diff --git a/.github/actions/build-sdk/action.yaml b/.github/actions/build-sdk/action.yaml index 982d4b7b..2205cd2e 100644 --- a/.github/actions/build-sdk/action.yaml +++ b/.github/actions/build-sdk/action.yaml @@ -17,76 +17,28 @@ runs: - name: Set up Node uses: actions/setup-node@v6 with: - node-version: "24" + node-version: "20" - name: Set up Java uses: actions/setup-java@v4 with: distribution: "temurin" java-version: "17" + + - name: Install Node dependencies + shell: bash + run: npm install - name: Download OpenAPI Generator shell: bash run: | wget -q https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.12.0/openapi-generator-cli-7.12.0.jar -O openapi-generator-cli.jar - - name: Build V3 SDK - shell: bash - run: | - rm -rf ./sdk-output/v3 - java -jar openapi-generator-cli.jar generate \ - -i ${{ inputs.api-specs-path }}/idn/sailpoint-api.v3.yaml \ - -g typescript-axios -o sdk-output/v3 \ - --global-property skipFormModel=false,apiDocs=true,modelDocs=true \ - --config sdk-resources/v3-config.yaml - - - name: Build Beta SDK + - name: Build Versioned SDK (per-partition) shell: bash run: | - rm -rf ./sdk-output/beta - java -jar openapi-generator-cli.jar generate \ - -i ${{ inputs.api-specs-path }}/idn/sailpoint-api.beta.yaml \ - -g typescript-axios -o sdk-output/beta \ - --global-property skipFormModel=false,apiDocs=true,modelDocs=true \ - --config sdk-resources/beta-config.yaml \ - --api-name-suffix BetaApi --model-name-suffix Beta - - - name: Build V2024 SDK - shell: bash - run: | - rm -rf ./sdk-output/v2024 - node sdk-resources/prescript.js ${{ inputs.api-specs-path }}/idn/v2024/paths - java -jar openapi-generator-cli.jar generate \ - -i ${{ inputs.api-specs-path }}/idn/sailpoint-api.v2024.yaml \ - -g typescript-axios -o sdk-output/v2024 \ - --global-property skipFormModel=false,apiDocs=true,modelDocs=true \ - --config sdk-resources/v2024-config.yaml \ - --api-name-suffix V2024Api --model-name-suffix V2024 - - - name: Build V2025 SDK - shell: bash - run: | - rm -rf ./sdk-output/v2025 - node sdk-resources/prescript.js ${{ inputs.api-specs-path }}/idn/v2025/paths - java -jar openapi-generator-cli.jar generate \ - -i ${{ inputs.api-specs-path }}/idn/sailpoint-api.v2025.yaml \ - -g typescript-axios -o sdk-output/v2025 \ - --global-property skipFormModel=false,apiDocs=true,modelDocs=true \ - --config sdk-resources/v2025-config.yaml \ - --api-name-suffix V2025Api --model-name-suffix V2025 - - - name: Build V2026 SDK - shell: bash - run: | - rm -rf ./sdk-output/v2026 - node sdk-resources/prescript.js ${{ inputs.api-specs-path }}/idn/v2026/paths - java -jar openapi-generator-cli.jar generate \ - -i ${{ inputs.api-specs-path }}/idn/sailpoint-api.v2026.yaml \ - -g typescript-axios -o sdk-output/v2026 \ - --global-property skipFormModel=false,apiDocs=true,modelDocs=true \ - --config sdk-resources/v2026-config.yaml \ - --api-name-suffix V2026Api --model-name-suffix V2026 - + node sdk-resources/build-versioned-sdk.js \ + ${{ inputs.api-specs-path }}/idn/apis - name: Build NERM SDK shell: bash diff --git a/.github/workflows/build_pr.yml b/.github/workflows/build_pr.yml index ddb0dfb6..84305056 100644 --- a/.github/workflows/build_pr.yml +++ b/.github/workflows/build_pr.yml @@ -4,6 +4,7 @@ env: SAIL_CLIENT_ID: ${{ secrets.SDK_TEST_TENANT_CLIENT_ID }} SAIL_CLIENT_SECRET: ${{ secrets.SDK_TEST_TENANT_CLIENT_SECRET }} SAIL_BASE_URL: ${{ secrets.SDK_TEST_TENANT_BASE_URL }} + SAIL_NERM_BASE_URL: ${{ secrets.SDK_TEST_NERM_BASE_URL }} on: pull_request: diff --git a/.gitignore b/.gitignore index 8766cd93..4691c484 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ build dist api-specs sdk-output/config.json -examples/config.json \ No newline at end of file +examples/config.json +.sdk-build-tmp/ +build-errors/ \ No newline at end of file diff --git a/Makefile b/Makefile index b9a6e542..ce08692a 100644 --- a/Makefile +++ b/Makefile @@ -6,21 +6,15 @@ specs: clean-specs: rm -rf ./api-specs +APIS_DIR ?= api-specs/src/main/yaml/apis + .PHONY: build build: - rm -rf ./sdk-output/v3 - java -jar openapi-generator-cli.jar generate -i api-specs/idn/sailpoint-api.v3.yaml -g typescript-axios -o sdk-output/v3 --global-property skipFormModel=false,apiDocs=true,modelDocs=true --config sdk-resources/v3-config.yaml - rm -rf ./sdk-output/beta - java -jar openapi-generator-cli.jar generate -i api-specs/idn/sailpoint-api.beta.yaml -g typescript-axios -o sdk-output/beta --global-property skipFormModel=false,apiDocs=true,modelDocs=true --config sdk-resources/beta-config.yaml --api-name-suffix BetaApi --model-name-suffix Beta - rm -rf ./sdk-output/v2024 - node sdk-resources/prescript.js api-specs/idn/v2024/paths - java -jar openapi-generator-cli.jar generate -i api-specs/idn/sailpoint-api.v2024.yaml -g typescript-axios -o sdk-output/v2024 --global-property skipFormModel=false,apiDocs=true,modelDocs=true --config sdk-resources/v2024-config.yaml --api-name-suffix V2024Api --model-name-suffix V2024 - rm -rf ./sdk-output/v2025 - node sdk-resources/prescript.js api-specs/idn/v2025/paths - java -jar openapi-generator-cli.jar generate -i api-specs/idn/sailpoint-api.v2025.yaml -g typescript-axios -o sdk-output/v2025 --global-property skipFormModel=false,apiDocs=true,modelDocs=true --config sdk-resources/v2025-config.yaml --api-name-suffix V2025Api --model-name-suffix V2025 - rm -rf ./sdk-output/v2026 - node sdk-resources/prescript.js api-specs/idn/v2026/paths - java -jar openapi-generator-cli.jar generate -i api-specs/idn/sailpoint-api.v2026.yaml -g typescript-axios -o sdk-output/v2026 --global-property skipFormModel=false,apiDocs=true,modelDocs=true --config sdk-resources/v2026-config.yaml --api-name-suffix V2026Api --model-name-suffix V2026 + node sdk-resources/build-versioned-sdk.js $(APIS_DIR) + +.PHONY: build-partition +build-partition: + node sdk-resources/build-versioned-sdk.js $(APIS_DIR) --partition $(PARTITION) .PHONY: test test: diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000..bfc95ee0 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,29 @@ +{ + "name": "typescript-sdk-builder", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "typescript-sdk-builder", + "version": "1.0.0", + "dependencies": { + "@redocly/cli": "^2.32.2" + } + }, + "node_modules/@redocly/cli": { + "version": "2.35.0", + "resolved": "https://registry.npmjs.org/@redocly/cli/-/cli-2.35.0.tgz", + "integrity": "sha512-p25TtRIN85KewtpPVdTuakmKHCcZkmV+ygQx2dJgvpXpNqZeoyjmnNThev1oyIc4t2h2mGkompan/LgPtG/u3g==", + "license": "MIT", + "bin": { + "openapi": "bin/cli.js", + "redocly": "bin/cli.js" + }, + "engines": { + "node": ">=22.12.0 || >=20.19.0 <21.0.0", + "npm": ">=10" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 00000000..73826364 --- /dev/null +++ b/package.json @@ -0,0 +1,12 @@ +{ + "name": "typescript-sdk-builder", + "version": "1.0.0", + "private": true, + "description": "Build tooling for the SailPoint Typescript SDK", + "scripts": { + "build": "node sdk-resources/build-versioned-sdk.js" + }, + "dependencies": { + "@redocly/cli": "^2.32.2" + } +} diff --git a/sdk-output/beta/.gitignore b/sdk-output/access_model_metadata/.gitignore similarity index 100% rename from sdk-output/beta/.gitignore rename to sdk-output/access_model_metadata/.gitignore diff --git a/sdk-output/beta/.npmignore b/sdk-output/access_model_metadata/.npmignore similarity index 100% rename from sdk-output/beta/.npmignore rename to sdk-output/access_model_metadata/.npmignore diff --git a/sdk-output/beta/.openapi-generator-ignore b/sdk-output/access_model_metadata/.openapi-generator-ignore similarity index 100% rename from sdk-output/beta/.openapi-generator-ignore rename to sdk-output/access_model_metadata/.openapi-generator-ignore diff --git a/sdk-output/beta/.openapi-generator/FILES b/sdk-output/access_model_metadata/.openapi-generator/FILES similarity index 100% rename from sdk-output/beta/.openapi-generator/FILES rename to sdk-output/access_model_metadata/.openapi-generator/FILES diff --git a/sdk-output/beta/.openapi-generator/VERSION b/sdk-output/access_model_metadata/.openapi-generator/VERSION similarity index 100% rename from sdk-output/beta/.openapi-generator/VERSION rename to sdk-output/access_model_metadata/.openapi-generator/VERSION diff --git a/sdk-output/access_model_metadata/.sdk-partition b/sdk-output/access_model_metadata/.sdk-partition new file mode 100644 index 00000000..a2eeffc9 --- /dev/null +++ b/sdk-output/access_model_metadata/.sdk-partition @@ -0,0 +1 @@ +access-model-metadata \ No newline at end of file diff --git a/sdk-output/beta/README.md b/sdk-output/access_model_metadata/README.md similarity index 92% rename from sdk-output/beta/README.md rename to sdk-output/access_model_metadata/README.md index 51f7499b..e26f6a53 100644 --- a/sdk-output/beta/README.md +++ b/sdk-output/access_model_metadata/README.md @@ -1,4 +1,4 @@ -## sailpoint-sdk@1.8.69 +## sailpoint-api-client@1.0.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: @@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co _published:_ ``` -npm install sailpoint-sdk@1.8.69 --save +npm install sailpoint-api-client@1.0.0 --save ``` _unPublished (not recommended):_ diff --git a/sdk-output/access_model_metadata/api.ts b/sdk-output/access_model_metadata/api.ts new file mode 100644 index 00000000..cc94e6bb --- /dev/null +++ b/sdk-output/access_model_metadata/api.ts @@ -0,0 +1,2220 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Model Metadata + * 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 AccessmodelmetadatabulkupdateresponseV1 + */ +export interface AccessmodelmetadatabulkupdateresponseV1 { + /** + * ID of the task which is executing the bulk update. + * @type {string} + * @memberof AccessmodelmetadatabulkupdateresponseV1 + */ + 'id'?: string; + /** + * Type of the bulk update object. + * @type {string} + * @memberof AccessmodelmetadatabulkupdateresponseV1 + */ + 'type'?: string; + /** + * The status of the bulk update request, only list unfinished request\'s status. + * @type {string} + * @memberof AccessmodelmetadatabulkupdateresponseV1 + */ + 'status'?: AccessmodelmetadatabulkupdateresponseV1StatusV1; + /** + * Time when the bulk update request was created + * @type {string} + * @memberof AccessmodelmetadatabulkupdateresponseV1 + */ + 'created'?: string; +} + +export const AccessmodelmetadatabulkupdateresponseV1StatusV1 = { + Created: 'CREATED', + PreProcess: 'PRE_PROCESS', + PreProcessCompleted: 'PRE_PROCESS_COMPLETED', + PostProcess: 'POST_PROCESS', + Completed: 'COMPLETED', + ChunkPending: 'CHUNK_PENDING', + ChunkProcessing: 'CHUNK_PROCESSING', + ReProcessing: 'RE_PROCESSING', + PreProcessFailed: 'PRE_PROCESS_FAILED', + Failed: 'FAILED' +} as const; + +export type AccessmodelmetadatabulkupdateresponseV1StatusV1 = typeof AccessmodelmetadatabulkupdateresponseV1StatusV1[keyof typeof AccessmodelmetadatabulkupdateresponseV1StatusV1]; + +/** + * + * @export + * @interface AggregationsV1 + */ +export interface AggregationsV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof AggregationsV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof AggregationsV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof AggregationsV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof AggregationsV1 + */ + 'bucket'?: BucketaggregationV1; +} +/** + * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const AggregationtypeV1 = { + Dsl: 'DSL', + Sailpoint: 'SAILPOINT' +} as const; + +export type AggregationtypeV1 = typeof AggregationtypeV1[keyof typeof AggregationtypeV1]; + + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AttributedtoV1 + */ +export interface AttributedtoV1 { + /** + * Technical name of the Attribute. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributedtoV1 + */ + 'key'?: string; + /** + * The display name of the key. + * @type {string} + * @memberof AttributedtoV1 + */ + 'name'?: string; + /** + * Indicates whether the attribute can have multiple values. + * @type {boolean} + * @memberof AttributedtoV1 + */ + 'multiselect'?: boolean; + /** + * The status of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'status'?: string; + /** + * The type of the Attribute. This can be either \"custom\" or \"governance\". + * @type {string} + * @memberof AttributedtoV1 + */ + 'type'?: string; + /** + * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. + * @type {Array} + * @memberof AttributedtoV1 + */ + 'objectTypes'?: Array | null; + /** + * The description of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'description'?: string; + /** + * + * @type {Array} + * @memberof AttributedtoV1 + */ + 'values'?: Array | null; +} +/** + * + * @export + * @interface AttributevaluedtoV1 + */ +export interface AttributevaluedtoV1 { + /** + * Technical name of the Attribute value. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'value'?: string; + /** + * The display name of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'name'?: string; + /** + * The status of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'status'?: string; +} +/** + * + * @export + * @interface BoundV1 + */ +export interface BoundV1 { + /** + * The value of the range\'s endpoint. + * @type {string} + * @memberof BoundV1 + */ + 'value': string; + /** + * Indicates if the endpoint is included in the range. + * @type {boolean} + * @memberof BoundV1 + */ + 'inclusive'?: boolean; +} +/** + * The bucket to group the results of the aggregation query by. + * @export + * @interface BucketaggregationV1 + */ +export interface BucketaggregationV1 { + /** + * The name of the bucket aggregate to be included in the result. + * @type {string} + * @memberof BucketaggregationV1 + */ + 'name': string; + /** + * + * @type {BuckettypeV1} + * @memberof BucketaggregationV1 + */ + 'type'?: BuckettypeV1; + /** + * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof BucketaggregationV1 + */ + 'field': string; + /** + * Maximum number of buckets to include. + * @type {number} + * @memberof BucketaggregationV1 + */ + 'size'?: number; + /** + * Minimum number of documents a bucket should have. + * @type {number} + * @memberof BucketaggregationV1 + */ + 'minDocCount'?: number; +} + + +/** + * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const BuckettypeV1 = { + Terms: 'TERMS' +} as const; + +export type BuckettypeV1 = typeof BuckettypeV1[keyof typeof BuckettypeV1]; + + +/** + * + * @export + * @interface BulkupdateammkeyvalueInnerV1 + */ +export interface BulkupdateammkeyvalueInnerV1 { + /** + * the key of metadata attribute + * @type {string} + * @memberof BulkupdateammkeyvalueInnerV1 + */ + 'attribute': string; + /** + * the values of attribute to be updated + * @type {Array} + * @memberof BulkupdateammkeyvalueInnerV1 + */ + 'values': Array | null; +} +/** + * + * @export + * @interface EntitlementattributebulkupdatefilterrequestV1 + */ +export interface EntitlementattributebulkupdatefilterrequestV1 { + /** + * 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* + * @type {string} + * @memberof EntitlementattributebulkupdatefilterrequestV1 + */ + 'filters'?: string; + /** + * Operation to perform on the attributes in the bulk update request. + * @type {string} + * @memberof EntitlementattributebulkupdatefilterrequestV1 + */ + 'operation'?: EntitlementattributebulkupdatefilterrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof EntitlementattributebulkupdatefilterrequestV1 + */ + 'replaceScope'?: EntitlementattributebulkupdatefilterrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute and values. + * @type {Array} + * @memberof EntitlementattributebulkupdatefilterrequestV1 + */ + 'values'?: Array; +} + +export const EntitlementattributebulkupdatefilterrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type EntitlementattributebulkupdatefilterrequestV1OperationV1 = typeof EntitlementattributebulkupdatefilterrequestV1OperationV1[keyof typeof EntitlementattributebulkupdatefilterrequestV1OperationV1]; +export const EntitlementattributebulkupdatefilterrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type EntitlementattributebulkupdatefilterrequestV1ReplaceScopeV1 = typeof EntitlementattributebulkupdatefilterrequestV1ReplaceScopeV1[keyof typeof EntitlementattributebulkupdatefilterrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface EntitlementattributebulkupdateidsrequestV1 + */ +export interface EntitlementattributebulkupdateidsrequestV1 { + /** + * List of entitlement IDs to update. + * @type {Array} + * @memberof EntitlementattributebulkupdateidsrequestV1 + */ + 'entitlements'?: Array; + /** + * Operation to perform on the attributes in the bulk update request. + * @type {string} + * @memberof EntitlementattributebulkupdateidsrequestV1 + */ + 'operation'?: EntitlementattributebulkupdateidsrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof EntitlementattributebulkupdateidsrequestV1 + */ + 'replaceScope'?: EntitlementattributebulkupdateidsrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute and values. + * @type {Array} + * @memberof EntitlementattributebulkupdateidsrequestV1 + */ + 'values'?: Array; +} + +export const EntitlementattributebulkupdateidsrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type EntitlementattributebulkupdateidsrequestV1OperationV1 = typeof EntitlementattributebulkupdateidsrequestV1OperationV1[keyof typeof EntitlementattributebulkupdateidsrequestV1OperationV1]; +export const EntitlementattributebulkupdateidsrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type EntitlementattributebulkupdateidsrequestV1ReplaceScopeV1 = typeof EntitlementattributebulkupdateidsrequestV1ReplaceScopeV1[keyof typeof EntitlementattributebulkupdateidsrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface EntitlementattributebulkupdatequeryrequestV1 + */ +export interface EntitlementattributebulkupdatequeryrequestV1 { + /** + * + * @type {SearchV1} + * @memberof EntitlementattributebulkupdatequeryrequestV1 + */ + 'query'?: SearchV1; + /** + * Operation to perform on the attributes in the bulk update request. + * @type {string} + * @memberof EntitlementattributebulkupdatequeryrequestV1 + */ + 'operation'?: EntitlementattributebulkupdatequeryrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof EntitlementattributebulkupdatequeryrequestV1 + */ + 'replaceScope'?: EntitlementattributebulkupdatequeryrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute and values. + * @type {Array} + * @memberof EntitlementattributebulkupdatequeryrequestV1 + */ + 'values'?: Array; +} + +export const EntitlementattributebulkupdatequeryrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type EntitlementattributebulkupdatequeryrequestV1OperationV1 = typeof EntitlementattributebulkupdatequeryrequestV1OperationV1[keyof typeof EntitlementattributebulkupdatequeryrequestV1OperationV1]; +export const EntitlementattributebulkupdatequeryrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type EntitlementattributebulkupdatequeryrequestV1ReplaceScopeV1 = typeof EntitlementattributebulkupdatequeryrequestV1ReplaceScopeV1[keyof typeof EntitlementattributebulkupdatequeryrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FilterV1 + */ +export interface FilterV1 { + /** + * + * @type {FiltertypeV1} + * @memberof FilterV1 + */ + 'type'?: FiltertypeV1; + /** + * + * @type {RangeV1} + * @memberof FilterV1 + */ + 'range'?: RangeV1; + /** + * The terms to be filtered. + * @type {Array} + * @memberof FilterV1 + */ + 'terms'?: Array; + /** + * Indicates if the filter excludes results. + * @type {boolean} + * @memberof FilterV1 + */ + 'exclude'?: boolean; +} + + +/** + * An additional filter to constrain the results of the search query. + * @export + * @interface FilteraggregationV1 + */ +export interface FilteraggregationV1 { + /** + * The name of the filter aggregate to be included in the result. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'name': string; + /** + * + * @type {SearchfiltertypeV1} + * @memberof FilteraggregationV1 + */ + 'type'?: SearchfiltertypeV1; + /** + * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'field': string; + /** + * The value to filter on. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'value': string; +} + + +/** + * Enum representing the currently supported filter types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const FiltertypeV1 = { + Exists: 'EXISTS', + Range: 'RANGE', + Terms: 'TERMS' +} as const; + +export type FiltertypeV1 = typeof FiltertypeV1[keyof typeof FiltertypeV1]; + + +/** + * Enum representing the currently supported indices. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const IndexV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Events: 'events', + Identities: 'identities', + Roles: 'roles', + Star: '*' +} as const; + +export type IndexV1 = typeof IndexV1[keyof typeof IndexV1]; + + +/** + * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. + * @export + * @interface InnerhitV1 + */ +export interface InnerhitV1 { + /** + * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof InnerhitV1 + */ + 'query': string; + /** + * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. + * @type {string} + * @memberof InnerhitV1 + */ + 'type': string; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListAccessModelMetadataAttributeV1401ResponseV1 + */ +export interface ListAccessModelMetadataAttributeV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccessModelMetadataAttributeV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListAccessModelMetadataAttributeV1429ResponseV1 + */ +export interface ListAccessModelMetadataAttributeV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccessModelMetadataAttributeV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The calculation done on the results of the query + * @export + * @interface MetricaggregationV1 + */ +export interface MetricaggregationV1 { + /** + * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + * @type {string} + * @memberof MetricaggregationV1 + */ + 'name': string; + /** + * + * @type {MetrictypeV1} + * @memberof MetricaggregationV1 + */ + 'type'?: MetrictypeV1; + /** + * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof MetricaggregationV1 + */ + 'field': string; +} + + +/** + * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const MetrictypeV1 = { + Count: 'COUNT', + UniqueCount: 'UNIQUE_COUNT', + Avg: 'AVG', + Sum: 'SUM', + Median: 'MEDIAN', + Min: 'MIN', + Max: 'MAX' +} as const; + +export type MetrictypeV1 = typeof MetrictypeV1[keyof typeof MetrictypeV1]; + + +/** + * The nested aggregation object. + * @export + * @interface NestedaggregationV1 + */ +export interface NestedaggregationV1 { + /** + * The name of the nested aggregate to be included in the result. + * @type {string} + * @memberof NestedaggregationV1 + */ + 'name': string; + /** + * The type of the nested object. + * @type {string} + * @memberof NestedaggregationV1 + */ + 'type': string; +} +/** + * Query parameters used to construct an Elasticsearch query object. + * @export + * @interface QueryV1 + */ +export interface QueryV1 { + /** + * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof QueryV1 + */ + 'query'?: string; + /** + * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. + * @type {string} + * @memberof QueryV1 + */ + 'fields'?: string; + /** + * The time zone to be applied to any range query related to dates. + * @type {string} + * @memberof QueryV1 + */ + 'timeZone'?: string; + /** + * + * @type {InnerhitV1} + * @memberof QueryV1 + */ + 'innerHit'?: InnerhitV1; +} +/** + * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + * @export + * @interface QueryresultfilterV1 + */ +export interface QueryresultfilterV1 { + /** + * The list of field names to include in the result documents. + * @type {Array} + * @memberof QueryresultfilterV1 + */ + 'includes'?: Array; + /** + * The list of field names to exclude from the result documents. + * @type {Array} + * @memberof QueryresultfilterV1 + */ + 'excludes'?: Array; +} +/** + * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const QuerytypeV1 = { + Dsl: 'DSL', + Sailpoint: 'SAILPOINT', + Text: 'TEXT', + Typeahead: 'TYPEAHEAD' +} as const; + +export type QuerytypeV1 = typeof QuerytypeV1[keyof typeof QuerytypeV1]; + + +/** + * The range of values to be filtered. + * @export + * @interface RangeV1 + */ +export interface RangeV1 { + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'lower'?: BoundV1; + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'upper'?: BoundV1; +} +/** + * + * @export + * @interface SearchV1 + */ +export interface SearchV1 { + /** + * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. + * @type {Array} + * @memberof SearchV1 + */ + 'indices'?: Array; + /** + * + * @type {QuerytypeV1} + * @memberof SearchV1 + */ + 'queryType'?: QuerytypeV1; + /** + * + * @type {string} + * @memberof SearchV1 + */ + 'queryVersion'?: string; + /** + * + * @type {QueryV1} + * @memberof SearchV1 + */ + 'query'?: QueryV1; + /** + * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. + * @type {object} + * @memberof SearchV1 + */ + 'queryDsl'?: object; + /** + * + * @type {TextqueryV1} + * @memberof SearchV1 + */ + 'textQuery'?: TextqueryV1; + /** + * + * @type {TypeaheadqueryV1} + * @memberof SearchV1 + */ + 'typeAheadQuery'?: TypeaheadqueryV1; + /** + * Indicates whether nested objects from returned search results should be included. + * @type {boolean} + * @memberof SearchV1 + */ + 'includeNested'?: boolean; + /** + * + * @type {QueryresultfilterV1} + * @memberof SearchV1 + */ + 'queryResultFilter'?: QueryresultfilterV1; + /** + * + * @type {AggregationtypeV1} + * @memberof SearchV1 + */ + 'aggregationType'?: AggregationtypeV1; + /** + * + * @type {string} + * @memberof SearchV1 + */ + 'aggregationsVersion'?: string; + /** + * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. + * @type {object} + * @memberof SearchV1 + */ + 'aggregationsDsl'?: object; + /** + * + * @type {SearchaggregationspecificationV1} + * @memberof SearchV1 + */ + 'aggregations'?: SearchaggregationspecificationV1; + /** + * The fields to be used to sort the search results. Use + or - to specify the sort direction. + * @type {Array} + * @memberof SearchV1 + */ + 'sort'?: Array; + /** + * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] + * @type {Array} + * @memberof SearchV1 + */ + 'searchAfter'?: Array; + /** + * The filters to be applied for each filtered field name. + * @type {{ [key: string]: FilterV1; }} + * @memberof SearchV1 + */ + 'filters'?: { [key: string]: FilterV1; }; +} + + +/** + * + * @export + * @interface SearchaggregationspecificationV1 + */ +export interface SearchaggregationspecificationV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'bucket'?: BucketaggregationV1; + /** + * + * @type {SubsearchaggregationspecificationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'subAggregation'?: SubsearchaggregationspecificationV1; +} +/** + * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const SearchfiltertypeV1 = { + Term: 'TERM' +} as const; + +export type SearchfiltertypeV1 = typeof SearchfiltertypeV1[keyof typeof SearchfiltertypeV1]; + + +/** + * + * @export + * @interface SubsearchaggregationspecificationV1 + */ +export interface SubsearchaggregationspecificationV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'bucket'?: BucketaggregationV1; + /** + * + * @type {AggregationsV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'subAggregation'?: AggregationsV1; +} +/** + * Query parameters used to construct an Elasticsearch text query object. + * @export + * @interface TextqueryV1 + */ +export interface TextqueryV1 { + /** + * Words or characters that specify a particular thing to be searched for. + * @type {Array} + * @memberof TextqueryV1 + */ + 'terms': Array; + /** + * The fields to be searched. + * @type {Array} + * @memberof TextqueryV1 + */ + 'fields': Array; + /** + * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. + * @type {boolean} + * @memberof TextqueryV1 + */ + 'matchAny'?: boolean; + /** + * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. + * @type {boolean} + * @memberof TextqueryV1 + */ + 'contains'?: boolean; +} +/** + * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" + * @export + * @interface TypeaheadqueryV1 + */ +export interface TypeaheadqueryV1 { + /** + * The type ahead query string used to construct a phrase prefix match query. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'query': string; + /** + * The field on which to perform the type ahead search. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'field': string; + /** + * The nested type. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'nestedType'?: string; + /** + * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. + * @type {number} + * @memberof TypeaheadqueryV1 + */ + 'maxExpansions'?: number; + /** + * The max amount of records the search will return. + * @type {number} + * @memberof TypeaheadqueryV1 + */ + 'size'?: number; + /** + * The sort order of the returned records. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'sort'?: string; + /** + * The flag that defines the sort type, by count or value. + * @type {boolean} + * @memberof TypeaheadqueryV1 + */ + 'sortByValue'?: boolean; +} + +/** + * AccessModelMetadataV1Api - axios parameter creator + * @export + */ +export const AccessModelMetadataV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new Access Model Metadata Attribute. + * @summary Create access model metadata attribute + * @param {AttributedtoV1} attributedtoV1 Attribute to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataAttributeV1: async (attributedtoV1: AttributedtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'attributedtoV1' is not null or undefined + assertParamExists('createAccessModelMetadataAttributeV1', 'attributedtoV1', attributedtoV1) + const localVarPath = `/access-model-metadata/v1/attributes`; + // 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(attributedtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Create a new value for an existing Access Model Metadata Attribute. + * @summary Create access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {AttributevaluedtoV1} attributevaluedtoV1 Attribute value to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataAttributeValueV1: async (key: string, attributevaluedtoV1: AttributevaluedtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('createAccessModelMetadataAttributeValueV1', 'key', key) + // verify required parameter 'attributevaluedtoV1' is not null or undefined + assertParamExists('createAccessModelMetadataAttributeValueV1', 'attributevaluedtoV1', attributevaluedtoV1) + const localVarPath = `/access-model-metadata/v1/attributes/{key}/values` + .replace(`{${"key"}}`, encodeURIComponent(String(key))); + // 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(attributevaluedtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get single Access Model Metadata Attribute + * @summary Get access model metadata attribute + * @param {string} key Technical name of the Attribute. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessModelMetadataAttributeV1: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('getAccessModelMetadataAttributeV1', 'key', key) + const localVarPath = `/access-model-metadata/v1/attributes/{key}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))); + // 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 single Access Model Metadata Attribute Value + * @summary Get access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {string} value Technical name of the Attribute value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessModelMetadataAttributeValueV1: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('getAccessModelMetadataAttributeValueV1', 'key', key) + // verify required parameter 'value' is not null or undefined + assertParamExists('getAccessModelMetadataAttributeValueV1', 'value', value) + const localVarPath = `/access-model-metadata/v1/attributes/{key}/values/{value}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))) + .replace(`{${"value"}}`, encodeURIComponent(String(value))); + // 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 list of Access Model Metadata Attributes + * @summary List access model metadata attributes + * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* + * @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: **name, key** + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessModelMetadataAttributeV1: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-model-metadata/v1/attributes`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a list of Access Model Metadata Attribute Values + * @summary List access model metadata values + * @param {string} key Technical name of the Attribute. + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessModelMetadataAttributeValueV1: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('listAccessModelMetadataAttributeValueV1', 'key', key) + const localVarPath = `/access-model-metadata/v1/attributes/{key}/values` + .replace(`{${"key"}}`, encodeURIComponent(String(key))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + 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 Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** + * @summary Update access model metadata attribute + * @param {string} key Technical name of the Attribute. + * @param {Array} jsonpatchoperationV1 JSON Patch array to apply + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessModelMetadataAttributeV1: async (key: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('updateAccessModelMetadataAttributeV1', 'key', key) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateAccessModelMetadataAttributeV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/access-model-metadata/v1/attributes/{key}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** + * @summary Update access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {string} value Technical name of the Attribute value. + * @param {Array} jsonpatchoperationV1 JSON Patch array to apply + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessModelMetadataAttributeValueV1: async (key: string, value: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('updateAccessModelMetadataAttributeValueV1', 'key', key) + // verify required parameter 'value' is not null or undefined + assertParamExists('updateAccessModelMetadataAttributeValueV1', 'value', value) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateAccessModelMetadataAttributeValueV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/access-model-metadata/v1/attributes/{key}/values/{value}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))) + .replace(`{${"value"}}`, encodeURIComponent(String(value))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk update Access Model Metadata Attribute Values using a filter + * @summary Metadata Attribute update by filter + * @param {EntitlementattributebulkupdatefilterrequestV1} entitlementattributebulkupdatefilterrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByFilterV1: async (entitlementattributebulkupdatefilterrequestV1: EntitlementattributebulkupdatefilterrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementattributebulkupdatefilterrequestV1' is not null or undefined + assertParamExists('updateAccessModelMetadataByFilterV1', 'entitlementattributebulkupdatefilterrequestV1', entitlementattributebulkupdatefilterrequestV1) + const localVarPath = `/access-model-metadata/v1/bulk-update/filter`; + // 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(entitlementattributebulkupdatefilterrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk update Access Model Metadata Attribute Values using ids. + * @summary Metadata Attribute update by ids + * @param {EntitlementattributebulkupdateidsrequestV1} entitlementattributebulkupdateidsrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByIdsV1: async (entitlementattributebulkupdateidsrequestV1: EntitlementattributebulkupdateidsrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementattributebulkupdateidsrequestV1' is not null or undefined + assertParamExists('updateAccessModelMetadataByIdsV1', 'entitlementattributebulkupdateidsrequestV1', entitlementattributebulkupdateidsrequestV1) + const localVarPath = `/access-model-metadata/v1/bulk-update/ids`; + // 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(entitlementattributebulkupdateidsrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk update Access Model Metadata Attribute Values using a query + * @summary Metadata Attribute update by query + * @param {EntitlementattributebulkupdatequeryrequestV1} entitlementattributebulkupdatequeryrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByQueryV1: async (entitlementattributebulkupdatequeryrequestV1: EntitlementattributebulkupdatequeryrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementattributebulkupdatequeryrequestV1' is not null or undefined + assertParamExists('updateAccessModelMetadataByQueryV1', 'entitlementattributebulkupdatequeryrequestV1', entitlementattributebulkupdatequeryrequestV1) + const localVarPath = `/access-model-metadata/v1/bulk-update/query`; + // 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(entitlementattributebulkupdatequeryrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccessModelMetadataV1Api - functional programming interface + * @export + */ +export const AccessModelMetadataV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccessModelMetadataV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new Access Model Metadata Attribute. + * @summary Create access model metadata attribute + * @param {AttributedtoV1} attributedtoV1 Attribute to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccessModelMetadataAttributeV1(attributedtoV1: AttributedtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeV1(attributedtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.createAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create a new value for an existing Access Model Metadata Attribute. + * @summary Create access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {AttributevaluedtoV1} attributevaluedtoV1 Attribute value to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccessModelMetadataAttributeValueV1(key: string, attributevaluedtoV1: AttributevaluedtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValueV1(key, attributevaluedtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.createAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get single Access Model Metadata Attribute + * @summary Get access model metadata attribute + * @param {string} key Technical name of the Attribute. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessModelMetadataAttributeV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeV1(key, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.getAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get single Access Model Metadata Attribute Value + * @summary Get access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {string} value Technical name of the Attribute value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessModelMetadataAttributeValueV1(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValueV1(key, value, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.getAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of Access Model Metadata Attributes + * @summary List access model metadata attributes + * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* + * @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: **name, key** + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessModelMetadataAttributeV1(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeV1(filters, sorters, limit, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.listAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of Access Model Metadata Attribute Values + * @summary List access model metadata values + * @param {string} key Technical name of the Attribute. + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessModelMetadataAttributeValueV1(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValueV1(key, limit, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.listAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** + * @summary Update access model metadata attribute + * @param {string} key Technical name of the Attribute. + * @param {Array} jsonpatchoperationV1 JSON Patch array to apply + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAccessModelMetadataAttributeV1(key: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeV1(key, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.updateAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** + * @summary Update access model metadata value + * @param {string} key Technical name of the Attribute. + * @param {string} value Technical name of the Attribute value. + * @param {Array} jsonpatchoperationV1 JSON Patch array to apply + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAccessModelMetadataAttributeValueV1(key: string, value: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValueV1(key, value, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.updateAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk update Access Model Metadata Attribute Values using a filter + * @summary Metadata Attribute update by filter + * @param {EntitlementattributebulkupdatefilterrequestV1} entitlementattributebulkupdatefilterrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async updateAccessModelMetadataByFilterV1(entitlementattributebulkupdatefilterrequestV1: EntitlementattributebulkupdatefilterrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByFilterV1(entitlementattributebulkupdatefilterrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.updateAccessModelMetadataByFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk update Access Model Metadata Attribute Values using ids. + * @summary Metadata Attribute update by ids + * @param {EntitlementattributebulkupdateidsrequestV1} entitlementattributebulkupdateidsrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async updateAccessModelMetadataByIdsV1(entitlementattributebulkupdateidsrequestV1: EntitlementattributebulkupdateidsrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByIdsV1(entitlementattributebulkupdateidsrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.updateAccessModelMetadataByIdsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk update Access Model Metadata Attribute Values using a query + * @summary Metadata Attribute update by query + * @param {EntitlementattributebulkupdatequeryrequestV1} entitlementattributebulkupdatequeryrequestV1 Attribute metadata bulk update request body. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async updateAccessModelMetadataByQueryV1(entitlementattributebulkupdatequeryrequestV1: EntitlementattributebulkupdatequeryrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByQueryV1(entitlementattributebulkupdatequeryrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV1Api.updateAccessModelMetadataByQueryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccessModelMetadataV1Api - factory interface + * @export + */ +export const AccessModelMetadataV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccessModelMetadataV1ApiFp(configuration) + return { + /** + * Create a new Access Model Metadata Attribute. + * @summary Create access model metadata attribute + * @param {AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccessModelMetadataAttributeV1(requestParameters.attributedtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create a new value for an existing Access Model Metadata Attribute. + * @summary Create access model metadata value + * @param {AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.attributevaluedtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get single Access Model Metadata Attribute + * @summary Get access model metadata attribute + * @param {AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessModelMetadataAttributeV1(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get single Access Model Metadata Attribute Value + * @summary Get access model metadata value + * @param {AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of Access Model Metadata Attributes + * @summary List access model metadata attributes + * @param {AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessModelMetadataAttributeV1(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of Access Model Metadata Attribute Values + * @summary List access model metadata values + * @param {AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** + * @summary Update access model metadata attribute + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccessModelMetadataAttributeV1(requestParameters.key, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** + * @summary Update access model metadata value + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk update Access Model Metadata Attribute Values using a filter + * @summary Metadata Attribute update by filter + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByFilterV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccessModelMetadataByFilterV1(requestParameters.entitlementattributebulkupdatefilterrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk update Access Model Metadata Attribute Values using ids. + * @summary Metadata Attribute update by ids + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByIdsV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccessModelMetadataByIdsV1(requestParameters.entitlementattributebulkupdateidsrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk update Access Model Metadata Attribute Values using a query + * @summary Metadata Attribute update by query + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + updateAccessModelMetadataByQueryV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccessModelMetadataByQueryV1(requestParameters.entitlementattributebulkupdatequeryrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createAccessModelMetadataAttributeV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request + */ +export interface AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request { + /** + * Attribute to create + * @type {AttributedtoV1} + * @memberof AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1 + */ + readonly attributedtoV1: AttributedtoV1 +} + +/** + * Request parameters for createAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request + */ +export interface AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1 + */ + readonly key: string + + /** + * Attribute value to create + * @type {AttributevaluedtoV1} + * @memberof AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1 + */ + readonly attributevaluedtoV1: AttributevaluedtoV1 +} + +/** + * Request parameters for getAccessModelMetadataAttributeV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request + */ +export interface AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1 + */ + readonly key: string +} + +/** + * Request parameters for getAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request + */ +export interface AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1 + */ + readonly key: string + + /** + * Technical name of the Attribute value. + * @type {string} + * @memberof AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1 + */ + readonly value: string +} + +/** + * Request parameters for listAccessModelMetadataAttributeV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request + */ +export interface AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request { + /** + * 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* + * @type {string} + * @memberof AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1 + */ + 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: **name, key** + * @type {string} + * @memberof AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1 + */ + readonly sorters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1 + */ + 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 AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for listAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request + */ +export interface AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1 + */ + readonly key: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1 + */ + 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 AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for updateAccessModelMetadataAttributeV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request + */ +export interface AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1 + */ + readonly key: string + + /** + * JSON Patch array to apply + * @type {Array} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request + */ +export interface AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request { + /** + * Technical name of the Attribute. + * @type {string} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1 + */ + readonly key: string + + /** + * Technical name of the Attribute value. + * @type {string} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1 + */ + readonly value: string + + /** + * JSON Patch array to apply + * @type {Array} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateAccessModelMetadataByFilterV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request + */ +export interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request { + /** + * Attribute metadata bulk update request body. + * @type {EntitlementattributebulkupdatefilterrequestV1} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1 + */ + readonly entitlementattributebulkupdatefilterrequestV1: EntitlementattributebulkupdatefilterrequestV1 +} + +/** + * Request parameters for updateAccessModelMetadataByIdsV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request + */ +export interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request { + /** + * Attribute metadata bulk update request body. + * @type {EntitlementattributebulkupdateidsrequestV1} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1 + */ + readonly entitlementattributebulkupdateidsrequestV1: EntitlementattributebulkupdateidsrequestV1 +} + +/** + * Request parameters for updateAccessModelMetadataByQueryV1 operation in AccessModelMetadataV1Api. + * @export + * @interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request + */ +export interface AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request { + /** + * Attribute metadata bulk update request body. + * @type {EntitlementattributebulkupdatequeryrequestV1} + * @memberof AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1 + */ + readonly entitlementattributebulkupdatequeryrequestV1: EntitlementattributebulkupdatequeryrequestV1 +} + +/** + * AccessModelMetadataV1Api - object-oriented interface + * @export + * @class AccessModelMetadataV1Api + * @extends {BaseAPI} + */ +export class AccessModelMetadataV1Api extends BaseAPI { + /** + * Create a new Access Model Metadata Attribute. + * @summary Create access model metadata attribute + * @param {AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public createAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).createAccessModelMetadataAttributeV1(requestParameters.attributedtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create a new value for an existing Access Model Metadata Attribute. + * @summary Create access model metadata value + * @param {AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public createAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiCreateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).createAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.attributevaluedtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get single Access Model Metadata Attribute + * @summary Get access model metadata attribute + * @param {AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public getAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiGetAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).getAccessModelMetadataAttributeV1(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get single Access Model Metadata Attribute Value + * @summary Get access model metadata value + * @param {AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public getAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiGetAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).getAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of Access Model Metadata Attributes + * @summary List access model metadata attributes + * @param {AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public listAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiListAccessModelMetadataAttributeV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).listAccessModelMetadataAttributeV1(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of Access Model Metadata Attribute Values + * @summary List access model metadata values + * @param {AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public listAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiListAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).listAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** + * @summary Update access model metadata attribute + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public updateAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).updateAccessModelMetadataAttributeV1(requestParameters.key, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** + * @summary Update access model metadata value + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public updateAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).updateAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk update Access Model Metadata Attribute Values using a filter + * @summary Metadata Attribute update by filter + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public updateAccessModelMetadataByFilterV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).updateAccessModelMetadataByFilterV1(requestParameters.entitlementattributebulkupdatefilterrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk update Access Model Metadata Attribute Values using ids. + * @summary Metadata Attribute update by ids + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public updateAccessModelMetadataByIdsV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).updateAccessModelMetadataByIdsV1(requestParameters.entitlementattributebulkupdateidsrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk update Access Model Metadata Attribute Values using a query + * @summary Metadata Attribute update by query + * @param {AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof AccessModelMetadataV1Api + */ + public updateAccessModelMetadataByQueryV1(requestParameters: AccessModelMetadataV1ApiUpdateAccessModelMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessModelMetadataV1ApiFp(this.configuration).updateAccessModelMetadataByQueryV1(requestParameters.entitlementattributebulkupdatequeryrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/access_model_metadata/base.ts b/sdk-output/access_model_metadata/base.ts new file mode 100644 index 00000000..2c7ee6c8 --- /dev/null +++ b/sdk-output/access_model_metadata/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Model Metadata + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/access_model_metadata/common.ts b/sdk-output/access_model_metadata/common.ts new file mode 100644 index 00000000..0cc4f328 --- /dev/null +++ b/sdk-output/access_model_metadata/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Model Metadata + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/access_model_metadata/configuration.ts b/sdk-output/access_model_metadata/configuration.ts new file mode 100644 index 00000000..23c9e00c --- /dev/null +++ b/sdk-output/access_model_metadata/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Model Metadata + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/beta/git_push.sh b/sdk-output/access_model_metadata/git_push.sh similarity index 100% rename from sdk-output/beta/git_push.sh rename to sdk-output/access_model_metadata/git_push.sh diff --git a/sdk-output/access_model_metadata/index.ts b/sdk-output/access_model_metadata/index.ts new file mode 100644 index 00000000..442b3710 --- /dev/null +++ b/sdk-output/access_model_metadata/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Model Metadata + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/beta/package.json b/sdk-output/access_model_metadata/package.json similarity index 81% rename from sdk-output/beta/package.json rename to sdk-output/access_model_metadata/package.json index 4332abe8..65897fe3 100644 --- a/sdk-output/beta/package.json +++ b/sdk-output/access_model_metadata/package.json @@ -1,7 +1,7 @@ { - "name": "sailpoint-sdk", - "version": "1.8.69", - "description": "OpenAPI client for sailpoint-sdk", + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", "author": "OpenAPI-Generator Contributors", "repository": { "type": "git", @@ -12,7 +12,7 @@ "typescript", "openapi-client", "openapi-generator", - "sailpoint-sdk" + "sailpoint-api-client" ], "license": "Unlicense", "main": "./dist/index.js", diff --git a/sdk-output/beta/tsconfig.json b/sdk-output/access_model_metadata/tsconfig.json similarity index 100% rename from sdk-output/beta/tsconfig.json rename to sdk-output/access_model_metadata/tsconfig.json diff --git a/sdk-output/v2024/.gitignore b/sdk-output/access_profiles/.gitignore similarity index 100% rename from sdk-output/v2024/.gitignore rename to sdk-output/access_profiles/.gitignore diff --git a/sdk-output/v2024/.npmignore b/sdk-output/access_profiles/.npmignore similarity index 100% rename from sdk-output/v2024/.npmignore rename to sdk-output/access_profiles/.npmignore diff --git a/sdk-output/v2024/.openapi-generator-ignore b/sdk-output/access_profiles/.openapi-generator-ignore similarity index 100% rename from sdk-output/v2024/.openapi-generator-ignore rename to sdk-output/access_profiles/.openapi-generator-ignore diff --git a/sdk-output/v2024/.openapi-generator/FILES b/sdk-output/access_profiles/.openapi-generator/FILES similarity index 100% rename from sdk-output/v2024/.openapi-generator/FILES rename to sdk-output/access_profiles/.openapi-generator/FILES diff --git a/sdk-output/v2024/.openapi-generator/VERSION b/sdk-output/access_profiles/.openapi-generator/VERSION similarity index 100% rename from sdk-output/v2024/.openapi-generator/VERSION rename to sdk-output/access_profiles/.openapi-generator/VERSION diff --git a/sdk-output/access_profiles/.sdk-partition b/sdk-output/access_profiles/.sdk-partition new file mode 100644 index 00000000..fb72fd25 --- /dev/null +++ b/sdk-output/access_profiles/.sdk-partition @@ -0,0 +1 @@ +access-profiles \ No newline at end of file diff --git a/sdk-output/v2025/README.md b/sdk-output/access_profiles/README.md similarity index 92% rename from sdk-output/v2025/README.md rename to sdk-output/access_profiles/README.md index 51f7499b..e26f6a53 100644 --- a/sdk-output/v2025/README.md +++ b/sdk-output/access_profiles/README.md @@ -1,4 +1,4 @@ -## sailpoint-sdk@1.8.69 +## sailpoint-api-client@1.0.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: @@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co _published:_ ``` -npm install sailpoint-sdk@1.8.69 --save +npm install sailpoint-api-client@1.0.0 --save ``` _unPublished (not recommended):_ diff --git a/sdk-output/access_profiles/api.ts b/sdk-output/access_profiles/api.ts new file mode 100644 index 00000000..17805778 --- /dev/null +++ b/sdk-output/access_profiles/api.ts @@ -0,0 +1,2080 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Profiles + * 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 AccessdurationV1 + */ +export interface AccessdurationV1 { + /** + * The numeric value representing the amount of time, which is defined in the **timeUnit**. + * @type {number} + * @memberof AccessdurationV1 + */ + 'value'?: number; + /** + * The unit of time that corresponds to the **value**. It defines the scale of the time period. + * @type {string} + * @memberof AccessdurationV1 + */ + 'timeUnit'?: AccessdurationV1TimeUnitV1; +} + +export const AccessdurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type AccessdurationV1TimeUnitV1 = typeof AccessdurationV1TimeUnitV1[keyof typeof AccessdurationV1TimeUnitV1]; + +/** + * Metadata that describes an access item + * @export + * @interface AccessmodelmetadataV1 + */ +export interface AccessmodelmetadataV1 { + /** + * Unique identifier for the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'key'?: string; + /** + * Human readable name of the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'name'?: string; + /** + * Allows selecting multiple values + * @type {boolean} + * @memberof AccessmodelmetadataV1 + */ + 'multiselect'?: boolean; + /** + * The state of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'status'?: string; + /** + * The type of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'type'?: string; + /** + * The types of objects + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'objectTypes'?: Array; + /** + * Describes the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'description'?: string; + /** + * The value to assign to the metadata item + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'values'?: Array; +} +/** + * An individual value to assign to the metadata item + * @export + * @interface AccessmodelmetadataValuesInnerV1 + */ +export interface AccessmodelmetadataValuesInnerV1 { + /** + * The value to assign to the metdata item + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'value'?: string; + /** + * Display name of the value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'name'?: string; + /** + * The status of the individual value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'status'?: string; +} +/** + * Access profile. + * @export + * @interface AccessprofileV1 + */ +export interface AccessprofileV1 { + /** + * Access profile ID. + * @type {string} + * @memberof AccessprofileV1 + */ + 'id'?: string; + /** + * Access profile name. + * @type {string} + * @memberof AccessprofileV1 + */ + 'name': string; + /** + * Access profile description. + * @type {string} + * @memberof AccessprofileV1 + */ + 'description'?: string | null; + /** + * Date and time when the access profile was created. + * @type {string} + * @memberof AccessprofileV1 + */ + 'created'?: string; + /** + * Date and time when the access profile was last modified. + * @type {string} + * @memberof AccessprofileV1 + */ + 'modified'?: string; + /** + * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. + * @type {boolean} + * @memberof AccessprofileV1 + */ + 'enabled'?: boolean; + /** + * + * @type {OwnerreferenceV1} + * @memberof AccessprofileV1 + */ + 'owner': OwnerreferenceV1 | null; + /** + * + * @type {AccessprofilesourcerefV1} + * @memberof AccessprofileV1 + */ + 'source': AccessprofilesourcerefV1; + /** + * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. + * @type {Array} + * @memberof AccessprofileV1 + */ + 'entitlements'?: Array | null; + /** + * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. + * @type {boolean} + * @memberof AccessprofileV1 + */ + 'requestable'?: boolean; + /** + * + * @type {RequestabilityV1} + * @memberof AccessprofileV1 + */ + 'accessRequestConfig'?: RequestabilityV1 | null; + /** + * + * @type {RevocabilityV1} + * @memberof AccessprofileV1 + */ + 'revocationRequestConfig'?: RevocabilityV1 | null; + /** + * List of segment IDs, if any, that the access profile is assigned to. + * @type {Array} + * @memberof AccessprofileV1 + */ + 'segments'?: Array | null; + /** + * + * @type {AttributedtolistV1} + * @memberof AccessprofileV1 + */ + 'accessModelMetadata'?: AttributedtolistV1; + /** + * + * @type {Provisioningcriterialevel1V1} + * @memberof AccessprofileV1 + */ + 'provisioningCriteria'?: Provisioningcriterialevel1V1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof AccessprofileV1 + */ + 'additionalOwners'?: Array | null; +} +/** + * + * @export + * @interface AccessprofileapprovalschemeV1 + */ +export interface AccessprofileapprovalschemeV1 { + /** + * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field + * @type {string} + * @memberof AccessprofileapprovalschemeV1 + */ + 'approverType'?: AccessprofileapprovalschemeV1ApproverTypeV1; + /** + * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. + * @type {string} + * @memberof AccessprofileapprovalschemeV1 + */ + 'approverId'?: string | null; +} + +export const AccessprofileapprovalschemeV1ApproverTypeV1 = { + AppOwner: 'APP_OWNER', + Owner: 'OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW', + AllOwners: 'ALL_OWNERS', + AdditionalOwner: 'ADDITIONAL_OWNER', + AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' +} as const; + +export type AccessprofileapprovalschemeV1ApproverTypeV1 = typeof AccessprofileapprovalschemeV1ApproverTypeV1[keyof typeof AccessprofileapprovalschemeV1ApproverTypeV1]; + +/** + * + * @export + * @interface AccessprofilebulkdeleterequestV1 + */ +export interface AccessprofilebulkdeleterequestV1 { + /** + * List of IDs of Access Profiles to be deleted. + * @type {Array} + * @memberof AccessprofilebulkdeleterequestV1 + */ + 'accessProfileIds'?: Array; + /** + * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. + * @type {boolean} + * @memberof AccessprofilebulkdeleterequestV1 + */ + 'bestEffortOnly'?: boolean; +} +/** + * + * @export + * @interface AccessprofilebulkdeleteresponseV1 + */ +export interface AccessprofilebulkdeleteresponseV1 { + /** + * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. + * @type {string} + * @memberof AccessprofilebulkdeleteresponseV1 + */ + 'taskId'?: string; + /** + * List of IDs of Access Profiles which are pending deletion. + * @type {Array} + * @memberof AccessprofilebulkdeleteresponseV1 + */ + 'pending'?: Array; + /** + * List of usages of Access Profiles targeted for deletion. + * @type {Array} + * @memberof AccessprofilebulkdeleteresponseV1 + */ + 'inUse'?: Array; +} +/** + * Access Profile\'s basic details. + * @export + * @interface AccessprofilebulkupdaterequestInnerV1 + */ +export interface AccessprofilebulkupdaterequestInnerV1 { + /** + * Access Profile ID. + * @type {string} + * @memberof AccessprofilebulkupdaterequestInnerV1 + */ + 'id'?: string; + /** + * Access Profile is requestable or not. + * @type {boolean} + * @memberof AccessprofilebulkupdaterequestInnerV1 + */ + 'requestable'?: boolean; +} +/** + * + * @export + * @interface AccessprofilesourcerefV1 + */ +export interface AccessprofilesourcerefV1 { + /** + * ID of the source the access profile is associated with. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'id'?: string; + /** + * Source\'s DTO type. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'type'?: AccessprofilesourcerefV1TypeV1; + /** + * Source name. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'name'?: string; +} + +export const AccessprofilesourcerefV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccessprofilesourcerefV1TypeV1 = typeof AccessprofilesourcerefV1TypeV1[keyof typeof AccessprofilesourcerefV1TypeV1]; + +/** + * + * @export + * @interface AccessprofileupdateitemV1 + */ +export interface AccessprofileupdateitemV1 { + /** + * Identifier of Access Profile in bulk update request. + * @type {string} + * @memberof AccessprofileupdateitemV1 + */ + 'id': string; + /** + * Access Profile requestable or not. + * @type {boolean} + * @memberof AccessprofileupdateitemV1 + */ + 'requestable': boolean; + /** + * The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. + * @type {string} + * @memberof AccessprofileupdateitemV1 + */ + 'status': string; + /** + * Human readable status description and containing additional context information about success or failures etc. + * @type {string} + * @memberof AccessprofileupdateitemV1 + */ + 'description'?: string; +} +/** + * Role using the access profile. + * @export + * @interface AccessprofileusageUsedByInnerV1 + */ +export interface AccessprofileusageUsedByInnerV1 { + /** + * DTO type of role using the access profile. + * @type {string} + * @memberof AccessprofileusageUsedByInnerV1 + */ + 'type'?: AccessprofileusageUsedByInnerV1TypeV1; + /** + * ID of role using the access profile. + * @type {string} + * @memberof AccessprofileusageUsedByInnerV1 + */ + 'id'?: string; + /** + * Display name of role using the access profile. + * @type {string} + * @memberof AccessprofileusageUsedByInnerV1 + */ + 'name'?: string; +} + +export const AccessprofileusageUsedByInnerV1TypeV1 = { + Role: 'ROLE' +} as const; + +export type AccessprofileusageUsedByInnerV1TypeV1 = typeof AccessprofileusageUsedByInnerV1TypeV1[keyof typeof AccessprofileusageUsedByInnerV1TypeV1]; + +/** + * + * @export + * @interface AccessprofileusageV1 + */ +export interface AccessprofileusageV1 { + /** + * ID of the Access Profile that is in use + * @type {string} + * @memberof AccessprofileusageV1 + */ + 'accessProfileId'?: string; + /** + * List of references to objects which are using the indicated Access Profile + * @type {Array} + * @memberof AccessprofileusageV1 + */ + 'usedBy'?: Array; +} +/** + * Reference to an additional owner (identity or governance group). + * @export + * @interface AdditionalownerrefV1 + */ +export interface AdditionalownerrefV1 { + /** + * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'type'?: AdditionalownerrefV1TypeV1; + /** + * ID of the identity or governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'id'?: string; + /** + * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'name'?: string | null; +} + +export const AdditionalownerrefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type AdditionalownerrefV1TypeV1 = typeof AdditionalownerrefV1TypeV1[keyof typeof AdditionalownerrefV1TypeV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AttributedtoV1 + */ +export interface AttributedtoV1 { + /** + * Technical name of the Attribute. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributedtoV1 + */ + 'key'?: string; + /** + * The display name of the key. + * @type {string} + * @memberof AttributedtoV1 + */ + 'name'?: string; + /** + * Indicates whether the attribute can have multiple values. + * @type {boolean} + * @memberof AttributedtoV1 + */ + 'multiselect'?: boolean; + /** + * The status of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'status'?: string; + /** + * The type of the Attribute. This can be either \"custom\" or \"governance\". + * @type {string} + * @memberof AttributedtoV1 + */ + 'type'?: string; + /** + * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. + * @type {Array} + * @memberof AttributedtoV1 + */ + 'objectTypes'?: Array | null; + /** + * The description of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'description'?: string; + /** + * + * @type {Array} + * @memberof AttributedtoV1 + */ + 'values'?: Array | null; +} +/** + * + * @export + * @interface AttributedtolistV1 + */ +export interface AttributedtolistV1 { + /** + * + * @type {Array} + * @memberof AttributedtolistV1 + */ + 'attributes'?: Array | null; +} +/** + * + * @export + * @interface AttributevaluedtoV1 + */ +export interface AttributevaluedtoV1 { + /** + * Technical name of the Attribute value. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'value'?: string; + /** + * The display name of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'name'?: string; + /** + * The status of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'status'?: string; +} +/** + * Additional data to classify the entitlement + * @export + * @interface EntitlementAccessModelMetadataV1 + */ +export interface EntitlementAccessModelMetadataV1 { + /** + * + * @type {Array} + * @memberof EntitlementAccessModelMetadataV1 + */ + 'attributes'?: Array; +} +/** + * The identity that owns the entitlement + * @export + * @interface EntitlementOwnerV1 + */ +export interface EntitlementOwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'id'?: string; + /** + * The type of object + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'type'?: EntitlementOwnerV1TypeV1; + /** + * The display name of the identity + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'name'?: string; +} + +export const EntitlementOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type EntitlementOwnerV1TypeV1 = typeof EntitlementOwnerV1TypeV1[keyof typeof EntitlementOwnerV1TypeV1]; + +/** + * + * @export + * @interface EntitlementSourceV1 + */ +export interface EntitlementSourceV1 { + /** + * The source ID + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV1 + */ +export interface EntitlementV1 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV1 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV1 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'description'?: string | null; + /** + * True if the entitlement is privileged + * @type {boolean} + * @memberof EntitlementV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV1 + */ + 'requestable'?: boolean; + /** + * + * @type {EntitlementOwnerV1} + * @memberof EntitlementV1 + */ + 'owner'?: EntitlementOwnerV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof EntitlementV1 + */ + 'additionalOwners'?: Array | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {EntitlementAccessModelMetadataV1} + * @memberof EntitlementV1 + */ + 'accessModelMetadata'?: EntitlementAccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV1 + */ + 'modified'?: string; + /** + * + * @type {EntitlementSourceV1} + * @memberof EntitlementV1 + */ + 'source'?: EntitlementSourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV1 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV1 + */ + 'directPermissions'?: Array; +} +/** + * Entitlement including a specific set of access. + * @export + * @interface EntitlementrefV1 + */ +export interface EntitlementrefV1 { + /** + * Entitlement\'s DTO type. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'type'?: EntitlementrefV1TypeV1; + /** + * Entitlement\'s ID. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'id'?: string; + /** + * Entitlement\'s display name. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'name'?: string | null; +} + +export const EntitlementrefV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type EntitlementrefV1TypeV1 = typeof EntitlementrefV1TypeV1[keyof typeof EntitlementrefV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListAccessProfilesV1401ResponseV1 + */ +export interface ListAccessProfilesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccessProfilesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListAccessProfilesV1429ResponseV1 + */ +export interface ListAccessProfilesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccessProfilesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner of the object. + * @export + * @interface OwnerreferenceV1 + */ +export interface OwnerreferenceV1 { + /** + * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'type'?: OwnerreferenceV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'id'?: string; + /** + * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'name'?: string; +} + +export const OwnerreferenceV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerreferenceV1TypeV1 = typeof OwnerreferenceV1TypeV1[keyof typeof OwnerreferenceV1TypeV1]; + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel1V1 + */ +export interface Provisioningcriterialevel1V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel1V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel1V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel1V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {Array} + * @memberof Provisioningcriterialevel1V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel2V1 + */ +export interface Provisioningcriterialevel2V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel2V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel2V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel2V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {Array} + * @memberof Provisioningcriterialevel2V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel3V1 + */ +export interface Provisioningcriterialevel3V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel3V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'children'?: string | null; +} + + +/** + * Supported operations on `ProvisioningCriteria`. + * @export + * @enum {string} + */ + +export const ProvisioningcriteriaoperationV1 = { + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + Contains: 'CONTAINS', + Has: 'HAS', + And: 'AND', + Or: 'OR' +} as const; + +export type ProvisioningcriteriaoperationV1 = typeof ProvisioningcriteriaoperationV1[keyof typeof ProvisioningcriteriaoperationV1]; + + +/** + * + * @export + * @interface RequestabilityV1 + */ +export interface RequestabilityV1 { + /** + * Indicates whether the requester of the containing object must provide comments justifying the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'commentsRequired'?: boolean | null; + /** + * Indicates whether an approver must provide comments when denying the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'denialCommentsRequired'?: boolean | null; + /** + * Indicates whether reauthorization is required for the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'reauthorizationRequired'?: boolean | null; + /** + * Indicates whether the requester of the containing object must provide access end date. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'requireEndDate'?: boolean | null; + /** + * + * @type {AccessdurationV1} + * @memberof RequestabilityV1 + */ + 'maxPermittedAccessDuration'?: AccessdurationV1 | null; + /** + * List describing the steps involved in approving the request. + * @type {Array} + * @memberof RequestabilityV1 + */ + 'approvalSchemes'?: Array | null; +} +/** + * + * @export + * @interface RevocabilityV1 + */ +export interface RevocabilityV1 { + /** + * List describing the steps involved in approving the revocation request. + * @type {Array} + * @memberof RevocabilityV1 + */ + 'approvalSchemes'?: Array | null; +} +/** + * + * @export + * @interface UpdateAccessProfilesInBulkV1412ResponseV1 + */ +export interface UpdateAccessProfilesInBulkV1412ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof UpdateAccessProfilesInBulkV1412ResponseV1 + */ + 'message'?: any; +} + +/** + * AccessProfilesV1Api - axios parameter creator + * @export + */ +export const AccessProfilesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. + * @summary Create access profile + * @param {AccessprofileV1} accessprofileV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessProfileV1: async (accessprofileV1: AccessprofileV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessprofileV1' is not null or undefined + assertParamExists('createAccessProfileV1', 'accessprofileV1', accessprofileV1) + const localVarPath = `/access-profiles/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(accessprofileV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + * @summary Delete the specified access profile + * @param {string} id ID of the Access Profile to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfileV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccessProfileV1', 'id', id) + const localVarPath = `/access-profiles/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, + }; + }, + /** + * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. + * @summary Delete access profile(s) + * @param {AccessprofilebulkdeleterequestV1} accessprofilebulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfilesInBulkV1: async (accessprofilebulkdeleterequestV1: AccessprofilebulkdeleterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessprofilebulkdeleterequestV1' is not null or undefined + assertParamExists('deleteAccessProfilesInBulkV1', 'accessprofilebulkdeleterequestV1', accessprofilebulkdeleterequestV1) + const localVarPath = `/access-profiles/v1/bulk-delete`; + // 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(accessprofilebulkdeleterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profile\'s entitlements + * @param {string} id ID of the access profile containing the entitlements. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @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: **name, attribute, value, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessProfileEntitlementsV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccessProfileEntitlementsV1', 'id', id) + const localVarPath = `/access-profiles/v1/{id}/entitlements` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns an Access Profile by its ID. + * @summary Get an access profile + * @param {string} id ID of the Access Profile + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessProfileV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccessProfileV1', 'id', id) + const localVarPath = `/access-profiles/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, + }; + }, + /** + * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profiles + * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @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: **name, created, modified** + * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessProfilesV1: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-profiles/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 (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (forSegmentIds !== undefined) { + localVarQueryParameter['for-segment-ids'] = forSegmentIds; + } + + if (includeUnsegmented !== undefined) { + localVarQueryParameter['include-unsegmented'] = includeUnsegmented; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. + * @summary Patch a specified access profile + * @param {string} id ID of the Access Profile to patch + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAccessProfileV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchAccessProfileV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAccessProfileV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/access-profiles/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + * @summary Update access profile(s) requestable field. + * @param {Array} accessprofilebulkupdaterequestInnerV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessProfilesInBulkV1: async (accessprofilebulkupdaterequestInnerV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessprofilebulkupdaterequestInnerV1' is not null or undefined + assertParamExists('updateAccessProfilesInBulkV1', 'accessprofilebulkupdaterequestInnerV1', accessprofilebulkupdaterequestInnerV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/access-profiles/v1/bulk-update-requestable`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessprofilebulkupdaterequestInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccessProfilesV1Api - functional programming interface + * @export + */ +export const AccessProfilesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccessProfilesV1ApiAxiosParamCreator(configuration) + return { + /** + * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. + * @summary Create access profile + * @param {AccessprofileV1} accessprofileV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccessProfileV1(accessprofileV1: AccessprofileV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfileV1(accessprofileV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.createAccessProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + * @summary Delete the specified access profile + * @param {string} id ID of the Access Profile to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccessProfileV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfileV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.deleteAccessProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. + * @summary Delete access profile(s) + * @param {AccessprofilebulkdeleterequestV1} accessprofilebulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccessProfilesInBulkV1(accessprofilebulkdeleterequestV1: AccessprofilebulkdeleterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulkV1(accessprofilebulkdeleterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.deleteAccessProfilesInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profile\'s entitlements + * @param {string} id ID of the access profile containing the entitlements. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @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: **name, attribute, value, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessProfileEntitlementsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlementsV1(id, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.getAccessProfileEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns an Access Profile by its ID. + * @summary Get an access profile + * @param {string} id ID of the Access Profile + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessProfileV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.getAccessProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profiles + * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @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: **name, created, modified** + * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessProfilesV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesV1(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.listAccessProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. + * @summary Patch a specified access profile + * @param {string} id ID of the Access Profile to patch + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAccessProfileV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfileV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.patchAccessProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + * @summary Update access profile(s) requestable field. + * @param {Array} accessprofilebulkupdaterequestInnerV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAccessProfilesInBulkV1(accessprofilebulkupdaterequestInnerV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessProfilesInBulkV1(accessprofilebulkupdaterequestInnerV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessProfilesV1Api.updateAccessProfilesInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccessProfilesV1Api - factory interface + * @export + */ +export const AccessProfilesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccessProfilesV1ApiFp(configuration) + return { + /** + * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. + * @summary Create access profile + * @param {AccessProfilesV1ApiCreateAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessProfileV1(requestParameters: AccessProfilesV1ApiCreateAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccessProfileV1(requestParameters.accessprofileV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + * @summary Delete the specified access profile + * @param {AccessProfilesV1ApiDeleteAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfileV1(requestParameters: AccessProfilesV1ApiDeleteAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccessProfileV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. + * @summary Delete access profile(s) + * @param {AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccessProfilesInBulkV1(requestParameters.accessprofilebulkdeleterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profile\'s entitlements + * @param {AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessProfileEntitlementsV1(requestParameters: AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccessProfileEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns an Access Profile by its ID. + * @summary Get an access profile + * @param {AccessProfilesV1ApiGetAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessProfileV1(requestParameters: AccessProfilesV1ApiGetAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessProfileV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profiles + * @param {AccessProfilesV1ApiListAccessProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessProfilesV1(requestParameters: AccessProfilesV1ApiListAccessProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessProfilesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. + * @summary Patch a specified access profile + * @param {AccessProfilesV1ApiPatchAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAccessProfileV1(requestParameters: AccessProfilesV1ApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAccessProfileV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + * @summary Update access profile(s) requestable field. + * @param {AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccessProfilesInBulkV1(requestParameters: AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.updateAccessProfilesInBulkV1(requestParameters.accessprofilebulkupdaterequestInnerV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createAccessProfileV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiCreateAccessProfileV1Request + */ +export interface AccessProfilesV1ApiCreateAccessProfileV1Request { + /** + * + * @type {AccessprofileV1} + * @memberof AccessProfilesV1ApiCreateAccessProfileV1 + */ + readonly accessprofileV1: AccessprofileV1 +} + +/** + * Request parameters for deleteAccessProfileV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiDeleteAccessProfileV1Request + */ +export interface AccessProfilesV1ApiDeleteAccessProfileV1Request { + /** + * ID of the Access Profile to delete + * @type {string} + * @memberof AccessProfilesV1ApiDeleteAccessProfileV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteAccessProfilesInBulkV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request + */ +export interface AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request { + /** + * + * @type {AccessprofilebulkdeleterequestV1} + * @memberof AccessProfilesV1ApiDeleteAccessProfilesInBulkV1 + */ + readonly accessprofilebulkdeleterequestV1: AccessprofilebulkdeleterequestV1 +} + +/** + * Request parameters for getAccessProfileEntitlementsV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request + */ +export interface AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request { + /** + * ID of the access profile containing the entitlements. + * @type {string} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @type {string} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + 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: **name, attribute, value, created, modified** + * @type {string} + * @memberof AccessProfilesV1ApiGetAccessProfileEntitlementsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getAccessProfileV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiGetAccessProfileV1Request + */ +export interface AccessProfilesV1ApiGetAccessProfileV1Request { + /** + * ID of the Access Profile + * @type {string} + * @memberof AccessProfilesV1ApiGetAccessProfileV1 + */ + readonly id: string +} + +/** + * Request parameters for listAccessProfilesV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiListAccessProfilesV1Request + */ +export interface AccessProfilesV1ApiListAccessProfilesV1Request { + /** + * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. + * @type {string} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly forSubadmin?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. + * @type {string} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + 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: **name, created, modified** + * @type {string} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly sorters?: string + + /** + * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @type {string} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly forSegmentIds?: string + + /** + * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. + * @type {boolean} + * @memberof AccessProfilesV1ApiListAccessProfilesV1 + */ + readonly includeUnsegmented?: boolean +} + +/** + * Request parameters for patchAccessProfileV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiPatchAccessProfileV1Request + */ +export interface AccessProfilesV1ApiPatchAccessProfileV1Request { + /** + * ID of the Access Profile to patch + * @type {string} + * @memberof AccessProfilesV1ApiPatchAccessProfileV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof AccessProfilesV1ApiPatchAccessProfileV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateAccessProfilesInBulkV1 operation in AccessProfilesV1Api. + * @export + * @interface AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request + */ +export interface AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request { + /** + * + * @type {Array} + * @memberof AccessProfilesV1ApiUpdateAccessProfilesInBulkV1 + */ + readonly accessprofilebulkupdaterequestInnerV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AccessProfilesV1ApiUpdateAccessProfilesInBulkV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * AccessProfilesV1Api - object-oriented interface + * @export + * @class AccessProfilesV1Api + * @extends {BaseAPI} + */ +export class AccessProfilesV1Api extends BaseAPI { + /** + * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. + * @summary Create access profile + * @param {AccessProfilesV1ApiCreateAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public createAccessProfileV1(requestParameters: AccessProfilesV1ApiCreateAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).createAccessProfileV1(requestParameters.accessprofileV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + * @summary Delete the specified access profile + * @param {AccessProfilesV1ApiDeleteAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public deleteAccessProfileV1(requestParameters: AccessProfilesV1ApiDeleteAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).deleteAccessProfileV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. + * @summary Delete access profile(s) + * @param {AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesV1ApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).deleteAccessProfilesInBulkV1(requestParameters.accessprofilebulkdeleterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profile\'s entitlements + * @param {AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public getAccessProfileEntitlementsV1(requestParameters: AccessProfilesV1ApiGetAccessProfileEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).getAccessProfileEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns an Access Profile by its ID. + * @summary Get an access profile + * @param {AccessProfilesV1ApiGetAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public getAccessProfileV1(requestParameters: AccessProfilesV1ApiGetAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).getAccessProfileV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. + * @summary List access profiles + * @param {AccessProfilesV1ApiListAccessProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public listAccessProfilesV1(requestParameters: AccessProfilesV1ApiListAccessProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).listAccessProfilesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. + * @summary Patch a specified access profile + * @param {AccessProfilesV1ApiPatchAccessProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public patchAccessProfileV1(requestParameters: AccessProfilesV1ApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).patchAccessProfileV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + * @summary Update access profile(s) requestable field. + * @param {AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessProfilesV1Api + */ + public updateAccessProfilesInBulkV1(requestParameters: AccessProfilesV1ApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessProfilesV1ApiFp(this.configuration).updateAccessProfilesInBulkV1(requestParameters.accessprofilebulkupdaterequestInnerV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/access_profiles/base.ts b/sdk-output/access_profiles/base.ts new file mode 100644 index 00000000..30615824 --- /dev/null +++ b/sdk-output/access_profiles/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Profiles + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/access_profiles/common.ts b/sdk-output/access_profiles/common.ts new file mode 100644 index 00000000..ccad91b4 --- /dev/null +++ b/sdk-output/access_profiles/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Profiles + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/access_profiles/configuration.ts b/sdk-output/access_profiles/configuration.ts new file mode 100644 index 00000000..5ac4de63 --- /dev/null +++ b/sdk-output/access_profiles/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Profiles + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/v2024/git_push.sh b/sdk-output/access_profiles/git_push.sh similarity index 100% rename from sdk-output/v2024/git_push.sh rename to sdk-output/access_profiles/git_push.sh diff --git a/sdk-output/access_profiles/index.ts b/sdk-output/access_profiles/index.ts new file mode 100644 index 00000000..ff68a39b --- /dev/null +++ b/sdk-output/access_profiles/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Profiles + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/v2024/package.json b/sdk-output/access_profiles/package.json similarity index 81% rename from sdk-output/v2024/package.json rename to sdk-output/access_profiles/package.json index 4332abe8..65897fe3 100644 --- a/sdk-output/v2024/package.json +++ b/sdk-output/access_profiles/package.json @@ -1,7 +1,7 @@ { - "name": "sailpoint-sdk", - "version": "1.8.69", - "description": "OpenAPI client for sailpoint-sdk", + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", "author": "OpenAPI-Generator Contributors", "repository": { "type": "git", @@ -12,7 +12,7 @@ "typescript", "openapi-client", "openapi-generator", - "sailpoint-sdk" + "sailpoint-api-client" ], "license": "Unlicense", "main": "./dist/index.js", diff --git a/sdk-output/v2024/tsconfig.json b/sdk-output/access_profiles/tsconfig.json similarity index 100% rename from sdk-output/v2024/tsconfig.json rename to sdk-output/access_profiles/tsconfig.json diff --git a/sdk-output/v2025/.gitignore b/sdk-output/access_request_approvals/.gitignore similarity index 100% rename from sdk-output/v2025/.gitignore rename to sdk-output/access_request_approvals/.gitignore diff --git a/sdk-output/v2025/.npmignore b/sdk-output/access_request_approvals/.npmignore similarity index 100% rename from sdk-output/v2025/.npmignore rename to sdk-output/access_request_approvals/.npmignore diff --git a/sdk-output/v2025/.openapi-generator-ignore b/sdk-output/access_request_approvals/.openapi-generator-ignore similarity index 100% rename from sdk-output/v2025/.openapi-generator-ignore rename to sdk-output/access_request_approvals/.openapi-generator-ignore diff --git a/sdk-output/v2025/.openapi-generator/FILES b/sdk-output/access_request_approvals/.openapi-generator/FILES similarity index 100% rename from sdk-output/v2025/.openapi-generator/FILES rename to sdk-output/access_request_approvals/.openapi-generator/FILES diff --git a/sdk-output/v2025/.openapi-generator/VERSION b/sdk-output/access_request_approvals/.openapi-generator/VERSION similarity index 100% rename from sdk-output/v2025/.openapi-generator/VERSION rename to sdk-output/access_request_approvals/.openapi-generator/VERSION diff --git a/sdk-output/access_request_approvals/.sdk-partition b/sdk-output/access_request_approvals/.sdk-partition new file mode 100644 index 00000000..ef8370d7 --- /dev/null +++ b/sdk-output/access_request_approvals/.sdk-partition @@ -0,0 +1 @@ +access-request-approvals \ No newline at end of file diff --git a/sdk-output/v2024/README.md b/sdk-output/access_request_approvals/README.md similarity index 92% rename from sdk-output/v2024/README.md rename to sdk-output/access_request_approvals/README.md index 51f7499b..e26f6a53 100644 --- a/sdk-output/v2024/README.md +++ b/sdk-output/access_request_approvals/README.md @@ -1,4 +1,4 @@ -## sailpoint-sdk@1.8.69 +## sailpoint-api-client@1.0.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: @@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co _published:_ ``` -npm install sailpoint-sdk@1.8.69 --save +npm install sailpoint-api-client@1.0.0 --save ``` _unPublished (not recommended):_ diff --git a/sdk-output/access_request_approvals/api.ts b/sdk-output/access_request_approvals/api.ts new file mode 100644 index 00000000..367936fb --- /dev/null +++ b/sdk-output/access_request_approvals/api.ts @@ -0,0 +1,2170 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Approvals + * 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'; + +/** + * Identity the access item is requested for. + * @export + * @interface AccessitemrequestedforV1 + */ +export interface AccessitemrequestedforV1 { + /** + * DTO type of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedforV1 + */ + 'type'?: AccessitemrequestedforV1TypeV1; + /** + * ID of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedforV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedforV1 + */ + 'name'?: string; +} + +export const AccessitemrequestedforV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemrequestedforV1TypeV1 = typeof AccessitemrequestedforV1TypeV1[keyof typeof AccessitemrequestedforV1TypeV1]; + +/** + * Access item requester\'s identity. + * @export + * @interface AccessitemrequesterV1 + */ +export interface AccessitemrequesterV1 { + /** + * Access item requester\'s DTO type. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'type'?: AccessitemrequesterV1TypeV1; + /** + * Access item requester\'s identity ID. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'id'?: string; + /** + * Access item owner\'s human-readable display name. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'name'?: string; +} + +export const AccessitemrequesterV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemrequesterV1TypeV1 = typeof AccessitemrequesterV1TypeV1[keyof typeof AccessitemrequesterV1TypeV1]; + +/** + * Identity who reviewed the access item request. + * @export + * @interface AccessitemreviewedbyV1 + */ +export interface AccessitemreviewedbyV1 { + /** + * DTO type of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'type'?: AccessitemreviewedbyV1TypeV1; + /** + * ID of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'name'?: string; +} + +export const AccessitemreviewedbyV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemreviewedbyV1TypeV1 = typeof AccessitemreviewedbyV1TypeV1[keyof typeof AccessitemreviewedbyV1TypeV1]; + +/** + * + * @export + * @interface AccessrequestapproverslistresponseV1 + */ +export interface AccessrequestapproverslistresponseV1 { + /** + * Approver id. + * @type {string} + * @memberof AccessrequestapproverslistresponseV1 + */ + 'id'?: string; + /** + * Email of the approver. + * @type {string} + * @memberof AccessrequestapproverslistresponseV1 + */ + 'email'?: string; + /** + * Name of the approver. + * @type {string} + * @memberof AccessrequestapproverslistresponseV1 + */ + 'name'?: string; + /** + * Id of the approval item. + * @type {string} + * @memberof AccessrequestapproverslistresponseV1 + */ + 'approvalId'?: string; + /** + * Type of the object returned. In this case, the value for this field will always Identity. + * @type {string} + * @memberof AccessrequestapproverslistresponseV1 + */ + 'type'?: string; +} +/** + * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. + * @export + * @enum {string} + */ + +export const AccessrequesttypeV1 = { + GrantAccess: 'GRANT_ACCESS', + RevokeAccess: 'REVOKE_ACCESS', + ModifyAccess: 'MODIFY_ACCESS' +} as const; + +export type AccessrequesttypeV1 = typeof AccessrequesttypeV1[keyof typeof AccessrequesttypeV1]; + + +/** + * + * @export + * @interface ApprovalforwardhistoryV1 + */ +export interface ApprovalforwardhistoryV1 { + /** + * Display name of approver from whom the approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'oldApproverName'?: string; + /** + * Display name of approver to whom the approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'newApproverName'?: string; + /** + * Comment made while forwarding. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'comment'?: string | null; + /** + * Time at which approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'modified'?: string; + /** + * Display name of forwarder who forwarded the approval. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'forwarderName'?: string | null; + /** + * + * @type {ReassignmenttypeV1} + * @memberof ApprovalforwardhistoryV1 + */ + 'reassignmentType'?: ReassignmenttypeV1; +} + + +/** + * + * @export + * @interface ApprovalsummaryV1 + */ +export interface ApprovalsummaryV1 { + /** + * The number of pending access requests approvals. + * @type {number} + * @memberof ApprovalsummaryV1 + */ + 'pending'?: number; + /** + * The number of approved access requests approvals. + * @type {number} + * @memberof ApprovalsummaryV1 + */ + 'approved'?: number; + /** + * The number of rejected access requests approvals. + * @type {number} + * @memberof ApprovalsummaryV1 + */ + 'rejected'?: number; +} +/** + * Author of the comment + * @export + * @interface CommentdtoAuthorV1 + */ +export interface CommentdtoAuthorV1 { + /** + * The type of object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'type'?: CommentdtoAuthorV1TypeV1; + /** + * The unique ID of the object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'id'?: string; + /** + * The display name of the object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'name'?: string; +} + +export const CommentdtoAuthorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type CommentdtoAuthorV1TypeV1 = typeof CommentdtoAuthorV1TypeV1[keyof typeof CommentdtoAuthorV1TypeV1]; + +/** + * + * @export + * @interface CommentdtoV1 + */ +export interface CommentdtoV1 { + /** + * Comment content. + * @type {string} + * @memberof CommentdtoV1 + */ + 'comment'?: string | null; + /** + * Date and time comment was created. + * @type {string} + * @memberof CommentdtoV1 + */ + 'created'?: string; + /** + * + * @type {CommentdtoAuthorV1} + * @memberof CommentdtoV1 + */ + 'author'?: CommentdtoAuthorV1; +} +/** + * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. + * @export + * @interface CompletedapprovalPreApprovalTriggerResultV1 + */ +export interface CompletedapprovalPreApprovalTriggerResultV1 { + /** + * The comment from the trigger + * @type {string} + * @memberof CompletedapprovalPreApprovalTriggerResultV1 + */ + 'comment'?: string; + /** + * + * @type {CompletedapprovalstateV1} + * @memberof CompletedapprovalPreApprovalTriggerResultV1 + */ + 'decision'?: CompletedapprovalstateV1; + /** + * The name of the approver + * @type {string} + * @memberof CompletedapprovalPreApprovalTriggerResultV1 + */ + 'reviewer'?: string; + /** + * The date and time the trigger decided on the request + * @type {string} + * @memberof CompletedapprovalPreApprovalTriggerResultV1 + */ + 'date'?: string; +} + + +/** + * Identity access was requested for. + * @export + * @interface CompletedapprovalRequestedForV1 + */ +export interface CompletedapprovalRequestedForV1 { + /** + * Type of the object to which this reference applies + * @type {string} + * @memberof CompletedapprovalRequestedForV1 + */ + 'type'?: CompletedapprovalRequestedForV1TypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof CompletedapprovalRequestedForV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof CompletedapprovalRequestedForV1 + */ + 'name'?: string; +} + +export const CompletedapprovalRequestedForV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type CompletedapprovalRequestedForV1TypeV1 = typeof CompletedapprovalRequestedForV1TypeV1[keyof typeof CompletedapprovalRequestedForV1TypeV1]; + +/** + * + * @export + * @interface CompletedapprovalRequesterCommentV1 + */ +export interface CompletedapprovalRequesterCommentV1 { + /** + * Comment content. + * @type {string} + * @memberof CompletedapprovalRequesterCommentV1 + */ + 'comment'?: string | null; + /** + * Date and time comment was created. + * @type {string} + * @memberof CompletedapprovalRequesterCommentV1 + */ + 'created'?: string; + /** + * + * @type {CommentdtoAuthorV1} + * @memberof CompletedapprovalRequesterCommentV1 + */ + 'author'?: CommentdtoAuthorV1; +} +/** + * + * @export + * @interface CompletedapprovalReviewerCommentV1 + */ +export interface CompletedapprovalReviewerCommentV1 { + /** + * Comment content. + * @type {string} + * @memberof CompletedapprovalReviewerCommentV1 + */ + 'comment'?: string | null; + /** + * Date and time comment was created. + * @type {string} + * @memberof CompletedapprovalReviewerCommentV1 + */ + 'created'?: string; + /** + * + * @type {CommentdtoAuthorV1} + * @memberof CompletedapprovalReviewerCommentV1 + */ + 'author'?: CommentdtoAuthorV1; +} +/** + * + * @export + * @interface CompletedapprovalV1 + */ +export interface CompletedapprovalV1 { + /** + * The approval id. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'id'?: string; + /** + * The name of the approval. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'name'?: string; + /** + * When the approval was created. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'created'?: string; + /** + * When the approval was modified last time. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'modified'?: string; + /** + * When the access-request was created. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'requestCreated'?: string; + /** + * + * @type {AccessrequesttypeV1} + * @memberof CompletedapprovalV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * + * @type {AccessitemrequesterV1} + * @memberof CompletedapprovalV1 + */ + 'requester'?: AccessitemrequesterV1; + /** + * + * @type {CompletedapprovalRequestedForV1} + * @memberof CompletedapprovalV1 + */ + 'requestedFor'?: CompletedapprovalRequestedForV1; + /** + * + * @type {AccessitemreviewedbyV1} + * @memberof CompletedapprovalV1 + */ + 'reviewedBy'?: AccessitemreviewedbyV1; + /** + * + * @type {OwnerdtoV1} + * @memberof CompletedapprovalV1 + */ + 'owner'?: OwnerdtoV1; + /** + * + * @type {RequestableobjectreferenceV1} + * @memberof CompletedapprovalV1 + */ + 'requestedObject'?: RequestableobjectreferenceV1; + /** + * + * @type {CompletedapprovalRequesterCommentV1} + * @memberof CompletedapprovalV1 + */ + 'requesterComment'?: CompletedapprovalRequesterCommentV1; + /** + * + * @type {CompletedapprovalReviewerCommentV1} + * @memberof CompletedapprovalV1 + */ + 'reviewerComment'?: CompletedapprovalReviewerCommentV1; + /** + * The history of the previous reviewers comments. + * @type {Array} + * @memberof CompletedapprovalV1 + */ + 'previousReviewersComments'?: Array; + /** + * The history of approval forward action. + * @type {Array} + * @memberof CompletedapprovalV1 + */ + 'forwardHistory'?: Array; + /** + * When true the rejector has to provide comments when rejecting + * @type {boolean} + * @memberof CompletedapprovalV1 + */ + 'commentRequiredWhenRejected'?: boolean; + /** + * + * @type {CompletedapprovalstateV1} + * @memberof CompletedapprovalV1 + */ + 'state'?: CompletedapprovalstateV1; + /** + * The date the role or access profile or entitlement is no longer assigned to the specified identity. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'removeDate'?: string | null; + /** + * If true, then the request was to change the remove date or sunset date. + * @type {boolean} + * @memberof CompletedapprovalV1 + */ + 'removeDateUpdateRequested'?: boolean; + /** + * The remove date or sunset date that was assigned at the time of the request. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'currentRemoveDate'?: string | null; + /** + * The date the role or access profile or entitlement is/will assigned to the specified identity. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'startDate'?: string; + /** + * If true, then the request is to change the start date or sunrise date. + * @type {boolean} + * @memberof CompletedapprovalV1 + */ + 'startUpdateRequested'?: boolean; + /** + * The start date or sunrise date that was assigned at the time of the request. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'currentStartDate'?: string; + /** + * + * @type {SodviolationcontextcheckcompletedV1} + * @memberof CompletedapprovalV1 + */ + 'sodViolationContext'?: SodviolationcontextcheckcompletedV1 | null; + /** + * + * @type {CompletedapprovalPreApprovalTriggerResultV1} + * @memberof CompletedapprovalV1 + */ + 'preApprovalTriggerResult'?: CompletedapprovalPreApprovalTriggerResultV1 | null; + /** + * Arbitrary key-value pairs provided during the request. + * @type {{ [key: string]: string; }} + * @memberof CompletedapprovalV1 + */ + 'clientMetadata'?: { [key: string]: string; }; + /** + * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. + * @type {Array} + * @memberof CompletedapprovalV1 + */ + 'requestedAccounts'?: Array | null; + /** + * The privilege level of the requested access item, if applicable. + * @type {string} + * @memberof CompletedapprovalV1 + */ + 'privilegeLevel'?: string | null; + /** + * + * @type {PendingapprovalMaxPermittedAccessDurationV1} + * @memberof CompletedapprovalV1 + */ + 'maxPermittedAccessDuration'?: PendingapprovalMaxPermittedAccessDurationV1 | null; +} + + +/** + * Enum represents completed approval object\'s state. + * @export + * @enum {string} + */ + +export const CompletedapprovalstateV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED' +} as const; + +export type CompletedapprovalstateV1 = typeof CompletedapprovalstateV1[keyof typeof CompletedapprovalstateV1]; + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ForwardapprovaldtoV1 + */ +export interface ForwardapprovaldtoV1 { + /** + * The Id of the new owner + * @type {string} + * @memberof ForwardapprovaldtoV1 + */ + 'newOwnerId': string; + /** + * The comment provided by the forwarder + * @type {string} + * @memberof ForwardapprovaldtoV1 + */ + 'comment': string; +} +/** + * + * @export + * @interface ListPendingApprovalsV1401ResponseV1 + */ +export interface ListPendingApprovalsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPendingApprovalsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListPendingApprovalsV1429ResponseV1 + */ +export interface ListPendingApprovalsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPendingApprovalsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner\'s identity. + * @export + * @interface OwnerdtoV1 + */ +export interface OwnerdtoV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'type'?: OwnerdtoV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'name'?: string; +} + +export const OwnerdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerdtoV1TypeV1 = typeof OwnerdtoV1TypeV1[keyof typeof OwnerdtoV1TypeV1]; + +/** + * The maximum duration for which the access is permitted. + * @export + * @interface PendingapprovalMaxPermittedAccessDurationV1 + */ +export interface PendingapprovalMaxPermittedAccessDurationV1 { + /** + * The numeric value of the duration. + * @type {number} + * @memberof PendingapprovalMaxPermittedAccessDurationV1 + */ + 'value'?: number; + /** + * The time unit for the duration. + * @type {string} + * @memberof PendingapprovalMaxPermittedAccessDurationV1 + */ + 'timeUnit'?: PendingapprovalMaxPermittedAccessDurationV1TimeUnitV1; +} + +export const PendingapprovalMaxPermittedAccessDurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type PendingapprovalMaxPermittedAccessDurationV1TimeUnitV1 = typeof PendingapprovalMaxPermittedAccessDurationV1TimeUnitV1[keyof typeof PendingapprovalMaxPermittedAccessDurationV1TimeUnitV1]; + +/** + * Access item owner\'s identity. + * @export + * @interface PendingapprovalOwnerV1 + */ +export interface PendingapprovalOwnerV1 { + /** + * Access item owner\'s DTO type. + * @type {string} + * @memberof PendingapprovalOwnerV1 + */ + 'type'?: PendingapprovalOwnerV1TypeV1; + /** + * Access item owner\'s identity ID. + * @type {string} + * @memberof PendingapprovalOwnerV1 + */ + 'id'?: string; + /** + * Access item owner\'s human-readable display name. + * @type {string} + * @memberof PendingapprovalOwnerV1 + */ + 'name'?: string; +} + +export const PendingapprovalOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type PendingapprovalOwnerV1TypeV1 = typeof PendingapprovalOwnerV1TypeV1[keyof typeof PendingapprovalOwnerV1TypeV1]; + +/** + * + * @export + * @interface PendingapprovalV1 + */ +export interface PendingapprovalV1 { + /** + * The approval id. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'id'?: string; + /** + * This is the access request id. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'accessRequestId'?: string; + /** + * The name of the approval. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'name'?: string; + /** + * When the approval was created. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'created'?: string; + /** + * When the approval was modified last time. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'modified'?: string; + /** + * When the access-request was created. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'requestCreated'?: string; + /** + * + * @type {AccessrequesttypeV1} + * @memberof PendingapprovalV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * + * @type {AccessitemrequesterV1} + * @memberof PendingapprovalV1 + */ + 'requester'?: AccessitemrequesterV1; + /** + * + * @type {AccessitemrequestedforV1} + * @memberof PendingapprovalV1 + */ + 'requestedFor'?: AccessitemrequestedforV1; + /** + * + * @type {PendingapprovalOwnerV1} + * @memberof PendingapprovalV1 + */ + 'owner'?: PendingapprovalOwnerV1; + /** + * + * @type {RequestableobjectreferenceV1} + * @memberof PendingapprovalV1 + */ + 'requestedObject'?: RequestableobjectreferenceV1; + /** + * + * @type {CommentdtoV1} + * @memberof PendingapprovalV1 + */ + 'requesterComment'?: CommentdtoV1; + /** + * The history of the previous reviewers comments. + * @type {Array} + * @memberof PendingapprovalV1 + */ + 'previousReviewersComments'?: Array; + /** + * The history of approval forward action. + * @type {Array} + * @memberof PendingapprovalV1 + */ + 'forwardHistory'?: Array; + /** + * When true the rejector has to provide comments when rejecting + * @type {boolean} + * @memberof PendingapprovalV1 + */ + 'commentRequiredWhenRejected'?: boolean; + /** + * + * @type {PendingapprovalactionV1} + * @memberof PendingapprovalV1 + */ + 'actionInProcess'?: PendingapprovalactionV1; + /** + * The date the role or access profile or entitlement is no longer assigned to the specified identity. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'removeDate'?: string; + /** + * If true, then the request is to change the remove date or sunset date. + * @type {boolean} + * @memberof PendingapprovalV1 + */ + 'removeDateUpdateRequested'?: boolean; + /** + * The remove date or sunset date that was assigned at the time of the request. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'currentRemoveDate'?: string; + /** + * The date the role or access profile or entitlement is/will assigned to the specified identity. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'startDate'?: string; + /** + * If true, then the request is to change the start date or sunrise date. + * @type {boolean} + * @memberof PendingapprovalV1 + */ + 'startUpdateRequested'?: boolean; + /** + * The start date or sunrise date that was assigned at the time of the request. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'currentStartDate'?: string; + /** + * + * @type {SodviolationcontextcheckcompletedV1} + * @memberof PendingapprovalV1 + */ + 'sodViolationContext'?: SodviolationcontextcheckcompletedV1 | null; + /** + * Arbitrary key-value pairs, if any were included in the corresponding access request item + * @type {{ [key: string]: string; }} + * @memberof PendingapprovalV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; + /** + * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. + * @type {Array} + * @memberof PendingapprovalV1 + */ + 'requestedAccounts'?: Array | null; + /** + * The privilege level of the requested access item, if applicable. + * @type {string} + * @memberof PendingapprovalV1 + */ + 'privilegeLevel'?: string | null; + /** + * + * @type {PendingapprovalMaxPermittedAccessDurationV1} + * @memberof PendingapprovalV1 + */ + 'maxPermittedAccessDuration'?: PendingapprovalMaxPermittedAccessDurationV1 | null; +} + + +/** + * Enum represents action that is being processed on an approval. + * @export + * @enum {string} + */ + +export const PendingapprovalactionV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED', + Forwarded: 'FORWARDED' +} as const; + +export type PendingapprovalactionV1 = typeof PendingapprovalactionV1[keyof typeof PendingapprovalactionV1]; + + +/** + * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). + * @export + * @enum {string} + */ + +export const ReassignmenttypeV1 = { + ManualReassignment: 'MANUAL_REASSIGNMENT', + AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', + AutoEscalation: 'AUTO_ESCALATION', + SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' +} as const; + +export type ReassignmenttypeV1 = typeof ReassignmenttypeV1[keyof typeof ReassignmenttypeV1]; + + +/** + * + * @export + * @interface RequestableobjectreferenceV1 + */ +export interface RequestableobjectreferenceV1 { + /** + * Id of the object. + * @type {string} + * @memberof RequestableobjectreferenceV1 + */ + 'id'?: string; + /** + * Name of the object. + * @type {string} + * @memberof RequestableobjectreferenceV1 + */ + 'name'?: string; + /** + * Description of the object. + * @type {string} + * @memberof RequestableobjectreferenceV1 + */ + 'description'?: string; + /** + * Type of the object. + * @type {string} + * @memberof RequestableobjectreferenceV1 + */ + 'type'?: RequestableobjectreferenceV1TypeV1; +} + +export const RequestableobjectreferenceV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequestableobjectreferenceV1TypeV1 = typeof RequestableobjectreferenceV1TypeV1[keyof typeof RequestableobjectreferenceV1TypeV1]; + +/** + * + * @export + * @interface RequestedaccountrefV1 + */ +export interface RequestedaccountrefV1 { + /** + * Display name of the account for the user + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'name'?: string; + /** + * + * @type {DtotypeV1} + * @memberof RequestedaccountrefV1 + */ + 'type'?: DtotypeV1; + /** + * The uuid for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'accountUuid'?: string | null; + /** + * The native identity for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'accountId'?: string | null; + /** + * Display name of the source for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'sourceName'?: string; +} + + +/** + * Details of the Entitlement criteria + * @export + * @interface SodexemptcriteriaV1 + */ +export interface SodexemptcriteriaV1 { + /** + * If the entitlement already belonged to the user or not. + * @type {boolean} + * @memberof SodexemptcriteriaV1 + */ + 'existing'?: boolean; + /** + * + * @type {DtotypeV1} + * @memberof SodexemptcriteriaV1 + */ + 'type'?: DtotypeV1; + /** + * Entitlement ID + * @type {string} + * @memberof SodexemptcriteriaV1 + */ + 'id'?: string; + /** + * Entitlement name + * @type {string} + * @memberof SodexemptcriteriaV1 + */ + 'name'?: string; +} + + +/** + * SOD policy. + * @export + * @interface SodpolicydtoV1 + */ +export interface SodpolicydtoV1 { + /** + * SOD policy DTO type. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'type'?: SodpolicydtoV1TypeV1; + /** + * SOD policy ID. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'id'?: string; + /** + * SOD policy display name. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'name'?: string; +} + +export const SodpolicydtoV1TypeV1 = { + SodPolicy: 'SOD_POLICY' +} as const; + +export type SodpolicydtoV1TypeV1 = typeof SodpolicydtoV1TypeV1[keyof typeof SodpolicydtoV1TypeV1]; + +/** + * The inner object representing the completed SOD Violation check + * @export + * @interface SodviolationcheckresultV1 + */ +export interface SodviolationcheckresultV1 { + /** + * + * @type {ErrormessagedtoV1} + * @memberof SodviolationcheckresultV1 + */ + 'message'?: ErrormessagedtoV1; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + * @type {{ [key: string]: string; }} + * @memberof SodviolationcheckresultV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; + /** + * + * @type {Array} + * @memberof SodviolationcheckresultV1 + */ + 'violationContexts'?: Array | null; + /** + * A list of the SOD policies that were violated. + * @type {Array} + * @memberof SodviolationcheckresultV1 + */ + 'violatedPolicies'?: Array | null; +} +/** + * + * @export + * @interface SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + */ +export interface SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 { + /** + * + * @type {Array} + * @memberof SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + */ + 'criteriaList'?: Array; +} +/** + * The object which contains the left and right hand side of the entitlements that got violated according to the policy. + * @export + * @interface SodviolationcontextConflictingAccessCriteriaV1 + */ +export interface SodviolationcontextConflictingAccessCriteriaV1 { + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1} + * @memberof SodviolationcontextConflictingAccessCriteriaV1 + */ + 'leftCriteria'?: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1; + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1} + * @memberof SodviolationcontextConflictingAccessCriteriaV1 + */ + 'rightCriteria'?: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1; +} +/** + * The contextual information of the violated criteria + * @export + * @interface SodviolationcontextV1 + */ +export interface SodviolationcontextV1 { + /** + * + * @type {SodpolicydtoV1} + * @memberof SodviolationcontextV1 + */ + 'policy'?: SodpolicydtoV1; + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaV1} + * @memberof SodviolationcontextV1 + */ + 'conflictingAccessCriteria'?: SodviolationcontextConflictingAccessCriteriaV1; +} +/** + * An object referencing a completed SOD violation check + * @export + * @interface SodviolationcontextcheckcompletedV1 + */ +export interface SodviolationcontextcheckcompletedV1 { + /** + * The status of SOD violation check + * @type {string} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'state'?: SodviolationcontextcheckcompletedV1StateV1 | null; + /** + * The id of the Violation check event + * @type {string} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'uuid'?: string | null; + /** + * + * @type {SodviolationcheckresultV1} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'violationCheckResult'?: SodviolationcheckresultV1; +} + +export const SodviolationcontextcheckcompletedV1StateV1 = { + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type SodviolationcontextcheckcompletedV1StateV1 = typeof SodviolationcontextcheckcompletedV1StateV1[keyof typeof SodviolationcontextcheckcompletedV1StateV1]; + + +/** + * AccessRequestApprovalsV1Api - axios parameter creator + * @export + */ +export const AccessRequestApprovalsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Approve access request approval + * @param {string} approvalId Approval ID. + * @param {CommentdtoV1} [commentdtoV1] Reviewer\'s comment. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveAccessRequestV1: async (approvalId: string, commentdtoV1?: CommentdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'approvalId' is not null or undefined + assertParamExists('approveAccessRequestV1', 'approvalId', approvalId) + const localVarPath = `/access-request-approvals/v1/{approvalId}/approve` + .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); + // 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(commentdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Forward access request approval + * @param {string} approvalId Approval ID. + * @param {ForwardapprovaldtoV1} forwardapprovaldtoV1 Information about the forwarded approval. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + forwardAccessRequestV1: async (approvalId: string, forwardapprovaldtoV1: ForwardapprovaldtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'approvalId' is not null or undefined + assertParamExists('forwardAccessRequestV1', 'approvalId', approvalId) + // verify required parameter 'forwardapprovaldtoV1' is not null or undefined + assertParamExists('forwardAccessRequestV1', 'forwardapprovaldtoV1', forwardapprovaldtoV1) + const localVarPath = `/access-request-approvals/v1/{approvalId}/forward` + .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); + // 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(forwardapprovaldtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. + * @summary Get access requests approvals number + * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestApprovalSummaryV1: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-approvals/v1/approval-summary`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['owner-id'] = ownerId; + } + + if (fromDate !== undefined) { + localVarQueryParameter['from-date'] = fromDate; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint returns the list of approvers for the given access request id. + * @summary Access request approvers + * @param {string} accessRequestId Access Request ID. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessRequestApproversV1: async (accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessRequestId' is not null or undefined + assertParamExists('listAccessRequestApproversV1', 'accessRequestId', accessRequestId) + const localVarPath = `/access-request-approvals/v1/{accessRequestId}/approvers` + .replace(`{${"accessRequestId"}}`, encodeURIComponent(String(accessRequestId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + * @summary Completed access request approvals list + * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCompletedApprovalsV1: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-approvals/v1/completed`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['owner-id'] = ownerId; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. + * @summary Pending access request approvals list + * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPendingApprovalsV1: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-approvals/v1/pending`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['owner-id'] = ownerId; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + * @summary Reject access request approval + * @param {string} approvalId Approval ID. + * @param {CommentdtoV1} commentdtoV1 Reviewer\'s comment. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectAccessRequestV1: async (approvalId: string, commentdtoV1: CommentdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'approvalId' is not null or undefined + assertParamExists('rejectAccessRequestV1', 'approvalId', approvalId) + // verify required parameter 'commentdtoV1' is not null or undefined + assertParamExists('rejectAccessRequestV1', 'commentdtoV1', commentdtoV1) + const localVarPath = `/access-request-approvals/v1/{approvalId}/reject` + .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); + // 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(commentdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccessRequestApprovalsV1Api - functional programming interface + * @export + */ +export const AccessRequestApprovalsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccessRequestApprovalsV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Approve access request approval + * @param {string} approvalId Approval ID. + * @param {CommentdtoV1} [commentdtoV1] Reviewer\'s comment. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveAccessRequestV1(approvalId: string, commentdtoV1?: CommentdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequestV1(approvalId, commentdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.approveAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Forward access request approval + * @param {string} approvalId Approval ID. + * @param {ForwardapprovaldtoV1} forwardapprovaldtoV1 Information about the forwarded approval. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async forwardAccessRequestV1(approvalId: string, forwardapprovaldtoV1: ForwardapprovaldtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequestV1(approvalId, forwardapprovaldtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.forwardAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. + * @summary Get access requests approvals number + * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestApprovalSummaryV1(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummaryV1(ownerId, fromDate, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.getAccessRequestApprovalSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint returns the list of approvers for the given access request id. + * @summary Access request approvers + * @param {string} accessRequestId Access Request ID. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessRequestApproversV1(accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestApproversV1(accessRequestId, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.listAccessRequestApproversV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + * @summary Completed access request approvals list + * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listCompletedApprovalsV1(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovalsV1(ownerId, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.listCompletedApprovalsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. + * @summary Pending access request approvals list + * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPendingApprovalsV1(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovalsV1(ownerId, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.listPendingApprovalsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + * @summary Reject access request approval + * @param {string} approvalId Approval ID. + * @param {CommentdtoV1} commentdtoV1 Reviewer\'s comment. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectAccessRequestV1(approvalId: string, commentdtoV1: CommentdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequestV1(approvalId, commentdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV1Api.rejectAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccessRequestApprovalsV1Api - factory interface + * @export + */ +export const AccessRequestApprovalsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccessRequestApprovalsV1ApiFp(configuration) + return { + /** + * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Approve access request approval + * @param {AccessRequestApprovalsV1ApiApproveAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiApproveAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveAccessRequestV1(requestParameters.approvalId, requestParameters.commentdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Forward access request approval + * @param {AccessRequestApprovalsV1ApiForwardAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + forwardAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiForwardAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.forwardAccessRequestV1(requestParameters.approvalId, requestParameters.forwardapprovaldtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. + * @summary Get access requests approvals number + * @param {AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestApprovalSummaryV1(requestParameters: AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessRequestApprovalSummaryV1(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint returns the list of approvers for the given access request id. + * @summary Access request approvers + * @param {AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessRequestApproversV1(requestParameters: AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessRequestApproversV1(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + * @summary Completed access request approvals list + * @param {AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCompletedApprovalsV1(requestParameters: AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listCompletedApprovalsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. + * @summary Pending access request approvals list + * @param {AccessRequestApprovalsV1ApiListPendingApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPendingApprovalsV1(requestParameters: AccessRequestApprovalsV1ApiListPendingApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPendingApprovalsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + * @summary Reject access request approval + * @param {AccessRequestApprovalsV1ApiRejectAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiRejectAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectAccessRequestV1(requestParameters.approvalId, requestParameters.commentdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveAccessRequestV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiApproveAccessRequestV1Request + */ +export interface AccessRequestApprovalsV1ApiApproveAccessRequestV1Request { + /** + * Approval ID. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiApproveAccessRequestV1 + */ + readonly approvalId: string + + /** + * Reviewer\'s comment. + * @type {CommentdtoV1} + * @memberof AccessRequestApprovalsV1ApiApproveAccessRequestV1 + */ + readonly commentdtoV1?: CommentdtoV1 +} + +/** + * Request parameters for forwardAccessRequestV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiForwardAccessRequestV1Request + */ +export interface AccessRequestApprovalsV1ApiForwardAccessRequestV1Request { + /** + * Approval ID. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiForwardAccessRequestV1 + */ + readonly approvalId: string + + /** + * Information about the forwarded approval. + * @type {ForwardapprovaldtoV1} + * @memberof AccessRequestApprovalsV1ApiForwardAccessRequestV1 + */ + readonly forwardapprovaldtoV1: ForwardapprovaldtoV1 +} + +/** + * Request parameters for getAccessRequestApprovalSummaryV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request + */ +export interface AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request { + /** + * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1 + */ + readonly ownerId?: string + + /** + * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1 + */ + readonly fromDate?: string +} + +/** + * Request parameters for listAccessRequestApproversV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request + */ +export interface AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request { + /** + * Access Request ID. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListAccessRequestApproversV1 + */ + readonly accessRequestId: string + + /** + * Max number of results to return. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListAccessRequestApproversV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListAccessRequestApproversV1 + */ + readonly offset?: number + + /** + * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @type {boolean} + * @memberof AccessRequestApprovalsV1ApiListAccessRequestApproversV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for listCompletedApprovalsV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request + */ +export interface AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request { + /** + * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + readonly ownerId?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + 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: **created, modified** + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListCompletedApprovalsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listPendingApprovalsV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiListPendingApprovalsV1Request + */ +export interface AccessRequestApprovalsV1ApiListPendingApprovalsV1Request { + /** + * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + readonly ownerId?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + 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: **created, modified** + * @type {string} + * @memberof AccessRequestApprovalsV1ApiListPendingApprovalsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for rejectAccessRequestV1 operation in AccessRequestApprovalsV1Api. + * @export + * @interface AccessRequestApprovalsV1ApiRejectAccessRequestV1Request + */ +export interface AccessRequestApprovalsV1ApiRejectAccessRequestV1Request { + /** + * Approval ID. + * @type {string} + * @memberof AccessRequestApprovalsV1ApiRejectAccessRequestV1 + */ + readonly approvalId: string + + /** + * Reviewer\'s comment. + * @type {CommentdtoV1} + * @memberof AccessRequestApprovalsV1ApiRejectAccessRequestV1 + */ + readonly commentdtoV1: CommentdtoV1 +} + +/** + * AccessRequestApprovalsV1Api - object-oriented interface + * @export + * @class AccessRequestApprovalsV1Api + * @extends {BaseAPI} + */ +export class AccessRequestApprovalsV1Api extends BaseAPI { + /** + * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Approve access request approval + * @param {AccessRequestApprovalsV1ApiApproveAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public approveAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiApproveAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).approveAccessRequestV1(requestParameters.approvalId, requestParameters.commentdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + * @summary Forward access request approval + * @param {AccessRequestApprovalsV1ApiForwardAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public forwardAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiForwardAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).forwardAccessRequestV1(requestParameters.approvalId, requestParameters.forwardapprovaldtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. + * @summary Get access requests approvals number + * @param {AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public getAccessRequestApprovalSummaryV1(requestParameters: AccessRequestApprovalsV1ApiGetAccessRequestApprovalSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).getAccessRequestApprovalSummaryV1(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint returns the list of approvers for the given access request id. + * @summary Access request approvers + * @param {AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public listAccessRequestApproversV1(requestParameters: AccessRequestApprovalsV1ApiListAccessRequestApproversV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).listAccessRequestApproversV1(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + * @summary Completed access request approvals list + * @param {AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public listCompletedApprovalsV1(requestParameters: AccessRequestApprovalsV1ApiListCompletedApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).listCompletedApprovalsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. + * @summary Pending access request approvals list + * @param {AccessRequestApprovalsV1ApiListPendingApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public listPendingApprovalsV1(requestParameters: AccessRequestApprovalsV1ApiListPendingApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).listPendingApprovalsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + * @summary Reject access request approval + * @param {AccessRequestApprovalsV1ApiRejectAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestApprovalsV1Api + */ + public rejectAccessRequestV1(requestParameters: AccessRequestApprovalsV1ApiRejectAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestApprovalsV1ApiFp(this.configuration).rejectAccessRequestV1(requestParameters.approvalId, requestParameters.commentdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/access_request_approvals/base.ts b/sdk-output/access_request_approvals/base.ts new file mode 100644 index 00000000..653649ef --- /dev/null +++ b/sdk-output/access_request_approvals/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Approvals + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/access_request_approvals/common.ts b/sdk-output/access_request_approvals/common.ts new file mode 100644 index 00000000..ff9e59e2 --- /dev/null +++ b/sdk-output/access_request_approvals/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Approvals + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/access_request_approvals/configuration.ts b/sdk-output/access_request_approvals/configuration.ts new file mode 100644 index 00000000..3d250a24 --- /dev/null +++ b/sdk-output/access_request_approvals/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Approvals + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/v2025/git_push.sh b/sdk-output/access_request_approvals/git_push.sh similarity index 100% rename from sdk-output/v2025/git_push.sh rename to sdk-output/access_request_approvals/git_push.sh diff --git a/sdk-output/access_request_approvals/index.ts b/sdk-output/access_request_approvals/index.ts new file mode 100644 index 00000000..509cec9a --- /dev/null +++ b/sdk-output/access_request_approvals/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Approvals + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/v2025/package.json b/sdk-output/access_request_approvals/package.json similarity index 81% rename from sdk-output/v2025/package.json rename to sdk-output/access_request_approvals/package.json index 4332abe8..65897fe3 100644 --- a/sdk-output/v2025/package.json +++ b/sdk-output/access_request_approvals/package.json @@ -1,7 +1,7 @@ { - "name": "sailpoint-sdk", - "version": "1.8.69", - "description": "OpenAPI client for sailpoint-sdk", + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", "author": "OpenAPI-Generator Contributors", "repository": { "type": "git", @@ -12,7 +12,7 @@ "typescript", "openapi-client", "openapi-generator", - "sailpoint-sdk" + "sailpoint-api-client" ], "license": "Unlicense", "main": "./dist/index.js", diff --git a/sdk-output/v2025/tsconfig.json b/sdk-output/access_request_approvals/tsconfig.json similarity index 100% rename from sdk-output/v2025/tsconfig.json rename to sdk-output/access_request_approvals/tsconfig.json diff --git a/sdk-output/v2026/.gitignore b/sdk-output/access_request_identity_metrics/.gitignore similarity index 100% rename from sdk-output/v2026/.gitignore rename to sdk-output/access_request_identity_metrics/.gitignore diff --git a/sdk-output/v2026/.npmignore b/sdk-output/access_request_identity_metrics/.npmignore similarity index 100% rename from sdk-output/v2026/.npmignore rename to sdk-output/access_request_identity_metrics/.npmignore diff --git a/sdk-output/v2026/.openapi-generator-ignore b/sdk-output/access_request_identity_metrics/.openapi-generator-ignore similarity index 100% rename from sdk-output/v2026/.openapi-generator-ignore rename to sdk-output/access_request_identity_metrics/.openapi-generator-ignore diff --git a/sdk-output/v2026/.openapi-generator/FILES b/sdk-output/access_request_identity_metrics/.openapi-generator/FILES similarity index 100% rename from sdk-output/v2026/.openapi-generator/FILES rename to sdk-output/access_request_identity_metrics/.openapi-generator/FILES diff --git a/sdk-output/v2026/.openapi-generator/VERSION b/sdk-output/access_request_identity_metrics/.openapi-generator/VERSION similarity index 100% rename from sdk-output/v2026/.openapi-generator/VERSION rename to sdk-output/access_request_identity_metrics/.openapi-generator/VERSION diff --git a/sdk-output/access_request_identity_metrics/.sdk-partition b/sdk-output/access_request_identity_metrics/.sdk-partition new file mode 100644 index 00000000..73f9f663 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/.sdk-partition @@ -0,0 +1 @@ +access-request-identity-metrics \ No newline at end of file diff --git a/sdk-output/v2026/README.md b/sdk-output/access_request_identity_metrics/README.md similarity index 92% rename from sdk-output/v2026/README.md rename to sdk-output/access_request_identity_metrics/README.md index 51f7499b..e26f6a53 100644 --- a/sdk-output/v2026/README.md +++ b/sdk-output/access_request_identity_metrics/README.md @@ -1,4 +1,4 @@ -## sailpoint-sdk@1.8.69 +## sailpoint-api-client@1.0.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: @@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co _published:_ ``` -npm install sailpoint-sdk@1.8.69 --save +npm install sailpoint-api-client@1.0.0 --save ``` _unPublished (not recommended):_ diff --git a/sdk-output/access_request_identity_metrics/api.ts b/sdk-output/access_request_identity_metrics/api.ts new file mode 100644 index 00000000..c88960d2 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/api.ts @@ -0,0 +1,279 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Identity Metrics + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAccessRequestIdentityMetricsV1401ResponseV1 + */ +export interface GetAccessRequestIdentityMetricsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestIdentityMetricsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAccessRequestIdentityMetricsV1429ResponseV1 + */ +export interface GetAccessRequestIdentityMetricsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestIdentityMetricsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AccessRequestIdentityMetricsV1Api - axios parameter creator + * @export + */ +export const AccessRequestIdentityMetricsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to return information access metrics. + * @summary Return access request identity metrics + * @param {string} identityId Manager\'s identity ID. + * @param {string} requestedObjectId Requested access item\'s ID. + * @param {GetAccessRequestIdentityMetricsV1TypeV1} type Requested access item\'s type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestIdentityMetricsV1: async (identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsV1TypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getAccessRequestIdentityMetricsV1', 'identityId', identityId) + // verify required parameter 'requestedObjectId' is not null or undefined + assertParamExists('getAccessRequestIdentityMetricsV1', 'requestedObjectId', requestedObjectId) + // verify required parameter 'type' is not null or undefined + assertParamExists('getAccessRequestIdentityMetricsV1', 'type', type) + const localVarPath = `/access-request-identity-metrics/v1/{identityId}/requested-objects/{requestedObjectId}/type/{type}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) + .replace(`{${"requestedObjectId"}}`, encodeURIComponent(String(requestedObjectId))) + .replace(`{${"type"}}`, encodeURIComponent(String(type))); + // 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, + }; + }, + } +}; + +/** + * AccessRequestIdentityMetricsV1Api - functional programming interface + * @export + */ +export const AccessRequestIdentityMetricsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccessRequestIdentityMetricsV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to return information access metrics. + * @summary Return access request identity metrics + * @param {string} identityId Manager\'s identity ID. + * @param {string} requestedObjectId Requested access item\'s ID. + * @param {GetAccessRequestIdentityMetricsV1TypeV1} type Requested access item\'s type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestIdentityMetricsV1(identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsV1TypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestIdentityMetricsV1(identityId, requestedObjectId, type, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestIdentityMetricsV1Api.getAccessRequestIdentityMetricsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccessRequestIdentityMetricsV1Api - factory interface + * @export + */ +export const AccessRequestIdentityMetricsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccessRequestIdentityMetricsV1ApiFp(configuration) + return { + /** + * Use this API to return information access metrics. + * @summary Return access request identity metrics + * @param {AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestIdentityMetricsV1(requestParameters: AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessRequestIdentityMetricsV1(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getAccessRequestIdentityMetricsV1 operation in AccessRequestIdentityMetricsV1Api. + * @export + * @interface AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request + */ +export interface AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request { + /** + * Manager\'s identity ID. + * @type {string} + * @memberof AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1 + */ + readonly identityId: string + + /** + * Requested access item\'s ID. + * @type {string} + * @memberof AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1 + */ + readonly requestedObjectId: string + + /** + * Requested access item\'s type. + * @type {'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE'} + * @memberof AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1 + */ + readonly type: GetAccessRequestIdentityMetricsV1TypeV1 +} + +/** + * AccessRequestIdentityMetricsV1Api - object-oriented interface + * @export + * @class AccessRequestIdentityMetricsV1Api + * @extends {BaseAPI} + */ +export class AccessRequestIdentityMetricsV1Api extends BaseAPI { + /** + * Use this API to return information access metrics. + * @summary Return access request identity metrics + * @param {AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestIdentityMetricsV1Api + */ + public getAccessRequestIdentityMetricsV1(requestParameters: AccessRequestIdentityMetricsV1ApiGetAccessRequestIdentityMetricsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestIdentityMetricsV1ApiFp(this.configuration).getAccessRequestIdentityMetricsV1(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetAccessRequestIdentityMetricsV1TypeV1 = { + Entitlement: 'ENTITLEMENT', + Role: 'ROLE', + AccessProfile: 'ACCESS_PROFILE' +} as const; +export type GetAccessRequestIdentityMetricsV1TypeV1 = typeof GetAccessRequestIdentityMetricsV1TypeV1[keyof typeof GetAccessRequestIdentityMetricsV1TypeV1]; + + diff --git a/sdk-output/access_request_identity_metrics/base.ts b/sdk-output/access_request_identity_metrics/base.ts new file mode 100644 index 00000000..3c0b9f35 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Identity Metrics + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/access_request_identity_metrics/common.ts b/sdk-output/access_request_identity_metrics/common.ts new file mode 100644 index 00000000..6d31ac49 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Identity Metrics + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/access_request_identity_metrics/configuration.ts b/sdk-output/access_request_identity_metrics/configuration.ts new file mode 100644 index 00000000..d81d53fb --- /dev/null +++ b/sdk-output/access_request_identity_metrics/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Identity Metrics + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/v2026/git_push.sh b/sdk-output/access_request_identity_metrics/git_push.sh similarity index 100% rename from sdk-output/v2026/git_push.sh rename to sdk-output/access_request_identity_metrics/git_push.sh diff --git a/sdk-output/access_request_identity_metrics/index.ts b/sdk-output/access_request_identity_metrics/index.ts new file mode 100644 index 00000000..c28f0b07 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Request Identity Metrics + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/v2026/package.json b/sdk-output/access_request_identity_metrics/package.json similarity index 81% rename from sdk-output/v2026/package.json rename to sdk-output/access_request_identity_metrics/package.json index 4332abe8..65897fe3 100644 --- a/sdk-output/v2026/package.json +++ b/sdk-output/access_request_identity_metrics/package.json @@ -1,7 +1,7 @@ { - "name": "sailpoint-sdk", - "version": "1.8.69", - "description": "OpenAPI client for sailpoint-sdk", + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", "author": "OpenAPI-Generator Contributors", "repository": { "type": "git", @@ -12,7 +12,7 @@ "typescript", "openapi-client", "openapi-generator", - "sailpoint-sdk" + "sailpoint-api-client" ], "license": "Unlicense", "main": "./dist/index.js", diff --git a/sdk-output/v2026/tsconfig.json b/sdk-output/access_request_identity_metrics/tsconfig.json similarity index 100% rename from sdk-output/v2026/tsconfig.json rename to sdk-output/access_request_identity_metrics/tsconfig.json diff --git a/sdk-output/v3/.gitignore b/sdk-output/access_requests/.gitignore similarity index 100% rename from sdk-output/v3/.gitignore rename to sdk-output/access_requests/.gitignore diff --git a/sdk-output/v3/.npmignore b/sdk-output/access_requests/.npmignore similarity index 100% rename from sdk-output/v3/.npmignore rename to sdk-output/access_requests/.npmignore diff --git a/sdk-output/v3/.openapi-generator-ignore b/sdk-output/access_requests/.openapi-generator-ignore similarity index 100% rename from sdk-output/v3/.openapi-generator-ignore rename to sdk-output/access_requests/.openapi-generator-ignore diff --git a/sdk-output/v3/.openapi-generator/FILES b/sdk-output/access_requests/.openapi-generator/FILES similarity index 100% rename from sdk-output/v3/.openapi-generator/FILES rename to sdk-output/access_requests/.openapi-generator/FILES diff --git a/sdk-output/v3/.openapi-generator/VERSION b/sdk-output/access_requests/.openapi-generator/VERSION similarity index 100% rename from sdk-output/v3/.openapi-generator/VERSION rename to sdk-output/access_requests/.openapi-generator/VERSION diff --git a/sdk-output/access_requests/.sdk-partition b/sdk-output/access_requests/.sdk-partition new file mode 100644 index 00000000..1c75782d --- /dev/null +++ b/sdk-output/access_requests/.sdk-partition @@ -0,0 +1 @@ +access-requests \ No newline at end of file diff --git a/sdk-output/access_requests/README.md b/sdk-output/access_requests/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_requests/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_requests/api.ts b/sdk-output/access_requests/api.ts new file mode 100644 index 00000000..51d6a057 --- /dev/null +++ b/sdk-output/access_requests/api.ts @@ -0,0 +1,4046 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Requests + * 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'; + +/** + * Access item requester\'s identity. + * @export + * @interface AccessitemrequesterV1 + */ +export interface AccessitemrequesterV1 { + /** + * Access item requester\'s DTO type. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'type'?: AccessitemrequesterV1TypeV1; + /** + * Access item requester\'s identity ID. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'id'?: string; + /** + * Access item owner\'s human-readable display name. + * @type {string} + * @memberof AccessitemrequesterV1 + */ + 'name'?: string; +} + +export const AccessitemrequesterV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemrequesterV1TypeV1 = typeof AccessitemrequesterV1TypeV1[keyof typeof AccessitemrequesterV1TypeV1]; + +/** + * Identity who reviewed the access item request. + * @export + * @interface AccessitemreviewedbyV1 + */ +export interface AccessitemreviewedbyV1 { + /** + * DTO type of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'type'?: AccessitemreviewedbyV1TypeV1; + /** + * ID of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity who reviewed the access item request. + * @type {string} + * @memberof AccessitemreviewedbyV1 + */ + 'name'?: string; +} + +export const AccessitemreviewedbyV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemreviewedbyV1TypeV1 = typeof AccessitemreviewedbyV1TypeV1[keyof typeof AccessitemreviewedbyV1TypeV1]; + +/** + * + * @export + * @interface AccessrequestV1 + */ +export interface AccessrequestV1 { + /** + * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. + * @type {Array} + * @memberof AccessrequestV1 + */ + 'requestedFor': Array; + /** + * + * @type {AccessrequesttypeV1} + * @memberof AccessrequestV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * + * @type {Array} + * @memberof AccessrequestV1 + */ + 'requestedItems': Array; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + * @type {{ [key: string]: string; }} + * @memberof AccessrequestV1 + */ + 'clientMetadata'?: { [key: string]: string; }; + /** + * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests + * @type {Array} + * @memberof AccessrequestV1 + */ + 'requestedForWithRequestedItems'?: Array | null; +} + + +/** + * + * @export + * @interface AccessrequestadminitemstatusV1 + */ +export interface AccessrequestadminitemstatusV1 { + /** + * ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'id'?: string | null; + /** + * Human-readable display name of the item being requested. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'name'?: string | null; + /** + * Type of requested object. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'type'?: AccessrequestadminitemstatusV1TypeV1 | null; + /** + * + * @type {RequesteditemstatusCancelledRequestDetailsV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'cancelledRequestDetails'?: RequesteditemstatusCancelledRequestDetailsV1; + /** + * List of localized error messages, if any, encountered during the approval/provisioning process. + * @type {Array>} + * @memberof AccessrequestadminitemstatusV1 + */ + 'errorMessages'?: Array> | null; + /** + * + * @type {RequesteditemstatusrequeststateV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'state'?: RequesteditemstatusrequeststateV1; + /** + * Approval details for each item. + * @type {Array} + * @memberof AccessrequestadminitemstatusV1 + */ + 'approvalDetails'?: Array; + /** + * Manual work items created for provisioning the item. + * @type {Array} + * @memberof AccessrequestadminitemstatusV1 + */ + 'manualWorkItemDetails'?: Array | null; + /** + * Id of associated account activity item. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'accountActivityItemId'?: string; + /** + * + * @type {AccessrequesttypeV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * When the request was last modified. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'modified'?: string | null; + /** + * When the request was created. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'created'?: string; + /** + * + * @type {AccessitemrequesterV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'requester'?: AccessitemrequesterV1; + /** + * + * @type {RequesteditemstatusRequestedForV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'requestedFor'?: RequesteditemstatusRequestedForV1; + /** + * + * @type {RequesteditemstatusRequesterCommentV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'requesterComment'?: RequesteditemstatusRequesterCommentV1; + /** + * + * @type {RequesteditemstatusSodViolationContextV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'sodViolationContext'?: RequesteditemstatusSodViolationContextV1; + /** + * + * @type {RequesteditemstatusProvisioningDetailsV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'provisioningDetails'?: RequesteditemstatusProvisioningDetailsV1; + /** + * + * @type {RequesteditemstatusPreApprovalTriggerDetailsV1} + * @memberof AccessrequestadminitemstatusV1 + */ + 'preApprovalTriggerDetails'?: RequesteditemstatusPreApprovalTriggerDetailsV1; + /** + * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + * @type {Array} + * @memberof AccessrequestadminitemstatusV1 + */ + 'accessRequestPhases'?: Array | null; + /** + * Description associated to the requested object. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'description'?: string | null; + /** + * When the role access is scheduled for provisioning. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'startDate'?: string | null; + /** + * When the role access is scheduled for removal. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'removeDate'?: string | null; + /** + * True if the request can be canceled. + * @type {boolean} + * @memberof AccessrequestadminitemstatusV1 + */ + 'cancelable'?: boolean; + /** + * True if re-auth is required. + * @type {boolean} + * @memberof AccessrequestadminitemstatusV1 + */ + 'reauthorizationRequired'?: boolean; + /** + * This is the account activity id. + * @type {string} + * @memberof AccessrequestadminitemstatusV1 + */ + 'accessRequestId'?: string; + /** + * Arbitrary key-value pairs, if any were included in the corresponding access request + * @type {{ [key: string]: string; }} + * @memberof AccessrequestadminitemstatusV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; +} + +export const AccessrequestadminitemstatusV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccessrequestadminitemstatusV1TypeV1 = typeof AccessrequestadminitemstatusV1TypeV1[keyof typeof AccessrequestadminitemstatusV1TypeV1]; + +/** + * + * @export + * @interface AccessrequestconfigV1 + */ +export interface AccessrequestconfigV1 { + /** + * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. + * @type {boolean} + * @memberof AccessrequestconfigV1 + */ + 'approvalsMustBeExternal'?: boolean; + /** + * If this is true and the requester and reviewer are the same, the request is automatically approved. + * @type {boolean} + * @memberof AccessrequestconfigV1 + */ + 'autoApprovalEnabled'?: boolean; + /** + * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. + * @type {boolean} + * @memberof AccessrequestconfigV1 + */ + 'reauthorizationEnabled'?: boolean; + /** + * + * @type {RequestonbehalfofconfigV1} + * @memberof AccessrequestconfigV1 + */ + 'requestOnBehalfOfConfig'?: RequestonbehalfofconfigV1; + /** + * + * @type {ApprovalreminderandescalationconfigV1} + * @memberof AccessrequestconfigV1 + */ + 'approvalReminderAndEscalationConfig'?: ApprovalreminderandescalationconfigV1; + /** + * + * @type {EntitlementrequestconfigV1} + * @memberof AccessrequestconfigV1 + */ + 'entitlementRequestConfig'?: EntitlementrequestconfigV1; +} +/** + * + * @export + * @interface AccessrequestconfigV2 + */ +export interface AccessrequestconfigV2 { + /** + * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. + * @type {boolean} + * @memberof AccessrequestconfigV2 + */ + 'approvalsMustBeExternal'?: boolean; + /** + * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. + * @type {boolean} + * @memberof AccessrequestconfigV2 + */ + 'reauthorizationEnabled'?: boolean; + /** + * + * @type {RequestonbehalfofconfigV2} + * @memberof AccessrequestconfigV2 + */ + 'requestOnBehalfOfConfig'?: RequestonbehalfofconfigV2; + /** + * + * @type {EntitlementrequestconfigV2} + * @memberof AccessrequestconfigV2 + */ + 'entitlementRequestConfig'?: EntitlementrequestconfigV2; + /** + * If this is true, requesters and requested-for users will be able to see the names of governance group members when a request is awaiting the group\'s approval. Up to the first 10 members of the group will be listed. + * @type {boolean} + * @memberof AccessrequestconfigV2 + */ + 'govGroupVisibilityEnabled'?: boolean; +} +/** + * + * @export + * @interface AccessrequestitemV1 + */ +export interface AccessrequestitemV1 { + /** + * The type of the item being requested. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'type': AccessrequestitemV1TypeV1; + /** + * ID of Role, Access Profile or Entitlement being requested. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'id': string; + /** + * Comment provided by requester. * Comment is required when the request is of type Revoke Access. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'comment'?: string; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. + * @type {{ [key: string]: string; }} + * @memberof AccessrequestitemV1 + */ + 'clientMetadata'?: { [key: string]: string; }; + /** + * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'startDate'?: string; + /** + * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'removeDate'?: string; + /** + * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'assignmentId'?: string | null; + /** + * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + * @type {string} + * @memberof AccessrequestitemV1 + */ + 'nativeIdentity'?: string | null; +} + +export const AccessrequestitemV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccessrequestitemV1TypeV1 = typeof AccessrequestitemV1TypeV1[keyof typeof AccessrequestitemV1TypeV1]; + +/** + * Provides additional details about this access request phase. + * @export + * @interface AccessrequestphasesV1 + */ +export interface AccessrequestphasesV1 { + /** + * The time that this phase started. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'started'?: string; + /** + * The time that this phase finished. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'finished'?: string | null; + /** + * The name of this phase. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'name'?: string; + /** + * The state of this phase. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'state'?: AccessrequestphasesV1StateV1; + /** + * The state of this phase. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'result'?: AccessrequestphasesV1ResultV1 | null; + /** + * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. + * @type {string} + * @memberof AccessrequestphasesV1 + */ + 'phaseReference'?: string | null; +} + +export const AccessrequestphasesV1StateV1 = { + Pending: 'PENDING', + Executing: 'EXECUTING', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED', + NotExecuted: 'NOT_EXECUTED' +} as const; + +export type AccessrequestphasesV1StateV1 = typeof AccessrequestphasesV1StateV1[keyof typeof AccessrequestphasesV1StateV1]; +export const AccessrequestphasesV1ResultV1 = { + Successful: 'SUCCESSFUL', + Failed: 'FAILED' +} as const; + +export type AccessrequestphasesV1ResultV1 = typeof AccessrequestphasesV1ResultV1[keyof typeof AccessrequestphasesV1ResultV1]; + +/** + * + * @export + * @interface AccessrequestresponseV1 + */ +export interface AccessrequestresponseV1 { + /** + * A list of new access request tracking data mapped to the values requested. + * @type {Array} + * @memberof AccessrequestresponseV1 + */ + 'newRequests'?: Array; + /** + * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. + * @type {Array} + * @memberof AccessrequestresponseV1 + */ + 'existingRequests'?: Array; +} +/** + * + * @export + * @interface AccessrequesttrackingV1 + */ +export interface AccessrequesttrackingV1 { + /** + * The identity id in which the access request is for. + * @type {string} + * @memberof AccessrequesttrackingV1 + */ + 'requestedFor'?: string; + /** + * The details of the item requested. + * @type {Array} + * @memberof AccessrequesttrackingV1 + */ + 'requestedItemsDetails'?: Array; + /** + * a hash representation of the access requested, useful for longer term tracking client side. + * @type {number} + * @memberof AccessrequesttrackingV1 + */ + 'attributesHash'?: number; + /** + * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. + * @type {Array} + * @memberof AccessrequesttrackingV1 + */ + 'accessRequestIds'?: Array; +} +/** + * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. + * @export + * @enum {string} + */ + +export const AccessrequesttypeV1 = { + GrantAccess: 'GRANT_ACCESS', + RevokeAccess: 'REVOKE_ACCESS', + ModifyAccess: 'MODIFY_ACCESS' +} as const; + +export type AccessrequesttypeV1 = typeof AccessrequesttypeV1[keyof typeof AccessrequesttypeV1]; + + +/** + * + * @export + * @interface AccountinforefV1 + */ +export interface AccountinforefV1 { + /** + * The uuid for the account, available under the \'objectguid\' attribute + * @type {string} + * @memberof AccountinforefV1 + */ + 'uuid'?: string; + /** + * The \'distinguishedName\' attribute for the account + * @type {string} + * @memberof AccountinforefV1 + */ + 'nativeIdentity'?: string; + /** + * + * @type {DtotypeV1} + * @memberof AccountinforefV1 + */ + 'type'?: DtotypeV1; + /** + * The account id + * @type {string} + * @memberof AccountinforefV1 + */ + 'id'?: string; + /** + * The account display name + * @type {string} + * @memberof AccountinforefV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface AccountitemrefV1 + */ +export interface AccountitemrefV1 { + /** + * The uuid for the account, available under the \'objectguid\' attribute + * @type {string} + * @memberof AccountitemrefV1 + */ + 'accountUuid'?: string | null; + /** + * The \'distinguishedName\' attribute for the account + * @type {string} + * @memberof AccountitemrefV1 + */ + 'nativeIdentity'?: string; +} +/** + * + * @export + * @interface AccountsselectionrequestV1 + */ +export interface AccountsselectionrequestV1 { + /** + * A list of Identity IDs for whom the Access is requested. + * @type {Array} + * @memberof AccountsselectionrequestV1 + */ + 'requestedFor': Array; + /** + * + * @type {AccessrequesttypeV1} + * @memberof AccountsselectionrequestV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * + * @type {Array} + * @memberof AccountsselectionrequestV1 + */ + 'requestedItems': Array; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + * @type {{ [key: string]: string; }} + * @memberof AccountsselectionrequestV1 + */ + 'clientMetadata'?: { [key: string]: string; }; +} + + +/** + * + * @export + * @interface AccountsselectionresponseV1 + */ +export interface AccountsselectionresponseV1 { + /** + * A list of available account selections per identity in the request, for all the requested items + * @type {Array} + * @memberof AccountsselectionresponseV1 + */ + 'identities'?: Array; +} +/** + * + * @export + * @interface ApprovalforwardhistoryV1 + */ +export interface ApprovalforwardhistoryV1 { + /** + * Display name of approver from whom the approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'oldApproverName'?: string; + /** + * Display name of approver to whom the approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'newApproverName'?: string; + /** + * Comment made while forwarding. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'comment'?: string | null; + /** + * Time at which approval was forwarded. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'modified'?: string; + /** + * Display name of forwarder who forwarded the approval. + * @type {string} + * @memberof ApprovalforwardhistoryV1 + */ + 'forwarderName'?: string | null; + /** + * + * @type {ReassignmenttypeV1} + * @memberof ApprovalforwardhistoryV1 + */ + 'reassignmentType'?: ReassignmenttypeV1; +} + + +/** + * Configuration for approval reminder and escalation behavior. Important: Modifying this object will override the sp-approval service\'s reminderConfig and escalationConfig settings. Changes made here take precedence over any configuration set directly in the sp-approval service. + * @export + * @interface ApprovalreminderandescalationconfigV1 + */ +export interface ApprovalreminderandescalationconfigV1 { + /** + * Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. + * @type {number} + * @memberof ApprovalreminderandescalationconfigV1 + */ + 'daysUntilEscalation'?: number | null; + /** + * Number of days to wait between reminder notifications. + * @type {number} + * @memberof ApprovalreminderandescalationconfigV1 + */ + 'daysBetweenReminders'?: number | null; + /** + * Maximum number of reminder notifications to send to the reviewer before approval escalation. The maximum allowed value is 20. + * @type {number} + * @memberof ApprovalreminderandescalationconfigV1 + */ + 'maxReminders'?: number | null; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ApprovalreminderandescalationconfigV1 + */ + 'fallbackApproverRef'?: IdentityreferencewithnameandemailV1 | null; +} +/** + * Describes the individual or group that is responsible for an approval step. + * @export + * @enum {string} + */ + +export const ApprovalschemeV1 = { + AppOwner: 'APP_OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + RoleOwner: 'ROLE_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type ApprovalschemeV1 = typeof ApprovalschemeV1[keyof typeof ApprovalschemeV1]; + + +/** + * + * @export + * @interface ApprovalstatusdtoCurrentOwnerV1 + */ +export interface ApprovalstatusdtoCurrentOwnerV1 { + /** + * DTO type of identity who reviewed the access item request. + * @type {string} + * @memberof ApprovalstatusdtoCurrentOwnerV1 + */ + 'type'?: ApprovalstatusdtoCurrentOwnerV1TypeV1; + /** + * ID of identity who reviewed the access item request. + * @type {string} + * @memberof ApprovalstatusdtoCurrentOwnerV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity who reviewed the access item request. + * @type {string} + * @memberof ApprovalstatusdtoCurrentOwnerV1 + */ + 'name'?: string; +} + +export const ApprovalstatusdtoCurrentOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ApprovalstatusdtoCurrentOwnerV1TypeV1 = typeof ApprovalstatusdtoCurrentOwnerV1TypeV1[keyof typeof ApprovalstatusdtoCurrentOwnerV1TypeV1]; + +/** + * Identity of orginal approval owner. + * @export + * @interface ApprovalstatusdtoOriginalOwnerV1 + */ +export interface ApprovalstatusdtoOriginalOwnerV1 { + /** + * DTO type of original approval owner\'s identity. + * @type {string} + * @memberof ApprovalstatusdtoOriginalOwnerV1 + */ + 'type'?: ApprovalstatusdtoOriginalOwnerV1TypeV1; + /** + * ID of original approval owner\'s identity. + * @type {string} + * @memberof ApprovalstatusdtoOriginalOwnerV1 + */ + 'id'?: string; + /** + * Display name of original approval owner. + * @type {string} + * @memberof ApprovalstatusdtoOriginalOwnerV1 + */ + 'name'?: string; +} + +export const ApprovalstatusdtoOriginalOwnerV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type ApprovalstatusdtoOriginalOwnerV1TypeV1 = typeof ApprovalstatusdtoOriginalOwnerV1TypeV1[keyof typeof ApprovalstatusdtoOriginalOwnerV1TypeV1]; + +/** + * + * @export + * @interface ApprovalstatusdtoV1 + */ +export interface ApprovalstatusdtoV1 { + /** + * True if the request for this item was forwarded from one owner to another. + * @type {boolean} + * @memberof ApprovalstatusdtoV1 + */ + 'forwarded'?: boolean; + /** + * + * @type {ApprovalstatusdtoOriginalOwnerV1} + * @memberof ApprovalstatusdtoV1 + */ + 'originalOwner'?: ApprovalstatusdtoOriginalOwnerV1; + /** + * + * @type {ApprovalstatusdtoCurrentOwnerV1} + * @memberof ApprovalstatusdtoV1 + */ + 'currentOwner'?: ApprovalstatusdtoCurrentOwnerV1; + /** + * Time at which item was modified. + * @type {string} + * @memberof ApprovalstatusdtoV1 + */ + 'modified'?: string | null; + /** + * + * @type {ManualworkitemstateV1} + * @memberof ApprovalstatusdtoV1 + */ + 'status'?: ManualworkitemstateV1; + /** + * + * @type {ApprovalschemeV1} + * @memberof ApprovalstatusdtoV1 + */ + 'scheme'?: ApprovalschemeV1; + /** + * If the request failed, includes any error messages that were generated. + * @type {Array} + * @memberof ApprovalstatusdtoV1 + */ + 'errorMessages'?: Array | null; + /** + * Comment, if any, provided by the approver. + * @type {string} + * @memberof ApprovalstatusdtoV1 + */ + 'comment'?: string | null; + /** + * The date the role or access profile or entitlement is no longer assigned to the specified identity. + * @type {string} + * @memberof ApprovalstatusdtoV1 + */ + 'removeDate'?: string | null; +} + + +/** + * Request body payload for bulk approve access request endpoint. + * @export + * @interface BulkapproveaccessrequestV1 + */ +export interface BulkapproveaccessrequestV1 { + /** + * List of approval ids to approve the pending requests + * @type {Array} + * @memberof BulkapproveaccessrequestV1 + */ + 'approvalIds': Array; + /** + * Reason for approving the pending access request. + * @type {string} + * @memberof BulkapproveaccessrequestV1 + */ + 'comment': string; +} +/** + * Request body payload for bulk cancel access request endpoint. + * @export + * @interface BulkcancelaccessrequestV1 + */ +export interface BulkcancelaccessrequestV1 { + /** + * List of access requests ids to cancel the pending requests + * @type {Array} + * @memberof BulkcancelaccessrequestV1 + */ + 'accessRequestIds': Array; + /** + * Reason for cancelling the pending access request. + * @type {string} + * @memberof BulkcancelaccessrequestV1 + */ + 'comment': string; +} +/** + * Request body payload for cancel access request endpoint. + * @export + * @interface CancelaccessrequestV1 + */ +export interface CancelaccessrequestV1 { + /** + * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. + * @type {string} + * @memberof CancelaccessrequestV1 + */ + 'accountActivityId': string; + /** + * Reason for cancelling the pending access request. + * @type {string} + * @memberof CancelaccessrequestV1 + */ + 'comment': string; +} +/** + * Provides additional details for a request that has been cancelled. + * @export + * @interface CancelledrequestdetailsV1 + */ +export interface CancelledrequestdetailsV1 { + /** + * Comment made by the owner when cancelling the associated request. + * @type {string} + * @memberof CancelledrequestdetailsV1 + */ + 'comment'?: string; + /** + * + * @type {OwnerdtoV1} + * @memberof CancelledrequestdetailsV1 + */ + 'owner'?: OwnerdtoV1; + /** + * Date comment was added by the owner when cancelling the associated request. + * @type {string} + * @memberof CancelledrequestdetailsV1 + */ + 'modified'?: string; +} +/** + * Request body payload for close access requests endpoint. + * @export + * @interface CloseaccessrequestV1 + */ +export interface CloseaccessrequestV1 { + /** + * Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. + * @type {Array} + * @memberof CloseaccessrequestV1 + */ + 'accessRequestIds': Array; + /** + * Reason for closing the access request. Displayed under Warnings in IdentityNow. + * @type {string} + * @memberof CloseaccessrequestV1 + */ + 'message'?: string; + /** + * The request\'s provisioning status. Displayed as Stage in IdentityNow. + * @type {string} + * @memberof CloseaccessrequestV1 + */ + 'executionStatus'?: CloseaccessrequestV1ExecutionStatusV1; + /** + * The request\'s overall status. Displayed as Status in IdentityNow. + * @type {string} + * @memberof CloseaccessrequestV1 + */ + 'completionStatus'?: CloseaccessrequestV1CompletionStatusV1; +} + +export const CloseaccessrequestV1ExecutionStatusV1 = { + Terminated: 'Terminated', + Completed: 'Completed' +} as const; + +export type CloseaccessrequestV1ExecutionStatusV1 = typeof CloseaccessrequestV1ExecutionStatusV1[keyof typeof CloseaccessrequestV1ExecutionStatusV1]; +export const CloseaccessrequestV1CompletionStatusV1 = { + Success: 'Success', + Incomplete: 'Incomplete', + Failure: 'Failure' +} as const; + +export type CloseaccessrequestV1CompletionStatusV1 = typeof CloseaccessrequestV1CompletionStatusV1[keyof typeof CloseaccessrequestV1CompletionStatusV1]; + +/** + * Author of the comment + * @export + * @interface CommentdtoAuthorV1 + */ +export interface CommentdtoAuthorV1 { + /** + * The type of object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'type'?: CommentdtoAuthorV1TypeV1; + /** + * The unique ID of the object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'id'?: string; + /** + * The display name of the object + * @type {string} + * @memberof CommentdtoAuthorV1 + */ + 'name'?: string; +} + +export const CommentdtoAuthorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type CommentdtoAuthorV1TypeV1 = typeof CommentdtoAuthorV1TypeV1[keyof typeof CommentdtoAuthorV1TypeV1]; + +/** + * + * @export + * @interface CommentdtoV1 + */ +export interface CommentdtoV1 { + /** + * Comment content. + * @type {string} + * @memberof CommentdtoV1 + */ + 'comment'?: string | null; + /** + * Date and time comment was created. + * @type {string} + * @memberof CommentdtoV1 + */ + 'created'?: string; + /** + * + * @type {CommentdtoAuthorV1} + * @memberof CommentdtoV1 + */ + 'author'?: CommentdtoAuthorV1; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * The maximum duration for which the access is permitted. + * @export + * @interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ +export interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 { + /** + * The numeric value of the duration. + * @type {number} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'value'?: number; + /** + * The time unit for the duration. + * @type {string} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'timeUnit'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1; +} + +export const EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1[keyof typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1]; + +/** + * + * @export + * @interface EntitlementaccessrequestconfigV1 + */ +export interface EntitlementaccessrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'approvalSchemes'?: Array; + /** + * If the requester must provide a comment during access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requestCommentRequired'?: boolean; + /** + * If the reviewer must provide a comment when denying the access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'denialCommentRequired'?: boolean; + /** + * Is Reauthorization Required + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'reauthorizationRequired'?: boolean; + /** + * If true, then remove date or sunset date is required in access request of the entitlement. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requireEndDate'?: boolean; + /** + * + * @type {EntitlementaccessrequestconfigMaxPermittedAccessDurationV1} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'maxPermittedAccessDuration'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 | null; +} +/** + * + * @export + * @interface EntitlementapprovalschemeV1 + */ +export interface EntitlementapprovalschemeV1 { + /** + * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverType'?: EntitlementapprovalschemeV1ApproverTypeV1; + /** + * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverId'?: string | null; +} + +export const EntitlementapprovalschemeV1ApproverTypeV1 = { + EntitlementOwner: 'ENTITLEMENT_OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW' +} as const; + +export type EntitlementapprovalschemeV1ApproverTypeV1 = typeof EntitlementapprovalschemeV1ApproverTypeV1[keyof typeof EntitlementapprovalschemeV1ApproverTypeV1]; + +/** + * + * @export + * @interface EntitlementrequestconfigV1 + */ +export interface EntitlementrequestconfigV1 { + /** + * + * @type {EntitlementaccessrequestconfigV1} + * @memberof EntitlementrequestconfigV1 + */ + 'accessRequestConfig'?: EntitlementaccessrequestconfigV1; + /** + * + * @type {EntitlementrevocationrequestconfigV1} + * @memberof EntitlementrequestconfigV1 + */ + 'revocationRequestConfig'?: EntitlementrevocationrequestconfigV1; +} +/** + * + * @export + * @interface EntitlementrequestconfigV2 + */ +export interface EntitlementrequestconfigV2 { + /** + * + * @type {EntitlementaccessrequestconfigV1} + * @memberof EntitlementrequestconfigV2 + */ + 'accessRequestConfig'?: EntitlementaccessrequestconfigV1; + /** + * + * @type {EntitlementrevocationrequestconfigV1} + * @memberof EntitlementrequestconfigV2 + */ + 'revocationRequestConfig'?: EntitlementrevocationrequestconfigV1; +} +/** + * + * @export + * @interface EntitlementrevocationrequestconfigV1 + */ +export interface EntitlementrevocationrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementrevocationrequestconfigV1 + */ + 'approvalSchemes'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAccessRequestConfigV1401ResponseV1 + */ +export interface GetAccessRequestConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAccessRequestConfigV1429ResponseV1 + */ +export interface GetAccessRequestConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface IdentityaccountselectionsV1 + */ +export interface IdentityaccountselectionsV1 { + /** + * Available account selections for the identity, per requested item + * @type {Array} + * @memberof IdentityaccountselectionsV1 + */ + 'requestedItems'?: Array; + /** + * A boolean indicating whether any account selections will be required for the user to raise an access request + * @type {boolean} + * @memberof IdentityaccountselectionsV1 + */ + 'accountsSelectionRequired'?: boolean; + /** + * + * @type {DtotypeV1} + * @memberof IdentityaccountselectionsV1 + */ + 'type'?: DtotypeV1; + /** + * The identity id for the user + * @type {string} + * @memberof IdentityaccountselectionsV1 + */ + 'id'?: string; + /** + * The name of the identity + * @type {string} + * @memberof IdentityaccountselectionsV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface IdentityentitlementdetailsV1 + */ +export interface IdentityentitlementdetailsV1 { + /** + * Id of Identity + * @type {string} + * @memberof IdentityentitlementdetailsV1 + */ + 'identityId'?: string; + /** + * + * @type {IdentityentitlementdetailsentitlementdtoV1} + * @memberof IdentityentitlementdetailsV1 + */ + 'entitlement'?: IdentityentitlementdetailsentitlementdtoV1; + /** + * Id of Source + * @type {string} + * @memberof IdentityentitlementdetailsV1 + */ + 'sourceId'?: string; + /** + * A list of account targets on the identity provisioned with the requested entitlement. + * @type {Array} + * @memberof IdentityentitlementdetailsV1 + */ + 'accountTargets'?: Array; +} +/** + * + * @export + * @interface IdentityentitlementdetailsaccounttargetV1 + */ +export interface IdentityentitlementdetailsaccounttargetV1 { + /** + * The id of account + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'accountId'?: string; + /** + * The name of account + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'accountName'?: string; + /** + * The UUID representation of the account if available + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'accountUUID'?: string | null; + /** + * The id of Source + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'sourceId'?: string; + /** + * The name of Source + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'sourceName'?: string; + /** + * The removal date scheduled for the entitlement on the Identity + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'removeDate'?: string | null; + /** + * The assignmentId of the entitlement on the Identity + * @type {string} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'assignmentId'?: string | null; + /** + * If the entitlement can be revoked + * @type {boolean} + * @memberof IdentityentitlementdetailsaccounttargetV1 + */ + 'revocable'?: boolean; +} +/** + * + * @export + * @interface IdentityentitlementdetailsentitlementdtoV1 + */ +export interface IdentityentitlementdetailsentitlementdtoV1 { + /** + * The entitlement id + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'name'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'modified'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'description'?: string | null; + /** + * The type of the object, will always be \"ENTITLEMENT\" + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'type'?: string; + /** + * The source ID + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'sourceId'?: string; + /** + * The source name + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'sourceName'?: string; + /** + * + * @type {OwnerdtoV1} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'owner'?: OwnerdtoV1; + /** + * The value of the entitlement + * @type {string} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'value'?: string; + /** + * a list of properties informing the viewer about the entitlement + * @type {Array} + * @memberof IdentityentitlementdetailsentitlementdtoV1 + */ + 'flags'?: Array; +} +/** + * + * @export + * @interface IdentityreferencewithnameandemailV1 + */ +export interface IdentityreferencewithnameandemailV1 { + /** + * The type can only be IDENTITY. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'type'?: string; + /** + * Identity ID. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'id'?: string; + /** + * Identity\'s human-readable display name. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'name'?: string; + /** + * Identity\'s email address. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'email'?: string | null; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Identity of current work item owner. + * @export + * @interface ManualworkitemdetailsCurrentOwnerV1 + */ +export interface ManualworkitemdetailsCurrentOwnerV1 { + /** + * DTO type of current work item owner\'s identity. + * @type {string} + * @memberof ManualworkitemdetailsCurrentOwnerV1 + */ + 'type'?: ManualworkitemdetailsCurrentOwnerV1TypeV1; + /** + * ID of current work item owner\'s identity. + * @type {string} + * @memberof ManualworkitemdetailsCurrentOwnerV1 + */ + 'id'?: string; + /** + * Display name of current work item owner. + * @type {string} + * @memberof ManualworkitemdetailsCurrentOwnerV1 + */ + 'name'?: string; +} + +export const ManualworkitemdetailsCurrentOwnerV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type ManualworkitemdetailsCurrentOwnerV1TypeV1 = typeof ManualworkitemdetailsCurrentOwnerV1TypeV1[keyof typeof ManualworkitemdetailsCurrentOwnerV1TypeV1]; + +/** + * Identity of original work item owner, if the work item has been forwarded. + * @export + * @interface ManualworkitemdetailsOriginalOwnerV1 + */ +export interface ManualworkitemdetailsOriginalOwnerV1 { + /** + * DTO type of original work item owner\'s identity. + * @type {string} + * @memberof ManualworkitemdetailsOriginalOwnerV1 + */ + 'type'?: ManualworkitemdetailsOriginalOwnerV1TypeV1; + /** + * ID of original work item owner\'s identity. + * @type {string} + * @memberof ManualworkitemdetailsOriginalOwnerV1 + */ + 'id'?: string; + /** + * Display name of original work item owner. + * @type {string} + * @memberof ManualworkitemdetailsOriginalOwnerV1 + */ + 'name'?: string; +} + +export const ManualworkitemdetailsOriginalOwnerV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type ManualworkitemdetailsOriginalOwnerV1TypeV1 = typeof ManualworkitemdetailsOriginalOwnerV1TypeV1[keyof typeof ManualworkitemdetailsOriginalOwnerV1TypeV1]; + +/** + * + * @export + * @interface ManualworkitemdetailsV1 + */ +export interface ManualworkitemdetailsV1 { + /** + * True if the request for this item was forwarded from one owner to another. + * @type {boolean} + * @memberof ManualworkitemdetailsV1 + */ + 'forwarded'?: boolean; + /** + * + * @type {ManualworkitemdetailsOriginalOwnerV1} + * @memberof ManualworkitemdetailsV1 + */ + 'originalOwner'?: ManualworkitemdetailsOriginalOwnerV1 | null; + /** + * + * @type {ManualworkitemdetailsCurrentOwnerV1} + * @memberof ManualworkitemdetailsV1 + */ + 'currentOwner'?: ManualworkitemdetailsCurrentOwnerV1 | null; + /** + * Time at which item was modified. + * @type {string} + * @memberof ManualworkitemdetailsV1 + */ + 'modified'?: string; + /** + * + * @type {ManualworkitemstateV1} + * @memberof ManualworkitemdetailsV1 + */ + 'status'?: ManualworkitemstateV1; + /** + * The history of approval forward action. + * @type {Array} + * @memberof ManualworkitemdetailsV1 + */ + 'forwardHistory'?: Array | null; +} + + +/** + * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. + * @export + * @enum {string} + */ + +export const ManualworkitemstateV1 = { + Pending: 'PENDING', + Approved: 'APPROVED', + Rejected: 'REJECTED', + Expired: 'EXPIRED', + Cancelled: 'CANCELLED', + Archived: 'ARCHIVED' +} as const; + +export type ManualworkitemstateV1 = typeof ManualworkitemstateV1[keyof typeof ManualworkitemstateV1]; + + +/** + * Owner\'s identity. + * @export + * @interface OwnerdtoV1 + */ +export interface OwnerdtoV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'type'?: OwnerdtoV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'name'?: string; +} + +export const OwnerdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerdtoV1TypeV1 = typeof OwnerdtoV1TypeV1[keyof typeof OwnerdtoV1TypeV1]; + +/** + * Provides additional details about the pre-approval trigger for this request. + * @export + * @interface PreapprovaltriggerdetailsV1 + */ +export interface PreapprovaltriggerdetailsV1 { + /** + * Comment left for the pre-approval decision + * @type {string} + * @memberof PreapprovaltriggerdetailsV1 + */ + 'comment'?: string; + /** + * The reviewer of the pre-approval decision + * @type {string} + * @memberof PreapprovaltriggerdetailsV1 + */ + 'reviewer'?: string; + /** + * The decision of the pre-approval trigger + * @type {string} + * @memberof PreapprovaltriggerdetailsV1 + */ + 'decision'?: PreapprovaltriggerdetailsV1DecisionV1; +} + +export const PreapprovaltriggerdetailsV1DecisionV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED' +} as const; + +export type PreapprovaltriggerdetailsV1DecisionV1 = typeof PreapprovaltriggerdetailsV1DecisionV1[keyof typeof PreapprovaltriggerdetailsV1DecisionV1]; + +/** + * Provides additional details about provisioning for this request. + * @export + * @interface ProvisioningdetailsV1 + */ +export interface ProvisioningdetailsV1 { + /** + * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. + * @type {string} + * @memberof ProvisioningdetailsV1 + */ + 'orderedSubPhaseReferences'?: string; +} +/** + * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). + * @export + * @enum {string} + */ + +export const ReassignmenttypeV1 = { + ManualReassignment: 'MANUAL_REASSIGNMENT', + AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', + AutoEscalation: 'AUTO_ESCALATION', + SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' +} as const; + +export type ReassignmenttypeV1 = typeof ReassignmenttypeV1[keyof typeof ReassignmenttypeV1]; + + +/** + * + * @export + * @interface RequestedaccountrefV1 + */ +export interface RequestedaccountrefV1 { + /** + * Display name of the account for the user + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'name'?: string; + /** + * + * @type {DtotypeV1} + * @memberof RequestedaccountrefV1 + */ + 'type'?: DtotypeV1; + /** + * The uuid for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'accountUuid'?: string | null; + /** + * The native identity for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'accountId'?: string | null; + /** + * Display name of the source for the account + * @type {string} + * @memberof RequestedaccountrefV1 + */ + 'sourceName'?: string; +} + + +/** + * + * @export + * @interface RequestedfordtorefV1 + */ +export interface RequestedfordtorefV1 { + /** + * The identity id for which the access is requested + * @type {string} + * @memberof RequestedfordtorefV1 + */ + 'identityId': string; + /** + * the details for the access items that are requested for the identity + * @type {Array} + * @memberof RequestedfordtorefV1 + */ + 'requestedItems': Array; +} +/** + * + * @export + * @interface RequesteditemaccountselectionsV1 + */ +export interface RequesteditemaccountselectionsV1 { + /** + * The description for this requested item + * @type {string} + * @memberof RequesteditemaccountselectionsV1 + */ + 'description'?: string; + /** + * This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. + * @type {boolean} + * @memberof RequesteditemaccountselectionsV1 + */ + 'accountsSelectionBlocked'?: boolean; + /** + * If account selections are not allowed for an item, this field will denote the reason. + * @type {string} + * @memberof RequesteditemaccountselectionsV1 + */ + 'accountsSelectionBlockedReason'?: string | null; + /** + * The type of the item being requested. + * @type {string} + * @memberof RequesteditemaccountselectionsV1 + */ + 'type'?: RequesteditemaccountselectionsV1TypeV1; + /** + * The id of the requested item + * @type {string} + * @memberof RequesteditemaccountselectionsV1 + */ + 'id'?: string; + /** + * The name of the requested item + * @type {string} + * @memberof RequesteditemaccountselectionsV1 + */ + 'name'?: string; + /** + * The details for the sources and accounts for the requested item and identity combination + * @type {Array} + * @memberof RequesteditemaccountselectionsV1 + */ + 'sources'?: Array; +} + +export const RequesteditemaccountselectionsV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequesteditemaccountselectionsV1TypeV1 = typeof RequesteditemaccountselectionsV1TypeV1[keyof typeof RequesteditemaccountselectionsV1TypeV1]; + +/** + * + * @export + * @interface RequesteditemdetailsV1 + */ +export interface RequesteditemdetailsV1 { + /** + * The type of access item requested. + * @type {string} + * @memberof RequesteditemdetailsV1 + */ + 'type'?: RequesteditemdetailsV1TypeV1; + /** + * The id of the access item requested. + * @type {string} + * @memberof RequesteditemdetailsV1 + */ + 'id'?: string; +} + +export const RequesteditemdetailsV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Entitlement: 'ENTITLEMENT', + Role: 'ROLE' +} as const; + +export type RequesteditemdetailsV1TypeV1 = typeof RequesteditemdetailsV1TypeV1[keyof typeof RequesteditemdetailsV1TypeV1]; + +/** + * + * @export + * @interface RequesteditemdtorefV1 + */ +export interface RequesteditemdtorefV1 { + /** + * The type of the item being requested. + * @type {string} + * @memberof RequesteditemdtorefV1 + */ + 'type': RequesteditemdtorefV1TypeV1; + /** + * ID of Role, Access Profile or Entitlement being requested. + * @type {string} + * @memberof RequesteditemdtorefV1 + */ + 'id': string; + /** + * Comment provided by requester. * Comment is required when the request is of type Revoke Access. + * @type {string} + * @memberof RequesteditemdtorefV1 + */ + 'comment'?: string; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. + * @type {{ [key: string]: string; }} + * @memberof RequesteditemdtorefV1 + */ + 'clientMetadata'?: { [key: string]: string; }; + /** + * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. + * @type {string} + * @memberof RequesteditemdtorefV1 + */ + 'startDate'?: string; + /** + * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. + * @type {string} + * @memberof RequesteditemdtorefV1 + */ + 'removeDate'?: string; + /** + * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account + * @type {Array} + * @memberof RequesteditemdtorefV1 + */ + 'accountSelection'?: Array | null; +} + +export const RequesteditemdtorefV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequesteditemdtorefV1TypeV1 = typeof RequesteditemdtorefV1TypeV1[keyof typeof RequesteditemdtorefV1TypeV1]; + +/** + * + * @export + * @interface RequesteditemstatusCancelledRequestDetailsV1 + */ +export interface RequesteditemstatusCancelledRequestDetailsV1 { + /** + * Comment made by the owner when cancelling the associated request. + * @type {string} + * @memberof RequesteditemstatusCancelledRequestDetailsV1 + */ + 'comment'?: string; + /** + * + * @type {OwnerdtoV1} + * @memberof RequesteditemstatusCancelledRequestDetailsV1 + */ + 'owner'?: OwnerdtoV1; + /** + * Date comment was added by the owner when cancelling the associated request. + * @type {string} + * @memberof RequesteditemstatusCancelledRequestDetailsV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface RequesteditemstatusPreApprovalTriggerDetailsV1 + */ +export interface RequesteditemstatusPreApprovalTriggerDetailsV1 { + /** + * Comment left for the pre-approval decision + * @type {string} + * @memberof RequesteditemstatusPreApprovalTriggerDetailsV1 + */ + 'comment'?: string; + /** + * The reviewer of the pre-approval decision + * @type {string} + * @memberof RequesteditemstatusPreApprovalTriggerDetailsV1 + */ + 'reviewer'?: string; + /** + * The decision of the pre-approval trigger + * @type {string} + * @memberof RequesteditemstatusPreApprovalTriggerDetailsV1 + */ + 'decision'?: RequesteditemstatusPreApprovalTriggerDetailsV1DecisionV1; +} + +export const RequesteditemstatusPreApprovalTriggerDetailsV1DecisionV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED' +} as const; + +export type RequesteditemstatusPreApprovalTriggerDetailsV1DecisionV1 = typeof RequesteditemstatusPreApprovalTriggerDetailsV1DecisionV1[keyof typeof RequesteditemstatusPreApprovalTriggerDetailsV1DecisionV1]; + +/** + * + * @export + * @interface RequesteditemstatusProvisioningDetailsV1 + */ +export interface RequesteditemstatusProvisioningDetailsV1 { + /** + * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. + * @type {string} + * @memberof RequesteditemstatusProvisioningDetailsV1 + */ + 'orderedSubPhaseReferences'?: string; +} +/** + * Identity access was requested for. + * @export + * @interface RequesteditemstatusRequestedForV1 + */ +export interface RequesteditemstatusRequestedForV1 { + /** + * Type of the object to which this reference applies + * @type {string} + * @memberof RequesteditemstatusRequestedForV1 + */ + 'type'?: RequesteditemstatusRequestedForV1TypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof RequesteditemstatusRequestedForV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof RequesteditemstatusRequestedForV1 + */ + 'name'?: string; +} + +export const RequesteditemstatusRequestedForV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type RequesteditemstatusRequestedForV1TypeV1 = typeof RequesteditemstatusRequestedForV1TypeV1[keyof typeof RequesteditemstatusRequestedForV1TypeV1]; + +/** + * + * @export + * @interface RequesteditemstatusRequesterCommentV1 + */ +export interface RequesteditemstatusRequesterCommentV1 { + /** + * Comment content. + * @type {string} + * @memberof RequesteditemstatusRequesterCommentV1 + */ + 'comment'?: string | null; + /** + * Date and time comment was created. + * @type {string} + * @memberof RequesteditemstatusRequesterCommentV1 + */ + 'created'?: string; + /** + * + * @type {CommentdtoAuthorV1} + * @memberof RequesteditemstatusRequesterCommentV1 + */ + 'author'?: CommentdtoAuthorV1; +} +/** + * + * @export + * @interface RequesteditemstatusSodViolationContextV1 + */ +export interface RequesteditemstatusSodViolationContextV1 { + /** + * The status of SOD violation check + * @type {string} + * @memberof RequesteditemstatusSodViolationContextV1 + */ + 'state'?: RequesteditemstatusSodViolationContextV1StateV1 | null; + /** + * The id of the Violation check event + * @type {string} + * @memberof RequesteditemstatusSodViolationContextV1 + */ + 'uuid'?: string | null; + /** + * + * @type {SodviolationcheckresultV1} + * @memberof RequesteditemstatusSodViolationContextV1 + */ + 'violationCheckResult'?: SodviolationcheckresultV1; +} + +export const RequesteditemstatusSodViolationContextV1StateV1 = { + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type RequesteditemstatusSodViolationContextV1StateV1 = typeof RequesteditemstatusSodViolationContextV1StateV1[keyof typeof RequesteditemstatusSodViolationContextV1StateV1]; + +/** + * + * @export + * @interface RequesteditemstatusV1 + */ +export interface RequesteditemstatusV1 { + /** + * The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'id'?: string | null; + /** + * Human-readable display name of the item being requested. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'name'?: string | null; + /** + * Type of requested object. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'type'?: RequesteditemstatusV1TypeV1 | null; + /** + * + * @type {RequesteditemstatusCancelledRequestDetailsV1} + * @memberof RequesteditemstatusV1 + */ + 'cancelledRequestDetails'?: RequesteditemstatusCancelledRequestDetailsV1; + /** + * List of list of localized error messages, if any, encountered during the approval/provisioning process. + * @type {Array>} + * @memberof RequesteditemstatusV1 + */ + 'errorMessages'?: Array> | null; + /** + * + * @type {RequesteditemstatusrequeststateV1} + * @memberof RequesteditemstatusV1 + */ + 'state'?: RequesteditemstatusrequeststateV1; + /** + * Approval details for each item. + * @type {Array} + * @memberof RequesteditemstatusV1 + */ + 'approvalDetails'?: Array; + /** + * List of approval IDs associated with the request. + * @type {Array} + * @memberof RequesteditemstatusV1 + */ + 'approvalIds'?: Array | null; + /** + * Manual work items created for provisioning the item. + * @type {Array} + * @memberof RequesteditemstatusV1 + */ + 'manualWorkItemDetails'?: Array | null; + /** + * Id of associated account activity item. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'accountActivityItemId'?: string; + /** + * + * @type {AccessrequesttypeV1} + * @memberof RequesteditemstatusV1 + */ + 'requestType'?: AccessrequesttypeV1 | null; + /** + * When the request was last modified. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'modified'?: string | null; + /** + * When the request was created. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'created'?: string; + /** + * + * @type {AccessitemrequesterV1} + * @memberof RequesteditemstatusV1 + */ + 'requester'?: AccessitemrequesterV1; + /** + * + * @type {RequesteditemstatusRequestedForV1} + * @memberof RequesteditemstatusV1 + */ + 'requestedFor'?: RequesteditemstatusRequestedForV1; + /** + * + * @type {RequesteditemstatusRequesterCommentV1} + * @memberof RequesteditemstatusV1 + */ + 'requesterComment'?: RequesteditemstatusRequesterCommentV1; + /** + * + * @type {RequesteditemstatusSodViolationContextV1} + * @memberof RequesteditemstatusV1 + */ + 'sodViolationContext'?: RequesteditemstatusSodViolationContextV1; + /** + * + * @type {RequesteditemstatusProvisioningDetailsV1} + * @memberof RequesteditemstatusV1 + */ + 'provisioningDetails'?: RequesteditemstatusProvisioningDetailsV1; + /** + * + * @type {RequesteditemstatusPreApprovalTriggerDetailsV1} + * @memberof RequesteditemstatusV1 + */ + 'preApprovalTriggerDetails'?: RequesteditemstatusPreApprovalTriggerDetailsV1; + /** + * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + * @type {Array} + * @memberof RequesteditemstatusV1 + */ + 'accessRequestPhases'?: Array | null; + /** + * Description associated to the requested object. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'description'?: string | null; + /** + * When the role access is scheduled for provisioning. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'startDate'?: string | null; + /** + * When the role access is scheduled for removal. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'removeDate'?: string | null; + /** + * True if the request can be canceled. + * @type {boolean} + * @memberof RequesteditemstatusV1 + */ + 'cancelable'?: boolean; + /** + * This is the account activity id. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'accessRequestId'?: string; + /** + * Arbitrary key-value pairs, if any were included in the corresponding access request + * @type {{ [key: string]: string; }} + * @memberof RequesteditemstatusV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; + /** + * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. + * @type {Array} + * @memberof RequesteditemstatusV1 + */ + 'requestedAccounts'?: Array | null; + /** + * The privilege level of the requested access item, if applicable. + * @type {string} + * @memberof RequesteditemstatusV1 + */ + 'privilegeLevel'?: string | null; +} + +export const RequesteditemstatusV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequesteditemstatusV1TypeV1 = typeof RequesteditemstatusV1TypeV1[keyof typeof RequesteditemstatusV1TypeV1]; + +/** + * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. + * @export + * @enum {string} + */ + +export const RequesteditemstatusrequeststateV1 = { + Executing: 'EXECUTING', + RequestCompleted: 'REQUEST_COMPLETED', + Cancelled: 'CANCELLED', + Terminated: 'TERMINATED', + ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', + Rejected: 'REJECTED', + ProvisioningFailed: 'PROVISIONING_FAILED', + NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', + Error: 'ERROR' +} as const; + +export type RequesteditemstatusrequeststateV1 = typeof RequesteditemstatusrequeststateV1[keyof typeof RequesteditemstatusrequeststateV1]; + + +/** + * + * @export + * @interface RequestonbehalfofconfigV1 + */ +export interface RequestonbehalfofconfigV1 { + /** + * If this is true, anyone can request access for anyone. + * @type {boolean} + * @memberof RequestonbehalfofconfigV1 + */ + 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; + /** + * If this is true, a manager can request access for his or her direct reports. + * @type {boolean} + * @memberof RequestonbehalfofconfigV1 + */ + 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; +} +/** + * + * @export + * @interface RequestonbehalfofconfigV2 + */ +export interface RequestonbehalfofconfigV2 { + /** + * If this is true, anyone can request access for anyone. + * @type {boolean} + * @memberof RequestonbehalfofconfigV2 + */ + 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; + /** + * If this is true, a manager can request access for his or her direct reports. + * @type {boolean} + * @memberof RequestonbehalfofconfigV2 + */ + 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; +} +/** + * Details of the Entitlement criteria + * @export + * @interface SodexemptcriteriaV1 + */ +export interface SodexemptcriteriaV1 { + /** + * If the entitlement already belonged to the user or not. + * @type {boolean} + * @memberof SodexemptcriteriaV1 + */ + 'existing'?: boolean; + /** + * + * @type {DtotypeV1} + * @memberof SodexemptcriteriaV1 + */ + 'type'?: DtotypeV1; + /** + * Entitlement ID + * @type {string} + * @memberof SodexemptcriteriaV1 + */ + 'id'?: string; + /** + * Entitlement name + * @type {string} + * @memberof SodexemptcriteriaV1 + */ + 'name'?: string; +} + + +/** + * SOD policy. + * @export + * @interface SodpolicydtoV1 + */ +export interface SodpolicydtoV1 { + /** + * SOD policy DTO type. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'type'?: SodpolicydtoV1TypeV1; + /** + * SOD policy ID. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'id'?: string; + /** + * SOD policy display name. + * @type {string} + * @memberof SodpolicydtoV1 + */ + 'name'?: string; +} + +export const SodpolicydtoV1TypeV1 = { + SodPolicy: 'SOD_POLICY' +} as const; + +export type SodpolicydtoV1TypeV1 = typeof SodpolicydtoV1TypeV1[keyof typeof SodpolicydtoV1TypeV1]; + +/** + * The inner object representing the completed SOD Violation check + * @export + * @interface SodviolationcheckresultV1 + */ +export interface SodviolationcheckresultV1 { + /** + * + * @type {ErrormessagedtoV1} + * @memberof SodviolationcheckresultV1 + */ + 'message'?: ErrormessagedtoV1; + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + * @type {{ [key: string]: string; }} + * @memberof SodviolationcheckresultV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; + /** + * + * @type {Array} + * @memberof SodviolationcheckresultV1 + */ + 'violationContexts'?: Array | null; + /** + * A list of the SOD policies that were violated. + * @type {Array} + * @memberof SodviolationcheckresultV1 + */ + 'violatedPolicies'?: Array | null; +} +/** + * + * @export + * @interface SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + */ +export interface SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 { + /** + * + * @type {Array} + * @memberof SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + */ + 'criteriaList'?: Array; +} +/** + * The object which contains the left and right hand side of the entitlements that got violated according to the policy. + * @export + * @interface SodviolationcontextConflictingAccessCriteriaV1 + */ +export interface SodviolationcontextConflictingAccessCriteriaV1 { + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1} + * @memberof SodviolationcontextConflictingAccessCriteriaV1 + */ + 'leftCriteria'?: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1; + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1} + * @memberof SodviolationcontextConflictingAccessCriteriaV1 + */ + 'rightCriteria'?: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1; +} +/** + * The contextual information of the violated criteria + * @export + * @interface SodviolationcontextV1 + */ +export interface SodviolationcontextV1 { + /** + * + * @type {SodpolicydtoV1} + * @memberof SodviolationcontextV1 + */ + 'policy'?: SodpolicydtoV1; + /** + * + * @type {SodviolationcontextConflictingAccessCriteriaV1} + * @memberof SodviolationcontextV1 + */ + 'conflictingAccessCriteria'?: SodviolationcontextConflictingAccessCriteriaV1; +} +/** + * An object referencing a completed SOD violation check + * @export + * @interface SodviolationcontextcheckcompletedV1 + */ +export interface SodviolationcontextcheckcompletedV1 { + /** + * The status of SOD violation check + * @type {string} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'state'?: SodviolationcontextcheckcompletedV1StateV1 | null; + /** + * The id of the Violation check event + * @type {string} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'uuid'?: string | null; + /** + * + * @type {SodviolationcheckresultV1} + * @memberof SodviolationcontextcheckcompletedV1 + */ + 'violationCheckResult'?: SodviolationcheckresultV1; +} + +export const SodviolationcontextcheckcompletedV1StateV1 = { + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type SodviolationcontextcheckcompletedV1StateV1 = typeof SodviolationcontextcheckcompletedV1StateV1[keyof typeof SodviolationcontextcheckcompletedV1StateV1]; + +/** + * + * @export + * @interface SourceaccountselectionsV1 + */ +export interface SourceaccountselectionsV1 { + /** + * + * @type {DtotypeV1} + * @memberof SourceaccountselectionsV1 + */ + 'type'?: DtotypeV1; + /** + * The source id + * @type {string} + * @memberof SourceaccountselectionsV1 + */ + 'id'?: string; + /** + * The source name + * @type {string} + * @memberof SourceaccountselectionsV1 + */ + 'name'?: string; + /** + * The accounts information for a particular source in the requested item + * @type {Array} + * @memberof SourceaccountselectionsV1 + */ + 'accounts'?: Array; +} + + +/** + * + * @export + * @interface SourceitemrefV1 + */ +export interface SourceitemrefV1 { + /** + * The id for the source on which account selections are made + * @type {string} + * @memberof SourceitemrefV1 + */ + 'sourceId'?: string | null; + /** + * A list of account selections on the source. Currently, only one selection per source is supported. + * @type {Array} + * @memberof SourceitemrefV1 + */ + 'accounts'?: Array | null; +} + +/** + * AccessRequestsV1Api - axios parameter creator + * @export + */ +export const AccessRequestsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. + * @summary Bulk approve access request + * @param {BulkapproveaccessrequestV1} bulkapproveaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveBulkAccessRequestV1: async (bulkapproveaccessrequestV1: BulkapproveaccessrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkapproveaccessrequestV1' is not null or undefined + assertParamExists('approveBulkAccessRequestV1', 'bulkapproveaccessrequestV1', bulkapproveaccessrequestV1) + const localVarPath = `/access-request-approvals/v1/bulk-approve`; + // 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(bulkapproveaccessrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. + * @summary Bulk cancel access request + * @param {BulkcancelaccessrequestV1} bulkcancelaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelAccessRequestInBulkV1: async (bulkcancelaccessrequestV1: BulkcancelaccessrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkcancelaccessrequestV1' is not null or undefined + assertParamExists('cancelAccessRequestInBulkV1', 'bulkcancelaccessrequestV1', bulkcancelaccessrequestV1) + const localVarPath = `/access-requests/v1/bulk-cancel`; + // 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(bulkcancelaccessrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + * @summary Cancel access request + * @param {CancelaccessrequestV1} cancelaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelAccessRequestV1: async (cancelaccessrequestV1: CancelaccessrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cancelaccessrequestV1' is not null or undefined + assertParamExists('cancelAccessRequestV1', 'cancelaccessrequestV1', cancelaccessrequestV1) + const localVarPath = `/access-requests/v1/cancel`; + // 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(cancelaccessrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + * @summary Close access request + * @param {CloseaccessrequestV1} closeaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + closeAccessRequestV1: async (closeaccessrequestV1: CloseaccessrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'closeaccessrequestV1' is not null or undefined + assertParamExists('closeAccessRequestV1', 'closeaccessrequestV1', closeaccessrequestV1) + const localVarPath = `/access-requests/v1/close`; + // 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(closeaccessrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. + * @summary Submit access request + * @param {AccessrequestV1} accessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessRequestV1: async (accessrequestV1: AccessrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestV1' is not null or undefined + assertParamExists('createAccessRequestV1', 'accessrequestV1', accessrequestV1) + const localVarPath = `/access-requests/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(accessrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getAccessRequestConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-config/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestConfigV2: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-config/v2`; + // 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, + }; + }, + /** + * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + * @summary Identity entitlement details + * @param {string} identityId The identity ID. + * @param {string} entitlementId The entitlement ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementDetailsForIdentityV1: async (identityId: string, entitlementId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getEntitlementDetailsForIdentityV1', 'identityId', identityId) + // verify required parameter 'entitlementId' is not null or undefined + assertParamExists('getEntitlementDetailsForIdentityV1', 'entitlementId', entitlementId) + const localVarPath = `/revocable-objects/v1` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) + .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); + // 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, + }; + }, + /** + * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + * @summary Access request status + * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* + * @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: **created, modified, accountActivityItemId, name** + * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessRequestStatusV1: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/access-request-status/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 (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (requestedBy !== undefined) { + localVarQueryParameter['requested-by'] = requestedBy; + } + + if (regardingIdentity !== undefined) { + localVarQueryParameter['regarding-identity'] = regardingIdentity; + } + + if (assignedTo !== undefined) { + localVarQueryParameter['assigned-to'] = assignedTo; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (requestState !== undefined) { + localVarQueryParameter['request-state'] = requestState; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + * @summary Access request status for administrators + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + * @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: **created, modified, accountActivityItemId, name, accessRequestId** + * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAdministratorsAccessRequestStatusV1: async (xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('listAdministratorsAccessRequestStatusV1', 'xSailPointExperimental', xSailPointExperimental) + const localVarPath = `/access-request-administration/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 (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (requestedBy !== undefined) { + localVarQueryParameter['requested-by'] = requestedBy; + } + + if (regardingIdentity !== undefined) { + localVarQueryParameter['regarding-identity'] = regardingIdentity; + } + + if (assignedTo !== undefined) { + localVarQueryParameter['assigned-to'] = assignedTo; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (requestState !== undefined) { + localVarQueryParameter['request-state'] = requestState; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + * @summary Get accounts selections for identity + * @param {AccountsselectionrequestV1} accountsselectionrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + loadAccountSelectionsV1: async (accountsselectionrequestV1: AccountsselectionrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountsselectionrequestV1' is not null or undefined + assertParamExists('loadAccountSelectionsV1', 'accountsselectionrequestV1', accountsselectionrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/access-requests/v1/accounts-selection`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accountsselectionrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessrequestconfigV1} accessrequestconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + setAccessRequestConfigV1: async (accessrequestconfigV1: AccessrequestconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestconfigV1' is not null or undefined + assertParamExists('setAccessRequestConfigV1', 'accessrequestconfigV1', accessrequestconfigV1) + const localVarPath = `/access-request-config/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: 'PUT', ...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(accessrequestconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessrequestconfigV2} accessrequestconfigv2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setAccessRequestConfigV2: async (accessrequestconfigv2V1: AccessrequestconfigV2, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestconfigv2V1' is not null or undefined + assertParamExists('setAccessRequestConfigV2', 'accessrequestconfigv2V1', accessrequestconfigv2V1) + const localVarPath = `/access-request-config/v2`; + // 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: 'PUT', ...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(accessrequestconfigv2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccessRequestsV1Api - functional programming interface + * @export + */ +export const AccessRequestsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccessRequestsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. + * @summary Bulk approve access request + * @param {BulkapproveaccessrequestV1} bulkapproveaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveBulkAccessRequestV1(bulkapproveaccessrequestV1: BulkapproveaccessrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkAccessRequestV1(bulkapproveaccessrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.approveBulkAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. + * @summary Bulk cancel access request + * @param {BulkcancelaccessrequestV1} bulkcancelaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelAccessRequestInBulkV1(bulkcancelaccessrequestV1: BulkcancelaccessrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequestInBulkV1(bulkcancelaccessrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.cancelAccessRequestInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + * @summary Cancel access request + * @param {CancelaccessrequestV1} cancelaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelAccessRequestV1(cancelaccessrequestV1: CancelaccessrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequestV1(cancelaccessrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.cancelAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + * @summary Close access request + * @param {CloseaccessrequestV1} closeaccessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async closeAccessRequestV1(closeaccessrequestV1: CloseaccessrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.closeAccessRequestV1(closeaccessrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.closeAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. + * @summary Submit access request + * @param {AccessrequestV1} accessrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccessRequestV1(accessrequestV1: AccessrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequestV1(accessrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.createAccessRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async getAccessRequestConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.getAccessRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestConfigV2(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfigV2(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.getAccessRequestConfigV2']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + * @summary Identity entitlement details + * @param {string} identityId The identity ID. + * @param {string} entitlementId The entitlement ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementDetailsForIdentityV1(identityId: string, entitlementId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDetailsForIdentityV1(identityId, entitlementId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.getEntitlementDetailsForIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + * @summary Access request status + * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* + * @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: **created, modified, accountActivityItemId, name** + * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessRequestStatusV1(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatusV1(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.listAccessRequestStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + * @summary Access request status for administrators + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + * @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: **created, modified, accountActivityItemId, name, accessRequestId** + * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAdministratorsAccessRequestStatusV1(xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAdministratorsAccessRequestStatusV1(xSailPointExperimental, requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.listAdministratorsAccessRequestStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + * @summary Get accounts selections for identity + * @param {AccountsselectionrequestV1} accountsselectionrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async loadAccountSelectionsV1(accountsselectionrequestV1: AccountsselectionrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.loadAccountSelectionsV1(accountsselectionrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.loadAccountSelectionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessrequestconfigV1} accessrequestconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async setAccessRequestConfigV1(accessrequestconfigV1: AccessrequestconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfigV1(accessrequestconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.setAccessRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessrequestconfigV2} accessrequestconfigv2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setAccessRequestConfigV2(accessrequestconfigv2V1: AccessrequestconfigV2, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfigV2(accessrequestconfigv2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccessRequestsV1Api.setAccessRequestConfigV2']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccessRequestsV1Api - factory interface + * @export + */ +export const AccessRequestsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccessRequestsV1ApiFp(configuration) + return { + /** + * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. + * @summary Bulk approve access request + * @param {AccessRequestsV1ApiApproveBulkAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveBulkAccessRequestV1(requestParameters: AccessRequestsV1ApiApproveBulkAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveBulkAccessRequestV1(requestParameters.bulkapproveaccessrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. + * @summary Bulk cancel access request + * @param {AccessRequestsV1ApiCancelAccessRequestInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelAccessRequestInBulkV1(requestParameters: AccessRequestsV1ApiCancelAccessRequestInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelAccessRequestInBulkV1(requestParameters.bulkcancelaccessrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + * @summary Cancel access request + * @param {AccessRequestsV1ApiCancelAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelAccessRequestV1(requestParameters: AccessRequestsV1ApiCancelAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelAccessRequestV1(requestParameters.cancelaccessrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + * @summary Close access request + * @param {AccessRequestsV1ApiCloseAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + closeAccessRequestV1(requestParameters: AccessRequestsV1ApiCloseAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.closeAccessRequestV1(requestParameters.closeaccessrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. + * @summary Submit access request + * @param {AccessRequestsV1ApiCreateAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessRequestV1(requestParameters: AccessRequestsV1ApiCreateAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccessRequestV1(requestParameters.accessrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getAccessRequestConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessRequestConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestConfigV2(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessRequestConfigV2(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + * @summary Identity entitlement details + * @param {AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementDetailsForIdentityV1(requestParameters: AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getEntitlementDetailsForIdentityV1(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + * @summary Access request status + * @param {AccessRequestsV1ApiListAccessRequestStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessRequestStatusV1(requestParameters: AccessRequestsV1ApiListAccessRequestStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessRequestStatusV1(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + * @summary Access request status for administrators + * @param {AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAdministratorsAccessRequestStatusV1(requestParameters: AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAdministratorsAccessRequestStatusV1(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + * @summary Get accounts selections for identity + * @param {AccessRequestsV1ApiLoadAccountSelectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + loadAccountSelectionsV1(requestParameters: AccessRequestsV1ApiLoadAccountSelectionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.loadAccountSelectionsV1(requestParameters.accountsselectionrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessRequestsV1ApiSetAccessRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + setAccessRequestConfigV1(requestParameters: AccessRequestsV1ApiSetAccessRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setAccessRequestConfigV1(requestParameters.accessrequestconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessRequestsV1ApiSetAccessRequestConfigV2Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setAccessRequestConfigV2(requestParameters: AccessRequestsV1ApiSetAccessRequestConfigV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setAccessRequestConfigV2(requestParameters.accessrequestconfigv2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveBulkAccessRequestV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiApproveBulkAccessRequestV1Request + */ +export interface AccessRequestsV1ApiApproveBulkAccessRequestV1Request { + /** + * + * @type {BulkapproveaccessrequestV1} + * @memberof AccessRequestsV1ApiApproveBulkAccessRequestV1 + */ + readonly bulkapproveaccessrequestV1: BulkapproveaccessrequestV1 +} + +/** + * Request parameters for cancelAccessRequestInBulkV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiCancelAccessRequestInBulkV1Request + */ +export interface AccessRequestsV1ApiCancelAccessRequestInBulkV1Request { + /** + * + * @type {BulkcancelaccessrequestV1} + * @memberof AccessRequestsV1ApiCancelAccessRequestInBulkV1 + */ + readonly bulkcancelaccessrequestV1: BulkcancelaccessrequestV1 +} + +/** + * Request parameters for cancelAccessRequestV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiCancelAccessRequestV1Request + */ +export interface AccessRequestsV1ApiCancelAccessRequestV1Request { + /** + * + * @type {CancelaccessrequestV1} + * @memberof AccessRequestsV1ApiCancelAccessRequestV1 + */ + readonly cancelaccessrequestV1: CancelaccessrequestV1 +} + +/** + * Request parameters for closeAccessRequestV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiCloseAccessRequestV1Request + */ +export interface AccessRequestsV1ApiCloseAccessRequestV1Request { + /** + * + * @type {CloseaccessrequestV1} + * @memberof AccessRequestsV1ApiCloseAccessRequestV1 + */ + readonly closeaccessrequestV1: CloseaccessrequestV1 +} + +/** + * Request parameters for createAccessRequestV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiCreateAccessRequestV1Request + */ +export interface AccessRequestsV1ApiCreateAccessRequestV1Request { + /** + * + * @type {AccessrequestV1} + * @memberof AccessRequestsV1ApiCreateAccessRequestV1 + */ + readonly accessrequestV1: AccessrequestV1 +} + +/** + * Request parameters for getEntitlementDetailsForIdentityV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request + */ +export interface AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request { + /** + * The identity ID. + * @type {string} + * @memberof AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1 + */ + readonly identityId: string + + /** + * The entitlement ID + * @type {string} + * @memberof AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1 + */ + readonly entitlementId: string +} + +/** + * Request parameters for listAccessRequestStatusV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiListAccessRequestStatusV1Request + */ +export interface AccessRequestsV1ApiListAccessRequestStatusV1Request { + /** + * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly requestedFor?: string + + /** + * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly requestedBy?: string + + /** + * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly regardingIdentity?: string + + /** + * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly assignedTo?: string + + /** + * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @type {boolean} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly count?: boolean + + /** + * Max number of results to return. + * @type {number} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @type {number} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly offset?: number + + /** + * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + 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: **created, modified, accountActivityItemId, name** + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly sorters?: string + + /** + * Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @type {string} + * @memberof AccessRequestsV1ApiListAccessRequestStatusV1 + */ + readonly requestState?: string +} + +/** + * Request parameters for listAdministratorsAccessRequestStatusV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request + */ +export interface AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly xSailPointExperimental: string + + /** + * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly requestedFor?: string + + /** + * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly requestedBy?: string + + /** + * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly regardingIdentity?: string + + /** + * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly assignedTo?: string + + /** + * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + * @type {boolean} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly count?: boolean + + /** + * Max number of results to return. + * @type {number} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @type {number} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly offset?: number + + /** + * 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + 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: **created, modified, accountActivityItemId, name, accessRequestId** + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly sorters?: string + + /** + * Filter the results by the state of the request. The only valid value is *EXECUTING*. + * @type {string} + * @memberof AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1 + */ + readonly requestState?: string +} + +/** + * Request parameters for loadAccountSelectionsV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiLoadAccountSelectionsV1Request + */ +export interface AccessRequestsV1ApiLoadAccountSelectionsV1Request { + /** + * + * @type {AccountsselectionrequestV1} + * @memberof AccessRequestsV1ApiLoadAccountSelectionsV1 + */ + readonly accountsselectionrequestV1: AccountsselectionrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AccessRequestsV1ApiLoadAccountSelectionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setAccessRequestConfigV1 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiSetAccessRequestConfigV1Request + */ +export interface AccessRequestsV1ApiSetAccessRequestConfigV1Request { + /** + * + * @type {AccessrequestconfigV1} + * @memberof AccessRequestsV1ApiSetAccessRequestConfigV1 + */ + readonly accessrequestconfigV1: AccessrequestconfigV1 +} + +/** + * Request parameters for setAccessRequestConfigV2 operation in AccessRequestsV1Api. + * @export + * @interface AccessRequestsV1ApiSetAccessRequestConfigV2Request + */ +export interface AccessRequestsV1ApiSetAccessRequestConfigV2Request { + /** + * + * @type {AccessrequestconfigV2} + * @memberof AccessRequestsV1ApiSetAccessRequestConfigV2 + */ + readonly accessrequestconfigv2V1: AccessrequestconfigV2 +} + +/** + * AccessRequestsV1Api - object-oriented interface + * @export + * @class AccessRequestsV1Api + * @extends {BaseAPI} + */ +export class AccessRequestsV1Api extends BaseAPI { + /** + * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. + * @summary Bulk approve access request + * @param {AccessRequestsV1ApiApproveBulkAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public approveBulkAccessRequestV1(requestParameters: AccessRequestsV1ApiApproveBulkAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).approveBulkAccessRequestV1(requestParameters.bulkapproveaccessrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. + * @summary Bulk cancel access request + * @param {AccessRequestsV1ApiCancelAccessRequestInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public cancelAccessRequestInBulkV1(requestParameters: AccessRequestsV1ApiCancelAccessRequestInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).cancelAccessRequestInBulkV1(requestParameters.bulkcancelaccessrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + * @summary Cancel access request + * @param {AccessRequestsV1ApiCancelAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public cancelAccessRequestV1(requestParameters: AccessRequestsV1ApiCancelAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).cancelAccessRequestV1(requestParameters.cancelaccessrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + * @summary Close access request + * @param {AccessRequestsV1ApiCloseAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public closeAccessRequestV1(requestParameters: AccessRequestsV1ApiCloseAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).closeAccessRequestV1(requestParameters.closeaccessrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. + * @summary Submit access request + * @param {AccessRequestsV1ApiCreateAccessRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public createAccessRequestV1(requestParameters: AccessRequestsV1ApiCreateAccessRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).createAccessRequestV1(requestParameters.accessrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public getAccessRequestConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).getAccessRequestConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the current access-request configuration. + * @summary Get access request configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public getAccessRequestConfigV2(axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).getAccessRequestConfigV2(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + * @summary Identity entitlement details + * @param {AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public getEntitlementDetailsForIdentityV1(requestParameters: AccessRequestsV1ApiGetEntitlementDetailsForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).getEntitlementDetailsForIdentityV1(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + * @summary Access request status + * @param {AccessRequestsV1ApiListAccessRequestStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public listAccessRequestStatusV1(requestParameters: AccessRequestsV1ApiListAccessRequestStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).listAccessRequestStatusV1(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + * @summary Access request status for administrators + * @param {AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public listAdministratorsAccessRequestStatusV1(requestParameters: AccessRequestsV1ApiListAdministratorsAccessRequestStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).listAdministratorsAccessRequestStatusV1(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + * @summary Get accounts selections for identity + * @param {AccessRequestsV1ApiLoadAccountSelectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public loadAccountSelectionsV1(requestParameters: AccessRequestsV1ApiLoadAccountSelectionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).loadAccountSelectionsV1(requestParameters.accountsselectionrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessRequestsV1ApiSetAccessRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public setAccessRequestConfigV1(requestParameters: AccessRequestsV1ApiSetAccessRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).setAccessRequestConfigV1(requestParameters.accessrequestconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint replaces the current access-request configuration. + * @summary Update access request configuration + * @param {AccessRequestsV1ApiSetAccessRequestConfigV2Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccessRequestsV1Api + */ + public setAccessRequestConfigV2(requestParameters: AccessRequestsV1ApiSetAccessRequestConfigV2Request, axiosOptions?: RawAxiosRequestConfig) { + return AccessRequestsV1ApiFp(this.configuration).setAccessRequestConfigV2(requestParameters.accessrequestconfigv2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/access_requests/base.ts b/sdk-output/access_requests/base.ts new file mode 100644 index 00000000..7aba2c77 --- /dev/null +++ b/sdk-output/access_requests/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Requests + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/access_requests/common.ts b/sdk-output/access_requests/common.ts new file mode 100644 index 00000000..b9012c02 --- /dev/null +++ b/sdk-output/access_requests/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Requests + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/access_requests/configuration.ts b/sdk-output/access_requests/configuration.ts new file mode 100644 index 00000000..59e730d6 --- /dev/null +++ b/sdk-output/access_requests/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Requests + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/v3/git_push.sh b/sdk-output/access_requests/git_push.sh similarity index 100% rename from sdk-output/v3/git_push.sh rename to sdk-output/access_requests/git_push.sh diff --git a/sdk-output/access_requests/index.ts b/sdk-output/access_requests/index.ts new file mode 100644 index 00000000..4ce00654 --- /dev/null +++ b/sdk-output/access_requests/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Access Requests + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/access_requests/package.json b/sdk-output/access_requests/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/access_requests/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/v3/tsconfig.json b/sdk-output/access_requests/tsconfig.json similarity index 100% rename from sdk-output/v3/tsconfig.json rename to sdk-output/access_requests/tsconfig.json diff --git a/sdk-output/account_activities/.gitignore b/sdk-output/account_activities/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/account_activities/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/account_activities/.npmignore b/sdk-output/account_activities/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/account_activities/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/account_activities/.openapi-generator-ignore b/sdk-output/account_activities/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/account_activities/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/account_activities/.openapi-generator/FILES b/sdk-output/account_activities/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/account_activities/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/account_activities/.openapi-generator/VERSION b/sdk-output/account_activities/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/account_activities/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/account_activities/.sdk-partition b/sdk-output/account_activities/.sdk-partition new file mode 100644 index 00000000..6d20d537 --- /dev/null +++ b/sdk-output/account_activities/.sdk-partition @@ -0,0 +1 @@ +account-activities \ No newline at end of file diff --git a/sdk-output/account_activities/README.md b/sdk-output/account_activities/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_activities/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_activities/api.ts b/sdk-output/account_activities/api.ts new file mode 100644 index 00000000..21d8fe68 --- /dev/null +++ b/sdk-output/account_activities/api.ts @@ -0,0 +1,813 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Activities + * 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 AccountactivityV1 + */ +export interface AccountactivityV1 { + /** + * Id of the account activity + * @type {string} + * @memberof AccountactivityV1 + */ + 'id'?: string; + /** + * The name of the activity + * @type {string} + * @memberof AccountactivityV1 + */ + 'name'?: string; + /** + * When the activity was first created + * @type {string} + * @memberof AccountactivityV1 + */ + 'created'?: string; + /** + * When the activity was last modified + * @type {string} + * @memberof AccountactivityV1 + */ + 'modified'?: string | null; + /** + * When the activity was completed + * @type {string} + * @memberof AccountactivityV1 + */ + 'completed'?: string | null; + /** + * + * @type {CompletionstatusV1} + * @memberof AccountactivityV1 + */ + 'completionStatus'?: CompletionstatusV1 | null; + /** + * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). + * @type {string} + * @memberof AccountactivityV1 + */ + 'type'?: string | null; + /** + * + * @type {IdentitysummaryV1} + * @memberof AccountactivityV1 + */ + 'requesterIdentitySummary'?: IdentitysummaryV1 | null; + /** + * + * @type {IdentitysummaryV1} + * @memberof AccountactivityV1 + */ + 'targetIdentitySummary'?: IdentitysummaryV1 | null; + /** + * A list of error messages, if any, that were encountered. + * @type {Array} + * @memberof AccountactivityV1 + */ + 'errors'?: Array | null; + /** + * A list of warning messages, if any, that were encountered. + * @type {Array} + * @memberof AccountactivityV1 + */ + 'warnings'?: Array | null; + /** + * Individual actions performed as part of this account activity + * @type {Array} + * @memberof AccountactivityV1 + */ + 'items'?: Array | null; + /** + * + * @type {ExecutionstatusV1} + * @memberof AccountactivityV1 + */ + 'executionStatus'?: ExecutionstatusV1; + /** + * Arbitrary key-value pairs, if any were included in the corresponding access request + * @type {{ [key: string]: string; }} + * @memberof AccountactivityV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; +} + + +/** + * The state of an approval status + * @export + * @enum {string} + */ + +export const AccountactivityapprovalstatusV1 = { + Finished: 'FINISHED', + Rejected: 'REJECTED', + Returned: 'RETURNED', + Expired: 'EXPIRED', + Pending: 'PENDING', + Canceled: 'CANCELED' +} as const; + +export type AccountactivityapprovalstatusV1 = typeof AccountactivityapprovalstatusV1[keyof typeof AccountactivityapprovalstatusV1]; + + +/** + * + * @export + * @interface AccountactivityitemV1 + */ +export interface AccountactivityitemV1 { + /** + * Item id + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'id'?: string; + /** + * Human-readable display name of item + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'name'?: string; + /** + * Date and time item was requested + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'requested'?: string; + /** + * + * @type {AccountactivityapprovalstatusV1} + * @memberof AccountactivityitemV1 + */ + 'approvalStatus'?: AccountactivityapprovalstatusV1 | null; + /** + * + * @type {ProvisioningstateV1} + * @memberof AccountactivityitemV1 + */ + 'provisioningStatus'?: ProvisioningstateV1; + /** + * + * @type {CommentV1} + * @memberof AccountactivityitemV1 + */ + 'requesterComment'?: CommentV1 | null; + /** + * + * @type {IdentitysummaryV1} + * @memberof AccountactivityitemV1 + */ + 'reviewerIdentitySummary'?: IdentitysummaryV1 | null; + /** + * + * @type {CommentV1} + * @memberof AccountactivityitemV1 + */ + 'reviewerComment'?: CommentV1 | null; + /** + * + * @type {AccountactivityitemoperationV1} + * @memberof AccountactivityitemV1 + */ + 'operation'?: AccountactivityitemoperationV1 | null; + /** + * Attribute to which account activity applies + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'attribute'?: string | null; + /** + * Value of attribute + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'value'?: string | null; + /** + * Native identity in the target system to which the account activity applies + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'nativeIdentity'?: string | null; + /** + * Id of Source to which account activity applies + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'sourceId'?: string; + /** + * + * @type {AccountrequestinfoV1} + * @memberof AccountactivityitemV1 + */ + 'accountRequestInfo'?: AccountrequestinfoV1 | null; + /** + * Arbitrary key-value pairs, if any were included in the corresponding access request item + * @type {{ [key: string]: string; }} + * @memberof AccountactivityitemV1 + */ + 'clientMetadata'?: { [key: string]: string; } | null; + /** + * The date the role or access profile or entitlement is no longer assigned to the specified identity. + * @type {string} + * @memberof AccountactivityitemV1 + */ + 'removeDate'?: string | null; +} + + +/** + * Represents an operation in an account activity item + * @export + * @enum {string} + */ + +export const AccountactivityitemoperationV1 = { + Add: 'ADD', + Create: 'CREATE', + Modify: 'MODIFY', + Delete: 'DELETE', + Disable: 'DISABLE', + Enable: 'ENABLE', + Unlock: 'UNLOCK', + Lock: 'LOCK', + Remove: 'REMOVE', + Set: 'SET' +} as const; + +export type AccountactivityitemoperationV1 = typeof AccountactivityitemoperationV1[keyof typeof AccountactivityitemoperationV1]; + + +/** + * If an account activity item is associated with an access request, captures details of that request. + * @export + * @interface AccountrequestinfoV1 + */ +export interface AccountrequestinfoV1 { + /** + * Id of requested object + * @type {string} + * @memberof AccountrequestinfoV1 + */ + 'requestedObjectId'?: string; + /** + * Human-readable name of requested object + * @type {string} + * @memberof AccountrequestinfoV1 + */ + 'requestedObjectName'?: string; + /** + * + * @type {RequestableobjecttypeV1} + * @memberof AccountrequestinfoV1 + */ + 'requestedObjectType'?: RequestableobjecttypeV1; +} + + +/** + * + * @export + * @interface CommentV1 + */ +export interface CommentV1 { + /** + * Id of the identity making the comment + * @type {string} + * @memberof CommentV1 + */ + 'commenterId'?: string; + /** + * Human-readable display name of the identity making the comment + * @type {string} + * @memberof CommentV1 + */ + 'commenterName'?: string; + /** + * Content of the comment + * @type {string} + * @memberof CommentV1 + */ + 'body'?: string; + /** + * Date and time comment was made + * @type {string} + * @memberof CommentV1 + */ + 'date'?: string; +} +/** + * The status after completion. + * @export + * @enum {string} + */ + +export const CompletionstatusV1 = { + Success: 'SUCCESS', + Failure: 'FAILURE', + Incomplete: 'INCOMPLETE', + Pending: 'PENDING' +} as const; + +export type CompletionstatusV1 = typeof CompletionstatusV1[keyof typeof CompletionstatusV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * The current state of execution. + * @export + * @enum {string} + */ + +export const ExecutionstatusV1 = { + Executing: 'EXECUTING', + Verifying: 'VERIFYING', + Terminated: 'TERMINATED', + Completed: 'COMPLETED' +} as const; + +export type ExecutionstatusV1 = typeof ExecutionstatusV1[keyof typeof ExecutionstatusV1]; + + +/** + * + * @export + * @interface IdentitysummaryV1 + */ +export interface IdentitysummaryV1 { + /** + * ID of this identity summary + * @type {string} + * @memberof IdentitysummaryV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity + * @type {string} + * @memberof IdentitysummaryV1 + */ + 'name'?: string; + /** + * ID of the identity that this summary represents + * @type {string} + * @memberof IdentitysummaryV1 + */ + 'identityId'?: string; + /** + * Indicates if all access items for this summary have been decided on + * @type {boolean} + * @memberof IdentitysummaryV1 + */ + 'completed'?: boolean; +} +/** + * + * @export + * @interface ListAccountActivitiesV1401ResponseV1 + */ +export interface ListAccountActivitiesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccountActivitiesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListAccountActivitiesV1429ResponseV1 + */ +export interface ListAccountActivitiesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccountActivitiesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Provisioning state of an account activity item + * @export + * @enum {string} + */ + +export const ProvisioningstateV1 = { + Pending: 'PENDING', + Finished: 'FINISHED', + Unverifiable: 'UNVERIFIABLE', + Commited: 'COMMITED', + Failed: 'FAILED', + Retry: 'RETRY' +} as const; + +export type ProvisioningstateV1 = typeof ProvisioningstateV1[keyof typeof ProvisioningstateV1]; + + +/** + * Currently supported requestable object types. + * @export + * @enum {string} + */ + +export const RequestableobjecttypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequestableobjecttypeV1 = typeof RequestableobjecttypeV1[keyof typeof RequestableobjecttypeV1]; + + + +/** + * AccountActivitiesV1Api - axios parameter creator + * @export + */ +export const AccountActivitiesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This gets a single account activity by its id. + * @summary Get an account activity + * @param {string} id The account activity id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountActivityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccountActivityV1', 'id', id) + const localVarPath = `/account-activities/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, + }; + }, + /** + * This gets a collection of account activities that satisfy the given query parameters. + * @summary List account activities + * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + * @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: **type, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccountActivitiesV1: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/account-activities/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 (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (requestedBy !== undefined) { + localVarQueryParameter['requested-by'] = requestedBy; + } + + if (regardingIdentity !== undefined) { + localVarQueryParameter['regarding-identity'] = regardingIdentity; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + } +}; + +/** + * AccountActivitiesV1Api - functional programming interface + * @export + */ +export const AccountActivitiesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccountActivitiesV1ApiAxiosParamCreator(configuration) + return { + /** + * This gets a single account activity by its id. + * @summary Get an account activity + * @param {string} id The account activity id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountActivityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivityV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV1Api.getAccountActivityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a collection of account activities that satisfy the given query parameters. + * @summary List account activities + * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + * @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: **type, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccountActivitiesV1(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivitiesV1(requestedFor, requestedBy, regardingIdentity, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV1Api.listAccountActivitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccountActivitiesV1Api - factory interface + * @export + */ +export const AccountActivitiesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccountActivitiesV1ApiFp(configuration) + return { + /** + * This gets a single account activity by its id. + * @summary Get an account activity + * @param {AccountActivitiesV1ApiGetAccountActivityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountActivityV1(requestParameters: AccountActivitiesV1ApiGetAccountActivityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccountActivityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a collection of account activities that satisfy the given query parameters. + * @summary List account activities + * @param {AccountActivitiesV1ApiListAccountActivitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccountActivitiesV1(requestParameters: AccountActivitiesV1ApiListAccountActivitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccountActivitiesV1(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getAccountActivityV1 operation in AccountActivitiesV1Api. + * @export + * @interface AccountActivitiesV1ApiGetAccountActivityV1Request + */ +export interface AccountActivitiesV1ApiGetAccountActivityV1Request { + /** + * The account activity id + * @type {string} + * @memberof AccountActivitiesV1ApiGetAccountActivityV1 + */ + readonly id: string +} + +/** + * Request parameters for listAccountActivitiesV1 operation in AccountActivitiesV1Api. + * @export + * @interface AccountActivitiesV1ApiListAccountActivitiesV1Request + */ +export interface AccountActivitiesV1ApiListAccountActivitiesV1Request { + /** + * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly requestedFor?: string + + /** + * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + * @type {string} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly requestedBy?: string + + /** + * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + * @type {string} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly regardingIdentity?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + * @type {string} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + 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: **type, created, modified** + * @type {string} + * @memberof AccountActivitiesV1ApiListAccountActivitiesV1 + */ + readonly sorters?: string +} + +/** + * AccountActivitiesV1Api - object-oriented interface + * @export + * @class AccountActivitiesV1Api + * @extends {BaseAPI} + */ +export class AccountActivitiesV1Api extends BaseAPI { + /** + * This gets a single account activity by its id. + * @summary Get an account activity + * @param {AccountActivitiesV1ApiGetAccountActivityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountActivitiesV1Api + */ + public getAccountActivityV1(requestParameters: AccountActivitiesV1ApiGetAccountActivityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountActivitiesV1ApiFp(this.configuration).getAccountActivityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a collection of account activities that satisfy the given query parameters. + * @summary List account activities + * @param {AccountActivitiesV1ApiListAccountActivitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountActivitiesV1Api + */ + public listAccountActivitiesV1(requestParameters: AccountActivitiesV1ApiListAccountActivitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccountActivitiesV1ApiFp(this.configuration).listAccountActivitiesV1(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/account_activities/base.ts b/sdk-output/account_activities/base.ts new file mode 100644 index 00000000..4a9df384 --- /dev/null +++ b/sdk-output/account_activities/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Activities + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/account_activities/common.ts b/sdk-output/account_activities/common.ts new file mode 100644 index 00000000..1d126136 --- /dev/null +++ b/sdk-output/account_activities/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Activities + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/account_activities/configuration.ts b/sdk-output/account_activities/configuration.ts new file mode 100644 index 00000000..ceb8b468 --- /dev/null +++ b/sdk-output/account_activities/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Activities + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/account_activities/git_push.sh b/sdk-output/account_activities/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/account_activities/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/account_activities/index.ts b/sdk-output/account_activities/index.ts new file mode 100644 index 00000000..e04d4482 --- /dev/null +++ b/sdk-output/account_activities/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Activities + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/account_activities/package.json b/sdk-output/account_activities/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/account_activities/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/account_activities/tsconfig.json b/sdk-output/account_activities/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/account_activities/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/account_aggregations/.gitignore b/sdk-output/account_aggregations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/account_aggregations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/account_aggregations/.npmignore b/sdk-output/account_aggregations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/account_aggregations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/account_aggregations/.openapi-generator-ignore b/sdk-output/account_aggregations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/account_aggregations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/account_aggregations/.openapi-generator/FILES b/sdk-output/account_aggregations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/account_aggregations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/account_aggregations/.openapi-generator/VERSION b/sdk-output/account_aggregations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/account_aggregations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/account_aggregations/.sdk-partition b/sdk-output/account_aggregations/.sdk-partition new file mode 100644 index 00000000..347e6b5b --- /dev/null +++ b/sdk-output/account_aggregations/.sdk-partition @@ -0,0 +1 @@ +account-aggregations \ No newline at end of file diff --git a/sdk-output/account_aggregations/README.md b/sdk-output/account_aggregations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_aggregations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_aggregations/api.ts b/sdk-output/account_aggregations/api.ts new file mode 100644 index 00000000..722c80c5 --- /dev/null +++ b/sdk-output/account_aggregations/api.ts @@ -0,0 +1,314 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Aggregations + * 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 AccountaggregationstatusV1 + */ +export interface AccountaggregationstatusV1 { + /** + * When the aggregation started. + * @type {string} + * @memberof AccountaggregationstatusV1 + */ + 'start'?: string | null; + /** + * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. + * @type {string} + * @memberof AccountaggregationstatusV1 + */ + 'status'?: AccountaggregationstatusV1StatusV1; + /** + * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'totalAccounts'?: number; + /** + * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'processedAccounts'?: number; + /** + * The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'totalAccountsMarkedForDeletion'?: number; + /** + * The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'deletedAccounts'?: number; + /** + * The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'totalIdentities'?: number; + /** + * The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + * @type {number} + * @memberof AccountaggregationstatusV1 + */ + 'processedIdentities'?: number; +} + +export const AccountaggregationstatusV1StatusV1 = { + Started: 'STARTED', + AccountsCollected: 'ACCOUNTS_COLLECTED', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED', + Retried: 'RETRIED', + Terminated: 'TERMINATED', + NotFound: 'NOT_FOUND' +} as const; + +export type AccountaggregationstatusV1StatusV1 = typeof AccountaggregationstatusV1StatusV1[keyof typeof AccountaggregationstatusV1StatusV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAccountAggregationStatusV1400ResponseV1 + */ +export interface GetAccountAggregationStatusV1400ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccountAggregationStatusV1400ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAccountAggregationStatusV1429ResponseV1 + */ +export interface GetAccountAggregationStatusV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccountAggregationStatusV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AccountAggregationsV1Api - axios parameter creator + * @export + */ +export const AccountAggregationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. + * @summary In-progress account aggregation status + * @param {string} id The account aggregation id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountAggregationStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccountAggregationStatusV1', 'id', id) + const localVarPath = `/account-aggregations/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccountAggregationsV1Api - functional programming interface + * @export + */ +export const AccountAggregationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccountAggregationsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. + * @summary In-progress account aggregation status + * @param {string} id The account aggregation id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountAggregationStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountAggregationStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountAggregationsV1Api.getAccountAggregationStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccountAggregationsV1Api - factory interface + * @export + */ +export const AccountAggregationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccountAggregationsV1ApiFp(configuration) + return { + /** + * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. + * @summary In-progress account aggregation status + * @param {AccountAggregationsV1ApiGetAccountAggregationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountAggregationStatusV1(requestParameters: AccountAggregationsV1ApiGetAccountAggregationStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccountAggregationStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getAccountAggregationStatusV1 operation in AccountAggregationsV1Api. + * @export + * @interface AccountAggregationsV1ApiGetAccountAggregationStatusV1Request + */ +export interface AccountAggregationsV1ApiGetAccountAggregationStatusV1Request { + /** + * The account aggregation id + * @type {string} + * @memberof AccountAggregationsV1ApiGetAccountAggregationStatusV1 + */ + readonly id: string +} + +/** + * AccountAggregationsV1Api - object-oriented interface + * @export + * @class AccountAggregationsV1Api + * @extends {BaseAPI} + */ +export class AccountAggregationsV1Api extends BaseAPI { + /** + * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. + * @summary In-progress account aggregation status + * @param {AccountAggregationsV1ApiGetAccountAggregationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountAggregationsV1Api + */ + public getAccountAggregationStatusV1(requestParameters: AccountAggregationsV1ApiGetAccountAggregationStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountAggregationsV1ApiFp(this.configuration).getAccountAggregationStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/account_aggregations/base.ts b/sdk-output/account_aggregations/base.ts new file mode 100644 index 00000000..d5fa8912 --- /dev/null +++ b/sdk-output/account_aggregations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Aggregations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/account_aggregations/common.ts b/sdk-output/account_aggregations/common.ts new file mode 100644 index 00000000..78446b11 --- /dev/null +++ b/sdk-output/account_aggregations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Aggregations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/account_aggregations/configuration.ts b/sdk-output/account_aggregations/configuration.ts new file mode 100644 index 00000000..d822f01e --- /dev/null +++ b/sdk-output/account_aggregations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Aggregations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/account_aggregations/git_push.sh b/sdk-output/account_aggregations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/account_aggregations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/account_aggregations/index.ts b/sdk-output/account_aggregations/index.ts new file mode 100644 index 00000000..8d86d9a0 --- /dev/null +++ b/sdk-output/account_aggregations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Aggregations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/account_aggregations/package.json b/sdk-output/account_aggregations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/account_aggregations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/account_aggregations/tsconfig.json b/sdk-output/account_aggregations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/account_aggregations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/account_deletion_requests/.gitignore b/sdk-output/account_deletion_requests/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/account_deletion_requests/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/account_deletion_requests/.npmignore b/sdk-output/account_deletion_requests/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/account_deletion_requests/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/account_deletion_requests/.openapi-generator-ignore b/sdk-output/account_deletion_requests/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/account_deletion_requests/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/account_deletion_requests/.openapi-generator/FILES b/sdk-output/account_deletion_requests/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/account_deletion_requests/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/account_deletion_requests/.openapi-generator/VERSION b/sdk-output/account_deletion_requests/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/account_deletion_requests/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/account_deletion_requests/.sdk-partition b/sdk-output/account_deletion_requests/.sdk-partition new file mode 100644 index 00000000..b3290b70 --- /dev/null +++ b/sdk-output/account_deletion_requests/.sdk-partition @@ -0,0 +1 @@ +account-deletion-requests \ No newline at end of file diff --git a/sdk-output/account_deletion_requests/README.md b/sdk-output/account_deletion_requests/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_deletion_requests/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_deletion_requests/api.ts b/sdk-output/account_deletion_requests/api.ts new file mode 100644 index 00000000..f38d9dbe --- /dev/null +++ b/sdk-output/account_deletion_requests/api.ts @@ -0,0 +1,1142 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Deletion Requests + * 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 AccountactionrequestdtoAccountDetailsV1 + */ +export interface AccountactionrequestdtoAccountDetailsV1 { + /** + * unique id of this object + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'id'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'name'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'accountId'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'description'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'nativeIdentity'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'uuid'?: string; + /** + * + * @type {string} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'displayName'?: string; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'disabled'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'locked'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'uncorrelated'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'systemAccount'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'authoritative'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'supportsPasswordChange'?: boolean; + /** + * + * @type {object} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'attributes'?: object; + /** + * + * @type {object} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'application'?: object; + /** + * + * @type {object} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'identity'?: object; + /** + * + * @type {object} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'schema'?: object; + /** + * + * @type {Array} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'pendingAccessRequestIds'?: Array; + /** + * + * @type {Array} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'features'?: Array; + /** + * + * @type {object} + * @memberof AccountactionrequestdtoAccountDetailsV1 + */ + 'meta'?: object; +} + +export const AccountactionrequestdtoAccountDetailsV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING' +} as const; + +export type AccountactionrequestdtoAccountDetailsV1FeaturesV1 = typeof AccountactionrequestdtoAccountDetailsV1FeaturesV1[keyof typeof AccountactionrequestdtoAccountDetailsV1FeaturesV1]; + +/** + * + * @export + * @interface AccountactionrequestdtoCorrelatedIdentityV1 + */ +export interface AccountactionrequestdtoCorrelatedIdentityV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccountactionrequestdtoCorrelatedIdentityV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof AccountactionrequestdtoCorrelatedIdentityV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof AccountactionrequestdtoCorrelatedIdentityV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface AccountactionrequestdtoRequesterV1 + */ +export interface AccountactionrequestdtoRequesterV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccountactionrequestdtoRequesterV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof AccountactionrequestdtoRequesterV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof AccountactionrequestdtoRequesterV1 + */ + 'name'?: string; +} + + +/** + * Represents a request to perform an action on an account, such as deletion or modification. + * @export + * @interface AccountactionrequestdtoV1 + */ +export interface AccountactionrequestdtoV1 { + /** + * Account requester ID. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'accountRequestId'?: string; + /** + * Access item requester\'s identity ID. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'requestType'?: string; + /** + * Creation date and time of account deletion request date. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'createdAt'?: string; + /** + * Account deletion request completion date and time. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'completedAt'?: string; + /** + * Overall status of deletion request. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'overallStatus'?: string; + /** + * + * @type {AccountactionrequestdtoRequesterV1} + * @memberof AccountactionrequestdtoV1 + */ + 'requester'?: AccountactionrequestdtoRequesterV1; + /** + * Comments added by the requester while creating the account deletion request. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'requesterComments'?: string; + /** + * + * @type {AccountactionrequestdtoAccountDetailsV1} + * @memberof AccountactionrequestdtoV1 + */ + 'accountDetails'?: AccountactionrequestdtoAccountDetailsV1; + /** + * + * @type {AccountactionrequestdtoCorrelatedIdentityV1} + * @memberof AccountactionrequestdtoV1 + */ + 'correlatedIdentity'?: AccountactionrequestdtoCorrelatedIdentityV1; + /** + * + * @type {IdentityreferenceV1} + * @memberof AccountactionrequestdtoV1 + */ + 'managerReference'?: IdentityreferenceV1 | null; + /** + * ID of the approval request associated with the account deletion action. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'approvalRequestId'?: string; + /** + * List of account request phases. + * @type {Array} + * @memberof AccountactionrequestdtoV1 + */ + 'accountRequestPhases'?: Array; + /** + * List approval details + * @type {Array} + * @memberof AccountactionrequestdtoV1 + */ + 'approvalDetails'?: Array; + /** + * Detailed error information. + * @type {string} + * @memberof AccountactionrequestdtoV1 + */ + 'errorDetails'?: string | null; +} +/** + * Contains the required information for processing a user-initiated account deletion request, including the reason for deletion. + * @export + * @interface AccountdeleterequestinputV1 + */ +export interface AccountdeleterequestinputV1 { + /** + * Reason for deleting the account. + * @type {string} + * @memberof AccountdeleterequestinputV1 + */ + 'comments'?: string; +} +/** + * Account Details + * @export + * @interface AccountdetailsV1 + */ +export interface AccountdetailsV1 { + /** + * unique id of this object + * @type {string} + * @memberof AccountdetailsV1 + */ + 'id'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'name'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'accountId'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'description'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'nativeIdentity'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'uuid'?: string; + /** + * + * @type {string} + * @memberof AccountdetailsV1 + */ + 'displayName'?: string; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'disabled'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'locked'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'uncorrelated'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'systemAccount'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'authoritative'?: boolean; + /** + * + * @type {boolean} + * @memberof AccountdetailsV1 + */ + 'supportsPasswordChange'?: boolean; + /** + * + * @type {object} + * @memberof AccountdetailsV1 + */ + 'attributes'?: object; + /** + * + * @type {object} + * @memberof AccountdetailsV1 + */ + 'application'?: object; + /** + * + * @type {object} + * @memberof AccountdetailsV1 + */ + 'identity'?: object; + /** + * + * @type {object} + * @memberof AccountdetailsV1 + */ + 'schema'?: object; + /** + * + * @type {Array} + * @memberof AccountdetailsV1 + */ + 'pendingAccessRequestIds'?: Array; + /** + * + * @type {Array} + * @memberof AccountdetailsV1 + */ + 'features'?: Array; + /** + * + * @type {object} + * @memberof AccountdetailsV1 + */ + 'meta'?: object; +} + +export const AccountdetailsV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING' +} as const; + +export type AccountdetailsV1FeaturesV1 = typeof AccountdetailsV1FeaturesV1[keyof typeof AccountdetailsV1FeaturesV1]; + +/** + * Asynchronous response containing a unique tracking ID for the account request + * @export + * @interface AccountrequestasyncresultV1 + */ +export interface AccountrequestasyncresultV1 { + /** + * Id of the account request + * @type {string} + * @memberof AccountrequestasyncresultV1 + */ + 'accountRequestId': string; +} +/** + * Contains detailed information about each phase in the account request process, including its type, current state, and relevant timestamps. + * @export + * @interface AccountrequestphaseV1 + */ +export interface AccountrequestphaseV1 { + /** + * Enum of account request phase type + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'name'?: AccountrequestphaseV1NameV1; + /** + * + * @type {AccountrequestphasestateV1} + * @memberof AccountrequestphaseV1 + */ + 'state'?: AccountrequestphasestateV1; + /** + * Start date of account request phase. + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'started'?: string; + /** + * Finish date of account request phase. + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'finished'?: string; +} + +export const AccountrequestphaseV1NameV1 = { + ApprovalPhase: 'APPROVAL_PHASE', + ProvisioningPhase: 'PROVISIONING_PHASE' +} as const; + +export type AccountrequestphaseV1NameV1 = typeof AccountrequestphaseV1NameV1[keyof typeof AccountrequestphaseV1NameV1]; + +/** + * The current phase state of the account request, indicating its progress or outcome in the approval workflow. + * @export + * @enum {string} + */ + +export const AccountrequestphasestateV1 = { + Pending: 'PENDING', + Cancelled: 'CANCELLED', + Approved: 'APPROVED', + Rejected: 'REJECTED', + Passed: 'PASSED', + Failed: 'FAILED', + NotStarted: 'NOT_STARTED' +} as const; + +export type AccountrequestphasestateV1 = typeof AccountrequestphasestateV1[keyof typeof AccountrequestphasestateV1]; + + +/** + * Contains comprehensive details about the approval process, including the approver\'s information, comments, decision date, serial order, and the current status of the approval request. + * @export + * @interface ApprovaldetailsV1 + */ +export interface ApprovaldetailsV1 { + /** + * + * @type {ApproverdtoV1} + * @memberof ApprovaldetailsV1 + */ + 'approver'?: ApproverdtoV1; + /** + * Comments added by approver while rejecting or approving the account deletion request. + * @type {string} + * @memberof ApprovaldetailsV1 + */ + 'approverComments'?: string; + /** + * Decision date of approval rejected or approved. + * @type {string} + * @memberof ApprovaldetailsV1 + */ + 'decisionDate'?: string; + /** + * SerialOrder of approval details. + * @type {number} + * @memberof ApprovaldetailsV1 + */ + 'serialOrder'?: number; + /** + * + * @type {AccountrequestphasestateV1} + * @memberof ApprovaldetailsV1 + */ + 'status'?: AccountrequestphasestateV1; +} + + +/** + * Contains detailed information about the approver, including their identity, contact details, type, and references to related identities such as owners, actioned identities, and members. + * @export + * @interface ApproverdtoV1 + */ +export interface ApproverdtoV1 { + /** + * Identity ID and it cannot be null. + * @type {string} + * @memberof ApproverdtoV1 + */ + 'identityID'?: string; + /** + * Optional id + * @type {string} + * @memberof ApproverdtoV1 + */ + 'id'?: string | null; + /** + * Identity display name + * @type {string} + * @memberof ApproverdtoV1 + */ + 'name'?: string; + /** + * Email address of identity + * @type {string} + * @memberof ApproverdtoV1 + */ + 'email'?: string; + /** + * Used to mention type of data transfer object in this case it is used to transfer IDENTITY data. + * @type {string} + * @memberof ApproverdtoV1 + */ + 'type'?: string; + /** + * List of reference of identity type dto for account owner identities + * @type {Array} + * @memberof ApproverdtoV1 + */ + 'ownerOf'?: Array | null; + /** + * List of reference of identity type dto who acted on behalf of other identities. + * @type {Array} + * @memberof ApproverdtoV1 + */ + 'actionedAs'?: Array | null; + /** + * List of reference of identity type dto for member identities. + * @type {Array} + * @memberof ApproverdtoV1 + */ + 'members'?: Array | null; +} +/** + * + * @export + * @interface ApproverreferenceV1 + */ +export interface ApproverreferenceV1 { + /** + * Id of supported DtoType like IDENTITY, MACHINE_IDENTITY etc. + * @type {string} + * @memberof ApproverreferenceV1 + */ + 'id'?: string; + /** + * Type of Dto + * @type {string} + * @memberof ApproverreferenceV1 + */ + 'type'?: string; + /** + * Display name of DtoType like IDENTITY, MACHINE_IDENTITY etc + * @type {string} + * @memberof ApproverreferenceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAccountDeletionRequestsV1401ResponseV1 + */ +export interface GetAccountDeletionRequestsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccountDeletionRequestsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAccountDeletionRequestsV1429ResponseV1 + */ +export interface GetAccountDeletionRequestsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccountDeletionRequestsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * The manager for the identity. + * @export + * @interface IdentityreferenceV1 + */ +export interface IdentityreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof IdentityreferenceV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'name'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AccountDeletionRequestsV1Api - axios parameter creator + * @export + */ +export const AccountDeletionRequestsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** + * @summary Delete account + * @param {string} accountId Account ID. + * @param {AccountdeleterequestinputV1} [accountdeleterequestinputV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountRequestV1: async (accountId: string, accountdeleterequestinputV1?: AccountdeleterequestinputV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountId' is not null or undefined + assertParamExists('deleteAccountRequestV1', 'accountId', accountId) + const localVarPath = `/account-requests/v1/account/{accountId}/delete` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // 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(accountdeleterequestinputV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. + * @summary List of Account Deletion Requests + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [mine] Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountDeletionRequestsV1: async (limit?: number, offset?: number, count?: boolean, mine?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/account-requests/v1/deletion`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (mine !== undefined) { + localVarQueryParameter['mine'] = mine; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccountDeletionRequestsV1Api - functional programming interface + * @export + */ +export const AccountDeletionRequestsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccountDeletionRequestsV1ApiAxiosParamCreator(configuration) + return { + /** + * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** + * @summary Delete account + * @param {string} accountId Account ID. + * @param {AccountdeleterequestinputV1} [accountdeleterequestinputV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccountRequestV1(accountId: string, accountdeleterequestinputV1?: AccountdeleterequestinputV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountRequestV1(accountId, accountdeleterequestinputV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountDeletionRequestsV1Api.deleteAccountRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. + * @summary List of Account Deletion Requests + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [mine] Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountDeletionRequestsV1(limit?: number, offset?: number, count?: boolean, mine?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountDeletionRequestsV1(limit, offset, count, mine, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountDeletionRequestsV1Api.getAccountDeletionRequestsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccountDeletionRequestsV1Api - factory interface + * @export + */ +export const AccountDeletionRequestsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccountDeletionRequestsV1ApiFp(configuration) + return { + /** + * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** + * @summary Delete account + * @param {AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountRequestV1(requestParameters: AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccountRequestV1(requestParameters.accountId, requestParameters.accountdeleterequestinputV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. + * @summary List of Account Deletion Requests + * @param {AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountDeletionRequestsV1(requestParameters: AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccountDeletionRequestsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.mine, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteAccountRequestV1 operation in AccountDeletionRequestsV1Api. + * @export + * @interface AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request + */ +export interface AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request { + /** + * Account ID. + * @type {string} + * @memberof AccountDeletionRequestsV1ApiDeleteAccountRequestV1 + */ + readonly accountId: string + + /** + * + * @type {AccountdeleterequestinputV1} + * @memberof AccountDeletionRequestsV1ApiDeleteAccountRequestV1 + */ + readonly accountdeleterequestinputV1?: AccountdeleterequestinputV1 +} + +/** + * Request parameters for getAccountDeletionRequestsV1 operation in AccountDeletionRequestsV1Api. + * @export + * @interface AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request + */ +export interface AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request { + /** + * 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 AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1 + */ + readonly count?: boolean + + /** + * Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. + * @type {boolean} + * @memberof AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1 + */ + readonly mine?: boolean +} + +/** + * AccountDeletionRequestsV1Api - object-oriented interface + * @export + * @class AccountDeletionRequestsV1Api + * @extends {BaseAPI} + */ +export class AccountDeletionRequestsV1Api extends BaseAPI { + /** + * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** + * @summary Delete account + * @param {AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountDeletionRequestsV1Api + */ + public deleteAccountRequestV1(requestParameters: AccountDeletionRequestsV1ApiDeleteAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountDeletionRequestsV1ApiFp(this.configuration).deleteAccountRequestV1(requestParameters.accountId, requestParameters.accountdeleterequestinputV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. + * @summary List of Account Deletion Requests + * @param {AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountDeletionRequestsV1Api + */ + public getAccountDeletionRequestsV1(requestParameters: AccountDeletionRequestsV1ApiGetAccountDeletionRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccountDeletionRequestsV1ApiFp(this.configuration).getAccountDeletionRequestsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.mine, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/account_deletion_requests/base.ts b/sdk-output/account_deletion_requests/base.ts new file mode 100644 index 00000000..e3569973 --- /dev/null +++ b/sdk-output/account_deletion_requests/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Deletion Requests + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/account_deletion_requests/common.ts b/sdk-output/account_deletion_requests/common.ts new file mode 100644 index 00000000..dfcdd107 --- /dev/null +++ b/sdk-output/account_deletion_requests/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Deletion Requests + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/account_deletion_requests/configuration.ts b/sdk-output/account_deletion_requests/configuration.ts new file mode 100644 index 00000000..c3b83364 --- /dev/null +++ b/sdk-output/account_deletion_requests/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Deletion Requests + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/account_deletion_requests/git_push.sh b/sdk-output/account_deletion_requests/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/account_deletion_requests/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/account_deletion_requests/index.ts b/sdk-output/account_deletion_requests/index.ts new file mode 100644 index 00000000..53a96fa1 --- /dev/null +++ b/sdk-output/account_deletion_requests/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Deletion Requests + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/account_deletion_requests/package.json b/sdk-output/account_deletion_requests/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/account_deletion_requests/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/account_deletion_requests/tsconfig.json b/sdk-output/account_deletion_requests/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/account_deletion_requests/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/account_usages/.gitignore b/sdk-output/account_usages/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/account_usages/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/account_usages/.npmignore b/sdk-output/account_usages/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/account_usages/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/account_usages/.openapi-generator-ignore b/sdk-output/account_usages/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/account_usages/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/account_usages/.openapi-generator/FILES b/sdk-output/account_usages/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/account_usages/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/account_usages/.openapi-generator/VERSION b/sdk-output/account_usages/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/account_usages/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/account_usages/.sdk-partition b/sdk-output/account_usages/.sdk-partition new file mode 100644 index 00000000..f9cad579 --- /dev/null +++ b/sdk-output/account_usages/.sdk-partition @@ -0,0 +1 @@ +account-usages \ No newline at end of file diff --git a/sdk-output/account_usages/README.md b/sdk-output/account_usages/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_usages/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_usages/api.ts b/sdk-output/account_usages/api.ts new file mode 100644 index 00000000..9e051525 --- /dev/null +++ b/sdk-output/account_usages/api.ts @@ -0,0 +1,317 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Usages + * 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 AccountusageV1 + */ +export interface AccountusageV1 { + /** + * The first day of the month for which activity is aggregated. + * @type {string} + * @memberof AccountusageV1 + */ + 'date'?: string; + /** + * The number of days within the month that the account was active in a source. + * @type {number} + * @memberof AccountusageV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetUsagesByAccountIdV1401ResponseV1 + */ +export interface GetUsagesByAccountIdV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetUsagesByAccountIdV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetUsagesByAccountIdV1429ResponseV1 + */ +export interface GetUsagesByAccountIdV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetUsagesByAccountIdV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AccountUsagesV1Api - axios parameter creator + * @export + */ +export const AccountUsagesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns a summary of account usage insights for past 12 months. + * @summary Returns account usage insights + * @param {string} accountId ID of IDN account + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **date** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUsagesByAccountIdV1: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountId' is not null or undefined + assertParamExists('getUsagesByAccountIdV1', 'accountId', accountId) + const localVarPath = `/account-usages/v1/{accountId}/summaries` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + } +}; + +/** + * AccountUsagesV1Api - functional programming interface + * @export + */ +export const AccountUsagesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccountUsagesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns a summary of account usage insights for past 12 months. + * @summary Returns account usage insights + * @param {string} accountId ID of IDN account + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **date** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getUsagesByAccountIdV1(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountIdV1(accountId, limit, offset, count, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountUsagesV1Api.getUsagesByAccountIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccountUsagesV1Api - factory interface + * @export + */ +export const AccountUsagesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccountUsagesV1ApiFp(configuration) + return { + /** + * This API returns a summary of account usage insights for past 12 months. + * @summary Returns account usage insights + * @param {AccountUsagesV1ApiGetUsagesByAccountIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUsagesByAccountIdV1(requestParameters: AccountUsagesV1ApiGetUsagesByAccountIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getUsagesByAccountIdV1(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getUsagesByAccountIdV1 operation in AccountUsagesV1Api. + * @export + * @interface AccountUsagesV1ApiGetUsagesByAccountIdV1Request + */ +export interface AccountUsagesV1ApiGetUsagesByAccountIdV1Request { + /** + * ID of IDN account + * @type {string} + * @memberof AccountUsagesV1ApiGetUsagesByAccountIdV1 + */ + readonly accountId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountUsagesV1ApiGetUsagesByAccountIdV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountUsagesV1ApiGetUsagesByAccountIdV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccountUsagesV1ApiGetUsagesByAccountIdV1 + */ + readonly count?: boolean + + /** + * 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: **date** + * @type {string} + * @memberof AccountUsagesV1ApiGetUsagesByAccountIdV1 + */ + readonly sorters?: string +} + +/** + * AccountUsagesV1Api - object-oriented interface + * @export + * @class AccountUsagesV1Api + * @extends {BaseAPI} + */ +export class AccountUsagesV1Api extends BaseAPI { + /** + * This API returns a summary of account usage insights for past 12 months. + * @summary Returns account usage insights + * @param {AccountUsagesV1ApiGetUsagesByAccountIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountUsagesV1Api + */ + public getUsagesByAccountIdV1(requestParameters: AccountUsagesV1ApiGetUsagesByAccountIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountUsagesV1ApiFp(this.configuration).getUsagesByAccountIdV1(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/account_usages/base.ts b/sdk-output/account_usages/base.ts new file mode 100644 index 00000000..0666a76f --- /dev/null +++ b/sdk-output/account_usages/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Usages + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/account_usages/common.ts b/sdk-output/account_usages/common.ts new file mode 100644 index 00000000..4c1519ed --- /dev/null +++ b/sdk-output/account_usages/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Usages + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/account_usages/configuration.ts b/sdk-output/account_usages/configuration.ts new file mode 100644 index 00000000..0b806347 --- /dev/null +++ b/sdk-output/account_usages/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Usages + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/account_usages/git_push.sh b/sdk-output/account_usages/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/account_usages/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/account_usages/index.ts b/sdk-output/account_usages/index.ts new file mode 100644 index 00000000..103fbe88 --- /dev/null +++ b/sdk-output/account_usages/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Account Usages + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/account_usages/package.json b/sdk-output/account_usages/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/account_usages/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/account_usages/tsconfig.json b/sdk-output/account_usages/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/account_usages/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/accounts/.gitignore b/sdk-output/accounts/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/accounts/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/accounts/.npmignore b/sdk-output/accounts/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/accounts/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/accounts/.openapi-generator-ignore b/sdk-output/accounts/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/accounts/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/accounts/.openapi-generator/FILES b/sdk-output/accounts/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/accounts/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/accounts/.openapi-generator/VERSION b/sdk-output/accounts/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/accounts/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/accounts/.sdk-partition b/sdk-output/accounts/.sdk-partition new file mode 100644 index 00000000..17e27af8 --- /dev/null +++ b/sdk-output/accounts/.sdk-partition @@ -0,0 +1 @@ +accounts \ No newline at end of file diff --git a/sdk-output/accounts/README.md b/sdk-output/accounts/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/accounts/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/accounts/api.ts b/sdk-output/accounts/api.ts new file mode 100644 index 00000000..4c914c35 --- /dev/null +++ b/sdk-output/accounts/api.ts @@ -0,0 +1,2612 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Accounts + * 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'; + +/** + * Metadata that describes an access item + * @export + * @interface AccessmodelmetadataV1 + */ +export interface AccessmodelmetadataV1 { + /** + * Unique identifier for the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'key'?: string; + /** + * Human readable name of the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'name'?: string; + /** + * Allows selecting multiple values + * @type {boolean} + * @memberof AccessmodelmetadataV1 + */ + 'multiselect'?: boolean; + /** + * The state of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'status'?: string; + /** + * The type of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'type'?: string; + /** + * The types of objects + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'objectTypes'?: Array; + /** + * Describes the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'description'?: string; + /** + * The value to assign to the metadata item + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'values'?: Array; +} +/** + * An individual value to assign to the metadata item + * @export + * @interface AccessmodelmetadataValuesInnerV1 + */ +export interface AccessmodelmetadataValuesInnerV1 { + /** + * The value to assign to the metdata item + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'value'?: string; + /** + * Display name of the value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'name'?: string; + /** + * The status of the individual value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'status'?: string; +} +/** + * The identity this account is correlated to + * @export + * @interface AccountAllOfIdentityV1 + */ +export interface AccountAllOfIdentityV1 { + /** + * The ID of the identity + * @type {string} + * @memberof AccountAllOfIdentityV1 + */ + 'id'?: string; + /** + * The type of object being referenced + * @type {string} + * @memberof AccountAllOfIdentityV1 + */ + 'type'?: AccountAllOfIdentityV1TypeV1; + /** + * display name of identity + * @type {string} + * @memberof AccountAllOfIdentityV1 + */ + 'name'?: string; +} + +export const AccountAllOfIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccountAllOfIdentityV1TypeV1 = typeof AccountAllOfIdentityV1TypeV1[keyof typeof AccountAllOfIdentityV1TypeV1]; + +/** + * + * @export + * @interface AccountAllOfOwnerIdentityV1 + */ +export interface AccountAllOfOwnerIdentityV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccountAllOfOwnerIdentityV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof AccountAllOfOwnerIdentityV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof AccountAllOfOwnerIdentityV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface AccountAllOfRecommendationV1 + */ +export interface AccountAllOfRecommendationV1 { + /** + * Recommended type of account. + * @type {string} + * @memberof AccountAllOfRecommendationV1 + */ + 'type': AccountAllOfRecommendationV1TypeV1; + /** + * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. + * @type {string} + * @memberof AccountAllOfRecommendationV1 + */ + 'method': AccountAllOfRecommendationV1MethodV1; +} + +export const AccountAllOfRecommendationV1TypeV1 = { + Human: 'HUMAN', + Machine: 'MACHINE' +} as const; + +export type AccountAllOfRecommendationV1TypeV1 = typeof AccountAllOfRecommendationV1TypeV1[keyof typeof AccountAllOfRecommendationV1TypeV1]; +export const AccountAllOfRecommendationV1MethodV1 = { + Discovery: 'DISCOVERY', + Source: 'SOURCE', + Criteria: 'CRITERIA' +} as const; + +export type AccountAllOfRecommendationV1MethodV1 = typeof AccountAllOfRecommendationV1MethodV1[keyof typeof AccountAllOfRecommendationV1MethodV1]; + +/** + * The owner of the source this account belongs to. + * @export + * @interface AccountAllOfSourceOwnerV1 + */ +export interface AccountAllOfSourceOwnerV1 { + /** + * The ID of the identity + * @type {string} + * @memberof AccountAllOfSourceOwnerV1 + */ + 'id'?: string; + /** + * The type of object being referenced + * @type {string} + * @memberof AccountAllOfSourceOwnerV1 + */ + 'type'?: AccountAllOfSourceOwnerV1TypeV1; + /** + * display name of identity + * @type {string} + * @memberof AccountAllOfSourceOwnerV1 + */ + 'name'?: string; +} + +export const AccountAllOfSourceOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccountAllOfSourceOwnerV1TypeV1 = typeof AccountAllOfSourceOwnerV1TypeV1[keyof typeof AccountAllOfSourceOwnerV1TypeV1]; + +/** + * + * @export + * @interface AccountV1 + */ +export interface AccountV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof AccountV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof AccountV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof AccountV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof AccountV1 + */ + 'modified'?: string; + /** + * The unique ID of the source this account belongs to + * @type {string} + * @memberof AccountV1 + */ + 'sourceId': string; + /** + * The display name of the source this account belongs to + * @type {string} + * @memberof AccountV1 + */ + 'sourceName': string | null; + /** + * The unique ID of the identity this account is correlated to + * @type {string} + * @memberof AccountV1 + */ + 'identityId'?: string; + /** + * The lifecycle state of the identity this account is correlated to + * @type {string} + * @memberof AccountV1 + */ + 'cloudLifecycleState'?: string | null; + /** + * The identity state of the identity this account is correlated to + * @type {string} + * @memberof AccountV1 + */ + 'identityState'?: string | null; + /** + * The connection type of the source this account is from + * @type {string} + * @memberof AccountV1 + */ + 'connectionType'?: string | null; + /** + * Indicates if the account is of machine type + * @type {boolean} + * @memberof AccountV1 + */ + 'isMachine'?: boolean; + /** + * + * @type {AccountAllOfRecommendationV1} + * @memberof AccountV1 + */ + 'recommendation'?: AccountAllOfRecommendationV1; + /** + * The account attributes that are aggregated + * @type {{ [key: string]: any; }} + * @memberof AccountV1 + */ + 'attributes': { [key: string]: any; } | null; + /** + * Indicates if this account is from an authoritative source + * @type {boolean} + * @memberof AccountV1 + */ + 'authoritative': boolean; + /** + * A description of the account + * @type {string} + * @memberof AccountV1 + */ + 'description'?: string | null; + /** + * Indicates if the account is currently disabled + * @type {boolean} + * @memberof AccountV1 + */ + 'disabled': boolean; + /** + * Indicates if the account is currently locked + * @type {boolean} + * @memberof AccountV1 + */ + 'locked': boolean; + /** + * The unique ID of the account generated by the source system + * @type {string} + * @memberof AccountV1 + */ + 'nativeIdentity': string; + /** + * If true, this is a user account within IdentityNow. If false, this is an account from a source system. + * @type {boolean} + * @memberof AccountV1 + */ + 'systemAccount': boolean; + /** + * Indicates if this account is not correlated to an identity + * @type {boolean} + * @memberof AccountV1 + */ + 'uncorrelated': boolean; + /** + * The unique ID of the account as determined by the account schema + * @type {string} + * @memberof AccountV1 + */ + 'uuid'?: string | null; + /** + * Indicates if the account has been manually correlated to an identity + * @type {boolean} + * @memberof AccountV1 + */ + 'manuallyCorrelated': boolean; + /** + * Indicates if the account has entitlements + * @type {boolean} + * @memberof AccountV1 + */ + 'hasEntitlements': boolean; + /** + * + * @type {AccountAllOfIdentityV1} + * @memberof AccountV1 + */ + 'identity'?: AccountAllOfIdentityV1; + /** + * + * @type {AccountAllOfSourceOwnerV1} + * @memberof AccountV1 + */ + 'sourceOwner'?: AccountAllOfSourceOwnerV1 | null; + /** + * A string list containing the owning source\'s features + * @type {string} + * @memberof AccountV1 + */ + 'features'?: string | null; + /** + * The origin of the account either aggregated or provisioned + * @type {string} + * @memberof AccountV1 + */ + 'origin'?: AccountV1OriginV1 | null; + /** + * + * @type {AccountAllOfOwnerIdentityV1} + * @memberof AccountV1 + */ + 'ownerIdentity'?: AccountAllOfOwnerIdentityV1; +} + +export const AccountV1OriginV1 = { + Aggregated: 'AGGREGATED', + Provisioned: 'PROVISIONED' +} as const; + +export type AccountV1OriginV1 = typeof AccountV1OriginV1[keyof typeof AccountV1OriginV1]; + +/** + * + * @export + * @interface AccountattributesV1 + */ +export interface AccountattributesV1 { + /** + * The schema attribute values for the account + * @type {{ [key: string]: any; }} + * @memberof AccountattributesV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * The schema attribute values for the account + * @export + * @interface AccountattributescreateAttributesV1 + */ +export interface AccountattributescreateAttributesV1 { + [key: string]: string | any; + + /** + * Target source to create an account + * @type {string} + * @memberof AccountattributescreateAttributesV1 + */ + 'sourceId': string; +} +/** + * + * @export + * @interface AccountattributescreateV1 + */ +export interface AccountattributescreateV1 { + /** + * + * @type {AccountattributescreateAttributesV1} + * @memberof AccountattributescreateV1 + */ + 'attributes': AccountattributescreateAttributesV1; +} +/** + * Accounts async response containing details on started async process + * @export + * @interface AccountsasyncresultV1 + */ +export interface AccountsasyncresultV1 { + /** + * id of the task + * @type {string} + * @memberof AccountsasyncresultV1 + */ + 'id': string; +} +/** + * Request used for account enable/disable + * @export + * @interface AccounttogglerequestV1 + */ +export interface AccounttogglerequestV1 { + /** + * If set, an external process validates that the user wants to proceed with this request. + * @type {string} + * @memberof AccounttogglerequestV1 + */ + 'externalVerificationId'?: string; + /** + * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. + * @type {boolean} + * @memberof AccounttogglerequestV1 + */ + 'forceProvisioning'?: boolean; +} +/** + * Request used for account unlock + * @export + * @interface AccountunlockrequestV1 + */ +export interface AccountunlockrequestV1 { + /** + * If set, an external process validates that the user wants to proceed with this request. + * @type {string} + * @memberof AccountunlockrequestV1 + */ + 'externalVerificationId'?: string; + /** + * If set, the IDN account is unlocked after the workflow completes. + * @type {boolean} + * @memberof AccountunlockrequestV1 + */ + 'unlockIDNAccount'?: boolean; + /** + * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. + * @type {boolean} + * @memberof AccountunlockrequestV1 + */ + 'forceProvisioning'?: boolean; +} +/** + * Reference to an additional owner (identity or governance group). + * @export + * @interface AdditionalownerrefV1 + */ +export interface AdditionalownerrefV1 { + /** + * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'type'?: AdditionalownerrefV1TypeV1; + /** + * ID of the identity or governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'id'?: string; + /** + * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'name'?: string | null; +} + +export const AdditionalownerrefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type AdditionalownerrefV1TypeV1 = typeof AdditionalownerrefV1TypeV1[keyof typeof AdditionalownerrefV1TypeV1]; + +/** + * + * @export + * @interface BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * Bulk response object. + * @export + * @interface BulkidentitiesaccountsresponseV1 + */ +export interface BulkidentitiesaccountsresponseV1 { + /** + * Identifier of bulk request item. + * @type {string} + * @memberof BulkidentitiesaccountsresponseV1 + */ + 'id'?: string; + /** + * Response status value. + * @type {number} + * @memberof BulkidentitiesaccountsresponseV1 + */ + 'statusCode'?: number; + /** + * Status containing additional context information about failures. + * @type {string} + * @memberof BulkidentitiesaccountsresponseV1 + */ + 'message'?: string; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * Additional data to classify the entitlement + * @export + * @interface EntitlementAccessModelMetadataV1 + */ +export interface EntitlementAccessModelMetadataV1 { + /** + * + * @type {Array} + * @memberof EntitlementAccessModelMetadataV1 + */ + 'attributes'?: Array; +} +/** + * The identity that owns the entitlement + * @export + * @interface EntitlementOwnerV1 + */ +export interface EntitlementOwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'id'?: string; + /** + * The type of object + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'type'?: EntitlementOwnerV1TypeV1; + /** + * The display name of the identity + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'name'?: string; +} + +export const EntitlementOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type EntitlementOwnerV1TypeV1 = typeof EntitlementOwnerV1TypeV1[keyof typeof EntitlementOwnerV1TypeV1]; + +/** + * + * @export + * @interface EntitlementSourceV1 + */ +export interface EntitlementSourceV1 { + /** + * The source ID + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV1 + */ +export interface EntitlementV1 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV1 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV1 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'description'?: string | null; + /** + * True if the entitlement is privileged + * @type {boolean} + * @memberof EntitlementV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV1 + */ + 'requestable'?: boolean; + /** + * + * @type {EntitlementOwnerV1} + * @memberof EntitlementV1 + */ + 'owner'?: EntitlementOwnerV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof EntitlementV1 + */ + 'additionalOwners'?: Array | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {EntitlementAccessModelMetadataV1} + * @memberof EntitlementV1 + */ + 'accessModelMetadata'?: EntitlementAccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV1 + */ + 'modified'?: string; + /** + * + * @type {EntitlementSourceV1} + * @memberof EntitlementV1 + */ + 'source'?: EntitlementSourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV1 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV1 + */ + 'directPermissions'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface IdentitiesaccountsbulkrequestV1 + */ +export interface IdentitiesaccountsbulkrequestV1 { + /** + * The ids of the identities for which enable/disable accounts. + * @type {Array} + * @memberof IdentitiesaccountsbulkrequestV1 + */ + 'identityIds'?: Array; +} +/** + * + * @export + * @interface ListAccountsV1401ResponseV1 + */ +export interface ListAccountsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccountsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListAccountsV1429ResponseV1 + */ +export interface ListAccountsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListAccountsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} +/** + * + * @export + * @interface RecommendationV1 + */ +export interface RecommendationV1 { + /** + * Recommended type of account. + * @type {string} + * @memberof RecommendationV1 + */ + 'type': RecommendationV1TypeV1; + /** + * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. + * @type {string} + * @memberof RecommendationV1 + */ + 'method': RecommendationV1MethodV1; +} + +export const RecommendationV1TypeV1 = { + Human: 'HUMAN', + Machine: 'MACHINE' +} as const; + +export type RecommendationV1TypeV1 = typeof RecommendationV1TypeV1[keyof typeof RecommendationV1TypeV1]; +export const RecommendationV1MethodV1 = { + Discovery: 'DISCOVERY', + Source: 'SOURCE', + Criteria: 'CRITERIA' +} as const; + +export type RecommendationV1MethodV1 = typeof RecommendationV1MethodV1[keyof typeof RecommendationV1MethodV1]; + +/** + * Task result. + * @export + * @interface TaskresultdtoV1 + */ +export interface TaskresultdtoV1 { + /** + * Task result DTO type. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'type'?: TaskresultdtoV1TypeV1; + /** + * Task result ID. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'id'?: string; + /** + * Task result display name. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'name'?: string | null; +} + +export const TaskresultdtoV1TypeV1 = { + TaskResult: 'TASK_RESULT' +} as const; + +export type TaskresultdtoV1TypeV1 = typeof TaskresultdtoV1TypeV1[keyof typeof TaskresultdtoV1TypeV1]; + + +/** + * AccountsV1Api - axios parameter creator + * @export + */ +export const AccountsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + * @summary Create account + * @param {AccountattributescreateV1} accountattributescreateV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccountV1: async (accountattributescreateV1: AccountattributescreateV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountattributescreateV1' is not null or undefined + assertParamExists('createAccountV1', 'accountattributescreateV1', accountattributescreateV1) + const localVarPath = `/accounts/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(accountattributescreateV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove account + * @param {string} id The account id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountAsyncV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccountAsyncV1', 'id', id) + const localVarPath = `/accounts/v1/{id}/remove` + .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: 'POST', ...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, + }; + }, + /** + * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** + * @summary Delete account + * @param {string} id Account ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccountV1', 'id', id) + const localVarPath = `/accounts/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, + }; + }, + /** + * This API submits a task to disable IDN account for a single identity. + * @summary Disable idn account for identity + * @param {string} id The identity id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountForIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('disableAccountForIdentityV1', 'id', id) + const localVarPath = `/identities-accounts/v1/{id}/disable` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits a task to disable the account and returns the task ID. + * @summary Disable account + * @param {string} id The account id + * @param {AccounttogglerequestV1} accounttogglerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountV1: async (id: string, accounttogglerequestV1: AccounttogglerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('disableAccountV1', 'id', id) + // verify required parameter 'accounttogglerequestV1' is not null or undefined + assertParamExists('disableAccountV1', 'accounttogglerequestV1', accounttogglerequestV1) + const localVarPath = `/accounts/v1/{id}/disable` + .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: '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(accounttogglerequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits tasks to disable IDN account for each identity provided in the request body. + * @summary Disable idn accounts for identities + * @param {IdentitiesaccountsbulkrequestV1} identitiesaccountsbulkrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountsForIdentitiesV1: async (identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identitiesaccountsbulkrequestV1' is not null or undefined + assertParamExists('disableAccountsForIdentitiesV1', 'identitiesaccountsbulkrequestV1', identitiesaccountsbulkrequestV1) + const localVarPath = `/identities-accounts/v1/disable`; + // 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(identitiesaccountsbulkrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits a task to enable IDN account for a single identity. + * @summary Enable idn account for identity + * @param {string} id The identity id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountForIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('enableAccountForIdentityV1', 'id', id) + const localVarPath = `/identities-accounts/v1/{id}/enable` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits a task to enable account and returns the task ID. + * @summary Enable account + * @param {string} id The account id + * @param {AccounttogglerequestV1} accounttogglerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountV1: async (id: string, accounttogglerequestV1: AccounttogglerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('enableAccountV1', 'id', id) + // verify required parameter 'accounttogglerequestV1' is not null or undefined + assertParamExists('enableAccountV1', 'accounttogglerequestV1', accounttogglerequestV1) + const localVarPath = `/accounts/v1/{id}/enable` + .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: '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(accounttogglerequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits tasks to enable IDN account for each identity provided in the request body. + * @summary Enable idn accounts for identities + * @param {IdentitiesaccountsbulkrequestV1} identitiesaccountsbulkrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountsForIdentitiesV1: async (identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identitiesaccountsbulkrequestV1' is not null or undefined + assertParamExists('enableAccountsForIdentitiesV1', 'identitiesaccountsbulkrequestV1', identitiesaccountsbulkrequestV1) + const localVarPath = `/identities-accounts/v1/enable`; + // 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(identitiesaccountsbulkrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns entitlements of the account. + * @summary Account entitlements + * @param {string} id The account id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountEntitlementsV1: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccountEntitlementsV1', 'id', id) + const localVarPath = `/accounts/v1/{id}/entitlements` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to return the details for a single account by its ID. + * @summary Account details + * @param {string} id Account ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccountV1', 'id', id) + const localVarPath = `/accounts/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 accounts. + * @summary Accounts list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {ListAccountsV1DetailLevelV1} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* + * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccountsV1: async (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsV1DetailLevelV1, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/accounts/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (detailLevel !== undefined) { + localVarQueryParameter['detailLevel'] = detailLevel; + } + + 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, + }; + }, + /** + * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + * @summary Update account + * @param {string} id Account ID. + * @param {AccountattributesV1} accountattributesV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putAccountV1: async (id: string, accountattributesV1: AccountattributesV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putAccountV1', 'id', id) + // verify required parameter 'accountattributesV1' is not null or undefined + assertParamExists('putAccountV1', 'accountattributesV1', accountattributesV1) + const localVarPath = `/accounts/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: 'PUT', ...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(accountattributesV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + * @summary Reload account + * @param {string} id The account id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitReloadAccountV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('submitReloadAccountV1', 'id', id) + const localVarPath = `/accounts/v1/{id}/reload` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + * @summary Unlock account + * @param {string} id The account ID. + * @param {AccountunlockrequestV1} accountunlockrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unlockAccountV1: async (id: string, accountunlockrequestV1: AccountunlockrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('unlockAccountV1', 'id', id) + // verify required parameter 'accountunlockrequestV1' is not null or undefined + assertParamExists('unlockAccountV1', 'accountunlockrequestV1', accountunlockrequestV1) + const localVarPath = `/accounts/v1/{id}/unlock` + .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: '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(accountunlockrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. + * @summary Update account + * @param {string} id Account ID. + * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccountV1: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateAccountV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('updateAccountV1', 'requestBody', requestBody) + const localVarPath = `/accounts/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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AccountsV1Api - functional programming interface + * @export + */ +export const AccountsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AccountsV1ApiAxiosParamCreator(configuration) + return { + /** + * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + * @summary Create account + * @param {AccountattributescreateV1} accountattributescreateV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccountV1(accountattributescreateV1: AccountattributescreateV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccountV1(accountattributescreateV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.createAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove account + * @param {string} id The account id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccountAsyncV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountAsyncV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.deleteAccountAsyncV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** + * @summary Delete account + * @param {string} id Account ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccountV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.deleteAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task to disable IDN account for a single identity. + * @summary Disable idn account for identity + * @param {string} id The identity id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async disableAccountForIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountForIdentityV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.disableAccountForIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task to disable the account and returns the task ID. + * @summary Disable account + * @param {string} id The account id + * @param {AccounttogglerequestV1} accounttogglerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async disableAccountV1(id: string, accounttogglerequestV1: AccounttogglerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountV1(id, accounttogglerequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.disableAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits tasks to disable IDN account for each identity provided in the request body. + * @summary Disable idn accounts for identities + * @param {IdentitiesaccountsbulkrequestV1} identitiesaccountsbulkrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async disableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.disableAccountsForIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task to enable IDN account for a single identity. + * @summary Enable idn account for identity + * @param {string} id The identity id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async enableAccountForIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountForIdentityV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.enableAccountForIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task to enable account and returns the task ID. + * @summary Enable account + * @param {string} id The account id + * @param {AccounttogglerequestV1} accounttogglerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async enableAccountV1(id: string, accounttogglerequestV1: AccounttogglerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountV1(id, accounttogglerequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.enableAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits tasks to enable IDN account for each identity provided in the request body. + * @summary Enable idn accounts for identities + * @param {IdentitiesaccountsbulkrequestV1} identitiesaccountsbulkrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async enableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.enableAccountsForIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns entitlements of the account. + * @summary Account entitlements + * @param {string} id The account id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountEntitlementsV1(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlementsV1(id, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.getAccountEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return the details for a single account by its ID. + * @summary Account details + * @param {string} id Account ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.getAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List accounts. + * @summary Accounts list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {ListAccountsV1DetailLevelV1} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* + * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccountsV1(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsV1DetailLevelV1, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountsV1(limit, offset, count, detailLevel, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.listAccountsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + * @summary Update account + * @param {string} id Account ID. + * @param {AccountattributesV1} accountattributesV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putAccountV1(id: string, accountattributesV1: AccountattributesV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putAccountV1(id, accountattributesV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.putAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + * @summary Reload account + * @param {string} id The account id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitReloadAccountV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccountV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.submitReloadAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + * @summary Unlock account + * @param {string} id The account ID. + * @param {AccountunlockrequestV1} accountunlockrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async unlockAccountV1(id: string, accountunlockrequestV1: AccountunlockrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccountV1(id, accountunlockrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.unlockAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. + * @summary Update account + * @param {string} id Account ID. + * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAccountV1(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccountV1(id, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AccountsV1Api.updateAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AccountsV1Api - factory interface + * @export + */ +export const AccountsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AccountsV1ApiFp(configuration) + return { + /** + * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + * @summary Create account + * @param {AccountsV1ApiCreateAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccountV1(requestParameters: AccountsV1ApiCreateAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccountV1(requestParameters.accountattributescreateV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove account + * @param {AccountsV1ApiDeleteAccountAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountAsyncV1(requestParameters: AccountsV1ApiDeleteAccountAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccountAsyncV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** + * @summary Delete account + * @param {AccountsV1ApiDeleteAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountV1(requestParameters: AccountsV1ApiDeleteAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccountV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task to disable IDN account for a single identity. + * @summary Disable idn account for identity + * @param {AccountsV1ApiDisableAccountForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountForIdentityV1(requestParameters: AccountsV1ApiDisableAccountForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.disableAccountForIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task to disable the account and returns the task ID. + * @summary Disable account + * @param {AccountsV1ApiDisableAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountV1(requestParameters: AccountsV1ApiDisableAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.disableAccountV1(requestParameters.id, requestParameters.accounttogglerequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits tasks to disable IDN account for each identity provided in the request body. + * @summary Disable idn accounts for identities + * @param {AccountsV1ApiDisableAccountsForIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + disableAccountsForIdentitiesV1(requestParameters: AccountsV1ApiDisableAccountsForIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.disableAccountsForIdentitiesV1(requestParameters.identitiesaccountsbulkrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task to enable IDN account for a single identity. + * @summary Enable idn account for identity + * @param {AccountsV1ApiEnableAccountForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountForIdentityV1(requestParameters: AccountsV1ApiEnableAccountForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.enableAccountForIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task to enable account and returns the task ID. + * @summary Enable account + * @param {AccountsV1ApiEnableAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountV1(requestParameters: AccountsV1ApiEnableAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.enableAccountV1(requestParameters.id, requestParameters.accounttogglerequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits tasks to enable IDN account for each identity provided in the request body. + * @summary Enable idn accounts for identities + * @param {AccountsV1ApiEnableAccountsForIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + enableAccountsForIdentitiesV1(requestParameters: AccountsV1ApiEnableAccountsForIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.enableAccountsForIdentitiesV1(requestParameters.identitiesaccountsbulkrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns entitlements of the account. + * @summary Account entitlements + * @param {AccountsV1ApiGetAccountEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountEntitlementsV1(requestParameters: AccountsV1ApiGetAccountEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccountEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return the details for a single account by its ID. + * @summary Account details + * @param {AccountsV1ApiGetAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountV1(requestParameters: AccountsV1ApiGetAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccountV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List accounts. + * @summary Accounts list + * @param {AccountsV1ApiListAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccountsV1(requestParameters: AccountsV1ApiListAccountsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + * @summary Update account + * @param {AccountsV1ApiPutAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putAccountV1(requestParameters: AccountsV1ApiPutAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putAccountV1(requestParameters.id, requestParameters.accountattributesV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + * @summary Reload account + * @param {AccountsV1ApiSubmitReloadAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitReloadAccountV1(requestParameters: AccountsV1ApiSubmitReloadAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitReloadAccountV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + * @summary Unlock account + * @param {AccountsV1ApiUnlockAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unlockAccountV1(requestParameters: AccountsV1ApiUnlockAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unlockAccountV1(requestParameters.id, requestParameters.accountunlockrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. + * @summary Update account + * @param {AccountsV1ApiUpdateAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccountV1(requestParameters: AccountsV1ApiUpdateAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccountV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiCreateAccountV1Request + */ +export interface AccountsV1ApiCreateAccountV1Request { + /** + * + * @type {AccountattributescreateV1} + * @memberof AccountsV1ApiCreateAccountV1 + */ + readonly accountattributescreateV1: AccountattributescreateV1 +} + +/** + * Request parameters for deleteAccountAsyncV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiDeleteAccountAsyncV1Request + */ +export interface AccountsV1ApiDeleteAccountAsyncV1Request { + /** + * The account id + * @type {string} + * @memberof AccountsV1ApiDeleteAccountAsyncV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiDeleteAccountV1Request + */ +export interface AccountsV1ApiDeleteAccountV1Request { + /** + * Account ID. + * @type {string} + * @memberof AccountsV1ApiDeleteAccountV1 + */ + readonly id: string +} + +/** + * Request parameters for disableAccountForIdentityV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiDisableAccountForIdentityV1Request + */ +export interface AccountsV1ApiDisableAccountForIdentityV1Request { + /** + * The identity id. + * @type {string} + * @memberof AccountsV1ApiDisableAccountForIdentityV1 + */ + readonly id: string +} + +/** + * Request parameters for disableAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiDisableAccountV1Request + */ +export interface AccountsV1ApiDisableAccountV1Request { + /** + * The account id + * @type {string} + * @memberof AccountsV1ApiDisableAccountV1 + */ + readonly id: string + + /** + * + * @type {AccounttogglerequestV1} + * @memberof AccountsV1ApiDisableAccountV1 + */ + readonly accounttogglerequestV1: AccounttogglerequestV1 +} + +/** + * Request parameters for disableAccountsForIdentitiesV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiDisableAccountsForIdentitiesV1Request + */ +export interface AccountsV1ApiDisableAccountsForIdentitiesV1Request { + /** + * + * @type {IdentitiesaccountsbulkrequestV1} + * @memberof AccountsV1ApiDisableAccountsForIdentitiesV1 + */ + readonly identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 +} + +/** + * Request parameters for enableAccountForIdentityV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiEnableAccountForIdentityV1Request + */ +export interface AccountsV1ApiEnableAccountForIdentityV1Request { + /** + * The identity id. + * @type {string} + * @memberof AccountsV1ApiEnableAccountForIdentityV1 + */ + readonly id: string +} + +/** + * Request parameters for enableAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiEnableAccountV1Request + */ +export interface AccountsV1ApiEnableAccountV1Request { + /** + * The account id + * @type {string} + * @memberof AccountsV1ApiEnableAccountV1 + */ + readonly id: string + + /** + * + * @type {AccounttogglerequestV1} + * @memberof AccountsV1ApiEnableAccountV1 + */ + readonly accounttogglerequestV1: AccounttogglerequestV1 +} + +/** + * Request parameters for enableAccountsForIdentitiesV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiEnableAccountsForIdentitiesV1Request + */ +export interface AccountsV1ApiEnableAccountsForIdentitiesV1Request { + /** + * + * @type {IdentitiesaccountsbulkrequestV1} + * @memberof AccountsV1ApiEnableAccountsForIdentitiesV1 + */ + readonly identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 +} + +/** + * Request parameters for getAccountEntitlementsV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiGetAccountEntitlementsV1Request + */ +export interface AccountsV1ApiGetAccountEntitlementsV1Request { + /** + * The account id + * @type {string} + * @memberof AccountsV1ApiGetAccountEntitlementsV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountsV1ApiGetAccountEntitlementsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountsV1ApiGetAccountEntitlementsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccountsV1ApiGetAccountEntitlementsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiGetAccountV1Request + */ +export interface AccountsV1ApiGetAccountV1Request { + /** + * Account ID. + * @type {string} + * @memberof AccountsV1ApiGetAccountV1 + */ + readonly id: string +} + +/** + * Request parameters for listAccountsV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiListAccountsV1Request + */ +export interface AccountsV1ApiListAccountsV1Request { + /** + * 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 AccountsV1ApiListAccountsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AccountsV1ApiListAccountsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof AccountsV1ApiListAccountsV1 + */ + readonly count?: boolean + + /** + * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + * @type {'SLIM' | 'FULL'} + * @memberof AccountsV1ApiListAccountsV1 + */ + readonly detailLevel?: ListAccountsV1DetailLevelV1 + + /** + * 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* + * @type {string} + * @memberof AccountsV1ApiListAccountsV1 + */ + 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + * @type {string} + * @memberof AccountsV1ApiListAccountsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for putAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiPutAccountV1Request + */ +export interface AccountsV1ApiPutAccountV1Request { + /** + * Account ID. + * @type {string} + * @memberof AccountsV1ApiPutAccountV1 + */ + readonly id: string + + /** + * + * @type {AccountattributesV1} + * @memberof AccountsV1ApiPutAccountV1 + */ + readonly accountattributesV1: AccountattributesV1 +} + +/** + * Request parameters for submitReloadAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiSubmitReloadAccountV1Request + */ +export interface AccountsV1ApiSubmitReloadAccountV1Request { + /** + * The account id + * @type {string} + * @memberof AccountsV1ApiSubmitReloadAccountV1 + */ + readonly id: string +} + +/** + * Request parameters for unlockAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiUnlockAccountV1Request + */ +export interface AccountsV1ApiUnlockAccountV1Request { + /** + * The account ID. + * @type {string} + * @memberof AccountsV1ApiUnlockAccountV1 + */ + readonly id: string + + /** + * + * @type {AccountunlockrequestV1} + * @memberof AccountsV1ApiUnlockAccountV1 + */ + readonly accountunlockrequestV1: AccountunlockrequestV1 +} + +/** + * Request parameters for updateAccountV1 operation in AccountsV1Api. + * @export + * @interface AccountsV1ApiUpdateAccountV1Request + */ +export interface AccountsV1ApiUpdateAccountV1Request { + /** + * Account ID. + * @type {string} + * @memberof AccountsV1ApiUpdateAccountV1 + */ + readonly id: string + + /** + * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof AccountsV1ApiUpdateAccountV1 + */ + readonly requestBody: Array +} + +/** + * AccountsV1Api - object-oriented interface + * @export + * @class AccountsV1Api + * @extends {BaseAPI} + */ +export class AccountsV1Api extends BaseAPI { + /** + * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + * @summary Create account + * @param {AccountsV1ApiCreateAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public createAccountV1(requestParameters: AccountsV1ApiCreateAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).createAccountV1(requestParameters.accountattributescreateV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove account + * @param {AccountsV1ApiDeleteAccountAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public deleteAccountAsyncV1(requestParameters: AccountsV1ApiDeleteAccountAsyncV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).deleteAccountAsyncV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** + * @summary Delete account + * @param {AccountsV1ApiDeleteAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public deleteAccountV1(requestParameters: AccountsV1ApiDeleteAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).deleteAccountV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task to disable IDN account for a single identity. + * @summary Disable idn account for identity + * @param {AccountsV1ApiDisableAccountForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public disableAccountForIdentityV1(requestParameters: AccountsV1ApiDisableAccountForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).disableAccountForIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task to disable the account and returns the task ID. + * @summary Disable account + * @param {AccountsV1ApiDisableAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public disableAccountV1(requestParameters: AccountsV1ApiDisableAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).disableAccountV1(requestParameters.id, requestParameters.accounttogglerequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits tasks to disable IDN account for each identity provided in the request body. + * @summary Disable idn accounts for identities + * @param {AccountsV1ApiDisableAccountsForIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public disableAccountsForIdentitiesV1(requestParameters: AccountsV1ApiDisableAccountsForIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).disableAccountsForIdentitiesV1(requestParameters.identitiesaccountsbulkrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task to enable IDN account for a single identity. + * @summary Enable idn account for identity + * @param {AccountsV1ApiEnableAccountForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public enableAccountForIdentityV1(requestParameters: AccountsV1ApiEnableAccountForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).enableAccountForIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task to enable account and returns the task ID. + * @summary Enable account + * @param {AccountsV1ApiEnableAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public enableAccountV1(requestParameters: AccountsV1ApiEnableAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).enableAccountV1(requestParameters.id, requestParameters.accounttogglerequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits tasks to enable IDN account for each identity provided in the request body. + * @summary Enable idn accounts for identities + * @param {AccountsV1ApiEnableAccountsForIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public enableAccountsForIdentitiesV1(requestParameters: AccountsV1ApiEnableAccountsForIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).enableAccountsForIdentitiesV1(requestParameters.identitiesaccountsbulkrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns entitlements of the account. + * @summary Account entitlements + * @param {AccountsV1ApiGetAccountEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public getAccountEntitlementsV1(requestParameters: AccountsV1ApiGetAccountEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).getAccountEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return the details for a single account by its ID. + * @summary Account details + * @param {AccountsV1ApiGetAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public getAccountV1(requestParameters: AccountsV1ApiGetAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).getAccountV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List accounts. + * @summary Accounts list + * @param {AccountsV1ApiListAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public listAccountsV1(requestParameters: AccountsV1ApiListAccountsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).listAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + * @summary Update account + * @param {AccountsV1ApiPutAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public putAccountV1(requestParameters: AccountsV1ApiPutAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).putAccountV1(requestParameters.id, requestParameters.accountattributesV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + * @summary Reload account + * @param {AccountsV1ApiSubmitReloadAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public submitReloadAccountV1(requestParameters: AccountsV1ApiSubmitReloadAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).submitReloadAccountV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + * @summary Unlock account + * @param {AccountsV1ApiUnlockAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public unlockAccountV1(requestParameters: AccountsV1ApiUnlockAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).unlockAccountV1(requestParameters.id, requestParameters.accountunlockrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. + * @summary Update account + * @param {AccountsV1ApiUpdateAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AccountsV1Api + */ + public updateAccountV1(requestParameters: AccountsV1ApiUpdateAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AccountsV1ApiFp(this.configuration).updateAccountV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ListAccountsV1DetailLevelV1 = { + Slim: 'SLIM', + Full: 'FULL' +} as const; +export type ListAccountsV1DetailLevelV1 = typeof ListAccountsV1DetailLevelV1[keyof typeof ListAccountsV1DetailLevelV1]; + + diff --git a/sdk-output/accounts/base.ts b/sdk-output/accounts/base.ts new file mode 100644 index 00000000..a25dc790 --- /dev/null +++ b/sdk-output/accounts/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Accounts + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/accounts/common.ts b/sdk-output/accounts/common.ts new file mode 100644 index 00000000..52667cab --- /dev/null +++ b/sdk-output/accounts/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Accounts + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/accounts/configuration.ts b/sdk-output/accounts/configuration.ts new file mode 100644 index 00000000..e330f750 --- /dev/null +++ b/sdk-output/accounts/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Accounts + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/accounts/git_push.sh b/sdk-output/accounts/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/accounts/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/accounts/index.ts b/sdk-output/accounts/index.ts new file mode 100644 index 00000000..6eea53f8 --- /dev/null +++ b/sdk-output/accounts/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Accounts + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/accounts/package.json b/sdk-output/accounts/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/accounts/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/accounts/tsconfig.json b/sdk-output/accounts/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/accounts/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/api_usage/.gitignore b/sdk-output/api_usage/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/api_usage/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/api_usage/.npmignore b/sdk-output/api_usage/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/api_usage/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/api_usage/.openapi-generator-ignore b/sdk-output/api_usage/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/api_usage/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/api_usage/.openapi-generator/FILES b/sdk-output/api_usage/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/api_usage/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/api_usage/.openapi-generator/VERSION b/sdk-output/api_usage/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/api_usage/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/api_usage/.sdk-partition b/sdk-output/api_usage/.sdk-partition new file mode 100644 index 00000000..1914f223 --- /dev/null +++ b/sdk-output/api_usage/.sdk-partition @@ -0,0 +1 @@ +api-usage \ No newline at end of file diff --git a/sdk-output/api_usage/README.md b/sdk-output/api_usage/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/api_usage/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/api_usage/api.ts b/sdk-output/api_usage/api.ts new file mode 100644 index 00000000..c74ee96a --- /dev/null +++ b/sdk-output/api_usage/api.ts @@ -0,0 +1,408 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Api Usage + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTotalCountV1401ResponseV1 + */ +export interface GetTotalCountV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTotalCountV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTotalCountV1429ResponseV1 + */ +export interface GetTotalCountV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTotalCountV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SummaryresponseV1 + */ +export interface SummaryresponseV1 { + /** + * The endpoint of a SailPoint API + * @type {string} + * @memberof SummaryresponseV1 + */ + 'RequestedUri'?: string; + /** + * Number of calls made to a specific SailPoint API + * @type {number} + * @memberof SummaryresponseV1 + */ + 'NumberOfCalls'?: number; +} + +/** + * ApiUsageV1Api - axios parameter creator + * @export + */ +export const ApiUsageV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Total number of API requests + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTotalCountV1: async (xSailPointExperimental?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/api-usage/v1/count`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Get Api Summary + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listApiSummaryV1: async (xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/api-usage/v1/summary`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ApiUsageV1Api - functional programming interface + * @export + */ +export const ApiUsageV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ApiUsageV1ApiAxiosParamCreator(configuration) + return { + /** + * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Total number of API requests + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTotalCountV1(xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTotalCountV1(xSailPointExperimental, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApiUsageV1Api.getTotalCountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Get Api Summary + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listApiSummaryV1(xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listApiSummaryV1(xSailPointExperimental, filters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApiUsageV1Api.listApiSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ApiUsageV1Api - factory interface + * @export + */ +export const ApiUsageV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ApiUsageV1ApiFp(configuration) + return { + /** + * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Total number of API requests + * @param {ApiUsageV1ApiGetTotalCountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTotalCountV1(requestParameters: ApiUsageV1ApiGetTotalCountV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTotalCountV1(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Get Api Summary + * @param {ApiUsageV1ApiListApiSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listApiSummaryV1(requestParameters: ApiUsageV1ApiListApiSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listApiSummaryV1(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getTotalCountV1 operation in ApiUsageV1Api. + * @export + * @interface ApiUsageV1ApiGetTotalCountV1Request + */ +export interface ApiUsageV1ApiGetTotalCountV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof ApiUsageV1ApiGetTotalCountV1 + */ + readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @type {string} + * @memberof ApiUsageV1ApiGetTotalCountV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listApiSummaryV1 operation in ApiUsageV1Api. + * @export + * @interface ApiUsageV1ApiListApiSummaryV1Request + */ +export interface ApiUsageV1ApiListApiSummaryV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof ApiUsageV1ApiListApiSummaryV1 + */ + readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* + * @type {string} + * @memberof ApiUsageV1ApiListApiSummaryV1 + */ + readonly filters?: string + + /** + * Max number of results to return. + * @type {number} + * @memberof ApiUsageV1ApiListApiSummaryV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + * @type {number} + * @memberof ApiUsageV1ApiListApiSummaryV1 + */ + readonly offset?: number +} + +/** + * ApiUsageV1Api - object-oriented interface + * @export + * @class ApiUsageV1Api + * @extends {BaseAPI} + */ +export class ApiUsageV1Api extends BaseAPI { + /** + * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Total number of API requests + * @param {ApiUsageV1ApiGetTotalCountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApiUsageV1Api + */ + public getTotalCountV1(requestParameters: ApiUsageV1ApiGetTotalCountV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ApiUsageV1ApiFp(this.configuration).getTotalCountV1(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. + * @summary Get Api Summary + * @param {ApiUsageV1ApiListApiSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApiUsageV1Api + */ + public listApiSummaryV1(requestParameters: ApiUsageV1ApiListApiSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ApiUsageV1ApiFp(this.configuration).listApiSummaryV1(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/api_usage/base.ts b/sdk-output/api_usage/base.ts new file mode 100644 index 00000000..1ec8405f --- /dev/null +++ b/sdk-output/api_usage/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Api Usage + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/api_usage/common.ts b/sdk-output/api_usage/common.ts new file mode 100644 index 00000000..ea92f973 --- /dev/null +++ b/sdk-output/api_usage/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Api Usage + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/api_usage/configuration.ts b/sdk-output/api_usage/configuration.ts new file mode 100644 index 00000000..67d1d955 --- /dev/null +++ b/sdk-output/api_usage/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Api Usage + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/api_usage/git_push.sh b/sdk-output/api_usage/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/api_usage/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/api_usage/index.ts b/sdk-output/api_usage/index.ts new file mode 100644 index 00000000..73f3d954 --- /dev/null +++ b/sdk-output/api_usage/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Api Usage + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/api_usage/package.json b/sdk-output/api_usage/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/api_usage/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/api_usage/tsconfig.json b/sdk-output/api_usage/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/api_usage/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/application_discovery/.gitignore b/sdk-output/application_discovery/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/application_discovery/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/application_discovery/.npmignore b/sdk-output/application_discovery/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/application_discovery/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/application_discovery/.openapi-generator-ignore b/sdk-output/application_discovery/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/application_discovery/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/application_discovery/.openapi-generator/FILES b/sdk-output/application_discovery/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/application_discovery/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/application_discovery/.openapi-generator/VERSION b/sdk-output/application_discovery/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/application_discovery/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/application_discovery/.sdk-partition b/sdk-output/application_discovery/.sdk-partition new file mode 100644 index 00000000..4e4f213c --- /dev/null +++ b/sdk-output/application_discovery/.sdk-partition @@ -0,0 +1 @@ +application-discovery \ No newline at end of file diff --git a/sdk-output/application_discovery/README.md b/sdk-output/application_discovery/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/application_discovery/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/application_discovery/api.ts b/sdk-output/application_discovery/api.ts new file mode 100644 index 00000000..2e6f9299 --- /dev/null +++ b/sdk-output/application_discovery/api.ts @@ -0,0 +1,1408 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Application Discovery + * 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 ApplicationdiscoveryrequestV1 + */ +export interface ApplicationdiscoveryrequestV1 { + /** + * List of dataset Ids to discover applications + * @type {Array} + * @memberof ApplicationdiscoveryrequestV1 + */ + 'datasetIds': Array; +} +/** + * The target(source) of app discovery + * @export + * @interface ApplicationdiscoveryresponseTargetV1 + */ +export interface ApplicationdiscoveryresponseTargetV1 { + /** + * + * @type {DtotypeV1} + * @memberof ApplicationdiscoveryresponseTargetV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof ApplicationdiscoveryresponseTargetV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof ApplicationdiscoveryresponseTargetV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface ApplicationdiscoveryresponseV1 + */ +export interface ApplicationdiscoveryresponseV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'id'?: string; + /** + * Type of task for app discovery + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'type'?: ApplicationdiscoveryresponseV1TypeV1; + /** + * Name of the task for app discovery + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'uniqueName'?: string; + /** + * Description of the app discovery aggregation + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'description'?: string; + /** + * Name of the parent of the task for app discovery + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'parentName'?: string | null; + /** + * Service to execute app discovery + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'launcher'?: string; + /** + * + * @type {ApplicationdiscoveryresponseTargetV1} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'target'?: ApplicationdiscoveryresponseTargetV1; + /** + * Creation date of app discovery task + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'created'?: string; + /** + * Last modification date of app discovery task + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'modified'?: string; + /** + * Launch date of app discovery task + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'launched'?: string | null; + /** + * Completion date of app discovery task + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'completed'?: string | null; + /** + * + * @type {TaskdefinitionsummaryV1} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'taskDefinitionSummary'?: TaskdefinitionsummaryV1; + /** + * Completion status of app discovery task + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'completionStatus'?: ApplicationdiscoveryresponseV1CompletionStatusV1 | null; + /** + * Messages associated with the app discovery task + * @type {Array} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'messages'?: Array; + /** + * Return values associated with the app discovery task + * @type {Array} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'returns'?: Array; + /** + * Attributes of the app discovery task + * @type {{ [key: string]: any; }} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Current progress of aggregation + * @type {string} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'progress'?: string | null; + /** + * Current percentage completion of app discovery task + * @type {number} + * @memberof ApplicationdiscoveryresponseV1 + */ + 'percentComplete'?: number; +} + +export const ApplicationdiscoveryresponseV1TypeV1 = { + Quartz: 'QUARTZ', + Qpoc: 'QPOC', + QueuedTask: 'QUEUED_TASK' +} as const; + +export type ApplicationdiscoveryresponseV1TypeV1 = typeof ApplicationdiscoveryresponseV1TypeV1[keyof typeof ApplicationdiscoveryresponseV1TypeV1]; +export const ApplicationdiscoveryresponseV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + Temperror: 'TEMPERROR' +} as const; + +export type ApplicationdiscoveryresponseV1CompletionStatusV1 = typeof ApplicationdiscoveryresponseV1CompletionStatusV1[keyof typeof ApplicationdiscoveryresponseV1CompletionStatusV1]; + +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * Discovered applications with their respective associated sources + * @export + * @interface FulldiscoveredapplicationsV1 + */ +export interface FulldiscoveredapplicationsV1 { + /** + * Unique identifier for the discovered application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'id'?: string; + /** + * Name of the discovered application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'name'?: string; + /** + * Source from which the application was discovered. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'discoverySource'?: string; + /** + * The vendor associated with the discovered application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'discoveredVendor'?: string; + /** + * A brief description of the discovered application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'description'?: string; + /** + * List of recommended connectors for the application. + * @type {Array} + * @memberof FulldiscoveredapplicationsV1 + */ + 'recommendedConnectors'?: Array; + /** + * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'discoveredAt'?: string; + /** + * The timestamp when the application was first discovered, in ISO 8601 format. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'createdAt'?: string; + /** + * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'status'?: string; + /** + * List of associated sources related to this discovered application. + * @type {Array} + * @memberof FulldiscoveredapplicationsV1 + */ + 'associatedSources'?: Array; + /** + * The operational status of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'operationalStatus'?: string; + /** + * The category of the discovery source. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'discoverySourceCategory'?: string; + /** + * The number of licenses associated with the application. + * @type {number} + * @memberof FulldiscoveredapplicationsV1 + */ + 'licenseCount'?: number; + /** + * Indicates whether the application is sanctioned. + * @type {boolean} + * @memberof FulldiscoveredapplicationsV1 + */ + 'isSanctioned'?: boolean; + /** + * URL of the application\'s logo. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'logo'?: string; + /** + * The URL of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'appUrl'?: string; + /** + * List of groups associated with the application. + * @type {Array} + * @memberof FulldiscoveredapplicationsV1 + */ + 'groups'?: Array; + /** + * The count of users associated with the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'usersCount'?: string; + /** + * The owners of the application. + * @type {Array} + * @memberof FulldiscoveredapplicationsV1 + */ + 'applicationOwner'?: Array; + /** + * The IT owners of the application. + * @type {Array} + * @memberof FulldiscoveredapplicationsV1 + */ + 'itApplicationOwner'?: Array; + /** + * The business criticality level of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'businessCriticality'?: string; + /** + * The data classification level of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'dataClassification'?: string; + /** + * The business unit associated with the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'businessUnit'?: string; + /** + * The installation type of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'installType'?: string; + /** + * The environment in which the application operates. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'environment'?: string; + /** + * The risk score of the application ranging from 0-100, 100 being highest risk. + * @type {number} + * @memberof FulldiscoveredapplicationsV1 + */ + 'riskScore'?: number; + /** + * Indicates whether the application is used for business purposes. + * @type {boolean} + * @memberof FulldiscoveredapplicationsV1 + */ + 'isBusiness'?: boolean; + /** + * The total number of sign-in accounts for the application. + * @type {number} + * @memberof FulldiscoveredapplicationsV1 + */ + 'totalSigninsCount'?: number; + /** + * The risk level of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'riskLevel'?: FulldiscoveredapplicationsV1RiskLevelV1; + /** + * Indicates whether the application has privileged access. + * @type {boolean} + * @memberof FulldiscoveredapplicationsV1 + */ + 'isPrivileged'?: boolean; + /** + * The warranty expiration date of the application. + * @type {string} + * @memberof FulldiscoveredapplicationsV1 + */ + 'warrantyExpiration'?: string; + /** + * Additional attributes of the application useful for visibility of governance posture. + * @type {object} + * @memberof FulldiscoveredapplicationsV1 + */ + 'attributes'?: object; +} + +export const FulldiscoveredapplicationsV1RiskLevelV1 = { + High: 'High', + Medium: 'Medium', + Low: 'Low' +} as const; + +export type FulldiscoveredapplicationsV1RiskLevelV1 = typeof FulldiscoveredapplicationsV1RiskLevelV1[keyof typeof FulldiscoveredapplicationsV1RiskLevelV1]; + +/** + * @type GetDiscoveredApplicationsV1200ResponseInnerV1 + * @export + */ +export type GetDiscoveredApplicationsV1200ResponseInnerV1 = FulldiscoveredapplicationsV1 | SlimdiscoveredapplicationsV1; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Localized error message to indicate a failed invocation or error if any. + * @export + * @interface LocalizedmessageV1 + */ +export interface LocalizedmessageV1 { + /** + * Message locale + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'locale': string; + /** + * Message text + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'message': string; +} +/** + * + * @export + * @interface ManualdiscoverapplicationsV1 + */ +export interface ManualdiscoverapplicationsV1 { + /** + * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + * @type {File} + * @memberof ManualdiscoverapplicationsV1 + */ + 'file': File; +} +/** + * + * @export + * @interface ManualdiscoverapplicationstemplateV1 + */ +export interface ManualdiscoverapplicationstemplateV1 { + /** + * Name of the application. + * @type {string} + * @memberof ManualdiscoverapplicationstemplateV1 + */ + 'application_name'?: string; + /** + * Description of the application. + * @type {string} + * @memberof ManualdiscoverapplicationstemplateV1 + */ + 'description'?: string; +} +/** + * Discovered applications + * @export + * @interface SlimdiscoveredapplicationsV1 + */ +export interface SlimdiscoveredapplicationsV1 { + /** + * Unique identifier for the discovered application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'id'?: string; + /** + * Name of the discovered application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'name'?: string; + /** + * Source from which the application was discovered. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'discoverySource'?: string; + /** + * The vendor associated with the discovered application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'discoveredVendor'?: string; + /** + * A brief description of the discovered application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'description'?: string; + /** + * List of recommended connectors for the application. + * @type {Array} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'recommendedConnectors'?: Array; + /** + * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'discoveredAt'?: string; + /** + * The timestamp when the application was first discovered, in ISO 8601 format. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'createdAt'?: string; + /** + * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'status'?: string; + /** + * The operational status of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'operationalStatus'?: string; + /** + * The category of the discovery source. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'discoverySourceCategory'?: string; + /** + * The number of licenses associated with the application. + * @type {number} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'licenseCount'?: number; + /** + * Indicates whether the application is sanctioned. + * @type {boolean} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'isSanctioned'?: boolean; + /** + * URL of the application\'s logo. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'logo'?: string; + /** + * The URL of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'appUrl'?: string; + /** + * List of groups associated with the application. + * @type {Array} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'groups'?: Array; + /** + * The count of users associated with the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'usersCount'?: string; + /** + * The owners of the application. + * @type {Array} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'applicationOwner'?: Array; + /** + * The IT owners of the application. + * @type {Array} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'itApplicationOwner'?: Array; + /** + * The business criticality level of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'businessCriticality'?: string; + /** + * The data classification level of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'dataClassification'?: string; + /** + * The business unit associated with the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'businessUnit'?: string; + /** + * The installation type of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'installType'?: string; + /** + * The environment in which the application operates. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'environment'?: string; + /** + * The risk score of the application ranging from 0-100, 100 being highest risk. + * @type {number} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'riskScore'?: number; + /** + * Indicates whether the application is used for business purposes. + * @type {boolean} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'isBusiness'?: boolean; + /** + * The total number of sign-in accounts for the application. + * @type {number} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'totalSigninsCount'?: number; + /** + * The risk level of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'riskLevel'?: SlimdiscoveredapplicationsV1RiskLevelV1; + /** + * Indicates whether the application has privileged access. + * @type {boolean} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'isPrivileged'?: boolean; + /** + * The warranty expiration date of the application. + * @type {string} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'warrantyExpiration'?: string; + /** + * Additional attributes of the application useful for visibility of governance posture. + * @type {object} + * @memberof SlimdiscoveredapplicationsV1 + */ + 'attributes'?: object; +} + +export const SlimdiscoveredapplicationsV1RiskLevelV1 = { + High: 'High', + Medium: 'Medium', + Low: 'Low' +} as const; + +export type SlimdiscoveredapplicationsV1RiskLevelV1 = typeof SlimdiscoveredapplicationsV1RiskLevelV1[keyof typeof SlimdiscoveredapplicationsV1RiskLevelV1]; + +/** + * + * @export + * @interface StartApplicationDiscoveryV1401ResponseV1 + */ +export interface StartApplicationDiscoveryV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartApplicationDiscoveryV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface StartApplicationDiscoveryV1403ResponseOneOfV1 + */ +export interface StartApplicationDiscoveryV1403ResponseOneOfV1 { + /** + * Error message when quota is exceeded + * @type {string} + * @memberof StartApplicationDiscoveryV1403ResponseOneOfV1 + */ + 'error': string; +} +/** + * @type StartApplicationDiscoveryV1403ResponseV1 + * @export + */ +export type StartApplicationDiscoveryV1403ResponseV1 = ErrorresponsedtoV1 | StartApplicationDiscoveryV1403ResponseOneOfV1; + +/** + * + * @export + * @interface StartApplicationDiscoveryV1429ResponseV1 + */ +export interface StartApplicationDiscoveryV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartApplicationDiscoveryV1429ResponseV1 + */ + 'message'?: any; +} +/** + * Definition of a type of task, used to invoke tasks + * @export + * @interface TaskdefinitionsummaryV1 + */ +export interface TaskdefinitionsummaryV1 { + /** + * System-generated unique ID of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'id': string; + /** + * Name of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'uniqueName': string; + /** + * Description of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'description': string | null; + /** + * Name of the parent of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'parentName': string; + /** + * Executor of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'executor': string | null; + /** + * Formal parameters of the TaskDefinition, without values + * @type {{ [key: string]: any; }} + * @memberof TaskdefinitionsummaryV1 + */ + 'arguments': { [key: string]: any; }; +} +/** + * Task return details + * @export + * @interface TaskreturndetailsV1 + */ +export interface TaskreturndetailsV1 { + /** + * Display name of the TaskReturnDetails + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'name': string; + /** + * Attribute the TaskReturnDetails is for + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'attributeName': string; +} +/** + * + * @export + * @interface TaskstatusmessageParametersInnerV1 + */ +export interface TaskstatusmessageParametersInnerV1 { +} +/** + * TaskStatus Message + * @export + * @interface TaskstatusmessageV1 + */ +export interface TaskstatusmessageV1 { + /** + * Type of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'type': TaskstatusmessageV1TypeV1; + /** + * + * @type {LocalizedmessageV1} + * @memberof TaskstatusmessageV1 + */ + 'localizedText': LocalizedmessageV1 | null; + /** + * Key of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'key': string; + /** + * Message parameters for internationalization + * @type {Array} + * @memberof TaskstatusmessageV1 + */ + 'parameters': Array | null; +} + +export const TaskstatusmessageV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type TaskstatusmessageV1TypeV1 = typeof TaskstatusmessageV1TypeV1[keyof typeof TaskstatusmessageV1TypeV1]; + + +/** + * ApplicationDiscoveryV1Api - axios parameter creator + * @export + */ +export const ApplicationDiscoveryV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + * @summary Get discovered applications for tenant + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetDiscoveredApplicationsV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* + * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDiscoveredApplicationsV1: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsV1DetailV1, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/discovered-applications/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (detail !== undefined) { + localVarQueryParameter['detail'] = detail; + } + + if (filter !== undefined) { + localVarQueryParameter['filter'] = filter; + } + + 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, + }; + }, + /** + * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + * @summary Download csv template for discovery + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManualDiscoverApplicationsCsvTemplateV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/manual-discover-applications-template/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + * @summary Upload csv to discover applications + * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendManualDiscoverApplicationsCsvTemplateV1: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'file' is not null or undefined + assertParamExists('sendManualDiscoverApplicationsCsvTemplateV1', 'file', file) + const localVarPath = `/manual-discover-applications/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; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to discover applications. + * @summary Start Application Discovery + * @param {string} sourceId The sourceId. + * @param {ApplicationdiscoveryrequestV1} applicationdiscoveryrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startApplicationDiscoveryV1: async (sourceId: string, applicationdiscoveryrequestV1: ApplicationdiscoveryrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('startApplicationDiscoveryV1', 'sourceId', sourceId) + // verify required parameter 'applicationdiscoveryrequestV1' is not null or undefined + assertParamExists('startApplicationDiscoveryV1', 'applicationdiscoveryrequestV1', applicationdiscoveryrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/discover-applications` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(applicationdiscoveryrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ApplicationDiscoveryV1Api - functional programming interface + * @export + */ +export const ApplicationDiscoveryV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ApplicationDiscoveryV1ApiAxiosParamCreator(configuration) + return { + /** + * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + * @summary Get discovered applications for tenant + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetDiscoveredApplicationsV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* + * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDiscoveredApplicationsV1(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsV1DetailV1, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplicationsV1(limit, offset, detail, filter, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV1Api.getDiscoveredApplicationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + * @summary Download csv template for discovery + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManualDiscoverApplicationsCsvTemplateV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplateV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV1Api.getManualDiscoverApplicationsCsvTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + * @summary Upload csv to discover applications + * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendManualDiscoverApplicationsCsvTemplateV1(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplateV1(file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV1Api.sendManualDiscoverApplicationsCsvTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to discover applications. + * @summary Start Application Discovery + * @param {string} sourceId The sourceId. + * @param {ApplicationdiscoveryrequestV1} applicationdiscoveryrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startApplicationDiscoveryV1(sourceId: string, applicationdiscoveryrequestV1: ApplicationdiscoveryrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startApplicationDiscoveryV1(sourceId, applicationdiscoveryrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV1Api.startApplicationDiscoveryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ApplicationDiscoveryV1Api - factory interface + * @export + */ +export const ApplicationDiscoveryV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ApplicationDiscoveryV1ApiFp(configuration) + return { + /** + * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + * @summary Get discovered applications for tenant + * @param {ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDiscoveredApplicationsV1(requestParameters: ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getDiscoveredApplicationsV1(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + * @summary Download csv template for discovery + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManualDiscoverApplicationsCsvTemplateV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getManualDiscoverApplicationsCsvTemplateV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + * @summary Upload csv to discover applications + * @param {ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendManualDiscoverApplicationsCsvTemplateV1(requestParameters: ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendManualDiscoverApplicationsCsvTemplateV1(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to discover applications. + * @summary Start Application Discovery + * @param {ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startApplicationDiscoveryV1(requestParameters: ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startApplicationDiscoveryV1(requestParameters.sourceId, requestParameters.applicationdiscoveryrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getDiscoveredApplicationsV1 operation in ApplicationDiscoveryV1Api. + * @export + * @interface ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request + */ +export interface ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request { + /** + * 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 ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1 + */ + readonly offset?: number + + /** + * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + * @type {'SLIM' | 'FULL'} + * @memberof ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1 + */ + readonly detail?: GetDiscoveredApplicationsV1DetailV1 + + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* + * @type {string} + * @memberof ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1 + */ + readonly filter?: 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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** + * @type {string} + * @memberof ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for sendManualDiscoverApplicationsCsvTemplateV1 operation in ApplicationDiscoveryV1Api. + * @export + * @interface ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request + */ +export interface ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request { + /** + * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + * @type {File} + * @memberof ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1 + */ + readonly file: File +} + +/** + * Request parameters for startApplicationDiscoveryV1 operation in ApplicationDiscoveryV1Api. + * @export + * @interface ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request + */ +export interface ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request { + /** + * The sourceId. + * @type {string} + * @memberof ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1 + */ + readonly sourceId: string + + /** + * + * @type {ApplicationdiscoveryrequestV1} + * @memberof ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1 + */ + readonly applicationdiscoveryrequestV1: ApplicationdiscoveryrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * ApplicationDiscoveryV1Api - object-oriented interface + * @export + * @class ApplicationDiscoveryV1Api + * @extends {BaseAPI} + */ +export class ApplicationDiscoveryV1Api extends BaseAPI { + /** + * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + * @summary Get discovered applications for tenant + * @param {ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApplicationDiscoveryV1Api + */ + public getDiscoveredApplicationsV1(requestParameters: ApplicationDiscoveryV1ApiGetDiscoveredApplicationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ApplicationDiscoveryV1ApiFp(this.configuration).getDiscoveredApplicationsV1(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + * @summary Download csv template for discovery + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApplicationDiscoveryV1Api + */ + public getManualDiscoverApplicationsCsvTemplateV1(axiosOptions?: RawAxiosRequestConfig) { + return ApplicationDiscoveryV1ApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplateV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + * @summary Upload csv to discover applications + * @param {ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApplicationDiscoveryV1Api + */ + public sendManualDiscoverApplicationsCsvTemplateV1(requestParameters: ApplicationDiscoveryV1ApiSendManualDiscoverApplicationsCsvTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApplicationDiscoveryV1ApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplateV1(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to discover applications. + * @summary Start Application Discovery + * @param {ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApplicationDiscoveryV1Api + */ + public startApplicationDiscoveryV1(requestParameters: ApplicationDiscoveryV1ApiStartApplicationDiscoveryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApplicationDiscoveryV1ApiFp(this.configuration).startApplicationDiscoveryV1(requestParameters.sourceId, requestParameters.applicationdiscoveryrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetDiscoveredApplicationsV1DetailV1 = { + Slim: 'SLIM', + Full: 'FULL' +} as const; +export type GetDiscoveredApplicationsV1DetailV1 = typeof GetDiscoveredApplicationsV1DetailV1[keyof typeof GetDiscoveredApplicationsV1DetailV1]; + + diff --git a/sdk-output/application_discovery/base.ts b/sdk-output/application_discovery/base.ts new file mode 100644 index 00000000..07ff6a0c --- /dev/null +++ b/sdk-output/application_discovery/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Application Discovery + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/application_discovery/common.ts b/sdk-output/application_discovery/common.ts new file mode 100644 index 00000000..51d3c0b4 --- /dev/null +++ b/sdk-output/application_discovery/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Application Discovery + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/application_discovery/configuration.ts b/sdk-output/application_discovery/configuration.ts new file mode 100644 index 00000000..6acf9099 --- /dev/null +++ b/sdk-output/application_discovery/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Application Discovery + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/application_discovery/git_push.sh b/sdk-output/application_discovery/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/application_discovery/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/application_discovery/index.ts b/sdk-output/application_discovery/index.ts new file mode 100644 index 00000000..40dbdcc3 --- /dev/null +++ b/sdk-output/application_discovery/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Application Discovery + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/application_discovery/package.json b/sdk-output/application_discovery/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/application_discovery/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/application_discovery/tsconfig.json b/sdk-output/application_discovery/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/application_discovery/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/approvals/.gitignore b/sdk-output/approvals/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/approvals/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/approvals/.npmignore b/sdk-output/approvals/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/approvals/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/approvals/.openapi-generator-ignore b/sdk-output/approvals/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/approvals/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/approvals/.openapi-generator/FILES b/sdk-output/approvals/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/approvals/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/approvals/.openapi-generator/VERSION b/sdk-output/approvals/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/approvals/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/approvals/.sdk-partition b/sdk-output/approvals/.sdk-partition new file mode 100644 index 00000000..d4eb1299 --- /dev/null +++ b/sdk-output/approvals/.sdk-partition @@ -0,0 +1 @@ +approvals \ No newline at end of file diff --git a/sdk-output/approvals/README.md b/sdk-output/approvals/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/approvals/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/approvals/api.ts b/sdk-output/approvals/api.ts new file mode 100644 index 00000000..076410bc --- /dev/null +++ b/sdk-output/approvals/api.ts @@ -0,0 +1,3000 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Approvals + * 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'; + +/** + * Criteria for approval + * @export + * @interface Approval2ApprovalCriteriaApprovalV1 + */ +export interface Approval2ApprovalCriteriaApprovalV1 { + /** + * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to approve + * @type {string} + * @memberof Approval2ApprovalCriteriaApprovalV1 + */ + 'calculationType'?: Approval2ApprovalCriteriaApprovalV1CalculationTypeV1; + /** + * The value that needs to be met for the approval criteria + * @type {number} + * @memberof Approval2ApprovalCriteriaApprovalV1 + */ + 'value'?: number; +} + +export const Approval2ApprovalCriteriaApprovalV1CalculationTypeV1 = { + Count: 'COUNT', + Percent: 'PERCENT' +} as const; + +export type Approval2ApprovalCriteriaApprovalV1CalculationTypeV1 = typeof Approval2ApprovalCriteriaApprovalV1CalculationTypeV1[keyof typeof Approval2ApprovalCriteriaApprovalV1CalculationTypeV1]; + +/** + * Criteria for rejection + * @export + * @interface Approval2ApprovalCriteriaRejectionV1 + */ +export interface Approval2ApprovalCriteriaRejectionV1 { + /** + * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to reject + * @type {string} + * @memberof Approval2ApprovalCriteriaRejectionV1 + */ + 'calculationType'?: Approval2ApprovalCriteriaRejectionV1CalculationTypeV1; + /** + * The value that needs to be met for the rejection criteria + * @type {number} + * @memberof Approval2ApprovalCriteriaRejectionV1 + */ + 'value'?: number; +} + +export const Approval2ApprovalCriteriaRejectionV1CalculationTypeV1 = { + Count: 'COUNT', + Percent: 'PERCENT' +} as const; + +export type Approval2ApprovalCriteriaRejectionV1CalculationTypeV1 = typeof Approval2ApprovalCriteriaRejectionV1CalculationTypeV1[keyof typeof Approval2ApprovalCriteriaRejectionV1CalculationTypeV1]; + +/** + * Criteria that needs to be met for an approval or rejection + * @export + * @interface Approval2ApprovalCriteriaV1 + */ +export interface Approval2ApprovalCriteriaV1 { + /** + * Type of approval criteria, such as SERIAL or PARALLEL + * @type {string} + * @memberof Approval2ApprovalCriteriaV1 + */ + 'type'?: string; + /** + * + * @type {Approval2ApprovalCriteriaApprovalV1} + * @memberof Approval2ApprovalCriteriaV1 + */ + 'approval'?: Approval2ApprovalCriteriaApprovalV1; + /** + * + * @type {Approval2ApprovalCriteriaRejectionV1} + * @memberof Approval2ApprovalCriteriaV1 + */ + 'rejection'?: Approval2ApprovalCriteriaRejectionV1; +} +/** + * Approval Object + * @export + * @interface Approval2V1 + */ +export interface Approval2V1 { + /** + * The Approval ID + * @type {string} + * @memberof Approval2V1 + */ + 'id'?: string; + /** + * The Tenant ID of the Approval + * @type {string} + * @memberof Approval2V1 + */ + 'tenantId'?: string; + /** + * The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL + * @type {string} + * @memberof Approval2V1 + */ + 'type'?: string; + /** + * Object representation of an approver of an approval + * @type {Array} + * @memberof Approval2V1 + */ + 'approvers'?: Array; + /** + * Date the approval was created + * @type {string} + * @memberof Approval2V1 + */ + 'createdDate'?: string; + /** + * Date the approval is due + * @type {string} + * @memberof Approval2V1 + */ + 'dueDate'?: string; + /** + * Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. + * @type {string} + * @memberof Approval2V1 + */ + 'escalationStep'?: string; + /** + * The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. + * @type {number} + * @memberof Approval2V1 + */ + 'serialStep'?: number; + /** + * Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. + * @type {boolean} + * @memberof Approval2V1 + */ + 'isEscalated'?: boolean; + /** + * The name of the approval for a given locale + * @type {Array} + * @memberof Approval2V1 + */ + 'name'?: Array; + /** + * + * @type {ApprovalbatchV1} + * @memberof Approval2V1 + */ + 'batchRequest'?: ApprovalbatchV1; + /** + * + * @type {ApprovalconfigV1} + * @memberof Approval2V1 + */ + 'approvalConfig'?: ApprovalconfigV1; + /** + * The description of the approval for a given locale + * @type {Array} + * @memberof Approval2V1 + */ + 'description'?: Array; + /** + * Signifies what medium to use when sending notifications (currently only email is utilized) + * @type {string} + * @memberof Approval2V1 + */ + 'medium'?: Approval2V1MediumV1; + /** + * The priority of the approval + * @type {string} + * @memberof Approval2V1 + */ + 'priority'?: Approval2V1PriorityV1; + /** + * + * @type {ApprovalidentityV1} + * @memberof Approval2V1 + */ + 'requester'?: ApprovalidentityV1; + /** + * + * @type {ApprovalidentityV1} + * @memberof Approval2V1 + */ + 'requestee'?: ApprovalidentityV1; + /** + * Object representation of a comment on the approval + * @type {Array} + * @memberof Approval2V1 + */ + 'comments'?: Array; + /** + * Array of approvers who have approved the approval + * @type {Array} + * @memberof Approval2V1 + */ + 'approvedBy'?: Array; + /** + * Array of approvers who have rejected the approval + * @type {Array} + * @memberof Approval2V1 + */ + 'rejectedBy'?: Array; + /** + * Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. + * @type {Array} + * @memberof Approval2V1 + */ + 'assignedTo'?: Array; + /** + * Date the approval was completed + * @type {string} + * @memberof Approval2V1 + */ + 'completedDate'?: string; + /** + * + * @type {Approval2ApprovalCriteriaV1} + * @memberof Approval2V1 + */ + 'approvalCriteria'?: Approval2ApprovalCriteriaV1; + /** + * Json string representing additional attributes known about the object to be approved. + * @type {string} + * @memberof Approval2V1 + */ + 'additionalAttributes'?: string; + /** + * Reference data related to the approval + * @type {Array} + * @memberof Approval2V1 + */ + 'referenceData'?: Array; + /** + * History of whom the approval request was assigned to + * @type {Array} + * @memberof Approval2V1 + */ + 'reassignmentHistory'?: Array; + /** + * Field that can include any static additional info that may be needed by the service that the approval request originated from + * @type {{ [key: string]: any; }} + * @memberof Approval2V1 + */ + 'staticAttributes'?: { [key: string]: any; }; + /** + * Date/time that the approval request was last updated + * @type {string} + * @memberof Approval2V1 + */ + 'modifiedDate'?: string; + /** + * RequestedTarget used to specify the actual object or target the approval request is for + * @type {Array} + * @memberof Approval2V1 + */ + 'requestedTarget'?: Array; +} + +export const Approval2V1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type Approval2V1MediumV1 = typeof Approval2V1MediumV1[keyof typeof Approval2V1MediumV1]; +export const Approval2V1PriorityV1 = { + High: 'HIGH', + Medium: 'MEDIUM', + Low: 'LOW' +} as const; + +export type Approval2V1PriorityV1 = typeof Approval2V1PriorityV1[keyof typeof Approval2V1PriorityV1]; + +/** + * Approval Approve Request + * @export + * @interface ApprovalapproverequestV1 + */ +export interface ApprovalapproverequestV1 { + /** + * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. + * @type {{ [key: string]: string; }} + * @memberof ApprovalapproverequestV1 + */ + 'additionalAttributes'?: { [key: string]: string; }; + /** + * Comment associated with the request. + * @type {string} + * @memberof ApprovalapproverequestV1 + */ + 'comment'?: string; +} +/** + * Approval Attributes Request + * @export + * @interface ApprovalattributesrequestV1 + */ +export interface ApprovalattributesrequestV1 { + /** + * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. + * @type {{ [key: string]: string; }} + * @memberof ApprovalattributesrequestV1 + */ + 'additionalAttributes'?: { [key: string]: string; }; + /** + * Comment associated with the request. + * @type {string} + * @memberof ApprovalattributesrequestV1 + */ + 'comment'?: string; + /** + * List of attribute keys to be removed. + * @type {Array} + * @memberof ApprovalattributesrequestV1 + */ + 'removeAttributeKeys'?: Array; +} +/** + * Batch properties if an approval is sent via batching. + * @export + * @interface ApprovalbatchV1 + */ +export interface ApprovalbatchV1 { + /** + * ID of the batch + * @type {string} + * @memberof ApprovalbatchV1 + */ + 'batchId'?: string; + /** + * How many approvals are going to be in this batch. Defaults to 1 if not provided. + * @type {number} + * @memberof ApprovalbatchV1 + */ + 'batchSize'?: number; +} +/** + * Request body for cancelling a single approval request. + * @export + * @interface ApprovalcancelrequestV1 + */ +export interface ApprovalcancelrequestV1 { + /** + * Optional comment associated with the cancel request. + * @type {string} + * @memberof ApprovalcancelrequestV1 + */ + 'comment'?: string; +} +/** + * Comments Object + * @export + * @interface Approvalcomment3V1 + */ +export interface Approvalcomment3V1 { + /** + * + * @type {ApprovalidentityV1} + * @memberof Approvalcomment3V1 + */ + 'author'?: ApprovalidentityV1; + /** + * Comment to be left on an approval + * @type {string} + * @memberof Approvalcomment3V1 + */ + 'comment'?: string; + /** + * Date the comment was created + * @type {string} + * @memberof Approvalcomment3V1 + */ + 'createdDate'?: string; + /** + * ID of the comment + * @type {string} + * @memberof Approvalcomment3V1 + */ + 'commentId'?: string; +} +/** + * + * @export + * @interface ApprovalcommentsrequestV1 + */ +export interface ApprovalcommentsrequestV1 { + /** + * Comment associated with the request. + * @type {string} + * @memberof ApprovalcommentsrequestV1 + */ + 'comment'?: string; +} +/** + * Timezone configuration for cron schedules. + * @export + * @interface ApprovalconfigCronTimezoneV1 + */ +export interface ApprovalconfigCronTimezoneV1 { + /** + * Timezone location for cron schedules. + * @type {string} + * @memberof ApprovalconfigCronTimezoneV1 + */ + 'location'?: string; + /** + * Timezone offset for cron schedules. + * @type {string} + * @memberof ApprovalconfigCronTimezoneV1 + */ + 'offset'?: string; +} +/** + * + * @export + * @interface ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ +export interface ApprovalconfigEscalationConfigEscalationChainInnerV1 { + /** + * Starting at 1 defines the order in which the identities will get assigned + * @type {number} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'tier'?: number; + /** + * Optional Identity ID of the type of identity defined in the \'identityType\' field. + * @type {string} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'identityId'?: string; + /** + * Type of identityId in the escalation chain. + * @type {string} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'identityType'?: ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1; +} + +export const ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1 = { + Identity: 'IDENTITY', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER' +} as const; + +export type ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1 = typeof ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1[keyof typeof ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1]; + +/** + * Configuration for escalations. + * @export + * @interface ApprovalconfigEscalationConfigV1 + */ +export interface ApprovalconfigEscalationConfigV1 { + /** + * Indicates if escalations are enabled. + * @type {boolean} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until the first escalation. + * @type {number} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'daysUntilFirstEscalation'?: number; + /** + * Cron schedule for escalations. + * @type {string} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'escalationCronSchedule'?: string; + /** + * Escalation chain configuration. + * @type {Array} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'escalationChain'?: Array; +} +/** + * Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. + * @export + * @interface ApprovalconfigFallbackApproverV1 + */ +export interface ApprovalconfigFallbackApproverV1 { + /** + * Optional Identity ID of the type of identity defined in the \'type\' field. + * @type {string} + * @memberof ApprovalconfigFallbackApproverV1 + */ + 'identityID'?: string; + /** + * Type of identityID for the fallback approver. + * @type {string} + * @memberof ApprovalconfigFallbackApproverV1 + */ + 'type'?: ApprovalconfigFallbackApproverV1TypeV1; +} + +export const ApprovalconfigFallbackApproverV1TypeV1 = { + Identity: 'IDENTITY', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', + RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER' +} as const; + +export type ApprovalconfigFallbackApproverV1TypeV1 = typeof ApprovalconfigFallbackApproverV1TypeV1[keyof typeof ApprovalconfigFallbackApproverV1TypeV1]; + +/** + * Configuration for reminders. + * @export + * @interface ApprovalconfigReminderConfigV1 + */ +export interface ApprovalconfigReminderConfigV1 { + /** + * Indicates if reminders are enabled. + * @type {boolean} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until the first reminder. + * @type {number} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'daysUntilFirstReminder'?: number; + /** + * Cron schedule for reminders. + * @type {string} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'reminderCronSchedule'?: string; + /** + * Maximum number of reminders. Max is 20. + * @type {number} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'maxReminders'?: number; +} +/** + * + * @export + * @interface ApprovalconfigSerialChainInnerV1 + */ +export interface ApprovalconfigSerialChainInnerV1 { + /** + * Starting at 1 defines the order in which the identities will get assigned + * @type {number} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'tier'?: number; + /** + * Optional Identity ID of the type of identity defined in the \'identityType\' field. + * @type {string} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'identityId'?: string; + /** + * Type of identityId in the serial chain. + * @type {string} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'identityType'?: ApprovalconfigSerialChainInnerV1IdentityTypeV1; +} + +export const ApprovalconfigSerialChainInnerV1IdentityTypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', + RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', + AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', + ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', + EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', + RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', + SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', + RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', + AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', + ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', + EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', + RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', + SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', + RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' +} as const; + +export type ApprovalconfigSerialChainInnerV1IdentityTypeV1 = typeof ApprovalconfigSerialChainInnerV1IdentityTypeV1[keyof typeof ApprovalconfigSerialChainInnerV1IdentityTypeV1]; + +/** + * TimeoutConfig contains configurations around when the approval request should expire. + * @export + * @interface ApprovalconfigTimeoutConfigV1 + */ +export interface ApprovalconfigTimeoutConfigV1 { + /** + * Indicates if timeout is enabled. + * @type {boolean} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until approval request times out. Max value is 90. + * @type {number} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'daysUntilTimeout'?: number; + /** + * Result of timeout. + * @type {string} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'timeoutResult'?: ApprovalconfigTimeoutConfigV1TimeoutResultV1; +} + +export const ApprovalconfigTimeoutConfigV1TimeoutResultV1 = { + Expired: 'EXPIRED', + Approved: 'APPROVED' +} as const; + +export type ApprovalconfigTimeoutConfigV1TimeoutResultV1 = typeof ApprovalconfigTimeoutConfigV1TimeoutResultV1[keyof typeof ApprovalconfigTimeoutConfigV1TimeoutResultV1]; + +/** + * Approval config Object + * @export + * @interface ApprovalconfigV1 + */ +export interface ApprovalconfigV1 { + /** + * + * @type {ApprovalconfigReminderConfigV1} + * @memberof ApprovalconfigV1 + */ + 'reminderConfig'?: ApprovalconfigReminderConfigV1; + /** + * + * @type {ApprovalconfigEscalationConfigV1} + * @memberof ApprovalconfigV1 + */ + 'escalationConfig'?: ApprovalconfigEscalationConfigV1; + /** + * + * @type {ApprovalconfigTimeoutConfigV1} + * @memberof ApprovalconfigV1 + */ + 'timeoutConfig'?: ApprovalconfigTimeoutConfigV1; + /** + * + * @type {ApprovalconfigCronTimezoneV1} + * @memberof ApprovalconfigV1 + */ + 'cronTimezone'?: ApprovalconfigCronTimezoneV1; + /** + * If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. + * @type {Array} + * @memberof ApprovalconfigV1 + */ + 'serialChain'?: Array; + /** + * Determines whether a comment is required when approving or rejecting the approval request. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'requiresComment'?: ApprovalconfigV1RequiresCommentV1; + /** + * + * @type {ApprovalconfigFallbackApproverV1} + * @memberof ApprovalconfigV1 + */ + 'fallbackApprover'?: ApprovalconfigFallbackApproverV1; + /** + * Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'machineIdentityManagerAssignment'?: ApprovalconfigV1MachineIdentityManagerAssignmentV1; + /** + * When true, all approvals will be created with the status \"PASSED\". + * @type {boolean} + * @memberof ApprovalconfigV1 + */ + 'circumventApprovalProcess'?: boolean; + /** + * OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'autoApprove'?: ApprovalconfigV1AutoApproveV1; +} + +export const ApprovalconfigV1RequiresCommentV1 = { + Approval: 'APPROVAL', + Rejection: 'REJECTION', + All: 'ALL', + Off: 'OFF' +} as const; + +export type ApprovalconfigV1RequiresCommentV1 = typeof ApprovalconfigV1RequiresCommentV1[keyof typeof ApprovalconfigV1RequiresCommentV1]; +export const ApprovalconfigV1MachineIdentityManagerAssignmentV1 = { + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + AccountOwner: 'ACCOUNT_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER' +} as const; + +export type ApprovalconfigV1MachineIdentityManagerAssignmentV1 = typeof ApprovalconfigV1MachineIdentityManagerAssignmentV1[keyof typeof ApprovalconfigV1MachineIdentityManagerAssignmentV1]; +export const ApprovalconfigV1AutoApproveV1 = { + Off: 'OFF', + Direct: 'DIRECT', + Indirect: 'INDIRECT' +} as const; + +export type ApprovalconfigV1AutoApproveV1 = typeof ApprovalconfigV1AutoApproveV1[keyof typeof ApprovalconfigV1AutoApproveV1]; + +/** + * The description of what the approval is asking for + * @export + * @interface ApprovaldescriptionV1 + */ +export interface ApprovaldescriptionV1 { + /** + * The description of what the approval is asking for + * @type {string} + * @memberof ApprovaldescriptionV1 + */ + 'value'?: string; + /** + * What locale the description of the approval is using + * @type {string} + * @memberof ApprovaldescriptionV1 + */ + 'locale'?: string; +} +/** + * + * @export + * @interface ApprovalidentityMembersInnerV1 + */ +export interface ApprovalidentityMembersInnerV1 { + /** + * Email of the member. + * @type {string} + * @memberof ApprovalidentityMembersInnerV1 + */ + 'email'?: string; + /** + * ID of the member. + * @type {string} + * @memberof ApprovalidentityMembersInnerV1 + */ + 'id'?: string; + /** + * Name of the member. + * @type {string} + * @memberof ApprovalidentityMembersInnerV1 + */ + 'name'?: string; + /** + * Type of the member. + * @type {string} + * @memberof ApprovalidentityMembersInnerV1 + */ + 'type'?: string; +} +/** + * + * @export + * @interface ApprovalidentityOwnerOfInnerV1 + */ +export interface ApprovalidentityOwnerOfInnerV1 { + /** + * ID of the object that is owned. + * @type {string} + * @memberof ApprovalidentityOwnerOfInnerV1 + */ + 'id'?: string; + /** + * Name of the object that is owned. + * @type {string} + * @memberof ApprovalidentityOwnerOfInnerV1 + */ + 'name'?: string; + /** + * Type of the object that is owned. + * @type {string} + * @memberof ApprovalidentityOwnerOfInnerV1 + */ + 'type'?: string; +} +/** + * Approval Identity Object + * @export + * @interface ApprovalidentityV1 + */ +export interface ApprovalidentityV1 { + /** + * Email address. + * @type {string} + * @memberof ApprovalidentityV1 + */ + 'email'?: string; + /** + * Identity ID of the type of identity defined in the \'type\' field. + * @type {string} + * @memberof ApprovalidentityV1 + */ + 'identityID'?: string; + /** + * List of members of a governance group. Will be omitted if the identity is not a governance group. + * @type {Array} + * @memberof ApprovalidentityV1 + */ + 'members'?: Array; + /** + * Name of the identity. + * @type {string} + * @memberof ApprovalidentityV1 + */ + 'name'?: string; + /** + * List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. + * @type {Array} + * @memberof ApprovalidentityV1 + */ + 'ownerOf'?: Array; + /** + * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. + * @type {number} + * @memberof ApprovalidentityV1 + */ + 'serialOrder'?: number; + /** + * Type of identityID. + * @type {string} + * @memberof ApprovalidentityV1 + */ + 'type'?: ApprovalidentityV1TypeV1; +} + +export const ApprovalidentityV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', + RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', + AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', + ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', + EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', + RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', + SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', + RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', + AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', + ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', + EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', + RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', + SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', + RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' +} as const; + +export type ApprovalidentityV1TypeV1 = typeof ApprovalidentityV1TypeV1[keyof typeof ApprovalidentityV1TypeV1]; + +/** + * Identity Record Object + * @export + * @interface ApprovalidentityrecordV1 + */ +export interface ApprovalidentityrecordV1 { + /** + * Identity ID. + * @type {string} + * @memberof ApprovalidentityrecordV1 + */ + 'identityID'?: string; + /** + * Type of identity. + * @type {string} + * @memberof ApprovalidentityrecordV1 + */ + 'type'?: ApprovalidentityrecordV1TypeV1; + /** + * Name of the identity. + * @type {string} + * @memberof ApprovalidentityrecordV1 + */ + 'name'?: string; + /** + * List of references representing actions taken by the identity. + * @type {Array} + * @memberof ApprovalidentityrecordV1 + */ + 'actionedAs'?: Array; + /** + * List of references representing members of the identity. + * @type {Array} + * @memberof ApprovalidentityrecordV1 + */ + 'members'?: Array; + /** + * Date when the decision was made. + * @type {string} + * @memberof ApprovalidentityrecordV1 + */ + 'decisionDate'?: string; + /** + * Email associated with the identity. + * @type {string} + * @memberof ApprovalidentityrecordV1 + */ + 'email'?: string; +} + +export const ApprovalidentityrecordV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ApprovalidentityrecordV1TypeV1 = typeof ApprovalidentityrecordV1TypeV1[keyof typeof ApprovalidentityrecordV1TypeV1]; + +/** + * Approval Name Object + * @export + * @interface ApprovalnameV1 + */ +export interface ApprovalnameV1 { + /** + * Name of the approval + * @type {string} + * @memberof ApprovalnameV1 + */ + 'value'?: string; + /** + * What locale the name of the approval is using + * @type {string} + * @memberof ApprovalnameV1 + */ + 'locale'?: string; +} +/** + * ReassignmentHistoryRecord holds a history record of reassignment and escalation actions for an approval request + * @export + * @interface ApprovalreassignmenthistoryV1 + */ +export interface ApprovalreassignmenthistoryV1 { + /** + * Unique identifier for the comment associated with the reassignment. + * @type {string} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'commentID'?: string; + /** + * + * @type {ApprovalidentityV1} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'reassignedFrom'?: ApprovalidentityV1; + /** + * + * @type {ApprovalidentityV1} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'reassignedTo'?: ApprovalidentityV1; + /** + * + * @type {ApprovalidentityV1} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'reassigner'?: ApprovalidentityV1; + /** + * Date and time when the reassignment occurred. + * @type {string} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'reassignmentDate'?: string; + /** + * Type of reassignment, such as escalation or manual reassignment. + * @type {string} + * @memberof ApprovalreassignmenthistoryV1 + */ + 'reassignmentType'?: ApprovalreassignmenthistoryV1ReassignmentTypeV1; +} + +export const ApprovalreassignmenthistoryV1ReassignmentTypeV1 = { + Escalation: 'ESCALATION', + ManualReassignment: 'MANUAL_REASSIGNMENT', + AutoReassignment: 'AUTO_REASSIGNMENT' +} as const; + +export type ApprovalreassignmenthistoryV1ReassignmentTypeV1 = typeof ApprovalreassignmenthistoryV1ReassignmentTypeV1[keyof typeof ApprovalreassignmenthistoryV1ReassignmentTypeV1]; + +/** + * Request body for reassigning an approval request to another identity. This results in that identity being added as an authorized approver. + * @export + * @interface ApprovalreassignrequestV1 + */ +export interface ApprovalreassignrequestV1 { + /** + * Comment associated with the reassign request. + * @type {string} + * @memberof ApprovalreassignrequestV1 + */ + 'comment'?: string; + /** + * Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user\'s identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. + * @type {string} + * @memberof ApprovalreassignrequestV1 + */ + 'reassignFrom'?: string; + /** + * Identity to which the approval is being reassigned. + * @type {string} + * @memberof ApprovalreassignrequestV1 + */ + 'reassignTo'?: string; +} +/** + * Reference objects related to the approval + * @export + * @interface ApprovalreferenceV1 + */ +export interface ApprovalreferenceV1 { + /** + * Id of the reference object + * @type {string} + * @memberof ApprovalreferenceV1 + */ + 'id'?: string; + /** + * What reference object does this ID correspond to + * @type {string} + * @memberof ApprovalreferenceV1 + */ + 'type'?: string; + /** + * Name of the reference object + * @type {string} + * @memberof ApprovalreferenceV1 + */ + 'name'?: string; + /** + * Email associated with the reference object + * @type {string} + * @memberof ApprovalreferenceV1 + */ + 'email'?: string; + /** + * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. + * @type {number} + * @memberof ApprovalreferenceV1 + */ + 'serialOrder'?: number; +} +/** + * Request body for rejecting an approval request. + * @export + * @interface ApprovalrejectrequestV1 + */ +export interface ApprovalrejectrequestV1 { + /** + * Comment associated with the reject request. + * @type {string} + * @memberof ApprovalrejectrequestV1 + */ + 'comment'?: string; +} +/** + * Represents a requested target in an approval process, including details such as ID, name, reauthentication requirements, and removal date. + * @export + * @interface ApprovalrequestedtargetV1 + */ +export interface ApprovalrequestedtargetV1 { + /** + * Signature required for forced authentication. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'forcedAuthSignature'?: string; + /** + * ID of the requested target. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'id'?: string; + /** + * Name of the requested target. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'name'?: string; + /** + * Indicates if reauthentication is required. + * @type {boolean} + * @memberof ApprovalrequestedtargetV1 + */ + 'reauthRequired'?: boolean; + /** + * Date when the target will be removed. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'removalDate'?: string; + /** + * Type of the request. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'requestType'?: string; + /** + * Type of the target. + * @type {string} + * @memberof ApprovalrequestedtargetV1 + */ + 'targetType'?: string; +} +/** + * BulkApproveRequestDTO is the input struct that represents the request body required to facilitate a bulk approval action for a set of generic approval requests. + * @export + * @interface BulkapproverequestdtoV1 + */ +export interface BulkapproverequestdtoV1 { + /** + * Array of Approval IDs to be bulk approved + * @type {Array} + * @memberof BulkapproverequestdtoV1 + */ + 'approvalIds'?: Array; + /** + * Optional comment to include with the bulk approval request + * @type {string} + * @memberof BulkapproverequestdtoV1 + */ + 'comment'?: string; + /** + * Additional attributes to include with the bulk approval request + * @type {{ [key: string]: any; }} + * @memberof BulkapproverequestdtoV1 + */ + 'additionalAttributes'?: { [key: string]: any; }; +} +/** + * BulkCancelRequestDTO is the input struct that represents the request body required to facilitate a bulk cancellation action for a set of generic approval requests. + * @export + * @interface BulkcancelrequestdtoV1 + */ +export interface BulkcancelrequestdtoV1 { + /** + * Array of Approval IDs to be bulk cancelled + * @type {Array} + * @memberof BulkcancelrequestdtoV1 + */ + 'approvalIds'?: Array; + /** + * Optional comment to include with the bulk cancellation request + * @type {string} + * @memberof BulkcancelrequestdtoV1 + */ + 'comment'?: string; +} +/** + * BulkReassignRequestDTO is the input struct that represents the request body required to facilitate a bulk reassignment action for a set of generic approval requests. + * @export + * @interface BulkreassignrequestdtoV1 + */ +export interface BulkreassignrequestdtoV1 { + /** + * Array of Approval IDs to be bulk reassigned + * @type {Array} + * @memberof BulkreassignrequestdtoV1 + */ + 'approvalIds'?: Array; + /** + * Optional comment to include with the bulk reassignment request + * @type {string} + * @memberof BulkreassignrequestdtoV1 + */ + 'comment'?: string; + /** + * Identity ID from which the approval requests are being reassigned + * @type {string} + * @memberof BulkreassignrequestdtoV1 + */ + 'reassignFrom'?: string; + /** + * ReassignTo signifies the Identity ID that the approval request is being reassigned to + * @type {string} + * @memberof BulkreassignrequestdtoV1 + */ + 'reassignTo'?: string; +} +/** + * BulkRejectRequestDTO is the input struct that represents the request body required to facilitate a bulk reject action for a set of generic approval requests. + * @export + * @interface BulkrejectrequestdtoV1 + */ +export interface BulkrejectrequestdtoV1 { + /** + * Array of Approval IDs to be bulk rejected + * @type {Array} + * @memberof BulkrejectrequestdtoV1 + */ + 'approvalIds'?: Array; + /** + * Optional comment to include with the bulk reject request + * @type {string} + * @memberof BulkrejectrequestdtoV1 + */ + 'comment'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetApprovalsV1401ResponseV1 + */ +export interface GetApprovalsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetApprovalsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetApprovalsV1429ResponseV1 + */ +export interface GetApprovalsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetApprovalsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * ApprovalsV1Api - axios parameter creator + * @export + */ +export const ApprovalsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Bulk Approves specified approval requests on behalf of the caller + * @summary Post Bulk Approve Approvals + * @param {BulkapproverequestdtoV1} bulkapproverequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalInBulkV1: async (bulkapproverequestdtoV1: BulkapproverequestdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkapproverequestdtoV1' is not null or undefined + assertParamExists('approveApprovalInBulkV1', 'bulkapproverequestdtoV1', bulkapproverequestdtoV1) + const localVarPath = `/generic-approvals/v1/bulk-approve`; + // 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(bulkapproverequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. + * @summary Post Approvals Approve + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. + * @param {ApprovalapproverequestV1} [approvalapproverequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalV1: async (id: string, approvalapproverequestV1?: ApprovalapproverequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('approveApprovalV1', 'id', id) + const localVarPath = `/generic-approvals/v1/{id}/approve` + .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: '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(approvalapproverequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel + * @summary Post Approval Cancel + * @param {string} id ID of the approval request to cancel. + * @param {ApprovalcancelrequestV1} [approvalcancelrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelApprovalByIdV1: async (id: string, approvalcancelrequestV1?: ApprovalcancelrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cancelApprovalByIdV1', 'id', id) + const localVarPath = `/generic-approvals/v1/{id}/cancel` + .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: '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(approvalcancelrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel + * @summary Post Bulk Cancel Approvals + * @param {BulkcancelrequestdtoV1} bulkcancelrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelApprovalV1: async (bulkcancelrequestdtoV1: BulkcancelrequestdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkcancelrequestdtoV1' is not null or undefined + assertParamExists('cancelApprovalV1', 'bulkcancelrequestdtoV1', bulkcancelrequestdtoV1) + const localVarPath = `/generic-approvals/v1/bulk-cancel`; + // 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(bulkcancelrequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. + * @summary Delete Approval Configuration + * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {DeleteApprovalConfigRequestV1ScopeV1} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteApprovalConfigRequestV1: async (id: string, scope: DeleteApprovalConfigRequestV1ScopeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteApprovalConfigRequestV1', 'id', id) + // verify required parameter 'scope' is not null or undefined + assertParamExists('deleteApprovalConfigRequestV1', 'scope', scope) + const localVarPath = `/generic-approvals/v1/config/{id}/{scope}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); + // 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, + }; + }, + /** + * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" + * @summary Get an approval + * @param {string} id ID of the approval that is to be returned + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getApprovalV1', 'id', id) + const localVarPath = `/generic-approvals/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, + }; + }, + /** + * Retrieves a singular approval configuration that matches the given ID + * @summary Get Approval Config + * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalsConfigV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getApprovalsConfigV1', 'id', id) + const localVarPath = `/generic-approvals/v1/config/{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, + }; + }, + /** + * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' + * @summary Get approvals + * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). + * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. + * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. + * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. + * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. + * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. + * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalsV1: async (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/generic-approvals/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 (mine !== undefined) { + localVarQueryParameter['mine'] = mine; + } + + if (requesterId !== undefined) { + localVarQueryParameter['requesterId'] = requesterId; + } + + if (requesteeId !== undefined) { + localVarQueryParameter['requesteeId'] = requesteeId; + } + + if (approverId !== undefined) { + localVarQueryParameter['approverId'] = approverId; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (countOnly !== undefined) { + localVarQueryParameter['count-only'] = countOnly; + } + + if (includeComments !== undefined) { + localVarQueryParameter['include-comments'] = includeComments; + } + + if (includeApprovers !== undefined) { + localVarQueryParameter['include-approvers'] = includeApprovers; + } + + if (includeReassignmentHistory !== undefined) { + localVarQueryParameter['include-reassignment-history'] = includeReassignmentHistory; + } + + if (includeBatchInfo !== undefined) { + localVarQueryParameter['include-batch-info'] = includeBatchInfo; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk reassigns specified approval requests on behalf of the caller + * @summary Post Bulk Reassign Approvals + * @param {BulkreassignrequestdtoV1} bulkreassignrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + moveApprovalV1: async (bulkreassignrequestdtoV1: BulkreassignrequestdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkreassignrequestdtoV1' is not null or undefined + assertParamExists('moveApprovalV1', 'bulkreassignrequestdtoV1', bulkreassignrequestdtoV1) + const localVarPath = `/generic-approvals/v1/bulk-reassign`; + // 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(bulkreassignrequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' + * @summary Put Approval Config + * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {PutApprovalsConfigV1ScopeV1} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {ApprovalconfigV1} approvalconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putApprovalsConfigV1: async (id: string, scope: PutApprovalsConfigV1ScopeV1, approvalconfigV1: ApprovalconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putApprovalsConfigV1', 'id', id) + // verify required parameter 'scope' is not null or undefined + assertParamExists('putApprovalsConfigV1', 'scope', scope) + // verify required parameter 'approvalconfigV1' is not null or undefined + assertParamExists('putApprovalsConfigV1', 'approvalconfigV1', approvalconfigV1) + const localVarPath = `/generic-approvals/v1/config/{id}/{scope}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); + // 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: 'PUT', ...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(approvalconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Bulk reject specified approval requests on behalf of the caller + * @summary Post Bulk Reject Approvals + * @param {BulkrejectrequestdtoV1} bulkrejectrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalInBulkV1: async (bulkrejectrequestdtoV1: BulkrejectrequestdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkrejectrequestdtoV1' is not null or undefined + assertParamExists('rejectApprovalInBulkV1', 'bulkrejectrequestdtoV1', bulkrejectrequestdtoV1) + const localVarPath = `/generic-approvals/v1/bulk-reject`; + // 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(bulkrejectrequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. + * @summary Post Approvals Reject + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. + * @param {ApprovalrejectrequestV1} [approvalrejectrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalV1: async (id: string, approvalrejectrequestV1?: ApprovalrejectrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rejectApprovalV1', 'id', id) + const localVarPath = `/generic-approvals/v1/{id}/reject` + .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: '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(approvalrejectrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Attributes + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. + * @param {ApprovalattributesrequestV1} approvalattributesrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsAttributesV1: async (id: string, approvalattributesrequestV1: ApprovalattributesrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateApprovalsAttributesV1', 'id', id) + // verify required parameter 'approvalattributesrequestV1' is not null or undefined + assertParamExists('updateApprovalsAttributesV1', 'approvalattributesrequestV1', approvalattributesrequestV1) + const localVarPath = `/generic-approvals/v1/{id}/attributes` + .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: '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(approvalattributesrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Adds comments to a specified approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Comments + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. + * @param {ApprovalcommentsrequestV1} approvalcommentsrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsCommentsV1: async (id: string, approvalcommentsrequestV1: ApprovalcommentsrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateApprovalsCommentsV1', 'id', id) + // verify required parameter 'approvalcommentsrequestV1' is not null or undefined + assertParamExists('updateApprovalsCommentsV1', 'approvalcommentsrequestV1', approvalcommentsrequestV1) + const localVarPath = `/generic-approvals/v1/{id}/comments` + .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: '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(approvalcommentsrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. + * @summary Post Approvals Reassign + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. + * @param {ApprovalreassignrequestV1} approvalreassignrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsReassignV1: async (id: string, approvalreassignrequestV1: ApprovalreassignrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateApprovalsReassignV1', 'id', id) + // verify required parameter 'approvalreassignrequestV1' is not null or undefined + assertParamExists('updateApprovalsReassignV1', 'approvalreassignrequestV1', approvalreassignrequestV1) + const localVarPath = `/generic-approvals/v1/{id}/reassign` + .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: '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(approvalreassignrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ApprovalsV1Api - functional programming interface + * @export + */ +export const ApprovalsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ApprovalsV1ApiAxiosParamCreator(configuration) + return { + /** + * Bulk Approves specified approval requests on behalf of the caller + * @summary Post Bulk Approve Approvals + * @param {BulkapproverequestdtoV1} bulkapproverequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveApprovalInBulkV1(bulkapproverequestdtoV1: BulkapproverequestdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalInBulkV1(bulkapproverequestdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.approveApprovalInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. + * @summary Post Approvals Approve + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. + * @param {ApprovalapproverequestV1} [approvalapproverequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveApprovalV1(id: string, approvalapproverequestV1?: ApprovalapproverequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalV1(id, approvalapproverequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.approveApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel + * @summary Post Approval Cancel + * @param {string} id ID of the approval request to cancel. + * @param {ApprovalcancelrequestV1} [approvalcancelrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelApprovalByIdV1(id: string, approvalcancelrequestV1?: ApprovalcancelrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApprovalByIdV1(id, approvalcancelrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.cancelApprovalByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel + * @summary Post Bulk Cancel Approvals + * @param {BulkcancelrequestdtoV1} bulkcancelrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelApprovalV1(bulkcancelrequestdtoV1: BulkcancelrequestdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApprovalV1(bulkcancelrequestdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.cancelApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. + * @summary Delete Approval Configuration + * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {DeleteApprovalConfigRequestV1ScopeV1} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteApprovalConfigRequestV1(id: string, scope: DeleteApprovalConfigRequestV1ScopeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApprovalConfigRequestV1(id, scope, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.deleteApprovalConfigRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" + * @summary Get an approval + * @param {string} id ID of the approval that is to be returned + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getApprovalV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovalV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.getApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a singular approval configuration that matches the given ID + * @summary Get Approval Config + * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getApprovalsConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovalsConfigV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.getApprovalsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' + * @summary Get approvals + * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). + * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. + * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. + * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. + * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. + * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. + * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. + * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getApprovalsV1(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovalsV1(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeReassignmentHistory, includeBatchInfo, filters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.getApprovalsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk reassigns specified approval requests on behalf of the caller + * @summary Post Bulk Reassign Approvals + * @param {BulkreassignrequestdtoV1} bulkreassignrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async moveApprovalV1(bulkreassignrequestdtoV1: BulkreassignrequestdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.moveApprovalV1(bulkreassignrequestdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.moveApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' + * @summary Put Approval Config + * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {PutApprovalsConfigV1ScopeV1} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @param {ApprovalconfigV1} approvalconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putApprovalsConfigV1(id: string, scope: PutApprovalsConfigV1ScopeV1, approvalconfigV1: ApprovalconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putApprovalsConfigV1(id, scope, approvalconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.putApprovalsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Bulk reject specified approval requests on behalf of the caller + * @summary Post Bulk Reject Approvals + * @param {BulkrejectrequestdtoV1} bulkrejectrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectApprovalInBulkV1(bulkrejectrequestdtoV1: BulkrejectrequestdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalInBulkV1(bulkrejectrequestdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.rejectApprovalInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. + * @summary Post Approvals Reject + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. + * @param {ApprovalrejectrequestV1} [approvalrejectrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectApprovalV1(id: string, approvalrejectrequestV1?: ApprovalrejectrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalV1(id, approvalrejectrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.rejectApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Attributes + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. + * @param {ApprovalattributesrequestV1} approvalattributesrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateApprovalsAttributesV1(id: string, approvalattributesrequestV1: ApprovalattributesrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsAttributesV1(id, approvalattributesrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.updateApprovalsAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Adds comments to a specified approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Comments + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. + * @param {ApprovalcommentsrequestV1} approvalcommentsrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateApprovalsCommentsV1(id: string, approvalcommentsrequestV1: ApprovalcommentsrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsCommentsV1(id, approvalcommentsrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.updateApprovalsCommentsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. + * @summary Post Approvals Reassign + * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. + * @param {ApprovalreassignrequestV1} approvalreassignrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateApprovalsReassignV1(id: string, approvalreassignrequestV1: ApprovalreassignrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsReassignV1(id, approvalreassignrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ApprovalsV1Api.updateApprovalsReassignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ApprovalsV1Api - factory interface + * @export + */ +export const ApprovalsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ApprovalsV1ApiFp(configuration) + return { + /** + * Bulk Approves specified approval requests on behalf of the caller + * @summary Post Bulk Approve Approvals + * @param {ApprovalsV1ApiApproveApprovalInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalInBulkV1(requestParameters: ApprovalsV1ApiApproveApprovalInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveApprovalInBulkV1(requestParameters.bulkapproverequestdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. + * @summary Post Approvals Approve + * @param {ApprovalsV1ApiApproveApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalV1(requestParameters: ApprovalsV1ApiApproveApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveApprovalV1(requestParameters.id, requestParameters.approvalapproverequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel + * @summary Post Approval Cancel + * @param {ApprovalsV1ApiCancelApprovalByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelApprovalByIdV1(requestParameters: ApprovalsV1ApiCancelApprovalByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelApprovalByIdV1(requestParameters.id, requestParameters.approvalcancelrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel + * @summary Post Bulk Cancel Approvals + * @param {ApprovalsV1ApiCancelApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelApprovalV1(requestParameters: ApprovalsV1ApiCancelApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelApprovalV1(requestParameters.bulkcancelrequestdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. + * @summary Delete Approval Configuration + * @param {ApprovalsV1ApiDeleteApprovalConfigRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteApprovalConfigRequestV1(requestParameters: ApprovalsV1ApiDeleteApprovalConfigRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteApprovalConfigRequestV1(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" + * @summary Get an approval + * @param {ApprovalsV1ApiGetApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalV1(requestParameters: ApprovalsV1ApiGetApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getApprovalV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a singular approval configuration that matches the given ID + * @summary Get Approval Config + * @param {ApprovalsV1ApiGetApprovalsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalsConfigV1(requestParameters: ApprovalsV1ApiGetApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getApprovalsConfigV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' + * @summary Get approvals + * @param {ApprovalsV1ApiGetApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApprovalsV1(requestParameters: ApprovalsV1ApiGetApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getApprovalsV1(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk reassigns specified approval requests on behalf of the caller + * @summary Post Bulk Reassign Approvals + * @param {ApprovalsV1ApiMoveApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + moveApprovalV1(requestParameters: ApprovalsV1ApiMoveApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.moveApprovalV1(requestParameters.bulkreassignrequestdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' + * @summary Put Approval Config + * @param {ApprovalsV1ApiPutApprovalsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putApprovalsConfigV1(requestParameters: ApprovalsV1ApiPutApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putApprovalsConfigV1(requestParameters.id, requestParameters.scope, requestParameters.approvalconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Bulk reject specified approval requests on behalf of the caller + * @summary Post Bulk Reject Approvals + * @param {ApprovalsV1ApiRejectApprovalInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalInBulkV1(requestParameters: ApprovalsV1ApiRejectApprovalInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectApprovalInBulkV1(requestParameters.bulkrejectrequestdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. + * @summary Post Approvals Reject + * @param {ApprovalsV1ApiRejectApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalV1(requestParameters: ApprovalsV1ApiRejectApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectApprovalV1(requestParameters.id, requestParameters.approvalrejectrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Attributes + * @param {ApprovalsV1ApiUpdateApprovalsAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsAttributesV1(requestParameters: ApprovalsV1ApiUpdateApprovalsAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateApprovalsAttributesV1(requestParameters.id, requestParameters.approvalattributesrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Adds comments to a specified approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Comments + * @param {ApprovalsV1ApiUpdateApprovalsCommentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsCommentsV1(requestParameters: ApprovalsV1ApiUpdateApprovalsCommentsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateApprovalsCommentsV1(requestParameters.id, requestParameters.approvalcommentsrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. + * @summary Post Approvals Reassign + * @param {ApprovalsV1ApiUpdateApprovalsReassignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateApprovalsReassignV1(requestParameters: ApprovalsV1ApiUpdateApprovalsReassignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateApprovalsReassignV1(requestParameters.id, requestParameters.approvalreassignrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveApprovalInBulkV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiApproveApprovalInBulkV1Request + */ +export interface ApprovalsV1ApiApproveApprovalInBulkV1Request { + /** + * + * @type {BulkapproverequestdtoV1} + * @memberof ApprovalsV1ApiApproveApprovalInBulkV1 + */ + readonly bulkapproverequestdtoV1: BulkapproverequestdtoV1 +} + +/** + * Request parameters for approveApprovalV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiApproveApprovalV1Request + */ +export interface ApprovalsV1ApiApproveApprovalV1Request { + /** + * Approval ID that correlates to an existing approval request that a user wants to approve. + * @type {string} + * @memberof ApprovalsV1ApiApproveApprovalV1 + */ + readonly id: string + + /** + * + * @type {ApprovalapproverequestV1} + * @memberof ApprovalsV1ApiApproveApprovalV1 + */ + readonly approvalapproverequestV1?: ApprovalapproverequestV1 +} + +/** + * Request parameters for cancelApprovalByIdV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiCancelApprovalByIdV1Request + */ +export interface ApprovalsV1ApiCancelApprovalByIdV1Request { + /** + * ID of the approval request to cancel. + * @type {string} + * @memberof ApprovalsV1ApiCancelApprovalByIdV1 + */ + readonly id: string + + /** + * + * @type {ApprovalcancelrequestV1} + * @memberof ApprovalsV1ApiCancelApprovalByIdV1 + */ + readonly approvalcancelrequestV1?: ApprovalcancelrequestV1 +} + +/** + * Request parameters for cancelApprovalV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiCancelApprovalV1Request + */ +export interface ApprovalsV1ApiCancelApprovalV1Request { + /** + * + * @type {BulkcancelrequestdtoV1} + * @memberof ApprovalsV1ApiCancelApprovalV1 + */ + readonly bulkcancelrequestdtoV1: BulkcancelrequestdtoV1 +} + +/** + * Request parameters for deleteApprovalConfigRequestV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiDeleteApprovalConfigRequestV1Request + */ +export interface ApprovalsV1ApiDeleteApprovalConfigRequestV1Request { + /** + * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @type {string} + * @memberof ApprovalsV1ApiDeleteApprovalConfigRequestV1 + */ + readonly id: string + + /** + * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} + * @memberof ApprovalsV1ApiDeleteApprovalConfigRequestV1 + */ + readonly scope: DeleteApprovalConfigRequestV1ScopeV1 +} + +/** + * Request parameters for getApprovalV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiGetApprovalV1Request + */ +export interface ApprovalsV1ApiGetApprovalV1Request { + /** + * ID of the approval that is to be returned + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalV1 + */ + readonly id: string +} + +/** + * Request parameters for getApprovalsConfigV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiGetApprovalsConfigV1Request + */ +export interface ApprovalsV1ApiGetApprovalsConfigV1Request { + /** + * The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalsConfigV1 + */ + readonly id: string +} + +/** + * Request parameters for getApprovalsV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiGetApprovalsV1Request + */ +export interface ApprovalsV1ApiGetApprovalsV1Request { + /** + * Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly mine?: boolean + + /** + * Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly requesterId?: string + + /** + * Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly requesteeId?: string + + /** + * Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly approverId?: string + + /** + * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly count?: boolean + + /** + * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly countOnly?: boolean + + /** + * If set to true in the query, the approval requests returned will include comments. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly includeComments?: boolean + + /** + * If set to true in the query, the approval requests returned will include approvers. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly includeApprovers?: boolean + + /** + * If set to true in the query, the approval requests returned will include reassignment history. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly includeReassignmentHistory?: boolean + + /** + * If set to true in the query, the approval requests returned will include batch information. + * @type {boolean} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly includeBatchInfo?: 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* + * @type {string} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ApprovalsV1ApiGetApprovalsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for moveApprovalV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiMoveApprovalV1Request + */ +export interface ApprovalsV1ApiMoveApprovalV1Request { + /** + * + * @type {BulkreassignrequestdtoV1} + * @memberof ApprovalsV1ApiMoveApprovalV1 + */ + readonly bulkreassignrequestdtoV1: BulkreassignrequestdtoV1 +} + +/** + * Request parameters for putApprovalsConfigV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiPutApprovalsConfigV1Request + */ +export interface ApprovalsV1ApiPutApprovalsConfigV1Request { + /** + * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @type {string} + * @memberof ApprovalsV1ApiPutApprovalsConfigV1 + */ + readonly id: string + + /** + * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT + * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} + * @memberof ApprovalsV1ApiPutApprovalsConfigV1 + */ + readonly scope: PutApprovalsConfigV1ScopeV1 + + /** + * + * @type {ApprovalconfigV1} + * @memberof ApprovalsV1ApiPutApprovalsConfigV1 + */ + readonly approvalconfigV1: ApprovalconfigV1 +} + +/** + * Request parameters for rejectApprovalInBulkV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiRejectApprovalInBulkV1Request + */ +export interface ApprovalsV1ApiRejectApprovalInBulkV1Request { + /** + * + * @type {BulkrejectrequestdtoV1} + * @memberof ApprovalsV1ApiRejectApprovalInBulkV1 + */ + readonly bulkrejectrequestdtoV1: BulkrejectrequestdtoV1 +} + +/** + * Request parameters for rejectApprovalV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiRejectApprovalV1Request + */ +export interface ApprovalsV1ApiRejectApprovalV1Request { + /** + * Approval ID that correlates to an existing approval request that a user wants to reject. + * @type {string} + * @memberof ApprovalsV1ApiRejectApprovalV1 + */ + readonly id: string + + /** + * + * @type {ApprovalrejectrequestV1} + * @memberof ApprovalsV1ApiRejectApprovalV1 + */ + readonly approvalrejectrequestV1?: ApprovalrejectrequestV1 +} + +/** + * Request parameters for updateApprovalsAttributesV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiUpdateApprovalsAttributesV1Request + */ +export interface ApprovalsV1ApiUpdateApprovalsAttributesV1Request { + /** + * Approval ID that correlates to an existing approval request that a user wants to change the attributes of. + * @type {string} + * @memberof ApprovalsV1ApiUpdateApprovalsAttributesV1 + */ + readonly id: string + + /** + * + * @type {ApprovalattributesrequestV1} + * @memberof ApprovalsV1ApiUpdateApprovalsAttributesV1 + */ + readonly approvalattributesrequestV1: ApprovalattributesrequestV1 +} + +/** + * Request parameters for updateApprovalsCommentsV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiUpdateApprovalsCommentsV1Request + */ +export interface ApprovalsV1ApiUpdateApprovalsCommentsV1Request { + /** + * Approval ID that correlates to an existing approval request that a user wants to add a comment to. + * @type {string} + * @memberof ApprovalsV1ApiUpdateApprovalsCommentsV1 + */ + readonly id: string + + /** + * + * @type {ApprovalcommentsrequestV1} + * @memberof ApprovalsV1ApiUpdateApprovalsCommentsV1 + */ + readonly approvalcommentsrequestV1: ApprovalcommentsrequestV1 +} + +/** + * Request parameters for updateApprovalsReassignV1 operation in ApprovalsV1Api. + * @export + * @interface ApprovalsV1ApiUpdateApprovalsReassignV1Request + */ +export interface ApprovalsV1ApiUpdateApprovalsReassignV1Request { + /** + * Approval ID that correlates to an existing approval request that a user wants to reassign. + * @type {string} + * @memberof ApprovalsV1ApiUpdateApprovalsReassignV1 + */ + readonly id: string + + /** + * + * @type {ApprovalreassignrequestV1} + * @memberof ApprovalsV1ApiUpdateApprovalsReassignV1 + */ + readonly approvalreassignrequestV1: ApprovalreassignrequestV1 +} + +/** + * ApprovalsV1Api - object-oriented interface + * @export + * @class ApprovalsV1Api + * @extends {BaseAPI} + */ +export class ApprovalsV1Api extends BaseAPI { + /** + * Bulk Approves specified approval requests on behalf of the caller + * @summary Post Bulk Approve Approvals + * @param {ApprovalsV1ApiApproveApprovalInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public approveApprovalInBulkV1(requestParameters: ApprovalsV1ApiApproveApprovalInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).approveApprovalInBulkV1(requestParameters.bulkapproverequestdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. + * @summary Post Approvals Approve + * @param {ApprovalsV1ApiApproveApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public approveApprovalV1(requestParameters: ApprovalsV1ApiApproveApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).approveApprovalV1(requestParameters.id, requestParameters.approvalapproverequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel + * @summary Post Approval Cancel + * @param {ApprovalsV1ApiCancelApprovalByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public cancelApprovalByIdV1(requestParameters: ApprovalsV1ApiCancelApprovalByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).cancelApprovalByIdV1(requestParameters.id, requestParameters.approvalcancelrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel + * @summary Post Bulk Cancel Approvals + * @param {ApprovalsV1ApiCancelApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public cancelApprovalV1(requestParameters: ApprovalsV1ApiCancelApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).cancelApprovalV1(requestParameters.bulkcancelrequestdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. + * @summary Delete Approval Configuration + * @param {ApprovalsV1ApiDeleteApprovalConfigRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public deleteApprovalConfigRequestV1(requestParameters: ApprovalsV1ApiDeleteApprovalConfigRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).deleteApprovalConfigRequestV1(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" + * @summary Get an approval + * @param {ApprovalsV1ApiGetApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public getApprovalV1(requestParameters: ApprovalsV1ApiGetApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).getApprovalV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a singular approval configuration that matches the given ID + * @summary Get Approval Config + * @param {ApprovalsV1ApiGetApprovalsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public getApprovalsConfigV1(requestParameters: ApprovalsV1ApiGetApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).getApprovalsConfigV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' + * @summary Get approvals + * @param {ApprovalsV1ApiGetApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public getApprovalsV1(requestParameters: ApprovalsV1ApiGetApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).getApprovalsV1(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk reassigns specified approval requests on behalf of the caller + * @summary Post Bulk Reassign Approvals + * @param {ApprovalsV1ApiMoveApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public moveApprovalV1(requestParameters: ApprovalsV1ApiMoveApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).moveApprovalV1(requestParameters.bulkreassignrequestdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' + * @summary Put Approval Config + * @param {ApprovalsV1ApiPutApprovalsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public putApprovalsConfigV1(requestParameters: ApprovalsV1ApiPutApprovalsConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).putApprovalsConfigV1(requestParameters.id, requestParameters.scope, requestParameters.approvalconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Bulk reject specified approval requests on behalf of the caller + * @summary Post Bulk Reject Approvals + * @param {ApprovalsV1ApiRejectApprovalInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public rejectApprovalInBulkV1(requestParameters: ApprovalsV1ApiRejectApprovalInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).rejectApprovalInBulkV1(requestParameters.bulkrejectrequestdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. + * @summary Post Approvals Reject + * @param {ApprovalsV1ApiRejectApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public rejectApprovalV1(requestParameters: ApprovalsV1ApiRejectApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).rejectApprovalV1(requestParameters.id, requestParameters.approvalrejectrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Attributes + * @param {ApprovalsV1ApiUpdateApprovalsAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public updateApprovalsAttributesV1(requestParameters: ApprovalsV1ApiUpdateApprovalsAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).updateApprovalsAttributesV1(requestParameters.id, requestParameters.approvalattributesrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Adds comments to a specified approval request. This endpoint does not support access request IDs. + * @summary Post Approvals Comments + * @param {ApprovalsV1ApiUpdateApprovalsCommentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public updateApprovalsCommentsV1(requestParameters: ApprovalsV1ApiUpdateApprovalsCommentsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).updateApprovalsCommentsV1(requestParameters.id, requestParameters.approvalcommentsrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. + * @summary Post Approvals Reassign + * @param {ApprovalsV1ApiUpdateApprovalsReassignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ApprovalsV1Api + */ + public updateApprovalsReassignV1(requestParameters: ApprovalsV1ApiUpdateApprovalsReassignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ApprovalsV1ApiFp(this.configuration).updateApprovalsReassignV1(requestParameters.id, requestParameters.approvalreassignrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DeleteApprovalConfigRequestV1ScopeV1 = { + DomainObject: 'DOMAIN_OBJECT', + Role: 'ROLE', + AccessProfile: 'ACCESS_PROFILE', + Entitlement: 'ENTITLEMENT', + ApprovalType: 'APPROVAL_TYPE', + Tenant: 'TENANT' +} as const; +export type DeleteApprovalConfigRequestV1ScopeV1 = typeof DeleteApprovalConfigRequestV1ScopeV1[keyof typeof DeleteApprovalConfigRequestV1ScopeV1]; +/** + * @export + */ +export const PutApprovalsConfigV1ScopeV1 = { + DomainObject: 'DOMAIN_OBJECT', + Role: 'ROLE', + AccessProfile: 'ACCESS_PROFILE', + Entitlement: 'ENTITLEMENT', + ApprovalType: 'APPROVAL_TYPE', + Tenant: 'TENANT' +} as const; +export type PutApprovalsConfigV1ScopeV1 = typeof PutApprovalsConfigV1ScopeV1[keyof typeof PutApprovalsConfigV1ScopeV1]; + + diff --git a/sdk-output/approvals/base.ts b/sdk-output/approvals/base.ts new file mode 100644 index 00000000..ef949e33 --- /dev/null +++ b/sdk-output/approvals/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Approvals + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/approvals/common.ts b/sdk-output/approvals/common.ts new file mode 100644 index 00000000..f261e323 --- /dev/null +++ b/sdk-output/approvals/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Approvals + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/approvals/configuration.ts b/sdk-output/approvals/configuration.ts new file mode 100644 index 00000000..594f1411 --- /dev/null +++ b/sdk-output/approvals/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Approvals + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/approvals/git_push.sh b/sdk-output/approvals/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/approvals/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/approvals/index.ts b/sdk-output/approvals/index.ts new file mode 100644 index 00000000..04c4a99c --- /dev/null +++ b/sdk-output/approvals/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Approvals + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/approvals/package.json b/sdk-output/approvals/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/approvals/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/approvals/tsconfig.json b/sdk-output/approvals/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/approvals/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/apps/.gitignore b/sdk-output/apps/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/apps/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/apps/.npmignore b/sdk-output/apps/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/apps/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/apps/.openapi-generator-ignore b/sdk-output/apps/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/apps/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/apps/.openapi-generator/FILES b/sdk-output/apps/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/apps/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/apps/.openapi-generator/VERSION b/sdk-output/apps/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/apps/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/apps/.sdk-partition b/sdk-output/apps/.sdk-partition new file mode 100644 index 00000000..03736e32 --- /dev/null +++ b/sdk-output/apps/.sdk-partition @@ -0,0 +1 @@ +apps \ No newline at end of file diff --git a/sdk-output/apps/README.md b/sdk-output/apps/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/apps/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/apps/api.ts b/sdk-output/apps/api.ts new file mode 100644 index 00000000..80b967f8 --- /dev/null +++ b/sdk-output/apps/api.ts @@ -0,0 +1,2796 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Apps + * 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'; + +/** + * How to select account when there are multiple accounts for the user + * @export + * @interface AccessprofiledetailsAccountSelectorV1 + */ +export interface AccessprofiledetailsAccountSelectorV1 { + /** + * + * @type {Array} + * @memberof AccessprofiledetailsAccountSelectorV1 + */ + 'selectors'?: Array | null; +} +/** + * + * @export + * @interface AccessprofiledetailsV1 + */ +export interface AccessprofiledetailsV1 { + /** + * The ID of the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'id'?: string; + /** + * Name of the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'name'?: string; + /** + * Information about the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'description'?: string | null; + /** + * Date the Access Profile was created + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'created'?: string; + /** + * Date the Access Profile was last modified. + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'modified'?: string; + /** + * Whether the Access Profile is enabled. + * @type {boolean} + * @memberof AccessprofiledetailsV1 + */ + 'disabled'?: boolean; + /** + * Whether the Access Profile is requestable via access request. + * @type {boolean} + * @memberof AccessprofiledetailsV1 + */ + 'requestable'?: boolean; + /** + * Whether the Access Profile is protected. + * @type {boolean} + * @memberof AccessprofiledetailsV1 + */ + 'protected'?: boolean; + /** + * The owner ID of the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'ownerId'?: string; + /** + * The source ID of the Access Profile + * @type {number} + * @memberof AccessprofiledetailsV1 + */ + 'sourceId'?: number | null; + /** + * The source name of the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'sourceName'?: string; + /** + * The source app ID of the Access Profile + * @type {number} + * @memberof AccessprofiledetailsV1 + */ + 'appId'?: number | null; + /** + * The source app name of the Access Profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'appName'?: string | null; + /** + * The id of the application + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'applicationId'?: string; + /** + * The type of the access profile + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'type'?: string; + /** + * List of IDs of entitlements + * @type {Array} + * @memberof AccessprofiledetailsV1 + */ + 'entitlements'?: Array; + /** + * The number of entitlements in the access profile + * @type {number} + * @memberof AccessprofiledetailsV1 + */ + 'entitlementCount'?: number; + /** + * List of IDs of segments, if any, to which this Access Profile is assigned. + * @type {Array} + * @memberof AccessprofiledetailsV1 + */ + 'segments'?: Array; + /** + * Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'approvalSchemes'?: string; + /** + * Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> + * @type {string} + * @memberof AccessprofiledetailsV1 + */ + 'revokeRequestApprovalSchemes'?: string; + /** + * Whether the access profile require request comment for access request. + * @type {boolean} + * @memberof AccessprofiledetailsV1 + */ + 'requestCommentsRequired'?: boolean; + /** + * Whether denied comment is required when access request is denied. + * @type {boolean} + * @memberof AccessprofiledetailsV1 + */ + 'deniedCommentsRequired'?: boolean; + /** + * + * @type {AccessprofiledetailsAccountSelectorV1} + * @memberof AccessprofiledetailsV1 + */ + 'accountSelector'?: AccessprofiledetailsAccountSelectorV1; +} +/** + * + * @export + * @interface AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 + */ +export interface AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 { + /** + * + * @type {Array} + * @memberof AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 + */ + 'matchTerms'?: Array; + /** + * If it is AND operators for match terms + * @type {boolean} + * @memberof AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 + */ + 'and'?: boolean; +} +/** + * + * @export + * @interface AppaccessprofileselectorAccountMatchConfigV1 + */ +export interface AppaccessprofileselectorAccountMatchConfigV1 { + /** + * + * @type {AppaccessprofileselectorAccountMatchConfigMatchExpressionV1} + * @memberof AppaccessprofileselectorAccountMatchConfigV1 + */ + 'matchExpression'?: AppaccessprofileselectorAccountMatchConfigMatchExpressionV1; +} +/** + * + * @export + * @interface AppaccessprofileselectorV1 + */ +export interface AppaccessprofileselectorV1 { + /** + * The application id + * @type {string} + * @memberof AppaccessprofileselectorV1 + */ + 'applicationId'?: string; + /** + * + * @type {AppaccessprofileselectorAccountMatchConfigV1} + * @memberof AppaccessprofileselectorV1 + */ + 'accountMatchConfig'?: AppaccessprofileselectorAccountMatchConfigV1; +} +/** + * + * @export + * @interface AppaccountdetailsSourceAccountV1 + */ +export interface AppaccountdetailsSourceAccountV1 { + /** + * The account ID + * @type {string} + * @memberof AppaccountdetailsSourceAccountV1 + */ + 'id'?: string; + /** + * The native identity of account + * @type {string} + * @memberof AppaccountdetailsSourceAccountV1 + */ + 'nativeIdentity'?: string; + /** + * The display name of account + * @type {string} + * @memberof AppaccountdetailsSourceAccountV1 + */ + 'displayName'?: string; + /** + * The source ID of account + * @type {string} + * @memberof AppaccountdetailsSourceAccountV1 + */ + 'sourceId'?: string; + /** + * The source name of account + * @type {string} + * @memberof AppaccountdetailsSourceAccountV1 + */ + 'sourceDisplayName'?: string; +} +/** + * + * @export + * @interface AppaccountdetailsV1 + */ +export interface AppaccountdetailsV1 { + /** + * The source app ID + * @type {string} + * @memberof AppaccountdetailsV1 + */ + 'appId'?: string; + /** + * The source app display name + * @type {string} + * @memberof AppaccountdetailsV1 + */ + 'appDisplayName'?: string; + /** + * + * @type {AppaccountdetailsSourceAccountV1} + * @memberof AppaccountdetailsV1 + */ + 'sourceAccount'?: AppaccountdetailsSourceAccountV1; +} +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetSourceAppV1401ResponseV1 + */ +export interface GetSourceAppV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSourceAppV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetSourceAppV1429ResponseV1 + */ +export interface GetSourceAppV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSourceAppV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MatchtermV1 + */ +export interface MatchtermV1 { + /** + * The attribute name + * @type {string} + * @memberof MatchtermV1 + */ + 'name'?: string; + /** + * The attribute value + * @type {string} + * @memberof MatchtermV1 + */ + 'value'?: string; + /** + * The operator between name and value + * @type {string} + * @memberof MatchtermV1 + */ + 'op'?: string; + /** + * If it is a container or a real match term + * @type {boolean} + * @memberof MatchtermV1 + */ + 'container'?: boolean; + /** + * If it is AND logical operator for the children match terms + * @type {boolean} + * @memberof MatchtermV1 + */ + 'and'?: boolean; + /** + * The children under this match term + * @type {Array<{ [key: string]: any; }>} + * @memberof MatchtermV1 + */ + 'children'?: Array<{ [key: string]: any; }> | null; +} +/** + * + * @export + * @interface SourceappAccountSourceV1 + */ +export interface SourceappAccountSourceV1 { + /** + * The source ID + * @type {string} + * @memberof SourceappAccountSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof SourceappAccountSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof SourceappAccountSourceV1 + */ + 'name'?: string; + /** + * If the source is used for password management + * @type {boolean} + * @memberof SourceappAccountSourceV1 + */ + 'useForPasswordManagement'?: boolean; + /** + * The password policies for the source + * @type {Array} + * @memberof SourceappAccountSourceV1 + */ + 'passwordPolicies'?: Array | null; +} +/** + * + * @export + * @interface SourceappV1 + */ +export interface SourceappV1 { + /** + * The source app id + * @type {string} + * @memberof SourceappV1 + */ + 'id'?: string; + /** + * The deprecated source app id + * @type {string} + * @memberof SourceappV1 + */ + 'cloudAppId'?: string; + /** + * The source app name + * @type {string} + * @memberof SourceappV1 + */ + 'name'?: string; + /** + * Time when the source app was created + * @type {string} + * @memberof SourceappV1 + */ + 'created'?: string; + /** + * Time when the source app was last modified + * @type {string} + * @memberof SourceappV1 + */ + 'modified'?: string; + /** + * True if the source app is enabled + * @type {boolean} + * @memberof SourceappV1 + */ + 'enabled'?: boolean; + /** + * True if the app allows access request + * @type {boolean} + * @memberof SourceappV1 + */ + 'provisionRequestEnabled'?: boolean; + /** + * The description of the source app + * @type {string} + * @memberof SourceappV1 + */ + 'description'?: string; + /** + * True if the source app match all accounts + * @type {boolean} + * @memberof SourceappV1 + */ + 'matchAllAccounts'?: boolean; + /** + * True if the app is visible in the request center + * @type {boolean} + * @memberof SourceappV1 + */ + 'appCenterEnabled'?: boolean; + /** + * + * @type {SourceappAccountSourceV1} + * @memberof SourceappV1 + */ + 'accountSource'?: SourceappAccountSourceV1 | null; + /** + * The owner of source app + * @type {BasereferencedtoV1} + * @memberof SourceappV1 + */ + 'owner'?: BasereferencedtoV1 | null; +} +/** + * + * @export + * @interface SourceappbulkupdaterequestV1 + */ +export interface SourceappbulkupdaterequestV1 { + /** + * List of source app ids to update + * @type {Array} + * @memberof SourceappbulkupdaterequestV1 + */ + 'appIds': Array; + /** + * The JSONPatch payload used to update the source app. + * @type {Array} + * @memberof SourceappbulkupdaterequestV1 + */ + 'jsonPatch': Array; +} +/** + * + * @export + * @interface SourceappcreatedtoAccountSourceV1 + */ +export interface SourceappcreatedtoAccountSourceV1 { + /** + * The source ID + * @type {string} + * @memberof SourceappcreatedtoAccountSourceV1 + */ + 'id': string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof SourceappcreatedtoAccountSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof SourceappcreatedtoAccountSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface SourceappcreatedtoV1 + */ +export interface SourceappcreatedtoV1 { + /** + * The source app name + * @type {string} + * @memberof SourceappcreatedtoV1 + */ + 'name': string; + /** + * The description of the source app + * @type {string} + * @memberof SourceappcreatedtoV1 + */ + 'description': string; + /** + * True if the source app match all accounts + * @type {boolean} + * @memberof SourceappcreatedtoV1 + */ + 'matchAllAccounts'?: boolean; + /** + * + * @type {SourceappcreatedtoAccountSourceV1} + * @memberof SourceappcreatedtoV1 + */ + 'accountSource': SourceappcreatedtoAccountSourceV1; +} +/** + * + * @export + * @interface SourceapppatchdtoV1 + */ +export interface SourceapppatchdtoV1 { + /** + * The source app id + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'id'?: string; + /** + * The deprecated source app id + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'cloudAppId'?: string; + /** + * The source app name + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'name'?: string; + /** + * Time when the source app was created + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'created'?: string; + /** + * Time when the source app was last modified + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'modified'?: string; + /** + * True if the source app is enabled + * @type {boolean} + * @memberof SourceapppatchdtoV1 + */ + 'enabled'?: boolean; + /** + * True if the app allows access request + * @type {boolean} + * @memberof SourceapppatchdtoV1 + */ + 'provisionRequestEnabled'?: boolean; + /** + * The description of the source app + * @type {string} + * @memberof SourceapppatchdtoV1 + */ + 'description'?: string; + /** + * True if the source app match all accounts + * @type {boolean} + * @memberof SourceapppatchdtoV1 + */ + 'matchAllAccounts'?: boolean; + /** + * True if the app is visible in the request center + * @type {boolean} + * @memberof SourceapppatchdtoV1 + */ + 'appCenterEnabled'?: boolean; + /** + * List of IDs of access profiles + * @type {Array} + * @memberof SourceapppatchdtoV1 + */ + 'accessProfiles'?: Array | null; + /** + * + * @type {SourceappAccountSourceV1} + * @memberof SourceapppatchdtoV1 + */ + 'accountSource'?: SourceappAccountSourceV1 | null; + /** + * The owner of source app + * @type {BasereferencedtoV1} + * @memberof SourceapppatchdtoV1 + */ + 'owner'?: BasereferencedtoV1 | null; +} +/** + * + * @export + * @interface UserappAccountV1 + */ +export interface UserappAccountV1 { + /** + * the account ID + * @type {string} + * @memberof UserappAccountV1 + */ + 'id'?: string; + /** + * It will always be \"ACCOUNT\" + * @type {string} + * @memberof UserappAccountV1 + */ + 'type'?: string; + /** + * the account name + * @type {string} + * @memberof UserappAccountV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface UserappOwnerV1 + */ +export interface UserappOwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof UserappOwnerV1 + */ + 'id'?: string; + /** + * It will always be \"IDENTITY\" + * @type {string} + * @memberof UserappOwnerV1 + */ + 'type'?: string; + /** + * The identity name + * @type {string} + * @memberof UserappOwnerV1 + */ + 'name'?: string; + /** + * The identity alias + * @type {string} + * @memberof UserappOwnerV1 + */ + 'alias'?: string; +} +/** + * + * @export + * @interface UserappSourceAppV1 + */ +export interface UserappSourceAppV1 { + /** + * the source app ID + * @type {string} + * @memberof UserappSourceAppV1 + */ + 'id'?: string; + /** + * It will always be \"APPLICATION\" + * @type {string} + * @memberof UserappSourceAppV1 + */ + 'type'?: string; + /** + * the source app name + * @type {string} + * @memberof UserappSourceAppV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface UserappSourceV1 + */ +export interface UserappSourceV1 { + /** + * the source ID + * @type {string} + * @memberof UserappSourceV1 + */ + 'id'?: string; + /** + * It will always be \"SOURCE\" + * @type {string} + * @memberof UserappSourceV1 + */ + 'type'?: string; + /** + * the source name + * @type {string} + * @memberof UserappSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface UserappV1 + */ +export interface UserappV1 { + /** + * The user app id + * @type {string} + * @memberof UserappV1 + */ + 'id'?: string; + /** + * Time when the user app was created + * @type {string} + * @memberof UserappV1 + */ + 'created'?: string; + /** + * Time when the user app was last modified + * @type {string} + * @memberof UserappV1 + */ + 'modified'?: string; + /** + * True if the owner has multiple accounts for the source + * @type {boolean} + * @memberof UserappV1 + */ + 'hasMultipleAccounts'?: boolean; + /** + * True if the source has password feature + * @type {boolean} + * @memberof UserappV1 + */ + 'useForPasswordManagement'?: boolean; + /** + * True if the app allows access request + * @type {boolean} + * @memberof UserappV1 + */ + 'provisionRequestEnabled'?: boolean; + /** + * True if the app is visible in the request center + * @type {boolean} + * @memberof UserappV1 + */ + 'appCenterEnabled'?: boolean; + /** + * + * @type {UserappSourceAppV1} + * @memberof UserappV1 + */ + 'sourceApp'?: UserappSourceAppV1; + /** + * + * @type {UserappSourceV1} + * @memberof UserappV1 + */ + 'source'?: UserappSourceV1; + /** + * + * @type {UserappAccountV1} + * @memberof UserappV1 + */ + 'account'?: UserappAccountV1; + /** + * + * @type {UserappOwnerV1} + * @memberof UserappV1 + */ + 'owner'?: UserappOwnerV1; +} + +/** + * AppsV1Api - axios parameter creator + * @export + */ +export const AppsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This endpoint creates a source app using the given source app payload + * @summary Create source app + * @param {SourceappcreatedtoV1} sourceappcreatedtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceAppV1: async (sourceappcreatedtoV1: SourceappcreatedtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceappcreatedtoV1' is not null or undefined + assertParamExists('createSourceAppV1', 'sourceappcreatedtoV1', sourceappcreatedtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sourceappcreatedtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the final list of access profiles for the specified source app after removing + * @summary Bulk remove access profiles from the specified source app + * @param {string} id ID of the source app + * @param {Array} requestBody List of access profile IDs for removal + * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfilesFromSourceAppByBulkV1: async (id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccessProfilesFromSourceAppByBulkV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('deleteAccessProfilesFromSourceAppByBulkV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/v1/{id}/access-profiles/bulk-remove` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to delete a specific source app + * @summary Delete source app by id + * @param {string} id source app ID. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceAppV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSourceAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a source app by its ID. + * @summary Get source app by id + * @param {string} id ID of the source app + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceAppV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSourceAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of access profiles for the specified source app + * @summary List access profiles for the specified source app + * @param {string} id ID of the source app + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessProfilesForSourceAppV1: async (id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listAccessProfilesForSourceAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/v1/{id}/access-profiles` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of all source apps for the org. + * @summary List all source apps + * @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 {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 {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, name, created, modified, owner.id, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllSourceAppV1: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/v1/all`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. + * @summary List all user apps + * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllUserAppsV1: async (filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'filters' is not null or undefined + assertParamExists('listAllUserAppsV1', 'filters', filters) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/user-apps/v1/all`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of source apps assigned for logged in user. + * @summary List assigned source apps + * @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 {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 {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, name, created, modified, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAssignedSourceAppV1: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/v1/assigned`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + * @summary List available accounts for user app + * @param {string} id ID of the user app + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAvailableAccountsForUserAppV1: async (id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listAvailableAccountsForUserAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/user-apps/v1/{id}/available-accounts` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of source apps available for access request. + * @summary List available source apps + * @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 {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 {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, name, created, modified, owner.id, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAvailableSourceAppsV1: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of user apps assigned to logged in user + * @summary List owned user apps + * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOwnedUserAppsV1: async (limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/user-apps/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Patch source app by id + * @param {string} id ID of the source app to patch + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSourceAppV1: async (id: string, xSailPointExperimental?: string, jsonpatchoperationV1?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSourceAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** + * @summary Patch user app by id + * @param {string} id ID of the user app to patch + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchUserAppV1: async (id: string, xSailPointExperimental?: string, jsonpatchoperationV1?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchUserAppV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/user-apps/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Bulk update source apps + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {SourceappbulkupdaterequestV1} [sourceappbulkupdaterequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceAppsInBulkV1: async (xSailPointExperimental?: string, sourceappbulkupdaterequestV1?: SourceappbulkupdaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-apps/v1/bulk-update`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sourceappbulkupdaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AppsV1Api - functional programming interface + * @export + */ +export const AppsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AppsV1ApiAxiosParamCreator(configuration) + return { + /** + * This endpoint creates a source app using the given source app payload + * @summary Create source app + * @param {SourceappcreatedtoV1} sourceappcreatedtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourceAppV1(sourceappcreatedtoV1: SourceappcreatedtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceAppV1(sourceappcreatedtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.createSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the final list of access profiles for the specified source app after removing + * @summary Bulk remove access profiles from the specified source app + * @param {string} id ID of the source app + * @param {Array} requestBody List of access profile IDs for removal + * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccessProfilesFromSourceAppByBulkV1(id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesFromSourceAppByBulkV1(id, requestBody, limit, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.deleteAccessProfilesFromSourceAppByBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete a specific source app + * @summary Delete source app by id + * @param {string} id source app ID. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSourceAppV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceAppV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.deleteSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a source app by its ID. + * @summary Get source app by id + * @param {string} id ID of the source app + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceAppV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAppV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.getSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of access profiles for the specified source app + * @summary List access profiles for the specified source app + * @param {string} id ID of the source app + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAccessProfilesForSourceAppV1(id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesForSourceAppV1(id, limit, offset, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAccessProfilesForSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of all source apps for the org. + * @summary List all source apps + * @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 {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 {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, name, created, modified, owner.id, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAllSourceAppV1(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAllSourceAppV1(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAllSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. + * @summary List all user apps + * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAllUserAppsV1(filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAllUserAppsV1(filters, limit, count, offset, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAllUserAppsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of source apps assigned for logged in user. + * @summary List assigned source apps + * @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 {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 {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, name, created, modified, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAssignedSourceAppV1(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignedSourceAppV1(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAssignedSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + * @summary List available accounts for user app + * @param {string} id ID of the user app + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAvailableAccountsForUserAppV1(id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAccountsForUserAppV1(id, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAvailableAccountsForUserAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of source apps available for access request. + * @summary List available source apps + * @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 {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 {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, name, created, modified, owner.id, accountSource.id** + * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAvailableSourceAppsV1(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableSourceAppsV1(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listAvailableSourceAppsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of user apps assigned to logged in user + * @summary List owned user apps + * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listOwnedUserAppsV1(limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnedUserAppsV1(limit, count, offset, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.listOwnedUserAppsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Patch source app by id + * @param {string} id ID of the source app to patch + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSourceAppV1(id: string, xSailPointExperimental?: string, jsonpatchoperationV1?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSourceAppV1(id, xSailPointExperimental, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.patchSourceAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** + * @summary Patch user app by id + * @param {string} id ID of the user app to patch + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchUserAppV1(id: string, xSailPointExperimental?: string, jsonpatchoperationV1?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchUserAppV1(id, xSailPointExperimental, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.patchUserAppV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Bulk update source apps + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {SourceappbulkupdaterequestV1} [sourceappbulkupdaterequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSourceAppsInBulkV1(xSailPointExperimental?: string, sourceappbulkupdaterequestV1?: SourceappbulkupdaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceAppsInBulkV1(xSailPointExperimental, sourceappbulkupdaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AppsV1Api.updateSourceAppsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AppsV1Api - factory interface + * @export + */ +export const AppsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AppsV1ApiFp(configuration) + return { + /** + * This endpoint creates a source app using the given source app payload + * @summary Create source app + * @param {AppsV1ApiCreateSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceAppV1(requestParameters: AppsV1ApiCreateSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourceAppV1(requestParameters.sourceappcreatedtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the final list of access profiles for the specified source app after removing + * @summary Bulk remove access profiles from the specified source app + * @param {AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessProfilesFromSourceAppByBulkV1(requestParameters: AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.deleteAccessProfilesFromSourceAppByBulkV1(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete a specific source app + * @summary Delete source app by id + * @param {AppsV1ApiDeleteSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceAppV1(requestParameters: AppsV1ApiDeleteSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a source app by its ID. + * @summary Get source app by id + * @param {AppsV1ApiGetSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceAppV1(requestParameters: AppsV1ApiGetSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of access profiles for the specified source app + * @summary List access profiles for the specified source app + * @param {AppsV1ApiListAccessProfilesForSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAccessProfilesForSourceAppV1(requestParameters: AppsV1ApiListAccessProfilesForSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAccessProfilesForSourceAppV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of all source apps for the org. + * @summary List all source apps + * @param {AppsV1ApiListAllSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllSourceAppV1(requestParameters: AppsV1ApiListAllSourceAppV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAllSourceAppV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. + * @summary List all user apps + * @param {AppsV1ApiListAllUserAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllUserAppsV1(requestParameters: AppsV1ApiListAllUserAppsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAllUserAppsV1(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of source apps assigned for logged in user. + * @summary List assigned source apps + * @param {AppsV1ApiListAssignedSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAssignedSourceAppV1(requestParameters: AppsV1ApiListAssignedSourceAppV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAssignedSourceAppV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + * @summary List available accounts for user app + * @param {AppsV1ApiListAvailableAccountsForUserAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAvailableAccountsForUserAppV1(requestParameters: AppsV1ApiListAvailableAccountsForUserAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAvailableAccountsForUserAppV1(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of source apps available for access request. + * @summary List available source apps + * @param {AppsV1ApiListAvailableSourceAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAvailableSourceAppsV1(requestParameters: AppsV1ApiListAvailableSourceAppsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAvailableSourceAppsV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of user apps assigned to logged in user + * @summary List owned user apps + * @param {AppsV1ApiListOwnedUserAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOwnedUserAppsV1(requestParameters: AppsV1ApiListOwnedUserAppsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listOwnedUserAppsV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Patch source app by id + * @param {AppsV1ApiPatchSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSourceAppV1(requestParameters: AppsV1ApiPatchSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** + * @summary Patch user app by id + * @param {AppsV1ApiPatchUserAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchUserAppV1(requestParameters: AppsV1ApiPatchUserAppV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchUserAppV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Bulk update source apps + * @param {AppsV1ApiUpdateSourceAppsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceAppsInBulkV1(requestParameters: AppsV1ApiUpdateSourceAppsInBulkV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSourceAppsInBulkV1(requestParameters.xSailPointExperimental, requestParameters.sourceappbulkupdaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiCreateSourceAppV1Request + */ +export interface AppsV1ApiCreateSourceAppV1Request { + /** + * + * @type {SourceappcreatedtoV1} + * @memberof AppsV1ApiCreateSourceAppV1 + */ + readonly sourceappcreatedtoV1: SourceappcreatedtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiCreateSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteAccessProfilesFromSourceAppByBulkV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request + */ +export interface AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request { + /** + * ID of the source app + * @type {string} + * @memberof AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1 + */ + readonly id: string + + /** + * List of access profile IDs for removal + * @type {Array} + * @memberof AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1 + */ + readonly requestBody: Array + + /** + * 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 AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1 + */ + readonly limit?: number + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiDeleteSourceAppV1Request + */ +export interface AppsV1ApiDeleteSourceAppV1Request { + /** + * source app ID. + * @type {string} + * @memberof AppsV1ApiDeleteSourceAppV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiDeleteSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiGetSourceAppV1Request + */ +export interface AppsV1ApiGetSourceAppV1Request { + /** + * ID of the source app + * @type {string} + * @memberof AppsV1ApiGetSourceAppV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiGetSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAccessProfilesForSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAccessProfilesForSourceAppV1Request + */ +export interface AppsV1ApiListAccessProfilesForSourceAppV1Request { + /** + * ID of the source app + * @type {string} + * @memberof AppsV1ApiListAccessProfilesForSourceAppV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AppsV1ApiListAccessProfilesForSourceAppV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AppsV1ApiListAccessProfilesForSourceAppV1 + */ + readonly offset?: number + + /** + * 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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + * @type {string} + * @memberof AppsV1ApiListAccessProfilesForSourceAppV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAccessProfilesForSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAllSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAllSourceAppV1Request + */ +export interface AppsV1ApiListAllSourceAppV1Request { + /** + * 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 AppsV1ApiListAllSourceAppV1 + */ + 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 AppsV1ApiListAllSourceAppV1 + */ + readonly count?: boolean + + /** + * 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 AppsV1ApiListAllSourceAppV1 + */ + readonly offset?: number + + /** + * 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, name, created, modified, owner.id, accountSource.id** + * @type {string} + * @memberof AppsV1ApiListAllSourceAppV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* + * @type {string} + * @memberof AppsV1ApiListAllSourceAppV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAllSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAllUserAppsV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAllUserAppsV1Request + */ +export interface AppsV1ApiListAllUserAppsV1Request { + /** + * 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @type {string} + * @memberof AppsV1ApiListAllUserAppsV1 + */ + readonly filters: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AppsV1ApiListAllUserAppsV1 + */ + 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 AppsV1ApiListAllUserAppsV1 + */ + readonly count?: boolean + + /** + * 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 AppsV1ApiListAllUserAppsV1 + */ + readonly offset?: number + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAllUserAppsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAssignedSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAssignedSourceAppV1Request + */ +export interface AppsV1ApiListAssignedSourceAppV1Request { + /** + * 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 AppsV1ApiListAssignedSourceAppV1 + */ + 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 AppsV1ApiListAssignedSourceAppV1 + */ + readonly count?: boolean + + /** + * 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 AppsV1ApiListAssignedSourceAppV1 + */ + readonly offset?: number + + /** + * 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, name, created, modified, accountSource.id** + * @type {string} + * @memberof AppsV1ApiListAssignedSourceAppV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @type {string} + * @memberof AppsV1ApiListAssignedSourceAppV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAssignedSourceAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAvailableAccountsForUserAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAvailableAccountsForUserAppV1Request + */ +export interface AppsV1ApiListAvailableAccountsForUserAppV1Request { + /** + * ID of the user app + * @type {string} + * @memberof AppsV1ApiListAvailableAccountsForUserAppV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof AppsV1ApiListAvailableAccountsForUserAppV1 + */ + 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 AppsV1ApiListAvailableAccountsForUserAppV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAvailableAccountsForUserAppV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAvailableSourceAppsV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListAvailableSourceAppsV1Request + */ +export interface AppsV1ApiListAvailableSourceAppsV1Request { + /** + * 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 AppsV1ApiListAvailableSourceAppsV1 + */ + 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 AppsV1ApiListAvailableSourceAppsV1 + */ + readonly count?: boolean + + /** + * 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 AppsV1ApiListAvailableSourceAppsV1 + */ + readonly offset?: number + + /** + * 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, name, created, modified, owner.id, accountSource.id** + * @type {string} + * @memberof AppsV1ApiListAvailableSourceAppsV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + * @type {string} + * @memberof AppsV1ApiListAvailableSourceAppsV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListAvailableSourceAppsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listOwnedUserAppsV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiListOwnedUserAppsV1Request + */ +export interface AppsV1ApiListOwnedUserAppsV1Request { + /** + * 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 AppsV1ApiListOwnedUserAppsV1 + */ + 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 AppsV1ApiListOwnedUserAppsV1 + */ + readonly count?: boolean + + /** + * 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 AppsV1ApiListOwnedUserAppsV1 + */ + readonly offset?: number + + /** + * 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + * @type {string} + * @memberof AppsV1ApiListOwnedUserAppsV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiListOwnedUserAppsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchSourceAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiPatchSourceAppV1Request + */ +export interface AppsV1ApiPatchSourceAppV1Request { + /** + * ID of the source app to patch + * @type {string} + * @memberof AppsV1ApiPatchSourceAppV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiPatchSourceAppV1 + */ + readonly xSailPointExperimental?: string + + /** + * + * @type {Array} + * @memberof AppsV1ApiPatchSourceAppV1 + */ + readonly jsonpatchoperationV1?: Array +} + +/** + * Request parameters for patchUserAppV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiPatchUserAppV1Request + */ +export interface AppsV1ApiPatchUserAppV1Request { + /** + * ID of the user app to patch + * @type {string} + * @memberof AppsV1ApiPatchUserAppV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiPatchUserAppV1 + */ + readonly xSailPointExperimental?: string + + /** + * + * @type {Array} + * @memberof AppsV1ApiPatchUserAppV1 + */ + readonly jsonpatchoperationV1?: Array +} + +/** + * Request parameters for updateSourceAppsInBulkV1 operation in AppsV1Api. + * @export + * @interface AppsV1ApiUpdateSourceAppsInBulkV1Request + */ +export interface AppsV1ApiUpdateSourceAppsInBulkV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AppsV1ApiUpdateSourceAppsInBulkV1 + */ + readonly xSailPointExperimental?: string + + /** + * + * @type {SourceappbulkupdaterequestV1} + * @memberof AppsV1ApiUpdateSourceAppsInBulkV1 + */ + readonly sourceappbulkupdaterequestV1?: SourceappbulkupdaterequestV1 +} + +/** + * AppsV1Api - object-oriented interface + * @export + * @class AppsV1Api + * @extends {BaseAPI} + */ +export class AppsV1Api extends BaseAPI { + /** + * This endpoint creates a source app using the given source app payload + * @summary Create source app + * @param {AppsV1ApiCreateSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public createSourceAppV1(requestParameters: AppsV1ApiCreateSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).createSourceAppV1(requestParameters.sourceappcreatedtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the final list of access profiles for the specified source app after removing + * @summary Bulk remove access profiles from the specified source app + * @param {AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public deleteAccessProfilesFromSourceAppByBulkV1(requestParameters: AppsV1ApiDeleteAccessProfilesFromSourceAppByBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).deleteAccessProfilesFromSourceAppByBulkV1(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete a specific source app + * @summary Delete source app by id + * @param {AppsV1ApiDeleteSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public deleteSourceAppV1(requestParameters: AppsV1ApiDeleteSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).deleteSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a source app by its ID. + * @summary Get source app by id + * @param {AppsV1ApiGetSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public getSourceAppV1(requestParameters: AppsV1ApiGetSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).getSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of access profiles for the specified source app + * @summary List access profiles for the specified source app + * @param {AppsV1ApiListAccessProfilesForSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAccessProfilesForSourceAppV1(requestParameters: AppsV1ApiListAccessProfilesForSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAccessProfilesForSourceAppV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of all source apps for the org. + * @summary List all source apps + * @param {AppsV1ApiListAllSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAllSourceAppV1(requestParameters: AppsV1ApiListAllSourceAppV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAllSourceAppV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. + * @summary List all user apps + * @param {AppsV1ApiListAllUserAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAllUserAppsV1(requestParameters: AppsV1ApiListAllUserAppsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAllUserAppsV1(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of source apps assigned for logged in user. + * @summary List assigned source apps + * @param {AppsV1ApiListAssignedSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAssignedSourceAppV1(requestParameters: AppsV1ApiListAssignedSourceAppV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAssignedSourceAppV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + * @summary List available accounts for user app + * @param {AppsV1ApiListAvailableAccountsForUserAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAvailableAccountsForUserAppV1(requestParameters: AppsV1ApiListAvailableAccountsForUserAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAvailableAccountsForUserAppV1(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of source apps available for access request. + * @summary List available source apps + * @param {AppsV1ApiListAvailableSourceAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listAvailableSourceAppsV1(requestParameters: AppsV1ApiListAvailableSourceAppsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listAvailableSourceAppsV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of user apps assigned to logged in user + * @summary List owned user apps + * @param {AppsV1ApiListOwnedUserAppsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public listOwnedUserAppsV1(requestParameters: AppsV1ApiListOwnedUserAppsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).listOwnedUserAppsV1(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Patch source app by id + * @param {AppsV1ApiPatchSourceAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public patchSourceAppV1(requestParameters: AppsV1ApiPatchSourceAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).patchSourceAppV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** + * @summary Patch user app by id + * @param {AppsV1ApiPatchUserAppV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public patchUserAppV1(requestParameters: AppsV1ApiPatchUserAppV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).patchUserAppV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. + * @summary Bulk update source apps + * @param {AppsV1ApiUpdateSourceAppsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AppsV1Api + */ + public updateSourceAppsInBulkV1(requestParameters: AppsV1ApiUpdateSourceAppsInBulkV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AppsV1ApiFp(this.configuration).updateSourceAppsInBulkV1(requestParameters.xSailPointExperimental, requestParameters.sourceappbulkupdaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/v2024/base.ts b/sdk-output/apps/base.ts similarity index 83% rename from sdk-output/v2024/base.ts rename to sdk-output/apps/base.ts index 826181cb..1628842c 100644 --- a/sdk-output/v2024/base.ts +++ b/sdk-output/apps/base.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2024 API + * Identity Security Cloud API - Apps * 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: v2024 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -19,7 +19,7 @@ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://sailpoint.api.identitynow.com/v2024".replace(/\/+$/, ""); +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); /** * @@ -50,10 +50,10 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; - this.basePath = configuration.basePath + "/v2024"|| this.basePath; + this.basePath = configuration.basePath || this.basePath; } } }; diff --git a/sdk-output/v3/common.ts b/sdk-output/apps/common.ts similarity index 83% rename from sdk-output/v3/common.ts rename to sdk-output/apps/common.ts index 7abd580e..ee77d745 100644 --- a/sdk-output/v3/common.ts +++ b/sdk-output/apps/common.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V3 API + * Identity Security Cloud API - Apps * 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: 3.0.0 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,16 +143,15 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) - let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; } userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; const headers = { ...axiosArgs.axiosOptions.headers, - ...{'X-SailPoint-SDK':'typescript-1.8.69'}, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, ...{'User-Agent': userAgent}, } @@ -163,8 +161,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath+ "/v3" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/v3/configuration.ts b/sdk-output/apps/configuration.ts similarity index 97% rename from sdk-output/v3/configuration.ts rename to sdk-output/apps/configuration.ts index aaa791f6..991c7a7b 100644 --- a/sdk-output/v3/configuration.ts +++ b/sdk-output/apps/configuration.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V3 API + * Identity Security Cloud API - Apps * 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: 3.0.0 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/apps/git_push.sh b/sdk-output/apps/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/apps/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/v3/index.ts b/sdk-output/apps/index.ts similarity index 87% rename from sdk-output/v3/index.ts rename to sdk-output/apps/index.ts index 1632f524..49266f59 100644 --- a/sdk-output/v3/index.ts +++ b/sdk-output/apps/index.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V3 API + * Identity Security Cloud API - Apps * 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: 3.0.0 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/apps/package.json b/sdk-output/apps/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/apps/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/apps/tsconfig.json b/sdk-output/apps/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/apps/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/auth_profile/.gitignore b/sdk-output/auth_profile/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/auth_profile/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/auth_profile/.npmignore b/sdk-output/auth_profile/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/auth_profile/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/auth_profile/.openapi-generator-ignore b/sdk-output/auth_profile/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/auth_profile/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/auth_profile/.openapi-generator/FILES b/sdk-output/auth_profile/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/auth_profile/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/auth_profile/.openapi-generator/VERSION b/sdk-output/auth_profile/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/auth_profile/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/auth_profile/.sdk-partition b/sdk-output/auth_profile/.sdk-partition new file mode 100644 index 00000000..6f15ccc2 --- /dev/null +++ b/sdk-output/auth_profile/.sdk-partition @@ -0,0 +1 @@ +auth-profile \ No newline at end of file diff --git a/sdk-output/auth_profile/README.md b/sdk-output/auth_profile/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/auth_profile/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/auth_profile/api.ts b/sdk-output/auth_profile/api.ts new file mode 100644 index 00000000..70c03575 --- /dev/null +++ b/sdk-output/auth_profile/api.ts @@ -0,0 +1,591 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Profile + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AuthprofileV1 + */ +export interface AuthprofileV1 { + /** + * Authentication Profile name. + * @type {string} + * @memberof AuthprofileV1 + */ + 'name'?: string; + /** + * Use it to block access from off network. + * @type {boolean} + * @memberof AuthprofileV1 + */ + 'offNetwork'?: boolean; + /** + * Use it to block access from untrusted geoographies. + * @type {boolean} + * @memberof AuthprofileV1 + */ + 'untrustedGeography'?: boolean; + /** + * Application ID. + * @type {string} + * @memberof AuthprofileV1 + */ + 'applicationId'?: string | null; + /** + * Application name. + * @type {string} + * @memberof AuthprofileV1 + */ + 'applicationName'?: string | null; + /** + * Type of the Authentication Profile. + * @type {string} + * @memberof AuthprofileV1 + */ + 'type'?: AuthprofileV1TypeV1; + /** + * Use it to enable strong authentication. + * @type {boolean} + * @memberof AuthprofileV1 + */ + 'strongAuthLogin'?: boolean; +} + +export const AuthprofileV1TypeV1 = { + Block: 'BLOCK', + Mfa: 'MFA', + NonPta: 'NON_PTA', + Pta: 'PTA' +} as const; + +export type AuthprofileV1TypeV1 = typeof AuthprofileV1TypeV1[keyof typeof AuthprofileV1TypeV1]; + +/** + * + * @export + * @interface AuthprofilesummaryV1 + */ +export interface AuthprofilesummaryV1 { + /** + * Tenant name. + * @type {string} + * @memberof AuthprofilesummaryV1 + */ + 'tenant'?: string; + /** + * Identity ID. + * @type {string} + * @memberof AuthprofilesummaryV1 + */ + 'id'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetProfileConfigListV1401ResponseV1 + */ +export interface GetProfileConfigListV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetProfileConfigListV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetProfileConfigListV1429ResponseV1 + */ +export interface GetProfileConfigListV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetProfileConfigListV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AuthProfileV1Api - axios parameter creator + * @export + */ +export const AuthProfileV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns a list of auth profiles. + * @summary Get list of auth profiles + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProfileConfigListV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/auth-profiles/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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns auth profile information. + * @summary Get auth profile + * @param {string} id ID of the Auth Profile to patch. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProfileConfigV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getProfileConfigV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/auth-profiles/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + * @summary Patch a specified auth profile + * @param {string} id ID of the Auth Profile to patch. + * @param {Array} jsonpatchoperationV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchProfileConfigV1: async (id: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchProfileConfigV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchProfileConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/auth-profiles/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AuthProfileV1Api - functional programming interface + * @export + */ +export const AuthProfileV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AuthProfileV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns a list of auth profiles. + * @summary Get list of auth profiles + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getProfileConfigListV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigListV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AuthProfileV1Api.getProfileConfigListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns auth profile information. + * @summary Get auth profile + * @param {string} id ID of the Auth Profile to patch. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getProfileConfigV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AuthProfileV1Api.getProfileConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + * @summary Patch a specified auth profile + * @param {string} id ID of the Auth Profile to patch. + * @param {Array} jsonpatchoperationV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchProfileConfigV1(id: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchProfileConfigV1(id, jsonpatchoperationV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AuthProfileV1Api.patchProfileConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AuthProfileV1Api - factory interface + * @export + */ +export const AuthProfileV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AuthProfileV1ApiFp(configuration) + return { + /** + * This API returns a list of auth profiles. + * @summary Get list of auth profiles + * @param {AuthProfileV1ApiGetProfileConfigListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProfileConfigListV1(requestParameters: AuthProfileV1ApiGetProfileConfigListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getProfileConfigListV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns auth profile information. + * @summary Get auth profile + * @param {AuthProfileV1ApiGetProfileConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProfileConfigV1(requestParameters: AuthProfileV1ApiGetProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getProfileConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + * @summary Patch a specified auth profile + * @param {AuthProfileV1ApiPatchProfileConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchProfileConfigV1(requestParameters: AuthProfileV1ApiPatchProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchProfileConfigV1(requestParameters.id, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getProfileConfigListV1 operation in AuthProfileV1Api. + * @export + * @interface AuthProfileV1ApiGetProfileConfigListV1Request + */ +export interface AuthProfileV1ApiGetProfileConfigListV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AuthProfileV1ApiGetProfileConfigListV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getProfileConfigV1 operation in AuthProfileV1Api. + * @export + * @interface AuthProfileV1ApiGetProfileConfigV1Request + */ +export interface AuthProfileV1ApiGetProfileConfigV1Request { + /** + * ID of the Auth Profile to patch. + * @type {string} + * @memberof AuthProfileV1ApiGetProfileConfigV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AuthProfileV1ApiGetProfileConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchProfileConfigV1 operation in AuthProfileV1Api. + * @export + * @interface AuthProfileV1ApiPatchProfileConfigV1Request + */ +export interface AuthProfileV1ApiPatchProfileConfigV1Request { + /** + * ID of the Auth Profile to patch. + * @type {string} + * @memberof AuthProfileV1ApiPatchProfileConfigV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof AuthProfileV1ApiPatchProfileConfigV1 + */ + readonly jsonpatchoperationV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof AuthProfileV1ApiPatchProfileConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * AuthProfileV1Api - object-oriented interface + * @export + * @class AuthProfileV1Api + * @extends {BaseAPI} + */ +export class AuthProfileV1Api extends BaseAPI { + /** + * This API returns a list of auth profiles. + * @summary Get list of auth profiles + * @param {AuthProfileV1ApiGetProfileConfigListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AuthProfileV1Api + */ + public getProfileConfigListV1(requestParameters: AuthProfileV1ApiGetProfileConfigListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return AuthProfileV1ApiFp(this.configuration).getProfileConfigListV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns auth profile information. + * @summary Get auth profile + * @param {AuthProfileV1ApiGetProfileConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AuthProfileV1Api + */ + public getProfileConfigV1(requestParameters: AuthProfileV1ApiGetProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AuthProfileV1ApiFp(this.configuration).getProfileConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + * @summary Patch a specified auth profile + * @param {AuthProfileV1ApiPatchProfileConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AuthProfileV1Api + */ + public patchProfileConfigV1(requestParameters: AuthProfileV1ApiPatchProfileConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AuthProfileV1ApiFp(this.configuration).patchProfileConfigV1(requestParameters.id, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/auth_profile/base.ts b/sdk-output/auth_profile/base.ts new file mode 100644 index 00000000..b64ca499 --- /dev/null +++ b/sdk-output/auth_profile/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Profile + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/auth_profile/common.ts b/sdk-output/auth_profile/common.ts new file mode 100644 index 00000000..4ec93e0c --- /dev/null +++ b/sdk-output/auth_profile/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Profile + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/auth_profile/configuration.ts b/sdk-output/auth_profile/configuration.ts new file mode 100644 index 00000000..5156f60b --- /dev/null +++ b/sdk-output/auth_profile/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Profile + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/auth_profile/git_push.sh b/sdk-output/auth_profile/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/auth_profile/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/auth_profile/index.ts b/sdk-output/auth_profile/index.ts new file mode 100644 index 00000000..9d39d2a6 --- /dev/null +++ b/sdk-output/auth_profile/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Profile + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/auth_profile/package.json b/sdk-output/auth_profile/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/auth_profile/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/auth_profile/tsconfig.json b/sdk-output/auth_profile/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/auth_profile/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/auth_users/.gitignore b/sdk-output/auth_users/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/auth_users/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/auth_users/.npmignore b/sdk-output/auth_users/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/auth_users/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/auth_users/.openapi-generator-ignore b/sdk-output/auth_users/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/auth_users/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/auth_users/.openapi-generator/FILES b/sdk-output/auth_users/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/auth_users/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/auth_users/.openapi-generator/VERSION b/sdk-output/auth_users/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/auth_users/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/auth_users/.sdk-partition b/sdk-output/auth_users/.sdk-partition new file mode 100644 index 00000000..39aca3cc --- /dev/null +++ b/sdk-output/auth_users/.sdk-partition @@ -0,0 +1 @@ +auth-users \ No newline at end of file diff --git a/sdk-output/auth_users/README.md b/sdk-output/auth_users/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/auth_users/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/auth_users/api.ts b/sdk-output/auth_users/api.ts new file mode 100644 index 00000000..7a80066c --- /dev/null +++ b/sdk-output/auth_users/api.ts @@ -0,0 +1,538 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Users + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AuthuserV1 + */ +export interface AuthuserV1 { + /** + * Tenant name. + * @type {string} + * @memberof AuthuserV1 + */ + 'tenant'?: string; + /** + * Identity ID. + * @type {string} + * @memberof AuthuserV1 + */ + 'id'?: string; + /** + * Identity\'s unique identitifier. + * @type {string} + * @memberof AuthuserV1 + */ + 'uid'?: string; + /** + * ID of the auth profile associated with the auth user. + * @type {string} + * @memberof AuthuserV1 + */ + 'profile'?: string; + /** + * Auth user\'s employee number. + * @type {string} + * @memberof AuthuserV1 + */ + 'identificationNumber'?: string | null; + /** + * Auth user\'s email. + * @type {string} + * @memberof AuthuserV1 + */ + 'email'?: string | null; + /** + * Auth user\'s phone number. + * @type {string} + * @memberof AuthuserV1 + */ + 'phone'?: string | null; + /** + * Auth user\'s work phone number. + * @type {string} + * @memberof AuthuserV1 + */ + 'workPhone'?: string | null; + /** + * Auth user\'s personal email. + * @type {string} + * @memberof AuthuserV1 + */ + 'personalEmail'?: string | null; + /** + * Auth user\'s first name. + * @type {string} + * @memberof AuthuserV1 + */ + 'firstname'?: string | null; + /** + * Auth user\'s last name. + * @type {string} + * @memberof AuthuserV1 + */ + 'lastname'?: string | null; + /** + * Auth user\'s name in displayed format. + * @type {string} + * @memberof AuthuserV1 + */ + 'displayName'?: string; + /** + * Auth user\'s alias. + * @type {string} + * @memberof AuthuserV1 + */ + 'alias'?: string; + /** + * Date of last password change. + * @type {string} + * @memberof AuthuserV1 + */ + 'lastPasswordChangeDate'?: string | null; + /** + * Timestamp of the last login (long type value). + * @type {number} + * @memberof AuthuserV1 + */ + 'lastLoginTimestamp'?: number; + /** + * Timestamp of the current login (long type value). + * @type {number} + * @memberof AuthuserV1 + */ + 'currentLoginTimestamp'?: number; + /** + * The date and time when the user was last unlocked. + * @type {string} + * @memberof AuthuserV1 + */ + 'lastUnlockTimestamp'?: string | null; + /** + * Array of the auth user\'s capabilities. + * @type {Array} + * @memberof AuthuserV1 + */ + 'capabilities'?: Array | null; +} + +export const AuthuserV1CapabilitiesV1 = { + CertAdmin: 'CERT_ADMIN', + CloudGovAdmin: 'CLOUD_GOV_ADMIN', + CloudGovUser: 'CLOUD_GOV_USER', + Helpdesk: 'HELPDESK', + Internal: 'INTERNAL', + OrgAdmin: 'ORG_ADMIN', + PolicyAdmin: 'POLICY_ADMIN', + ReportAdmin: 'REPORT_ADMIN', + RoleAdmin: 'ROLE_ADMIN', + RoleSubadmin: 'ROLE_SUBADMIN', + SaasManagementAdmin: 'SAAS_MANAGEMENT_ADMIN', + SaasManagementReader: 'SAAS_MANAGEMENT_READER', + SourceAdmin: 'SOURCE_ADMIN', + SourceSubadmin: 'SOURCE_SUBADMIN', + DasUiAdministrator: 'das:ui-administrator', + DasUiComplianceManager: 'das:ui-compliance_manager', + DasUiAuditor: 'das:ui-auditor', + DasUiDataScope: 'das:ui-data-scope', + SpAicDashboardRead: 'sp:aic-dashboard-read', + SpAicDashboardWrite: 'sp:aic-dashboard-write', + SpUiConfigHubAdmin: 'sp:ui-config-hub-admin', + SpUiConfigHubBackupAdmin: 'sp:ui-config-hub-backup-admin', + SpUiConfigHubRead: 'sp:ui-config-hub-read' +} as const; + +export type AuthuserV1CapabilitiesV1 = typeof AuthuserV1CapabilitiesV1[keyof typeof AuthuserV1CapabilitiesV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAuthUserV1401ResponseV1 + */ +export interface GetAuthUserV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAuthUserV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAuthUserV1429ResponseV1 + */ +export interface GetAuthUserV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAuthUserV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * AuthUsersV1Api - axios parameter creator + * @export + */ +export const AuthUsersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Return the specified user\'s authentication system details. + * @summary Auth user details + * @param {string} id Identity ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthUserV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAuthUserV1', 'id', id) + const localVarPath = `/auth-users/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, + }; + }, + /** + * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. + * @summary Auth user update + * @param {string} id Identity ID + * @param {Array} jsonpatchoperationV1 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthUserV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchAuthUserV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAuthUserV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/auth-users/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * AuthUsersV1Api - functional programming interface + * @export + */ +export const AuthUsersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AuthUsersV1ApiAxiosParamCreator(configuration) + return { + /** + * Return the specified user\'s authentication system details. + * @summary Auth user details + * @param {string} id Identity ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAuthUserV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthUserV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AuthUsersV1Api.getAuthUserV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. + * @summary Auth user update + * @param {string} id Identity ID + * @param {Array} jsonpatchoperationV1 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAuthUserV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthUserV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AuthUsersV1Api.patchAuthUserV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AuthUsersV1Api - factory interface + * @export + */ +export const AuthUsersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AuthUsersV1ApiFp(configuration) + return { + /** + * Return the specified user\'s authentication system details. + * @summary Auth user details + * @param {AuthUsersV1ApiGetAuthUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthUserV1(requestParameters: AuthUsersV1ApiGetAuthUserV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAuthUserV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. + * @summary Auth user update + * @param {AuthUsersV1ApiPatchAuthUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthUserV1(requestParameters: AuthUsersV1ApiPatchAuthUserV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAuthUserV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getAuthUserV1 operation in AuthUsersV1Api. + * @export + * @interface AuthUsersV1ApiGetAuthUserV1Request + */ +export interface AuthUsersV1ApiGetAuthUserV1Request { + /** + * Identity ID + * @type {string} + * @memberof AuthUsersV1ApiGetAuthUserV1 + */ + readonly id: string +} + +/** + * Request parameters for patchAuthUserV1 operation in AuthUsersV1Api. + * @export + * @interface AuthUsersV1ApiPatchAuthUserV1Request + */ +export interface AuthUsersV1ApiPatchAuthUserV1Request { + /** + * Identity ID + * @type {string} + * @memberof AuthUsersV1ApiPatchAuthUserV1 + */ + readonly id: string + + /** + * A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof AuthUsersV1ApiPatchAuthUserV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * AuthUsersV1Api - object-oriented interface + * @export + * @class AuthUsersV1Api + * @extends {BaseAPI} + */ +export class AuthUsersV1Api extends BaseAPI { + /** + * Return the specified user\'s authentication system details. + * @summary Auth user details + * @param {AuthUsersV1ApiGetAuthUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AuthUsersV1Api + */ + public getAuthUserV1(requestParameters: AuthUsersV1ApiGetAuthUserV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AuthUsersV1ApiFp(this.configuration).getAuthUserV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. + * @summary Auth user update + * @param {AuthUsersV1ApiPatchAuthUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof AuthUsersV1Api + */ + public patchAuthUserV1(requestParameters: AuthUsersV1ApiPatchAuthUserV1Request, axiosOptions?: RawAxiosRequestConfig) { + return AuthUsersV1ApiFp(this.configuration).patchAuthUserV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/auth_users/base.ts b/sdk-output/auth_users/base.ts new file mode 100644 index 00000000..7b493221 --- /dev/null +++ b/sdk-output/auth_users/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Users + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/auth_users/common.ts b/sdk-output/auth_users/common.ts new file mode 100644 index 00000000..ab25c108 --- /dev/null +++ b/sdk-output/auth_users/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Users + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/auth_users/configuration.ts b/sdk-output/auth_users/configuration.ts new file mode 100644 index 00000000..0bfff6da --- /dev/null +++ b/sdk-output/auth_users/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Users + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/auth_users/git_push.sh b/sdk-output/auth_users/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/auth_users/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/auth_users/index.ts b/sdk-output/auth_users/index.ts new file mode 100644 index 00000000..82068e29 --- /dev/null +++ b/sdk-output/auth_users/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Auth Users + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/auth_users/package.json b/sdk-output/auth_users/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/auth_users/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/auth_users/tsconfig.json b/sdk-output/auth_users/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/auth_users/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/beta/api.ts b/sdk-output/beta/api.ts deleted file mode 100644 index 74847170..00000000 --- a/sdk-output/beta/api.ts +++ /dev/null @@ -1,99298 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud Beta API - * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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: 3.1.0-beta - * - * - * 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 AccessConstraintBeta - */ -export interface AccessConstraintBeta { - /** - * Type of Access - * @type {string} - * @memberof AccessConstraintBeta - */ - 'type': AccessConstraintBetaTypeBeta; - /** - * Must be set only if operator is SELECTED. - * @type {Array} - * @memberof AccessConstraintBeta - */ - 'ids'?: Array; - /** - * Used to determine whether the scope of the campaign should be reduced for selected ids or all. - * @type {string} - * @memberof AccessConstraintBeta - */ - 'operator': AccessConstraintBetaOperatorBeta; -} - -export const AccessConstraintBetaTypeBeta = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessConstraintBetaTypeBeta = typeof AccessConstraintBetaTypeBeta[keyof typeof AccessConstraintBetaTypeBeta]; -export const AccessConstraintBetaOperatorBeta = { - All: 'ALL', - Selected: 'SELECTED' -} as const; - -export type AccessConstraintBetaOperatorBeta = typeof AccessConstraintBetaOperatorBeta[keyof typeof AccessConstraintBetaOperatorBeta]; - -/** - * - * @export - * @interface AccessCriteriaBeta - */ -export interface AccessCriteriaBeta { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteriaBeta - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteriaBeta - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessCriteriaCriteriaListInnerBeta - */ -export interface AccessCriteriaCriteriaListInnerBeta { - /** - * DTO type - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerBeta - */ - 'type'?: AccessCriteriaCriteriaListInnerBetaTypeBeta; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerBeta - */ - 'name'?: string; -} - -export const AccessCriteriaCriteriaListInnerBetaTypeBeta = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaCriteriaListInnerBetaTypeBeta = typeof AccessCriteriaCriteriaListInnerBetaTypeBeta[keyof typeof AccessCriteriaCriteriaListInnerBetaTypeBeta]; - -/** - * - * @export - * @interface AccessDurationBeta - */ -export interface AccessDurationBeta { - /** - * The numeric value representing the amount of time, which is defined in the **timeUnit**. - * @type {number} - * @memberof AccessDurationBeta - */ - 'value'?: number; - /** - * The unit of time that corresponds to the **value**. It defines the scale of the time period. - * @type {string} - * @memberof AccessDurationBeta - */ - 'timeUnit'?: AccessDurationBetaTimeUnitBeta; -} - -export const AccessDurationBetaTimeUnitBeta = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type AccessDurationBetaTimeUnitBeta = typeof AccessDurationBetaTimeUnitBeta[keyof typeof AccessDurationBetaTimeUnitBeta]; - -/** - * - * @export - * @interface AccessItemAccessProfileResponseAppRefsInnerBeta - */ -export interface AccessItemAccessProfileResponseAppRefsInnerBeta { - /** - * the cloud app id associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerBeta - */ - 'cloudAppId'?: string; - /** - * the cloud app name associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerBeta - */ - 'cloudAppName'?: string; -} -/** - * - * @export - * @interface AccessItemAccessProfileResponseBeta - */ -export interface AccessItemAccessProfileResponseBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'id'?: string; - /** - * the access item type. accessProfile in this case - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'sourceName'?: string; - /** - * the number of entitlements the access profile will create - * @type {number} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'entitlementCount': number; - /** - * the description for the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'sourceId'?: string; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'startDate'?: string | null; - /** - * the date the access profile is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'removeDate'?: string | null; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'standalone': boolean | null; - /** - * indicates whether the access profile is revocable - * @type {boolean} - * @memberof AccessItemAccessProfileResponseBeta - */ - 'revocable': boolean | null; -} -/** - * - * @export - * @interface AccessItemAccountResponseBeta - */ -export interface AccessItemAccountResponseBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'id'?: string; - /** - * the access item type. account in this case - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'sourceName'?: string; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'nativeIdentity': string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccountResponseBeta - */ - 'sourceId'?: string; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAccountResponseBeta - */ - 'entitlementCount'?: number; -} -/** - * - * @export - * @interface AccessItemAppResponseBeta - */ -export interface AccessItemAppResponseBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemAppResponseBeta - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAppResponseBeta - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAppResponseBeta - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAppResponseBeta - */ - 'sourceName'?: string | null; - /** - * the app role id - * @type {string} - * @memberof AccessItemAppResponseBeta - */ - 'appRoleId': string | null; -} -/** - * - * @export - * @interface AccessItemApproverDtoBeta - */ -export interface AccessItemApproverDtoBeta { - /** - * DTO type of the identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoBeta - */ - 'type'?: AccessItemApproverDtoBetaTypeBeta; - /** - * ID of the identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoBeta - */ - 'id'?: string; - /** - * Name of the identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoBeta - */ - 'name'?: string; -} - -export const AccessItemApproverDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemApproverDtoBetaTypeBeta = typeof AccessItemApproverDtoBetaTypeBeta[keyof typeof AccessItemApproverDtoBetaTypeBeta]; - -/** - * - * @export - * @interface AccessItemAssociatedAccessItemBeta - */ -export interface AccessItemAssociatedAccessItemBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof AccessItemAssociatedAccessItemBeta - */ - 'appRoleId': string | null; -} -/** - * - * @export - * @interface AccessItemAssociatedBeta - */ -export interface AccessItemAssociatedBeta { - /** - * the event type - * @type {string} - * @memberof AccessItemAssociatedBeta - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemAssociatedBeta - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof AccessItemAssociatedBeta - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemBeta} - * @memberof AccessItemAssociatedBeta - */ - 'accessItem': AccessItemAssociatedAccessItemBeta; - /** - * - * @type {CorrelatedGovernanceEventBeta} - * @memberof AccessItemAssociatedBeta - */ - 'governanceEvent': CorrelatedGovernanceEventBeta | null; - /** - * the access item type - * @type {string} - * @memberof AccessItemAssociatedBeta - */ - 'accessItemType'?: AccessItemAssociatedBetaAccessItemTypeBeta; -} - -export const AccessItemAssociatedBetaAccessItemTypeBeta = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemAssociatedBetaAccessItemTypeBeta = typeof AccessItemAssociatedBetaAccessItemTypeBeta[keyof typeof AccessItemAssociatedBetaAccessItemTypeBeta]; - -/** - * - * @export - * @interface AccessItemDiffBeta - */ -export interface AccessItemDiffBeta { - /** - * the id of the access item - * @type {string} - * @memberof AccessItemDiffBeta - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccessItemDiffBeta - */ - 'eventType'?: AccessItemDiffBetaEventTypeBeta; - /** - * the display name of the access item - * @type {string} - * @memberof AccessItemDiffBeta - */ - 'displayName'?: string; - /** - * the source name of the access item - * @type {string} - * @memberof AccessItemDiffBeta - */ - 'sourceName'?: string; -} - -export const AccessItemDiffBetaEventTypeBeta = { - Add: 'ADD', - Remove: 'REMOVE' -} as const; - -export type AccessItemDiffBetaEventTypeBeta = typeof AccessItemDiffBetaEventTypeBeta[keyof typeof AccessItemDiffBetaEventTypeBeta]; - -/** - * - * @export - * @interface AccessItemEntitlementResponseBeta - */ -export interface AccessItemEntitlementResponseBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'sourceName'?: string; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'type': string; - /** - * the description for the entitlment - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemEntitlementResponseBeta - */ - 'sourceId'?: string; - /** - * indicates whether the entitlement is standalone - * @type {boolean} - * @memberof AccessItemEntitlementResponseBeta - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemEntitlementResponseBeta - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemEntitlementResponseBeta - */ - 'cloudGoverned': boolean | null; -} -/** - * Access item owner\'s identity. - * @export - * @interface AccessItemOwnerDtoBeta - */ -export interface AccessItemOwnerDtoBeta { - /** - * Access item owner\'s DTO type. - * @type {string} - * @memberof AccessItemOwnerDtoBeta - */ - 'type'?: AccessItemOwnerDtoBetaTypeBeta; - /** - * Access item owner\'s identity ID. - * @type {string} - * @memberof AccessItemOwnerDtoBeta - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemOwnerDtoBeta - */ - 'name'?: string; -} - -export const AccessItemOwnerDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemOwnerDtoBetaTypeBeta = typeof AccessItemOwnerDtoBetaTypeBeta[keyof typeof AccessItemOwnerDtoBetaTypeBeta]; - -/** - * - * @export - * @interface AccessItemRefBeta - */ -export interface AccessItemRefBeta { - /** - * ID of the access item to retrieve the recommendation for. - * @type {string} - * @memberof AccessItemRefBeta - */ - 'id'?: string; - /** - * Access item\'s type. - * @type {string} - * @memberof AccessItemRefBeta - */ - 'type'?: AccessItemRefBetaTypeBeta; -} - -export const AccessItemRefBetaTypeBeta = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessItemRefBetaTypeBeta = typeof AccessItemRefBetaTypeBeta[keyof typeof AccessItemRefBetaTypeBeta]; - -/** - * - * @export - * @interface AccessItemRemovedBeta - */ -export interface AccessItemRemovedBeta { - /** - * - * @type {AccessItemAssociatedAccessItemBeta} - * @memberof AccessItemRemovedBeta - */ - 'accessItem': AccessItemAssociatedAccessItemBeta; - /** - * the identity id - * @type {string} - * @memberof AccessItemRemovedBeta - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessItemRemovedBeta - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemRemovedBeta - */ - 'dateTime'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessItemRemovedBeta - */ - 'accessItemType'?: AccessItemRemovedBetaAccessItemTypeBeta; - /** - * - * @type {CorrelatedGovernanceEventBeta} - * @memberof AccessItemRemovedBeta - */ - 'governanceEvent'?: CorrelatedGovernanceEventBeta | null; -} - -export const AccessItemRemovedBetaAccessItemTypeBeta = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemRemovedBetaAccessItemTypeBeta = typeof AccessItemRemovedBetaAccessItemTypeBeta[keyof typeof AccessItemRemovedBetaAccessItemTypeBeta]; - -/** - * Identity whom the access item is requested for. - * @export - * @interface AccessItemRequestedForDto1Beta - */ -export interface AccessItemRequestedForDto1Beta { - /** - * DTO type of the identity whom the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDto1Beta - */ - 'type'?: AccessItemRequestedForDto1BetaTypeBeta; - /** - * ID of the identity whom the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDto1Beta - */ - 'id'?: string; - /** - * Name of the identity whom the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDto1Beta - */ - 'name'?: string; -} - -export const AccessItemRequestedForDto1BetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForDto1BetaTypeBeta = typeof AccessItemRequestedForDto1BetaTypeBeta[keyof typeof AccessItemRequestedForDto1BetaTypeBeta]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForDtoBeta - */ -export interface AccessItemRequestedForDtoBeta { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoBeta - */ - 'type'?: AccessItemRequestedForDtoBetaTypeBeta; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoBeta - */ - 'name'?: string; -} - -export const AccessItemRequestedForDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForDtoBetaTypeBeta = typeof AccessItemRequestedForDtoBetaTypeBeta[keyof typeof AccessItemRequestedForDtoBetaTypeBeta]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterBeta - */ -export interface AccessItemRequesterBeta { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterBeta - */ - 'type'?: AccessItemRequesterBetaTypeBeta; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterBeta - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterBeta - */ - 'name'?: string; -} - -export const AccessItemRequesterBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterBetaTypeBeta = typeof AccessItemRequesterBetaTypeBeta[keyof typeof AccessItemRequesterBetaTypeBeta]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterDto1Beta - */ -export interface AccessItemRequesterDto1Beta { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterDto1Beta - */ - 'type'?: AccessItemRequesterDto1BetaTypeBeta; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterDto1Beta - */ - 'id'?: string; - /** - * Access item requester\'s name. - * @type {string} - * @memberof AccessItemRequesterDto1Beta - */ - 'name'?: string; -} - -export const AccessItemRequesterDto1BetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterDto1BetaTypeBeta = typeof AccessItemRequesterDto1BetaTypeBeta[keyof typeof AccessItemRequesterDto1BetaTypeBeta]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterDtoBeta - */ -export interface AccessItemRequesterDtoBeta { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterDtoBeta - */ - 'type'?: AccessItemRequesterDtoBetaTypeBeta; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterDtoBeta - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterDtoBeta - */ - 'name'?: string; -} - -export const AccessItemRequesterDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterDtoBetaTypeBeta = typeof AccessItemRequesterDtoBetaTypeBeta[keyof typeof AccessItemRequesterDtoBetaTypeBeta]; - -/** - * Identity who reviewed the access item request. - * @export - * @interface AccessItemReviewedByBeta - */ -export interface AccessItemReviewedByBeta { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByBeta - */ - 'type'?: AccessItemReviewedByBetaTypeBeta; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByBeta - */ - 'name'?: string; -} - -export const AccessItemReviewedByBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemReviewedByBetaTypeBeta = typeof AccessItemReviewedByBetaTypeBeta[keyof typeof AccessItemReviewedByBetaTypeBeta]; - -/** - * - * @export - * @interface AccessItemRoleResponseBeta - */ -export interface AccessItemRoleResponseBeta { - /** - * the access item id - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'id'?: string; - /** - * the access item type. role in this case - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'accessType'?: string; - /** - * the role display name - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'sourceName'?: string | null; - /** - * the description for the role - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'description'?: string; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemRoleResponseBeta - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemRoleResponseBeta - */ - 'revocable': boolean; -} -/** - * - * @export - * @interface AccessProfileApprovalSchemeBeta - */ -export interface AccessProfileApprovalSchemeBeta { - /** - * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof AccessProfileApprovalSchemeBeta - */ - 'approverType'?: AccessProfileApprovalSchemeBetaApproverTypeBeta; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof AccessProfileApprovalSchemeBeta - */ - 'approverId'?: string | null; -} - -export const AccessProfileApprovalSchemeBetaApproverTypeBeta = { - AppOwner: 'APP_OWNER', - Owner: 'OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type AccessProfileApprovalSchemeBetaApproverTypeBeta = typeof AccessProfileApprovalSchemeBetaApproverTypeBeta[keyof typeof AccessProfileApprovalSchemeBetaApproverTypeBeta]; - -/** - * Access profile. - * @export - * @interface AccessProfileBeta - */ -export interface AccessProfileBeta { - /** - * Access profile ID. - * @type {string} - * @memberof AccessProfileBeta - */ - 'id'?: string; - /** - * Access profile name. - * @type {string} - * @memberof AccessProfileBeta - */ - 'name': string; - /** - * Access profile description. - * @type {string} - * @memberof AccessProfileBeta - */ - 'description'?: string | null; - /** - * Date and time when the access profile was created. - * @type {string} - * @memberof AccessProfileBeta - */ - 'created'?: string; - /** - * Date and time when the access profile was last modified. - * @type {string} - * @memberof AccessProfileBeta - */ - 'modified'?: string; - /** - * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. - * @type {boolean} - * @memberof AccessProfileBeta - */ - 'enabled'?: boolean; - /** - * - * @type {OwnerReferenceBeta} - * @memberof AccessProfileBeta - */ - 'owner': OwnerReferenceBeta; - /** - * - * @type {AccessProfileSourceRefBeta} - * @memberof AccessProfileBeta - */ - 'source': AccessProfileSourceRefBeta; - /** - * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. - * @type {Array} - * @memberof AccessProfileBeta - */ - 'entitlements'?: Array | null; - /** - * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. - * @type {boolean} - * @memberof AccessProfileBeta - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityBeta} - * @memberof AccessProfileBeta - */ - 'accessRequestConfig'?: RequestabilityBeta | null; - /** - * - * @type {RevocabilityBeta} - * @memberof AccessProfileBeta - */ - 'revocationRequestConfig'?: RevocabilityBeta | null; - /** - * List of segment IDs, if any, that the access profile is assigned to. - * @type {Array} - * @memberof AccessProfileBeta - */ - 'segments'?: Array | null; - /** - * - * @type {AttributeDTOListBeta} - * @memberof AccessProfileBeta - */ - 'accessModelMetadata'?: AttributeDTOListBeta; - /** - * - * @type {ProvisioningCriteriaLevel1Beta} - * @memberof AccessProfileBeta - */ - 'provisioningCriteria'?: ProvisioningCriteriaLevel1Beta | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof AccessProfileBeta - */ - 'additionalOwners'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteRequestBeta - */ -export interface AccessProfileBulkDeleteRequestBeta { - /** - * List of IDs of Access Profiles to be deleted. - * @type {Array} - * @memberof AccessProfileBulkDeleteRequestBeta - */ - 'accessProfileIds'?: Array; - /** - * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - * @type {boolean} - * @memberof AccessProfileBulkDeleteRequestBeta - */ - 'bestEffortOnly'?: boolean; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteResponseBeta - */ -export interface AccessProfileBulkDeleteResponseBeta { - /** - * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. - * @type {string} - * @memberof AccessProfileBulkDeleteResponseBeta - */ - 'taskId'?: string; - /** - * List of IDs of Access Profiles which are pending deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseBeta - */ - 'pending'?: Array; - /** - * List of usages of Access Profiles targeted for deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseBeta - */ - 'inUse'?: Array; -} -/** - * Access Profile\'s basic details. - * @export - * @interface AccessProfileBulkUpdateRequestInnerBeta - */ -export interface AccessProfileBulkUpdateRequestInnerBeta { - /** - * Access Profile ID. - * @type {string} - * @memberof AccessProfileBulkUpdateRequestInnerBeta - */ - 'id'?: string; - /** - * Access Profile is requestable or not. - * @type {boolean} - * @memberof AccessProfileBulkUpdateRequestInnerBeta - */ - 'requestable'?: boolean; -} -/** - * How to select account when there are multiple accounts for the user - * @export - * @interface AccessProfileDetailsAccountSelectorBeta - */ -export interface AccessProfileDetailsAccountSelectorBeta { - /** - * - * @type {Array} - * @memberof AccessProfileDetailsAccountSelectorBeta - */ - 'selectors'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileDetailsBeta - */ -export interface AccessProfileDetailsBeta { - /** - * The ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'description'?: string | null; - /** - * Date the Access Profile was created - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'modified'?: string; - /** - * Whether the Access Profile is enabled. - * @type {boolean} - * @memberof AccessProfileDetailsBeta - */ - 'disabled'?: boolean; - /** - * Whether the Access Profile is requestable via access request. - * @type {boolean} - * @memberof AccessProfileDetailsBeta - */ - 'requestable'?: boolean; - /** - * Whether the Access Profile is protected. - * @type {boolean} - * @memberof AccessProfileDetailsBeta - */ - 'protected'?: boolean; - /** - * The owner ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'ownerId'?: string; - /** - * The source ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsBeta - */ - 'sourceId'?: number | null; - /** - * The source name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'sourceName'?: string; - /** - * The source app ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsBeta - */ - 'appId'?: number | null; - /** - * The source app name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'appName'?: string | null; - /** - * The id of the application - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'applicationId'?: string; - /** - * The type of the access profile - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'type'?: string; - /** - * List of IDs of entitlements - * @type {Array} - * @memberof AccessProfileDetailsBeta - */ - 'entitlements'?: Array; - /** - * The number of entitlements in the access profile - * @type {number} - * @memberof AccessProfileDetailsBeta - */ - 'entitlementCount'?: number; - /** - * List of IDs of segments, if any, to which this Access Profile is assigned. - * @type {Array} - * @memberof AccessProfileDetailsBeta - */ - 'segments'?: Array; - /** - * Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'approvalSchemes'?: string; - /** - * Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsBeta - */ - 'revokeRequestApprovalSchemes'?: string; - /** - * Whether the access profile require request comment for access request. - * @type {boolean} - * @memberof AccessProfileDetailsBeta - */ - 'requestCommentsRequired'?: boolean; - /** - * Whether denied comment is required when access request is denied. - * @type {boolean} - * @memberof AccessProfileDetailsBeta - */ - 'deniedCommentsRequired'?: boolean; - /** - * - * @type {AccessProfileDetailsAccountSelectorBeta} - * @memberof AccessProfileDetailsBeta - */ - 'accountSelector'?: AccessProfileDetailsAccountSelectorBeta; -} -/** - * - * @export - * @interface AccessProfileRefBeta - */ -export interface AccessProfileRefBeta { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfileRefBeta - */ - 'id'?: string; - /** - * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof AccessProfileRefBeta - */ - 'type'?: AccessProfileRefBetaTypeBeta; - /** - * Human-readable display name of the Access Profile. This field is ignored on input. - * @type {string} - * @memberof AccessProfileRefBeta - */ - 'name'?: string; -} - -export const AccessProfileRefBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE' -} as const; - -export type AccessProfileRefBetaTypeBeta = typeof AccessProfileRefBetaTypeBeta[keyof typeof AccessProfileRefBetaTypeBeta]; - -/** - * - * @export - * @interface AccessProfileSourceRefBeta - */ -export interface AccessProfileSourceRefBeta { - /** - * ID of the source the access profile is associated with. - * @type {string} - * @memberof AccessProfileSourceRefBeta - */ - 'id'?: string; - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccessProfileSourceRefBeta - */ - 'type'?: AccessProfileSourceRefBetaTypeBeta; - /** - * Source name. - * @type {string} - * @memberof AccessProfileSourceRefBeta - */ - 'name'?: string; -} - -export const AccessProfileSourceRefBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccessProfileSourceRefBetaTypeBeta = typeof AccessProfileSourceRefBetaTypeBeta[keyof typeof AccessProfileSourceRefBetaTypeBeta]; - -/** - * - * @export - * @interface AccessProfileUpdateItemBeta - */ -export interface AccessProfileUpdateItemBeta { - /** - * Identifier of Access Profile in bulk update request. - * @type {string} - * @memberof AccessProfileUpdateItemBeta - */ - 'id': string; - /** - * Access Profile requestable or not. - * @type {boolean} - * @memberof AccessProfileUpdateItemBeta - */ - 'requestable': boolean; - /** - * The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. - * @type {string} - * @memberof AccessProfileUpdateItemBeta - */ - 'status': string; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof AccessProfileUpdateItemBeta - */ - 'description'?: string; -} -/** - * - * @export - * @interface AccessProfileUsageBeta - */ -export interface AccessProfileUsageBeta { - /** - * ID of the Access Profile that is in use - * @type {string} - * @memberof AccessProfileUsageBeta - */ - 'accessProfileId'?: string; - /** - * List of references to objects which are using the indicated Access Profile - * @type {Array} - * @memberof AccessProfileUsageBeta - */ - 'usedBy'?: Array; -} -/** - * Role using the access profile. - * @export - * @interface AccessProfileUsageUsedByInnerBeta - */ -export interface AccessProfileUsageUsedByInnerBeta { - /** - * DTO type of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerBeta - */ - 'type'?: AccessProfileUsageUsedByInnerBetaTypeBeta; - /** - * ID of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerBeta - */ - 'id'?: string; - /** - * Display name of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerBeta - */ - 'name'?: string; -} - -export const AccessProfileUsageUsedByInnerBetaTypeBeta = { - Role: 'ROLE' -} as const; - -export type AccessProfileUsageUsedByInnerBetaTypeBeta = typeof AccessProfileUsageUsedByInnerBetaTypeBeta[keyof typeof AccessProfileUsageUsedByInnerBetaTypeBeta]; - -/** - * - * @export - * @interface AccessRecommendationMessageBeta - */ -export interface AccessRecommendationMessageBeta { - /** - * Information about why the access item was recommended. - * @type {string} - * @memberof AccessRecommendationMessageBeta - */ - 'interpretation'?: string; -} -/** - * - * @export - * @interface AccessRequestAdminItemStatusBeta - */ -export interface AccessRequestAdminItemStatusBeta { - /** - * ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'type'?: AccessRequestAdminItemStatusBetaTypeBeta | null; - /** - * - * @type {AccessRequestAdminItemStatusCancelledRequestDetailsBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'cancelledRequestDetails'?: AccessRequestAdminItemStatusCancelledRequestDetailsBeta; - /** - * List of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'state'?: RequestedItemStatusRequestStateBeta; - /** - * Approval details for each item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'approvalDetails'?: Array; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'requestType'?: AccessRequestTypeBeta | null; - /** - * When the request was last modified. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'requester'?: AccessItemRequesterBeta; - /** - * - * @type {RequestedItemStatusRequestedForBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'requestedFor'?: RequestedItemStatusRequestedForBeta; - /** - * - * @type {RequestedItemStatusRequesterCommentBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentBeta; - /** - * - * @type {AccessRequestAdminItemStatusSodViolationContextBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'sodViolationContext'?: AccessRequestAdminItemStatusSodViolationContextBeta; - /** - * - * @type {RequestedItemStatusProvisioningDetailsBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsBeta; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsBeta} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsBeta; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'cancelable'?: boolean; - /** - * True if re-auth is required. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'reauthorizationRequired'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccessRequestAdminItemStatusBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - -export const AccessRequestAdminItemStatusBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestAdminItemStatusBetaTypeBeta = typeof AccessRequestAdminItemStatusBetaTypeBeta[keyof typeof AccessRequestAdminItemStatusBetaTypeBeta]; - -/** - * - * @export - * @interface AccessRequestAdminItemStatusCancelledRequestDetailsBeta - */ -export interface AccessRequestAdminItemStatusCancelledRequestDetailsBeta { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof AccessRequestAdminItemStatusCancelledRequestDetailsBeta - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoBeta} - * @memberof AccessRequestAdminItemStatusCancelledRequestDetailsBeta - */ - 'owner'?: OwnerDtoBeta; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof AccessRequestAdminItemStatusCancelledRequestDetailsBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface AccessRequestAdminItemStatusSodViolationContextBeta - */ -export interface AccessRequestAdminItemStatusSodViolationContextBeta { - /** - * The status of SOD violation check - * @type {string} - * @memberof AccessRequestAdminItemStatusSodViolationContextBeta - */ - 'state'?: AccessRequestAdminItemStatusSodViolationContextBetaStateBeta | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof AccessRequestAdminItemStatusSodViolationContextBeta - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResult1Beta} - * @memberof AccessRequestAdminItemStatusSodViolationContextBeta - */ - 'violationCheckResult'?: SodViolationCheckResult1Beta; -} - -export const AccessRequestAdminItemStatusSodViolationContextBetaStateBeta = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type AccessRequestAdminItemStatusSodViolationContextBetaStateBeta = typeof AccessRequestAdminItemStatusSodViolationContextBetaStateBeta[keyof typeof AccessRequestAdminItemStatusSodViolationContextBetaStateBeta]; - -/** - * - * @export - * @interface AccessRequestBeta - */ -export interface AccessRequestBeta { - /** - * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. - * @type {Array} - * @memberof AccessRequestBeta - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeBeta} - * @memberof AccessRequestBeta - */ - 'requestType'?: AccessRequestTypeBeta | null; - /** - * - * @type {Array} - * @memberof AccessRequestBeta - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestBeta - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests - * @type {Array} - * @memberof AccessRequestBeta - */ - 'requestedForWithRequestedItems'?: Array | null; -} - - -/** - * - * @export - * @interface AccessRequestConfigBeta - */ -export interface AccessRequestConfigBeta { - /** - * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. - * @type {boolean} - * @memberof AccessRequestConfigBeta - */ - 'approvalsMustBeExternal'?: boolean; - /** - * If this is true and the requester and reviewer are the same, the request is automatically approved. - * @type {boolean} - * @memberof AccessRequestConfigBeta - */ - 'autoApprovalEnabled'?: boolean; - /** - * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - * @type {boolean} - * @memberof AccessRequestConfigBeta - */ - 'reauthorizationEnabled'?: boolean; - /** - * - * @type {RequestOnBehalfOfConfigBeta} - * @memberof AccessRequestConfigBeta - */ - 'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfigBeta; - /** - * - * @type {ApprovalReminderAndEscalationConfigBeta} - * @memberof AccessRequestConfigBeta - */ - 'approvalReminderAndEscalationConfig'?: ApprovalReminderAndEscalationConfigBeta; - /** - * - * @type {EntitlementRequestConfig1Beta} - * @memberof AccessRequestConfigBeta - */ - 'entitlementRequestConfig'?: EntitlementRequestConfig1Beta; -} -/** - * - * @export - * @interface AccessRequestContextBeta - */ -export interface AccessRequestContextBeta { - /** - * - * @type {Array} - * @memberof AccessRequestContextBeta - */ - 'contextAttributes'?: Array; -} -/** - * - * @export - * @interface AccessRequestDynamicApprover1Beta - */ -export interface AccessRequestDynamicApprover1Beta { - /** - * The unique ID of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1Beta - */ - 'id': string; - /** - * The name of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1Beta - */ - 'name': string; - /** - * The type of object being referenced. - * @type {object} - * @memberof AccessRequestDynamicApprover1Beta - */ - 'type': AccessRequestDynamicApprover1BetaTypeBeta; -} - -export const AccessRequestDynamicApprover1BetaTypeBeta = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AccessRequestDynamicApprover1BetaTypeBeta = typeof AccessRequestDynamicApprover1BetaTypeBeta[keyof typeof AccessRequestDynamicApprover1BetaTypeBeta]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverBeta - */ -export interface AccessRequestDynamicApproverBeta { - /** - * Unique ID of the access request object. You can use this ID with the [Access Request Status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the request\'s status. - * @type {string} - * @memberof AccessRequestDynamicApproverBeta - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestDynamicApproverBeta - */ - 'requestedFor': Array; - /** - * Requested access items. - * @type {Array} - * @memberof AccessRequestDynamicApproverBeta - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDto1Beta} - * @memberof AccessRequestDynamicApproverBeta - */ - 'requestedBy': AccessItemRequesterDto1Beta; -} -/** - * - * @export - * @interface AccessRequestDynamicApproverRequestedItemsInnerBeta - */ -export interface AccessRequestDynamicApproverRequestedItemsInnerBeta { - /** - * Access item\'s unique identifier. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'id': string; - /** - * Access item\'s name. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'name': string; - /** - * Access item\'s extended description. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'description'?: string | null; - /** - * Type of access item being requested. - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'type': AccessRequestDynamicApproverRequestedItemsInnerBetaTypeBeta; - /** - * Action to perform on the requested access item. - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'operation': AccessRequestDynamicApproverRequestedItemsInnerBetaOperationBeta; - /** - * Comment from the requester about why the access is necessary. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerBeta - */ - 'comment'?: string | null; -} - -export const AccessRequestDynamicApproverRequestedItemsInnerBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerBetaTypeBeta = typeof AccessRequestDynamicApproverRequestedItemsInnerBetaTypeBeta[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerBetaTypeBeta]; -export const AccessRequestDynamicApproverRequestedItemsInnerBetaOperationBeta = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerBetaOperationBeta = typeof AccessRequestDynamicApproverRequestedItemsInnerBetaOperationBeta[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerBetaOperationBeta]; - -/** - * - * @export - * @interface AccessRequestItemBeta - */ -export interface AccessRequestItemBeta { - /** - * The type of the item being requested. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'type': AccessRequestItemBetaTypeBeta; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestItemBeta - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'removeDate'?: string; - /** - * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'assignmentId'?: string | null; - /** - * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemBeta - */ - 'nativeIdentity'?: string | null; -} - -export const AccessRequestItemBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestItemBetaTypeBeta = typeof AccessRequestItemBetaTypeBeta[keyof typeof AccessRequestItemBetaTypeBeta]; - -/** - * - * @export - * @interface AccessRequestItemResponseBeta - */ -export interface AccessRequestItemResponseBeta { - /** - * the access request item operation - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'operation'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'accessItemType'?: string; - /** - * the name of access request item - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'name'?: string; - /** - * the final decision for the access request - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'decision'?: AccessRequestItemResponseBetaDecisionBeta; - /** - * the description of access request item - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'description'?: string; - /** - * the source id - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'sourceId'?: string; - /** - * the source Name - * @type {string} - * @memberof AccessRequestItemResponseBeta - */ - 'sourceName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestItemResponseBeta - */ - 'approvalInfos'?: Array; -} - -export const AccessRequestItemResponseBetaDecisionBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type AccessRequestItemResponseBetaDecisionBeta = typeof AccessRequestItemResponseBetaDecisionBeta[keyof typeof AccessRequestItemResponseBetaDecisionBeta]; - -/** - * Provides additional details about this access request phase. - * @export - * @interface AccessRequestPhasesBeta - */ -export interface AccessRequestPhasesBeta { - /** - * The time that this phase started. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'started'?: string; - /** - * The time that this phase finished. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'finished'?: string | null; - /** - * The name of this phase. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'name'?: string; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'state'?: AccessRequestPhasesBetaStateBeta; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'result'?: AccessRequestPhasesBetaResultBeta | null; - /** - * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - * @type {string} - * @memberof AccessRequestPhasesBeta - */ - 'phaseReference'?: string | null; -} - -export const AccessRequestPhasesBetaStateBeta = { - Pending: 'PENDING', - Executing: 'EXECUTING', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - NotExecuted: 'NOT_EXECUTED' -} as const; - -export type AccessRequestPhasesBetaStateBeta = typeof AccessRequestPhasesBetaStateBeta[keyof typeof AccessRequestPhasesBetaStateBeta]; -export const AccessRequestPhasesBetaResultBeta = { - Successful: 'SUCCESSFUL', - Failed: 'FAILED' -} as const; - -export type AccessRequestPhasesBetaResultBeta = typeof AccessRequestPhasesBetaResultBeta[keyof typeof AccessRequestPhasesBetaResultBeta]; - -/** - * - * @export - * @interface AccessRequestPostApprovalBeta - */ -export interface AccessRequestPostApprovalBeta { - /** - * Access request\'s unique ID. - * @type {string} - * @memberof AccessRequestPostApprovalBeta - */ - 'accessRequestId': string; - /** - * Identities whom access was requested for. - * @type {Array} - * @memberof AccessRequestPostApprovalBeta - */ - 'requestedFor': Array; - /** - * Details about the outcome of each requested access item. - * @type {Array} - * @memberof AccessRequestPostApprovalBeta - */ - 'requestedItemsStatus': Array; - /** - * - * @type {AccessItemRequesterDto1Beta} - * @memberof AccessRequestPostApprovalBeta - */ - 'requestedBy': AccessItemRequesterDto1Beta; -} -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta { - /** - * Approver\'s comment. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta - */ - 'approvalComment'?: string | null; - /** - * Approver\'s final decision. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta - */ - 'approvalDecision': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBetaApprovalDecisionBeta; - /** - * Approver\'s name. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta - */ - 'approverName': string; - /** - * Approver\'s identity. - * @type {AccessItemApproverDtoBeta} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBeta - */ - 'approver': AccessItemApproverDtoBeta; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBetaApprovalDecisionBeta = { - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBetaApprovalDecisionBeta = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBetaApprovalDecisionBeta[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerBetaApprovalDecisionBeta]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerBeta { - /** - * Access item\'s unique ID. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'id': string; - /** - * Access item\'s name. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'name': string; - /** - * Access item\'s description. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'description'?: string | null; - /** - * Access item\'s type. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerBetaTypeBeta; - /** - * Action to perform on the requested access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'operation': AccessRequestPostApprovalRequestedItemsStatusInnerBetaOperationBeta; - /** - * Comment from the identity requesting access. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'comment'?: string | null; - /** - * Additional customer defined metadata about the access item. - * @type {{ [key: string]: any; }} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'clientMetadata'?: { [key: string]: any; } | null; - /** - * List of approvers for the access request. - * @type {Array} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerBeta - */ - 'approvalInfo': Array; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerBetaTypeBeta = typeof AccessRequestPostApprovalRequestedItemsStatusInnerBetaTypeBeta[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerBetaTypeBeta]; -export const AccessRequestPostApprovalRequestedItemsStatusInnerBetaOperationBeta = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerBetaOperationBeta = typeof AccessRequestPostApprovalRequestedItemsStatusInnerBetaOperationBeta[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerBetaOperationBeta]; - -/** - * - * @export - * @interface AccessRequestPreApproval1Beta - */ -export interface AccessRequestPreApproval1Beta { - /** - * Whether or not to approve the access request. - * @type {boolean} - * @memberof AccessRequestPreApproval1Beta - */ - 'approved': boolean; - /** - * A comment about the decision to approve or deny the request. - * @type {string} - * @memberof AccessRequestPreApproval1Beta - */ - 'comment': string; - /** - * The name of the entity that approved or denied the request. - * @type {string} - * @memberof AccessRequestPreApproval1Beta - */ - 'approver': string; -} -/** - * - * @export - * @interface AccessRequestPreApprovalBeta - */ -export interface AccessRequestPreApprovalBeta { - /** - * Access request\'s unique ID. - * @type {string} - * @memberof AccessRequestPreApprovalBeta - */ - 'accessRequestId': string; - /** - * Identities whom access was requested for. - * @type {Array} - * @memberof AccessRequestPreApprovalBeta - */ - 'requestedFor': Array; - /** - * Details about each requested access item. - * @type {Array} - * @memberof AccessRequestPreApprovalBeta - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDto1Beta} - * @memberof AccessRequestPreApprovalBeta - */ - 'requestedBy': AccessItemRequesterDto1Beta; -} -/** - * - * @export - * @interface AccessRequestPreApprovalRequestedItemsInnerBeta - */ -export interface AccessRequestPreApprovalRequestedItemsInnerBeta { - /** - * Access item\'s unique ID. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'id': string; - /** - * Access item\'s name. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'name': string; - /** - * Access item\'s description. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'description'?: string | null; - /** - * Access item\'s type. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'type': AccessRequestPreApprovalRequestedItemsInnerBetaTypeBeta; - /** - * Action to perform on the access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'operation': AccessRequestPreApprovalRequestedItemsInnerBetaOperationBeta; - /** - * Comment from the identity requesting access. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerBeta - */ - 'comment'?: string | null; -} - -export const AccessRequestPreApprovalRequestedItemsInnerBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerBetaTypeBeta = typeof AccessRequestPreApprovalRequestedItemsInnerBetaTypeBeta[keyof typeof AccessRequestPreApprovalRequestedItemsInnerBetaTypeBeta]; -export const AccessRequestPreApprovalRequestedItemsInnerBetaOperationBeta = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerBetaOperationBeta = typeof AccessRequestPreApprovalRequestedItemsInnerBetaOperationBeta[keyof typeof AccessRequestPreApprovalRequestedItemsInnerBetaOperationBeta]; - -/** - * - * @export - * @interface AccessRequestRecommendationActionItemDtoBeta - */ -export interface AccessRequestRecommendationActionItemDtoBeta { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemDtoBeta - */ - 'identityId': string; - /** - * - * @type {AccessRequestRecommendationItemBeta} - * @memberof AccessRequestRecommendationActionItemDtoBeta - */ - 'access': AccessRequestRecommendationItemBeta; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemResponseDtoBeta - */ -export interface AccessRequestRecommendationActionItemResponseDtoBeta { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoBeta - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemBeta} - * @memberof AccessRequestRecommendationActionItemResponseDtoBeta - */ - 'access'?: AccessRequestRecommendationItemBeta; - /** - * - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoBeta - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface AccessRequestRecommendationItemBeta - */ -export interface AccessRequestRecommendationItemBeta { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemBeta - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeBeta} - * @memberof AccessRequestRecommendationItemBeta - */ - 'type'?: AccessRequestRecommendationItemTypeBeta; -} - - -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailAccessBeta - */ -export interface AccessRequestRecommendationItemDetailAccessBeta { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessBeta - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeBeta} - * @memberof AccessRequestRecommendationItemDetailAccessBeta - */ - 'type'?: AccessRequestRecommendationItemTypeBeta; - /** - * Name of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessBeta - */ - 'name'?: string; - /** - * Description of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessBeta - */ - 'description'?: string; -} - - -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailBeta - */ -export interface AccessRequestRecommendationItemDetailBeta { - /** - * Identity ID for the recommendation - * @type {string} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemDetailAccessBeta} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'access'?: AccessRequestRecommendationItemDetailAccessBeta; - /** - * Whether or not the identity has already chosen to ignore this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'ignored'?: boolean; - /** - * Whether or not the identity has already chosen to request this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'requested'?: boolean; - /** - * Whether or not the identity reportedly viewed this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'viewed'?: boolean; - /** - * - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'messages'?: Array; - /** - * The list of translation messages - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailBeta - */ - 'translationMessages'?: Array; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const AccessRequestRecommendationItemTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessRequestRecommendationItemTypeBeta = typeof AccessRequestRecommendationItemTypeBeta[keyof typeof AccessRequestRecommendationItemTypeBeta]; - - -/** - * - * @export - * @interface AccessRequestResponse1Beta - */ -export interface AccessRequestResponse1Beta { - /** - * the requester Id - * @type {string} - * @memberof AccessRequestResponse1Beta - */ - 'requesterId'?: string; - /** - * the requesterName - * @type {string} - * @memberof AccessRequestResponse1Beta - */ - 'requesterName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestResponse1Beta - */ - 'items'?: Array; -} -/** - * - * @export - * @interface AccessRequestResponseBeta - */ -export interface AccessRequestResponseBeta { - /** - * A list of new access request tracking data mapped to the values requested. - * @type {Array} - * @memberof AccessRequestResponseBeta - */ - 'newRequests'?: Array; - /** - * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - * @type {Array} - * @memberof AccessRequestResponseBeta - */ - 'existingRequests'?: Array; -} -/** - * - * @export - * @interface AccessRequestTrackingBeta - */ -export interface AccessRequestTrackingBeta { - /** - * The identity id in which the access request is for. - * @type {string} - * @memberof AccessRequestTrackingBeta - */ - 'requestedFor'?: string; - /** - * The details of the item requested. - * @type {Array} - * @memberof AccessRequestTrackingBeta - */ - 'requestedItemsDetails'?: Array; - /** - * a hash representation of the access requested, useful for longer term tracking client side. - * @type {number} - * @memberof AccessRequestTrackingBeta - */ - 'attributesHash'?: number; - /** - * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - * @type {Array} - * @memberof AccessRequestTrackingBeta - */ - 'accessRequestIds'?: Array; -} -/** - * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. - * @export - * @enum {string} - */ - -export const AccessRequestTypeBeta = { - GrantAccess: 'GRANT_ACCESS', - RevokeAccess: 'REVOKE_ACCESS', - ModifyAccess: 'MODIFY_ACCESS' -} as const; - -export type AccessRequestTypeBeta = typeof AccessRequestTypeBeta[keyof typeof AccessRequestTypeBeta]; - - -/** - * - * @export - * @interface AccessRequestedBeta - */ -export interface AccessRequestedBeta { - /** - * - * @type {AccessRequestResponse1Beta} - * @memberof AccessRequestedBeta - */ - 'accessRequest': AccessRequestResponse1Beta; - /** - * the identity id - * @type {string} - * @memberof AccessRequestedBeta - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessRequestedBeta - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessRequestedBeta - */ - 'dateTime'?: string; -} -/** - * Access type of API Client indicating online or offline use - * @export - * @enum {string} - */ - -export const AccessTypeBeta = { - Online: 'ONLINE', - Offline: 'OFFLINE' -} as const; - -export type AccessTypeBeta = typeof AccessTypeBeta[keyof typeof AccessTypeBeta]; - - -/** - * Object for specifying Actions to be performed on a specified list of sources\' account. - * @export - * @interface AccountActionBeta - */ -export interface AccountActionBeta { - /** - * Describes if action will be enable, disable or delete. - * @type {string} - * @memberof AccountActionBeta - */ - 'action'?: AccountActionBetaActionBeta; - /** - * A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. - * @type {Set} - * @memberof AccountActionBeta - */ - 'sourceIds'?: Set | null; - /** - * A list of source IDs to exclude from the action. Cannot be used together with sourceIds. - * @type {Set} - * @memberof AccountActionBeta - */ - 'excludeSourceIds'?: Set | null; - /** - * If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. - * @type {boolean} - * @memberof AccountActionBeta - */ - 'allSources'?: boolean; -} - -export const AccountActionBetaActionBeta = { - Enable: 'ENABLE', - Disable: 'DISABLE' -} as const; - -export type AccountActionBetaActionBeta = typeof AccountActionBetaActionBeta[keyof typeof AccountActionBetaActionBeta]; - -/** - * The state of an approval status - * @export - * @enum {string} - */ - -export const AccountActivityApprovalStatusBeta = { - Finished: 'FINISHED', - Rejected: 'REJECTED', - Returned: 'RETURNED', - Expired: 'EXPIRED', - Pending: 'PENDING', - Canceled: 'CANCELED' -} as const; - -export type AccountActivityApprovalStatusBeta = typeof AccountActivityApprovalStatusBeta[keyof typeof AccountActivityApprovalStatusBeta]; - - -/** - * - * @export - * @interface AccountActivityItemBeta - */ -export interface AccountActivityItemBeta { - /** - * Item id - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'id'?: string; - /** - * Human-readable display name of item - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'name'?: string; - /** - * Date and time item was requested - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'requested'?: string; - /** - * - * @type {AccountActivityApprovalStatusBeta} - * @memberof AccountActivityItemBeta - */ - 'approvalStatus'?: AccountActivityApprovalStatusBeta | null; - /** - * - * @type {ProvisioningStateBeta} - * @memberof AccountActivityItemBeta - */ - 'provisioningStatus'?: ProvisioningStateBeta; - /** - * - * @type {CommentBeta} - * @memberof AccountActivityItemBeta - */ - 'requesterComment'?: CommentBeta | null; - /** - * - * @type {IdentitySummaryBeta} - * @memberof AccountActivityItemBeta - */ - 'reviewerIdentitySummary'?: IdentitySummaryBeta | null; - /** - * - * @type {CommentBeta} - * @memberof AccountActivityItemBeta - */ - 'reviewerComment'?: CommentBeta | null; - /** - * - * @type {AccountActivityItemOperationBeta} - * @memberof AccountActivityItemBeta - */ - 'operation'?: AccountActivityItemOperationBeta | null; - /** - * Attribute to which account activity applies - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'attribute'?: string | null; - /** - * Value of attribute - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'value'?: string | null; - /** - * Native identity in the target system to which the account activity applies - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'nativeIdentity'?: string | null; - /** - * Id of Source to which account activity applies - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'sourceId'?: string; - /** - * - * @type {AccountRequestInfoBeta} - * @memberof AccountActivityItemBeta - */ - 'accountRequestInfo'?: AccountRequestInfoBeta | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof AccountActivityItemBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof AccountActivityItemBeta - */ - 'removeDate'?: string | null; -} - - -/** - * Represents an operation in an account activity item - * @export - * @enum {string} - */ - -export const AccountActivityItemOperationBeta = { - Add: 'ADD', - Create: 'CREATE', - Modify: 'MODIFY', - Delete: 'DELETE', - Disable: 'DISABLE', - Enable: 'ENABLE', - Unlock: 'UNLOCK', - Lock: 'LOCK', - Remove: 'REMOVE', - Set: 'SET' -} as const; - -export type AccountActivityItemOperationBeta = typeof AccountActivityItemOperationBeta[keyof typeof AccountActivityItemOperationBeta]; - - -/** - * - * @export - * @interface AccountAggregationBeta - */ -export interface AccountAggregationBeta { - /** - * When the aggregation started. - * @type {string} - * @memberof AccountAggregationBeta - */ - 'start'?: string; - /** - * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - * @type {string} - * @memberof AccountAggregationBeta - */ - 'status'?: AccountAggregationBetaStatusBeta; - /** - * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationBeta - */ - 'totalAccounts'?: number; - /** - * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationBeta - */ - 'processedAccounts'?: number; -} - -export const AccountAggregationBetaStatusBeta = { - Started: 'STARTED', - AccountsCollected: 'ACCOUNTS_COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Retried: 'RETRIED', - Terminated: 'TERMINATED' -} as const; - -export type AccountAggregationBetaStatusBeta = typeof AccountAggregationBetaStatusBeta[keyof typeof AccountAggregationBetaStatusBeta]; - -/** - * - * @export - * @interface AccountAggregationCompletedBeta - */ -export interface AccountAggregationCompletedBeta { - /** - * - * @type {AccountAggregationCompletedSourceBeta} - * @memberof AccountAggregationCompletedBeta - */ - 'source': AccountAggregationCompletedSourceBeta; - /** - * Aggregation\'s overall status. - * @type {object} - * @memberof AccountAggregationCompletedBeta - */ - 'status': AccountAggregationCompletedBetaStatusBeta; - /** - * Date and time when the account aggregation started. - * @type {string} - * @memberof AccountAggregationCompletedBeta - */ - 'started': string; - /** - * Date and time when the account aggregation finished. - * @type {string} - * @memberof AccountAggregationCompletedBeta - */ - 'completed': string; - /** - * List of errors that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedBeta - */ - 'errors': Array | null; - /** - * List of warnings that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedBeta - */ - 'warnings': Array | null; - /** - * - * @type {AccountAggregationCompletedStatsBeta} - * @memberof AccountAggregationCompletedBeta - */ - 'stats': AccountAggregationCompletedStatsBeta; -} - -export const AccountAggregationCompletedBetaStatusBeta = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountAggregationCompletedBetaStatusBeta = typeof AccountAggregationCompletedBetaStatusBeta[keyof typeof AccountAggregationCompletedBetaStatusBeta]; - -/** - * Source ISC is aggregating accounts from. - * @export - * @interface AccountAggregationCompletedSourceBeta - */ -export interface AccountAggregationCompletedSourceBeta { - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccountAggregationCompletedSourceBeta - */ - 'type': AccountAggregationCompletedSourceBetaTypeBeta; - /** - * Source\'s unique ID. - * @type {string} - * @memberof AccountAggregationCompletedSourceBeta - */ - 'id': string; - /** - * Source\'s name. - * @type {string} - * @memberof AccountAggregationCompletedSourceBeta - */ - 'name': string; -} - -export const AccountAggregationCompletedSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccountAggregationCompletedSourceBetaTypeBeta = typeof AccountAggregationCompletedSourceBetaTypeBeta[keyof typeof AccountAggregationCompletedSourceBetaTypeBeta]; - -/** - * Overall statistics about the account aggregation. - * @export - * @interface AccountAggregationCompletedStatsBeta - */ -export interface AccountAggregationCompletedStatsBeta { - /** - * Number of accounts scanned/iterated over. - * @type {number} - * @memberof AccountAggregationCompletedStatsBeta - */ - 'scanned': number; - /** - * Number of accounts that existed before but had no changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsBeta - */ - 'unchanged': number; - /** - * Number of accounts that existed before but had changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsBeta - */ - 'changed': number; - /** - * Number of accounts that are new and didn\'t previously exist. - * @type {number} - * @memberof AccountAggregationCompletedStatsBeta - */ - 'added': number; - /** - * Number accounts that existed before but were removed and no longer exist. - * @type {number} - * @memberof AccountAggregationCompletedStatsBeta - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountAggregationStatusBeta - */ -export interface AccountAggregationStatusBeta { - /** - * When the aggregation started. - * @type {string} - * @memberof AccountAggregationStatusBeta - */ - 'start'?: string; - /** - * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - * @type {string} - * @memberof AccountAggregationStatusBeta - */ - 'status'?: AccountAggregationStatusBetaStatusBeta; - /** - * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusBeta - */ - 'totalAccounts'?: number; - /** - * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusBeta - */ - 'processedAccounts'?: number; -} - -export const AccountAggregationStatusBetaStatusBeta = { - Started: 'STARTED', - AccountsCollected: 'ACCOUNTS_COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Retried: 'RETRIED', - Terminated: 'TERMINATED' -} as const; - -export type AccountAggregationStatusBetaStatusBeta = typeof AccountAggregationStatusBetaStatusBeta[keyof typeof AccountAggregationStatusBetaStatusBeta]; - -/** - * - * @export - * @interface AccountAttributeBeta - */ -export interface AccountAttributeBeta { - /** - * A reference to the source to search for the account - * @type {string} - * @memberof AccountAttributeBeta - */ - 'sourceName': string; - /** - * The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - * @type {string} - * @memberof AccountAttributeBeta - */ - 'attributeName': string; - /** - * The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - * @type {string} - * @memberof AccountAttributeBeta - */ - 'accountSortAttribute'?: string; - /** - * The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - * @type {boolean} - * @memberof AccountAttributeBeta - */ - 'accountSortDescending'?: boolean; - /** - * The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - * @type {boolean} - * @memberof AccountAttributeBeta - */ - 'accountReturnFirstLink'?: boolean; - /** - * This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - * @type {string} - * @memberof AccountAttributeBeta - */ - 'accountFilter'?: string; - /** - * This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. - * @type {string} - * @memberof AccountAttributeBeta - */ - 'accountPropertyFilter'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof AccountAttributeBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof AccountAttributeBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface AccountAttributesBeta - */ -export interface AccountAttributesBeta { - /** - * The schema attribute values for the account - * @type {object} - * @memberof AccountAttributesBeta - */ - 'attributes': object; -} -/** - * Details of the account where the attributes changed. - * @export - * @interface AccountAttributesChangedAccountBeta - */ -export interface AccountAttributesChangedAccountBeta { - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof AccountAttributesChangedAccountBeta - */ - 'id': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountAttributesChangedAccountBeta - */ - 'uuid': string | null; - /** - * Name of the account. - * @type {string} - * @memberof AccountAttributesChangedAccountBeta - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountAttributesChangedAccountBeta - */ - 'nativeIdentity': string; - /** - * The type of the account - * @type {object} - * @memberof AccountAttributesChangedAccountBeta - */ - 'type': AccountAttributesChangedAccountBetaTypeBeta; -} - -export const AccountAttributesChangedAccountBetaTypeBeta = { - Account: 'ACCOUNT' -} as const; - -export type AccountAttributesChangedAccountBetaTypeBeta = typeof AccountAttributesChangedAccountBetaTypeBeta[keyof typeof AccountAttributesChangedAccountBetaTypeBeta]; - -/** - * - * @export - * @interface AccountAttributesChangedBeta - */ -export interface AccountAttributesChangedBeta { - /** - * - * @type {AccountAttributesChangedIdentityBeta} - * @memberof AccountAttributesChangedBeta - */ - 'identity': AccountAttributesChangedIdentityBeta; - /** - * - * @type {AccountAttributesChangedSourceBeta} - * @memberof AccountAttributesChangedBeta - */ - 'source': AccountAttributesChangedSourceBeta; - /** - * - * @type {AccountAttributesChangedAccountBeta} - * @memberof AccountAttributesChangedBeta - */ - 'account': AccountAttributesChangedAccountBeta; - /** - * A list of attributes that changed. - * @type {Array} - * @memberof AccountAttributesChangedBeta - */ - 'changes': Array; -} -/** - * - * @export - * @interface AccountAttributesChangedChangesInnerBeta - */ -export interface AccountAttributesChangedChangesInnerBeta { - /** - * The name of the attribute. - * @type {string} - * @memberof AccountAttributesChangedChangesInnerBeta - */ - 'attribute': string; - /** - * - * @type {AccountAttributesChangedChangesInnerOldValueBeta} - * @memberof AccountAttributesChangedChangesInnerBeta - */ - 'oldValue': AccountAttributesChangedChangesInnerOldValueBeta | null; - /** - * - * @type {AccountAttributesChangedChangesInnerNewValueBeta} - * @memberof AccountAttributesChangedChangesInnerBeta - */ - 'newValue': AccountAttributesChangedChangesInnerNewValueBeta | null; -} -/** - * @type AccountAttributesChangedChangesInnerNewValueBeta - * The new value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerNewValueBeta = Array | boolean | string; - -/** - * @type AccountAttributesChangedChangesInnerOldValueBeta - * The previous value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerOldValueBeta = Array | boolean | string; - -/** - * The identity whose account attributes were updated. - * @export - * @interface AccountAttributesChangedIdentityBeta - */ -export interface AccountAttributesChangedIdentityBeta { - /** - * DTO type of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityBeta - */ - 'type': AccountAttributesChangedIdentityBetaTypeBeta; - /** - * ID of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityBeta - */ - 'id': string; - /** - * Display name of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityBeta - */ - 'name': string; -} - -export const AccountAttributesChangedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccountAttributesChangedIdentityBetaTypeBeta = typeof AccountAttributesChangedIdentityBetaTypeBeta[keyof typeof AccountAttributesChangedIdentityBetaTypeBeta]; - -/** - * The source that contains the account. - * @export - * @interface AccountAttributesChangedSourceBeta - */ -export interface AccountAttributesChangedSourceBeta { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceBeta - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountAttributesChangedSourceBeta - */ - 'type': AccountAttributesChangedSourceBetaTypeBeta; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceBeta - */ - 'name': string; -} - -export const AccountAttributesChangedSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccountAttributesChangedSourceBetaTypeBeta = typeof AccountAttributesChangedSourceBetaTypeBeta[keyof typeof AccountAttributesChangedSourceBetaTypeBeta]; - -/** - * The schema attribute values for the account - * @export - * @interface AccountAttributesCreateAttributesBeta - */ -export interface AccountAttributesCreateAttributesBeta { - [key: string]: string | any; - - /** - * Target source to create an account - * @type {string} - * @memberof AccountAttributesCreateAttributesBeta - */ - 'sourceId': string; -} -/** - * - * @export - * @interface AccountAttributesCreateBeta - */ -export interface AccountAttributesCreateBeta { - /** - * - * @type {AccountAttributesCreateAttributesBeta} - * @memberof AccountAttributesCreateBeta - */ - 'attributes': AccountAttributesCreateAttributesBeta; -} -/** - * - * @export - * @interface AccountBeta - */ -export interface AccountBeta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof AccountBeta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof AccountBeta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof AccountBeta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof AccountBeta - */ - 'modified'?: string; - /** - * The unique ID of the source this account belongs to - * @type {string} - * @memberof AccountBeta - */ - 'sourceId': string; - /** - * The display name of the source this account belongs to - * @type {string} - * @memberof AccountBeta - */ - 'sourceName': string | null; - /** - * The unique ID of the identity this account is correlated to - * @type {string} - * @memberof AccountBeta - */ - 'identityId'?: string; - /** - * The lifecycle state of the identity this account is correlated to - * @type {string} - * @memberof AccountBeta - */ - 'cloudLifecycleState'?: string | null; - /** - * The identity state of the identity this account is correlated to - * @type {string} - * @memberof AccountBeta - */ - 'identityState'?: string | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof AccountBeta - */ - 'connectionType'?: string | null; - /** - * Indicates if the account is of machine type - * @type {boolean} - * @memberof AccountBeta - */ - 'isMachine'?: boolean; - /** - * - * @type {RecommendationBeta} - * @memberof AccountBeta - */ - 'recommendation'?: RecommendationBeta | null; - /** - * The account attributes that are aggregated - * @type {{ [key: string]: any; }} - * @memberof AccountBeta - */ - 'attributes': { [key: string]: any; } | null; - /** - * Indicates if this account is from an authoritative source - * @type {boolean} - * @memberof AccountBeta - */ - 'authoritative': boolean; - /** - * A description of the account - * @type {string} - * @memberof AccountBeta - */ - 'description'?: string | null; - /** - * Indicates if the account is currently disabled - * @type {boolean} - * @memberof AccountBeta - */ - 'disabled': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof AccountBeta - */ - 'locked': boolean; - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountBeta - */ - 'nativeIdentity': string; - /** - * If true, this is a user account within IdentityNow. If false, this is an account from a source system. - * @type {boolean} - * @memberof AccountBeta - */ - 'systemAccount': boolean; - /** - * Indicates if this account is not correlated to an identity - * @type {boolean} - * @memberof AccountBeta - */ - 'uncorrelated': boolean; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof AccountBeta - */ - 'uuid'?: string | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof AccountBeta - */ - 'manuallyCorrelated': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof AccountBeta - */ - 'hasEntitlements': boolean; - /** - * - * @type {BaseReferenceDtoBeta} - * @memberof AccountBeta - */ - 'identity'?: BaseReferenceDtoBeta; - /** - * - * @type {BaseReferenceDtoBeta} - * @memberof AccountBeta - */ - 'sourceOwner'?: BaseReferenceDtoBeta; - /** - * A string list containing the owning source\'s features - * @type {string} - * @memberof AccountBeta - */ - 'features'?: string | null; - /** - * The origin of the account either aggregated or provisioned - * @type {string} - * @memberof AccountBeta - */ - 'origin'?: AccountBetaOriginBeta | null; - /** - * - * @type {BaseReferenceDtoBeta} - * @memberof AccountBeta - */ - 'ownerIdentity'?: BaseReferenceDtoBeta; -} - -export const AccountBetaOriginBeta = { - Aggregated: 'AGGREGATED', - Provisioned: 'PROVISIONED' -} as const; - -export type AccountBetaOriginBeta = typeof AccountBetaOriginBeta[keyof typeof AccountBetaOriginBeta]; - -/** - * The correlated account. - * @export - * @interface AccountCorrelatedAccountBeta - */ -export interface AccountCorrelatedAccountBeta { - /** - * The correlated account\'s DTO type. - * @type {string} - * @memberof AccountCorrelatedAccountBeta - */ - 'type': AccountCorrelatedAccountBetaTypeBeta; - /** - * The correlated account\'s ID. - * @type {string} - * @memberof AccountCorrelatedAccountBeta - */ - 'id': string; - /** - * The correlated account\'s display name. - * @type {string} - * @memberof AccountCorrelatedAccountBeta - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountCorrelatedAccountBeta - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountCorrelatedAccountBeta - */ - 'uuid'?: string | null; -} - -export const AccountCorrelatedAccountBetaTypeBeta = { - Account: 'ACCOUNT' -} as const; - -export type AccountCorrelatedAccountBetaTypeBeta = typeof AccountCorrelatedAccountBetaTypeBeta[keyof typeof AccountCorrelatedAccountBetaTypeBeta]; - -/** - * - * @export - * @interface AccountCorrelatedBeta - */ -export interface AccountCorrelatedBeta { - /** - * - * @type {AccountCorrelatedIdentityBeta} - * @memberof AccountCorrelatedBeta - */ - 'identity': AccountCorrelatedIdentityBeta; - /** - * - * @type {AccountCorrelatedSourceBeta} - * @memberof AccountCorrelatedBeta - */ - 'source': AccountCorrelatedSourceBeta; - /** - * - * @type {AccountCorrelatedAccountBeta} - * @memberof AccountCorrelatedBeta - */ - 'account': AccountCorrelatedAccountBeta; - /** - * The attributes associated with the account. Attributes are unique per source. - * @type {{ [key: string]: any; }} - * @memberof AccountCorrelatedBeta - */ - 'attributes': { [key: string]: any; }; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountCorrelatedBeta - */ - 'entitlementCount'?: number; -} -/** - * Identity the account is correlated with. - * @export - * @interface AccountCorrelatedIdentityBeta - */ -export interface AccountCorrelatedIdentityBeta { - /** - * DTO type of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityBeta - */ - 'type': AccountCorrelatedIdentityBetaTypeBeta; - /** - * ID of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityBeta - */ - 'id': string; - /** - * Display name of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityBeta - */ - 'name': string; -} - -export const AccountCorrelatedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccountCorrelatedIdentityBetaTypeBeta = typeof AccountCorrelatedIdentityBetaTypeBeta[keyof typeof AccountCorrelatedIdentityBetaTypeBeta]; - -/** - * The source the accounts are being correlated from. - * @export - * @interface AccountCorrelatedSourceBeta - */ -export interface AccountCorrelatedSourceBeta { - /** - * The DTO type of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceBeta - */ - 'type': AccountCorrelatedSourceBetaTypeBeta; - /** - * The ID of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceBeta - */ - 'id': string; - /** - * Display name of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceBeta - */ - 'name': string; -} - -export const AccountCorrelatedSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccountCorrelatedSourceBetaTypeBeta = typeof AccountCorrelatedSourceBetaTypeBeta[keyof typeof AccountCorrelatedSourceBetaTypeBeta]; - -/** - * - * @export - * @interface AccountInfoDtoBeta - */ -export interface AccountInfoDtoBeta { - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountInfoDtoBeta - */ - 'nativeIdentity'?: string; - /** - * Display name for this account - * @type {string} - * @memberof AccountInfoDtoBeta - */ - 'displayName'?: string; - /** - * UUID associated with this account - * @type {string} - * @memberof AccountInfoDtoBeta - */ - 'uuid'?: string; -} -/** - * - * @export - * @interface AccountItemRefBeta - */ -export interface AccountItemRefBeta { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountItemRefBeta - */ - 'accountUuid'?: string | null; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountItemRefBeta - */ - 'nativeIdentity'?: string; -} -/** - * If an account activity item is associated with an access request, captures details of that request. - * @export - * @interface AccountRequestInfoBeta - */ -export interface AccountRequestInfoBeta { - /** - * Id of requested object - * @type {string} - * @memberof AccountRequestInfoBeta - */ - 'requestedObjectId'?: string; - /** - * Human-readable name of requested object - * @type {string} - * @memberof AccountRequestInfoBeta - */ - 'requestedObjectName'?: string; - /** - * - * @type {RequestableObjectTypeBeta} - * @memberof AccountRequestInfoBeta - */ - 'requestedObjectType'?: RequestableObjectTypeBeta; -} - - -/** - * - * @export - * @interface AccountStatusChangedAccountBeta - */ -export interface AccountStatusChangedAccountBeta { - /** - * the ID of the account in the database - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'id'?: string; - /** - * the native identifier of the account - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'nativeIdentity'?: string; - /** - * the display name of the account - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'displayName'?: string; - /** - * the ID of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'sourceId'?: string; - /** - * the name of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'sourceName'?: string; - /** - * the number of entitlements on this account - * @type {number} - * @memberof AccountStatusChangedAccountBeta - */ - 'entitlementCount'?: number; - /** - * this value is always \"account\" - * @type {string} - * @memberof AccountStatusChangedAccountBeta - */ - 'accessType'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedBeta - */ -export interface AccountStatusChangedBeta { - /** - * the event type - * @type {string} - * @memberof AccountStatusChangedBeta - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AccountStatusChangedBeta - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AccountStatusChangedBeta - */ - 'dateTime'?: string; - /** - * - * @type {AccountStatusChangedAccountBeta} - * @memberof AccountStatusChangedBeta - */ - 'account': AccountStatusChangedAccountBeta; - /** - * - * @type {AccountStatusChangedStatusChangeBeta} - * @memberof AccountStatusChangedBeta - */ - 'statusChange': AccountStatusChangedStatusChangeBeta; -} -/** - * - * @export - * @interface AccountStatusChangedStatusChangeBeta - */ -export interface AccountStatusChangedStatusChangeBeta { - /** - * the previous status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeBeta - */ - 'previousStatus'?: AccountStatusChangedStatusChangeBetaPreviousStatusBeta; - /** - * the new status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeBeta - */ - 'newStatus'?: AccountStatusChangedStatusChangeBetaNewStatusBeta; -} - -export const AccountStatusChangedStatusChangeBetaPreviousStatusBeta = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeBetaPreviousStatusBeta = typeof AccountStatusChangedStatusChangeBetaPreviousStatusBeta[keyof typeof AccountStatusChangedStatusChangeBetaPreviousStatusBeta]; -export const AccountStatusChangedStatusChangeBetaNewStatusBeta = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeBetaNewStatusBeta = typeof AccountStatusChangedStatusChangeBetaNewStatusBeta[keyof typeof AccountStatusChangedStatusChangeBetaNewStatusBeta]; - -/** - * Request used for account enable/disable - * @export - * @interface AccountToggleRequestBeta - */ -export interface AccountToggleRequestBeta { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountToggleRequestBeta - */ - 'externalVerificationId'?: string; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountToggleRequestBeta - */ - 'forceProvisioning'?: boolean; -} -/** - * Uncorrelated account. - * @export - * @interface AccountUncorrelatedAccountBeta - */ -export interface AccountUncorrelatedAccountBeta { - /** - * Uncorrelated account\'s DTO type. - * @type {object} - * @memberof AccountUncorrelatedAccountBeta - */ - 'type': AccountUncorrelatedAccountBetaTypeBeta; - /** - * Uncorrelated account\'s ID. - * @type {string} - * @memberof AccountUncorrelatedAccountBeta - */ - 'id': string; - /** - * Uncorrelated account\'s display name. - * @type {string} - * @memberof AccountUncorrelatedAccountBeta - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountUncorrelatedAccountBeta - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountUncorrelatedAccountBeta - */ - 'uuid'?: string | null; -} - -export const AccountUncorrelatedAccountBetaTypeBeta = { - Account: 'ACCOUNT' -} as const; - -export type AccountUncorrelatedAccountBetaTypeBeta = typeof AccountUncorrelatedAccountBetaTypeBeta[keyof typeof AccountUncorrelatedAccountBetaTypeBeta]; - -/** - * - * @export - * @interface AccountUncorrelatedBeta - */ -export interface AccountUncorrelatedBeta { - /** - * - * @type {AccountUncorrelatedIdentityBeta} - * @memberof AccountUncorrelatedBeta - */ - 'identity': AccountUncorrelatedIdentityBeta; - /** - * - * @type {AccountUncorrelatedSourceBeta} - * @memberof AccountUncorrelatedBeta - */ - 'source': AccountUncorrelatedSourceBeta; - /** - * - * @type {AccountUncorrelatedAccountBeta} - * @memberof AccountUncorrelatedBeta - */ - 'account': AccountUncorrelatedAccountBeta; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountUncorrelatedBeta - */ - 'entitlementCount'?: number; -} -/** - * Identity the account is uncorrelated with. - * @export - * @interface AccountUncorrelatedIdentityBeta - */ -export interface AccountUncorrelatedIdentityBeta { - /** - * DTO type of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityBeta - */ - 'type': AccountUncorrelatedIdentityBetaTypeBeta; - /** - * ID of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityBeta - */ - 'id': string; - /** - * Display name of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityBeta - */ - 'name': string; -} - -export const AccountUncorrelatedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AccountUncorrelatedIdentityBetaTypeBeta = typeof AccountUncorrelatedIdentityBetaTypeBeta[keyof typeof AccountUncorrelatedIdentityBetaTypeBeta]; - -/** - * The source the accounts are uncorrelated from. - * @export - * @interface AccountUncorrelatedSourceBeta - */ -export interface AccountUncorrelatedSourceBeta { - /** - * The DTO type of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceBeta - */ - 'type': AccountUncorrelatedSourceBetaTypeBeta; - /** - * The ID of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceBeta - */ - 'id': string; - /** - * Display name of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceBeta - */ - 'name': string; -} - -export const AccountUncorrelatedSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccountUncorrelatedSourceBetaTypeBeta = typeof AccountUncorrelatedSourceBetaTypeBeta[keyof typeof AccountUncorrelatedSourceBetaTypeBeta]; - -/** - * Request used for account unlock - * @export - * @interface AccountUnlockRequestBeta - */ -export interface AccountUnlockRequestBeta { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountUnlockRequestBeta - */ - 'externalVerificationId'?: string; - /** - * If set, the IDN account is unlocked after the workflow completes. - * @type {boolean} - * @memberof AccountUnlockRequestBeta - */ - 'unlockIDNAccount'?: boolean; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountUnlockRequestBeta - */ - 'forceProvisioning'?: boolean; -} -/** - * - * @export - * @interface AccountUsageBeta - */ -export interface AccountUsageBeta { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof AccountUsageBeta - */ - 'date'?: string; - /** - * The number of days within the month that the account was active in a source. - * @type {number} - * @memberof AccountUsageBeta - */ - 'count'?: number; -} -/** - * Accounts async response containing details on started async process - * @export - * @interface AccountsAsyncResultBeta - */ -export interface AccountsAsyncResultBeta { - /** - * id of the task - * @type {string} - * @memberof AccountsAsyncResultBeta - */ - 'id': string; -} -/** - * - * @export - * @interface AccountsCollectedForAggregationBeta - */ -export interface AccountsCollectedForAggregationBeta { - /** - * - * @type {AccountsCollectedForAggregationSourceBeta} - * @memberof AccountsCollectedForAggregationBeta - */ - 'source': AccountsCollectedForAggregationSourceBeta; - /** - * The overall status of the collection. - * @type {object} - * @memberof AccountsCollectedForAggregationBeta - */ - 'status': AccountsCollectedForAggregationBetaStatusBeta; - /** - * The date and time when the account collection started. - * @type {string} - * @memberof AccountsCollectedForAggregationBeta - */ - 'started': string; - /** - * The date and time when the account collection finished. - * @type {string} - * @memberof AccountsCollectedForAggregationBeta - */ - 'completed': string; - /** - * A list of errors that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationBeta - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationBeta - */ - 'warnings': Array | null; - /** - * - * @type {AccountsCollectedForAggregationStatsBeta} - * @memberof AccountsCollectedForAggregationBeta - */ - 'stats': AccountsCollectedForAggregationStatsBeta; -} - -export const AccountsCollectedForAggregationBetaStatusBeta = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountsCollectedForAggregationBetaStatusBeta = typeof AccountsCollectedForAggregationBetaStatusBeta[keyof typeof AccountsCollectedForAggregationBetaStatusBeta]; - -/** - * Reference to the source that has been aggregated. - * @export - * @interface AccountsCollectedForAggregationSourceBeta - */ -export interface AccountsCollectedForAggregationSourceBeta { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceBeta - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountsCollectedForAggregationSourceBeta - */ - 'type': AccountsCollectedForAggregationSourceBetaTypeBeta; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceBeta - */ - 'name': string; -} - -export const AccountsCollectedForAggregationSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AccountsCollectedForAggregationSourceBetaTypeBeta = typeof AccountsCollectedForAggregationSourceBetaTypeBeta[keyof typeof AccountsCollectedForAggregationSourceBetaTypeBeta]; - -/** - * Overall statistics about the account collection. - * @export - * @interface AccountsCollectedForAggregationStatsBeta - */ -export interface AccountsCollectedForAggregationStatsBeta { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsBeta - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsBeta - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsBeta - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsBeta - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountsCollectedForAggregationStatsBeta - */ - 'removed': number; -} -/** - * - * @export - * @interface ActivateCampaignOptionsBeta - */ -export interface ActivateCampaignOptionsBeta { - /** - * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - * @type {string} - * @memberof ActivateCampaignOptionsBeta - */ - 'timeZone'?: string; -} -/** - * Reference to an additional owner (identity or governance group). - * @export - * @interface AdditionalOwnerRefBeta - */ -export interface AdditionalOwnerRefBeta { - /** - * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. - * @type {string} - * @memberof AdditionalOwnerRefBeta - */ - 'type'?: AdditionalOwnerRefBetaTypeBeta; - /** - * ID of the identity or governance group. - * @type {string} - * @memberof AdditionalOwnerRefBeta - */ - 'id'?: string; - /** - * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. - * @type {string} - * @memberof AdditionalOwnerRefBeta - */ - 'name'?: string | null; -} - -export const AdditionalOwnerRefBetaTypeBeta = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AdditionalOwnerRefBetaTypeBeta = typeof AdditionalOwnerRefBetaTypeBeta[keyof typeof AdditionalOwnerRefBetaTypeBeta]; - -/** - * - * @export - * @interface AdminReviewReassignBeta - */ -export interface AdminReviewReassignBeta { - /** - * List of certification IDs to reassign - * @type {Array} - * @memberof AdminReviewReassignBeta - */ - 'certificationIds'?: Array; - /** - * - * @type {AdminReviewReassignReassignToBeta} - * @memberof AdminReviewReassignBeta - */ - 'reassignTo'?: AdminReviewReassignReassignToBeta; - /** - * Comment to explain why the certification was reassigned - * @type {string} - * @memberof AdminReviewReassignBeta - */ - 'reason'?: string; -} -/** - * - * @export - * @interface AdminReviewReassignReassignToBeta - */ -export interface AdminReviewReassignReassignToBeta { - /** - * The identity ID to which the review is being assigned. - * @type {string} - * @memberof AdminReviewReassignReassignToBeta - */ - 'id'?: string; - /** - * The type of the ID provided. - * @type {string} - * @memberof AdminReviewReassignReassignToBeta - */ - 'type'?: AdminReviewReassignReassignToBetaTypeBeta; -} - -export const AdminReviewReassignReassignToBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type AdminReviewReassignReassignToBetaTypeBeta = typeof AdminReviewReassignReassignToBetaTypeBeta[keyof typeof AdminReviewReassignReassignToBetaTypeBeta]; - -/** - * - * @export - * @interface AppAccountDetailsBeta - */ -export interface AppAccountDetailsBeta { - /** - * The source app ID - * @type {string} - * @memberof AppAccountDetailsBeta - */ - 'appId'?: string; - /** - * The source app display name - * @type {string} - * @memberof AppAccountDetailsBeta - */ - 'appDisplayName'?: string; - /** - * - * @type {AppAccountDetailsSourceAccountBeta} - * @memberof AppAccountDetailsBeta - */ - 'sourceAccount'?: AppAccountDetailsSourceAccountBeta; -} -/** - * - * @export - * @interface AppAccountDetailsSourceAccountBeta - */ -export interface AppAccountDetailsSourceAccountBeta { - /** - * The account ID - * @type {string} - * @memberof AppAccountDetailsSourceAccountBeta - */ - 'id'?: string; - /** - * The native identity of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountBeta - */ - 'nativeIdentity'?: string; - /** - * The display name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountBeta - */ - 'displayName'?: string; - /** - * The source ID of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountBeta - */ - 'sourceId'?: string; - /** - * The source name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountBeta - */ - 'sourceDisplayName'?: string; -} -/** - * - * @export - * @interface ApprovalForwardHistory1Beta - */ -export interface ApprovalForwardHistory1Beta { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory1Beta - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory1Beta - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistory1Beta - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory1Beta - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistory1Beta - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentTypeBeta} - * @memberof ApprovalForwardHistory1Beta - */ - 'reassignmentType'?: ReassignmentTypeBeta; -} - - -/** - * - * @export - * @interface ApprovalForwardHistoryBeta - */ -export interface ApprovalForwardHistoryBeta { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryBeta - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryBeta - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistoryBeta - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryBeta - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistoryBeta - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentTypeBeta} - * @memberof ApprovalForwardHistoryBeta - */ - 'reassignmentType'?: ReassignmentTypeBeta; -} - - -/** - * - * @export - * @interface ApprovalInfoResponseBeta - */ -export interface ApprovalInfoResponseBeta { - /** - * the id of approver - * @type {string} - * @memberof ApprovalInfoResponseBeta - */ - 'id'?: string; - /** - * the name of approver - * @type {string} - * @memberof ApprovalInfoResponseBeta - */ - 'name'?: string; - /** - * the status of the approval request - * @type {string} - * @memberof ApprovalInfoResponseBeta - */ - 'status'?: string; -} -/** - * - * @export - * @interface ApprovalItemDetailsBeta - */ -export interface ApprovalItemDetailsBeta { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemDetailsBeta - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateBeta} - * @memberof ApprovalItemDetailsBeta - */ - 'state'?: WorkItemStateBeta | null; -} - - -/** - * - * @export - * @interface ApprovalItemsBeta - */ -export interface ApprovalItemsBeta { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemsBeta - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateBeta} - * @memberof ApprovalItemsBeta - */ - 'state'?: WorkItemStateBeta | null; -} - - -/** - * - * @export - * @interface ApprovalReminderAndEscalationConfigBeta - */ -export interface ApprovalReminderAndEscalationConfigBeta { - /** - * Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigBeta - */ - 'daysUntilEscalation'?: number | null; - /** - * Number of days to wait between reminder notifications. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigBeta - */ - 'daysBetweenReminders'?: number | null; - /** - * Maximum number of reminder notification to send to the reviewer before approval escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigBeta - */ - 'maxReminders'?: number | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailBeta} - * @memberof ApprovalReminderAndEscalationConfigBeta - */ - 'fallbackApproverRef'?: IdentityReferenceWithNameAndEmailBeta | null; -} -/** - * Describes the individual or group that is responsible for an approval step. - * @export - * @enum {string} - */ - -export const ApprovalSchemeBeta = { - AppOwner: 'APP_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - RoleOwner: 'ROLE_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeBeta = typeof ApprovalSchemeBeta[keyof typeof ApprovalSchemeBeta]; - - -/** - * - * @export - * @interface ApprovalSchemeForRoleBeta - */ -export interface ApprovalSchemeForRoleBeta { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof ApprovalSchemeForRoleBeta - */ - 'approverType'?: ApprovalSchemeForRoleBetaApproverTypeBeta; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof ApprovalSchemeForRoleBeta - */ - 'approverId'?: string | null; -} - -export const ApprovalSchemeForRoleBetaApproverTypeBeta = { - Owner: 'OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeForRoleBetaApproverTypeBeta = typeof ApprovalSchemeForRoleBetaApproverTypeBeta[keyof typeof ApprovalSchemeForRoleBetaApproverTypeBeta]; - -/** - * Enum representing the non-employee request approval status - * @export - * @enum {string} - */ - -export const ApprovalStatusBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Pending: 'PENDING', - NotReady: 'NOT_READY', - Cancelled: 'CANCELLED' -} as const; - -export type ApprovalStatusBeta = typeof ApprovalStatusBeta[keyof typeof ApprovalStatusBeta]; - - -/** - * - * @export - * @interface ApprovalStatusDto1Beta - */ -export interface ApprovalStatusDto1Beta { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDto1Beta - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwnerBeta} - * @memberof ApprovalStatusDto1Beta - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwnerBeta; - /** - * - * @type {ApprovalStatusDtoCurrentOwnerBeta} - * @memberof ApprovalStatusDto1Beta - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwnerBeta; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDto1Beta - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemStateBeta} - * @memberof ApprovalStatusDto1Beta - */ - 'status'?: ManualWorkItemStateBeta; - /** - * - * @type {ApprovalSchemeBeta} - * @memberof ApprovalStatusDto1Beta - */ - 'scheme'?: ApprovalSchemeBeta; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDto1Beta - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDto1Beta - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDto1Beta - */ - 'removeDate'?: string | null; -} - - -/** - * - * @export - * @interface ApprovalStatusDtoBeta - */ -export interface ApprovalStatusDtoBeta { - /** - * Unique identifier for the approval. - * @type {string} - * @memberof ApprovalStatusDtoBeta - */ - 'approvalId'?: string | null; - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDtoBeta - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwnerBeta} - * @memberof ApprovalStatusDtoBeta - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwnerBeta; - /** - * - * @type {ApprovalStatusDtoCurrentOwnerBeta} - * @memberof ApprovalStatusDtoBeta - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwnerBeta; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDtoBeta - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemStateBeta} - * @memberof ApprovalStatusDtoBeta - */ - 'status'?: ManualWorkItemStateBeta; - /** - * - * @type {ApprovalSchemeBeta} - * @memberof ApprovalStatusDtoBeta - */ - 'scheme'?: ApprovalSchemeBeta; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDtoBeta - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDtoBeta - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDtoBeta - */ - 'removeDate'?: string | null; -} - - -/** - * - * @export - * @interface ApprovalStatusDtoCurrentOwnerBeta - */ -export interface ApprovalStatusDtoCurrentOwnerBeta { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerBeta - */ - 'type'?: ApprovalStatusDtoCurrentOwnerBetaTypeBeta; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerBeta - */ - 'name'?: string; -} - -export const ApprovalStatusDtoCurrentOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoCurrentOwnerBetaTypeBeta = typeof ApprovalStatusDtoCurrentOwnerBetaTypeBeta[keyof typeof ApprovalStatusDtoCurrentOwnerBetaTypeBeta]; - -/** - * Identity of orginal approval owner. - * @export - * @interface ApprovalStatusDtoOriginalOwnerBeta - */ -export interface ApprovalStatusDtoOriginalOwnerBeta { - /** - * DTO type of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerBeta - */ - 'type'?: ApprovalStatusDtoOriginalOwnerBetaTypeBeta; - /** - * ID of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerBeta - */ - 'id'?: string; - /** - * Display name of original approval owner. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerBeta - */ - 'name'?: string; -} - -export const ApprovalStatusDtoOriginalOwnerBetaTypeBeta = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoOriginalOwnerBetaTypeBeta = typeof ApprovalStatusDtoOriginalOwnerBetaTypeBeta[keyof typeof ApprovalStatusDtoOriginalOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface ApprovalSummaryBeta - */ -export interface ApprovalSummaryBeta { - /** - * The number of pending access requests approvals. - * @type {number} - * @memberof ApprovalSummaryBeta - */ - 'pending'?: number; - /** - * The number of approved access requests approvals. - * @type {number} - * @memberof ApprovalSummaryBeta - */ - 'approved'?: number; - /** - * The number of rejected access requests approvals. - * @type {number} - * @memberof ApprovalSummaryBeta - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface ArgumentBeta - */ -export interface ArgumentBeta { - /** - * the name of the argument - * @type {string} - * @memberof ArgumentBeta - */ - 'name': string; - /** - * the description of the argument - * @type {string} - * @memberof ArgumentBeta - */ - 'description'?: string; - /** - * the programmatic type of the argument - * @type {string} - * @memberof ArgumentBeta - */ - 'type'?: string | null; -} -/** - * - * @export - * @interface ArrayInner1Beta - */ -export interface ArrayInner1Beta { -} -/** - * - * @export - * @interface ArrayInner2Beta - */ -export interface ArrayInner2Beta { -} -/** - * - * @export - * @interface ArrayInnerBeta - */ -export interface ArrayInnerBeta { -} -/** - * - * @export - * @interface AssignmentContextDtoBeta - */ -export interface AssignmentContextDtoBeta { - /** - * - * @type {AccessRequestContextBeta} - * @memberof AssignmentContextDtoBeta - */ - 'requested'?: AccessRequestContextBeta; - /** - * - * @type {Array} - * @memberof AssignmentContextDtoBeta - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof AssignmentContextDtoBeta - */ - 'computedDate'?: string; -} -/** - * Specification of source attribute sync mapping configuration for an identity attribute - * @export - * @interface AttrSyncSourceAttributeConfigBeta - */ -export interface AttrSyncSourceAttributeConfigBeta { - /** - * Name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigBeta - */ - 'name': string; - /** - * Display name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigBeta - */ - 'displayName': string; - /** - * Determines whether or not the attribute is enabled for synchronization - * @type {boolean} - * @memberof AttrSyncSourceAttributeConfigBeta - */ - 'enabled': boolean; - /** - * Name of the source account attribute to which the identity attribute value will be synchronized if enabled - * @type {string} - * @memberof AttrSyncSourceAttributeConfigBeta - */ - 'target': string; -} -/** - * Target source for attribute synchronization. - * @export - * @interface AttrSyncSourceBeta - */ -export interface AttrSyncSourceBeta { - /** - * DTO type of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceBeta - */ - 'type'?: AttrSyncSourceBetaTypeBeta; - /** - * ID of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceBeta - */ - 'id'?: string; - /** - * Human-readable name of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceBeta - */ - 'name'?: string; -} - -export const AttrSyncSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type AttrSyncSourceBetaTypeBeta = typeof AttrSyncSourceBetaTypeBeta[keyof typeof AttrSyncSourceBetaTypeBeta]; - -/** - * Specification of attribute sync configuration for a source - * @export - * @interface AttrSyncSourceConfigBeta - */ -export interface AttrSyncSourceConfigBeta { - /** - * - * @type {AttrSyncSourceBeta} - * @memberof AttrSyncSourceConfigBeta - */ - 'source': AttrSyncSourceBeta; - /** - * Attribute synchronization configuration for specific identity attributes in the context of a source - * @type {Array} - * @memberof AttrSyncSourceConfigBeta - */ - 'attributes': Array; -} -/** - * - * @export - * @interface AttributeChangeBeta - */ -export interface AttributeChangeBeta { - /** - * the attribute name - * @type {string} - * @memberof AttributeChangeBeta - */ - 'name'?: string; - /** - * the old value of attribute - * @type {string} - * @memberof AttributeChangeBeta - */ - 'previousValue'?: string; - /** - * the new value of attribute - * @type {string} - * @memberof AttributeChangeBeta - */ - 'newValue'?: string; -} -/** - * - * @export - * @interface AttributeDTOBeta - */ -export interface AttributeDTOBeta { - /** - * Technical name of the Attribute. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeDTOBeta - */ - 'key'?: string; - /** - * The display name of the key. - * @type {string} - * @memberof AttributeDTOBeta - */ - 'name'?: string; - /** - * Indicates whether the attribute can have multiple values. - * @type {boolean} - * @memberof AttributeDTOBeta - */ - 'multiselect'?: boolean; - /** - * The status of the Attribute. - * @type {string} - * @memberof AttributeDTOBeta - */ - 'status'?: string; - /** - * The type of the Attribute. This can be either \"custom\" or \"governance\". - * @type {string} - * @memberof AttributeDTOBeta - */ - 'type'?: string; - /** - * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. - * @type {Array} - * @memberof AttributeDTOBeta - */ - 'objectTypes'?: Array | null; - /** - * The description of the Attribute. - * @type {string} - * @memberof AttributeDTOBeta - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof AttributeDTOBeta - */ - 'values'?: Array | null; -} -/** - * - * @export - * @interface AttributeDTOListBeta - */ -export interface AttributeDTOListBeta { - /** - * - * @type {Array} - * @memberof AttributeDTOListBeta - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface AttributeDefinitionBeta - */ -export interface AttributeDefinitionBeta { - /** - * The name of the attribute. - * @type {string} - * @memberof AttributeDefinitionBeta - */ - 'name'?: string; - /** - * Attribute name in the native system. - * @type {string} - * @memberof AttributeDefinitionBeta - */ - 'nativeName'?: string | null; - /** - * - * @type {AttributeDefinitionTypeBeta} - * @memberof AttributeDefinitionBeta - */ - 'type'?: AttributeDefinitionTypeBeta; - /** - * - * @type {AttributeDefinitionSchemaBeta} - * @memberof AttributeDefinitionBeta - */ - 'schema'?: AttributeDefinitionSchemaBeta | null; - /** - * A human-readable description of the attribute. - * @type {string} - * @memberof AttributeDefinitionBeta - */ - 'description'?: string; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof AttributeDefinitionBeta - */ - 'isMulti'?: boolean; - /** - * Flag indicating whether or not the attribute is an entitlement. - * @type {boolean} - * @memberof AttributeDefinitionBeta - */ - 'isEntitlement'?: boolean; - /** - * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute. - * @type {boolean} - * @memberof AttributeDefinitionBeta - */ - 'isGroup'?: boolean; -} - - -/** - * A reference to the schema on the source to the attribute values map to. - * @export - * @interface AttributeDefinitionSchemaBeta - */ -export interface AttributeDefinitionSchemaBeta { - /** - * The type of object being referenced - * @type {string} - * @memberof AttributeDefinitionSchemaBeta - */ - 'type'?: AttributeDefinitionSchemaBetaTypeBeta; - /** - * The object ID this reference applies to. - * @type {string} - * @memberof AttributeDefinitionSchemaBeta - */ - 'id'?: string; - /** - * The human-readable display name of the object. - * @type {string} - * @memberof AttributeDefinitionSchemaBeta - */ - 'name'?: string; -} - -export const AttributeDefinitionSchemaBetaTypeBeta = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type AttributeDefinitionSchemaBetaTypeBeta = typeof AttributeDefinitionSchemaBetaTypeBeta[keyof typeof AttributeDefinitionSchemaBetaTypeBeta]; - -/** - * The underlying type of the value which an AttributeDefinition represents. - * @export - * @enum {string} - */ - -export const AttributeDefinitionTypeBeta = { - String: 'STRING', - Long: 'LONG', - Int: 'INT', - Boolean: 'BOOLEAN', - Date: 'DATE' -} as const; - -export type AttributeDefinitionTypeBeta = typeof AttributeDefinitionTypeBeta[keyof typeof AttributeDefinitionTypeBeta]; - - -/** - * - * @export - * @interface AttributeValueDTOBeta - */ -export interface AttributeValueDTOBeta { - /** - * Technical name of the Attribute value. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeValueDTOBeta - */ - 'value'?: string; - /** - * The display name of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOBeta - */ - 'name'?: string; - /** - * The status of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOBeta - */ - 'status'?: string; -} -/** - * - * @export - * @interface AttributesChangedBeta - */ -export interface AttributesChangedBeta { - /** - * - * @type {Array} - * @memberof AttributesChangedBeta - */ - 'attributeChanges': Array; - /** - * the event type - * @type {string} - * @memberof AttributesChangedBeta - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AttributesChangedBeta - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AttributesChangedBeta - */ - 'dateTime'?: string; -} -/** - * Audit details for the reassignment configuration of an identity - * @export - * @interface AuditDetailsBeta - */ -export interface AuditDetailsBeta { - /** - * Initial date and time when the record was created - * @type {string} - * @memberof AuditDetailsBeta - */ - 'created'?: string; - /** - * - * @type {Identity1Beta} - * @memberof AuditDetailsBeta - */ - 'createdBy'?: Identity1Beta; - /** - * Last modified date and time for the record - * @type {string} - * @memberof AuditDetailsBeta - */ - 'modified'?: string; - /** - * - * @type {Identity1Beta} - * @memberof AuditDetailsBeta - */ - 'modifiedBy'?: Identity1Beta; -} -/** - * - * @export - * @interface AuthProfileBeta - */ -export interface AuthProfileBeta { - /** - * Authentication Profile name. - * @type {string} - * @memberof AuthProfileBeta - */ - 'name'?: string; - /** - * Use it to block access from off network. - * @type {boolean} - * @memberof AuthProfileBeta - */ - 'offNetwork'?: boolean; - /** - * Use it to block access from untrusted geoographies. - * @type {boolean} - * @memberof AuthProfileBeta - */ - 'untrustedGeography'?: boolean; - /** - * Application ID. - * @type {string} - * @memberof AuthProfileBeta - */ - 'applicationId'?: string; - /** - * Application name. - * @type {string} - * @memberof AuthProfileBeta - */ - 'applicationName'?: string; - /** - * Type of the Authentication Profile. - * @type {string} - * @memberof AuthProfileBeta - */ - 'type'?: AuthProfileBetaTypeBeta; - /** - * Use it to enable strong authentication. - * @type {boolean} - * @memberof AuthProfileBeta - */ - 'strongAuthLogin'?: boolean; -} - -export const AuthProfileBetaTypeBeta = { - Block: 'BLOCK', - Mfa: 'MFA', - NonPta: 'NON_PTA', - Pta: 'PTA' -} as const; - -export type AuthProfileBetaTypeBeta = typeof AuthProfileBetaTypeBeta[keyof typeof AuthProfileBetaTypeBeta]; - -/** - * - * @export - * @interface AuthProfileSummaryBeta - */ -export interface AuthProfileSummaryBeta { - /** - * Tenant name. - * @type {string} - * @memberof AuthProfileSummaryBeta - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthProfileSummaryBeta - */ - 'id'?: string; -} -/** - * - * @export - * @interface Base64DecodeBeta - */ -export interface Base64DecodeBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64DecodeBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64DecodeBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Base64EncodeBeta - */ -export interface Base64EncodeBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64EncodeBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64EncodeBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface BaseCommonDto1Beta - */ -export interface BaseCommonDto1Beta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDto1Beta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDto1Beta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDto1Beta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDto1Beta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseCommonDtoBeta - */ -export interface BaseCommonDtoBeta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDtoBeta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDtoBeta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDtoBeta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDtoBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseReferenceDto1Beta - */ -export interface BaseReferenceDto1Beta { - /** - * the application ID - * @type {string} - * @memberof BaseReferenceDto1Beta - */ - 'id'?: string; - /** - * the application name - * @type {string} - * @memberof BaseReferenceDto1Beta - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseReferenceDtoBeta - */ -export interface BaseReferenceDtoBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof BaseReferenceDtoBeta - */ - 'type'?: DtoTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoBeta - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface BaseRoleReferenceDtoBeta - */ -export interface BaseRoleReferenceDtoBeta { - /** - * DTO type - * @type {string} - * @memberof BaseRoleReferenceDtoBeta - */ - 'type'?: string; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseRoleReferenceDtoBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseRoleReferenceDtoBeta - */ - 'name'?: string; -} -/** - * Config required if BASIC_AUTH is used. - * @export - * @interface BasicAuthConfigBeta - */ -export interface BasicAuthConfigBeta { - /** - * The username to authenticate. - * @type {string} - * @memberof BasicAuthConfigBeta - */ - 'userName'?: string; - /** - * The password to authenticate. On response, this field is set to null as to not return secrets. - * @type {string} - * @memberof BasicAuthConfigBeta - */ - 'password'?: string | null; -} -/** - * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. - * @export - * @interface BearerTokenAuthConfigBeta - */ -export interface BearerTokenAuthConfigBeta { - /** - * Bearer token - * @type {string} - * @memberof BearerTokenAuthConfigBeta - */ - 'bearerToken'?: string | null; -} -/** - * Before Provisioning Rule. - * @export - * @interface BeforeProvisioningRuleDtoBeta - */ -export interface BeforeProvisioningRuleDtoBeta { - /** - * Before Provisioning Rule DTO type. - * @type {string} - * @memberof BeforeProvisioningRuleDtoBeta - */ - 'type'?: BeforeProvisioningRuleDtoBetaTypeBeta; - /** - * Before Provisioning Rule ID. - * @type {string} - * @memberof BeforeProvisioningRuleDtoBeta - */ - 'id'?: string; - /** - * Rule display name. - * @type {string} - * @memberof BeforeProvisioningRuleDtoBeta - */ - 'name'?: string; -} - -export const BeforeProvisioningRuleDtoBetaTypeBeta = { - Rule: 'RULE' -} as const; - -export type BeforeProvisioningRuleDtoBetaTypeBeta = typeof BeforeProvisioningRuleDtoBetaTypeBeta[keyof typeof BeforeProvisioningRuleDtoBetaTypeBeta]; - -/** - * Bulk response object. - * @export - * @interface BulkIdentitiesAccountsResponseBeta - */ -export interface BulkIdentitiesAccountsResponseBeta { - /** - * Identifier of bulk request item. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseBeta - */ - 'id'?: string; - /** - * Response status value. - * @type {number} - * @memberof BulkIdentitiesAccountsResponseBeta - */ - 'statusCode'?: number; - /** - * Status containing additional context information about failures. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseBeta - */ - 'message'?: string; -} -/** - * - * @export - * @interface BulkTaggedObjectBeta - */ -export interface BulkTaggedObjectBeta { - /** - * - * @type {Array} - * @memberof BulkTaggedObjectBeta - */ - 'objectRefs'?: Array; - /** - * Label to be applied to object. - * @type {Array} - * @memberof BulkTaggedObjectBeta - */ - 'tags'?: Array; - /** - * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - * @type {string} - * @memberof BulkTaggedObjectBeta - */ - 'operation'?: BulkTaggedObjectBetaOperationBeta; -} - -export const BulkTaggedObjectBetaOperationBeta = { - Append: 'APPEND', - Merge: 'MERGE' -} as const; - -export type BulkTaggedObjectBetaOperationBeta = typeof BulkTaggedObjectBetaOperationBeta[keyof typeof BulkTaggedObjectBetaOperationBeta]; - -/** - * Identity\'s basic details. - * @export - * @interface BulkWorkgroupMembersRequestInnerBeta - */ -export interface BulkWorkgroupMembersRequestInnerBeta { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof BulkWorkgroupMembersRequestInnerBeta - */ - 'type'?: BulkWorkgroupMembersRequestInnerBetaTypeBeta; - /** - * Identity ID. - * @type {string} - * @memberof BulkWorkgroupMembersRequestInnerBeta - */ - 'id'?: string; - /** - * Identity\'s display name. - * @type {string} - * @memberof BulkWorkgroupMembersRequestInnerBeta - */ - 'name'?: string; -} - -export const BulkWorkgroupMembersRequestInnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type BulkWorkgroupMembersRequestInnerBetaTypeBeta = typeof BulkWorkgroupMembersRequestInnerBetaTypeBeta[keyof typeof BulkWorkgroupMembersRequestInnerBetaTypeBeta]; - -/** - * - * @export - * @interface CampaignActivatedBeta - */ -export interface CampaignActivatedBeta { - /** - * - * @type {CampaignActivatedCampaignBeta} - * @memberof CampaignActivatedBeta - */ - 'campaign': CampaignActivatedCampaignBeta; -} -/** - * Details about the certification campaign that was activated. - * @export - * @interface CampaignActivatedCampaignBeta - */ -export interface CampaignActivatedCampaignBeta { - /** - * Campaign\'s unique ID. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'id': string; - /** - * Campaign\'s name. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'name': string; - /** - * Campaign\'s extended description. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'description': string; - /** - * Date and time when the campaign was created. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'created': string; - /** - * Date and time when the campaign was last modified. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'modified'?: string | null; - /** - * Date and time when the campaign is due. - * @type {string} - * @memberof CampaignActivatedCampaignBeta - */ - 'deadline': string; - /** - * Campaign\'s type. - * @type {object} - * @memberof CampaignActivatedCampaignBeta - */ - 'type': CampaignActivatedCampaignBetaTypeBeta; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerBeta} - * @memberof CampaignActivatedCampaignBeta - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerBeta; - /** - * Campaign\'s current status. - * @type {object} - * @memberof CampaignActivatedCampaignBeta - */ - 'status': CampaignActivatedCampaignBetaStatusBeta; -} - -export const CampaignActivatedCampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignActivatedCampaignBetaTypeBeta = typeof CampaignActivatedCampaignBetaTypeBeta[keyof typeof CampaignActivatedCampaignBetaTypeBeta]; -export const CampaignActivatedCampaignBetaStatusBeta = { - Active: 'ACTIVE' -} as const; - -export type CampaignActivatedCampaignBetaStatusBeta = typeof CampaignActivatedCampaignBetaStatusBeta[keyof typeof CampaignActivatedCampaignBetaStatusBeta]; - -/** - * Details of the identity who owns the campaign. - * @export - * @interface CampaignActivatedCampaignCampaignOwnerBeta - */ -export interface CampaignActivatedCampaignCampaignOwnerBeta { - /** - * Identity\'s unique ID. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerBeta - */ - 'id': string; - /** - * Identity\'s name. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerBeta - */ - 'displayName': string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerBeta - */ - 'email': string; -} -/** - * - * @export - * @interface CampaignAlertBeta - */ -export interface CampaignAlertBeta { - /** - * Denotes the level of the message - * @type {string} - * @memberof CampaignAlertBeta - */ - 'level'?: CampaignAlertBetaLevelBeta; - /** - * - * @type {Array} - * @memberof CampaignAlertBeta - */ - 'localizations'?: Array; -} - -export const CampaignAlertBetaLevelBeta = { - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO' -} as const; - -export type CampaignAlertBetaLevelBeta = typeof CampaignAlertBetaLevelBeta[keyof typeof CampaignAlertBetaLevelBeta]; - -/** - * - * @export - * @interface CampaignBeta - */ -export interface CampaignBeta { - /** - * Id of the campaign - * @type {string} - * @memberof CampaignBeta - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignBeta - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignBeta - */ - 'description': string; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof CampaignBeta - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof CampaignBeta - */ - 'type': CampaignBetaTypeBeta; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof CampaignBeta - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof CampaignBeta - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof CampaignBeta - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof CampaignBeta - */ - 'status'?: CampaignBetaStatusBeta; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignBeta - */ - 'correlatedStatus'?: CampaignBetaCorrelatedStatusBeta; - /** - * Created time of the campaign - * @type {string} - * @memberof CampaignBeta - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof CampaignBeta - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof CampaignBeta - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof CampaignBeta - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof CampaignBeta - */ - 'modified'?: string; - /** - * - * @type {FullcampaignAllOfFilterBeta} - * @memberof CampaignBeta - */ - 'filter'?: FullcampaignAllOfFilterBeta; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof CampaignBeta - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {FullcampaignAllOfSourceOwnerCampaignInfoBeta} - * @memberof CampaignBeta - */ - 'sourceOwnerCampaignInfo'?: FullcampaignAllOfSourceOwnerCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfSearchCampaignInfoBeta} - * @memberof CampaignBeta - */ - 'searchCampaignInfo'?: FullcampaignAllOfSearchCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfRoleCompositionCampaignInfoBeta} - * @memberof CampaignBeta - */ - 'roleCompositionCampaignInfo'?: FullcampaignAllOfRoleCompositionCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfMachineAccountCampaignInfoBeta} - * @memberof CampaignBeta - */ - 'machineAccountCampaignInfo'?: FullcampaignAllOfMachineAccountCampaignInfoBeta; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof CampaignBeta - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignBeta - */ - 'mandatoryCommentRequirement'?: CampaignBetaMandatoryCommentRequirementBeta; -} - -export const CampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignBetaTypeBeta = typeof CampaignBetaTypeBeta[keyof typeof CampaignBetaTypeBeta]; -export const CampaignBetaStatusBeta = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type CampaignBetaStatusBeta = typeof CampaignBetaStatusBeta[keyof typeof CampaignBetaStatusBeta]; -export const CampaignBetaCorrelatedStatusBeta = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignBetaCorrelatedStatusBeta = typeof CampaignBetaCorrelatedStatusBeta[keyof typeof CampaignBetaCorrelatedStatusBeta]; -export const CampaignBetaMandatoryCommentRequirementBeta = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignBetaMandatoryCommentRequirementBeta = typeof CampaignBetaMandatoryCommentRequirementBeta[keyof typeof CampaignBetaMandatoryCommentRequirementBeta]; - -/** - * - * @export - * @interface CampaignEndedBeta - */ -export interface CampaignEndedBeta { - /** - * - * @type {CampaignEndedCampaignBeta} - * @memberof CampaignEndedBeta - */ - 'campaign': CampaignEndedCampaignBeta; -} -/** - * Details about the certification campaign that ended. - * @export - * @interface CampaignEndedCampaignBeta - */ -export interface CampaignEndedCampaignBeta { - /** - * Campaign\'s unique ID for the campaign. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'id': string; - /** - * Campaign\'s unique ID. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'name': string; - /** - * Campaign\'s extended description. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'description': string; - /** - * Date and time when the campaign was created. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'created': string; - /** - * Date and time when the campaign was last modified. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'modified'?: string | null; - /** - * Date and time when the campaign is due. - * @type {string} - * @memberof CampaignEndedCampaignBeta - */ - 'deadline': string; - /** - * Campaign\'s type. - * @type {object} - * @memberof CampaignEndedCampaignBeta - */ - 'type': CampaignEndedCampaignBetaTypeBeta; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerBeta} - * @memberof CampaignEndedCampaignBeta - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerBeta; - /** - * Campaign\'s current status. - * @type {object} - * @memberof CampaignEndedCampaignBeta - */ - 'status': CampaignEndedCampaignBetaStatusBeta; -} - -export const CampaignEndedCampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignEndedCampaignBetaTypeBeta = typeof CampaignEndedCampaignBetaTypeBeta[keyof typeof CampaignEndedCampaignBetaTypeBeta]; -export const CampaignEndedCampaignBetaStatusBeta = { - Completed: 'COMPLETED' -} as const; - -export type CampaignEndedCampaignBetaStatusBeta = typeof CampaignEndedCampaignBetaStatusBeta[keyof typeof CampaignEndedCampaignBetaStatusBeta]; - -/** - * - * @export - * @interface CampaignGeneratedBeta - */ -export interface CampaignGeneratedBeta { - /** - * - * @type {CampaignGeneratedCampaignBeta} - * @memberof CampaignGeneratedBeta - */ - 'campaign': CampaignGeneratedCampaignBeta; -} -/** - * Details about the campaign that was generated. - * @export - * @interface CampaignGeneratedCampaignBeta - */ -export interface CampaignGeneratedCampaignBeta { - /** - * Campaign\'s unique ID. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'id': string; - /** - * Campaign\'s name. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'name': string; - /** - * Campaign\'s extended description. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'description': string; - /** - * Date and time when the campaign was created. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'created': string; - /** - * Date and time when the campaign was last modified. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'modified'?: string | null; - /** - * Date and time when the campaign must be finished. - * @type {string} - * @memberof CampaignGeneratedCampaignBeta - */ - 'deadline'?: string | null; - /** - * Campaign\'s type. - * @type {object} - * @memberof CampaignGeneratedCampaignBeta - */ - 'type': CampaignGeneratedCampaignBetaTypeBeta; - /** - * - * @type {CampaignGeneratedCampaignCampaignOwnerBeta} - * @memberof CampaignGeneratedCampaignBeta - */ - 'campaignOwner': CampaignGeneratedCampaignCampaignOwnerBeta; - /** - * Campaign\'s current status. - * @type {object} - * @memberof CampaignGeneratedCampaignBeta - */ - 'status': CampaignGeneratedCampaignBetaStatusBeta; -} - -export const CampaignGeneratedCampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignGeneratedCampaignBetaTypeBeta = typeof CampaignGeneratedCampaignBetaTypeBeta[keyof typeof CampaignGeneratedCampaignBetaTypeBeta]; -export const CampaignGeneratedCampaignBetaStatusBeta = { - Staged: 'STAGED', - Activating: 'ACTIVATING', - Active: 'ACTIVE' -} as const; - -export type CampaignGeneratedCampaignBetaStatusBeta = typeof CampaignGeneratedCampaignBetaStatusBeta[keyof typeof CampaignGeneratedCampaignBetaStatusBeta]; - -/** - * Identity who owns the campaign. - * @export - * @interface CampaignGeneratedCampaignCampaignOwnerBeta - */ -export interface CampaignGeneratedCampaignCampaignOwnerBeta { - /** - * Identity\'s unique ID. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerBeta - */ - 'id': string; - /** - * Identity\'s name. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerBeta - */ - 'displayName': string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerBeta - */ - 'email': string; -} -/** - * - * @export - * @interface CampaignReferenceBeta - */ -export interface CampaignReferenceBeta { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'id': string; - /** - * The name of the campaign. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'name': string; - /** - * The type of object that is being referenced. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'type': CampaignReferenceBetaTypeBeta; - /** - * The type of the campaign. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'campaignType': CampaignReferenceBetaCampaignTypeBeta; - /** - * The description of the campaign set by the admin who created it. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'description': string | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'correlatedStatus': CampaignReferenceBetaCorrelatedStatusBeta; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignReferenceBeta - */ - 'mandatoryCommentRequirement': CampaignReferenceBetaMandatoryCommentRequirementBeta; -} - -export const CampaignReferenceBetaTypeBeta = { - Campaign: 'CAMPAIGN' -} as const; - -export type CampaignReferenceBetaTypeBeta = typeof CampaignReferenceBetaTypeBeta[keyof typeof CampaignReferenceBetaTypeBeta]; -export const CampaignReferenceBetaCampaignTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignReferenceBetaCampaignTypeBeta = typeof CampaignReferenceBetaCampaignTypeBeta[keyof typeof CampaignReferenceBetaCampaignTypeBeta]; -export const CampaignReferenceBetaCorrelatedStatusBeta = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignReferenceBetaCorrelatedStatusBeta = typeof CampaignReferenceBetaCorrelatedStatusBeta[keyof typeof CampaignReferenceBetaCorrelatedStatusBeta]; -export const CampaignReferenceBetaMandatoryCommentRequirementBeta = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignReferenceBetaMandatoryCommentRequirementBeta = typeof CampaignReferenceBetaMandatoryCommentRequirementBeta[keyof typeof CampaignReferenceBetaMandatoryCommentRequirementBeta]; - -/** - * - * @export - * @interface CampaignReportBeta - */ -export interface CampaignReportBeta { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof CampaignReportBeta - */ - 'type'?: CampaignReportBetaTypeBeta; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof CampaignReportBeta - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof CampaignReportBeta - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof CampaignReportBeta - */ - 'status'?: CampaignReportBetaStatusBeta; - /** - * - * @type {ReportTypeBeta} - * @memberof CampaignReportBeta - */ - 'reportType': ReportTypeBeta; - /** - * The most recent date and time this report was run - * @type {string} - * @memberof CampaignReportBeta - */ - 'lastRunAt'?: string; -} - -export const CampaignReportBetaTypeBeta = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type CampaignReportBetaTypeBeta = typeof CampaignReportBetaTypeBeta[keyof typeof CampaignReportBetaTypeBeta]; -export const CampaignReportBetaStatusBeta = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type CampaignReportBetaStatusBeta = typeof CampaignReportBetaStatusBeta[keyof typeof CampaignReportBetaStatusBeta]; - -/** - * - * @export - * @interface CampaignReportsConfigBeta - */ -export interface CampaignReportsConfigBeta { - /** - * list of identity attribute columns - * @type {Array} - * @memberof CampaignReportsConfigBeta - */ - 'identityAttributeColumns'?: Array | null; -} -/** - * Campaign Template - * @export - * @interface CampaignTemplateBeta - */ -export interface CampaignTemplateBeta { - /** - * Id of the campaign template - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'id'?: string; - /** - * This template\'s name. Has no bearing on generated campaigns\' names. - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'name': string; - /** - * This template\'s description. Has no bearing on generated campaigns\' descriptions. - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'description': string; - /** - * Creation date of Campaign Template - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'created': string; - /** - * Modification date of Campaign Template - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'modified': string | null; - /** - * Indicates if this campaign template has been scheduled. - * @type {boolean} - * @memberof CampaignTemplateBeta - */ - 'scheduled'?: boolean; - /** - * - * @type {CampaignTemplateOwnerRefBeta} - * @memberof CampaignTemplateBeta - */ - 'ownerRef'?: CampaignTemplateOwnerRefBeta; - /** - * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). - * @type {string} - * @memberof CampaignTemplateBeta - */ - 'deadlineDuration'?: string; - /** - * - * @type {CampaignBeta} - * @memberof CampaignTemplateBeta - */ - 'campaign': CampaignBeta; -} -/** - * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. - * @export - * @interface CampaignTemplateOwnerRefBeta - */ -export interface CampaignTemplateOwnerRefBeta { - /** - * Id of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefBeta - */ - 'id'?: string; - /** - * Type of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefBeta - */ - 'type'?: CampaignTemplateOwnerRefBetaTypeBeta; - /** - * Name of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefBeta - */ - 'name'?: string; - /** - * Email of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefBeta - */ - 'email'?: string; -} - -export const CampaignTemplateOwnerRefBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type CampaignTemplateOwnerRefBetaTypeBeta = typeof CampaignTemplateOwnerRefBetaTypeBeta[keyof typeof CampaignTemplateOwnerRefBetaTypeBeta]; - -/** - * Request body payload for cancel access request endpoint. - * @export - * @interface CancelAccessRequestBeta - */ -export interface CancelAccessRequestBeta { - /** - * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - * @type {string} - * @memberof CancelAccessRequestBeta - */ - 'accountActivityId': string; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof CancelAccessRequestBeta - */ - 'comment': string; -} -/** - * - * @export - * @interface CancelableAccountActivityBeta - */ -export interface CancelableAccountActivityBeta { - /** - * ID of the account activity itself - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'modified'?: string | null; - /** - * - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'completed'?: string | null; - /** - * - * @type {CompletionStatusBeta} - * @memberof CancelableAccountActivityBeta - */ - 'completionStatus'?: CompletionStatusBeta | null; - /** - * - * @type {string} - * @memberof CancelableAccountActivityBeta - */ - 'type'?: string | null; - /** - * - * @type {IdentitySummaryBeta} - * @memberof CancelableAccountActivityBeta - */ - 'requesterIdentitySummary'?: IdentitySummaryBeta | null; - /** - * - * @type {IdentitySummaryBeta} - * @memberof CancelableAccountActivityBeta - */ - 'targetIdentitySummary'?: IdentitySummaryBeta | null; - /** - * - * @type {Array} - * @memberof CancelableAccountActivityBeta - */ - 'errors'?: Array | null; - /** - * - * @type {Array} - * @memberof CancelableAccountActivityBeta - */ - 'warnings'?: Array | null; - /** - * - * @type {Array} - * @memberof CancelableAccountActivityBeta - */ - 'items'?: Array | null; - /** - * - * @type {ExecutionStatusBeta} - * @memberof CancelableAccountActivityBeta - */ - 'executionStatus'?: ExecutionStatusBeta; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof CancelableAccountActivityBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * Whether the account activity can be canceled before completion - * @type {boolean} - * @memberof CancelableAccountActivityBeta - */ - 'cancelable'?: boolean; - /** - * - * @type {CommentBeta} - * @memberof CancelableAccountActivityBeta - */ - 'cancelComment'?: CommentBeta | null; -} - - -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetails1Beta - */ -export interface CancelledRequestDetails1Beta { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetails1Beta - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoBeta} - * @memberof CancelledRequestDetails1Beta - */ - 'owner'?: OwnerDtoBeta; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetails1Beta - */ - 'modified'?: string; -} -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetailsBeta - */ -export interface CancelledRequestDetailsBeta { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsBeta - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoBeta} - * @memberof CancelledRequestDetailsBeta - */ - 'owner'?: OwnerDtoBeta; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface CertificationDtoBeta - */ -export interface CertificationDtoBeta { - /** - * - * @type {CampaignReferenceBeta} - * @memberof CertificationDtoBeta - */ - 'campaignRef': CampaignReferenceBeta; - /** - * - * @type {CertificationPhaseBeta} - * @memberof CertificationDtoBeta - */ - 'phase': CertificationPhaseBeta; - /** - * Date and time when the certification is due. - * @type {string} - * @memberof CertificationDtoBeta - */ - 'due': string; - /** - * Date and time when the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationDtoBeta - */ - 'signed': string; - /** - * - * @type {ReviewerBeta} - * @memberof CertificationDtoBeta - */ - 'reviewer': ReviewerBeta; - /** - * - * @type {ReassignmentBeta} - * @memberof CertificationDtoBeta - */ - 'reassignment'?: ReassignmentBeta; - /** - * Indicates whether the certification has any errors. - * @type {boolean} - * @memberof CertificationDtoBeta - */ - 'hasErrors': boolean; - /** - * Message indicating what the error is. - * @type {string} - * @memberof CertificationDtoBeta - */ - 'errorMessage'?: string | null; - /** - * Indicates whether all certification decisions have been made. - * @type {boolean} - * @memberof CertificationDtoBeta - */ - 'completed': boolean; - /** - * Number of approve/revoke/acknowledge decisions the reviewer has made. - * @type {number} - * @memberof CertificationDtoBeta - */ - 'decisionsMade': number; - /** - * Total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationDtoBeta - */ - 'decisionsTotal': number; - /** - * Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. - * @type {number} - * @memberof CertificationDtoBeta - */ - 'entitiesCompleted': number; - /** - * Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationDtoBeta - */ - 'entitiesTotal': number; -} - - -/** - * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - * @export - * @enum {string} - */ - -export const CertificationPhaseBeta = { - Staged: 'STAGED', - Active: 'ACTIVE', - Signed: 'SIGNED' -} as const; - -export type CertificationPhaseBeta = typeof CertificationPhaseBeta[keyof typeof CertificationPhaseBeta]; - - -/** - * Previous certification. - * @export - * @interface CertificationReferenceBeta - */ -export interface CertificationReferenceBeta { - /** - * DTO type of certification for review. - * @type {string} - * @memberof CertificationReferenceBeta - */ - 'type'?: CertificationReferenceBetaTypeBeta; - /** - * ID of certification for review. - * @type {string} - * @memberof CertificationReferenceBeta - */ - 'id'?: string; - /** - * Display name of certification for review. - * @type {string} - * @memberof CertificationReferenceBeta - */ - 'name'?: string; - /** - * - * @type {ReviewerBeta} - * @memberof CertificationReferenceBeta - */ - 'reviewer'?: ReviewerBeta; -} - -export const CertificationReferenceBetaTypeBeta = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceBetaTypeBeta = typeof CertificationReferenceBetaTypeBeta[keyof typeof CertificationReferenceBetaTypeBeta]; - -/** - * Certification for review. - * @export - * @interface CertificationReferenceDtoBeta - */ -export interface CertificationReferenceDtoBeta { - /** - * DTO type of certification for review. - * @type {string} - * @memberof CertificationReferenceDtoBeta - */ - 'type'?: CertificationReferenceDtoBetaTypeBeta; - /** - * ID of certification for review. - * @type {string} - * @memberof CertificationReferenceDtoBeta - */ - 'id'?: string; - /** - * Display name of certification for review. - * @type {string} - * @memberof CertificationReferenceDtoBeta - */ - 'name'?: string; -} - -export const CertificationReferenceDtoBetaTypeBeta = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceDtoBetaTypeBeta = typeof CertificationReferenceDtoBetaTypeBeta[keyof typeof CertificationReferenceDtoBetaTypeBeta]; - -/** - * - * @export - * @interface CertificationSignedOffBeta - */ -export interface CertificationSignedOffBeta { - /** - * - * @type {CertificationSignedOffCertificationBeta} - * @memberof CertificationSignedOffBeta - */ - 'certification': CertificationSignedOffCertificationBeta; -} -/** - * Certification campaign that was signed off on. - * @export - * @interface CertificationSignedOffCertificationBeta - */ -export interface CertificationSignedOffCertificationBeta { - /** - * Certification\'s unique ID. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'id': string; - /** - * Certification\'s name. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'name': string; - /** - * Date and time when the certification was created. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'created': string; - /** - * Date and time when the certification was last modified. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'modified'?: string | null; - /** - * - * @type {CampaignReferenceBeta} - * @memberof CertificationSignedOffCertificationBeta - */ - 'campaignRef': CampaignReferenceBeta; - /** - * - * @type {CertificationPhaseBeta} - * @memberof CertificationSignedOffCertificationBeta - */ - 'phase': CertificationPhaseBeta; - /** - * Date and time when the certification is due. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'due': string; - /** - * Date and time when the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'signed': string; - /** - * - * @type {ReviewerBeta} - * @memberof CertificationSignedOffCertificationBeta - */ - 'reviewer': ReviewerBeta; - /** - * - * @type {ReassignmentBeta} - * @memberof CertificationSignedOffCertificationBeta - */ - 'reassignment'?: ReassignmentBeta; - /** - * Indicates whether the certification has any errors. - * @type {boolean} - * @memberof CertificationSignedOffCertificationBeta - */ - 'hasErrors': boolean; - /** - * Message indicating what the error is. - * @type {string} - * @memberof CertificationSignedOffCertificationBeta - */ - 'errorMessage'?: string | null; - /** - * Indicates whether all certification decisions have been made. - * @type {boolean} - * @memberof CertificationSignedOffCertificationBeta - */ - 'completed': boolean; - /** - * Number of approve/revoke/acknowledge decisions the reviewer has made. - * @type {number} - * @memberof CertificationSignedOffCertificationBeta - */ - 'decisionsMade': number; - /** - * Total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationSignedOffCertificationBeta - */ - 'decisionsTotal': number; - /** - * Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. - * @type {number} - * @memberof CertificationSignedOffCertificationBeta - */ - 'entitiesCompleted': number; - /** - * Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationSignedOffCertificationBeta - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationTaskBeta - */ -export interface CertificationTaskBeta { - /** - * The ID of the certification task. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'id'?: string; - /** - * The type of the certification task. More values may be added in the future. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'type'?: CertificationTaskBetaTypeBeta; - /** - * The type of item that is being operated on by this task whose ID is stored in the targetId field. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'targetType'?: CertificationTaskBetaTargetTypeBeta; - /** - * The ID of the item being operated on by this task. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'targetId'?: string; - /** - * The status of the task. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'status'?: CertificationTaskBetaStatusBeta; - /** - * - * @type {Array} - * @memberof CertificationTaskBeta - */ - 'errors'?: Array; - /** - * The date and time on which this task was created. - * @type {string} - * @memberof CertificationTaskBeta - */ - 'created'?: string; -} - -export const CertificationTaskBetaTypeBeta = { - Reassign: 'REASSIGN', - AdminReassign: 'ADMIN_REASSIGN', - CompleteCertification: 'COMPLETE_CERTIFICATION', - FinishCertification: 'FINISH_CERTIFICATION', - CompleteCampaign: 'COMPLETE_CAMPAIGN', - ActivateCampaign: 'ACTIVATE_CAMPAIGN', - CampaignCreate: 'CAMPAIGN_CREATE', - CampaignDelete: 'CAMPAIGN_DELETE' -} as const; - -export type CertificationTaskBetaTypeBeta = typeof CertificationTaskBetaTypeBeta[keyof typeof CertificationTaskBetaTypeBeta]; -export const CertificationTaskBetaTargetTypeBeta = { - Certification: 'CERTIFICATION', - Campaign: 'CAMPAIGN' -} as const; - -export type CertificationTaskBetaTargetTypeBeta = typeof CertificationTaskBetaTargetTypeBeta[keyof typeof CertificationTaskBetaTargetTypeBeta]; -export const CertificationTaskBetaStatusBeta = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type CertificationTaskBetaStatusBeta = typeof CertificationTaskBetaStatusBeta[keyof typeof CertificationTaskBetaStatusBeta]; - -/** - * - * @export - * @interface CertifierResponseBeta - */ -export interface CertifierResponseBeta { - /** - * the id of the certifier - * @type {string} - * @memberof CertifierResponseBeta - */ - 'id'?: string; - /** - * the name of the certifier - * @type {string} - * @memberof CertifierResponseBeta - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface ChildrenBeta - */ -export interface ChildrenBeta { - /** - * - * @type {string} - * @memberof ChildrenBeta - */ - 'operator'?: string; - /** - * - * @type {string} - * @memberof ChildrenBeta - */ - 'attribute'?: string; - /** - * - * @type {ValueBeta} - * @memberof ChildrenBeta - */ - 'value'?: ValueBeta | null; - /** - * - * @type {string} - * @memberof ChildrenBeta - */ - 'children'?: string | null; -} -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationBeta - */ -export interface ClientLogConfigurationBeta { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationBeta - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults - * @type {number} - * @memberof ClientLogConfigurationBeta - */ - 'durationMinutes': number; - /** - * Expiration date-time of the log configuration request - * @type {string} - * @memberof ClientLogConfigurationBeta - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelBeta} - * @memberof ClientLogConfigurationBeta - */ - 'rootLevel': StandardLevelBeta; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelBeta; }} - * @memberof ClientLogConfigurationBeta - */ - 'logLevels'?: { [key: string]: StandardLevelBeta; }; -} - - -/** - * Type of an API Client indicating public or confidentials use - * @export - * @enum {string} - */ - -export const ClientTypeBeta = { - Confidential: 'CONFIDENTIAL', - Public: 'PUBLIC' -} as const; - -export type ClientTypeBeta = typeof ClientTypeBeta[keyof typeof ClientTypeBeta]; - - -/** - * Request body payload for close access requests endpoint. - * @export - * @interface CloseAccessRequestBeta - */ -export interface CloseAccessRequestBeta { - /** - * Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. - * @type {Array} - * @memberof CloseAccessRequestBeta - */ - 'accessRequestIds': Array; - /** - * Reason for closing the access request. Displayed under Warnings in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestBeta - */ - 'message'?: string; - /** - * The request\'s provisioning status. Displayed as Stage in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestBeta - */ - 'executionStatus'?: CloseAccessRequestBetaExecutionStatusBeta; - /** - * The request\'s overall status. Displayed as Status in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestBeta - */ - 'completionStatus'?: CloseAccessRequestBetaCompletionStatusBeta; -} - -export const CloseAccessRequestBetaExecutionStatusBeta = { - Terminated: 'Terminated', - Completed: 'Completed' -} as const; - -export type CloseAccessRequestBetaExecutionStatusBeta = typeof CloseAccessRequestBetaExecutionStatusBeta[keyof typeof CloseAccessRequestBetaExecutionStatusBeta]; -export const CloseAccessRequestBetaCompletionStatusBeta = { - Success: 'Success', - Incomplete: 'Incomplete', - Failure: 'Failure' -} as const; - -export type CloseAccessRequestBetaCompletionStatusBeta = typeof CloseAccessRequestBetaCompletionStatusBeta[keyof typeof CloseAccessRequestBetaCompletionStatusBeta]; - -/** - * - * @export - * @interface CommentBeta - */ -export interface CommentBeta { - /** - * Id of the identity making the comment - * @type {string} - * @memberof CommentBeta - */ - 'commenterId'?: string; - /** - * Human-readable display name of the identity making the comment - * @type {string} - * @memberof CommentBeta - */ - 'commenterName'?: string; - /** - * Content of the comment - * @type {string} - * @memberof CommentBeta - */ - 'body'?: string; - /** - * Date and time comment was made - * @type {string} - * @memberof CommentBeta - */ - 'date'?: string; -} -/** - * Author of the comment - * @export - * @interface CommentDto1AuthorBeta - */ -export interface CommentDto1AuthorBeta { - /** - * The type of object - * @type {string} - * @memberof CommentDto1AuthorBeta - */ - 'type'?: CommentDto1AuthorBetaTypeBeta; - /** - * The unique ID of the object - * @type {string} - * @memberof CommentDto1AuthorBeta - */ - 'id'?: string; - /** - * The display name of the object - * @type {string} - * @memberof CommentDto1AuthorBeta - */ - 'name'?: string; -} - -export const CommentDto1AuthorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type CommentDto1AuthorBetaTypeBeta = typeof CommentDto1AuthorBetaTypeBeta[keyof typeof CommentDto1AuthorBetaTypeBeta]; - -/** - * - * @export - * @interface CommentDto1Beta - */ -export interface CommentDto1Beta { - /** - * Comment content. - * @type {string} - * @memberof CommentDto1Beta - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDto1Beta - */ - 'created'?: string; - /** - * - * @type {CommentDto1AuthorBeta} - * @memberof CommentDto1Beta - */ - 'author'?: CommentDto1AuthorBeta; -} -/** - * - * @export - * @interface CommentDtoAuthorBeta - */ -export interface CommentDtoAuthorBeta { - /** - * DTO type of the commenting identity. - * @type {string} - * @memberof CommentDtoAuthorBeta - */ - 'type'?: CommentDtoAuthorBetaTypeBeta; - /** - * ID of the commenting identity. - * @type {string} - * @memberof CommentDtoAuthorBeta - */ - 'id'?: string; - /** - * Display name of the commenting identity. - * @type {string} - * @memberof CommentDtoAuthorBeta - */ - 'name'?: string; -} - -export const CommentDtoAuthorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type CommentDtoAuthorBetaTypeBeta = typeof CommentDtoAuthorBetaTypeBeta[keyof typeof CommentDtoAuthorBetaTypeBeta]; - -/** - * - * @export - * @interface CommentDtoBeta - */ -export interface CommentDtoBeta { - /** - * Comment content. - * @type {string} - * @memberof CommentDtoBeta - */ - 'comment'?: string | null; - /** - * - * @type {CommentDtoAuthorBeta} - * @memberof CommentDtoBeta - */ - 'author'?: CommentDtoAuthorBeta; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDtoBeta - */ - 'created'?: string; -} -/** - * - * @export - * @interface CommonAccessIDStatusBeta - */ -export interface CommonAccessIDStatusBeta { - /** - * List of confirmed common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusBeta - */ - 'confirmedIds'?: Array; - /** - * List of denied common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusBeta - */ - 'deniedIds'?: Array; -} -/** - * - * @export - * @interface CommonAccessItemAccessBeta - */ -export interface CommonAccessItemAccessBeta { - /** - * Common access ID - * @type {string} - * @memberof CommonAccessItemAccessBeta - */ - 'id'?: string; - /** - * - * @type {CommonAccessTypeBeta} - * @memberof CommonAccessItemAccessBeta - */ - 'type'?: CommonAccessTypeBeta; - /** - * Common access name - * @type {string} - * @memberof CommonAccessItemAccessBeta - */ - 'name'?: string; - /** - * Common access description - * @type {string} - * @memberof CommonAccessItemAccessBeta - */ - 'description'?: string | null; - /** - * Common access owner name - * @type {string} - * @memberof CommonAccessItemAccessBeta - */ - 'ownerName'?: string; - /** - * Common access owner ID - * @type {string} - * @memberof CommonAccessItemAccessBeta - */ - 'ownerId'?: string; -} - - -/** - * - * @export - * @interface CommonAccessItemRequestBeta - */ -export interface CommonAccessItemRequestBeta { - /** - * - * @type {CommonAccessItemAccessBeta} - * @memberof CommonAccessItemRequestBeta - */ - 'access'?: CommonAccessItemAccessBeta; - /** - * - * @type {CommonAccessItemStateBeta} - * @memberof CommonAccessItemRequestBeta - */ - 'status'?: CommonAccessItemStateBeta; -} - - -/** - * - * @export - * @interface CommonAccessItemResponseBeta - */ -export interface CommonAccessItemResponseBeta { - /** - * Common Access Item ID - * @type {string} - * @memberof CommonAccessItemResponseBeta - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessBeta} - * @memberof CommonAccessItemResponseBeta - */ - 'access'?: CommonAccessItemAccessBeta; - /** - * - * @type {CommonAccessItemStateBeta} - * @memberof CommonAccessItemResponseBeta - */ - 'status'?: CommonAccessItemStateBeta; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseBeta - */ - 'lastUpdated'?: string; - /** - * - * @type {boolean} - * @memberof CommonAccessItemResponseBeta - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseBeta - */ - 'lastReviewed'?: string; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseBeta - */ - 'createdByUser'?: string; -} - - -/** - * State of common access item. - * @export - * @enum {string} - */ - -export const CommonAccessItemStateBeta = { - Confirmed: 'CONFIRMED', - Denied: 'DENIED' -} as const; - -export type CommonAccessItemStateBeta = typeof CommonAccessItemStateBeta[keyof typeof CommonAccessItemStateBeta]; - - -/** - * - * @export - * @interface CommonAccessResponseBeta - */ -export interface CommonAccessResponseBeta { - /** - * Unique ID of the common access item - * @type {string} - * @memberof CommonAccessResponseBeta - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessBeta} - * @memberof CommonAccessResponseBeta - */ - 'access'?: CommonAccessItemAccessBeta; - /** - * CONFIRMED or DENIED - * @type {string} - * @memberof CommonAccessResponseBeta - */ - 'status'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseBeta - */ - 'commonAccessType'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseBeta - */ - 'lastUpdated'?: string; - /** - * true if user has confirmed or denied status - * @type {boolean} - * @memberof CommonAccessResponseBeta - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessResponseBeta - */ - 'lastReviewed'?: string | null; - /** - * - * @type {boolean} - * @memberof CommonAccessResponseBeta - */ - 'createdByUser'?: boolean; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const CommonAccessTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type CommonAccessTypeBeta = typeof CommonAccessTypeBeta[keyof typeof CommonAccessTypeBeta]; - - -/** - * - * @export - * @interface CompleteCampaignOptionsBeta - */ -export interface CompleteCampaignOptionsBeta { - /** - * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - * @type {string} - * @memberof CompleteCampaignOptionsBeta - */ - 'autoCompleteAction'?: CompleteCampaignOptionsBetaAutoCompleteActionBeta; -} - -export const CompleteCampaignOptionsBetaAutoCompleteActionBeta = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CompleteCampaignOptionsBetaAutoCompleteActionBeta = typeof CompleteCampaignOptionsBetaAutoCompleteActionBeta[keyof typeof CompleteCampaignOptionsBetaAutoCompleteActionBeta]; - -/** - * - * @export - * @interface CompleteInvocationBeta - */ -export interface CompleteInvocationBeta { - /** - * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. - * @type {string} - * @memberof CompleteInvocationBeta - */ - 'secret': string; - /** - * The error message to indicate a failed invocation or error if any. - * @type {string} - * @memberof CompleteInvocationBeta - */ - 'error'?: string; - /** - * Trigger output to complete the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationBeta - */ - 'output': object; -} -/** - * - * @export - * @interface CompleteInvocationInputBeta - */ -export interface CompleteInvocationInputBeta { - /** - * - * @type {LocalizedMessageBeta} - * @memberof CompleteInvocationInputBeta - */ - 'localizedError'?: LocalizedMessageBeta | null; - /** - * Trigger output that completed the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationInputBeta - */ - 'output'?: object | null; -} -/** - * - * @export - * @interface CompletedApprovalBeta - */ -export interface CompletedApprovalBeta { - /** - * The approval id. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeBeta} - * @memberof CompletedApprovalBeta - */ - 'requestType'?: AccessRequestTypeBeta | null; - /** - * - * @type {AccessItemRequesterDtoBeta} - * @memberof CompletedApprovalBeta - */ - 'requester'?: AccessItemRequesterDtoBeta; - /** - * - * @type {RequestedItemStatusRequestedForBeta} - * @memberof CompletedApprovalBeta - */ - 'requestedFor'?: RequestedItemStatusRequestedForBeta; - /** - * - * @type {CompletedApprovalReviewedByBeta} - * @memberof CompletedApprovalBeta - */ - 'reviewedBy'?: CompletedApprovalReviewedByBeta; - /** - * - * @type {AccessItemOwnerDtoBeta} - * @memberof CompletedApprovalBeta - */ - 'owner'?: AccessItemOwnerDtoBeta; - /** - * - * @type {RequestableObjectReferenceBeta} - * @memberof CompletedApprovalBeta - */ - 'requestedObject'?: RequestableObjectReferenceBeta; - /** - * - * @type {CommentDto1Beta} - * @memberof CompletedApprovalBeta - */ - 'requesterComment'?: CommentDto1Beta; - /** - * The approval\'s reviewer\'s comment. - * @type {CommentDtoBeta} - * @memberof CompletedApprovalBeta - */ - 'reviewerComment'?: CommentDtoBeta | null; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof CompletedApprovalBeta - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof CompletedApprovalBeta - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof CompletedApprovalBeta - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {CompletedApprovalStateBeta} - * @memberof CompletedApprovalBeta - */ - 'state'?: CompletedApprovalStateBeta; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'removeDate'?: string | null; - /** - * If true, then the request was to change the remove date or sunset date. - * @type {boolean} - * @memberof CompletedApprovalBeta - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'currentRemoveDate'?: string | null; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof CompletedApprovalBeta - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompleted2Beta} - * @memberof CompletedApprovalBeta - */ - 'sodViolationContext'?: SodViolationContextCheckCompleted2Beta | null; - /** - * - * @type {CompletedApprovalPreApprovalTriggerResultBeta} - * @memberof CompletedApprovalBeta - */ - 'preApprovalTriggerResult'?: CompletedApprovalPreApprovalTriggerResultBeta | null; - /** - * Arbitrary key-value pairs provided during the request. - * @type {{ [key: string]: string; }} - * @memberof CompletedApprovalBeta - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof CompletedApprovalBeta - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof CompletedApprovalBeta - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationBeta} - * @memberof CompletedApprovalBeta - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationBeta | null; -} - - -/** - * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. - * @export - * @interface CompletedApprovalPreApprovalTriggerResultBeta - */ -export interface CompletedApprovalPreApprovalTriggerResultBeta { - /** - * The comment from the trigger - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultBeta - */ - 'comment'?: string; - /** - * - * @type {CompletedApprovalStateBeta} - * @memberof CompletedApprovalPreApprovalTriggerResultBeta - */ - 'decision'?: CompletedApprovalStateBeta; - /** - * The name of the approver - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultBeta - */ - 'reviewer'?: string; - /** - * The date and time the trigger decided on the request - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultBeta - */ - 'date'?: string; -} - - -/** - * Identity who reviewed the access item request. - * @export - * @interface CompletedApprovalReviewedByBeta - */ -export interface CompletedApprovalReviewedByBeta { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof CompletedApprovalReviewedByBeta - */ - 'type'?: CompletedApprovalReviewedByBetaTypeBeta; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof CompletedApprovalReviewedByBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof CompletedApprovalReviewedByBeta - */ - 'name'?: string; -} - -export const CompletedApprovalReviewedByBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type CompletedApprovalReviewedByBetaTypeBeta = typeof CompletedApprovalReviewedByBetaTypeBeta[keyof typeof CompletedApprovalReviewedByBetaTypeBeta]; - -/** - * Enum represents completed approval object\'s state. - * @export - * @enum {string} - */ - -export const CompletedApprovalStateBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type CompletedApprovalStateBeta = typeof CompletedApprovalStateBeta[keyof typeof CompletedApprovalStateBeta]; - - -/** - * The status after completion. - * @export - * @enum {string} - */ - -export const CompletionStatusBeta = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Incomplete: 'INCOMPLETE', - Pending: 'PENDING' -} as const; - -export type CompletionStatusBeta = typeof CompletionStatusBeta[keyof typeof CompletionStatusBeta]; - - -/** - * - * @export - * @interface ConcatenationBeta - */ -export interface ConcatenationBeta { - /** - * An array of items to join together - * @type {Array} - * @memberof ConcatenationBeta - */ - 'values': Array; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConcatenationBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConcatenationBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * Effect produced by a condition. - * @export - * @interface ConditionEffectBeta - */ -export interface ConditionEffectBeta { - /** - * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - * @type {string} - * @memberof ConditionEffectBeta - */ - 'effectType'?: ConditionEffectBetaEffectTypeBeta; - /** - * - * @type {ConditionEffectConfigBeta} - * @memberof ConditionEffectBeta - */ - 'config'?: ConditionEffectConfigBeta; -} - -export const ConditionEffectBetaEffectTypeBeta = { - Hide: 'HIDE', - Show: 'SHOW', - Disable: 'DISABLE', - Enable: 'ENABLE', - Require: 'REQUIRE', - Optional: 'OPTIONAL', - SubmitMessage: 'SUBMIT_MESSAGE', - SubmitNotification: 'SUBMIT_NOTIFICATION', - SetDefaultValue: 'SET_DEFAULT_VALUE' -} as const; - -export type ConditionEffectBetaEffectTypeBeta = typeof ConditionEffectBetaEffectTypeBeta[keyof typeof ConditionEffectBetaEffectTypeBeta]; - -/** - * Arbitrary map containing a configuration based on the EffectType. - * @export - * @interface ConditionEffectConfigBeta - */ -export interface ConditionEffectConfigBeta { - /** - * Effect type\'s label. - * @type {string} - * @memberof ConditionEffectConfigBeta - */ - 'defaultValueLabel'?: string; - /** - * Element\'s identifier. - * @type {string} - * @memberof ConditionEffectConfigBeta - */ - 'element'?: string; -} -/** - * - * @export - * @interface ConditionRuleBeta - */ -export interface ConditionRuleBeta { - /** - * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement - * @type {string} - * @memberof ConditionRuleBeta - */ - 'sourceType'?: ConditionRuleBetaSourceTypeBeta; - /** - * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. - * @type {string} - * @memberof ConditionRuleBeta - */ - 'source'?: string; - /** - * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - * @type {string} - * @memberof ConditionRuleBeta - */ - 'operator'?: ConditionRuleBetaOperatorBeta; - /** - * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean - * @type {string} - * @memberof ConditionRuleBeta - */ - 'valueType'?: ConditionRuleBetaValueTypeBeta; - /** - * Based on the ValueType. - * @type {string} - * @memberof ConditionRuleBeta - */ - 'value'?: string; -} - -export const ConditionRuleBetaSourceTypeBeta = { - Input: 'INPUT', - Element: 'ELEMENT' -} as const; - -export type ConditionRuleBetaSourceTypeBeta = typeof ConditionRuleBetaSourceTypeBeta[keyof typeof ConditionRuleBetaSourceTypeBeta]; -export const ConditionRuleBetaOperatorBeta = { - Eq: 'EQ', - Ne: 'NE', - Co: 'CO', - NotCo: 'NOT_CO', - In: 'IN', - NotIn: 'NOT_IN', - Em: 'EM', - NotEm: 'NOT_EM', - Sw: 'SW', - NotSw: 'NOT_SW', - Ew: 'EW', - NotEw: 'NOT_EW' -} as const; - -export type ConditionRuleBetaOperatorBeta = typeof ConditionRuleBetaOperatorBeta[keyof typeof ConditionRuleBetaOperatorBeta]; -export const ConditionRuleBetaValueTypeBeta = { - String: 'STRING', - StringList: 'STRING_LIST', - Input: 'INPUT', - Element: 'ELEMENT', - List: 'LIST', - Boolean: 'BOOLEAN' -} as const; - -export type ConditionRuleBetaValueTypeBeta = typeof ConditionRuleBetaValueTypeBeta[keyof typeof ConditionRuleBetaValueTypeBeta]; - -/** - * - * @export - * @interface ConditionalBeta - */ -export interface ConditionalBeta { - /** - * A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison - * @type {string} - * @memberof ConditionalBeta - */ - 'expression': string; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof ConditionalBeta - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof ConditionalBeta - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConditionalBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConditionalBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * Config export and import format for individual object configurations. - * @export - * @interface ConfigObjectBeta - */ -export interface ConfigObjectBeta { - /** - * Current version of configuration object. - * @type {number} - * @memberof ConfigObjectBeta - */ - 'version'?: number; - /** - * - * @type {SelfImportExportDtoBeta} - * @memberof ConfigObjectBeta - */ - 'self'?: SelfImportExportDtoBeta; - /** - * Object details. Format dependant on the object type. - * @type {{ [key: string]: any; }} - * @memberof ConfigObjectBeta - */ - 'object'?: { [key: string]: any; }; -} -/** - * Type of Reassignment Configuration. - * @export - * @interface ConfigTypeBeta - */ -export interface ConfigTypeBeta { - /** - * - * @type {number} - * @memberof ConfigTypeBeta - */ - 'priority'?: number; - /** - * - * @type {ConfigTypeEnumCamelBeta} - * @memberof ConfigTypeBeta - */ - 'internalName'?: ConfigTypeEnumCamelBeta; - /** - * - * @type {ConfigTypeEnumBeta} - * @memberof ConfigTypeBeta - */ - 'internalNameCamel'?: ConfigTypeEnumBeta; - /** - * Human readable display name of the type to be shown on UI - * @type {string} - * @memberof ConfigTypeBeta - */ - 'displayName'?: string; - /** - * Description of the type of work to be reassigned, displayed by the UI. - * @type {string} - * @memberof ConfigTypeBeta - */ - 'description'?: string; -} - - -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumBeta = { - AccessRequests: 'ACCESS_REQUESTS', - Certifications: 'CERTIFICATIONS', - ManualTasks: 'MANUAL_TASKS' -} as const; - -export type ConfigTypeEnumBeta = typeof ConfigTypeEnumBeta[keyof typeof ConfigTypeEnumBeta]; - - -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumCamelBeta = { - AccessRequests: 'accessRequests', - Certifications: 'certifications', - ManualTasks: 'manualTasks' -} as const; - -export type ConfigTypeEnumCamelBeta = typeof ConfigTypeEnumCamelBeta[keyof typeof ConfigTypeEnumCamelBeta]; - - -/** - * The request body of Reassignment Configuration Details for a specific identity and config type - * @export - * @interface ConfigurationDetailsResponseBeta - */ -export interface ConfigurationDetailsResponseBeta { - /** - * - * @type {ConfigTypeEnumBeta} - * @memberof ConfigurationDetailsResponseBeta - */ - 'configType'?: ConfigTypeEnumBeta; - /** - * - * @type {Identity1Beta} - * @memberof ConfigurationDetailsResponseBeta - */ - 'targetIdentity'?: Identity1Beta; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationDetailsResponseBeta - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationDetailsResponseBeta - */ - 'endDate'?: string; - /** - * - * @type {AuditDetailsBeta} - * @memberof ConfigurationDetailsResponseBeta - */ - 'auditDetails'?: AuditDetailsBeta; -} - - -/** - * The request body for creation or update of a Reassignment Configuration for a single identity and work type - * @export - * @interface ConfigurationItemRequestBeta - */ -export interface ConfigurationItemRequestBeta { - /** - * The identity id to reassign an item from - * @type {string} - * @memberof ConfigurationItemRequestBeta - */ - 'reassignedFromId'?: string; - /** - * The identity id to reassign an item to - * @type {string} - * @memberof ConfigurationItemRequestBeta - */ - 'reassignedToId'?: string; - /** - * - * @type {ConfigTypeEnumBeta} - * @memberof ConfigurationItemRequestBeta - */ - 'configType'?: ConfigTypeEnumBeta; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationItemRequestBeta - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationItemRequestBeta - */ - 'endDate'?: string | null; -} - - -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationItemResponseBeta - */ -export interface ConfigurationItemResponseBeta { - /** - * - * @type {Identity1Beta} - * @memberof ConfigurationItemResponseBeta - */ - 'identity'?: Identity1Beta; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationItemResponseBeta - */ - 'configDetails'?: Array; -} -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationResponseBeta - */ -export interface ConfigurationResponseBeta { - /** - * - * @type {Identity1Beta} - * @memberof ConfigurationResponseBeta - */ - 'identity'?: Identity1Beta; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationResponseBeta - */ - 'configDetails'?: Array; -} -/** - * - * @export - * @interface ConflictingAccessCriteriaBeta - */ -export interface ConflictingAccessCriteriaBeta { - /** - * - * @type {AccessCriteriaBeta} - * @memberof ConflictingAccessCriteriaBeta - */ - 'leftCriteria'?: AccessCriteriaBeta; - /** - * - * @type {AccessCriteriaBeta} - * @memberof ConflictingAccessCriteriaBeta - */ - 'rightCriteria'?: AccessCriteriaBeta; -} -/** - * - * @export - * @interface ConnectedObjectBeta - */ -export interface ConnectedObjectBeta { - /** - * - * @type {ConnectedObjectTypeBeta} - * @memberof ConnectedObjectBeta - */ - 'type'?: ConnectedObjectTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ConnectedObjectBeta - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof ConnectedObjectBeta - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof ConnectedObjectBeta - */ - 'description'?: string; -} - - -/** - * An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - * @export - * @enum {string} - */ - -export const ConnectedObjectTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type ConnectedObjectTypeBeta = typeof ConnectedObjectTypeBeta[keyof typeof ConnectedObjectTypeBeta]; - - -/** - * - * @export - * @interface ConnectorDetailBeta - */ -export interface ConnectorDetailBeta { - /** - * The connector name - * @type {string} - * @memberof ConnectorDetailBeta - */ - 'name'?: string; - /** - * XML representation of the source config data - * @type {string} - * @memberof ConnectorDetailBeta - */ - 'sourceConfigXml'?: string; - /** - * JSON representation of the source config data - * @type {string} - * @memberof ConnectorDetailBeta - */ - 'sourceConfig'?: string; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof ConnectorDetailBeta - */ - 'directConnect'?: boolean; - /** - * Connector config\'s file upload attribute, false if not there - * @type {boolean} - * @memberof ConnectorDetailBeta - */ - 'fileUpload'?: boolean; - /** - * List of uploaded file strings for the connector - * @type {string} - * @memberof ConnectorDetailBeta - */ - 'uploadedFiles'?: string; - /** - * Object containing metadata pertinent to the UI to be used - * @type {object} - * @memberof ConnectorDetailBeta - */ - 'connectorMetadata'?: object; -} -/** - * ConnectorRuleCreateRequest - * @export - * @interface ConnectorRuleCreateRequestBeta - */ -export interface ConnectorRuleCreateRequestBeta { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'description'?: string; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'type': ConnectorRuleCreateRequestBetaTypeBeta; - /** - * - * @type {ConnectorRuleCreateRequestSignatureBeta} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'signature'?: ConnectorRuleCreateRequestSignatureBeta; - /** - * - * @type {SourceCodeBeta} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'sourceCode': SourceCodeBeta; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleCreateRequestBeta - */ - 'attributes'?: object | null; -} - -export const ConnectorRuleCreateRequestBetaTypeBeta = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleCreateRequestBetaTypeBeta = typeof ConnectorRuleCreateRequestBetaTypeBeta[keyof typeof ConnectorRuleCreateRequestBetaTypeBeta]; - -/** - * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) - * @export - * @interface ConnectorRuleCreateRequestSignatureBeta - */ -export interface ConnectorRuleCreateRequestSignatureBeta { - /** - * - * @type {Array} - * @memberof ConnectorRuleCreateRequestSignatureBeta - */ - 'input': Array; - /** - * - * @type {ArgumentBeta} - * @memberof ConnectorRuleCreateRequestSignatureBeta - */ - 'output'?: ArgumentBeta | null; -} -/** - * ConnectorRuleResponse - * @export - * @interface ConnectorRuleResponseBeta - */ -export interface ConnectorRuleResponseBeta { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'description'?: string; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'type': ConnectorRuleResponseBetaTypeBeta; - /** - * - * @type {ConnectorRuleCreateRequestSignatureBeta} - * @memberof ConnectorRuleResponseBeta - */ - 'signature'?: ConnectorRuleCreateRequestSignatureBeta; - /** - * - * @type {SourceCodeBeta} - * @memberof ConnectorRuleResponseBeta - */ - 'sourceCode': SourceCodeBeta; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleResponseBeta - */ - 'attributes'?: object | null; - /** - * the ID of the rule - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'id': string; - /** - * an ISO 8601 UTC timestamp when this rule was created - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'created': string; - /** - * an ISO 8601 UTC timestamp when this rule was last modified - * @type {string} - * @memberof ConnectorRuleResponseBeta - */ - 'modified'?: string | null; -} - -export const ConnectorRuleResponseBetaTypeBeta = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleResponseBetaTypeBeta = typeof ConnectorRuleResponseBetaTypeBeta[keyof typeof ConnectorRuleResponseBetaTypeBeta]; - -/** - * ConnectorRuleUpdateRequest - * @export - * @interface ConnectorRuleUpdateRequestBeta - */ -export interface ConnectorRuleUpdateRequestBeta { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'description'?: string; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'type': ConnectorRuleUpdateRequestBetaTypeBeta; - /** - * - * @type {ConnectorRuleCreateRequestSignatureBeta} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'signature'?: ConnectorRuleCreateRequestSignatureBeta; - /** - * - * @type {SourceCodeBeta} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'sourceCode': SourceCodeBeta; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'attributes'?: object | null; - /** - * the ID of the rule to update - * @type {string} - * @memberof ConnectorRuleUpdateRequestBeta - */ - 'id': string; -} - -export const ConnectorRuleUpdateRequestBetaTypeBeta = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleUpdateRequestBetaTypeBeta = typeof ConnectorRuleUpdateRequestBetaTypeBeta[keyof typeof ConnectorRuleUpdateRequestBetaTypeBeta]; - -/** - * ConnectorRuleValidationResponse - * @export - * @interface ConnectorRuleValidationResponseBeta - */ -export interface ConnectorRuleValidationResponseBeta { - /** - * - * @type {string} - * @memberof ConnectorRuleValidationResponseBeta - */ - 'state': ConnectorRuleValidationResponseBetaStateBeta; - /** - * - * @type {Array} - * @memberof ConnectorRuleValidationResponseBeta - */ - 'details': Array; -} - -export const ConnectorRuleValidationResponseBetaStateBeta = { - Ok: 'OK', - Error: 'ERROR' -} as const; - -export type ConnectorRuleValidationResponseBetaStateBeta = typeof ConnectorRuleValidationResponseBetaStateBeta[keyof typeof ConnectorRuleValidationResponseBetaStateBeta]; - -/** - * CodeErrorDetail - * @export - * @interface ConnectorRuleValidationResponseDetailsInnerBeta - */ -export interface ConnectorRuleValidationResponseDetailsInnerBeta { - /** - * The line number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerBeta - */ - 'line': number; - /** - * the column number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerBeta - */ - 'column': number; - /** - * a description of the issue in the code - * @type {string} - * @memberof ConnectorRuleValidationResponseDetailsInnerBeta - */ - 'messsage'?: string; -} -/** - * - * @export - * @interface ContextAttributeDtoBeta - */ -export interface ContextAttributeDtoBeta { - /** - * The name of the attribute - * @type {string} - * @memberof ContextAttributeDtoBeta - */ - 'attribute'?: string; - /** - * - * @type {ContextAttributeDtoValueBeta} - * @memberof ContextAttributeDtoBeta - */ - 'value'?: ContextAttributeDtoValueBeta; - /** - * True if the attribute was derived. - * @type {boolean} - * @memberof ContextAttributeDtoBeta - */ - 'derived'?: boolean; -} -/** - * @type ContextAttributeDtoValueBeta - * The value of the attribute. This can be either a string or a multi-valued string - * @export - */ -export type ContextAttributeDtoValueBeta = Array | string; - -/** - * - * @export - * @interface CorrelatedGovernanceEventBeta - */ -export interface CorrelatedGovernanceEventBeta { - /** - * The name of the governance event, such as the certification name or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventBeta - */ - 'name'?: string; - /** - * The date that the certification or access request was completed. - * @type {string} - * @memberof CorrelatedGovernanceEventBeta - */ - 'dateTime'?: string; - /** - * The type of governance event. - * @type {string} - * @memberof CorrelatedGovernanceEventBeta - */ - 'type'?: CorrelatedGovernanceEventBetaTypeBeta; - /** - * The ID of the instance that caused the event - either the certification ID or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventBeta - */ - 'governanceId'?: string; - /** - * The owners of the governance event (the certifiers or approvers) - * @type {Array} - * @memberof CorrelatedGovernanceEventBeta - */ - 'owners'?: Array; - /** - * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners - * @type {Array} - * @memberof CorrelatedGovernanceEventBeta - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseBeta} - * @memberof CorrelatedGovernanceEventBeta - */ - 'decisionMaker'?: CertifierResponseBeta; -} - -export const CorrelatedGovernanceEventBetaTypeBeta = { - Certification: 'certification', - AccessRequest: 'accessRequest' -} as const; - -export type CorrelatedGovernanceEventBetaTypeBeta = typeof CorrelatedGovernanceEventBetaTypeBeta[keyof typeof CorrelatedGovernanceEventBetaTypeBeta]; - -/** - * The attribute assignment of the correlation configuration. - * @export - * @interface CorrelationConfigAttributeAssignmentsInnerBeta - */ -export interface CorrelationConfigAttributeAssignmentsInnerBeta { - /** - * The sequence of the attribute assignment. - * @type {number} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'sequence'?: number; - /** - * The property of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'property'?: string; - /** - * The value of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'value'?: string; - /** - * The operation of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'operation'?: CorrelationConfigAttributeAssignmentsInnerBetaOperationBeta; - /** - * Whether or not the it\'s a complex attribute assignment. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'complex'?: boolean; - /** - * Whether or not the attribute assignment should ignore case. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'ignoreCase'?: boolean; - /** - * The match mode of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'matchMode'?: CorrelationConfigAttributeAssignmentsInnerBetaMatchModeBeta; - /** - * The filter string of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerBeta - */ - 'filterString'?: string; -} - -export const CorrelationConfigAttributeAssignmentsInnerBetaOperationBeta = { - Eq: 'EQ' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerBetaOperationBeta = typeof CorrelationConfigAttributeAssignmentsInnerBetaOperationBeta[keyof typeof CorrelationConfigAttributeAssignmentsInnerBetaOperationBeta]; -export const CorrelationConfigAttributeAssignmentsInnerBetaMatchModeBeta = { - Anywhere: 'ANYWHERE', - Start: 'START', - End: 'END' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerBetaMatchModeBeta = typeof CorrelationConfigAttributeAssignmentsInnerBetaMatchModeBeta[keyof typeof CorrelationConfigAttributeAssignmentsInnerBetaMatchModeBeta]; - -/** - * Source configuration information that is used by correlation process. - * @export - * @interface CorrelationConfigBeta - */ -export interface CorrelationConfigBeta { - /** - * The ID of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigBeta - */ - 'id'?: string; - /** - * The name of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigBeta - */ - 'name'?: string; - /** - * The list of attribute assignments of the correlation configuration. - * @type {Array} - * @memberof CorrelationConfigBeta - */ - 'attributeAssignments'?: Array; -} -/** - * - * @export - * @interface CreateDomainDkim405ResponseBeta - */ -export interface CreateDomainDkim405ResponseBeta { - /** - * A message describing the error - * @type {object} - * @memberof CreateDomainDkim405ResponseBeta - */ - 'errorName'?: object; - /** - * Description of the error - * @type {object} - * @memberof CreateDomainDkim405ResponseBeta - */ - 'errorMessage'?: object; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof CreateDomainDkim405ResponseBeta - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface CreateFormDefinitionFileRequestRequestBeta - */ -export interface CreateFormDefinitionFileRequestRequestBeta { - /** - * File specifying the multipart - * @type {File} - * @memberof CreateFormDefinitionFileRequestRequestBeta - */ - 'file': File; -} -/** - * - * @export - * @interface CreateFormDefinitionRequestBeta - */ -export interface CreateFormDefinitionRequestBeta { - /** - * Description is the form definition description - * @type {string} - * @memberof CreateFormDefinitionRequestBeta - */ - 'description'?: string; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof CreateFormDefinitionRequestBeta - */ - 'formConditions'?: Array; - /** - * FormElements is a list of nested form elements - * @type {Array} - * @memberof CreateFormDefinitionRequestBeta - */ - 'formElements'?: Array; - /** - * FormInput is a list of form inputs that are required when creating a form-instance object - * @type {Array} - * @memberof CreateFormDefinitionRequestBeta - */ - 'formInput'?: Array; - /** - * Name is the form definition name - * @type {string} - * @memberof CreateFormDefinitionRequestBeta - */ - 'name': string; - /** - * - * @type {FormOwnerBeta} - * @memberof CreateFormDefinitionRequestBeta - */ - 'owner': FormOwnerBeta; - /** - * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used - * @type {Array} - * @memberof CreateFormDefinitionRequestBeta - */ - 'usedBy'?: Array; -} -/** - * - * @export - * @interface CreateFormInstanceRequestBeta - */ -export interface CreateFormInstanceRequestBeta { - /** - * - * @type {FormInstanceCreatedByBeta} - * @memberof CreateFormInstanceRequestBeta - */ - 'createdBy': FormInstanceCreatedByBeta; - /** - * Expire is required - * @type {string} - * @memberof CreateFormInstanceRequestBeta - */ - 'expire': string; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof CreateFormInstanceRequestBeta - */ - 'formDefinitionId': string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: any; }} - * @memberof CreateFormInstanceRequestBeta - */ - 'formInput'?: { [key: string]: any; }; - /** - * Recipients is required - * @type {Array} - * @memberof CreateFormInstanceRequestBeta - */ - 'recipients': Array; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof CreateFormInstanceRequestBeta - */ - 'standAloneForm'?: boolean; - /** - * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof CreateFormInstanceRequestBeta - */ - 'state'?: CreateFormInstanceRequestBetaStateBeta; - /** - * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html - * @type {number} - * @memberof CreateFormInstanceRequestBeta - */ - 'ttl'?: number; -} - -export const CreateFormInstanceRequestBetaStateBeta = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type CreateFormInstanceRequestBetaStateBeta = typeof CreateFormInstanceRequestBetaStateBeta[keyof typeof CreateFormInstanceRequestBetaStateBeta]; - -/** - * - * @export - * @interface CreateOAuthClientRequestBeta - */ -export interface CreateOAuthClientRequestBeta { - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientRequestBeta - */ - 'businessName'?: string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestBeta - */ - 'homepageUrl'?: string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientRequestBeta - */ - 'name': string | null; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestBeta - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestBeta - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestBeta - */ - 'refreshTokenValiditySeconds'?: number; - /** - * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - * @type {Array} - * @memberof CreateOAuthClientRequestBeta - */ - 'redirectUris'?: Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientRequestBeta - */ - 'grantTypes': Array | null; - /** - * - * @type {AccessTypeBeta} - * @memberof CreateOAuthClientRequestBeta - */ - 'accessType': AccessTypeBeta; - /** - * - * @type {ClientTypeBeta} - * @memberof CreateOAuthClientRequestBeta - */ - 'type'?: ClientTypeBeta; - /** - * An indicator of whether the API Client can be used for requests internal within the product. - * @type {boolean} - * @memberof CreateOAuthClientRequestBeta - */ - 'internal'?: boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientRequestBeta - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientRequestBeta - */ - 'strongAuthSupported'?: boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientRequestBeta - */ - 'claimsSupported'?: boolean; - /** - * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreateOAuthClientRequestBeta - */ - 'scope'?: Array | null; -} - - -/** - * - * @export - * @interface CreateOAuthClientResponseBeta - */ -export interface CreateOAuthClientResponseBeta { - /** - * ID of the OAuth client - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'id': string; - /** - * Secret of the OAuth client (This field is only returned on the intial create call.) - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'secret': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'businessName': string; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'homepageUrl': string; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'description': string; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseBeta - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseBeta - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof CreateOAuthClientResponseBeta - */ - 'redirectUris': Array; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientResponseBeta - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeBeta} - * @memberof CreateOAuthClientResponseBeta - */ - 'accessType': AccessTypeBeta; - /** - * - * @type {ClientTypeBeta} - * @memberof CreateOAuthClientResponseBeta - */ - 'type': ClientTypeBeta; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof CreateOAuthClientResponseBeta - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientResponseBeta - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientResponseBeta - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientResponseBeta - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof CreateOAuthClientResponseBeta - */ - 'modified': string; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof CreateOAuthClientResponseBeta - */ - 'scope': Array | null; -} - - -/** - * Object for specifying the name of a personal access token to create - * @export - * @interface CreatePersonalAccessTokenRequestBeta - */ -export interface CreatePersonalAccessTokenRequestBeta { - /** - * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestBeta - */ - 'name': string; - /** - * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreatePersonalAccessTokenRequestBeta - */ - 'scope'?: Array | null; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenRequestBeta - */ - 'accessTokenValiditySeconds'?: number | null; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestBeta - */ - 'expirationDate'?: string | null; -} -/** - * - * @export - * @interface CreatePersonalAccessTokenResponseBeta - */ -export interface CreatePersonalAccessTokenResponseBeta { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'id': string; - /** - * The secret of the personal access token (to be used as the password for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'secret': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'scope': Array | null; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'name': string; - /** - * - * @type {PatOwnerBeta} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'owner': PatOwnerBeta; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'created': string; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'accessTokenValiditySeconds': number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseBeta - */ - 'expirationDate': string; -} -/** - * - * @export - * @interface CreateWorkflowRequestBeta - */ -export interface CreateWorkflowRequestBeta { - /** - * The name of the workflow - * @type {string} - * @memberof CreateWorkflowRequestBeta - */ - 'name': string; - /** - * - * @type {WorkflowBodyOwnerBeta} - * @memberof CreateWorkflowRequestBeta - */ - 'owner': WorkflowBodyOwnerBeta; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof CreateWorkflowRequestBeta - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionBeta} - * @memberof CreateWorkflowRequestBeta - */ - 'definition'?: WorkflowDefinitionBeta; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof CreateWorkflowRequestBeta - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerBeta} - * @memberof CreateWorkflowRequestBeta - */ - 'trigger'?: WorkflowTriggerBeta; -} -/** - * - * @export - * @interface CustomPasswordInstructionBeta - */ -export interface CustomPasswordInstructionBeta { - /** - * The page ID that represents the page for forget user name, reset password and unlock account flow. - * @type {string} - * @memberof CustomPasswordInstructionBeta - */ - 'pageId'?: CustomPasswordInstructionBetaPageIdBeta; - /** - * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. - * @type {string} - * @memberof CustomPasswordInstructionBeta - */ - 'pageContent'?: string; - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionBeta - */ - 'locale'?: string; -} - -export const CustomPasswordInstructionBetaPageIdBeta = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; - -export type CustomPasswordInstructionBetaPageIdBeta = typeof CustomPasswordInstructionBetaPageIdBeta[keyof typeof CustomPasswordInstructionBetaPageIdBeta]; - -/** - * - * @export - * @interface DateCompareBeta - */ -export interface DateCompareBeta { - /** - * - * @type {DateCompareFirstDateBeta} - * @memberof DateCompareBeta - */ - 'firstDate': DateCompareFirstDateBeta; - /** - * - * @type {DateCompareSecondDateBeta} - * @memberof DateCompareBeta - */ - 'secondDate': DateCompareSecondDateBeta; - /** - * This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | - * @type {string} - * @memberof DateCompareBeta - */ - 'operator': DateCompareBetaOperatorBeta; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof DateCompareBeta - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof DateCompareBeta - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateCompareBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateCompareBeta - */ - 'input'?: { [key: string]: any; }; -} - -export const DateCompareBetaOperatorBeta = { - Lt: 'LT', - Lte: 'LTE', - Gt: 'GT', - Gte: 'GTE' -} as const; - -export type DateCompareBetaOperatorBeta = typeof DateCompareBetaOperatorBeta[keyof typeof DateCompareBetaOperatorBeta]; - -/** - * @type DateCompareFirstDateBeta - * This is the first date to consider (The date that would be on the left hand side of the comparison operation). - * @export - */ -export type DateCompareFirstDateBeta = AccountAttributeBeta | DateFormatBeta; - -/** - * @type DateCompareSecondDateBeta - * This is the second date to consider (The date that would be on the right hand side of the comparison operation). - * @export - */ -export type DateCompareSecondDateBeta = AccountAttributeBeta | DateFormatBeta; - -/** - * - * @export - * @interface DateFormatBeta - */ -export interface DateFormatBeta { - /** - * - * @type {DateFormatInputFormatBeta} - * @memberof DateFormatBeta - */ - 'inputFormat'?: DateFormatInputFormatBeta; - /** - * - * @type {DateFormatOutputFormatBeta} - * @memberof DateFormatBeta - */ - 'outputFormat'?: DateFormatOutputFormatBeta; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateFormatBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateFormatBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * @type DateFormatInputFormatBeta - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatInputFormatBeta = NamedConstructsBeta | string; - -/** - * @type DateFormatOutputFormatBeta - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatOutputFormatBeta = NamedConstructsBeta | string; - -/** - * - * @export - * @interface DateMathBeta - */ -export interface DateMathBeta { - /** - * A string value of the date and time components to operation on, along with the math operations to execute. - * @type {string} - * @memberof DateMathBeta - */ - 'expression': string; - /** - * A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - * @type {boolean} - * @memberof DateMathBeta - */ - 'roundUp'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateMathBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateMathBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DecomposeDiacriticalMarksBeta - */ -export interface DecomposeDiacriticalMarksBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DecomposeDiacriticalMarksBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DecomposeDiacriticalMarksBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Delete202ResponseBeta - */ -export interface Delete202ResponseBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof Delete202ResponseBeta - */ - 'type'?: Delete202ResponseBetaTypeBeta; - /** - * Task result ID. - * @type {string} - * @memberof Delete202ResponseBeta - */ - 'id'?: string; - /** - * Task result\'s human-readable display name (this should be null/empty). - * @type {string} - * @memberof Delete202ResponseBeta - */ - 'name'?: string; -} - -export const Delete202ResponseBetaTypeBeta = { - TaskResult: 'TASK_RESULT' -} as const; - -export type Delete202ResponseBetaTypeBeta = typeof Delete202ResponseBetaTypeBeta[keyof typeof Delete202ResponseBetaTypeBeta]; - -/** - * - * @export - * @interface DeleteCampaignsRequestBeta - */ -export interface DeleteCampaignsRequestBeta { - /** - * The ids of the campaigns to delete - * @type {Array} - * @memberof DeleteCampaignsRequestBeta - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface DeleteNonEmployeeRecordInBulkRequestBeta - */ -export interface DeleteNonEmployeeRecordInBulkRequestBeta { - /** - * List of non-employee ids. - * @type {Array} - * @memberof DeleteNonEmployeeRecordInBulkRequestBeta - */ - 'ids': Array; -} -/** - * - * @export - * @interface DimensionRefBeta - */ -export interface DimensionRefBeta { - /** - * The type of the object to which this reference applies - * @type {string} - * @memberof DimensionRefBeta - */ - 'type'?: DimensionRefBetaTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DimensionRefBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DimensionRefBeta - */ - 'name'?: string; -} - -export const DimensionRefBetaTypeBeta = { - Dimension: 'DIMENSION' -} as const; - -export type DimensionRefBetaTypeBeta = typeof DimensionRefBetaTypeBeta[keyof typeof DimensionRefBetaTypeBeta]; - -/** - * DKIM attributes for a domain or identity - * @export - * @interface DkimAttributesBeta - */ -export interface DkimAttributesBeta { - /** - * UUID associated with domain to be verified - * @type {string} - * @memberof DkimAttributesBeta - */ - 'id'?: string; - /** - * The identity or domain address - * @type {string} - * @memberof DkimAttributesBeta - */ - 'address'?: string; - /** - * Whether or not DKIM has been enabled for this domain / identity - * @type {boolean} - * @memberof DkimAttributesBeta - */ - 'dkimEnabled'?: boolean; - /** - * The tokens to be added to a DNS for verification - * @type {Array} - * @memberof DkimAttributesBeta - */ - 'dkimTokens'?: Array; - /** - * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING - * @type {string} - * @memberof DkimAttributesBeta - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DkimAttributesBeta - */ - 'region'?: string; -} -/** - * - * @export - * @interface DomainAddressBeta - */ -export interface DomainAddressBeta { - /** - * A domain address - * @type {string} - * @memberof DomainAddressBeta - */ - 'domain'?: string; -} -/** - * Domain status DTO containing everything required to verify via DKIM - * @export - * @interface DomainStatusDtoBeta - */ -export interface DomainStatusDtoBeta { - /** - * New UUID associated with domain to be verified - * @type {string} - * @memberof DomainStatusDtoBeta - */ - 'id'?: string; - /** - * A domain address - * @type {string} - * @memberof DomainStatusDtoBeta - */ - 'domain'?: string; - /** - * DKIM is enabled for this domain - * @type {boolean} - * @memberof DomainStatusDtoBeta - */ - 'dkimEnabled'?: boolean; - /** - * DKIM tokens required for authentication - * @type {Array} - * @memberof DomainStatusDtoBeta - */ - 'dkimTokens'?: Array; - /** - * Status of DKIM authentication - * @type {string} - * @memberof DomainStatusDtoBeta - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DomainStatusDtoBeta - */ - 'region'?: string; -} -/** - * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - * @export - * @enum {string} - */ - -export const DtoTypeBeta = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', - AccessProfile: 'ACCESS_PROFILE', - AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', - Account: 'ACCOUNT', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - CampaignFilter: 'CAMPAIGN_FILTER', - Certification: 'CERTIFICATION', - Cluster: 'CLUSTER', - ConnectorSchema: 'CONNECTOR_SCHEMA', - Entitlement: 'ENTITLEMENT', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityProfile: 'IDENTITY_PROFILE', - IdentityRequest: 'IDENTITY_REQUEST', - MachineIdentity: 'MACHINE_IDENTITY', - LifecycleState: 'LIFECYCLE_STATE', - PasswordPolicy: 'PASSWORD_POLICY', - Role: 'ROLE', - Rule: 'RULE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - TagCategory: 'TAG_CATEGORY', - TaskResult: 'TASK_RESULT', - ReportResult: 'REPORT_RESULT', - SodViolation: 'SOD_VIOLATION', - AccountActivity: 'ACCOUNT_ACTIVITY', - Workgroup: 'WORKGROUP' -} as const; - -export type DtoTypeBeta = typeof DtoTypeBeta[keyof typeof DtoTypeBeta]; - - -/** - * - * @export - * @interface DuoVerificationRequestBeta - */ -export interface DuoVerificationRequestBeta { - /** - * User id for Verification request. - * @type {string} - * @memberof DuoVerificationRequestBeta - */ - 'userId': string; - /** - * User id for Verification request. - * @type {string} - * @memberof DuoVerificationRequestBeta - */ - 'signedResponse': string; -} -/** - * - * @export - * @interface E164phoneBeta - */ -export interface E164phoneBeta { - /** - * This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - * @type {string} - * @memberof E164phoneBeta - */ - 'defaultRegion'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof E164phoneBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof E164phoneBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface EmailNotificationOptionBeta - */ -export interface EmailNotificationOptionBeta { - /** - * If true, then the manager is notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionBeta - */ - 'notifyManagers'?: boolean; - /** - * If true, then all the admins are notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionBeta - */ - 'notifyAllAdmins'?: boolean; - /** - * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionBeta - */ - 'notifySpecificUsers'?: boolean; - /** - * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. - * @type {Array} - * @memberof EmailNotificationOptionBeta - */ - 'emailAddressList'?: Array; -} -/** - * - * @export - * @interface EmailStatusDtoBeta - */ -export interface EmailStatusDtoBeta { - /** - * Unique identifier for the verified sender address - * @type {string} - * @memberof EmailStatusDtoBeta - */ - 'id'?: string | null; - /** - * The verified sender email address - * @type {string} - * @memberof EmailStatusDtoBeta - */ - 'email'?: string; - /** - * Whether the sender address is verified by domain - * @type {boolean} - * @memberof EmailStatusDtoBeta - */ - 'isVerifiedByDomain'?: boolean; - /** - * The verification status of the sender address - * @type {string} - * @memberof EmailStatusDtoBeta - */ - 'verificationStatus'?: EmailStatusDtoBetaVerificationStatusBeta; - /** - * The AWS SES region the sender address is associated with - * @type {string} - * @memberof EmailStatusDtoBeta - */ - 'region'?: string | null; -} - -export const EmailStatusDtoBetaVerificationStatusBeta = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Na: 'NA' -} as const; - -export type EmailStatusDtoBetaVerificationStatusBeta = typeof EmailStatusDtoBetaVerificationStatusBeta[keyof typeof EmailStatusDtoBetaVerificationStatusBeta]; - -/** - * - * @export - * @interface EntitlementAccessModelMetadataBeta - */ -export interface EntitlementAccessModelMetadataBeta { - /** - * - * @type {Array} - * @memberof EntitlementAccessModelMetadataBeta - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface EntitlementAccessRequestConfigBeta - */ -export interface EntitlementAccessRequestConfigBeta { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'approvalSchemes'?: Array; - /** - * If the requester must provide a comment during access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'requestCommentRequired'?: boolean; - /** - * If the reviewer must provide a comment when denying the access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'denialCommentRequired'?: boolean; - /** - * Is Reauthorization Required - * @type {boolean} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'reauthorizationRequired'?: boolean; - /** - * If true, then remove date or sunset date is required in access request of the entitlement. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'requireEndDate'?: boolean; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationBeta} - * @memberof EntitlementAccessRequestConfigBeta - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationBeta | null; -} -/** - * - * @export - * @interface EntitlementApprovalSchemeBeta - */ -export interface EntitlementApprovalSchemeBeta { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. - * @type {string} - * @memberof EntitlementApprovalSchemeBeta - */ - 'approverType'?: EntitlementApprovalSchemeBetaApproverTypeBeta; - /** - * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW - * @type {string} - * @memberof EntitlementApprovalSchemeBeta - */ - 'approverId'?: string | null; -} - -export const EntitlementApprovalSchemeBetaApproverTypeBeta = { - EntitlementOwner: 'ENTITLEMENT_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW' -} as const; - -export type EntitlementApprovalSchemeBetaApproverTypeBeta = typeof EntitlementApprovalSchemeBetaApproverTypeBeta[keyof typeof EntitlementApprovalSchemeBetaApproverTypeBeta]; - -/** - * - * @export - * @interface EntitlementBeta - */ -export interface EntitlementBeta { - /** - * The entitlement id - * @type {string} - * @memberof EntitlementBeta - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof EntitlementBeta - */ - 'name'?: string; - /** - * Time when the entitlement was created - * @type {string} - * @memberof EntitlementBeta - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof EntitlementBeta - */ - 'modified'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof EntitlementBeta - */ - 'attribute'?: string | null; - /** - * The value of the entitlement - * @type {string} - * @memberof EntitlementBeta - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof EntitlementBeta - */ - 'sourceSchemaObjectType'?: string; - /** - * True if the entitlement is privileged - * @type {boolean} - * @memberof EntitlementBeta - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof EntitlementBeta - */ - 'cloudGoverned'?: boolean; - /** - * The description of the entitlement - * @type {string} - * @memberof EntitlementBeta - */ - 'description'?: string | null; - /** - * True if the entitlement is requestable - * @type {boolean} - * @memberof EntitlementBeta - */ - 'requestable'?: boolean; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof EntitlementBeta - */ - 'attributes'?: { [key: string]: any; }; - /** - * - * @type {EntitlementSourceBeta} - * @memberof EntitlementBeta - */ - 'source'?: EntitlementSourceBeta; - /** - * - * @type {EntitlementOwnerBeta} - * @memberof EntitlementBeta - */ - 'owner'?: EntitlementOwnerBeta; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof EntitlementBeta - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof EntitlementBeta - */ - 'directPermissions'?: Array; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof EntitlementBeta - */ - 'segments'?: Array | null; - /** - * - * @type {EntitlementManuallyUpdatedFieldsBeta} - * @memberof EntitlementBeta - */ - 'manuallyUpdatedFields'?: EntitlementManuallyUpdatedFieldsBeta; - /** - * - * @type {EntitlementAccessModelMetadataBeta} - * @memberof EntitlementBeta - */ - 'accessModelMetadata'?: EntitlementAccessModelMetadataBeta; -} -/** - * Object for specifying the bulk update request - * @export - * @interface EntitlementBulkUpdateRequestBeta - */ -export interface EntitlementBulkUpdateRequestBeta { - /** - * List of entitlement ids to update - * @type {Array} - * @memberof EntitlementBulkUpdateRequestBeta - */ - 'entitlementIds': Array; - /** - * List of entitlement ids to update - * @type {Array} - * @memberof EntitlementBulkUpdateRequestBeta - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface EntitlementManuallyUpdatedFieldsBeta - */ -export interface EntitlementManuallyUpdatedFieldsBeta { - /** - * True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. - * @type {boolean} - * @memberof EntitlementManuallyUpdatedFieldsBeta - */ - 'DISPLAY_NAME'?: boolean; - /** - * True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. - * @type {boolean} - * @memberof EntitlementManuallyUpdatedFieldsBeta - */ - 'DESCRIPTION'?: boolean; -} -/** - * - * @export - * @interface EntitlementOwnerBeta - */ -export interface EntitlementOwnerBeta { - /** - * The owner id for the entitlement - * @type {string} - * @memberof EntitlementOwnerBeta - */ - 'id'?: string; - /** - * The owner name for the entitlement - * @type {string} - * @memberof EntitlementOwnerBeta - */ - 'name'?: string; - /** - * The type of the owner. Initially only type IDENTITY is supported - * @type {string} - * @memberof EntitlementOwnerBeta - */ - 'type'?: EntitlementOwnerBetaTypeBeta; -} - -export const EntitlementOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type EntitlementOwnerBetaTypeBeta = typeof EntitlementOwnerBetaTypeBeta[keyof typeof EntitlementOwnerBetaTypeBeta]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface EntitlementRefBeta - */ -export interface EntitlementRefBeta { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof EntitlementRefBeta - */ - 'type'?: EntitlementRefBetaTypeBeta; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof EntitlementRefBeta - */ - 'id'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementRefBeta - */ - 'name'?: string | null; -} - -export const EntitlementRefBetaTypeBeta = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type EntitlementRefBetaTypeBeta = typeof EntitlementRefBetaTypeBeta[keyof typeof EntitlementRefBetaTypeBeta]; - -/** - * - * @export - * @interface EntitlementRequestConfig1Beta - */ -export interface EntitlementRequestConfig1Beta { - /** - * If this is true, entitlement requests are allowed. - * @type {boolean} - * @memberof EntitlementRequestConfig1Beta - */ - 'allowEntitlementRequest'?: boolean; - /** - * If this is true, comments are required to submit entitlement requests. - * @type {boolean} - * @memberof EntitlementRequestConfig1Beta - */ - 'requestCommentsRequired'?: boolean; - /** - * If this is true, comments are required to reject entitlement requests. - * @type {boolean} - * @memberof EntitlementRequestConfig1Beta - */ - 'deniedCommentsRequired'?: boolean; - /** - * Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). - * @type {string} - * @memberof EntitlementRequestConfig1Beta - */ - 'grantRequestApprovalSchemes'?: string | null; -} -/** - * - * @export - * @interface EntitlementRequestConfigBeta - */ -export interface EntitlementRequestConfigBeta { - /** - * - * @type {EntitlementAccessRequestConfigBeta} - * @memberof EntitlementRequestConfigBeta - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigBeta; - /** - * - * @type {EntitlementRevocationRequestConfigBeta} - * @memberof EntitlementRequestConfigBeta - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigBeta; -} -/** - * - * @export - * @interface EntitlementRevocationRequestConfigBeta - */ -export interface EntitlementRevocationRequestConfigBeta { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementRevocationRequestConfigBeta - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface EntitlementSourceBeta - */ -export interface EntitlementSourceBeta { - /** - * The source ID - * @type {string} - * @memberof EntitlementSourceBeta - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementSourceBeta - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementSourceBeta - */ - 'name'?: string | null; -} -/** - * - * @export - * @interface EntitlementSourceResetBaseReferenceDtoBeta - */ -export interface EntitlementSourceResetBaseReferenceDtoBeta { - /** - * The DTO type - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoBeta - */ - 'type'?: string; - /** - * The task ID of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface EntityCreatedByDTOBeta - */ -export interface EntityCreatedByDTOBeta { - /** - * ID of the creator - * @type {string} - * @memberof EntityCreatedByDTOBeta - */ - 'id'?: string; - /** - * The display name of the creator - * @type {string} - * @memberof EntityCreatedByDTOBeta - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface ErrorBeta - */ -export interface ErrorBeta { - /** - * DetailCode is the text of the status code returned - * @type {string} - * @memberof ErrorBeta - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof ErrorBeta - */ - 'messages'?: Array; - /** - * TrackingID is the request tracking unique identifier - * @type {string} - * @memberof ErrorBeta - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface ErrorMessageBeta - */ -export interface ErrorMessageBeta { - /** - * Locale is the current Locale - * @type {string} - * @memberof ErrorMessageBeta - */ - 'locale'?: string; - /** - * LocaleOrigin holds possible values of how the locale was selected - * @type {string} - * @memberof ErrorMessageBeta - */ - 'localeOrigin'?: string; - /** - * Text is the actual text of the error message - * @type {string} - * @memberof ErrorMessageBeta - */ - 'text'?: string; -} -/** - * - * @export - * @interface ErrorMessageDto1Beta - */ -export interface ErrorMessageDto1Beta { - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof ErrorMessageDto1Beta - */ - 'locale'?: string | null; - /** - * - * @type {LocaleOriginBeta} - * @memberof ErrorMessageDto1Beta - */ - 'localeOrigin'?: LocaleOriginBeta | null; - /** - * Actual text of the error message in the indicated locale. - * @type {string} - * @memberof ErrorMessageDto1Beta - */ - 'text'?: string; -} - - -/** - * - * @export - * @interface ErrorMessageDtoBeta - */ -export interface ErrorMessageDtoBeta { - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof ErrorMessageDtoBeta - */ - 'locale'?: string | null; - /** - * - * @type {LocaleOriginBeta} - * @memberof ErrorMessageDtoBeta - */ - 'localeOrigin'?: LocaleOriginBeta | null; - /** - * Actual text of the error message in the indicated locale. - * @type {string} - * @memberof ErrorMessageDtoBeta - */ - 'text'?: string; -} - - -/** - * - * @export - * @interface ErrorResponseDtoBeta - */ -export interface ErrorResponseDtoBeta { - /** - * Fine-grained error code providing more detail of the error. - * @type {string} - * @memberof ErrorResponseDtoBeta - */ - 'detailCode'?: string; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof ErrorResponseDtoBeta - */ - 'trackingId'?: string; - /** - * Generic localized reason for error - * @type {Array} - * @memberof ErrorResponseDtoBeta - */ - 'messages'?: Array; - /** - * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - * @type {Array} - * @memberof ErrorResponseDtoBeta - */ - 'causes'?: Array; -} -/** - * The response body for Evaluate Reassignment Configuration - * @export - * @interface EvaluateResponseBeta - */ -export interface EvaluateResponseBeta { - /** - * The Identity ID which should be the recipient of any work items sent to a specific identity & work type - * @type {string} - * @memberof EvaluateResponseBeta - */ - 'reassignToId'?: string; - /** - * List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration - * @type {Array} - * @memberof EvaluateResponseBeta - */ - 'lookupTrail'?: Array; -} -/** - * Attributes related to an IdentityNow ETS event - * @export - * @interface EventAttributesBeta - */ -export interface EventAttributesBeta { - /** - * The unique ID of the trigger - * @type {string} - * @memberof EventAttributesBeta - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof EventAttributesBeta - */ - 'filter.$'?: string | null; - /** - * Description of the event trigger - * @type {string} - * @memberof EventAttributesBeta - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof EventAttributesBeta - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof EventAttributesBeta - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface EventBridgeConfigBeta - */ -export interface EventBridgeConfigBeta { - /** - * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. - * @type {string} - * @memberof EventBridgeConfigBeta - */ - 'awsAccount': string; - /** - * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. - * @type {string} - * @memberof EventBridgeConfigBeta - */ - 'awsRegion': string; -} -/** - * - * @export - * @interface ExceptionAccessCriteriaBeta - */ -export interface ExceptionAccessCriteriaBeta { - /** - * - * @type {ExceptionCriteriaBeta} - * @memberof ExceptionAccessCriteriaBeta - */ - 'leftCriteria'?: ExceptionCriteriaBeta; - /** - * - * @type {ExceptionCriteriaBeta} - * @memberof ExceptionAccessCriteriaBeta - */ - 'rightCriteria'?: ExceptionCriteriaBeta; -} -/** - * Access reference with addition of boolean existing flag to indicate whether the access was extant - * @export - * @interface ExceptionCriteriaAccessBeta - */ -export interface ExceptionCriteriaAccessBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof ExceptionCriteriaAccessBeta - */ - 'type'?: DtoTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessBeta - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaAccessBeta - */ - 'existing'?: boolean; -} - - -/** - * - * @export - * @interface ExceptionCriteriaBeta - */ -export interface ExceptionCriteriaBeta { - /** - * List of exception criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof ExceptionCriteriaBeta - */ - 'criteriaList'?: Array; -} -/** - * The types of objects supported for SOD violations - * @export - * @interface ExceptionCriteriaCriteriaListInnerBeta - */ -export interface ExceptionCriteriaCriteriaListInnerBeta { - /** - * The type of object that is referenced - * @type {object} - * @memberof ExceptionCriteriaCriteriaListInnerBeta - */ - 'type'?: ExceptionCriteriaCriteriaListInnerBetaTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerBeta - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaCriteriaListInnerBeta - */ - 'existing'?: boolean; -} - -export const ExceptionCriteriaCriteriaListInnerBetaTypeBeta = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ExceptionCriteriaCriteriaListInnerBetaTypeBeta = typeof ExceptionCriteriaCriteriaListInnerBetaTypeBeta[keyof typeof ExceptionCriteriaCriteriaListInnerBetaTypeBeta]; - -/** - * The current state of execution. - * @export - * @enum {string} - */ - -export const ExecutionStatusBeta = { - Executing: 'EXECUTING', - Verifying: 'VERIFYING', - Terminated: 'TERMINATED', - Completed: 'COMPLETED' -} as const; - -export type ExecutionStatusBeta = typeof ExecutionStatusBeta[keyof typeof ExecutionStatusBeta]; - - -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerBeta - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerBeta { - /** - * - * @type {FormDefinitionResponseBeta} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerBeta - */ - 'object'?: FormDefinitionResponseBeta; - /** - * - * @type {FormDefinitionSelfImportExportDtoBeta} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerBeta - */ - 'self'?: FormDefinitionSelfImportExportDtoBeta; - /** - * - * @type {number} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerBeta - */ - 'version'?: number; -} -/** - * - * @export - * @interface ExportOptionsBeta - */ -export interface ExportOptionsBeta { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptionsBeta - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptionsBeta - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsBeta; }} - * @memberof ExportOptionsBeta - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsBeta; }; -} - -export const ExportOptionsBetaExcludeTypesBeta = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsBetaExcludeTypesBeta = typeof ExportOptionsBetaExcludeTypesBeta[keyof typeof ExportOptionsBetaExcludeTypesBeta]; -export const ExportOptionsBetaIncludeTypesBeta = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsBetaIncludeTypesBeta = typeof ExportOptionsBetaIncludeTypesBeta[keyof typeof ExportOptionsBetaIncludeTypesBeta]; - -/** - * - * @export - * @interface ExportPayloadBeta - */ -export interface ExportPayloadBeta { - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof ExportPayloadBeta - */ - 'description'?: string; - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportPayloadBeta - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportPayloadBeta - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsBeta; }} - * @memberof ExportPayloadBeta - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsBeta; }; -} - -export const ExportPayloadBetaExcludeTypesBeta = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadBetaExcludeTypesBeta = typeof ExportPayloadBetaExcludeTypesBeta[keyof typeof ExportPayloadBetaExcludeTypesBeta]; -export const ExportPayloadBetaIncludeTypesBeta = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadBetaIncludeTypesBeta = typeof ExportPayloadBetaIncludeTypesBeta[keyof typeof ExportPayloadBetaIncludeTypesBeta]; - -/** - * - * @export - * @interface ExpressionBeta - */ -export interface ExpressionBeta { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionBeta - */ - 'operator'?: ExpressionBetaOperatorBeta; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionBeta - */ - 'attribute'?: string | null; - /** - * - * @type {ValueBeta} - * @memberof ExpressionBeta - */ - 'value'?: ValueBeta | null; - /** - * List of expressions - * @type {Array} - * @memberof ExpressionBeta - */ - 'children'?: Array | null; -} - -export const ExpressionBetaOperatorBeta = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionBetaOperatorBeta = typeof ExpressionBetaOperatorBeta[keyof typeof ExpressionBetaOperatorBeta]; - -/** - * Attributes related to an external trigger - * @export - * @interface ExternalAttributesBeta - */ -export interface ExternalAttributesBeta { - /** - * A unique name for the external trigger - * @type {string} - * @memberof ExternalAttributesBeta - */ - 'name'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof ExternalAttributesBeta - */ - 'description'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof ExternalAttributesBeta - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof ExternalAttributesBeta - */ - 'url'?: string | null; -} -/** - * - * @export - * @interface FeatureValueDtoBeta - */ -export interface FeatureValueDtoBeta { - /** - * The type of feature - * @type {string} - * @memberof FeatureValueDtoBeta - */ - 'feature'?: string; - /** - * The number of identities that have access to the feature - * @type {number} - * @memberof FeatureValueDtoBeta - */ - 'numerator'?: number; - /** - * The number of identities with the corresponding feature - * @type {number} - * @memberof FeatureValueDtoBeta - */ - 'denominator'?: number; -} -/** - * - * @export - * @interface FieldBeta - */ -export interface FieldBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof FieldBeta - */ - 'name'?: string; - /** - * Display name of the field - * @type {string} - * @memberof FieldBeta - */ - 'displayName'?: string; - /** - * Type of the field to display - * @type {string} - * @memberof FieldBeta - */ - 'displayType'?: string; - /** - * True if the field is required - * @type {boolean} - * @memberof FieldBeta - */ - 'required'?: boolean; - /** - * List of allowed values for the field - * @type {Array} - * @memberof FieldBeta - */ - 'allowedValuesList'?: Array; - /** - * Value of the field - * @type {object} - * @memberof FieldBeta - */ - 'value'?: object; -} -/** - * - * @export - * @interface FieldDetailsBeta - */ -export interface FieldDetailsBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof FieldDetailsBeta - */ - 'name'?: string; - /** - * Display name of the field - * @type {string} - * @memberof FieldDetailsBeta - */ - 'displayName'?: string; - /** - * Type of the field to display - * @type {string} - * @memberof FieldDetailsBeta - */ - 'displayType'?: string; - /** - * True if the field is required - * @type {boolean} - * @memberof FieldDetailsBeta - */ - 'required'?: boolean; - /** - * List of allowed values for the field - * @type {Array} - * @memberof FieldDetailsBeta - */ - 'allowedValuesList'?: Array; - /** - * Value of the field - * @type {object} - * @memberof FieldDetailsBeta - */ - 'value'?: object; -} -/** - * - * @export - * @interface FieldDetailsDtoBeta - */ -export interface FieldDetailsDtoBeta { - /** - * The name of the attribute. - * @type {string} - * @memberof FieldDetailsDtoBeta - */ - 'name'?: string; - /** - * The transform to apply to the field - * @type {object} - * @memberof FieldDetailsDtoBeta - */ - 'transform'?: object; - /** - * Attributes required for the transform - * @type {object} - * @memberof FieldDetailsDtoBeta - */ - 'attributes'?: object; - /** - * Flag indicating whether or not the attribute is required. - * @type {boolean} - * @memberof FieldDetailsDtoBeta - */ - 'isRequired'?: boolean; - /** - * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. - * @type {string} - * @memberof FieldDetailsDtoBeta - */ - 'type'?: FieldDetailsDtoBetaTypeBeta; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof FieldDetailsDtoBeta - */ - 'isMultiValued'?: boolean; -} - -export const FieldDetailsDtoBetaTypeBeta = { - String: 'string', - Int: 'int', - Long: 'long', - Date: 'date', - Boolean: 'boolean', - Secret: 'secret' -} as const; - -export type FieldDetailsDtoBetaTypeBeta = typeof FieldDetailsDtoBetaTypeBeta[keyof typeof FieldDetailsDtoBetaTypeBeta]; - -/** - * - * @export - * @interface FirstValidBeta - */ -export interface FirstValidBeta { - /** - * An array of attributes to evaluate for existence. - * @type {Array} - * @memberof FirstValidBeta - */ - 'values': Array; - /** - * a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - * @type {boolean} - * @memberof FirstValidBeta - */ - 'ignoreErrors'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof FirstValidBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface FormBeta - */ -export interface FormBeta { - /** - * ID of the form - * @type {string} - * @memberof FormBeta - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormBeta - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormBeta - */ - 'title'?: string; - /** - * The form subtitle. - * @type {string} - * @memberof FormBeta - */ - 'subtitle'?: string; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormBeta - */ - 'targetUser'?: string; - /** - * - * @type {Array} - * @memberof FormBeta - */ - 'sections'?: Array; -} -/** - * Represent a form conditional. - * @export - * @interface FormConditionBeta - */ -export interface FormConditionBeta { - /** - * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr - * @type {string} - * @memberof FormConditionBeta - */ - 'ruleOperator'?: FormConditionBetaRuleOperatorBeta; - /** - * List of rules. - * @type {Array} - * @memberof FormConditionBeta - */ - 'rules'?: Array; - /** - * List of effects. - * @type {Array} - * @memberof FormConditionBeta - */ - 'effects'?: Array; -} - -export const FormConditionBetaRuleOperatorBeta = { - And: 'AND', - Or: 'OR' -} as const; - -export type FormConditionBetaRuleOperatorBeta = typeof FormConditionBetaRuleOperatorBeta[keyof typeof FormConditionBetaRuleOperatorBeta]; - -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestAttributesBeta - */ -export interface FormDefinitionDynamicSchemaRequestAttributesBeta { - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestAttributesBeta - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestBeta - */ -export interface FormDefinitionDynamicSchemaRequestBeta { - /** - * - * @type {FormDefinitionDynamicSchemaRequestAttributesBeta} - * @memberof FormDefinitionDynamicSchemaRequestBeta - */ - 'attributes'?: FormDefinitionDynamicSchemaRequestAttributesBeta; - /** - * Description is the form definition dynamic schema description text - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestBeta - */ - 'description'?: string; - /** - * ID is a unique identifier - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestBeta - */ - 'id'?: string; - /** - * Type is the form definition dynamic schema type - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestBeta - */ - 'type'?: string; - /** - * VersionNumber is the form definition dynamic schema version number - * @type {number} - * @memberof FormDefinitionDynamicSchemaRequestBeta - */ - 'versionNumber'?: number; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaResponseBeta - */ -export interface FormDefinitionDynamicSchemaResponseBeta { - /** - * OutputSchema holds a JSON schema generated dynamically - * @type {{ [key: string]: object; }} - * @memberof FormDefinitionDynamicSchemaResponseBeta - */ - 'outputSchema'?: { [key: string]: object; }; -} -/** - * - * @export - * @interface FormDefinitionFileUploadResponseBeta - */ -export interface FormDefinitionFileUploadResponseBeta { - /** - * Created is the date the file was uploaded - * @type {string} - * @memberof FormDefinitionFileUploadResponseBeta - */ - 'created'?: string; - /** - * fileId is a unique ULID that serves as an identifier for the form definition file - * @type {string} - * @memberof FormDefinitionFileUploadResponseBeta - */ - 'fileId'?: string; - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionFileUploadResponseBeta - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionInputBeta - */ -export interface FormDefinitionInputBeta { - /** - * Unique identifier for the form input. - * @type {string} - * @memberof FormDefinitionInputBeta - */ - 'id'?: string; - /** - * FormDefinitionInputType value. STRING FormDefinitionInputTypeString - * @type {string} - * @memberof FormDefinitionInputBeta - */ - 'type'?: FormDefinitionInputBetaTypeBeta; - /** - * Name for the form input. - * @type {string} - * @memberof FormDefinitionInputBeta - */ - 'label'?: string; - /** - * Form input\'s description. - * @type {string} - * @memberof FormDefinitionInputBeta - */ - 'description'?: string; -} - -export const FormDefinitionInputBetaTypeBeta = { - String: 'STRING', - Array: 'ARRAY' -} as const; - -export type FormDefinitionInputBetaTypeBeta = typeof FormDefinitionInputBetaTypeBeta[keyof typeof FormDefinitionInputBetaTypeBeta]; - -/** - * - * @export - * @interface FormDefinitionResponseBeta - */ -export interface FormDefinitionResponseBeta { - /** - * Unique guid identifying the form definition. - * @type {string} - * @memberof FormDefinitionResponseBeta - */ - 'id'?: string; - /** - * Name of the form definition. - * @type {string} - * @memberof FormDefinitionResponseBeta - */ - 'name'?: string; - /** - * Form definition\'s description. - * @type {string} - * @memberof FormDefinitionResponseBeta - */ - 'description'?: string; - /** - * - * @type {FormOwnerBeta} - * @memberof FormDefinitionResponseBeta - */ - 'owner'?: FormOwnerBeta; - /** - * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. - * @type {Array} - * @memberof FormDefinitionResponseBeta - */ - 'usedBy'?: Array; - /** - * List of form inputs required to create a form-instance object. - * @type {Array} - * @memberof FormDefinitionResponseBeta - */ - 'formInput'?: Array; - /** - * List of nested form elements. - * @type {Array} - * @memberof FormDefinitionResponseBeta - */ - 'formElements'?: Array; - /** - * Conditional logic that can dynamically modify the form as the recipient is interacting with it. - * @type {Array} - * @memberof FormDefinitionResponseBeta - */ - 'formConditions'?: Array; - /** - * Created is the date the form definition was created - * @type {string} - * @memberof FormDefinitionResponseBeta - */ - 'created'?: string; - /** - * Modified is the last date the form definition was modified - * @type {string} - * @memberof FormDefinitionResponseBeta - */ - 'modified'?: string; -} -/** - * Self block for imported/exported object. - * @export - * @interface FormDefinitionSelfImportExportDtoBeta - */ -export interface FormDefinitionSelfImportExportDtoBeta { - /** - * Imported/exported object\'s DTO type. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoBeta - */ - 'type'?: FormDefinitionSelfImportExportDtoBetaTypeBeta; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoBeta - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoBeta - */ - 'name'?: string; -} - -export const FormDefinitionSelfImportExportDtoBetaTypeBeta = { - FormDefinition: 'FORM_DEFINITION' -} as const; - -export type FormDefinitionSelfImportExportDtoBetaTypeBeta = typeof FormDefinitionSelfImportExportDtoBetaTypeBeta[keyof typeof FormDefinitionSelfImportExportDtoBetaTypeBeta]; - -/** - * - * @export - * @interface FormDetailsBeta - */ -export interface FormDetailsBeta { - /** - * ID of the form - * @type {string} - * @memberof FormDetailsBeta - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormDetailsBeta - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormDetailsBeta - */ - 'title'?: string; - /** - * The form subtitle. - * @type {string} - * @memberof FormDetailsBeta - */ - 'subtitle'?: string; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormDetailsBeta - */ - 'targetUser'?: string; - /** - * - * @type {Array} - * @memberof FormDetailsBeta - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface FormElementBeta - */ -export interface FormElementBeta { - /** - * Form element identifier. - * @type {string} - * @memberof FormElementBeta - */ - 'id'?: string; - /** - * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription - * @type {string} - * @memberof FormElementBeta - */ - 'elementType'?: FormElementBetaElementTypeBeta; - /** - * Config object. - * @type {{ [key: string]: any; }} - * @memberof FormElementBeta - */ - 'config'?: { [key: string]: any; }; - /** - * Technical key. - * @type {string} - * @memberof FormElementBeta - */ - 'key'?: string; - /** - * - * @type {Array} - * @memberof FormElementBeta - */ - 'validations'?: Array | null; -} - -export const FormElementBetaElementTypeBeta = { - Text: 'TEXT', - Toggle: 'TOGGLE', - Textarea: 'TEXTAREA', - Hidden: 'HIDDEN', - Phone: 'PHONE', - Email: 'EMAIL', - Select: 'SELECT', - Date: 'DATE', - Section: 'SECTION', - ColumnSet: 'COLUMN_SET', - Image: 'IMAGE', - Description: 'DESCRIPTION' -} as const; - -export type FormElementBetaElementTypeBeta = typeof FormElementBetaElementTypeBeta[keyof typeof FormElementBetaElementTypeBeta]; - -/** - * - * @export - * @interface FormElementDataSourceConfigOptionsBeta - */ -export interface FormElementDataSourceConfigOptionsBeta { - /** - * Label is the main label to display to the user when selecting this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsBeta - */ - 'label'?: string; - /** - * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsBeta - */ - 'subLabel'?: string; - /** - * Value is the value to save as an entry when the user selects this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsBeta - */ - 'value'?: string; -} -/** - * - * @export - * @interface FormElementDynamicDataSourceBeta - */ -export interface FormElementDynamicDataSourceBeta { - /** - * - * @type {FormElementDynamicDataSourceConfigBeta} - * @memberof FormElementDynamicDataSourceBeta - */ - 'config'?: FormElementDynamicDataSourceConfigBeta; - /** - * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput - * @type {string} - * @memberof FormElementDynamicDataSourceBeta - */ - 'dataSourceType'?: FormElementDynamicDataSourceBetaDataSourceTypeBeta; -} - -export const FormElementDynamicDataSourceBetaDataSourceTypeBeta = { - Static: 'STATIC', - Internal: 'INTERNAL', - Search: 'SEARCH', - FormInput: 'FORM_INPUT' -} as const; - -export type FormElementDynamicDataSourceBetaDataSourceTypeBeta = typeof FormElementDynamicDataSourceBetaDataSourceTypeBeta[keyof typeof FormElementDynamicDataSourceBetaDataSourceTypeBeta]; - -/** - * - * @export - * @interface FormElementDynamicDataSourceConfigBeta - */ -export interface FormElementDynamicDataSourceConfigBeta { - /** - * AggregationBucketField is the aggregation bucket field name - * @type {string} - * @memberof FormElementDynamicDataSourceConfigBeta - */ - 'aggregationBucketField'?: string; - /** - * Indices is a list of indices to use - * @type {Array} - * @memberof FormElementDynamicDataSourceConfigBeta - */ - 'indices'?: Array; - /** - * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement - * @type {string} - * @memberof FormElementDynamicDataSourceConfigBeta - */ - 'objectType'?: FormElementDynamicDataSourceConfigBetaObjectTypeBeta; - /** - * Query is a text - * @type {string} - * @memberof FormElementDynamicDataSourceConfigBeta - */ - 'query'?: string; -} - -export const FormElementDynamicDataSourceConfigBetaIndicesBeta = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Identities: 'identities', - Events: 'events', - Roles: 'roles', - Star: '*' -} as const; - -export type FormElementDynamicDataSourceConfigBetaIndicesBeta = typeof FormElementDynamicDataSourceConfigBetaIndicesBeta[keyof typeof FormElementDynamicDataSourceConfigBetaIndicesBeta]; -export const FormElementDynamicDataSourceConfigBetaObjectTypeBeta = { - Identity: 'IDENTITY', - AccessProfile: 'ACCESS_PROFILE', - Sources: 'SOURCES', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type FormElementDynamicDataSourceConfigBetaObjectTypeBeta = typeof FormElementDynamicDataSourceConfigBetaObjectTypeBeta[keyof typeof FormElementDynamicDataSourceConfigBetaObjectTypeBeta]; - -/** - * - * @export - * @interface FormElementPreviewRequestBeta - */ -export interface FormElementPreviewRequestBeta { - /** - * - * @type {FormElementDynamicDataSourceBeta} - * @memberof FormElementPreviewRequestBeta - */ - 'dataSource'?: FormElementDynamicDataSourceBeta; -} -/** - * Set of FormElementValidation items. - * @export - * @interface FormElementValidationsSetBeta - */ -export interface FormElementValidationsSetBeta { - /** - * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. - * @type {string} - * @memberof FormElementValidationsSetBeta - */ - 'validationType'?: FormElementValidationsSetBetaValidationTypeBeta; -} - -export const FormElementValidationsSetBetaValidationTypeBeta = { - Required: 'REQUIRED', - MinLength: 'MIN_LENGTH', - MaxLength: 'MAX_LENGTH', - Regex: 'REGEX', - Date: 'DATE', - MaxDate: 'MAX_DATE', - MinDate: 'MIN_DATE', - LessThanDate: 'LESS_THAN_DATE', - Phone: 'PHONE', - Email: 'EMAIL', - DataSource: 'DATA_SOURCE', - Textarea: 'TEXTAREA' -} as const; - -export type FormElementValidationsSetBetaValidationTypeBeta = typeof FormElementValidationsSetBetaValidationTypeBeta[keyof typeof FormElementValidationsSetBetaValidationTypeBeta]; - -/** - * - * @export - * @interface FormErrorBeta - */ -export interface FormErrorBeta { - /** - * Key is the technical key - * @type {string} - * @memberof FormErrorBeta - */ - 'key'?: string; - /** - * Messages is a list of web.ErrorMessage items - * @type {Array} - * @memberof FormErrorBeta - */ - 'messages'?: Array; - /** - * Value is the value associated with a Key - * @type {object} - * @memberof FormErrorBeta - */ - 'value'?: object; -} -/** - * - * @export - * @interface FormInstanceCreatedByBeta - */ -export interface FormInstanceCreatedByBeta { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceCreatedByBeta - */ - 'id'?: string; - /** - * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource - * @type {string} - * @memberof FormInstanceCreatedByBeta - */ - 'type'?: FormInstanceCreatedByBetaTypeBeta; -} - -export const FormInstanceCreatedByBetaTypeBeta = { - WorkflowExecution: 'WORKFLOW_EXECUTION', - Source: 'SOURCE' -} as const; - -export type FormInstanceCreatedByBetaTypeBeta = typeof FormInstanceCreatedByBetaTypeBeta[keyof typeof FormInstanceCreatedByBetaTypeBeta]; - -/** - * - * @export - * @interface FormInstanceRecipientBeta - */ -export interface FormInstanceRecipientBeta { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceRecipientBeta - */ - 'id'?: string; - /** - * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity - * @type {string} - * @memberof FormInstanceRecipientBeta - */ - 'type'?: FormInstanceRecipientBetaTypeBeta; -} - -export const FormInstanceRecipientBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type FormInstanceRecipientBetaTypeBeta = typeof FormInstanceRecipientBetaTypeBeta[keyof typeof FormInstanceRecipientBetaTypeBeta]; - -/** - * - * @export - * @interface FormInstanceResponseBeta - */ -export interface FormInstanceResponseBeta { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'state'?: FormInstanceResponseBetaStateBeta; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof FormInstanceResponseBeta - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByBeta} - * @memberof FormInstanceResponseBeta - */ - 'createdBy'?: FormInstanceCreatedByBeta; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof FormInstanceResponseBeta - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof FormInstanceResponseBeta - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof FormInstanceResponseBeta - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof FormInstanceResponseBeta - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof FormInstanceResponseBeta - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof FormInstanceResponseBeta - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof FormInstanceResponseBeta - */ - 'recipients'?: Array; -} - -export const FormInstanceResponseBetaStateBeta = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type FormInstanceResponseBetaStateBeta = typeof FormInstanceResponseBetaStateBeta[keyof typeof FormInstanceResponseBetaStateBeta]; - -/** - * - * @export - * @interface FormItemBeta - */ -export interface FormItemBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface FormItemDetailsBeta - */ -export interface FormItemDetailsBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemDetailsBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface FormOwnerBeta - */ -export interface FormOwnerBeta { - /** - * FormOwnerType value. IDENTITY FormOwnerTypeIdentity - * @type {string} - * @memberof FormOwnerBeta - */ - 'type'?: FormOwnerBetaTypeBeta; - /** - * Unique identifier of the form\'s owner. - * @type {string} - * @memberof FormOwnerBeta - */ - 'id'?: string; - /** - * Name of the form\'s owner. - * @type {string} - * @memberof FormOwnerBeta - */ - 'name'?: string; -} - -export const FormOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type FormOwnerBetaTypeBeta = typeof FormOwnerBetaTypeBeta[keyof typeof FormOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface FormUsedByBeta - */ -export interface FormUsedByBeta { - /** - * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType - * @type {string} - * @memberof FormUsedByBeta - */ - 'type'?: FormUsedByBetaTypeBeta; - /** - * Unique identifier of the system using the form. - * @type {string} - * @memberof FormUsedByBeta - */ - 'id'?: string; - /** - * Name of the system using the form. - * @type {string} - * @memberof FormUsedByBeta - */ - 'name'?: string; -} - -export const FormUsedByBetaTypeBeta = { - Workflow: 'WORKFLOW', - Source: 'SOURCE', - MySailPoint: 'MySailPoint' -} as const; - -export type FormUsedByBetaTypeBeta = typeof FormUsedByBetaTypeBeta[keyof typeof FormUsedByBetaTypeBeta]; - -/** - * - * @export - * @interface ForwardApprovalDtoBeta - */ -export interface ForwardApprovalDtoBeta { - /** - * The Id of the new owner - * @type {string} - * @memberof ForwardApprovalDtoBeta - */ - 'newOwnerId': string; - /** - * The comment provided by the forwarder - * @type {string} - * @memberof ForwardApprovalDtoBeta - */ - 'comment': string; -} -/** - * Discovered applications with their respective associated sources - * @export - * @interface FullDiscoveredApplicationsBeta - */ -export interface FullDiscoveredApplicationsBeta { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsBeta - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'status'?: string; - /** - * List of associated sources related to this discovered application. - * @type {Array} - * @memberof FullDiscoveredApplicationsBeta - */ - 'associatedSources'?: Array; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof FullDiscoveredApplicationsBeta - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof FullDiscoveredApplicationsBeta - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof FullDiscoveredApplicationsBeta - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsBeta - */ - 'riskLevel'?: FullDiscoveredApplicationsBetaRiskLevelBeta; -} - -export const FullDiscoveredApplicationsBetaRiskLevelBeta = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type FullDiscoveredApplicationsBetaRiskLevelBeta = typeof FullDiscoveredApplicationsBetaRiskLevelBeta[keyof typeof FullDiscoveredApplicationsBetaRiskLevelBeta]; - -/** - * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - * @export - * @interface FullcampaignAllOfFilterBeta - */ -export interface FullcampaignAllOfFilterBeta { - /** - * The ID of whatever type of filter is being used. - * @type {string} - * @memberof FullcampaignAllOfFilterBeta - */ - 'id'?: string; - /** - * Type of the filter - * @type {string} - * @memberof FullcampaignAllOfFilterBeta - */ - 'type'?: FullcampaignAllOfFilterBetaTypeBeta; - /** - * Name of the filter - * @type {string} - * @memberof FullcampaignAllOfFilterBeta - */ - 'name'?: string; -} - -export const FullcampaignAllOfFilterBetaTypeBeta = { - CampaignFilter: 'CAMPAIGN_FILTER' -} as const; - -export type FullcampaignAllOfFilterBetaTypeBeta = typeof FullcampaignAllOfFilterBetaTypeBeta[keyof typeof FullcampaignAllOfFilterBetaTypeBeta]; - -/** - * Must be set only if the campaign type is MACHINE_ACCOUNT. - * @export - * @interface FullcampaignAllOfMachineAccountCampaignInfoBeta - */ -export interface FullcampaignAllOfMachineAccountCampaignInfoBeta { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof FullcampaignAllOfMachineAccountCampaignInfoBeta - */ - 'sourceIds'?: Array; - /** - * The reviewer\'s type. - * @type {string} - * @memberof FullcampaignAllOfMachineAccountCampaignInfoBeta - */ - 'reviewerType'?: FullcampaignAllOfMachineAccountCampaignInfoBetaReviewerTypeBeta; -} - -export const FullcampaignAllOfMachineAccountCampaignInfoBetaReviewerTypeBeta = { - AccountOwner: 'ACCOUNT_OWNER' -} as const; - -export type FullcampaignAllOfMachineAccountCampaignInfoBetaReviewerTypeBeta = typeof FullcampaignAllOfMachineAccountCampaignInfoBetaReviewerTypeBeta[keyof typeof FullcampaignAllOfMachineAccountCampaignInfoBetaReviewerTypeBeta]; - -/** - * Optional configuration options for role composition campaigns. - * @export - * @interface FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ -export interface FullcampaignAllOfRoleCompositionCampaignInfoBeta { - /** - * - * @type {FullcampaignAllOfSearchCampaignInfoReviewerBeta} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ - 'reviewer'?: FullcampaignAllOfSearchCampaignInfoReviewerBeta; - /** - * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {Array} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ - 'roleIds'?: Array; - /** - * - * @type {FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ - 'remediatorRef': FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta; - /** - * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {string} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ - 'query'?: string; - /** - * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - * @type {string} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoBeta - */ - 'description'?: string; -} -/** - * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. - * @export - * @interface FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta - */ -export interface FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta { - /** - * Legal Remediator Type - * @type {string} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta - */ - 'type': FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBetaTypeBeta; - /** - * The ID of the remediator. - * @type {string} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta - */ - 'id': string; - /** - * The name of the remediator. - * @type {string} - * @memberof FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBeta - */ - 'name'?: string; -} - -export const FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBetaTypeBeta = typeof FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBetaTypeBeta[keyof typeof FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRefBetaTypeBeta]; - -/** - * Must be set only if the campaign type is SEARCH. - * @export - * @interface FullcampaignAllOfSearchCampaignInfoBeta - */ -export interface FullcampaignAllOfSearchCampaignInfoBeta { - /** - * The type of search campaign represented. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'type': FullcampaignAllOfSearchCampaignInfoBetaTypeBeta; - /** - * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'description'?: string; - /** - * - * @type {FullcampaignAllOfSearchCampaignInfoReviewerBeta} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'reviewer'?: FullcampaignAllOfSearchCampaignInfoReviewerBeta; - /** - * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'query'?: string; - /** - * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - * @type {Array} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'identityIds'?: Array; - /** - * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - * @type {Array} - * @memberof FullcampaignAllOfSearchCampaignInfoBeta - */ - 'accessConstraints'?: Array; -} - -export const FullcampaignAllOfSearchCampaignInfoBetaTypeBeta = { - Identity: 'IDENTITY', - Access: 'ACCESS' -} as const; - -export type FullcampaignAllOfSearchCampaignInfoBetaTypeBeta = typeof FullcampaignAllOfSearchCampaignInfoBetaTypeBeta[keyof typeof FullcampaignAllOfSearchCampaignInfoBetaTypeBeta]; - -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface FullcampaignAllOfSearchCampaignInfoReviewerBeta - */ -export interface FullcampaignAllOfSearchCampaignInfoReviewerBeta { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoReviewerBeta - */ - 'type'?: FullcampaignAllOfSearchCampaignInfoReviewerBetaTypeBeta; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoReviewerBeta - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof FullcampaignAllOfSearchCampaignInfoReviewerBeta - */ - 'name'?: string; -} - -export const FullcampaignAllOfSearchCampaignInfoReviewerBetaTypeBeta = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type FullcampaignAllOfSearchCampaignInfoReviewerBetaTypeBeta = typeof FullcampaignAllOfSearchCampaignInfoReviewerBetaTypeBeta[keyof typeof FullcampaignAllOfSearchCampaignInfoReviewerBetaTypeBeta]; - -/** - * Must be set only if the campaign type is SOURCE_OWNER. - * @export - * @interface FullcampaignAllOfSourceOwnerCampaignInfoBeta - */ -export interface FullcampaignAllOfSourceOwnerCampaignInfoBeta { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof FullcampaignAllOfSourceOwnerCampaignInfoBeta - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface FullcampaignAllOfSourcesWithOrphanEntitlementsBeta - */ -export interface FullcampaignAllOfSourcesWithOrphanEntitlementsBeta { - /** - * Id of the source - * @type {string} - * @memberof FullcampaignAllOfSourcesWithOrphanEntitlementsBeta - */ - 'id'?: string; - /** - * Type - * @type {string} - * @memberof FullcampaignAllOfSourcesWithOrphanEntitlementsBeta - */ - 'type'?: FullcampaignAllOfSourcesWithOrphanEntitlementsBetaTypeBeta; - /** - * Name of the source - * @type {string} - * @memberof FullcampaignAllOfSourcesWithOrphanEntitlementsBeta - */ - 'name'?: string; -} - -export const FullcampaignAllOfSourcesWithOrphanEntitlementsBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type FullcampaignAllOfSourcesWithOrphanEntitlementsBetaTypeBeta = typeof FullcampaignAllOfSourcesWithOrphanEntitlementsBetaTypeBeta[keyof typeof FullcampaignAllOfSourcesWithOrphanEntitlementsBetaTypeBeta]; - -/** - * - * @export - * @interface FullcampaignBeta - */ -export interface FullcampaignBeta { - /** - * Id of the campaign - * @type {string} - * @memberof FullcampaignBeta - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof FullcampaignBeta - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof FullcampaignBeta - */ - 'description': string; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof FullcampaignBeta - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof FullcampaignBeta - */ - 'type': FullcampaignBetaTypeBeta; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof FullcampaignBeta - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof FullcampaignBeta - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof FullcampaignBeta - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof FullcampaignBeta - */ - 'status'?: FullcampaignBetaStatusBeta; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof FullcampaignBeta - */ - 'correlatedStatus'?: FullcampaignBetaCorrelatedStatusBeta; - /** - * Created time of the campaign - * @type {string} - * @memberof FullcampaignBeta - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof FullcampaignBeta - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof FullcampaignBeta - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof FullcampaignBeta - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof FullcampaignBeta - */ - 'modified'?: string; - /** - * - * @type {FullcampaignAllOfFilterBeta} - * @memberof FullcampaignBeta - */ - 'filter'?: FullcampaignAllOfFilterBeta; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof FullcampaignBeta - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {FullcampaignAllOfSourceOwnerCampaignInfoBeta} - * @memberof FullcampaignBeta - */ - 'sourceOwnerCampaignInfo'?: FullcampaignAllOfSourceOwnerCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfSearchCampaignInfoBeta} - * @memberof FullcampaignBeta - */ - 'searchCampaignInfo'?: FullcampaignAllOfSearchCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfRoleCompositionCampaignInfoBeta} - * @memberof FullcampaignBeta - */ - 'roleCompositionCampaignInfo'?: FullcampaignAllOfRoleCompositionCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfMachineAccountCampaignInfoBeta} - * @memberof FullcampaignBeta - */ - 'machineAccountCampaignInfo'?: FullcampaignAllOfMachineAccountCampaignInfoBeta; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof FullcampaignBeta - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof FullcampaignBeta - */ - 'mandatoryCommentRequirement'?: FullcampaignBetaMandatoryCommentRequirementBeta; -} - -export const FullcampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type FullcampaignBetaTypeBeta = typeof FullcampaignBetaTypeBeta[keyof typeof FullcampaignBetaTypeBeta]; -export const FullcampaignBetaStatusBeta = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type FullcampaignBetaStatusBeta = typeof FullcampaignBetaStatusBeta[keyof typeof FullcampaignBetaStatusBeta]; -export const FullcampaignBetaCorrelatedStatusBeta = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type FullcampaignBetaCorrelatedStatusBeta = typeof FullcampaignBetaCorrelatedStatusBeta[keyof typeof FullcampaignBetaCorrelatedStatusBeta]; -export const FullcampaignBetaMandatoryCommentRequirementBeta = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type FullcampaignBetaMandatoryCommentRequirementBeta = typeof FullcampaignBetaMandatoryCommentRequirementBeta[keyof typeof FullcampaignBetaMandatoryCommentRequirementBeta]; - -/** - * - * @export - * @interface GenerateRandomStringBeta - */ -export interface GenerateRandomStringBeta { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GenerateRandomStringBeta - */ - 'name': string; - /** - * The operation to perform `generateRandomString` - * @type {string} - * @memberof GenerateRandomStringBeta - */ - 'operation': string; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers - * @type {boolean} - * @memberof GenerateRandomStringBeta - */ - 'includeNumbers': boolean; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters - * @type {boolean} - * @memberof GenerateRandomStringBeta - */ - 'includeSpecialChars': boolean; - /** - * This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - * @type {string} - * @memberof GenerateRandomStringBeta - */ - 'length': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GenerateRandomStringBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetActiveCampaigns200ResponseInnerBeta - */ -export interface GetActiveCampaigns200ResponseInnerBeta { - /** - * Id of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'description': string; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'type': GetActiveCampaigns200ResponseInnerBetaTypeBeta; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'status'?: GetActiveCampaigns200ResponseInnerBetaStatusBeta; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'correlatedStatus'?: GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta; - /** - * Created time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'modified'?: string; - /** - * - * @type {FullcampaignAllOfFilterBeta} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'filter'?: FullcampaignAllOfFilterBeta; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {FullcampaignAllOfSourceOwnerCampaignInfoBeta} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'sourceOwnerCampaignInfo'?: FullcampaignAllOfSourceOwnerCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfSearchCampaignInfoBeta} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'searchCampaignInfo'?: FullcampaignAllOfSearchCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfRoleCompositionCampaignInfoBeta} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'roleCompositionCampaignInfo'?: FullcampaignAllOfRoleCompositionCampaignInfoBeta; - /** - * - * @type {FullcampaignAllOfMachineAccountCampaignInfoBeta} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'machineAccountCampaignInfo'?: FullcampaignAllOfMachineAccountCampaignInfoBeta; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerBeta - */ - 'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta; -} - -export const GetActiveCampaigns200ResponseInnerBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetActiveCampaigns200ResponseInnerBetaTypeBeta = typeof GetActiveCampaigns200ResponseInnerBetaTypeBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaTypeBeta]; -export const GetActiveCampaigns200ResponseInnerBetaStatusBeta = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetActiveCampaigns200ResponseInnerBetaStatusBeta = typeof GetActiveCampaigns200ResponseInnerBetaStatusBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaStatusBeta]; -export const GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta = typeof GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaCorrelatedStatusBeta]; -export const GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta = typeof GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta[keyof typeof GetActiveCampaigns200ResponseInnerBetaMandatoryCommentRequirementBeta]; - -/** - * @type GetDiscoveredApplications200ResponseInnerBeta - * @export - */ -export type GetDiscoveredApplications200ResponseInnerBeta = FullDiscoveredApplicationsBeta | SlimDiscoveredApplicationsBeta; - -/** - * - * @export - * @interface GetFormDefinitionByKey400ResponseBeta - */ -export interface GetFormDefinitionByKey400ResponseBeta { - /** - * - * @type {string} - * @memberof GetFormDefinitionByKey400ResponseBeta - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof GetFormDefinitionByKey400ResponseBeta - */ - 'messages'?: Array; - /** - * - * @type {number} - * @memberof GetFormDefinitionByKey400ResponseBeta - */ - 'statusCode'?: number; - /** - * - * @type {string} - * @memberof GetFormDefinitionByKey400ResponseBeta - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface GetHistoricalIdentityEvents200ResponseInnerBeta - */ -export interface GetHistoricalIdentityEvents200ResponseInnerBeta { - /** - * the id of the certification item - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseBeta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'signer'?: CertifierResponseBeta; - /** - * the event type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemBeta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'accessItem': AccessItemAssociatedAccessItemBeta; - /** - * - * @type {CorrelatedGovernanceEventBeta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'governanceEvent': CorrelatedGovernanceEventBeta | null; - /** - * the access item type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'accessItemType'?: GetHistoricalIdentityEvents200ResponseInnerBetaAccessItemTypeBeta; - /** - * - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'attributeChanges': Array; - /** - * - * @type {AccessRequestResponse1Beta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'accessRequest': AccessRequestResponse1Beta; - /** - * - * @type {AccountStatusChangedAccountBeta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'account': AccountStatusChangedAccountBeta; - /** - * - * @type {AccountStatusChangedStatusChangeBeta} - * @memberof GetHistoricalIdentityEvents200ResponseInnerBeta - */ - 'statusChange': AccountStatusChangedStatusChangeBeta; -} - -export const GetHistoricalIdentityEvents200ResponseInnerBetaAccessItemTypeBeta = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type GetHistoricalIdentityEvents200ResponseInnerBetaAccessItemTypeBeta = typeof GetHistoricalIdentityEvents200ResponseInnerBetaAccessItemTypeBeta[keyof typeof GetHistoricalIdentityEvents200ResponseInnerBetaAccessItemTypeBeta]; - -/** - * - * @export - * @interface GetLaunchers200ResponseBeta - */ -export interface GetLaunchers200ResponseBeta { - /** - * Pagination marker - * @type {string} - * @memberof GetLaunchers200ResponseBeta - */ - 'next'?: string; - /** - * - * @type {Array} - * @memberof GetLaunchers200ResponseBeta - */ - 'items'?: Array; -} -/** - * - * @export - * @interface GetOAuthClientResponseBeta - */ -export interface GetOAuthClientResponseBeta { - /** - * ID of the OAuth client - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'id': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'businessName': string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'homepageUrl': string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseBeta - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseBeta - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof GetOAuthClientResponseBeta - */ - 'redirectUris': Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof GetOAuthClientResponseBeta - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeBeta} - * @memberof GetOAuthClientResponseBeta - */ - 'accessType': AccessTypeBeta; - /** - * - * @type {ClientTypeBeta} - * @memberof GetOAuthClientResponseBeta - */ - 'type': ClientTypeBeta; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof GetOAuthClientResponseBeta - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof GetOAuthClientResponseBeta - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof GetOAuthClientResponseBeta - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof GetOAuthClientResponseBeta - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'modified': string; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'secret'?: string | null; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'metadata'?: string | null; - /** - * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - * @type {string} - * @memberof GetOAuthClientResponseBeta - */ - 'lastUsed'?: string | null; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof GetOAuthClientResponseBeta - */ - 'scope': Array | null; -} - - -/** - * - * @export - * @interface GetPersonalAccessTokenResponseBeta - */ -export interface GetPersonalAccessTokenResponseBeta { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'id': string; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'name': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'scope': Array | null; - /** - * - * @type {PatOwnerBeta} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'owner': PatOwnerBeta; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'created': string; - /** - * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - * @type {string} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'lastUsed'?: string | null; - /** - * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'managed'?: boolean; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'accessTokenValiditySeconds'?: number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof GetPersonalAccessTokenResponseBeta - */ - 'expirationDate'?: string | null; -} -/** - * - * @export - * @interface GetReferenceIdentityAttributeBeta - */ -export interface GetReferenceIdentityAttributeBeta { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GetReferenceIdentityAttributeBeta - */ - 'name': string; - /** - * The operation to perform `getReferenceIdentityAttribute` - * @type {string} - * @memberof GetReferenceIdentityAttributeBeta - */ - 'operation': string; - /** - * This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user\'s manager and then get that manager\'s identity attribute. - * @type {string} - * @memberof GetReferenceIdentityAttributeBeta - */ - 'uid': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GetReferenceIdentityAttributeBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetRoleAssignments200ResponseInnerBeta - */ -export interface GetRoleAssignments200ResponseInnerBeta { - /** - * Assignment Id - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'id'?: string; - /** - * - * @type {BaseRoleReferenceDtoBeta} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'role'?: BaseRoleReferenceDtoBeta; - /** - * Date that the assignment was added - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'removeDate'?: string | null; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerBeta} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'assigner'?: RoleAssignmentDtoAssignerBeta; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextBeta} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextBeta; - /** - * - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerBeta - */ - 'accountTargets'?: Array; -} -/** - * OAuth2 Grant Type - * @export - * @enum {string} - */ - -export const GrantTypeBeta = { - ClientCredentials: 'CLIENT_CREDENTIALS', - AuthorizationCode: 'AUTHORIZATION_CODE', - RefreshToken: 'REFRESH_TOKEN' -} as const; - -export type GrantTypeBeta = typeof GrantTypeBeta[keyof typeof GrantTypeBeta]; - - -/** - * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. - * @export - * @enum {string} - */ - -export const HttpAuthenticationTypeBeta = { - NoAuth: 'NO_AUTH', - BasicAuth: 'BASIC_AUTH', - BearerToken: 'BEARER_TOKEN' -} as const; - -export type HttpAuthenticationTypeBeta = typeof HttpAuthenticationTypeBeta[keyof typeof HttpAuthenticationTypeBeta]; - - -/** - * - * @export - * @interface HttpConfigBeta - */ -export interface HttpConfigBeta { - /** - * URL of the external/custom integration. - * @type {string} - * @memberof HttpConfigBeta - */ - 'url': string; - /** - * - * @type {HttpDispatchModeBeta} - * @memberof HttpConfigBeta - */ - 'httpDispatchMode': HttpDispatchModeBeta; - /** - * - * @type {HttpAuthenticationTypeBeta} - * @memberof HttpConfigBeta - */ - 'httpAuthenticationType'?: HttpAuthenticationTypeBeta; - /** - * - * @type {BasicAuthConfigBeta} - * @memberof HttpConfigBeta - */ - 'basicAuthConfig'?: BasicAuthConfigBeta | null; - /** - * - * @type {BearerTokenAuthConfigBeta} - * @memberof HttpConfigBeta - */ - 'bearerTokenAuthConfig'?: BearerTokenAuthConfigBeta | null; -} - - -/** - * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. - * @export - * @enum {string} - */ - -export const HttpDispatchModeBeta = { - Sync: 'SYNC', - Async: 'ASYNC', - Dynamic: 'DYNAMIC' -} as const; - -export type HttpDispatchModeBeta = typeof HttpDispatchModeBeta[keyof typeof HttpDispatchModeBeta]; - - -/** - * - * @export - * @interface ISO3166Beta - */ -export interface ISO3166Beta { - /** - * An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., \"USA\") `numeric` - The numeric country code (e.g., \"840\") - * @type {string} - * @memberof ISO3166Beta - */ - 'format'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ISO3166Beta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ISO3166Beta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentitiesAccountsBulkRequestBeta - */ -export interface IdentitiesAccountsBulkRequestBeta { - /** - * The ids of the identities for which enable/disable accounts. - * @type {Array} - * @memberof IdentitiesAccountsBulkRequestBeta - */ - 'identityIds'?: Array; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface Identity1Beta - */ -export interface Identity1Beta { - /** - * The ID of the object - * @type {string} - * @memberof Identity1Beta - */ - 'id'?: string; - /** - * Human-readable display name of the object - * @type {string} - * @memberof Identity1Beta - */ - 'name'?: string; -} -/** - * - * @export - * @interface IdentityAssociationDetailsAssociationDetailsInnerBeta - */ -export interface IdentityAssociationDetailsAssociationDetailsInnerBeta { - /** - * association type with the identity - * @type {string} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerBeta - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerBeta - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityAssociationDetailsBeta - */ -export interface IdentityAssociationDetailsBeta { - /** - * any additional context information of the http call result - * @type {string} - * @memberof IdentityAssociationDetailsBeta - */ - 'message'?: string; - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityAssociationDetailsBeta - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityAttribute1Beta - */ -export interface IdentityAttribute1Beta { - /** - * The system (camel-cased) name of the identity attribute to bring in - * @type {string} - * @memberof IdentityAttribute1Beta - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IdentityAttribute1Beta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IdentityAttribute1Beta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentityAttributeBeta - */ -export interface IdentityAttributeBeta { - /** - * Identity attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributeBeta - */ - 'name': string; - /** - * Identity attribute\'s business-friendly name. - * @type {string} - * @memberof IdentityAttributeBeta - */ - 'displayName'?: string; - /** - * Indicates whether the attribute is \'standard\' or \'default\'. - * @type {boolean} - * @memberof IdentityAttributeBeta - */ - 'standard'?: boolean; - /** - * Identity attribute\'s type. - * @type {string} - * @memberof IdentityAttributeBeta - */ - 'type'?: string | null; - /** - * Indicates whether the identity attribute is multi-valued. - * @type {boolean} - * @memberof IdentityAttributeBeta - */ - 'multi'?: boolean; - /** - * Indicates whether the identity attribute is searchable. - * @type {boolean} - * @memberof IdentityAttributeBeta - */ - 'searchable'?: boolean; - /** - * Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. - * @type {boolean} - * @memberof IdentityAttributeBeta - */ - 'system'?: boolean; - /** - * Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. - * @type {Array} - * @memberof IdentityAttributeBeta - */ - 'sources'?: Array; -} -/** - * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - * @export - * @interface IdentityAttributeConfig1Beta - */ -export interface IdentityAttributeConfig1Beta { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfig1Beta - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfig1Beta - */ - 'attributeTransforms'?: Array; -} -/** - * - * @export - * @interface IdentityAttributeConfigBeta - */ -export interface IdentityAttributeConfigBeta { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfigBeta - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfigBeta - */ - 'attributeTransforms'?: Array; -} -/** - * Identity attribute IDs. - * @export - * @interface IdentityAttributeNamesBeta - */ -export interface IdentityAttributeNamesBeta { - /** - * List of identity attributes\' technical names. - * @type {Array} - * @memberof IdentityAttributeNamesBeta - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface IdentityAttributePreviewBeta - */ -export interface IdentityAttributePreviewBeta { - /** - * Name of the attribute that is being previewed. - * @type {string} - * @memberof IdentityAttributePreviewBeta - */ - 'name'?: string; - /** - * Value that was derived during the preview. - * @type {string} - * @memberof IdentityAttributePreviewBeta - */ - 'value'?: string; - /** - * The value of the attribute before the preview. - * @type {string} - * @memberof IdentityAttributePreviewBeta - */ - 'previousValue'?: string; - /** - * - * @type {Array} - * @memberof IdentityAttributePreviewBeta - */ - 'errorMessages'?: Array; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransform1Beta - */ -export interface IdentityAttributeTransform1Beta { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransform1Beta - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinition1Beta} - * @memberof IdentityAttributeTransform1Beta - */ - 'transformDefinition'?: TransformDefinition1Beta; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransformBeta - */ -export interface IdentityAttributeTransformBeta { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransformBeta - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinitionBeta} - * @memberof IdentityAttributeTransformBeta - */ - 'transformDefinition'?: TransformDefinitionBeta; -} -/** - * - * @export - * @interface IdentityAttributesChangedBeta - */ -export interface IdentityAttributesChangedBeta { - /** - * - * @type {IdentityAttributesChangedIdentityBeta} - * @memberof IdentityAttributesChangedBeta - */ - 'identity': IdentityAttributesChangedIdentityBeta; - /** - * List of identity\'s attributes that changed. - * @type {Array} - * @memberof IdentityAttributesChangedBeta - */ - 'changes': Array; -} -/** - * - * @export - * @interface IdentityAttributesChangedChangesInnerBeta - */ -export interface IdentityAttributesChangedChangesInnerBeta { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributesChangedChangesInnerBeta - */ - 'attribute': string; - /** - * - * @type {IdentityAttributesChangedChangesInnerOldValueBeta} - * @memberof IdentityAttributesChangedChangesInnerBeta - */ - 'oldValue'?: IdentityAttributesChangedChangesInnerOldValueBeta | null; - /** - * - * @type {IdentityAttributesChangedChangesInnerNewValueBeta} - * @memberof IdentityAttributesChangedChangesInnerBeta - */ - 'newValue'?: IdentityAttributesChangedChangesInnerNewValueBeta; -} -/** - * @type IdentityAttributesChangedChangesInnerNewValueBeta - * Identity attribute\'s new value after the change. - * @export - */ -export type IdentityAttributesChangedChangesInnerNewValueBeta = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueBeta; }; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueBeta - * Identity attribute\'s previous value before the change. - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueBeta = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueBeta; }; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueOneOfValueBeta - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueOneOfValueBeta = boolean | number | string; - -/** - * Identity whose attributes changed. - * @export - * @interface IdentityAttributesChangedIdentityBeta - */ -export interface IdentityAttributesChangedIdentityBeta { - /** - * DTO type of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityBeta - */ - 'type': IdentityAttributesChangedIdentityBetaTypeBeta; - /** - * ID of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityBeta - */ - 'id': string; - /** - * Name of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityBeta - */ - 'name': string; -} - -export const IdentityAttributesChangedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityAttributesChangedIdentityBetaTypeBeta = typeof IdentityAttributesChangedIdentityBetaTypeBeta[keyof typeof IdentityAttributesChangedIdentityBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityBeta - */ -export interface IdentityBeta { - /** - * System-generated unique ID of the identity - * @type {string} - * @memberof IdentityBeta - */ - 'id'?: string; - /** - * The identity\'s name is equivalent to its Display Name attribute. - * @type {string} - * @memberof IdentityBeta - */ - 'name': string; - /** - * Creation date of the identity - * @type {string} - * @memberof IdentityBeta - */ - 'created'?: string; - /** - * Last modification date of the identity - * @type {string} - * @memberof IdentityBeta - */ - 'modified'?: string; - /** - * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. - * @type {string} - * @memberof IdentityBeta - */ - 'alias'?: string; - /** - * The email address of the identity - * @type {string} - * @memberof IdentityBeta - */ - 'emailAddress'?: string | null; - /** - * The processing state of the identity - * @type {string} - * @memberof IdentityBeta - */ - 'processingState'?: IdentityBetaProcessingStateBeta | null; - /** - * The identity\'s status in the system - * @type {string} - * @memberof IdentityBeta - */ - 'identityStatus'?: IdentityBetaIdentityStatusBeta; - /** - * - * @type {IdentityManagerRefBeta} - * @memberof IdentityBeta - */ - 'managerRef'?: IdentityManagerRefBeta | null; - /** - * Whether this identity is a manager of another identity - * @type {boolean} - * @memberof IdentityBeta - */ - 'isManager'?: boolean; - /** - * The last time the identity was refreshed by the system - * @type {string} - * @memberof IdentityBeta - */ - 'lastRefresh'?: string; - /** - * A map with the identity attributes for the identity - * @type {object} - * @memberof IdentityBeta - */ - 'attributes'?: object; - /** - * - * @type {IdentityLifecycleStateBeta} - * @memberof IdentityBeta - */ - 'lifecycleState'?: IdentityLifecycleStateBeta; -} - -export const IdentityBetaProcessingStateBeta = { - Error: 'ERROR', - Ok: 'OK' -} as const; - -export type IdentityBetaProcessingStateBeta = typeof IdentityBetaProcessingStateBeta[keyof typeof IdentityBetaProcessingStateBeta]; -export const IdentityBetaIdentityStatusBeta = { - Unregistered: 'UNREGISTERED', - Registered: 'REGISTERED', - Pending: 'PENDING', - Warning: 'WARNING', - Disabled: 'DISABLED', - Active: 'ACTIVE', - Deactivated: 'DEACTIVATED', - Terminated: 'TERMINATED', - Error: 'ERROR', - Locked: 'LOCKED' -} as const; - -export type IdentityBetaIdentityStatusBeta = typeof IdentityBetaIdentityStatusBeta[keyof typeof IdentityBetaIdentityStatusBeta]; - -/** - * - * @export - * @interface IdentityCertificationTaskBeta - */ -export interface IdentityCertificationTaskBeta { - /** - * The task id - * @type {string} - * @memberof IdentityCertificationTaskBeta - */ - 'id'?: string; - /** - * The certification id - * @type {string} - * @memberof IdentityCertificationTaskBeta - */ - 'certificationId'?: string; - /** - * - * @type {string} - * @memberof IdentityCertificationTaskBeta - */ - 'type'?: IdentityCertificationTaskBetaTypeBeta; - /** - * - * @type {string} - * @memberof IdentityCertificationTaskBeta - */ - 'status'?: IdentityCertificationTaskBetaStatusBeta; - /** - * Any errors executing the task (Optional). - * @type {Array} - * @memberof IdentityCertificationTaskBeta - */ - 'errors'?: Array; -} - -export const IdentityCertificationTaskBetaTypeBeta = { - Reassign: 'REASSIGN' -} as const; - -export type IdentityCertificationTaskBetaTypeBeta = typeof IdentityCertificationTaskBetaTypeBeta[keyof typeof IdentityCertificationTaskBetaTypeBeta]; -export const IdentityCertificationTaskBetaStatusBeta = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type IdentityCertificationTaskBetaStatusBeta = typeof IdentityCertificationTaskBetaStatusBeta[keyof typeof IdentityCertificationTaskBetaStatusBeta]; - -/** - * - * @export - * @interface IdentityCertifiedBeta - */ -export interface IdentityCertifiedBeta { - /** - * the id of the certification item - * @type {string} - * @memberof IdentityCertifiedBeta - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof IdentityCertifiedBeta - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof IdentityCertifiedBeta - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof IdentityCertifiedBeta - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof IdentityCertifiedBeta - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseBeta} - * @memberof IdentityCertifiedBeta - */ - 'signer'?: CertifierResponseBeta; - /** - * the event type - * @type {string} - * @memberof IdentityCertifiedBeta - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof IdentityCertifiedBeta - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface IdentityCompareResponseBeta - */ -export interface IdentityCompareResponseBeta { - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: object; }} - * @memberof IdentityCompareResponseBeta - */ - 'accessItemDiff'?: { [key: string]: object; }; -} -/** - * - * @export - * @interface IdentityCreatedBeta - */ -export interface IdentityCreatedBeta { - /** - * - * @type {IdentityCreatedIdentityBeta} - * @memberof IdentityCreatedBeta - */ - 'identity': IdentityCreatedIdentityBeta; - /** - * Attributes assigned to the identity. These attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityCreatedBeta - */ - 'attributes': { [key: string]: any; }; -} -/** - * Created identity. - * @export - * @interface IdentityCreatedIdentityBeta - */ -export interface IdentityCreatedIdentityBeta { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof IdentityCreatedIdentityBeta - */ - 'type': IdentityCreatedIdentityBetaTypeBeta; - /** - * Identity\'s unique ID. - * @type {string} - * @memberof IdentityCreatedIdentityBeta - */ - 'id': string; - /** - * Identity\'s name. - * @type {string} - * @memberof IdentityCreatedIdentityBeta - */ - 'name': string; -} - -export const IdentityCreatedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityCreatedIdentityBetaTypeBeta = typeof IdentityCreatedIdentityBetaTypeBeta[keyof typeof IdentityCreatedIdentityBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityDeletedBeta - */ -export interface IdentityDeletedBeta { - /** - * - * @type {IdentityDeletedIdentityBeta} - * @memberof IdentityDeletedBeta - */ - 'identity': IdentityDeletedIdentityBeta; - /** - * Identity attributes. The attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityDeletedBeta - */ - 'attributes': { [key: string]: any; }; -} -/** - * Deleted identity. - * @export - * @interface IdentityDeletedIdentityBeta - */ -export interface IdentityDeletedIdentityBeta { - /** - * Deleted identity\'s DTO type. - * @type {string} - * @memberof IdentityDeletedIdentityBeta - */ - 'type': IdentityDeletedIdentityBetaTypeBeta; - /** - * Deleted identity ID. - * @type {string} - * @memberof IdentityDeletedIdentityBeta - */ - 'id': string; - /** - * Deleted identity\'s name. - * @type {string} - * @memberof IdentityDeletedIdentityBeta - */ - 'name': string; -} - -export const IdentityDeletedIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityDeletedIdentityBetaTypeBeta = typeof IdentityDeletedIdentityBetaTypeBeta[keyof typeof IdentityDeletedIdentityBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityEntitiesBeta - */ -export interface IdentityEntitiesBeta { - /** - * - * @type {IdentityEntitiesIdentityEntityBeta} - * @memberof IdentityEntitiesBeta - */ - 'identityEntity'?: IdentityEntitiesIdentityEntityBeta; -} -/** - * - * @export - * @interface IdentityEntitiesIdentityEntityBeta - */ -export interface IdentityEntitiesIdentityEntityBeta { - /** - * id of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityBeta - */ - 'id'?: string; - /** - * name of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityBeta - */ - 'name'?: string; - /** - * type of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityBeta - */ - 'type'?: string; -} -/** - * - * @export - * @interface IdentityExceptionReportReference1Beta - */ -export interface IdentityExceptionReportReference1Beta { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReference1Beta - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReference1Beta - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityExceptionReportReferenceBeta - */ -export interface IdentityExceptionReportReferenceBeta { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReferenceBeta - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReferenceBeta - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityHistoryResponseBeta - */ -export interface IdentityHistoryResponseBeta { - /** - * the identity ID - * @type {string} - * @memberof IdentityHistoryResponseBeta - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityHistoryResponseBeta - */ - 'displayName'?: string; - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentityHistoryResponseBeta - */ - 'snapshot'?: string; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityHistoryResponseBeta - */ - 'deletedDate'?: string; - /** - * A map containing the count of each access item - * @type {{ [key: string]: number; }} - * @memberof IdentityHistoryResponseBeta - */ - 'accessItemCount'?: { [key: string]: number; }; - /** - * A map containing the identity attributes - * @type {{ [key: string]: any; }} - * @memberof IdentityHistoryResponseBeta - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentityLifecycleStateBeta - */ -export interface IdentityLifecycleStateBeta { - /** - * The name of the lifecycle state - * @type {string} - * @memberof IdentityLifecycleStateBeta - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof IdentityLifecycleStateBeta - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface IdentityListItemBeta - */ -export interface IdentityListItemBeta { - /** - * the identity ID - * @type {string} - * @memberof IdentityListItemBeta - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityListItemBeta - */ - 'displayName'?: string; - /** - * the first name of the identity - * @type {string} - * @memberof IdentityListItemBeta - */ - 'firstName'?: string | null; - /** - * the last name of the identity - * @type {string} - * @memberof IdentityListItemBeta - */ - 'lastName'?: string | null; - /** - * indicates if an identity is active or not - * @type {boolean} - * @memberof IdentityListItemBeta - */ - 'active'?: boolean; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityListItemBeta - */ - 'deletedDate'?: string | null; -} -/** - * Identity\'s manager - * @export - * @interface IdentityManagerRefBeta - */ -export interface IdentityManagerRefBeta { - /** - * DTO type of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefBeta - */ - 'type'?: IdentityManagerRefBetaTypeBeta; - /** - * ID of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefBeta - */ - 'name'?: string; -} - -export const IdentityManagerRefBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityManagerRefBetaTypeBeta = typeof IdentityManagerRefBetaTypeBeta[keyof typeof IdentityManagerRefBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerBeta - */ -export interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerBeta { - /** - * association type with the identity - * @type {string} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerBeta - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerBeta - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsBeta - */ -export interface IdentityOwnershipAssociationDetailsBeta { - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsBeta - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityPreviewRequestBeta - */ -export interface IdentityPreviewRequestBeta { - /** - * - * @type {string} - * @memberof IdentityPreviewRequestBeta - */ - 'identityId'?: string; - /** - * - * @type {IdentityAttributeConfigBeta} - * @memberof IdentityPreviewRequestBeta - */ - 'identityAttributeConfig'?: IdentityAttributeConfigBeta; -} -/** - * - * @export - * @interface IdentityPreviewResponseBeta - */ -export interface IdentityPreviewResponseBeta { - /** - * - * @type {IdentityPreviewResponseIdentityBeta} - * @memberof IdentityPreviewResponseBeta - */ - 'identity'?: IdentityPreviewResponseIdentityBeta; - /** - * - * @type {Array} - * @memberof IdentityPreviewResponseBeta - */ - 'previewAttributes'?: Array; -} -/** - * Identity\'s manager. - * @export - * @interface IdentityPreviewResponseIdentityBeta - */ -export interface IdentityPreviewResponseIdentityBeta { - /** - * DTO type of identity\'s manager. - * @type {string} - * @memberof IdentityPreviewResponseIdentityBeta - */ - 'type'?: IdentityPreviewResponseIdentityBetaTypeBeta; - /** - * ID of identity\'s manager. - * @type {string} - * @memberof IdentityPreviewResponseIdentityBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity\'s manager. - * @type {string} - * @memberof IdentityPreviewResponseIdentityBeta - */ - 'name'?: string; -} - -export const IdentityPreviewResponseIdentityBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityPreviewResponseIdentityBetaTypeBeta = typeof IdentityPreviewResponseIdentityBetaTypeBeta[keyof typeof IdentityPreviewResponseIdentityBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityProfile1AllOfAuthoritativeSourceBeta - */ -export interface IdentityProfile1AllOfAuthoritativeSourceBeta { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfile1AllOfAuthoritativeSourceBeta - */ - 'type'?: IdentityProfile1AllOfAuthoritativeSourceBetaTypeBeta; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfile1AllOfAuthoritativeSourceBeta - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfile1AllOfAuthoritativeSourceBeta - */ - 'name'?: string; -} - -export const IdentityProfile1AllOfAuthoritativeSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type IdentityProfile1AllOfAuthoritativeSourceBetaTypeBeta = typeof IdentityProfile1AllOfAuthoritativeSourceBetaTypeBeta[keyof typeof IdentityProfile1AllOfAuthoritativeSourceBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityProfile1Beta - */ -export interface IdentityProfile1Beta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfile1Beta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfile1Beta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfile1Beta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfile1Beta - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfile1Beta - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwnerBeta} - * @memberof IdentityProfile1Beta - */ - 'owner'?: IdentityProfileAllOfOwnerBeta | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfile1Beta - */ - 'priority'?: number; - /** - * - * @type {IdentityProfile1AllOfAuthoritativeSourceBeta} - * @memberof IdentityProfile1Beta - */ - 'authoritativeSource': IdentityProfile1AllOfAuthoritativeSourceBeta; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfile1Beta - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfile1Beta - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfig1Beta} - * @memberof IdentityProfile1Beta - */ - 'identityAttributeConfig'?: IdentityAttributeConfig1Beta; - /** - * - * @type {IdentityExceptionReportReference1Beta} - * @memberof IdentityProfile1Beta - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReference1Beta | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfile1Beta - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * Identity profile\'s authoritative source. - * @export - * @interface IdentityProfileAllOfAuthoritativeSourceBeta - */ -export interface IdentityProfileAllOfAuthoritativeSourceBeta { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceBeta - */ - 'type'?: IdentityProfileAllOfAuthoritativeSourceBetaTypeBeta; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceBeta - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceBeta - */ - 'name'?: string; -} - -export const IdentityProfileAllOfAuthoritativeSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type IdentityProfileAllOfAuthoritativeSourceBetaTypeBeta = typeof IdentityProfileAllOfAuthoritativeSourceBetaTypeBeta[keyof typeof IdentityProfileAllOfAuthoritativeSourceBetaTypeBeta]; - -/** - * Identity profile\'s owner. - * @export - * @interface IdentityProfileAllOfOwnerBeta - */ -export interface IdentityProfileAllOfOwnerBeta { - /** - * Owner\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfOwnerBeta - */ - 'type'?: IdentityProfileAllOfOwnerBetaTypeBeta; - /** - * Owner\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfOwnerBeta - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof IdentityProfileAllOfOwnerBeta - */ - 'name'?: string; -} - -export const IdentityProfileAllOfOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type IdentityProfileAllOfOwnerBetaTypeBeta = typeof IdentityProfileAllOfOwnerBetaTypeBeta[keyof typeof IdentityProfileAllOfOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface IdentityProfileBeta - */ -export interface IdentityProfileBeta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfileBeta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfileBeta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfileBeta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfileBeta - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfileBeta - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwnerBeta} - * @memberof IdentityProfileBeta - */ - 'owner'?: IdentityProfileAllOfOwnerBeta | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfileBeta - */ - 'priority'?: number; - /** - * - * @type {IdentityProfileAllOfAuthoritativeSourceBeta} - * @memberof IdentityProfileBeta - */ - 'authoritativeSource': IdentityProfileAllOfAuthoritativeSourceBeta; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfileBeta - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfileBeta - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfigBeta} - * @memberof IdentityProfileBeta - */ - 'identityAttributeConfig'?: IdentityAttributeConfigBeta; - /** - * - * @type {IdentityExceptionReportReferenceBeta} - * @memberof IdentityProfileBeta - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReferenceBeta | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfileBeta - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * Identity Profile exported object - * @export - * @interface IdentityProfileExportedObjectBeta - */ -export interface IdentityProfileExportedObjectBeta { - /** - * Version or object from the target service. - * @type {number} - * @memberof IdentityProfileExportedObjectBeta - */ - 'version'?: number; - /** - * - * @type {SelfImportExportDtoBeta} - * @memberof IdentityProfileExportedObjectBeta - */ - 'self'?: SelfImportExportDtoBeta; - /** - * - * @type {IdentityProfile1Beta} - * @memberof IdentityProfileExportedObjectBeta - */ - 'object'?: IdentityProfile1Beta; -} -/** - * The manager for the identity. - * @export - * @interface IdentityReferenceBeta - */ -export interface IdentityReferenceBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof IdentityReferenceBeta - */ - 'type'?: DtoTypeBeta; - /** - * Identity id - * @type {string} - * @memberof IdentityReferenceBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof IdentityReferenceBeta - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithIdBeta - */ -export interface IdentityReferenceWithIdBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof IdentityReferenceWithIdBeta - */ - 'type'?: DtoTypeBeta; - /** - * Identity id - * @type {string} - * @memberof IdentityReferenceWithIdBeta - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithNameAndEmailBeta - */ -export interface IdentityReferenceWithNameAndEmailBeta { - /** - * The type can only be IDENTITY. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailBeta - */ - 'type'?: string; - /** - * Identity ID. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailBeta - */ - 'id'?: string; - /** - * Identity\'s human-readable display name. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailBeta - */ - 'name'?: string; - /** - * Identity\'s email address. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailBeta - */ - 'email'?: string; -} -/** - * - * @export - * @interface IdentitySnapshotSummaryResponseBeta - */ -export interface IdentitySnapshotSummaryResponseBeta { - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentitySnapshotSummaryResponseBeta - */ - 'snapshot'?: string; -} -/** - * - * @export - * @interface IdentitySummaryBeta - */ -export interface IdentitySummaryBeta { - /** - * ID of this identity summary - * @type {string} - * @memberof IdentitySummaryBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity - * @type {string} - * @memberof IdentitySummaryBeta - */ - 'name'?: string; - /** - * ID of the identity that this summary represents - * @type {string} - * @memberof IdentitySummaryBeta - */ - 'identityId'?: string; - /** - * Indicates if all access items for this summary have been decided on - * @type {boolean} - * @memberof IdentitySummaryBeta - */ - 'completed'?: boolean; -} -/** - * - * @export - * @interface IdentitySyncJobBeta - */ -export interface IdentitySyncJobBeta { - /** - * Job ID. - * @type {string} - * @memberof IdentitySyncJobBeta - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof IdentitySyncJobBeta - */ - 'status': IdentitySyncJobBetaStatusBeta; - /** - * - * @type {IdentitySyncPayloadBeta} - * @memberof IdentitySyncJobBeta - */ - 'payload': IdentitySyncPayloadBeta; -} - -export const IdentitySyncJobBetaStatusBeta = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type IdentitySyncJobBetaStatusBeta = typeof IdentitySyncJobBetaStatusBeta[keyof typeof IdentitySyncJobBetaStatusBeta]; - -/** - * - * @export - * @interface IdentitySyncPayloadBeta - */ -export interface IdentitySyncPayloadBeta { - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadBeta - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadBeta - */ - 'dataJson': string; -} -/** - * Entitlement including a specific set of access. - * @export - * @interface IdentityWithNewAccessAccessRefsInnerBeta - */ -export interface IdentityWithNewAccessAccessRefsInnerBeta { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerBeta - */ - 'type'?: IdentityWithNewAccessAccessRefsInnerBetaTypeBeta; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerBeta - */ - 'id'?: string; -} - -export const IdentityWithNewAccessAccessRefsInnerBetaTypeBeta = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type IdentityWithNewAccessAccessRefsInnerBetaTypeBeta = typeof IdentityWithNewAccessAccessRefsInnerBetaTypeBeta[keyof typeof IdentityWithNewAccessAccessRefsInnerBetaTypeBeta]; - -/** - * An identity with a set of access to be added - * @export - * @interface IdentityWithNewAccessBeta - */ -export interface IdentityWithNewAccessBeta { - /** - * Identity id to be checked. - * @type {string} - * @memberof IdentityWithNewAccessBeta - */ - 'identityId': string; - /** - * The list of entitlements to consider for possible violations in a preventive check. - * @type {Array} - * @memberof IdentityWithNewAccessBeta - */ - 'accessRefs': Array; -} -/** - * This content type is provided for compatibility with services that don\'t support multipart/form-data, such as SailPoint Workflows. This content type does not support files, so it can only be used for direct connect sources. - * @export - * @interface ImportAccountsRequest1Beta - */ -export interface ImportAccountsRequest1Beta { - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof ImportAccountsRequest1Beta - */ - 'disableOptimization'?: ImportAccountsRequest1BetaDisableOptimizationBeta; -} - -export const ImportAccountsRequest1BetaDisableOptimizationBeta = { - True: 'true', - False: 'false' -} as const; - -export type ImportAccountsRequest1BetaDisableOptimizationBeta = typeof ImportAccountsRequest1BetaDisableOptimizationBeta[keyof typeof ImportAccountsRequest1BetaDisableOptimizationBeta]; - -/** - * - * @export - * @interface ImportAccountsRequestBeta - */ -export interface ImportAccountsRequestBeta { - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof ImportAccountsRequestBeta - */ - 'file'?: File; - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof ImportAccountsRequestBeta - */ - 'disableOptimization'?: ImportAccountsRequestBetaDisableOptimizationBeta; -} - -export const ImportAccountsRequestBetaDisableOptimizationBeta = { - True: 'true', - False: 'false' -} as const; - -export type ImportAccountsRequestBetaDisableOptimizationBeta = typeof ImportAccountsRequestBetaDisableOptimizationBeta[keyof typeof ImportAccountsRequestBetaDisableOptimizationBeta]; - -/** - * - * @export - * @interface ImportEntitlementsBySourceRequestBeta - */ -export interface ImportEntitlementsBySourceRequestBeta { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsBySourceRequestBeta - */ - 'csvFile'?: File; -} -/** - * - * @export - * @interface ImportEntitlementsRequestBeta - */ -export interface ImportEntitlementsRequestBeta { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsRequestBeta - */ - 'file'?: File; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseBeta - */ -export interface ImportFormDefinitions202ResponseBeta { - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseBeta - */ - 'errors'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseBeta - */ - 'importedObjects'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseBeta - */ - 'infos'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseBeta - */ - 'warnings'?: Array; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseErrorsInnerBeta - */ -export interface ImportFormDefinitions202ResponseErrorsInnerBeta { - /** - * - * @type {{ [key: string]: object; }} - * @memberof ImportFormDefinitions202ResponseErrorsInnerBeta - */ - 'detail'?: { [key: string]: object; }; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerBeta - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerBeta - */ - 'text'?: string; -} -/** - * - * @export - * @interface ImportFormDefinitionsRequestInnerBeta - */ -export interface ImportFormDefinitionsRequestInnerBeta { - /** - * - * @type {FormDefinitionResponseBeta} - * @memberof ImportFormDefinitionsRequestInnerBeta - */ - 'object'?: FormDefinitionResponseBeta; - /** - * - * @type {string} - * @memberof ImportFormDefinitionsRequestInnerBeta - */ - 'self'?: string; - /** - * - * @type {number} - * @memberof ImportFormDefinitionsRequestInnerBeta - */ - 'version'?: number; -} -/** - * - * @export - * @interface ImportNonEmployeeRecordsInBulkRequestBeta - */ -export interface ImportNonEmployeeRecordsInBulkRequestBeta { - /** - * - * @type {File} - * @memberof ImportNonEmployeeRecordsInBulkRequestBeta - */ - 'data': File; -} -/** - * Object created or updated by import. - * @export - * @interface ImportObjectBeta - */ -export interface ImportObjectBeta { - /** - * DTO type of object created or updated by import. - * @type {string} - * @memberof ImportObjectBeta - */ - 'type'?: ImportObjectBetaTypeBeta; - /** - * ID of object created or updated by import. - * @type {string} - * @memberof ImportObjectBeta - */ - 'id'?: string; - /** - * Display name of object created or updated by import. - * @type {string} - * @memberof ImportObjectBeta - */ - 'name'?: string; -} - -export const ImportObjectBetaTypeBeta = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportObjectBetaTypeBeta = typeof ImportObjectBetaTypeBeta[keyof typeof ImportObjectBetaTypeBeta]; - -/** - * - * @export - * @interface ImportOptionsBeta - */ -export interface ImportOptionsBeta { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ImportOptionsBeta - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ImportOptionsBeta - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsBeta; }} - * @memberof ImportOptionsBeta - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsBeta; }; - /** - * List of object types that can be used to resolve references on import. - * @type {Array} - * @memberof ImportOptionsBeta - */ - 'defaultReferences'?: Array; - /** - * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. - * @type {boolean} - * @memberof ImportOptionsBeta - */ - 'excludeBackup'?: boolean; -} - -export const ImportOptionsBetaExcludeTypesBeta = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsBetaExcludeTypesBeta = typeof ImportOptionsBetaExcludeTypesBeta[keyof typeof ImportOptionsBetaExcludeTypesBeta]; -export const ImportOptionsBetaIncludeTypesBeta = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsBetaIncludeTypesBeta = typeof ImportOptionsBetaIncludeTypesBeta[keyof typeof ImportOptionsBetaIncludeTypesBeta]; -export const ImportOptionsBetaDefaultReferencesBeta = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsBetaDefaultReferencesBeta = typeof ImportOptionsBetaDefaultReferencesBeta[keyof typeof ImportOptionsBetaDefaultReferencesBeta]; - -/** - * - * @export - * @interface ImportSpConfigRequestBeta - */ -export interface ImportSpConfigRequestBeta { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ImportSpConfigRequestBeta - */ - 'data': File; - /** - * - * @type {ImportOptionsBeta} - * @memberof ImportSpConfigRequestBeta - */ - 'options'?: ImportOptionsBeta; -} -/** - * - * @export - * @interface IndexOfBeta - */ -export interface IndexOfBeta { - /** - * A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - * @type {string} - * @memberof IndexOfBeta - */ - 'substring': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IndexOfBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IndexOfBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface InviteIdentitiesRequestBeta - */ -export interface InviteIdentitiesRequestBeta { - /** - * The list of Identities IDs to invite - required when \'uninvited\' is false - * @type {Array} - * @memberof InviteIdentitiesRequestBeta - */ - 'ids'?: Array | null; - /** - * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. - * @type {boolean} - * @memberof InviteIdentitiesRequestBeta - */ - 'uninvited'?: boolean; -} -/** - * - * @export - * @interface InvocationBeta - */ -export interface InvocationBeta { - /** - * Invocation ID - * @type {string} - * @memberof InvocationBeta - */ - 'id'?: string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationBeta - */ - 'triggerId'?: string; - /** - * Unique invocation secret. - * @type {string} - * @memberof InvocationBeta - */ - 'secret'?: string; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof InvocationBeta - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface InvocationStatusBeta - */ -export interface InvocationStatusBeta { - /** - * Invocation ID - * @type {string} - * @memberof InvocationStatusBeta - */ - 'id': string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationStatusBeta - */ - 'triggerId': string; - /** - * Subscription name - * @type {string} - * @memberof InvocationStatusBeta - */ - 'subscriptionName': string; - /** - * Subscription ID - * @type {string} - * @memberof InvocationStatusBeta - */ - 'subscriptionId': string; - /** - * - * @type {InvocationStatusTypeBeta} - * @memberof InvocationStatusBeta - */ - 'type': InvocationStatusTypeBeta; - /** - * Invocation created timestamp. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusBeta - */ - 'created': string; - /** - * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusBeta - */ - 'completed'?: string; - /** - * - * @type {StartInvocationInputBeta} - * @memberof InvocationStatusBeta - */ - 'startInvocationInput': StartInvocationInputBeta; - /** - * - * @type {CompleteInvocationInputBeta} - * @memberof InvocationStatusBeta - */ - 'completeInvocationInput'?: CompleteInvocationInputBeta; -} - - -/** - * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. - * @export - * @enum {string} - */ - -export const InvocationStatusTypeBeta = { - Test: 'TEST', - RealTime: 'REAL_TIME' -} as const; - -export type InvocationStatusTypeBeta = typeof InvocationStatusTypeBeta[keyof typeof InvocationStatusTypeBeta]; - - -/** - * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchBeta - */ -export interface JsonPatchBeta { - /** - * Operations to be applied - * @type {Array} - * @memberof JsonPatchBeta - */ - 'operations'?: Array; -} -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationBeta - */ -export interface JsonPatchOperationBeta { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationBeta - */ - 'op': JsonPatchOperationBetaOpBeta; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationBeta - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueBeta} - * @memberof JsonPatchOperationBeta - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueBeta; -} - -export const JsonPatchOperationBetaOpBeta = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type JsonPatchOperationBetaOpBeta = typeof JsonPatchOperationBetaOpBeta[keyof typeof JsonPatchOperationBetaOpBeta]; - -/** - * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationRoleMiningBeta - */ -export interface JsonPatchOperationRoleMiningBeta { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationRoleMiningBeta - */ - 'op': JsonPatchOperationRoleMiningBetaOpBeta; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationRoleMiningBeta - */ - 'path': string; - /** - * - * @type {JsonPatchOperationRoleMiningValueBeta} - * @memberof JsonPatchOperationRoleMiningBeta - */ - 'value'?: JsonPatchOperationRoleMiningValueBeta; -} - -export const JsonPatchOperationRoleMiningBetaOpBeta = { - Remove: 'remove', - Replace: 'replace' -} as const; - -export type JsonPatchOperationRoleMiningBetaOpBeta = typeof JsonPatchOperationRoleMiningBetaOpBeta[keyof typeof JsonPatchOperationRoleMiningBetaOpBeta]; - -/** - * @type JsonPatchOperationRoleMiningValueBeta - * The value to be used for the operation, required for \"replace\" operations - * @export - */ -export type JsonPatchOperationRoleMiningValueBeta = Array | boolean | number | object | string; - -/** - * A limited JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationsBeta - */ -export interface JsonPatchOperationsBeta { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationsBeta - */ - 'op': JsonPatchOperationsBetaOpBeta; - /** - * A string representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationsBeta - */ - 'path': string; - /** - * - * @type {JsonPatchOperationsValueBeta} - * @memberof JsonPatchOperationsBeta - */ - 'value'?: JsonPatchOperationsValueBeta; -} - -export const JsonPatchOperationsBetaOpBeta = { - Add: 'add', - Remove: 'remove', - Replace: 'replace' -} as const; - -export type JsonPatchOperationsBetaOpBeta = typeof JsonPatchOperationsBetaOpBeta[keyof typeof JsonPatchOperationsBetaOpBeta]; - -/** - * @type JsonPatchOperationsValueBeta - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - */ -export type JsonPatchOperationsValueBeta = Array | boolean | string; - -/** - * - * @export - * @interface KbaAnswerRequestItemBeta - */ -export interface KbaAnswerRequestItemBeta { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerRequestItemBeta - */ - 'id': string; - /** - * An answer for the KBA question - * @type {string} - * @memberof KbaAnswerRequestItemBeta - */ - 'answer': string; -} -/** - * - * @export - * @interface KbaAnswerResponseItemBeta - */ -export interface KbaAnswerResponseItemBeta { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerResponseItemBeta - */ - 'id': string; - /** - * Question description - * @type {string} - * @memberof KbaAnswerResponseItemBeta - */ - 'question': string; - /** - * Denotes whether the KBA question has an answer configured for the current user - * @type {boolean} - * @memberof KbaAnswerResponseItemBeta - */ - 'hasAnswer': boolean; -} -/** - * - * @export - * @interface KbaAuthResponseBeta - */ -export interface KbaAuthResponseBeta { - /** - * - * @type {Array} - * @memberof KbaAuthResponseBeta - */ - 'kbaAuthResponseItems'?: Array; - /** - * MFA Authentication status - * @type {string} - * @memberof KbaAuthResponseBeta - */ - 'status'?: KbaAuthResponseBetaStatusBeta; -} - -export const KbaAuthResponseBetaStatusBeta = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type KbaAuthResponseBetaStatusBeta = typeof KbaAuthResponseBetaStatusBeta[keyof typeof KbaAuthResponseBetaStatusBeta]; - -/** - * - * @export - * @interface KbaAuthResponseItemBeta - */ -export interface KbaAuthResponseItemBeta { - /** - * The KBA question id - * @type {string} - * @memberof KbaAuthResponseItemBeta - */ - 'questionId'?: string | null; - /** - * Return true if verified - * @type {boolean} - * @memberof KbaAuthResponseItemBeta - */ - 'isVerified'?: boolean | null; -} -/** - * KBA Configuration - * @export - * @interface KbaQuestionBeta - */ -export interface KbaQuestionBeta { - /** - * KBA Question Id - * @type {string} - * @memberof KbaQuestionBeta - */ - 'id': string; - /** - * KBA Question description - * @type {string} - * @memberof KbaQuestionBeta - */ - 'text': string; - /** - * Denotes whether the KBA question has an answer configured for any user in the tenant - * @type {boolean} - * @memberof KbaQuestionBeta - */ - 'hasAnswer': boolean; - /** - * Denotes the number of KBA configurations for this question - * @type {number} - * @memberof KbaQuestionBeta - */ - 'numAnswers': number; -} -/** - * - * @export - * @interface LatestOutlierSummaryBeta - */ -export interface LatestOutlierSummaryBeta { - /** - * The type of outlier summary - * @type {string} - * @memberof LatestOutlierSummaryBeta - */ - 'type'?: LatestOutlierSummaryBetaTypeBeta; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof LatestOutlierSummaryBeta - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryBeta - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryBeta - */ - 'totalIdentities'?: number; - /** - * Total number of ignored outliers - * @type {number} - * @memberof LatestOutlierSummaryBeta - */ - 'totalIgnored'?: number; -} - -export const LatestOutlierSummaryBetaTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type LatestOutlierSummaryBetaTypeBeta = typeof LatestOutlierSummaryBetaTypeBeta[keyof typeof LatestOutlierSummaryBetaTypeBeta]; - -/** - * - * @export - * @interface LauncherBeta - */ -export interface LauncherBeta { - /** - * ID of the Launcher - * @type {string} - * @memberof LauncherBeta - */ - 'id': string; - /** - * Date the Launcher was created - * @type {string} - * @memberof LauncherBeta - */ - 'created': string; - /** - * Date the Launcher was last modified - * @type {string} - * @memberof LauncherBeta - */ - 'modified': string; - /** - * - * @type {LauncherOwnerBeta} - * @memberof LauncherBeta - */ - 'owner': LauncherOwnerBeta; - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherBeta - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherBeta - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherBeta - */ - 'type': LauncherBetaTypeBeta; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherBeta - */ - 'disabled': boolean; - /** - * - * @type {LauncherReferenceBeta} - * @memberof LauncherBeta - */ - 'reference'?: LauncherReferenceBeta; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherBeta - */ - 'config': string; -} - -export const LauncherBetaTypeBeta = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherBetaTypeBeta = typeof LauncherBetaTypeBeta[keyof typeof LauncherBetaTypeBeta]; - -/** - * Owner of the Launcher - * @export - * @interface LauncherOwnerBeta - */ -export interface LauncherOwnerBeta { - /** - * Owner type - * @type {string} - * @memberof LauncherOwnerBeta - */ - 'type': string; - /** - * Owner ID - * @type {string} - * @memberof LauncherOwnerBeta - */ - 'id': string; -} -/** - * - * @export - * @interface LauncherReferenceBeta - */ -export interface LauncherReferenceBeta { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherReferenceBeta - */ - 'type'?: LauncherReferenceBetaTypeBeta; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherReferenceBeta - */ - 'id'?: string; -} - -export const LauncherReferenceBetaTypeBeta = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherReferenceBetaTypeBeta = typeof LauncherReferenceBetaTypeBeta[keyof typeof LauncherReferenceBetaTypeBeta]; - -/** - * - * @export - * @interface LauncherRequestBeta - */ -export interface LauncherRequestBeta { - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherRequestBeta - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherRequestBeta - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherRequestBeta - */ - 'type': LauncherRequestBetaTypeBeta; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherRequestBeta - */ - 'disabled': boolean; - /** - * - * @type {LauncherRequestReferenceBeta} - * @memberof LauncherRequestBeta - */ - 'reference'?: LauncherRequestReferenceBeta; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherRequestBeta - */ - 'config': string; -} - -export const LauncherRequestBetaTypeBeta = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherRequestBetaTypeBeta = typeof LauncherRequestBetaTypeBeta[keyof typeof LauncherRequestBetaTypeBeta]; - -/** - * - * @export - * @interface LauncherRequestReferenceBeta - */ -export interface LauncherRequestReferenceBeta { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceBeta - */ - 'type': LauncherRequestReferenceBetaTypeBeta; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceBeta - */ - 'id': string; -} - -export const LauncherRequestReferenceBetaTypeBeta = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherRequestReferenceBetaTypeBeta = typeof LauncherRequestReferenceBetaTypeBeta[keyof typeof LauncherRequestReferenceBetaTypeBeta]; - -/** - * - * @export - * @interface LeftPadBeta - */ -export interface LeftPadBeta { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof LeftPadBeta - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof LeftPadBeta - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LeftPadBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LeftPadBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LicenseBeta - */ -export interface LicenseBeta { - /** - * Name of the license - * @type {string} - * @memberof LicenseBeta - */ - 'licenseId'?: string; - /** - * Legacy name of the license - * @type {string} - * @memberof LicenseBeta - */ - 'legacyFeatureName'?: string; -} -/** - * - * @export - * @interface LifecycleStateBeta - */ -export interface LifecycleStateBeta { - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'id'?: string; - /** - * Lifecycle state name. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'name'?: string; - /** - * Lifecycle state technical name. This is for internal use. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'technicalName'?: string; - /** - * Lifecycle state description. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'description'?: string; - /** - * Lifecycle state created date. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'created'?: string; - /** - * Lifecycle state modified date. - * @type {string} - * @memberof LifecycleStateBeta - */ - 'modified'?: string; - /** - * Indicates whether the lifecycle state is enabled or disabled. - * @type {boolean} - * @memberof LifecycleStateBeta - */ - 'enabled'?: boolean; - /** - * Number of identities that have the lifecycle state. - * @type {number} - * @memberof LifecycleStateBeta - */ - 'identityCount'?: number; - /** - * - * @type {EmailNotificationOptionBeta} - * @memberof LifecycleStateBeta - */ - 'emailNotificationOption'?: EmailNotificationOptionBeta; - /** - * - * @type {Array} - * @memberof LifecycleStateBeta - */ - 'accountActions'?: Array; - /** - * List of access-profile IDs that are associated with the lifecycle state. - * @type {Array} - * @memberof LifecycleStateBeta - */ - 'accessProfileIds'?: Array; -} -/** - * - * @export - * @interface LifecycleStateDtoBeta - */ -export interface LifecycleStateDtoBeta { - /** - * The name of the lifecycle state - * @type {string} - * @memberof LifecycleStateDtoBeta - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof LifecycleStateDtoBeta - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface ListAccessModelMetadataAttribute401ResponseBeta - */ -export interface ListAccessModelMetadataAttribute401ResponseBeta { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessModelMetadataAttribute401ResponseBeta - */ - 'error'?: object; -} -/** - * - * @export - * @interface ListAccessModelMetadataAttribute429ResponseBeta - */ -export interface ListAccessModelMetadataAttribute429ResponseBeta { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessModelMetadataAttribute429ResponseBeta - */ - 'message'?: object; -} -/** - * - * @export - * @interface ListCompleteWorkflowLibrary200ResponseInnerBeta - */ -export interface ListCompleteWorkflowLibrary200ResponseInnerBeta { - /** - * Operator ID. - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'description'?: string; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputBeta} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputBeta; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'isDynamicSchema'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'outputSchema'?: object; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerBeta - */ - 'inputExample'?: object | null; -} -/** - * - * @export - * @interface ListFormDefinitionsByTenantResponseBeta - */ -export interface ListFormDefinitionsByTenantResponseBeta { - /** - * Count number of results. - * @type {number} - * @memberof ListFormDefinitionsByTenantResponseBeta - */ - 'count'?: number; - /** - * List of FormDefinitionResponse items. - * @type {Array} - * @memberof ListFormDefinitionsByTenantResponseBeta - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ListFormElementDataByElementIDResponseBeta - */ -export interface ListFormElementDataByElementIDResponseBeta { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof ListFormElementDataByElementIDResponseBeta - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ListIdentityAccessItems200ResponseInnerBeta - */ -export interface ListIdentityAccessItems200ResponseInnerBeta { - /** - * the access item id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerBeta - */ - 'appRoleId': string | null; -} -/** - * @type ListIdentitySnapshotAccessItems200ResponseInnerBeta - * @export - */ -export type ListIdentitySnapshotAccessItems200ResponseInnerBeta = AccessItemAccessProfileResponseBeta | AccessItemAccountResponseBeta | AccessItemAppResponseBeta | AccessItemEntitlementResponseBeta | AccessItemRoleResponseBeta; - -/** - * - * @export - * @interface ListPredefinedSelectOptionsResponseBeta - */ -export interface ListPredefinedSelectOptionsResponseBeta { - /** - * Results holds a list of PreDefinedSelectOption items - * @type {Array} - * @memberof ListPredefinedSelectOptionsResponseBeta - */ - 'results'?: Array; -} -/** - * Identity of workgroup member. - * @export - * @interface ListWorkgroupMembers200ResponseInnerBeta - */ -export interface ListWorkgroupMembers200ResponseInnerBeta { - /** - * Workgroup member identity DTO type. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerBeta - */ - 'type'?: ListWorkgroupMembers200ResponseInnerBetaTypeBeta; - /** - * Workgroup member identity ID. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerBeta - */ - 'id'?: string; - /** - * Workgroup member identity display name. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerBeta - */ - 'name'?: string; - /** - * Workgroup member identity email. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerBeta - */ - 'email'?: string; -} - -export const ListWorkgroupMembers200ResponseInnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type ListWorkgroupMembers200ResponseInnerBetaTypeBeta = typeof ListWorkgroupMembers200ResponseInnerBetaTypeBeta[keyof typeof ListWorkgroupMembers200ResponseInnerBetaTypeBeta]; - -/** - * - * @export - * @interface LoadAccountsTaskBeta - */ -export interface LoadAccountsTaskBeta { - /** - * The status of the result - * @type {boolean} - * @memberof LoadAccountsTaskBeta - */ - 'success'?: boolean; - /** - * - * @type {LoadAccountsTaskTaskBeta} - * @memberof LoadAccountsTaskBeta - */ - 'task'?: LoadAccountsTaskTaskBeta; -} -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadAccountsTaskTaskAttributesBeta - */ -export interface LoadAccountsTaskTaskAttributesBeta { - [key: string]: object | any; - - /** - * The id of the source - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesBeta - */ - 'appId'?: string; - /** - * The indicator if the aggregation process was enabled/disabled for the aggregation job - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesBeta - */ - 'optimizedAggregation'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskBeta - */ -export interface LoadAccountsTaskTaskBeta { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'type'?: string; - /** - * The name of the aggregation process - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'completionStatus'?: LoadAccountsTaskTaskBetaCompletionStatusBeta | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadAccountsTaskTaskBeta - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadAccountsTaskTaskBeta - */ - 'progress'?: string | null; - /** - * - * @type {LoadAccountsTaskTaskAttributesBeta} - * @memberof LoadAccountsTaskTaskBeta - */ - 'attributes'?: LoadAccountsTaskTaskAttributesBeta; - /** - * Return values from the task - * @type {Array} - * @memberof LoadAccountsTaskTaskBeta - */ - 'returns'?: Array; -} - -export const LoadAccountsTaskTaskBetaCompletionStatusBeta = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadAccountsTaskTaskBetaCompletionStatusBeta = typeof LoadAccountsTaskTaskBetaCompletionStatusBeta[keyof typeof LoadAccountsTaskTaskBetaCompletionStatusBeta]; - -/** - * - * @export - * @interface LoadAccountsTaskTaskMessagesInnerBeta - */ -export interface LoadAccountsTaskTaskMessagesInnerBeta { - /** - * Type of the message. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerBeta - */ - 'type'?: LoadAccountsTaskTaskMessagesInnerBetaTypeBeta; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerBeta - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerBeta - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerBeta - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerBeta - */ - 'localizedText'?: string; -} - -export const LoadAccountsTaskTaskMessagesInnerBetaTypeBeta = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadAccountsTaskTaskMessagesInnerBetaTypeBeta = typeof LoadAccountsTaskTaskMessagesInnerBetaTypeBeta[keyof typeof LoadAccountsTaskTaskMessagesInnerBetaTypeBeta]; - -/** - * - * @export - * @interface LoadAccountsTaskTaskReturnsInnerBeta - */ -export interface LoadAccountsTaskTaskReturnsInnerBeta { - /** - * The display label of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerBeta - */ - 'displayLabel'?: string; - /** - * The attribute name of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerBeta - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadEntitlementTaskBeta - */ -export interface LoadEntitlementTaskBeta { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'type'?: string; - /** - * The name of the task - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'uniqueName'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'launcher'?: string; - /** - * The creation date of the task - * @type {string} - * @memberof LoadEntitlementTaskBeta - */ - 'created'?: string; - /** - * Return values from the task - * @type {Array} - * @memberof LoadEntitlementTaskBeta - */ - 'returns'?: Array; -} -/** - * - * @export - * @interface LoadEntitlementTaskReturnsInnerBeta - */ -export interface LoadEntitlementTaskReturnsInnerBeta { - /** - * The display label for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerBeta - */ - 'displayLabel'?: string; - /** - * The attribute name for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerBeta - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskBeta - */ -export interface LoadUncorrelatedAccountsTaskBeta { - /** - * The status of the result - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskBeta - */ - 'success'?: boolean; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskBeta} - * @memberof LoadUncorrelatedAccountsTaskBeta - */ - 'task'?: LoadUncorrelatedAccountsTaskTaskBeta; -} -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadUncorrelatedAccountsTaskTaskAttributesBeta - */ -export interface LoadUncorrelatedAccountsTaskTaskAttributesBeta { - /** - * The id of qpoc job - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesBeta - */ - 'qpocJobId'?: string; - /** - * the task start delay value - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesBeta - */ - 'taskStartDelay'?: object; -} -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskBeta - */ -export interface LoadUncorrelatedAccountsTaskTaskBeta { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'type'?: string; - /** - * The name of uncorrelated accounts process - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'completionStatus'?: LoadUncorrelatedAccountsTaskTaskBetaCompletionStatusBeta | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'progress'?: string | null; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskAttributesBeta} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'attributes'?: LoadUncorrelatedAccountsTaskTaskAttributesBeta; - /** - * Return values from the task - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskBeta - */ - 'returns'?: object; -} - -export const LoadUncorrelatedAccountsTaskTaskBetaCompletionStatusBeta = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskBetaCompletionStatusBeta = typeof LoadUncorrelatedAccountsTaskTaskBetaCompletionStatusBeta[keyof typeof LoadUncorrelatedAccountsTaskTaskBetaCompletionStatusBeta]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ -export interface LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta { - /** - * Type of the message. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ - 'type'?: LoadUncorrelatedAccountsTaskTaskMessagesInnerBetaTypeBeta; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerBeta - */ - 'localizedText'?: string; -} - -export const LoadUncorrelatedAccountsTaskTaskMessagesInnerBetaTypeBeta = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskMessagesInnerBetaTypeBeta = typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerBetaTypeBeta[keyof typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerBetaTypeBeta]; - -/** - * 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 LocaleOriginBeta = { - Default: 'DEFAULT', - Request: 'REQUEST' -} as const; - -export type LocaleOriginBeta = typeof LocaleOriginBeta[keyof typeof LocaleOriginBeta]; - - -/** - * Localized error message to indicate a failed invocation or error if any. - * @export - * @interface LocalizedMessageBeta - */ -export interface LocalizedMessageBeta { - /** - * Message locale - * @type {string} - * @memberof LocalizedMessageBeta - */ - 'locale': string; - /** - * Message text - * @type {string} - * @memberof LocalizedMessageBeta - */ - 'message': string; -} -/** - * - * @export - * @interface LookupBeta - */ -export interface LookupBeta { - /** - * This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform. - * @type {{ [key: string]: any; }} - * @memberof LookupBeta - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LookupBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LookupBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface LookupStepBeta - */ -export interface LookupStepBeta { - /** - * The ID of the Identity who work is reassigned to - * @type {string} - * @memberof LookupStepBeta - */ - 'reassignedToId'?: string; - /** - * The ID of the Identity who work is reassigned from - * @type {string} - * @memberof LookupStepBeta - */ - 'reassignedFromId'?: string; - /** - * - * @type {ReassignmentTypeEnumBeta} - * @memberof LookupStepBeta - */ - 'reassignmentType'?: ReassignmentTypeEnumBeta; -} - - -/** - * - * @export - * @interface LowerBeta - */ -export interface LowerBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LowerBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LowerBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesBeta - */ -export interface MailFromAttributesBeta { - /** - * The email identity - * @type {string} - * @memberof MailFromAttributesBeta - */ - 'identity'?: string; - /** - * The name of a domain that an email identity uses as a custom MAIL FROM domain - * @type {string} - * @memberof MailFromAttributesBeta - */ - 'mailFromDomain'?: string; - /** - * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you - * @type {string} - * @memberof MailFromAttributesBeta - */ - 'mxRecord'?: string; - /** - * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain - * @type {string} - * @memberof MailFromAttributesBeta - */ - 'txtRecord'?: string; - /** - * The current status of the MAIL FROM verification - * @type {string} - * @memberof MailFromAttributesBeta - */ - 'mailFromDomainStatus'?: MailFromAttributesBetaMailFromDomainStatusBeta; -} - -export const MailFromAttributesBetaMailFromDomainStatusBeta = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MailFromAttributesBetaMailFromDomainStatusBeta = typeof MailFromAttributesBetaMailFromDomainStatusBeta[keyof typeof MailFromAttributesBetaMailFromDomainStatusBeta]; - -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesDtoBeta - */ -export interface MailFromAttributesDtoBeta { - /** - * The identity or domain address - * @type {string} - * @memberof MailFromAttributesDtoBeta - */ - 'identity'?: string; - /** - * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. - * @type {string} - * @memberof MailFromAttributesDtoBeta - */ - 'mailFromDomain'?: string; -} -/** - * Managed Client - * @export - * @interface ManagedClientBeta - */ -export interface ManagedClientBeta { - /** - * ManagedClient ID - * @type {string} - * @memberof ManagedClientBeta - */ - 'id'?: string; - /** - * ManagedClient alert key - * @type {string} - * @memberof ManagedClientBeta - */ - 'alertKey'?: string; - /** - * ManagedClient gateway base url - * @type {string} - * @memberof ManagedClientBeta - */ - 'apiGatewayBaseUrl'?: string; - /** - * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - * @type {number} - * @memberof ManagedClientBeta - */ - 'ccId'?: number; - /** - * The client ID used in API management - * @type {string} - * @memberof ManagedClientBeta - */ - 'clientId': string; - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientBeta - */ - 'clusterId': string; - /** - * VA cookbook - * @type {string} - * @memberof ManagedClientBeta - */ - 'cookbook'?: string; - /** - * ManagedClient description - * @type {string} - * @memberof ManagedClientBeta - */ - 'description': string; - /** - * The public IP address of the ManagedClient - * @type {string} - * @memberof ManagedClientBeta - */ - 'ipAddress'?: string; - /** - * When the ManagedClient was last seen by the server - * @type {string} - * @memberof ManagedClientBeta - */ - 'lastSeen'?: string; - /** - * ManagedClient name - * @type {string} - * @memberof ManagedClientBeta - */ - 'name'?: string; - /** - * Milliseconds since the ManagedClient has polled the server - * @type {string} - * @memberof ManagedClientBeta - */ - 'sinceLastSeen'?: string; - /** - * Status of the ManagedClient - * @type {ManagedClientStatusEnumBeta} - * @memberof ManagedClientBeta - */ - 'status'?: ManagedClientStatusEnumBeta; - /** - * Type of the ManagedClient (VA, CCG) - * @type {string} - * @memberof ManagedClientBeta - */ - 'type': string; - /** - * ManagedClient VA download URL - * @type {string} - * @memberof ManagedClientBeta - */ - 'vaDownloadUrl'?: string; - /** - * Version that the ManagedClient\'s VA is running - * @type {string} - * @memberof ManagedClientBeta - */ - 'vaVersion'?: string; - /** - * Client\'s apiKey - * @type {string} - * @memberof ManagedClientBeta - */ - 'secret'?: string; -} - - -/** - * Managed Client Status - * @export - * @interface ManagedClientStatusAggResponseBeta - */ -export interface ManagedClientStatusAggResponseBeta { - /** - * ManagedClientStatus body information - * @type {object} - * @memberof ManagedClientStatusAggResponseBeta - */ - 'body': object; - /** - * - * @type {ManagedClientStatusEnumBeta} - * @memberof ManagedClientStatusAggResponseBeta - */ - 'status': ManagedClientStatusEnumBeta; - /** - * - * @type {ManagedClientTypeBeta} - * @memberof ManagedClientStatusAggResponseBeta - */ - 'type': ManagedClientTypeBeta | null; - /** - * timestamp on the Client Status update - * @type {string} - * @memberof ManagedClientStatusAggResponseBeta - */ - 'timestamp': string; -} - - -/** - * Managed Client Status - * @export - * @interface ManagedClientStatusBeta - */ -export interface ManagedClientStatusBeta { - /** - * ManagedClientStatus body information - * @type {object} - * @memberof ManagedClientStatusBeta - */ - 'body': object; - /** - * - * @type {ManagedClientStatusEnumBeta} - * @memberof ManagedClientStatusBeta - */ - 'status': ManagedClientStatusEnumBeta; - /** - * - * @type {ManagedClientTypeBeta} - * @memberof ManagedClientStatusBeta - */ - 'type': ManagedClientTypeBeta | null; - /** - * timestamp on the Client Status update - * @type {string} - * @memberof ManagedClientStatusBeta - */ - 'timestamp': string; -} - - -/** - * - * @export - * @enum {string} - */ - -export const ManagedClientStatusEnumBeta = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientStatusEnumBeta = typeof ManagedClientStatusEnumBeta[keyof typeof ManagedClientStatusEnumBeta]; - - -/** - * Managed Client type - * @export - * @enum {string} - */ - -export const ManagedClientTypeBeta = { - Ccg: 'CCG', - Va: 'VA', - Internal: 'INTERNAL', - IiqHarvester: 'IIQ_HARVESTER' -} as const; - -export type ManagedClientTypeBeta = typeof ManagedClientTypeBeta[keyof typeof ManagedClientTypeBeta]; - - -/** - * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - * @export - * @interface ManagedClusterAttributesBeta - */ -export interface ManagedClusterAttributesBeta { - /** - * - * @type {ManagedClusterQueueBeta} - * @memberof ManagedClusterAttributesBeta - */ - 'queue'?: ManagedClusterQueueBeta; - /** - * ManagedCluster keystore for spConnectCluster type - * @type {string} - * @memberof ManagedClusterAttributesBeta - */ - 'keystore'?: string | null; -} -/** - * Managed Cluster - * @export - * @interface ManagedClusterBeta - */ -export interface ManagedClusterBeta { - /** - * ManagedCluster ID - * @type {string} - * @memberof ManagedClusterBeta - */ - 'id': string; - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterBeta - */ - 'name'?: string; - /** - * ManagedCluster pod - * @type {string} - * @memberof ManagedClusterBeta - */ - 'pod'?: string; - /** - * ManagedCluster org - * @type {string} - * @memberof ManagedClusterBeta - */ - 'org'?: string; - /** - * - * @type {ManagedClusterTypesBeta} - * @memberof ManagedClusterBeta - */ - 'type'?: ManagedClusterTypesBeta; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string | null; }} - * @memberof ManagedClusterBeta - */ - 'configuration'?: { [key: string]: string | null; }; - /** - * - * @type {ManagedClusterKeyPairBeta} - * @memberof ManagedClusterBeta - */ - 'keyPair'?: ManagedClusterKeyPairBeta; - /** - * - * @type {ManagedClusterAttributesBeta} - * @memberof ManagedClusterBeta - */ - 'attributes'?: ManagedClusterAttributesBeta; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterBeta - */ - 'description'?: string; - /** - * - * @type {ManagedClusterRedisBeta} - * @memberof ManagedClusterBeta - */ - 'redis'?: ManagedClusterRedisBeta; - /** - * - * @type {ManagedClientTypeBeta} - * @memberof ManagedClusterBeta - */ - 'clientType': ManagedClientTypeBeta | null; - /** - * CCG version used by the ManagedCluster - * @type {string} - * @memberof ManagedClusterBeta - */ - 'ccgVersion': string; - /** - * boolean flag indiacting whether or not the cluster configuration is pinned - * @type {boolean} - * @memberof ManagedClusterBeta - */ - 'pinnedConfig'?: boolean; - /** - * - * @type {ClientLogConfigurationBeta} - * @memberof ManagedClusterBeta - */ - 'logConfiguration'?: ClientLogConfigurationBeta | null; - /** - * Whether or not the cluster is operational or not - * @type {boolean} - * @memberof ManagedClusterBeta - */ - 'operational'?: boolean; - /** - * Cluster status - * @type {string} - * @memberof ManagedClusterBeta - */ - 'status'?: string; - /** - * Public key certificate - * @type {string} - * @memberof ManagedClusterBeta - */ - 'publicKeyCertificate'?: string | null; - /** - * Public key thumbprint - * @type {string} - * @memberof ManagedClusterBeta - */ - 'publicKeyThumbprint'?: string | null; - /** - * Public key - * @type {string} - * @memberof ManagedClusterBeta - */ - 'publicKey'?: string | null; - /** - * Key describing any immediate cluster alerts - * @type {string} - * @memberof ManagedClusterBeta - */ - 'alertKey'?: string; - /** - * List of clients in a cluster - * @type {Array} - * @memberof ManagedClusterBeta - */ - 'clientIds'?: Array; - /** - * Number of services bound to a cluster - * @type {number} - * @memberof ManagedClusterBeta - */ - 'serviceCount'?: number; - /** - * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - * @type {string} - * @memberof ManagedClusterBeta - */ - 'ccId'?: string; - /** - * The date/time this cluster was created - * @type {string} - * @memberof ManagedClusterBeta - */ - 'createdAt'?: string | null; - /** - * The date/time this cluster was last updated - * @type {string} - * @memberof ManagedClusterBeta - */ - 'updatedAt'?: string | null; - /** - * The date/time this cluster was notified for the last release - * @type {string} - * @memberof ManagedClusterBeta - */ - 'lastReleaseNotifiedAt'?: string | null; - /** - * - * @type {ManagedClusterUpdatePreferencesBeta} - * @memberof ManagedClusterBeta - */ - 'updatePreferences'?: ManagedClusterUpdatePreferencesBeta; - /** - * The current installed release on the Managed cluster - * @type {string} - * @memberof ManagedClusterBeta - */ - 'currentInstalledReleaseVersion'?: string | null; - /** - * New available updates for the Managed cluster - * @type {string} - * @memberof ManagedClusterBeta - */ - 'updatePackage'?: string | null; - /** - * The time at which out of date notification was sent for the Managed cluster - * @type {string} - * @memberof ManagedClusterBeta - */ - 'isOutOfDateNotifiedAt'?: string | null; - /** - * The consolidated Health Status for the Managed cluster - * @type {string} - * @memberof ManagedClusterBeta - */ - 'consolidatedHealthIndicatorsStatus'?: ManagedClusterBetaConsolidatedHealthIndicatorsStatusBeta | null; - /** - * - * @type {ManagedClusterEncryptionConfigBeta} - * @memberof ManagedClusterBeta - */ - 'encryptionConfiguration'?: ManagedClusterEncryptionConfigBeta; -} - -export const ManagedClusterBetaConsolidatedHealthIndicatorsStatusBeta = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClusterBetaConsolidatedHealthIndicatorsStatusBeta = typeof ManagedClusterBetaConsolidatedHealthIndicatorsStatusBeta[keyof typeof ManagedClusterBetaConsolidatedHealthIndicatorsStatusBeta]; - -/** - * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. - * @export - * @interface ManagedClusterEncryptionConfigBeta - */ -export interface ManagedClusterEncryptionConfigBeta { - /** - * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. - * @type {string} - * @memberof ManagedClusterEncryptionConfigBeta - */ - 'format'?: ManagedClusterEncryptionConfigBetaFormatBeta; -} - -export const ManagedClusterEncryptionConfigBetaFormatBeta = { - V2: 'V2', - V3: 'V3' -} as const; - -export type ManagedClusterEncryptionConfigBetaFormatBeta = typeof ManagedClusterEncryptionConfigBetaFormatBeta[keyof typeof ManagedClusterEncryptionConfigBetaFormatBeta]; - -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterKeyPairBeta - */ -export interface ManagedClusterKeyPairBeta { - /** - * ManagedCluster publicKey - * @type {string} - * @memberof ManagedClusterKeyPairBeta - */ - 'publicKey'?: string | null; - /** - * ManagedCluster publicKeyThumbprint - * @type {string} - * @memberof ManagedClusterKeyPairBeta - */ - 'publicKeyThumbprint'?: string | null; - /** - * ManagedCluster publicKeyCertificate - * @type {string} - * @memberof ManagedClusterKeyPairBeta - */ - 'publicKeyCertificate'?: string | null; -} -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterQueueBeta - */ -export interface ManagedClusterQueueBeta { - /** - * ManagedCluster queue name - * @type {string} - * @memberof ManagedClusterQueueBeta - */ - 'name'?: string; - /** - * ManagedCluster queue aws region - * @type {string} - * @memberof ManagedClusterQueueBeta - */ - 'region'?: string; -} -/** - * Managed Cluster Redis Configuration - * @export - * @interface ManagedClusterRedisBeta - */ -export interface ManagedClusterRedisBeta { - /** - * ManagedCluster redisHost - * @type {string} - * @memberof ManagedClusterRedisBeta - */ - 'redisHost'?: string; - /** - * ManagedCluster redisPort - * @type {number} - * @memberof ManagedClusterRedisBeta - */ - 'redisPort'?: number; -} -/** - * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products - * @export - * @enum {string} - */ - -export const ManagedClusterTypesBeta = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc', - Pag: 'pag', - DasAm: 'das-am', - Standard: 'standard' -} as const; - -export type ManagedClusterTypesBeta = typeof ManagedClusterTypesBeta[keyof typeof ManagedClusterTypesBeta]; - - -/** - * The preference for applying updates for the cluster - * @export - * @interface ManagedClusterUpdatePreferencesBeta - */ -export interface ManagedClusterUpdatePreferencesBeta { - /** - * The processGroups for updatePreferences - * @type {string} - * @memberof ManagedClusterUpdatePreferencesBeta - */ - 'processGroups'?: string | null; - /** - * The current updateState for the cluster - * @type {string} - * @memberof ManagedClusterUpdatePreferencesBeta - */ - 'updateState'?: ManagedClusterUpdatePreferencesBetaUpdateStateBeta | null; - /** - * The mail id to which new releases will be notified - * @type {string} - * @memberof ManagedClusterUpdatePreferencesBeta - */ - 'notificationEmail'?: string | null; -} - -export const ManagedClusterUpdatePreferencesBetaUpdateStateBeta = { - Auto: 'AUTO', - Disabled: 'DISABLED' -} as const; - -export type ManagedClusterUpdatePreferencesBetaUpdateStateBeta = typeof ManagedClusterUpdatePreferencesBetaUpdateStateBeta[keyof typeof ManagedClusterUpdatePreferencesBetaUpdateStateBeta]; - -/** - * - * @export - * @interface ManagerCorrelationMappingBeta - */ -export interface ManagerCorrelationMappingBeta { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof ManagerCorrelationMappingBeta - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof ManagerCorrelationMappingBeta - */ - 'identityAttributeName'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsBeta - */ -export interface ManualDiscoverApplicationsBeta { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ManualDiscoverApplicationsBeta - */ - 'file': File; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsTemplateBeta - */ -export interface ManualDiscoverApplicationsTemplateBeta { - /** - * Name of the example application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateBeta - */ - 'application_name'?: string; - /** - * Description of the example application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateBeta - */ - 'description'?: string; -} -/** - * - * @export - * @interface ManualWorkItemDetails1Beta - */ -export interface ManualWorkItemDetails1Beta { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetails1Beta - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwnerBeta} - * @memberof ManualWorkItemDetails1Beta - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwnerBeta | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwnerBeta} - * @memberof ManualWorkItemDetails1Beta - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwnerBeta | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetails1Beta - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemStateBeta} - * @memberof ManualWorkItemDetails1Beta - */ - 'status'?: ManualWorkItemStateBeta; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetails1Beta - */ - 'forwardHistory'?: Array | null; -} - - -/** - * - * @export - * @interface ManualWorkItemDetailsBeta - */ -export interface ManualWorkItemDetailsBeta { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetailsBeta - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwnerBeta} - * @memberof ManualWorkItemDetailsBeta - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwnerBeta | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwnerBeta} - * @memberof ManualWorkItemDetailsBeta - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwnerBeta | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetailsBeta - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemStateBeta} - * @memberof ManualWorkItemDetailsBeta - */ - 'status'?: ManualWorkItemStateBeta; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetailsBeta - */ - 'forwardHistory'?: Array | null; -} - - -/** - * Identity of current work item owner. - * @export - * @interface ManualWorkItemDetailsCurrentOwnerBeta - */ -export interface ManualWorkItemDetailsCurrentOwnerBeta { - /** - * DTO type of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerBeta - */ - 'type'?: ManualWorkItemDetailsCurrentOwnerBetaTypeBeta; - /** - * ID of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerBeta - */ - 'id'?: string; - /** - * Display name of current work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerBeta - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsCurrentOwnerBetaTypeBeta = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsCurrentOwnerBetaTypeBeta = typeof ManualWorkItemDetailsCurrentOwnerBetaTypeBeta[keyof typeof ManualWorkItemDetailsCurrentOwnerBetaTypeBeta]; - -/** - * Identity of original work item owner, if the work item has been forwarded. - * @export - * @interface ManualWorkItemDetailsOriginalOwnerBeta - */ -export interface ManualWorkItemDetailsOriginalOwnerBeta { - /** - * DTO type of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerBeta - */ - 'type'?: ManualWorkItemDetailsOriginalOwnerBetaTypeBeta; - /** - * ID of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerBeta - */ - 'id'?: string; - /** - * Display name of original work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerBeta - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsOriginalOwnerBetaTypeBeta = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsOriginalOwnerBetaTypeBeta = typeof ManualWorkItemDetailsOriginalOwnerBetaTypeBeta[keyof typeof ManualWorkItemDetailsOriginalOwnerBetaTypeBeta]; - -/** - * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. - * @export - * @enum {string} - */ - -export const ManualWorkItemStateBeta = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Expired: 'EXPIRED', - Cancelled: 'CANCELLED', - Archived: 'ARCHIVED' -} as const; - -export type ManualWorkItemStateBeta = typeof ManualWorkItemStateBeta[keyof typeof ManualWorkItemStateBeta]; - - -/** - * - * @export - * @interface ManuallyUpdatedFieldsDTOBeta - */ -export interface ManuallyUpdatedFieldsDTOBeta { - /** - * True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. - * @type {boolean} - * @memberof ManuallyUpdatedFieldsDTOBeta - */ - 'DISPLAY_NAME'?: boolean; - /** - * True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. - * @type {boolean} - * @memberof ManuallyUpdatedFieldsDTOBeta - */ - 'DESCRIPTION'?: boolean; -} -/** - * - * @export - * @interface MatchTermBeta - */ -export interface MatchTermBeta { - /** - * The attribute name - * @type {string} - * @memberof MatchTermBeta - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof MatchTermBeta - */ - 'value'?: string; - /** - * The operator between name and value - * @type {string} - * @memberof MatchTermBeta - */ - 'op'?: string; - /** - * If it is a container or a real match term - * @type {boolean} - * @memberof MatchTermBeta - */ - 'container'?: boolean; - /** - * If it is AND logical operator for the children match terms - * @type {boolean} - * @memberof MatchTermBeta - */ - 'and'?: boolean; - /** - * The children under this match term - * @type {Array<{ [key: string]: any; }>} - * @memberof MatchTermBeta - */ - 'children'?: Array<{ [key: string]: any; }> | null; -} -/** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @export - * @enum {string} - */ - -export const MediumBeta = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type MediumBeta = typeof MediumBeta[keyof typeof MediumBeta]; - - -/** - * - * @export - * @interface MessageCatalogDtoBeta - */ -export interface MessageCatalogDtoBeta { - /** - * The language in which the messages are returned - * @type {string} - * @memberof MessageCatalogDtoBeta - */ - 'locale'?: string; - /** - * The list of message with their keys and formats - * @type {Array} - * @memberof MessageCatalogDtoBeta - */ - 'messages'?: Array; -} -/** - * - * @export - * @interface MetricResponseBeta - */ -export interface MetricResponseBeta { - /** - * the name of metric - * @type {string} - * @memberof MetricResponseBeta - */ - 'name'?: string; - /** - * the value associated to the metric - * @type {number} - * @memberof MetricResponseBeta - */ - 'value'?: number; -} -/** - * Response model for configuration test of a given MFA method - * @export - * @interface MfaConfigTestResponseBeta - */ -export interface MfaConfigTestResponseBeta { - /** - * The configuration test result. - * @type {string} - * @memberof MfaConfigTestResponseBeta - */ - 'state'?: MfaConfigTestResponseBetaStateBeta; - /** - * The error message to indicate the failure of configuration test. - * @type {string} - * @memberof MfaConfigTestResponseBeta - */ - 'error'?: string; -} - -export const MfaConfigTestResponseBetaStateBeta = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MfaConfigTestResponseBetaStateBeta = typeof MfaConfigTestResponseBetaStateBeta[keyof typeof MfaConfigTestResponseBetaStateBeta]; - -/** - * - * @export - * @interface MfaDuoConfigBeta - */ -export interface MfaDuoConfigBeta { - /** - * Mfa method name - * @type {string} - * @memberof MfaDuoConfigBeta - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaDuoConfigBeta - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaDuoConfigBeta - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigBeta - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigBeta - */ - 'identityAttribute'?: string | null; - /** - * A map with additional config properties for the given MFA method - duo-web. - * @type {{ [key: string]: any; }} - * @memberof MfaDuoConfigBeta - */ - 'configProperties'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface MfaOktaConfigBeta - */ -export interface MfaOktaConfigBeta { - /** - * Mfa method name - * @type {string} - * @memberof MfaOktaConfigBeta - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaOktaConfigBeta - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaOktaConfigBeta - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigBeta - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigBeta - */ - 'identityAttribute'?: string | null; -} -/** - * This represents a Multi-Host Integration template type. - * @export - * @interface MultiHostIntegrationTemplateTypeBeta - */ -export interface MultiHostIntegrationTemplateTypeBeta { - /** - * This is the name of the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeBeta - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeBeta - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeBeta - */ - 'scriptName': string; -} -/** - * - * @export - * @interface MultiHostIntegrationsAggScheduleUpdateBeta - */ -export interface MultiHostIntegrationsAggScheduleUpdateBeta { - /** - * Multi-Host Integration ID. The ID must be unique - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'multihostId': string; - /** - * Multi-Host Integration aggregation group ID - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'aggregation_grp_id': string; - /** - * Multi-Host Integration name - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'aggregation_grp_name': string; - /** - * Cron expression to schedule aggregation - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'aggregation_cron_schedule': string; - /** - * Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. - * @type {boolean} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'enableSchedule': boolean; - /** - * Source IDs of the Multi-Host Integration - * @type {Array} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'source_id_list': Array; - /** - * Created date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'created'?: string; - /** - * Modified date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface MultiHostIntegrationsBeta - */ -export interface MultiHostIntegrationsBeta { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'id': string; - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerBeta} - * @memberof MultiHostIntegrationsBeta - */ - 'owner': MultiHostIntegrationsOwnerBeta; - /** - * - * @type {MultiHostIntegrationsClusterBeta} - * @memberof MultiHostIntegrationsBeta - */ - 'cluster'?: MultiHostIntegrationsClusterBeta | null; - /** - * Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connector': string; - /** - * Last successfully uploaded source count of given Multi-Host Integration. - * @type {number} - * @memberof MultiHostIntegrationsBeta - */ - 'lastSourceUploadSuccessCount'?: number; - /** - * Maximum sources that can contain in a aggregation group of Multi-Host Integration. - * @type {number} - * @memberof MultiHostIntegrationsBeta - */ - 'maxSourcesPerAggGroup'?: number; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connectorClass'?: string; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesBeta} - * @memberof MultiHostIntegrationsBeta - */ - 'connectorAttributes'?: MultiHostIntegrationsConnectorAttributesBeta; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostIntegrationsBeta - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostIntegrationsBeta - */ - 'authoritative'?: boolean; - /** - * - * @type {MultiHostIntegrationsManagementWorkgroupBeta} - * @memberof MultiHostIntegrationsBeta - */ - 'managementWorkgroup'?: MultiHostIntegrationsManagementWorkgroupBeta | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostIntegrationsBeta - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'status'?: MultiHostIntegrationsBetaStatusBeta; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connectionType'?: MultiHostIntegrationsBetaConnectionTypeBeta; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostIntegrationsBeta - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostIntegrationsBeta - */ - 'category'?: string | null; -} - -export const MultiHostIntegrationsBetaStatusBeta = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostIntegrationsBetaStatusBeta = typeof MultiHostIntegrationsBetaStatusBeta[keyof typeof MultiHostIntegrationsBetaStatusBeta]; -export const MultiHostIntegrationsBetaConnectionTypeBeta = { - Direct: 'direct', - File: 'file' -} as const; - -export type MultiHostIntegrationsBetaConnectionTypeBeta = typeof MultiHostIntegrationsBetaConnectionTypeBeta[keyof typeof MultiHostIntegrationsBetaConnectionTypeBeta]; - -/** - * Reference to the source\'s associated cluster. - * @export - * @interface MultiHostIntegrationsClusterBeta - */ -export interface MultiHostIntegrationsClusterBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsClusterBeta - */ - 'type': MultiHostIntegrationsClusterBetaTypeBeta; - /** - * Cluster ID. - * @type {string} - * @memberof MultiHostIntegrationsClusterBeta - */ - 'id': string; - /** - * Cluster\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsClusterBeta - */ - 'name': string; -} - -export const MultiHostIntegrationsClusterBetaTypeBeta = { - Cluster: 'CLUSTER' -} as const; - -export type MultiHostIntegrationsClusterBetaTypeBeta = typeof MultiHostIntegrationsClusterBetaTypeBeta[keyof typeof MultiHostIntegrationsClusterBetaTypeBeta]; - -/** - * Connector specific configuration. This configuration will differ for Multi-Host Integration type. - * @export - * @interface MultiHostIntegrationsConnectorAttributesBeta - */ -export interface MultiHostIntegrationsConnectorAttributesBeta { - [key: string]: string | any; - - /** - * Maximum sources allowed count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'maxAllowedSources'?: number; - /** - * Last upload sources count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'lastSourceUploadCount'?: number; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryBeta} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'connectorFileUploadHistory'?: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryBeta; - /** - * Multi-Host integration status. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'multihost_status'?: MultiHostIntegrationsConnectorAttributesBetaMultihostStatusBeta; - /** - * Show account schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'showAccountSchema'?: boolean; - /** - * Show entitlement schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'showEntitlementSchema'?: boolean; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta} - * @memberof MultiHostIntegrationsConnectorAttributesBeta - */ - 'multiHostAttributes'?: MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta; -} - -export const MultiHostIntegrationsConnectorAttributesBetaMultihostStatusBeta = { - Ready: 'ready', - Processing: 'processing', - FileUploadInProgress: 'fileUploadInProgress', - SourceCreationInProgress: 'sourceCreationInProgress', - AggregationGroupingInProgress: 'aggregationGroupingInProgress', - AggregationScheduleInProgress: 'aggregationScheduleInProgress', - DeleteInProgress: 'deleteInProgress', - DeleteFailed: 'deleteFailed' -} as const; - -export type MultiHostIntegrationsConnectorAttributesBetaMultihostStatusBeta = typeof MultiHostIntegrationsConnectorAttributesBetaMultihostStatusBeta[keyof typeof MultiHostIntegrationsConnectorAttributesBetaMultihostStatusBeta]; - -/** - * - * @export - * @interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryBeta - */ -export interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryBeta { - /** - * File name of the connector JAR - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryBeta - */ - 'connectorFileNameUploadedDate'?: string; -} -/** - * Attributes of Multi-Host Integration - * @export - * @interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta - */ -export interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta { - /** - * Password. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta - */ - 'password'?: string; - /** - * Connector file. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta - */ - 'connector_files'?: string; - /** - * Authentication type. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta - */ - 'authType'?: string; - /** - * Username. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesBeta - */ - 'user'?: string; -} -/** - * - * @export - * @interface MultiHostIntegrationsCreateBeta - */ -export interface MultiHostIntegrationsCreateBeta { - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerBeta} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'owner': MultiHostIntegrationsOwnerBeta; - /** - * - * @type {MultiHostIntegrationsClusterBeta} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'cluster'?: MultiHostIntegrationsClusterBeta | null; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'connector': string; - /** - * Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * - * @type {MultiHostIntegrationsManagementWorkgroupBeta} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'managementWorkgroup'?: MultiHostIntegrationsManagementWorkgroupBeta | null; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsCreateBeta - */ - 'modified'?: string; -} -/** - * This represents sources to be created of same type. - * @export - * @interface MultiHostIntegrationsCreateSourcesBeta - */ -export interface MultiHostIntegrationsCreateSourcesBeta { - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesBeta - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesBeta - */ - 'description'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateSourcesBeta - */ - 'connectorAttributes'?: { [key: string]: any; }; -} -/** - * Reference to management workgroup for the source. - * @export - * @interface MultiHostIntegrationsManagementWorkgroupBeta - */ -export interface MultiHostIntegrationsManagementWorkgroupBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsManagementWorkgroupBeta - */ - 'type'?: MultiHostIntegrationsManagementWorkgroupBetaTypeBeta; - /** - * Management workgroup ID. - * @type {string} - * @memberof MultiHostIntegrationsManagementWorkgroupBeta - */ - 'id'?: string; - /** - * Management workgroup\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsManagementWorkgroupBeta - */ - 'name'?: string; -} - -export const MultiHostIntegrationsManagementWorkgroupBetaTypeBeta = { - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type MultiHostIntegrationsManagementWorkgroupBetaTypeBeta = typeof MultiHostIntegrationsManagementWorkgroupBetaTypeBeta[keyof typeof MultiHostIntegrationsManagementWorkgroupBetaTypeBeta]; - -/** - * Reference to identity object who owns the source. - * @export - * @interface MultiHostIntegrationsOwnerBeta - */ -export interface MultiHostIntegrationsOwnerBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsOwnerBeta - */ - 'type'?: MultiHostIntegrationsOwnerBetaTypeBeta; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof MultiHostIntegrationsOwnerBeta - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsOwnerBeta - */ - 'name'?: string; -} - -export const MultiHostIntegrationsOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type MultiHostIntegrationsOwnerBetaTypeBeta = typeof MultiHostIntegrationsOwnerBetaTypeBeta[keyof typeof MultiHostIntegrationsOwnerBetaTypeBeta]; - -/** - * Reference to account correlation config object. - * @export - * @interface MultiHostSourcesAccountCorrelationConfigBeta - */ -export interface MultiHostSourcesAccountCorrelationConfigBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationConfigBeta - */ - 'type'?: MultiHostSourcesAccountCorrelationConfigBetaTypeBeta; - /** - * Account correlation config ID. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationConfigBeta - */ - 'id'?: string; - /** - * Account correlation config\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationConfigBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesAccountCorrelationConfigBetaTypeBeta = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' -} as const; - -export type MultiHostSourcesAccountCorrelationConfigBetaTypeBeta = typeof MultiHostSourcesAccountCorrelationConfigBetaTypeBeta[keyof typeof MultiHostSourcesAccountCorrelationConfigBetaTypeBeta]; - -/** - * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. - * @export - * @interface MultiHostSourcesAccountCorrelationRuleBeta - */ -export interface MultiHostSourcesAccountCorrelationRuleBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationRuleBeta - */ - 'type'?: MultiHostSourcesAccountCorrelationRuleBetaTypeBeta; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationRuleBeta - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesAccountCorrelationRuleBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesAccountCorrelationRuleBetaTypeBeta = { - Rule: 'RULE' -} as const; - -export type MultiHostSourcesAccountCorrelationRuleBetaTypeBeta = typeof MultiHostSourcesAccountCorrelationRuleBetaTypeBeta[keyof typeof MultiHostSourcesAccountCorrelationRuleBetaTypeBeta]; - -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface MultiHostSourcesBeforeProvisioningRuleBeta - */ -export interface MultiHostSourcesBeforeProvisioningRuleBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesBeforeProvisioningRuleBeta - */ - 'type'?: MultiHostSourcesBeforeProvisioningRuleBetaTypeBeta; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostSourcesBeforeProvisioningRuleBeta - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesBeforeProvisioningRuleBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesBeforeProvisioningRuleBetaTypeBeta = { - Rule: 'RULE' -} as const; - -export type MultiHostSourcesBeforeProvisioningRuleBetaTypeBeta = typeof MultiHostSourcesBeforeProvisioningRuleBetaTypeBeta[keyof typeof MultiHostSourcesBeforeProvisioningRuleBetaTypeBeta]; - -/** - * - * @export - * @interface MultiHostSourcesBeta - */ -export interface MultiHostSourcesBeta { - /** - * Source ID. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'id': string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'description'?: string; - /** - * - * @type {MultiHostIntegrationsOwnerBeta} - * @memberof MultiHostSourcesBeta - */ - 'owner': MultiHostIntegrationsOwnerBeta; - /** - * - * @type {MultiHostIntegrationsClusterBeta} - * @memberof MultiHostSourcesBeta - */ - 'cluster'?: MultiHostIntegrationsClusterBeta | null; - /** - * - * @type {MultiHostSourcesAccountCorrelationConfigBeta} - * @memberof MultiHostSourcesBeta - */ - 'accountCorrelationConfig'?: MultiHostSourcesAccountCorrelationConfigBeta | null; - /** - * - * @type {MultiHostSourcesAccountCorrelationRuleBeta} - * @memberof MultiHostSourcesBeta - */ - 'accountCorrelationRule'?: MultiHostSourcesAccountCorrelationRuleBeta | null; - /** - * - * @type {ManagerCorrelationMappingBeta} - * @memberof MultiHostSourcesBeta - */ - 'managerCorrelationMapping'?: ManagerCorrelationMappingBeta | null; - /** - * - * @type {MultiHostSourcesManagerCorrelationRuleBeta} - * @memberof MultiHostSourcesBeta - */ - 'managerCorrelationRule'?: MultiHostSourcesManagerCorrelationRuleBeta | null; - /** - * - * @type {MultiHostSourcesBeforeProvisioningRuleBeta} - * @memberof MultiHostSourcesBeta - */ - 'beforeProvisioningRule'?: MultiHostSourcesBeforeProvisioningRuleBeta | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostSourcesBeta - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostSourcesBeta - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostSourcesBeta - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostSourcesBeta - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostSourcesBeta - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostSourcesBeta - */ - 'authoritative'?: boolean; - /** - * - * @type {MultiHostIntegrationsManagementWorkgroupBeta} - * @memberof MultiHostSourcesBeta - */ - 'managementWorkgroup'?: MultiHostIntegrationsManagementWorkgroupBeta | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostSourcesBeta - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'status'?: MultiHostSourcesBetaStatusBeta; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connectorName': string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostSourcesBeta - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostSourcesBeta - */ - 'category'?: string | null; -} - -export const MultiHostSourcesBetaFeaturesBeta = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostSourcesBetaFeaturesBeta = typeof MultiHostSourcesBetaFeaturesBeta[keyof typeof MultiHostSourcesBetaFeaturesBeta]; -export const MultiHostSourcesBetaStatusBeta = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostSourcesBetaStatusBeta = typeof MultiHostSourcesBetaStatusBeta[keyof typeof MultiHostSourcesBetaStatusBeta]; - -/** - * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. - * @export - * @interface MultiHostSourcesManagerCorrelationRuleBeta - */ -export interface MultiHostSourcesManagerCorrelationRuleBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesManagerCorrelationRuleBeta - */ - 'type'?: MultiHostSourcesManagerCorrelationRuleBetaTypeBeta; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostSourcesManagerCorrelationRuleBeta - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesManagerCorrelationRuleBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesManagerCorrelationRuleBetaTypeBeta = { - Rule: 'RULE' -} as const; - -export type MultiHostSourcesManagerCorrelationRuleBetaTypeBeta = typeof MultiHostSourcesManagerCorrelationRuleBetaTypeBeta[keyof typeof MultiHostSourcesManagerCorrelationRuleBetaTypeBeta]; - -/** - * - * @export - * @interface MultiHostSourcesPasswordPoliciesInnerBeta - */ -export interface MultiHostSourcesPasswordPoliciesInnerBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesPasswordPoliciesInnerBeta - */ - 'type'?: MultiHostSourcesPasswordPoliciesInnerBetaTypeBeta; - /** - * Policy ID. - * @type {string} - * @memberof MultiHostSourcesPasswordPoliciesInnerBeta - */ - 'id'?: string; - /** - * Policy\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesPasswordPoliciesInnerBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesPasswordPoliciesInnerBetaTypeBeta = { - PasswordPolicy: 'PASSWORD_POLICY' -} as const; - -export type MultiHostSourcesPasswordPoliciesInnerBetaTypeBeta = typeof MultiHostSourcesPasswordPoliciesInnerBetaTypeBeta[keyof typeof MultiHostSourcesPasswordPoliciesInnerBetaTypeBeta]; - -/** - * - * @export - * @interface MultiHostSourcesSchemasInnerBeta - */ -export interface MultiHostSourcesSchemasInnerBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostSourcesSchemasInnerBeta - */ - 'type'?: MultiHostSourcesSchemasInnerBetaTypeBeta; - /** - * Schema ID. - * @type {string} - * @memberof MultiHostSourcesSchemasInnerBeta - */ - 'id'?: string; - /** - * Schema\'s human-readable display name. - * @type {string} - * @memberof MultiHostSourcesSchemasInnerBeta - */ - 'name'?: string; -} - -export const MultiHostSourcesSchemasInnerBetaTypeBeta = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type MultiHostSourcesSchemasInnerBetaTypeBeta = typeof MultiHostSourcesSchemasInnerBetaTypeBeta[keyof typeof MultiHostSourcesSchemasInnerBetaTypeBeta]; - -/** - * - * @export - * @interface MultiPolicyRequestBeta - */ -export interface MultiPolicyRequestBeta { - /** - * Multi-policy report will be run for this list of ids - * @type {Array} - * @memberof MultiPolicyRequestBeta - */ - 'filteredPolicyList'?: Array; -} -/** - * - * @export - * @interface NameNormalizerBeta - */ -export interface NameNormalizerBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof NameNormalizerBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof NameNormalizerBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * | Construct | Date Time Pattern | Description | | --------- | ----------------- | ----------- | | ISO8601 | `yyyy-MM-dd\'T\'HH:mm:ss.SSSX` | The ISO8601 standard. | | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - * @export - * @enum {string} - */ - -export const NamedConstructsBeta = { - Iso8601: 'ISO8601', - Ldap: 'LDAP', - PeopleSoft: 'PEOPLE_SOFT', - EpochTimeJava: 'EPOCH_TIME_JAVA', - EpochTimeWin32: 'EPOCH_TIME_WIN32' -} as const; - -export type NamedConstructsBeta = typeof NamedConstructsBeta[keyof typeof NamedConstructsBeta]; - - -/** - * Source configuration information for Native Change Detection that is read and used by account aggregation process. - * @export - * @interface NativeChangeDetectionConfigBeta - */ -export interface NativeChangeDetectionConfigBeta { - /** - * A flag indicating if Native Change Detection is enabled for a source. - * @type {boolean} - * @memberof NativeChangeDetectionConfigBeta - */ - 'enabled'?: boolean; - /** - * Operation types for which Native Change Detection is enabled for a source. - * @type {Array} - * @memberof NativeChangeDetectionConfigBeta - */ - 'operations'?: Array; - /** - * A flag indicating that all entitlements participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigBeta - */ - 'allEntitlements'?: boolean; - /** - * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigBeta - */ - 'allNonEntitlementAttributes'?: boolean; - /** - * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigBeta - */ - 'selectedEntitlements'?: Array; - /** - * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigBeta - */ - 'selectedNonEntitlementAttributes'?: Array; -} - -export const NativeChangeDetectionConfigBetaOperationsBeta = { - AccountUpdated: 'ACCOUNT_UPDATED', - AccountCreated: 'ACCOUNT_CREATED', - AccountDeleted: 'ACCOUNT_DELETED' -} as const; - -export type NativeChangeDetectionConfigBetaOperationsBeta = typeof NativeChangeDetectionConfigBetaOperationsBeta[keyof typeof NativeChangeDetectionConfigBetaOperationsBeta]; - -/** - * - * @export - * @interface NonEmployeeApprovalDecisionBeta - */ -export interface NonEmployeeApprovalDecisionBeta { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeApprovalDecisionBeta - */ - 'comment'?: string; -} -/** - * - * @export - * @interface NonEmployeeApprovalItemBaseBeta - */ -export interface NonEmployeeApprovalItemBaseBeta { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'id'?: string; - /** - * - * @type {IdentityReferenceWithIdBeta} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'approver'?: IdentityReferenceWithIdBeta; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusBeta} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'approvalStatus'?: ApprovalStatusBeta; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseBeta - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemBeta - */ -export interface NonEmployeeApprovalItemBeta { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBeta - */ - 'id'?: string; - /** - * - * @type {IdentityReferenceWithIdBeta} - * @memberof NonEmployeeApprovalItemBeta - */ - 'approver'?: IdentityReferenceWithIdBeta; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBeta - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusBeta} - * @memberof NonEmployeeApprovalItemBeta - */ - 'approvalStatus'?: ApprovalStatusBeta; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBeta - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBeta - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBeta - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestLiteBeta} - * @memberof NonEmployeeApprovalItemBeta - */ - 'nonEmployeeRequest'?: NonEmployeeRequestLiteBeta; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemDetailBeta - */ -export interface NonEmployeeApprovalItemDetailBeta { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'id'?: string; - /** - * - * @type {IdentityReferenceWithIdBeta} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'approver'?: IdentityReferenceWithIdBeta; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusBeta} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'approvalStatus'?: ApprovalStatusBeta; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestWithoutApprovalItemBeta} - * @memberof NonEmployeeApprovalItemDetailBeta - */ - 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItemBeta; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalSummaryBeta - */ -export interface NonEmployeeApprovalSummaryBeta { - /** - * The number of approved non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryBeta - */ - 'approved'?: number; - /** - * The number of pending non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryBeta - */ - 'pending'?: number; - /** - * The number of rejected non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryBeta - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface NonEmployeeBulkUploadJobBeta - */ -export interface NonEmployeeBulkUploadJobBeta { - /** - * The bulk upload job\'s ID. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobBeta - */ - 'id'?: string; - /** - * The ID of the source to bulk-upload non-employees to. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobBeta - */ - 'sourceId'?: string; - /** - * The date-time the job was submitted. - * @type {string} - * @memberof NonEmployeeBulkUploadJobBeta - */ - 'created'?: string; - /** - * The date-time that the job was last updated. - * @type {string} - * @memberof NonEmployeeBulkUploadJobBeta - */ - 'modified'?: string; - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. - * @type {string} - * @memberof NonEmployeeBulkUploadJobBeta - */ - 'status'?: NonEmployeeBulkUploadJobBetaStatusBeta; -} - -export const NonEmployeeBulkUploadJobBetaStatusBeta = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadJobBetaStatusBeta = typeof NonEmployeeBulkUploadJobBetaStatusBeta[keyof typeof NonEmployeeBulkUploadJobBetaStatusBeta]; - -/** - * - * @export - * @interface NonEmployeeBulkUploadStatusBeta - */ -export interface NonEmployeeBulkUploadStatusBeta { - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. - * @type {string} - * @memberof NonEmployeeBulkUploadStatusBeta - */ - 'status'?: NonEmployeeBulkUploadStatusBetaStatusBeta | null; -} - -export const NonEmployeeBulkUploadStatusBetaStatusBeta = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadStatusBetaStatusBeta = typeof NonEmployeeBulkUploadStatusBetaStatusBeta[keyof typeof NonEmployeeBulkUploadStatusBetaStatusBeta]; - -/** - * - * @export - * @interface NonEmployeeIdnUserRequestBeta - */ -export interface NonEmployeeIdnUserRequestBeta { - /** - * Identity id. - * @type {string} - * @memberof NonEmployeeIdnUserRequestBeta - */ - 'id': string; -} -/** - * - * @export - * @interface NonEmployeeRecordBeta - */ -export interface NonEmployeeRecordBeta { - /** - * Non-Employee record id. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'id'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'manager'?: string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'sourceId'?: string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRecordBeta - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRecordBeta - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeRejectApprovalDecisionBeta - */ -export interface NonEmployeeRejectApprovalDecisionBeta { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeRejectApprovalDecisionBeta - */ - 'comment': string; -} -/** - * - * @export - * @interface NonEmployeeRequestBeta - */ -export interface NonEmployeeRequestBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'description'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteBeta} - * @memberof NonEmployeeRequestBeta - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteBeta; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBeta - */ - 'data'?: { [key: string]: string; }; - /** - * List of approval item for the request - * @type {Array} - * @memberof NonEmployeeRequestBeta - */ - 'approvalItems'?: Array; - /** - * - * @type {ApprovalStatusBeta} - * @memberof NonEmployeeRequestBeta - */ - 'approvalStatus'?: ApprovalStatusBeta; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestBeta - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeRequestBodyBeta - */ -export interface NonEmployeeRequestBodyBeta { - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'accountName': string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'firstName': string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'lastName': string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'email': string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'phone': string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'manager': string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'sourceId': string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBodyBeta - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'startDate': string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBodyBeta - */ - 'endDate': string; -} -/** - * - * @export - * @interface NonEmployeeRequestLiteBeta - */ -export interface NonEmployeeRequestLiteBeta { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestLiteBeta - */ - 'id'?: string; - /** - * - * @type {IdentityReferenceWithIdBeta} - * @memberof NonEmployeeRequestLiteBeta - */ - 'requester'?: IdentityReferenceWithIdBeta; -} -/** - * - * @export - * @interface NonEmployeeRequestSummaryBeta - */ -export interface NonEmployeeRequestSummaryBeta { - /** - * The number of approved non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryBeta - */ - 'approved'?: number; - /** - * The number of rejected non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryBeta - */ - 'rejected'?: number; - /** - * The number of pending non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryBeta - */ - 'pending'?: number; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryBeta - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NonEmployeeRequestWithoutApprovalItemBeta - */ -export interface NonEmployeeRequestWithoutApprovalItemBeta { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'id'?: string; - /** - * - * @type {IdentityReferenceWithIdBeta} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'requester'?: IdentityReferenceWithIdBeta; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteWithSchemaAttributesBeta} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributesBeta; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'data'?: { [key: string]: string; }; - /** - * - * @type {ApprovalStatusBeta} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'approvalStatus'?: ApprovalStatusBeta; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemBeta - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBeta - */ -export interface NonEmployeeSchemaAttributeBeta { - /** - * Schema Attribute Id - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'id'?: string; - /** - * True if this schema attribute is mandatory on all non-employees sources. - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'system'?: boolean; - /** - * When the schema attribute was last modified. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'modified'?: string; - /** - * When the schema attribute was created. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'created'?: string; - /** - * - * @type {NonEmployeeSchemaAttributeTypeBeta} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'type': NonEmployeeSchemaAttributeTypeBeta; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'helpText'?: string | null; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'placeholder'?: string | null; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBeta - */ - 'required'?: boolean; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBodyBeta - */ -export interface NonEmployeeSchemaAttributeBodyBeta { - /** - * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'type': string; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBodyBeta - */ - 'required'?: boolean; -} -/** - * Enum representing the type of data a schema attribute accepts. - * @export - * @enum {string} - */ - -export const NonEmployeeSchemaAttributeTypeBeta = { - Text: 'TEXT', - Date: 'DATE', - Identity: 'IDENTITY', - Phone: 'PHONE', - Email: 'EMAIL' -} as const; - -export type NonEmployeeSchemaAttributeTypeBeta = typeof NonEmployeeSchemaAttributeTypeBeta[keyof typeof NonEmployeeSchemaAttributeTypeBeta]; - - -/** - * - * @export - * @interface NonEmployeeSourceBeta - */ -export interface NonEmployeeSourceBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceBeta - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceBeta - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceBeta - */ - 'created'?: string; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeSourceBeta - */ - 'nonEmployeeCount'?: number | null; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteBeta - */ -export interface NonEmployeeSourceLiteBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteBeta - */ - 'description'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteWithSchemaAttributesBeta - */ -export interface NonEmployeeSourceLiteWithSchemaAttributesBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesBeta - */ - 'description'?: string; - /** - * List of schema attributes associated with this non-employee source. - * @type {Array} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesBeta - */ - 'schemaAttributes'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceRequestBodyBeta - */ -export interface NonEmployeeSourceRequestBodyBeta { - /** - * Name of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'name': string; - /** - * Description of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'description': string; - /** - * - * @type {NonEmployeeIdnUserRequestBeta} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'owner': NonEmployeeIdnUserRequestBeta; - /** - * The ID for the management workgroup that contains source sub-admins - * @type {string} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'managementWorkgroup'?: string; - /** - * List of approvers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'approvers'?: Array; - /** - * List of account managers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyBeta - */ - 'accountManagers'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceWithCloudExternalIdBeta - */ -export interface NonEmployeeSourceWithCloudExternalIdBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'created'?: string; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'nonEmployeeCount'?: number | null; - /** - * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdBeta - */ - 'cloudExternalId'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithNECountBeta - */ -export interface NonEmployeeSourceWithNECountBeta { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'created'?: string; - /** - * Number of non-employee records associated with this source. This value is \'null\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. - * @type {number} - * @memberof NonEmployeeSourceWithNECountBeta - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NotificationTemplateContextBeta - */ -export interface NotificationTemplateContextBeta { - /** - * A JSON object that stores the context. - * @type {{ [key: string]: any; }} - * @memberof NotificationTemplateContextBeta - */ - 'attributes'?: { [key: string]: any; }; - /** - * When the global context was created - * @type {string} - * @memberof NotificationTemplateContextBeta - */ - 'created'?: string; - /** - * When the global context was last modified - * @type {string} - * @memberof NotificationTemplateContextBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface ObjectExportImportOptionsBeta - */ -export interface ObjectExportImportOptionsBeta { - /** - * Object ids to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsBeta - */ - 'includedIds'?: Array; - /** - * Object names to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsBeta - */ - 'includedNames'?: Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResultBeta - */ -export interface ObjectImportResultBeta { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultBeta - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultBeta - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultBeta - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResultBeta - */ - 'importedObjects': Array; -} -/** - * - * @export - * @interface OktaVerificationRequestBeta - */ -export interface OktaVerificationRequestBeta { - /** - * User identifier for Verification request. The value of the user\'s attribute. - * @type {string} - * @memberof OktaVerificationRequestBeta - */ - 'userId': string; -} -/** - * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users - * @export - * @interface OrgConfigBeta - */ -export interface OrgConfigBeta { - /** - * The name of the org. - * @type {string} - * @memberof OrgConfigBeta - */ - 'orgName'?: string; - /** - * The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones - * @type {string} - * @memberof OrgConfigBeta - */ - 'timeZone'?: string; - /** - * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. - * @type {boolean} - * @memberof OrgConfigBeta - */ - 'lcsChangeHonorsSourceEnableFeature'?: boolean; - /** - * ARM Customer ID - * @type {string} - * @memberof OrgConfigBeta - */ - 'armCustomerId'?: string | null; - /** - * A list of IDN::sourceId to ARM::systemId mappings. - * @type {string} - * @memberof OrgConfigBeta - */ - 'armSapSystemIdMappings'?: string | null; - /** - * ARM authentication string - * @type {string} - * @memberof OrgConfigBeta - */ - 'armAuth'?: string | null; - /** - * ARM database name - * @type {string} - * @memberof OrgConfigBeta - */ - 'armDb'?: string | null; - /** - * ARM SSO URL - * @type {string} - * @memberof OrgConfigBeta - */ - 'armSsoUrl'?: string | null; - /** - * Flag to determine whether IAI Certification Recommendations are enabled for the current org - * @type {boolean} - * @memberof OrgConfigBeta - */ - 'iaiEnableCertificationRecommendations'?: boolean; - /** - * - * @type {Array} - * @memberof OrgConfigBeta - */ - 'sodReportConfigs'?: Array; -} -/** - * - * @export - * @interface OutlierBeta - */ -export interface OutlierBeta { - /** - * The identity\'s unique identifier for the outlier record - * @type {string} - * @memberof OutlierBeta - */ - 'id'?: string; - /** - * The ID of the identity that is detected as an outlier - * @type {string} - * @memberof OutlierBeta - */ - 'identityId'?: string; - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierBeta - */ - 'type'?: OutlierBetaTypeBeta; - /** - * The first date the outlier was detected - * @type {string} - * @memberof OutlierBeta - */ - 'firstDetectionDate'?: string; - /** - * The most recent date the outlier was detected - * @type {string} - * @memberof OutlierBeta - */ - 'latestDetectionDate'?: string; - /** - * Flag whether or not the outlier has been ignored - * @type {boolean} - * @memberof OutlierBeta - */ - 'ignored'?: boolean; - /** - * Object containing mapped identity attributes - * @type {object} - * @memberof OutlierBeta - */ - 'attributes'?: object; - /** - * The outlier score determined by the detection engine ranging from 0..1 - * @type {number} - * @memberof OutlierBeta - */ - 'score'?: number; - /** - * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored - * @type {string} - * @memberof OutlierBeta - */ - 'unignoreType'?: OutlierBetaUnignoreTypeBeta | null; - /** - * shows date when last time has been unignored outlier - * @type {string} - * @memberof OutlierBeta - */ - 'unignoreDate'?: string | null; - /** - * shows date when last time has been ignored outlier - * @type {string} - * @memberof OutlierBeta - */ - 'ignoreDate'?: string | null; -} - -export const OutlierBetaTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierBetaTypeBeta = typeof OutlierBetaTypeBeta[keyof typeof OutlierBetaTypeBeta]; -export const OutlierBetaUnignoreTypeBeta = { - Manual: 'MANUAL', - Automatic: 'AUTOMATIC' -} as const; - -export type OutlierBetaUnignoreTypeBeta = typeof OutlierBetaUnignoreTypeBeta[keyof typeof OutlierBetaUnignoreTypeBeta]; - -/** - * - * @export - * @interface OutlierContributingFeatureBeta - */ -export interface OutlierContributingFeatureBeta { - /** - * Contributing feature id - * @type {string} - * @memberof OutlierContributingFeatureBeta - */ - 'id'?: string; - /** - * The name of the feature - * @type {string} - * @memberof OutlierContributingFeatureBeta - */ - 'name'?: string; - /** - * The data type of the value field - * @type {string} - * @memberof OutlierContributingFeatureBeta - */ - 'valueType'?: OutlierContributingFeatureBetaValueTypeBeta; - /** - * - * @type {OutlierContributingFeatureValueBeta} - * @memberof OutlierContributingFeatureBeta - */ - 'value'?: OutlierContributingFeatureValueBeta; - /** - * The importance of the feature. This can also be a negative value - * @type {number} - * @memberof OutlierContributingFeatureBeta - */ - 'importance'?: number; - /** - * The (translated if header is passed) displayName for the feature - * @type {string} - * @memberof OutlierContributingFeatureBeta - */ - 'displayName'?: string; - /** - * The (translated if header is passed) description for the feature - * @type {string} - * @memberof OutlierContributingFeatureBeta - */ - 'description'?: string; - /** - * - * @type {OutlierFeatureTranslationBeta} - * @memberof OutlierContributingFeatureBeta - */ - 'translationMessages'?: OutlierFeatureTranslationBeta; -} - -export const OutlierContributingFeatureBetaValueTypeBeta = { - Integer: 'INTEGER', - Float: 'FLOAT' -} as const; - -export type OutlierContributingFeatureBetaValueTypeBeta = typeof OutlierContributingFeatureBetaValueTypeBeta[keyof typeof OutlierContributingFeatureBetaValueTypeBeta]; - -/** - * @type OutlierContributingFeatureValueBeta - * The feature value - * @export - */ -export type OutlierContributingFeatureValueBeta = number; - -/** - * - * @export - * @interface OutlierFeatureSummaryBeta - */ -export interface OutlierFeatureSummaryBeta { - /** - * Contributing feature name - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'contributingFeatureName'?: string; - /** - * Identity display name - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'identityOutlierDisplayName'?: string; - /** - * - * @type {Array} - * @memberof OutlierFeatureSummaryBeta - */ - 'outlierFeatureDisplayValues'?: Array; - /** - * Definition of the feature - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'featureDefinition'?: string; - /** - * Detailed explanation of the feature - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'featureExplanation'?: string; - /** - * outlier\'s peer identity display name - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'peerDisplayName'?: string; - /** - * outlier\'s peer identity id - * @type {string} - * @memberof OutlierFeatureSummaryBeta - */ - 'peerIdentityId'?: string; - /** - * Access Item reference - * @type {object} - * @memberof OutlierFeatureSummaryBeta - */ - 'accessItemReference'?: object; -} -/** - * - * @export - * @interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBeta - */ -export interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBeta { - /** - * display name - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBeta - */ - 'displayName'?: string; - /** - * value - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBeta - */ - 'value'?: string; - /** - * The data type of the value field - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBeta - */ - 'valueType'?: OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBetaValueTypeBeta; -} - -export const OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBetaValueTypeBeta = { - Integer: 'INTEGER', - Float: 'FLOAT' -} as const; - -export type OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBetaValueTypeBeta = typeof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBetaValueTypeBeta[keyof typeof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerBetaValueTypeBeta]; - -/** - * - * @export - * @interface OutlierFeatureTranslationBeta - */ -export interface OutlierFeatureTranslationBeta { - /** - * - * @type {TranslationMessageBeta} - * @memberof OutlierFeatureTranslationBeta - */ - 'displayName'?: TranslationMessageBeta; - /** - * - * @type {TranslationMessageBeta} - * @memberof OutlierFeatureTranslationBeta - */ - 'description'?: TranslationMessageBeta; -} -/** - * - * @export - * @interface OutlierSummaryBeta - */ -export interface OutlierSummaryBeta { - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierSummaryBeta - */ - 'type'?: OutlierSummaryBetaTypeBeta; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof OutlierSummaryBeta - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof OutlierSummaryBeta - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof OutlierSummaryBeta - */ - 'totalIdentities'?: number; - /** - * - * @type {number} - * @memberof OutlierSummaryBeta - */ - 'totalIgnored'?: number; -} - -export const OutlierSummaryBetaTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierSummaryBetaTypeBeta = typeof OutlierSummaryBetaTypeBeta[keyof typeof OutlierSummaryBetaTypeBeta]; - -/** - * - * @export - * @interface OutliersContributingFeatureAccessItemsBeta - */ -export interface OutliersContributingFeatureAccessItemsBeta { - /** - * The ID of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'id'?: string; - /** - * the display name of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'displayName'?: string; - /** - * Description of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'description'?: string; - /** - * The type of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'accessType'?: OutliersContributingFeatureAccessItemsBetaAccessTypeBeta; - /** - * the associated source name if it exists - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'sourceName'?: string; - /** - * rarest access - * @type {boolean} - * @memberof OutliersContributingFeatureAccessItemsBeta - */ - 'extremelyRare'?: boolean; -} - -export const OutliersContributingFeatureAccessItemsBetaAccessTypeBeta = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type OutliersContributingFeatureAccessItemsBetaAccessTypeBeta = typeof OutliersContributingFeatureAccessItemsBetaAccessTypeBeta[keyof typeof OutliersContributingFeatureAccessItemsBetaAccessTypeBeta]; - -/** - * Owner\'s identity. - * @export - * @interface OwnerDtoBeta - */ -export interface OwnerDtoBeta { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof OwnerDtoBeta - */ - 'type'?: OwnerDtoBetaTypeBeta; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerDtoBeta - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof OwnerDtoBeta - */ - 'name'?: string; -} - -export const OwnerDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type OwnerDtoBetaTypeBeta = typeof OwnerDtoBetaTypeBeta[keyof typeof OwnerDtoBetaTypeBeta]; - -/** - * Owner of the object. - * @export - * @interface OwnerReferenceBeta - */ -export interface OwnerReferenceBeta { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceBeta - */ - 'type'?: OwnerReferenceBetaTypeBeta; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerReferenceBeta - */ - 'id'?: string; - /** - * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceBeta - */ - 'name'?: string; -} - -export const OwnerReferenceBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceBetaTypeBeta = typeof OwnerReferenceBetaTypeBeta[keyof typeof OwnerReferenceBetaTypeBeta]; - -/** - * Simplified DTO for the owner object of the entitlement - * @export - * @interface OwnerReferenceDtoBeta - */ -export interface OwnerReferenceDtoBeta { - /** - * The owner id for the entitlement - * @type {string} - * @memberof OwnerReferenceDtoBeta - */ - 'id'?: string; - /** - * The owner name for the entitlement - * @type {string} - * @memberof OwnerReferenceDtoBeta - */ - 'name'?: string; - /** - * The type of the owner. Initially only type IDENTITY is supported - * @type {string} - * @memberof OwnerReferenceDtoBeta - */ - 'type'?: OwnerReferenceDtoBetaTypeBeta; -} - -export const OwnerReferenceDtoBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceDtoBetaTypeBeta = typeof OwnerReferenceDtoBetaTypeBeta[keyof typeof OwnerReferenceDtoBetaTypeBeta]; - -/** - * The owner of this object. - * @export - * @interface OwnerReferenceSegmentsBeta - */ -export interface OwnerReferenceSegmentsBeta { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsBeta - */ - 'type'?: OwnerReferenceSegmentsBetaTypeBeta; - /** - * Identity id - * @type {string} - * @memberof OwnerReferenceSegmentsBeta - */ - 'id'?: string; - /** - * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsBeta - */ - 'name'?: string; -} - -export const OwnerReferenceSegmentsBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceSegmentsBetaTypeBeta = typeof OwnerReferenceSegmentsBetaTypeBeta[keyof typeof OwnerReferenceSegmentsBetaTypeBeta]; - -/** - * - * @export - * @interface PasswordChangeRequestBeta - */ -export interface PasswordChangeRequestBeta { - /** - * The identity ID that requested the password change - * @type {string} - * @memberof PasswordChangeRequestBeta - */ - 'identityId'?: string; - /** - * The RSA encrypted password - * @type {string} - * @memberof PasswordChangeRequestBeta - */ - 'encryptedPassword'?: string; - /** - * The encryption key ID - * @type {string} - * @memberof PasswordChangeRequestBeta - */ - 'publicKeyId'?: string; - /** - * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordChangeRequestBeta - */ - 'accountId'?: string; - /** - * The ID of the source for which identity is requesting the password change - * @type {string} - * @memberof PasswordChangeRequestBeta - */ - 'sourceId'?: string; -} -/** - * - * @export - * @interface PasswordChangeResponseBeta - */ -export interface PasswordChangeResponseBeta { - /** - * The password change request ID - * @type {string} - * @memberof PasswordChangeResponseBeta - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordChangeResponseBeta - */ - 'state'?: PasswordChangeResponseBetaStateBeta; -} - -export const PasswordChangeResponseBetaStateBeta = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordChangeResponseBetaStateBeta = typeof PasswordChangeResponseBetaStateBeta[keyof typeof PasswordChangeResponseBetaStateBeta]; - -/** - * - * @export - * @interface PasswordDigitTokenBeta - */ -export interface PasswordDigitTokenBeta { - /** - * The digit token for password management - * @type {string} - * @memberof PasswordDigitTokenBeta - */ - 'digitToken'?: string; - /** - * The reference ID of the digit token generation request - * @type {string} - * @memberof PasswordDigitTokenBeta - */ - 'requestId'?: string; -} -/** - * - * @export - * @interface PasswordDigitTokenResetBeta - */ -export interface PasswordDigitTokenResetBeta { - /** - * The uid of the user requested for digit token - * @type {string} - * @memberof PasswordDigitTokenResetBeta - */ - 'userId': string; - /** - * The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. - * @type {number} - * @memberof PasswordDigitTokenResetBeta - */ - 'length'?: number; - /** - * The time to live for the digit token in minutes. The default value is 5 minutes. - * @type {number} - * @memberof PasswordDigitTokenResetBeta - */ - 'durationMinutes'?: number; -} -/** - * - * @export - * @interface PasswordInfoAccountBeta - */ -export interface PasswordInfoAccountBeta { - /** - * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordInfoAccountBeta - */ - 'accountId'?: string; - /** - * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - * @type {string} - * @memberof PasswordInfoAccountBeta - */ - 'accountName'?: string; -} -/** - * - * @export - * @interface PasswordInfoBeta - */ -export interface PasswordInfoBeta { - /** - * - * @type {string} - * @memberof PasswordInfoBeta - */ - 'identityId'?: string; - /** - * - * @type {string} - * @memberof PasswordInfoBeta - */ - 'sourceId'?: string; - /** - * - * @type {string} - * @memberof PasswordInfoBeta - */ - 'publicKeyId'?: string; - /** - * User\'s public key with Base64 encoding - * @type {string} - * @memberof PasswordInfoBeta - */ - 'publicKey'?: string; - /** - * Account info related to queried identity and source - * @type {Array} - * @memberof PasswordInfoBeta - */ - 'accounts'?: Array; - /** - * Password constraints - * @type {Array} - * @memberof PasswordInfoBeta - */ - 'policies'?: Array; -} -/** - * - * @export - * @interface PasswordInfoQueryDTOBeta - */ -export interface PasswordInfoQueryDTOBeta { - /** - * The login name of the user - * @type {string} - * @memberof PasswordInfoQueryDTOBeta - */ - 'userName'?: string; - /** - * The display name of the source - * @type {string} - * @memberof PasswordInfoQueryDTOBeta - */ - 'sourceName'?: string; -} -/** - * - * @export - * @interface PasswordOrgConfigBeta - */ -export interface PasswordOrgConfigBeta { - /** - * Indicator whether custom password instructions feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigBeta - */ - 'customInstructionsEnabled'?: boolean; - /** - * Indicator whether \"digit token\" feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigBeta - */ - 'digitTokenEnabled'?: boolean; - /** - * The duration of \"digit token\" in minutes. The default value is 5. - * @type {number} - * @memberof PasswordOrgConfigBeta - */ - 'digitTokenDurationMinutes'?: number; - /** - * The length of \"digit token\". The default value is 6. - * @type {number} - * @memberof PasswordOrgConfigBeta - */ - 'digitTokenLength'?: number; -} -/** - * - * @export - * @interface PasswordPolicyV3DtoBeta - */ -export interface PasswordPolicyV3DtoBeta { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'id'?: string; - /** - * Description for current password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'description'?: string | null; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'name'?: string; - /** - * Date the Password Policy was created. - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'dateCreated'?: string; - /** - * Date the Password Policy was updated. - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'lastUpdated'?: string | null; - /** - * The number of days before expiration remaninder. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'firstExpirationReminder'?: number; - /** - * The minimun length of account Id. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'accountIdMinWordLength'?: number; - /** - * The minimun length of account name. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'accountNameMinWordLength'?: number; - /** - * Maximum alpha. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minAlpha'?: number; - /** - * MinCharacterTypes. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minCharacterTypes'?: number; - /** - * Maximum length of the password. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'maxLength'?: number; - /** - * Minimum length of the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minLength'?: number; - /** - * Maximum repetition of the same character in the password. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'maxRepeatedChars'?: number; - /** - * Minimum amount of lower case character in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minLower'?: number; - /** - * Minimum amount of numeric characters in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minNumeric'?: number; - /** - * Minimum amount of special symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minSpecial'?: number; - /** - * Minimum amount of upper case symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'minUpper'?: number; - /** - * Number of days before current password expires. By default is equals to 90. - * @type {number} - * @memberof PasswordPolicyV3DtoBeta - */ - 'passwordExpiration'?: number; - /** - * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'defaultPolicy'?: boolean; - /** - * Defines whether this policy is enabled to expire or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'enablePasswdExpiration'?: boolean; - /** - * Defines whether this policy require strong Auth or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'requireStrongAuthn'?: boolean; - /** - * Defines whether this policy require strong Auth of network or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'requireStrongAuthOffNetwork'?: boolean; - /** - * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'requireStrongAuthUntrustedGeographies'?: boolean; - /** - * Defines whether this policy uses account attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'useAccountAttributes'?: boolean; - /** - * Defines whether this policy uses dictionary or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'useDictionary'?: boolean; - /** - * Defines whether this policy uses identity attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'useIdentityAttributes'?: boolean; - /** - * Defines whether this policy validate against account id or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'validateAgainstAccountId'?: boolean; - /** - * Defines whether this policy validate against account name or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoBeta - */ - 'validateAgainstAccountName'?: boolean; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'created'?: string | null; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoBeta - */ - 'modified'?: string | null; - /** - * List of sources IDs managed by this password policy. - * @type {Array} - * @memberof PasswordPolicyV3DtoBeta - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface PasswordStatusBeta - */ -export interface PasswordStatusBeta { - /** - * The password change request ID - * @type {string} - * @memberof PasswordStatusBeta - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordStatusBeta - */ - 'state'?: PasswordStatusBetaStateBeta; - /** - * The errors during the password change request - * @type {Array} - * @memberof PasswordStatusBeta - */ - 'errors'?: Array; - /** - * List of source IDs in the password change request - * @type {Array} - * @memberof PasswordStatusBeta - */ - 'sourceIds'?: Array; -} - -export const PasswordStatusBetaStateBeta = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordStatusBetaStateBeta = typeof PasswordStatusBetaStateBeta[keyof typeof PasswordStatusBetaStateBeta]; - -/** - * - * @export - * @interface PasswordSyncGroupBeta - */ -export interface PasswordSyncGroupBeta { - /** - * ID of the sync group - * @type {string} - * @memberof PasswordSyncGroupBeta - */ - 'id'?: string; - /** - * Name of the sync group - * @type {string} - * @memberof PasswordSyncGroupBeta - */ - 'name'?: string; - /** - * ID of the password policy - * @type {string} - * @memberof PasswordSyncGroupBeta - */ - 'passwordPolicyId'?: string; - /** - * List of password managed sources IDs - * @type {Array} - * @memberof PasswordSyncGroupBeta - */ - 'sourceIds'?: Array; - /** - * The date and time this sync group was created - * @type {string} - * @memberof PasswordSyncGroupBeta - */ - 'created'?: string | null; - /** - * The date and time this sync group was last modified - * @type {string} - * @memberof PasswordSyncGroupBeta - */ - 'modified'?: string | null; -} -/** - * Personal access token owner\'s identity. - * @export - * @interface PatOwnerBeta - */ -export interface PatOwnerBeta { - /** - * Personal access token owner\'s DTO type. - * @type {string} - * @memberof PatOwnerBeta - */ - 'type'?: PatOwnerBetaTypeBeta; - /** - * Personal access token owner\'s identity ID. - * @type {string} - * @memberof PatOwnerBeta - */ - 'id'?: string; - /** - * Personal access token owner\'s human-readable display name. - * @type {string} - * @memberof PatOwnerBeta - */ - 'name'?: string; -} - -export const PatOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type PatOwnerBetaTypeBeta = typeof PatOwnerBetaTypeBeta[keyof typeof PatOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface PeerGroupMemberBeta - */ -export interface PeerGroupMemberBeta { - /** - * A unique identifier for the peer group member. - * @type {string} - * @memberof PeerGroupMemberBeta - */ - 'id'?: string; - /** - * The type of the peer group member. - * @type {string} - * @memberof PeerGroupMemberBeta - */ - 'type'?: string; - /** - * The ID of the peer group. - * @type {string} - * @memberof PeerGroupMemberBeta - */ - 'peer_group_id'?: string; - /** - * Arbitrary key-value pairs, belonging to the peer group member. - * @type {{ [key: string]: object; }} - * @memberof PeerGroupMemberBeta - */ - 'attributes'?: { [key: string]: object; }; -} -/** - * Enum represents action that is being processed on an approval. - * @export - * @enum {string} - */ - -export const PendingApprovalActionBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Forwarded: 'FORWARDED' -} as const; - -export type PendingApprovalActionBeta = typeof PendingApprovalActionBeta[keyof typeof PendingApprovalActionBeta]; - - -/** - * - * @export - * @interface PendingApprovalBeta - */ -export interface PendingApprovalBeta { - /** - * The approval id. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeBeta} - * @memberof PendingApprovalBeta - */ - 'requestType'?: AccessRequestTypeBeta | null; - /** - * - * @type {AccessItemRequesterDtoBeta} - * @memberof PendingApprovalBeta - */ - 'requester'?: AccessItemRequesterDtoBeta; - /** - * - * @type {AccessItemRequestedForDtoBeta} - * @memberof PendingApprovalBeta - */ - 'requestedFor'?: AccessItemRequestedForDtoBeta; - /** - * - * @type {AccessItemOwnerDtoBeta} - * @memberof PendingApprovalBeta - */ - 'owner'?: AccessItemOwnerDtoBeta; - /** - * - * @type {RequestableObjectReferenceBeta} - * @memberof PendingApprovalBeta - */ - 'requestedObject'?: RequestableObjectReferenceBeta; - /** - * - * @type {CommentDto1Beta} - * @memberof PendingApprovalBeta - */ - 'requesterComment'?: CommentDto1Beta; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof PendingApprovalBeta - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof PendingApprovalBeta - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof PendingApprovalBeta - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {PendingApprovalActionBeta} - * @memberof PendingApprovalBeta - */ - 'actionInProcess'?: PendingApprovalActionBeta; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'removeDate'?: string; - /** - * If true, then the request is to change the remove date or sunset date. - * @type {boolean} - * @memberof PendingApprovalBeta - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'currentRemoveDate'?: string; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof PendingApprovalBeta - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompleted2Beta} - * @memberof PendingApprovalBeta - */ - 'sodViolationContext'?: SodViolationContextCheckCompleted2Beta | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof PendingApprovalBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof PendingApprovalBeta - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof PendingApprovalBeta - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationBeta} - * @memberof PendingApprovalBeta - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationBeta | null; -} - - -/** - * The maximum duration for which the access is permitted. - * @export - * @interface PendingApprovalMaxPermittedAccessDurationBeta - */ -export interface PendingApprovalMaxPermittedAccessDurationBeta { - /** - * The numeric value of the duration. - * @type {number} - * @memberof PendingApprovalMaxPermittedAccessDurationBeta - */ - 'value'?: number; - /** - * The time unit for the duration. - * @type {string} - * @memberof PendingApprovalMaxPermittedAccessDurationBeta - */ - 'timeUnit'?: PendingApprovalMaxPermittedAccessDurationBetaTimeUnitBeta; -} - -export const PendingApprovalMaxPermittedAccessDurationBetaTimeUnitBeta = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type PendingApprovalMaxPermittedAccessDurationBetaTimeUnitBeta = typeof PendingApprovalMaxPermittedAccessDurationBetaTimeUnitBeta[keyof typeof PendingApprovalMaxPermittedAccessDurationBetaTimeUnitBeta]; - -/** - * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - * @export - * @interface PermissionDtoBeta - */ -export interface PermissionDtoBeta { - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof PermissionDtoBeta - */ - 'rights'?: Array; - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof PermissionDtoBeta - */ - 'target'?: string; -} -/** - * - * @export - * @interface PostExternalExecuteWorkflow200ResponseBeta - */ -export interface PostExternalExecuteWorkflow200ResponseBeta { - /** - * The workflow execution id - * @type {string} - * @memberof PostExternalExecuteWorkflow200ResponseBeta - */ - 'workflowExecutionId'?: string; - /** - * An error message if any errors occurred - * @type {string} - * @memberof PostExternalExecuteWorkflow200ResponseBeta - */ - 'message'?: string; -} -/** - * - * @export - * @interface PostExternalExecuteWorkflowRequestBeta - */ -export interface PostExternalExecuteWorkflowRequestBeta { - /** - * The input for the workflow - * @type {object} - * @memberof PostExternalExecuteWorkflowRequestBeta - */ - 'input'?: object; -} -/** - * Provides additional details about the pre-approval trigger for this request. - * @export - * @interface PreApprovalTriggerDetailsBeta - */ -export interface PreApprovalTriggerDetailsBeta { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsBeta - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsBeta - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof PreApprovalTriggerDetailsBeta - */ - 'decision'?: PreApprovalTriggerDetailsBetaDecisionBeta; -} - -export const PreApprovalTriggerDetailsBetaDecisionBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type PreApprovalTriggerDetailsBetaDecisionBeta = typeof PreApprovalTriggerDetailsBetaDecisionBeta[keyof typeof PreApprovalTriggerDetailsBetaDecisionBeta]; - -/** - * Maps an Identity\'s attribute key to a list of preferred notification mediums. - * @export - * @interface PreferencesDtoBeta - */ -export interface PreferencesDtoBeta { - /** - * The template notification key. - * @type {string} - * @memberof PreferencesDtoBeta - */ - 'key'?: string; - /** - * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - * @type {Array} - * @memberof PreferencesDtoBeta - */ - 'mediums'?: Array; - /** - * Modified date of preference - * @type {string} - * @memberof PreferencesDtoBeta - */ - 'modified'?: string; -} -/** - * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint - * @export - * @interface PreviewDataSourceResponseBeta - */ -export interface PreviewDataSourceResponseBeta { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof PreviewDataSourceResponseBeta - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ProcessIdentitiesRequestBeta - */ -export interface ProcessIdentitiesRequestBeta { - /** - * List of up to 250 identity IDs to process. - * @type {Array} - * @memberof ProcessIdentitiesRequestBeta - */ - 'identityIds'?: Array; -} -/** - * - * @export - * @interface ProductBeta - */ -export interface ProductBeta { - /** - * Name of the Product - * @type {string} - * @memberof ProductBeta - */ - 'productName'?: string; - /** - * URL of the Product - * @type {string} - * @memberof ProductBeta - */ - 'url'?: string; - /** - * An identifier for a specific product-tenant combination - * @type {string} - * @memberof ProductBeta - */ - 'productTenantId'?: string; - /** - * Product region - * @type {string} - * @memberof ProductBeta - */ - 'productRegion'?: string; - /** - * Right needed for the Product - * @type {string} - * @memberof ProductBeta - */ - 'productRight'?: string; - /** - * API URL of the Product - * @type {string} - * @memberof ProductBeta - */ - 'apiUrl'?: string | null; - /** - * - * @type {Array} - * @memberof ProductBeta - */ - 'licenses'?: Array; - /** - * Additional attributes for a product - * @type {{ [key: string]: any; }} - * @memberof ProductBeta - */ - 'attributes'?: { [key: string]: any; }; - /** - * Zone - * @type {string} - * @memberof ProductBeta - */ - 'zone'?: string; - /** - * Status of the product - * @type {string} - * @memberof ProductBeta - */ - 'status'?: string; - /** - * Status datetime - * @type {string} - * @memberof ProductBeta - */ - 'statusDateTime'?: string; - /** - * If there\'s a tenant provisioning failure then reason will have the description of error - * @type {string} - * @memberof ProductBeta - */ - 'reason'?: string; - /** - * Product could have additional notes added during tenant provisioning. - * @type {string} - * @memberof ProductBeta - */ - 'notes'?: string; - /** - * Date when the product was created - * @type {string} - * @memberof ProductBeta - */ - 'dateCreated'?: string | null; - /** - * Date when the product was last updated - * @type {string} - * @memberof ProductBeta - */ - 'lastUpdated'?: string | null; - /** - * Type of org - * @type {string} - * @memberof ProductBeta - */ - 'orgType'?: ProductBetaOrgTypeBeta | null; -} - -export const ProductBetaOrgTypeBeta = { - Development: 'development', - Staging: 'staging', - Production: 'production', - Test: 'test', - Partner: 'partner', - Training: 'training', - Demonstration: 'demonstration', - Sandbox: 'sandbox' -} as const; - -export type ProductBetaOrgTypeBeta = typeof ProductBetaOrgTypeBeta[keyof typeof ProductBetaOrgTypeBeta]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBeta - */ -export interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBeta { - /** - * Name of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBeta - */ - 'attributeName': string; - /** - * Value of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBeta - */ - 'attributeValue'?: string | null; - /** - * The operation to handle the attribute. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBeta - */ - 'operation': ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBetaOperationBeta; -} - -export const ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBetaOperationBeta = { - Add: 'Add', - Set: 'Set', - Remove: 'Remove' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBetaOperationBeta = typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBetaOperationBeta[keyof typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerBetaOperationBeta]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerBeta - */ -export interface ProvisioningCompletedAccountRequestsInnerBeta { - /** - * - * @type {ProvisioningCompletedAccountRequestsInnerSourceBeta} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'source': ProvisioningCompletedAccountRequestsInnerSourceBeta; - /** - * Unique idenfier of the account being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'accountId'?: string; - /** - * Provisioning operation. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'accountOperation': ProvisioningCompletedAccountRequestsInnerBetaAccountOperationBeta; - /** - * Overall result of the provisioning transaction. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'provisioningResult': ProvisioningCompletedAccountRequestsInnerBetaProvisioningResultBeta; - /** - * Nme of the selected provisioning channel selected. This could be the same as the source, or it could be a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'provisioningTarget': string; - /** - * Reference to a tracking number for if this is sent to a SDIM. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'ticketId'?: string | null; - /** - * List of attributes to include in the provisioning transaction. - * @type {Array} - * @memberof ProvisioningCompletedAccountRequestsInnerBeta - */ - 'attributeRequests'?: Array | null; -} - -export const ProvisioningCompletedAccountRequestsInnerBetaAccountOperationBeta = { - Create: 'Create', - Modify: 'Modify', - Enable: 'Enable', - Disable: 'Disable', - Unlock: 'Unlock', - Delete: 'Delete' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerBetaAccountOperationBeta = typeof ProvisioningCompletedAccountRequestsInnerBetaAccountOperationBeta[keyof typeof ProvisioningCompletedAccountRequestsInnerBetaAccountOperationBeta]; -export const ProvisioningCompletedAccountRequestsInnerBetaProvisioningResultBeta = { - Success: 'SUCCESS', - Pending: 'PENDING', - Failed: 'FAILED' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerBetaProvisioningResultBeta = typeof ProvisioningCompletedAccountRequestsInnerBetaProvisioningResultBeta[keyof typeof ProvisioningCompletedAccountRequestsInnerBetaProvisioningResultBeta]; - -/** - * Source that ISC is provisioning access on. - * @export - * @interface ProvisioningCompletedAccountRequestsInnerSourceBeta - */ -export interface ProvisioningCompletedAccountRequestsInnerSourceBeta { - /** - * Source ID. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceBeta - */ - 'id': string; - /** - * Source DTO type. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceBeta - */ - 'type': ProvisioningCompletedAccountRequestsInnerSourceBetaTypeBeta; - /** - * Source name. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceBeta - */ - 'name': string; -} - -export const ProvisioningCompletedAccountRequestsInnerSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerSourceBetaTypeBeta = typeof ProvisioningCompletedAccountRequestsInnerSourceBetaTypeBeta[keyof typeof ProvisioningCompletedAccountRequestsInnerSourceBetaTypeBeta]; - -/** - * - * @export - * @interface ProvisioningCompletedBeta - */ -export interface ProvisioningCompletedBeta { - /** - * Provisioning request\'s reference number. Useful for tracking status in the \'Account Activity\' search interface. - * @type {string} - * @memberof ProvisioningCompletedBeta - */ - 'trackingNumber': string; - /** - * Sources the provisioning transactions were performed on. Sources are comma separated. - * @type {string} - * @memberof ProvisioningCompletedBeta - */ - 'sources': string; - /** - * Origin of the provisioning request. - * @type {string} - * @memberof ProvisioningCompletedBeta - */ - 'action'?: string | null; - /** - * List of any accumulated error messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedBeta - */ - 'errors'?: Array | null; - /** - * List of any accumulated warning messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedBeta - */ - 'warnings'?: Array | null; - /** - * - * @type {ProvisioningCompletedRecipientBeta} - * @memberof ProvisioningCompletedBeta - */ - 'recipient': ProvisioningCompletedRecipientBeta; - /** - * - * @type {ProvisioningCompletedRequesterBeta} - * @memberof ProvisioningCompletedBeta - */ - 'requester'?: ProvisioningCompletedRequesterBeta | null; - /** - * List of provisioning instructions to perform on an account-by-account basis. - * @type {Array} - * @memberof ProvisioningCompletedBeta - */ - 'accountRequests': Array; -} -/** - * Provisioning recpient. - * @export - * @interface ProvisioningCompletedRecipientBeta - */ -export interface ProvisioningCompletedRecipientBeta { - /** - * Provisioning recipient DTO type. - * @type {string} - * @memberof ProvisioningCompletedRecipientBeta - */ - 'type': ProvisioningCompletedRecipientBetaTypeBeta; - /** - * Provisioning recipient\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRecipientBeta - */ - 'id': string; - /** - * Provisioning recipient\'s name. - * @type {string} - * @memberof ProvisioningCompletedRecipientBeta - */ - 'name': string; -} - -export const ProvisioningCompletedRecipientBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRecipientBetaTypeBeta = typeof ProvisioningCompletedRecipientBetaTypeBeta[keyof typeof ProvisioningCompletedRecipientBetaTypeBeta]; - -/** - * Provisioning requester\'s identity. - * @export - * @interface ProvisioningCompletedRequesterBeta - */ -export interface ProvisioningCompletedRequesterBeta { - /** - * Provisioning requester\'s DTO type. - * @type {string} - * @memberof ProvisioningCompletedRequesterBeta - */ - 'type': ProvisioningCompletedRequesterBetaTypeBeta; - /** - * Provisioning requester\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRequesterBeta - */ - 'id': string; - /** - * Provisioning requester\'s name. - * @type {string} - * @memberof ProvisioningCompletedRequesterBeta - */ - 'name': string; -} - -export const ProvisioningCompletedRequesterBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRequesterBetaTypeBeta = typeof ProvisioningCompletedRequesterBetaTypeBeta[keyof typeof ProvisioningCompletedRequesterBetaTypeBeta]; - -/** - * Specification of a Service Desk integration provisioning configuration. - * @export - * @interface ProvisioningConfigBeta - */ -export interface ProvisioningConfigBeta { - /** - * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - * @type {boolean} - * @memberof ProvisioningConfigBeta - */ - 'universalManager'?: boolean; - /** - * References to sources for the Service Desk integration template. May only be specified if universalManager is false. - * @type {Array} - * @memberof ProvisioningConfigBeta - */ - 'managedResourceRefs'?: Array; - /** - * - * @type {ProvisioningConfigPlanInitializerScriptBeta} - * @memberof ProvisioningConfigBeta - */ - 'planInitializerScript'?: ProvisioningConfigPlanInitializerScriptBeta; - /** - * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - * @type {boolean} - * @memberof ProvisioningConfigBeta - */ - 'noProvisioningRequests'?: boolean; - /** - * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - * @type {number} - * @memberof ProvisioningConfigBeta - */ - 'provisioningRequestExpiration'?: number; -} -/** - * - * @export - * @interface ProvisioningConfigManagedResourceRefsInnerBeta - */ -export interface ProvisioningConfigManagedResourceRefsInnerBeta { - /** - * The type of object being referenced - * @type {object} - * @memberof ProvisioningConfigManagedResourceRefsInnerBeta - */ - 'type'?: ProvisioningConfigManagedResourceRefsInnerBetaTypeBeta; - /** - * ID of the source - * @type {object} - * @memberof ProvisioningConfigManagedResourceRefsInnerBeta - */ - 'id'?: object; - /** - * Human-readable display name of the source - * @type {object} - * @memberof ProvisioningConfigManagedResourceRefsInnerBeta - */ - 'name'?: object; -} - -export const ProvisioningConfigManagedResourceRefsInnerBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type ProvisioningConfigManagedResourceRefsInnerBetaTypeBeta = typeof ProvisioningConfigManagedResourceRefsInnerBetaTypeBeta[keyof typeof ProvisioningConfigManagedResourceRefsInnerBetaTypeBeta]; - -/** - * This is a reference to a plan initializer script. - * @export - * @interface ProvisioningConfigPlanInitializerScriptBeta - */ -export interface ProvisioningConfigPlanInitializerScriptBeta { - /** - * This is a Rule that allows provisioning instruction changes. - * @type {string} - * @memberof ProvisioningConfigPlanInitializerScriptBeta - */ - 'source'?: string; -} -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel1Beta - */ -export interface ProvisioningCriteriaLevel1Beta { - /** - * - * @type {ProvisioningCriteriaOperationBeta} - * @memberof ProvisioningCriteriaLevel1Beta - */ - 'operation'?: ProvisioningCriteriaOperationBeta; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel1Beta - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel1Beta - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel1Beta - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel2Beta - */ -export interface ProvisioningCriteriaLevel2Beta { - /** - * - * @type {ProvisioningCriteriaOperationBeta} - * @memberof ProvisioningCriteriaLevel2Beta - */ - 'operation'?: ProvisioningCriteriaOperationBeta; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel2Beta - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel2Beta - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel2Beta - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel3Beta - */ -export interface ProvisioningCriteriaLevel3Beta { - /** - * - * @type {ProvisioningCriteriaOperationBeta} - * @memberof ProvisioningCriteriaLevel3Beta - */ - 'operation'?: ProvisioningCriteriaOperationBeta; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel3Beta - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel3Beta - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {string} - * @memberof ProvisioningCriteriaLevel3Beta - */ - 'children'?: string | null; -} - - -/** - * Supported operations on `ProvisioningCriteria`. - * @export - * @enum {string} - */ - -export const ProvisioningCriteriaOperationBeta = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - Has: 'HAS', - And: 'AND', - Or: 'OR' -} as const; - -export type ProvisioningCriteriaOperationBeta = typeof ProvisioningCriteriaOperationBeta[keyof typeof ProvisioningCriteriaOperationBeta]; - - -/** - * Provides additional details about provisioning for this request. - * @export - * @interface ProvisioningDetailsBeta - */ -export interface ProvisioningDetailsBeta { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof ProvisioningDetailsBeta - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * - * @export - * @interface ProvisioningPolicyDtoBeta - */ -export interface ProvisioningPolicyDtoBeta { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyDtoBeta - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyDtoBeta - */ - 'description'?: string; - /** - * - * @type {UsageTypeBeta} - * @memberof ProvisioningPolicyDtoBeta - */ - 'usageType'?: UsageTypeBeta; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyDtoBeta - */ - 'fields'?: Array; -} - - -/** - * Provisioning state of an account activity item - * @export - * @enum {string} - */ - -export const ProvisioningStateBeta = { - Pending: 'PENDING', - Finished: 'FINISHED', - Unverifiable: 'UNVERIFIABLE', - Commited: 'COMMITED', - Failed: 'FAILED', - Retry: 'RETRY' -} as const; - -export type ProvisioningStateBeta = typeof ProvisioningStateBeta[keyof typeof ProvisioningStateBeta]; - - -/** - * Used to map an attribute key for an Identity to its display name. - * @export - * @interface PublicIdentityAttributeConfigBeta - */ -export interface PublicIdentityAttributeConfigBeta { - /** - * the key of the attribute - * @type {string} - * @memberof PublicIdentityAttributeConfigBeta - */ - 'key'?: string; - /** - * the display name of the attribute - * @type {string} - * @memberof PublicIdentityAttributeConfigBeta - */ - 'name'?: string; -} -/** - * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org - * @export - * @interface PublicIdentityConfigBeta - */ -export interface PublicIdentityConfigBeta { - /** - * - * @type {Array} - * @memberof PublicIdentityConfigBeta - */ - 'attributes'?: Array; - /** - * - * @type {IdentityReferenceBeta} - * @memberof PublicIdentityConfigBeta - */ - 'modifiedBy'?: IdentityReferenceBeta | null; - /** - * the date/time of the modification - * @type {string} - * @memberof PublicIdentityConfigBeta - */ - 'modified'?: string | null; -} -/** - * - * @export - * @interface PutPasswordDictionaryRequestBeta - */ -export interface PutPasswordDictionaryRequestBeta { - /** - * - * @type {File} - * @memberof PutPasswordDictionaryRequestBeta - */ - 'file'?: File; -} -/** - * Configuration of maximum number of days and interval for checking Service Desk integration queue status. - * @export - * @interface QueuedCheckConfigDetailsBeta - */ -export interface QueuedCheckConfigDetailsBeta { - /** - * Interval in minutes between status checks - * @type {string} - * @memberof QueuedCheckConfigDetailsBeta - */ - 'provisioningStatusCheckIntervalMinutes': string; - /** - * Maximum number of days to check - * @type {string} - * @memberof QueuedCheckConfigDetailsBeta - */ - 'provisioningMaxStatusCheckDays': string; -} -/** - * - * @export - * @interface RandomAlphaNumericBeta - */ -export interface RandomAlphaNumericBeta { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomAlphaNumericBeta - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomAlphaNumericBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomAlphaNumericBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RandomNumericBeta - */ -export interface RandomNumericBeta { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomNumericBeta - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomNumericBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomNumericBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReassignReferenceBeta - */ -export interface ReassignReferenceBeta { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceBeta - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceBeta - */ - 'type': ReassignReferenceBetaTypeBeta; -} - -export const ReassignReferenceBetaTypeBeta = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignReferenceBetaTypeBeta = typeof ReassignReferenceBetaTypeBeta[keyof typeof ReassignReferenceBetaTypeBeta]; - -/** - * - * @export - * @interface ReassignmentBeta - */ -export interface ReassignmentBeta { - /** - * - * @type {CertificationReferenceBeta} - * @memberof ReassignmentBeta - */ - 'from'?: CertificationReferenceBeta; - /** - * Comments from the previous reviewer. - * @type {string} - * @memberof ReassignmentBeta - */ - 'comment'?: string; -} -/** - * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - * @export - * @enum {string} - */ - -export const ReassignmentTypeBeta = { - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', - AutoEscalation: 'AUTO_ESCALATION', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeBeta = typeof ReassignmentTypeBeta[keyof typeof ReassignmentTypeBeta]; - - -/** - * Enum list containing types of Reassignment that can be found in the evaluate response. - * @export - * @enum {string} - */ - -export const ReassignmentTypeEnumBeta = { - ManualReassignment: 'MANUAL_REASSIGNMENT,', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT,', - AutoEscalation: 'AUTO_ESCALATION,', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeEnumBeta = typeof ReassignmentTypeEnumBeta[keyof typeof ReassignmentTypeEnumBeta]; - - -/** - * - * @export - * @interface RecommendationBeta - */ -export interface RecommendationBeta { - /** - * Recommended type of account. - * @type {string} - * @memberof RecommendationBeta - */ - 'type': RecommendationBetaTypeBeta; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof RecommendationBeta - */ - 'method': RecommendationBetaMethodBeta; -} - -export const RecommendationBetaTypeBeta = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type RecommendationBetaTypeBeta = typeof RecommendationBetaTypeBeta[keyof typeof RecommendationBetaTypeBeta]; -export const RecommendationBetaMethodBeta = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type RecommendationBetaMethodBeta = typeof RecommendationBetaMethodBeta[keyof typeof RecommendationBetaMethodBeta]; - -/** - * - * @export - * @interface RecommendationConfigDtoBeta - */ -export interface RecommendationConfigDtoBeta { - /** - * List of identity attributes to use for calculating certification recommendations - * @type {Array} - * @memberof RecommendationConfigDtoBeta - */ - 'recommenderFeatures'?: Array; - /** - * The percent value that the recommendation calculation must surpass to produce a YES recommendation - * @type {number} - * @memberof RecommendationConfigDtoBeta - */ - 'peerGroupPercentageThreshold'?: number; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoBeta - */ - 'runAutoSelectOnce'?: boolean; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoBeta - */ - 'onlyTuneThreshold'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestBeta - */ -export interface RecommendationRequestBeta { - /** - * The identity ID - * @type {string} - * @memberof RecommendationRequestBeta - */ - 'identityId'?: string; - /** - * - * @type {AccessItemRefBeta} - * @memberof RecommendationRequestBeta - */ - 'item'?: AccessItemRefBeta; -} -/** - * - * @export - * @interface RecommendationRequestDtoBeta - */ -export interface RecommendationRequestDtoBeta { - /** - * - * @type {Array} - * @memberof RecommendationRequestDtoBeta - */ - 'requests'?: Array; - /** - * Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. - * @type {boolean} - * @memberof RecommendationRequestDtoBeta - */ - 'excludeInterpretations'?: boolean; - /** - * When set to true, the calling system uses the translated messages for the specified language - * @type {boolean} - * @memberof RecommendationRequestDtoBeta - */ - 'includeTranslationMessages'?: boolean; - /** - * Returns the recommender calculations if set to true - * @type {boolean} - * @memberof RecommendationRequestDtoBeta - */ - 'includeDebugInformation'?: boolean; - /** - * When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. - * @type {boolean} - * @memberof RecommendationRequestDtoBeta - */ - 'prescribeMode'?: boolean; -} -/** - * - * @export - * @interface RecommendationResponseBeta - */ -export interface RecommendationResponseBeta { - /** - * - * @type {RecommendationRequestBeta} - * @memberof RecommendationResponseBeta - */ - 'request'?: RecommendationRequestBeta; - /** - * The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system - * @type {string} - * @memberof RecommendationResponseBeta - */ - 'recommendation'?: RecommendationResponseBetaRecommendationBeta; - /** - * The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. - * @type {Array} - * @memberof RecommendationResponseBeta - */ - 'interpretations'?: Array; - /** - * The list of translation messages, if they have been requested. - * @type {Array} - * @memberof RecommendationResponseBeta - */ - 'translationMessages'?: Array; - /** - * - * @type {RecommenderCalculationsBeta} - * @memberof RecommendationResponseBeta - */ - 'recommenderCalculations'?: RecommenderCalculationsBeta; -} - -export const RecommendationResponseBetaRecommendationBeta = { - True: 'true', - False: 'false', - Maybe: 'MAYBE', - NotFound: 'NOT_FOUND' -} as const; - -export type RecommendationResponseBetaRecommendationBeta = typeof RecommendationResponseBetaRecommendationBeta[keyof typeof RecommendationResponseBetaRecommendationBeta]; - -/** - * - * @export - * @interface RecommendationResponseDtoBeta - */ -export interface RecommendationResponseDtoBeta { - /** - * - * @type {Array} - * @memberof RecommendationResponseDtoBeta - */ - 'response'?: Array; -} -/** - * - * @export - * @interface RecommenderCalculationsBeta - */ -export interface RecommenderCalculationsBeta { - /** - * The ID of the identity - * @type {string} - * @memberof RecommenderCalculationsBeta - */ - 'identityId'?: string; - /** - * The entitlement ID - * @type {string} - * @memberof RecommenderCalculationsBeta - */ - 'entitlementId'?: string; - /** - * The actual recommendation - * @type {string} - * @memberof RecommenderCalculationsBeta - */ - 'recommendation'?: string; - /** - * The overall weighted score - * @type {number} - * @memberof RecommenderCalculationsBeta - */ - 'overallWeightedScore'?: number; - /** - * The weighted score of each individual feature - * @type {{ [key: string]: number; }} - * @memberof RecommenderCalculationsBeta - */ - 'featureWeightedScores'?: { [key: string]: number; }; - /** - * The configured value against which the overallWeightedScore is compared - * @type {number} - * @memberof RecommenderCalculationsBeta - */ - 'threshold'?: number; - /** - * The values for your configured features - * @type {{ [key: string]: RecommenderCalculationsIdentityAttributesValueBeta; }} - * @memberof RecommenderCalculationsBeta - */ - 'identityAttributes'?: { [key: string]: RecommenderCalculationsIdentityAttributesValueBeta; }; - /** - * - * @type {FeatureValueDtoBeta} - * @memberof RecommenderCalculationsBeta - */ - 'featureValues'?: FeatureValueDtoBeta; -} -/** - * - * @export - * @interface RecommenderCalculationsIdentityAttributesValueBeta - */ -export interface RecommenderCalculationsIdentityAttributesValueBeta { - /** - * - * @type {string} - * @memberof RecommenderCalculationsIdentityAttributesValueBeta - */ - 'value'?: string; -} -/** - * - * @export - * @interface ReferenceBeta - */ -export interface ReferenceBeta { - /** - * This ID specifies the name of the pre-existing transform which you want to use within your current transform - * @type {string} - * @memberof ReferenceBeta - */ - 'id': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReferenceBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReferenceBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RemediationItemDetailsBeta - */ -export interface RemediationItemDetailsBeta { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemDetailsBeta - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface RemediationItemsBeta - */ -export interface RemediationItemsBeta { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemsBeta - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemsBeta - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemsBeta - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemsBeta - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemsBeta - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemsBeta - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemsBeta - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemsBeta - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemsBeta - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface ReplaceAllBeta - */ -export interface ReplaceAllBeta { - /** - * An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllBeta - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceAllBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReplaceBeta - */ -export interface ReplaceBeta { - /** - * This can be a string or a regex pattern in which you want to replace. - * @type {string} - * @memberof ReplaceBeta - */ - 'regex': string; - /** - * This is the replacement string that should be substituded wherever the string or pattern is found. - * @type {string} - * @memberof ReplaceBeta - */ - 'replacement': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReportConfigDTOBeta - */ -export interface ReportConfigDTOBeta { - /** - * Name of column in report - * @type {string} - * @memberof ReportConfigDTOBeta - */ - 'columnName'?: string; - /** - * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. - * @type {boolean} - * @memberof ReportConfigDTOBeta - */ - 'required'?: boolean; - /** - * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. - * @type {boolean} - * @memberof ReportConfigDTOBeta - */ - 'included'?: boolean; - /** - * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. - * @type {number} - * @memberof ReportConfigDTOBeta - */ - 'order'?: number; -} -/** - * - * @export - * @interface ReportResultReferenceBeta - */ -export interface ReportResultReferenceBeta { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof ReportResultReferenceBeta - */ - 'type'?: ReportResultReferenceBetaTypeBeta; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof ReportResultReferenceBeta - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof ReportResultReferenceBeta - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof ReportResultReferenceBeta - */ - 'status'?: ReportResultReferenceBetaStatusBeta; -} - -export const ReportResultReferenceBetaTypeBeta = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type ReportResultReferenceBetaTypeBeta = typeof ReportResultReferenceBetaTypeBeta[keyof typeof ReportResultReferenceBetaTypeBeta]; -export const ReportResultReferenceBetaStatusBeta = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type ReportResultReferenceBetaStatusBeta = typeof ReportResultReferenceBetaStatusBeta[keyof typeof ReportResultReferenceBetaStatusBeta]; - -/** - * type of a Report - * @export - * @enum {string} - */ - -export const ReportTypeBeta = { - CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', - CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', - CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', - CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' -} as const; - -export type ReportTypeBeta = typeof ReportTypeBeta[keyof typeof ReportTypeBeta]; - - -/** - * - * @export - * @interface RequestOnBehalfOfConfigBeta - */ -export interface RequestOnBehalfOfConfigBeta { - /** - * If this is true, anyone can request access for anyone. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigBeta - */ - 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; - /** - * If this is true, a manager can request access for his or her direct reports. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigBeta - */ - 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; -} -/** - * - * @export - * @interface RequestabilityBeta - */ -export interface RequestabilityBeta { - /** - * Indicates whether the requester of the containing object must provide comments justifying the request. - * @type {boolean} - * @memberof RequestabilityBeta - */ - 'commentsRequired'?: boolean | null; - /** - * Indicates whether an approver must provide comments when denying the request. - * @type {boolean} - * @memberof RequestabilityBeta - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityBeta - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityBeta - */ - 'requireEndDate'?: boolean | null; - /** - * - * @type {AccessDurationBeta} - * @memberof RequestabilityBeta - */ - 'maxPermittedAccessDuration'?: AccessDurationBeta | null; - /** - * List describing the steps involved in approving the request. - * @type {Array} - * @memberof RequestabilityBeta - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RequestabilityForRoleBeta - */ -export interface RequestabilityForRoleBeta { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RequestabilityForRoleBeta - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RequestabilityForRoleBeta - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityForRoleBeta - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityForRoleBeta - */ - 'requireEndDate'?: boolean; - /** - * - * @type {AccessDurationBeta} - * @memberof RequestabilityForRoleBeta - */ - 'maxPermittedAccessDuration'?: AccessDurationBeta | null; - /** - * List describing the steps in approving the request - * @type {Array} - * @memberof RequestabilityForRoleBeta - */ - 'approvalSchemes'?: Array; - /** - * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. - * @type {string} - * @memberof RequestabilityForRoleBeta - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface RequestableObjectBeta - */ -export interface RequestableObjectBeta { - /** - * Id of the requestable object itself - * @type {string} - * @memberof RequestableObjectBeta - */ - 'id'?: string; - /** - * Human-readable display name of the requestable object - * @type {string} - * @memberof RequestableObjectBeta - */ - 'name'?: string; - /** - * The time when the requestable object was created - * @type {string} - * @memberof RequestableObjectBeta - */ - 'created'?: string; - /** - * The time when the requestable object was last modified - * @type {string} - * @memberof RequestableObjectBeta - */ - 'modified'?: string | null; - /** - * Description of the requestable object. - * @type {string} - * @memberof RequestableObjectBeta - */ - 'description'?: string | null; - /** - * - * @type {RequestableObjectTypeBeta} - * @memberof RequestableObjectBeta - */ - 'type'?: RequestableObjectTypeBeta; - /** - * - * @type {RequestableObjectRequestStatusBeta & object} - * @memberof RequestableObjectBeta - */ - 'requestStatus'?: RequestableObjectRequestStatusBeta & object; - /** - * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - * @type {string} - * @memberof RequestableObjectBeta - */ - 'identityRequestId'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailBeta} - * @memberof RequestableObjectBeta - */ - 'ownerRef'?: IdentityReferenceWithNameAndEmailBeta | null; - /** - * Whether the requester must provide comments when requesting the object. - * @type {boolean} - * @memberof RequestableObjectBeta - */ - 'requestCommentsRequired'?: boolean; -} - - -/** - * - * @export - * @interface RequestableObjectReferenceBeta - */ -export interface RequestableObjectReferenceBeta { - /** - * Id of the object. - * @type {string} - * @memberof RequestableObjectReferenceBeta - */ - 'id'?: string; - /** - * Name of the object. - * @type {string} - * @memberof RequestableObjectReferenceBeta - */ - 'name'?: string; - /** - * Description of the object. - * @type {string} - * @memberof RequestableObjectReferenceBeta - */ - 'description'?: string; - /** - * Type of the object. - * @type {string} - * @memberof RequestableObjectReferenceBeta - */ - 'type'?: RequestableObjectReferenceBetaTypeBeta; -} - -export const RequestableObjectReferenceBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectReferenceBetaTypeBeta = typeof RequestableObjectReferenceBetaTypeBeta[keyof typeof RequestableObjectReferenceBetaTypeBeta]; - -/** - * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - * @export - * @enum {string} - */ - -export const RequestableObjectRequestStatusBeta = { - Available: 'AVAILABLE', - Pending: 'PENDING', - Assigned: 'ASSIGNED' -} as const; - -export type RequestableObjectRequestStatusBeta = typeof RequestableObjectRequestStatusBeta[keyof typeof RequestableObjectRequestStatusBeta]; - - -/** - * Currently supported requestable object types. - * @export - * @enum {string} - */ - -export const RequestableObjectTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectTypeBeta = typeof RequestableObjectTypeBeta[keyof typeof RequestableObjectTypeBeta]; - - -/** - * - * @export - * @interface RequestedAccountRefBeta - */ -export interface RequestedAccountRefBeta { - /** - * Display name of the account for the user - * @type {string} - * @memberof RequestedAccountRefBeta - */ - 'name'?: string; - /** - * - * @type {DtoTypeBeta} - * @memberof RequestedAccountRefBeta - */ - 'type'?: DtoTypeBeta; - /** - * The uuid for the account - * @type {string} - * @memberof RequestedAccountRefBeta - */ - 'accountUuid'?: string | null; - /** - * The native identity for the account - * @type {string} - * @memberof RequestedAccountRefBeta - */ - 'accountId'?: string | null; - /** - * Display name of the source for the account - * @type {string} - * @memberof RequestedAccountRefBeta - */ - 'sourceName'?: string; -} - - -/** - * - * @export - * @interface RequestedForDtoRefBeta - */ -export interface RequestedForDtoRefBeta { - /** - * The identity id for which the access is requested - * @type {string} - * @memberof RequestedForDtoRefBeta - */ - 'identityId': string; - /** - * the details for the access items that are requested for the identity - * @type {Array} - * @memberof RequestedForDtoRefBeta - */ - 'requestedItems': Array; -} -/** - * - * @export - * @interface RequestedItemDetailsBeta - */ -export interface RequestedItemDetailsBeta { - /** - * The type of access item requested. - * @type {string} - * @memberof RequestedItemDetailsBeta - */ - 'type'?: RequestedItemDetailsBetaTypeBeta; - /** - * The id of the access item requested. - * @type {string} - * @memberof RequestedItemDetailsBeta - */ - 'id'?: string; -} - -export const RequestedItemDetailsBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - Role: 'ROLE' -} as const; - -export type RequestedItemDetailsBetaTypeBeta = typeof RequestedItemDetailsBetaTypeBeta[keyof typeof RequestedItemDetailsBetaTypeBeta]; - -/** - * - * @export - * @interface RequestedItemDtoRefBeta - */ -export interface RequestedItemDtoRefBeta { - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemDtoRefBeta - */ - 'type': RequestedItemDtoRefBetaTypeBeta; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof RequestedItemDtoRefBeta - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof RequestedItemDtoRefBeta - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof RequestedItemDtoRefBeta - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof RequestedItemDtoRefBeta - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof RequestedItemDtoRefBeta - */ - 'removeDate'?: string; - /** - * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account - * @type {Array} - * @memberof RequestedItemDtoRefBeta - */ - 'accountSelection'?: Array | null; -} - -export const RequestedItemDtoRefBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemDtoRefBetaTypeBeta = typeof RequestedItemDtoRefBetaTypeBeta[keyof typeof RequestedItemDtoRefBetaTypeBeta]; - -/** - * - * @export - * @interface RequestedItemStatusBeta - */ -export interface RequestedItemStatusBeta { - /** - * The ID of the access request. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'id'?: string; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'type'?: RequestedItemStatusBetaTypeBeta | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsBeta} - * @memberof RequestedItemStatusBeta - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsBeta; - /** - * List of list of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof RequestedItemStatusBeta - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateBeta} - * @memberof RequestedItemStatusBeta - */ - 'state'?: RequestedItemStatusRequestStateBeta; - /** - * Approval details for each item. - * @type {Array} - * @memberof RequestedItemStatusBeta - */ - 'approvalDetails'?: Array; - /** - * List of approval IDs associated with the request. - * @type {Array} - * @memberof RequestedItemStatusBeta - */ - 'approvalIds'?: Array | null; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof RequestedItemStatusBeta - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeBeta} - * @memberof RequestedItemStatusBeta - */ - 'requestType'?: AccessRequestTypeBeta | null; - /** - * When the request was last modified. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterBeta} - * @memberof RequestedItemStatusBeta - */ - 'requester'?: AccessItemRequesterBeta; - /** - * - * @type {RequestedItemStatusRequestedForBeta} - * @memberof RequestedItemStatusBeta - */ - 'requestedFor'?: RequestedItemStatusRequestedForBeta; - /** - * - * @type {RequestedItemStatusRequesterCommentBeta} - * @memberof RequestedItemStatusBeta - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentBeta; - /** - * - * @type {RequestedItemStatusSodViolationContextBeta} - * @memberof RequestedItemStatusBeta - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextBeta; - /** - * - * @type {RequestedItemStatusProvisioningDetailsBeta} - * @memberof RequestedItemStatusBeta - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsBeta; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsBeta} - * @memberof RequestedItemStatusBeta - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsBeta; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof RequestedItemStatusBeta - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof RequestedItemStatusBeta - */ - 'cancelable'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof RequestedItemStatusBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof RequestedItemStatusBeta - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof RequestedItemStatusBeta - */ - 'privilegeLevel'?: string | null; -} - -export const RequestedItemStatusBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemStatusBetaTypeBeta = typeof RequestedItemStatusBetaTypeBeta[keyof typeof RequestedItemStatusBetaTypeBeta]; - -/** - * - * @export - * @interface RequestedItemStatusCancelledRequestDetailsBeta - */ -export interface RequestedItemStatusCancelledRequestDetailsBeta { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsBeta - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoBeta} - * @memberof RequestedItemStatusCancelledRequestDetailsBeta - */ - 'owner'?: OwnerDtoBeta; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface RequestedItemStatusPreApprovalTriggerDetailsBeta - */ -export interface RequestedItemStatusPreApprovalTriggerDetailsBeta { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsBeta - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsBeta - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsBeta - */ - 'decision'?: RequestedItemStatusPreApprovalTriggerDetailsBetaDecisionBeta; -} - -export const RequestedItemStatusPreApprovalTriggerDetailsBetaDecisionBeta = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type RequestedItemStatusPreApprovalTriggerDetailsBetaDecisionBeta = typeof RequestedItemStatusPreApprovalTriggerDetailsBetaDecisionBeta[keyof typeof RequestedItemStatusPreApprovalTriggerDetailsBetaDecisionBeta]; - -/** - * - * @export - * @interface RequestedItemStatusProvisioningDetailsBeta - */ -export interface RequestedItemStatusProvisioningDetailsBeta { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof RequestedItemStatusProvisioningDetailsBeta - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. - * @export - * @enum {string} - */ - -export const RequestedItemStatusRequestStateBeta = { - Executing: 'EXECUTING', - RequestCompleted: 'REQUEST_COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED', - ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', - Rejected: 'REJECTED', - ProvisioningFailed: 'PROVISIONING_FAILED', - NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusRequestStateBeta = typeof RequestedItemStatusRequestStateBeta[keyof typeof RequestedItemStatusRequestStateBeta]; - - -/** - * Identity access was requested for. - * @export - * @interface RequestedItemStatusRequestedForBeta - */ -export interface RequestedItemStatusRequestedForBeta { - /** - * Type of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForBeta - */ - 'type'?: RequestedItemStatusRequestedForBetaTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForBeta - */ - 'name'?: string; -} - -export const RequestedItemStatusRequestedForBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type RequestedItemStatusRequestedForBetaTypeBeta = typeof RequestedItemStatusRequestedForBetaTypeBeta[keyof typeof RequestedItemStatusRequestedForBetaTypeBeta]; - -/** - * - * @export - * @interface RequestedItemStatusRequesterCommentBeta - */ -export interface RequestedItemStatusRequesterCommentBeta { - /** - * Comment content. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentBeta - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentBeta - */ - 'created'?: string; - /** - * - * @type {CommentDto1AuthorBeta} - * @memberof RequestedItemStatusRequesterCommentBeta - */ - 'author'?: CommentDto1AuthorBeta; -} -/** - * - * @export - * @interface RequestedItemStatusSodViolationContextBeta - */ -export interface RequestedItemStatusSodViolationContextBeta { - /** - * The status of SOD violation check - * @type {string} - * @memberof RequestedItemStatusSodViolationContextBeta - */ - 'state'?: RequestedItemStatusSodViolationContextBetaStateBeta | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof RequestedItemStatusSodViolationContextBeta - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultBeta} - * @memberof RequestedItemStatusSodViolationContextBeta - */ - 'violationCheckResult'?: SodViolationCheckResultBeta; -} - -export const RequestedItemStatusSodViolationContextBetaStateBeta = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusSodViolationContextBetaStateBeta = typeof RequestedItemStatusSodViolationContextBetaStateBeta[keyof typeof RequestedItemStatusSodViolationContextBetaStateBeta]; - -/** - * - * @export - * @interface ResourceBundleMessageBeta - */ -export interface ResourceBundleMessageBeta { - /** - * The key of the message - * @type {string} - * @memberof ResourceBundleMessageBeta - */ - 'key'?: string; - /** - * The format of the message - * @type {string} - * @memberof ResourceBundleMessageBeta - */ - 'format'?: string; -} -/** - * Representation of the object which is returned from source connectors. - * @export - * @interface ResourceObjectBeta - */ -export interface ResourceObjectBeta { - /** - * Identifier of the specific instance where this object resides. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'instance'?: string; - /** - * Native identity of the object in the Source. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'identity'?: string; - /** - * Universal unique identifier of the object in the Source. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'uuid'?: string; - /** - * Native identity that the object has previously. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'previousIdentity'?: string; - /** - * Display name for this object. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof ResourceObjectBeta - */ - 'objectType'?: string; - /** - * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - * @type {boolean} - * @memberof ResourceObjectBeta - */ - 'incomplete'?: boolean; - /** - * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - * @type {boolean} - * @memberof ResourceObjectBeta - */ - 'incremental'?: boolean; - /** - * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - * @type {boolean} - * @memberof ResourceObjectBeta - */ - 'delete'?: boolean; - /** - * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - * @type {boolean} - * @memberof ResourceObjectBeta - */ - 'remove'?: boolean; - /** - * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". - * @type {Array} - * @memberof ResourceObjectBeta - */ - 'missing'?: Array; - /** - * Attributes of this ResourceObject. - * @type {object} - * @memberof ResourceObjectBeta - */ - 'attributes'?: object; - /** - * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - * @type {boolean} - * @memberof ResourceObjectBeta - */ - 'finalUpdate'?: boolean; -} -/** - * Request model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsRequestBeta - */ -export interface ResourceObjectsRequestBeta { - /** - * The type of resource objects to iterate over. - * @type {string} - * @memberof ResourceObjectsRequestBeta - */ - 'objectType'?: string; - /** - * The maximum number of resource objects to iterate over and return. - * @type {number} - * @memberof ResourceObjectsRequestBeta - */ - 'maxCount'?: number; -} -/** - * Response model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsResponseBeta - */ -export interface ResourceObjectsResponseBeta { - /** - * ID of the source - * @type {string} - * @memberof ResourceObjectsResponseBeta - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof ResourceObjectsResponseBeta - */ - 'name'?: string; - /** - * The number of objects that were fetched by the connector. - * @type {number} - * @memberof ResourceObjectsResponseBeta - */ - 'objectCount'?: number; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof ResourceObjectsResponseBeta - */ - 'elapsedMillis'?: number; - /** - * Fetched objects from the source connector. - * @type {Array} - * @memberof ResourceObjectsResponseBeta - */ - 'resourceObjects'?: Array; -} -/** - * - * @export - * @interface ReviewReassignBeta - */ -export interface ReviewReassignBeta { - /** - * - * @type {Array} - * @memberof ReviewReassignBeta - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof ReviewReassignBeta - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof ReviewReassignBeta - */ - 'reason': string; -} -/** - * Details of the reviewer for a certification. - * @export - * @interface ReviewerBeta - */ -export interface ReviewerBeta { - /** - * Reviewer\'s DTO type. - * @type {string} - * @memberof ReviewerBeta - */ - 'type': ReviewerBetaTypeBeta; - /** - * Reviewer\'s ID. - * @type {string} - * @memberof ReviewerBeta - */ - 'id': string; - /** - * Reviewer\'s display name. - * @type {string} - * @memberof ReviewerBeta - */ - 'name': string; - /** - * Reviewing identity\'s email. This is only applicable to reviewers of the `IDENTITY` type. - * @type {string} - * @memberof ReviewerBeta - */ - 'email'?: string | null; -} - -export const ReviewerBetaTypeBeta = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ReviewerBetaTypeBeta = typeof ReviewerBetaTypeBeta[keyof typeof ReviewerBetaTypeBeta]; - -/** - * - * @export - * @interface RevocabilityBeta - */ -export interface RevocabilityBeta { - /** - * List describing the steps involved in approving the revocation request. - * @type {Array} - * @memberof RevocabilityBeta - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RevocabilityForRoleBeta - */ -export interface RevocabilityForRoleBeta { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RevocabilityForRoleBeta - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RevocabilityForRoleBeta - */ - 'denialCommentsRequired'?: boolean | null; - /** - * List describing the steps in approving the revocation request - * @type {Array} - * @memberof RevocabilityForRoleBeta - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface RightPadBeta - */ -export interface RightPadBeta { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof RightPadBeta - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof RightPadBeta - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RightPadBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RightPadBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * The identity that performed the assignment. This could be blank or system - * @export - * @interface RoleAssignmentDtoAssignerBeta - */ -export interface RoleAssignmentDtoAssignerBeta { - /** - * Object type - * @type {string} - * @memberof RoleAssignmentDtoAssignerBeta - */ - 'type'?: RoleAssignmentDtoAssignerBetaTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerBeta - */ - 'name'?: string | null; -} - -export const RoleAssignmentDtoAssignerBetaTypeBeta = { - Identity: 'IDENTITY', - Unknown: 'UNKNOWN' -} as const; - -export type RoleAssignmentDtoAssignerBetaTypeBeta = typeof RoleAssignmentDtoAssignerBetaTypeBeta[keyof typeof RoleAssignmentDtoAssignerBetaTypeBeta]; - -/** - * - * @export - * @interface RoleAssignmentDtoAssignmentContextBeta - */ -export interface RoleAssignmentDtoAssignmentContextBeta { - /** - * - * @type {AccessRequestContextBeta} - * @memberof RoleAssignmentDtoAssignmentContextBeta - */ - 'requested'?: AccessRequestContextBeta; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoAssignmentContextBeta - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof RoleAssignmentDtoAssignmentContextBeta - */ - 'computedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentDtoBeta - */ -export interface RoleAssignmentDtoBeta { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'id'?: string; - /** - * - * @type {BaseRoleReferenceDtoBeta} - * @memberof RoleAssignmentDtoBeta - */ - 'role'?: BaseRoleReferenceDtoBeta; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerBeta} - * @memberof RoleAssignmentDtoBeta - */ - 'assigner'?: RoleAssignmentDtoAssignerBeta; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof RoleAssignmentDtoBeta - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextBeta} - * @memberof RoleAssignmentDtoBeta - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextBeta; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoBeta - */ - 'accountTargets'?: Array; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'removeDate'?: string | null; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentDtoBeta - */ - 'addedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentRefBeta - */ -export interface RoleAssignmentRefBeta { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentRefBeta - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDto1Beta} - * @memberof RoleAssignmentRefBeta - */ - 'role'?: BaseReferenceDto1Beta; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentRefBeta - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentRefBeta - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentRefBeta - */ - 'removeDate'?: string | null; -} -/** - * Type which indicates how a particular Identity obtained a particular Role - * @export - * @enum {string} - */ - -export const RoleAssignmentSourceTypeBeta = { - AccessRequest: 'ACCESS_REQUEST', - RoleMembership: 'ROLE_MEMBERSHIP' -} as const; - -export type RoleAssignmentSourceTypeBeta = typeof RoleAssignmentSourceTypeBeta[keyof typeof RoleAssignmentSourceTypeBeta]; - - -/** - * A Role - * @export - * @interface RoleBeta - */ -export interface RoleBeta { - /** - * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof RoleBeta - */ - 'id'?: string; - /** - * The human-readable display name of the Role - * @type {string} - * @memberof RoleBeta - */ - 'name': string; - /** - * Date the Role was created - * @type {string} - * @memberof RoleBeta - */ - 'created'?: string; - /** - * Date the Role was last modified. - * @type {string} - * @memberof RoleBeta - */ - 'modified'?: string; - /** - * A human-readable description of the Role - * @type {string} - * @memberof RoleBeta - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceBeta} - * @memberof RoleBeta - */ - 'owner': OwnerReferenceBeta; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof RoleBeta - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleBeta - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleBeta - */ - 'entitlements'?: Array; - /** - * - * @type {RoleMembershipSelectorBeta} - * @memberof RoleBeta - */ - 'membership'?: RoleMembershipSelectorBeta | null; - /** - * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - * @type {{ [key: string]: any; }} - * @memberof RoleBeta - */ - 'legacyMembershipInfo'?: { [key: string]: any; } | null; - /** - * Whether the Role is enabled or not. - * @type {boolean} - * @memberof RoleBeta - */ - 'enabled'?: boolean; - /** - * Whether the Role can be the target of access requests. - * @type {boolean} - * @memberof RoleBeta - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityForRoleBeta} - * @memberof RoleBeta - */ - 'accessRequestConfig'?: RequestabilityForRoleBeta; - /** - * - * @type {RevocabilityForRoleBeta} - * @memberof RoleBeta - */ - 'revocationRequestConfig'?: RevocabilityForRoleBeta; - /** - * List of IDs of segments, if any, to which this Role is assigned. - * @type {Array} - * @memberof RoleBeta - */ - 'segments'?: Array | null; - /** - * Whether the Role is dimensional. - * @type {boolean} - * @memberof RoleBeta - */ - 'dimensional'?: boolean | null; - /** - * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - * @type {Array} - * @memberof RoleBeta - */ - 'dimensionRefs'?: Array | null; - /** - * - * @type {AttributeDTOListBeta} - * @memberof RoleBeta - */ - 'accessModelMetadata'?: AttributeDTOListBeta; - /** - * The privilege level of the role, if applicable. - * @type {string} - * @memberof RoleBeta - */ - 'privilegeLevel'?: string | null; -} -/** - * - * @export - * @interface RoleBulkDeleteRequestBeta - */ -export interface RoleBulkDeleteRequestBeta { - /** - * List of IDs of Roles to be deleted. - * @type {Array} - * @memberof RoleBulkDeleteRequestBeta - */ - 'roleIds': Array; -} -/** - * Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - * @export - * @interface RoleCriteriaKeyBeta - */ -export interface RoleCriteriaKeyBeta { - /** - * - * @type {RoleCriteriaKeyTypeBeta} - * @memberof RoleCriteriaKeyBeta - */ - 'type': RoleCriteriaKeyTypeBeta; - /** - * The name of the attribute or entitlement to which the associated criteria applies. - * @type {string} - * @memberof RoleCriteriaKeyBeta - */ - 'property': string; - /** - * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - * @type {string} - * @memberof RoleCriteriaKeyBeta - */ - 'sourceId'?: string | null; -} - - -/** - * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - * @export - * @enum {string} - */ - -export const RoleCriteriaKeyTypeBeta = { - Identity: 'IDENTITY', - Account: 'ACCOUNT', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RoleCriteriaKeyTypeBeta = typeof RoleCriteriaKeyTypeBeta[keyof typeof RoleCriteriaKeyTypeBeta]; - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel1Beta - */ -export interface RoleCriteriaLevel1Beta { - /** - * - * @type {RoleCriteriaOperationBeta} - * @memberof RoleCriteriaLevel1Beta - */ - 'operation'?: RoleCriteriaOperationBeta; - /** - * - * @type {RoleCriteriaKeyBeta} - * @memberof RoleCriteriaLevel1Beta - */ - 'key'?: RoleCriteriaKeyBeta | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel1Beta - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel1Beta - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel2Beta - */ -export interface RoleCriteriaLevel2Beta { - /** - * - * @type {RoleCriteriaOperationBeta} - * @memberof RoleCriteriaLevel2Beta - */ - 'operation'?: RoleCriteriaOperationBeta; - /** - * - * @type {RoleCriteriaKeyBeta} - * @memberof RoleCriteriaLevel2Beta - */ - 'key'?: RoleCriteriaKeyBeta | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel2Beta - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel2Beta - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel3Beta - */ -export interface RoleCriteriaLevel3Beta { - /** - * - * @type {RoleCriteriaOperationBeta} - * @memberof RoleCriteriaLevel3Beta - */ - 'operation'?: RoleCriteriaOperationBeta; - /** - * - * @type {RoleCriteriaKeyBeta} - * @memberof RoleCriteriaLevel3Beta - */ - 'key'?: RoleCriteriaKeyBeta | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel3Beta - */ - 'stringValue'?: string | null; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const RoleCriteriaOperationBeta = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - GreaterThan: 'GREATER_THAN', - LessThan: 'LESS_THAN', - GreaterThanEquals: 'GREATER_THAN_EQUALS', - LessThanEquals: 'LESS_THAN_EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type RoleCriteriaOperationBeta = typeof RoleCriteriaOperationBeta[keyof typeof RoleCriteriaOperationBeta]; - - -/** - * A subset of the fields of an Identity which is a member of a Role. - * @export - * @interface RoleIdentityBeta - */ -export interface RoleIdentityBeta { - /** - * The ID of the Identity - * @type {string} - * @memberof RoleIdentityBeta - */ - 'id'?: string; - /** - * The alias / username of the Identity - * @type {string} - * @memberof RoleIdentityBeta - */ - 'aliasName'?: string; - /** - * The human-readable display name of the Identity - * @type {string} - * @memberof RoleIdentityBeta - */ - 'name'?: string; - /** - * Email address of the Identity - * @type {string} - * @memberof RoleIdentityBeta - */ - 'email'?: string; - /** - * - * @type {RoleAssignmentSourceTypeBeta} - * @memberof RoleIdentityBeta - */ - 'roleAssignmentSource'?: RoleAssignmentSourceTypeBeta; -} - - -/** - * - * @export - * @interface RoleInsightBeta - */ -export interface RoleInsightBeta { - /** - * Insight id - * @type {string} - * @memberof RoleInsightBeta - */ - 'id'?: string; - /** - * Total number of updates for this role - * @type {number} - * @memberof RoleInsightBeta - */ - 'numberOfUpdates'?: number; - /** - * The date-time insights were last created for this role. - * @type {string} - * @memberof RoleInsightBeta - */ - 'createdDate'?: string; - /** - * The date-time insights were last modified for this role. - * @type {string} - * @memberof RoleInsightBeta - */ - 'modifiedDate'?: string | null; - /** - * - * @type {RoleInsightsRoleBeta} - * @memberof RoleInsightBeta - */ - 'role'?: RoleInsightsRoleBeta; - /** - * - * @type {RoleInsightsInsightBeta} - * @memberof RoleInsightBeta - */ - 'insight'?: RoleInsightsInsightBeta; -} -/** - * - * @export - * @interface RoleInsightsEntitlementBeta - */ -export interface RoleInsightsEntitlementBeta { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'description'?: string; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'source'?: string; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementBeta - */ - 'value'?: string; -} -/** - * - * @export - * @interface RoleInsightsEntitlementChangesBeta - */ -export interface RoleInsightsEntitlementChangesBeta { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'description'?: string; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'value'?: string; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'source'?: string; - /** - * - * @type {RoleInsightsInsightBeta} - * @memberof RoleInsightsEntitlementChangesBeta - */ - 'insight'?: RoleInsightsInsightBeta; -} -/** - * - * @export - * @interface RoleInsightsIdentitiesBeta - */ -export interface RoleInsightsIdentitiesBeta { - /** - * Id for identity - * @type {string} - * @memberof RoleInsightsIdentitiesBeta - */ - 'id'?: string; - /** - * Name for identity - * @type {string} - * @memberof RoleInsightsIdentitiesBeta - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string; }} - * @memberof RoleInsightsIdentitiesBeta - */ - 'attributes'?: { [key: string]: string; }; -} -/** - * - * @export - * @interface RoleInsightsInsightBeta - */ -export interface RoleInsightsInsightBeta { - /** - * The number of identities in this role with the entitlement. - * @type {string} - * @memberof RoleInsightsInsightBeta - */ - 'type'?: string; - /** - * The number of identities in this role with the entitlement. - * @type {number} - * @memberof RoleInsightsInsightBeta - */ - 'identitiesWithAccess'?: number; - /** - * The number of identities in this role that do not have the specified entitlement. - * @type {number} - * @memberof RoleInsightsInsightBeta - */ - 'identitiesImpacted'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsInsightBeta - */ - 'totalNumberOfIdentities'?: number; - /** - * - * @type {string} - * @memberof RoleInsightsInsightBeta - */ - 'impactedIdentityNames'?: string | null; -} -/** - * - * @export - * @interface RoleInsightsResponseBeta - */ -export interface RoleInsightsResponseBeta { - /** - * Request Id for a role insight generation request - * @type {string} - * @memberof RoleInsightsResponseBeta - */ - 'id'?: string; - /** - * The date-time role insights request was created. - * @type {string} - * @memberof RoleInsightsResponseBeta - */ - 'createdDate'?: string; - /** - * The date-time role insights request was completed. - * @type {string} - * @memberof RoleInsightsResponseBeta - */ - 'lastGenerated'?: string; - /** - * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. - * @type {number} - * @memberof RoleInsightsResponseBeta - */ - 'numberOfUpdates'?: number; - /** - * The role IDs that are in this request. - * @type {Array} - * @memberof RoleInsightsResponseBeta - */ - 'roleIds'?: Array; - /** - * Request status - * @type {string} - * @memberof RoleInsightsResponseBeta - */ - 'status'?: RoleInsightsResponseBetaStatusBeta; -} - -export const RoleInsightsResponseBetaStatusBeta = { - Created: 'CREATED', - InProgress: 'IN PROGRESS', - Completed: 'COMPLETED', - Failed: 'FAILED' -} as const; - -export type RoleInsightsResponseBetaStatusBeta = typeof RoleInsightsResponseBetaStatusBeta[keyof typeof RoleInsightsResponseBetaStatusBeta]; - -/** - * - * @export - * @interface RoleInsightsRoleBeta - */ -export interface RoleInsightsRoleBeta { - /** - * Role name - * @type {string} - * @memberof RoleInsightsRoleBeta - */ - 'name'?: string; - /** - * Role id - * @type {string} - * @memberof RoleInsightsRoleBeta - */ - 'id'?: string; - /** - * Role description - * @type {string} - * @memberof RoleInsightsRoleBeta - */ - 'description'?: string; - /** - * Role owner name - * @type {string} - * @memberof RoleInsightsRoleBeta - */ - 'ownerName'?: string; - /** - * Role owner id - * @type {string} - * @memberof RoleInsightsRoleBeta - */ - 'ownerId'?: string; -} -/** - * - * @export - * @interface RoleInsightsSummaryBeta - */ -export interface RoleInsightsSummaryBeta { - /** - * Total number of roles with updates - * @type {number} - * @memberof RoleInsightsSummaryBeta - */ - 'numberOfUpdates'?: number; - /** - * The date-time role insights were last found. - * @type {string} - * @memberof RoleInsightsSummaryBeta - */ - 'lastGenerated'?: string; - /** - * The number of entitlements included in roles (vs free radicals). - * @type {number} - * @memberof RoleInsightsSummaryBeta - */ - 'entitlementsIncludedInRoles'?: number; - /** - * The total number of entitlements. - * @type {number} - * @memberof RoleInsightsSummaryBeta - */ - 'totalNumberOfEntitlements'?: number; - /** - * The number of identities in roles vs. identities with just entitlements and not in roles. - * @type {number} - * @memberof RoleInsightsSummaryBeta - */ - 'identitiesWithAccessViaRoles'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsSummaryBeta - */ - 'totalNumberOfIdentities'?: number; -} -/** - * - * @export - * @interface RoleMatchDtoBeta - */ -export interface RoleMatchDtoBeta { - /** - * - * @type {BaseReferenceDto1Beta} - * @memberof RoleMatchDtoBeta - */ - 'roleRef'?: BaseReferenceDto1Beta; - /** - * - * @type {Array} - * @memberof RoleMatchDtoBeta - */ - 'matchedAttributes'?: Array; -} -/** - * A reference to an Identity in an IDENTITY_LIST role membership criteria. - * @export - * @interface RoleMembershipIdentityBeta - */ -export interface RoleMembershipIdentityBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof RoleMembershipIdentityBeta - */ - 'type'?: DtoTypeBeta; - /** - * Identity id - * @type {string} - * @memberof RoleMembershipIdentityBeta - */ - 'id'?: string; - /** - * Human-readable display name of the Identity. - * @type {string} - * @memberof RoleMembershipIdentityBeta - */ - 'name'?: string | null; - /** - * User name of the Identity - * @type {string} - * @memberof RoleMembershipIdentityBeta - */ - 'aliasName'?: string | null; -} - - -/** - * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - * @export - * @interface RoleMembershipSelectorBeta - */ -export interface RoleMembershipSelectorBeta { - /** - * - * @type {RoleMembershipSelectorTypeBeta} - * @memberof RoleMembershipSelectorBeta - */ - 'type'?: RoleMembershipSelectorTypeBeta; - /** - * - * @type {RoleCriteriaLevel1Beta} - * @memberof RoleMembershipSelectorBeta - */ - 'criteria'?: RoleCriteriaLevel1Beta | null; - /** - * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - * @type {Array} - * @memberof RoleMembershipSelectorBeta - */ - 'identities'?: Array | null; -} - - -/** - * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - * @export - * @enum {string} - */ - -export const RoleMembershipSelectorTypeBeta = { - Standard: 'STANDARD', - IdentityList: 'IDENTITY_LIST' -} as const; - -export type RoleMembershipSelectorTypeBeta = typeof RoleMembershipSelectorTypeBeta[keyof typeof RoleMembershipSelectorTypeBeta]; - - -/** - * - * @export - * @interface RoleMiningEntitlementBeta - */ -export interface RoleMiningEntitlementBeta { - /** - * - * @type {RoleMiningEntitlementRefBeta} - * @memberof RoleMiningEntitlementBeta - */ - 'entitlementRef'?: RoleMiningEntitlementRefBeta; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementBeta - */ - 'name'?: string; - /** - * Application name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementBeta - */ - 'applicationName'?: string; - /** - * The number of identities with this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementBeta - */ - 'identityCount'?: number; - /** - * The % popularity of this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementBeta - */ - 'popularity'?: number; - /** - * The % popularity of this entitlement in the org. - * @type {number} - * @memberof RoleMiningEntitlementBeta - */ - 'popularityInOrg'?: number; - /** - * The ID of the source/application. - * @type {string} - * @memberof RoleMiningEntitlementBeta - */ - 'sourceId'?: string; - /** - * The status of activity data for the source. Value is complete or notComplete. - * @type {string} - * @memberof RoleMiningEntitlementBeta - */ - 'activitySourceState'?: string | null; - /** - * The percentage of identities in the potential role that have usage of the source/application of this entitlement. - * @type {number} - * @memberof RoleMiningEntitlementBeta - */ - 'sourceUsagePercent'?: number | null; -} -/** - * - * @export - * @interface RoleMiningEntitlementRefBeta - */ -export interface RoleMiningEntitlementRefBeta { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefBeta - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefBeta - */ - 'name'?: string; - /** - * Description forthe entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefBeta - */ - 'description'?: string | null; - /** - * The entitlement attribute - * @type {string} - * @memberof RoleMiningEntitlementRefBeta - */ - 'attribute'?: string; -} -/** - * - * @export - * @interface RoleMiningIdentityBeta - */ -export interface RoleMiningIdentityBeta { - /** - * Id of the identity - * @type {string} - * @memberof RoleMiningIdentityBeta - */ - 'id'?: string; - /** - * Name of the identity - * @type {string} - * @memberof RoleMiningIdentityBeta - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string; }} - * @memberof RoleMiningIdentityBeta - */ - 'attributes'?: { [key: string]: string; }; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionBeta - */ -export interface RoleMiningIdentityDistributionBeta { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningIdentityDistributionBeta - */ - 'attributeName'?: string; - /** - * - * @type {Array} - * @memberof RoleMiningIdentityDistributionBeta - */ - 'distribution'?: Array; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionDistributionInnerBeta - */ -export interface RoleMiningIdentityDistributionDistributionInnerBeta { - /** - * The attribute value that identities are grouped by - * @type {string} - * @memberof RoleMiningIdentityDistributionDistributionInnerBeta - */ - 'attributeValue'?: string | null; - /** - * The number of identities that have this attribute value - * @type {number} - * @memberof RoleMiningIdentityDistributionDistributionInnerBeta - */ - 'count'?: number; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleApplicationBeta - */ -export interface RoleMiningPotentialRoleApplicationBeta { - /** - * Id of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationBeta - */ - 'id'?: string; - /** - * Name of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleBeta - */ -export interface RoleMiningPotentialRoleBeta { - /** - * - * @type {RoleMiningSessionResponseCreatedByBeta} - * @memberof RoleMiningPotentialRoleBeta - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByBeta; - /** - * The density of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleBeta - */ - 'density'?: number; - /** - * The description of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'description'?: string | null; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleBeta - */ - 'entitlementCount'?: number; - /** - * The list of entitlement ids to be excluded. - * @type {Array} - * @memberof RoleMiningPotentialRoleBeta - */ - 'excludedEntitlements'?: Array | null; - /** - * The freshness of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleBeta - */ - 'freshness'?: number; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleBeta - */ - 'identityCount'?: number; - /** - * Identity attribute distribution. - * @type {Array} - * @memberof RoleMiningPotentialRoleBeta - */ - 'identityDistribution'?: Array | null; - /** - * The list of ids in a potential role. - * @type {Array} - * @memberof RoleMiningPotentialRoleBeta - */ - 'identityIds'?: Array; - /** - * The status for this identity group which can be OBTAINED or COMPRESSED - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'identityGroupStatus'?: string | null; - /** - * Name of the potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRolePotentialRoleRefBeta} - * @memberof RoleMiningPotentialRoleBeta - */ - 'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefBeta | null; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateBeta} - * @memberof RoleMiningPotentialRoleBeta - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateBeta; - /** - * The quality of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleBeta - */ - 'quality'?: number; - /** - * The roleId of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'roleId'?: string | null; - /** - * The potential role\'s saved status. - * @type {boolean} - * @memberof RoleMiningPotentialRoleBeta - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionParametersDtoBeta} - * @memberof RoleMiningPotentialRoleBeta - */ - 'session'?: RoleMiningSessionParametersDtoBeta; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningPotentialRoleBeta - */ - 'type'?: RoleMiningRoleTypeBeta; - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'id'?: string; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'createdDate'?: string; - /** - * The date-time when this potential role was modified. - * @type {string} - * @memberof RoleMiningPotentialRoleBeta - */ - 'modifiedDate'?: string; -} - - -/** - * - * @export - * @interface RoleMiningPotentialRoleEditEntitlementsBeta - */ -export interface RoleMiningPotentialRoleEditEntitlementsBeta { - /** - * The list of entitlement ids to be edited - * @type {Array} - * @memberof RoleMiningPotentialRoleEditEntitlementsBeta - */ - 'ids'?: Array; - /** - * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. - * @type {boolean} - * @memberof RoleMiningPotentialRoleEditEntitlementsBeta - */ - 'exclude'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEntitlementsBeta - */ -export interface RoleMiningPotentialRoleEntitlementsBeta { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsBeta - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportRequestBeta - */ -export interface RoleMiningPotentialRoleExportRequestBeta { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportRequestBeta - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportRequestBeta - */ - 'includeCommonAccess'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportResponseBeta - */ -export interface RoleMiningPotentialRoleExportResponseBeta { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportResponseBeta - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportResponseBeta - */ - 'includeCommonAccess'?: boolean; - /** - * ID used to reference this export - * @type {string} - * @memberof RoleMiningPotentialRoleExportResponseBeta - */ - 'exportId'?: string; - /** - * - * @type {RoleMiningPotentialRoleExportStateBeta} - * @memberof RoleMiningPotentialRoleExportResponseBeta - */ - 'status'?: RoleMiningPotentialRoleExportStateBeta; -} - - -/** - * - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleExportStateBeta = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RoleMiningPotentialRoleExportStateBeta = typeof RoleMiningPotentialRoleExportStateBeta[keyof typeof RoleMiningPotentialRoleExportStateBeta]; - - -/** - * The potential role reference - * @export - * @interface RoleMiningPotentialRolePotentialRoleRefBeta - */ -export interface RoleMiningPotentialRolePotentialRoleRefBeta { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefBeta - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleProvisionRequestBeta - */ -export interface RoleMiningPotentialRoleProvisionRequestBeta { - /** - * Name of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestBeta - */ - 'roleName'?: string; - /** - * Short description of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestBeta - */ - 'roleDescription'?: string; - /** - * ID of the identity that will own this role - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestBeta - */ - 'ownerId'?: string; - /** - * When true, create access requests for the identities associated with the potential role - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestBeta - */ - 'includeIdentities'?: boolean; - /** - * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestBeta - */ - 'directlyAssignedEntitlements'?: boolean; -} -/** - * Provision state - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleProvisionStateBeta = { - Potential: 'POTENTIAL', - Pending: 'PENDING', - Complete: 'COMPLETE', - Failed: 'FAILED' -} as const; - -export type RoleMiningPotentialRoleProvisionStateBeta = typeof RoleMiningPotentialRoleProvisionStateBeta[keyof typeof RoleMiningPotentialRoleProvisionStateBeta]; - - -/** - * - * @export - * @interface RoleMiningPotentialRoleRefBeta - */ -export interface RoleMiningPotentialRoleRefBeta { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefBeta - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleSourceUsageBeta - */ -export interface RoleMiningPotentialRoleSourceUsageBeta { - /** - * The identity ID - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageBeta - */ - 'id'?: string; - /** - * Display name for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageBeta - */ - 'displayName'?: string; - /** - * Email address for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageBeta - */ - 'email'?: string; - /** - * The number of days there has been usage of the source by the identity. - * @type {number} - * @memberof RoleMiningPotentialRoleSourceUsageBeta - */ - 'usageCount'?: number; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleSummaryBeta - */ -export interface RoleMiningPotentialRoleSummaryBeta { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRoleRefBeta} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'potentialRoleRef'?: RoleMiningPotentialRoleRefBeta; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'identityCount'?: number; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'entitlementCount'?: number; - /** - * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'identityGroupStatus'?: string; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateBeta} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateBeta; - /** - * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'roleId'?: string | null; - /** - * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'density'?: number; - /** - * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'freshness'?: number; - /** - * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'quality'?: number; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'type'?: RoleMiningRoleTypeBeta; - /** - * - * @type {RoleMiningPotentialRoleSummaryCreatedByBeta} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'createdBy'?: RoleMiningPotentialRoleSummaryCreatedByBeta; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'createdDate'?: string; - /** - * The potential role\'s saved status - * @type {boolean} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'saved'?: boolean; - /** - * Description of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'description'?: string | null; - /** - * - * @type {RoleMiningSessionParametersDtoBeta} - * @memberof RoleMiningPotentialRoleSummaryBeta - */ - 'session'?: RoleMiningSessionParametersDtoBeta; -} - - -/** - * @type RoleMiningPotentialRoleSummaryCreatedByBeta - * The potential role created by details - * @export - */ -export type RoleMiningPotentialRoleSummaryCreatedByBeta = EntityCreatedByDTOBeta | string; - -/** - * Role type - * @export - * @enum {string} - */ - -export const RoleMiningRoleTypeBeta = { - Specialized: 'SPECIALIZED', - Common: 'COMMON' -} as const; - -export type RoleMiningRoleTypeBeta = typeof RoleMiningRoleTypeBeta[keyof typeof RoleMiningRoleTypeBeta]; - - -/** - * - * @export - * @interface RoleMiningSessionDraftRoleDtoBeta - */ -export interface RoleMiningSessionDraftRoleDtoBeta { - /** - * Name of the draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'name'?: string; - /** - * Draft role description - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'description'?: string; - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'identityIds'?: Array; - /** - * The list of entitlement ids for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'entitlementIds'?: Array; - /** - * The list of excluded entitlement ids. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'excludedEntitlements'?: Array; - /** - * Last modified date - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'modified'?: string; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'type'?: RoleMiningRoleTypeBeta; - /** - * Id of the potential draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'id'?: string; - /** - * The date-time when this potential draft role was created. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'createdDate'?: string; - /** - * The date-time when this potential draft role was modified. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoBeta - */ - 'modifiedDate'?: string; -} - - -/** - * - * @export - * @interface RoleMiningSessionDtoBeta - */ -export interface RoleMiningSessionDtoBeta { - /** - * - * @type {RoleMiningSessionScopeBeta} - * @memberof RoleMiningSessionDtoBeta - */ - 'scope'?: RoleMiningSessionScopeBeta; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'pruneThreshold'?: number | null; - /** - * The calculated prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'prescribedPruneThreshold'?: number | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * Number of potential roles - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'potentialRoleCount'?: number; - /** - * Number of potential roles ready - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningSessionDtoBeta - */ - 'type'?: RoleMiningRoleTypeBeta; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionDtoBeta - */ - 'emailRecipientId'?: string | null; - /** - * Number of identities in the population which meet the search criteria or identity list provided - * @type {number} - * @memberof RoleMiningSessionDtoBeta - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionDtoBeta - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionDtoBeta - */ - 'name'?: string | null; -} - - -/** - * - * @export - * @interface RoleMiningSessionParametersDtoBeta - */ -export interface RoleMiningSessionParametersDtoBeta { - /** - * The ID of the role mining session - * @type {string} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'id'?: string; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'name'?: string | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'pruneThreshold'?: number | null; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionScopeBeta} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'scope'?: RoleMiningSessionScopeBeta; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'type'?: RoleMiningRoleTypeBeta; - /** - * - * @type {RoleMiningSessionStateBeta} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'state'?: RoleMiningSessionStateBeta; - /** - * - * @type {RoleMiningSessionScopingMethodBeta} - * @memberof RoleMiningSessionParametersDtoBeta - */ - 'scopingMethod'?: RoleMiningSessionScopingMethodBeta; -} - - -/** - * - * @export - * @interface RoleMiningSessionResponseBeta - */ -export interface RoleMiningSessionResponseBeta { - /** - * - * @type {RoleMiningSessionScopeBeta} - * @memberof RoleMiningSessionResponseBeta - */ - 'scope'?: RoleMiningSessionScopeBeta; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The scoping method of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'scopingMethod'?: string | null; - /** - * The computed (or prescribed) prune threshold for this session - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'prescribedPruneThreshold'?: number | null; - /** - * The prune threshold to be used for this role mining session - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'pruneThreshold'?: number | null; - /** - * The number of potential roles - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'potentialRoleCount'?: number; - /** - * The number of potential roles which have completed processing - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningSessionStatusBeta} - * @memberof RoleMiningSessionResponseBeta - */ - 'status'?: RoleMiningSessionStatusBeta; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'emailRecipientId'?: string | null; - /** - * - * @type {RoleMiningSessionResponseCreatedByBeta} - * @memberof RoleMiningSessionResponseBeta - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByBeta; - /** - * The number of identities - * @type {number} - * @memberof RoleMiningSessionResponseBeta - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionResponseBeta - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'name'?: string | null; - /** - * The data file path of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'dataFilePath'?: string | null; - /** - * Session Id for this role mining session - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'id'?: string; - /** - * The date-time when this role mining session was created. - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'createdDate'?: string; - /** - * The date-time when this role mining session was completed. - * @type {string} - * @memberof RoleMiningSessionResponseBeta - */ - 'modifiedDate'?: string; - /** - * - * @type {RoleMiningRoleTypeBeta} - * @memberof RoleMiningSessionResponseBeta - */ - 'type'?: RoleMiningRoleTypeBeta; -} - - -/** - * @type RoleMiningSessionResponseCreatedByBeta - * The session created by details - * @export - */ -export type RoleMiningSessionResponseCreatedByBeta = EntityCreatedByDTOBeta | string; - -/** - * - * @export - * @interface RoleMiningSessionScopeBeta - */ -export interface RoleMiningSessionScopeBeta { - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeBeta - */ - 'identityIds'?: Array; - /** - * The \"search\" criteria that produces the list of identities for this role mining session. - * @type {string} - * @memberof RoleMiningSessionScopeBeta - */ - 'criteria'?: string | null; - /** - * The filter criteria for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeBeta - */ - 'attributeFilterCriteria'?: Array | null; -} -/** - * The scoping method used in the current role mining session. - * @export - * @enum {string} - */ - -export const RoleMiningSessionScopingMethodBeta = { - Manual: 'MANUAL', - AutoRm: 'AUTO_RM' -} as const; - -export type RoleMiningSessionScopingMethodBeta = typeof RoleMiningSessionScopingMethodBeta[keyof typeof RoleMiningSessionScopingMethodBeta]; - - -/** - * Role mining session status - * @export - * @enum {string} - */ - -export const RoleMiningSessionStateBeta = { - Created: 'CREATED', - Updated: 'UPDATED', - IdentitiesObtained: 'IDENTITIES_OBTAINED', - PruneThresholdObtained: 'PRUNE_THRESHOLD_OBTAINED', - PotentialRolesProcessing: 'POTENTIAL_ROLES_PROCESSING', - PotentialRolesCreated: 'POTENTIAL_ROLES_CREATED' -} as const; - -export type RoleMiningSessionStateBeta = typeof RoleMiningSessionStateBeta[keyof typeof RoleMiningSessionStateBeta]; - - -/** - * - * @export - * @interface RoleMiningSessionStatusBeta - */ -export interface RoleMiningSessionStatusBeta { - /** - * - * @type {RoleMiningSessionStateBeta} - * @memberof RoleMiningSessionStatusBeta - */ - 'state'?: RoleMiningSessionStateBeta; -} - - -/** - * - * @export - * @interface RoleTargetDtoBeta - */ -export interface RoleTargetDtoBeta { - /** - * - * @type {BaseReferenceDto1Beta} - * @memberof RoleTargetDtoBeta - */ - 'source'?: BaseReferenceDto1Beta; - /** - * - * @type {AccountInfoDtoBeta} - * @memberof RoleTargetDtoBeta - */ - 'accountInfo'?: AccountInfoDtoBeta; - /** - * - * @type {BaseReferenceDto1Beta} - * @memberof RoleTargetDtoBeta - */ - 'role'?: BaseReferenceDto1Beta; -} -/** - * @type RuleBeta - * @export - */ -export type RuleBeta = GenerateRandomStringBeta | GetReferenceIdentityAttributeBeta | TransformRuleBeta; - -/** - * - * @export - * @interface SavedSearchCompleteBeta - */ -export interface SavedSearchCompleteBeta { - /** - * Report file name. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'fileName': string; - /** - * Email address of the identity who owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'ownerEmail': string; - /** - * Name of the identity who owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'ownerName': string; - /** - * Search query used to generate the report. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'query': string; - /** - * Saved search name. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'searchName': string; - /** - * - * @type {SavedSearchCompleteSearchResultsBeta} - * @memberof SavedSearchCompleteBeta - */ - 'searchResults': SavedSearchCompleteSearchResultsBeta; - /** - * The Amazon S3 URL to download the report from. - * @type {string} - * @memberof SavedSearchCompleteBeta - */ - 'signedS3Url': string; -} -/** - * Table of accounts matching the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsAccountBeta - */ -export interface SavedSearchCompleteSearchResultsAccountBeta { - /** - * Number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountBeta - */ - 'count': string; - /** - * Type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountBeta - */ - 'noun': string; - /** - * Sample of table data. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsAccountBeta - */ - 'preview': Array>; -} -/** - * Preview of the search results for each object type. This includes a count as well as headers and the first several rows of data, per object type. - * @export - * @interface SavedSearchCompleteSearchResultsBeta - */ -export interface SavedSearchCompleteSearchResultsBeta { - /** - * - * @type {SavedSearchCompleteSearchResultsAccountBeta} - * @memberof SavedSearchCompleteSearchResultsBeta - */ - 'Account'?: SavedSearchCompleteSearchResultsAccountBeta | null; - /** - * - * @type {SavedSearchCompleteSearchResultsEntitlementBeta} - * @memberof SavedSearchCompleteSearchResultsBeta - */ - 'Entitlement'?: SavedSearchCompleteSearchResultsEntitlementBeta | null; - /** - * - * @type {SavedSearchCompleteSearchResultsIdentityBeta} - * @memberof SavedSearchCompleteSearchResultsBeta - */ - 'Identity'?: SavedSearchCompleteSearchResultsIdentityBeta | null; -} -/** - * Table of entitlements matching the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsEntitlementBeta - */ -export interface SavedSearchCompleteSearchResultsEntitlementBeta { - /** - * Number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementBeta - */ - 'count': string; - /** - * Type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementBeta - */ - 'noun': string; - /** - * Sample of table data. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsEntitlementBeta - */ - 'preview': Array>; -} -/** - * Table of identities matching the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsIdentityBeta - */ -export interface SavedSearchCompleteSearchResultsIdentityBeta { - /** - * Number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityBeta - */ - 'count': string; - /** - * Type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityBeta - */ - 'noun': string; - /** - * Sample of the table data. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsIdentityBeta - */ - 'preview': Array>; -} -/** - * The schedule information. - * @export - * @interface Schedule1Beta - */ -export interface Schedule1Beta { - /** - * - * @type {ScheduleTypeBeta} - * @memberof Schedule1Beta - */ - 'type': ScheduleTypeBeta; - /** - * - * @type {Schedule1MonthsBeta} - * @memberof Schedule1Beta - */ - 'months'?: Schedule1MonthsBeta; - /** - * - * @type {Schedule1DaysBeta} - * @memberof Schedule1Beta - */ - 'days'?: Schedule1DaysBeta; - /** - * - * @type {Schedule1HoursBeta} - * @memberof Schedule1Beta - */ - 'hours': Schedule1HoursBeta; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Schedule1Beta - */ - 'expiration'?: string | null; - /** - * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. - * @type {string} - * @memberof Schedule1Beta - */ - 'timeZoneId'?: string | null; -} - - -/** - * - * @export - * @interface Schedule1DaysBeta - */ -export interface Schedule1DaysBeta { - /** - * The application id - * @type {string} - * @memberof Schedule1DaysBeta - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigBeta} - * @memberof Schedule1DaysBeta - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigBeta; -} -/** - * - * @export - * @interface Schedule1HoursBeta - */ -export interface Schedule1HoursBeta { - /** - * The application id - * @type {string} - * @memberof Schedule1HoursBeta - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigBeta} - * @memberof Schedule1HoursBeta - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigBeta; -} -/** - * - * @export - * @interface Schedule1MonthsBeta - */ -export interface Schedule1MonthsBeta { - /** - * The application id - * @type {string} - * @memberof Schedule1MonthsBeta - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigBeta} - * @memberof Schedule1MonthsBeta - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigBeta; -} -/** - * - * @export - * @interface ScheduleBeta - */ -export interface ScheduleBeta { - /** - * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. - * @type {string} - * @memberof ScheduleBeta - */ - 'type': ScheduleBetaTypeBeta; - /** - * - * @type {ScheduleMonthsBeta} - * @memberof ScheduleBeta - */ - 'months'?: ScheduleMonthsBeta; - /** - * - * @type {ScheduleDaysBeta} - * @memberof ScheduleBeta - */ - 'days'?: ScheduleDaysBeta; - /** - * - * @type {ScheduleHoursBeta} - * @memberof ScheduleBeta - */ - 'hours': ScheduleHoursBeta; - /** - * Specifies the time after which this schedule will no longer occur. - * @type {string} - * @memberof ScheduleBeta - */ - 'expiration'?: string; - /** - * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. - * @type {string} - * @memberof ScheduleBeta - */ - 'timeZoneId'?: string; -} - -export const ScheduleBetaTypeBeta = { - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Annually: 'ANNUALLY', - Calendar: 'CALENDAR' -} as const; - -export type ScheduleBetaTypeBeta = typeof ScheduleBetaTypeBeta[keyof typeof ScheduleBetaTypeBeta]; - -/** - * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" - * @export - * @interface ScheduleDaysBeta - */ -export interface ScheduleDaysBeta { - /** - * Enum type to specify days value - * @type {string} - * @memberof ScheduleDaysBeta - */ - 'type': ScheduleDaysBetaTypeBeta; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleDaysBeta - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleDaysBeta - */ - 'interval'?: number; -} - -export const ScheduleDaysBetaTypeBeta = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleDaysBetaTypeBeta = typeof ScheduleDaysBetaTypeBeta[keyof typeof ScheduleDaysBetaTypeBeta]; - -/** - * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" - * @export - * @interface ScheduleHoursBeta - */ -export interface ScheduleHoursBeta { - /** - * Enum type to specify hours value - * @type {string} - * @memberof ScheduleHoursBeta - */ - 'type': ScheduleHoursBetaTypeBeta; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleHoursBeta - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleHoursBeta - */ - 'interval'?: number; -} - -export const ScheduleHoursBetaTypeBeta = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleHoursBetaTypeBeta = typeof ScheduleHoursBetaTypeBeta[keyof typeof ScheduleHoursBetaTypeBeta]; - -/** - * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 - * @export - * @interface ScheduleMonthsBeta - */ -export interface ScheduleMonthsBeta { - /** - * Enum type to specify months value - * @type {string} - * @memberof ScheduleMonthsBeta - */ - 'type': ScheduleMonthsBetaTypeBeta; - /** - * Values of the months based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleMonthsBeta - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleMonthsBeta - */ - 'interval'?: number; -} - -export const ScheduleMonthsBetaTypeBeta = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleMonthsBetaTypeBeta = typeof ScheduleMonthsBetaTypeBeta[keyof typeof ScheduleMonthsBetaTypeBeta]; - -/** - * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const ScheduleTypeBeta = { - Daily: 'DAILY', - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Calendar: 'CALENDAR', - Annually: 'ANNUALLY' -} as const; - -export type ScheduleTypeBeta = typeof ScheduleTypeBeta[keyof typeof ScheduleTypeBeta]; - - -/** - * Attributes related to a scheduled trigger - * @export - * @interface ScheduledAttributesBeta - */ -export interface ScheduledAttributesBeta { - /** - * Frequency of execution - * @type {string} - * @memberof ScheduledAttributesBeta - */ - 'frequency': ScheduledAttributesBetaFrequencyBeta | null; - /** - * Time zone identifier - * @type {string} - * @memberof ScheduledAttributesBeta - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof ScheduledAttributesBeta - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof ScheduledAttributesBeta - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesBeta - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesBeta - */ - 'yearlyTimes'?: Array | null; -} - -export const ScheduledAttributesBetaFrequencyBeta = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type ScheduledAttributesBetaFrequencyBeta = typeof ScheduledAttributesBetaFrequencyBeta[keyof typeof ScheduledAttributesBetaFrequencyBeta]; - -/** - * - * @export - * @interface SchemaBeta - */ -export interface SchemaBeta { - /** - * The id of the Schema. - * @type {string} - * @memberof SchemaBeta - */ - 'id'?: string; - /** - * The name of the Schema. - * @type {string} - * @memberof SchemaBeta - */ - 'name'?: string; - /** - * The name of the object type on the native system that the schema represents. - * @type {string} - * @memberof SchemaBeta - */ - 'nativeObjectType'?: string; - /** - * The name of the attribute used to calculate the unique identifier for an object in the schema. - * @type {string} - * @memberof SchemaBeta - */ - 'identityAttribute'?: string; - /** - * The name of the attribute used to calculate the display value for an object in the schema. - * @type {string} - * @memberof SchemaBeta - */ - 'displayAttribute'?: string; - /** - * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - * @type {string} - * @memberof SchemaBeta - */ - 'hierarchyAttribute'?: string | null; - /** - * Flag indicating whether or not the include permissions with the object data when aggregating the schema. - * @type {boolean} - * @memberof SchemaBeta - */ - 'includePermissions'?: boolean; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SchemaBeta - */ - 'features'?: Array; - /** - * Holds any extra configuration data that the schema may require. - * @type {object} - * @memberof SchemaBeta - */ - 'configuration'?: object; - /** - * The attribute definitions which form the schema. - * @type {Array} - * @memberof SchemaBeta - */ - 'attributes'?: Array; - /** - * The date the Schema was created. - * @type {string} - * @memberof SchemaBeta - */ - 'created'?: string; - /** - * The date the Schema was last modified. - * @type {string} - * @memberof SchemaBeta - */ - 'modified'?: string | null; -} - -export const SchemaBetaFeaturesBeta = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SchemaBetaFeaturesBeta = typeof SchemaBetaFeaturesBeta[keyof typeof SchemaBetaFeaturesBeta]; - -/** - * - * @export - * @interface SearchAttributeConfigBeta - */ -export interface SearchAttributeConfigBeta { - /** - * Name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigBeta - */ - 'name'?: string; - /** - * The display name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigBeta - */ - 'displayName'?: string; - /** - * Map of application id and their associated attribute. - * @type {object} - * @memberof SearchAttributeConfigBeta - */ - 'applicationAttributes'?: object; -} -/** - * Represents the search criteria for querying entitlements. - * @export - * @interface SearchCriteriaBeta - */ -export interface SearchCriteriaBeta { - /** - * A list of indices to search within. Must contain exactly one item, typically \"entitlements\". - * @type {Array} - * @memberof SearchCriteriaBeta - */ - 'indices': Array; - /** - * A map of filters applied to the search. Keys are filter names, and values are filter definitions. - * @type {{ [key: string]: SearchCriteriaFiltersValueBeta; }} - * @memberof SearchCriteriaBeta - */ - 'filters'?: { [key: string]: SearchCriteriaFiltersValueBeta; }; - /** - * - * @type {SearchCriteriaQueryBeta} - * @memberof SearchCriteriaBeta - */ - 'query'?: SearchCriteriaQueryBeta; - /** - * Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. - * @type {string} - * @memberof SearchCriteriaBeta - */ - 'queryType'?: string; - /** - * - * @type {SearchCriteriaTextQueryBeta} - * @memberof SearchCriteriaBeta - */ - 'textQuery'?: SearchCriteriaTextQueryBeta; - /** - * Whether to include nested objects in the search results. - * @type {boolean} - * @memberof SearchCriteriaBeta - */ - 'includeNested'?: boolean; - /** - * Specifies the sorting order for the results. - * @type {Array} - * @memberof SearchCriteriaBeta - */ - 'sort'?: Array; - /** - * Used for pagination to fetch results after a specific point. - * @type {Array} - * @memberof SearchCriteriaBeta - */ - 'searchAfter'?: Array; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueBeta - */ -export interface SearchCriteriaFiltersValueBeta { - /** - * The type of filter, e.g., \"TERMS\" or \"RANGE\". - * @type {string} - * @memberof SearchCriteriaFiltersValueBeta - */ - 'type'?: string; - /** - * Terms to filter by (for \"TERMS\" type). - * @type {Array} - * @memberof SearchCriteriaFiltersValueBeta - */ - 'terms'?: Array; - /** - * - * @type {SearchCriteriaFiltersValueRangeBeta} - * @memberof SearchCriteriaFiltersValueBeta - */ - 'range'?: SearchCriteriaFiltersValueRangeBeta; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeBeta - */ -export interface SearchCriteriaFiltersValueRangeBeta { - /** - * - * @type {SearchCriteriaFiltersValueRangeLowerBeta} - * @memberof SearchCriteriaFiltersValueRangeBeta - */ - 'lower'?: SearchCriteriaFiltersValueRangeLowerBeta; - /** - * - * @type {SearchCriteriaFiltersValueRangeUpperBeta} - * @memberof SearchCriteriaFiltersValueRangeBeta - */ - 'upper'?: SearchCriteriaFiltersValueRangeUpperBeta; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeLowerBeta - */ -export interface SearchCriteriaFiltersValueRangeLowerBeta { - /** - * The lower bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeLowerBeta - */ - 'value'?: string; - /** - * Whether the lower bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeLowerBeta - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeUpperBeta - */ -export interface SearchCriteriaFiltersValueRangeUpperBeta { - /** - * The upper bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeUpperBeta - */ - 'value'?: string; - /** - * Whether the upper bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeUpperBeta - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaQueryBeta - */ -export interface SearchCriteriaQueryBeta { - /** - * A structured query for advanced search. - * @type {string} - * @memberof SearchCriteriaQueryBeta - */ - 'query'?: string; -} -/** - * - * @export - * @interface SearchCriteriaTextQueryBeta - */ -export interface SearchCriteriaTextQueryBeta { - /** - * Terms to search for. - * @type {Array} - * @memberof SearchCriteriaTextQueryBeta - */ - 'terms'?: Array; - /** - * Fields to search within. - * @type {Array} - * @memberof SearchCriteriaTextQueryBeta - */ - 'fields'?: Array; - /** - * Whether to match any of the terms. - * @type {boolean} - * @memberof SearchCriteriaTextQueryBeta - */ - 'matchAny'?: boolean; -} -/** - * - * @export - * @interface SearchFormDefinitionsByTenant400ResponseBeta - */ -export interface SearchFormDefinitionsByTenant400ResponseBeta { - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseBeta - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof SearchFormDefinitionsByTenant400ResponseBeta - */ - 'messages'?: Array; - /** - * - * @type {number} - * @memberof SearchFormDefinitionsByTenant400ResponseBeta - */ - 'statusCode'?: number; - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseBeta - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface SectionBeta - */ -export interface SectionBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionBeta - */ - 'name'?: string; - /** - * Label of the section - * @type {string} - * @memberof SectionBeta - */ - 'label'?: string; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionBeta - */ - 'formItems'?: Array; -} -/** - * - * @export - * @interface SectionDetailsBeta - */ -export interface SectionDetailsBeta { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionDetailsBeta - */ - 'name'?: string; - /** - * Label of the section - * @type {string} - * @memberof SectionDetailsBeta - */ - 'label'?: string; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionDetailsBeta - */ - 'formItems'?: Array; -} -/** - * Sed Approval Request Body - * @export - * @interface SedApprovalBeta - */ -export interface SedApprovalBeta { - /** - * List of SED id\'s - * @type {Array} - * @memberof SedApprovalBeta - */ - 'items'?: Array; -} -/** - * SED Approval Status - * @export - * @interface SedApprovalStatusBeta - */ -export interface SedApprovalStatusBeta { - /** - * failed reason will be display if status is failed - * @type {string} - * @memberof SedApprovalStatusBeta - */ - 'failedReason'?: string; - /** - * Sed id - * @type {string} - * @memberof SedApprovalStatusBeta - */ - 'id'?: string; - /** - * SUCCESS | FAILED - * @type {string} - * @memberof SedApprovalStatusBeta - */ - 'status'?: string; -} -/** - * Sed Assignee - * @export - * @interface SedAssigneeBeta - */ -export interface SedAssigneeBeta { - /** - * Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE - * @type {string} - * @memberof SedAssigneeBeta - */ - 'type': SedAssigneeBetaTypeBeta; - /** - * Identity or Group identifier Empty when using source/entitlement owner personas - * @type {string} - * @memberof SedAssigneeBeta - */ - 'value'?: string; -} - -export const SedAssigneeBetaTypeBeta = { - Identity: 'IDENTITY', - Group: 'GROUP', - SourceOwner: 'SOURCE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER' -} as const; - -export type SedAssigneeBetaTypeBeta = typeof SedAssigneeBetaTypeBeta[keyof typeof SedAssigneeBetaTypeBeta]; - -/** - * Sed Assignment - * @export - * @interface SedAssignmentBeta - */ -export interface SedAssignmentBeta { - /** - * - * @type {SedAssigneeBeta} - * @memberof SedAssignmentBeta - */ - 'assignee'?: SedAssigneeBeta; - /** - * List of SED id\'s - * @type {Array} - * @memberof SedAssignmentBeta - */ - 'items'?: Array; -} -/** - * Sed Assignment Response - * @export - * @interface SedAssignmentResponseBeta - */ -export interface SedAssignmentResponseBeta { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedAssignmentResponseBeta - */ - 'batchId'?: string; -} -/** - * Sed Batch Request - * @export - * @interface SedBatchRequestBeta - */ -export interface SedBatchRequestBeta { - /** - * list of entitlement ids - * @type {Array} - * @memberof SedBatchRequestBeta - */ - 'entitlements'?: Array | null; - /** - * list of sed ids - * @type {Array} - * @memberof SedBatchRequestBeta - */ - 'seds'?: Array | null; - /** - * Search criteria for the batch request. - * @type {{ [key: string]: SearchCriteriaBeta; }} - * @memberof SedBatchRequestBeta - */ - 'searchCriteria'?: { [key: string]: SearchCriteriaBeta; } | null; -} -/** - * Sed Batch Response - * @export - * @interface SedBatchResponseBeta - */ -export interface SedBatchResponseBeta { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedBatchResponseBeta - */ - 'batchId'?: string; -} -/** - * Sed Batch Stats - * @export - * @interface SedBatchStatsBeta - */ -export interface SedBatchStatsBeta { - /** - * batch complete - * @type {boolean} - * @memberof SedBatchStatsBeta - */ - 'batchComplete'?: boolean; - /** - * batch Id - * @type {string} - * @memberof SedBatchStatsBeta - */ - 'batchId'?: string; - /** - * discovered count - * @type {number} - * @memberof SedBatchStatsBeta - */ - 'discoveredCount'?: number; - /** - * discovery complete - * @type {boolean} - * @memberof SedBatchStatsBeta - */ - 'discoveryComplete'?: boolean; - /** - * processed count - * @type {number} - * @memberof SedBatchStatsBeta - */ - 'processedCount'?: number; -} -/** - * Suggested Entitlement Description - * @export - * @interface SedBeta - */ -export interface SedBeta { - /** - * name of the entitlement - * @type {string} - * @memberof SedBeta - */ - 'Name'?: string; - /** - * entitlement approved by - * @type {string} - * @memberof SedBeta - */ - 'approved_by'?: string; - /** - * entitlement approved type - * @type {string} - * @memberof SedBeta - */ - 'approved_type'?: string; - /** - * entitlement approved then - * @type {string} - * @memberof SedBeta - */ - 'approved_when'?: string; - /** - * entitlement attribute - * @type {string} - * @memberof SedBeta - */ - 'attribute'?: string; - /** - * description of entitlement - * @type {string} - * @memberof SedBeta - */ - 'description'?: string; - /** - * entitlement display name - * @type {string} - * @memberof SedBeta - */ - 'displayName'?: string; - /** - * sed id - * @type {string} - * @memberof SedBeta - */ - 'id'?: string; - /** - * entitlement source id - * @type {string} - * @memberof SedBeta - */ - 'sourceId'?: string; - /** - * entitlement source name - * @type {string} - * @memberof SedBeta - */ - 'sourceName'?: string; - /** - * entitlement status - * @type {string} - * @memberof SedBeta - */ - 'status'?: string; - /** - * llm suggested entitlement description - * @type {string} - * @memberof SedBeta - */ - 'suggestedDescription'?: string; - /** - * entitlement type - * @type {string} - * @memberof SedBeta - */ - 'type'?: string; - /** - * entitlement value - * @type {string} - * @memberof SedBeta - */ - 'value'?: string; -} -/** - * Patch for Suggested Entitlement Description - * @export - * @interface SedPatchBeta - */ -export interface SedPatchBeta { - /** - * desired operation - * @type {string} - * @memberof SedPatchBeta - */ - 'op'?: string; - /** - * field to be patched - * @type {string} - * @memberof SedPatchBeta - */ - 'path'?: string; - /** - * value to replace with - * @type {object} - * @memberof SedPatchBeta - */ - 'value'?: object; -} -/** - * - * @export - * @interface SegmentBeta - */ -export interface SegmentBeta { - /** - * The segment\'s ID. - * @type {string} - * @memberof SegmentBeta - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof SegmentBeta - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof SegmentBeta - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof SegmentBeta - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof SegmentBeta - */ - 'description'?: string; - /** - * - * @type {OwnerReferenceSegmentsBeta} - * @memberof SegmentBeta - */ - 'owner'?: OwnerReferenceSegmentsBeta | null; - /** - * - * @type {VisibilityCriteriaBeta} - * @memberof SegmentBeta - */ - 'visibilityCriteria'?: VisibilityCriteriaBeta | null; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof SegmentBeta - */ - 'active'?: boolean; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigBeta - */ -export interface SelectorAccountMatchConfigBeta { - /** - * - * @type {SelectorAccountMatchConfigMatchExpressionBeta} - * @memberof SelectorAccountMatchConfigBeta - */ - 'matchExpression'?: SelectorAccountMatchConfigMatchExpressionBeta; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigMatchExpressionBeta - */ -export interface SelectorAccountMatchConfigMatchExpressionBeta { - /** - * - * @type {Array} - * @memberof SelectorAccountMatchConfigMatchExpressionBeta - */ - 'matchTerms'?: Array; - /** - * If it is AND operators for match terms - * @type {boolean} - * @memberof SelectorAccountMatchConfigMatchExpressionBeta - */ - 'and'?: boolean; -} -/** - * - * @export - * @interface SelectorBeta - */ -export interface SelectorBeta { - /** - * The application id - * @type {string} - * @memberof SelectorBeta - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigBeta} - * @memberof SelectorBeta - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigBeta; -} -/** - * Self block for imported/exported object. - * @export - * @interface SelfImportExportDtoBeta - */ -export interface SelfImportExportDtoBeta { - /** - * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. - * @type {string} - * @memberof SelfImportExportDtoBeta - */ - 'type'?: SelfImportExportDtoBetaTypeBeta; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof SelfImportExportDtoBeta - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof SelfImportExportDtoBeta - */ - 'name'?: string; -} - -export const SelfImportExportDtoBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type SelfImportExportDtoBetaTypeBeta = typeof SelfImportExportDtoBetaTypeBeta[keyof typeof SelfImportExportDtoBetaTypeBeta]; - -/** - * - * @export - * @interface SendAccountVerificationRequestBeta - */ -export interface SendAccountVerificationRequestBeta { - /** - * The source name where identity account password should be reset - * @type {string} - * @memberof SendAccountVerificationRequestBeta - */ - 'sourceName'?: string | null; - /** - * The method to send notification - * @type {string} - * @memberof SendAccountVerificationRequestBeta - */ - 'via': SendAccountVerificationRequestBetaViaBeta; -} - -export const SendAccountVerificationRequestBetaViaBeta = { - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL', - LinkWork: 'LINK_WORK', - LinkPersonal: 'LINK_PERSONAL' -} as const; - -export type SendAccountVerificationRequestBetaViaBeta = typeof SendAccountVerificationRequestBetaViaBeta[keyof typeof SendAccountVerificationRequestBetaViaBeta]; - -/** - * - * @export - * @interface SendTestNotificationRequestDtoBeta - */ -export interface SendTestNotificationRequestDtoBeta { - /** - * The template notification key. - * @type {string} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'key'?: string; - /** - * The notification medium. Has to be one of the following enum values. - * @type {string} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'medium'?: SendTestNotificationRequestDtoBetaMediumBeta; - /** - * The locale for the message text. - * @type {string} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'locale'?: string; - /** - * A Json object that denotes the context specific to the template. - * @type {object} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'context'?: object; - /** - * A list of override recipient email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'recipientEmailList'?: Array; - /** - * A list of CC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'carbonCopy'?: Array; - /** - * A list of BCC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoBeta - */ - 'blindCarbonCopy'?: Array; -} - -export const SendTestNotificationRequestDtoBetaMediumBeta = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type SendTestNotificationRequestDtoBetaMediumBeta = typeof SendTestNotificationRequestDtoBetaMediumBeta[keyof typeof SendTestNotificationRequestDtoBetaMediumBeta]; - -/** - * - * @export - * @interface SendTokenRequestBeta - */ -export interface SendTokenRequestBeta { - /** - * User alias from table spt_identity field named \'name\' - * @type {string} - * @memberof SendTokenRequestBeta - */ - 'userAlias': string; - /** - * Token delivery type - * @type {string} - * @memberof SendTokenRequestBeta - */ - 'deliveryType': SendTokenRequestBetaDeliveryTypeBeta; -} - -export const SendTokenRequestBetaDeliveryTypeBeta = { - SmsPersonal: 'SMS_PERSONAL', - VoicePersonal: 'VOICE_PERSONAL', - SmsWork: 'SMS_WORK', - VoiceWork: 'VOICE_WORK', - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL' -} as const; - -export type SendTokenRequestBetaDeliveryTypeBeta = typeof SendTokenRequestBetaDeliveryTypeBeta[keyof typeof SendTokenRequestBetaDeliveryTypeBeta]; - -/** - * - * @export - * @interface SendTokenResponseBeta - */ -export interface SendTokenResponseBeta { - /** - * The token request ID - * @type {string} - * @memberof SendTokenResponseBeta - */ - 'requestId'?: string | null; - /** - * Status of sending token - * @type {string} - * @memberof SendTokenResponseBeta - */ - 'status'?: SendTokenResponseBetaStatusBeta; - /** - * Error messages from token send request - * @type {string} - * @memberof SendTokenResponseBeta - */ - 'errorMessage'?: string | null; -} - -export const SendTokenResponseBetaStatusBeta = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type SendTokenResponseBetaStatusBeta = typeof SendTokenResponseBetaStatusBeta[keyof typeof SendTokenResponseBetaStatusBeta]; - -/** - * - * @export - * @interface ServiceDeskIntegrationDtoBeta - */ -export interface ServiceDeskIntegrationDtoBeta { - /** - * Service Desk integration\'s name. The name must be unique. - * @type {string} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'name': string; - /** - * Service Desk integration\'s description. - * @type {string} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'description': string; - /** - * Service Desk integration types: - ServiceNowSDIM - ServiceNow - * @type {string} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'type': string; - /** - * - * @type {OwnerDtoBeta} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'ownerRef'?: OwnerDtoBeta; - /** - * - * @type {SourceClusterDtoBeta} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'clusterRef'?: SourceClusterDtoBeta; - /** - * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - * @type {string} - * @memberof ServiceDeskIntegrationDtoBeta - * @deprecated - */ - 'cluster'?: string; - /** - * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - * @type {Array} - * @memberof ServiceDeskIntegrationDtoBeta - * @deprecated - */ - 'managedSources'?: Array; - /** - * - * @type {ProvisioningConfigBeta} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'provisioningConfig'?: ProvisioningConfigBeta; - /** - * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {BeforeProvisioningRuleDtoBeta} - * @memberof ServiceDeskIntegrationDtoBeta - */ - 'beforeProvisioningRule'?: BeforeProvisioningRuleDtoBeta; -} -/** - * - * @export - * @interface ServiceDeskIntegrationTemplateDtoBeta - */ -export interface ServiceDeskIntegrationTemplateDtoBeta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'modified'?: string; - /** - * The \'type\' property specifies the type of the Service Desk integration template. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'type': string; - /** - * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {ProvisioningConfigBeta} - * @memberof ServiceDeskIntegrationTemplateDtoBeta - */ - 'provisioningConfig': ProvisioningConfigBeta; -} -/** - * This represents a Service Desk Integration template type. - * @export - * @interface ServiceDeskIntegrationTemplateTypeBeta - */ -export interface ServiceDeskIntegrationTemplateTypeBeta { - /** - * This is the name of the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeBeta - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeBeta - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeBeta - */ - 'scriptName': string; -} -/** - * Source for Service Desk integration template. - * @export - * @interface ServiceDeskSourceBeta - */ -export interface ServiceDeskSourceBeta { - /** - * DTO type of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceBeta - */ - 'type'?: ServiceDeskSourceBetaTypeBeta; - /** - * ID of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceBeta - */ - 'id'?: string; - /** - * Human-readable name of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceBeta - */ - 'name'?: string; -} - -export const ServiceDeskSourceBetaTypeBeta = { - Source: 'SOURCE' -} as const; - -export type ServiceDeskSourceBetaTypeBeta = typeof ServiceDeskSourceBetaTypeBeta[keyof typeof ServiceDeskSourceBetaTypeBeta]; - -/** - * - * @export - * @interface SetIcon200ResponseBeta - */ -export interface SetIcon200ResponseBeta { - /** - * url to file with icon - * @type {string} - * @memberof SetIcon200ResponseBeta - */ - 'icon'?: string; -} -/** - * - * @export - * @interface SetIconRequestBeta - */ -export interface SetIconRequestBeta { - /** - * file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] - * @type {File} - * @memberof SetIconRequestBeta - */ - 'image': File; -} -/** - * Before provisioning rule of integration - * @export - * @interface SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta - */ -export interface SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta { - /** - * - * @type {DtoTypeBeta} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta - */ - 'type'?: DtoTypeBeta; - /** - * ID of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta - */ - 'id'?: string; - /** - * Human-readable display name of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SimIntegrationDetailsBeta - */ -export interface SimIntegrationDetailsBeta { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'modified'?: string; - /** - * The description of the integration - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'description'?: string; - /** - * The integration type - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'type'?: string; - /** - * The attributes map containing the credentials used to configure the integration. - * @type {object} - * @memberof SimIntegrationDetailsBeta - */ - 'attributes'?: object | null; - /** - * The list of sources (managed resources) - * @type {Array} - * @memberof SimIntegrationDetailsBeta - */ - 'sources'?: Array; - /** - * The cluster/proxy - * @type {string} - * @memberof SimIntegrationDetailsBeta - */ - 'cluster'?: string; - /** - * Custom mapping between the integration result and the provisioning result - * @type {object} - * @memberof SimIntegrationDetailsBeta - */ - 'statusMap'?: object; - /** - * Request data to customize desc and body of the created ticket - * @type {object} - * @memberof SimIntegrationDetailsBeta - */ - 'request'?: object; - /** - * - * @type {SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta} - * @memberof SimIntegrationDetailsBeta - */ - 'beforeProvisioningRule'?: SimIntegrationDetailsAllOfBeforeProvisioningRuleBeta; -} -/** - * Discovered applications - * @export - * @interface SlimDiscoveredApplicationsBeta - */ -export interface SlimDiscoveredApplicationsBeta { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'status'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsBeta - */ - 'riskLevel'?: SlimDiscoveredApplicationsBetaRiskLevelBeta; -} - -export const SlimDiscoveredApplicationsBetaRiskLevelBeta = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type SlimDiscoveredApplicationsBetaRiskLevelBeta = typeof SlimDiscoveredApplicationsBetaRiskLevelBeta[keyof typeof SlimDiscoveredApplicationsBetaRiskLevelBeta]; - -/** - * - * @export - * @interface SlimcampaignBeta - */ -export interface SlimcampaignBeta { - /** - * Id of the campaign - * @type {string} - * @memberof SlimcampaignBeta - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimcampaignBeta - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimcampaignBeta - */ - 'description': string; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof SlimcampaignBeta - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof SlimcampaignBeta - */ - 'type': SlimcampaignBetaTypeBeta; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof SlimcampaignBeta - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof SlimcampaignBeta - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof SlimcampaignBeta - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof SlimcampaignBeta - */ - 'status'?: SlimcampaignBetaStatusBeta; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof SlimcampaignBeta - */ - 'correlatedStatus'?: SlimcampaignBetaCorrelatedStatusBeta; - /** - * Created time of the campaign - * @type {string} - * @memberof SlimcampaignBeta - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof SlimcampaignBeta - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof SlimcampaignBeta - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof SlimcampaignBeta - */ - 'alerts'?: Array; -} - -export const SlimcampaignBetaTypeBeta = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type SlimcampaignBetaTypeBeta = typeof SlimcampaignBetaTypeBeta[keyof typeof SlimcampaignBetaTypeBeta]; -export const SlimcampaignBetaStatusBeta = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type SlimcampaignBetaStatusBeta = typeof SlimcampaignBetaStatusBeta[keyof typeof SlimcampaignBetaStatusBeta]; -export const SlimcampaignBetaCorrelatedStatusBeta = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type SlimcampaignBetaCorrelatedStatusBeta = typeof SlimcampaignBetaCorrelatedStatusBeta[keyof typeof SlimcampaignBetaCorrelatedStatusBeta]; - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteria1Beta - */ -export interface SodExemptCriteria1Beta { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteria1Beta - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeBeta} - * @memberof SodExemptCriteria1Beta - */ - 'type'?: DtoTypeBeta; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteria1Beta - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteria1Beta - */ - 'name'?: string; -} - - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteria2Beta - */ -export interface SodExemptCriteria2Beta { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteria2Beta - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeBeta} - * @memberof SodExemptCriteria2Beta - */ - 'type'?: DtoTypeBeta; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteria2Beta - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteria2Beta - */ - 'name'?: string; -} - - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteriaBeta - */ -export interface SodExemptCriteriaBeta { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteriaBeta - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeBeta} - * @memberof SodExemptCriteriaBeta - */ - 'type'?: DtoTypeBeta; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteriaBeta - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteriaBeta - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SodPolicyBeta - */ -export interface SodPolicyBeta { - /** - * Policy ID. - * @type {string} - * @memberof SodPolicyBeta - */ - 'id'?: string; - /** - * Policy business name. - * @type {string} - * @memberof SodPolicyBeta - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyBeta - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyBeta - */ - 'modified'?: string; - /** - * Optional description of the SOD policy. - * @type {string} - * @memberof SodPolicyBeta - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRefBeta} - * @memberof SodPolicyBeta - */ - 'ownerRef'?: SodPolicyOwnerRefBeta; - /** - * Optional external policy reference. - * @type {string} - * @memberof SodPolicyBeta - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy. - * @type {string} - * @memberof SodPolicyBeta - */ - 'policyQuery'?: string; - /** - * Optional compensating controls (Mitigating Controls). - * @type {string} - * @memberof SodPolicyBeta - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice. - * @type {string} - * @memberof SodPolicyBeta - */ - 'correctionAdvice'?: string | null; - /** - * Whether the policy is enforced or not. - * @type {string} - * @memberof SodPolicyBeta - */ - 'state'?: SodPolicyBetaStateBeta; - /** - * Tags for the policy object. - * @type {Array} - * @memberof SodPolicyBeta - */ - 'tags'?: Array; - /** - * Policy\'s creator ID. - * @type {string} - * @memberof SodPolicyBeta - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID. - * @type {string} - * @memberof SodPolicyBeta - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfigBeta} - * @memberof SodPolicyBeta - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfigBeta; - /** - * Defines whether a policy has been scheduled or not. - * @type {boolean} - * @memberof SodPolicyBeta - */ - 'scheduled'?: boolean; - /** - * Whether a policy is query based or conflicting access based. - * @type {string} - * @memberof SodPolicyBeta - */ - 'type'?: SodPolicyBetaTypeBeta; - /** - * - * @type {SodPolicyConflictingAccessCriteriaBeta} - * @memberof SodPolicyBeta - */ - 'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteriaBeta; -} - -export const SodPolicyBetaStateBeta = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyBetaStateBeta = typeof SodPolicyBetaStateBeta[keyof typeof SodPolicyBetaStateBeta]; -export const SodPolicyBetaTypeBeta = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyBetaTypeBeta = typeof SodPolicyBetaTypeBeta[keyof typeof SodPolicyBetaTypeBeta]; - -/** - * - * @export - * @interface SodPolicyConflictingAccessCriteriaBeta - */ -export interface SodPolicyConflictingAccessCriteriaBeta { - /** - * - * @type {AccessCriteriaBeta} - * @memberof SodPolicyConflictingAccessCriteriaBeta - */ - 'leftCriteria'?: AccessCriteriaBeta; - /** - * - * @type {AccessCriteriaBeta} - * @memberof SodPolicyConflictingAccessCriteriaBeta - */ - 'rightCriteria'?: AccessCriteriaBeta; -} -/** - * SOD policy. - * @export - * @interface SodPolicyDto1Beta - */ -export interface SodPolicyDto1Beta { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto1Beta - */ - 'type'?: SodPolicyDto1BetaTypeBeta; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto1Beta - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto1Beta - */ - 'name'?: string; -} - -export const SodPolicyDto1BetaTypeBeta = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDto1BetaTypeBeta = typeof SodPolicyDto1BetaTypeBeta[keyof typeof SodPolicyDto1BetaTypeBeta]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDtoBeta - */ -export interface SodPolicyDtoBeta { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDtoBeta - */ - 'type'?: SodPolicyDtoBetaTypeBeta; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDtoBeta - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDtoBeta - */ - 'name'?: string; -} - -export const SodPolicyDtoBetaTypeBeta = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDtoBetaTypeBeta = typeof SodPolicyDtoBetaTypeBeta[keyof typeof SodPolicyDtoBetaTypeBeta]; - -/** - * The owner of the SOD policy. - * @export - * @interface SodPolicyOwnerRefBeta - */ -export interface SodPolicyOwnerRefBeta { - /** - * Owner type. - * @type {string} - * @memberof SodPolicyOwnerRefBeta - */ - 'type'?: SodPolicyOwnerRefBetaTypeBeta; - /** - * Owner\'s ID. - * @type {string} - * @memberof SodPolicyOwnerRefBeta - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof SodPolicyOwnerRefBeta - */ - 'name'?: string; -} - -export const SodPolicyOwnerRefBetaTypeBeta = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SodPolicyOwnerRefBetaTypeBeta = typeof SodPolicyOwnerRefBetaTypeBeta[keyof typeof SodPolicyOwnerRefBetaTypeBeta]; - -/** - * - * @export - * @interface SodPolicyScheduleBeta - */ -export interface SodPolicyScheduleBeta { - /** - * SOD Policy schedule name - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'name'?: string; - /** - * The time when this SOD policy schedule is created. - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'created'?: string; - /** - * The time when this SOD policy schedule is modified. - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'modified'?: string; - /** - * SOD Policy schedule description - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'description'?: string; - /** - * - * @type {Schedule1Beta} - * @memberof SodPolicyScheduleBeta - */ - 'schedule'?: Schedule1Beta; - /** - * - * @type {Array} - * @memberof SodPolicyScheduleBeta - */ - 'recipients'?: Array; - /** - * Indicates if empty results need to be emailed - * @type {boolean} - * @memberof SodPolicyScheduleBeta - */ - 'emailEmptyResults'?: boolean; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyScheduleBeta - */ - 'modifierId'?: string; -} -/** - * SOD policy recipient. - * @export - * @interface SodRecipientBeta - */ -export interface SodRecipientBeta { - /** - * SOD policy recipient DTO type. - * @type {string} - * @memberof SodRecipientBeta - */ - 'type'?: SodRecipientBetaTypeBeta; - /** - * SOD policy recipient\'s identity ID. - * @type {string} - * @memberof SodRecipientBeta - */ - 'id'?: string; - /** - * SOD policy recipient\'s display name. - * @type {string} - * @memberof SodRecipientBeta - */ - 'name'?: string; -} - -export const SodRecipientBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type SodRecipientBetaTypeBeta = typeof SodRecipientBetaTypeBeta[keyof typeof SodRecipientBetaTypeBeta]; - -/** - * SOD policy violation report result. - * @export - * @interface SodReportResultDtoBeta - */ -export interface SodReportResultDtoBeta { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof SodReportResultDtoBeta - */ - 'type'?: SodReportResultDtoBetaTypeBeta; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof SodReportResultDtoBeta - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof SodReportResultDtoBeta - */ - 'name'?: string; -} - -export const SodReportResultDtoBetaTypeBeta = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type SodReportResultDtoBetaTypeBeta = typeof SodReportResultDtoBetaTypeBeta[keyof typeof SodReportResultDtoBetaTypeBeta]; - -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResult1Beta - */ -export interface SodViolationCheckResult1Beta { - /** - * - * @type {ErrorMessageDto1Beta} - * @memberof SodViolationCheckResult1Beta - */ - 'message'?: ErrorMessageDto1Beta; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResult1Beta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResult1Beta - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResult1Beta - */ - 'violatedPolicies'?: Array | null; -} -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResult2Beta - */ -export interface SodViolationCheckResult2Beta { - /** - * - * @type {ErrorMessageDtoBeta} - * @memberof SodViolationCheckResult2Beta - */ - 'message'?: ErrorMessageDtoBeta; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResult2Beta - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * - * @type {Array} - * @memberof SodViolationCheckResult2Beta - */ - 'violationContexts'?: Array; - /** - * A list of the Policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResult2Beta - */ - 'violatedPolicies'?: Array; -} -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResultBeta - */ -export interface SodViolationCheckResultBeta { - /** - * - * @type {ErrorMessageDtoBeta} - * @memberof SodViolationCheckResultBeta - */ - 'message'?: ErrorMessageDtoBeta; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResultBeta - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResultBeta - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResultBeta - */ - 'violatedPolicies'?: Array | null; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContext1Beta - */ -export interface SodViolationContext1Beta { - /** - * - * @type {SodPolicyDto1Beta} - * @memberof SodViolationContext1Beta - */ - 'policy'?: SodPolicyDto1Beta; - /** - * - * @type {SodViolationContext1ConflictingAccessCriteriaBeta} - * @memberof SodViolationContext1Beta - */ - 'conflictingAccessCriteria'?: SodViolationContext1ConflictingAccessCriteriaBeta; -} -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContext1ConflictingAccessCriteriaBeta - */ -export interface SodViolationContext1ConflictingAccessCriteriaBeta { - /** - * - * @type {SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContext1ConflictingAccessCriteriaBeta - */ - 'leftCriteria'?: SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta; - /** - * - * @type {SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContext1ConflictingAccessCriteriaBeta - */ - 'rightCriteria'?: SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta; -} -/** - * - * @export - * @interface SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta - */ -export interface SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta { - /** - * - * @type {Array} - * @memberof SodViolationContext1ConflictingAccessCriteriaLeftCriteriaBeta - */ - 'criteriaList'?: Array; -} -/** - * The contextual information of the violated criteria. - * @export - * @interface SodViolationContext2Beta - */ -export interface SodViolationContext2Beta { - /** - * - * @type {SodPolicyDto1Beta} - * @memberof SodViolationContext2Beta - */ - 'policy'?: SodPolicyDto1Beta; - /** - * - * @type {SodViolationContext2ConflictingAccessCriteriaBeta} - * @memberof SodViolationContext2Beta - */ - 'conflictingAccessCriteria'?: SodViolationContext2ConflictingAccessCriteriaBeta; -} -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContext2ConflictingAccessCriteriaBeta - */ -export interface SodViolationContext2ConflictingAccessCriteriaBeta { - /** - * - * @type {SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContext2ConflictingAccessCriteriaBeta - */ - 'leftCriteria'?: SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta; - /** - * - * @type {SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContext2ConflictingAccessCriteriaBeta - */ - 'rightCriteria'?: SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta; -} -/** - * - * @export - * @interface SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta - */ -export interface SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta { - /** - * - * @type {Array} - * @memberof SodViolationContext2ConflictingAccessCriteriaLeftCriteriaBeta - */ - 'criteriaList'?: Array; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContextBeta - */ -export interface SodViolationContextBeta { - /** - * - * @type {SodPolicyDto1Beta} - * @memberof SodViolationContextBeta - */ - 'policy'?: SodPolicyDto1Beta; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaBeta} - * @memberof SodViolationContextBeta - */ - 'conflictingAccessCriteria'?: SodViolationContextConflictingAccessCriteriaBeta; -} -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompleted1Beta - */ -export interface SodViolationContextCheckCompleted1Beta { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompleted1Beta - */ - 'state'?: SodViolationContextCheckCompleted1BetaStateBeta | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompleted1Beta - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResult1Beta} - * @memberof SodViolationContextCheckCompleted1Beta - */ - 'violationCheckResult'?: SodViolationCheckResult1Beta; -} - -export const SodViolationContextCheckCompleted1BetaStateBeta = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompleted1BetaStateBeta = typeof SodViolationContextCheckCompleted1BetaStateBeta[keyof typeof SodViolationContextCheckCompleted1BetaStateBeta]; - -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompleted2Beta - */ -export interface SodViolationContextCheckCompleted2Beta { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompleted2Beta - */ - 'state'?: SodViolationContextCheckCompleted2BetaStateBeta; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompleted2Beta - */ - 'uuid'?: string; - /** - * - * @type {SodViolationCheckResult2Beta} - * @memberof SodViolationContextCheckCompleted2Beta - */ - 'violationCheckResult'?: SodViolationCheckResult2Beta; -} - -export const SodViolationContextCheckCompleted2BetaStateBeta = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompleted2BetaStateBeta = typeof SodViolationContextCheckCompleted2BetaStateBeta[keyof typeof SodViolationContextCheckCompleted2BetaStateBeta]; - -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompletedBeta - */ -export interface SodViolationContextCheckCompletedBeta { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompletedBeta - */ - 'state'?: SodViolationContextCheckCompletedBetaStateBeta | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompletedBeta - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultBeta} - * @memberof SodViolationContextCheckCompletedBeta - */ - 'violationCheckResult'?: SodViolationCheckResultBeta; -} - -export const SodViolationContextCheckCompletedBetaStateBeta = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompletedBetaStateBeta = typeof SodViolationContextCheckCompletedBetaStateBeta[keyof typeof SodViolationContextCheckCompletedBetaStateBeta]; - -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContextConflictingAccessCriteriaBeta - */ -export interface SodViolationContextConflictingAccessCriteriaBeta { - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContextConflictingAccessCriteriaBeta - */ - 'leftCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta} - * @memberof SodViolationContextConflictingAccessCriteriaBeta - */ - 'rightCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta; -} -/** - * - * @export - * @interface SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta - */ -export interface SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta { - /** - * - * @type {Array} - * @memberof SodViolationContextConflictingAccessCriteriaLeftCriteriaBeta - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface Source1Beta - */ -export interface Source1Beta { - /** - * Attribute mapping type. - * @type {string} - * @memberof Source1Beta - */ - 'type'?: string; - /** - * Attribute mapping properties. - * @type {object} - * @memberof Source1Beta - */ - 'properties'?: object; -} -/** - * - * @export - * @interface SourceAccountCreatedBeta - */ -export interface SourceAccountCreatedBeta { - /** - * Identity\'s universal unique identifier (UUID) on the source. The source system generates the UUID. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'uuid': string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'id': string; - /** - * Account\'s unique ID on the source. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'nativeIdentifier': string; - /** - * Source ID. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'sourceId': string; - /** - * Source name. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'sourceName': string; - /** - * ID of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'identityId': string; - /** - * Name of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountCreatedBeta - */ - 'identityName': string; - /** - * Account attributes. The attributes\' contents depend on the source\'s account schema. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountCreatedBeta - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountDeletedBeta - */ -export interface SourceAccountDeletedBeta { - /** - * Identity\'s universal unique identifier (UUID) on the source. The source system generates the UUID. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'uuid': string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'id': string; - /** - * Account\'s unique ID on the source. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'nativeIdentifier': string; - /** - * Source ID. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'sourceId': string; - /** - * Source name. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'sourceName': string; - /** - * ID of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'identityId': string; - /** - * Name of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountDeletedBeta - */ - 'identityName': string; - /** - * Account attributes. The attributes\' contents depend on the source\'s account schema. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountDeletedBeta - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountUpdatedBeta - */ -export interface SourceAccountUpdatedBeta { - /** - * Identity\'s universal unique identifier (UUID) on the source. The source system generates the UUID. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'uuid': string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'id': string; - /** - * Account\'s unique ID on the source. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'nativeIdentifier': string; - /** - * Source ID. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'sourceId': string; - /** - * Source name. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'sourceName': string; - /** - * ID of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'identityId': string; - /** - * Name of the identity correlated with the account. - * @type {string} - * @memberof SourceAccountUpdatedBeta - */ - 'identityName': string; - /** - * Account attributes. The attributes\' contents depend on the source\'s account schema. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountUpdatedBeta - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAppAccountSourceBeta - */ -export interface SourceAppAccountSourceBeta { - /** - * The source ID - * @type {string} - * @memberof SourceAppAccountSourceBeta - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppAccountSourceBeta - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppAccountSourceBeta - */ - 'name'?: string; - /** - * If the source is used for password management - * @type {boolean} - * @memberof SourceAppAccountSourceBeta - */ - 'useForPasswordManagement'?: boolean; - /** - * The password policies for the source - * @type {Array} - * @memberof SourceAppAccountSourceBeta - */ - 'passwordPolicies'?: Array | null; -} -/** - * - * @export - * @interface SourceAppBeta - */ -export interface SourceAppBeta { - /** - * The source app id - * @type {string} - * @memberof SourceAppBeta - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppBeta - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppBeta - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppBeta - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppBeta - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppBeta - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppBeta - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppBeta - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppBeta - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppBeta - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {SourceAppAccountSourceBeta} - * @memberof SourceAppBeta - */ - 'accountSource'?: SourceAppAccountSourceBeta | null; - /** - * The owner of source app - * @type {BaseReferenceDtoBeta} - * @memberof SourceAppBeta - */ - 'owner'?: BaseReferenceDtoBeta | null; -} -/** - * - * @export - * @interface SourceAppBulkUpdateRequestBeta - */ -export interface SourceAppBulkUpdateRequestBeta { - /** - * List of source app ids to update - * @type {Array} - * @memberof SourceAppBulkUpdateRequestBeta - */ - 'appIds': Array; - /** - * The JSONPatch payload used to update the source app. - * @type {Array} - * @memberof SourceAppBulkUpdateRequestBeta - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface SourceAppCreateDtoAccountSourceBeta - */ -export interface SourceAppCreateDtoAccountSourceBeta { - /** - * The source ID - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceBeta - */ - 'id': string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceBeta - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface SourceAppCreateDtoBeta - */ -export interface SourceAppCreateDtoBeta { - /** - * The source app name - * @type {string} - * @memberof SourceAppCreateDtoBeta - */ - 'name': string; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppCreateDtoBeta - */ - 'description': string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppCreateDtoBeta - */ - 'matchAllAccounts'?: boolean; - /** - * - * @type {SourceAppCreateDtoAccountSourceBeta} - * @memberof SourceAppCreateDtoBeta - */ - 'accountSource': SourceAppCreateDtoAccountSourceBeta; -} -/** - * - * @export - * @interface SourceAppPatchDtoBeta - */ -export interface SourceAppPatchDtoBeta { - /** - * The source app id - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppPatchDtoBeta - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppPatchDtoBeta - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppPatchDtoBeta - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppPatchDtoBeta - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppPatchDtoBeta - */ - 'appCenterEnabled'?: boolean; - /** - * List of IDs of access profiles - * @type {Array} - * @memberof SourceAppPatchDtoBeta - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {SourceAppAccountSourceBeta} - * @memberof SourceAppPatchDtoBeta - */ - 'accountSource'?: SourceAppAccountSourceBeta | null; - /** - * The owner of source app - * @type {BaseReferenceDtoBeta} - * @memberof SourceAppPatchDtoBeta - */ - 'owner'?: BaseReferenceDtoBeta | null; -} -/** - * - * @export - * @interface SourceBeta - */ -export interface SourceBeta { - /** - * Source ID. - * @type {string} - * @memberof SourceBeta - */ - 'id'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceBeta - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceBeta - */ - 'description'?: string; - /** - * - * @type {SourceOwnerBeta} - * @memberof SourceBeta - */ - 'owner': SourceOwnerBeta | null; - /** - * - * @type {MultiHostIntegrationsClusterBeta} - * @memberof SourceBeta - */ - 'cluster'?: MultiHostIntegrationsClusterBeta | null; - /** - * - * @type {MultiHostSourcesAccountCorrelationConfigBeta} - * @memberof SourceBeta - */ - 'accountCorrelationConfig'?: MultiHostSourcesAccountCorrelationConfigBeta | null; - /** - * - * @type {MultiHostSourcesAccountCorrelationRuleBeta} - * @memberof SourceBeta - */ - 'accountCorrelationRule'?: MultiHostSourcesAccountCorrelationRuleBeta | null; - /** - * - * @type {ManagerCorrelationMappingBeta} - * @memberof SourceBeta - */ - 'managerCorrelationMapping'?: ManagerCorrelationMappingBeta | null; - /** - * - * @type {MultiHostSourcesManagerCorrelationRuleBeta} - * @memberof SourceBeta - */ - 'managerCorrelationRule'?: MultiHostSourcesManagerCorrelationRuleBeta | null; - /** - * - * @type {MultiHostSourcesBeforeProvisioningRuleBeta} - * @memberof SourceBeta - */ - 'beforeProvisioningRule'?: MultiHostSourcesBeforeProvisioningRuleBeta | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof SourceBeta - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof SourceBeta - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SourceBeta - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceBeta - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof SourceBeta - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof SourceBeta - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {object} - * @memberof SourceBeta - */ - 'connectorAttributes'?: object; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof SourceBeta - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof SourceBeta - */ - 'authoritative'?: boolean; - /** - * - * @type {MultiHostIntegrationsManagementWorkgroupBeta} - * @memberof SourceBeta - */ - 'managementWorkgroup'?: MultiHostIntegrationsManagementWorkgroupBeta | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof SourceBeta - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof SourceBeta - */ - 'status'?: SourceBetaStatusBeta; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof SourceBeta - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof SourceBeta - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof SourceBeta - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof SourceBeta - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof SourceBeta - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceBeta - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceBeta - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof SourceBeta - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof SourceBeta - */ - 'category'?: string | null; -} - -export const SourceBetaFeaturesBeta = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SourceBetaFeaturesBeta = typeof SourceBetaFeaturesBeta[keyof typeof SourceBetaFeaturesBeta]; -export const SourceBetaStatusBeta = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceBetaStatusBeta = typeof SourceBetaStatusBeta[keyof typeof SourceBetaStatusBeta]; - -/** - * Source cluster. - * @export - * @interface SourceClusterDtoBeta - */ -export interface SourceClusterDtoBeta { - /** - * Source cluster DTO type. - * @type {string} - * @memberof SourceClusterDtoBeta - */ - 'type'?: SourceClusterDtoBetaTypeBeta; - /** - * Source cluster ID. - * @type {string} - * @memberof SourceClusterDtoBeta - */ - 'id'?: string; - /** - * Source cluster display name. - * @type {string} - * @memberof SourceClusterDtoBeta - */ - 'name'?: string; -} - -export const SourceClusterDtoBetaTypeBeta = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterDtoBetaTypeBeta = typeof SourceClusterDtoBetaTypeBeta[keyof typeof SourceClusterDtoBetaTypeBeta]; - -/** - * SourceCode - * @export - * @interface SourceCodeBeta - */ -export interface SourceCodeBeta { - /** - * the version of the code - * @type {string} - * @memberof SourceCodeBeta - */ - 'version': string; - /** - * The code - * @type {string} - * @memberof SourceCodeBeta - */ - 'script': string; -} -/** - * Identity who created the source. - * @export - * @interface SourceCreatedActorBeta - */ -export interface SourceCreatedActorBeta { - /** - * DTO type of the identity who created the source. - * @type {string} - * @memberof SourceCreatedActorBeta - */ - 'type': SourceCreatedActorBetaTypeBeta; - /** - * ID of the identity who created the source. - * @type {string} - * @memberof SourceCreatedActorBeta - */ - 'id': string; - /** - * Name of the identity who created the source. - * @type {string} - * @memberof SourceCreatedActorBeta - */ - 'name': string; -} - -export const SourceCreatedActorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type SourceCreatedActorBetaTypeBeta = typeof SourceCreatedActorBetaTypeBeta[keyof typeof SourceCreatedActorBetaTypeBeta]; - -/** - * - * @export - * @interface SourceCreatedBeta - */ -export interface SourceCreatedBeta { - /** - * Source\'s unique ID. - * @type {string} - * @memberof SourceCreatedBeta - */ - 'id': string; - /** - * Source name. - * @type {string} - * @memberof SourceCreatedBeta - */ - 'name': string; - /** - * Connection type. - * @type {string} - * @memberof SourceCreatedBeta - */ - 'type': string; - /** - * Date and time when the source was created. - * @type {string} - * @memberof SourceCreatedBeta - */ - 'created': string; - /** - * Connector type used to connect to the source. - * @type {string} - * @memberof SourceCreatedBeta - */ - 'connector': string; - /** - * - * @type {SourceCreatedActorBeta} - * @memberof SourceCreatedBeta - */ - 'actor': SourceCreatedActorBeta; -} -/** - * - * @export - * @interface SourceCreationErrorsBeta - */ -export interface SourceCreationErrorsBeta { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'multihostId'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'source_name'?: string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'source_error'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'modified'?: string; - /** - * operation category (e.g. DELETE). - * @type {string} - * @memberof SourceCreationErrorsBeta - */ - 'operation'?: string | null; -} -/** - * Identity who deleted the source. - * @export - * @interface SourceDeletedActorBeta - */ -export interface SourceDeletedActorBeta { - /** - * DTO type of the identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorBeta - */ - 'type': SourceDeletedActorBetaTypeBeta; - /** - * ID of the identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorBeta - */ - 'id': string; - /** - * Name of the identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorBeta - */ - 'name': string; -} - -export const SourceDeletedActorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type SourceDeletedActorBetaTypeBeta = typeof SourceDeletedActorBetaTypeBeta[keyof typeof SourceDeletedActorBetaTypeBeta]; - -/** - * - * @export - * @interface SourceDeletedBeta - */ -export interface SourceDeletedBeta { - /** - * Source\'s unique ID. - * @type {string} - * @memberof SourceDeletedBeta - */ - 'id': string; - /** - * Source name. - * @type {string} - * @memberof SourceDeletedBeta - */ - 'name': string; - /** - * Connection type. - * @type {string} - * @memberof SourceDeletedBeta - */ - 'type': string; - /** - * Date and time when the source was deleted. - * @type {string} - * @memberof SourceDeletedBeta - */ - 'deleted': string; - /** - * Connector type used to connect to the source. - * @type {string} - * @memberof SourceDeletedBeta - */ - 'connector': string; - /** - * - * @type {SourceDeletedActorBeta} - * @memberof SourceDeletedBeta - */ - 'actor': SourceDeletedActorBeta; -} -/** - * Entitlement Request Configuration - * @export - * @interface SourceEntitlementRequestConfigBeta - */ -export interface SourceEntitlementRequestConfigBeta { - /** - * - * @type {EntitlementAccessRequestConfigBeta} - * @memberof SourceEntitlementRequestConfigBeta - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigBeta; - /** - * - * @type {EntitlementRevocationRequestConfigBeta} - * @memberof SourceEntitlementRequestConfigBeta - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigBeta; -} -/** - * - * @export - * @interface SourceItemRefBeta - */ -export interface SourceItemRefBeta { - /** - * The id for the source on which account selections are made - * @type {string} - * @memberof SourceItemRefBeta - */ - 'sourceId'?: string | null; - /** - * A list of account selections on the source. Currently, only one selection per source is supported. - * @type {Array} - * @memberof SourceItemRefBeta - */ - 'accounts'?: Array | null; -} -/** - * Reference to identity object who owns the source. - * @export - * @interface SourceOwnerBeta - */ -export interface SourceOwnerBeta { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceOwnerBeta - */ - 'type'?: SourceOwnerBetaTypeBeta; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof SourceOwnerBeta - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof SourceOwnerBeta - */ - 'name'?: string; -} - -export const SourceOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type SourceOwnerBetaTypeBeta = typeof SourceOwnerBetaTypeBeta[keyof typeof SourceOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface SourceSyncJobBeta - */ -export interface SourceSyncJobBeta { - /** - * Job ID. - * @type {string} - * @memberof SourceSyncJobBeta - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof SourceSyncJobBeta - */ - 'status': SourceSyncJobBetaStatusBeta; - /** - * - * @type {SourceSyncPayloadBeta} - * @memberof SourceSyncJobBeta - */ - 'payload': SourceSyncPayloadBeta; -} - -export const SourceSyncJobBetaStatusBeta = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SourceSyncJobBetaStatusBeta = typeof SourceSyncJobBetaStatusBeta[keyof typeof SourceSyncJobBetaStatusBeta]; - -/** - * - * @export - * @interface SourceSyncPayloadBeta - */ -export interface SourceSyncPayloadBeta { - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadBeta - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadBeta - */ - 'dataJson': string; -} -/** - * Identity who updated the source. - * @export - * @interface SourceUpdatedActorBeta - */ -export interface SourceUpdatedActorBeta { - /** - * DTO type of the identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorBeta - */ - 'type': SourceUpdatedActorBetaTypeBeta; - /** - * ID of the identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorBeta - */ - 'id': string; - /** - * Name of the identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorBeta - */ - 'name': string; -} - -export const SourceUpdatedActorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type SourceUpdatedActorBetaTypeBeta = typeof SourceUpdatedActorBetaTypeBeta[keyof typeof SourceUpdatedActorBetaTypeBeta]; - -/** - * - * @export - * @interface SourceUpdatedBeta - */ -export interface SourceUpdatedBeta { - /** - * Source\'s unique ID. - * @type {string} - * @memberof SourceUpdatedBeta - */ - 'id': string; - /** - * Source name. - * @type {string} - * @memberof SourceUpdatedBeta - */ - 'name': string; - /** - * Connection type. - * @type {string} - * @memberof SourceUpdatedBeta - */ - 'type': string; - /** - * Date and time when the source was modified. - * @type {string} - * @memberof SourceUpdatedBeta - */ - 'modified': string; - /** - * Connector type used to connect to the source. - * @type {string} - * @memberof SourceUpdatedBeta - */ - 'connector': string; - /** - * - * @type {SourceUpdatedActorBeta} - * @memberof SourceUpdatedBeta - */ - 'actor': SourceUpdatedActorBeta; -} -/** - * - * @export - * @interface SourceUsageBeta - */ -export interface SourceUsageBeta { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof SourceUsageBeta - */ - 'date'?: string; - /** - * The average number of days that accounts were active within this source, for the month. - * @type {number} - * @memberof SourceUsageBeta - */ - 'count'?: number; -} -/** - * - * @export - * @interface SourceUsageStatusBeta - */ -export interface SourceUsageStatusBeta { - /** - * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. - * @type {string} - * @memberof SourceUsageStatusBeta - */ - 'status'?: SourceUsageStatusBetaStatusBeta; -} - -export const SourceUsageStatusBetaStatusBeta = { - Complete: 'COMPLETE', - Incomplete: 'INCOMPLETE' -} as const; - -export type SourceUsageStatusBetaStatusBeta = typeof SourceUsageStatusBetaStatusBeta[keyof typeof SourceUsageStatusBetaStatusBeta]; - -/** - * - * @export - * @interface SpConfigExportJobBeta - */ -export interface SpConfigExportJobBeta { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'status': SpConfigExportJobBetaStatusBeta; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'type': SpConfigExportJobBetaTypeBeta; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobBeta - */ - 'description'?: string; -} - -export const SpConfigExportJobBetaStatusBeta = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobBetaStatusBeta = typeof SpConfigExportJobBetaStatusBeta[keyof typeof SpConfigExportJobBetaStatusBeta]; -export const SpConfigExportJobBetaTypeBeta = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobBetaTypeBeta = typeof SpConfigExportJobBetaTypeBeta[keyof typeof SpConfigExportJobBetaTypeBeta]; - -/** - * - * @export - * @interface SpConfigExportJobStatusBeta - */ -export interface SpConfigExportJobStatusBeta { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'status': SpConfigExportJobStatusBetaStatusBeta; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'type': SpConfigExportJobStatusBetaTypeBeta; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'description'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigExportJobStatusBeta - */ - 'completed'?: string; -} - -export const SpConfigExportJobStatusBetaStatusBeta = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobStatusBetaStatusBeta = typeof SpConfigExportJobStatusBetaStatusBeta[keyof typeof SpConfigExportJobStatusBetaStatusBeta]; -export const SpConfigExportJobStatusBetaTypeBeta = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobStatusBetaTypeBeta = typeof SpConfigExportJobStatusBetaTypeBeta[keyof typeof SpConfigExportJobStatusBetaTypeBeta]; - -/** - * Response model for config export download response. - * @export - * @interface SpConfigExportResultsBeta - */ -export interface SpConfigExportResultsBeta { - /** - * Current version of the export results object. - * @type {number} - * @memberof SpConfigExportResultsBeta - */ - 'version'?: number; - /** - * Time the export was completed. - * @type {string} - * @memberof SpConfigExportResultsBeta - */ - 'timestamp'?: string; - /** - * Name of the tenant where this export originated. - * @type {string} - * @memberof SpConfigExportResultsBeta - */ - 'tenant'?: string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportResultsBeta - */ - 'description'?: string; - /** - * - * @type {ExportOptionsBeta} - * @memberof SpConfigExportResultsBeta - */ - 'options'?: ExportOptionsBeta; - /** - * - * @type {Array} - * @memberof SpConfigExportResultsBeta - */ - 'objects'?: Array; -} -/** - * - * @export - * @interface SpConfigImportJobStatusBeta - */ -export interface SpConfigImportJobStatusBeta { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'status': SpConfigImportJobStatusBetaStatusBeta; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'type': SpConfigImportJobStatusBetaTypeBeta; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'modified': string; - /** - * This message contains additional information about the overall status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'message'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigImportJobStatusBeta - */ - 'completed'?: string; -} - -export const SpConfigImportJobStatusBetaStatusBeta = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigImportJobStatusBetaStatusBeta = typeof SpConfigImportJobStatusBetaStatusBeta[keyof typeof SpConfigImportJobStatusBetaStatusBeta]; -export const SpConfigImportJobStatusBetaTypeBeta = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigImportJobStatusBetaTypeBeta = typeof SpConfigImportJobStatusBetaTypeBeta[keyof typeof SpConfigImportJobStatusBetaTypeBeta]; - -/** - * Response Body for Config Import command. - * @export - * @interface SpConfigImportResultsBeta - */ -export interface SpConfigImportResultsBeta { - /** - * The results of an object configuration import job. - * @type {{ [key: string]: ObjectImportResultBeta; }} - * @memberof SpConfigImportResultsBeta - */ - 'results': { [key: string]: ObjectImportResultBeta; }; - /** - * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. - * @type {string} - * @memberof SpConfigImportResultsBeta - */ - 'exportJobId'?: string; -} -/** - * - * @export - * @interface SpConfigJobBeta - */ -export interface SpConfigJobBeta { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'status': SpConfigJobBetaStatusBeta; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'type': SpConfigJobBetaTypeBeta; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigJobBeta - */ - 'modified': string; -} - -export const SpConfigJobBetaStatusBeta = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigJobBetaStatusBeta = typeof SpConfigJobBetaStatusBeta[keyof typeof SpConfigJobBetaStatusBeta]; -export const SpConfigJobBetaTypeBeta = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigJobBetaTypeBeta = typeof SpConfigJobBetaTypeBeta[keyof typeof SpConfigJobBetaTypeBeta]; - -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessageBeta - */ -export interface SpConfigMessageBeta { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessageBeta - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessageBeta - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: object; }} - * @memberof SpConfigMessageBeta - */ - 'details': { [key: string]: object; }; -} -/** - * Response model for object configuration. - * @export - * @interface SpConfigObjectBeta - */ -export interface SpConfigObjectBeta { - /** - * Object type the configuration is for. - * @type {string} - * @memberof SpConfigObjectBeta - */ - 'objectType'?: string; - /** - * List of JSON paths within an exported object of this type, representing references that must be resolved. - * @type {Array} - * @memberof SpConfigObjectBeta - */ - 'referenceExtractors'?: Array | null; - /** - * Indicates whether this type of object will be JWS signed and cannot be modified before import. - * @type {boolean} - * @memberof SpConfigObjectBeta - */ - 'signatureRequired'?: boolean; - /** - * Indicates whether this object type must be always be resolved by ID. - * @type {boolean} - * @memberof SpConfigObjectBeta - */ - 'alwaysResolveById'?: boolean; - /** - * Indicates whether this is a legacy object. - * @type {boolean} - * @memberof SpConfigObjectBeta - */ - 'legacyObject'?: boolean; - /** - * Indicates whether there is only one object of this type. - * @type {boolean} - * @memberof SpConfigObjectBeta - */ - 'onePerTenant'?: boolean; - /** - * Indicates whether the object can be exported or is just a reference object. - * @type {boolean} - * @memberof SpConfigObjectBeta - */ - 'exportable'?: boolean; - /** - * - * @type {SpConfigRulesBeta} - * @memberof SpConfigObjectBeta - */ - 'rules'?: SpConfigRulesBeta; -} -/** - * Format of Config Hub object rules. - * @export - * @interface SpConfigRuleBeta - */ -export interface SpConfigRuleBeta { - /** - * JSONPath expression denoting the path within the object where a value substitution should be applied. - * @type {string} - * @memberof SpConfigRuleBeta - */ - 'path'?: string; - /** - * - * @type {SpConfigRuleValueBeta} - * @memberof SpConfigRuleBeta - */ - 'value'?: SpConfigRuleValueBeta | null; - /** - * Draft modes the rule will apply to. - * @type {Array} - * @memberof SpConfigRuleBeta - */ - 'modes'?: Array; -} - -export const SpConfigRuleBetaModesBeta = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type SpConfigRuleBetaModesBeta = typeof SpConfigRuleBetaModesBeta[keyof typeof SpConfigRuleBetaModesBeta]; - -/** - * Value to be assigned at the jsonPath location within the object. - * @export - * @interface SpConfigRuleValueBeta - */ -export interface SpConfigRuleValueBeta { -} -/** - * Rules to be applied to the config object during the draft process. - * @export - * @interface SpConfigRulesBeta - */ -export interface SpConfigRulesBeta { - /** - * - * @type {Array} - * @memberof SpConfigRulesBeta - */ - 'takeFromTargetRules'?: Array; - /** - * - * @type {Array} - * @memberof SpConfigRulesBeta - */ - 'defaultRules'?: Array; - /** - * Indicates whether the object can be edited. - * @type {boolean} - * @memberof SpConfigRulesBeta - */ - 'editable'?: boolean; -} -/** - * - * @export - * @interface SplitBeta - */ -export interface SplitBeta { - /** - * This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - * @type {string} - * @memberof SplitBeta - */ - 'delimiter': string; - /** - * An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - * @type {string} - * @memberof SplitBeta - */ - 'index': string; - /** - * A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return \"IndexOutOfBoundsException\" `false` - The transform should return null If not provided, the transform will default to false and return a null - * @type {boolean} - * @memberof SplitBeta - */ - 'throws'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SplitBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SplitBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * Standard Log4j log level - * @export - * @enum {string} - */ - -export const StandardLevelBeta = { - False: 'false', - Fatal: 'FATAL', - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO', - Debug: 'DEBUG', - Trace: 'TRACE' -} as const; - -export type StandardLevelBeta = typeof StandardLevelBeta[keyof typeof StandardLevelBeta]; - - -/** - * - * @export - * @interface StartInvocationInputBeta - */ -export interface StartInvocationInputBeta { - /** - * Trigger ID - * @type {string} - * @memberof StartInvocationInputBeta - */ - 'triggerId'?: string; - /** - * Trigger input payload. Its schema is defined in the trigger definition. - * @type {object} - * @memberof StartInvocationInputBeta - */ - 'input'?: object; - /** - * JSON map of invocation metadata - * @type {object} - * @memberof StartInvocationInputBeta - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface StartLauncher200ResponseBeta - */ -export interface StartLauncher200ResponseBeta { - /** - * ID of the Interactive Process that was launched - * @type {string} - * @memberof StartLauncher200ResponseBeta - */ - 'interactiveProcessId': string; -} -/** - * - * @export - * @interface StaticBeta - */ -export interface StaticBeta { - /** - * This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - * @type {string} - * @memberof StaticBeta - */ - 'values': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof StaticBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Response model for connection check, configuration test and ping of source connectors. - * @export - * @interface StatusResponseBeta - */ -export interface StatusResponseBeta { - /** - * ID of the source - * @type {string} - * @memberof StatusResponseBeta - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof StatusResponseBeta - */ - 'name'?: string; - /** - * The status of the health check. - * @type {string} - * @memberof StatusResponseBeta - */ - 'status'?: StatusResponseBetaStatusBeta; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof StatusResponseBeta - */ - 'elapsedMillis'?: number; - /** - * The document contains the results of the health check. The schema of this document depends on the type of source used. - * @type {object} - * @memberof StatusResponseBeta - */ - 'details'?: object; -} - -export const StatusResponseBetaStatusBeta = { - Success: 'SUCCESS', - Failure: 'FAILURE' -} as const; - -export type StatusResponseBetaStatusBeta = typeof StatusResponseBetaStatusBeta[keyof typeof StatusResponseBetaStatusBeta]; - -/** - * - * @export - * @interface SubscriptionBeta - */ -export interface SubscriptionBeta { - /** - * Subscription ID. - * @type {string} - * @memberof SubscriptionBeta - */ - 'id': string; - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionBeta - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionBeta - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionBeta - */ - 'triggerId': string; - /** - * Trigger name of trigger subscribed to. - * @type {string} - * @memberof SubscriptionBeta - */ - 'triggerName': string; - /** - * - * @type {SubscriptionTypeBeta} - * @memberof SubscriptionBeta - */ - 'type': SubscriptionTypeBeta; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionBeta - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigBeta} - * @memberof SubscriptionBeta - */ - 'httpConfig'?: HttpConfigBeta; - /** - * - * @type {EventBridgeConfigBeta} - * @memberof SubscriptionBeta - */ - 'eventBridgeConfig'?: EventBridgeConfigBeta; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionBeta - */ - 'enabled': boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionBeta - */ - 'filter'?: string; -} - - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface SubscriptionPatchRequestInnerBeta - */ -export interface SubscriptionPatchRequestInnerBeta { - /** - * The operation to be performed - * @type {string} - * @memberof SubscriptionPatchRequestInnerBeta - */ - 'op': SubscriptionPatchRequestInnerBetaOpBeta; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof SubscriptionPatchRequestInnerBeta - */ - 'path': string; - /** - * - * @type {SubscriptionPatchRequestInnerValueBeta} - * @memberof SubscriptionPatchRequestInnerBeta - */ - 'value'?: SubscriptionPatchRequestInnerValueBeta; -} - -export const SubscriptionPatchRequestInnerBetaOpBeta = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy' -} as const; - -export type SubscriptionPatchRequestInnerBetaOpBeta = typeof SubscriptionPatchRequestInnerBetaOpBeta[keyof typeof SubscriptionPatchRequestInnerBetaOpBeta]; - -/** - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - * @interface SubscriptionPatchRequestInnerValueBeta - */ -export interface SubscriptionPatchRequestInnerValueBeta { -} -/** - * - * @export - * @interface SubscriptionPostRequestBeta - */ -export interface SubscriptionPostRequestBeta { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPostRequestBeta - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPostRequestBeta - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionPostRequestBeta - */ - 'triggerId': string; - /** - * - * @type {SubscriptionTypeBeta} - * @memberof SubscriptionPostRequestBeta - */ - 'type': SubscriptionTypeBeta; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPostRequestBeta - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigBeta} - * @memberof SubscriptionPostRequestBeta - */ - 'httpConfig'?: HttpConfigBeta; - /** - * - * @type {EventBridgeConfigBeta} - * @memberof SubscriptionPostRequestBeta - */ - 'eventBridgeConfig'?: EventBridgeConfigBeta; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPostRequestBeta - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPostRequestBeta - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubscriptionPutRequestBeta - */ -export interface SubscriptionPutRequestBeta { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPutRequestBeta - */ - 'name'?: string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPutRequestBeta - */ - 'description'?: string; - /** - * - * @type {SubscriptionTypeBeta} - * @memberof SubscriptionPutRequestBeta - */ - 'type'?: SubscriptionTypeBeta; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPutRequestBeta - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigBeta} - * @memberof SubscriptionPutRequestBeta - */ - 'httpConfig'?: HttpConfigBeta; - /** - * - * @type {EventBridgeConfigBeta} - * @memberof SubscriptionPutRequestBeta - */ - 'eventBridgeConfig'?: EventBridgeConfigBeta; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPutRequestBeta - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPutRequestBeta - */ - 'filter'?: string; -} - - -/** - * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. - * @export - * @enum {string} - */ - -export const SubscriptionTypeBeta = { - Http: 'HTTP', - Eventbridge: 'EVENTBRIDGE', - Inline: 'INLINE', - Script: 'SCRIPT', - Workflow: 'WORKFLOW' -} as const; - -export type SubscriptionTypeBeta = typeof SubscriptionTypeBeta[keyof typeof SubscriptionTypeBeta]; - - -/** - * - * @export - * @interface SubstringBeta - */ -export interface SubstringBeta { - /** - * The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data - * @type {number} - * @memberof SubstringBeta - */ - 'begin': number; - /** - * This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. - * @type {number} - * @memberof SubstringBeta - */ - 'beginOffset'?: number; - /** - * The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - * @type {number} - * @memberof SubstringBeta - */ - 'end'?: number; - /** - * This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. - * @type {number} - * @memberof SubstringBeta - */ - 'endOffset'?: number; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SubstringBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SubstringBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TagBeta - */ -export interface TagBeta { - /** - * Tag id - * @type {string} - * @memberof TagBeta - */ - 'id': string; - /** - * Name of the tag. - * @type {string} - * @memberof TagBeta - */ - 'name': string; - /** - * Date the tag was created. - * @type {string} - * @memberof TagBeta - */ - 'created': string; - /** - * Date the tag was last modified. - * @type {string} - * @memberof TagBeta - */ - 'modified': string; - /** - * - * @type {Array} - * @memberof TagBeta - */ - 'tagCategoryRefs': Array; -} -/** - * Tagged object\'s category. - * @export - * @interface TagTagCategoryRefsInnerBeta - */ -export interface TagTagCategoryRefsInnerBeta { - /** - * DTO type of the tagged object\'s category. - * @type {string} - * @memberof TagTagCategoryRefsInnerBeta - */ - 'type'?: TagTagCategoryRefsInnerBetaTypeBeta; - /** - * Tagged object\'s ID. - * @type {string} - * @memberof TagTagCategoryRefsInnerBeta - */ - 'id'?: string; - /** - * Tagged object\'s display name. - * @type {string} - * @memberof TagTagCategoryRefsInnerBeta - */ - 'name'?: string; -} - -export const TagTagCategoryRefsInnerBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TagTagCategoryRefsInnerBetaTypeBeta = typeof TagTagCategoryRefsInnerBetaTypeBeta[keyof typeof TagTagCategoryRefsInnerBetaTypeBeta]; - -/** - * - * @export - * @interface TaggedObjectBeta - */ -export interface TaggedObjectBeta { - /** - * - * @type {TaggedObjectObjectRefBeta} - * @memberof TaggedObjectBeta - */ - 'objectRef'?: TaggedObjectObjectRefBeta; - /** - * Labels to be applied to an Object - * @type {Array} - * @memberof TaggedObjectBeta - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface TaggedObjectDtoBeta - */ -export interface TaggedObjectDtoBeta { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectDtoBeta - */ - 'type'?: TaggedObjectDtoBetaTypeBeta; - /** - * ID of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoBeta - */ - 'name'?: string | null; -} - -export const TaggedObjectDtoBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectDtoBetaTypeBeta = typeof TaggedObjectDtoBetaTypeBeta[keyof typeof TaggedObjectDtoBetaTypeBeta]; - -/** - * - * @export - * @interface TaggedObjectObjectRefBeta - */ -export interface TaggedObjectObjectRefBeta { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectObjectRefBeta - */ - 'type'?: TaggedObjectObjectRefBetaTypeBeta; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof TaggedObjectObjectRefBeta - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof TaggedObjectObjectRefBeta - */ - 'name'?: string | null; -} - -export const TaggedObjectObjectRefBetaTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectObjectRefBetaTypeBeta = typeof TaggedObjectObjectRefBetaTypeBeta[keyof typeof TaggedObjectObjectRefBetaTypeBeta]; - -/** - * - * @export - * @interface TargetBeta - */ -export interface TargetBeta { - /** - * Target ID - * @type {string} - * @memberof TargetBeta - */ - 'id'?: string; - /** - * Target type - * @type {string} - * @memberof TargetBeta - */ - 'type'?: TargetBetaTypeBeta | null; - /** - * Target name - * @type {string} - * @memberof TargetBeta - */ - 'name'?: string; -} - -export const TargetBetaTypeBeta = { - Application: 'APPLICATION', - Identity: 'IDENTITY' -} as const; - -export type TargetBetaTypeBeta = typeof TargetBetaTypeBeta[keyof typeof TargetBetaTypeBeta]; - -/** - * Definition of a type of task, used to invoke tasks - * @export - * @interface TaskDefinitionSummaryBeta - */ -export interface TaskDefinitionSummaryBeta { - /** - * System-generated unique ID of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryBeta - */ - 'id': string; - /** - * Name of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryBeta - */ - 'uniqueName': string; - /** - * Description of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryBeta - */ - 'description': string | null; - /** - * Name of the parent of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryBeta - */ - 'parentName': string; - /** - * Executor of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryBeta - */ - 'executor': string | null; - /** - * Formal parameters of the TaskDefinition, without values - * @type {{ [key: string]: any; }} - * @memberof TaskDefinitionSummaryBeta - */ - 'arguments': { [key: string]: any; }; -} -/** - * Task result. - * @export - * @interface TaskResultDtoBeta - */ -export interface TaskResultDtoBeta { - /** - * Task result DTO type. - * @type {string} - * @memberof TaskResultDtoBeta - */ - 'type'?: TaskResultDtoBetaTypeBeta; - /** - * Task result ID. - * @type {string} - * @memberof TaskResultDtoBeta - */ - 'id'?: string; - /** - * Task result display name. - * @type {string} - * @memberof TaskResultDtoBeta - */ - 'name'?: string | null; -} - -export const TaskResultDtoBetaTypeBeta = { - TaskResult: 'TASK_RESULT' -} as const; - -export type TaskResultDtoBetaTypeBeta = typeof TaskResultDtoBetaTypeBeta[keyof typeof TaskResultDtoBetaTypeBeta]; - -/** - * - * @export - * @interface TaskResultResponseBeta - */ -export interface TaskResultResponseBeta { - /** - * the type of response reference - * @type {string} - * @memberof TaskResultResponseBeta - */ - 'type'?: string; - /** - * the task ID - * @type {string} - * @memberof TaskResultResponseBeta - */ - 'id'?: string; - /** - * the task name (not used in this endpoint, always null) - * @type {string} - * @memberof TaskResultResponseBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface TaskResultSimplifiedBeta - */ -export interface TaskResultSimplifiedBeta { - /** - * Task identifier - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'id'?: string; - /** - * Task name - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'name'?: string; - /** - * Task description - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'description'?: string; - /** - * User or process who launched the task - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'launcher'?: string; - /** - * Date time of completion - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'completed'?: string; - /** - * Date time when the task was launched - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'launched'?: string; - /** - * Task result status - * @type {string} - * @memberof TaskResultSimplifiedBeta - */ - 'completionStatus'?: TaskResultSimplifiedBetaCompletionStatusBeta; -} - -export const TaskResultSimplifiedBetaCompletionStatusBeta = { - Success: 'Success', - Warning: 'Warning', - Error: 'Error', - Terminated: 'Terminated', - TempError: 'TempError' -} as const; - -export type TaskResultSimplifiedBetaCompletionStatusBeta = typeof TaskResultSimplifiedBetaCompletionStatusBeta[keyof typeof TaskResultSimplifiedBetaCompletionStatusBeta]; - -/** - * Task return details - * @export - * @interface TaskReturnDetailsBeta - */ -export interface TaskReturnDetailsBeta { - /** - * Display name of the TaskReturnDetails - * @type {string} - * @memberof TaskReturnDetailsBeta - */ - 'name': string; - /** - * Attribute the TaskReturnDetails is for - * @type {string} - * @memberof TaskReturnDetailsBeta - */ - 'attributeName': string; -} -/** - * Details and current status of a specific task - * @export - * @interface TaskStatusBeta - */ -export interface TaskStatusBeta { - /** - * System-generated unique ID of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'id': string; - /** - * Type of task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'type': TaskStatusBetaTypeBeta; - /** - * Name of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'uniqueName': string; - /** - * Description of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'description': string; - /** - * Name of the parent of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'parentName': string | null; - /** - * Service to execute the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'launcher': string; - /** - * - * @type {TargetBeta} - * @memberof TaskStatusBeta - */ - 'target'?: TargetBeta | null; - /** - * Creation date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'created': string; - /** - * Last modification date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'modified': string | null; - /** - * Launch date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'launched': string | null; - /** - * Completion date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'completed': string | null; - /** - * Completion status of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'completionStatus': TaskStatusBetaCompletionStatusBeta | null; - /** - * Messages associated with the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusBeta - */ - 'messages': Array; - /** - * Return values from the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusBeta - */ - 'returns': Array; - /** - * Attributes of the task this TaskStatus represents - * @type {{ [key: string]: any; }} - * @memberof TaskStatusBeta - */ - 'attributes': { [key: string]: any; }; - /** - * Current progress of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusBeta - */ - 'progress': string | null; - /** - * Current percentage completion of the task this TaskStatus represents - * @type {number} - * @memberof TaskStatusBeta - */ - 'percentComplete': number; - /** - * - * @type {TaskDefinitionSummaryBeta} - * @memberof TaskStatusBeta - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryBeta; -} - -export const TaskStatusBetaTypeBeta = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskStatusBetaTypeBeta = typeof TaskStatusBetaTypeBeta[keyof typeof TaskStatusBetaTypeBeta]; -export const TaskStatusBetaCompletionStatusBeta = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type TaskStatusBetaCompletionStatusBeta = typeof TaskStatusBetaCompletionStatusBeta[keyof typeof TaskStatusBetaCompletionStatusBeta]; - -/** - * TaskStatus Message - * @export - * @interface TaskStatusMessageBeta - */ -export interface TaskStatusMessageBeta { - /** - * Type of the message - * @type {string} - * @memberof TaskStatusMessageBeta - */ - 'type': TaskStatusMessageBetaTypeBeta; - /** - * - * @type {LocalizedMessageBeta} - * @memberof TaskStatusMessageBeta - */ - 'localizedText': LocalizedMessageBeta | null; - /** - * Key of the message - * @type {string} - * @memberof TaskStatusMessageBeta - */ - 'key': string; - /** - * Message parameters for internationalization - * @type {Array} - * @memberof TaskStatusMessageBeta - */ - 'parameters': Array | null; -} - -export const TaskStatusMessageBetaTypeBeta = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskStatusMessageBetaTypeBeta = typeof TaskStatusMessageBetaTypeBeta[keyof typeof TaskStatusMessageBetaTypeBeta]; - -/** - * - * @export - * @interface TaskStatusMessageParametersInnerBeta - */ -export interface TaskStatusMessageParametersInnerBeta { -} -/** - * - * @export - * @interface TemplateBulkDeleteDtoBeta - */ -export interface TemplateBulkDeleteDtoBeta { - /** - * The template key to delete - * @type {string} - * @memberof TemplateBulkDeleteDtoBeta - */ - 'key': string; - /** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @type {string} - * @memberof TemplateBulkDeleteDtoBeta - */ - 'medium'?: TemplateBulkDeleteDtoBetaMediumBeta; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateBulkDeleteDtoBeta - */ - 'locale'?: string; -} - -export const TemplateBulkDeleteDtoBetaMediumBeta = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateBulkDeleteDtoBetaMediumBeta = typeof TemplateBulkDeleteDtoBetaMediumBeta[keyof typeof TemplateBulkDeleteDtoBetaMediumBeta]; - -/** - * - * @export - * @interface TemplateDtoBeta - */ -export interface TemplateDtoBeta { - /** - * The key of the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'key': string; - /** - * The name of the Task Manager Subscription - * @type {string} - * @memberof TemplateDtoBeta - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoBeta - */ - 'medium': TemplateDtoBetaMediumBeta; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoBeta - */ - 'locale': string; - /** - * The subject line in the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'subject'?: string; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoBeta - * @deprecated - */ - 'header'?: string | null; - /** - * The body in the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoBeta - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address in the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'from'?: string; - /** - * The \"Reply To\" line in the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'replyTo'?: string; - /** - * The description in the template - * @type {string} - * @memberof TemplateDtoBeta - */ - 'description'?: string; - /** - * This is auto-generated. - * @type {string} - * @memberof TemplateDtoBeta - */ - 'id'?: string; - /** - * The time when this template is created. This is auto-generated. - * @type {string} - * @memberof TemplateDtoBeta - */ - 'created'?: string; - /** - * The time when this template was last modified. This is auto-generated. - * @type {string} - * @memberof TemplateDtoBeta - */ - 'modified'?: string; - /** - * - * @type {TemplateDtoSlackTemplateBeta} - * @memberof TemplateDtoBeta - */ - 'slackTemplate'?: TemplateDtoSlackTemplateBeta; - /** - * - * @type {TemplateDtoTeamsTemplateBeta} - * @memberof TemplateDtoBeta - */ - 'teamsTemplate'?: TemplateDtoTeamsTemplateBeta; -} - -export const TemplateDtoBetaMediumBeta = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoBetaMediumBeta = typeof TemplateDtoBetaMediumBeta[keyof typeof TemplateDtoBetaMediumBeta]; - -/** - * - * @export - * @interface TemplateDtoDefaultBeta - */ -export interface TemplateDtoDefaultBeta { - /** - * The key of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'key'?: string; - /** - * The name of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'medium'?: TemplateDtoDefaultBetaMediumBeta; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'locale'?: string; - /** - * The subject of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'subject'?: string | null; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultBeta - * @deprecated - */ - 'header'?: string | null; - /** - * The body of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultBeta - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'from'?: string | null; - /** - * The \"Reply To\" field of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'replyTo'?: string | null; - /** - * The description of the default template - * @type {string} - * @memberof TemplateDtoDefaultBeta - */ - 'description'?: string | null; - /** - * - * @type {TemplateSlackBeta} - * @memberof TemplateDtoDefaultBeta - */ - 'slackTemplate'?: TemplateSlackBeta | null; - /** - * - * @type {TemplateTeamsBeta} - * @memberof TemplateDtoDefaultBeta - */ - 'teamsTemplate'?: TemplateTeamsBeta | null; -} - -export const TemplateDtoDefaultBetaMediumBeta = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoDefaultBetaMediumBeta = typeof TemplateDtoDefaultBetaMediumBeta[keyof typeof TemplateDtoDefaultBetaMediumBeta]; - -/** - * - * @export - * @interface TemplateDtoSlackTemplateBeta - */ -export interface TemplateDtoSlackTemplateBeta { - /** - * The template key - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataBeta} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null; - /** - * - * @type {TemplateSlackCustomFieldsBeta} - * @memberof TemplateDtoSlackTemplateBeta - */ - 'customFields'?: TemplateSlackCustomFieldsBeta | null; -} -/** - * - * @export - * @interface TemplateDtoTeamsTemplateBeta - */ -export interface TemplateDtoTeamsTemplateBeta { - /** - * The template key - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataBeta} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null; - /** - * - * @type {TemplateSlackCustomFieldsBeta} - * @memberof TemplateDtoTeamsTemplateBeta - */ - 'customFields'?: TemplateSlackCustomFieldsBeta | null; -} -/** - * - * @export - * @interface TemplateSlackAutoApprovalDataBeta - */ -export interface TemplateSlackAutoApprovalDataBeta { - /** - * Whether the request was auto-approved - * @type {string} - * @memberof TemplateSlackAutoApprovalDataBeta - */ - 'isAutoApproved'?: string | null; - /** - * The item ID - * @type {string} - * @memberof TemplateSlackAutoApprovalDataBeta - */ - 'itemId'?: string | null; - /** - * The item type - * @type {string} - * @memberof TemplateSlackAutoApprovalDataBeta - */ - 'itemType'?: string | null; - /** - * JSON message for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataBeta - */ - 'autoApprovalMessageJSON'?: string | null; - /** - * Title for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataBeta - */ - 'autoApprovalTitle'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackBeta - */ -export interface TemplateSlackBeta { - /** - * The template key - * @type {string} - * @memberof TemplateSlackBeta - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateSlackBeta - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateSlackBeta - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateSlackBeta - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateSlackBeta - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateSlackBeta - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateSlackBeta - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateSlackBeta - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateSlackBeta - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataBeta} - * @memberof TemplateSlackBeta - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null; - /** - * - * @type {TemplateSlackCustomFieldsBeta} - * @memberof TemplateSlackBeta - */ - 'customFields'?: TemplateSlackCustomFieldsBeta | null; -} -/** - * - * @export - * @interface TemplateSlackCustomFieldsBeta - */ -export interface TemplateSlackCustomFieldsBeta { - /** - * The type of request - * @type {string} - * @memberof TemplateSlackCustomFieldsBeta - */ - 'requestType'?: string | null; - /** - * Whether the request contains a deny action - * @type {string} - * @memberof TemplateSlackCustomFieldsBeta - */ - 'containsDeny'?: string | null; - /** - * The campaign ID - * @type {string} - * @memberof TemplateSlackCustomFieldsBeta - */ - 'campaignId'?: string | null; - /** - * The campaign status - * @type {string} - * @memberof TemplateSlackCustomFieldsBeta - */ - 'campaignStatus'?: string | null; -} -/** - * - * @export - * @interface TemplateTeamsBeta - */ -export interface TemplateTeamsBeta { - /** - * The template key - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateTeamsBeta - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateTeamsBeta - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataBeta} - * @memberof TemplateTeamsBeta - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null; - /** - * - * @type {TemplateSlackCustomFieldsBeta} - * @memberof TemplateTeamsBeta - */ - 'customFields'?: TemplateSlackCustomFieldsBeta | null; -} -/** - * - * @export - * @interface TenantBeta - */ -export interface TenantBeta { - /** - * The unique identifier for the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'id'?: string; - /** - * Abbreviated name of the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'name'?: string; - /** - * Human-readable name of the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'fullName'?: string; - /** - * Deployment pod for the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'pod'?: string; - /** - * Deployment region for the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'region'?: string; - /** - * Description of the Tenant - * @type {string} - * @memberof TenantBeta - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof TenantBeta - */ - 'products'?: Array; -} -/** - * Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) - * @export - * @interface TenantConfigurationDetailsBeta - */ -export interface TenantConfigurationDetailsBeta { - /** - * Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. - * @type {boolean} - * @memberof TenantConfigurationDetailsBeta - */ - 'disabled'?: boolean | null; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationRequestBeta - */ -export interface TenantConfigurationRequestBeta { - /** - * - * @type {TenantConfigurationDetailsBeta} - * @memberof TenantConfigurationRequestBeta - */ - 'configDetails'?: TenantConfigurationDetailsBeta; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationResponseBeta - */ -export interface TenantConfigurationResponseBeta { - /** - * - * @type {AuditDetailsBeta} - * @memberof TenantConfigurationResponseBeta - */ - 'auditDetails'?: AuditDetailsBeta; - /** - * - * @type {TenantConfigurationDetailsBeta} - * @memberof TenantConfigurationResponseBeta - */ - 'configDetails'?: TenantConfigurationDetailsBeta; -} -/** - * - * @export - * @interface TenantUiMetadataItemResponseBeta - */ -export interface TenantUiMetadataItemResponseBeta { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemResponseBeta - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseBeta - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseBeta - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantUiMetadataItemUpdateRequestBeta - */ -export interface TenantUiMetadataItemUpdateRequestBeta { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestBeta - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestBeta - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestBeta - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflow200ResponseBeta - */ -export interface TestExternalExecuteWorkflow200ResponseBeta { - /** - * The input that was received - * @type {object} - * @memberof TestExternalExecuteWorkflow200ResponseBeta - */ - 'payload'?: object; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflowRequestBeta - */ -export interface TestExternalExecuteWorkflowRequestBeta { - /** - * The test input for the workflow - * @type {object} - * @memberof TestExternalExecuteWorkflowRequestBeta - */ - 'input'?: object; -} -/** - * - * @export - * @interface TestInvocationBeta - */ -export interface TestInvocationBeta { - /** - * Trigger ID - * @type {string} - * @memberof TestInvocationBeta - */ - 'triggerId': string; - /** - * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. - * @type {object} - * @memberof TestInvocationBeta - */ - 'input'?: object; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof TestInvocationBeta - */ - 'contentJson': object; - /** - * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. - * @type {Array} - * @memberof TestInvocationBeta - */ - 'subscriptionIds'?: Array; -} -/** - * - * @export - * @interface TestSourceConnectionMultihost200ResponseBeta - */ -export interface TestSourceConnectionMultihost200ResponseBeta { - /** - * Source\'s test connection status. - * @type {boolean} - * @memberof TestSourceConnectionMultihost200ResponseBeta - */ - 'success'?: boolean; - /** - * Source\'s test connection message. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseBeta - */ - 'message'?: string; - /** - * Source\'s test connection timing. - * @type {number} - * @memberof TestSourceConnectionMultihost200ResponseBeta - */ - 'timing'?: number; - /** - * Source\'s human-readable result type. - * @type {object} - * @memberof TestSourceConnectionMultihost200ResponseBeta - */ - 'resultType'?: TestSourceConnectionMultihost200ResponseBetaResultTypeBeta; - /** - * Source\'s human-readable test connection details. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseBeta - */ - 'testConnectionDetails'?: string; -} - -export const TestSourceConnectionMultihost200ResponseBetaResultTypeBeta = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type TestSourceConnectionMultihost200ResponseBetaResultTypeBeta = typeof TestSourceConnectionMultihost200ResponseBetaResultTypeBeta[keyof typeof TestSourceConnectionMultihost200ResponseBetaResultTypeBeta]; - -/** - * - * @export - * @interface TestWorkflow200ResponseBeta - */ -export interface TestWorkflow200ResponseBeta { - /** - * The workflow execution id - * @type {string} - * @memberof TestWorkflow200ResponseBeta - */ - 'workflowExecutionId'?: string; -} -/** - * - * @export - * @interface TestWorkflowRequestBeta - */ -export interface TestWorkflowRequestBeta { - /** - * The test input for the workflow. - * @type {object} - * @memberof TestWorkflowRequestBeta - */ - 'input': object; -} -/** - * - * @export - * @interface TokenAuthRequestBeta - */ -export interface TokenAuthRequestBeta { - /** - * Token value - * @type {string} - * @memberof TokenAuthRequestBeta - */ - 'token': string; - /** - * User alias from table spt_identity field named \'name\' - * @type {string} - * @memberof TokenAuthRequestBeta - */ - 'userAlias': string; - /** - * Token delivery type - * @type {string} - * @memberof TokenAuthRequestBeta - */ - 'deliveryType': TokenAuthRequestBetaDeliveryTypeBeta; -} - -export const TokenAuthRequestBetaDeliveryTypeBeta = { - SmsPersonal: 'SMS_PERSONAL', - VoicePersonal: 'VOICE_PERSONAL', - SmsWork: 'SMS_WORK', - VoiceWork: 'VOICE_WORK', - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL' -} as const; - -export type TokenAuthRequestBetaDeliveryTypeBeta = typeof TokenAuthRequestBetaDeliveryTypeBeta[keyof typeof TokenAuthRequestBetaDeliveryTypeBeta]; - -/** - * - * @export - * @interface TokenAuthResponseBeta - */ -export interface TokenAuthResponseBeta { - /** - * MFA Authentication status - * @type {string} - * @memberof TokenAuthResponseBeta - */ - 'status'?: TokenAuthResponseBetaStatusBeta; -} - -export const TokenAuthResponseBetaStatusBeta = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type TokenAuthResponseBetaStatusBeta = typeof TokenAuthResponseBetaStatusBeta[keyof typeof TokenAuthResponseBetaStatusBeta]; - -/** - * @type TransformAttributesBeta - * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - * @export - */ -export type TransformAttributesBeta = AccountAttributeBeta | Base64DecodeBeta | Base64EncodeBeta | ConcatenationBeta | ConditionalBeta | DateCompareBeta | DateFormatBeta | DateMathBeta | DecomposeDiacriticalMarksBeta | E164phoneBeta | FirstValidBeta | ISO3166Beta | IdentityAttribute1Beta | IndexOfBeta | LeftPadBeta | LookupBeta | LowerBeta | NameNormalizerBeta | RandomAlphaNumericBeta | RandomNumericBeta | ReferenceBeta | ReplaceAllBeta | ReplaceBeta | RightPadBeta | RuleBeta | SplitBeta | StaticBeta | SubstringBeta | TrimBeta | UUIDGeneratorBeta | UpperBeta; - -/** - * The representation of an internally- or customer-defined transform. - * @export - * @interface TransformBeta - */ -export interface TransformBeta { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformBeta - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformBeta - */ - 'type': TransformBetaTypeBeta; - /** - * - * @type {TransformAttributesBeta} - * @memberof TransformBeta - */ - 'attributes': TransformAttributesBeta | null; -} - -export const TransformBetaTypeBeta = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformBetaTypeBeta = typeof TransformBetaTypeBeta[keyof typeof TransformBetaTypeBeta]; - -/** - * - * @export - * @interface TransformDefinition1Beta - */ -export interface TransformDefinition1Beta { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinition1Beta - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinition1Beta - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TransformDefinitionBeta - */ -export interface TransformDefinitionBeta { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinitionBeta - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinitionBeta - */ - 'attributes'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface TransformReadBeta - */ -export interface TransformReadBeta { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformReadBeta - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformReadBeta - */ - 'type': TransformReadBetaTypeBeta; - /** - * - * @type {TransformAttributesBeta} - * @memberof TransformReadBeta - */ - 'attributes': TransformAttributesBeta | null; - /** - * Unique ID of this transform - * @type {string} - * @memberof TransformReadBeta - */ - 'id': string; - /** - * Indicates whether this is an internal SailPoint-created transform or a customer-created transform - * @type {boolean} - * @memberof TransformReadBeta - */ - 'internal': boolean; -} - -export const TransformReadBetaTypeBeta = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformReadBetaTypeBeta = typeof TransformReadBetaTypeBeta[keyof typeof TransformReadBetaTypeBeta]; - -/** - * - * @export - * @interface TransformRuleBeta - */ -export interface TransformRuleBeta { - /** - * This is the name of the Transform rule that needs to be invoked by the transform - * @type {string} - * @memberof TransformRuleBeta - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TransformRuleBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface TranslationMessageBeta - */ -export interface TranslationMessageBeta { - /** - * The key of the translation message - * @type {string} - * @memberof TranslationMessageBeta - */ - 'key'?: string; - /** - * The values corresponding to the translation messages - * @type {Array} - * @memberof TranslationMessageBeta - */ - 'values'?: Array; -} -/** - * - * @export - * @interface TriggerBeta - */ -export interface TriggerBeta { - /** - * Unique identifier of the trigger. - * @type {string} - * @memberof TriggerBeta - */ - 'id': string; - /** - * Trigger Name. - * @type {string} - * @memberof TriggerBeta - */ - 'name': string; - /** - * - * @type {TriggerTypeBeta} - * @memberof TriggerBeta - */ - 'type': TriggerTypeBeta; - /** - * Trigger Description. - * @type {string} - * @memberof TriggerBeta - */ - 'description'?: string; - /** - * The JSON schema of the payload that will be sent by the trigger to the subscribed service. - * @type {string} - * @memberof TriggerBeta - */ - 'inputSchema': string; - /** - * - * @type {TriggerExampleInputBeta} - * @memberof TriggerBeta - */ - 'exampleInput': TriggerExampleInputBeta; - /** - * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. - * @type {string} - * @memberof TriggerBeta - */ - 'outputSchema'?: string | null; - /** - * - * @type {TriggerExampleOutputBeta} - * @memberof TriggerBeta - */ - 'exampleOutput'?: TriggerExampleOutputBeta | null; -} - - -/** - * @type TriggerExampleInputBeta - * An example of the JSON payload that will be sent by the trigger to the subscribed service. - * @export - */ -export type TriggerExampleInputBeta = AccessRequestDynamicApproverBeta | AccessRequestPostApprovalBeta | AccessRequestPreApprovalBeta | AccountAggregationCompletedBeta | AccountAttributesChangedBeta | AccountCorrelatedBeta | AccountUncorrelatedBeta | AccountsCollectedForAggregationBeta | CampaignActivatedBeta | CampaignEndedBeta | CampaignGeneratedBeta | CertificationSignedOffBeta | IdentityAttributesChangedBeta | IdentityCreatedBeta | IdentityDeletedBeta | ProvisioningCompletedBeta | SavedSearchCompleteBeta | SourceAccountCreatedBeta | SourceAccountDeletedBeta | SourceAccountUpdatedBeta | SourceCreatedBeta | SourceDeletedBeta | SourceUpdatedBeta | VAClusterStatusChangeEventBeta; - -/** - * @type TriggerExampleOutputBeta - * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. - * @export - */ -export type TriggerExampleOutputBeta = AccessRequestDynamicApprover1Beta | AccessRequestPreApproval1Beta; - -/** - * The type of trigger. - * @export - * @enum {string} - */ - -export const TriggerTypeBeta = { - RequestResponse: 'REQUEST_RESPONSE', - FireAndForget: 'FIRE_AND_FORGET' -} as const; - -export type TriggerTypeBeta = typeof TriggerTypeBeta[keyof typeof TriggerTypeBeta]; - - -/** - * - * @export - * @interface TrimBeta - */ -export interface TrimBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TrimBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof TrimBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface UUIDGeneratorBeta - */ -export interface UUIDGeneratorBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UUIDGeneratorBeta - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface UpdateAccessProfilesInBulk412ResponseBeta - */ -export interface UpdateAccessProfilesInBulk412ResponseBeta { - /** - * A message describing the error - * @type {object} - * @memberof UpdateAccessProfilesInBulk412ResponseBeta - */ - 'message'?: object; -} -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface UpdateMultiHostSourcesRequestInnerBeta - */ -export interface UpdateMultiHostSourcesRequestInnerBeta { - /** - * The operation to be performed - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerBeta - */ - 'op': UpdateMultiHostSourcesRequestInnerBetaOpBeta; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerBeta - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueBeta} - * @memberof UpdateMultiHostSourcesRequestInnerBeta - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueBeta; -} - -export const UpdateMultiHostSourcesRequestInnerBetaOpBeta = { - Add: 'add', - Replace: 'replace' -} as const; - -export type UpdateMultiHostSourcesRequestInnerBetaOpBeta = typeof UpdateMultiHostSourcesRequestInnerBetaOpBeta[keyof typeof UpdateMultiHostSourcesRequestInnerBetaOpBeta]; - -/** - * @type UpdateMultiHostSourcesRequestInnerValueBeta - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - */ -export type UpdateMultiHostSourcesRequestInnerValueBeta = Array | boolean | number | object | string; - -/** - * - * @export - * @interface UpperBeta - */ -export interface UpperBeta { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UpperBeta - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof UpperBeta - */ - 'input'?: { [key: string]: any; }; -} -/** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @export - * @enum {string} - */ - -export const UsageTypeBeta = { - Create: 'CREATE', - Update: 'UPDATE', - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE', - Assign: 'ASSIGN', - Unassign: 'UNASSIGN', - CreateGroup: 'CREATE_GROUP', - UpdateGroup: 'UPDATE_GROUP', - DeleteGroup: 'DELETE_GROUP', - Register: 'REGISTER', - CreateIdentity: 'CREATE_IDENTITY', - UpdateIdentity: 'UPDATE_IDENTITY', - EditGroup: 'EDIT_GROUP', - Unlock: 'UNLOCK', - ChangePassword: 'CHANGE_PASSWORD' -} as const; - -export type UsageTypeBeta = typeof UsageTypeBeta[keyof typeof UsageTypeBeta]; - - -/** - * - * @export - * @interface UserAppAccountBeta - */ -export interface UserAppAccountBeta { - /** - * the account ID - * @type {string} - * @memberof UserAppAccountBeta - */ - 'id'?: string; - /** - * It will always be \"ACCOUNT\" - * @type {string} - * @memberof UserAppAccountBeta - */ - 'type'?: string; - /** - * the account name - * @type {string} - * @memberof UserAppAccountBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppBeta - */ -export interface UserAppBeta { - /** - * The user app id - * @type {string} - * @memberof UserAppBeta - */ - 'id'?: string; - /** - * Time when the user app was created - * @type {string} - * @memberof UserAppBeta - */ - 'created'?: string; - /** - * Time when the user app was last modified - * @type {string} - * @memberof UserAppBeta - */ - 'modified'?: string; - /** - * True if the owner has multiple accounts for the source - * @type {boolean} - * @memberof UserAppBeta - */ - 'hasMultipleAccounts'?: boolean; - /** - * True if the source has password feature - * @type {boolean} - * @memberof UserAppBeta - */ - 'useForPasswordManagement'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof UserAppBeta - */ - 'provisionRequestEnabled'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof UserAppBeta - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {UserAppSourceAppBeta} - * @memberof UserAppBeta - */ - 'sourceApp'?: UserAppSourceAppBeta; - /** - * - * @type {UserAppSourceBeta} - * @memberof UserAppBeta - */ - 'source'?: UserAppSourceBeta; - /** - * - * @type {UserAppAccountBeta} - * @memberof UserAppBeta - */ - 'account'?: UserAppAccountBeta; - /** - * - * @type {UserAppOwnerBeta} - * @memberof UserAppBeta - */ - 'owner'?: UserAppOwnerBeta; -} -/** - * - * @export - * @interface UserAppOwnerBeta - */ -export interface UserAppOwnerBeta { - /** - * The identity ID - * @type {string} - * @memberof UserAppOwnerBeta - */ - 'id'?: string; - /** - * It will always be \"IDENTITY\" - * @type {string} - * @memberof UserAppOwnerBeta - */ - 'type'?: string; - /** - * The identity name - * @type {string} - * @memberof UserAppOwnerBeta - */ - 'name'?: string; - /** - * The identity alias - * @type {string} - * @memberof UserAppOwnerBeta - */ - 'alias'?: string; -} -/** - * - * @export - * @interface UserAppSourceAppBeta - */ -export interface UserAppSourceAppBeta { - /** - * the source app ID - * @type {string} - * @memberof UserAppSourceAppBeta - */ - 'id'?: string; - /** - * It will always be \"APPLICATION\" - * @type {string} - * @memberof UserAppSourceAppBeta - */ - 'type'?: string; - /** - * the source app name - * @type {string} - * @memberof UserAppSourceAppBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppSourceBeta - */ -export interface UserAppSourceBeta { - /** - * the source ID - * @type {string} - * @memberof UserAppSourceBeta - */ - 'id'?: string; - /** - * It will always be \"SOURCE\" - * @type {string} - * @memberof UserAppSourceBeta - */ - 'type'?: string; - /** - * the source name - * @type {string} - * @memberof UserAppSourceBeta - */ - 'name'?: string; -} -/** - * - * @export - * @interface V3ConnectorDtoBeta - */ -export interface V3ConnectorDtoBeta { - /** - * The connector name - * @type {string} - * @memberof V3ConnectorDtoBeta - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof V3ConnectorDtoBeta - */ - 'type'?: string; - /** - * The connector script name - * @type {string} - * @memberof V3ConnectorDtoBeta - */ - 'scriptName'?: string; - /** - * The connector class name. - * @type {string} - * @memberof V3ConnectorDtoBeta - */ - 'className'?: string | null; - /** - * The list of features supported by the connector - * @type {Array} - * @memberof V3ConnectorDtoBeta - */ - 'features'?: Array | null; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3ConnectorDtoBeta - */ - 'directConnect'?: boolean; - /** - * Object containing metadata pertinent to the UI to be used - * @type {object} - * @memberof V3ConnectorDtoBeta - */ - 'connectorMetadata'?: object; - /** - * The connector status - * @type {string} - * @memberof V3ConnectorDtoBeta - */ - 'status'?: string; -} -/** - * Details about the `CLUSTER` or `SOURCE` that initiated the event. - * @export - * @interface VAClusterStatusChangeEventApplicationBeta - */ -export interface VAClusterStatusChangeEventApplicationBeta { - /** - * Application\'s globally unique identifier (GUID). - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationBeta - */ - 'id': string; - /** - * Application name. - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationBeta - */ - 'name': string; - /** - * Custom map of attributes for a source. Attributes only populate if the type is `SOURCE` and the source has a proxy. - * @type {{ [key: string]: any; }} - * @memberof VAClusterStatusChangeEventApplicationBeta - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * - * @export - * @interface VAClusterStatusChangeEventBeta - */ -export interface VAClusterStatusChangeEventBeta { - /** - * Date and time when the status change occurred. - * @type {string} - * @memberof VAClusterStatusChangeEventBeta - */ - 'created': string; - /** - * Type of the object that initiated the event. - * @type {object} - * @memberof VAClusterStatusChangeEventBeta - */ - 'type': VAClusterStatusChangeEventBetaTypeBeta; - /** - * - * @type {VAClusterStatusChangeEventApplicationBeta} - * @memberof VAClusterStatusChangeEventBeta - */ - 'application': VAClusterStatusChangeEventApplicationBeta; - /** - * - * @type {VAClusterStatusChangeEventHealthCheckResultBeta} - * @memberof VAClusterStatusChangeEventBeta - */ - 'healthCheckResult': VAClusterStatusChangeEventHealthCheckResultBeta; - /** - * - * @type {VAClusterStatusChangeEventPreviousHealthCheckResultBeta} - * @memberof VAClusterStatusChangeEventBeta - */ - 'previousHealthCheckResult': VAClusterStatusChangeEventPreviousHealthCheckResultBeta; -} - -export const VAClusterStatusChangeEventBetaTypeBeta = { - Source: 'SOURCE', - Cluster: 'CLUSTER' -} as const; - -export type VAClusterStatusChangeEventBetaTypeBeta = typeof VAClusterStatusChangeEventBetaTypeBeta[keyof typeof VAClusterStatusChangeEventBetaTypeBeta]; - -/** - * Results of the most recent health check. - * @export - * @interface VAClusterStatusChangeEventHealthCheckResultBeta - */ -export interface VAClusterStatusChangeEventHealthCheckResultBeta { - /** - * Detailed message of the health check result.. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultBeta - */ - 'message': string; - /** - * Health check result type. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultBeta - */ - 'resultType': string; - /** - * Health check status. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultBeta - */ - 'status': VAClusterStatusChangeEventHealthCheckResultBetaStatusBeta; -} - -export const VAClusterStatusChangeEventHealthCheckResultBetaStatusBeta = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventHealthCheckResultBetaStatusBeta = typeof VAClusterStatusChangeEventHealthCheckResultBetaStatusBeta[keyof typeof VAClusterStatusChangeEventHealthCheckResultBetaStatusBeta]; - -/** - * Results of the last health check. - * @export - * @interface VAClusterStatusChangeEventPreviousHealthCheckResultBeta - */ -export interface VAClusterStatusChangeEventPreviousHealthCheckResultBeta { - /** - * Detailed message of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultBeta - */ - 'message': string; - /** - * Health check result type. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultBeta - */ - 'resultType': string; - /** - * Health check status. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultBeta - */ - 'status': VAClusterStatusChangeEventPreviousHealthCheckResultBetaStatusBeta; -} - -export const VAClusterStatusChangeEventPreviousHealthCheckResultBetaStatusBeta = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventPreviousHealthCheckResultBetaStatusBeta = typeof VAClusterStatusChangeEventPreviousHealthCheckResultBetaStatusBeta[keyof typeof VAClusterStatusChangeEventPreviousHealthCheckResultBetaStatusBeta]; - -/** - * - * @export - * @interface ValidateFilterInputDtoBeta - */ -export interface ValidateFilterInputDtoBeta { - /** - * Mock input to evaluate filter expression against. - * @type {object} - * @memberof ValidateFilterInputDtoBeta - */ - 'input': object; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof ValidateFilterInputDtoBeta - */ - 'filter': string; -} -/** - * - * @export - * @interface ValidateFilterOutputDtoBeta - */ -export interface ValidateFilterOutputDtoBeta { - /** - * When this field is true, the filter expression is valid against the input. - * @type {boolean} - * @memberof ValidateFilterOutputDtoBeta - */ - 'isValid'?: boolean; - /** - * When this field is true, the filter expression is using a valid JSON path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoBeta - */ - 'isValidJSONPath'?: boolean; - /** - * When this field is true, the filter expression is using an existing path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoBeta - */ - 'isPathExist'?: boolean; -} -/** - * - * @export - * @interface ValueBeta - */ -export interface ValueBeta { - /** - * The type of attribute value - * @type {string} - * @memberof ValueBeta - */ - 'type'?: string | null; - /** - * The attribute value - * @type {string} - * @memberof ValueBeta - */ - 'value'?: string; -} -/** - * - * @export - * @interface VerificationPollRequestBeta - */ -export interface VerificationPollRequestBeta { - /** - * Verification request Id - * @type {string} - * @memberof VerificationPollRequestBeta - */ - 'requestId': string; -} -/** - * - * @export - * @interface VerificationResponseBeta - */ -export interface VerificationResponseBeta { - /** - * The verificationPollRequest request ID - * @type {string} - * @memberof VerificationResponseBeta - */ - 'requestId'?: string | null; - /** - * MFA Authentication status - * @type {string} - * @memberof VerificationResponseBeta - */ - 'status'?: VerificationResponseBetaStatusBeta; - /** - * Error messages from MFA verification request - * @type {string} - * @memberof VerificationResponseBeta - */ - 'error'?: string | null; -} - -export const VerificationResponseBetaStatusBeta = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type VerificationResponseBetaStatusBeta = typeof VerificationResponseBetaStatusBeta[keyof typeof VerificationResponseBetaStatusBeta]; - -/** - * - * @export - * @interface ViolationContextBeta - */ -export interface ViolationContextBeta { - /** - * - * @type {ViolationContextPolicyBeta} - * @memberof ViolationContextBeta - */ - 'policy'?: ViolationContextPolicyBeta; - /** - * - * @type {ExceptionAccessCriteriaBeta} - * @memberof ViolationContextBeta - */ - 'conflictingAccessCriteria'?: ExceptionAccessCriteriaBeta; -} -/** - * The types of objects supported for SOD policy violations. - * @export - * @interface ViolationContextPolicyBeta - */ -export interface ViolationContextPolicyBeta { - /** - * The type of object supported for SOD policy violations. - * @type {object} - * @memberof ViolationContextPolicyBeta - */ - 'type'?: ViolationContextPolicyBetaTypeBeta; - /** - * SOD policy ID. - * @type {string} - * @memberof ViolationContextPolicyBeta - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof ViolationContextPolicyBeta - */ - 'name'?: string; -} - -export const ViolationContextPolicyBetaTypeBeta = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ViolationContextPolicyBetaTypeBeta = typeof ViolationContextPolicyBetaTypeBeta[keyof typeof ViolationContextPolicyBetaTypeBeta]; - -/** - * - * @export - * @interface ViolationOwnerAssignmentConfigBeta - */ -export interface ViolationOwnerAssignmentConfigBeta { - /** - * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity - * @type {string} - * @memberof ViolationOwnerAssignmentConfigBeta - */ - 'assignmentRule'?: ViolationOwnerAssignmentConfigBetaAssignmentRuleBeta | null; - /** - * - * @type {ViolationOwnerAssignmentConfigOwnerRefBeta} - * @memberof ViolationOwnerAssignmentConfigBeta - */ - 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRefBeta | null; -} - -export const ViolationOwnerAssignmentConfigBetaAssignmentRuleBeta = { - Manager: 'MANAGER', - Static: 'STATIC' -} as const; - -export type ViolationOwnerAssignmentConfigBetaAssignmentRuleBeta = typeof ViolationOwnerAssignmentConfigBetaAssignmentRuleBeta[keyof typeof ViolationOwnerAssignmentConfigBetaAssignmentRuleBeta]; - -/** - * The owner of the violation assignment config. - * @export - * @interface ViolationOwnerAssignmentConfigOwnerRefBeta - */ -export interface ViolationOwnerAssignmentConfigOwnerRefBeta { - /** - * Owner type. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefBeta - */ - 'type'?: ViolationOwnerAssignmentConfigOwnerRefBetaTypeBeta | null; - /** - * Owner\'s ID. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefBeta - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefBeta - */ - 'name'?: string; -} - -export const ViolationOwnerAssignmentConfigOwnerRefBetaTypeBeta = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - Manager: 'MANAGER' -} as const; - -export type ViolationOwnerAssignmentConfigOwnerRefBetaTypeBeta = typeof ViolationOwnerAssignmentConfigOwnerRefBetaTypeBeta[keyof typeof ViolationOwnerAssignmentConfigOwnerRefBetaTypeBeta]; - -/** - * An object containing a listing of the SOD violation reasons detected by this check. - * @export - * @interface ViolationPredictionBeta - */ -export interface ViolationPredictionBeta { - /** - * List of Violation Contexts - * @type {Array} - * @memberof ViolationPredictionBeta - */ - 'violationContexts'?: Array; -} -/** - * - * @export - * @interface VisibilityCriteriaBeta - */ -export interface VisibilityCriteriaBeta { - /** - * - * @type {ExpressionBeta} - * @memberof VisibilityCriteriaBeta - */ - 'expression'?: ExpressionBeta; -} -/** - * - * @export - * @interface WorkItemForwardBeta - */ -export interface WorkItemForwardBeta { - /** - * The ID of the identity to forward this work item to. - * @type {string} - * @memberof WorkItemForwardBeta - */ - 'targetOwnerId': string; - /** - * Comments to send to the target owner - * @type {string} - * @memberof WorkItemForwardBeta - */ - 'comment': string; - /** - * If true, send a notification to the target owner. - * @type {boolean} - * @memberof WorkItemForwardBeta - */ - 'sendNotifications'?: boolean; -} -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateBeta = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateBeta = typeof WorkItemStateBeta[keyof typeof WorkItemStateBeta]; - - -/** - * The type of the work item - * @export - * @enum {string} - */ - -export const WorkItemTypeBeta = { - Unknown: 'Unknown', - Generic: 'Generic', - Certification: 'Certification', - Remediation: 'Remediation', - Delegation: 'Delegation', - Approval: 'Approval', - ViolationReview: 'ViolationReview', - Form: 'Form', - PolicyViolation: 'PolicyViolation', - Challenge: 'Challenge', - ImpactAnalysis: 'ImpactAnalysis', - Signoff: 'Signoff', - Event: 'Event', - ManualAction: 'ManualAction', - Test: 'Test' -} as const; - -export type WorkItemTypeBeta = typeof WorkItemTypeBeta[keyof typeof WorkItemTypeBeta]; - - -/** - * - * @export - * @interface WorkItemsBeta - */ -export interface WorkItemsBeta { - /** - * ID of the work item - * @type {string} - * @memberof WorkItemsBeta - */ - 'id'?: string; - /** - * ID of the requester - * @type {string} - * @memberof WorkItemsBeta - */ - 'requesterId'?: string | null; - /** - * The displayname of the requester - * @type {string} - * @memberof WorkItemsBeta - */ - 'requesterDisplayName'?: string | null; - /** - * The ID of the owner - * @type {string} - * @memberof WorkItemsBeta - */ - 'ownerId'?: string | null; - /** - * The name of the owner - * @type {string} - * @memberof WorkItemsBeta - */ - 'ownerName'?: string; - /** - * - * @type {string} - * @memberof WorkItemsBeta - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof WorkItemsBeta - */ - 'modified'?: string | null; - /** - * The description of the work item - * @type {string} - * @memberof WorkItemsBeta - */ - 'description'?: string; - /** - * - * @type {WorkItemStateBeta} - * @memberof WorkItemsBeta - */ - 'state'?: WorkItemStateBeta | null; - /** - * - * @type {WorkItemTypeBeta} - * @memberof WorkItemsBeta - */ - 'type'?: WorkItemTypeBeta; - /** - * - * @type {Array} - * @memberof WorkItemsBeta - */ - 'remediationItems'?: Array | null; - /** - * - * @type {Array} - * @memberof WorkItemsBeta - */ - 'approvalItems'?: Array | null; - /** - * The work item name - * @type {string} - * @memberof WorkItemsBeta - */ - 'name'?: string | null; - /** - * - * @type {string} - * @memberof WorkItemsBeta - */ - 'completed'?: string | null; - /** - * The number of items in the work item - * @type {number} - * @memberof WorkItemsBeta - */ - 'numItems'?: number | null; - /** - * - * @type {Array} - * @memberof WorkItemsBeta - */ - 'errors'?: Array; - /** - * - * @type {FormDetailsBeta} - * @memberof WorkItemsBeta - */ - 'form'?: FormDetailsBeta | null; -} - - -/** - * - * @export - * @interface WorkItemsCountBeta - */ -export interface WorkItemsCountBeta { - /** - * The count of work items - * @type {number} - * @memberof WorkItemsCountBeta - */ - 'count'?: number; -} -/** - * - * @export - * @interface WorkItemsSummaryBeta - */ -export interface WorkItemsSummaryBeta { - /** - * The count of open work items - * @type {number} - * @memberof WorkItemsSummaryBeta - */ - 'open'?: number; - /** - * The count of completed work items - * @type {number} - * @memberof WorkItemsSummaryBeta - */ - 'completed'?: number; - /** - * The count of total work items - * @type {number} - * @memberof WorkItemsSummaryBeta - */ - 'total'?: number; -} -/** - * Workflow creator\'s identity. - * @export - * @interface WorkflowAllOfCreatorBeta - */ -export interface WorkflowAllOfCreatorBeta { - /** - * Workflow creator\'s DTO type. - * @type {string} - * @memberof WorkflowAllOfCreatorBeta - */ - 'type'?: WorkflowAllOfCreatorBetaTypeBeta; - /** - * Workflow creator\'s identity ID. - * @type {string} - * @memberof WorkflowAllOfCreatorBeta - */ - 'id'?: string; - /** - * Workflow creator\'s display name. - * @type {string} - * @memberof WorkflowAllOfCreatorBeta - */ - 'name'?: string; -} - -export const WorkflowAllOfCreatorBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowAllOfCreatorBetaTypeBeta = typeof WorkflowAllOfCreatorBetaTypeBeta[keyof typeof WorkflowAllOfCreatorBetaTypeBeta]; - -/** - * - * @export - * @interface WorkflowBeta - */ -export interface WorkflowBeta { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBeta - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerBeta} - * @memberof WorkflowBeta - */ - 'owner'?: WorkflowBodyOwnerBeta; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBeta - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionBeta} - * @memberof WorkflowBeta - */ - 'definition'?: WorkflowDefinitionBeta; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBeta - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerBeta} - * @memberof WorkflowBeta - */ - 'trigger'?: WorkflowTriggerBeta; - /** - * Workflow ID. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowBeta - */ - 'id'?: string; - /** - * The date and time the workflow was modified. - * @type {string} - * @memberof WorkflowBeta - */ - 'modified'?: string; - /** - * - * @type {WorkflowModifiedByBeta} - * @memberof WorkflowBeta - */ - 'modifiedBy'?: WorkflowModifiedByBeta; - /** - * The number of times this workflow has been executed. - * @type {number} - * @memberof WorkflowBeta - */ - 'executionCount'?: number; - /** - * The number of times this workflow has failed during execution. - * @type {number} - * @memberof WorkflowBeta - */ - 'failureCount'?: number; - /** - * The date and time the workflow was created. - * @type {string} - * @memberof WorkflowBeta - */ - 'created'?: string; - /** - * - * @type {WorkflowAllOfCreatorBeta} - * @memberof WorkflowBeta - */ - 'creator'?: WorkflowAllOfCreatorBeta; -} -/** - * - * @export - * @interface WorkflowBodyBeta - */ -export interface WorkflowBodyBeta { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBodyBeta - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerBeta} - * @memberof WorkflowBodyBeta - */ - 'owner'?: WorkflowBodyOwnerBeta; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBodyBeta - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionBeta} - * @memberof WorkflowBodyBeta - */ - 'definition'?: WorkflowDefinitionBeta; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBodyBeta - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerBeta} - * @memberof WorkflowBodyBeta - */ - 'trigger'?: WorkflowTriggerBeta; -} -/** - * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - * @export - * @interface WorkflowBodyOwnerBeta - */ -export interface WorkflowBodyOwnerBeta { - /** - * The type of object that is referenced - * @type {string} - * @memberof WorkflowBodyOwnerBeta - */ - 'type'?: WorkflowBodyOwnerBetaTypeBeta; - /** - * The unique ID of the object - * @type {string} - * @memberof WorkflowBodyOwnerBeta - */ - 'id'?: string; - /** - * The name of the object - * @type {string} - * @memberof WorkflowBodyOwnerBeta - */ - 'name'?: string; -} - -export const WorkflowBodyOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowBodyOwnerBetaTypeBeta = typeof WorkflowBodyOwnerBetaTypeBeta[keyof typeof WorkflowBodyOwnerBetaTypeBeta]; - -/** - * The map of steps that the workflow will execute. - * @export - * @interface WorkflowDefinitionBeta - */ -export interface WorkflowDefinitionBeta { - /** - * The name of the starting step. - * @type {string} - * @memberof WorkflowDefinitionBeta - */ - 'start'?: string; - /** - * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - * @type {{ [key: string]: any; }} - * @memberof WorkflowDefinitionBeta - */ - 'steps'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface WorkflowExecutionBeta - */ -export interface WorkflowExecutionBeta { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'id'?: string; - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'workflowId'?: string; - /** - * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'requestId'?: string; - /** - * Date/time when the workflow started. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'startTime'?: string; - /** - * Date/time when the workflow ended. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'closeTime'?: string; - /** - * Workflow execution status. - * @type {string} - * @memberof WorkflowExecutionBeta - */ - 'status'?: WorkflowExecutionBetaStatusBeta; -} - -export const WorkflowExecutionBetaStatusBeta = { - Completed: 'Completed', - Failed: 'Failed', - Canceled: 'Canceled', - Queued: 'Queued', - Running: 'Running' -} as const; - -export type WorkflowExecutionBetaStatusBeta = typeof WorkflowExecutionBetaStatusBeta[keyof typeof WorkflowExecutionBetaStatusBeta]; - -/** - * - * @export - * @interface WorkflowExecutionEventBeta - */ -export interface WorkflowExecutionEventBeta { - /** - * The type of event - * @type {object} - * @memberof WorkflowExecutionEventBeta - */ - 'type'?: WorkflowExecutionEventBetaTypeBeta; - /** - * The date-time when the event occurred - * @type {string} - * @memberof WorkflowExecutionEventBeta - */ - 'timestamp'?: string; - /** - * Additional attributes associated with the event - * @type {object} - * @memberof WorkflowExecutionEventBeta - */ - 'attributes'?: object; -} - -export const WorkflowExecutionEventBetaTypeBeta = { - WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', - WorkflowExecutionStarted: 'WorkflowExecutionStarted', - WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', - WorkflowExecutionFailed: 'WorkflowExecutionFailed', - WorkflowTaskScheduled: 'WorkflowTaskScheduled', - WorkflowTaskStarted: 'WorkflowTaskStarted', - WorkflowTaskCompleted: 'WorkflowTaskCompleted', - WorkflowTaskFailed: 'WorkflowTaskFailed', - ActivityTaskScheduled: 'ActivityTaskScheduled', - ActivityTaskStarted: 'ActivityTaskStarted', - ActivityTaskCompleted: 'ActivityTaskCompleted', - ActivityTaskFailed: 'ActivityTaskFailed' -} as const; - -export type WorkflowExecutionEventBetaTypeBeta = typeof WorkflowExecutionEventBetaTypeBeta[keyof typeof WorkflowExecutionEventBetaTypeBeta]; - -/** - * - * @export - * @interface WorkflowLibraryActionBeta - */ -export interface WorkflowLibraryActionBeta { - /** - * Action ID. This is a static namespaced ID for the action - * @type {string} - * @memberof WorkflowLibraryActionBeta - */ - 'id'?: string; - /** - * Action Name - * @type {string} - * @memberof WorkflowLibraryActionBeta - */ - 'name'?: string; - /** - * Action type - * @type {string} - * @memberof WorkflowLibraryActionBeta - */ - 'type'?: string; - /** - * Action Description - * @type {string} - * @memberof WorkflowLibraryActionBeta - */ - 'description'?: string; - /** - * One or more inputs that the action accepts - * @type {Array} - * @memberof WorkflowLibraryActionBeta - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputBeta} - * @memberof WorkflowLibraryActionBeta - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputBeta; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionBeta - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryActionBeta - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof WorkflowLibraryActionBeta - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionBeta - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryActionBeta - */ - 'isDynamicSchema'?: boolean; - /** - * Defines the output schema, if any, that this action produces. - * @type {object} - * @memberof WorkflowLibraryActionBeta - */ - 'outputSchema'?: object; -} -/** - * @type WorkflowLibraryActionExampleOutputBeta - * @export - */ -export type WorkflowLibraryActionExampleOutputBeta = Array | object; - -/** - * - * @export - * @interface WorkflowLibraryFormFieldsBeta - */ -export interface WorkflowLibraryFormFieldsBeta { - /** - * Description of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'description'?: string; - /** - * Describes the form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'helpText'?: string; - /** - * A human readable name for this form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'label'?: string; - /** - * The name of the input attribute - * @type {string} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'name'?: string; - /** - * Denotes if this field is a required attribute - * @type {boolean} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'required'?: boolean; - /** - * The type of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsBeta - */ - 'type'?: WorkflowLibraryFormFieldsBetaTypeBeta | null; -} - -export const WorkflowLibraryFormFieldsBetaTypeBeta = { - Text: 'text', - Textarea: 'textarea', - Boolean: 'boolean', - Email: 'email', - Url: 'url', - Number: 'number', - Json: 'json', - Checkbox: 'checkbox', - Jsonpath: 'jsonpath', - Select: 'select', - MultiType: 'multiType', - Duration: 'duration', - Toggle: 'toggle', - FormPicker: 'formPicker', - IdentityPicker: 'identityPicker', - GovernanceGroupPicker: 'governanceGroupPicker', - String: 'string', - Object: 'object', - Array: 'array', - Secret: 'secret', - KeyValuePairs: 'keyValuePairs', - EmailPicker: 'emailPicker', - AdvancedToggle: 'advancedToggle', - VariableCreator: 'variableCreator', - HtmlEditor: 'htmlEditor' -} as const; - -export type WorkflowLibraryFormFieldsBetaTypeBeta = typeof WorkflowLibraryFormFieldsBetaTypeBeta[keyof typeof WorkflowLibraryFormFieldsBetaTypeBeta]; - -/** - * - * @export - * @interface WorkflowLibraryOperatorBeta - */ -export interface WorkflowLibraryOperatorBeta { - /** - * Operator ID. - * @type {string} - * @memberof WorkflowLibraryOperatorBeta - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof WorkflowLibraryOperatorBeta - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof WorkflowLibraryOperatorBeta - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof WorkflowLibraryOperatorBeta - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryOperatorBeta - */ - 'isDynamicSchema'?: boolean; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorBeta - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryOperatorBeta - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorBeta - */ - 'isSimulationEnabled'?: boolean; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof WorkflowLibraryOperatorBeta - */ - 'formFields'?: Array | null; -} -/** - * - * @export - * @interface WorkflowLibraryTriggerBeta - */ -export interface WorkflowLibraryTriggerBeta { - /** - * Trigger ID. This is a static namespaced ID for the trigger. - * @type {string} - * @memberof WorkflowLibraryTriggerBeta - */ - 'id'?: string; - /** - * Trigger type - * @type {string} - * @memberof WorkflowLibraryTriggerBeta - */ - 'type'?: WorkflowLibraryTriggerBetaTypeBeta; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryTriggerBeta - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryTriggerBeta - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryTriggerBeta - */ - 'isSimulationEnabled'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof WorkflowLibraryTriggerBeta - */ - 'outputSchema'?: object; - /** - * Trigger Name - * @type {string} - * @memberof WorkflowLibraryTriggerBeta - */ - 'name'?: string; - /** - * Trigger Description - * @type {string} - * @memberof WorkflowLibraryTriggerBeta - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryTriggerBeta - */ - 'isDynamicSchema'?: boolean; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof WorkflowLibraryTriggerBeta - */ - 'inputExample'?: object | null; - /** - * One or more inputs that the trigger accepts - * @type {Array} - * @memberof WorkflowLibraryTriggerBeta - */ - 'formFields'?: Array | null; -} - -export const WorkflowLibraryTriggerBetaTypeBeta = { - Event: 'EVENT', - Scheduled: 'SCHEDULED', - External: 'EXTERNAL' -} as const; - -export type WorkflowLibraryTriggerBetaTypeBeta = typeof WorkflowLibraryTriggerBetaTypeBeta[keyof typeof WorkflowLibraryTriggerBetaTypeBeta]; - -/** - * - * @export - * @interface WorkflowModifiedByBeta - */ -export interface WorkflowModifiedByBeta { - /** - * - * @type {string} - * @memberof WorkflowModifiedByBeta - */ - 'type'?: WorkflowModifiedByBetaTypeBeta; - /** - * Identity ID - * @type {string} - * @memberof WorkflowModifiedByBeta - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof WorkflowModifiedByBeta - */ - 'name'?: string; -} - -export const WorkflowModifiedByBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowModifiedByBetaTypeBeta = typeof WorkflowModifiedByBetaTypeBeta[keyof typeof WorkflowModifiedByBetaTypeBeta]; - -/** - * - * @export - * @interface WorkflowOAuthClientBeta - */ -export interface WorkflowOAuthClientBeta { - /** - * OAuth client ID for the trigger. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowOAuthClientBeta - */ - 'id'?: string; - /** - * OAuthClient secret. - * @type {string} - * @memberof WorkflowOAuthClientBeta - */ - 'secret'?: string; - /** - * URL for the external trigger to invoke - * @type {string} - * @memberof WorkflowOAuthClientBeta - */ - 'url'?: string; -} -/** - * Workflow Trigger Attributes. - * @export - * @interface WorkflowTriggerAttributesBeta - */ -export interface WorkflowTriggerAttributesBeta { - /** - * The unique ID of the trigger - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'filter.$'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'formDefinitionId'?: string | null; - /** - * A unique name for the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'name'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'url'?: string | null; - /** - * Frequency of execution - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'frequency': WorkflowTriggerAttributesBetaFrequencyBeta | null; - /** - * Time zone identifier - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof WorkflowTriggerAttributesBeta - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof WorkflowTriggerAttributesBeta - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesBeta - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesBeta - */ - 'yearlyTimes'?: Array | null; -} - -export const WorkflowTriggerAttributesBetaFrequencyBeta = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type WorkflowTriggerAttributesBetaFrequencyBeta = typeof WorkflowTriggerAttributesBetaFrequencyBeta[keyof typeof WorkflowTriggerAttributesBetaFrequencyBeta]; - -/** - * The trigger that starts the workflow - * @export - * @interface WorkflowTriggerBeta - */ -export interface WorkflowTriggerBeta { - /** - * The trigger type - * @type {string} - * @memberof WorkflowTriggerBeta - */ - 'type': WorkflowTriggerBetaTypeBeta; - /** - * - * @type {string} - * @memberof WorkflowTriggerBeta - */ - 'displayName'?: string | null; - /** - * - * @type {WorkflowTriggerAttributesBeta} - * @memberof WorkflowTriggerBeta - */ - 'attributes': WorkflowTriggerAttributesBeta | null; -} - -export const WorkflowTriggerBetaTypeBeta = { - Event: 'EVENT', - External: 'EXTERNAL', - Scheduled: 'SCHEDULED', - Empty: '' -} as const; - -export type WorkflowTriggerBetaTypeBeta = typeof WorkflowTriggerBetaTypeBeta[keyof typeof WorkflowTriggerBetaTypeBeta]; - -/** - * - * @export - * @interface WorkgroupBulkDeleteRequestBeta - */ -export interface WorkgroupBulkDeleteRequestBeta { - /** - * List of IDs of Governance Groups to be deleted. - * @type {Array} - * @memberof WorkgroupBulkDeleteRequestBeta - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoBeta - */ -export interface WorkgroupConnectionDtoBeta { - /** - * - * @type {ConnectedObjectBeta} - * @memberof WorkgroupConnectionDtoBeta - */ - 'object'?: ConnectedObjectBeta; - /** - * Connection Type. - * @type {string} - * @memberof WorkgroupConnectionDtoBeta - */ - 'connectionType'?: WorkgroupConnectionDtoBetaConnectionTypeBeta; -} - -export const WorkgroupConnectionDtoBetaConnectionTypeBeta = { - AccessRequestReviewer: 'AccessRequestReviewer', - Owner: 'Owner', - ManagementWorkgroup: 'ManagementWorkgroup' -} as const; - -export type WorkgroupConnectionDtoBetaConnectionTypeBeta = typeof WorkgroupConnectionDtoBetaConnectionTypeBeta[keyof typeof WorkgroupConnectionDtoBetaConnectionTypeBeta]; - -/** - * - * @export - * @interface WorkgroupDeleteItemBeta - */ -export interface WorkgroupDeleteItemBeta { - /** - * Id of the Governance Group. - * @type {string} - * @memberof WorkgroupDeleteItemBeta - */ - 'id': string; - /** - * The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. - * @type {number} - * @memberof WorkgroupDeleteItemBeta - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupDeleteItemBeta - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupDtoBeta - */ -export interface WorkgroupDtoBeta { - /** - * - * @type {WorkgroupDtoOwnerBeta} - * @memberof WorkgroupDtoBeta - */ - 'owner'?: WorkgroupDtoOwnerBeta; - /** - * Governance group ID. - * @type {string} - * @memberof WorkgroupDtoBeta - */ - 'id'?: string; - /** - * Governance group name. - * @type {string} - * @memberof WorkgroupDtoBeta - */ - 'name'?: string; - /** - * Governance group description. - * @type {string} - * @memberof WorkgroupDtoBeta - */ - 'description'?: string; - /** - * Number of members in the governance group. - * @type {number} - * @memberof WorkgroupDtoBeta - */ - 'memberCount'?: number; - /** - * Number of connections in the governance group. - * @type {number} - * @memberof WorkgroupDtoBeta - */ - 'connectionCount'?: number; - /** - * - * @type {string} - * @memberof WorkgroupDtoBeta - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof WorkgroupDtoBeta - */ - 'modified'?: string; -} -/** - * - * @export - * @interface WorkgroupDtoOwnerBeta - */ -export interface WorkgroupDtoOwnerBeta { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof WorkgroupDtoOwnerBeta - */ - 'type'?: WorkgroupDtoOwnerBetaTypeBeta; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof WorkgroupDtoOwnerBeta - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof WorkgroupDtoOwnerBeta - */ - 'name'?: string; - /** - * The display name of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerBeta - */ - 'displayName'?: string; - /** - * The primary email address of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerBeta - */ - 'emailAddress'?: string; -} - -export const WorkgroupDtoOwnerBetaTypeBeta = { - Identity: 'IDENTITY' -} as const; - -export type WorkgroupDtoOwnerBetaTypeBeta = typeof WorkgroupDtoOwnerBetaTypeBeta[keyof typeof WorkgroupDtoOwnerBetaTypeBeta]; - -/** - * - * @export - * @interface WorkgroupMemberAddItemBeta - */ -export interface WorkgroupMemberAddItemBeta { - /** - * Identifier of identity in bulk member add request. - * @type {string} - * @memberof WorkgroupMemberAddItemBeta - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberAddItemBeta - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberAddItemBeta - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberDeleteItemBeta - */ -export interface WorkgroupMemberDeleteItemBeta { - /** - * Identifier of identity in bulk member add /remove request. - * @type {string} - * @memberof WorkgroupMemberDeleteItemBeta - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberDeleteItemBeta - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberDeleteItemBeta - */ - 'description'?: string; -} - -/** - * AccessModelMetadataBetaApi - axios parameter creator - * @export - */ -export const AccessModelMetadataBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOBeta} attributeDTOBeta Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute: async (attributeDTOBeta: AttributeDTOBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeDTOBeta' is not null or undefined - assertParamExists('createAccessModelMetadataAttribute', 'attributeDTOBeta', attributeDTOBeta) - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeDTOBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOBeta} attributeValueDTOBeta Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue: async (key: string, attributeValueDTOBeta: AttributeValueDTOBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'attributeValueDTOBeta' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'attributeValueDTOBeta', attributeValueDTOBeta) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeValueDTOBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttribute', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'value', value) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('listAccessModelMetadataAttributeValue', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationBeta JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute: async (key: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'key', key) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationBeta JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue: async (key: string, value: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'value', value) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessModelMetadataBetaApi - functional programming interface - * @export - */ -export const AccessModelMetadataBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessModelMetadataBetaApiAxiosParamCreator(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOBeta} attributeDTOBeta Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttribute(attributeDTOBeta: AttributeDTOBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttribute(attributeDTOBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.createAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOBeta} attributeValueDTOBeta Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttributeValue(key: string, attributeValueDTOBeta: AttributeValueDTOBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValue(key, attributeValueDTOBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.createAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttribute(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttribute(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.getAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttributeValue(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValue(key, value, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.getAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttribute(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttribute(filters, sorters, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.listAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttributeValue(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValue(key, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.listAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationBeta JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttribute(key: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttribute(key, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.updateAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationBeta JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttributeValue(key: string, value: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValue(key, value, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataBetaApi.updateAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessModelMetadataBetaApi - factory interface - * @export - */ -export const AccessModelMetadataBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessModelMetadataBetaApiFp(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttribute(requestParameters.attributeDTOBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataAttribute operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest { - /** - * Attribute to create - * @type {AttributeDTOBeta} - * @memberof AccessModelMetadataBetaApiCreateAccessModelMetadataAttribute - */ - readonly attributeDTOBeta: AttributeDTOBeta -} - -/** - * Request parameters for createAccessModelMetadataAttributeValue operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Attribute value to create - * @type {AttributeValueDTOBeta} - * @memberof AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValue - */ - readonly attributeValueDTOBeta: AttributeValueDTOBeta -} - -/** - * Request parameters for getAccessModelMetadataAttribute operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiGetAccessModelMetadataAttribute - */ - readonly key: string -} - -/** - * Request parameters for getAccessModelMetadataAttributeValue operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValue - */ - readonly value: string -} - -/** - * Request parameters for listAccessModelMetadataAttribute operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest { - /** - * 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof AccessModelMetadataBetaApiListAccessModelMetadataAttribute - */ - 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: **name, key** - * @type {string} - * @memberof AccessModelMetadataBetaApiListAccessModelMetadataAttribute - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataBetaApiListAccessModelMetadataAttribute - */ - 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 AccessModelMetadataBetaApiListAccessModelMetadataAttribute - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccessModelMetadataAttributeValue operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiListAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataBetaApiListAccessModelMetadataAttributeValue - */ - 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 AccessModelMetadataBetaApiListAccessModelMetadataAttributeValue - */ - readonly count?: boolean -} - -/** - * Request parameters for updateAccessModelMetadataAttribute operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiUpdateAccessModelMetadataAttribute - */ - readonly key: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataBetaApiUpdateAccessModelMetadataAttribute - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for updateAccessModelMetadataAttributeValue operation in AccessModelMetadataBetaApi. - * @export - * @interface AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValue - */ - readonly value: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValue - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * AccessModelMetadataBetaApi - object-oriented interface - * @export - * @class AccessModelMetadataBetaApi - * @extends {BaseAPI} - */ -export class AccessModelMetadataBetaApi extends BaseAPI { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).createAccessModelMetadataAttribute(requestParameters.attributeDTOBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataBetaApi - */ - public updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataBetaApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataBetaApiFp(this.configuration).updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessProfilesBetaApi - axios parameter creator - * @export - */ -export const AccessProfilesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileBeta} accessProfileBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile: async (accessProfileBeta: AccessProfileBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBeta' is not null or undefined - assertParamExists('createAccessProfile', 'accessProfileBeta', accessProfileBeta) - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestBeta} accessProfileBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk: async (accessProfileBulkDeleteRequestBeta: AccessProfileBulkDeleteRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkDeleteRequestBeta' is not null or undefined - assertParamExists('deleteAccessProfilesInBulk', 'accessProfileBulkDeleteRequestBeta', accessProfileBulkDeleteRequestBeta) - const localVarPath = `/access-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfileEntitlements', 'id', id) - const localVarPath = `/access-profiles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAccessProfile', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchAccessProfile', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk: async (accessProfileBulkUpdateRequestInnerBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkUpdateRequestInnerBeta' is not null or undefined - assertParamExists('updateAccessProfilesInBulk', 'accessProfileBulkUpdateRequestInnerBeta', accessProfileBulkUpdateRequestInnerBeta) - const localVarPath = `/access-profiles/bulk-update-requestable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkUpdateRequestInnerBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessProfilesBetaApi - functional programming interface - * @export - */ -export const AccessProfilesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessProfilesBetaApiAxiosParamCreator(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileBeta} accessProfileBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessProfile(accessProfileBeta: AccessProfileBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfile(accessProfileBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.createAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.deleteAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestBeta} accessProfileBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestBeta: AccessProfileBulkDeleteRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.deleteAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.getAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.getAccessProfileEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfiles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.listAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAccessProfile(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfile(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.patchAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesBetaApi.updateAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessProfilesBetaApi - factory interface - * @export - */ -export const AccessProfilesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessProfilesBetaApiFp(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesBetaApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile(requestParameters: AccessProfilesBetaApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessProfile(requestParameters.accessProfileBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesBetaApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile(requestParameters: AccessProfilesBetaApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - * @summary Delete access profile(s) - * @param {AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk(requestParameters: AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesBetaApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile(requestParameters: AccessProfilesBetaApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. - * @summary List access profile\'s entitlements - * @param {AccessProfilesBetaApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements(requestParameters: AccessProfilesBetaApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesBetaApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles(requestParameters: AccessProfilesBetaApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesBetaApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile(requestParameters: AccessProfilesBetaApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk(requestParameters: AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessProfile operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiCreateAccessProfileRequest - */ -export interface AccessProfilesBetaApiCreateAccessProfileRequest { - /** - * - * @type {AccessProfileBeta} - * @memberof AccessProfilesBetaApiCreateAccessProfile - */ - readonly accessProfileBeta: AccessProfileBeta -} - -/** - * Request parameters for deleteAccessProfile operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiDeleteAccessProfileRequest - */ -export interface AccessProfilesBetaApiDeleteAccessProfileRequest { - /** - * ID of the Access Profile to delete - * @type {string} - * @memberof AccessProfilesBetaApiDeleteAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest - */ -export interface AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest { - /** - * - * @type {AccessProfileBulkDeleteRequestBeta} - * @memberof AccessProfilesBetaApiDeleteAccessProfilesInBulk - */ - readonly accessProfileBulkDeleteRequestBeta: AccessProfileBulkDeleteRequestBeta -} - -/** - * Request parameters for getAccessProfile operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiGetAccessProfileRequest - */ -export interface AccessProfilesBetaApiGetAccessProfileRequest { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfilesBetaApiGetAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for getAccessProfileEntitlements operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest - */ -export interface AccessProfilesBetaApiGetAccessProfileEntitlementsRequest { - /** - * ID of the access profile containing the entitlements. - * @type {string} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof AccessProfilesBetaApiGetAccessProfileEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listAccessProfiles operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiListAccessProfilesRequest - */ -export interface AccessProfilesBetaApiListAccessProfilesRequest { - /** - * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @type {string} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly forSubadmin?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly sorters?: string - - /** - * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly forSegmentIds?: string - - /** - * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @type {boolean} - * @memberof AccessProfilesBetaApiListAccessProfiles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchAccessProfile operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiPatchAccessProfileRequest - */ -export interface AccessProfilesBetaApiPatchAccessProfileRequest { - /** - * ID of the Access Profile to patch - * @type {string} - * @memberof AccessProfilesBetaApiPatchAccessProfile - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AccessProfilesBetaApiPatchAccessProfile - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for updateAccessProfilesInBulk operation in AccessProfilesBetaApi. - * @export - * @interface AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest - */ -export interface AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest { - /** - * - * @type {Array} - * @memberof AccessProfilesBetaApiUpdateAccessProfilesInBulk - */ - readonly accessProfileBulkUpdateRequestInnerBeta: Array -} - -/** - * AccessProfilesBetaApi - object-oriented interface - * @export - * @class AccessProfilesBetaApi - * @extends {BaseAPI} - */ -export class AccessProfilesBetaApi extends BaseAPI { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesBetaApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public createAccessProfile(requestParameters: AccessProfilesBetaApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).createAccessProfile(requestParameters.accessProfileBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesBetaApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public deleteAccessProfile(requestParameters: AccessProfilesBetaApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - * @summary Delete access profile(s) - * @param {AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public deleteAccessProfilesInBulk(requestParameters: AccessProfilesBetaApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesBetaApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public getAccessProfile(requestParameters: AccessProfilesBetaApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of an access profile\'s entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. - * @summary List access profile\'s entitlements - * @param {AccessProfilesBetaApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public getAccessProfileEntitlements(requestParameters: AccessProfilesBetaApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesBetaApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public listAccessProfiles(requestParameters: AccessProfilesBetaApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesBetaApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public patchAccessProfile(requestParameters: AccessProfilesBetaApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesBetaApi - */ - public updateAccessProfilesInBulk(requestParameters: AccessProfilesBetaApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesBetaApiFp(this.configuration).updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestApprovalsBetaApi - axios parameter creator - * @export - */ -export const AccessRequestApprovalsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoBeta} commentDtoBeta Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest: async (approvalId: string, commentDtoBeta: CommentDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('approveAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDtoBeta' is not null or undefined - assertParamExists('approveAccessRequest', 'commentDtoBeta', commentDtoBeta) - const localVarPath = `/access-request-approvals/{approvalId}/approve` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoBeta} forwardApprovalDtoBeta Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest: async (approvalId: string, forwardApprovalDtoBeta: ForwardApprovalDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('forwardAccessRequest', 'approvalId', approvalId) - // verify required parameter 'forwardApprovalDtoBeta' is not null or undefined - assertParamExists('forwardAccessRequest', 'forwardApprovalDtoBeta', forwardApprovalDtoBeta) - const localVarPath = `/access-request-approvals/{approvalId}/forward` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(forwardApprovalDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/approval-summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (fromDate !== undefined) { - localVarQueryParameter['from-date'] = fromDate; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/pending`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoBeta} commentDtoBeta Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest: async (approvalId: string, commentDtoBeta: CommentDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('rejectAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDtoBeta' is not null or undefined - assertParamExists('rejectAccessRequest', 'commentDtoBeta', commentDtoBeta) - const localVarPath = `/access-request-approvals/{approvalId}/reject` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestApprovalsBetaApi - functional programming interface - * @export - */ -export const AccessRequestApprovalsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestApprovalsBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoBeta} commentDtoBeta Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveAccessRequest(approvalId: string, commentDtoBeta: CommentDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequest(approvalId, commentDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.approveAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoBeta} forwardApprovalDtoBeta Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardAccessRequest(approvalId: string, forwardApprovalDtoBeta: ForwardApprovalDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequest(approvalId, forwardApprovalDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.forwardAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummary(ownerId, fromDate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.getAccessRequestApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.listCompletedApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.listPendingApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoBeta} commentDtoBeta Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectAccessRequest(approvalId: string, commentDtoBeta: CommentDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequest(approvalId, commentDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsBetaApi.rejectAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestApprovalsBetaApi - factory interface - * @export - */ -export const AccessRequestApprovalsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestApprovalsBetaApiFp(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsBetaApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest(requestParameters: AccessRequestApprovalsBetaApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsBetaApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest(requestParameters: AccessRequestApprovalsBetaApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsBetaApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals(requestParameters: AccessRequestApprovalsBetaApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsBetaApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals(requestParameters: AccessRequestApprovalsBetaApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsBetaApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest(requestParameters: AccessRequestApprovalsBetaApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveAccessRequest operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiApproveAccessRequestRequest - */ -export interface AccessRequestApprovalsBetaApiApproveAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiApproveAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoBeta} - * @memberof AccessRequestApprovalsBetaApiApproveAccessRequest - */ - readonly commentDtoBeta: CommentDtoBeta -} - -/** - * Request parameters for forwardAccessRequest operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiForwardAccessRequestRequest - */ -export interface AccessRequestApprovalsBetaApiForwardAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiForwardAccessRequest - */ - readonly approvalId: string - - /** - * Information about the forwarded approval. - * @type {ForwardApprovalDtoBeta} - * @memberof AccessRequestApprovalsBetaApiForwardAccessRequest - */ - readonly forwardApprovalDtoBeta: ForwardApprovalDtoBeta -} - -/** - * Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest - */ -export interface AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest { - /** - * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummary - */ - readonly ownerId?: string - - /** - * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummary - */ - readonly fromDate?: string -} - -/** - * Request parameters for listCompletedApprovals operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiListCompletedApprovalsRequest - */ -export interface AccessRequestApprovalsBetaApiListCompletedApprovalsRequest { - /** - * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListCompletedApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listPendingApprovals operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiListPendingApprovalsRequest - */ -export interface AccessRequestApprovalsBetaApiListPendingApprovalsRequest { - /** - * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsBetaApiListPendingApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for rejectAccessRequest operation in AccessRequestApprovalsBetaApi. - * @export - * @interface AccessRequestApprovalsBetaApiRejectAccessRequestRequest - */ -export interface AccessRequestApprovalsBetaApiRejectAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsBetaApiRejectAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoBeta} - * @memberof AccessRequestApprovalsBetaApiRejectAccessRequest - */ - readonly commentDtoBeta: CommentDtoBeta -} - -/** - * AccessRequestApprovalsBetaApi - object-oriented interface - * @export - * @class AccessRequestApprovalsBetaApi - * @extends {BaseAPI} - */ -export class AccessRequestApprovalsBetaApi extends BaseAPI { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsBetaApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public approveAccessRequest(requestParameters: AccessRequestApprovalsBetaApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsBetaApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public forwardAccessRequest(requestParameters: AccessRequestApprovalsBetaApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsBetaApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsBetaApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public listCompletedApprovals(requestParameters: AccessRequestApprovalsBetaApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsBetaApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public listPendingApprovals(requestParameters: AccessRequestApprovalsBetaApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsBetaApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsBetaApi - */ - public rejectAccessRequest(requestParameters: AccessRequestApprovalsBetaApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsBetaApiFp(this.configuration).rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestIdentityMetricsBetaApi - axios parameter creator - * @export - */ -export const AccessRequestIdentityMetricsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeBeta} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics: async (identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'identityId', identityId) - // verify required parameter 'requestedObjectId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'requestedObjectId', requestedObjectId) - // verify required parameter 'type' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'type', type) - const localVarPath = `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"requestedObjectId"}}`, encodeURIComponent(String(requestedObjectId))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestIdentityMetricsBetaApi - functional programming interface - * @export - */ -export const AccessRequestIdentityMetricsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestIdentityMetricsBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeBeta} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestIdentityMetrics(identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestIdentityMetrics(identityId, requestedObjectId, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestIdentityMetricsBetaApi.getAccessRequestIdentityMetrics']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestIdentityMetricsBetaApi - factory interface - * @export - */ -export const AccessRequestIdentityMetricsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestIdentityMetricsBetaApiFp(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccessRequestIdentityMetrics operation in AccessRequestIdentityMetricsBetaApi. - * @export - * @interface AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest - */ -export interface AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest { - /** - * Manager\'s identity ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetrics - */ - readonly identityId: string - - /** - * Requested access item\'s ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetrics - */ - readonly requestedObjectId: string - - /** - * Requested access item\'s type. - * @type {'ENTITLEMENT' | 'ACCESS_PROFILE' | 'ROLE'} - * @memberof AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetrics - */ - readonly type: GetAccessRequestIdentityMetricsTypeBeta -} - -/** - * AccessRequestIdentityMetricsBetaApi - object-oriented interface - * @export - * @class AccessRequestIdentityMetricsBetaApi - * @extends {BaseAPI} - */ -export class AccessRequestIdentityMetricsBetaApi extends BaseAPI { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestIdentityMetricsBetaApi - */ - public getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsBetaApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestIdentityMetricsBetaApiFp(this.configuration).getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetAccessRequestIdentityMetricsTypeBeta = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type GetAccessRequestIdentityMetricsTypeBeta = typeof GetAccessRequestIdentityMetricsTypeBeta[keyof typeof GetAccessRequestIdentityMetricsTypeBeta]; - - -/** - * AccessRequestsBetaApi - axios parameter creator - * @export - */ -export const AccessRequestsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestBeta} cancelAccessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest: async (cancelAccessRequestBeta: CancelAccessRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cancelAccessRequestBeta' is not null or undefined - assertParamExists('cancelAccessRequest', 'cancelAccessRequestBeta', cancelAccessRequestBeta) - const localVarPath = `/access-requests/cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(cancelAccessRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestBeta} closeAccessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest: async (closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'closeAccessRequestBeta' is not null or undefined - assertParamExists('closeAccessRequest', 'closeAccessRequestBeta', closeAccessRequestBeta) - const localVarPath = `/access-requests/close`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(closeAccessRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestBeta} accessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest: async (accessRequestBeta: AccessRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestBeta' is not null or undefined - assertParamExists('createAccessRequest', 'accessRequestBeta', accessRequestBeta) - const localVarPath = `/access-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus: async (xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('listAdministratorsAccessRequestStatus', 'xSailPointExperimental', xSailPointExperimental) - const localVarPath = `/access-request-administration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigBeta} accessRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig: async (accessRequestConfigBeta: AccessRequestConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestConfigBeta' is not null or undefined - assertParamExists('setAccessRequestConfig', 'accessRequestConfigBeta', accessRequestConfigBeta) - const localVarPath = `/access-request-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestsBetaApi - functional programming interface - * @export - */ -export const AccessRequestsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestBeta} cancelAccessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequest(cancelAccessRequestBeta: CancelAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequest(cancelAccessRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.cancelAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestBeta} closeAccessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async closeAccessRequest(closeAccessRequestBeta: CloseAccessRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.closeAccessRequest(closeAccessRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.closeAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestBeta} accessRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessRequest(accessRequestBeta: AccessRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequest(accessRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.createAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.getAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatus(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.listAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAdministratorsAccessRequestStatus(xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAdministratorsAccessRequestStatus(xSailPointExperimental, requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.listAdministratorsAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigBeta} accessRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setAccessRequestConfig(accessRequestConfigBeta: AccessRequestConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfig(accessRequestConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsBetaApi.setAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestsBetaApi - factory interface - * @export - */ -export const AccessRequestsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestsBetaApiFp(configuration) - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsBetaApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest(requestParameters: AccessRequestsBetaApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsBetaApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.closeAccessRequest(requestParameters.closeAccessRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest(requestParameters: AccessRequestsBetaApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessRequest(requestParameters.accessRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsBetaApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus(requestParameters: AccessRequestsBetaApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsBetaApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig(requestParameters: AccessRequestsBetaApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestConfig(requestParameters.accessRequestConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelAccessRequest operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiCancelAccessRequestRequest - */ -export interface AccessRequestsBetaApiCancelAccessRequestRequest { - /** - * - * @type {CancelAccessRequestBeta} - * @memberof AccessRequestsBetaApiCancelAccessRequest - */ - readonly cancelAccessRequestBeta: CancelAccessRequestBeta -} - -/** - * Request parameters for closeAccessRequest operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiCloseAccessRequestRequest - */ -export interface AccessRequestsBetaApiCloseAccessRequestRequest { - /** - * - * @type {CloseAccessRequestBeta} - * @memberof AccessRequestsBetaApiCloseAccessRequest - */ - readonly closeAccessRequestBeta: CloseAccessRequestBeta -} - -/** - * Request parameters for createAccessRequest operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiCreateAccessRequestRequest - */ -export interface AccessRequestsBetaApiCreateAccessRequestRequest { - /** - * - * @type {AccessRequestBeta} - * @memberof AccessRequestsBetaApiCreateAccessRequest - */ - readonly accessRequestBeta: AccessRequestBeta -} - -/** - * Request parameters for listAccessRequestStatus operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiListAccessRequestStatusRequest - */ -export interface AccessRequestsBetaApiListAccessRequestStatusRequest { - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name** - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsBetaApiListAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for listAdministratorsAccessRequestStatus operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest - */ -export interface AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly xSailPointExperimental: string - - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name, accessRequestId** - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsBetaApiListAdministratorsAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for setAccessRequestConfig operation in AccessRequestsBetaApi. - * @export - * @interface AccessRequestsBetaApiSetAccessRequestConfigRequest - */ -export interface AccessRequestsBetaApiSetAccessRequestConfigRequest { - /** - * - * @type {AccessRequestConfigBeta} - * @memberof AccessRequestsBetaApiSetAccessRequestConfig - */ - readonly accessRequestConfigBeta: AccessRequestConfigBeta -} - -/** - * AccessRequestsBetaApi - object-oriented interface - * @export - * @class AccessRequestsBetaApi - * @extends {BaseAPI} - */ -export class AccessRequestsBetaApi extends BaseAPI { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsBetaApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public cancelAccessRequest(requestParameters: AccessRequestsBetaApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsBetaApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public closeAccessRequest(requestParameters: AccessRequestsBetaApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).closeAccessRequest(requestParameters.closeAccessRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsBetaApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public createAccessRequest(requestParameters: AccessRequestsBetaApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).createAccessRequest(requestParameters.accessRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).getAccessRequestConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsBetaApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public listAccessRequestStatus(requestParameters: AccessRequestsBetaApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsBetaApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsBetaApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsBetaApi - */ - public setAccessRequestConfig(requestParameters: AccessRequestsBetaApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsBetaApiFp(this.configuration).setAccessRequestConfig(requestParameters.accessRequestConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountActivitiesBetaApi - axios parameter creator - * @export - */ -export const AccountActivitiesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets a single account activity by its id. - * @summary Get account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountActivity', 'id', id) - const localVarPath = `/account-activities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [type] The type of account activity. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, type?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-activities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountActivitiesBetaApi - functional programming interface - * @export - */ -export const AccountActivitiesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountActivitiesBetaApiAxiosParamCreator(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountActivity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesBetaApi.getAccountActivity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [type] The type of account activity. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccountActivities(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, type?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivities(requestedFor, requestedBy, regardingIdentity, type, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesBetaApi.listAccountActivities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountActivitiesBetaApi - factory interface - * @export - */ -export const AccountActivitiesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountActivitiesBetaApiFp(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get account activity - * @param {AccountActivitiesBetaApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity(requestParameters: AccountActivitiesBetaApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesBetaApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities(requestParameters: AccountActivitiesBetaApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountActivity operation in AccountActivitiesBetaApi. - * @export - * @interface AccountActivitiesBetaApiGetAccountActivityRequest - */ -export interface AccountActivitiesBetaApiGetAccountActivityRequest { - /** - * The account activity id - * @type {string} - * @memberof AccountActivitiesBetaApiGetAccountActivity - */ - readonly id: string -} - -/** - * Request parameters for listAccountActivities operation in AccountActivitiesBetaApi. - * @export - * @interface AccountActivitiesBetaApiListAccountActivitiesRequest - */ -export interface AccountActivitiesBetaApiListAccountActivitiesRequest { - /** - * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly requestedFor?: string - - /** - * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly requestedBy?: string - - /** - * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly regardingIdentity?: string - - /** - * The type of account activity. - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly type?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - 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: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - 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: **type, created, modified** - * @type {string} - * @memberof AccountActivitiesBetaApiListAccountActivities - */ - readonly sorters?: string -} - -/** - * AccountActivitiesBetaApi - object-oriented interface - * @export - * @class AccountActivitiesBetaApi - * @extends {BaseAPI} - */ -export class AccountActivitiesBetaApi extends BaseAPI { - /** - * This gets a single account activity by its id. - * @summary Get account activity - * @param {AccountActivitiesBetaApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesBetaApi - */ - public getAccountActivity(requestParameters: AccountActivitiesBetaApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesBetaApiFp(this.configuration).getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesBetaApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesBetaApi - */ - public listAccountActivities(requestParameters: AccountActivitiesBetaApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesBetaApiFp(this.configuration).listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountAggregationsBetaApi - axios parameter creator - * @export - */ -export const AccountAggregationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountAggregationStatus', 'id', id) - const localVarPath = `/account-aggregations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountAggregationsBetaApi - functional programming interface - * @export - */ -export const AccountAggregationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountAggregationsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountAggregationStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountAggregationStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountAggregationsBetaApi.getAccountAggregationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountAggregationsBetaApi - factory interface - * @export - */ -export const AccountAggregationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountAggregationsBetaApiFp(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsBetaApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus(requestParameters: AccountAggregationsBetaApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountAggregationStatus operation in AccountAggregationsBetaApi. - * @export - * @interface AccountAggregationsBetaApiGetAccountAggregationStatusRequest - */ -export interface AccountAggregationsBetaApiGetAccountAggregationStatusRequest { - /** - * The account aggregation id - * @type {string} - * @memberof AccountAggregationsBetaApiGetAccountAggregationStatus - */ - readonly id: string -} - -/** - * AccountAggregationsBetaApi - object-oriented interface - * @export - * @class AccountAggregationsBetaApi - * @extends {BaseAPI} - */ -export class AccountAggregationsBetaApi extends BaseAPI { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsBetaApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountAggregationsBetaApi - */ - public getAccountAggregationStatus(requestParameters: AccountAggregationsBetaApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountAggregationsBetaApiFp(this.configuration).getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountUsagesBetaApi - axios parameter creator - * @export - */ -export const AccountUsagesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('getUsagesByAccountId', 'accountId', accountId) - const localVarPath = `/account-usages/{accountId}/summaries` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountUsagesBetaApi - functional programming interface - * @export - */ -export const AccountUsagesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountUsagesBetaApiAxiosParamCreator(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountId(accountId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountUsagesBetaApi.getUsagesByAccountId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountUsagesBetaApi - factory interface - * @export - */ -export const AccountUsagesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountUsagesBetaApiFp(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesBetaApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId(requestParameters: AccountUsagesBetaApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getUsagesByAccountId operation in AccountUsagesBetaApi. - * @export - * @interface AccountUsagesBetaApiGetUsagesByAccountIdRequest - */ -export interface AccountUsagesBetaApiGetUsagesByAccountIdRequest { - /** - * ID of IDN account - * @type {string} - * @memberof AccountUsagesBetaApiGetUsagesByAccountId - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesBetaApiGetUsagesByAccountId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesBetaApiGetUsagesByAccountId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountUsagesBetaApiGetUsagesByAccountId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof AccountUsagesBetaApiGetUsagesByAccountId - */ - readonly sorters?: string -} - -/** - * AccountUsagesBetaApi - object-oriented interface - * @export - * @class AccountUsagesBetaApi - * @extends {BaseAPI} - */ -export class AccountUsagesBetaApi extends BaseAPI { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesBetaApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountUsagesBetaApi - */ - public getUsagesByAccountId(requestParameters: AccountUsagesBetaApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountUsagesBetaApiFp(this.configuration).getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountsBetaApi - axios parameter creator - * @export - */ -export const AccountsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateBeta} accountAttributesCreateBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createAccount: async (accountAttributesCreateBeta: AccountAttributesCreateBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountAttributesCreateBeta' is not null or undefined - assertParamExists('createAccount', 'accountAttributesCreateBeta', accountAttributesCreateBeta) - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesCreateBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**NOTE:** You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountAsync', 'id', id) - const localVarPath = `/accounts/{id}/remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestBeta} accountToggleRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccount: async (id: string, accountToggleRequestBeta: AccountToggleRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccount', 'id', id) - // verify required parameter 'accountToggleRequestBeta' is not null or undefined - assertParamExists('disableAccount', 'accountToggleRequestBeta', accountToggleRequestBeta) - const localVarPath = `/accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestBeta} identitiesAccountsBulkRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccountsForIdentities: async (identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestBeta' is not null or undefined - assertParamExists('disableAccountsForIdentities', 'identitiesAccountsBulkRequestBeta', identitiesAccountsBulkRequestBeta) - const localVarPath = `/identities-accounts/disable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestBeta} accountToggleRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccount: async (id: string, accountToggleRequestBeta: AccountToggleRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccount', 'id', id) - // verify required parameter 'accountToggleRequestBeta' is not null or undefined - assertParamExists('enableAccount', 'accountToggleRequestBeta', accountToggleRequestBeta) - const localVarPath = `/accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestBeta} identitiesAccountsBulkRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccountsForIdentities: async (identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestBeta' is not null or undefined - assertParamExists('enableAccountsForIdentities', 'identitiesAccountsBulkRequestBeta', identitiesAccountsBulkRequestBeta) - const localVarPath = `/identities-accounts/enable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account entitlements - * @param {string} id The account id - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccountEntitlements: async (id: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountEntitlements', 'id', id) - const localVarPath = `/accounts/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List accounts. - * @summary Accounts list - * @param {ListAccountsDetailLevelBeta} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listAccounts: async (detailLevel?: ListAccountsDetailLevelBeta, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesBeta} accountAttributesBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putAccount: async (id: string, accountAttributesBeta: AccountAttributesBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putAccount', 'id', id) - // verify required parameter 'accountAttributesBeta' is not null or undefined - assertParamExists('putAccount', 'accountAttributesBeta', accountAttributesBeta) - const localVarPath = `/accounts/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitReloadAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReloadAccount', 'id', id) - const localVarPath = `/accounts/{id}/reload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestBeta} accountUnlockRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - unlockAccount: async (id: string, accountUnlockRequestBeta: AccountUnlockRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unlockAccount', 'id', id) - // verify required parameter 'accountUnlockRequestBeta' is not null or undefined - assertParamExists('unlockAccount', 'accountUnlockRequestBeta', accountUnlockRequestBeta) - const localVarPath = `/accounts/{id}/unlock` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountUnlockRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateAccount', 'requestBody', requestBody) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountsBetaApi - functional programming interface - * @export - */ -export const AccountsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountsBetaApiAxiosParamCreator(configuration) - return { - /** - * Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateBeta} accountAttributesCreateBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createAccount(accountAttributesCreateBeta: AccountAttributesCreateBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccount(accountAttributesCreateBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.createAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**NOTE:** You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.deleteAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.deleteAccountAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestBeta} accountToggleRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async disableAccount(id: string, accountToggleRequestBeta: AccountToggleRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccount(id, accountToggleRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.disableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async disableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.disableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestBeta} identitiesAccountsBulkRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async disableAccountsForIdentities(identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountsForIdentities(identitiesAccountsBulkRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.disableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestBeta} accountToggleRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async enableAccount(id: string, accountToggleRequestBeta: AccountToggleRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccount(id, accountToggleRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.enableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async enableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.enableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestBeta} identitiesAccountsBulkRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async enableAccountsForIdentities(identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountsForIdentities(identitiesAccountsBulkRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.enableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.getAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account entitlements - * @param {string} id The account id - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccountEntitlements(id: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.getAccountEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List accounts. - * @summary Accounts list - * @param {ListAccountsDetailLevelBeta} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listAccounts(detailLevel?: ListAccountsDetailLevelBeta, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(detailLevel, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.listAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesBeta} accountAttributesBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async putAccount(id: string, accountAttributesBeta: AccountAttributesBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putAccount(id, accountAttributesBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.putAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async submitReloadAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.submitReloadAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestBeta} accountUnlockRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async unlockAccount(id: string, accountUnlockRequestBeta: AccountUnlockRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(id, accountUnlockRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.unlockAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsBetaApi.updateAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountsBetaApi - factory interface - * @export - */ -export const AccountsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountsBetaApiFp(configuration) - return { - /** - * Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsBetaApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createAccount(requestParameters: AccountsBetaApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccount(requestParameters.accountAttributesCreateBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**NOTE:** You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsBetaApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteAccount(requestParameters: AccountsBetaApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsBetaApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync(requestParameters: AccountsBetaApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Disable account - * @param {AccountsBetaApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccount(requestParameters: AccountsBetaApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccount(requestParameters.id, requestParameters.accountToggleRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsBetaApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccountForIdentity(requestParameters: AccountsBetaApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsBetaApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - disableAccountsForIdentities(requestParameters: AccountsBetaApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Enable account - * @param {AccountsBetaApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccount(requestParameters: AccountsBetaApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccount(requestParameters.id, requestParameters.accountToggleRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsBetaApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccountForIdentity(requestParameters: AccountsBetaApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsBetaApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - enableAccountsForIdentities(requestParameters: AccountsBetaApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account details - * @param {AccountsBetaApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccount(requestParameters: AccountsBetaApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account entitlements - * @param {AccountsBetaApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccountEntitlements(requestParameters: AccountsBetaApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List accounts. - * @summary Accounts list - * @param {AccountsBetaApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listAccounts(requestParameters: AccountsBetaApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccounts(requestParameters.detailLevel, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsBetaApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putAccount(requestParameters: AccountsBetaApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putAccount(requestParameters.id, requestParameters.accountAttributesBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Reload account - * @param {AccountsBetaApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitReloadAccount(requestParameters: AccountsBetaApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Unlock account - * @param {AccountsBetaApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - unlockAccount(requestParameters: AccountsBetaApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsBetaApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccount(requestParameters: AccountsBetaApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiCreateAccountRequest - */ -export interface AccountsBetaApiCreateAccountRequest { - /** - * - * @type {AccountAttributesCreateBeta} - * @memberof AccountsBetaApiCreateAccount - */ - readonly accountAttributesCreateBeta: AccountAttributesCreateBeta -} - -/** - * Request parameters for deleteAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiDeleteAccountRequest - */ -export interface AccountsBetaApiDeleteAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsBetaApiDeleteAccount - */ - readonly id: string -} - -/** - * Request parameters for deleteAccountAsync operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiDeleteAccountAsyncRequest - */ -export interface AccountsBetaApiDeleteAccountAsyncRequest { - /** - * The account id - * @type {string} - * @memberof AccountsBetaApiDeleteAccountAsync - */ - readonly id: string -} - -/** - * Request parameters for disableAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiDisableAccountRequest - */ -export interface AccountsBetaApiDisableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsBetaApiDisableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestBeta} - * @memberof AccountsBetaApiDisableAccount - */ - readonly accountToggleRequestBeta: AccountToggleRequestBeta -} - -/** - * Request parameters for disableAccountForIdentity operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiDisableAccountForIdentityRequest - */ -export interface AccountsBetaApiDisableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsBetaApiDisableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for disableAccountsForIdentities operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiDisableAccountsForIdentitiesRequest - */ -export interface AccountsBetaApiDisableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestBeta} - * @memberof AccountsBetaApiDisableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta -} - -/** - * Request parameters for enableAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiEnableAccountRequest - */ -export interface AccountsBetaApiEnableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsBetaApiEnableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestBeta} - * @memberof AccountsBetaApiEnableAccount - */ - readonly accountToggleRequestBeta: AccountToggleRequestBeta -} - -/** - * Request parameters for enableAccountForIdentity operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiEnableAccountForIdentityRequest - */ -export interface AccountsBetaApiEnableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsBetaApiEnableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for enableAccountsForIdentities operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiEnableAccountsForIdentitiesRequest - */ -export interface AccountsBetaApiEnableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestBeta} - * @memberof AccountsBetaApiEnableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestBeta: IdentitiesAccountsBulkRequestBeta -} - -/** - * Request parameters for getAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiGetAccountRequest - */ -export interface AccountsBetaApiGetAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsBetaApiGetAccount - */ - readonly id: string -} - -/** - * Request parameters for getAccountEntitlements operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiGetAccountEntitlementsRequest - */ -export interface AccountsBetaApiGetAccountEntitlementsRequest { - /** - * The account id - * @type {string} - * @memberof AccountsBetaApiGetAccountEntitlements - */ - readonly id: string - - /** - * 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 AccountsBetaApiGetAccountEntitlements - */ - 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 AccountsBetaApiGetAccountEntitlements - */ - 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 AccountsBetaApiGetAccountEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccounts operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiListAccountsRequest - */ -export interface AccountsBetaApiListAccountsRequest { - /** - * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof AccountsBetaApiListAccounts - */ - readonly detailLevel?: ListAccountsDetailLevelBeta - - /** - * 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 AccountsBetaApiListAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsBetaApiListAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsBetaApiListAccounts - */ - 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* - * @type {string} - * @memberof AccountsBetaApiListAccounts - */ - 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** - * @type {string} - * @memberof AccountsBetaApiListAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for putAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiPutAccountRequest - */ -export interface AccountsBetaApiPutAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsBetaApiPutAccount - */ - readonly id: string - - /** - * - * @type {AccountAttributesBeta} - * @memberof AccountsBetaApiPutAccount - */ - readonly accountAttributesBeta: AccountAttributesBeta -} - -/** - * Request parameters for submitReloadAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiSubmitReloadAccountRequest - */ -export interface AccountsBetaApiSubmitReloadAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsBetaApiSubmitReloadAccount - */ - readonly id: string -} - -/** - * Request parameters for unlockAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiUnlockAccountRequest - */ -export interface AccountsBetaApiUnlockAccountRequest { - /** - * The account ID. - * @type {string} - * @memberof AccountsBetaApiUnlockAccount - */ - readonly id: string - - /** - * - * @type {AccountUnlockRequestBeta} - * @memberof AccountsBetaApiUnlockAccount - */ - readonly accountUnlockRequestBeta: AccountUnlockRequestBeta -} - -/** - * Request parameters for updateAccount operation in AccountsBetaApi. - * @export - * @interface AccountsBetaApiUpdateAccountRequest - */ -export interface AccountsBetaApiUpdateAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsBetaApiUpdateAccount - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AccountsBetaApiUpdateAccount - */ - readonly requestBody: Array -} - -/** - * AccountsBetaApi - object-oriented interface - * @export - * @class AccountsBetaApi - * @extends {BaseAPI} - */ -export class AccountsBetaApi extends BaseAPI { - /** - * Submits an account creation task - the API then returns the task ID. The `sourceId` where this account will be created must be included in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsBetaApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public createAccount(requestParameters: AccountsBetaApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).createAccount(requestParameters.accountAttributesCreateBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**NOTE:** You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsBetaApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public deleteAccount(requestParameters: AccountsBetaApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).deleteAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsBetaApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public deleteAccountAsync(requestParameters: AccountsBetaApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Disable account - * @param {AccountsBetaApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public disableAccount(requestParameters: AccountsBetaApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).disableAccount(requestParameters.id, requestParameters.accountToggleRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsBetaApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public disableAccountForIdentity(requestParameters: AccountsBetaApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsBetaApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public disableAccountsForIdentities(requestParameters: AccountsBetaApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Enable account - * @param {AccountsBetaApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public enableAccount(requestParameters: AccountsBetaApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).enableAccount(requestParameters.id, requestParameters.accountToggleRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsBetaApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public enableAccountForIdentity(requestParameters: AccountsBetaApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsBetaApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public enableAccountsForIdentities(requestParameters: AccountsBetaApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account details - * @param {AccountsBetaApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public getAccount(requestParameters: AccountsBetaApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).getAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Account entitlements - * @param {AccountsBetaApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public getAccountEntitlements(requestParameters: AccountsBetaApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).getAccountEntitlements(requestParameters.id, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List accounts. - * @summary Accounts list - * @param {AccountsBetaApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public listAccounts(requestParameters: AccountsBetaApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).listAccounts(requestParameters.detailLevel, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsBetaApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public putAccount(requestParameters: AccountsBetaApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).putAccount(requestParameters.id, requestParameters.accountAttributesBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Reload account - * @param {AccountsBetaApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public submitReloadAccount(requestParameters: AccountsBetaApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - * @summary Unlock account - * @param {AccountsBetaApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public unlockAccount(requestParameters: AccountsBetaApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsBetaApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccountsBetaApi - */ - public updateAccount(requestParameters: AccountsBetaApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsBetaApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListAccountsDetailLevelBeta = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type ListAccountsDetailLevelBeta = typeof ListAccountsDetailLevelBeta[keyof typeof ListAccountsDetailLevelBeta]; - - -/** - * ApplicationDiscoveryBetaApi - axios parameter creator - * @export - */ -export const ApplicationDiscoveryBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the discovered application, along with with its associated sources, based on the provided ID. - * @summary Get discovered application by id - * @param {string} id Discovered application\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplicationByID: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDiscoveredApplicationByID', 'id', id) - const localVarPath = `/discovered-applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Retrieve discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailBeta} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailBeta, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/discovered-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (filter !== undefined) { - localVarQueryParameter['filter'] = filter; - } - - 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, - }; - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/manual-discover-applications-template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** - * @summary Patch discovered application by id - * @param {string} id Discovered application\'s ID. - * @param {Array} [jsonPatchOperationsBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDiscoveredApplicationByID: async (id: string, jsonPatchOperationsBeta?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchDiscoveredApplicationByID', 'id', id) - const localVarPath = `/discovered-applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Upload a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'file' is not null or undefined - assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file) - const localVarPath = `/manual-discover-applications`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApplicationDiscoveryBetaApi - functional programming interface - * @export - */ -export const ApplicationDiscoveryBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApplicationDiscoveryBetaApiAxiosParamCreator(configuration) - return { - /** - * Get the discovered application, along with with its associated sources, based on the provided ID. - * @summary Get discovered application by id - * @param {string} id Discovered application\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplicationByID(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplicationByID(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryBetaApi.getDiscoveredApplicationByID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Retrieve discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailBeta} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplications(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailBeta, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, detail, filter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryBetaApi.getDiscoveredApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryBetaApi.getManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** - * @summary Patch discovered application by id - * @param {string} id Discovered application\'s ID. - * @param {Array} [jsonPatchOperationsBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDiscoveredApplicationByID(id: string, jsonPatchOperationsBeta?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDiscoveredApplicationByID(id, jsonPatchOperationsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryBetaApi.patchDiscoveredApplicationByID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Upload a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendManualDiscoverApplicationsCsvTemplate(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryBetaApi.sendManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApplicationDiscoveryBetaApi - factory interface - * @export - */ -export const ApplicationDiscoveryBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApplicationDiscoveryBetaApiFp(configuration) - return { - /** - * Get the discovered application, along with with its associated sources, based on the provided ID. - * @summary Get discovered application by id - * @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplicationByID(requestParameters: ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDiscoveredApplicationByID(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Retrieve discovered applications for tenant - * @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications(requestParameters: ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** - * @summary Patch discovered application by id - * @param {ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDiscoveredApplicationByID(requestParameters: ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDiscoveredApplicationByID(requestParameters.id, requestParameters.jsonPatchOperationsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Upload a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getDiscoveredApplicationByID operation in ApplicationDiscoveryBetaApi. - * @export - * @interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest - */ -export interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest { - /** - * Discovered application\'s ID. - * @type {string} - * @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplicationByID - */ - readonly id: string -} - -/** - * Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryBetaApi. - * @export - * @interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest - */ -export interface ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest { - /** - * 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 ApplicationDiscoveryBetaApiGetDiscoveredApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications - */ - readonly offset?: number - - /** - * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications - */ - readonly detail?: GetDiscoveredApplicationsDetailBeta - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @type {string} - * @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications - */ - readonly filter?: 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: **name, description, discoveredAt, discoverySource** - * @type {string} - * @memberof ApplicationDiscoveryBetaApiGetDiscoveredApplications - */ - readonly sorters?: string -} - -/** - * Request parameters for patchDiscoveredApplicationByID operation in ApplicationDiscoveryBetaApi. - * @export - * @interface ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest - */ -export interface ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest { - /** - * Discovered application\'s ID. - * @type {string} - * @memberof ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByID - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByID - */ - readonly jsonPatchOperationsBeta?: Array -} - -/** - * Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryBetaApi. - * @export - * @interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest - */ -export interface ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplate - */ - readonly file: File -} - -/** - * ApplicationDiscoveryBetaApi - object-oriented interface - * @export - * @class ApplicationDiscoveryBetaApi - * @extends {BaseAPI} - */ -export class ApplicationDiscoveryBetaApi extends BaseAPI { - /** - * Get the discovered application, along with with its associated sources, based on the provided ID. - * @summary Get discovered application by id - * @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryBetaApi - */ - public getDiscoveredApplicationByID(requestParameters: ApplicationDiscoveryBetaApiGetDiscoveredApplicationByIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryBetaApiFp(this.configuration).getDiscoveredApplicationByID(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Retrieve discovered applications for tenant - * @param {ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryBetaApi - */ - public getDiscoveredApplications(requestParameters: ApplicationDiscoveryBetaApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryBetaApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryBetaApi - */ - public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryBetaApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** - * @summary Patch discovered application by id - * @param {ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryBetaApi - */ - public patchDiscoveredApplicationByID(requestParameters: ApplicationDiscoveryBetaApiPatchDiscoveredApplicationByIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryBetaApiFp(this.configuration).patchDiscoveredApplicationByID(requestParameters.id, requestParameters.jsonPatchOperationsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Upload a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryBetaApi - */ - public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryBetaApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryBetaApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetDiscoveredApplicationsDetailBeta = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetDiscoveredApplicationsDetailBeta = typeof GetDiscoveredApplicationsDetailBeta[keyof typeof GetDiscoveredApplicationsDetailBeta]; - - -/** - * AppsBetaApi - axios parameter creator - * @export - */ -export const AppsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoBeta} sourceAppCreateDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp: async (sourceAppCreateDtoBeta: SourceAppCreateDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceAppCreateDtoBeta' is not null or undefined - assertParamExists('createSourceApp', 'sourceAppCreateDtoBeta', sourceAppCreateDtoBeta) - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppCreateDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk: async (id: string, requestBody: Array, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'requestBody', requestBody) - const localVarPath = `/source-apps/{id}/access-profiles/bulk-remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSourceApp', 'id', id) - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceApp', 'id', id) - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAccessProfilesForSourceApp', 'id', id) - const localVarPath = `/source-apps/{id}/access-profiles` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/source-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps: async (filters: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listAllUserApps', 'filters', filters) - const localVarPath = `/user-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/source-apps/assigned`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp: async (id: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAvailableAccountsForUserApp', 'id', id) - const localVarPath = `/user-apps/{id}/available-accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps: async (limit?: number, count?: boolean, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/user-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp: async (id: string, jsonPatchOperationBeta?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSourceApp', 'id', id) - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp: async (id: string, jsonPatchOperationBeta?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchUserApp', 'id', id) - const localVarPath = `/user-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {SourceAppBulkUpdateRequestBeta} [sourceAppBulkUpdateRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk: async (sourceAppBulkUpdateRequestBeta?: SourceAppBulkUpdateRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/source-apps/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppBulkUpdateRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AppsBetaApi - functional programming interface - * @export - */ -export const AppsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AppsBetaApiAxiosParamCreator(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoBeta} sourceAppCreateDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceApp(sourceAppCreateDtoBeta: SourceAppCreateDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceApp(sourceAppCreateDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.createSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesFromSourceAppByBulk(id: string, requestBody: Array, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesFromSourceAppByBulk(id, requestBody, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.deleteAccessProfilesFromSourceAppByBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceApp(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceApp(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.deleteSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceApp(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceApp(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.getSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesForSourceApp(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAccessProfilesForSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllSourceApp(limit, count, offset, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAllSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllUserApps(filters, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAllUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignedSourceApp(limit, count, offset, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAssignedSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAccountsForUserApp(id, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAvailableAccountsForUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableSourceApps(limit, count, offset, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listAvailableSourceApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnedUserApps(limit, count, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.listOwnedUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSourceApp(id: string, jsonPatchOperationBeta?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSourceApp(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.patchSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchUserApp(id: string, jsonPatchOperationBeta?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchUserApp(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.patchUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {SourceAppBulkUpdateRequestBeta} [sourceAppBulkUpdateRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceAppsInBulk(sourceAppBulkUpdateRequestBeta?: SourceAppBulkUpdateRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceAppsInBulk(sourceAppBulkUpdateRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsBetaApi.updateSourceAppsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AppsBetaApi - factory interface - * @export - */ -export const AppsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AppsBetaApiFp(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsBetaApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp(requestParameters: AppsBetaApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceApp(requestParameters.sourceAppCreateDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsBetaApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp(requestParameters: AppsBetaApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceApp(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsBetaApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp(requestParameters: AppsBetaApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceApp(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsBetaApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp(requestParameters: AppsBetaApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API. - * @summary List all source apps - * @param {AppsBetaApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp(requestParameters: AppsBetaApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsBetaApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps(requestParameters: AppsBetaApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsBetaApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp(requestParameters: AppsBetaApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsBetaApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp(requestParameters: AppsBetaApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsBetaApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps(requestParameters: AppsBetaApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsBetaApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps(requestParameters: AppsBetaApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsBetaApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp(requestParameters: AppsBetaApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSourceApp(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsBetaApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp(requestParameters: AppsBetaApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchUserApp(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsBetaApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk(requestParameters: AppsBetaApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceAppsInBulk(requestParameters.sourceAppBulkUpdateRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiCreateSourceAppRequest - */ -export interface AppsBetaApiCreateSourceAppRequest { - /** - * - * @type {SourceAppCreateDtoBeta} - * @memberof AppsBetaApiCreateSourceApp - */ - readonly sourceAppCreateDtoBeta: SourceAppCreateDtoBeta -} - -/** - * Request parameters for deleteAccessProfilesFromSourceAppByBulk operation in AppsBetaApi. - * @export - * @interface AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest - */ -export interface AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsBetaApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsBetaApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly requestBody: Array - - /** - * 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 AppsBetaApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly limit?: number -} - -/** - * Request parameters for deleteSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiDeleteSourceAppRequest - */ -export interface AppsBetaApiDeleteSourceAppRequest { - /** - * source app ID. - * @type {string} - * @memberof AppsBetaApiDeleteSourceApp - */ - readonly id: string -} - -/** - * Request parameters for getSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiGetSourceAppRequest - */ -export interface AppsBetaApiGetSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsBetaApiGetSourceApp - */ - readonly id: string -} - -/** - * Request parameters for listAccessProfilesForSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAccessProfilesForSourceAppRequest - */ -export interface AppsBetaApiListAccessProfilesForSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsBetaApiListAccessProfilesForSourceApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsBetaApiListAccessProfilesForSourceApp - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsBetaApiListAccessProfilesForSourceApp - */ - readonly offset?: number - - /** - * 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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof AppsBetaApiListAccessProfilesForSourceApp - */ - readonly filters?: string -} - -/** - * Request parameters for listAllSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAllSourceAppRequest - */ -export interface AppsBetaApiListAllSourceAppRequest { - /** - * 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 AppsBetaApiListAllSourceApp - */ - 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 AppsBetaApiListAllSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListAllSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsBetaApiListAllSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @type {string} - * @memberof AppsBetaApiListAllSourceApp - */ - readonly filters?: string -} - -/** - * Request parameters for listAllUserApps operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAllUserAppsRequest - */ -export interface AppsBetaApiListAllUserAppsRequest { - /** - * 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsBetaApiListAllUserApps - */ - readonly filters: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsBetaApiListAllUserApps - */ - 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 AppsBetaApiListAllUserApps - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListAllUserApps - */ - readonly offset?: number -} - -/** - * Request parameters for listAssignedSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAssignedSourceAppRequest - */ -export interface AppsBetaApiListAssignedSourceAppRequest { - /** - * 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 AppsBetaApiListAssignedSourceApp - */ - 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 AppsBetaApiListAssignedSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListAssignedSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, accountSource.id** - * @type {string} - * @memberof AppsBetaApiListAssignedSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsBetaApiListAssignedSourceApp - */ - readonly filters?: string -} - -/** - * Request parameters for listAvailableAccountsForUserApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAvailableAccountsForUserAppRequest - */ -export interface AppsBetaApiListAvailableAccountsForUserAppRequest { - /** - * ID of the user app - * @type {string} - * @memberof AppsBetaApiListAvailableAccountsForUserApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsBetaApiListAvailableAccountsForUserApp - */ - 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 AppsBetaApiListAvailableAccountsForUserApp - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListAvailableAccountsForUserApp - */ - readonly offset?: number -} - -/** - * Request parameters for listAvailableSourceApps operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListAvailableSourceAppsRequest - */ -export interface AppsBetaApiListAvailableSourceAppsRequest { - /** - * 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 AppsBetaApiListAvailableSourceApps - */ - 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 AppsBetaApiListAvailableSourceApps - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListAvailableSourceApps - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsBetaApiListAvailableSourceApps - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsBetaApiListAvailableSourceApps - */ - readonly filters?: string -} - -/** - * Request parameters for listOwnedUserApps operation in AppsBetaApi. - * @export - * @interface AppsBetaApiListOwnedUserAppsRequest - */ -export interface AppsBetaApiListOwnedUserAppsRequest { - /** - * 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 AppsBetaApiListOwnedUserApps - */ - 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 AppsBetaApiListOwnedUserApps - */ - readonly count?: boolean - - /** - * 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 AppsBetaApiListOwnedUserApps - */ - readonly offset?: number - - /** - * 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsBetaApiListOwnedUserApps - */ - readonly filters?: string -} - -/** - * Request parameters for patchSourceApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiPatchSourceAppRequest - */ -export interface AppsBetaApiPatchSourceAppRequest { - /** - * ID of the source app to patch - * @type {string} - * @memberof AppsBetaApiPatchSourceApp - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsBetaApiPatchSourceApp - */ - readonly jsonPatchOperationBeta?: Array -} - -/** - * Request parameters for patchUserApp operation in AppsBetaApi. - * @export - * @interface AppsBetaApiPatchUserAppRequest - */ -export interface AppsBetaApiPatchUserAppRequest { - /** - * ID of the user app to patch - * @type {string} - * @memberof AppsBetaApiPatchUserApp - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsBetaApiPatchUserApp - */ - readonly jsonPatchOperationBeta?: Array -} - -/** - * Request parameters for updateSourceAppsInBulk operation in AppsBetaApi. - * @export - * @interface AppsBetaApiUpdateSourceAppsInBulkRequest - */ -export interface AppsBetaApiUpdateSourceAppsInBulkRequest { - /** - * - * @type {SourceAppBulkUpdateRequestBeta} - * @memberof AppsBetaApiUpdateSourceAppsInBulk - */ - readonly sourceAppBulkUpdateRequestBeta?: SourceAppBulkUpdateRequestBeta -} - -/** - * AppsBetaApi - object-oriented interface - * @export - * @class AppsBetaApi - * @extends {BaseAPI} - */ -export class AppsBetaApi extends BaseAPI { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsBetaApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public createSourceApp(requestParameters: AppsBetaApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).createSourceApp(requestParameters.sourceAppCreateDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsBetaApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsBetaApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public deleteSourceApp(requestParameters: AppsBetaApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).deleteSourceApp(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsBetaApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public getSourceApp(requestParameters: AppsBetaApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).getSourceApp(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsBetaApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAccessProfilesForSourceApp(requestParameters: AppsBetaApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API. - * @summary List all source apps - * @param {AppsBetaApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAllSourceApp(requestParameters: AppsBetaApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsBetaApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAllUserApps(requestParameters: AppsBetaApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsBetaApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAssignedSourceApp(requestParameters: AppsBetaApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsBetaApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAvailableAccountsForUserApp(requestParameters: AppsBetaApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsBetaApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listAvailableSourceApps(requestParameters: AppsBetaApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsBetaApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public listOwnedUserApps(requestParameters: AppsBetaApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsBetaApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public patchSourceApp(requestParameters: AppsBetaApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).patchSourceApp(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsBetaApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public patchUserApp(requestParameters: AppsBetaApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).patchUserApp(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsBetaApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsBetaApi - */ - public updateSourceAppsInBulk(requestParameters: AppsBetaApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsBetaApiFp(this.configuration).updateSourceAppsInBulk(requestParameters.sourceAppBulkUpdateRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthProfileBetaApi - axios parameter creator - * @export - */ -export const AuthProfileBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns auth profile information. - * @summary Get auth profile. - * @param {string} id ID of the Auth Profile to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getProfileConfig', 'id', id) - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchProfileConfig', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchProfileConfig', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthProfileBetaApi - functional programming interface - * @export - */ -export const AuthProfileBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthProfileBetaApiAxiosParamCreator(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile. - * @param {string} id ID of the Auth Profile to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileBetaApi.getProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfigList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileBetaApi.getProfileConfigList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchProfileConfig(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchProfileConfig(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileBetaApi.patchProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthProfileBetaApi - factory interface - * @export - */ -export const AuthProfileBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthProfileBetaApiFp(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile. - * @param {AuthProfileBetaApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig(requestParameters: AuthProfileBetaApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProfileConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getProfileConfigList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileBetaApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig(requestParameters: AuthProfileBetaApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getProfileConfig operation in AuthProfileBetaApi. - * @export - * @interface AuthProfileBetaApiGetProfileConfigRequest - */ -export interface AuthProfileBetaApiGetProfileConfigRequest { - /** - * ID of the Auth Profile to get. - * @type {string} - * @memberof AuthProfileBetaApiGetProfileConfig - */ - readonly id: string -} - -/** - * Request parameters for patchProfileConfig operation in AuthProfileBetaApi. - * @export - * @interface AuthProfileBetaApiPatchProfileConfigRequest - */ -export interface AuthProfileBetaApiPatchProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileBetaApiPatchProfileConfig - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AuthProfileBetaApiPatchProfileConfig - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * AuthProfileBetaApi - object-oriented interface - * @export - * @class AuthProfileBetaApi - * @extends {BaseAPI} - */ -export class AuthProfileBetaApi extends BaseAPI { - /** - * This API returns auth profile information. - * @summary Get auth profile. - * @param {AuthProfileBetaApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileBetaApi - */ - public getProfileConfig(requestParameters: AuthProfileBetaApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileBetaApiFp(this.configuration).getProfileConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileBetaApi - */ - public getProfileConfigList(axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileBetaApiFp(this.configuration).getProfileConfigList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileBetaApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileBetaApi - */ - public patchProfileConfig(requestParameters: AuthProfileBetaApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileBetaApiFp(this.configuration).patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignsBetaApi - axios parameter creator - * @export - */ -export const CertificationCampaignsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - completeCampaign: async (id: string, completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(completeCampaignOptionsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create campaign - * @param {CampaignBeta} campaignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createCampaign: async (campaignBeta: CampaignBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignBeta' is not null or undefined - assertParamExists('createCampaign', 'campaignBeta', campaignBeta) - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create a campaign template - * @param {CampaignTemplateBeta} campaignTemplateBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createCampaignTemplate: async (campaignTemplateBeta: CampaignTemplateBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignTemplateBeta' is not null or undefined - assertParamExists('createCampaignTemplate', 'campaignTemplateBeta', campaignTemplateBeta) - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignTemplateBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaigns - * @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaigns: async (deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteCampaignsRequestBeta' is not null or undefined - assertParamExists('deleteCampaigns', 'deleteCampaignsRequestBeta', deleteCampaignsRequestBeta) - const localVarPath = `/campaigns/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteCampaignsRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary List campaigns - * @param {GetActiveCampaignsDetailBeta} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getActiveCampaigns: async (detail?: GetActiveCampaignsDetailBeta, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaign: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaign', 'id', id) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignReports: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignReports', 'id', id) - const localVarPath = `/campaigns/{id}/reports` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignReportsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns/reports-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v2025/get-campaign-templates). The endpoint returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplates: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignBeta} adminReviewReassignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - move: async (id: string, adminReviewReassignBeta: AdminReviewReassignBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('move', 'id', id) - // verify required parameter 'adminReviewReassignBeta' is not null or undefined - assertParamExists('move', 'adminReviewReassignBeta', adminReviewReassignBeta) - const localVarPath = `/campaigns/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(adminReviewReassignBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationBeta A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchCampaignTemplate: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchCampaignTemplate', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchCampaignTemplate', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setCampaignReportsConfig: async (campaignReportsConfigBeta: CampaignReportsConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignReportsConfigBeta' is not null or undefined - assertParamExists('setCampaignReportsConfig', 'campaignReportsConfigBeta', campaignReportsConfigBeta) - const localVarPath = `/campaigns/reports-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignReportsConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleBeta} [scheduleBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setCampaignTemplateSchedule: async (id: string, scheduleBeta?: ScheduleBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduleBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsBeta} [activateCampaignOptionsBeta] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaign: async (id: string, activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/activate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(activateCampaignOptionsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaignRemediationScan: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignRemediationScan', 'id', id) - const localVarPath = `/campaigns/{id}/run-remediation-scan` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeBeta} type Type of report to run. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaignReport: async (id: string, type: ReportTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignReport', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('startCampaignReport', 'type', type) - const localVarPath = `/campaigns/{id}/run-report/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startGenerateCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startGenerateCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{id}/generate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign - * @param {string} id ID of the campaign being modified. - * @param {Array} requestBody A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateCampaign: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateCampaign', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateCampaign', 'requestBody', requestBody) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignsBetaApi - functional programming interface - * @export - */ -export const CertificationCampaignsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignsBetaApiAxiosParamCreator(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CompleteCampaignOptionsBeta} [completeCampaignOptionsBeta] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async completeCampaign(id: string, completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaign(id, completeCampaignOptionsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.completeCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create campaign - * @param {CampaignBeta} campaignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createCampaign(campaignBeta: CampaignBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaign(campaignBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.createCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create a campaign template - * @param {CampaignTemplateBeta} campaignTemplateBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createCampaignTemplate(campaignTemplateBeta: CampaignTemplateBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplate(campaignTemplateBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.createCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.deleteCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.deleteCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaigns - * @param {DeleteCampaignsRequestBeta} deleteCampaignsRequestBeta IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteCampaigns(deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaigns(deleteCampaignsRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.deleteCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary List campaigns - * @param {GetActiveCampaignsDetailBeta} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getActiveCampaigns(detail?: GetActiveCampaignsDetailBeta, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getActiveCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaign(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaign(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaignReports(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReports(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaignReports']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v2025/get-campaign-templates). The endpoint returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.getCampaignTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignBeta} adminReviewReassignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async move(id: string, adminReviewReassignBeta: AdminReviewReassignBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.move(id, adminReviewReassignBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.move']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationBeta A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchCampaignTemplate(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplate(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.patchCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigBeta} campaignReportsConfigBeta Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setCampaignReportsConfig(campaignReportsConfigBeta: CampaignReportsConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfig(campaignReportsConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.setCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleBeta} [scheduleBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setCampaignTemplateSchedule(id: string, scheduleBeta?: ScheduleBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateSchedule(id, scheduleBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.setCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsBeta} [activateCampaignOptionsBeta] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startCampaign(id: string, activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaign(id, activateCampaignOptionsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.startCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startCampaignRemediationScan(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScan(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.startCampaignRemediationScan']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeBeta} type Type of report to run. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startCampaignReport(id: string, type: ReportTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReport(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.startCampaignReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startGenerateCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.startGenerateCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign - * @param {string} id ID of the campaign being modified. - * @param {Array} requestBody A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateCampaign(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaign(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsBetaApi.updateCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignsBetaApi - factory interface - * @export - */ -export const CertificationCampaignsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignsBetaApiFp(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Complete a campaign - * @param {CertificationCampaignsBetaApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - completeCampaign(requestParameters: CertificationCampaignsBetaApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeCampaign(requestParameters.id, requestParameters.completeCampaignOptionsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create campaign - * @param {CertificationCampaignsBetaApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createCampaign(requestParameters: CertificationCampaignsBetaApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaign(requestParameters.campaignBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create a campaign template - * @param {CertificationCampaignsBetaApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createCampaignTemplate(requestParameters: CertificationCampaignsBetaApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignTemplate(requestParameters.campaignTemplateBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete a campaign template - * @param {CertificationCampaignsBetaApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaignTemplate(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaigns - * @param {CertificationCampaignsBetaApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteCampaigns(requestParameters: CertificationCampaignsBetaApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaigns(requestParameters.deleteCampaignsRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary List campaigns - * @param {CertificationCampaignsBetaApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getActiveCampaigns(requestParameters: CertificationCampaignsBetaApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign - * @param {CertificationCampaignsBetaApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaign(requestParameters: CertificationCampaignsBetaApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaign(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Get campaign reports - * @param {CertificationCampaignsBetaApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignReports(requestParameters: CertificationCampaignsBetaApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get a campaign template - * @param {CertificationCampaignsBetaApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplate(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign template schedule - * @param {CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v2025/get-campaign-templates). The endpoint returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary List campaign templates - * @param {CertificationCampaignsBetaApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCampaignTemplates(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Reassign certifications - * @param {CertificationCampaignsBetaApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - move(requestParameters: CertificationCampaignsBetaApiMoveRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.move(requestParameters.id, requestParameters.adminReviewReassignBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign template - * @param {CertificationCampaignsBetaApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchCampaignTemplate(requestParameters: CertificationCampaignsBetaApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsBetaApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setCampaignReportsConfig(requestParameters: CertificationCampaignsBetaApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignReportsConfig(requestParameters.campaignReportsConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign template schedule - * @param {CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Activate a campaign - * @param {CertificationCampaignsBetaApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaign(requestParameters: CertificationCampaignsBetaApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsBetaApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaignRemediationScan(requestParameters: CertificationCampaignsBetaApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign report - * @param {CertificationCampaignsBetaApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startCampaignReport(requestParameters: CertificationCampaignsBetaApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Generate a campaign from template - * @param {CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startGenerateCampaignTemplate(requestParameters: CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign - * @param {CertificationCampaignsBetaApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateCampaign(requestParameters: CertificationCampaignsBetaApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaign(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeCampaign operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiCompleteCampaignRequest - */ -export interface CertificationCampaignsBetaApiCompleteCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsBetaApiCompleteCampaign - */ - readonly id: string - - /** - * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @type {CompleteCampaignOptionsBeta} - * @memberof CertificationCampaignsBetaApiCompleteCampaign - */ - readonly completeCampaignOptionsBeta?: CompleteCampaignOptionsBeta -} - -/** - * Request parameters for createCampaign operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiCreateCampaignRequest - */ -export interface CertificationCampaignsBetaApiCreateCampaignRequest { - /** - * - * @type {CampaignBeta} - * @memberof CertificationCampaignsBetaApiCreateCampaign - */ - readonly campaignBeta: CampaignBeta -} - -/** - * Request parameters for createCampaignTemplate operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiCreateCampaignTemplateRequest - */ -export interface CertificationCampaignsBetaApiCreateCampaignTemplateRequest { - /** - * - * @type {CampaignTemplateBeta} - * @memberof CertificationCampaignsBetaApiCreateCampaignTemplate - */ - readonly campaignTemplateBeta: CampaignTemplateBeta -} - -/** - * Request parameters for deleteCampaignTemplate operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiDeleteCampaignTemplateRequest - */ -export interface CertificationCampaignsBetaApiDeleteCampaignTemplateRequest { - /** - * ID of the campaign template being deleted. - * @type {string} - * @memberof CertificationCampaignsBetaApiDeleteCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaignTemplateSchedule operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being deleted. - * @type {string} - * @memberof CertificationCampaignsBetaApiDeleteCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaigns operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiDeleteCampaignsRequest - */ -export interface CertificationCampaignsBetaApiDeleteCampaignsRequest { - /** - * IDs of the campaigns to delete. - * @type {DeleteCampaignsRequestBeta} - * @memberof CertificationCampaignsBetaApiDeleteCampaigns - */ - readonly deleteCampaignsRequestBeta: DeleteCampaignsRequestBeta -} - -/** - * Request parameters for getActiveCampaigns operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetActiveCampaignsRequest - */ -export interface CertificationCampaignsBetaApiGetActiveCampaignsRequest { - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsBetaApiGetActiveCampaigns - */ - readonly detail?: GetActiveCampaignsDetailBeta - - /** - * 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 CertificationCampaignsBetaApiGetActiveCampaigns - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsBetaApiGetActiveCampaigns - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsBetaApiGetActiveCampaigns - */ - 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, in* **name**: *eq, sw* **status**: *eq, in* - * @type {string} - * @memberof CertificationCampaignsBetaApiGetActiveCampaigns - */ - 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: **name, created** - * @type {string} - * @memberof CertificationCampaignsBetaApiGetActiveCampaigns - */ - readonly sorters?: string -} - -/** - * Request parameters for getCampaign operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetCampaignRequest - */ -export interface CertificationCampaignsBetaApiGetCampaignRequest { - /** - * ID of the campaign to be retrieved. - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaign - */ - readonly id: string -} - -/** - * Request parameters for getCampaignReports operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetCampaignReportsRequest - */ -export interface CertificationCampaignsBetaApiGetCampaignReportsRequest { - /** - * ID of the campaign whose reports are being fetched. - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaignReports - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplate operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetCampaignTemplateRequest - */ -export interface CertificationCampaignsBetaApiGetCampaignTemplateRequest { - /** - * Requested campaign template\'s ID. - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplateSchedule operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being fetched. - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplates operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiGetCampaignTemplatesRequest - */ -export interface CertificationCampaignsBetaApiGetCampaignTemplatesRequest { - /** - * 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 CertificationCampaignsBetaApiGetCampaignTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplates - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplates - */ - readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof CertificationCampaignsBetaApiGetCampaignTemplates - */ - readonly filters?: string -} - -/** - * Request parameters for move operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiMoveRequest - */ -export interface CertificationCampaignsBetaApiMoveRequest { - /** - * The certification campaign ID - * @type {string} - * @memberof CertificationCampaignsBetaApiMove - */ - readonly id: string - - /** - * - * @type {AdminReviewReassignBeta} - * @memberof CertificationCampaignsBetaApiMove - */ - readonly adminReviewReassignBeta: AdminReviewReassignBeta -} - -/** - * Request parameters for patchCampaignTemplate operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiPatchCampaignTemplateRequest - */ -export interface CertificationCampaignsBetaApiPatchCampaignTemplateRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsBetaApiPatchCampaignTemplate - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @type {Array} - * @memberof CertificationCampaignsBetaApiPatchCampaignTemplate - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for setCampaignReportsConfig operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiSetCampaignReportsConfigRequest - */ -export interface CertificationCampaignsBetaApiSetCampaignReportsConfigRequest { - /** - * Campaign report configuration. - * @type {CampaignReportsConfigBeta} - * @memberof CertificationCampaignsBetaApiSetCampaignReportsConfig - */ - readonly campaignReportsConfigBeta: CampaignReportsConfigBeta -} - -/** - * Request parameters for setCampaignTemplateSchedule operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template being scheduled. - * @type {string} - * @memberof CertificationCampaignsBetaApiSetCampaignTemplateSchedule - */ - readonly id: string - - /** - * - * @type {ScheduleBeta} - * @memberof CertificationCampaignsBetaApiSetCampaignTemplateSchedule - */ - readonly scheduleBeta?: ScheduleBeta -} - -/** - * Request parameters for startCampaign operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiStartCampaignRequest - */ -export interface CertificationCampaignsBetaApiStartCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsBetaApiStartCampaign - */ - readonly id: string - - /** - * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @type {ActivateCampaignOptionsBeta} - * @memberof CertificationCampaignsBetaApiStartCampaign - */ - readonly activateCampaignOptionsBeta?: ActivateCampaignOptionsBeta -} - -/** - * Request parameters for startCampaignRemediationScan operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiStartCampaignRemediationScanRequest - */ -export interface CertificationCampaignsBetaApiStartCampaignRemediationScanRequest { - /** - * ID of the campaign the remediation scan is being run for. - * @type {string} - * @memberof CertificationCampaignsBetaApiStartCampaignRemediationScan - */ - readonly id: string -} - -/** - * Request parameters for startCampaignReport operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiStartCampaignReportRequest - */ -export interface CertificationCampaignsBetaApiStartCampaignReportRequest { - /** - * ID of the campaign the report is being run for. - * @type {string} - * @memberof CertificationCampaignsBetaApiStartCampaignReport - */ - readonly id: string - - /** - * Type of report to run. - * @type {ReportTypeBeta} - * @memberof CertificationCampaignsBetaApiStartCampaignReport - */ - readonly type: ReportTypeBeta -} - -/** - * Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest - */ -export interface CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest { - /** - * ID of the campaign template to use for generation. - * @type {string} - * @memberof CertificationCampaignsBetaApiStartGenerateCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for updateCampaign operation in CertificationCampaignsBetaApi. - * @export - * @interface CertificationCampaignsBetaApiUpdateCampaignRequest - */ -export interface CertificationCampaignsBetaApiUpdateCampaignRequest { - /** - * ID of the campaign being modified. - * @type {string} - * @memberof CertificationCampaignsBetaApiUpdateCampaign - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @type {Array} - * @memberof CertificationCampaignsBetaApiUpdateCampaign - */ - readonly requestBody: Array -} - -/** - * CertificationCampaignsBetaApi - object-oriented interface - * @export - * @class CertificationCampaignsBetaApi - * @extends {BaseAPI} - */ -export class CertificationCampaignsBetaApi extends BaseAPI { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Complete a campaign - * @param {CertificationCampaignsBetaApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public completeCampaign(requestParameters: CertificationCampaignsBetaApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).completeCampaign(requestParameters.id, requestParameters.completeCampaignOptionsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create campaign - * @param {CertificationCampaignsBetaApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public createCampaign(requestParameters: CertificationCampaignsBetaApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).createCampaign(requestParameters.campaignBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Create a campaign template - * @param {CertificationCampaignsBetaApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public createCampaignTemplate(requestParameters: CertificationCampaignsBetaApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).createCampaignTemplate(requestParameters.campaignTemplateBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete a campaign template - * @param {CertificationCampaignsBetaApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public deleteCampaignTemplate(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Delete campaigns - * @param {CertificationCampaignsBetaApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public deleteCampaigns(requestParameters: CertificationCampaignsBetaApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).deleteCampaigns(requestParameters.deleteCampaignsRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary List campaigns - * @param {CertificationCampaignsBetaApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getActiveCampaigns(requestParameters: CertificationCampaignsBetaApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign - * @param {CertificationCampaignsBetaApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaign(requestParameters: CertificationCampaignsBetaApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaign(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Get campaign reports - * @param {CertificationCampaignsBetaApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaignReports(requestParameters: CertificationCampaignsBetaApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaignReportsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get a campaign template - * @param {CertificationCampaignsBetaApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaignTemplate(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Get campaign template schedule - * @param {CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v2025/get-campaign-templates). The endpoint returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary List campaign templates - * @param {CertificationCampaignsBetaApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public getCampaignTemplates(requestParameters: CertificationCampaignsBetaApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Reassign certifications - * @param {CertificationCampaignsBetaApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public move(requestParameters: CertificationCampaignsBetaApiMoveRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).move(requestParameters.id, requestParameters.adminReviewReassignBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign template - * @param {CertificationCampaignsBetaApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public patchCampaignTemplate(requestParameters: CertificationCampaignsBetaApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsBetaApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public setCampaignReportsConfig(requestParameters: CertificationCampaignsBetaApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).setCampaignReportsConfig(requestParameters.campaignReportsConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Set campaign template schedule - * @param {CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public setCampaignTemplateSchedule(requestParameters: CertificationCampaignsBetaApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Activate a campaign - * @param {CertificationCampaignsBetaApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public startCampaign(requestParameters: CertificationCampaignsBetaApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsBetaApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public startCampaignRemediationScan(requestParameters: CertificationCampaignsBetaApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - * @summary Run campaign report - * @param {CertificationCampaignsBetaApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public startCampaignReport(requestParameters: CertificationCampaignsBetaApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Generate a campaign from template - * @param {CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public startGenerateCampaignTemplate(requestParameters: CertificationCampaignsBetaApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - * @summary Update a campaign - * @param {CertificationCampaignsBetaApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationCampaignsBetaApi - */ - public updateCampaign(requestParameters: CertificationCampaignsBetaApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsBetaApiFp(this.configuration).updateCampaign(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetActiveCampaignsDetailBeta = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetActiveCampaignsDetailBeta = typeof GetActiveCampaignsDetailBeta[keyof typeof GetActiveCampaignsDetailBeta]; - - -/** - * CertificationsBetaApi - axios parameter creator - * @export - */ -export const CertificationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'certificationId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'certificationId', certificationId) - // verify required parameter 'itemId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'itemId', itemId) - const localVarPath = `/certifications/{certificationId}/access-review-items/{itemId}/permissions` - .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) - .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Pending certification tasks - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationPendingTasks: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertificationPendingTasks', 'id', id) - const localVarPath = `/certifications/{id}/tasks-pending` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Certification task status - * @param {string} id The identity campaign certification ID - * @param {string} taskId The certification task ID - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationTaskStatus: async (id: string, taskId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertificationTaskStatus', 'id', id) - // verify required parameter 'taskId' is not null or undefined - assertParamExists('getIdentityCertificationTaskStatus', 'taskId', taskId) - const localVarPath = `/certifications/{id}/tasks/{taskId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"taskId"}}`, encodeURIComponent(String(taskId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listCertificationReviewers: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listCertificationReviewers', 'id', id) - const localVarPath = `/certifications/{id}/reviewers` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary Certifications by ids - * @param {string} [reviewerIdentitiy] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listCertifications: async (reviewerIdentitiy?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certifications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (reviewerIdentitiy !== undefined) { - localVarQueryParameter['reviewer-identitiy'] = reviewerIdentitiy; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignBeta} reviewReassignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitReassignCertsAsync: async (id: string, reviewReassignBeta: ReviewReassignBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'id', id) - // verify required parameter 'reviewReassignBeta' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'reviewReassignBeta', reviewReassignBeta) - const localVarPath = `/certifications/{id}/reassign-async` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationsBetaApi - functional programming interface - * @export - */ -export const CertificationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissions(certificationId, itemId, filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.getIdentityCertificationItemPermissions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Pending certification tasks - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getIdentityCertificationPendingTasks(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationPendingTasks(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.getIdentityCertificationPendingTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Certification task status - * @param {string} id The identity campaign certification ID - * @param {string} taskId The certification task ID - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getIdentityCertificationTaskStatus(id: string, taskId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationTaskStatus(id, taskId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.getIdentityCertificationTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewers(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.listCertificationReviewers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary Certifications by ids - * @param {string} [reviewerIdentitiy] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listCertifications(reviewerIdentitiy?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertifications(reviewerIdentitiy, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.listCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignBeta} reviewReassignBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async submitReassignCertsAsync(id: string, reviewReassignBeta: ReviewReassignBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsync(id, reviewReassignBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsBetaApi.submitReassignCertsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationsBetaApi - factory interface - * @export - */ -export const CertificationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationsBetaApiFp(configuration) - return { - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions(requestParameters: CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Pending certification tasks - * @param {CertificationsBetaApiGetIdentityCertificationPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationPendingTasks(requestParameters: CertificationsBetaApiGetIdentityCertificationPendingTasksRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationPendingTasks(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Certification task status - * @param {CertificationsBetaApiGetIdentityCertificationTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getIdentityCertificationTaskStatus(requestParameters: CertificationsBetaApiGetIdentityCertificationTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityCertificationTaskStatus(requestParameters.id, requestParameters.taskId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsBetaApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listCertificationReviewers(requestParameters: CertificationsBetaApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary Certifications by ids - * @param {CertificationsBetaApiListCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listCertifications(requestParameters: CertificationsBetaApiListCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertifications(requestParameters.reviewerIdentitiy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsBetaApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitReassignCertsAsync(requestParameters: CertificationsBetaApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getIdentityCertificationItemPermissions operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest - */ -export interface CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly certificationId: string - - /** - * The certification item ID - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsBetaApiGetIdentityCertificationItemPermissions - */ - readonly count?: boolean -} - -/** - * Request parameters for getIdentityCertificationPendingTasks operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiGetIdentityCertificationPendingTasksRequest - */ -export interface CertificationsBetaApiGetIdentityCertificationPendingTasksRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationPendingTasks - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertificationTaskStatus operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiGetIdentityCertificationTaskStatusRequest - */ -export interface CertificationsBetaApiGetIdentityCertificationTaskStatusRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationTaskStatus - */ - readonly id: string - - /** - * The certification task ID - * @type {string} - * @memberof CertificationsBetaApiGetIdentityCertificationTaskStatus - */ - readonly taskId: string -} - -/** - * Request parameters for listCertificationReviewers operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiListCertificationReviewersRequest - */ -export interface CertificationsBetaApiListCertificationReviewersRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - 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, in* **name**: *eq, sw* **email**: *eq, sw* - * @type {string} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - 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: **name, email** - * @type {string} - * @memberof CertificationsBetaApiListCertificationReviewers - */ - readonly sorters?: string -} - -/** - * Request parameters for listCertifications operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiListCertificationsRequest - */ -export interface CertificationsBetaApiListCertificationsRequest { - /** - * The ID of reviewer identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsBetaApiListCertifications - */ - readonly reviewerIdentitiy?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiListCertifications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsBetaApiListCertifications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsBetaApiListCertifications - */ - 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, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* - * @type {string} - * @memberof CertificationsBetaApiListCertifications - */ - 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: **name, due, signed** - * @type {string} - * @memberof CertificationsBetaApiListCertifications - */ - readonly sorters?: string -} - -/** - * Request parameters for submitReassignCertsAsync operation in CertificationsBetaApi. - * @export - * @interface CertificationsBetaApiSubmitReassignCertsAsyncRequest - */ -export interface CertificationsBetaApiSubmitReassignCertsAsyncRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsBetaApiSubmitReassignCertsAsync - */ - readonly id: string - - /** - * - * @type {ReviewReassignBeta} - * @memberof CertificationsBetaApiSubmitReassignCertsAsync - */ - readonly reviewReassignBeta: ReviewReassignBeta -} - -/** - * CertificationsBetaApi - object-oriented interface - * @export - * @class CertificationsBetaApi - * @extends {BaseAPI} - */ -export class CertificationsBetaApi extends BaseAPI { - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public getIdentityCertificationItemPermissions(requestParameters: CertificationsBetaApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Pending certification tasks - * @param {CertificationsBetaApiGetIdentityCertificationPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public getIdentityCertificationPendingTasks(requestParameters: CertificationsBetaApiGetIdentityCertificationPendingTasksRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).getIdentityCertificationPendingTasks(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Certification task status - * @param {CertificationsBetaApiGetIdentityCertificationTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public getIdentityCertificationTaskStatus(requestParameters: CertificationsBetaApiGetIdentityCertificationTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).getIdentityCertificationTaskStatus(requestParameters.id, requestParameters.taskId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsBetaApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public listCertificationReviewers(requestParameters: CertificationsBetaApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary Certifications by ids - * @param {CertificationsBetaApiListCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public listCertifications(requestParameters: CertificationsBetaApiListCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).listCertifications(requestParameters.reviewerIdentitiy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsBetaApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof CertificationsBetaApi - */ - public submitReassignCertsAsync(requestParameters: CertificationsBetaApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsBetaApiFp(this.configuration).submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorRuleManagementBetaApi - axios parameter creator - * @export - */ -export const ConnectorRuleManagementBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestBeta} connectorRuleCreateRequestBeta The connector rule to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule: async (connectorRuleCreateRequestBeta: ConnectorRuleCreateRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorRuleCreateRequestBeta' is not null or undefined - assertParamExists('createConnectorRule', 'connectorRuleCreateRequestBeta', connectorRuleCreateRequestBeta) - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleCreateRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete a connector-rule - * @param {string} id ID of the connector rule to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Connector-rule by id - * @param {string} id ID of the connector rule to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. - * @summary List connector rules - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing connector rule with the one provided in the request body. Note that the fields \'id\', \'name\', and \'type\' are immutable. A token with ORG_ADMIN authority is required to call this API. - * @summary Update a connector rule - * @param {string} id ID of the connector rule to update - * @param {ConnectorRuleUpdateRequestBeta} [connectorRuleUpdateRequestBeta] The connector rule with updated data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnectorRule: async (id: string, connectorRuleUpdateRequestBeta?: ConnectorRuleUpdateRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleUpdateRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. - * @summary Validate connector rule - * @param {SourceCodeBeta} sourceCodeBeta The code to validate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - validateConnectorRule: async (sourceCodeBeta: SourceCodeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceCodeBeta' is not null or undefined - assertParamExists('validateConnectorRule', 'sourceCodeBeta', sourceCodeBeta) - const localVarPath = `/connector-rules/validate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceCodeBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorRuleManagementBetaApi - functional programming interface - * @export - */ -export const ConnectorRuleManagementBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorRuleManagementBetaApiAxiosParamCreator(configuration) - return { - /** - * Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestBeta} connectorRuleCreateRequestBeta The connector rule to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorRule(connectorRuleCreateRequestBeta: ConnectorRuleCreateRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRule(connectorRuleCreateRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.createConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete a connector-rule - * @param {string} id ID of the connector rule to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.deleteConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Connector-rule by id - * @param {string} id ID of the connector rule to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.getConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. - * @summary List connector rules - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRuleList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.getConnectorRuleList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing connector rule with the one provided in the request body. Note that the fields \'id\', \'name\', and \'type\' are immutable. A token with ORG_ADMIN authority is required to call this API. - * @summary Update a connector rule - * @param {string} id ID of the connector rule to update - * @param {ConnectorRuleUpdateRequestBeta} [connectorRuleUpdateRequestBeta] The connector rule with updated data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateConnectorRule(id: string, connectorRuleUpdateRequestBeta?: ConnectorRuleUpdateRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnectorRule(id, connectorRuleUpdateRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.updateConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. - * @summary Validate connector rule - * @param {SourceCodeBeta} sourceCodeBeta The code to validate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async validateConnectorRule(sourceCodeBeta: SourceCodeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateConnectorRule(sourceCodeBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementBetaApi.validateConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorRuleManagementBetaApi - factory interface - * @export - */ -export const ConnectorRuleManagementBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorRuleManagementBetaApiFp(configuration) - return { - /** - * Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. - * @summary Create connector rule - * @param {ConnectorRuleManagementBetaApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule(requestParameters: ConnectorRuleManagementBetaApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorRule(requestParameters.connectorRuleCreateRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete a connector-rule - * @param {ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule(requestParameters: ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Connector-rule by id - * @param {ConnectorRuleManagementBetaApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule(requestParameters: ConnectorRuleManagementBetaApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. - * @summary List connector rules - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorRuleList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing connector rule with the one provided in the request body. Note that the fields \'id\', \'name\', and \'type\' are immutable. A token with ORG_ADMIN authority is required to call this API. - * @summary Update a connector rule - * @param {ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnectorRule(requestParameters: ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. - * @summary Validate connector rule - * @param {ConnectorRuleManagementBetaApiValidateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - validateConnectorRule(requestParameters: ConnectorRuleManagementBetaApiValidateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateConnectorRule(requestParameters.sourceCodeBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorRule operation in ConnectorRuleManagementBetaApi. - * @export - * @interface ConnectorRuleManagementBetaApiCreateConnectorRuleRequest - */ -export interface ConnectorRuleManagementBetaApiCreateConnectorRuleRequest { - /** - * The connector rule to create - * @type {ConnectorRuleCreateRequestBeta} - * @memberof ConnectorRuleManagementBetaApiCreateConnectorRule - */ - readonly connectorRuleCreateRequestBeta: ConnectorRuleCreateRequestBeta -} - -/** - * Request parameters for deleteConnectorRule operation in ConnectorRuleManagementBetaApi. - * @export - * @interface ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest - */ -export interface ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest { - /** - * ID of the connector rule to delete - * @type {string} - * @memberof ConnectorRuleManagementBetaApiDeleteConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRule operation in ConnectorRuleManagementBetaApi. - * @export - * @interface ConnectorRuleManagementBetaApiGetConnectorRuleRequest - */ -export interface ConnectorRuleManagementBetaApiGetConnectorRuleRequest { - /** - * ID of the connector rule to retrieve - * @type {string} - * @memberof ConnectorRuleManagementBetaApiGetConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for updateConnectorRule operation in ConnectorRuleManagementBetaApi. - * @export - * @interface ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest - */ -export interface ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest { - /** - * ID of the connector rule to update - * @type {string} - * @memberof ConnectorRuleManagementBetaApiUpdateConnectorRule - */ - readonly id: string - - /** - * The connector rule with updated data - * @type {ConnectorRuleUpdateRequestBeta} - * @memberof ConnectorRuleManagementBetaApiUpdateConnectorRule - */ - readonly connectorRuleUpdateRequestBeta?: ConnectorRuleUpdateRequestBeta -} - -/** - * Request parameters for validateConnectorRule operation in ConnectorRuleManagementBetaApi. - * @export - * @interface ConnectorRuleManagementBetaApiValidateConnectorRuleRequest - */ -export interface ConnectorRuleManagementBetaApiValidateConnectorRuleRequest { - /** - * The code to validate - * @type {SourceCodeBeta} - * @memberof ConnectorRuleManagementBetaApiValidateConnectorRule - */ - readonly sourceCodeBeta: SourceCodeBeta -} - -/** - * ConnectorRuleManagementBetaApi - object-oriented interface - * @export - * @class ConnectorRuleManagementBetaApi - * @extends {BaseAPI} - */ -export class ConnectorRuleManagementBetaApi extends BaseAPI { - /** - * Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. - * @summary Create connector rule - * @param {ConnectorRuleManagementBetaApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public createConnectorRule(requestParameters: ConnectorRuleManagementBetaApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).createConnectorRule(requestParameters.connectorRuleCreateRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete a connector-rule - * @param {ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public deleteConnectorRule(requestParameters: ConnectorRuleManagementBetaApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Connector-rule by id - * @param {ConnectorRuleManagementBetaApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public getConnectorRule(requestParameters: ConnectorRuleManagementBetaApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. - * @summary List connector rules - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public getConnectorRuleList(axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).getConnectorRuleList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing connector rule with the one provided in the request body. Note that the fields \'id\', \'name\', and \'type\' are immutable. A token with ORG_ADMIN authority is required to call this API. - * @summary Update a connector rule - * @param {ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public updateConnectorRule(requestParameters: ConnectorRuleManagementBetaApiUpdateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).updateConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. - * @summary Validate connector rule - * @param {ConnectorRuleManagementBetaApiValidateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementBetaApi - */ - public validateConnectorRule(requestParameters: ConnectorRuleManagementBetaApiValidateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementBetaApiFp(this.configuration).validateConnectorRule(requestParameters.sourceCodeBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorsBetaApi - axios parameter creator - * @export - */ -export const ConnectorsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleBeta} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorsBetaApi - functional programming interface - * @export - */ -export const ConnectorsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorsBetaApiAxiosParamCreator(configuration) - return { - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleBeta} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorList(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorList(filters, limit, offset, count, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsBetaApi.getConnectorList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorsBetaApi - factory interface - * @export - */ -export const ConnectorsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorsBetaApiFp(configuration) - return { - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsBetaApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList(requestParameters: ConnectorsBetaApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getConnectorList operation in ConnectorsBetaApi. - * @export - * @interface ConnectorsBetaApiGetConnectorListRequest - */ -export interface ConnectorsBetaApiGetConnectorListRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* - * @type {string} - * @memberof ConnectorsBetaApiGetConnectorList - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsBetaApiGetConnectorList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsBetaApiGetConnectorList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorsBetaApiGetConnectorList - */ - readonly count?: boolean - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsBetaApiGetConnectorList - */ - readonly locale?: GetConnectorListLocaleBeta -} - -/** - * ConnectorsBetaApi - object-oriented interface - * @export - * @class ConnectorsBetaApi - * @extends {BaseAPI} - */ -export class ConnectorsBetaApi extends BaseAPI { - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsBetaApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsBetaApi - */ - public getConnectorList(requestParameters: ConnectorsBetaApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsBetaApiFp(this.configuration).getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetConnectorListLocaleBeta = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorListLocaleBeta = typeof GetConnectorListLocaleBeta[keyof typeof GetConnectorListLocaleBeta]; - - -/** - * CustomFormsBetaApi - axios parameter creator - * @export - */ -export const CustomFormsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition: async (createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createFormDefinitionRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Create a form definition by template. - * @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionByTemplate: async (createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createFormDefinitionRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestBeta} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema: async (body?: FormDefinitionDynamicSchemaRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/forms-action-dynamic-schema`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest: async (formDefinitionID: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'formDefinitionID', formDefinitionID) - // verify required parameter 'file' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'file', file) - const localVarPath = `/form-definitions/{formDefinitionID}/upload` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestBeta} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance: async (body?: CreateFormInstanceRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('deleteFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3: async (formDefinitionID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFileFromS3', 'formDefinitionID', formDefinitionID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFileFromS3', 'fileID', fileID) - const localVarPath = `/form-definitions/{formDefinitionID}/file/{fileID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFormDefinitionByKey', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey: async (formInstanceID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceByKey', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile: async (formInstanceID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceFile', 'formInstanceID', formInstanceID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFormInstanceFile', 'fileID', fileID) - const localVarPath = `/form-instances/{formInstanceID}/file/{fileID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions: async (body?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition: async (formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('patchFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance: async (formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('patchFormInstance', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID: async (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formInstanceID', formInstanceID) - // verify required parameter 'formElementID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formElementID', formElementID) - const localVarPath = `/form-instances/{formInstanceID}/data-source/{formElementID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"formElementID"}}`, encodeURIComponent(String(formElementID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/predefined-select-options`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestBeta} [formElementPreviewRequestBeta] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource: async (formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestBeta?: FormElementPreviewRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('showPreviewDataSource', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}/data-source` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(formElementPreviewRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomFormsBetaApi - functional programming interface - * @export - */ -export const CustomFormsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomFormsBetaApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinition(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinition(createFormDefinitionRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.createFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Create a form definition by template. - * @param {CreateFormDefinitionRequestBeta} [createFormDefinitionRequestBeta] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionByTemplate(createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionByTemplate(createFormDefinitionRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.createFormDefinitionByTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestBeta} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionDynamicSchema(body?: FormDefinitionDynamicSchemaRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionDynamicSchema(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.createFormDefinitionDynamicSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionFileRequest(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionFileRequest(formDefinitionID, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.createFormDefinitionFileRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestBeta} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormInstance(body?: CreateFormInstanceRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormInstance(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.createFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteFormDefinition(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFormDefinition(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.deleteFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.exportFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFileFromS3(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFileFromS3(formDefinitionID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.getFileFromS3']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormDefinitionByKey(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormDefinitionByKey(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.getFormDefinitionByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceByKey(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceByKey(formInstanceID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.getFormInstanceByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceFile(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceFile(formInstanceID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.getFormInstanceFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importFormDefinitions(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importFormDefinitions(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.importFormDefinitions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormDefinition(formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormDefinition(formDefinitionID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.patchFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormInstance(formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormInstance(formInstanceID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.patchFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.searchFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormElementDataByElementID(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormElementDataByElementID(formInstanceID, formElementID, limit, filters, query, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.searchFormElementDataByElementID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormInstancesByTenant(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPreDefinedSelectOptions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.searchPreDefinedSelectOptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestBeta} [formElementPreviewRequestBeta] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showPreviewDataSource(formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestBeta?: FormElementPreviewRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showPreviewDataSource(formDefinitionID, limit, filters, query, formElementPreviewRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsBetaApi.showPreviewDataSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomFormsBetaApi - factory interface - * @export - */ -export const CustomFormsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomFormsBetaApiFp(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsBetaApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition(requestParameters: CustomFormsBetaApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinition(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Create a form definition by template. - * @param {CustomFormsBetaApiCreateFormDefinitionByTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionByTemplate(requestParameters: CustomFormsBetaApiCreateFormDefinitionByTemplateRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionByTemplate(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema(requestParameters: CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsBetaApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest(requestParameters: CustomFormsBetaApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Creates a form instance. - * @param {CustomFormsBetaApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance(requestParameters: CustomFormsBetaApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormInstance(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsBetaApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition(requestParameters: CustomFormsBetaApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsBetaApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant(requestParameters: CustomFormsBetaApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsBetaApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3(requestParameters: CustomFormsBetaApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsBetaApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey(requestParameters: CustomFormsBetaApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsBetaApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey(requestParameters: CustomFormsBetaApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsBetaApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile(requestParameters: CustomFormsBetaApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsBetaApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions(requestParameters: CustomFormsBetaApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsBetaApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition(requestParameters: CustomFormsBetaApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsBetaApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance(requestParameters: CustomFormsBetaApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsBetaApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant(requestParameters: CustomFormsBetaApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsBetaApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID(requestParameters: CustomFormsBetaApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List form instances by tenant. - * @param {CustomFormsBetaApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant(requestParameters: CustomFormsBetaApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchPreDefinedSelectOptions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsBetaApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource(requestParameters: CustomFormsBetaApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createFormDefinition operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiCreateFormDefinitionRequest - */ -export interface CustomFormsBetaApiCreateFormDefinitionRequest { - /** - * Body is the request payload to create form definition request - * @type {CreateFormDefinitionRequestBeta} - * @memberof CustomFormsBetaApiCreateFormDefinition - */ - readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta -} - -/** - * Request parameters for createFormDefinitionByTemplate operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest - */ -export interface CustomFormsBetaApiCreateFormDefinitionByTemplateRequest { - /** - * Body is the request payload to create form definition request - * @type {CreateFormDefinitionRequestBeta} - * @memberof CustomFormsBetaApiCreateFormDefinitionByTemplate - */ - readonly createFormDefinitionRequestBeta?: CreateFormDefinitionRequestBeta -} - -/** - * Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest - */ -export interface CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest { - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormDefinitionDynamicSchemaRequestBeta} - * @memberof CustomFormsBetaApiCreateFormDefinitionDynamicSchema - */ - readonly body?: FormDefinitionDynamicSchemaRequestBeta -} - -/** - * Request parameters for createFormDefinitionFileRequest operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiCreateFormDefinitionFileRequestRequest - */ -export interface CustomFormsBetaApiCreateFormDefinitionFileRequestRequest { - /** - * FormDefinitionID String specifying FormDefinitionID - * @type {string} - * @memberof CustomFormsBetaApiCreateFormDefinitionFileRequest - */ - readonly formDefinitionID: string - - /** - * File specifying the multipart - * @type {File} - * @memberof CustomFormsBetaApiCreateFormDefinitionFileRequest - */ - readonly file: File -} - -/** - * Request parameters for createFormInstance operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiCreateFormInstanceRequest - */ -export interface CustomFormsBetaApiCreateFormInstanceRequest { - /** - * Body is the request payload to create a form instance - * @type {CreateFormInstanceRequestBeta} - * @memberof CustomFormsBetaApiCreateFormInstance - */ - readonly body?: CreateFormInstanceRequestBeta -} - -/** - * Request parameters for deleteFormDefinition operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiDeleteFormDefinitionRequest - */ -export interface CustomFormsBetaApiDeleteFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsBetaApiDeleteFormDefinition - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for exportFormDefinitionsByTenant operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiExportFormDefinitionsByTenantRequest - */ -export interface CustomFormsBetaApiExportFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsBetaApiExportFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsBetaApiExportFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsBetaApiExportFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsBetaApiExportFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for getFileFromS3 operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiGetFileFromS3Request - */ -export interface CustomFormsBetaApiGetFileFromS3Request { - /** - * FormDefinitionID Form definition ID - * @type {string} - * @memberof CustomFormsBetaApiGetFileFromS3 - */ - readonly formDefinitionID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsBetaApiGetFileFromS3 - */ - readonly fileID: string -} - -/** - * Request parameters for getFormDefinitionByKey operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiGetFormDefinitionByKeyRequest - */ -export interface CustomFormsBetaApiGetFormDefinitionByKeyRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsBetaApiGetFormDefinitionByKey - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for getFormInstanceByKey operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiGetFormInstanceByKeyRequest - */ -export interface CustomFormsBetaApiGetFormInstanceByKeyRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsBetaApiGetFormInstanceByKey - */ - readonly formInstanceID: string -} - -/** - * Request parameters for getFormInstanceFile operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiGetFormInstanceFileRequest - */ -export interface CustomFormsBetaApiGetFormInstanceFileRequest { - /** - * FormInstanceID Form instance ID - * @type {string} - * @memberof CustomFormsBetaApiGetFormInstanceFile - */ - readonly formInstanceID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsBetaApiGetFormInstanceFile - */ - readonly fileID: string -} - -/** - * Request parameters for importFormDefinitions operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiImportFormDefinitionsRequest - */ -export interface CustomFormsBetaApiImportFormDefinitionsRequest { - /** - * Body is the request payload to import form definitions - * @type {Array} - * @memberof CustomFormsBetaApiImportFormDefinitions - */ - readonly body?: Array -} - -/** - * Request parameters for patchFormDefinition operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiPatchFormDefinitionRequest - */ -export interface CustomFormsBetaApiPatchFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsBetaApiPatchFormDefinition - */ - readonly formDefinitionID: string - - /** - * Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsBetaApiPatchFormDefinition - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for patchFormInstance operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiPatchFormInstanceRequest - */ -export interface CustomFormsBetaApiPatchFormInstanceRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsBetaApiPatchFormInstance - */ - readonly formInstanceID: string - - /** - * Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsBetaApiPatchFormInstance - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for searchFormDefinitionsByTenant operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiSearchFormDefinitionsByTenantRequest - */ -export interface CustomFormsBetaApiSearchFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsBetaApiSearchFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsBetaApiSearchFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsBetaApiSearchFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsBetaApiSearchFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for searchFormElementDataByElementID operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiSearchFormElementDataByElementIDRequest - */ -export interface CustomFormsBetaApiSearchFormElementDataByElementIDRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsBetaApiSearchFormElementDataByElementID - */ - readonly formInstanceID: string - - /** - * Form element ID - * @type {string} - * @memberof CustomFormsBetaApiSearchFormElementDataByElementID - */ - readonly formElementID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsBetaApiSearchFormElementDataByElementID - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsBetaApiSearchFormElementDataByElementID - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsBetaApiSearchFormElementDataByElementID - */ - readonly query?: string -} - -/** - * Request parameters for searchFormInstancesByTenant operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiSearchFormInstancesByTenantRequest - */ -export interface CustomFormsBetaApiSearchFormInstancesByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsBetaApiSearchFormInstancesByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsBetaApiSearchFormInstancesByTenant - */ - readonly limit?: number -} - -/** - * Request parameters for showPreviewDataSource operation in CustomFormsBetaApi. - * @export - * @interface CustomFormsBetaApiShowPreviewDataSourceRequest - */ -export interface CustomFormsBetaApiShowPreviewDataSourceRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsBetaApiShowPreviewDataSource - */ - readonly formDefinitionID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsBetaApiShowPreviewDataSource - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsBetaApiShowPreviewDataSource - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsBetaApiShowPreviewDataSource - */ - readonly query?: string - - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormElementPreviewRequestBeta} - * @memberof CustomFormsBetaApiShowPreviewDataSource - */ - readonly formElementPreviewRequestBeta?: FormElementPreviewRequestBeta -} - -/** - * CustomFormsBetaApi - object-oriented interface - * @export - * @class CustomFormsBetaApi - * @extends {BaseAPI} - */ -export class CustomFormsBetaApi extends BaseAPI { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsBetaApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public createFormDefinition(requestParameters: CustomFormsBetaApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).createFormDefinition(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Create a form definition by template. - * @param {CustomFormsBetaApiCreateFormDefinitionByTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public createFormDefinitionByTemplate(requestParameters: CustomFormsBetaApiCreateFormDefinitionByTemplateRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).createFormDefinitionByTemplate(requestParameters.createFormDefinitionRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public createFormDefinitionDynamicSchema(requestParameters: CustomFormsBetaApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsBetaApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public createFormDefinitionFileRequest(requestParameters: CustomFormsBetaApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Creates a form instance. - * @param {CustomFormsBetaApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public createFormInstance(requestParameters: CustomFormsBetaApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).createFormInstance(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsBetaApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public deleteFormDefinition(requestParameters: CustomFormsBetaApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsBetaApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public exportFormDefinitionsByTenant(requestParameters: CustomFormsBetaApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsBetaApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public getFileFromS3(requestParameters: CustomFormsBetaApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsBetaApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public getFormDefinitionByKey(requestParameters: CustomFormsBetaApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsBetaApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public getFormInstanceByKey(requestParameters: CustomFormsBetaApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsBetaApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public getFormInstanceFile(requestParameters: CustomFormsBetaApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsBetaApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public importFormDefinitions(requestParameters: CustomFormsBetaApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsBetaApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public patchFormDefinition(requestParameters: CustomFormsBetaApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsBetaApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public patchFormInstance(requestParameters: CustomFormsBetaApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsBetaApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public searchFormDefinitionsByTenant(requestParameters: CustomFormsBetaApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsBetaApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public searchFormElementDataByElementID(requestParameters: CustomFormsBetaApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List form instances by tenant. - * @param {CustomFormsBetaApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public searchFormInstancesByTenant(requestParameters: CustomFormsBetaApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).searchPreDefinedSelectOptions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsBetaApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsBetaApi - */ - public showPreviewDataSource(requestParameters: CustomFormsBetaApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsBetaApiFp(this.configuration).showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CustomPasswordInstructionsBetaApi - axios parameter creator - * @export - */ -export const CustomPasswordInstructionsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionBeta} customPasswordInstructionBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions: async (customPasswordInstructionBeta: CustomPasswordInstructionBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'customPasswordInstructionBeta' is not null or undefined - assertParamExists('createCustomPasswordInstructions', 'customPasswordInstructionBeta', customPasswordInstructionBeta) - const localVarPath = `/custom-password-instructions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(customPasswordInstructionBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdBeta} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions: async (pageId: DeleteCustomPasswordInstructionsPageIdBeta, locale?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('deleteCustomPasswordInstructions', 'pageId', pageId) - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdBeta} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions: async (pageId: GetCustomPasswordInstructionsPageIdBeta, locale?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('getCustomPasswordInstructions', 'pageId', pageId) - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomPasswordInstructionsBetaApi - functional programming interface - * @export - */ -export const CustomPasswordInstructionsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomPasswordInstructionsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionBeta} customPasswordInstructionBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPasswordInstructions(customPasswordInstructionBeta: CustomPasswordInstructionBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPasswordInstructions(customPasswordInstructionBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsBetaApi.createCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdBeta} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPasswordInstructions(pageId: DeleteCustomPasswordInstructionsPageIdBeta, locale?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPasswordInstructions(pageId, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsBetaApi.deleteCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdBeta} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomPasswordInstructions(pageId: GetCustomPasswordInstructionsPageIdBeta, locale?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomPasswordInstructions(pageId, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsBetaApi.getCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomPasswordInstructionsBetaApi - factory interface - * @export - */ -export const CustomPasswordInstructionsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomPasswordInstructionsBetaApiFp(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPasswordInstructions(requestParameters.customPasswordInstructionBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPasswordInstructions operation in CustomPasswordInstructionsBetaApi. - * @export - * @interface CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest { - /** - * - * @type {CustomPasswordInstructionBeta} - * @memberof CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructions - */ - readonly customPasswordInstructionBeta: CustomPasswordInstructionBeta -} - -/** - * Request parameters for deleteCustomPasswordInstructions operation in CustomPasswordInstructionsBetaApi. - * @export - * @interface CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to delete. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructions - */ - readonly pageId: DeleteCustomPasswordInstructionsPageIdBeta - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructions - */ - readonly locale?: string -} - -/** - * Request parameters for getCustomPasswordInstructions operation in CustomPasswordInstructionsBetaApi. - * @export - * @interface CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to query. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsBetaApiGetCustomPasswordInstructions - */ - readonly pageId: GetCustomPasswordInstructionsPageIdBeta - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsBetaApiGetCustomPasswordInstructions - */ - readonly locale?: string -} - -/** - * CustomPasswordInstructionsBetaApi - object-oriented interface - * @export - * @class CustomPasswordInstructionsBetaApi - * @extends {BaseAPI} - */ -export class CustomPasswordInstructionsBetaApi extends BaseAPI { - /** - * This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsBetaApi - */ - public createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsBetaApiFp(this.configuration).createCustomPasswordInstructions(requestParameters.customPasswordInstructionBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsBetaApi - */ - public deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsBetaApiFp(this.configuration).deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsBetaApi - */ - public getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsBetaApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsBetaApiFp(this.configuration).getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteCustomPasswordInstructionsPageIdBeta = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type DeleteCustomPasswordInstructionsPageIdBeta = typeof DeleteCustomPasswordInstructionsPageIdBeta[keyof typeof DeleteCustomPasswordInstructionsPageIdBeta]; -/** - * @export - */ -export const GetCustomPasswordInstructionsPageIdBeta = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type GetCustomPasswordInstructionsPageIdBeta = typeof GetCustomPasswordInstructionsPageIdBeta[keyof typeof GetCustomPasswordInstructionsPageIdBeta]; - - -/** - * EntitlementsBetaApi - axios parameter creator - * @export - */ -export const EntitlementsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementRequestConfig', 'id', id) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource: async (id: string, csvFile?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsBySource', 'id', id) - const localVarPath = `/entitlements/aggregate/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (csvFile !== undefined) { - localVarFormParams.append('csvFile', csvFile as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementChildren', 'id', id) - const localVarPath = `/entitlements/{id}/children` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementParents', 'id', id) - const localVarPath = `/entitlements/{id}/parents` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/docs/api/v2025/get-account-entitlements/) to get account entitlements. - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements: async (accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accountId !== undefined) { - localVarQueryParameter['account-id'] = accountId; - } - - if (segmentedForIdentity !== undefined) { - localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description** and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement: async (id: string, jsonPatchOperationBeta?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigBeta} entitlementRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig: async (id: string, entitlementRequestConfigBeta: EntitlementRequestConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'id', id) - // verify required parameter 'entitlementRequestConfigBeta' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'entitlementRequestConfigBeta', entitlementRequestConfigBeta) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementRequestConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} sourceId ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('resetSourceEntitlements', 'sourceId', sourceId) - const localVarPath = `/entitlements/reset/sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestBeta} entitlementBulkUpdateRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk: async (entitlementBulkUpdateRequestBeta: EntitlementBulkUpdateRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementBulkUpdateRequestBeta' is not null or undefined - assertParamExists('updateEntitlementsInBulk', 'entitlementBulkUpdateRequestBeta', entitlementBulkUpdateRequestBeta) - const localVarPath = `/entitlements/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementBulkUpdateRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * EntitlementsBetaApi - functional programming interface - * @export - */ -export const EntitlementsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = EntitlementsBetaApiAxiosParamCreator(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataForEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.createAccessModelMetadataForEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessModelMetadataFromEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.deleteAccessModelMetadataFromEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlement(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.getEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementRequestConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementRequestConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.getEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async importEntitlementsBySource(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsBySource(id, csvFile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.importEntitlementsBySource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildren(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.listEntitlementChildren']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParents(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.listEntitlementParents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/docs/api/v2025/get-account-entitlements/) to get account entitlements. - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlements(accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlements(accountId, segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.listEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description** and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlement(id: string, jsonPatchOperationBeta?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlement(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.patchEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigBeta} entitlementRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putEntitlementRequestConfig(id: string, entitlementRequestConfigBeta: EntitlementRequestConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putEntitlementRequestConfig(id, entitlementRequestConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.putEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} sourceId ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetSourceEntitlements(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetSourceEntitlements(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.resetSourceEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestBeta} entitlementBulkUpdateRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsInBulk(entitlementBulkUpdateRequestBeta: EntitlementBulkUpdateRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulk(entitlementBulkUpdateRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsBetaApi.updateEntitlementsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * EntitlementsBetaApi - factory interface - * @export - */ -export const EntitlementsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = EntitlementsBetaApiFp(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement(requestParameters: EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsBetaApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement(requestParameters: EntitlementsBetaApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlement(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsBetaApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig(requestParameters: EntitlementsBetaApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsBetaApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource(requestParameters: EntitlementsBetaApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsBetaApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren(requestParameters: EntitlementsBetaApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsBetaApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents(requestParameters: EntitlementsBetaApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsBetaApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements(requestParameters: EntitlementsBetaApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description** and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Patch an entitlement - * @param {EntitlementsBetaApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement(requestParameters: EntitlementsBetaApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsBetaApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig(requestParameters: EntitlementsBetaApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsBetaApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements(requestParameters: EntitlementsBetaApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetSourceEntitlements(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsBetaApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk(requestParameters: EntitlementsBetaApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataForEntitlement operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest - */ -export interface EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsBetaApiCreateAccessModelMetadataForEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsBetaApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsBetaApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest - */ -export interface EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for getEntitlement operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiGetEntitlementRequest - */ -export interface EntitlementsBetaApiGetEntitlementRequest { - /** - * The entitlement ID - * @type {string} - * @memberof EntitlementsBetaApiGetEntitlement - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementRequestConfig operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiGetEntitlementRequestConfigRequest - */ -export interface EntitlementsBetaApiGetEntitlementRequestConfigRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsBetaApiGetEntitlementRequestConfig - */ - readonly id: string -} - -/** - * Request parameters for importEntitlementsBySource operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiImportEntitlementsBySourceRequest - */ -export interface EntitlementsBetaApiImportEntitlementsBySourceRequest { - /** - * Source Id - * @type {string} - * @memberof EntitlementsBetaApiImportEntitlementsBySource - */ - readonly id: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof EntitlementsBetaApiImportEntitlementsBySource - */ - readonly csvFile?: File -} - -/** - * Request parameters for listEntitlementChildren operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiListEntitlementChildrenRequest - */ -export interface EntitlementsBetaApiListEntitlementChildrenRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementChildren - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlementParents operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiListEntitlementParentsRequest - */ -export interface EntitlementsBetaApiListEntitlementParentsRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsBetaApiListEntitlementParents - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlements operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiListEntitlementsRequest - */ -export interface EntitlementsBetaApiListEntitlementsRequest { - /** - * The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/docs/api/v2025/get-account-entitlements/) to get account entitlements. - * @type {string} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly accountId?: string - - /** - * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @type {string} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly segmentedForIdentity?: string - - /** - * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @type {string} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @type {boolean} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly includeUnsegmented?: boolean - - /** - * 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 EntitlementsBetaApiListEntitlements - */ - 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 EntitlementsBetaApiListEntitlements - */ - 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 EntitlementsBetaApiListEntitlements - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof EntitlementsBetaApiListEntitlements - */ - readonly filters?: string -} - -/** - * Request parameters for patchEntitlement operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiPatchEntitlementRequest - */ -export interface EntitlementsBetaApiPatchEntitlementRequest { - /** - * ID of the entitlement to patch - * @type {string} - * @memberof EntitlementsBetaApiPatchEntitlement - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof EntitlementsBetaApiPatchEntitlement - */ - readonly jsonPatchOperationBeta?: Array -} - -/** - * Request parameters for putEntitlementRequestConfig operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiPutEntitlementRequestConfigRequest - */ -export interface EntitlementsBetaApiPutEntitlementRequestConfigRequest { - /** - * Entitlement ID - * @type {string} - * @memberof EntitlementsBetaApiPutEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {EntitlementRequestConfigBeta} - * @memberof EntitlementsBetaApiPutEntitlementRequestConfig - */ - readonly entitlementRequestConfigBeta: EntitlementRequestConfigBeta -} - -/** - * Request parameters for resetSourceEntitlements operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiResetSourceEntitlementsRequest - */ -export interface EntitlementsBetaApiResetSourceEntitlementsRequest { - /** - * ID of source for the entitlement reset - * @type {string} - * @memberof EntitlementsBetaApiResetSourceEntitlements - */ - readonly sourceId: string -} - -/** - * Request parameters for updateEntitlementsInBulk operation in EntitlementsBetaApi. - * @export - * @interface EntitlementsBetaApiUpdateEntitlementsInBulkRequest - */ -export interface EntitlementsBetaApiUpdateEntitlementsInBulkRequest { - /** - * - * @type {EntitlementBulkUpdateRequestBeta} - * @memberof EntitlementsBetaApiUpdateEntitlementsInBulk - */ - readonly entitlementBulkUpdateRequestBeta: EntitlementBulkUpdateRequestBeta -} - -/** - * EntitlementsBetaApi - object-oriented interface - * @export - * @class EntitlementsBetaApi - * @extends {BaseAPI} - */ -export class EntitlementsBetaApi extends BaseAPI { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public createAccessModelMetadataForEntitlement(requestParameters: EntitlementsBetaApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsBetaApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsBetaApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public getEntitlement(requestParameters: EntitlementsBetaApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).getEntitlement(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsBetaApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public getEntitlementRequestConfig(requestParameters: EntitlementsBetaApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsBetaApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public importEntitlementsBySource(requestParameters: EntitlementsBetaApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsBetaApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public listEntitlementChildren(requestParameters: EntitlementsBetaApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsBetaApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public listEntitlementParents(requestParameters: EntitlementsBetaApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsBetaApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public listEntitlements(requestParameters: EntitlementsBetaApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description** and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Patch an entitlement - * @param {EntitlementsBetaApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public patchEntitlement(requestParameters: EntitlementsBetaApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsBetaApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public putEntitlementRequestConfig(requestParameters: EntitlementsBetaApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsBetaApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public resetSourceEntitlements(requestParameters: EntitlementsBetaApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).resetSourceEntitlements(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsBetaApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsBetaApi - */ - public updateEntitlementsInBulk(requestParameters: EntitlementsBetaApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsBetaApiFp(this.configuration).updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GovernanceGroupsBetaApi - axios parameter creator - * @export - */ -export const GovernanceGroupsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoBeta} workgroupDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup: async (workgroupDtoBeta: WorkgroupDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupDtoBeta' is not null or undefined - assertParamExists('createWorkgroup', 'workgroupDtoBeta', workgroupDtoBeta) - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} bulkWorkgroupMembersRequestInnerBeta List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers: async (workgroupId: string, bulkWorkgroupMembersRequestInnerBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'bulkWorkgroupMembersRequestInnerBeta' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'bulkWorkgroupMembersRequestInnerBeta', bulkWorkgroupMembersRequestInnerBeta) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-delete` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkWorkgroupMembersRequestInnerBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestBeta} workgroupBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk: async (workgroupBulkDeleteRequestBeta: WorkgroupBulkDeleteRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupBulkDeleteRequestBeta' is not null or undefined - assertParamExists('deleteWorkgroupsInBulk', 'workgroupBulkDeleteRequestBeta', workgroupBulkDeleteRequestBeta) - const localVarPath = `/workgroups/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupBulkDeleteRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listConnections', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/connections` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listWorkgroupMembers', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/members` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner A token with API or ORG_ADMIN authority is required to call this API. - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup: async (id: string, jsonPatchOperationBeta?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} bulkWorkgroupMembersRequestInnerBeta List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers: async (workgroupId: string, bulkWorkgroupMembersRequestInnerBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'bulkWorkgroupMembersRequestInnerBeta' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'bulkWorkgroupMembersRequestInnerBeta', bulkWorkgroupMembersRequestInnerBeta) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-add` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkWorkgroupMembersRequestInnerBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GovernanceGroupsBetaApi - functional programming interface - * @export - */ -export const GovernanceGroupsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GovernanceGroupsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoBeta} workgroupDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkgroup(workgroupDtoBeta: WorkgroupDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkgroup(workgroupDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.createWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.deleteWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} bulkWorkgroupMembersRequestInnerBeta List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupMembers(workgroupId: string, bulkWorkgroupMembersRequestInnerBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupMembers(workgroupId, bulkWorkgroupMembersRequestInnerBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.deleteWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestBeta} workgroupBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupsInBulk(workgroupBulkDeleteRequestBeta: WorkgroupBulkDeleteRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupsInBulk(workgroupBulkDeleteRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.deleteWorkgroupsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.getWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnections(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.listConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroupMembers(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupMembers(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.listWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroups(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroups(offset, limit, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.listWorkgroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner A token with API or ORG_ADMIN authority is required to call this API. - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkgroup(id: string, jsonPatchOperationBeta?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkgroup(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.patchWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} bulkWorkgroupMembersRequestInnerBeta List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateWorkgroupMembers(workgroupId: string, bulkWorkgroupMembersRequestInnerBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkgroupMembers(workgroupId, bulkWorkgroupMembersRequestInnerBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsBetaApi.updateWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GovernanceGroupsBetaApi - factory interface - * @export - */ -export const GovernanceGroupsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GovernanceGroupsBetaApiFp(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsBetaApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup(requestParameters: GovernanceGroupsBetaApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkgroup(requestParameters.workgroupDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsBetaApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.bulkWorkgroupMembersRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsBetaApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup(requestParameters: GovernanceGroupsBetaApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsBetaApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections(requestParameters: GovernanceGroupsBetaApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsBetaApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsBetaApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups(requestParameters: GovernanceGroupsBetaApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner A token with API or ORG_ADMIN authority is required to call this API. - * @summary Patch a governance group - * @param {GovernanceGroupsBetaApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup(requestParameters: GovernanceGroupsBetaApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.bulkWorkgroupMembersRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createWorkgroup operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiCreateWorkgroupRequest - */ -export interface GovernanceGroupsBetaApiCreateWorkgroupRequest { - /** - * - * @type {WorkgroupDtoBeta} - * @memberof GovernanceGroupsBetaApiCreateWorkgroup - */ - readonly workgroupDtoBeta: WorkgroupDtoBeta -} - -/** - * Request parameters for deleteWorkgroup operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiDeleteWorkgroupRequest - */ -export interface GovernanceGroupsBetaApiDeleteWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsBetaApiDeleteWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkgroupMembers operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest - */ -export interface GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsBetaApiDeleteWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be removed from a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsBetaApiDeleteWorkgroupMembers - */ - readonly bulkWorkgroupMembersRequestInnerBeta: Array -} - -/** - * Request parameters for deleteWorkgroupsInBulk operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest - */ -export interface GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest { - /** - * - * @type {WorkgroupBulkDeleteRequestBeta} - * @memberof GovernanceGroupsBetaApiDeleteWorkgroupsInBulk - */ - readonly workgroupBulkDeleteRequestBeta: WorkgroupBulkDeleteRequestBeta -} - -/** - * Request parameters for getWorkgroup operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiGetWorkgroupRequest - */ -export interface GovernanceGroupsBetaApiGetWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsBetaApiGetWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for listConnections operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiListConnectionsRequest - */ -export interface GovernanceGroupsBetaApiListConnectionsRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsBetaApiListConnections - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsBetaApiListConnections - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsBetaApiListConnections - */ - 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 GovernanceGroupsBetaApiListConnections - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsBetaApiListConnections - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroupMembers operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiListWorkgroupMembersRequest - */ -export interface GovernanceGroupsBetaApiListWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsBetaApiListWorkgroupMembers - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsBetaApiListWorkgroupMembers - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsBetaApiListWorkgroupMembers - */ - 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 GovernanceGroupsBetaApiListWorkgroupMembers - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsBetaApiListWorkgroupMembers - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroups operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiListWorkgroupsRequest - */ -export interface GovernanceGroupsBetaApiListWorkgroupsRequest { - /** - * 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 GovernanceGroupsBetaApiListWorkgroups - */ - 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 GovernanceGroupsBetaApiListWorkgroups - */ - 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 GovernanceGroupsBetaApiListWorkgroups - */ - 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @type {string} - * @memberof GovernanceGroupsBetaApiListWorkgroups - */ - 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: **name, created, modified, id, description** - * @type {string} - * @memberof GovernanceGroupsBetaApiListWorkgroups - */ - readonly sorters?: string -} - -/** - * Request parameters for patchWorkgroup operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiPatchWorkgroupRequest - */ -export interface GovernanceGroupsBetaApiPatchWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsBetaApiPatchWorkgroup - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof GovernanceGroupsBetaApiPatchWorkgroup - */ - readonly jsonPatchOperationBeta?: Array -} - -/** - * Request parameters for updateWorkgroupMembers operation in GovernanceGroupsBetaApi. - * @export - * @interface GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest - */ -export interface GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsBetaApiUpdateWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be added to a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsBetaApiUpdateWorkgroupMembers - */ - readonly bulkWorkgroupMembersRequestInnerBeta: Array -} - -/** - * GovernanceGroupsBetaApi - object-oriented interface - * @export - * @class GovernanceGroupsBetaApi - * @extends {BaseAPI} - */ -export class GovernanceGroupsBetaApi extends BaseAPI { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsBetaApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public createWorkgroup(requestParameters: GovernanceGroupsBetaApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).createWorkgroup(requestParameters.workgroupDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsBetaApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public deleteWorkgroup(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public deleteWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.bulkWorkgroupMembersRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsBetaApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsBetaApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public getWorkgroup(requestParameters: GovernanceGroupsBetaApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsBetaApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public listConnections(requestParameters: GovernanceGroupsBetaApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsBetaApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public listWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsBetaApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public listWorkgroups(requestParameters: GovernanceGroupsBetaApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner A token with API or ORG_ADMIN authority is required to call this API. - * @summary Patch a governance group - * @param {GovernanceGroupsBetaApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public patchWorkgroup(requestParameters: GovernanceGroupsBetaApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsBetaApi - */ - public updateWorkgroupMembers(requestParameters: GovernanceGroupsBetaApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsBetaApiFp(this.configuration).updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.bulkWorkgroupMembersRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIAccessRequestRecommendationsBetaApi - axios parameter creator - * @export - */ -export const IAIAccessRequestRecommendationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access item to ignore for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem: async (accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoBeta' is not null or undefined - assertParamExists('addAccessRequestRecommendationsIgnoredItem', 'accessRequestRecommendationActionItemDtoBeta', accessRequestRecommendationActionItemDtoBeta) - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access item that was requested for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem: async (accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoBeta' is not null or undefined - assertParamExists('addAccessRequestRecommendationsRequestedItem', 'accessRequestRecommendationActionItemDtoBeta', accessRequestRecommendationActionItemDtoBeta) - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access that was viewed for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem: async (accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoBeta' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItem', 'accessRequestRecommendationActionItemDtoBeta', accessRequestRecommendationActionItemDtoBeta) - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoBeta The recommended access items that were viewed for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems: async (accessRequestRecommendationActionItemDtoBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoBeta' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItems', 'accessRequestRecommendationActionItemDtoBeta', accessRequestRecommendationActionItemDtoBeta) - const localVarPath = `/ai-access-request-recommendations/viewed-items/bulk-create`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations: async (identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ai-access-request-recommendations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - 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, - }; - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * IAIAccessRequestRecommendationsBetaApi - functional programming interface - * @export - */ -export const IAIAccessRequestRecommendationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIAccessRequestRecommendationsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access item to ignore for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.addAccessRequestRecommendationsIgnoredItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access item that was requested for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.addAccessRequestRecommendationsRequestedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoBeta} accessRequestRecommendationActionItemDtoBeta The recommended access that was viewed for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.addAccessRequestRecommendationsViewedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoBeta The recommended access items that were viewed for an identity. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.addAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendations(identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendations(identityId, limit, offset, count, includeTranslationMessages, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.getAccessRequestRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsIgnoredItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsIgnoredItems(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.getAccessRequestRecommendationsIgnoredItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsRequestedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsRequestedItems(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.getAccessRequestRecommendationsRequestedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsViewedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsViewedItems(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsBetaApi.getAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIAccessRequestRecommendationsBetaApi - factory interface - * @export - */ -export const IAIAccessRequestRecommendationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIAccessRequestRecommendationsBetaApiFp(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for addAccessRequestRecommendationsIgnoredItem operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest { - /** - * The recommended access item to ignore for an identity. - * @type {AccessRequestRecommendationActionItemDtoBeta} - * @memberof IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta -} - -/** - * Request parameters for addAccessRequestRecommendationsRequestedItem operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest { - /** - * The recommended access item that was requested for an identity. - * @type {AccessRequestRecommendationActionItemDtoBeta} - * @memberof IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItem - */ - readonly accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItem operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest { - /** - * The recommended access that was viewed for an identity. - * @type {AccessRequestRecommendationActionItemDtoBeta} - * @memberof IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItem - */ - readonly accessRequestRecommendationActionItemDtoBeta: AccessRequestRecommendationActionItemDtoBeta -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest { - /** - * The recommended access items that were viewed for an identity. - * @type {Array} - * @memberof IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItems - */ - readonly accessRequestRecommendationActionItemDtoBeta: Array -} - -/** - * Request parameters for getAccessRequestRecommendations operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest { - /** - * Get access request recommendations for an identityId. *me* indicates the current user. - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly identityId?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly count?: boolean - - /** - * If *true* it will populate a list of translation messages in the response. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly includeTranslationMessages?: 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendations - */ - readonly sorters?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsIgnoredItems operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly sorters?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsRequestedItems operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItems - */ - readonly sorters?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsBetaApi. - * @export - * @interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItems - */ - readonly sorters?: string -} - -/** - * IAIAccessRequestRecommendationsBetaApi - object-oriented interface - * @export - * @class IAIAccessRequestRecommendationsBetaApi - * @extends {BaseAPI} - */ -export class IAIAccessRequestRecommendationsBetaApi extends BaseAPI { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsBetaApi - */ - public getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsBetaApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsBetaApiFp(this.configuration).getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAICommonAccessBetaApi - axios parameter creator - * @export - */ -export const IAICommonAccessBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestBeta} commonAccessItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess: async (commonAccessItemRequestBeta: CommonAccessItemRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessItemRequestBeta' is not null or undefined - assertParamExists('createCommonAccess', 'commonAccessItemRequestBeta', commonAccessItemRequestBeta) - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessItemRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusBeta Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk: async (commonAccessIDStatusBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessIDStatusBeta' is not null or undefined - assertParamExists('updateCommonAccessStatusInBulk', 'commonAccessIDStatusBeta', commonAccessIDStatusBeta) - const localVarPath = `/common-access/update-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessIDStatusBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAICommonAccessBetaApi - functional programming interface - * @export - */ -export const IAICommonAccessBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAICommonAccessBetaApiAxiosParamCreator(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestBeta} commonAccessItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCommonAccess(commonAccessItemRequestBeta: CommonAccessItemRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCommonAccess(commonAccessItemRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessBetaApi.createCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCommonAccess(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCommonAccess(offset, limit, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessBetaApi.getCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusBeta Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCommonAccessStatusInBulk(commonAccessIDStatusBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommonAccessStatusInBulk(commonAccessIDStatusBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessBetaApi.updateCommonAccessStatusInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAICommonAccessBetaApi - factory interface - * @export - */ -export const IAICommonAccessBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAICommonAccessBetaApiFp(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessBetaApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess(requestParameters: IAICommonAccessBetaApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCommonAccess(requestParameters.commonAccessItemRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessBetaApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess(requestParameters: IAICommonAccessBetaApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCommonAccess operation in IAICommonAccessBetaApi. - * @export - * @interface IAICommonAccessBetaApiCreateCommonAccessRequest - */ -export interface IAICommonAccessBetaApiCreateCommonAccessRequest { - /** - * - * @type {CommonAccessItemRequestBeta} - * @memberof IAICommonAccessBetaApiCreateCommonAccess - */ - readonly commonAccessItemRequestBeta: CommonAccessItemRequestBeta -} - -/** - * Request parameters for getCommonAccess operation in IAICommonAccessBetaApi. - * @export - * @interface IAICommonAccessBetaApiGetCommonAccessRequest - */ -export interface IAICommonAccessBetaApiGetCommonAccessRequest { - /** - * 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 IAICommonAccessBetaApiGetCommonAccess - */ - 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 IAICommonAccessBetaApiGetCommonAccess - */ - 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 IAICommonAccessBetaApiGetCommonAccess - */ - 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @type {string} - * @memberof IAICommonAccessBetaApiGetCommonAccess - */ - 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: **access.name, status** By default the common access items are sorted by name, ascending. - * @type {string} - * @memberof IAICommonAccessBetaApiGetCommonAccess - */ - readonly sorters?: string -} - -/** - * Request parameters for updateCommonAccessStatusInBulk operation in IAICommonAccessBetaApi. - * @export - * @interface IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest - */ -export interface IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest { - /** - * Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @type {Array} - * @memberof IAICommonAccessBetaApiUpdateCommonAccessStatusInBulk - */ - readonly commonAccessIDStatusBeta: Array -} - -/** - * IAICommonAccessBetaApi - object-oriented interface - * @export - * @class IAICommonAccessBetaApi - * @extends {BaseAPI} - */ -export class IAICommonAccessBetaApi extends BaseAPI { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessBetaApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessBetaApi - */ - public createCommonAccess(requestParameters: IAICommonAccessBetaApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessBetaApiFp(this.configuration).createCommonAccess(requestParameters.commonAccessItemRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessBetaApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessBetaApi - */ - public getCommonAccess(requestParameters: IAICommonAccessBetaApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessBetaApiFp(this.configuration).getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessBetaApi - */ - public updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessBetaApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessBetaApiFp(this.configuration).updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIMessageCatalogsBetaApi - axios parameter creator - * @export - */ -export const IAIMessageCatalogsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The getMessageCatalogs API returns message catalog based on the language headers in the requested object. - * @summary Get message catalogs - * @param {GetMessageCatalogsCatalogIdBeta} catalogId The ID of the message catalog. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMessageCatalogs: async (catalogId: GetMessageCatalogsCatalogIdBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'catalogId' is not null or undefined - assertParamExists('getMessageCatalogs', 'catalogId', catalogId) - const localVarPath = `/translation-catalogs/{catalog-id}` - .replace(`{${"catalog-id"}}`, encodeURIComponent(String(catalogId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIMessageCatalogsBetaApi - functional programming interface - * @export - */ -export const IAIMessageCatalogsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIMessageCatalogsBetaApiAxiosParamCreator(configuration) - return { - /** - * The getMessageCatalogs API returns message catalog based on the language headers in the requested object. - * @summary Get message catalogs - * @param {GetMessageCatalogsCatalogIdBeta} catalogId The ID of the message catalog. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMessageCatalogs(catalogId: GetMessageCatalogsCatalogIdBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMessageCatalogs(catalogId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIMessageCatalogsBetaApi.getMessageCatalogs']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIMessageCatalogsBetaApi - factory interface - * @export - */ -export const IAIMessageCatalogsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIMessageCatalogsBetaApiFp(configuration) - return { - /** - * The getMessageCatalogs API returns message catalog based on the language headers in the requested object. - * @summary Get message catalogs - * @param {IAIMessageCatalogsBetaApiGetMessageCatalogsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMessageCatalogs(requestParameters: IAIMessageCatalogsBetaApiGetMessageCatalogsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMessageCatalogs(requestParameters.catalogId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getMessageCatalogs operation in IAIMessageCatalogsBetaApi. - * @export - * @interface IAIMessageCatalogsBetaApiGetMessageCatalogsRequest - */ -export interface IAIMessageCatalogsBetaApiGetMessageCatalogsRequest { - /** - * The ID of the message catalog. - * @type {'recommender' | 'access-request-recommender'} - * @memberof IAIMessageCatalogsBetaApiGetMessageCatalogs - */ - readonly catalogId: GetMessageCatalogsCatalogIdBeta -} - -/** - * IAIMessageCatalogsBetaApi - object-oriented interface - * @export - * @class IAIMessageCatalogsBetaApi - * @extends {BaseAPI} - */ -export class IAIMessageCatalogsBetaApi extends BaseAPI { - /** - * The getMessageCatalogs API returns message catalog based on the language headers in the requested object. - * @summary Get message catalogs - * @param {IAIMessageCatalogsBetaApiGetMessageCatalogsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIMessageCatalogsBetaApi - */ - public getMessageCatalogs(requestParameters: IAIMessageCatalogsBetaApiGetMessageCatalogsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIMessageCatalogsBetaApiFp(this.configuration).getMessageCatalogs(requestParameters.catalogId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetMessageCatalogsCatalogIdBeta = { - Recommender: 'recommender', - AccessRequestRecommender: 'access-request-recommender' -} as const; -export type GetMessageCatalogsCatalogIdBeta = typeof GetMessageCatalogsCatalogIdBeta[keyof typeof GetMessageCatalogsCatalogIdBeta]; - - -/** - * IAIOutliersBetaApi - axios parameter creator - * @export - */ -export const IAIOutliersBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip: async (type?: ExportOutliersZipTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/outliers/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeBeta, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/outlier-summaries`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - 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, - }; - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeBeta, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/outliers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - 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, - }; - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots: async (type?: GetLatestIdentityOutlierSnapshotsTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/outlier-summaries/latest`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary: async (outlierFeatureId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierFeatureId' is not null or undefined - assertParamExists('getOutlierContributingFeatureSummary', 'outlierFeatureId', outlierFeatureId) - const localVarPath = `/outlier-feature-summaries/{outlierFeatureId}` - .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('getPeerGroupOutliersContributingFeatures', 'outlierId', outlierId) - const localVarPath = `/outliers/{outlierId}/contributing-features` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - 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, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('ignoreIdentityOutliers', 'requestBody', requestBody) - const localVarPath = `/outliers/ignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'outlierId', outlierId) - // verify required parameter 'contributingFeatureName' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'contributingFeatureName', contributingFeatureName) - const localVarPath = `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) - .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (accessType !== undefined) { - localVarQueryParameter['accessType'] = accessType; - } - - 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, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('unIgnoreIdentityOutliers', 'requestBody', requestBody) - const localVarPath = `/outliers/unignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIOutliersBetaApi - functional programming interface - * @export - */ -export const IAIOutliersBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIOutliersBetaApiAxiosParamCreator(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportOutliersZip(type?: ExportOutliersZipTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZip(type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.exportOutliersZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeBeta, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshots(limit, offset, type, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.getIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeBeta, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliers(limit, offset, count, type, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.getIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeBeta} [type] Type of the identity outliers snapshot to filter on - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLatestIdentityOutlierSnapshots(type?: GetLatestIdentityOutlierSnapshotsTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshots(type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.getLatestIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOutlierContributingFeatureSummary(outlierFeatureId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummary(outlierFeatureId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.getOutlierContributingFeatureSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeatures(outlierId, limit, offset, count, includeTranslationMessages, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.getPeerGroupOutliersContributingFeatures']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async ignoreIdentityOutliers(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliers(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.ignoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItems(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.listOutliersContributingFeatureAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unIgnoreIdentityOutliers(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliers(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersBetaApi.unIgnoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIOutliersBetaApi - factory interface - * @export - */ -export const IAIOutliersBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIOutliersBetaApiFp(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersBetaApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip(requestParameters: IAIOutliersBetaApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportOutliersZip(requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots(requestParameters: IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersBetaApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers(requestParameters: IAIOutliersBetaApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLatestIdentityOutlierSnapshots(requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary(requestParameters: IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersBetaApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers(requestParameters: IAIOutliersBetaApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.ignoreIdentityOutliers(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers(requestParameters: IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unIgnoreIdentityOutliers(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportOutliersZip operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiExportOutliersZipRequest - */ -export interface IAIOutliersBetaApiExportOutliersZipRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersBetaApiExportOutliersZip - */ - readonly type?: ExportOutliersZipTypeBeta -} - -/** - * Request parameters for getIdentityOutlierSnapshots operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest { - /** - * 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 IAIOutliersBetaApiGetIdentityOutlierSnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersBetaApiGetIdentityOutlierSnapshots - */ - readonly offset?: number - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersBetaApiGetIdentityOutlierSnapshots - */ - readonly type?: GetIdentityOutlierSnapshotsTypeBeta - - /** - * 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: **snapshotDate**: *ge, le* - * @type {string} - * @memberof IAIOutliersBetaApiGetIdentityOutlierSnapshots - */ - 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: **snapshotDate** - * @type {string} - * @memberof IAIOutliersBetaApiGetIdentityOutlierSnapshots - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentityOutliers operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiGetIdentityOutliersRequest - */ -export interface IAIOutliersBetaApiGetIdentityOutliersRequest { - /** - * 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 IAIOutliersBetaApiGetIdentityOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersBetaApiGetIdentityOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersBetaApiGetIdentityOutliers - */ - readonly count?: boolean - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersBetaApiGetIdentityOutliers - */ - readonly type?: GetIdentityOutliersTypeBeta - - /** - * 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* - * @type {string} - * @memberof IAIOutliersBetaApiGetIdentityOutliers - */ - 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: **firstDetectionDate, attributes, score** - * @type {string} - * @memberof IAIOutliersBetaApiGetIdentityOutliers - */ - readonly sorters?: string -} - -/** - * Request parameters for getLatestIdentityOutlierSnapshots operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersBetaApiGetLatestIdentityOutlierSnapshots - */ - readonly type?: GetLatestIdentityOutlierSnapshotsTypeBeta -} - -/** - * Request parameters for getOutlierContributingFeatureSummary operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest - */ -export interface IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest { - /** - * Contributing feature id - * @type {string} - * @memberof IAIOutliersBetaApiGetOutlierContributingFeatureSummary - */ - readonly outlierFeatureId: string -} - -/** - * Request parameters for getPeerGroupOutliersContributingFeatures operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest - */ -export interface IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly outlierId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly count?: boolean - - /** - * Whether or not to include translation messages object in returned response - * @type {string} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly includeTranslationMessages?: 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: **importance** - * @type {string} - * @memberof IAIOutliersBetaApiGetPeerGroupOutliersContributingFeatures - */ - readonly sorters?: string -} - -/** - * Request parameters for ignoreIdentityOutliers operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersBetaApiIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersBetaApiIgnoreIdentityOutliers - */ - readonly requestBody: Array -} - -/** - * Request parameters for listOutliersContributingFeatureAccessItems operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest - */ -export interface IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly outlierId: string - - /** - * The name of contributing feature - * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta - - /** - * 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 IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly count?: boolean - - /** - * The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @type {string} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly accessType?: 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: **displayName** - * @type {string} - * @memberof IAIOutliersBetaApiListOutliersContributingFeatureAccessItems - */ - readonly sorters?: string -} - -/** - * Request parameters for unIgnoreIdentityOutliers operation in IAIOutliersBetaApi. - * @export - * @interface IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersBetaApiUnIgnoreIdentityOutliers - */ - readonly requestBody: Array -} - -/** - * IAIOutliersBetaApi - object-oriented interface - * @export - * @class IAIOutliersBetaApi - * @extends {BaseAPI} - */ -export class IAIOutliersBetaApi extends BaseAPI { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersBetaApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public exportOutliersZip(requestParameters: IAIOutliersBetaApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).exportOutliersZip(requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public getIdentityOutlierSnapshots(requestParameters: IAIOutliersBetaApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersBetaApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public getIdentityOutliers(requestParameters: IAIOutliersBetaApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersBetaApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).getLatestIdentityOutlierSnapshots(requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public getOutlierContributingFeatureSummary(requestParameters: IAIOutliersBetaApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersBetaApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersBetaApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public ignoreIdentityOutliers(requestParameters: IAIOutliersBetaApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).ignoreIdentityOutliers(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersBetaApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersBetaApi - */ - public unIgnoreIdentityOutliers(requestParameters: IAIOutliersBetaApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersBetaApiFp(this.configuration).unIgnoreIdentityOutliers(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ExportOutliersZipTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type ExportOutliersZipTypeBeta = typeof ExportOutliersZipTypeBeta[keyof typeof ExportOutliersZipTypeBeta]; -/** - * @export - */ -export const GetIdentityOutlierSnapshotsTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutlierSnapshotsTypeBeta = typeof GetIdentityOutlierSnapshotsTypeBeta[keyof typeof GetIdentityOutlierSnapshotsTypeBeta]; -/** - * @export - */ -export const GetIdentityOutliersTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutliersTypeBeta = typeof GetIdentityOutliersTypeBeta[keyof typeof GetIdentityOutliersTypeBeta]; -/** - * @export - */ -export const GetLatestIdentityOutlierSnapshotsTypeBeta = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetLatestIdentityOutlierSnapshotsTypeBeta = typeof GetLatestIdentityOutlierSnapshotsTypeBeta[keyof typeof GetLatestIdentityOutlierSnapshotsTypeBeta]; -/** - * @export - */ -export const ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta = { - RadicalEntitlementCount: 'radical_entitlement_count', - EntitlementCount: 'entitlement_count', - MaxJaccardSimilarity: 'max_jaccard_similarity', - MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', - SingleEntitlementBundleCount: 'single_entitlement_bundle_count', - PeerlessScore: 'peerless_score' -} as const; -export type ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta = typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta[keyof typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameBeta]; - - -/** - * IAIPeerGroupStrategiesBetaApi - axios parameter creator - * @export - */ -export const IAIPeerGroupStrategiesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyBeta} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers: async (strategy: GetPeerGroupOutliersStrategyBeta, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'strategy' is not null or undefined - assertParamExists('getPeerGroupOutliers', 'strategy', strategy) - const localVarPath = `/peer-group-strategies/{strategy}/identity-outliers` - .replace(`{${"strategy"}}`, encodeURIComponent(String(strategy))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIPeerGroupStrategiesBetaApi - functional programming interface - * @export - */ -export const IAIPeerGroupStrategiesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIPeerGroupStrategiesBetaApiAxiosParamCreator(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyBeta} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPeerGroupOutliers(strategy: GetPeerGroupOutliersStrategyBeta, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliers(strategy, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIPeerGroupStrategiesBetaApi.getPeerGroupOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIPeerGroupStrategiesBetaApi - factory interface - * @export - */ -export const IAIPeerGroupStrategiesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIPeerGroupStrategiesBetaApiFp(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPeerGroupOutliers operation in IAIPeerGroupStrategiesBetaApi. - * @export - * @interface IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest - */ -export interface IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest { - /** - * The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @type {'entitlement'} - * @memberof IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliers - */ - readonly strategy: GetPeerGroupOutliersStrategyBeta - - /** - * 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 IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliers - */ - readonly count?: boolean -} - -/** - * IAIPeerGroupStrategiesBetaApi - object-oriented interface - * @export - * @class IAIPeerGroupStrategiesBetaApi - * @extends {BaseAPI} - */ -export class IAIPeerGroupStrategiesBetaApi extends BaseAPI { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof IAIPeerGroupStrategiesBetaApi - */ - public getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesBetaApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIPeerGroupStrategiesBetaApiFp(this.configuration).getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetPeerGroupOutliersStrategyBeta = { - Entitlement: 'entitlement' -} as const; -export type GetPeerGroupOutliersStrategyBeta = typeof GetPeerGroupOutliersStrategyBeta[keyof typeof GetPeerGroupOutliersStrategyBeta]; - - -/** - * IAIRecommendationsBetaApi - axios parameter creator - * @export - */ -export const IAIRecommendationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoBeta} recommendationRequestDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations: async (recommendationRequestDtoBeta: RecommendationRequestDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationRequestDtoBeta' is not null or undefined - assertParamExists('getRecommendations', 'recommendationRequestDtoBeta', recommendationRequestDtoBeta) - const localVarPath = `/recommendations/request`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationRequestDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoBeta} recommendationConfigDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig: async (recommendationConfigDtoBeta: RecommendationConfigDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationConfigDtoBeta' is not null or undefined - assertParamExists('updateRecommendationsConfig', 'recommendationConfigDtoBeta', recommendationConfigDtoBeta) - const localVarPath = `/recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationConfigDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRecommendationsBetaApi - functional programming interface - * @export - */ -export const IAIRecommendationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRecommendationsBetaApiAxiosParamCreator(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoBeta} recommendationRequestDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendations(recommendationRequestDtoBeta: RecommendationRequestDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendations(recommendationRequestDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsBetaApi.getRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendationsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsBetaApi.getRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoBeta} recommendationConfigDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRecommendationsConfig(recommendationConfigDtoBeta: RecommendationConfigDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRecommendationsConfig(recommendationConfigDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsBetaApi.updateRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRecommendationsBetaApi - factory interface - * @export - */ -export const IAIRecommendationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRecommendationsBetaApiFp(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsBetaApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations(requestParameters: IAIRecommendationsBetaApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendations(requestParameters.recommendationRequestDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendationsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig(requestParameters: IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRecommendationsConfig(requestParameters.recommendationConfigDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getRecommendations operation in IAIRecommendationsBetaApi. - * @export - * @interface IAIRecommendationsBetaApiGetRecommendationsRequest - */ -export interface IAIRecommendationsBetaApiGetRecommendationsRequest { - /** - * - * @type {RecommendationRequestDtoBeta} - * @memberof IAIRecommendationsBetaApiGetRecommendations - */ - readonly recommendationRequestDtoBeta: RecommendationRequestDtoBeta -} - -/** - * Request parameters for updateRecommendationsConfig operation in IAIRecommendationsBetaApi. - * @export - * @interface IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest - */ -export interface IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest { - /** - * - * @type {RecommendationConfigDtoBeta} - * @memberof IAIRecommendationsBetaApiUpdateRecommendationsConfig - */ - readonly recommendationConfigDtoBeta: RecommendationConfigDtoBeta -} - -/** - * IAIRecommendationsBetaApi - object-oriented interface - * @export - * @class IAIRecommendationsBetaApi - * @extends {BaseAPI} - */ -export class IAIRecommendationsBetaApi extends BaseAPI { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsBetaApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsBetaApi - */ - public getRecommendations(requestParameters: IAIRecommendationsBetaApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsBetaApiFp(this.configuration).getRecommendations(requestParameters.recommendationRequestDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsBetaApi - */ - public getRecommendationsConfig(axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsBetaApiFp(this.configuration).getRecommendationsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsBetaApi - */ - public updateRecommendationsConfig(requestParameters: IAIRecommendationsBetaApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsBetaApiFp(this.configuration).updateRecommendationsConfig(requestParameters.recommendationConfigDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIRoleMiningBetaApi - axios parameter creator - * @export - */ -export const IAIRoleMiningBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {RoleMiningPotentialRoleProvisionRequestBeta} [roleMiningPotentialRoleProvisionRequestBeta] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest: async (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, roleMiningPotentialRoleProvisionRequestBeta?: RoleMiningPotentialRoleProvisionRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (minEntitlementPopularity !== undefined) { - localVarQueryParameter['min-entitlement-popularity'] = minEntitlementPopularity; - } - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['include-common-access'] = includeCommonAccess; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleProvisionRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoBeta} roleMiningSessionDtoBeta Role mining session parameters - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions: async (roleMiningSessionDtoBeta: RoleMiningSessionDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMiningSessionDtoBeta' is not null or undefined - assertParamExists('createRoleMiningSessions', 'roleMiningSessionDtoBeta', roleMiningSessionDtoBeta) - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningSessionDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip: async (sessionId: string, potentialRoleId: string, exportId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'exportId', exportId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole: async (sessionId: string, potentialRoleId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to s3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleExportRequestBeta} [roleMiningPotentialRoleExportRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync: async (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleExportRequestBeta?: RoleMiningPotentialRoleExportRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleExportRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus: async (sessionId: string, potentialRoleId: string, exportId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'exportId', exportId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries: async (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-mining-potential-roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieve potential role in session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole: async (sessionId: string, potentialRoleId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage: async (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'potentialRoleId', potentialRoleId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'sourceId', sourceId) - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieve session\'s potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries: async (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleSummaries', 'sessionId', sessionId) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole: async (potentialRoleId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession: async (sessionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSession', 'sessionId', sessionId) - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus: async (sessionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSessionStatus', 'sessionId', sessionId) - const localVarPath = `/role-mining-sessions/{sessionId}/status` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions: async (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles: async (sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-mining-potential-roles/saved`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update potential role in session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningBeta' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'jsonPatchOperationRoleMiningBeta', jsonPatchOperationRoleMiningBeta) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationRoleMiningBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningPotentialRole: async (potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningBeta' is not null or undefined - assertParamExists('patchRoleMiningPotentialRole', 'jsonPatchOperationRoleMiningBeta', jsonPatchOperationRoleMiningBeta) - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationRoleMiningBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationBeta Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession: async (sessionId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchRoleMiningSession', 'sessionId', sessionId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchRoleMiningSession', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsBeta} roleMiningPotentialRoleEditEntitlementsBeta Role mining session parameters - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsBeta: RoleMiningPotentialRoleEditEntitlementsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'roleMiningPotentialRoleEditEntitlementsBeta' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'roleMiningPotentialRoleEditEntitlementsBeta', roleMiningPotentialRoleEditEntitlementsBeta) - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleEditEntitlementsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRoleMiningBetaApi - functional programming interface - * @export - */ -export const IAIRoleMiningBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRoleMiningBetaApiAxiosParamCreator(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {RoleMiningPotentialRoleProvisionRequestBeta} [roleMiningPotentialRoleProvisionRequestBeta] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPotentialRoleProvisionRequest(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, roleMiningPotentialRoleProvisionRequestBeta?: RoleMiningPotentialRoleProvisionRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPotentialRoleProvisionRequest(sessionId, potentialRoleId, minEntitlementPopularity, includeCommonAccess, roleMiningPotentialRoleProvisionRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.createPotentialRoleProvisionRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoBeta} roleMiningSessionDtoBeta Role mining session parameters - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRoleMiningSessions(roleMiningSessionDtoBeta: RoleMiningSessionDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMiningSessions(roleMiningSessionDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.createRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleMiningPotentialRoleZip(sessionId: string, potentialRoleId: string, exportId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleMiningPotentialRoleZip(sessionId, potentialRoleId, exportId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.downloadRoleMiningPotentialRoleZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRole(sessionId: string, potentialRoleId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRole(sessionId, potentialRoleId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.exportRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to s3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleExportRequestBeta} [roleMiningPotentialRoleExportRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleAsync(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleExportRequestBeta?: RoleMiningPotentialRoleExportRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleAsync(sessionId, potentialRoleId, roleMiningPotentialRoleExportRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.exportRoleMiningPotentialRoleAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleStatus(sessionId: string, potentialRoleId: string, exportId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleStatus(sessionId, potentialRoleId, exportId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.exportRoleMiningPotentialRoleStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAllPotentialRoleSummaries(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPotentialRoleSummaries(sorters, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getAllPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDistributionPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDistributionPotentialRole(sessionId, potentialRoleId, includeCommonAccess, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getEntitlementDistributionPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsPotentialRole(sessionId, potentialRoleId, includeCommonAccess, sorters, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getExcludedEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getExcludedEntitlementsPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getExcludedEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitiesPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getIdentitiesPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieve potential role in session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRole(sessionId: string, potentialRoleId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRole(sessionId, potentialRoleId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleApplications(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleApplications(sessionId, potentialRoleId, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getPotentialRoleApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleEntitlements(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleEntitlements(sessionId, potentialRoleId, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getPotentialRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSourceIdentityUsage(potentialRoleId, sourceId, sorters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getPotentialRoleSourceIdentityUsage']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieve session\'s potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSummaries(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSummaries(sessionId, sorters, filters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningPotentialRole(potentialRoleId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningPotentialRole(potentialRoleId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSession(sessionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSession(sessionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessionStatus(sessionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionStatus(sessionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getRoleMiningSessionStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessions(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessions(filters, sorters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedPotentialRoles(sorters, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.getSavedPotentialRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update potential role in session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleSession(sessionId, potentialRoleId, jsonPatchOperationRoleMiningBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.patchPotentialRoleSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRoleMiningPotentialRole(potentialRoleId: string, jsonPatchOperationRoleMiningBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningPotentialRole(potentialRoleId, jsonPatchOperationRoleMiningBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.patchRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationBeta Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRoleMiningSession(sessionId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningSession(sessionId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.patchRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsBeta} roleMiningPotentialRoleEditEntitlementsBeta Role mining session parameters - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsBeta: RoleMiningPotentialRoleEditEntitlementsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsPotentialRole(sessionId, potentialRoleId, roleMiningPotentialRoleEditEntitlementsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningBetaApi.updateEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRoleMiningBetaApi - factory interface - * @export - */ -export const IAIRoleMiningBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRoleMiningBetaApiFp(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.roleMiningPotentialRoleProvisionRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions(requestParameters: IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleMiningSessions(requestParameters.roleMiningSessionDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to s3 - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleExportRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }> { - return localVarFp.getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole(requestParameters: IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieve potential role in session - * @param {IAIRoleMiningBetaApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieve session\'s potential role summaries - * @param {IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningPotentialRole(requestParameters.potentialRoleId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSession(requestParameters.sessionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSessionStatus(requestParameters.sessionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningBetaApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles(requestParameters: IAIRoleMiningBetaApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update potential role in session - * @param {IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession(requestParameters: IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningBetaApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPotentialRoleProvisionRequest operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest - */ -export interface IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequest - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequest - */ - readonly potentialRoleId: string - - /** - * Minimum popularity required for an entitlement to be included in the provisioned role. - * @type {number} - * @memberof IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequest - */ - readonly minEntitlementPopularity?: number - - /** - * Boolean determining whether common access entitlements will be included in the provisioned role. - * @type {boolean} - * @memberof IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequest - */ - readonly includeCommonAccess?: boolean - - /** - * Required information to create a new role - * @type {RoleMiningPotentialRoleProvisionRequestBeta} - * @memberof IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequest - */ - readonly roleMiningPotentialRoleProvisionRequestBeta?: RoleMiningPotentialRoleProvisionRequestBeta -} - -/** - * Request parameters for createRoleMiningSessions operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest - */ -export interface IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest { - /** - * Role mining session parameters - * @type {RoleMiningSessionDtoBeta} - * @memberof IAIRoleMiningBetaApiCreateRoleMiningSessions - */ - readonly roleMiningSessionDtoBeta: RoleMiningSessionDtoBeta -} - -/** - * Request parameters for downloadRoleMiningPotentialRoleZip operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest - */ -export interface IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZip - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZip - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZip - */ - readonly exportId: string -} - -/** - * Request parameters for exportRoleMiningPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRole - */ - readonly potentialRoleId: string -} - -/** - * Request parameters for exportRoleMiningPotentialRoleAsync operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest - */ -export interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsync - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsync - */ - readonly potentialRoleId: string - - /** - * - * @type {RoleMiningPotentialRoleExportRequestBeta} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsync - */ - readonly roleMiningPotentialRoleExportRequestBeta?: RoleMiningPotentialRoleExportRequestBeta -} - -/** - * Request parameters for exportRoleMiningPotentialRoleStatus operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest - */ -export interface IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatus - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatus - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatus - */ - readonly exportId: string -} - -/** - * Request parameters for getAllPotentialRoleSummaries operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest { - /** - * 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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetAllPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetAllPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningBetaApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningBetaApiGetAllPotentialRoleSummaries - */ - readonly count?: boolean -} - -/** - * Request parameters for getEntitlementDistributionPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRole - */ - readonly includeCommonAccess?: boolean -} - -/** - * Request parameters for getEntitlementsPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningBetaApiGetEntitlementsPotentialRole - */ - readonly count?: boolean -} - -/** - * Request parameters for getExcludedEntitlementsPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - readonly potentialRoleId: 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: **popularity** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRole - */ - readonly count?: boolean -} - -/** - * Request parameters for getIdentitiesPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - readonly potentialRoleId: 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: **name** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningBetaApiGetIdentitiesPotentialRole - */ - readonly count?: boolean -} - -/** - * Request parameters for getPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRole - */ - readonly potentialRoleId: string -} - -/** - * Request parameters for getPotentialRoleApplications operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest - */ -export interface IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - readonly potentialRoleId: 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: **applicationName**: *sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleApplications - */ - readonly count?: boolean -} - -/** - * Request parameters for getPotentialRoleEntitlements operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest - */ -export interface IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - readonly potentialRoleId: 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: **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for getPotentialRoleSourceIdentityUsage operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest - */ -export interface IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - readonly potentialRoleId: string - - /** - * A source id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - readonly sourceId: string - - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsage - */ - readonly count?: boolean -} - -/** - * Request parameters for getPotentialRoleSummaries operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - readonly sessionId: 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: **createdDate** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningBetaApiGetPotentialRoleSummaries - */ - readonly count?: boolean -} - -/** - * Request parameters for getRoleMiningPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetRoleMiningPotentialRole - */ - readonly potentialRoleId: string -} - -/** - * Request parameters for getRoleMiningSession operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetRoleMiningSessionRequest - */ -export interface IAIRoleMiningBetaApiGetRoleMiningSessionRequest { - /** - * The role mining session id to be retrieved. - * @type {string} - * @memberof IAIRoleMiningBetaApiGetRoleMiningSession - */ - readonly sessionId: string -} - -/** - * Request parameters for getRoleMiningSessionStatus operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest - */ -export interface IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiGetRoleMiningSessionStatus - */ - readonly sessionId: string -} - -/** - * Request parameters for getRoleMiningSessions operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetRoleMiningSessionsRequest - */ -export interface IAIRoleMiningBetaApiGetRoleMiningSessionsRequest { - /** - * 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: **saved**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof IAIRoleMiningBetaApiGetRoleMiningSessions - */ - 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: **createdBy, createdDate** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetRoleMiningSessions - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningBetaApiGetRoleMiningSessions - */ - 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 IAIRoleMiningBetaApiGetRoleMiningSessions - */ - 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 IAIRoleMiningBetaApiGetRoleMiningSessions - */ - readonly count?: boolean -} - -/** - * Request parameters for getSavedPotentialRoles operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiGetSavedPotentialRolesRequest - */ -export interface IAIRoleMiningBetaApiGetSavedPotentialRolesRequest { - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** - * @type {string} - * @memberof IAIRoleMiningBetaApiGetSavedPotentialRoles - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningBetaApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningBetaApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningBetaApiGetSavedPotentialRoles - */ - readonly count?: boolean -} - -/** - * Request parameters for patchPotentialRoleSession operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest - */ -export interface IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiPatchPotentialRoleSession - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningBetaApiPatchPotentialRoleSession - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningBetaApiPatchPotentialRoleSession - */ - readonly jsonPatchOperationRoleMiningBeta: Array -} - -/** - * Request parameters for patchRoleMiningPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest { - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningBetaApiPatchRoleMiningPotentialRole - */ - readonly jsonPatchOperationRoleMiningBeta: Array -} - -/** - * Request parameters for patchRoleMiningSession operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiPatchRoleMiningSessionRequest - */ -export interface IAIRoleMiningBetaApiPatchRoleMiningSessionRequest { - /** - * The role mining session id to be patched - * @type {string} - * @memberof IAIRoleMiningBetaApiPatchRoleMiningSession - */ - readonly sessionId: string - - /** - * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @type {Array} - * @memberof IAIRoleMiningBetaApiPatchRoleMiningSession - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for updateEntitlementsPotentialRole operation in IAIRoleMiningBetaApi. - * @export - * @interface IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningBetaApiUpdateEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningBetaApiUpdateEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Role mining session parameters - * @type {RoleMiningPotentialRoleEditEntitlementsBeta} - * @memberof IAIRoleMiningBetaApiUpdateEntitlementsPotentialRole - */ - readonly roleMiningPotentialRoleEditEntitlementsBeta: RoleMiningPotentialRoleEditEntitlementsBeta -} - -/** - * IAIRoleMiningBetaApi - object-oriented interface - * @export - * @class IAIRoleMiningBetaApi - * @extends {BaseAPI} - */ -export class IAIRoleMiningBetaApi extends BaseAPI { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningBetaApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.roleMiningPotentialRoleProvisionRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public createRoleMiningSessions(requestParameters: IAIRoleMiningBetaApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).createRoleMiningSessions(requestParameters.roleMiningSessionDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningBetaApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to s3 - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleExportRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningBetaApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningBetaApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningBetaApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getIdentitiesPotentialRole(requestParameters: IAIRoleMiningBetaApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieve potential role in session - * @param {IAIRoleMiningBetaApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getPotentialRole(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getPotentialRoleApplications(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getPotentialRoleEntitlements(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieve session\'s potential role summaries - * @param {IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getPotentialRoleSummaries(requestParameters: IAIRoleMiningBetaApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getRoleMiningPotentialRole(requestParameters.potentialRoleId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getRoleMiningSession(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getRoleMiningSession(requestParameters.sessionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getRoleMiningSessionStatus(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getRoleMiningSessionStatus(requestParameters.sessionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningBetaApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getRoleMiningSessions(requestParameters: IAIRoleMiningBetaApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningBetaApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public getSavedPotentialRoles(requestParameters: IAIRoleMiningBetaApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method updates an existing potential role using the role mining session id and the potential role summary id. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update potential role in session - * @param {IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public patchPotentialRoleSession(requestParameters: IAIRoleMiningBetaApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method updates an existing potential role. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public patchRoleMiningPotentialRole(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).patchRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningBetaApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public patchRoleMiningSession(requestParameters: IAIRoleMiningBetaApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningBetaApi - */ - public updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningBetaApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningBetaApiFp(this.configuration).updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IconsBetaApi - axios parameter creator - * @export - */ -export const IconsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeBeta} objectType Object type - * @param {string} objectId Object id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon: async (objectType: DeleteIconObjectTypeBeta, objectId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('deleteIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('deleteIcon', 'objectId', objectId) - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeBeta} objectType Object type - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon: async (objectType: SetIconObjectTypeBeta, objectId: string, image: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('setIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('setIcon', 'objectId', objectId) - // verify required parameter 'image' is not null or undefined - assertParamExists('setIcon', 'image', image) - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (image !== undefined) { - localVarFormParams.append('image', image as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IconsBetaApi - functional programming interface - * @export - */ -export const IconsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IconsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeBeta} objectType Object type - * @param {string} objectId Object id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIcon(objectType: DeleteIconObjectTypeBeta, objectId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIcon(objectType, objectId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsBetaApi.deleteIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeBeta} objectType Object type - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setIcon(objectType: SetIconObjectTypeBeta, objectId: string, image: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setIcon(objectType, objectId, image, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsBetaApi.setIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IconsBetaApi - factory interface - * @export - */ -export const IconsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IconsBetaApiFp(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsBetaApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon(requestParameters: IconsBetaApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIcon(requestParameters.objectType, requestParameters.objectId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsBetaApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon(requestParameters: IconsBetaApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIcon operation in IconsBetaApi. - * @export - * @interface IconsBetaApiDeleteIconRequest - */ -export interface IconsBetaApiDeleteIconRequest { - /** - * Object type - * @type {'application'} - * @memberof IconsBetaApiDeleteIcon - */ - readonly objectType: DeleteIconObjectTypeBeta - - /** - * Object id. - * @type {string} - * @memberof IconsBetaApiDeleteIcon - */ - readonly objectId: string -} - -/** - * Request parameters for setIcon operation in IconsBetaApi. - * @export - * @interface IconsBetaApiSetIconRequest - */ -export interface IconsBetaApiSetIconRequest { - /** - * Object type - * @type {'application'} - * @memberof IconsBetaApiSetIcon - */ - readonly objectType: SetIconObjectTypeBeta - - /** - * Object id. - * @type {string} - * @memberof IconsBetaApiSetIcon - */ - readonly objectId: string - - /** - * file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @type {File} - * @memberof IconsBetaApiSetIcon - */ - readonly image: File -} - -/** - * IconsBetaApi - object-oriented interface - * @export - * @class IconsBetaApi - * @extends {BaseAPI} - */ -export class IconsBetaApi extends BaseAPI { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsBetaApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsBetaApi - */ - public deleteIcon(requestParameters: IconsBetaApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsBetaApiFp(this.configuration).deleteIcon(requestParameters.objectType, requestParameters.objectId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsBetaApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsBetaApi - */ - public setIcon(requestParameters: IconsBetaApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsBetaApiFp(this.configuration).setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteIconObjectTypeBeta = { - Application: 'application' -} as const; -export type DeleteIconObjectTypeBeta = typeof DeleteIconObjectTypeBeta[keyof typeof DeleteIconObjectTypeBeta]; -/** - * @export - */ -export const SetIconObjectTypeBeta = { - Application: 'application' -} as const; -export type SetIconObjectTypeBeta = typeof SetIconObjectTypeBeta[keyof typeof SetIconObjectTypeBeta]; - - -/** - * IdentitiesBetaApi - axios parameter creator - * @export - */ -export const IdentitiesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getIdentityOwnershipDetails', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/ownership` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignment', 'identityId', identityId) - // verify required parameter 'assignmentId' is not null or undefined - assertParamExists('getRoleAssignment', 'assignmentId', assignmentId) - const localVarPath = `/identities/{identityId}/role-assignments/{assignmentId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignments', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/role-assignments` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (roleId !== undefined) { - localVarQueryParameter['roleId'] = roleId; - } - - if (roleName !== undefined) { - localVarQueryParameter['roleName'] = roleName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterBeta} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterBeta, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (defaultFilter !== undefined) { - localVarQueryParameter['defaultFilter'] = defaultFilter; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('resetIdentity', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/reset` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestBeta} sendAccountVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken: async (id: string, sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'id', id) - // verify required parameter 'sendAccountVerificationRequestBeta' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'sendAccountVerificationRequestBeta', sendAccountVerificationRequestBeta) - const localVarPath = `/identities/{id}/verification/account/send` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendAccountVerificationRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestBeta} inviteIdentitiesRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite: async (inviteIdentitiesRequestBeta: InviteIdentitiesRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'inviteIdentitiesRequestBeta' is not null or undefined - assertParamExists('startIdentitiesInvite', 'inviteIdentitiesRequestBeta', inviteIdentitiesRequestBeta) - const localVarPath = `/identities/invite`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(inviteIdentitiesRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestBeta} processIdentitiesRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing: async (processIdentitiesRequestBeta: ProcessIdentitiesRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'processIdentitiesRequestBeta' is not null or undefined - assertParamExists('startIdentityProcessing', 'processIdentitiesRequestBeta', processIdentitiesRequestBeta) - const localVarPath = `/identities/process`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(processIdentitiesRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('synchronizeAttributesForIdentity', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/synchronize-attributes` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentitiesBetaApi - functional programming interface - * @export - */ -export const IdentitiesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentitiesBetaApiAxiosParamCreator(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.deleteIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.getIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOwnershipDetails(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetails(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.getIdentityOwnershipDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignment(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignment(identityId, assignmentId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.getRoleAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignments(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignments(identityId, roleId, roleName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.getRoleAssignments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterBeta} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentities(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterBeta, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentities(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.listIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetIdentity(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentity(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.resetIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestBeta} sendAccountVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountToken(id, sendAccountVerificationRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.sendIdentityVerificationAccountToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestBeta} inviteIdentitiesRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentitiesInvite(inviteIdentitiesRequestBeta: InviteIdentitiesRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInvite(inviteIdentitiesRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.startIdentitiesInvite']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestBeta} processIdentitiesRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentityProcessing(processIdentitiesRequestBeta: ProcessIdentitiesRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessing(processIdentitiesRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.startIdentityProcessing']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async synchronizeAttributesForIdentity(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentity(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesBetaApi.synchronizeAttributesForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentitiesBetaApi - factory interface - * @export - */ -export const IdentitiesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentitiesBetaApiFp(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesBetaApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity(requestParameters: IdentitiesBetaApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesBetaApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity(requestParameters: IdentitiesBetaApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesBetaApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails(requestParameters: IdentitiesBetaApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Role assignment details - * @param {IdentitiesBetaApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment(requestParameters: IdentitiesBetaApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesBetaApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments(requestParameters: IdentitiesBetaApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesBetaApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities(requestParameters: IdentitiesBetaApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesBetaApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity(requestParameters: IdentitiesBetaApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken(requestParameters: IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesBetaApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite(requestParameters: IdentitiesBetaApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentitiesInvite(requestParameters.inviteIdentitiesRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Process a list of identityids - * @param {IdentitiesBetaApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing(requestParameters: IdentitiesBetaApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentityProcessing(requestParameters.processIdentitiesRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesBetaApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity(requestParameters: IdentitiesBetaApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.synchronizeAttributesForIdentity(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIdentity operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiDeleteIdentityRequest - */ -export interface IdentitiesBetaApiDeleteIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesBetaApiDeleteIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentity operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiGetIdentityRequest - */ -export interface IdentitiesBetaApiGetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesBetaApiGetIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentityOwnershipDetails operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiGetIdentityOwnershipDetailsRequest - */ -export interface IdentitiesBetaApiGetIdentityOwnershipDetailsRequest { - /** - * Identity ID. - * @type {string} - * @memberof IdentitiesBetaApiGetIdentityOwnershipDetails - */ - readonly identityId: string -} - -/** - * Request parameters for getRoleAssignment operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiGetRoleAssignmentRequest - */ -export interface IdentitiesBetaApiGetRoleAssignmentRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesBetaApiGetRoleAssignment - */ - readonly identityId: string - - /** - * Assignment Id - * @type {string} - * @memberof IdentitiesBetaApiGetRoleAssignment - */ - readonly assignmentId: string -} - -/** - * Request parameters for getRoleAssignments operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiGetRoleAssignmentsRequest - */ -export interface IdentitiesBetaApiGetRoleAssignmentsRequest { - /** - * Identity Id to get the role assignments for - * @type {string} - * @memberof IdentitiesBetaApiGetRoleAssignments - */ - readonly identityId: string - - /** - * Role Id to filter the role assignments with - * @type {string} - * @memberof IdentitiesBetaApiGetRoleAssignments - */ - readonly roleId?: string - - /** - * Role name to filter the role assignments with - * @type {string} - * @memberof IdentitiesBetaApiGetRoleAssignments - */ - readonly roleName?: string -} - -/** - * Request parameters for listIdentities operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiListIdentitiesRequest - */ -export interface IdentitiesBetaApiListIdentitiesRequest { - /** - * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @type {string} - * @memberof IdentitiesBetaApiListIdentities - */ - 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: **name, alias, cloudStatus** - * @type {string} - * @memberof IdentitiesBetaApiListIdentities - */ - readonly sorters?: string - - /** - * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @type {'CORRELATED_ONLY' | 'NONE'} - * @memberof IdentitiesBetaApiListIdentities - */ - readonly defaultFilter?: ListIdentitiesDefaultFilterBeta - - /** - * 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 IdentitiesBetaApiListIdentities - */ - readonly count?: boolean - - /** - * 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 IdentitiesBetaApiListIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesBetaApiListIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for resetIdentity operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiResetIdentityRequest - */ -export interface IdentitiesBetaApiResetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesBetaApiResetIdentity - */ - readonly identityId: string -} - -/** - * Request parameters for sendIdentityVerificationAccountToken operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest - */ -export interface IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest { - /** - * Identity ID - * @type {string} - * @memberof IdentitiesBetaApiSendIdentityVerificationAccountToken - */ - readonly id: string - - /** - * - * @type {SendAccountVerificationRequestBeta} - * @memberof IdentitiesBetaApiSendIdentityVerificationAccountToken - */ - readonly sendAccountVerificationRequestBeta: SendAccountVerificationRequestBeta -} - -/** - * Request parameters for startIdentitiesInvite operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiStartIdentitiesInviteRequest - */ -export interface IdentitiesBetaApiStartIdentitiesInviteRequest { - /** - * - * @type {InviteIdentitiesRequestBeta} - * @memberof IdentitiesBetaApiStartIdentitiesInvite - */ - readonly inviteIdentitiesRequestBeta: InviteIdentitiesRequestBeta -} - -/** - * Request parameters for startIdentityProcessing operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiStartIdentityProcessingRequest - */ -export interface IdentitiesBetaApiStartIdentityProcessingRequest { - /** - * - * @type {ProcessIdentitiesRequestBeta} - * @memberof IdentitiesBetaApiStartIdentityProcessing - */ - readonly processIdentitiesRequestBeta: ProcessIdentitiesRequestBeta -} - -/** - * Request parameters for synchronizeAttributesForIdentity operation in IdentitiesBetaApi. - * @export - * @interface IdentitiesBetaApiSynchronizeAttributesForIdentityRequest - */ -export interface IdentitiesBetaApiSynchronizeAttributesForIdentityRequest { - /** - * The Identity id - * @type {string} - * @memberof IdentitiesBetaApiSynchronizeAttributesForIdentity - */ - readonly identityId: string -} - -/** - * IdentitiesBetaApi - object-oriented interface - * @export - * @class IdentitiesBetaApi - * @extends {BaseAPI} - */ -export class IdentitiesBetaApi extends BaseAPI { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesBetaApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public deleteIdentity(requestParameters: IdentitiesBetaApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).deleteIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesBetaApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public getIdentity(requestParameters: IdentitiesBetaApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).getIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesBetaApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public getIdentityOwnershipDetails(requestParameters: IdentitiesBetaApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Role assignment details - * @param {IdentitiesBetaApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public getRoleAssignment(requestParameters: IdentitiesBetaApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesBetaApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public getRoleAssignments(requestParameters: IdentitiesBetaApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesBetaApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public listIdentities(requestParameters: IdentitiesBetaApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesBetaApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public resetIdentity(requestParameters: IdentitiesBetaApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public sendIdentityVerificationAccountToken(requestParameters: IdentitiesBetaApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesBetaApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public startIdentitiesInvite(requestParameters: IdentitiesBetaApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).startIdentitiesInvite(requestParameters.inviteIdentitiesRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Process a list of identityids - * @param {IdentitiesBetaApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public startIdentityProcessing(requestParameters: IdentitiesBetaApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).startIdentityProcessing(requestParameters.processIdentitiesRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesBetaApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesBetaApi - */ - public synchronizeAttributesForIdentity(requestParameters: IdentitiesBetaApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesBetaApiFp(this.configuration).synchronizeAttributesForIdentity(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListIdentitiesDefaultFilterBeta = { - CorrelatedOnly: 'CORRELATED_ONLY', - None: 'NONE' -} as const; -export type ListIdentitiesDefaultFilterBeta = typeof ListIdentitiesDefaultFilterBeta[keyof typeof ListIdentitiesDefaultFilterBeta]; - - -/** - * IdentityAttributesBetaApi - axios parameter creator - * @export - */ -export const IdentityAttributesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Create identity attribute - * @param {IdentityAttributeBeta} identityAttributeBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute: async (identityAttributeBeta: IdentityAttributeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeBeta' is not null or undefined - assertParamExists('createIdentityAttribute', 'identityAttributeBeta', identityAttributeBeta) - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesBeta} identityAttributeNamesBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk: async (identityAttributeNamesBeta: IdentityAttributeNamesBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeNamesBeta' is not null or undefined - assertParamExists('deleteIdentityAttributesInBulk', 'identityAttributeNamesBeta', identityAttributeNamesBeta) - const localVarPath = `/identity-attributes/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeNamesBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes: async (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeSystem !== undefined) { - localVarQueryParameter['includeSystem'] = includeSystem; - } - - if (includeSilent !== undefined) { - localVarQueryParameter['includeSilent'] = includeSilent; - } - - if (searchableOnly !== undefined) { - localVarQueryParameter['searchableOnly'] = searchableOnly; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeBeta} identityAttributeBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute: async (name: string, identityAttributeBeta: IdentityAttributeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('putIdentityAttribute', 'name', name) - // verify required parameter 'identityAttributeBeta' is not null or undefined - assertParamExists('putIdentityAttribute', 'identityAttributeBeta', identityAttributeBeta) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityAttributesBetaApi - functional programming interface - * @export - */ -export const IdentityAttributesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityAttributesBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Create identity attribute - * @param {IdentityAttributeBeta} identityAttributeBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityAttribute(identityAttributeBeta: IdentityAttributeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityAttribute(identityAttributeBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.createIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.deleteIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesBeta} identityAttributeNamesBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttributesInBulk(identityAttributeNamesBeta: IdentityAttributeNamesBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributesInBulk(identityAttributeNamesBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.deleteIdentityAttributesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.getIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAttributes(includeSystem, includeSilent, searchableOnly, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.listIdentityAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeBeta} identityAttributeBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putIdentityAttribute(name: string, identityAttributeBeta: IdentityAttributeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityAttribute(name, identityAttributeBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesBetaApi.putIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityAttributesBetaApi - factory interface - * @export - */ -export const IdentityAttributesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityAttributesBetaApiFp(configuration) - return { - /** - * Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Create identity attribute - * @param {IdentityAttributesBetaApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute(requestParameters: IdentityAttributesBetaApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityAttribute(requestParameters.identityAttributeBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity attribute - * @param {IdentityAttributesBetaApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute(requestParameters: IdentityAttributesBetaApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesBetaApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute(requestParameters: IdentityAttributesBetaApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesBetaApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes(requestParameters: IdentityAttributesBetaApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. - * @summary Update identity attribute - * @param {IdentityAttributesBetaApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute(requestParameters: IdentityAttributesBetaApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityAttribute operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiCreateIdentityAttributeRequest - */ -export interface IdentityAttributesBetaApiCreateIdentityAttributeRequest { - /** - * - * @type {IdentityAttributeBeta} - * @memberof IdentityAttributesBetaApiCreateIdentityAttribute - */ - readonly identityAttributeBeta: IdentityAttributeBeta -} - -/** - * Request parameters for deleteIdentityAttribute operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiDeleteIdentityAttributeRequest - */ -export interface IdentityAttributesBetaApiDeleteIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesBetaApiDeleteIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for deleteIdentityAttributesInBulk operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest - */ -export interface IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest { - /** - * - * @type {IdentityAttributeNamesBeta} - * @memberof IdentityAttributesBetaApiDeleteIdentityAttributesInBulk - */ - readonly identityAttributeNamesBeta: IdentityAttributeNamesBeta -} - -/** - * Request parameters for getIdentityAttribute operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiGetIdentityAttributeRequest - */ -export interface IdentityAttributesBetaApiGetIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesBetaApiGetIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for listIdentityAttributes operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiListIdentityAttributesRequest - */ -export interface IdentityAttributesBetaApiListIdentityAttributesRequest { - /** - * Include \'system\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesBetaApiListIdentityAttributes - */ - readonly includeSystem?: boolean - - /** - * Include \'silent\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesBetaApiListIdentityAttributes - */ - readonly includeSilent?: boolean - - /** - * Include only \'searchable\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesBetaApiListIdentityAttributes - */ - readonly searchableOnly?: boolean - - /** - * 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 IdentityAttributesBetaApiListIdentityAttributes - */ - readonly count?: boolean -} - -/** - * Request parameters for putIdentityAttribute operation in IdentityAttributesBetaApi. - * @export - * @interface IdentityAttributesBetaApiPutIdentityAttributeRequest - */ -export interface IdentityAttributesBetaApiPutIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesBetaApiPutIdentityAttribute - */ - readonly name: string - - /** - * - * @type {IdentityAttributeBeta} - * @memberof IdentityAttributesBetaApiPutIdentityAttribute - */ - readonly identityAttributeBeta: IdentityAttributeBeta -} - -/** - * IdentityAttributesBetaApi - object-oriented interface - * @export - * @class IdentityAttributesBetaApi - * @extends {BaseAPI} - */ -export class IdentityAttributesBetaApi extends BaseAPI { - /** - * Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Create identity attribute - * @param {IdentityAttributesBetaApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public createIdentityAttribute(requestParameters: IdentityAttributesBetaApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).createIdentityAttribute(requestParameters.identityAttributeBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity attribute - * @param {IdentityAttributesBetaApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public deleteIdentityAttribute(requestParameters: IdentityAttributesBetaApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesBetaApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesBetaApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public getIdentityAttribute(requestParameters: IdentityAttributesBetaApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesBetaApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public listIdentityAttributes(requestParameters: IdentityAttributesBetaApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. - * @summary Update identity attribute - * @param {IdentityAttributesBetaApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesBetaApi - */ - public putIdentityAttribute(requestParameters: IdentityAttributesBetaApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesBetaApiFp(this.configuration).putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IdentityHistoryBetaApi - axios parameter creator - * @export - */ -export const IdentityHistoryBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshots', 'id', id) - const localVarPath = `/historical-identities/{id}/compare` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeBeta} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeBeta, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'id', id) - // verify required parameter 'accessType' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'accessType', accessType) - const localVarPath = `/historical-identities/{id}/compare/{accessType}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (accessAssociated !== undefined) { - localVarQueryParameter['access-associated'] = accessAssociated; - } - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentity', 'id', id) - const localVarPath = `/historical-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentityEvents', 'id', id) - const localVarPath = `/historical-identities/{id}/events` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (from !== undefined) { - localVarQueryParameter['from'] = from; - } - - if (eventTypes) { - localVarQueryParameter['eventTypes'] = eventTypes.join(COLLECTION_FORMATS.csv); - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot: async (id: string, date: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshot', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('getIdentitySnapshot', 'date', date) - const localVarPath = `/historical-identities/{id}/snapshots/{date}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalBeta} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalBeta, timeZone?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshotSummary', 'id', id) - const localVarPath = `/historical-identities/{id}/snapshot-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (before !== undefined) { - localVarQueryParameter['before'] = before; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (timeZone !== undefined) { - localVarQueryParameter['time-zone'] = timeZone; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityStartDate', 'id', id) - const localVarPath = `/historical-identities/{id}/start-date` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/historical-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (startsWithQuery !== undefined) { - localVarQueryParameter['starts-with-query'] = startsWithQuery; - } - - if (isDeleted !== undefined) { - localVarQueryParameter['is-deleted'] = isDeleted; - } - - if (isActive !== undefined) { - localVarQueryParameter['is-active'] = isActive; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeBeta} [type] The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** - * @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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* - * @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: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** - * @param {string} [query] This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems: async (id: string, type?: ListIdentityAccessItemsTypeBeta, filters?: string, sorters?: string, query?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessItems', 'id', id) - const localVarPath = `/historical-identities/{id}/access-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of identity access items at a specified date, filtered by item type. - * @summary Get identity access items snapshot - * @param {string} id Identity ID. - * @param {string} date Specified date. - * @param {ListIdentitySnapshotAccessItemsTypeBeta} [type] Access item type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems: async (id: string, date: string, type?: ListIdentitySnapshotAccessItemsTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'date', date) - const localVarPath = `/historical-identities/{id}/snapshots/{date}/access-items` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalBeta} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots: async (id: string, start?: string, interval?: ListIdentitySnapshotsIntervalBeta, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshots', 'id', id) - const localVarPath = `/historical-identities/{id}/snapshots` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityHistoryBetaApi - functional programming interface - * @export - */ -export const IdentityHistoryBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityHistoryBetaApiAxiosParamCreator(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshots(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshots(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.compareIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeBeta} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshotsAccessType(id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeBeta, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessType(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.compareIdentitySnapshotsAccessType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.getHistoricalIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentityEvents(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEvents(id, from, eventTypes, accessItemTypes, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.getHistoricalIdentityEvents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshot(id: string, date: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshot(id, date, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.getIdentitySnapshot']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalBeta} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshotSummary(id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalBeta, timeZone?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummary(id, before, interval, timeZone, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.getIdentitySnapshotSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityStartDate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.getIdentityStartDate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentities(startsWithQuery, isDeleted, isActive, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.listHistoricalIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeBeta} [type] The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** - * @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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* - * @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: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** - * @param {string} [query] This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessItems(id: string, type?: ListIdentityAccessItemsTypeBeta, filters?: string, sorters?: string, query?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, filters, sorters, query, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.listIdentityAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of identity access items at a specified date, filtered by item type. - * @summary Get identity access items snapshot - * @param {string} id Identity ID. - * @param {string} date Specified date. - * @param {ListIdentitySnapshotAccessItemsTypeBeta} [type] Access item type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshotAccessItems(id: string, date: string, type?: ListIdentitySnapshotAccessItemsTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItems(id, date, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.listIdentitySnapshotAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalBeta} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshots(id: string, start?: string, interval?: ListIdentitySnapshotsIntervalBeta, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshots(id, start, interval, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryBetaApi.listIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityHistoryBetaApi - factory interface - * @export - */ -export const IdentityHistoryBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityHistoryBetaApiFp(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryBetaApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots(requestParameters: IdentityHistoryBetaApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryBetaApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity(requestParameters: IdentityHistoryBetaApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getHistoricalIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents(requestParameters: IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryBetaApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot(requestParameters: IdentityHistoryBetaApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySnapshot(requestParameters.id, requestParameters.date, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary(requestParameters: IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryBetaApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate(requestParameters: IdentityHistoryBetaApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityStartDate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryBetaApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities(requestParameters: IdentityHistoryBetaApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryBetaApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems(requestParameters: IdentityHistoryBetaApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.query, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of identity access items at a specified date, filtered by item type. - * @summary Get identity access items snapshot - * @param {IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryBetaApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots(requestParameters: IdentityHistoryBetaApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for compareIdentitySnapshots operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiCompareIdentitySnapshotsRequest - */ -export interface IdentityHistoryBetaApiCompareIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly id: string - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly snapshot2?: string - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshots - */ - readonly count?: boolean -} - -/** - * Request parameters for compareIdentitySnapshotsAccessType operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest - */ -export interface IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly id: string - - /** - * The specific type which needs to be compared - * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly accessType: CompareIdentitySnapshotsAccessTypeAccessTypeBeta - - /** - * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @type {boolean} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly accessAssociated?: boolean - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot2?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryBetaApiCompareIdentitySnapshotsAccessType - */ - readonly count?: boolean -} - -/** - * Request parameters for getHistoricalIdentity operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiGetHistoricalIdentityRequest - */ -export interface IdentityHistoryBetaApiGetHistoricalIdentityRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentity - */ - readonly id: string -} - -/** - * Request parameters for getHistoricalIdentityEvents operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest - */ -export interface IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly id: string - - /** - * The optional instant until which access events are returned - * @type {string} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly from?: string - - /** - * An optional list of event types to return. If null or empty, all events are returned - * @type {Array} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly eventTypes?: Array - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryBetaApiGetHistoricalIdentityEvents - */ - readonly count?: boolean -} - -/** - * Request parameters for getIdentitySnapshot operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiGetIdentitySnapshotRequest - */ -export interface IdentityHistoryBetaApiGetIdentitySnapshotRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshot - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshot - */ - readonly date: string -} - -/** - * Request parameters for getIdentitySnapshotSummary operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest - */ -export interface IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly id: string - - /** - * The date before which snapshot summary is required - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly before?: string - - /** - * The interval indicating day or month. Defaults to month if not specified - * @type {'day' | 'month'} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly interval?: GetIdentitySnapshotSummaryIntervalBeta - - /** - * The time zone. Defaults to UTC if not provided - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly timeZone?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryBetaApiGetIdentitySnapshotSummary - */ - readonly count?: boolean -} - -/** - * Request parameters for getIdentityStartDate operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiGetIdentityStartDateRequest - */ -export interface IdentityHistoryBetaApiGetIdentityStartDateRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiGetIdentityStartDate - */ - readonly id: string -} - -/** - * Request parameters for listHistoricalIdentities operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiListHistoricalIdentitiesRequest - */ -export interface IdentityHistoryBetaApiListHistoricalIdentitiesRequest { - /** - * This param is used for starts-with search for first, last and display name of the identity - * @type {string} - * @memberof IdentityHistoryBetaApiListHistoricalIdentities - */ - readonly startsWithQuery?: string - - /** - * Indicates if we want to only list down deleted identities or not. - * @type {boolean} - * @memberof IdentityHistoryBetaApiListHistoricalIdentities - */ - readonly isDeleted?: boolean - - /** - * Indicates if we want to only list active or inactive identities. - * @type {boolean} - * @memberof IdentityHistoryBetaApiListHistoricalIdentities - */ - readonly isActive?: boolean - - /** - * 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 IdentityHistoryBetaApiListHistoricalIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiListHistoricalIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for listIdentityAccessItems operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiListIdentityAccessItemsRequest - */ -export interface IdentityHistoryBetaApiListIdentityAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly id: string - - /** - * The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** - * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly type?: ListIdentityAccessItemsTypeBeta - - /** - * 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: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - 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: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly sorters?: string - - /** - * This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly query?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiListIdentityAccessItems - */ - 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 IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly count?: boolean - - /** - * 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 IdentityHistoryBetaApiListIdentityAccessItems - */ - readonly offset?: number -} - -/** - * Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest - */ -export interface IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest { - /** - * Identity ID. - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems - */ - readonly id: string - - /** - * Specified date. - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems - */ - readonly date: string - - /** - * Access item type. - * @type {'role' | 'access_profile' | 'entitlement' | 'app' | 'account'} - * @memberof IdentityHistoryBetaApiListIdentitySnapshotAccessItems - */ - readonly type?: ListIdentitySnapshotAccessItemsTypeBeta -} - -/** - * Request parameters for listIdentitySnapshots operation in IdentityHistoryBetaApi. - * @export - * @interface IdentityHistoryBetaApiListIdentitySnapshotsRequest - */ -export interface IdentityHistoryBetaApiListIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly id: string - - /** - * The specified start date - * @type {string} - * @memberof IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly start?: string - - /** - * The interval indicating the range in day or month for the specified interval-name - * @type {'day' | 'month'} - * @memberof IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly interval?: ListIdentitySnapshotsIntervalBeta - - /** - * 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 IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryBetaApiListIdentitySnapshots - */ - readonly count?: boolean -} - -/** - * IdentityHistoryBetaApi - object-oriented interface - * @export - * @class IdentityHistoryBetaApi - * @extends {BaseAPI} - */ -export class IdentityHistoryBetaApi extends BaseAPI { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryBetaApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public compareIdentitySnapshots(requestParameters: IdentityHistoryBetaApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryBetaApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryBetaApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public getHistoricalIdentity(requestParameters: IdentityHistoryBetaApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).getHistoricalIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public getHistoricalIdentityEvents(requestParameters: IdentityHistoryBetaApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryBetaApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public getIdentitySnapshot(requestParameters: IdentityHistoryBetaApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).getIdentitySnapshot(requestParameters.id, requestParameters.date, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public getIdentitySnapshotSummary(requestParameters: IdentityHistoryBetaApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryBetaApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public getIdentityStartDate(requestParameters: IdentityHistoryBetaApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).getIdentityStartDate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryBetaApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public listHistoricalIdentities(requestParameters: IdentityHistoryBetaApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryBetaApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public listIdentityAccessItems(requestParameters: IdentityHistoryBetaApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.query, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of identity access items at a specified date, filtered by item type. - * @summary Get identity access items snapshot - * @param {IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryBetaApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryBetaApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryBetaApi - */ - public listIdentitySnapshots(requestParameters: IdentityHistoryBetaApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryBetaApiFp(this.configuration).listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const CompareIdentitySnapshotsAccessTypeAccessTypeBeta = { - AccessProfile: 'accessProfile', - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role' -} as const; -export type CompareIdentitySnapshotsAccessTypeAccessTypeBeta = typeof CompareIdentitySnapshotsAccessTypeAccessTypeBeta[keyof typeof CompareIdentitySnapshotsAccessTypeAccessTypeBeta]; -/** - * @export - */ -export const GetIdentitySnapshotSummaryIntervalBeta = { - Day: 'day', - Month: 'month' -} as const; -export type GetIdentitySnapshotSummaryIntervalBeta = typeof GetIdentitySnapshotSummaryIntervalBeta[keyof typeof GetIdentitySnapshotSummaryIntervalBeta]; -/** - * @export - */ -export const ListIdentityAccessItemsTypeBeta = { - Account: 'account', - Entitlement: 'entitlement', - App: 'app', - AccessProfile: 'accessProfile', - Role: 'role' -} as const; -export type ListIdentityAccessItemsTypeBeta = typeof ListIdentityAccessItemsTypeBeta[keyof typeof ListIdentityAccessItemsTypeBeta]; -/** - * @export - */ -export const ListIdentitySnapshotAccessItemsTypeBeta = { - Role: 'role', - AccessProfile: 'access_profile', - Entitlement: 'entitlement', - App: 'app', - Account: 'account' -} as const; -export type ListIdentitySnapshotAccessItemsTypeBeta = typeof ListIdentitySnapshotAccessItemsTypeBeta[keyof typeof ListIdentitySnapshotAccessItemsTypeBeta]; -/** - * @export - */ -export const ListIdentitySnapshotsIntervalBeta = { - Day: 'day', - Month: 'month' -} as const; -export type ListIdentitySnapshotsIntervalBeta = typeof ListIdentitySnapshotsIntervalBeta[keyof typeof ListIdentitySnapshotsIntervalBeta]; - - -/** - * IdentityProfilesBetaApi - axios parameter creator - * @export - */ -export const IdentityProfilesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. - * @summary Create identity profile - * @param {IdentityProfileBeta} identityProfileBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile: async (identityProfileBeta: IdentityProfileBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileBeta' is not null or undefined - assertParamExists('createIdentityProfile', 'identityProfileBeta', identityProfileBeta) - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteIdentityProfiles', 'requestBody', requestBody) - const localVarPath = `/identity-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This returns the default identity attribute config A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - * @summary Default identity attribute config - * @param {string} identityProfileId The Identity Profile ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectBeta Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles: async (identityProfileExportedObjectBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileExportedObjectBeta' is not null or undefined - assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectBeta', identityProfileExportedObjectBeta) - const localVarPath = `/identity-profiles/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showGenerateIdentityPreview: async (identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityPreviewRequestBeta' is not null or undefined - assertParamExists('showGenerateIdentityPreview', 'identityPreviewRequestBeta', identityPreviewRequestBeta) - const localVarPath = `/identity-profiles/identity-preview`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('syncIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/process-identities` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. These fields cannot be updated: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationBeta List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile: async (identityProfileId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateIdentityProfile', 'identityProfileId', identityProfileId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateIdentityProfile', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityProfilesBetaApi - functional programming interface - * @export - */ -export const IdentityProfilesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityProfilesBetaApiAxiosParamCreator(configuration) - return { - /** - * Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. - * @summary Create identity profile - * @param {IdentityProfileBeta} identityProfileBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityProfile(identityProfileBeta: IdentityProfileBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfile(identityProfileBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.createIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.deleteIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfiles(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfiles(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.deleteIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.exportIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns the default identity attribute config A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - * @summary Default identity attribute config - * @param {string} identityProfileId The Identity Profile ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.getDefaultIdentityAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.getIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectBeta Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importIdentityProfiles(identityProfileExportedObjectBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfiles(identityProfileExportedObjectBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.importIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.listIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestBeta} identityPreviewRequestBeta Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showGenerateIdentityPreview(identityPreviewRequestBeta: IdentityPreviewRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showGenerateIdentityPreview(identityPreviewRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.showGenerateIdentityPreview']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.syncIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. These fields cannot be updated: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationBeta List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateIdentityProfile(identityProfileId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfile(identityProfileId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesBetaApi.updateIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityProfilesBetaApi - factory interface - * @export - */ -export const IdentityProfilesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityProfilesBetaApiFp(configuration) - return { - /** - * Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. - * @summary Create identity profile - * @param {IdentityProfilesBetaApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile(requestParameters: IdentityProfilesBetaApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityProfile(requestParameters.identityProfileBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity profile - * @param {IdentityProfilesBetaApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile(requestParameters: IdentityProfilesBetaApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesBetaApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles(requestParameters: IdentityProfilesBetaApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesBetaApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles(requestParameters: IdentityProfilesBetaApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns the default identity attribute config A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - * @summary Default identity attribute config - * @param {IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get identity profile - * @param {IdentityProfilesBetaApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile(requestParameters: IdentityProfilesBetaApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesBetaApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles(requestParameters: IdentityProfilesBetaApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importIdentityProfiles(requestParameters.identityProfileExportedObjectBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - * @summary List identity profiles - * @param {IdentityProfilesBetaApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles(requestParameters: IdentityProfilesBetaApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. - * @summary Generate identity profile preview - * @param {IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showGenerateIdentityPreview(requestParameters: IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showGenerateIdentityPreview(requestParameters.identityPreviewRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API. - * @summary Process identities under profile - * @param {IdentityProfilesBetaApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile(requestParameters: IdentityProfilesBetaApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. These fields cannot be updated: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. - * @summary Update identity profile - * @param {IdentityProfilesBetaApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile(requestParameters: IdentityProfilesBetaApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityProfile operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiCreateIdentityProfileRequest - */ -export interface IdentityProfilesBetaApiCreateIdentityProfileRequest { - /** - * - * @type {IdentityProfileBeta} - * @memberof IdentityProfilesBetaApiCreateIdentityProfile - */ - readonly identityProfileBeta: IdentityProfileBeta -} - -/** - * Request parameters for deleteIdentityProfile operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiDeleteIdentityProfileRequest - */ -export interface IdentityProfilesBetaApiDeleteIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesBetaApiDeleteIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for deleteIdentityProfiles operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiDeleteIdentityProfilesRequest - */ -export interface IdentityProfilesBetaApiDeleteIdentityProfilesRequest { - /** - * Identity Profile bulk delete request body. - * @type {Array} - * @memberof IdentityProfilesBetaApiDeleteIdentityProfiles - */ - readonly requestBody: Array -} - -/** - * Request parameters for exportIdentityProfiles operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiExportIdentityProfilesRequest - */ -export interface IdentityProfilesBetaApiExportIdentityProfilesRequest { - /** - * 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 IdentityProfilesBetaApiExportIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesBetaApiExportIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesBetaApiExportIdentityProfiles - */ - 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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesBetaApiExportIdentityProfiles - */ - 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, name, priority** - * @type {string} - * @memberof IdentityProfilesBetaApiExportIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest - */ -export interface IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest { - /** - * The Identity Profile ID - * @type {string} - * @memberof IdentityProfilesBetaApiGetDefaultIdentityAttributeConfig - */ - readonly identityProfileId: string -} - -/** - * Request parameters for getIdentityProfile operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiGetIdentityProfileRequest - */ -export interface IdentityProfilesBetaApiGetIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesBetaApiGetIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for importIdentityProfiles operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiImportIdentityProfilesRequest - */ -export interface IdentityProfilesBetaApiImportIdentityProfilesRequest { - /** - * Previously exported Identity Profiles. - * @type {Array} - * @memberof IdentityProfilesBetaApiImportIdentityProfiles - */ - readonly identityProfileExportedObjectBeta: Array -} - -/** - * Request parameters for listIdentityProfiles operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiListIdentityProfilesRequest - */ -export interface IdentityProfilesBetaApiListIdentityProfilesRequest { - /** - * 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 IdentityProfilesBetaApiListIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesBetaApiListIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesBetaApiListIdentityProfiles - */ - 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesBetaApiListIdentityProfiles - */ - 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, name, priority, created, modified, owner.id, owner.name** - * @type {string} - * @memberof IdentityProfilesBetaApiListIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for showGenerateIdentityPreview operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest - */ -export interface IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest { - /** - * Identity Preview request body. - * @type {IdentityPreviewRequestBeta} - * @memberof IdentityProfilesBetaApiShowGenerateIdentityPreview - */ - readonly identityPreviewRequestBeta: IdentityPreviewRequestBeta -} - -/** - * Request parameters for syncIdentityProfile operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiSyncIdentityProfileRequest - */ -export interface IdentityProfilesBetaApiSyncIdentityProfileRequest { - /** - * The Identity Profile ID to be processed - * @type {string} - * @memberof IdentityProfilesBetaApiSyncIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for updateIdentityProfile operation in IdentityProfilesBetaApi. - * @export - * @interface IdentityProfilesBetaApiUpdateIdentityProfileRequest - */ -export interface IdentityProfilesBetaApiUpdateIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesBetaApiUpdateIdentityProfile - */ - readonly identityProfileId: string - - /** - * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof IdentityProfilesBetaApiUpdateIdentityProfile - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * IdentityProfilesBetaApi - object-oriented interface - * @export - * @class IdentityProfilesBetaApi - * @extends {BaseAPI} - */ -export class IdentityProfilesBetaApi extends BaseAPI { - /** - * Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. - * @summary Create identity profile - * @param {IdentityProfilesBetaApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public createIdentityProfile(requestParameters: IdentityProfilesBetaApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).createIdentityProfile(requestParameters.identityProfileBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete identity profile - * @param {IdentityProfilesBetaApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public deleteIdentityProfile(requestParameters: IdentityProfilesBetaApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesBetaApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public deleteIdentityProfiles(requestParameters: IdentityProfilesBetaApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesBetaApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public exportIdentityProfiles(requestParameters: IdentityProfilesBetaApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns the default identity attribute config A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - * @summary Default identity attribute config - * @param {IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesBetaApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get identity profile - * @param {IdentityProfilesBetaApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public getIdentityProfile(requestParameters: IdentityProfilesBetaApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesBetaApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public importIdentityProfiles(requestParameters: IdentityProfilesBetaApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).importIdentityProfiles(requestParameters.identityProfileExportedObjectBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - * @summary List identity profiles - * @param {IdentityProfilesBetaApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public listIdentityProfiles(requestParameters: IdentityProfilesBetaApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. - * @summary Generate identity profile preview - * @param {IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public showGenerateIdentityPreview(requestParameters: IdentityProfilesBetaApiShowGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).showGenerateIdentityPreview(requestParameters.identityPreviewRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API. - * @summary Process identities under profile - * @param {IdentityProfilesBetaApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public syncIdentityProfile(requestParameters: IdentityProfilesBetaApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. These fields cannot be updated: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. - * @summary Update identity profile - * @param {IdentityProfilesBetaApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesBetaApi - */ - public updateIdentityProfile(requestParameters: IdentityProfilesBetaApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesBetaApiFp(this.configuration).updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LaunchersBetaApi - axios parameter creator - * @export - */ -export const LaunchersBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestBeta} launcherRequestBeta Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher: async (launcherRequestBeta: LauncherRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherRequestBeta' is not null or undefined - assertParamExists('createLauncher', 'launcherRequestBeta', launcherRequestBeta) - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('deleteLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('getLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers: async (filters?: string, next?: string, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (next !== undefined) { - localVarQueryParameter['next'] = next; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestBeta} launcherRequestBeta Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher: async (launcherID: string, launcherRequestBeta: LauncherRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('putLauncher', 'launcherID', launcherID) - // verify required parameter 'launcherRequestBeta' is not null or undefined - assertParamExists('putLauncher', 'launcherRequestBeta', launcherRequestBeta) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('startLauncher', 'launcherID', launcherID) - const localVarPath = `/beta/launchers/{launcherID}/launch` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LaunchersBetaApi - functional programming interface - * @export - */ -export const LaunchersBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LaunchersBetaApiAxiosParamCreator(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestBeta} launcherRequestBeta Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLauncher(launcherRequestBeta: LauncherRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLauncher(launcherRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.createLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.deleteLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.getLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLaunchers(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLaunchers(filters, next, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.getLaunchers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestBeta} launcherRequestBeta Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putLauncher(launcherID: string, launcherRequestBeta: LauncherRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putLauncher(launcherID, launcherRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.putLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersBetaApi.startLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LaunchersBetaApi - factory interface - * @export - */ -export const LaunchersBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LaunchersBetaApiFp(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersBetaApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher(requestParameters: LaunchersBetaApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLauncher(requestParameters.launcherRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersBetaApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher(requestParameters: LaunchersBetaApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersBetaApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher(requestParameters: LaunchersBetaApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersBetaApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers(requestParameters: LaunchersBetaApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersBetaApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher(requestParameters: LaunchersBetaApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putLauncher(requestParameters.launcherID, requestParameters.launcherRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersBetaApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher(requestParameters: LaunchersBetaApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLauncher operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiCreateLauncherRequest - */ -export interface LaunchersBetaApiCreateLauncherRequest { - /** - * Payload to create a Launcher - * @type {LauncherRequestBeta} - * @memberof LaunchersBetaApiCreateLauncher - */ - readonly launcherRequestBeta: LauncherRequestBeta -} - -/** - * Request parameters for deleteLauncher operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiDeleteLauncherRequest - */ -export interface LaunchersBetaApiDeleteLauncherRequest { - /** - * ID of the Launcher to be deleted - * @type {string} - * @memberof LaunchersBetaApiDeleteLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLauncher operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiGetLauncherRequest - */ -export interface LaunchersBetaApiGetLauncherRequest { - /** - * ID of the Launcher to be retrieved - * @type {string} - * @memberof LaunchersBetaApiGetLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLaunchers operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiGetLaunchersRequest - */ -export interface LaunchersBetaApiGetLaunchersRequest { - /** - * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @type {string} - * @memberof LaunchersBetaApiGetLaunchers - */ - readonly filters?: string - - /** - * Pagination marker - * @type {string} - * @memberof LaunchersBetaApiGetLaunchers - */ - readonly next?: string - - /** - * Number of Launchers to return - * @type {number} - * @memberof LaunchersBetaApiGetLaunchers - */ - readonly limit?: number -} - -/** - * Request parameters for putLauncher operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiPutLauncherRequest - */ -export interface LaunchersBetaApiPutLauncherRequest { - /** - * ID of the Launcher to be replaced - * @type {string} - * @memberof LaunchersBetaApiPutLauncher - */ - readonly launcherID: string - - /** - * Payload to replace Launcher - * @type {LauncherRequestBeta} - * @memberof LaunchersBetaApiPutLauncher - */ - readonly launcherRequestBeta: LauncherRequestBeta -} - -/** - * Request parameters for startLauncher operation in LaunchersBetaApi. - * @export - * @interface LaunchersBetaApiStartLauncherRequest - */ -export interface LaunchersBetaApiStartLauncherRequest { - /** - * ID of the Launcher to be launched - * @type {string} - * @memberof LaunchersBetaApiStartLauncher - */ - readonly launcherID: string -} - -/** - * LaunchersBetaApi - object-oriented interface - * @export - * @class LaunchersBetaApi - * @extends {BaseAPI} - */ -export class LaunchersBetaApi extends BaseAPI { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersBetaApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public createLauncher(requestParameters: LaunchersBetaApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).createLauncher(requestParameters.launcherRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersBetaApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public deleteLauncher(requestParameters: LaunchersBetaApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersBetaApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public getLauncher(requestParameters: LaunchersBetaApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersBetaApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public getLaunchers(requestParameters: LaunchersBetaApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersBetaApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public putLauncher(requestParameters: LaunchersBetaApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).putLauncher(requestParameters.launcherID, requestParameters.launcherRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersBetaApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersBetaApi - */ - public startLauncher(requestParameters: LaunchersBetaApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersBetaApiFp(this.configuration).startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LifecycleStatesBetaApi - axios parameter creator - * @export - */ -export const LifecycleStatesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity Profile ID. - * @param {string} lifecycleStateId Lifecycle State ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('getLifecycleStates', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity Profile ID. - * @param {string} lifecycleStateId Lifecycle State ID. - * @param {Array} jsonPatchOperationBeta A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('updateLifecycleStates', 'lifecycleStateId', lifecycleStateId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateLifecycleStates', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LifecycleStatesBetaApi - functional programming interface - * @export - */ -export const LifecycleStatesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LifecycleStatesBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity Profile ID. - * @param {string} lifecycleStateId Lifecycle State ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleStates(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStates(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesBetaApi.getLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity Profile ID. - * @param {string} lifecycleStateId Lifecycle State ID. - * @param {Array} jsonPatchOperationBeta A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateLifecycleStates(identityProfileId: string, lifecycleStateId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStates(identityProfileId, lifecycleStateId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesBetaApi.updateLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LifecycleStatesBetaApi - factory interface - * @export - */ -export const LifecycleStatesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LifecycleStatesBetaApiFp(configuration) - return { - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get lifecycle state - * @param {LifecycleStatesBetaApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates(requestParameters: LifecycleStatesBetaApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update lifecycle state - * @param {LifecycleStatesBetaApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates(requestParameters: LifecycleStatesBetaApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getLifecycleStates operation in LifecycleStatesBetaApi. - * @export - * @interface LifecycleStatesBetaApiGetLifecycleStatesRequest - */ -export interface LifecycleStatesBetaApiGetLifecycleStatesRequest { - /** - * Identity Profile ID. - * @type {string} - * @memberof LifecycleStatesBetaApiGetLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle State ID. - * @type {string} - * @memberof LifecycleStatesBetaApiGetLifecycleStates - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for updateLifecycleStates operation in LifecycleStatesBetaApi. - * @export - * @interface LifecycleStatesBetaApiUpdateLifecycleStatesRequest - */ -export interface LifecycleStatesBetaApiUpdateLifecycleStatesRequest { - /** - * Identity Profile ID. - * @type {string} - * @memberof LifecycleStatesBetaApiUpdateLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle State ID. - * @type {string} - * @memberof LifecycleStatesBetaApiUpdateLifecycleStates - */ - readonly lifecycleStateId: string - - /** - * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @type {Array} - * @memberof LifecycleStatesBetaApiUpdateLifecycleStates - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * LifecycleStatesBetaApi - object-oriented interface - * @export - * @class LifecycleStatesBetaApi - * @extends {BaseAPI} - */ -export class LifecycleStatesBetaApi extends BaseAPI { - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get lifecycle state - * @param {LifecycleStatesBetaApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesBetaApi - */ - public getLifecycleStates(requestParameters: LifecycleStatesBetaApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesBetaApiFp(this.configuration).getLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update lifecycle state - * @param {LifecycleStatesBetaApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesBetaApi - */ - public updateLifecycleStates(requestParameters: LifecycleStatesBetaApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesBetaApiFp(this.configuration).updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MFAConfigurationBetaApi - axios parameter creator - * @export - */ -export const MFAConfigurationBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {DeleteMFAConfigMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMFAConfig: async (method: DeleteMFAConfigMethodBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('deleteMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/delete` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/duo-web/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/kba/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (allLanguages !== undefined) { - localVarQueryParameter['allLanguages'] = allLanguages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/okta-verify/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigBeta} mfaDuoConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig: async (mfaDuoConfigBeta: MfaDuoConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaDuoConfigBeta' is not null or undefined - assertParamExists('setMFADuoConfig', 'mfaDuoConfigBeta', mfaDuoConfigBeta) - const localVarPath = `/mfa/duo-web/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaDuoConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig: async (kbaAnswerRequestItemBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItemBeta' is not null or undefined - assertParamExists('setMFAKBAConfig', 'kbaAnswerRequestItemBeta', kbaAnswerRequestItemBeta) - const localVarPath = `/mfa/kba/config/answers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItemBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigBeta} mfaOktaConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig: async (mfaOktaConfigBeta: MfaOktaConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaOktaConfigBeta' is not null or undefined - assertParamExists('setMFAOktaConfig', 'mfaOktaConfigBeta', mfaOktaConfigBeta) - const localVarPath = `/mfa/okta-verify/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaOktaConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig: async (method: TestMFAConfigMethodBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('testMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/test` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAConfigurationBetaApi - functional programming interface - * @export - */ -export const MFAConfigurationBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAConfigurationBetaApiAxiosParamCreator(configuration) - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {DeleteMFAConfigMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMFAConfig(method: DeleteMFAConfigMethodBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.deleteMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.getMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAKbaConfig(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfig(allLanguages, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.getMFAKbaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.getMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigBeta} mfaDuoConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFADuoConfig(mfaDuoConfigBeta: MfaDuoConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfig(mfaDuoConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.setMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAKBAConfig(kbaAnswerRequestItemBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfig(kbaAnswerRequestItemBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.setMFAKBAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigBeta} mfaOktaConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAOktaConfig(mfaOktaConfigBeta: MfaOktaConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfig(mfaOktaConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.setMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testMFAConfig(method: TestMFAConfigMethodBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationBetaApi.testMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAConfigurationBetaApi - factory interface - * @export - */ -export const MFAConfigurationBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAConfigurationBetaApiFp(configuration) - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {MFAConfigurationBetaApiDeleteMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMFAConfig(requestParameters: MFAConfigurationBetaApiDeleteMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFADuoConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationBetaApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig(requestParameters: MFAConfigurationBetaApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFAOktaConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationBetaApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig(requestParameters: MFAConfigurationBetaApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFADuoConfig(requestParameters.mfaDuoConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationBetaApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig(requestParameters: MFAConfigurationBetaApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMFAKBAConfig(requestParameters.kbaAnswerRequestItemBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationBetaApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig(requestParameters: MFAConfigurationBetaApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFAOktaConfig(requestParameters.mfaOktaConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationBetaApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig(requestParameters: MFAConfigurationBetaApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteMFAConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiDeleteMFAConfigRequest - */ -export interface MFAConfigurationBetaApiDeleteMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationBetaApiDeleteMFAConfig - */ - readonly method: DeleteMFAConfigMethodBeta -} - -/** - * Request parameters for getMFAKbaConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiGetMFAKbaConfigRequest - */ -export interface MFAConfigurationBetaApiGetMFAKbaConfigRequest { - /** - * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @type {boolean} - * @memberof MFAConfigurationBetaApiGetMFAKbaConfig - */ - readonly allLanguages?: boolean -} - -/** - * Request parameters for setMFADuoConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiSetMFADuoConfigRequest - */ -export interface MFAConfigurationBetaApiSetMFADuoConfigRequest { - /** - * - * @type {MfaDuoConfigBeta} - * @memberof MFAConfigurationBetaApiSetMFADuoConfig - */ - readonly mfaDuoConfigBeta: MfaDuoConfigBeta -} - -/** - * Request parameters for setMFAKBAConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiSetMFAKBAConfigRequest - */ -export interface MFAConfigurationBetaApiSetMFAKBAConfigRequest { - /** - * - * @type {Array} - * @memberof MFAConfigurationBetaApiSetMFAKBAConfig - */ - readonly kbaAnswerRequestItemBeta: Array -} - -/** - * Request parameters for setMFAOktaConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiSetMFAOktaConfigRequest - */ -export interface MFAConfigurationBetaApiSetMFAOktaConfigRequest { - /** - * - * @type {MfaOktaConfigBeta} - * @memberof MFAConfigurationBetaApiSetMFAOktaConfig - */ - readonly mfaOktaConfigBeta: MfaOktaConfigBeta -} - -/** - * Request parameters for testMFAConfig operation in MFAConfigurationBetaApi. - * @export - * @interface MFAConfigurationBetaApiTestMFAConfigRequest - */ -export interface MFAConfigurationBetaApiTestMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationBetaApiTestMFAConfig - */ - readonly method: TestMFAConfigMethodBeta -} - -/** - * MFAConfigurationBetaApi - object-oriented interface - * @export - * @class MFAConfigurationBetaApi - * @extends {BaseAPI} - */ -export class MFAConfigurationBetaApi extends BaseAPI { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {MFAConfigurationBetaApiDeleteMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public deleteMFAConfig(requestParameters: MFAConfigurationBetaApiDeleteMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).deleteMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).getMFADuoConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationBetaApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public getMFAKbaConfig(requestParameters: MFAConfigurationBetaApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).getMFAOktaConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationBetaApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public setMFADuoConfig(requestParameters: MFAConfigurationBetaApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).setMFADuoConfig(requestParameters.mfaDuoConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationBetaApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public setMFAKBAConfig(requestParameters: MFAConfigurationBetaApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).setMFAKBAConfig(requestParameters.kbaAnswerRequestItemBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationBetaApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public setMFAOktaConfig(requestParameters: MFAConfigurationBetaApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).setMFAOktaConfig(requestParameters.mfaOktaConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationBetaApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationBetaApi - */ - public testMFAConfig(requestParameters: MFAConfigurationBetaApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationBetaApiFp(this.configuration).testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteMFAConfigMethodBeta = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type DeleteMFAConfigMethodBeta = typeof DeleteMFAConfigMethodBeta[keyof typeof DeleteMFAConfigMethodBeta]; -/** - * @export - */ -export const TestMFAConfigMethodBeta = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type TestMFAConfigMethodBeta = typeof TestMFAConfigMethodBeta[keyof typeof TestMFAConfigMethodBeta]; - - -/** - * MFAControllerBetaApi - axios parameter creator - * @export - */ -export const MFAControllerBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {SendTokenRequestBeta} sendTokenRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSendToken: async (sendTokenRequestBeta: SendTokenRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTokenRequestBeta' is not null or undefined - assertParamExists('createSendToken', 'sendTokenRequestBeta', sendTokenRequestBeta) - const localVarPath = `/mfa/token/send`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTokenRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {PingVerificationStatusMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @param {VerificationPollRequestBeta} verificationPollRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingVerificationStatus: async (method: PingVerificationStatusMethodBeta, verificationPollRequestBeta: VerificationPollRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('pingVerificationStatus', 'method', method) - // verify required parameter 'verificationPollRequestBeta' is not null or undefined - assertParamExists('pingVerificationStatus', 'verificationPollRequestBeta', verificationPollRequestBeta) - const localVarPath = `/mfa/{method}/poll` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(verificationPollRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {DuoVerificationRequestBeta} duoVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDuoVerifyRequest: async (duoVerificationRequestBeta: DuoVerificationRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'duoVerificationRequestBeta' is not null or undefined - assertParamExists('sendDuoVerifyRequest', 'duoVerificationRequestBeta', duoVerificationRequestBeta) - const localVarPath = `/mfa/duo-web/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(duoVerificationRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {Array} kbaAnswerRequestItemBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendKbaAnswers: async (kbaAnswerRequestItemBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItemBeta' is not null or undefined - assertParamExists('sendKbaAnswers', 'kbaAnswerRequestItemBeta', kbaAnswerRequestItemBeta) - const localVarPath = `/mfa/kba/authenticate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItemBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {OktaVerificationRequestBeta} oktaVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendOktaVerifyRequest: async (oktaVerificationRequestBeta: OktaVerificationRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'oktaVerificationRequestBeta' is not null or undefined - assertParamExists('sendOktaVerifyRequest', 'oktaVerificationRequestBeta', oktaVerificationRequestBeta) - const localVarPath = `/mfa/okta-verify/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(oktaVerificationRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {TokenAuthRequestBeta} tokenAuthRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTokenAuthRequest: async (tokenAuthRequestBeta: TokenAuthRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tokenAuthRequestBeta' is not null or undefined - assertParamExists('sendTokenAuthRequest', 'tokenAuthRequestBeta', tokenAuthRequestBeta) - const localVarPath = `/mfa/token/authenticate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tokenAuthRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAControllerBetaApi - functional programming interface - * @export - */ -export const MFAControllerBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAControllerBetaApiAxiosParamCreator(configuration) - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {SendTokenRequestBeta} sendTokenRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSendToken(sendTokenRequestBeta: SendTokenRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSendToken(sendTokenRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.createSendToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {PingVerificationStatusMethodBeta} method The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @param {VerificationPollRequestBeta} verificationPollRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingVerificationStatus(method: PingVerificationStatusMethodBeta, verificationPollRequestBeta: VerificationPollRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingVerificationStatus(method, verificationPollRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.pingVerificationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {DuoVerificationRequestBeta} duoVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendDuoVerifyRequest(duoVerificationRequestBeta: DuoVerificationRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendDuoVerifyRequest(duoVerificationRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.sendDuoVerifyRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {Array} kbaAnswerRequestItemBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendKbaAnswers(kbaAnswerRequestItemBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendKbaAnswers(kbaAnswerRequestItemBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.sendKbaAnswers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {OktaVerificationRequestBeta} oktaVerificationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendOktaVerifyRequest(oktaVerificationRequestBeta: OktaVerificationRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendOktaVerifyRequest(oktaVerificationRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.sendOktaVerifyRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {TokenAuthRequestBeta} tokenAuthRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTokenAuthRequest(tokenAuthRequestBeta: TokenAuthRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTokenAuthRequest(tokenAuthRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerBetaApi.sendTokenAuthRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAControllerBetaApi - factory interface - * @export - */ -export const MFAControllerBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAControllerBetaApiFp(configuration) - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {MFAControllerBetaApiCreateSendTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSendToken(requestParameters: MFAControllerBetaApiCreateSendTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSendToken(requestParameters.sendTokenRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {MFAControllerBetaApiPingVerificationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingVerificationStatus(requestParameters: MFAControllerBetaApiPingVerificationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingVerificationStatus(requestParameters.method, requestParameters.verificationPollRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {MFAControllerBetaApiSendDuoVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDuoVerifyRequest(requestParameters: MFAControllerBetaApiSendDuoVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendDuoVerifyRequest(requestParameters.duoVerificationRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {MFAControllerBetaApiSendKbaAnswersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendKbaAnswers(requestParameters: MFAControllerBetaApiSendKbaAnswersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendKbaAnswers(requestParameters.kbaAnswerRequestItemBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {MFAControllerBetaApiSendOktaVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendOktaVerifyRequest(requestParameters: MFAControllerBetaApiSendOktaVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendOktaVerifyRequest(requestParameters.oktaVerificationRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {MFAControllerBetaApiSendTokenAuthRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTokenAuthRequest(requestParameters: MFAControllerBetaApiSendTokenAuthRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTokenAuthRequest(requestParameters.tokenAuthRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSendToken operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiCreateSendTokenRequest - */ -export interface MFAControllerBetaApiCreateSendTokenRequest { - /** - * - * @type {SendTokenRequestBeta} - * @memberof MFAControllerBetaApiCreateSendToken - */ - readonly sendTokenRequestBeta: SendTokenRequestBeta -} - -/** - * Request parameters for pingVerificationStatus operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiPingVerificationStatusRequest - */ -export interface MFAControllerBetaApiPingVerificationStatusRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @type {'okta-verify' | 'duo-web' | 'kba' | 'token' | 'rsa'} - * @memberof MFAControllerBetaApiPingVerificationStatus - */ - readonly method: PingVerificationStatusMethodBeta - - /** - * - * @type {VerificationPollRequestBeta} - * @memberof MFAControllerBetaApiPingVerificationStatus - */ - readonly verificationPollRequestBeta: VerificationPollRequestBeta -} - -/** - * Request parameters for sendDuoVerifyRequest operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiSendDuoVerifyRequestRequest - */ -export interface MFAControllerBetaApiSendDuoVerifyRequestRequest { - /** - * - * @type {DuoVerificationRequestBeta} - * @memberof MFAControllerBetaApiSendDuoVerifyRequest - */ - readonly duoVerificationRequestBeta: DuoVerificationRequestBeta -} - -/** - * Request parameters for sendKbaAnswers operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiSendKbaAnswersRequest - */ -export interface MFAControllerBetaApiSendKbaAnswersRequest { - /** - * - * @type {Array} - * @memberof MFAControllerBetaApiSendKbaAnswers - */ - readonly kbaAnswerRequestItemBeta: Array -} - -/** - * Request parameters for sendOktaVerifyRequest operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiSendOktaVerifyRequestRequest - */ -export interface MFAControllerBetaApiSendOktaVerifyRequestRequest { - /** - * - * @type {OktaVerificationRequestBeta} - * @memberof MFAControllerBetaApiSendOktaVerifyRequest - */ - readonly oktaVerificationRequestBeta: OktaVerificationRequestBeta -} - -/** - * Request parameters for sendTokenAuthRequest operation in MFAControllerBetaApi. - * @export - * @interface MFAControllerBetaApiSendTokenAuthRequestRequest - */ -export interface MFAControllerBetaApiSendTokenAuthRequestRequest { - /** - * - * @type {TokenAuthRequestBeta} - * @memberof MFAControllerBetaApiSendTokenAuthRequest - */ - readonly tokenAuthRequestBeta: TokenAuthRequestBeta -} - -/** - * MFAControllerBetaApi - object-oriented interface - * @export - * @class MFAControllerBetaApi - * @extends {BaseAPI} - */ -export class MFAControllerBetaApi extends BaseAPI { - /** - * This API send token request. - * @summary Create and send user token - * @param {MFAControllerBetaApiCreateSendTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public createSendToken(requestParameters: MFAControllerBetaApiCreateSendTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).createSendToken(requestParameters.sendTokenRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {MFAControllerBetaApiPingVerificationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public pingVerificationStatus(requestParameters: MFAControllerBetaApiPingVerificationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).pingVerificationStatus(requestParameters.method, requestParameters.verificationPollRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {MFAControllerBetaApiSendDuoVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public sendDuoVerifyRequest(requestParameters: MFAControllerBetaApiSendDuoVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).sendDuoVerifyRequest(requestParameters.duoVerificationRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {MFAControllerBetaApiSendKbaAnswersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public sendKbaAnswers(requestParameters: MFAControllerBetaApiSendKbaAnswersRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).sendKbaAnswers(requestParameters.kbaAnswerRequestItemBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {MFAControllerBetaApiSendOktaVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public sendOktaVerifyRequest(requestParameters: MFAControllerBetaApiSendOktaVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).sendOktaVerifyRequest(requestParameters.oktaVerificationRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {MFAControllerBetaApiSendTokenAuthRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerBetaApi - */ - public sendTokenAuthRequest(requestParameters: MFAControllerBetaApiSendTokenAuthRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerBetaApiFp(this.configuration).sendTokenAuthRequest(requestParameters.tokenAuthRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const PingVerificationStatusMethodBeta = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web', - Kba: 'kba', - Token: 'token', - Rsa: 'rsa' -} as const; -export type PingVerificationStatusMethodBeta = typeof PingVerificationStatusMethodBeta[keyof typeof PingVerificationStatusMethodBeta]; - - -/** - * ManagedClientsBetaApi - axios parameter creator - * @export - */ -export const ManagedClientsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Retrieve Managed Client Status by ID. - * @summary Specified managed client status. - * @param {string} id ID of the Managed Client Status to get - * @param {ManagedClientTypeBeta} type Type of the Managed Client Status to get - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedClientStatus: async (id: string, type: ManagedClientTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientStatus', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getManagedClientStatus', 'type', type) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * Update a status detail passed in from the client - * @summary Handle status request from client - * @param {string} id ID of the Managed Client Status to update - * @param {ManagedClientStatusBeta} managedClientStatusBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateManagedClientStatus: async (id: string, managedClientStatusBeta: ManagedClientStatusBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClientStatus', 'id', id) - // verify required parameter 'managedClientStatusBeta' is not null or undefined - assertParamExists('updateManagedClientStatus', 'managedClientStatusBeta', managedClientStatusBeta) - const localVarPath = `/managed-clients/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClientStatusBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClientsBetaApi - functional programming interface - * @export - */ -export const ManagedClientsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClientsBetaApiAxiosParamCreator(configuration) - return { - /** - * Retrieve Managed Client Status by ID. - * @summary Specified managed client status. - * @param {string} id ID of the Managed Client Status to get - * @param {ManagedClientTypeBeta} type Type of the Managed Client Status to get - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getManagedClientStatus(id: string, type: ManagedClientTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatus(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsBetaApi.getManagedClientStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a status detail passed in from the client - * @summary Handle status request from client - * @param {string} id ID of the Managed Client Status to update - * @param {ManagedClientStatusBeta} managedClientStatusBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateManagedClientStatus(id: string, managedClientStatusBeta: ManagedClientStatusBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClientStatus(id, managedClientStatusBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsBetaApi.updateManagedClientStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClientsBetaApi - factory interface - * @export - */ -export const ManagedClientsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClientsBetaApiFp(configuration) - return { - /** - * Retrieve Managed Client Status by ID. - * @summary Specified managed client status. - * @param {ManagedClientsBetaApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedClientStatus(requestParameters: ManagedClientsBetaApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a status detail passed in from the client - * @summary Handle status request from client - * @param {ManagedClientsBetaApiUpdateManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateManagedClientStatus(requestParameters: ManagedClientsBetaApiUpdateManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClientStatus(requestParameters.id, requestParameters.managedClientStatusBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getManagedClientStatus operation in ManagedClientsBetaApi. - * @export - * @interface ManagedClientsBetaApiGetManagedClientStatusRequest - */ -export interface ManagedClientsBetaApiGetManagedClientStatusRequest { - /** - * ID of the Managed Client Status to get - * @type {string} - * @memberof ManagedClientsBetaApiGetManagedClientStatus - */ - readonly id: string - - /** - * Type of the Managed Client Status to get - * @type {ManagedClientTypeBeta} - * @memberof ManagedClientsBetaApiGetManagedClientStatus - */ - readonly type: ManagedClientTypeBeta -} - -/** - * Request parameters for updateManagedClientStatus operation in ManagedClientsBetaApi. - * @export - * @interface ManagedClientsBetaApiUpdateManagedClientStatusRequest - */ -export interface ManagedClientsBetaApiUpdateManagedClientStatusRequest { - /** - * ID of the Managed Client Status to update - * @type {string} - * @memberof ManagedClientsBetaApiUpdateManagedClientStatus - */ - readonly id: string - - /** - * - * @type {ManagedClientStatusBeta} - * @memberof ManagedClientsBetaApiUpdateManagedClientStatus - */ - readonly managedClientStatusBeta: ManagedClientStatusBeta -} - -/** - * ManagedClientsBetaApi - object-oriented interface - * @export - * @class ManagedClientsBetaApi - * @extends {BaseAPI} - */ -export class ManagedClientsBetaApi extends BaseAPI { - /** - * Retrieve Managed Client Status by ID. - * @summary Specified managed client status. - * @param {ManagedClientsBetaApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClientsBetaApi - */ - public getManagedClientStatus(requestParameters: ManagedClientsBetaApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsBetaApiFp(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a status detail passed in from the client - * @summary Handle status request from client - * @param {ManagedClientsBetaApiUpdateManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClientsBetaApi - */ - public updateManagedClientStatus(requestParameters: ManagedClientsBetaApiUpdateManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsBetaApiFp(this.configuration).updateManagedClientStatus(requestParameters.id, requestParameters.managedClientStatusBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClustersBetaApi - axios parameter creator - * @export - */ -export const ManagedClustersBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get managed cluster\'s log configuration. - * @summary Get managed cluster\'s log configuration - * @param {string} id ID of ManagedCluster to get log configuration for - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getClientLogConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClientLogConfiguration', 'id', id) - const localVarPath = `/managed-clusters/{id}/log-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a ManagedCluster by ID. - * @summary Get a specified managedcluster. - * @param {string} id ID of the ManagedCluster to get - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedCluster: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve all Managed Clusters for the current Org, based on request context. - * @summary Retrieve all managed clusters. - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedClusters: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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 managed cluster\'s log configuration - * @summary Update managed cluster\'s log configuration - * @param {string} id ID of ManagedCluster to update log configuration for - * @param {ClientLogConfigurationBeta | null} clientLogConfigurationBeta ClientLogConfiguration for given ManagedCluster - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putClientLogConfiguration: async (id: string, clientLogConfigurationBeta: ClientLogConfigurationBeta | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putClientLogConfiguration', 'id', id) - // verify required parameter 'clientLogConfigurationBeta' is not null or undefined - assertParamExists('putClientLogConfiguration', 'clientLogConfigurationBeta', clientLogConfigurationBeta) - const localVarPath = `/managed-clusters/{id}/log-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(clientLogConfigurationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClustersBetaApi - functional programming interface - * @export - */ -export const ManagedClustersBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClustersBetaApiAxiosParamCreator(configuration) - return { - /** - * Get managed cluster\'s log configuration. - * @summary Get managed cluster\'s log configuration - * @param {string} id ID of ManagedCluster to get log configuration for - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getClientLogConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersBetaApi.getClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a ManagedCluster by ID. - * @summary Get a specified managedcluster. - * @param {string} id ID of the ManagedCluster to get - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getManagedCluster(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedCluster(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersBetaApi.getManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve all Managed Clusters for the current Org, based on request context. - * @summary Retrieve all managed clusters. - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getManagedClusters(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusters(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersBetaApi.getManagedClusters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update managed cluster\'s log configuration - * @summary Update managed cluster\'s log configuration - * @param {string} id ID of ManagedCluster to update log configuration for - * @param {ClientLogConfigurationBeta | null} clientLogConfigurationBeta ClientLogConfiguration for given ManagedCluster - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async putClientLogConfiguration(id: string, clientLogConfigurationBeta: ClientLogConfigurationBeta | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfiguration(id, clientLogConfigurationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersBetaApi.putClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClustersBetaApi - factory interface - * @export - */ -export const ManagedClustersBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClustersBetaApiFp(configuration) - return { - /** - * Get managed cluster\'s log configuration. - * @summary Get managed cluster\'s log configuration - * @param {ManagedClustersBetaApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getClientLogConfiguration(requestParameters: ManagedClustersBetaApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a ManagedCluster by ID. - * @summary Get a specified managedcluster. - * @param {ManagedClustersBetaApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedCluster(requestParameters: ManagedClustersBetaApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve all Managed Clusters for the current Org, based on request context. - * @summary Retrieve all managed clusters. - * @param {ManagedClustersBetaApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getManagedClusters(requestParameters: ManagedClustersBetaApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update managed cluster\'s log configuration - * @summary Update managed cluster\'s log configuration - * @param {ManagedClustersBetaApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putClientLogConfiguration(requestParameters: ManagedClustersBetaApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putClientLogConfiguration(requestParameters.id, requestParameters.clientLogConfigurationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getClientLogConfiguration operation in ManagedClustersBetaApi. - * @export - * @interface ManagedClustersBetaApiGetClientLogConfigurationRequest - */ -export interface ManagedClustersBetaApiGetClientLogConfigurationRequest { - /** - * ID of ManagedCluster to get log configuration for - * @type {string} - * @memberof ManagedClustersBetaApiGetClientLogConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getManagedCluster operation in ManagedClustersBetaApi. - * @export - * @interface ManagedClustersBetaApiGetManagedClusterRequest - */ -export interface ManagedClustersBetaApiGetManagedClusterRequest { - /** - * ID of the ManagedCluster to get - * @type {string} - * @memberof ManagedClustersBetaApiGetManagedCluster - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusters operation in ManagedClustersBetaApi. - * @export - * @interface ManagedClustersBetaApiGetManagedClustersRequest - */ -export interface ManagedClustersBetaApiGetManagedClustersRequest { - /** - * 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 ManagedClustersBetaApiGetManagedClusters - */ - 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 ManagedClustersBetaApiGetManagedClusters - */ - 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 ManagedClustersBetaApiGetManagedClusters - */ - 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @type {string} - * @memberof ManagedClustersBetaApiGetManagedClusters - */ - readonly filters?: string -} - -/** - * Request parameters for putClientLogConfiguration operation in ManagedClustersBetaApi. - * @export - * @interface ManagedClustersBetaApiPutClientLogConfigurationRequest - */ -export interface ManagedClustersBetaApiPutClientLogConfigurationRequest { - /** - * ID of ManagedCluster to update log configuration for - * @type {string} - * @memberof ManagedClustersBetaApiPutClientLogConfiguration - */ - readonly id: string - - /** - * ClientLogConfiguration for given ManagedCluster - * @type {ClientLogConfigurationBeta} - * @memberof ManagedClustersBetaApiPutClientLogConfiguration - */ - readonly clientLogConfigurationBeta: ClientLogConfigurationBeta | null -} - -/** - * ManagedClustersBetaApi - object-oriented interface - * @export - * @class ManagedClustersBetaApi - * @extends {BaseAPI} - */ -export class ManagedClustersBetaApi extends BaseAPI { - /** - * Get managed cluster\'s log configuration. - * @summary Get managed cluster\'s log configuration - * @param {ManagedClustersBetaApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClustersBetaApi - */ - public getClientLogConfiguration(requestParameters: ManagedClustersBetaApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersBetaApiFp(this.configuration).getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a ManagedCluster by ID. - * @summary Get a specified managedcluster. - * @param {ManagedClustersBetaApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClustersBetaApi - */ - public getManagedCluster(requestParameters: ManagedClustersBetaApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersBetaApiFp(this.configuration).getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve all Managed Clusters for the current Org, based on request context. - * @summary Retrieve all managed clusters. - * @param {ManagedClustersBetaApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClustersBetaApi - */ - public getManagedClusters(requestParameters: ManagedClustersBetaApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersBetaApiFp(this.configuration).getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update managed cluster\'s log configuration - * @summary Update managed cluster\'s log configuration - * @param {ManagedClustersBetaApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ManagedClustersBetaApi - */ - public putClientLogConfiguration(requestParameters: ManagedClustersBetaApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersBetaApiFp(this.configuration).putClientLogConfiguration(requestParameters.id, requestParameters.clientLogConfigurationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MultiHostIntegrationBetaApi - axios parameter creator - * @export - */ -export const MultiHostIntegrationBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateBeta} multiHostIntegrationsCreateBeta The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration: async (multiHostIntegrationsCreateBeta: MultiHostIntegrationsCreateBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostIntegrationsCreateBeta' is not null or undefined - assertParamExists('createMultiHostIntegration', 'multiHostIntegrationsCreateBeta', multiHostIntegrationsCreateBeta) - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesBeta The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost: async (multihostId: string, multiHostIntegrationsCreateSourcesBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multihostId', multihostId) - // verify required parameter 'multiHostIntegrationsCreateSourcesBeta' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multiHostIntegrationsCreateSourcesBeta', multiHostIntegrationsCreateSourcesBeta) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateSourcesBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('deleteMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get account aggregation groups within multi-host integration id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getAcctAggregationGroups', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/acctAggregationGroups` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get entitlement aggregation groups within multi-host integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getEntitlementAggregationGroups', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/entitlementAggregationGroups` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getMultiHostIntegrations', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getMultiHostSourceCreationErrors', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/sources/errors` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost: async (multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getSourcesWithinMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testConnectionMultiHostSources', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost: async (multihostId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'multihostId', multihostId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'sourceId', sourceId) - const localVarPath = `/multihosts/{multihostId}/sources/{sourceId}/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerBeta This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources: async (multihostId: string, updateMultiHostSourcesRequestInnerBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('updateMultiHostSources', 'multihostId', multihostId) - // verify required parameter 'updateMultiHostSourcesRequestInnerBeta' is not null or undefined - assertParamExists('updateMultiHostSources', 'updateMultiHostSourcesRequestInnerBeta', updateMultiHostSourcesRequestInnerBeta) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(updateMultiHostSourcesRequestInnerBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MultiHostIntegrationBetaApi - functional programming interface - * @export - */ -export const MultiHostIntegrationBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MultiHostIntegrationBetaApiAxiosParamCreator(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateBeta} multiHostIntegrationsCreateBeta The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMultiHostIntegration(multiHostIntegrationsCreateBeta: MultiHostIntegrationsCreateBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMultiHostIntegration(multiHostIntegrationsCreateBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.createMultiHostIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesBeta The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourcesWithinMultiHost(multihostId: string, multiHostIntegrationsCreateSourcesBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourcesWithinMultiHost(multihostId, multiHostIntegrationsCreateSourcesBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.createSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHost(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHost(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.deleteMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get account aggregation groups within multi-host integration id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAcctAggregationGroups(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAcctAggregationGroups(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getAcctAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get entitlement aggregation groups within multi-host integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementAggregationGroups(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementAggregationGroups(multiHostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getEntitlementAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrations(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrations(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getMultiHostIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrationsList(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsList(offset, limit, sorters, filters, count, forSubadmin, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getMultiHostIntegrationsList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostSourceCreationErrors(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostSourceCreationErrors(multiHostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getMultiHostSourceCreationErrors']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultihostIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getMultihostIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourcesWithinMultiHost(multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourcesWithinMultiHost(multihostId, offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.getSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectionMultiHostSources(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionMultiHostSources(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.testConnectionMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnectionMultihost(multihostId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionMultihost(multihostId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.testSourceConnectionMultihost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerBeta This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMultiHostSources(multihostId: string, updateMultiHostSourcesRequestInnerBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMultiHostSources(multihostId, updateMultiHostSourcesRequestInnerBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationBetaApi.updateMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MultiHostIntegrationBetaApi - factory interface - * @export - */ -export const MultiHostIntegrationBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MultiHostIntegrationBetaApiFp(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration(requestParameters: MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationBetaApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost(requestParameters: MultiHostIntegrationBetaApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get account aggregation groups within multi-host integration id - * @param {MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups(requestParameters: MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAcctAggregationGroups(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get entitlement aggregation groups within multi-host integration id - * @param {MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementAggregationGroups(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations(requestParameters: MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultihostIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources(requestParameters: MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost(requestParameters: MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources(requestParameters: MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMultiHostIntegration operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest - */ -export interface MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest { - /** - * The specifics of the Multi-Host Integration to create - * @type {MultiHostIntegrationsCreateBeta} - * @memberof MultiHostIntegrationBetaApiCreateMultiHostIntegration - */ - readonly multiHostIntegrationsCreateBeta: MultiHostIntegrationsCreateBeta -} - -/** - * Request parameters for createSourcesWithinMultiHost operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationBetaApiCreateSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * The specifics of the sources to create within Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationBetaApiCreateSourcesWithinMultiHost - */ - readonly multiHostIntegrationsCreateSourcesBeta: Array -} - -/** - * Request parameters for deleteMultiHost operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiDeleteMultiHostRequest - */ -export interface MultiHostIntegrationBetaApiDeleteMultiHostRequest { - /** - * ID of Multi-Host Integration to delete. - * @type {string} - * @memberof MultiHostIntegrationBetaApiDeleteMultiHost - */ - readonly multihostId: string -} - -/** - * Request parameters for getAcctAggregationGroups operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest - */ -export interface MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetAcctAggregationGroups - */ - readonly multihostId: string -} - -/** - * Request parameters for getEntitlementAggregationGroups operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest - */ -export interface MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetEntitlementAggregationGroups - */ - readonly multiHostId: string -} - -/** - * Request parameters for getMultiHostIntegrations operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest - */ -export interface MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetMultiHostIntegrations - */ - readonly multihostId: string -} - -/** - * Request parameters for getMultiHostIntegrationsList operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest - */ -export interface MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest { - /** - * 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 MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - 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 MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - readonly sorters?: 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: **type**: *in* **forSubAdminId**: *in* - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - readonly count?: boolean - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetMultiHostIntegrationsList - */ - readonly forSubadmin?: string -} - -/** - * Request parameters for getMultiHostSourceCreationErrors operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest - */ -export interface MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrors - */ - readonly multiHostId: string -} - -/** - * Request parameters for getSourcesWithinMultiHost operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - 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 MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - readonly sorters?: 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: **id**: *in* - * @type {string} - * @memberof MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationBetaApiGetSourcesWithinMultiHost - */ - readonly count?: boolean -} - -/** - * Request parameters for testConnectionMultiHostSources operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest - */ -export interface MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationBetaApiTestConnectionMultiHostSources - */ - readonly multihostId: string -} - -/** - * Request parameters for testSourceConnectionMultihost operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest - */ -export interface MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationBetaApiTestSourceConnectionMultihost - */ - readonly multihostId: string - - /** - * ID of the source within the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationBetaApiTestSourceConnectionMultihost - */ - readonly sourceId: string -} - -/** - * Request parameters for updateMultiHostSources operation in MultiHostIntegrationBetaApi. - * @export - * @interface MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest - */ -export interface MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration to update. - * @type {string} - * @memberof MultiHostIntegrationBetaApiUpdateMultiHostSources - */ - readonly multihostId: string - - /** - * This endpoint allows you to update a Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationBetaApiUpdateMultiHostSources - */ - readonly updateMultiHostSourcesRequestInnerBeta: Array -} - -/** - * MultiHostIntegrationBetaApi - object-oriented interface - * @export - * @class MultiHostIntegrationBetaApi - * @extends {BaseAPI} - */ -export class MultiHostIntegrationBetaApi extends BaseAPI { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public createMultiHostIntegration(requestParameters: MultiHostIntegrationBetaApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationBetaApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationBetaApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public deleteMultiHost(requestParameters: MultiHostIntegrationBetaApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get account aggregation groups within multi-host integration id - * @param {MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getAcctAggregationGroups(requestParameters: MultiHostIntegrationBetaApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getAcctAggregationGroups(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Get entitlement aggregation groups within multi-host integration id - * @param {MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationBetaApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getEntitlementAggregationGroups(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getMultiHostIntegrations(requestParameters: MultiHostIntegrationBetaApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationBetaApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationBetaApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getMultihostIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationBetaApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public testConnectionMultiHostSources(requestParameters: MultiHostIntegrationBetaApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public testSourceConnectionMultihost(requestParameters: MultiHostIntegrationBetaApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationBetaApi - */ - public updateMultiHostSources(requestParameters: MultiHostIntegrationBetaApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationBetaApiFp(this.configuration).updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NonEmployeeLifecycleManagementBetaApi - axios parameter creator - * @export - */ -export const NonEmployeeLifecycleManagementBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionBeta} nonEmployeeApprovalDecisionBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveNonEmployeeRequest: async (id: string, nonEmployeeApprovalDecisionBeta: NonEmployeeApprovalDecisionBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeApprovalDecisionBeta' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'nonEmployeeApprovalDecisionBeta', nonEmployeeApprovalDecisionBeta) - const localVarPath = `/non-employee-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecisionBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee record. Request will require the following security scope: \'idn:nesr:create\' - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeRecord: async (nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyBeta' is not null or undefined - assertParamExists('createNonEmployeeRecord', 'nonEmployeeRequestBodyBeta', nonEmployeeRequestBodyBeta) - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee request and notify the approver - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeRequest: async (nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyBeta' is not null or undefined - assertParamExists('createNonEmployeeRequest', 'nonEmployeeRequestBodyBeta', nonEmployeeRequestBodyBeta) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyBeta} nonEmployeeSourceRequestBodyBeta Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeSource: async (nonEmployeeSourceRequestBodyBeta: NonEmployeeSourceRequestBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeSourceRequestBodyBeta' is not null or undefined - assertParamExists('createNonEmployeeSource', 'nonEmployeeSourceRequestBodyBeta', nonEmployeeSourceRequestBodyBeta) - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. - * @summary Create non-employee source schema attribute - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyBeta} nonEmployeeSchemaAttributeBodyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes: async (sourceId: string, nonEmployeeSchemaAttributeBodyBeta: NonEmployeeSchemaAttributeBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - // verify required parameter 'nonEmployeeSchemaAttributeBodyBeta' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'nonEmployeeSchemaAttributeBodyBeta', nonEmployeeSchemaAttributeBodyBeta) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee record. - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: \'idn:nesr:delete\' - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordInBulkRequestBeta} deleteNonEmployeeRecordInBulkRequestBeta Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRecordInBulk: async (deleteNonEmployeeRecordInBulkRequestBeta: DeleteNonEmployeeRecordInBulkRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteNonEmployeeRecordInBulkRequestBeta' is not null or undefined - assertParamExists('deleteNonEmployeeRecordInBulk', 'deleteNonEmployeeRecordInBulkRequestBeta', deleteNonEmployeeRecordInBulkRequestBeta) - const localVarPath = `/non-employee-records/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordInBulkRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee request. - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. - * @summary Delete non-employee source\'s schema attribute - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee source. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. - * @summary Delete all custom schema attributes - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary A non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {string} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeApproval: async (id: string, includeDetail?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeApproval', 'id', id) - const localVarPath = `/non-employee-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeDetail !== undefined) { - localVarQueryParameter['include-detail'] = includeDetail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeApprovalSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-approvals/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - * @summary Bulk upload status on source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeBulkUploadStatus', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a CSV download for all non-employees from a provided source. - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeExportRecords: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeExportRecords', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employees/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read\' - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeExportSourceSchemaTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeExportSourceSchemaTemplate', 'id', id) - const localVarPath = `/non-employee-sources/{id}/schema-attributes-template/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee record. - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeRequestSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee source. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes: async (sourceId: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: \'idn:nesr:create\' - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'id', id) - // verify required parameter 'data' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'data', data) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee approval requests. - * @summary List of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeApproval: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This gets a list of non-employee records. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeRecords: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee requests. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeRequests: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('listNonEmployeeRequests', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeSources: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (nonEmployeeCount !== undefined) { - localVarQueryParameter['non-employee-count'] = nonEmployeeCount; - } - - 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, - }; - }, - /** - * This request will patch a non-employee record. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationBeta A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeRecord: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. - * @summary Patch non-employee source\'s schema attribute - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationBeta A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationBeta A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeSource: async (sourceId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will update a non-employee record. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putNonEmployeeRecord: async (id: string, nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putNonEmployeeRecord', 'id', id) - // verify required parameter 'nonEmployeeRequestBodyBeta' is not null or undefined - assertParamExists('putNonEmployeeRecord', 'nonEmployeeRequestBodyBeta', nonEmployeeRequestBodyBeta) - const localVarPath = `/non-employee-records/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint will reject an approval item request and notify user. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionBeta} nonEmployeeRejectApprovalDecisionBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectNonEmployeeRequest: async (id: string, nonEmployeeRejectApprovalDecisionBeta: NonEmployeeRejectApprovalDecisionBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeRejectApprovalDecisionBeta' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'nonEmployeeRejectApprovalDecisionBeta', nonEmployeeRejectApprovalDecisionBeta) - const localVarPath = `/non-employee-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecisionBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NonEmployeeLifecycleManagementBetaApi - functional programming interface - * @export - */ -export const NonEmployeeLifecycleManagementBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NonEmployeeLifecycleManagementBetaApiAxiosParamCreator(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionBeta} nonEmployeeApprovalDecisionBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async approveNonEmployeeRequest(id: string, nonEmployeeApprovalDecisionBeta: NonEmployeeApprovalDecisionBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequest(id, nonEmployeeApprovalDecisionBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.approveNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee record. Request will require the following security scope: \'idn:nesr:create\' - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createNonEmployeeRecord(nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecord(nonEmployeeRequestBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.createNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee request and notify the approver - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createNonEmployeeRequest(nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequest(nonEmployeeRequestBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.createNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyBeta} nonEmployeeSourceRequestBodyBeta Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createNonEmployeeSource(nonEmployeeSourceRequestBodyBeta: NonEmployeeSourceRequestBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSource(nonEmployeeSourceRequestBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.createNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. - * @summary Create non-employee source schema attribute - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyBeta} nonEmployeeSchemaAttributeBodyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createNonEmployeeSourceSchemaAttributes(sourceId: string, nonEmployeeSchemaAttributeBodyBeta: NonEmployeeSchemaAttributeBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributes(sourceId, nonEmployeeSchemaAttributeBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.createNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee record. - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: \'idn:nesr:delete\' - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordInBulkRequestBeta} deleteNonEmployeeRecordInBulkRequestBeta Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeRecordInBulk(deleteNonEmployeeRecordInBulkRequestBeta: DeleteNonEmployeeRecordInBulkRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordInBulk(deleteNonEmployeeRecordInBulkRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeRecordInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee request. - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. - * @summary Delete non-employee source\'s schema attribute - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee source. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. - * @summary Delete all custom schema attributes - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.deleteNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary A non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {string} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeApproval(id: string, includeDetail?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApproval(id, includeDetail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeApprovalSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - * @summary Bulk upload status on source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeBulkUploadStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeBulkUploadStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a CSV download for all non-employees from a provided source. - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeExportRecords(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeExportRecords(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeExportRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read\' - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeExportSourceSchemaTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeExportSourceSchemaTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeExportSourceSchemaTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee record. - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeRequestSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeRequestSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee source. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getNonEmployeeSourceSchemaAttributes(sourceId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributes(sourceId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.getNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: \'idn:nesr:create\' - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async importNonEmployeeRecordsInBulk(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulk(id, data, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.importNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee approval requests. - * @summary List of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listNonEmployeeApproval(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApproval(requestedFor, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.listNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee records. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listNonEmployeeRecords(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecords(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.listNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee requests. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listNonEmployeeRequests(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequests(requestedFor, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.listNonEmployeeRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listNonEmployeeSources(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSources(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.listNonEmployeeSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will patch a non-employee record. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationBeta A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchNonEmployeeRecord(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecord(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.patchNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. - * @summary Patch non-employee source\'s schema attribute - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationBeta A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttribute(attributeId, sourceId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.patchNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationBeta A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchNonEmployeeSource(sourceId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSource(sourceId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.patchNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will update a non-employee record. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyBeta} nonEmployeeRequestBodyBeta Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async putNonEmployeeRecord(id: string, nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putNonEmployeeRecord(id, nonEmployeeRequestBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.putNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint will reject an approval item request and notify user. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionBeta} nonEmployeeRejectApprovalDecisionBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async rejectNonEmployeeRequest(id: string, nonEmployeeRejectApprovalDecisionBeta: NonEmployeeRejectApprovalDecisionBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequest(id, nonEmployeeRejectApprovalDecisionBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementBetaApi.rejectNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NonEmployeeLifecycleManagementBetaApi - factory interface - * @export - */ -export const NonEmployeeLifecycleManagementBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NonEmployeeLifecycleManagementBetaApiFp(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee record. Request will require the following security scope: \'idn:nesr:create\' - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee request and notify the approver - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. - * @summary Create non-employee source schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee record. - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: \'idn:nesr:delete\' - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRecordInBulk(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecordInBulk(requestParameters.deleteNonEmployeeRecordInBulkRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee request. - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. - * @summary Delete non-employee source\'s schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee source. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. - * @summary Delete all custom schema attributes - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary A non-employee approval item detail - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - * @summary Bulk upload status on source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a CSV download for all non-employees from a provided source. - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeExportRecords(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeExportRecords(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read\' - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeExportSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeExportSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee record. - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee source. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: \'idn:nesr:create\' - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee approval requests. - * @summary List of non-employee approval requests - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeApproval(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee records. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee requests. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will patch a non-employee record. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. - * @summary Patch non-employee source\'s schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will update a non-employee record. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint will reject an approval item request and notify user. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveNonEmployeeRequest operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeApprovalDecisionBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequest - */ - readonly nonEmployeeApprovalDecisionBeta: NonEmployeeApprovalDecisionBeta -} - -/** - * Request parameters for createNonEmployeeRecord operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest { - /** - * Non-Employee record creation request body. - * @type {NonEmployeeRequestBodyBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta -} - -/** - * Request parameters for createNonEmployeeRequest operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest { - /** - * Non-Employee creation request body - * @type {NonEmployeeRequestBodyBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequest - */ - readonly nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta -} - -/** - * Request parameters for createNonEmployeeSource operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest { - /** - * Non-Employee source creation request body. - * @type {NonEmployeeSourceRequestBodyBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSource - */ - readonly nonEmployeeSourceRequestBodyBeta: NonEmployeeSourceRequestBodyBeta -} - -/** - * Request parameters for createNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * - * @type {NonEmployeeSchemaAttributeBodyBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly nonEmployeeSchemaAttributeBodyBeta: NonEmployeeSchemaAttributeBodyBeta -} - -/** - * Request parameters for deleteNonEmployeeRecord operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeRecordInBulk operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest { - /** - * Non-Employee bulk delete request body. - * @type {DeleteNonEmployeeRecordInBulkRequestBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulk - */ - readonly deleteNonEmployeeRecordInBulkRequestBeta: DeleteNonEmployeeRecordInBulkRequestBeta -} - -/** - * Request parameters for deleteNonEmployeeRequest operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest { - /** - * Non-Employee request id in the UUID format - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSource operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeApproval operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApproval - */ - readonly id: string - - /** - * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApproval - */ - readonly includeDetail?: string -} - -/** - * Request parameters for getNonEmployeeApprovalSummary operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest { - /** - * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeBulkUploadStatus operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest { - /** - * Source ID (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatus - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeExportRecords operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecords - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeExportSourceSchemaTemplate operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRecord operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequest operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest { - /** - * Non-Employee request id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequestSummary operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest { - /** - * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSource operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributes - */ - readonly offset?: number -} - -/** - * Request parameters for importNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulk - */ - readonly id: string - - /** - * - * @type {File} - * @memberof NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulk - */ - readonly data: File -} - -/** - * Request parameters for listNonEmployeeApproval operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - readonly requestedFor?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - 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: **approvalStatus**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - 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: **created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeApproval - */ - readonly sorters?: string -} - -/** - * Request parameters for listNonEmployeeRecords operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest { - /** - * 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 NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecords - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecords - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecords - */ - readonly count?: boolean - - /** - * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecords - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecords - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeRequests operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly requestedFor: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly count?: boolean - - /** - * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequests - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeSources operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest { - /** - * 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 NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly count?: boolean - - /** - * Identity the request was made for. Use \'me\' to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly requestedFor?: string - - /** - * Flag that determines whether the API will return a non-employee count associated with the source. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly nonEmployeeCount?: boolean - - /** - * 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: **name, created, sourceId** - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiListNonEmployeeSources - */ - readonly sorters?: string -} - -/** - * Request parameters for patchNonEmployeeRecord operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecord - */ - readonly id: string - - /** - * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecord - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for patchNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttribute - */ - readonly sourceId: string - - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttribute - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for patchNonEmployeeSource operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSource - */ - readonly sourceId: string - - /** - * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSource - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for putNonEmployeeRecord operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecord - */ - readonly id: string - - /** - * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {NonEmployeeRequestBodyBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyBeta: NonEmployeeRequestBodyBeta -} - -/** - * Request parameters for rejectNonEmployeeRequest operation in NonEmployeeLifecycleManagementBetaApi. - * @export - * @interface NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeRejectApprovalDecisionBeta} - * @memberof NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequest - */ - readonly nonEmployeeRejectApprovalDecisionBeta: NonEmployeeRejectApprovalDecisionBeta -} - -/** - * NonEmployeeLifecycleManagementBetaApi - object-oriented interface - * @export - * @class NonEmployeeLifecycleManagementBetaApi - * @extends {BaseAPI} - */ -export class NonEmployeeLifecycleManagementBetaApi extends BaseAPI { - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee record. Request will require the following security scope: \'idn:nesr:create\' - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee request and notify the approver - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. - * @summary Create non-employee source schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee record. - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: \'idn:nesr:delete\' - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeRecordInBulk(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRecordInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeRecordInBulk(requestParameters.deleteNonEmployeeRecordInBulkRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee request. - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes a specific schema attribute for a non-employee source. - * @summary Delete non-employee source\'s schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee source. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes all custom schema attributes for a non-employee source. - * @summary Delete all custom schema attributes - * @param {NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Approves a non-employee approval request and notifies the next approver. - * @summary A non-employee approval item detail - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - * @summary Bulk upload status on source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a CSV download for all non-employees from a provided source. - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeExportRecords(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportRecordsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeExportRecords(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read\' - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeExportSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeExportSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeExportSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee record. - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee source. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementBetaApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: \'idn:nesr:create\' - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementBetaApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee approval requests. - * @summary List of non-employee approval requests - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public listNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeApprovalRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).listNonEmployeeApproval(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee records. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee requests. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementBetaApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will patch a non-employee record. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. - * @summary Patch non-employee source\'s schema attribute - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementBetaApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will update a non-employee record. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public putNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementBetaApiPutNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).putNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint will reject an approval item request and notify user. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementBetaApi - */ - public rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementBetaApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementBetaApiFp(this.configuration).rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NotificationsBetaApi - axios parameter creator - * @export - */ -export const NotificationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressBeta} domainAddressBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim: async (domainAddressBeta: DomainAddressBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'domainAddressBeta' is not null or undefined - assertParamExists('createDomainDkim', 'domainAddressBeta', domainAddressBeta) - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(domainAddressBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoBeta} templateDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate: async (templateDtoBeta: TemplateDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateDtoBeta' is not null or undefined - assertParamExists('createNotificationTemplate', 'templateDtoBeta', templateDtoBeta) - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoBeta} emailStatusDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress: async (emailStatusDtoBeta: EmailStatusDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'emailStatusDtoBeta' is not null or undefined - assertParamExists('createVerifiedFromAddress', 'emailStatusDtoBeta', emailStatusDtoBeta) - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailStatusDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk: async (templateBulkDeleteDtoBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateBulkDeleteDtoBeta' is not null or undefined - assertParamExists('deleteNotificationTemplatesInBulk', 'templateBulkDeleteDtoBeta', templateBulkDeleteDtoBeta) - const localVarPath = `/notification-templates/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateBulkDeleteDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteVerifiedFromAddress', 'id', id) - const localVarPath = `/verified-from-addresses/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identityId Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getMailFromAttributes', 'identityId', identityId) - const localVarPath = `/mail-from-attributes/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNotificationTemplate', 'id', id) - const localVarPath = `/notification-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, sw* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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 a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {string} key The notification key. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationPreferences: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('listNotificationPreferences', 'key', key) - const localVarPath = `/notification-preferences/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-defaults`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in* **medium**: *eq* **locale**: *eq* **name**: *eq, sw* **description**: *eq, sw* **id**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoBeta} mailFromAttributesDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes: async (mailFromAttributesDtoBeta: MailFromAttributesDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mailFromAttributesDtoBeta' is not null or undefined - assertParamExists('putMailFromAttributes', 'mailFromAttributesDtoBeta', mailFromAttributesDtoBeta) - const localVarPath = `/mail-from-attributes`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mailFromAttributesDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoBeta} sendTestNotificationRequestDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification: async (sendTestNotificationRequestDtoBeta: SendTestNotificationRequestDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTestNotificationRequestDtoBeta' is not null or undefined - assertParamExists('sendTestNotification', 'sendTestNotificationRequestDtoBeta', sendTestNotificationRequestDtoBeta) - const localVarPath = `/send-test-notification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTestNotificationRequestDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NotificationsBetaApi - functional programming interface - * @export - */ -export const NotificationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NotificationsBetaApiAxiosParamCreator(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressBeta} domainAddressBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDomainDkim(domainAddressBeta: DomainAddressBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkim(domainAddressBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.createDomainDkim']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoBeta} templateDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNotificationTemplate(templateDtoBeta: TemplateDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplate(templateDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.createNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoBeta} emailStatusDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createVerifiedFromAddress(emailStatusDtoBeta: EmailStatusDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddress(emailStatusDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.createVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNotificationTemplatesInBulk(templateBulkDeleteDtoBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulk(templateBulkDeleteDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.deleteNotificationTemplatesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddress(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.deleteVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDkimAttributes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.getDkimAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identityId Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMailFromAttributes(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributes(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.getMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.getNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.getNotificationsTemplateContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, sw* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddresses(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.listFromAddresses']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {string} key The notification key. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationPreferences(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationPreferences(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.listNotificationPreferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaults(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.listNotificationTemplateDefaults']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in* **medium**: *eq* **locale**: *eq* **name**: *eq, sw* **description**: *eq, sw* **id**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplates(limit, offset, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.listNotificationTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoBeta} mailFromAttributesDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putMailFromAttributes(mailFromAttributesDtoBeta: MailFromAttributesDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributes(mailFromAttributesDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.putMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoBeta} sendTestNotificationRequestDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTestNotification(sendTestNotificationRequestDtoBeta: SendTestNotificationRequestDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotification(sendTestNotificationRequestDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsBetaApi.sendTestNotification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NotificationsBetaApi - factory interface - * @export - */ -export const NotificationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NotificationsBetaApiFp(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsBetaApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim(requestParameters: NotificationsBetaApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDomainDkim(requestParameters.domainAddressBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsBetaApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate(requestParameters: NotificationsBetaApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNotificationTemplate(requestParameters.templateDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsBetaApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress(requestParameters: NotificationsBetaApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createVerifiedFromAddress(requestParameters.emailStatusDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk(requestParameters: NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsBetaApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress(requestParameters: NotificationsBetaApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDkimAttributes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsBetaApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes(requestParameters: NotificationsBetaApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMailFromAttributes(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsBetaApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate(requestParameters: NotificationsBetaApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationsTemplateContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsBetaApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses(requestParameters: NotificationsBetaApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {NotificationsBetaApiListNotificationPreferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationPreferences(requestParameters: NotificationsBetaApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationPreferences(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsBetaApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults(requestParameters: NotificationsBetaApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsBetaApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates(requestParameters: NotificationsBetaApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsBetaApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes(requestParameters: NotificationsBetaApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putMailFromAttributes(requestParameters.mailFromAttributesDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsBetaApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification(requestParameters: NotificationsBetaApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTestNotification(requestParameters.sendTestNotificationRequestDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDomainDkim operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiCreateDomainDkimRequest - */ -export interface NotificationsBetaApiCreateDomainDkimRequest { - /** - * - * @type {DomainAddressBeta} - * @memberof NotificationsBetaApiCreateDomainDkim - */ - readonly domainAddressBeta: DomainAddressBeta -} - -/** - * Request parameters for createNotificationTemplate operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiCreateNotificationTemplateRequest - */ -export interface NotificationsBetaApiCreateNotificationTemplateRequest { - /** - * - * @type {TemplateDtoBeta} - * @memberof NotificationsBetaApiCreateNotificationTemplate - */ - readonly templateDtoBeta: TemplateDtoBeta -} - -/** - * Request parameters for createVerifiedFromAddress operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiCreateVerifiedFromAddressRequest - */ -export interface NotificationsBetaApiCreateVerifiedFromAddressRequest { - /** - * - * @type {EmailStatusDtoBeta} - * @memberof NotificationsBetaApiCreateVerifiedFromAddress - */ - readonly emailStatusDtoBeta: EmailStatusDtoBeta -} - -/** - * Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest - */ -export interface NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest { - /** - * - * @type {Array} - * @memberof NotificationsBetaApiDeleteNotificationTemplatesInBulk - */ - readonly templateBulkDeleteDtoBeta: Array -} - -/** - * Request parameters for deleteVerifiedFromAddress operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiDeleteVerifiedFromAddressRequest - */ -export interface NotificationsBetaApiDeleteVerifiedFromAddressRequest { - /** - * - * @type {string} - * @memberof NotificationsBetaApiDeleteVerifiedFromAddress - */ - readonly id: string -} - -/** - * Request parameters for getMailFromAttributes operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiGetMailFromAttributesRequest - */ -export interface NotificationsBetaApiGetMailFromAttributesRequest { - /** - * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @type {string} - * @memberof NotificationsBetaApiGetMailFromAttributes - */ - readonly identityId: string -} - -/** - * Request parameters for getNotificationTemplate operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiGetNotificationTemplateRequest - */ -export interface NotificationsBetaApiGetNotificationTemplateRequest { - /** - * Id of the Notification Template - * @type {string} - * @memberof NotificationsBetaApiGetNotificationTemplate - */ - readonly id: string -} - -/** - * Request parameters for listFromAddresses operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiListFromAddressesRequest - */ -export interface NotificationsBetaApiListFromAddressesRequest { - /** - * 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 NotificationsBetaApiListFromAddresses - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsBetaApiListFromAddresses - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NotificationsBetaApiListFromAddresses - */ - 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: **email**: *eq, ge, le, sw* - * @type {string} - * @memberof NotificationsBetaApiListFromAddresses - */ - 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: **email** - * @type {string} - * @memberof NotificationsBetaApiListFromAddresses - */ - readonly sorters?: string -} - -/** - * Request parameters for listNotificationPreferences operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiListNotificationPreferencesRequest - */ -export interface NotificationsBetaApiListNotificationPreferencesRequest { - /** - * The notification key. - * @type {string} - * @memberof NotificationsBetaApiListNotificationPreferences - */ - readonly key: string -} - -/** - * Request parameters for listNotificationTemplateDefaults operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiListNotificationTemplateDefaultsRequest - */ -export interface NotificationsBetaApiListNotificationTemplateDefaultsRequest { - /** - * 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 NotificationsBetaApiListNotificationTemplateDefaults - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsBetaApiListNotificationTemplateDefaults - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsBetaApiListNotificationTemplateDefaults - */ - readonly filters?: string -} - -/** - * Request parameters for listNotificationTemplates operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiListNotificationTemplatesRequest - */ -export interface NotificationsBetaApiListNotificationTemplatesRequest { - /** - * 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 NotificationsBetaApiListNotificationTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsBetaApiListNotificationTemplates - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in* **medium**: *eq* **locale**: *eq* **name**: *eq, sw* **description**: *eq, sw* **id**: *eq, sw* - * @type {string} - * @memberof NotificationsBetaApiListNotificationTemplates - */ - 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: **key, name, medium** - * @type {string} - * @memberof NotificationsBetaApiListNotificationTemplates - */ - readonly sorters?: string -} - -/** - * Request parameters for putMailFromAttributes operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiPutMailFromAttributesRequest - */ -export interface NotificationsBetaApiPutMailFromAttributesRequest { - /** - * - * @type {MailFromAttributesDtoBeta} - * @memberof NotificationsBetaApiPutMailFromAttributes - */ - readonly mailFromAttributesDtoBeta: MailFromAttributesDtoBeta -} - -/** - * Request parameters for sendTestNotification operation in NotificationsBetaApi. - * @export - * @interface NotificationsBetaApiSendTestNotificationRequest - */ -export interface NotificationsBetaApiSendTestNotificationRequest { - /** - * - * @type {SendTestNotificationRequestDtoBeta} - * @memberof NotificationsBetaApiSendTestNotification - */ - readonly sendTestNotificationRequestDtoBeta: SendTestNotificationRequestDtoBeta -} - -/** - * NotificationsBetaApi - object-oriented interface - * @export - * @class NotificationsBetaApi - * @extends {BaseAPI} - */ -export class NotificationsBetaApi extends BaseAPI { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsBetaApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public createDomainDkim(requestParameters: NotificationsBetaApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).createDomainDkim(requestParameters.domainAddressBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsBetaApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public createNotificationTemplate(requestParameters: NotificationsBetaApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).createNotificationTemplate(requestParameters.templateDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsBetaApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public createVerifiedFromAddress(requestParameters: NotificationsBetaApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).createVerifiedFromAddress(requestParameters.emailStatusDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public deleteNotificationTemplatesInBulk(requestParameters: NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsBetaApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public deleteVerifiedFromAddress(requestParameters: NotificationsBetaApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public getDkimAttributes(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).getDkimAttributes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsBetaApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public getMailFromAttributes(requestParameters: NotificationsBetaApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).getMailFromAttributes(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsBetaApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public getNotificationTemplate(requestParameters: NotificationsBetaApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).getNotificationsTemplateContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsBetaApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public listFromAddresses(requestParameters: NotificationsBetaApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {NotificationsBetaApiListNotificationPreferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public listNotificationPreferences(requestParameters: NotificationsBetaApiListNotificationPreferencesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).listNotificationPreferences(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsBetaApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public listNotificationTemplateDefaults(requestParameters: NotificationsBetaApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsBetaApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public listNotificationTemplates(requestParameters: NotificationsBetaApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsBetaApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public putMailFromAttributes(requestParameters: NotificationsBetaApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).putMailFromAttributes(requestParameters.mailFromAttributesDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsBetaApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsBetaApi - */ - public sendTestNotification(requestParameters: NotificationsBetaApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsBetaApiFp(this.configuration).sendTestNotification(requestParameters.sendTestNotificationRequestDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OAuthClientsBetaApi - axios parameter creator - * @export - */ -export const OAuthClientsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestBeta} createOAuthClientRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient: async (createOAuthClientRequestBeta: CreateOAuthClientRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createOAuthClientRequestBeta' is not null or undefined - assertParamExists('createOauthClient', 'createOAuthClientRequestBeta', createOAuthClientRequestBeta) - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationBeta A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchOauthClient', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchOauthClient', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OAuthClientsBetaApi - functional programming interface - * @export - */ -export const OAuthClientsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OAuthClientsBetaApiAxiosParamCreator(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestBeta} createOAuthClientRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createOauthClient(createOAuthClientRequestBeta: CreateOAuthClientRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClient(createOAuthClientRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsBetaApi.createOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsBetaApi.deleteOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsBetaApi.getOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOauthClients(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClients(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsBetaApi.listOauthClients']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationBeta A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOauthClient(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClient(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsBetaApi.patchOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OAuthClientsBetaApi - factory interface - * @export - */ -export const OAuthClientsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OAuthClientsBetaApiFp(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsBetaApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient(requestParameters: OAuthClientsBetaApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createOauthClient(requestParameters.createOAuthClientRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsBetaApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient(requestParameters: OAuthClientsBetaApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsBetaApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient(requestParameters: OAuthClientsBetaApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsBetaApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients(requestParameters: OAuthClientsBetaApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage - * @summary Patch oauth client - * @param {OAuthClientsBetaApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient(requestParameters: OAuthClientsBetaApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createOauthClient operation in OAuthClientsBetaApi. - * @export - * @interface OAuthClientsBetaApiCreateOauthClientRequest - */ -export interface OAuthClientsBetaApiCreateOauthClientRequest { - /** - * - * @type {CreateOAuthClientRequestBeta} - * @memberof OAuthClientsBetaApiCreateOauthClient - */ - readonly createOAuthClientRequestBeta: CreateOAuthClientRequestBeta -} - -/** - * Request parameters for deleteOauthClient operation in OAuthClientsBetaApi. - * @export - * @interface OAuthClientsBetaApiDeleteOauthClientRequest - */ -export interface OAuthClientsBetaApiDeleteOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsBetaApiDeleteOauthClient - */ - readonly id: string -} - -/** - * Request parameters for getOauthClient operation in OAuthClientsBetaApi. - * @export - * @interface OAuthClientsBetaApiGetOauthClientRequest - */ -export interface OAuthClientsBetaApiGetOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsBetaApiGetOauthClient - */ - readonly id: string -} - -/** - * Request parameters for listOauthClients operation in OAuthClientsBetaApi. - * @export - * @interface OAuthClientsBetaApiListOauthClientsRequest - */ -export interface OAuthClientsBetaApiListOauthClientsRequest { - /** - * 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof OAuthClientsBetaApiListOauthClients - */ - readonly filters?: string -} - -/** - * Request parameters for patchOauthClient operation in OAuthClientsBetaApi. - * @export - * @interface OAuthClientsBetaApiPatchOauthClientRequest - */ -export interface OAuthClientsBetaApiPatchOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsBetaApiPatchOauthClient - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @type {Array} - * @memberof OAuthClientsBetaApiPatchOauthClient - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * OAuthClientsBetaApi - object-oriented interface - * @export - * @class OAuthClientsBetaApi - * @extends {BaseAPI} - */ -export class OAuthClientsBetaApi extends BaseAPI { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsBetaApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsBetaApi - */ - public createOauthClient(requestParameters: OAuthClientsBetaApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsBetaApiFp(this.configuration).createOauthClient(requestParameters.createOAuthClientRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsBetaApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsBetaApi - */ - public deleteOauthClient(requestParameters: OAuthClientsBetaApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsBetaApiFp(this.configuration).deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsBetaApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsBetaApi - */ - public getOauthClient(requestParameters: OAuthClientsBetaApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsBetaApiFp(this.configuration).getOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsBetaApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsBetaApi - */ - public listOauthClients(requestParameters: OAuthClientsBetaApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsBetaApiFp(this.configuration).listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage - * @summary Patch oauth client - * @param {OAuthClientsBetaApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsBetaApi - */ - public patchOauthClient(requestParameters: OAuthClientsBetaApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsBetaApiFp(this.configuration).patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OrgConfigBetaApi - axios parameter creator - * @export - */ -export const OrgConfigBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get org configuration with only external (org admin) accessible properties for the current org. - * @summary Get org configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of valid time zones that can be set in org configurations. - * @summary Get list of time zones - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/org-config/valid-time-zones`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. - * @summary Patch an org configuration property - * @param {Array} jsonPatchOperationBeta A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig: async (jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchOrgConfig', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OrgConfigBetaApi - functional programming interface - * @export - */ -export const OrgConfigBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrgConfigBetaApiAxiosParamCreator(configuration) - return { - /** - * Get org configuration with only external (org admin) accessible properties for the current org. - * @summary Get org configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigBetaApi.getOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of valid time zones that can be set in org configurations. - * @summary Get list of time zones - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getValidTimeZones(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZones(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigBetaApi.getValidTimeZones']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. - * @summary Patch an org configuration property - * @param {Array} jsonPatchOperationBeta A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOrgConfig(jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfig(jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigBetaApi.patchOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OrgConfigBetaApi - factory interface - * @export - */ -export const OrgConfigBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrgConfigBetaApiFp(configuration) - return { - /** - * Get org configuration with only external (org admin) accessible properties for the current org. - * @summary Get org configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of valid time zones that can be set in org configurations. - * @summary Get list of time zones - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getValidTimeZones(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. - * @summary Patch an org configuration property - * @param {OrgConfigBetaApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig(requestParameters: OrgConfigBetaApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOrgConfig(requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for patchOrgConfig operation in OrgConfigBetaApi. - * @export - * @interface OrgConfigBetaApiPatchOrgConfigRequest - */ -export interface OrgConfigBetaApiPatchOrgConfigRequest { - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof OrgConfigBetaApiPatchOrgConfig - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * OrgConfigBetaApi - object-oriented interface - * @export - * @class OrgConfigBetaApi - * @extends {BaseAPI} - */ -export class OrgConfigBetaApi extends BaseAPI { - /** - * Get org configuration with only external (org admin) accessible properties for the current org. - * @summary Get org configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigBetaApi - */ - public getOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigBetaApiFp(this.configuration).getOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of valid time zones that can be set in org configurations. - * @summary Get list of time zones - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigBetaApi - */ - public getValidTimeZones(axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigBetaApiFp(this.configuration).getValidTimeZones(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. - * @summary Patch an org configuration property - * @param {OrgConfigBetaApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigBetaApi - */ - public patchOrgConfig(requestParameters: OrgConfigBetaApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigBetaApiFp(this.configuration).patchOrgConfig(requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordConfigurationBetaApi - axios parameter creator - * @export - */ -export const PasswordConfigurationBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigBeta} passwordOrgConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig: async (passwordOrgConfigBeta: PasswordOrgConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigBeta' is not null or undefined - assertParamExists('createPasswordOrgConfig', 'passwordOrgConfigBeta', passwordOrgConfigBeta) - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigBeta} passwordOrgConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig: async (passwordOrgConfigBeta: PasswordOrgConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigBeta' is not null or undefined - assertParamExists('putPasswordOrgConfig', 'passwordOrgConfigBeta', passwordOrgConfigBeta) - const localVarPath = `/password-org-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordConfigurationBetaApi - functional programming interface - * @export - */ -export const PasswordConfigurationBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordConfigurationBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigBeta} passwordOrgConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordOrgConfig(passwordOrgConfigBeta: PasswordOrgConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfig(passwordOrgConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationBetaApi.createPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationBetaApi.getPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigBeta} passwordOrgConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordOrgConfig(passwordOrgConfigBeta: PasswordOrgConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfig(passwordOrgConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationBetaApi.putPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordConfigurationBetaApi - factory interface - * @export - */ -export const PasswordConfigurationBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordConfigurationBetaApiFp(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig(requestParameters: PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordOrgConfig(requestParameters.passwordOrgConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationBetaApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig(requestParameters: PasswordConfigurationBetaApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordOrgConfig(requestParameters.passwordOrgConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordOrgConfig operation in PasswordConfigurationBetaApi. - * @export - * @interface PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest - */ -export interface PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigBeta} - * @memberof PasswordConfigurationBetaApiCreatePasswordOrgConfig - */ - readonly passwordOrgConfigBeta: PasswordOrgConfigBeta -} - -/** - * Request parameters for putPasswordOrgConfig operation in PasswordConfigurationBetaApi. - * @export - * @interface PasswordConfigurationBetaApiPutPasswordOrgConfigRequest - */ -export interface PasswordConfigurationBetaApiPutPasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigBeta} - * @memberof PasswordConfigurationBetaApiPutPasswordOrgConfig - */ - readonly passwordOrgConfigBeta: PasswordOrgConfigBeta -} - -/** - * PasswordConfigurationBetaApi - object-oriented interface - * @export - * @class PasswordConfigurationBetaApi - * @extends {BaseAPI} - */ -export class PasswordConfigurationBetaApi extends BaseAPI { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationBetaApi - */ - public createPasswordOrgConfig(requestParameters: PasswordConfigurationBetaApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationBetaApiFp(this.configuration).createPasswordOrgConfig(requestParameters.passwordOrgConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationBetaApi - */ - public getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationBetaApiFp(this.configuration).getPasswordOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationBetaApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationBetaApi - */ - public putPasswordOrgConfig(requestParameters: PasswordConfigurationBetaApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationBetaApiFp(this.configuration).putPasswordOrgConfig(requestParameters.passwordOrgConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordDictionaryBetaApi - axios parameter creator - * @export - */ -export const PasswordDictionaryBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordDictionaryBetaApi - functional programming interface - * @export - */ -export const PasswordDictionaryBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordDictionaryBetaApiAxiosParamCreator(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryBetaApi.getPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordDictionary(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionary(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryBetaApi.putPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordDictionaryBetaApi - factory interface - * @export - */ -export const PasswordDictionaryBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordDictionaryBetaApiFp(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordDictionary(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryBetaApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary(requestParameters: PasswordDictionaryBetaApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for putPasswordDictionary operation in PasswordDictionaryBetaApi. - * @export - * @interface PasswordDictionaryBetaApiPutPasswordDictionaryRequest - */ -export interface PasswordDictionaryBetaApiPutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PasswordDictionaryBetaApiPutPasswordDictionary - */ - readonly file?: File -} - -/** - * PasswordDictionaryBetaApi - object-oriented interface - * @export - * @class PasswordDictionaryBetaApi - * @extends {BaseAPI} - */ -export class PasswordDictionaryBetaApi extends BaseAPI { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryBetaApi - */ - public getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryBetaApiFp(this.configuration).getPasswordDictionary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryBetaApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryBetaApi - */ - public putPasswordDictionary(requestParameters: PasswordDictionaryBetaApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryBetaApiFp(this.configuration).putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordManagementBetaApi - axios parameter creator - * @export - */ -export const PasswordManagementBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetBeta} passwordDigitTokenResetBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken: async (passwordDigitTokenResetBeta: PasswordDigitTokenResetBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordDigitTokenResetBeta' is not null or undefined - assertParamExists('createDigitToken', 'passwordDigitTokenResetBeta', passwordDigitTokenResetBeta) - const localVarPath = `/generate-password-reset-token/digit`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordDigitTokenResetBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - * @summary Get password change request status - * @param {string} id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityPasswordChangeStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityPasswordChangeStatus', 'id', id) - const localVarPath = `/password-change-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned. - * @summary Query password info - * @param {PasswordInfoQueryDTOBeta} passwordInfoQueryDTOBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo: async (passwordInfoQueryDTOBeta: PasswordInfoQueryDTOBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordInfoQueryDTOBeta' is not null or undefined - assertParamExists('queryPasswordInfo', 'passwordInfoQueryDTOBeta', passwordInfoQueryDTOBeta) - const localVarPath = `/query-password-info`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordInfoQueryDTOBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestBeta} passwordChangeRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIdentityPassword: async (passwordChangeRequestBeta: PasswordChangeRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordChangeRequestBeta' is not null or undefined - assertParamExists('setIdentityPassword', 'passwordChangeRequestBeta', passwordChangeRequestBeta) - const localVarPath = `/set-password`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordChangeRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordManagementBetaApi - functional programming interface - * @export - */ -export const PasswordManagementBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordManagementBetaApiAxiosParamCreator(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetBeta} passwordDigitTokenResetBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDigitToken(passwordDigitTokenResetBeta: PasswordDigitTokenResetBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDigitToken(passwordDigitTokenResetBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementBetaApi.createDigitToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - * @summary Get password change request status - * @param {string} id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityPasswordChangeStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityPasswordChangeStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementBetaApi.getIdentityPasswordChangeStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned. - * @summary Query password info - * @param {PasswordInfoQueryDTOBeta} passwordInfoQueryDTOBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async queryPasswordInfo(passwordInfoQueryDTOBeta: PasswordInfoQueryDTOBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfo(passwordInfoQueryDTOBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementBetaApi.queryPasswordInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestBeta} passwordChangeRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setIdentityPassword(passwordChangeRequestBeta: PasswordChangeRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setIdentityPassword(passwordChangeRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementBetaApi.setIdentityPassword']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordManagementBetaApi - factory interface - * @export - */ -export const PasswordManagementBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordManagementBetaApiFp(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementBetaApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken(requestParameters: PasswordManagementBetaApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDigitToken(requestParameters.passwordDigitTokenResetBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - * @summary Get password change request status - * @param {PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityPasswordChangeStatus(requestParameters: PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned. - * @summary Query password info - * @param {PasswordManagementBetaApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo(requestParameters: PasswordManagementBetaApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.queryPasswordInfo(requestParameters.passwordInfoQueryDTOBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementBetaApiSetIdentityPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIdentityPassword(requestParameters: PasswordManagementBetaApiSetIdentityPasswordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setIdentityPassword(requestParameters.passwordChangeRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDigitToken operation in PasswordManagementBetaApi. - * @export - * @interface PasswordManagementBetaApiCreateDigitTokenRequest - */ -export interface PasswordManagementBetaApiCreateDigitTokenRequest { - /** - * - * @type {PasswordDigitTokenResetBeta} - * @memberof PasswordManagementBetaApiCreateDigitToken - */ - readonly passwordDigitTokenResetBeta: PasswordDigitTokenResetBeta -} - -/** - * Request parameters for getIdentityPasswordChangeStatus operation in PasswordManagementBetaApi. - * @export - * @interface PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest - */ -export interface PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest { - /** - * - * @type {string} - * @memberof PasswordManagementBetaApiGetIdentityPasswordChangeStatus - */ - readonly id: string -} - -/** - * Request parameters for queryPasswordInfo operation in PasswordManagementBetaApi. - * @export - * @interface PasswordManagementBetaApiQueryPasswordInfoRequest - */ -export interface PasswordManagementBetaApiQueryPasswordInfoRequest { - /** - * - * @type {PasswordInfoQueryDTOBeta} - * @memberof PasswordManagementBetaApiQueryPasswordInfo - */ - readonly passwordInfoQueryDTOBeta: PasswordInfoQueryDTOBeta -} - -/** - * Request parameters for setIdentityPassword operation in PasswordManagementBetaApi. - * @export - * @interface PasswordManagementBetaApiSetIdentityPasswordRequest - */ -export interface PasswordManagementBetaApiSetIdentityPasswordRequest { - /** - * - * @type {PasswordChangeRequestBeta} - * @memberof PasswordManagementBetaApiSetIdentityPassword - */ - readonly passwordChangeRequestBeta: PasswordChangeRequestBeta -} - -/** - * PasswordManagementBetaApi - object-oriented interface - * @export - * @class PasswordManagementBetaApi - * @extends {BaseAPI} - */ -export class PasswordManagementBetaApi extends BaseAPI { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementBetaApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementBetaApi - */ - public createDigitToken(requestParameters: PasswordManagementBetaApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementBetaApiFp(this.configuration).createDigitToken(requestParameters.passwordDigitTokenResetBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - * @summary Get password change request status - * @param {PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementBetaApi - */ - public getIdentityPasswordChangeStatus(requestParameters: PasswordManagementBetaApiGetIdentityPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementBetaApiFp(this.configuration).getIdentityPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to query password related information. A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) is required to call this API. \"API authority\" refers to a token that only has the \"client_credentials\" grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned. - * @summary Query password info - * @param {PasswordManagementBetaApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementBetaApi - */ - public queryPasswordInfo(requestParameters: PasswordManagementBetaApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementBetaApiFp(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTOBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity\'s password or the password of any of the identity\'s accounts. \"API authority\" refers to a token that only has the \"client_credentials\" grant type. >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). To do so, follow these steps: 1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. 2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. 3. Use [Set Identity\'s Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: ```java import javax.crypto.Cipher; import java.security.KeyFactory; import java.security.PublicKey; import java.security.spec.X509EncodedKeySpec; import java util.Base64; String encrypt(String publicKey, String toEncrypt) throws Exception { byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes(\"UTF-8\")); return Base64.getEncoder().encodeToString(encryptedBytes); } private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { PublicKey key = KeyFactory.getInstance(\"RSA\").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); String transformation = \"RSA/ECB/PKCS1Padding\"; Cipher cipher = Cipher.getInstance(transformation); cipher.init(1, key); return cipher.doFinal(toEncryptBytes); } ``` In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementBetaApiSetIdentityPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementBetaApi - */ - public setIdentityPassword(requestParameters: PasswordManagementBetaApiSetIdentityPasswordRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementBetaApiFp(this.configuration).setIdentityPassword(requestParameters.passwordChangeRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordPoliciesBetaApi - axios parameter creator - * @export - */ -export const PasswordPoliciesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoBeta} passwordPolicyV3DtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy: async (passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordPolicyV3DtoBeta' is not null or undefined - assertParamExists('createPasswordPolicy', 'passwordPolicyV3DtoBeta', passwordPolicyV3DtoBeta) - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordPolicy', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordPolicyById', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoBeta} passwordPolicyV3DtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy: async (id: string, passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setPasswordPolicy', 'id', id) - // verify required parameter 'passwordPolicyV3DtoBeta' is not null or undefined - assertParamExists('setPasswordPolicy', 'passwordPolicyV3DtoBeta', passwordPolicyV3DtoBeta) - const localVarPath = `/password-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordPoliciesBetaApi - functional programming interface - * @export - */ -export const PasswordPoliciesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordPoliciesBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoBeta} passwordPolicyV3DtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordPolicy(passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicy(passwordPolicyV3DtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesBetaApi.createPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesBetaApi.deletePasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordPolicyById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesBetaApi.getPasswordPolicyById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicies(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicies(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesBetaApi.listPasswordPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoBeta} passwordPolicyV3DtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPasswordPolicy(id: string, passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicy(id, passwordPolicyV3DtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesBetaApi.setPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordPoliciesBetaApi - factory interface - * @export - */ -export const PasswordPoliciesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordPoliciesBetaApiFp(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesBetaApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy(requestParameters: PasswordPoliciesBetaApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordPolicy(requestParameters.passwordPolicyV3DtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesBetaApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy(requestParameters: PasswordPoliciesBetaApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById(requestParameters: PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesBetaApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies(requestParameters: PasswordPoliciesBetaApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesBetaApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy(requestParameters: PasswordPoliciesBetaApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordPolicy operation in PasswordPoliciesBetaApi. - * @export - * @interface PasswordPoliciesBetaApiCreatePasswordPolicyRequest - */ -export interface PasswordPoliciesBetaApiCreatePasswordPolicyRequest { - /** - * - * @type {PasswordPolicyV3DtoBeta} - * @memberof PasswordPoliciesBetaApiCreatePasswordPolicy - */ - readonly passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta -} - -/** - * Request parameters for deletePasswordPolicy operation in PasswordPoliciesBetaApi. - * @export - * @interface PasswordPoliciesBetaApiDeletePasswordPolicyRequest - */ -export interface PasswordPoliciesBetaApiDeletePasswordPolicyRequest { - /** - * The ID of password policy to delete. - * @type {string} - * @memberof PasswordPoliciesBetaApiDeletePasswordPolicy - */ - readonly id: string -} - -/** - * Request parameters for getPasswordPolicyById operation in PasswordPoliciesBetaApi. - * @export - * @interface PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest - */ -export interface PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest { - /** - * The ID of password policy to retrieve. - * @type {string} - * @memberof PasswordPoliciesBetaApiGetPasswordPolicyById - */ - readonly id: string -} - -/** - * Request parameters for listPasswordPolicies operation in PasswordPoliciesBetaApi. - * @export - * @interface PasswordPoliciesBetaApiListPasswordPoliciesRequest - */ -export interface PasswordPoliciesBetaApiListPasswordPoliciesRequest { - /** - * 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 PasswordPoliciesBetaApiListPasswordPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordPoliciesBetaApiListPasswordPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordPoliciesBetaApiListPasswordPolicies - */ - readonly count?: boolean -} - -/** - * Request parameters for setPasswordPolicy operation in PasswordPoliciesBetaApi. - * @export - * @interface PasswordPoliciesBetaApiSetPasswordPolicyRequest - */ -export interface PasswordPoliciesBetaApiSetPasswordPolicyRequest { - /** - * The ID of password policy to update. - * @type {string} - * @memberof PasswordPoliciesBetaApiSetPasswordPolicy - */ - readonly id: string - - /** - * - * @type {PasswordPolicyV3DtoBeta} - * @memberof PasswordPoliciesBetaApiSetPasswordPolicy - */ - readonly passwordPolicyV3DtoBeta: PasswordPolicyV3DtoBeta -} - -/** - * PasswordPoliciesBetaApi - object-oriented interface - * @export - * @class PasswordPoliciesBetaApi - * @extends {BaseAPI} - */ -export class PasswordPoliciesBetaApi extends BaseAPI { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesBetaApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesBetaApi - */ - public createPasswordPolicy(requestParameters: PasswordPoliciesBetaApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesBetaApiFp(this.configuration).createPasswordPolicy(requestParameters.passwordPolicyV3DtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesBetaApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesBetaApi - */ - public deletePasswordPolicy(requestParameters: PasswordPoliciesBetaApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesBetaApiFp(this.configuration).deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesBetaApi - */ - public getPasswordPolicyById(requestParameters: PasswordPoliciesBetaApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesBetaApiFp(this.configuration).getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesBetaApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesBetaApi - */ - public listPasswordPolicies(requestParameters: PasswordPoliciesBetaApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesBetaApiFp(this.configuration).listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesBetaApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesBetaApi - */ - public setPasswordPolicy(requestParameters: PasswordPoliciesBetaApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesBetaApiFp(this.configuration).setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordSyncGroupsBetaApi - axios parameter creator - * @export - */ -export const PasswordSyncGroupsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupBeta} passwordSyncGroupBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup: async (passwordSyncGroupBeta: PasswordSyncGroupBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordSyncGroupBeta' is not null or undefined - assertParamExists('createPasswordSyncGroup', 'passwordSyncGroupBeta', passwordSyncGroupBeta) - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupBeta} passwordSyncGroupBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup: async (id: string, passwordSyncGroupBeta: PasswordSyncGroupBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'id', id) - // verify required parameter 'passwordSyncGroupBeta' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'passwordSyncGroupBeta', passwordSyncGroupBeta) - const localVarPath = `/password-sync-groups/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordSyncGroupsBetaApi - functional programming interface - * @export - */ -export const PasswordSyncGroupsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordSyncGroupsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupBeta} passwordSyncGroupBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordSyncGroup(passwordSyncGroupBeta: PasswordSyncGroupBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroup(passwordSyncGroupBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsBetaApi.createPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsBetaApi.deletePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsBetaApi.getPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroups(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsBetaApi.getPasswordSyncGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupBeta} passwordSyncGroupBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordSyncGroup(id: string, passwordSyncGroupBeta: PasswordSyncGroupBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroup(id, passwordSyncGroupBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsBetaApi.updatePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordSyncGroupsBetaApi - factory interface - * @export - */ -export const PasswordSyncGroupsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordSyncGroupsBetaApiFp(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordSyncGroup(requestParameters.passwordSyncGroupBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups(requestParameters: PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsBetaApi. - * @export - * @interface PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest { - /** - * - * @type {PasswordSyncGroupBeta} - * @memberof PasswordSyncGroupsBetaApiCreatePasswordSyncGroup - */ - readonly passwordSyncGroupBeta: PasswordSyncGroupBeta -} - -/** - * Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsBetaApi. - * @export - * @interface PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest { - /** - * The ID of password sync group to delete. - * @type {string} - * @memberof PasswordSyncGroupsBetaApiDeletePasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsBetaApi. - * @export - * @interface PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest { - /** - * The ID of password sync group to retrieve. - * @type {string} - * @memberof PasswordSyncGroupsBetaApiGetPasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsBetaApi. - * @export - * @interface PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest - */ -export interface PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest { - /** - * 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 PasswordSyncGroupsBetaApiGetPasswordSyncGroups - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordSyncGroupsBetaApiGetPasswordSyncGroups - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordSyncGroupsBetaApiGetPasswordSyncGroups - */ - readonly count?: boolean -} - -/** - * Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsBetaApi. - * @export - * @interface PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest { - /** - * The ID of password sync group to update. - * @type {string} - * @memberof PasswordSyncGroupsBetaApiUpdatePasswordSyncGroup - */ - readonly id: string - - /** - * - * @type {PasswordSyncGroupBeta} - * @memberof PasswordSyncGroupsBetaApiUpdatePasswordSyncGroup - */ - readonly passwordSyncGroupBeta: PasswordSyncGroupBeta -} - -/** - * PasswordSyncGroupsBetaApi - object-oriented interface - * @export - * @class PasswordSyncGroupsBetaApi - * @extends {BaseAPI} - */ -export class PasswordSyncGroupsBetaApi extends BaseAPI { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsBetaApi - */ - public createPasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsBetaApiFp(this.configuration).createPasswordSyncGroup(requestParameters.passwordSyncGroupBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsBetaApi - */ - public deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsBetaApiFp(this.configuration).deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsBetaApi - */ - public getPasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsBetaApiFp(this.configuration).getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsBetaApi - */ - public getPasswordSyncGroups(requestParameters: PasswordSyncGroupsBetaApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsBetaApiFp(this.configuration).getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsBetaApi - */ - public updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsBetaApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsBetaApiFp(this.configuration).updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PersonalAccessTokensBetaApi - axios parameter creator - * @export - */ -export const PersonalAccessTokensBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestBeta} createPersonalAccessTokenRequestBeta Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken: async (createPersonalAccessTokenRequestBeta: CreatePersonalAccessTokenRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPersonalAccessTokenRequestBeta' is not null or undefined - assertParamExists('createPersonalAccessToken', 'createPersonalAccessTokenRequestBeta', createPersonalAccessTokenRequestBeta) - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPersonalAccessTokenRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePersonalAccessToken', 'id', id) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationBeta A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PersonalAccessTokensBetaApi - functional programming interface - * @export - */ -export const PersonalAccessTokensBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PersonalAccessTokensBetaApiAxiosParamCreator(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestBeta} createPersonalAccessTokenRequestBeta Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPersonalAccessToken(createPersonalAccessTokenRequestBeta: CreatePersonalAccessTokenRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessToken(createPersonalAccessTokenRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensBetaApi.createPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePersonalAccessToken(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessToken(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensBetaApi.deletePersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokens(ownerId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensBetaApi.listPersonalAccessTokens']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationBeta A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPersonalAccessToken(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessToken(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensBetaApi.patchPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PersonalAccessTokensBetaApi - factory interface - * @export - */ -export const PersonalAccessTokensBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PersonalAccessTokensBetaApiFp(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensBetaApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens(requestParameters: PersonalAccessTokensBetaApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. - * @summary Patch personal access token - * @param {PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPersonalAccessToken operation in PersonalAccessTokensBetaApi. - * @export - * @interface PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest { - /** - * Name and scope of personal access token. - * @type {CreatePersonalAccessTokenRequestBeta} - * @memberof PersonalAccessTokensBetaApiCreatePersonalAccessToken - */ - readonly createPersonalAccessTokenRequestBeta: CreatePersonalAccessTokenRequestBeta -} - -/** - * Request parameters for deletePersonalAccessToken operation in PersonalAccessTokensBetaApi. - * @export - * @interface PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest { - /** - * The personal access token id - * @type {string} - * @memberof PersonalAccessTokensBetaApiDeletePersonalAccessToken - */ - readonly id: string -} - -/** - * Request parameters for listPersonalAccessTokens operation in PersonalAccessTokensBetaApi. - * @export - * @interface PersonalAccessTokensBetaApiListPersonalAccessTokensRequest - */ -export interface PersonalAccessTokensBetaApiListPersonalAccessTokensRequest { - /** - * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @type {string} - * @memberof PersonalAccessTokensBetaApiListPersonalAccessTokens - */ - readonly ownerId?: 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof PersonalAccessTokensBetaApiListPersonalAccessTokens - */ - readonly filters?: string -} - -/** - * Request parameters for patchPersonalAccessToken operation in PersonalAccessTokensBetaApi. - * @export - * @interface PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest - */ -export interface PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest { - /** - * The Personal Access Token id - * @type {string} - * @memberof PersonalAccessTokensBetaApiPatchPersonalAccessToken - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @type {Array} - * @memberof PersonalAccessTokensBetaApiPatchPersonalAccessToken - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * PersonalAccessTokensBetaApi - object-oriented interface - * @export - * @class PersonalAccessTokensBetaApi - * @extends {BaseAPI} - */ -export class PersonalAccessTokensBetaApi extends BaseAPI { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensBetaApi - */ - public createPersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensBetaApiFp(this.configuration).createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensBetaApi - */ - public deletePersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensBetaApiFp(this.configuration).deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensBetaApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensBetaApi - */ - public listPersonalAccessTokens(requestParameters: PersonalAccessTokensBetaApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensBetaApiFp(this.configuration).listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of a Personal Access Token. - * @summary Patch personal access token - * @param {PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensBetaApi - */ - public patchPersonalAccessToken(requestParameters: PersonalAccessTokensBetaApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensBetaApiFp(this.configuration).patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesConfigBetaApi - axios parameter creator - * @export - */ -export const PublicIdentitiesConfigBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets details of public identity config. - * @summary Get public identity config - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPublicIdentityConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates the details of public identity config. - * @summary Update public identity config - * @param {PublicIdentityConfigBeta} publicIdentityConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updatePublicIdentityConfig: async (publicIdentityConfigBeta: PublicIdentityConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'publicIdentityConfigBeta' is not null or undefined - assertParamExists('updatePublicIdentityConfig', 'publicIdentityConfigBeta', publicIdentityConfigBeta) - const localVarPath = `/public-identities-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(publicIdentityConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PublicIdentitiesConfigBetaApi - functional programming interface - * @export - */ -export const PublicIdentitiesConfigBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesConfigBetaApiAxiosParamCreator(configuration) - return { - /** - * This gets details of public identity config. - * @summary Get public identity config - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigBetaApi.getPublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates the details of public identity config. - * @summary Update public identity config - * @param {PublicIdentityConfigBeta} publicIdentityConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updatePublicIdentityConfig(publicIdentityConfigBeta: PublicIdentityConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfig(publicIdentityConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigBetaApi.updatePublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesConfigBetaApi - factory interface - * @export - */ -export const PublicIdentitiesConfigBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesConfigBetaApiFp(configuration) - return { - /** - * This gets details of public identity config. - * @summary Get public identity config - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPublicIdentityConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates the details of public identity config. - * @summary Update public identity config - * @param {PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePublicIdentityConfig(requestParameters.publicIdentityConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updatePublicIdentityConfig operation in PublicIdentitiesConfigBetaApi. - * @export - * @interface PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest - */ -export interface PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest { - /** - * - * @type {PublicIdentityConfigBeta} - * @memberof PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfig - */ - readonly publicIdentityConfigBeta: PublicIdentityConfigBeta -} - -/** - * PublicIdentitiesConfigBetaApi - object-oriented interface - * @export - * @class PublicIdentitiesConfigBetaApi - * @extends {BaseAPI} - */ -export class PublicIdentitiesConfigBetaApi extends BaseAPI { - /** - * This gets details of public identity config. - * @summary Get public identity config - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigBetaApi - */ - public getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigBetaApiFp(this.configuration).getPublicIdentityConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates the details of public identity config. - * @summary Update public identity config - * @param {PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigBetaApi - */ - public updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigBetaApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigBetaApiFp(this.configuration).updatePublicIdentityConfig(requestParameters.publicIdentityConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RequestableObjectsBetaApi - axios parameter creator - * @export - */ -export const RequestableObjectsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/requestable-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (types) { - localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); - } - - if (term !== undefined) { - localVarQueryParameter['term'] = term; - } - - if (statuses) { - localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * RequestableObjectsBetaApi - functional programming interface - * @export - */ -export const RequestableObjectsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RequestableObjectsBetaApiAxiosParamCreator(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRequestableObjects(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjects(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RequestableObjectsBetaApi.listRequestableObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RequestableObjectsBetaApi - factory interface - * @export - */ -export const RequestableObjectsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RequestableObjectsBetaApiFp(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsBetaApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects(requestParameters: RequestableObjectsBetaApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listRequestableObjects operation in RequestableObjectsBetaApi. - * @export - * @interface RequestableObjectsBetaApiListRequestableObjectsRequest - */ -export interface RequestableObjectsBetaApiListRequestableObjectsRequest { - /** - * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @type {string} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly identityId?: string - - /** - * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly types?: Array - - /** - * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @type {string} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly term?: string - - /** - * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @type {Array} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly statuses?: Array - - /** - * 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 RequestableObjectsBetaApiListRequestableObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - 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: **name** - * @type {string} - * @memberof RequestableObjectsBetaApiListRequestableObjects - */ - readonly sorters?: string -} - -/** - * RequestableObjectsBetaApi - object-oriented interface - * @export - * @class RequestableObjectsBetaApi - * @extends {BaseAPI} - */ -export class RequestableObjectsBetaApi extends BaseAPI { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsBetaApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RequestableObjectsBetaApi - */ - public listRequestableObjects(requestParameters: RequestableObjectsBetaApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RequestableObjectsBetaApiFp(this.configuration).listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListRequestableObjectsTypesBeta = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type ListRequestableObjectsTypesBeta = typeof ListRequestableObjectsTypesBeta[keyof typeof ListRequestableObjectsTypesBeta]; - - -/** - * RoleInsightsBetaApi - axios parameter creator - * @export - */ -export const RoleInsightsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-insights/requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('downloadRoleInsightsEntitlementsChanges', 'insightId', insightId) - const localVarPath = `/role-insights/{insightId}/entitlement-changes/download` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'insightId', insightId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'entitlementId', entitlementId) - const localVarPath = `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (hasEntitlement !== undefined) { - localVarQueryParameter['hasEntitlement'] = hasEntitlement; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight: async (insightId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsight', 'insightId', insightId) - const localVarPath = `/role-insights/{insightId}` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-insights`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements: async (insightId: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsCurrentEntitlements', 'insightId', insightId) - const localVarPath = `/role-insights/{insightId}/current-entitlements` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsEntitlementsChanges', 'insightId', insightId) - const localVarPath = `/role-insights/{insightId}/entitlement-changes` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleInsightsRequests', 'id', id) - const localVarPath = `/role-insights/requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/role-insights/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RoleInsightsBetaApi - functional programming interface - * @export - */ -export const RoleInsightsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RoleInsightsBetaApiAxiosParamCreator(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createRoleInsightRequests(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequests(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.createRoleInsightRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChanges(insightId, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.downloadRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementChangesIdentities(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentities(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getEntitlementChangesIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsight(insightId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsight(insightId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsight']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsights(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsights(offset, limit, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsights']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsCurrentEntitlements(insightId: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlements(insightId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsightsCurrentEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChanges(insightId, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getRoleInsightsRequests(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequests(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsightsRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsSummary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsBetaApi.getRoleInsightsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RoleInsightsBetaApi - factory interface - * @export - */ -export const RoleInsightsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RoleInsightsBetaApiFp(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleInsightRequests(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities(requestParameters: RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsBetaApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight(requestParameters: RoleInsightsBetaApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsight(requestParameters.insightId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsBetaApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights(requestParameters: RoleInsightsBetaApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsBetaApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests(requestParameters: RoleInsightsBetaApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsRequests(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsSummary(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for downloadRoleInsightsEntitlementsChanges operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @type {string} - * @memberof RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChanges - */ - readonly filters?: string -} - -/** - * Request parameters for getEntitlementChangesIdentities operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest - */ -export interface RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly insightId: string - - /** - * The entitlement id - * @type {string} - * @memberof RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly entitlementId: string - - /** - * Identity has this entitlement or not - * @type {boolean} - * @memberof RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly hasEntitlement?: boolean - - /** - * 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 RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly count?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof RoleInsightsBetaApiGetEntitlementChangesIdentities - */ - readonly filters?: string -} - -/** - * Request parameters for getRoleInsight operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetRoleInsightRequest - */ -export interface RoleInsightsBetaApiGetRoleInsightRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsight - */ - readonly insightId: string -} - -/** - * Request parameters for getRoleInsights operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetRoleInsightsRequest - */ -export interface RoleInsightsBetaApiGetRoleInsightsRequest { - /** - * 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 RoleInsightsBetaApiGetRoleInsights - */ - 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 RoleInsightsBetaApiGetRoleInsights - */ - 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 RoleInsightsBetaApiGetRoleInsights - */ - readonly count?: boolean - - /** - * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsights - */ - readonly sorters?: 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsights - */ - readonly filters?: string -} - -/** - * Request parameters for getRoleInsightsCurrentEntitlements operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest - */ -export interface RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsCurrentEntitlements - */ - readonly insightId: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsCurrentEntitlements - */ - readonly filters?: string -} - -/** - * Request parameters for getRoleInsightsEntitlementsChanges operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess, name** - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsEntitlementsChanges - */ - readonly filters?: string -} - -/** - * Request parameters for getRoleInsightsRequests operation in RoleInsightsBetaApi. - * @export - * @interface RoleInsightsBetaApiGetRoleInsightsRequestsRequest - */ -export interface RoleInsightsBetaApiGetRoleInsightsRequestsRequest { - /** - * The role insights request id - * @type {string} - * @memberof RoleInsightsBetaApiGetRoleInsightsRequests - */ - readonly id: string -} - -/** - * RoleInsightsBetaApi - object-oriented interface - * @export - * @class RoleInsightsBetaApi - * @extends {BaseAPI} - */ -export class RoleInsightsBetaApi extends BaseAPI { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public createRoleInsightRequests(axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).createRoleInsightRequests(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsBetaApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getEntitlementChangesIdentities(requestParameters: RoleInsightsBetaApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsBetaApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsight(requestParameters: RoleInsightsBetaApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsight(requestParameters.insightId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsBetaApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsights(requestParameters: RoleInsightsBetaApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsBetaApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsBetaApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsBetaApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsightsRequests(requestParameters: RoleInsightsBetaApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsightsRequests(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsBetaApi - */ - public getRoleInsightsSummary(axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsBetaApiFp(this.configuration).getRoleInsightsSummary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolesBetaApi - axios parameter creator - * @export - */ -export const RolesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleBeta} roleBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole: async (roleBeta: RoleBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBeta' is not null or undefined - assertParamExists('createRole', 'roleBeta', roleBeta) - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestBeta} roleBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles: async (roleBulkDeleteRequestBeta: RoleBulkDeleteRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBulkDeleteRequestBeta' is not null or undefined - assertParamExists('deleteBulkRoles', 'roleBulkDeleteRequestBeta', roleBulkDeleteRequestBeta) - const localVarPath = `/roles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBulkDeleteRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleAssignedIdentities', 'id', id) - const localVarPath = `/roles/{id}/assigned-identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleEntitlements', 'id', id) - const localVarPath = `/roles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchRole', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchRole', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolesBetaApi - functional programming interface - * @export - */ -export const RolesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolesBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleBeta} roleBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRole(roleBeta: RoleBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRole(roleBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.createRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestBeta} roleBulkDeleteRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkRoles(roleBulkDeleteRequestBeta: RoleBulkDeleteRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRoles(roleBulkDeleteRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.deleteBulkRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.deleteRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.getRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentities(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.getRoleAssignedIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.getRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.listRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRole(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRole(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesBetaApi.patchRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolesBetaApi - factory interface - * @export - */ -export const RolesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolesBetaApiFp(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesBetaApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole(requestParameters: RolesBetaApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRole(requestParameters.roleBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesBetaApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles(requestParameters: RolesBetaApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesBetaApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole(requestParameters: RolesBetaApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesBetaApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole(requestParameters: RolesBetaApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Identities assigned a role - * @param {RolesBetaApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities(requestParameters: RolesBetaApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesBetaApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements(requestParameters: RolesBetaApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesBetaApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles(requestParameters: RolesBetaApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesBetaApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole(requestParameters: RolesBetaApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRole(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRole operation in RolesBetaApi. - * @export - * @interface RolesBetaApiCreateRoleRequest - */ -export interface RolesBetaApiCreateRoleRequest { - /** - * - * @type {RoleBeta} - * @memberof RolesBetaApiCreateRole - */ - readonly roleBeta: RoleBeta -} - -/** - * Request parameters for deleteBulkRoles operation in RolesBetaApi. - * @export - * @interface RolesBetaApiDeleteBulkRolesRequest - */ -export interface RolesBetaApiDeleteBulkRolesRequest { - /** - * - * @type {RoleBulkDeleteRequestBeta} - * @memberof RolesBetaApiDeleteBulkRoles - */ - readonly roleBulkDeleteRequestBeta: RoleBulkDeleteRequestBeta -} - -/** - * Request parameters for deleteRole operation in RolesBetaApi. - * @export - * @interface RolesBetaApiDeleteRoleRequest - */ -export interface RolesBetaApiDeleteRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesBetaApiDeleteRole - */ - readonly id: string -} - -/** - * Request parameters for getRole operation in RolesBetaApi. - * @export - * @interface RolesBetaApiGetRoleRequest - */ -export interface RolesBetaApiGetRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesBetaApiGetRole - */ - readonly id: string -} - -/** - * Request parameters for getRoleAssignedIdentities operation in RolesBetaApi. - * @export - * @interface RolesBetaApiGetRoleAssignedIdentitiesRequest - */ -export interface RolesBetaApiGetRoleAssignedIdentitiesRequest { - /** - * ID of the Role for which the assigned Identities are to be listed - * @type {string} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @type {string} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - 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, name, aliasName, email** - * @type {string} - * @memberof RolesBetaApiGetRoleAssignedIdentities - */ - readonly sorters?: string -} - -/** - * Request parameters for getRoleEntitlements operation in RolesBetaApi. - * @export - * @interface RolesBetaApiGetRoleEntitlementsRequest - */ -export interface RolesBetaApiGetRoleEntitlementsRequest { - /** - * Containing role\'s ID. - * @type {string} - * @memberof RolesBetaApiGetRoleEntitlements - */ - readonly id: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiGetRoleEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiGetRoleEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesBetaApiGetRoleEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof RolesBetaApiGetRoleEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof RolesBetaApiGetRoleEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listRoles operation in RolesBetaApi. - * @export - * @interface RolesBetaApiListRolesRequest - */ -export interface RolesBetaApiListRolesRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesBetaApiListRoles - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiListRoles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesBetaApiListRoles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesBetaApiListRoles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @type {string} - * @memberof RolesBetaApiListRoles - */ - 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: **name, created, modified** - * @type {string} - * @memberof RolesBetaApiListRoles - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesBetaApiListRoles - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesBetaApiListRoles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchRole operation in RolesBetaApi. - * @export - * @interface RolesBetaApiPatchRoleRequest - */ -export interface RolesBetaApiPatchRoleRequest { - /** - * ID of the Role to patch - * @type {string} - * @memberof RolesBetaApiPatchRole - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof RolesBetaApiPatchRole - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * RolesBetaApi - object-oriented interface - * @export - * @class RolesBetaApi - * @extends {BaseAPI} - */ -export class RolesBetaApi extends BaseAPI { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesBetaApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public createRole(requestParameters: RolesBetaApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).createRole(requestParameters.roleBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesBetaApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public deleteBulkRoles(requestParameters: RolesBetaApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesBetaApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public deleteRole(requestParameters: RolesBetaApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).deleteRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesBetaApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public getRole(requestParameters: RolesBetaApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).getRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Identities assigned a role - * @param {RolesBetaApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public getRoleAssignedIdentities(requestParameters: RolesBetaApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesBetaApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public getRoleEntitlements(requestParameters: RolesBetaApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesBetaApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public listRoles(requestParameters: RolesBetaApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesBetaApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesBetaApi - */ - public patchRole(requestParameters: RolesBetaApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesBetaApiFp(this.configuration).patchRole(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SIMIntegrationsBetaApi - axios parameter creator - * @export - */ -export const SIMIntegrationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Create new sim integration - * @param {SimIntegrationDetailsBeta} simIntegrationDetailsBeta DTO containing the details of the SIM integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration: async (simIntegrationDetailsBeta: SimIntegrationDetailsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'simIntegrationDetailsBeta' is not null or undefined - assertParamExists('createSIMIntegration', 'simIntegrationDetailsBeta', simIntegrationDetailsBeta) - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSIMIntegration', 'id', id) - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSIMIntegration', 'id', id) - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary List the existing sim integrations. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchBeta} jsonPatchBeta The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule: async (id: string, jsonPatchBeta: JsonPatchBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'id', id) - // verify required parameter 'jsonPatchBeta' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'jsonPatchBeta', jsonPatchBeta) - const localVarPath = `/sim-integrations/{id}/beforeProvisioningRule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchBeta} jsonPatchBeta The JsonPatch object that describes the changes of SIM - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes: async (id: string, jsonPatchBeta: JsonPatchBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSIMAttributes', 'id', id) - // verify required parameter 'jsonPatchBeta' is not null or undefined - assertParamExists('patchSIMAttributes', 'jsonPatchBeta', jsonPatchBeta) - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsBeta} simIntegrationDetailsBeta The full DTO of the integration containing the updated model - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration: async (id: string, simIntegrationDetailsBeta: SimIntegrationDetailsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSIMIntegration', 'id', id) - // verify required parameter 'simIntegrationDetailsBeta' is not null or undefined - assertParamExists('putSIMIntegration', 'simIntegrationDetailsBeta', simIntegrationDetailsBeta) - const localVarPath = `/sim-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SIMIntegrationsBetaApi - functional programming interface - * @export - */ -export const SIMIntegrationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SIMIntegrationsBetaApiAxiosParamCreator(configuration) - return { - /** - * Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Create new sim integration - * @param {SimIntegrationDetailsBeta} simIntegrationDetailsBeta DTO containing the details of the SIM integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSIMIntegration(simIntegrationDetailsBeta: SimIntegrationDetailsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSIMIntegration(simIntegrationDetailsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.createSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSIMIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSIMIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.deleteSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.getSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary List the existing sim integrations. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegrations(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrations(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.getSIMIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchBeta} jsonPatchBeta The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchBeforeProvisioningRule(id: string, jsonPatchBeta: JsonPatchBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchBeforeProvisioningRule(id, jsonPatchBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.patchBeforeProvisioningRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchBeta} jsonPatchBeta The JsonPatch object that describes the changes of SIM - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSIMAttributes(id: string, jsonPatchBeta: JsonPatchBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSIMAttributes(id, jsonPatchBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.patchSIMAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsBeta} simIntegrationDetailsBeta The full DTO of the integration containing the updated model - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSIMIntegration(id: string, simIntegrationDetailsBeta: SimIntegrationDetailsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSIMIntegration(id, simIntegrationDetailsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsBetaApi.putSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SIMIntegrationsBetaApi - factory interface - * @export - */ -export const SIMIntegrationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SIMIntegrationsBetaApiFp(configuration) - return { - /** - * Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Create new sim integration - * @param {SIMIntegrationsBetaApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration(requestParameters: SIMIntegrationsBetaApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSIMIntegration(requestParameters.simIntegrationDetailsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Delete a sim integration - * @param {SIMIntegrationsBetaApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration(requestParameters: SIMIntegrationsBetaApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSIMIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Get a sim integration details. - * @param {SIMIntegrationsBetaApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration(requestParameters: SIMIntegrationsBetaApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSIMIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary List the existing sim integrations. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSIMIntegrations(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule(requestParameters: SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsBetaApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes(requestParameters: SIMIntegrationsBetaApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Update an existing sim integration - * @param {SIMIntegrationsBetaApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration(requestParameters: SIMIntegrationsBetaApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSIMIntegration operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiCreateSIMIntegrationRequest - */ -export interface SIMIntegrationsBetaApiCreateSIMIntegrationRequest { - /** - * DTO containing the details of the SIM integration - * @type {SimIntegrationDetailsBeta} - * @memberof SIMIntegrationsBetaApiCreateSIMIntegration - */ - readonly simIntegrationDetailsBeta: SimIntegrationDetailsBeta -} - -/** - * Request parameters for deleteSIMIntegration operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiDeleteSIMIntegrationRequest - */ -export interface SIMIntegrationsBetaApiDeleteSIMIntegrationRequest { - /** - * The id of the integration to delete. - * @type {string} - * @memberof SIMIntegrationsBetaApiDeleteSIMIntegration - */ - readonly id: string -} - -/** - * Request parameters for getSIMIntegration operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiGetSIMIntegrationRequest - */ -export interface SIMIntegrationsBetaApiGetSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsBetaApiGetSIMIntegration - */ - readonly id: string -} - -/** - * Request parameters for patchBeforeProvisioningRule operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest - */ -export interface SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsBetaApiPatchBeforeProvisioningRule - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @type {JsonPatchBeta} - * @memberof SIMIntegrationsBetaApiPatchBeforeProvisioningRule - */ - readonly jsonPatchBeta: JsonPatchBeta -} - -/** - * Request parameters for patchSIMAttributes operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiPatchSIMAttributesRequest - */ -export interface SIMIntegrationsBetaApiPatchSIMAttributesRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsBetaApiPatchSIMAttributes - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM - * @type {JsonPatchBeta} - * @memberof SIMIntegrationsBetaApiPatchSIMAttributes - */ - readonly jsonPatchBeta: JsonPatchBeta -} - -/** - * Request parameters for putSIMIntegration operation in SIMIntegrationsBetaApi. - * @export - * @interface SIMIntegrationsBetaApiPutSIMIntegrationRequest - */ -export interface SIMIntegrationsBetaApiPutSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsBetaApiPutSIMIntegration - */ - readonly id: string - - /** - * The full DTO of the integration containing the updated model - * @type {SimIntegrationDetailsBeta} - * @memberof SIMIntegrationsBetaApiPutSIMIntegration - */ - readonly simIntegrationDetailsBeta: SimIntegrationDetailsBeta -} - -/** - * SIMIntegrationsBetaApi - object-oriented interface - * @export - * @class SIMIntegrationsBetaApi - * @extends {BaseAPI} - */ -export class SIMIntegrationsBetaApi extends BaseAPI { - /** - * Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Create new sim integration - * @param {SIMIntegrationsBetaApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public createSIMIntegration(requestParameters: SIMIntegrationsBetaApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).createSIMIntegration(requestParameters.simIntegrationDetailsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Delete a sim integration - * @param {SIMIntegrationsBetaApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public deleteSIMIntegration(requestParameters: SIMIntegrationsBetaApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).deleteSIMIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Get a sim integration details. - * @param {SIMIntegrationsBetaApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public getSIMIntegration(requestParameters: SIMIntegrationsBetaApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).getSIMIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary List the existing sim integrations. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public getSIMIntegrations(axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).getSIMIntegrations(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public patchBeforeProvisioningRule(requestParameters: SIMIntegrationsBetaApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsBetaApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public patchSIMAttributes(requestParameters: SIMIntegrationsBetaApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - * @summary Update an existing sim integration - * @param {SIMIntegrationsBetaApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsBetaApi - */ - public putSIMIntegration(requestParameters: SIMIntegrationsBetaApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsBetaApiFp(this.configuration).putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODPoliciesBetaApi - axios parameter creator - * @export - */ -export const SODPoliciesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyBeta} sodPolicyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createSodPolicy: async (sodPolicyBeta: SodPolicyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sodPolicyBeta' is not null or undefined - assertParamExists('createSodPolicy', 'sodPolicyBeta', sodPolicyBeta) - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteSodPolicy: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (logical !== undefined) { - localVarQueryParameter['logical'] = logical; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCustomViolationReport: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getCustomViolationReport', 'reportResultId', reportResultId) - // verify required parameter 'fileName' is not null or undefined - assertParamExists('getCustomViolationReport', 'fileName', fileName) - const localVarPath = `/sod-violation-report/{reportResultId}/download/{fileName}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) - .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getDefaultViolationReport: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getDefaultViolationReport', 'reportResultId', reportResultId) - const localVarPath = `/sod-violation-report/{reportResultId}/download` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodAllReportRunStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. Requires the role of ORG_ADMIN. - * @summary Get sod policy schedule - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodViolationReportRunStatus: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getSodViolationReportRunStatus', 'reportResultId', reportResultId) - const localVarPath = `/sod-policies/sod-violation-report-status/{reportResultId}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get sod violation report status - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodViolationReportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodViolationReportStatus', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listSodPolicies: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch a sod policy - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} requestBody A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchSodPolicy: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSodPolicy', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSodPolicy', 'requestBody', requestBody) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleBeta} sodPolicyScheduleBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putPolicySchedule: async (id: string, sodPolicyScheduleBeta: SodPolicyScheduleBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putPolicySchedule', 'id', id) - // verify required parameter 'sodPolicyScheduleBeta' is not null or undefined - assertParamExists('putPolicySchedule', 'sodPolicyScheduleBeta', sodPolicyScheduleBeta) - const localVarPath = `/sod-policies/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyScheduleBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyBeta} sodPolicyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putSodPolicy: async (id: string, sodPolicyBeta: SodPolicyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSodPolicy', 'id', id) - // verify required parameter 'sodPolicyBeta' is not null or undefined - assertParamExists('putSodPolicy', 'sodPolicyBeta', sodPolicyBeta) - const localVarPath = `/sod-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN. - * @summary Runs all policies for org - * @param {MultiPolicyRequestBeta} [multiPolicyRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg: async (multiPolicyRequestBeta?: MultiPolicyRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiPolicyRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report/run` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODPoliciesBetaApi - functional programming interface - * @export - */ -export const SODPoliciesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODPoliciesBetaApiAxiosParamCreator(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyBeta} sodPolicyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createSodPolicy(sodPolicyBeta: SodPolicyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.createSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteSodPolicy(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicy(id, logical, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.deleteSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.deleteSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCustomViolationReport(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReport(reportResultId, fileName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getCustomViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getDefaultViolationReport(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReport(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getDefaultViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getSodAllReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. Requires the role of ORG_ADMIN. - * @summary Get sod policy schedule - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getSodViolationReportRunStatus(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatus(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getSodViolationReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get sod violation report status - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getSodViolationReportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.getSodViolationReportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.listSodPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch a sod policy - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} requestBody A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchSodPolicy(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.patchSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleBeta} sodPolicyScheduleBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async putPolicySchedule(id: string, sodPolicyScheduleBeta: SodPolicyScheduleBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicySchedule(id, sodPolicyScheduleBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.putPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyBeta} sodPolicyBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async putSodPolicy(id: string, sodPolicyBeta: SodPolicyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.putSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN. - * @summary Runs all policies for org - * @param {MultiPolicyRequestBeta} [multiPolicyRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startSodAllPoliciesForOrg(multiPolicyRequestBeta?: MultiPolicyRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrg(multiPolicyRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.startSodAllPoliciesForOrg']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesBetaApi.startSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODPoliciesBetaApi - factory interface - * @export - */ -export const SODPoliciesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODPoliciesBetaApiFp(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesBetaApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createSodPolicy(requestParameters: SODPoliciesBetaApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSodPolicy(requestParameters.sodPolicyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesBetaApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteSodPolicy(requestParameters: SODPoliciesBetaApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy schedule - * @param {SODPoliciesBetaApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteSodPolicySchedule(requestParameters: SODPoliciesBetaApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download custom violation report - * @param {SODPoliciesBetaApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCustomViolationReport(requestParameters: SODPoliciesBetaApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download violation report - * @param {SODPoliciesBetaApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getDefaultViolationReport(requestParameters: SODPoliciesBetaApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodAllReportRunStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesBetaApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodPolicy(requestParameters: SODPoliciesBetaApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. Requires the role of ORG_ADMIN. - * @summary Get sod policy schedule - * @param {SODPoliciesBetaApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodPolicySchedule(requestParameters: SODPoliciesBetaApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get violation report run status - * @param {SODPoliciesBetaApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodViolationReportRunStatus(requestParameters: SODPoliciesBetaApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get sod violation report status - * @param {SODPoliciesBetaApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getSodViolationReportStatus(requestParameters: SODPoliciesBetaApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesBetaApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listSodPolicies(requestParameters: SODPoliciesBetaApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch a sod policy - * @param {SODPoliciesBetaApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchSodPolicy(requestParameters: SODPoliciesBetaApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy schedule - * @param {SODPoliciesBetaApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putPolicySchedule(requestParameters: SODPoliciesBetaApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesBetaApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - putSodPolicy(requestParameters: SODPoliciesBetaApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN. - * @summary Runs all policies for org - * @param {SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg(requestParameters: SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. - * @summary Runs sod policy violation report - * @param {SODPoliciesBetaApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startSodPolicy(requestParameters: SODPoliciesBetaApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiCreateSodPolicyRequest - */ -export interface SODPoliciesBetaApiCreateSodPolicyRequest { - /** - * - * @type {SodPolicyBeta} - * @memberof SODPoliciesBetaApiCreateSodPolicy - */ - readonly sodPolicyBeta: SodPolicyBeta -} - -/** - * Request parameters for deleteSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiDeleteSodPolicyRequest - */ -export interface SODPoliciesBetaApiDeleteSodPolicyRequest { - /** - * The ID of the SOD Policy to delete. - * @type {string} - * @memberof SODPoliciesBetaApiDeleteSodPolicy - */ - readonly id: string - - /** - * Indicates whether this is a soft delete (logical true) or a hard delete. - * @type {boolean} - * @memberof SODPoliciesBetaApiDeleteSodPolicy - */ - readonly logical?: boolean -} - -/** - * Request parameters for deleteSodPolicySchedule operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiDeleteSodPolicyScheduleRequest - */ -export interface SODPoliciesBetaApiDeleteSodPolicyScheduleRequest { - /** - * The ID of the SOD policy the schedule must be deleted for. - * @type {string} - * @memberof SODPoliciesBetaApiDeleteSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getCustomViolationReport operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetCustomViolationReportRequest - */ -export interface SODPoliciesBetaApiGetCustomViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesBetaApiGetCustomViolationReport - */ - readonly reportResultId: string - - /** - * Custom Name for the file. - * @type {string} - * @memberof SODPoliciesBetaApiGetCustomViolationReport - */ - readonly fileName: string -} - -/** - * Request parameters for getDefaultViolationReport operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetDefaultViolationReportRequest - */ -export interface SODPoliciesBetaApiGetDefaultViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesBetaApiGetDefaultViolationReport - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetSodPolicyRequest - */ -export interface SODPoliciesBetaApiGetSodPolicyRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof SODPoliciesBetaApiGetSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for getSodPolicySchedule operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetSodPolicyScheduleRequest - */ -export interface SODPoliciesBetaApiGetSodPolicyScheduleRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof SODPoliciesBetaApiGetSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getSodViolationReportRunStatus operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetSodViolationReportRunStatusRequest - */ -export interface SODPoliciesBetaApiGetSodViolationReportRunStatusRequest { - /** - * The ID of the report reference to retrieve. - * @type {string} - * @memberof SODPoliciesBetaApiGetSodViolationReportRunStatus - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodViolationReportStatus operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiGetSodViolationReportStatusRequest - */ -export interface SODPoliciesBetaApiGetSodViolationReportStatusRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof SODPoliciesBetaApiGetSodViolationReportStatus - */ - readonly id: string -} - -/** - * Request parameters for listSodPolicies operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiListSodPoliciesRequest - */ -export interface SODPoliciesBetaApiListSodPoliciesRequest { - /** - * 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 SODPoliciesBetaApiListSodPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SODPoliciesBetaApiListSodPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SODPoliciesBetaApiListSodPolicies - */ - 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, in* **name**: *eq, in* **state**: *eq, in* - * @type {string} - * @memberof SODPoliciesBetaApiListSodPolicies - */ - 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, name, created, modified, description** - * @type {string} - * @memberof SODPoliciesBetaApiListSodPolicies - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiPatchSodPolicyRequest - */ -export interface SODPoliciesBetaApiPatchSodPolicyRequest { - /** - * The ID of the SOD policy being modified. - * @type {string} - * @memberof SODPoliciesBetaApiPatchSodPolicy - */ - readonly id: string - - /** - * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @type {Array} - * @memberof SODPoliciesBetaApiPatchSodPolicy - */ - readonly requestBody: Array -} - -/** - * Request parameters for putPolicySchedule operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiPutPolicyScheduleRequest - */ -export interface SODPoliciesBetaApiPutPolicyScheduleRequest { - /** - * The ID of the SOD policy to update its schedule. - * @type {string} - * @memberof SODPoliciesBetaApiPutPolicySchedule - */ - readonly id: string - - /** - * - * @type {SodPolicyScheduleBeta} - * @memberof SODPoliciesBetaApiPutPolicySchedule - */ - readonly sodPolicyScheduleBeta: SodPolicyScheduleBeta -} - -/** - * Request parameters for putSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiPutSodPolicyRequest - */ -export interface SODPoliciesBetaApiPutSodPolicyRequest { - /** - * The ID of the SOD policy to update. - * @type {string} - * @memberof SODPoliciesBetaApiPutSodPolicy - */ - readonly id: string - - /** - * - * @type {SodPolicyBeta} - * @memberof SODPoliciesBetaApiPutSodPolicy - */ - readonly sodPolicyBeta: SodPolicyBeta -} - -/** - * Request parameters for startSodAllPoliciesForOrg operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest - */ -export interface SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest { - /** - * - * @type {MultiPolicyRequestBeta} - * @memberof SODPoliciesBetaApiStartSodAllPoliciesForOrg - */ - readonly multiPolicyRequestBeta?: MultiPolicyRequestBeta -} - -/** - * Request parameters for startSodPolicy operation in SODPoliciesBetaApi. - * @export - * @interface SODPoliciesBetaApiStartSodPolicyRequest - */ -export interface SODPoliciesBetaApiStartSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesBetaApiStartSodPolicy - */ - readonly id: string -} - -/** - * SODPoliciesBetaApi - object-oriented interface - * @export - * @class SODPoliciesBetaApi - * @extends {BaseAPI} - */ -export class SODPoliciesBetaApi extends BaseAPI { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesBetaApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public createSodPolicy(requestParameters: SODPoliciesBetaApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesBetaApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public deleteSodPolicy(requestParameters: SODPoliciesBetaApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy schedule - * @param {SODPoliciesBetaApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public deleteSodPolicySchedule(requestParameters: SODPoliciesBetaApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download custom violation report - * @param {SODPoliciesBetaApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getCustomViolationReport(requestParameters: SODPoliciesBetaApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN. - * @summary Download violation report - * @param {SODPoliciesBetaApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getDefaultViolationReport(requestParameters: SODPoliciesBetaApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getSodAllReportRunStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesBetaApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getSodPolicy(requestParameters: SODPoliciesBetaApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets a specified SOD policy\'s schedule. Requires the role of ORG_ADMIN. - * @summary Get sod policy schedule - * @param {SODPoliciesBetaApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getSodPolicySchedule(requestParameters: SODPoliciesBetaApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get violation report run status - * @param {SODPoliciesBetaApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getSodViolationReportRunStatus(requestParameters: SODPoliciesBetaApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. - * @summary Get sod violation report status - * @param {SODPoliciesBetaApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public getSodViolationReportStatus(requestParameters: SODPoliciesBetaApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesBetaApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public listSodPolicies(requestParameters: SODPoliciesBetaApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch a sod policy - * @param {SODPoliciesBetaApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public patchSodPolicy(requestParameters: SODPoliciesBetaApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).patchSodPolicy(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy schedule - * @param {SODPoliciesBetaApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public putPolicySchedule(requestParameters: SODPoliciesBetaApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesBetaApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public putSodPolicy(requestParameters: SODPoliciesBetaApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN. - * @summary Runs all policies for org - * @param {SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public startSodAllPoliciesForOrg(requestParameters: SODPoliciesBetaApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. - * @summary Runs sod policy violation report - * @param {SODPoliciesBetaApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODPoliciesBetaApi - */ - public startSodPolicy(requestParameters: SODPoliciesBetaApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesBetaApiFp(this.configuration).startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODViolationsBetaApi - axios parameter creator - * @export - */ -export const SODViolationsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessBeta} identityWithNewAccessBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startPredictSodViolations: async (identityWithNewAccessBeta: IdentityWithNewAccessBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessBeta' is not null or undefined - assertParamExists('startPredictSodViolations', 'identityWithNewAccessBeta', identityWithNewAccessBeta) - const localVarPath = `/sod-violations/predict`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODViolationsBetaApi - functional programming interface - * @export - */ -export const SODViolationsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODViolationsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessBeta} identityWithNewAccessBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async startPredictSodViolations(identityWithNewAccessBeta: IdentityWithNewAccessBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolations(identityWithNewAccessBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsBetaApi.startPredictSodViolations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODViolationsBetaApi - factory interface - * @export - */ -export const SODViolationsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODViolationsBetaApiFp(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Predict sod violations for identity. - * @param {SODViolationsBetaApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - startPredictSodViolations(requestParameters: SODViolationsBetaApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startPredictSodViolations(requestParameters.identityWithNewAccessBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startPredictSodViolations operation in SODViolationsBetaApi. - * @export - * @interface SODViolationsBetaApiStartPredictSodViolationsRequest - */ -export interface SODViolationsBetaApiStartPredictSodViolationsRequest { - /** - * - * @type {IdentityWithNewAccessBeta} - * @memberof SODViolationsBetaApiStartPredictSodViolations - */ - readonly identityWithNewAccessBeta: IdentityWithNewAccessBeta -} - -/** - * SODViolationsBetaApi - object-oriented interface - * @export - * @class SODViolationsBetaApi - * @extends {BaseAPI} - */ -export class SODViolationsBetaApi extends BaseAPI { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Predict sod violations for identity. - * @param {SODViolationsBetaApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof SODViolationsBetaApi - */ - public startPredictSodViolations(requestParameters: SODViolationsBetaApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsBetaApiFp(this.configuration).startPredictSodViolations(requestParameters.identityWithNewAccessBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SPConfigBetaApi - axios parameter creator - * @export - */ -export const SPConfigBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadBeta} exportPayloadBeta Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig: async (exportPayloadBeta: ExportPayloadBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'exportPayloadBeta' is not null or undefined - assertParamExists('exportSpConfig', 'exportPayloadBeta', exportPayloadBeta) - const localVarPath = `/sp-config/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(exportPayloadBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExport', 'id', id) - const localVarPath = `/sp-config/export/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExportStatus', 'id', id) - const localVarPath = `/sp-config/export/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImport', 'id', id) - const localVarPath = `/sp-config/import/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImportStatus', 'id', id) - const localVarPath = `/sp-config/import/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsBeta} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig: async (data: File, preview?: boolean, _options?: ImportOptionsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('importSpConfig', 'data', data) - const localVarPath = `/sp-config/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (preview !== undefined) { - localVarQueryParameter['preview'] = preview; - } - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (_options !== undefined) { - localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sp-config/config-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SPConfigBetaApi - functional programming interface - * @export - */ -export const SPConfigBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SPConfigBetaApiAxiosParamCreator(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadBeta} exportPayloadBeta Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportSpConfig(exportPayloadBeta: ExportPayloadBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfig(exportPayloadBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.exportSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.getSpConfigExport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.getSpConfigExportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.getSpConfigImport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.getSpConfigImportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsBeta} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSpConfig(data: File, preview?: boolean, _options?: ImportOptionsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfig(data, preview, _options, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.importSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjects(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigBetaApi.listSpConfigObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SPConfigBetaApi - factory interface - * @export - */ -export const SPConfigBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SPConfigBetaApiFp(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigBetaApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig(requestParameters: SPConfigBetaApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportSpConfig(requestParameters.exportPayloadBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigBetaApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport(requestParameters: SPConfigBetaApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigBetaApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus(requestParameters: SPConfigBetaApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigBetaApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport(requestParameters: SPConfigBetaApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Get import job status - * @param {SPConfigBetaApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus(requestParameters: SPConfigBetaApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigBetaApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig(requestParameters: SPConfigBetaApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSpConfigObjects(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportSpConfig operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiExportSpConfigRequest - */ -export interface SPConfigBetaApiExportSpConfigRequest { - /** - * Export options control what will be included in the export. - * @type {ExportPayloadBeta} - * @memberof SPConfigBetaApiExportSpConfig - */ - readonly exportPayloadBeta: ExportPayloadBeta -} - -/** - * Request parameters for getSpConfigExport operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiGetSpConfigExportRequest - */ -export interface SPConfigBetaApiGetSpConfigExportRequest { - /** - * The ID of the export job whose results will be downloaded. - * @type {string} - * @memberof SPConfigBetaApiGetSpConfigExport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigExportStatus operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiGetSpConfigExportStatusRequest - */ -export interface SPConfigBetaApiGetSpConfigExportStatusRequest { - /** - * The ID of the export job whose status will be returned. - * @type {string} - * @memberof SPConfigBetaApiGetSpConfigExportStatus - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImport operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiGetSpConfigImportRequest - */ -export interface SPConfigBetaApiGetSpConfigImportRequest { - /** - * The ID of the import job whose results will be downloaded. - * @type {string} - * @memberof SPConfigBetaApiGetSpConfigImport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImportStatus operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiGetSpConfigImportStatusRequest - */ -export interface SPConfigBetaApiGetSpConfigImportStatusRequest { - /** - * The ID of the import job whose status will be returned. - * @type {string} - * @memberof SPConfigBetaApiGetSpConfigImportStatus - */ - readonly id: string -} - -/** - * Request parameters for importSpConfig operation in SPConfigBetaApi. - * @export - * @interface SPConfigBetaApiImportSpConfigRequest - */ -export interface SPConfigBetaApiImportSpConfigRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof SPConfigBetaApiImportSpConfig - */ - readonly data: File - - /** - * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @type {boolean} - * @memberof SPConfigBetaApiImportSpConfig - */ - readonly preview?: boolean - - /** - * - * @type {ImportOptionsBeta} - * @memberof SPConfigBetaApiImportSpConfig - */ - readonly _options?: ImportOptionsBeta -} - -/** - * SPConfigBetaApi - object-oriented interface - * @export - * @class SPConfigBetaApi - * @extends {BaseAPI} - */ -export class SPConfigBetaApi extends BaseAPI { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigBetaApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public exportSpConfig(requestParameters: SPConfigBetaApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).exportSpConfig(requestParameters.exportPayloadBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigBetaApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public getSpConfigExport(requestParameters: SPConfigBetaApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigBetaApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public getSpConfigExportStatus(requestParameters: SPConfigBetaApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigBetaApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public getSpConfigImport(requestParameters: SPConfigBetaApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Get import job status - * @param {SPConfigBetaApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public getSpConfigImportStatus(requestParameters: SPConfigBetaApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigBetaApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public importSpConfig(requestParameters: SPConfigBetaApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigBetaApi - */ - public listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig) { - return SPConfigBetaApiFp(this.configuration).listSpConfigObjects(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SearchAttributeConfigurationBetaApi - axios parameter creator - * @export - */ -export const SearchAttributeConfigurationBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigBeta} searchAttributeConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig: async (searchAttributeConfigBeta: SearchAttributeConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchAttributeConfigBeta' is not null or undefined - assertParamExists('createSearchAttributeConfig', 'searchAttributeConfigBeta', searchAttributeConfigBeta) - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchAttributeConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteSearchAttributeConfig', 'name', name) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getSingleSearchAttributeConfig', 'name', name) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the extended search attribute configuration to patch. - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig: async (name: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'name', name) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchAttributeConfigurationBetaApi - functional programming interface - * @export - */ -export const SearchAttributeConfigurationBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchAttributeConfigurationBetaApiAxiosParamCreator(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigBeta} searchAttributeConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSearchAttributeConfig(searchAttributeConfigBeta: SearchAttributeConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfig(searchAttributeConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationBetaApi.createSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfig(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationBetaApi.deleteSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationBetaApi.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSingleSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfig(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationBetaApi.getSingleSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the extended search attribute configuration to patch. - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSearchAttributeConfig(name: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfig(name, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationBetaApi.patchSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchAttributeConfigurationBetaApi - factory interface - * @export - */ -export const SearchAttributeConfigurationBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchAttributeConfigurationBetaApiFp(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSearchAttributeConfig(requestParameters.searchAttributeConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. - * @summary List extended search attributes - * @param {SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSingleSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationBetaApi. - * @export - * @interface SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest { - /** - * - * @type {SearchAttributeConfigBeta} - * @memberof SearchAttributeConfigurationBetaApiCreateSearchAttributeConfig - */ - readonly searchAttributeConfigBeta: SearchAttributeConfigBeta -} - -/** - * Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationBetaApi. - * @export - * @interface SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to delete. - * @type {string} - * @memberof SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfig - */ - readonly name: string -} - -/** - * Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationBetaApi. - * @export - * @interface SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest { - /** - * 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 SearchAttributeConfigurationBetaApiGetSearchAttributeConfig - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SearchAttributeConfigurationBetaApiGetSearchAttributeConfig - */ - readonly offset?: number -} - -/** - * Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationBetaApi. - * @export - * @interface SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to get. - * @type {string} - * @memberof SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfig - */ - readonly name: string -} - -/** - * Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationBetaApi. - * @export - * @interface SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to patch. - * @type {string} - * @memberof SearchAttributeConfigurationBetaApiPatchSearchAttributeConfig - */ - readonly name: string - - /** - * - * @type {Array} - * @memberof SearchAttributeConfigurationBetaApiPatchSearchAttributeConfig - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * SearchAttributeConfigurationBetaApi - object-oriented interface - * @export - * @class SearchAttributeConfigurationBetaApi - * @extends {BaseAPI} - */ -export class SearchAttributeConfigurationBetaApi extends BaseAPI { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationBetaApi - */ - public createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationBetaApiFp(this.configuration).createSearchAttributeConfig(requestParameters.searchAttributeConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationBetaApi - */ - public deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationBetaApiFp(this.configuration).deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. - * @summary List extended search attributes - * @param {SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationBetaApi - */ - public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationBetaApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationBetaApi - */ - public getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationBetaApiFp(this.configuration).getSingleSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationBetaApi - */ - public patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationBetaApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationBetaApiFp(this.configuration).patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SegmentsBetaApi - axios parameter creator - * @export - */ -export const SegmentsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Create segment - * @param {SegmentBeta} segmentBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment: async (segmentBeta: SegmentBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'segmentBeta' is not null or undefined - assertParamExists('createSegment', 'segmentBeta', segmentBeta) - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(segmentBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSegment', 'requestBody', requestBody) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SegmentsBetaApi - functional programming interface - * @export - */ -export const SegmentsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SegmentsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Create segment - * @param {SegmentBeta} segmentBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSegment(segmentBeta: SegmentBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSegment(segmentBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsBetaApi.createSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsBetaApi.deleteSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsBetaApi.getSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSegments(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsBetaApi.listSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSegment(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegment(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsBetaApi.patchSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SegmentsBetaApi - factory interface - * @export - */ -export const SegmentsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SegmentsBetaApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Create segment - * @param {SegmentsBetaApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment(requestParameters: SegmentsBetaApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSegment(requestParameters.segmentBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Delete segment by id - * @param {SegmentsBetaApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment(requestParameters: SegmentsBetaApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get segment by id - * @param {SegmentsBetaApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment(requestParameters: SegmentsBetaApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List segments - * @param {SegmentsBetaApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments(requestParameters: SegmentsBetaApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update segment - * @param {SegmentsBetaApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment(requestParameters: SegmentsBetaApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSegment operation in SegmentsBetaApi. - * @export - * @interface SegmentsBetaApiCreateSegmentRequest - */ -export interface SegmentsBetaApiCreateSegmentRequest { - /** - * - * @type {SegmentBeta} - * @memberof SegmentsBetaApiCreateSegment - */ - readonly segmentBeta: SegmentBeta -} - -/** - * Request parameters for deleteSegment operation in SegmentsBetaApi. - * @export - * @interface SegmentsBetaApiDeleteSegmentRequest - */ -export interface SegmentsBetaApiDeleteSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof SegmentsBetaApiDeleteSegment - */ - readonly id: string -} - -/** - * Request parameters for getSegment operation in SegmentsBetaApi. - * @export - * @interface SegmentsBetaApiGetSegmentRequest - */ -export interface SegmentsBetaApiGetSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof SegmentsBetaApiGetSegment - */ - readonly id: string -} - -/** - * Request parameters for listSegments operation in SegmentsBetaApi. - * @export - * @interface SegmentsBetaApiListSegmentsRequest - */ -export interface SegmentsBetaApiListSegmentsRequest { - /** - * 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 SegmentsBetaApiListSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SegmentsBetaApiListSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SegmentsBetaApiListSegments - */ - readonly count?: boolean -} - -/** - * Request parameters for patchSegment operation in SegmentsBetaApi. - * @export - * @interface SegmentsBetaApiPatchSegmentRequest - */ -export interface SegmentsBetaApiPatchSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof SegmentsBetaApiPatchSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @type {Array} - * @memberof SegmentsBetaApiPatchSegment - */ - readonly requestBody: Array -} - -/** - * SegmentsBetaApi - object-oriented interface - * @export - * @class SegmentsBetaApi - * @extends {BaseAPI} - */ -export class SegmentsBetaApi extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Create segment - * @param {SegmentsBetaApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsBetaApi - */ - public createSegment(requestParameters: SegmentsBetaApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsBetaApiFp(this.configuration).createSegment(requestParameters.segmentBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Delete segment by id - * @param {SegmentsBetaApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsBetaApi - */ - public deleteSegment(requestParameters: SegmentsBetaApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsBetaApiFp(this.configuration).deleteSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Get segment by id - * @param {SegmentsBetaApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsBetaApi - */ - public getSegment(requestParameters: SegmentsBetaApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsBetaApiFp(this.configuration).getSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List segments - * @param {SegmentsBetaApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsBetaApi - */ - public listSegments(requestParameters: SegmentsBetaApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsBetaApiFp(this.configuration).listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. - * @summary Update segment - * @param {SegmentsBetaApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsBetaApi - */ - public patchSegment(requestParameters: SegmentsBetaApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsBetaApiFp(this.configuration).patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ServiceDeskIntegrationBetaApi - axios parameter creator - * @export - */ -export const ServiceDeskIntegrationBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoBeta} serviceDeskIntegrationDtoBeta The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration: async (serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'serviceDeskIntegrationDtoBeta' is not null or undefined - assertParamExists('createServiceDeskIntegration', 'serviceDeskIntegrationDtoBeta', serviceDeskIntegrationDtoBeta) - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationList: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getServiceDeskIntegrationTemplate', 'scriptName', scriptName) - const localVarPath = `/service-desk-integrations/templates/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationBeta A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoBeta} serviceDeskIntegrationDtoBeta The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration: async (id: string, serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'id', id) - // verify required parameter 'serviceDeskIntegrationDtoBeta' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'serviceDeskIntegrationDtoBeta', serviceDeskIntegrationDtoBeta) - const localVarPath = `/service-desk-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsBeta} queuedCheckConfigDetailsBeta The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails: async (queuedCheckConfigDetailsBeta: QueuedCheckConfigDetailsBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'queuedCheckConfigDetailsBeta' is not null or undefined - assertParamExists('updateStatusCheckDetails', 'queuedCheckConfigDetailsBeta', queuedCheckConfigDetailsBeta) - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetailsBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ServiceDeskIntegrationBetaApi - functional programming interface - * @export - */ -export const ServiceDeskIntegrationBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ServiceDeskIntegrationBetaApiAxiosParamCreator(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoBeta} serviceDeskIntegrationDtoBeta The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createServiceDeskIntegration(serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegration(serviceDeskIntegrationDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.createServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.deleteServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.getServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationList(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationList(offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.getServiceDeskIntegrationList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.getServiceDeskIntegrationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.getServiceDeskIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetails(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.getStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationBeta A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchServiceDeskIntegration(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoBeta} serviceDeskIntegrationDtoBeta The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putServiceDeskIntegration(id: string, serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegration(id, serviceDeskIntegrationDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.putServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsBeta} queuedCheckConfigDetailsBeta The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStatusCheckDetails(queuedCheckConfigDetailsBeta: QueuedCheckConfigDetailsBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetails(queuedCheckConfigDetailsBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationBetaApi.updateStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ServiceDeskIntegrationBetaApi - factory interface - * @export - */ -export const ServiceDeskIntegrationBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ServiceDeskIntegrationBetaApiFp(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationList(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusCheckDetails(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createServiceDeskIntegration operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest { - /** - * The specifics of a new integration to create - * @type {ServiceDeskIntegrationDtoBeta} - * @memberof ServiceDeskIntegrationBetaApiCreateServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta -} - -/** - * Request parameters for deleteServiceDeskIntegration operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest { - /** - * ID of Service Desk integration to delete - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegration operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to get - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiGetServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegrationList operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest - */ -export interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest { - /** - * 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 ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationList - */ - 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 ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationList - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationList - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationList - */ - readonly filters?: string - - /** - * 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 ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationList - */ - readonly count?: boolean -} - -/** - * Request parameters for getServiceDeskIntegrationTemplate operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest - */ -export interface ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest { - /** - * The scriptName value of the Service Desk integration template to get - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for patchServiceDeskIntegration operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiPatchServiceDeskIntegration - */ - readonly id: string - - /** - * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @type {Array} - * @memberof ServiceDeskIntegrationBetaApiPatchServiceDeskIntegration - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationBetaApiPutServiceDeskIntegration - */ - readonly id: string - - /** - * The specifics of the integration to update - * @type {ServiceDeskIntegrationDtoBeta} - * @memberof ServiceDeskIntegrationBetaApiPutServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoBeta: ServiceDeskIntegrationDtoBeta -} - -/** - * Request parameters for updateStatusCheckDetails operation in ServiceDeskIntegrationBetaApi. - * @export - * @interface ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest - */ -export interface ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest { - /** - * The modified time check configuration - * @type {QueuedCheckConfigDetailsBeta} - * @memberof ServiceDeskIntegrationBetaApiUpdateStatusCheckDetails - */ - readonly queuedCheckConfigDetailsBeta: QueuedCheckConfigDetailsBeta -} - -/** - * ServiceDeskIntegrationBetaApi - object-oriented interface - * @export - * @class ServiceDeskIntegrationBetaApi - * @extends {BaseAPI} - */ -export class ServiceDeskIntegrationBetaApi extends BaseAPI { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public getServiceDeskIntegrationList(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).getServiceDeskIntegrationList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationBetaApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).getStatusCheckDetails(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationBetaApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationBetaApi - */ - public updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationBetaApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationBetaApiFp(this.configuration).updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourceUsagesBetaApi - axios parameter creator - * @export - */ -export const SourceUsagesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getStatusBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/status` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getUsagesBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/summaries` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * SourceUsagesBetaApi - functional programming interface - * @export - */ -export const SourceUsagesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourceUsagesBetaApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusBySourceId(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceId(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesBetaApi.getStatusBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceId(sourceId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesBetaApi.getUsagesBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourceUsagesBetaApi - factory interface - * @export - */ -export const SourceUsagesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourceUsagesBetaApiFp(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesBetaApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId(requestParameters: SourceUsagesBetaApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesBetaApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId(requestParameters: SourceUsagesBetaApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getStatusBySourceId operation in SourceUsagesBetaApi. - * @export - * @interface SourceUsagesBetaApiGetStatusBySourceIdRequest - */ -export interface SourceUsagesBetaApiGetStatusBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesBetaApiGetStatusBySourceId - */ - readonly sourceId: string -} - -/** - * Request parameters for getUsagesBySourceId operation in SourceUsagesBetaApi. - * @export - * @interface SourceUsagesBetaApiGetUsagesBySourceIdRequest - */ -export interface SourceUsagesBetaApiGetUsagesBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesBetaApiGetUsagesBySourceId - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesBetaApiGetUsagesBySourceId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesBetaApiGetUsagesBySourceId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourceUsagesBetaApiGetUsagesBySourceId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof SourceUsagesBetaApiGetUsagesBySourceId - */ - readonly sorters?: string -} - -/** - * SourceUsagesBetaApi - object-oriented interface - * @export - * @class SourceUsagesBetaApi - * @extends {BaseAPI} - */ -export class SourceUsagesBetaApi extends BaseAPI { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesBetaApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesBetaApi - */ - public getStatusBySourceId(requestParameters: SourceUsagesBetaApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesBetaApiFp(this.configuration).getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesBetaApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesBetaApi - */ - public getUsagesBySourceId(requestParameters: SourceUsagesBetaApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesBetaApiFp(this.configuration).getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourcesBetaApi - axios parameter creator - * @export - */ -export const SourcesBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - _delete: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('_delete', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoBeta} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy: async (sourceId: string, provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoBeta' is not null or undefined - assertParamExists('createProvisioningPolicy', 'provisioningPolicyDtoBeta', provisioningPolicyDtoBeta) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Creates a source in identitynow. - * @param {SourceBeta} sourceBeta - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource: async (sourceBeta: SourceBeta, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceBeta' is not null or undefined - assertParamExists('createSource', 'sourceBeta', sourceBeta) - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (provisionAsCsv !== undefined) { - localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaBeta} schemaBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema: async (sourceId: string, schemaBeta: SchemaBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaBeta' is not null or undefined - assertParamExists('createSourceSchema', 'schemaBeta', schemaBeta) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in a source - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteAccountsAsync', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/remove-accounts` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. - * @summary Delete native change detection configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNativeChangeDetectionConfig', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy: async (sourceId: string, usageType: UsageTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('deleteSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getCorrelationConfig', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/correlation-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Native change detection configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNativeChangeDetectionConfig', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy: async (sourceId: string, usageType: UsageTypeBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('getProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Downloads source accounts schema template - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAccountsSchema: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceAccountsSchema', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas/accounts` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Attribute sync config - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceAttrSyncConfig', 'id', id) - const localVarPath = `/sources/{id}/attribute-sync-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. A token with ORG_ADMIN authority is required to call this API. - * @summary Gets source config with language translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleBeta} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig: async (id: string, locale?: GetSourceConfigLocaleBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceConfig', 'id', id) - const localVarPath = `/sources/{id}/connectors/source-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source entitlement request configuration - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceEntitlementRequestConfig', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/entitlement-request-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Downloads source entitlements schema template - * @param {string} sourceId The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementsSchema: async (sourceId: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceEntitlementsSchema', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas/entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('getSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesBeta} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas: async (sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesBeta, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchemas', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeTypes !== undefined) { - localVarQueryParameter['include-types'] = includeTypes; - } - - if (includeNames !== undefined) { - localVarQueryParameter['include-names'] = includeNames; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Account aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {ImportAccountsDisableOptimizationBeta} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts: async (sourceId: string, file?: File, disableOptimization?: ImportAccountsDisableOptimizationBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importAccounts', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-accounts` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - if (disableOptimization !== undefined) { - localVarFormParams.append('disableOptimization', disableOptimization as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importEntitlements', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. - * @summary Uploads source accounts schema template - * @param {string} sourceId The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceAccountsSchema: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importSourceAccountsSchema', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas/accounts` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. A token with ORG_ADMIN authority is required to call this API. - * @summary Upload connector file to source - * @param {string} sourceId The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceConnectorFile: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importSourceConnectorFile', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/upload-connector-file` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. - * @summary Uploads source entitlements schema template - * @param {string} sourceId The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceEntitlementsSchema: async (sourceId: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importSourceEntitlementsSchema', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas/entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} sourceId Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importUncorrelatedAccounts', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-uncorrelated-accounts` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listProvisioningPolicies', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (includeIDNSource !== undefined) { - localVarQueryParameter['includeIDNSource'] = includeIDNSource; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. A token with ORG_ADMIN authority is required to call this API. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestBeta} resourceObjectsRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - peekResourceObjects: async (sourceId: string, resourceObjectsRequestBeta: ResourceObjectsRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('peekResourceObjects', 'sourceId', sourceId) - // verify required parameter 'resourceObjectsRequestBeta' is not null or undefined - assertParamExists('peekResourceObjects', 'resourceObjectsRequestBeta', resourceObjectsRequestBeta) - const localVarPath = `/sources/{sourceId}/connector/peek-resource-objects` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(resourceObjectsRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. A token with ORG_ADMIN authority is required to call this API. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('pingCluster', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/ping-cluster` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} sourceId The source id - * @param {CorrelationConfigBeta} correlationConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig: async (sourceId: string, correlationConfigBeta: CorrelationConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putCorrelationConfig', 'sourceId', sourceId) - // verify required parameter 'correlationConfigBeta' is not null or undefined - assertParamExists('putCorrelationConfig', 'correlationConfigBeta', correlationConfigBeta) - const localVarPath = `/sources/{sourceId}/correlation-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(correlationConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. - * @summary Update native change detection configuration - * @param {string} sourceId The source id - * @param {NativeChangeDetectionConfigBeta} nativeChangeDetectionConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig: async (sourceId: string, nativeChangeDetectionConfigBeta: NativeChangeDetectionConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'sourceId', sourceId) - // verify required parameter 'nativeChangeDetectionConfigBeta' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'nativeChangeDetectionConfigBeta', nativeChangeDetectionConfigBeta) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nativeChangeDetectionConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoBeta} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy: async (sourceId: string, usageType: UsageTypeBeta, provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('putProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'provisioningPolicyDtoBeta' is not null or undefined - assertParamExists('putProvisioningPolicy', 'provisioningPolicyDtoBeta', provisioningPolicyDtoBeta) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceBeta} sourceBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource: async (id: string, sourceBeta: SourceBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSource', 'id', id) - // verify required parameter 'sourceBeta' is not null or undefined - assertParamExists('putSource', 'sourceBeta', sourceBeta) - const localVarPath = `/sources/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. A token with ORG_ADMIN authority is required to call this API. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigBeta} attrSyncSourceConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig: async (id: string, attrSyncSourceConfigBeta: AttrSyncSourceConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'id', id) - // verify required parameter 'attrSyncSourceConfigBeta' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'attrSyncSourceConfigBeta', attrSyncSourceConfigBeta) - const localVarPath = `/sources/{id}/attribute-sync-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attrSyncSourceConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. - * @summary Update source schema (full) - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {SchemaBeta} schemaBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema: async (sourceId: string, schemaId: string, schemaBeta: SchemaBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('putSourceSchema', 'schemaId', schemaId) - // verify required parameter 'schemaBeta' is not null or undefined - assertParamExists('putSourceSchema', 'schemaBeta', schemaBeta) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected source. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Synchronize single source attributes. - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('syncAttributesForSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/synchronize-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. A token with ORG_ADMIN authority is required to call this API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConfiguration', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/test-configuration` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnection', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/check-connection` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk: async (sourceId: string, provisioningPolicyDtoBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoBeta' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'provisioningPolicyDtoBeta', provisioningPolicyDtoBeta) - const localVarPath = `/sources/{sourceId}/provisioning-policies/bulk-update` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy: async (sourceId: string, usageType: UsageTypeBeta, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationBeta A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSource', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateSource', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source entitlement request configuration - * @param {string} sourceId The Source id - * @param {SourceEntitlementRequestConfigBeta} sourceEntitlementRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig: async (sourceId: string, sourceEntitlementRequestConfigBeta: SourceEntitlementRequestConfigBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'sourceId', sourceId) - // verify required parameter 'sourceEntitlementRequestConfigBeta' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'sourceEntitlementRequestConfigBeta', sourceEntitlementRequestConfigBeta) - const localVarPath = `/sources/{sourceId}/entitlement-request-config` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceEntitlementRequestConfigBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema: async (sourceId: string, schemaId: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('updateSourceSchema', 'schemaId', schemaId) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateSourceSchema', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SourcesBetaApi - functional programming interface - * @export - */ -export const SourcesBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourcesBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async _delete(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator._delete(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi._delete']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoBeta} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createProvisioningPolicy(sourceId: string, provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicy(sourceId, provisioningPolicyDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.createProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Creates a source in identitynow. - * @param {SourceBeta} sourceBeta - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSource(sourceBeta: SourceBeta, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSource(sourceBeta, provisionAsCsv, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.createSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaBeta} schemaBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchema(sourceId: string, schemaBeta: SchemaBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchema(sourceId, schemaBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.createSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in a source - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountsAsync(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountsAsync(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.deleteAccountsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. - * @summary Delete native change detection configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNativeChangeDetectionConfig(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNativeChangeDetectionConfig(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.deleteNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteProvisioningPolicy(sourceId: string, usageType: UsageTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.deleteProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.deleteSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCorrelationConfig(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCorrelationConfig(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Native change detection configuration - * @param {string} sourceId The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNativeChangeDetectionConfig(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNativeChangeDetectionConfig(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProvisioningPolicy(sourceId: string, usageType: UsageTypeBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Downloads source accounts schema template - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceAccountsSchema(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAccountsSchema(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Attribute sync config - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceAttrSyncConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAttrSyncConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. A token with ORG_ADMIN authority is required to call this API. - * @summary Gets source config with language translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleBeta} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConfig(id: string, locale?: GetSourceConfigLocaleBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConfig(id, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source entitlement request configuration - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceEntitlementRequestConfig(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementRequestConfig(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Downloads source entitlements schema template - * @param {string} sourceId The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceEntitlementsSchema(sourceId: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementsSchema(sourceId, schemaName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesBeta} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchemas(sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesBeta, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemas(sourceId, includeTypes, includeNames, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.getSourceSchemas']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Account aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {ImportAccountsDisableOptimizationBeta} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccounts(sourceId: string, file?: File, disableOptimization?: ImportAccountsDisableOptimizationBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccounts(sourceId, file, disableOptimization, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlements(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlements(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. - * @summary Uploads source accounts schema template - * @param {string} sourceId The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSourceAccountsSchema(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSourceAccountsSchema(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importSourceAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. A token with ORG_ADMIN authority is required to call this API. - * @summary Upload connector file to source - * @param {string} sourceId The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSourceConnectorFile(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSourceConnectorFile(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importSourceConnectorFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. - * @summary Uploads source entitlements schema template - * @param {string} sourceId The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSourceEntitlementsSchema(sourceId: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSourceEntitlementsSchema(sourceId, schemaName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importSourceEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} sourceId Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importUncorrelatedAccounts(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importUncorrelatedAccounts(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.importUncorrelatedAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listProvisioningPolicies(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPolicies(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.listProvisioningPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSources(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSources(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.listSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. A token with ORG_ADMIN authority is required to call this API. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestBeta} resourceObjectsRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async peekResourceObjects(sourceId: string, resourceObjectsRequestBeta: ResourceObjectsRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.peekResourceObjects(sourceId, resourceObjectsRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.peekResourceObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. A token with ORG_ADMIN authority is required to call this API. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingCluster(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingCluster(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.pingCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} sourceId The source id - * @param {CorrelationConfigBeta} correlationConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCorrelationConfig(sourceId: string, correlationConfigBeta: CorrelationConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCorrelationConfig(sourceId, correlationConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. - * @summary Update native change detection configuration - * @param {string} sourceId The source id - * @param {NativeChangeDetectionConfigBeta} nativeChangeDetectionConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putNativeChangeDetectionConfig(sourceId: string, nativeChangeDetectionConfigBeta: NativeChangeDetectionConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putNativeChangeDetectionConfig(sourceId, nativeChangeDetectionConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoBeta} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putProvisioningPolicy(sourceId: string, usageType: UsageTypeBeta, provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicy(sourceId, usageType, provisioningPolicyDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceBeta} sourceBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSource(id: string, sourceBeta: SourceBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSource(id, sourceBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. A token with ORG_ADMIN authority is required to call this API. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigBeta} attrSyncSourceConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceAttrSyncConfig(id: string, attrSyncSourceConfigBeta: AttrSyncSourceConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceAttrSyncConfig(id, attrSyncSourceConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. - * @summary Update source schema (full) - * @param {string} sourceId The Source ID. - * @param {string} schemaId The Schema ID. - * @param {SchemaBeta} schemaBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceSchema(sourceId: string, schemaId: string, schemaBeta: SchemaBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchema(sourceId, schemaId, schemaBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.putSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected source. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Synchronize single source attributes. - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncAttributesForSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncAttributesForSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.syncAttributesForSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. A token with ORG_ADMIN authority is required to call this API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConfiguration(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConfiguration(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.testSourceConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnection(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnection(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.testSourceConnection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDtoBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulk(sourceId, provisioningPolicyDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.updateProvisioningPoliciesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeBeta} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPolicy(sourceId: string, usageType: UsageTypeBeta, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicy(sourceId, usageType, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.updateProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationBeta A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSource(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSource(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.updateSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source entitlement request configuration - * @param {string} sourceId The Source id - * @param {SourceEntitlementRequestConfigBeta} sourceEntitlementRequestConfigBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceEntitlementRequestConfig(sourceId: string, sourceEntitlementRequestConfigBeta: SourceEntitlementRequestConfigBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceEntitlementRequestConfig(sourceId, sourceEntitlementRequestConfigBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.updateSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchema(sourceId, schemaId, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesBetaApi.updateSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourcesBetaApi - factory interface - * @export - */ -export const SourcesBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourcesBetaApiFp(configuration) - return { - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source by id - * @param {SourcesBetaApiDeleteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - _delete(requestParameters: SourcesBetaApiDeleteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp._delete(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesBetaApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy(requestParameters: SourcesBetaApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Creates a source in identitynow. - * @param {SourcesBetaApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource(requestParameters: SourcesBetaApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSource(requestParameters.sourceBeta, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesBetaApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema(requestParameters: SourcesBetaApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchema(requestParameters.sourceId, requestParameters.schemaBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in a source - * @param {SourcesBetaApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync(requestParameters: SourcesBetaApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountsAsync(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. - * @summary Delete native change detection configuration - * @param {SourcesBetaApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig(requestParameters: SourcesBetaApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNativeChangeDetectionConfig(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesBetaApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy(requestParameters: SourcesBetaApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schema by id - * @param {SourcesBetaApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema(requestParameters: SourcesBetaApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesBetaApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig(requestParameters: SourcesBetaApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCorrelationConfig(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Native change detection configuration - * @param {SourcesBetaApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig(requestParameters: SourcesBetaApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNativeChangeDetectionConfig(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesBetaApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy(requestParameters: SourcesBetaApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source by id - * @param {SourcesBetaApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource(requestParameters: SourcesBetaApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Downloads source accounts schema template - * @param {SourcesBetaApiGetSourceAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAccountsSchema(requestParameters: SourcesBetaApiGetSourceAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceAccountsSchema(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Attribute sync config - * @param {SourcesBetaApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig(requestParameters: SourcesBetaApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceAttrSyncConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. A token with ORG_ADMIN authority is required to call this API. - * @summary Gets source config with language translations - * @param {SourcesBetaApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig(requestParameters: SourcesBetaApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source entitlement request configuration - * @param {SourcesBetaApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig(requestParameters: SourcesBetaApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceEntitlementRequestConfig(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Downloads source entitlements schema template - * @param {SourcesBetaApiGetSourceEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementsSchema(requestParameters: SourcesBetaApiGetSourceEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceEntitlementsSchema(requestParameters.sourceId, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesBetaApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema(requestParameters: SourcesBetaApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesBetaApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas(requestParameters: SourcesBetaApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Account aggregation - * @param {SourcesBetaApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts(requestParameters: SourcesBetaApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccounts(requestParameters.sourceId, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesBetaApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements(requestParameters: SourcesBetaApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. - * @summary Uploads source accounts schema template - * @param {SourcesBetaApiImportSourceAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceAccountsSchema(requestParameters: SourcesBetaApiImportSourceAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSourceAccountsSchema(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. A token with ORG_ADMIN authority is required to call this API. - * @summary Upload connector file to source - * @param {SourcesBetaApiImportSourceConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceConnectorFile(requestParameters: SourcesBetaApiImportSourceConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSourceConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. - * @summary Uploads source entitlements schema template - * @param {SourcesBetaApiImportSourceEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSourceEntitlementsSchema(requestParameters: SourcesBetaApiImportSourceEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSourceEntitlementsSchema(requestParameters.sourceId, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesBetaApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts(requestParameters: SourcesBetaApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importUncorrelatedAccounts(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesBetaApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies(requestParameters: SourcesBetaApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary Lists all sources in identitynow. - * @param {SourcesBetaApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources(requestParameters: SourcesBetaApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. A token with ORG_ADMIN authority is required to call this API. - * @summary Peek source connector\'s resource objects - * @param {SourcesBetaApiPeekResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - peekResourceObjects(requestParameters: SourcesBetaApiPeekResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.peekResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. A token with ORG_ADMIN authority is required to call this API. - * @summary Ping cluster for source connector - * @param {SourcesBetaApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster(requestParameters: SourcesBetaApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesBetaApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig(requestParameters: SourcesBetaApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCorrelationConfig(requestParameters.sourceId, requestParameters.correlationConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. - * @summary Update native change detection configuration - * @param {SourcesBetaApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig(requestParameters: SourcesBetaApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putNativeChangeDetectionConfig(requestParameters.sourceId, requestParameters.nativeChangeDetectionConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesBetaApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy(requestParameters: SourcesBetaApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source (full) - * @param {SourcesBetaApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource(requestParameters: SourcesBetaApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSource(requestParameters.id, requestParameters.sourceBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. A token with ORG_ADMIN authority is required to call this API. - * @summary Update attribute sync config - * @param {SourcesBetaApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig(requestParameters: SourcesBetaApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. - * @summary Update source schema (full) - * @param {SourcesBetaApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema(requestParameters: SourcesBetaApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected source. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Synchronize single source attributes. - * @param {SourcesBetaApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource(requestParameters: SourcesBetaApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncAttributesForSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. A token with ORG_ADMIN authority is required to call this API. - * @summary Test configuration for source connector - * @param {SourcesBetaApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration(requestParameters: SourcesBetaApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API. - * @summary Check connection for source connector. - * @param {SourcesBetaApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection(requestParameters: SourcesBetaApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk(requestParameters: SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesBetaApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy(requestParameters: SourcesBetaApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - * @summary Update source (partial) - * @param {SourcesBetaApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource(requestParameters: SourcesBetaApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSource(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source entitlement request configuration - * @param {SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig(requestParameters: SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceEntitlementRequestConfig(requestParameters.sourceId, requestParameters.sourceEntitlementRequestConfigBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesBetaApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema(requestParameters: SourcesBetaApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for _delete operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiDeleteRequest - */ -export interface SourcesBetaApiDeleteRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiDelete - */ - readonly id: string -} - -/** - * Request parameters for createProvisioningPolicy operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiCreateProvisioningPolicyRequest - */ -export interface SourcesBetaApiCreateProvisioningPolicyRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiCreateProvisioningPolicy - */ - readonly sourceId: string - - /** - * - * @type {ProvisioningPolicyDtoBeta} - * @memberof SourcesBetaApiCreateProvisioningPolicy - */ - readonly provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta -} - -/** - * Request parameters for createSource operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiCreateSourceRequest - */ -export interface SourcesBetaApiCreateSourceRequest { - /** - * - * @type {SourceBeta} - * @memberof SourcesBetaApiCreateSource - */ - readonly sourceBeta: SourceBeta - - /** - * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @type {boolean} - * @memberof SourcesBetaApiCreateSource - */ - readonly provisionAsCsv?: boolean -} - -/** - * Request parameters for createSourceSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiCreateSourceSchemaRequest - */ -export interface SourcesBetaApiCreateSourceSchemaRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiCreateSourceSchema - */ - readonly sourceId: string - - /** - * - * @type {SchemaBeta} - * @memberof SourcesBetaApiCreateSourceSchema - */ - readonly schemaBeta: SchemaBeta -} - -/** - * Request parameters for deleteAccountsAsync operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiDeleteAccountsAsyncRequest - */ -export interface SourcesBetaApiDeleteAccountsAsyncRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiDeleteAccountsAsync - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNativeChangeDetectionConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiDeleteNativeChangeDetectionConfigRequest - */ -export interface SourcesBetaApiDeleteNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiDeleteNativeChangeDetectionConfig - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteProvisioningPolicy operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiDeleteProvisioningPolicyRequest - */ -export interface SourcesBetaApiDeleteProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiDeleteProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeBeta} - * @memberof SourcesBetaApiDeleteProvisioningPolicy - */ - readonly usageType: UsageTypeBeta -} - -/** - * Request parameters for deleteSourceSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiDeleteSourceSchemaRequest - */ -export interface SourcesBetaApiDeleteSourceSchemaRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiDeleteSourceSchema - */ - readonly sourceId: string - - /** - * The Schema ID. - * @type {string} - * @memberof SourcesBetaApiDeleteSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getCorrelationConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetCorrelationConfigRequest - */ -export interface SourcesBetaApiGetCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiGetCorrelationConfig - */ - readonly sourceId: string -} - -/** - * Request parameters for getNativeChangeDetectionConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetNativeChangeDetectionConfigRequest - */ -export interface SourcesBetaApiGetNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiGetNativeChangeDetectionConfig - */ - readonly sourceId: string -} - -/** - * Request parameters for getProvisioningPolicy operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetProvisioningPolicyRequest - */ -export interface SourcesBetaApiGetProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiGetProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeBeta} - * @memberof SourcesBetaApiGetProvisioningPolicy - */ - readonly usageType: UsageTypeBeta -} - -/** - * Request parameters for getSource operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceRequest - */ -export interface SourcesBetaApiGetSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiGetSource - */ - readonly id: string -} - -/** - * Request parameters for getSourceAccountsSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceAccountsSchemaRequest - */ -export interface SourcesBetaApiGetSourceAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiGetSourceAccountsSchema - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceAttrSyncConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceAttrSyncConfigRequest - */ -export interface SourcesBetaApiGetSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiGetSourceAttrSyncConfig - */ - readonly id: string -} - -/** - * Request parameters for getSourceConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceConfigRequest - */ -export interface SourcesBetaApiGetSourceConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiGetSourceConfig - */ - readonly id: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof SourcesBetaApiGetSourceConfig - */ - readonly locale?: GetSourceConfigLocaleBeta -} - -/** - * Request parameters for getSourceEntitlementRequestConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceEntitlementRequestConfigRequest - */ -export interface SourcesBetaApiGetSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiGetSourceEntitlementRequestConfig - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceEntitlementsSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceEntitlementsSchemaRequest - */ -export interface SourcesBetaApiGetSourceEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiGetSourceEntitlementsSchema - */ - readonly sourceId: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesBetaApiGetSourceEntitlementsSchema - */ - readonly schemaName?: string -} - -/** - * Request parameters for getSourceSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceSchemaRequest - */ -export interface SourcesBetaApiGetSourceSchemaRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiGetSourceSchema - */ - readonly sourceId: string - - /** - * The Schema ID. - * @type {string} - * @memberof SourcesBetaApiGetSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getSourceSchemas operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiGetSourceSchemasRequest - */ -export interface SourcesBetaApiGetSourceSchemasRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiGetSourceSchemas - */ - readonly sourceId: string - - /** - * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @type {'group' | 'user'} - * @memberof SourcesBetaApiGetSourceSchemas - */ - readonly includeTypes?: GetSourceSchemasIncludeTypesBeta - - /** - * A comma-separated list of schema names to filter result. - * @type {string} - * @memberof SourcesBetaApiGetSourceSchemas - */ - readonly includeNames?: string -} - -/** - * Request parameters for importAccounts operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportAccountsRequest - */ -export interface SourcesBetaApiImportAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesBetaApiImportAccounts - */ - readonly sourceId: string - - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof SourcesBetaApiImportAccounts - */ - readonly file?: File - - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof SourcesBetaApiImportAccounts - */ - readonly disableOptimization?: ImportAccountsDisableOptimizationBeta -} - -/** - * Request parameters for importEntitlements operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportEntitlementsRequest - */ -export interface SourcesBetaApiImportEntitlementsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesBetaApiImportEntitlements - */ - readonly sourceId: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof SourcesBetaApiImportEntitlements - */ - readonly file?: File -} - -/** - * Request parameters for importSourceAccountsSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportSourceAccountsSchemaRequest - */ -export interface SourcesBetaApiImportSourceAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiImportSourceAccountsSchema - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesBetaApiImportSourceAccountsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importSourceConnectorFile operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportSourceConnectorFileRequest - */ -export interface SourcesBetaApiImportSourceConnectorFileRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiImportSourceConnectorFile - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesBetaApiImportSourceConnectorFile - */ - readonly file?: File -} - -/** - * Request parameters for importSourceEntitlementsSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportSourceEntitlementsSchemaRequest - */ -export interface SourcesBetaApiImportSourceEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiImportSourceEntitlementsSchema - */ - readonly sourceId: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesBetaApiImportSourceEntitlementsSchema - */ - readonly schemaName?: string - - /** - * - * @type {File} - * @memberof SourcesBetaApiImportSourceEntitlementsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importUncorrelatedAccounts operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiImportUncorrelatedAccountsRequest - */ -export interface SourcesBetaApiImportUncorrelatedAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesBetaApiImportUncorrelatedAccounts - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesBetaApiImportUncorrelatedAccounts - */ - readonly file?: File -} - -/** - * Request parameters for listProvisioningPolicies operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiListProvisioningPoliciesRequest - */ -export interface SourcesBetaApiListProvisioningPoliciesRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiListProvisioningPolicies - */ - readonly sourceId: string -} - -/** - * Request parameters for listSources operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiListSourcesRequest - */ -export interface SourcesBetaApiListSourcesRequest { - /** - * 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 SourcesBetaApiListSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourcesBetaApiListSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourcesBetaApiListSources - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof SourcesBetaApiListSources - */ - 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @type {string} - * @memberof SourcesBetaApiListSources - */ - readonly sorters?: string - - /** - * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @type {string} - * @memberof SourcesBetaApiListSources - */ - readonly forSubadmin?: string - - /** - * Include the IdentityNow source in the response. - * @type {boolean} - * @memberof SourcesBetaApiListSources - */ - readonly includeIDNSource?: boolean -} - -/** - * Request parameters for peekResourceObjects operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPeekResourceObjectsRequest - */ -export interface SourcesBetaApiPeekResourceObjectsRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesBetaApiPeekResourceObjects - */ - readonly sourceId: string - - /** - * - * @type {ResourceObjectsRequestBeta} - * @memberof SourcesBetaApiPeekResourceObjects - */ - readonly resourceObjectsRequestBeta: ResourceObjectsRequestBeta -} - -/** - * Request parameters for pingCluster operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPingClusterRequest - */ -export interface SourcesBetaApiPingClusterRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesBetaApiPingCluster - */ - readonly sourceId: string -} - -/** - * Request parameters for putCorrelationConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutCorrelationConfigRequest - */ -export interface SourcesBetaApiPutCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiPutCorrelationConfig - */ - readonly sourceId: string - - /** - * - * @type {CorrelationConfigBeta} - * @memberof SourcesBetaApiPutCorrelationConfig - */ - readonly correlationConfigBeta: CorrelationConfigBeta -} - -/** - * Request parameters for putNativeChangeDetectionConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutNativeChangeDetectionConfigRequest - */ -export interface SourcesBetaApiPutNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiPutNativeChangeDetectionConfig - */ - readonly sourceId: string - - /** - * - * @type {NativeChangeDetectionConfigBeta} - * @memberof SourcesBetaApiPutNativeChangeDetectionConfig - */ - readonly nativeChangeDetectionConfigBeta: NativeChangeDetectionConfigBeta -} - -/** - * Request parameters for putProvisioningPolicy operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutProvisioningPolicyRequest - */ -export interface SourcesBetaApiPutProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiPutProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeBeta} - * @memberof SourcesBetaApiPutProvisioningPolicy - */ - readonly usageType: UsageTypeBeta - - /** - * - * @type {ProvisioningPolicyDtoBeta} - * @memberof SourcesBetaApiPutProvisioningPolicy - */ - readonly provisioningPolicyDtoBeta: ProvisioningPolicyDtoBeta -} - -/** - * Request parameters for putSource operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutSourceRequest - */ -export interface SourcesBetaApiPutSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiPutSource - */ - readonly id: string - - /** - * - * @type {SourceBeta} - * @memberof SourcesBetaApiPutSource - */ - readonly sourceBeta: SourceBeta -} - -/** - * Request parameters for putSourceAttrSyncConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutSourceAttrSyncConfigRequest - */ -export interface SourcesBetaApiPutSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesBetaApiPutSourceAttrSyncConfig - */ - readonly id: string - - /** - * - * @type {AttrSyncSourceConfigBeta} - * @memberof SourcesBetaApiPutSourceAttrSyncConfig - */ - readonly attrSyncSourceConfigBeta: AttrSyncSourceConfigBeta -} - -/** - * Request parameters for putSourceSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiPutSourceSchemaRequest - */ -export interface SourcesBetaApiPutSourceSchemaRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesBetaApiPutSourceSchema - */ - readonly sourceId: string - - /** - * The Schema ID. - * @type {string} - * @memberof SourcesBetaApiPutSourceSchema - */ - readonly schemaId: string - - /** - * - * @type {SchemaBeta} - * @memberof SourcesBetaApiPutSourceSchema - */ - readonly schemaBeta: SchemaBeta -} - -/** - * Request parameters for syncAttributesForSource operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiSyncAttributesForSourceRequest - */ -export interface SourcesBetaApiSyncAttributesForSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiSyncAttributesForSource - */ - readonly sourceId: string -} - -/** - * Request parameters for testSourceConfiguration operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiTestSourceConfigurationRequest - */ -export interface SourcesBetaApiTestSourceConfigurationRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesBetaApiTestSourceConfiguration - */ - readonly sourceId: string -} - -/** - * Request parameters for testSourceConnection operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiTestSourceConnectionRequest - */ -export interface SourcesBetaApiTestSourceConnectionRequest { - /** - * The ID of the Source. - * @type {string} - * @memberof SourcesBetaApiTestSourceConnection - */ - readonly sourceId: string -} - -/** - * Request parameters for updateProvisioningPoliciesInBulk operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest - */ -export interface SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesBetaApiUpdateProvisioningPoliciesInBulk - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesBetaApiUpdateProvisioningPoliciesInBulk - */ - readonly provisioningPolicyDtoBeta: Array -} - -/** - * Request parameters for updateProvisioningPolicy operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiUpdateProvisioningPolicyRequest - */ -export interface SourcesBetaApiUpdateProvisioningPolicyRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesBetaApiUpdateProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeBeta} - * @memberof SourcesBetaApiUpdateProvisioningPolicy - */ - readonly usageType: UsageTypeBeta - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesBetaApiUpdateProvisioningPolicy - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for updateSource operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiUpdateSourceRequest - */ -export interface SourcesBetaApiUpdateSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesBetaApiUpdateSource - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @type {Array} - * @memberof SourcesBetaApiUpdateSource - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for updateSourceEntitlementRequestConfig operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest - */ -export interface SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesBetaApiUpdateSourceEntitlementRequestConfig - */ - readonly sourceId: string - - /** - * - * @type {SourceEntitlementRequestConfigBeta} - * @memberof SourcesBetaApiUpdateSourceEntitlementRequestConfig - */ - readonly sourceEntitlementRequestConfigBeta: SourceEntitlementRequestConfigBeta -} - -/** - * Request parameters for updateSourceSchema operation in SourcesBetaApi. - * @export - * @interface SourcesBetaApiUpdateSourceSchemaRequest - */ -export interface SourcesBetaApiUpdateSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesBetaApiUpdateSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesBetaApiUpdateSourceSchema - */ - readonly schemaId: string - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesBetaApiUpdateSourceSchema - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * SourcesBetaApi - object-oriented interface - * @export - * @class SourcesBetaApi - * @extends {BaseAPI} - */ -export class SourcesBetaApi extends BaseAPI { - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source by id - * @param {SourcesBetaApiDeleteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public _delete(requestParameters: SourcesBetaApiDeleteRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration)._delete(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesBetaApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public createProvisioningPolicy(requestParameters: SourcesBetaApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Creates a source in identitynow. - * @param {SourcesBetaApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public createSource(requestParameters: SourcesBetaApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).createSource(requestParameters.sourceBeta, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesBetaApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public createSourceSchema(requestParameters: SourcesBetaApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).createSourceSchema(requestParameters.sourceId, requestParameters.schemaBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in a source - * @param {SourcesBetaApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public deleteAccountsAsync(requestParameters: SourcesBetaApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).deleteAccountsAsync(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. - * @summary Delete native change detection configuration - * @param {SourcesBetaApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public deleteNativeChangeDetectionConfig(requestParameters: SourcesBetaApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).deleteNativeChangeDetectionConfig(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesBetaApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public deleteProvisioningPolicy(requestParameters: SourcesBetaApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schema by id - * @param {SourcesBetaApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public deleteSourceSchema(requestParameters: SourcesBetaApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesBetaApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getCorrelationConfig(requestParameters: SourcesBetaApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getCorrelationConfig(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. - * @summary Native change detection configuration - * @param {SourcesBetaApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getNativeChangeDetectionConfig(requestParameters: SourcesBetaApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getNativeChangeDetectionConfig(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesBetaApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getProvisioningPolicy(requestParameters: SourcesBetaApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source by id - * @param {SourcesBetaApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSource(requestParameters: SourcesBetaApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Downloads source accounts schema template - * @param {SourcesBetaApiGetSourceAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceAccountsSchema(requestParameters: SourcesBetaApiGetSourceAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceAccountsSchema(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. - * @summary Attribute sync config - * @param {SourcesBetaApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceAttrSyncConfig(requestParameters: SourcesBetaApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceAttrSyncConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. A token with ORG_ADMIN authority is required to call this API. - * @summary Gets source config with language translations - * @param {SourcesBetaApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceConfig(requestParameters: SourcesBetaApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get source entitlement request configuration - * @param {SourcesBetaApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceEntitlementRequestConfig(requestParameters: SourcesBetaApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceEntitlementRequestConfig(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Downloads source entitlements schema template - * @param {SourcesBetaApiGetSourceEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceEntitlementsSchema(requestParameters: SourcesBetaApiGetSourceEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceEntitlementsSchema(requestParameters.sourceId, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesBetaApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceSchema(requestParameters: SourcesBetaApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesBetaApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public getSourceSchemas(requestParameters: SourcesBetaApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Account aggregation - * @param {SourcesBetaApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importAccounts(requestParameters: SourcesBetaApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importAccounts(requestParameters.sourceId, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesBetaApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importEntitlements(requestParameters: SourcesBetaApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s account attributes. - * @summary Uploads source accounts schema template - * @param {SourcesBetaApiImportSourceAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importSourceAccountsSchema(requestParameters: SourcesBetaApiImportSourceAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importSourceAccountsSchema(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. A token with ORG_ADMIN authority is required to call this API. - * @summary Upload connector file to source - * @param {SourcesBetaApiImportSourceConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importSourceConnectorFile(requestParameters: SourcesBetaApiImportSourceConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importSourceConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. - * @summary Uploads source entitlements schema template - * @param {SourcesBetaApiImportSourceEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importSourceEntitlementsSchema(requestParameters: SourcesBetaApiImportSourceEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importSourceEntitlementsSchema(requestParameters.sourceId, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesBetaApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public importUncorrelatedAccounts(requestParameters: SourcesBetaApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).importUncorrelatedAccounts(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesBetaApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public listProvisioningPolicies(requestParameters: SourcesBetaApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary Lists all sources in identitynow. - * @param {SourcesBetaApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public listSources(requestParameters: SourcesBetaApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a sample of data returned from account and group aggregation requests. A token with ORG_ADMIN authority is required to call this API. - * @summary Peek source connector\'s resource objects - * @param {SourcesBetaApiPeekResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public peekResourceObjects(requestParameters: SourcesBetaApiPeekResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).peekResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. A token with ORG_ADMIN authority is required to call this API. - * @summary Ping cluster for source connector - * @param {SourcesBetaApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public pingCluster(requestParameters: SourcesBetaApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesBetaApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putCorrelationConfig(requestParameters: SourcesBetaApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putCorrelationConfig(requestParameters.sourceId, requestParameters.correlationConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. - * @summary Update native change detection configuration - * @param {SourcesBetaApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putNativeChangeDetectionConfig(requestParameters: SourcesBetaApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putNativeChangeDetectionConfig(requestParameters.sourceId, requestParameters.nativeChangeDetectionConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesBetaApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putProvisioningPolicy(requestParameters: SourcesBetaApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source (full) - * @param {SourcesBetaApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putSource(requestParameters: SourcesBetaApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putSource(requestParameters.id, requestParameters.sourceBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. A token with ORG_ADMIN authority is required to call this API. - * @summary Update attribute sync config - * @param {SourcesBetaApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putSourceAttrSyncConfig(requestParameters: SourcesBetaApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. - * @summary Update source schema (full) - * @param {SourcesBetaApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public putSourceSchema(requestParameters: SourcesBetaApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected source. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Synchronize single source attributes. - * @param {SourcesBetaApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public syncAttributesForSource(requestParameters: SourcesBetaApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).syncAttributesForSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. A token with ORG_ADMIN authority is required to call this API. - * @summary Test configuration for source connector - * @param {SourcesBetaApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public testSourceConfiguration(requestParameters: SourcesBetaApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API. - * @summary Check connection for source connector. - * @param {SourcesBetaApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public testSourceConnection(requestParameters: SourcesBetaApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public updateProvisioningPoliciesInBulk(requestParameters: SourcesBetaApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesBetaApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public updateProvisioningPolicy(requestParameters: SourcesBetaApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - * @summary Update source (partial) - * @param {SourcesBetaApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public updateSource(requestParameters: SourcesBetaApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).updateSource(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source entitlement request configuration - * @param {SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public updateSourceEntitlementRequestConfig(requestParameters: SourcesBetaApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).updateSourceEntitlementRequestConfig(requestParameters.sourceId, requestParameters.sourceEntitlementRequestConfigBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesBetaApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesBetaApi - */ - public updateSourceSchema(requestParameters: SourcesBetaApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesBetaApiFp(this.configuration).updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetSourceConfigLocaleBeta = { - De: 'de', - No: 'no', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetSourceConfigLocaleBeta = typeof GetSourceConfigLocaleBeta[keyof typeof GetSourceConfigLocaleBeta]; -/** - * @export - */ -export const GetSourceSchemasIncludeTypesBeta = { - Group: 'group', - User: 'user' -} as const; -export type GetSourceSchemasIncludeTypesBeta = typeof GetSourceSchemasIncludeTypesBeta[keyof typeof GetSourceSchemasIncludeTypesBeta]; -/** - * @export - */ -export const ImportAccountsDisableOptimizationBeta = { - True: 'true', - False: 'false' -} as const; -export type ImportAccountsDisableOptimizationBeta = typeof ImportAccountsDisableOptimizationBeta[keyof typeof ImportAccountsDisableOptimizationBeta]; - - -/** - * SuggestedEntitlementDescriptionBetaApi - axios parameter creator - * @export - */ -export const SuggestedEntitlementDescriptionBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId. - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats: async (batchId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'batchId' is not null or undefined - assertParamExists('getSedBatchStats', 'batchId', batchId) - const localVarPath = `/suggested-entitlement-description-batches/{batchId}/stats` - .replace(`{${"batchId"}}`, encodeURIComponent(String(batchId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches: async (offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds: async (limit?: number, filters?: string, sorters?: string, count?: boolean, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-descriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (requestedByAnyone !== undefined) { - localVarQueryParameter['requested-by-anyone'] = requestedByAnyone; - } - - if (showPendingStatusOnly !== undefined) { - localVarQueryParameter['show-pending-status-only'] = showPendingStatusOnly; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchBeta Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed: async (id: string, sedPatchBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSed', 'id', id) - // verify required parameter 'sedPatchBeta' is not null or undefined - assertParamExists('patchSed', 'sedPatchBeta', sedPatchBeta) - const localVarPath = `/suggested-entitlement-descriptions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedPatchBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalBeta Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval: async (sedApprovalBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedApprovalBeta' is not null or undefined - assertParamExists('submitSedApproval', 'sedApprovalBeta', sedApprovalBeta) - const localVarPath = `/suggested-entitlement-description-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedApprovalBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentBeta} sedAssignmentBeta Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment: async (sedAssignmentBeta: SedAssignmentBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedAssignmentBeta' is not null or undefined - assertParamExists('submitSedAssignment', 'sedAssignmentBeta', sedAssignmentBeta) - const localVarPath = `/suggested-entitlement-description-assignments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedAssignmentBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestBeta} [sedBatchRequestBeta] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest: async (sedBatchRequestBeta?: SedBatchRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedBatchRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SuggestedEntitlementDescriptionBetaApi - functional programming interface - * @export - */ -export const SuggestedEntitlementDescriptionBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SuggestedEntitlementDescriptionBetaApiAxiosParamCreator(configuration) - return { - /** - * Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId. - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatchStats(batchId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchStats(batchId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.getSedBatchStats']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatches(offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatches(offset, limit, count, countOnly, status, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.getSedBatches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSeds(limit?: number, filters?: string, sorters?: string, count?: boolean, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSeds(limit, filters, sorters, count, countOnly, requestedByAnyone, showPendingStatusOnly, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.listSeds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchBeta Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSed(id: string, sedPatchBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSed(id, sedPatchBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.patchSed']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalBeta Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedApproval(sedApprovalBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedApproval(sedApprovalBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.submitSedApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentBeta} sedAssignmentBeta Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedAssignment(sedAssignmentBeta: SedAssignmentBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedAssignment(sedAssignmentBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.submitSedAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestBeta} [sedBatchRequestBeta] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedBatchRequest(sedBatchRequestBeta?: SedBatchRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedBatchRequest(sedBatchRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionBetaApi.submitSedBatchRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SuggestedEntitlementDescriptionBetaApi - factory interface - * @export - */ -export const SuggestedEntitlementDescriptionBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SuggestedEntitlementDescriptionBetaApiFp(configuration) - return { - /** - * Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId. - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches(requestParameters: SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionBetaApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds(requestParameters: SuggestedEntitlementDescriptionBetaApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSeds(requestParameters.limit, requestParameters.filters, requestParameters.sorters, requestParameters.count, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionBetaApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed(requestParameters: SuggestedEntitlementDescriptionBetaApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSed(requestParameters.id, requestParameters.sedPatchBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.submitSedApproval(requestParameters.sedApprovalBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedAssignment(requestParameters.sedAssignmentBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedBatchRequest(requestParameters.sedBatchRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getSedBatchStats operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest { - /** - * Batch Id - * @type {string} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatchStats - */ - readonly batchId: string -} - -/** - * Request parameters for getSedBatches operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatches - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatches - */ - 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatches - */ - readonly count?: boolean - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatches - */ - readonly countOnly?: boolean - - /** - * Batch Status - * @type {string} - * @memberof SuggestedEntitlementDescriptionBetaApiGetSedBatches - */ - readonly status?: string -} - -/** - * Request parameters for listSeds operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiListSedsRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiListSedsRequest { - /** - * Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly limit?: number - - /** - * 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @type {string} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - 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: **displayName, sourceName, status** - * @type {string} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly sorters?: string - - /** - * 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly count?: boolean - - /** - * 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly countOnly?: boolean - - /** - * By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly requestedByAnyone?: boolean - - /** - * Will limit records to items that are in \"suggested\" or \"approved\" status - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionBetaApiListSeds - */ - readonly showPendingStatusOnly?: boolean -} - -/** - * Request parameters for patchSed operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiPatchSedRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiPatchSedRequest { - /** - * id is sed id - * @type {string} - * @memberof SuggestedEntitlementDescriptionBetaApiPatchSed - */ - readonly id: string - - /** - * Sed Patch Request - * @type {Array} - * @memberof SuggestedEntitlementDescriptionBetaApiPatchSed - */ - readonly sedPatchBeta: Array -} - -/** - * Request parameters for submitSedApproval operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest { - /** - * Sed Approval - * @type {Array} - * @memberof SuggestedEntitlementDescriptionBetaApiSubmitSedApproval - */ - readonly sedApprovalBeta: Array -} - -/** - * Request parameters for submitSedAssignment operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest { - /** - * Sed Assignment Request - * @type {SedAssignmentBeta} - * @memberof SuggestedEntitlementDescriptionBetaApiSubmitSedAssignment - */ - readonly sedAssignmentBeta: SedAssignmentBeta -} - -/** - * Request parameters for submitSedBatchRequest operation in SuggestedEntitlementDescriptionBetaApi. - * @export - * @interface SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest - */ -export interface SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest { - /** - * Sed Batch Request - * @type {SedBatchRequestBeta} - * @memberof SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequest - */ - readonly sedBatchRequestBeta?: SedBatchRequestBeta -} - -/** - * SuggestedEntitlementDescriptionBetaApi - object-oriented interface - * @export - * @class SuggestedEntitlementDescriptionBetaApi - * @extends {BaseAPI} - */ -export class SuggestedEntitlementDescriptionBetaApi extends BaseAPI { - /** - * Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId. - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionBetaApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public getSedBatches(requestParameters: SuggestedEntitlementDescriptionBetaApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionBetaApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public listSeds(requestParameters: SuggestedEntitlementDescriptionBetaApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).listSeds(requestParameters.limit, requestParameters.filters, requestParameters.sorters, requestParameters.count, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionBetaApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public patchSed(requestParameters: SuggestedEntitlementDescriptionBetaApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).patchSed(requestParameters.id, requestParameters.sedPatchBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public submitSedApproval(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).submitSedApproval(requestParameters.sedApprovalBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).submitSedAssignment(requestParameters.sedAssignmentBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionBetaApi - */ - public submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionBetaApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionBetaApiFp(this.configuration).submitSedBatchRequest(requestParameters.sedBatchRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaggedObjectsBetaApi - axios parameter creator - * @export - */ -export const TaggedObjectsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeBeta} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject: async (type: DeleteTaggedObjectTypeBeta, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('deleteTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Remove tags from multiple objects - * @param {BulkTaggedObjectBeta} bulkTaggedObjectBeta Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject: async (bulkTaggedObjectBeta: BulkTaggedObjectBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkTaggedObjectBeta' is not null or undefined - assertParamExists('deleteTagsToManyObject', 'bulkTaggedObjectBeta', bulkTaggedObjectBeta) - const localVarPath = `/tagged-objects/bulk-remove`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkTaggedObjectBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeBeta} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject: async (type: GetTaggedObjectTypeBeta, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('getTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeBeta} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType: async (type: ListTaggedObjectsByTypeTypeBeta, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('listTaggedObjectsByType', 'type', type) - const localVarPath = `/tagged-objects/{type}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeBeta} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectBeta} taggedObjectBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject: async (type: PutTaggedObjectTypeBeta, id: string, taggedObjectBeta: TaggedObjectBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('putTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('putTaggedObject', 'id', id) - // verify required parameter 'taggedObjectBeta' is not null or undefined - assertParamExists('putTaggedObject', 'taggedObjectBeta', taggedObjectBeta) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectBeta} taggedObjectBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject: async (taggedObjectBeta: TaggedObjectBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taggedObjectBeta' is not null or undefined - assertParamExists('setTagToObject', 'taggedObjectBeta', taggedObjectBeta) - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Tag multiple objects - * @param {BulkTaggedObjectBeta} bulkTaggedObjectBeta Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects: async (bulkTaggedObjectBeta: BulkTaggedObjectBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkTaggedObjectBeta' is not null or undefined - assertParamExists('setTagsToManyObjects', 'bulkTaggedObjectBeta', bulkTaggedObjectBeta) - const localVarPath = `/tagged-objects/bulk-add`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkTaggedObjectBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaggedObjectsBetaApi - functional programming interface - * @export - */ -export const TaggedObjectsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaggedObjectsBetaApiAxiosParamCreator(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeBeta} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTaggedObject(type: DeleteTaggedObjectTypeBeta, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.deleteTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Remove tags from multiple objects - * @param {BulkTaggedObjectBeta} bulkTaggedObjectBeta Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagsToManyObject(bulkTaggedObjectBeta: BulkTaggedObjectBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObject(bulkTaggedObjectBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.deleteTagsToManyObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeBeta} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaggedObject(type: GetTaggedObjectTypeBeta, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.getTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjects(limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.listTaggedObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeBeta} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjectsByType(type: ListTaggedObjectsByTypeTypeBeta, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByType(type, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.listTaggedObjectsByType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeBeta} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectBeta} taggedObjectBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTaggedObject(type: PutTaggedObjectTypeBeta, id: string, taggedObjectBeta: TaggedObjectBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObject(type, id, taggedObjectBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.putTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectBeta} taggedObjectBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagToObject(taggedObjectBeta: TaggedObjectBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObject(taggedObjectBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.setTagToObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Tag multiple objects - * @param {BulkTaggedObjectBeta} bulkTaggedObjectBeta Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagsToManyObjects(bulkTaggedObjectBeta: BulkTaggedObjectBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjects(bulkTaggedObjectBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsBetaApi.setTagsToManyObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaggedObjectsBetaApi - factory interface - * @export - */ -export const TaggedObjectsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaggedObjectsBetaApiFp(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsBetaApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject(requestParameters: TaggedObjectsBetaApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsBetaApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject(requestParameters: TaggedObjectsBetaApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagsToManyObject(requestParameters.bulkTaggedObjectBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsBetaApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject(requestParameters: TaggedObjectsBetaApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsBetaApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects(requestParameters: TaggedObjectsBetaApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsBetaApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType(requestParameters: TaggedObjectsBetaApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsBetaApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject(requestParameters: TaggedObjectsBetaApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsBetaApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject(requestParameters: TaggedObjectsBetaApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagToObject(requestParameters.taggedObjectBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Tag multiple objects - * @param {TaggedObjectsBetaApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects(requestParameters: TaggedObjectsBetaApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagsToManyObjects(requestParameters.bulkTaggedObjectBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteTaggedObject operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiDeleteTaggedObjectRequest - */ -export interface TaggedObjectsBetaApiDeleteTaggedObjectRequest { - /** - * The type of object to delete tags from. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsBetaApiDeleteTaggedObject - */ - readonly type: DeleteTaggedObjectTypeBeta - - /** - * The ID of the object to delete tags from. - * @type {string} - * @memberof TaggedObjectsBetaApiDeleteTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for deleteTagsToManyObject operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiDeleteTagsToManyObjectRequest - */ -export interface TaggedObjectsBetaApiDeleteTagsToManyObjectRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkTaggedObjectBeta} - * @memberof TaggedObjectsBetaApiDeleteTagsToManyObject - */ - readonly bulkTaggedObjectBeta: BulkTaggedObjectBeta -} - -/** - * Request parameters for getTaggedObject operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiGetTaggedObjectRequest - */ -export interface TaggedObjectsBetaApiGetTaggedObjectRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsBetaApiGetTaggedObject - */ - readonly type: GetTaggedObjectTypeBeta - - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TaggedObjectsBetaApiGetTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for listTaggedObjects operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiListTaggedObjectsRequest - */ -export interface TaggedObjectsBetaApiListTaggedObjectsRequest { - /** - * 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 TaggedObjectsBetaApiListTaggedObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsBetaApiListTaggedObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsBetaApiListTaggedObjects - */ - 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @type {string} - * @memberof TaggedObjectsBetaApiListTaggedObjects - */ - readonly filters?: string -} - -/** - * Request parameters for listTaggedObjectsByType operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiListTaggedObjectsByTypeRequest - */ -export interface TaggedObjectsBetaApiListTaggedObjectsByTypeRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsBetaApiListTaggedObjectsByType - */ - readonly type: ListTaggedObjectsByTypeTypeBeta - - /** - * 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 TaggedObjectsBetaApiListTaggedObjectsByType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsBetaApiListTaggedObjectsByType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsBetaApiListTaggedObjectsByType - */ - 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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @type {string} - * @memberof TaggedObjectsBetaApiListTaggedObjectsByType - */ - readonly filters?: string -} - -/** - * Request parameters for putTaggedObject operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiPutTaggedObjectRequest - */ -export interface TaggedObjectsBetaApiPutTaggedObjectRequest { - /** - * The type of tagged object to update. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsBetaApiPutTaggedObject - */ - readonly type: PutTaggedObjectTypeBeta - - /** - * The ID of the object reference to update. - * @type {string} - * @memberof TaggedObjectsBetaApiPutTaggedObject - */ - readonly id: string - - /** - * - * @type {TaggedObjectBeta} - * @memberof TaggedObjectsBetaApiPutTaggedObject - */ - readonly taggedObjectBeta: TaggedObjectBeta -} - -/** - * Request parameters for setTagToObject operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiSetTagToObjectRequest - */ -export interface TaggedObjectsBetaApiSetTagToObjectRequest { - /** - * - * @type {TaggedObjectBeta} - * @memberof TaggedObjectsBetaApiSetTagToObject - */ - readonly taggedObjectBeta: TaggedObjectBeta -} - -/** - * Request parameters for setTagsToManyObjects operation in TaggedObjectsBetaApi. - * @export - * @interface TaggedObjectsBetaApiSetTagsToManyObjectsRequest - */ -export interface TaggedObjectsBetaApiSetTagsToManyObjectsRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkTaggedObjectBeta} - * @memberof TaggedObjectsBetaApiSetTagsToManyObjects - */ - readonly bulkTaggedObjectBeta: BulkTaggedObjectBeta -} - -/** - * TaggedObjectsBetaApi - object-oriented interface - * @export - * @class TaggedObjectsBetaApi - * @extends {BaseAPI} - */ -export class TaggedObjectsBetaApi extends BaseAPI { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsBetaApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public deleteTaggedObject(requestParameters: TaggedObjectsBetaApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsBetaApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public deleteTagsToManyObject(requestParameters: TaggedObjectsBetaApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).deleteTagsToManyObject(requestParameters.bulkTaggedObjectBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsBetaApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public getTaggedObject(requestParameters: TaggedObjectsBetaApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsBetaApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public listTaggedObjects(requestParameters: TaggedObjectsBetaApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsBetaApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public listTaggedObjectsByType(requestParameters: TaggedObjectsBetaApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsBetaApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public putTaggedObject(requestParameters: TaggedObjectsBetaApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsBetaApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public setTagToObject(requestParameters: TaggedObjectsBetaApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).setTagToObject(requestParameters.taggedObjectBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Tag multiple objects - * @param {TaggedObjectsBetaApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsBetaApi - */ - public setTagsToManyObjects(requestParameters: TaggedObjectsBetaApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsBetaApiFp(this.configuration).setTagsToManyObjects(requestParameters.bulkTaggedObjectBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteTaggedObjectTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type DeleteTaggedObjectTypeBeta = typeof DeleteTaggedObjectTypeBeta[keyof typeof DeleteTaggedObjectTypeBeta]; -/** - * @export - */ -export const GetTaggedObjectTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type GetTaggedObjectTypeBeta = typeof GetTaggedObjectTypeBeta[keyof typeof GetTaggedObjectTypeBeta]; -/** - * @export - */ -export const ListTaggedObjectsByTypeTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type ListTaggedObjectsByTypeTypeBeta = typeof ListTaggedObjectsByTypeTypeBeta[keyof typeof ListTaggedObjectsByTypeTypeBeta]; -/** - * @export - */ -export const PutTaggedObjectTypeBeta = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type PutTaggedObjectTypeBeta = typeof PutTaggedObjectTypeBeta[keyof typeof PutTaggedObjectTypeBeta]; - - -/** - * TagsBetaApi - axios parameter creator - * @export - */ -export const TagsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagBeta} tagBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag: async (tagBeta: TagBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tagBeta' is not null or undefined - assertParamExists('createTag', 'tagBeta', tagBeta) - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tagBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * TagsBetaApi - functional programming interface - * @export - */ -export const TagsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TagsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagBeta} tagBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTag(tagBeta: TagBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTag(tagBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsBetaApi.createTag']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsBetaApi.deleteTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsBetaApi.getTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTags(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsBetaApi.listTags']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TagsBetaApi - factory interface - * @export - */ -export const TagsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TagsBetaApiFp(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsBetaApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag(requestParameters: TagsBetaApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTag(requestParameters.tagBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsBetaApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById(requestParameters: TagsBetaApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsBetaApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById(requestParameters: TagsBetaApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsBetaApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags(requestParameters: TagsBetaApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTag operation in TagsBetaApi. - * @export - * @interface TagsBetaApiCreateTagRequest - */ -export interface TagsBetaApiCreateTagRequest { - /** - * - * @type {TagBeta} - * @memberof TagsBetaApiCreateTag - */ - readonly tagBeta: TagBeta -} - -/** - * Request parameters for deleteTagById operation in TagsBetaApi. - * @export - * @interface TagsBetaApiDeleteTagByIdRequest - */ -export interface TagsBetaApiDeleteTagByIdRequest { - /** - * The ID of the object reference to delete. - * @type {string} - * @memberof TagsBetaApiDeleteTagById - */ - readonly id: string -} - -/** - * Request parameters for getTagById operation in TagsBetaApi. - * @export - * @interface TagsBetaApiGetTagByIdRequest - */ -export interface TagsBetaApiGetTagByIdRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TagsBetaApiGetTagById - */ - readonly id: string -} - -/** - * Request parameters for listTags operation in TagsBetaApi. - * @export - * @interface TagsBetaApiListTagsRequest - */ -export interface TagsBetaApiListTagsRequest { - /** - * 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 TagsBetaApiListTags - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TagsBetaApiListTags - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TagsBetaApiListTags - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof TagsBetaApiListTags - */ - 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, name, created, modified** - * @type {string} - * @memberof TagsBetaApiListTags - */ - readonly sorters?: string -} - -/** - * TagsBetaApi - object-oriented interface - * @export - * @class TagsBetaApi - * @extends {BaseAPI} - */ -export class TagsBetaApi extends BaseAPI { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsBetaApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsBetaApi - */ - public createTag(requestParameters: TagsBetaApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsBetaApiFp(this.configuration).createTag(requestParameters.tagBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsBetaApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsBetaApi - */ - public deleteTagById(requestParameters: TagsBetaApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsBetaApiFp(this.configuration).deleteTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsBetaApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsBetaApi - */ - public getTagById(requestParameters: TagsBetaApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsBetaApiFp(this.configuration).getTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsBetaApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsBetaApi - */ - public listTags(requestParameters: TagsBetaApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TagsBetaApiFp(this.configuration).listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaskManagementBetaApi - axios parameter creator - * @export - */ -export const TaskManagementBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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: 'HEAD', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaskStatus', 'id', id) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTaskStatus', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('updateTaskStatus', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaskManagementBetaApi - functional programming interface - * @export - */ -export const TaskManagementBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaskManagementBetaApiAxiosParamCreator(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementBetaApi.getPendingTaskHeaders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTasks(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementBetaApi.getPendingTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementBetaApi.getTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementBetaApi.getTaskStatusList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationBeta The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTaskStatus(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementBetaApi.updateTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaskManagementBetaApi - factory interface - * @export - */ -export const TaskManagementBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaskManagementBetaApiFp(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementBetaApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders(requestParameters: TaskManagementBetaApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementBetaApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks(requestParameters: TaskManagementBetaApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementBetaApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus(requestParameters: TaskManagementBetaApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {TaskManagementBetaApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList(requestParameters: TaskManagementBetaApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementBetaApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus(requestParameters: TaskManagementBetaApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPendingTaskHeaders operation in TaskManagementBetaApi. - * @export - * @interface TaskManagementBetaApiGetPendingTaskHeadersRequest - */ -export interface TaskManagementBetaApiGetPendingTaskHeadersRequest { - /** - * 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 TaskManagementBetaApiGetPendingTaskHeaders - */ - 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 TaskManagementBetaApiGetPendingTaskHeaders - */ - 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 TaskManagementBetaApiGetPendingTaskHeaders - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingTasks operation in TaskManagementBetaApi. - * @export - * @interface TaskManagementBetaApiGetPendingTasksRequest - */ -export interface TaskManagementBetaApiGetPendingTasksRequest { - /** - * 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 TaskManagementBetaApiGetPendingTasks - */ - 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 TaskManagementBetaApiGetPendingTasks - */ - 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 TaskManagementBetaApiGetPendingTasks - */ - readonly count?: boolean -} - -/** - * Request parameters for getTaskStatus operation in TaskManagementBetaApi. - * @export - * @interface TaskManagementBetaApiGetTaskStatusRequest - */ -export interface TaskManagementBetaApiGetTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementBetaApiGetTaskStatus - */ - readonly id: string -} - -/** - * Request parameters for getTaskStatusList operation in TaskManagementBetaApi. - * @export - * @interface TaskManagementBetaApiGetTaskStatusListRequest - */ -export interface TaskManagementBetaApiGetTaskStatusListRequest { - /** - * 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 TaskManagementBetaApiGetTaskStatusList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaskManagementBetaApiGetTaskStatusList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaskManagementBetaApiGetTaskStatusList - */ - 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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof TaskManagementBetaApiGetTaskStatusList - */ - 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: **created** - * @type {string} - * @memberof TaskManagementBetaApiGetTaskStatusList - */ - readonly sorters?: string -} - -/** - * Request parameters for updateTaskStatus operation in TaskManagementBetaApi. - * @export - * @interface TaskManagementBetaApiUpdateTaskStatusRequest - */ -export interface TaskManagementBetaApiUpdateTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementBetaApiUpdateTaskStatus - */ - readonly id: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof TaskManagementBetaApiUpdateTaskStatus - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * TaskManagementBetaApi - object-oriented interface - * @export - * @class TaskManagementBetaApi - * @extends {BaseAPI} - */ -export class TaskManagementBetaApi extends BaseAPI { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementBetaApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementBetaApi - */ - public getPendingTaskHeaders(requestParameters: TaskManagementBetaApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementBetaApiFp(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementBetaApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementBetaApi - */ - public getPendingTasks(requestParameters: TaskManagementBetaApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementBetaApiFp(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementBetaApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementBetaApi - */ - public getTaskStatus(requestParameters: TaskManagementBetaApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementBetaApiFp(this.configuration).getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {TaskManagementBetaApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementBetaApi - */ - public getTaskStatusList(requestParameters: TaskManagementBetaApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementBetaApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementBetaApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementBetaApi - */ - public updateTaskStatus(requestParameters: TaskManagementBetaApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementBetaApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantBetaApi - axios parameter creator - * @export - */ -export const TenantBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantBetaApi - functional programming interface - * @export - */ -export const TenantBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantBetaApiAxiosParamCreator(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenant(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenant(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantBetaApi.getTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantBetaApi - factory interface - * @export - */ -export const TenantBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantBetaApiFp(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenant(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * TenantBetaApi - object-oriented interface - * @export - * @class TenantBetaApi - * @extends {BaseAPI} - */ -export class TenantBetaApi extends BaseAPI { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantBetaApi - */ - public getTenant(axiosOptions?: RawAxiosRequestConfig) { - return TenantBetaApiFp(this.configuration).getTenant(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TransformsBetaApi - axios parameter creator - * @export - */ -export const TransformsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. - * @summary Create transform - * @param {TransformBeta} transformBeta The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform: async (transformBeta: TransformBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'transformBeta' is not null or undefined - assertParamExists('createTransform', 'transformBeta', transformBeta) - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - 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, - }; - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformBeta} [transformBeta] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform: async (id: string, transformBeta?: TransformBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTransform', 'id', id) - const localVarPath = `/transforms/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TransformsBetaApi - functional programming interface - * @export - */ -export const TransformsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TransformsBetaApiAxiosParamCreator(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. - * @summary Create transform - * @param {TransformBeta} transformBeta The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTransform(transformBeta: TransformBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTransform(transformBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsBetaApi.createTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsBetaApi.deleteTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsBetaApi.getTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTransforms(offset, limit, count, name, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsBetaApi.listTransforms']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformBeta} [transformBeta] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTransform(id: string, transformBeta?: TransformBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransform(id, transformBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsBetaApi.updateTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TransformsBetaApi - factory interface - * @export - */ -export const TransformsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TransformsBetaApiFp(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. - * @summary Create transform - * @param {TransformsBetaApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform(requestParameters: TransformsBetaApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTransform(requestParameters.transformBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API. - * @summary Delete a transform - * @param {TransformsBetaApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform(requestParameters: TransformsBetaApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. - * @summary Transform by id - * @param {TransformsBetaApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform(requestParameters: TransformsBetaApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API. - * @summary List transforms - * @param {TransformsBetaApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms(requestParameters: TransformsBetaApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API. - * @summary Update a transform - * @param {TransformsBetaApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform(requestParameters: TransformsBetaApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTransform(requestParameters.id, requestParameters.transformBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTransform operation in TransformsBetaApi. - * @export - * @interface TransformsBetaApiCreateTransformRequest - */ -export interface TransformsBetaApiCreateTransformRequest { - /** - * The transform to be created. - * @type {TransformBeta} - * @memberof TransformsBetaApiCreateTransform - */ - readonly transformBeta: TransformBeta -} - -/** - * Request parameters for deleteTransform operation in TransformsBetaApi. - * @export - * @interface TransformsBetaApiDeleteTransformRequest - */ -export interface TransformsBetaApiDeleteTransformRequest { - /** - * ID of the transform to delete - * @type {string} - * @memberof TransformsBetaApiDeleteTransform - */ - readonly id: string -} - -/** - * Request parameters for getTransform operation in TransformsBetaApi. - * @export - * @interface TransformsBetaApiGetTransformRequest - */ -export interface TransformsBetaApiGetTransformRequest { - /** - * ID of the transform to retrieve - * @type {string} - * @memberof TransformsBetaApiGetTransform - */ - readonly id: string -} - -/** - * Request parameters for listTransforms operation in TransformsBetaApi. - * @export - * @interface TransformsBetaApiListTransformsRequest - */ -export interface TransformsBetaApiListTransformsRequest { - /** - * 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 TransformsBetaApiListTransforms - */ - 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 TransformsBetaApiListTransforms - */ - 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 TransformsBetaApiListTransforms - */ - readonly count?: boolean - - /** - * Name of the transform to retrieve from the list. - * @type {string} - * @memberof TransformsBetaApiListTransforms - */ - readonly name?: 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: **internal**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof TransformsBetaApiListTransforms - */ - readonly filters?: string -} - -/** - * Request parameters for updateTransform operation in TransformsBetaApi. - * @export - * @interface TransformsBetaApiUpdateTransformRequest - */ -export interface TransformsBetaApiUpdateTransformRequest { - /** - * ID of the transform to update - * @type {string} - * @memberof TransformsBetaApiUpdateTransform - */ - readonly id: string - - /** - * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @type {TransformBeta} - * @memberof TransformsBetaApiUpdateTransform - */ - readonly transformBeta?: TransformBeta -} - -/** - * TransformsBetaApi - object-oriented interface - * @export - * @class TransformsBetaApi - * @extends {BaseAPI} - */ -export class TransformsBetaApi extends BaseAPI { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. - * @summary Create transform - * @param {TransformsBetaApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsBetaApi - */ - public createTransform(requestParameters: TransformsBetaApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsBetaApiFp(this.configuration).createTransform(requestParameters.transformBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API. - * @summary Delete a transform - * @param {TransformsBetaApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsBetaApi - */ - public deleteTransform(requestParameters: TransformsBetaApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsBetaApiFp(this.configuration).deleteTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. - * @summary Transform by id - * @param {TransformsBetaApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsBetaApi - */ - public getTransform(requestParameters: TransformsBetaApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsBetaApiFp(this.configuration).getTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API. - * @summary List transforms - * @param {TransformsBetaApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsBetaApi - */ - public listTransforms(requestParameters: TransformsBetaApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TransformsBetaApiFp(this.configuration).listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. A token with transform write authority is required to call this API. - * @summary Update a transform - * @param {TransformsBetaApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsBetaApi - */ - public updateTransform(requestParameters: TransformsBetaApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsBetaApiFp(this.configuration).updateTransform(requestParameters.id, requestParameters.transformBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TriggersBetaApi - axios parameter creator - * @export - */ -export const TriggersBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationBeta} completeInvocationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation: async (id: string, completeInvocationBeta: CompleteInvocationBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeTriggerInvocation', 'id', id) - // verify required parameter 'completeInvocationBeta' is not null or undefined - assertParamExists('completeTriggerInvocation', 'completeInvocationBeta', completeInvocationBeta) - const localVarPath = `/trigger-invocations/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(completeInvocationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestBeta} subscriptionPostRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription: async (subscriptionPostRequestBeta: SubscriptionPostRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subscriptionPostRequestBeta' is not null or undefined - assertParamExists('createSubscription', 'subscriptionPostRequestBeta', subscriptionPostRequestBeta) - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPostRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSubscription', 'id', id) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-invocations/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription: async (id: string, subscriptionPatchRequestInnerBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSubscription', 'id', id) - // verify required parameter 'subscriptionPatchRequestInnerBeta' is not null or undefined - assertParamExists('patchSubscription', 'subscriptionPatchRequestInnerBeta', subscriptionPatchRequestInnerBeta) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(subscriptionPatchRequestInnerBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationBeta} testInvocationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation: async (testInvocationBeta: TestInvocationBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'testInvocationBeta' is not null or undefined - assertParamExists('startTestTriggerInvocation', 'testInvocationBeta', testInvocationBeta) - const localVarPath = `/trigger-invocations/test`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testInvocationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoBeta} validateFilterInputDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter: async (validateFilterInputDtoBeta: ValidateFilterInputDtoBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'validateFilterInputDtoBeta' is not null or undefined - assertParamExists('testSubscriptionFilter', 'validateFilterInputDtoBeta', validateFilterInputDtoBeta) - const localVarPath = `/trigger-subscriptions/validate-filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(validateFilterInputDtoBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestBeta} subscriptionPutRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription: async (id: string, subscriptionPutRequestBeta: SubscriptionPutRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSubscription', 'id', id) - // verify required parameter 'subscriptionPutRequestBeta' is not null or undefined - assertParamExists('updateSubscription', 'subscriptionPutRequestBeta', subscriptionPutRequestBeta) - const localVarPath = `/trigger-subscriptions/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPutRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TriggersBetaApi - functional programming interface - * @export - */ -export const TriggersBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TriggersBetaApiAxiosParamCreator(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationBeta} completeInvocationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeTriggerInvocation(id: string, completeInvocationBeta: CompleteInvocationBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocation(id, completeInvocationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.completeTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestBeta} subscriptionPostRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSubscription(subscriptionPostRequestBeta: SubscriptionPostRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(subscriptionPostRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.createSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSubscription(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscription(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.deleteSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSubscriptions(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptions(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.listSubscriptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggerInvocationStatus(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatus(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.listTriggerInvocationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggers(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggers(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.listTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSubscription(id: string, subscriptionPatchRequestInnerBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscription(id, subscriptionPatchRequestInnerBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.patchSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationBeta} testInvocationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTestTriggerInvocation(testInvocationBeta: TestInvocationBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocation(testInvocationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.startTestTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoBeta} validateFilterInputDtoBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSubscriptionFilter(validateFilterInputDtoBeta: ValidateFilterInputDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilter(validateFilterInputDtoBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.testSubscriptionFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestBeta} subscriptionPutRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSubscription(id: string, subscriptionPutRequestBeta: SubscriptionPutRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscription(id, subscriptionPutRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersBetaApi.updateSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TriggersBetaApi - factory interface - * @export - */ -export const TriggersBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TriggersBetaApiFp(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersBetaApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation(requestParameters: TriggersBetaApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersBetaApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription(requestParameters: TriggersBetaApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSubscription(requestParameters.subscriptionPostRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersBetaApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription(requestParameters: TriggersBetaApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersBetaApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions(requestParameters: TriggersBetaApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersBetaApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus(requestParameters: TriggersBetaApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersBetaApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers(requestParameters: TriggersBetaApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersBetaApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription(requestParameters: TriggersBetaApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersBetaApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation(requestParameters: TriggersBetaApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.startTestTriggerInvocation(requestParameters.testInvocationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersBetaApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter(requestParameters: TriggersBetaApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSubscriptionFilter(requestParameters.validateFilterInputDtoBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersBetaApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription(requestParameters: TriggersBetaApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeTriggerInvocation operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiCompleteTriggerInvocationRequest - */ -export interface TriggersBetaApiCompleteTriggerInvocationRequest { - /** - * The ID of the invocation to complete. - * @type {string} - * @memberof TriggersBetaApiCompleteTriggerInvocation - */ - readonly id: string - - /** - * - * @type {CompleteInvocationBeta} - * @memberof TriggersBetaApiCompleteTriggerInvocation - */ - readonly completeInvocationBeta: CompleteInvocationBeta -} - -/** - * Request parameters for createSubscription operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiCreateSubscriptionRequest - */ -export interface TriggersBetaApiCreateSubscriptionRequest { - /** - * - * @type {SubscriptionPostRequestBeta} - * @memberof TriggersBetaApiCreateSubscription - */ - readonly subscriptionPostRequestBeta: SubscriptionPostRequestBeta -} - -/** - * Request parameters for deleteSubscription operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiDeleteSubscriptionRequest - */ -export interface TriggersBetaApiDeleteSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersBetaApiDeleteSubscription - */ - readonly id: string -} - -/** - * Request parameters for listSubscriptions operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiListSubscriptionsRequest - */ -export interface TriggersBetaApiListSubscriptionsRequest { - /** - * 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 TriggersBetaApiListSubscriptions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersBetaApiListSubscriptions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersBetaApiListSubscriptions - */ - 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* **triggerId**: *eq* **type**: *eq, le* - * @type {string} - * @memberof TriggersBetaApiListSubscriptions - */ - 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: **triggerId, triggerName** - * @type {string} - * @memberof TriggersBetaApiListSubscriptions - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggerInvocationStatus operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiListTriggerInvocationStatusRequest - */ -export interface TriggersBetaApiListTriggerInvocationStatusRequest { - /** - * 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 TriggersBetaApiListTriggerInvocationStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersBetaApiListTriggerInvocationStatus - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersBetaApiListTriggerInvocationStatus - */ - 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: **triggerId**: *eq* **subscriptionId**: *eq* - * @type {string} - * @memberof TriggersBetaApiListTriggerInvocationStatus - */ - 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: **triggerId, subscriptionName, created, completed** - * @type {string} - * @memberof TriggersBetaApiListTriggerInvocationStatus - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggers operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiListTriggersRequest - */ -export interface TriggersBetaApiListTriggersRequest { - /** - * 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 TriggersBetaApiListTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersBetaApiListTriggers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersBetaApiListTriggers - */ - 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, ge, le* - * @type {string} - * @memberof TriggersBetaApiListTriggers - */ - 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, name** - * @type {string} - * @memberof TriggersBetaApiListTriggers - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSubscription operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiPatchSubscriptionRequest - */ -export interface TriggersBetaApiPatchSubscriptionRequest { - /** - * ID of the Subscription to patch - * @type {string} - * @memberof TriggersBetaApiPatchSubscription - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof TriggersBetaApiPatchSubscription - */ - readonly subscriptionPatchRequestInnerBeta: Array -} - -/** - * Request parameters for startTestTriggerInvocation operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiStartTestTriggerInvocationRequest - */ -export interface TriggersBetaApiStartTestTriggerInvocationRequest { - /** - * - * @type {TestInvocationBeta} - * @memberof TriggersBetaApiStartTestTriggerInvocation - */ - readonly testInvocationBeta: TestInvocationBeta -} - -/** - * Request parameters for testSubscriptionFilter operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiTestSubscriptionFilterRequest - */ -export interface TriggersBetaApiTestSubscriptionFilterRequest { - /** - * - * @type {ValidateFilterInputDtoBeta} - * @memberof TriggersBetaApiTestSubscriptionFilter - */ - readonly validateFilterInputDtoBeta: ValidateFilterInputDtoBeta -} - -/** - * Request parameters for updateSubscription operation in TriggersBetaApi. - * @export - * @interface TriggersBetaApiUpdateSubscriptionRequest - */ -export interface TriggersBetaApiUpdateSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersBetaApiUpdateSubscription - */ - readonly id: string - - /** - * - * @type {SubscriptionPutRequestBeta} - * @memberof TriggersBetaApiUpdateSubscription - */ - readonly subscriptionPutRequestBeta: SubscriptionPutRequestBeta -} - -/** - * TriggersBetaApi - object-oriented interface - * @export - * @class TriggersBetaApi - * @extends {BaseAPI} - */ -export class TriggersBetaApi extends BaseAPI { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersBetaApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public completeTriggerInvocation(requestParameters: TriggersBetaApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersBetaApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public createSubscription(requestParameters: TriggersBetaApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).createSubscription(requestParameters.subscriptionPostRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersBetaApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public deleteSubscription(requestParameters: TriggersBetaApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersBetaApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public listSubscriptions(requestParameters: TriggersBetaApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersBetaApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public listTriggerInvocationStatus(requestParameters: TriggersBetaApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersBetaApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public listTriggers(requestParameters: TriggersBetaApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersBetaApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public patchSubscription(requestParameters: TriggersBetaApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersBetaApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public startTestTriggerInvocation(requestParameters: TriggersBetaApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).startTestTriggerInvocation(requestParameters.testInvocationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersBetaApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public testSubscriptionFilter(requestParameters: TriggersBetaApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).testSubscriptionFilter(requestParameters.validateFilterInputDtoBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersBetaApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersBetaApi - */ - public updateSubscription(requestParameters: TriggersBetaApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersBetaApiFp(this.configuration).updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * UIMetadataBetaApi - axios parameter creator - * @export - */ -export const UIMetadataBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. - * @summary Get a tenant ui metadata - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ui-metadata/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestBeta} tenantUiMetadataItemUpdateRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata: async (tenantUiMetadataItemUpdateRequestBeta: TenantUiMetadataItemUpdateRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantUiMetadataItemUpdateRequestBeta' is not null or undefined - assertParamExists('setTenantUiMetadata', 'tenantUiMetadataItemUpdateRequestBeta', tenantUiMetadataItemUpdateRequestBeta) - const localVarPath = `/ui-metadata/tenant`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantUiMetadataItemUpdateRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * UIMetadataBetaApi - functional programming interface - * @export - */ -export const UIMetadataBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UIMetadataBetaApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. - * @summary Get a tenant ui metadata - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantUiMetadata(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantUiMetadata(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataBetaApi.getTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestBeta} tenantUiMetadataItemUpdateRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTenantUiMetadata(tenantUiMetadataItemUpdateRequestBeta: TenantUiMetadataItemUpdateRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTenantUiMetadata(tenantUiMetadataItemUpdateRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataBetaApi.setTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * UIMetadataBetaApi - factory interface - * @export - */ -export const UIMetadataBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UIMetadataBetaApiFp(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. - * @summary Get a tenant ui metadata - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantUiMetadata(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. - * @summary Update tenant ui metadata - * @param {UIMetadataBetaApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata(requestParameters: UIMetadataBetaApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for setTenantUiMetadata operation in UIMetadataBetaApi. - * @export - * @interface UIMetadataBetaApiSetTenantUiMetadataRequest - */ -export interface UIMetadataBetaApiSetTenantUiMetadataRequest { - /** - * - * @type {TenantUiMetadataItemUpdateRequestBeta} - * @memberof UIMetadataBetaApiSetTenantUiMetadata - */ - readonly tenantUiMetadataItemUpdateRequestBeta: TenantUiMetadataItemUpdateRequestBeta -} - -/** - * UIMetadataBetaApi - object-oriented interface - * @export - * @class UIMetadataBetaApi - * @extends {BaseAPI} - */ -export class UIMetadataBetaApi extends BaseAPI { - /** - * This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. - * @summary Get a tenant ui metadata - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataBetaApi - */ - public getTenantUiMetadata(axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataBetaApiFp(this.configuration).getTenantUiMetadata(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. - * @summary Update tenant ui metadata - * @param {UIMetadataBetaApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataBetaApi - */ - public setTenantUiMetadata(requestParameters: UIMetadataBetaApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataBetaApiFp(this.configuration).setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkItemsBetaApi - axios parameter creator - * @export - */ -export const WorkItemsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('approveApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/approve/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeWorkItem', 'id', id) - const localVarPath = `/work-items/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCountCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCountWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkItem: async (id: string, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkItem', 'id', id) - const localVarPath = `/work-items/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkItemsSummary: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listWorkItems: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('rejectApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/reject/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitAccountSelection: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitAccountSelection', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('submitAccountSelection', 'requestBody', requestBody) - const localVarPath = `/work-items/{id}/submit-account-selection` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardBeta} workItemForwardBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitForwardWorkItem: async (id: string, workItemForwardBeta: WorkItemForwardBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitForwardWorkItem', 'id', id) - // verify required parameter 'workItemForwardBeta' is not null or undefined - assertParamExists('submitForwardWorkItem', 'workItemForwardBeta', workItemForwardBeta) - const localVarPath = `/work-items/{id}/forward` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workItemForwardBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkItemsBetaApi - functional programming interface - * @export - */ -export const WorkItemsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkItemsBetaApiAxiosParamCreator(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async approveApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.approveApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async approveApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.approveApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.completeWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItems(ownerId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.getCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCountCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItems(ownerId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.getCountCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getCountWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.getCountWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getWorkItem(id: string, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItem(id, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.getWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getWorkItemsSummary(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummary(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.getWorkItemsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listWorkItems(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItems(limit, offset, count, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.listWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async rejectApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.rejectApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async rejectApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.rejectApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async submitAccountSelection(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelection(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.submitAccountSelection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardBeta} workItemForwardBeta - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async submitForwardWorkItem(id: string, workItemForwardBeta: WorkItemForwardBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitForwardWorkItem(id, workItemForwardBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsBetaApi.submitForwardWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkItemsBetaApi - factory interface - * @export - */ -export const WorkItemsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkItemsBetaApiFp(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsBetaApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveApprovalItem(requestParameters: WorkItemsBetaApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsBetaApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - approveApprovalItemsInBulk(requestParameters: WorkItemsBetaApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsBetaApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - completeWorkItem(requestParameters: WorkItemsBetaApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsBetaApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCompletedWorkItems(requestParameters: WorkItemsBetaApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsBetaApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCountCompletedWorkItems(requestParameters: WorkItemsBetaApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCountCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsBetaApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getCountWorkItems(requestParameters: WorkItemsBetaApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsBetaApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkItem(requestParameters: WorkItemsBetaApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItem(requestParameters.id, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsBetaApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkItemsSummary(requestParameters: WorkItemsBetaApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsBetaApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listWorkItems(requestParameters: WorkItemsBetaApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsBetaApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectApprovalItem(requestParameters: WorkItemsBetaApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsBetaApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk(requestParameters: WorkItemsBetaApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsBetaApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitAccountSelection(requestParameters: WorkItemsBetaApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsBetaApiSubmitForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - submitForwardWorkItem(requestParameters: WorkItemsBetaApiSubmitForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitForwardWorkItem(requestParameters.id, requestParameters.workItemForwardBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApprovalItem operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiApproveApprovalItemRequest - */ -export interface WorkItemsBetaApiApproveApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiApproveApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsBetaApiApproveApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for approveApprovalItemsInBulk operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiApproveApprovalItemsInBulkRequest - */ -export interface WorkItemsBetaApiApproveApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiApproveApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for completeWorkItem operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiCompleteWorkItemRequest - */ -export interface WorkItemsBetaApiCompleteWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiCompleteWorkItem - */ - readonly id: string - - /** - * Body is the request payload to create form definition request - * @type {string} - * @memberof WorkItemsBetaApiCompleteWorkItem - */ - readonly body?: string | null -} - -/** - * Request parameters for getCompletedWorkItems operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiGetCompletedWorkItemsRequest - */ -export interface WorkItemsBetaApiGetCompletedWorkItemsRequest { - /** - * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @type {string} - * @memberof WorkItemsBetaApiGetCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsBetaApiGetCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsBetaApiGetCompletedWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsBetaApiGetCompletedWorkItems - */ - readonly count?: boolean -} - -/** - * Request parameters for getCountCompletedWorkItems operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiGetCountCompletedWorkItemsRequest - */ -export interface WorkItemsBetaApiGetCountCompletedWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsBetaApiGetCountCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsBetaApiGetCountCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsBetaApiGetCountCompletedWorkItems - */ - readonly offset?: number -} - -/** - * Request parameters for getCountWorkItems operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiGetCountWorkItemsRequest - */ -export interface WorkItemsBetaApiGetCountWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsBetaApiGetCountWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItem operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiGetWorkItemRequest - */ -export interface WorkItemsBetaApiGetWorkItemRequest { - /** - * ID of the work item. - * @type {string} - * @memberof WorkItemsBetaApiGetWorkItem - */ - readonly id: string - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsBetaApiGetWorkItem - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItemsSummary operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiGetWorkItemsSummaryRequest - */ -export interface WorkItemsBetaApiGetWorkItemsSummaryRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsBetaApiGetWorkItemsSummary - */ - readonly ownerId?: string -} - -/** - * Request parameters for listWorkItems operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiListWorkItemsRequest - */ -export interface WorkItemsBetaApiListWorkItemsRequest { - /** - * 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 WorkItemsBetaApiListWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsBetaApiListWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsBetaApiListWorkItems - */ - readonly count?: boolean - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsBetaApiListWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for rejectApprovalItem operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiRejectApprovalItemRequest - */ -export interface WorkItemsBetaApiRejectApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiRejectApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsBetaApiRejectApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for rejectApprovalItemsInBulk operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiRejectApprovalItemsInBulkRequest - */ -export interface WorkItemsBetaApiRejectApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiRejectApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for submitAccountSelection operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiSubmitAccountSelectionRequest - */ -export interface WorkItemsBetaApiSubmitAccountSelectionRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiSubmitAccountSelection - */ - readonly id: string - - /** - * Account Selection Data map, keyed on fieldName - * @type {{ [key: string]: any; }} - * @memberof WorkItemsBetaApiSubmitAccountSelection - */ - readonly requestBody: { [key: string]: any; } -} - -/** - * Request parameters for submitForwardWorkItem operation in WorkItemsBetaApi. - * @export - * @interface WorkItemsBetaApiSubmitForwardWorkItemRequest - */ -export interface WorkItemsBetaApiSubmitForwardWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsBetaApiSubmitForwardWorkItem - */ - readonly id: string - - /** - * - * @type {WorkItemForwardBeta} - * @memberof WorkItemsBetaApiSubmitForwardWorkItem - */ - readonly workItemForwardBeta: WorkItemForwardBeta -} - -/** - * WorkItemsBetaApi - object-oriented interface - * @export - * @class WorkItemsBetaApi - * @extends {BaseAPI} - */ -export class WorkItemsBetaApi extends BaseAPI { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsBetaApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public approveApprovalItem(requestParameters: WorkItemsBetaApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsBetaApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public approveApprovalItemsInBulk(requestParameters: WorkItemsBetaApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsBetaApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public completeWorkItem(requestParameters: WorkItemsBetaApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsBetaApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public getCompletedWorkItems(requestParameters: WorkItemsBetaApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsBetaApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public getCountCompletedWorkItems(requestParameters: WorkItemsBetaApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).getCountCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsBetaApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public getCountWorkItems(requestParameters: WorkItemsBetaApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsBetaApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public getWorkItem(requestParameters: WorkItemsBetaApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).getWorkItem(requestParameters.id, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsBetaApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public getWorkItemsSummary(requestParameters: WorkItemsBetaApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsBetaApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public listWorkItems(requestParameters: WorkItemsBetaApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsBetaApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public rejectApprovalItem(requestParameters: WorkItemsBetaApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsBetaApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public rejectApprovalItemsInBulk(requestParameters: WorkItemsBetaApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsBetaApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public submitAccountSelection(requestParameters: WorkItemsBetaApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsBetaApiSubmitForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkItemsBetaApi - */ - public submitForwardWorkItem(requestParameters: WorkItemsBetaApiSubmitForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsBetaApiFp(this.configuration).submitForwardWorkItem(requestParameters.id, requestParameters.workItemForwardBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkReassignmentBetaApi - axios parameter creator - * @export - */ -export const WorkReassignmentBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestBeta} configurationItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration: async (configurationItemRequestBeta: ConfigurationItemRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configurationItemRequestBeta' is not null or undefined - assertParamExists('createReassignmentConfiguration', 'configurationItemRequestBeta', configurationItemRequestBeta) - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumBeta} configType - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'configType', configType) - const localVarPath = `/reassignment-configurations/{identityId}/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumBeta} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumBeta, exclusionFilters?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'configType', configType) - const localVarPath = `/reassignment-configurations/{identityId}/evaluate/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (exclusionFilters) { - localVarQueryParameter['exclusionFilters'] = exclusionFilters.join(COLLECTION_FORMATS.csv); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/reassignment-configurations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getReassignmentConfiguration', 'identityId', identityId) - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestBeta} configurationItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig: async (identityId: string, configurationItemRequestBeta: ConfigurationItemRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('putReassignmentConfig', 'identityId', identityId) - // verify required parameter 'configurationItemRequestBeta' is not null or undefined - assertParamExists('putReassignmentConfig', 'configurationItemRequestBeta', configurationItemRequestBeta) - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestBeta} tenantConfigurationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration: async (tenantConfigurationRequestBeta: TenantConfigurationRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantConfigurationRequestBeta' is not null or undefined - assertParamExists('putTenantConfiguration', 'tenantConfigurationRequestBeta', tenantConfigurationRequestBeta) - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantConfigurationRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkReassignmentBetaApi - functional programming interface - * @export - */ -export const WorkReassignmentBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkReassignmentBetaApiAxiosParamCreator(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestBeta} configurationItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createReassignmentConfiguration(configurationItemRequestBeta: ConfigurationItemRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createReassignmentConfiguration(configurationItemRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.createReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumBeta} configType - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReassignmentConfiguration(identityId, configType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.deleteReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumBeta} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEvaluateReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumBeta, exclusionFilters?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluateReassignmentConfiguration(identityId, configType, exclusionFilters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.getEvaluateReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfigTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.getReassignmentConfigTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfiguration(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfiguration(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.getReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantConfigConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantConfigConfiguration(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.getTenantConfigConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listReassignmentConfigurations(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReassignmentConfigurations(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.listReassignmentConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestBeta} configurationItemRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putReassignmentConfig(identityId: string, configurationItemRequestBeta: ConfigurationItemRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putReassignmentConfig(identityId, configurationItemRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.putReassignmentConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestBeta} tenantConfigurationRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTenantConfiguration(tenantConfigurationRequestBeta: TenantConfigurationRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTenantConfiguration(tenantConfigurationRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentBetaApi.putTenantConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkReassignmentBetaApi - factory interface - * @export - */ -export const WorkReassignmentBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkReassignmentBetaApiFp(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentBetaApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createReassignmentConfiguration(requestParameters.configurationItemRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getReassignmentConfigTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentBetaApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReassignmentConfiguration(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantConfigConfiguration(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentBetaApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations(requestParameters: WorkReassignmentBetaApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listReassignmentConfigurations(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentBetaApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig(requestParameters: WorkReassignmentBetaApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentBetaApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration(requestParameters: WorkReassignmentBetaApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTenantConfiguration(requestParameters.tenantConfigurationRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createReassignmentConfiguration operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiCreateReassignmentConfigurationRequest - */ -export interface WorkReassignmentBetaApiCreateReassignmentConfigurationRequest { - /** - * - * @type {ConfigurationItemRequestBeta} - * @memberof WorkReassignmentBetaApiCreateReassignmentConfiguration - */ - readonly configurationItemRequestBeta: ConfigurationItemRequestBeta -} - -/** - * Request parameters for deleteReassignmentConfiguration operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest - */ -export interface WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentBetaApiDeleteReassignmentConfiguration - */ - readonly identityId: string - - /** - * - * @type {ConfigTypeEnumBeta} - * @memberof WorkReassignmentBetaApiDeleteReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumBeta -} - -/** - * Request parameters for getEvaluateReassignmentConfiguration operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest - */ -export interface WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentBetaApiGetEvaluateReassignmentConfiguration - */ - readonly identityId: string - - /** - * Reassignment work type - * @type {ConfigTypeEnumBeta} - * @memberof WorkReassignmentBetaApiGetEvaluateReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumBeta - - /** - * Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @type {Array} - * @memberof WorkReassignmentBetaApiGetEvaluateReassignmentConfiguration - */ - readonly exclusionFilters?: Array -} - -/** - * Request parameters for getReassignmentConfiguration operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiGetReassignmentConfigurationRequest - */ -export interface WorkReassignmentBetaApiGetReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentBetaApiGetReassignmentConfiguration - */ - readonly identityId: string -} - -/** - * Request parameters for listReassignmentConfigurations operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiListReassignmentConfigurationsRequest - */ -export interface WorkReassignmentBetaApiListReassignmentConfigurationsRequest { - /** - * Max number of results to return. - * @type {number} - * @memberof WorkReassignmentBetaApiListReassignmentConfigurations - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof WorkReassignmentBetaApiListReassignmentConfigurations - */ - readonly offset?: number -} - -/** - * Request parameters for putReassignmentConfig operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiPutReassignmentConfigRequest - */ -export interface WorkReassignmentBetaApiPutReassignmentConfigRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentBetaApiPutReassignmentConfig - */ - readonly identityId: string - - /** - * - * @type {ConfigurationItemRequestBeta} - * @memberof WorkReassignmentBetaApiPutReassignmentConfig - */ - readonly configurationItemRequestBeta: ConfigurationItemRequestBeta -} - -/** - * Request parameters for putTenantConfiguration operation in WorkReassignmentBetaApi. - * @export - * @interface WorkReassignmentBetaApiPutTenantConfigurationRequest - */ -export interface WorkReassignmentBetaApiPutTenantConfigurationRequest { - /** - * - * @type {TenantConfigurationRequestBeta} - * @memberof WorkReassignmentBetaApiPutTenantConfiguration - */ - readonly tenantConfigurationRequestBeta: TenantConfigurationRequestBeta -} - -/** - * WorkReassignmentBetaApi - object-oriented interface - * @export - * @class WorkReassignmentBetaApi - * @extends {BaseAPI} - */ -export class WorkReassignmentBetaApi extends BaseAPI { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentBetaApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public createReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).createReassignmentConfiguration(requestParameters.configurationItemRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public deleteReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public getReassignmentConfigTypes(axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).getReassignmentConfigTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentBetaApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public getReassignmentConfiguration(requestParameters: WorkReassignmentBetaApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).getReassignmentConfiguration(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public getTenantConfigConfiguration(axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).getTenantConfigConfiguration(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentBetaApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public listReassignmentConfigurations(requestParameters: WorkReassignmentBetaApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).listReassignmentConfigurations(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentBetaApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public putReassignmentConfig(requestParameters: WorkReassignmentBetaApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentBetaApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentBetaApi - */ - public putTenantConfiguration(requestParameters: WorkReassignmentBetaApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentBetaApiFp(this.configuration).putTenantConfiguration(requestParameters.tenantConfigurationRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkflowsBetaApi - axios parameter creator - * @export - */ -export const WorkflowsBetaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestBeta} createWorkflowRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow: async (createWorkflowRequestBeta: CreateWorkflowRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createWorkflowRequestBeta' is not null or undefined - assertParamExists('createWorkflow', 'createWorkflowRequestBeta', createWorkflowRequestBeta) - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createWorkflowRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {boolean} [workflowMetrics] disable workflow metrics - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow: async (id: string, workflowMetrics?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (workflowMetrics !== undefined) { - localVarQueryParameter['workflowMetrics'] = workflowMetrics; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkflowExecutionHistory: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistory', 'id', id) - const localVarPath = `/workflow-executions/{id}/history` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutions', 'id', id) - const localVarPath = `/workflows/{id}/executions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/operators`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @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: **modified, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow: async (id: string, jsonPatchOperationBeta: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkflow', 'id', id) - // verify required parameter 'jsonPatchOperationBeta' is not null or undefined - assertParamExists('patchWorkflow', 'jsonPatchOperationBeta', jsonPatchOperationBeta) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {PostExternalExecuteWorkflowRequestBeta} [postExternalExecuteWorkflowRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - postExternalExecuteWorkflow: async (id: string, postExternalExecuteWorkflowRequestBeta?: PostExternalExecuteWorkflowRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('postExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(postExternalExecuteWorkflowRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - postWorkflowExternalTrigger: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('postWorkflowExternalTrigger', 'id', id) - const localVarPath = `/workflows/{id}/external/oauth-clients` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyBeta} workflowBodyBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow: async (id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putWorkflow', 'id', id) - // verify required parameter 'workflowBodyBeta' is not null or undefined - assertParamExists('putWorkflow', 'workflowBodyBeta', workflowBodyBeta) - const localVarPath = `/workflows/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workflowBodyBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestBeta} [testExternalExecuteWorkflowRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - testExternalExecuteWorkflow: async (id: string, testExternalExecuteWorkflowRequestBeta?: TestExternalExecuteWorkflowRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testExternalExecuteWorkflowRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestBeta} testWorkflowRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow: async (id: string, testWorkflowRequestBeta: TestWorkflowRequestBeta, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testWorkflow', 'id', id) - // verify required parameter 'testWorkflowRequestBeta' is not null or undefined - assertParamExists('testWorkflow', 'testWorkflowRequestBeta', testWorkflowRequestBeta) - const localVarPath = `/workflows/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testWorkflowRequestBeta, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkflowsBetaApi - functional programming interface - * @export - */ -export const WorkflowsBetaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkflowsBetaApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.cancelWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestBeta} createWorkflowRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflow(createWorkflowRequestBeta: CreateWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflow(createWorkflowRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.createWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.deleteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {boolean} [workflowMetrics] disable workflow metrics - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflow(id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflow(id, workflowMetrics, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.getWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.getWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getWorkflowExecutionHistory(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistory(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.getWorkflowExecutionHistory']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutions(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.getWorkflowExecutions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompleteWorkflowLibrary(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibrary(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.listCompleteWorkflowLibrary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryActions(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActions(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.listWorkflowLibraryActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperators(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.listWorkflowLibraryOperators']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryTriggers(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggers(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.listWorkflowLibraryTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @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: **modified, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflows(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflows(limit, offset, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.listWorkflows']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkflow(id: string, jsonPatchOperationBeta: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflow(id, jsonPatchOperationBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.patchWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {PostExternalExecuteWorkflowRequestBeta} [postExternalExecuteWorkflowRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async postExternalExecuteWorkflow(id: string, postExternalExecuteWorkflowRequestBeta?: PostExternalExecuteWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postExternalExecuteWorkflow(id, postExternalExecuteWorkflowRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.postExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async postWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postWorkflowExternalTrigger(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.postWorkflowExternalTrigger']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyBeta} workflowBodyBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putWorkflow(id: string, workflowBodyBeta: WorkflowBodyBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflow(id, workflowBodyBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.putWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestBeta} [testExternalExecuteWorkflowRequestBeta] - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequestBeta?: TestExternalExecuteWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflow(id, testExternalExecuteWorkflowRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.testExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestBeta} testWorkflowRequestBeta - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testWorkflow(id: string, testWorkflowRequestBeta: TestWorkflowRequestBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflow(id, testWorkflowRequestBeta, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsBetaApi.testWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkflowsBetaApi - factory interface - * @export - */ -export const WorkflowsBetaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkflowsBetaApiFp(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsBetaApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution(requestParameters: WorkflowsBetaApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsBetaApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow(requestParameters: WorkflowsBetaApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflow(requestParameters.createWorkflowRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsBetaApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow(requestParameters: WorkflowsBetaApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsBetaApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow(requestParameters: WorkflowsBetaApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsBetaApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution(requestParameters: WorkflowsBetaApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsBetaApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkflowExecutionHistory(requestParameters: WorkflowsBetaApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsBetaApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions(requestParameters: WorkflowsBetaApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsBetaApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary(requestParameters: WorkflowsBetaApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsBetaApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions(requestParameters: WorkflowsBetaApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryOperators(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsBetaApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers(requestParameters: WorkflowsBetaApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {WorkflowsBetaApiListWorkflowsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows(requestParameters: WorkflowsBetaApiListWorkflowsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflows(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsBetaApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow(requestParameters: WorkflowsBetaApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsBetaApiPostExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - postExternalExecuteWorkflow(requestParameters: WorkflowsBetaApiPostExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postExternalExecuteWorkflow(requestParameters.id, requestParameters.postExternalExecuteWorkflowRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsBetaApiPostWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - postWorkflowExternalTrigger(requestParameters: WorkflowsBetaApiPostWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsBetaApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow(requestParameters: WorkflowsBetaApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putWorkflow(requestParameters.id, requestParameters.workflowBodyBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsBetaApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - testExternalExecuteWorkflow(requestParameters: WorkflowsBetaApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsBetaApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow(requestParameters: WorkflowsBetaApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestBeta, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelWorkflowExecution operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiCancelWorkflowExecutionRequest - */ -export interface WorkflowsBetaApiCancelWorkflowExecutionRequest { - /** - * The workflow execution ID - * @type {string} - * @memberof WorkflowsBetaApiCancelWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for createWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiCreateWorkflowRequest - */ -export interface WorkflowsBetaApiCreateWorkflowRequest { - /** - * - * @type {CreateWorkflowRequestBeta} - * @memberof WorkflowsBetaApiCreateWorkflow - */ - readonly createWorkflowRequestBeta: CreateWorkflowRequestBeta -} - -/** - * Request parameters for deleteWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiDeleteWorkflowRequest - */ -export interface WorkflowsBetaApiDeleteWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsBetaApiDeleteWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiGetWorkflowRequest - */ -export interface WorkflowsBetaApiGetWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsBetaApiGetWorkflow - */ - readonly id: string - - /** - * disable workflow metrics - * @type {boolean} - * @memberof WorkflowsBetaApiGetWorkflow - */ - readonly workflowMetrics?: boolean -} - -/** - * Request parameters for getWorkflowExecution operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiGetWorkflowExecutionRequest - */ -export interface WorkflowsBetaApiGetWorkflowExecutionRequest { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowsBetaApiGetWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistory operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiGetWorkflowExecutionHistoryRequest - */ -export interface WorkflowsBetaApiGetWorkflowExecutionHistoryRequest { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsBetaApiGetWorkflowExecutionHistory - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutions operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiGetWorkflowExecutionsRequest - */ -export interface WorkflowsBetaApiGetWorkflowExecutionsRequest { - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowsBetaApiGetWorkflowExecutions - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiGetWorkflowExecutions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiGetWorkflowExecutions - */ - readonly offset?: number - - /** - * 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* - * @type {string} - * @memberof WorkflowsBetaApiGetWorkflowExecutions - */ - readonly filters?: string -} - -/** - * Request parameters for listCompleteWorkflowLibrary operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiListCompleteWorkflowLibraryRequest - */ -export interface WorkflowsBetaApiListCompleteWorkflowLibraryRequest { - /** - * 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 WorkflowsBetaApiListCompleteWorkflowLibrary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiListCompleteWorkflowLibrary - */ - readonly offset?: number -} - -/** - * Request parameters for listWorkflowLibraryActions operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiListWorkflowLibraryActionsRequest - */ -export interface WorkflowsBetaApiListWorkflowLibraryActionsRequest { - /** - * 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 WorkflowsBetaApiListWorkflowLibraryActions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiListWorkflowLibraryActions - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsBetaApiListWorkflowLibraryActions - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflowLibraryTriggers operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiListWorkflowLibraryTriggersRequest - */ -export interface WorkflowsBetaApiListWorkflowLibraryTriggersRequest { - /** - * 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 WorkflowsBetaApiListWorkflowLibraryTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiListWorkflowLibraryTriggers - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsBetaApiListWorkflowLibraryTriggers - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflows operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiListWorkflowsRequest - */ -export interface WorkflowsBetaApiListWorkflowsRequest { - /** - * 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 WorkflowsBetaApiListWorkflows - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsBetaApiListWorkflows - */ - readonly offset?: number - - /** - * 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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @type {string} - * @memberof WorkflowsBetaApiListWorkflows - */ - 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: **modified, name** - * @type {string} - * @memberof WorkflowsBetaApiListWorkflows - */ - readonly sorters?: string -} - -/** - * Request parameters for patchWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiPatchWorkflowRequest - */ -export interface WorkflowsBetaApiPatchWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsBetaApiPatchWorkflow - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof WorkflowsBetaApiPatchWorkflow - */ - readonly jsonPatchOperationBeta: Array -} - -/** - * Request parameters for postExternalExecuteWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiPostExternalExecuteWorkflowRequest - */ -export interface WorkflowsBetaApiPostExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsBetaApiPostExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {PostExternalExecuteWorkflowRequestBeta} - * @memberof WorkflowsBetaApiPostExternalExecuteWorkflow - */ - readonly postExternalExecuteWorkflowRequestBeta?: PostExternalExecuteWorkflowRequestBeta -} - -/** - * Request parameters for postWorkflowExternalTrigger operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiPostWorkflowExternalTriggerRequest - */ -export interface WorkflowsBetaApiPostWorkflowExternalTriggerRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsBetaApiPostWorkflowExternalTrigger - */ - readonly id: string -} - -/** - * Request parameters for putWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiPutWorkflowRequest - */ -export interface WorkflowsBetaApiPutWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsBetaApiPutWorkflow - */ - readonly id: string - - /** - * - * @type {WorkflowBodyBeta} - * @memberof WorkflowsBetaApiPutWorkflow - */ - readonly workflowBodyBeta: WorkflowBodyBeta -} - -/** - * Request parameters for testExternalExecuteWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiTestExternalExecuteWorkflowRequest - */ -export interface WorkflowsBetaApiTestExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsBetaApiTestExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {TestExternalExecuteWorkflowRequestBeta} - * @memberof WorkflowsBetaApiTestExternalExecuteWorkflow - */ - readonly testExternalExecuteWorkflowRequestBeta?: TestExternalExecuteWorkflowRequestBeta -} - -/** - * Request parameters for testWorkflow operation in WorkflowsBetaApi. - * @export - * @interface WorkflowsBetaApiTestWorkflowRequest - */ -export interface WorkflowsBetaApiTestWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsBetaApiTestWorkflow - */ - readonly id: string - - /** - * - * @type {TestWorkflowRequestBeta} - * @memberof WorkflowsBetaApiTestWorkflow - */ - readonly testWorkflowRequestBeta: TestWorkflowRequestBeta -} - -/** - * WorkflowsBetaApi - object-oriented interface - * @export - * @class WorkflowsBetaApi - * @extends {BaseAPI} - */ -export class WorkflowsBetaApi extends BaseAPI { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsBetaApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public cancelWorkflowExecution(requestParameters: WorkflowsBetaApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsBetaApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public createWorkflow(requestParameters: WorkflowsBetaApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).createWorkflow(requestParameters.createWorkflowRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsBetaApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public deleteWorkflow(requestParameters: WorkflowsBetaApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsBetaApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public getWorkflow(requestParameters: WorkflowsBetaApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsBetaApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public getWorkflowExecution(requestParameters: WorkflowsBetaApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsBetaApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public getWorkflowExecutionHistory(requestParameters: WorkflowsBetaApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsBetaApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public getWorkflowExecutions(requestParameters: WorkflowsBetaApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsBetaApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public listCompleteWorkflowLibrary(requestParameters: WorkflowsBetaApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsBetaApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public listWorkflowLibraryActions(requestParameters: WorkflowsBetaApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).listWorkflowLibraryOperators(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsBetaApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public listWorkflowLibraryTriggers(requestParameters: WorkflowsBetaApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {WorkflowsBetaApiListWorkflowsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public listWorkflows(requestParameters: WorkflowsBetaApiListWorkflowsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).listWorkflows(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsBetaApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public patchWorkflow(requestParameters: WorkflowsBetaApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsBetaApiPostExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public postExternalExecuteWorkflow(requestParameters: WorkflowsBetaApiPostExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).postExternalExecuteWorkflow(requestParameters.id, requestParameters.postExternalExecuteWorkflowRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsBetaApiPostWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public postWorkflowExternalTrigger(requestParameters: WorkflowsBetaApiPostWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).postWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsBetaApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public putWorkflow(requestParameters: WorkflowsBetaApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).putWorkflow(requestParameters.id, requestParameters.workflowBodyBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsBetaApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public testExternalExecuteWorkflow(requestParameters: WorkflowsBetaApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsBetaApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsBetaApi - */ - public testWorkflow(requestParameters: WorkflowsBetaApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsBetaApiFp(this.configuration).testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestBeta, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - diff --git a/sdk-output/beta/base.ts b/sdk-output/beta/base.ts deleted file mode 100644 index 61862560..00000000 --- a/sdk-output/beta/base.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud Beta API - * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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: 3.1.0-beta - * - * - * 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'; -// Some imports not used depending on template conditions -// @ts-ignore -import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; -import globalAxios from 'axios'; - -export const BASE_PATH = "https://sailpoint.api.identitynow.com/beta".replace(/\/+$/, ""); - -/** - * - * @export - */ -export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; - -/** - * - * @export - * @interface RequestArgs - */ -export interface RequestArgs { - url: string; - axiosOptions: RawAxiosRequestConfig; -} - -/** - * - * @export - * @class BaseAPI - */ -export class BaseAPI { - protected configuration: Configuration | undefined; - - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath + "/beta"|| this.basePath; - } - } -}; - -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ -export class RequiredError extends Error { - constructor(public field: string, msg?: string) { - super(msg); - this.name = "RequiredError" - } -} - -interface ServerMap { - [key: string]: { - url: string, - description: string, - }[]; -} - -/** - * - * @export - */ -export const operationServerMap: ServerMap = { -} diff --git a/sdk-output/beta/common.ts b/sdk-output/beta/common.ts deleted file mode 100644 index 953901de..00000000 --- a/sdk-output/beta/common.ts +++ /dev/null @@ -1,170 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud Beta API - * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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: 3.1.0-beta - * - * - * 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 { RequestArgs } from "./base"; -import type { AxiosInstance, AxiosResponse } from 'axios'; -import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; - -/** - * - * @export - */ -export const DUMMY_BASE_URL = 'https://example.com' - -/** - * - * @throws {RequiredError} - * @export - */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } -} - -/** - * - * @export - */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } -} - -/** - * - * @export - */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; - } -} - -/** - * - * @export - */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } -} - -/** - * - * @export - */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } -} - -function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { - if (parameter == null) return; - if (typeof parameter === "object") { - if (Array.isArray(parameter)) { - (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } - else { - Object.keys(parameter).forEach(currentKey => - setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) - ); - } - } - else { - if (urlSearchParams.has(key)) { - urlSearchParams.append(key, parameter); - } - else { - urlSearchParams.set(key, parameter); - } - } -} - -/** - * - * @export - */ -export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - setFlattenedQueryParams(searchParams, objects); - url.search = searchParams.toString(); -} - -/** - * - * @export - */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); -} - -/** - * - * @export - */ -export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash -} - -/** - * - * @export - */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) - let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; - if (configuration?.consumerIdentifier && configuration?.consumerVersion) { - userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; - } - userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; - const headers = { - ...axiosArgs.axiosOptions.headers, - ...{'X-SailPoint-SDK':'typescript-1.8.69'}, - ...{'User-Agent': userAgent}, - } - - if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { - throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") - } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { - console.log("Warning: You are using Experimental APIs") - } - - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath+ "/beta" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; -} diff --git a/sdk-output/beta/configuration.ts b/sdk-output/beta/configuration.ts deleted file mode 100644 index 95ae2f54..00000000 --- a/sdk-output/beta/configuration.ts +++ /dev/null @@ -1,110 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud Beta API - * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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: 3.1.0-beta - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export interface ConfigurationParameters { - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - username?: string; - password?: string; - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - basePath?: string; - serverIndex?: number; - baseOptions?: any; - formDataCtor?: new () => any; -} - -export class Configuration { - /** - * parameter for apiKey security - * @param name security name - * @memberof Configuration - */ - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - username?: string; - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - password?: string; - /** - * parameter for oauth2 security - * @param name security name - * @param scopes oauth2 scope - * @memberof Configuration - */ - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - /** - * override base path - * - * @type {string} - * @memberof Configuration - */ - basePath?: string; - /** - * override server index - * - * @type {number} - * @memberof Configuration - */ - serverIndex?: number; - /** - * base options for axios calls - * - * @type {any} - * @memberof Configuration - */ - baseOptions?: any; - /** - * The FormData constructor that will be used to create multipart form data - * requests. You can inject this here so that execution environments that - * do not support the FormData class can still run the generated client. - * - * @type {new () => FormData} - */ - formDataCtor?: new () => any; - - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.serverIndex = param.serverIndex; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } - - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - public isJsonMime(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } -} diff --git a/sdk-output/beta/index.ts b/sdk-output/beta/index.ts deleted file mode 100644 index f5f5a583..00000000 --- a/sdk-output/beta/index.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud Beta API - * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. 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: 3.1.0-beta - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export * from "./api"; -export * from "../configuration"; - diff --git a/sdk-output/branding/.gitignore b/sdk-output/branding/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/branding/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/branding/.npmignore b/sdk-output/branding/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/branding/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/branding/.openapi-generator-ignore b/sdk-output/branding/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/branding/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/branding/.openapi-generator/FILES b/sdk-output/branding/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/branding/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/branding/.openapi-generator/VERSION b/sdk-output/branding/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/branding/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/branding/.sdk-partition b/sdk-output/branding/.sdk-partition new file mode 100644 index 00000000..7f0343fd --- /dev/null +++ b/sdk-output/branding/.sdk-partition @@ -0,0 +1 @@ +branding \ No newline at end of file diff --git a/sdk-output/branding/README.md b/sdk-output/branding/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/branding/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/branding/api.ts b/sdk-output/branding/api.ts new file mode 100644 index 00000000..ceba949b --- /dev/null +++ b/sdk-output/branding/api.ts @@ -0,0 +1,879 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Branding + * 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 BrandingitemV1 + */ +export interface BrandingitemV1 { + /** + * name of branding item + * @type {string} + * @memberof BrandingitemV1 + */ + 'name'?: string; + /** + * product name + * @type {string} + * @memberof BrandingitemV1 + */ + 'productName'?: string | null; + /** + * hex value of color for action button + * @type {string} + * @memberof BrandingitemV1 + */ + 'actionButtonColor'?: string | null; + /** + * hex value of color for link + * @type {string} + * @memberof BrandingitemV1 + */ + 'activeLinkColor'?: string | null; + /** + * hex value of color for navigation bar + * @type {string} + * @memberof BrandingitemV1 + */ + 'navigationColor'?: string | null; + /** + * email from address + * @type {string} + * @memberof BrandingitemV1 + */ + 'emailFromAddress'?: string | null; + /** + * url to standard logo + * @type {string} + * @memberof BrandingitemV1 + */ + 'standardLogoURL'?: string | null; + /** + * login information message + * @type {string} + * @memberof BrandingitemV1 + */ + 'loginInformationalMessage'?: string | null; +} +/** + * + * @export + * @interface BrandingitemcreateV1 + */ +export interface BrandingitemcreateV1 { + /** + * name of branding item + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'name': string; + /** + * product name + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'productName': string | null; + /** + * hex value of color for action button + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'actionButtonColor'?: string; + /** + * hex value of color for link + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'activeLinkColor'?: string; + /** + * hex value of color for navigation bar + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'navigationColor'?: string; + /** + * email from address + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'emailFromAddress'?: string; + /** + * login information message + * @type {string} + * @memberof BrandingitemcreateV1 + */ + 'loginInformationalMessage'?: string; + /** + * png file with logo + * @type {File} + * @memberof BrandingitemcreateV1 + */ + 'fileStandard'?: File; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetBrandingListV1401ResponseV1 + */ +export interface GetBrandingListV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetBrandingListV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetBrandingListV1429ResponseV1 + */ +export interface GetBrandingListV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetBrandingListV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * BrandingV1Api - axios parameter creator + * @export + */ +export const BrandingV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API endpoint creates a branding item. + * @summary Create a branding item + * @param {string} name name of branding item + * @param {string | null} productName product name + * @param {string} [actionButtonColor] hex value of color for action button + * @param {string} [activeLinkColor] hex value of color for link + * @param {string} [navigationColor] hex value of color for navigation bar + * @param {string} [emailFromAddress] email from address + * @param {string} [loginInformationalMessage] login information message + * @param {File} [fileStandard] png file with logo + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createBrandingItemV1: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('createBrandingItemV1', 'name', name) + // verify required parameter 'productName' is not null or undefined + assertParamExists('createBrandingItemV1', 'productName', productName) + const localVarPath = `/brandings/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; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (name !== undefined) { + localVarFormParams.append('name', name as any); + } + + if (productName !== undefined) { + localVarFormParams.append('productName', productName as any); + } + + if (actionButtonColor !== undefined) { + localVarFormParams.append('actionButtonColor', actionButtonColor as any); + } + + if (activeLinkColor !== undefined) { + localVarFormParams.append('activeLinkColor', activeLinkColor as any); + } + + if (navigationColor !== undefined) { + localVarFormParams.append('navigationColor', navigationColor as any); + } + + if (emailFromAddress !== undefined) { + localVarFormParams.append('emailFromAddress', emailFromAddress as any); + } + + if (loginInformationalMessage !== undefined) { + localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); + } + + if (fileStandard !== undefined) { + localVarFormParams.append('fileStandard', fileStandard as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint delete information for an existing branding item by name. + * @summary Delete a branding item + * @param {string} name The name of the branding item to be deleted + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBrandingV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('deleteBrandingV1', 'name', name) + const localVarPath = `/brandings/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint returns a list of branding items. + * @summary List of branding items + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBrandingListV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/brandings/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint retrieves information for an existing branding item by name. + * @summary Get a branding item + * @param {string} name The name of the branding item to be retrieved + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBrandingV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('getBrandingV1', 'name', name) + const localVarPath = `/brandings/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint updates information for an existing branding item. + * @summary Update a branding item + * @param {string} name The name of the branding item to be retrieved + * @param {string} name2 name of branding item + * @param {string | null} productName product name + * @param {string} [actionButtonColor] hex value of color for action button + * @param {string} [activeLinkColor] hex value of color for link + * @param {string} [navigationColor] hex value of color for navigation bar + * @param {string} [emailFromAddress] email from address + * @param {string} [loginInformationalMessage] login information message + * @param {File} [fileStandard] png file with logo + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setBrandingItemV1: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('setBrandingItemV1', 'name', name) + // verify required parameter 'name2' is not null or undefined + assertParamExists('setBrandingItemV1', 'name2', name2) + // verify required parameter 'productName' is not null or undefined + assertParamExists('setBrandingItemV1', 'productName', productName) + const localVarPath = `/brandings/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (name2 !== undefined) { + localVarFormParams.append('name', name2 as any); + } + + if (productName !== undefined) { + localVarFormParams.append('productName', productName as any); + } + + if (actionButtonColor !== undefined) { + localVarFormParams.append('actionButtonColor', actionButtonColor as any); + } + + if (activeLinkColor !== undefined) { + localVarFormParams.append('activeLinkColor', activeLinkColor as any); + } + + if (navigationColor !== undefined) { + localVarFormParams.append('navigationColor', navigationColor as any); + } + + if (emailFromAddress !== undefined) { + localVarFormParams.append('emailFromAddress', emailFromAddress as any); + } + + if (loginInformationalMessage !== undefined) { + localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); + } + + if (fileStandard !== undefined) { + localVarFormParams.append('fileStandard', fileStandard as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrandingV1Api - functional programming interface + * @export + */ +export const BrandingV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrandingV1ApiAxiosParamCreator(configuration) + return { + /** + * This API endpoint creates a branding item. + * @summary Create a branding item + * @param {string} name name of branding item + * @param {string | null} productName product name + * @param {string} [actionButtonColor] hex value of color for action button + * @param {string} [activeLinkColor] hex value of color for link + * @param {string} [navigationColor] hex value of color for navigation bar + * @param {string} [emailFromAddress] email from address + * @param {string} [loginInformationalMessage] login information message + * @param {File} [fileStandard] png file with logo + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createBrandingItemV1(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItemV1(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrandingV1Api.createBrandingItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint delete information for an existing branding item by name. + * @summary Delete a branding item + * @param {string} name The name of the branding item to be deleted + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteBrandingV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBrandingV1(name, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrandingV1Api.deleteBrandingV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint returns a list of branding items. + * @summary List of branding items + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getBrandingListV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingListV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrandingV1Api.getBrandingListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint retrieves information for an existing branding item by name. + * @summary Get a branding item + * @param {string} name The name of the branding item to be retrieved + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getBrandingV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingV1(name, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrandingV1Api.getBrandingV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint updates information for an existing branding item. + * @summary Update a branding item + * @param {string} name The name of the branding item to be retrieved + * @param {string} name2 name of branding item + * @param {string | null} productName product name + * @param {string} [actionButtonColor] hex value of color for action button + * @param {string} [activeLinkColor] hex value of color for link + * @param {string} [navigationColor] hex value of color for navigation bar + * @param {string} [emailFromAddress] email from address + * @param {string} [loginInformationalMessage] login information message + * @param {File} [fileStandard] png file with logo + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setBrandingItemV1(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItemV1(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrandingV1Api.setBrandingItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrandingV1Api - factory interface + * @export + */ +export const BrandingV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrandingV1ApiFp(configuration) + return { + /** + * This API endpoint creates a branding item. + * @summary Create a branding item + * @param {BrandingV1ApiCreateBrandingItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createBrandingItemV1(requestParameters: BrandingV1ApiCreateBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createBrandingItemV1(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint delete information for an existing branding item by name. + * @summary Delete a branding item + * @param {BrandingV1ApiDeleteBrandingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBrandingV1(requestParameters: BrandingV1ApiDeleteBrandingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteBrandingV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint returns a list of branding items. + * @summary List of branding items + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBrandingListV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getBrandingListV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint retrieves information for an existing branding item by name. + * @summary Get a branding item + * @param {BrandingV1ApiGetBrandingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBrandingV1(requestParameters: BrandingV1ApiGetBrandingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getBrandingV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint updates information for an existing branding item. + * @summary Update a branding item + * @param {BrandingV1ApiSetBrandingItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setBrandingItemV1(requestParameters: BrandingV1ApiSetBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setBrandingItemV1(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createBrandingItemV1 operation in BrandingV1Api. + * @export + * @interface BrandingV1ApiCreateBrandingItemV1Request + */ +export interface BrandingV1ApiCreateBrandingItemV1Request { + /** + * name of branding item + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly name: string + + /** + * product name + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly productName: string | null + + /** + * hex value of color for action button + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly actionButtonColor?: string + + /** + * hex value of color for link + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly activeLinkColor?: string + + /** + * hex value of color for navigation bar + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly navigationColor?: string + + /** + * email from address + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly emailFromAddress?: string + + /** + * login information message + * @type {string} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly loginInformationalMessage?: string + + /** + * png file with logo + * @type {File} + * @memberof BrandingV1ApiCreateBrandingItemV1 + */ + readonly fileStandard?: File +} + +/** + * Request parameters for deleteBrandingV1 operation in BrandingV1Api. + * @export + * @interface BrandingV1ApiDeleteBrandingV1Request + */ +export interface BrandingV1ApiDeleteBrandingV1Request { + /** + * The name of the branding item to be deleted + * @type {string} + * @memberof BrandingV1ApiDeleteBrandingV1 + */ + readonly name: string +} + +/** + * Request parameters for getBrandingV1 operation in BrandingV1Api. + * @export + * @interface BrandingV1ApiGetBrandingV1Request + */ +export interface BrandingV1ApiGetBrandingV1Request { + /** + * The name of the branding item to be retrieved + * @type {string} + * @memberof BrandingV1ApiGetBrandingV1 + */ + readonly name: string +} + +/** + * Request parameters for setBrandingItemV1 operation in BrandingV1Api. + * @export + * @interface BrandingV1ApiSetBrandingItemV1Request + */ +export interface BrandingV1ApiSetBrandingItemV1Request { + /** + * The name of the branding item to be retrieved + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly name: string + + /** + * name of branding item + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly name2: string + + /** + * product name + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly productName: string | null + + /** + * hex value of color for action button + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly actionButtonColor?: string + + /** + * hex value of color for link + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly activeLinkColor?: string + + /** + * hex value of color for navigation bar + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly navigationColor?: string + + /** + * email from address + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly emailFromAddress?: string + + /** + * login information message + * @type {string} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly loginInformationalMessage?: string + + /** + * png file with logo + * @type {File} + * @memberof BrandingV1ApiSetBrandingItemV1 + */ + readonly fileStandard?: File +} + +/** + * BrandingV1Api - object-oriented interface + * @export + * @class BrandingV1Api + * @extends {BaseAPI} + */ +export class BrandingV1Api extends BaseAPI { + /** + * This API endpoint creates a branding item. + * @summary Create a branding item + * @param {BrandingV1ApiCreateBrandingItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof BrandingV1Api + */ + public createBrandingItemV1(requestParameters: BrandingV1ApiCreateBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return BrandingV1ApiFp(this.configuration).createBrandingItemV1(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint delete information for an existing branding item by name. + * @summary Delete a branding item + * @param {BrandingV1ApiDeleteBrandingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof BrandingV1Api + */ + public deleteBrandingV1(requestParameters: BrandingV1ApiDeleteBrandingV1Request, axiosOptions?: RawAxiosRequestConfig) { + return BrandingV1ApiFp(this.configuration).deleteBrandingV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint returns a list of branding items. + * @summary List of branding items + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof BrandingV1Api + */ + public getBrandingListV1(axiosOptions?: RawAxiosRequestConfig) { + return BrandingV1ApiFp(this.configuration).getBrandingListV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint retrieves information for an existing branding item by name. + * @summary Get a branding item + * @param {BrandingV1ApiGetBrandingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof BrandingV1Api + */ + public getBrandingV1(requestParameters: BrandingV1ApiGetBrandingV1Request, axiosOptions?: RawAxiosRequestConfig) { + return BrandingV1ApiFp(this.configuration).getBrandingV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint updates information for an existing branding item. + * @summary Update a branding item + * @param {BrandingV1ApiSetBrandingItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof BrandingV1Api + */ + public setBrandingItemV1(requestParameters: BrandingV1ApiSetBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return BrandingV1ApiFp(this.configuration).setBrandingItemV1(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/branding/base.ts b/sdk-output/branding/base.ts new file mode 100644 index 00000000..96e93237 --- /dev/null +++ b/sdk-output/branding/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Branding + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/branding/common.ts b/sdk-output/branding/common.ts new file mode 100644 index 00000000..a6c94783 --- /dev/null +++ b/sdk-output/branding/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Branding + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/branding/configuration.ts b/sdk-output/branding/configuration.ts new file mode 100644 index 00000000..dff5ab58 --- /dev/null +++ b/sdk-output/branding/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Branding + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/branding/git_push.sh b/sdk-output/branding/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/branding/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/branding/index.ts b/sdk-output/branding/index.ts new file mode 100644 index 00000000..cd910b66 --- /dev/null +++ b/sdk-output/branding/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Branding + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/branding/package.json b/sdk-output/branding/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/branding/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/branding/tsconfig.json b/sdk-output/branding/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/branding/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/certification_campaign_filters/.gitignore b/sdk-output/certification_campaign_filters/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/certification_campaign_filters/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/certification_campaign_filters/.npmignore b/sdk-output/certification_campaign_filters/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/certification_campaign_filters/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/certification_campaign_filters/.openapi-generator-ignore b/sdk-output/certification_campaign_filters/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/certification_campaign_filters/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/certification_campaign_filters/.openapi-generator/FILES b/sdk-output/certification_campaign_filters/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/certification_campaign_filters/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/certification_campaign_filters/.openapi-generator/VERSION b/sdk-output/certification_campaign_filters/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/certification_campaign_filters/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/certification_campaign_filters/.sdk-partition b/sdk-output/certification_campaign_filters/.sdk-partition new file mode 100644 index 00000000..d3614674 --- /dev/null +++ b/sdk-output/certification_campaign_filters/.sdk-partition @@ -0,0 +1 @@ +certification-campaign-filters \ No newline at end of file diff --git a/sdk-output/certification_campaign_filters/README.md b/sdk-output/certification_campaign_filters/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_campaign_filters/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_campaign_filters/api.ts b/sdk-output/certification_campaign_filters/api.ts new file mode 100644 index 00000000..4644a8f3 --- /dev/null +++ b/sdk-output/certification_campaign_filters/api.ts @@ -0,0 +1,810 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaign Filters + * 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 CampaignfilterdetailsCriteriaListInnerV1 + */ +export interface CampaignfilterdetailsCriteriaListInnerV1 { + /** + * + * @type {CriteriatypeV1} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'type': CriteriatypeV1; + /** + * + * @type {OperationV1} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'operation'?: OperationV1 | null; + /** + * Specified key from the type of criteria. + * @type {string} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'property': string | null; + /** + * Value for the specified key from the type of criteria. + * @type {string} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'value': string | null; + /** + * If true, the filter will negate the result of the criteria. + * @type {boolean} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'negateResult'?: boolean; + /** + * If true, the filter will short circuit the evaluation of the criteria. + * @type {boolean} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'shortCircuit'?: boolean; + /** + * If true, the filter will record child matches for the criteria. + * @type {boolean} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'recordChildMatches'?: boolean; + /** + * The unique ID of the criteria. + * @type {string} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'id'?: string | null; + /** + * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. + * @type {boolean} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'suppressMatchedItems'?: boolean; + /** + * List of child criteria. + * @type {Array} + * @memberof CampaignfilterdetailsCriteriaListInnerV1 + */ + 'children'?: Array; +} + + +/** + * Campaign Filter Details + * @export + * @interface CampaignfilterdetailsV1 + */ +export interface CampaignfilterdetailsV1 { + /** + * The unique ID of the campaign filter + * @type {string} + * @memberof CampaignfilterdetailsV1 + */ + 'id': string; + /** + * Campaign filter name. + * @type {string} + * @memberof CampaignfilterdetailsV1 + */ + 'name': string; + /** + * Campaign filter description. + * @type {string} + * @memberof CampaignfilterdetailsV1 + */ + 'description'?: string; + /** + * Owner of the filter. This field automatically populates at creation time with the current user. + * @type {string} + * @memberof CampaignfilterdetailsV1 + */ + 'owner': string | null; + /** + * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. + * @type {string} + * @memberof CampaignfilterdetailsV1 + */ + 'mode': CampaignfilterdetailsV1ModeV1; + /** + * List of criteria. + * @type {Array} + * @memberof CampaignfilterdetailsV1 + */ + 'criteriaList'?: Array; + /** + * If true, the filter is created by the system. If false, the filter is created by a user. + * @type {boolean} + * @memberof CampaignfilterdetailsV1 + */ + 'isSystemFilter': boolean; +} + +export const CampaignfilterdetailsV1ModeV1 = { + Inclusion: 'INCLUSION', + Exclusion: 'EXCLUSION' +} as const; + +export type CampaignfilterdetailsV1ModeV1 = typeof CampaignfilterdetailsV1ModeV1[keyof typeof CampaignfilterdetailsV1ModeV1]; + +/** + * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. + * @export + * @enum {string} + */ + +export const CriteriatypeV1 = { + Composite: 'COMPOSITE', + Role: 'ROLE', + Identity: 'IDENTITY', + IdentityAttribute: 'IDENTITY_ATTRIBUTE', + Entitlement: 'ENTITLEMENT', + AccessProfile: 'ACCESS_PROFILE', + Source: 'SOURCE', + Account: 'ACCOUNT', + AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', + InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', + InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' +} as const; + +export type CriteriatypeV1 = typeof CriteriatypeV1[keyof typeof CriteriatypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListCampaignFiltersV1200ResponseV1 + */ +export interface ListCampaignFiltersV1200ResponseV1 { + /** + * List of campaign filters. + * @type {Array} + * @memberof ListCampaignFiltersV1200ResponseV1 + */ + 'items'?: Array; + /** + * Number of filters returned. + * @type {number} + * @memberof ListCampaignFiltersV1200ResponseV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface ListCampaignFiltersV1401ResponseV1 + */ +export interface ListCampaignFiltersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListCampaignFiltersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListCampaignFiltersV1429ResponseV1 + */ +export interface ListCampaignFiltersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListCampaignFiltersV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Operation on a specific criteria + * @export + * @enum {string} + */ + +export const OperationV1 = { + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + Contains: 'CONTAINS', + StartsWith: 'STARTS_WITH', + EndsWith: 'ENDS_WITH', + And: 'AND', + Or: 'OR' +} as const; + +export type OperationV1 = typeof OperationV1[keyof typeof OperationV1]; + + + +/** + * CertificationCampaignFiltersV1Api - axios parameter creator + * @export + */ +export const CertificationCampaignFiltersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to create a campaign filter based on filter details and criteria. + * @summary Create campaign filter + * @param {CampaignfilterdetailsV1} campaignfilterdetailsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignFilterV1: async (campaignfilterdetailsV1: CampaignfilterdetailsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'campaignfilterdetailsV1' is not null or undefined + assertParamExists('createCampaignFilterV1', 'campaignfilterdetailsV1', campaignfilterdetailsV1) + const localVarPath = `/campaign-filters/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(campaignfilterdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + * @summary Deletes campaign filters + * @param {Array} requestBody A json list of IDs of campaign filters to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignFiltersV1: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('deleteCampaignFiltersV1', 'requestBody', requestBody) + const localVarPath = `/campaign-filters/v1/delete`; + // 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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves information for an existing campaign filter using the filter\'s ID. + * @summary Get campaign filter by id + * @param {string} id The ID of the campaign filter to be retrieved. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignFilterByIdV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCampaignFilterByIdV1', 'id', id) + const localVarPath = `/campaign-filters/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, + }; + }, + /** + * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + * @summary List campaign filters + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCampaignFiltersV1: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/campaign-filters/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (start !== undefined) { + localVarQueryParameter['start'] = start; + } + + if (includeSystemFilters !== undefined) { + localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates an existing campaign filter using the filter\'s ID. + * @summary Updates a campaign filter + * @param {string} id The ID of the campaign filter being modified. + * @param {CampaignfilterdetailsV1} campaignfilterdetailsV1 A campaign filter details with updated field values. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCampaignFilterV1: async (id: string, campaignfilterdetailsV1: CampaignfilterdetailsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateCampaignFilterV1', 'id', id) + // verify required parameter 'campaignfilterdetailsV1' is not null or undefined + assertParamExists('updateCampaignFilterV1', 'campaignfilterdetailsV1', campaignfilterdetailsV1) + const localVarPath = `/campaign-filters/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: '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(campaignfilterdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CertificationCampaignFiltersV1Api - functional programming interface + * @export + */ +export const CertificationCampaignFiltersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CertificationCampaignFiltersV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to create a campaign filter based on filter details and criteria. + * @summary Create campaign filter + * @param {CampaignfilterdetailsV1} campaignfilterdetailsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCampaignFilterV1(campaignfilterdetailsV1: CampaignfilterdetailsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilterV1(campaignfilterdetailsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV1Api.createCampaignFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + * @summary Deletes campaign filters + * @param {Array} requestBody A json list of IDs of campaign filters to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCampaignFiltersV1(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFiltersV1(requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV1Api.deleteCampaignFiltersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves information for an existing campaign filter using the filter\'s ID. + * @summary Get campaign filter by id + * @param {string} id The ID of the campaign filter to be retrieved. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignFilterByIdV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterByIdV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV1Api.getCampaignFilterByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + * @summary List campaign filters + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listCampaignFiltersV1(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFiltersV1(limit, start, includeSystemFilters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV1Api.listCampaignFiltersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates an existing campaign filter using the filter\'s ID. + * @summary Updates a campaign filter + * @param {string} id The ID of the campaign filter being modified. + * @param {CampaignfilterdetailsV1} campaignfilterdetailsV1 A campaign filter details with updated field values. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateCampaignFilterV1(id: string, campaignfilterdetailsV1: CampaignfilterdetailsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilterV1(id, campaignfilterdetailsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV1Api.updateCampaignFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CertificationCampaignFiltersV1Api - factory interface + * @export + */ +export const CertificationCampaignFiltersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CertificationCampaignFiltersV1ApiFp(configuration) + return { + /** + * Use this API to create a campaign filter based on filter details and criteria. + * @summary Create campaign filter + * @param {CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignFilterV1(requestParameters: CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCampaignFilterV1(requestParameters.campaignfilterdetailsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + * @summary Deletes campaign filters + * @param {CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignFiltersV1(requestParameters: CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCampaignFiltersV1(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves information for an existing campaign filter using the filter\'s ID. + * @summary Get campaign filter by id + * @param {CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignFilterByIdV1(requestParameters: CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCampaignFilterByIdV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + * @summary List campaign filters + * @param {CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCampaignFiltersV1(requestParameters: CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listCampaignFiltersV1(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates an existing campaign filter using the filter\'s ID. + * @summary Updates a campaign filter + * @param {CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCampaignFilterV1(requestParameters: CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateCampaignFilterV1(requestParameters.id, requestParameters.campaignfilterdetailsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCampaignFilterV1 operation in CertificationCampaignFiltersV1Api. + * @export + * @interface CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request + */ +export interface CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request { + /** + * + * @type {CampaignfilterdetailsV1} + * @memberof CertificationCampaignFiltersV1ApiCreateCampaignFilterV1 + */ + readonly campaignfilterdetailsV1: CampaignfilterdetailsV1 +} + +/** + * Request parameters for deleteCampaignFiltersV1 operation in CertificationCampaignFiltersV1Api. + * @export + * @interface CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request + */ +export interface CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request { + /** + * A json list of IDs of campaign filters to delete. + * @type {Array} + * @memberof CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1 + */ + readonly requestBody: Array +} + +/** + * Request parameters for getCampaignFilterByIdV1 operation in CertificationCampaignFiltersV1Api. + * @export + * @interface CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request + */ +export interface CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request { + /** + * The ID of the campaign filter to be retrieved. + * @type {string} + * @memberof CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1 + */ + readonly id: string +} + +/** + * Request parameters for listCampaignFiltersV1 operation in CertificationCampaignFiltersV1Api. + * @export + * @interface CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request + */ +export interface CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request { + /** + * 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 CertificationCampaignFiltersV1ApiListCampaignFiltersV1 + */ + readonly limit?: number + + /** + * Start/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 CertificationCampaignFiltersV1ApiListCampaignFiltersV1 + */ + readonly start?: number + + /** + * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. + * @type {boolean} + * @memberof CertificationCampaignFiltersV1ApiListCampaignFiltersV1 + */ + readonly includeSystemFilters?: boolean +} + +/** + * Request parameters for updateCampaignFilterV1 operation in CertificationCampaignFiltersV1Api. + * @export + * @interface CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request + */ +export interface CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request { + /** + * The ID of the campaign filter being modified. + * @type {string} + * @memberof CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1 + */ + readonly id: string + + /** + * A campaign filter details with updated field values. + * @type {CampaignfilterdetailsV1} + * @memberof CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1 + */ + readonly campaignfilterdetailsV1: CampaignfilterdetailsV1 +} + +/** + * CertificationCampaignFiltersV1Api - object-oriented interface + * @export + * @class CertificationCampaignFiltersV1Api + * @extends {BaseAPI} + */ +export class CertificationCampaignFiltersV1Api extends BaseAPI { + /** + * Use this API to create a campaign filter based on filter details and criteria. + * @summary Create campaign filter + * @param {CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignFiltersV1Api + */ + public createCampaignFilterV1(requestParameters: CertificationCampaignFiltersV1ApiCreateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignFiltersV1ApiFp(this.configuration).createCampaignFilterV1(requestParameters.campaignfilterdetailsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + * @summary Deletes campaign filters + * @param {CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignFiltersV1Api + */ + public deleteCampaignFiltersV1(requestParameters: CertificationCampaignFiltersV1ApiDeleteCampaignFiltersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignFiltersV1ApiFp(this.configuration).deleteCampaignFiltersV1(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves information for an existing campaign filter using the filter\'s ID. + * @summary Get campaign filter by id + * @param {CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignFiltersV1Api + */ + public getCampaignFilterByIdV1(requestParameters: CertificationCampaignFiltersV1ApiGetCampaignFilterByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignFiltersV1ApiFp(this.configuration).getCampaignFilterByIdV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + * @summary List campaign filters + * @param {CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignFiltersV1Api + */ + public listCampaignFiltersV1(requestParameters: CertificationCampaignFiltersV1ApiListCampaignFiltersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignFiltersV1ApiFp(this.configuration).listCampaignFiltersV1(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates an existing campaign filter using the filter\'s ID. + * @summary Updates a campaign filter + * @param {CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignFiltersV1Api + */ + public updateCampaignFilterV1(requestParameters: CertificationCampaignFiltersV1ApiUpdateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignFiltersV1ApiFp(this.configuration).updateCampaignFilterV1(requestParameters.id, requestParameters.campaignfilterdetailsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/certification_campaign_filters/base.ts b/sdk-output/certification_campaign_filters/base.ts new file mode 100644 index 00000000..f2289d7c --- /dev/null +++ b/sdk-output/certification_campaign_filters/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaign Filters + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/certification_campaign_filters/common.ts b/sdk-output/certification_campaign_filters/common.ts new file mode 100644 index 00000000..21dbb88f --- /dev/null +++ b/sdk-output/certification_campaign_filters/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaign Filters + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/certification_campaign_filters/configuration.ts b/sdk-output/certification_campaign_filters/configuration.ts new file mode 100644 index 00000000..d484749e --- /dev/null +++ b/sdk-output/certification_campaign_filters/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaign Filters + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/certification_campaign_filters/git_push.sh b/sdk-output/certification_campaign_filters/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/certification_campaign_filters/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/certification_campaign_filters/index.ts b/sdk-output/certification_campaign_filters/index.ts new file mode 100644 index 00000000..41e3c4ac --- /dev/null +++ b/sdk-output/certification_campaign_filters/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaign Filters + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/certification_campaign_filters/package.json b/sdk-output/certification_campaign_filters/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/certification_campaign_filters/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/certification_campaign_filters/tsconfig.json b/sdk-output/certification_campaign_filters/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/certification_campaign_filters/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/certification_campaigns/.gitignore b/sdk-output/certification_campaigns/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/certification_campaigns/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/certification_campaigns/.npmignore b/sdk-output/certification_campaigns/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/certification_campaigns/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/certification_campaigns/.openapi-generator-ignore b/sdk-output/certification_campaigns/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/certification_campaigns/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/certification_campaigns/.openapi-generator/FILES b/sdk-output/certification_campaigns/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/certification_campaigns/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/certification_campaigns/.openapi-generator/VERSION b/sdk-output/certification_campaigns/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/certification_campaigns/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/certification_campaigns/.sdk-partition b/sdk-output/certification_campaigns/.sdk-partition new file mode 100644 index 00000000..c6abbf7f --- /dev/null +++ b/sdk-output/certification_campaigns/.sdk-partition @@ -0,0 +1 @@ +certification-campaigns \ No newline at end of file diff --git a/sdk-output/certification_campaigns/README.md b/sdk-output/certification_campaigns/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_campaigns/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_campaigns/api.ts b/sdk-output/certification_campaigns/api.ts new file mode 100644 index 00000000..2ed2e169 --- /dev/null +++ b/sdk-output/certification_campaigns/api.ts @@ -0,0 +1,4000 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaigns + * 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 AccessconstraintV1 + */ +export interface AccessconstraintV1 { + /** + * Type of Access + * @type {string} + * @memberof AccessconstraintV1 + */ + 'type': AccessconstraintV1TypeV1; + /** + * Must be set only if operator is SELECTED. + * @type {Array} + * @memberof AccessconstraintV1 + */ + 'ids'?: Array; + /** + * Used to determine whether the scope of the campaign should be reduced for selected ids or all. + * @type {string} + * @memberof AccessconstraintV1 + */ + 'operator': AccessconstraintV1OperatorV1; +} + +export const AccessconstraintV1TypeV1 = { + Entitlement: 'ENTITLEMENT', + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; + +export type AccessconstraintV1TypeV1 = typeof AccessconstraintV1TypeV1[keyof typeof AccessconstraintV1TypeV1]; +export const AccessconstraintV1OperatorV1 = { + All: 'ALL', + Selected: 'SELECTED' +} as const; + +export type AccessconstraintV1OperatorV1 = typeof AccessconstraintV1OperatorV1[keyof typeof AccessconstraintV1OperatorV1]; + +/** + * + * @export + * @interface ActivatecampaignoptionsV1 + */ +export interface ActivatecampaignoptionsV1 { + /** + * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. + * @type {string} + * @memberof ActivatecampaignoptionsV1 + */ + 'timeZone'?: string; +} +/** + * + * @export + * @interface AdminreviewreassignReassignToV1 + */ +export interface AdminreviewreassignReassignToV1 { + /** + * The identity ID to which the review is being assigned. + * @type {string} + * @memberof AdminreviewreassignReassignToV1 + */ + 'id'?: string; + /** + * The type of the ID provided. + * @type {string} + * @memberof AdminreviewreassignReassignToV1 + */ + 'type'?: AdminreviewreassignReassignToV1TypeV1; +} + +export const AdminreviewreassignReassignToV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AdminreviewreassignReassignToV1TypeV1 = typeof AdminreviewreassignReassignToV1TypeV1[keyof typeof AdminreviewreassignReassignToV1TypeV1]; + +/** + * + * @export + * @interface AdminreviewreassignV1 + */ +export interface AdminreviewreassignV1 { + /** + * List of certification IDs to reassign + * @type {Array} + * @memberof AdminreviewreassignV1 + */ + 'certificationIds'?: Array; + /** + * + * @type {AdminreviewreassignReassignToV1} + * @memberof AdminreviewreassignV1 + */ + 'reassignTo'?: AdminreviewreassignReassignToV1; + /** + * Comment to explain why the certification was reassigned + * @type {string} + * @memberof AdminreviewreassignV1 + */ + 'reason'?: string; +} +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. + * @export + * @interface Campaign2AllOfFilterV1 + */ +export interface Campaign2AllOfFilterV1 { + /** + * The ID of whatever type of filter is being used. + * @type {string} + * @memberof Campaign2AllOfFilterV1 + */ + 'id'?: string; + /** + * Type of the filter + * @type {string} + * @memberof Campaign2AllOfFilterV1 + */ + 'type'?: Campaign2AllOfFilterV1TypeV1; + /** + * Name of the filter + * @type {string} + * @memberof Campaign2AllOfFilterV1 + */ + 'name'?: string; +} + +export const Campaign2AllOfFilterV1TypeV1 = { + CampaignFilter: 'CAMPAIGN_FILTER' +} as const; + +export type Campaign2AllOfFilterV1TypeV1 = typeof Campaign2AllOfFilterV1TypeV1[keyof typeof Campaign2AllOfFilterV1TypeV1]; + +/** + * Must be set only if the campaign type is MACHINE_ACCOUNT. + * @export + * @interface Campaign2AllOfMachineAccountCampaignInfoV1 + */ +export interface Campaign2AllOfMachineAccountCampaignInfoV1 { + /** + * The list of sources to be included in the campaign. + * @type {Array} + * @memberof Campaign2AllOfMachineAccountCampaignInfoV1 + */ + 'sourceIds'?: Array; + /** + * The reviewer\'s type. + * @type {string} + * @memberof Campaign2AllOfMachineAccountCampaignInfoV1 + */ + 'reviewerType'?: Campaign2AllOfMachineAccountCampaignInfoV1ReviewerTypeV1; +} + +export const Campaign2AllOfMachineAccountCampaignInfoV1ReviewerTypeV1 = { + AccountOwner: 'ACCOUNT_OWNER' +} as const; + +export type Campaign2AllOfMachineAccountCampaignInfoV1ReviewerTypeV1 = typeof Campaign2AllOfMachineAccountCampaignInfoV1ReviewerTypeV1[keyof typeof Campaign2AllOfMachineAccountCampaignInfoV1ReviewerTypeV1]; + +/** + * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. + * @export + * @interface Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 + */ +export interface Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 { + /** + * Legal Remediator Type + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 + */ + 'type': Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1TypeV1; + /** + * The ID of the remediator. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 + */ + 'id': string; + /** + * The name of the remediator. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 + */ + 'name'?: string; +} + +export const Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1TypeV1 = typeof Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1TypeV1[keyof typeof Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1TypeV1]; + +/** + * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. + * @export + * @interface Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 + */ +export interface Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 { + /** + * The reviewer\'s DTO type. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 + */ + 'type'?: Campaign2AllOfRoleCompositionCampaignInfoReviewerV1TypeV1; + /** + * The reviewer\'s ID. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 + */ + 'id'?: string; + /** + * The reviewer\'s name. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 + */ + 'name'?: string; +} + +export const Campaign2AllOfRoleCompositionCampaignInfoReviewerV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type Campaign2AllOfRoleCompositionCampaignInfoReviewerV1TypeV1 = typeof Campaign2AllOfRoleCompositionCampaignInfoReviewerV1TypeV1[keyof typeof Campaign2AllOfRoleCompositionCampaignInfoReviewerV1TypeV1]; + +/** + * Optional configuration options for role composition campaigns. + * @export + * @interface Campaign2AllOfRoleCompositionCampaignInfoV1 + */ +export interface Campaign2AllOfRoleCompositionCampaignInfoV1 { + /** + * The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + * @deprecated + */ + 'reviewerId'?: string | null; + /** + * + * @type {Campaign2AllOfRoleCompositionCampaignInfoReviewerV1} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + */ + 'reviewer'?: Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 | null; + /** + * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. + * @type {Array} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + */ + 'roleIds'?: Array; + /** + * + * @type {Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + */ + 'remediatorRef': Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1; + /** + * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + */ + 'query'?: string | null; + /** + * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. + * @type {string} + * @memberof Campaign2AllOfRoleCompositionCampaignInfoV1 + */ + 'description'?: string | null; +} +/** + * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. + * @export + * @interface Campaign2AllOfSearchCampaignInfoReviewerV1 + */ +export interface Campaign2AllOfSearchCampaignInfoReviewerV1 { + /** + * The reviewer\'s DTO type. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoReviewerV1 + */ + 'type'?: Campaign2AllOfSearchCampaignInfoReviewerV1TypeV1; + /** + * The reviewer\'s ID. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoReviewerV1 + */ + 'id'?: string; + /** + * The reviewer\'s name. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoReviewerV1 + */ + 'name'?: string | null; +} + +export const Campaign2AllOfSearchCampaignInfoReviewerV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type Campaign2AllOfSearchCampaignInfoReviewerV1TypeV1 = typeof Campaign2AllOfSearchCampaignInfoReviewerV1TypeV1[keyof typeof Campaign2AllOfSearchCampaignInfoReviewerV1TypeV1]; + +/** + * Must be set only if the campaign type is SEARCH. + * @export + * @interface Campaign2AllOfSearchCampaignInfoV1 + */ +export interface Campaign2AllOfSearchCampaignInfoV1 { + /** + * The type of search campaign represented. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'type': Campaign2AllOfSearchCampaignInfoV1TypeV1; + /** + * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'description'?: string; + /** + * + * @type {Campaign2AllOfSearchCampaignInfoReviewerV1} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'reviewer'?: Campaign2AllOfSearchCampaignInfoReviewerV1 | null; + /** + * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. + * @type {string} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'query'?: string | null; + /** + * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. + * @type {Array} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'identityIds'?: Array | null; + /** + * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. + * @type {Array} + * @memberof Campaign2AllOfSearchCampaignInfoV1 + */ + 'accessConstraints'?: Array; +} + +export const Campaign2AllOfSearchCampaignInfoV1TypeV1 = { + Identity: 'IDENTITY', + Access: 'ACCESS' +} as const; + +export type Campaign2AllOfSearchCampaignInfoV1TypeV1 = typeof Campaign2AllOfSearchCampaignInfoV1TypeV1[keyof typeof Campaign2AllOfSearchCampaignInfoV1TypeV1]; + +/** + * Must be set only if the campaign type is SOURCE_OWNER. + * @export + * @interface Campaign2AllOfSourceOwnerCampaignInfoV1 + */ +export interface Campaign2AllOfSourceOwnerCampaignInfoV1 { + /** + * The list of sources to be included in the campaign. + * @type {Array} + * @memberof Campaign2AllOfSourceOwnerCampaignInfoV1 + */ + 'sourceIds'?: Array; +} +/** + * + * @export + * @interface Campaign2AllOfSourcesWithOrphanEntitlementsV1 + */ +export interface Campaign2AllOfSourcesWithOrphanEntitlementsV1 { + /** + * Id of the source + * @type {string} + * @memberof Campaign2AllOfSourcesWithOrphanEntitlementsV1 + */ + 'id'?: string; + /** + * Type + * @type {string} + * @memberof Campaign2AllOfSourcesWithOrphanEntitlementsV1 + */ + 'type'?: Campaign2AllOfSourcesWithOrphanEntitlementsV1TypeV1; + /** + * Name of the source + * @type {string} + * @memberof Campaign2AllOfSourcesWithOrphanEntitlementsV1 + */ + 'name'?: string; +} + +export const Campaign2AllOfSourcesWithOrphanEntitlementsV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type Campaign2AllOfSourcesWithOrphanEntitlementsV1TypeV1 = typeof Campaign2AllOfSourcesWithOrphanEntitlementsV1TypeV1[keyof typeof Campaign2AllOfSourcesWithOrphanEntitlementsV1TypeV1]; + +/** + * + * @export + * @interface Campaign2V1 + */ +export interface Campaign2V1 { + /** + * Id of the campaign + * @type {string} + * @memberof Campaign2V1 + */ + 'id'?: string | null; + /** + * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof Campaign2V1 + */ + 'name': string; + /** + * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof Campaign2V1 + */ + 'description': string | null; + /** + * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. + * @type {string} + * @memberof Campaign2V1 + */ + 'deadline'?: string | null; + /** + * The type of campaign. Could be extended in the future. + * @type {string} + * @memberof Campaign2V1 + */ + 'type': Campaign2V1TypeV1; + /** + * Enables email notification for this campaign + * @type {boolean} + * @memberof Campaign2V1 + */ + 'emailNotificationEnabled'?: boolean; + /** + * Allows auto revoke for this campaign + * @type {boolean} + * @memberof Campaign2V1 + */ + 'autoRevokeAllowed'?: boolean; + /** + * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. + * @type {boolean} + * @memberof Campaign2V1 + */ + 'recommendationsEnabled'?: boolean; + /** + * The campaign\'s current status. + * @type {string} + * @memberof Campaign2V1 + */ + 'status'?: Campaign2V1StatusV1 | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof Campaign2V1 + */ + 'correlatedStatus'?: Campaign2V1CorrelatedStatusV1; + /** + * Created time of the campaign + * @type {string} + * @memberof Campaign2V1 + */ + 'created'?: string | null; + /** + * The total number of certifications in this campaign. + * @type {number} + * @memberof Campaign2V1 + */ + 'totalCertifications'?: number | null; + /** + * The number of completed certifications in this campaign. + * @type {number} + * @memberof Campaign2V1 + */ + 'completedCertifications'?: number | null; + /** + * A list of errors and warnings that have accumulated. + * @type {Array} + * @memberof Campaign2V1 + */ + 'alerts'?: Array | null; + /** + * Modified time of the campaign + * @type {string} + * @memberof Campaign2V1 + */ + 'modified'?: string | null; + /** + * + * @type {Campaign2AllOfFilterV1} + * @memberof Campaign2V1 + */ + 'filter'?: Campaign2AllOfFilterV1 | null; + /** + * Determines if comments on sunset date changes are required. + * @type {boolean} + * @memberof Campaign2V1 + */ + 'sunsetCommentsRequired'?: boolean; + /** + * + * @type {Campaign2AllOfSourceOwnerCampaignInfoV1} + * @memberof Campaign2V1 + */ + 'sourceOwnerCampaignInfo'?: Campaign2AllOfSourceOwnerCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfSearchCampaignInfoV1} + * @memberof Campaign2V1 + */ + 'searchCampaignInfo'?: Campaign2AllOfSearchCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfRoleCompositionCampaignInfoV1} + * @memberof Campaign2V1 + */ + 'roleCompositionCampaignInfo'?: Campaign2AllOfRoleCompositionCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfMachineAccountCampaignInfoV1} + * @memberof Campaign2V1 + */ + 'machineAccountCampaignInfo'?: Campaign2AllOfMachineAccountCampaignInfoV1 | null; + /** + * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + * @type {Array} + * @memberof Campaign2V1 + */ + 'sourcesWithOrphanEntitlements'?: Array | null; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof Campaign2V1 + */ + 'mandatoryCommentRequirement'?: Campaign2V1MandatoryCommentRequirementV1; +} + +export const Campaign2V1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type Campaign2V1TypeV1 = typeof Campaign2V1TypeV1[keyof typeof Campaign2V1TypeV1]; +export const Campaign2V1StatusV1 = { + Pending: 'PENDING', + Staged: 'STAGED', + Canceling: 'CANCELING', + Activating: 'ACTIVATING', + Active: 'ACTIVE', + Completing: 'COMPLETING', + Completed: 'COMPLETED', + Error: 'ERROR', + Archived: 'ARCHIVED' +} as const; + +export type Campaign2V1StatusV1 = typeof Campaign2V1StatusV1[keyof typeof Campaign2V1StatusV1]; +export const Campaign2V1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type Campaign2V1CorrelatedStatusV1 = typeof Campaign2V1CorrelatedStatusV1[keyof typeof Campaign2V1CorrelatedStatusV1]; +export const Campaign2V1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type Campaign2V1MandatoryCommentRequirementV1 = typeof Campaign2V1MandatoryCommentRequirementV1[keyof typeof Campaign2V1MandatoryCommentRequirementV1]; + +/** + * + * @export + * @interface CampaignalertV1 + */ +export interface CampaignalertV1 { + /** + * Denotes the level of the message + * @type {string} + * @memberof CampaignalertV1 + */ + 'level'?: CampaignalertV1LevelV1; + /** + * + * @type {Array} + * @memberof CampaignalertV1 + */ + 'localizations'?: Array; +} + +export const CampaignalertV1LevelV1 = { + Error: 'ERROR', + Warn: 'WARN', + Info: 'INFO' +} as const; + +export type CampaignalertV1LevelV1 = typeof CampaignalertV1LevelV1[keyof typeof CampaignalertV1LevelV1]; + +/** + * + * @export + * @interface CampaigncompleteoptionsV1 + */ +export interface CampaigncompleteoptionsV1 { + /** + * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. + * @type {string} + * @memberof CampaigncompleteoptionsV1 + */ + 'autoCompleteAction'?: CampaigncompleteoptionsV1AutoCompleteActionV1; +} + +export const CampaigncompleteoptionsV1AutoCompleteActionV1 = { + Approve: 'APPROVE', + Revoke: 'REVOKE' +} as const; + +export type CampaigncompleteoptionsV1AutoCompleteActionV1 = typeof CampaigncompleteoptionsV1AutoCompleteActionV1[keyof typeof CampaigncompleteoptionsV1AutoCompleteActionV1]; + +/** + * + * @export + * @interface CampaignreferenceV1 + */ +export interface CampaignreferenceV1 { + /** + * The unique ID of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'id': string; + /** + * The name of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'name': string; + /** + * The type of object that is being referenced. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'type': CampaignreferenceV1TypeV1; + /** + * The type of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'campaignType': CampaignreferenceV1CampaignTypeV1; + /** + * The description of the campaign set by the admin who created it. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'description': string | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'correlatedStatus': CampaignreferenceV1CorrelatedStatusV1; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'mandatoryCommentRequirement': CampaignreferenceV1MandatoryCommentRequirementV1; +} + +export const CampaignreferenceV1TypeV1 = { + Campaign: 'CAMPAIGN' +} as const; + +export type CampaignreferenceV1TypeV1 = typeof CampaignreferenceV1TypeV1[keyof typeof CampaignreferenceV1TypeV1]; +export const CampaignreferenceV1CampaignTypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type CampaignreferenceV1CampaignTypeV1 = typeof CampaignreferenceV1CampaignTypeV1[keyof typeof CampaignreferenceV1CampaignTypeV1]; +export const CampaignreferenceV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type CampaignreferenceV1CorrelatedStatusV1 = typeof CampaignreferenceV1CorrelatedStatusV1[keyof typeof CampaignreferenceV1CorrelatedStatusV1]; +export const CampaignreferenceV1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type CampaignreferenceV1MandatoryCommentRequirementV1 = typeof CampaignreferenceV1MandatoryCommentRequirementV1[keyof typeof CampaignreferenceV1MandatoryCommentRequirementV1]; + +/** + * + * @export + * @interface CampaignreportV1 + */ +export interface CampaignreportV1 { + /** + * SOD policy violation report result DTO type. + * @type {string} + * @memberof CampaignreportV1 + */ + 'type'?: CampaignreportV1TypeV1; + /** + * SOD policy violation report result ID. + * @type {string} + * @memberof CampaignreportV1 + */ + 'id'?: string; + /** + * Human-readable name of the SOD policy violation report result. + * @type {string} + * @memberof CampaignreportV1 + */ + 'name'?: string; + /** + * Status of a SOD policy violation report. + * @type {string} + * @memberof CampaignreportV1 + */ + 'status'?: CampaignreportV1StatusV1; + /** + * + * @type {ReporttypeV1} + * @memberof CampaignreportV1 + */ + 'reportType': ReporttypeV1; + /** + * The most recent date and time this report was run + * @type {string} + * @memberof CampaignreportV1 + */ + 'lastRunAt'?: string; +} + +export const CampaignreportV1TypeV1 = { + ReportResult: 'REPORT_RESULT' +} as const; + +export type CampaignreportV1TypeV1 = typeof CampaignreportV1TypeV1[keyof typeof CampaignreportV1TypeV1]; +export const CampaignreportV1StatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR', + Pending: 'PENDING' +} as const; + +export type CampaignreportV1StatusV1 = typeof CampaignreportV1StatusV1[keyof typeof CampaignreportV1StatusV1]; + +/** + * + * @export + * @interface CampaignreportsconfigV1 + */ +export interface CampaignreportsconfigV1 { + /** + * list of identity attribute columns + * @type {Array} + * @memberof CampaignreportsconfigV1 + */ + 'identityAttributeColumns'?: Array | null; +} +/** + * + * @export + * @interface CampaignsdeleterequestV1 + */ +export interface CampaignsdeleterequestV1 { + /** + * The ids of the campaigns to delete + * @type {Array} + * @memberof CampaignsdeleterequestV1 + */ + 'ids'?: Array; +} +/** + * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. + * @export + * @interface CampaigntemplateOwnerRefV1 + */ +export interface CampaigntemplateOwnerRefV1 { + /** + * Id of the owner + * @type {string} + * @memberof CampaigntemplateOwnerRefV1 + */ + 'id'?: string; + /** + * Type of the owner + * @type {string} + * @memberof CampaigntemplateOwnerRefV1 + */ + 'type'?: CampaigntemplateOwnerRefV1TypeV1; + /** + * Name of the owner + * @type {string} + * @memberof CampaigntemplateOwnerRefV1 + */ + 'name'?: string; + /** + * Email of the owner + * @type {string} + * @memberof CampaigntemplateOwnerRefV1 + */ + 'email'?: string; +} + +export const CampaigntemplateOwnerRefV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type CampaigntemplateOwnerRefV1TypeV1 = typeof CampaigntemplateOwnerRefV1TypeV1[keyof typeof CampaigntemplateOwnerRefV1TypeV1]; + +/** + * Campaign Template + * @export + * @interface CampaigntemplateV1 + */ +export interface CampaigntemplateV1 { + /** + * Id of the campaign template + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'id'?: string; + /** + * This template\'s name. Has no bearing on generated campaigns\' names. + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'name': string; + /** + * This template\'s description. Has no bearing on generated campaigns\' descriptions. + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'description': string; + /** + * Creation date of Campaign Template + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'created': string; + /** + * Modification date of Campaign Template + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'modified': string | null; + /** + * Indicates if this campaign template has been scheduled. + * @type {boolean} + * @memberof CampaigntemplateV1 + */ + 'scheduled'?: boolean; + /** + * + * @type {CampaigntemplateOwnerRefV1} + * @memberof CampaigntemplateV1 + */ + 'ownerRef'?: CampaigntemplateOwnerRefV1; + /** + * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). + * @type {string} + * @memberof CampaigntemplateV1 + */ + 'deadlineDuration'?: string | null; + /** + * + * @type {Campaign2V1} + * @memberof CampaigntemplateV1 + */ + 'campaign': Campaign2V1; +} +/** + * + * @export + * @interface CertificationtaskV1 + */ +export interface CertificationtaskV1 { + /** + * The ID of the certification task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'id'?: string; + /** + * The type of the certification task. More values may be added in the future. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'type'?: CertificationtaskV1TypeV1; + /** + * The type of item that is being operated on by this task whose ID is stored in the targetId field. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'targetType'?: CertificationtaskV1TargetTypeV1; + /** + * The ID of the item being operated on by this task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'targetId'?: string; + /** + * The status of the task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'status'?: CertificationtaskV1StatusV1; + /** + * List of error messages + * @type {Array} + * @memberof CertificationtaskV1 + */ + 'errors'?: Array; + /** + * Reassignment trails that lead to self certification identity + * @type {Array} + * @memberof CertificationtaskV1 + */ + 'reassignmentTrailDTOs'?: Array; + /** + * The date and time on which this task was created. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'created'?: string; +} + +export const CertificationtaskV1TypeV1 = { + Reassign: 'REASSIGN', + AdminReassign: 'ADMIN_REASSIGN', + CompleteCertification: 'COMPLETE_CERTIFICATION', + FinishCertification: 'FINISH_CERTIFICATION', + CompleteCampaign: 'COMPLETE_CAMPAIGN', + ActivateCampaign: 'ACTIVATE_CAMPAIGN', + CampaignCreate: 'CAMPAIGN_CREATE', + CampaignDelete: 'CAMPAIGN_DELETE' +} as const; + +export type CertificationtaskV1TypeV1 = typeof CertificationtaskV1TypeV1[keyof typeof CertificationtaskV1TypeV1]; +export const CertificationtaskV1TargetTypeV1 = { + Certification: 'CERTIFICATION', + Campaign: 'CAMPAIGN' +} as const; + +export type CertificationtaskV1TargetTypeV1 = typeof CertificationtaskV1TargetTypeV1[keyof typeof CertificationtaskV1TargetTypeV1]; +export const CertificationtaskV1StatusV1 = { + Queued: 'QUEUED', + InProgress: 'IN_PROGRESS', + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type CertificationtaskV1StatusV1 = typeof CertificationtaskV1StatusV1[keyof typeof CertificationtaskV1StatusV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetActiveCampaignsV1200ResponseInnerV1 + */ +export interface GetActiveCampaignsV1200ResponseInnerV1 { + /** + * Id of the campaign + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'id'?: string | null; + /** + * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'name': string; + /** + * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'description': string | null; + /** + * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'deadline'?: string | null; + /** + * The type of campaign. Could be extended in the future. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'type': GetActiveCampaignsV1200ResponseInnerV1TypeV1; + /** + * Enables email notification for this campaign + * @type {boolean} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'emailNotificationEnabled'?: boolean; + /** + * Allows auto revoke for this campaign + * @type {boolean} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'autoRevokeAllowed'?: boolean; + /** + * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. + * @type {boolean} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'recommendationsEnabled'?: boolean; + /** + * The campaign\'s current status. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'status'?: GetActiveCampaignsV1200ResponseInnerV1StatusV1 | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'correlatedStatus'?: GetActiveCampaignsV1200ResponseInnerV1CorrelatedStatusV1; + /** + * Created time of the campaign + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'created'?: string | null; + /** + * The total number of certifications in this campaign. + * @type {number} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'totalCertifications'?: number | null; + /** + * The number of completed certifications in this campaign. + * @type {number} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'completedCertifications'?: number | null; + /** + * A list of errors and warnings that have accumulated. + * @type {Array} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'alerts'?: Array | null; + /** + * Modified time of the campaign + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'modified'?: string | null; + /** + * + * @type {Campaign2AllOfFilterV1} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'filter'?: Campaign2AllOfFilterV1 | null; + /** + * Determines if comments on sunset date changes are required. + * @type {boolean} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'sunsetCommentsRequired'?: boolean; + /** + * + * @type {Campaign2AllOfSourceOwnerCampaignInfoV1} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'sourceOwnerCampaignInfo'?: Campaign2AllOfSourceOwnerCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfSearchCampaignInfoV1} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'searchCampaignInfo'?: Campaign2AllOfSearchCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfRoleCompositionCampaignInfoV1} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'roleCompositionCampaignInfo'?: Campaign2AllOfRoleCompositionCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfMachineAccountCampaignInfoV1} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'machineAccountCampaignInfo'?: Campaign2AllOfMachineAccountCampaignInfoV1 | null; + /** + * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + * @type {Array} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'sourcesWithOrphanEntitlements'?: Array | null; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof GetActiveCampaignsV1200ResponseInnerV1 + */ + 'mandatoryCommentRequirement'?: GetActiveCampaignsV1200ResponseInnerV1MandatoryCommentRequirementV1; +} + +export const GetActiveCampaignsV1200ResponseInnerV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type GetActiveCampaignsV1200ResponseInnerV1TypeV1 = typeof GetActiveCampaignsV1200ResponseInnerV1TypeV1[keyof typeof GetActiveCampaignsV1200ResponseInnerV1TypeV1]; +export const GetActiveCampaignsV1200ResponseInnerV1StatusV1 = { + Pending: 'PENDING', + Staged: 'STAGED', + Canceling: 'CANCELING', + Activating: 'ACTIVATING', + Active: 'ACTIVE', + Completing: 'COMPLETING', + Completed: 'COMPLETED', + Error: 'ERROR', + Archived: 'ARCHIVED' +} as const; + +export type GetActiveCampaignsV1200ResponseInnerV1StatusV1 = typeof GetActiveCampaignsV1200ResponseInnerV1StatusV1[keyof typeof GetActiveCampaignsV1200ResponseInnerV1StatusV1]; +export const GetActiveCampaignsV1200ResponseInnerV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type GetActiveCampaignsV1200ResponseInnerV1CorrelatedStatusV1 = typeof GetActiveCampaignsV1200ResponseInnerV1CorrelatedStatusV1[keyof typeof GetActiveCampaignsV1200ResponseInnerV1CorrelatedStatusV1]; +export const GetActiveCampaignsV1200ResponseInnerV1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type GetActiveCampaignsV1200ResponseInnerV1MandatoryCommentRequirementV1 = typeof GetActiveCampaignsV1200ResponseInnerV1MandatoryCommentRequirementV1[keyof typeof GetActiveCampaignsV1200ResponseInnerV1MandatoryCommentRequirementV1]; + +/** + * + * @export + * @interface GetActiveCampaignsV1401ResponseV1 + */ +export interface GetActiveCampaignsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetActiveCampaignsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetActiveCampaignsV1429ResponseV1 + */ +export interface GetActiveCampaignsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetActiveCampaignsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface GetCampaignV1200ResponseV1 + */ +export interface GetCampaignV1200ResponseV1 { + /** + * Id of the campaign + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'id'?: string | null; + /** + * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'name': string; + /** + * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'description': string | null; + /** + * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'deadline'?: string | null; + /** + * The type of campaign. Could be extended in the future. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'type': GetCampaignV1200ResponseV1TypeV1; + /** + * Enables email notification for this campaign + * @type {boolean} + * @memberof GetCampaignV1200ResponseV1 + */ + 'emailNotificationEnabled'?: boolean; + /** + * Allows auto revoke for this campaign + * @type {boolean} + * @memberof GetCampaignV1200ResponseV1 + */ + 'autoRevokeAllowed'?: boolean; + /** + * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. + * @type {boolean} + * @memberof GetCampaignV1200ResponseV1 + */ + 'recommendationsEnabled'?: boolean; + /** + * The campaign\'s current status. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'status'?: GetCampaignV1200ResponseV1StatusV1 | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'correlatedStatus'?: GetCampaignV1200ResponseV1CorrelatedStatusV1; + /** + * Created time of the campaign + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'created'?: string | null; + /** + * The total number of certifications in this campaign. + * @type {number} + * @memberof GetCampaignV1200ResponseV1 + */ + 'totalCertifications'?: number | null; + /** + * The number of completed certifications in this campaign. + * @type {number} + * @memberof GetCampaignV1200ResponseV1 + */ + 'completedCertifications'?: number | null; + /** + * A list of errors and warnings that have accumulated. + * @type {Array} + * @memberof GetCampaignV1200ResponseV1 + */ + 'alerts'?: Array | null; + /** + * Modified time of the campaign + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'modified'?: string | null; + /** + * + * @type {Campaign2AllOfFilterV1} + * @memberof GetCampaignV1200ResponseV1 + */ + 'filter'?: Campaign2AllOfFilterV1 | null; + /** + * Determines if comments on sunset date changes are required. + * @type {boolean} + * @memberof GetCampaignV1200ResponseV1 + */ + 'sunsetCommentsRequired'?: boolean; + /** + * + * @type {Campaign2AllOfSourceOwnerCampaignInfoV1} + * @memberof GetCampaignV1200ResponseV1 + */ + 'sourceOwnerCampaignInfo'?: Campaign2AllOfSourceOwnerCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfSearchCampaignInfoV1} + * @memberof GetCampaignV1200ResponseV1 + */ + 'searchCampaignInfo'?: Campaign2AllOfSearchCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfRoleCompositionCampaignInfoV1} + * @memberof GetCampaignV1200ResponseV1 + */ + 'roleCompositionCampaignInfo'?: Campaign2AllOfRoleCompositionCampaignInfoV1 | null; + /** + * + * @type {Campaign2AllOfMachineAccountCampaignInfoV1} + * @memberof GetCampaignV1200ResponseV1 + */ + 'machineAccountCampaignInfo'?: Campaign2AllOfMachineAccountCampaignInfoV1 | null; + /** + * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + * @type {Array} + * @memberof GetCampaignV1200ResponseV1 + */ + 'sourcesWithOrphanEntitlements'?: Array | null; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof GetCampaignV1200ResponseV1 + */ + 'mandatoryCommentRequirement'?: GetCampaignV1200ResponseV1MandatoryCommentRequirementV1; +} + +export const GetCampaignV1200ResponseV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type GetCampaignV1200ResponseV1TypeV1 = typeof GetCampaignV1200ResponseV1TypeV1[keyof typeof GetCampaignV1200ResponseV1TypeV1]; +export const GetCampaignV1200ResponseV1StatusV1 = { + Pending: 'PENDING', + Staged: 'STAGED', + Canceling: 'CANCELING', + Activating: 'ACTIVATING', + Active: 'ACTIVE', + Completing: 'COMPLETING', + Completed: 'COMPLETED', + Error: 'ERROR', + Archived: 'ARCHIVED' +} as const; + +export type GetCampaignV1200ResponseV1StatusV1 = typeof GetCampaignV1200ResponseV1StatusV1[keyof typeof GetCampaignV1200ResponseV1StatusV1]; +export const GetCampaignV1200ResponseV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type GetCampaignV1200ResponseV1CorrelatedStatusV1 = typeof GetCampaignV1200ResponseV1CorrelatedStatusV1[keyof typeof GetCampaignV1200ResponseV1CorrelatedStatusV1]; +export const GetCampaignV1200ResponseV1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type GetCampaignV1200ResponseV1MandatoryCommentRequirementV1 = typeof GetCampaignV1200ResponseV1MandatoryCommentRequirementV1[keyof typeof GetCampaignV1200ResponseV1MandatoryCommentRequirementV1]; + +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ReassignmenttraildtoV1 + */ +export interface ReassignmenttraildtoV1 { + /** + * The ID of previous owner identity. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'previousOwner'?: string; + /** + * The ID of new owner identity. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'newOwner'?: string; + /** + * The type of reassignment. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'reassignmentType'?: string; +} +/** + * + * @export + * @interface ReportresultreferenceV1 + */ +export interface ReportresultreferenceV1 { + /** + * SOD policy violation report result DTO type. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'type'?: ReportresultreferenceV1TypeV1; + /** + * SOD policy violation report result ID. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'id'?: string; + /** + * Human-readable name of the SOD policy violation report result. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'name'?: string; + /** + * Status of a SOD policy violation report. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'status'?: ReportresultreferenceV1StatusV1; +} + +export const ReportresultreferenceV1TypeV1 = { + ReportResult: 'REPORT_RESULT' +} as const; + +export type ReportresultreferenceV1TypeV1 = typeof ReportresultreferenceV1TypeV1[keyof typeof ReportresultreferenceV1TypeV1]; +export const ReportresultreferenceV1StatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR', + Pending: 'PENDING' +} as const; + +export type ReportresultreferenceV1StatusV1 = typeof ReportresultreferenceV1StatusV1[keyof typeof ReportresultreferenceV1StatusV1]; + +/** + * type of a Report + * @export + * @enum {string} + */ + +export const ReporttypeV1 = { + CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', + CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', + CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', + CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' +} as const; + +export type ReporttypeV1 = typeof ReporttypeV1[keyof typeof ReporttypeV1]; + + +/** + * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" + * @export + * @interface Schedule2DaysV1 + */ +export interface Schedule2DaysV1 { + /** + * Enum type to specify days value + * @type {string} + * @memberof Schedule2DaysV1 + */ + 'type': Schedule2DaysV1TypeV1; + /** + * Values of the days based on the enum type mentioned above + * @type {Array} + * @memberof Schedule2DaysV1 + */ + 'values': Array; + /** + * Interval between the cert generations + * @type {number} + * @memberof Schedule2DaysV1 + */ + 'interval'?: number | null; +} + +export const Schedule2DaysV1TypeV1 = { + List: 'LIST', + Range: 'RANGE' +} as const; + +export type Schedule2DaysV1TypeV1 = typeof Schedule2DaysV1TypeV1[keyof typeof Schedule2DaysV1TypeV1]; + +/** + * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" + * @export + * @interface Schedule2HoursV1 + */ +export interface Schedule2HoursV1 { + /** + * Enum type to specify hours value + * @type {string} + * @memberof Schedule2HoursV1 + */ + 'type': Schedule2HoursV1TypeV1; + /** + * Values of the days based on the enum type mentioned above + * @type {Array} + * @memberof Schedule2HoursV1 + */ + 'values': Array; + /** + * Interval between the cert generations + * @type {number} + * @memberof Schedule2HoursV1 + */ + 'interval'?: number | null; +} + +export const Schedule2HoursV1TypeV1 = { + List: 'LIST', + Range: 'RANGE' +} as const; + +export type Schedule2HoursV1TypeV1 = typeof Schedule2HoursV1TypeV1[keyof typeof Schedule2HoursV1TypeV1]; + +/** + * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 + * @export + * @interface Schedule2MonthsV1 + */ +export interface Schedule2MonthsV1 { + /** + * Enum type to specify months value + * @type {string} + * @memberof Schedule2MonthsV1 + */ + 'type': Schedule2MonthsV1TypeV1; + /** + * Values of the months based on the enum type mentioned above + * @type {Array} + * @memberof Schedule2MonthsV1 + */ + 'values': Array; + /** + * Interval between the cert generations + * @type {number} + * @memberof Schedule2MonthsV1 + */ + 'interval'?: number; +} + +export const Schedule2MonthsV1TypeV1 = { + List: 'LIST', + Range: 'RANGE' +} as const; + +export type Schedule2MonthsV1TypeV1 = typeof Schedule2MonthsV1TypeV1[keyof typeof Schedule2MonthsV1TypeV1]; + +/** + * + * @export + * @interface Schedule2V1 + */ +export interface Schedule2V1 { + /** + * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. + * @type {string} + * @memberof Schedule2V1 + */ + 'type': Schedule2V1TypeV1; + /** + * + * @type {Schedule2MonthsV1} + * @memberof Schedule2V1 + */ + 'months'?: Schedule2MonthsV1 | null; + /** + * + * @type {Schedule2DaysV1} + * @memberof Schedule2V1 + */ + 'days'?: Schedule2DaysV1; + /** + * + * @type {Schedule2HoursV1} + * @memberof Schedule2V1 + */ + 'hours': Schedule2HoursV1; + /** + * Specifies the time after which this schedule will no longer occur. + * @type {string} + * @memberof Schedule2V1 + */ + 'expiration'?: string | null; + /** + * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. + * @type {string} + * @memberof Schedule2V1 + */ + 'timeZoneId'?: string; +} + +export const Schedule2V1TypeV1 = { + Weekly: 'WEEKLY', + Monthly: 'MONTHLY', + Annually: 'ANNUALLY', + Calendar: 'CALENDAR' +} as const; + +export type Schedule2V1TypeV1 = typeof Schedule2V1TypeV1[keyof typeof Schedule2V1TypeV1]; + +/** + * + * @export + * @interface SlimcampaignV1 + */ +export interface SlimcampaignV1 { + /** + * Id of the campaign + * @type {string} + * @memberof SlimcampaignV1 + */ + 'id'?: string | null; + /** + * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof SlimcampaignV1 + */ + 'name': string; + /** + * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. + * @type {string} + * @memberof SlimcampaignV1 + */ + 'description': string | null; + /** + * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. + * @type {string} + * @memberof SlimcampaignV1 + */ + 'deadline'?: string | null; + /** + * The type of campaign. Could be extended in the future. + * @type {string} + * @memberof SlimcampaignV1 + */ + 'type': SlimcampaignV1TypeV1; + /** + * Enables email notification for this campaign + * @type {boolean} + * @memberof SlimcampaignV1 + */ + 'emailNotificationEnabled'?: boolean; + /** + * Allows auto revoke for this campaign + * @type {boolean} + * @memberof SlimcampaignV1 + */ + 'autoRevokeAllowed'?: boolean; + /** + * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. + * @type {boolean} + * @memberof SlimcampaignV1 + */ + 'recommendationsEnabled'?: boolean; + /** + * The campaign\'s current status. + * @type {string} + * @memberof SlimcampaignV1 + */ + 'status'?: SlimcampaignV1StatusV1 | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof SlimcampaignV1 + */ + 'correlatedStatus'?: SlimcampaignV1CorrelatedStatusV1; + /** + * Created time of the campaign + * @type {string} + * @memberof SlimcampaignV1 + */ + 'created'?: string | null; + /** + * The total number of certifications in this campaign. + * @type {number} + * @memberof SlimcampaignV1 + */ + 'totalCertifications'?: number | null; + /** + * The number of completed certifications in this campaign. + * @type {number} + * @memberof SlimcampaignV1 + */ + 'completedCertifications'?: number | null; + /** + * A list of errors and warnings that have accumulated. + * @type {Array} + * @memberof SlimcampaignV1 + */ + 'alerts'?: Array | null; +} + +export const SlimcampaignV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type SlimcampaignV1TypeV1 = typeof SlimcampaignV1TypeV1[keyof typeof SlimcampaignV1TypeV1]; +export const SlimcampaignV1StatusV1 = { + Pending: 'PENDING', + Staged: 'STAGED', + Canceling: 'CANCELING', + Activating: 'ACTIVATING', + Active: 'ACTIVE', + Completing: 'COMPLETING', + Completed: 'COMPLETED', + Error: 'ERROR', + Archived: 'ARCHIVED' +} as const; + +export type SlimcampaignV1StatusV1 = typeof SlimcampaignV1StatusV1[keyof typeof SlimcampaignV1StatusV1]; +export const SlimcampaignV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type SlimcampaignV1CorrelatedStatusV1 = typeof SlimcampaignV1CorrelatedStatusV1[keyof typeof SlimcampaignV1CorrelatedStatusV1]; + +/** + * SOD policy violation report result. + * @export + * @interface SodreportresultdtoV1 + */ +export interface SodreportresultdtoV1 { + /** + * SOD policy violation report result DTO type. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'type'?: SodreportresultdtoV1TypeV1; + /** + * SOD policy violation report result ID. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'id'?: string; + /** + * Human-readable name of the SOD policy violation report result. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'name'?: string; +} + +export const SodreportresultdtoV1TypeV1 = { + ReportResult: 'REPORT_RESULT' +} as const; + +export type SodreportresultdtoV1TypeV1 = typeof SodreportresultdtoV1TypeV1[keyof typeof SodreportresultdtoV1TypeV1]; + + +/** + * CertificationCampaignsV1Api - axios parameter creator + * @export + */ +export const CertificationCampaignsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. + * @summary Complete a campaign + * @param {string} id Campaign ID. + * @param {CampaigncompleteoptionsV1} [campaigncompleteoptionsV1] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeCampaignV1: async (id: string, campaigncompleteoptionsV1?: CampaigncompleteoptionsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('completeCampaignV1', 'id', id) + const localVarPath = `/campaigns/v1/{id}/complete` + .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: '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(campaigncompleteoptionsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to create a certification campaign template based on campaign. + * @summary Create a campaign template + * @param {CampaigntemplateV1} campaigntemplateV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignTemplateV1: async (campaigntemplateV1: CampaigntemplateV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'campaigntemplateV1' is not null or undefined + assertParamExists('createCampaignTemplateV1', 'campaigntemplateV1', campaigntemplateV1) + const localVarPath = `/campaign-templates/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(campaigntemplateV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to create a certification campaign with the information provided in the request body. + * @summary Create a campaign + * @param {Campaign2V1} campaign2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignV1: async (campaign2V1: Campaign2V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'campaign2V1' is not null or undefined + assertParamExists('createCampaignV1', 'campaign2V1', campaign2V1) + const localVarPath = `/campaigns/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(campaign2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Delete campaign template schedule + * @param {string} id ID of the campaign template whose schedule is being deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignTemplateScheduleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteCampaignTemplateScheduleV1', 'id', id) + const localVarPath = `/campaign-templates/v1/{id}/schedule` + .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, + }; + }, + /** + * Use this API to delete a certification campaign template by ID. + * @summary Delete a campaign template + * @param {string} id ID of the campaign template being deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteCampaignTemplateV1', 'id', id) + const localVarPath = `/campaign-templates/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, + }; + }, + /** + * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + * @summary Delete campaigns + * @param {CampaignsdeleterequestV1} campaignsdeleterequestV1 IDs of the campaigns to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignsV1: async (campaignsdeleterequestV1: CampaignsdeleterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'campaignsdeleterequestV1' is not null or undefined + assertParamExists('deleteCampaignsV1', 'campaignsdeleterequestV1', campaignsdeleterequestV1) + const localVarPath = `/campaigns/v1/delete`; + // 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(campaignsdeleterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + * @summary List campaigns + * @param {GetActiveCampaignsV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **status**: *eq, in* + * @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: **name, created** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getActiveCampaignsV1: async (detail?: GetActiveCampaignsV1DetailV1, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/campaigns/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 (detail !== undefined) { + localVarQueryParameter['detail'] = detail; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + * @summary Get campaign reports configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignReportsConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/campaigns/v1/reports-configuration`; + // 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, + }; + }, + /** + * Use this API to fetch all reports for a certification campaign by campaign ID. + * @summary Get campaign reports + * @param {string} id ID of the campaign whose reports are being fetched. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignReportsV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCampaignReportsV1', 'id', id) + const localVarPath = `/campaigns/v1/{id}/reports` + .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, + }; + }, + /** + * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Get campaign template schedule + * @param {string} id ID of the campaign template whose schedule is being fetched. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplateScheduleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCampaignTemplateScheduleV1', 'id', id) + const localVarPath = `/campaign-templates/v1/{id}/schedule` + .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, + }; + }, + /** + * Use this API to fetch a certification campaign template by ID. + * @summary Get a campaign template + * @param {string} id Requested campaign template\'s ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCampaignTemplateV1', 'id', id) + const localVarPath = `/campaign-templates/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, + }; + }, + /** + * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. + * @summary List campaign templates + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **name, created, modified** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplatesV1: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/campaign-templates/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + 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, + }; + }, + /** + * Use this API to get information for an existing certification campaign by the campaign\'s ID. + * @summary Get campaign + * @param {string} id ID of the campaign to be retrieved. + * @param {GetCampaignV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignV1: async (id: string, detail?: GetCampaignV1DetailV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCampaignV1', 'id', id) + const localVarPath = `/campaigns/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; + + if (detail !== undefined) { + localVarQueryParameter['detail'] = detail; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API reassigns the specified certifications from one identity to another. + * @summary Reassign certifications + * @param {string} id The certification campaign ID + * @param {AdminreviewreassignV1} adminreviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + moveV1: async (id: string, adminreviewreassignV1: AdminreviewreassignV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('moveV1', 'id', id) + // verify required parameter 'adminreviewreassignV1' is not null or undefined + assertParamExists('moveV1', 'adminreviewreassignV1', adminreviewreassignV1) + const localVarPath = `/campaigns/v1/{id}/reassign` + .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: '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(adminreviewreassignV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign template + * @param {string} id ID of the campaign template being modified. + * @param {Array} jsonpatchoperationV1 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchCampaignTemplateV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchCampaignTemplateV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchCampaignTemplateV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/campaign-templates/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to overwrite the configuration for campaign reports. + * @summary Set campaign reports configuration + * @param {CampaignreportsconfigV1} campaignreportsconfigV1 Campaign report configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setCampaignReportsConfigV1: async (campaignreportsconfigV1: CampaignreportsconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'campaignreportsconfigV1' is not null or undefined + assertParamExists('setCampaignReportsConfigV1', 'campaignreportsconfigV1', campaignreportsconfigV1) + const localVarPath = `/campaigns/v1/reports-configuration`; + // 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: 'PUT', ...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(campaignreportsconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + * @summary Set campaign template schedule + * @param {string} id ID of the campaign template being scheduled. + * @param {Schedule2V1} [schedule2V1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setCampaignTemplateScheduleV1: async (id: string, schedule2V1?: Schedule2V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('setCampaignTemplateScheduleV1', 'id', id) + const localVarPath = `/campaign-templates/v1/{id}/schedule` + .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: 'PUT', ...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(schedule2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to run a remediation scan task for a certification campaign. + * @summary Run campaign remediation scan + * @param {string} id ID of the campaign the remediation scan is being run for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignRemediationScanV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startCampaignRemediationScanV1', 'id', id) + const localVarPath = `/campaigns/v1/{id}/run-remediation-scan` + .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: 'POST', ...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, + }; + }, + /** + * Use this API to run a report for a certification campaign. + * @summary Run campaign report + * @param {string} id ID of the campaign the report is being run for. + * @param {ReporttypeV1} type Type of the report to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignReportV1: async (id: string, type: ReporttypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startCampaignReportV1', 'id', id) + // verify required parameter 'type' is not null or undefined + assertParamExists('startCampaignReportV1', 'type', type) + const localVarPath = `/campaigns/v1/{id}/run-report/{type}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"type"}}`, encodeURIComponent(String(type))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + * @summary Activate a campaign + * @param {string} id Campaign ID. + * @param {ActivatecampaignoptionsV1} [activatecampaignoptionsV1] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignV1: async (id: string, activatecampaignoptionsV1?: ActivatecampaignoptionsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startCampaignV1', 'id', id) + const localVarPath = `/campaigns/v1/{id}/activate` + .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: '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(activatecampaignoptionsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + * @summary Generate a campaign from template + * @param {string} id ID of the campaign template to use for generation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startGenerateCampaignTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startGenerateCampaignTemplateV1', 'id', id) + const localVarPath = `/campaign-templates/v1/{id}/generate` + .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: 'POST', ...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, + }; + }, + /** + * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign + * @param {string} id ID of the campaign template being modified. + * @param {Array} jsonpatchoperationV1 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCampaignV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateCampaignV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateCampaignV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/campaigns/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CertificationCampaignsV1Api - functional programming interface + * @export + */ +export const CertificationCampaignsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CertificationCampaignsV1ApiAxiosParamCreator(configuration) + return { + /** + * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. + * @summary Complete a campaign + * @param {string} id Campaign ID. + * @param {CampaigncompleteoptionsV1} [campaigncompleteoptionsV1] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async completeCampaignV1(id: string, campaigncompleteoptionsV1?: CampaigncompleteoptionsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaignV1(id, campaigncompleteoptionsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.completeCampaignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to create a certification campaign template based on campaign. + * @summary Create a campaign template + * @param {CampaigntemplateV1} campaigntemplateV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCampaignTemplateV1(campaigntemplateV1: CampaigntemplateV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplateV1(campaigntemplateV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.createCampaignTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to create a certification campaign with the information provided in the request body. + * @summary Create a campaign + * @param {Campaign2V1} campaign2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCampaignV1(campaign2V1: Campaign2V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignV1(campaign2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.createCampaignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Delete campaign template schedule + * @param {string} id ID of the campaign template whose schedule is being deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCampaignTemplateScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.deleteCampaignTemplateScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete a certification campaign template by ID. + * @summary Delete a campaign template + * @param {string} id ID of the campaign template being deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCampaignTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.deleteCampaignTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + * @summary Delete campaigns + * @param {CampaignsdeleterequestV1} campaignsdeleterequestV1 IDs of the campaigns to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCampaignsV1(campaignsdeleterequestV1: CampaignsdeleterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignsV1(campaignsdeleterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.deleteCampaignsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + * @summary List campaigns + * @param {GetActiveCampaignsV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **status**: *eq, in* + * @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: **name, created** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getActiveCampaignsV1(detail?: GetActiveCampaignsV1DetailV1, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaignsV1(detail, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getActiveCampaignsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + * @summary Get campaign reports configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignReportsConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignReportsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to fetch all reports for a certification campaign by campaign ID. + * @summary Get campaign reports + * @param {string} id ID of the campaign whose reports are being fetched. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignReportsV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignReportsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Get campaign template schedule + * @param {string} id ID of the campaign template whose schedule is being fetched. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignTemplateScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignTemplateScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to fetch a certification campaign template by ID. + * @summary Get a campaign template + * @param {string} id Requested campaign template\'s ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. + * @summary List campaign templates + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **name, created, modified** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignTemplatesV1(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplatesV1(limit, offset, count, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignTemplatesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get information for an existing certification campaign by the campaign\'s ID. + * @summary Get campaign + * @param {string} id ID of the campaign to be retrieved. + * @param {GetCampaignV1DetailV1} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCampaignV1(id: string, detail?: GetCampaignV1DetailV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignV1(id, detail, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.getCampaignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API reassigns the specified certifications from one identity to another. + * @summary Reassign certifications + * @param {string} id The certification campaign ID + * @param {AdminreviewreassignV1} adminreviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async moveV1(id: string, adminreviewreassignV1: AdminreviewreassignV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.moveV1(id, adminreviewreassignV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.moveV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign template + * @param {string} id ID of the campaign template being modified. + * @param {Array} jsonpatchoperationV1 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchCampaignTemplateV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplateV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.patchCampaignTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to overwrite the configuration for campaign reports. + * @summary Set campaign reports configuration + * @param {CampaignreportsconfigV1} campaignreportsconfigV1 Campaign report configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setCampaignReportsConfigV1(campaignreportsconfigV1: CampaignreportsconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfigV1(campaignreportsconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.setCampaignReportsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + * @summary Set campaign template schedule + * @param {string} id ID of the campaign template being scheduled. + * @param {Schedule2V1} [schedule2V1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setCampaignTemplateScheduleV1(id: string, schedule2V1?: Schedule2V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateScheduleV1(id, schedule2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.setCampaignTemplateScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to run a remediation scan task for a certification campaign. + * @summary Run campaign remediation scan + * @param {string} id ID of the campaign the remediation scan is being run for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startCampaignRemediationScanV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScanV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.startCampaignRemediationScanV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to run a report for a certification campaign. + * @summary Run campaign report + * @param {string} id ID of the campaign the report is being run for. + * @param {ReporttypeV1} type Type of the report to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startCampaignReportV1(id: string, type: ReporttypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReportV1(id, type, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.startCampaignReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + * @summary Activate a campaign + * @param {string} id Campaign ID. + * @param {ActivatecampaignoptionsV1} [activatecampaignoptionsV1] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startCampaignV1(id: string, activatecampaignoptionsV1?: ActivatecampaignoptionsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignV1(id, activatecampaignoptionsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.startCampaignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + * @summary Generate a campaign from template + * @param {string} id ID of the campaign template to use for generation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startGenerateCampaignTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.startGenerateCampaignTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign + * @param {string} id ID of the campaign template being modified. + * @param {Array} jsonpatchoperationV1 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateCampaignV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV1Api.updateCampaignV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CertificationCampaignsV1Api - factory interface + * @export + */ +export const CertificationCampaignsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CertificationCampaignsV1ApiFp(configuration) + return { + /** + * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. + * @summary Complete a campaign + * @param {CertificationCampaignsV1ApiCompleteCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeCampaignV1(requestParameters: CertificationCampaignsV1ApiCompleteCampaignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.completeCampaignV1(requestParameters.id, requestParameters.campaigncompleteoptionsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to create a certification campaign template based on campaign. + * @summary Create a campaign template + * @param {CertificationCampaignsV1ApiCreateCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiCreateCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCampaignTemplateV1(requestParameters.campaigntemplateV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to create a certification campaign with the information provided in the request body. + * @summary Create a campaign + * @param {CertificationCampaignsV1ApiCreateCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCampaignV1(requestParameters: CertificationCampaignsV1ApiCreateCampaignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCampaignV1(requestParameters.campaign2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Delete campaign template schedule + * @param {CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCampaignTemplateScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete a certification campaign template by ID. + * @summary Delete a campaign template + * @param {CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + * @summary Delete campaigns + * @param {CertificationCampaignsV1ApiDeleteCampaignsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCampaignsV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCampaignsV1(requestParameters.campaignsdeleterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + * @summary List campaigns + * @param {CertificationCampaignsV1ApiGetActiveCampaignsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getActiveCampaignsV1(requestParameters: CertificationCampaignsV1ApiGetActiveCampaignsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getActiveCampaignsV1(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + * @summary Get campaign reports configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignReportsConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCampaignReportsConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to fetch all reports for a certification campaign by campaign ID. + * @summary Get campaign reports + * @param {CertificationCampaignsV1ApiGetCampaignReportsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignReportsV1(requestParameters: CertificationCampaignsV1ApiGetCampaignReportsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getCampaignReportsV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Get campaign template schedule + * @param {CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCampaignTemplateScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to fetch a certification campaign template by ID. + * @summary Get a campaign template + * @param {CertificationCampaignsV1ApiGetCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. + * @summary List campaign templates + * @param {CertificationCampaignsV1ApiGetCampaignTemplatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignTemplatesV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getCampaignTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get information for an existing certification campaign by the campaign\'s ID. + * @summary Get campaign + * @param {CertificationCampaignsV1ApiGetCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCampaignV1(requestParameters: CertificationCampaignsV1ApiGetCampaignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCampaignV1(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API reassigns the specified certifications from one identity to another. + * @summary Reassign certifications + * @param {CertificationCampaignsV1ApiMoveV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + moveV1(requestParameters: CertificationCampaignsV1ApiMoveV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.moveV1(requestParameters.id, requestParameters.adminreviewreassignV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign template + * @param {CertificationCampaignsV1ApiPatchCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiPatchCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchCampaignTemplateV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to overwrite the configuration for campaign reports. + * @summary Set campaign reports configuration + * @param {CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setCampaignReportsConfigV1(requestParameters: CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setCampaignReportsConfigV1(requestParameters.campaignreportsconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + * @summary Set campaign template schedule + * @param {CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setCampaignTemplateScheduleV1(requestParameters.id, requestParameters.schedule2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to run a remediation scan task for a certification campaign. + * @summary Run campaign remediation scan + * @param {CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignRemediationScanV1(requestParameters: CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startCampaignRemediationScanV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to run a report for a certification campaign. + * @summary Run campaign report + * @param {CertificationCampaignsV1ApiStartCampaignReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignReportV1(requestParameters: CertificationCampaignsV1ApiStartCampaignReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startCampaignReportV1(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + * @summary Activate a campaign + * @param {CertificationCampaignsV1ApiStartCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startCampaignV1(requestParameters: CertificationCampaignsV1ApiStartCampaignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startCampaignV1(requestParameters.id, requestParameters.activatecampaignoptionsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + * @summary Generate a campaign from template + * @param {CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startGenerateCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startGenerateCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign + * @param {CertificationCampaignsV1ApiUpdateCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCampaignV1(requestParameters: CertificationCampaignsV1ApiUpdateCampaignV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateCampaignV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for completeCampaignV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiCompleteCampaignV1Request + */ +export interface CertificationCampaignsV1ApiCompleteCampaignV1Request { + /** + * Campaign ID. + * @type {string} + * @memberof CertificationCampaignsV1ApiCompleteCampaignV1 + */ + readonly id: string + + /** + * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + * @type {CampaigncompleteoptionsV1} + * @memberof CertificationCampaignsV1ApiCompleteCampaignV1 + */ + readonly campaigncompleteoptionsV1?: CampaigncompleteoptionsV1 +} + +/** + * Request parameters for createCampaignTemplateV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiCreateCampaignTemplateV1Request + */ +export interface CertificationCampaignsV1ApiCreateCampaignTemplateV1Request { + /** + * + * @type {CampaigntemplateV1} + * @memberof CertificationCampaignsV1ApiCreateCampaignTemplateV1 + */ + readonly campaigntemplateV1: CampaigntemplateV1 +} + +/** + * Request parameters for createCampaignV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiCreateCampaignV1Request + */ +export interface CertificationCampaignsV1ApiCreateCampaignV1Request { + /** + * + * @type {Campaign2V1} + * @memberof CertificationCampaignsV1ApiCreateCampaignV1 + */ + readonly campaign2V1: Campaign2V1 +} + +/** + * Request parameters for deleteCampaignTemplateScheduleV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request + */ +export interface CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request { + /** + * ID of the campaign template whose schedule is being deleted. + * @type {string} + * @memberof CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteCampaignTemplateV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request + */ +export interface CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request { + /** + * ID of the campaign template being deleted. + * @type {string} + * @memberof CertificationCampaignsV1ApiDeleteCampaignTemplateV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteCampaignsV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiDeleteCampaignsV1Request + */ +export interface CertificationCampaignsV1ApiDeleteCampaignsV1Request { + /** + * IDs of the campaigns to delete. + * @type {CampaignsdeleterequestV1} + * @memberof CertificationCampaignsV1ApiDeleteCampaignsV1 + */ + readonly campaignsdeleterequestV1: CampaignsdeleterequestV1 +} + +/** + * Request parameters for getActiveCampaignsV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetActiveCampaignsV1Request + */ +export interface CertificationCampaignsV1ApiGetActiveCampaignsV1Request { + /** + * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @type {'SLIM' | 'FULL'} + * @memberof CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + readonly detail?: GetActiveCampaignsV1DetailV1 + + /** + * 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 CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + 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, in* **name**: *eq, sw* **status**: *eq, in* + * @type {string} + * @memberof CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + 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: **name, created** + * @type {string} + * @memberof CertificationCampaignsV1ApiGetActiveCampaignsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getCampaignReportsV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetCampaignReportsV1Request + */ +export interface CertificationCampaignsV1ApiGetCampaignReportsV1Request { + /** + * ID of the campaign whose reports are being fetched. + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignReportsV1 + */ + readonly id: string +} + +/** + * Request parameters for getCampaignTemplateScheduleV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request + */ +export interface CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request { + /** + * ID of the campaign template whose schedule is being fetched. + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1 + */ + readonly id: string +} + +/** + * Request parameters for getCampaignTemplateV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetCampaignTemplateV1Request + */ +export interface CertificationCampaignsV1ApiGetCampaignTemplateV1Request { + /** + * Requested campaign template\'s ID. + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplateV1 + */ + readonly id: string +} + +/** + * Request parameters for getCampaignTemplatesV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetCampaignTemplatesV1Request + */ +export interface CertificationCampaignsV1ApiGetCampaignTemplatesV1Request { + /** + * 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 CertificationCampaignsV1ApiGetCampaignTemplatesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplatesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplatesV1 + */ + readonly count?: boolean + + /** + * 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: **name, created, modified** + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplatesV1 + */ + readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignTemplatesV1 + */ + readonly filters?: string +} + +/** + * Request parameters for getCampaignV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiGetCampaignV1Request + */ +export interface CertificationCampaignsV1ApiGetCampaignV1Request { + /** + * ID of the campaign to be retrieved. + * @type {string} + * @memberof CertificationCampaignsV1ApiGetCampaignV1 + */ + readonly id: string + + /** + * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + * @type {'SLIM' | 'FULL'} + * @memberof CertificationCampaignsV1ApiGetCampaignV1 + */ + readonly detail?: GetCampaignV1DetailV1 +} + +/** + * Request parameters for moveV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiMoveV1Request + */ +export interface CertificationCampaignsV1ApiMoveV1Request { + /** + * The certification campaign ID + * @type {string} + * @memberof CertificationCampaignsV1ApiMoveV1 + */ + readonly id: string + + /** + * + * @type {AdminreviewreassignV1} + * @memberof CertificationCampaignsV1ApiMoveV1 + */ + readonly adminreviewreassignV1: AdminreviewreassignV1 +} + +/** + * Request parameters for patchCampaignTemplateV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiPatchCampaignTemplateV1Request + */ +export interface CertificationCampaignsV1ApiPatchCampaignTemplateV1Request { + /** + * ID of the campaign template being modified. + * @type {string} + * @memberof CertificationCampaignsV1ApiPatchCampaignTemplateV1 + */ + readonly id: string + + /** + * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + * @type {Array} + * @memberof CertificationCampaignsV1ApiPatchCampaignTemplateV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for setCampaignReportsConfigV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request + */ +export interface CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request { + /** + * Campaign report configuration. + * @type {CampaignreportsconfigV1} + * @memberof CertificationCampaignsV1ApiSetCampaignReportsConfigV1 + */ + readonly campaignreportsconfigV1: CampaignreportsconfigV1 +} + +/** + * Request parameters for setCampaignTemplateScheduleV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request + */ +export interface CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request { + /** + * ID of the campaign template being scheduled. + * @type {string} + * @memberof CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1 + */ + readonly id: string + + /** + * + * @type {Schedule2V1} + * @memberof CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1 + */ + readonly schedule2V1?: Schedule2V1 +} + +/** + * Request parameters for startCampaignRemediationScanV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request + */ +export interface CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request { + /** + * ID of the campaign the remediation scan is being run for. + * @type {string} + * @memberof CertificationCampaignsV1ApiStartCampaignRemediationScanV1 + */ + readonly id: string +} + +/** + * Request parameters for startCampaignReportV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiStartCampaignReportV1Request + */ +export interface CertificationCampaignsV1ApiStartCampaignReportV1Request { + /** + * ID of the campaign the report is being run for. + * @type {string} + * @memberof CertificationCampaignsV1ApiStartCampaignReportV1 + */ + readonly id: string + + /** + * Type of the report to run. + * @type {ReporttypeV1} + * @memberof CertificationCampaignsV1ApiStartCampaignReportV1 + */ + readonly type: ReporttypeV1 +} + +/** + * Request parameters for startCampaignV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiStartCampaignV1Request + */ +export interface CertificationCampaignsV1ApiStartCampaignV1Request { + /** + * Campaign ID. + * @type {string} + * @memberof CertificationCampaignsV1ApiStartCampaignV1 + */ + readonly id: string + + /** + * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + * @type {ActivatecampaignoptionsV1} + * @memberof CertificationCampaignsV1ApiStartCampaignV1 + */ + readonly activatecampaignoptionsV1?: ActivatecampaignoptionsV1 +} + +/** + * Request parameters for startGenerateCampaignTemplateV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request + */ +export interface CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request { + /** + * ID of the campaign template to use for generation. + * @type {string} + * @memberof CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1 + */ + readonly id: string +} + +/** + * Request parameters for updateCampaignV1 operation in CertificationCampaignsV1Api. + * @export + * @interface CertificationCampaignsV1ApiUpdateCampaignV1Request + */ +export interface CertificationCampaignsV1ApiUpdateCampaignV1Request { + /** + * ID of the campaign template being modified. + * @type {string} + * @memberof CertificationCampaignsV1ApiUpdateCampaignV1 + */ + readonly id: string + + /** + * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + * @type {Array} + * @memberof CertificationCampaignsV1ApiUpdateCampaignV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * CertificationCampaignsV1Api - object-oriented interface + * @export + * @class CertificationCampaignsV1Api + * @extends {BaseAPI} + */ +export class CertificationCampaignsV1Api extends BaseAPI { + /** + * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. + * @summary Complete a campaign + * @param {CertificationCampaignsV1ApiCompleteCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public completeCampaignV1(requestParameters: CertificationCampaignsV1ApiCompleteCampaignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).completeCampaignV1(requestParameters.id, requestParameters.campaigncompleteoptionsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to create a certification campaign template based on campaign. + * @summary Create a campaign template + * @param {CertificationCampaignsV1ApiCreateCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public createCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiCreateCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).createCampaignTemplateV1(requestParameters.campaigntemplateV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to create a certification campaign with the information provided in the request body. + * @summary Create a campaign + * @param {CertificationCampaignsV1ApiCreateCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public createCampaignV1(requestParameters: CertificationCampaignsV1ApiCreateCampaignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).createCampaignV1(requestParameters.campaign2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Delete campaign template schedule + * @param {CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public deleteCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).deleteCampaignTemplateScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete a certification campaign template by ID. + * @summary Delete a campaign template + * @param {CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public deleteCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).deleteCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + * @summary Delete campaigns + * @param {CertificationCampaignsV1ApiDeleteCampaignsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public deleteCampaignsV1(requestParameters: CertificationCampaignsV1ApiDeleteCampaignsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).deleteCampaignsV1(requestParameters.campaignsdeleterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + * @summary List campaigns + * @param {CertificationCampaignsV1ApiGetActiveCampaignsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getActiveCampaignsV1(requestParameters: CertificationCampaignsV1ApiGetActiveCampaignsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getActiveCampaignsV1(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + * @summary Get campaign reports configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignReportsConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignReportsConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to fetch all reports for a certification campaign by campaign ID. + * @summary Get campaign reports + * @param {CertificationCampaignsV1ApiGetCampaignReportsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignReportsV1(requestParameters: CertificationCampaignsV1ApiGetCampaignReportsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignReportsV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + * @summary Get campaign template schedule + * @param {CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignTemplateScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to fetch a certification campaign template by ID. + * @summary Get a campaign template + * @param {CertificationCampaignsV1ApiGetCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. + * @summary List campaign templates + * @param {CertificationCampaignsV1ApiGetCampaignTemplatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignTemplatesV1(requestParameters: CertificationCampaignsV1ApiGetCampaignTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get information for an existing certification campaign by the campaign\'s ID. + * @summary Get campaign + * @param {CertificationCampaignsV1ApiGetCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public getCampaignV1(requestParameters: CertificationCampaignsV1ApiGetCampaignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).getCampaignV1(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API reassigns the specified certifications from one identity to another. + * @summary Reassign certifications + * @param {CertificationCampaignsV1ApiMoveV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public moveV1(requestParameters: CertificationCampaignsV1ApiMoveV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).moveV1(requestParameters.id, requestParameters.adminreviewreassignV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign template + * @param {CertificationCampaignsV1ApiPatchCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public patchCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiPatchCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).patchCampaignTemplateV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to overwrite the configuration for campaign reports. + * @summary Set campaign reports configuration + * @param {CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public setCampaignReportsConfigV1(requestParameters: CertificationCampaignsV1ApiSetCampaignReportsConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).setCampaignReportsConfigV1(requestParameters.campaignreportsconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + * @summary Set campaign template schedule + * @param {CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public setCampaignTemplateScheduleV1(requestParameters: CertificationCampaignsV1ApiSetCampaignTemplateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).setCampaignTemplateScheduleV1(requestParameters.id, requestParameters.schedule2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to run a remediation scan task for a certification campaign. + * @summary Run campaign remediation scan + * @param {CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public startCampaignRemediationScanV1(requestParameters: CertificationCampaignsV1ApiStartCampaignRemediationScanV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).startCampaignRemediationScanV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to run a report for a certification campaign. + * @summary Run campaign report + * @param {CertificationCampaignsV1ApiStartCampaignReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public startCampaignReportV1(requestParameters: CertificationCampaignsV1ApiStartCampaignReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).startCampaignReportV1(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + * @summary Activate a campaign + * @param {CertificationCampaignsV1ApiStartCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public startCampaignV1(requestParameters: CertificationCampaignsV1ApiStartCampaignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).startCampaignV1(requestParameters.id, requestParameters.activatecampaignoptionsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + * @summary Generate a campaign from template + * @param {CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public startGenerateCampaignTemplateV1(requestParameters: CertificationCampaignsV1ApiStartGenerateCampaignTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).startGenerateCampaignTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update a campaign + * @param {CertificationCampaignsV1ApiUpdateCampaignV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationCampaignsV1Api + */ + public updateCampaignV1(requestParameters: CertificationCampaignsV1ApiUpdateCampaignV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationCampaignsV1ApiFp(this.configuration).updateCampaignV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetActiveCampaignsV1DetailV1 = { + Slim: 'SLIM', + Full: 'FULL' +} as const; +export type GetActiveCampaignsV1DetailV1 = typeof GetActiveCampaignsV1DetailV1[keyof typeof GetActiveCampaignsV1DetailV1]; +/** + * @export + */ +export const GetCampaignV1DetailV1 = { + Slim: 'SLIM', + Full: 'FULL' +} as const; +export type GetCampaignV1DetailV1 = typeof GetCampaignV1DetailV1[keyof typeof GetCampaignV1DetailV1]; + + diff --git a/sdk-output/certification_campaigns/base.ts b/sdk-output/certification_campaigns/base.ts new file mode 100644 index 00000000..16e0e76c --- /dev/null +++ b/sdk-output/certification_campaigns/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaigns + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/certification_campaigns/common.ts b/sdk-output/certification_campaigns/common.ts new file mode 100644 index 00000000..e97d523c --- /dev/null +++ b/sdk-output/certification_campaigns/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaigns + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/certification_campaigns/configuration.ts b/sdk-output/certification_campaigns/configuration.ts new file mode 100644 index 00000000..0943ca42 --- /dev/null +++ b/sdk-output/certification_campaigns/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaigns + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/certification_campaigns/git_push.sh b/sdk-output/certification_campaigns/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/certification_campaigns/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/certification_campaigns/index.ts b/sdk-output/certification_campaigns/index.ts new file mode 100644 index 00000000..7ea3e589 --- /dev/null +++ b/sdk-output/certification_campaigns/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Campaigns + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/certification_campaigns/package.json b/sdk-output/certification_campaigns/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/certification_campaigns/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/certification_campaigns/tsconfig.json b/sdk-output/certification_campaigns/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/certification_campaigns/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/certification_summaries/.gitignore b/sdk-output/certification_summaries/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/certification_summaries/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/certification_summaries/.npmignore b/sdk-output/certification_summaries/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/certification_summaries/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/certification_summaries/.openapi-generator-ignore b/sdk-output/certification_summaries/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/certification_summaries/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/certification_summaries/.openapi-generator/FILES b/sdk-output/certification_summaries/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/certification_summaries/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/certification_summaries/.openapi-generator/VERSION b/sdk-output/certification_summaries/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/certification_summaries/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/certification_summaries/.sdk-partition b/sdk-output/certification_summaries/.sdk-partition new file mode 100644 index 00000000..c0a50ed5 --- /dev/null +++ b/sdk-output/certification_summaries/.sdk-partition @@ -0,0 +1 @@ +certification-summaries \ No newline at end of file diff --git a/sdk-output/certification_summaries/README.md b/sdk-output/certification_summaries/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_summaries/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_summaries/api.ts b/sdk-output/certification_summaries/api.ts new file mode 100644 index 00000000..c97c1eb0 --- /dev/null +++ b/sdk-output/certification_summaries/api.ts @@ -0,0 +1,1394 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Summaries + * 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 AccesssummaryAccessV1 + */ +export interface AccesssummaryAccessV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccesssummaryAccessV1 + */ + 'type'?: DtotypeV1; + /** + * The ID of the item being certified + * @type {string} + * @memberof AccesssummaryAccessV1 + */ + 'id'?: string; + /** + * The name of the item being certified + * @type {string} + * @memberof AccesssummaryAccessV1 + */ + 'name'?: string; +} + + +/** + * An object holding the access that is being reviewed + * @export + * @interface AccesssummaryV1 + */ +export interface AccesssummaryV1 { + /** + * + * @type {AccesssummaryAccessV1} + * @memberof AccesssummaryV1 + */ + 'access'?: AccesssummaryAccessV1; + /** + * + * @type {ReviewableentitlementV1} + * @memberof AccesssummaryV1 + */ + 'entitlement'?: ReviewableentitlementV1 | null; + /** + * + * @type {ReviewableaccessprofileV1} + * @memberof AccesssummaryV1 + */ + 'accessProfile'?: ReviewableaccessprofileV1; + /** + * + * @type {ReviewableroleV1} + * @memberof AccesssummaryV1 + */ + 'role'?: ReviewableroleV1 | null; +} +/** + * Insights into account activity + * @export + * @interface ActivityinsightsV1 + */ +export interface ActivityinsightsV1 { + /** + * UUID of the account + * @type {string} + * @memberof ActivityinsightsV1 + */ + 'accountID'?: string; + /** + * The number of days of activity + * @type {number} + * @memberof ActivityinsightsV1 + */ + 'usageDays'?: number; + /** + * Status indicating if the activity is complete or unknown + * @type {string} + * @memberof ActivityinsightsV1 + */ + 'usageDaysState'?: ActivityinsightsV1UsageDaysStateV1; +} + +export const ActivityinsightsV1UsageDaysStateV1 = { + Complete: 'COMPLETE', + Unknown: 'UNKNOWN' +} as const; + +export type ActivityinsightsV1UsageDaysStateV1 = typeof ActivityinsightsV1UsageDaysStateV1[keyof typeof ActivityinsightsV1UsageDaysStateV1]; + +/** + * + * @export + * @interface CertificationidentitysummaryV1 + */ +export interface CertificationidentitysummaryV1 { + /** + * The ID of the identity summary + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'id'?: string; + /** + * Name of the linked identity + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'name'?: string; + /** + * The ID of the identity being certified + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'identityId'?: string; + /** + * Indicates whether the review items for the linked identity\'s certification have been completed + * @type {boolean} + * @memberof CertificationidentitysummaryV1 + */ + 'completed'?: boolean; +} +/** + * + * @export + * @interface DataaccessCategoriesInnerV1 + */ +export interface DataaccessCategoriesInnerV1 { + /** + * Value of the category + * @type {string} + * @memberof DataaccessCategoriesInnerV1 + */ + 'value'?: string; + /** + * Number of matched for each category + * @type {number} + * @memberof DataaccessCategoriesInnerV1 + */ + 'matchCount'?: number; +} +/** + * + * @export + * @interface DataaccessImpactScoreV1 + */ +export interface DataaccessImpactScoreV1 { + /** + * Impact Score for this data + * @type {string} + * @memberof DataaccessImpactScoreV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface DataaccessPoliciesInnerV1 + */ +export interface DataaccessPoliciesInnerV1 { + /** + * Value of the policy + * @type {string} + * @memberof DataaccessPoliciesInnerV1 + */ + 'value'?: string; +} +/** + * DAS data for the entitlement + * @export + * @interface DataaccessV1 + */ +export interface DataaccessV1 { + /** + * List of classification policies that apply to resources the entitlement \\ groups has access to + * @type {Array} + * @memberof DataaccessV1 + */ + 'policies'?: Array; + /** + * List of classification categories that apply to resources the entitlement \\ groups has access to + * @type {Array} + * @memberof DataaccessV1 + */ + 'categories'?: Array; + /** + * + * @type {DataaccessImpactScoreV1} + * @memberof DataaccessV1 + */ + 'impactScore'?: DataaccessImpactScoreV1; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetIdentityDecisionSummaryV1401ResponseV1 + */ +export interface GetIdentityDecisionSummaryV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetIdentityDecisionSummaryV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetIdentityDecisionSummaryV1429ResponseV1 + */ +export interface GetIdentityDecisionSummaryV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetIdentityDecisionSummaryV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface IdentitycertdecisionsummaryV1 + */ +export interface IdentitycertdecisionsummaryV1 { + /** + * Number of entitlement decisions that have been made + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'entitlementDecisionsMade'?: number; + /** + * Number of access profile decisions that have been made + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accessProfileDecisionsMade'?: number; + /** + * Number of role decisions that have been made + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'roleDecisionsMade'?: number; + /** + * Number of account decisions that have been made + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accountDecisionsMade'?: number; + /** + * The total number of entitlement decisions on the certification, both complete and incomplete + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'entitlementDecisionsTotal'?: number; + /** + * The total number of access profile decisions on the certification, both complete and incomplete + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accessProfileDecisionsTotal'?: number; + /** + * The total number of role decisions on the certification, both complete and incomplete + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'roleDecisionsTotal'?: number; + /** + * The total number of account decisions on the certification, both complete and incomplete + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accountDecisionsTotal'?: number; + /** + * The number of entitlement decisions that have been made which were approved + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'entitlementsApproved'?: number; + /** + * The number of entitlement decisions that have been made which were revoked + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'entitlementsRevoked'?: number; + /** + * The number of access profile decisions that have been made which were approved + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accessProfilesApproved'?: number; + /** + * The number of access profile decisions that have been made which were revoked + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accessProfilesRevoked'?: number; + /** + * The number of role decisions that have been made which were approved + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'rolesApproved'?: number; + /** + * The number of role decisions that have been made which were revoked + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'rolesRevoked'?: number; + /** + * The number of account decisions that have been made which were approved + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accountsApproved'?: number; + /** + * The number of account decisions that have been made which were revoked + * @type {number} + * @memberof IdentitycertdecisionsummaryV1 + */ + 'accountsRevoked'?: number; +} +/** + * + * @export + * @interface IdentityreferencewithnameandemailV1 + */ +export interface IdentityreferencewithnameandemailV1 { + /** + * The type can only be IDENTITY. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'type'?: string; + /** + * Identity ID. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'id'?: string; + /** + * Identity\'s human-readable display name. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'name'?: string; + /** + * Identity\'s email address. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'email'?: string | null; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ReviewableaccessprofileV1 + */ +export interface ReviewableaccessprofileV1 { + /** + * The id of the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'id'?: string; + /** + * Name of the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'name'?: string; + /** + * Information about the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'description'?: string; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableaccessprofileV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof ReviewableaccessprofileV1 + */ + 'cloudGoverned'?: boolean; + /** + * The date at which a user\'s access expires + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'endDate'?: string | null; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableaccessprofileV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * A list of entitlements associated with this Access Profile + * @type {Array} + * @memberof ReviewableaccessprofileV1 + */ + 'entitlements'?: Array; + /** + * Date the Access Profile was created. + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'created'?: string; + /** + * Date the Access Profile was last modified. + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'modified'?: string; +} +/** + * Information about the machine account owner + * @export + * @interface ReviewableentitlementAccountOwnerV1 + */ +export interface ReviewableentitlementAccountOwnerV1 { + /** + * The id associated with the machine account owner + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'id'?: string | null; + /** + * An enumeration of the types of Owner supported within the IdentityNow infrastructure. + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'type'?: ReviewableentitlementAccountOwnerV1TypeV1; + /** + * The machine account owner\'s display name + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'displayName'?: string | null; +} + +export const ReviewableentitlementAccountOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ReviewableentitlementAccountOwnerV1TypeV1 = typeof ReviewableentitlementAccountOwnerV1TypeV1[keyof typeof ReviewableentitlementAccountOwnerV1TypeV1]; + +/** + * Information about the status of the entitlement + * @export + * @interface ReviewableentitlementAccountV1 + */ +export interface ReviewableentitlementAccountV1 { + /** + * The native identity for this account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'nativeIdentity'?: string; + /** + * Indicates whether this account is currently disabled + * @type {boolean} + * @memberof ReviewableentitlementAccountV1 + */ + 'disabled'?: boolean; + /** + * Indicates whether this account is currently locked + * @type {boolean} + * @memberof ReviewableentitlementAccountV1 + */ + 'locked'?: boolean; + /** + * + * @type {DtotypeV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'type'?: DtotypeV1; + /** + * The id associated with the account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'id'?: string | null; + /** + * The account name + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'name'?: string | null; + /** + * When the account was created + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'created'?: string | null; + /** + * When the account was last modified + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'modified'?: string | null; + /** + * + * @type {ActivityinsightsV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'activityInsights'?: ActivityinsightsV1; + /** + * Information about the account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'description'?: string | null; + /** + * The id associated with the machine Account Governance Group + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'governanceGroupId'?: string | null; + /** + * + * @type {ReviewableentitlementAccountOwnerV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'owner'?: ReviewableentitlementAccountOwnerV1 | null; +} + + +/** + * + * @export + * @interface ReviewableentitlementV1 + */ +export interface ReviewableentitlementV1 { + /** + * The id for the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'id'?: string; + /** + * The name of the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'name'?: string; + /** + * Information about the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'description'?: string | null; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'privileged'?: boolean; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableentitlementV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * The name of the attribute on the source + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'attributeName'?: string; + /** + * The value of the attribute on the source + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'attributeValue'?: string; + /** + * The schema object type on the source used to represent the entitlement and its attributes + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The name of the source for which this entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceName'?: string; + /** + * The type of the source for which the entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceType'?: string; + /** + * The ID of the source for which the entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceId'?: string; + /** + * Indicates if the entitlement has permissions + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'hasPermissions'?: boolean; + /** + * Indicates if the entitlement is a representation of an account permission + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'isPermission'?: boolean; + /** + * Indicates whether the entitlement can be revoked + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'revocable'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement has DAS data + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'containsDataAccess'?: boolean; + /** + * + * @type {DataaccessV1} + * @memberof ReviewableentitlementV1 + */ + 'dataAccess'?: DataaccessV1 | null; + /** + * + * @type {ReviewableentitlementAccountV1} + * @memberof ReviewableentitlementV1 + */ + 'account'?: ReviewableentitlementAccountV1 | null; +} +/** + * + * @export + * @interface ReviewableroleV1 + */ +export interface ReviewableroleV1 { + /** + * The id for the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'id'?: string; + /** + * The name of the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'name'?: string; + /** + * Information about the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'description'?: string; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableroleV1 + */ + 'privileged'?: boolean; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableroleV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * Indicates whether the Role can be revoked or requested + * @type {boolean} + * @memberof ReviewableroleV1 + */ + 'revocable'?: boolean; + /** + * The date when a user\'s access expires. + * @type {string} + * @memberof ReviewableroleV1 + */ + 'endDate'?: string; + /** + * The list of Access Profiles associated with this Role + * @type {Array} + * @memberof ReviewableroleV1 + */ + 'accessProfiles'?: Array; + /** + * The list of entitlements associated with this Role + * @type {Array} + * @memberof ReviewableroleV1 + */ + 'entitlements'?: Array; +} + +/** + * CertificationSummariesV1Api - axios parameter creator + * @export + */ +export const CertificationSummariesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + * @summary Access summaries + * @param {string} id The identity campaign certification ID + * @param {GetIdentityAccessSummariesV1TypeV1} type The type of access review item to retrieve summaries for + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @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: **access.name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityAccessSummariesV1: async (id: string, type: GetIdentityAccessSummariesV1TypeV1, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentityAccessSummariesV1', 'id', id) + // verify required parameter 'type' is not null or undefined + assertParamExists('getIdentityAccessSummariesV1', 'type', type) + const localVarPath = `/certifications/v1/{id}/access-summaries/{type}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"type"}}`, encodeURIComponent(String(type))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + * @summary Summary of certification decisions + * @param {string} id The certification ID + * @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: **identitySummary.id**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityDecisionSummaryV1: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentityDecisionSummaryV1', 'id', id) + const localVarPath = `/certifications/v1/{id}/decision-summary` + .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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + * @summary Identity summaries for campaign certification + * @param {string} id The identity campaign certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySummariesV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentitySummariesV1', 'id', id) + const localVarPath = `/certifications/v1/{id}/identity-summaries` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + * @summary Summary for identity + * @param {string} id The identity campaign certification ID + * @param {string} identitySummaryId The identity summary ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySummaryV1: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentitySummaryV1', 'id', id) + // verify required parameter 'identitySummaryId' is not null or undefined + assertParamExists('getIdentitySummaryV1', 'identitySummaryId', identitySummaryId) + const localVarPath = `/certifications/v1/{id}/identity-summaries/{identitySummaryId}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); + // 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, + }; + }, + } +}; + +/** + * CertificationSummariesV1Api - functional programming interface + * @export + */ +export const CertificationSummariesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CertificationSummariesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + * @summary Access summaries + * @param {string} id The identity campaign certification ID + * @param {GetIdentityAccessSummariesV1TypeV1} type The type of access review item to retrieve summaries for + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @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: **access.name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityAccessSummariesV1(id: string, type: GetIdentityAccessSummariesV1TypeV1, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummariesV1(id, type, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV1Api.getIdentityAccessSummariesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + * @summary Summary of certification decisions + * @param {string} id The certification ID + * @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: **identitySummary.id**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityDecisionSummaryV1(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummaryV1(id, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV1Api.getIdentityDecisionSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + * @summary Identity summaries for campaign certification + * @param {string} id The identity campaign certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentitySummariesV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummariesV1(id, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV1Api.getIdentitySummariesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + * @summary Summary for identity + * @param {string} id The identity campaign certification ID + * @param {string} identitySummaryId The identity summary ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentitySummaryV1(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaryV1(id, identitySummaryId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV1Api.getIdentitySummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CertificationSummariesV1Api - factory interface + * @export + */ +export const CertificationSummariesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CertificationSummariesV1ApiFp(configuration) + return { + /** + * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + * @summary Access summaries + * @param {CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityAccessSummariesV1(requestParameters: CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentityAccessSummariesV1(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + * @summary Summary of certification decisions + * @param {CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityDecisionSummaryV1(requestParameters: CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityDecisionSummaryV1(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + * @summary Identity summaries for campaign certification + * @param {CertificationSummariesV1ApiGetIdentitySummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySummariesV1(requestParameters: CertificationSummariesV1ApiGetIdentitySummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentitySummariesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + * @summary Summary for identity + * @param {CertificationSummariesV1ApiGetIdentitySummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySummaryV1(requestParameters: CertificationSummariesV1ApiGetIdentitySummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentitySummaryV1(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getIdentityAccessSummariesV1 operation in CertificationSummariesV1Api. + * @export + * @interface CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request + */ +export interface CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + readonly id: string + + /** + * The type of access review item to retrieve summaries for + * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + readonly type: GetIdentityAccessSummariesV1TypeV1 + + /** + * 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 CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + 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: **access.name** + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentityAccessSummariesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getIdentityDecisionSummaryV1 operation in CertificationSummariesV1Api. + * @export + * @interface CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request + */ +export interface CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request { + /** + * The certification ID + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentityDecisionSummaryV1 + */ + readonly id: 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: **identitySummary.id**: *eq, in* + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentityDecisionSummaryV1 + */ + readonly filters?: string +} + +/** + * Request parameters for getIdentitySummariesV1 operation in CertificationSummariesV1Api. + * @export + * @interface CertificationSummariesV1ApiGetIdentitySummariesV1Request + */ +export interface CertificationSummariesV1ApiGetIdentitySummariesV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + 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, in* **completed**: *eq, ne* **name**: *eq, sw* + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + 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: **name** + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentitySummariesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getIdentitySummaryV1 operation in CertificationSummariesV1Api. + * @export + * @interface CertificationSummariesV1ApiGetIdentitySummaryV1Request + */ +export interface CertificationSummariesV1ApiGetIdentitySummaryV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentitySummaryV1 + */ + readonly id: string + + /** + * The identity summary ID + * @type {string} + * @memberof CertificationSummariesV1ApiGetIdentitySummaryV1 + */ + readonly identitySummaryId: string +} + +/** + * CertificationSummariesV1Api - object-oriented interface + * @export + * @class CertificationSummariesV1Api + * @extends {BaseAPI} + */ +export class CertificationSummariesV1Api extends BaseAPI { + /** + * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + * @summary Access summaries + * @param {CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationSummariesV1Api + */ + public getIdentityAccessSummariesV1(requestParameters: CertificationSummariesV1ApiGetIdentityAccessSummariesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationSummariesV1ApiFp(this.configuration).getIdentityAccessSummariesV1(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + * @summary Summary of certification decisions + * @param {CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationSummariesV1Api + */ + public getIdentityDecisionSummaryV1(requestParameters: CertificationSummariesV1ApiGetIdentityDecisionSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationSummariesV1ApiFp(this.configuration).getIdentityDecisionSummaryV1(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + * @summary Identity summaries for campaign certification + * @param {CertificationSummariesV1ApiGetIdentitySummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationSummariesV1Api + */ + public getIdentitySummariesV1(requestParameters: CertificationSummariesV1ApiGetIdentitySummariesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationSummariesV1ApiFp(this.configuration).getIdentitySummariesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + * @summary Summary for identity + * @param {CertificationSummariesV1ApiGetIdentitySummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationSummariesV1Api + */ + public getIdentitySummaryV1(requestParameters: CertificationSummariesV1ApiGetIdentitySummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationSummariesV1ApiFp(this.configuration).getIdentitySummaryV1(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetIdentityAccessSummariesV1TypeV1 = { + Role: 'ROLE', + AccessProfile: 'ACCESS_PROFILE', + Entitlement: 'ENTITLEMENT' +} as const; +export type GetIdentityAccessSummariesV1TypeV1 = typeof GetIdentityAccessSummariesV1TypeV1[keyof typeof GetIdentityAccessSummariesV1TypeV1]; + + diff --git a/sdk-output/certification_summaries/base.ts b/sdk-output/certification_summaries/base.ts new file mode 100644 index 00000000..f118bb3c --- /dev/null +++ b/sdk-output/certification_summaries/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Summaries + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/certification_summaries/common.ts b/sdk-output/certification_summaries/common.ts new file mode 100644 index 00000000..14f5d19b --- /dev/null +++ b/sdk-output/certification_summaries/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Summaries + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/certification_summaries/configuration.ts b/sdk-output/certification_summaries/configuration.ts new file mode 100644 index 00000000..37f8140f --- /dev/null +++ b/sdk-output/certification_summaries/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Summaries + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/certification_summaries/git_push.sh b/sdk-output/certification_summaries/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/certification_summaries/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/certification_summaries/index.ts b/sdk-output/certification_summaries/index.ts new file mode 100644 index 00000000..025f16c4 --- /dev/null +++ b/sdk-output/certification_summaries/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certification Summaries + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/certification_summaries/package.json b/sdk-output/certification_summaries/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/certification_summaries/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/certification_summaries/tsconfig.json b/sdk-output/certification_summaries/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/certification_summaries/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/certifications/.gitignore b/sdk-output/certifications/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/certifications/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/certifications/.npmignore b/sdk-output/certifications/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/certifications/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/certifications/.openapi-generator-ignore b/sdk-output/certifications/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/certifications/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/certifications/.openapi-generator/FILES b/sdk-output/certifications/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/certifications/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/certifications/.openapi-generator/VERSION b/sdk-output/certifications/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/certifications/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/certifications/.sdk-partition b/sdk-output/certifications/.sdk-partition new file mode 100644 index 00000000..5bc67a6c --- /dev/null +++ b/sdk-output/certifications/.sdk-partition @@ -0,0 +1 @@ +certifications \ No newline at end of file diff --git a/sdk-output/certifications/README.md b/sdk-output/certifications/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certifications/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certifications/api.ts b/sdk-output/certifications/api.ts new file mode 100644 index 00000000..5460d311 --- /dev/null +++ b/sdk-output/certifications/api.ts @@ -0,0 +1,2717 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certifications + * 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 AccessreviewitemV1 + */ +export interface AccessreviewitemV1 { + /** + * + * @type {AccesssummaryV1} + * @memberof AccessreviewitemV1 + */ + 'accessSummary'?: AccesssummaryV1; + /** + * + * @type {CertificationidentitysummaryV1} + * @memberof AccessreviewitemV1 + */ + 'identitySummary'?: CertificationidentitysummaryV1; + /** + * The review item\'s id + * @type {string} + * @memberof AccessreviewitemV1 + */ + 'id'?: string; + /** + * Whether the review item is complete + * @type {boolean} + * @memberof AccessreviewitemV1 + */ + 'completed'?: boolean; + /** + * Indicates whether the review item is for new access to a source + * @type {boolean} + * @memberof AccessreviewitemV1 + */ + 'newAccess'?: boolean; + /** + * + * @type {CertificationdecisionV1} + * @memberof AccessreviewitemV1 + */ + 'decision'?: CertificationdecisionV1; + /** + * Comments for this review item + * @type {string} + * @memberof AccessreviewitemV1 + */ + 'comments'?: string | null; +} + + +/** + * + * @export + * @interface AccesssummaryAccessV1 + */ +export interface AccesssummaryAccessV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccesssummaryAccessV1 + */ + 'type'?: DtotypeV1; + /** + * The ID of the item being certified + * @type {string} + * @memberof AccesssummaryAccessV1 + */ + 'id'?: string; + /** + * The name of the item being certified + * @type {string} + * @memberof AccesssummaryAccessV1 + */ + 'name'?: string; +} + + +/** + * An object holding the access that is being reviewed + * @export + * @interface AccesssummaryV1 + */ +export interface AccesssummaryV1 { + /** + * + * @type {AccesssummaryAccessV1} + * @memberof AccesssummaryV1 + */ + 'access'?: AccesssummaryAccessV1; + /** + * + * @type {ReviewableentitlementV1} + * @memberof AccesssummaryV1 + */ + 'entitlement'?: ReviewableentitlementV1 | null; + /** + * + * @type {ReviewableaccessprofileV1} + * @memberof AccesssummaryV1 + */ + 'accessProfile'?: ReviewableaccessprofileV1; + /** + * + * @type {ReviewableroleV1} + * @memberof AccesssummaryV1 + */ + 'role'?: ReviewableroleV1 | null; +} +/** + * Insights into account activity + * @export + * @interface ActivityinsightsV1 + */ +export interface ActivityinsightsV1 { + /** + * UUID of the account + * @type {string} + * @memberof ActivityinsightsV1 + */ + 'accountID'?: string; + /** + * The number of days of activity + * @type {number} + * @memberof ActivityinsightsV1 + */ + 'usageDays'?: number; + /** + * Status indicating if the activity is complete or unknown + * @type {string} + * @memberof ActivityinsightsV1 + */ + 'usageDaysState'?: ActivityinsightsV1UsageDaysStateV1; +} + +export const ActivityinsightsV1UsageDaysStateV1 = { + Complete: 'COMPLETE', + Unknown: 'UNKNOWN' +} as const; + +export type ActivityinsightsV1UsageDaysStateV1 = typeof ActivityinsightsV1UsageDaysStateV1[keyof typeof ActivityinsightsV1UsageDaysStateV1]; + +/** + * + * @export + * @interface CampaignreferenceV1 + */ +export interface CampaignreferenceV1 { + /** + * The unique ID of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'id': string; + /** + * The name of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'name': string; + /** + * The type of object that is being referenced. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'type': CampaignreferenceV1TypeV1; + /** + * The type of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'campaignType': CampaignreferenceV1CampaignTypeV1; + /** + * The description of the campaign set by the admin who created it. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'description': string | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'correlatedStatus': CampaignreferenceV1CorrelatedStatusV1; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'mandatoryCommentRequirement': CampaignreferenceV1MandatoryCommentRequirementV1; +} + +export const CampaignreferenceV1TypeV1 = { + Campaign: 'CAMPAIGN' +} as const; + +export type CampaignreferenceV1TypeV1 = typeof CampaignreferenceV1TypeV1[keyof typeof CampaignreferenceV1TypeV1]; +export const CampaignreferenceV1CampaignTypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type CampaignreferenceV1CampaignTypeV1 = typeof CampaignreferenceV1CampaignTypeV1[keyof typeof CampaignreferenceV1CampaignTypeV1]; +export const CampaignreferenceV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type CampaignreferenceV1CorrelatedStatusV1 = typeof CampaignreferenceV1CorrelatedStatusV1[keyof typeof CampaignreferenceV1CorrelatedStatusV1]; +export const CampaignreferenceV1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type CampaignreferenceV1MandatoryCommentRequirementV1 = typeof CampaignreferenceV1MandatoryCommentRequirementV1[keyof typeof CampaignreferenceV1MandatoryCommentRequirementV1]; + +/** + * The decision to approve or revoke the review item + * @export + * @enum {string} + */ + +export const CertificationdecisionV1 = { + Approve: 'APPROVE', + Revoke: 'REVOKE' +} as const; + +export type CertificationdecisionV1 = typeof CertificationdecisionV1[keyof typeof CertificationdecisionV1]; + + +/** + * + * @export + * @interface CertificationidentitysummaryV1 + */ +export interface CertificationidentitysummaryV1 { + /** + * The ID of the identity summary + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'id'?: string; + /** + * Name of the linked identity + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'name'?: string; + /** + * The ID of the identity being certified + * @type {string} + * @memberof CertificationidentitysummaryV1 + */ + 'identityId'?: string; + /** + * Indicates whether the review items for the linked identity\'s certification have been completed + * @type {boolean} + * @memberof CertificationidentitysummaryV1 + */ + 'completed'?: boolean; +} +/** + * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + * @export + * @enum {string} + */ + +export const CertificationphaseV1 = { + Staged: 'STAGED', + Active: 'ACTIVE', + Signed: 'SIGNED' +} as const; + +export type CertificationphaseV1 = typeof CertificationphaseV1[keyof typeof CertificationphaseV1]; + + +/** + * + * @export + * @interface CertificationreferenceV1 + */ +export interface CertificationreferenceV1 { + /** + * The id of the certification. + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'id'?: string; + /** + * The name of the certification. + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'name'?: string; + /** + * + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'type'?: CertificationreferenceV1TypeV1; + /** + * + * @type {ReviewerV1} + * @memberof CertificationreferenceV1 + */ + 'reviewer'?: ReviewerV1; +} + +export const CertificationreferenceV1TypeV1 = { + Certification: 'CERTIFICATION' +} as const; + +export type CertificationreferenceV1TypeV1 = typeof CertificationreferenceV1TypeV1[keyof typeof CertificationreferenceV1TypeV1]; + +/** + * + * @export + * @interface CertificationtaskV1 + */ +export interface CertificationtaskV1 { + /** + * The ID of the certification task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'id'?: string; + /** + * The type of the certification task. More values may be added in the future. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'type'?: CertificationtaskV1TypeV1; + /** + * The type of item that is being operated on by this task whose ID is stored in the targetId field. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'targetType'?: CertificationtaskV1TargetTypeV1; + /** + * The ID of the item being operated on by this task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'targetId'?: string; + /** + * The status of the task. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'status'?: CertificationtaskV1StatusV1; + /** + * List of error messages + * @type {Array} + * @memberof CertificationtaskV1 + */ + 'errors'?: Array; + /** + * Reassignment trails that lead to self certification identity + * @type {Array} + * @memberof CertificationtaskV1 + */ + 'reassignmentTrailDTOs'?: Array; + /** + * The date and time on which this task was created. + * @type {string} + * @memberof CertificationtaskV1 + */ + 'created'?: string; +} + +export const CertificationtaskV1TypeV1 = { + Reassign: 'REASSIGN', + AdminReassign: 'ADMIN_REASSIGN', + CompleteCertification: 'COMPLETE_CERTIFICATION', + FinishCertification: 'FINISH_CERTIFICATION', + CompleteCampaign: 'COMPLETE_CAMPAIGN', + ActivateCampaign: 'ACTIVATE_CAMPAIGN', + CampaignCreate: 'CAMPAIGN_CREATE', + CampaignDelete: 'CAMPAIGN_DELETE' +} as const; + +export type CertificationtaskV1TypeV1 = typeof CertificationtaskV1TypeV1[keyof typeof CertificationtaskV1TypeV1]; +export const CertificationtaskV1TargetTypeV1 = { + Certification: 'CERTIFICATION', + Campaign: 'CAMPAIGN' +} as const; + +export type CertificationtaskV1TargetTypeV1 = typeof CertificationtaskV1TargetTypeV1[keyof typeof CertificationtaskV1TargetTypeV1]; +export const CertificationtaskV1StatusV1 = { + Queued: 'QUEUED', + InProgress: 'IN_PROGRESS', + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type CertificationtaskV1StatusV1 = typeof CertificationtaskV1StatusV1[keyof typeof CertificationtaskV1StatusV1]; + +/** + * + * @export + * @interface DataaccessCategoriesInnerV1 + */ +export interface DataaccessCategoriesInnerV1 { + /** + * Value of the category + * @type {string} + * @memberof DataaccessCategoriesInnerV1 + */ + 'value'?: string; + /** + * Number of matched for each category + * @type {number} + * @memberof DataaccessCategoriesInnerV1 + */ + 'matchCount'?: number; +} +/** + * + * @export + * @interface DataaccessImpactScoreV1 + */ +export interface DataaccessImpactScoreV1 { + /** + * Impact Score for this data + * @type {string} + * @memberof DataaccessImpactScoreV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface DataaccessPoliciesInnerV1 + */ +export interface DataaccessPoliciesInnerV1 { + /** + * Value of the policy + * @type {string} + * @memberof DataaccessPoliciesInnerV1 + */ + 'value'?: string; +} +/** + * DAS data for the entitlement + * @export + * @interface DataaccessV1 + */ +export interface DataaccessV1 { + /** + * List of classification policies that apply to resources the entitlement \\ groups has access to + * @type {Array} + * @memberof DataaccessV1 + */ + 'policies'?: Array; + /** + * List of classification categories that apply to resources the entitlement \\ groups has access to + * @type {Array} + * @memberof DataaccessV1 + */ + 'categories'?: Array; + /** + * + * @type {DataaccessImpactScoreV1} + * @memberof DataaccessV1 + */ + 'impactScore'?: DataaccessImpactScoreV1; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface IdentitycertificationdtoV1 + */ +export interface IdentitycertificationdtoV1 { + /** + * id of the certification + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'id'?: string; + /** + * name of the certification + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'name'?: string; + /** + * + * @type {CampaignreferenceV1} + * @memberof IdentitycertificationdtoV1 + */ + 'campaign'?: CampaignreferenceV1; + /** + * Have all decisions been made? + * @type {boolean} + * @memberof IdentitycertificationdtoV1 + */ + 'completed'?: boolean; + /** + * The number of identities for whom all decisions have been made and are complete. + * @type {number} + * @memberof IdentitycertificationdtoV1 + */ + 'identitiesCompleted'?: number; + /** + * The total number of identities in the Certification, both complete and incomplete. + * @type {number} + * @memberof IdentitycertificationdtoV1 + */ + 'identitiesTotal'?: number; + /** + * created date + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'created'?: string; + /** + * modified date + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'modified'?: string; + /** + * The number of approve/revoke/acknowledge decisions that have been made. + * @type {number} + * @memberof IdentitycertificationdtoV1 + */ + 'decisionsMade'?: number; + /** + * The total number of approve/revoke/acknowledge decisions. + * @type {number} + * @memberof IdentitycertificationdtoV1 + */ + 'decisionsTotal'?: number; + /** + * The due date of the certification. + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'due'?: string | null; + /** + * The date the reviewer signed off on the Certification. + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'signed'?: string | null; + /** + * + * @type {ReviewerV1} + * @memberof IdentitycertificationdtoV1 + */ + 'reviewer'?: ReviewerV1; + /** + * + * @type {ReassignmentV1} + * @memberof IdentitycertificationdtoV1 + */ + 'reassignment'?: ReassignmentV1 | null; + /** + * Identifies if the certification has an error + * @type {boolean} + * @memberof IdentitycertificationdtoV1 + */ + 'hasErrors'?: boolean; + /** + * Description of the certification error + * @type {string} + * @memberof IdentitycertificationdtoV1 + */ + 'errorMessage'?: string | null; + /** + * + * @type {CertificationphaseV1} + * @memberof IdentitycertificationdtoV1 + */ + 'phase'?: CertificationphaseV1; +} + + +/** + * + * @export + * @interface IdentityreferencewithnameandemailV1 + */ +export interface IdentityreferencewithnameandemailV1 { + /** + * The type can only be IDENTITY. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'type'?: string; + /** + * Identity ID. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'id'?: string; + /** + * Identity\'s human-readable display name. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'name'?: string; + /** + * Identity\'s email address. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'email'?: string | null; +} +/** + * + * @export + * @interface ListIdentityCertificationsV1401ResponseV1 + */ +export interface ListIdentityCertificationsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityCertificationsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListIdentityCertificationsV1429ResponseV1 + */ +export interface ListIdentityCertificationsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityCertificationsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} +/** + * + * @export + * @interface ReassignmentV1 + */ +export interface ReassignmentV1 { + /** + * + * @type {CertificationreferenceV1} + * @memberof ReassignmentV1 + */ + 'from'?: CertificationreferenceV1; + /** + * The comment entered when the Certification was reassigned + * @type {string} + * @memberof ReassignmentV1 + */ + 'comment'?: string; +} +/** + * + * @export + * @interface ReassignmenttraildtoV1 + */ +export interface ReassignmenttraildtoV1 { + /** + * The ID of previous owner identity. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'previousOwner'?: string; + /** + * The ID of new owner identity. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'newOwner'?: string; + /** + * The type of reassignment. + * @type {string} + * @memberof ReassignmenttraildtoV1 + */ + 'reassignmentType'?: string; +} +/** + * + * @export + * @interface ReassignreferenceV1 + */ +export interface ReassignreferenceV1 { + /** + * The ID of item or identity being reassigned. + * @type {string} + * @memberof ReassignreferenceV1 + */ + 'id': string; + /** + * The type of item or identity being reassigned. + * @type {string} + * @memberof ReassignreferenceV1 + */ + 'type': ReassignreferenceV1TypeV1; +} + +export const ReassignreferenceV1TypeV1 = { + TargetSummary: 'TARGET_SUMMARY', + Item: 'ITEM', + IdentitySummary: 'IDENTITY_SUMMARY' +} as const; + +export type ReassignreferenceV1TypeV1 = typeof ReassignreferenceV1TypeV1[keyof typeof ReassignreferenceV1TypeV1]; + +/** + * + * @export + * @interface ReviewableaccessprofileV1 + */ +export interface ReviewableaccessprofileV1 { + /** + * The id of the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'id'?: string; + /** + * Name of the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'name'?: string; + /** + * Information about the Access Profile + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'description'?: string; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableaccessprofileV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof ReviewableaccessprofileV1 + */ + 'cloudGoverned'?: boolean; + /** + * The date at which a user\'s access expires + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'endDate'?: string | null; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableaccessprofileV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * A list of entitlements associated with this Access Profile + * @type {Array} + * @memberof ReviewableaccessprofileV1 + */ + 'entitlements'?: Array; + /** + * Date the Access Profile was created. + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'created'?: string; + /** + * Date the Access Profile was last modified. + * @type {string} + * @memberof ReviewableaccessprofileV1 + */ + 'modified'?: string; +} +/** + * Information about the machine account owner + * @export + * @interface ReviewableentitlementAccountOwnerV1 + */ +export interface ReviewableentitlementAccountOwnerV1 { + /** + * The id associated with the machine account owner + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'id'?: string | null; + /** + * An enumeration of the types of Owner supported within the IdentityNow infrastructure. + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'type'?: ReviewableentitlementAccountOwnerV1TypeV1; + /** + * The machine account owner\'s display name + * @type {string} + * @memberof ReviewableentitlementAccountOwnerV1 + */ + 'displayName'?: string | null; +} + +export const ReviewableentitlementAccountOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ReviewableentitlementAccountOwnerV1TypeV1 = typeof ReviewableentitlementAccountOwnerV1TypeV1[keyof typeof ReviewableentitlementAccountOwnerV1TypeV1]; + +/** + * Information about the status of the entitlement + * @export + * @interface ReviewableentitlementAccountV1 + */ +export interface ReviewableentitlementAccountV1 { + /** + * The native identity for this account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'nativeIdentity'?: string; + /** + * Indicates whether this account is currently disabled + * @type {boolean} + * @memberof ReviewableentitlementAccountV1 + */ + 'disabled'?: boolean; + /** + * Indicates whether this account is currently locked + * @type {boolean} + * @memberof ReviewableentitlementAccountV1 + */ + 'locked'?: boolean; + /** + * + * @type {DtotypeV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'type'?: DtotypeV1; + /** + * The id associated with the account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'id'?: string | null; + /** + * The account name + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'name'?: string | null; + /** + * When the account was created + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'created'?: string | null; + /** + * When the account was last modified + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'modified'?: string | null; + /** + * + * @type {ActivityinsightsV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'activityInsights'?: ActivityinsightsV1; + /** + * Information about the account + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'description'?: string | null; + /** + * The id associated with the machine Account Governance Group + * @type {string} + * @memberof ReviewableentitlementAccountV1 + */ + 'governanceGroupId'?: string | null; + /** + * + * @type {ReviewableentitlementAccountOwnerV1} + * @memberof ReviewableentitlementAccountV1 + */ + 'owner'?: ReviewableentitlementAccountOwnerV1 | null; +} + + +/** + * + * @export + * @interface ReviewableentitlementV1 + */ +export interface ReviewableentitlementV1 { + /** + * The id for the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'id'?: string; + /** + * The name of the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'name'?: string; + /** + * Information about the entitlement + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'description'?: string | null; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'privileged'?: boolean; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableentitlementV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * The name of the attribute on the source + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'attributeName'?: string; + /** + * The value of the attribute on the source + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'attributeValue'?: string; + /** + * The schema object type on the source used to represent the entitlement and its attributes + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The name of the source for which this entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceName'?: string; + /** + * The type of the source for which the entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceType'?: string; + /** + * The ID of the source for which the entitlement belongs + * @type {string} + * @memberof ReviewableentitlementV1 + */ + 'sourceId'?: string; + /** + * Indicates if the entitlement has permissions + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'hasPermissions'?: boolean; + /** + * Indicates if the entitlement is a representation of an account permission + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'isPermission'?: boolean; + /** + * Indicates whether the entitlement can be revoked + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'revocable'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement has DAS data + * @type {boolean} + * @memberof ReviewableentitlementV1 + */ + 'containsDataAccess'?: boolean; + /** + * + * @type {DataaccessV1} + * @memberof ReviewableentitlementV1 + */ + 'dataAccess'?: DataaccessV1 | null; + /** + * + * @type {ReviewableentitlementAccountV1} + * @memberof ReviewableentitlementV1 + */ + 'account'?: ReviewableentitlementAccountV1 | null; +} +/** + * + * @export + * @interface ReviewableroleV1 + */ +export interface ReviewableroleV1 { + /** + * The id for the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'id'?: string; + /** + * The name of the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'name'?: string; + /** + * Information about the Role + * @type {string} + * @memberof ReviewableroleV1 + */ + 'description'?: string; + /** + * Indicates if the entitlement is a privileged entitlement + * @type {boolean} + * @memberof ReviewableroleV1 + */ + 'privileged'?: boolean; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof ReviewableroleV1 + */ + 'owner'?: IdentityreferencewithnameandemailV1 | null; + /** + * Indicates whether the Role can be revoked or requested + * @type {boolean} + * @memberof ReviewableroleV1 + */ + 'revocable'?: boolean; + /** + * The date when a user\'s access expires. + * @type {string} + * @memberof ReviewableroleV1 + */ + 'endDate'?: string; + /** + * The list of Access Profiles associated with this Role + * @type {Array} + * @memberof ReviewableroleV1 + */ + 'accessProfiles'?: Array; + /** + * The list of entitlements associated with this Role + * @type {Array} + * @memberof ReviewableroleV1 + */ + 'entitlements'?: Array; +} +/** + * + * @export + * @interface ReviewdecisionV1 + */ +export interface ReviewdecisionV1 { + /** + * The id of the review decision + * @type {string} + * @memberof ReviewdecisionV1 + */ + 'id': string; + /** + * + * @type {CertificationdecisionV1} + * @memberof ReviewdecisionV1 + */ + 'decision': CertificationdecisionV1; + /** + * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. + * @type {string} + * @memberof ReviewdecisionV1 + */ + 'proposedEndDate'?: string; + /** + * Indicates whether decision should be marked as part of a larger bulk decision + * @type {boolean} + * @memberof ReviewdecisionV1 + */ + 'bulk': boolean; + /** + * + * @type {ReviewrecommendationV1} + * @memberof ReviewdecisionV1 + */ + 'recommendation'?: ReviewrecommendationV1; + /** + * Comments recorded when the decision was made + * @type {string} + * @memberof ReviewdecisionV1 + */ + 'comments'?: string; +} + + +/** + * + * @export + * @interface ReviewerV1 + */ +export interface ReviewerV1 { + /** + * The id of the reviewer. + * @type {string} + * @memberof ReviewerV1 + */ + 'id'?: string; + /** + * The name of the reviewer. + * @type {string} + * @memberof ReviewerV1 + */ + 'name'?: string; + /** + * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. + * @type {string} + * @memberof ReviewerV1 + */ + 'email'?: string | null; + /** + * The type of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'type'?: ReviewerV1TypeV1; + /** + * The created date of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'created'?: string | null; + /** + * The modified date of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'modified'?: string | null; +} + +export const ReviewerV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type ReviewerV1TypeV1 = typeof ReviewerV1TypeV1[keyof typeof ReviewerV1TypeV1]; + +/** + * + * @export + * @interface ReviewreassignV1 + */ +export interface ReviewreassignV1 { + /** + * + * @type {Array} + * @memberof ReviewreassignV1 + */ + 'reassign': Array; + /** + * The ID of the identity to which the certification is reassigned + * @type {string} + * @memberof ReviewreassignV1 + */ + 'reassignTo': string; + /** + * The reason comment for why the reassign was made + * @type {string} + * @memberof ReviewreassignV1 + */ + 'reason': string; +} +/** + * + * @export + * @interface ReviewrecommendationV1 + */ +export interface ReviewrecommendationV1 { + /** + * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. + * @type {string} + * @memberof ReviewrecommendationV1 + */ + 'recommendation'?: string | null; + /** + * A list of reasons for the recommendation. + * @type {Array} + * @memberof ReviewrecommendationV1 + */ + 'reasons'?: Array; + /** + * The time at which the recommendation was recorded. + * @type {string} + * @memberof ReviewrecommendationV1 + */ + 'timestamp'?: string; +} + +/** + * CertificationsV1Api - axios parameter creator + * @export + */ +export const CertificationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + * @summary Certification task by id + * @param {string} id The task ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCertificationTaskV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCertificationTaskV1', 'id', id) + const localVarPath = `/certification-tasks/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, + }; + }, + /** + * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. + * @summary Permissions for entitlement certification item + * @param {string} certificationId The certification ID + * @param {string} itemId The certification item ID + * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityCertificationItemPermissionsV1: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'certificationId' is not null or undefined + assertParamExists('getIdentityCertificationItemPermissionsV1', 'certificationId', certificationId) + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getIdentityCertificationItemPermissionsV1', 'itemId', itemId) + const localVarPath = `/certifications/v1/{certificationId}/access-review-items/{itemId}/permissions` + .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. + * @summary Identity certification by id + * @param {string} id The certification id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityCertificationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentityCertificationV1', 'id', id) + const localVarPath = `/certifications/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, + }; + }, + /** + * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + * @summary List of pending certification tasks + * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPendingCertificationTasksV1: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/certification-tasks/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 (reviewerIdentity !== undefined) { + localVarQueryParameter['reviewer-identity'] = reviewerIdentity; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + * @summary List of reviewers for certification + * @param {string} id The certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* + * @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: **name, email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCertificationReviewersV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listCertificationReviewersV1', 'id', id) + const localVarPath = `/certifications/v1/{id}/reviewers` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary List of access review items + * @param {string} id The identity campaign certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAccessReviewItemsV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listIdentityAccessReviewItemsV1', 'id', id) + const localVarPath = `/certifications/v1/{id}/access-review-items` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (entitlements !== undefined) { + localVarQueryParameter['entitlements'] = entitlements; + } + + if (accessProfiles !== undefined) { + localVarQueryParameter['access-profiles'] = accessProfiles; + } + + if (roles !== undefined) { + localVarQueryParameter['roles'] = roles; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + * @summary List identity campaign certifications + * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* + * @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: **name, due, signed** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityCertificationsV1: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/certifications/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 (reviewerIdentity !== undefined) { + localVarQueryParameter['reviewer-identity'] = reviewerIdentity; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Decide on a certification item + * @param {string} id The ID of the identity campaign certification on which to make decisions + * @param {Array} reviewdecisionV1 A non-empty array of decisions to be made. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + makeIdentityDecisionV1: async (id: string, reviewdecisionV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('makeIdentityDecisionV1', 'id', id) + // verify required parameter 'reviewdecisionV1' is not null or undefined + assertParamExists('makeIdentityDecisionV1', 'reviewdecisionV1', reviewdecisionV1) + const localVarPath = `/certifications/v1/{id}/decide` + .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: '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(reviewdecisionV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Reassign identities or items + * @param {string} id The identity campaign certification ID + * @param {ReviewreassignV1} reviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + reassignIdentityCertificationsV1: async (id: string, reviewreassignV1: ReviewreassignV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('reassignIdentityCertificationsV1', 'id', id) + // verify required parameter 'reviewreassignV1' is not null or undefined + assertParamExists('reassignIdentityCertificationsV1', 'reviewreassignV1', reviewreassignV1) + const localVarPath = `/certifications/v1/{id}/reassign` + .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: '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(reviewreassignV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Finalize identity certification decisions + * @param {string} id The identity campaign certification ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + signOffIdentityCertificationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('signOffIdentityCertificationV1', 'id', id) + const localVarPath = `/certifications/v1/{id}/sign-off` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. + * @summary Reassign certifications asynchronously + * @param {string} id The identity campaign certification ID + * @param {ReviewreassignV1} reviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitReassignCertsAsyncV1: async (id: string, reviewreassignV1: ReviewreassignV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('submitReassignCertsAsyncV1', 'id', id) + // verify required parameter 'reviewreassignV1' is not null or undefined + assertParamExists('submitReassignCertsAsyncV1', 'reviewreassignV1', reviewreassignV1) + const localVarPath = `/certifications/v1/{id}/reassign-async` + .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: '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(reviewreassignV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CertificationsV1Api - functional programming interface + * @export + */ +export const CertificationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CertificationsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + * @summary Certification task by id + * @param {string} id The task ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCertificationTaskV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTaskV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.getCertificationTaskV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. + * @summary Permissions for entitlement certification item + * @param {string} certificationId The certification ID + * @param {string} itemId The certification item ID + * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityCertificationItemPermissionsV1(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissionsV1(certificationId, itemId, filters, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.getIdentityCertificationItemPermissionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. + * @summary Identity certification by id + * @param {string} id The certification id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityCertificationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.getIdentityCertificationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + * @summary List of pending certification tasks + * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPendingCertificationTasksV1(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasksV1(reviewerIdentity, limit, offset, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.getPendingCertificationTasksV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + * @summary List of reviewers for certification + * @param {string} id The certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* + * @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: **name, email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listCertificationReviewersV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewersV1(id, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.listCertificationReviewersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary List of access review items + * @param {string} id The identity campaign certification ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityAccessReviewItemsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItemsV1(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.listIdentityAccessReviewItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + * @summary List identity campaign certifications + * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* + * @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: **name, due, signed** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityCertificationsV1(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertificationsV1(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.listIdentityCertificationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Decide on a certification item + * @param {string} id The ID of the identity campaign certification on which to make decisions + * @param {Array} reviewdecisionV1 A non-empty array of decisions to be made. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async makeIdentityDecisionV1(id: string, reviewdecisionV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecisionV1(id, reviewdecisionV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.makeIdentityDecisionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Reassign identities or items + * @param {string} id The identity campaign certification ID + * @param {ReviewreassignV1} reviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async reassignIdentityCertificationsV1(id: string, reviewreassignV1: ReviewreassignV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertificationsV1(id, reviewreassignV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.reassignIdentityCertificationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Finalize identity certification decisions + * @param {string} id The identity campaign certification ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async signOffIdentityCertificationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertificationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.signOffIdentityCertificationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. + * @summary Reassign certifications asynchronously + * @param {string} id The identity campaign certification ID + * @param {ReviewreassignV1} reviewreassignV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitReassignCertsAsyncV1(id: string, reviewreassignV1: ReviewreassignV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsyncV1(id, reviewreassignV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CertificationsV1Api.submitReassignCertsAsyncV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CertificationsV1Api - factory interface + * @export + */ +export const CertificationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CertificationsV1ApiFp(configuration) + return { + /** + * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + * @summary Certification task by id + * @param {CertificationsV1ApiGetCertificationTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCertificationTaskV1(requestParameters: CertificationsV1ApiGetCertificationTaskV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCertificationTaskV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. + * @summary Permissions for entitlement certification item + * @param {CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityCertificationItemPermissionsV1(requestParameters: CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentityCertificationItemPermissionsV1(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. + * @summary Identity certification by id + * @param {CertificationsV1ApiGetIdentityCertificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityCertificationV1(requestParameters: CertificationsV1ApiGetIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + * @summary List of pending certification tasks + * @param {CertificationsV1ApiGetPendingCertificationTasksV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPendingCertificationTasksV1(requestParameters: CertificationsV1ApiGetPendingCertificationTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPendingCertificationTasksV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + * @summary List of reviewers for certification + * @param {CertificationsV1ApiListCertificationReviewersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCertificationReviewersV1(requestParameters: CertificationsV1ApiListCertificationReviewersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listCertificationReviewersV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary List of access review items + * @param {CertificationsV1ApiListIdentityAccessReviewItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAccessReviewItemsV1(requestParameters: CertificationsV1ApiListIdentityAccessReviewItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityAccessReviewItemsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + * @summary List identity campaign certifications + * @param {CertificationsV1ApiListIdentityCertificationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityCertificationsV1(requestParameters: CertificationsV1ApiListIdentityCertificationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityCertificationsV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Decide on a certification item + * @param {CertificationsV1ApiMakeIdentityDecisionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + makeIdentityDecisionV1(requestParameters: CertificationsV1ApiMakeIdentityDecisionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.makeIdentityDecisionV1(requestParameters.id, requestParameters.reviewdecisionV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Reassign identities or items + * @param {CertificationsV1ApiReassignIdentityCertificationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + reassignIdentityCertificationsV1(requestParameters: CertificationsV1ApiReassignIdentityCertificationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.reassignIdentityCertificationsV1(requestParameters.id, requestParameters.reviewreassignV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Finalize identity certification decisions + * @param {CertificationsV1ApiSignOffIdentityCertificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + signOffIdentityCertificationV1(requestParameters: CertificationsV1ApiSignOffIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.signOffIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. + * @summary Reassign certifications asynchronously + * @param {CertificationsV1ApiSubmitReassignCertsAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitReassignCertsAsyncV1(requestParameters: CertificationsV1ApiSubmitReassignCertsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitReassignCertsAsyncV1(requestParameters.id, requestParameters.reviewreassignV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getCertificationTaskV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiGetCertificationTaskV1Request + */ +export interface CertificationsV1ApiGetCertificationTaskV1Request { + /** + * The task ID + * @type {string} + * @memberof CertificationsV1ApiGetCertificationTaskV1 + */ + readonly id: string +} + +/** + * Request parameters for getIdentityCertificationItemPermissionsV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request + */ +export interface CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request { + /** + * The certification ID + * @type {string} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly certificationId: string + + /** + * The certification item ID + * @type {string} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 + * @type {string} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationsV1ApiGetIdentityCertificationItemPermissionsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getIdentityCertificationV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiGetIdentityCertificationV1Request + */ +export interface CertificationsV1ApiGetIdentityCertificationV1Request { + /** + * The certification id + * @type {string} + * @memberof CertificationsV1ApiGetIdentityCertificationV1 + */ + readonly id: string +} + +/** + * Request parameters for getPendingCertificationTasksV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiGetPendingCertificationTasksV1Request + */ +export interface CertificationsV1ApiGetPendingCertificationTasksV1Request { + /** + * The ID of reviewer identity. *me* indicates the current user. + * @type {string} + * @memberof CertificationsV1ApiGetPendingCertificationTasksV1 + */ + readonly reviewerIdentity?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiGetPendingCertificationTasksV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiGetPendingCertificationTasksV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationsV1ApiGetPendingCertificationTasksV1 + */ + 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, in* **targetId**: *eq, in* **type**: *eq, in* + * @type {string} + * @memberof CertificationsV1ApiGetPendingCertificationTasksV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listCertificationReviewersV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiListCertificationReviewersV1Request + */ +export interface CertificationsV1ApiListCertificationReviewersV1Request { + /** + * The certification ID + * @type {string} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + 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, in* **name**: *eq, sw* **email**: *eq, sw* + * @type {string} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + 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: **name, email** + * @type {string} + * @memberof CertificationsV1ApiListCertificationReviewersV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listIdentityAccessReviewItemsV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiListIdentityAccessReviewItemsV1Request + */ +export interface CertificationsV1ApiListIdentityAccessReviewItemsV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + 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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly sorters?: string + + /** + * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly entitlements?: string + + /** + * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly accessProfiles?: string + + /** + * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + * @type {string} + * @memberof CertificationsV1ApiListIdentityAccessReviewItemsV1 + */ + readonly roles?: string +} + +/** + * Request parameters for listIdentityCertificationsV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiListIdentityCertificationsV1Request + */ +export interface CertificationsV1ApiListIdentityCertificationsV1Request { + /** + * Reviewer\'s identity. *me* indicates the current user. + * @type {string} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + readonly reviewerIdentity?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + 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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* + * @type {string} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + 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: **name, due, signed** + * @type {string} + * @memberof CertificationsV1ApiListIdentityCertificationsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for makeIdentityDecisionV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiMakeIdentityDecisionV1Request + */ +export interface CertificationsV1ApiMakeIdentityDecisionV1Request { + /** + * The ID of the identity campaign certification on which to make decisions + * @type {string} + * @memberof CertificationsV1ApiMakeIdentityDecisionV1 + */ + readonly id: string + + /** + * A non-empty array of decisions to be made. + * @type {Array} + * @memberof CertificationsV1ApiMakeIdentityDecisionV1 + */ + readonly reviewdecisionV1: Array +} + +/** + * Request parameters for reassignIdentityCertificationsV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiReassignIdentityCertificationsV1Request + */ +export interface CertificationsV1ApiReassignIdentityCertificationsV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationsV1ApiReassignIdentityCertificationsV1 + */ + readonly id: string + + /** + * + * @type {ReviewreassignV1} + * @memberof CertificationsV1ApiReassignIdentityCertificationsV1 + */ + readonly reviewreassignV1: ReviewreassignV1 +} + +/** + * Request parameters for signOffIdentityCertificationV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiSignOffIdentityCertificationV1Request + */ +export interface CertificationsV1ApiSignOffIdentityCertificationV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationsV1ApiSignOffIdentityCertificationV1 + */ + readonly id: string +} + +/** + * Request parameters for submitReassignCertsAsyncV1 operation in CertificationsV1Api. + * @export + * @interface CertificationsV1ApiSubmitReassignCertsAsyncV1Request + */ +export interface CertificationsV1ApiSubmitReassignCertsAsyncV1Request { + /** + * The identity campaign certification ID + * @type {string} + * @memberof CertificationsV1ApiSubmitReassignCertsAsyncV1 + */ + readonly id: string + + /** + * + * @type {ReviewreassignV1} + * @memberof CertificationsV1ApiSubmitReassignCertsAsyncV1 + */ + readonly reviewreassignV1: ReviewreassignV1 +} + +/** + * CertificationsV1Api - object-oriented interface + * @export + * @class CertificationsV1Api + * @extends {BaseAPI} + */ +export class CertificationsV1Api extends BaseAPI { + /** + * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + * @summary Certification task by id + * @param {CertificationsV1ApiGetCertificationTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public getCertificationTaskV1(requestParameters: CertificationsV1ApiGetCertificationTaskV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).getCertificationTaskV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. + * @summary Permissions for entitlement certification item + * @param {CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public getIdentityCertificationItemPermissionsV1(requestParameters: CertificationsV1ApiGetIdentityCertificationItemPermissionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).getIdentityCertificationItemPermissionsV1(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. + * @summary Identity certification by id + * @param {CertificationsV1ApiGetIdentityCertificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public getIdentityCertificationV1(requestParameters: CertificationsV1ApiGetIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).getIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + * @summary List of pending certification tasks + * @param {CertificationsV1ApiGetPendingCertificationTasksV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public getPendingCertificationTasksV1(requestParameters: CertificationsV1ApiGetPendingCertificationTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).getPendingCertificationTasksV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + * @summary List of reviewers for certification + * @param {CertificationsV1ApiListCertificationReviewersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public listCertificationReviewersV1(requestParameters: CertificationsV1ApiListCertificationReviewersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).listCertificationReviewersV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary List of access review items + * @param {CertificationsV1ApiListIdentityAccessReviewItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public listIdentityAccessReviewItemsV1(requestParameters: CertificationsV1ApiListIdentityAccessReviewItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).listIdentityAccessReviewItemsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + * @summary List identity campaign certifications + * @param {CertificationsV1ApiListIdentityCertificationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public listIdentityCertificationsV1(requestParameters: CertificationsV1ApiListIdentityCertificationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).listIdentityCertificationsV1(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Decide on a certification item + * @param {CertificationsV1ApiMakeIdentityDecisionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public makeIdentityDecisionV1(requestParameters: CertificationsV1ApiMakeIdentityDecisionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).makeIdentityDecisionV1(requestParameters.id, requestParameters.reviewdecisionV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Reassign identities or items + * @param {CertificationsV1ApiReassignIdentityCertificationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public reassignIdentityCertificationsV1(requestParameters: CertificationsV1ApiReassignIdentityCertificationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).reassignIdentityCertificationsV1(requestParameters.id, requestParameters.reviewreassignV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + * @summary Finalize identity certification decisions + * @param {CertificationsV1ApiSignOffIdentityCertificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public signOffIdentityCertificationV1(requestParameters: CertificationsV1ApiSignOffIdentityCertificationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).signOffIdentityCertificationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. + * @summary Reassign certifications asynchronously + * @param {CertificationsV1ApiSubmitReassignCertsAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CertificationsV1Api + */ + public submitReassignCertsAsyncV1(requestParameters: CertificationsV1ApiSubmitReassignCertsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CertificationsV1ApiFp(this.configuration).submitReassignCertsAsyncV1(requestParameters.id, requestParameters.reviewreassignV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/certifications/base.ts b/sdk-output/certifications/base.ts new file mode 100644 index 00000000..92758f8b --- /dev/null +++ b/sdk-output/certifications/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certifications + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/certifications/common.ts b/sdk-output/certifications/common.ts new file mode 100644 index 00000000..317bdaec --- /dev/null +++ b/sdk-output/certifications/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certifications + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/certifications/configuration.ts b/sdk-output/certifications/configuration.ts new file mode 100644 index 00000000..3ad81b37 --- /dev/null +++ b/sdk-output/certifications/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certifications + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/certifications/git_push.sh b/sdk-output/certifications/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/certifications/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/certifications/index.ts b/sdk-output/certifications/index.ts new file mode 100644 index 00000000..503e57f1 --- /dev/null +++ b/sdk-output/certifications/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Certifications + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/certifications/package.json b/sdk-output/certifications/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/certifications/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/certifications/tsconfig.json b/sdk-output/certifications/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/certifications/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/classify_source/.gitignore b/sdk-output/classify_source/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/classify_source/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/classify_source/.npmignore b/sdk-output/classify_source/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/classify_source/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/classify_source/.openapi-generator-ignore b/sdk-output/classify_source/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/classify_source/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/classify_source/.openapi-generator/FILES b/sdk-output/classify_source/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/classify_source/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/classify_source/.openapi-generator/VERSION b/sdk-output/classify_source/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/classify_source/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/classify_source/.sdk-partition b/sdk-output/classify_source/.sdk-partition new file mode 100644 index 00000000..2a6ea552 --- /dev/null +++ b/sdk-output/classify_source/.sdk-partition @@ -0,0 +1 @@ +classify-source \ No newline at end of file diff --git a/sdk-output/classify_source/README.md b/sdk-output/classify_source/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/classify_source/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/classify_source/api.ts b/sdk-output/classify_source/api.ts new file mode 100644 index 00000000..5770ec05 --- /dev/null +++ b/sdk-output/classify_source/api.ts @@ -0,0 +1,492 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Classify Source + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 + */ +export interface GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 + */ +export interface GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SendClassifyMachineAccountFromSourceV1200ResponseV1 + */ +export interface SendClassifyMachineAccountFromSourceV1200ResponseV1 { + /** + * Returns the number of all the accounts from source submitted for processing. + * @type {number} + * @memberof SendClassifyMachineAccountFromSourceV1200ResponseV1 + */ + 'Accounts submitted for processing'?: number; +} +/** + * A map containing numbers relevant to the source classification process + * @export + * @interface SourceclassificationstatusAllOfCountsV1 + */ +export interface SourceclassificationstatusAllOfCountsV1 { + /** + * total number of source accounts + * @type {number} + * @memberof SourceclassificationstatusAllOfCountsV1 + */ + 'EXPECTED': number; + /** + * number of accounts that have been sent for processing (should be the same as expected when all accounts are collected) + * @type {number} + * @memberof SourceclassificationstatusAllOfCountsV1 + */ + 'RECEIVED': number; + /** + * number of accounts that have been classified + * @type {number} + * @memberof SourceclassificationstatusAllOfCountsV1 + */ + 'COMPLETED': number; +} +/** + * + * @export + * @interface SourceclassificationstatusV1 + */ +export interface SourceclassificationstatusV1 { + /** + * Status of Classification Process + * @type {string} + * @memberof SourceclassificationstatusV1 + */ + 'status'?: SourceclassificationstatusV1StatusV1; + /** + * Time when the process was started + * @type {string} + * @memberof SourceclassificationstatusV1 + */ + 'started'?: string; + /** + * Time when the process status was last updated + * @type {string} + * @memberof SourceclassificationstatusV1 + */ + 'updated'?: string | null; + /** + * + * @type {SourceclassificationstatusAllOfCountsV1} + * @memberof SourceclassificationstatusV1 + */ + 'counts'?: SourceclassificationstatusAllOfCountsV1; +} + +export const SourceclassificationstatusV1StatusV1 = { + Started: 'STARTED', + Collected: 'COLLECTED', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED', + Terminated: 'TERMINATED' +} as const; + +export type SourceclassificationstatusV1StatusV1 = typeof SourceclassificationstatusV1StatusV1[keyof typeof SourceclassificationstatusV1StatusV1]; + + +/** + * ClassifySourceV1Api - axios parameter creator + * @export + */ +export const ClassifySourceV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Cancel classify source\'s accounts process + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteClassifyMachineAccountFromSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteClassifyMachineAccountFromSourceV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/classify` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Source accounts classification status + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getClassifyMachineAccountFromSourceStatusV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getClassifyMachineAccountFromSourceStatusV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/classify` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify source\'s all accounts + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendClassifyMachineAccountFromSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('sendClassifyMachineAccountFromSourceV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/classify` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ClassifySourceV1Api - functional programming interface + * @export + */ +export const ClassifySourceV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ClassifySourceV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Cancel classify source\'s accounts process + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteClassifyMachineAccountFromSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteClassifyMachineAccountFromSourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ClassifySourceV1Api.deleteClassifyMachineAccountFromSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Source accounts classification status + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getClassifyMachineAccountFromSourceStatusV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getClassifyMachineAccountFromSourceStatusV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ClassifySourceV1Api.getClassifyMachineAccountFromSourceStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify source\'s all accounts + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendClassifyMachineAccountFromSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccountFromSourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ClassifySourceV1Api.sendClassifyMachineAccountFromSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ClassifySourceV1Api - factory interface + * @export + */ +export const ClassifySourceV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ClassifySourceV1ApiFp(configuration) + return { + /** + * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Cancel classify source\'s accounts process + * @param {ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteClassifyMachineAccountFromSourceV1(requestParameters: ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteClassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Source accounts classification status + * @param {ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getClassifyMachineAccountFromSourceStatusV1(requestParameters: ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getClassifyMachineAccountFromSourceStatusV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify source\'s all accounts + * @param {ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendClassifyMachineAccountFromSourceV1(requestParameters: ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendClassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteClassifyMachineAccountFromSourceV1 operation in ClassifySourceV1Api. + * @export + * @interface ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request + */ +export interface ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getClassifyMachineAccountFromSourceStatusV1 operation in ClassifySourceV1Api. + * @export + * @interface ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request + */ +export interface ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request { + /** + * Source ID. + * @type {string} + * @memberof ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for sendClassifyMachineAccountFromSourceV1 operation in ClassifySourceV1Api. + * @export + * @interface ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request + */ +export interface ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1 + */ + readonly sourceId: string +} + +/** + * ClassifySourceV1Api - object-oriented interface + * @export + * @class ClassifySourceV1Api + * @extends {BaseAPI} + */ +export class ClassifySourceV1Api extends BaseAPI { + /** + * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Cancel classify source\'s accounts process + * @param {ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ClassifySourceV1Api + */ + public deleteClassifyMachineAccountFromSourceV1(requestParameters: ClassifySourceV1ApiDeleteClassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ClassifySourceV1ApiFp(this.configuration).deleteClassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Source accounts classification status + * @param {ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ClassifySourceV1Api + */ + public getClassifyMachineAccountFromSourceStatusV1(requestParameters: ClassifySourceV1ApiGetClassifyMachineAccountFromSourceStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ClassifySourceV1ApiFp(this.configuration).getClassifyMachineAccountFromSourceStatusV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify source\'s all accounts + * @param {ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ClassifySourceV1Api + */ + public sendClassifyMachineAccountFromSourceV1(requestParameters: ClassifySourceV1ApiSendClassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ClassifySourceV1ApiFp(this.configuration).sendClassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/classify_source/base.ts b/sdk-output/classify_source/base.ts new file mode 100644 index 00000000..8c81809d --- /dev/null +++ b/sdk-output/classify_source/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Classify Source + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/classify_source/common.ts b/sdk-output/classify_source/common.ts new file mode 100644 index 00000000..2fe3b74b --- /dev/null +++ b/sdk-output/classify_source/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Classify Source + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/classify_source/configuration.ts b/sdk-output/classify_source/configuration.ts new file mode 100644 index 00000000..26882687 --- /dev/null +++ b/sdk-output/classify_source/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Classify Source + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/classify_source/git_push.sh b/sdk-output/classify_source/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/classify_source/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/classify_source/index.ts b/sdk-output/classify_source/index.ts new file mode 100644 index 00000000..5089b45f --- /dev/null +++ b/sdk-output/classify_source/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Classify Source + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/classify_source/package.json b/sdk-output/classify_source/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/classify_source/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/classify_source/tsconfig.json b/sdk-output/classify_source/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/classify_source/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/configuration.ts b/sdk-output/configuration.ts index f75fdee9..5d596482 100644 --- a/sdk-output/configuration.ts +++ b/sdk-output/configuration.ts @@ -1,5 +1,5 @@ -import axios from "axios"; -import { IAxiosRetryConfig } from "axios-retry"; +import axios, { AxiosInstance } from "axios"; +import axiosRetry, { IAxiosRetryConfig } from "axios-retry"; import FormData from "form-data"; import * as fs from "fs"; import * as yaml from "js-yaml"; @@ -152,6 +152,14 @@ export class Configuration { * @memberof Configuration */ retriesConfig?: IAxiosRetryConfig; + /** + * Shared axios instance pre-configured with retry logic. + * All API classes use this instance by default. + * + * @type {AxiosInstance} + * @memberof Configuration + */ + axiosInstance: AxiosInstance; /** * Optional identifier for the application consuming this SDK (e.g. "sailpoint-cli"). * @@ -189,6 +197,9 @@ export class Configuration { formData.append("client_secret", this.clientSecret); this.accessToken = this.getAccessToken(url, formData); } + + this.axiosInstance = axios.create(); + axiosRetry(this.axiosInstance, this.retriesConfig); } private getHomeParams(): ConfigurationParameters { @@ -223,7 +234,7 @@ export class Configuration { config.clientId = jsonData.ClientId; config.clientSecret = jsonData.ClientSecret; config.tokenUrl = config.baseurl + "/oauth/token"; - config.nermBaseurl = jsonData.NERMBaseURL; + config.nermBaseurl = jsonData.NermBaseUrl ?? jsonData.NERMBaseURL; } catch (error) { console.log("unable to find config file in local directory"); } diff --git a/sdk-output/configuration_hub/.gitignore b/sdk-output/configuration_hub/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/configuration_hub/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/configuration_hub/.npmignore b/sdk-output/configuration_hub/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/configuration_hub/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/configuration_hub/.openapi-generator-ignore b/sdk-output/configuration_hub/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/configuration_hub/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/configuration_hub/.openapi-generator/FILES b/sdk-output/configuration_hub/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/configuration_hub/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/configuration_hub/.openapi-generator/VERSION b/sdk-output/configuration_hub/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/configuration_hub/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/configuration_hub/.sdk-partition b/sdk-output/configuration_hub/.sdk-partition new file mode 100644 index 00000000..67430deb --- /dev/null +++ b/sdk-output/configuration_hub/.sdk-partition @@ -0,0 +1 @@ +configuration-hub \ No newline at end of file diff --git a/sdk-output/configuration_hub/README.md b/sdk-output/configuration_hub/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/configuration_hub/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/configuration_hub/api.ts b/sdk-output/configuration_hub/api.ts new file mode 100644 index 00000000..fccd1728 --- /dev/null +++ b/sdk-output/configuration_hub/api.ts @@ -0,0 +1,2913 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Configuration Hub + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * + * @export + * @interface ApprovalcommentV1 + */ +export interface ApprovalcommentV1 { + /** + * Comment provided either by the approval requester or the approver. + * @type {string} + * @memberof ApprovalcommentV1 + */ + 'comment': string; + /** + * The time when this comment was provided. + * @type {string} + * @memberof ApprovalcommentV1 + */ + 'timestamp': string; + /** + * Name of the user that provided this comment. + * @type {string} + * @memberof ApprovalcommentV1 + */ + 'user': string; + /** + * Id of the user that provided this comment. + * @type {string} + * @memberof ApprovalcommentV1 + */ + 'id': string; + /** + * Status transition of the draft. + * @type {string} + * @memberof ApprovalcommentV1 + */ + 'changedToStatus': ApprovalcommentV1ChangedToStatusV1; +} + +export const ApprovalcommentV1ChangedToStatusV1 = { + PendingApproval: 'PENDING_APPROVAL', + Approved: 'APPROVED', + Rejected: 'REJECTED' +} as const; + +export type ApprovalcommentV1ChangedToStatusV1 = typeof ApprovalcommentV1ChangedToStatusV1[keyof typeof ApprovalcommentV1ChangedToStatusV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Backup options control what will be included in the backup. + * @export + * @interface BackupoptionsV1 + */ +export interface BackupoptionsV1 { + /** + * Object type names to be included in a Configuration Hub backup command. + * @type {Array} + * @memberof BackupoptionsV1 + */ + 'includeTypes'?: Array; + /** + * Additional options targeting specific objects related to each item in the includeTypes field. + * @type {{ [key: string]: ObjectexportimportnamesV1; }} + * @memberof BackupoptionsV1 + */ + 'objectOptions'?: { [key: string]: ObjectexportimportnamesV1; }; +} + +export const BackupoptionsV1IncludeTypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type BackupoptionsV1IncludeTypesV1 = typeof BackupoptionsV1IncludeTypesV1[keyof typeof BackupoptionsV1IncludeTypesV1]; + +/** + * + * @export + * @interface BackupresponseV1 + */ +export interface BackupresponseV1 { + /** + * Unique id assigned to this backup. + * @type {string} + * @memberof BackupresponseV1 + */ + 'jobId'?: string; + /** + * Status of the backup. + * @type {string} + * @memberof BackupresponseV1 + */ + 'status'?: BackupresponseV1StatusV1; + /** + * Type of the job, will always be BACKUP for this type of job. + * @type {string} + * @memberof BackupresponseV1 + */ + 'type'?: BackupresponseV1TypeV1; + /** + * The name of the tenant performing the upload + * @type {string} + * @memberof BackupresponseV1 + */ + 'tenant'?: string; + /** + * The name of the requester. + * @type {string} + * @memberof BackupresponseV1 + */ + 'requesterName'?: string; + /** + * Whether or not a file was created and stored for this backup. + * @type {boolean} + * @memberof BackupresponseV1 + */ + 'fileExists'?: boolean; + /** + * The time the job was started. + * @type {string} + * @memberof BackupresponseV1 + */ + 'created'?: string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof BackupresponseV1 + */ + 'modified'?: string; + /** + * The time the job was completed. + * @type {string} + * @memberof BackupresponseV1 + */ + 'completed'?: string; + /** + * The name assigned to the upload file in the request body. + * @type {string} + * @memberof BackupresponseV1 + */ + 'name'?: string; + /** + * Whether this backup can be deleted by a regular user. + * @type {boolean} + * @memberof BackupresponseV1 + */ + 'userCanDelete'?: boolean; + /** + * Whether this backup contains all supported object types or only some of them. + * @type {boolean} + * @memberof BackupresponseV1 + */ + 'isPartial'?: boolean; + /** + * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. + * @type {string} + * @memberof BackupresponseV1 + */ + 'backupType'?: BackupresponseV1BackupTypeV1; + /** + * + * @type {BackupoptionsV1} + * @memberof BackupresponseV1 + */ + 'options'?: BackupoptionsV1 | null; + /** + * Whether the object details of this backup are ready. + * @type {string} + * @memberof BackupresponseV1 + */ + 'hydrationStatus'?: BackupresponseV1HydrationStatusV1; + /** + * Number of objects contained in this backup. + * @type {number} + * @memberof BackupresponseV1 + */ + 'totalObjectCount'?: number; + /** + * Whether this backup has been transferred to a customer storage location. + * @type {string} + * @memberof BackupresponseV1 + */ + 'cloudStorageStatus'?: BackupresponseV1CloudStorageStatusV1; +} + +export const BackupresponseV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type BackupresponseV1StatusV1 = typeof BackupresponseV1StatusV1[keyof typeof BackupresponseV1StatusV1]; +export const BackupresponseV1TypeV1 = { + Backup: 'BACKUP' +} as const; + +export type BackupresponseV1TypeV1 = typeof BackupresponseV1TypeV1[keyof typeof BackupresponseV1TypeV1]; +export const BackupresponseV1BackupTypeV1 = { + Uploaded: 'UPLOADED', + Automated: 'AUTOMATED', + Manual: 'MANUAL' +} as const; + +export type BackupresponseV1BackupTypeV1 = typeof BackupresponseV1BackupTypeV1[keyof typeof BackupresponseV1BackupTypeV1]; +export const BackupresponseV1HydrationStatusV1 = { + Hydrated: 'HYDRATED', + NotHydrated: 'NOT_HYDRATED' +} as const; + +export type BackupresponseV1HydrationStatusV1 = typeof BackupresponseV1HydrationStatusV1[keyof typeof BackupresponseV1HydrationStatusV1]; +export const BackupresponseV1CloudStorageStatusV1 = { + Synced: 'SYNCED', + NotSynced: 'NOT_SYNCED', + SyncFailed: 'SYNC_FAILED' +} as const; + +export type BackupresponseV1CloudStorageStatusV1 = typeof BackupresponseV1CloudStorageStatusV1[keyof typeof BackupresponseV1CloudStorageStatusV1]; + +/** + * + * @export + * @interface CreateUploadedConfigurationV1RequestV1 + */ +export interface CreateUploadedConfigurationV1RequestV1 { + /** + * JSON file containing the objects to be imported. + * @type {File} + * @memberof CreateUploadedConfigurationV1RequestV1 + */ + 'data': File; + /** + * Name that will be assigned to the uploaded configuration file. + * @type {string} + * @memberof CreateUploadedConfigurationV1RequestV1 + */ + 'name': string; +} +/** + * + * @export + * @interface DeployrequestV1 + */ +export interface DeployrequestV1 { + /** + * The id of the draft to be used by this deploy. + * @type {string} + * @memberof DeployrequestV1 + */ + 'draftId': string; +} +/** + * + * @export + * @interface DeployresponseV1 + */ +export interface DeployresponseV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof DeployresponseV1 + */ + 'jobId'?: string; + /** + * Status of the job. + * @type {string} + * @memberof DeployresponseV1 + */ + 'status'?: DeployresponseV1StatusV1; + /** + * Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. + * @type {string} + * @memberof DeployresponseV1 + */ + 'type'?: DeployresponseV1TypeV1; + /** + * Message providing information about the outcome of the deploy process. + * @type {string} + * @memberof DeployresponseV1 + */ + 'message'?: string; + /** + * The name of the user that initiated the deploy process. + * @type {string} + * @memberof DeployresponseV1 + */ + 'requesterName'?: string; + /** + * Whether or not a results file was created and stored for this deploy. + * @type {boolean} + * @memberof DeployresponseV1 + */ + 'fileExists'?: boolean; + /** + * The time the job was started. + * @type {string} + * @memberof DeployresponseV1 + */ + 'created'?: string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof DeployresponseV1 + */ + 'modified'?: string; + /** + * The time the job was completed. + * @type {string} + * @memberof DeployresponseV1 + */ + 'completed'?: string; + /** + * The id of the draft that was used for this deploy. + * @type {string} + * @memberof DeployresponseV1 + */ + 'draftId'?: string; + /** + * The name of the draft that was used for this deploy. + * @type {string} + * @memberof DeployresponseV1 + */ + 'draftName'?: string; + /** + * Whether this deploy results file has been transferred to a customer storage location. + * @type {string} + * @memberof DeployresponseV1 + */ + 'cloudStorageStatus'?: DeployresponseV1CloudStorageStatusV1; +} + +export const DeployresponseV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type DeployresponseV1StatusV1 = typeof DeployresponseV1StatusV1[keyof typeof DeployresponseV1StatusV1]; +export const DeployresponseV1TypeV1 = { + ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' +} as const; + +export type DeployresponseV1TypeV1 = typeof DeployresponseV1TypeV1[keyof typeof DeployresponseV1TypeV1]; +export const DeployresponseV1CloudStorageStatusV1 = { + Synced: 'SYNCED', + NotSynced: 'NOT_SYNCED', + SyncFailed: 'SYNC_FAILED' +} as const; + +export type DeployresponseV1CloudStorageStatusV1 = typeof DeployresponseV1CloudStorageStatusV1[keyof typeof DeployresponseV1CloudStorageStatusV1]; + +/** + * + * @export + * @interface DraftresponseV1 + */ +export interface DraftresponseV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof DraftresponseV1 + */ + 'jobId'?: string; + /** + * Status of the job. + * @type {string} + * @memberof DraftresponseV1 + */ + 'status'?: DraftresponseV1StatusV1; + /** + * Type of the job, will always be CREATE_DRAFT for this type of job. + * @type {string} + * @memberof DraftresponseV1 + */ + 'type'?: DraftresponseV1TypeV1; + /** + * Message providing information about the outcome of the draft process. + * @type {string} + * @memberof DraftresponseV1 + */ + 'message'?: string; + /** + * The name of user that that initiated the draft process. + * @type {string} + * @memberof DraftresponseV1 + */ + 'requesterName'?: string; + /** + * Whether or not a file was generated for this draft. + * @type {boolean} + * @memberof DraftresponseV1 + */ + 'fileExists'?: boolean; + /** + * The time the job was started. + * @type {string} + * @memberof DraftresponseV1 + */ + 'created'?: string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof DraftresponseV1 + */ + 'modified'?: string; + /** + * The time the job was completed. + * @type {string} + * @memberof DraftresponseV1 + */ + 'completed'?: string; + /** + * Name of the draft. + * @type {string} + * @memberof DraftresponseV1 + */ + 'name'?: string; + /** + * Tenant owner of the backup from which the draft was generated. + * @type {string} + * @memberof DraftresponseV1 + */ + 'sourceTenant'?: string; + /** + * Id of the backup from which the draft was generated. + * @type {string} + * @memberof DraftresponseV1 + */ + 'sourceBackupId'?: string; + /** + * Name of the backup from which the draft was generated. + * @type {string} + * @memberof DraftresponseV1 + */ + 'sourceBackupName'?: string; + /** + * Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. + * @type {string} + * @memberof DraftresponseV1 + */ + 'mode'?: DraftresponseV1ModeV1; + /** + * Approval status of the draft used to determine whether or not the draft can be deployed. + * @type {string} + * @memberof DraftresponseV1 + */ + 'approvalStatus'?: DraftresponseV1ApprovalStatusV1; + /** + * List of comments that have been exchanged between an approval requester and an approver. + * @type {Array} + * @memberof DraftresponseV1 + */ + 'approvalComment'?: Array; +} + +export const DraftresponseV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type DraftresponseV1StatusV1 = typeof DraftresponseV1StatusV1[keyof typeof DraftresponseV1StatusV1]; +export const DraftresponseV1TypeV1 = { + CreateDraft: 'CREATE_DRAFT' +} as const; + +export type DraftresponseV1TypeV1 = typeof DraftresponseV1TypeV1[keyof typeof DraftresponseV1TypeV1]; +export const DraftresponseV1ModeV1 = { + Restore: 'RESTORE', + Promote: 'PROMOTE', + Upload: 'UPLOAD' +} as const; + +export type DraftresponseV1ModeV1 = typeof DraftresponseV1ModeV1[keyof typeof DraftresponseV1ModeV1]; +export const DraftresponseV1ApprovalStatusV1 = { + Default: 'DEFAULT', + PendingApproval: 'PENDING_APPROVAL', + Approved: 'APPROVED', + Denied: 'DENIED' +} as const; + +export type DraftresponseV1ApprovalStatusV1 = typeof DraftresponseV1ApprovalStatusV1[keyof typeof DraftresponseV1ApprovalStatusV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetObjectMappingsV1401ResponseV1 + */ +export interface GetObjectMappingsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetObjectMappingsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetObjectMappingsV1429ResponseV1 + */ +export interface GetObjectMappingsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetObjectMappingsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchV1 + */ +export interface JsonpatchV1 { + /** + * Operations to be applied + * @type {Array} + * @memberof JsonpatchV1 + */ + 'operations'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListDeploysV1200ResponseV1 + */ +export interface ListDeploysV1200ResponseV1 { + /** + * list of deployments + * @type {Array} + * @memberof ListDeploysV1200ResponseV1 + */ + 'items'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ObjectexportimportnamesV1 + */ +export interface ObjectexportimportnamesV1 { + /** + * Object names to be included in a backup. + * @type {Array} + * @memberof ObjectexportimportnamesV1 + */ + 'includedNames'?: Array; +} +/** + * + * @export + * @interface ObjectmappingbulkcreaterequestV1 + */ +export interface ObjectmappingbulkcreaterequestV1 { + /** + * + * @type {Array} + * @memberof ObjectmappingbulkcreaterequestV1 + */ + 'newObjectsMappings': Array; +} +/** + * + * @export + * @interface ObjectmappingbulkcreateresponseV1 + */ +export interface ObjectmappingbulkcreateresponseV1 { + /** + * + * @type {Array} + * @memberof ObjectmappingbulkcreateresponseV1 + */ + 'addedObjects'?: Array; +} +/** + * + * @export + * @interface ObjectmappingbulkpatchrequestV1 + */ +export interface ObjectmappingbulkpatchrequestV1 { + /** + * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. + * @type {{ [key: string]: Array; }} + * @memberof ObjectmappingbulkpatchrequestV1 + */ + 'patches': { [key: string]: Array; }; +} +/** + * + * @export + * @interface ObjectmappingbulkpatchresponseV1 + */ +export interface ObjectmappingbulkpatchresponseV1 { + /** + * + * @type {Array} + * @memberof ObjectmappingbulkpatchresponseV1 + */ + 'patchedObjects'?: Array; +} +/** + * + * @export + * @interface ObjectmappingrequestV1 + */ +export interface ObjectmappingrequestV1 { + /** + * Type of the object the mapping value applies to, must be one from enum + * @type {string} + * @memberof ObjectmappingrequestV1 + */ + 'objectType': ObjectmappingrequestV1ObjectTypeV1; + /** + * JSONPath expression denoting the path within the object where the mapping value should be applied + * @type {string} + * @memberof ObjectmappingrequestV1 + */ + 'jsonPath': string; + /** + * Original value at the jsonPath location within the object + * @type {string} + * @memberof ObjectmappingrequestV1 + */ + 'sourceValue': string; + /** + * Value to be assigned at the jsonPath location within the object + * @type {string} + * @memberof ObjectmappingrequestV1 + */ + 'targetValue': string; + /** + * Whether or not this object mapping is enabled + * @type {boolean} + * @memberof ObjectmappingrequestV1 + */ + 'enabled'?: boolean; +} + +export const ObjectmappingrequestV1ObjectTypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + Entitlement: 'ENTITLEMENT', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ObjectmappingrequestV1ObjectTypeV1 = typeof ObjectmappingrequestV1ObjectTypeV1[keyof typeof ObjectmappingrequestV1ObjectTypeV1]; + +/** + * + * @export + * @interface ObjectmappingresponseV1 + */ +export interface ObjectmappingresponseV1 { + /** + * Id of the object mapping + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'objectMappingId'?: string; + /** + * Type of the object the mapping value applies to + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'objectType'?: ObjectmappingresponseV1ObjectTypeV1; + /** + * JSONPath expression denoting the path within the object where the mapping value should be applied + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'jsonPath'?: string; + /** + * Original value at the jsonPath location within the object + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'sourceValue'?: string; + /** + * Value to be assigned at the jsonPath location within the object + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'targetValue'?: string; + /** + * Whether or not this object mapping is enabled + * @type {boolean} + * @memberof ObjectmappingresponseV1 + */ + 'enabled'?: boolean; + /** + * Object mapping creation timestamp + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'created'?: string; + /** + * Object mapping latest update timestamp + * @type {string} + * @memberof ObjectmappingresponseV1 + */ + 'modified'?: string; +} + +export const ObjectmappingresponseV1ObjectTypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + Entitlement: 'ENTITLEMENT', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ObjectmappingresponseV1ObjectTypeV1 = typeof ObjectmappingresponseV1ObjectTypeV1[keyof typeof ObjectmappingresponseV1ObjectTypeV1]; + +/** + * Options for BACKUP type jobs. Required for BACKUP jobs. + * @export + * @interface ScheduledactionpayloadContentBackupOptionsV1 + */ +export interface ScheduledactionpayloadContentBackupOptionsV1 { + /** + * Object types that are to be included in the backup. + * @type {Array} + * @memberof ScheduledactionpayloadContentBackupOptionsV1 + */ + 'includeTypes'?: Array; + /** + * Map of objectType string to the options to be passed to the target service for that objectType. + * @type {{ [key: string]: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1; }} + * @memberof ScheduledactionpayloadContentBackupOptionsV1 + */ + 'objectOptions'?: { [key: string]: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1; }; +} +/** + * + * @export + * @interface ScheduledactionpayloadContentV1 + */ +export interface ScheduledactionpayloadContentV1 { + /** + * Name of the scheduled action (maximum 50 characters). + * @type {string} + * @memberof ScheduledactionpayloadContentV1 + */ + 'name': string; + /** + * + * @type {ScheduledactionpayloadContentBackupOptionsV1} + * @memberof ScheduledactionpayloadContentV1 + */ + 'backupOptions'?: ScheduledactionpayloadContentBackupOptionsV1; + /** + * ID of the source backup. Required for CREATE_DRAFT jobs. + * @type {string} + * @memberof ScheduledactionpayloadContentV1 + */ + 'sourceBackupId'?: string; + /** + * Source tenant identifier. Required for CREATE_DRAFT jobs. + * @type {string} + * @memberof ScheduledactionpayloadContentV1 + */ + 'sourceTenant'?: string; + /** + * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. + * @type {string} + * @memberof ScheduledactionpayloadContentV1 + */ + 'draftId'?: string; +} +/** + * + * @export + * @interface ScheduledactionpayloadV1 + */ +export interface ScheduledactionpayloadV1 { + /** + * Type of the scheduled job. + * @type {string} + * @memberof ScheduledactionpayloadV1 + */ + 'jobType': ScheduledactionpayloadV1JobTypeV1; + /** + * The time when this scheduled action should start. Optional. + * @type {string} + * @memberof ScheduledactionpayloadV1 + */ + 'startTime'?: string; + /** + * Cron expression defining the schedule for this action. Optional for repeated events. + * @type {string} + * @memberof ScheduledactionpayloadV1 + */ + 'cronString'?: string; + /** + * Time zone ID for interpreting the cron expression. Optional, will default to current time zone. + * @type {string} + * @memberof ScheduledactionpayloadV1 + */ + 'timeZoneId'?: string; + /** + * + * @type {ScheduledactionpayloadContentV1} + * @memberof ScheduledactionpayloadV1 + */ + 'content': ScheduledactionpayloadContentV1; +} + +export const ScheduledactionpayloadV1JobTypeV1 = { + Backup: 'BACKUP', + CreateDraft: 'CREATE_DRAFT', + ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' +} as const; + +export type ScheduledactionpayloadV1JobTypeV1 = typeof ScheduledactionpayloadV1JobTypeV1[keyof typeof ScheduledactionpayloadV1JobTypeV1]; + +/** + * + * @export + * @interface ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 + */ +export interface ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 { + /** + * Set of names to be included. + * @type {Array} + * @memberof ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 + */ + 'includedNames'?: Array; +} +/** + * Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. + * @export + * @interface ScheduledactionresponseContentBackupOptionsV1 + */ +export interface ScheduledactionresponseContentBackupOptionsV1 { + /** + * Object types that are to be included in the backup. + * @type {Array} + * @memberof ScheduledactionresponseContentBackupOptionsV1 + */ + 'includeTypes'?: Array; + /** + * Map of objectType string to the options to be passed to the target service for that objectType. + * @type {{ [key: string]: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1; }} + * @memberof ScheduledactionresponseContentBackupOptionsV1 + */ + 'objectOptions'?: { [key: string]: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1; }; +} +/** + * Content details for the scheduled action. + * @export + * @interface ScheduledactionresponseContentV1 + */ +export interface ScheduledactionresponseContentV1 { + /** + * Name of the scheduled action (maximum 50 characters). + * @type {string} + * @memberof ScheduledactionresponseContentV1 + */ + 'name'?: string; + /** + * + * @type {ScheduledactionresponseContentBackupOptionsV1} + * @memberof ScheduledactionresponseContentV1 + */ + 'backupOptions'?: ScheduledactionresponseContentBackupOptionsV1; + /** + * ID of the source backup. Required for CREATE_DRAFT jobs only. + * @type {string} + * @memberof ScheduledactionresponseContentV1 + */ + 'sourceBackupId'?: string; + /** + * Source tenant identifier. Required for CREATE_DRAFT jobs only. + * @type {string} + * @memberof ScheduledactionresponseContentV1 + */ + 'sourceTenant'?: string; + /** + * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. + * @type {string} + * @memberof ScheduledactionresponseContentV1 + */ + 'draftId'?: string; +} +/** + * + * @export + * @interface ScheduledactionresponseV1 + */ +export interface ScheduledactionresponseV1 { + /** + * Unique identifier for this scheduled action. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'id'?: string; + /** + * The time when this scheduled action was created. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'created'?: string; + /** + * Type of the scheduled job. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'jobType'?: ScheduledactionresponseV1JobTypeV1; + /** + * + * @type {ScheduledactionresponseContentV1} + * @memberof ScheduledactionresponseV1 + */ + 'content'?: ScheduledactionresponseContentV1; + /** + * The time when this scheduled action should start. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'startTime'?: string; + /** + * Cron expression defining the schedule for this action. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'cronString'?: string; + /** + * Time zone ID for interpreting the cron expression. + * @type {string} + * @memberof ScheduledactionresponseV1 + */ + 'timeZoneId'?: string; +} + +export const ScheduledactionresponseV1JobTypeV1 = { + Backup: 'BACKUP', + CreateDraft: 'CREATE_DRAFT', + ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' +} as const; + +export type ScheduledactionresponseV1JobTypeV1 = typeof ScheduledactionresponseV1JobTypeV1[keyof typeof ScheduledactionresponseV1JobTypeV1]; + + +/** + * ConfigurationHubV1Api - axios parameter creator + * @export + */ +export const ConfigurationHubV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API performs a deploy based on an existing daft. + * @summary Create a deploy + * @param {DeployrequestV1} deployrequestV1 The deploy request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDeployV1: async (deployrequestV1: DeployrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'deployrequestV1' is not null or undefined + assertParamExists('createDeployV1', 'deployrequestV1', deployrequestV1) + const localVarPath = `/configuration-hub/v1/deploys`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deployrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Creates an object mapping + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingrequestV1} objectmappingrequestV1 The object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createObjectMappingV1: async (sourceOrg: string, objectmappingrequestV1: ObjectmappingrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceOrg' is not null or undefined + assertParamExists('createObjectMappingV1', 'sourceOrg', sourceOrg) + // verify required parameter 'objectmappingrequestV1' is not null or undefined + assertParamExists('createObjectMappingV1', 'objectmappingrequestV1', objectmappingrequestV1) + const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}` + .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(objectmappingrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk creates object mappings + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingbulkcreaterequestV1} objectmappingbulkcreaterequestV1 The bulk create object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createObjectMappingsV1: async (sourceOrg: string, objectmappingbulkcreaterequestV1: ObjectmappingbulkcreaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceOrg' is not null or undefined + assertParamExists('createObjectMappingsV1', 'sourceOrg', sourceOrg) + // verify required parameter 'objectmappingbulkcreaterequestV1' is not null or undefined + assertParamExists('createObjectMappingsV1', 'objectmappingbulkcreaterequestV1', objectmappingbulkcreaterequestV1) + const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-create` + .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(objectmappingbulkcreaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API creates a new scheduled action for the current tenant. + * @summary Create scheduled action + * @param {ScheduledactionpayloadV1} scheduledactionpayloadV1 The scheduled action creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduledActionV1: async (scheduledactionpayloadV1: ScheduledactionpayloadV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scheduledactionpayloadV1' is not null or undefined + assertParamExists('createScheduledActionV1', 'scheduledactionpayloadV1', scheduledactionpayloadV1) + const localVarPath = `/configuration-hub/v1/scheduled-actions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(scheduledactionpayloadV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. + * @summary Upload a configuration + * @param {File} data JSON file containing the objects to be imported. + * @param {string} name Name that will be assigned to the uploaded configuration file. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createUploadedConfigurationV1: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'data' is not null or undefined + assertParamExists('createUploadedConfigurationV1', 'data', data) + // verify required parameter 'name' is not null or undefined + assertParamExists('createUploadedConfigurationV1', 'name', name) + const localVarPath = `/configuration-hub/v1/backups/uploads`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (data !== undefined) { + localVarFormParams.append('data', data as any); + } + + if (name !== undefined) { + localVarFormParams.append('name', name as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + * @summary Delete a backup + * @param {string} id The id of the backup to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBackupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteBackupV1', 'id', id) + const localVarPath = `/configuration-hub/v1/backups/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + * @summary Delete a draft + * @param {string} id The id of the draft to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDraftV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteDraftV1', 'id', id) + const localVarPath = `/configuration-hub/v1/drafts/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Deletes an object mapping + * @param {string} sourceOrg The name of the source org. + * @param {string} objectMappingId The id of the object mapping to be deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteObjectMappingV1: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceOrg' is not null or undefined + assertParamExists('deleteObjectMappingV1', 'sourceOrg', sourceOrg) + // verify required parameter 'objectMappingId' is not null or undefined + assertParamExists('deleteObjectMappingV1', 'objectMappingId', objectMappingId) + const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/{objectMappingId}` + .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) + .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes an existing scheduled action. + * @summary Delete scheduled action + * @param {string} id The ID of the scheduled action. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduledActionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteScheduledActionV1', 'id', id) + const localVarPath = `/configuration-hub/v1/scheduled-actions/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + * @summary Delete an uploaded configuration + * @param {string} id The id of the uploaded configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteUploadedConfigurationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteUploadedConfigurationV1', 'id', id) + const localVarPath = `/configuration-hub/v1/backups/uploads/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets an existing deploy for the current tenant. + * @summary Get a deploy + * @param {string} id The id of the deploy. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDeployV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getDeployV1', 'id', id) + const localVarPath = `/configuration-hub/v1/deploys/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read + * @summary Gets list of object mappings + * @param {string} sourceOrg The name of the source org. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getObjectMappingsV1: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceOrg' is not null or undefined + assertParamExists('getObjectMappingsV1', 'sourceOrg', sourceOrg) + const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}` + .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets an existing uploaded configuration for the current tenant. + * @summary Get an uploaded configuration + * @param {string} id The id of the uploaded configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUploadedConfigurationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getUploadedConfigurationV1', 'id', id) + const localVarPath = `/configuration-hub/v1/backups/uploads/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of existing backups for the current tenant. + * @summary List backups + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listBackupsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/configuration-hub/v1/backups`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of deploys for the current tenant. + * @summary List deploys + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDeploysV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/configuration-hub/v1/deploys`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of existing drafts for the current tenant. + * @summary List drafts + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDraftsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/configuration-hub/v1/drafts`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of existing scheduled actions for the current tenant. + * @summary List scheduled actions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listScheduledActionsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/configuration-hub/v1/scheduled-actions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets a list of existing uploaded configurations for the current tenant. + * @summary List uploaded configurations + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUploadedConfigurationsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/configuration-hub/v1/backups/uploads`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk updates object mappings + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingbulkpatchrequestV1} objectmappingbulkpatchrequestV1 The object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateObjectMappingsV1: async (sourceOrg: string, objectmappingbulkpatchrequestV1: ObjectmappingbulkpatchrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceOrg' is not null or undefined + assertParamExists('updateObjectMappingsV1', 'sourceOrg', sourceOrg) + // verify required parameter 'objectmappingbulkpatchrequestV1' is not null or undefined + assertParamExists('updateObjectMappingsV1', 'objectmappingbulkpatchrequestV1', objectmappingbulkpatchrequestV1) + const localVarPath = `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-patch` + .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(objectmappingbulkpatchrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing scheduled action using JSON Patch format. + * @summary Update scheduled action + * @param {string} id The ID of the scheduled action. + * @param {JsonpatchV1} jsonpatchV1 The JSON Patch document containing the changes to apply to the scheduled action. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateScheduledActionV1: async (id: string, jsonpatchV1: JsonpatchV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateScheduledActionV1', 'id', id) + // verify required parameter 'jsonpatchV1' is not null or undefined + assertParamExists('updateScheduledActionV1', 'jsonpatchV1', jsonpatchV1) + const localVarPath = `/configuration-hub/v1/scheduled-actions/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ConfigurationHubV1Api - functional programming interface + * @export + */ +export const ConfigurationHubV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ConfigurationHubV1ApiAxiosParamCreator(configuration) + return { + /** + * This API performs a deploy based on an existing daft. + * @summary Create a deploy + * @param {DeployrequestV1} deployrequestV1 The deploy request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createDeployV1(deployrequestV1: DeployrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDeployV1(deployrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.createDeployV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Creates an object mapping + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingrequestV1} objectmappingrequestV1 The object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createObjectMappingV1(sourceOrg: string, objectmappingrequestV1: ObjectmappingrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappingV1(sourceOrg, objectmappingrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.createObjectMappingV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk creates object mappings + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingbulkcreaterequestV1} objectmappingbulkcreaterequestV1 The bulk create object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createObjectMappingsV1(sourceOrg: string, objectmappingbulkcreaterequestV1: ObjectmappingbulkcreaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappingsV1(sourceOrg, objectmappingbulkcreaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.createObjectMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API creates a new scheduled action for the current tenant. + * @summary Create scheduled action + * @param {ScheduledactionpayloadV1} scheduledactionpayloadV1 The scheduled action creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createScheduledActionV1(scheduledactionpayloadV1: ScheduledactionpayloadV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledActionV1(scheduledactionpayloadV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.createScheduledActionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. + * @summary Upload a configuration + * @param {File} data JSON file containing the objects to be imported. + * @param {string} name Name that will be assigned to the uploaded configuration file. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createUploadedConfigurationV1(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfigurationV1(data, name, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.createUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + * @summary Delete a backup + * @param {string} id The id of the backup to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteBackupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBackupV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.deleteBackupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + * @summary Delete a draft + * @param {string} id The id of the draft to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteDraftV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDraftV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.deleteDraftV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Deletes an object mapping + * @param {string} sourceOrg The name of the source org. + * @param {string} objectMappingId The id of the object mapping to be deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteObjectMappingV1(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMappingV1(sourceOrg, objectMappingId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.deleteObjectMappingV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes an existing scheduled action. + * @summary Delete scheduled action + * @param {string} id The ID of the scheduled action. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteScheduledActionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledActionV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.deleteScheduledActionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + * @summary Delete an uploaded configuration + * @param {string} id The id of the uploaded configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteUploadedConfigurationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfigurationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.deleteUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets an existing deploy for the current tenant. + * @summary Get a deploy + * @param {string} id The id of the deploy. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDeployV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDeployV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.getDeployV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read + * @summary Gets list of object mappings + * @param {string} sourceOrg The name of the source org. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getObjectMappingsV1(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappingsV1(sourceOrg, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.getObjectMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets an existing uploaded configuration for the current tenant. + * @summary Get an uploaded configuration + * @param {string} id The id of the uploaded configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getUploadedConfigurationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfigurationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.getUploadedConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of existing backups for the current tenant. + * @summary List backups + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listBackupsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listBackupsV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.listBackupsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of deploys for the current tenant. + * @summary List deploys + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listDeploysV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDeploysV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.listDeploysV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of existing drafts for the current tenant. + * @summary List drafts + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listDraftsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDraftsV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.listDraftsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of existing scheduled actions for the current tenant. + * @summary List scheduled actions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledActionsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.listScheduledActionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a list of existing uploaded configurations for the current tenant. + * @summary List uploaded configurations + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listUploadedConfigurationsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurationsV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.listUploadedConfigurationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk updates object mappings + * @param {string} sourceOrg The name of the source org. + * @param {ObjectmappingbulkpatchrequestV1} objectmappingbulkpatchrequestV1 The object mapping request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateObjectMappingsV1(sourceOrg: string, objectmappingbulkpatchrequestV1: ObjectmappingbulkpatchrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappingsV1(sourceOrg, objectmappingbulkpatchrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.updateObjectMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing scheduled action using JSON Patch format. + * @summary Update scheduled action + * @param {string} id The ID of the scheduled action. + * @param {JsonpatchV1} jsonpatchV1 The JSON Patch document containing the changes to apply to the scheduled action. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateScheduledActionV1(id: string, jsonpatchV1: JsonpatchV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledActionV1(id, jsonpatchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV1Api.updateScheduledActionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ConfigurationHubV1Api - factory interface + * @export + */ +export const ConfigurationHubV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ConfigurationHubV1ApiFp(configuration) + return { + /** + * This API performs a deploy based on an existing daft. + * @summary Create a deploy + * @param {ConfigurationHubV1ApiCreateDeployV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDeployV1(requestParameters: ConfigurationHubV1ApiCreateDeployV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDeployV1(requestParameters.deployrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Creates an object mapping + * @param {ConfigurationHubV1ApiCreateObjectMappingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createObjectMappingV1(requestParameters: ConfigurationHubV1ApiCreateObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectmappingrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk creates object mappings + * @param {ConfigurationHubV1ApiCreateObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createObjectMappingsV1(requestParameters: ConfigurationHubV1ApiCreateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectmappingbulkcreaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API creates a new scheduled action for the current tenant. + * @summary Create scheduled action + * @param {ConfigurationHubV1ApiCreateScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduledActionV1(requestParameters: ConfigurationHubV1ApiCreateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createScheduledActionV1(requestParameters.scheduledactionpayloadV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. + * @summary Upload a configuration + * @param {ConfigurationHubV1ApiCreateUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiCreateUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createUploadedConfigurationV1(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + * @summary Delete a backup + * @param {ConfigurationHubV1ApiDeleteBackupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBackupV1(requestParameters: ConfigurationHubV1ApiDeleteBackupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteBackupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + * @summary Delete a draft + * @param {ConfigurationHubV1ApiDeleteDraftV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDraftV1(requestParameters: ConfigurationHubV1ApiDeleteDraftV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteDraftV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Deletes an object mapping + * @param {ConfigurationHubV1ApiDeleteObjectMappingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteObjectMappingV1(requestParameters: ConfigurationHubV1ApiDeleteObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes an existing scheduled action. + * @summary Delete scheduled action + * @param {ConfigurationHubV1ApiDeleteScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduledActionV1(requestParameters: ConfigurationHubV1ApiDeleteScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteScheduledActionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + * @summary Delete an uploaded configuration + * @param {ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets an existing deploy for the current tenant. + * @summary Get a deploy + * @param {ConfigurationHubV1ApiGetDeployV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDeployV1(requestParameters: ConfigurationHubV1ApiGetDeployV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDeployV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read + * @summary Gets list of object mappings + * @param {ConfigurationHubV1ApiGetObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getObjectMappingsV1(requestParameters: ConfigurationHubV1ApiGetObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getObjectMappingsV1(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets an existing uploaded configuration for the current tenant. + * @summary Get an uploaded configuration + * @param {ConfigurationHubV1ApiGetUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiGetUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of existing backups for the current tenant. + * @summary List backups + * @param {ConfigurationHubV1ApiListBackupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listBackupsV1(requestParameters: ConfigurationHubV1ApiListBackupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listBackupsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of deploys for the current tenant. + * @summary List deploys + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDeploysV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listDeploysV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of existing drafts for the current tenant. + * @summary List drafts + * @param {ConfigurationHubV1ApiListDraftsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDraftsV1(requestParameters: ConfigurationHubV1ApiListDraftsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listDraftsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of existing scheduled actions for the current tenant. + * @summary List scheduled actions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listScheduledActionsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a list of existing uploaded configurations for the current tenant. + * @summary List uploaded configurations + * @param {ConfigurationHubV1ApiListUploadedConfigurationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUploadedConfigurationsV1(requestParameters: ConfigurationHubV1ApiListUploadedConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listUploadedConfigurationsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk updates object mappings + * @param {ConfigurationHubV1ApiUpdateObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateObjectMappingsV1(requestParameters: ConfigurationHubV1ApiUpdateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectmappingbulkpatchrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing scheduled action using JSON Patch format. + * @summary Update scheduled action + * @param {ConfigurationHubV1ApiUpdateScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateScheduledActionV1(requestParameters: ConfigurationHubV1ApiUpdateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateScheduledActionV1(requestParameters.id, requestParameters.jsonpatchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDeployV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiCreateDeployV1Request + */ +export interface ConfigurationHubV1ApiCreateDeployV1Request { + /** + * The deploy request body. + * @type {DeployrequestV1} + * @memberof ConfigurationHubV1ApiCreateDeployV1 + */ + readonly deployrequestV1: DeployrequestV1 +} + +/** + * Request parameters for createObjectMappingV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiCreateObjectMappingV1Request + */ +export interface ConfigurationHubV1ApiCreateObjectMappingV1Request { + /** + * The name of the source org. + * @type {string} + * @memberof ConfigurationHubV1ApiCreateObjectMappingV1 + */ + readonly sourceOrg: string + + /** + * The object mapping request body. + * @type {ObjectmappingrequestV1} + * @memberof ConfigurationHubV1ApiCreateObjectMappingV1 + */ + readonly objectmappingrequestV1: ObjectmappingrequestV1 +} + +/** + * Request parameters for createObjectMappingsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiCreateObjectMappingsV1Request + */ +export interface ConfigurationHubV1ApiCreateObjectMappingsV1Request { + /** + * The name of the source org. + * @type {string} + * @memberof ConfigurationHubV1ApiCreateObjectMappingsV1 + */ + readonly sourceOrg: string + + /** + * The bulk create object mapping request body. + * @type {ObjectmappingbulkcreaterequestV1} + * @memberof ConfigurationHubV1ApiCreateObjectMappingsV1 + */ + readonly objectmappingbulkcreaterequestV1: ObjectmappingbulkcreaterequestV1 +} + +/** + * Request parameters for createScheduledActionV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiCreateScheduledActionV1Request + */ +export interface ConfigurationHubV1ApiCreateScheduledActionV1Request { + /** + * The scheduled action creation request body. + * @type {ScheduledactionpayloadV1} + * @memberof ConfigurationHubV1ApiCreateScheduledActionV1 + */ + readonly scheduledactionpayloadV1: ScheduledactionpayloadV1 +} + +/** + * Request parameters for createUploadedConfigurationV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiCreateUploadedConfigurationV1Request + */ +export interface ConfigurationHubV1ApiCreateUploadedConfigurationV1Request { + /** + * JSON file containing the objects to be imported. + * @type {File} + * @memberof ConfigurationHubV1ApiCreateUploadedConfigurationV1 + */ + readonly data: File + + /** + * Name that will be assigned to the uploaded configuration file. + * @type {string} + * @memberof ConfigurationHubV1ApiCreateUploadedConfigurationV1 + */ + readonly name: string +} + +/** + * Request parameters for deleteBackupV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiDeleteBackupV1Request + */ +export interface ConfigurationHubV1ApiDeleteBackupV1Request { + /** + * The id of the backup to delete. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteBackupV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteDraftV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiDeleteDraftV1Request + */ +export interface ConfigurationHubV1ApiDeleteDraftV1Request { + /** + * The id of the draft to delete. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteDraftV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteObjectMappingV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiDeleteObjectMappingV1Request + */ +export interface ConfigurationHubV1ApiDeleteObjectMappingV1Request { + /** + * The name of the source org. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteObjectMappingV1 + */ + readonly sourceOrg: string + + /** + * The id of the object mapping to be deleted. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteObjectMappingV1 + */ + readonly objectMappingId: string +} + +/** + * Request parameters for deleteScheduledActionV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiDeleteScheduledActionV1Request + */ +export interface ConfigurationHubV1ApiDeleteScheduledActionV1Request { + /** + * The ID of the scheduled action. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteScheduledActionV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteUploadedConfigurationV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request + */ +export interface ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request { + /** + * The id of the uploaded configuration. + * @type {string} + * @memberof ConfigurationHubV1ApiDeleteUploadedConfigurationV1 + */ + readonly id: string +} + +/** + * Request parameters for getDeployV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiGetDeployV1Request + */ +export interface ConfigurationHubV1ApiGetDeployV1Request { + /** + * The id of the deploy. + * @type {string} + * @memberof ConfigurationHubV1ApiGetDeployV1 + */ + readonly id: string +} + +/** + * Request parameters for getObjectMappingsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiGetObjectMappingsV1Request + */ +export interface ConfigurationHubV1ApiGetObjectMappingsV1Request { + /** + * The name of the source org. + * @type {string} + * @memberof ConfigurationHubV1ApiGetObjectMappingsV1 + */ + readonly sourceOrg: string +} + +/** + * Request parameters for getUploadedConfigurationV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiGetUploadedConfigurationV1Request + */ +export interface ConfigurationHubV1ApiGetUploadedConfigurationV1Request { + /** + * The id of the uploaded configuration. + * @type {string} + * @memberof ConfigurationHubV1ApiGetUploadedConfigurationV1 + */ + readonly id: string +} + +/** + * Request parameters for listBackupsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiListBackupsV1Request + */ +export interface ConfigurationHubV1ApiListBackupsV1Request { + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @type {string} + * @memberof ConfigurationHubV1ApiListBackupsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listDraftsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiListDraftsV1Request + */ +export interface ConfigurationHubV1ApiListDraftsV1Request { + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* + * @type {string} + * @memberof ConfigurationHubV1ApiListDraftsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listUploadedConfigurationsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiListUploadedConfigurationsV1Request + */ +export interface ConfigurationHubV1ApiListUploadedConfigurationsV1Request { + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + * @type {string} + * @memberof ConfigurationHubV1ApiListUploadedConfigurationsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for updateObjectMappingsV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiUpdateObjectMappingsV1Request + */ +export interface ConfigurationHubV1ApiUpdateObjectMappingsV1Request { + /** + * The name of the source org. + * @type {string} + * @memberof ConfigurationHubV1ApiUpdateObjectMappingsV1 + */ + readonly sourceOrg: string + + /** + * The object mapping request body. + * @type {ObjectmappingbulkpatchrequestV1} + * @memberof ConfigurationHubV1ApiUpdateObjectMappingsV1 + */ + readonly objectmappingbulkpatchrequestV1: ObjectmappingbulkpatchrequestV1 +} + +/** + * Request parameters for updateScheduledActionV1 operation in ConfigurationHubV1Api. + * @export + * @interface ConfigurationHubV1ApiUpdateScheduledActionV1Request + */ +export interface ConfigurationHubV1ApiUpdateScheduledActionV1Request { + /** + * The ID of the scheduled action. + * @type {string} + * @memberof ConfigurationHubV1ApiUpdateScheduledActionV1 + */ + readonly id: string + + /** + * The JSON Patch document containing the changes to apply to the scheduled action. + * @type {JsonpatchV1} + * @memberof ConfigurationHubV1ApiUpdateScheduledActionV1 + */ + readonly jsonpatchV1: JsonpatchV1 +} + +/** + * ConfigurationHubV1Api - object-oriented interface + * @export + * @class ConfigurationHubV1Api + * @extends {BaseAPI} + */ +export class ConfigurationHubV1Api extends BaseAPI { + /** + * This API performs a deploy based on an existing daft. + * @summary Create a deploy + * @param {ConfigurationHubV1ApiCreateDeployV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public createDeployV1(requestParameters: ConfigurationHubV1ApiCreateDeployV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).createDeployV1(requestParameters.deployrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Creates an object mapping + * @param {ConfigurationHubV1ApiCreateObjectMappingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public createObjectMappingV1(requestParameters: ConfigurationHubV1ApiCreateObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).createObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectmappingrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk creates object mappings + * @param {ConfigurationHubV1ApiCreateObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public createObjectMappingsV1(requestParameters: ConfigurationHubV1ApiCreateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).createObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectmappingbulkcreaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API creates a new scheduled action for the current tenant. + * @summary Create scheduled action + * @param {ConfigurationHubV1ApiCreateScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public createScheduledActionV1(requestParameters: ConfigurationHubV1ApiCreateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).createScheduledActionV1(requestParameters.scheduledactionpayloadV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. + * @summary Upload a configuration + * @param {ConfigurationHubV1ApiCreateUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public createUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiCreateUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).createUploadedConfigurationV1(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + * @summary Delete a backup + * @param {ConfigurationHubV1ApiDeleteBackupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public deleteBackupV1(requestParameters: ConfigurationHubV1ApiDeleteBackupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).deleteBackupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + * @summary Delete a draft + * @param {ConfigurationHubV1ApiDeleteDraftV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public deleteDraftV1(requestParameters: ConfigurationHubV1ApiDeleteDraftV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).deleteDraftV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Deletes an object mapping + * @param {ConfigurationHubV1ApiDeleteObjectMappingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public deleteObjectMappingV1(requestParameters: ConfigurationHubV1ApiDeleteObjectMappingV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).deleteObjectMappingV1(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes an existing scheduled action. + * @summary Delete scheduled action + * @param {ConfigurationHubV1ApiDeleteScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public deleteScheduledActionV1(requestParameters: ConfigurationHubV1ApiDeleteScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).deleteScheduledActionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + * @summary Delete an uploaded configuration + * @param {ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public deleteUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiDeleteUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).deleteUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets an existing deploy for the current tenant. + * @summary Get a deploy + * @param {ConfigurationHubV1ApiGetDeployV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public getDeployV1(requestParameters: ConfigurationHubV1ApiGetDeployV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).getDeployV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read + * @summary Gets list of object mappings + * @param {ConfigurationHubV1ApiGetObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public getObjectMappingsV1(requestParameters: ConfigurationHubV1ApiGetObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).getObjectMappingsV1(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets an existing uploaded configuration for the current tenant. + * @summary Get an uploaded configuration + * @param {ConfigurationHubV1ApiGetUploadedConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public getUploadedConfigurationV1(requestParameters: ConfigurationHubV1ApiGetUploadedConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).getUploadedConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of existing backups for the current tenant. + * @summary List backups + * @param {ConfigurationHubV1ApiListBackupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public listBackupsV1(requestParameters: ConfigurationHubV1ApiListBackupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).listBackupsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of deploys for the current tenant. + * @summary List deploys + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public listDeploysV1(axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).listDeploysV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of existing drafts for the current tenant. + * @summary List drafts + * @param {ConfigurationHubV1ApiListDraftsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public listDraftsV1(requestParameters: ConfigurationHubV1ApiListDraftsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).listDraftsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of existing scheduled actions for the current tenant. + * @summary List scheduled actions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public listScheduledActionsV1(axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).listScheduledActionsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a list of existing uploaded configurations for the current tenant. + * @summary List uploaded configurations + * @param {ConfigurationHubV1ApiListUploadedConfigurationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public listUploadedConfigurationsV1(requestParameters: ConfigurationHubV1ApiListUploadedConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).listUploadedConfigurationsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage + * @summary Bulk updates object mappings + * @param {ConfigurationHubV1ApiUpdateObjectMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public updateObjectMappingsV1(requestParameters: ConfigurationHubV1ApiUpdateObjectMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).updateObjectMappingsV1(requestParameters.sourceOrg, requestParameters.objectmappingbulkpatchrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing scheduled action using JSON Patch format. + * @summary Update scheduled action + * @param {ConfigurationHubV1ApiUpdateScheduledActionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConfigurationHubV1Api + */ + public updateScheduledActionV1(requestParameters: ConfigurationHubV1ApiUpdateScheduledActionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConfigurationHubV1ApiFp(this.configuration).updateScheduledActionV1(requestParameters.id, requestParameters.jsonpatchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/configuration_hub/base.ts b/sdk-output/configuration_hub/base.ts new file mode 100644 index 00000000..824dead2 --- /dev/null +++ b/sdk-output/configuration_hub/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Configuration Hub + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/configuration_hub/common.ts b/sdk-output/configuration_hub/common.ts new file mode 100644 index 00000000..f696c17c --- /dev/null +++ b/sdk-output/configuration_hub/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Configuration Hub + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/configuration_hub/configuration.ts b/sdk-output/configuration_hub/configuration.ts new file mode 100644 index 00000000..9fd02cfa --- /dev/null +++ b/sdk-output/configuration_hub/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Configuration Hub + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/configuration_hub/git_push.sh b/sdk-output/configuration_hub/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/configuration_hub/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/configuration_hub/index.ts b/sdk-output/configuration_hub/index.ts new file mode 100644 index 00000000..4e55c6bb --- /dev/null +++ b/sdk-output/configuration_hub/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Configuration Hub + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/configuration_hub/package.json b/sdk-output/configuration_hub/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/configuration_hub/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/configuration_hub/tsconfig.json b/sdk-output/configuration_hub/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/configuration_hub/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/connector_customizers/.gitignore b/sdk-output/connector_customizers/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/connector_customizers/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/connector_customizers/.npmignore b/sdk-output/connector_customizers/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/connector_customizers/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/connector_customizers/.openapi-generator-ignore b/sdk-output/connector_customizers/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/connector_customizers/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/connector_customizers/.openapi-generator/FILES b/sdk-output/connector_customizers/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/connector_customizers/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/connector_customizers/.openapi-generator/VERSION b/sdk-output/connector_customizers/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/connector_customizers/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/connector_customizers/.sdk-partition b/sdk-output/connector_customizers/.sdk-partition new file mode 100644 index 00000000..7ce3b4cb --- /dev/null +++ b/sdk-output/connector_customizers/.sdk-partition @@ -0,0 +1 @@ +connector-customizers \ No newline at end of file diff --git a/sdk-output/connector_customizers/README.md b/sdk-output/connector_customizers/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connector_customizers/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connector_customizers/api.ts b/sdk-output/connector_customizers/api.ts new file mode 100644 index 00000000..d28759f1 --- /dev/null +++ b/sdk-output/connector_customizers/api.ts @@ -0,0 +1,863 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Customizers + * 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 ConnectorcustomizercreaterequestV1 + */ +export interface ConnectorcustomizercreaterequestV1 { + /** + * Connector customizer name. + * @type {string} + * @memberof ConnectorcustomizercreaterequestV1 + */ + 'name'?: string; +} +/** + * ConnectorCustomizerResponse + * @export + * @interface ConnectorcustomizercreateresponseV1 + */ +export interface ConnectorcustomizercreateresponseV1 { + /** + * the ID of connector customizer. + * @type {string} + * @memberof ConnectorcustomizercreateresponseV1 + */ + 'id'?: string; + /** + * name of the connector customizer. + * @type {string} + * @memberof ConnectorcustomizercreateresponseV1 + */ + 'name'?: string; + /** + * Connector customizer tenant id. + * @type {string} + * @memberof ConnectorcustomizercreateresponseV1 + */ + 'tenantID'?: string; + /** + * Date-time when the connector customizer was created. + * @type {string} + * @memberof ConnectorcustomizercreateresponseV1 + */ + 'created'?: string; +} +/** + * + * @export + * @interface ConnectorcustomizersresponseV1 + */ +export interface ConnectorcustomizersresponseV1 { + /** + * Connector customizer ID. + * @type {string} + * @memberof ConnectorcustomizersresponseV1 + */ + 'id'?: string; + /** + * Connector customizer name. + * @type {string} + * @memberof ConnectorcustomizersresponseV1 + */ + 'name'?: string; + /** + * Connector customizer image version. + * @type {number} + * @memberof ConnectorcustomizersresponseV1 + */ + 'imageVersion'?: number; + /** + * Connector customizer image id. + * @type {string} + * @memberof ConnectorcustomizersresponseV1 + */ + 'imageID'?: string; + /** + * Connector customizer tenant id. + * @type {string} + * @memberof ConnectorcustomizersresponseV1 + */ + 'tenantID'?: string; + /** + * Date-time when the connector customizer was created + * @type {string} + * @memberof ConnectorcustomizersresponseV1 + */ + 'created'?: string; +} +/** + * ConnectorCustomizerUpdateRequest + * @export + * @interface ConnectorcustomizerupdaterequestV1 + */ +export interface ConnectorcustomizerupdaterequestV1 { + /** + * Connector customizer name. + * @type {string} + * @memberof ConnectorcustomizerupdaterequestV1 + */ + 'name'?: string; +} +/** + * ConnectorCustomizerUpdateResponse + * @export + * @interface ConnectorcustomizerupdateresponseV1 + */ +export interface ConnectorcustomizerupdateresponseV1 { + /** + * the ID of connector customizer. + * @type {string} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'id'?: string; + /** + * name of the connector customizer. + * @type {string} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'name'?: string; + /** + * Connector customizer tenant id. + * @type {string} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'tenantID'?: string; + /** + * Date-time when the connector customizer was created. + * @type {string} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'created'?: string; + /** + * Connector customizer image version. + * @type {number} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'imageVersion'?: number; + /** + * Connector customizer image id. + * @type {string} + * @memberof ConnectorcustomizerupdateresponseV1 + */ + 'imageID'?: string; +} +/** + * ConnectorCustomizerVersionCreateResponse + * @export + * @interface ConnectorcustomizerversioncreateresponseV1 + */ +export interface ConnectorcustomizerversioncreateresponseV1 { + /** + * ID of connector customizer. + * @type {string} + * @memberof ConnectorcustomizerversioncreateresponseV1 + */ + 'customizerID'?: string; + /** + * ImageID of the connector customizer. + * @type {string} + * @memberof ConnectorcustomizerversioncreateresponseV1 + */ + 'imageID'?: string; + /** + * Image version of the connector customizer. + * @type {number} + * @memberof ConnectorcustomizerversioncreateresponseV1 + */ + 'version'?: number; + /** + * Date-time when the connector customizer version was created. + * @type {string} + * @memberof ConnectorcustomizerversioncreateresponseV1 + */ + 'created'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListConnectorCustomizersV1401ResponseV1 + */ +export interface ListConnectorCustomizersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListConnectorCustomizersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListConnectorCustomizersV1429ResponseV1 + */ +export interface ListConnectorCustomizersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListConnectorCustomizersV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * ConnectorCustomizersV1Api - axios parameter creator + * @export + */ +export const ConnectorCustomizersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a connector customizer. + * @summary Create connector customizer + * @param {ConnectorcustomizercreaterequestV1} connectorcustomizercreaterequestV1 Connector customizer to create. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorCustomizerV1: async (connectorcustomizercreaterequestV1: ConnectorcustomizercreaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'connectorcustomizercreaterequestV1' is not null or undefined + assertParamExists('createConnectorCustomizerV1', 'connectorcustomizercreaterequestV1', connectorcustomizercreaterequestV1) + const localVarPath = `/connector-customizers/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(connectorcustomizercreaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Creates a new version for the customizer. + * @summary Creates a connector customizer version + * @param {string} id The id of the connector customizer. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorCustomizerVersionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('createConnectorCustomizerVersionV1', 'id', id) + const localVarPath = `/connector-customizers/v1/{id}/versions` + .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: 'POST', ...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, + }; + }, + /** + * Delete the connector customizer for the given ID. + * @summary Delete connector customizer + * @param {string} id ID of the connector customizer to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteConnectorCustomizerV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteConnectorCustomizerV1', 'id', id) + const localVarPath = `/connector-customizers/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, + }; + }, + /** + * Gets connector customizer by ID. + * @summary Get connector customizer + * @param {string} id ID of the connector customizer to get. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorCustomizerV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getConnectorCustomizerV1', 'id', id) + const localVarPath = `/connector-customizers/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 all connector customizers. + * @summary List all connector customizers + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listConnectorCustomizersV1: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/connector-customizers/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; + } + + + + 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 connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + * @summary Update connector customizer + * @param {string} id ID of the connector customizer to update. + * @param {ConnectorcustomizerupdaterequestV1} [connectorcustomizerupdaterequestV1] Connector rule with updated data. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorCustomizerV1: async (id: string, connectorcustomizerupdaterequestV1?: ConnectorcustomizerupdaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putConnectorCustomizerV1', 'id', id) + const localVarPath = `/connector-customizers/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: 'PUT', ...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(connectorcustomizerupdaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ConnectorCustomizersV1Api - functional programming interface + * @export + */ +export const ConnectorCustomizersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ConnectorCustomizersV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a connector customizer. + * @summary Create connector customizer + * @param {ConnectorcustomizercreaterequestV1} connectorcustomizercreaterequestV1 Connector customizer to create. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createConnectorCustomizerV1(connectorcustomizercreaterequestV1: ConnectorcustomizercreaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizerV1(connectorcustomizercreaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.createConnectorCustomizerV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Creates a new version for the customizer. + * @summary Creates a connector customizer version + * @param {string} id The id of the connector customizer. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createConnectorCustomizerVersionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizerVersionV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.createConnectorCustomizerVersionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete the connector customizer for the given ID. + * @summary Delete connector customizer + * @param {string} id ID of the connector customizer to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteConnectorCustomizerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorCustomizerV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.deleteConnectorCustomizerV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets connector customizer by ID. + * @summary Get connector customizer + * @param {string} id ID of the connector customizer to get. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorCustomizerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCustomizerV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.getConnectorCustomizerV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List all connector customizers. + * @summary List all connector customizers + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listConnectorCustomizersV1(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listConnectorCustomizersV1(offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.listConnectorCustomizersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + * @summary Update connector customizer + * @param {string} id ID of the connector customizer to update. + * @param {ConnectorcustomizerupdaterequestV1} [connectorcustomizerupdaterequestV1] Connector rule with updated data. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorCustomizerV1(id: string, connectorcustomizerupdaterequestV1?: ConnectorcustomizerupdaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCustomizerV1(id, connectorcustomizerupdaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV1Api.putConnectorCustomizerV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ConnectorCustomizersV1Api - factory interface + * @export + */ +export const ConnectorCustomizersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ConnectorCustomizersV1ApiFp(configuration) + return { + /** + * Create a connector customizer. + * @summary Create connector customizer + * @param {ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createConnectorCustomizerV1(requestParameters.connectorcustomizercreaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Creates a new version for the customizer. + * @summary Creates a connector customizer version + * @param {ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorCustomizerVersionV1(requestParameters: ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createConnectorCustomizerVersionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete the connector customizer for the given ID. + * @summary Delete connector customizer + * @param {ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteConnectorCustomizerV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets connector customizer by ID. + * @summary Get connector customizer + * @param {ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorCustomizerV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List all connector customizers. + * @summary List all connector customizers + * @param {ConnectorCustomizersV1ApiListConnectorCustomizersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listConnectorCustomizersV1(requestParameters: ConnectorCustomizersV1ApiListConnectorCustomizersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listConnectorCustomizersV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + * @summary Update connector customizer + * @param {ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorCustomizerV1(requestParameters.id, requestParameters.connectorcustomizerupdaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createConnectorCustomizerV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request + */ +export interface ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request { + /** + * Connector customizer to create. + * @type {ConnectorcustomizercreaterequestV1} + * @memberof ConnectorCustomizersV1ApiCreateConnectorCustomizerV1 + */ + readonly connectorcustomizercreaterequestV1: ConnectorcustomizercreaterequestV1 +} + +/** + * Request parameters for createConnectorCustomizerVersionV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request + */ +export interface ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request { + /** + * The id of the connector customizer. + * @type {string} + * @memberof ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteConnectorCustomizerV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request + */ +export interface ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request { + /** + * ID of the connector customizer to delete. + * @type {string} + * @memberof ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1 + */ + readonly id: string +} + +/** + * Request parameters for getConnectorCustomizerV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request + */ +export interface ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request { + /** + * ID of the connector customizer to get. + * @type {string} + * @memberof ConnectorCustomizersV1ApiGetConnectorCustomizerV1 + */ + readonly id: string +} + +/** + * Request parameters for listConnectorCustomizersV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiListConnectorCustomizersV1Request + */ +export interface ConnectorCustomizersV1ApiListConnectorCustomizersV1Request { + /** + * 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 ConnectorCustomizersV1ApiListConnectorCustomizersV1 + */ + 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 ConnectorCustomizersV1ApiListConnectorCustomizersV1 + */ + readonly limit?: number +} + +/** + * Request parameters for putConnectorCustomizerV1 operation in ConnectorCustomizersV1Api. + * @export + * @interface ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request + */ +export interface ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request { + /** + * ID of the connector customizer to update. + * @type {string} + * @memberof ConnectorCustomizersV1ApiPutConnectorCustomizerV1 + */ + readonly id: string + + /** + * Connector rule with updated data. + * @type {ConnectorcustomizerupdaterequestV1} + * @memberof ConnectorCustomizersV1ApiPutConnectorCustomizerV1 + */ + readonly connectorcustomizerupdaterequestV1?: ConnectorcustomizerupdaterequestV1 +} + +/** + * ConnectorCustomizersV1Api - object-oriented interface + * @export + * @class ConnectorCustomizersV1Api + * @extends {BaseAPI} + */ +export class ConnectorCustomizersV1Api extends BaseAPI { + /** + * Create a connector customizer. + * @summary Create connector customizer + * @param {ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public createConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiCreateConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).createConnectorCustomizerV1(requestParameters.connectorcustomizercreaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Creates a new version for the customizer. + * @summary Creates a connector customizer version + * @param {ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public createConnectorCustomizerVersionV1(requestParameters: ConnectorCustomizersV1ApiCreateConnectorCustomizerVersionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).createConnectorCustomizerVersionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete the connector customizer for the given ID. + * @summary Delete connector customizer + * @param {ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public deleteConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiDeleteConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).deleteConnectorCustomizerV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets connector customizer by ID. + * @summary Get connector customizer + * @param {ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public getConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiGetConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).getConnectorCustomizerV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List all connector customizers. + * @summary List all connector customizers + * @param {ConnectorCustomizersV1ApiListConnectorCustomizersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public listConnectorCustomizersV1(requestParameters: ConnectorCustomizersV1ApiListConnectorCustomizersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).listConnectorCustomizersV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + * @summary Update connector customizer + * @param {ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorCustomizersV1Api + */ + public putConnectorCustomizerV1(requestParameters: ConnectorCustomizersV1ApiPutConnectorCustomizerV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorCustomizersV1ApiFp(this.configuration).putConnectorCustomizerV1(requestParameters.id, requestParameters.connectorcustomizerupdaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/connector_customizers/base.ts b/sdk-output/connector_customizers/base.ts new file mode 100644 index 00000000..85beab88 --- /dev/null +++ b/sdk-output/connector_customizers/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Customizers + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/connector_customizers/common.ts b/sdk-output/connector_customizers/common.ts new file mode 100644 index 00000000..665a3c4f --- /dev/null +++ b/sdk-output/connector_customizers/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Customizers + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/connector_customizers/configuration.ts b/sdk-output/connector_customizers/configuration.ts new file mode 100644 index 00000000..f12070eb --- /dev/null +++ b/sdk-output/connector_customizers/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Customizers + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/connector_customizers/git_push.sh b/sdk-output/connector_customizers/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/connector_customizers/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/connector_customizers/index.ts b/sdk-output/connector_customizers/index.ts new file mode 100644 index 00000000..e162e0d6 --- /dev/null +++ b/sdk-output/connector_customizers/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Customizers + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/connector_customizers/package.json b/sdk-output/connector_customizers/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/connector_customizers/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/connector_customizers/tsconfig.json b/sdk-output/connector_customizers/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/connector_customizers/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/connector_rule_management/.gitignore b/sdk-output/connector_rule_management/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/connector_rule_management/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/connector_rule_management/.npmignore b/sdk-output/connector_rule_management/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/connector_rule_management/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/connector_rule_management/.openapi-generator-ignore b/sdk-output/connector_rule_management/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/connector_rule_management/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/connector_rule_management/.openapi-generator/FILES b/sdk-output/connector_rule_management/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/connector_rule_management/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/connector_rule_management/.openapi-generator/VERSION b/sdk-output/connector_rule_management/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/connector_rule_management/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/connector_rule_management/.sdk-partition b/sdk-output/connector_rule_management/.sdk-partition new file mode 100644 index 00000000..44a5c2bd --- /dev/null +++ b/sdk-output/connector_rule_management/.sdk-partition @@ -0,0 +1 @@ +connector-rule-management \ No newline at end of file diff --git a/sdk-output/connector_rule_management/README.md b/sdk-output/connector_rule_management/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connector_rule_management/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connector_rule_management/api.ts b/sdk-output/connector_rule_management/api.ts new file mode 100644 index 00000000..e937016e --- /dev/null +++ b/sdk-output/connector_rule_management/api.ts @@ -0,0 +1,1059 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Rule Management + * 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 ArgumentV1 + */ +export interface ArgumentV1 { + /** + * the name of the argument + * @type {string} + * @memberof ArgumentV1 + */ + 'name': string; + /** + * the description of the argument + * @type {string} + * @memberof ArgumentV1 + */ + 'description'?: string | null; + /** + * the programmatic type of the argument + * @type {string} + * @memberof ArgumentV1 + */ + 'type'?: string | null; +} +/** + * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) + * @export + * @interface ConnectorrulecreaterequestSignatureV1 + */ +export interface ConnectorrulecreaterequestSignatureV1 { + /** + * + * @type {Array} + * @memberof ConnectorrulecreaterequestSignatureV1 + */ + 'input': Array; + /** + * + * @type {ArgumentV1} + * @memberof ConnectorrulecreaterequestSignatureV1 + */ + 'output'?: ArgumentV1 | null; +} +/** + * ConnectorRuleCreateRequest + * @export + * @interface ConnectorrulecreaterequestV1 + */ +export interface ConnectorrulecreaterequestV1 { + /** + * the name of the rule + * @type {string} + * @memberof ConnectorrulecreaterequestV1 + */ + 'name': string; + /** + * a description of the rule\'s purpose + * @type {string} + * @memberof ConnectorrulecreaterequestV1 + */ + 'description'?: string | null; + /** + * the type of rule + * @type {string} + * @memberof ConnectorrulecreaterequestV1 + */ + 'type': ConnectorrulecreaterequestV1TypeV1; + /** + * + * @type {ConnectorrulecreaterequestSignatureV1} + * @memberof ConnectorrulecreaterequestV1 + */ + 'signature'?: ConnectorrulecreaterequestSignatureV1; + /** + * + * @type {SourcecodeV1} + * @memberof ConnectorrulecreaterequestV1 + */ + 'sourceCode': SourcecodeV1; + /** + * a map of string to objects + * @type {object} + * @memberof ConnectorrulecreaterequestV1 + */ + 'attributes'?: object | null; +} + +export const ConnectorrulecreaterequestV1TypeV1 = { + BuildMap: 'BuildMap', + ConnectorAfterCreate: 'ConnectorAfterCreate', + ConnectorAfterDelete: 'ConnectorAfterDelete', + ConnectorAfterModify: 'ConnectorAfterModify', + ConnectorBeforeCreate: 'ConnectorBeforeCreate', + ConnectorBeforeDelete: 'ConnectorBeforeDelete', + ConnectorBeforeModify: 'ConnectorBeforeModify', + JdbcBuildMap: 'JDBCBuildMap', + JdbcOperationProvisioning: 'JDBCOperationProvisioning', + JdbcProvision: 'JDBCProvision', + PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', + PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', + PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', + RacfPermissionCustomization: 'RACFPermissionCustomization', + ResourceObjectCustomization: 'ResourceObjectCustomization', + SapBuildMap: 'SAPBuildMap', + SapHrManagerRule: 'SapHrManagerRule', + SapHrOperationProvisioning: 'SapHrOperationProvisioning', + SapHrProvision: 'SapHrProvision', + SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', + WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', + WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', + ResourceObjectCustomization2: 'ResourceObjectCustomization' +} as const; + +export type ConnectorrulecreaterequestV1TypeV1 = typeof ConnectorrulecreaterequestV1TypeV1[keyof typeof ConnectorrulecreaterequestV1TypeV1]; + +/** + * ConnectorRuleResponse + * @export + * @interface ConnectorruleresponseV1 + */ +export interface ConnectorruleresponseV1 { + /** + * the name of the rule + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'name': string; + /** + * a description of the rule\'s purpose + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'description'?: string | null; + /** + * the type of rule + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'type': ConnectorruleresponseV1TypeV1; + /** + * + * @type {ConnectorrulecreaterequestSignatureV1} + * @memberof ConnectorruleresponseV1 + */ + 'signature'?: ConnectorrulecreaterequestSignatureV1; + /** + * + * @type {SourcecodeV1} + * @memberof ConnectorruleresponseV1 + */ + 'sourceCode': SourcecodeV1; + /** + * a map of string to objects + * @type {object} + * @memberof ConnectorruleresponseV1 + */ + 'attributes'?: object | null; + /** + * the ID of the rule + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'id': string; + /** + * an ISO 8601 UTC timestamp when this rule was created + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'created': string; + /** + * an ISO 8601 UTC timestamp when this rule was last modified + * @type {string} + * @memberof ConnectorruleresponseV1 + */ + 'modified'?: string | null; +} + +export const ConnectorruleresponseV1TypeV1 = { + BuildMap: 'BuildMap', + ConnectorAfterCreate: 'ConnectorAfterCreate', + ConnectorAfterDelete: 'ConnectorAfterDelete', + ConnectorAfterModify: 'ConnectorAfterModify', + ConnectorBeforeCreate: 'ConnectorBeforeCreate', + ConnectorBeforeDelete: 'ConnectorBeforeDelete', + ConnectorBeforeModify: 'ConnectorBeforeModify', + JdbcBuildMap: 'JDBCBuildMap', + JdbcOperationProvisioning: 'JDBCOperationProvisioning', + JdbcProvision: 'JDBCProvision', + PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', + PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', + PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', + RacfPermissionCustomization: 'RACFPermissionCustomization', + ResourceObjectCustomization: 'ResourceObjectCustomization', + SapBuildMap: 'SAPBuildMap', + SapHrManagerRule: 'SapHrManagerRule', + SapHrOperationProvisioning: 'SapHrOperationProvisioning', + SapHrProvision: 'SapHrProvision', + SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', + WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', + WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', + ResourceObjectCustomization2: 'ResourceObjectCustomization' +} as const; + +export type ConnectorruleresponseV1TypeV1 = typeof ConnectorruleresponseV1TypeV1[keyof typeof ConnectorruleresponseV1TypeV1]; + +/** + * ConnectorRuleUpdateRequest + * @export + * @interface ConnectorruleupdaterequestV1 + */ +export interface ConnectorruleupdaterequestV1 { + /** + * the name of the rule + * @type {string} + * @memberof ConnectorruleupdaterequestV1 + */ + 'name': string; + /** + * a description of the rule\'s purpose + * @type {string} + * @memberof ConnectorruleupdaterequestV1 + */ + 'description'?: string | null; + /** + * the type of rule + * @type {string} + * @memberof ConnectorruleupdaterequestV1 + */ + 'type': ConnectorruleupdaterequestV1TypeV1; + /** + * + * @type {ConnectorrulecreaterequestSignatureV1} + * @memberof ConnectorruleupdaterequestV1 + */ + 'signature'?: ConnectorrulecreaterequestSignatureV1; + /** + * + * @type {SourcecodeV1} + * @memberof ConnectorruleupdaterequestV1 + */ + 'sourceCode': SourcecodeV1; + /** + * a map of string to objects + * @type {object} + * @memberof ConnectorruleupdaterequestV1 + */ + 'attributes'?: object | null; + /** + * the ID of the rule to update + * @type {string} + * @memberof ConnectorruleupdaterequestV1 + */ + 'id': string; +} + +export const ConnectorruleupdaterequestV1TypeV1 = { + BuildMap: 'BuildMap', + ConnectorAfterCreate: 'ConnectorAfterCreate', + ConnectorAfterDelete: 'ConnectorAfterDelete', + ConnectorAfterModify: 'ConnectorAfterModify', + ConnectorBeforeCreate: 'ConnectorBeforeCreate', + ConnectorBeforeDelete: 'ConnectorBeforeDelete', + ConnectorBeforeModify: 'ConnectorBeforeModify', + JdbcBuildMap: 'JDBCBuildMap', + JdbcOperationProvisioning: 'JDBCOperationProvisioning', + JdbcProvision: 'JDBCProvision', + PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', + PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', + PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', + RacfPermissionCustomization: 'RACFPermissionCustomization', + ResourceObjectCustomization: 'ResourceObjectCustomization', + SapBuildMap: 'SAPBuildMap', + SapHrManagerRule: 'SapHrManagerRule', + SapHrOperationProvisioning: 'SapHrOperationProvisioning', + SapHrProvision: 'SapHrProvision', + SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', + WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', + WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', + ResourceObjectCustomization2: 'ResourceObjectCustomization' +} as const; + +export type ConnectorruleupdaterequestV1TypeV1 = typeof ConnectorruleupdaterequestV1TypeV1[keyof typeof ConnectorruleupdaterequestV1TypeV1]; + +/** + * CodeErrorDetail + * @export + * @interface ConnectorrulevalidationresponseDetailsInnerV1 + */ +export interface ConnectorrulevalidationresponseDetailsInnerV1 { + /** + * The line number where the issue occurred + * @type {number} + * @memberof ConnectorrulevalidationresponseDetailsInnerV1 + */ + 'line': number; + /** + * the column number where the issue occurred + * @type {number} + * @memberof ConnectorrulevalidationresponseDetailsInnerV1 + */ + 'column': number; + /** + * a description of the issue in the code + * @type {string} + * @memberof ConnectorrulevalidationresponseDetailsInnerV1 + */ + 'messsage'?: string; +} +/** + * ConnectorRuleValidationResponse + * @export + * @interface ConnectorrulevalidationresponseV1 + */ +export interface ConnectorrulevalidationresponseV1 { + /** + * + * @type {string} + * @memberof ConnectorrulevalidationresponseV1 + */ + 'state': ConnectorrulevalidationresponseV1StateV1; + /** + * + * @type {Array} + * @memberof ConnectorrulevalidationresponseV1 + */ + 'details': Array; +} + +export const ConnectorrulevalidationresponseV1StateV1 = { + Ok: 'OK', + Error: 'ERROR' +} as const; + +export type ConnectorrulevalidationresponseV1StateV1 = typeof ConnectorrulevalidationresponseV1StateV1[keyof typeof ConnectorrulevalidationresponseV1StateV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetConnectorRuleListV1401ResponseV1 + */ +export interface GetConnectorRuleListV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetConnectorRuleListV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetConnectorRuleListV1429ResponseV1 + */ +export interface GetConnectorRuleListV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetConnectorRuleListV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * SourceCode + * @export + * @interface SourcecodeV1 + */ +export interface SourcecodeV1 { + /** + * the version of the code + * @type {string} + * @memberof SourcecodeV1 + */ + 'version': string; + /** + * The code + * @type {string} + * @memberof SourcecodeV1 + */ + 'script': string; +} + +/** + * ConnectorRuleManagementV1Api - axios parameter creator + * @export + */ +export const ConnectorRuleManagementV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a connector rule from the available types. + * @summary Create connector rule + * @param {ConnectorrulecreaterequestV1} connectorrulecreaterequestV1 Connector rule to create. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorRuleV1: async (connectorrulecreaterequestV1: ConnectorrulecreaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'connectorrulecreaterequestV1' is not null or undefined + assertParamExists('createConnectorRuleV1', 'connectorrulecreaterequestV1', connectorrulecreaterequestV1) + const localVarPath = `/connector-rules/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(connectorrulecreaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete the connector rule for the given ID. + * @summary Delete connector rule + * @param {string} id ID of the connector rule to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteConnectorRuleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteConnectorRuleV1', 'id', id) + const localVarPath = `/connector-rules/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, + }; + }, + /** + * List existing connector rules. + * @summary List connector rules + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorRuleListV1: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/connector-rules/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a connector rule by ID. + * @summary Get connector rule + * @param {string} id ID of the connector rule to get. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorRuleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getConnectorRuleV1', 'id', id) + const localVarPath = `/connector-rules/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, + }; + }, + /** + * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + * @summary Update connector rule + * @param {string} id ID of the connector rule to update. + * @param {ConnectorruleupdaterequestV1} [connectorruleupdaterequestV1] Connector rule with updated data. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorRuleV1: async (id: string, connectorruleupdaterequestV1?: ConnectorruleupdaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putConnectorRuleV1', 'id', id) + const localVarPath = `/connector-rules/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: 'PUT', ...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(connectorruleupdaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Detect issues within the connector rule\'s code to fix and list them. + * @summary Validate connector rule + * @param {SourcecodeV1} sourcecodeV1 Code to validate. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testConnectorRuleV1: async (sourcecodeV1: SourcecodeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourcecodeV1' is not null or undefined + assertParamExists('testConnectorRuleV1', 'sourcecodeV1', sourcecodeV1) + const localVarPath = `/connector-rules/v1/validate`; + // 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(sourcecodeV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ConnectorRuleManagementV1Api - functional programming interface + * @export + */ +export const ConnectorRuleManagementV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ConnectorRuleManagementV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a connector rule from the available types. + * @summary Create connector rule + * @param {ConnectorrulecreaterequestV1} connectorrulecreaterequestV1 Connector rule to create. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createConnectorRuleV1(connectorrulecreaterequestV1: ConnectorrulecreaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRuleV1(connectorrulecreaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.createConnectorRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete the connector rule for the given ID. + * @summary Delete connector rule + * @param {string} id ID of the connector rule to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteConnectorRuleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRuleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.deleteConnectorRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List existing connector rules. + * @summary List connector rules + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorRuleListV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleListV1(limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.getConnectorRuleListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a connector rule by ID. + * @summary Get connector rule + * @param {string} id ID of the connector rule to get. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorRuleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.getConnectorRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + * @summary Update connector rule + * @param {string} id ID of the connector rule to update. + * @param {ConnectorruleupdaterequestV1} [connectorruleupdaterequestV1] Connector rule with updated data. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorRuleV1(id: string, connectorruleupdaterequestV1?: ConnectorruleupdaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorRuleV1(id, connectorruleupdaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.putConnectorRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Detect issues within the connector rule\'s code to fix and list them. + * @summary Validate connector rule + * @param {SourcecodeV1} sourcecodeV1 Code to validate. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testConnectorRuleV1(sourcecodeV1: SourcecodeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectorRuleV1(sourcecodeV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV1Api.testConnectorRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ConnectorRuleManagementV1Api - factory interface + * @export + */ +export const ConnectorRuleManagementV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ConnectorRuleManagementV1ApiFp(configuration) + return { + /** + * Create a connector rule from the available types. + * @summary Create connector rule + * @param {ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createConnectorRuleV1(requestParameters.connectorrulecreaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete the connector rule for the given ID. + * @summary Delete connector rule + * @param {ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List existing connector rules. + * @summary List connector rules + * @param {ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorRuleListV1(requestParameters: ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getConnectorRuleListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a connector rule by ID. + * @summary Get connector rule + * @param {ConnectorRuleManagementV1ApiGetConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiGetConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + * @summary Update connector rule + * @param {ConnectorRuleManagementV1ApiPutConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiPutConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorRuleV1(requestParameters.id, requestParameters.connectorruleupdaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Detect issues within the connector rule\'s code to fix and list them. + * @summary Validate connector rule + * @param {ConnectorRuleManagementV1ApiTestConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiTestConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testConnectorRuleV1(requestParameters.sourcecodeV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createConnectorRuleV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request + */ +export interface ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request { + /** + * Connector rule to create. + * @type {ConnectorrulecreaterequestV1} + * @memberof ConnectorRuleManagementV1ApiCreateConnectorRuleV1 + */ + readonly connectorrulecreaterequestV1: ConnectorrulecreaterequestV1 +} + +/** + * Request parameters for deleteConnectorRuleV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request + */ +export interface ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request { + /** + * ID of the connector rule to delete. + * @type {string} + * @memberof ConnectorRuleManagementV1ApiDeleteConnectorRuleV1 + */ + readonly id: string +} + +/** + * Request parameters for getConnectorRuleListV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request + */ +export interface ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request { + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ConnectorRuleManagementV1ApiGetConnectorRuleListV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ConnectorRuleManagementV1ApiGetConnectorRuleListV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof ConnectorRuleManagementV1ApiGetConnectorRuleListV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getConnectorRuleV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiGetConnectorRuleV1Request + */ +export interface ConnectorRuleManagementV1ApiGetConnectorRuleV1Request { + /** + * ID of the connector rule to get. + * @type {string} + * @memberof ConnectorRuleManagementV1ApiGetConnectorRuleV1 + */ + readonly id: string +} + +/** + * Request parameters for putConnectorRuleV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiPutConnectorRuleV1Request + */ +export interface ConnectorRuleManagementV1ApiPutConnectorRuleV1Request { + /** + * ID of the connector rule to update. + * @type {string} + * @memberof ConnectorRuleManagementV1ApiPutConnectorRuleV1 + */ + readonly id: string + + /** + * Connector rule with updated data. + * @type {ConnectorruleupdaterequestV1} + * @memberof ConnectorRuleManagementV1ApiPutConnectorRuleV1 + */ + readonly connectorruleupdaterequestV1?: ConnectorruleupdaterequestV1 +} + +/** + * Request parameters for testConnectorRuleV1 operation in ConnectorRuleManagementV1Api. + * @export + * @interface ConnectorRuleManagementV1ApiTestConnectorRuleV1Request + */ +export interface ConnectorRuleManagementV1ApiTestConnectorRuleV1Request { + /** + * Code to validate. + * @type {SourcecodeV1} + * @memberof ConnectorRuleManagementV1ApiTestConnectorRuleV1 + */ + readonly sourcecodeV1: SourcecodeV1 +} + +/** + * ConnectorRuleManagementV1Api - object-oriented interface + * @export + * @class ConnectorRuleManagementV1Api + * @extends {BaseAPI} + */ +export class ConnectorRuleManagementV1Api extends BaseAPI { + /** + * Create a connector rule from the available types. + * @summary Create connector rule + * @param {ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public createConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiCreateConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).createConnectorRuleV1(requestParameters.connectorrulecreaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete the connector rule for the given ID. + * @summary Delete connector rule + * @param {ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public deleteConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiDeleteConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).deleteConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List existing connector rules. + * @summary List connector rules + * @param {ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public getConnectorRuleListV1(requestParameters: ConnectorRuleManagementV1ApiGetConnectorRuleListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).getConnectorRuleListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a connector rule by ID. + * @summary Get connector rule + * @param {ConnectorRuleManagementV1ApiGetConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public getConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiGetConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).getConnectorRuleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + * @summary Update connector rule + * @param {ConnectorRuleManagementV1ApiPutConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public putConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiPutConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).putConnectorRuleV1(requestParameters.id, requestParameters.connectorruleupdaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Detect issues within the connector rule\'s code to fix and list them. + * @summary Validate connector rule + * @param {ConnectorRuleManagementV1ApiTestConnectorRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorRuleManagementV1Api + */ + public testConnectorRuleV1(requestParameters: ConnectorRuleManagementV1ApiTestConnectorRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorRuleManagementV1ApiFp(this.configuration).testConnectorRuleV1(requestParameters.sourcecodeV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/connector_rule_management/base.ts b/sdk-output/connector_rule_management/base.ts new file mode 100644 index 00000000..ef8c79ca --- /dev/null +++ b/sdk-output/connector_rule_management/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Rule Management + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/connector_rule_management/common.ts b/sdk-output/connector_rule_management/common.ts new file mode 100644 index 00000000..577dfcd6 --- /dev/null +++ b/sdk-output/connector_rule_management/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Rule Management + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/connector_rule_management/configuration.ts b/sdk-output/connector_rule_management/configuration.ts new file mode 100644 index 00000000..7cb5d8a4 --- /dev/null +++ b/sdk-output/connector_rule_management/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Rule Management + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/connector_rule_management/git_push.sh b/sdk-output/connector_rule_management/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/connector_rule_management/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/connector_rule_management/index.ts b/sdk-output/connector_rule_management/index.ts new file mode 100644 index 00000000..ca4f5703 --- /dev/null +++ b/sdk-output/connector_rule_management/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connector Rule Management + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/connector_rule_management/package.json b/sdk-output/connector_rule_management/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/connector_rule_management/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/connector_rule_management/tsconfig.json b/sdk-output/connector_rule_management/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/connector_rule_management/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/connectors/.gitignore b/sdk-output/connectors/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/connectors/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/connectors/.npmignore b/sdk-output/connectors/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/connectors/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/connectors/.openapi-generator-ignore b/sdk-output/connectors/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/connectors/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/connectors/.openapi-generator/FILES b/sdk-output/connectors/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/connectors/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/connectors/.openapi-generator/VERSION b/sdk-output/connectors/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/connectors/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/connectors/.sdk-partition b/sdk-output/connectors/.sdk-partition new file mode 100644 index 00000000..5c286ba7 --- /dev/null +++ b/sdk-output/connectors/.sdk-partition @@ -0,0 +1 @@ +connectors \ No newline at end of file diff --git a/sdk-output/connectors/README.md b/sdk-output/connectors/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connectors/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connectors/api.ts b/sdk-output/connectors/api.ts new file mode 100644 index 00000000..e37af0f1 --- /dev/null +++ b/sdk-output/connectors/api.ts @@ -0,0 +1,1860 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connectors + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ConnectordetailV1 + */ +export interface ConnectordetailV1 { + /** + * The connector name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'name'?: string; + /** + * The connector type + * @type {string} + * @memberof ConnectordetailV1 + */ + 'type'?: string; + /** + * The connector class name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'className'?: string; + /** + * The connector script name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'scriptName'?: string; + /** + * The connector application xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'applicationXml'?: string; + /** + * The connector correlation config xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'correlationConfigXml'?: string; + /** + * The connector source config xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfigXml'?: string; + /** + * The connector source config + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfig'?: string | null; + /** + * The connector source config origin + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfigFrom'?: string | null; + /** + * storage path key for this connector + * @type {string} + * @memberof ConnectordetailV1 + */ + 's3Location'?: string; + /** + * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. + * @type {Array} + * @memberof ConnectordetailV1 + */ + 'uploadedFiles'?: Array | null; + /** + * true if the source is file upload + * @type {boolean} + * @memberof ConnectordetailV1 + */ + 'fileUpload'?: boolean; + /** + * true if the source is a direct connect source + * @type {boolean} + * @memberof ConnectordetailV1 + */ + 'directConnect'?: boolean; + /** + * A map containing translation attributes by loacale key + * @type {{ [key: string]: any; }} + * @memberof ConnectordetailV1 + */ + 'translationProperties'?: { [key: string]: any; }; + /** + * A map containing metadata pertinent to the UI to be used + * @type {{ [key: string]: any; }} + * @memberof ConnectordetailV1 + */ + 'connectorMetadata'?: { [key: string]: any; }; + /** + * The connector status + * @type {string} + * @memberof ConnectordetailV1 + */ + 'status'?: ConnectordetailV1StatusV1; +} + +export const ConnectordetailV1StatusV1 = { + Deprecated: 'DEPRECATED', + Development: 'DEVELOPMENT', + Demo: 'DEMO', + Released: 'RELEASED' +} as const; + +export type ConnectordetailV1StatusV1 = typeof ConnectordetailV1StatusV1[keyof typeof ConnectordetailV1StatusV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetConnectorV1401ResponseV1 + */ +export interface GetConnectorV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetConnectorV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetConnectorV1429ResponseV1 + */ +export interface GetConnectorV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetConnectorV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PutConnectorCorrelationConfigV1RequestV1 + */ +export interface PutConnectorCorrelationConfigV1RequestV1 { + /** + * connector correlation config xml file + * @type {File} + * @memberof PutConnectorCorrelationConfigV1RequestV1 + */ + 'file': File; +} +/** + * + * @export + * @interface PutConnectorSourceConfigV1RequestV1 + */ +export interface PutConnectorSourceConfigV1RequestV1 { + /** + * connector source config xml file + * @type {File} + * @memberof PutConnectorSourceConfigV1RequestV1 + */ + 'file': File; +} +/** + * + * @export + * @interface PutConnectorSourceTemplateV1RequestV1 + */ +export interface PutConnectorSourceTemplateV1RequestV1 { + /** + * connector source template xml file + * @type {File} + * @memberof PutConnectorSourceTemplateV1RequestV1 + */ + 'file': File; +} +/** + * + * @export + * @interface UpdatedetailV1 + */ +export interface UpdatedetailV1 { + /** + * The detailed message for an update. Typically the relevent error message when status is error. + * @type {string} + * @memberof UpdatedetailV1 + */ + 'message'?: string; + /** + * The connector script name + * @type {string} + * @memberof UpdatedetailV1 + */ + 'scriptName'?: string; + /** + * The list of updated files supported by the connector + * @type {Array} + * @memberof UpdatedetailV1 + */ + 'updatedFiles'?: Array | null; + /** + * The connector update status + * @type {string} + * @memberof UpdatedetailV1 + */ + 'status'?: UpdatedetailV1StatusV1; +} + +export const UpdatedetailV1StatusV1 = { + Error: 'ERROR', + Updated: 'UPDATED', + Unchanged: 'UNCHANGED', + Skipped: 'SKIPPED' +} as const; + +export type UpdatedetailV1StatusV1 = typeof UpdatedetailV1StatusV1[keyof typeof UpdatedetailV1StatusV1]; + +/** + * + * @export + * @interface V3connectordtoV1 + */ +export interface V3connectordtoV1 { + /** + * The connector name + * @type {string} + * @memberof V3connectordtoV1 + */ + 'name'?: string; + /** + * The connector type + * @type {string} + * @memberof V3connectordtoV1 + */ + 'type'?: string; + /** + * The connector script name + * @type {string} + * @memberof V3connectordtoV1 + */ + 'scriptName'?: string; + /** + * The connector class name. + * @type {string} + * @memberof V3connectordtoV1 + */ + 'className'?: string | null; + /** + * The list of features supported by the connector + * @type {Array} + * @memberof V3connectordtoV1 + */ + 'features'?: Array | null; + /** + * true if the source is a direct connect source + * @type {boolean} + * @memberof V3connectordtoV1 + */ + 'directConnect'?: boolean; + /** + * A map containing metadata pertinent to the connector + * @type {{ [key: string]: any; }} + * @memberof V3connectordtoV1 + */ + 'connectorMetadata'?: { [key: string]: any; }; + /** + * The connector status + * @type {string} + * @memberof V3connectordtoV1 + */ + 'status'?: V3connectordtoV1StatusV1; +} + +export const V3connectordtoV1StatusV1 = { + Deprecated: 'DEPRECATED', + Development: 'DEVELOPMENT', + Demo: 'DEMO', + Released: 'RELEASED' +} as const; + +export type V3connectordtoV1StatusV1 = typeof V3connectordtoV1StatusV1[keyof typeof V3connectordtoV1StatusV1]; + +/** + * + * @export + * @interface V3createconnectordtoV1 + */ +export interface V3createconnectordtoV1 { + /** + * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints + * @type {string} + * @memberof V3createconnectordtoV1 + */ + 'name': string; + /** + * The connector type. If not specified will be defaulted to \'custom \'+name + * @type {string} + * @memberof V3createconnectordtoV1 + */ + 'type'?: string; + /** + * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter + * @type {string} + * @memberof V3createconnectordtoV1 + */ + 'className': string; + /** + * true if the source is a direct connect source + * @type {boolean} + * @memberof V3createconnectordtoV1 + */ + 'directConnect'?: boolean; + /** + * The connector status + * @type {string} + * @memberof V3createconnectordtoV1 + */ + 'status'?: V3createconnectordtoV1StatusV1; +} + +export const V3createconnectordtoV1StatusV1 = { + Development: 'DEVELOPMENT', + Demo: 'DEMO', + Released: 'RELEASED' +} as const; + +export type V3createconnectordtoV1StatusV1 = typeof V3createconnectordtoV1StatusV1[keyof typeof V3createconnectordtoV1StatusV1]; + + +/** + * ConnectorsV1Api - axios parameter creator + * @export + */ +export const ConnectorsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create custom connector. + * @summary Create custom connector + * @param {V3createconnectordtoV1} v3createconnectordtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomConnectorV1: async (v3createconnectordtoV1: V3createconnectordtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'v3createconnectordtoV1' is not null or undefined + assertParamExists('createCustomConnectorV1', 'v3createconnectordtoV1', v3createconnectordtoV1) + const localVarPath = `/connectors/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(v3createconnectordtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a custom connector that using its script name. + * @summary Delete connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomConnectorV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('deleteCustomConnectorV1', 'scriptName', scriptName) + const localVarPath = `/connectors/v1/{scriptName}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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, + }; + }, + /** + * Fetches a connector\'s correlation config using its script name. + * @summary Get connector correlation configuration + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorCorrelationConfigV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getConnectorCorrelationConfigV1', 'scriptName', scriptName) + const localVarPath = `/connectors/v1/{scriptName}/correlation-config` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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, + }; + }, + /** + * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. + * @summary Get connector list + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetConnectorListV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorListV1: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListV1LocaleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/connectors/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (locale !== undefined) { + localVarQueryParameter['locale'] = locale; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Fetches a connector\'s source config using its script name. + * @summary Get connector source configuration + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorSourceConfigV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getConnectorSourceConfigV1', 'scriptName', scriptName) + const localVarPath = `/connectors/v1/{scriptName}/source-config` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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, + }; + }, + /** + * Fetches a connector\'s source template using its script name. + * @summary Get connector source template + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorSourceTemplateV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getConnectorSourceTemplateV1', 'scriptName', scriptName) + const localVarPath = `/connectors/v1/{scriptName}/source-template` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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, + }; + }, + /** + * Fetches a connector\'s translations using its script name. + * @summary Get connector translations + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {GetConnectorTranslationsV1LocaleV1} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorTranslationsV1: async (scriptName: string, locale: GetConnectorTranslationsV1LocaleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getConnectorTranslationsV1', 'scriptName', scriptName) + // verify required parameter 'locale' is not null or undefined + assertParamExists('getConnectorTranslationsV1', 'locale', locale) + const localVarPath = `/connectors/v1/{scriptName}/translations/{locale}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) + .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); + // 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, + }; + }, + /** + * Fetches a connector that using its script name. + * @summary Get connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {GetConnectorV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorV1: async (scriptName: string, locale?: GetConnectorV1LocaleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getConnectorV1', 'scriptName', scriptName) + const localVarPath = `/connectors/v1/{scriptName}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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 (locale !== undefined) { + localVarQueryParameter['locale'] = locale; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a connector\'s correlation config using its script name. + * @summary Update connector correlation configuration + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {File} file connector correlation config xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorCorrelationConfigV1: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('putConnectorCorrelationConfigV1', 'scriptName', scriptName) + // verify required parameter 'file' is not null or undefined + assertParamExists('putConnectorCorrelationConfigV1', 'file', file) + const localVarPath = `/connectors/v1/{scriptName}/correlation-config` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a connector\'s source config using its script name. + * @summary Update connector source configuration + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {File} file connector source config xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorSourceConfigV1: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('putConnectorSourceConfigV1', 'scriptName', scriptName) + // verify required parameter 'file' is not null or undefined + assertParamExists('putConnectorSourceConfigV1', 'file', file) + const localVarPath = `/connectors/v1/{scriptName}/source-config` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a connector\'s source template using its script name. + * @summary Update connector source template + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {File} file connector source template xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorSourceTemplateV1: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('putConnectorSourceTemplateV1', 'scriptName', scriptName) + // verify required parameter 'file' is not null or undefined + assertParamExists('putConnectorSourceTemplateV1', 'file', file) + const localVarPath = `/connectors/v1/{scriptName}/source-template` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a connector\'s translations using its script name. + * @summary Update connector translations + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {PutConnectorTranslationsV1LocaleV1} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorTranslationsV1: async (scriptName: string, locale: PutConnectorTranslationsV1LocaleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('putConnectorTranslationsV1', 'scriptName', scriptName) + // verify required parameter 'locale' is not null or undefined + assertParamExists('putConnectorTranslationsV1', 'locale', locale) + const localVarPath = `/connectors/v1/{scriptName}/translations/{locale}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) + .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml + * @summary Update connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {Array} jsonpatchoperationV1 A list of connector detail update operations + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateConnectorV1: async (scriptName: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('updateConnectorV1', 'scriptName', scriptName) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateConnectorV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/connectors/v1/{scriptName}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ConnectorsV1Api - functional programming interface + * @export + */ +export const ConnectorsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ConnectorsV1ApiAxiosParamCreator(configuration) + return { + /** + * Create custom connector. + * @summary Create custom connector + * @param {V3createconnectordtoV1} v3createconnectordtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCustomConnectorV1(v3createconnectordtoV1: V3createconnectordtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomConnectorV1(v3createconnectordtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.createCustomConnectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a custom connector that using its script name. + * @summary Delete connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCustomConnectorV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomConnectorV1(scriptName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.deleteCustomConnectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a connector\'s correlation config using its script name. + * @summary Get connector correlation configuration + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorCorrelationConfigV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCorrelationConfigV1(scriptName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. + * @summary Get connector list + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetConnectorListV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorListV1(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListV1LocaleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorListV1(filters, limit, offset, count, locale, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a connector\'s source config using its script name. + * @summary Get connector source configuration + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorSourceConfigV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceConfigV1(scriptName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorSourceConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a connector\'s source template using its script name. + * @summary Get connector source template + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorSourceTemplateV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceTemplateV1(scriptName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorSourceTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a connector\'s translations using its script name. + * @summary Get connector translations + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {GetConnectorTranslationsV1LocaleV1} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorTranslationsV1(scriptName: string, locale: GetConnectorTranslationsV1LocaleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorTranslationsV1(scriptName, locale, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorTranslationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a connector that using its script name. + * @summary Get connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {GetConnectorV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getConnectorV1(scriptName: string, locale?: GetConnectorV1LocaleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorV1(scriptName, locale, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.getConnectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a connector\'s correlation config using its script name. + * @summary Update connector correlation configuration + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {File} file connector correlation config xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorCorrelationConfigV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCorrelationConfigV1(scriptName, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.putConnectorCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a connector\'s source config using its script name. + * @summary Update connector source configuration + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {File} file connector source config xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorSourceConfigV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceConfigV1(scriptName, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.putConnectorSourceConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a connector\'s source template using its script name. + * @summary Update connector source template + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {File} file connector source template xml file + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorSourceTemplateV1(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceTemplateV1(scriptName, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.putConnectorSourceTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a connector\'s translations using its script name. + * @summary Update connector translations + * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @param {PutConnectorTranslationsV1LocaleV1} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putConnectorTranslationsV1(scriptName: string, locale: PutConnectorTranslationsV1LocaleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorTranslationsV1(scriptName, locale, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.putConnectorTranslationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml + * @summary Update connector by script name + * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @param {Array} jsonpatchoperationV1 A list of connector detail update operations + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateConnectorV1(scriptName: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnectorV1(scriptName, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ConnectorsV1Api.updateConnectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ConnectorsV1Api - factory interface + * @export + */ +export const ConnectorsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ConnectorsV1ApiFp(configuration) + return { + /** + * Create custom connector. + * @summary Create custom connector + * @param {ConnectorsV1ApiCreateCustomConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomConnectorV1(requestParameters: ConnectorsV1ApiCreateCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCustomConnectorV1(requestParameters.v3createconnectordtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a custom connector that using its script name. + * @summary Delete connector by script name + * @param {ConnectorsV1ApiDeleteCustomConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomConnectorV1(requestParameters: ConnectorsV1ApiDeleteCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCustomConnectorV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a connector\'s correlation config using its script name. + * @summary Get connector correlation configuration + * @param {ConnectorsV1ApiGetConnectorCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorCorrelationConfigV1(requestParameters: ConnectorsV1ApiGetConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorCorrelationConfigV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. + * @summary Get connector list + * @param {ConnectorsV1ApiGetConnectorListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorListV1(requestParameters: ConnectorsV1ApiGetConnectorListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getConnectorListV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a connector\'s source config using its script name. + * @summary Get connector source configuration + * @param {ConnectorsV1ApiGetConnectorSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorSourceConfigV1(requestParameters: ConnectorsV1ApiGetConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorSourceConfigV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a connector\'s source template using its script name. + * @summary Get connector source template + * @param {ConnectorsV1ApiGetConnectorSourceTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorSourceTemplateV1(requestParameters: ConnectorsV1ApiGetConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorSourceTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a connector\'s translations using its script name. + * @summary Get connector translations + * @param {ConnectorsV1ApiGetConnectorTranslationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorTranslationsV1(requestParameters: ConnectorsV1ApiGetConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorTranslationsV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a connector that using its script name. + * @summary Get connector by script name + * @param {ConnectorsV1ApiGetConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getConnectorV1(requestParameters: ConnectorsV1ApiGetConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getConnectorV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a connector\'s correlation config using its script name. + * @summary Update connector correlation configuration + * @param {ConnectorsV1ApiPutConnectorCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorCorrelationConfigV1(requestParameters: ConnectorsV1ApiPutConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorCorrelationConfigV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a connector\'s source config using its script name. + * @summary Update connector source configuration + * @param {ConnectorsV1ApiPutConnectorSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorSourceConfigV1(requestParameters: ConnectorsV1ApiPutConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorSourceConfigV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a connector\'s source template using its script name. + * @summary Update connector source template + * @param {ConnectorsV1ApiPutConnectorSourceTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorSourceTemplateV1(requestParameters: ConnectorsV1ApiPutConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorSourceTemplateV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a connector\'s translations using its script name. + * @summary Update connector translations + * @param {ConnectorsV1ApiPutConnectorTranslationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putConnectorTranslationsV1(requestParameters: ConnectorsV1ApiPutConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putConnectorTranslationsV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml + * @summary Update connector by script name + * @param {ConnectorsV1ApiUpdateConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateConnectorV1(requestParameters: ConnectorsV1ApiUpdateConnectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateConnectorV1(requestParameters.scriptName, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCustomConnectorV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiCreateCustomConnectorV1Request + */ +export interface ConnectorsV1ApiCreateCustomConnectorV1Request { + /** + * + * @type {V3createconnectordtoV1} + * @memberof ConnectorsV1ApiCreateCustomConnectorV1 + */ + readonly v3createconnectordtoV1: V3createconnectordtoV1 +} + +/** + * Request parameters for deleteCustomConnectorV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiDeleteCustomConnectorV1Request + */ +export interface ConnectorsV1ApiDeleteCustomConnectorV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiDeleteCustomConnectorV1 + */ + readonly scriptName: string +} + +/** + * Request parameters for getConnectorCorrelationConfigV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorCorrelationConfigV1Request + */ +export interface ConnectorsV1ApiGetConnectorCorrelationConfigV1Request { + /** + * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorCorrelationConfigV1 + */ + readonly scriptName: string +} + +/** + * Request parameters for getConnectorListV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorListV1Request + */ +export interface ConnectorsV1ApiGetConnectorListV1Request { + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorListV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ConnectorsV1ApiGetConnectorListV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ConnectorsV1ApiGetConnectorListV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof ConnectorsV1ApiGetConnectorListV1 + */ + readonly count?: boolean + + /** + * The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} + * @memberof ConnectorsV1ApiGetConnectorListV1 + */ + readonly locale?: GetConnectorListV1LocaleV1 +} + +/** + * Request parameters for getConnectorSourceConfigV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorSourceConfigV1Request + */ +export interface ConnectorsV1ApiGetConnectorSourceConfigV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorSourceConfigV1 + */ + readonly scriptName: string +} + +/** + * Request parameters for getConnectorSourceTemplateV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorSourceTemplateV1Request + */ +export interface ConnectorsV1ApiGetConnectorSourceTemplateV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorSourceTemplateV1 + */ + readonly scriptName: string +} + +/** + * Request parameters for getConnectorTranslationsV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorTranslationsV1Request + */ +export interface ConnectorsV1ApiGetConnectorTranslationsV1Request { + /** + * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorTranslationsV1 + */ + readonly scriptName: string + + /** + * The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} + * @memberof ConnectorsV1ApiGetConnectorTranslationsV1 + */ + readonly locale: GetConnectorTranslationsV1LocaleV1 +} + +/** + * Request parameters for getConnectorV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiGetConnectorV1Request + */ +export interface ConnectorsV1ApiGetConnectorV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiGetConnectorV1 + */ + readonly scriptName: string + + /** + * The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} + * @memberof ConnectorsV1ApiGetConnectorV1 + */ + readonly locale?: GetConnectorV1LocaleV1 +} + +/** + * Request parameters for putConnectorCorrelationConfigV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiPutConnectorCorrelationConfigV1Request + */ +export interface ConnectorsV1ApiPutConnectorCorrelationConfigV1Request { + /** + * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiPutConnectorCorrelationConfigV1 + */ + readonly scriptName: string + + /** + * connector correlation config xml file + * @type {File} + * @memberof ConnectorsV1ApiPutConnectorCorrelationConfigV1 + */ + readonly file: File +} + +/** + * Request parameters for putConnectorSourceConfigV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiPutConnectorSourceConfigV1Request + */ +export interface ConnectorsV1ApiPutConnectorSourceConfigV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiPutConnectorSourceConfigV1 + */ + readonly scriptName: string + + /** + * connector source config xml file + * @type {File} + * @memberof ConnectorsV1ApiPutConnectorSourceConfigV1 + */ + readonly file: File +} + +/** + * Request parameters for putConnectorSourceTemplateV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiPutConnectorSourceTemplateV1Request + */ +export interface ConnectorsV1ApiPutConnectorSourceTemplateV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiPutConnectorSourceTemplateV1 + */ + readonly scriptName: string + + /** + * connector source template xml file + * @type {File} + * @memberof ConnectorsV1ApiPutConnectorSourceTemplateV1 + */ + readonly file: File +} + +/** + * Request parameters for putConnectorTranslationsV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiPutConnectorTranslationsV1Request + */ +export interface ConnectorsV1ApiPutConnectorTranslationsV1Request { + /** + * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiPutConnectorTranslationsV1 + */ + readonly scriptName: string + + /** + * The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @type {'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} + * @memberof ConnectorsV1ApiPutConnectorTranslationsV1 + */ + readonly locale: PutConnectorTranslationsV1LocaleV1 +} + +/** + * Request parameters for updateConnectorV1 operation in ConnectorsV1Api. + * @export + * @interface ConnectorsV1ApiUpdateConnectorV1Request + */ +export interface ConnectorsV1ApiUpdateConnectorV1Request { + /** + * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + * @type {string} + * @memberof ConnectorsV1ApiUpdateConnectorV1 + */ + readonly scriptName: string + + /** + * A list of connector detail update operations + * @type {Array} + * @memberof ConnectorsV1ApiUpdateConnectorV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * ConnectorsV1Api - object-oriented interface + * @export + * @class ConnectorsV1Api + * @extends {BaseAPI} + */ +export class ConnectorsV1Api extends BaseAPI { + /** + * Create custom connector. + * @summary Create custom connector + * @param {ConnectorsV1ApiCreateCustomConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public createCustomConnectorV1(requestParameters: ConnectorsV1ApiCreateCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).createCustomConnectorV1(requestParameters.v3createconnectordtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a custom connector that using its script name. + * @summary Delete connector by script name + * @param {ConnectorsV1ApiDeleteCustomConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public deleteCustomConnectorV1(requestParameters: ConnectorsV1ApiDeleteCustomConnectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).deleteCustomConnectorV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a connector\'s correlation config using its script name. + * @summary Get connector correlation configuration + * @param {ConnectorsV1ApiGetConnectorCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorCorrelationConfigV1(requestParameters: ConnectorsV1ApiGetConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorCorrelationConfigV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. + * @summary Get connector list + * @param {ConnectorsV1ApiGetConnectorListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorListV1(requestParameters: ConnectorsV1ApiGetConnectorListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorListV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a connector\'s source config using its script name. + * @summary Get connector source configuration + * @param {ConnectorsV1ApiGetConnectorSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorSourceConfigV1(requestParameters: ConnectorsV1ApiGetConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorSourceConfigV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a connector\'s source template using its script name. + * @summary Get connector source template + * @param {ConnectorsV1ApiGetConnectorSourceTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorSourceTemplateV1(requestParameters: ConnectorsV1ApiGetConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorSourceTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a connector\'s translations using its script name. + * @summary Get connector translations + * @param {ConnectorsV1ApiGetConnectorTranslationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorTranslationsV1(requestParameters: ConnectorsV1ApiGetConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorTranslationsV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a connector that using its script name. + * @summary Get connector by script name + * @param {ConnectorsV1ApiGetConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public getConnectorV1(requestParameters: ConnectorsV1ApiGetConnectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).getConnectorV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a connector\'s correlation config using its script name. + * @summary Update connector correlation configuration + * @param {ConnectorsV1ApiPutConnectorCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public putConnectorCorrelationConfigV1(requestParameters: ConnectorsV1ApiPutConnectorCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).putConnectorCorrelationConfigV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a connector\'s source config using its script name. + * @summary Update connector source configuration + * @param {ConnectorsV1ApiPutConnectorSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public putConnectorSourceConfigV1(requestParameters: ConnectorsV1ApiPutConnectorSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).putConnectorSourceConfigV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a connector\'s source template using its script name. + * @summary Update connector source template + * @param {ConnectorsV1ApiPutConnectorSourceTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public putConnectorSourceTemplateV1(requestParameters: ConnectorsV1ApiPutConnectorSourceTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).putConnectorSourceTemplateV1(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a connector\'s translations using its script name. + * @summary Update connector translations + * @param {ConnectorsV1ApiPutConnectorTranslationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public putConnectorTranslationsV1(requestParameters: ConnectorsV1ApiPutConnectorTranslationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).putConnectorTranslationsV1(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml + * @summary Update connector by script name + * @param {ConnectorsV1ApiUpdateConnectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ConnectorsV1Api + */ + public updateConnectorV1(requestParameters: ConnectorsV1ApiUpdateConnectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ConnectorsV1ApiFp(this.configuration).updateConnectorV1(requestParameters.scriptName, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetConnectorListV1LocaleV1 = { + De: 'de', + No: 'no', + Fi: 'fi', + Sv: 'sv', + Ru: 'ru', + Pt: 'pt', + Ko: 'ko', + ZhTw: 'zh-TW', + En: 'en', + It: 'it', + Fr: 'fr', + ZhCn: 'zh-CN', + Hu: 'hu', + Es: 'es', + Cs: 'cs', + Ja: 'ja', + Pl: 'pl', + Da: 'da', + Nl: 'nl' +} as const; +export type GetConnectorListV1LocaleV1 = typeof GetConnectorListV1LocaleV1[keyof typeof GetConnectorListV1LocaleV1]; +/** + * @export + */ +export const GetConnectorTranslationsV1LocaleV1 = { + De: 'de', + No: 'no', + Fi: 'fi', + Sv: 'sv', + Ru: 'ru', + Pt: 'pt', + Ko: 'ko', + ZhTw: 'zh-TW', + En: 'en', + It: 'it', + Fr: 'fr', + ZhCn: 'zh-CN', + Hu: 'hu', + Es: 'es', + Cs: 'cs', + Ja: 'ja', + Pl: 'pl', + Da: 'da', + Nl: 'nl' +} as const; +export type GetConnectorTranslationsV1LocaleV1 = typeof GetConnectorTranslationsV1LocaleV1[keyof typeof GetConnectorTranslationsV1LocaleV1]; +/** + * @export + */ +export const GetConnectorV1LocaleV1 = { + De: 'de', + No: 'no', + Fi: 'fi', + Sv: 'sv', + Ru: 'ru', + Pt: 'pt', + Ko: 'ko', + ZhTw: 'zh-TW', + En: 'en', + It: 'it', + Fr: 'fr', + ZhCn: 'zh-CN', + Hu: 'hu', + Es: 'es', + Cs: 'cs', + Ja: 'ja', + Pl: 'pl', + Da: 'da', + Nl: 'nl' +} as const; +export type GetConnectorV1LocaleV1 = typeof GetConnectorV1LocaleV1[keyof typeof GetConnectorV1LocaleV1]; +/** + * @export + */ +export const PutConnectorTranslationsV1LocaleV1 = { + De: 'de', + No: 'no', + Fi: 'fi', + Sv: 'sv', + Ru: 'ru', + Pt: 'pt', + Ko: 'ko', + ZhTw: 'zh-TW', + En: 'en', + It: 'it', + Fr: 'fr', + ZhCn: 'zh-CN', + Hu: 'hu', + Es: 'es', + Cs: 'cs', + Ja: 'ja', + Pl: 'pl', + Da: 'da', + Nl: 'nl' +} as const; +export type PutConnectorTranslationsV1LocaleV1 = typeof PutConnectorTranslationsV1LocaleV1[keyof typeof PutConnectorTranslationsV1LocaleV1]; + + diff --git a/sdk-output/connectors/base.ts b/sdk-output/connectors/base.ts new file mode 100644 index 00000000..5d6182ac --- /dev/null +++ b/sdk-output/connectors/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connectors + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/connectors/common.ts b/sdk-output/connectors/common.ts new file mode 100644 index 00000000..d02a0db6 --- /dev/null +++ b/sdk-output/connectors/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connectors + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/connectors/configuration.ts b/sdk-output/connectors/configuration.ts new file mode 100644 index 00000000..4eba3bd9 --- /dev/null +++ b/sdk-output/connectors/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connectors + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/connectors/git_push.sh b/sdk-output/connectors/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/connectors/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/connectors/index.ts b/sdk-output/connectors/index.ts new file mode 100644 index 00000000..099feeaa --- /dev/null +++ b/sdk-output/connectors/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Connectors + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/connectors/package.json b/sdk-output/connectors/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/connectors/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/connectors/tsconfig.json b/sdk-output/connectors/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/connectors/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/custom_forms/.gitignore b/sdk-output/custom_forms/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/custom_forms/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/custom_forms/.npmignore b/sdk-output/custom_forms/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/custom_forms/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/custom_forms/.openapi-generator-ignore b/sdk-output/custom_forms/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/custom_forms/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/custom_forms/.openapi-generator/FILES b/sdk-output/custom_forms/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/custom_forms/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/custom_forms/.openapi-generator/VERSION b/sdk-output/custom_forms/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/custom_forms/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/custom_forms/.sdk-partition b/sdk-output/custom_forms/.sdk-partition new file mode 100644 index 00000000..a5c1657a --- /dev/null +++ b/sdk-output/custom_forms/.sdk-partition @@ -0,0 +1 @@ +custom-forms \ No newline at end of file diff --git a/sdk-output/custom_forms/README.md b/sdk-output/custom_forms/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_forms/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_forms/api.ts b/sdk-output/custom_forms/api.ts new file mode 100644 index 00000000..baa37358 --- /dev/null +++ b/sdk-output/custom_forms/api.ts @@ -0,0 +1,3149 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Forms + * 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'; + +/** + * Arbitrary map containing a configuration based on the EffectType. + * @export + * @interface ConditioneffectConfigV1 + */ +export interface ConditioneffectConfigV1 { + /** + * Effect type\'s label. + * @type {string} + * @memberof ConditioneffectConfigV1 + */ + 'defaultValueLabel'?: string; + /** + * Element\'s identifier. + * @type {string} + * @memberof ConditioneffectConfigV1 + */ + 'element'?: string; +} +/** + * Effect produced by a condition. + * @export + * @interface ConditioneffectV1 + */ +export interface ConditioneffectV1 { + /** + * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. + * @type {string} + * @memberof ConditioneffectV1 + */ + 'effectType'?: ConditioneffectV1EffectTypeV1; + /** + * + * @type {ConditioneffectConfigV1} + * @memberof ConditioneffectV1 + */ + 'config'?: ConditioneffectConfigV1; +} + +export const ConditioneffectV1EffectTypeV1 = { + Hide: 'HIDE', + Show: 'SHOW', + Disable: 'DISABLE', + Enable: 'ENABLE', + Require: 'REQUIRE', + Optional: 'OPTIONAL', + SubmitMessage: 'SUBMIT_MESSAGE', + SubmitNotification: 'SUBMIT_NOTIFICATION', + SetDefaultValue: 'SET_DEFAULT_VALUE' +} as const; + +export type ConditioneffectV1EffectTypeV1 = typeof ConditioneffectV1EffectTypeV1[keyof typeof ConditioneffectV1EffectTypeV1]; + +/** + * + * @export + * @interface ConditionruleV1 + */ +export interface ConditionruleV1 { + /** + * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement + * @type {string} + * @memberof ConditionruleV1 + */ + 'sourceType'?: ConditionruleV1SourceTypeV1; + /** + * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. + * @type {string} + * @memberof ConditionruleV1 + */ + 'source'?: string; + /** + * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith + * @type {string} + * @memberof ConditionruleV1 + */ + 'operator'?: ConditionruleV1OperatorV1; + /** + * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean + * @type {string} + * @memberof ConditionruleV1 + */ + 'valueType'?: ConditionruleV1ValueTypeV1; + /** + * Based on the ValueType. + * @type {string} + * @memberof ConditionruleV1 + */ + 'value'?: string; +} + +export const ConditionruleV1SourceTypeV1 = { + Input: 'INPUT', + Element: 'ELEMENT' +} as const; + +export type ConditionruleV1SourceTypeV1 = typeof ConditionruleV1SourceTypeV1[keyof typeof ConditionruleV1SourceTypeV1]; +export const ConditionruleV1OperatorV1 = { + Eq: 'EQ', + Ne: 'NE', + Co: 'CO', + NotCo: 'NOT_CO', + In: 'IN', + NotIn: 'NOT_IN', + Em: 'EM', + NotEm: 'NOT_EM', + Sw: 'SW', + NotSw: 'NOT_SW', + Ew: 'EW', + NotEw: 'NOT_EW' +} as const; + +export type ConditionruleV1OperatorV1 = typeof ConditionruleV1OperatorV1[keyof typeof ConditionruleV1OperatorV1]; +export const ConditionruleV1ValueTypeV1 = { + String: 'STRING', + StringList: 'STRING_LIST', + Input: 'INPUT', + Element: 'ELEMENT', + List: 'LIST', + Boolean: 'BOOLEAN' +} as const; + +export type ConditionruleV1ValueTypeV1 = typeof ConditionruleV1ValueTypeV1[keyof typeof ConditionruleV1ValueTypeV1]; + +/** + * + * @export + * @interface CreateFormDefinitionFileRequestV1RequestV1 + */ +export interface CreateFormDefinitionFileRequestV1RequestV1 { + /** + * File specifying the multipart + * @type {File} + * @memberof CreateFormDefinitionFileRequestV1RequestV1 + */ + 'file': File; +} +/** + * + * @export + * @interface CreateformdefinitionrequestV1 + */ +export interface CreateformdefinitionrequestV1 { + /** + * Description is the form definition description + * @type {string} + * @memberof CreateformdefinitionrequestV1 + */ + 'description'?: string; + /** + * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + * @type {Array} + * @memberof CreateformdefinitionrequestV1 + */ + 'formConditions'?: Array; + /** + * FormElements is a list of nested form elements + * @type {Array} + * @memberof CreateformdefinitionrequestV1 + */ + 'formElements'?: Array; + /** + * FormInput is a list of form inputs that are required when creating a form-instance object + * @type {Array} + * @memberof CreateformdefinitionrequestV1 + */ + 'formInput'?: Array; + /** + * Name is the form definition name + * @type {string} + * @memberof CreateformdefinitionrequestV1 + */ + 'name': string; + /** + * + * @type {FormownerV1} + * @memberof CreateformdefinitionrequestV1 + */ + 'owner': FormownerV1; + /** + * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used + * @type {Array} + * @memberof CreateformdefinitionrequestV1 + */ + 'usedBy'?: Array; +} +/** + * + * @export + * @interface CreateforminstancerequestV1 + */ +export interface CreateforminstancerequestV1 { + /** + * + * @type {ForminstancecreatedbyV1} + * @memberof CreateforminstancerequestV1 + */ + 'createdBy': ForminstancecreatedbyV1; + /** + * Expire is required + * @type {string} + * @memberof CreateforminstancerequestV1 + */ + 'expire': string; + /** + * FormDefinitionID is the id of the form definition that created this form + * @type {string} + * @memberof CreateforminstancerequestV1 + */ + 'formDefinitionId': string; + /** + * FormInput is an object of form input labels to value + * @type {{ [key: string]: any; }} + * @memberof CreateforminstancerequestV1 + */ + 'formInput'?: { [key: string]: any; }; + /** + * Recipients is required + * @type {Array} + * @memberof CreateforminstancerequestV1 + */ + 'recipients': Array; + /** + * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form + * @type {boolean} + * @memberof CreateforminstancerequestV1 + */ + 'standAloneForm'?: boolean; + /** + * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled + * @type {string} + * @memberof CreateforminstancerequestV1 + */ + 'state'?: CreateforminstancerequestV1StateV1; + /** + * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html + * @type {number} + * @memberof CreateforminstancerequestV1 + */ + 'ttl'?: number; +} + +export const CreateforminstancerequestV1StateV1 = { + Assigned: 'ASSIGNED', + InProgress: 'IN_PROGRESS', + Submitted: 'SUBMITTED', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED' +} as const; + +export type CreateforminstancerequestV1StateV1 = typeof CreateforminstancerequestV1StateV1[keyof typeof CreateforminstancerequestV1StateV1]; + +/** + * + * @export + * @interface ErrorV1 + */ +export interface ErrorV1 { + /** + * DetailCode is the text of the status code returned + * @type {string} + * @memberof ErrorV1 + */ + 'detailCode'?: string; + /** + * + * @type {Array} + * @memberof ErrorV1 + */ + 'messages'?: Array; + /** + * TrackingID is the request tracking unique identifier + * @type {string} + * @memberof ErrorV1 + */ + 'trackingId'?: string; +} +/** + * + * @export + * @interface ErrormessageV1 + */ +export interface ErrormessageV1 { + /** + * Locale is the current Locale + * @type {string} + * @memberof ErrormessageV1 + */ + 'locale'?: string; + /** + * LocaleOrigin holds possible values of how the locale was selected + * @type {string} + * @memberof ErrormessageV1 + */ + 'localeOrigin'?: string; + /** + * Text is the actual text of the error message + * @type {string} + * @memberof ErrormessageV1 + */ + 'text'?: string; +} +/** + * + * @export + * @interface ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 + */ +export interface ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 { + /** + * + * @type {FormdefinitionselfimportexportdtoV1} + * @memberof ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 + */ + 'object'?: FormdefinitionselfimportexportdtoV1; +} +/** + * + * @export + * @interface ExportFormDefinitionsByTenantV1200ResponseInnerV1 + */ +export interface ExportFormDefinitionsByTenantV1200ResponseInnerV1 { + /** + * + * @type {FormdefinitionresponseV1} + * @memberof ExportFormDefinitionsByTenantV1200ResponseInnerV1 + */ + 'object'?: FormdefinitionresponseV1; + /** + * + * @type {ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1} + * @memberof ExportFormDefinitionsByTenantV1200ResponseInnerV1 + */ + 'self'?: ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1; + /** + * + * @type {number} + * @memberof ExportFormDefinitionsByTenantV1200ResponseInnerV1 + */ + 'version'?: number; +} +/** + * Represent a form conditional. + * @export + * @interface FormconditionV1 + */ +export interface FormconditionV1 { + /** + * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr + * @type {string} + * @memberof FormconditionV1 + */ + 'ruleOperator'?: FormconditionV1RuleOperatorV1; + /** + * List of rules. + * @type {Array} + * @memberof FormconditionV1 + */ + 'rules'?: Array; + /** + * List of effects. + * @type {Array} + * @memberof FormconditionV1 + */ + 'effects'?: Array; +} + +export const FormconditionV1RuleOperatorV1 = { + And: 'AND', + Or: 'OR' +} as const; + +export type FormconditionV1RuleOperatorV1 = typeof FormconditionV1RuleOperatorV1[keyof typeof FormconditionV1RuleOperatorV1]; + +/** + * + * @export + * @interface FormdefinitiondynamicschemarequestAttributesV1 + */ +export interface FormdefinitiondynamicschemarequestAttributesV1 { + /** + * FormDefinitionID is a unique guid identifying this form definition + * @type {string} + * @memberof FormdefinitiondynamicschemarequestAttributesV1 + */ + 'formDefinitionId'?: string; +} +/** + * + * @export + * @interface FormdefinitiondynamicschemarequestV1 + */ +export interface FormdefinitiondynamicschemarequestV1 { + /** + * + * @type {FormdefinitiondynamicschemarequestAttributesV1} + * @memberof FormdefinitiondynamicschemarequestV1 + */ + 'attributes'?: FormdefinitiondynamicschemarequestAttributesV1; + /** + * Description is the form definition dynamic schema description text + * @type {string} + * @memberof FormdefinitiondynamicschemarequestV1 + */ + 'description'?: string; + /** + * ID is a unique identifier + * @type {string} + * @memberof FormdefinitiondynamicschemarequestV1 + */ + 'id'?: string; + /** + * Type is the form definition dynamic schema type + * @type {string} + * @memberof FormdefinitiondynamicschemarequestV1 + */ + 'type'?: string; + /** + * VersionNumber is the form definition dynamic schema version number + * @type {number} + * @memberof FormdefinitiondynamicschemarequestV1 + */ + 'versionNumber'?: number; +} +/** + * + * @export + * @interface FormdefinitiondynamicschemaresponseV1 + */ +export interface FormdefinitiondynamicschemaresponseV1 { + /** + * OutputSchema holds a JSON schema generated dynamically + * @type {{ [key: string]: any; }} + * @memberof FormdefinitiondynamicschemaresponseV1 + */ + 'outputSchema'?: { [key: string]: any; }; +} +/** + * + * @export + * @interface FormdefinitionfileuploadresponseV1 + */ +export interface FormdefinitionfileuploadresponseV1 { + /** + * Created is the date the file was uploaded + * @type {string} + * @memberof FormdefinitionfileuploadresponseV1 + */ + 'created'?: string; + /** + * fileId is a unique ULID that serves as an identifier for the form definition file + * @type {string} + * @memberof FormdefinitionfileuploadresponseV1 + */ + 'fileId'?: string; + /** + * FormDefinitionID is a unique guid identifying this form definition + * @type {string} + * @memberof FormdefinitionfileuploadresponseV1 + */ + 'formDefinitionId'?: string; +} +/** + * + * @export + * @interface FormdefinitioninputV1 + */ +export interface FormdefinitioninputV1 { + /** + * Unique identifier for the form input. + * @type {string} + * @memberof FormdefinitioninputV1 + */ + 'id'?: string; + /** + * FormDefinitionInputType value. STRING FormDefinitionInputTypeString + * @type {string} + * @memberof FormdefinitioninputV1 + */ + 'type'?: FormdefinitioninputV1TypeV1; + /** + * Name for the form input. + * @type {string} + * @memberof FormdefinitioninputV1 + */ + 'label'?: string; + /** + * Form input\'s description. + * @type {string} + * @memberof FormdefinitioninputV1 + */ + 'description'?: string; +} + +export const FormdefinitioninputV1TypeV1 = { + String: 'STRING', + Array: 'ARRAY' +} as const; + +export type FormdefinitioninputV1TypeV1 = typeof FormdefinitioninputV1TypeV1[keyof typeof FormdefinitioninputV1TypeV1]; + +/** + * + * @export + * @interface FormdefinitionresponseV1 + */ +export interface FormdefinitionresponseV1 { + /** + * Unique guid identifying the form definition. + * @type {string} + * @memberof FormdefinitionresponseV1 + */ + 'id'?: string; + /** + * Name of the form definition. + * @type {string} + * @memberof FormdefinitionresponseV1 + */ + 'name'?: string; + /** + * Form definition\'s description. + * @type {string} + * @memberof FormdefinitionresponseV1 + */ + 'description'?: string; + /** + * + * @type {FormownerV1} + * @memberof FormdefinitionresponseV1 + */ + 'owner'?: FormownerV1; + /** + * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + * @type {Array} + * @memberof FormdefinitionresponseV1 + */ + 'usedBy'?: Array; + /** + * List of form inputs required to create a form-instance object. + * @type {Array} + * @memberof FormdefinitionresponseV1 + */ + 'formInput'?: Array; + /** + * List of nested form elements. + * @type {Array} + * @memberof FormdefinitionresponseV1 + */ + 'formElements'?: Array; + /** + * Conditional logic that can dynamically modify the form as the recipient is interacting with it. + * @type {Array} + * @memberof FormdefinitionresponseV1 + */ + 'formConditions'?: Array; + /** + * Created is the date the form definition was created + * @type {string} + * @memberof FormdefinitionresponseV1 + */ + 'created'?: string; + /** + * Modified is the last date the form definition was modified + * @type {string} + * @memberof FormdefinitionresponseV1 + */ + 'modified'?: string; +} +/** + * Self block for imported/exported object. + * @export + * @interface FormdefinitionselfimportexportdtoV1 + */ +export interface FormdefinitionselfimportexportdtoV1 { + /** + * Imported/exported object\'s DTO type. + * @type {string} + * @memberof FormdefinitionselfimportexportdtoV1 + */ + 'type'?: FormdefinitionselfimportexportdtoV1TypeV1; + /** + * Imported/exported object\'s ID. + * @type {string} + * @memberof FormdefinitionselfimportexportdtoV1 + */ + 'id'?: string; + /** + * Imported/exported object\'s display name. + * @type {string} + * @memberof FormdefinitionselfimportexportdtoV1 + */ + 'name'?: string; +} + +export const FormdefinitionselfimportexportdtoV1TypeV1 = { + FormDefinition: 'FORM_DEFINITION' +} as const; + +export type FormdefinitionselfimportexportdtoV1TypeV1 = typeof FormdefinitionselfimportexportdtoV1TypeV1[keyof typeof FormdefinitionselfimportexportdtoV1TypeV1]; + +/** + * + * @export + * @interface FormelementV1 + */ +export interface FormelementV1 { + /** + * Form element identifier. + * @type {string} + * @memberof FormelementV1 + */ + 'id'?: string; + /** + * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription + * @type {string} + * @memberof FormelementV1 + */ + 'elementType'?: FormelementV1ElementTypeV1; + /** + * Config object. + * @type {{ [key: string]: any; }} + * @memberof FormelementV1 + */ + 'config'?: { [key: string]: any; }; + /** + * Technical key. + * @type {string} + * @memberof FormelementV1 + */ + 'key'?: string; + /** + * + * @type {Array} + * @memberof FormelementV1 + */ + 'validations'?: Array | null; +} + +export const FormelementV1ElementTypeV1 = { + Text: 'TEXT', + Toggle: 'TOGGLE', + Textarea: 'TEXTAREA', + Hidden: 'HIDDEN', + Phone: 'PHONE', + Email: 'EMAIL', + Select: 'SELECT', + Date: 'DATE', + Section: 'SECTION', + ColumnSet: 'COLUMN_SET', + Image: 'IMAGE', + Description: 'DESCRIPTION' +} as const; + +export type FormelementV1ElementTypeV1 = typeof FormelementV1ElementTypeV1[keyof typeof FormelementV1ElementTypeV1]; + +/** + * + * @export + * @interface FormelementdatasourceconfigoptionsV1 + */ +export interface FormelementdatasourceconfigoptionsV1 { + /** + * Label is the main label to display to the user when selecting this option + * @type {string} + * @memberof FormelementdatasourceconfigoptionsV1 + */ + 'label'?: string; + /** + * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option + * @type {string} + * @memberof FormelementdatasourceconfigoptionsV1 + */ + 'subLabel'?: string; + /** + * Value is the value to save as an entry when the user selects this option + * @type {string} + * @memberof FormelementdatasourceconfigoptionsV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface FormelementdynamicdatasourceV1 + */ +export interface FormelementdynamicdatasourceV1 { + /** + * + * @type {FormelementdynamicdatasourceconfigV1} + * @memberof FormelementdynamicdatasourceV1 + */ + 'config'?: FormelementdynamicdatasourceconfigV1; + /** + * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput + * @type {string} + * @memberof FormelementdynamicdatasourceV1 + */ + 'dataSourceType'?: FormelementdynamicdatasourceV1DataSourceTypeV1; +} + +export const FormelementdynamicdatasourceV1DataSourceTypeV1 = { + Static: 'STATIC', + Internal: 'INTERNAL', + Search: 'SEARCH', + FormInput: 'FORM_INPUT' +} as const; + +export type FormelementdynamicdatasourceV1DataSourceTypeV1 = typeof FormelementdynamicdatasourceV1DataSourceTypeV1[keyof typeof FormelementdynamicdatasourceV1DataSourceTypeV1]; + +/** + * + * @export + * @interface FormelementdynamicdatasourceconfigV1 + */ +export interface FormelementdynamicdatasourceconfigV1 { + /** + * AggregationBucketField is the aggregation bucket field name + * @type {string} + * @memberof FormelementdynamicdatasourceconfigV1 + */ + 'aggregationBucketField'?: string; + /** + * Indices is a list of indices to use + * @type {Array} + * @memberof FormelementdynamicdatasourceconfigV1 + */ + 'indices'?: Array; + /** + * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement + * @type {string} + * @memberof FormelementdynamicdatasourceconfigV1 + */ + 'objectType'?: FormelementdynamicdatasourceconfigV1ObjectTypeV1; + /** + * Query is a text + * @type {string} + * @memberof FormelementdynamicdatasourceconfigV1 + */ + 'query'?: string; +} + +export const FormelementdynamicdatasourceconfigV1IndicesV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Identities: 'identities', + Events: 'events', + Roles: 'roles', + Star: '*' +} as const; + +export type FormelementdynamicdatasourceconfigV1IndicesV1 = typeof FormelementdynamicdatasourceconfigV1IndicesV1[keyof typeof FormelementdynamicdatasourceconfigV1IndicesV1]; +export const FormelementdynamicdatasourceconfigV1ObjectTypeV1 = { + Identity: 'IDENTITY', + AccessProfile: 'ACCESS_PROFILE', + Sources: 'SOURCES', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type FormelementdynamicdatasourceconfigV1ObjectTypeV1 = typeof FormelementdynamicdatasourceconfigV1ObjectTypeV1[keyof typeof FormelementdynamicdatasourceconfigV1ObjectTypeV1]; + +/** + * + * @export + * @interface FormelementpreviewrequestV1 + */ +export interface FormelementpreviewrequestV1 { + /** + * + * @type {FormelementdynamicdatasourceV1} + * @memberof FormelementpreviewrequestV1 + */ + 'dataSource'?: FormelementdynamicdatasourceV1; +} +/** + * Set of FormElementValidation items. + * @export + * @interface FormelementvalidationssetV1 + */ +export interface FormelementvalidationssetV1 { + /** + * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. + * @type {string} + * @memberof FormelementvalidationssetV1 + */ + 'validationType'?: FormelementvalidationssetV1ValidationTypeV1; +} + +export const FormelementvalidationssetV1ValidationTypeV1 = { + Required: 'REQUIRED', + MinLength: 'MIN_LENGTH', + MaxLength: 'MAX_LENGTH', + Regex: 'REGEX', + Date: 'DATE', + MaxDate: 'MAX_DATE', + MinDate: 'MIN_DATE', + LessThanDate: 'LESS_THAN_DATE', + Phone: 'PHONE', + Email: 'EMAIL', + DataSource: 'DATA_SOURCE', + Textarea: 'TEXTAREA' +} as const; + +export type FormelementvalidationssetV1ValidationTypeV1 = typeof FormelementvalidationssetV1ValidationTypeV1[keyof typeof FormelementvalidationssetV1ValidationTypeV1]; + +/** + * + * @export + * @interface FormerrorV1 + */ +export interface FormerrorV1 { + /** + * Key is the technical key + * @type {string} + * @memberof FormerrorV1 + */ + 'key'?: string; + /** + * Messages is a list of web.ErrorMessage items + * @type {Array} + * @memberof FormerrorV1 + */ + 'messages'?: Array; + /** + * Value is the value associated with a Key + * @type {any} + * @memberof FormerrorV1 + */ + 'value'?: any; +} +/** + * + * @export + * @interface ForminstancecreatedbyV1 + */ +export interface ForminstancecreatedbyV1 { + /** + * ID is a unique identifier + * @type {string} + * @memberof ForminstancecreatedbyV1 + */ + 'id'?: string; + /** + * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource + * @type {string} + * @memberof ForminstancecreatedbyV1 + */ + 'type'?: ForminstancecreatedbyV1TypeV1; +} + +export const ForminstancecreatedbyV1TypeV1 = { + WorkflowExecution: 'WORKFLOW_EXECUTION', + Source: 'SOURCE' +} as const; + +export type ForminstancecreatedbyV1TypeV1 = typeof ForminstancecreatedbyV1TypeV1[keyof typeof ForminstancecreatedbyV1TypeV1]; + +/** + * + * @export + * @interface ForminstancerecipientV1 + */ +export interface ForminstancerecipientV1 { + /** + * ID is a unique identifier + * @type {string} + * @memberof ForminstancerecipientV1 + */ + 'id'?: string; + /** + * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity + * @type {string} + * @memberof ForminstancerecipientV1 + */ + 'type'?: ForminstancerecipientV1TypeV1; +} + +export const ForminstancerecipientV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ForminstancerecipientV1TypeV1 = typeof ForminstancerecipientV1TypeV1[keyof typeof ForminstancerecipientV1TypeV1]; + +/** + * + * @export + * @interface ForminstanceresponseV1 + */ +export interface ForminstanceresponseV1 { + /** + * Unique guid identifying this form instance + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'id'?: string; + /** + * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'expire'?: string; + /** + * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'state'?: ForminstanceresponseV1StateV1; + /** + * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form + * @type {boolean} + * @memberof ForminstanceresponseV1 + */ + 'standAloneForm'?: boolean; + /** + * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'standAloneFormUrl'?: string; + /** + * + * @type {ForminstancecreatedbyV1} + * @memberof ForminstanceresponseV1 + */ + 'createdBy'?: ForminstancecreatedbyV1; + /** + * FormDefinitionID is the id of the form definition that created this form + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'formDefinitionId'?: string; + /** + * FormInput is an object of form input labels to value + * @type {{ [key: string]: any; }} + * @memberof ForminstanceresponseV1 + */ + 'formInput'?: { [key: string]: any; } | null; + /** + * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + * @type {Array} + * @memberof ForminstanceresponseV1 + */ + 'formElements'?: Array; + /** + * FormData is the data provided by the form on submit. The data is in a key -> value map + * @type {{ [key: string]: any; }} + * @memberof ForminstanceresponseV1 + */ + 'formData'?: { [key: string]: any; } | null; + /** + * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + * @type {Array} + * @memberof ForminstanceresponseV1 + */ + 'formErrors'?: Array; + /** + * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + * @type {Array} + * @memberof ForminstanceresponseV1 + */ + 'formConditions'?: Array; + /** + * Created is the date the form instance was assigned + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'created'?: string; + /** + * Modified is the last date the form instance was modified + * @type {string} + * @memberof ForminstanceresponseV1 + */ + 'modified'?: string; + /** + * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + * @type {Array} + * @memberof ForminstanceresponseV1 + */ + 'recipients'?: Array; +} + +export const ForminstanceresponseV1StateV1 = { + Assigned: 'ASSIGNED', + InProgress: 'IN_PROGRESS', + Submitted: 'SUBMITTED', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED' +} as const; + +export type ForminstanceresponseV1StateV1 = typeof ForminstanceresponseV1StateV1[keyof typeof ForminstanceresponseV1StateV1]; + +/** + * + * @export + * @interface FormownerV1 + */ +export interface FormownerV1 { + /** + * FormOwnerType value. IDENTITY FormOwnerTypeIdentity + * @type {string} + * @memberof FormownerV1 + */ + 'type'?: FormownerV1TypeV1; + /** + * Unique identifier of the form\'s owner. + * @type {string} + * @memberof FormownerV1 + */ + 'id'?: string; + /** + * Name of the form\'s owner. + * @type {string} + * @memberof FormownerV1 + */ + 'name'?: string; +} + +export const FormownerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type FormownerV1TypeV1 = typeof FormownerV1TypeV1[keyof typeof FormownerV1TypeV1]; + +/** + * + * @export + * @interface FormusedbyV1 + */ +export interface FormusedbyV1 { + /** + * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType + * @type {string} + * @memberof FormusedbyV1 + */ + 'type'?: FormusedbyV1TypeV1; + /** + * Unique identifier of the system using the form. + * @type {string} + * @memberof FormusedbyV1 + */ + 'id'?: string; + /** + * Name of the system using the form. + * @type {string} + * @memberof FormusedbyV1 + */ + 'name'?: string; +} + +export const FormusedbyV1TypeV1 = { + Workflow: 'WORKFLOW', + Source: 'SOURCE', + MySailPoint: 'MySailPoint' +} as const; + +export type FormusedbyV1TypeV1 = typeof FormusedbyV1TypeV1[keyof typeof FormusedbyV1TypeV1]; + +/** + * + * @export + * @interface ImportFormDefinitionsV1202ResponseErrorsInnerV1 + */ +export interface ImportFormDefinitionsV1202ResponseErrorsInnerV1 { + /** + * + * @type {{ [key: string]: object; }} + * @memberof ImportFormDefinitionsV1202ResponseErrorsInnerV1 + */ + 'detail'?: { [key: string]: object; }; + /** + * + * @type {string} + * @memberof ImportFormDefinitionsV1202ResponseErrorsInnerV1 + */ + 'key'?: string; + /** + * + * @type {string} + * @memberof ImportFormDefinitionsV1202ResponseErrorsInnerV1 + */ + 'text'?: string; +} +/** + * + * @export + * @interface ImportFormDefinitionsV1202ResponseV1 + */ +export interface ImportFormDefinitionsV1202ResponseV1 { + /** + * + * @type {Array} + * @memberof ImportFormDefinitionsV1202ResponseV1 + */ + 'errors'?: Array; + /** + * + * @type {Array} + * @memberof ImportFormDefinitionsV1202ResponseV1 + */ + 'importedObjects'?: Array; + /** + * + * @type {Array} + * @memberof ImportFormDefinitionsV1202ResponseV1 + */ + 'infos'?: Array; + /** + * + * @type {Array} + * @memberof ImportFormDefinitionsV1202ResponseV1 + */ + 'warnings'?: Array; +} +/** + * + * @export + * @interface ImportFormDefinitionsV1RequestInnerV1 + */ +export interface ImportFormDefinitionsV1RequestInnerV1 { + /** + * + * @type {FormdefinitionresponseV1} + * @memberof ImportFormDefinitionsV1RequestInnerV1 + */ + 'object'?: FormdefinitionresponseV1; + /** + * + * @type {string} + * @memberof ImportFormDefinitionsV1RequestInnerV1 + */ + 'self'?: string; + /** + * + * @type {number} + * @memberof ImportFormDefinitionsV1RequestInnerV1 + */ + 'version'?: number; +} +/** + * + * @export + * @interface ListformdefinitionsbytenantresponseV1 + */ +export interface ListformdefinitionsbytenantresponseV1 { + /** + * Count number of results. + * @type {number} + * @memberof ListformdefinitionsbytenantresponseV1 + */ + 'count'?: number; + /** + * List of FormDefinitionResponse items. + * @type {Array} + * @memberof ListformdefinitionsbytenantresponseV1 + */ + 'results'?: Array; +} +/** + * + * @export + * @interface ListformelementdatabyelementidresponseV1 + */ +export interface ListformelementdatabyelementidresponseV1 { + /** + * Results holds a list of FormElementDataSourceConfigOptions items + * @type {Array} + * @memberof ListformelementdatabyelementidresponseV1 + */ + 'results'?: Array; +} +/** + * List of FormInstanceResponse items + * @export + * @interface ListforminstancesbytenantresponseV1 + */ +export interface ListforminstancesbytenantresponseV1 { + /** + * Unique guid identifying this form instance + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'id'?: string; + /** + * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'expire'?: string; + /** + * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'state'?: ListforminstancesbytenantresponseV1StateV1; + /** + * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form + * @type {boolean} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'standAloneForm'?: boolean; + /** + * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'standAloneFormUrl'?: string; + /** + * + * @type {ForminstancecreatedbyV1} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'createdBy'?: ForminstancecreatedbyV1; + /** + * FormDefinitionID is the id of the form definition that created this form + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formDefinitionId'?: string; + /** + * FormInput is an object of form input labels to value + * @type {{ [key: string]: any; }} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formInput'?: { [key: string]: any; } | null; + /** + * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config + * @type {Array} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formElements'?: Array; + /** + * FormData is the data provided by the form on submit. The data is in a key -> value map + * @type {{ [key: string]: any; }} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formData'?: { [key: string]: any; } | null; + /** + * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors + * @type {Array} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formErrors'?: Array; + /** + * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form + * @type {Array} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'formConditions'?: Array; + /** + * Created is the date the form instance was assigned + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'created'?: string; + /** + * Modified is the last date the form instance was modified + * @type {string} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'modified'?: string; + /** + * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it + * @type {Array} + * @memberof ListforminstancesbytenantresponseV1 + */ + 'recipients'?: Array; +} + +export const ListforminstancesbytenantresponseV1StateV1 = { + Assigned: 'ASSIGNED', + InProgress: 'IN_PROGRESS', + Submitted: 'SUBMITTED', + Completed: 'COMPLETED', + Cancelled: 'CANCELLED' +} as const; + +export type ListforminstancesbytenantresponseV1StateV1 = typeof ListforminstancesbytenantresponseV1StateV1[keyof typeof ListforminstancesbytenantresponseV1StateV1]; + +/** + * + * @export + * @interface ListpredefinedselectoptionsresponseV1 + */ +export interface ListpredefinedselectoptionsresponseV1 { + /** + * Results holds a list of PreDefinedSelectOption items + * @type {Array} + * @memberof ListpredefinedselectoptionsresponseV1 + */ + 'results'?: Array; +} +/** + * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint + * @export + * @interface PreviewdatasourceresponseV1 + */ +export interface PreviewdatasourceresponseV1 { + /** + * Results holds a list of FormElementDataSourceConfigOptions items + * @type {Array} + * @memberof PreviewdatasourceresponseV1 + */ + 'results'?: Array; +} +/** + * + * @export + * @interface SearchFormDefinitionsByTenantV1400ResponseV1 + */ +export interface SearchFormDefinitionsByTenantV1400ResponseV1 { + /** + * + * @type {string} + * @memberof SearchFormDefinitionsByTenantV1400ResponseV1 + */ + 'detailCode'?: string; + /** + * + * @type {Array} + * @memberof SearchFormDefinitionsByTenantV1400ResponseV1 + */ + 'messages'?: Array; + /** + * + * @type {number} + * @memberof SearchFormDefinitionsByTenantV1400ResponseV1 + */ + 'statusCode'?: number; + /** + * + * @type {string} + * @memberof SearchFormDefinitionsByTenantV1400ResponseV1 + */ + 'trackingId'?: string; +} + +/** + * CustomFormsV1Api - axios parameter creator + * @export + */ +export const CustomFormsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Generate json schema dynamically. + * @param {FormdefinitiondynamicschemarequestV1} [body] Body is the request payload to create a form definition dynamic schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionDynamicSchemaV1: async (body?: FormdefinitiondynamicschemarequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/v1/forms-action-dynamic-schema`; + // 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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Upload new form definition file. + * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID + * @param {File} file File specifying the multipart + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionFileRequestV1: async (formDefinitionID: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('createFormDefinitionFileRequestV1', 'formDefinitionID', formDefinitionID) + // verify required parameter 'file' is not null or undefined + assertParamExists('createFormDefinitionFileRequestV1', 'file', file) + const localVarPath = `/form-definitions/v1/{formDefinitionID}/upload` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Creates a form definition. + * @param {CreateformdefinitionrequestV1} [body] Body is the request payload to create form definition request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionV1: async (body?: CreateformdefinitionrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Creates a form instance. + * @param {CreateforminstancerequestV1} [body] Body is the request payload to create a form instance + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormInstanceV1: async (body?: CreateforminstancerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-instances/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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Deletes a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteFormDefinitionV1: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('deleteFormDefinitionV1', 'formDefinitionID', formDefinitionID) + const localVarPath = `/form-definitions/v1/{formDefinitionID}` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); + // 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, + }; + }, + /** + * No parameters required. + * @summary List form definitions by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @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: **name, description, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportFormDefinitionsByTenantV1: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/v1/export`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + 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, + }; + }, + /** + * + * @summary Download definition file by fileid. + * @param {string} formDefinitionID FormDefinitionID Form definition ID + * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFileFromS3V1: async (formDefinitionID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('getFileFromS3V1', 'formDefinitionID', formDefinitionID) + // verify required parameter 'fileID' is not null or undefined + assertParamExists('getFileFromS3V1', 'fileID', fileID) + const localVarPath = `/form-definitions/v1/{formDefinitionID}/file/{fileID}` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))) + .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); + // 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, + }; + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Return a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormDefinitionByKeyV1: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('getFormDefinitionByKeyV1', 'formDefinitionID', formDefinitionID) + const localVarPath = `/form-definitions/v1/{formDefinitionID}` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); + // 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, + }; + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Returns a form instance. + * @param {string} formInstanceID Form instance ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormInstanceByKeyV1: async (formInstanceID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formInstanceID' is not null or undefined + assertParamExists('getFormInstanceByKeyV1', 'formInstanceID', formInstanceID) + const localVarPath = `/form-instances/v1/{formInstanceID}` + .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); + // 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, + }; + }, + /** + * + * @summary Download instance file by fileid. + * @param {string} formInstanceID FormInstanceID Form instance ID + * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormInstanceFileV1: async (formInstanceID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formInstanceID' is not null or undefined + assertParamExists('getFormInstanceFileV1', 'formInstanceID', formInstanceID) + // verify required parameter 'fileID' is not null or undefined + assertParamExists('getFormInstanceFileV1', 'fileID', fileID) + const localVarPath = `/form-instances/v1/{formInstanceID}/file/{fileID}` + .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) + .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); + // 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, + }; + }, + /** + * + * @summary Import form definitions from export. + * @param {Array} [body] Body is the request payload to import form definitions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importFormDefinitionsV1: async (body?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/v1/import`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Patch a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchFormDefinitionV1: async (formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('patchFormDefinitionV1', 'formDefinitionID', formDefinitionID) + const localVarPath = `/form-definitions/v1/{formDefinitionID}` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); + // 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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Patch a form instance. + * @param {string} formInstanceID Form instance ID + * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchFormInstanceV1: async (formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formInstanceID' is not null or undefined + assertParamExists('patchFormInstanceV1', 'formInstanceID', formInstanceID) + const localVarPath = `/form-instances/v1/{formInstanceID}` + .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); + // 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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * No parameters required. + * @summary Export form definitions by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @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: **name, description, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormDefinitionsByTenantV1: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/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 (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, + }; + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. + * @summary Retrieves dynamic data by element. + * @param {string} formInstanceID Form instance ID + * @param {string} formElementID Form element ID + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormElementDataByElementIDV1: async (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formInstanceID' is not null or undefined + assertParamExists('searchFormElementDataByElementIDV1', 'formInstanceID', formInstanceID) + // verify required parameter 'formElementID' is not null or undefined + assertParamExists('searchFormElementDataByElementIDV1', 'formElementID', formElementID) + const localVarPath = `/form-instances/v1/{formInstanceID}/data-source/{formElementID}` + .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) + .replace(`{${"formElementID"}}`, encodeURIComponent(String(formElementID))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (query !== undefined) { + localVarQueryParameter['query'] = query; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns a list of form instances for the tenant. Optionally filter by form definition ID. + * @summary List form instances by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **formDefinitionId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormInstancesByTenantV1: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-instances/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 (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, + }; + }, + /** + * No parameters required. + * @summary List predefined select options. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchPreDefinedSelectOptionsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/form-definitions/v1/predefined-select-options`; + // 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, + }; + }, + /** + * + * @summary Preview form definition data source. + * @param {string} formDefinitionID Form definition ID + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @param {FormelementpreviewrequestV1} [formelementpreviewrequestV1] Body is the request payload to create a form definition dynamic schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + showPreviewDataSourceV1: async (formDefinitionID: string, limit?: number, filters?: string, query?: string, formelementpreviewrequestV1?: FormelementpreviewrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'formDefinitionID' is not null or undefined + assertParamExists('showPreviewDataSourceV1', 'formDefinitionID', formDefinitionID) + const localVarPath = `/form-definitions/v1/{formDefinitionID}/data-source` + .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); + // 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; + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (query !== undefined) { + localVarQueryParameter['query'] = query; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(formelementpreviewrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CustomFormsV1Api - functional programming interface + * @export + */ +export const CustomFormsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CustomFormsV1ApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Generate json schema dynamically. + * @param {FormdefinitiondynamicschemarequestV1} [body] Body is the request payload to create a form definition dynamic schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createFormDefinitionDynamicSchemaV1(body?: FormdefinitiondynamicschemarequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionDynamicSchemaV1(body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.createFormDefinitionDynamicSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Upload new form definition file. + * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID + * @param {File} file File specifying the multipart + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createFormDefinitionFileRequestV1(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionFileRequestV1(formDefinitionID, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.createFormDefinitionFileRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Creates a form definition. + * @param {CreateformdefinitionrequestV1} [body] Body is the request payload to create form definition request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createFormDefinitionV1(body?: CreateformdefinitionrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionV1(body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.createFormDefinitionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Creates a form instance. + * @param {CreateforminstancerequestV1} [body] Body is the request payload to create a form instance + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createFormInstanceV1(body?: CreateforminstancerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFormInstanceV1(body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.createFormInstanceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Deletes a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteFormDefinitionV1(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFormDefinitionV1(formDefinitionID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.deleteFormDefinitionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * No parameters required. + * @summary List form definitions by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @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: **name, description, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportFormDefinitionsByTenantV1(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportFormDefinitionsByTenantV1(offset, limit, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.exportFormDefinitionsByTenantV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Download definition file by fileid. + * @param {string} formDefinitionID FormDefinitionID Form definition ID + * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getFileFromS3V1(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileFromS3V1(formDefinitionID, fileID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.getFileFromS3V1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Return a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getFormDefinitionByKeyV1(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFormDefinitionByKeyV1(formDefinitionID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.getFormDefinitionByKeyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Returns a form instance. + * @param {string} formInstanceID Form instance ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getFormInstanceByKeyV1(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceByKeyV1(formInstanceID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.getFormInstanceByKeyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Download instance file by fileid. + * @param {string} formInstanceID FormInstanceID Form instance ID + * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getFormInstanceFileV1(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceFileV1(formInstanceID, fileID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.getFormInstanceFileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Import form definitions from export. + * @param {Array} [body] Body is the request payload to import form definitions + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importFormDefinitionsV1(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importFormDefinitionsV1(body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.importFormDefinitionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Patch a form definition. + * @param {string} formDefinitionID Form definition ID + * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchFormDefinitionV1(formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormDefinitionV1(formDefinitionID, body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.patchFormDefinitionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Patch a form instance. + * @param {string} formInstanceID Form instance ID + * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchFormInstanceV1(formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormInstanceV1(formInstanceID, body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.patchFormInstanceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * No parameters required. + * @summary Export form definitions by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @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: **name, description, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchFormDefinitionsByTenantV1(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormDefinitionsByTenantV1(offset, limit, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.searchFormDefinitionsByTenantV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. + * @summary Retrieves dynamic data by element. + * @param {string} formInstanceID Form instance ID + * @param {string} formElementID Form element ID + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchFormElementDataByElementIDV1(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormElementDataByElementIDV1(formInstanceID, formElementID, limit, filters, query, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.searchFormElementDataByElementIDV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of form instances for the tenant. Optionally filter by form definition ID. + * @summary List form instances by tenant. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **formDefinitionId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchFormInstancesByTenantV1(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenantV1(offset, limit, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.searchFormInstancesByTenantV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * No parameters required. + * @summary List predefined select options. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchPreDefinedSelectOptionsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.searchPreDefinedSelectOptionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Preview form definition data source. + * @param {string} formDefinitionID Form definition ID + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @param {FormelementpreviewrequestV1} [formelementpreviewrequestV1] Body is the request payload to create a form definition dynamic schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async showPreviewDataSourceV1(formDefinitionID: string, limit?: number, filters?: string, query?: string, formelementpreviewrequestV1?: FormelementpreviewrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.showPreviewDataSourceV1(formDefinitionID, limit, filters, query, formelementpreviewrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomFormsV1Api.showPreviewDataSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CustomFormsV1Api - factory interface + * @export + */ +export const CustomFormsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CustomFormsV1ApiFp(configuration) + return { + /** + * + * @summary Generate json schema dynamically. + * @param {CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionDynamicSchemaV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createFormDefinitionDynamicSchemaV1(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Upload new form definition file. + * @param {CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionFileRequestV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createFormDefinitionFileRequestV1(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Creates a form definition. + * @param {CustomFormsV1ApiCreateFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormDefinitionV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createFormDefinitionV1(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Creates a form instance. + * @param {CustomFormsV1ApiCreateFormInstanceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createFormInstanceV1(requestParameters: CustomFormsV1ApiCreateFormInstanceV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createFormInstanceV1(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Deletes a form definition. + * @param {CustomFormsV1ApiDeleteFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteFormDefinitionV1(requestParameters: CustomFormsV1ApiDeleteFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteFormDefinitionV1(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * No parameters required. + * @summary List form definitions by tenant. + * @param {CustomFormsV1ApiExportFormDefinitionsByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportFormDefinitionsByTenantV1(requestParameters: CustomFormsV1ApiExportFormDefinitionsByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.exportFormDefinitionsByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Download definition file by fileid. + * @param {CustomFormsV1ApiGetFileFromS3V1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFileFromS3V1(requestParameters: CustomFormsV1ApiGetFileFromS3V1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getFileFromS3V1(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Return a form definition. + * @param {CustomFormsV1ApiGetFormDefinitionByKeyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormDefinitionByKeyV1(requestParameters: CustomFormsV1ApiGetFormDefinitionByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getFormDefinitionByKeyV1(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Returns a form instance. + * @param {CustomFormsV1ApiGetFormInstanceByKeyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormInstanceByKeyV1(requestParameters: CustomFormsV1ApiGetFormInstanceByKeyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getFormInstanceByKeyV1(requestParameters.formInstanceID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Download instance file by fileid. + * @param {CustomFormsV1ApiGetFormInstanceFileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getFormInstanceFileV1(requestParameters: CustomFormsV1ApiGetFormInstanceFileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getFormInstanceFileV1(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Import form definitions from export. + * @param {CustomFormsV1ApiImportFormDefinitionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importFormDefinitionsV1(requestParameters: CustomFormsV1ApiImportFormDefinitionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importFormDefinitionsV1(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Patch a form definition. + * @param {CustomFormsV1ApiPatchFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchFormDefinitionV1(requestParameters: CustomFormsV1ApiPatchFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchFormDefinitionV1(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Patch a form instance. + * @param {CustomFormsV1ApiPatchFormInstanceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchFormInstanceV1(requestParameters: CustomFormsV1ApiPatchFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchFormInstanceV1(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * No parameters required. + * @summary Export form definitions by tenant. + * @param {CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormDefinitionsByTenantV1(requestParameters: CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchFormDefinitionsByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. + * @summary Retrieves dynamic data by element. + * @param {CustomFormsV1ApiSearchFormElementDataByElementIDV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormElementDataByElementIDV1(requestParameters: CustomFormsV1ApiSearchFormElementDataByElementIDV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchFormElementDataByElementIDV1(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of form instances for the tenant. Optionally filter by form definition ID. + * @summary List form instances by tenant. + * @param {CustomFormsV1ApiSearchFormInstancesByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchFormInstancesByTenantV1(requestParameters: CustomFormsV1ApiSearchFormInstancesByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.searchFormInstancesByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * No parameters required. + * @summary List predefined select options. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchPreDefinedSelectOptionsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Preview form definition data source. + * @param {CustomFormsV1ApiShowPreviewDataSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + showPreviewDataSourceV1(requestParameters: CustomFormsV1ApiShowPreviewDataSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.showPreviewDataSourceV1(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formelementpreviewrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createFormDefinitionDynamicSchemaV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request + */ +export interface CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request { + /** + * Body is the request payload to create a form definition dynamic schema + * @type {FormdefinitiondynamicschemarequestV1} + * @memberof CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1 + */ + readonly body?: FormdefinitiondynamicschemarequestV1 +} + +/** + * Request parameters for createFormDefinitionFileRequestV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request + */ +export interface CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request { + /** + * FormDefinitionID String specifying FormDefinitionID + * @type {string} + * @memberof CustomFormsV1ApiCreateFormDefinitionFileRequestV1 + */ + readonly formDefinitionID: string + + /** + * File specifying the multipart + * @type {File} + * @memberof CustomFormsV1ApiCreateFormDefinitionFileRequestV1 + */ + readonly file: File +} + +/** + * Request parameters for createFormDefinitionV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiCreateFormDefinitionV1Request + */ +export interface CustomFormsV1ApiCreateFormDefinitionV1Request { + /** + * Body is the request payload to create form definition request + * @type {CreateformdefinitionrequestV1} + * @memberof CustomFormsV1ApiCreateFormDefinitionV1 + */ + readonly body?: CreateformdefinitionrequestV1 +} + +/** + * Request parameters for createFormInstanceV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiCreateFormInstanceV1Request + */ +export interface CustomFormsV1ApiCreateFormInstanceV1Request { + /** + * Body is the request payload to create a form instance + * @type {CreateforminstancerequestV1} + * @memberof CustomFormsV1ApiCreateFormInstanceV1 + */ + readonly body?: CreateforminstancerequestV1 +} + +/** + * Request parameters for deleteFormDefinitionV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiDeleteFormDefinitionV1Request + */ +export interface CustomFormsV1ApiDeleteFormDefinitionV1Request { + /** + * Form definition ID + * @type {string} + * @memberof CustomFormsV1ApiDeleteFormDefinitionV1 + */ + readonly formDefinitionID: string +} + +/** + * Request parameters for exportFormDefinitionsByTenantV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiExportFormDefinitionsByTenantV1Request + */ +export interface CustomFormsV1ApiExportFormDefinitionsByTenantV1Request { + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof CustomFormsV1ApiExportFormDefinitionsByTenantV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof CustomFormsV1ApiExportFormDefinitionsByTenantV1 + */ + readonly limit?: number + + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @type {string} + * @memberof CustomFormsV1ApiExportFormDefinitionsByTenantV1 + */ + 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: **name, description, created, modified** + * @type {string} + * @memberof CustomFormsV1ApiExportFormDefinitionsByTenantV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getFileFromS3V1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiGetFileFromS3V1Request + */ +export interface CustomFormsV1ApiGetFileFromS3V1Request { + /** + * FormDefinitionID Form definition ID + * @type {string} + * @memberof CustomFormsV1ApiGetFileFromS3V1 + */ + readonly formDefinitionID: string + + /** + * FileID String specifying the hashed name of the uploaded file we are retrieving. + * @type {string} + * @memberof CustomFormsV1ApiGetFileFromS3V1 + */ + readonly fileID: string +} + +/** + * Request parameters for getFormDefinitionByKeyV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiGetFormDefinitionByKeyV1Request + */ +export interface CustomFormsV1ApiGetFormDefinitionByKeyV1Request { + /** + * Form definition ID + * @type {string} + * @memberof CustomFormsV1ApiGetFormDefinitionByKeyV1 + */ + readonly formDefinitionID: string +} + +/** + * Request parameters for getFormInstanceByKeyV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiGetFormInstanceByKeyV1Request + */ +export interface CustomFormsV1ApiGetFormInstanceByKeyV1Request { + /** + * Form instance ID + * @type {string} + * @memberof CustomFormsV1ApiGetFormInstanceByKeyV1 + */ + readonly formInstanceID: string +} + +/** + * Request parameters for getFormInstanceFileV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiGetFormInstanceFileV1Request + */ +export interface CustomFormsV1ApiGetFormInstanceFileV1Request { + /** + * FormInstanceID Form instance ID + * @type {string} + * @memberof CustomFormsV1ApiGetFormInstanceFileV1 + */ + readonly formInstanceID: string + + /** + * FileID String specifying the hashed name of the uploaded file we are retrieving. + * @type {string} + * @memberof CustomFormsV1ApiGetFormInstanceFileV1 + */ + readonly fileID: string +} + +/** + * Request parameters for importFormDefinitionsV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiImportFormDefinitionsV1Request + */ +export interface CustomFormsV1ApiImportFormDefinitionsV1Request { + /** + * Body is the request payload to import form definitions + * @type {Array} + * @memberof CustomFormsV1ApiImportFormDefinitionsV1 + */ + readonly body?: Array +} + +/** + * Request parameters for patchFormDefinitionV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiPatchFormDefinitionV1Request + */ +export interface CustomFormsV1ApiPatchFormDefinitionV1Request { + /** + * Form definition ID + * @type {string} + * @memberof CustomFormsV1ApiPatchFormDefinitionV1 + */ + readonly formDefinitionID: string + + /** + * Body is the request payload to patch a form definition, check: https://jsonpatch.com + * @type {Array<{ [key: string]: object; }>} + * @memberof CustomFormsV1ApiPatchFormDefinitionV1 + */ + readonly body?: Array<{ [key: string]: object; }> +} + +/** + * Request parameters for patchFormInstanceV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiPatchFormInstanceV1Request + */ +export interface CustomFormsV1ApiPatchFormInstanceV1Request { + /** + * Form instance ID + * @type {string} + * @memberof CustomFormsV1ApiPatchFormInstanceV1 + */ + readonly formInstanceID: string + + /** + * Body is the request payload to patch a form instance, check: https://jsonpatch.com + * @type {Array<{ [key: string]: object; }>} + * @memberof CustomFormsV1ApiPatchFormInstanceV1 + */ + readonly body?: Array<{ [key: string]: object; }> +} + +/** + * Request parameters for searchFormDefinitionsByTenantV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request + */ +export interface CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request { + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof CustomFormsV1ApiSearchFormDefinitionsByTenantV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof CustomFormsV1ApiSearchFormDefinitionsByTenantV1 + */ + readonly limit?: number + + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + * @type {string} + * @memberof CustomFormsV1ApiSearchFormDefinitionsByTenantV1 + */ + 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: **name, description, created, modified** + * @type {string} + * @memberof CustomFormsV1ApiSearchFormDefinitionsByTenantV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for searchFormElementDataByElementIDV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiSearchFormElementDataByElementIDV1Request + */ +export interface CustomFormsV1ApiSearchFormElementDataByElementIDV1Request { + /** + * Form instance ID + * @type {string} + * @memberof CustomFormsV1ApiSearchFormElementDataByElementIDV1 + */ + readonly formInstanceID: string + + /** + * Form element ID + * @type {string} + * @memberof CustomFormsV1ApiSearchFormElementDataByElementIDV1 + */ + readonly formElementID: string + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof CustomFormsV1ApiSearchFormElementDataByElementIDV1 + */ + readonly limit?: number + + /** + * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @type {string} + * @memberof CustomFormsV1ApiSearchFormElementDataByElementIDV1 + */ + readonly filters?: string + + /** + * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @type {string} + * @memberof CustomFormsV1ApiSearchFormElementDataByElementIDV1 + */ + readonly query?: string +} + +/** + * Request parameters for searchFormInstancesByTenantV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiSearchFormInstancesByTenantV1Request + */ +export interface CustomFormsV1ApiSearchFormInstancesByTenantV1Request { + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof CustomFormsV1ApiSearchFormInstancesByTenantV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof CustomFormsV1ApiSearchFormInstancesByTenantV1 + */ + readonly limit?: number + + /** + * 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: **formDefinitionId**: *eq* + * @type {string} + * @memberof CustomFormsV1ApiSearchFormInstancesByTenantV1 + */ + readonly filters?: string +} + +/** + * Request parameters for showPreviewDataSourceV1 operation in CustomFormsV1Api. + * @export + * @interface CustomFormsV1ApiShowPreviewDataSourceV1Request + */ +export interface CustomFormsV1ApiShowPreviewDataSourceV1Request { + /** + * Form definition ID + * @type {string} + * @memberof CustomFormsV1ApiShowPreviewDataSourceV1 + */ + readonly formDefinitionID: string + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof CustomFormsV1ApiShowPreviewDataSourceV1 + */ + readonly limit?: number + + /** + * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` + * @type {string} + * @memberof CustomFormsV1ApiShowPreviewDataSourceV1 + */ + readonly filters?: string + + /** + * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. + * @type {string} + * @memberof CustomFormsV1ApiShowPreviewDataSourceV1 + */ + readonly query?: string + + /** + * Body is the request payload to create a form definition dynamic schema + * @type {FormelementpreviewrequestV1} + * @memberof CustomFormsV1ApiShowPreviewDataSourceV1 + */ + readonly formelementpreviewrequestV1?: FormelementpreviewrequestV1 +} + +/** + * CustomFormsV1Api - object-oriented interface + * @export + * @class CustomFormsV1Api + * @extends {BaseAPI} + */ +export class CustomFormsV1Api extends BaseAPI { + /** + * + * @summary Generate json schema dynamically. + * @param {CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public createFormDefinitionDynamicSchemaV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionDynamicSchemaV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).createFormDefinitionDynamicSchemaV1(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Upload new form definition file. + * @param {CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public createFormDefinitionFileRequestV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionFileRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).createFormDefinitionFileRequestV1(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Creates a form definition. + * @param {CustomFormsV1ApiCreateFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public createFormDefinitionV1(requestParameters: CustomFormsV1ApiCreateFormDefinitionV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).createFormDefinitionV1(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Creates a form instance. + * @param {CustomFormsV1ApiCreateFormInstanceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public createFormInstanceV1(requestParameters: CustomFormsV1ApiCreateFormInstanceV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).createFormInstanceV1(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Deletes a form definition. + * @param {CustomFormsV1ApiDeleteFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public deleteFormDefinitionV1(requestParameters: CustomFormsV1ApiDeleteFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).deleteFormDefinitionV1(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * No parameters required. + * @summary List form definitions by tenant. + * @param {CustomFormsV1ApiExportFormDefinitionsByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public exportFormDefinitionsByTenantV1(requestParameters: CustomFormsV1ApiExportFormDefinitionsByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).exportFormDefinitionsByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Download definition file by fileid. + * @param {CustomFormsV1ApiGetFileFromS3V1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public getFileFromS3V1(requestParameters: CustomFormsV1ApiGetFileFromS3V1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).getFileFromS3V1(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Return a form definition. + * @param {CustomFormsV1ApiGetFormDefinitionByKeyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public getFormDefinitionByKeyV1(requestParameters: CustomFormsV1ApiGetFormDefinitionByKeyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).getFormDefinitionByKeyV1(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Returns a form instance. + * @param {CustomFormsV1ApiGetFormInstanceByKeyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public getFormInstanceByKeyV1(requestParameters: CustomFormsV1ApiGetFormInstanceByKeyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).getFormInstanceByKeyV1(requestParameters.formInstanceID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Download instance file by fileid. + * @param {CustomFormsV1ApiGetFormInstanceFileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public getFormInstanceFileV1(requestParameters: CustomFormsV1ApiGetFormInstanceFileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).getFormInstanceFileV1(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Import form definitions from export. + * @param {CustomFormsV1ApiImportFormDefinitionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public importFormDefinitionsV1(requestParameters: CustomFormsV1ApiImportFormDefinitionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).importFormDefinitionsV1(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formDefinitionID}` should match a form definition ID. + * @summary Patch a form definition. + * @param {CustomFormsV1ApiPatchFormDefinitionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public patchFormDefinitionV1(requestParameters: CustomFormsV1ApiPatchFormDefinitionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).patchFormDefinitionV1(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + * @summary Patch a form instance. + * @param {CustomFormsV1ApiPatchFormInstanceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public patchFormInstanceV1(requestParameters: CustomFormsV1ApiPatchFormInstanceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).patchFormInstanceV1(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * No parameters required. + * @summary Export form definitions by tenant. + * @param {CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public searchFormDefinitionsByTenantV1(requestParameters: CustomFormsV1ApiSearchFormDefinitionsByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).searchFormDefinitionsByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. + * @summary Retrieves dynamic data by element. + * @param {CustomFormsV1ApiSearchFormElementDataByElementIDV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public searchFormElementDataByElementIDV1(requestParameters: CustomFormsV1ApiSearchFormElementDataByElementIDV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).searchFormElementDataByElementIDV1(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of form instances for the tenant. Optionally filter by form definition ID. + * @summary List form instances by tenant. + * @param {CustomFormsV1ApiSearchFormInstancesByTenantV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public searchFormInstancesByTenantV1(requestParameters: CustomFormsV1ApiSearchFormInstancesByTenantV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).searchFormInstancesByTenantV1(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * No parameters required. + * @summary List predefined select options. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public searchPreDefinedSelectOptionsV1(axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).searchPreDefinedSelectOptionsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Preview form definition data source. + * @param {CustomFormsV1ApiShowPreviewDataSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomFormsV1Api + */ + public showPreviewDataSourceV1(requestParameters: CustomFormsV1ApiShowPreviewDataSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomFormsV1ApiFp(this.configuration).showPreviewDataSourceV1(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formelementpreviewrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/custom_forms/base.ts b/sdk-output/custom_forms/base.ts new file mode 100644 index 00000000..48a710e4 --- /dev/null +++ b/sdk-output/custom_forms/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Forms + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/custom_forms/common.ts b/sdk-output/custom_forms/common.ts new file mode 100644 index 00000000..767e6737 --- /dev/null +++ b/sdk-output/custom_forms/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Forms + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/custom_forms/configuration.ts b/sdk-output/custom_forms/configuration.ts new file mode 100644 index 00000000..f396dfc1 --- /dev/null +++ b/sdk-output/custom_forms/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Forms + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/custom_forms/git_push.sh b/sdk-output/custom_forms/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/custom_forms/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/custom_forms/index.ts b/sdk-output/custom_forms/index.ts new file mode 100644 index 00000000..44a9f053 --- /dev/null +++ b/sdk-output/custom_forms/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Forms + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/custom_forms/package.json b/sdk-output/custom_forms/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/custom_forms/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/custom_forms/tsconfig.json b/sdk-output/custom_forms/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/custom_forms/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/custom_password_instructions/.gitignore b/sdk-output/custom_password_instructions/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/custom_password_instructions/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/custom_password_instructions/.npmignore b/sdk-output/custom_password_instructions/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/custom_password_instructions/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/custom_password_instructions/.openapi-generator-ignore b/sdk-output/custom_password_instructions/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/custom_password_instructions/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/custom_password_instructions/.openapi-generator/FILES b/sdk-output/custom_password_instructions/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/custom_password_instructions/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/custom_password_instructions/.openapi-generator/VERSION b/sdk-output/custom_password_instructions/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/custom_password_instructions/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/custom_password_instructions/.sdk-partition b/sdk-output/custom_password_instructions/.sdk-partition new file mode 100644 index 00000000..dc360e67 --- /dev/null +++ b/sdk-output/custom_password_instructions/.sdk-partition @@ -0,0 +1 @@ +custom-password-instructions \ No newline at end of file diff --git a/sdk-output/custom_password_instructions/README.md b/sdk-output/custom_password_instructions/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_password_instructions/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_password_instructions/api.ts b/sdk-output/custom_password_instructions/api.ts new file mode 100644 index 00000000..352cc018 --- /dev/null +++ b/sdk-output/custom_password_instructions/api.ts @@ -0,0 +1,541 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Password Instructions + * 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 CustompasswordinstructionV1 + */ +export interface CustompasswordinstructionV1 { + /** + * The page ID that represents the page for forget user name, reset password and unlock account flow. + * @type {string} + * @memberof CustompasswordinstructionV1 + */ + 'pageId'?: CustompasswordinstructionV1PageIdV1; + /** + * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. + * @type {string} + * @memberof CustompasswordinstructionV1 + */ + 'pageContent'?: string; + /** + * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @type {string} + * @memberof CustompasswordinstructionV1 + */ + 'locale'?: string; +} + +export const CustompasswordinstructionV1PageIdV1 = { + ChangePasswordEnterPassword: 'change-password:enter-password', + ChangePasswordFinish: 'change-password:finish', + FlowSelectionSelect: 'flow-selection:select', + ForgetUsernameUserEmail: 'forget-username:user-email', + MfaEnterCode: 'mfa:enter-code', + MfaEnterKba: 'mfa:enter-kba', + MfaSelect: 'mfa:select', + ResetPasswordEnterPassword: 'reset-password:enter-password', + ResetPasswordEnterUsername: 'reset-password:enter-username', + ResetPasswordFinish: 'reset-password:finish', + UnlockAccountEnterUsername: 'unlock-account:enter-username', + UnlockAccountFinish: 'unlock-account:finish' +} as const; + +export type CustompasswordinstructionV1PageIdV1 = typeof CustompasswordinstructionV1PageIdV1[keyof typeof CustompasswordinstructionV1PageIdV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * CustomPasswordInstructionsV1Api - axios parameter creator + * @export + */ +export const CustomPasswordInstructionsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates the custom password instructions for the specified page ID. + * @summary Create custom password instructions + * @param {CustompasswordinstructionV1} custompasswordinstructionV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomPasswordInstructionsV1: async (custompasswordinstructionV1: CustompasswordinstructionV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'custompasswordinstructionV1' is not null or undefined + assertParamExists('createCustomPasswordInstructionsV1', 'custompasswordinstructionV1', custompasswordinstructionV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/custom-password-instructions/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(custompasswordinstructionV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API delete the custom password instructions for the specified page ID. + * @summary Delete custom password instructions by page id + * @param {DeleteCustomPasswordInstructionsV1PageIdV1} pageId The page ID of custom password instructions to delete. + * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomPasswordInstructionsV1: async (pageId: DeleteCustomPasswordInstructionsV1PageIdV1, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pageId' is not null or undefined + assertParamExists('deleteCustomPasswordInstructionsV1', 'pageId', pageId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/custom-password-instructions/v1/{pageId}` + .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); + // 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; + + if (locale !== undefined) { + localVarQueryParameter['locale'] = locale; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the custom password instructions for the specified page ID. + * @summary Get custom password instructions by page id + * @param {GetCustomPasswordInstructionsV1PageIdV1} pageId The page ID of custom password instructions to query. + * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCustomPasswordInstructionsV1: async (pageId: GetCustomPasswordInstructionsV1PageIdV1, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pageId' is not null or undefined + assertParamExists('getCustomPasswordInstructionsV1', 'pageId', pageId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/custom-password-instructions/v1/{pageId}` + .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); + // 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 (locale !== undefined) { + localVarQueryParameter['locale'] = locale; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CustomPasswordInstructionsV1Api - functional programming interface + * @export + */ +export const CustomPasswordInstructionsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CustomPasswordInstructionsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates the custom password instructions for the specified page ID. + * @summary Create custom password instructions + * @param {CustompasswordinstructionV1} custompasswordinstructionV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCustomPasswordInstructionsV1(custompasswordinstructionV1: CustompasswordinstructionV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPasswordInstructionsV1(custompasswordinstructionV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV1Api.createCustomPasswordInstructionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API delete the custom password instructions for the specified page ID. + * @summary Delete custom password instructions by page id + * @param {DeleteCustomPasswordInstructionsV1PageIdV1} pageId The page ID of custom password instructions to delete. + * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCustomPasswordInstructionsV1(pageId: DeleteCustomPasswordInstructionsV1PageIdV1, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPasswordInstructionsV1(pageId, locale, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV1Api.deleteCustomPasswordInstructionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the custom password instructions for the specified page ID. + * @summary Get custom password instructions by page id + * @param {GetCustomPasswordInstructionsV1PageIdV1} pageId The page ID of custom password instructions to query. + * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCustomPasswordInstructionsV1(pageId: GetCustomPasswordInstructionsV1PageIdV1, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomPasswordInstructionsV1(pageId, locale, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV1Api.getCustomPasswordInstructionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CustomPasswordInstructionsV1Api - factory interface + * @export + */ +export const CustomPasswordInstructionsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CustomPasswordInstructionsV1ApiFp(configuration) + return { + /** + * This API creates the custom password instructions for the specified page ID. + * @summary Create custom password instructions + * @param {CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCustomPasswordInstructionsV1(requestParameters.custompasswordinstructionV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API delete the custom password instructions for the specified page ID. + * @summary Delete custom password instructions by page id + * @param {CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCustomPasswordInstructionsV1(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the custom password instructions for the specified page ID. + * @summary Get custom password instructions by page id + * @param {CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCustomPasswordInstructionsV1(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsV1Api. + * @export + * @interface CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request + */ +export interface CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request { + /** + * + * @type {CustompasswordinstructionV1} + * @memberof CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1 + */ + readonly custompasswordinstructionV1: CustompasswordinstructionV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsV1Api. + * @export + * @interface CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request + */ +export interface CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request { + /** + * The page ID of custom password instructions to delete. + * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} + * @memberof CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1 + */ + readonly pageId: DeleteCustomPasswordInstructionsV1PageIdV1 + + /** + * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @type {string} + * @memberof CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1 + */ + readonly locale?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsV1Api. + * @export + * @interface CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request + */ +export interface CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request { + /** + * The page ID of custom password instructions to query. + * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} + * @memberof CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1 + */ + readonly pageId: GetCustomPasswordInstructionsV1PageIdV1 + + /** + * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". + * @type {string} + * @memberof CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1 + */ + readonly locale?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * CustomPasswordInstructionsV1Api - object-oriented interface + * @export + * @class CustomPasswordInstructionsV1Api + * @extends {BaseAPI} + */ +export class CustomPasswordInstructionsV1Api extends BaseAPI { + /** + * This API creates the custom password instructions for the specified page ID. + * @summary Create custom password instructions + * @param {CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomPasswordInstructionsV1Api + */ + public createCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiCreateCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomPasswordInstructionsV1ApiFp(this.configuration).createCustomPasswordInstructionsV1(requestParameters.custompasswordinstructionV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API delete the custom password instructions for the specified page ID. + * @summary Delete custom password instructions by page id + * @param {CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomPasswordInstructionsV1Api + */ + public deleteCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiDeleteCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomPasswordInstructionsV1ApiFp(this.configuration).deleteCustomPasswordInstructionsV1(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the custom password instructions for the specified page ID. + * @summary Get custom password instructions by page id + * @param {CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomPasswordInstructionsV1Api + */ + public getCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsV1ApiGetCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomPasswordInstructionsV1ApiFp(this.configuration).getCustomPasswordInstructionsV1(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DeleteCustomPasswordInstructionsV1PageIdV1 = { + ChangePasswordEnterPassword: 'change-password:enter-password', + ChangePasswordFinish: 'change-password:finish', + FlowSelectionSelect: 'flow-selection:select', + ForgetUsernameUserEmail: 'forget-username:user-email', + MfaEnterCode: 'mfa:enter-code', + MfaEnterKba: 'mfa:enter-kba', + MfaSelect: 'mfa:select', + ResetPasswordEnterPassword: 'reset-password:enter-password', + ResetPasswordEnterUsername: 'reset-password:enter-username', + ResetPasswordFinish: 'reset-password:finish', + UnlockAccountEnterUsername: 'unlock-account:enter-username', + UnlockAccountFinish: 'unlock-account:finish' +} as const; +export type DeleteCustomPasswordInstructionsV1PageIdV1 = typeof DeleteCustomPasswordInstructionsV1PageIdV1[keyof typeof DeleteCustomPasswordInstructionsV1PageIdV1]; +/** + * @export + */ +export const GetCustomPasswordInstructionsV1PageIdV1 = { + ChangePasswordEnterPassword: 'change-password:enter-password', + ChangePasswordFinish: 'change-password:finish', + FlowSelectionSelect: 'flow-selection:select', + ForgetUsernameUserEmail: 'forget-username:user-email', + MfaEnterCode: 'mfa:enter-code', + MfaEnterKba: 'mfa:enter-kba', + MfaSelect: 'mfa:select', + ResetPasswordEnterPassword: 'reset-password:enter-password', + ResetPasswordEnterUsername: 'reset-password:enter-username', + ResetPasswordFinish: 'reset-password:finish', + UnlockAccountEnterUsername: 'unlock-account:enter-username', + UnlockAccountFinish: 'unlock-account:finish' +} as const; +export type GetCustomPasswordInstructionsV1PageIdV1 = typeof GetCustomPasswordInstructionsV1PageIdV1[keyof typeof GetCustomPasswordInstructionsV1PageIdV1]; + + diff --git a/sdk-output/custom_password_instructions/base.ts b/sdk-output/custom_password_instructions/base.ts new file mode 100644 index 00000000..1539a4b1 --- /dev/null +++ b/sdk-output/custom_password_instructions/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Password Instructions + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/custom_password_instructions/common.ts b/sdk-output/custom_password_instructions/common.ts new file mode 100644 index 00000000..ec64a707 --- /dev/null +++ b/sdk-output/custom_password_instructions/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Password Instructions + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/custom_password_instructions/configuration.ts b/sdk-output/custom_password_instructions/configuration.ts new file mode 100644 index 00000000..62d5765b --- /dev/null +++ b/sdk-output/custom_password_instructions/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Password Instructions + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/custom_password_instructions/git_push.sh b/sdk-output/custom_password_instructions/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/custom_password_instructions/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/custom_password_instructions/index.ts b/sdk-output/custom_password_instructions/index.ts new file mode 100644 index 00000000..5c953550 --- /dev/null +++ b/sdk-output/custom_password_instructions/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom Password Instructions + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/custom_password_instructions/package.json b/sdk-output/custom_password_instructions/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/custom_password_instructions/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/custom_password_instructions/tsconfig.json b/sdk-output/custom_password_instructions/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/custom_password_instructions/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/custom_user_levels/.gitignore b/sdk-output/custom_user_levels/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/custom_user_levels/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/custom_user_levels/.npmignore b/sdk-output/custom_user_levels/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/custom_user_levels/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/custom_user_levels/.openapi-generator-ignore b/sdk-output/custom_user_levels/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/custom_user_levels/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/custom_user_levels/.openapi-generator/FILES b/sdk-output/custom_user_levels/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/custom_user_levels/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/custom_user_levels/.openapi-generator/VERSION b/sdk-output/custom_user_levels/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/custom_user_levels/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/custom_user_levels/.sdk-partition b/sdk-output/custom_user_levels/.sdk-partition new file mode 100644 index 00000000..d52235cd --- /dev/null +++ b/sdk-output/custom_user_levels/.sdk-partition @@ -0,0 +1 @@ +custom-user-levels \ No newline at end of file diff --git a/sdk-output/custom_user_levels/README.md b/sdk-output/custom_user_levels/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_user_levels/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_user_levels/api.ts b/sdk-output/custom_user_levels/api.ts new file mode 100644 index 00000000..cdc5175d --- /dev/null +++ b/sdk-output/custom_user_levels/api.ts @@ -0,0 +1,1810 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom User Levels + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AuthuserlevelsidentitycountV1 + */ +export interface AuthuserlevelsidentitycountV1 { + /** + * The unique identifier of the user level. + * @type {string} + * @memberof AuthuserlevelsidentitycountV1 + */ + 'id'?: string; + /** + * Number of identities having this user level. + * @type {number} + * @memberof AuthuserlevelsidentitycountV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface AuthuserslimresponseV1 + */ +export interface AuthuserslimresponseV1 { + /** + * Identity ID. + * @type {string} + * @memberof AuthuserslimresponseV1 + */ + 'id'?: string; + /** + * Identity unique identifier. + * @type {string} + * @memberof AuthuserslimresponseV1 + */ + 'uid'?: string; + /** + * Identity alias. + * @type {string} + * @memberof AuthuserslimresponseV1 + */ + 'alias'?: string; + /** + * Identity name in display format. + * @type {string} + * @memberof AuthuserslimresponseV1 + */ + 'displayName'?: string; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A HierarchicalRightSet + * @export + * @interface HierarchicalrightsetV1 + */ +export interface HierarchicalrightsetV1 { + /** + * The unique identifier of the RightSet. + * @type {string} + * @memberof HierarchicalrightsetV1 + */ + 'id'?: string; + /** + * The human-readable name of the RightSet. + * @type {string} + * @memberof HierarchicalrightsetV1 + */ + 'name'?: string; + /** + * A human-readable description of the RightSet. + * @type {string} + * @memberof HierarchicalrightsetV1 + */ + 'description'?: string | null; + /** + * The category of the RightSet. + * @type {string} + * @memberof HierarchicalrightsetV1 + */ + 'category'?: string; + /** + * + * @type {NestedconfigV1} + * @memberof HierarchicalrightsetV1 + */ + 'nestedConfig'?: NestedconfigV1; + /** + * List of child HierarchicalRightSets. + * @type {Array} + * @memberof HierarchicalrightsetV1 + */ + 'children'?: Array; +} +/** + * The manager for the identity. + * @export + * @interface IdentityreferenceV1 + */ +export interface IdentityreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof IdentityreferenceV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'name'?: string; +} + + +/** + * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchV1 + */ +export interface JsonpatchV1 { + /** + * Operations to be applied + * @type {Array} + * @memberof JsonpatchV1 + */ + 'operations'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListUserLevelsV1401ResponseV1 + */ +export interface ListUserLevelsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListUserLevelsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListUserLevelsV1429ResponseV1 + */ +export interface ListUserLevelsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListUserLevelsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * A NestedConfig + * @export + * @interface NestedconfigV1 + */ +export interface NestedconfigV1 { + /** + * The unique identifier of the ancestor RightSet. + * @type {string} + * @memberof NestedconfigV1 + */ + 'ancestorId'?: string; + /** + * The depth level of the configuration. + * @type {number} + * @memberof NestedconfigV1 + */ + 'depth'?: number; + /** + * The unique identifier of the parent RightSet. + * @type {string} + * @memberof NestedconfigV1 + */ + 'parentId'?: string | null; + /** + * List of unique identifiers for child configurations. + * @type {Array} + * @memberof NestedconfigV1 + */ + 'childrenIds'?: Array; +} +/** + * + * @export + * @interface PublicidentityAttributesInnerV1 + */ +export interface PublicidentityAttributesInnerV1 { + /** + * The attribute key + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'key'?: string; + /** + * Human-readable display name of the attribute + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'name'?: string; + /** + * The attribute value + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'value'?: string | null; +} +/** + * Details about a public identity + * @export + * @interface PublicidentityV1 + */ +export interface PublicidentityV1 { + /** + * Identity id + * @type {string} + * @memberof PublicidentityV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'name'?: string; + /** + * Alternate unique identifier for the identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'alias'?: string; + /** + * Email address of identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'email'?: string | null; + /** + * The lifecycle status for the identity + * @type {string} + * @memberof PublicidentityV1 + */ + 'status'?: string | null; + /** + * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. + * @type {string} + * @memberof PublicidentityV1 + */ + 'identityState'?: PublicidentityV1IdentityStateV1 | null; + /** + * + * @type {IdentityreferenceV1} + * @memberof PublicidentityV1 + */ + 'manager'?: IdentityreferenceV1 | null; + /** + * The public identity attributes of the identity + * @type {Array} + * @memberof PublicidentityV1 + */ + 'attributes'?: Array; +} + +export const PublicidentityV1IdentityStateV1 = { + Active: 'ACTIVE', + InactiveShortTerm: 'INACTIVE_SHORT_TERM', + InactiveLongTerm: 'INACTIVE_LONG_TERM' +} as const; + +export type PublicidentityV1IdentityStateV1 = typeof PublicidentityV1IdentityStateV1[keyof typeof PublicidentityV1IdentityStateV1]; + +/** + * A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs. + * @export + * @interface RightsetdtoV1 + */ +export interface RightsetdtoV1 { + /** + * The unique identifier of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'id'?: string; + /** + * The human-readable name of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'name'?: string; + /** + * A human-readable description of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'description'?: string; + /** + * The category of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'category'?: string; + /** + * Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. + * @type {Array} + * @memberof RightsetdtoV1 + */ + 'rights'?: Array; + /** + * List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. + * @type {Array} + * @memberof RightsetdtoV1 + */ + 'rightSetIds'?: Array; + /** + * List of unique identifiers for UI-assignable child RightSets, used to build UI components. + * @type {Array} + * @memberof RightsetdtoV1 + */ + 'uiAssignableChildRightSetIds'?: Array; + /** + * Indicates whether the RightSet is UI-assignable. + * @type {boolean} + * @memberof RightsetdtoV1 + */ + 'uiAssignable'?: boolean; + /** + * The translated name of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'translatedName'?: string; + /** + * The translated description of the RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'translatedDescription'?: string | null; + /** + * The unique identifier of the parent RightSet for UI Assignable RightSet. + * @type {string} + * @memberof RightsetdtoV1 + */ + 'parentId'?: string | null; +} +/** + * It represents a summary of a user level publish operation, including its metadata and status. + * @export + * @interface UserlevelpublishsummaryV1 + */ +export interface UserlevelpublishsummaryV1 { + /** + * The unique identifier of the UserLevel. + * @type {string} + * @memberof UserlevelpublishsummaryV1 + */ + 'userLevelId'?: string; + /** + * Indicates whether the API call triggered a publish operation. + * @type {boolean} + * @memberof UserlevelpublishsummaryV1 + */ + 'publish'?: boolean; + /** + * The status of the UserLevel publish operation. + * @type {string} + * @memberof UserlevelpublishsummaryV1 + */ + 'status'?: string; + /** + * The last modification timestamp of the UserLevel. + * @type {string} + * @memberof UserlevelpublishsummaryV1 + */ + 'modified'?: string; +} +/** + * Payload containing details for creating a custom user level. + * @export + * @interface UserlevelrequestV1 + */ +export interface UserlevelrequestV1 { + /** + * The name of the user level. + * @type {string} + * @memberof UserlevelrequestV1 + */ + 'name': string; + /** + * A brief description of the user level. + * @type {string} + * @memberof UserlevelrequestV1 + */ + 'description': string; + /** + * + * @type {PublicidentityV1} + * @memberof UserlevelrequestV1 + */ + 'owner': PublicidentityV1; + /** + * A list of rights associated with the user level. + * @type {Array} + * @memberof UserlevelrequestV1 + */ + 'rightSets'?: Array; +} +/** + * It represents a summary of a user level, including its metadata, attributes, and associated properties. + * @export + * @interface UserlevelsummarydtoV1 + */ +export interface UserlevelsummarydtoV1 { + /** + * The unique identifier of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'id'?: string; + /** + * The human-readable name of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'name'?: string; + /** + * A human-readable description of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'description'?: string | null; + /** + * The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'legacyGroup'?: string | null; + /** + * List of RightSets associated with the UserLevel. + * @type {Array} + * @memberof UserlevelsummarydtoV1 + */ + 'rightSets'?: Array; + /** + * Indicates whether the UserLevel is custom. + * @type {boolean} + * @memberof UserlevelsummarydtoV1 + */ + 'custom'?: boolean; + /** + * Indicates whether the UserLevel is admin-assignable. + * @type {boolean} + * @memberof UserlevelsummarydtoV1 + */ + 'adminAssignable'?: boolean; + /** + * The translated name of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'translatedName'?: string | null; + /** + * The translated grant message for the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'translatedGrant'?: string | null; + /** + * The translated remove message for the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'translatedRemove'?: string | null; + /** + * + * @type {PublicidentityV1} + * @memberof UserlevelsummarydtoV1 + */ + 'owner'?: PublicidentityV1; + /** + * The status of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'status'?: UserlevelsummarydtoV1StatusV1; + /** + * The creation timestamp of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'created'?: string; + /** + * The last modification timestamp of the UserLevel. + * @type {string} + * @memberof UserlevelsummarydtoV1 + */ + 'modified'?: string; + /** + * The count of associated identities for the UserLevel. + * @type {number} + * @memberof UserlevelsummarydtoV1 + */ + 'associatedIdentitiesCount'?: number | null; +} + +export const UserlevelsummarydtoV1StatusV1 = { + Active: 'ACTIVE', + Draft: 'DRAFT' +} as const; + +export type UserlevelsummarydtoV1StatusV1 = typeof UserlevelsummarydtoV1StatusV1[keyof typeof UserlevelsummarydtoV1StatusV1]; + + +/** + * CustomUserLevelsV1Api - axios parameter creator + * @export + */ +export const CustomUserLevelsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new custom user level for the tenant. + * @summary Create a custom user level + * @param {UserlevelrequestV1} userlevelrequestV1 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomUserLevelV1: async (userlevelrequestV1: UserlevelrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'userlevelrequestV1' is not null or undefined + assertParamExists('createCustomUserLevelV1', 'userlevelrequestV1', userlevelrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(userlevelrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes a specific user level by its ID. + * @summary Delete a user level + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteUserLevelV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteUserLevelV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels/{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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Fetches the details of a specific user level by its ID. + * @summary Retrieve a user level + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUserLevelV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getUserLevelV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels/{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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves a list of authorization assignable right sets for the tenant. + * @summary List all uiAssignable right sets + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **category**: *eq* + * @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, name, category** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllAuthorizationRightSetsV1: async (xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/authorization-assignable-right-sets`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * List of identities associated with a user level. + * @summary List user level identities + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. + * @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: **displayName** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUserLevelIdentitiesV1: async (id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listUserLevelIdentitiesV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/user-levels/{id}/identities` + .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 (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves a list of user levels for the tenant. + * @summary List user levels + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {ListUserLevelsV1DetailLevelV1} [detailLevel] Specifies the level of detail for the user levels. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* + * @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: **name, created, description, status, owner** + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUserLevelsV1: async (xSailPointExperimental?: string, detailLevel?: ListUserLevelsV1DetailLevelV1, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels`; + // 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 (detailLevel !== undefined) { + localVarQueryParameter['detailLevel'] = detailLevel; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Publishes a custom user level for the tenant, making it active and available. + * @summary Publish a custom user level + * @param {string} id The unique identifier of the user level to publish. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + publishCustomUserLevelV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('publishCustomUserLevelV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels/{id}/publish` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * List of user levels along with the number of identities associated to it. + * @summary Count user levels identities + * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + showUserLevelCountsV1: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('showUserLevelCountsV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/user-levels/get-identity-count`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates the details of a specific user level using JSON Patch. + * @summary Update a user level + * @param {string} id The unique identifier of the user level. + * @param {JsonpatchV1} jsonpatchV1 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateUserLevelV1: async (id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateUserLevelV1', 'id', id) + // verify required parameter 'jsonpatchV1' is not null or undefined + assertParamExists('updateUserLevelV1', 'jsonpatchV1', jsonpatchV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/authorization/v1/custom-user-levels/{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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * CustomUserLevelsV1Api - functional programming interface + * @export + */ +export const CustomUserLevelsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CustomUserLevelsV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates a new custom user level for the tenant. + * @summary Create a custom user level + * @param {UserlevelrequestV1} userlevelrequestV1 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCustomUserLevelV1(userlevelrequestV1: UserlevelrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomUserLevelV1(userlevelrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.createCustomUserLevelV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes a specific user level by its ID. + * @summary Delete a user level + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserLevelV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.deleteUserLevelV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches the details of a specific user level by its ID. + * @summary Retrieve a user level + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUserLevelV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.getUserLevelV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a list of authorization assignable right sets for the tenant. + * @summary List all uiAssignable right sets + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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: **category**: *eq* + * @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, name, category** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listAllAuthorizationRightSetsV1(xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAllAuthorizationRightSetsV1(xSailPointExperimental, filters, sorters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.listAllAuthorizationRightSetsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List of identities associated with a user level. + * @summary List user level identities + * @param {string} id The unique identifier of the user level. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. + * @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: **displayName** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listUserLevelIdentitiesV1(id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevelIdentitiesV1(id, xSailPointExperimental, count, sorters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.listUserLevelIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a list of user levels for the tenant. + * @summary List user levels + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {ListUserLevelsV1DetailLevelV1} [detailLevel] Specifies the level of detail for the user levels. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* + * @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: **name, created, description, status, owner** + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listUserLevelsV1(xSailPointExperimental?: string, detailLevel?: ListUserLevelsV1DetailLevelV1, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevelsV1(xSailPointExperimental, detailLevel, filters, sorters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.listUserLevelsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Publishes a custom user level for the tenant, making it active and available. + * @summary Publish a custom user level + * @param {string} id The unique identifier of the user level to publish. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async publishCustomUserLevelV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishCustomUserLevelV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.publishCustomUserLevelV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List of user levels along with the number of identities associated to it. + * @summary Count user levels identities + * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async showUserLevelCountsV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.showUserLevelCountsV1(requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.showUserLevelCountsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the details of a specific user level using JSON Patch. + * @summary Update a user level + * @param {string} id The unique identifier of the user level. + * @param {JsonpatchV1} jsonpatchV1 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateUserLevelV1(id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserLevelV1(id, jsonpatchV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV1Api.updateUserLevelV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CustomUserLevelsV1Api - factory interface + * @export + */ +export const CustomUserLevelsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CustomUserLevelsV1ApiFp(configuration) + return { + /** + * Creates a new custom user level for the tenant. + * @summary Create a custom user level + * @param {CustomUserLevelsV1ApiCreateCustomUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomUserLevelV1(requestParameters: CustomUserLevelsV1ApiCreateCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCustomUserLevelV1(requestParameters.userlevelrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes a specific user level by its ID. + * @summary Delete a user level + * @param {CustomUserLevelsV1ApiDeleteUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteUserLevelV1(requestParameters: CustomUserLevelsV1ApiDeleteUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches the details of a specific user level by its ID. + * @summary Retrieve a user level + * @param {CustomUserLevelsV1ApiGetUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUserLevelV1(requestParameters: CustomUserLevelsV1ApiGetUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a list of authorization assignable right sets for the tenant. + * @summary List all uiAssignable right sets + * @param {CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listAllAuthorizationRightSetsV1(requestParameters: CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listAllAuthorizationRightSetsV1(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List of identities associated with a user level. + * @summary List user level identities + * @param {CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUserLevelIdentitiesV1(requestParameters: CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listUserLevelIdentitiesV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a list of user levels for the tenant. + * @summary List user levels + * @param {CustomUserLevelsV1ApiListUserLevelsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listUserLevelsV1(requestParameters: CustomUserLevelsV1ApiListUserLevelsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listUserLevelsV1(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Publishes a custom user level for the tenant, making it active and available. + * @summary Publish a custom user level + * @param {CustomUserLevelsV1ApiPublishCustomUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + publishCustomUserLevelV1(requestParameters: CustomUserLevelsV1ApiPublishCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.publishCustomUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List of user levels along with the number of identities associated to it. + * @summary Count user levels identities + * @param {CustomUserLevelsV1ApiShowUserLevelCountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + showUserLevelCountsV1(requestParameters: CustomUserLevelsV1ApiShowUserLevelCountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.showUserLevelCountsV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the details of a specific user level using JSON Patch. + * @summary Update a user level + * @param {CustomUserLevelsV1ApiUpdateUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateUserLevelV1(requestParameters: CustomUserLevelsV1ApiUpdateUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateUserLevelV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCustomUserLevelV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiCreateCustomUserLevelV1Request + */ +export interface CustomUserLevelsV1ApiCreateCustomUserLevelV1Request { + /** + * Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @type {UserlevelrequestV1} + * @memberof CustomUserLevelsV1ApiCreateCustomUserLevelV1 + */ + readonly userlevelrequestV1: UserlevelrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiCreateCustomUserLevelV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteUserLevelV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiDeleteUserLevelV1Request + */ +export interface CustomUserLevelsV1ApiDeleteUserLevelV1Request { + /** + * The unique identifier of the user level. + * @type {string} + * @memberof CustomUserLevelsV1ApiDeleteUserLevelV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiDeleteUserLevelV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getUserLevelV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiGetUserLevelV1Request + */ +export interface CustomUserLevelsV1ApiGetUserLevelV1Request { + /** + * The unique identifier of the user level. + * @type {string} + * @memberof CustomUserLevelsV1ApiGetUserLevelV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiGetUserLevelV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listAllAuthorizationRightSetsV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request + */ +export interface CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1 + */ + readonly xSailPointExperimental?: 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: **category**: *eq* + * @type {string} + * @memberof CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1 + */ + 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, name, category** + * @type {string} + * @memberof CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1 + */ + readonly sorters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listUserLevelIdentitiesV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request + */ +export interface CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request { + /** + * The unique identifier of the user level. + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly xSailPointExperimental?: string + + /** + * If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. + * @type {boolean} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly count?: boolean + + /** + * 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: **displayName** + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly sorters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListUserLevelIdentitiesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listUserLevelsV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiListUserLevelsV1Request + */ +export interface CustomUserLevelsV1ApiListUserLevelsV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + readonly xSailPointExperimental?: string + + /** + * Specifies the level of detail for the user levels. + * @type {'FULL' | 'SLIM'} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + readonly detailLevel?: ListUserLevelsV1DetailLevelV1 + + /** + * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + 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: **name, created, description, status, owner** + * @type {string} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + readonly sorters?: string + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof CustomUserLevelsV1ApiListUserLevelsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for publishCustomUserLevelV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiPublishCustomUserLevelV1Request + */ +export interface CustomUserLevelsV1ApiPublishCustomUserLevelV1Request { + /** + * The unique identifier of the user level to publish. + * @type {string} + * @memberof CustomUserLevelsV1ApiPublishCustomUserLevelV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiPublishCustomUserLevelV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for showUserLevelCountsV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiShowUserLevelCountsV1Request + */ +export interface CustomUserLevelsV1ApiShowUserLevelCountsV1Request { + /** + * List of user level ids. Max 50 identifiers can be passed in a single request. + * @type {Array} + * @memberof CustomUserLevelsV1ApiShowUserLevelCountsV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiShowUserLevelCountsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateUserLevelV1 operation in CustomUserLevelsV1Api. + * @export + * @interface CustomUserLevelsV1ApiUpdateUserLevelV1Request + */ +export interface CustomUserLevelsV1ApiUpdateUserLevelV1Request { + /** + * The unique identifier of the user level. + * @type {string} + * @memberof CustomUserLevelsV1ApiUpdateUserLevelV1 + */ + readonly id: string + + /** + * JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + * @type {JsonpatchV1} + * @memberof CustomUserLevelsV1ApiUpdateUserLevelV1 + */ + readonly jsonpatchV1: JsonpatchV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof CustomUserLevelsV1ApiUpdateUserLevelV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * CustomUserLevelsV1Api - object-oriented interface + * @export + * @class CustomUserLevelsV1Api + * @extends {BaseAPI} + */ +export class CustomUserLevelsV1Api extends BaseAPI { + /** + * Creates a new custom user level for the tenant. + * @summary Create a custom user level + * @param {CustomUserLevelsV1ApiCreateCustomUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public createCustomUserLevelV1(requestParameters: CustomUserLevelsV1ApiCreateCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).createCustomUserLevelV1(requestParameters.userlevelrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes a specific user level by its ID. + * @summary Delete a user level + * @param {CustomUserLevelsV1ApiDeleteUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public deleteUserLevelV1(requestParameters: CustomUserLevelsV1ApiDeleteUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).deleteUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches the details of a specific user level by its ID. + * @summary Retrieve a user level + * @param {CustomUserLevelsV1ApiGetUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public getUserLevelV1(requestParameters: CustomUserLevelsV1ApiGetUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).getUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a list of authorization assignable right sets for the tenant. + * @summary List all uiAssignable right sets + * @param {CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public listAllAuthorizationRightSetsV1(requestParameters: CustomUserLevelsV1ApiListAllAuthorizationRightSetsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).listAllAuthorizationRightSetsV1(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List of identities associated with a user level. + * @summary List user level identities + * @param {CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public listUserLevelIdentitiesV1(requestParameters: CustomUserLevelsV1ApiListUserLevelIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).listUserLevelIdentitiesV1(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a list of user levels for the tenant. + * @summary List user levels + * @param {CustomUserLevelsV1ApiListUserLevelsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public listUserLevelsV1(requestParameters: CustomUserLevelsV1ApiListUserLevelsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).listUserLevelsV1(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Publishes a custom user level for the tenant, making it active and available. + * @summary Publish a custom user level + * @param {CustomUserLevelsV1ApiPublishCustomUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public publishCustomUserLevelV1(requestParameters: CustomUserLevelsV1ApiPublishCustomUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).publishCustomUserLevelV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List of user levels along with the number of identities associated to it. + * @summary Count user levels identities + * @param {CustomUserLevelsV1ApiShowUserLevelCountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public showUserLevelCountsV1(requestParameters: CustomUserLevelsV1ApiShowUserLevelCountsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).showUserLevelCountsV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the details of a specific user level using JSON Patch. + * @summary Update a user level + * @param {CustomUserLevelsV1ApiUpdateUserLevelV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof CustomUserLevelsV1Api + */ + public updateUserLevelV1(requestParameters: CustomUserLevelsV1ApiUpdateUserLevelV1Request, axiosOptions?: RawAxiosRequestConfig) { + return CustomUserLevelsV1ApiFp(this.configuration).updateUserLevelV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ListUserLevelsV1DetailLevelV1 = { + Full: 'FULL', + Slim: 'SLIM' +} as const; +export type ListUserLevelsV1DetailLevelV1 = typeof ListUserLevelsV1DetailLevelV1[keyof typeof ListUserLevelsV1DetailLevelV1]; + + diff --git a/sdk-output/custom_user_levels/base.ts b/sdk-output/custom_user_levels/base.ts new file mode 100644 index 00000000..3a004787 --- /dev/null +++ b/sdk-output/custom_user_levels/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom User Levels + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/custom_user_levels/common.ts b/sdk-output/custom_user_levels/common.ts new file mode 100644 index 00000000..f01cda40 --- /dev/null +++ b/sdk-output/custom_user_levels/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom User Levels + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/custom_user_levels/configuration.ts b/sdk-output/custom_user_levels/configuration.ts new file mode 100644 index 00000000..d9e9a9ba --- /dev/null +++ b/sdk-output/custom_user_levels/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom User Levels + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/custom_user_levels/git_push.sh b/sdk-output/custom_user_levels/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/custom_user_levels/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/custom_user_levels/index.ts b/sdk-output/custom_user_levels/index.ts new file mode 100644 index 00000000..94b47870 --- /dev/null +++ b/sdk-output/custom_user_levels/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Custom User Levels + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/custom_user_levels/package.json b/sdk-output/custom_user_levels/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/custom_user_levels/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/custom_user_levels/tsconfig.json b/sdk-output/custom_user_levels/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/custom_user_levels/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/data_access_security/.gitignore b/sdk-output/data_access_security/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/data_access_security/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/data_access_security/.npmignore b/sdk-output/data_access_security/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/data_access_security/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/data_access_security/.openapi-generator-ignore b/sdk-output/data_access_security/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/data_access_security/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/data_access_security/.openapi-generator/FILES b/sdk-output/data_access_security/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/data_access_security/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/data_access_security/.openapi-generator/VERSION b/sdk-output/data_access_security/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/data_access_security/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/data_access_security/.sdk-partition b/sdk-output/data_access_security/.sdk-partition new file mode 100644 index 00000000..e8bb206e --- /dev/null +++ b/sdk-output/data_access_security/.sdk-partition @@ -0,0 +1 @@ +data-access-security \ No newline at end of file diff --git a/sdk-output/data_access_security/README.md b/sdk-output/data_access_security/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/data_access_security/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/data_access_security/api.ts b/sdk-output/data_access_security/api.ts new file mode 100644 index 00000000..c5402f2f --- /dev/null +++ b/sdk-output/data_access_security/api.ts @@ -0,0 +1,3618 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Access Security + * 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 ActivityconfigurationsettingsV1 + */ +export interface ActivityconfigurationsettingsV1 { + /** + * Indicates whether the feature or configuration is enabled. + * @type {boolean} + * @memberof ActivityconfigurationsettingsV1 + */ + 'isEnabled'?: boolean; + /** + * The identifier of the cluster associated with this configuration, if applicable. + * @type {string} + * @memberof ActivityconfigurationsettingsV1 + */ + 'clusterId'?: string | null; + /** + * The time period for retaining activity logs. + * @type {number} + * @memberof ActivityconfigurationsettingsV1 + */ + 'retentionTimePeriod'?: number; + /** + * The type of retention period (e.g., days, months, years). + * @type {string} + * @memberof ActivityconfigurationsettingsV1 + */ + 'retentionTimeType'?: string | null; + /** + * List of user identifiers to exclude from activity tracking. + * @type {Array} + * @memberof ActivityconfigurationsettingsV1 + */ + 'excludeUsers'?: Array | null; + /** + * List of folder paths to exclude from activity tracking. + * @type {Array} + * @memberof ActivityconfigurationsettingsV1 + */ + 'excludeFolders'?: Array | null; + /** + * List of file extensions to exclude from activity tracking. + * @type {Array} + * @memberof ActivityconfigurationsettingsV1 + */ + 'excludeFileExtensions'?: Array | null; + /** + * List of actions to exclude from activity tracking. + * @type {Array} + * @memberof ActivityconfigurationsettingsV1 + */ + 'excludeActions'?: Array | null; +} +/** + * + * @export + * @interface ApplicationcrawlersettingsV1 + */ +export interface ApplicationcrawlersettingsV1 { + /** + * Indicates whether the feature or configuration is enabled. + * @type {boolean} + * @memberof ApplicationcrawlersettingsV1 + */ + 'isEnabled'?: boolean; + /** + * The identifier of the cluster associated with this configuration, if applicable. + * @type {string} + * @memberof ApplicationcrawlersettingsV1 + */ + 'clusterId'?: string | null; + /** + * + * @type {CrawlresourcessizesoptionsV1} + * @memberof ApplicationcrawlersettingsV1 + */ + 'calculateResourceSize'?: CrawlresourcessizesoptionsV1; + /** + * Indicates whether to crawl the snapshots folder. + * @type {boolean} + * @memberof ApplicationcrawlersettingsV1 + */ + 'crawlSnapshotsFolder'?: boolean | null; + /** + * Indicates whether to crawl mailboxes. + * @type {boolean} + * @memberof ApplicationcrawlersettingsV1 + */ + 'crawlMailboxes'?: boolean | null; + /** + * Indicates whether to crawl public folders. + * @type {boolean} + * @memberof ApplicationcrawlersettingsV1 + */ + 'crawlPublicFolders'?: boolean | null; + /** + * Regular expression pattern for paths to exclude from crawling. + * @type {string} + * @memberof ApplicationcrawlersettingsV1 + */ + 'excludedPathsByRegex'?: string | null; + /** + * List of top-level shares to crawl. + * @type {Array} + * @memberof ApplicationcrawlersettingsV1 + */ + 'crawlTopLevelShares'?: Array | null; + /** + * List of resource identifiers to exclude from crawling. + * @type {Array} + * @memberof ApplicationcrawlersettingsV1 + */ + 'excludedResources'?: Array | null; + /** + * List of resource identifiers to include in crawling. + * @type {Array} + * @memberof ApplicationcrawlersettingsV1 + */ + 'includeResources'?: Array | null; +} + + +/** + * + * @export + * @interface ApplicationitemV1 + */ +export interface ApplicationitemV1 { + /** + * The unique identifier of the application. + * @type {number} + * @memberof ApplicationitemV1 + */ + 'id'?: number; + /** + * The display name of the application. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'name'?: string | null; + /** + * A brief description of the application and its purpose. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'description'?: string | null; + /** + * The type of the application. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'type'?: string | null; + /** + * A list of tags associated with the application. + * @type {Array} + * @memberof ApplicationitemV1 + */ + 'tags'?: Array | null; + /** + * The status of the last connection test performed on the application. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'testConnectionStatus'?: string | null; + /** + * The timestamp of the last connection test performed on the application, in milliseconds since epoch. + * @type {number} + * @memberof ApplicationitemV1 + */ + 'testConnectionDate'?: number | null; + /** + * The identifier of the cluster used for crawling resources. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'rcClusterId'?: string | null; + /** + * The identifier of the cluster used for data classification. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'dcClusterId'?: string | null; + /** + * The identifier of the cluster used for permission collection. + * @type {string} + * @memberof ApplicationitemV1 + */ + 'pcClusterId'?: string | null; +} +/** + * Specifies the type of application. Possible values: 1 - Sharepoint 8 - WindowsFileServer 9 - ActiveDirectory 11 - EmcCelerraCifs 15 - NetappCifs 20 - EmcIsilon 21 - GoogleDrive 24 - Box 25 - Dropbox 27 - OneDriveForBusiness 28 - SharepointOnline 29 - ExchangeOnline 33 - Cifs 35 - AwsS3 37 - Snowflake + * @export + * @enum {number} + */ + +export const ApplicationtypeV1 = { + NUMBER_1: 1, + NUMBER_8: 8, + NUMBER_9: 9, + NUMBER_11: 11, + NUMBER_15: 15, + NUMBER_20: 20, + NUMBER_21: 21, + NUMBER_24: 24, + NUMBER_25: 25, + NUMBER_27: 27, + NUMBER_28: 28, + NUMBER_29: 29, + NUMBER_33: 33, + NUMBER_35: 35, + NUMBER_37: 37 +} as const; + +export type ApplicationtypeV1 = typeof ApplicationtypeV1[keyof typeof ApplicationtypeV1]; + + +/** + * + * @export + * @interface AssignresourceownerrequestV1 + */ +export interface AssignresourceownerrequestV1 { + /** + * The unique identifier of the application containing the resource. + * @type {number} + * @memberof AssignresourceownerrequestV1 + */ + 'appId'?: number; + /** + * The full path to the resource within the application (e.g., file path or object path). + * @type {string} + * @memberof AssignresourceownerrequestV1 + */ + 'fullPath'?: string | null; + /** + * The unique identifier (UUID) of the identity to be assigned as the resource owner. + * @type {string} + * @memberof AssignresourceownerrequestV1 + */ + 'identityId'?: string; +} +/** + * + * @export + * @interface BasecreateapplicationrequestV1 + */ +export interface BasecreateapplicationrequestV1 { + /** + * + * @type {ApplicationtypeV1} + * @memberof BasecreateapplicationrequestV1 + */ + 'applicationType': ApplicationtypeV1; + /** + * The display name of the application. + * @type {string} + * @memberof BasecreateapplicationrequestV1 + */ + 'name': string; + /** + * A brief description of the application and its purpose. + * @type {string} + * @memberof BasecreateapplicationrequestV1 + */ + 'description'?: string | null; + /** + * A list of tags to categorize or identify the application. + * @type {Array} + * @memberof BasecreateapplicationrequestV1 + */ + 'tags'?: Array | null; + /** + * The unique identifier for the identity collector associated with this application. + * @type {number} + * @memberof BasecreateapplicationrequestV1 + */ + 'identityCollectorId'?: number | null; + /** + * The unique identifier for the AD identity collector. + * @type {number} + * @memberof BasecreateapplicationrequestV1 + */ + 'adIdentityCollectorId'?: number | null; + /** + * The unique identifier for the NIS identity collector. + * @type {number} + * @memberof BasecreateapplicationrequestV1 + */ + 'nisIdentityCollectorId'?: number | null; + /** + * + * @type {ApplicationcrawlersettingsV1} + * @memberof BasecreateapplicationrequestV1 + */ + 'applicationCrawlerSettings'?: ApplicationcrawlersettingsV1; + /** + * + * @type {PermissioncollectorsettingsV1} + * @memberof BasecreateapplicationrequestV1 + */ + 'permissionCollectorSettings'?: PermissioncollectorsettingsV1; + /** + * + * @type {DataclassificationsettingsV1} + * @memberof BasecreateapplicationrequestV1 + */ + 'dataClassificationSettings'?: DataclassificationsettingsV1; + /** + * + * @type {ActivityconfigurationsettingsV1} + * @memberof BasecreateapplicationrequestV1 + */ + 'activityConfigurationSettings'?: ActivityconfigurationsettingsV1; + /** + * If true, the application setup will be executed immediately after creation. + * @type {boolean} + * @memberof BasecreateapplicationrequestV1 + */ + 'executeNow'?: boolean; +} + + +/** + * + * @export + * @interface BasesettingsV1 + */ +export interface BasesettingsV1 { + /** + * Indicates whether the feature or configuration is enabled. + * @type {boolean} + * @memberof BasesettingsV1 + */ + 'isEnabled'?: boolean; + /** + * The identifier of the cluster associated with this configuration, if applicable. + * @type {string} + * @memberof BasesettingsV1 + */ + 'clusterId'?: string | null; +} +/** + * Specifies the type of business service or resource. Possible values include: 0 - Folder 1 - Computer 2 - Container 3 - Domain 4 - Group / GPO 5 - OrganizationalUnit 6 - User 7 - Document 8 - List / WindowsFileServer / SharepointOnline 9 - ListItem 10 - Site 11 - Unknown / DropboxUser 12 - WSSFolder 13 - Web 14 - ExchangeFolder 15 - Mailbox 16 - PublicFolder 18 - UserSAMAccountName 24 - (reserved) 25 - GroupPolicyContainer 30 - File 801 - WindowsClusterServerName 908 - GoogleFolder 909 - GoogleUser 910 - DropboxFolder 912 - BoxFolder 913 - BoxUser 914 - BoxFile 950 - WSSFile 951 - HiddenList 952 - HiddenWSSFolder 953 - HiddenWSSFile 1000 - BuiltinDomain 1100 - DfsNamespace 1101 - DfsLink 1200 - SqlServerInstance 1201 - SqlServerDatabase 1202 - SqlServerSchema 1203 - SqlServerTable 1204 - SqlServerView 1205 - SqlServerStoredProcedure 1206 - SqlServerFunction 1207 - SqlServerAssemblie 1208 - SqlServerType 1209 - SqlServerDatabaseRole 1210 - SqlServerDatabaseUser 1211 - SqlServerApplicationRole 1212 - SqlServerLogin 1213 - SqlServerServerRole 1214 - SqlServerVirtualContainer 1215 - SqlServerSynonym 1216 - SqlServerExtendedStoredProcedure 1300 - AwsS3Root 1301 - AwsS3OU 1302 - AwsS3Account 1303 - AwsS3Bucket 1304 - AwsS3Folder 1305 - AwsS3File 1400 - SnowflakeDatabase 1401 - SnowflakeSchema 1402 - SnowflakeTable 1403 - SnowflakeView 1404 - SnowflakeFunction 1405 - SnowflakeProcedure 1406 - SnowflakeVirtualContainer 1407 - SnowflakeDatabaseApplication 1408 - SnowflakeDatabaseApplicationPackage 1409 - SnowflakeDatabasePersonal 1410 - SnowflakeDatabaseImported 1411 - SnowflakeViewMaterialized + * @export + * @enum {number} + */ + +export const BusinessservicetypeV1 = { + NUMBER_0: 0, + NUMBER_1: 1, + NUMBER_2: 2, + NUMBER_3: 3, + NUMBER_4: 4, + NUMBER_5: 5, + NUMBER_6: 6, + NUMBER_7: 7, + NUMBER_8: 8, + NUMBER_9: 9, + NUMBER_10: 10, + NUMBER_11: 11, + NUMBER_12: 12, + NUMBER_13: 13, + NUMBER_14: 14, + NUMBER_15: 15, + NUMBER_16: 16, + NUMBER_18: 18, + NUMBER_24: 24, + NUMBER_25: 25, + NUMBER_30: 30, + NUMBER_801: 801, + NUMBER_908: 908, + NUMBER_909: 909, + NUMBER_910: 910, + NUMBER_912: 912, + NUMBER_913: 913, + NUMBER_914: 914, + NUMBER_950: 950, + NUMBER_951: 951, + NUMBER_952: 952, + NUMBER_953: 953, + NUMBER_1000: 1000, + NUMBER_1100: 1100, + NUMBER_1101: 1101, + NUMBER_1200: 1200, + NUMBER_1201: 1201, + NUMBER_1202: 1202, + NUMBER_1203: 1203, + NUMBER_1204: 1204, + NUMBER_1205: 1205, + NUMBER_1206: 1206, + NUMBER_1207: 1207, + NUMBER_1208: 1208, + NUMBER_1209: 1209, + NUMBER_1210: 1210, + NUMBER_1211: 1211, + NUMBER_1212: 1212, + NUMBER_1213: 1213, + NUMBER_1214: 1214, + NUMBER_1215: 1215, + NUMBER_1216: 1216, + NUMBER_1300: 1300, + NUMBER_1301: 1301, + NUMBER_1302: 1302, + NUMBER_1303: 1303, + NUMBER_1304: 1304, + NUMBER_1305: 1305, + NUMBER_1400: 1400, + NUMBER_1401: 1401, + NUMBER_1402: 1402, + NUMBER_1403: 1403, + NUMBER_1404: 1404, + NUMBER_1405: 1405, + NUMBER_1406: 1406, + NUMBER_1407: 1407, + NUMBER_1408: 1408, + NUMBER_1409: 1409, + NUMBER_1410: 1410, + NUMBER_1411: 1411 +} as const; + +export type BusinessservicetypeV1 = typeof BusinessservicetypeV1[keyof typeof BusinessservicetypeV1]; + + +/** + * Specifies when resource sizes should be calculated during a crawl operation. - 0: Unspecified - No specific option set. - 1: Never - Resource sizes are never calculated. - 2: Always - Resource sizes are always calculated. - 3: Secondcrawl - Resource sizes are calculated only on a second crawl. + * @export + * @enum {number} + */ + +export const CrawlresourcessizesoptionsV1 = { + NUMBER_0: 0, + NUMBER_1: 1, + NUMBER_2: 2, + NUMBER_3: 3 +} as const; + +export type CrawlresourcessizesoptionsV1 = typeof CrawlresourcessizesoptionsV1[keyof typeof CrawlresourcessizesoptionsV1]; + + +/** + * + * @export + * @interface CreateIdentityCollectorV1200ResponseV1 + */ +export interface CreateIdentityCollectorV1200ResponseV1 { + /** + * The unique identifier of the created identity collector. + * @type {number} + * @memberof CreateIdentityCollectorV1200ResponseV1 + */ + 'id'?: number; + /** + * The display name of the created identity collector. + * @type {string} + * @memberof CreateIdentityCollectorV1200ResponseV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface CreateidentitycollectorrequestV1 + */ +export interface CreateidentitycollectorrequestV1 { + /** + * The display name for the new identity collector. Must be unique within the tenant. + * @type {string} + * @memberof CreateidentitycollectorrequestV1 + */ + 'name': string; + /** + * The identifier of the source to create the identity collector for, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. The identity collector type is derived from this source. + * @type {string} + * @memberof CreateidentitycollectorrequestV1 + */ + 'sourceId': string; +} +/** + * + * @export + * @interface CreateschedulerequestV1 + */ +export interface CreateschedulerequestV1 { + /** + * The type or category of the scheduled task. + * @type {string} + * @memberof CreateschedulerequestV1 + */ + 'taskTypeName'?: string | null; + /** + * The scheduling type, such as \"Daily\", \"Weekly\" etc. + * @type {string} + * @memberof CreateschedulerequestV1 + */ + 'scheduleType'?: string | null; + /** + * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. + * @type {number} + * @memberof CreateschedulerequestV1 + */ + 'interval'?: number | null; + /** + * The display name of the scheduled task. + * @type {string} + * @memberof CreateschedulerequestV1 + */ + 'scheduleTaskName'?: string | null; + /** + * The start time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof CreateschedulerequestV1 + */ + 'startTime'?: number; + /** + * The end time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof CreateschedulerequestV1 + */ + 'endTime'?: number; + /** + * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). + * @type {Array} + * @memberof CreateschedulerequestV1 + */ + 'daysOfWeek'?: Array | null; + /** + * Indicates whether the scheduled task is currently active. + * @type {boolean} + * @memberof CreateschedulerequestV1 + */ + 'active'?: boolean; + /** + * The ID of another scheduled task that triggers this scheduled task upon its completion. + * @type {number} + * @memberof CreateschedulerequestV1 + */ + 'runAfterScheduleTaskId'?: number | null; + /** + * The unique identifier of the application associated with the scheduled task. + * @type {number} + * @memberof CreateschedulerequestV1 + */ + 'applicationId'?: number | null; +} +/** + * + * @export + * @interface DataclassificationsettingsV1 + */ +export interface DataclassificationsettingsV1 { + /** + * Indicates whether the feature or configuration is enabled. + * @type {boolean} + * @memberof DataclassificationsettingsV1 + */ + 'isEnabled'?: boolean; + /** + * The identifier of the cluster associated with this configuration, if applicable. + * @type {string} + * @memberof DataclassificationsettingsV1 + */ + 'clusterId'?: string | null; +} +/** + * + * @export + * @interface DataownermodelV1 + */ +export interface DataownermodelV1 { + /** + * The unique identifier (UUID) of the identity assigned as the owner of the resource. + * @type {string} + * @memberof DataownermodelV1 + */ + 'identityId'?: string; + /** + * The unique identifier of the resource owned by the identity. + * @type {number} + * @memberof DataownermodelV1 + */ + 'resourceId'?: number; + /** + * The full path to the resource within the system or application. + * @type {string} + * @memberof DataownermodelV1 + */ + 'fullPath'?: string | null; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTasksV1401ResponseV1 + */ +export interface GetTasksV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTasksV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTasksV1429ResponseV1 + */ +export interface GetTasksV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTasksV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface IdentitycollectorlistitemV1 + */ +export interface IdentitycollectorlistitemV1 { + /** + * The unique identifier of the identity collector. + * @type {string} + * @memberof IdentitycollectorlistitemV1 + */ + 'id'?: string; + /** + * The display name of the identity collector. + * @type {string} + * @memberof IdentitycollectorlistitemV1 + */ + 'name'?: string; + /** + * The identity collector type, derived from its underlying source. Possible values include \"Active Directory\", \"Azure Active Directory\", \"Google Drive\", \"Dropbox\", \"Box\", \"Microsoft Entra SaaS\", \"Snowflake\", and \"Databricks\". + * @type {string} + * @memberof IdentitycollectorlistitemV1 + */ + 'type'?: string; + /** + * The identifier of the source the identity collector is associated with, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. + * @type {string} + * @memberof IdentitycollectorlistitemV1 + */ + 'sourceId'?: string; +} +/** + * + * @export + * @interface Int64stringkeyvaluepairV1 + */ +export interface Int64stringkeyvaluepairV1 { + /** + * The key for the tag or pair. + * @type {number} + * @memberof Int64stringkeyvaluepairV1 + */ + 'key'?: number; + /** + * The value for the tag or pair. + * @type {string} + * @memberof Int64stringkeyvaluepairV1 + */ + 'value'?: string | null; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PermissioncollectorsettingsV1 + */ +export interface PermissioncollectorsettingsV1 { + /** + * Indicates whether the feature or configuration is enabled. + * @type {boolean} + * @memberof PermissioncollectorsettingsV1 + */ + 'isEnabled'?: boolean; + /** + * The identifier of the cluster associated with this configuration, if applicable. + * @type {string} + * @memberof PermissioncollectorsettingsV1 + */ + 'clusterId'?: string | null; + /** + * Indicates whether unique permissions should be analyzed for resources. + * @type {boolean} + * @memberof PermissioncollectorsettingsV1 + */ + 'analyzeUniquePermissions'?: boolean | null; + /** + * Indicates whether effective permissions should be calculated. + * @type {boolean} + * @memberof PermissioncollectorsettingsV1 + */ + 'calculateEffectivePermissions'?: boolean | null; + /** + * Indicates whether riskiest permissions should be calculated. + * @type {boolean} + * @memberof PermissioncollectorsettingsV1 + */ + 'calculateRiskiestPermissions'?: boolean | null; + /** + * Source for effective permissions calculation. + * @type {string} + * @memberof PermissioncollectorsettingsV1 + */ + 'effectivePermissionsSource'?: string | null; +} +/** + * + * @export + * @interface PutIdentityCollectorV1409ResponseMessagesInnerV1 + */ +export interface PutIdentityCollectorV1409ResponseMessagesInnerV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof PutIdentityCollectorV1409ResponseMessagesInnerV1 + */ + 'locale'?: string; + /** + * An indicator of how the locale was selected. + * @type {string} + * @memberof PutIdentityCollectorV1409ResponseMessagesInnerV1 + */ + 'localeOrigin'?: string; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof PutIdentityCollectorV1409ResponseMessagesInnerV1 + */ + 'text'?: string; +} +/** + * + * @export + * @interface PutIdentityCollectorV1409ResponseV1 + */ +export interface PutIdentityCollectorV1409ResponseV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof PutIdentityCollectorV1409ResponseV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof PutIdentityCollectorV1409ResponseV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error. + * @type {Array} + * @memberof PutIdentityCollectorV1409ResponseV1 + */ + 'messages'?: Array; +} +/** + * + * @export + * @interface ReelectrequestV1 + */ +export interface ReelectrequestV1 { + /** + * The UUID of the identity proposed to be re-elected as the resource owner. + * @type {string} + * @memberof ReelectrequestV1 + */ + 'ownerId'?: string; + /** + * The name of the campaign or election process for re-electing the owner. + * @type {string} + * @memberof ReelectrequestV1 + */ + 'campaignName'?: string | null; + /** + * A list of UUIDs representing the identities of reviewers participating in the re-election process. + * @type {Array} + * @memberof ReelectrequestV1 + */ + 'reviewers'?: Array | null; +} +/** + * + * @export + * @interface ResourcemodelV1 + */ +export interface ResourcemodelV1 { + /** + * The unique identifier for the resource. + * @type {number} + * @memberof ResourcemodelV1 + */ + 'id'?: number; + /** + * The display name or label for the resource. + * @type {string} + * @memberof ResourcemodelV1 + */ + 'name'?: string | null; + /** + * The full path to the resource within the system or application. + * @type {string} + * @memberof ResourcemodelV1 + */ + 'fullPath'?: string | null; + /** + * The unique identifier of the application to which this resource belongs. + * @type {number} + * @memberof ResourcemodelV1 + */ + 'applicationId'?: number; + /** + * + * @type {BusinessservicetypeV1} + * @memberof ResourcemodelV1 + */ + 'type'?: BusinessservicetypeV1; + /** + * A list of UUIDs representing the owners of the resource. + * @type {Array} + * @memberof ResourcemodelV1 + */ + 'owners'?: Array | null; +} + + +/** + * + * @export + * @interface ScheduleinfoV1 + */ +export interface ScheduleinfoV1 { + /** + * The unique identifier for the scheduled task. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'scheduleTaskId'?: number; + /** + * The display name of the scheduled task. + * @type {string} + * @memberof ScheduleinfoV1 + */ + 'scheduleTaskName'?: string | null; + /** + * The type or category of the scheduled task. + * @type {string} + * @memberof ScheduleinfoV1 + */ + 'taskTypeName'?: string | null; + /** + * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'interval'?: number; + /** + * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. + * @type {string} + * @memberof ScheduleinfoV1 + */ + 'scheduleType'?: string | null; + /** + * Indicates whether the scheduled task is currently active. + * @type {boolean} + * @memberof ScheduleinfoV1 + */ + 'active'?: boolean; + /** + * The start time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'startTime'?: number | null; + /** + * The end time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'endTime'?: number | null; + /** + * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). + * @type {Array} + * @memberof ScheduleinfoV1 + */ + 'daysOfWeek'?: Array | null; + /** + * The ID of another scheduled task that triggers this scheduled task upon its completion. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'runAfterScheduleTaskId'?: number | null; + /** + * The name of the scheduled task that must complete before this task runs. + * @type {string} + * @memberof ScheduleinfoV1 + */ + 'runAfterScheduleTaskName'?: string | null; + /** + * The unique identifier of the application associated with the scheduled task. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'applicationId'?: number | null; + /** + * The display name of the user who created the scheduled task. + * @type {string} + * @memberof ScheduleinfoV1 + */ + 'createdByDisplayName'?: string | null; + /** + * The next scheduled run time for the task, represented as epoch seconds. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'nextRun'?: number | null; + /** + * The last run time of the task, represented as epoch seconds. + * @type {number} + * @memberof ScheduleinfoV1 + */ + 'lastRun'?: number | null; +} +/** + * + * @export + * @interface TagV1 + */ +export interface TagV1 { + /** + * The unique identifier for the tag. + * @type {number} + * @memberof TagV1 + */ + 'id'?: number; + /** + * The display name or label for the tag. + * @type {string} + * @memberof TagV1 + */ + 'name'?: string | null; +} +/** + * + * @export + * @interface TaskinfoV1 + */ +export interface TaskinfoV1 { + /** + * The unique identifier for the task. + * @type {number} + * @memberof TaskinfoV1 + */ + 'taskId'?: number | null; + /** + * The type or category of the task. + * @type {string} + * @memberof TaskinfoV1 + */ + 'taskTypeName'?: string | null; + /** + * The start time of the task, represented as epoch seconds. + * @type {number} + * @memberof TaskinfoV1 + */ + 'startTime'?: number | null; + /** + * The end time of the task, represented as epoch seconds. + * @type {number} + * @memberof TaskinfoV1 + */ + 'endTime'?: number | null; + /** + * The display name of the task. + * @type {string} + * @memberof TaskinfoV1 + */ + 'taskName'?: string | null; + /** + * The display name of the user who created the task. + * @type {string} + * @memberof TaskinfoV1 + */ + 'createdByDisplayName'?: string | null; + /** + * The progress of the task, typically represented as a percentage (0-100). + * @type {number} + * @memberof TaskinfoV1 + */ + 'progress'?: number; + /** + * The current status of the task (e.g., \"Running\", \"Completed\", \"Failed\"). + * @type {string} + * @memberof TaskinfoV1 + */ + 'status'?: string | null; + /** + * Additional details or information about the task. + * @type {string} + * @memberof TaskinfoV1 + */ + 'details'?: string | null; + /** + * The unique identifier of the associated scheduled task, if applicable. + * @type {number} + * @memberof TaskinfoV1 + */ + 'scheduleTaskId'?: number | null; +} +/** + * + * @export + * @interface UpdateidentitycollectorrequestV1 + */ +export interface UpdateidentitycollectorrequestV1 { + /** + * The display name of the identity collector. Must be unique within the tenant. + * @type {string} + * @memberof UpdateidentitycollectorrequestV1 + */ + 'name': string; + /** + * The identifier of the associated source, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. This value cannot be modified for an existing identity collector and must match the current value. + * @type {string} + * @memberof UpdateidentitycollectorrequestV1 + */ + 'sourceId': string; + /** + * The identity collector type. This value cannot be modified for an existing identity collector and must match the current value. + * @type {string} + * @memberof UpdateidentitycollectorrequestV1 + */ + 'type': string; +} +/** + * + * @export + * @interface UpdateschedulerequestV1 + */ +export interface UpdateschedulerequestV1 { + /** + * The type or category of the scheduled task. + * @type {string} + * @memberof UpdateschedulerequestV1 + */ + 'taskTypeName'?: string | null; + /** + * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. + * @type {string} + * @memberof UpdateschedulerequestV1 + */ + 'scheduleType'?: string | null; + /** + * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. + * @type {number} + * @memberof UpdateschedulerequestV1 + */ + 'interval'?: number | null; + /** + * The display name of the scheduled task. + * @type {string} + * @memberof UpdateschedulerequestV1 + */ + 'scheduleTaskName'?: string | null; + /** + * The start time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof UpdateschedulerequestV1 + */ + 'startTime'?: number; + /** + * The end time for the scheduled task, represented as epoch seconds. + * @type {number} + * @memberof UpdateschedulerequestV1 + */ + 'endTime'?: number; + /** + * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). + * @type {Array} + * @memberof UpdateschedulerequestV1 + */ + 'daysOfWeek'?: Array | null; + /** + * Indicates whether the scheduled task is currently active. + * @type {boolean} + * @memberof UpdateschedulerequestV1 + */ + 'active'?: boolean; + /** + * The ID of another scheduled task that triggers this scheduled task upon its completion. + * @type {number} + * @memberof UpdateschedulerequestV1 + */ + 'runAfterScheduleTaskId'?: number | null; + /** + * The unique identifier of the application associated with the scheduled task. + * @type {number} + * @memberof UpdateschedulerequestV1 + */ + 'applicationId'?: number | null; +} + +/** + * DataAccessSecurityV1Api - axios parameter creator + * @export + */ +export const DataAccessSecurityV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This end-point sends a request to cancel a task in Data Access Security. + * @summary Cancel a DAS task. + * @param {number} id The unique identifier of the task to cancel. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelTaskV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cancelTaskV1', 'id', id) + const localVarPath = `/das/v1/tasks/cancel/{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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint creates a new application in Data Access Security with the specified configuration. + * @summary Create application + * @param {BasecreateapplicationrequestV1} basecreateapplicationrequestV1 Request body containing the details required to create a new application. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createApplicationV1: async (basecreateapplicationrequestV1: BasecreateapplicationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'basecreateapplicationrequestV1' is not null or undefined + assertParamExists('createApplicationV1', 'basecreateapplicationrequestV1', basecreateapplicationrequestV1) + const localVarPath = `/das/v1/applications`; + // 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(basecreateapplicationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. + * @summary Create identity collector + * @param {CreateidentitycollectorrequestV1} createidentitycollectorrequestV1 Request body containing the details required to create a new identity collector. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityCollectorV1: async (createidentitycollectorrequestV1: CreateidentitycollectorrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createidentitycollectorrequestV1' is not null or undefined + assertParamExists('createIdentityCollectorV1', 'createidentitycollectorrequestV1', createidentitycollectorrequestV1) + const localVarPath = `/das/identity-collectors/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(createidentitycollectorrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Create a new schedule. + * @param {CreateschedulerequestV1} createschedulerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduleV1: async (createschedulerequestV1: CreateschedulerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createschedulerequestV1' is not null or undefined + assertParamExists('createScheduleV1', 'createschedulerequestV1', createschedulerequestV1) + const localVarPath = `/das/v1/tasks/schedules`; + // 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(createschedulerequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Assign owner to application resource. + * @param {AssignresourceownerrequestV1} assignresourceownerrequestV1 The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersAssignPost: async (assignresourceownerrequestV1: AssignresourceownerrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'assignresourceownerrequestV1' is not null or undefined + assertParamExists('dasV1OwnersAssignPost', 'assignresourceownerrequestV1', assignresourceownerrequestV1) + const localVarPath = `/das/v1/owners/assign`; + // 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(assignresourceownerrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary List resources for owner. + * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersOwnerIdentityIdResourcesGet: async (ownerIdentityId: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ownerIdentityId' is not null or undefined + assertParamExists('dasV1OwnersOwnerIdentityIdResourcesGet', 'ownerIdentityId', ownerIdentityId) + const localVarPath = `/das/v1/owners/{ownerIdentityId}/resources` + .replace(`{${"ownerIdentityId"}}`, encodeURIComponent(String(ownerIdentityId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Re-elect resource owner. + * @param {ReelectrequestV1} reelectrequestV1 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersReelectPost: async (reelectrequestV1: ReelectrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'reelectrequestV1' is not null or undefined + assertParamExists('dasV1OwnersReelectPost', 'reelectrequestV1', reelectrequestV1) + const localVarPath = `/das/v1/owners/reelect`; + // 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(reelectrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary List owners for resource. + * @param {number} resourceId Unique identifier for the resource. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersResourcesResourceIdGet: async (resourceId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('dasV1OwnersResourcesResourceIdGet', 'resourceId', resourceId) + const localVarPath = `/das/v1/owners/resources/{resourceId}` + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Reassign resource owner. + * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. + * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost: async (sourceIdentityId: string, destinationIdentityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceIdentityId' is not null or undefined + assertParamExists('dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'sourceIdentityId', sourceIdentityId) + // verify required parameter 'destinationIdentityId' is not null or undefined + assertParamExists('dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'destinationIdentityId', destinationIdentityId) + const localVarPath = `/das/v1/owners/{sourceIdentityId}/reassign/{destinationIdentityId}` + .replace(`{${"sourceIdentityId"}}`, encodeURIComponent(String(sourceIdentityId))) + .replace(`{${"destinationIdentityId"}}`, encodeURIComponent(String(destinationIdentityId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint deletes an application from Data Access Security by its unique identifier. + * @summary Delete an application by identifier. + * @param {number} id The unique identifier of the application to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteApplicationV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteApplicationV1', 'id', id) + const localVarPath = `/das/v1/applications/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint deletes an identity collector from Data Access Security by its unique identifier. + * @summary Delete identity collector by identifier + * @param {number} id The unique identifier of the identity collector to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityCollectorV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteIdentityCollectorV1', 'id', id) + const localVarPath = `/das/identity-collectors/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, + }; + }, + /** + * This end-point sends a request to delete a schedule in Data Access Security. + * @summary Delete a DAS schedule. + * @param {number} id The unique identifier of the schedule to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduleV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteScheduleV1', 'id', id) + const localVarPath = `/das/v1/tasks/schedules/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point sends a request to delete a task in Data Access Security. + * @summary Delete a DAS task. + * @param {number} id The unique identifier of the task to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTaskV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteTaskV1', 'id', id) + const localVarPath = `/das/v1/tasks/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. + * @summary Retrieve application details by identifier. + * @param {number} id The unique identifier of the application to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApplicationV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getApplicationV1', 'id', id) + const localVarPath = `/das/v1/applications/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint lists all the applications in Data Access Security with optional filtering. + * @summary Search applications in DAS. + * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApplicationsV1: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/das/v1/applications`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Retrieve owners per application. + * @param {number} appId The unique identifier of the application for which to retrieve owners. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOwnersV1: async (appId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'appId' is not null or undefined + assertParamExists('getOwnersV1', 'appId', appId) + const localVarPath = `/das/v1/owners/applications/{appId}` + .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point gets a schedule in Data Access Security. + * @summary Get a DAS schedule. + * @param {number} id The unique identifier of the schedule to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getScheduleV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getScheduleV1', 'id', id) + const localVarPath = `/das/v1/tasks/schedules/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point lists all the schedules in Data Access Security. + * @summary List all schedules. + * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSchedulesV1: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/das/v1/tasks/schedules`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point gets a task in Data Access Security. + * @summary Get a DAS task. + * @param {number} id The unique identifier of the task to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getTaskV1', 'id', id) + const localVarPath = `/das/v1/tasks/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point lists all the tasks in Data Access Security. + * @summary Lists all DAS tasks. + * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTasksV1: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/das/v1/tasks`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error. + * @summary List identity collectors + * @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: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityCollectorsV1: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/das/identity-collectors/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint updates an existing application in Data Access Security with the specified configuration. + * @summary Update application by identifier. + * @param {number} id The unique identifier of the application to update. + * @param {BasecreateapplicationrequestV1} basecreateapplicationrequestV1 Request body containing the updated details for the application. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putApplicationV1: async (id: number, basecreateapplicationrequestV1: BasecreateapplicationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putApplicationV1', 'id', id) + // verify required parameter 'basecreateapplicationrequestV1' is not null or undefined + assertParamExists('putApplicationV1', 'basecreateapplicationrequestV1', basecreateapplicationrequestV1) + const localVarPath = `/das/v1/applications/{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: 'PUT', ...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(basecreateapplicationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint updates the name of an existing identity collector in Data Access Security. The `sourceId` and `type` cannot be changed and must match the current values. + * @summary Update identity collector by identifier + * @param {number} id The unique identifier of the identity collector to update. + * @param {UpdateidentitycollectorrequestV1} updateidentitycollectorrequestV1 Request body containing the updated details for the identity collector. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putIdentityCollectorV1: async (id: number, updateidentitycollectorrequestV1: UpdateidentitycollectorrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putIdentityCollectorV1', 'id', id) + // verify required parameter 'updateidentitycollectorrequestV1' is not null or undefined + assertParamExists('putIdentityCollectorV1', 'updateidentitycollectorrequestV1', updateidentitycollectorrequestV1) + const localVarPath = `/das/identity-collectors/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: 'PUT', ...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(updateidentitycollectorrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * + * @summary Update a schedule. + * @param {number} id The unique identifier of the schedule to update. + * @param {UpdateschedulerequestV1} updateschedulerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putScheduleV1: async (id: number, updateschedulerequestV1: UpdateschedulerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putScheduleV1', 'id', id) + // verify required parameter 'updateschedulerequestV1' is not null or undefined + assertParamExists('putScheduleV1', 'updateschedulerequestV1', updateschedulerequestV1) + const localVarPath = `/das/v1/tasks/schedules/{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: 'PUT', ...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(updateschedulerequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point sends a request to re-run a task in Data Access Security. + * @summary Rerun a DAS task. + * @param {number} id The unique identifier of the task to rerun. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startTaskRerunV1: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startTaskRerunV1', 'id', id) + const localVarPath = `/das/v1/tasks/rerun/{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: 'POST', ...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, + }; + }, + } +}; + +/** + * DataAccessSecurityV1Api - functional programming interface + * @export + */ +export const DataAccessSecurityV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DataAccessSecurityV1ApiAxiosParamCreator(configuration) + return { + /** + * This end-point sends a request to cancel a task in Data Access Security. + * @summary Cancel a DAS task. + * @param {number} id The unique identifier of the task to cancel. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelTaskV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelTaskV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.cancelTaskV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint creates a new application in Data Access Security with the specified configuration. + * @summary Create application + * @param {BasecreateapplicationrequestV1} basecreateapplicationrequestV1 Request body containing the details required to create a new application. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createApplicationV1(basecreateapplicationrequestV1: BasecreateapplicationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createApplicationV1(basecreateapplicationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.createApplicationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. + * @summary Create identity collector + * @param {CreateidentitycollectorrequestV1} createidentitycollectorrequestV1 Request body containing the details required to create a new identity collector. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createIdentityCollectorV1(createidentitycollectorrequestV1: CreateidentitycollectorrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityCollectorV1(createidentitycollectorrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.createIdentityCollectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Create a new schedule. + * @param {CreateschedulerequestV1} createschedulerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createScheduleV1(createschedulerequestV1: CreateschedulerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduleV1(createschedulerequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.createScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Assign owner to application resource. + * @param {AssignresourceownerrequestV1} assignresourceownerrequestV1 The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async dasV1OwnersAssignPost(assignresourceownerrequestV1: AssignresourceownerrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.dasV1OwnersAssignPost(assignresourceownerrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.dasV1OwnersAssignPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary List resources for owner. + * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async dasV1OwnersOwnerIdentityIdResourcesGet(ownerIdentityId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.dasV1OwnersOwnerIdentityIdResourcesGet(ownerIdentityId, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.dasV1OwnersOwnerIdentityIdResourcesGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Re-elect resource owner. + * @param {ReelectrequestV1} reelectrequestV1 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async dasV1OwnersReelectPost(reelectrequestV1: ReelectrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.dasV1OwnersReelectPost(reelectrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.dasV1OwnersReelectPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary List owners for resource. + * @param {number} resourceId Unique identifier for the resource. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async dasV1OwnersResourcesResourceIdGet(resourceId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.dasV1OwnersResourcesResourceIdGet(resourceId, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.dasV1OwnersResourcesResourceIdGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Reassign resource owner. + * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. + * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId: string, destinationIdentityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId, destinationIdentityId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint deletes an application from Data Access Security by its unique identifier. + * @summary Delete an application by identifier. + * @param {number} id The unique identifier of the application to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteApplicationV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApplicationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.deleteApplicationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint deletes an identity collector from Data Access Security by its unique identifier. + * @summary Delete identity collector by identifier + * @param {number} id The unique identifier of the identity collector to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityCollectorV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityCollectorV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.deleteIdentityCollectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point sends a request to delete a schedule in Data Access Security. + * @summary Delete a DAS schedule. + * @param {number} id The unique identifier of the schedule to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteScheduleV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.deleteScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point sends a request to delete a task in Data Access Security. + * @summary Delete a DAS task. + * @param {number} id The unique identifier of the task to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteTaskV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaskV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.deleteTaskV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. + * @summary Retrieve application details by identifier. + * @param {number} id The unique identifier of the application to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getApplicationV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApplicationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getApplicationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint lists all the applications in Data Access Security with optional filtering. + * @summary Search applications in DAS. + * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getApplicationsV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApplicationsV1(filters, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getApplicationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Retrieve owners per application. + * @param {number} appId The unique identifier of the application for which to retrieve owners. + * @param {number} [limit] Not applicable for this endpoint. Do not use. + * @param {number} [offset] Not applicable for this endpoint. Do not use. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getOwnersV1(appId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOwnersV1(appId, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getOwnersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point gets a schedule in Data Access Security. + * @summary Get a DAS schedule. + * @param {number} id The unique identifier of the schedule to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getScheduleV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point lists all the schedules in Data Access Security. + * @summary List all schedules. + * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSchedulesV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSchedulesV1(filters, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getSchedulesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point gets a task in Data Access Security. + * @summary Get a DAS task. + * @param {number} id The unique identifier of the task to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTaskV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getTaskV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point lists all the tasks in Data Access Security. + * @summary Lists all DAS tasks. + * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTasksV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTasksV1(filters, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.getTasksV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error. + * @summary List identity collectors + * @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: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityCollectorsV1(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCollectorsV1(filters, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.listIdentityCollectorsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint updates an existing application in Data Access Security with the specified configuration. + * @summary Update application by identifier. + * @param {number} id The unique identifier of the application to update. + * @param {BasecreateapplicationrequestV1} basecreateapplicationrequestV1 Request body containing the updated details for the application. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putApplicationV1(id: number, basecreateapplicationrequestV1: BasecreateapplicationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putApplicationV1(id, basecreateapplicationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.putApplicationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint updates the name of an existing identity collector in Data Access Security. The `sourceId` and `type` cannot be changed and must match the current values. + * @summary Update identity collector by identifier + * @param {number} id The unique identifier of the identity collector to update. + * @param {UpdateidentitycollectorrequestV1} updateidentitycollectorrequestV1 Request body containing the updated details for the identity collector. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putIdentityCollectorV1(id: number, updateidentitycollectorrequestV1: UpdateidentitycollectorrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityCollectorV1(id, updateidentitycollectorrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.putIdentityCollectorV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Update a schedule. + * @param {number} id The unique identifier of the schedule to update. + * @param {UpdateschedulerequestV1} updateschedulerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putScheduleV1(id: number, updateschedulerequestV1: UpdateschedulerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putScheduleV1(id, updateschedulerequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.putScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point sends a request to re-run a task in Data Access Security. + * @summary Rerun a DAS task. + * @param {number} id The unique identifier of the task to rerun. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startTaskRerunV1(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startTaskRerunV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV1Api.startTaskRerunV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DataAccessSecurityV1Api - factory interface + * @export + */ +export const DataAccessSecurityV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DataAccessSecurityV1ApiFp(configuration) + return { + /** + * This end-point sends a request to cancel a task in Data Access Security. + * @summary Cancel a DAS task. + * @param {DataAccessSecurityV1ApiCancelTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelTaskV1(requestParameters: DataAccessSecurityV1ApiCancelTaskV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelTaskV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint creates a new application in Data Access Security with the specified configuration. + * @summary Create application + * @param {DataAccessSecurityV1ApiCreateApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createApplicationV1(requestParameters: DataAccessSecurityV1ApiCreateApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createApplicationV1(requestParameters.basecreateapplicationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. + * @summary Create identity collector + * @param {DataAccessSecurityV1ApiCreateIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createIdentityCollectorV1(requestParameters.createidentitycollectorrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Create a new schedule. + * @param {DataAccessSecurityV1ApiCreateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduleV1(requestParameters: DataAccessSecurityV1ApiCreateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createScheduleV1(requestParameters.createschedulerequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Assign owner to application resource. + * @param {DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersAssignPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.dasV1OwnersAssignPost(requestParameters.assignresourceownerrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List resources for owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.dasV1OwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Re-elect resource owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersReelectPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.dasV1OwnersReelectPost(requestParameters.reelectrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List owners for resource. + * @param {DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.dasV1OwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Reassign resource owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint deletes an application from Data Access Security by its unique identifier. + * @summary Delete an application by identifier. + * @param {DataAccessSecurityV1ApiDeleteApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteApplicationV1(requestParameters: DataAccessSecurityV1ApiDeleteApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteApplicationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint deletes an identity collector from Data Access Security by its unique identifier. + * @summary Delete identity collector by identifier + * @param {DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityCollectorV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point sends a request to delete a schedule in Data Access Security. + * @summary Delete a DAS schedule. + * @param {DataAccessSecurityV1ApiDeleteScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduleV1(requestParameters: DataAccessSecurityV1ApiDeleteScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point sends a request to delete a task in Data Access Security. + * @summary Delete a DAS task. + * @param {DataAccessSecurityV1ApiDeleteTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTaskV1(requestParameters: DataAccessSecurityV1ApiDeleteTaskV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteTaskV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. + * @summary Retrieve application details by identifier. + * @param {DataAccessSecurityV1ApiGetApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApplicationV1(requestParameters: DataAccessSecurityV1ApiGetApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getApplicationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint lists all the applications in Data Access Security with optional filtering. + * @summary Search applications in DAS. + * @param {DataAccessSecurityV1ApiGetApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getApplicationsV1(requestParameters: DataAccessSecurityV1ApiGetApplicationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getApplicationsV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieve owners per application. + * @param {DataAccessSecurityV1ApiGetOwnersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOwnersV1(requestParameters: DataAccessSecurityV1ApiGetOwnersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getOwnersV1(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point gets a schedule in Data Access Security. + * @summary Get a DAS schedule. + * @param {DataAccessSecurityV1ApiGetScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getScheduleV1(requestParameters: DataAccessSecurityV1ApiGetScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point lists all the schedules in Data Access Security. + * @summary List all schedules. + * @param {DataAccessSecurityV1ApiGetSchedulesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSchedulesV1(requestParameters: DataAccessSecurityV1ApiGetSchedulesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSchedulesV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point gets a task in Data Access Security. + * @summary Get a DAS task. + * @param {DataAccessSecurityV1ApiGetTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskV1(requestParameters: DataAccessSecurityV1ApiGetTaskV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTaskV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point lists all the tasks in Data Access Security. + * @summary Lists all DAS tasks. + * @param {DataAccessSecurityV1ApiGetTasksV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTasksV1(requestParameters: DataAccessSecurityV1ApiGetTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getTasksV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error. + * @summary List identity collectors + * @param {DataAccessSecurityV1ApiListIdentityCollectorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityCollectorsV1(requestParameters: DataAccessSecurityV1ApiListIdentityCollectorsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityCollectorsV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint updates an existing application in Data Access Security with the specified configuration. + * @summary Update application by identifier. + * @param {DataAccessSecurityV1ApiPutApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putApplicationV1(requestParameters: DataAccessSecurityV1ApiPutApplicationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putApplicationV1(requestParameters.id, requestParameters.basecreateapplicationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint updates the name of an existing identity collector in Data Access Security. The `sourceId` and `type` cannot be changed and must match the current values. + * @summary Update identity collector by identifier + * @param {DataAccessSecurityV1ApiPutIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiPutIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putIdentityCollectorV1(requestParameters.id, requestParameters.updateidentitycollectorrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Update a schedule. + * @param {DataAccessSecurityV1ApiPutScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putScheduleV1(requestParameters: DataAccessSecurityV1ApiPutScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putScheduleV1(requestParameters.id, requestParameters.updateschedulerequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point sends a request to re-run a task in Data Access Security. + * @summary Rerun a DAS task. + * @param {DataAccessSecurityV1ApiStartTaskRerunV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startTaskRerunV1(requestParameters: DataAccessSecurityV1ApiStartTaskRerunV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startTaskRerunV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for cancelTaskV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiCancelTaskV1Request + */ +export interface DataAccessSecurityV1ApiCancelTaskV1Request { + /** + * The unique identifier of the task to cancel. + * @type {number} + * @memberof DataAccessSecurityV1ApiCancelTaskV1 + */ + readonly id: number +} + +/** + * Request parameters for createApplicationV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiCreateApplicationV1Request + */ +export interface DataAccessSecurityV1ApiCreateApplicationV1Request { + /** + * Request body containing the details required to create a new application. + * @type {BasecreateapplicationrequestV1} + * @memberof DataAccessSecurityV1ApiCreateApplicationV1 + */ + readonly basecreateapplicationrequestV1: BasecreateapplicationrequestV1 +} + +/** + * Request parameters for createIdentityCollectorV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiCreateIdentityCollectorV1Request + */ +export interface DataAccessSecurityV1ApiCreateIdentityCollectorV1Request { + /** + * Request body containing the details required to create a new identity collector. + * @type {CreateidentitycollectorrequestV1} + * @memberof DataAccessSecurityV1ApiCreateIdentityCollectorV1 + */ + readonly createidentitycollectorrequestV1: CreateidentitycollectorrequestV1 +} + +/** + * Request parameters for createScheduleV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiCreateScheduleV1Request + */ +export interface DataAccessSecurityV1ApiCreateScheduleV1Request { + /** + * + * @type {CreateschedulerequestV1} + * @memberof DataAccessSecurityV1ApiCreateScheduleV1 + */ + readonly createschedulerequestV1: CreateschedulerequestV1 +} + +/** + * Request parameters for dasV1OwnersAssignPost operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest + */ +export interface DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest { + /** + * The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. + * @type {AssignresourceownerrequestV1} + * @memberof DataAccessSecurityV1ApiDasV1OwnersAssignPost + */ + readonly assignresourceownerrequestV1: AssignresourceownerrequestV1 +} + +/** + * Request parameters for dasV1OwnersOwnerIdentityIdResourcesGet operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest + */ +export interface DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest { + /** + * Unique identifier for the owner. This should be a UUID representing the owner\'s identity. + * @type {string} + * @memberof DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGet + */ + readonly ownerIdentityId: string + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGet + */ + readonly limit?: number + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGet + */ + readonly offset?: number +} + +/** + * Request parameters for dasV1OwnersReelectPost operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest + */ +export interface DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest { + /** + * The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. + * @type {ReelectrequestV1} + * @memberof DataAccessSecurityV1ApiDasV1OwnersReelectPost + */ + readonly reelectrequestV1: ReelectrequestV1 +} + +/** + * Request parameters for dasV1OwnersResourcesResourceIdGet operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest + */ +export interface DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest { + /** + * Unique identifier for the resource. + * @type {number} + * @memberof DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGet + */ + readonly resourceId: number + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGet + */ + readonly limit?: number + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGet + */ + readonly offset?: number +} + +/** + * Request parameters for dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest + */ +export interface DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest { + /** + * Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. + * @type {string} + * @memberof DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost + */ + readonly sourceIdentityId: string + + /** + * Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. + * @type {string} + * @memberof DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost + */ + readonly destinationIdentityId: string +} + +/** + * Request parameters for deleteApplicationV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDeleteApplicationV1Request + */ +export interface DataAccessSecurityV1ApiDeleteApplicationV1Request { + /** + * The unique identifier of the application to delete. + * @type {number} + * @memberof DataAccessSecurityV1ApiDeleteApplicationV1 + */ + readonly id: number +} + +/** + * Request parameters for deleteIdentityCollectorV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request + */ +export interface DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request { + /** + * The unique identifier of the identity collector to delete. + * @type {number} + * @memberof DataAccessSecurityV1ApiDeleteIdentityCollectorV1 + */ + readonly id: number +} + +/** + * Request parameters for deleteScheduleV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDeleteScheduleV1Request + */ +export interface DataAccessSecurityV1ApiDeleteScheduleV1Request { + /** + * The unique identifier of the schedule to delete. + * @type {number} + * @memberof DataAccessSecurityV1ApiDeleteScheduleV1 + */ + readonly id: number +} + +/** + * Request parameters for deleteTaskV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiDeleteTaskV1Request + */ +export interface DataAccessSecurityV1ApiDeleteTaskV1Request { + /** + * The unique identifier of the task to delete. + * @type {number} + * @memberof DataAccessSecurityV1ApiDeleteTaskV1 + */ + readonly id: number +} + +/** + * Request parameters for getApplicationV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetApplicationV1Request + */ +export interface DataAccessSecurityV1ApiGetApplicationV1Request { + /** + * The unique identifier of the application to retrieve. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetApplicationV1 + */ + readonly id: number +} + +/** + * Request parameters for getApplicationsV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetApplicationsV1Request + */ +export interface DataAccessSecurityV1ApiGetApplicationsV1Request { + /** + * 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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* + * @type {string} + * @memberof DataAccessSecurityV1ApiGetApplicationsV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetApplicationsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetApplicationsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DataAccessSecurityV1ApiGetApplicationsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getOwnersV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetOwnersV1Request + */ +export interface DataAccessSecurityV1ApiGetOwnersV1Request { + /** + * The unique identifier of the application for which to retrieve owners. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetOwnersV1 + */ + readonly appId: number + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetOwnersV1 + */ + readonly limit?: number + + /** + * Not applicable for this endpoint. Do not use. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetOwnersV1 + */ + readonly offset?: number +} + +/** + * Request parameters for getScheduleV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetScheduleV1Request + */ +export interface DataAccessSecurityV1ApiGetScheduleV1Request { + /** + * The unique identifier of the schedule to retrieve. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetScheduleV1 + */ + readonly id: number +} + +/** + * Request parameters for getSchedulesV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetSchedulesV1Request + */ +export interface DataAccessSecurityV1ApiGetSchedulesV1Request { + /** + * 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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* + * @type {string} + * @memberof DataAccessSecurityV1ApiGetSchedulesV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetSchedulesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetSchedulesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DataAccessSecurityV1ApiGetSchedulesV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getTaskV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetTaskV1Request + */ +export interface DataAccessSecurityV1ApiGetTaskV1Request { + /** + * The unique identifier of the task to retrieve. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetTaskV1 + */ + readonly id: number +} + +/** + * Request parameters for getTasksV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiGetTasksV1Request + */ +export interface DataAccessSecurityV1ApiGetTasksV1Request { + /** + * 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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 + * @type {string} + * @memberof DataAccessSecurityV1ApiGetTasksV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetTasksV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiGetTasksV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DataAccessSecurityV1ApiGetTasksV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for listIdentityCollectorsV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiListIdentityCollectorsV1Request + */ +export interface DataAccessSecurityV1ApiListIdentityCollectorsV1Request { + /** + * 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: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* + * @type {string} + * @memberof DataAccessSecurityV1ApiListIdentityCollectorsV1 + */ + readonly filters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiListIdentityCollectorsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataAccessSecurityV1ApiListIdentityCollectorsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DataAccessSecurityV1ApiListIdentityCollectorsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for putApplicationV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiPutApplicationV1Request + */ +export interface DataAccessSecurityV1ApiPutApplicationV1Request { + /** + * The unique identifier of the application to update. + * @type {number} + * @memberof DataAccessSecurityV1ApiPutApplicationV1 + */ + readonly id: number + + /** + * Request body containing the updated details for the application. + * @type {BasecreateapplicationrequestV1} + * @memberof DataAccessSecurityV1ApiPutApplicationV1 + */ + readonly basecreateapplicationrequestV1: BasecreateapplicationrequestV1 +} + +/** + * Request parameters for putIdentityCollectorV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiPutIdentityCollectorV1Request + */ +export interface DataAccessSecurityV1ApiPutIdentityCollectorV1Request { + /** + * The unique identifier of the identity collector to update. + * @type {number} + * @memberof DataAccessSecurityV1ApiPutIdentityCollectorV1 + */ + readonly id: number + + /** + * Request body containing the updated details for the identity collector. + * @type {UpdateidentitycollectorrequestV1} + * @memberof DataAccessSecurityV1ApiPutIdentityCollectorV1 + */ + readonly updateidentitycollectorrequestV1: UpdateidentitycollectorrequestV1 +} + +/** + * Request parameters for putScheduleV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiPutScheduleV1Request + */ +export interface DataAccessSecurityV1ApiPutScheduleV1Request { + /** + * The unique identifier of the schedule to update. + * @type {number} + * @memberof DataAccessSecurityV1ApiPutScheduleV1 + */ + readonly id: number + + /** + * + * @type {UpdateschedulerequestV1} + * @memberof DataAccessSecurityV1ApiPutScheduleV1 + */ + readonly updateschedulerequestV1: UpdateschedulerequestV1 +} + +/** + * Request parameters for startTaskRerunV1 operation in DataAccessSecurityV1Api. + * @export + * @interface DataAccessSecurityV1ApiStartTaskRerunV1Request + */ +export interface DataAccessSecurityV1ApiStartTaskRerunV1Request { + /** + * The unique identifier of the task to rerun. + * @type {number} + * @memberof DataAccessSecurityV1ApiStartTaskRerunV1 + */ + readonly id: number +} + +/** + * DataAccessSecurityV1Api - object-oriented interface + * @export + * @class DataAccessSecurityV1Api + * @extends {BaseAPI} + */ +export class DataAccessSecurityV1Api extends BaseAPI { + /** + * This end-point sends a request to cancel a task in Data Access Security. + * @summary Cancel a DAS task. + * @param {DataAccessSecurityV1ApiCancelTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public cancelTaskV1(requestParameters: DataAccessSecurityV1ApiCancelTaskV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).cancelTaskV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint creates a new application in Data Access Security with the specified configuration. + * @summary Create application + * @param {DataAccessSecurityV1ApiCreateApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public createApplicationV1(requestParameters: DataAccessSecurityV1ApiCreateApplicationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).createApplicationV1(requestParameters.basecreateapplicationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. + * @summary Create identity collector + * @param {DataAccessSecurityV1ApiCreateIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public createIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiCreateIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).createIdentityCollectorV1(requestParameters.createidentitycollectorrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Create a new schedule. + * @param {DataAccessSecurityV1ApiCreateScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public createScheduleV1(requestParameters: DataAccessSecurityV1ApiCreateScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).createScheduleV1(requestParameters.createschedulerequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Assign owner to application resource. + * @param {DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public dasV1OwnersAssignPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).dasV1OwnersAssignPost(requestParameters.assignresourceownerrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List resources for owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public dasV1OwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV1ApiDasV1OwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).dasV1OwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Re-elect resource owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public dasV1OwnersReelectPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).dasV1OwnersReelectPost(requestParameters.reelectrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List owners for resource. + * @param {DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public dasV1OwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV1ApiDasV1OwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).dasV1OwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Reassign resource owner. + * @param {DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV1ApiDasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint deletes an application from Data Access Security by its unique identifier. + * @summary Delete an application by identifier. + * @param {DataAccessSecurityV1ApiDeleteApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public deleteApplicationV1(requestParameters: DataAccessSecurityV1ApiDeleteApplicationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).deleteApplicationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint deletes an identity collector from Data Access Security by its unique identifier. + * @summary Delete identity collector by identifier + * @param {DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public deleteIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiDeleteIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).deleteIdentityCollectorV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point sends a request to delete a schedule in Data Access Security. + * @summary Delete a DAS schedule. + * @param {DataAccessSecurityV1ApiDeleteScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public deleteScheduleV1(requestParameters: DataAccessSecurityV1ApiDeleteScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).deleteScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point sends a request to delete a task in Data Access Security. + * @summary Delete a DAS task. + * @param {DataAccessSecurityV1ApiDeleteTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public deleteTaskV1(requestParameters: DataAccessSecurityV1ApiDeleteTaskV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).deleteTaskV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. + * @summary Retrieve application details by identifier. + * @param {DataAccessSecurityV1ApiGetApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getApplicationV1(requestParameters: DataAccessSecurityV1ApiGetApplicationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getApplicationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint lists all the applications in Data Access Security with optional filtering. + * @summary Search applications in DAS. + * @param {DataAccessSecurityV1ApiGetApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getApplicationsV1(requestParameters: DataAccessSecurityV1ApiGetApplicationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getApplicationsV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Retrieve owners per application. + * @param {DataAccessSecurityV1ApiGetOwnersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getOwnersV1(requestParameters: DataAccessSecurityV1ApiGetOwnersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getOwnersV1(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point gets a schedule in Data Access Security. + * @summary Get a DAS schedule. + * @param {DataAccessSecurityV1ApiGetScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getScheduleV1(requestParameters: DataAccessSecurityV1ApiGetScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point lists all the schedules in Data Access Security. + * @summary List all schedules. + * @param {DataAccessSecurityV1ApiGetSchedulesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getSchedulesV1(requestParameters: DataAccessSecurityV1ApiGetSchedulesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getSchedulesV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point gets a task in Data Access Security. + * @summary Get a DAS task. + * @param {DataAccessSecurityV1ApiGetTaskV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getTaskV1(requestParameters: DataAccessSecurityV1ApiGetTaskV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getTaskV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point lists all the tasks in Data Access Security. + * @summary Lists all DAS tasks. + * @param {DataAccessSecurityV1ApiGetTasksV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public getTasksV1(requestParameters: DataAccessSecurityV1ApiGetTasksV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).getTasksV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error. + * @summary List identity collectors + * @param {DataAccessSecurityV1ApiListIdentityCollectorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public listIdentityCollectorsV1(requestParameters: DataAccessSecurityV1ApiListIdentityCollectorsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).listIdentityCollectorsV1(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint updates an existing application in Data Access Security with the specified configuration. + * @summary Update application by identifier. + * @param {DataAccessSecurityV1ApiPutApplicationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public putApplicationV1(requestParameters: DataAccessSecurityV1ApiPutApplicationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).putApplicationV1(requestParameters.id, requestParameters.basecreateapplicationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint updates the name of an existing identity collector in Data Access Security. The `sourceId` and `type` cannot be changed and must match the current values. + * @summary Update identity collector by identifier + * @param {DataAccessSecurityV1ApiPutIdentityCollectorV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public putIdentityCollectorV1(requestParameters: DataAccessSecurityV1ApiPutIdentityCollectorV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).putIdentityCollectorV1(requestParameters.id, requestParameters.updateidentitycollectorrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Update a schedule. + * @param {DataAccessSecurityV1ApiPutScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public putScheduleV1(requestParameters: DataAccessSecurityV1ApiPutScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).putScheduleV1(requestParameters.id, requestParameters.updateschedulerequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point sends a request to re-run a task in Data Access Security. + * @summary Rerun a DAS task. + * @param {DataAccessSecurityV1ApiStartTaskRerunV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataAccessSecurityV1Api + */ + public startTaskRerunV1(requestParameters: DataAccessSecurityV1ApiStartTaskRerunV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataAccessSecurityV1ApiFp(this.configuration).startTaskRerunV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/data_access_security/base.ts b/sdk-output/data_access_security/base.ts new file mode 100644 index 00000000..16325aeb --- /dev/null +++ b/sdk-output/data_access_security/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Access Security + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/data_access_security/common.ts b/sdk-output/data_access_security/common.ts new file mode 100644 index 00000000..6847d6c8 --- /dev/null +++ b/sdk-output/data_access_security/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Access Security + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/data_access_security/configuration.ts b/sdk-output/data_access_security/configuration.ts new file mode 100644 index 00000000..5e4f6224 --- /dev/null +++ b/sdk-output/data_access_security/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Access Security + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/data_access_security/git_push.sh b/sdk-output/data_access_security/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/data_access_security/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/data_access_security/index.ts b/sdk-output/data_access_security/index.ts new file mode 100644 index 00000000..6eef830f --- /dev/null +++ b/sdk-output/data_access_security/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Access Security + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/data_access_security/package.json b/sdk-output/data_access_security/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/data_access_security/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/data_access_security/tsconfig.json b/sdk-output/data_access_security/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/data_access_security/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/data_segmentation/.gitignore b/sdk-output/data_segmentation/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/data_segmentation/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/data_segmentation/.npmignore b/sdk-output/data_segmentation/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/data_segmentation/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/data_segmentation/.openapi-generator-ignore b/sdk-output/data_segmentation/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/data_segmentation/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/data_segmentation/.openapi-generator/FILES b/sdk-output/data_segmentation/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/data_segmentation/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/data_segmentation/.openapi-generator/VERSION b/sdk-output/data_segmentation/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/data_segmentation/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/data_segmentation/.sdk-partition b/sdk-output/data_segmentation/.sdk-partition new file mode 100644 index 00000000..34d783c9 --- /dev/null +++ b/sdk-output/data_segmentation/.sdk-partition @@ -0,0 +1 @@ +data-segmentation \ No newline at end of file diff --git a/sdk-output/data_segmentation/README.md b/sdk-output/data_segmentation/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/data_segmentation/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/data_segmentation/api.ts b/sdk-output/data_segmentation/api.ts new file mode 100644 index 00000000..2766bd46 --- /dev/null +++ b/sdk-output/data_segmentation/api.ts @@ -0,0 +1,1426 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Segmentation + * 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 DataSegmentV1 + */ +export interface DataSegmentV1 { + /** + * The segment\'s ID. + * @type {string} + * @memberof DataSegmentV1 + */ + 'id'?: string; + /** + * The segment\'s business name. + * @type {string} + * @memberof DataSegmentV1 + */ + 'name'?: string; + /** + * The time when the segment is created. + * @type {string} + * @memberof DataSegmentV1 + */ + 'created'?: string; + /** + * The time when the segment is modified. + * @type {string} + * @memberof DataSegmentV1 + */ + 'modified'?: string; + /** + * The segment\'s optional description. + * @type {string} + * @memberof DataSegmentV1 + */ + 'description'?: string; + /** + * List of Scopes that are assigned to the segment + * @type {Array} + * @memberof DataSegmentV1 + */ + 'scopes'?: Array; + /** + * List of Identities that are assigned to the segment + * @type {Array} + * @memberof DataSegmentV1 + */ + 'memberSelection'?: Array; + /** + * + * @type {VisibilitycriteriaV1} + * @memberof DataSegmentV1 + */ + 'memberFilter'?: VisibilitycriteriaV1; + /** + * + * @type {MembershiptypeV1} + * @memberof DataSegmentV1 + */ + 'membership'?: MembershiptypeV1; + /** + * This boolean indicates whether the segment is currently active. Inactive segments have no effect. + * @type {boolean} + * @memberof DataSegmentV1 + */ + 'enabled'?: boolean; + /** + * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published + * @type {boolean} + * @memberof DataSegmentV1 + */ + 'published'?: boolean; +} + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ExpressionChildrenInnerV1 + */ +export interface ExpressionChildrenInnerV1 { + /** + * Operator for the expression + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'operator'?: ExpressionChildrenInnerV1OperatorV1; + /** + * Name for the attribute + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'attribute'?: string | null; + /** + * + * @type {ValueV1} + * @memberof ExpressionChildrenInnerV1 + */ + 'value'?: ValueV1 | null; + /** + * There cannot be anymore nested children. This will always be null. + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'children'?: string | null; +} + +export const ExpressionChildrenInnerV1OperatorV1 = { + And: 'AND', + Equals: 'EQUALS' +} as const; + +export type ExpressionChildrenInnerV1OperatorV1 = typeof ExpressionChildrenInnerV1OperatorV1[keyof typeof ExpressionChildrenInnerV1OperatorV1]; + +/** + * + * @export + * @interface ExpressionV1 + */ +export interface ExpressionV1 { + /** + * Operator for the expression + * @type {string} + * @memberof ExpressionV1 + */ + 'operator'?: ExpressionV1OperatorV1; + /** + * Name for the attribute + * @type {string} + * @memberof ExpressionV1 + */ + 'attribute'?: string | null; + /** + * + * @type {ValueV1} + * @memberof ExpressionV1 + */ + 'value'?: ValueV1 | null; + /** + * List of expressions + * @type {Array} + * @memberof ExpressionV1 + */ + 'children'?: Array | null; +} + +export const ExpressionV1OperatorV1 = { + And: 'AND', + Equals: 'EQUALS' +} as const; + +export type ExpressionV1OperatorV1 = typeof ExpressionV1OperatorV1[keyof typeof ExpressionV1OperatorV1]; + +/** + * + * @export + * @interface GetDataSegmentIdentityMembershipV1401ResponseV1 + */ +export interface GetDataSegmentIdentityMembershipV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetDataSegmentIdentityMembershipV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetDataSegmentIdentityMembershipV1429ResponseV1 + */ +export interface GetDataSegmentIdentityMembershipV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetDataSegmentIdentityMembershipV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * An enumeration of the types of membership choices + * @export + * @enum {string} + */ + +export const MembershiptypeV1 = { + All: 'ALL', + Filter: 'FILTER', + Selection: 'SELECTION' +} as const; + +export type MembershiptypeV1 = typeof MembershiptypeV1[keyof typeof MembershiptypeV1]; + + +/** + * + * @export + * @interface RefV1 + */ +export interface RefV1 { + /** + * + * @type {DtotypeV1} + * @memberof RefV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof RefV1 + */ + 'id'?: string; +} + + +/** + * This defines what access the segment is giving + * @export + * @interface ScopeV1 + */ +export interface ScopeV1 { + /** + * + * @type {ScopetypeV1} + * @memberof ScopeV1 + */ + 'scope'?: ScopetypeV1; + /** + * + * @type {ScopevisibilitytypeV1} + * @memberof ScopeV1 + */ + 'visibility'?: ScopevisibilitytypeV1; + /** + * + * @type {VisibilitycriteriaV1} + * @memberof ScopeV1 + */ + 'scopeFilter'?: VisibilitycriteriaV1; + /** + * List of Identities that are assigned to the segment + * @type {Array} + * @memberof ScopeV1 + */ + 'scopeSelection'?: Array; +} + + +/** + * An enumeration of the types of scope choices + * @export + * @enum {string} + */ + +export const ScopetypeV1 = { + Entitlement: 'ENTITLEMENT', + Certification: 'CERTIFICATION', + Identity: 'IDENTITY', + Entitlementrequest: 'ENTITLEMENTREQUEST' +} as const; + +export type ScopetypeV1 = typeof ScopetypeV1[keyof typeof ScopetypeV1]; + + +/** + * An enumeration of the types of scope visibility choices + * @export + * @enum {string} + */ + +export const ScopevisibilitytypeV1 = { + All: 'ALL', + Filter: 'FILTER', + Selection: 'SELECTION', + Unsegmented: 'UNSEGMENTED' +} as const; + +export type ScopevisibilitytypeV1 = typeof ScopevisibilitytypeV1[keyof typeof ScopevisibilitytypeV1]; + + +/** + * Contains the segments and types that an identity is associated with + * @export + * @interface SegmentmembershipV1 + */ +export interface SegmentmembershipV1 { + /** + * List of segment ids that the identity is associated with. + * @type {Array} + * @memberof SegmentmembershipV1 + */ + 'segments'?: Array; + /** + * They type of scopes that are assigned to the identity. + * @type {Array} + * @memberof SegmentmembershipV1 + */ + 'allAccessScopes'?: Array; + /** + * Date time string that lets you know when the membership data is going to be refreshed. + * @type {string} + * @memberof SegmentmembershipV1 + */ + 'refreshBy'?: string; +} +/** + * + * @export + * @interface ValueV1 + */ +export interface ValueV1 { + /** + * The type of attribute value + * @type {string} + * @memberof ValueV1 + */ + 'type'?: string; + /** + * The attribute value + * @type {string} + * @memberof ValueV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface VisibilitycriteriaV1 + */ +export interface VisibilitycriteriaV1 { + /** + * + * @type {ExpressionV1} + * @memberof VisibilitycriteriaV1 + */ + 'expression'?: ExpressionV1; +} + +/** + * DataSegmentationV1Api - axios parameter creator + * @export + */ +export const DataSegmentationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {DataSegmentV1} dataSegmentV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDataSegmentV1: async (dataSegmentV1: DataSegmentV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dataSegmentV1' is not null or undefined + assertParamExists('createDataSegmentV1', 'dataSegmentV1', dataSegmentV1) + const localVarPath = `/data-segments/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(dataSegmentV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes the segment specified by the given ID. + * @summary Delete segment by id + * @param {string} segmentId The segment ID to delete. + * @param {boolean} [published] This determines which version of the segment to delete + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDataSegmentV1: async (segmentId: string, published?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'segmentId' is not null or undefined + assertParamExists('deleteDataSegmentV1', 'segmentId', segmentId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/{segmentId}` + .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId))); + // 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; + + if (published !== undefined) { + localVarQueryParameter['published'] = published; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the segment membership specified by the given identity ID. + * @summary Get segmentmembership by identity id + * @param {string} identityId The identity ID to retrieve the segments they are in. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentIdentityMembershipV1: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getDataSegmentIdentityMembershipV1', 'identityId', identityId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/membership/{identityId}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {string} segmentId The segment ID to retrieve. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentV1: async (segmentId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'segmentId' is not null or undefined + assertParamExists('getDataSegmentV1', 'segmentId', segmentId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/{segmentId}` + .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns whether or not segmentation is enabled for the identity. + * @summary Is segmentation enabled by identity + * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentationEnabledForUserV1: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getDataSegmentationEnabledForUserV1', 'identityId', identityId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/user-enabled/{identityId}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segments + * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. + * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. + * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, sw* **name**: *eq, in, sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDataSegmentsV1: async (enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/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 (enabled !== undefined) { + localVarQueryParameter['enabled'] = enabled; + } + + if (unique !== undefined) { + localVarQueryParameter['unique'] = unique; + } + + if (published !== undefined) { + localVarQueryParameter['published'] = published; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update segment + * @param {string} segmentId The segment ID to modify. + * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchDataSegmentV1: async (segmentId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'segmentId' is not null or undefined + assertParamExists('patchDataSegmentV1', 'segmentId', segmentId) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('patchDataSegmentV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/{segmentId}` + .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This will publish the segment so that it starts applying the segmentation to the desired users if enabled + * @summary Publish segment by id + * @param {string} segmentId The segmentId. + * @param {Array} requestBody A list of segment ids that you wish to publish + * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + publishDataSegmentV1: async (segmentId: string, requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'segmentId' is not null or undefined + assertParamExists('publishDataSegmentV1', 'segmentId', segmentId) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('publishDataSegmentV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/data-segments/v1/{segmentId}` + .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId))); + // 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; + + if (publishAll !== undefined) { + localVarQueryParameter['publishAll'] = publishAll; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * DataSegmentationV1Api - functional programming interface + * @export + */ +export const DataSegmentationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DataSegmentationV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {DataSegmentV1} dataSegmentV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createDataSegmentV1(dataSegmentV1: DataSegmentV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDataSegmentV1(dataSegmentV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.createDataSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes the segment specified by the given ID. + * @summary Delete segment by id + * @param {string} segmentId The segment ID to delete. + * @param {boolean} [published] This determines which version of the segment to delete + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteDataSegmentV1(segmentId: string, published?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDataSegmentV1(segmentId, published, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.deleteDataSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the segment membership specified by the given identity ID. + * @summary Get segmentmembership by identity id + * @param {string} identityId The identity ID to retrieve the segments they are in. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDataSegmentIdentityMembershipV1(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentIdentityMembershipV1(identityId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.getDataSegmentIdentityMembershipV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {string} segmentId The segment ID to retrieve. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDataSegmentV1(segmentId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentV1(segmentId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.getDataSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns whether or not segmentation is enabled for the identity. + * @summary Is segmentation enabled by identity + * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDataSegmentationEnabledForUserV1(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentationEnabledForUserV1(identityId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.getDataSegmentationEnabledForUserV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segments + * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. + * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. + * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, sw* **name**: *eq, in, sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listDataSegmentsV1(enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDataSegmentsV1(enabled, unique, published, limit, offset, count, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.listDataSegmentsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update segment + * @param {string} segmentId The segment ID to modify. + * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchDataSegmentV1(segmentId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchDataSegmentV1(segmentId, requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.patchDataSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This will publish the segment so that it starts applying the segmentation to the desired users if enabled + * @summary Publish segment by id + * @param {string} segmentId The segmentId. + * @param {Array} requestBody A list of segment ids that you wish to publish + * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async publishDataSegmentV1(segmentId: string, requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishDataSegmentV1(segmentId, requestBody, publishAll, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DataSegmentationV1Api.publishDataSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DataSegmentationV1Api - factory interface + * @export + */ +export const DataSegmentationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DataSegmentationV1ApiFp(configuration) + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {DataSegmentationV1ApiCreateDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDataSegmentV1(requestParameters: DataSegmentationV1ApiCreateDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDataSegmentV1(requestParameters.dataSegmentV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes the segment specified by the given ID. + * @summary Delete segment by id + * @param {DataSegmentationV1ApiDeleteDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDataSegmentV1(requestParameters: DataSegmentationV1ApiDeleteDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteDataSegmentV1(requestParameters.segmentId, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the segment membership specified by the given identity ID. + * @summary Get segmentmembership by identity id + * @param {DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentIdentityMembershipV1(requestParameters: DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getDataSegmentIdentityMembershipV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {DataSegmentationV1ApiGetDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentV1(requestParameters: DataSegmentationV1ApiGetDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDataSegmentV1(requestParameters.segmentId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns whether or not segmentation is enabled for the identity. + * @summary Is segmentation enabled by identity + * @param {DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDataSegmentationEnabledForUserV1(requestParameters: DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDataSegmentationEnabledForUserV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segments + * @param {DataSegmentationV1ApiListDataSegmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDataSegmentsV1(requestParameters: DataSegmentationV1ApiListDataSegmentsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listDataSegmentsV1(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update segment + * @param {DataSegmentationV1ApiPatchDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchDataSegmentV1(requestParameters: DataSegmentationV1ApiPatchDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchDataSegmentV1(requestParameters.segmentId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This will publish the segment so that it starts applying the segmentation to the desired users if enabled + * @summary Publish segment by id + * @param {DataSegmentationV1ApiPublishDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + publishDataSegmentV1(requestParameters: DataSegmentationV1ApiPublishDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.publishDataSegmentV1(requestParameters.segmentId, requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDataSegmentV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiCreateDataSegmentV1Request + */ +export interface DataSegmentationV1ApiCreateDataSegmentV1Request { + /** + * + * @type {DataSegmentV1} + * @memberof DataSegmentationV1ApiCreateDataSegmentV1 + */ + readonly dataSegmentV1: DataSegmentV1 +} + +/** + * Request parameters for deleteDataSegmentV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiDeleteDataSegmentV1Request + */ +export interface DataSegmentationV1ApiDeleteDataSegmentV1Request { + /** + * The segment ID to delete. + * @type {string} + * @memberof DataSegmentationV1ApiDeleteDataSegmentV1 + */ + readonly segmentId: string + + /** + * This determines which version of the segment to delete + * @type {boolean} + * @memberof DataSegmentationV1ApiDeleteDataSegmentV1 + */ + readonly published?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiDeleteDataSegmentV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getDataSegmentIdentityMembershipV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request + */ +export interface DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request { + /** + * The identity ID to retrieve the segments they are in. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1 + */ + readonly identityId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getDataSegmentV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiGetDataSegmentV1Request + */ +export interface DataSegmentationV1ApiGetDataSegmentV1Request { + /** + * The segment ID to retrieve. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentV1 + */ + readonly segmentId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getDataSegmentationEnabledForUserV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request + */ +export interface DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request { + /** + * The identity ID to retrieve if segmentation is enabled for the identity. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1 + */ + readonly identityId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listDataSegmentsV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiListDataSegmentsV1Request + */ +export interface DataSegmentationV1ApiListDataSegmentsV1Request { + /** + * This boolean indicates whether the segment is currently active. Inactive segments have no effect. + * @type {boolean} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly enabled?: boolean + + /** + * This returns only one record if set to true and that would be the published record if exists. + * @type {boolean} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly unique?: boolean + + /** + * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published + * @type {boolean} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly published?: boolean + + /** + * 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 DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + 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, in, sw* **name**: *eq, in, sw* + * @type {string} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiListDataSegmentsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchDataSegmentV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiPatchDataSegmentV1Request + */ +export interface DataSegmentationV1ApiPatchDataSegmentV1Request { + /** + * The segment ID to modify. + * @type {string} + * @memberof DataSegmentationV1ApiPatchDataSegmentV1 + */ + readonly segmentId: string + + /** + * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + * @type {Array} + * @memberof DataSegmentationV1ApiPatchDataSegmentV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiPatchDataSegmentV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for publishDataSegmentV1 operation in DataSegmentationV1Api. + * @export + * @interface DataSegmentationV1ApiPublishDataSegmentV1Request + */ +export interface DataSegmentationV1ApiPublishDataSegmentV1Request { + /** + * The segmentId. + * @type {string} + * @memberof DataSegmentationV1ApiPublishDataSegmentV1 + */ + readonly segmentId: string + + /** + * A list of segment ids that you wish to publish + * @type {Array} + * @memberof DataSegmentationV1ApiPublishDataSegmentV1 + */ + readonly requestBody: Array + + /** + * This flag decides whether you want to publish all unpublished or a list of specific segment ids + * @type {boolean} + * @memberof DataSegmentationV1ApiPublishDataSegmentV1 + */ + readonly publishAll?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof DataSegmentationV1ApiPublishDataSegmentV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * DataSegmentationV1Api - object-oriented interface + * @export + * @class DataSegmentationV1Api + * @extends {BaseAPI} + */ +export class DataSegmentationV1Api extends BaseAPI { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {DataSegmentationV1ApiCreateDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public createDataSegmentV1(requestParameters: DataSegmentationV1ApiCreateDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).createDataSegmentV1(requestParameters.dataSegmentV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes the segment specified by the given ID. + * @summary Delete segment by id + * @param {DataSegmentationV1ApiDeleteDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public deleteDataSegmentV1(requestParameters: DataSegmentationV1ApiDeleteDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).deleteDataSegmentV1(requestParameters.segmentId, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the segment membership specified by the given identity ID. + * @summary Get segmentmembership by identity id + * @param {DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public getDataSegmentIdentityMembershipV1(requestParameters: DataSegmentationV1ApiGetDataSegmentIdentityMembershipV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).getDataSegmentIdentityMembershipV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {DataSegmentationV1ApiGetDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public getDataSegmentV1(requestParameters: DataSegmentationV1ApiGetDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).getDataSegmentV1(requestParameters.segmentId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns whether or not segmentation is enabled for the identity. + * @summary Is segmentation enabled by identity + * @param {DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public getDataSegmentationEnabledForUserV1(requestParameters: DataSegmentationV1ApiGetDataSegmentationEnabledForUserV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).getDataSegmentationEnabledForUserV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the segment specified by the given ID. + * @summary Get segments + * @param {DataSegmentationV1ApiListDataSegmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public listDataSegmentsV1(requestParameters: DataSegmentationV1ApiListDataSegmentsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).listDataSegmentsV1(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update segment + * @param {DataSegmentationV1ApiPatchDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public patchDataSegmentV1(requestParameters: DataSegmentationV1ApiPatchDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).patchDataSegmentV1(requestParameters.segmentId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This will publish the segment so that it starts applying the segmentation to the desired users if enabled + * @summary Publish segment by id + * @param {DataSegmentationV1ApiPublishDataSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DataSegmentationV1Api + */ + public publishDataSegmentV1(requestParameters: DataSegmentationV1ApiPublishDataSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DataSegmentationV1ApiFp(this.configuration).publishDataSegmentV1(requestParameters.segmentId, requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/data_segmentation/base.ts b/sdk-output/data_segmentation/base.ts new file mode 100644 index 00000000..aae36831 --- /dev/null +++ b/sdk-output/data_segmentation/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Segmentation + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/data_segmentation/common.ts b/sdk-output/data_segmentation/common.ts new file mode 100644 index 00000000..01499fe6 --- /dev/null +++ b/sdk-output/data_segmentation/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Segmentation + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/data_segmentation/configuration.ts b/sdk-output/data_segmentation/configuration.ts new file mode 100644 index 00000000..83aeb658 --- /dev/null +++ b/sdk-output/data_segmentation/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Segmentation + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/data_segmentation/git_push.sh b/sdk-output/data_segmentation/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/data_segmentation/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/data_segmentation/index.ts b/sdk-output/data_segmentation/index.ts new file mode 100644 index 00000000..54eb0214 --- /dev/null +++ b/sdk-output/data_segmentation/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Data Segmentation + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/data_segmentation/package.json b/sdk-output/data_segmentation/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/data_segmentation/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/data_segmentation/tsconfig.json b/sdk-output/data_segmentation/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/data_segmentation/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/declassify_source/.gitignore b/sdk-output/declassify_source/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/declassify_source/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/declassify_source/.npmignore b/sdk-output/declassify_source/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/declassify_source/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/declassify_source/.openapi-generator-ignore b/sdk-output/declassify_source/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/declassify_source/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/declassify_source/.openapi-generator/FILES b/sdk-output/declassify_source/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/declassify_source/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/declassify_source/.openapi-generator/VERSION b/sdk-output/declassify_source/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/declassify_source/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/declassify_source/.sdk-partition b/sdk-output/declassify_source/.sdk-partition new file mode 100644 index 00000000..29eb9c9a --- /dev/null +++ b/sdk-output/declassify_source/.sdk-partition @@ -0,0 +1 @@ +declassify-source \ No newline at end of file diff --git a/sdk-output/declassify_source/README.md b/sdk-output/declassify_source/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/declassify_source/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/declassify_source/api.ts b/sdk-output/declassify_source/api.ts new file mode 100644 index 00000000..7b6f38c3 --- /dev/null +++ b/sdk-output/declassify_source/api.ts @@ -0,0 +1,246 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Declassify Source + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SendDeclassifyMachineAccountFromSourceV1401ResponseV1 + */ +export interface SendDeclassifyMachineAccountFromSourceV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SendDeclassifyMachineAccountFromSourceV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface SendDeclassifyMachineAccountFromSourceV1429ResponseV1 + */ +export interface SendDeclassifyMachineAccountFromSourceV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SendDeclassifyMachineAccountFromSourceV1429ResponseV1 + */ + 'message'?: any; +} + +/** + * DeclassifySourceV1Api - axios parameter creator + * @export + */ +export const DeclassifySourceV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Declassify source\'s all accounts + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendDeclassifyMachineAccountFromSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('sendDeclassifyMachineAccountFromSourceV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/declassify` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * DeclassifySourceV1Api - functional programming interface + * @export + */ +export const DeclassifySourceV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DeclassifySourceV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Declassify source\'s all accounts + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendDeclassifyMachineAccountFromSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendDeclassifyMachineAccountFromSourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DeclassifySourceV1Api.sendDeclassifyMachineAccountFromSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DeclassifySourceV1Api - factory interface + * @export + */ +export const DeclassifySourceV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DeclassifySourceV1ApiFp(configuration) + return { + /** + * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Declassify source\'s all accounts + * @param {DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendDeclassifyMachineAccountFromSourceV1(requestParameters: DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendDeclassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for sendDeclassifyMachineAccountFromSourceV1 operation in DeclassifySourceV1Api. + * @export + * @interface DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request + */ +export interface DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1 + */ + readonly sourceId: string +} + +/** + * DeclassifySourceV1Api - object-oriented interface + * @export + * @class DeclassifySourceV1Api + * @extends {BaseAPI} + */ +export class DeclassifySourceV1Api extends BaseAPI { + /** + * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Declassify source\'s all accounts + * @param {DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DeclassifySourceV1Api + */ + public sendDeclassifyMachineAccountFromSourceV1(requestParameters: DeclassifySourceV1ApiSendDeclassifyMachineAccountFromSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DeclassifySourceV1ApiFp(this.configuration).sendDeclassifyMachineAccountFromSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/declassify_source/base.ts b/sdk-output/declassify_source/base.ts new file mode 100644 index 00000000..a4e35d82 --- /dev/null +++ b/sdk-output/declassify_source/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Declassify Source + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/declassify_source/common.ts b/sdk-output/declassify_source/common.ts new file mode 100644 index 00000000..d2818246 --- /dev/null +++ b/sdk-output/declassify_source/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Declassify Source + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/declassify_source/configuration.ts b/sdk-output/declassify_source/configuration.ts new file mode 100644 index 00000000..76ac5bf2 --- /dev/null +++ b/sdk-output/declassify_source/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Declassify Source + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/declassify_source/git_push.sh b/sdk-output/declassify_source/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/declassify_source/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/declassify_source/index.ts b/sdk-output/declassify_source/index.ts new file mode 100644 index 00000000..6f494866 --- /dev/null +++ b/sdk-output/declassify_source/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Declassify Source + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/declassify_source/package.json b/sdk-output/declassify_source/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/declassify_source/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/declassify_source/tsconfig.json b/sdk-output/declassify_source/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/declassify_source/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/dimensions/.gitignore b/sdk-output/dimensions/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/dimensions/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/dimensions/.npmignore b/sdk-output/dimensions/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/dimensions/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/dimensions/.openapi-generator-ignore b/sdk-output/dimensions/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/dimensions/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/dimensions/.openapi-generator/FILES b/sdk-output/dimensions/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/dimensions/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/dimensions/.openapi-generator/VERSION b/sdk-output/dimensions/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/dimensions/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/dimensions/.sdk-partition b/sdk-output/dimensions/.sdk-partition new file mode 100644 index 00000000..5d57834d --- /dev/null +++ b/sdk-output/dimensions/.sdk-partition @@ -0,0 +1 @@ +dimensions \ No newline at end of file diff --git a/sdk-output/dimensions/README.md b/sdk-output/dimensions/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/dimensions/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/dimensions/api.ts b/sdk-output/dimensions/api.ts new file mode 100644 index 00000000..1bbcc106 --- /dev/null +++ b/sdk-output/dimensions/api.ts @@ -0,0 +1,2359 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Dimensions + * 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 AccessdurationV1 + */ +export interface AccessdurationV1 { + /** + * The numeric value representing the amount of time, which is defined in the **timeUnit**. + * @type {number} + * @memberof AccessdurationV1 + */ + 'value'?: number; + /** + * The unit of time that corresponds to the **value**. It defines the scale of the time period. + * @type {string} + * @memberof AccessdurationV1 + */ + 'timeUnit'?: AccessdurationV1TimeUnitV1; +} + +export const AccessdurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type AccessdurationV1TimeUnitV1 = typeof AccessdurationV1TimeUnitV1[keyof typeof AccessdurationV1TimeUnitV1]; + +/** + * Metadata that describes an access item + * @export + * @interface AccessmodelmetadataV1 + */ +export interface AccessmodelmetadataV1 { + /** + * Unique identifier for the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'key'?: string; + /** + * Human readable name of the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'name'?: string; + /** + * Allows selecting multiple values + * @type {boolean} + * @memberof AccessmodelmetadataV1 + */ + 'multiselect'?: boolean; + /** + * The state of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'status'?: string; + /** + * The type of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'type'?: string; + /** + * The types of objects + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'objectTypes'?: Array; + /** + * Describes the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'description'?: string; + /** + * The value to assign to the metadata item + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'values'?: Array; +} +/** + * An individual value to assign to the metadata item + * @export + * @interface AccessmodelmetadataValuesInnerV1 + */ +export interface AccessmodelmetadataValuesInnerV1 { + /** + * The value to assign to the metdata item + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'value'?: string; + /** + * Display name of the value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'name'?: string; + /** + * The status of the individual value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'status'?: string; +} +/** + * Access profile. + * @export + * @interface AccessprofileV1 + */ +export interface AccessprofileV1 { + /** + * Access profile ID. + * @type {string} + * @memberof AccessprofileV1 + */ + 'id'?: string; + /** + * Access profile name. + * @type {string} + * @memberof AccessprofileV1 + */ + 'name': string; + /** + * Access profile description. + * @type {string} + * @memberof AccessprofileV1 + */ + 'description'?: string | null; + /** + * Date and time when the access profile was created. + * @type {string} + * @memberof AccessprofileV1 + */ + 'created'?: string; + /** + * Date and time when the access profile was last modified. + * @type {string} + * @memberof AccessprofileV1 + */ + 'modified'?: string; + /** + * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. + * @type {boolean} + * @memberof AccessprofileV1 + */ + 'enabled'?: boolean; + /** + * + * @type {OwnerreferenceV1} + * @memberof AccessprofileV1 + */ + 'owner': OwnerreferenceV1 | null; + /** + * + * @type {AccessprofilesourcerefV1} + * @memberof AccessprofileV1 + */ + 'source': AccessprofilesourcerefV1; + /** + * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. + * @type {Array} + * @memberof AccessprofileV1 + */ + 'entitlements'?: Array | null; + /** + * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. + * @type {boolean} + * @memberof AccessprofileV1 + */ + 'requestable'?: boolean; + /** + * + * @type {RequestabilityV1} + * @memberof AccessprofileV1 + */ + 'accessRequestConfig'?: RequestabilityV1 | null; + /** + * + * @type {RevocabilityV1} + * @memberof AccessprofileV1 + */ + 'revocationRequestConfig'?: RevocabilityV1 | null; + /** + * List of segment IDs, if any, that the access profile is assigned to. + * @type {Array} + * @memberof AccessprofileV1 + */ + 'segments'?: Array | null; + /** + * + * @type {AttributedtolistV1} + * @memberof AccessprofileV1 + */ + 'accessModelMetadata'?: AttributedtolistV1; + /** + * + * @type {Provisioningcriterialevel1V1} + * @memberof AccessprofileV1 + */ + 'provisioningCriteria'?: Provisioningcriterialevel1V1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof AccessprofileV1 + */ + 'additionalOwners'?: Array | null; +} +/** + * + * @export + * @interface AccessprofileapprovalschemeV1 + */ +export interface AccessprofileapprovalschemeV1 { + /** + * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field + * @type {string} + * @memberof AccessprofileapprovalschemeV1 + */ + 'approverType'?: AccessprofileapprovalschemeV1ApproverTypeV1; + /** + * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. + * @type {string} + * @memberof AccessprofileapprovalschemeV1 + */ + 'approverId'?: string | null; +} + +export const AccessprofileapprovalschemeV1ApproverTypeV1 = { + AppOwner: 'APP_OWNER', + Owner: 'OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW', + AllOwners: 'ALL_OWNERS', + AdditionalOwner: 'ADDITIONAL_OWNER', + AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' +} as const; + +export type AccessprofileapprovalschemeV1ApproverTypeV1 = typeof AccessprofileapprovalschemeV1ApproverTypeV1[keyof typeof AccessprofileapprovalschemeV1ApproverTypeV1]; + +/** + * + * @export + * @interface AccessprofilerefV1 + */ +export interface AccessprofilerefV1 { + /** + * ID of the Access Profile + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'id'?: string; + /** + * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'type'?: AccessprofilerefV1TypeV1; + /** + * Human-readable display name of the Access Profile. This field is ignored on input. + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'name'?: string; +} + +export const AccessprofilerefV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE' +} as const; + +export type AccessprofilerefV1TypeV1 = typeof AccessprofilerefV1TypeV1[keyof typeof AccessprofilerefV1TypeV1]; + +/** + * + * @export + * @interface AccessprofilesourcerefV1 + */ +export interface AccessprofilesourcerefV1 { + /** + * ID of the source the access profile is associated with. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'id'?: string; + /** + * Source\'s DTO type. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'type'?: AccessprofilesourcerefV1TypeV1; + /** + * Source name. + * @type {string} + * @memberof AccessprofilesourcerefV1 + */ + 'name'?: string; +} + +export const AccessprofilesourcerefV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccessprofilesourcerefV1TypeV1 = typeof AccessprofilesourcerefV1TypeV1[keyof typeof AccessprofilesourcerefV1TypeV1]; + +/** + * Reference to an additional owner (identity or governance group). + * @export + * @interface AdditionalownerrefV1 + */ +export interface AdditionalownerrefV1 { + /** + * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'type'?: AdditionalownerrefV1TypeV1; + /** + * ID of the identity or governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'id'?: string; + /** + * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'name'?: string | null; +} + +export const AdditionalownerrefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type AdditionalownerrefV1TypeV1 = typeof AdditionalownerrefV1TypeV1[keyof typeof AdditionalownerrefV1TypeV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AttributedtoV1 + */ +export interface AttributedtoV1 { + /** + * Technical name of the Attribute. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributedtoV1 + */ + 'key'?: string; + /** + * The display name of the key. + * @type {string} + * @memberof AttributedtoV1 + */ + 'name'?: string; + /** + * Indicates whether the attribute can have multiple values. + * @type {boolean} + * @memberof AttributedtoV1 + */ + 'multiselect'?: boolean; + /** + * The status of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'status'?: string; + /** + * The type of the Attribute. This can be either \"custom\" or \"governance\". + * @type {string} + * @memberof AttributedtoV1 + */ + 'type'?: string; + /** + * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. + * @type {Array} + * @memberof AttributedtoV1 + */ + 'objectTypes'?: Array | null; + /** + * The description of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'description'?: string; + /** + * + * @type {Array} + * @memberof AttributedtoV1 + */ + 'values'?: Array | null; +} +/** + * + * @export + * @interface AttributedtolistV1 + */ +export interface AttributedtolistV1 { + /** + * + * @type {Array} + * @memberof AttributedtolistV1 + */ + 'attributes'?: Array | null; +} +/** + * + * @export + * @interface AttributevaluedtoV1 + */ +export interface AttributevaluedtoV1 { + /** + * Technical name of the Attribute value. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'value'?: string; + /** + * The display name of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'name'?: string; + /** + * The status of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'status'?: string; +} +/** + * A Dimension + * @export + * @interface DimensionV1 + */ +export interface DimensionV1 { + /** + * The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof DimensionV1 + */ + 'id'?: string; + /** + * The human-readable display name of the Dimension + * @type {string} + * @memberof DimensionV1 + */ + 'name': string; + /** + * Date the Dimension was created + * @type {string} + * @memberof DimensionV1 + */ + 'created'?: string; + /** + * Date the Dimension was last modified. + * @type {string} + * @memberof DimensionV1 + */ + 'modified'?: string; + /** + * A human-readable description of the Dimension + * @type {string} + * @memberof DimensionV1 + */ + 'description'?: string | null; + /** + * + * @type {OwnerreferenceV1} + * @memberof DimensionV1 + */ + 'owner': OwnerreferenceV1 | null; + /** + * + * @type {Array} + * @memberof DimensionV1 + */ + 'accessProfiles'?: Array | null; + /** + * + * @type {Array} + * @memberof DimensionV1 + */ + 'entitlements'?: Array; + /** + * + * @type {DimensionmembershipselectorV1} + * @memberof DimensionV1 + */ + 'membership'?: DimensionmembershipselectorV1 | null; + /** + * The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. + * @type {string} + * @memberof DimensionV1 + */ + 'parentId'?: string | null; +} +/** + * + * @export + * @interface DimensionbulkdeleterequestV1 + */ +export interface DimensionbulkdeleterequestV1 { + /** + * List of IDs of Dimensions to be deleted. + * @type {Array} + * @memberof DimensionbulkdeleterequestV1 + */ + 'dimensionIds': Array; +} +/** + * Refers to a specific Identity attribute used in Dimension membership criteria. + * @export + * @interface DimensioncriteriakeyV1 + */ +export interface DimensioncriteriakeyV1 { + /** + * + * @type {DimensioncriteriakeytypeV1} + * @memberof DimensioncriteriakeyV1 + */ + 'type': DimensioncriteriakeytypeV1; + /** + * The name of the identity attribute to which the associated criteria applies. + * @type {string} + * @memberof DimensioncriteriakeyV1 + */ + 'property': string; +} + + +/** + * Indicates whether the associated criteria represents an expression on identity attributes. + * @export + * @enum {string} + */ + +export const DimensioncriteriakeytypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type DimensioncriteriakeytypeV1 = typeof DimensioncriteriakeytypeV1[keyof typeof DimensioncriteriakeytypeV1]; + + +/** + * Defines STANDARD type Dimension membership + * @export + * @interface Dimensioncriterialevel1V1 + */ +export interface Dimensioncriterialevel1V1 { + /** + * + * @type {DimensioncriteriaoperationV1} + * @memberof Dimensioncriterialevel1V1 + */ + 'operation'?: DimensioncriteriaoperationV1; + /** + * + * @type {DimensioncriteriakeyV1} + * @memberof Dimensioncriterialevel1V1 + */ + 'key'?: DimensioncriteriakeyV1 | null; + /** + * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Dimensioncriterialevel1V1 + */ + 'stringValue'?: string | null; + /** + * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + * @type {Array} + * @memberof Dimensioncriterialevel1V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines STANDARD type Role membership + * @export + * @interface Dimensioncriterialevel2V1 + */ +export interface Dimensioncriterialevel2V1 { + /** + * + * @type {DimensioncriteriaoperationV1} + * @memberof Dimensioncriterialevel2V1 + */ + 'operation'?: DimensioncriteriaoperationV1; + /** + * + * @type {DimensioncriteriakeyV1} + * @memberof Dimensioncriterialevel2V1 + */ + 'key'?: DimensioncriteriakeyV1 | null; + /** + * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Dimensioncriterialevel2V1 + */ + 'stringValue'?: string | null; + /** + * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + * @type {Array} + * @memberof Dimensioncriterialevel2V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines STANDARD type Dimension membership + * @export + * @interface Dimensioncriterialevel3V1 + */ +export interface Dimensioncriterialevel3V1 { + /** + * + * @type {DimensioncriteriaoperationV1} + * @memberof Dimensioncriterialevel3V1 + */ + 'operation'?: DimensioncriteriaoperationV1; + /** + * + * @type {DimensioncriteriakeyV1} + * @memberof Dimensioncriterialevel3V1 + */ + 'key'?: DimensioncriteriakeyV1 | null; + /** + * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Dimensioncriterialevel3V1 + */ + 'stringValue'?: string; +} + + +/** + * An operation + * @export + * @enum {string} + */ + +export const DimensioncriteriaoperationV1 = { + Equals: 'EQUALS', + And: 'AND', + Or: 'OR' +} as const; + +export type DimensioncriteriaoperationV1 = typeof DimensioncriteriaoperationV1[keyof typeof DimensioncriteriaoperationV1]; + + +/** + * When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. + * @export + * @interface DimensionmembershipselectorV1 + */ +export interface DimensionmembershipselectorV1 { + /** + * + * @type {DimensionmembershipselectortypeV1} + * @memberof DimensionmembershipselectorV1 + */ + 'type'?: DimensionmembershipselectortypeV1; + /** + * + * @type {Dimensioncriterialevel1V1} + * @memberof DimensionmembershipselectorV1 + */ + 'criteria'?: Dimensioncriterialevel1V1 | null; +} + + +/** + * This enum characterizes the type of a Dimension\'s membership selector. Only the STANDARD type supported: STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression + * @export + * @enum {string} + */ + +export const DimensionmembershipselectortypeV1 = { + Standard: 'STANDARD' +} as const; + +export type DimensionmembershipselectortypeV1 = typeof DimensionmembershipselectortypeV1[keyof typeof DimensionmembershipselectortypeV1]; + + +/** + * Additional data to classify the entitlement + * @export + * @interface EntitlementAccessModelMetadataV1 + */ +export interface EntitlementAccessModelMetadataV1 { + /** + * + * @type {Array} + * @memberof EntitlementAccessModelMetadataV1 + */ + 'attributes'?: Array; +} +/** + * The identity that owns the entitlement + * @export + * @interface EntitlementOwnerV1 + */ +export interface EntitlementOwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'id'?: string; + /** + * The type of object + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'type'?: EntitlementOwnerV1TypeV1; + /** + * The display name of the identity + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'name'?: string; +} + +export const EntitlementOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type EntitlementOwnerV1TypeV1 = typeof EntitlementOwnerV1TypeV1[keyof typeof EntitlementOwnerV1TypeV1]; + +/** + * + * @export + * @interface EntitlementSourceV1 + */ +export interface EntitlementSourceV1 { + /** + * The source ID + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV1 + */ +export interface EntitlementV1 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV1 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV1 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'description'?: string | null; + /** + * True if the entitlement is privileged + * @type {boolean} + * @memberof EntitlementV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV1 + */ + 'requestable'?: boolean; + /** + * + * @type {EntitlementOwnerV1} + * @memberof EntitlementV1 + */ + 'owner'?: EntitlementOwnerV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof EntitlementV1 + */ + 'additionalOwners'?: Array | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {EntitlementAccessModelMetadataV1} + * @memberof EntitlementV1 + */ + 'accessModelMetadata'?: EntitlementAccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV1 + */ + 'modified'?: string; + /** + * + * @type {EntitlementSourceV1} + * @memberof EntitlementV1 + */ + 'source'?: EntitlementSourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV1 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV1 + */ + 'directPermissions'?: Array; +} +/** + * Entitlement including a specific set of access. + * @export + * @interface EntitlementrefV1 + */ +export interface EntitlementrefV1 { + /** + * Entitlement\'s DTO type. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'type'?: EntitlementrefV1TypeV1; + /** + * Entitlement\'s ID. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'id'?: string; + /** + * Entitlement\'s display name. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'name'?: string | null; +} + +export const EntitlementrefV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type EntitlementrefV1TypeV1 = typeof EntitlementrefV1TypeV1[keyof typeof EntitlementrefV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListDimensionsV1401ResponseV1 + */ +export interface ListDimensionsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListDimensionsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListDimensionsV1429ResponseV1 + */ +export interface ListDimensionsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListDimensionsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner of the object. + * @export + * @interface OwnerreferenceV1 + */ +export interface OwnerreferenceV1 { + /** + * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'type'?: OwnerreferenceV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'id'?: string; + /** + * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'name'?: string; +} + +export const OwnerreferenceV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerreferenceV1TypeV1 = typeof OwnerreferenceV1TypeV1[keyof typeof OwnerreferenceV1TypeV1]; + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel1V1 + */ +export interface Provisioningcriterialevel1V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel1V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel1V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel1V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {Array} + * @memberof Provisioningcriterialevel1V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel2V1 + */ +export interface Provisioningcriterialevel2V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel2V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel2V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel2V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {Array} + * @memberof Provisioningcriterialevel2V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines matching criteria for an account to be provisioned with a specific access profile. + * @export + * @interface Provisioningcriterialevel3V1 + */ +export interface Provisioningcriterialevel3V1 { + /** + * + * @type {ProvisioningcriteriaoperationV1} + * @memberof Provisioningcriterialevel3V1 + */ + 'operation'?: ProvisioningcriteriaoperationV1; + /** + * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'attribute'?: string | null; + /** + * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'value'?: string | null; + /** + * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. + * @type {string} + * @memberof Provisioningcriterialevel3V1 + */ + 'children'?: string | null; +} + + +/** + * Supported operations on `ProvisioningCriteria`. + * @export + * @enum {string} + */ + +export const ProvisioningcriteriaoperationV1 = { + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + Contains: 'CONTAINS', + Has: 'HAS', + And: 'AND', + Or: 'OR' +} as const; + +export type ProvisioningcriteriaoperationV1 = typeof ProvisioningcriteriaoperationV1[keyof typeof ProvisioningcriteriaoperationV1]; + + +/** + * + * @export + * @interface RequestabilityV1 + */ +export interface RequestabilityV1 { + /** + * Indicates whether the requester of the containing object must provide comments justifying the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'commentsRequired'?: boolean | null; + /** + * Indicates whether an approver must provide comments when denying the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'denialCommentsRequired'?: boolean | null; + /** + * Indicates whether reauthorization is required for the request. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'reauthorizationRequired'?: boolean | null; + /** + * Indicates whether the requester of the containing object must provide access end date. + * @type {boolean} + * @memberof RequestabilityV1 + */ + 'requireEndDate'?: boolean | null; + /** + * + * @type {AccessdurationV1} + * @memberof RequestabilityV1 + */ + 'maxPermittedAccessDuration'?: AccessdurationV1 | null; + /** + * List describing the steps involved in approving the request. + * @type {Array} + * @memberof RequestabilityV1 + */ + 'approvalSchemes'?: Array | null; +} +/** + * + * @export + * @interface RevocabilityV1 + */ +export interface RevocabilityV1 { + /** + * List describing the steps involved in approving the revocation request. + * @type {Array} + * @memberof RevocabilityV1 + */ + 'approvalSchemes'?: Array | null; +} +/** + * Task result. + * @export + * @interface TaskresultdtoV1 + */ +export interface TaskresultdtoV1 { + /** + * Task result DTO type. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'type'?: TaskresultdtoV1TypeV1; + /** + * Task result ID. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'id'?: string; + /** + * Task result display name. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'name'?: string | null; +} + +export const TaskresultdtoV1TypeV1 = { + TaskResult: 'TASK_RESULT' +} as const; + +export type TaskresultdtoV1TypeV1 = typeof TaskresultdtoV1TypeV1[keyof typeof TaskresultdtoV1TypeV1]; + + +/** + * DimensionsV1Api - axios parameter creator + * @export + */ +export const DimensionsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. + * @summary Create a dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {DimensionV1} dimensionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDimensionV1: async (roleId: string, dimensionV1: DimensionV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('createDimensionV1', 'roleId', roleId) + // verify required parameter 'dimensionV1' is not null or undefined + assertParamExists('createDimensionV1', 'dimensionV1', dimensionV1) + const localVarPath = `/roles/v1/{roleId}/dimensions` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); + // 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(dimensionV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete dimension(s) + * @param {string} roleId Parent Role Id of the dimensions. + * @param {DimensionbulkdeleterequestV1} dimensionbulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBulkDimensionsV1: async (roleId: string, dimensionbulkdeleterequestV1: DimensionbulkdeleterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('deleteBulkDimensionsV1', 'roleId', roleId) + // verify required parameter 'dimensionbulkdeleterequestV1' is not null or undefined + assertParamExists('deleteBulkDimensionsV1', 'dimensionbulkdeleterequestV1', dimensionbulkdeleterequestV1) + const localVarPath = `/roles/v1/{roleId}/dimensions/bulk-delete` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); + // 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(dimensionbulkdeleterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDimensionV1: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('deleteDimensionV1', 'roleId', roleId) + // verify required parameter 'dimensionId' is not null or undefined + assertParamExists('deleteDimensionV1', 'dimensionId', dimensionId) + const localVarPath = `/roles/v1/{roleId}/dimensions/{dimensionId}` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) + .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimension\'s entitlements + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, attribute, value, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDimensionEntitlementsV1: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('getDimensionEntitlementsV1', 'roleId', roleId) + // verify required parameter 'dimensionId' is not null or undefined + assertParamExists('getDimensionEntitlementsV1', 'dimensionId', dimensionId) + const localVarPath = `/roles/v1/{roleId}/dimensions/{dimensionId}/entitlements` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) + .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a dimension under role. + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDimensionV1: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('getDimensionV1', 'roleId', roleId) + // verify required parameter 'dimensionId' is not null or undefined + assertParamExists('getDimensionV1', 'dimensionId', dimensionId) + const localVarPath = `/roles/v1/{roleId}/dimensions/{dimensionId}` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) + .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary List dimension\'s access profiles + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDimensionAccessProfilesV1: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('listDimensionAccessProfilesV1', 'roleId', roleId) + // verify required parameter 'dimensionId' is not null or undefined + assertParamExists('listDimensionAccessProfilesV1', 'dimensionId', dimensionId) + const localVarPath = `/roles/v1/{roleId}/dimensions/{dimensionId}/access-profiles` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) + .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimensions + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + * @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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDimensionsV1: async (roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('listDimensionsV1', 'roleId', roleId) + const localVarPath = `/roles/v1/{roleId}/dimensions` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); + // 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 (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchDimensionV1: async (roleId: string, dimensionId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleId' is not null or undefined + assertParamExists('patchDimensionV1', 'roleId', roleId) + // verify required parameter 'dimensionId' is not null or undefined + assertParamExists('patchDimensionV1', 'dimensionId', dimensionId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchDimensionV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/roles/v1/{roleId}/dimensions/{dimensionId}` + .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) + .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * DimensionsV1Api - functional programming interface + * @export + */ +export const DimensionsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DimensionsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. + * @summary Create a dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {DimensionV1} dimensionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createDimensionV1(roleId: string, dimensionV1: DimensionV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDimensionV1(roleId, dimensionV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.createDimensionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete dimension(s) + * @param {string} roleId Parent Role Id of the dimensions. + * @param {DimensionbulkdeleterequestV1} dimensionbulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteBulkDimensionsV1(roleId: string, dimensionbulkdeleterequestV1: DimensionbulkdeleterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkDimensionsV1(roleId, dimensionbulkdeleterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.deleteBulkDimensionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteDimensionV1(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDimensionV1(roleId, dimensionId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.deleteDimensionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimension\'s entitlements + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, attribute, value, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDimensionEntitlementsV1(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDimensionEntitlementsV1(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.getDimensionEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a dimension under role. + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDimensionV1(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDimensionV1(roleId, dimensionId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.getDimensionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary List dimension\'s access profiles + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listDimensionAccessProfilesV1(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensionAccessProfilesV1(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.listDimensionAccessProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimensions + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + * @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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listDimensionsV1(roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensionsV1(roleId, forSubadmin, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.listDimensionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified dimension + * @param {string} roleId Parent Role Id of the dimension. + * @param {string} dimensionId Id of the Dimension + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchDimensionV1(roleId: string, dimensionId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchDimensionV1(roleId, dimensionId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DimensionsV1Api.patchDimensionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DimensionsV1Api - factory interface + * @export + */ +export const DimensionsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DimensionsV1ApiFp(configuration) + return { + /** + * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. + * @summary Create a dimension + * @param {DimensionsV1ApiCreateDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDimensionV1(requestParameters: DimensionsV1ApiCreateDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDimensionV1(requestParameters.roleId, requestParameters.dimensionV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete dimension(s) + * @param {DimensionsV1ApiDeleteBulkDimensionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBulkDimensionsV1(requestParameters: DimensionsV1ApiDeleteBulkDimensionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteBulkDimensionsV1(requestParameters.roleId, requestParameters.dimensionbulkdeleterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a dimension + * @param {DimensionsV1ApiDeleteDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteDimensionV1(requestParameters: DimensionsV1ApiDeleteDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteDimensionV1(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimension\'s entitlements + * @param {DimensionsV1ApiGetDimensionEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDimensionEntitlementsV1(requestParameters: DimensionsV1ApiGetDimensionEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getDimensionEntitlementsV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a dimension under role. + * @param {DimensionsV1ApiGetDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDimensionV1(requestParameters: DimensionsV1ApiGetDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDimensionV1(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary List dimension\'s access profiles + * @param {DimensionsV1ApiListDimensionAccessProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDimensionAccessProfilesV1(requestParameters: DimensionsV1ApiListDimensionAccessProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listDimensionAccessProfilesV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimensions + * @param {DimensionsV1ApiListDimensionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listDimensionsV1(requestParameters: DimensionsV1ApiListDimensionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listDimensionsV1(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified dimension + * @param {DimensionsV1ApiPatchDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchDimensionV1(requestParameters: DimensionsV1ApiPatchDimensionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchDimensionV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDimensionV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiCreateDimensionV1Request + */ +export interface DimensionsV1ApiCreateDimensionV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiCreateDimensionV1 + */ + readonly roleId: string + + /** + * + * @type {DimensionV1} + * @memberof DimensionsV1ApiCreateDimensionV1 + */ + readonly dimensionV1: DimensionV1 +} + +/** + * Request parameters for deleteBulkDimensionsV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiDeleteBulkDimensionsV1Request + */ +export interface DimensionsV1ApiDeleteBulkDimensionsV1Request { + /** + * Parent Role Id of the dimensions. + * @type {string} + * @memberof DimensionsV1ApiDeleteBulkDimensionsV1 + */ + readonly roleId: string + + /** + * + * @type {DimensionbulkdeleterequestV1} + * @memberof DimensionsV1ApiDeleteBulkDimensionsV1 + */ + readonly dimensionbulkdeleterequestV1: DimensionbulkdeleterequestV1 +} + +/** + * Request parameters for deleteDimensionV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiDeleteDimensionV1Request + */ +export interface DimensionsV1ApiDeleteDimensionV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiDeleteDimensionV1 + */ + readonly roleId: string + + /** + * Id of the Dimension + * @type {string} + * @memberof DimensionsV1ApiDeleteDimensionV1 + */ + readonly dimensionId: string +} + +/** + * Request parameters for getDimensionEntitlementsV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiGetDimensionEntitlementsV1Request + */ +export interface DimensionsV1ApiGetDimensionEntitlementsV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + readonly roleId: string + + /** + * Id of the Dimension + * @type {string} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + readonly dimensionId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @type {string} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + 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: **name, attribute, value, created, modified** + * @type {string} + * @memberof DimensionsV1ApiGetDimensionEntitlementsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getDimensionV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiGetDimensionV1Request + */ +export interface DimensionsV1ApiGetDimensionV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiGetDimensionV1 + */ + readonly roleId: string + + /** + * Id of the Dimension + * @type {string} + * @memberof DimensionsV1ApiGetDimensionV1 + */ + readonly dimensionId: string +} + +/** + * Request parameters for listDimensionAccessProfilesV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiListDimensionAccessProfilesV1Request + */ +export interface DimensionsV1ApiListDimensionAccessProfilesV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + readonly roleId: string + + /** + * Id of the Dimension + * @type {string} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + readonly dimensionId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @type {string} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + 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: **name, created, modified** + * @type {string} + * @memberof DimensionsV1ApiListDimensionAccessProfilesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listDimensionsV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiListDimensionsV1Request + */ +export interface DimensionsV1ApiListDimensionsV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + readonly roleId: string + + /** + * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @type {string} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + readonly forSubadmin?: string + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + * @type {string} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + 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: **name, created, modified** + * @type {string} + * @memberof DimensionsV1ApiListDimensionsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchDimensionV1 operation in DimensionsV1Api. + * @export + * @interface DimensionsV1ApiPatchDimensionV1Request + */ +export interface DimensionsV1ApiPatchDimensionV1Request { + /** + * Parent Role Id of the dimension. + * @type {string} + * @memberof DimensionsV1ApiPatchDimensionV1 + */ + readonly roleId: string + + /** + * Id of the Dimension + * @type {string} + * @memberof DimensionsV1ApiPatchDimensionV1 + */ + readonly dimensionId: string + + /** + * + * @type {Array} + * @memberof DimensionsV1ApiPatchDimensionV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * DimensionsV1Api - object-oriented interface + * @export + * @class DimensionsV1Api + * @extends {BaseAPI} + */ +export class DimensionsV1Api extends BaseAPI { + /** + * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. + * @summary Create a dimension + * @param {DimensionsV1ApiCreateDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public createDimensionV1(requestParameters: DimensionsV1ApiCreateDimensionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).createDimensionV1(requestParameters.roleId, requestParameters.dimensionV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete dimension(s) + * @param {DimensionsV1ApiDeleteBulkDimensionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public deleteBulkDimensionsV1(requestParameters: DimensionsV1ApiDeleteBulkDimensionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).deleteBulkDimensionsV1(requestParameters.roleId, requestParameters.dimensionbulkdeleterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a dimension + * @param {DimensionsV1ApiDeleteDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public deleteDimensionV1(requestParameters: DimensionsV1ApiDeleteDimensionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).deleteDimensionV1(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimension\'s entitlements + * @param {DimensionsV1ApiGetDimensionEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public getDimensionEntitlementsV1(requestParameters: DimensionsV1ApiGetDimensionEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).getDimensionEntitlementsV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a dimension under role. + * @param {DimensionsV1ApiGetDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public getDimensionV1(requestParameters: DimensionsV1ApiGetDimensionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).getDimensionV1(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary List dimension\'s access profiles + * @param {DimensionsV1ApiListDimensionAccessProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public listDimensionAccessProfilesV1(requestParameters: DimensionsV1ApiListDimensionAccessProfilesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).listDimensionAccessProfilesV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List dimensions + * @param {DimensionsV1ApiListDimensionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public listDimensionsV1(requestParameters: DimensionsV1ApiListDimensionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).listDimensionsV1(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified dimension + * @param {DimensionsV1ApiPatchDimensionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof DimensionsV1Api + */ + public patchDimensionV1(requestParameters: DimensionsV1ApiPatchDimensionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return DimensionsV1ApiFp(this.configuration).patchDimensionV1(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/dimensions/base.ts b/sdk-output/dimensions/base.ts new file mode 100644 index 00000000..6964f49c --- /dev/null +++ b/sdk-output/dimensions/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Dimensions + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/dimensions/common.ts b/sdk-output/dimensions/common.ts new file mode 100644 index 00000000..a192f82f --- /dev/null +++ b/sdk-output/dimensions/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Dimensions + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/dimensions/configuration.ts b/sdk-output/dimensions/configuration.ts new file mode 100644 index 00000000..fc35c233 --- /dev/null +++ b/sdk-output/dimensions/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Dimensions + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/dimensions/git_push.sh b/sdk-output/dimensions/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/dimensions/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/dimensions/index.ts b/sdk-output/dimensions/index.ts new file mode 100644 index 00000000..f99be4ea --- /dev/null +++ b/sdk-output/dimensions/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Dimensions + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/dimensions/package.json b/sdk-output/dimensions/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/dimensions/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/dimensions/tsconfig.json b/sdk-output/dimensions/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/dimensions/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/entitlement_connections/.gitignore b/sdk-output/entitlement_connections/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/entitlement_connections/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/entitlement_connections/.npmignore b/sdk-output/entitlement_connections/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/entitlement_connections/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/entitlement_connections/.openapi-generator-ignore b/sdk-output/entitlement_connections/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/entitlement_connections/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/entitlement_connections/.openapi-generator/FILES b/sdk-output/entitlement_connections/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/entitlement_connections/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/entitlement_connections/.openapi-generator/VERSION b/sdk-output/entitlement_connections/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/entitlement_connections/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/entitlement_connections/.sdk-partition b/sdk-output/entitlement_connections/.sdk-partition new file mode 100644 index 00000000..53afc172 --- /dev/null +++ b/sdk-output/entitlement_connections/.sdk-partition @@ -0,0 +1 @@ +entitlement-connections \ No newline at end of file diff --git a/sdk-output/entitlement_connections/README.md b/sdk-output/entitlement_connections/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/entitlement_connections/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/entitlement_connections/api.ts b/sdk-output/entitlement_connections/api.ts new file mode 100644 index 00000000..336a3697 --- /dev/null +++ b/sdk-output/entitlement_connections/api.ts @@ -0,0 +1,1193 @@ +/* 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Entitlement connection entity returned by patch APIs. + * @export + * @interface EntitlementconnectionV1 + */ +export interface EntitlementconnectionV1 { + /** + * Tenant identifier that owns the connection. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'tenantId'?: string; + /** + * Entitlement connection identifier. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'connectionId'?: string; + /** + * Identity identifier associated with the connection. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'identityId'?: string; + /** + * Machine identity identifier when the connection is machine-backed. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'machineIdentityId'?: string; + /** + * Account identifier for the connected source account. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'accountId'?: string; + /** + * Entitlement identifier on the source. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'entitlementId'?: string; + /** + * Source identifier that provides the account and entitlement. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'sourceId'?: string; + /** + * Indicates whether the connection is marked as standalone. + * @type {boolean} + * @memberof EntitlementconnectionV1 + */ + 'standalone'?: boolean; + /** + * Entitlement attribute name on the source. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'attributeName'?: string; + /** + * Entitlement attribute value on the source. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'attributeValue'?: string; + /** + * Connection type classification. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'type'?: EntitlementconnectionV1TypeV1; + /** + * Current lifecycle state of the connection. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'state'?: string; + /** + * Time the connection state was last updated. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'stateChanged'?: string; + /** + * Identifier of the actor that last changed state. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'stateChangedBy'?: string; + /** + * Time JIT activation occurred. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'jitActivation'?: string; + /** + * Time provisioning completed for JIT activation. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'jitProvision'?: string; + /** + * Time JIT deactivation occurred. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'jitDeactivation'?: string; + /** + * Time deprovisioning completed after JIT deactivation. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'jitDeprovision'?: string; + /** + * Time when JIT access expires. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'jitExpiration'?: string; + /** + * Time after which the connection is eligible for deletion. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'deleteAfter'?: string; + /** + * Time when the connection was created. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'created'?: string; + /** + * Time when the connection was last modified. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'modified'?: string; + /** + * Display value for the actor associated with the latest change. + * @type {string} + * @memberof EntitlementconnectionV1 + */ + 'actorName'?: string; +} + +export const EntitlementconnectionV1TypeV1 = { + Jit: 'JIT', + Standing: 'STANDING', + Na: 'NA' +} as const; + +export type EntitlementconnectionV1TypeV1 = typeof EntitlementconnectionV1TypeV1[keyof typeof EntitlementconnectionV1TypeV1]; + +/** + * + * @export + * @interface EntitlementconnectionbulkupdateitemV1 + */ +export interface EntitlementconnectionbulkupdateitemV1 { + /** + * Connection ID to update. + * @type {string} + * @memberof EntitlementconnectionbulkupdateitemV1 + */ + 'connectionId': string; + /** + * Target connection type. + * @type {string} + * @memberof EntitlementconnectionbulkupdateitemV1 + */ + 'type': EntitlementconnectionbulkupdateitemV1TypeV1; +} + +export const EntitlementconnectionbulkupdateitemV1TypeV1 = { + Jit: 'JIT', + Standing: 'STANDING' +} as const; + +export type EntitlementconnectionbulkupdateitemV1TypeV1 = typeof EntitlementconnectionbulkupdateitemV1TypeV1[keyof typeof EntitlementconnectionbulkupdateitemV1TypeV1]; + +/** + * + * @export + * @interface EntitlementconnectionbulkupdateresultitemV1 + */ +export interface EntitlementconnectionbulkupdateresultitemV1 { + /** + * Connection ID processed in this row. + * @type {string} + * @memberof EntitlementconnectionbulkupdateresultitemV1 + */ + 'connectionId'?: string; + /** + * Requested or resulting connection type for the row. + * @type {string} + * @memberof EntitlementconnectionbulkupdateresultitemV1 + */ + 'type'?: string; + /** + * Item-level result status code. + * @type {number} + * @memberof EntitlementconnectionbulkupdateresultitemV1 + */ + 'status'?: number; + /** + * Item-level result message. + * @type {string} + * @memberof EntitlementconnectionbulkupdateresultitemV1 + */ + 'description'?: string; +} +/** + * Entitlement connection record returned by search-backed list endpoints. + * @export + * @interface EntitlementconnectionsearchhitV1 + */ +export interface EntitlementconnectionsearchhitV1 { + /** + * Connection ID as represented in search results. + * @type {string} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'id'?: string; + /** + * Identity summary object from search index. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'identity'?: { [key: string]: any; }; + /** + * Machine identity summary object when available. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'machineIdentity'?: { [key: string]: any; }; + /** + * Account summary object. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'account'?: { [key: string]: any; }; + /** + * + * @type {EntitlementconnectionsearchhitentitlementV1} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'entitlement'?: EntitlementconnectionsearchhitentitlementV1; + /** + * Source summary object. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'source'?: { [key: string]: any; }; + /** + * Connection state object. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'state'?: { [key: string]: any; }; + /** + * JIT timestamps for lifecycle events. + * @type {{ [key: string]: any; }} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'jit'?: { [key: string]: any; }; + /** + * Indicates whether the connection is marked as standalone. + * @type {boolean} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'standalone'?: boolean; + /** + * Connection type classification. + * @type {string} + * @memberof EntitlementconnectionsearchhitV1 + */ + 'type'?: EntitlementconnectionsearchhitV1TypeV1; +} + +export const EntitlementconnectionsearchhitV1TypeV1 = { + Jit: 'JIT', + Standing: 'STANDING', + Na: 'NA' +} as const; + +export type EntitlementconnectionsearchhitV1TypeV1 = typeof EntitlementconnectionsearchhitV1TypeV1[keyof typeof EntitlementconnectionsearchhitV1TypeV1]; + +/** + * Privilege classification details for the entitlement. + * @export + * @interface EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 + */ +export interface EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 { + /** + * Effective privilege level. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 + */ + 'effective'?: string; +} +/** + * Entitlement object embedded in entitlement connection search responses. + * @export + * @interface EntitlementconnectionsearchhitentitlementV1 + */ +export interface EntitlementconnectionsearchhitentitlementV1 { + /** + * Entitlement identifier. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'id'?: string; + /** + * Entitlement name. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'name'?: string; + /** + * Human-readable entitlement label. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'displayName'?: string; + /** + * Entitlement description. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'description'?: string; + /** + * Source attribute carrying entitlement values. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'attribute'?: string; + /** + * Source entitlement value. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'value'?: string; + /** + * Source schema object type for the entitlement. + * @type {string} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * + * @type {EntitlementconnectionsearchhitentitlementPrivilegeLevelV1} + * @memberof EntitlementconnectionsearchhitentitlementV1 + */ + 'privilegeLevel'?: EntitlementconnectionsearchhitentitlementPrivilegeLevelV1; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListEntitlementConnectionsV1401ResponseV1 + */ +export interface ListEntitlementConnectionsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListEntitlementConnectionsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListEntitlementConnectionsV1412ResponseV1 + */ +export interface ListEntitlementConnectionsV1412ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListEntitlementConnectionsV1412ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface ListEntitlementConnectionsV1429ResponseV1 + */ +export interface ListEntitlementConnectionsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListEntitlementConnectionsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * EntitlementConnectionsV1Api - axios parameter creator + * @export + */ +export const EntitlementConnectionsV1ApiAxiosParamCreator = 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} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementConnectionByIdV1: async (connectionId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'connectionId' is not null or undefined + assertParamExists('patchEntitlementConnectionByIdV1', 'connectionId', connectionId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchEntitlementConnectionByIdV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + 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(jsonpatchoperationV1, 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} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementConnectionByQueryV1: async (entitlementId: string, identityId: string, accountId: string, jsonpatchoperationV1: 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 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchEntitlementConnectionByQueryV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + 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(jsonpatchoperationV1, 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} entitlementconnectionbulkupdateitemV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementConnectionsBulkV1: async (entitlementconnectionbulkupdateitemV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementconnectionbulkupdateitemV1' is not null or undefined + assertParamExists('updateEntitlementConnectionsBulkV1', 'entitlementconnectionbulkupdateitemV1', entitlementconnectionbulkupdateitemV1) + 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(entitlementconnectionbulkupdateitemV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * EntitlementConnectionsV1Api - functional programming interface + * @export + */ +export const EntitlementConnectionsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = EntitlementConnectionsV1ApiAxiosParamCreator(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['EntitlementConnectionsV1Api.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['EntitlementConnectionsV1Api.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} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchEntitlementConnectionByIdV1(connectionId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionByIdV1(connectionId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV1Api.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} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchEntitlementConnectionByQueryV1(entitlementId: string, identityId: string, accountId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionByQueryV1(entitlementId, identityId, accountId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV1Api.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} entitlementconnectionbulkupdateitemV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateEntitlementConnectionsBulkV1(entitlementconnectionbulkupdateitemV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementConnectionsBulkV1(entitlementconnectionbulkupdateitemV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV1Api.updateEntitlementConnectionsBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * EntitlementConnectionsV1Api - factory interface + * @export + */ +export const EntitlementConnectionsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = EntitlementConnectionsV1ApiFp(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 {EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementConnectionsForCurrentIdentityV1(requestParameters: EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request = {}, 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 {EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementConnectionsV1(requestParameters: EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request = {}, 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 {EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementConnectionByIdV1(requestParameters: EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchEntitlementConnectionByIdV1(requestParameters.connectionId, requestParameters.jsonpatchoperationV1, 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 {EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementConnectionByQueryV1(requestParameters: EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchEntitlementConnectionByQueryV1(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonpatchoperationV1, 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 {EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementConnectionsBulkV1(requestParameters: EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.updateEntitlementConnectionsBulkV1(requestParameters.entitlementconnectionbulkupdateitemV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for listEntitlementConnectionsForCurrentIdentityV1 operation in EntitlementConnectionsV1Api. + * @export + * @interface EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request + */ +export interface EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request { + /** + * 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listEntitlementConnectionsV1 operation in EntitlementConnectionsV1Api. + * @export + * @interface EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request + */ +export interface EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request { + /** + * 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + 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 EntitlementConnectionsV1ApiListEntitlementConnectionsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchEntitlementConnectionByIdV1 operation in EntitlementConnectionsV1Api. + * @export + * @interface EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request + */ +export interface EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request { + /** + * Connection ID (UUID with or without hyphens). + * @type {string} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1 + */ + readonly connectionId: string + + /** + * + * @type {Array} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchEntitlementConnectionByQueryV1 operation in EntitlementConnectionsV1Api. + * @export + * @interface EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request + */ +export interface EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request { + /** + * Entitlement ID (UUID with or without hyphens). + * @type {string} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1 + */ + readonly entitlementId: string + + /** + * Identity ID (UUID with or without hyphens). + * @type {string} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1 + */ + readonly identityId: string + + /** + * Account ID (UUID with or without hyphens). + * @type {string} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1 + */ + readonly accountId: string + + /** + * + * @type {Array} + * @memberof EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateEntitlementConnectionsBulkV1 operation in EntitlementConnectionsV1Api. + * @export + * @interface EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request + */ +export interface EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request { + /** + * + * @type {Array} + * @memberof EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1 + */ + readonly entitlementconnectionbulkupdateitemV1: Array +} + +/** + * EntitlementConnectionsV1Api - object-oriented interface + * @export + * @class EntitlementConnectionsV1Api + * @extends {BaseAPI} + */ +export class EntitlementConnectionsV1Api 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 {EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementConnectionsV1Api + */ + public listEntitlementConnectionsForCurrentIdentityV1(requestParameters: EntitlementConnectionsV1ApiListEntitlementConnectionsForCurrentIdentityV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementConnectionsV1ApiFp(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 {EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementConnectionsV1Api + */ + public listEntitlementConnectionsV1(requestParameters: EntitlementConnectionsV1ApiListEntitlementConnectionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementConnectionsV1ApiFp(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 {EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementConnectionsV1Api + */ + public patchEntitlementConnectionByIdV1(requestParameters: EntitlementConnectionsV1ApiPatchEntitlementConnectionByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementConnectionsV1ApiFp(this.configuration).patchEntitlementConnectionByIdV1(requestParameters.connectionId, requestParameters.jsonpatchoperationV1, 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 {EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementConnectionsV1Api + */ + public patchEntitlementConnectionByQueryV1(requestParameters: EntitlementConnectionsV1ApiPatchEntitlementConnectionByQueryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementConnectionsV1ApiFp(this.configuration).patchEntitlementConnectionByQueryV1(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonpatchoperationV1, 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 {EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementConnectionsV1Api + */ + public updateEntitlementConnectionsBulkV1(requestParameters: EntitlementConnectionsV1ApiUpdateEntitlementConnectionsBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementConnectionsV1ApiFp(this.configuration).updateEntitlementConnectionsBulkV1(requestParameters.entitlementconnectionbulkupdateitemV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/entitlement_connections/base.ts b/sdk-output/entitlement_connections/base.ts new file mode 100644 index 00000000..d7b4e40a --- /dev/null +++ b/sdk-output/entitlement_connections/base.ts @@ -0,0 +1,86 @@ +/* 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/entitlement_connections/common.ts b/sdk-output/entitlement_connections/common.ts new file mode 100644 index 00000000..fc94f13a --- /dev/null +++ b/sdk-output/entitlement_connections/common.ts @@ -0,0 +1,183 @@ +/* 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/entitlement_connections/configuration.ts b/sdk-output/entitlement_connections/configuration.ts new file mode 100644 index 00000000..588a2853 --- /dev/null +++ b/sdk-output/entitlement_connections/configuration.ts @@ -0,0 +1,110 @@ +/* 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/entitlement_connections/git_push.sh b/sdk-output/entitlement_connections/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/entitlement_connections/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/entitlement_connections/index.ts b/sdk-output/entitlement_connections/index.ts new file mode 100644 index 00000000..54208299 --- /dev/null +++ b/sdk-output/entitlement_connections/index.ts @@ -0,0 +1,18 @@ +/* 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/entitlement_connections/package.json b/sdk-output/entitlement_connections/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/entitlement_connections/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/entitlement_connections/tsconfig.json b/sdk-output/entitlement_connections/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/entitlement_connections/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/entitlements/.gitignore b/sdk-output/entitlements/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/entitlements/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/entitlements/.npmignore b/sdk-output/entitlements/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/entitlements/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/entitlements/.openapi-generator-ignore b/sdk-output/entitlements/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/entitlements/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/entitlements/.openapi-generator/FILES b/sdk-output/entitlements/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/entitlements/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/entitlements/.openapi-generator/VERSION b/sdk-output/entitlements/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/entitlements/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/entitlements/.sdk-partition b/sdk-output/entitlements/.sdk-partition new file mode 100644 index 00000000..1c6eb411 --- /dev/null +++ b/sdk-output/entitlements/.sdk-partition @@ -0,0 +1 @@ +entitlements \ No newline at end of file diff --git a/sdk-output/entitlements/README.md b/sdk-output/entitlements/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/entitlements/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/entitlements/api.ts b/sdk-output/entitlements/api.ts new file mode 100644 index 00000000..9fc097be --- /dev/null +++ b/sdk-output/entitlements/api.ts @@ -0,0 +1,2586 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Entitlements + * 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'; + +/** + * Metadata that describes an access item + * @export + * @interface AccessmodelmetadataV1 + */ +export interface AccessmodelmetadataV1 { + /** + * Unique identifier for the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'key'?: string; + /** + * Human readable name of the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'name'?: string; + /** + * Allows selecting multiple values + * @type {boolean} + * @memberof AccessmodelmetadataV1 + */ + 'multiselect'?: boolean; + /** + * The state of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'status'?: string; + /** + * The type of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'type'?: string; + /** + * The types of objects + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'objectTypes'?: Array; + /** + * Describes the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'description'?: string; + /** + * The value to assign to the metadata item + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'values'?: Array; +} +/** + * An individual value to assign to the metadata item + * @export + * @interface AccessmodelmetadataValuesInnerV1 + */ +export interface AccessmodelmetadataValuesInnerV1 { + /** + * The value to assign to the metdata item + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'value'?: string; + /** + * Display name of the value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'name'?: string; + /** + * The status of the individual value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'status'?: string; +} +/** + * Reference to an additional owner (identity or governance group). + * @export + * @interface AdditionalownerrefV1 + */ +export interface AdditionalownerrefV1 { + /** + * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'type'?: AdditionalownerrefV1TypeV1; + /** + * ID of the identity or governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'id'?: string; + /** + * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'name'?: string | null; +} + +export const AdditionalownerrefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type AdditionalownerrefV1TypeV1 = typeof AdditionalownerrefV1TypeV1[keyof typeof AdditionalownerrefV1TypeV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface EntitlementSourceV1 + */ +export interface EntitlementSourceV1 { + /** + * The source ID + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV1 + */ +export interface EntitlementV1 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV1 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV1 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'description'?: string | null; + /** + * True if the entitlement is privileged + * @type {boolean} + * @memberof EntitlementV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV1 + */ + 'requestable'?: boolean; + /** + * + * @type {Entitlementv2OwnerV1} + * @memberof EntitlementV1 + */ + 'owner'?: Entitlementv2OwnerV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof EntitlementV1 + */ + 'additionalOwners'?: Array | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {Entitlementv2AccessModelMetadataV1} + * @memberof EntitlementV1 + */ + 'accessModelMetadata'?: Entitlementv2AccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV1 + */ + 'modified'?: string; + /** + * + * @type {EntitlementSourceV1} + * @memberof EntitlementV1 + */ + 'source'?: EntitlementSourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV1 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV1 + */ + 'directPermissions'?: Array; +} +/** + * The maximum duration for which the access is permitted. + * @export + * @interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ +export interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 { + /** + * The numeric value of the duration. + * @type {number} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'value'?: number; + /** + * The time unit for the duration. + * @type {string} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'timeUnit'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1; +} + +export const EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1[keyof typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1]; + +/** + * + * @export + * @interface EntitlementaccessrequestconfigV1 + */ +export interface EntitlementaccessrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'approvalSchemes'?: Array; + /** + * If the requester must provide a comment during access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requestCommentRequired'?: boolean; + /** + * If the reviewer must provide a comment when denying the access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'denialCommentRequired'?: boolean; + /** + * Is Reauthorization Required + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'reauthorizationRequired'?: boolean; + /** + * If true, then remove date or sunset date is required in access request of the entitlement. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requireEndDate'?: boolean; + /** + * + * @type {EntitlementaccessrequestconfigMaxPermittedAccessDurationV1} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'maxPermittedAccessDuration'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 | null; +} +/** + * + * @export + * @interface EntitlementapprovalschemeV1 + */ +export interface EntitlementapprovalschemeV1 { + /** + * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverType'?: EntitlementapprovalschemeV1ApproverTypeV1; + /** + * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverId'?: string | null; +} + +export const EntitlementapprovalschemeV1ApproverTypeV1 = { + EntitlementOwner: 'ENTITLEMENT_OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW' +} as const; + +export type EntitlementapprovalschemeV1ApproverTypeV1 = typeof EntitlementapprovalschemeV1ApproverTypeV1[keyof typeof EntitlementapprovalschemeV1ApproverTypeV1]; + +/** + * Object for specifying the bulk update request + * @export + * @interface EntitlementbulkupdaterequestV1 + */ +export interface EntitlementbulkupdaterequestV1 { + /** + * List of entitlement ids to update + * @type {Array} + * @memberof EntitlementbulkupdaterequestV1 + */ + 'entitlementIds': Array; + /** + * + * @type {Array} + * @memberof EntitlementbulkupdaterequestV1 + */ + 'jsonPatch': Array; +} +/** + * + * @export + * @interface EntitlementprivilegelevelV1 + */ +export interface EntitlementprivilegelevelV1 { + /** + * Direct privilege level assigned to the entitlement + * @type {string} + * @memberof EntitlementprivilegelevelV1 + */ + 'direct'?: EntitlementprivilegelevelV1DirectV1; + /** + * User or process that set the privilege level + * @type {string} + * @memberof EntitlementprivilegelevelV1 + */ + 'setBy'?: string; + /** + * Method by which the privilege level was set + * @type {string} + * @memberof EntitlementprivilegelevelV1 + */ + 'setByType'?: EntitlementprivilegelevelV1SetByTypeV1 | null; + /** + * Inherited privilege level on the entitlement, if any + * @type {string} + * @memberof EntitlementprivilegelevelV1 + */ + 'inherited'?: EntitlementprivilegelevelV1InheritedV1 | null; + /** + * Effective privilege level assigned to the entitlement + * @type {string} + * @memberof EntitlementprivilegelevelV1 + */ + 'effective'?: EntitlementprivilegelevelV1EffectiveV1; +} + +export const EntitlementprivilegelevelV1DirectV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type EntitlementprivilegelevelV1DirectV1 = typeof EntitlementprivilegelevelV1DirectV1[keyof typeof EntitlementprivilegelevelV1DirectV1]; +export const EntitlementprivilegelevelV1SetByTypeV1 = { + Override: 'OVERRIDE', + CustomCriteria: 'CUSTOM_CRITERIA', + ConnectorCriteria: 'CONNECTOR_CRITERIA', + SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA' +} as const; + +export type EntitlementprivilegelevelV1SetByTypeV1 = typeof EntitlementprivilegelevelV1SetByTypeV1[keyof typeof EntitlementprivilegelevelV1SetByTypeV1]; +export const EntitlementprivilegelevelV1InheritedV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type EntitlementprivilegelevelV1InheritedV1 = typeof EntitlementprivilegelevelV1InheritedV1[keyof typeof EntitlementprivilegelevelV1InheritedV1]; +export const EntitlementprivilegelevelV1EffectiveV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type EntitlementprivilegelevelV1EffectiveV1 = typeof EntitlementprivilegelevelV1EffectiveV1[keyof typeof EntitlementprivilegelevelV1EffectiveV1]; + +/** + * + * @export + * @interface EntitlementrequestconfigV1 + */ +export interface EntitlementrequestconfigV1 { + /** + * + * @type {EntitlementaccessrequestconfigV1} + * @memberof EntitlementrequestconfigV1 + */ + 'accessRequestConfig'?: EntitlementaccessrequestconfigV1; + /** + * + * @type {EntitlementrevocationrequestconfigV1} + * @memberof EntitlementrequestconfigV1 + */ + 'revocationRequestConfig'?: EntitlementrevocationrequestconfigV1; +} +/** + * + * @export + * @interface EntitlementrevocationrequestconfigV1 + */ +export interface EntitlementrevocationrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementrevocationrequestconfigV1 + */ + 'approvalSchemes'?: Array; +} +/** + * + * @export + * @interface EntitlementsourceresetbasereferencedtoV1 + */ +export interface EntitlementsourceresetbasereferencedtoV1 { + /** + * The DTO type + * @type {string} + * @memberof EntitlementsourceresetbasereferencedtoV1 + */ + 'type'?: string; + /** + * The task ID of the object to which this reference applies + * @type {string} + * @memberof EntitlementsourceresetbasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof EntitlementsourceresetbasereferencedtoV1 + */ + 'name'?: string; +} +/** + * Additional data to classify the entitlement + * @export + * @interface Entitlementv2AccessModelMetadataV1 + */ +export interface Entitlementv2AccessModelMetadataV1 { + /** + * + * @type {Array} + * @memberof Entitlementv2AccessModelMetadataV1 + */ + 'attributes'?: Array; +} +/** + * The identity that owns the entitlement + * @export + * @interface Entitlementv2OwnerV1 + */ +export interface Entitlementv2OwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof Entitlementv2OwnerV1 + */ + 'id'?: string; + /** + * The type of object + * @type {string} + * @memberof Entitlementv2OwnerV1 + */ + 'type'?: Entitlementv2OwnerV1TypeV1; + /** + * The display name of the identity + * @type {string} + * @memberof Entitlementv2OwnerV1 + */ + 'name'?: string; +} + +export const Entitlementv2OwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type Entitlementv2OwnerV1TypeV1 = typeof Entitlementv2OwnerV1TypeV1[keyof typeof Entitlementv2OwnerV1TypeV1]; + +/** + * + * @export + * @interface Entitlementv2PrivilegeLevelV1 + */ +export interface Entitlementv2PrivilegeLevelV1 { + /** + * Direct privilege level assigned to the entitlement + * @type {string} + * @memberof Entitlementv2PrivilegeLevelV1 + */ + 'direct'?: Entitlementv2PrivilegeLevelV1DirectV1; + /** + * User or process that set the privilege level + * @type {string} + * @memberof Entitlementv2PrivilegeLevelV1 + */ + 'setBy'?: string; + /** + * Method by which the privilege level was set + * @type {string} + * @memberof Entitlementv2PrivilegeLevelV1 + */ + 'setByType'?: Entitlementv2PrivilegeLevelV1SetByTypeV1 | null; + /** + * Inherited privilege level on the entitlement, if any + * @type {string} + * @memberof Entitlementv2PrivilegeLevelV1 + */ + 'inherited'?: Entitlementv2PrivilegeLevelV1InheritedV1 | null; + /** + * Effective privilege level assigned to the entitlement + * @type {string} + * @memberof Entitlementv2PrivilegeLevelV1 + */ + 'effective'?: Entitlementv2PrivilegeLevelV1EffectiveV1; +} + +export const Entitlementv2PrivilegeLevelV1DirectV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type Entitlementv2PrivilegeLevelV1DirectV1 = typeof Entitlementv2PrivilegeLevelV1DirectV1[keyof typeof Entitlementv2PrivilegeLevelV1DirectV1]; +export const Entitlementv2PrivilegeLevelV1SetByTypeV1 = { + Override: 'OVERRIDE', + CustomCriteria: 'CUSTOM_CRITERIA', + ConnectorCriteria: 'CONNECTOR_CRITERIA', + SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA' +} as const; + +export type Entitlementv2PrivilegeLevelV1SetByTypeV1 = typeof Entitlementv2PrivilegeLevelV1SetByTypeV1[keyof typeof Entitlementv2PrivilegeLevelV1SetByTypeV1]; +export const Entitlementv2PrivilegeLevelV1InheritedV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type Entitlementv2PrivilegeLevelV1InheritedV1 = typeof Entitlementv2PrivilegeLevelV1InheritedV1[keyof typeof Entitlementv2PrivilegeLevelV1InheritedV1]; +export const Entitlementv2PrivilegeLevelV1EffectiveV1 = { + High: 'HIGH', + Low: 'LOW', + Medium: 'MEDIUM', + None: 'NONE' +} as const; + +export type Entitlementv2PrivilegeLevelV1EffectiveV1 = typeof Entitlementv2PrivilegeLevelV1EffectiveV1[keyof typeof Entitlementv2PrivilegeLevelV1EffectiveV1]; + +/** + * + * @export + * @interface Entitlementv2SourceV1 + */ +export interface Entitlementv2SourceV1 { + /** + * The source ID + * @type {string} + * @memberof Entitlementv2SourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof Entitlementv2SourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof Entitlementv2SourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV2 + */ +export interface EntitlementV2 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV2 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV2 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV2 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV2 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV2 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV2 + */ + 'description'?: string | null; + /** + * + * @type {Entitlementv2PrivilegeLevelV1} + * @memberof EntitlementV2 + */ + 'privilegeLevel'?: Entitlementv2PrivilegeLevelV1; + /** + * List of tags assigned to the entitlement + * @type {Array} + * @memberof EntitlementV2 + */ + 'tags'?: Array | null; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV2 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV2 + */ + 'requestable'?: boolean; + /** + * + * @type {Entitlementv2OwnerV1} + * @memberof EntitlementV2 + */ + 'owner'?: Entitlementv2OwnerV1 | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV2 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {Entitlementv2AccessModelMetadataV1} + * @memberof EntitlementV2 + */ + 'accessModelMetadata'?: Entitlementv2AccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV2 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV2 + */ + 'modified'?: string; + /** + * + * @type {Entitlementv2SourceV1} + * @memberof EntitlementV2 + */ + 'source'?: Entitlementv2SourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV2 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV2 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV2 + */ + 'directPermissions'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ImportEntitlementsBySourceV1RequestV1 + */ +export interface ImportEntitlementsBySourceV1RequestV1 { + /** + * The CSV file containing the source entitlements to aggregate. + * @type {File} + * @memberof ImportEntitlementsBySourceV1RequestV1 + */ + 'csvFile'?: File; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListEntitlementsV1401ResponseV1 + */ +export interface ListEntitlementsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListEntitlementsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListEntitlementsV1429ResponseV1 + */ +export interface ListEntitlementsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListEntitlementsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface LoadentitlementtaskReturnsInnerV1 + */ +export interface LoadentitlementtaskReturnsInnerV1 { + /** + * The display label for the return value + * @type {string} + * @memberof LoadentitlementtaskReturnsInnerV1 + */ + 'displayLabel'?: string; + /** + * The attribute name for the return value + * @type {string} + * @memberof LoadentitlementtaskReturnsInnerV1 + */ + 'attributeName'?: string; +} +/** + * + * @export + * @interface LoadentitlementtaskV1 + */ +export interface LoadentitlementtaskV1 { + /** + * System-generated unique ID of the task this taskStatus represents + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'id'?: string; + /** + * Type of task this task represents + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'type'?: string; + /** + * The name of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'uniqueName'?: string; + /** + * The description of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'description'?: string; + /** + * The user who initiated the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'launcher'?: string; + /** + * The creation date of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'created'?: string; + /** + * Return values from the task + * @type {Array} + * @memberof LoadentitlementtaskV1 + */ + 'returns'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} + +/** + * EntitlementsV1Api - axios parameter creator + * @export + */ +export const EntitlementsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add single Access Model Metadata to an entitlement. + * @summary Add metadata to an entitlement. + * @param {string} id The entitlement id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataForEntitlementV1: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('createAccessModelMetadataForEntitlementV1', 'id', id) + // verify required parameter 'attributeKey' is not null or undefined + assertParamExists('createAccessModelMetadataForEntitlementV1', 'attributeKey', attributeKey) + // verify required parameter 'attributeValue' is not null or undefined + assertParamExists('createAccessModelMetadataForEntitlementV1', 'attributeValue', attributeValue) + const localVarPath = `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) + .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Remove single Access Model Metadata from an entitlement. + * @summary Remove metadata from an entitlement. + * @param {string} id The entitlement id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessModelMetadataFromEntitlementV1: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccessModelMetadataFromEntitlementV1', 'id', id) + // verify required parameter 'attributeKey' is not null or undefined + assertParamExists('deleteAccessModelMetadataFromEntitlementV1', 'attributeKey', attributeKey) + // verify required parameter 'attributeValue' is not null or undefined + assertParamExists('deleteAccessModelMetadataFromEntitlementV1', 'attributeValue', attributeValue) + const localVarPath = `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) + .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the entitlement request config for a specified entitlement. + * @summary Get entitlement request config + * @param {string} id Entitlement Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementRequestConfigV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getEntitlementRequestConfigV1', 'id', id) + const localVarPath = `/entitlements/v1/{id}/entitlement-request-config` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns an entitlement by its ID. + * @summary Get an entitlement + * @param {string} id The entitlement ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getEntitlementV1', 'id', id) + const localVarPath = `/entitlements/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, + }; + }, + /** + * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Aggregate entitlements + * @param {string} id Source Id + * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + importEntitlementsBySourceV1: async (id: string, csvFile?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importEntitlementsBySourceV1', 'id', id) + const localVarPath = `/entitlements/v1/aggregate/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (csvFile !== undefined) { + localVarFormParams.append('csvFile', csvFile as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of all child entitlements of a given entitlement. + * @summary List of entitlements children + * @param {string} id Entitlement Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementChildrenV1: async (id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listEntitlementChildrenV1', 'id', id) + const localVarPath = `/entitlements/v1/{id}/children` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (searchAfter !== undefined) { + localVarQueryParameter['searchAfter'] = searchAfter; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of all parent entitlements of a given entitlement. + * @summary List of entitlements parents + * @param {string} id Entitlement Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementParentsV1: async (id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listEntitlementParentsV1', 'id', id) + const localVarPath = `/entitlements/v1/{id}/parents` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (searchAfter !== undefined) { + localVarQueryParameter['searchAfter'] = searchAfter; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. + * @summary Get entitlements for an account + * @param {string} accountId The account ID to get entitlements for + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsByAccountV1: async (accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accountId' is not null or undefined + assertParamExists('listEntitlementsByAccountV1', 'accountId', accountId) + const localVarPath = `/entitlements/v1/account/{accountId}/entitlements` + .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (searchAfter !== undefined) { + localVarQueryParameter['searchAfter'] = searchAfter; + } + + 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, + }; + }, + /** + * This API returns a list of entitlements. Any authenticated token can call this API. + * @summary Gets a list of entitlements. + * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. + * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. + * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsV1: async (segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/entitlements/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 (segmentedForIdentity !== undefined) { + localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity; + } + + if (forSegmentIds !== undefined) { + localVarQueryParameter['for-segment-ids'] = forSegmentIds; + } + + if (includeUnsegmented !== undefined) { + localVarQueryParameter['include-unsegmented'] = includeUnsegmented; + } + + 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + * @summary Patch an entitlement + * @param {string} id ID of the entitlement to patch + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementV1: async (id: string, jsonpatchoperationV1?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchEntitlementV1', 'id', id) + const localVarPath = `/entitlements/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API replaces the entitlement request config for a specified entitlement. + * @summary Replace entitlement request config + * @param {string} id Entitlement ID + * @param {EntitlementrequestconfigV1} entitlementrequestconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putEntitlementRequestConfigV1: async (id: string, entitlementrequestconfigV1: EntitlementrequestconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putEntitlementRequestConfigV1', 'id', id) + // verify required parameter 'entitlementrequestconfigV1' is not null or undefined + assertParamExists('putEntitlementRequestConfigV1', 'entitlementrequestconfigV1', entitlementrequestconfigV1) + const localVarPath = `/entitlements/v1/{id}/entitlement-request-config` + .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: 'PUT', ...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(entitlementrequestconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + * @summary Reset source entitlements + * @param {string} id ID of source for the entitlement reset + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + resetSourceEntitlementsV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('resetSourceEntitlementsV1', 'id', id) + const localVarPath = `/entitlements/v1/reset/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. + * @summary Bulk update an entitlement list + * @param {EntitlementbulkupdaterequestV1} entitlementbulkupdaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementsInBulkV1: async (entitlementbulkupdaterequestV1: EntitlementbulkupdaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementbulkupdaterequestV1' is not null or undefined + assertParamExists('updateEntitlementsInBulkV1', 'entitlementbulkupdaterequestV1', entitlementbulkupdaterequestV1) + const localVarPath = `/entitlements/v1/bulk-update`; + // 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(entitlementbulkupdaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * EntitlementsV1Api - functional programming interface + * @export + */ +export const EntitlementsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = EntitlementsV1ApiAxiosParamCreator(configuration) + return { + /** + * Add single Access Model Metadata to an entitlement. + * @summary Add metadata to an entitlement. + * @param {string} id The entitlement id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAccessModelMetadataForEntitlementV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataForEntitlementV1(id, attributeKey, attributeValue, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.createAccessModelMetadataForEntitlementV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove single Access Model Metadata from an entitlement. + * @summary Remove metadata from an entitlement. + * @param {string} id The entitlement id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccessModelMetadataFromEntitlementV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessModelMetadataFromEntitlementV1(id, attributeKey, attributeValue, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.deleteAccessModelMetadataFromEntitlementV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the entitlement request config for a specified entitlement. + * @summary Get entitlement request config + * @param {string} id Entitlement Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementRequestConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementRequestConfigV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.getEntitlementRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns an entitlement by its ID. + * @summary Get an entitlement + * @param {string} id The entitlement ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.getEntitlementV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Aggregate entitlements + * @param {string} id Source Id + * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async importEntitlementsBySourceV1(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsBySourceV1(id, csvFile, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.importEntitlementsBySourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all child entitlements of a given entitlement. + * @summary List of entitlements children + * @param {string} id Entitlement Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listEntitlementChildrenV1(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildrenV1(id, limit, offset, count, searchAfter, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.listEntitlementChildrenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all parent entitlements of a given entitlement. + * @summary List of entitlements parents + * @param {string} id Entitlement Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listEntitlementParentsV1(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParentsV1(id, limit, offset, count, searchAfter, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.listEntitlementParentsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. + * @summary Get entitlements for an account + * @param {string} accountId The account ID to get entitlements for + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listEntitlementsByAccountV1(accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByAccountV1(accountId, limit, offset, count, searchAfter, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.listEntitlementsByAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of entitlements. Any authenticated token can call this API. + * @summary Gets a list of entitlements. + * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. + * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. + * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** + * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listEntitlementsV1(segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsV1(segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, searchAfter, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.listEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + * @summary Patch an entitlement + * @param {string} id ID of the entitlement to patch + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchEntitlementV1(id: string, jsonpatchoperationV1?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.patchEntitlementV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API replaces the entitlement request config for a specified entitlement. + * @summary Replace entitlement request config + * @param {string} id Entitlement ID + * @param {EntitlementrequestconfigV1} entitlementrequestconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putEntitlementRequestConfigV1(id: string, entitlementrequestconfigV1: EntitlementrequestconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putEntitlementRequestConfigV1(id, entitlementrequestconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.putEntitlementRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + * @summary Reset source entitlements + * @param {string} id ID of source for the entitlement reset + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async resetSourceEntitlementsV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.resetSourceEntitlementsV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.resetSourceEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. + * @summary Bulk update an entitlement list + * @param {EntitlementbulkupdaterequestV1} entitlementbulkupdaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateEntitlementsInBulkV1(entitlementbulkupdaterequestV1: EntitlementbulkupdaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulkV1(entitlementbulkupdaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['EntitlementsV1Api.updateEntitlementsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * EntitlementsV1Api - factory interface + * @export + */ +export const EntitlementsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = EntitlementsV1ApiFp(configuration) + return { + /** + * Add single Access Model Metadata to an entitlement. + * @summary Add metadata to an entitlement. + * @param {EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAccessModelMetadataForEntitlementV1(requestParameters: EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAccessModelMetadataForEntitlementV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Remove single Access Model Metadata from an entitlement. + * @summary Remove metadata from an entitlement. + * @param {EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccessModelMetadataFromEntitlementV1(requestParameters: EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccessModelMetadataFromEntitlementV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the entitlement request config for a specified entitlement. + * @summary Get entitlement request config + * @param {EntitlementsV1ApiGetEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementRequestConfigV1(requestParameters: EntitlementsV1ApiGetEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getEntitlementRequestConfigV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns an entitlement by its ID. + * @summary Get an entitlement + * @param {EntitlementsV1ApiGetEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementV1(requestParameters: EntitlementsV1ApiGetEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getEntitlementV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Aggregate entitlements + * @param {EntitlementsV1ApiImportEntitlementsBySourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + importEntitlementsBySourceV1(requestParameters: EntitlementsV1ApiImportEntitlementsBySourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importEntitlementsBySourceV1(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all child entitlements of a given entitlement. + * @summary List of entitlements children + * @param {EntitlementsV1ApiListEntitlementChildrenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementChildrenV1(requestParameters: EntitlementsV1ApiListEntitlementChildrenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listEntitlementChildrenV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all parent entitlements of a given entitlement. + * @summary List of entitlements parents + * @param {EntitlementsV1ApiListEntitlementParentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementParentsV1(requestParameters: EntitlementsV1ApiListEntitlementParentsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listEntitlementParentsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. + * @summary Get entitlements for an account + * @param {EntitlementsV1ApiListEntitlementsByAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsByAccountV1(requestParameters: EntitlementsV1ApiListEntitlementsByAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listEntitlementsByAccountV1(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of entitlements. Any authenticated token can call this API. + * @summary Gets a list of entitlements. + * @param {EntitlementsV1ApiListEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsV1(requestParameters: EntitlementsV1ApiListEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listEntitlementsV1(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + * @summary Patch an entitlement + * @param {EntitlementsV1ApiPatchEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementV1(requestParameters: EntitlementsV1ApiPatchEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchEntitlementV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API replaces the entitlement request config for a specified entitlement. + * @summary Replace entitlement request config + * @param {EntitlementsV1ApiPutEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putEntitlementRequestConfigV1(requestParameters: EntitlementsV1ApiPutEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putEntitlementRequestConfigV1(requestParameters.id, requestParameters.entitlementrequestconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + * @summary Reset source entitlements + * @param {EntitlementsV1ApiResetSourceEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + resetSourceEntitlementsV1(requestParameters: EntitlementsV1ApiResetSourceEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.resetSourceEntitlementsV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. + * @summary Bulk update an entitlement list + * @param {EntitlementsV1ApiUpdateEntitlementsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementsInBulkV1(requestParameters: EntitlementsV1ApiUpdateEntitlementsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateEntitlementsInBulkV1(requestParameters.entitlementbulkupdaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createAccessModelMetadataForEntitlementV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request + */ +export interface EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request { + /** + * The entitlement id. + * @type {string} + * @memberof EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1 + */ + readonly id: string + + /** + * Technical name of the Attribute. + * @type {string} + * @memberof EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1 + */ + readonly attributeKey: string + + /** + * Technical name of the Attribute Value. + * @type {string} + * @memberof EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1 + */ + readonly attributeValue: string +} + +/** + * Request parameters for deleteAccessModelMetadataFromEntitlementV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request + */ +export interface EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request { + /** + * The entitlement id. + * @type {string} + * @memberof EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1 + */ + readonly id: string + + /** + * Technical name of the Attribute. + * @type {string} + * @memberof EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1 + */ + readonly attributeKey: string + + /** + * Technical name of the Attribute Value. + * @type {string} + * @memberof EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1 + */ + readonly attributeValue: string +} + +/** + * Request parameters for getEntitlementRequestConfigV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiGetEntitlementRequestConfigV1Request + */ +export interface EntitlementsV1ApiGetEntitlementRequestConfigV1Request { + /** + * Entitlement Id + * @type {string} + * @memberof EntitlementsV1ApiGetEntitlementRequestConfigV1 + */ + readonly id: string +} + +/** + * Request parameters for getEntitlementV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiGetEntitlementV1Request + */ +export interface EntitlementsV1ApiGetEntitlementV1Request { + /** + * The entitlement ID + * @type {string} + * @memberof EntitlementsV1ApiGetEntitlementV1 + */ + readonly id: string +} + +/** + * Request parameters for importEntitlementsBySourceV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiImportEntitlementsBySourceV1Request + */ +export interface EntitlementsV1ApiImportEntitlementsBySourceV1Request { + /** + * Source Id + * @type {string} + * @memberof EntitlementsV1ApiImportEntitlementsBySourceV1 + */ + readonly id: string + + /** + * The CSV file containing the source entitlements to aggregate. + * @type {File} + * @memberof EntitlementsV1ApiImportEntitlementsBySourceV1 + */ + readonly csvFile?: File +} + +/** + * Request parameters for listEntitlementChildrenV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiListEntitlementChildrenV1Request + */ +export interface EntitlementsV1ApiListEntitlementChildrenV1Request { + /** + * Entitlement Id + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + 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 EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementChildrenV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listEntitlementParentsV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiListEntitlementParentsV1Request + */ +export interface EntitlementsV1ApiListEntitlementParentsV1Request { + /** + * Entitlement Id + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + 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 EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementParentsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listEntitlementsByAccountV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiListEntitlementsByAccountV1Request + */ +export interface EntitlementsV1ApiListEntitlementsByAccountV1Request { + /** + * The account ID to get entitlements for + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsByAccountV1 + */ + readonly accountId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementsByAccountV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof EntitlementsV1ApiListEntitlementsByAccountV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof EntitlementsV1ApiListEntitlementsByAccountV1 + */ + 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 EntitlementsV1ApiListEntitlementsByAccountV1 + */ + readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsByAccountV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listEntitlementsV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiListEntitlementsV1Request + */ +export interface EntitlementsV1ApiListEntitlementsV1Request { + /** + * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsV1 + */ + readonly segmentedForIdentity?: string + + /** + * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsV1 + */ + readonly forSegmentIds?: string + + /** + * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. + * @type {boolean} + * @memberof EntitlementsV1ApiListEntitlementsV1 + */ + readonly includeUnsegmented?: boolean + + /** + * 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 EntitlementsV1ApiListEntitlementsV1 + */ + 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 EntitlementsV1ApiListEntitlementsV1 + */ + 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 EntitlementsV1ApiListEntitlementsV1 + */ + 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 EntitlementsV1ApiListEntitlementsV1 + */ + readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* + * @type {string} + * @memberof EntitlementsV1ApiListEntitlementsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for patchEntitlementV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiPatchEntitlementV1Request + */ +export interface EntitlementsV1ApiPatchEntitlementV1Request { + /** + * ID of the entitlement to patch + * @type {string} + * @memberof EntitlementsV1ApiPatchEntitlementV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof EntitlementsV1ApiPatchEntitlementV1 + */ + readonly jsonpatchoperationV1?: Array +} + +/** + * Request parameters for putEntitlementRequestConfigV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiPutEntitlementRequestConfigV1Request + */ +export interface EntitlementsV1ApiPutEntitlementRequestConfigV1Request { + /** + * Entitlement ID + * @type {string} + * @memberof EntitlementsV1ApiPutEntitlementRequestConfigV1 + */ + readonly id: string + + /** + * + * @type {EntitlementrequestconfigV1} + * @memberof EntitlementsV1ApiPutEntitlementRequestConfigV1 + */ + readonly entitlementrequestconfigV1: EntitlementrequestconfigV1 +} + +/** + * Request parameters for resetSourceEntitlementsV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiResetSourceEntitlementsV1Request + */ +export interface EntitlementsV1ApiResetSourceEntitlementsV1Request { + /** + * ID of source for the entitlement reset + * @type {string} + * @memberof EntitlementsV1ApiResetSourceEntitlementsV1 + */ + readonly id: string +} + +/** + * Request parameters for updateEntitlementsInBulkV1 operation in EntitlementsV1Api. + * @export + * @interface EntitlementsV1ApiUpdateEntitlementsInBulkV1Request + */ +export interface EntitlementsV1ApiUpdateEntitlementsInBulkV1Request { + /** + * + * @type {EntitlementbulkupdaterequestV1} + * @memberof EntitlementsV1ApiUpdateEntitlementsInBulkV1 + */ + readonly entitlementbulkupdaterequestV1: EntitlementbulkupdaterequestV1 +} + +/** + * EntitlementsV1Api - object-oriented interface + * @export + * @class EntitlementsV1Api + * @extends {BaseAPI} + */ +export class EntitlementsV1Api extends BaseAPI { + /** + * Add single Access Model Metadata to an entitlement. + * @summary Add metadata to an entitlement. + * @param {EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public createAccessModelMetadataForEntitlementV1(requestParameters: EntitlementsV1ApiCreateAccessModelMetadataForEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).createAccessModelMetadataForEntitlementV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove single Access Model Metadata from an entitlement. + * @summary Remove metadata from an entitlement. + * @param {EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public deleteAccessModelMetadataFromEntitlementV1(requestParameters: EntitlementsV1ApiDeleteAccessModelMetadataFromEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).deleteAccessModelMetadataFromEntitlementV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the entitlement request config for a specified entitlement. + * @summary Get entitlement request config + * @param {EntitlementsV1ApiGetEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public getEntitlementRequestConfigV1(requestParameters: EntitlementsV1ApiGetEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).getEntitlementRequestConfigV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns an entitlement by its ID. + * @summary Get an entitlement + * @param {EntitlementsV1ApiGetEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public getEntitlementV1(requestParameters: EntitlementsV1ApiGetEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).getEntitlementV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Aggregate entitlements + * @param {EntitlementsV1ApiImportEntitlementsBySourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public importEntitlementsBySourceV1(requestParameters: EntitlementsV1ApiImportEntitlementsBySourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).importEntitlementsBySourceV1(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all child entitlements of a given entitlement. + * @summary List of entitlements children + * @param {EntitlementsV1ApiListEntitlementChildrenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public listEntitlementChildrenV1(requestParameters: EntitlementsV1ApiListEntitlementChildrenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).listEntitlementChildrenV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all parent entitlements of a given entitlement. + * @summary List of entitlements parents + * @param {EntitlementsV1ApiListEntitlementParentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public listEntitlementParentsV1(requestParameters: EntitlementsV1ApiListEntitlementParentsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).listEntitlementParentsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. + * @summary Get entitlements for an account + * @param {EntitlementsV1ApiListEntitlementsByAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public listEntitlementsByAccountV1(requestParameters: EntitlementsV1ApiListEntitlementsByAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).listEntitlementsByAccountV1(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of entitlements. Any authenticated token can call this API. + * @summary Gets a list of entitlements. + * @param {EntitlementsV1ApiListEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public listEntitlementsV1(requestParameters: EntitlementsV1ApiListEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).listEntitlementsV1(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + * @summary Patch an entitlement + * @param {EntitlementsV1ApiPatchEntitlementV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public patchEntitlementV1(requestParameters: EntitlementsV1ApiPatchEntitlementV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).patchEntitlementV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API replaces the entitlement request config for a specified entitlement. + * @summary Replace entitlement request config + * @param {EntitlementsV1ApiPutEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public putEntitlementRequestConfigV1(requestParameters: EntitlementsV1ApiPutEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).putEntitlementRequestConfigV1(requestParameters.id, requestParameters.entitlementrequestconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + * @summary Reset source entitlements + * @param {EntitlementsV1ApiResetSourceEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public resetSourceEntitlementsV1(requestParameters: EntitlementsV1ApiResetSourceEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).resetSourceEntitlementsV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. + * @summary Bulk update an entitlement list + * @param {EntitlementsV1ApiUpdateEntitlementsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof EntitlementsV1Api + */ + public updateEntitlementsInBulkV1(requestParameters: EntitlementsV1ApiUpdateEntitlementsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return EntitlementsV1ApiFp(this.configuration).updateEntitlementsInBulkV1(requestParameters.entitlementbulkupdaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/entitlements/base.ts b/sdk-output/entitlements/base.ts new file mode 100644 index 00000000..2535ebcc --- /dev/null +++ b/sdk-output/entitlements/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Entitlements + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/entitlements/common.ts b/sdk-output/entitlements/common.ts new file mode 100644 index 00000000..a515a5de --- /dev/null +++ b/sdk-output/entitlements/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Entitlements + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/entitlements/configuration.ts b/sdk-output/entitlements/configuration.ts new file mode 100644 index 00000000..2cb04245 --- /dev/null +++ b/sdk-output/entitlements/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Entitlements + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/entitlements/git_push.sh b/sdk-output/entitlements/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/entitlements/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/entitlements/index.ts b/sdk-output/entitlements/index.ts new file mode 100644 index 00000000..134911b0 --- /dev/null +++ b/sdk-output/entitlements/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Entitlements + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/entitlements/package.json b/sdk-output/entitlements/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/entitlements/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/entitlements/tsconfig.json b/sdk-output/entitlements/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/entitlements/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/generic/base.ts b/sdk-output/generic/base.ts index af5d80e6..3191cdde 100644 --- a/sdk-output/generic/base.ts +++ b/sdk-output/generic/base.ts @@ -50,7 +50,7 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; this.basePath = configuration.basePath || this.basePath; diff --git a/sdk-output/generic/common.ts b/sdk-output/generic/common.ts index 7e7bfdb6..497638ea 100644 --- a/sdk-output/generic/common.ts +++ b/sdk-output/generic/common.ts @@ -14,7 +14,6 @@ import type { AxiosInstance, AxiosResponse } from 'axios'; -import axiosRetry from "axios-retry"; import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import { RequiredError } from "./base"; @@ -144,8 +143,7 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const headers = { ...{'User-Agent':'OpenAPI-Generator/1.6.7/ts'}, ...axiosArgs.axiosOptions.headers, @@ -153,7 +151,21 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi } axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath || basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? "API request failed"); + clean.name = "ApiError"; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/global_tenant_security_settings/.gitignore b/sdk-output/global_tenant_security_settings/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/global_tenant_security_settings/.npmignore b/sdk-output/global_tenant_security_settings/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/global_tenant_security_settings/.openapi-generator-ignore b/sdk-output/global_tenant_security_settings/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/global_tenant_security_settings/.openapi-generator/FILES b/sdk-output/global_tenant_security_settings/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/global_tenant_security_settings/.openapi-generator/VERSION b/sdk-output/global_tenant_security_settings/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/global_tenant_security_settings/.sdk-partition b/sdk-output/global_tenant_security_settings/.sdk-partition new file mode 100644 index 00000000..ccfe2e64 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/.sdk-partition @@ -0,0 +1 @@ +global-tenant-security-settings \ No newline at end of file diff --git a/sdk-output/global_tenant_security_settings/README.md b/sdk-output/global_tenant_security_settings/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/global_tenant_security_settings/api.ts b/sdk-output/global_tenant_security_settings/api.ts new file mode 100644 index 00000000..07028b12 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/api.ts @@ -0,0 +1,1306 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Global Tenant Security Settings + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FederationprotocoldetailsV1 + */ +export interface FederationprotocoldetailsV1 { + /** + * Federation protocol role + * @type {string} + * @memberof FederationprotocoldetailsV1 + */ + 'role'?: FederationprotocoldetailsV1RoleV1; + /** + * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). + * @type {string} + * @memberof FederationprotocoldetailsV1 + */ + 'entityId'?: string; +} + +export const FederationprotocoldetailsV1RoleV1 = { + SamlIdp: 'SAML_IDP', + SamlSp: 'SAML_SP' +} as const; + +export type FederationprotocoldetailsV1RoleV1 = typeof FederationprotocoldetailsV1RoleV1[keyof typeof FederationprotocoldetailsV1RoleV1]; + +/** + * + * @export + * @interface GetAuthOrgNetworkConfigV1401ResponseV1 + */ +export interface GetAuthOrgNetworkConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAuthOrgNetworkConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAuthOrgNetworkConfigV1429ResponseV1 + */ +export interface GetAuthOrgNetworkConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAuthOrgNetworkConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface IdpdetailsV1 + */ +export interface IdpdetailsV1 { + /** + * Federation protocol role + * @type {string} + * @memberof IdpdetailsV1 + */ + 'role'?: IdpdetailsV1RoleV1; + /** + * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). + * @type {string} + * @memberof IdpdetailsV1 + */ + 'entityId'?: string; + /** + * Defines the binding used for the SAML flow. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'binding'?: string; + /** + * Specifies the SAML authentication method to use. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'authnContext'?: string; + /** + * The IDP logout URL. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'logoutUrl'?: string; + /** + * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. + * @type {boolean} + * @memberof IdpdetailsV1 + */ + 'includeAuthnContext'?: boolean; + /** + * The name id format to use. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'nameId'?: string; + /** + * + * @type {JitconfigurationV1} + * @memberof IdpdetailsV1 + */ + 'jitConfiguration'?: JitconfigurationV1; + /** + * The Base64-encoded certificate used by the IDP. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'cert'?: string; + /** + * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'loginUrlPost'?: string; + /** + * The IDP Redirect URL. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'loginUrlRedirect'?: string; + /** + * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'mappingAttribute': string; + /** + * The expiration date extracted from the certificate. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'certificateExpirationDate'?: string; + /** + * The name extracted from the certificate. + * @type {string} + * @memberof IdpdetailsV1 + */ + 'certificateName'?: string; +} + +export const IdpdetailsV1RoleV1 = { + SamlIdp: 'SAML_IDP', + SamlSp: 'SAML_SP' +} as const; + +export type IdpdetailsV1RoleV1 = typeof IdpdetailsV1RoleV1[keyof typeof IdpdetailsV1RoleV1]; + +/** + * + * @export + * @interface JitconfigurationV1 + */ +export interface JitconfigurationV1 { + /** + * The indicator for just-in-time provisioning enabled + * @type {boolean} + * @memberof JitconfigurationV1 + */ + 'enabled'?: boolean; + /** + * the sourceId that mapped to just-in-time provisioning configuration + * @type {string} + * @memberof JitconfigurationV1 + */ + 'sourceId'?: string; + /** + * A mapping of identity profile attribute names to SAML assertion attribute names + * @type {{ [key: string]: string; }} + * @memberof JitconfigurationV1 + */ + 'sourceAttributeMappings'?: { [key: string]: string; }; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface LockoutconfigurationV1 + */ +export interface LockoutconfigurationV1 { + /** + * The maximum attempts allowed before lockout occurs. + * @type {number} + * @memberof LockoutconfigurationV1 + */ + 'maximumAttempts'?: number; + /** + * The total time in minutes a user will be locked out. + * @type {number} + * @memberof LockoutconfigurationV1 + */ + 'lockoutDuration'?: number; + /** + * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. + * @type {number} + * @memberof LockoutconfigurationV1 + */ + 'lockoutWindow'?: number; +} +/** + * + * @export + * @interface NetworkconfigurationV1 + */ +export interface NetworkconfigurationV1 { + /** + * The collection of ip ranges. + * @type {Array} + * @memberof NetworkconfigurationV1 + */ + 'range'?: Array | null; + /** + * The collection of country codes. + * @type {Array} + * @memberof NetworkconfigurationV1 + */ + 'geolocation'?: Array | null; + /** + * Denotes whether the provided lists are whitelisted or blacklisted for geo location. + * @type {boolean} + * @memberof NetworkconfigurationV1 + */ + 'whitelisted'?: boolean; +} +/** + * + * @export + * @interface ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ +export interface ServiceproviderconfigurationFederationProtocolDetailsInnerV1 { + /** + * Federation protocol role + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'role'?: ServiceproviderconfigurationFederationProtocolDetailsInnerV1RoleV1; + /** + * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'entityId'?: string; + /** + * Defines the binding used for the SAML flow. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'binding'?: string; + /** + * Specifies the SAML authentication method to use. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'authnContext'?: string; + /** + * The IDP logout URL. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'logoutUrl'?: string; + /** + * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. + * @type {boolean} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'includeAuthnContext'?: boolean; + /** + * The name id format to use. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'nameId'?: string; + /** + * + * @type {JitconfigurationV1} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'jitConfiguration'?: JitconfigurationV1; + /** + * The Base64-encoded certificate used by the IDP. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'cert'?: string; + /** + * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'loginUrlPost'?: string; + /** + * The IDP Redirect URL. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'loginUrlRedirect'?: string; + /** + * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'mappingAttribute': string; + /** + * The expiration date extracted from the certificate. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'certificateExpirationDate'?: string; + /** + * The name extracted from the certificate. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'certificateName'?: string; + /** + * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'alias'?: string; + /** + * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'callbackUrl': string; + /** + * The legacy ACS URL used for SAML authentication. Used with SP configurations. + * @type {string} + * @memberof ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + */ + 'legacyAcsUrl'?: string; +} + +export const ServiceproviderconfigurationFederationProtocolDetailsInnerV1RoleV1 = { + SamlIdp: 'SAML_IDP', + SamlSp: 'SAML_SP' +} as const; + +export type ServiceproviderconfigurationFederationProtocolDetailsInnerV1RoleV1 = typeof ServiceproviderconfigurationFederationProtocolDetailsInnerV1RoleV1[keyof typeof ServiceproviderconfigurationFederationProtocolDetailsInnerV1RoleV1]; + +/** + * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + * @export + * @interface ServiceproviderconfigurationV1 + */ +export interface ServiceproviderconfigurationV1 { + /** + * This determines whether or not the SAML authentication flow is enabled for an org + * @type {boolean} + * @memberof ServiceproviderconfigurationV1 + */ + 'enabled'?: boolean; + /** + * This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. + * @type {boolean} + * @memberof ServiceproviderconfigurationV1 + */ + 'bypassIdp'?: boolean; + /** + * This indicates whether or not the SAML configuration is valid. + * @type {boolean} + * @memberof ServiceproviderconfigurationV1 + */ + 'samlConfigurationValid'?: boolean; + /** + * A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). + * @type {Array} + * @memberof ServiceproviderconfigurationV1 + */ + 'federationProtocolDetails'?: Array; +} +/** + * + * @export + * @interface SessionconfigurationV1 + */ +export interface SessionconfigurationV1 { + /** + * The maximum time in minutes a session can be idle. + * @type {number} + * @memberof SessionconfigurationV1 + */ + 'maxIdleTime'?: number; + /** + * Denotes if \'remember me\' is enabled. + * @type {boolean} + * @memberof SessionconfigurationV1 + */ + 'rememberMe'?: boolean; + /** + * The maximum allowable session time in minutes. + * @type {number} + * @memberof SessionconfigurationV1 + */ + 'maxSessionTime'?: number; +} +/** + * + * @export + * @interface SpdetailsV1 + */ +export interface SpdetailsV1 { + /** + * Federation protocol role + * @type {string} + * @memberof SpdetailsV1 + */ + 'role'?: SpdetailsV1RoleV1; + /** + * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). + * @type {string} + * @memberof SpdetailsV1 + */ + 'entityId'?: string; + /** + * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. + * @type {string} + * @memberof SpdetailsV1 + */ + 'alias'?: string; + /** + * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. + * @type {string} + * @memberof SpdetailsV1 + */ + 'callbackUrl': string; + /** + * The legacy ACS URL used for SAML authentication. Used with SP configurations. + * @type {string} + * @memberof SpdetailsV1 + */ + 'legacyAcsUrl'?: string; +} + +export const SpdetailsV1RoleV1 = { + SamlIdp: 'SAML_IDP', + SamlSp: 'SAML_SP' +} as const; + +export type SpdetailsV1RoleV1 = typeof SpdetailsV1RoleV1[keyof typeof SpdetailsV1RoleV1]; + + +/** + * GlobalTenantSecuritySettingsV1Api - axios parameter creator + * @export + */ +export const GlobalTenantSecuritySettingsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' + * @summary Create security network configuration. + * @param {NetworkconfigurationV1} networkconfigurationV1 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAuthOrgNetworkConfigV1: async (networkconfigurationV1: NetworkconfigurationV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'networkconfigurationV1' is not null or undefined + assertParamExists('createAuthOrgNetworkConfigV1', 'networkconfigurationV1', networkconfigurationV1) + const localVarPath = `/auth-org/v1/network-config`; + // 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(networkconfigurationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the details of an org\'s lockout auth configuration. + * @summary Get auth org lockout configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgLockoutConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/auth-org/v1/lockout-config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the details of an org\'s network auth configuration. + * @summary Get security network configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgNetworkConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/auth-org/v1/network-config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the details of an org\'s service provider auth configuration. + * @summary Get service provider configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgServiceProviderConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/auth-org/v1/service-provider-config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the details of an org\'s session auth configuration. + * @summary Get auth org session configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgSessionConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/auth-org/v1/session-config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing lockout configuration for an org using PATCH + * @summary Update auth org lockout configuration + * @param {Array} jsonpatchoperationV1 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgLockoutConfigV1: async (jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAuthOrgLockoutConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/auth-org/v1/lockout-config`; + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' + * @summary Update security network configuration. + * @param {Array} jsonpatchoperationV1 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgNetworkConfigV1: async (jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAuthOrgNetworkConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/auth-org/v1/network-config`; + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing service provider configuration for an org using PATCH. + * @summary Update service provider configuration + * @param {Array} jsonpatchoperationV1 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgServiceProviderConfigV1: async (jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAuthOrgServiceProviderConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/auth-org/v1/service-provider-config`; + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing session configuration for an org using PATCH. + * @summary Update auth org session configuration + * @param {Array} jsonpatchoperationV1 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgSessionConfigV1: async (jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchAuthOrgSessionConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/auth-org/v1/session-config`; + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * GlobalTenantSecuritySettingsV1Api - functional programming interface + * @export + */ +export const GlobalTenantSecuritySettingsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = GlobalTenantSecuritySettingsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' + * @summary Create security network configuration. + * @param {NetworkconfigurationV1} networkconfigurationV1 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAuthOrgNetworkConfigV1(networkconfigurationV1: NetworkconfigurationV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAuthOrgNetworkConfigV1(networkconfigurationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.createAuthOrgNetworkConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the details of an org\'s lockout auth configuration. + * @summary Get auth org lockout configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgLockoutConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.getAuthOrgLockoutConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the details of an org\'s network auth configuration. + * @summary Get security network configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgNetworkConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.getAuthOrgNetworkConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the details of an org\'s service provider auth configuration. + * @summary Get service provider configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgServiceProviderConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.getAuthOrgServiceProviderConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the details of an org\'s session auth configuration. + * @summary Get auth org session configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgSessionConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.getAuthOrgSessionConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing lockout configuration for an org using PATCH + * @summary Update auth org lockout configuration + * @param {Array} jsonpatchoperationV1 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAuthOrgLockoutConfigV1(jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgLockoutConfigV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.patchAuthOrgLockoutConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' + * @summary Update security network configuration. + * @param {Array} jsonpatchoperationV1 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAuthOrgNetworkConfigV1(jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgNetworkConfigV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.patchAuthOrgNetworkConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing service provider configuration for an org using PATCH. + * @summary Update service provider configuration + * @param {Array} jsonpatchoperationV1 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAuthOrgServiceProviderConfigV1(jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgServiceProviderConfigV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.patchAuthOrgServiceProviderConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing session configuration for an org using PATCH. + * @summary Update auth org session configuration + * @param {Array} jsonpatchoperationV1 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchAuthOrgSessionConfigV1(jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgSessionConfigV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV1Api.patchAuthOrgSessionConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * GlobalTenantSecuritySettingsV1Api - factory interface + * @export + */ +export const GlobalTenantSecuritySettingsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = GlobalTenantSecuritySettingsV1ApiFp(configuration) + return { + /** + * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' + * @summary Create security network configuration. + * @param {GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAuthOrgNetworkConfigV1(requestParameters.networkconfigurationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the details of an org\'s lockout auth configuration. + * @summary Get auth org lockout configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAuthOrgLockoutConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the details of an org\'s network auth configuration. + * @summary Get security network configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAuthOrgNetworkConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the details of an org\'s service provider auth configuration. + * @summary Get service provider configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAuthOrgServiceProviderConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the details of an org\'s session auth configuration. + * @summary Get auth org session configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAuthOrgSessionConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing lockout configuration for an org using PATCH + * @summary Update auth org lockout configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgLockoutConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAuthOrgLockoutConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' + * @summary Update security network configuration. + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAuthOrgNetworkConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing service provider configuration for an org using PATCH. + * @summary Update service provider configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgServiceProviderConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAuthOrgServiceProviderConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing session configuration for an org using PATCH. + * @summary Update auth org session configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchAuthOrgSessionConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchAuthOrgSessionConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createAuthOrgNetworkConfigV1 operation in GlobalTenantSecuritySettingsV1Api. + * @export + * @interface GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request + */ +export interface GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request { + /** + * Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @type {NetworkconfigurationV1} + * @memberof GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1 + */ + readonly networkconfigurationV1: NetworkconfigurationV1 +} + +/** + * Request parameters for patchAuthOrgLockoutConfigV1 operation in GlobalTenantSecuritySettingsV1Api. + * @export + * @interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request + */ +export interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request { + /** + * A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + * @type {Array} + * @memberof GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchAuthOrgNetworkConfigV1 operation in GlobalTenantSecuritySettingsV1Api. + * @export + * @interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request + */ +export interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request { + /** + * A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + * @type {Array} + * @memberof GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchAuthOrgServiceProviderConfigV1 operation in GlobalTenantSecuritySettingsV1Api. + * @export + * @interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request + */ +export interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request { + /** + * A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + * @type {Array} + * @memberof GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchAuthOrgSessionConfigV1 operation in GlobalTenantSecuritySettingsV1Api. + * @export + * @interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request + */ +export interface GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request { + /** + * A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + * @type {Array} + * @memberof GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * GlobalTenantSecuritySettingsV1Api - object-oriented interface + * @export + * @class GlobalTenantSecuritySettingsV1Api + * @extends {BaseAPI} + */ +export class GlobalTenantSecuritySettingsV1Api extends BaseAPI { + /** + * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' + * @summary Create security network configuration. + * @param {GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public createAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiCreateAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).createAuthOrgNetworkConfigV1(requestParameters.networkconfigurationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the details of an org\'s lockout auth configuration. + * @summary Get auth org lockout configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).getAuthOrgLockoutConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the details of an org\'s network auth configuration. + * @summary Get security network configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).getAuthOrgNetworkConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the details of an org\'s service provider auth configuration. + * @summary Get service provider configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).getAuthOrgServiceProviderConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the details of an org\'s session auth configuration. + * @summary Get auth org session configuration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).getAuthOrgSessionConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing lockout configuration for an org using PATCH + * @summary Update auth org lockout configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public patchAuthOrgLockoutConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgLockoutConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).patchAuthOrgLockoutConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' + * @summary Update security network configuration. + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public patchAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).patchAuthOrgNetworkConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing service provider configuration for an org using PATCH. + * @summary Update service provider configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public patchAuthOrgServiceProviderConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgServiceProviderConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).patchAuthOrgServiceProviderConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing session configuration for an org using PATCH. + * @summary Update auth org session configuration + * @param {GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GlobalTenantSecuritySettingsV1Api + */ + public patchAuthOrgSessionConfigV1(requestParameters: GlobalTenantSecuritySettingsV1ApiPatchAuthOrgSessionConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GlobalTenantSecuritySettingsV1ApiFp(this.configuration).patchAuthOrgSessionConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/global_tenant_security_settings/base.ts b/sdk-output/global_tenant_security_settings/base.ts new file mode 100644 index 00000000..c868eb62 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Global Tenant Security Settings + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/global_tenant_security_settings/common.ts b/sdk-output/global_tenant_security_settings/common.ts new file mode 100644 index 00000000..3ae32f29 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Global Tenant Security Settings + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/global_tenant_security_settings/configuration.ts b/sdk-output/global_tenant_security_settings/configuration.ts new file mode 100644 index 00000000..77a8a32a --- /dev/null +++ b/sdk-output/global_tenant_security_settings/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Global Tenant Security Settings + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/global_tenant_security_settings/git_push.sh b/sdk-output/global_tenant_security_settings/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/global_tenant_security_settings/index.ts b/sdk-output/global_tenant_security_settings/index.ts new file mode 100644 index 00000000..2c02e4d3 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Global Tenant Security Settings + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/global_tenant_security_settings/package.json b/sdk-output/global_tenant_security_settings/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/global_tenant_security_settings/tsconfig.json b/sdk-output/global_tenant_security_settings/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/governance_groups/.gitignore b/sdk-output/governance_groups/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/governance_groups/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/governance_groups/.npmignore b/sdk-output/governance_groups/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/governance_groups/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/governance_groups/.openapi-generator-ignore b/sdk-output/governance_groups/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/governance_groups/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/governance_groups/.openapi-generator/FILES b/sdk-output/governance_groups/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/governance_groups/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/governance_groups/.openapi-generator/VERSION b/sdk-output/governance_groups/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/governance_groups/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/governance_groups/.sdk-partition b/sdk-output/governance_groups/.sdk-partition new file mode 100644 index 00000000..e4f010f2 --- /dev/null +++ b/sdk-output/governance_groups/.sdk-partition @@ -0,0 +1 @@ +governance-groups \ No newline at end of file diff --git a/sdk-output/governance_groups/README.md b/sdk-output/governance_groups/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/governance_groups/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/governance_groups/api.ts b/sdk-output/governance_groups/api.ts new file mode 100644 index 00000000..c94904a4 --- /dev/null +++ b/sdk-output/governance_groups/api.ts @@ -0,0 +1,1640 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Governance Groups + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Identity\'s basic details. + * @export + * @interface BulkworkgroupmembersrequestInnerV1 + */ +export interface BulkworkgroupmembersrequestInnerV1 { + /** + * Identity\'s DTO type. + * @type {string} + * @memberof BulkworkgroupmembersrequestInnerV1 + */ + 'type'?: BulkworkgroupmembersrequestInnerV1TypeV1; + /** + * Identity ID. + * @type {string} + * @memberof BulkworkgroupmembersrequestInnerV1 + */ + 'id'?: string; + /** + * Identity\'s display name. + * @type {string} + * @memberof BulkworkgroupmembersrequestInnerV1 + */ + 'name'?: string; +} + +export const BulkworkgroupmembersrequestInnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type BulkworkgroupmembersrequestInnerV1TypeV1 = typeof BulkworkgroupmembersrequestInnerV1TypeV1[keyof typeof BulkworkgroupmembersrequestInnerV1TypeV1]; + +/** + * + * @export + * @interface ConnectedobjectV1 + */ +export interface ConnectedobjectV1 { + /** + * + * @type {ConnectedobjecttypeV1} + * @memberof ConnectedobjectV1 + */ + 'type'?: ConnectedobjecttypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof ConnectedobjectV1 + */ + 'id'?: string; + /** + * Human-readable name of Connected object + * @type {string} + * @memberof ConnectedobjectV1 + */ + 'name'?: string; + /** + * Description of the Connected object. + * @type {string} + * @memberof ConnectedobjectV1 + */ + 'description'?: string | null; +} +/** + * An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. + * @export + * @enum {string} + */ + +export const ConnectedobjecttypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; + +export type ConnectedobjecttypeV1 = typeof ConnectedobjecttypeV1[keyof typeof ConnectedobjecttypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * Identity of workgroup member. + * @export + * @interface ListWorkgroupMembersV1200ResponseInnerV1 + */ +export interface ListWorkgroupMembersV1200ResponseInnerV1 { + /** + * Workgroup member identity DTO type. + * @type {string} + * @memberof ListWorkgroupMembersV1200ResponseInnerV1 + */ + 'type'?: ListWorkgroupMembersV1200ResponseInnerV1TypeV1; + /** + * Workgroup member identity ID. + * @type {string} + * @memberof ListWorkgroupMembersV1200ResponseInnerV1 + */ + 'id'?: string; + /** + * Workgroup member identity display name. + * @type {string} + * @memberof ListWorkgroupMembersV1200ResponseInnerV1 + */ + 'name'?: string; + /** + * Workgroup member identity email. + * @type {string} + * @memberof ListWorkgroupMembersV1200ResponseInnerV1 + */ + 'email'?: string; +} + +export const ListWorkgroupMembersV1200ResponseInnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ListWorkgroupMembersV1200ResponseInnerV1TypeV1 = typeof ListWorkgroupMembersV1200ResponseInnerV1TypeV1[keyof typeof ListWorkgroupMembersV1200ResponseInnerV1TypeV1]; + +/** + * + * @export + * @interface ListWorkgroupsV1401ResponseV1 + */ +export interface ListWorkgroupsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkgroupsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListWorkgroupsV1429ResponseV1 + */ +export interface ListWorkgroupsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkgroupsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner\'s identity. + * @export + * @interface OwnerdtoV1 + */ +export interface OwnerdtoV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'type'?: OwnerdtoV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'name'?: string; +} + +export const OwnerdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerdtoV1TypeV1 = typeof OwnerdtoV1TypeV1[keyof typeof OwnerdtoV1TypeV1]; + +/** + * + * @export + * @interface WorkgroupbulkdeleterequestV1 + */ +export interface WorkgroupbulkdeleterequestV1 { + /** + * List of IDs of Governance Groups to be deleted. + * @type {Array} + * @memberof WorkgroupbulkdeleterequestV1 + */ + 'ids'?: Array; +} +/** + * + * @export + * @interface WorkgroupconnectiondtoObjectV1 + */ +export interface WorkgroupconnectiondtoObjectV1 { + /** + * + * @type {ConnectedobjecttypeV1 & object} + * @memberof WorkgroupconnectiondtoObjectV1 + */ + 'type'?: ConnectedobjecttypeV1 & object; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof WorkgroupconnectiondtoObjectV1 + */ + 'id'?: string; + /** + * Human-readable name of Connected object + * @type {string} + * @memberof WorkgroupconnectiondtoObjectV1 + */ + 'name'?: string; + /** + * Description of the Connected object. + * @type {string} + * @memberof WorkgroupconnectiondtoObjectV1 + */ + 'description'?: string | null; +} +/** + * + * @export + * @interface WorkgroupconnectiondtoV1 + */ +export interface WorkgroupconnectiondtoV1 { + /** + * + * @type {WorkgroupconnectiondtoObjectV1} + * @memberof WorkgroupconnectiondtoV1 + */ + 'object'?: WorkgroupconnectiondtoObjectV1; + /** + * Connection Type. + * @type {string} + * @memberof WorkgroupconnectiondtoV1 + */ + 'connectionType'?: WorkgroupconnectiondtoV1ConnectionTypeV1; +} + +export const WorkgroupconnectiondtoV1ConnectionTypeV1 = { + AccessRequestReviewer: 'AccessRequestReviewer', + Owner: 'Owner', + ManagementWorkgroup: 'ManagementWorkgroup' +} as const; + +export type WorkgroupconnectiondtoV1ConnectionTypeV1 = typeof WorkgroupconnectiondtoV1ConnectionTypeV1[keyof typeof WorkgroupconnectiondtoV1ConnectionTypeV1]; + +/** + * + * @export + * @interface WorkgroupdeleteitemV1 + */ +export interface WorkgroupdeleteitemV1 { + /** + * Id of the Governance Group. + * @type {string} + * @memberof WorkgroupdeleteitemV1 + */ + 'id': string; + /** + * The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. + * @type {number} + * @memberof WorkgroupdeleteitemV1 + */ + 'status': number; + /** + * Human readable status description and containing additional context information about success or failures etc. + * @type {string} + * @memberof WorkgroupdeleteitemV1 + */ + 'description'?: string; +} +/** + * + * @export + * @interface WorkgroupdtoOwnerV1 + */ +export interface WorkgroupdtoOwnerV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof WorkgroupdtoOwnerV1 + */ + 'type'?: WorkgroupdtoOwnerV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof WorkgroupdtoOwnerV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof WorkgroupdtoOwnerV1 + */ + 'name'?: string; + /** + * The display name of the identity + * @type {string} + * @memberof WorkgroupdtoOwnerV1 + */ + 'displayName'?: string; + /** + * The primary email address of the identity + * @type {string} + * @memberof WorkgroupdtoOwnerV1 + */ + 'emailAddress'?: string; +} + +export const WorkgroupdtoOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type WorkgroupdtoOwnerV1TypeV1 = typeof WorkgroupdtoOwnerV1TypeV1[keyof typeof WorkgroupdtoOwnerV1TypeV1]; + +/** + * + * @export + * @interface WorkgroupdtoV1 + */ +export interface WorkgroupdtoV1 { + /** + * + * @type {WorkgroupdtoOwnerV1} + * @memberof WorkgroupdtoV1 + */ + 'owner'?: WorkgroupdtoOwnerV1; + /** + * Governance group ID. + * @type {string} + * @memberof WorkgroupdtoV1 + */ + 'id'?: string; + /** + * Governance group name. + * @type {string} + * @memberof WorkgroupdtoV1 + */ + 'name'?: string; + /** + * Governance group description. + * @type {string} + * @memberof WorkgroupdtoV1 + */ + 'description'?: string; + /** + * Number of members in the governance group. + * @type {number} + * @memberof WorkgroupdtoV1 + */ + 'memberCount'?: number; + /** + * Number of connections in the governance group. + * @type {number} + * @memberof WorkgroupdtoV1 + */ + 'connectionCount'?: number; + /** + * + * @type {string} + * @memberof WorkgroupdtoV1 + */ + 'created'?: string; + /** + * + * @type {string} + * @memberof WorkgroupdtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface WorkgroupmemberadditemV1 + */ +export interface WorkgroupmemberadditemV1 { + /** + * Identifier of identity in bulk member add request. + * @type {string} + * @memberof WorkgroupmemberadditemV1 + */ + 'id': string; + /** + * The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. + * @type {number} + * @memberof WorkgroupmemberadditemV1 + */ + 'status': number; + /** + * Human readable status description and containing additional context information about success or failures etc. + * @type {string} + * @memberof WorkgroupmemberadditemV1 + */ + 'description'?: string; +} +/** + * + * @export + * @interface WorkgroupmemberdeleteitemV1 + */ +export interface WorkgroupmemberdeleteitemV1 { + /** + * Identifier of identity in bulk member add /remove request. + * @type {string} + * @memberof WorkgroupmemberdeleteitemV1 + */ + 'id': string; + /** + * The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. + * @type {number} + * @memberof WorkgroupmemberdeleteitemV1 + */ + 'status': number; + /** + * Human readable status description and containing additional context information about success or failures etc. + * @type {string} + * @memberof WorkgroupmemberdeleteitemV1 + */ + 'description'?: string; +} + +/** + * GovernanceGroupsV1Api - axios parameter creator + * @export + */ +export const GovernanceGroupsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a new Governance Group. + * @summary Create a new governance group. + * @param {WorkgroupdtoV1} workgroupdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkgroupV1: async (workgroupdtoV1: WorkgroupdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupdtoV1' is not null or undefined + assertParamExists('createWorkgroupV1', 'workgroupdtoV1', workgroupdtoV1) + const localVarPath = `/workgroups/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(workgroupdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** + * @summary Remove members from governance group + * @param {string} workgroupId ID of the Governance Group. + * @param {Array} bulkworkgroupmembersrequestInnerV1 List of identities to be removed from a Governance Group members list. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupMembersV1: async (workgroupId: string, bulkworkgroupmembersrequestInnerV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupId' is not null or undefined + assertParamExists('deleteWorkgroupMembersV1', 'workgroupId', workgroupId) + // verify required parameter 'bulkworkgroupmembersrequestInnerV1' is not null or undefined + assertParamExists('deleteWorkgroupMembersV1', 'bulkworkgroupmembersrequestInnerV1', bulkworkgroupmembersrequestInnerV1) + const localVarPath = `/workgroups/v1/{workgroupId}/members/bulk-delete` + .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); + // 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(bulkworkgroupmembersrequestInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes a Governance Group by its ID. + * @summary Delete a governance group + * @param {string} id ID of the Governance Group + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteWorkgroupV1', 'id', id) + const localVarPath = `/workgroups/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, + }; + }, + /** + * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + * @summary Delete governance group(s) + * @param {WorkgroupbulkdeleterequestV1} workgroupbulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupsInBulkV1: async (workgroupbulkdeleterequestV1: WorkgroupbulkdeleterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupbulkdeleterequestV1' is not null or undefined + assertParamExists('deleteWorkgroupsInBulkV1', 'workgroupbulkdeleterequestV1', workgroupbulkdeleterequestV1) + const localVarPath = `/workgroups/v1/bulk-delete`; + // 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(workgroupbulkdeleterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a Governance Groups by its ID. + * @summary Get governance group by id + * @param {string} id ID of the Governance Group + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkgroupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkgroupV1', 'id', id) + const localVarPath = `/workgroups/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, + }; + }, + /** + * This API returns list of connections associated with a Governance Group. + * @summary List connections for governance group + * @param {string} workgroupId ID of the Governance Group. + * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listConnectionsV1: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupId' is not null or undefined + assertParamExists('listConnectionsV1', 'workgroupId', workgroupId) + const localVarPath = `/workgroups/v1/{workgroupId}/connections` + .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); + // 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 (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, + }; + }, + /** + * This API returns list of members associated with a Governance Group. + * @summary List governance group members + * @param {string} workgroupId ID of the Governance Group. + * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkgroupMembersV1: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupId' is not null or undefined + assertParamExists('listWorkgroupMembersV1', 'workgroupId', workgroupId) + const localVarPath = `/workgroups/v1/{workgroupId}/members` + .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); + // 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 (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, + }; + }, + /** + * This API returns list of Governance Groups + * @summary List governance groups + * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* + * @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: **name, created, modified, id, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkgroupsV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workgroups/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; + } + + 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, + }; + }, + /** + * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner + * @summary Patch a governance group + * @param {string} id ID of the Governance Group + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchWorkgroupV1: async (id: string, jsonpatchoperationV1?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchWorkgroupV1', 'id', id) + const localVarPath = `/workgroups/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** + * @summary Add members to governance group + * @param {string} workgroupId ID of the Governance Group. + * @param {Array} bulkworkgroupmembersrequestInnerV1 List of identities to be added to a Governance Group members list. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateWorkgroupMembersV1: async (workgroupId: string, bulkworkgroupmembersrequestInnerV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workgroupId' is not null or undefined + assertParamExists('updateWorkgroupMembersV1', 'workgroupId', workgroupId) + // verify required parameter 'bulkworkgroupmembersrequestInnerV1' is not null or undefined + assertParamExists('updateWorkgroupMembersV1', 'bulkworkgroupmembersrequestInnerV1', bulkworkgroupmembersrequestInnerV1) + const localVarPath = `/workgroups/v1/{workgroupId}/members/bulk-add` + .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); + // 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(bulkworkgroupmembersrequestInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * GovernanceGroupsV1Api - functional programming interface + * @export + */ +export const GovernanceGroupsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = GovernanceGroupsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a new Governance Group. + * @summary Create a new governance group. + * @param {WorkgroupdtoV1} workgroupdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createWorkgroupV1(workgroupdtoV1: WorkgroupdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkgroupV1(workgroupdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.createWorkgroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** + * @summary Remove members from governance group + * @param {string} workgroupId ID of the Governance Group. + * @param {Array} bulkworkgroupmembersrequestInnerV1 List of identities to be removed from a Governance Group members list. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteWorkgroupMembersV1(workgroupId: string, bulkworkgroupmembersrequestInnerV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.deleteWorkgroupMembersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes a Governance Group by its ID. + * @summary Delete a governance group + * @param {string} id ID of the Governance Group + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteWorkgroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.deleteWorkgroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + * @summary Delete governance group(s) + * @param {WorkgroupbulkdeleterequestV1} workgroupbulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteWorkgroupsInBulkV1(workgroupbulkdeleterequestV1: WorkgroupbulkdeleterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupsInBulkV1(workgroupbulkdeleterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.deleteWorkgroupsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a Governance Groups by its ID. + * @summary Get governance group by id + * @param {string} id ID of the Governance Group + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkgroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkgroupV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.getWorkgroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns list of connections associated with a Governance Group. + * @summary List connections for governance group + * @param {string} workgroupId ID of the Governance Group. + * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listConnectionsV1(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listConnectionsV1(workgroupId, offset, limit, count, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.listConnectionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns list of members associated with a Governance Group. + * @summary List governance group members + * @param {string} workgroupId ID of the Governance Group. + * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkgroupMembersV1(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupMembersV1(workgroupId, offset, limit, count, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.listWorkgroupMembersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns list of Governance Groups + * @summary List governance groups + * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* + * @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: **name, created, modified, id, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkgroupsV1(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupsV1(offset, limit, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.listWorkgroupsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner + * @summary Patch a governance group + * @param {string} id ID of the Governance Group + * @param {Array} [jsonpatchoperationV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchWorkgroupV1(id: string, jsonpatchoperationV1?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkgroupV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.patchWorkgroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** + * @summary Add members to governance group + * @param {string} workgroupId ID of the Governance Group. + * @param {Array} bulkworkgroupmembersrequestInnerV1 List of identities to be added to a Governance Group members list. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateWorkgroupMembersV1(workgroupId: string, bulkworkgroupmembersrequestInnerV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV1Api.updateWorkgroupMembersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * GovernanceGroupsV1Api - factory interface + * @export + */ +export const GovernanceGroupsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = GovernanceGroupsV1ApiFp(configuration) + return { + /** + * This API creates a new Governance Group. + * @summary Create a new governance group. + * @param {GovernanceGroupsV1ApiCreateWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkgroupV1(requestParameters: GovernanceGroupsV1ApiCreateWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createWorkgroupV1(requestParameters.workgroupdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** + * @summary Remove members from governance group + * @param {GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.deleteWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.bulkworkgroupmembersrequestInnerV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes a Governance Group by its ID. + * @summary Delete a governance group + * @param {GovernanceGroupsV1ApiDeleteWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteWorkgroupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + * @summary Delete governance group(s) + * @param {GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkgroupsInBulkV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.deleteWorkgroupsInBulkV1(requestParameters.workgroupbulkdeleterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a Governance Groups by its ID. + * @summary Get governance group by id + * @param {GovernanceGroupsV1ApiGetWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkgroupV1(requestParameters: GovernanceGroupsV1ApiGetWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getWorkgroupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns list of connections associated with a Governance Group. + * @summary List connections for governance group + * @param {GovernanceGroupsV1ApiListConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listConnectionsV1(requestParameters: GovernanceGroupsV1ApiListConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listConnectionsV1(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns list of members associated with a Governance Group. + * @summary List governance group members + * @param {GovernanceGroupsV1ApiListWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiListWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns list of Governance Groups + * @summary List governance groups + * @param {GovernanceGroupsV1ApiListWorkgroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkgroupsV1(requestParameters: GovernanceGroupsV1ApiListWorkgroupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkgroupsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner + * @summary Patch a governance group + * @param {GovernanceGroupsV1ApiPatchWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchWorkgroupV1(requestParameters: GovernanceGroupsV1ApiPatchWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchWorkgroupV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** + * @summary Add members to governance group + * @param {GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.updateWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.bulkworkgroupmembersrequestInnerV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createWorkgroupV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiCreateWorkgroupV1Request + */ +export interface GovernanceGroupsV1ApiCreateWorkgroupV1Request { + /** + * + * @type {WorkgroupdtoV1} + * @memberof GovernanceGroupsV1ApiCreateWorkgroupV1 + */ + readonly workgroupdtoV1: WorkgroupdtoV1 +} + +/** + * Request parameters for deleteWorkgroupMembersV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request + */ +export interface GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request { + /** + * ID of the Governance Group. + * @type {string} + * @memberof GovernanceGroupsV1ApiDeleteWorkgroupMembersV1 + */ + readonly workgroupId: string + + /** + * List of identities to be removed from a Governance Group members list. + * @type {Array} + * @memberof GovernanceGroupsV1ApiDeleteWorkgroupMembersV1 + */ + readonly bulkworkgroupmembersrequestInnerV1: Array +} + +/** + * Request parameters for deleteWorkgroupV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiDeleteWorkgroupV1Request + */ +export interface GovernanceGroupsV1ApiDeleteWorkgroupV1Request { + /** + * ID of the Governance Group + * @type {string} + * @memberof GovernanceGroupsV1ApiDeleteWorkgroupV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteWorkgroupsInBulkV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request + */ +export interface GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request { + /** + * + * @type {WorkgroupbulkdeleterequestV1} + * @memberof GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1 + */ + readonly workgroupbulkdeleterequestV1: WorkgroupbulkdeleterequestV1 +} + +/** + * Request parameters for getWorkgroupV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiGetWorkgroupV1Request + */ +export interface GovernanceGroupsV1ApiGetWorkgroupV1Request { + /** + * ID of the Governance Group + * @type {string} + * @memberof GovernanceGroupsV1ApiGetWorkgroupV1 + */ + readonly id: string +} + +/** + * Request parameters for listConnectionsV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiListConnectionsV1Request + */ +export interface GovernanceGroupsV1ApiListConnectionsV1Request { + /** + * ID of the Governance Group. + * @type {string} + * @memberof GovernanceGroupsV1ApiListConnectionsV1 + */ + readonly workgroupId: string + + /** + * 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 GovernanceGroupsV1ApiListConnectionsV1 + */ + readonly offset?: number + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof GovernanceGroupsV1ApiListConnectionsV1 + */ + 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 GovernanceGroupsV1ApiListConnectionsV1 + */ + readonly count?: boolean + + /** + * 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: **name, created, modified** + * @type {string} + * @memberof GovernanceGroupsV1ApiListConnectionsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listWorkgroupMembersV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiListWorkgroupMembersV1Request + */ +export interface GovernanceGroupsV1ApiListWorkgroupMembersV1Request { + /** + * ID of the Governance Group. + * @type {string} + * @memberof GovernanceGroupsV1ApiListWorkgroupMembersV1 + */ + readonly workgroupId: string + + /** + * 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 GovernanceGroupsV1ApiListWorkgroupMembersV1 + */ + readonly offset?: number + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof GovernanceGroupsV1ApiListWorkgroupMembersV1 + */ + 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 GovernanceGroupsV1ApiListWorkgroupMembersV1 + */ + readonly count?: boolean + + /** + * 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: **name, created, modified** + * @type {string} + * @memberof GovernanceGroupsV1ApiListWorkgroupMembersV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listWorkgroupsV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiListWorkgroupsV1Request + */ +export interface GovernanceGroupsV1ApiListWorkgroupsV1Request { + /** + * 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 GovernanceGroupsV1ApiListWorkgroupsV1 + */ + 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 GovernanceGroupsV1ApiListWorkgroupsV1 + */ + 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 GovernanceGroupsV1ApiListWorkgroupsV1 + */ + 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* + * @type {string} + * @memberof GovernanceGroupsV1ApiListWorkgroupsV1 + */ + 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: **name, created, modified, id, description** + * @type {string} + * @memberof GovernanceGroupsV1ApiListWorkgroupsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchWorkgroupV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiPatchWorkgroupV1Request + */ +export interface GovernanceGroupsV1ApiPatchWorkgroupV1Request { + /** + * ID of the Governance Group + * @type {string} + * @memberof GovernanceGroupsV1ApiPatchWorkgroupV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof GovernanceGroupsV1ApiPatchWorkgroupV1 + */ + readonly jsonpatchoperationV1?: Array +} + +/** + * Request parameters for updateWorkgroupMembersV1 operation in GovernanceGroupsV1Api. + * @export + * @interface GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request + */ +export interface GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request { + /** + * ID of the Governance Group. + * @type {string} + * @memberof GovernanceGroupsV1ApiUpdateWorkgroupMembersV1 + */ + readonly workgroupId: string + + /** + * List of identities to be added to a Governance Group members list. + * @type {Array} + * @memberof GovernanceGroupsV1ApiUpdateWorkgroupMembersV1 + */ + readonly bulkworkgroupmembersrequestInnerV1: Array +} + +/** + * GovernanceGroupsV1Api - object-oriented interface + * @export + * @class GovernanceGroupsV1Api + * @extends {BaseAPI} + */ +export class GovernanceGroupsV1Api extends BaseAPI { + /** + * This API creates a new Governance Group. + * @summary Create a new governance group. + * @param {GovernanceGroupsV1ApiCreateWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public createWorkgroupV1(requestParameters: GovernanceGroupsV1ApiCreateWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).createWorkgroupV1(requestParameters.workgroupdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** + * @summary Remove members from governance group + * @param {GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public deleteWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).deleteWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.bulkworkgroupmembersrequestInnerV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes a Governance Group by its ID. + * @summary Delete a governance group + * @param {GovernanceGroupsV1ApiDeleteWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public deleteWorkgroupV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).deleteWorkgroupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + * @summary Delete governance group(s) + * @param {GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public deleteWorkgroupsInBulkV1(requestParameters: GovernanceGroupsV1ApiDeleteWorkgroupsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).deleteWorkgroupsInBulkV1(requestParameters.workgroupbulkdeleterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a Governance Groups by its ID. + * @summary Get governance group by id + * @param {GovernanceGroupsV1ApiGetWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public getWorkgroupV1(requestParameters: GovernanceGroupsV1ApiGetWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).getWorkgroupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns list of connections associated with a Governance Group. + * @summary List connections for governance group + * @param {GovernanceGroupsV1ApiListConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public listConnectionsV1(requestParameters: GovernanceGroupsV1ApiListConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).listConnectionsV1(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns list of members associated with a Governance Group. + * @summary List governance group members + * @param {GovernanceGroupsV1ApiListWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public listWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiListWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).listWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns list of Governance Groups + * @summary List governance groups + * @param {GovernanceGroupsV1ApiListWorkgroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public listWorkgroupsV1(requestParameters: GovernanceGroupsV1ApiListWorkgroupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).listWorkgroupsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner + * @summary Patch a governance group + * @param {GovernanceGroupsV1ApiPatchWorkgroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public patchWorkgroupV1(requestParameters: GovernanceGroupsV1ApiPatchWorkgroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).patchWorkgroupV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** + * @summary Add members to governance group + * @param {GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof GovernanceGroupsV1Api + */ + public updateWorkgroupMembersV1(requestParameters: GovernanceGroupsV1ApiUpdateWorkgroupMembersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return GovernanceGroupsV1ApiFp(this.configuration).updateWorkgroupMembersV1(requestParameters.workgroupId, requestParameters.bulkworkgroupmembersrequestInnerV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/governance_groups/base.ts b/sdk-output/governance_groups/base.ts new file mode 100644 index 00000000..2dc47f3c --- /dev/null +++ b/sdk-output/governance_groups/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Governance Groups + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/governance_groups/common.ts b/sdk-output/governance_groups/common.ts new file mode 100644 index 00000000..719d41fd --- /dev/null +++ b/sdk-output/governance_groups/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Governance Groups + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/governance_groups/configuration.ts b/sdk-output/governance_groups/configuration.ts new file mode 100644 index 00000000..58c727cf --- /dev/null +++ b/sdk-output/governance_groups/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Governance Groups + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/governance_groups/git_push.sh b/sdk-output/governance_groups/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/governance_groups/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/governance_groups/index.ts b/sdk-output/governance_groups/index.ts new file mode 100644 index 00000000..209cdae4 --- /dev/null +++ b/sdk-output/governance_groups/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Governance Groups + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/governance_groups/package.json b/sdk-output/governance_groups/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/governance_groups/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/governance_groups/tsconfig.json b/sdk-output/governance_groups/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/governance_groups/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_access_request_recommendations/.gitignore b/sdk-output/iai_access_request_recommendations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_access_request_recommendations/.npmignore b/sdk-output/iai_access_request_recommendations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_access_request_recommendations/.openapi-generator-ignore b/sdk-output/iai_access_request_recommendations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES b/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_access_request_recommendations/.openapi-generator/VERSION b/sdk-output/iai_access_request_recommendations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_access_request_recommendations/.sdk-partition b/sdk-output/iai_access_request_recommendations/.sdk-partition new file mode 100644 index 00000000..62b01b27 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/.sdk-partition @@ -0,0 +1 @@ +iai-access-request-recommendations \ No newline at end of file diff --git a/sdk-output/iai_access_request_recommendations/README.md b/sdk-output/iai_access_request_recommendations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_access_request_recommendations/api.ts b/sdk-output/iai_access_request_recommendations/api.ts new file mode 100644 index 00000000..d569e3f1 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/api.ts @@ -0,0 +1,1625 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Access Request Recommendations + * 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 AccessrecommendationmessageV1 + */ +export interface AccessrecommendationmessageV1 { + /** + * Information about why the access item was recommended. + * @type {string} + * @memberof AccessrecommendationmessageV1 + */ + 'interpretation'?: string; +} +/** + * + * @export + * @interface AccessrequestrecommendationactionitemdtoV1 + */ +export interface AccessrequestrecommendationactionitemdtoV1 { + /** + * The identity ID taking the action. + * @type {string} + * @memberof AccessrequestrecommendationactionitemdtoV1 + */ + 'identityId': string; + /** + * + * @type {AccessrequestrecommendationitemV1} + * @memberof AccessrequestrecommendationactionitemdtoV1 + */ + 'access': AccessrequestrecommendationitemV1; +} +/** + * + * @export + * @interface AccessrequestrecommendationactionitemresponsedtoV1 + */ +export interface AccessrequestrecommendationactionitemresponsedtoV1 { + /** + * The identity ID taking the action. + * @type {string} + * @memberof AccessrequestrecommendationactionitemresponsedtoV1 + */ + 'identityId'?: string; + /** + * + * @type {AccessrequestrecommendationitemV1} + * @memberof AccessrequestrecommendationactionitemresponsedtoV1 + */ + 'access'?: AccessrequestrecommendationitemV1; + /** + * + * @type {string} + * @memberof AccessrequestrecommendationactionitemresponsedtoV1 + */ + 'timestamp'?: string; +} +/** + * + * @export + * @interface AccessrequestrecommendationconfigdtoV1 + */ +export interface AccessrequestrecommendationconfigdtoV1 { + /** + * The value that internal calculations need to exceed for recommendations to be made. + * @type {number} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'scoreThreshold': number; + /** + * Use to map an attribute name for determining identities\' start date. + * @type {string} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'startDateAttribute'?: string; + /** + * Use to only give recommendations based on this attribute. + * @type {string} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'restrictionAttribute'?: string; + /** + * Use to map an attribute name for determining whether identities are movers. + * @type {string} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'moverAttribute'?: string; + /** + * Use to map an attribute name for determining whether identities are joiners. + * @type {string} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'joinerAttribute'?: string; + /** + * Use only the attribute named in restrictionAttribute to make recommendations. + * @type {boolean} + * @memberof AccessrequestrecommendationconfigdtoV1 + */ + 'useRestrictionAttribute'?: boolean; +} +/** + * + * @export + * @interface AccessrequestrecommendationitemV1 + */ +export interface AccessrequestrecommendationitemV1 { + /** + * ID of access item being recommended. + * @type {string} + * @memberof AccessrequestrecommendationitemV1 + */ + 'id'?: string; + /** + * + * @type {AccessrequestrecommendationitemtypeV1} + * @memberof AccessrequestrecommendationitemV1 + */ + 'type'?: AccessrequestrecommendationitemtypeV1; +} + + +/** + * + * @export + * @interface AccessrequestrecommendationitemdetailAccessV1 + */ +export interface AccessrequestrecommendationitemdetailAccessV1 { + /** + * ID of access item being recommended. + * @type {string} + * @memberof AccessrequestrecommendationitemdetailAccessV1 + */ + 'id'?: string; + /** + * + * @type {AccessrequestrecommendationitemtypeV1} + * @memberof AccessrequestrecommendationitemdetailAccessV1 + */ + 'type'?: AccessrequestrecommendationitemtypeV1; + /** + * Name of the access item + * @type {string} + * @memberof AccessrequestrecommendationitemdetailAccessV1 + */ + 'name'?: string; + /** + * Description of the access item + * @type {string} + * @memberof AccessrequestrecommendationitemdetailAccessV1 + */ + 'description'?: string; +} + + +/** + * + * @export + * @interface AccessrequestrecommendationitemdetailV1 + */ +export interface AccessrequestrecommendationitemdetailV1 { + /** + * Identity ID for the recommendation + * @type {string} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'identityId'?: string; + /** + * + * @type {AccessrequestrecommendationitemdetailAccessV1} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'access'?: AccessrequestrecommendationitemdetailAccessV1; + /** + * Whether or not the identity has already chosen to ignore this recommendation. + * @type {boolean} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'ignored'?: boolean; + /** + * Whether or not the identity has already chosen to request this recommendation. + * @type {boolean} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'requested'?: boolean; + /** + * Whether or not the identity reportedly viewed this recommendation. + * @type {boolean} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'viewed'?: boolean; + /** + * + * @type {Array} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'messages'?: Array; + /** + * The list of translation messages + * @type {Array} + * @memberof AccessrequestrecommendationitemdetailV1 + */ + 'translationMessages'?: Array; +} +/** + * The type of access item. + * @export + * @enum {string} + */ + +export const AccessrequestrecommendationitemtypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; + +export type AccessrequestrecommendationitemtypeV1 = typeof AccessrequestrecommendationitemtypeV1[keyof typeof AccessrequestrecommendationitemtypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAccessRequestRecommendationsV1401ResponseV1 + */ +export interface GetAccessRequestRecommendationsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestRecommendationsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAccessRequestRecommendationsV1429ResponseV1 + */ +export interface GetAccessRequestRecommendationsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAccessRequestRecommendationsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface TranslationmessageV1 + */ +export interface TranslationmessageV1 { + /** + * The key of the translation message + * @type {string} + * @memberof TranslationmessageV1 + */ + 'key'?: string; + /** + * The values corresponding to the translation messages + * @type {Array} + * @memberof TranslationmessageV1 + */ + 'values'?: Array; +} + +/** + * IAIAccessRequestRecommendationsV1Api - axios parameter creator + * @export + */ +export const IAIAccessRequestRecommendationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + * @summary Ignore access request recommendation + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access item to ignore for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsIgnoredItemV1: async (accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestrecommendationactionitemdtoV1' is not null or undefined + assertParamExists('addAccessRequestRecommendationsIgnoredItemV1', 'accessrequestrecommendationactionitemdtoV1', accessrequestrecommendationactionitemdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/ignored-items`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessrequestrecommendationactionitemdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + * @summary Accept access request recommendation + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access item that was requested for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsRequestedItemV1: async (accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestrecommendationactionitemdtoV1' is not null or undefined + assertParamExists('addAccessRequestRecommendationsRequestedItemV1', 'accessrequestrecommendationactionitemdtoV1', accessrequestrecommendationactionitemdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/requested-items`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessrequestrecommendationactionitemdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Mark viewed access request recommendations + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access that was viewed for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsViewedItemV1: async (accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestrecommendationactionitemdtoV1' is not null or undefined + assertParamExists('addAccessRequestRecommendationsViewedItemV1', 'accessrequestrecommendationactionitemdtoV1', accessrequestrecommendationactionitemdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/viewed-items`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessrequestrecommendationactionitemdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Bulk mark viewed access request recommendations + * @param {Array} accessrequestrecommendationactionitemdtoV1 The recommended access items that were viewed for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsViewedItemsV1: async (accessrequestrecommendationactionitemdtoV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestrecommendationactionitemdtoV1' is not null or undefined + assertParamExists('addAccessRequestRecommendationsViewedItemsV1', 'accessrequestrecommendationactionitemdtoV1', accessrequestrecommendationactionitemdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/viewed-items/bulk-create`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessrequestrecommendationactionitemdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the configurations for Access Request Recommender for the tenant. + * @summary Get access request recommendations config + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsConfigV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/config`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of ignored access request recommendations. + * @summary List ignored access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsIgnoredItemsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/ignored-items`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of requested access request recommendations. + * @summary List accepted access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsRequestedItemsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/requested-items`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + * @summary Identity access request recommendations + * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. + * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* + * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsV1: async (identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/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 (identityId !== undefined) { + localVarQueryParameter['identity-id'] = identityId; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (includeTranslationMessages !== undefined) { + localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the list of viewed access request recommendations. + * @summary List viewed access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsViewedItemsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/viewed-items`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates the configurations for Access Request Recommender for the tenant. + * @summary Update access request recommendations config + * @param {AccessrequestrecommendationconfigdtoV1} accessrequestrecommendationconfigdtoV1 The desired configurations for Access Request Recommender for the tenant. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setAccessRequestRecommendationsConfigV1: async (accessrequestrecommendationconfigdtoV1: AccessrequestrecommendationconfigdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'accessrequestrecommendationconfigdtoV1' is not null or undefined + assertParamExists('setAccessRequestRecommendationsConfigV1', 'accessrequestrecommendationconfigdtoV1', accessrequestrecommendationconfigdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ai-access-request-recommendations/v1/config`; + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(accessrequestrecommendationconfigdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAIAccessRequestRecommendationsV1Api - functional programming interface + * @export + */ +export const IAIAccessRequestRecommendationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAIAccessRequestRecommendationsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + * @summary Ignore access request recommendation + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access item to ignore for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async addAccessRequestRecommendationsIgnoredItemV1(accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsIgnoredItemV1(accessrequestrecommendationactionitemdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.addAccessRequestRecommendationsIgnoredItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + * @summary Accept access request recommendation + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access item that was requested for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async addAccessRequestRecommendationsRequestedItemV1(accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsRequestedItemV1(accessrequestrecommendationactionitemdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.addAccessRequestRecommendationsRequestedItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Mark viewed access request recommendations + * @param {AccessrequestrecommendationactionitemdtoV1} accessrequestrecommendationactionitemdtoV1 The recommended access that was viewed for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async addAccessRequestRecommendationsViewedItemV1(accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItemV1(accessrequestrecommendationactionitemdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.addAccessRequestRecommendationsViewedItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Bulk mark viewed access request recommendations + * @param {Array} accessrequestrecommendationactionitemdtoV1 The recommended access items that were viewed for an identity. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async addAccessRequestRecommendationsViewedItemsV1(accessrequestrecommendationactionitemdtoV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItemsV1(accessrequestrecommendationactionitemdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.addAccessRequestRecommendationsViewedItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the configurations for Access Request Recommender for the tenant. + * @summary Get access request recommendations config + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestRecommendationsConfigV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsConfigV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.getAccessRequestRecommendationsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of ignored access request recommendations. + * @summary List ignored access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestRecommendationsIgnoredItemsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsIgnoredItemsV1(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.getAccessRequestRecommendationsIgnoredItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of requested access request recommendations. + * @summary List accepted access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestRecommendationsRequestedItemsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsRequestedItemsV1(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.getAccessRequestRecommendationsRequestedItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + * @summary Identity access request recommendations + * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. + * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* + * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestRecommendationsV1(identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsV1(identityId, limit, offset, count, includeTranslationMessages, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.getAccessRequestRecommendationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the list of viewed access request recommendations. + * @summary List viewed access request recommendations + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @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: **access.id, access.type, identityId, timestamp** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccessRequestRecommendationsViewedItemsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsViewedItemsV1(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.getAccessRequestRecommendationsViewedItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates the configurations for Access Request Recommender for the tenant. + * @summary Update access request recommendations config + * @param {AccessrequestrecommendationconfigdtoV1} accessrequestrecommendationconfigdtoV1 The desired configurations for Access Request Recommender for the tenant. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setAccessRequestRecommendationsConfigV1(accessrequestrecommendationconfigdtoV1: AccessrequestrecommendationconfigdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestRecommendationsConfigV1(accessrequestrecommendationconfigdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV1Api.setAccessRequestRecommendationsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAIAccessRequestRecommendationsV1Api - factory interface + * @export + */ +export const IAIAccessRequestRecommendationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAIAccessRequestRecommendationsV1ApiFp(configuration) + return { + /** + * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + * @summary Ignore access request recommendation + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsIgnoredItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.addAccessRequestRecommendationsIgnoredItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + * @summary Accept access request recommendation + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsRequestedItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.addAccessRequestRecommendationsRequestedItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Mark viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsViewedItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.addAccessRequestRecommendationsViewedItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Bulk mark viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + addAccessRequestRecommendationsViewedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.addAccessRequestRecommendationsViewedItemsV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the configurations for Access Request Recommender for the tenant. + * @summary Get access request recommendations config + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsConfigV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccessRequestRecommendationsConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of ignored access request recommendations. + * @summary List ignored access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsIgnoredItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccessRequestRecommendationsIgnoredItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of requested access request recommendations. + * @summary List accepted access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsRequestedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccessRequestRecommendationsRequestedItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + * @summary Identity access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccessRequestRecommendationsV1(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the list of viewed access request recommendations. + * @summary List viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccessRequestRecommendationsViewedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAccessRequestRecommendationsViewedItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates the configurations for Access Request Recommender for the tenant. + * @summary Update access request recommendations config + * @param {IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setAccessRequestRecommendationsConfigV1(requestParameters: IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setAccessRequestRecommendationsConfigV1(requestParameters.accessrequestrecommendationconfigdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for addAccessRequestRecommendationsIgnoredItemV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request { + /** + * The recommended access item to ignore for an identity. + * @type {AccessrequestrecommendationactionitemdtoV1} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1 + */ + readonly accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for addAccessRequestRecommendationsRequestedItemV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request { + /** + * The recommended access item that was requested for an identity. + * @type {AccessrequestrecommendationactionitemdtoV1} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1 + */ + readonly accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for addAccessRequestRecommendationsViewedItemV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request { + /** + * The recommended access that was viewed for an identity. + * @type {AccessrequestrecommendationactionitemdtoV1} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1 + */ + readonly accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for addAccessRequestRecommendationsViewedItemsV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request { + /** + * The recommended access items that were viewed for an identity. + * @type {Array} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1 + */ + readonly accessrequestrecommendationactionitemdtoV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAccessRequestRecommendationsConfigV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAccessRequestRecommendationsIgnoredItemsV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request { + /** + * 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 IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + 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: **access.id, access.type, identityId, timestamp** + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAccessRequestRecommendationsRequestedItemsV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request { + /** + * 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 IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + 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: **access.id, access.type, identityId, timestamp** + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAccessRequestRecommendationsV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request { + /** + * Get access request recommendations for an identityId. *me* indicates the current user. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly identityId?: string + + /** + * Max number of results to return. + * @type {number} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly count?: boolean + + /** + * If *true* it will populate a list of translation messages in the response. + * @type {boolean} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly includeTranslationMessages?: 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAccessRequestRecommendationsViewedItemsV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request { + /** + * 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 IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + 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: **access.id, access.type, identityId, timestamp** + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setAccessRequestRecommendationsConfigV1 operation in IAIAccessRequestRecommendationsV1Api. + * @export + * @interface IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request + */ +export interface IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request { + /** + * The desired configurations for Access Request Recommender for the tenant. + * @type {AccessrequestrecommendationconfigdtoV1} + * @memberof IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1 + */ + readonly accessrequestrecommendationconfigdtoV1: AccessrequestrecommendationconfigdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAIAccessRequestRecommendationsV1Api - object-oriented interface + * @export + * @class IAIAccessRequestRecommendationsV1Api + * @extends {BaseAPI} + */ +export class IAIAccessRequestRecommendationsV1Api extends BaseAPI { + /** + * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + * @summary Ignore access request recommendation + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public addAccessRequestRecommendationsIgnoredItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsIgnoredItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).addAccessRequestRecommendationsIgnoredItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + * @summary Accept access request recommendation + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public addAccessRequestRecommendationsRequestedItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsRequestedItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).addAccessRequestRecommendationsRequestedItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Mark viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public addAccessRequestRecommendationsViewedItemV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).addAccessRequestRecommendationsViewedItemV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + * @summary Bulk mark viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public addAccessRequestRecommendationsViewedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiAddAccessRequestRecommendationsViewedItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).addAccessRequestRecommendationsViewedItemsV1(requestParameters.accessrequestrecommendationactionitemdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the configurations for Access Request Recommender for the tenant. + * @summary Get access request recommendations config + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public getAccessRequestRecommendationsConfigV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).getAccessRequestRecommendationsConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of ignored access request recommendations. + * @summary List ignored access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public getAccessRequestRecommendationsIgnoredItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsIgnoredItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).getAccessRequestRecommendationsIgnoredItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of requested access request recommendations. + * @summary List accepted access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public getAccessRequestRecommendationsRequestedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsRequestedItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).getAccessRequestRecommendationsRequestedItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + * @summary Identity access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public getAccessRequestRecommendationsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).getAccessRequestRecommendationsV1(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the list of viewed access request recommendations. + * @summary List viewed access request recommendations + * @param {IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public getAccessRequestRecommendationsViewedItemsV1(requestParameters: IAIAccessRequestRecommendationsV1ApiGetAccessRequestRecommendationsViewedItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).getAccessRequestRecommendationsViewedItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates the configurations for Access Request Recommender for the tenant. + * @summary Update access request recommendations config + * @param {IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIAccessRequestRecommendationsV1Api + */ + public setAccessRequestRecommendationsConfigV1(requestParameters: IAIAccessRequestRecommendationsV1ApiSetAccessRequestRecommendationsConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIAccessRequestRecommendationsV1ApiFp(this.configuration).setAccessRequestRecommendationsConfigV1(requestParameters.accessrequestrecommendationconfigdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/iai_access_request_recommendations/base.ts b/sdk-output/iai_access_request_recommendations/base.ts new file mode 100644 index 00000000..db323893 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Access Request Recommendations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_access_request_recommendations/common.ts b/sdk-output/iai_access_request_recommendations/common.ts new file mode 100644 index 00000000..27714f3e --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Access Request Recommendations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_access_request_recommendations/configuration.ts b/sdk-output/iai_access_request_recommendations/configuration.ts new file mode 100644 index 00000000..23caf3fd --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Access Request Recommendations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_access_request_recommendations/git_push.sh b/sdk-output/iai_access_request_recommendations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_access_request_recommendations/index.ts b/sdk-output/iai_access_request_recommendations/index.ts new file mode 100644 index 00000000..ae4fad8c --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Access Request Recommendations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_access_request_recommendations/package.json b/sdk-output/iai_access_request_recommendations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_access_request_recommendations/tsconfig.json b/sdk-output/iai_access_request_recommendations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_common_access/.gitignore b/sdk-output/iai_common_access/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_common_access/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_common_access/.npmignore b/sdk-output/iai_common_access/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_common_access/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_common_access/.openapi-generator-ignore b/sdk-output/iai_common_access/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_common_access/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_common_access/.openapi-generator/FILES b/sdk-output/iai_common_access/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_common_access/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_common_access/.openapi-generator/VERSION b/sdk-output/iai_common_access/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_common_access/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_common_access/.sdk-partition b/sdk-output/iai_common_access/.sdk-partition new file mode 100644 index 00000000..9f4859a3 --- /dev/null +++ b/sdk-output/iai_common_access/.sdk-partition @@ -0,0 +1 @@ +iai-common-access \ No newline at end of file diff --git a/sdk-output/iai_common_access/README.md b/sdk-output/iai_common_access/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_common_access/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_common_access/api.ts b/sdk-output/iai_common_access/api.ts new file mode 100644 index 00000000..f81ea289 --- /dev/null +++ b/sdk-output/iai_common_access/api.ts @@ -0,0 +1,736 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Common Access + * 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 CommonaccessidstatusV1 + */ +export interface CommonaccessidstatusV1 { + /** + * List of confirmed common access ids. + * @type {Array} + * @memberof CommonaccessidstatusV1 + */ + 'confirmedIds'?: Array; + /** + * List of denied common access ids. + * @type {Array} + * @memberof CommonaccessidstatusV1 + */ + 'deniedIds'?: Array; +} +/** + * + * @export + * @interface CommonaccessitemaccessV1 + */ +export interface CommonaccessitemaccessV1 { + /** + * Common access ID + * @type {string} + * @memberof CommonaccessitemaccessV1 + */ + 'id'?: string; + /** + * + * @type {CommonaccesstypeV1} + * @memberof CommonaccessitemaccessV1 + */ + 'type'?: CommonaccesstypeV1; + /** + * Common access name + * @type {string} + * @memberof CommonaccessitemaccessV1 + */ + 'name'?: string; + /** + * Common access description + * @type {string} + * @memberof CommonaccessitemaccessV1 + */ + 'description'?: string | null; + /** + * Common access owner name + * @type {string} + * @memberof CommonaccessitemaccessV1 + */ + 'ownerName'?: string; + /** + * Common access owner ID + * @type {string} + * @memberof CommonaccessitemaccessV1 + */ + 'ownerId'?: string; +} + + +/** + * + * @export + * @interface CommonaccessitemrequestV1 + */ +export interface CommonaccessitemrequestV1 { + /** + * + * @type {CommonaccessitemaccessV1} + * @memberof CommonaccessitemrequestV1 + */ + 'access'?: CommonaccessitemaccessV1; + /** + * + * @type {CommonaccessitemstateV1} + * @memberof CommonaccessitemrequestV1 + */ + 'status'?: CommonaccessitemstateV1; +} + + +/** + * + * @export + * @interface CommonaccessitemresponseV1 + */ +export interface CommonaccessitemresponseV1 { + /** + * Common Access Item ID + * @type {string} + * @memberof CommonaccessitemresponseV1 + */ + 'id'?: string; + /** + * + * @type {CommonaccessitemaccessV1} + * @memberof CommonaccessitemresponseV1 + */ + 'access'?: CommonaccessitemaccessV1; + /** + * + * @type {CommonaccessitemstateV1} + * @memberof CommonaccessitemresponseV1 + */ + 'status'?: CommonaccessitemstateV1; + /** + * + * @type {string} + * @memberof CommonaccessitemresponseV1 + */ + 'lastUpdated'?: string; + /** + * + * @type {boolean} + * @memberof CommonaccessitemresponseV1 + */ + 'reviewedByUser'?: boolean; + /** + * + * @type {string} + * @memberof CommonaccessitemresponseV1 + */ + 'lastReviewed'?: string; + /** + * + * @type {string} + * @memberof CommonaccessitemresponseV1 + */ + 'createdByUser'?: string; +} + + +/** + * State of common access item. + * @export + * @enum {string} + */ + +export const CommonaccessitemstateV1 = { + Confirmed: 'CONFIRMED', + Denied: 'DENIED' +} as const; + +export type CommonaccessitemstateV1 = typeof CommonaccessitemstateV1[keyof typeof CommonaccessitemstateV1]; + + +/** + * + * @export + * @interface CommonaccessresponseV1 + */ +export interface CommonaccessresponseV1 { + /** + * Unique ID of the common access item + * @type {string} + * @memberof CommonaccessresponseV1 + */ + 'id'?: string; + /** + * + * @type {CommonaccessitemaccessV1} + * @memberof CommonaccessresponseV1 + */ + 'access'?: CommonaccessitemaccessV1; + /** + * CONFIRMED or DENIED + * @type {string} + * @memberof CommonaccessresponseV1 + */ + 'status'?: string; + /** + * + * @type {string} + * @memberof CommonaccessresponseV1 + */ + 'commonAccessType'?: string; + /** + * + * @type {string} + * @memberof CommonaccessresponseV1 + */ + 'lastUpdated'?: string; + /** + * true if user has confirmed or denied status + * @type {boolean} + * @memberof CommonaccessresponseV1 + */ + 'reviewedByUser'?: boolean; + /** + * + * @type {string} + * @memberof CommonaccessresponseV1 + */ + 'lastReviewed'?: string | null; + /** + * + * @type {boolean} + * @memberof CommonaccessresponseV1 + */ + 'createdByUser'?: boolean; +} +/** + * The type of access item. + * @export + * @enum {string} + */ + +export const CommonaccesstypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; + +export type CommonaccesstypeV1 = typeof CommonaccesstypeV1[keyof typeof CommonaccesstypeV1]; + + +/** + * + * @export + * @interface CreateCommonAccessV1429ResponseV1 + */ +export interface CreateCommonAccessV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateCommonAccessV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetCommonAccessV1401ResponseV1 + */ +export interface GetCommonAccessV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetCommonAccessV1401ResponseV1 + */ + 'error'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * IAICommonAccessV1Api - axios parameter creator + * @export + */ +export const IAICommonAccessV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + * @summary Create common access items + * @param {CommonaccessitemrequestV1} commonaccessitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCommonAccessV1: async (commonaccessitemrequestV1: CommonaccessitemrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'commonaccessitemrequestV1' is not null or undefined + assertParamExists('createCommonAccessV1', 'commonaccessitemrequestV1', commonaccessitemrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/common-access/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(commonaccessitemrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + * @summary Get a paginated list of common access + * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* + * @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: **access.name, status** By default the common access items are sorted by name, ascending. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCommonAccessV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/common-access/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; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + * @summary Bulk update common access status + * @param {Array} commonaccessidstatusV1 Confirm or deny in bulk the common access ids that are (or aren\'t) common access + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCommonAccessStatusInBulkV1: async (commonaccessidstatusV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'commonaccessidstatusV1' is not null or undefined + assertParamExists('updateCommonAccessStatusInBulkV1', 'commonaccessidstatusV1', commonaccessidstatusV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/common-access/v1/update-status`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(commonaccessidstatusV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAICommonAccessV1Api - functional programming interface + * @export + */ +export const IAICommonAccessV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAICommonAccessV1ApiAxiosParamCreator(configuration) + return { + /** + * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + * @summary Create common access items + * @param {CommonaccessitemrequestV1} commonaccessitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCommonAccessV1(commonaccessitemrequestV1: CommonaccessitemrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCommonAccessV1(commonaccessitemrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV1Api.createCommonAccessV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + * @summary Get a paginated list of common access + * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* + * @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: **access.name, status** By default the common access items are sorted by name, ascending. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCommonAccessV1(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCommonAccessV1(offset, limit, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV1Api.getCommonAccessV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + * @summary Bulk update common access status + * @param {Array} commonaccessidstatusV1 Confirm or deny in bulk the common access ids that are (or aren\'t) common access + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateCommonAccessStatusInBulkV1(commonaccessidstatusV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommonAccessStatusInBulkV1(commonaccessidstatusV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV1Api.updateCommonAccessStatusInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAICommonAccessV1Api - factory interface + * @export + */ +export const IAICommonAccessV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAICommonAccessV1ApiFp(configuration) + return { + /** + * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + * @summary Create common access items + * @param {IAICommonAccessV1ApiCreateCommonAccessV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCommonAccessV1(requestParameters: IAICommonAccessV1ApiCreateCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCommonAccessV1(requestParameters.commonaccessitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + * @summary Get a paginated list of common access + * @param {IAICommonAccessV1ApiGetCommonAccessV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCommonAccessV1(requestParameters: IAICommonAccessV1ApiGetCommonAccessV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getCommonAccessV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + * @summary Bulk update common access status + * @param {IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateCommonAccessStatusInBulkV1(requestParameters: IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateCommonAccessStatusInBulkV1(requestParameters.commonaccessidstatusV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCommonAccessV1 operation in IAICommonAccessV1Api. + * @export + * @interface IAICommonAccessV1ApiCreateCommonAccessV1Request + */ +export interface IAICommonAccessV1ApiCreateCommonAccessV1Request { + /** + * + * @type {CommonaccessitemrequestV1} + * @memberof IAICommonAccessV1ApiCreateCommonAccessV1 + */ + readonly commonaccessitemrequestV1: CommonaccessitemrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAICommonAccessV1ApiCreateCommonAccessV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getCommonAccessV1 operation in IAICommonAccessV1Api. + * @export + * @interface IAICommonAccessV1ApiGetCommonAccessV1Request + */ +export interface IAICommonAccessV1ApiGetCommonAccessV1Request { + /** + * 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 IAICommonAccessV1ApiGetCommonAccessV1 + */ + 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 IAICommonAccessV1ApiGetCommonAccessV1 + */ + 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 IAICommonAccessV1ApiGetCommonAccessV1 + */ + 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* + * @type {string} + * @memberof IAICommonAccessV1ApiGetCommonAccessV1 + */ + 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: **access.name, status** By default the common access items are sorted by name, ascending. + * @type {string} + * @memberof IAICommonAccessV1ApiGetCommonAccessV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAICommonAccessV1ApiGetCommonAccessV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateCommonAccessStatusInBulkV1 operation in IAICommonAccessV1Api. + * @export + * @interface IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request + */ +export interface IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request { + /** + * Confirm or deny in bulk the common access ids that are (or aren\'t) common access + * @type {Array} + * @memberof IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1 + */ + readonly commonaccessidstatusV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAICommonAccessV1Api - object-oriented interface + * @export + * @class IAICommonAccessV1Api + * @extends {BaseAPI} + */ +export class IAICommonAccessV1Api extends BaseAPI { + /** + * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + * @summary Create common access items + * @param {IAICommonAccessV1ApiCreateCommonAccessV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAICommonAccessV1Api + */ + public createCommonAccessV1(requestParameters: IAICommonAccessV1ApiCreateCommonAccessV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAICommonAccessV1ApiFp(this.configuration).createCommonAccessV1(requestParameters.commonaccessitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + * @summary Get a paginated list of common access + * @param {IAICommonAccessV1ApiGetCommonAccessV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAICommonAccessV1Api + */ + public getCommonAccessV1(requestParameters: IAICommonAccessV1ApiGetCommonAccessV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAICommonAccessV1ApiFp(this.configuration).getCommonAccessV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + * @summary Bulk update common access status + * @param {IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAICommonAccessV1Api + */ + public updateCommonAccessStatusInBulkV1(requestParameters: IAICommonAccessV1ApiUpdateCommonAccessStatusInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAICommonAccessV1ApiFp(this.configuration).updateCommonAccessStatusInBulkV1(requestParameters.commonaccessidstatusV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/iai_common_access/base.ts b/sdk-output/iai_common_access/base.ts new file mode 100644 index 00000000..fa5b3b67 --- /dev/null +++ b/sdk-output/iai_common_access/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Common Access + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_common_access/common.ts b/sdk-output/iai_common_access/common.ts new file mode 100644 index 00000000..d0c52f0a --- /dev/null +++ b/sdk-output/iai_common_access/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Common Access + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_common_access/configuration.ts b/sdk-output/iai_common_access/configuration.ts new file mode 100644 index 00000000..b313870a --- /dev/null +++ b/sdk-output/iai_common_access/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Common Access + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_common_access/git_push.sh b/sdk-output/iai_common_access/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_common_access/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_common_access/index.ts b/sdk-output/iai_common_access/index.ts new file mode 100644 index 00000000..ba83d965 --- /dev/null +++ b/sdk-output/iai_common_access/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Common Access + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_common_access/package.json b/sdk-output/iai_common_access/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_common_access/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_common_access/tsconfig.json b/sdk-output/iai_common_access/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_common_access/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_outliers/.gitignore b/sdk-output/iai_outliers/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_outliers/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_outliers/.npmignore b/sdk-output/iai_outliers/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_outliers/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_outliers/.openapi-generator-ignore b/sdk-output/iai_outliers/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_outliers/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_outliers/.openapi-generator/FILES b/sdk-output/iai_outliers/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_outliers/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_outliers/.openapi-generator/VERSION b/sdk-output/iai_outliers/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_outliers/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_outliers/.sdk-partition b/sdk-output/iai_outliers/.sdk-partition new file mode 100644 index 00000000..243d82e2 --- /dev/null +++ b/sdk-output/iai_outliers/.sdk-partition @@ -0,0 +1 @@ +iai-outliers \ No newline at end of file diff --git a/sdk-output/iai_outliers/README.md b/sdk-output/iai_outliers/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_outliers/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_outliers/api.ts b/sdk-output/iai_outliers/api.ts new file mode 100644 index 00000000..8b17c690 --- /dev/null +++ b/sdk-output/iai_outliers/api.ts @@ -0,0 +1,1794 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Outliers + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetIdentityOutlierSnapshotsV1401ResponseV1 + */ +export interface GetIdentityOutlierSnapshotsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetIdentityOutlierSnapshotsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetIdentityOutlierSnapshotsV1429ResponseV1 + */ +export interface GetIdentityOutlierSnapshotsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetIdentityOutlierSnapshotsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface LatestoutliersummaryV1 + */ +export interface LatestoutliersummaryV1 { + /** + * The type of outlier summary + * @type {string} + * @memberof LatestoutliersummaryV1 + */ + 'type'?: LatestoutliersummaryV1TypeV1; + /** + * The date the bulk outlier detection ran/snapshot was created + * @type {string} + * @memberof LatestoutliersummaryV1 + */ + 'snapshotDate'?: string; + /** + * Total number of outliers for the customer making the request + * @type {number} + * @memberof LatestoutliersummaryV1 + */ + 'totalOutliers'?: number; + /** + * Total number of identities for the customer making the request + * @type {number} + * @memberof LatestoutliersummaryV1 + */ + 'totalIdentities'?: number; + /** + * Total number of ignored outliers + * @type {number} + * @memberof LatestoutliersummaryV1 + */ + 'totalIgnored'?: number; +} + +export const LatestoutliersummaryV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; + +export type LatestoutliersummaryV1TypeV1 = typeof LatestoutliersummaryV1TypeV1[keyof typeof LatestoutliersummaryV1TypeV1]; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface OutlierV1 + */ +export interface OutlierV1 { + /** + * The identity\'s unique identifier for the outlier record + * @type {string} + * @memberof OutlierV1 + */ + 'id'?: string; + /** + * The ID of the identity that is detected as an outlier + * @type {string} + * @memberof OutlierV1 + */ + 'identityId'?: string; + /** + * The type of outlier summary + * @type {string} + * @memberof OutlierV1 + */ + 'type'?: OutlierV1TypeV1; + /** + * The first date the outlier was detected + * @type {string} + * @memberof OutlierV1 + */ + 'firstDetectionDate'?: string; + /** + * The most recent date the outlier was detected + * @type {string} + * @memberof OutlierV1 + */ + 'latestDetectionDate'?: string; + /** + * Flag whether or not the outlier has been ignored + * @type {boolean} + * @memberof OutlierV1 + */ + 'ignored'?: boolean; + /** + * Object containing mapped identity attributes + * @type {object} + * @memberof OutlierV1 + */ + 'attributes'?: object; + /** + * The outlier score determined by the detection engine ranging from 0..1 + * @type {number} + * @memberof OutlierV1 + */ + 'score'?: number; + /** + * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored + * @type {string} + * @memberof OutlierV1 + */ + 'unignoreType'?: OutlierV1UnignoreTypeV1 | null; + /** + * shows date when last time has been unignored outlier + * @type {string} + * @memberof OutlierV1 + */ + 'unignoreDate'?: string | null; + /** + * shows date when last time has been ignored outlier + * @type {string} + * @memberof OutlierV1 + */ + 'ignoreDate'?: string | null; +} + +export const OutlierV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; + +export type OutlierV1TypeV1 = typeof OutlierV1TypeV1[keyof typeof OutlierV1TypeV1]; +export const OutlierV1UnignoreTypeV1 = { + Manual: 'MANUAL', + Automatic: 'AUTOMATIC' +} as const; + +export type OutlierV1UnignoreTypeV1 = typeof OutlierV1UnignoreTypeV1[keyof typeof OutlierV1UnignoreTypeV1]; + +/** + * + * @export + * @interface OutliercontributingfeatureV1 + */ +export interface OutliercontributingfeatureV1 { + /** + * Contributing feature id + * @type {string} + * @memberof OutliercontributingfeatureV1 + */ + 'id'?: string; + /** + * The name of the feature + * @type {string} + * @memberof OutliercontributingfeatureV1 + */ + 'name'?: string; + /** + * + * @type {OutliervaluetypeV1} + * @memberof OutliercontributingfeatureV1 + */ + 'valueType'?: OutliervaluetypeV1; + /** + * The feature value + * @type {number} + * @memberof OutliercontributingfeatureV1 + */ + 'value'?: number; + /** + * The importance of the feature. This can also be a negative value + * @type {number} + * @memberof OutliercontributingfeatureV1 + */ + 'importance'?: number; + /** + * The (translated if header is passed) displayName for the feature + * @type {string} + * @memberof OutliercontributingfeatureV1 + */ + 'displayName'?: string; + /** + * The (translated if header is passed) description for the feature + * @type {string} + * @memberof OutliercontributingfeatureV1 + */ + 'description'?: string; + /** + * + * @type {OutlierfeaturetranslationV1} + * @memberof OutliercontributingfeatureV1 + */ + 'translationMessages'?: OutlierfeaturetranslationV1 | null; +} +/** + * + * @export + * @interface OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 + */ +export interface OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 { + /** + * display name + * @type {string} + * @memberof OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 + */ + 'displayName'?: string; + /** + * value + * @type {string} + * @memberof OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 + */ + 'value'?: string; + /** + * + * @type {OutliervaluetypeV1} + * @memberof OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 + */ + 'valueType'?: OutliervaluetypeV1; +} +/** + * + * @export + * @interface OutlierfeaturesummaryV1 + */ +export interface OutlierfeaturesummaryV1 { + /** + * Contributing feature name + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'contributingFeatureName'?: string; + /** + * Identity display name + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'identityOutlierDisplayName'?: string; + /** + * + * @type {Array} + * @memberof OutlierfeaturesummaryV1 + */ + 'outlierFeatureDisplayValues'?: Array; + /** + * Definition of the feature + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'featureDefinition'?: string; + /** + * Detailed explanation of the feature + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'featureExplanation'?: string; + /** + * outlier\'s peer identity display name + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'peerDisplayName'?: string | null; + /** + * outlier\'s peer identity id + * @type {string} + * @memberof OutlierfeaturesummaryV1 + */ + 'peerIdentityId'?: string | null; + /** + * Access Item reference + * @type {object} + * @memberof OutlierfeaturesummaryV1 + */ + 'accessItemReference'?: object; +} +/** + * + * @export + * @interface OutlierfeaturetranslationV1 + */ +export interface OutlierfeaturetranslationV1 { + /** + * + * @type {TranslationmessageV1} + * @memberof OutlierfeaturetranslationV1 + */ + 'displayName'?: TranslationmessageV1; + /** + * + * @type {TranslationmessageV1} + * @memberof OutlierfeaturetranslationV1 + */ + 'description'?: TranslationmessageV1; +} +/** + * + * @export + * @interface OutlierscontributingfeatureaccessitemsV1 + */ +export interface OutlierscontributingfeatureaccessitemsV1 { + /** + * The ID of the access item + * @type {string} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'id'?: string; + /** + * the display name of the access item + * @type {string} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'displayName'?: string; + /** + * Description of the access item. + * @type {string} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'description'?: string | null; + /** + * The type of the access item. + * @type {string} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'accessType'?: OutlierscontributingfeatureaccessitemsV1AccessTypeV1; + /** + * the associated source name if it exists + * @type {string} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'sourceName'?: string; + /** + * rarest access + * @type {boolean} + * @memberof OutlierscontributingfeatureaccessitemsV1 + */ + 'extremelyRare'?: boolean; +} + +export const OutlierscontributingfeatureaccessitemsV1AccessTypeV1 = { + Entitlement: 'ENTITLEMENT', + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; + +export type OutlierscontributingfeatureaccessitemsV1AccessTypeV1 = typeof OutlierscontributingfeatureaccessitemsV1AccessTypeV1[keyof typeof OutlierscontributingfeatureaccessitemsV1AccessTypeV1]; + +/** + * + * @export + * @interface OutliersummaryV1 + */ +export interface OutliersummaryV1 { + /** + * The type of outlier summary + * @type {string} + * @memberof OutliersummaryV1 + */ + 'type'?: OutliersummaryV1TypeV1; + /** + * The date the bulk outlier detection ran/snapshot was created + * @type {string} + * @memberof OutliersummaryV1 + */ + 'snapshotDate'?: string; + /** + * Total number of outliers for the customer making the request + * @type {number} + * @memberof OutliersummaryV1 + */ + 'totalOutliers'?: number; + /** + * Total number of identities for the customer making the request + * @type {number} + * @memberof OutliersummaryV1 + */ + 'totalIdentities'?: number; + /** + * + * @type {number} + * @memberof OutliersummaryV1 + */ + 'totalIgnored'?: number; +} + +export const OutliersummaryV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; + +export type OutliersummaryV1TypeV1 = typeof OutliersummaryV1TypeV1[keyof typeof OutliersummaryV1TypeV1]; + +/** + * The data type of the value field + * @export + * @interface OutliervaluetypeV1 + */ +export interface OutliervaluetypeV1 { + /** + * The data type of the value field + * @type {string} + * @memberof OutliervaluetypeV1 + */ + 'name'?: OutliervaluetypeV1NameV1; + /** + * The position of the value type + * @type {number} + * @memberof OutliervaluetypeV1 + */ + 'ordinal'?: number; +} + +export const OutliervaluetypeV1NameV1 = { + Integer: 'INTEGER', + Float: 'FLOAT' +} as const; + +export type OutliervaluetypeV1NameV1 = typeof OutliervaluetypeV1NameV1[keyof typeof OutliervaluetypeV1NameV1]; + +/** + * + * @export + * @interface TranslationmessageV1 + */ +export interface TranslationmessageV1 { + /** + * The key of the translation message + * @type {string} + * @memberof TranslationmessageV1 + */ + 'key'?: string; + /** + * The values corresponding to the translation messages + * @type {Array} + * @memberof TranslationmessageV1 + */ + 'values'?: Array; +} + +/** + * IAIOutliersV1Api - axios parameter creator + * @export + */ +export const IAIOutliersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + * @summary Iai identity outliers export + * @param {ExportOutliersZipV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportOutliersZipV1: async (type?: ExportOutliersZipV1TypeV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/v1/export`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers summary + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetIdentityOutlierSnapshotsV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @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: **snapshotDate**: *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: **snapshotDate** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOutlierSnapshotsV1: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsV1TypeV1, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outlier-summaries/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + * @summary Iai get identity outliers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetIdentityOutliersV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOutliersV1: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersV1TypeV1, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers latest summary + * @param {GetLatestIdentityOutlierSnapshotsV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLatestIdentityOutlierSnapshotsV1: async (type?: GetLatestIdentityOutlierSnapshotsV1TypeV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outlier-summaries/v1/latest`; + // 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; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + * @summary Get identity outlier contibuting feature summary + * @param {string} outlierFeatureId Contributing feature id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOutlierContributingFeatureSummaryV1: async (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'outlierFeatureId' is not null or undefined + assertParamExists('getOutlierContributingFeatureSummaryV1', 'outlierFeatureId', outlierFeatureId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outlier-feature-summaries/v1/{outlierFeatureId}` + .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + * @summary Get identity outlier\'s contibuting features + * @param {string} outlierId The outlier id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response + * @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: **importance** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPeerGroupOutliersContributingFeaturesV1: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'outlierId' is not null or undefined + assertParamExists('getPeerGroupOutliersContributingFeaturesV1', 'outlierId', outlierId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/v1/{outlierId}/contributing-features` + .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (includeTranslationMessages !== undefined) { + localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be ignored. + * @summary Iai identity outliers ignore + * @param {Array} requestBody + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + ignoreIdentityOutliersV1: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('ignoreIdentityOutliersV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/v1/ignore`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + * @summary Gets a list of access items associated with each identity outlier contributing feature + * @param {string} outlierId The outlier id + * @param {ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1} contributingFeatureName The name of contributing feature + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. + * @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: **displayName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOutliersContributingFeatureAccessItemsV1: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'outlierId' is not null or undefined + assertParamExists('listOutliersContributingFeatureAccessItemsV1', 'outlierId', outlierId) + // verify required parameter 'contributingFeatureName' is not null or undefined + assertParamExists('listOutliersContributingFeatureAccessItemsV1', 'contributingFeatureName', contributingFeatureName) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/v1/{outlierId}/feature-details/{contributingFeatureName}/access-items` + .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) + .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (accessType !== undefined) { + localVarQueryParameter['accessType'] = accessType; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + * @summary Iai identity outliers unignore + * @param {Array} requestBody + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unIgnoreIdentityOutliersV1: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('unIgnoreIdentityOutliersV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/outliers/v1/unignore`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAIOutliersV1Api - functional programming interface + * @export + */ +export const IAIOutliersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAIOutliersV1ApiAxiosParamCreator(configuration) + return { + /** + * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + * @summary Iai identity outliers export + * @param {ExportOutliersZipV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportOutliersZipV1(type?: ExportOutliersZipV1TypeV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZipV1(type, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.exportOutliersZipV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers summary + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetIdentityOutlierSnapshotsV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @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: **snapshotDate**: *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: **snapshotDate** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityOutlierSnapshotsV1(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsV1TypeV1, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshotsV1(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.getIdentityOutlierSnapshotsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + * @summary Iai get identity outliers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {GetIdentityOutliersV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityOutliersV1(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersV1TypeV1, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliersV1(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.getIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers latest summary + * @param {GetLatestIdentityOutlierSnapshotsV1TypeV1} [type] Type of the identity outliers snapshot to filter on + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getLatestIdentityOutlierSnapshotsV1(type?: GetLatestIdentityOutlierSnapshotsV1TypeV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshotsV1(type, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.getLatestIdentityOutlierSnapshotsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + * @summary Get identity outlier contibuting feature summary + * @param {string} outlierFeatureId Contributing feature id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getOutlierContributingFeatureSummaryV1(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummaryV1(outlierFeatureId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.getOutlierContributingFeatureSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + * @summary Get identity outlier\'s contibuting features + * @param {string} outlierId The outlier id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response + * @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: **importance** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPeerGroupOutliersContributingFeaturesV1(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeaturesV1(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.getPeerGroupOutliersContributingFeaturesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be ignored. + * @summary Iai identity outliers ignore + * @param {Array} requestBody + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async ignoreIdentityOutliersV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliersV1(requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.ignoreIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + * @summary Gets a list of access items associated with each identity outlier contributing feature + * @param {string} outlierId The outlier id + * @param {ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1} contributingFeatureName The name of contributing feature + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. + * @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: **displayName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listOutliersContributingFeatureAccessItemsV1(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItemsV1(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.listOutliersContributingFeatureAccessItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + * @summary Iai identity outliers unignore + * @param {Array} requestBody + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async unIgnoreIdentityOutliersV1(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliersV1(requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIOutliersV1Api.unIgnoreIdentityOutliersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAIOutliersV1Api - factory interface + * @export + */ +export const IAIOutliersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAIOutliersV1ApiFp(configuration) + return { + /** + * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + * @summary Iai identity outliers export + * @param {IAIOutliersV1ApiExportOutliersZipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportOutliersZipV1(requestParameters: IAIOutliersV1ApiExportOutliersZipV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportOutliersZipV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers summary + * @param {IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentityOutlierSnapshotsV1(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + * @summary Iai get identity outliers + * @param {IAIOutliersV1ApiGetIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOutliersV1(requestParameters: IAIOutliersV1ApiGetIdentityOutliersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentityOutliersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers latest summary + * @param {IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLatestIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getLatestIdentityOutlierSnapshotsV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + * @summary Get identity outlier contibuting feature summary + * @param {IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOutlierContributingFeatureSummaryV1(requestParameters: IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getOutlierContributingFeatureSummaryV1(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + * @summary Get identity outlier\'s contibuting features + * @param {IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPeerGroupOutliersContributingFeaturesV1(requestParameters: IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPeerGroupOutliersContributingFeaturesV1(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be ignored. + * @summary Iai identity outliers ignore + * @param {IAIOutliersV1ApiIgnoreIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + ignoreIdentityOutliersV1(requestParameters: IAIOutliersV1ApiIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.ignoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + * @summary Gets a list of access items associated with each identity outlier contributing feature + * @param {IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOutliersContributingFeatureAccessItemsV1(requestParameters: IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listOutliersContributingFeatureAccessItemsV1(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + * @summary Iai identity outliers unignore + * @param {IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unIgnoreIdentityOutliersV1(requestParameters: IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unIgnoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for exportOutliersZipV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiExportOutliersZipV1Request + */ +export interface IAIOutliersV1ApiExportOutliersZipV1Request { + /** + * Type of the identity outliers snapshot to filter on + * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} + * @memberof IAIOutliersV1ApiExportOutliersZipV1 + */ + readonly type?: ExportOutliersZipV1TypeV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiExportOutliersZipV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentityOutlierSnapshotsV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request + */ +export interface IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request { + /** + * 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 IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + readonly offset?: number + + /** + * Type of the identity outliers snapshot to filter on + * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} + * @memberof IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + readonly type?: GetIdentityOutlierSnapshotsV1TypeV1 + + /** + * 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: **snapshotDate**: *ge, le* + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + 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: **snapshotDate** + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentityOutliersV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiGetIdentityOutliersV1Request + */ +export interface IAIOutliersV1ApiGetIdentityOutliersV1Request { + /** + * 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 IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly count?: boolean + + /** + * Type of the identity outliers snapshot to filter on + * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly type?: GetIdentityOutliersV1TypeV1 + + /** + * 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + 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: **firstDetectionDate, attributes, score** + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiGetIdentityOutliersV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getLatestIdentityOutlierSnapshotsV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request + */ +export interface IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request { + /** + * Type of the identity outliers snapshot to filter on + * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} + * @memberof IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1 + */ + readonly type?: GetLatestIdentityOutlierSnapshotsV1TypeV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getOutlierContributingFeatureSummaryV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request + */ +export interface IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request { + /** + * Contributing feature id + * @type {string} + * @memberof IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1 + */ + readonly outlierFeatureId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPeerGroupOutliersContributingFeaturesV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request + */ +export interface IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request { + /** + * The outlier id + * @type {string} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly outlierId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly count?: boolean + + /** + * Whether or not to include translation messages object in returned response + * @type {string} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly includeTranslationMessages?: 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: **importance** + * @type {string} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for ignoreIdentityOutliersV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiIgnoreIdentityOutliersV1Request + */ +export interface IAIOutliersV1ApiIgnoreIdentityOutliersV1Request { + /** + * + * @type {Array} + * @memberof IAIOutliersV1ApiIgnoreIdentityOutliersV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiIgnoreIdentityOutliersV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listOutliersContributingFeatureAccessItemsV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request + */ +export interface IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request { + /** + * The outlier id + * @type {string} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly outlierId: string + + /** + * The name of contributing feature + * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1 + + /** + * 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 IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly count?: boolean + + /** + * The type of access item for the identity outlier contributing feature. If not provided, it returns all. + * @type {string} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly accessType?: 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: **displayName** + * @type {string} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for unIgnoreIdentityOutliersV1 operation in IAIOutliersV1Api. + * @export + * @interface IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request + */ +export interface IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request { + /** + * + * @type {Array} + * @memberof IAIOutliersV1ApiUnIgnoreIdentityOutliersV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIOutliersV1ApiUnIgnoreIdentityOutliersV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAIOutliersV1Api - object-oriented interface + * @export + * @class IAIOutliersV1Api + * @extends {BaseAPI} + */ +export class IAIOutliersV1Api extends BaseAPI { + /** + * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + * @summary Iai identity outliers export + * @param {IAIOutliersV1ApiExportOutliersZipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public exportOutliersZipV1(requestParameters: IAIOutliersV1ApiExportOutliersZipV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).exportOutliersZipV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers summary + * @param {IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public getIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersV1ApiGetIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).getIdentityOutlierSnapshotsV1(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + * @summary Iai get identity outliers + * @param {IAIOutliersV1ApiGetIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public getIdentityOutliersV1(requestParameters: IAIOutliersV1ApiGetIdentityOutliersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).getIdentityOutliersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + * @summary Iai identity outliers latest summary + * @param {IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public getLatestIdentityOutlierSnapshotsV1(requestParameters: IAIOutliersV1ApiGetLatestIdentityOutlierSnapshotsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).getLatestIdentityOutlierSnapshotsV1(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + * @summary Get identity outlier contibuting feature summary + * @param {IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public getOutlierContributingFeatureSummaryV1(requestParameters: IAIOutliersV1ApiGetOutlierContributingFeatureSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).getOutlierContributingFeatureSummaryV1(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + * @summary Get identity outlier\'s contibuting features + * @param {IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public getPeerGroupOutliersContributingFeaturesV1(requestParameters: IAIOutliersV1ApiGetPeerGroupOutliersContributingFeaturesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).getPeerGroupOutliersContributingFeaturesV1(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API receives a list of identity IDs in the request, changes the outliers to be ignored. + * @summary Iai identity outliers ignore + * @param {IAIOutliersV1ApiIgnoreIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public ignoreIdentityOutliersV1(requestParameters: IAIOutliersV1ApiIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).ignoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + * @summary Gets a list of access items associated with each identity outlier contributing feature + * @param {IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public listOutliersContributingFeatureAccessItemsV1(requestParameters: IAIOutliersV1ApiListOutliersContributingFeatureAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).listOutliersContributingFeatureAccessItemsV1(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + * @summary Iai identity outliers unignore + * @param {IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIOutliersV1Api + */ + public unIgnoreIdentityOutliersV1(requestParameters: IAIOutliersV1ApiUnIgnoreIdentityOutliersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIOutliersV1ApiFp(this.configuration).unIgnoreIdentityOutliersV1(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ExportOutliersZipV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; +export type ExportOutliersZipV1TypeV1 = typeof ExportOutliersZipV1TypeV1[keyof typeof ExportOutliersZipV1TypeV1]; +/** + * @export + */ +export const GetIdentityOutlierSnapshotsV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; +export type GetIdentityOutlierSnapshotsV1TypeV1 = typeof GetIdentityOutlierSnapshotsV1TypeV1[keyof typeof GetIdentityOutlierSnapshotsV1TypeV1]; +/** + * @export + */ +export const GetIdentityOutliersV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; +export type GetIdentityOutliersV1TypeV1 = typeof GetIdentityOutliersV1TypeV1[keyof typeof GetIdentityOutliersV1TypeV1]; +/** + * @export + */ +export const GetLatestIdentityOutlierSnapshotsV1TypeV1 = { + LowSimilarity: 'LOW_SIMILARITY', + Structural: 'STRUCTURAL' +} as const; +export type GetLatestIdentityOutlierSnapshotsV1TypeV1 = typeof GetLatestIdentityOutlierSnapshotsV1TypeV1[keyof typeof GetLatestIdentityOutlierSnapshotsV1TypeV1]; +/** + * @export + */ +export const ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1 = { + RadicalEntitlementCount: 'radical_entitlement_count', + EntitlementCount: 'entitlement_count', + MaxJaccardSimilarity: 'max_jaccard_similarity', + MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', + SingleEntitlementBundleCount: 'single_entitlement_bundle_count', + PeerlessScore: 'peerless_score' +} as const; +export type ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1 = typeof ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1[keyof typeof ListOutliersContributingFeatureAccessItemsV1ContributingFeatureNameV1]; + + diff --git a/sdk-output/iai_outliers/base.ts b/sdk-output/iai_outliers/base.ts new file mode 100644 index 00000000..658c376c --- /dev/null +++ b/sdk-output/iai_outliers/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Outliers + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_outliers/common.ts b/sdk-output/iai_outliers/common.ts new file mode 100644 index 00000000..d6105d48 --- /dev/null +++ b/sdk-output/iai_outliers/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Outliers + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_outliers/configuration.ts b/sdk-output/iai_outliers/configuration.ts new file mode 100644 index 00000000..b797a528 --- /dev/null +++ b/sdk-output/iai_outliers/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Outliers + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_outliers/git_push.sh b/sdk-output/iai_outliers/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_outliers/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_outliers/index.ts b/sdk-output/iai_outliers/index.ts new file mode 100644 index 00000000..6b50b2ed --- /dev/null +++ b/sdk-output/iai_outliers/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Outliers + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_outliers/package.json b/sdk-output/iai_outliers/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_outliers/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_outliers/tsconfig.json b/sdk-output/iai_outliers/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_outliers/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_peer_group_strategies/.gitignore b/sdk-output/iai_peer_group_strategies/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_peer_group_strategies/.npmignore b/sdk-output/iai_peer_group_strategies/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_peer_group_strategies/.openapi-generator-ignore b/sdk-output/iai_peer_group_strategies/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES b/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_peer_group_strategies/.openapi-generator/VERSION b/sdk-output/iai_peer_group_strategies/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_peer_group_strategies/.sdk-partition b/sdk-output/iai_peer_group_strategies/.sdk-partition new file mode 100644 index 00000000..ddb5d9ca --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/.sdk-partition @@ -0,0 +1 @@ +iai-peer-group-strategies \ No newline at end of file diff --git a/sdk-output/iai_peer_group_strategies/README.md b/sdk-output/iai_peer_group_strategies/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_peer_group_strategies/api.ts b/sdk-output/iai_peer_group_strategies/api.ts new file mode 100644 index 00000000..0164e1e5 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/api.ts @@ -0,0 +1,343 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Peer Group Strategies + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPeerGroupOutliersV1401ResponseV1 + */ +export interface GetPeerGroupOutliersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPeerGroupOutliersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPeerGroupOutliersV1429ResponseV1 + */ +export interface GetPeerGroupOutliersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPeerGroupOutliersV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PeergroupmemberV1 + */ +export interface PeergroupmemberV1 { + /** + * A unique identifier for the peer group member. + * @type {string} + * @memberof PeergroupmemberV1 + */ + 'id'?: string; + /** + * The type of the peer group member. + * @type {string} + * @memberof PeergroupmemberV1 + */ + 'type'?: string; + /** + * The ID of the peer group. + * @type {string} + * @memberof PeergroupmemberV1 + */ + 'peer_group_id'?: string; + /** + * Arbitrary key-value pairs, belonging to the peer group member. + * @type {{ [key: string]: object; }} + * @memberof PeergroupmemberV1 + */ + 'attributes'?: { [key: string]: object; }; +} + +/** + * IAIPeerGroupStrategiesV1Api - axios parameter creator + * @export + */ +export const IAIPeerGroupStrategiesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + * @summary Identity outliers list + * @param {GetPeerGroupOutliersV1StrategyV1} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getPeerGroupOutliersV1: async (strategy: GetPeerGroupOutliersV1StrategyV1, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'strategy' is not null or undefined + assertParamExists('getPeerGroupOutliersV1', 'strategy', strategy) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/peer-group-strategies/v1/{strategy}/identity-outliers` + .replace(`{${"strategy"}}`, encodeURIComponent(String(strategy))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAIPeerGroupStrategiesV1Api - functional programming interface + * @export + */ +export const IAIPeerGroupStrategiesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAIPeerGroupStrategiesV1ApiAxiosParamCreator(configuration) + return { + /** + * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + * @summary Identity outliers list + * @param {GetPeerGroupOutliersV1StrategyV1} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async getPeerGroupOutliersV1(strategy: GetPeerGroupOutliersV1StrategyV1, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersV1(strategy, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIPeerGroupStrategiesV1Api.getPeerGroupOutliersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAIPeerGroupStrategiesV1Api - factory interface + * @export + */ +export const IAIPeerGroupStrategiesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAIPeerGroupStrategiesV1ApiFp(configuration) + return { + /** + * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + * @summary Identity outliers list + * @param {IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getPeerGroupOutliersV1(requestParameters: IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPeerGroupOutliersV1(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getPeerGroupOutliersV1 operation in IAIPeerGroupStrategiesV1Api. + * @export + * @interface IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request + */ +export interface IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request { + /** + * The strategy used to create peer groups. Currently, \'entitlement\' is supported. + * @type {'entitlement'} + * @memberof IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1 + */ + readonly strategy: GetPeerGroupOutliersV1StrategyV1 + + /** + * 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 IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAIPeerGroupStrategiesV1Api - object-oriented interface + * @export + * @class IAIPeerGroupStrategiesV1Api + * @extends {BaseAPI} + */ +export class IAIPeerGroupStrategiesV1Api extends BaseAPI { + /** + * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + * @summary Identity outliers list + * @param {IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof IAIPeerGroupStrategiesV1Api + */ + public getPeerGroupOutliersV1(requestParameters: IAIPeerGroupStrategiesV1ApiGetPeerGroupOutliersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIPeerGroupStrategiesV1ApiFp(this.configuration).getPeerGroupOutliersV1(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetPeerGroupOutliersV1StrategyV1 = { + Entitlement: 'entitlement' +} as const; +export type GetPeerGroupOutliersV1StrategyV1 = typeof GetPeerGroupOutliersV1StrategyV1[keyof typeof GetPeerGroupOutliersV1StrategyV1]; + + diff --git a/sdk-output/iai_peer_group_strategies/base.ts b/sdk-output/iai_peer_group_strategies/base.ts new file mode 100644 index 00000000..169ea66e --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Peer Group Strategies + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_peer_group_strategies/common.ts b/sdk-output/iai_peer_group_strategies/common.ts new file mode 100644 index 00000000..eda798ca --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Peer Group Strategies + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_peer_group_strategies/configuration.ts b/sdk-output/iai_peer_group_strategies/configuration.ts new file mode 100644 index 00000000..570b2139 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Peer Group Strategies + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_peer_group_strategies/git_push.sh b/sdk-output/iai_peer_group_strategies/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_peer_group_strategies/index.ts b/sdk-output/iai_peer_group_strategies/index.ts new file mode 100644 index 00000000..2a50e141 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Peer Group Strategies + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_peer_group_strategies/package.json b/sdk-output/iai_peer_group_strategies/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_peer_group_strategies/tsconfig.json b/sdk-output/iai_peer_group_strategies/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_recommendations/.gitignore b/sdk-output/iai_recommendations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_recommendations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_recommendations/.npmignore b/sdk-output/iai_recommendations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_recommendations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_recommendations/.openapi-generator-ignore b/sdk-output/iai_recommendations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_recommendations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_recommendations/.openapi-generator/FILES b/sdk-output/iai_recommendations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_recommendations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_recommendations/.openapi-generator/VERSION b/sdk-output/iai_recommendations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_recommendations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_recommendations/.sdk-partition b/sdk-output/iai_recommendations/.sdk-partition new file mode 100644 index 00000000..3cc677f6 --- /dev/null +++ b/sdk-output/iai_recommendations/.sdk-partition @@ -0,0 +1 @@ +iai-recommendations \ No newline at end of file diff --git a/sdk-output/iai_recommendations/README.md b/sdk-output/iai_recommendations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_recommendations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_recommendations/api.ts b/sdk-output/iai_recommendations/api.ts new file mode 100644 index 00000000..65f2f5a7 --- /dev/null +++ b/sdk-output/iai_recommendations/api.ts @@ -0,0 +1,739 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Recommendations + * 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 AccessitemrefV1 + */ +export interface AccessitemrefV1 { + /** + * ID of the access item to retrieve the recommendation for. + * @type {string} + * @memberof AccessitemrefV1 + */ + 'id'?: string; + /** + * Access item\'s type. + * @type {string} + * @memberof AccessitemrefV1 + */ + 'type'?: AccessitemrefV1TypeV1; +} + +export const AccessitemrefV1TypeV1 = { + Entitlement: 'ENTITLEMENT', + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; + +export type AccessitemrefV1TypeV1 = typeof AccessitemrefV1TypeV1[keyof typeof AccessitemrefV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FeaturevaluedtoV1 + */ +export interface FeaturevaluedtoV1 { + /** + * The type of feature + * @type {string} + * @memberof FeaturevaluedtoV1 + */ + 'feature'?: string; + /** + * The number of identities that have access to the feature + * @type {number} + * @memberof FeaturevaluedtoV1 + */ + 'numerator'?: number; + /** + * The number of identities with the corresponding feature + * @type {number} + * @memberof FeaturevaluedtoV1 + */ + 'denominator'?: number; +} +/** + * + * @export + * @interface GetRecommendationsV1401ResponseV1 + */ +export interface GetRecommendationsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetRecommendationsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetRecommendationsV1429ResponseV1 + */ +export interface GetRecommendationsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetRecommendationsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface RecommendationconfigdtoV1 + */ +export interface RecommendationconfigdtoV1 { + /** + * List of identity attributes to use for calculating certification recommendations + * @type {Array} + * @memberof RecommendationconfigdtoV1 + */ + 'recommenderFeatures'?: Array; + /** + * The percent value that the recommendation calculation must surpass to produce a YES recommendation + * @type {number} + * @memberof RecommendationconfigdtoV1 + */ + 'peerGroupPercentageThreshold'?: number; + /** + * If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run + * @type {boolean} + * @memberof RecommendationconfigdtoV1 + */ + 'runAutoSelectOnce'?: boolean; + /** + * If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run + * @type {boolean} + * @memberof RecommendationconfigdtoV1 + */ + 'onlyTuneThreshold'?: boolean; +} +/** + * + * @export + * @interface RecommendationrequestV1 + */ +export interface RecommendationrequestV1 { + /** + * The identity ID + * @type {string} + * @memberof RecommendationrequestV1 + */ + 'identityId'?: string; + /** + * + * @type {AccessitemrefV1} + * @memberof RecommendationrequestV1 + */ + 'item'?: AccessitemrefV1; +} +/** + * + * @export + * @interface RecommendationrequestdtoV1 + */ +export interface RecommendationrequestdtoV1 { + /** + * + * @type {Array} + * @memberof RecommendationrequestdtoV1 + */ + 'requests'?: Array; + /** + * Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. + * @type {boolean} + * @memberof RecommendationrequestdtoV1 + */ + 'excludeInterpretations'?: boolean; + /** + * When set to true, the calling system uses the translated messages for the specified language + * @type {boolean} + * @memberof RecommendationrequestdtoV1 + */ + 'includeTranslationMessages'?: boolean; + /** + * Returns the recommender calculations if set to true + * @type {boolean} + * @memberof RecommendationrequestdtoV1 + */ + 'includeDebugInformation'?: boolean; + /** + * When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. + * @type {boolean} + * @memberof RecommendationrequestdtoV1 + */ + 'prescribeMode'?: boolean; +} +/** + * + * @export + * @interface RecommendationresponseV1 + */ +export interface RecommendationresponseV1 { + /** + * + * @type {RecommendationrequestV1} + * @memberof RecommendationresponseV1 + */ + 'request'?: RecommendationrequestV1; + /** + * The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system + * @type {string} + * @memberof RecommendationresponseV1 + */ + 'recommendation'?: RecommendationresponseV1RecommendationV1; + /** + * The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. + * @type {Array} + * @memberof RecommendationresponseV1 + */ + 'interpretations'?: Array; + /** + * The list of translation messages, if they have been requested. + * @type {Array} + * @memberof RecommendationresponseV1 + */ + 'translationMessages'?: Array; + /** + * + * @type {RecommendercalculationsV1} + * @memberof RecommendationresponseV1 + */ + 'recommenderCalculations'?: RecommendercalculationsV1; +} + +export const RecommendationresponseV1RecommendationV1 = { + Yes: 'YES', + No: 'NO', + Maybe: 'MAYBE', + NotFound: 'NOT_FOUND' +} as const; + +export type RecommendationresponseV1RecommendationV1 = typeof RecommendationresponseV1RecommendationV1[keyof typeof RecommendationresponseV1RecommendationV1]; + +/** + * + * @export + * @interface RecommendationresponsedtoV1 + */ +export interface RecommendationresponsedtoV1 { + /** + * + * @type {Array} + * @memberof RecommendationresponsedtoV1 + */ + 'response'?: Array; +} +/** + * + * @export + * @interface RecommendercalculationsIdentityAttributesValueV1 + */ +export interface RecommendercalculationsIdentityAttributesValueV1 { + /** + * + * @type {string} + * @memberof RecommendercalculationsIdentityAttributesValueV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface RecommendercalculationsV1 + */ +export interface RecommendercalculationsV1 { + /** + * The ID of the identity + * @type {string} + * @memberof RecommendercalculationsV1 + */ + 'identityId'?: string; + /** + * The entitlement ID + * @type {string} + * @memberof RecommendercalculationsV1 + */ + 'entitlementId'?: string; + /** + * The actual recommendation + * @type {string} + * @memberof RecommendercalculationsV1 + */ + 'recommendation'?: string; + /** + * The overall weighted score + * @type {number} + * @memberof RecommendercalculationsV1 + */ + 'overallWeightedScore'?: number; + /** + * The weighted score of each individual feature + * @type {{ [key: string]: number; }} + * @memberof RecommendercalculationsV1 + */ + 'featureWeightedScores'?: { [key: string]: number; }; + /** + * The configured value against which the overallWeightedScore is compared + * @type {number} + * @memberof RecommendercalculationsV1 + */ + 'threshold'?: number; + /** + * The values for your configured features + * @type {{ [key: string]: RecommendercalculationsIdentityAttributesValueV1; }} + * @memberof RecommendercalculationsV1 + */ + 'identityAttributes'?: { [key: string]: RecommendercalculationsIdentityAttributesValueV1; }; + /** + * + * @type {FeaturevaluedtoV1} + * @memberof RecommendercalculationsV1 + */ + 'featureValues'?: FeaturevaluedtoV1; +} +/** + * + * @export + * @interface TranslationmessageV1 + */ +export interface TranslationmessageV1 { + /** + * The key of the translation message + * @type {string} + * @memberof TranslationmessageV1 + */ + 'key'?: string; + /** + * The values corresponding to the translation messages + * @type {Array} + * @memberof TranslationmessageV1 + */ + 'values'?: Array; +} + +/** + * IAIRecommendationsV1Api - axios parameter creator + * @export + */ +export const IAIRecommendationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Retrieves configuration attributes used by certification recommendations. + * @summary Get certification recommendation config values + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRecommendationsConfigV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/recommendations/v1/config`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + * @summary Returns recommendation based on object + * @param {RecommendationrequestdtoV1} recommendationrequestdtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRecommendationsV1: async (recommendationrequestdtoV1: RecommendationrequestdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'recommendationrequestdtoV1' is not null or undefined + assertParamExists('getRecommendationsV1', 'recommendationrequestdtoV1', recommendationrequestdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/recommendations/v1/request`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(recommendationrequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates configuration attributes used by certification recommendations. + * @summary Update certification recommendation config values + * @param {RecommendationconfigdtoV1} recommendationconfigdtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRecommendationsConfigV1: async (recommendationconfigdtoV1: RecommendationconfigdtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'recommendationconfigdtoV1' is not null or undefined + assertParamExists('updateRecommendationsConfigV1', 'recommendationconfigdtoV1', recommendationconfigdtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/recommendations/v1/config`; + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(recommendationconfigdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAIRecommendationsV1Api - functional programming interface + * @export + */ +export const IAIRecommendationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAIRecommendationsV1ApiAxiosParamCreator(configuration) + return { + /** + * Retrieves configuration attributes used by certification recommendations. + * @summary Get certification recommendation config values + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRecommendationsConfigV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsConfigV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV1Api.getRecommendationsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + * @summary Returns recommendation based on object + * @param {RecommendationrequestdtoV1} recommendationrequestdtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRecommendationsV1(recommendationrequestdtoV1: RecommendationrequestdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsV1(recommendationrequestdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV1Api.getRecommendationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates configuration attributes used by certification recommendations. + * @summary Update certification recommendation config values + * @param {RecommendationconfigdtoV1} recommendationconfigdtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateRecommendationsConfigV1(recommendationconfigdtoV1: RecommendationconfigdtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateRecommendationsConfigV1(recommendationconfigdtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV1Api.updateRecommendationsConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAIRecommendationsV1Api - factory interface + * @export + */ +export const IAIRecommendationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAIRecommendationsV1ApiFp(configuration) + return { + /** + * Retrieves configuration attributes used by certification recommendations. + * @summary Get certification recommendation config values + * @param {IAIRecommendationsV1ApiGetRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRecommendationsConfigV1(requestParameters: IAIRecommendationsV1ApiGetRecommendationsConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRecommendationsConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + * @summary Returns recommendation based on object + * @param {IAIRecommendationsV1ApiGetRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRecommendationsV1(requestParameters: IAIRecommendationsV1ApiGetRecommendationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRecommendationsV1(requestParameters.recommendationrequestdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates configuration attributes used by certification recommendations. + * @summary Update certification recommendation config values + * @param {IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRecommendationsConfigV1(requestParameters: IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateRecommendationsConfigV1(requestParameters.recommendationconfigdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getRecommendationsConfigV1 operation in IAIRecommendationsV1Api. + * @export + * @interface IAIRecommendationsV1ApiGetRecommendationsConfigV1Request + */ +export interface IAIRecommendationsV1ApiGetRecommendationsConfigV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRecommendationsV1ApiGetRecommendationsConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRecommendationsV1 operation in IAIRecommendationsV1Api. + * @export + * @interface IAIRecommendationsV1ApiGetRecommendationsV1Request + */ +export interface IAIRecommendationsV1ApiGetRecommendationsV1Request { + /** + * + * @type {RecommendationrequestdtoV1} + * @memberof IAIRecommendationsV1ApiGetRecommendationsV1 + */ + readonly recommendationrequestdtoV1: RecommendationrequestdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRecommendationsV1ApiGetRecommendationsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateRecommendationsConfigV1 operation in IAIRecommendationsV1Api. + * @export + * @interface IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request + */ +export interface IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request { + /** + * + * @type {RecommendationconfigdtoV1} + * @memberof IAIRecommendationsV1ApiUpdateRecommendationsConfigV1 + */ + readonly recommendationconfigdtoV1: RecommendationconfigdtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRecommendationsV1ApiUpdateRecommendationsConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAIRecommendationsV1Api - object-oriented interface + * @export + * @class IAIRecommendationsV1Api + * @extends {BaseAPI} + */ +export class IAIRecommendationsV1Api extends BaseAPI { + /** + * Retrieves configuration attributes used by certification recommendations. + * @summary Get certification recommendation config values + * @param {IAIRecommendationsV1ApiGetRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRecommendationsV1Api + */ + public getRecommendationsConfigV1(requestParameters: IAIRecommendationsV1ApiGetRecommendationsConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIRecommendationsV1ApiFp(this.configuration).getRecommendationsConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + * @summary Returns recommendation based on object + * @param {IAIRecommendationsV1ApiGetRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRecommendationsV1Api + */ + public getRecommendationsV1(requestParameters: IAIRecommendationsV1ApiGetRecommendationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRecommendationsV1ApiFp(this.configuration).getRecommendationsV1(requestParameters.recommendationrequestdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates configuration attributes used by certification recommendations. + * @summary Update certification recommendation config values + * @param {IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRecommendationsV1Api + */ + public updateRecommendationsConfigV1(requestParameters: IAIRecommendationsV1ApiUpdateRecommendationsConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRecommendationsV1ApiFp(this.configuration).updateRecommendationsConfigV1(requestParameters.recommendationconfigdtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/iai_recommendations/base.ts b/sdk-output/iai_recommendations/base.ts new file mode 100644 index 00000000..e6d37edf --- /dev/null +++ b/sdk-output/iai_recommendations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Recommendations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_recommendations/common.ts b/sdk-output/iai_recommendations/common.ts new file mode 100644 index 00000000..b2ec85cc --- /dev/null +++ b/sdk-output/iai_recommendations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Recommendations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_recommendations/configuration.ts b/sdk-output/iai_recommendations/configuration.ts new file mode 100644 index 00000000..1dc17631 --- /dev/null +++ b/sdk-output/iai_recommendations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Recommendations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_recommendations/git_push.sh b/sdk-output/iai_recommendations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_recommendations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_recommendations/index.ts b/sdk-output/iai_recommendations/index.ts new file mode 100644 index 00000000..7af584ee --- /dev/null +++ b/sdk-output/iai_recommendations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Recommendations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_recommendations/package.json b/sdk-output/iai_recommendations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_recommendations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_recommendations/tsconfig.json b/sdk-output/iai_recommendations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_recommendations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/iai_role_mining/.gitignore b/sdk-output/iai_role_mining/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/iai_role_mining/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/iai_role_mining/.npmignore b/sdk-output/iai_role_mining/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/iai_role_mining/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/iai_role_mining/.openapi-generator-ignore b/sdk-output/iai_role_mining/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/iai_role_mining/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/iai_role_mining/.openapi-generator/FILES b/sdk-output/iai_role_mining/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/iai_role_mining/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/iai_role_mining/.openapi-generator/VERSION b/sdk-output/iai_role_mining/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/iai_role_mining/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/iai_role_mining/.sdk-partition b/sdk-output/iai_role_mining/.sdk-partition new file mode 100644 index 00000000..268089fb --- /dev/null +++ b/sdk-output/iai_role_mining/.sdk-partition @@ -0,0 +1 @@ +iai-role-mining \ No newline at end of file diff --git a/sdk-output/iai_role_mining/README.md b/sdk-output/iai_role_mining/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_role_mining/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_role_mining/api.ts b/sdk-output/iai_role_mining/api.ts new file mode 100644 index 00000000..9f5b1928 --- /dev/null +++ b/sdk-output/iai_role_mining/api.ts @@ -0,0 +1,4739 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Role Mining + * 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 ArrayInner1V1 + */ +export interface ArrayInner1V1 { +} +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface EntitycreatedbydtoV1 + */ +export interface EntitycreatedbydtoV1 { + /** + * ID of the creator + * @type {string} + * @memberof EntitycreatedbydtoV1 + */ + 'id'?: string; + /** + * The display name of the creator + * @type {string} + * @memberof EntitycreatedbydtoV1 + */ + 'displayName'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetRoleMiningSessionsV1401ResponseV1 + */ +export interface GetRoleMiningSessionsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetRoleMiningSessionsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetRoleMiningSessionsV1429ResponseV1 + */ +export interface GetRoleMiningSessionsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetRoleMiningSessionsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationroleminingV1 + */ +export interface JsonpatchoperationroleminingV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationroleminingV1 + */ + 'op': JsonpatchoperationroleminingV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationroleminingV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationroleminingValueV1} + * @memberof JsonpatchoperationroleminingV1 + */ + 'value'?: JsonpatchoperationroleminingValueV1; +} + +export const JsonpatchoperationroleminingV1OpV1 = { + Remove: 'remove', + Replace: 'replace' +} as const; + +export type JsonpatchoperationroleminingV1OpV1 = typeof JsonpatchoperationroleminingV1OpV1[keyof typeof JsonpatchoperationroleminingV1OpV1]; + +/** + * @type JsonpatchoperationroleminingValueV1 + * The value to be used for the operation, required for \"replace\" operations + * @export + */ +export type JsonpatchoperationroleminingValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface RoleminingentitlementV1 + */ +export interface RoleminingentitlementV1 { + /** + * + * @type {RoleminingentitlementrefV1} + * @memberof RoleminingentitlementV1 + */ + 'entitlementRef'?: RoleminingentitlementrefV1; + /** + * Name of the entitlement + * @type {string} + * @memberof RoleminingentitlementV1 + */ + 'name'?: string; + /** + * Application name of the entitlement + * @type {string} + * @memberof RoleminingentitlementV1 + */ + 'applicationName'?: string; + /** + * The number of identities with this entitlement in a role. + * @type {number} + * @memberof RoleminingentitlementV1 + */ + 'identityCount'?: number; + /** + * The % popularity of this entitlement in a role. + * @type {number} + * @memberof RoleminingentitlementV1 + */ + 'popularity'?: number; + /** + * The % popularity of this entitlement in the org. + * @type {number} + * @memberof RoleminingentitlementV1 + */ + 'popularityInOrg'?: number; + /** + * The ID of the source/application. + * @type {string} + * @memberof RoleminingentitlementV1 + */ + 'sourceId'?: string; + /** + * The status of activity data for the source. Value is complete or notComplete. + * @type {string} + * @memberof RoleminingentitlementV1 + */ + 'activitySourceState'?: string | null; + /** + * The percentage of identities in the potential role that have usage of the source/application of this entitlement. + * @type {number} + * @memberof RoleminingentitlementV1 + */ + 'sourceUsagePercent'?: number | null; +} +/** + * + * @export + * @interface RoleminingentitlementrefV1 + */ +export interface RoleminingentitlementrefV1 { + /** + * Id of the entitlement + * @type {string} + * @memberof RoleminingentitlementrefV1 + */ + 'id'?: string; + /** + * Name of the entitlement + * @type {string} + * @memberof RoleminingentitlementrefV1 + */ + 'name'?: string; + /** + * Description forthe entitlement + * @type {string} + * @memberof RoleminingentitlementrefV1 + */ + 'description'?: string | null; + /** + * The entitlement attribute + * @type {string} + * @memberof RoleminingentitlementrefV1 + */ + 'attribute'?: string; +} +/** + * + * @export + * @interface RoleminingidentityV1 + */ +export interface RoleminingidentityV1 { + /** + * Id of the identity + * @type {string} + * @memberof RoleminingidentityV1 + */ + 'id'?: string; + /** + * Name of the identity + * @type {string} + * @memberof RoleminingidentityV1 + */ + 'name'?: string; + /** + * + * @type {{ [key: string]: string | null; }} + * @memberof RoleminingidentityV1 + */ + 'attributes'?: { [key: string]: string | null; }; +} +/** + * + * @export + * @interface RoleminingidentitydistributionDistributionInnerV1 + */ +export interface RoleminingidentitydistributionDistributionInnerV1 { + /** + * The attribute value that identities are grouped by + * @type {string} + * @memberof RoleminingidentitydistributionDistributionInnerV1 + */ + 'attributeValue'?: string | null; + /** + * The number of identities that have this attribute value + * @type {number} + * @memberof RoleminingidentitydistributionDistributionInnerV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface RoleminingidentitydistributionV1 + */ +export interface RoleminingidentitydistributionV1 { + /** + * Id of the potential role + * @type {string} + * @memberof RoleminingidentitydistributionV1 + */ + 'attributeName'?: string; + /** + * + * @type {Array} + * @memberof RoleminingidentitydistributionV1 + */ + 'distribution'?: Array; +} +/** + * The potential role reference + * @export + * @interface RoleminingpotentialrolePotentialRoleRefV1 + */ +export interface RoleminingpotentialrolePotentialRoleRefV1 { + /** + * Id of the potential role + * @type {string} + * @memberof RoleminingpotentialrolePotentialRoleRefV1 + */ + 'id'?: string; + /** + * Name of the potential role + * @type {string} + * @memberof RoleminingpotentialrolePotentialRoleRefV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface RoleminingpotentialroleV1 + */ +export interface RoleminingpotentialroleV1 { + /** + * + * @type {RoleminingsessionresponseCreatedByV1} + * @memberof RoleminingpotentialroleV1 + */ + 'createdBy'?: RoleminingsessionresponseCreatedByV1; + /** + * The density of a potential role. + * @type {number} + * @memberof RoleminingpotentialroleV1 + */ + 'density'?: number; + /** + * The description of a potential role. + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'description'?: string | null; + /** + * The number of entitlements in a potential role. + * @type {number} + * @memberof RoleminingpotentialroleV1 + */ + 'entitlementCount'?: number; + /** + * The list of entitlement ids to be excluded. + * @type {Array} + * @memberof RoleminingpotentialroleV1 + */ + 'excludedEntitlements'?: Array | null; + /** + * The freshness of a potential role. + * @type {number} + * @memberof RoleminingpotentialroleV1 + */ + 'freshness'?: number; + /** + * The number of identities in a potential role. + * @type {number} + * @memberof RoleminingpotentialroleV1 + */ + 'identityCount'?: number; + /** + * Identity attribute distribution. + * @type {Array} + * @memberof RoleminingpotentialroleV1 + */ + 'identityDistribution'?: Array | null; + /** + * The list of ids in a potential role. + * @type {Array} + * @memberof RoleminingpotentialroleV1 + */ + 'identityIds'?: Array; + /** + * The status for this identity group which can be OBTAINED or COMPRESSED + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'identityGroupStatus'?: string | null; + /** + * Name of the potential role. + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'name'?: string; + /** + * + * @type {RoleminingpotentialrolePotentialRoleRefV1} + * @memberof RoleminingpotentialroleV1 + */ + 'potentialRoleRef'?: RoleminingpotentialrolePotentialRoleRefV1 | null; + /** + * + * @type {RoleminingpotentialroleprovisionstateV1} + * @memberof RoleminingpotentialroleV1 + */ + 'provisionState'?: RoleminingpotentialroleprovisionstateV1; + /** + * The quality of a potential role. + * @type {number} + * @memberof RoleminingpotentialroleV1 + */ + 'quality'?: number; + /** + * The roleId of a potential role. + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'roleId'?: string | null; + /** + * The potential role\'s saved status. + * @type {boolean} + * @memberof RoleminingpotentialroleV1 + */ + 'saved'?: boolean; + /** + * + * @type {RoleminingsessionparametersdtoV1} + * @memberof RoleminingpotentialroleV1 + */ + 'session'?: RoleminingsessionparametersdtoV1; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingpotentialroleV1 + */ + 'type'?: RoleminingroletypeV1; + /** + * Id of the potential role + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'id'?: string; + /** + * The date-time when this potential role was created. + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'createdDate'?: string; + /** + * The date-time when this potential role was modified. + * @type {string} + * @memberof RoleminingpotentialroleV1 + */ + 'modifiedDate'?: string; +} + + +/** + * + * @export + * @interface RoleminingpotentialroleapplicationV1 + */ +export interface RoleminingpotentialroleapplicationV1 { + /** + * Id of the application + * @type {string} + * @memberof RoleminingpotentialroleapplicationV1 + */ + 'id'?: string; + /** + * Name of the application + * @type {string} + * @memberof RoleminingpotentialroleapplicationV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface RoleminingpotentialroleeditentitlementsV1 + */ +export interface RoleminingpotentialroleeditentitlementsV1 { + /** + * The list of entitlement ids to be edited + * @type {Array} + * @memberof RoleminingpotentialroleeditentitlementsV1 + */ + 'ids'?: Array; + /** + * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. + * @type {boolean} + * @memberof RoleminingpotentialroleeditentitlementsV1 + */ + 'exclude'?: boolean; +} +/** + * + * @export + * @interface RoleminingpotentialroleentitlementsV1 + */ +export interface RoleminingpotentialroleentitlementsV1 { + /** + * Id of the entitlement + * @type {string} + * @memberof RoleminingpotentialroleentitlementsV1 + */ + 'id'?: string; + /** + * Name of the entitlement + * @type {string} + * @memberof RoleminingpotentialroleentitlementsV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface RoleminingpotentialroleexportrequestV1 + */ +export interface RoleminingpotentialroleexportrequestV1 { + /** + * The minimum popularity among identities in the role which an entitlement must have to be included in the report + * @type {number} + * @memberof RoleminingpotentialroleexportrequestV1 + */ + 'minEntitlementPopularity'?: number; + /** + * If false, do not include entitlements that are highly popular among the entire orginization + * @type {boolean} + * @memberof RoleminingpotentialroleexportrequestV1 + */ + 'includeCommonAccess'?: boolean; +} +/** + * + * @export + * @interface RoleminingpotentialroleexportresponseV1 + */ +export interface RoleminingpotentialroleexportresponseV1 { + /** + * The minimum popularity among identities in the role which an entitlement must have to be included in the report + * @type {number} + * @memberof RoleminingpotentialroleexportresponseV1 + */ + 'minEntitlementPopularity'?: number; + /** + * If false, do not include entitlements that are highly popular among the entire orginization + * @type {boolean} + * @memberof RoleminingpotentialroleexportresponseV1 + */ + 'includeCommonAccess'?: boolean; + /** + * ID used to reference this export + * @type {string} + * @memberof RoleminingpotentialroleexportresponseV1 + */ + 'exportId'?: string; + /** + * + * @type {RoleminingpotentialroleexportstateV1} + * @memberof RoleminingpotentialroleexportresponseV1 + */ + 'status'?: RoleminingpotentialroleexportstateV1; +} + + +/** + * + * @export + * @enum {string} + */ + +export const RoleminingpotentialroleexportstateV1 = { + Queued: 'QUEUED', + InProgress: 'IN_PROGRESS', + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type RoleminingpotentialroleexportstateV1 = typeof RoleminingpotentialroleexportstateV1[keyof typeof RoleminingpotentialroleexportstateV1]; + + +/** + * + * @export + * @interface RoleminingpotentialroleprovisionrequestV1 + */ +export interface RoleminingpotentialroleprovisionrequestV1 { + /** + * Name of the new role being created + * @type {string} + * @memberof RoleminingpotentialroleprovisionrequestV1 + */ + 'roleName'?: string; + /** + * Short description of the new role being created + * @type {string} + * @memberof RoleminingpotentialroleprovisionrequestV1 + */ + 'roleDescription'?: string; + /** + * ID of the identity that will own this role + * @type {string} + * @memberof RoleminingpotentialroleprovisionrequestV1 + */ + 'ownerId'?: string; + /** + * When true, create access requests for the identities associated with the potential role + * @type {boolean} + * @memberof RoleminingpotentialroleprovisionrequestV1 + */ + 'includeIdentities'?: boolean; + /** + * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements + * @type {boolean} + * @memberof RoleminingpotentialroleprovisionrequestV1 + */ + 'directlyAssignedEntitlements'?: boolean; +} +/** + * Provision state + * @export + * @enum {string} + */ + +export const RoleminingpotentialroleprovisionstateV1 = { + Potential: 'POTENTIAL', + Pending: 'PENDING', + Complete: 'COMPLETE', + Failed: 'FAILED' +} as const; + +export type RoleminingpotentialroleprovisionstateV1 = typeof RoleminingpotentialroleprovisionstateV1[keyof typeof RoleminingpotentialroleprovisionstateV1]; + + +/** + * + * @export + * @interface RoleminingpotentialrolerefV1 + */ +export interface RoleminingpotentialrolerefV1 { + /** + * Id of the potential role + * @type {string} + * @memberof RoleminingpotentialrolerefV1 + */ + 'id'?: string; + /** + * Name of the potential role + * @type {string} + * @memberof RoleminingpotentialrolerefV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface RoleminingpotentialrolesourceusageV1 + */ +export interface RoleminingpotentialrolesourceusageV1 { + /** + * The identity ID + * @type {string} + * @memberof RoleminingpotentialrolesourceusageV1 + */ + 'id'?: string; + /** + * Display name for the identity + * @type {string} + * @memberof RoleminingpotentialrolesourceusageV1 + */ + 'displayName'?: string; + /** + * Email address for the identity + * @type {string} + * @memberof RoleminingpotentialrolesourceusageV1 + */ + 'email'?: string; + /** + * The number of days there has been usage of the source by the identity. + * @type {number} + * @memberof RoleminingpotentialrolesourceusageV1 + */ + 'usageCount'?: number; +} +/** + * @type RoleminingpotentialrolesummaryCreatedByV1 + * The potential role created by details + * @export + */ +export type RoleminingpotentialrolesummaryCreatedByV1 = EntitycreatedbydtoV1 | string; + +/** + * + * @export + * @interface RoleminingpotentialrolesummaryV1 + */ +export interface RoleminingpotentialrolesummaryV1 { + /** + * Id of the potential role + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'id'?: string; + /** + * Name of the potential role + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'name'?: string; + /** + * + * @type {RoleminingpotentialrolerefV1} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'potentialRoleRef'?: RoleminingpotentialrolerefV1; + /** + * The number of identities in a potential role. + * @type {number} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'identityCount'?: number; + /** + * The number of entitlements in a potential role. + * @type {number} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'entitlementCount'?: number; + /** + * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'identityGroupStatus'?: string; + /** + * + * @type {RoleminingpotentialroleprovisionstateV1} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'provisionState'?: RoleminingpotentialroleprovisionstateV1; + /** + * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'roleId'?: string | null; + /** + * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. + * @type {number} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'density'?: number; + /** + * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. + * @type {number} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'freshness'?: number; + /** + * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. + * @type {number} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'quality'?: number; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'type'?: RoleminingroletypeV1; + /** + * + * @type {RoleminingpotentialrolesummaryCreatedByV1} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'createdBy'?: RoleminingpotentialrolesummaryCreatedByV1; + /** + * The date-time when this potential role was created. + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'createdDate'?: string; + /** + * The potential role\'s saved status + * @type {boolean} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'saved'?: boolean; + /** + * Description of the potential role + * @type {string} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'description'?: string | null; + /** + * + * @type {RoleminingsessionparametersdtoV1} + * @memberof RoleminingpotentialrolesummaryV1 + */ + 'session'?: RoleminingsessionparametersdtoV1; +} + + +/** + * Role type + * @export + * @enum {string} + */ + +export const RoleminingroletypeV1 = { + Specialized: 'SPECIALIZED', + Common: 'COMMON' +} as const; + +export type RoleminingroletypeV1 = typeof RoleminingroletypeV1[keyof typeof RoleminingroletypeV1]; + + +/** + * + * @export + * @interface RoleminingsessiondraftroledtoV1 + */ +export interface RoleminingsessiondraftroledtoV1 { + /** + * Name of the draft role + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'name'?: string; + /** + * Draft role description + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'description'?: string; + /** + * The list of identities for this role mining session. + * @type {Array} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'identityIds'?: Array; + /** + * The list of entitlement ids for this role mining session. + * @type {Array} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'entitlementIds'?: Array; + /** + * The list of excluded entitlement ids. + * @type {Array} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'excludedEntitlements'?: Array; + /** + * Last modified date + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'modified'?: string; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'type'?: RoleminingroletypeV1; + /** + * Id of the potential draft role + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'id'?: string; + /** + * The date-time when this potential draft role was created. + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'createdDate'?: string; + /** + * The date-time when this potential draft role was modified. + * @type {string} + * @memberof RoleminingsessiondraftroledtoV1 + */ + 'modifiedDate'?: string; +} + + +/** + * + * @export + * @interface RoleminingsessiondtoV1 + */ +export interface RoleminingsessiondtoV1 { + /** + * + * @type {RoleminingsessionscopeV1} + * @memberof RoleminingsessiondtoV1 + */ + 'scope'?: RoleminingsessionscopeV1; + /** + * The prune threshold to be used or null to calculate prescribedPruneThreshold + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'pruneThreshold'?: number | null; + /** + * The calculated prescribedPruneThreshold + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'prescribedPruneThreshold'?: number | null; + /** + * Minimum number of identities in a potential role + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'minNumIdentitiesInPotentialRole'?: number | null; + /** + * Number of potential roles + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'potentialRoleCount'?: number; + /** + * Number of potential roles ready + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'potentialRolesReadyCount'?: number; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingsessiondtoV1 + */ + 'type'?: RoleminingroletypeV1; + /** + * The id of the user who will receive an email about the role mining session + * @type {string} + * @memberof RoleminingsessiondtoV1 + */ + 'emailRecipientId'?: string | null; + /** + * Number of identities in the population which meet the search criteria or identity list provided + * @type {number} + * @memberof RoleminingsessiondtoV1 + */ + 'identityCount'?: number; + /** + * The session\'s saved status + * @type {boolean} + * @memberof RoleminingsessiondtoV1 + */ + 'saved'?: boolean; + /** + * The session\'s saved name + * @type {string} + * @memberof RoleminingsessiondtoV1 + */ + 'name'?: string | null; +} + + +/** + * + * @export + * @interface RoleminingsessionparametersdtoV1 + */ +export interface RoleminingsessionparametersdtoV1 { + /** + * The ID of the role mining session + * @type {string} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'id'?: string; + /** + * The session\'s saved name + * @type {string} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'name'?: string | null; + /** + * Minimum number of identities in a potential role + * @type {number} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'minNumIdentitiesInPotentialRole'?: number | null; + /** + * The prune threshold to be used or null to calculate prescribedPruneThreshold + * @type {number} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'pruneThreshold'?: number | null; + /** + * The session\'s saved status + * @type {boolean} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'saved'?: boolean; + /** + * + * @type {RoleminingsessionscopeV1} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'scope'?: RoleminingsessionscopeV1; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'type'?: RoleminingroletypeV1; + /** + * + * @type {RoleminingsessionstateV1} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'state'?: RoleminingsessionstateV1; + /** + * + * @type {RoleminingsessionscopingmethodV1} + * @memberof RoleminingsessionparametersdtoV1 + */ + 'scopingMethod'?: RoleminingsessionscopingmethodV1; +} + + +/** + * @type RoleminingsessionresponseCreatedByV1 + * The session created by details + * @export + */ +export type RoleminingsessionresponseCreatedByV1 = EntitycreatedbydtoV1 | string; + +/** + * + * @export + * @interface RoleminingsessionresponseV1 + */ +export interface RoleminingsessionresponseV1 { + /** + * + * @type {RoleminingsessionscopeV1} + * @memberof RoleminingsessionresponseV1 + */ + 'scope'?: RoleminingsessionscopeV1; + /** + * Minimum number of identities in a potential role + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'minNumIdentitiesInPotentialRole'?: number | null; + /** + * The scoping method of the role mining session + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'scopingMethod'?: string | null; + /** + * The computed (or prescribed) prune threshold for this session + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'prescribedPruneThreshold'?: number | null; + /** + * The prune threshold to be used for this role mining session + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'pruneThreshold'?: number | null; + /** + * The number of potential roles + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'potentialRoleCount'?: number; + /** + * The number of potential roles which have completed processing + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'potentialRolesReadyCount'?: number; + /** + * + * @type {RoleminingsessionstatusV1} + * @memberof RoleminingsessionresponseV1 + */ + 'status'?: RoleminingsessionstatusV1; + /** + * The id of the user who will receive an email about the role mining session + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'emailRecipientId'?: string | null; + /** + * + * @type {RoleminingsessionresponseCreatedByV1} + * @memberof RoleminingsessionresponseV1 + */ + 'createdBy'?: RoleminingsessionresponseCreatedByV1; + /** + * The number of identities + * @type {number} + * @memberof RoleminingsessionresponseV1 + */ + 'identityCount'?: number; + /** + * The session\'s saved status + * @type {boolean} + * @memberof RoleminingsessionresponseV1 + */ + 'saved'?: boolean; + /** + * The session\'s saved name + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'name'?: string | null; + /** + * The data file path of the role mining session + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'dataFilePath'?: string | null; + /** + * Session Id for this role mining session + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'id'?: string; + /** + * The date-time when this role mining session was created. + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'createdDate'?: string; + /** + * The date-time when this role mining session was completed. + * @type {string} + * @memberof RoleminingsessionresponseV1 + */ + 'modifiedDate'?: string; + /** + * + * @type {RoleminingroletypeV1} + * @memberof RoleminingsessionresponseV1 + */ + 'type'?: RoleminingroletypeV1; +} + + +/** + * + * @export + * @interface RoleminingsessionscopeV1 + */ +export interface RoleminingsessionscopeV1 { + /** + * The list of identities for this role mining session. + * @type {Array} + * @memberof RoleminingsessionscopeV1 + */ + 'identityIds'?: Array; + /** + * The \"search\" criteria that produces the list of identities for this role mining session. + * @type {string} + * @memberof RoleminingsessionscopeV1 + */ + 'criteria'?: string | null; + /** + * The filter criteria for this role mining session. + * @type {Array} + * @memberof RoleminingsessionscopeV1 + */ + 'attributeFilterCriteria'?: Array | null; +} +/** + * The scoping method used in the current role mining session. + * @export + * @enum {string} + */ + +export const RoleminingsessionscopingmethodV1 = { + Manual: 'MANUAL', + AutoRm: 'AUTO_RM' +} as const; + +export type RoleminingsessionscopingmethodV1 = typeof RoleminingsessionscopingmethodV1[keyof typeof RoleminingsessionscopingmethodV1]; + + +/** + * Role mining session status + * @export + * @enum {string} + */ + +export const RoleminingsessionstateV1 = { + Created: 'CREATED', + Updated: 'UPDATED', + IdentitiesObtained: 'IDENTITIES_OBTAINED', + PruneThresholdObtained: 'PRUNE_THRESHOLD_OBTAINED', + PotentialRolesProcessing: 'POTENTIAL_ROLES_PROCESSING', + PotentialRolesCreated: 'POTENTIAL_ROLES_CREATED' +} as const; + +export type RoleminingsessionstateV1 = typeof RoleminingsessionstateV1[keyof typeof RoleminingsessionstateV1]; + + +/** + * + * @export + * @interface RoleminingsessionstatusV1 + */ +export interface RoleminingsessionstatusV1 { + /** + * + * @type {RoleminingsessionstateV1} + * @memberof RoleminingsessionstatusV1 + */ + 'state'?: RoleminingsessionstateV1; +} + + + +/** + * IAIRoleMiningV1Api - axios parameter creator + * @export + */ +export const IAIRoleMiningV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This method starts a job to provision a potential role + * @summary Create request to provision a potential role into an actual role. + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {RoleminingpotentialroleprovisionrequestV1} [roleminingpotentialroleprovisionrequestV1] Required information to create a new role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPotentialRoleProvisionRequestV1: async (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleminingpotentialroleprovisionrequestV1?: RoleminingpotentialroleprovisionrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('createPotentialRoleProvisionRequestV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('createPotentialRoleProvisionRequestV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/provision` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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; + + if (minEntitlementPopularity !== undefined) { + localVarQueryParameter['min-entitlement-popularity'] = minEntitlementPopularity; + } + + if (includeCommonAccess !== undefined) { + localVarQueryParameter['include-common-access'] = includeCommonAccess; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(roleminingpotentialroleprovisionrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This submits a create role mining session request to the role mining application. + * @summary Create a role mining session + * @param {RoleminingsessiondtoV1} roleminingsessiondtoV1 Role mining session parameters + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createRoleMiningSessionsV1: async (roleminingsessiondtoV1: RoleminingsessiondtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleminingsessiondtoV1' is not null or undefined + assertParamExists('createRoleMiningSessionsV1', 'roleminingsessiondtoV1', roleminingsessiondtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(roleminingsessiondtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint downloads a completed export of information for a potential role in a role mining session. + * @summary Export (download) details for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} exportId The id of a previously run export job for this potential role + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + downloadRoleMiningPotentialRoleZipV1: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('downloadRoleMiningPotentialRoleZipV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('downloadRoleMiningPotentialRoleZipV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'exportId' is not null or undefined + assertParamExists('downloadRoleMiningPotentialRoleZipV1', 'exportId', exportId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) + .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {RoleminingpotentialroleexportrequestV1} [roleminingpotentialroleexportrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleAsyncV1: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleminingpotentialroleexportrequestV1?: RoleminingpotentialroleexportrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleAsyncV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleAsyncV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(roleminingpotentialroleexportrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint retrieves information about the current status of a potential role export. + * @summary Retrieve status of a potential role export job + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} exportId The id of a previously run export job for this potential role + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleStatusV1: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleStatusV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleStatusV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'exportId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleStatusV1', 'exportId', exportId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) + .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + * @summary Export (download) details for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleV1: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('exportRoleMiningPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns all potential role summaries that match the query parameters + * @summary Retrieves all potential role summaries + * @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: **createdDate, identityCount, entitlementCount, freshness, quality** + * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAllPotentialRoleSummariesV1: async (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-potential-roles/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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns entitlement popularity distribution for a potential role in a role mining session. + * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementDistributionPotentialRoleV1: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getEntitlementDistributionPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getEntitlementDistributionPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (includeCommonAccess !== undefined) { + localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns entitlements for a potential role in a role mining session. + * @summary Retrieves entitlements for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not + * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. + * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementsPotentialRoleV1: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getEntitlementsPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getEntitlementsPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (includeCommonAccess !== undefined) { + localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns excluded entitlements for a potential role in a role mining session. + * @summary Retrieves excluded entitlements for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **popularity** + * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getExcludedEntitlementsPotentialRoleV1: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getExcludedEntitlementsPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getExcludedEntitlementsPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns identities for a potential role in a role mining session. + * @summary Retrieves identities for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitiesPotentialRoleV1: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getIdentitiesPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getIdentitiesPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/identities` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns the applications of a potential role for a role mining session. + * @summary Retrieves the applications of a potential role for a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **applicationName**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleApplicationsV1: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getPotentialRoleApplicationsV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getPotentialRoleApplicationsV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns the entitlements of a potential role for a role mining session. + * @summary Retrieves the entitlements of a potential role for a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleEntitlementsV1: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getPotentialRoleEntitlementsV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getPotentialRoleEntitlementsV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + * @summary Retrieves potential role source usage + * @param {string} potentialRoleId A potential role id + * @param {string} sourceId A source id + * @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 is supported for the following fields: **displayName, email, usageCount** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleSourceIdentityUsageV1: async (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getPotentialRoleSourceIdentityUsageV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getPotentialRoleSourceIdentityUsageV1', 'sourceId', sourceId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-potential-roles/v1/{potentialRoleId}/sources/{sourceId}/identityUsage` + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns the potential role summaries for a role mining session. + * @summary Retrieves all potential role summaries + * @param {string} sessionId The role mining session id + * @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: **createdDate** + * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleSummariesV1: async (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getPotentialRoleSummariesV1', 'sessionId', sessionId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-role-summaries` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns a specific potential role for a role mining session. + * @summary Retrieves a specific potential role + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleV1: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns a specific potential role. + * @summary Retrieves a specific potential role + * @param {string} potentialRoleId A potential role id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningPotentialRoleV1: async (potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('getRoleMiningPotentialRoleV1', 'potentialRoleId', potentialRoleId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-potential-roles/v1/{potentialRoleId}` + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns a role mining session status for a customer. + * @summary Get role mining session status state + * @param {string} sessionId The role mining session id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionStatusV1: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getRoleMiningSessionStatusV1', 'sessionId', sessionId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/status` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The method retrieves a role mining session. + * @summary Get a role mining session + * @param {string} sessionId The role mining session id to be retrieved. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionV1: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('getRoleMiningSessionV1', 'sessionId', sessionId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns all role mining sessions that match the query parameters + * @summary Retrieves all role mining sessions + * @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: **saved**: *eq* **name**: *eq, sw* + * @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: **createdBy, createdDate** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionsV1: async (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns all saved potential roles (draft roles). + * @summary Retrieves all saved potential roles + * @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 is supported for the following fields: **modified** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSavedPotentialRolesV1: async (sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-potential-roles/v1/saved`; + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId The potential role summary id + * @param {Array} jsonpatchoperationroleminingV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPotentialRoleSessionV1: async (sessionId: string, potentialRoleId: string, jsonpatchoperationroleminingV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('patchPotentialRoleSessionV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('patchPotentialRoleSessionV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'jsonpatchoperationroleminingV1' is not null or undefined + assertParamExists('patchPotentialRoleSessionV1', 'jsonpatchoperationroleminingV1', jsonpatchoperationroleminingV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationroleminingV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId The potential role summary id + * @param {Array} jsonpatchoperationroleminingV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPotentialRoleV1: async (sessionId: string, potentialRoleId: string, jsonpatchoperationroleminingV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('patchPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('patchPotentialRoleV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'jsonpatchoperationroleminingV1' is not null or undefined + assertParamExists('patchPotentialRoleV1', 'jsonpatchoperationroleminingV1', jsonpatchoperationroleminingV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-potential-roles/v1/{potentialRoleId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationroleminingV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + * @summary Patch a role mining session + * @param {string} sessionId The role mining session id to be patched + * @param {Array} jsonpatchoperationV1 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchRoleMiningSessionV1: async (sessionId: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('patchRoleMiningSessionV1', 'sessionId', sessionId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchRoleMiningSessionV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint adds or removes entitlements from an exclusion list for a potential role. + * @summary Edit entitlements for a potential role to exclude some entitlements + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {RoleminingpotentialroleeditentitlementsV1} roleminingpotentialroleeditentitlementsV1 Role mining session parameters + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementsPotentialRoleV1: async (sessionId: string, potentialRoleId: string, roleminingpotentialroleeditentitlementsV1: RoleminingpotentialroleeditentitlementsV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sessionId' is not null or undefined + assertParamExists('updateEntitlementsPotentialRoleV1', 'sessionId', sessionId) + // verify required parameter 'potentialRoleId' is not null or undefined + assertParamExists('updateEntitlementsPotentialRoleV1', 'potentialRoleId', potentialRoleId) + // verify required parameter 'roleminingpotentialroleeditentitlementsV1' is not null or undefined + assertParamExists('updateEntitlementsPotentialRoleV1', 'roleminingpotentialroleeditentitlementsV1', roleminingpotentialroleeditentitlementsV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` + .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) + .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(roleminingpotentialroleeditentitlementsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IAIRoleMiningV1Api - functional programming interface + * @export + */ +export const IAIRoleMiningV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IAIRoleMiningV1ApiAxiosParamCreator(configuration) + return { + /** + * This method starts a job to provision a potential role + * @summary Create request to provision a potential role into an actual role. + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {RoleminingpotentialroleprovisionrequestV1} [roleminingpotentialroleprovisionrequestV1] Required information to create a new role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createPotentialRoleProvisionRequestV1(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleminingpotentialroleprovisionrequestV1?: RoleminingpotentialroleprovisionrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createPotentialRoleProvisionRequestV1(sessionId, potentialRoleId, minEntitlementPopularity, includeCommonAccess, xSailPointExperimental, roleminingpotentialroleprovisionrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.createPotentialRoleProvisionRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This submits a create role mining session request to the role mining application. + * @summary Create a role mining session + * @param {RoleminingsessiondtoV1} roleminingsessiondtoV1 Role mining session parameters + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createRoleMiningSessionsV1(roleminingsessiondtoV1: RoleminingsessiondtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMiningSessionsV1(roleminingsessiondtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.createRoleMiningSessionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint downloads a completed export of information for a potential role in a role mining session. + * @summary Export (download) details for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} exportId The id of a previously run export job for this potential role + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async downloadRoleMiningPotentialRoleZipV1(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleMiningPotentialRoleZipV1(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.downloadRoleMiningPotentialRoleZipV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {RoleminingpotentialroleexportrequestV1} [roleminingpotentialroleexportrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportRoleMiningPotentialRoleAsyncV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleminingpotentialroleexportrequestV1?: RoleminingpotentialroleexportrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleAsyncV1(sessionId, potentialRoleId, xSailPointExperimental, roleminingpotentialroleexportrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.exportRoleMiningPotentialRoleAsyncV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint retrieves information about the current status of a potential role export. + * @summary Retrieve status of a potential role export job + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} exportId The id of a previously run export job for this potential role + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportRoleMiningPotentialRoleStatusV1(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleStatusV1(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.exportRoleMiningPotentialRoleStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + * @summary Export (download) details for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportRoleMiningPotentialRoleV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleV1(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.exportRoleMiningPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns all potential role summaries that match the query parameters + * @summary Retrieves all potential role summaries + * @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: **createdDate, identityCount, entitlementCount, freshness, quality** + * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAllPotentialRoleSummariesV1(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPotentialRoleSummariesV1(sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getAllPotentialRoleSummariesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns entitlement popularity distribution for a potential role in a role mining session. + * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementDistributionPotentialRoleV1(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDistributionPotentialRoleV1(sessionId, potentialRoleId, includeCommonAccess, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getEntitlementDistributionPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns entitlements for a potential role in a role mining session. + * @summary Retrieves entitlements for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not + * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. + * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsPotentialRoleV1(sessionId, potentialRoleId, includeCommonAccess, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getEntitlementsPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns excluded entitlements for a potential role in a role mining session. + * @summary Retrieves excluded entitlements for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **popularity** + * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getExcludedEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getExcludedEntitlementsPotentialRoleV1(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getExcludedEntitlementsPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns identities for a potential role in a role mining session. + * @summary Retrieves identities for a potential role in a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentitiesPotentialRoleV1(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitiesPotentialRoleV1(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getIdentitiesPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns the applications of a potential role for a role mining session. + * @summary Retrieves the applications of a potential role for a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **applicationName**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPotentialRoleApplicationsV1(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleApplicationsV1(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getPotentialRoleApplicationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns the entitlements of a potential role for a role mining session. + * @summary Retrieves the entitlements of a potential role for a role mining session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @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: **entitlementRef.name**: *sw* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPotentialRoleEntitlementsV1(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleEntitlementsV1(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getPotentialRoleEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + * @summary Retrieves potential role source usage + * @param {string} potentialRoleId A potential role id + * @param {string} sourceId A source id + * @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 is supported for the following fields: **displayName, email, usageCount** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPotentialRoleSourceIdentityUsageV1(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSourceIdentityUsageV1(potentialRoleId, sourceId, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getPotentialRoleSourceIdentityUsageV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns the potential role summaries for a role mining session. + * @summary Retrieves all potential role summaries + * @param {string} sessionId The role mining session id + * @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: **createdDate** + * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPotentialRoleSummariesV1(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSummariesV1(sessionId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getPotentialRoleSummariesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns a specific potential role for a role mining session. + * @summary Retrieves a specific potential role + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPotentialRoleV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleV1(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns a specific potential role. + * @summary Retrieves a specific potential role + * @param {string} potentialRoleId A potential role id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleMiningPotentialRoleV1(potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningPotentialRoleV1(potentialRoleId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getRoleMiningPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns a role mining session status for a customer. + * @summary Get role mining session status state + * @param {string} sessionId The role mining session id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleMiningSessionStatusV1(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionStatusV1(sessionId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getRoleMiningSessionStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The method retrieves a role mining session. + * @summary Get a role mining session + * @param {string} sessionId The role mining session id to be retrieved. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleMiningSessionV1(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionV1(sessionId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getRoleMiningSessionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns all role mining sessions that match the query parameters + * @summary Retrieves all role mining sessions + * @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: **saved**: *eq* **name**: *eq, sw* + * @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: **createdBy, createdDate** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleMiningSessionsV1(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionsV1(filters, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getRoleMiningSessionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns all saved potential roles (draft roles). + * @summary Retrieves all saved potential roles + * @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 is supported for the following fields: **modified** + * @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} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSavedPotentialRolesV1(sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedPotentialRolesV1(sorters, offset, limit, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.getSavedPotentialRolesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role session + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId The potential role summary id + * @param {Array} jsonpatchoperationroleminingV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchPotentialRoleSessionV1(sessionId: string, potentialRoleId: string, jsonpatchoperationroleminingV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleSessionV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.patchPotentialRoleSessionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId The potential role summary id + * @param {Array} jsonpatchoperationroleminingV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchPotentialRoleV1(sessionId: string, potentialRoleId: string, jsonpatchoperationroleminingV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.patchPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + * @summary Patch a role mining session + * @param {string} sessionId The role mining session id to be patched + * @param {Array} jsonpatchoperationV1 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchRoleMiningSessionV1(sessionId: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningSessionV1(sessionId, jsonpatchoperationV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.patchRoleMiningSessionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint adds or removes entitlements from an exclusion list for a potential role. + * @summary Edit entitlements for a potential role to exclude some entitlements + * @param {string} sessionId The role mining session id + * @param {string} potentialRoleId A potential role id in a role mining session + * @param {RoleminingpotentialroleeditentitlementsV1} roleminingpotentialroleeditentitlementsV1 Role mining session parameters + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, roleminingpotentialroleeditentitlementsV1: RoleminingpotentialroleeditentitlementsV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsPotentialRoleV1(sessionId, potentialRoleId, roleminingpotentialroleeditentitlementsV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV1Api.updateEntitlementsPotentialRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IAIRoleMiningV1Api - factory interface + * @export + */ +export const IAIRoleMiningV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IAIRoleMiningV1ApiFp(configuration) + return { + /** + * This method starts a job to provision a potential role + * @summary Create request to provision a potential role into an actual role. + * @param {IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPotentialRoleProvisionRequestV1(requestParameters: IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createPotentialRoleProvisionRequestV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleminingpotentialroleprovisionrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This submits a create role mining session request to the role mining application. + * @summary Create a role mining session + * @param {IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createRoleMiningSessionsV1(requestParameters: IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createRoleMiningSessionsV1(requestParameters.roleminingsessiondtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint downloads a completed export of information for a potential role in a role mining session. + * @summary Export (download) details for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + downloadRoleMiningPotentialRoleZipV1(requestParameters: IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.downloadRoleMiningPotentialRoleZipV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleAsyncV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportRoleMiningPotentialRoleAsyncV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleminingpotentialroleexportrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint retrieves information about the current status of a potential role export. + * @summary Retrieve status of a potential role export job + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleStatusV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportRoleMiningPotentialRoleStatusV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + * @summary Export (download) details for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportRoleMiningPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns all potential role summaries that match the query parameters + * @summary Retrieves all potential role summaries + * @param {IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAllPotentialRoleSummariesV1(requestParameters: IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAllPotentialRoleSummariesV1(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns entitlement popularity distribution for a potential role in a role mining session. + * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementDistributionPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }> { + return localVarFp.getEntitlementDistributionPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns entitlements for a potential role in a role mining session. + * @summary Retrieves entitlements for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns excluded entitlements for a potential role in a role mining session. + * @summary Retrieves excluded entitlements for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getExcludedEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getExcludedEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns identities for a potential role in a role mining session. + * @summary Retrieves identities for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitiesPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentitiesPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns the applications of a potential role for a role mining session. + * @summary Retrieves the applications of a potential role for a role mining session + * @param {IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleApplicationsV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPotentialRoleApplicationsV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns the entitlements of a potential role for a role mining session. + * @summary Retrieves the entitlements of a potential role for a role mining session + * @param {IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleEntitlementsV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPotentialRoleEntitlementsV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + * @summary Retrieves potential role source usage + * @param {IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleSourceIdentityUsageV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPotentialRoleSourceIdentityUsageV1(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns the potential role summaries for a role mining session. + * @summary Retrieves all potential role summaries + * @param {IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleSummariesV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPotentialRoleSummariesV1(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns a specific potential role for a role mining session. + * @summary Retrieves a specific potential role + * @param {IAIRoleMiningV1ApiGetPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns a specific potential role. + * @summary Retrieves a specific potential role + * @param {IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleMiningPotentialRoleV1(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns a role mining session status for a customer. + * @summary Get role mining session status state + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionStatusV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleMiningSessionStatusV1(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The method retrieves a role mining session. + * @summary Get a role mining session + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleMiningSessionV1(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns all role mining sessions that match the query parameters + * @summary Retrieves all role mining sessions + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleMiningSessionsV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleMiningSessionsV1(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns all saved potential roles (draft roles). + * @summary Retrieves all saved potential roles + * @param {IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSavedPotentialRolesV1(requestParameters: IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSavedPotentialRolesV1(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role session + * @param {IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPotentialRoleSessionV1(requestParameters: IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchPotentialRoleSessionV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonpatchoperationroleminingV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role + * @param {IAIRoleMiningV1ApiPatchPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiPatchPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonpatchoperationroleminingV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + * @summary Patch a role mining session + * @param {IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchRoleMiningSessionV1(requestParameters: IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchRoleMiningSessionV1(requestParameters.sessionId, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint adds or removes entitlements from an exclusion list for a potential role. + * @summary Edit entitlements for a potential role to exclude some entitlements + * @param {IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleminingpotentialroleeditentitlementsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createPotentialRoleProvisionRequestV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request + */ +export interface IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly potentialRoleId: string + + /** + * Minimum popularity required for an entitlement to be included in the provisioned role. + * @type {number} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly minEntitlementPopularity?: number + + /** + * Boolean determining whether common access entitlements will be included in the provisioned role. + * @type {boolean} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly includeCommonAccess?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly xSailPointExperimental?: string + + /** + * Required information to create a new role + * @type {RoleminingpotentialroleprovisionrequestV1} + * @memberof IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1 + */ + readonly roleminingpotentialroleprovisionrequestV1?: RoleminingpotentialroleprovisionrequestV1 +} + +/** + * Request parameters for createRoleMiningSessionsV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request + */ +export interface IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request { + /** + * Role mining session parameters + * @type {RoleminingsessiondtoV1} + * @memberof IAIRoleMiningV1ApiCreateRoleMiningSessionsV1 + */ + readonly roleminingsessiondtoV1: RoleminingsessiondtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiCreateRoleMiningSessionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for downloadRoleMiningPotentialRoleZipV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request + */ +export interface IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1 + */ + readonly potentialRoleId: string + + /** + * The id of a previously run export job for this potential role + * @type {string} + * @memberof IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1 + */ + readonly exportId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for exportRoleMiningPotentialRoleAsyncV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request + */ +export interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1 + */ + readonly potentialRoleId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1 + */ + readonly xSailPointExperimental?: string + + /** + * + * @type {RoleminingpotentialroleexportrequestV1} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1 + */ + readonly roleminingpotentialroleexportrequestV1?: RoleminingpotentialroleexportrequestV1 +} + +/** + * Request parameters for exportRoleMiningPotentialRoleStatusV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request + */ +export interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1 + */ + readonly potentialRoleId: string + + /** + * The id of a previously run export job for this potential role + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1 + */ + readonly exportId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for exportRoleMiningPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getAllPotentialRoleSummariesV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request + */ +export interface IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request { + /** + * 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: **createdDate, identityCount, entitlementCount, freshness, quality** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + 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 IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + 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 IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getEntitlementDistributionPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Boolean determining whether common access entitlements will be included or not + * @type {boolean} + * @memberof IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1 + */ + readonly includeCommonAccess?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getEntitlementsPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Boolean determining whether common access entitlements will be included or not + * @type {boolean} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly includeCommonAccess?: boolean + + /** + * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getExcludedEntitlementsPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly potentialRoleId: 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: **popularity** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentitiesPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly potentialRoleId: 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: **name** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly sorters?: 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: **name**: *sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + 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 IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPotentialRoleApplicationsV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request + */ +export interface IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + readonly potentialRoleId: 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: **applicationName**: *sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPotentialRoleEntitlementsV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request + */ +export interface IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + readonly potentialRoleId: 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: **entitlementRef.name**: *sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPotentialRoleSourceIdentityUsageV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request + */ +export interface IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request { + /** + * A potential role id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + readonly potentialRoleId: string + + /** + * A source id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + readonly sourceId: string + + /** + * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + readonly sorters?: string + + /** + * 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 IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPotentialRoleSummariesV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request + */ +export interface IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + readonly sessionId: 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: **createdDate** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + readonly filters?: string + + /** + * 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 IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + 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 IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleSummariesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleMiningPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request { + /** + * A potential role id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleMiningSessionStatusV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request + */ +export interface IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1 + */ + readonly sessionId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleMiningSessionV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetRoleMiningSessionV1Request + */ +export interface IAIRoleMiningV1ApiGetRoleMiningSessionV1Request { + /** + * The role mining session id to be retrieved. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionV1 + */ + readonly sessionId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleMiningSessionsV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request + */ +export interface IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request { + /** + * 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: **saved**: *eq* **name**: *eq, sw* + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + 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: **createdBy, createdDate** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + readonly sorters?: string + + /** + * 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 IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + 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 IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + 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 IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetRoleMiningSessionsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSavedPotentialRolesV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request + */ +export interface IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request { + /** + * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** + * @type {string} + * @memberof IAIRoleMiningV1ApiGetSavedPotentialRolesV1 + */ + readonly sorters?: string + + /** + * 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 IAIRoleMiningV1ApiGetSavedPotentialRolesV1 + */ + 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 IAIRoleMiningV1ApiGetSavedPotentialRolesV1 + */ + 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 IAIRoleMiningV1ApiGetSavedPotentialRolesV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiGetSavedPotentialRolesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchPotentialRoleSessionV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request + */ +export interface IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleSessionV1 + */ + readonly sessionId: string + + /** + * The potential role summary id + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleSessionV1 + */ + readonly potentialRoleId: string + + /** + * + * @type {Array} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleSessionV1 + */ + readonly jsonpatchoperationroleminingV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleSessionV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiPatchPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiPatchPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleV1 + */ + readonly sessionId: string + + /** + * The potential role summary id + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * + * @type {Array} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleV1 + */ + readonly jsonpatchoperationroleminingV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchRoleMiningSessionV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request + */ +export interface IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request { + /** + * The role mining session id to be patched + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchRoleMiningSessionV1 + */ + readonly sessionId: string + + /** + * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + * @type {Array} + * @memberof IAIRoleMiningV1ApiPatchRoleMiningSessionV1 + */ + readonly jsonpatchoperationV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiPatchRoleMiningSessionV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateEntitlementsPotentialRoleV1 operation in IAIRoleMiningV1Api. + * @export + * @interface IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request + */ +export interface IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request { + /** + * The role mining session id + * @type {string} + * @memberof IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1 + */ + readonly sessionId: string + + /** + * A potential role id in a role mining session + * @type {string} + * @memberof IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1 + */ + readonly potentialRoleId: string + + /** + * Role mining session parameters + * @type {RoleminingpotentialroleeditentitlementsV1} + * @memberof IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1 + */ + readonly roleminingpotentialroleeditentitlementsV1: RoleminingpotentialroleeditentitlementsV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IAIRoleMiningV1Api - object-oriented interface + * @export + * @class IAIRoleMiningV1Api + * @extends {BaseAPI} + */ +export class IAIRoleMiningV1Api extends BaseAPI { + /** + * This method starts a job to provision a potential role + * @summary Create request to provision a potential role into an actual role. + * @param {IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public createPotentialRoleProvisionRequestV1(requestParameters: IAIRoleMiningV1ApiCreatePotentialRoleProvisionRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).createPotentialRoleProvisionRequestV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleminingpotentialroleprovisionrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This submits a create role mining session request to the role mining application. + * @summary Create a role mining session + * @param {IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public createRoleMiningSessionsV1(requestParameters: IAIRoleMiningV1ApiCreateRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).createRoleMiningSessionsV1(requestParameters.roleminingsessiondtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint downloads a completed export of information for a potential role in a role mining session. + * @summary Export (download) details for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public downloadRoleMiningPotentialRoleZipV1(requestParameters: IAIRoleMiningV1ApiDownloadRoleMiningPotentialRoleZipV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).downloadRoleMiningPotentialRoleZipV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public exportRoleMiningPotentialRoleAsyncV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleAsyncV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).exportRoleMiningPotentialRoleAsyncV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleminingpotentialroleexportrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint retrieves information about the current status of a potential role export. + * @summary Retrieve status of a potential role export job + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public exportRoleMiningPotentialRoleStatusV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).exportRoleMiningPotentialRoleStatusV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + * @summary Export (download) details for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public exportRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiExportRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).exportRoleMiningPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns all potential role summaries that match the query parameters + * @summary Retrieves all potential role summaries + * @param {IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getAllPotentialRoleSummariesV1(requestParameters: IAIRoleMiningV1ApiGetAllPotentialRoleSummariesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getAllPotentialRoleSummariesV1(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns entitlement popularity distribution for a potential role in a role mining session. + * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getEntitlementDistributionPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetEntitlementDistributionPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getEntitlementDistributionPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns entitlements for a potential role in a role mining session. + * @summary Retrieves entitlements for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns excluded entitlements for a potential role in a role mining session. + * @summary Retrieves excluded entitlements for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getExcludedEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetExcludedEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getExcludedEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns identities for a potential role in a role mining session. + * @summary Retrieves identities for a potential role in a role mining session + * @param {IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getIdentitiesPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetIdentitiesPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getIdentitiesPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns the applications of a potential role for a role mining session. + * @summary Retrieves the applications of a potential role for a role mining session + * @param {IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getPotentialRoleApplicationsV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getPotentialRoleApplicationsV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns the entitlements of a potential role for a role mining session. + * @summary Retrieves the entitlements of a potential role for a role mining session + * @param {IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getPotentialRoleEntitlementsV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getPotentialRoleEntitlementsV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + * @summary Retrieves potential role source usage + * @param {IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getPotentialRoleSourceIdentityUsageV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleSourceIdentityUsageV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getPotentialRoleSourceIdentityUsageV1(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns the potential role summaries for a role mining session. + * @summary Retrieves all potential role summaries + * @param {IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getPotentialRoleSummariesV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getPotentialRoleSummariesV1(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns a specific potential role for a role mining session. + * @summary Retrieves a specific potential role + * @param {IAIRoleMiningV1ApiGetPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns a specific potential role. + * @summary Retrieves a specific potential role + * @param {IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getRoleMiningPotentialRoleV1(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns a role mining session status for a customer. + * @summary Get role mining session status state + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getRoleMiningSessionStatusV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getRoleMiningSessionStatusV1(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The method retrieves a role mining session. + * @summary Get a role mining session + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getRoleMiningSessionV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getRoleMiningSessionV1(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns all role mining sessions that match the query parameters + * @summary Retrieves all role mining sessions + * @param {IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getRoleMiningSessionsV1(requestParameters: IAIRoleMiningV1ApiGetRoleMiningSessionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getRoleMiningSessionsV1(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns all saved potential roles (draft roles). + * @summary Retrieves all saved potential roles + * @param {IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public getSavedPotentialRolesV1(requestParameters: IAIRoleMiningV1ApiGetSavedPotentialRolesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).getSavedPotentialRolesV1(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role session + * @param {IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public patchPotentialRoleSessionV1(requestParameters: IAIRoleMiningV1ApiPatchPotentialRoleSessionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).patchPotentialRoleSessionV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonpatchoperationroleminingV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** + * @summary Update a potential role + * @param {IAIRoleMiningV1ApiPatchPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public patchPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiPatchPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).patchPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonpatchoperationroleminingV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + * @summary Patch a role mining session + * @param {IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public patchRoleMiningSessionV1(requestParameters: IAIRoleMiningV1ApiPatchRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).patchRoleMiningSessionV1(requestParameters.sessionId, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint adds or removes entitlements from an exclusion list for a potential role. + * @summary Edit entitlements for a potential role to exclude some entitlements + * @param {IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IAIRoleMiningV1Api + */ + public updateEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningV1ApiUpdateEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IAIRoleMiningV1ApiFp(this.configuration).updateEntitlementsPotentialRoleV1(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleminingpotentialroleeditentitlementsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/iai_role_mining/base.ts b/sdk-output/iai_role_mining/base.ts new file mode 100644 index 00000000..69380d01 --- /dev/null +++ b/sdk-output/iai_role_mining/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Role Mining + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/iai_role_mining/common.ts b/sdk-output/iai_role_mining/common.ts new file mode 100644 index 00000000..ff79a310 --- /dev/null +++ b/sdk-output/iai_role_mining/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Role Mining + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/iai_role_mining/configuration.ts b/sdk-output/iai_role_mining/configuration.ts new file mode 100644 index 00000000..8554f10f --- /dev/null +++ b/sdk-output/iai_role_mining/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Role Mining + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/iai_role_mining/git_push.sh b/sdk-output/iai_role_mining/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/iai_role_mining/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/iai_role_mining/index.ts b/sdk-output/iai_role_mining/index.ts new file mode 100644 index 00000000..38bd37df --- /dev/null +++ b/sdk-output/iai_role_mining/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - IAI Role Mining + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/iai_role_mining/package.json b/sdk-output/iai_role_mining/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/iai_role_mining/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/iai_role_mining/tsconfig.json b/sdk-output/iai_role_mining/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/iai_role_mining/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/icons/.gitignore b/sdk-output/icons/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/icons/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/icons/.npmignore b/sdk-output/icons/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/icons/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/icons/.openapi-generator-ignore b/sdk-output/icons/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/icons/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/icons/.openapi-generator/FILES b/sdk-output/icons/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/icons/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/icons/.openapi-generator/VERSION b/sdk-output/icons/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/icons/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/icons/.sdk-partition b/sdk-output/icons/.sdk-partition new file mode 100644 index 00000000..9b4cf893 --- /dev/null +++ b/sdk-output/icons/.sdk-partition @@ -0,0 +1 @@ +icons \ No newline at end of file diff --git a/sdk-output/icons/README.md b/sdk-output/icons/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/icons/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/icons/api.ts b/sdk-output/icons/api.ts new file mode 100644 index 00000000..b4fee52c --- /dev/null +++ b/sdk-output/icons/api.ts @@ -0,0 +1,444 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Icons + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SetIconV1200ResponseV1 + */ +export interface SetIconV1200ResponseV1 { + /** + * url to file with icon + * @type {string} + * @memberof SetIconV1200ResponseV1 + */ + 'icon'?: string; +} +/** + * + * @export + * @interface SetIconV1401ResponseV1 + */ +export interface SetIconV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SetIconV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface SetIconV1429ResponseV1 + */ +export interface SetIconV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SetIconV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface SetIconV1RequestV1 + */ +export interface SetIconV1RequestV1 { + /** + * file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] + * @type {File} + * @memberof SetIconV1RequestV1 + */ + 'image': File; +} + +/** + * IconsV1Api - axios parameter creator + * @export + */ +export const IconsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Delete an icon + * @param {DeleteIconV1ObjectTypeV1} objectType Object type. Available options [\'application\'] + * @param {string} objectId Object id. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIconV1: async (objectType: DeleteIconV1ObjectTypeV1, objectId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'objectType' is not null or undefined + assertParamExists('deleteIconV1', 'objectType', objectType) + // verify required parameter 'objectId' is not null or undefined + assertParamExists('deleteIconV1', 'objectId', objectId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/icons/v1/{objectType}/{objectId}` + .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) + .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Update an icon + * @param {SetIconV1ObjectTypeV1} objectType Object type. Available options [\'application\'] + * @param {string} objectId Object id. + * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setIconV1: async (objectType: SetIconV1ObjectTypeV1, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'objectType' is not null or undefined + assertParamExists('setIconV1', 'objectType', objectType) + // verify required parameter 'objectId' is not null or undefined + assertParamExists('setIconV1', 'objectId', objectId) + // verify required parameter 'image' is not null or undefined + assertParamExists('setIconV1', 'image', image) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/icons/v1/{objectType}/{objectId}` + .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) + .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (image !== undefined) { + localVarFormParams.append('image', image as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IconsV1Api - functional programming interface + * @export + */ +export const IconsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IconsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Delete an icon + * @param {DeleteIconV1ObjectTypeV1} objectType Object type. Available options [\'application\'] + * @param {string} objectId Object id. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIconV1(objectType: DeleteIconV1ObjectTypeV1, objectId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIconV1(objectType, objectId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IconsV1Api.deleteIconV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Update an icon + * @param {SetIconV1ObjectTypeV1} objectType Object type. Available options [\'application\'] + * @param {string} objectId Object id. + * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setIconV1(objectType: SetIconV1ObjectTypeV1, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setIconV1(objectType, objectId, image, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IconsV1Api.setIconV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IconsV1Api - factory interface + * @export + */ +export const IconsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IconsV1ApiFp(configuration) + return { + /** + * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Delete an icon + * @param {IconsV1ApiDeleteIconV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIconV1(requestParameters: IconsV1ApiDeleteIconV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIconV1(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Update an icon + * @param {IconsV1ApiSetIconV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setIconV1(requestParameters: IconsV1ApiSetIconV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setIconV1(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteIconV1 operation in IconsV1Api. + * @export + * @interface IconsV1ApiDeleteIconV1Request + */ +export interface IconsV1ApiDeleteIconV1Request { + /** + * Object type. Available options [\'application\'] + * @type {'application'} + * @memberof IconsV1ApiDeleteIconV1 + */ + readonly objectType: DeleteIconV1ObjectTypeV1 + + /** + * Object id. + * @type {string} + * @memberof IconsV1ApiDeleteIconV1 + */ + readonly objectId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IconsV1ApiDeleteIconV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setIconV1 operation in IconsV1Api. + * @export + * @interface IconsV1ApiSetIconV1Request + */ +export interface IconsV1ApiSetIconV1Request { + /** + * Object type. Available options [\'application\'] + * @type {'application'} + * @memberof IconsV1ApiSetIconV1 + */ + readonly objectType: SetIconV1ObjectTypeV1 + + /** + * Object id. + * @type {string} + * @memberof IconsV1ApiSetIconV1 + */ + readonly objectId: string + + /** + * file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] + * @type {File} + * @memberof IconsV1ApiSetIconV1 + */ + readonly image: File + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IconsV1ApiSetIconV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IconsV1Api - object-oriented interface + * @export + * @class IconsV1Api + * @extends {BaseAPI} + */ +export class IconsV1Api extends BaseAPI { + /** + * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Delete an icon + * @param {IconsV1ApiDeleteIconV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IconsV1Api + */ + public deleteIconV1(requestParameters: IconsV1ApiDeleteIconV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IconsV1ApiFp(this.configuration).deleteIconV1(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + * @summary Update an icon + * @param {IconsV1ApiSetIconV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IconsV1Api + */ + public setIconV1(requestParameters: IconsV1ApiSetIconV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IconsV1ApiFp(this.configuration).setIconV1(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DeleteIconV1ObjectTypeV1 = { + Application: 'application' +} as const; +export type DeleteIconV1ObjectTypeV1 = typeof DeleteIconV1ObjectTypeV1[keyof typeof DeleteIconV1ObjectTypeV1]; +/** + * @export + */ +export const SetIconV1ObjectTypeV1 = { + Application: 'application' +} as const; +export type SetIconV1ObjectTypeV1 = typeof SetIconV1ObjectTypeV1[keyof typeof SetIconV1ObjectTypeV1]; + + diff --git a/sdk-output/v3/base.ts b/sdk-output/icons/base.ts similarity index 83% rename from sdk-output/v3/base.ts rename to sdk-output/icons/base.ts index b2a29373..86813df1 100644 --- a/sdk-output/v3/base.ts +++ b/sdk-output/icons/base.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V3 API + * Identity Security Cloud API - Icons * 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: 3.0.0 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -19,7 +19,7 @@ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://sailpoint.api.identitynow.com/v3".replace(/\/+$/, ""); +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); /** * @@ -50,10 +50,10 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; - this.basePath = configuration.basePath + "/v3"|| this.basePath; + this.basePath = configuration.basePath || this.basePath; } } }; diff --git a/sdk-output/v2024/common.ts b/sdk-output/icons/common.ts similarity index 83% rename from sdk-output/v2024/common.ts rename to sdk-output/icons/common.ts index 6a92c82d..c3277f06 100644 --- a/sdk-output/v2024/common.ts +++ b/sdk-output/icons/common.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2024 API + * Identity Security Cloud API - Icons * 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: v2024 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,16 +143,15 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) - let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; } userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; const headers = { ...axiosArgs.axiosOptions.headers, - ...{'X-SailPoint-SDK':'typescript-1.8.69'}, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, ...{'User-Agent': userAgent}, } @@ -163,8 +161,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath+ "/v2024" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/v2025/configuration.ts b/sdk-output/icons/configuration.ts similarity index 97% rename from sdk-output/v2025/configuration.ts rename to sdk-output/icons/configuration.ts index 7ad4dbe8..958ffc6a 100644 --- a/sdk-output/v2025/configuration.ts +++ b/sdk-output/icons/configuration.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2025 API + * Identity Security Cloud API - Icons * 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: v2025 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/icons/git_push.sh b/sdk-output/icons/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/icons/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/v2025/index.ts b/sdk-output/icons/index.ts similarity index 87% rename from sdk-output/v2025/index.ts rename to sdk-output/icons/index.ts index 2a480a47..b9eeb1d8 100644 --- a/sdk-output/v2025/index.ts +++ b/sdk-output/icons/index.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2025 API + * Identity Security Cloud API - Icons * 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: v2025 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/icons/package.json b/sdk-output/icons/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/icons/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/icons/tsconfig.json b/sdk-output/icons/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/icons/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/identities/.gitignore b/sdk-output/identities/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/identities/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/identities/.npmignore b/sdk-output/identities/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/identities/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/identities/.openapi-generator-ignore b/sdk-output/identities/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/identities/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/identities/.openapi-generator/FILES b/sdk-output/identities/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/identities/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/identities/.openapi-generator/VERSION b/sdk-output/identities/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/identities/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/identities/.sdk-partition b/sdk-output/identities/.sdk-partition new file mode 100644 index 00000000..be77e30e --- /dev/null +++ b/sdk-output/identities/.sdk-partition @@ -0,0 +1 @@ +identities \ No newline at end of file diff --git a/sdk-output/identities/README.md b/sdk-output/identities/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identities/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identities/api.ts b/sdk-output/identities/api.ts new file mode 100644 index 00000000..4f06aeae --- /dev/null +++ b/sdk-output/identities/api.ts @@ -0,0 +1,2633 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identities + * 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 AccessrequestcontextV1 + */ +export interface AccessrequestcontextV1 { + /** + * + * @type {Array} + * @memberof AccessrequestcontextV1 + */ + 'contextAttributes'?: Array; +} +/** + * + * @export + * @interface AccountinfodtoV1 + */ +export interface AccountinfodtoV1 { + /** + * The unique ID of the account generated by the source system + * @type {string} + * @memberof AccountinfodtoV1 + */ + 'nativeIdentity'?: string; + /** + * Display name for this account + * @type {string} + * @memberof AccountinfodtoV1 + */ + 'displayName'?: string; + /** + * UUID associated with this account + * @type {string} + * @memberof AccountinfodtoV1 + */ + 'uuid'?: string; +} +/** + * + * @export + * @interface AssignmentcontextdtoV1 + */ +export interface AssignmentcontextdtoV1 { + /** + * + * @type {AccessrequestcontextV1} + * @memberof AssignmentcontextdtoV1 + */ + 'requested'?: AccessrequestcontextV1; + /** + * + * @type {Array} + * @memberof AssignmentcontextdtoV1 + */ + 'matched'?: Array; + /** + * Date that the assignment will was evaluated + * @type {string} + * @memberof AssignmentcontextdtoV1 + */ + 'computedDate'?: string; +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface ContextattributedtoV1 + */ +export interface ContextattributedtoV1 { + /** + * The name of the attribute + * @type {string} + * @memberof ContextattributedtoV1 + */ + 'attribute'?: string; + /** + * + * @type {ContextattributedtoValueV1} + * @memberof ContextattributedtoV1 + */ + 'value'?: ContextattributedtoValueV1; + /** + * True if the attribute was derived. + * @type {boolean} + * @memberof ContextattributedtoV1 + */ + 'derived'?: boolean; +} +/** + * @type ContextattributedtoValueV1 + * The value of the attribute. This can be either a string or a multi-valued string + * @export + */ +export type ContextattributedtoValueV1 = Array | string; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetRoleAssignmentsV1200ResponseInnerV1 + */ +export interface GetRoleAssignmentsV1200ResponseInnerV1 { + /** + * Assignment Id + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'id'?: string; + /** + * + * @type {BasereferencedtoV1} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'role'?: BasereferencedtoV1; + /** + * Date that the assignment was added + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'addedDate'?: string; + /** + * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'startDate'?: string | null; + /** + * Date that the assignment will be removed + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'removeDate'?: string | null; + /** + * Comments added by the user when the assignment was made + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'comments'?: string | null; + /** + * Source describing how this assignment was made + * @type {string} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'assignmentSource'?: string; + /** + * + * @type {RoleassignmentdtoAssignerV1} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'assigner'?: RoleassignmentdtoAssignerV1; + /** + * Dimensions assigned related to this role + * @type {Array} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'assignedDimensions'?: Array; + /** + * + * @type {RoleassignmentdtoAssignmentContextV1} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'assignmentContext'?: RoleassignmentdtoAssignmentContextV1; + /** + * + * @type {Array} + * @memberof GetRoleAssignmentsV1200ResponseInnerV1 + */ + 'accountTargets'?: Array; +} +/** + * + * @export + * @interface IdentityLifecycleStateV1 + */ +export interface IdentityLifecycleStateV1 { + /** + * The name of the lifecycle state + * @type {string} + * @memberof IdentityLifecycleStateV1 + */ + 'stateName': string; + /** + * Whether the lifecycle state has been manually or automatically set + * @type {boolean} + * @memberof IdentityLifecycleStateV1 + */ + 'manuallyUpdated': boolean; +} +/** + * Identity\'s manager + * @export + * @interface IdentityManagerRefV1 + */ +export interface IdentityManagerRefV1 { + /** + * DTO type of identity\'s manager + * @type {string} + * @memberof IdentityManagerRefV1 + */ + 'type'?: IdentityManagerRefV1TypeV1; + /** + * ID of identity\'s manager + * @type {string} + * @memberof IdentityManagerRefV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity\'s manager + * @type {string} + * @memberof IdentityManagerRefV1 + */ + 'name'?: string; +} + +export const IdentityManagerRefV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentityManagerRefV1TypeV1 = typeof IdentityManagerRefV1TypeV1[keyof typeof IdentityManagerRefV1TypeV1]; + +/** + * + * @export + * @interface IdentityV1 + */ +export interface IdentityV1 { + /** + * System-generated unique ID of the identity + * @type {string} + * @memberof IdentityV1 + */ + 'id'?: string; + /** + * The identity\'s name is equivalent to its Display Name attribute. + * @type {string} + * @memberof IdentityV1 + */ + 'name': string; + /** + * Creation date of the identity + * @type {string} + * @memberof IdentityV1 + */ + 'created'?: string; + /** + * Last modification date of the identity + * @type {string} + * @memberof IdentityV1 + */ + 'modified'?: string; + /** + * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. + * @type {string} + * @memberof IdentityV1 + */ + 'alias'?: string; + /** + * The email address of the identity + * @type {string} + * @memberof IdentityV1 + */ + 'emailAddress'?: string | null; + /** + * The processing state of the identity + * @type {string} + * @memberof IdentityV1 + */ + 'processingState'?: IdentityV1ProcessingStateV1 | null; + /** + * The identity\'s status in the system + * @type {string} + * @memberof IdentityV1 + */ + 'identityStatus'?: IdentityV1IdentityStatusV1; + /** + * + * @type {IdentityManagerRefV1} + * @memberof IdentityV1 + */ + 'managerRef'?: IdentityManagerRefV1 | null; + /** + * Whether this identity is a manager of another identity + * @type {boolean} + * @memberof IdentityV1 + */ + 'isManager'?: boolean; + /** + * The last time the identity was refreshed by the system + * @type {string} + * @memberof IdentityV1 + */ + 'lastRefresh'?: string; + /** + * A map with the identity attributes for the identity + * @type {object} + * @memberof IdentityV1 + */ + 'attributes'?: object; + /** + * + * @type {IdentityLifecycleStateV1} + * @memberof IdentityV1 + */ + 'lifecycleState'?: IdentityLifecycleStateV1; +} + +export const IdentityV1ProcessingStateV1 = { + Error: 'ERROR', + Ok: 'OK' +} as const; + +export type IdentityV1ProcessingStateV1 = typeof IdentityV1ProcessingStateV1[keyof typeof IdentityV1ProcessingStateV1]; +export const IdentityV1IdentityStatusV1 = { + Unregistered: 'UNREGISTERED', + Registered: 'REGISTERED', + Pending: 'PENDING', + Warning: 'WARNING', + Disabled: 'DISABLED', + Active: 'ACTIVE', + Deactivated: 'DEACTIVATED', + Terminated: 'TERMINATED', + Error: 'ERROR', + Locked: 'LOCKED' +} as const; + +export type IdentityV1IdentityStatusV1 = typeof IdentityV1IdentityStatusV1[keyof typeof IdentityV1IdentityStatusV1]; + +/** + * + * @export + * @interface IdentityassociationdetailsAssociationDetailsInnerV1 + */ +export interface IdentityassociationdetailsAssociationDetailsInnerV1 { + /** + * association type with the identity + * @type {string} + * @memberof IdentityassociationdetailsAssociationDetailsInnerV1 + */ + 'associationType'?: string; + /** + * the specific resource this identity has ownership on + * @type {Array} + * @memberof IdentityassociationdetailsAssociationDetailsInnerV1 + */ + 'entities'?: Array; +} +/** + * + * @export + * @interface IdentityassociationdetailsV1 + */ +export interface IdentityassociationdetailsV1 { + /** + * any additional context information of the http call result + * @type {string} + * @memberof IdentityassociationdetailsV1 + */ + 'message'?: string; + /** + * list of all the resource associations for the identity + * @type {Array} + * @memberof IdentityassociationdetailsV1 + */ + 'associationDetails'?: Array; +} +/** + * + * @export + * @interface IdentityentitiesIdentityEntityV1 + */ +export interface IdentityentitiesIdentityEntityV1 { + /** + * id of the resource to which the identity is associated + * @type {string} + * @memberof IdentityentitiesIdentityEntityV1 + */ + 'id'?: string; + /** + * name of the resource to which the identity is associated + * @type {string} + * @memberof IdentityentitiesIdentityEntityV1 + */ + 'name'?: string; + /** + * type of the resource to which the identity is associated + * @type {string} + * @memberof IdentityentitiesIdentityEntityV1 + */ + 'type'?: string; +} +/** + * + * @export + * @interface IdentityentitiesV1 + */ +export interface IdentityentitiesV1 { + /** + * + * @type {IdentityentitiesIdentityEntityV1} + * @memberof IdentityentitiesV1 + */ + 'identityEntity'?: IdentityentitiesIdentityEntityV1; +} +/** + * + * @export + * @interface IdentityentitlementsV1 + */ +export interface IdentityentitlementsV1 { + /** + * + * @type {TaggedobjectdtoV1} + * @memberof IdentityentitlementsV1 + */ + 'objectRef'?: TaggedobjectdtoV1; + /** + * Labels to be applied to object. + * @type {Array} + * @memberof IdentityentitlementsV1 + */ + 'tags'?: Array; +} +/** + * + * @export + * @interface IdentityownershipassociationdetailsAssociationDetailsInnerV1 + */ +export interface IdentityownershipassociationdetailsAssociationDetailsInnerV1 { + /** + * association type with the identity + * @type {string} + * @memberof IdentityownershipassociationdetailsAssociationDetailsInnerV1 + */ + 'associationType'?: string; + /** + * the specific resource this identity has ownership on + * @type {Array} + * @memberof IdentityownershipassociationdetailsAssociationDetailsInnerV1 + */ + 'entities'?: Array; +} +/** + * + * @export + * @interface IdentityownershipassociationdetailsV1 + */ +export interface IdentityownershipassociationdetailsV1 { + /** + * list of all the resource associations for the identity + * @type {Array} + * @memberof IdentityownershipassociationdetailsV1 + */ + 'associationDetails'?: Array; +} +/** + * + * @export + * @interface IdentitysyncjobV1 + */ +export interface IdentitysyncjobV1 { + /** + * Job ID. + * @type {string} + * @memberof IdentitysyncjobV1 + */ + 'id': string; + /** + * The job status. + * @type {string} + * @memberof IdentitysyncjobV1 + */ + 'status': IdentitysyncjobV1StatusV1; + /** + * + * @type {IdentitysyncpayloadV1} + * @memberof IdentitysyncjobV1 + */ + 'payload': IdentitysyncpayloadV1; +} + +export const IdentitysyncjobV1StatusV1 = { + Queued: 'QUEUED', + InProgress: 'IN_PROGRESS', + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type IdentitysyncjobV1StatusV1 = typeof IdentitysyncjobV1StatusV1[keyof typeof IdentitysyncjobV1StatusV1]; + +/** + * + * @export + * @interface IdentitysyncpayloadV1 + */ +export interface IdentitysyncpayloadV1 { + /** + * Payload type. + * @type {string} + * @memberof IdentitysyncpayloadV1 + */ + 'type': string; + /** + * Payload type. + * @type {string} + * @memberof IdentitysyncpayloadV1 + */ + 'dataJson': string; +} +/** + * + * @export + * @interface InviteidentitiesrequestV1 + */ +export interface InviteidentitiesrequestV1 { + /** + * The list of Identities IDs to invite - required when \'uninvited\' is false + * @type {Array} + * @memberof InviteidentitiesrequestV1 + */ + 'ids'?: Array | null; + /** + * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. + * @type {boolean} + * @memberof InviteidentitiesrequestV1 + */ + 'uninvited'?: boolean; +} +/** + * + * @export + * @interface LifecyclestatedtoV1 + */ +export interface LifecyclestatedtoV1 { + /** + * The name of the lifecycle state + * @type {string} + * @memberof LifecyclestatedtoV1 + */ + 'stateName': string; + /** + * Whether the lifecycle state has been manually or automatically set + * @type {boolean} + * @memberof LifecyclestatedtoV1 + */ + 'manuallyUpdated': boolean; +} +/** + * + * @export + * @interface ListIdentitiesV1401ResponseV1 + */ +export interface ListIdentitiesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentitiesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListIdentitiesV1429ResponseV1 + */ +export interface ListIdentitiesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentitiesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Localized error message to indicate a failed invocation or error if any. + * @export + * @interface LocalizedmessageV1 + */ +export interface LocalizedmessageV1 { + /** + * Message locale + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'locale': string; + /** + * Message text + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'message': string; +} +/** + * + * @export + * @interface ProcessidentitiesrequestV1 + */ +export interface ProcessidentitiesrequestV1 { + /** + * List of up to 250 identity IDs to process. + * @type {Array} + * @memberof ProcessidentitiesrequestV1 + */ + 'identityIds'?: Array; +} +/** + * The identity that performed the assignment. This could be blank or system + * @export + * @interface RoleassignmentdtoAssignerV1 + */ +export interface RoleassignmentdtoAssignerV1 { + /** + * Object type + * @type {string} + * @memberof RoleassignmentdtoAssignerV1 + */ + 'type'?: RoleassignmentdtoAssignerV1TypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof RoleassignmentdtoAssignerV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof RoleassignmentdtoAssignerV1 + */ + 'name'?: string | null; +} + +export const RoleassignmentdtoAssignerV1TypeV1 = { + Identity: 'IDENTITY', + Unknown: 'UNKNOWN' +} as const; + +export type RoleassignmentdtoAssignerV1TypeV1 = typeof RoleassignmentdtoAssignerV1TypeV1[keyof typeof RoleassignmentdtoAssignerV1TypeV1]; + +/** + * + * @export + * @interface RoleassignmentdtoAssignmentContextV1 + */ +export interface RoleassignmentdtoAssignmentContextV1 { + /** + * + * @type {AccessrequestcontextV1} + * @memberof RoleassignmentdtoAssignmentContextV1 + */ + 'requested'?: AccessrequestcontextV1; + /** + * + * @type {Array} + * @memberof RoleassignmentdtoAssignmentContextV1 + */ + 'matched'?: Array; + /** + * Date that the assignment will was evaluated + * @type {string} + * @memberof RoleassignmentdtoAssignmentContextV1 + */ + 'computedDate'?: string; +} +/** + * + * @export + * @interface RoleassignmentdtoV1 + */ +export interface RoleassignmentdtoV1 { + /** + * Assignment Id + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'id'?: string; + /** + * + * @type {BasereferencedtoV1} + * @memberof RoleassignmentdtoV1 + */ + 'role'?: BasereferencedtoV1; + /** + * Comments added by the user when the assignment was made + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'comments'?: string | null; + /** + * Source describing how this assignment was made + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'assignmentSource'?: string; + /** + * + * @type {RoleassignmentdtoAssignerV1} + * @memberof RoleassignmentdtoV1 + */ + 'assigner'?: RoleassignmentdtoAssignerV1; + /** + * Dimensions assigned related to this role + * @type {Array} + * @memberof RoleassignmentdtoV1 + */ + 'assignedDimensions'?: Array; + /** + * + * @type {RoleassignmentdtoAssignmentContextV1} + * @memberof RoleassignmentdtoV1 + */ + 'assignmentContext'?: RoleassignmentdtoAssignmentContextV1; + /** + * + * @type {Array} + * @memberof RoleassignmentdtoV1 + */ + 'accountTargets'?: Array; + /** + * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'startDate'?: string | null; + /** + * Date that the assignment will be removed + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'removeDate'?: string | null; + /** + * Date that the assignment was added + * @type {string} + * @memberof RoleassignmentdtoV1 + */ + 'addedDate'?: string; +} +/** + * + * @export + * @interface RoleassignmentrefV1 + */ +export interface RoleassignmentrefV1 { + /** + * Assignment Id + * @type {string} + * @memberof RoleassignmentrefV1 + */ + 'id'?: string; + /** + * + * @type {BasereferencedtoV1} + * @memberof RoleassignmentrefV1 + */ + 'role'?: BasereferencedtoV1; + /** + * Date that the assignment was added + * @type {string} + * @memberof RoleassignmentrefV1 + */ + 'addedDate'?: string; + /** + * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately + * @type {string} + * @memberof RoleassignmentrefV1 + */ + 'startDate'?: string | null; + /** + * Date that the assignment will be removed + * @type {string} + * @memberof RoleassignmentrefV1 + */ + 'removeDate'?: string | null; +} +/** + * + * @export + * @interface RolematchdtoV1 + */ +export interface RolematchdtoV1 { + /** + * + * @type {BasereferencedtoV1} + * @memberof RolematchdtoV1 + */ + 'roleRef'?: BasereferencedtoV1; + /** + * + * @type {Array} + * @memberof RolematchdtoV1 + */ + 'matchedAttributes'?: Array; +} +/** + * + * @export + * @interface RoletargetdtoV1 + */ +export interface RoletargetdtoV1 { + /** + * + * @type {BasereferencedtoV1} + * @memberof RoletargetdtoV1 + */ + 'source'?: BasereferencedtoV1; + /** + * + * @type {AccountinfodtoV1} + * @memberof RoletargetdtoV1 + */ + 'accountInfo'?: AccountinfodtoV1; + /** + * + * @type {BasereferencedtoV1} + * @memberof RoletargetdtoV1 + */ + 'role'?: BasereferencedtoV1; +} +/** + * + * @export + * @interface SendaccountverificationrequestV1 + */ +export interface SendaccountverificationrequestV1 { + /** + * The source name where identity account password should be reset + * @type {string} + * @memberof SendaccountverificationrequestV1 + */ + 'sourceName'?: string | null; + /** + * The method to send notification + * @type {string} + * @memberof SendaccountverificationrequestV1 + */ + 'via': SendaccountverificationrequestV1ViaV1; +} + +export const SendaccountverificationrequestV1ViaV1 = { + EmailWork: 'EMAIL_WORK', + EmailPersonal: 'EMAIL_PERSONAL', + LinkWork: 'LINK_WORK', + LinkPersonal: 'LINK_PERSONAL' +} as const; + +export type SendaccountverificationrequestV1ViaV1 = typeof SendaccountverificationrequestV1ViaV1[keyof typeof SendaccountverificationrequestV1ViaV1]; + +/** + * + * @export + * @interface TaggedobjectdtoV1 + */ +export interface TaggedobjectdtoV1 { + /** + * DTO type + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'type'?: TaggedobjectdtoV1TypeV1; + /** + * ID of the object this reference applies to + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object this reference applies to + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'name'?: string | null; +} + +export const TaggedobjectdtoV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; + +export type TaggedobjectdtoV1TypeV1 = typeof TaggedobjectdtoV1TypeV1[keyof typeof TaggedobjectdtoV1TypeV1]; + +/** + * + * @export + * @interface TargetV1 + */ +export interface TargetV1 { + /** + * Target ID + * @type {string} + * @memberof TargetV1 + */ + 'id'?: string; + /** + * Target type + * @type {string} + * @memberof TargetV1 + */ + 'type'?: TargetV1TypeV1 | null; + /** + * Target name + * @type {string} + * @memberof TargetV1 + */ + 'name'?: string; +} + +export const TargetV1TypeV1 = { + Application: 'APPLICATION', + Identity: 'IDENTITY' +} as const; + +export type TargetV1TypeV1 = typeof TargetV1TypeV1[keyof typeof TargetV1TypeV1]; + +/** + * Definition of a type of task, used to invoke tasks + * @export + * @interface TaskdefinitionsummaryV1 + */ +export interface TaskdefinitionsummaryV1 { + /** + * System-generated unique ID of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'id': string; + /** + * Name of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'uniqueName': string; + /** + * Description of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'description': string | null; + /** + * Name of the parent of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'parentName': string; + /** + * Executor of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'executor': string | null; + /** + * Formal parameters of the TaskDefinition, without values + * @type {{ [key: string]: any; }} + * @memberof TaskdefinitionsummaryV1 + */ + 'arguments': { [key: string]: any; }; +} +/** + * + * @export + * @interface TaskresultresponseV1 + */ +export interface TaskresultresponseV1 { + /** + * the type of response reference + * @type {string} + * @memberof TaskresultresponseV1 + */ + 'type'?: string; + /** + * the task ID + * @type {string} + * @memberof TaskresultresponseV1 + */ + 'id'?: string; + /** + * the task name (not used in this endpoint, always null) + * @type {string} + * @memberof TaskresultresponseV1 + */ + 'name'?: string; +} +/** + * Task return details + * @export + * @interface TaskreturndetailsV1 + */ +export interface TaskreturndetailsV1 { + /** + * Display name of the TaskReturnDetails + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'name': string; + /** + * Attribute the TaskReturnDetails is for + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'attributeName': string; +} +/** + * Details and current status of a specific task + * @export + * @interface TaskstatusV1 + */ +export interface TaskstatusV1 { + /** + * System-generated unique ID of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'id': string; + /** + * Type of task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'type': TaskstatusV1TypeV1; + /** + * Name of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'uniqueName': string; + /** + * Description of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'description': string; + /** + * Name of the parent of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'parentName': string | null; + /** + * Service to execute the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'launcher': string; + /** + * + * @type {TargetV1} + * @memberof TaskstatusV1 + */ + 'target'?: TargetV1 | null; + /** + * Creation date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'created': string; + /** + * Last modification date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'modified': string | null; + /** + * Launch date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'launched': string | null; + /** + * Completion date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'completed': string | null; + /** + * Completion status of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'completionStatus': TaskstatusV1CompletionStatusV1 | null; + /** + * Messages associated with the task this TaskStatus represents + * @type {Array} + * @memberof TaskstatusV1 + */ + 'messages': Array; + /** + * Return values from the task this TaskStatus represents + * @type {Array} + * @memberof TaskstatusV1 + */ + 'returns': Array; + /** + * Attributes of the task this TaskStatus represents + * @type {{ [key: string]: any; }} + * @memberof TaskstatusV1 + */ + 'attributes': { [key: string]: any; }; + /** + * Current progress of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'progress': string | null; + /** + * Current percentage completion of the task this TaskStatus represents + * @type {number} + * @memberof TaskstatusV1 + */ + 'percentComplete': number; + /** + * + * @type {TaskdefinitionsummaryV1} + * @memberof TaskstatusV1 + */ + 'taskDefinitionSummary'?: TaskdefinitionsummaryV1; +} + +export const TaskstatusV1TypeV1 = { + Quartz: 'QUARTZ', + Qpoc: 'QPOC', + QueuedTask: 'QUEUED_TASK' +} as const; + +export type TaskstatusV1TypeV1 = typeof TaskstatusV1TypeV1[keyof typeof TaskstatusV1TypeV1]; +export const TaskstatusV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + Temperror: 'TEMPERROR' +} as const; + +export type TaskstatusV1CompletionStatusV1 = typeof TaskstatusV1CompletionStatusV1[keyof typeof TaskstatusV1CompletionStatusV1]; + +/** + * + * @export + * @interface TaskstatusmessageParametersInnerV1 + */ +export interface TaskstatusmessageParametersInnerV1 { +} +/** + * TaskStatus Message + * @export + * @interface TaskstatusmessageV1 + */ +export interface TaskstatusmessageV1 { + /** + * Type of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'type': TaskstatusmessageV1TypeV1; + /** + * + * @type {LocalizedmessageV1} + * @memberof TaskstatusmessageV1 + */ + 'localizedText': LocalizedmessageV1 | null; + /** + * Key of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'key': string; + /** + * Message parameters for internationalization + * @type {Array} + * @memberof TaskstatusmessageV1 + */ + 'parameters': Array | null; +} + +export const TaskstatusmessageV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type TaskstatusmessageV1TypeV1 = typeof TaskstatusmessageV1TypeV1[keyof typeof TaskstatusmessageV1TypeV1]; + + +/** + * IdentitiesV1Api - axios parameter creator + * @export + */ +export const IdentitiesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * The API returns successful response if the requested identity was deleted. + * @summary Delete identity + * @param {string} id Identity Id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteIdentityV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/identities/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. + * @summary Get ownership details + * @param {string} identityId Identity ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOwnershipDetailsV1: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getIdentityOwnershipDetailsV1', 'identityId', identityId) + const localVarPath = `/identities/v1/{identityId}/ownership` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a single identity using the Identity ID. + * @summary Identity details + * @param {string} id Identity Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentityV1', 'id', id) + const localVarPath = `/identities/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, + }; + }, + /** + * + * @summary Role assignment details + * @param {string} identityId Identity Id + * @param {string} assignmentId Assignment Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignmentV1: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getRoleAssignmentV1', 'identityId', identityId) + // verify required parameter 'assignmentId' is not null or undefined + assertParamExists('getRoleAssignmentV1', 'assignmentId', assignmentId) + const localVarPath = `/identities/v1/{identityId}/role-assignments/{assignmentId}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) + .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + * @summary List role assignments + * @param {string} identityId Identity Id to get the role assignments for + * @param {string} [roleId] Role Id to filter the role assignments with + * @param {string} [roleName] Role name to filter the role assignments with + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignmentsV1: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getRoleAssignmentsV1', 'identityId', identityId) + const localVarPath = `/identities/v1/{identityId}/role-assignments` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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 (roleId !== undefined) { + localVarQueryParameter['roleId'] = roleId; + } + + if (roleName !== undefined) { + localVarQueryParameter['roleName'] = roleName; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. + * @summary List of entitlements by identity. + * @param {string} id Identity Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsByIdentityV1: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listEntitlementsByIdentityV1', 'id', id) + const localVarPath = `/entitlements/v1/identities/{id}/entitlements` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of identities. + * @summary List identities + * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* + * @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: **name, alias, cloudStatus** + * @param {ListIdentitiesV1DefaultFilterV1} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitiesV1: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterV1, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/identities/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (defaultFilter !== undefined) { + localVarQueryParameter['defaultFilter'] = defaultFilter; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + * @summary Reset an identity + * @param {string} id Identity Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + resetIdentityV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('resetIdentityV1', 'id', id) + const localVarPath = `/identities/v1/{id}/reset` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + * @summary Send password reset email + * @param {string} id Identity ID + * @param {SendaccountverificationrequestV1} sendaccountverificationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendIdentityVerificationAccountTokenV1: async (id: string, sendaccountverificationrequestV1: SendaccountverificationrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('sendIdentityVerificationAccountTokenV1', 'id', id) + // verify required parameter 'sendaccountverificationrequestV1' is not null or undefined + assertParamExists('sendIdentityVerificationAccountTokenV1', 'sendaccountverificationrequestV1', sendaccountverificationrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/identities/v1/{id}/verification/account/send` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendaccountverificationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + * @summary Invite identities to register + * @param {InviteidentitiesrequestV1} inviteidentitiesrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startIdentitiesInviteV1: async (inviteidentitiesrequestV1: InviteidentitiesrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'inviteidentitiesrequestV1' is not null or undefined + assertParamExists('startIdentitiesInviteV1', 'inviteidentitiesrequestV1', inviteidentitiesrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/identities/v1/invite`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(inviteidentitiesrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. + * @summary Process a list of identityids + * @param {ProcessidentitiesrequestV1} processidentitiesrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startIdentityProcessingV1: async (processidentitiesrequestV1: ProcessidentitiesrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'processidentitiesrequestV1' is not null or undefined + assertParamExists('startIdentityProcessingV1', 'processidentitiesrequestV1', processidentitiesrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/identities/v1/process`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(processidentitiesrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + * @summary Attribute synchronization for single identity. + * @param {string} identityId The Identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + synchronizeAttributesForIdentityV1: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('synchronizeAttributesForIdentityV1', 'identityId', identityId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/identities/v1/{identityId}/synchronize-attributes` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IdentitiesV1Api - functional programming interface + * @export + */ +export const IdentitiesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IdentitiesV1ApiAxiosParamCreator(configuration) + return { + /** + * The API returns successful response if the requested identity was deleted. + * @summary Delete identity + * @param {string} id Identity Id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.deleteIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. + * @summary Get ownership details + * @param {string} identityId Identity ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityOwnershipDetailsV1(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetailsV1(identityId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.getIdentityOwnershipDetailsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a single identity using the Identity ID. + * @summary Identity details + * @param {string} id Identity Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.getIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Role assignment details + * @param {string} identityId Identity Id + * @param {string} assignmentId Assignment Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleAssignmentV1(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignmentV1(identityId, assignmentId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.getRoleAssignmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + * @summary List role assignments + * @param {string} identityId Identity Id to get the role assignments for + * @param {string} [roleId] Role Id to filter the role assignments with + * @param {string} [roleName] Role name to filter the role assignments with + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleAssignmentsV1(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignmentsV1(identityId, roleId, roleName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.getRoleAssignmentsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. + * @summary List of entitlements by identity. + * @param {string} id Identity Id + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listEntitlementsByIdentityV1(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByIdentityV1(id, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.listEntitlementsByIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of identities. + * @summary List identities + * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* + * @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: **name, alias, cloudStatus** + * @param {ListIdentitiesV1DefaultFilterV1} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentitiesV1(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterV1, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitiesV1(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.listIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + * @summary Reset an identity + * @param {string} id Identity Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async resetIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentityV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.resetIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + * @summary Send password reset email + * @param {string} id Identity ID + * @param {SendaccountverificationrequestV1} sendaccountverificationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendIdentityVerificationAccountTokenV1(id: string, sendaccountverificationrequestV1: SendaccountverificationrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountTokenV1(id, sendaccountverificationrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.sendIdentityVerificationAccountTokenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + * @summary Invite identities to register + * @param {InviteidentitiesrequestV1} inviteidentitiesrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startIdentitiesInviteV1(inviteidentitiesrequestV1: InviteidentitiesrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInviteV1(inviteidentitiesrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.startIdentitiesInviteV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. + * @summary Process a list of identityids + * @param {ProcessidentitiesrequestV1} processidentitiesrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startIdentityProcessingV1(processidentitiesrequestV1: ProcessidentitiesrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessingV1(processidentitiesrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.startIdentityProcessingV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + * @summary Attribute synchronization for single identity. + * @param {string} identityId The Identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async synchronizeAttributesForIdentityV1(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentityV1(identityId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentitiesV1Api.synchronizeAttributesForIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IdentitiesV1Api - factory interface + * @export + */ +export const IdentitiesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IdentitiesV1ApiFp(configuration) + return { + /** + * The API returns successful response if the requested identity was deleted. + * @summary Delete identity + * @param {IdentitiesV1ApiDeleteIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityV1(requestParameters: IdentitiesV1ApiDeleteIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. + * @summary Get ownership details + * @param {IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityOwnershipDetailsV1(requestParameters: IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityOwnershipDetailsV1(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a single identity using the Identity ID. + * @summary Identity details + * @param {IdentitiesV1ApiGetIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityV1(requestParameters: IdentitiesV1ApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Role assignment details + * @param {IdentitiesV1ApiGetRoleAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignmentV1(requestParameters: IdentitiesV1ApiGetRoleAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleAssignmentV1(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + * @summary List role assignments + * @param {IdentitiesV1ApiGetRoleAssignmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignmentsV1(requestParameters: IdentitiesV1ApiGetRoleAssignmentsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleAssignmentsV1(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. + * @summary List of entitlements by identity. + * @param {IdentitiesV1ApiListEntitlementsByIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listEntitlementsByIdentityV1(requestParameters: IdentitiesV1ApiListEntitlementsByIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listEntitlementsByIdentityV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of identities. + * @summary List identities + * @param {IdentitiesV1ApiListIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitiesV1(requestParameters: IdentitiesV1ApiListIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + * @summary Reset an identity + * @param {IdentitiesV1ApiResetIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + resetIdentityV1(requestParameters: IdentitiesV1ApiResetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.resetIdentityV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + * @summary Send password reset email + * @param {IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendIdentityVerificationAccountTokenV1(requestParameters: IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendIdentityVerificationAccountTokenV1(requestParameters.id, requestParameters.sendaccountverificationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + * @summary Invite identities to register + * @param {IdentitiesV1ApiStartIdentitiesInviteV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startIdentitiesInviteV1(requestParameters: IdentitiesV1ApiStartIdentitiesInviteV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startIdentitiesInviteV1(requestParameters.inviteidentitiesrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. + * @summary Process a list of identityids + * @param {IdentitiesV1ApiStartIdentityProcessingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startIdentityProcessingV1(requestParameters: IdentitiesV1ApiStartIdentityProcessingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startIdentityProcessingV1(requestParameters.processidentitiesrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + * @summary Attribute synchronization for single identity. + * @param {IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + synchronizeAttributesForIdentityV1(requestParameters: IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.synchronizeAttributesForIdentityV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteIdentityV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiDeleteIdentityV1Request + */ +export interface IdentitiesV1ApiDeleteIdentityV1Request { + /** + * Identity Id + * @type {string} + * @memberof IdentitiesV1ApiDeleteIdentityV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentitiesV1ApiDeleteIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentityOwnershipDetailsV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request + */ +export interface IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request { + /** + * Identity ID. + * @type {string} + * @memberof IdentitiesV1ApiGetIdentityOwnershipDetailsV1 + */ + readonly identityId: string +} + +/** + * Request parameters for getIdentityV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiGetIdentityV1Request + */ +export interface IdentitiesV1ApiGetIdentityV1Request { + /** + * Identity Id + * @type {string} + * @memberof IdentitiesV1ApiGetIdentityV1 + */ + readonly id: string +} + +/** + * Request parameters for getRoleAssignmentV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiGetRoleAssignmentV1Request + */ +export interface IdentitiesV1ApiGetRoleAssignmentV1Request { + /** + * Identity Id + * @type {string} + * @memberof IdentitiesV1ApiGetRoleAssignmentV1 + */ + readonly identityId: string + + /** + * Assignment Id + * @type {string} + * @memberof IdentitiesV1ApiGetRoleAssignmentV1 + */ + readonly assignmentId: string +} + +/** + * Request parameters for getRoleAssignmentsV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiGetRoleAssignmentsV1Request + */ +export interface IdentitiesV1ApiGetRoleAssignmentsV1Request { + /** + * Identity Id to get the role assignments for + * @type {string} + * @memberof IdentitiesV1ApiGetRoleAssignmentsV1 + */ + readonly identityId: string + + /** + * Role Id to filter the role assignments with + * @type {string} + * @memberof IdentitiesV1ApiGetRoleAssignmentsV1 + */ + readonly roleId?: string + + /** + * Role name to filter the role assignments with + * @type {string} + * @memberof IdentitiesV1ApiGetRoleAssignmentsV1 + */ + readonly roleName?: string +} + +/** + * Request parameters for listEntitlementsByIdentityV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiListEntitlementsByIdentityV1Request + */ +export interface IdentitiesV1ApiListEntitlementsByIdentityV1Request { + /** + * Identity Id + * @type {string} + * @memberof IdentitiesV1ApiListEntitlementsByIdentityV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentitiesV1ApiListEntitlementsByIdentityV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentitiesV1ApiListEntitlementsByIdentityV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentitiesV1ApiListEntitlementsByIdentityV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for listIdentitiesV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiListIdentitiesV1Request + */ +export interface IdentitiesV1ApiListIdentitiesV1Request { + /** + * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* + * @type {string} + * @memberof IdentitiesV1ApiListIdentitiesV1 + */ + 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: **name, alias, cloudStatus** + * @type {string} + * @memberof IdentitiesV1ApiListIdentitiesV1 + */ + readonly sorters?: string + + /** + * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. + * @type {'CORRELATED_ONLY' | 'NONE'} + * @memberof IdentitiesV1ApiListIdentitiesV1 + */ + readonly defaultFilter?: ListIdentitiesV1DefaultFilterV1 + + /** + * 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 IdentitiesV1ApiListIdentitiesV1 + */ + readonly count?: boolean + + /** + * 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 IdentitiesV1ApiListIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentitiesV1ApiListIdentitiesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for resetIdentityV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiResetIdentityV1Request + */ +export interface IdentitiesV1ApiResetIdentityV1Request { + /** + * Identity Id + * @type {string} + * @memberof IdentitiesV1ApiResetIdentityV1 + */ + readonly id: string +} + +/** + * Request parameters for sendIdentityVerificationAccountTokenV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request + */ +export interface IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request { + /** + * Identity ID + * @type {string} + * @memberof IdentitiesV1ApiSendIdentityVerificationAccountTokenV1 + */ + readonly id: string + + /** + * + * @type {SendaccountverificationrequestV1} + * @memberof IdentitiesV1ApiSendIdentityVerificationAccountTokenV1 + */ + readonly sendaccountverificationrequestV1: SendaccountverificationrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentitiesV1ApiSendIdentityVerificationAccountTokenV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for startIdentitiesInviteV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiStartIdentitiesInviteV1Request + */ +export interface IdentitiesV1ApiStartIdentitiesInviteV1Request { + /** + * + * @type {InviteidentitiesrequestV1} + * @memberof IdentitiesV1ApiStartIdentitiesInviteV1 + */ + readonly inviteidentitiesrequestV1: InviteidentitiesrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentitiesV1ApiStartIdentitiesInviteV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for startIdentityProcessingV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiStartIdentityProcessingV1Request + */ +export interface IdentitiesV1ApiStartIdentityProcessingV1Request { + /** + * + * @type {ProcessidentitiesrequestV1} + * @memberof IdentitiesV1ApiStartIdentityProcessingV1 + */ + readonly processidentitiesrequestV1: ProcessidentitiesrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentitiesV1ApiStartIdentityProcessingV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for synchronizeAttributesForIdentityV1 operation in IdentitiesV1Api. + * @export + * @interface IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request + */ +export interface IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request { + /** + * The Identity id + * @type {string} + * @memberof IdentitiesV1ApiSynchronizeAttributesForIdentityV1 + */ + readonly identityId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentitiesV1ApiSynchronizeAttributesForIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IdentitiesV1Api - object-oriented interface + * @export + * @class IdentitiesV1Api + * @extends {BaseAPI} + */ +export class IdentitiesV1Api extends BaseAPI { + /** + * The API returns successful response if the requested identity was deleted. + * @summary Delete identity + * @param {IdentitiesV1ApiDeleteIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public deleteIdentityV1(requestParameters: IdentitiesV1ApiDeleteIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).deleteIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. + * @summary Get ownership details + * @param {IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public getIdentityOwnershipDetailsV1(requestParameters: IdentitiesV1ApiGetIdentityOwnershipDetailsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).getIdentityOwnershipDetailsV1(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a single identity using the Identity ID. + * @summary Identity details + * @param {IdentitiesV1ApiGetIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public getIdentityV1(requestParameters: IdentitiesV1ApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).getIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Role assignment details + * @param {IdentitiesV1ApiGetRoleAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public getRoleAssignmentV1(requestParameters: IdentitiesV1ApiGetRoleAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).getRoleAssignmentV1(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + * @summary List role assignments + * @param {IdentitiesV1ApiGetRoleAssignmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public getRoleAssignmentsV1(requestParameters: IdentitiesV1ApiGetRoleAssignmentsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).getRoleAssignmentsV1(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. + * @summary List of entitlements by identity. + * @param {IdentitiesV1ApiListEntitlementsByIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public listEntitlementsByIdentityV1(requestParameters: IdentitiesV1ApiListEntitlementsByIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).listEntitlementsByIdentityV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of identities. + * @summary List identities + * @param {IdentitiesV1ApiListIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public listIdentitiesV1(requestParameters: IdentitiesV1ApiListIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).listIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + * @summary Reset an identity + * @param {IdentitiesV1ApiResetIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public resetIdentityV1(requestParameters: IdentitiesV1ApiResetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).resetIdentityV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + * @summary Send password reset email + * @param {IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public sendIdentityVerificationAccountTokenV1(requestParameters: IdentitiesV1ApiSendIdentityVerificationAccountTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).sendIdentityVerificationAccountTokenV1(requestParameters.id, requestParameters.sendaccountverificationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + * @summary Invite identities to register + * @param {IdentitiesV1ApiStartIdentitiesInviteV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public startIdentitiesInviteV1(requestParameters: IdentitiesV1ApiStartIdentitiesInviteV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).startIdentitiesInviteV1(requestParameters.inviteidentitiesrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. + * @summary Process a list of identityids + * @param {IdentitiesV1ApiStartIdentityProcessingV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public startIdentityProcessingV1(requestParameters: IdentitiesV1ApiStartIdentityProcessingV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).startIdentityProcessingV1(requestParameters.processidentitiesrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + * @summary Attribute synchronization for single identity. + * @param {IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentitiesV1Api + */ + public synchronizeAttributesForIdentityV1(requestParameters: IdentitiesV1ApiSynchronizeAttributesForIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentitiesV1ApiFp(this.configuration).synchronizeAttributesForIdentityV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ListIdentitiesV1DefaultFilterV1 = { + CorrelatedOnly: 'CORRELATED_ONLY', + None: 'NONE' +} as const; +export type ListIdentitiesV1DefaultFilterV1 = typeof ListIdentitiesV1DefaultFilterV1[keyof typeof ListIdentitiesV1DefaultFilterV1]; + + diff --git a/sdk-output/identities/base.ts b/sdk-output/identities/base.ts new file mode 100644 index 00000000..134f78c1 --- /dev/null +++ b/sdk-output/identities/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identities + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/identities/common.ts b/sdk-output/identities/common.ts new file mode 100644 index 00000000..e414e443 --- /dev/null +++ b/sdk-output/identities/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identities + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/identities/configuration.ts b/sdk-output/identities/configuration.ts new file mode 100644 index 00000000..18cb4574 --- /dev/null +++ b/sdk-output/identities/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identities + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/identities/git_push.sh b/sdk-output/identities/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/identities/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/identities/index.ts b/sdk-output/identities/index.ts new file mode 100644 index 00000000..d5351551 --- /dev/null +++ b/sdk-output/identities/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identities + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/identities/package.json b/sdk-output/identities/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/identities/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/identities/tsconfig.json b/sdk-output/identities/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/identities/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/identity_attributes/.gitignore b/sdk-output/identity_attributes/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/identity_attributes/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/identity_attributes/.npmignore b/sdk-output/identity_attributes/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/identity_attributes/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/identity_attributes/.openapi-generator-ignore b/sdk-output/identity_attributes/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/identity_attributes/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/identity_attributes/.openapi-generator/FILES b/sdk-output/identity_attributes/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/identity_attributes/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/identity_attributes/.openapi-generator/VERSION b/sdk-output/identity_attributes/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/identity_attributes/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/identity_attributes/.sdk-partition b/sdk-output/identity_attributes/.sdk-partition new file mode 100644 index 00000000..f551732b --- /dev/null +++ b/sdk-output/identity_attributes/.sdk-partition @@ -0,0 +1 @@ +identity-attributes \ No newline at end of file diff --git a/sdk-output/identity_attributes/README.md b/sdk-output/identity_attributes/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_attributes/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_attributes/api.ts b/sdk-output/identity_attributes/api.ts new file mode 100644 index 00000000..b6d85b0f --- /dev/null +++ b/sdk-output/identity_attributes/api.ts @@ -0,0 +1,806 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Attributes + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface Identityattribute2V1 + */ +export interface Identityattribute2V1 { + /** + * Identity attribute\'s technical name. + * @type {string} + * @memberof Identityattribute2V1 + */ + 'name': string; + /** + * Identity attribute\'s business-friendly name. + * @type {string} + * @memberof Identityattribute2V1 + */ + 'displayName'?: string; + /** + * Indicates whether the attribute is \'standard\' or \'default\'. + * @type {boolean} + * @memberof Identityattribute2V1 + */ + 'standard'?: boolean; + /** + * Identity attribute\'s type. + * @type {string} + * @memberof Identityattribute2V1 + */ + 'type'?: string | null; + /** + * Indicates whether the identity attribute is multi-valued. + * @type {boolean} + * @memberof Identityattribute2V1 + */ + 'multi'?: boolean; + /** + * Indicates whether the identity attribute is searchable. + * @type {boolean} + * @memberof Identityattribute2V1 + */ + 'searchable'?: boolean; + /** + * Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. + * @type {boolean} + * @memberof Identityattribute2V1 + */ + 'system'?: boolean; + /** + * Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. + * @type {Array} + * @memberof Identityattribute2V1 + */ + 'sources'?: Array; +} +/** + * Identity attribute IDs. + * @export + * @interface IdentityattributenamesV1 + */ +export interface IdentityattributenamesV1 { + /** + * List of identity attributes\' technical names. + * @type {Array} + * @memberof IdentityattributenamesV1 + */ + 'ids'?: Array; +} +/** + * + * @export + * @interface ListIdentityAttributesV1401ResponseV1 + */ +export interface ListIdentityAttributesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityAttributesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListIdentityAttributesV1429ResponseV1 + */ +export interface ListIdentityAttributesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityAttributesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface Source2V1 + */ +export interface Source2V1 { + /** + * Attribute mapping type. + * @type {string} + * @memberof Source2V1 + */ + 'type'?: string; + /** + * Attribute mapping properties. + * @type {object} + * @memberof Source2V1 + */ + 'properties'?: object; +} + +/** + * IdentityAttributesV1Api - axios parameter creator + * @export + */ +export const IdentityAttributesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to create a new identity attribute. + * @summary Create identity attribute + * @param {Identityattribute2V1} identityattribute2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityAttributeV1: async (identityattribute2V1: Identityattribute2V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityattribute2V1' is not null or undefined + assertParamExists('createIdentityAttributeV1', 'identityattribute2V1', identityattribute2V1) + const localVarPath = `/identity-attributes/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(identityattribute2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + * @summary Delete identity attribute + * @param {string} name The attribute\'s technical name. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityAttributeV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('deleteIdentityAttributeV1', 'name', name) + const localVarPath = `/identity-attributes/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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, + }; + }, + /** + * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. + * @summary Bulk delete identity attributes + * @param {IdentityattributenamesV1} identityattributenamesV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityAttributesInBulkV1: async (identityattributenamesV1: IdentityattributenamesV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityattributenamesV1' is not null or undefined + assertParamExists('deleteIdentityAttributesInBulkV1', 'identityattributenamesV1', identityattributenamesV1) + const localVarPath = `/identity-attributes/v1/bulk-delete`; + // 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; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(identityattributenamesV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets an identity attribute for a given technical name. + * @summary Get identity attribute + * @param {string} name The attribute\'s technical name. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityAttributeV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('getIdentityAttributeV1', 'name', name) + const localVarPath = `/identity-attributes/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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, + }; + }, + /** + * Use this API to get a collection of identity attributes. + * @summary List identity attributes + * @param {boolean} [includeSystem] Include \'system\' attributes in the response. + * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. + * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAttributesV1: async (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/identity-attributes/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 (includeSystem !== undefined) { + localVarQueryParameter['includeSystem'] = includeSystem; + } + + if (includeSilent !== undefined) { + localVarQueryParameter['includeSilent'] = includeSilent; + } + + if (searchableOnly !== undefined) { + localVarQueryParameter['searchableOnly'] = searchableOnly; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + * @summary Update identity attribute + * @param {string} name The attribute\'s technical name. + * @param {Identityattribute2V1} identityattribute2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putIdentityAttributeV1: async (name: string, identityattribute2V1: Identityattribute2V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('putIdentityAttributeV1', 'name', name) + // verify required parameter 'identityattribute2V1' is not null or undefined + assertParamExists('putIdentityAttributeV1', 'identityattribute2V1', identityattribute2V1) + const localVarPath = `/identity-attributes/v1/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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: 'PUT', ...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(identityattribute2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IdentityAttributesV1Api - functional programming interface + * @export + */ +export const IdentityAttributesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IdentityAttributesV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to create a new identity attribute. + * @summary Create identity attribute + * @param {Identityattribute2V1} identityattribute2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createIdentityAttributeV1(identityattribute2V1: Identityattribute2V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityAttributeV1(identityattribute2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.createIdentityAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + * @summary Delete identity attribute + * @param {string} name The attribute\'s technical name. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityAttributeV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributeV1(name, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.deleteIdentityAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. + * @summary Bulk delete identity attributes + * @param {IdentityattributenamesV1} identityattributenamesV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityAttributesInBulkV1(identityattributenamesV1: IdentityattributenamesV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributesInBulkV1(identityattributenamesV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.deleteIdentityAttributesInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets an identity attribute for a given technical name. + * @summary Get identity attribute + * @param {string} name The attribute\'s technical name. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityAttributeV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAttributeV1(name, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.getIdentityAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a collection of identity attributes. + * @summary List identity attributes + * @param {boolean} [includeSystem] Include \'system\' attributes in the response. + * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. + * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityAttributesV1(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAttributesV1(includeSystem, includeSilent, searchableOnly, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.listIdentityAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + * @summary Update identity attribute + * @param {string} name The attribute\'s technical name. + * @param {Identityattribute2V1} identityattribute2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putIdentityAttributeV1(name: string, identityattribute2V1: Identityattribute2V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityAttributeV1(name, identityattribute2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV1Api.putIdentityAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IdentityAttributesV1Api - factory interface + * @export + */ +export const IdentityAttributesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IdentityAttributesV1ApiFp(configuration) + return { + /** + * Use this API to create a new identity attribute. + * @summary Create identity attribute + * @param {IdentityAttributesV1ApiCreateIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiCreateIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createIdentityAttributeV1(requestParameters.identityattribute2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + * @summary Delete identity attribute + * @param {IdentityAttributesV1ApiDeleteIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiDeleteIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityAttributeV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. + * @summary Bulk delete identity attributes + * @param {IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityAttributesInBulkV1(requestParameters: IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityAttributesInBulkV1(requestParameters.identityattributenamesV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets an identity attribute for a given technical name. + * @summary Get identity attribute + * @param {IdentityAttributesV1ApiGetIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiGetIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityAttributeV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a collection of identity attributes. + * @summary List identity attributes + * @param {IdentityAttributesV1ApiListIdentityAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAttributesV1(requestParameters: IdentityAttributesV1ApiListIdentityAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityAttributesV1(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + * @summary Update identity attribute + * @param {IdentityAttributesV1ApiPutIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiPutIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putIdentityAttributeV1(requestParameters.name, requestParameters.identityattribute2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createIdentityAttributeV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiCreateIdentityAttributeV1Request + */ +export interface IdentityAttributesV1ApiCreateIdentityAttributeV1Request { + /** + * + * @type {Identityattribute2V1} + * @memberof IdentityAttributesV1ApiCreateIdentityAttributeV1 + */ + readonly identityattribute2V1: Identityattribute2V1 +} + +/** + * Request parameters for deleteIdentityAttributeV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiDeleteIdentityAttributeV1Request + */ +export interface IdentityAttributesV1ApiDeleteIdentityAttributeV1Request { + /** + * The attribute\'s technical name. + * @type {string} + * @memberof IdentityAttributesV1ApiDeleteIdentityAttributeV1 + */ + readonly name: string +} + +/** + * Request parameters for deleteIdentityAttributesInBulkV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request + */ +export interface IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request { + /** + * + * @type {IdentityattributenamesV1} + * @memberof IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1 + */ + readonly identityattributenamesV1: IdentityattributenamesV1 +} + +/** + * Request parameters for getIdentityAttributeV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiGetIdentityAttributeV1Request + */ +export interface IdentityAttributesV1ApiGetIdentityAttributeV1Request { + /** + * The attribute\'s technical name. + * @type {string} + * @memberof IdentityAttributesV1ApiGetIdentityAttributeV1 + */ + readonly name: string +} + +/** + * Request parameters for listIdentityAttributesV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiListIdentityAttributesV1Request + */ +export interface IdentityAttributesV1ApiListIdentityAttributesV1Request { + /** + * Include \'system\' attributes in the response. + * @type {boolean} + * @memberof IdentityAttributesV1ApiListIdentityAttributesV1 + */ + readonly includeSystem?: boolean + + /** + * Include \'silent\' attributes in the response. + * @type {boolean} + * @memberof IdentityAttributesV1ApiListIdentityAttributesV1 + */ + readonly includeSilent?: boolean + + /** + * Include only \'searchable\' attributes in the response. + * @type {boolean} + * @memberof IdentityAttributesV1ApiListIdentityAttributesV1 + */ + readonly searchableOnly?: boolean + + /** + * 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 IdentityAttributesV1ApiListIdentityAttributesV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for putIdentityAttributeV1 operation in IdentityAttributesV1Api. + * @export + * @interface IdentityAttributesV1ApiPutIdentityAttributeV1Request + */ +export interface IdentityAttributesV1ApiPutIdentityAttributeV1Request { + /** + * The attribute\'s technical name. + * @type {string} + * @memberof IdentityAttributesV1ApiPutIdentityAttributeV1 + */ + readonly name: string + + /** + * + * @type {Identityattribute2V1} + * @memberof IdentityAttributesV1ApiPutIdentityAttributeV1 + */ + readonly identityattribute2V1: Identityattribute2V1 +} + +/** + * IdentityAttributesV1Api - object-oriented interface + * @export + * @class IdentityAttributesV1Api + * @extends {BaseAPI} + */ +export class IdentityAttributesV1Api extends BaseAPI { + /** + * Use this API to create a new identity attribute. + * @summary Create identity attribute + * @param {IdentityAttributesV1ApiCreateIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public createIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiCreateIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).createIdentityAttributeV1(requestParameters.identityattribute2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + * @summary Delete identity attribute + * @param {IdentityAttributesV1ApiDeleteIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public deleteIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiDeleteIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).deleteIdentityAttributeV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. + * @summary Bulk delete identity attributes + * @param {IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public deleteIdentityAttributesInBulkV1(requestParameters: IdentityAttributesV1ApiDeleteIdentityAttributesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).deleteIdentityAttributesInBulkV1(requestParameters.identityattributenamesV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets an identity attribute for a given technical name. + * @summary Get identity attribute + * @param {IdentityAttributesV1ApiGetIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public getIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiGetIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).getIdentityAttributeV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a collection of identity attributes. + * @summary List identity attributes + * @param {IdentityAttributesV1ApiListIdentityAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public listIdentityAttributesV1(requestParameters: IdentityAttributesV1ApiListIdentityAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).listIdentityAttributesV1(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + * @summary Update identity attribute + * @param {IdentityAttributesV1ApiPutIdentityAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityAttributesV1Api + */ + public putIdentityAttributeV1(requestParameters: IdentityAttributesV1ApiPutIdentityAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityAttributesV1ApiFp(this.configuration).putIdentityAttributeV1(requestParameters.name, requestParameters.identityattribute2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/identity_attributes/base.ts b/sdk-output/identity_attributes/base.ts new file mode 100644 index 00000000..8d4c34ea --- /dev/null +++ b/sdk-output/identity_attributes/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Attributes + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/identity_attributes/common.ts b/sdk-output/identity_attributes/common.ts new file mode 100644 index 00000000..ebdbce11 --- /dev/null +++ b/sdk-output/identity_attributes/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Attributes + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/identity_attributes/configuration.ts b/sdk-output/identity_attributes/configuration.ts new file mode 100644 index 00000000..bc6fa319 --- /dev/null +++ b/sdk-output/identity_attributes/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Attributes + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/identity_attributes/git_push.sh b/sdk-output/identity_attributes/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/identity_attributes/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/identity_attributes/index.ts b/sdk-output/identity_attributes/index.ts new file mode 100644 index 00000000..d7c999c1 --- /dev/null +++ b/sdk-output/identity_attributes/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Attributes + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/identity_attributes/package.json b/sdk-output/identity_attributes/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/identity_attributes/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/identity_attributes/tsconfig.json b/sdk-output/identity_attributes/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/identity_attributes/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/identity_history/.gitignore b/sdk-output/identity_history/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/identity_history/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/identity_history/.npmignore b/sdk-output/identity_history/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/identity_history/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/identity_history/.openapi-generator-ignore b/sdk-output/identity_history/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/identity_history/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/identity_history/.openapi-generator/FILES b/sdk-output/identity_history/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/identity_history/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/identity_history/.openapi-generator/VERSION b/sdk-output/identity_history/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/identity_history/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/identity_history/.sdk-partition b/sdk-output/identity_history/.sdk-partition new file mode 100644 index 00000000..ac30f862 --- /dev/null +++ b/sdk-output/identity_history/.sdk-partition @@ -0,0 +1 @@ +identity-history \ No newline at end of file diff --git a/sdk-output/identity_history/README.md b/sdk-output/identity_history/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_history/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_history/api.ts b/sdk-output/identity_history/api.ts new file mode 100644 index 00000000..62373f91 --- /dev/null +++ b/sdk-output/identity_history/api.ts @@ -0,0 +1,3231 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity History + * 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 AccessitemaccessprofileresponseAppRefsInnerV1 + */ +export interface AccessitemaccessprofileresponseAppRefsInnerV1 { + /** + * the cloud app id associated with the access profile + * @type {string} + * @memberof AccessitemaccessprofileresponseAppRefsInnerV1 + */ + 'cloudAppId'?: string; + /** + * the cloud app name associated with the access profile + * @type {string} + * @memberof AccessitemaccessprofileresponseAppRefsInnerV1 + */ + 'cloudAppName'?: string; +} +/** + * + * @export + * @interface AccessitemaccessprofileresponseV1 + */ +export interface AccessitemaccessprofileresponseV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'id'?: string; + /** + * the access item type. accessProfile in this case + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'accessType'?: string; + /** + * the display name of the identity + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'displayName'?: string; + /** + * the name of the source + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'sourceName'?: string; + /** + * the number of entitlements the access profile will create + * @type {number} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'entitlementCount': number; + /** + * the description for the access profile + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'description'?: string | null; + /** + * the id of the source + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'sourceId'?: string; + /** + * the list of app ids associated with the access profile + * @type {Array} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'appRefs': Array; + /** + * the date the access profile will be assigned to the specified identity, in case requested with a future start date + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'startDate'?: string | null; + /** + * the date the access profile is no longer assigned to the specified identity + * @type {string} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'removeDate'?: string | null; + /** + * indicates whether the access profile is standalone + * @type {boolean} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'standalone': boolean | null; + /** + * indicates whether the access profile is revocable + * @type {boolean} + * @memberof AccessitemaccessprofileresponseV1 + */ + 'revocable': boolean | null; +} +/** + * + * @export + * @interface AccessitemaccountresponseV1 + */ +export interface AccessitemaccountresponseV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'id'?: string; + /** + * the access item type. account in this case + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'accessType'?: string; + /** + * the display name of the identity + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'displayName'?: string; + /** + * the name of the source + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'sourceName'?: string; + /** + * the native identifier used to uniquely identify an acccount + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'nativeIdentity': string; + /** + * the id of the source + * @type {string} + * @memberof AccessitemaccountresponseV1 + */ + 'sourceId'?: string; + /** + * the number of entitlements the account will create + * @type {number} + * @memberof AccessitemaccountresponseV1 + */ + 'entitlementCount'?: number; +} +/** + * + * @export + * @interface AccessitemappresponseV1 + */ +export interface AccessitemappresponseV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitemappresponseV1 + */ + 'id'?: string; + /** + * the access item type. entitlement in this case + * @type {string} + * @memberof AccessitemappresponseV1 + */ + 'accessType'?: string; + /** + * the access item display name + * @type {string} + * @memberof AccessitemappresponseV1 + */ + 'displayName'?: string; + /** + * the associated source name if it exists + * @type {string} + * @memberof AccessitemappresponseV1 + */ + 'sourceName'?: string | null; + /** + * the app role id + * @type {string} + * @memberof AccessitemappresponseV1 + */ + 'appRoleId': string | null; +} +/** + * + * @export + * @interface AccessitemassociatedAccessItemV1 + */ +export interface AccessitemassociatedAccessItemV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'id'?: string; + /** + * the access item type. entitlement in this case + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'accessType'?: string; + /** + * the access item display name + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'displayName'?: string; + /** + * the associated source name if it exists + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'sourceName'?: string | null; + /** + * the entitlement attribute + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'attribute': string; + /** + * the associated value + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'value': string; + /** + * the type of entitlement + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'type': string; + /** + * the description for the role + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'description'?: string; + /** + * the id of the source + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'sourceId'?: string; + /** + * indicates whether the access profile is standalone + * @type {boolean} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'standalone': boolean | null; + /** + * indicates whether the entitlement is privileged + * @type {boolean} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'privileged': boolean | null; + /** + * indicates whether the entitlement is cloud governed + * @type {boolean} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'cloudGoverned': boolean | null; + /** + * the number of entitlements the account will create + * @type {number} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'entitlementCount': number; + /** + * the list of app ids associated with the access profile + * @type {Array} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'appRefs': Array; + /** + * the date the access profile will be assigned to the specified identity, in case requested with a future start date + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'startDate'?: string | null; + /** + * the date the role is no longer assigned to the specified identity + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'removeDate'?: string; + /** + * indicates whether the role is revocable + * @type {boolean} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'revocable': boolean; + /** + * the native identifier used to uniquely identify an acccount + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'nativeIdentity': string; + /** + * the app role id + * @type {string} + * @memberof AccessitemassociatedAccessItemV1 + */ + 'appRoleId': string | null; +} +/** + * + * @export + * @interface AccessitemassociatedV1 + */ +export interface AccessitemassociatedV1 { + /** + * the event type + * @type {string} + * @memberof AccessitemassociatedV1 + */ + 'eventType'?: string; + /** + * the date of event + * @type {string} + * @memberof AccessitemassociatedV1 + */ + 'dateTime'?: string; + /** + * the identity id + * @type {string} + * @memberof AccessitemassociatedV1 + */ + 'identityId'?: string; + /** + * + * @type {AccessitemassociatedAccessItemV1} + * @memberof AccessitemassociatedV1 + */ + 'accessItem': AccessitemassociatedAccessItemV1; + /** + * + * @type {CorrelatedgovernanceeventV1} + * @memberof AccessitemassociatedV1 + */ + 'governanceEvent': CorrelatedgovernanceeventV1 | null; + /** + * the access item type + * @type {string} + * @memberof AccessitemassociatedV1 + */ + 'accessItemType'?: AccessitemassociatedV1AccessItemTypeV1; +} + +export const AccessitemassociatedV1AccessItemTypeV1 = { + Account: 'account', + App: 'app', + Entitlement: 'entitlement', + Role: 'role', + AccessProfile: 'accessProfile' +} as const; + +export type AccessitemassociatedV1AccessItemTypeV1 = typeof AccessitemassociatedV1AccessItemTypeV1[keyof typeof AccessitemassociatedV1AccessItemTypeV1]; + +/** + * + * @export + * @interface AccessitemdiffV1 + */ +export interface AccessitemdiffV1 { + /** + * the id of the access item + * @type {string} + * @memberof AccessitemdiffV1 + */ + 'id'?: string; + /** + * + * @type {string} + * @memberof AccessitemdiffV1 + */ + 'eventType'?: AccessitemdiffV1EventTypeV1; + /** + * the display name of the access item + * @type {string} + * @memberof AccessitemdiffV1 + */ + 'displayName'?: string; + /** + * the source name of the access item + * @type {string} + * @memberof AccessitemdiffV1 + */ + 'sourceName'?: string; +} + +export const AccessitemdiffV1EventTypeV1 = { + Add: 'ADD', + Remove: 'REMOVE' +} as const; + +export type AccessitemdiffV1EventTypeV1 = typeof AccessitemdiffV1EventTypeV1[keyof typeof AccessitemdiffV1EventTypeV1]; + +/** + * + * @export + * @interface AccessitementitlementresponseV1 + */ +export interface AccessitementitlementresponseV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'id'?: string; + /** + * the access item type. entitlement in this case + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'accessType'?: string; + /** + * the display name of the identity + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'displayName'?: string; + /** + * the name of the source + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'sourceName'?: string; + /** + * the entitlement attribute + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'attribute': string; + /** + * the associated value + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'value': string; + /** + * the type of entitlement + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'type': string; + /** + * the description for the entitlment + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'description'?: string | null; + /** + * the id of the source + * @type {string} + * @memberof AccessitementitlementresponseV1 + */ + 'sourceId'?: string; + /** + * indicates whether the entitlement is standalone + * @type {boolean} + * @memberof AccessitementitlementresponseV1 + */ + 'standalone': boolean | null; + /** + * indicates whether the entitlement is privileged + * @type {boolean} + * @memberof AccessitementitlementresponseV1 + */ + 'privileged': boolean | null; + /** + * indicates whether the entitlement is cloud governed + * @type {boolean} + * @memberof AccessitementitlementresponseV1 + */ + 'cloudGoverned': boolean | null; +} +/** + * + * @export + * @interface AccessitemremovedV1 + */ +export interface AccessitemremovedV1 { + /** + * + * @type {AccessitemassociatedAccessItemV1} + * @memberof AccessitemremovedV1 + */ + 'accessItem': AccessitemassociatedAccessItemV1; + /** + * the identity id + * @type {string} + * @memberof AccessitemremovedV1 + */ + 'identityId'?: string; + /** + * the event type + * @type {string} + * @memberof AccessitemremovedV1 + */ + 'eventType'?: string; + /** + * the date of event + * @type {string} + * @memberof AccessitemremovedV1 + */ + 'dateTime'?: string; + /** + * the access item type + * @type {string} + * @memberof AccessitemremovedV1 + */ + 'accessItemType'?: AccessitemremovedV1AccessItemTypeV1; + /** + * + * @type {CorrelatedgovernanceeventV1} + * @memberof AccessitemremovedV1 + */ + 'governanceEvent'?: CorrelatedgovernanceeventV1 | null; +} + +export const AccessitemremovedV1AccessItemTypeV1 = { + Account: 'account', + App: 'app', + Entitlement: 'entitlement', + Role: 'role', + AccessProfile: 'accessProfile' +} as const; + +export type AccessitemremovedV1AccessItemTypeV1 = typeof AccessitemremovedV1AccessItemTypeV1[keyof typeof AccessitemremovedV1AccessItemTypeV1]; + +/** + * + * @export + * @interface AccessitemroleresponseV1 + */ +export interface AccessitemroleresponseV1 { + /** + * the access item id + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'id'?: string; + /** + * the access item type. role in this case + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'accessType'?: string; + /** + * the role display name + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'displayName'?: string; + /** + * the associated source name if it exists + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'sourceName'?: string | null; + /** + * the description for the role + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'description'?: string; + /** + * the date the access profile will be assigned to the specified identity, in case requested with a future start date + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'startDate'?: string | null; + /** + * the date the role is no longer assigned to the specified identity + * @type {string} + * @memberof AccessitemroleresponseV1 + */ + 'removeDate'?: string; + /** + * indicates whether the role is revocable + * @type {boolean} + * @memberof AccessitemroleresponseV1 + */ + 'revocable': boolean; +} +/** + * + * @export + * @interface AccessrequestedV1 + */ +export interface AccessrequestedV1 { + /** + * + * @type {Accessrequestresponse2V1} + * @memberof AccessrequestedV1 + */ + 'accessRequest': Accessrequestresponse2V1; + /** + * the identity id + * @type {string} + * @memberof AccessrequestedV1 + */ + 'identityId'?: string; + /** + * the event type + * @type {string} + * @memberof AccessrequestedV1 + */ + 'eventType'?: string; + /** + * the date of event + * @type {string} + * @memberof AccessrequestedV1 + */ + 'dateTime'?: string; +} +/** + * + * @export + * @interface AccessrequestitemresponseV1 + */ +export interface AccessrequestitemresponseV1 { + /** + * the access request item operation + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'operation'?: string; + /** + * the access item type + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'accessItemType'?: string; + /** + * the name of access request item + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'name'?: string; + /** + * the final decision for the access request + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'decision'?: AccessrequestitemresponseV1DecisionV1; + /** + * the description of access request item + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'description'?: string; + /** + * the source id + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'sourceId'?: string; + /** + * the source Name + * @type {string} + * @memberof AccessrequestitemresponseV1 + */ + 'sourceName'?: string; + /** + * + * @type {Array} + * @memberof AccessrequestitemresponseV1 + */ + 'approvalInfos'?: Array; +} + +export const AccessrequestitemresponseV1DecisionV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED' +} as const; + +export type AccessrequestitemresponseV1DecisionV1 = typeof AccessrequestitemresponseV1DecisionV1[keyof typeof AccessrequestitemresponseV1DecisionV1]; + +/** + * + * @export + * @interface Accessrequestresponse2V1 + */ +export interface Accessrequestresponse2V1 { + /** + * the requester Id + * @type {string} + * @memberof Accessrequestresponse2V1 + */ + 'requesterId'?: string; + /** + * the requesterName + * @type {string} + * @memberof Accessrequestresponse2V1 + */ + 'requesterName'?: string; + /** + * + * @type {Array} + * @memberof Accessrequestresponse2V1 + */ + 'items'?: Array; +} +/** + * + * @export + * @interface AccountstatuschangedAccountV1 + */ +export interface AccountstatuschangedAccountV1 { + /** + * the ID of the account in the database + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'id'?: string; + /** + * the native identifier of the account + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'nativeIdentity'?: string; + /** + * the display name of the account + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'displayName'?: string; + /** + * the ID of the source for this account + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'sourceId'?: string; + /** + * the name of the source for this account + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'sourceName'?: string; + /** + * the number of entitlements on this account + * @type {number} + * @memberof AccountstatuschangedAccountV1 + */ + 'entitlementCount'?: number; + /** + * this value is always \"account\" + * @type {string} + * @memberof AccountstatuschangedAccountV1 + */ + 'accessType'?: string; +} +/** + * + * @export + * @interface AccountstatuschangedStatusChangeV1 + */ +export interface AccountstatuschangedStatusChangeV1 { + /** + * the previous status of the account + * @type {string} + * @memberof AccountstatuschangedStatusChangeV1 + */ + 'previousStatus'?: AccountstatuschangedStatusChangeV1PreviousStatusV1; + /** + * the new status of the account + * @type {string} + * @memberof AccountstatuschangedStatusChangeV1 + */ + 'newStatus'?: AccountstatuschangedStatusChangeV1NewStatusV1; +} + +export const AccountstatuschangedStatusChangeV1PreviousStatusV1 = { + Enabled: 'enabled', + Disabled: 'disabled', + Locked: 'locked' +} as const; + +export type AccountstatuschangedStatusChangeV1PreviousStatusV1 = typeof AccountstatuschangedStatusChangeV1PreviousStatusV1[keyof typeof AccountstatuschangedStatusChangeV1PreviousStatusV1]; +export const AccountstatuschangedStatusChangeV1NewStatusV1 = { + Enabled: 'enabled', + Disabled: 'disabled', + Locked: 'locked' +} as const; + +export type AccountstatuschangedStatusChangeV1NewStatusV1 = typeof AccountstatuschangedStatusChangeV1NewStatusV1[keyof typeof AccountstatuschangedStatusChangeV1NewStatusV1]; + +/** + * + * @export + * @interface AccountstatuschangedV1 + */ +export interface AccountstatuschangedV1 { + /** + * the event type + * @type {string} + * @memberof AccountstatuschangedV1 + */ + 'eventType'?: string; + /** + * the identity id + * @type {string} + * @memberof AccountstatuschangedV1 + */ + 'identityId'?: string; + /** + * the date of event + * @type {string} + * @memberof AccountstatuschangedV1 + */ + 'dateTime'?: string; + /** + * + * @type {AccountstatuschangedAccountV1} + * @memberof AccountstatuschangedV1 + */ + 'account': AccountstatuschangedAccountV1; + /** + * + * @type {AccountstatuschangedStatusChangeV1} + * @memberof AccountstatuschangedV1 + */ + 'statusChange': AccountstatuschangedStatusChangeV1; +} +/** + * + * @export + * @interface ApprovalinforesponseV1 + */ +export interface ApprovalinforesponseV1 { + /** + * the id of approver + * @type {string} + * @memberof ApprovalinforesponseV1 + */ + 'id'?: string; + /** + * the name of approver + * @type {string} + * @memberof ApprovalinforesponseV1 + */ + 'name'?: string; + /** + * the status of the approval request + * @type {string} + * @memberof ApprovalinforesponseV1 + */ + 'status'?: string; +} +/** + * + * @export + * @interface AttributechangeV1 + */ +export interface AttributechangeV1 { + /** + * the attribute name + * @type {string} + * @memberof AttributechangeV1 + */ + 'name'?: string; + /** + * the old value of attribute + * @type {string} + * @memberof AttributechangeV1 + */ + 'previousValue'?: string; + /** + * the new value of attribute + * @type {string} + * @memberof AttributechangeV1 + */ + 'newValue'?: string; +} +/** + * + * @export + * @interface AttributeschangedV1 + */ +export interface AttributeschangedV1 { + /** + * + * @type {Array} + * @memberof AttributeschangedV1 + */ + 'attributeChanges': Array; + /** + * the event type + * @type {string} + * @memberof AttributeschangedV1 + */ + 'eventType'?: string; + /** + * the identity id + * @type {string} + * @memberof AttributeschangedV1 + */ + 'identityId'?: string; + /** + * the date of event + * @type {string} + * @memberof AttributeschangedV1 + */ + 'dateTime'?: string; +} +/** + * + * @export + * @interface CertifierresponseV1 + */ +export interface CertifierresponseV1 { + /** + * the id of the certifier + * @type {string} + * @memberof CertifierresponseV1 + */ + 'id'?: string; + /** + * the name of the certifier + * @type {string} + * @memberof CertifierresponseV1 + */ + 'displayName'?: string; +} +/** + * + * @export + * @interface CorrelatedgovernanceeventV1 + */ +export interface CorrelatedgovernanceeventV1 { + /** + * The name of the governance event, such as the certification name or access request ID. + * @type {string} + * @memberof CorrelatedgovernanceeventV1 + */ + 'name'?: string; + /** + * The date that the certification or access request was completed. + * @type {string} + * @memberof CorrelatedgovernanceeventV1 + */ + 'dateTime'?: string; + /** + * The type of governance event. + * @type {string} + * @memberof CorrelatedgovernanceeventV1 + */ + 'type'?: CorrelatedgovernanceeventV1TypeV1; + /** + * The ID of the instance that caused the event - either the certification ID or access request ID. + * @type {string} + * @memberof CorrelatedgovernanceeventV1 + */ + 'governanceId'?: string; + /** + * The owners of the governance event (the certifiers or approvers) + * @type {Array} + * @memberof CorrelatedgovernanceeventV1 + */ + 'owners'?: Array; + /** + * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + * @type {Array} + * @memberof CorrelatedgovernanceeventV1 + */ + 'reviewers'?: Array; + /** + * + * @type {CertifierresponseV1} + * @memberof CorrelatedgovernanceeventV1 + */ + 'decisionMaker'?: CertifierresponseV1; +} + +export const CorrelatedgovernanceeventV1TypeV1 = { + Certification: 'certification', + AccessRequest: 'accessRequest' +} as const; + +export type CorrelatedgovernanceeventV1TypeV1 = typeof CorrelatedgovernanceeventV1TypeV1[keyof typeof CorrelatedgovernanceeventV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ +export interface GetHistoricalIdentityEventsV1200ResponseInnerV1 { + /** + * the id of the certification item + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'certificationId': string; + /** + * the certification item name + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'certificationName': string; + /** + * the date ceritification was signed + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'signedDate'?: string; + /** + * this field is deprecated and may go away + * @type {Array} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'certifiers'?: Array; + /** + * The list of identities who review this certification + * @type {Array} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'reviewers'?: Array; + /** + * + * @type {CertifierresponseV1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'signer'?: CertifierresponseV1; + /** + * the event type + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'eventType'?: string; + /** + * the date of event + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'dateTime'?: string; + /** + * the identity id + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'identityId'?: string; + /** + * + * @type {AccessitemassociatedAccessItemV1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'accessItem': AccessitemassociatedAccessItemV1; + /** + * + * @type {CorrelatedgovernanceeventV1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'governanceEvent': CorrelatedgovernanceeventV1 | null; + /** + * the access item type + * @type {string} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'accessItemType'?: GetHistoricalIdentityEventsV1200ResponseInnerV1AccessItemTypeV1; + /** + * + * @type {Array} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'attributeChanges': Array; + /** + * + * @type {Accessrequestresponse2V1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'accessRequest': Accessrequestresponse2V1; + /** + * + * @type {AccountstatuschangedAccountV1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'account': AccountstatuschangedAccountV1; + /** + * + * @type {AccountstatuschangedStatusChangeV1} + * @memberof GetHistoricalIdentityEventsV1200ResponseInnerV1 + */ + 'statusChange': AccountstatuschangedStatusChangeV1; +} + +export const GetHistoricalIdentityEventsV1200ResponseInnerV1AccessItemTypeV1 = { + Account: 'account', + App: 'app', + Entitlement: 'entitlement', + Role: 'role', + AccessProfile: 'accessProfile' +} as const; + +export type GetHistoricalIdentityEventsV1200ResponseInnerV1AccessItemTypeV1 = typeof GetHistoricalIdentityEventsV1200ResponseInnerV1AccessItemTypeV1[keyof typeof GetHistoricalIdentityEventsV1200ResponseInnerV1AccessItemTypeV1]; + +/** + * + * @export + * @interface IdentitycertifiedV1 + */ +export interface IdentitycertifiedV1 { + /** + * the id of the certification item + * @type {string} + * @memberof IdentitycertifiedV1 + */ + 'certificationId': string; + /** + * the certification item name + * @type {string} + * @memberof IdentitycertifiedV1 + */ + 'certificationName': string; + /** + * the date ceritification was signed + * @type {string} + * @memberof IdentitycertifiedV1 + */ + 'signedDate'?: string; + /** + * this field is deprecated and may go away + * @type {Array} + * @memberof IdentitycertifiedV1 + */ + 'certifiers'?: Array; + /** + * The list of identities who review this certification + * @type {Array} + * @memberof IdentitycertifiedV1 + */ + 'reviewers'?: Array; + /** + * + * @type {CertifierresponseV1} + * @memberof IdentitycertifiedV1 + */ + 'signer'?: CertifierresponseV1; + /** + * the event type + * @type {string} + * @memberof IdentitycertifiedV1 + */ + 'eventType'?: string; + /** + * the date of event + * @type {string} + * @memberof IdentitycertifiedV1 + */ + 'dateTime'?: string; +} +/** + * + * @export + * @interface IdentitycompareresponseV1 + */ +export interface IdentitycompareresponseV1 { + /** + * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + * @type {{ [key: string]: object; }} + * @memberof IdentitycompareresponseV1 + */ + 'accessItemDiff'?: { [key: string]: object; }; +} +/** + * + * @export + * @interface IdentityhistoryresponseV1 + */ +export interface IdentityhistoryresponseV1 { + /** + * the identity ID + * @type {string} + * @memberof IdentityhistoryresponseV1 + */ + 'id'?: string; + /** + * the display name of the identity + * @type {string} + * @memberof IdentityhistoryresponseV1 + */ + 'displayName'?: string; + /** + * the date when the identity record was created + * @type {string} + * @memberof IdentityhistoryresponseV1 + */ + 'snapshot'?: string; + /** + * the date when the identity was deleted + * @type {string} + * @memberof IdentityhistoryresponseV1 + */ + 'deletedDate'?: string; + /** + * A map containing the count of each access item + * @type {{ [key: string]: number; }} + * @memberof IdentityhistoryresponseV1 + */ + 'accessItemCount'?: { [key: string]: number; }; + /** + * A map containing the identity attributes + * @type {{ [key: string]: any; }} + * @memberof IdentityhistoryresponseV1 + */ + 'attributes'?: { [key: string]: any; }; +} +/** + * + * @export + * @interface IdentitylistitemV1 + */ +export interface IdentitylistitemV1 { + /** + * the identity ID + * @type {string} + * @memberof IdentitylistitemV1 + */ + 'id'?: string; + /** + * the display name of the identity + * @type {string} + * @memberof IdentitylistitemV1 + */ + 'displayName'?: string; + /** + * the first name of the identity + * @type {string} + * @memberof IdentitylistitemV1 + */ + 'firstName'?: string | null; + /** + * the last name of the identity + * @type {string} + * @memberof IdentitylistitemV1 + */ + 'lastName'?: string | null; + /** + * indicates if an identity is active or not + * @type {boolean} + * @memberof IdentitylistitemV1 + */ + 'active'?: boolean; + /** + * the date when the identity was deleted + * @type {string} + * @memberof IdentitylistitemV1 + */ + 'deletedDate'?: string | null; +} +/** + * + * @export + * @interface IdentitysnapshotsummaryresponseV1 + */ +export interface IdentitysnapshotsummaryresponseV1 { + /** + * the date when the identity record was created + * @type {string} + * @memberof IdentitysnapshotsummaryresponseV1 + */ + 'snapshot'?: string; +} +/** + * + * @export + * @interface ListHistoricalIdentitiesV1401ResponseV1 + */ +export interface ListHistoricalIdentitiesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListHistoricalIdentitiesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListHistoricalIdentitiesV1429ResponseV1 + */ +export interface ListHistoricalIdentitiesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListHistoricalIdentitiesV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface ListIdentityAccessItemsV1200ResponseInnerV1 + */ +export interface ListIdentityAccessItemsV1200ResponseInnerV1 { + /** + * the access item id + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'id'?: string; + /** + * the access item type. entitlement in this case + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'accessType'?: string; + /** + * the access item display name + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'displayName'?: string; + /** + * the associated source name if it exists + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'sourceName'?: string | null; + /** + * the entitlement attribute + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'attribute': string; + /** + * the associated value + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'value': string; + /** + * the type of entitlement + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'type': string; + /** + * the description for the role + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'description'?: string; + /** + * the id of the source + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'sourceId'?: string; + /** + * indicates whether the access profile is standalone + * @type {boolean} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'standalone': boolean | null; + /** + * indicates whether the entitlement is privileged + * @type {boolean} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'privileged': boolean | null; + /** + * indicates whether the entitlement is cloud governed + * @type {boolean} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'cloudGoverned': boolean | null; + /** + * the number of entitlements the account will create + * @type {number} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'entitlementCount': number; + /** + * the list of app ids associated with the access profile + * @type {Array} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'appRefs': Array; + /** + * the date the access profile will be assigned to the specified identity, in case requested with a future start date + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'startDate'?: string | null; + /** + * the date the role is no longer assigned to the specified identity + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'removeDate'?: string; + /** + * indicates whether the role is revocable + * @type {boolean} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'revocable': boolean; + /** + * the native identifier used to uniquely identify an acccount + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'nativeIdentity': string; + /** + * the app role id + * @type {string} + * @memberof ListIdentityAccessItemsV1200ResponseInnerV1 + */ + 'appRoleId': string | null; +} +/** + * @type ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 + * @export + */ +export type ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 = AccessitemaccessprofileresponseV1 | AccessitemaccountresponseV1 | AccessitemappresponseV1 | AccessitementitlementresponseV1 | AccessitemroleresponseV1; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MetricresponseV1 + */ +export interface MetricresponseV1 { + /** + * the name of metric + * @type {string} + * @memberof MetricresponseV1 + */ + 'name'?: string; + /** + * the value associated to the metric + * @type {number} + * @memberof MetricresponseV1 + */ + 'value'?: number; +} + +/** + * IdentityHistoryV1Api - axios parameter creator + * @export + */ +export const IdentityHistoryV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots + * @param {string} id The identity id + * @param {CompareIdentitySnapshotsAccessTypeV1AccessTypeV1} accessType The specific type which needs to be compared + * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + * @param {string} [snapshot1] The snapshot 1 of identity + * @param {string} [snapshot2] The snapshot 2 of identity + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + compareIdentitySnapshotsAccessTypeV1: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeV1, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('compareIdentitySnapshotsAccessTypeV1', 'id', id) + // verify required parameter 'accessType' is not null or undefined + assertParamExists('compareIdentitySnapshotsAccessTypeV1', 'accessType', accessType) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/compare/{access-type}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); + // 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 (accessAssociated !== undefined) { + localVarQueryParameter['access-associated'] = accessAssociated; + } + + if (snapshot1 !== undefined) { + localVarQueryParameter['snapshot1'] = snapshot1; + } + + if (snapshot2 !== undefined) { + localVarQueryParameter['snapshot2'] = snapshot2; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots + * @param {string} id The identity id + * @param {string} [snapshot1] The snapshot 1 of identity + * @param {string} [snapshot2] The snapshot 2 of identity + * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + compareIdentitySnapshotsV1: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('compareIdentitySnapshotsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/compare` + .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 (snapshot1 !== undefined) { + localVarQueryParameter['snapshot1'] = snapshot1; + } + + if (snapshot2 !== undefined) { + localVarQueryParameter['snapshot2'] = snapshot2; + } + + if (accessItemTypes) { + localVarQueryParameter['accessItemTypes'] = accessItemTypes; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary List identity event history + * @param {string} id The identity id + * @param {string} [from] The optional instant until which access events are returned + * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned + * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getHistoricalIdentityEventsV1: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getHistoricalIdentityEventsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/events` + .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 (from !== undefined) { + localVarQueryParameter['from'] = from; + } + + if (eventTypes) { + localVarQueryParameter['eventTypes'] = eventTypes; + } + + if (accessItemTypes) { + localVarQueryParameter['accessItemTypes'] = accessItemTypes; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Get latest snapshot of identity + * @param {string} id The identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getHistoricalIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getHistoricalIdentityV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the summary for the event count for a specific identity + * @param {string} id The identity id + * @param {string} [before] The date before which snapshot summary is required + * @param {GetIdentitySnapshotSummaryV1IntervalV1} [interval] The interval indicating day or month. Defaults to month if not specified + * @param {string} [timeZone] The time zone. Defaults to UTC if not provided + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySnapshotSummaryV1: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryV1IntervalV1, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentitySnapshotSummaryV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/snapshot-summary` + .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 (before !== undefined) { + localVarQueryParameter['before'] = before; + } + + if (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + if (timeZone !== undefined) { + localVarQueryParameter['time-zone'] = timeZone; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets an identity snapshot at a given date + * @param {string} id The identity id + * @param {string} date The specified date + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySnapshotV1: async (id: string, date: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentitySnapshotV1', 'id', id) + // verify required parameter 'date' is not null or undefined + assertParamExists('getIdentitySnapshotV1', 'date', date) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/snapshots/{date}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the start date of the identity + * @param {string} id The identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityStartDateV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getIdentityStartDateV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/start-date` + .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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the identities + * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity + * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. + * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listHistoricalIdentitiesV1: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/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 (startsWithQuery !== undefined) { + localVarQueryParameter['starts-with-query'] = startsWithQuery; + } + + if (isDeleted !== undefined) { + localVarQueryParameter['is-deleted'] = isDeleted; + } + + if (isActive !== undefined) { + localVarQueryParameter['is-active'] = isActive; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves a list of access item for the identity filtered by the access item type + * @summary List access items by identity + * @param {string} id The identity id + * @param {ListIdentityAccessItemsV1TypeV1} [type] The type of access item for the identity. If not provided, it defaults to account + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAccessItemsV1: async (id: string, type?: ListIdentityAccessItemsV1TypeV1, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listIdentityAccessItemsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/access-items` + .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; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the list of identity access items at a given date filterd by item type + * @param {string} id The identity id + * @param {string} date The specified date + * @param {string} [type] The access item type + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitySnapshotAccessItemsV1: async (id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listIdentitySnapshotAccessItemsV1', 'id', id) + // verify required parameter 'date' is not null or undefined + assertParamExists('listIdentitySnapshotAccessItemsV1', 'date', date) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/snapshots/{date}/access-items` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // 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; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the snapshots for the identity + * @param {string} id The identity id + * @param {string} [start] The specified start date + * @param {ListIdentitySnapshotsV1IntervalV1} [interval] The interval indicating the range in day or month for the specified interval-name + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitySnapshotsV1: async (id: string, start?: string, interval?: ListIdentitySnapshotsV1IntervalV1, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('listIdentitySnapshotsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/historical-identities/v1/{id}/snapshots` + .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 (start !== undefined) { + localVarQueryParameter['start'] = start; + } + + if (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IdentityHistoryV1Api - functional programming interface + * @export + */ +export const IdentityHistoryV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IdentityHistoryV1ApiAxiosParamCreator(configuration) + return { + /** + * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots + * @param {string} id The identity id + * @param {CompareIdentitySnapshotsAccessTypeV1AccessTypeV1} accessType The specific type which needs to be compared + * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + * @param {string} [snapshot1] The snapshot 1 of identity + * @param {string} [snapshot2] The snapshot 2 of identity + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async compareIdentitySnapshotsAccessTypeV1(id: string, accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeV1, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessTypeV1(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.compareIdentitySnapshotsAccessTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots + * @param {string} id The identity id + * @param {string} [snapshot1] The snapshot 1 of identity + * @param {string} [snapshot2] The snapshot 2 of identity + * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async compareIdentitySnapshotsV1(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsV1(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.compareIdentitySnapshotsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary List identity event history + * @param {string} id The identity id + * @param {string} [from] The optional instant until which access events are returned + * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned + * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getHistoricalIdentityEventsV1(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEventsV1(id, from, eventTypes, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.getHistoricalIdentityEventsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Get latest snapshot of identity + * @param {string} id The identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getHistoricalIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.getHistoricalIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the summary for the event count for a specific identity + * @param {string} id The identity id + * @param {string} [before] The date before which snapshot summary is required + * @param {GetIdentitySnapshotSummaryV1IntervalV1} [interval] The interval indicating day or month. Defaults to month if not specified + * @param {string} [timeZone] The time zone. Defaults to UTC if not provided + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentitySnapshotSummaryV1(id: string, before?: string, interval?: GetIdentitySnapshotSummaryV1IntervalV1, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummaryV1(id, before, interval, timeZone, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.getIdentitySnapshotSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets an identity snapshot at a given date + * @param {string} id The identity id + * @param {string} date The specified date + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentitySnapshotV1(id: string, date: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotV1(id, date, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.getIdentitySnapshotV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the start date of the identity + * @param {string} id The identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityStartDateV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDateV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.getIdentityStartDateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the identities + * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity + * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. + * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listHistoricalIdentitiesV1(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentitiesV1(startsWithQuery, isDeleted, isActive, limit, offset, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.listHistoricalIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves a list of access item for the identity filtered by the access item type + * @summary List access items by identity + * @param {string} id The identity id + * @param {ListIdentityAccessItemsV1TypeV1} [type] The type of access item for the identity. If not provided, it defaults to account + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityAccessItemsV1(id: string, type?: ListIdentityAccessItemsV1TypeV1, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItemsV1(id, type, xSailPointExperimental, limit, count, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.listIdentityAccessItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the list of identity access items at a given date filterd by item type + * @param {string} id The identity id + * @param {string} date The specified date + * @param {string} [type] The access item type + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentitySnapshotAccessItemsV1(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItemsV1(id, date, type, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.listIdentitySnapshotAccessItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the snapshots for the identity + * @param {string} id The identity id + * @param {string} [start] The specified start date + * @param {ListIdentitySnapshotsV1IntervalV1} [interval] The interval indicating the range in day or month for the specified interval-name + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentitySnapshotsV1(id: string, start?: string, interval?: ListIdentitySnapshotsV1IntervalV1, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotsV1(id, start, interval, limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV1Api.listIdentitySnapshotsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IdentityHistoryV1Api - factory interface + * @export + */ +export const IdentityHistoryV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IdentityHistoryV1ApiFp(configuration) + return { + /** + * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots + * @param {IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + compareIdentitySnapshotsAccessTypeV1(requestParameters: IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.compareIdentitySnapshotsAccessTypeV1(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots + * @param {IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + compareIdentitySnapshotsV1(requestParameters: IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.compareIdentitySnapshotsV1(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary List identity event history + * @param {IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getHistoricalIdentityEventsV1(requestParameters: IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getHistoricalIdentityEventsV1(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Get latest snapshot of identity + * @param {IdentityHistoryV1ApiGetHistoricalIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getHistoricalIdentityV1(requestParameters: IdentityHistoryV1ApiGetHistoricalIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getHistoricalIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the summary for the event count for a specific identity + * @param {IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySnapshotSummaryV1(requestParameters: IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getIdentitySnapshotSummaryV1(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets an identity snapshot at a given date + * @param {IdentityHistoryV1ApiGetIdentitySnapshotV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentitySnapshotV1(requestParameters: IdentityHistoryV1ApiGetIdentitySnapshotV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentitySnapshotV1(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the start date of the identity + * @param {IdentityHistoryV1ApiGetIdentityStartDateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityStartDateV1(requestParameters: IdentityHistoryV1ApiGetIdentityStartDateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityStartDateV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the identities + * @param {IdentityHistoryV1ApiListHistoricalIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listHistoricalIdentitiesV1(requestParameters: IdentityHistoryV1ApiListHistoricalIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listHistoricalIdentitiesV1(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves a list of access item for the identity filtered by the access item type + * @summary List access items by identity + * @param {IdentityHistoryV1ApiListIdentityAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityAccessItemsV1(requestParameters: IdentityHistoryV1ApiListIdentityAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityAccessItemsV1(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the list of identity access items at a given date filterd by item type + * @param {IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitySnapshotAccessItemsV1(requestParameters: IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentitySnapshotAccessItemsV1(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the snapshots for the identity + * @param {IdentityHistoryV1ApiListIdentitySnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentitySnapshotsV1(requestParameters: IdentityHistoryV1ApiListIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentitySnapshotsV1(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for compareIdentitySnapshotsAccessTypeV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request + */ +export interface IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly id: string + + /** + * The specific type which needs to be compared + * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeV1 + + /** + * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + * @type {boolean} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly accessAssociated?: boolean + + /** + * The snapshot 1 of identity + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly snapshot1?: string + + /** + * The snapshot 2 of identity + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly snapshot2?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for compareIdentitySnapshotsV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request + */ +export interface IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly id: string + + /** + * The snapshot 1 of identity + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly snapshot1?: string + + /** + * The snapshot 2 of identity + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly snapshot2?: string + + /** + * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @type {Array} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly accessItemTypes?: Array + + /** + * 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 IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiCompareIdentitySnapshotsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getHistoricalIdentityEventsV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request + */ +export interface IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly id: string + + /** + * The optional instant until which access events are returned + * @type {string} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly from?: string + + /** + * An optional list of event types to return. If null or empty, all events are returned + * @type {Array} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly eventTypes?: Array + + /** + * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + * @type {Array} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly accessItemTypes?: Array + + /** + * 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 IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityEventsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getHistoricalIdentityV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiGetHistoricalIdentityV1Request + */ +export interface IdentityHistoryV1ApiGetHistoricalIdentityV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiGetHistoricalIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentitySnapshotSummaryV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request + */ +export interface IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly id: string + + /** + * The date before which snapshot summary is required + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly before?: string + + /** + * The interval indicating day or month. Defaults to month if not specified + * @type {'day' | 'month'} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly interval?: GetIdentitySnapshotSummaryV1IntervalV1 + + /** + * The time zone. Defaults to UTC if not provided + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly timeZone?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentitySnapshotV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiGetIdentitySnapshotV1Request + */ +export interface IdentityHistoryV1ApiGetIdentitySnapshotV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotV1 + */ + readonly id: string + + /** + * The specified date + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotV1 + */ + readonly date: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentitySnapshotV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getIdentityStartDateV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiGetIdentityStartDateV1Request + */ +export interface IdentityHistoryV1ApiGetIdentityStartDateV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentityStartDateV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiGetIdentityStartDateV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listHistoricalIdentitiesV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiListHistoricalIdentitiesV1Request + */ +export interface IdentityHistoryV1ApiListHistoricalIdentitiesV1Request { + /** + * This param is used for starts-with search for first, last and display name of the identity + * @type {string} + * @memberof IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly startsWithQuery?: string + + /** + * Indicates if we want to only list down deleted identities or not. + * @type {boolean} + * @memberof IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly isDeleted?: boolean + + /** + * Indicates if we want to only list active or inactive identities. + * @type {boolean} + * @memberof IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly isActive?: boolean + + /** + * 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 IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly offset?: number + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiListHistoricalIdentitiesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listIdentityAccessItemsV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiListIdentityAccessItemsV1Request + */ +export interface IdentityHistoryV1ApiListIdentityAccessItemsV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + readonly id: string + + /** + * The type of access item for the identity. If not provided, it defaults to account + * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} + * @memberof IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + readonly type?: ListIdentityAccessItemsV1TypeV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + readonly xSailPointExperimental?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + 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 IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + readonly count?: boolean + + /** + * 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 IdentityHistoryV1ApiListIdentityAccessItemsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listIdentitySnapshotAccessItemsV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request + */ +export interface IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1 + */ + readonly id: string + + /** + * The specified date + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1 + */ + readonly date: string + + /** + * The access item type + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1 + */ + readonly type?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listIdentitySnapshotsV1 operation in IdentityHistoryV1Api. + * @export + * @interface IdentityHistoryV1ApiListIdentitySnapshotsV1Request + */ +export interface IdentityHistoryV1ApiListIdentitySnapshotsV1Request { + /** + * The identity id + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly id: string + + /** + * The specified start date + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly start?: string + + /** + * The interval indicating the range in day or month for the specified interval-name + * @type {'day' | 'month'} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly interval?: ListIdentitySnapshotsV1IntervalV1 + + /** + * 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 IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof IdentityHistoryV1ApiListIdentitySnapshotsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * IdentityHistoryV1Api - object-oriented interface + * @export + * @class IdentityHistoryV1Api + * @extends {BaseAPI} + */ +export class IdentityHistoryV1Api extends BaseAPI { + /** + * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots + * @param {IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public compareIdentitySnapshotsAccessTypeV1(requestParameters: IdentityHistoryV1ApiCompareIdentitySnapshotsAccessTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).compareIdentitySnapshotsAccessTypeV1(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots + * @param {IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public compareIdentitySnapshotsV1(requestParameters: IdentityHistoryV1ApiCompareIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).compareIdentitySnapshotsV1(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary List identity event history + * @param {IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public getHistoricalIdentityEventsV1(requestParameters: IdentityHistoryV1ApiGetHistoricalIdentityEventsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).getHistoricalIdentityEventsV1(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Get latest snapshot of identity + * @param {IdentityHistoryV1ApiGetHistoricalIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public getHistoricalIdentityV1(requestParameters: IdentityHistoryV1ApiGetHistoricalIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).getHistoricalIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the summary for the event count for a specific identity + * @param {IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public getIdentitySnapshotSummaryV1(requestParameters: IdentityHistoryV1ApiGetIdentitySnapshotSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).getIdentitySnapshotSummaryV1(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets an identity snapshot at a given date + * @param {IdentityHistoryV1ApiGetIdentitySnapshotV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public getIdentitySnapshotV1(requestParameters: IdentityHistoryV1ApiGetIdentitySnapshotV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).getIdentitySnapshotV1(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the start date of the identity + * @param {IdentityHistoryV1ApiGetIdentityStartDateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public getIdentityStartDateV1(requestParameters: IdentityHistoryV1ApiGetIdentityStartDateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).getIdentityStartDateV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the identities + * @param {IdentityHistoryV1ApiListHistoricalIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public listHistoricalIdentitiesV1(requestParameters: IdentityHistoryV1ApiListHistoricalIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).listHistoricalIdentitiesV1(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves a list of access item for the identity filtered by the access item type + * @summary List access items by identity + * @param {IdentityHistoryV1ApiListIdentityAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public listIdentityAccessItemsV1(requestParameters: IdentityHistoryV1ApiListIdentityAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).listIdentityAccessItemsV1(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' + * @summary Gets the list of identity access items at a given date filterd by item type + * @param {IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public listIdentitySnapshotAccessItemsV1(requestParameters: IdentityHistoryV1ApiListIdentitySnapshotAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).listIdentitySnapshotAccessItemsV1(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' + * @summary Lists all the snapshots for the identity + * @param {IdentityHistoryV1ApiListIdentitySnapshotsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityHistoryV1Api + */ + public listIdentitySnapshotsV1(requestParameters: IdentityHistoryV1ApiListIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityHistoryV1ApiFp(this.configuration).listIdentitySnapshotsV1(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const CompareIdentitySnapshotsAccessTypeV1AccessTypeV1 = { + AccessProfile: 'accessProfile', + Account: 'account', + App: 'app', + Entitlement: 'entitlement', + Role: 'role' +} as const; +export type CompareIdentitySnapshotsAccessTypeV1AccessTypeV1 = typeof CompareIdentitySnapshotsAccessTypeV1AccessTypeV1[keyof typeof CompareIdentitySnapshotsAccessTypeV1AccessTypeV1]; +/** + * @export + */ +export const GetIdentitySnapshotSummaryV1IntervalV1 = { + Day: 'day', + Month: 'month' +} as const; +export type GetIdentitySnapshotSummaryV1IntervalV1 = typeof GetIdentitySnapshotSummaryV1IntervalV1[keyof typeof GetIdentitySnapshotSummaryV1IntervalV1]; +/** + * @export + */ +export const ListIdentityAccessItemsV1TypeV1 = { + Account: 'account', + Entitlement: 'entitlement', + App: 'app', + AccessProfile: 'accessProfile', + Role: 'role' +} as const; +export type ListIdentityAccessItemsV1TypeV1 = typeof ListIdentityAccessItemsV1TypeV1[keyof typeof ListIdentityAccessItemsV1TypeV1]; +/** + * @export + */ +export const ListIdentitySnapshotsV1IntervalV1 = { + Day: 'day', + Month: 'month' +} as const; +export type ListIdentitySnapshotsV1IntervalV1 = typeof ListIdentitySnapshotsV1IntervalV1[keyof typeof ListIdentitySnapshotsV1IntervalV1]; + + diff --git a/sdk-output/identity_history/base.ts b/sdk-output/identity_history/base.ts new file mode 100644 index 00000000..efb968ae --- /dev/null +++ b/sdk-output/identity_history/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity History + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/identity_history/common.ts b/sdk-output/identity_history/common.ts new file mode 100644 index 00000000..df393289 --- /dev/null +++ b/sdk-output/identity_history/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity History + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/identity_history/configuration.ts b/sdk-output/identity_history/configuration.ts new file mode 100644 index 00000000..09c579e3 --- /dev/null +++ b/sdk-output/identity_history/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity History + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/identity_history/git_push.sh b/sdk-output/identity_history/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/identity_history/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/identity_history/index.ts b/sdk-output/identity_history/index.ts new file mode 100644 index 00000000..d7dbd380 --- /dev/null +++ b/sdk-output/identity_history/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity History + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/identity_history/package.json b/sdk-output/identity_history/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/identity_history/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/identity_history/tsconfig.json b/sdk-output/identity_history/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/identity_history/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/identity_profiles/.gitignore b/sdk-output/identity_profiles/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/identity_profiles/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/identity_profiles/.npmignore b/sdk-output/identity_profiles/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/identity_profiles/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/identity_profiles/.openapi-generator-ignore b/sdk-output/identity_profiles/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/identity_profiles/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/identity_profiles/.openapi-generator/FILES b/sdk-output/identity_profiles/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/identity_profiles/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/identity_profiles/.openapi-generator/VERSION b/sdk-output/identity_profiles/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/identity_profiles/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/identity_profiles/.sdk-partition b/sdk-output/identity_profiles/.sdk-partition new file mode 100644 index 00000000..68a4d77d --- /dev/null +++ b/sdk-output/identity_profiles/.sdk-partition @@ -0,0 +1 @@ +identity-profiles \ No newline at end of file diff --git a/sdk-output/identity_profiles/README.md b/sdk-output/identity_profiles/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_profiles/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_profiles/api.ts b/sdk-output/identity_profiles/api.ts new file mode 100644 index 00000000..16353b29 --- /dev/null +++ b/sdk-output/identity_profiles/api.ts @@ -0,0 +1,1846 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Profiles + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + * @export + * @interface IdentityattributeconfigV1 + */ +export interface IdentityattributeconfigV1 { + /** + * Backend will only promote values if the profile/mapping is enabled. + * @type {boolean} + * @memberof IdentityattributeconfigV1 + */ + 'enabled'?: boolean; + /** + * + * @type {Array} + * @memberof IdentityattributeconfigV1 + */ + 'attributeTransforms'?: Array; +} +/** + * + * @export + * @interface IdentityattributepreviewV1 + */ +export interface IdentityattributepreviewV1 { + /** + * Name of the attribute that is being previewed. + * @type {string} + * @memberof IdentityattributepreviewV1 + */ + 'name'?: string; + /** + * Value that was derived during the preview. + * @type {string} + * @memberof IdentityattributepreviewV1 + */ + 'value'?: string; + /** + * The value of the attribute before the preview. + * @type {string} + * @memberof IdentityattributepreviewV1 + */ + 'previousValue'?: string; + /** + * List of error messages + * @type {Array} + * @memberof IdentityattributepreviewV1 + */ + 'errorMessages'?: Array; +} +/** + * Transform definition for an identity attribute. + * @export + * @interface IdentityattributetransformV1 + */ +export interface IdentityattributetransformV1 { + /** + * Identity attribute\'s name. + * @type {string} + * @memberof IdentityattributetransformV1 + */ + 'identityAttributeName'?: string; + /** + * + * @type {TransformdefinitionV1} + * @memberof IdentityattributetransformV1 + */ + 'transformDefinition'?: TransformdefinitionV1; +} +/** + * + * @export + * @interface IdentityexceptionreportreferenceV1 + */ +export interface IdentityexceptionreportreferenceV1 { + /** + * Task result ID. + * @type {string} + * @memberof IdentityexceptionreportreferenceV1 + */ + 'taskResultId'?: string; + /** + * Report name. + * @type {string} + * @memberof IdentityexceptionreportreferenceV1 + */ + 'reportName'?: string; +} +/** + * + * @export + * @interface IdentitypreviewrequestV1 + */ +export interface IdentitypreviewrequestV1 { + /** + * The Identity id + * @type {string} + * @memberof IdentitypreviewrequestV1 + */ + 'identityId'?: string; + /** + * + * @type {IdentityattributeconfigV1} + * @memberof IdentitypreviewrequestV1 + */ + 'identityAttributeConfig'?: IdentityattributeconfigV1; +} +/** + * Identity\'s basic details. + * @export + * @interface IdentitypreviewresponseIdentityV1 + */ +export interface IdentitypreviewresponseIdentityV1 { + /** + * Identity\'s DTO type. + * @type {string} + * @memberof IdentitypreviewresponseIdentityV1 + */ + 'type'?: IdentitypreviewresponseIdentityV1TypeV1; + /** + * Identity ID. + * @type {string} + * @memberof IdentitypreviewresponseIdentityV1 + */ + 'id'?: string; + /** + * Identity\'s display name. + * @type {string} + * @memberof IdentitypreviewresponseIdentityV1 + */ + 'name'?: string; +} + +export const IdentitypreviewresponseIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentitypreviewresponseIdentityV1TypeV1 = typeof IdentitypreviewresponseIdentityV1TypeV1[keyof typeof IdentitypreviewresponseIdentityV1TypeV1]; + +/** + * + * @export + * @interface IdentitypreviewresponseV1 + */ +export interface IdentitypreviewresponseV1 { + /** + * + * @type {IdentitypreviewresponseIdentityV1} + * @memberof IdentitypreviewresponseV1 + */ + 'identity'?: IdentitypreviewresponseIdentityV1; + /** + * + * @type {Array} + * @memberof IdentitypreviewresponseV1 + */ + 'previewAttributes'?: Array; +} +/** + * + * @export + * @interface IdentityprofileAllOfAuthoritativeSourceV1 + */ +export interface IdentityprofileAllOfAuthoritativeSourceV1 { + /** + * Authoritative source\'s object type. + * @type {string} + * @memberof IdentityprofileAllOfAuthoritativeSourceV1 + */ + 'type'?: IdentityprofileAllOfAuthoritativeSourceV1TypeV1; + /** + * Authoritative source\'s ID. + * @type {string} + * @memberof IdentityprofileAllOfAuthoritativeSourceV1 + */ + 'id'?: string; + /** + * Authoritative source\'s name. + * @type {string} + * @memberof IdentityprofileAllOfAuthoritativeSourceV1 + */ + 'name'?: string; +} + +export const IdentityprofileAllOfAuthoritativeSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type IdentityprofileAllOfAuthoritativeSourceV1TypeV1 = typeof IdentityprofileAllOfAuthoritativeSourceV1TypeV1[keyof typeof IdentityprofileAllOfAuthoritativeSourceV1TypeV1]; + +/** + * Identity profile\'s owner. + * @export + * @interface IdentityprofileAllOfOwnerV1 + */ +export interface IdentityprofileAllOfOwnerV1 { + /** + * Owner\'s object type. + * @type {string} + * @memberof IdentityprofileAllOfOwnerV1 + */ + 'type'?: IdentityprofileAllOfOwnerV1TypeV1; + /** + * Owner\'s ID. + * @type {string} + * @memberof IdentityprofileAllOfOwnerV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof IdentityprofileAllOfOwnerV1 + */ + 'name'?: string; +} + +export const IdentityprofileAllOfOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentityprofileAllOfOwnerV1TypeV1 = typeof IdentityprofileAllOfOwnerV1TypeV1[keyof typeof IdentityprofileAllOfOwnerV1TypeV1]; + +/** + * + * @export + * @interface IdentityprofileV1 + */ +export interface IdentityprofileV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof IdentityprofileV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof IdentityprofileV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof IdentityprofileV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof IdentityprofileV1 + */ + 'modified'?: string; + /** + * Identity profile\'s description. + * @type {string} + * @memberof IdentityprofileV1 + */ + 'description'?: string | null; + /** + * + * @type {IdentityprofileAllOfOwnerV1} + * @memberof IdentityprofileV1 + */ + 'owner'?: IdentityprofileAllOfOwnerV1 | null; + /** + * Identity profile\'s priority. + * @type {number} + * @memberof IdentityprofileV1 + */ + 'priority'?: number; + /** + * + * @type {IdentityprofileAllOfAuthoritativeSourceV1} + * @memberof IdentityprofileV1 + */ + 'authoritativeSource': IdentityprofileAllOfAuthoritativeSourceV1; + /** + * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. + * @type {boolean} + * @memberof IdentityprofileV1 + */ + 'identityRefreshRequired'?: boolean; + /** + * Number of identities belonging to the identity profile. + * @type {number} + * @memberof IdentityprofileV1 + */ + 'identityCount'?: number; + /** + * + * @type {IdentityattributeconfigV1} + * @memberof IdentityprofileV1 + */ + 'identityAttributeConfig'?: IdentityattributeconfigV1; + /** + * + * @type {IdentityexceptionreportreferenceV1} + * @memberof IdentityprofileV1 + */ + 'identityExceptionReportReference'?: IdentityexceptionreportreferenceV1 | null; + /** + * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. + * @type {boolean} + * @memberof IdentityprofileV1 + */ + 'hasTimeBasedAttr'?: boolean; +} +/** + * Self block for exported object. + * @export + * @interface IdentityprofileexportedobjectSelfV1 + */ +export interface IdentityprofileexportedobjectSelfV1 { + /** + * Exported object\'s DTO type. + * @type {string} + * @memberof IdentityprofileexportedobjectSelfV1 + */ + 'type'?: IdentityprofileexportedobjectSelfV1TypeV1; + /** + * Exported object\'s ID. + * @type {string} + * @memberof IdentityprofileexportedobjectSelfV1 + */ + 'id'?: string; + /** + * Exported object\'s display name. + * @type {string} + * @memberof IdentityprofileexportedobjectSelfV1 + */ + 'name'?: string; +} + +export const IdentityprofileexportedobjectSelfV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type IdentityprofileexportedobjectSelfV1TypeV1 = typeof IdentityprofileexportedobjectSelfV1TypeV1[keyof typeof IdentityprofileexportedobjectSelfV1TypeV1]; + +/** + * Identity profile exported object. + * @export + * @interface IdentityprofileexportedobjectV1 + */ +export interface IdentityprofileexportedobjectV1 { + /** + * Version or object from the target service. + * @type {number} + * @memberof IdentityprofileexportedobjectV1 + */ + 'version'?: number; + /** + * + * @type {IdentityprofileexportedobjectSelfV1} + * @memberof IdentityprofileexportedobjectV1 + */ + 'self'?: IdentityprofileexportedobjectSelfV1; + /** + * + * @type {IdentityprofileV1} + * @memberof IdentityprofileexportedobjectV1 + */ + 'object'?: IdentityprofileV1; +} +/** + * Object created or updated by import. + * @export + * @interface ImportobjectV1 + */ +export interface ImportobjectV1 { + /** + * DTO type of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'type'?: ImportobjectV1TypeV1; + /** + * ID of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'id'?: string; + /** + * Display name of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'name'?: string; +} + +export const ImportobjectV1TypeV1 = { + ConnectorRule: 'CONNECTOR_RULE', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + Rule: 'RULE', + Source: 'SOURCE', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION' +} as const; + +export type ImportobjectV1TypeV1 = typeof ImportobjectV1TypeV1[keyof typeof ImportobjectV1TypeV1]; + +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListIdentityProfilesV1401ResponseV1 + */ +export interface ListIdentityProfilesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityProfilesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListIdentityProfilesV1429ResponseV1 + */ +export interface ListIdentityProfilesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListIdentityProfilesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Response model for import of a single object. + * @export + * @interface ObjectimportresultV1 + */ +export interface ObjectimportresultV1 { + /** + * Informational messages returned from the target service on import. + * @type {Array} + * @memberof ObjectimportresultV1 + */ + 'infos': Array; + /** + * Warning messages returned from the target service on import. + * @type {Array} + * @memberof ObjectimportresultV1 + */ + 'warnings': Array; + /** + * Error messages returned from the target service on import. + * @type {Array} + * @memberof ObjectimportresultV1 + */ + 'errors': Array; + /** + * References to objects that were created or updated by the import. + * @type {Array} + * @memberof ObjectimportresultV1 + */ + 'importedObjects': Array; +} +/** + * Message model for Config Import/Export. + * @export + * @interface SpconfigmessageV1 + */ +export interface SpconfigmessageV1 { + /** + * Message key. + * @type {string} + * @memberof SpconfigmessageV1 + */ + 'key': string; + /** + * Message text. + * @type {string} + * @memberof SpconfigmessageV1 + */ + 'text': string; + /** + * Message details if any, in key:value pairs. + * @type {{ [key: string]: any; }} + * @memberof SpconfigmessageV1 + */ + 'details': { [key: string]: any; }; +} +/** + * + * @export + * @interface TaskresultsimplifiedV1 + */ +export interface TaskresultsimplifiedV1 { + /** + * Task identifier + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'id'?: string; + /** + * Task name + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'name'?: string; + /** + * Task description + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'description'?: string; + /** + * User or process who launched the task + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'launcher'?: string; + /** + * Date time of completion + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'completed'?: string; + /** + * Date time when the task was launched + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'launched'?: string; + /** + * Task result status + * @type {string} + * @memberof TaskresultsimplifiedV1 + */ + 'completionStatus'?: TaskresultsimplifiedV1CompletionStatusV1; +} + +export const TaskresultsimplifiedV1CompletionStatusV1 = { + Success: 'Success', + Warning: 'Warning', + Error: 'Error', + Terminated: 'Terminated', + TempError: 'TempError' +} as const; + +export type TaskresultsimplifiedV1CompletionStatusV1 = typeof TaskresultsimplifiedV1CompletionStatusV1[keyof typeof TaskresultsimplifiedV1CompletionStatusV1]; + +/** + * + * @export + * @interface TransformdefinitionV1 + */ +export interface TransformdefinitionV1 { + /** + * Transform definition type. + * @type {string} + * @memberof TransformdefinitionV1 + */ + 'type'?: string; + /** + * Arbitrary key-value pairs to store any metadata for the object + * @type {{ [key: string]: any; }} + * @memberof TransformdefinitionV1 + */ + 'attributes'?: { [key: string]: any; }; +} + +/** + * IdentityProfilesV1Api - axios parameter creator + * @export + */ +export const IdentityProfilesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates an identity profile. + * @summary Create identity profile + * @param {IdentityprofileV1} identityprofileV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityProfileV1: async (identityprofileV1: IdentityprofileV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityprofileV1' is not null or undefined + assertParamExists('createIdentityProfileV1', 'identityprofileV1', identityprofileV1) + const localVarPath = `/identity-profiles/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(identityprofileV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. + * @summary Delete identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('deleteIdentityProfileV1', 'identityProfileId', identityProfileId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete + * @summary Delete identity profiles + * @param {Array} requestBody Identity Profile bulk delete request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityProfilesV1: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('deleteIdentityProfilesV1', 'requestBody', requestBody) + const localVarPath = `/identity-profiles/v1/bulk-delete`; + // 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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This exports existing identity profiles in the format specified by the sp-config service. + * @summary Export identity profiles + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* + * @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, name, priority** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportIdentityProfilesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/identity-profiles/v1/export`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. + * @summary Generate identity profile preview + * @param {IdentitypreviewrequestV1} identitypreviewrequestV1 Identity Preview request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + generateIdentityPreviewV1: async (identitypreviewrequestV1: IdentitypreviewrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identitypreviewrequestV1' is not null or undefined + assertParamExists('generateIdentityPreviewV1', 'identitypreviewrequestV1', identitypreviewrequestV1) + const localVarPath = `/identity-profiles/v1/identity-preview`; + // 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(identitypreviewrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This returns the default identity attribute config. + * @summary Get default identity attribute config + * @param {string} identityProfileId The Identity Profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDefaultIdentityAttributeConfigV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('getDefaultIdentityAttributeConfigV1', 'identityProfileId', identityProfileId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/default-identity-attribute-config` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // 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 single identity profile by ID. + * @summary Get identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('getIdentityProfileV1', 'identityProfileId', identityProfileId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This imports previously exported identity profiles. + * @summary Import identity profiles + * @param {Array} identityprofileexportedobjectV1 Previously exported Identity Profiles. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importIdentityProfilesV1: async (identityprofileexportedobjectV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityprofileexportedobjectV1' is not null or undefined + assertParamExists('importIdentityProfilesV1', 'identityprofileexportedobjectV1', identityprofileexportedobjectV1) + const localVarPath = `/identity-profiles/v1/import`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(identityprofileexportedobjectV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a list of identity profiles, based on the specified query parameters. + * @summary List identity profiles + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + * @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, name, priority, created, modified, owner.id, owner.name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityProfilesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/identity-profiles/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. + * @summary Process identities under profile + * @param {string} identityProfileId The Identity Profile ID to be processed + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + syncIdentityProfileV1: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('syncIdentityProfileV1', 'identityProfileId', identityProfileId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/process-identities` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + * @summary Update identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {Array} jsonpatchoperationV1 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateIdentityProfileV1: async (identityProfileId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('updateIdentityProfileV1', 'identityProfileId', identityProfileId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateIdentityProfileV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * IdentityProfilesV1Api - functional programming interface + * @export + */ +export const IdentityProfilesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = IdentityProfilesV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates an identity profile. + * @summary Create identity profile + * @param {IdentityprofileV1} identityprofileV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createIdentityProfileV1(identityprofileV1: IdentityprofileV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfileV1(identityprofileV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.createIdentityProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. + * @summary Delete identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfileV1(identityProfileId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.deleteIdentityProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete + * @summary Delete identity profiles + * @param {Array} requestBody Identity Profile bulk delete request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteIdentityProfilesV1(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfilesV1(requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.deleteIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This exports existing identity profiles in the format specified by the sp-config service. + * @summary Export identity profiles + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* + * @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, name, priority** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportIdentityProfilesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfilesV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.exportIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. + * @summary Generate identity profile preview + * @param {IdentitypreviewrequestV1} identitypreviewrequestV1 Identity Preview request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async generateIdentityPreviewV1(identitypreviewrequestV1: IdentitypreviewrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreviewV1(identitypreviewrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.generateIdentityPreviewV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This returns the default identity attribute config. + * @summary Get default identity attribute config + * @param {string} identityProfileId The Identity Profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDefaultIdentityAttributeConfigV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfigV1(identityProfileId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.getDefaultIdentityAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a single identity profile by ID. + * @summary Get identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfileV1(identityProfileId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.getIdentityProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This imports previously exported identity profiles. + * @summary Import identity profiles + * @param {Array} identityprofileexportedobjectV1 Previously exported Identity Profiles. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importIdentityProfilesV1(identityprofileexportedobjectV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfilesV1(identityprofileexportedobjectV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.importIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of identity profiles, based on the specified query parameters. + * @summary List identity profiles + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + * @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, name, priority, created, modified, owner.id, owner.name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listIdentityProfilesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfilesV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.listIdentityProfilesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. + * @summary Process identities under profile + * @param {string} identityProfileId The Identity Profile ID to be processed + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async syncIdentityProfileV1(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfileV1(identityProfileId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.syncIdentityProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + * @summary Update identity profile + * @param {string} identityProfileId Identity profile ID. + * @param {Array} jsonpatchoperationV1 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateIdentityProfileV1(identityProfileId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfileV1(identityProfileId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV1Api.updateIdentityProfileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * IdentityProfilesV1Api - factory interface + * @export + */ +export const IdentityProfilesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = IdentityProfilesV1ApiFp(configuration) + return { + /** + * Creates an identity profile. + * @summary Create identity profile + * @param {IdentityProfilesV1ApiCreateIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createIdentityProfileV1(requestParameters: IdentityProfilesV1ApiCreateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createIdentityProfileV1(requestParameters.identityprofileV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. + * @summary Delete identity profile + * @param {IdentityProfilesV1ApiDeleteIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityProfileV1(requestParameters: IdentityProfilesV1ApiDeleteIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete + * @summary Delete identity profiles + * @param {IdentityProfilesV1ApiDeleteIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiDeleteIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteIdentityProfilesV1(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This exports existing identity profiles in the format specified by the sp-config service. + * @summary Export identity profiles + * @param {IdentityProfilesV1ApiExportIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiExportIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.exportIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. + * @summary Generate identity profile preview + * @param {IdentityProfilesV1ApiGenerateIdentityPreviewV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + generateIdentityPreviewV1(requestParameters: IdentityProfilesV1ApiGenerateIdentityPreviewV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.generateIdentityPreviewV1(requestParameters.identitypreviewrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This returns the default identity attribute config. + * @summary Get default identity attribute config + * @param {IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDefaultIdentityAttributeConfigV1(requestParameters: IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDefaultIdentityAttributeConfigV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a single identity profile by ID. + * @summary Get identity profile + * @param {IdentityProfilesV1ApiGetIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getIdentityProfileV1(requestParameters: IdentityProfilesV1ApiGetIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This imports previously exported identity profiles. + * @summary Import identity profiles + * @param {IdentityProfilesV1ApiImportIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiImportIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importIdentityProfilesV1(requestParameters.identityprofileexportedobjectV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of identity profiles, based on the specified query parameters. + * @summary List identity profiles + * @param {IdentityProfilesV1ApiListIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiListIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. + * @summary Process identities under profile + * @param {IdentityProfilesV1ApiSyncIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + syncIdentityProfileV1(requestParameters: IdentityProfilesV1ApiSyncIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.syncIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + * @summary Update identity profile + * @param {IdentityProfilesV1ApiUpdateIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateIdentityProfileV1(requestParameters: IdentityProfilesV1ApiUpdateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateIdentityProfileV1(requestParameters.identityProfileId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createIdentityProfileV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiCreateIdentityProfileV1Request + */ +export interface IdentityProfilesV1ApiCreateIdentityProfileV1Request { + /** + * + * @type {IdentityprofileV1} + * @memberof IdentityProfilesV1ApiCreateIdentityProfileV1 + */ + readonly identityprofileV1: IdentityprofileV1 +} + +/** + * Request parameters for deleteIdentityProfileV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiDeleteIdentityProfileV1Request + */ +export interface IdentityProfilesV1ApiDeleteIdentityProfileV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof IdentityProfilesV1ApiDeleteIdentityProfileV1 + */ + readonly identityProfileId: string +} + +/** + * Request parameters for deleteIdentityProfilesV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiDeleteIdentityProfilesV1Request + */ +export interface IdentityProfilesV1ApiDeleteIdentityProfilesV1Request { + /** + * Identity Profile bulk delete request body. + * @type {Array} + * @memberof IdentityProfilesV1ApiDeleteIdentityProfilesV1 + */ + readonly requestBody: Array +} + +/** + * Request parameters for exportIdentityProfilesV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiExportIdentityProfilesV1Request + */ +export interface IdentityProfilesV1ApiExportIdentityProfilesV1Request { + /** + * 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 IdentityProfilesV1ApiExportIdentityProfilesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityProfilesV1ApiExportIdentityProfilesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityProfilesV1ApiExportIdentityProfilesV1 + */ + 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, ne* **name**: *eq, ne* **priority**: *eq, ne* + * @type {string} + * @memberof IdentityProfilesV1ApiExportIdentityProfilesV1 + */ + 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, name, priority** + * @type {string} + * @memberof IdentityProfilesV1ApiExportIdentityProfilesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for generateIdentityPreviewV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiGenerateIdentityPreviewV1Request + */ +export interface IdentityProfilesV1ApiGenerateIdentityPreviewV1Request { + /** + * Identity Preview request body. + * @type {IdentitypreviewrequestV1} + * @memberof IdentityProfilesV1ApiGenerateIdentityPreviewV1 + */ + readonly identitypreviewrequestV1: IdentitypreviewrequestV1 +} + +/** + * Request parameters for getDefaultIdentityAttributeConfigV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request + */ +export interface IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request { + /** + * The Identity Profile ID. + * @type {string} + * @memberof IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1 + */ + readonly identityProfileId: string +} + +/** + * Request parameters for getIdentityProfileV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiGetIdentityProfileV1Request + */ +export interface IdentityProfilesV1ApiGetIdentityProfileV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof IdentityProfilesV1ApiGetIdentityProfileV1 + */ + readonly identityProfileId: string +} + +/** + * Request parameters for importIdentityProfilesV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiImportIdentityProfilesV1Request + */ +export interface IdentityProfilesV1ApiImportIdentityProfilesV1Request { + /** + * Previously exported Identity Profiles. + * @type {Array} + * @memberof IdentityProfilesV1ApiImportIdentityProfilesV1 + */ + readonly identityprofileexportedobjectV1: Array +} + +/** + * Request parameters for listIdentityProfilesV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiListIdentityProfilesV1Request + */ +export interface IdentityProfilesV1ApiListIdentityProfilesV1Request { + /** + * 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 IdentityProfilesV1ApiListIdentityProfilesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof IdentityProfilesV1ApiListIdentityProfilesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof IdentityProfilesV1ApiListIdentityProfilesV1 + */ + 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + * @type {string} + * @memberof IdentityProfilesV1ApiListIdentityProfilesV1 + */ + 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, name, priority, created, modified, owner.id, owner.name** + * @type {string} + * @memberof IdentityProfilesV1ApiListIdentityProfilesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for syncIdentityProfileV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiSyncIdentityProfileV1Request + */ +export interface IdentityProfilesV1ApiSyncIdentityProfileV1Request { + /** + * The Identity Profile ID to be processed + * @type {string} + * @memberof IdentityProfilesV1ApiSyncIdentityProfileV1 + */ + readonly identityProfileId: string +} + +/** + * Request parameters for updateIdentityProfileV1 operation in IdentityProfilesV1Api. + * @export + * @interface IdentityProfilesV1ApiUpdateIdentityProfileV1Request + */ +export interface IdentityProfilesV1ApiUpdateIdentityProfileV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof IdentityProfilesV1ApiUpdateIdentityProfileV1 + */ + readonly identityProfileId: string + + /** + * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof IdentityProfilesV1ApiUpdateIdentityProfileV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * IdentityProfilesV1Api - object-oriented interface + * @export + * @class IdentityProfilesV1Api + * @extends {BaseAPI} + */ +export class IdentityProfilesV1Api extends BaseAPI { + /** + * Creates an identity profile. + * @summary Create identity profile + * @param {IdentityProfilesV1ApiCreateIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public createIdentityProfileV1(requestParameters: IdentityProfilesV1ApiCreateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).createIdentityProfileV1(requestParameters.identityprofileV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. + * @summary Delete identity profile + * @param {IdentityProfilesV1ApiDeleteIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public deleteIdentityProfileV1(requestParameters: IdentityProfilesV1ApiDeleteIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).deleteIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete + * @summary Delete identity profiles + * @param {IdentityProfilesV1ApiDeleteIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public deleteIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiDeleteIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).deleteIdentityProfilesV1(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This exports existing identity profiles in the format specified by the sp-config service. + * @summary Export identity profiles + * @param {IdentityProfilesV1ApiExportIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public exportIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiExportIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).exportIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. + * @summary Generate identity profile preview + * @param {IdentityProfilesV1ApiGenerateIdentityPreviewV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public generateIdentityPreviewV1(requestParameters: IdentityProfilesV1ApiGenerateIdentityPreviewV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).generateIdentityPreviewV1(requestParameters.identitypreviewrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This returns the default identity attribute config. + * @summary Get default identity attribute config + * @param {IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public getDefaultIdentityAttributeConfigV1(requestParameters: IdentityProfilesV1ApiGetDefaultIdentityAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).getDefaultIdentityAttributeConfigV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a single identity profile by ID. + * @summary Get identity profile + * @param {IdentityProfilesV1ApiGetIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public getIdentityProfileV1(requestParameters: IdentityProfilesV1ApiGetIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).getIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This imports previously exported identity profiles. + * @summary Import identity profiles + * @param {IdentityProfilesV1ApiImportIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public importIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiImportIdentityProfilesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).importIdentityProfilesV1(requestParameters.identityprofileexportedobjectV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of identity profiles, based on the specified query parameters. + * @summary List identity profiles + * @param {IdentityProfilesV1ApiListIdentityProfilesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public listIdentityProfilesV1(requestParameters: IdentityProfilesV1ApiListIdentityProfilesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).listIdentityProfilesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. + * @summary Process identities under profile + * @param {IdentityProfilesV1ApiSyncIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public syncIdentityProfileV1(requestParameters: IdentityProfilesV1ApiSyncIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).syncIdentityProfileV1(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + * @summary Update identity profile + * @param {IdentityProfilesV1ApiUpdateIdentityProfileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof IdentityProfilesV1Api + */ + public updateIdentityProfileV1(requestParameters: IdentityProfilesV1ApiUpdateIdentityProfileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return IdentityProfilesV1ApiFp(this.configuration).updateIdentityProfileV1(requestParameters.identityProfileId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/identity_profiles/base.ts b/sdk-output/identity_profiles/base.ts new file mode 100644 index 00000000..c560acc3 --- /dev/null +++ b/sdk-output/identity_profiles/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Profiles + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/identity_profiles/common.ts b/sdk-output/identity_profiles/common.ts new file mode 100644 index 00000000..f5191026 --- /dev/null +++ b/sdk-output/identity_profiles/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Profiles + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/identity_profiles/configuration.ts b/sdk-output/identity_profiles/configuration.ts new file mode 100644 index 00000000..b74106a4 --- /dev/null +++ b/sdk-output/identity_profiles/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Profiles + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/identity_profiles/git_push.sh b/sdk-output/identity_profiles/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/identity_profiles/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/identity_profiles/index.ts b/sdk-output/identity_profiles/index.ts new file mode 100644 index 00000000..c12598d0 --- /dev/null +++ b/sdk-output/identity_profiles/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Identity Profiles + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/identity_profiles/package.json b/sdk-output/identity_profiles/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/identity_profiles/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/identity_profiles/tsconfig.json b/sdk-output/identity_profiles/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/identity_profiles/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/index.spec.ts b/sdk-output/index.spec.ts index ee2c47ba..d360a06b 100644 --- a/sdk-output/index.spec.ts +++ b/sdk-output/index.spec.ts @@ -1,147 +1,95 @@ -import { AccountsApi, AccountsBetaApi, AccountsV2024Api, Configuration, ConnectorsBetaApi, IdentitiesV2024Api, IdentityProfilesBetaApi, Paginator, Search, SearchApi, SearchV2024, SearchV2024Api, SearchV2025, SearchV2025Api, SourcesBetaApi, TransformsApi, TransformsV2024Api, AccessModelMetadataV2024Api, TaskManagementV2026Api } from "./index" +import { SailPoint, Configuration, Paginator, UsersNERMApi, DelegationsNERMV2025Api } from "./index" +import type { SearchV1 } from "./search/api" -describe('Test_v3', () => { - it('Test List Accounts', async () => { +describe('accounts', () => { + it('list accounts', async () => { let apiConfig = new Configuration() - let api = new AccountsApi(apiConfig) - - const resp = await api.listAccounts({limit: 10}) - - expect(resp.data.length).toStrictEqual(10) - expect(resp.status).toStrictEqual(200) - }, 30000) + let api = new SailPoint.AccountsApi(apiConfig) - it('Test paginate search API', async () => { - let apiConfig = new Configuration() - let api = new SearchApi(apiConfig) - - let search: Search = { - indices: [ - "identities" - ], - query: { - query: "*" - }, - sort: ["-name"] - } - const resp = await Paginator.paginateSearchApi(api, search, 10, 100) - - expect(resp.data.length).toStrictEqual(100) - expect(resp.status).toStrictEqual(200) - }, 120000) - - it('Test List Transforms', async () => { - let apiConfig = new Configuration() - let api = new TransformsApi(apiConfig) - - const resp = await api.listTransforms({limit: 10}) + const resp = await api.listAccountsV1({limit: 10}) expect(resp.data.length).toStrictEqual(10) expect(resp.status).toStrictEqual(200) }, 30000) - it('Test Pagination', async () => { + it('paginate accounts', async () => { let apiConfig = new Configuration() - let api = new AccountsApi(apiConfig) + let api = new SailPoint.AccountsApi(apiConfig) - const resp = await Paginator.paginate(api, api.listAccounts, {limit: 100}, 10) + const resp = await Paginator.paginate(api, api.listAccountsV1, {limit: 100}, 10) expect(resp.data.length).toStrictEqual(100) expect(resp.status).toStrictEqual(200) }, 30000) }) -describe('Test_beta', () => { - it('Test List Accounts', async () => { +describe('connectors', () => { + it('get connector list', async () => { let apiConfig = new Configuration() - let api = new AccountsBetaApi(apiConfig) + let api = new SailPoint.ConnectorsApi(apiConfig) - const resp = await api.listAccounts({limit: 10}) - - expect(resp.data.length).toStrictEqual(10) - expect(resp.status).toStrictEqual(200) - }, 30000) - - - it('Test connector api', async () => { - let apiConfig = new Configuration() - let api = new ConnectorsBetaApi(apiConfig) - - const resp = await api.getConnectorList({limit: 10}) + const resp = await api.getConnectorListV1({limit: 10}) expect(resp.data.length).toStrictEqual(10) expect(resp.status).toStrictEqual(200) }, 30000) +}) - it('Test List Sources', async () => { +describe('sources', () => { + it('list sources', async () => { let apiConfig = new Configuration() - let api = new SourcesBetaApi(apiConfig) + let api = new SailPoint.SourcesApi(apiConfig) - const resp = await api.listSources({limit: 10}) + const resp = await api.listSourcesV1({limit: 10}) expect(resp.data.length).toStrictEqual(10) expect(resp.status).toStrictEqual(200) }, 30000) - - it('Test Pagination', async () => { - let apiConfig = new Configuration() - let api = new IdentityProfilesBetaApi(apiConfig) - - const resp = await Paginator.paginate(api, api.listIdentityProfiles, {limit: 5}, 1) - - expect(resp.data.length).toStrictEqual(5) - expect(resp.status).toStrictEqual(200) - }, 30000) }) - -describe('Test_v2024', () => { - it('Test List Accounts', async () => { +describe('transforms', () => { + it('list transforms', async () => { let apiConfig = new Configuration() - let api = new AccountsV2024Api(apiConfig) + let api = new SailPoint.TransformsApi(apiConfig) - const resp = await api.listAccounts({limit: 10}) + const resp = await api.listTransformsV1({limit: 10}) expect(resp.data.length).toStrictEqual(10) expect(resp.status).toStrictEqual(200) }, 30000) +}) - it('Test List Transforms', async () => { +describe('identities', () => { + it('list identities with experimental flag', async () => { let apiConfig = new Configuration() - let api = new TransformsV2024Api(apiConfig) + apiConfig.experimental = true + let api = new SailPoint.IdentitiesApi(apiConfig) - const resp = await api.listTransforms({limit: 10}) + const resp = await api.listIdentitiesV1({limit: 10}) expect(resp.data.length).toStrictEqual(10) expect(resp.status).toStrictEqual(200) }, 30000) +}) - // it('Test List Identities without experimental flag set', async () => { - // let apiConfig = new Configuration() - // let api = new AccessModelMetadataV2024Api(apiConfig); - - // await expect(api.listAccessModelMetadataAttribute()).rejects.toThrow( - // "You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK." - // ); - // }, 30000) - - it('Test List Identities without experimental flag set', async () => { +describe('identity-profiles', () => { + it('paginate identity profiles', async () => { let apiConfig = new Configuration() - apiConfig.experimental = true - let api = new IdentitiesV2024Api(apiConfig); + let api = new SailPoint.IdentityProfilesApi(apiConfig) - const resp = await api.listIdentities({limit: 10}) + const resp = await Paginator.paginate(api, api.listIdentityProfilesV1, {limit: 3}, 1) - expect(resp.data.length).toStrictEqual(10) + expect(resp.data.length).toStrictEqual(3) expect(resp.status).toStrictEqual(200) }, 30000) +}) - - it('Test paginate search API with V2024', async () => { +describe('search', () => { + it('paginate search API', async () => { let apiConfig = new Configuration() - let api = new SearchV2024Api(apiConfig) + let api = new SailPoint.SearchApi(apiConfig) - let search: SearchV2024 = { + let search: SearchV1 = { indices: [ "identities" ], @@ -157,35 +105,50 @@ describe('Test_v2024', () => { }, 120000) }) - -describe('Test_v2025', () => { - - it('Test paginate search API with V2025', async () => { +describe('access-model-metadata', () => { + it('list access model metadata attributes with experimental flag', async () => { let apiConfig = new Configuration() - let api = new SearchV2025Api(apiConfig) + apiConfig.experimental = true + let api = new SailPoint.AccessModelMetadataApi(apiConfig) - let search: SearchV2025 = { - indices: [ - "identities" - ], - query: { - query: "*" - }, - sort: ["-name"] - } - const resp = await Paginator.paginateSearchApi(api, search, 10, 100) + const resp = await api.listAccessModelMetadataAttributeV1() - expect(resp.data.length).toStrictEqual(100) expect(resp.status).toStrictEqual(200) - }, 120000) + }, 30000) }) -describe('Test_v2026', () => { - it('Test get task status list API with V2026', async () => { +describe('task-management', () => { + it('get task status list with experimental flag', async () => { let apiConfig = new Configuration() apiConfig.experimental = true - let api = new TaskManagementV2026Api(apiConfig) - const resp = await api.getTaskStatusList(); + let api = new SailPoint.TaskManagementApi(apiConfig) + + const resp = await api.getTaskStatusListV1() expect(resp.status).toStrictEqual(200) }, 30000) -}) \ No newline at end of file +}) + +const _nermCheck = new Configuration() +const describeIfNerm = _nermCheck.nermBasePath ? describe : describe.skip + +describeIfNerm('nerm', () => { + it('list users', async () => { + const apiConfig = new Configuration() + const api = new UsersNERMApi(apiConfig) + + const resp = await api.getUsers({}) + + expect(resp.status).toStrictEqual(200) + expect(resp.data).toBeDefined() + }, 30000) + + it('v2025 list delegations', async () => { + const apiConfig = new Configuration() + const api = new DelegationsNERMV2025Api(apiConfig) + + const resp = await api.delegationsGet({}) + + expect(resp.status).toStrictEqual(200) + expect(resp.data).toBeDefined() + }, 30000) +}) diff --git a/sdk-output/index.ts b/sdk-output/index.ts index dc29d984..a5ae2a4e 100644 --- a/sdk-output/index.ts +++ b/sdk-output/index.ts @@ -1,34 +1,244 @@ /* tslint:disable */ /* eslint-disable */ -/** - * IdentityNow V3 API - * Use these APIs to interact with the IdentityNow 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: 3.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +// Code generated by build-versioned-sdk.js; DO NOT EDIT. +// +// Named imports — backward-compatible, version-explicit: +// import { AccountsV1Api, Configuration } from "sailpoint-api-client" +// +// Namespace — resource-named, version-agnostic (preferred): +// import { SailPoint, Configuration } from "sailpoint-api-client" +// const api = new SailPoint.AccountsApi(config) // works for v1, v2, v3 … +// api.listAccountsV1(...) // method name shows version +// api.listAccountsV2(...) // when v2 partition lands +// +// Models — import directly from the partition sub-path: +// import type { AccountV1 } from "sailpoint-api-client/accounts/api" +// --- Partition imports (private _ alias avoids TS1194 / TS2303 in namespace) --- +import { AccessModelMetadataV1Api as _AccessModelMetadataV1Api } from "./access_model_metadata/api"; +import { AccessProfilesV1Api as _AccessProfilesV1Api } from "./access_profiles/api"; +import { AccessRequestApprovalsV1Api as _AccessRequestApprovalsV1Api } from "./access_request_approvals/api"; +import { AccessRequestIdentityMetricsV1Api as _AccessRequestIdentityMetricsV1Api } from "./access_request_identity_metrics/api"; +import { AccessRequestsV1Api as _AccessRequestsV1Api } from "./access_requests/api"; +import { AccountActivitiesV1Api as _AccountActivitiesV1Api } from "./account_activities/api"; +import { AccountAggregationsV1Api as _AccountAggregationsV1Api } from "./account_aggregations/api"; +import { AccountDeletionRequestsV1Api as _AccountDeletionRequestsV1Api } from "./account_deletion_requests/api"; +import { AccountUsagesV1Api as _AccountUsagesV1Api } from "./account_usages/api"; +import { AccountsV1Api as _AccountsV1Api } from "./accounts/api"; +import { ApiUsageV1Api as _ApiUsageV1Api } from "./api_usage/api"; +import { ApplicationDiscoveryV1Api as _ApplicationDiscoveryV1Api } from "./application_discovery/api"; +import { ApprovalsV1Api as _ApprovalsV1Api } from "./approvals/api"; +import { AppsV1Api as _AppsV1Api } from "./apps/api"; +import { AuthProfileV1Api as _AuthProfileV1Api } from "./auth_profile/api"; +import { AuthUsersV1Api as _AuthUsersV1Api } from "./auth_users/api"; +import { BrandingV1Api as _BrandingV1Api } from "./branding/api"; +import { CertificationCampaignFiltersV1Api as _CertificationCampaignFiltersV1Api } from "./certification_campaign_filters/api"; +import { CertificationCampaignsV1Api as _CertificationCampaignsV1Api } from "./certification_campaigns/api"; +import { CertificationSummariesV1Api as _CertificationSummariesV1Api } from "./certification_summaries/api"; +import { CertificationsV1Api as _CertificationsV1Api } from "./certifications/api"; +import { ClassifySourceV1Api as _ClassifySourceV1Api } from "./classify_source/api"; +import { ConfigurationHubV1Api as _ConfigurationHubV1Api } from "./configuration_hub/api"; +import { ConnectorCustomizersV1Api as _ConnectorCustomizersV1Api } from "./connector_customizers/api"; +import { ConnectorRuleManagementV1Api as _ConnectorRuleManagementV1Api } from "./connector_rule_management/api"; +import { ConnectorsV1Api as _ConnectorsV1Api } from "./connectors/api"; +import { CustomFormsV1Api as _CustomFormsV1Api } from "./custom_forms/api"; +import { CustomPasswordInstructionsV1Api as _CustomPasswordInstructionsV1Api } from "./custom_password_instructions/api"; +import { CustomUserLevelsV1Api as _CustomUserLevelsV1Api } from "./custom_user_levels/api"; +import { DataAccessSecurityV1Api as _DataAccessSecurityV1Api } from "./data_access_security/api"; +import { DataSegmentationV1Api as _DataSegmentationV1Api } from "./data_segmentation/api"; +import { DeclassifySourceV1Api as _DeclassifySourceV1Api } from "./declassify_source/api"; +import { DimensionsV1Api as _DimensionsV1Api } from "./dimensions/api"; +import { EntitlementConnectionsV1Api as _EntitlementConnectionsV1Api } from "./entitlement_connections/api"; +import { EntitlementsV1Api as _EntitlementsV1Api } from "./entitlements/api"; +import { GlobalTenantSecuritySettingsV1Api as _GlobalTenantSecuritySettingsV1Api } from "./global_tenant_security_settings/api"; +import { GovernanceGroupsV1Api as _GovernanceGroupsV1Api } from "./governance_groups/api"; +import { IAIAccessRequestRecommendationsV1Api as _IAIAccessRequestRecommendationsV1Api } from "./iai_access_request_recommendations/api"; +import { IAICommonAccessV1Api as _IAICommonAccessV1Api } from "./iai_common_access/api"; +import { IAIOutliersV1Api as _IAIOutliersV1Api } from "./iai_outliers/api"; +import { IAIPeerGroupStrategiesV1Api as _IAIPeerGroupStrategiesV1Api } from "./iai_peer_group_strategies/api"; +import { IAIRecommendationsV1Api as _IAIRecommendationsV1Api } from "./iai_recommendations/api"; +import { IAIRoleMiningV1Api as _IAIRoleMiningV1Api } from "./iai_role_mining/api"; +import { IconsV1Api as _IconsV1Api } from "./icons/api"; +import { IdentitiesV1Api as _IdentitiesV1Api } from "./identities/api"; +import { IdentityAttributesV1Api as _IdentityAttributesV1Api } from "./identity_attributes/api"; +import { IdentityHistoryV1Api as _IdentityHistoryV1Api } from "./identity_history/api"; +import { IdentityProfilesV1Api as _IdentityProfilesV1Api } from "./identity_profiles/api"; +import { JITAccessV1Api as _JITAccessV1Api } from "./jit_access/api"; +import { JITActivationsV1Api as _JITActivationsV1Api } from "./jit_activations/api"; +import { LaunchersV1Api as _LaunchersV1Api } from "./launchers/api"; +import { LifecycleStatesV1Api as _LifecycleStatesV1Api } from "./lifecycle_states/api"; +import { MachineAccountClassifyV1Api as _MachineAccountClassifyV1Api } from "./machine_account_classify/api"; +import { MachineAccountCreationRequestV1Api as _MachineAccountCreationRequestV1Api } from "./machine_account_creation_request/api"; +import { MachineAccountMappingsV1Api as _MachineAccountMappingsV1Api } from "./machine_account_mappings/api"; +import { MachineAccountSubtypesV1Api as _MachineAccountSubtypesV1Api } from "./machine_account_subtypes/api"; +import { MachineAccountsV1Api as _MachineAccountsV1Api } from "./machine_accounts/api"; +import { MachineClassificationConfigV1Api as _MachineClassificationConfigV1Api } from "./machine_classification_config/api"; +import { MachineIdentitiesV1Api as _MachineIdentitiesV1Api } from "./machine_identities/api"; +import { ManagedClientsV1Api as _ManagedClientsV1Api } from "./managed_clients/api"; +import { ManagedClusterTypesV1Api as _ManagedClusterTypesV1Api } from "./managed_cluster_types/api"; +import { ManagedClustersV1Api as _ManagedClustersV1Api } from "./managed_clusters/api"; +import { MFAConfigurationV1Api as _MFAConfigurationV1Api } from "./mfa_configuration/api"; +import { MultiHostIntegrationV1Api as _MultiHostIntegrationV1Api } from "./multi_host_integration/api"; +import { NonEmployeeLifecycleManagementV1Api as _NonEmployeeLifecycleManagementV1Api } from "./non_employee_lifecycle_management/api"; +import { NotificationsV1Api as _NotificationsV1Api } from "./notifications/api"; +import { OAuthClientsV1Api as _OAuthClientsV1Api } from "./oauth_clients/api"; +import { OrgConfigV1Api as _OrgConfigV1Api } from "./org_config/api"; +import { ParameterStorageV1Api as _ParameterStorageV1Api } from "./parameter_storage/api"; +import { PasswordConfigurationV1Api as _PasswordConfigurationV1Api } from "./password_configuration/api"; +import { PasswordDictionaryV1Api as _PasswordDictionaryV1Api } from "./password_dictionary/api"; +import { PasswordManagementV1Api as _PasswordManagementV1Api } from "./password_management/api"; +import { PasswordPoliciesV1Api as _PasswordPoliciesV1Api } from "./password_policies/api"; +import { PasswordSyncGroupsV1Api as _PasswordSyncGroupsV1Api } from "./password_sync_groups/api"; +import { PersonalAccessTokensV1Api as _PersonalAccessTokensV1Api } from "./personal_access_tokens/api"; +import { PrivilegeCriteriaV1Api as _PrivilegeCriteriaV1Api } from "./privilege_criteria/api"; +import { PrivilegeCriteriaConfigurationV1Api as _PrivilegeCriteriaConfigurationV1Api } from "./privilege_criteria_configuration/api"; +import { PromptInsightsV1Api as _PromptInsightsV1Api } from "./prompt_insights/api"; +import { PublicIdentitiesV1Api as _PublicIdentitiesV1Api } from "./public_identities/api"; +import { PublicIdentitiesConfigV1Api as _PublicIdentitiesConfigV1Api } from "./public_identities_config/api"; +import { ReportsDataExtractionV1Api as _ReportsDataExtractionV1Api } from "./reports_data_extraction/api"; +import { RequestableObjectsV1Api as _RequestableObjectsV1Api } from "./requestable_objects/api"; +import { RoleInsightsV1Api as _RoleInsightsV1Api } from "./role_insights/api"; +import { RolePropagationV1Api as _RolePropagationV1Api } from "./role_propagation/api"; +import { RolesV1Api as _RolesV1Api } from "./roles/api"; +import { SavedSearchV1Api as _SavedSearchV1Api } from "./saved_search/api"; +import { ScheduledSearchV1Api as _ScheduledSearchV1Api } from "./scheduled_search/api"; +import { SearchV1Api as _SearchV1Api } from "./search/api"; +import { SearchAttributeConfigurationV1Api as _SearchAttributeConfigurationV1Api } from "./search_attribute_configuration/api"; +import { SegmentsV1Api as _SegmentsV1Api } from "./segments/api"; +import { ServiceDeskIntegrationV1Api as _ServiceDeskIntegrationV1Api } from "./service_desk_integration/api"; +import { SharedSignalsFrameworkSSFV1Api as _SharedSignalsFrameworkSSFV1Api } from "./shared_signals_framework_ssf/api"; +import { SIMIntegrationsV1Api as _SIMIntegrationsV1Api } from "./sim_integrations/api"; +import { SODPoliciesV1Api as _SODPoliciesV1Api } from "./sod_policies/api"; +import { SODViolationsV1Api as _SODViolationsV1Api } from "./sod_violations/api"; +import { SourceUsagesV1Api as _SourceUsagesV1Api } from "./source_usages/api"; +import { SourcesV1Api as _SourcesV1Api } from "./sources/api"; +import { SPConfigV1Api as _SPConfigV1Api } from "./sp_config/api"; +import { SuggestedEntitlementDescriptionV1Api as _SuggestedEntitlementDescriptionV1Api } from "./suggested_entitlement_description/api"; +import { TaggedObjectsV1Api as _TaggedObjectsV1Api } from "./tagged_objects/api"; +import { TagsV1Api as _TagsV1Api } from "./tags/api"; +import { TaskManagementV1Api as _TaskManagementV1Api } from "./task_management/api"; +import { TenantV1Api as _TenantV1Api } from "./tenant/api"; +import { TenantContextV1Api as _TenantContextV1Api } from "./tenant_context/api"; +import { TransformsV1Api as _TransformsV1Api } from "./transforms/api"; +import { TriggersV1Api as _TriggersV1Api } from "./triggers/api"; +import { UIMetadataV1Api as _UIMetadataV1Api } from "./ui_metadata/api"; +import { WorkItemsV1Api as _WorkItemsV1Api } from "./work_items/api"; +import { WorkReassignmentV1Api as _WorkReassignmentV1Api } from "./work_reassignment/api"; +import { WorkflowsV1Api as _WorkflowsV1Api } from "./workflows/api"; +// --- Named exports (versioned class names, backward-compatible) --- +export { _AccessModelMetadataV1Api as AccessModelMetadataV1Api }; +export { _AccessProfilesV1Api as AccessProfilesV1Api }; +export { _AccessRequestApprovalsV1Api as AccessRequestApprovalsV1Api }; +export { _AccessRequestIdentityMetricsV1Api as AccessRequestIdentityMetricsV1Api }; +export { _AccessRequestsV1Api as AccessRequestsV1Api }; +export { _AccountActivitiesV1Api as AccountActivitiesV1Api }; +export { _AccountAggregationsV1Api as AccountAggregationsV1Api }; +export { _AccountDeletionRequestsV1Api as AccountDeletionRequestsV1Api }; +export { _AccountUsagesV1Api as AccountUsagesV1Api }; +export { _AccountsV1Api as AccountsV1Api }; +export { _ApiUsageV1Api as ApiUsageV1Api }; +export { _ApplicationDiscoveryV1Api as ApplicationDiscoveryV1Api }; +export { _ApprovalsV1Api as ApprovalsV1Api }; +export { _AppsV1Api as AppsV1Api }; +export { _AuthProfileV1Api as AuthProfileV1Api }; +export { _AuthUsersV1Api as AuthUsersV1Api }; +export { _BrandingV1Api as BrandingV1Api }; +export { _CertificationCampaignFiltersV1Api as CertificationCampaignFiltersV1Api }; +export { _CertificationCampaignsV1Api as CertificationCampaignsV1Api }; +export { _CertificationSummariesV1Api as CertificationSummariesV1Api }; +export { _CertificationsV1Api as CertificationsV1Api }; +export { _ClassifySourceV1Api as ClassifySourceV1Api }; +export { _ConfigurationHubV1Api as ConfigurationHubV1Api }; +export { _ConnectorCustomizersV1Api as ConnectorCustomizersV1Api }; +export { _ConnectorRuleManagementV1Api as ConnectorRuleManagementV1Api }; +export { _ConnectorsV1Api as ConnectorsV1Api }; +export { _CustomFormsV1Api as CustomFormsV1Api }; +export { _CustomPasswordInstructionsV1Api as CustomPasswordInstructionsV1Api }; +export { _CustomUserLevelsV1Api as CustomUserLevelsV1Api }; +export { _DataAccessSecurityV1Api as DataAccessSecurityV1Api }; +export { _DataSegmentationV1Api as DataSegmentationV1Api }; +export { _DeclassifySourceV1Api as DeclassifySourceV1Api }; +export { _DimensionsV1Api as DimensionsV1Api }; +export { _EntitlementConnectionsV1Api as EntitlementConnectionsV1Api }; +export { _EntitlementsV1Api as EntitlementsV1Api }; +export { _GlobalTenantSecuritySettingsV1Api as GlobalTenantSecuritySettingsV1Api }; +export { _GovernanceGroupsV1Api as GovernanceGroupsV1Api }; +export { _IAIAccessRequestRecommendationsV1Api as IAIAccessRequestRecommendationsV1Api }; +export { _IAICommonAccessV1Api as IAICommonAccessV1Api }; +export { _IAIOutliersV1Api as IAIOutliersV1Api }; +export { _IAIPeerGroupStrategiesV1Api as IAIPeerGroupStrategiesV1Api }; +export { _IAIRecommendationsV1Api as IAIRecommendationsV1Api }; +export { _IAIRoleMiningV1Api as IAIRoleMiningV1Api }; +export { _IconsV1Api as IconsV1Api }; +export { _IdentitiesV1Api as IdentitiesV1Api }; +export { _IdentityAttributesV1Api as IdentityAttributesV1Api }; +export { _IdentityHistoryV1Api as IdentityHistoryV1Api }; +export { _IdentityProfilesV1Api as IdentityProfilesV1Api }; +export { _JITAccessV1Api as JITAccessV1Api }; +export { _JITActivationsV1Api as JITActivationsV1Api }; +export { _LaunchersV1Api as LaunchersV1Api }; +export { _LifecycleStatesV1Api as LifecycleStatesV1Api }; +export { _MachineAccountClassifyV1Api as MachineAccountClassifyV1Api }; +export { _MachineAccountCreationRequestV1Api as MachineAccountCreationRequestV1Api }; +export { _MachineAccountMappingsV1Api as MachineAccountMappingsV1Api }; +export { _MachineAccountSubtypesV1Api as MachineAccountSubtypesV1Api }; +export { _MachineAccountsV1Api as MachineAccountsV1Api }; +export { _MachineClassificationConfigV1Api as MachineClassificationConfigV1Api }; +export { _MachineIdentitiesV1Api as MachineIdentitiesV1Api }; +export { _ManagedClientsV1Api as ManagedClientsV1Api }; +export { _ManagedClusterTypesV1Api as ManagedClusterTypesV1Api }; +export { _ManagedClustersV1Api as ManagedClustersV1Api }; +export { _MFAConfigurationV1Api as MFAConfigurationV1Api }; +export { _MultiHostIntegrationV1Api as MultiHostIntegrationV1Api }; +export { _NonEmployeeLifecycleManagementV1Api as NonEmployeeLifecycleManagementV1Api }; +export { _NotificationsV1Api as NotificationsV1Api }; +export { _OAuthClientsV1Api as OAuthClientsV1Api }; +export { _OrgConfigV1Api as OrgConfigV1Api }; +export { _ParameterStorageV1Api as ParameterStorageV1Api }; +export { _PasswordConfigurationV1Api as PasswordConfigurationV1Api }; +export { _PasswordDictionaryV1Api as PasswordDictionaryV1Api }; +export { _PasswordManagementV1Api as PasswordManagementV1Api }; +export { _PasswordPoliciesV1Api as PasswordPoliciesV1Api }; +export { _PasswordSyncGroupsV1Api as PasswordSyncGroupsV1Api }; +export { _PersonalAccessTokensV1Api as PersonalAccessTokensV1Api }; +export { _PrivilegeCriteriaV1Api as PrivilegeCriteriaV1Api }; +export { _PrivilegeCriteriaConfigurationV1Api as PrivilegeCriteriaConfigurationV1Api }; +export { _PromptInsightsV1Api as PromptInsightsV1Api }; +export { _PublicIdentitiesV1Api as PublicIdentitiesV1Api }; +export { _PublicIdentitiesConfigV1Api as PublicIdentitiesConfigV1Api }; +export { _ReportsDataExtractionV1Api as ReportsDataExtractionV1Api }; +export { _RequestableObjectsV1Api as RequestableObjectsV1Api }; +export { _RoleInsightsV1Api as RoleInsightsV1Api }; +export { _RolePropagationV1Api as RolePropagationV1Api }; +export { _RolesV1Api as RolesV1Api }; +export { _SavedSearchV1Api as SavedSearchV1Api }; +export { _ScheduledSearchV1Api as ScheduledSearchV1Api }; +export { _SearchV1Api as SearchV1Api }; +export { _SearchAttributeConfigurationV1Api as SearchAttributeConfigurationV1Api }; +export { _SegmentsV1Api as SegmentsV1Api }; +export { _ServiceDeskIntegrationV1Api as ServiceDeskIntegrationV1Api }; +export { _SharedSignalsFrameworkSSFV1Api as SharedSignalsFrameworkSSFV1Api }; +export { _SIMIntegrationsV1Api as SIMIntegrationsV1Api }; +export { _SODPoliciesV1Api as SODPoliciesV1Api }; +export { _SODViolationsV1Api as SODViolationsV1Api }; +export { _SourceUsagesV1Api as SourceUsagesV1Api }; +export { _SourcesV1Api as SourcesV1Api }; +export { _SPConfigV1Api as SPConfigV1Api }; +export { _SuggestedEntitlementDescriptionV1Api as SuggestedEntitlementDescriptionV1Api }; +export { _TaggedObjectsV1Api as TaggedObjectsV1Api }; +export { _TagsV1Api as TagsV1Api }; +export { _TaskManagementV1Api as TaskManagementV1Api }; +export { _TenantV1Api as TenantV1Api }; +export { _TenantContextV1Api as TenantContextV1Api }; +export { _TransformsV1Api as TransformsV1Api }; +export { _TriggersV1Api as TriggersV1Api }; +export { _UIMetadataV1Api as UIMetadataV1Api }; +export { _WorkItemsV1Api as WorkItemsV1Api }; +export { _WorkReassignmentV1Api as WorkReassignmentV1Api }; +export { _WorkflowsV1Api as WorkflowsV1Api }; -export * from "./beta/api"; -export { Configuration as ConfigurationBeta, ConfigurationParameters as ConfigurationParametersBeta } from "./beta/configuration"; - -export * from "./v3/api"; -export { ConfigurationParameters as ConfigurationParametersV3, Configuration as ConfigurationV3 } from "./v3/configuration"; - -export * from "./v2024/api"; -export { ConfigurationParameters as ConfigurationParametersV2024, Configuration as ConfigurationV2024 } from "./v2024/configuration"; - -export * from "./v2025/api"; -export { ConfigurationParameters as ConfigurationParametersV2025, Configuration as ConfigurationV2025 } from "./v2025/configuration"; - -export * from "./v2026/api"; -export { ConfigurationParameters as ConfigurationParametersV2026, Configuration as ConfigurationV2026 } from "./v2026/configuration"; - +// --- Generic / NERM / shared exports --- export * from "./generic/api"; export * from "./nerm/api"; @@ -44,3 +254,117 @@ export { axiosRetry }; import * as axiosRetry from "axios-retry"; + +// --- SailPoint namespace (resource-named, all versions combined) --- +export namespace SailPoint { + export const AccessModelMetadataApi = _AccessModelMetadataV1Api; + export const AccessProfilesApi = _AccessProfilesV1Api; + export const AccessRequestApprovalsApi = _AccessRequestApprovalsV1Api; + export const AccessRequestIdentityMetricsApi = _AccessRequestIdentityMetricsV1Api; + export const AccessRequestsApi = _AccessRequestsV1Api; + export const AccountActivitiesApi = _AccountActivitiesV1Api; + export const AccountAggregationsApi = _AccountAggregationsV1Api; + export const AccountDeletionRequestsApi = _AccountDeletionRequestsV1Api; + export const AccountUsagesApi = _AccountUsagesV1Api; + export const AccountsApi = _AccountsV1Api; + export const ApiUsageApi = _ApiUsageV1Api; + export const ApplicationDiscoveryApi = _ApplicationDiscoveryV1Api; + export const ApprovalsApi = _ApprovalsV1Api; + export const AppsApi = _AppsV1Api; + export const AuthProfileApi = _AuthProfileV1Api; + export const AuthUsersApi = _AuthUsersV1Api; + export const BrandingApi = _BrandingV1Api; + export const CertificationCampaignFiltersApi = _CertificationCampaignFiltersV1Api; + export const CertificationCampaignsApi = _CertificationCampaignsV1Api; + export const CertificationSummariesApi = _CertificationSummariesV1Api; + export const CertificationsApi = _CertificationsV1Api; + export const ClassifySourceApi = _ClassifySourceV1Api; + export const ConfigurationHubApi = _ConfigurationHubV1Api; + export const ConnectorCustomizersApi = _ConnectorCustomizersV1Api; + export const ConnectorRuleManagementApi = _ConnectorRuleManagementV1Api; + export const ConnectorsApi = _ConnectorsV1Api; + export const CustomFormsApi = _CustomFormsV1Api; + export const CustomPasswordInstructionsApi = _CustomPasswordInstructionsV1Api; + export const CustomUserLevelsApi = _CustomUserLevelsV1Api; + export const DataAccessSecurityApi = _DataAccessSecurityV1Api; + export const DataSegmentationApi = _DataSegmentationV1Api; + export const DeclassifySourceApi = _DeclassifySourceV1Api; + export const DimensionsApi = _DimensionsV1Api; + export const EntitlementConnectionsApi = _EntitlementConnectionsV1Api; + export const EntitlementsApi = _EntitlementsV1Api; + export const GlobalTenantSecuritySettingsApi = _GlobalTenantSecuritySettingsV1Api; + export const GovernanceGroupsApi = _GovernanceGroupsV1Api; + export const IAIAccessRequestRecommendationsApi = _IAIAccessRequestRecommendationsV1Api; + export const IAICommonAccessApi = _IAICommonAccessV1Api; + export const IAIOutliersApi = _IAIOutliersV1Api; + export const IAIPeerGroupStrategiesApi = _IAIPeerGroupStrategiesV1Api; + export const IAIRecommendationsApi = _IAIRecommendationsV1Api; + export const IAIRoleMiningApi = _IAIRoleMiningV1Api; + export const IconsApi = _IconsV1Api; + export const IdentitiesApi = _IdentitiesV1Api; + export const IdentityAttributesApi = _IdentityAttributesV1Api; + export const IdentityHistoryApi = _IdentityHistoryV1Api; + export const IdentityProfilesApi = _IdentityProfilesV1Api; + export const JITAccessApi = _JITAccessV1Api; + export const JITActivationsApi = _JITActivationsV1Api; + export const LaunchersApi = _LaunchersV1Api; + export const LifecycleStatesApi = _LifecycleStatesV1Api; + export const MachineAccountClassifyApi = _MachineAccountClassifyV1Api; + export const MachineAccountCreationRequestApi = _MachineAccountCreationRequestV1Api; + export const MachineAccountMappingsApi = _MachineAccountMappingsV1Api; + export const MachineAccountSubtypesApi = _MachineAccountSubtypesV1Api; + export const MachineAccountsApi = _MachineAccountsV1Api; + export const MachineClassificationConfigApi = _MachineClassificationConfigV1Api; + export const MachineIdentitiesApi = _MachineIdentitiesV1Api; + export const ManagedClientsApi = _ManagedClientsV1Api; + export const ManagedClusterTypesApi = _ManagedClusterTypesV1Api; + export const ManagedClustersApi = _ManagedClustersV1Api; + export const MFAConfigurationApi = _MFAConfigurationV1Api; + export const MultiHostIntegrationApi = _MultiHostIntegrationV1Api; + export const NonEmployeeLifecycleManagementApi = _NonEmployeeLifecycleManagementV1Api; + export const NotificationsApi = _NotificationsV1Api; + export const OAuthClientsApi = _OAuthClientsV1Api; + export const OrgConfigApi = _OrgConfigV1Api; + export const ParameterStorageApi = _ParameterStorageV1Api; + export const PasswordConfigurationApi = _PasswordConfigurationV1Api; + export const PasswordDictionaryApi = _PasswordDictionaryV1Api; + export const PasswordManagementApi = _PasswordManagementV1Api; + export const PasswordPoliciesApi = _PasswordPoliciesV1Api; + export const PasswordSyncGroupsApi = _PasswordSyncGroupsV1Api; + export const PersonalAccessTokensApi = _PersonalAccessTokensV1Api; + export const PrivilegeCriteriaApi = _PrivilegeCriteriaV1Api; + export const PrivilegeCriteriaConfigurationApi = _PrivilegeCriteriaConfigurationV1Api; + export const PromptInsightsApi = _PromptInsightsV1Api; + export const PublicIdentitiesApi = _PublicIdentitiesV1Api; + export const PublicIdentitiesConfigApi = _PublicIdentitiesConfigV1Api; + export const ReportsDataExtractionApi = _ReportsDataExtractionV1Api; + export const RequestableObjectsApi = _RequestableObjectsV1Api; + export const RoleInsightsApi = _RoleInsightsV1Api; + export const RolePropagationApi = _RolePropagationV1Api; + export const RolesApi = _RolesV1Api; + export const SavedSearchApi = _SavedSearchV1Api; + export const ScheduledSearchApi = _ScheduledSearchV1Api; + export const SearchApi = _SearchV1Api; + export const SearchAttributeConfigurationApi = _SearchAttributeConfigurationV1Api; + export const SegmentsApi = _SegmentsV1Api; + export const ServiceDeskIntegrationApi = _ServiceDeskIntegrationV1Api; + export const SharedSignalsFrameworkSSFApi = _SharedSignalsFrameworkSSFV1Api; + export const SIMIntegrationsApi = _SIMIntegrationsV1Api; + export const SODPoliciesApi = _SODPoliciesV1Api; + export const SODViolationsApi = _SODViolationsV1Api; + export const SourceUsagesApi = _SourceUsagesV1Api; + export const SourcesApi = _SourcesV1Api; + export const SPConfigApi = _SPConfigV1Api; + export const SuggestedEntitlementDescriptionApi = _SuggestedEntitlementDescriptionV1Api; + export const TaggedObjectsApi = _TaggedObjectsV1Api; + export const TagsApi = _TagsV1Api; + export const TaskManagementApi = _TaskManagementV1Api; + export const TenantApi = _TenantV1Api; + export const TenantContextApi = _TenantContextV1Api; + export const TransformsApi = _TransformsV1Api; + export const TriggersApi = _TriggersV1Api; + export const UIMetadataApi = _UIMetadataV1Api; + export const WorkItemsApi = _WorkItemsV1Api; + export const WorkReassignmentApi = _WorkReassignmentV1Api; + export const WorkflowsApi = _WorkflowsV1Api; +} diff --git a/sdk-output/jit_access/.gitignore b/sdk-output/jit_access/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/jit_access/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/jit_access/.npmignore b/sdk-output/jit_access/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/jit_access/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/jit_access/.openapi-generator-ignore b/sdk-output/jit_access/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/jit_access/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/jit_access/.openapi-generator/FILES b/sdk-output/jit_access/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/jit_access/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/jit_access/.openapi-generator/VERSION b/sdk-output/jit_access/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/jit_access/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/jit_access/.sdk-partition b/sdk-output/jit_access/.sdk-partition new file mode 100644 index 00000000..8d97a3dd --- /dev/null +++ b/sdk-output/jit_access/.sdk-partition @@ -0,0 +1 @@ +jit-access \ No newline at end of file diff --git a/sdk-output/jit_access/README.md b/sdk-output/jit_access/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/jit_access/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/jit_access/api.ts b/sdk-output/jit_access/api.ts new file mode 100644 index 00000000..6d4035e8 --- /dev/null +++ b/sdk-output/jit_access/api.ts @@ -0,0 +1,469 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Access + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetJitActivationConfigV1401ResponseV1 + */ +export interface GetJitActivationConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetJitActivationConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetJitActivationConfigV1429ResponseV1 + */ +export interface GetJitActivationConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetJitActivationConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A single replace operation applied to JIT activation configuration. Only **replace** is supported. **path** must be one of the allowed JSON Pointer-style paths. + * @export + * @interface JitaccessoperationrequestV1 + */ +export interface JitaccessoperationrequestV1 { + /** + * Operation type. Defaults to `replace` if omitted. + * @type {string} + * @memberof JitaccessoperationrequestV1 + */ + 'op'?: JitaccessoperationrequestV1OpV1; + /** + * Path to replace. Only the following JSON Pointer-style paths are supported. + * @type {string} + * @memberof JitaccessoperationrequestV1 + */ + 'path': JitaccessoperationrequestV1PathV1; + /** + * + * @type {JitaccessoperationrequestValueV1} + * @memberof JitaccessoperationrequestV1 + */ + 'value': JitaccessoperationrequestValueV1 | null; +} + +export const JitaccessoperationrequestV1OpV1 = { + Replace: 'replace' +} as const; + +export type JitaccessoperationrequestV1OpV1 = typeof JitaccessoperationrequestV1OpV1[keyof typeof JitaccessoperationrequestV1OpV1]; +export const JitaccessoperationrequestV1PathV1 = { + EntitlementIds: '/entitlementIds', + MaxActivationPeriodMins: '/maxActivationPeriodMins', + MaxActivationPeriodExtensionMins: '/maxActivationPeriodExtensionMins', + DefaultMaxActivationPeriodMins: '/defaultMaxActivationPeriodMins', + DefaultMaxActivationPeriodExtensionMins: '/defaultMaxActivationPeriodExtensionMins', + NotificationRecipients: '/notificationRecipients', + NotificationTemplate: '/notificationTemplate', + ApplyToFutureAssignments: '/applyToFutureAssignments' +} as const; + +export type JitaccessoperationrequestV1PathV1 = typeof JitaccessoperationrequestV1PathV1[keyof typeof JitaccessoperationrequestV1PathV1]; + +/** + * @type JitaccessoperationrequestValueV1 + * New value. Type depends on **path**: arrays of strings for `/entitlementIds` and `/notificationRecipients`, integer for `*Mins` paths, string for `/notificationTemplate`, boolean for `/applyToFutureAssignments`. Use `null` when clearing nullable fields (for example `/notificationTemplate` or `*Mins` paths). + * @export + */ +export type JitaccessoperationrequestValueV1 = Array | boolean | number | string; + +/** + * + * @export + * @interface JitactivationconfigresponseV1 + */ +export interface JitactivationconfigresponseV1 { + /** + * Unique identifier of this JIT activation configuration instance (persisted config id). + * @type {string} + * @memberof JitactivationconfigresponseV1 + */ + 'id': string; + /** + * Entitlement IDs governed by JIT activation policy. May be a single-element array when only one entitlement is in scope. + * @type {Array} + * @memberof JitactivationconfigresponseV1 + */ + 'entitlementIds'?: Array; + /** + * Maximum allowed JIT activation duration for a single grant, in minutes; null if unset. + * @type {number} + * @memberof JitactivationconfigresponseV1 + */ + 'maxActivationPeriodMins'?: number | null; + /** + * Maximum allowed extension of an active JIT activation, in minutes; null if unset. + * @type {number} + * @memberof JitactivationconfigresponseV1 + */ + 'maxActivationPeriodExtensionMins'?: number | null; + /** + * Default activation duration offered when a user requests JIT access, in minutes; null if unset. + * @type {number} + * @memberof JitactivationconfigresponseV1 + */ + 'defaultMaxActivationPeriodMins'?: number | null; + /** + * Default extension duration offered for an active JIT activation, in minutes; null if unset. + * @type {number} + * @memberof JitactivationconfigresponseV1 + */ + 'defaultMaxActivationPeriodExtensionMins'?: number | null; + /** + * Email addresses notified for JIT activation events (for example policy owners or a shared mailbox). + * @type {Array} + * @memberof JitactivationconfigresponseV1 + */ + 'notificationRecipients'?: Array; + /** + * Name or key of the email template used for JIT activation notifications; null if unset. + * @type {string} + * @memberof JitactivationconfigresponseV1 + */ + 'notificationTemplate'?: string | null; + /** + * Whether the policy applies to future entitlement assignments. + * @type {boolean} + * @memberof JitactivationconfigresponseV1 + */ + 'applyToFutureAssignments': boolean; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * JITAccessV1Api - axios parameter creator + * @export + */ +export const JITAccessV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). + * @summary Get JIT activation policy configuration + * @param {GetJitActivationConfigV1ConfigTypeV1} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getJitActivationConfigV1: async (configType: GetJitActivationConfigV1ConfigTypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'configType' is not null or undefined + assertParamExists('getJitActivationConfigV1', 'configType', configType) + const localVarPath = `/jit-activation-config/v1/{configType}` + .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); + // 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, + }; + }, + /** + * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). + * @summary Update JIT activation policy configuration + * @param {PatchJitActivationConfigV1ConfigTypeV1} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. + * @param {Array} jitaccessoperationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchJitActivationConfigV1: async (configType: PatchJitActivationConfigV1ConfigTypeV1, jitaccessoperationrequestV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'configType' is not null or undefined + assertParamExists('patchJitActivationConfigV1', 'configType', configType) + // verify required parameter 'jitaccessoperationrequestV1' is not null or undefined + assertParamExists('patchJitActivationConfigV1', 'jitaccessoperationrequestV1', jitaccessoperationrequestV1) + const localVarPath = `/jit-activation-config/v1/{configType}` + .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); + // 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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jitaccessoperationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * JITAccessV1Api - functional programming interface + * @export + */ +export const JITAccessV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = JITAccessV1ApiAxiosParamCreator(configuration) + return { + /** + * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). + * @summary Get JIT activation policy configuration + * @param {GetJitActivationConfigV1ConfigTypeV1} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getJitActivationConfigV1(configType: GetJitActivationConfigV1ConfigTypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getJitActivationConfigV1(configType, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['JITAccessV1Api.getJitActivationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). + * @summary Update JIT activation policy configuration + * @param {PatchJitActivationConfigV1ConfigTypeV1} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. + * @param {Array} jitaccessoperationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchJitActivationConfigV1(configType: PatchJitActivationConfigV1ConfigTypeV1, jitaccessoperationrequestV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchJitActivationConfigV1(configType, jitaccessoperationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['JITAccessV1Api.patchJitActivationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * JITAccessV1Api - factory interface + * @export + */ +export const JITAccessV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = JITAccessV1ApiFp(configuration) + return { + /** + * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). + * @summary Get JIT activation policy configuration + * @param {JITAccessV1ApiGetJitActivationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getJitActivationConfigV1(requestParameters: JITAccessV1ApiGetJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getJitActivationConfigV1(requestParameters.configType, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). + * @summary Update JIT activation policy configuration + * @param {JITAccessV1ApiPatchJitActivationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchJitActivationConfigV1(requestParameters: JITAccessV1ApiPatchJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchJitActivationConfigV1(requestParameters.configType, requestParameters.jitaccessoperationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getJitActivationConfigV1 operation in JITAccessV1Api. + * @export + * @interface JITAccessV1ApiGetJitActivationConfigV1Request + */ +export interface JITAccessV1ApiGetJitActivationConfigV1Request { + /** + * Configuration kind to read. Only **policy** (JIT activation policy) is supported today. + * @type {'policy'} + * @memberof JITAccessV1ApiGetJitActivationConfigV1 + */ + readonly configType: GetJitActivationConfigV1ConfigTypeV1 +} + +/** + * Request parameters for patchJitActivationConfigV1 operation in JITAccessV1Api. + * @export + * @interface JITAccessV1ApiPatchJitActivationConfigV1Request + */ +export interface JITAccessV1ApiPatchJitActivationConfigV1Request { + /** + * Configuration kind to update. Only **policy** (JIT activation policy) is supported today. + * @type {'policy'} + * @memberof JITAccessV1ApiPatchJitActivationConfigV1 + */ + readonly configType: PatchJitActivationConfigV1ConfigTypeV1 + + /** + * + * @type {Array} + * @memberof JITAccessV1ApiPatchJitActivationConfigV1 + */ + readonly jitaccessoperationrequestV1: Array +} + +/** + * JITAccessV1Api - object-oriented interface + * @export + * @class JITAccessV1Api + * @extends {BaseAPI} + */ +export class JITAccessV1Api extends BaseAPI { + /** + * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). + * @summary Get JIT activation policy configuration + * @param {JITAccessV1ApiGetJitActivationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof JITAccessV1Api + */ + public getJitActivationConfigV1(requestParameters: JITAccessV1ApiGetJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return JITAccessV1ApiFp(this.configuration).getJitActivationConfigV1(requestParameters.configType, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). + * @summary Update JIT activation policy configuration + * @param {JITAccessV1ApiPatchJitActivationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof JITAccessV1Api + */ + public patchJitActivationConfigV1(requestParameters: JITAccessV1ApiPatchJitActivationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return JITAccessV1ApiFp(this.configuration).patchJitActivationConfigV1(requestParameters.configType, requestParameters.jitaccessoperationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetJitActivationConfigV1ConfigTypeV1 = { + Policy: 'policy' +} as const; +export type GetJitActivationConfigV1ConfigTypeV1 = typeof GetJitActivationConfigV1ConfigTypeV1[keyof typeof GetJitActivationConfigV1ConfigTypeV1]; +/** + * @export + */ +export const PatchJitActivationConfigV1ConfigTypeV1 = { + Policy: 'policy' +} as const; +export type PatchJitActivationConfigV1ConfigTypeV1 = typeof PatchJitActivationConfigV1ConfigTypeV1[keyof typeof PatchJitActivationConfigV1ConfigTypeV1]; + + diff --git a/sdk-output/jit_access/base.ts b/sdk-output/jit_access/base.ts new file mode 100644 index 00000000..89b9ed9c --- /dev/null +++ b/sdk-output/jit_access/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Access + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/jit_access/common.ts b/sdk-output/jit_access/common.ts new file mode 100644 index 00000000..72426279 --- /dev/null +++ b/sdk-output/jit_access/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Access + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/jit_access/configuration.ts b/sdk-output/jit_access/configuration.ts new file mode 100644 index 00000000..0af0e56d --- /dev/null +++ b/sdk-output/jit_access/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Access + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/jit_access/git_push.sh b/sdk-output/jit_access/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/jit_access/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/jit_access/index.ts b/sdk-output/jit_access/index.ts new file mode 100644 index 00000000..7ea7b7be --- /dev/null +++ b/sdk-output/jit_access/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Access + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/jit_access/package.json b/sdk-output/jit_access/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/jit_access/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/jit_access/tsconfig.json b/sdk-output/jit_access/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/jit_access/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/jit_activations/.gitignore b/sdk-output/jit_activations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/jit_activations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/jit_activations/.npmignore b/sdk-output/jit_activations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/jit_activations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/jit_activations/.openapi-generator-ignore b/sdk-output/jit_activations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/jit_activations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/jit_activations/.openapi-generator/FILES b/sdk-output/jit_activations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/jit_activations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/jit_activations/.openapi-generator/VERSION b/sdk-output/jit_activations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/jit_activations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/jit_activations/.sdk-partition b/sdk-output/jit_activations/.sdk-partition new file mode 100644 index 00000000..1f0213d4 --- /dev/null +++ b/sdk-output/jit_activations/.sdk-partition @@ -0,0 +1 @@ +jit-activations \ No newline at end of file diff --git a/sdk-output/jit_activations/README.md b/sdk-output/jit_activations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/jit_activations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/jit_activations/api.ts b/sdk-output/jit_activations/api.ts new file mode 100644 index 00000000..826ff22a --- /dev/null +++ b/sdk-output/jit_activations/api.ts @@ -0,0 +1,618 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Activations + * 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'; + +/** + * JIT activation workflow status. + * @export + * @enum {string} + */ + +export const ActivationworkflowstatusV1 = { + Creating: 'CREATING', + Activating: 'ACTIVATING', + Invalid: 'INVALID', + Error: 'ERROR', + Provisioned: 'PROVISIONED', + Deprovisioning: 'DEPROVISIONING', + Completed: 'COMPLETED', + Revoked: 'REVOKED' +} as const; + +export type ActivationworkflowstatusV1 = typeof ActivationworkflowstatusV1[keyof typeof ActivationworkflowstatusV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface JitactivationactivaterequestV1 + */ +export interface JitactivationactivaterequestV1 { + /** + * Entitlement connection identifier for the activation. + * @type {string} + * @memberof JitactivationactivaterequestV1 + */ + 'connectionId': string; + /** + * Requested activation duration in minutes. + * @type {number} + * @memberof JitactivationactivaterequestV1 + */ + 'activationPeriodMins': number; +} +/** + * + * @export + * @interface JitactivationactivateresponseV1 + */ +export interface JitactivationactivateresponseV1 { + /** + * Workflow or business identifier for this activation. + * @type {string} + * @memberof JitactivationactivateresponseV1 + */ + 'id': string; + /** + * Persistent activation record identifier for this JIT activation. + * @type {string} + * @memberof JitactivationactivateresponseV1 + */ + 'activationId': string; + /** + * Entitlement connection identifier for the activation. + * @type {string} + * @memberof JitactivationactivateresponseV1 + */ + 'connectionId': string; + /** + * Activation duration in minutes for this workflow. + * @type {number} + * @memberof JitactivationactivateresponseV1 + */ + 'activationPeriodMins': number; + /** + * + * @type {ActivationworkflowstatusV1} + * @memberof JitactivationactivateresponseV1 + */ + 'status': ActivationworkflowstatusV1; + /** + * Time when the activation workflow was started (ISO-8601). + * @type {string} + * @memberof JitactivationactivateresponseV1 + */ + 'startTime': string; +} + + +/** + * + * @export + * @interface JitactivationdeactivaterequestV1 + */ +export interface JitactivationdeactivaterequestV1 { + /** + * Entitlement connection identifier for the activation to deactivate. + * @type {string} + * @memberof JitactivationdeactivaterequestV1 + */ + 'connectionId': string; +} +/** + * + * @export + * @interface JitactivationdeactivateresponseV1 + */ +export interface JitactivationdeactivateresponseV1 { + /** + * Workflow or business identifier for this activation. + * @type {string} + * @memberof JitactivationdeactivateresponseV1 + */ + 'id': string; + /** + * Persistent activation record identifier for this JIT activation. + * @type {string} + * @memberof JitactivationdeactivateresponseV1 + */ + 'activationId': string; + /** + * Entitlement connection identifier for the activation. + * @type {string} + * @memberof JitactivationdeactivateresponseV1 + */ + 'connectionId': string; + /** + * + * @type {ActivationworkflowstatusV1} + * @memberof JitactivationdeactivateresponseV1 + */ + 'status': ActivationworkflowstatusV1; + /** + * Time associated with this deactivation request (ISO-8601). + * @type {string} + * @memberof JitactivationdeactivateresponseV1 + */ + 'startTime': string; +} + + +/** + * + * @export + * @interface JitactivationextendrequestV1 + */ +export interface JitactivationextendrequestV1 { + /** + * Entitlement connection identifier for the activation to extend. + * @type {string} + * @memberof JitactivationextendrequestV1 + */ + 'connectionId': string; + /** + * Number of minutes to extend the activation period. + * @type {number} + * @memberof JitactivationextendrequestV1 + */ + 'activationPeriodExtensionMins': number; +} +/** + * + * @export + * @interface JitactivationextendresponseV1 + */ +export interface JitactivationextendresponseV1 { + /** + * Workflow or business identifier for this activation. + * @type {string} + * @memberof JitactivationextendresponseV1 + */ + 'id': string; + /** + * Persistent activation record identifier for this JIT activation. + * @type {string} + * @memberof JitactivationextendresponseV1 + */ + 'activationId': string; + /** + * Entitlement connection identifier for the activation. + * @type {string} + * @memberof JitactivationextendresponseV1 + */ + 'connectionId': string; + /** + * Extension applied to the activation period, in minutes. + * @type {number} + * @memberof JitactivationextendresponseV1 + */ + 'activationPeriodExtensionMins': number; + /** + * + * @type {ActivationworkflowstatusV1} + * @memberof JitactivationextendresponseV1 + */ + 'status': ActivationworkflowstatusV1; + /** + * Time associated with this extend request (ISO-8601). + * @type {string} + * @memberof JitactivationextendresponseV1 + */ + 'startTime': 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface StartActivateWorkflowV1401ResponseV1 + */ +export interface StartActivateWorkflowV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartActivateWorkflowV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface StartActivateWorkflowV1429ResponseV1 + */ +export interface StartActivateWorkflowV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartActivateWorkflowV1429ResponseV1 + */ + 'message'?: any; +} + +/** + * JITActivationsV1Api - axios parameter creator + * @export + */ +export const JITActivationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. + * @summary Start JIT activation workflow + * @param {JitactivationactivaterequestV1} jitactivationactivaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startActivateWorkflowV1: async (jitactivationactivaterequestV1: JitactivationactivaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jitactivationactivaterequestV1' is not null or undefined + assertParamExists('startActivateWorkflowV1', 'jitactivationactivaterequestV1', jitactivationactivaterequestV1) + const localVarPath = `/jit-activations/v1/activate`; + // 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(jitactivationactivaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Deactivate JIT activation workflow + * @param {JitactivationdeactivaterequestV1} jitactivationdeactivaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startDeactivateWorkflowV1: async (jitactivationdeactivaterequestV1: JitactivationdeactivaterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jitactivationdeactivaterequestV1' is not null or undefined + assertParamExists('startDeactivateWorkflowV1', 'jitactivationdeactivaterequestV1', jitactivationdeactivaterequestV1) + const localVarPath = `/jit-activations/v1/deactivate`; + // 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(jitactivationdeactivaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Extend JIT activation workflow + * @param {JitactivationextendrequestV1} jitactivationextendrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startExtendWorkflowV1: async (jitactivationextendrequestV1: JitactivationextendrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jitactivationextendrequestV1' is not null or undefined + assertParamExists('startExtendWorkflowV1', 'jitactivationextendrequestV1', jitactivationextendrequestV1) + const localVarPath = `/jit-activations/v1/extend`; + // 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(jitactivationextendrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * JITActivationsV1Api - functional programming interface + * @export + */ +export const JITActivationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = JITActivationsV1ApiAxiosParamCreator(configuration) + return { + /** + * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. + * @summary Start JIT activation workflow + * @param {JitactivationactivaterequestV1} jitactivationactivaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startActivateWorkflowV1(jitactivationactivaterequestV1: JitactivationactivaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startActivateWorkflowV1(jitactivationactivaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['JITActivationsV1Api.startActivateWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Deactivate JIT activation workflow + * @param {JitactivationdeactivaterequestV1} jitactivationdeactivaterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startDeactivateWorkflowV1(jitactivationdeactivaterequestV1: JitactivationdeactivaterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startDeactivateWorkflowV1(jitactivationdeactivaterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['JITActivationsV1Api.startDeactivateWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Extend JIT activation workflow + * @param {JitactivationextendrequestV1} jitactivationextendrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startExtendWorkflowV1(jitactivationextendrequestV1: JitactivationextendrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startExtendWorkflowV1(jitactivationextendrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['JITActivationsV1Api.startExtendWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * JITActivationsV1Api - factory interface + * @export + */ +export const JITActivationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = JITActivationsV1ApiFp(configuration) + return { + /** + * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. + * @summary Start JIT activation workflow + * @param {JITActivationsV1ApiStartActivateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startActivateWorkflowV1(requestParameters: JITActivationsV1ApiStartActivateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startActivateWorkflowV1(requestParameters.jitactivationactivaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Deactivate JIT activation workflow + * @param {JITActivationsV1ApiStartDeactivateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startDeactivateWorkflowV1(requestParameters: JITActivationsV1ApiStartDeactivateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startDeactivateWorkflowV1(requestParameters.jitactivationdeactivaterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Extend JIT activation workflow + * @param {JITActivationsV1ApiStartExtendWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startExtendWorkflowV1(requestParameters: JITActivationsV1ApiStartExtendWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startExtendWorkflowV1(requestParameters.jitactivationextendrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for startActivateWorkflowV1 operation in JITActivationsV1Api. + * @export + * @interface JITActivationsV1ApiStartActivateWorkflowV1Request + */ +export interface JITActivationsV1ApiStartActivateWorkflowV1Request { + /** + * + * @type {JitactivationactivaterequestV1} + * @memberof JITActivationsV1ApiStartActivateWorkflowV1 + */ + readonly jitactivationactivaterequestV1: JitactivationactivaterequestV1 +} + +/** + * Request parameters for startDeactivateWorkflowV1 operation in JITActivationsV1Api. + * @export + * @interface JITActivationsV1ApiStartDeactivateWorkflowV1Request + */ +export interface JITActivationsV1ApiStartDeactivateWorkflowV1Request { + /** + * + * @type {JitactivationdeactivaterequestV1} + * @memberof JITActivationsV1ApiStartDeactivateWorkflowV1 + */ + readonly jitactivationdeactivaterequestV1: JitactivationdeactivaterequestV1 +} + +/** + * Request parameters for startExtendWorkflowV1 operation in JITActivationsV1Api. + * @export + * @interface JITActivationsV1ApiStartExtendWorkflowV1Request + */ +export interface JITActivationsV1ApiStartExtendWorkflowV1Request { + /** + * + * @type {JitactivationextendrequestV1} + * @memberof JITActivationsV1ApiStartExtendWorkflowV1 + */ + readonly jitactivationextendrequestV1: JitactivationextendrequestV1 +} + +/** + * JITActivationsV1Api - object-oriented interface + * @export + * @class JITActivationsV1Api + * @extends {BaseAPI} + */ +export class JITActivationsV1Api extends BaseAPI { + /** + * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. + * @summary Start JIT activation workflow + * @param {JITActivationsV1ApiStartActivateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof JITActivationsV1Api + */ + public startActivateWorkflowV1(requestParameters: JITActivationsV1ApiStartActivateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return JITActivationsV1ApiFp(this.configuration).startActivateWorkflowV1(requestParameters.jitactivationactivaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Deactivate JIT activation workflow + * @param {JITActivationsV1ApiStartDeactivateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof JITActivationsV1Api + */ + public startDeactivateWorkflowV1(requestParameters: JITActivationsV1ApiStartDeactivateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return JITActivationsV1ApiFp(this.configuration).startDeactivateWorkflowV1(requestParameters.jitactivationdeactivaterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. + * @summary Extend JIT activation workflow + * @param {JITActivationsV1ApiStartExtendWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof JITActivationsV1Api + */ + public startExtendWorkflowV1(requestParameters: JITActivationsV1ApiStartExtendWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return JITActivationsV1ApiFp(this.configuration).startExtendWorkflowV1(requestParameters.jitactivationextendrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/jit_activations/base.ts b/sdk-output/jit_activations/base.ts new file mode 100644 index 00000000..ee5d3482 --- /dev/null +++ b/sdk-output/jit_activations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Activations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/jit_activations/common.ts b/sdk-output/jit_activations/common.ts new file mode 100644 index 00000000..03d020e0 --- /dev/null +++ b/sdk-output/jit_activations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Activations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/jit_activations/configuration.ts b/sdk-output/jit_activations/configuration.ts new file mode 100644 index 00000000..6e758b57 --- /dev/null +++ b/sdk-output/jit_activations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Activations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/jit_activations/git_push.sh b/sdk-output/jit_activations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/jit_activations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/jit_activations/index.ts b/sdk-output/jit_activations/index.ts new file mode 100644 index 00000000..6f631d3b --- /dev/null +++ b/sdk-output/jit_activations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - JIT Activations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/jit_activations/package.json b/sdk-output/jit_activations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/jit_activations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/jit_activations/tsconfig.json b/sdk-output/jit_activations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/jit_activations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/launchers/.gitignore b/sdk-output/launchers/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/launchers/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/launchers/.npmignore b/sdk-output/launchers/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/launchers/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/launchers/.openapi-generator-ignore b/sdk-output/launchers/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/launchers/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/launchers/.openapi-generator/FILES b/sdk-output/launchers/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/launchers/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/launchers/.openapi-generator/VERSION b/sdk-output/launchers/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/launchers/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/launchers/.sdk-partition b/sdk-output/launchers/.sdk-partition new file mode 100644 index 00000000..05896344 --- /dev/null +++ b/sdk-output/launchers/.sdk-partition @@ -0,0 +1 @@ +launchers \ No newline at end of file diff --git a/sdk-output/launchers/README.md b/sdk-output/launchers/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/launchers/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/launchers/api.ts b/sdk-output/launchers/api.ts new file mode 100644 index 00000000..68ca5b8e --- /dev/null +++ b/sdk-output/launchers/api.ts @@ -0,0 +1,931 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Launchers + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetLaunchersV1200ResponseV1 + */ +export interface GetLaunchersV1200ResponseV1 { + /** + * Pagination marker + * @type {string} + * @memberof GetLaunchersV1200ResponseV1 + */ + 'next'?: string; + /** + * + * @type {Array} + * @memberof GetLaunchersV1200ResponseV1 + */ + 'items'?: Array; +} +/** + * + * @export + * @interface GetLaunchersV1401ResponseV1 + */ +export interface GetLaunchersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetLaunchersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetLaunchersV1429ResponseV1 + */ +export interface GetLaunchersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetLaunchersV1429ResponseV1 + */ + 'message'?: any; +} +/** + * Owner of the Launcher + * @export + * @interface LauncherOwnerV1 + */ +export interface LauncherOwnerV1 { + /** + * Owner type + * @type {string} + * @memberof LauncherOwnerV1 + */ + 'type': string; + /** + * Owner ID + * @type {string} + * @memberof LauncherOwnerV1 + */ + 'id': string; +} +/** + * + * @export + * @interface LauncherReferenceV1 + */ +export interface LauncherReferenceV1 { + /** + * Type of Launcher reference + * @type {string} + * @memberof LauncherReferenceV1 + */ + 'type'?: LauncherReferenceV1TypeV1; + /** + * ID of Launcher reference + * @type {string} + * @memberof LauncherReferenceV1 + */ + 'id'?: string; +} + +export const LauncherReferenceV1TypeV1 = { + Workflow: 'WORKFLOW' +} as const; + +export type LauncherReferenceV1TypeV1 = typeof LauncherReferenceV1TypeV1[keyof typeof LauncherReferenceV1TypeV1]; + +/** + * + * @export + * @interface LauncherV1 + */ +export interface LauncherV1 { + /** + * ID of the Launcher + * @type {string} + * @memberof LauncherV1 + */ + 'id': string; + /** + * Date the Launcher was created + * @type {string} + * @memberof LauncherV1 + */ + 'created': string; + /** + * Date the Launcher was last modified + * @type {string} + * @memberof LauncherV1 + */ + 'modified': string; + /** + * + * @type {LauncherOwnerV1} + * @memberof LauncherV1 + */ + 'owner': LauncherOwnerV1; + /** + * Name of the Launcher, limited to 255 characters + * @type {string} + * @memberof LauncherV1 + */ + 'name': string; + /** + * Description of the Launcher, limited to 2000 characters + * @type {string} + * @memberof LauncherV1 + */ + 'description': string; + /** + * Launcher type + * @type {string} + * @memberof LauncherV1 + */ + 'type': LauncherV1TypeV1; + /** + * State of the Launcher + * @type {boolean} + * @memberof LauncherV1 + */ + 'disabled': boolean; + /** + * + * @type {LauncherReferenceV1} + * @memberof LauncherV1 + */ + 'reference'?: LauncherReferenceV1; + /** + * JSON configuration associated with this Launcher, restricted to a max size of 4KB + * @type {string} + * @memberof LauncherV1 + */ + 'config': string; +} + +export const LauncherV1TypeV1 = { + InteractiveProcess: 'INTERACTIVE_PROCESS' +} as const; + +export type LauncherV1TypeV1 = typeof LauncherV1TypeV1[keyof typeof LauncherV1TypeV1]; + +/** + * + * @export + * @interface LauncherrequestReferenceV1 + */ +export interface LauncherrequestReferenceV1 { + /** + * Type of Launcher reference + * @type {string} + * @memberof LauncherrequestReferenceV1 + */ + 'type': LauncherrequestReferenceV1TypeV1; + /** + * ID of Launcher reference + * @type {string} + * @memberof LauncherrequestReferenceV1 + */ + 'id': string; +} + +export const LauncherrequestReferenceV1TypeV1 = { + Workflow: 'WORKFLOW' +} as const; + +export type LauncherrequestReferenceV1TypeV1 = typeof LauncherrequestReferenceV1TypeV1[keyof typeof LauncherrequestReferenceV1TypeV1]; + +/** + * + * @export + * @interface LauncherrequestV1 + */ +export interface LauncherrequestV1 { + /** + * Name of the Launcher, limited to 255 characters + * @type {string} + * @memberof LauncherrequestV1 + */ + 'name': string; + /** + * Description of the Launcher, limited to 2000 characters + * @type {string} + * @memberof LauncherrequestV1 + */ + 'description': string; + /** + * Launcher type + * @type {string} + * @memberof LauncherrequestV1 + */ + 'type': LauncherrequestV1TypeV1; + /** + * State of the Launcher + * @type {boolean} + * @memberof LauncherrequestV1 + */ + 'disabled': boolean; + /** + * + * @type {LauncherrequestReferenceV1} + * @memberof LauncherrequestV1 + */ + 'reference'?: LauncherrequestReferenceV1; + /** + * JSON configuration associated with this Launcher, restricted to a max size of 4KB + * @type {string} + * @memberof LauncherrequestV1 + */ + 'config': string; +} + +export const LauncherrequestV1TypeV1 = { + InteractiveProcess: 'INTERACTIVE_PROCESS' +} as const; + +export type LauncherrequestV1TypeV1 = typeof LauncherrequestV1TypeV1[keyof typeof LauncherrequestV1TypeV1]; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface StartLauncherV1200ResponseV1 + */ +export interface StartLauncherV1200ResponseV1 { + /** + * ID of the Interactive Process that was launched + * @type {string} + * @memberof StartLauncherV1200ResponseV1 + */ + 'interactiveProcessId': string; +} + +/** + * LaunchersV1Api - axios parameter creator + * @export + */ +export const LaunchersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a Launcher with given information + * @summary Create launcher + * @param {LauncherrequestV1} launcherrequestV1 Payload to create a Launcher + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createLauncherV1: async (launcherrequestV1: LauncherrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'launcherrequestV1' is not null or undefined + assertParamExists('createLauncherV1', 'launcherrequestV1', launcherrequestV1) + const localVarPath = `/launchers/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(launcherrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete the given Launcher ID + * @summary Delete launcher + * @param {string} launcherID ID of the Launcher to be deleted + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteLauncherV1: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'launcherID' is not null or undefined + assertParamExists('deleteLauncherV1', 'launcherID', launcherID) + const localVarPath = `/launchers/v1/{launcherID}` + .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); + // 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 details for the given Launcher ID + * @summary Get launcher by id + * @param {string} launcherID ID of the Launcher to be retrieved + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLauncherV1: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'launcherID' is not null or undefined + assertParamExists('getLauncherV1', 'launcherID', launcherID) + const localVarPath = `/launchers/v1/{launcherID}` + .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); + // 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, + }; + }, + /** + * Return a list of Launchers for the authenticated tenant + * @summary List all launchers for tenant + * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* + * @param {string} [next] Pagination marker + * @param {number} [limit] Number of Launchers to return + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLaunchersV1: async (filters?: string, next?: string, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/launchers/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (next !== undefined) { + localVarQueryParameter['next'] = next; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replace the given Launcher ID with given payload + * @summary Replace launcher + * @param {string} launcherID ID of the Launcher to be replaced + * @param {LauncherrequestV1} launcherrequestV1 Payload to replace Launcher + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putLauncherV1: async (launcherID: string, launcherrequestV1: LauncherrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'launcherID' is not null or undefined + assertParamExists('putLauncherV1', 'launcherID', launcherID) + // verify required parameter 'launcherrequestV1' is not null or undefined + assertParamExists('putLauncherV1', 'launcherrequestV1', launcherrequestV1) + const localVarPath = `/launchers/v1/{launcherID}` + .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); + // 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: 'PUT', ...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(launcherrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Launch the given Launcher ID + * @summary Launch a launcher + * @param {string} launcherID ID of the Launcher to be launched + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startLauncherV1: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'launcherID' is not null or undefined + assertParamExists('startLauncherV1', 'launcherID', launcherID) + const localVarPath = `/launchers/v1/{launcherID}/launch` + .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * LaunchersV1Api - functional programming interface + * @export + */ +export const LaunchersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = LaunchersV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a Launcher with given information + * @summary Create launcher + * @param {LauncherrequestV1} launcherrequestV1 Payload to create a Launcher + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createLauncherV1(launcherrequestV1: LauncherrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createLauncherV1(launcherrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.createLauncherV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete the given Launcher ID + * @summary Delete launcher + * @param {string} launcherID ID of the Launcher to be deleted + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLauncherV1(launcherID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.deleteLauncherV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get details for the given Launcher ID + * @summary Get launcher by id + * @param {string} launcherID ID of the Launcher to be retrieved + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLauncherV1(launcherID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.getLauncherV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Return a list of Launchers for the authenticated tenant + * @summary List all launchers for tenant + * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* + * @param {string} [next] Pagination marker + * @param {number} [limit] Number of Launchers to return + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getLaunchersV1(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLaunchersV1(filters, next, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.getLaunchersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replace the given Launcher ID with given payload + * @summary Replace launcher + * @param {string} launcherID ID of the Launcher to be replaced + * @param {LauncherrequestV1} launcherrequestV1 Payload to replace Launcher + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putLauncherV1(launcherID: string, launcherrequestV1: LauncherrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putLauncherV1(launcherID, launcherrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.putLauncherV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Launch the given Launcher ID + * @summary Launch a launcher + * @param {string} launcherID ID of the Launcher to be launched + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startLauncherV1(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startLauncherV1(launcherID, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LaunchersV1Api.startLauncherV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * LaunchersV1Api - factory interface + * @export + */ +export const LaunchersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = LaunchersV1ApiFp(configuration) + return { + /** + * Create a Launcher with given information + * @summary Create launcher + * @param {LaunchersV1ApiCreateLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createLauncherV1(requestParameters: LaunchersV1ApiCreateLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createLauncherV1(requestParameters.launcherrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete the given Launcher ID + * @summary Delete launcher + * @param {LaunchersV1ApiDeleteLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteLauncherV1(requestParameters: LaunchersV1ApiDeleteLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get details for the given Launcher ID + * @summary Get launcher by id + * @param {LaunchersV1ApiGetLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLauncherV1(requestParameters: LaunchersV1ApiGetLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Return a list of Launchers for the authenticated tenant + * @summary List all launchers for tenant + * @param {LaunchersV1ApiGetLaunchersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLaunchersV1(requestParameters: LaunchersV1ApiGetLaunchersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getLaunchersV1(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replace the given Launcher ID with given payload + * @summary Replace launcher + * @param {LaunchersV1ApiPutLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putLauncherV1(requestParameters: LaunchersV1ApiPutLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putLauncherV1(requestParameters.launcherID, requestParameters.launcherrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Launch the given Launcher ID + * @summary Launch a launcher + * @param {LaunchersV1ApiStartLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startLauncherV1(requestParameters: LaunchersV1ApiStartLauncherV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createLauncherV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiCreateLauncherV1Request + */ +export interface LaunchersV1ApiCreateLauncherV1Request { + /** + * Payload to create a Launcher + * @type {LauncherrequestV1} + * @memberof LaunchersV1ApiCreateLauncherV1 + */ + readonly launcherrequestV1: LauncherrequestV1 +} + +/** + * Request parameters for deleteLauncherV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiDeleteLauncherV1Request + */ +export interface LaunchersV1ApiDeleteLauncherV1Request { + /** + * ID of the Launcher to be deleted + * @type {string} + * @memberof LaunchersV1ApiDeleteLauncherV1 + */ + readonly launcherID: string +} + +/** + * Request parameters for getLauncherV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiGetLauncherV1Request + */ +export interface LaunchersV1ApiGetLauncherV1Request { + /** + * ID of the Launcher to be retrieved + * @type {string} + * @memberof LaunchersV1ApiGetLauncherV1 + */ + readonly launcherID: string +} + +/** + * Request parameters for getLaunchersV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiGetLaunchersV1Request + */ +export interface LaunchersV1ApiGetLaunchersV1Request { + /** + * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* + * @type {string} + * @memberof LaunchersV1ApiGetLaunchersV1 + */ + readonly filters?: string + + /** + * Pagination marker + * @type {string} + * @memberof LaunchersV1ApiGetLaunchersV1 + */ + readonly next?: string + + /** + * Number of Launchers to return + * @type {number} + * @memberof LaunchersV1ApiGetLaunchersV1 + */ + readonly limit?: number +} + +/** + * Request parameters for putLauncherV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiPutLauncherV1Request + */ +export interface LaunchersV1ApiPutLauncherV1Request { + /** + * ID of the Launcher to be replaced + * @type {string} + * @memberof LaunchersV1ApiPutLauncherV1 + */ + readonly launcherID: string + + /** + * Payload to replace Launcher + * @type {LauncherrequestV1} + * @memberof LaunchersV1ApiPutLauncherV1 + */ + readonly launcherrequestV1: LauncherrequestV1 +} + +/** + * Request parameters for startLauncherV1 operation in LaunchersV1Api. + * @export + * @interface LaunchersV1ApiStartLauncherV1Request + */ +export interface LaunchersV1ApiStartLauncherV1Request { + /** + * ID of the Launcher to be launched + * @type {string} + * @memberof LaunchersV1ApiStartLauncherV1 + */ + readonly launcherID: string +} + +/** + * LaunchersV1Api - object-oriented interface + * @export + * @class LaunchersV1Api + * @extends {BaseAPI} + */ +export class LaunchersV1Api extends BaseAPI { + /** + * Create a Launcher with given information + * @summary Create launcher + * @param {LaunchersV1ApiCreateLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public createLauncherV1(requestParameters: LaunchersV1ApiCreateLauncherV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).createLauncherV1(requestParameters.launcherrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete the given Launcher ID + * @summary Delete launcher + * @param {LaunchersV1ApiDeleteLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public deleteLauncherV1(requestParameters: LaunchersV1ApiDeleteLauncherV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).deleteLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get details for the given Launcher ID + * @summary Get launcher by id + * @param {LaunchersV1ApiGetLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public getLauncherV1(requestParameters: LaunchersV1ApiGetLauncherV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).getLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Return a list of Launchers for the authenticated tenant + * @summary List all launchers for tenant + * @param {LaunchersV1ApiGetLaunchersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public getLaunchersV1(requestParameters: LaunchersV1ApiGetLaunchersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).getLaunchersV1(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replace the given Launcher ID with given payload + * @summary Replace launcher + * @param {LaunchersV1ApiPutLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public putLauncherV1(requestParameters: LaunchersV1ApiPutLauncherV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).putLauncherV1(requestParameters.launcherID, requestParameters.launcherrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Launch the given Launcher ID + * @summary Launch a launcher + * @param {LaunchersV1ApiStartLauncherV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LaunchersV1Api + */ + public startLauncherV1(requestParameters: LaunchersV1ApiStartLauncherV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LaunchersV1ApiFp(this.configuration).startLauncherV1(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/launchers/base.ts b/sdk-output/launchers/base.ts new file mode 100644 index 00000000..c689d81f --- /dev/null +++ b/sdk-output/launchers/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Launchers + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/launchers/common.ts b/sdk-output/launchers/common.ts new file mode 100644 index 00000000..6088b7ed --- /dev/null +++ b/sdk-output/launchers/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Launchers + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/launchers/configuration.ts b/sdk-output/launchers/configuration.ts new file mode 100644 index 00000000..f26450f5 --- /dev/null +++ b/sdk-output/launchers/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Launchers + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/launchers/git_push.sh b/sdk-output/launchers/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/launchers/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/launchers/index.ts b/sdk-output/launchers/index.ts new file mode 100644 index 00000000..83b0ed23 --- /dev/null +++ b/sdk-output/launchers/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Launchers + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/launchers/package.json b/sdk-output/launchers/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/launchers/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/launchers/tsconfig.json b/sdk-output/launchers/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/launchers/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/lifecycle_states/.gitignore b/sdk-output/lifecycle_states/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/lifecycle_states/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/lifecycle_states/.npmignore b/sdk-output/lifecycle_states/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/lifecycle_states/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/lifecycle_states/.openapi-generator-ignore b/sdk-output/lifecycle_states/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/lifecycle_states/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/lifecycle_states/.openapi-generator/FILES b/sdk-output/lifecycle_states/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/lifecycle_states/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/lifecycle_states/.openapi-generator/VERSION b/sdk-output/lifecycle_states/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/lifecycle_states/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/lifecycle_states/.sdk-partition b/sdk-output/lifecycle_states/.sdk-partition new file mode 100644 index 00000000..7e615d95 --- /dev/null +++ b/sdk-output/lifecycle_states/.sdk-partition @@ -0,0 +1 @@ +lifecycle-states \ No newline at end of file diff --git a/sdk-output/lifecycle_states/README.md b/sdk-output/lifecycle_states/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/lifecycle_states/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/lifecycle_states/api.ts b/sdk-output/lifecycle_states/api.ts new file mode 100644 index 00000000..bf39ed34 --- /dev/null +++ b/sdk-output/lifecycle_states/api.ts @@ -0,0 +1,1116 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Lifecycle States + * 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'; + +/** + * This is used for access configuration for a lifecycle state + * @export + * @interface AccessactionconfigurationV1 + */ +export interface AccessactionconfigurationV1 { + /** + * If true, then all accesses are marked for removal. + * @type {boolean} + * @memberof AccessactionconfigurationV1 + */ + 'removeAllAccessEnabled'?: boolean; +} +/** + * Object for specifying Actions to be performed on a specified list of sources\' account. + * @export + * @interface AccountactionV1 + */ +export interface AccountactionV1 { + /** + * Describes if action will be enable, disable or delete. + * @type {string} + * @memberof AccountactionV1 + */ + 'action'?: AccountactionV1ActionV1; + /** + * A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. + * @type {Set} + * @memberof AccountactionV1 + */ + 'sourceIds'?: Set | null; + /** + * A list of source IDs to exclude from the action. Cannot be used together with sourceIds. + * @type {Set} + * @memberof AccountactionV1 + */ + 'excludeSourceIds'?: Set | null; + /** + * If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. + * @type {boolean} + * @memberof AccountactionV1 + */ + 'allSources'?: boolean; +} + +export const AccountactionV1ActionV1 = { + Enable: 'ENABLE', + Disable: 'DISABLE', + Delete: 'DELETE' +} as const; + +export type AccountactionV1ActionV1 = typeof AccountactionV1ActionV1[keyof typeof AccountactionV1ActionV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * This is used for representing email configuration for a lifecycle state + * @export + * @interface EmailnotificationoptionV1 + */ +export interface EmailnotificationoptionV1 { + /** + * If true, then the manager is notified of the lifecycle state change. + * @type {boolean} + * @memberof EmailnotificationoptionV1 + */ + 'notifyManagers'?: boolean; + /** + * If true, then all the admins are notified of the lifecycle state change. + * @type {boolean} + * @memberof EmailnotificationoptionV1 + */ + 'notifyAllAdmins'?: boolean; + /** + * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. + * @type {boolean} + * @memberof EmailnotificationoptionV1 + */ + 'notifySpecificUsers'?: boolean; + /** + * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. + * @type {Array} + * @memberof EmailnotificationoptionV1 + */ + 'emailAddressList'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface LifecyclestateV1 + */ +export interface LifecyclestateV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof LifecyclestateV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof LifecyclestateV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof LifecyclestateV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof LifecyclestateV1 + */ + 'modified'?: string; + /** + * Indicates whether the lifecycle state is enabled or disabled. + * @type {boolean} + * @memberof LifecyclestateV1 + */ + 'enabled'?: boolean; + /** + * The lifecycle state\'s technical name. This is for internal use. + * @type {string} + * @memberof LifecyclestateV1 + */ + 'technicalName': string; + /** + * Lifecycle state\'s description. + * @type {string} + * @memberof LifecyclestateV1 + */ + 'description'?: string | null; + /** + * Number of identities that have the lifecycle state. + * @type {number} + * @memberof LifecyclestateV1 + */ + 'identityCount'?: number; + /** + * + * @type {EmailnotificationoptionV1} + * @memberof LifecyclestateV1 + */ + 'emailNotificationOption'?: EmailnotificationoptionV1; + /** + * + * @type {Array} + * @memberof LifecyclestateV1 + */ + 'accountActions'?: Array; + /** + * List of unique access-profile IDs that are associated with the lifecycle state. + * @type {Set} + * @memberof LifecyclestateV1 + */ + 'accessProfileIds'?: Set; + /** + * The lifecycle state\'s associated identity state. This field is generally \'null\'. + * @type {string} + * @memberof LifecyclestateV1 + */ + 'identityState'?: LifecyclestateV1IdentityStateV1 | null; + /** + * + * @type {AccessactionconfigurationV1} + * @memberof LifecyclestateV1 + */ + 'accessActionConfiguration'?: AccessactionconfigurationV1; + /** + * Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10. + * @type {number} + * @memberof LifecyclestateV1 + */ + 'priority'?: number | null; +} + +export const LifecyclestateV1IdentityStateV1 = { + Active: 'ACTIVE', + InactiveShortTerm: 'INACTIVE_SHORT_TERM', + InactiveLongTerm: 'INACTIVE_LONG_TERM' +} as const; + +export type LifecyclestateV1IdentityStateV1 = typeof LifecyclestateV1IdentityStateV1[keyof typeof LifecyclestateV1IdentityStateV1]; + +/** + * Deleted lifecycle state. + * @export + * @interface LifecyclestatedeletedV1 + */ +export interface LifecyclestatedeletedV1 { + /** + * Deleted lifecycle state\'s DTO type. + * @type {string} + * @memberof LifecyclestatedeletedV1 + */ + 'type'?: LifecyclestatedeletedV1TypeV1; + /** + * Deleted lifecycle state ID. + * @type {string} + * @memberof LifecyclestatedeletedV1 + */ + 'id'?: string; + /** + * Deleted lifecycle state\'s display name. + * @type {string} + * @memberof LifecyclestatedeletedV1 + */ + 'name'?: string; +} + +export const LifecyclestatedeletedV1TypeV1 = { + LifecycleState: 'LIFECYCLE_STATE', + TaskResult: 'TASK_RESULT' +} as const; + +export type LifecyclestatedeletedV1TypeV1 = typeof LifecyclestatedeletedV1TypeV1[keyof typeof LifecyclestatedeletedV1TypeV1]; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SetLifecycleStateV1200ResponseV1 + */ +export interface SetLifecycleStateV1200ResponseV1 { + /** + * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. + * @type {string} + * @memberof SetLifecycleStateV1200ResponseV1 + */ + 'accountActivityId'?: string; +} +/** + * + * @export + * @interface SetLifecycleStateV1401ResponseV1 + */ +export interface SetLifecycleStateV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SetLifecycleStateV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface SetLifecycleStateV1429ResponseV1 + */ +export interface SetLifecycleStateV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SetLifecycleStateV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface SetLifecycleStateV1RequestV1 + */ +export interface SetLifecycleStateV1RequestV1 { + /** + * ID of the lifecycle state to set. + * @type {string} + * @memberof SetLifecycleStateV1RequestV1 + */ + 'lifecycleStateId'?: string; +} + +/** + * LifecycleStatesV1Api - axios parameter creator + * @export + */ +export const LifecycleStatesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this endpoint to create a lifecycle state. + * @summary Create lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {LifecyclestateV1} lifecyclestateV1 Lifecycle state to be created. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createLifecycleStateV1: async (identityProfileId: string, lifecyclestateV1: LifecyclestateV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('createLifecycleStateV1', 'identityProfileId', identityProfileId) + // verify required parameter 'lifecyclestateV1' is not null or undefined + assertParamExists('createLifecycleStateV1', 'lifecyclestateV1', lifecyclestateV1) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/lifecycle-states` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // 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(lifecyclestateV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to delete the lifecycle state by its ID. + * @summary Delete lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteLifecycleStateV1: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('deleteLifecycleStateV1', 'identityProfileId', identityProfileId) + // verify required parameter 'lifecycleStateId' is not null or undefined + assertParamExists('deleteLifecycleStateV1', 'lifecycleStateId', lifecycleStateId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) + .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); + // 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, + }; + }, + /** + * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + * @summary Get lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLifecycleStateV1: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('getLifecycleStateV1', 'identityProfileId', identityProfileId) + // verify required parameter 'lifecycleStateId' is not null or undefined + assertParamExists('getLifecycleStateV1', 'lifecycleStateId', lifecycleStateId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) + .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); + // 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, + }; + }, + /** + * Use this endpoint to list all lifecycle states by their associated identity profiles. + * @summary Lists lifecyclestates + * @param {string} identityProfileId Identity profile ID. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **name, priority, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLifecycleStatesV1: async (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('getLifecycleStatesV1', 'identityProfileId', identityProfileId) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/lifecycle-states` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. + * @summary Set lifecycle state + * @param {string} identityId ID of the identity to update. + * @param {SetLifecycleStateV1RequestV1} setLifecycleStateV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setLifecycleStateV1: async (identityId: string, setLifecycleStateV1RequestV1: SetLifecycleStateV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('setLifecycleStateV1', 'identityId', identityId) + // verify required parameter 'setLifecycleStateV1RequestV1' is not null or undefined + assertParamExists('setLifecycleStateV1', 'setLifecycleStateV1RequestV1', setLifecycleStateV1RequestV1) + const localVarPath = `/identities/v1/{identity-id}/set-lifecycle-state` + .replace(`{${"identity-id"}}`, encodeURIComponent(String(identityId))); + // 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(setLifecycleStateV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {Array} jsonpatchoperationV1 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateLifecycleStatesV1: async (identityProfileId: string, lifecycleStateId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityProfileId' is not null or undefined + assertParamExists('updateLifecycleStatesV1', 'identityProfileId', identityProfileId) + // verify required parameter 'lifecycleStateId' is not null or undefined + assertParamExists('updateLifecycleStatesV1', 'lifecycleStateId', lifecycleStateId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateLifecycleStatesV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` + .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) + .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * LifecycleStatesV1Api - functional programming interface + * @export + */ +export const LifecycleStatesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = LifecycleStatesV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this endpoint to create a lifecycle state. + * @summary Create lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {LifecyclestateV1} lifecyclestateV1 Lifecycle state to be created. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createLifecycleStateV1(identityProfileId: string, lifecyclestateV1: LifecyclestateV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createLifecycleStateV1(identityProfileId, lifecyclestateV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.createLifecycleStateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to delete the lifecycle state by its ID. + * @summary Delete lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteLifecycleStateV1(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLifecycleStateV1(identityProfileId, lifecycleStateId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.deleteLifecycleStateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + * @summary Get lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getLifecycleStateV1(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStateV1(identityProfileId, lifecycleStateId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.getLifecycleStateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to list all lifecycle states by their associated identity profiles. + * @summary Lists lifecyclestates + * @param {string} identityProfileId Identity profile ID. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **name, priority, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getLifecycleStatesV1(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStatesV1(identityProfileId, limit, offset, count, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.getLifecycleStatesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. + * @summary Set lifecycle state + * @param {string} identityId ID of the identity to update. + * @param {SetLifecycleStateV1RequestV1} setLifecycleStateV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setLifecycleStateV1(identityId: string, setLifecycleStateV1RequestV1: SetLifecycleStateV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setLifecycleStateV1(identityId, setLifecycleStateV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.setLifecycleStateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update lifecycle state + * @param {string} identityProfileId Identity profile ID. + * @param {string} lifecycleStateId Lifecycle state ID. + * @param {Array} jsonpatchoperationV1 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateLifecycleStatesV1(identityProfileId: string, lifecycleStateId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStatesV1(identityProfileId, lifecycleStateId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV1Api.updateLifecycleStatesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * LifecycleStatesV1Api - factory interface + * @export + */ +export const LifecycleStatesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = LifecycleStatesV1ApiFp(configuration) + return { + /** + * Use this endpoint to create a lifecycle state. + * @summary Create lifecycle state + * @param {LifecycleStatesV1ApiCreateLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createLifecycleStateV1(requestParameters: LifecycleStatesV1ApiCreateLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecyclestateV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to delete the lifecycle state by its ID. + * @summary Delete lifecycle state + * @param {LifecycleStatesV1ApiDeleteLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteLifecycleStateV1(requestParameters: LifecycleStatesV1ApiDeleteLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + * @summary Get lifecycle state + * @param {LifecycleStatesV1ApiGetLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLifecycleStateV1(requestParameters: LifecycleStatesV1ApiGetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to list all lifecycle states by their associated identity profiles. + * @summary Lists lifecyclestates + * @param {LifecycleStatesV1ApiGetLifecycleStatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getLifecycleStatesV1(requestParameters: LifecycleStatesV1ApiGetLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getLifecycleStatesV1(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. + * @summary Set lifecycle state + * @param {LifecycleStatesV1ApiSetLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setLifecycleStateV1(requestParameters: LifecycleStatesV1ApiSetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setLifecycleStateV1(requestParameters.identityId, requestParameters.setLifecycleStateV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update lifecycle state + * @param {LifecycleStatesV1ApiUpdateLifecycleStatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateLifecycleStatesV1(requestParameters: LifecycleStatesV1ApiUpdateLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateLifecycleStatesV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createLifecycleStateV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiCreateLifecycleStateV1Request + */ +export interface LifecycleStatesV1ApiCreateLifecycleStateV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof LifecycleStatesV1ApiCreateLifecycleStateV1 + */ + readonly identityProfileId: string + + /** + * Lifecycle state to be created. + * @type {LifecyclestateV1} + * @memberof LifecycleStatesV1ApiCreateLifecycleStateV1 + */ + readonly lifecyclestateV1: LifecyclestateV1 +} + +/** + * Request parameters for deleteLifecycleStateV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiDeleteLifecycleStateV1Request + */ +export interface LifecycleStatesV1ApiDeleteLifecycleStateV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof LifecycleStatesV1ApiDeleteLifecycleStateV1 + */ + readonly identityProfileId: string + + /** + * Lifecycle state ID. + * @type {string} + * @memberof LifecycleStatesV1ApiDeleteLifecycleStateV1 + */ + readonly lifecycleStateId: string +} + +/** + * Request parameters for getLifecycleStateV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiGetLifecycleStateV1Request + */ +export interface LifecycleStatesV1ApiGetLifecycleStateV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof LifecycleStatesV1ApiGetLifecycleStateV1 + */ + readonly identityProfileId: string + + /** + * Lifecycle state ID. + * @type {string} + * @memberof LifecycleStatesV1ApiGetLifecycleStateV1 + */ + readonly lifecycleStateId: string +} + +/** + * Request parameters for getLifecycleStatesV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiGetLifecycleStatesV1Request + */ +export interface LifecycleStatesV1ApiGetLifecycleStatesV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof LifecycleStatesV1ApiGetLifecycleStatesV1 + */ + readonly identityProfileId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof LifecycleStatesV1ApiGetLifecycleStatesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof LifecycleStatesV1ApiGetLifecycleStatesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof LifecycleStatesV1ApiGetLifecycleStatesV1 + */ + readonly count?: boolean + + /** + * 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: **name, priority, created, modified** + * @type {string} + * @memberof LifecycleStatesV1ApiGetLifecycleStatesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for setLifecycleStateV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiSetLifecycleStateV1Request + */ +export interface LifecycleStatesV1ApiSetLifecycleStateV1Request { + /** + * ID of the identity to update. + * @type {string} + * @memberof LifecycleStatesV1ApiSetLifecycleStateV1 + */ + readonly identityId: string + + /** + * + * @type {SetLifecycleStateV1RequestV1} + * @memberof LifecycleStatesV1ApiSetLifecycleStateV1 + */ + readonly setLifecycleStateV1RequestV1: SetLifecycleStateV1RequestV1 +} + +/** + * Request parameters for updateLifecycleStatesV1 operation in LifecycleStatesV1Api. + * @export + * @interface LifecycleStatesV1ApiUpdateLifecycleStatesV1Request + */ +export interface LifecycleStatesV1ApiUpdateLifecycleStatesV1Request { + /** + * Identity profile ID. + * @type {string} + * @memberof LifecycleStatesV1ApiUpdateLifecycleStatesV1 + */ + readonly identityProfileId: string + + /** + * Lifecycle state ID. + * @type {string} + * @memberof LifecycleStatesV1ApiUpdateLifecycleStatesV1 + */ + readonly lifecycleStateId: string + + /** + * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority + * @type {Array} + * @memberof LifecycleStatesV1ApiUpdateLifecycleStatesV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * LifecycleStatesV1Api - object-oriented interface + * @export + * @class LifecycleStatesV1Api + * @extends {BaseAPI} + */ +export class LifecycleStatesV1Api extends BaseAPI { + /** + * Use this endpoint to create a lifecycle state. + * @summary Create lifecycle state + * @param {LifecycleStatesV1ApiCreateLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public createLifecycleStateV1(requestParameters: LifecycleStatesV1ApiCreateLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).createLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecyclestateV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to delete the lifecycle state by its ID. + * @summary Delete lifecycle state + * @param {LifecycleStatesV1ApiDeleteLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public deleteLifecycleStateV1(requestParameters: LifecycleStatesV1ApiDeleteLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).deleteLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + * @summary Get lifecycle state + * @param {LifecycleStatesV1ApiGetLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public getLifecycleStateV1(requestParameters: LifecycleStatesV1ApiGetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).getLifecycleStateV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to list all lifecycle states by their associated identity profiles. + * @summary Lists lifecyclestates + * @param {LifecycleStatesV1ApiGetLifecycleStatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public getLifecycleStatesV1(requestParameters: LifecycleStatesV1ApiGetLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).getLifecycleStatesV1(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. + * @summary Set lifecycle state + * @param {LifecycleStatesV1ApiSetLifecycleStateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public setLifecycleStateV1(requestParameters: LifecycleStatesV1ApiSetLifecycleStateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).setLifecycleStateV1(requestParameters.identityId, requestParameters.setLifecycleStateV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @summary Update lifecycle state + * @param {LifecycleStatesV1ApiUpdateLifecycleStatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof LifecycleStatesV1Api + */ + public updateLifecycleStatesV1(requestParameters: LifecycleStatesV1ApiUpdateLifecycleStatesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return LifecycleStatesV1ApiFp(this.configuration).updateLifecycleStatesV1(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/lifecycle_states/base.ts b/sdk-output/lifecycle_states/base.ts new file mode 100644 index 00000000..6f47cc13 --- /dev/null +++ b/sdk-output/lifecycle_states/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Lifecycle States + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/lifecycle_states/common.ts b/sdk-output/lifecycle_states/common.ts new file mode 100644 index 00000000..11728621 --- /dev/null +++ b/sdk-output/lifecycle_states/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Lifecycle States + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/lifecycle_states/configuration.ts b/sdk-output/lifecycle_states/configuration.ts new file mode 100644 index 00000000..bf1938b4 --- /dev/null +++ b/sdk-output/lifecycle_states/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Lifecycle States + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/lifecycle_states/git_push.sh b/sdk-output/lifecycle_states/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/lifecycle_states/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/lifecycle_states/index.ts b/sdk-output/lifecycle_states/index.ts new file mode 100644 index 00000000..5a80e031 --- /dev/null +++ b/sdk-output/lifecycle_states/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Lifecycle States + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/lifecycle_states/package.json b/sdk-output/lifecycle_states/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/lifecycle_states/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/lifecycle_states/tsconfig.json b/sdk-output/lifecycle_states/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/lifecycle_states/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_account_classify/.gitignore b/sdk-output/machine_account_classify/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_account_classify/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_account_classify/.npmignore b/sdk-output/machine_account_classify/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_account_classify/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_account_classify/.openapi-generator-ignore b/sdk-output/machine_account_classify/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_account_classify/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_account_classify/.openapi-generator/FILES b/sdk-output/machine_account_classify/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_account_classify/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_account_classify/.openapi-generator/VERSION b/sdk-output/machine_account_classify/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_account_classify/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_account_classify/.sdk-partition b/sdk-output/machine_account_classify/.sdk-partition new file mode 100644 index 00000000..b8d0e388 --- /dev/null +++ b/sdk-output/machine_account_classify/.sdk-partition @@ -0,0 +1 @@ +machine-account-classify \ No newline at end of file diff --git a/sdk-output/machine_account_classify/README.md b/sdk-output/machine_account_classify/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_classify/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_classify/api.ts b/sdk-output/machine_account_classify/api.ts new file mode 100644 index 00000000..2050cd7a --- /dev/null +++ b/sdk-output/machine_account_classify/api.ts @@ -0,0 +1,282 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Classify + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SendClassifyMachineAccountV1200ResponseV1 + */ +export interface SendClassifyMachineAccountV1200ResponseV1 { + /** + * Indicates if account is classified as machine + * @type {boolean} + * @memberof SendClassifyMachineAccountV1200ResponseV1 + */ + 'isMachine'?: boolean; +} +/** + * + * @export + * @interface SendClassifyMachineAccountV1401ResponseV1 + */ +export interface SendClassifyMachineAccountV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SendClassifyMachineAccountV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface SendClassifyMachineAccountV1429ResponseV1 + */ +export interface SendClassifyMachineAccountV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SendClassifyMachineAccountV1429ResponseV1 + */ + 'message'?: any; +} + +/** + * MachineAccountClassifyV1Api - axios parameter creator + * @export + */ +export const MachineAccountClassifyV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify single machine account + * @param {string} id Account ID. + * @param {SendClassifyMachineAccountV1ClassificationModeV1} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendClassifyMachineAccountV1: async (id: string, classificationMode?: SendClassifyMachineAccountV1ClassificationModeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('sendClassifyMachineAccountV1', 'id', id) + const localVarPath = `/accounts/v1/{id}/classify` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (classificationMode !== undefined) { + localVarQueryParameter['classificationMode'] = classificationMode; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineAccountClassifyV1Api - functional programming interface + * @export + */ +export const MachineAccountClassifyV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineAccountClassifyV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify single machine account + * @param {string} id Account ID. + * @param {SendClassifyMachineAccountV1ClassificationModeV1} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendClassifyMachineAccountV1(id: string, classificationMode?: SendClassifyMachineAccountV1ClassificationModeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccountV1(id, classificationMode, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountClassifyV1Api.sendClassifyMachineAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineAccountClassifyV1Api - factory interface + * @export + */ +export const MachineAccountClassifyV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineAccountClassifyV1ApiFp(configuration) + return { + /** + * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify single machine account + * @param {MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendClassifyMachineAccountV1(requestParameters: MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendClassifyMachineAccountV1(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for sendClassifyMachineAccountV1 operation in MachineAccountClassifyV1Api. + * @export + * @interface MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request + */ +export interface MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request { + /** + * Account ID. + * @type {string} + * @memberof MachineAccountClassifyV1ApiSendClassifyMachineAccountV1 + */ + readonly id: string + + /** + * Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. + * @type {'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman'} + * @memberof MachineAccountClassifyV1ApiSendClassifyMachineAccountV1 + */ + readonly classificationMode?: SendClassifyMachineAccountV1ClassificationModeV1 +} + +/** + * MachineAccountClassifyV1Api - object-oriented interface + * @export + * @class MachineAccountClassifyV1Api + * @extends {BaseAPI} + */ +export class MachineAccountClassifyV1Api extends BaseAPI { + /** + * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Classify single machine account + * @param {MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountClassifyV1Api + */ + public sendClassifyMachineAccountV1(requestParameters: MachineAccountClassifyV1ApiSendClassifyMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountClassifyV1ApiFp(this.configuration).sendClassifyMachineAccountV1(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const SendClassifyMachineAccountV1ClassificationModeV1 = { + Default: 'default', + IgnoreManual: 'ignoreManual', + ForceMachine: 'forceMachine', + ForceHuman: 'forceHuman' +} as const; +export type SendClassifyMachineAccountV1ClassificationModeV1 = typeof SendClassifyMachineAccountV1ClassificationModeV1[keyof typeof SendClassifyMachineAccountV1ClassificationModeV1]; + + diff --git a/sdk-output/machine_account_classify/base.ts b/sdk-output/machine_account_classify/base.ts new file mode 100644 index 00000000..4979f72c --- /dev/null +++ b/sdk-output/machine_account_classify/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Classify + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_account_classify/common.ts b/sdk-output/machine_account_classify/common.ts new file mode 100644 index 00000000..ac55c224 --- /dev/null +++ b/sdk-output/machine_account_classify/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Classify + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_account_classify/configuration.ts b/sdk-output/machine_account_classify/configuration.ts new file mode 100644 index 00000000..eaa192c9 --- /dev/null +++ b/sdk-output/machine_account_classify/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Classify + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_account_classify/git_push.sh b/sdk-output/machine_account_classify/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_account_classify/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_account_classify/index.ts b/sdk-output/machine_account_classify/index.ts new file mode 100644 index 00000000..2b0b5766 --- /dev/null +++ b/sdk-output/machine_account_classify/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Classify + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_account_classify/package.json b/sdk-output/machine_account_classify/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_account_classify/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_account_classify/tsconfig.json b/sdk-output/machine_account_classify/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_account_classify/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_account_creation_request/.gitignore b/sdk-output/machine_account_creation_request/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_account_creation_request/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_account_creation_request/.npmignore b/sdk-output/machine_account_creation_request/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_account_creation_request/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_account_creation_request/.openapi-generator-ignore b/sdk-output/machine_account_creation_request/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_account_creation_request/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_account_creation_request/.openapi-generator/FILES b/sdk-output/machine_account_creation_request/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_account_creation_request/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_account_creation_request/.openapi-generator/VERSION b/sdk-output/machine_account_creation_request/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_account_creation_request/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_account_creation_request/.sdk-partition b/sdk-output/machine_account_creation_request/.sdk-partition new file mode 100644 index 00000000..564c3c1f --- /dev/null +++ b/sdk-output/machine_account_creation_request/.sdk-partition @@ -0,0 +1 @@ +machine-account-creation-request \ No newline at end of file diff --git a/sdk-output/machine_account_creation_request/README.md b/sdk-output/machine_account_creation_request/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_creation_request/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_creation_request/api.ts b/sdk-output/machine_account_creation_request/api.ts new file mode 100644 index 00000000..986b7fbd --- /dev/null +++ b/sdk-output/machine_account_creation_request/api.ts @@ -0,0 +1,812 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Creation Request + * 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'; + +/** + * Asynchronous response containing a unique tracking ID for the account request + * @export + * @interface AccountrequestasyncresultV1 + */ +export interface AccountrequestasyncresultV1 { + /** + * Id of the account request + * @type {string} + * @memberof AccountrequestasyncresultV1 + */ + 'accountRequestId': string; +} +/** + * + * @export + * @interface AccountrequestdetailsdtoRequesterV1 + */ +export interface AccountrequestdetailsdtoRequesterV1 { + /** + * + * @type {DtotypeV1} + * @memberof AccountrequestdetailsdtoRequesterV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof AccountrequestdetailsdtoRequesterV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof AccountrequestdetailsdtoRequesterV1 + */ + 'name'?: string; +} + + +/** + * Represents a request to create a machine account. + * @export + * @interface AccountrequestdetailsdtoV1 + */ +export interface AccountrequestdetailsdtoV1 { + /** + * Account request ID. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'accountRequestId'?: string; + /** + * Type of the account request. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'requestType'?: string; + /** + * Machine account creation request creation date and time. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'createdAt'?: string; + /** + * Machine account creation request completion date and time. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'completedAt'?: string | null; + /** + * Overall status of the creation request. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'overallStatus'?: string; + /** + * + * @type {AccountrequestdetailsdtoRequesterV1} + * @memberof AccountrequestdetailsdtoV1 + */ + 'requester'?: AccountrequestdetailsdtoRequesterV1; + /** + * List of account request phases. + * @type {Array} + * @memberof AccountrequestdetailsdtoV1 + */ + 'accountRequestPhases'?: Array; + /** + * Detailed error information. + * @type {string} + * @memberof AccountrequestdetailsdtoV1 + */ + 'errorDetails'?: string | null; +} +/** + * Contains detailed information about each phase in the account request process, including its type, current state, and relevant timestamps. + * @export + * @interface AccountrequestphaseV1 + */ +export interface AccountrequestphaseV1 { + /** + * Enum of account request phase type + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'name'?: AccountrequestphaseV1NameV1; + /** + * + * @type {AccountrequestphasestateV1} + * @memberof AccountrequestphaseV1 + */ + 'state'?: AccountrequestphasestateV1; + /** + * Start date of account request phase. + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'started'?: string; + /** + * Finish date of account request phase. + * @type {string} + * @memberof AccountrequestphaseV1 + */ + 'finished'?: string; +} + +export const AccountrequestphaseV1NameV1 = { + ApprovalPhase: 'APPROVAL_PHASE', + ProvisioningPhase: 'PROVISIONING_PHASE' +} as const; + +export type AccountrequestphaseV1NameV1 = typeof AccountrequestphaseV1NameV1[keyof typeof AccountrequestphaseV1NameV1]; + +/** + * The current phase state of the account request, indicating its progress or outcome in the approval workflow. + * @export + * @enum {string} + */ + +export const AccountrequestphasestateV1 = { + Pending: 'PENDING', + Cancelled: 'CANCELLED', + Approved: 'APPROVED', + Rejected: 'REJECTED', + Passed: 'PASSED', + Failed: 'FAILED', + NotStarted: 'NOT_STARTED' +} as const; + +export type AccountrequestphasestateV1 = typeof AccountrequestphasestateV1[keyof typeof AccountrequestphasestateV1]; + + +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface CreateMachineAccountRequestV1401ResponseV1 + */ +export interface CreateMachineAccountRequestV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateMachineAccountRequestV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface CreateMachineAccountRequestV1429ResponseV1 + */ +export interface CreateMachineAccountRequestV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateMachineAccountRequestV1429ResponseV1 + */ + 'message'?: any; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MachineaccountcreateaccessdtoSubtypesInnerV1 + */ +export interface MachineaccountcreateaccessdtoSubtypesInnerV1 { + /** + * Subtype ID. + * @type {string} + * @memberof MachineaccountcreateaccessdtoSubtypesInnerV1 + */ + 'subtypeId'?: string; + /** + * Entitlement ID. + * @type {string} + * @memberof MachineaccountcreateaccessdtoSubtypesInnerV1 + */ + 'entitlementId'?: string; + /** + * Subtype display name. + * @type {string} + * @memberof MachineaccountcreateaccessdtoSubtypesInnerV1 + */ + 'subtypeDisplayName'?: string; + /** + * Subtype technical name. + * @type {string} + * @memberof MachineaccountcreateaccessdtoSubtypesInnerV1 + */ + 'subtypeTechnicalName'?: string; +} +/** + * A summary endpoint which returns list of sources and subtypes for which user has an entitlement to request machine accounts. + * @export + * @interface MachineaccountcreateaccessdtoV1 + */ +export interface MachineaccountcreateaccessdtoV1 { + /** + * Source ID. + * @type {string} + * @memberof MachineaccountcreateaccessdtoV1 + */ + 'sourceId'?: string; + /** + * Source name. + * @type {string} + * @memberof MachineaccountcreateaccessdtoV1 + */ + 'sourceName'?: string; + /** + * List of subtypes for which the user has an entitlement to request machine accounts. + * @type {Array} + * @memberof MachineaccountcreateaccessdtoV1 + */ + 'subtypes'?: Array; +} +/** + * Contains the required information for processing a user-initiated machine account creation request. + * @export + * @interface MachineaccountcreaterequestinputV1 + */ +export interface MachineaccountcreaterequestinputV1 { + /** + * Subtype ID for which machine account create is enabled and user have the entitlement to create the machine account. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'subtypeId': string; + /** + * Form ID selected by user for the machine account create request. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'formId'?: string; + /** + * Owner Identity ID. This identity will be assigned as an owner of the created machine account. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'ownerIdentityId': string; + /** + * Machine identity to correlate with the created machine account. If not provided, a new machine identity will be created. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'machineIdentityId'?: string | null; + /** + * Environment type to use for the machine account. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'environment'?: string; + /** + * Description for the machine account. + * @type {string} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'description'?: string; + /** + * Fields of the form linked to the subtype in approval settings. + * @type {object} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'userInput'?: object; + /** + * List of entitlement IDs to provision for created machine account. + * @type {Array} + * @memberof MachineaccountcreaterequestinputV1 + */ + 'entitlementIds'?: Array; +} + +/** + * MachineAccountCreationRequestV1Api - axios parameter creator + * @export + */ +export const MachineAccountCreationRequestV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** + * @summary Submit Machine Account Creation Request + * @param {MachineaccountcreaterequestinputV1} machineaccountcreaterequestinputV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineAccountRequestV1: async (machineaccountcreaterequestinputV1: MachineaccountcreaterequestinputV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'machineaccountcreaterequestinputV1' is not null or undefined + assertParamExists('createMachineAccountRequestV1', 'machineaccountcreaterequestinputV1', machineaccountcreaterequestinputV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/account-requests/v1/machine-account-create`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(machineaccountcreaterequestinputV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. + * @summary Get Machine Account Creation Request + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} accountRequestId Account Request ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCreateMachineAccountRequestV1: async (xSailPointExperimental: string, accountRequestId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('getCreateMachineAccountRequestV1', 'xSailPointExperimental', xSailPointExperimental) + // verify required parameter 'accountRequestId' is not null or undefined + assertParamExists('getCreateMachineAccountRequestV1', 'accountRequestId', accountRequestId) + const localVarPath = `/account-requests/v1/machine-account-create/{accountRequestId}` + .replace(`{${"accountRequestId"}}`, encodeURIComponent(String(accountRequestId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. + * @summary Machine Account Create Access + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountCreateAccessInfoV1: async (xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('getMachineAccountCreateAccessInfoV1', 'xSailPointExperimental', xSailPointExperimental) + const localVarPath = `/source-subtypes/v1/machine-account-create-access`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineAccountCreationRequestV1Api - functional programming interface + * @export + */ +export const MachineAccountCreationRequestV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineAccountCreationRequestV1ApiAxiosParamCreator(configuration) + return { + /** + * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** + * @summary Submit Machine Account Creation Request + * @param {MachineaccountcreaterequestinputV1} machineaccountcreaterequestinputV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createMachineAccountRequestV1(machineaccountcreaterequestinputV1: MachineaccountcreaterequestinputV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountRequestV1(machineaccountcreaterequestinputV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV1Api.createMachineAccountRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. + * @summary Get Machine Account Creation Request + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} accountRequestId Account Request ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCreateMachineAccountRequestV1(xSailPointExperimental: string, accountRequestId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCreateMachineAccountRequestV1(xSailPointExperimental, accountRequestId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV1Api.getCreateMachineAccountRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. + * @summary Machine Account Create Access + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineAccountCreateAccessInfoV1(xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountCreateAccessInfoV1(xSailPointExperimental, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV1Api.getMachineAccountCreateAccessInfoV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineAccountCreationRequestV1Api - factory interface + * @export + */ +export const MachineAccountCreationRequestV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineAccountCreationRequestV1ApiFp(configuration) + return { + /** + * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** + * @summary Submit Machine Account Creation Request + * @param {MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createMachineAccountRequestV1(requestParameters.machineaccountcreaterequestinputV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. + * @summary Get Machine Account Creation Request + * @param {MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCreateMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCreateMachineAccountRequestV1(requestParameters.xSailPointExperimental, requestParameters.accountRequestId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. + * @summary Machine Account Create Access + * @param {MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountCreateAccessInfoV1(requestParameters: MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getMachineAccountCreateAccessInfoV1(requestParameters.xSailPointExperimental, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createMachineAccountRequestV1 operation in MachineAccountCreationRequestV1Api. + * @export + * @interface MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request + */ +export interface MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request { + /** + * + * @type {MachineaccountcreaterequestinputV1} + * @memberof MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1 + */ + readonly machineaccountcreaterequestinputV1: MachineaccountcreaterequestinputV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getCreateMachineAccountRequestV1 operation in MachineAccountCreationRequestV1Api. + * @export + * @interface MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request + */ +export interface MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1 + */ + readonly xSailPointExperimental: string + + /** + * Account Request ID + * @type {string} + * @memberof MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1 + */ + readonly accountRequestId: string +} + +/** + * Request parameters for getMachineAccountCreateAccessInfoV1 operation in MachineAccountCreationRequestV1Api. + * @export + * @interface MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request + */ +export interface MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1 + */ + readonly xSailPointExperimental: string + + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1 + */ + readonly limit?: number +} + +/** + * MachineAccountCreationRequestV1Api - object-oriented interface + * @export + * @class MachineAccountCreationRequestV1Api + * @extends {BaseAPI} + */ +export class MachineAccountCreationRequestV1Api extends BaseAPI { + /** + * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** + * @summary Submit Machine Account Creation Request + * @param {MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountCreationRequestV1Api + */ + public createMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestV1ApiCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountCreationRequestV1ApiFp(this.configuration).createMachineAccountRequestV1(requestParameters.machineaccountcreaterequestinputV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. + * @summary Get Machine Account Creation Request + * @param {MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountCreationRequestV1Api + */ + public getCreateMachineAccountRequestV1(requestParameters: MachineAccountCreationRequestV1ApiGetCreateMachineAccountRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountCreationRequestV1ApiFp(this.configuration).getCreateMachineAccountRequestV1(requestParameters.xSailPointExperimental, requestParameters.accountRequestId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. + * @summary Machine Account Create Access + * @param {MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountCreationRequestV1Api + */ + public getMachineAccountCreateAccessInfoV1(requestParameters: MachineAccountCreationRequestV1ApiGetMachineAccountCreateAccessInfoV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountCreationRequestV1ApiFp(this.configuration).getMachineAccountCreateAccessInfoV1(requestParameters.xSailPointExperimental, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_account_creation_request/base.ts b/sdk-output/machine_account_creation_request/base.ts new file mode 100644 index 00000000..bfa015a4 --- /dev/null +++ b/sdk-output/machine_account_creation_request/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Creation Request + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_account_creation_request/common.ts b/sdk-output/machine_account_creation_request/common.ts new file mode 100644 index 00000000..9fbed7c2 --- /dev/null +++ b/sdk-output/machine_account_creation_request/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Creation Request + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_account_creation_request/configuration.ts b/sdk-output/machine_account_creation_request/configuration.ts new file mode 100644 index 00000000..b1b056e0 --- /dev/null +++ b/sdk-output/machine_account_creation_request/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Creation Request + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_account_creation_request/git_push.sh b/sdk-output/machine_account_creation_request/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_account_creation_request/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_account_creation_request/index.ts b/sdk-output/machine_account_creation_request/index.ts new file mode 100644 index 00000000..43bfdd0b --- /dev/null +++ b/sdk-output/machine_account_creation_request/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Creation Request + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_account_creation_request/package.json b/sdk-output/machine_account_creation_request/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_account_creation_request/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_account_creation_request/tsconfig.json b/sdk-output/machine_account_creation_request/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_account_creation_request/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_account_mappings/.gitignore b/sdk-output/machine_account_mappings/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_account_mappings/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_account_mappings/.npmignore b/sdk-output/machine_account_mappings/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_account_mappings/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_account_mappings/.openapi-generator-ignore b/sdk-output/machine_account_mappings/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_account_mappings/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_account_mappings/.openapi-generator/FILES b/sdk-output/machine_account_mappings/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_account_mappings/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_account_mappings/.openapi-generator/VERSION b/sdk-output/machine_account_mappings/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_account_mappings/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_account_mappings/.sdk-partition b/sdk-output/machine_account_mappings/.sdk-partition new file mode 100644 index 00000000..d9344b27 --- /dev/null +++ b/sdk-output/machine_account_mappings/.sdk-partition @@ -0,0 +1 @@ +machine-account-mappings \ No newline at end of file diff --git a/sdk-output/machine_account_mappings/README.md b/sdk-output/machine_account_mappings/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_mappings/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_mappings/api.ts b/sdk-output/machine_account_mappings/api.ts new file mode 100644 index 00000000..0f8e8b54 --- /dev/null +++ b/sdk-output/machine_account_mappings/api.ts @@ -0,0 +1,685 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Mappings + * 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'; + +/** + * Targeted Entity + * @export + * @interface AttributemappingsAllOfTargetV1 + */ +export interface AttributemappingsAllOfTargetV1 { + /** + * The type of target entity + * @type {string} + * @memberof AttributemappingsAllOfTargetV1 + */ + 'type'?: AttributemappingsAllOfTargetV1TypeV1; + /** + * Name of the targeted attribute + * @type {string} + * @memberof AttributemappingsAllOfTargetV1 + */ + 'attributeName'?: string; + /** + * The ID of Source + * @type {string} + * @memberof AttributemappingsAllOfTargetV1 + */ + 'sourceId'?: string; +} + +export const AttributemappingsAllOfTargetV1TypeV1 = { + Account: 'ACCOUNT', + Identity: 'IDENTITY', + OwnerAccount: 'OWNER_ACCOUNT', + OwnerIdentity: 'OWNER_IDENTITY' +} as const; + +export type AttributemappingsAllOfTargetV1TypeV1 = typeof AttributemappingsAllOfTargetV1TypeV1[keyof typeof AttributemappingsAllOfTargetV1TypeV1]; + +/** + * Attibute Mapping Object + * @export + * @interface AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 + */ +export interface AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 { + /** + * The name of attribute + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 + */ + 'attributeName'?: string; + /** + * Name of the Source + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 + */ + 'sourceName'?: string; + /** + * ID of the Source + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 + */ + 'name'?: string; +} +/** + * Input Object + * @export + * @interface AttributemappingsAllOfTransformDefinitionAttributesInputV1 + */ +export interface AttributemappingsAllOfTransformDefinitionAttributesInputV1 { + /** + * The Type of Attribute + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesInputV1 + */ + 'type'?: string; + /** + * + * @type {AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesInputV1 + */ + 'attributes'?: AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1; +} +/** + * attributes object + * @export + * @interface AttributemappingsAllOfTransformDefinitionAttributesV1 + */ +export interface AttributemappingsAllOfTransformDefinitionAttributesV1 { + /** + * + * @type {AttributemappingsAllOfTransformDefinitionAttributesInputV1} + * @memberof AttributemappingsAllOfTransformDefinitionAttributesV1 + */ + 'input'?: AttributemappingsAllOfTransformDefinitionAttributesInputV1; +} +/** + * + * @export + * @interface AttributemappingsAllOfTransformDefinitionV1 + */ +export interface AttributemappingsAllOfTransformDefinitionV1 { + /** + * The type of transform + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionV1 + */ + 'type'?: string; + /** + * + * @type {AttributemappingsAllOfTransformDefinitionAttributesV1} + * @memberof AttributemappingsAllOfTransformDefinitionV1 + */ + 'attributes'?: AttributemappingsAllOfTransformDefinitionAttributesV1; + /** + * Transform Operation + * @type {string} + * @memberof AttributemappingsAllOfTransformDefinitionV1 + */ + 'id'?: string; +} +/** + * + * @export + * @interface AttributemappingsV1 + */ +export interface AttributemappingsV1 { + /** + * + * @type {AttributemappingsAllOfTargetV1} + * @memberof AttributemappingsV1 + */ + 'target'?: AttributemappingsAllOfTargetV1; + /** + * + * @type {AttributemappingsAllOfTransformDefinitionV1} + * @memberof AttributemappingsV1 + */ + 'transformDefinition'?: AttributemappingsAllOfTransformDefinitionV1; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListMachineAccountMappingsV1401ResponseV1 + */ +export interface ListMachineAccountMappingsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineAccountMappingsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListMachineAccountMappingsV1429ResponseV1 + */ +export interface ListMachineAccountMappingsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineAccountMappingsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * MachineAccountMappingsV1Api - axios parameter creator + * @export + */ +export const MachineAccountMappingsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create machine account mappings + * @param {string} sourceId Source ID. + * @param {AttributemappingsV1} attributemappingsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineAccountMappingsV1: async (sourceId: string, attributemappingsV1: AttributemappingsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createMachineAccountMappingsV1', 'sourceId', sourceId) + // verify required parameter 'attributemappingsV1' is not null or undefined + assertParamExists('createMachineAccountMappingsV1', 'attributemappingsV1', attributemappingsV1) + const localVarPath = `/sources/v1/{sourceId}/machine-account-mappings` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(attributemappingsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s machine account mappings + * @param {string} sourceId source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineAccountMappingsV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteMachineAccountMappingsV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/machine-account-mappings` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Retrieves Machine account mappings for a specified source using Source ID. + * @summary Machine account mapping for source + * @param {string} sourceId Source ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineAccountMappingsV1: async (sourceId: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('listMachineAccountMappingsV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/machine-account-mappings` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s machine account mappings + * @param {string} sourceId Source ID. + * @param {AttributemappingsV1} attributemappingsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMachineAccountMappingsV1: async (sourceId: string, attributemappingsV1: AttributemappingsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('setMachineAccountMappingsV1', 'sourceId', sourceId) + // verify required parameter 'attributemappingsV1' is not null or undefined + assertParamExists('setMachineAccountMappingsV1', 'attributemappingsV1', attributemappingsV1) + const localVarPath = `/sources/v1/{sourceId}/machine-mappings` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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: 'PUT', ...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(attributemappingsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineAccountMappingsV1Api - functional programming interface + * @export + */ +export const MachineAccountMappingsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineAccountMappingsV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create machine account mappings + * @param {string} sourceId Source ID. + * @param {AttributemappingsV1} attributemappingsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createMachineAccountMappingsV1(sourceId: string, attributemappingsV1: AttributemappingsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountMappingsV1(sourceId, attributemappingsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV1Api.createMachineAccountMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s machine account mappings + * @param {string} sourceId source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMachineAccountMappingsV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountMappingsV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV1Api.deleteMachineAccountMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves Machine account mappings for a specified source using Source ID. + * @summary Machine account mapping for source + * @param {string} sourceId Source ID + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listMachineAccountMappingsV1(sourceId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountMappingsV1(sourceId, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV1Api.listMachineAccountMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s machine account mappings + * @param {string} sourceId Source ID. + * @param {AttributemappingsV1} attributemappingsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setMachineAccountMappingsV1(sourceId: string, attributemappingsV1: AttributemappingsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineAccountMappingsV1(sourceId, attributemappingsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV1Api.setMachineAccountMappingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineAccountMappingsV1Api - factory interface + * @export + */ +export const MachineAccountMappingsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineAccountMappingsV1ApiFp(configuration) + return { + /** + * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create machine account mappings + * @param {MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.createMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.attributemappingsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s machine account mappings + * @param {MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMachineAccountMappingsV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves Machine account mappings for a specified source using Source ID. + * @summary Machine account mapping for source + * @param {MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s machine account mappings + * @param {MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.setMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.attributemappingsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createMachineAccountMappingsV1 operation in MachineAccountMappingsV1Api. + * @export + * @interface MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request + */ +export interface MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request { + /** + * Source ID. + * @type {string} + * @memberof MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1 + */ + readonly sourceId: string + + /** + * + * @type {AttributemappingsV1} + * @memberof MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1 + */ + readonly attributemappingsV1: AttributemappingsV1 +} + +/** + * Request parameters for deleteMachineAccountMappingsV1 operation in MachineAccountMappingsV1Api. + * @export + * @interface MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request + */ +export interface MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request { + /** + * source ID. + * @type {string} + * @memberof MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for listMachineAccountMappingsV1 operation in MachineAccountMappingsV1Api. + * @export + * @interface MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request + */ +export interface MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request { + /** + * Source ID + * @type {string} + * @memberof MachineAccountMappingsV1ApiListMachineAccountMappingsV1 + */ + readonly sourceId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineAccountMappingsV1ApiListMachineAccountMappingsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineAccountMappingsV1ApiListMachineAccountMappingsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for setMachineAccountMappingsV1 operation in MachineAccountMappingsV1Api. + * @export + * @interface MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request + */ +export interface MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request { + /** + * Source ID. + * @type {string} + * @memberof MachineAccountMappingsV1ApiSetMachineAccountMappingsV1 + */ + readonly sourceId: string + + /** + * + * @type {AttributemappingsV1} + * @memberof MachineAccountMappingsV1ApiSetMachineAccountMappingsV1 + */ + readonly attributemappingsV1: AttributemappingsV1 +} + +/** + * MachineAccountMappingsV1Api - object-oriented interface + * @export + * @class MachineAccountMappingsV1Api + * @extends {BaseAPI} + */ +export class MachineAccountMappingsV1Api extends BaseAPI { + /** + * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create machine account mappings + * @param {MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountMappingsV1Api + */ + public createMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiCreateMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountMappingsV1ApiFp(this.configuration).createMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.attributemappingsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s machine account mappings + * @param {MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountMappingsV1Api + */ + public deleteMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiDeleteMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountMappingsV1ApiFp(this.configuration).deleteMachineAccountMappingsV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves Machine account mappings for a specified source using Source ID. + * @summary Machine account mapping for source + * @param {MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountMappingsV1Api + */ + public listMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiListMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountMappingsV1ApiFp(this.configuration).listMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s machine account mappings + * @param {MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountMappingsV1Api + */ + public setMachineAccountMappingsV1(requestParameters: MachineAccountMappingsV1ApiSetMachineAccountMappingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountMappingsV1ApiFp(this.configuration).setMachineAccountMappingsV1(requestParameters.sourceId, requestParameters.attributemappingsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_account_mappings/base.ts b/sdk-output/machine_account_mappings/base.ts new file mode 100644 index 00000000..5243a696 --- /dev/null +++ b/sdk-output/machine_account_mappings/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Mappings + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_account_mappings/common.ts b/sdk-output/machine_account_mappings/common.ts new file mode 100644 index 00000000..85c9d1ae --- /dev/null +++ b/sdk-output/machine_account_mappings/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Mappings + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_account_mappings/configuration.ts b/sdk-output/machine_account_mappings/configuration.ts new file mode 100644 index 00000000..ad7d5e7c --- /dev/null +++ b/sdk-output/machine_account_mappings/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Mappings + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_account_mappings/git_push.sh b/sdk-output/machine_account_mappings/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_account_mappings/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_account_mappings/index.ts b/sdk-output/machine_account_mappings/index.ts new file mode 100644 index 00000000..acffc92d --- /dev/null +++ b/sdk-output/machine_account_mappings/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Mappings + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_account_mappings/package.json b/sdk-output/machine_account_mappings/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_account_mappings/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_account_mappings/tsconfig.json b/sdk-output/machine_account_mappings/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_account_mappings/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_account_subtypes/.gitignore b/sdk-output/machine_account_subtypes/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_account_subtypes/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_account_subtypes/.npmignore b/sdk-output/machine_account_subtypes/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_account_subtypes/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_account_subtypes/.openapi-generator-ignore b/sdk-output/machine_account_subtypes/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_account_subtypes/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_account_subtypes/.openapi-generator/FILES b/sdk-output/machine_account_subtypes/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_account_subtypes/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_account_subtypes/.openapi-generator/VERSION b/sdk-output/machine_account_subtypes/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_account_subtypes/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_account_subtypes/.sdk-partition b/sdk-output/machine_account_subtypes/.sdk-partition new file mode 100644 index 00000000..c1567846 --- /dev/null +++ b/sdk-output/machine_account_subtypes/.sdk-partition @@ -0,0 +1 @@ +machine-account-subtypes \ No newline at end of file diff --git a/sdk-output/machine_account_subtypes/README.md b/sdk-output/machine_account_subtypes/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_subtypes/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_subtypes/api.ts b/sdk-output/machine_account_subtypes/api.ts new file mode 100644 index 00000000..2367a53f --- /dev/null +++ b/sdk-output/machine_account_subtypes/api.ts @@ -0,0 +1,1354 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Subtypes + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface CreateSourceSubtypeV1RequestV1 + */ +export interface CreateSourceSubtypeV1RequestV1 { + /** + * ID of the source where subtype is created. + * @type {string} + * @memberof CreateSourceSubtypeV1RequestV1 + */ + 'sourceId': string; + /** + * Technical name of the subtype. + * @type {string} + * @memberof CreateSourceSubtypeV1RequestV1 + */ + 'technicalName': string; + /** + * Display name of the subtype. + * @type {string} + * @memberof CreateSourceSubtypeV1RequestV1 + */ + 'displayName': string; + /** + * Description of the subtype. + * @type {string} + * @memberof CreateSourceSubtypeV1RequestV1 + */ + 'description': string; + /** + * Type of the subtype. + * @type {string} + * @memberof CreateSourceSubtypeV1RequestV1 + */ + 'type'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface LoadBulkSourceSubtypesV1401ResponseV1 + */ +export interface LoadBulkSourceSubtypesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof LoadBulkSourceSubtypesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface LoadBulkSourceSubtypesV1429ResponseV1 + */ +export interface LoadBulkSourceSubtypesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof LoadBulkSourceSubtypesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Configuration options for machine account creation, including whether creation is enabled, if approval is required, associated form and entitlement IDs, and detailed approval settings such as approvers and allowed comment types. + * @export + * @interface MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ +export interface MachineaccountsubtypeconfigdtoMachineAccountCreateV1 { + /** + * Specifies if the creation of machine accounts is allowed for this subtype. + * @type {boolean} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'accountCreateEnabled'?: boolean; + /** + * Specifies if approval is required for machine account creation requests for this subtype. + * @type {boolean} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'approvalRequired'?: boolean; + /** + * Id of the form linked to subtype. + * @type {string} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'formId'?: string; + /** + * Id of the system created entitlement entitlement upon enabling account creation for this subtype. + * @type {string} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'entitlementId'?: string; + /** + * This is required before enabling the account creation to true. Default value will be null. + * @type {string} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'passwordSetting'?: MachineaccountsubtypeconfigdtoMachineAccountCreateV1PasswordSettingV1; + /** + * Name of the account attribute from the source\'s schema or new custom attribute to use when password settings is enabled. + * @type {string} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'passwordAttribute'?: string; + /** + * + * @type {MachinesubtypeapprovalconfigV1} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + */ + 'approvalConfig'?: MachinesubtypeapprovalconfigV1; +} + +export const MachineaccountsubtypeconfigdtoMachineAccountCreateV1PasswordSettingV1 = { + DoNotSetPassword: 'DO_NOT_SET_PASSWORD', + SetToExistingAttribute: 'SET_TO_EXISTING_ATTRIBUTE', + SetToNewAttribute: 'SET_TO_NEW_ATTRIBUTE' +} as const; + +export type MachineaccountsubtypeconfigdtoMachineAccountCreateV1PasswordSettingV1 = typeof MachineaccountsubtypeconfigdtoMachineAccountCreateV1PasswordSettingV1[keyof typeof MachineaccountsubtypeconfigdtoMachineAccountCreateV1PasswordSettingV1]; + +/** + * Configuration options for machine account deletion, including whether approval is required, the list of authorized approvers, and the types of comments permitted during the approval workflow. + * @export + * @interface MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 + */ +export interface MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 { + /** + * Indicates whether approval is required for an account deletion request. + * @type {boolean} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 + */ + 'approvalRequired'?: boolean; + /** + * + * @type {MachinesubtypeapprovalconfigV1} + * @memberof MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 + */ + 'approvalConfig'?: MachinesubtypeapprovalconfigV1; +} +/** + * Contains comprehensive configuration details for machine account subtype approval, including creation and deletion approval requirements, approver lists, form and entitlement references, and approval status options. + * @export + * @interface MachineaccountsubtypeconfigdtoV1 + */ +export interface MachineaccountsubtypeconfigdtoV1 { + /** + * Unique identifier representing the specific subtype of the machine account, used to distinguish between different machine account categories. + * @type {string} + * @memberof MachineaccountsubtypeconfigdtoV1 + */ + 'subtypeId'?: string; + /** + * + * @type {MachineaccountsubtypeconfigdtoMachineAccountCreateV1} + * @memberof MachineaccountsubtypeconfigdtoV1 + */ + 'machineAccountCreate'?: MachineaccountsubtypeconfigdtoMachineAccountCreateV1; + /** + * + * @type {MachineaccountsubtypeconfigdtoMachineAccountDeleteV1} + * @memberof MachineaccountsubtypeconfigdtoV1 + */ + 'machineAccountDelete'?: MachineaccountsubtypeconfigdtoMachineAccountDeleteV1; +} +/** + * + * @export + * @interface MachinesubtypeapprovalconfigV1 + */ +export interface MachinesubtypeapprovalconfigV1 { + /** + * Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:[workgroupId] (Governance group). Approval request will be assigned based on the order of the approvers passed. Multiple workgroups(governance groups) can be selected as an approver. >**Note:** accountOwner approver type is only for machine account delete approval settings. + * @type {string} + * @memberof MachinesubtypeapprovalconfigV1 + */ + 'approvers'?: string; + /** + * Comment configurations for the approval request. Following are the options for comments: ALL, OFF, APPROVAL, REJECT. + * @type {string} + * @memberof MachinesubtypeapprovalconfigV1 + */ + 'comments'?: string; +} +/** + * Source reference of the subtype. + * @export + * @interface SourcesubtypewithsourceSourceV1 + */ +export interface SourcesubtypewithsourceSourceV1 { + /** + * Type of the reference object. + * @type {string} + * @memberof SourcesubtypewithsourceSourceV1 + */ + 'type'?: SourcesubtypewithsourceSourceV1TypeV1; + /** + * Unique identifier for the source. + * @type {string} + * @memberof SourcesubtypewithsourceSourceV1 + */ + 'id'?: string; + /** + * Name of the source. + * @type {string} + * @memberof SourcesubtypewithsourceSourceV1 + */ + 'name'?: string; +} + +export const SourcesubtypewithsourceSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type SourcesubtypewithsourceSourceV1TypeV1 = typeof SourcesubtypewithsourceSourceV1TypeV1[keyof typeof SourcesubtypewithsourceSourceV1TypeV1]; + +/** + * + * @export + * @interface SourcesubtypewithsourceV1 + */ +export interface SourcesubtypewithsourceV1 { + /** + * Unique identifier for the subtype. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'id'?: string; + /** + * The ID of the source. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'sourceId'?: string; + /** + * Technical name of the subtype. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'technicalName'?: string; + /** + * Display name of the subtype. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'displayName'?: string; + /** + * Description of the subtype. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'description'?: string; + /** + * Creation timestamp. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'created'?: string; + /** + * Last modified timestamp. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'modified'?: string; + /** + * Type of the subtype. Either MACHINE OR null. + * @type {string} + * @memberof SourcesubtypewithsourceV1 + */ + 'type'?: string; + /** + * + * @type {SourcesubtypewithsourceSourceV1} + * @memberof SourcesubtypewithsourceV1 + */ + 'source'?: SourcesubtypewithsourceSourceV1; + /** + * Indicates if the subtype is managed by the system. + * @type {boolean} + * @memberof SourcesubtypewithsourceV1 + */ + 'systemManaged'?: boolean; +} + +/** + * MachineAccountSubtypesV1Api - axios parameter creator + * @export + */ +export const MachineAccountSubtypesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new machine account subtype. + * @summary Create subtype + * @param {CreateSourceSubtypeV1RequestV1} createSourceSubtypeV1RequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceSubtypeV1: async (createSourceSubtypeV1RequestV1: CreateSourceSubtypeV1RequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createSourceSubtypeV1RequestV1' is not null or undefined + assertParamExists('createSourceSubtypeV1', 'createSourceSubtypeV1RequestV1', createSourceSubtypeV1RequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-subtypes/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createSourceSubtypeV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. + * @summary Delete subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineAccountSubtypeV1: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('deleteMachineAccountSubtypeV1', 'subtypeId', subtypeId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-subtypes/v1/{subtypeId}` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. + * @summary Machine Subtype Approval Config + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} subtypeId machine subtype id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountSubtypeApprovalConfigV1: async (xSailPointExperimental: string, subtypeId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('getMachineAccountSubtypeApprovalConfigV1', 'xSailPointExperimental', xSailPointExperimental) + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('getMachineAccountSubtypeApprovalConfigV1', 'subtypeId', subtypeId) + const localVarPath = `/source-subtypes/v1/{subtypeId}/machine-config` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a machine account subtype by subtype ID. + * @summary Get subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSubtypeByIdV1: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('getSourceSubtypeByIdV1', 'subtypeId', subtypeId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-subtypes/v1/{subtypeId}` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get all machine account subtypes. + * @summary Retrieve all subtypes + * @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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* + * @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: **displayName, technicalName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSourceSubtypesV1: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-subtypes/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint retrieves the subtypes for given subtypeIds. + * @summary Bulk Retrieve of Source Subtypes + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {Array} requestBody + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + loadBulkSourceSubtypesV1: async (xSailPointExperimental: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('loadBulkSourceSubtypesV1', 'xSailPointExperimental', xSailPointExperimental) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('loadBulkSourceSubtypesV1', 'requestBody', requestBody) + const localVarPath = `/source-subtypes/v1/bulk-retrieve`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. + * @summary Patch subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchMachineAccountSubtypeV1: async (subtypeId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('patchMachineAccountSubtypeV1', 'subtypeId', subtypeId) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('patchMachineAccountSubtypeV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/source-subtypes/v1/{subtypeId}` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. + * @summary Machine Subtype Approval Config + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} subtypeId machine account subtype ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountSubtypeApprovalConfigV1: async (xSailPointExperimental: string, subtypeId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + // verify required parameter 'xSailPointExperimental' is not null or undefined + assertParamExists('updateMachineAccountSubtypeApprovalConfigV1', 'xSailPointExperimental', xSailPointExperimental) + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('updateMachineAccountSubtypeApprovalConfigV1', 'subtypeId', subtypeId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateMachineAccountSubtypeApprovalConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/source-subtypes/v1/{subtypeId}/machine-config` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineAccountSubtypesV1Api - functional programming interface + * @export + */ +export const MachineAccountSubtypesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineAccountSubtypesV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new machine account subtype. + * @summary Create subtype + * @param {CreateSourceSubtypeV1RequestV1} createSourceSubtypeV1RequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourceSubtypeV1(createSourceSubtypeV1RequestV1: CreateSourceSubtypeV1RequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSubtypeV1(createSourceSubtypeV1RequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.createSourceSubtypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. + * @summary Delete subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMachineAccountSubtypeV1(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountSubtypeV1(subtypeId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.deleteMachineAccountSubtypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. + * @summary Machine Subtype Approval Config + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} subtypeId machine subtype id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.getMachineAccountSubtypeApprovalConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a machine account subtype by subtype ID. + * @summary Get subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceSubtypeByIdV1(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSubtypeByIdV1(subtypeId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.getSourceSubtypeByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get all machine account subtypes. + * @summary Retrieve all subtypes + * @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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* + * @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: **displayName, technicalName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSourceSubtypesV1(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSourceSubtypesV1(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.listSourceSubtypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint retrieves the subtypes for given subtypeIds. + * @summary Bulk Retrieve of Source Subtypes + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {Array} requestBody + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async loadBulkSourceSubtypesV1(xSailPointExperimental: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.loadBulkSourceSubtypesV1(xSailPointExperimental, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.loadBulkSourceSubtypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. + * @summary Patch subtype by ID + * @param {string} subtypeId The ID of the subtype. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchMachineAccountSubtypeV1(subtypeId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchMachineAccountSubtypeV1(subtypeId, requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.patchMachineAccountSubtypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. + * @summary Machine Subtype Approval Config + * @param {string} xSailPointExperimental Use this header to enable this experimental API. + * @param {string} subtypeId machine account subtype ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental: string, subtypeId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV1Api.updateMachineAccountSubtypeApprovalConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineAccountSubtypesV1Api - factory interface + * @export + */ +export const MachineAccountSubtypesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineAccountSubtypesV1ApiFp(configuration) + return { + /** + * Create a new machine account subtype. + * @summary Create subtype + * @param {MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourceSubtypeV1(requestParameters.createSourceSubtypeV1RequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. + * @summary Delete subtype by ID + * @param {MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineAccountSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMachineAccountSubtypeV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. + * @summary Machine Subtype Approval Config + * @param {MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountSubtypeApprovalConfigV1(requestParameters: MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineAccountSubtypeApprovalConfigV1(requestParameters.xSailPointExperimental, requestParameters.subtypeId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a machine account subtype by subtype ID. + * @summary Get subtype by ID + * @param {MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSubtypeByIdV1(requestParameters: MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceSubtypeByIdV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get all machine account subtypes. + * @summary Retrieve all subtypes + * @param {MachineAccountSubtypesV1ApiListSourceSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSourceSubtypesV1(requestParameters: MachineAccountSubtypesV1ApiListSourceSubtypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSourceSubtypesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint retrieves the subtypes for given subtypeIds. + * @summary Bulk Retrieve of Source Subtypes + * @param {MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + loadBulkSourceSubtypesV1(requestParameters: MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.loadBulkSourceSubtypesV1(requestParameters.xSailPointExperimental, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. + * @summary Patch subtype by ID + * @param {MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchMachineAccountSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchMachineAccountSubtypeV1(requestParameters.subtypeId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. + * @summary Machine Subtype Approval Config + * @param {MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountSubtypeApprovalConfigV1(requestParameters: MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateMachineAccountSubtypeApprovalConfigV1(requestParameters.xSailPointExperimental, requestParameters.subtypeId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSourceSubtypeV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request + */ +export interface MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request { + /** + * + * @type {CreateSourceSubtypeV1RequestV1} + * @memberof MachineAccountSubtypesV1ApiCreateSourceSubtypeV1 + */ + readonly createSourceSubtypeV1RequestV1: CreateSourceSubtypeV1RequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiCreateSourceSubtypeV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteMachineAccountSubtypeV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request + */ +export interface MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request { + /** + * The ID of the subtype. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1 + */ + readonly subtypeId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getMachineAccountSubtypeApprovalConfigV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request + */ +export interface MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1 + */ + readonly xSailPointExperimental: string + + /** + * machine subtype id. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1 + */ + readonly subtypeId: string +} + +/** + * Request parameters for getSourceSubtypeByIdV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request + */ +export interface MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request { + /** + * The ID of the subtype. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1 + */ + readonly subtypeId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listSourceSubtypesV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiListSourceSubtypesV1Request + */ +export interface MachineAccountSubtypesV1ApiListSourceSubtypesV1Request { + /** + * 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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* + * @type {string} + * @memberof MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + 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: **displayName, technicalName** + * @type {string} + * @memberof MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + readonly xSailPointExperimental?: string + + /** + * 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 MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + readonly count?: boolean + + /** + * 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 MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineAccountSubtypesV1ApiListSourceSubtypesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for loadBulkSourceSubtypesV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request + */ +export interface MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1 + */ + readonly xSailPointExperimental: string + + /** + * + * @type {Array} + * @memberof MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1 + */ + readonly requestBody: Array +} + +/** + * Request parameters for patchMachineAccountSubtypeV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request + */ +export interface MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request { + /** + * The ID of the subtype. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1 + */ + readonly subtypeId: string + + /** + * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateMachineAccountSubtypeApprovalConfigV1 operation in MachineAccountSubtypesV1Api. + * @export + * @interface MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request + */ +export interface MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1 + */ + readonly xSailPointExperimental: string + + /** + * machine account subtype ID. + * @type {string} + * @memberof MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1 + */ + readonly subtypeId: string + + /** + * The JSONPatch payload used to update the object. + * @type {Array} + * @memberof MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * MachineAccountSubtypesV1Api - object-oriented interface + * @export + * @class MachineAccountSubtypesV1Api + * @extends {BaseAPI} + */ +export class MachineAccountSubtypesV1Api extends BaseAPI { + /** + * Create a new machine account subtype. + * @summary Create subtype + * @param {MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public createSourceSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiCreateSourceSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).createSourceSubtypeV1(requestParameters.createSourceSubtypeV1RequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. + * @summary Delete subtype by ID + * @param {MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public deleteMachineAccountSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiDeleteMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).deleteMachineAccountSubtypeV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. + * @summary Machine Subtype Approval Config + * @param {MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public getMachineAccountSubtypeApprovalConfigV1(requestParameters: MachineAccountSubtypesV1ApiGetMachineAccountSubtypeApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).getMachineAccountSubtypeApprovalConfigV1(requestParameters.xSailPointExperimental, requestParameters.subtypeId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a machine account subtype by subtype ID. + * @summary Get subtype by ID + * @param {MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public getSourceSubtypeByIdV1(requestParameters: MachineAccountSubtypesV1ApiGetSourceSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).getSourceSubtypeByIdV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get all machine account subtypes. + * @summary Retrieve all subtypes + * @param {MachineAccountSubtypesV1ApiListSourceSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public listSourceSubtypesV1(requestParameters: MachineAccountSubtypesV1ApiListSourceSubtypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).listSourceSubtypesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint retrieves the subtypes for given subtypeIds. + * @summary Bulk Retrieve of Source Subtypes + * @param {MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public loadBulkSourceSubtypesV1(requestParameters: MachineAccountSubtypesV1ApiLoadBulkSourceSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).loadBulkSourceSubtypesV1(requestParameters.xSailPointExperimental, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. + * @summary Patch subtype by ID + * @param {MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public patchMachineAccountSubtypeV1(requestParameters: MachineAccountSubtypesV1ApiPatchMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).patchMachineAccountSubtypeV1(requestParameters.subtypeId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. + * @summary Machine Subtype Approval Config + * @param {MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountSubtypesV1Api + */ + public updateMachineAccountSubtypeApprovalConfigV1(requestParameters: MachineAccountSubtypesV1ApiUpdateMachineAccountSubtypeApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountSubtypesV1ApiFp(this.configuration).updateMachineAccountSubtypeApprovalConfigV1(requestParameters.xSailPointExperimental, requestParameters.subtypeId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_account_subtypes/base.ts b/sdk-output/machine_account_subtypes/base.ts new file mode 100644 index 00000000..fe492e32 --- /dev/null +++ b/sdk-output/machine_account_subtypes/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Subtypes + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_account_subtypes/common.ts b/sdk-output/machine_account_subtypes/common.ts new file mode 100644 index 00000000..abbefa19 --- /dev/null +++ b/sdk-output/machine_account_subtypes/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Subtypes + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_account_subtypes/configuration.ts b/sdk-output/machine_account_subtypes/configuration.ts new file mode 100644 index 00000000..84c6546d --- /dev/null +++ b/sdk-output/machine_account_subtypes/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Subtypes + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_account_subtypes/git_push.sh b/sdk-output/machine_account_subtypes/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_account_subtypes/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_account_subtypes/index.ts b/sdk-output/machine_account_subtypes/index.ts new file mode 100644 index 00000000..0615ec76 --- /dev/null +++ b/sdk-output/machine_account_subtypes/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Account Subtypes + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_account_subtypes/package.json b/sdk-output/machine_account_subtypes/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_account_subtypes/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_account_subtypes/tsconfig.json b/sdk-output/machine_account_subtypes/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_account_subtypes/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_accounts/.gitignore b/sdk-output/machine_accounts/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_accounts/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_accounts/.npmignore b/sdk-output/machine_accounts/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_accounts/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_accounts/.openapi-generator-ignore b/sdk-output/machine_accounts/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_accounts/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_accounts/.openapi-generator/FILES b/sdk-output/machine_accounts/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_accounts/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_accounts/.openapi-generator/VERSION b/sdk-output/machine_accounts/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_accounts/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_accounts/.sdk-partition b/sdk-output/machine_accounts/.sdk-partition new file mode 100644 index 00000000..8a05f7ec --- /dev/null +++ b/sdk-output/machine_accounts/.sdk-partition @@ -0,0 +1 @@ +machine-accounts \ No newline at end of file diff --git a/sdk-output/machine_accounts/README.md b/sdk-output/machine_accounts/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_accounts/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_accounts/api.ts b/sdk-output/machine_accounts/api.ts new file mode 100644 index 00000000..46910217 --- /dev/null +++ b/sdk-output/machine_accounts/api.ts @@ -0,0 +1,1534 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Accounts + * 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 BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface CreateMachineAccountSubtypeV1RequestV1 + */ +export interface CreateMachineAccountSubtypeV1RequestV1 { + /** + * Technical name of the subtype. + * @type {string} + * @memberof CreateMachineAccountSubtypeV1RequestV1 + */ + 'technicalName': string; + /** + * Display name of the subtype. + * @type {string} + * @memberof CreateMachineAccountSubtypeV1RequestV1 + */ + 'displayName': string; + /** + * Description of the subtype. + * @type {string} + * @memberof CreateMachineAccountSubtypeV1RequestV1 + */ + 'description': string; + /** + * Type of the subtype. + * @type {string} + * @memberof CreateMachineAccountSubtypeV1RequestV1 + */ + 'type'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListMachineAccountsV1401ResponseV1 + */ +export interface ListMachineAccountsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineAccountsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListMachineAccountsV1429ResponseV1 + */ +export interface ListMachineAccountsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineAccountsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MachineaccountV1 + */ +export interface MachineaccountV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineaccountV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof MachineaccountV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof MachineaccountV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof MachineaccountV1 + */ + 'modified'?: string; + /** + * A description of the machine account + * @type {string} + * @memberof MachineaccountV1 + */ + 'description'?: string | null; + /** + * The unique ID of the machine account generated by the source system + * @type {string} + * @memberof MachineaccountV1 + */ + 'nativeIdentity': string; + /** + * The unique ID of the account as determined by the account schema + * @type {string} + * @memberof MachineaccountV1 + */ + 'uuid'?: string | null; + /** + * Classification Method + * @type {string} + * @memberof MachineaccountV1 + */ + 'classificationMethod': MachineaccountV1ClassificationMethodV1; + /** + * The machine identity this account is associated with + * @type {any} + * @memberof MachineaccountV1 + */ + 'machineIdentity'?: any; + /** + * The identity who owns this account. + * @type {any} + * @memberof MachineaccountV1 + */ + 'ownerIdentity'?: any | null; + /** + * The connection type of the source this account is from + * @type {string} + * @memberof MachineaccountV1 + */ + 'accessType'?: string; + /** + * The sub-type + * @type {string} + * @memberof MachineaccountV1 + */ + 'subtype'?: string | null; + /** + * Environment + * @type {string} + * @memberof MachineaccountV1 + */ + 'environment'?: string | null; + /** + * Custom attributes specific to the machine account + * @type {{ [key: string]: any; }} + * @memberof MachineaccountV1 + */ + 'attributes'?: { [key: string]: any; } | null; + /** + * The connector attributes for the account + * @type {{ [key: string]: any; }} + * @memberof MachineaccountV1 + */ + 'connectorAttributes': { [key: string]: any; } | null; + /** + * Indicates if the account has been manually correlated to an identity + * @type {boolean} + * @memberof MachineaccountV1 + */ + 'manuallyCorrelated'?: boolean; + /** + * Indicates if the account has been manually edited + * @type {boolean} + * @memberof MachineaccountV1 + */ + 'manuallyEdited': boolean; + /** + * Indicates if the account is currently locked + * @type {boolean} + * @memberof MachineaccountV1 + */ + 'locked': boolean; + /** + * Indicates if the account is enabled + * @type {boolean} + * @memberof MachineaccountV1 + */ + 'enabled': boolean; + /** + * Indicates if the account has entitlements + * @type {boolean} + * @memberof MachineaccountV1 + */ + 'hasEntitlements': boolean; + /** + * The source this machine account belongs to. + * @type {any} + * @memberof MachineaccountV1 + */ + 'source': any; +} + +export const MachineaccountV1ClassificationMethodV1 = { + Source: 'SOURCE', + Criteria: 'CRITERIA', + Discovery: 'DISCOVERY', + Manual: 'MANUAL' +} as const; + +export type MachineaccountV1ClassificationMethodV1 = typeof MachineaccountV1ClassificationMethodV1[keyof typeof MachineaccountV1ClassificationMethodV1]; + +/** + * + * @export + * @interface SourcesubtypeV1 + */ +export interface SourcesubtypeV1 { + /** + * Unique identifier for the subtype. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'id'?: string; + /** + * The ID of the source. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'sourceId'?: string; + /** + * Technical name of the subtype. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'technicalName': string; + /** + * Display name of the subtype. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'displayName': string; + /** + * Description of the subtype. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'description': string; + /** + * Creation timestamp. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'created'?: string; + /** + * Last modified timestamp. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'modified'?: string; + /** + * Type of the subtype. Either MACHINE OR null. + * @type {string} + * @memberof SourcesubtypeV1 + */ + 'type'?: string; +} + +/** + * MachineAccountsV1Api - axios parameter creator + * @export + */ +export const MachineAccountsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new machine account subtype for a source. + * @summary Create subtype + * @param {string} sourceId The ID of the source. + * @param {CreateMachineAccountSubtypeV1RequestV1} createMachineAccountSubtypeV1RequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + createMachineAccountSubtypeV1: async (sourceId: string, createMachineAccountSubtypeV1RequestV1: CreateMachineAccountSubtypeV1RequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createMachineAccountSubtypeV1', 'sourceId', sourceId) + // verify required parameter 'createMachineAccountSubtypeV1RequestV1' is not null or undefined + assertParamExists('createMachineAccountSubtypeV1', 'createMachineAccountSubtypeV1RequestV1', createMachineAccountSubtypeV1RequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/subtypes` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createMachineAccountSubtypeV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a machine account subtype by source ID and technical name. + * @summary Delete subtype + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + deleteMachineAccountSubtypeByTechnicalNameV1: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteMachineAccountSubtypeByTechnicalNameV1', 'sourceId', sourceId) + // verify required parameter 'technicalName' is not null or undefined + assertParamExists('deleteMachineAccountSubtypeByTechnicalNameV1', 'technicalName', technicalName) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/subtypes/{technicalName}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a machine account subtype by its unique ID. + * @summary Retrieve subtype by subtype id + * @param {string} subtypeId The ID of the machine account subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getMachineAccountSubtypeByIdV1: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'subtypeId' is not null or undefined + assertParamExists('getMachineAccountSubtypeByIdV1', 'subtypeId', subtypeId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/subtypes/{subtypeId}` + .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a machine account subtype by source ID and technical name. + * @summary Retrieve subtype by source and technicalName + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getMachineAccountSubtypeByTechnicalNameV1: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getMachineAccountSubtypeByTechnicalNameV1', 'sourceId', sourceId) + // verify required parameter 'technicalName' is not null or undefined + assertParamExists('getMachineAccountSubtypeByTechnicalNameV1', 'technicalName', technicalName) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/subtypes/{technicalName}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to return the details for a single machine account by its ID. + * @summary Get machine account details + * @param {string} id Machine Account ID. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getMachineAccountV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-accounts/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get all machine account subtypes for a given source. + * @summary Retrieve all subtypes by source + * @param {string} sourceId The ID of the source. + * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* + * @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: **displayName, technicalName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + listMachineAccountSubtypesV1: async (sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('listMachineAccountSubtypesV1', 'sourceId', sourceId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/subtypes` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This returns a list of machine accounts. + * @summary List machine accounts + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineAccountsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-accounts/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. + * @summary Patch subtype + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + patchMachineAccountSubtypeByTechnicalNameV1: async (sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('patchMachineAccountSubtypeByTechnicalNameV1', 'sourceId', sourceId) + // verify required parameter 'technicalName' is not null or undefined + assertParamExists('patchMachineAccountSubtypeByTechnicalNameV1', 'technicalName', technicalName) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('patchMachineAccountSubtypeByTechnicalNameV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/subtypes/{technicalName}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update machine accounts details. + * @summary Update machine account details + * @param {string} id Machine Account ID. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountV1: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateMachineAccountV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('updateMachineAccountV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-accounts/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineAccountsV1Api - functional programming interface + * @export + */ +export const MachineAccountsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineAccountsV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new machine account subtype for a source. + * @summary Create subtype + * @param {string} sourceId The ID of the source. + * @param {CreateMachineAccountSubtypeV1RequestV1} createMachineAccountSubtypeV1RequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async createMachineAccountSubtypeV1(sourceId: string, createMachineAccountSubtypeV1RequestV1: CreateMachineAccountSubtypeV1RequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountSubtypeV1(sourceId, createMachineAccountSubtypeV1RequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.createMachineAccountSubtypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a machine account subtype by source ID and technical name. + * @summary Delete subtype + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async deleteMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.deleteMachineAccountSubtypeByTechnicalNameV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a machine account subtype by its unique ID. + * @summary Retrieve subtype by subtype id + * @param {string} subtypeId The ID of the machine account subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async getMachineAccountSubtypeByIdV1(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeByIdV1(subtypeId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.getMachineAccountSubtypeByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a machine account subtype by source ID and technical name. + * @summary Retrieve subtype by source and technicalName + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async getMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.getMachineAccountSubtypeByTechnicalNameV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to return the details for a single machine account by its ID. + * @summary Get machine account details + * @param {string} id Machine Account ID. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineAccountV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.getMachineAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get all machine account subtypes for a given source. + * @summary Retrieve all subtypes by source + * @param {string} sourceId The ID of the source. + * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* + * @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: **displayName, technicalName** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async listMachineAccountSubtypesV1(sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountSubtypesV1(sourceId, filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.listMachineAccountSubtypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This returns a list of machine accounts. + * @summary List machine accounts + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listMachineAccountsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountsV1(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.listMachineAccountsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. + * @summary Patch subtype + * @param {string} sourceId The ID of the source. + * @param {string} technicalName The technical name of the subtype. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async patchMachineAccountSubtypeByTechnicalNameV1(sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName, requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.patchMachineAccountSubtypeByTechnicalNameV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update machine accounts details. + * @summary Update machine account details + * @param {string} id Machine Account ID. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateMachineAccountV1(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccountV1(id, requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineAccountsV1Api.updateMachineAccountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineAccountsV1Api - factory interface + * @export + */ +export const MachineAccountsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineAccountsV1ApiFp(configuration) + return { + /** + * Create a new machine account subtype for a source. + * @summary Create subtype + * @param {MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + createMachineAccountSubtypeV1(requestParameters: MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createMachineAccountSubtypeV1(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeV1RequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a machine account subtype by source ID and technical name. + * @summary Delete subtype + * @param {MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a machine account subtype by its unique ID. + * @summary Retrieve subtype by subtype id + * @param {MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getMachineAccountSubtypeByIdV1(requestParameters: MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineAccountSubtypeByIdV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a machine account subtype by source ID and technical name. + * @summary Retrieve subtype by source and technicalName + * @param {MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to return the details for a single machine account by its ID. + * @summary Get machine account details + * @param {MachineAccountsV1ApiGetMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountV1(requestParameters: MachineAccountsV1ApiGetMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineAccountV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get all machine account subtypes for a given source. + * @summary Retrieve all subtypes by source + * @param {MachineAccountsV1ApiListMachineAccountSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + listMachineAccountSubtypesV1(requestParameters: MachineAccountsV1ApiListMachineAccountSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listMachineAccountSubtypesV1(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This returns a list of machine accounts. + * @summary List machine accounts + * @param {MachineAccountsV1ApiListMachineAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineAccountsV1(requestParameters: MachineAccountsV1ApiListMachineAccountsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listMachineAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. + * @summary Patch subtype + * @param {MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + patchMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update machine accounts details. + * @summary Update machine account details + * @param {MachineAccountsV1ApiUpdateMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountV1(requestParameters: MachineAccountsV1ApiUpdateMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateMachineAccountV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createMachineAccountSubtypeV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request + */ +export interface MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request { + /** + * The ID of the source. + * @type {string} + * @memberof MachineAccountsV1ApiCreateMachineAccountSubtypeV1 + */ + readonly sourceId: string + + /** + * + * @type {CreateMachineAccountSubtypeV1RequestV1} + * @memberof MachineAccountsV1ApiCreateMachineAccountSubtypeV1 + */ + readonly createMachineAccountSubtypeV1RequestV1: CreateMachineAccountSubtypeV1RequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiCreateMachineAccountSubtypeV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request + */ +export interface MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request { + /** + * The ID of the source. + * @type {string} + * @memberof MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1 + */ + readonly sourceId: string + + /** + * The technical name of the subtype. + * @type {string} + * @memberof MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1 + */ + readonly technicalName: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getMachineAccountSubtypeByIdV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request + */ +export interface MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request { + /** + * The ID of the machine account subtype. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1 + */ + readonly subtypeId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request + */ +export interface MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request { + /** + * The ID of the source. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1 + */ + readonly sourceId: string + + /** + * The technical name of the subtype. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1 + */ + readonly technicalName: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getMachineAccountV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiGetMachineAccountV1Request + */ +export interface MachineAccountsV1ApiGetMachineAccountV1Request { + /** + * Machine Account ID. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiGetMachineAccountV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listMachineAccountSubtypesV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiListMachineAccountSubtypesV1Request + */ +export interface MachineAccountsV1ApiListMachineAccountSubtypesV1Request { + /** + * The ID of the source. + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly sourceId: 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: **displayName**: *eq, sw* **technicalName**: *eq, sw* + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + 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: **displayName, technicalName** + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly xSailPointExperimental?: string + + /** + * 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 MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly count?: boolean + + /** + * 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 MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineAccountsV1ApiListMachineAccountSubtypesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listMachineAccountsV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiListMachineAccountsV1Request + */ +export interface MachineAccountsV1ApiListMachineAccountsV1Request { + /** + * 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 MachineAccountsV1ApiListMachineAccountsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineAccountsV1ApiListMachineAccountsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof MachineAccountsV1ApiListMachineAccountsV1 + */ + 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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountsV1 + */ + 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiListMachineAccountsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchMachineAccountSubtypeByTechnicalNameV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request + */ +export interface MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request { + /** + * The ID of the source. + * @type {string} + * @memberof MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1 + */ + readonly sourceId: string + + /** + * The technical name of the subtype. + * @type {string} + * @memberof MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1 + */ + readonly technicalName: string + + /** + * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateMachineAccountV1 operation in MachineAccountsV1Api. + * @export + * @interface MachineAccountsV1ApiUpdateMachineAccountV1Request + */ +export interface MachineAccountsV1ApiUpdateMachineAccountV1Request { + /** + * Machine Account ID. + * @type {string} + * @memberof MachineAccountsV1ApiUpdateMachineAccountV1 + */ + readonly id: string + + /** + * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + * @type {Array} + * @memberof MachineAccountsV1ApiUpdateMachineAccountV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineAccountsV1ApiUpdateMachineAccountV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * MachineAccountsV1Api - object-oriented interface + * @export + * @class MachineAccountsV1Api + * @extends {BaseAPI} + */ +export class MachineAccountsV1Api extends BaseAPI { + /** + * Create a new machine account subtype for a source. + * @summary Create subtype + * @param {MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public createMachineAccountSubtypeV1(requestParameters: MachineAccountsV1ApiCreateMachineAccountSubtypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).createMachineAccountSubtypeV1(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeV1RequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a machine account subtype by source ID and technical name. + * @summary Delete subtype + * @param {MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiDeleteMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).deleteMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a machine account subtype by its unique ID. + * @summary Retrieve subtype by subtype id + * @param {MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public getMachineAccountSubtypeByIdV1(requestParameters: MachineAccountsV1ApiGetMachineAccountSubtypeByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).getMachineAccountSubtypeByIdV1(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a machine account subtype by source ID and technical name. + * @summary Retrieve subtype by source and technicalName + * @param {MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public getMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiGetMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).getMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to return the details for a single machine account by its ID. + * @summary Get machine account details + * @param {MachineAccountsV1ApiGetMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public getMachineAccountV1(requestParameters: MachineAccountsV1ApiGetMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).getMachineAccountV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get all machine account subtypes for a given source. + * @summary Retrieve all subtypes by source + * @param {MachineAccountsV1ApiListMachineAccountSubtypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public listMachineAccountSubtypesV1(requestParameters: MachineAccountsV1ApiListMachineAccountSubtypesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).listMachineAccountSubtypesV1(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This returns a list of machine accounts. + * @summary List machine accounts + * @param {MachineAccountsV1ApiListMachineAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public listMachineAccountsV1(requestParameters: MachineAccountsV1ApiListMachineAccountsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).listMachineAccountsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. + * @summary Patch subtype + * @param {MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public patchMachineAccountSubtypeByTechnicalNameV1(requestParameters: MachineAccountsV1ApiPatchMachineAccountSubtypeByTechnicalNameV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).patchMachineAccountSubtypeByTechnicalNameV1(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update machine accounts details. + * @summary Update machine account details + * @param {MachineAccountsV1ApiUpdateMachineAccountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineAccountsV1Api + */ + public updateMachineAccountV1(requestParameters: MachineAccountsV1ApiUpdateMachineAccountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineAccountsV1ApiFp(this.configuration).updateMachineAccountV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_accounts/base.ts b/sdk-output/machine_accounts/base.ts new file mode 100644 index 00000000..bd1b3f3a --- /dev/null +++ b/sdk-output/machine_accounts/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Accounts + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_accounts/common.ts b/sdk-output/machine_accounts/common.ts new file mode 100644 index 00000000..3eedb564 --- /dev/null +++ b/sdk-output/machine_accounts/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Accounts + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_accounts/configuration.ts b/sdk-output/machine_accounts/configuration.ts new file mode 100644 index 00000000..d449df90 --- /dev/null +++ b/sdk-output/machine_accounts/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Accounts + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_accounts/git_push.sh b/sdk-output/machine_accounts/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_accounts/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_accounts/index.ts b/sdk-output/machine_accounts/index.ts new file mode 100644 index 00000000..be4516a9 --- /dev/null +++ b/sdk-output/machine_accounts/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Accounts + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_accounts/package.json b/sdk-output/machine_accounts/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_accounts/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_accounts/tsconfig.json b/sdk-output/machine_accounts/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_accounts/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_classification_config/.gitignore b/sdk-output/machine_classification_config/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_classification_config/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_classification_config/.npmignore b/sdk-output/machine_classification_config/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_classification_config/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_classification_config/.openapi-generator-ignore b/sdk-output/machine_classification_config/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_classification_config/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_classification_config/.openapi-generator/FILES b/sdk-output/machine_classification_config/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_classification_config/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_classification_config/.openapi-generator/VERSION b/sdk-output/machine_classification_config/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_classification_config/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_classification_config/.sdk-partition b/sdk-output/machine_classification_config/.sdk-partition new file mode 100644 index 00000000..2e496d56 --- /dev/null +++ b/sdk-output/machine_classification_config/.sdk-partition @@ -0,0 +1 @@ +machine-classification-config \ No newline at end of file diff --git a/sdk-output/machine_classification_config/README.md b/sdk-output/machine_classification_config/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_classification_config/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_classification_config/api.ts b/sdk-output/machine_classification_config/api.ts new file mode 100644 index 00000000..498746a1 --- /dev/null +++ b/sdk-output/machine_classification_config/api.ts @@ -0,0 +1,625 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Classification Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetMachineClassificationConfigV1401ResponseV1 + */ +export interface GetMachineClassificationConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMachineClassificationConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetMachineClassificationConfigV1429ResponseV1 + */ +export interface GetMachineClassificationConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMachineClassificationConfigV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MachineclassificationconfigV1 + */ +export interface MachineclassificationconfigV1 { + /** + * Indicates whether Classification is enabled for a Source + * @type {boolean} + * @memberof MachineclassificationconfigV1 + */ + 'enabled'?: boolean; + /** + * Classification Method + * @type {string} + * @memberof MachineclassificationconfigV1 + */ + 'classificationMethod'?: MachineclassificationconfigV1ClassificationMethodV1; + /** + * + * @type {Machineclassificationcriterialevel1V1} + * @memberof MachineclassificationconfigV1 + */ + 'criteria'?: Machineclassificationcriterialevel1V1; + /** + * Date the config was created + * @type {string} + * @memberof MachineclassificationconfigV1 + */ + 'created'?: string; + /** + * Date the config was last updated + * @type {string} + * @memberof MachineclassificationconfigV1 + */ + 'modified'?: string | null; +} + +export const MachineclassificationconfigV1ClassificationMethodV1 = { + Source: 'SOURCE', + Criteria: 'CRITERIA' +} as const; + +export type MachineclassificationconfigV1ClassificationMethodV1 = typeof MachineclassificationconfigV1ClassificationMethodV1[keyof typeof MachineclassificationconfigV1ClassificationMethodV1]; + +/** + * + * @export + * @interface Machineclassificationcriterialevel1V1 + */ +export interface Machineclassificationcriterialevel1V1 { + /** + * + * @type {MachineclassificationcriteriaoperationV1} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'operation'?: MachineclassificationcriteriaoperationV1; + /** + * Indicates whether case matters when evaluating the criteria + * @type {boolean} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'caseSensitive'?: boolean; + /** + * The data type of the attribute being evaluated + * @type {string} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'dataType'?: string | null; + /** + * The attribute to evaluate in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'attribute'?: string | null; + /** + * The value to compare against the attribute in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'value'?: string | null; + /** + * An array of child classification criteria objects + * @type {Array} + * @memberof Machineclassificationcriterialevel1V1 + */ + 'children'?: Array | null; +} + + +/** + * + * @export + * @interface Machineclassificationcriterialevel2V1 + */ +export interface Machineclassificationcriterialevel2V1 { + /** + * + * @type {MachineclassificationcriteriaoperationV1} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'operation'?: MachineclassificationcriteriaoperationV1; + /** + * Indicates whether case matters when evaluating the criteria + * @type {boolean} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'caseSensitive'?: boolean; + /** + * The data type of the attribute being evaluated + * @type {string} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'dataType'?: string | null; + /** + * The attribute to evaluate in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'attribute'?: string | null; + /** + * The value to compare against the attribute in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'value'?: string | null; + /** + * An array of child classification criteria objects + * @type {Array} + * @memberof Machineclassificationcriterialevel2V1 + */ + 'children'?: Array | null; +} + + +/** + * + * @export + * @interface Machineclassificationcriterialevel3V1 + */ +export interface Machineclassificationcriterialevel3V1 { + /** + * + * @type {MachineclassificationcriteriaoperationV1} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'operation'?: MachineclassificationcriteriaoperationV1; + /** + * Indicates whether or not case matters when evaluating the criteria + * @type {boolean} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'caseSensitive'?: boolean; + /** + * The data type of the attribute being evaluated + * @type {string} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'dataType'?: string | null; + /** + * The attribute to evaluate in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'attribute'?: string | null; + /** + * The value to compare against the attribute in the classification criteria + * @type {string} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'value'?: string | null; + /** + * An array of child classification criteria objects + * @type {Array} + * @memberof Machineclassificationcriterialevel3V1 + */ + 'children'?: Array | null; +} + + +/** + * An operation to perform on the classification criteria + * @export + * @enum {string} + */ + +export const MachineclassificationcriteriaoperationV1 = { + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + StartsWith: 'STARTS_WITH', + EndsWith: 'ENDS_WITH', + Contains: 'CONTAINS', + And: 'AND', + Or: 'OR' +} as const; + +export type MachineclassificationcriteriaoperationV1 = typeof MachineclassificationcriteriaoperationV1[keyof typeof MachineclassificationcriteriaoperationV1]; + + + +/** + * MachineClassificationConfigV1Api - axios parameter creator + * @export + */ +export const MachineClassificationConfigV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s classification config + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineClassificationConfigV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteMachineClassificationConfigV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/machine-classification-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a Machine Classification Config for a Source using Source ID. + * @summary Machine classification config for source + * @param {string} sourceId Source ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineClassificationConfigV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getMachineClassificationConfigV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/machine-classification-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s classification config + * @param {string} sourceId Source ID. + * @param {MachineclassificationconfigV1} machineclassificationconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMachineClassificationConfigV1: async (sourceId: string, machineclassificationconfigV1: MachineclassificationconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('setMachineClassificationConfigV1', 'sourceId', sourceId) + // verify required parameter 'machineclassificationconfigV1' is not null or undefined + assertParamExists('setMachineClassificationConfigV1', 'machineclassificationconfigV1', machineclassificationconfigV1) + const localVarPath = `/sources/v1/{sourceId}/machine-classification-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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: 'PUT', ...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(machineclassificationconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineClassificationConfigV1Api - functional programming interface + * @export + */ +export const MachineClassificationConfigV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineClassificationConfigV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s classification config + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMachineClassificationConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineClassificationConfigV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV1Api.deleteMachineClassificationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a Machine Classification Config for a Source using Source ID. + * @summary Machine classification config for source + * @param {string} sourceId Source ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineClassificationConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineClassificationConfigV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV1Api.getMachineClassificationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s classification config + * @param {string} sourceId Source ID. + * @param {MachineclassificationconfigV1} machineclassificationconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setMachineClassificationConfigV1(sourceId: string, machineclassificationconfigV1: MachineclassificationconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineClassificationConfigV1(sourceId, machineclassificationconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV1Api.setMachineClassificationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineClassificationConfigV1Api - factory interface + * @export + */ +export const MachineClassificationConfigV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineClassificationConfigV1ApiFp(configuration) + return { + /** + * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s classification config + * @param {MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMachineClassificationConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a Machine Classification Config for a Source using Source ID. + * @summary Machine classification config for source + * @param {MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineClassificationConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s classification config + * @param {MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setMachineClassificationConfigV1(requestParameters.sourceId, requestParameters.machineclassificationconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteMachineClassificationConfigV1 operation in MachineClassificationConfigV1Api. + * @export + * @interface MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request + */ +export interface MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request { + /** + * Source ID. + * @type {string} + * @memberof MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getMachineClassificationConfigV1 operation in MachineClassificationConfigV1Api. + * @export + * @interface MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request + */ +export interface MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request { + /** + * Source ID + * @type {string} + * @memberof MachineClassificationConfigV1ApiGetMachineClassificationConfigV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for setMachineClassificationConfigV1 operation in MachineClassificationConfigV1Api. + * @export + * @interface MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request + */ +export interface MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request { + /** + * Source ID. + * @type {string} + * @memberof MachineClassificationConfigV1ApiSetMachineClassificationConfigV1 + */ + readonly sourceId: string + + /** + * + * @type {MachineclassificationconfigV1} + * @memberof MachineClassificationConfigV1ApiSetMachineClassificationConfigV1 + */ + readonly machineclassificationconfigV1: MachineclassificationconfigV1 +} + +/** + * MachineClassificationConfigV1Api - object-oriented interface + * @export + * @class MachineClassificationConfigV1Api + * @extends {BaseAPI} + */ +export class MachineClassificationConfigV1Api extends BaseAPI { + /** + * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete source\'s classification config + * @param {MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineClassificationConfigV1Api + */ + public deleteMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiDeleteMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineClassificationConfigV1ApiFp(this.configuration).deleteMachineClassificationConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a Machine Classification Config for a Source using Source ID. + * @summary Machine classification config for source + * @param {MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineClassificationConfigV1Api + */ + public getMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiGetMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineClassificationConfigV1ApiFp(this.configuration).getMachineClassificationConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Update source\'s classification config + * @param {MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineClassificationConfigV1Api + */ + public setMachineClassificationConfigV1(requestParameters: MachineClassificationConfigV1ApiSetMachineClassificationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineClassificationConfigV1ApiFp(this.configuration).setMachineClassificationConfigV1(requestParameters.sourceId, requestParameters.machineclassificationconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_classification_config/base.ts b/sdk-output/machine_classification_config/base.ts new file mode 100644 index 00000000..98247bde --- /dev/null +++ b/sdk-output/machine_classification_config/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Classification Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_classification_config/common.ts b/sdk-output/machine_classification_config/common.ts new file mode 100644 index 00000000..13aab13c --- /dev/null +++ b/sdk-output/machine_classification_config/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Classification Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_classification_config/configuration.ts b/sdk-output/machine_classification_config/configuration.ts new file mode 100644 index 00000000..9211c2e7 --- /dev/null +++ b/sdk-output/machine_classification_config/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Classification Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_classification_config/git_push.sh b/sdk-output/machine_classification_config/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_classification_config/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_classification_config/index.ts b/sdk-output/machine_classification_config/index.ts new file mode 100644 index 00000000..b6c4562a --- /dev/null +++ b/sdk-output/machine_classification_config/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Classification Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_classification_config/package.json b/sdk-output/machine_classification_config/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_classification_config/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_classification_config/tsconfig.json b/sdk-output/machine_classification_config/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_classification_config/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/machine_identities/.gitignore b/sdk-output/machine_identities/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/machine_identities/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/machine_identities/.npmignore b/sdk-output/machine_identities/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/machine_identities/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/machine_identities/.openapi-generator-ignore b/sdk-output/machine_identities/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/machine_identities/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/machine_identities/.openapi-generator/FILES b/sdk-output/machine_identities/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/machine_identities/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/machine_identities/.openapi-generator/VERSION b/sdk-output/machine_identities/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/machine_identities/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/machine_identities/.sdk-partition b/sdk-output/machine_identities/.sdk-partition new file mode 100644 index 00000000..50290fdb --- /dev/null +++ b/sdk-output/machine_identities/.sdk-partition @@ -0,0 +1 @@ +machine-identities \ No newline at end of file diff --git a/sdk-output/machine_identities/README.md b/sdk-output/machine_identities/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_identities/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_identities/api.ts b/sdk-output/machine_identities/api.ts new file mode 100644 index 00000000..5e1a26ff --- /dev/null +++ b/sdk-output/machine_identities/api.ts @@ -0,0 +1,1813 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Identities + * 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 BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListMachineIdentitiesV1401ResponseV1 + */ +export interface ListMachineIdentitiesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineIdentitiesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListMachineIdentitiesV1429ResponseV1 + */ +export interface ListMachineIdentitiesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListMachineIdentitiesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Localized error message to indicate a failed invocation or error if any. + * @export + * @interface LocalizedmessageV1 + */ +export interface LocalizedmessageV1 { + /** + * Message locale + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'locale': string; + /** + * Message text + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'message': string; +} +/** + * The owner configuration associated to the machine identity + * @export + * @interface MachineIdentityDtoOwnersV1 + */ +export interface MachineIdentityDtoOwnersV1 { + /** + * Defines the identity which is selected as the primary owner + * @type {object} + * @memberof MachineIdentityDtoOwnersV1 + */ + 'primaryIdentity': object; + /** + * Defines the identities which are selected as secondary owners + * @type {Array} + * @memberof MachineIdentityDtoOwnersV1 + */ + 'secondaryIdentities': Array; +} +/** + * + * @export + * @interface MachineIdentityRequestUserEntitlementsV1 + */ +export interface MachineIdentityRequestUserEntitlementsV1 { + /** + * The ID of the entitlement + * @type {string} + * @memberof MachineIdentityRequestUserEntitlementsV1 + */ + 'entitlementId': string; + /** + * The source ID of the entitlement + * @type {string} + * @memberof MachineIdentityRequestUserEntitlementsV1 + */ + 'sourceId': string; +} +/** + * + * @export + * @interface MachineIdentityResponseUserEntitlementsV1 + */ +export interface MachineIdentityResponseUserEntitlementsV1 { + /** + * The source ID of the entitlement + * @type {string} + * @memberof MachineIdentityResponseUserEntitlementsV1 + */ + 'sourceId'?: string; + /** + * The ID of the entitlement + * @type {string} + * @memberof MachineIdentityResponseUserEntitlementsV1 + */ + 'entitlementId'?: string; + /** + * The display name of the entitlement + * @type {string} + * @memberof MachineIdentityResponseUserEntitlementsV1 + */ + 'displayName'?: string; + /** + * The source of the entitlement + * @type {object} + * @memberof MachineIdentityResponseUserEntitlementsV1 + */ + 'source'?: object; +} +/** + * + * @export + * @interface MachineidentityV1 + */ +export interface MachineidentityV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineidentityV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof MachineidentityV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof MachineidentityV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof MachineidentityV1 + */ + 'modified'?: string; + /** + * The native identity associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityV1 + */ + 'nativeIdentity': string; + /** + * Description of machine identity + * @type {string} + * @memberof MachineidentityV1 + */ + 'description'?: string; + /** + * A map of custom machine identity attributes + * @type {object} + * @memberof MachineidentityV1 + */ + 'attributes'?: object; + /** + * The subtype value associated to the machine identity + * @type {string} + * @memberof MachineidentityV1 + */ + 'subtype': string; + /** + * + * @type {MachineIdentityDtoOwnersV1} + * @memberof MachineidentityV1 + */ + 'owners'?: MachineIdentityDtoOwnersV1; + /** + * The source id associated to the machine identity + * @type {string} + * @memberof MachineidentityV1 + */ + 'sourceId'?: string; + /** + * The UUID associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityV1 + */ + 'uuid'?: string; +} +/** + * + * @export + * @interface MachineidentityaggregationrequestV1 + */ +export interface MachineidentityaggregationrequestV1 { + /** + * List of dataset Ids to aggregate machine identities + * @type {Array} + * @memberof MachineidentityaggregationrequestV1 + */ + 'datasetIds': Array; + /** + * Flag to disable optimization for the aggregation. Defaults to false when not provided. When set to true, it disables aggregation optimizations and may increase processing time. + * @type {boolean} + * @memberof MachineidentityaggregationrequestV1 + */ + 'disableOptimization'?: boolean; +} +/** + * The target(source) of the aggregation + * @export + * @interface MachineidentityaggregationresponseTargetV1 + */ +export interface MachineidentityaggregationresponseTargetV1 { + /** + * + * @type {DtotypeV1} + * @memberof MachineidentityaggregationresponseTargetV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof MachineidentityaggregationresponseTargetV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof MachineidentityaggregationresponseTargetV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface MachineidentityaggregationresponseV1 + */ +export interface MachineidentityaggregationresponseV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'id'?: string; + /** + * Type of task for aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'type'?: MachineidentityaggregationresponseV1TypeV1; + /** + * Name of the task for aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'uniqueName'?: string; + /** + * Description of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'description'?: string; + /** + * Name of the parent of the task for aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'parentName'?: string | null; + /** + * Service to execute the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'launcher'?: string; + /** + * + * @type {MachineidentityaggregationresponseTargetV1} + * @memberof MachineidentityaggregationresponseV1 + */ + 'target'?: MachineidentityaggregationresponseTargetV1; + /** + * Creation date of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'created'?: string; + /** + * Last modification date of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'modified'?: string; + /** + * Launch date of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'launched'?: string | null; + /** + * Completion date of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'completed'?: string | null; + /** + * + * @type {TaskdefinitionsummaryV1} + * @memberof MachineidentityaggregationresponseV1 + */ + 'taskDefinitionSummary'?: TaskdefinitionsummaryV1; + /** + * Completion status of the aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'completionStatus'?: MachineidentityaggregationresponseV1CompletionStatusV1 | null; + /** + * Messages associated with the aggregation + * @type {Array} + * @memberof MachineidentityaggregationresponseV1 + */ + 'messages'?: Array; + /** + * Return values associated with the aggregation + * @type {Array} + * @memberof MachineidentityaggregationresponseV1 + */ + 'returns'?: Array; + /** + * Attributes of the aggregation + * @type {{ [key: string]: any; }} + * @memberof MachineidentityaggregationresponseV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Current progress of aggregation + * @type {string} + * @memberof MachineidentityaggregationresponseV1 + */ + 'progress'?: string | null; + /** + * Current percentage completion of aggregation + * @type {number} + * @memberof MachineidentityaggregationresponseV1 + */ + 'percentComplete'?: number; +} + +export const MachineidentityaggregationresponseV1TypeV1 = { + Quartz: 'QUARTZ', + Qpoc: 'QPOC', + QueuedTask: 'QUEUED_TASK' +} as const; + +export type MachineidentityaggregationresponseV1TypeV1 = typeof MachineidentityaggregationresponseV1TypeV1[keyof typeof MachineidentityaggregationresponseV1TypeV1]; +export const MachineidentityaggregationresponseV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + Temperror: 'TEMPERROR' +} as const; + +export type MachineidentityaggregationresponseV1CompletionStatusV1 = typeof MachineidentityaggregationresponseV1CompletionStatusV1[keyof typeof MachineidentityaggregationresponseV1CompletionStatusV1]; + +/** + * + * @export + * @interface MachineidentityrequestV1 + */ +export interface MachineidentityrequestV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'modified'?: string; + /** + * The native identity associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'nativeIdentity': string; + /** + * Description of machine identity + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'description'?: string; + /** + * A map of custom machine identity attributes + * @type {object} + * @memberof MachineidentityrequestV1 + */ + 'attributes'?: object; + /** + * The subtype value associated to the machine identity + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'subtype': string; + /** + * + * @type {MachineIdentityDtoOwnersV1} + * @memberof MachineidentityrequestV1 + */ + 'owners'?: MachineIdentityDtoOwnersV1; + /** + * The source id associated to the machine identity + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'sourceId'?: string; + /** + * The UUID associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityrequestV1 + */ + 'uuid'?: string; + /** + * The user entitlements associated to the machine identity + * @type {Array} + * @memberof MachineidentityrequestV1 + */ + 'userEntitlements'?: Array; +} +/** + * + * @export + * @interface MachineidentityresponseV1 + */ +export interface MachineidentityresponseV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'modified'?: string; + /** + * The native identity associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'nativeIdentity': string; + /** + * Description of machine identity + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'description'?: string; + /** + * A map of custom machine identity attributes + * @type {object} + * @memberof MachineidentityresponseV1 + */ + 'attributes'?: object; + /** + * The subtype value associated to the machine identity + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'subtype': string; + /** + * + * @type {MachineIdentityDtoOwnersV1} + * @memberof MachineidentityresponseV1 + */ + 'owners'?: MachineIdentityDtoOwnersV1; + /** + * The source id associated to the machine identity + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'sourceId'?: string; + /** + * The UUID associated to the machine identity directly aggregated from a source + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'uuid'?: string; + /** + * Indicates if the machine identity has been manually edited + * @type {boolean} + * @memberof MachineidentityresponseV1 + */ + 'manuallyEdited'?: boolean; + /** + * Indicates if the machine identity has been manually created + * @type {boolean} + * @memberof MachineidentityresponseV1 + */ + 'manuallyCreated'?: boolean; + /** + * The source of the machine identity + * @type {object} + * @memberof MachineidentityresponseV1 + */ + 'source'?: object; + /** + * The dataset id associated to the source in which the identity was retrieved from + * @type {string} + * @memberof MachineidentityresponseV1 + */ + 'datasetId'?: string; + /** + * The user entitlements associated to the machine identity + * @type {Array} + * @memberof MachineidentityresponseV1 + */ + 'userEntitlements'?: Array; +} +/** + * The user entitlement + * @export + * @interface MachineidentityuserentitlementresponseEntitlementV1 + */ +export interface MachineidentityuserentitlementresponseEntitlementV1 { + /** + * + * @type {DtotypeV1} + * @memberof MachineidentityuserentitlementresponseEntitlementV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof MachineidentityuserentitlementresponseEntitlementV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof MachineidentityuserentitlementresponseEntitlementV1 + */ + 'name'?: string; +} + + +/** + * The source of the user entitlement + * @export + * @interface MachineidentityuserentitlementresponseSourceV1 + */ +export interface MachineidentityuserentitlementresponseSourceV1 { + /** + * + * @type {DtotypeV1} + * @memberof MachineidentityuserentitlementresponseSourceV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof MachineidentityuserentitlementresponseSourceV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof MachineidentityuserentitlementresponseSourceV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface MachineidentityuserentitlementresponseV1 + */ +export interface MachineidentityuserentitlementresponseV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof MachineidentityuserentitlementresponseV1 + */ + 'id'?: string; + /** + * System-generated unique ID of the Machine Identity + * @type {string} + * @memberof MachineidentityuserentitlementresponseV1 + */ + 'machineIdentityId'?: string; + /** + * + * @type {MachineidentityuserentitlementresponseSourceV1} + * @memberof MachineidentityuserentitlementresponseV1 + */ + 'source'?: MachineidentityuserentitlementresponseSourceV1; + /** + * + * @type {MachineidentityuserentitlementresponseEntitlementV1} + * @memberof MachineidentityuserentitlementresponseV1 + */ + 'entitlement'?: MachineidentityuserentitlementresponseEntitlementV1; + /** + * Creation date of the Object + * @type {string} + * @memberof MachineidentityuserentitlementresponseV1 + */ + 'created'?: string; +} +/** + * Definition of a type of task, used to invoke tasks + * @export + * @interface TaskdefinitionsummaryV1 + */ +export interface TaskdefinitionsummaryV1 { + /** + * System-generated unique ID of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'id': string; + /** + * Name of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'uniqueName': string; + /** + * Description of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'description': string | null; + /** + * Name of the parent of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'parentName': string; + /** + * Executor of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'executor': string | null; + /** + * Formal parameters of the TaskDefinition, without values + * @type {{ [key: string]: any; }} + * @memberof TaskdefinitionsummaryV1 + */ + 'arguments': { [key: string]: any; }; +} +/** + * Task return details + * @export + * @interface TaskreturndetailsV1 + */ +export interface TaskreturndetailsV1 { + /** + * Display name of the TaskReturnDetails + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'name': string; + /** + * Attribute the TaskReturnDetails is for + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'attributeName': string; +} +/** + * + * @export + * @interface TaskstatusmessageParametersInnerV1 + */ +export interface TaskstatusmessageParametersInnerV1 { +} +/** + * TaskStatus Message + * @export + * @interface TaskstatusmessageV1 + */ +export interface TaskstatusmessageV1 { + /** + * Type of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'type': TaskstatusmessageV1TypeV1; + /** + * + * @type {LocalizedmessageV1} + * @memberof TaskstatusmessageV1 + */ + 'localizedText': LocalizedmessageV1 | null; + /** + * Key of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'key': string; + /** + * Message parameters for internationalization + * @type {Array} + * @memberof TaskstatusmessageV1 + */ + 'parameters': Array | null; +} + +export const TaskstatusmessageV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type TaskstatusmessageV1TypeV1 = typeof TaskstatusmessageV1TypeV1[keyof typeof TaskstatusmessageV1TypeV1]; + + +/** + * MachineIdentitiesV1Api - axios parameter creator + * @export + */ +export const MachineIdentitiesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. + * @summary Create machine identity + * @param {MachineidentityrequestV1} machineidentityrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineIdentityV1: async (machineidentityrequestV1: MachineidentityrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'machineidentityrequestV1' is not null or undefined + assertParamExists('createMachineIdentityV1', 'machineidentityrequestV1', machineidentityrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identities/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(machineidentityrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The API returns successful response if the requested machine identity was deleted. + * @summary Delete machine identity + * @param {string} id Machine Identity ID + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteMachineIdentityV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identities/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a single machine identity using the Machine Identity ID. + * @summary Get machine identity details + * @param {string} id Machine Identity ID + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getMachineIdentityV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identities/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of machine identities. + * @summary List machine identities + * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* + * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineIdentitiesV1: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identities/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of user entitlements associated with machine identities. + * @summary List machine identity\'s user entitlements + * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* + * @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: **machineIdentityName, entitlement.name, source.name** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineIdentityUserEntitlementsV1: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identity-user-entitlements/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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Starts a machine identity (AI Agents) aggregation on the specified source. + * @summary Start machine identity aggregation + * @param {string} sourceId Source ID. + * @param {MachineidentityaggregationrequestV1} machineidentityaggregationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startMachineIdentityAggregationV1: async (sourceId: string, machineidentityaggregationrequestV1: MachineidentityaggregationrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('startMachineIdentityAggregationV1', 'sourceId', sourceId) + // verify required parameter 'machineidentityaggregationrequestV1' is not null or undefined + assertParamExists('startMachineIdentityAggregationV1', 'machineidentityaggregationrequestV1', machineidentityaggregationrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{sourceId}/aggregate-agents` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(machineidentityaggregationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update machine identity details. + * @summary Update machine identity details + * @param {string} id Machine Identity ID. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineIdentityV1: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateMachineIdentityV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('updateMachineIdentityV1', 'requestBody', requestBody) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/machine-identities/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MachineIdentitiesV1Api - functional programming interface + * @export + */ +export const MachineIdentitiesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MachineIdentitiesV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. + * @summary Create machine identity + * @param {MachineidentityrequestV1} machineidentityrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createMachineIdentityV1(machineidentityrequestV1: MachineidentityrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentityV1(machineidentityrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.createMachineIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The API returns successful response if the requested machine identity was deleted. + * @summary Delete machine identity + * @param {string} id Machine Identity ID + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMachineIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentityV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.deleteMachineIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a single machine identity using the Machine Identity ID. + * @summary Get machine identity details + * @param {string} id Machine Identity ID + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentityV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.getMachineIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of machine identities. + * @summary List machine identities + * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* + * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listMachineIdentitiesV1(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentitiesV1(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.listMachineIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of user entitlements associated with machine identities. + * @summary List machine identity\'s user entitlements + * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* + * @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: **machineIdentityName, entitlement.name, source.name** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listMachineIdentityUserEntitlementsV1(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentityUserEntitlementsV1(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.listMachineIdentityUserEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Starts a machine identity (AI Agents) aggregation on the specified source. + * @summary Start machine identity aggregation + * @param {string} sourceId Source ID. + * @param {MachineidentityaggregationrequestV1} machineidentityaggregationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startMachineIdentityAggregationV1(sourceId: string, machineidentityaggregationrequestV1: MachineidentityaggregationrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startMachineIdentityAggregationV1(sourceId, machineidentityaggregationrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.startMachineIdentityAggregationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update machine identity details. + * @summary Update machine identity details + * @param {string} id Machine Identity ID. + * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateMachineIdentityV1(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentityV1(id, requestBody, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV1Api.updateMachineIdentityV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MachineIdentitiesV1Api - factory interface + * @export + */ +export const MachineIdentitiesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MachineIdentitiesV1ApiFp(configuration) + return { + /** + * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. + * @summary Create machine identity + * @param {MachineIdentitiesV1ApiCreateMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiCreateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createMachineIdentityV1(requestParameters.machineidentityrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The API returns successful response if the requested machine identity was deleted. + * @summary Delete machine identity + * @param {MachineIdentitiesV1ApiDeleteMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiDeleteMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a single machine identity using the Machine Identity ID. + * @summary Get machine identity details + * @param {MachineIdentitiesV1ApiGetMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiGetMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of machine identities. + * @summary List machine identities + * @param {MachineIdentitiesV1ApiListMachineIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineIdentitiesV1(requestParameters: MachineIdentitiesV1ApiListMachineIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listMachineIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of user entitlements associated with machine identities. + * @summary List machine identity\'s user entitlements + * @param {MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listMachineIdentityUserEntitlementsV1(requestParameters: MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listMachineIdentityUserEntitlementsV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Starts a machine identity (AI Agents) aggregation on the specified source. + * @summary Start machine identity aggregation + * @param {MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startMachineIdentityAggregationV1(requestParameters: MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startMachineIdentityAggregationV1(requestParameters.sourceId, requestParameters.machineidentityaggregationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update machine identity details. + * @summary Update machine identity details + * @param {MachineIdentitiesV1ApiUpdateMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiUpdateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateMachineIdentityV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createMachineIdentityV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiCreateMachineIdentityV1Request + */ +export interface MachineIdentitiesV1ApiCreateMachineIdentityV1Request { + /** + * + * @type {MachineidentityrequestV1} + * @memberof MachineIdentitiesV1ApiCreateMachineIdentityV1 + */ + readonly machineidentityrequestV1: MachineidentityrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiCreateMachineIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteMachineIdentityV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiDeleteMachineIdentityV1Request + */ +export interface MachineIdentitiesV1ApiDeleteMachineIdentityV1Request { + /** + * Machine Identity ID + * @type {string} + * @memberof MachineIdentitiesV1ApiDeleteMachineIdentityV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiDeleteMachineIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getMachineIdentityV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiGetMachineIdentityV1Request + */ +export interface MachineIdentitiesV1ApiGetMachineIdentityV1Request { + /** + * Machine Identity ID + * @type {string} + * @memberof MachineIdentitiesV1ApiGetMachineIdentityV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiGetMachineIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listMachineIdentitiesV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiListMachineIdentitiesV1Request + */ +export interface MachineIdentitiesV1ApiListMachineIdentitiesV1Request { + /** + * 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + readonly xSailPointExperimental?: string + + /** + * 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 MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + readonly count?: boolean + + /** + * 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 MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineIdentitiesV1ApiListMachineIdentitiesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listMachineIdentityUserEntitlementsV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request + */ +export interface MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request { + /** + * 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + 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: **machineIdentityName, entitlement.name, source.name** + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + readonly xSailPointExperimental?: string + + /** + * 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 MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + readonly count?: boolean + + /** + * 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 MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1 + */ + readonly offset?: number +} + +/** + * Request parameters for startMachineIdentityAggregationV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request + */ +export interface MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request { + /** + * Source ID. + * @type {string} + * @memberof MachineIdentitiesV1ApiStartMachineIdentityAggregationV1 + */ + readonly sourceId: string + + /** + * + * @type {MachineidentityaggregationrequestV1} + * @memberof MachineIdentitiesV1ApiStartMachineIdentityAggregationV1 + */ + readonly machineidentityaggregationrequestV1: MachineidentityaggregationrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiStartMachineIdentityAggregationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateMachineIdentityV1 operation in MachineIdentitiesV1Api. + * @export + * @interface MachineIdentitiesV1ApiUpdateMachineIdentityV1Request + */ +export interface MachineIdentitiesV1ApiUpdateMachineIdentityV1Request { + /** + * Machine Identity ID. + * @type {string} + * @memberof MachineIdentitiesV1ApiUpdateMachineIdentityV1 + */ + readonly id: string + + /** + * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof MachineIdentitiesV1ApiUpdateMachineIdentityV1 + */ + readonly requestBody: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof MachineIdentitiesV1ApiUpdateMachineIdentityV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * MachineIdentitiesV1Api - object-oriented interface + * @export + * @class MachineIdentitiesV1Api + * @extends {BaseAPI} + */ +export class MachineIdentitiesV1Api extends BaseAPI { + /** + * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. + * @summary Create machine identity + * @param {MachineIdentitiesV1ApiCreateMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public createMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiCreateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).createMachineIdentityV1(requestParameters.machineidentityrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The API returns successful response if the requested machine identity was deleted. + * @summary Delete machine identity + * @param {MachineIdentitiesV1ApiDeleteMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public deleteMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiDeleteMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).deleteMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a single machine identity using the Machine Identity ID. + * @summary Get machine identity details + * @param {MachineIdentitiesV1ApiGetMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public getMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiGetMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).getMachineIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of machine identities. + * @summary List machine identities + * @param {MachineIdentitiesV1ApiListMachineIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public listMachineIdentitiesV1(requestParameters: MachineIdentitiesV1ApiListMachineIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).listMachineIdentitiesV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of user entitlements associated with machine identities. + * @summary List machine identity\'s user entitlements + * @param {MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public listMachineIdentityUserEntitlementsV1(requestParameters: MachineIdentitiesV1ApiListMachineIdentityUserEntitlementsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).listMachineIdentityUserEntitlementsV1(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Starts a machine identity (AI Agents) aggregation on the specified source. + * @summary Start machine identity aggregation + * @param {MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public startMachineIdentityAggregationV1(requestParameters: MachineIdentitiesV1ApiStartMachineIdentityAggregationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).startMachineIdentityAggregationV1(requestParameters.sourceId, requestParameters.machineidentityaggregationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update machine identity details. + * @summary Update machine identity details + * @param {MachineIdentitiesV1ApiUpdateMachineIdentityV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MachineIdentitiesV1Api + */ + public updateMachineIdentityV1(requestParameters: MachineIdentitiesV1ApiUpdateMachineIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MachineIdentitiesV1ApiFp(this.configuration).updateMachineIdentityV1(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/machine_identities/base.ts b/sdk-output/machine_identities/base.ts new file mode 100644 index 00000000..337a3538 --- /dev/null +++ b/sdk-output/machine_identities/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Identities + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/machine_identities/common.ts b/sdk-output/machine_identities/common.ts new file mode 100644 index 00000000..532b61ee --- /dev/null +++ b/sdk-output/machine_identities/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Identities + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/machine_identities/configuration.ts b/sdk-output/machine_identities/configuration.ts new file mode 100644 index 00000000..0597cda0 --- /dev/null +++ b/sdk-output/machine_identities/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Identities + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/machine_identities/git_push.sh b/sdk-output/machine_identities/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/machine_identities/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/machine_identities/index.ts b/sdk-output/machine_identities/index.ts new file mode 100644 index 00000000..6f9a3a10 --- /dev/null +++ b/sdk-output/machine_identities/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Machine Identities + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/machine_identities/package.json b/sdk-output/machine_identities/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/machine_identities/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/machine_identities/tsconfig.json b/sdk-output/machine_identities/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/machine_identities/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/managed_clients/.gitignore b/sdk-output/managed_clients/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/managed_clients/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/managed_clients/.npmignore b/sdk-output/managed_clients/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/managed_clients/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/managed_clients/.openapi-generator-ignore b/sdk-output/managed_clients/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/managed_clients/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/managed_clients/.openapi-generator/FILES b/sdk-output/managed_clients/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/managed_clients/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/managed_clients/.openapi-generator/VERSION b/sdk-output/managed_clients/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/managed_clients/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/managed_clients/.sdk-partition b/sdk-output/managed_clients/.sdk-partition new file mode 100644 index 00000000..59c39254 --- /dev/null +++ b/sdk-output/managed_clients/.sdk-partition @@ -0,0 +1 @@ +managed-clients \ No newline at end of file diff --git a/sdk-output/managed_clients/README.md b/sdk-output/managed_clients/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_clients/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_clients/api.ts b/sdk-output/managed_clients/api.ts new file mode 100644 index 00000000..4aa39a81 --- /dev/null +++ b/sdk-output/managed_clients/api.ts @@ -0,0 +1,1456 @@ +/* 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetManagedClientsV1401ResponseV1 + */ +export interface GetManagedClientsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClientsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetManagedClientsV1429ResponseV1 + */ +export interface GetManagedClientsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClientsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * Individual error or warning event + * @export + * @interface HealtheventV1 + */ +export interface HealtheventV1 { + /** + * Description of the issue + * @type {string} + * @memberof HealtheventV1 + */ + 'detailedMessage'?: string; + /** + * Unique identifier for the health event + * @type {string} + * @memberof HealtheventV1 + */ + 'uuid'?: string; + /** + * Optional URL associated with the issue + * @type {string} + * @memberof HealtheventV1 + */ + 'url'?: string | null; + /** + * Time when the event occurred + * @type {string} + * @memberof HealtheventV1 + */ + 'timestamp'?: string; + /** + * Last time notification was sent for this issue + * @type {string} + * @memberof HealtheventV1 + */ + 'lastNotifiedTimeStamp'?: string; + /** + * CPU usage percentage + * @type {number} + * @memberof HealtheventV1 + */ + 'cpuUtilizationPercentage'?: number | null; + /** + * Free memory percentage + * @type {number} + * @memberof HealtheventV1 + */ + 'freeSpacePercentage'?: number | null; +} +/** + * Health indicator category data with errors and warnings + * @export + * @interface HealthindicatorcategoryV1 + */ +export interface HealthindicatorcategoryV1 { + /** + * List of error events for this category + * @type {Array} + * @memberof HealthindicatorcategoryV1 + */ + 'errors'?: Array; + /** + * List of warning events for this category + * @type {Array} + * @memberof HealthindicatorcategoryV1 + */ + 'warnings'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Managed Client + * @export + * @interface ManagedclientV1 + */ +export interface ManagedclientV1 { + /** + * ManagedClient ID + * @type {string} + * @memberof ManagedclientV1 + */ + 'id'?: string | null; + /** + * ManagedClient alert key + * @type {string} + * @memberof ManagedclientV1 + */ + 'alertKey'?: string | null; + /** + * + * @type {string} + * @memberof ManagedclientV1 + */ + 'apiGatewayBaseUrl'?: string | null; + /** + * + * @type {string} + * @memberof ManagedclientV1 + */ + 'cookbook'?: string | null; + /** + * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) + * @type {number} + * @memberof ManagedclientV1 + */ + 'ccId'?: number | null; + /** + * The client ID used in API management + * @type {string} + * @memberof ManagedclientV1 + */ + 'clientId': string; + /** + * Cluster ID that the ManagedClient is linked to + * @type {string} + * @memberof ManagedclientV1 + */ + 'clusterId': string; + /** + * ManagedClient description + * @type {string} + * @memberof ManagedclientV1 + */ + 'description': string; + /** + * The public IP address of the ManagedClient + * @type {string} + * @memberof ManagedclientV1 + */ + 'ipAddress'?: string | null; + /** + * When the ManagedClient was last seen by the server + * @type {string} + * @memberof ManagedclientV1 + */ + 'lastSeen'?: string | null; + /** + * ManagedClient name + * @type {string} + * @memberof ManagedclientV1 + */ + 'name'?: string | null; + /** + * Milliseconds since the ManagedClient has polled the server + * @type {string} + * @memberof ManagedclientV1 + */ + 'sinceLastSeen'?: string | null; + /** + * Status of the ManagedClient + * @type {string} + * @memberof ManagedclientV1 + */ + 'status'?: ManagedclientV1StatusV1 | null; + /** + * Type of the ManagedClient (VA, CCG) + * @type {string} + * @memberof ManagedclientV1 + */ + 'type': string; + /** + * Cluster Type of the ManagedClient + * @type {string} + * @memberof ManagedclientV1 + */ + 'clusterType'?: ManagedclientV1ClusterTypeV1 | null; + /** + * ManagedClient VA download URL + * @type {string} + * @memberof ManagedclientV1 + */ + 'vaDownloadUrl'?: string | null; + /** + * Version that the ManagedClient\'s VA is running + * @type {string} + * @memberof ManagedclientV1 + */ + 'vaVersion'?: string | null; + /** + * Client\'s apiKey + * @type {string} + * @memberof ManagedclientV1 + */ + 'secret'?: string | null; + /** + * The date/time this ManagedClient was created + * @type {string} + * @memberof ManagedclientV1 + */ + 'createdAt'?: string | null; + /** + * The date/time this ManagedClient was last updated + * @type {string} + * @memberof ManagedclientV1 + */ + 'updatedAt'?: string | null; + /** + * The provisioning status of the ManagedClient + * @type {string} + * @memberof ManagedclientV1 + */ + 'provisionStatus'?: ManagedclientV1ProvisionStatusV1 | null; +} + +export const ManagedclientV1StatusV1 = { + Normal: 'NORMAL', + Undefined: 'UNDEFINED', + NotConfigured: 'NOT_CONFIGURED', + Configuring: 'CONFIGURING', + Warning: 'WARNING', + Error: 'ERROR', + Failed: 'FAILED' +} as const; + +export type ManagedclientV1StatusV1 = typeof ManagedclientV1StatusV1[keyof typeof ManagedclientV1StatusV1]; +export const ManagedclientV1ClusterTypeV1 = { + Idn: 'idn', + Iai: 'iai', + SpConnectCluster: 'spConnectCluster', + SqsCluster: 'sqsCluster', + DasRc: 'das-rc', + DasPc: 'das-pc', + DasDc: 'das-dc' +} as const; + +export type ManagedclientV1ClusterTypeV1 = typeof ManagedclientV1ClusterTypeV1[keyof typeof ManagedclientV1ClusterTypeV1]; +export const ManagedclientV1ProvisionStatusV1 = { + Provisioned: 'PROVISIONED', + Draft: 'DRAFT' +} as const; + +export type ManagedclientV1ProvisionStatusV1 = typeof ManagedclientV1ProvisionStatusV1[keyof typeof ManagedclientV1ProvisionStatusV1]; + +/** + * Health indicators grouped by category + * @export + * @interface ManagedclienthealthindicatorsBodyHealthIndicatorsV1 + */ +export interface ManagedclienthealthindicatorsBodyHealthIndicatorsV1 { + /** + * + * @type {HealthindicatorcategoryV1} + * @memberof ManagedclienthealthindicatorsBodyHealthIndicatorsV1 + */ + 'container'?: HealthindicatorcategoryV1; + /** + * + * @type {HealthindicatorcategoryV1} + * @memberof ManagedclienthealthindicatorsBodyHealthIndicatorsV1 + */ + 'memory'?: HealthindicatorcategoryV1; + /** + * + * @type {HealthindicatorcategoryV1} + * @memberof ManagedclienthealthindicatorsBodyHealthIndicatorsV1 + */ + 'cpu'?: HealthindicatorcategoryV1; +} +/** + * Health indicator details from the Managed Client + * @export + * @interface ManagedclienthealthindicatorsBodyV1 + */ +export interface ManagedclienthealthindicatorsBodyV1 { + /** + * Health indicator alert key + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'alertKey'?: string | null; + /** + * Unique identifier for the health report + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'id': string; + /** + * Cluster ID the health report belongs to + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'clusterId': string; + /** + * API user ID sending the health data + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'apiUser': string; + /** + * ETag value for CCG version control + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'ccg_etag'?: string | null; + /** + * PIN value for CCG validation + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'ccg_pin'?: string | null; + /** + * ETag for cookbook version + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'cookbook_etag'?: string | null; + /** + * Hostname of the Managed Client + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'hostname': string; + /** + * Internal IP address of the Managed Client + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'internal_ip'?: string; + /** + * Epoch timestamp (in millis) when last seen + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'lastSeen'?: string; + /** + * Seconds since last seen + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'sinceSeen'?: string; + /** + * Milliseconds since last seen + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'sinceSeenMillis'?: string; + /** + * Indicates if this is a local development instance + * @type {boolean} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'localDev'?: boolean; + /** + * Stacktrace associated with any error, if available + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'stacktrace'?: string | null; + /** + * Optional state value from the client + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'state'?: string | null; + /** + * Status of the client at the time of report + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'status': ManagedclienthealthindicatorsBodyV1StatusV1; + /** + * Optional UUID from the client + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'uuid'?: string | null; + /** + * Product type (e.g., idn) + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'product': string; + /** + * VA version installed on the client + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'va_version'?: string | null; + /** + * Version of the platform on which VA is running + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'platform_version': string; + /** + * Operating system version + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'os_version': string; + /** + * Operating system type + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'os_type': string; + /** + * Virtualization platform used + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'hypervisor': string; + /** + * Consolidated health indicator status + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'consolidatedHealthIndicatorsStatus': ManagedclienthealthindicatorsBodyV1ConsolidatedHealthIndicatorsStatusV1; + /** + * The last CCG version for which notification was sent + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'lastNotifiedCcgVersion'?: string; + /** + * Information about deployed processes + * @type {string} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'deployed_processes'?: string | null; + /** + * + * @type {ManagedclienthealthindicatorsBodyHealthIndicatorsV1} + * @memberof ManagedclienthealthindicatorsBodyV1 + */ + 'health_indicators': ManagedclienthealthindicatorsBodyHealthIndicatorsV1; +} + +export const ManagedclienthealthindicatorsBodyV1StatusV1 = { + Normal: 'NORMAL', + Undefined: 'UNDEFINED', + Warning: 'WARNING', + Error: 'ERROR', + Failed: 'FAILED' +} as const; + +export type ManagedclienthealthindicatorsBodyV1StatusV1 = typeof ManagedclienthealthindicatorsBodyV1StatusV1[keyof typeof ManagedclienthealthindicatorsBodyV1StatusV1]; +export const ManagedclienthealthindicatorsBodyV1ConsolidatedHealthIndicatorsStatusV1 = { + Normal: 'NORMAL', + Warning: 'WARNING', + Error: 'ERROR' +} as const; + +export type ManagedclienthealthindicatorsBodyV1ConsolidatedHealthIndicatorsStatusV1 = typeof ManagedclienthealthindicatorsBodyV1ConsolidatedHealthIndicatorsStatusV1[keyof typeof ManagedclienthealthindicatorsBodyV1ConsolidatedHealthIndicatorsStatusV1]; + +/** + * Health Indicators for a Managed Client + * @export + * @interface ManagedclienthealthindicatorsV1 + */ +export interface ManagedclienthealthindicatorsV1 { + /** + * + * @type {ManagedclienthealthindicatorsBodyV1} + * @memberof ManagedclienthealthindicatorsV1 + */ + 'body': ManagedclienthealthindicatorsBodyV1; + /** + * Top-level status of the Managed Client + * @type {string} + * @memberof ManagedclienthealthindicatorsV1 + */ + 'status': ManagedclienthealthindicatorsV1StatusV1; + /** + * Type of the Managed Client + * @type {string} + * @memberof ManagedclienthealthindicatorsV1 + */ + 'type': ManagedclienthealthindicatorsV1TypeV1; + /** + * Timestamp when this report was generated + * @type {string} + * @memberof ManagedclienthealthindicatorsV1 + */ + 'timestamp': string; +} + +export const ManagedclienthealthindicatorsV1StatusV1 = { + Normal: 'NORMAL', + Undefined: 'UNDEFINED', + Warning: 'WARNING', + Error: 'ERROR', + Failed: 'FAILED' +} as const; + +export type ManagedclienthealthindicatorsV1StatusV1 = typeof ManagedclienthealthindicatorsV1StatusV1[keyof typeof ManagedclienthealthindicatorsV1StatusV1]; +export const ManagedclienthealthindicatorsV1TypeV1 = { + Va: 'VA', + Ccg: 'CCG' +} as const; + +export type ManagedclienthealthindicatorsV1TypeV1 = typeof ManagedclienthealthindicatorsV1TypeV1[keyof typeof ManagedclienthealthindicatorsV1TypeV1]; + +/** + * Managed Client Request + * @export + * @interface ManagedclientrequestV1 + */ +export interface ManagedclientrequestV1 { + /** + * Cluster ID that the ManagedClient is linked to + * @type {string} + * @memberof ManagedclientrequestV1 + */ + 'clusterId': string; + /** + * description for the ManagedClient to create + * @type {string} + * @memberof ManagedclientrequestV1 + */ + 'description'?: string | null; + /** + * name for the ManagedClient to create + * @type {string} + * @memberof ManagedclientrequestV1 + */ + 'name'?: string | null; + /** + * Type of the ManagedClient (VA, CCG) to create + * @type {string} + * @memberof ManagedclientrequestV1 + */ + 'type'?: string | null; +} +/** + * Managed Client Status + * @export + * @interface ManagedclientstatusV1 + */ +export interface ManagedclientstatusV1 { + /** + * ManagedClientStatus body information + * @type {object} + * @memberof ManagedclientstatusV1 + */ + 'body': object; + /** + * + * @type {ManagedclientstatuscodeV1} + * @memberof ManagedclientstatusV1 + */ + 'status': ManagedclientstatuscodeV1; + /** + * + * @type {ManagedclienttypeV1} + * @memberof ManagedclientstatusV1 + */ + 'type': ManagedclienttypeV1 | null; + /** + * timestamp on the Client Status update + * @type {string} + * @memberof ManagedclientstatusV1 + */ + 'timestamp': string; +} + + +/** + * Status of a Managed Client + * @export + * @enum {string} + */ + +export const ManagedclientstatuscodeV1 = { + Normal: 'NORMAL', + Undefined: 'UNDEFINED', + NotConfigured: 'NOT_CONFIGURED', + Configuring: 'CONFIGURING', + Warning: 'WARNING', + Error: 'ERROR', + Failed: 'FAILED' +} as const; + +export type ManagedclientstatuscodeV1 = typeof ManagedclientstatuscodeV1[keyof typeof ManagedclientstatuscodeV1]; + + +/** + * Managed Client type + * @export + * @enum {string} + */ + +export const ManagedclienttypeV1 = { + Ccg: 'CCG', + Va: 'VA', + Internal: 'INTERNAL', + IiqHarvester: 'IIQ_HARVESTER' +} as const; + +export type ManagedclienttypeV1 = typeof ManagedclienttypeV1[keyof typeof ManagedclienttypeV1]; + + + +/** + * ManagedClientsV1Api - axios parameter creator + * @export + */ +export const ManagedClientsV1ApiAxiosParamCreator = 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 {ManagedclientrequestV1} managedclientrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClientV1: async (managedclientrequestV1: ManagedclientrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'managedclientrequestV1' is not null or undefined + assertParamExists('createManagedClientV1', 'managedclientrequestV1', managedclientrequestV1) + 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(managedclientrequestV1, 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 {ManagedclienttypeV1} type Managed client type to get status for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClientStatusV1: async (id: string, type: ManagedclienttypeV1, 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} jsonpatchoperationV1 JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClientV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateManagedClientV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateManagedClientV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ManagedClientsV1Api - functional programming interface + * @export + */ +export const ManagedClientsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ManagedClientsV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new managed client. The API returns a result that includes the managed client ID. + * @summary Create managed client + * @param {ManagedclientrequestV1} managedclientrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createManagedClientV1(managedclientrequestV1: ManagedclientrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClientV1(managedclientrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClientsV1Api.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['ManagedClientsV1Api.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['ManagedClientsV1Api.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 {ManagedclienttypeV1} type Managed client type to get status for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManagedClientStatusV1(id: string, type: ManagedclienttypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatusV1(id, type, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClientsV1Api.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['ManagedClientsV1Api.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['ManagedClientsV1Api.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} jsonpatchoperationV1 JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateManagedClientV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClientV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClientsV1Api.updateManagedClientV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ManagedClientsV1Api - factory interface + * @export + */ +export const ManagedClientsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ManagedClientsV1ApiFp(configuration) + return { + /** + * Create a new managed client. The API returns a result that includes the managed client ID. + * @summary Create managed client + * @param {ManagedClientsV1ApiCreateManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClientV1(requestParameters: ManagedClientsV1ApiCreateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createManagedClientV1(requestParameters.managedclientrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an existing managed client. + * @summary Delete managed client + * @param {ManagedClientsV1ApiDeleteManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteManagedClientV1(requestParameters: ManagedClientsV1ApiDeleteManagedClientV1Request, 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 {ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClientHealthIndicatorsV1(requestParameters: ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request, 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 {ManagedClientsV1ApiGetManagedClientStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClientStatusV1(requestParameters: ManagedClientsV1ApiGetManagedClientStatusV1Request, 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 {ManagedClientsV1ApiGetManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClientV1(requestParameters: ManagedClientsV1ApiGetManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List managed clients. + * @summary Get managed clients + * @param {ManagedClientsV1ApiGetManagedClientsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClientsV1(requestParameters: ManagedClientsV1ApiGetManagedClientsV1Request = {}, 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 {ManagedClientsV1ApiUpdateManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClientV1(requestParameters: ManagedClientsV1ApiUpdateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateManagedClientV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createManagedClientV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiCreateManagedClientV1Request + */ +export interface ManagedClientsV1ApiCreateManagedClientV1Request { + /** + * + * @type {ManagedclientrequestV1} + * @memberof ManagedClientsV1ApiCreateManagedClientV1 + */ + readonly managedclientrequestV1: ManagedclientrequestV1 +} + +/** + * Request parameters for deleteManagedClientV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiDeleteManagedClientV1Request + */ +export interface ManagedClientsV1ApiDeleteManagedClientV1Request { + /** + * Managed client ID. + * @type {string} + * @memberof ManagedClientsV1ApiDeleteManagedClientV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClientHealthIndicatorsV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request + */ +export interface ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request { + /** + * Managed client ID to get health indicators for. + * @type {string} + * @memberof ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClientStatusV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiGetManagedClientStatusV1Request + */ +export interface ManagedClientsV1ApiGetManagedClientStatusV1Request { + /** + * Managed client ID to get status for. + * @type {string} + * @memberof ManagedClientsV1ApiGetManagedClientStatusV1 + */ + readonly id: string + + /** + * Managed client type to get status for. + * @type {ManagedclienttypeV1} + * @memberof ManagedClientsV1ApiGetManagedClientStatusV1 + */ + readonly type: ManagedclienttypeV1 +} + +/** + * Request parameters for getManagedClientV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiGetManagedClientV1Request + */ +export interface ManagedClientsV1ApiGetManagedClientV1Request { + /** + * Managed client ID. + * @type {string} + * @memberof ManagedClientsV1ApiGetManagedClientV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClientsV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiGetManagedClientsV1Request + */ +export interface ManagedClientsV1ApiGetManagedClientsV1Request { + /** + * 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 ManagedClientsV1ApiGetManagedClientsV1 + */ + 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 ManagedClientsV1ApiGetManagedClientsV1 + */ + 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 ManagedClientsV1ApiGetManagedClientsV1 + */ + 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 ManagedClientsV1ApiGetManagedClientsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for updateManagedClientV1 operation in ManagedClientsV1Api. + * @export + * @interface ManagedClientsV1ApiUpdateManagedClientV1Request + */ +export interface ManagedClientsV1ApiUpdateManagedClientV1Request { + /** + * Managed client ID. + * @type {string} + * @memberof ManagedClientsV1ApiUpdateManagedClientV1 + */ + readonly id: string + + /** + * JSONPatch payload used to update the object. + * @type {Array} + * @memberof ManagedClientsV1ApiUpdateManagedClientV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * ManagedClientsV1Api - object-oriented interface + * @export + * @class ManagedClientsV1Api + * @extends {BaseAPI} + */ +export class ManagedClientsV1Api extends BaseAPI { + /** + * Create a new managed client. The API returns a result that includes the managed client ID. + * @summary Create managed client + * @param {ManagedClientsV1ApiCreateManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public createManagedClientV1(requestParameters: ManagedClientsV1ApiCreateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(this.configuration).createManagedClientV1(requestParameters.managedclientrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an existing managed client. + * @summary Delete managed client + * @param {ManagedClientsV1ApiDeleteManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public deleteManagedClientV1(requestParameters: ManagedClientsV1ApiDeleteManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(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 {ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public getManagedClientHealthIndicatorsV1(requestParameters: ManagedClientsV1ApiGetManagedClientHealthIndicatorsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(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 {ManagedClientsV1ApiGetManagedClientStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public getManagedClientStatusV1(requestParameters: ManagedClientsV1ApiGetManagedClientStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(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 {ManagedClientsV1ApiGetManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public getManagedClientV1(requestParameters: ManagedClientsV1ApiGetManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(this.configuration).getManagedClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List managed clients. + * @summary Get managed clients + * @param {ManagedClientsV1ApiGetManagedClientsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public getManagedClientsV1(requestParameters: ManagedClientsV1ApiGetManagedClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(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 {ManagedClientsV1ApiUpdateManagedClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClientsV1Api + */ + public updateManagedClientV1(requestParameters: ManagedClientsV1ApiUpdateManagedClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClientsV1ApiFp(this.configuration).updateManagedClientV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/managed_clients/base.ts b/sdk-output/managed_clients/base.ts new file mode 100644 index 00000000..77f60c51 --- /dev/null +++ b/sdk-output/managed_clients/base.ts @@ -0,0 +1,86 @@ +/* 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/managed_clients/common.ts b/sdk-output/managed_clients/common.ts new file mode 100644 index 00000000..3d514434 --- /dev/null +++ b/sdk-output/managed_clients/common.ts @@ -0,0 +1,183 @@ +/* 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/managed_clients/configuration.ts b/sdk-output/managed_clients/configuration.ts new file mode 100644 index 00000000..1601f435 --- /dev/null +++ b/sdk-output/managed_clients/configuration.ts @@ -0,0 +1,110 @@ +/* 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/managed_clients/git_push.sh b/sdk-output/managed_clients/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/managed_clients/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/managed_clients/index.ts b/sdk-output/managed_clients/index.ts new file mode 100644 index 00000000..d26762c6 --- /dev/null +++ b/sdk-output/managed_clients/index.ts @@ -0,0 +1,18 @@ +/* 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/managed_clients/package.json b/sdk-output/managed_clients/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/managed_clients/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/managed_clients/tsconfig.json b/sdk-output/managed_clients/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/managed_clients/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/managed_cluster_types/.gitignore b/sdk-output/managed_cluster_types/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/managed_cluster_types/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/managed_cluster_types/.npmignore b/sdk-output/managed_cluster_types/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/managed_cluster_types/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/managed_cluster_types/.openapi-generator-ignore b/sdk-output/managed_cluster_types/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/managed_cluster_types/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/managed_cluster_types/.openapi-generator/FILES b/sdk-output/managed_cluster_types/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/managed_cluster_types/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/managed_cluster_types/.openapi-generator/VERSION b/sdk-output/managed_cluster_types/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/managed_cluster_types/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/managed_cluster_types/.sdk-partition b/sdk-output/managed_cluster_types/.sdk-partition new file mode 100644 index 00000000..7088ddd3 --- /dev/null +++ b/sdk-output/managed_cluster_types/.sdk-partition @@ -0,0 +1 @@ +managed-cluster-types \ No newline at end of file diff --git a/sdk-output/managed_cluster_types/README.md b/sdk-output/managed_cluster_types/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_cluster_types/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_cluster_types/api.ts b/sdk-output/managed_cluster_types/api.ts new file mode 100644 index 00000000..203a6a09 --- /dev/null +++ b/sdk-output/managed_cluster_types/api.ts @@ -0,0 +1,748 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Cluster Types + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetManagedClusterTypesV1401ResponseV1 + */ +export interface GetManagedClusterTypesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClusterTypesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetManagedClusterTypesV1429ResponseV1 + */ +export interface GetManagedClusterTypesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClusterTypesV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchV1 + */ +export interface JsonpatchV1 { + /** + * Operations to be applied + * @type {Array} + * @memberof JsonpatchV1 + */ + 'operations'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Managed Cluster Type for Cluster upgrade configuration information + * @export + * @interface ManagedclustertypeV1 + */ +export interface ManagedclustertypeV1 { + /** + * ManagedClusterType ID + * @type {string} + * @memberof ManagedclustertypeV1 + */ + 'id'?: string; + /** + * ManagedClusterType type name + * @type {string} + * @memberof ManagedclustertypeV1 + */ + 'type': string; + /** + * ManagedClusterType pod + * @type {string} + * @memberof ManagedclustertypeV1 + */ + 'pod': string; + /** + * ManagedClusterType org + * @type {string} + * @memberof ManagedclustertypeV1 + */ + 'org': string; + /** + * List of processes for the cluster type + * @type {Array} + * @memberof ManagedclustertypeV1 + */ + 'managedProcessIds'?: Array; +} + +/** + * ManagedClusterTypesV1Api - axios parameter creator + * @export + */ +export const ManagedClusterTypesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID + * @summary Create new managed cluster type + * @param {ManagedclustertypeV1} managedclustertypeV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClusterTypeV1: async (managedclustertypeV1: ManagedclustertypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'managedclustertypeV1' is not null or undefined + assertParamExists('createManagedClusterTypeV1', 'managedclustertypeV1', managedclustertypeV1) + const localVarPath = `/managed-cluster-types/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(managedclustertypeV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an existing Managed Cluster Type. + * @summary Delete a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteManagedClusterTypeV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteManagedClusterTypeV1', 'id', id) + const localVarPath = `/managed-cluster-types/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 Cluster Type. + * @summary Get a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterTypeV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getManagedClusterTypeV1', 'id', id) + const localVarPath = `/managed-cluster-types/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, + }; + }, + /** + * Get a list of Managed Cluster Types. + * @summary List managed cluster types + * @param {string} [type] Type descriptor + * @param {string} [pod] Pinned pod (or default) + * @param {string} [org] Pinned org (or default) + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterTypesV1: async (type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/managed-cluster-types/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 (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (pod !== undefined) { + localVarQueryParameter['pod'] = pod; + } + + if (org !== undefined) { + localVarQueryParameter['org'] = org; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + 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 Cluster Type. + * @summary Update a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {JsonpatchV1} jsonpatchV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClusterTypeV1: async (id: string, jsonpatchV1: JsonpatchV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateManagedClusterTypeV1', 'id', id) + // verify required parameter 'jsonpatchV1' is not null or undefined + assertParamExists('updateManagedClusterTypeV1', 'jsonpatchV1', jsonpatchV1) + const localVarPath = `/managed-cluster-types/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(jsonpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ManagedClusterTypesV1Api - functional programming interface + * @export + */ +export const ManagedClusterTypesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ManagedClusterTypesV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID + * @summary Create new managed cluster type + * @param {ManagedclustertypeV1} managedclustertypeV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createManagedClusterTypeV1(managedclustertypeV1: ManagedclustertypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClusterTypeV1(managedclustertypeV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV1Api.createManagedClusterTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an existing Managed Cluster Type. + * @summary Delete a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteManagedClusterTypeV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClusterTypeV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV1Api.deleteManagedClusterTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a Managed Cluster Type. + * @summary Get a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManagedClusterTypeV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterTypeV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV1Api.getManagedClusterTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of Managed Cluster Types. + * @summary List managed cluster types + * @param {string} [type] Type descriptor + * @param {string} [pod] Pinned pod (or default) + * @param {string} [org] Pinned org (or default) + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManagedClusterTypesV1(type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterTypesV1(type, pod, org, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV1Api.getManagedClusterTypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing Managed Cluster Type. + * @summary Update a managed cluster type + * @param {string} id The Managed Cluster Type ID + * @param {JsonpatchV1} jsonpatchV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateManagedClusterTypeV1(id: string, jsonpatchV1: JsonpatchV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClusterTypeV1(id, jsonpatchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV1Api.updateManagedClusterTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ManagedClusterTypesV1Api - factory interface + * @export + */ +export const ManagedClusterTypesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ManagedClusterTypesV1ApiFp(configuration) + return { + /** + * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID + * @summary Create new managed cluster type + * @param {ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createManagedClusterTypeV1(requestParameters.managedclustertypeV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an existing Managed Cluster Type. + * @summary Delete a managed cluster type + * @param {ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteManagedClusterTypeV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a Managed Cluster Type. + * @summary Get a managed cluster type + * @param {ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getManagedClusterTypeV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of Managed Cluster Types. + * @summary List managed cluster types + * @param {ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterTypesV1(requestParameters: ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getManagedClusterTypesV1(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing Managed Cluster Type. + * @summary Update a managed cluster type + * @param {ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateManagedClusterTypeV1(requestParameters.id, requestParameters.jsonpatchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createManagedClusterTypeV1 operation in ManagedClusterTypesV1Api. + * @export + * @interface ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request + */ +export interface ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request { + /** + * + * @type {ManagedclustertypeV1} + * @memberof ManagedClusterTypesV1ApiCreateManagedClusterTypeV1 + */ + readonly managedclustertypeV1: ManagedclustertypeV1 +} + +/** + * Request parameters for deleteManagedClusterTypeV1 operation in ManagedClusterTypesV1Api. + * @export + * @interface ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request + */ +export interface ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request { + /** + * The Managed Cluster Type ID + * @type {string} + * @memberof ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClusterTypeV1 operation in ManagedClusterTypesV1Api. + * @export + * @interface ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request + */ +export interface ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request { + /** + * The Managed Cluster Type ID + * @type {string} + * @memberof ManagedClusterTypesV1ApiGetManagedClusterTypeV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClusterTypesV1 operation in ManagedClusterTypesV1Api. + * @export + * @interface ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request + */ +export interface ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request { + /** + * Type descriptor + * @type {string} + * @memberof ManagedClusterTypesV1ApiGetManagedClusterTypesV1 + */ + readonly type?: string + + /** + * Pinned pod (or default) + * @type {string} + * @memberof ManagedClusterTypesV1ApiGetManagedClusterTypesV1 + */ + readonly pod?: string + + /** + * Pinned org (or default) + * @type {string} + * @memberof ManagedClusterTypesV1ApiGetManagedClusterTypesV1 + */ + readonly org?: string + + /** + * 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 ManagedClusterTypesV1ApiGetManagedClusterTypesV1 + */ + 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 ManagedClusterTypesV1ApiGetManagedClusterTypesV1 + */ + readonly limit?: number +} + +/** + * Request parameters for updateManagedClusterTypeV1 operation in ManagedClusterTypesV1Api. + * @export + * @interface ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request + */ +export interface ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request { + /** + * The Managed Cluster Type ID + * @type {string} + * @memberof ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1 + */ + readonly id: string + + /** + * The JSONPatch payload used to update the schema. + * @type {JsonpatchV1} + * @memberof ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1 + */ + readonly jsonpatchV1: JsonpatchV1 +} + +/** + * ManagedClusterTypesV1Api - object-oriented interface + * @export + * @class ManagedClusterTypesV1Api + * @extends {BaseAPI} + */ +export class ManagedClusterTypesV1Api extends BaseAPI { + /** + * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID + * @summary Create new managed cluster type + * @param {ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClusterTypesV1Api + */ + public createManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiCreateManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClusterTypesV1ApiFp(this.configuration).createManagedClusterTypeV1(requestParameters.managedclustertypeV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an existing Managed Cluster Type. + * @summary Delete a managed cluster type + * @param {ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClusterTypesV1Api + */ + public deleteManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiDeleteManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClusterTypesV1ApiFp(this.configuration).deleteManagedClusterTypeV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a Managed Cluster Type. + * @summary Get a managed cluster type + * @param {ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClusterTypesV1Api + */ + public getManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiGetManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClusterTypesV1ApiFp(this.configuration).getManagedClusterTypeV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of Managed Cluster Types. + * @summary List managed cluster types + * @param {ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClusterTypesV1Api + */ + public getManagedClusterTypesV1(requestParameters: ManagedClusterTypesV1ApiGetManagedClusterTypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClusterTypesV1ApiFp(this.configuration).getManagedClusterTypesV1(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing Managed Cluster Type. + * @summary Update a managed cluster type + * @param {ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClusterTypesV1Api + */ + public updateManagedClusterTypeV1(requestParameters: ManagedClusterTypesV1ApiUpdateManagedClusterTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClusterTypesV1ApiFp(this.configuration).updateManagedClusterTypeV1(requestParameters.id, requestParameters.jsonpatchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/managed_cluster_types/base.ts b/sdk-output/managed_cluster_types/base.ts new file mode 100644 index 00000000..96bd961d --- /dev/null +++ b/sdk-output/managed_cluster_types/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Cluster Types + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/managed_cluster_types/common.ts b/sdk-output/managed_cluster_types/common.ts new file mode 100644 index 00000000..5c5baa26 --- /dev/null +++ b/sdk-output/managed_cluster_types/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Cluster Types + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/managed_cluster_types/configuration.ts b/sdk-output/managed_cluster_types/configuration.ts new file mode 100644 index 00000000..0b2e595d --- /dev/null +++ b/sdk-output/managed_cluster_types/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Cluster Types + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/managed_cluster_types/git_push.sh b/sdk-output/managed_cluster_types/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/managed_cluster_types/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/managed_cluster_types/index.ts b/sdk-output/managed_cluster_types/index.ts new file mode 100644 index 00000000..e57a6ad9 --- /dev/null +++ b/sdk-output/managed_cluster_types/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Cluster Types + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/managed_cluster_types/package.json b/sdk-output/managed_cluster_types/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/managed_cluster_types/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/managed_cluster_types/tsconfig.json b/sdk-output/managed_cluster_types/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/managed_cluster_types/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/managed_clusters/.gitignore b/sdk-output/managed_clusters/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/managed_clusters/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/managed_clusters/.npmignore b/sdk-output/managed_clusters/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/managed_clusters/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/managed_clusters/.openapi-generator-ignore b/sdk-output/managed_clusters/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/managed_clusters/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/managed_clusters/.openapi-generator/FILES b/sdk-output/managed_clusters/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/managed_clusters/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/managed_clusters/.openapi-generator/VERSION b/sdk-output/managed_clusters/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/managed_clusters/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/managed_clusters/.sdk-partition b/sdk-output/managed_clusters/.sdk-partition new file mode 100644 index 00000000..89847b37 --- /dev/null +++ b/sdk-output/managed_clusters/.sdk-partition @@ -0,0 +1 @@ +managed-clusters \ No newline at end of file diff --git a/sdk-output/managed_clusters/README.md b/sdk-output/managed_clusters/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_clusters/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_clusters/api.ts b/sdk-output/managed_clusters/api.ts new file mode 100644 index 00000000..7e6c098d --- /dev/null +++ b/sdk-output/managed_clusters/api.ts @@ -0,0 +1,1769 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Clusters + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Client Runtime Logging Configuration + * @export + * @interface ClientlogconfigurationV1 + */ +export interface ClientlogconfigurationV1 { + /** + * Log configuration\'s client ID + * @type {string} + * @memberof ClientlogconfigurationV1 + */ + 'clientId'?: string; + /** + * Duration in minutes for log configuration to remain in effect before resetting to defaults. + * @type {number} + * @memberof ClientlogconfigurationV1 + */ + 'durationMinutes'?: number; + /** + * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. + * @type {string} + * @memberof ClientlogconfigurationV1 + */ + 'expiration'?: string; + /** + * + * @type {StandardlevelV1} + * @memberof ClientlogconfigurationV1 + */ + 'rootLevel': StandardlevelV1; + /** + * Mapping of identifiers to Standard Log Level values + * @type {{ [key: string]: StandardlevelV1; }} + * @memberof ClientlogconfigurationV1 + */ + 'logLevels'?: { [key: string]: StandardlevelV1; }; +} + + +/** + * Client Runtime Logging Configuration + * @export + * @interface ClientlogconfigurationdurationminutesV1 + */ +export interface ClientlogconfigurationdurationminutesV1 { + /** + * Log configuration\'s client ID + * @type {string} + * @memberof ClientlogconfigurationdurationminutesV1 + */ + 'clientId'?: string; + /** + * Duration in minutes for log configuration to remain in effect before resetting to defaults. + * @type {number} + * @memberof ClientlogconfigurationdurationminutesV1 + */ + 'durationMinutes'?: number; + /** + * + * @type {StandardlevelV1} + * @memberof ClientlogconfigurationdurationminutesV1 + */ + 'rootLevel': StandardlevelV1; + /** + * Mapping of identifiers to Standard Log Level values + * @type {{ [key: string]: StandardlevelV1; }} + * @memberof ClientlogconfigurationdurationminutesV1 + */ + 'logLevels'?: { [key: string]: StandardlevelV1; }; +} + + +/** + * Client Runtime Logging Configuration + * @export + * @interface ClientlogconfigurationexpirationV1 + */ +export interface ClientlogconfigurationexpirationV1 { + /** + * Log configuration\'s client ID + * @type {string} + * @memberof ClientlogconfigurationexpirationV1 + */ + 'clientId'?: string; + /** + * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. + * @type {string} + * @memberof ClientlogconfigurationexpirationV1 + */ + 'expiration'?: string; + /** + * + * @type {StandardlevelV1} + * @memberof ClientlogconfigurationexpirationV1 + */ + 'rootLevel': StandardlevelV1; + /** + * Mapping of identifiers to Standard Log Level values + * @type {{ [key: string]: StandardlevelV1; }} + * @memberof ClientlogconfigurationexpirationV1 + */ + 'logLevels'?: { [key: string]: StandardlevelV1; }; +} + + +/** + * Configuration details for the \'ccg\' process. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 { + /** + * Version of the \'ccg\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ + 'version': string; + /** + * Path to the \'ccg\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ + 'path': string; + /** + * A brief description of the \'ccg\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ + 'description': string; + /** + * Indicates whether the process needs to be restarted. + * @type {boolean} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ + 'restartNeeded': boolean; + /** + * A map of dependencies for the \'ccg\' process. + * @type {{ [key: string]: string; }} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + */ + 'dependencies': { [key: string]: string; }; +} +/** + * Configuration details for the \'charon\' process. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 { + /** + * Version of the \'charon\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + */ + 'version': string; + /** + * Path to the \'charon\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + */ + 'path': string; + /** + * A brief description of the \'charon\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + */ + 'description': string; + /** + * Indicates whether the process needs to be restarted. + * @type {boolean} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + */ + 'restartNeeded': boolean; +} +/** + * Configuration details for the \'otel_agent\' process. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 { + /** + * Version of the \'otel_agent\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + */ + 'version': string; + /** + * Path to the \'otel_agent\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + */ + 'path': string; + /** + * A brief description of the \'otel_agent\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + */ + 'description': string; + /** + * Indicates whether the process needs to be restarted. + * @type {boolean} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + */ + 'restartNeeded': boolean; +} +/** + * Configuration details for the \'relay\' process. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 { + /** + * Version of the \'relay\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + */ + 'version': string; + /** + * Path to the \'relay\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + */ + 'path': string; + /** + * A brief description of the \'relay\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + */ + 'description': string; + /** + * Indicates whether the process needs to be restarted. + * @type {boolean} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + */ + 'restartNeeded': boolean; +} +/** + * Configuration details for the \'toolbox\' process. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 { + /** + * Version of the \'toolbox\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + */ + 'version': string; + /** + * Path to the \'toolbox\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + */ + 'path': string; + /** + * A brief description of the \'toolbox\' process. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + */ + 'description': string; + /** + * Indicates whether the process needs to be restarted. + * @type {boolean} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + */ + 'restartNeeded': boolean; +} +/** + * Configuration of the managed processes involved in the upgrade. + * @export + * @interface ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ +export interface ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 { + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ + 'charon'?: ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1; + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ + 'ccg'?: ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1; + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ + 'otel_agent'?: ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1; + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ + 'relay'?: ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1; + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1} + * @memberof ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + */ + 'toolbox'?: ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1; +} +/** + * + * @export + * @interface ClustermanualupgradeJobsInnerV1 + */ +export interface ClustermanualupgradeJobsInnerV1 { + /** + * Unique identifier for the upgrade job. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'uuid': string; + /** + * Identifier for the cookbook used in the upgrade job. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'cookbook': string; + /** + * Current state of the upgrade job. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'state': string; + /** + * The type of upgrade job (e.g., VA_UPGRADE). + * @type {string} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'type': string; + /** + * Unique identifier of the target for the upgrade job. + * @type {string} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'targetId': string; + /** + * + * @type {ClustermanualupgradeJobsInnerManagedProcessConfigurationV1} + * @memberof ClustermanualupgradeJobsInnerV1 + */ + 'managedProcessConfiguration': ClustermanualupgradeJobsInnerManagedProcessConfigurationV1; +} +/** + * Manual Upgrade Job Response + * @export + * @interface ClustermanualupgradeV1 + */ +export interface ClustermanualupgradeV1 { + /** + * List of job objects for the upgrade request. + * @type {Array} + * @memberof ClustermanualupgradeV1 + */ + 'jobs'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetManagedClustersV1401ResponseV1 + */ +export interface GetManagedClustersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClustersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetManagedClustersV1429ResponseV1 + */ +export interface GetManagedClustersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetManagedClustersV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Managed Client type + * @export + * @enum {string} + */ + +export const ManagedclienttypeV1 = { + Ccg: 'CCG', + Va: 'VA', + Internal: 'INTERNAL', + IiqHarvester: 'IIQ_HARVESTER' +} as const; + +export type ManagedclienttypeV1 = typeof ManagedclienttypeV1[keyof typeof ManagedclienttypeV1]; + + +/** + * The preference for applying updates for the cluster + * @export + * @interface ManagedclusterUpdatePreferencesV1 + */ +export interface ManagedclusterUpdatePreferencesV1 { + /** + * The processGroups for updatePreferences + * @type {string} + * @memberof ManagedclusterUpdatePreferencesV1 + */ + 'processGroups'?: string | null; + /** + * The current updateState for the cluster + * @type {string} + * @memberof ManagedclusterUpdatePreferencesV1 + */ + 'updateState'?: ManagedclusterUpdatePreferencesV1UpdateStateV1 | null; + /** + * The mail id to which new releases will be notified + * @type {string} + * @memberof ManagedclusterUpdatePreferencesV1 + */ + 'notificationEmail'?: string | null; +} + +export const ManagedclusterUpdatePreferencesV1UpdateStateV1 = { + Auto: 'AUTO', + Disabled: 'DISABLED' +} as const; + +export type ManagedclusterUpdatePreferencesV1UpdateStateV1 = typeof ManagedclusterUpdatePreferencesV1UpdateStateV1[keyof typeof ManagedclusterUpdatePreferencesV1UpdateStateV1]; + +/** + * Managed Cluster + * @export + * @interface ManagedclusterV1 + */ +export interface ManagedclusterV1 { + /** + * ManagedCluster ID + * @type {string} + * @memberof ManagedclusterV1 + */ + 'id': string; + /** + * ManagedCluster name + * @type {string} + * @memberof ManagedclusterV1 + */ + 'name'?: string; + /** + * ManagedCluster pod + * @type {string} + * @memberof ManagedclusterV1 + */ + 'pod'?: string; + /** + * ManagedCluster org + * @type {string} + * @memberof ManagedclusterV1 + */ + 'org'?: string; + /** + * + * @type {ManagedclustertypesV1} + * @memberof ManagedclusterV1 + */ + 'type'?: ManagedclustertypesV1; + /** + * ManagedProcess configuration map + * @type {{ [key: string]: string | null; }} + * @memberof ManagedclusterV1 + */ + 'configuration'?: { [key: string]: string | null; }; + /** + * + * @type {ManagedclusterkeypairV1} + * @memberof ManagedclusterV1 + */ + 'keyPair'?: ManagedclusterkeypairV1; + /** + * + * @type {ManagedclusterattributesV1} + * @memberof ManagedclusterV1 + */ + 'attributes'?: ManagedclusterattributesV1; + /** + * ManagedCluster description + * @type {string} + * @memberof ManagedclusterV1 + */ + 'description'?: string; + /** + * + * @type {ManagedclusterredisV1} + * @memberof ManagedclusterV1 + */ + 'redis'?: ManagedclusterredisV1; + /** + * + * @type {ManagedclienttypeV1} + * @memberof ManagedclusterV1 + */ + 'clientType': ManagedclienttypeV1 | null; + /** + * CCG version used by the ManagedCluster + * @type {string} + * @memberof ManagedclusterV1 + */ + 'ccgVersion': string; + /** + * boolean flag indicating whether or not the cluster configuration is pinned + * @type {boolean} + * @memberof ManagedclusterV1 + */ + 'pinnedConfig'?: boolean; + /** + * + * @type {ClientlogconfigurationV1} + * @memberof ManagedclusterV1 + */ + 'logConfiguration'?: ClientlogconfigurationV1 | null; + /** + * Whether or not the cluster is operational or not + * @type {boolean} + * @memberof ManagedclusterV1 + */ + 'operational'?: boolean; + /** + * Cluster status + * @type {string} + * @memberof ManagedclusterV1 + */ + 'status'?: ManagedclusterV1StatusV1; + /** + * Public key certificate + * @type {string} + * @memberof ManagedclusterV1 + */ + 'publicKeyCertificate'?: string | null; + /** + * Public key thumbprint + * @type {string} + * @memberof ManagedclusterV1 + */ + 'publicKeyThumbprint'?: string | null; + /** + * Public key + * @type {string} + * @memberof ManagedclusterV1 + */ + 'publicKey'?: string | null; + /** + * + * @type {ManagedclusterencryptionconfigV1} + * @memberof ManagedclusterV1 + */ + 'encryptionConfiguration'?: ManagedclusterencryptionconfigV1; + /** + * Key describing any immediate cluster alerts + * @type {string} + * @memberof ManagedclusterV1 + */ + 'alertKey'?: string; + /** + * List of clients in a cluster + * @type {Array} + * @memberof ManagedclusterV1 + */ + 'clientIds'?: Array; + /** + * Number of services bound to a cluster + * @type {number} + * @memberof ManagedclusterV1 + */ + 'serviceCount'?: number; + /** + * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished + * @type {string} + * @memberof ManagedclusterV1 + */ + 'ccId'?: string; + /** + * The date/time this cluster was created + * @type {string} + * @memberof ManagedclusterV1 + */ + 'createdAt'?: string | null; + /** + * The date/time this cluster was last updated + * @type {string} + * @memberof ManagedclusterV1 + */ + 'updatedAt'?: string | null; + /** + * The date/time this cluster was notified for the last release + * @type {string} + * @memberof ManagedclusterV1 + */ + 'lastReleaseNotifiedAt'?: string | null; + /** + * + * @type {ManagedclusterUpdatePreferencesV1} + * @memberof ManagedclusterV1 + */ + 'updatePreferences'?: ManagedclusterUpdatePreferencesV1; + /** + * The current installed release on the Managed cluster + * @type {string} + * @memberof ManagedclusterV1 + */ + 'currentInstalledReleaseVersion'?: string | null; + /** + * New available updates for the Managed cluster + * @type {string} + * @memberof ManagedclusterV1 + */ + 'updatePackage'?: string | null; + /** + * The time at which out of date notification was sent for the Managed cluster + * @type {string} + * @memberof ManagedclusterV1 + */ + 'isOutOfDateNotifiedAt'?: string | null; + /** + * The consolidated Health Status for the Managed cluster + * @type {string} + * @memberof ManagedclusterV1 + */ + 'consolidatedHealthIndicatorsStatus'?: ManagedclusterV1ConsolidatedHealthIndicatorsStatusV1 | null; +} + +export const ManagedclusterV1StatusV1 = { + Configuring: 'CONFIGURING', + Failed: 'FAILED', + NoClients: 'NO_CLIENTS', + Normal: 'NORMAL', + Warning: 'WARNING' +} as const; + +export type ManagedclusterV1StatusV1 = typeof ManagedclusterV1StatusV1[keyof typeof ManagedclusterV1StatusV1]; +export const ManagedclusterV1ConsolidatedHealthIndicatorsStatusV1 = { + Normal: 'NORMAL', + Warning: 'WARNING', + Error: 'ERROR' +} as const; + +export type ManagedclusterV1ConsolidatedHealthIndicatorsStatusV1 = typeof ManagedclusterV1ConsolidatedHealthIndicatorsStatusV1[keyof typeof ManagedclusterV1ConsolidatedHealthIndicatorsStatusV1]; + +/** + * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] + * @export + * @interface ManagedclusterattributesV1 + */ +export interface ManagedclusterattributesV1 { + /** + * + * @type {ManagedclusterqueueV1} + * @memberof ManagedclusterattributesV1 + */ + 'queue'?: ManagedclusterqueueV1; + /** + * ManagedCluster keystore for spConnectCluster type + * @type {string} + * @memberof ManagedclusterattributesV1 + */ + 'keystore'?: string | null; +} +/** + * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. + * @export + * @interface ManagedclusterencryptionconfigV1 + */ +export interface ManagedclusterencryptionconfigV1 { + /** + * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. + * @type {string} + * @memberof ManagedclusterencryptionconfigV1 + */ + 'format'?: ManagedclusterencryptionconfigV1FormatV1; +} + +export const ManagedclusterencryptionconfigV1FormatV1 = { + V2: 'V2', + V3: 'V3' +} as const; + +export type ManagedclusterencryptionconfigV1FormatV1 = typeof ManagedclusterencryptionconfigV1FormatV1[keyof typeof ManagedclusterencryptionconfigV1FormatV1]; + +/** + * Managed Cluster key pair for Cluster + * @export + * @interface ManagedclusterkeypairV1 + */ +export interface ManagedclusterkeypairV1 { + /** + * ManagedCluster publicKey + * @type {string} + * @memberof ManagedclusterkeypairV1 + */ + 'publicKey'?: string | null; + /** + * ManagedCluster publicKeyThumbprint + * @type {string} + * @memberof ManagedclusterkeypairV1 + */ + 'publicKeyThumbprint'?: string | null; + /** + * ManagedCluster publicKeyCertificate + * @type {string} + * @memberof ManagedclusterkeypairV1 + */ + 'publicKeyCertificate'?: string | null; +} +/** + * Managed Cluster key pair for Cluster + * @export + * @interface ManagedclusterqueueV1 + */ +export interface ManagedclusterqueueV1 { + /** + * ManagedCluster queue name + * @type {string} + * @memberof ManagedclusterqueueV1 + */ + 'name'?: string; + /** + * ManagedCluster queue aws region + * @type {string} + * @memberof ManagedclusterqueueV1 + */ + 'region'?: string; +} +/** + * Managed Cluster Redis Configuration + * @export + * @interface ManagedclusterredisV1 + */ +export interface ManagedclusterredisV1 { + /** + * ManagedCluster redisHost + * @type {string} + * @memberof ManagedclusterredisV1 + */ + 'redisHost'?: string; + /** + * ManagedCluster redisPort + * @type {number} + * @memberof ManagedclusterredisV1 + */ + 'redisPort'?: number; +} +/** + * Request to create Managed Cluster + * @export + * @interface ManagedclusterrequestV1 + */ +export interface ManagedclusterrequestV1 { + /** + * ManagedCluster name + * @type {string} + * @memberof ManagedclusterrequestV1 + */ + 'name': string; + /** + * + * @type {ManagedclustertypesV1} + * @memberof ManagedclusterrequestV1 + */ + 'type'?: ManagedclustertypesV1; + /** + * ManagedProcess configuration map + * @type {{ [key: string]: string; }} + * @memberof ManagedclusterrequestV1 + */ + 'configuration'?: { [key: string]: string; }; + /** + * ManagedCluster description + * @type {string} + * @memberof ManagedclusterrequestV1 + */ + 'description'?: string | null; +} + + +/** + * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products + * @export + * @enum {string} + */ + +export const ManagedclustertypesV1 = { + Idn: 'idn', + Iai: 'iai', + SpConnectCluster: 'spConnectCluster', + SqsCluster: 'sqsCluster', + DasRc: 'das-rc', + DasPc: 'das-pc', + DasDc: 'das-dc', + Pag: 'pag', + DasAm: 'das-am', + Standard: 'standard' +} as const; + +export type ManagedclustertypesV1 = typeof ManagedclustertypesV1[keyof typeof ManagedclustertypesV1]; + + +/** + * @type PutClientLogConfigurationV1RequestV1 + * @export + */ +export type PutClientLogConfigurationV1RequestV1 = ClientlogconfigurationdurationminutesV1 | ClientlogconfigurationexpirationV1; + +/** + * Standard Log4j log level + * @export + * @enum {string} + */ + +export const StandardlevelV1 = { + Off: 'OFF', + Fatal: 'FATAL', + Error: 'ERROR', + Warn: 'WARN', + Info: 'INFO', + Debug: 'DEBUG', + Trace: 'TRACE' +} as const; + +export type StandardlevelV1 = typeof StandardlevelV1[keyof typeof StandardlevelV1]; + + + +/** + * ManagedClustersV1Api - axios parameter creator + * @export + */ +export const ManagedClustersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. + * @summary Create create managed cluster + * @param {ManagedclusterrequestV1} managedclusterrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClusterV1: async (managedclusterrequestV1: ManagedclusterrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'managedclusterrequestV1' is not null or undefined + assertParamExists('createManagedClusterV1', 'managedclusterrequestV1', managedclusterrequestV1) + const localVarPath = `/managed-clusters/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(managedclusterrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an existing managed cluster. + * @summary Delete managed cluster + * @param {string} id Managed cluster ID. + * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteManagedClusterV1: async (id: string, removeClients?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteManagedClusterV1', 'id', id) + const localVarPath = `/managed-clusters/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; + + if (removeClients !== undefined) { + localVarQueryParameter['removeClients'] = removeClients; + } + + + + 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 cluster\'s log configuration. + * @summary Get managed cluster log configuration + * @param {string} id ID of managed cluster to get log configuration for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getClientLogConfigurationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getClientLogConfigurationV1', 'id', id) + const localVarPath = `/managed-clusters/v1/{id}/log-config` + .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 cluster by ID. + * @summary Get managed cluster + * @param {string} id Managed cluster ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getManagedClusterV1', 'id', id) + const localVarPath = `/managed-clusters/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 current organization\'s managed clusters, based on request context. + * @summary Get managed clusters + * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClustersV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/managed-clusters/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 a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + * @summary Update managed cluster log configuration + * @param {string} id ID of the managed cluster to update the log configuration for. + * @param {PutClientLogConfigurationV1RequestV1} putClientLogConfigurationV1RequestV1 Client log configuration for the given managed cluster. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putClientLogConfigurationV1: async (id: string, putClientLogConfigurationV1RequestV1: PutClientLogConfigurationV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putClientLogConfigurationV1', 'id', id) + // verify required parameter 'putClientLogConfigurationV1RequestV1' is not null or undefined + assertParamExists('putClientLogConfigurationV1', 'putClientLogConfigurationV1RequestV1', putClientLogConfigurationV1RequestV1) + const localVarPath = `/managed-clusters/v1/{id}/log-config` + .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: 'PUT', ...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(putClientLogConfigurationV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update an existing managed cluster. + * @summary Update managed cluster + * @param {string} id Managed cluster ID. + * @param {Array} jsonpatchoperationV1 JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClusterV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateManagedClusterV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateManagedClusterV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/managed-clusters/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + * @summary Trigger manual upgrade for managed cluster + * @param {string} id ID of managed cluster to trigger manual upgrade. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateV1', 'id', id) + const localVarPath = `/managed-clusters/v1/{id}/manualUpgrade` + .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: 'POST', ...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, + }; + }, + } +}; + +/** + * ManagedClustersV1Api - functional programming interface + * @export + */ +export const ManagedClustersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ManagedClustersV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. + * @summary Create create managed cluster + * @param {ManagedclusterrequestV1} managedclusterrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createManagedClusterV1(managedclusterrequestV1: ManagedclusterrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClusterV1(managedclusterrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.createManagedClusterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an existing managed cluster. + * @summary Delete managed cluster + * @param {string} id Managed cluster ID. + * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteManagedClusterV1(id: string, removeClients?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClusterV1(id, removeClients, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.deleteManagedClusterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a managed cluster\'s log configuration. + * @summary Get managed cluster log configuration + * @param {string} id ID of managed cluster to get log configuration for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getClientLogConfigurationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfigurationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.getClientLogConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a managed cluster by ID. + * @summary Get managed cluster + * @param {string} id Managed cluster ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManagedClusterV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.getManagedClusterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List current organization\'s managed clusters, based on request context. + * @summary Get managed clusters + * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getManagedClustersV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClustersV1(offset, limit, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.getManagedClustersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + * @summary Update managed cluster log configuration + * @param {string} id ID of the managed cluster to update the log configuration for. + * @param {PutClientLogConfigurationV1RequestV1} putClientLogConfigurationV1RequestV1 Client log configuration for the given managed cluster. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putClientLogConfigurationV1(id: string, putClientLogConfigurationV1RequestV1: PutClientLogConfigurationV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfigurationV1(id, putClientLogConfigurationV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.putClientLogConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing managed cluster. + * @summary Update managed cluster + * @param {string} id Managed cluster ID. + * @param {Array} jsonpatchoperationV1 JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateManagedClusterV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClusterV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.updateManagedClusterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + * @summary Trigger manual upgrade for managed cluster + * @param {string} id ID of managed cluster to trigger manual upgrade. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ManagedClustersV1Api.updateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ManagedClustersV1Api - factory interface + * @export + */ +export const ManagedClustersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ManagedClustersV1ApiFp(configuration) + return { + /** + * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. + * @summary Create create managed cluster + * @param {ManagedClustersV1ApiCreateManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createManagedClusterV1(requestParameters: ManagedClustersV1ApiCreateManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createManagedClusterV1(requestParameters.managedclusterrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an existing managed cluster. + * @summary Delete managed cluster + * @param {ManagedClustersV1ApiDeleteManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteManagedClusterV1(requestParameters: ManagedClustersV1ApiDeleteManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteManagedClusterV1(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a managed cluster\'s log configuration. + * @summary Get managed cluster log configuration + * @param {ManagedClustersV1ApiGetClientLogConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getClientLogConfigurationV1(requestParameters: ManagedClustersV1ApiGetClientLogConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getClientLogConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a managed cluster by ID. + * @summary Get managed cluster + * @param {ManagedClustersV1ApiGetManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClusterV1(requestParameters: ManagedClustersV1ApiGetManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getManagedClusterV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List current organization\'s managed clusters, based on request context. + * @summary Get managed clusters + * @param {ManagedClustersV1ApiGetManagedClustersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getManagedClustersV1(requestParameters: ManagedClustersV1ApiGetManagedClustersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getManagedClustersV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + * @summary Update managed cluster log configuration + * @param {ManagedClustersV1ApiPutClientLogConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putClientLogConfigurationV1(requestParameters: ManagedClustersV1ApiPutClientLogConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putClientLogConfigurationV1(requestParameters.id, requestParameters.putClientLogConfigurationV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing managed cluster. + * @summary Update managed cluster + * @param {ManagedClustersV1ApiUpdateManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateManagedClusterV1(requestParameters: ManagedClustersV1ApiUpdateManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateManagedClusterV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + * @summary Trigger manual upgrade for managed cluster + * @param {ManagedClustersV1ApiUpdateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateV1(requestParameters: ManagedClustersV1ApiUpdateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createManagedClusterV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiCreateManagedClusterV1Request + */ +export interface ManagedClustersV1ApiCreateManagedClusterV1Request { + /** + * + * @type {ManagedclusterrequestV1} + * @memberof ManagedClustersV1ApiCreateManagedClusterV1 + */ + readonly managedclusterrequestV1: ManagedclusterrequestV1 +} + +/** + * Request parameters for deleteManagedClusterV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiDeleteManagedClusterV1Request + */ +export interface ManagedClustersV1ApiDeleteManagedClusterV1Request { + /** + * Managed cluster ID. + * @type {string} + * @memberof ManagedClustersV1ApiDeleteManagedClusterV1 + */ + readonly id: string + + /** + * Flag to determine the need to delete a cluster with clients. + * @type {boolean} + * @memberof ManagedClustersV1ApiDeleteManagedClusterV1 + */ + readonly removeClients?: boolean +} + +/** + * Request parameters for getClientLogConfigurationV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiGetClientLogConfigurationV1Request + */ +export interface ManagedClustersV1ApiGetClientLogConfigurationV1Request { + /** + * ID of managed cluster to get log configuration for. + * @type {string} + * @memberof ManagedClustersV1ApiGetClientLogConfigurationV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClusterV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiGetManagedClusterV1Request + */ +export interface ManagedClustersV1ApiGetManagedClusterV1Request { + /** + * Managed cluster ID. + * @type {string} + * @memberof ManagedClustersV1ApiGetManagedClusterV1 + */ + readonly id: string +} + +/** + * Request parameters for getManagedClustersV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiGetManagedClustersV1Request + */ +export interface ManagedClustersV1ApiGetManagedClustersV1Request { + /** + * 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 ManagedClustersV1ApiGetManagedClustersV1 + */ + 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 ManagedClustersV1ApiGetManagedClustersV1 + */ + 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 ManagedClustersV1ApiGetManagedClustersV1 + */ + 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* + * @type {string} + * @memberof ManagedClustersV1ApiGetManagedClustersV1 + */ + readonly filters?: string +} + +/** + * Request parameters for putClientLogConfigurationV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiPutClientLogConfigurationV1Request + */ +export interface ManagedClustersV1ApiPutClientLogConfigurationV1Request { + /** + * ID of the managed cluster to update the log configuration for. + * @type {string} + * @memberof ManagedClustersV1ApiPutClientLogConfigurationV1 + */ + readonly id: string + + /** + * Client log configuration for the given managed cluster. + * @type {PutClientLogConfigurationV1RequestV1} + * @memberof ManagedClustersV1ApiPutClientLogConfigurationV1 + */ + readonly putClientLogConfigurationV1RequestV1: PutClientLogConfigurationV1RequestV1 +} + +/** + * Request parameters for updateManagedClusterV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiUpdateManagedClusterV1Request + */ +export interface ManagedClustersV1ApiUpdateManagedClusterV1Request { + /** + * Managed cluster ID. + * @type {string} + * @memberof ManagedClustersV1ApiUpdateManagedClusterV1 + */ + readonly id: string + + /** + * JSONPatch payload used to update the object. + * @type {Array} + * @memberof ManagedClustersV1ApiUpdateManagedClusterV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateV1 operation in ManagedClustersV1Api. + * @export + * @interface ManagedClustersV1ApiUpdateV1Request + */ +export interface ManagedClustersV1ApiUpdateV1Request { + /** + * ID of managed cluster to trigger manual upgrade. + * @type {string} + * @memberof ManagedClustersV1ApiUpdateV1 + */ + readonly id: string +} + +/** + * ManagedClustersV1Api - object-oriented interface + * @export + * @class ManagedClustersV1Api + * @extends {BaseAPI} + */ +export class ManagedClustersV1Api extends BaseAPI { + /** + * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. + * @summary Create create managed cluster + * @param {ManagedClustersV1ApiCreateManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public createManagedClusterV1(requestParameters: ManagedClustersV1ApiCreateManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).createManagedClusterV1(requestParameters.managedclusterrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an existing managed cluster. + * @summary Delete managed cluster + * @param {ManagedClustersV1ApiDeleteManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public deleteManagedClusterV1(requestParameters: ManagedClustersV1ApiDeleteManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).deleteManagedClusterV1(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a managed cluster\'s log configuration. + * @summary Get managed cluster log configuration + * @param {ManagedClustersV1ApiGetClientLogConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public getClientLogConfigurationV1(requestParameters: ManagedClustersV1ApiGetClientLogConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).getClientLogConfigurationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a managed cluster by ID. + * @summary Get managed cluster + * @param {ManagedClustersV1ApiGetManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public getManagedClusterV1(requestParameters: ManagedClustersV1ApiGetManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).getManagedClusterV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List current organization\'s managed clusters, based on request context. + * @summary Get managed clusters + * @param {ManagedClustersV1ApiGetManagedClustersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public getManagedClustersV1(requestParameters: ManagedClustersV1ApiGetManagedClustersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).getManagedClustersV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + * @summary Update managed cluster log configuration + * @param {ManagedClustersV1ApiPutClientLogConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public putClientLogConfigurationV1(requestParameters: ManagedClustersV1ApiPutClientLogConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).putClientLogConfigurationV1(requestParameters.id, requestParameters.putClientLogConfigurationV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing managed cluster. + * @summary Update managed cluster + * @param {ManagedClustersV1ApiUpdateManagedClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public updateManagedClusterV1(requestParameters: ManagedClustersV1ApiUpdateManagedClusterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).updateManagedClusterV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + * @summary Trigger manual upgrade for managed cluster + * @param {ManagedClustersV1ApiUpdateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ManagedClustersV1Api + */ + public updateV1(requestParameters: ManagedClustersV1ApiUpdateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ManagedClustersV1ApiFp(this.configuration).updateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/managed_clusters/base.ts b/sdk-output/managed_clusters/base.ts new file mode 100644 index 00000000..2734dad5 --- /dev/null +++ b/sdk-output/managed_clusters/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Clusters + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/managed_clusters/common.ts b/sdk-output/managed_clusters/common.ts new file mode 100644 index 00000000..b8d80111 --- /dev/null +++ b/sdk-output/managed_clusters/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Clusters + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/managed_clusters/configuration.ts b/sdk-output/managed_clusters/configuration.ts new file mode 100644 index 00000000..7aa67658 --- /dev/null +++ b/sdk-output/managed_clusters/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Clusters + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/managed_clusters/git_push.sh b/sdk-output/managed_clusters/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/managed_clusters/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/managed_clusters/index.ts b/sdk-output/managed_clusters/index.ts new file mode 100644 index 00000000..fdeb9bbc --- /dev/null +++ b/sdk-output/managed_clusters/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Managed Clusters + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/managed_clusters/package.json b/sdk-output/managed_clusters/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/managed_clusters/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/managed_clusters/tsconfig.json b/sdk-output/managed_clusters/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/managed_clusters/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/mfa_configuration/.gitignore b/sdk-output/mfa_configuration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/mfa_configuration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/mfa_configuration/.npmignore b/sdk-output/mfa_configuration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/mfa_configuration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/mfa_configuration/.openapi-generator-ignore b/sdk-output/mfa_configuration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/mfa_configuration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/mfa_configuration/.openapi-generator/FILES b/sdk-output/mfa_configuration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/mfa_configuration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/mfa_configuration/.openapi-generator/VERSION b/sdk-output/mfa_configuration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/mfa_configuration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/mfa_configuration/.sdk-partition b/sdk-output/mfa_configuration/.sdk-partition new file mode 100644 index 00000000..d5f95653 --- /dev/null +++ b/sdk-output/mfa_configuration/.sdk-partition @@ -0,0 +1 @@ +mfa-configuration \ No newline at end of file diff --git a/sdk-output/mfa_configuration/README.md b/sdk-output/mfa_configuration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/mfa_configuration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/mfa_configuration/api.ts b/sdk-output/mfa_configuration/api.ts new file mode 100644 index 00000000..e8093424 --- /dev/null +++ b/sdk-output/mfa_configuration/api.ts @@ -0,0 +1,899 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - MFA Configuration + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetMFAOktaConfigV1401ResponseV1 + */ +export interface GetMFAOktaConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMFAOktaConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetMFAOktaConfigV1429ResponseV1 + */ +export interface GetMFAOktaConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMFAOktaConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface KbaanswerrequestitemV1 + */ +export interface KbaanswerrequestitemV1 { + /** + * Question Id + * @type {string} + * @memberof KbaanswerrequestitemV1 + */ + 'id': string; + /** + * An answer for the KBA question + * @type {string} + * @memberof KbaanswerrequestitemV1 + */ + 'answer': string; +} +/** + * + * @export + * @interface KbaanswerresponseitemV1 + */ +export interface KbaanswerresponseitemV1 { + /** + * Question Id + * @type {string} + * @memberof KbaanswerresponseitemV1 + */ + 'id': string; + /** + * Question description + * @type {string} + * @memberof KbaanswerresponseitemV1 + */ + 'question': string; + /** + * Denotes whether the KBA question has an answer configured for the current user + * @type {boolean} + * @memberof KbaanswerresponseitemV1 + */ + 'hasAnswer': boolean; +} +/** + * KBA Configuration + * @export + * @interface KbaquestionV1 + */ +export interface KbaquestionV1 { + /** + * KBA Question Id + * @type {string} + * @memberof KbaquestionV1 + */ + 'id': string; + /** + * KBA Question description + * @type {string} + * @memberof KbaquestionV1 + */ + 'text': string; + /** + * Denotes whether the KBA question has an answer configured for any user in the tenant + * @type {boolean} + * @memberof KbaquestionV1 + */ + 'hasAnswer': boolean; + /** + * Denotes the number of KBA configurations for this question + * @type {number} + * @memberof KbaquestionV1 + */ + 'numAnswers': number; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Response model for configuration test of a given MFA method + * @export + * @interface MfaconfigtestresponseV1 + */ +export interface MfaconfigtestresponseV1 { + /** + * The configuration test result. + * @type {string} + * @memberof MfaconfigtestresponseV1 + */ + 'state'?: MfaconfigtestresponseV1StateV1; + /** + * The error message to indicate the failure of configuration test. + * @type {string} + * @memberof MfaconfigtestresponseV1 + */ + 'error'?: string; +} + +export const MfaconfigtestresponseV1StateV1 = { + Success: 'SUCCESS', + Failed: 'FAILED' +} as const; + +export type MfaconfigtestresponseV1StateV1 = typeof MfaconfigtestresponseV1StateV1[keyof typeof MfaconfigtestresponseV1StateV1]; + +/** + * + * @export + * @interface MfaduoconfigV1 + */ +export interface MfaduoconfigV1 { + /** + * Mfa method name + * @type {string} + * @memberof MfaduoconfigV1 + */ + 'mfaMethod'?: string | null; + /** + * If MFA method is enabled. + * @type {boolean} + * @memberof MfaduoconfigV1 + */ + 'enabled'?: boolean; + /** + * The server host name or IP address of the MFA provider. + * @type {string} + * @memberof MfaduoconfigV1 + */ + 'host'?: string | null; + /** + * The secret key for authenticating requests to the MFA provider. + * @type {string} + * @memberof MfaduoconfigV1 + */ + 'accessKey'?: string | null; + /** + * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. + * @type {string} + * @memberof MfaduoconfigV1 + */ + 'identityAttribute'?: string | null; + /** + * A map with additional config properties for the given MFA method - duo-web. + * @type {{ [key: string]: any; }} + * @memberof MfaduoconfigV1 + */ + 'configProperties'?: { [key: string]: any; } | null; +} +/** + * + * @export + * @interface MfaoktaconfigV1 + */ +export interface MfaoktaconfigV1 { + /** + * Mfa method name + * @type {string} + * @memberof MfaoktaconfigV1 + */ + 'mfaMethod'?: string | null; + /** + * If MFA method is enabled. + * @type {boolean} + * @memberof MfaoktaconfigV1 + */ + 'enabled'?: boolean; + /** + * The server host name or IP address of the MFA provider. + * @type {string} + * @memberof MfaoktaconfigV1 + */ + 'host'?: string | null; + /** + * The secret key for authenticating requests to the MFA provider. + * @type {string} + * @memberof MfaoktaconfigV1 + */ + 'accessKey'?: string | null; + /** + * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. + * @type {string} + * @memberof MfaoktaconfigV1 + */ + 'identityAttribute'?: string | null; +} + +/** + * MFAConfigurationV1Api - axios parameter creator + * @export + */ +export const MFAConfigurationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns the configuration of an Duo MFA method. + * @summary Configuration of duo mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFADuoConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/mfa/v1/duo-web/config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the KBA configuration for MFA. + * @summary Configuration of kba mfa method + * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFAKbaConfigV1: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/mfa/v1/kba/config`; + // 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 (allLanguages !== undefined) { + localVarQueryParameter['allLanguages'] = allLanguages; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the configuration of an Okta MFA method. + * @summary Configuration of okta mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFAOktaConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/mfa/v1/okta-verify/config`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API sets the configuration of an Duo MFA method. + * @summary Set duo mfa configuration + * @param {MfaduoconfigV1} mfaduoconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFADuoConfigV1: async (mfaduoconfigV1: MfaduoconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'mfaduoconfigV1' is not null or undefined + assertParamExists('setMFADuoConfigV1', 'mfaduoconfigV1', mfaduoconfigV1) + const localVarPath = `/mfa/v1/duo-web/config`; + // 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: 'PUT', ...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(mfaduoconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + * @summary Set mfa kba configuration + * @param {Array} kbaanswerrequestitemV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFAKBAConfigV1: async (kbaanswerrequestitemV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'kbaanswerrequestitemV1' is not null or undefined + assertParamExists('setMFAKBAConfigV1', 'kbaanswerrequestitemV1', kbaanswerrequestitemV1) + const localVarPath = `/mfa/v1/kba/config/answers`; + // 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(kbaanswerrequestitemV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API sets the configuration of an Okta MFA method. + * @summary Set okta mfa configuration + * @param {MfaoktaconfigV1} mfaoktaconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFAOktaConfigV1: async (mfaoktaconfigV1: MfaoktaconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'mfaoktaconfigV1' is not null or undefined + assertParamExists('setMFAOktaConfigV1', 'mfaoktaconfigV1', mfaoktaconfigV1) + const localVarPath = `/mfa/v1/okta-verify/config`; + // 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: 'PUT', ...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(mfaoktaconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + * @summary Mfa method\'s test configuration + * @param {TestMFAConfigV1MethodV1} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testMFAConfigV1: async (method: TestMFAConfigV1MethodV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'method' is not null or undefined + assertParamExists('testMFAConfigV1', 'method', method) + const localVarPath = `/mfa/v1/{method}/test` + .replace(`{${"method"}}`, encodeURIComponent(String(method))); + // 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, + }; + }, + } +}; + +/** + * MFAConfigurationV1Api - functional programming interface + * @export + */ +export const MFAConfigurationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MFAConfigurationV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns the configuration of an Duo MFA method. + * @summary Configuration of duo mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.getMFADuoConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the KBA configuration for MFA. + * @summary Configuration of kba mfa method + * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMFAKbaConfigV1(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfigV1(allLanguages, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.getMFAKbaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the configuration of an Okta MFA method. + * @summary Configuration of okta mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.getMFAOktaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API sets the configuration of an Duo MFA method. + * @summary Set duo mfa configuration + * @param {MfaduoconfigV1} mfaduoconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setMFADuoConfigV1(mfaduoconfigV1: MfaduoconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfigV1(mfaduoconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.setMFADuoConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + * @summary Set mfa kba configuration + * @param {Array} kbaanswerrequestitemV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setMFAKBAConfigV1(kbaanswerrequestitemV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfigV1(kbaanswerrequestitemV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.setMFAKBAConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API sets the configuration of an Okta MFA method. + * @summary Set okta mfa configuration + * @param {MfaoktaconfigV1} mfaoktaconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setMFAOktaConfigV1(mfaoktaconfigV1: MfaoktaconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfigV1(mfaoktaconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.setMFAOktaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + * @summary Mfa method\'s test configuration + * @param {TestMFAConfigV1MethodV1} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testMFAConfigV1(method: TestMFAConfigV1MethodV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfigV1(method, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV1Api.testMFAConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MFAConfigurationV1Api - factory interface + * @export + */ +export const MFAConfigurationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MFAConfigurationV1ApiFp(configuration) + return { + /** + * This API returns the configuration of an Duo MFA method. + * @summary Configuration of duo mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMFADuoConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the KBA configuration for MFA. + * @summary Configuration of kba mfa method + * @param {MFAConfigurationV1ApiGetMFAKbaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFAKbaConfigV1(requestParameters: MFAConfigurationV1ApiGetMFAKbaConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getMFAKbaConfigV1(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the configuration of an Okta MFA method. + * @summary Configuration of okta mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMFAOktaConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API sets the configuration of an Duo MFA method. + * @summary Set duo mfa configuration + * @param {MFAConfigurationV1ApiSetMFADuoConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFADuoConfigV1(requestParameters: MFAConfigurationV1ApiSetMFADuoConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setMFADuoConfigV1(requestParameters.mfaduoconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + * @summary Set mfa kba configuration + * @param {MFAConfigurationV1ApiSetMFAKBAConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFAKBAConfigV1(requestParameters: MFAConfigurationV1ApiSetMFAKBAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.setMFAKBAConfigV1(requestParameters.kbaanswerrequestitemV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API sets the configuration of an Okta MFA method. + * @summary Set okta mfa configuration + * @param {MFAConfigurationV1ApiSetMFAOktaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setMFAOktaConfigV1(requestParameters: MFAConfigurationV1ApiSetMFAOktaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setMFAOktaConfigV1(requestParameters.mfaoktaconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + * @summary Mfa method\'s test configuration + * @param {MFAConfigurationV1ApiTestMFAConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testMFAConfigV1(requestParameters: MFAConfigurationV1ApiTestMFAConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testMFAConfigV1(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getMFAKbaConfigV1 operation in MFAConfigurationV1Api. + * @export + * @interface MFAConfigurationV1ApiGetMFAKbaConfigV1Request + */ +export interface MFAConfigurationV1ApiGetMFAKbaConfigV1Request { + /** + * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + * @type {boolean} + * @memberof MFAConfigurationV1ApiGetMFAKbaConfigV1 + */ + readonly allLanguages?: boolean +} + +/** + * Request parameters for setMFADuoConfigV1 operation in MFAConfigurationV1Api. + * @export + * @interface MFAConfigurationV1ApiSetMFADuoConfigV1Request + */ +export interface MFAConfigurationV1ApiSetMFADuoConfigV1Request { + /** + * + * @type {MfaduoconfigV1} + * @memberof MFAConfigurationV1ApiSetMFADuoConfigV1 + */ + readonly mfaduoconfigV1: MfaduoconfigV1 +} + +/** + * Request parameters for setMFAKBAConfigV1 operation in MFAConfigurationV1Api. + * @export + * @interface MFAConfigurationV1ApiSetMFAKBAConfigV1Request + */ +export interface MFAConfigurationV1ApiSetMFAKBAConfigV1Request { + /** + * + * @type {Array} + * @memberof MFAConfigurationV1ApiSetMFAKBAConfigV1 + */ + readonly kbaanswerrequestitemV1: Array +} + +/** + * Request parameters for setMFAOktaConfigV1 operation in MFAConfigurationV1Api. + * @export + * @interface MFAConfigurationV1ApiSetMFAOktaConfigV1Request + */ +export interface MFAConfigurationV1ApiSetMFAOktaConfigV1Request { + /** + * + * @type {MfaoktaconfigV1} + * @memberof MFAConfigurationV1ApiSetMFAOktaConfigV1 + */ + readonly mfaoktaconfigV1: MfaoktaconfigV1 +} + +/** + * Request parameters for testMFAConfigV1 operation in MFAConfigurationV1Api. + * @export + * @interface MFAConfigurationV1ApiTestMFAConfigV1Request + */ +export interface MFAConfigurationV1ApiTestMFAConfigV1Request { + /** + * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. + * @type {'okta-verify' | 'duo-web'} + * @memberof MFAConfigurationV1ApiTestMFAConfigV1 + */ + readonly method: TestMFAConfigV1MethodV1 +} + +/** + * MFAConfigurationV1Api - object-oriented interface + * @export + * @class MFAConfigurationV1Api + * @extends {BaseAPI} + */ +export class MFAConfigurationV1Api extends BaseAPI { + /** + * This API returns the configuration of an Duo MFA method. + * @summary Configuration of duo mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public getMFADuoConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).getMFADuoConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the KBA configuration for MFA. + * @summary Configuration of kba mfa method + * @param {MFAConfigurationV1ApiGetMFAKbaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public getMFAKbaConfigV1(requestParameters: MFAConfigurationV1ApiGetMFAKbaConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).getMFAKbaConfigV1(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the configuration of an Okta MFA method. + * @summary Configuration of okta mfa method + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public getMFAOktaConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).getMFAOktaConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API sets the configuration of an Duo MFA method. + * @summary Set duo mfa configuration + * @param {MFAConfigurationV1ApiSetMFADuoConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public setMFADuoConfigV1(requestParameters: MFAConfigurationV1ApiSetMFADuoConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).setMFADuoConfigV1(requestParameters.mfaduoconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + * @summary Set mfa kba configuration + * @param {MFAConfigurationV1ApiSetMFAKBAConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public setMFAKBAConfigV1(requestParameters: MFAConfigurationV1ApiSetMFAKBAConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).setMFAKBAConfigV1(requestParameters.kbaanswerrequestitemV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API sets the configuration of an Okta MFA method. + * @summary Set okta mfa configuration + * @param {MFAConfigurationV1ApiSetMFAOktaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public setMFAOktaConfigV1(requestParameters: MFAConfigurationV1ApiSetMFAOktaConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).setMFAOktaConfigV1(requestParameters.mfaoktaconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + * @summary Mfa method\'s test configuration + * @param {MFAConfigurationV1ApiTestMFAConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MFAConfigurationV1Api + */ + public testMFAConfigV1(requestParameters: MFAConfigurationV1ApiTestMFAConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MFAConfigurationV1ApiFp(this.configuration).testMFAConfigV1(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const TestMFAConfigV1MethodV1 = { + OktaVerify: 'okta-verify', + DuoWeb: 'duo-web' +} as const; +export type TestMFAConfigV1MethodV1 = typeof TestMFAConfigV1MethodV1[keyof typeof TestMFAConfigV1MethodV1]; + + diff --git a/sdk-output/mfa_configuration/base.ts b/sdk-output/mfa_configuration/base.ts new file mode 100644 index 00000000..c0e7674c --- /dev/null +++ b/sdk-output/mfa_configuration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - MFA Configuration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/mfa_configuration/common.ts b/sdk-output/mfa_configuration/common.ts new file mode 100644 index 00000000..52317c06 --- /dev/null +++ b/sdk-output/mfa_configuration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - MFA Configuration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/mfa_configuration/configuration.ts b/sdk-output/mfa_configuration/configuration.ts new file mode 100644 index 00000000..8533f081 --- /dev/null +++ b/sdk-output/mfa_configuration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - MFA Configuration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/mfa_configuration/git_push.sh b/sdk-output/mfa_configuration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/mfa_configuration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/mfa_configuration/index.ts b/sdk-output/mfa_configuration/index.ts new file mode 100644 index 00000000..cb9e56c3 --- /dev/null +++ b/sdk-output/mfa_configuration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - MFA Configuration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/mfa_configuration/package.json b/sdk-output/mfa_configuration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/mfa_configuration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/mfa_configuration/tsconfig.json b/sdk-output/mfa_configuration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/mfa_configuration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/multi_host_integration/.gitignore b/sdk-output/multi_host_integration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/multi_host_integration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/multi_host_integration/.npmignore b/sdk-output/multi_host_integration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/multi_host_integration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/multi_host_integration/.openapi-generator-ignore b/sdk-output/multi_host_integration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/multi_host_integration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/multi_host_integration/.openapi-generator/FILES b/sdk-output/multi_host_integration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/multi_host_integration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/multi_host_integration/.openapi-generator/VERSION b/sdk-output/multi_host_integration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/multi_host_integration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/multi_host_integration/.sdk-partition b/sdk-output/multi_host_integration/.sdk-partition new file mode 100644 index 00000000..d4d162b7 --- /dev/null +++ b/sdk-output/multi_host_integration/.sdk-partition @@ -0,0 +1 @@ +multi-host-integration \ No newline at end of file diff --git a/sdk-output/multi_host_integration/README.md b/sdk-output/multi_host_integration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/multi_host_integration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/multi_host_integration/api.ts b/sdk-output/multi_host_integration/api.ts new file mode 100644 index 00000000..1f5d59b1 --- /dev/null +++ b/sdk-output/multi_host_integration/api.ts @@ -0,0 +1,2863 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Multi-Host Integration + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetMultiHostIntegrationsListV1401ResponseV1 + */ +export interface GetMultiHostIntegrationsListV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMultiHostIntegrationsListV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetMultiHostIntegrationsListV1429ResponseV1 + */ +export interface GetMultiHostIntegrationsListV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetMultiHostIntegrationsListV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ManagercorrelationmappingV1 + */ +export interface ManagercorrelationmappingV1 { + /** + * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. + * @type {string} + * @memberof ManagercorrelationmappingV1 + */ + 'accountAttributeName'?: string; + /** + * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + * @type {string} + * @memberof ManagercorrelationmappingV1 + */ + 'identityAttributeName'?: string; +} +/** + * Reference to account correlation config object. + * @export + * @interface MultihostintegrationsAccountCorrelationConfigV1 + */ +export interface MultihostintegrationsAccountCorrelationConfigV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationConfigV1 + */ + 'type'?: MultihostintegrationsAccountCorrelationConfigV1TypeV1; + /** + * Account correlation config ID. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationConfigV1 + */ + 'id'?: string; + /** + * Account correlation config\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationConfigV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsAccountCorrelationConfigV1TypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' +} as const; + +export type MultihostintegrationsAccountCorrelationConfigV1TypeV1 = typeof MultihostintegrationsAccountCorrelationConfigV1TypeV1[keyof typeof MultihostintegrationsAccountCorrelationConfigV1TypeV1]; + +/** + * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. + * @export + * @interface MultihostintegrationsAccountCorrelationRuleV1 + */ +export interface MultihostintegrationsAccountCorrelationRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationRuleV1 + */ + 'type'?: MultihostintegrationsAccountCorrelationRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsAccountCorrelationRuleV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsAccountCorrelationRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type MultihostintegrationsAccountCorrelationRuleV1TypeV1 = typeof MultihostintegrationsAccountCorrelationRuleV1TypeV1[keyof typeof MultihostintegrationsAccountCorrelationRuleV1TypeV1]; + +/** + * Reference to accounts file for the source. + * @export + * @interface MultihostintegrationsAccountsFileV1 + */ +export interface MultihostintegrationsAccountsFileV1 { + /** + * Name of the accounts file. + * @type {string} + * @memberof MultihostintegrationsAccountsFileV1 + */ + 'name'?: string; + /** + * The accounts file key. + * @type {string} + * @memberof MultihostintegrationsAccountsFileV1 + */ + 'key'?: string; + /** + * Date-time when the file was uploaded + * @type {string} + * @memberof MultihostintegrationsAccountsFileV1 + */ + 'uploadTime'?: string; + /** + * Date-time when the accounts file expired. + * @type {string} + * @memberof MultihostintegrationsAccountsFileV1 + */ + 'expiry'?: string; + /** + * If this is true, it indicates that the accounts file has expired. + * @type {boolean} + * @memberof MultihostintegrationsAccountsFileV1 + */ + 'expired'?: boolean; +} +/** + * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + * @export + * @interface MultihostintegrationsBeforeProvisioningRuleV1 + */ +export interface MultihostintegrationsBeforeProvisioningRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsBeforeProvisioningRuleV1 + */ + 'type'?: MultihostintegrationsBeforeProvisioningRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof MultihostintegrationsBeforeProvisioningRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsBeforeProvisioningRuleV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsBeforeProvisioningRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type MultihostintegrationsBeforeProvisioningRuleV1TypeV1 = typeof MultihostintegrationsBeforeProvisioningRuleV1TypeV1[keyof typeof MultihostintegrationsBeforeProvisioningRuleV1TypeV1]; + +/** + * Reference to the source\'s associated cluster. + * @export + * @interface MultihostintegrationsClusterV1 + */ +export interface MultihostintegrationsClusterV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsClusterV1 + */ + 'type': MultihostintegrationsClusterV1TypeV1; + /** + * Cluster ID. + * @type {string} + * @memberof MultihostintegrationsClusterV1 + */ + 'id': string; + /** + * Cluster\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsClusterV1 + */ + 'name': string; +} + +export const MultihostintegrationsClusterV1TypeV1 = { + Cluster: 'CLUSTER' +} as const; + +export type MultihostintegrationsClusterV1TypeV1 = typeof MultihostintegrationsClusterV1TypeV1[keyof typeof MultihostintegrationsClusterV1TypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 + */ +export interface MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 { + /** + * File name of the connector JAR + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 + */ + 'connectorFileNameUploadedDate'?: string; +} +/** + * Attributes of Multi-Host Integration + * @export + * @interface MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + */ +export interface MultihostintegrationsConnectorAttributesMultiHostAttributesV1 { + /** + * Password. + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + */ + 'password'?: string; + /** + * Connector file. + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + */ + 'connector_files'?: string; + /** + * Authentication type. + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + */ + 'authType'?: string; + /** + * Username. + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + */ + 'user'?: string; +} +/** + * Connector specific configuration. This configuration will differ for Multi-Host Integration type. + * @export + * @interface MultihostintegrationsConnectorAttributesV1 + */ +export interface MultihostintegrationsConnectorAttributesV1 { + [key: string]: string | any; + + /** + * Maximum sources allowed count of a Multi-Host Integration + * @type {number} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'maxAllowedSources'?: number; + /** + * Last upload sources count of a Multi-Host Integration + * @type {number} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'lastSourceUploadCount'?: number; + /** + * + * @type {MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'connectorFileUploadHistory'?: MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1; + /** + * Multi-Host integration status. + * @type {string} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'multihost_status'?: MultihostintegrationsConnectorAttributesV1MultihostStatusV1; + /** + * Show account schema + * @type {boolean} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'showAccountSchema'?: boolean; + /** + * Show entitlement schema + * @type {boolean} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'showEntitlementSchema'?: boolean; + /** + * + * @type {MultihostintegrationsConnectorAttributesMultiHostAttributesV1} + * @memberof MultihostintegrationsConnectorAttributesV1 + */ + 'multiHostAttributes'?: MultihostintegrationsConnectorAttributesMultiHostAttributesV1; +} + +export const MultihostintegrationsConnectorAttributesV1MultihostStatusV1 = { + Ready: 'ready', + Processing: 'processing', + FileUploadInProgress: 'fileUploadInProgress', + SourceCreationInProgress: 'sourceCreationInProgress', + AggregationGroupingInProgress: 'aggregationGroupingInProgress', + AggregationScheduleInProgress: 'aggregationScheduleInProgress', + DeleteInProgress: 'deleteInProgress', + DeleteFailed: 'deleteFailed' +} as const; + +export type MultihostintegrationsConnectorAttributesV1MultihostStatusV1 = typeof MultihostintegrationsConnectorAttributesV1MultihostStatusV1[keyof typeof MultihostintegrationsConnectorAttributesV1MultihostStatusV1]; + +/** + * Reference to management workgroup for the source. + * @export + * @interface MultihostintegrationsManagementWorkgroupV1 + */ +export interface MultihostintegrationsManagementWorkgroupV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsManagementWorkgroupV1 + */ + 'type'?: MultihostintegrationsManagementWorkgroupV1TypeV1; + /** + * Management workgroup ID. + * @type {string} + * @memberof MultihostintegrationsManagementWorkgroupV1 + */ + 'id'?: string; + /** + * Management workgroup\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsManagementWorkgroupV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsManagementWorkgroupV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type MultihostintegrationsManagementWorkgroupV1TypeV1 = typeof MultihostintegrationsManagementWorkgroupV1TypeV1[keyof typeof MultihostintegrationsManagementWorkgroupV1TypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsManagerCorrelationMappingV1 + */ +export interface MultihostintegrationsManagerCorrelationMappingV1 { + /** + * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. + * @type {string} + * @memberof MultihostintegrationsManagerCorrelationMappingV1 + */ + 'accountAttributeName'?: string; + /** + * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + * @type {string} + * @memberof MultihostintegrationsManagerCorrelationMappingV1 + */ + 'identityAttributeName'?: string; +} +/** + * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. + * @export + * @interface MultihostintegrationsManagerCorrelationRuleV1 + */ +export interface MultihostintegrationsManagerCorrelationRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsManagerCorrelationRuleV1 + */ + 'type'?: MultihostintegrationsManagerCorrelationRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof MultihostintegrationsManagerCorrelationRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsManagerCorrelationRuleV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsManagerCorrelationRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type MultihostintegrationsManagerCorrelationRuleV1TypeV1 = typeof MultihostintegrationsManagerCorrelationRuleV1TypeV1[keyof typeof MultihostintegrationsManagerCorrelationRuleV1TypeV1]; + +/** + * Reference to identity object who owns the source. + * @export + * @interface MultihostintegrationsOwnerV1 + */ +export interface MultihostintegrationsOwnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsOwnerV1 + */ + 'type'?: MultihostintegrationsOwnerV1TypeV1; + /** + * Owner identity\'s ID. + * @type {string} + * @memberof MultihostintegrationsOwnerV1 + */ + 'id'?: string; + /** + * Owner identity\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsOwnerV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type MultihostintegrationsOwnerV1TypeV1 = typeof MultihostintegrationsOwnerV1TypeV1[keyof typeof MultihostintegrationsOwnerV1TypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsPasswordPoliciesInnerV1 + */ +export interface MultihostintegrationsPasswordPoliciesInnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsPasswordPoliciesInnerV1 + */ + 'type'?: MultihostintegrationsPasswordPoliciesInnerV1TypeV1; + /** + * Policy ID. + * @type {string} + * @memberof MultihostintegrationsPasswordPoliciesInnerV1 + */ + 'id'?: string; + /** + * Policy\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsPasswordPoliciesInnerV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsPasswordPoliciesInnerV1TypeV1 = { + PasswordPolicy: 'PASSWORD_POLICY' +} as const; + +export type MultihostintegrationsPasswordPoliciesInnerV1TypeV1 = typeof MultihostintegrationsPasswordPoliciesInnerV1TypeV1[keyof typeof MultihostintegrationsPasswordPoliciesInnerV1TypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsSchemasInnerV1 + */ +export interface MultihostintegrationsSchemasInnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostintegrationsSchemasInnerV1 + */ + 'type'?: MultihostintegrationsSchemasInnerV1TypeV1; + /** + * Schema ID. + * @type {string} + * @memberof MultihostintegrationsSchemasInnerV1 + */ + 'id'?: string; + /** + * Schema\'s human-readable display name. + * @type {string} + * @memberof MultihostintegrationsSchemasInnerV1 + */ + 'name'?: string; +} + +export const MultihostintegrationsSchemasInnerV1TypeV1 = { + ConnectorSchema: 'CONNECTOR_SCHEMA' +} as const; + +export type MultihostintegrationsSchemasInnerV1TypeV1 = typeof MultihostintegrationsSchemasInnerV1TypeV1[keyof typeof MultihostintegrationsSchemasInnerV1TypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsV1 + */ +export interface MultihostintegrationsV1 { + /** + * Multi-Host Integration ID. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'id': string; + /** + * Multi-Host Integration\'s human-readable name. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'name': string; + /** + * Multi-Host Integration\'s human-readable description. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'description': string; + /** + * + * @type {MultihostintegrationsOwnerV1} + * @memberof MultihostintegrationsV1 + */ + 'owner': MultihostintegrationsOwnerV1; + /** + * + * @type {MultihostintegrationsClusterV1} + * @memberof MultihostintegrationsV1 + */ + 'cluster'?: MultihostintegrationsClusterV1 | null; + /** + * + * @type {MultihostintegrationsAccountCorrelationConfigV1} + * @memberof MultihostintegrationsV1 + */ + 'accountCorrelationConfig'?: MultihostintegrationsAccountCorrelationConfigV1 | null; + /** + * + * @type {MultihostintegrationsAccountCorrelationRuleV1} + * @memberof MultihostintegrationsV1 + */ + 'accountCorrelationRule'?: MultihostintegrationsAccountCorrelationRuleV1 | null; + /** + * + * @type {MultihostintegrationsManagerCorrelationMappingV1} + * @memberof MultihostintegrationsV1 + */ + 'managerCorrelationMapping'?: MultihostintegrationsManagerCorrelationMappingV1; + /** + * + * @type {MultihostintegrationsManagerCorrelationRuleV1} + * @memberof MultihostintegrationsV1 + */ + 'managerCorrelationRule'?: MultihostintegrationsManagerCorrelationRuleV1 | null; + /** + * + * @type {MultihostintegrationsBeforeProvisioningRuleV1} + * @memberof MultihostintegrationsV1 + */ + 'beforeProvisioningRule'?: MultihostintegrationsBeforeProvisioningRuleV1 | null; + /** + * List of references to schema objects. + * @type {Array} + * @memberof MultihostintegrationsV1 + */ + 'schemas'?: Array; + /** + * List of references to the associated PasswordPolicy objects. + * @type {Array} + * @memberof MultihostintegrationsV1 + */ + 'passwordPolicies'?: Array | null; + /** + * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM + * @type {Array} + * @memberof MultihostintegrationsV1 + */ + 'features'?: Array; + /** + * Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'type'?: string; + /** + * Connector script name. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connector': string; + /** + * Fully qualified name of the Java class that implements the connector interface. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connectorClass'?: string; + /** + * + * @type {MultihostintegrationsConnectorAttributesV1} + * @memberof MultihostintegrationsV1 + */ + 'connectorAttributes'?: MultihostintegrationsConnectorAttributesV1; + /** + * Number from 0 to 100 that specifies when to skip the delete phase. + * @type {number} + * @memberof MultihostintegrationsV1 + */ + 'deleteThreshold'?: number; + /** + * When this is true, it indicates that the source is referenced by an identity profile. + * @type {boolean} + * @memberof MultihostintegrationsV1 + */ + 'authoritative'?: boolean; + /** + * + * @type {MultihostintegrationsManagementWorkgroupV1} + * @memberof MultihostintegrationsV1 + */ + 'managementWorkgroup'?: MultihostintegrationsManagementWorkgroupV1 | null; + /** + * When this is true, it indicates that the source is healthy. + * @type {boolean} + * @memberof MultihostintegrationsV1 + */ + 'healthy'?: boolean; + /** + * Status identifier that gives specific information about why a source is or isn\'t healthy. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'status'?: MultihostintegrationsV1StatusV1; + /** + * Timestamp that shows when a source health check was last performed. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'since'?: string; + /** + * Connector ID + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connectorId'?: string; + /** + * Name of the connector that was chosen during source creation. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connectorName'?: string; + /** + * Type of connection (direct or file). + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connectionType'?: MultihostintegrationsV1ConnectionTypeV1; + /** + * Connector implementation ID. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'connectorImplementationId'?: string; + /** + * Date-time when the source was created + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'created'?: string; + /** + * Date-time when the source was last modified. + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'modified'?: string; + /** + * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. + * @type {boolean} + * @memberof MultihostintegrationsV1 + */ + 'credentialProviderEnabled'?: boolean; + /** + * Source category (e.g. null, CredentialProvider). + * @type {string} + * @memberof MultihostintegrationsV1 + */ + 'category'?: string | null; + /** + * + * @type {MultihostintegrationsAccountsFileV1} + * @memberof MultihostintegrationsV1 + */ + 'accountsFile'?: MultihostintegrationsAccountsFileV1 | null; +} + +export const MultihostintegrationsV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', + PreferUuid: 'PREFER_UUID', + ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', + ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', + ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', + UsesUuid: 'USES_UUID', + ApplicationDiscovery: 'APPLICATION_DISCOVERY', + Delete: 'DELETE' +} as const; + +export type MultihostintegrationsV1FeaturesV1 = typeof MultihostintegrationsV1FeaturesV1[keyof typeof MultihostintegrationsV1FeaturesV1]; +export const MultihostintegrationsV1StatusV1 = { + SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', + SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', + SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', + SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', + SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', + SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', + SourceStateHealthy: 'SOURCE_STATE_HEALTHY', + SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', + SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', + SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', + SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' +} as const; + +export type MultihostintegrationsV1StatusV1 = typeof MultihostintegrationsV1StatusV1[keyof typeof MultihostintegrationsV1StatusV1]; +export const MultihostintegrationsV1ConnectionTypeV1 = { + Direct: 'direct', + File: 'file' +} as const; + +export type MultihostintegrationsV1ConnectionTypeV1 = typeof MultihostintegrationsV1ConnectionTypeV1[keyof typeof MultihostintegrationsV1ConnectionTypeV1]; + +/** + * + * @export + * @interface MultihostintegrationsaggscheduleupdateV1 + */ +export interface MultihostintegrationsaggscheduleupdateV1 { + /** + * Multi-Host Integration ID. The ID must be unique + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'multihostId': string; + /** + * Multi-Host Integration aggregation group ID + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'aggregation_grp_id': string; + /** + * Multi-Host Integration name + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'aggregation_grp_name': string; + /** + * Cron expression to schedule aggregation + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'aggregation_cron_schedule': string; + /** + * Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. + * @type {boolean} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'enableSchedule': boolean; + /** + * Source IDs of the Multi-Host Integration + * @type {Array} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'source_id_list': Array; + /** + * Created date of Multi-Host Integration aggregation schedule + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'created'?: string; + /** + * Modified date of Multi-Host Integration aggregation schedule + * @type {string} + * @memberof MultihostintegrationsaggscheduleupdateV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface MultihostintegrationscreateV1 + */ +export interface MultihostintegrationscreateV1 { + /** + * Multi-Host Integration\'s human-readable name. + * @type {string} + * @memberof MultihostintegrationscreateV1 + */ + 'name': string; + /** + * Multi-Host Integration\'s human-readable description. + * @type {string} + * @memberof MultihostintegrationscreateV1 + */ + 'description': string; + /** + * + * @type {MultihostintegrationsOwnerV1} + * @memberof MultihostintegrationscreateV1 + */ + 'owner': MultihostintegrationsOwnerV1; + /** + * + * @type {MultihostintegrationsClusterV1} + * @memberof MultihostintegrationscreateV1 + */ + 'cluster'?: MultihostintegrationsClusterV1 | null; + /** + * Connector script name. + * @type {string} + * @memberof MultihostintegrationscreateV1 + */ + 'connector': string; + /** + * Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. + * @type {{ [key: string]: any; }} + * @memberof MultihostintegrationscreateV1 + */ + 'connectorAttributes'?: { [key: string]: any; }; + /** + * + * @type {MultihostintegrationsManagementWorkgroupV1} + * @memberof MultihostintegrationscreateV1 + */ + 'managementWorkgroup'?: MultihostintegrationsManagementWorkgroupV1 | null; + /** + * Date-time when the source was created + * @type {string} + * @memberof MultihostintegrationscreateV1 + */ + 'created'?: string; + /** + * Date-time when the source was last modified. + * @type {string} + * @memberof MultihostintegrationscreateV1 + */ + 'modified'?: string; +} +/** + * This represents sources to be created of same type. + * @export + * @interface MultihostintegrationscreatesourcesV1 + */ +export interface MultihostintegrationscreatesourcesV1 { + /** + * Source\'s human-readable name. + * @type {string} + * @memberof MultihostintegrationscreatesourcesV1 + */ + 'name': string; + /** + * Source\'s human-readable description. + * @type {string} + * @memberof MultihostintegrationscreatesourcesV1 + */ + 'description'?: string; + /** + * Connector specific configuration. This configuration will differ from type to type. + * @type {{ [key: string]: any; }} + * @memberof MultihostintegrationscreatesourcesV1 + */ + 'connectorAttributes'?: { [key: string]: any; }; +} +/** + * This represents a Multi-Host Integration template type. + * @export + * @interface MultihostintegrationtemplatetypeV1 + */ +export interface MultihostintegrationtemplatetypeV1 { + /** + * This is the name of the type. + * @type {string} + * @memberof MultihostintegrationtemplatetypeV1 + */ + 'name'?: string; + /** + * This is the type value for the type. + * @type {string} + * @memberof MultihostintegrationtemplatetypeV1 + */ + 'type': string; + /** + * This is the scriptName attribute value for the type. + * @type {string} + * @memberof MultihostintegrationtemplatetypeV1 + */ + 'scriptName': string; +} +/** + * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + * @export + * @interface MultihostsourcesBeforeProvisioningRuleV1 + */ +export interface MultihostsourcesBeforeProvisioningRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof MultihostsourcesBeforeProvisioningRuleV1 + */ + 'type'?: MultihostsourcesBeforeProvisioningRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof MultihostsourcesBeforeProvisioningRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof MultihostsourcesBeforeProvisioningRuleV1 + */ + 'name'?: string; +} + +export const MultihostsourcesBeforeProvisioningRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type MultihostsourcesBeforeProvisioningRuleV1TypeV1 = typeof MultihostsourcesBeforeProvisioningRuleV1TypeV1[keyof typeof MultihostsourcesBeforeProvisioningRuleV1TypeV1]; + +/** + * + * @export + * @interface MultihostsourcesV1 + */ +export interface MultihostsourcesV1 { + /** + * Source ID. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'id': string; + /** + * Source\'s human-readable name. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'name': string; + /** + * Source\'s human-readable description. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'description'?: string; + /** + * + * @type {MultihostintegrationsOwnerV1} + * @memberof MultihostsourcesV1 + */ + 'owner': MultihostintegrationsOwnerV1; + /** + * + * @type {MultihostintegrationsClusterV1} + * @memberof MultihostsourcesV1 + */ + 'cluster'?: MultihostintegrationsClusterV1 | null; + /** + * + * @type {MultihostintegrationsAccountCorrelationConfigV1} + * @memberof MultihostsourcesV1 + */ + 'accountCorrelationConfig'?: MultihostintegrationsAccountCorrelationConfigV1 | null; + /** + * + * @type {MultihostintegrationsAccountCorrelationRuleV1} + * @memberof MultihostsourcesV1 + */ + 'accountCorrelationRule'?: MultihostintegrationsAccountCorrelationRuleV1 | null; + /** + * + * @type {ManagercorrelationmappingV1} + * @memberof MultihostsourcesV1 + */ + 'managerCorrelationMapping'?: ManagercorrelationmappingV1; + /** + * + * @type {MultihostintegrationsManagerCorrelationRuleV1} + * @memberof MultihostsourcesV1 + */ + 'managerCorrelationRule'?: MultihostintegrationsManagerCorrelationRuleV1 | null; + /** + * + * @type {MultihostsourcesBeforeProvisioningRuleV1} + * @memberof MultihostsourcesV1 + */ + 'beforeProvisioningRule'?: MultihostsourcesBeforeProvisioningRuleV1 | null; + /** + * List of references to schema objects. + * @type {Array} + * @memberof MultihostsourcesV1 + */ + 'schemas'?: Array; + /** + * List of references to the associated PasswordPolicy objects. + * @type {Array} + * @memberof MultihostsourcesV1 + */ + 'passwordPolicies'?: Array | null; + /** + * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM + * @type {Array} + * @memberof MultihostsourcesV1 + */ + 'features'?: Array; + /** + * Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'type'?: string; + /** + * Connector script name. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connector': string; + /** + * Fully qualified name of the Java class that implements the connector interface. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connectorClass'?: string; + /** + * Connector specific configuration. This configuration will differ from type to type. + * @type {{ [key: string]: any; }} + * @memberof MultihostsourcesV1 + */ + 'connectorAttributes'?: { [key: string]: any; }; + /** + * Number from 0 to 100 that specifies when to skip the delete phase. + * @type {number} + * @memberof MultihostsourcesV1 + */ + 'deleteThreshold'?: number; + /** + * When this is true, it indicates that the source is referenced by an identity profile. + * @type {boolean} + * @memberof MultihostsourcesV1 + */ + 'authoritative'?: boolean; + /** + * + * @type {MultihostintegrationsManagementWorkgroupV1} + * @memberof MultihostsourcesV1 + */ + 'managementWorkgroup'?: MultihostintegrationsManagementWorkgroupV1 | null; + /** + * When this is true, it indicates that the source is healthy. + * @type {boolean} + * @memberof MultihostsourcesV1 + */ + 'healthy'?: boolean; + /** + * Status identifier that gives specific information about why a source is or isn\'t healthy. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'status'?: MultihostsourcesV1StatusV1; + /** + * Timestamp that shows when a source health check was last performed. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'since'?: string; + /** + * Connector ID + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connectorId'?: string; + /** + * Name of the connector that was chosen during source creation. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connectorName': string; + /** + * Type of connection (direct or file). + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connectionType'?: string; + /** + * Connector implementation ID. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'connectorImplementationId'?: string; + /** + * Date-time when the source was created + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'created'?: string; + /** + * Date-time when the source was last modified. + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'modified'?: string; + /** + * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. + * @type {boolean} + * @memberof MultihostsourcesV1 + */ + 'credentialProviderEnabled'?: boolean; + /** + * Source category (e.g. null, CredentialProvider). + * @type {string} + * @memberof MultihostsourcesV1 + */ + 'category'?: string | null; +} + +export const MultihostsourcesV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', + PreferUuid: 'PREFER_UUID', + ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', + ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', + ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', + UsesUuid: 'USES_UUID', + ApplicationDiscovery: 'APPLICATION_DISCOVERY', + Delete: 'DELETE' +} as const; + +export type MultihostsourcesV1FeaturesV1 = typeof MultihostsourcesV1FeaturesV1[keyof typeof MultihostsourcesV1FeaturesV1]; +export const MultihostsourcesV1StatusV1 = { + SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', + SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', + SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', + SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', + SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', + SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', + SourceStateHealthy: 'SOURCE_STATE_HEALTHY', + SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', + SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', + SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', + SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' +} as const; + +export type MultihostsourcesV1StatusV1 = typeof MultihostsourcesV1StatusV1[keyof typeof MultihostsourcesV1StatusV1]; + +/** + * + * @export + * @interface SourcecreationerrorsV1 + */ +export interface SourcecreationerrorsV1 { + /** + * Multi-Host Integration ID. + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'multihostId'?: string; + /** + * Source\'s human-readable name. + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'source_name'?: string; + /** + * Source\'s human-readable description. + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'source_error'?: string; + /** + * Date-time when the source was created + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'created'?: string; + /** + * Date-time when the source was last modified. + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'modified'?: string; + /** + * operation category (e.g. DELETE). + * @type {string} + * @memberof SourcecreationerrorsV1 + */ + 'operation'?: string | null; +} +/** + * + * @export + * @interface TestSourceConnectionMultihostV1200ResponseV1 + */ +export interface TestSourceConnectionMultihostV1200ResponseV1 { + /** + * Source\'s test connection status. + * @type {boolean} + * @memberof TestSourceConnectionMultihostV1200ResponseV1 + */ + 'success'?: boolean; + /** + * Source\'s test connection message. + * @type {string} + * @memberof TestSourceConnectionMultihostV1200ResponseV1 + */ + 'message'?: string; + /** + * Source\'s test connection timing. + * @type {number} + * @memberof TestSourceConnectionMultihostV1200ResponseV1 + */ + 'timing'?: number; + /** + * Source\'s human-readable result type. + * @type {string} + * @memberof TestSourceConnectionMultihostV1200ResponseV1 + */ + 'resultType'?: TestSourceConnectionMultihostV1200ResponseV1ResultTypeV1; + /** + * Source\'s human-readable test connection details. + * @type {string} + * @memberof TestSourceConnectionMultihostV1200ResponseV1 + */ + 'testConnectionDetails'?: string; +} + +export const TestSourceConnectionMultihostV1200ResponseV1ResultTypeV1 = { + SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', + SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', + SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', + SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', + SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', + SourceStateHealthy: 'SOURCE_STATE_HEALTHY', + SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', + SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', + SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', + SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', + SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' +} as const; + +export type TestSourceConnectionMultihostV1200ResponseV1ResultTypeV1 = typeof TestSourceConnectionMultihostV1200ResponseV1ResultTypeV1[keyof typeof TestSourceConnectionMultihostV1200ResponseV1ResultTypeV1]; + +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface UpdateMultiHostSourcesV1RequestInnerV1 + */ +export interface UpdateMultiHostSourcesV1RequestInnerV1 { + /** + * The operation to be performed + * @type {string} + * @memberof UpdateMultiHostSourcesV1RequestInnerV1 + */ + 'op': UpdateMultiHostSourcesV1RequestInnerV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof UpdateMultiHostSourcesV1RequestInnerV1 + */ + 'path': string; + /** + * + * @type {UpdateMultiHostSourcesV1RequestInnerValueV1} + * @memberof UpdateMultiHostSourcesV1RequestInnerV1 + */ + 'value'?: UpdateMultiHostSourcesV1RequestInnerValueV1; +} + +export const UpdateMultiHostSourcesV1RequestInnerV1OpV1 = { + Add: 'add', + Replace: 'replace' +} as const; + +export type UpdateMultiHostSourcesV1RequestInnerV1OpV1 = typeof UpdateMultiHostSourcesV1RequestInnerV1OpV1[keyof typeof UpdateMultiHostSourcesV1RequestInnerV1OpV1]; + +/** + * @type UpdateMultiHostSourcesV1RequestInnerValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type UpdateMultiHostSourcesV1RequestInnerValueV1 = Array | boolean | number | object | string; + + +/** + * MultiHostIntegrationV1Api - axios parameter creator + * @export + */ +export const MultiHostIntegrationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create multi-host integration + * @param {MultihostintegrationscreateV1} multihostintegrationscreateV1 The specifics of the Multi-Host Integration to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMultiHostIntegrationV1: async (multihostintegrationscreateV1: MultihostintegrationscreateV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostintegrationscreateV1' is not null or undefined + assertParamExists('createMultiHostIntegrationV1', 'multihostintegrationscreateV1', multihostintegrationscreateV1) + const localVarPath = `/multihosts/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(multihostintegrationscreateV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create sources within multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration. + * @param {Array} multihostintegrationscreatesourcesV1 The specifics of the sources to create within Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourcesWithinMultiHostV1: async (multihostId: string, multihostintegrationscreatesourcesV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('createSourcesWithinMultiHostV1', 'multihostId', multihostId) + // verify required parameter 'multihostintegrationscreatesourcesV1' is not null or undefined + assertParamExists('createSourcesWithinMultiHostV1', 'multihostintegrationscreatesourcesV1', multihostintegrationscreatesourcesV1) + const localVarPath = `/multihosts/v1/{multihostId}` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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(multihostintegrationscreatesourcesV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete + * @summary Delete sources within multi-host integration + * @param {string} multiHostId ID of the Multi-Host Integration + * @param {Array} requestBody The delete bulk sources within multi-host integration request body + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMultiHostSourcesV1: async (multiHostId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multiHostId' is not null or undefined + assertParamExists('deleteMultiHostSourcesV1', 'multiHostId', multiHostId) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('deleteMultiHostSourcesV1', 'requestBody', requestBody) + const localVarPath = `/multihosts/v1/{multiHostId}/sources/bulk-delete` + .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); + // 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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + * @summary Delete multi-host integration + * @param {string} multihostId ID of Multi-Host Integration to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMultiHostV1: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('deleteMultiHostV1', 'multihostId', multihostId) + const localVarPath = `/multihosts/v1/{multihostId}` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List account-aggregation-groups by multi-host id + * @param {string} multihostId ID of the Multi-Host Integration to update + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAcctAggregationGroupsV1: async (multihostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('getAcctAggregationGroupsV1', 'multihostId', multihostId) + const localVarPath = `/multihosts/v1/{multihostId}/acctAggregationGroups` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List entitlement-aggregation-groups by integration id + * @param {string} multiHostId ID of the Multi-Host Integration to update + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementAggregationGroupsV1: async (multiHostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multiHostId' is not null or undefined + assertParamExists('getEntitlementAggregationGroupsV1', 'multiHostId', multiHostId) + const localVarPath = `/multihosts/v1/{multiHostId}/entitlementAggregationGroups` + .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); + // 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List all existing multi-host integrations + * @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 {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: **name** + * @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: **type**: *in* **forSubAdminId**: *in* + * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostIntegrationsListV1: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/multihosts/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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + * @summary Get multi-host integration by id + * @param {string} multihostId ID of the Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostIntegrationsV1: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('getMultiHostIntegrationsV1', 'multihostId', multihostId) + const localVarPath = `/multihosts/v1/{multihostId}` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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 list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host source creation errors + * @param {string} multiHostId ID of the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostSourceCreationErrorsV1: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multiHostId' is not null or undefined + assertParamExists('getMultiHostSourceCreationErrorsV1', 'multiHostId', multiHostId) + const localVarPath = `/multihosts/v1/{multiHostId}/sources/errors` + .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultihostIntegrationTypesV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/multihosts/v1/types`; + // 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 list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List sources within multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration to update + * @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 {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: **name** + * @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**: *in* + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourcesWithinMultiHostV1: async (multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('getSourcesWithinMultiHostV1', 'multihostId', multihostId) + const localVarPath = `/multihosts/v1/{multihostId}/sources` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testConnectionMultiHostSourcesV1: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('testConnectionMultiHostSourcesV1', 'multihostId', multihostId) + const localVarPath = `/multihosts/v1/{multihostId}/sources/testConnection` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration\'s single source + * @param {string} multihostId ID of the Multi-Host Integration + * @param {string} sourceId ID of the source within the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConnectionMultihostV1: async (multihostId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('testSourceConnectionMultihostV1', 'multihostId', multihostId) + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('testSourceConnectionMultihostV1', 'sourceId', sourceId) + const localVarPath = `/multihosts/v1/{multihostId}/sources/{sourceId}/testConnection` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))) + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Update multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration to update. + * @param {Array} updateMultiHostSourcesV1RequestInnerV1 This endpoint allows you to update a Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMultiHostSourcesV1: async (multihostId: string, updateMultiHostSourcesV1RequestInnerV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'multihostId' is not null or undefined + assertParamExists('updateMultiHostSourcesV1', 'multihostId', multihostId) + // verify required parameter 'updateMultiHostSourcesV1RequestInnerV1' is not null or undefined + assertParamExists('updateMultiHostSourcesV1', 'updateMultiHostSourcesV1RequestInnerV1', updateMultiHostSourcesV1RequestInnerV1) + const localVarPath = `/multihosts/v1/{multihostId}` + .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); + // 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(updateMultiHostSourcesV1RequestInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * MultiHostIntegrationV1Api - functional programming interface + * @export + */ +export const MultiHostIntegrationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = MultiHostIntegrationV1ApiAxiosParamCreator(configuration) + return { + /** + * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create multi-host integration + * @param {MultihostintegrationscreateV1} multihostintegrationscreateV1 The specifics of the Multi-Host Integration to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createMultiHostIntegrationV1(multihostintegrationscreateV1: MultihostintegrationscreateV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMultiHostIntegrationV1(multihostintegrationscreateV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.createMultiHostIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create sources within multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration. + * @param {Array} multihostintegrationscreatesourcesV1 The specifics of the sources to create within Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourcesWithinMultiHostV1(multihostId: string, multihostintegrationscreatesourcesV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourcesWithinMultiHostV1(multihostId, multihostintegrationscreatesourcesV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.createSourcesWithinMultiHostV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete + * @summary Delete sources within multi-host integration + * @param {string} multiHostId ID of the Multi-Host Integration + * @param {Array} requestBody The delete bulk sources within multi-host integration request body + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMultiHostSourcesV1(multiHostId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHostSourcesV1(multiHostId, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.deleteMultiHostSourcesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + * @summary Delete multi-host integration + * @param {string} multihostId ID of Multi-Host Integration to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMultiHostV1(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHostV1(multihostId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.deleteMultiHostV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List account-aggregation-groups by multi-host id + * @param {string} multihostId ID of the Multi-Host Integration to update + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAcctAggregationGroupsV1(multihostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAcctAggregationGroupsV1(multihostId, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getAcctAggregationGroupsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List entitlement-aggregation-groups by integration id + * @param {string} multiHostId ID of the Multi-Host Integration to update + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementAggregationGroupsV1(multiHostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementAggregationGroupsV1(multiHostId, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getEntitlementAggregationGroupsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List all existing multi-host integrations + * @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 {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: **name** + * @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: **type**: *in* **forSubAdminId**: *in* + * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMultiHostIntegrationsListV1(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsListV1(offset, limit, sorters, filters, count, forSubadmin, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getMultiHostIntegrationsListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + * @summary Get multi-host integration by id + * @param {string} multihostId ID of the Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMultiHostIntegrationsV1(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsV1(multihostId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getMultiHostIntegrationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host source creation errors + * @param {string} multiHostId ID of the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMultiHostSourceCreationErrorsV1(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostSourceCreationErrorsV1(multiHostId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getMultiHostSourceCreationErrorsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMultihostIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMultihostIntegrationTypesV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getMultihostIntegrationTypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List sources within multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration to update + * @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 {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: **name** + * @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**: *in* + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourcesWithinMultiHostV1(multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourcesWithinMultiHostV1(multihostId, offset, limit, sorters, filters, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.getSourcesWithinMultiHostV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testConnectionMultiHostSourcesV1(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionMultiHostSourcesV1(multihostId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.testConnectionMultiHostSourcesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration\'s single source + * @param {string} multihostId ID of the Multi-Host Integration + * @param {string} sourceId ID of the source within the Multi-Host Integration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testSourceConnectionMultihostV1(multihostId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionMultihostV1(multihostId, sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.testSourceConnectionMultihostV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Update multi-host integration + * @param {string} multihostId ID of the Multi-Host Integration to update. + * @param {Array} updateMultiHostSourcesV1RequestInnerV1 This endpoint allows you to update a Multi-Host Integration. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateMultiHostSourcesV1(multihostId: string, updateMultiHostSourcesV1RequestInnerV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMultiHostSourcesV1(multihostId, updateMultiHostSourcesV1RequestInnerV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV1Api.updateMultiHostSourcesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * MultiHostIntegrationV1Api - factory interface + * @export + */ +export const MultiHostIntegrationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = MultiHostIntegrationV1ApiFp(configuration) + return { + /** + * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create multi-host integration + * @param {MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createMultiHostIntegrationV1(requestParameters: MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createMultiHostIntegrationV1(requestParameters.multihostintegrationscreateV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create sources within multi-host integration + * @param {MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourcesWithinMultiHostV1(requestParameters: MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourcesWithinMultiHostV1(requestParameters.multihostId, requestParameters.multihostintegrationscreatesourcesV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete + * @summary Delete sources within multi-host integration + * @param {MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMultiHostSourcesV1(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + * @summary Delete multi-host integration + * @param {MultiHostIntegrationV1ApiDeleteMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMultiHostV1(requestParameters: MultiHostIntegrationV1ApiDeleteMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMultiHostV1(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List account-aggregation-groups by multi-host id + * @param {MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAcctAggregationGroupsV1(requestParameters: MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getAcctAggregationGroupsV1(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List entitlement-aggregation-groups by integration id + * @param {MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementAggregationGroupsV1(requestParameters: MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getEntitlementAggregationGroupsV1(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List all existing multi-host integrations + * @param {MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostIntegrationsListV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getMultiHostIntegrationsListV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + * @summary Get multi-host integration by id + * @param {MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostIntegrationsV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMultiHostIntegrationsV1(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host source creation errors + * @param {MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultiHostSourceCreationErrorsV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getMultiHostSourceCreationErrorsV1(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMultihostIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getMultihostIntegrationTypesV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List sources within multi-host integration + * @param {MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourcesWithinMultiHostV1(requestParameters: MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSourcesWithinMultiHostV1(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration + * @param {MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testConnectionMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testConnectionMultiHostSourcesV1(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration\'s single source + * @param {MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConnectionMultihostV1(requestParameters: MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testSourceConnectionMultihostV1(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Update multi-host integration + * @param {MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateMultiHostSourcesV1(requestParameters.multihostId, requestParameters.updateMultiHostSourcesV1RequestInnerV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createMultiHostIntegrationV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request + */ +export interface MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request { + /** + * The specifics of the Multi-Host Integration to create + * @type {MultihostintegrationscreateV1} + * @memberof MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1 + */ + readonly multihostintegrationscreateV1: MultihostintegrationscreateV1 +} + +/** + * Request parameters for createSourcesWithinMultiHostV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request + */ +export interface MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request { + /** + * ID of the Multi-Host Integration. + * @type {string} + * @memberof MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1 + */ + readonly multihostId: string + + /** + * The specifics of the sources to create within Multi-Host Integration. + * @type {Array} + * @memberof MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1 + */ + readonly multihostintegrationscreatesourcesV1: Array +} + +/** + * Request parameters for deleteMultiHostSourcesV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request + */ +export interface MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request { + /** + * ID of the Multi-Host Integration + * @type {string} + * @memberof MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1 + */ + readonly multiHostId: string + + /** + * The delete bulk sources within multi-host integration request body + * @type {Array} + * @memberof MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1 + */ + readonly requestBody: Array +} + +/** + * Request parameters for deleteMultiHostV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiDeleteMultiHostV1Request + */ +export interface MultiHostIntegrationV1ApiDeleteMultiHostV1Request { + /** + * ID of Multi-Host Integration to delete. + * @type {string} + * @memberof MultiHostIntegrationV1ApiDeleteMultiHostV1 + */ + readonly multihostId: string +} + +/** + * Request parameters for getAcctAggregationGroupsV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request + */ +export interface MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request { + /** + * ID of the Multi-Host Integration to update + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1 + */ + readonly multihostId: string + + /** + * 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 MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1 + */ + 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 MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1 + */ + readonly limit?: number +} + +/** + * Request parameters for getEntitlementAggregationGroupsV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request + */ +export interface MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request { + /** + * ID of the Multi-Host Integration to update + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1 + */ + readonly multiHostId: string + + /** + * 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 MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1 + */ + 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 MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1 + */ + readonly limit?: number +} + +/** + * Request parameters for getMultiHostIntegrationsListV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request + */ +export interface MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request { + /** + * 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 MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + 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 MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + readonly limit?: number + + /** + * 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: **name** + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + readonly sorters?: 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: **type**: *in* **forSubAdminId**: *in* + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + readonly filters?: string + + /** + * 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 MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + readonly count?: boolean + + /** + * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1 + */ + readonly forSubadmin?: string +} + +/** + * Request parameters for getMultiHostIntegrationsV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request + */ +export interface MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request { + /** + * ID of the Multi-Host Integration. + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1 + */ + readonly multihostId: string +} + +/** + * Request parameters for getMultiHostSourceCreationErrorsV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request + */ +export interface MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request { + /** + * ID of the Multi-Host Integration + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1 + */ + readonly multiHostId: string +} + +/** + * Request parameters for getSourcesWithinMultiHostV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request + */ +export interface MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request { + /** + * ID of the Multi-Host Integration to update + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + readonly multihostId: string + + /** + * 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 MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + 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 MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + readonly limit?: number + + /** + * 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: **name** + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + readonly sorters?: 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: **id**: *in* + * @type {string} + * @memberof MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + readonly filters?: string + + /** + * 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 MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for testConnectionMultiHostSourcesV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request + */ +export interface MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request { + /** + * ID of the Multi-Host Integration + * @type {string} + * @memberof MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1 + */ + readonly multihostId: string +} + +/** + * Request parameters for testSourceConnectionMultihostV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request + */ +export interface MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request { + /** + * ID of the Multi-Host Integration + * @type {string} + * @memberof MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1 + */ + readonly multihostId: string + + /** + * ID of the source within the Multi-Host Integration + * @type {string} + * @memberof MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for updateMultiHostSourcesV1 operation in MultiHostIntegrationV1Api. + * @export + * @interface MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request + */ +export interface MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request { + /** + * ID of the Multi-Host Integration to update. + * @type {string} + * @memberof MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1 + */ + readonly multihostId: string + + /** + * This endpoint allows you to update a Multi-Host Integration. + * @type {Array} + * @memberof MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1 + */ + readonly updateMultiHostSourcesV1RequestInnerV1: Array +} + +/** + * MultiHostIntegrationV1Api - object-oriented interface + * @export + * @class MultiHostIntegrationV1Api + * @extends {BaseAPI} + */ +export class MultiHostIntegrationV1Api extends BaseAPI { + /** + * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create multi-host integration + * @param {MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public createMultiHostIntegrationV1(requestParameters: MultiHostIntegrationV1ApiCreateMultiHostIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).createMultiHostIntegrationV1(requestParameters.multihostintegrationscreateV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Create sources within multi-host integration + * @param {MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public createSourcesWithinMultiHostV1(requestParameters: MultiHostIntegrationV1ApiCreateSourcesWithinMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).createSourcesWithinMultiHostV1(requestParameters.multihostId, requestParameters.multihostintegrationscreatesourcesV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete + * @summary Delete sources within multi-host integration + * @param {MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public deleteMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiDeleteMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).deleteMultiHostSourcesV1(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + * @summary Delete multi-host integration + * @param {MultiHostIntegrationV1ApiDeleteMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public deleteMultiHostV1(requestParameters: MultiHostIntegrationV1ApiDeleteMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).deleteMultiHostV1(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List account-aggregation-groups by multi-host id + * @param {MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getAcctAggregationGroupsV1(requestParameters: MultiHostIntegrationV1ApiGetAcctAggregationGroupsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getAcctAggregationGroupsV1(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List entitlement-aggregation-groups by integration id + * @param {MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getEntitlementAggregationGroupsV1(requestParameters: MultiHostIntegrationV1ApiGetEntitlementAggregationGroupsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getEntitlementAggregationGroupsV1(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List all existing multi-host integrations + * @param {MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getMultiHostIntegrationsListV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostIntegrationsListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getMultiHostIntegrationsListV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + * @summary Get multi-host integration by id + * @param {MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getMultiHostIntegrationsV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostIntegrationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getMultiHostIntegrationsV1(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host source creation errors + * @param {MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getMultiHostSourceCreationErrorsV1(requestParameters: MultiHostIntegrationV1ApiGetMultiHostSourceCreationErrorsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getMultiHostSourceCreationErrorsV1(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List multi-host integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getMultihostIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getMultihostIntegrationTypesV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary List sources within multi-host integration + * @param {MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public getSourcesWithinMultiHostV1(requestParameters: MultiHostIntegrationV1ApiGetSourcesWithinMultiHostV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).getSourcesWithinMultiHostV1(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration + * @param {MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public testConnectionMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiTestConnectionMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).testConnectionMultiHostSourcesV1(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Test configuration for multi-host integration\'s single source + * @param {MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public testSourceConnectionMultihostV1(requestParameters: MultiHostIntegrationV1ApiTestSourceConnectionMultihostV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).testSourceConnectionMultihostV1(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + * @summary Update multi-host integration + * @param {MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof MultiHostIntegrationV1Api + */ + public updateMultiHostSourcesV1(requestParameters: MultiHostIntegrationV1ApiUpdateMultiHostSourcesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return MultiHostIntegrationV1ApiFp(this.configuration).updateMultiHostSourcesV1(requestParameters.multihostId, requestParameters.updateMultiHostSourcesV1RequestInnerV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/multi_host_integration/base.ts b/sdk-output/multi_host_integration/base.ts new file mode 100644 index 00000000..3b545e54 --- /dev/null +++ b/sdk-output/multi_host_integration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Multi-Host Integration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/multi_host_integration/common.ts b/sdk-output/multi_host_integration/common.ts new file mode 100644 index 00000000..61c448aa --- /dev/null +++ b/sdk-output/multi_host_integration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Multi-Host Integration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/multi_host_integration/configuration.ts b/sdk-output/multi_host_integration/configuration.ts new file mode 100644 index 00000000..f451f139 --- /dev/null +++ b/sdk-output/multi_host_integration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Multi-Host Integration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/multi_host_integration/git_push.sh b/sdk-output/multi_host_integration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/multi_host_integration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/multi_host_integration/index.ts b/sdk-output/multi_host_integration/index.ts new file mode 100644 index 00000000..f2177ee0 --- /dev/null +++ b/sdk-output/multi_host_integration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Multi-Host Integration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/multi_host_integration/package.json b/sdk-output/multi_host_integration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/multi_host_integration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/multi_host_integration/tsconfig.json b/sdk-output/multi_host_integration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/multi_host_integration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/nerm/base.ts b/sdk-output/nerm/base.ts index 4212f027..88475bc4 100644 --- a/sdk-output/nerm/base.ts +++ b/sdk-output/nerm/base.ts @@ -50,7 +50,7 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; this.basePath = configuration.nermBasePath; diff --git a/sdk-output/nerm/common.ts b/sdk-output/nerm/common.ts index d9c05675..874d9d6c 100644 --- a/sdk-output/nerm/common.ts +++ b/sdk-output/nerm/common.ts @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,8 +143,7 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; @@ -164,8 +162,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.nermBasePath || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.nermBasePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/nermv2025/base.ts b/sdk-output/nermv2025/base.ts index bde64c65..efdcf46b 100644 --- a/sdk-output/nermv2025/base.ts +++ b/sdk-output/nermv2025/base.ts @@ -50,10 +50,10 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; - this.basePath = configuration.nermBasePath+ "/2025"; + this.basePath = configuration.nermBasePath+ "/v2025"; } } }; diff --git a/sdk-output/nermv2025/common.ts b/sdk-output/nermv2025/common.ts index 281b2103..5dbcf01f 100644 --- a/sdk-output/nermv2025/common.ts +++ b/sdk-output/nermv2025/common.ts @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,8 +143,7 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; @@ -164,8 +162,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.nermBasePath+ "/2025" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.nermBasePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/non_employee_lifecycle_management/.gitignore b/sdk-output/non_employee_lifecycle_management/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/non_employee_lifecycle_management/.npmignore b/sdk-output/non_employee_lifecycle_management/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/non_employee_lifecycle_management/.openapi-generator-ignore b/sdk-output/non_employee_lifecycle_management/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES b/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/non_employee_lifecycle_management/.openapi-generator/VERSION b/sdk-output/non_employee_lifecycle_management/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/non_employee_lifecycle_management/.sdk-partition b/sdk-output/non_employee_lifecycle_management/.sdk-partition new file mode 100644 index 00000000..c55bb1c8 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/.sdk-partition @@ -0,0 +1 @@ +non-employee-lifecycle-management \ No newline at end of file diff --git a/sdk-output/non_employee_lifecycle_management/README.md b/sdk-output/non_employee_lifecycle_management/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/non_employee_lifecycle_management/api.ts b/sdk-output/non_employee_lifecycle_management/api.ts new file mode 100644 index 00000000..752e51f8 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/api.ts @@ -0,0 +1,4549 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Non-Employee Lifecycle Management + * 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'; + +/** + * Enum representing the non-employee request approval status + * @export + * @enum {string} + */ + +export const ApprovalstatusV1 = { + Approved: 'APPROVED', + Rejected: 'REJECTED', + Pending: 'PENDING', + NotReady: 'NOT_READY', + Cancelled: 'CANCELLED' +} as const; + +export type ApprovalstatusV1 = typeof ApprovalstatusV1[keyof typeof ApprovalstatusV1]; + + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface DeleteNonEmployeeRecordsInBulkV1RequestV1 + */ +export interface DeleteNonEmployeeRecordsInBulkV1RequestV1 { + /** + * List of non-employee ids. + * @type {Array} + * @memberof DeleteNonEmployeeRecordsInBulkV1RequestV1 + */ + 'ids': Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ImportNonEmployeeRecordsInBulkV1RequestV1 + */ +export interface ImportNonEmployeeRecordsInBulkV1RequestV1 { + /** + * + * @type {File} + * @memberof ImportNonEmployeeRecordsInBulkV1RequestV1 + */ + 'data': File; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListNonEmployeeRecordsV1401ResponseV1 + */ +export interface ListNonEmployeeRecordsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListNonEmployeeRecordsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListNonEmployeeRecordsV1429ResponseV1 + */ +export interface ListNonEmployeeRecordsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListNonEmployeeRecordsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface NonemployeeapprovaldecisionV1 + */ +export interface NonemployeeapprovaldecisionV1 { + /** + * Comment on the approval item. + * @type {string} + * @memberof NonemployeeapprovaldecisionV1 + */ + 'comment'?: string; +} +/** + * + * @export + * @interface NonemployeeapprovalitemV1 + */ +export interface NonemployeeapprovalitemV1 { + /** + * Non-Employee approval item id + * @type {string} + * @memberof NonemployeeapprovalitemV1 + */ + 'id'?: string; + /** + * + * @type {NonemployeeidentityreferencewithidV1} + * @memberof NonemployeeapprovalitemV1 + */ + 'approver'?: NonemployeeidentityreferencewithidV1; + /** + * Requested identity account name + * @type {string} + * @memberof NonemployeeapprovalitemV1 + */ + 'accountName'?: string; + /** + * + * @type {ApprovalstatusV1} + * @memberof NonemployeeapprovalitemV1 + */ + 'approvalStatus'?: ApprovalstatusV1; + /** + * Approval order + * @type {number} + * @memberof NonemployeeapprovalitemV1 + */ + 'approvalOrder'?: number; + /** + * comment of approver + * @type {string} + * @memberof NonemployeeapprovalitemV1 + */ + 'comment'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeeapprovalitemV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeeapprovalitemV1 + */ + 'created'?: string; + /** + * + * @type {NonemployeerequestliteV1} + * @memberof NonemployeeapprovalitemV1 + */ + 'nonEmployeeRequest'?: NonemployeerequestliteV1; +} + + +/** + * + * @export + * @interface NonemployeeapprovalitembaseV1 + */ +export interface NonemployeeapprovalitembaseV1 { + /** + * Non-Employee approval item id + * @type {string} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'id'?: string; + /** + * + * @type {NonemployeeidentityreferencewithidV1} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'approver'?: NonemployeeidentityreferencewithidV1; + /** + * Requested identity account name + * @type {string} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'accountName'?: string; + /** + * + * @type {ApprovalstatusV1} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'approvalStatus'?: ApprovalstatusV1; + /** + * Approval order + * @type {number} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'approvalOrder'?: number; + /** + * comment of approver + * @type {string} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'comment'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeeapprovalitembaseV1 + */ + 'created'?: string; +} + + +/** + * + * @export + * @interface NonemployeeapprovalitemdetailV1 + */ +export interface NonemployeeapprovalitemdetailV1 { + /** + * Non-Employee approval item id + * @type {string} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'id'?: string; + /** + * + * @type {NonemployeeidentityreferencewithidV1} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'approver'?: NonemployeeidentityreferencewithidV1; + /** + * Requested identity account name + * @type {string} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'accountName'?: string; + /** + * + * @type {ApprovalstatusV1} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'approvalStatus'?: ApprovalstatusV1; + /** + * Approval order + * @type {number} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'approvalOrder'?: number; + /** + * comment of approver + * @type {string} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'comment'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'created'?: string; + /** + * + * @type {NonemployeerequestwithoutapprovalitemV1} + * @memberof NonemployeeapprovalitemdetailV1 + */ + 'nonEmployeeRequest'?: NonemployeerequestwithoutapprovalitemV1; +} + + +/** + * + * @export + * @interface NonemployeeapprovalsummaryV1 + */ +export interface NonemployeeapprovalsummaryV1 { + /** + * The number of approved non-employee approval requests. + * @type {number} + * @memberof NonemployeeapprovalsummaryV1 + */ + 'approved'?: number; + /** + * The number of pending non-employee approval requests. + * @type {number} + * @memberof NonemployeeapprovalsummaryV1 + */ + 'pending'?: number; + /** + * The number of rejected non-employee approval requests. + * @type {number} + * @memberof NonemployeeapprovalsummaryV1 + */ + 'rejected'?: number; +} +/** + * + * @export + * @interface NonemployeebulkuploadjobV1 + */ +export interface NonemployeebulkuploadjobV1 { + /** + * The bulk upload job\'s ID. (UUID) + * @type {string} + * @memberof NonemployeebulkuploadjobV1 + */ + 'id'?: string; + /** + * The ID of the source to bulk-upload non-employees to. (UUID) + * @type {string} + * @memberof NonemployeebulkuploadjobV1 + */ + 'sourceId'?: string; + /** + * The date-time the job was submitted. + * @type {string} + * @memberof NonemployeebulkuploadjobV1 + */ + 'created'?: string; + /** + * The date-time that the job was last updated. + * @type {string} + * @memberof NonemployeebulkuploadjobV1 + */ + 'modified'?: string; + /** + * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. + * @type {string} + * @memberof NonemployeebulkuploadjobV1 + */ + 'status'?: NonemployeebulkuploadjobV1StatusV1; +} + +export const NonemployeebulkuploadjobV1StatusV1 = { + Pending: 'PENDING', + InProgress: 'IN_PROGRESS', + Completed: 'COMPLETED', + Error: 'ERROR' +} as const; + +export type NonemployeebulkuploadjobV1StatusV1 = typeof NonemployeebulkuploadjobV1StatusV1[keyof typeof NonemployeebulkuploadjobV1StatusV1]; + +/** + * + * @export + * @interface NonemployeebulkuploadstatusV1 + */ +export interface NonemployeebulkuploadstatusV1 { + /** + * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. + * @type {string} + * @memberof NonemployeebulkuploadstatusV1 + */ + 'status'?: NonemployeebulkuploadstatusV1StatusV1; +} + +export const NonemployeebulkuploadstatusV1StatusV1 = { + Pending: 'PENDING', + InProgress: 'IN_PROGRESS', + Completed: 'COMPLETED', + Error: 'ERROR' +} as const; + +export type NonemployeebulkuploadstatusV1StatusV1 = typeof NonemployeebulkuploadstatusV1StatusV1[keyof typeof NonemployeebulkuploadstatusV1StatusV1]; + +/** + * Identifies if the identity is a normal identity or a governance group + * @export + * @enum {string} + */ + +export const NonemployeeidentitydtotypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY' +} as const; + +export type NonemployeeidentitydtotypeV1 = typeof NonemployeeidentitydtotypeV1[keyof typeof NonemployeeidentitydtotypeV1]; + + +/** + * + * @export + * @interface NonemployeeidentityreferencewithidV1 + */ +export interface NonemployeeidentityreferencewithidV1 { + /** + * + * @type {NonemployeeidentitydtotypeV1} + * @memberof NonemployeeidentityreferencewithidV1 + */ + 'type'?: NonemployeeidentitydtotypeV1; + /** + * Identity id + * @type {string} + * @memberof NonemployeeidentityreferencewithidV1 + */ + 'id'?: string; +} + + +/** + * + * @export + * @interface NonemployeeidnuserrequestV1 + */ +export interface NonemployeeidnuserrequestV1 { + /** + * Identity id. + * @type {string} + * @memberof NonemployeeidnuserrequestV1 + */ + 'id': string; +} +/** + * + * @export + * @interface NonemployeerecordV1 + */ +export interface NonemployeerecordV1 { + /** + * Non-Employee record id. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'id'?: string; + /** + * Requested identity account name. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'accountName'?: string; + /** + * Non-Employee\'s first name. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'firstName'?: string; + /** + * Non-Employee\'s last name. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'lastName'?: string; + /** + * Non-Employee\'s email. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'email'?: string; + /** + * Non-Employee\'s phone. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'phone'?: string; + /** + * The account ID of a valid identity to serve as this non-employee\'s manager. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'manager'?: string; + /** + * Non-Employee\'s source id. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'sourceId'?: string; + /** + * Additional attributes for a non-employee. Up to 10 custom attributes can be added. + * @type {{ [key: string]: string; }} + * @memberof NonemployeerecordV1 + */ + 'data'?: { [key: string]: string; }; + /** + * Non-Employee employment start date. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'startDate'?: string; + /** + * Non-Employee employment end date. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'endDate'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeerecordV1 + */ + 'created'?: string; +} +/** + * + * @export + * @interface NonemployeerejectapprovaldecisionV1 + */ +export interface NonemployeerejectapprovaldecisionV1 { + /** + * Comment on the approval item. + * @type {string} + * @memberof NonemployeerejectapprovaldecisionV1 + */ + 'comment': string; +} +/** + * + * @export + * @interface NonemployeerequestV1 + */ +export interface NonemployeerequestV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'description'?: string; + /** + * Requested identity account name. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'accountName'?: string; + /** + * Non-Employee\'s first name. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'firstName'?: string; + /** + * Non-Employee\'s last name. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'lastName'?: string; + /** + * Non-Employee\'s email. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'email'?: string; + /** + * Non-Employee\'s phone. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'phone'?: string; + /** + * The account ID of a valid identity to serve as this non-employee\'s manager. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'manager'?: string; + /** + * + * @type {NonemployeesourceliteV1} + * @memberof NonemployeerequestV1 + */ + 'nonEmployeeSource'?: NonemployeesourceliteV1; + /** + * Additional attributes for a non-employee. Up to 10 custom attributes can be added. + * @type {{ [key: string]: string; }} + * @memberof NonemployeerequestV1 + */ + 'data'?: { [key: string]: string; }; + /** + * List of approval item for the request + * @type {Array} + * @memberof NonemployeerequestV1 + */ + 'approvalItems'?: Array; + /** + * + * @type {ApprovalstatusV1} + * @memberof NonemployeerequestV1 + */ + 'approvalStatus'?: ApprovalstatusV1; + /** + * Comment of requester + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'comment'?: string; + /** + * When the request was completely approved. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'completionDate'?: string; + /** + * Non-Employee employment start date. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'startDate'?: string; + /** + * Non-Employee employment end date. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'endDate'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeerequestV1 + */ + 'created'?: string; +} + + +/** + * + * @export + * @interface NonemployeerequestbodyV1 + */ +export interface NonemployeerequestbodyV1 { + /** + * Requested identity account name. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'accountName': string; + /** + * Non-Employee\'s first name. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'firstName': string; + /** + * Non-Employee\'s last name. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'lastName': string; + /** + * Non-Employee\'s email. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'email': string; + /** + * Non-Employee\'s phone. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'phone': string; + /** + * The account ID of a valid identity to serve as this non-employee\'s manager. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'manager': string; + /** + * Non-Employee\'s source id. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'sourceId': string; + /** + * Additional attributes for a non-employee. Up to 10 custom attributes can be added. + * @type {{ [key: string]: string; }} + * @memberof NonemployeerequestbodyV1 + */ + 'data'?: { [key: string]: string; }; + /** + * Non-Employee employment start date. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'startDate': string; + /** + * Non-Employee employment end date. + * @type {string} + * @memberof NonemployeerequestbodyV1 + */ + 'endDate': string; +} +/** + * + * @export + * @interface NonemployeerequestliteV1 + */ +export interface NonemployeerequestliteV1 { + /** + * Non-Employee request id. + * @type {string} + * @memberof NonemployeerequestliteV1 + */ + 'id'?: string; + /** + * + * @type {NonemployeeidentityreferencewithidV1} + * @memberof NonemployeerequestliteV1 + */ + 'requester'?: NonemployeeidentityreferencewithidV1; +} +/** + * + * @export + * @interface NonemployeerequestsummaryV1 + */ +export interface NonemployeerequestsummaryV1 { + /** + * The number of approved non-employee requests on all sources that *requested-for* user manages. + * @type {number} + * @memberof NonemployeerequestsummaryV1 + */ + 'approved'?: number; + /** + * The number of rejected non-employee requests on all sources that *requested-for* user manages. + * @type {number} + * @memberof NonemployeerequestsummaryV1 + */ + 'rejected'?: number; + /** + * The number of pending non-employee requests on all sources that *requested-for* user manages. + * @type {number} + * @memberof NonemployeerequestsummaryV1 + */ + 'pending'?: number; + /** + * The number of non-employee records on all sources that *requested-for* user manages. + * @type {number} + * @memberof NonemployeerequestsummaryV1 + */ + 'nonEmployeeCount'?: number; +} +/** + * + * @export + * @interface NonemployeerequestwithoutapprovalitemV1 + */ +export interface NonemployeerequestwithoutapprovalitemV1 { + /** + * Non-Employee request id. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'id'?: string; + /** + * + * @type {NonemployeeidentityreferencewithidV1} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'requester'?: NonemployeeidentityreferencewithidV1; + /** + * Requested identity account name. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'accountName'?: string; + /** + * Non-Employee\'s first name. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'firstName'?: string; + /** + * Non-Employee\'s last name. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'lastName'?: string; + /** + * Non-Employee\'s email. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'email'?: string; + /** + * Non-Employee\'s phone. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'phone'?: string; + /** + * The account ID of a valid identity to serve as this non-employee\'s manager. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'manager'?: string; + /** + * + * @type {NonemployeesourcelitewithschemaattributesV1} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'nonEmployeeSource'?: NonemployeesourcelitewithschemaattributesV1; + /** + * Additional attributes for a non-employee. Up to 10 custom attributes can be added. + * @type {{ [key: string]: string; }} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'data'?: { [key: string]: string; }; + /** + * + * @type {ApprovalstatusV1} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'approvalStatus'?: ApprovalstatusV1; + /** + * Comment of requester + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'comment'?: string; + /** + * When the request was completely approved. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'completionDate'?: string; + /** + * Non-Employee employment start date. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'startDate'?: string; + /** + * Non-Employee employment end date. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'endDate'?: string; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeerequestwithoutapprovalitemV1 + */ + 'created'?: string; +} + + +/** + * + * @export + * @interface NonemployeeschemaattributeV1 + */ +export interface NonemployeeschemaattributeV1 { + /** + * Schema Attribute Id + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'id'?: string; + /** + * True if this schema attribute is mandatory on all non-employees sources. + * @type {boolean} + * @memberof NonemployeeschemaattributeV1 + */ + 'system'?: boolean; + /** + * When the schema attribute was last modified. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'modified'?: string; + /** + * When the schema attribute was created. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'created'?: string; + /** + * + * @type {NonemployeeschemaattributetypeV1} + * @memberof NonemployeeschemaattributeV1 + */ + 'type': NonemployeeschemaattributetypeV1; + /** + * Label displayed on the UI for this schema attribute. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'label': string; + /** + * The technical name of the attribute. Must be unique per source. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'technicalName': string; + /** + * help text displayed by UI. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'helpText'?: string; + /** + * Hint text that fills UI box. + * @type {string} + * @memberof NonemployeeschemaattributeV1 + */ + 'placeholder'?: string; + /** + * If true, the schema attribute is required for all non-employees in the source + * @type {boolean} + * @memberof NonemployeeschemaattributeV1 + */ + 'required'?: boolean; +} + + +/** + * + * @export + * @interface NonemployeeschemaattributebodyV1 + */ +export interface NonemployeeschemaattributebodyV1 { + /** + * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. + * @type {string} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'type': string; + /** + * Label displayed on the UI for this schema attribute. + * @type {string} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'label': string; + /** + * The technical name of the attribute. Must be unique per source. + * @type {string} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'technicalName': string; + /** + * help text displayed by UI. + * @type {string} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'helpText'?: string; + /** + * Hint text that fills UI box. + * @type {string} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'placeholder'?: string; + /** + * If true, the schema attribute is required for all non-employees in the source + * @type {boolean} + * @memberof NonemployeeschemaattributebodyV1 + */ + 'required'?: boolean; +} +/** + * Enum representing the type of data a schema attribute accepts. + * @export + * @enum {string} + */ + +export const NonemployeeschemaattributetypeV1 = { + Text: 'TEXT', + Date: 'DATE', + Identity: 'IDENTITY' +} as const; + +export type NonemployeeschemaattributetypeV1 = typeof NonemployeeschemaattributetypeV1[keyof typeof NonemployeeschemaattributetypeV1]; + + +/** + * + * @export + * @interface NonemployeesourceV1 + */ +export interface NonemployeesourceV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'description'?: string; + /** + * List of approvers + * @type {Array} + * @memberof NonemployeesourceV1 + */ + 'approvers'?: Array; + /** + * List of account managers + * @type {Array} + * @memberof NonemployeesourceV1 + */ + 'accountManagers'?: Array; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeesourceV1 + */ + 'created'?: string; +} +/** + * + * @export + * @interface NonemployeesourceliteV1 + */ +export interface NonemployeesourceliteV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeesourceliteV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceliteV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceliteV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourceliteV1 + */ + 'description'?: string; +} +/** + * + * @export + * @interface NonemployeesourcelitewithschemaattributesV1 + */ +export interface NonemployeesourcelitewithschemaattributesV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeesourcelitewithschemaattributesV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcelitewithschemaattributesV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcelitewithschemaattributesV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcelitewithschemaattributesV1 + */ + 'description'?: string; + /** + * List of schema attributes associated with this non-employee source. + * @type {Array} + * @memberof NonemployeesourcelitewithschemaattributesV1 + */ + 'schemaAttributes'?: Array; +} +/** + * + * @export + * @interface NonemployeesourcerequestbodyV1 + */ +export interface NonemployeesourcerequestbodyV1 { + /** + * Name of non-employee source. + * @type {string} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'name': string; + /** + * Description of non-employee source. + * @type {string} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'description': string; + /** + * + * @type {NonemployeeidnuserrequestV1} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'owner': NonemployeeidnuserrequestV1; + /** + * The ID for the management workgroup that contains source sub-admins + * @type {string} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'managementWorkgroup'?: string; + /** + * List of approvers. + * @type {Array} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'approvers'?: Array; + /** + * List of account managers. + * @type {Array} + * @memberof NonemployeesourcerequestbodyV1 + */ + 'accountManagers'?: Array; +} +/** + * + * @export + * @interface NonemployeesourcewithcloudexternalidV1 + */ +export interface NonemployeesourcewithcloudexternalidV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'description'?: string; + /** + * List of approvers + * @type {Array} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'approvers'?: Array; + /** + * List of account managers + * @type {Array} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'accountManagers'?: Array; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'created'?: string; + /** + * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. + * @type {string} + * @memberof NonemployeesourcewithcloudexternalidV1 + */ + 'cloudExternalId'?: string; +} +/** + * + * @export + * @interface NonemployeesourcewithnecountV1 + */ +export interface NonemployeesourcewithnecountV1 { + /** + * Non-Employee source id. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'id'?: string; + /** + * Source Id associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'sourceId'?: string; + /** + * Source name associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'name'?: string; + /** + * Source description associated with this non-employee source. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'description'?: string; + /** + * List of approvers + * @type {Array} + * @memberof NonemployeesourcewithnecountV1 + */ + 'approvers'?: Array; + /** + * List of account managers + * @type {Array} + * @memberof NonemployeesourcewithnecountV1 + */ + 'accountManagers'?: Array; + /** + * When the request was last modified. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'modified'?: string; + /** + * When the request was created. + * @type {string} + * @memberof NonemployeesourcewithnecountV1 + */ + 'created'?: string; + /** + * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. + * @type {number} + * @memberof NonemployeesourcewithnecountV1 + */ + 'nonEmployeeCount'?: number | null; +} + +/** + * NonEmployeeLifecycleManagementV1Api - axios parameter creator + * @export + */ +export const NonEmployeeLifecycleManagementV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + * @summary Approve a non-employee request + * @param {string} id Non-Employee approval item id (UUID) + * @param {NonemployeeapprovaldecisionV1} nonemployeeapprovaldecisionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveNonEmployeeRequestV1: async (id: string, nonemployeeapprovaldecisionV1: NonemployeeapprovaldecisionV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('approveNonEmployeeRequestV1', 'id', id) + // verify required parameter 'nonemployeeapprovaldecisionV1' is not null or undefined + assertParamExists('approveNonEmployeeRequestV1', 'nonemployeeapprovaldecisionV1', nonemployeeapprovaldecisionV1) + const localVarPath = `/non-employee-approvals/v1/{id}/approve` + .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: '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(nonemployeeapprovaldecisionV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will create a non-employee record. Requires role context of `idn:nesr:create` + * @summary Create non-employee record + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-Employee record creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeRecordV1: async (nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'nonemployeerequestbodyV1' is not null or undefined + assertParamExists('createNonEmployeeRecordV1', 'nonemployeerequestbodyV1', nonemployeerequestbodyV1) + const localVarPath = `/non-employee-records/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(nonemployeerequestbodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + * @summary Create non-employee request + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-Employee creation request body + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeRequestV1: async (nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'nonemployeerequestbodyV1' is not null or undefined + assertParamExists('createNonEmployeeRequestV1', 'nonemployeerequestbodyV1', nonemployeerequestbodyV1) + const localVarPath = `/non-employee-requests/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(nonemployeerequestbodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` + * @summary Create a new schema attribute for non-employee source + * @param {string} sourceId The Source id + * @param {NonemployeeschemaattributebodyV1} nonemployeeschemaattributebodyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, nonemployeeschemaattributebodyV1: NonemployeeschemaattributebodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) + // verify required parameter 'nonemployeeschemaattributebodyV1' is not null or undefined + assertParamExists('createNonEmployeeSourceSchemaAttributesV1', 'nonemployeeschemaattributebodyV1', nonemployeeschemaattributebodyV1) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(nonemployeeschemaattributebodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Create a non-employee source. + * @summary Create non-employee source + * @param {NonemployeesourcerequestbodyV1} nonemployeesourcerequestbodyV1 Non-Employee source creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeSourceV1: async (nonemployeesourcerequestbodyV1: NonemployeesourcerequestbodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'nonemployeesourcerequestbodyV1' is not null or undefined + assertParamExists('createNonEmployeeSourceV1', 'nonemployeesourcerequestbodyV1', nonemployeesourcerequestbodyV1) + const localVarPath = `/non-employee-sources/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(nonemployeesourcerequestbodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee record + * @param {string} id Non-Employee record id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRecordV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteNonEmployeeRecordV1', 'id', id) + const localVarPath = `/non-employee-records/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, + }; + }, + /** + * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + * @summary Delete multiple non-employee records + * @param {DeleteNonEmployeeRecordsInBulkV1RequestV1} deleteNonEmployeeRecordsInBulkV1RequestV1 Non-Employee bulk delete request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRecordsInBulkV1: async (deleteNonEmployeeRecordsInBulkV1RequestV1: DeleteNonEmployeeRecordsInBulkV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'deleteNonEmployeeRecordsInBulkV1RequestV1' is not null or undefined + assertParamExists('deleteNonEmployeeRecordsInBulkV1', 'deleteNonEmployeeRecordsInBulkV1RequestV1', deleteNonEmployeeRecordsInBulkV1RequestV1) + const localVarPath = `/non-employee-records/v1/bulk-delete`; + // 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(deleteNonEmployeeRecordsInBulkV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee request + * @param {string} id Non-Employee request id in the UUID format + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRequestV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteNonEmployeeRequestV1', 'id', id) + const localVarPath = `/non-employee-requests/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, + }; + }, + /** + * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete a schema attribute for non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'attributeId' is not null or undefined + assertParamExists('deleteNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` + .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete all custom schema attributes for non-employee source + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + * @summary Delete non-employee source + * @param {string} sourceId Source Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteNonEmployeeSourceV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + * @summary Exports non-employee records to csv + * @param {string} id Source Id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportNonEmployeeRecordsV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('exportNonEmployeeRecordsV1', 'id', id) + const localVarPath = `/non-employee-sources/v1/{id}/non-employees/download` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + * @summary Exports source schema template + * @param {string} id Source Id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportNonEmployeeSourceSchemaTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('exportNonEmployeeSourceSchemaTemplateV1', 'id', id) + const localVarPath = `/non-employee-sources/v1/{id}/schema-attributes-template/download` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + * @summary Get summary of non-employee approval requests + * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeApprovalSummaryV1: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestedFor' is not null or undefined + assertParamExists('getNonEmployeeApprovalSummaryV1', 'requestedFor', requestedFor) + const localVarPath = `/non-employee-approvals/v1/summary/{requested-for}` + .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); + // 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, + }; + }, + /** + * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. + * @summary Get a non-employee approval item detail + * @param {string} id Non-Employee approval item id (UUID) + * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeApprovalV1: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getNonEmployeeApprovalV1', 'id', id) + const localVarPath = `/non-employee-approvals/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; + + if (includeDetail !== undefined) { + localVarQueryParameter['include-detail'] = includeDetail; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` + * @summary Obtain the status of bulk upload on the source + * @param {string} id Source ID (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeBulkUploadStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getNonEmployeeBulkUploadStatusV1', 'id', id) + const localVarPath = `/non-employee-sources/v1/{id}/non-employee-bulk-upload/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a non-employee record. Requires role context of `idn:nesr:read` + * @summary Get a non-employee record + * @param {string} id Non-Employee record id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRecordV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getNonEmployeeRecordV1', 'id', id) + const localVarPath = `/non-employee-records/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, + }; + }, + /** + * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + * @summary Get summary of non-employee requests + * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRequestSummaryV1: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestedFor' is not null or undefined + assertParamExists('getNonEmployeeRequestSummaryV1', 'requestedFor', requestedFor) + const localVarPath = `/non-employee-requests/v1/summary/{requested-for}` + .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. + * @summary Get a non-employee request + * @param {string} id Non-Employee request id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRequestV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getNonEmployeeRequestV1', 'id', id) + const localVarPath = `/non-employee-requests/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, + }; + }, + /** + * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary Get schema attribute non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'attributeId' is not null or undefined + assertParamExists('getNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` + .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary List schema attributes non-employee source + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. + * @summary Get a non-employee source + * @param {string} sourceId Source Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getNonEmployeeSourceV1', 'sourceId', sourceId) + const localVarPath = `/non-employee-sources/v1/{sourceId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + * @summary Imports, or updates, non-employee records + * @param {string} id Source Id (UUID) + * @param {File} data + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importNonEmployeeRecordsInBulkV1: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importNonEmployeeRecordsInBulkV1', 'id', id) + // verify required parameter 'data' is not null or undefined + assertParamExists('importNonEmployeeRecordsInBulkV1', 'data', data) + const localVarPath = `/non-employee-sources/v1/{id}/non-employee-bulk-upload` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (data !== undefined) { + localVarFormParams.append('data', data as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. + * @summary Get list of non-employee approval requests + * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **approvalStatus**: *eq* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeApprovalsV1: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/non-employee-approvals/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 (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + * @summary List non-employee records + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + * @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: **sourceId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeRecordsV1: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/non-employee-records/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + * @summary List non-employee requests + * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + * @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: **sourceId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeRequestsV1: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'requestedFor' is not null or undefined + assertParamExists('listNonEmployeeRequestsV1', 'requestedFor', requestedFor) + const localVarPath = `/non-employee-requests/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + 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, + }; + }, + /** + * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + * @summary List non-employee sources + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. + * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. + * @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: **name, created, sourceId** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeSourcesV1: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/non-employee-sources/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (requestedFor !== undefined) { + localVarQueryParameter['requested-for'] = requestedFor; + } + + if (nonEmployeeCount !== undefined) { + localVarQueryParameter['non-employee-count'] = nonEmployeeCount; + } + + 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, + }; + }, + /** + * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Patch non-employee record + * @param {string} id Non-employee record id (UUID) + * @param {Array} jsonpatchoperationV1 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeRecordV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchNonEmployeeRecordV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchNonEmployeeRecordV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/non-employee-records/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` + * @summary Patch a schema attribute for non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {Array} jsonpatchoperationV1 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'attributeId' is not null or undefined + assertParamExists('patchNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('patchNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchNonEmployeeSchemaAttributeV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` + .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + * @summary Patch a non-employee source + * @param {string} sourceId Source Id + * @param {Array} jsonpatchoperationV1 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeSourceV1: async (sourceId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('patchNonEmployeeSourceV1', 'sourceId', sourceId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchNonEmployeeSourceV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/non-employee-sources/v1/{sourceId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + * @summary Reject a non-employee request + * @param {string} id Non-Employee approval item id (UUID) + * @param {NonemployeerejectapprovaldecisionV1} nonemployeerejectapprovaldecisionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectNonEmployeeRequestV1: async (id: string, nonemployeerejectapprovaldecisionV1: NonemployeerejectapprovaldecisionV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rejectNonEmployeeRequestV1', 'id', id) + // verify required parameter 'nonemployeerejectapprovaldecisionV1' is not null or undefined + assertParamExists('rejectNonEmployeeRequestV1', 'nonemployeerejectapprovaldecisionV1', nonemployeerejectapprovaldecisionV1) + const localVarPath = `/non-employee-approvals/v1/{id}/reject` + .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: '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(nonemployeerejectapprovaldecisionV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Update non-employee record + * @param {string} id Non-employee record id (UUID) + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateNonEmployeeRecordV1: async (id: string, nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateNonEmployeeRecordV1', 'id', id) + // verify required parameter 'nonemployeerequestbodyV1' is not null or undefined + assertParamExists('updateNonEmployeeRecordV1', 'nonemployeerequestbodyV1', nonemployeerequestbodyV1) + const localVarPath = `/non-employee-records/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: 'PUT', ...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(nonemployeerequestbodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * NonEmployeeLifecycleManagementV1Api - functional programming interface + * @export + */ +export const NonEmployeeLifecycleManagementV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NonEmployeeLifecycleManagementV1ApiAxiosParamCreator(configuration) + return { + /** + * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + * @summary Approve a non-employee request + * @param {string} id Non-Employee approval item id (UUID) + * @param {NonemployeeapprovaldecisionV1} nonemployeeapprovaldecisionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveNonEmployeeRequestV1(id: string, nonemployeeapprovaldecisionV1: NonemployeeapprovaldecisionV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequestV1(id, nonemployeeapprovaldecisionV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.approveNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will create a non-employee record. Requires role context of `idn:nesr:create` + * @summary Create non-employee record + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-Employee record creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createNonEmployeeRecordV1(nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecordV1(nonemployeerequestbodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.createNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + * @summary Create non-employee request + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-Employee creation request body + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createNonEmployeeRequestV1(nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequestV1(nonemployeerequestbodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.createNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` + * @summary Create a new schema attribute for non-employee source + * @param {string} sourceId The Source id + * @param {NonemployeeschemaattributebodyV1} nonemployeeschemaattributebodyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createNonEmployeeSourceSchemaAttributesV1(sourceId: string, nonemployeeschemaattributebodyV1: NonemployeeschemaattributebodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributesV1(sourceId, nonemployeeschemaattributebodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.createNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create a non-employee source. + * @summary Create non-employee source + * @param {NonemployeesourcerequestbodyV1} nonemployeesourcerequestbodyV1 Non-Employee source creation request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createNonEmployeeSourceV1(nonemployeesourcerequestbodyV1: NonemployeesourcerequestbodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceV1(nonemployeesourcerequestbodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.createNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee record + * @param {string} id Non-Employee record id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeRecordV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + * @summary Delete multiple non-employee records + * @param {DeleteNonEmployeeRecordsInBulkV1RequestV1} deleteNonEmployeeRecordsInBulkV1RequestV1 Non-Employee bulk delete request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1RequestV1: DeleteNonEmployeeRecordsInBulkV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeRecordsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee request + * @param {string} id Non-Employee request id in the UUID format + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeRequestV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequestV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete a schema attribute for non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttributeV1(attributeId, sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete all custom schema attributes for non-employee source + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeSourceSchemaAttributesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributesV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + * @summary Delete non-employee source + * @param {string} sourceId Source Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNonEmployeeSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.deleteNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + * @summary Exports non-employee records to csv + * @param {string} id Source Id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportNonEmployeeRecordsV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecordsV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.exportNonEmployeeRecordsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + * @summary Exports source schema template + * @param {string} id Source Id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportNonEmployeeSourceSchemaTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.exportNonEmployeeSourceSchemaTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + * @summary Get summary of non-employee approval requests + * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeApprovalSummaryV1(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummaryV1(requestedFor, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeApprovalSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. + * @summary Get a non-employee approval item detail + * @param {string} id Non-Employee approval item id (UUID) + * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeApprovalV1(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalV1(id, includeDetail, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` + * @summary Obtain the status of bulk upload on the source + * @param {string} id Source ID (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeBulkUploadStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeBulkUploadStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a non-employee record. Requires role context of `idn:nesr:read` + * @summary Get a non-employee record + * @param {string} id Non-Employee record id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeRecordV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecordV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + * @summary Get summary of non-employee requests + * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeRequestSummaryV1(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummaryV1(requestedFor, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeRequestSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. + * @summary Get a non-employee request + * @param {string} id Non-Employee request id (UUID) + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeRequestV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary Get schema attribute non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttributeV1(attributeId, sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary List schema attributes non-employee source + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeSourceSchemaAttributesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributesV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. + * @summary Get a non-employee source + * @param {string} sourceId Source Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNonEmployeeSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.getNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + * @summary Imports, or updates, non-employee records + * @param {string} id Source Id (UUID) + * @param {File} data + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importNonEmployeeRecordsInBulkV1(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulkV1(id, data, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.importNonEmployeeRecordsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. + * @summary Get list of non-employee approval requests + * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **approvalStatus**: *eq* + * @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: **created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNonEmployeeApprovalsV1(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovalsV1(requestedFor, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.listNonEmployeeApprovalsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + * @summary List non-employee records + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + * @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: **sourceId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNonEmployeeRecordsV1(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecordsV1(limit, offset, count, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.listNonEmployeeRecordsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + * @summary List non-employee requests + * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + * @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: **sourceId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNonEmployeeRequestsV1(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequestsV1(requestedFor, limit, offset, count, sorters, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.listNonEmployeeRequestsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + * @summary List non-employee sources + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. + * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. + * @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: **name, created, sourceId** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNonEmployeeSourcesV1(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSourcesV1(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.listNonEmployeeSourcesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Patch non-employee record + * @param {string} id Non-employee record id (UUID) + * @param {Array} jsonpatchoperationV1 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchNonEmployeeRecordV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecordV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.patchNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` + * @summary Patch a schema attribute for non-employee source + * @param {string} attributeId The Schema Attribute Id (UUID) + * @param {string} sourceId The Source id + * @param {Array} jsonpatchoperationV1 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttributeV1(attributeId, sourceId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.patchNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + * @summary Patch a non-employee source + * @param {string} sourceId Source Id + * @param {Array} jsonpatchoperationV1 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchNonEmployeeSourceV1(sourceId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSourceV1(sourceId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.patchNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + * @summary Reject a non-employee request + * @param {string} id Non-Employee approval item id (UUID) + * @param {NonemployeerejectapprovaldecisionV1} nonemployeerejectapprovaldecisionV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectNonEmployeeRequestV1(id: string, nonemployeerejectapprovaldecisionV1: NonemployeerejectapprovaldecisionV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequestV1(id, nonemployeerejectapprovaldecisionV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.rejectNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Update non-employee record + * @param {string} id Non-employee record id (UUID) + * @param {NonemployeerequestbodyV1} nonemployeerequestbodyV1 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateNonEmployeeRecordV1(id: string, nonemployeerequestbodyV1: NonemployeerequestbodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecordV1(id, nonemployeerequestbodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV1Api.updateNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * NonEmployeeLifecycleManagementV1Api - factory interface + * @export + */ +export const NonEmployeeLifecycleManagementV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NonEmployeeLifecycleManagementV1ApiFp(configuration) + return { + /** + * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + * @summary Approve a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveNonEmployeeRequestV1(requestParameters.id, requestParameters.nonemployeeapprovaldecisionV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will create a non-employee record. Requires role context of `idn:nesr:create` + * @summary Create non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createNonEmployeeRecordV1(requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + * @summary Create non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createNonEmployeeRequestV1(requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` + * @summary Create a new schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, requestParameters.nonemployeeschemaattributebodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create a non-employee source. + * @summary Create non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createNonEmployeeSourceV1(requestParameters.nonemployeesourcerequestbodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + * @summary Delete multiple non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeRecordsInBulkV1(requestParameters.deleteNonEmployeeRecordsInBulkV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete a schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete all custom schema attributes for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + * @summary Delete non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + * @summary Exports non-employee records to csv + * @param {NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportNonEmployeeRecordsV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + * @summary Exports source schema template + * @param {NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportNonEmployeeSourceSchemaTemplateV1(requestParameters: NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportNonEmployeeSourceSchemaTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + * @summary Get summary of non-employee approval requests + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeApprovalSummaryV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeApprovalSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. + * @summary Get a non-employee approval item detail + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeApprovalV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeApprovalV1(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` + * @summary Obtain the status of bulk upload on the source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeBulkUploadStatusV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeBulkUploadStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a non-employee record. Requires role context of `idn:nesr:read` + * @summary Get a non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + * @summary Get summary of non-employee requests + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRequestSummaryV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeRequestSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. + * @summary Get a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary Get schema attribute non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary List schema attributes non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. + * @summary Get a non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + * @summary Imports, or updates, non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importNonEmployeeRecordsInBulkV1(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. + * @summary Get list of non-employee approval requests + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeApprovalsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNonEmployeeApprovalsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + * @summary List non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNonEmployeeRecordsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + * @summary List non-employee requests + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeRequestsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNonEmployeeRequestsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + * @summary List non-employee sources + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNonEmployeeSourcesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNonEmployeeSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Patch non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchNonEmployeeRecordV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` + * @summary Patch a schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + * @summary Patch a non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchNonEmployeeSourceV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + * @summary Reject a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectNonEmployeeRequestV1(requestParameters.id, requestParameters.nonemployeerejectapprovaldecisionV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Update non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateNonEmployeeRecordV1(requestParameters.id, requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request { + /** + * Non-Employee approval item id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1 + */ + readonly id: string + + /** + * + * @type {NonemployeeapprovaldecisionV1} + * @memberof NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1 + */ + readonly nonemployeeapprovaldecisionV1: NonemployeeapprovaldecisionV1 +} + +/** + * Request parameters for createNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request { + /** + * Non-Employee record creation request body. + * @type {NonemployeerequestbodyV1} + * @memberof NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1 + */ + readonly nonemployeerequestbodyV1: NonemployeerequestbodyV1 +} + +/** + * Request parameters for createNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request { + /** + * Non-Employee creation request body + * @type {NonemployeerequestbodyV1} + * @memberof NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1 + */ + readonly nonemployeerequestbodyV1: NonemployeerequestbodyV1 +} + +/** + * Request parameters for createNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request { + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1 + */ + readonly sourceId: string + + /** + * + * @type {NonemployeeschemaattributebodyV1} + * @memberof NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1 + */ + readonly nonemployeeschemaattributebodyV1: NonemployeeschemaattributebodyV1 +} + +/** + * Request parameters for createNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request { + /** + * Non-Employee source creation request body. + * @type {NonemployeesourcerequestbodyV1} + * @memberof NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1 + */ + readonly nonemployeesourcerequestbodyV1: NonemployeesourcerequestbodyV1 +} + +/** + * Request parameters for deleteNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request { + /** + * Non-Employee record id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteNonEmployeeRecordsInBulkV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request { + /** + * Non-Employee bulk delete request body. + * @type {DeleteNonEmployeeRecordsInBulkV1RequestV1} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1 + */ + readonly deleteNonEmployeeRecordsInBulkV1RequestV1: DeleteNonEmployeeRecordsInBulkV1RequestV1 +} + +/** + * Request parameters for deleteNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request { + /** + * Non-Employee request id in the UUID format + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request { + /** + * The Schema Attribute Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1 + */ + readonly attributeId: string + + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for deleteNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request { + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for deleteNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request { + /** + * Source Id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for exportNonEmployeeRecordsV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request { + /** + * Source Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1 + */ + readonly id: string +} + +/** + * Request parameters for exportNonEmployeeSourceSchemaTemplateV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request { + /** + * Source Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1 + */ + readonly id: string +} + +/** + * Request parameters for getNonEmployeeApprovalSummaryV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request { + /** + * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1 + */ + readonly requestedFor: string +} + +/** + * Request parameters for getNonEmployeeApprovalV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request { + /** + * Non-Employee approval item id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1 + */ + readonly id: string + + /** + * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1 + */ + readonly includeDetail?: boolean +} + +/** + * Request parameters for getNonEmployeeBulkUploadStatusV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request { + /** + * Source ID (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for getNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request { + /** + * Non-Employee record id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1 + */ + readonly id: string +} + +/** + * Request parameters for getNonEmployeeRequestSummaryV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request { + /** + * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1 + */ + readonly requestedFor: string +} + +/** + * Request parameters for getNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request { + /** + * Non-Employee request id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1 + */ + readonly id: string +} + +/** + * Request parameters for getNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request { + /** + * The Schema Attribute Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1 + */ + readonly attributeId: string + + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request { + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request { + /** + * Source Id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for importNonEmployeeRecordsInBulkV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request { + /** + * Source Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1 + */ + readonly id: string + + /** + * + * @type {File} + * @memberof NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1 + */ + readonly data: File +} + +/** + * Request parameters for listNonEmployeeApprovalsV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request { + /** + * The identity for whom the request was made. *me* indicates the current user. + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + readonly requestedFor?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + 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: **approvalStatus**: *eq* + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + 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: **created, modified** + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listNonEmployeeRecordsV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request { + /** + * 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 NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1 + */ + readonly count?: boolean + + /** + * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1 + */ + readonly sorters?: 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: **sourceId**: *eq* + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listNonEmployeeRequestsV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request { + /** + * The identity for whom the request was made. *me* indicates the current user. + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly requestedFor: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly count?: boolean + + /** + * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly sorters?: 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: **sourceId**: *eq* + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listNonEmployeeSourcesV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request { + /** + * 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 NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly count?: boolean + + /** + * Identity the request was made for. Use \'me\' to indicate the current user. + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly requestedFor?: string + + /** + * Flag that determines whether the API will return a non-employee count associated with the source. + * @type {boolean} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly nonEmployeeCount?: boolean + + /** + * 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: **name, created, sourceId** + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request { + /** + * Non-employee record id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1 + */ + readonly id: string + + /** + * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @type {Array} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request { + /** + * The Schema Attribute Id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1 + */ + readonly attributeId: string + + /** + * The Source id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1 + */ + readonly sourceId: string + + /** + * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. + * @type {Array} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request { + /** + * Source Id + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1 + */ + readonly sourceId: string + + /** + * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for rejectNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request { + /** + * Non-Employee approval item id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1 + */ + readonly id: string + + /** + * + * @type {NonemployeerejectapprovaldecisionV1} + * @memberof NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1 + */ + readonly nonemployeerejectapprovaldecisionV1: NonemployeerejectapprovaldecisionV1 +} + +/** + * Request parameters for updateNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementV1Api. + * @export + * @interface NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request + */ +export interface NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request { + /** + * Non-employee record id (UUID) + * @type {string} + * @memberof NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1 + */ + readonly id: string + + /** + * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + * @type {NonemployeerequestbodyV1} + * @memberof NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1 + */ + readonly nonemployeerequestbodyV1: NonemployeerequestbodyV1 +} + +/** + * NonEmployeeLifecycleManagementV1Api - object-oriented interface + * @export + * @class NonEmployeeLifecycleManagementV1Api + * @extends {BaseAPI} + */ +export class NonEmployeeLifecycleManagementV1Api extends BaseAPI { + /** + * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + * @summary Approve a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public approveNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiApproveNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).approveNonEmployeeRequestV1(requestParameters.id, requestParameters.nonemployeeapprovaldecisionV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will create a non-employee record. Requires role context of `idn:nesr:create` + * @summary Create non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public createNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).createNonEmployeeRecordV1(requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + * @summary Create non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public createNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).createNonEmployeeRequestV1(requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` + * @summary Create a new schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public createNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).createNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, requestParameters.nonemployeeschemaattributebodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create a non-employee source. + * @summary Create non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public createNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiCreateNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).createNonEmployeeSourceV1(requestParameters.nonemployeesourcerequestbodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + * @summary Delete multiple non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeRecordsInBulkV1(requestParameters.deleteNonEmployeeRecordsInBulkV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` + * @summary Delete non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete a schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + * @summary Delete all custom schema attributes for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + * @summary Delete non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public deleteNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiDeleteNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).deleteNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + * @summary Exports non-employee records to csv + * @param {NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public exportNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiExportNonEmployeeRecordsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).exportNonEmployeeRecordsV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + * @summary Exports source schema template + * @param {NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public exportNonEmployeeSourceSchemaTemplateV1(requestParameters: NonEmployeeLifecycleManagementV1ApiExportNonEmployeeSourceSchemaTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + * @summary Get summary of non-employee approval requests + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeApprovalSummaryV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeApprovalSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. + * @summary Get a non-employee approval item detail + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeApprovalV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeApprovalV1(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` + * @summary Obtain the status of bulk upload on the source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeBulkUploadStatusV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeBulkUploadStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeBulkUploadStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a non-employee record. Requires role context of `idn:nesr:read` + * @summary Get a non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + * @summary Get summary of non-employee requests + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeRequestSummaryV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeRequestSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. + * @summary Get a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary Get schema attribute non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + * @summary List schema attributes non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. + * @summary Get a non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public getNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiGetNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).getNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + * @summary Imports, or updates, non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public importNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementV1ApiImportNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).importNonEmployeeRecordsInBulkV1(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. + * @summary Get list of non-employee approval requests + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public listNonEmployeeApprovalsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).listNonEmployeeApprovalsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + * @summary List non-employee records + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public listNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeRecordsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).listNonEmployeeRecordsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + * @summary List non-employee requests + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public listNonEmployeeRequestsV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeRequestsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).listNonEmployeeRequestsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + * @summary List non-employee sources + * @param {NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public listNonEmployeeSourcesV1(requestParameters: NonEmployeeLifecycleManagementV1ApiListNonEmployeeSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).listNonEmployeeSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Patch non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public patchNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).patchNonEmployeeRecordV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` + * @summary Patch a schema attribute for non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public patchNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).patchNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + * @summary Patch a non-employee source + * @param {NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public patchNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementV1ApiPatchNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).patchNonEmployeeSourceV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + * @summary Reject a non-employee request + * @param {NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public rejectNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementV1ApiRejectNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).rejectNonEmployeeRequestV1(requestParameters.id, requestParameters.nonemployeerejectapprovaldecisionV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. + * @summary Update non-employee record + * @param {NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NonEmployeeLifecycleManagementV1Api + */ + public updateNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementV1ApiUpdateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NonEmployeeLifecycleManagementV1ApiFp(this.configuration).updateNonEmployeeRecordV1(requestParameters.id, requestParameters.nonemployeerequestbodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/non_employee_lifecycle_management/base.ts b/sdk-output/non_employee_lifecycle_management/base.ts new file mode 100644 index 00000000..0edeb5b7 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Non-Employee Lifecycle Management + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/non_employee_lifecycle_management/common.ts b/sdk-output/non_employee_lifecycle_management/common.ts new file mode 100644 index 00000000..e008c663 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Non-Employee Lifecycle Management + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/non_employee_lifecycle_management/configuration.ts b/sdk-output/non_employee_lifecycle_management/configuration.ts new file mode 100644 index 00000000..d4e257d3 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Non-Employee Lifecycle Management + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/non_employee_lifecycle_management/git_push.sh b/sdk-output/non_employee_lifecycle_management/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/non_employee_lifecycle_management/index.ts b/sdk-output/non_employee_lifecycle_management/index.ts new file mode 100644 index 00000000..a988ddf5 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Non-Employee Lifecycle Management + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/non_employee_lifecycle_management/package.json b/sdk-output/non_employee_lifecycle_management/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/non_employee_lifecycle_management/tsconfig.json b/sdk-output/non_employee_lifecycle_management/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/notifications/.gitignore b/sdk-output/notifications/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/notifications/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/notifications/.npmignore b/sdk-output/notifications/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/notifications/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/notifications/.openapi-generator-ignore b/sdk-output/notifications/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/notifications/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/notifications/.openapi-generator/FILES b/sdk-output/notifications/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/notifications/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/notifications/.openapi-generator/VERSION b/sdk-output/notifications/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/notifications/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/notifications/.sdk-partition b/sdk-output/notifications/.sdk-partition new file mode 100644 index 00000000..6f96b7b2 --- /dev/null +++ b/sdk-output/notifications/.sdk-partition @@ -0,0 +1 @@ +notifications \ No newline at end of file diff --git a/sdk-output/notifications/README.md b/sdk-output/notifications/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/notifications/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/notifications/api.ts b/sdk-output/notifications/api.ts new file mode 100644 index 00000000..18cf97ed --- /dev/null +++ b/sdk-output/notifications/api.ts @@ -0,0 +1,2704 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Notifications + * 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 CreateDomainDkimV1405ResponseV1 + */ +export interface CreateDomainDkimV1405ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateDomainDkimV1405ResponseV1 + */ + 'errorName'?: any; + /** + * Description of the error + * @type {any} + * @memberof CreateDomainDkimV1405ResponseV1 + */ + 'errorMessage'?: any; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof CreateDomainDkimV1405ResponseV1 + */ + 'trackingId'?: string; +} +/** + * DKIM attributes for a domain or identity + * @export + * @interface DkimattributesV1 + */ +export interface DkimattributesV1 { + /** + * UUID associated with domain to be verified + * @type {string} + * @memberof DkimattributesV1 + */ + 'id'?: string; + /** + * The identity or domain address + * @type {string} + * @memberof DkimattributesV1 + */ + 'address'?: string; + /** + * Whether or not DKIM has been enabled for this domain / identity + * @type {boolean} + * @memberof DkimattributesV1 + */ + 'dkimEnabled'?: boolean; + /** + * The tokens to be added to a DNS for verification + * @type {Array} + * @memberof DkimattributesV1 + */ + 'dkimTokens'?: Array; + /** + * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING + * @type {string} + * @memberof DkimattributesV1 + */ + 'dkimVerificationStatus'?: string; + /** + * The AWS SES region the domain is associated with + * @type {string} + * @memberof DkimattributesV1 + */ + 'region'?: string; +} +/** + * + * @export + * @interface DomainaddressV1 + */ +export interface DomainaddressV1 { + /** + * A domain address + * @type {string} + * @memberof DomainaddressV1 + */ + 'domain'?: string; +} +/** + * Domain status DTO containing everything required to verify via DKIM + * @export + * @interface DomainstatusdtoV1 + */ +export interface DomainstatusdtoV1 { + /** + * New UUID associated with domain to be verified + * @type {string} + * @memberof DomainstatusdtoV1 + */ + 'id'?: string; + /** + * A domain address + * @type {string} + * @memberof DomainstatusdtoV1 + */ + 'domain'?: string; + /** + * DKIM is enabled for this domain + * @type {boolean} + * @memberof DomainstatusdtoV1 + */ + 'dkimEnabled'?: boolean; + /** + * DKIM tokens required for authentication + * @type {Array} + * @memberof DomainstatusdtoV1 + */ + 'dkimTokens'?: Array; + /** + * Status of DKIM authentication + * @type {string} + * @memberof DomainstatusdtoV1 + */ + 'dkimVerificationStatus'?: string; + /** + * The AWS SES region the domain is associated with + * @type {string} + * @memberof DomainstatusdtoV1 + */ + 'region'?: string; +} +/** + * + * @export + * @interface EmailstatusdtoV1 + */ +export interface EmailstatusdtoV1 { + /** + * Unique identifier for the verified sender address + * @type {string} + * @memberof EmailstatusdtoV1 + */ + 'id'?: string | null; + /** + * The verified sender email address + * @type {string} + * @memberof EmailstatusdtoV1 + */ + 'email'?: string; + /** + * Whether the sender address is verified by domain + * @type {boolean} + * @memberof EmailstatusdtoV1 + */ + 'isVerifiedByDomain'?: boolean; + /** + * The verification status of the sender address + * @type {string} + * @memberof EmailstatusdtoV1 + */ + 'verificationStatus'?: EmailstatusdtoV1VerificationStatusV1; + /** + * The AWS SES region the sender address is associated with + * @type {string} + * @memberof EmailstatusdtoV1 + */ + 'region'?: string | null; +} + +export const EmailstatusdtoV1VerificationStatusV1 = { + Pending: 'PENDING', + Success: 'SUCCESS', + Failed: 'FAILED', + Na: 'NA' +} as const; + +export type EmailstatusdtoV1VerificationStatusV1 = typeof EmailstatusdtoV1VerificationStatusV1[keyof typeof EmailstatusdtoV1VerificationStatusV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetNotificationTemplateVariablesV1401ResponseV1 + */ +export interface GetNotificationTemplateVariablesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetNotificationTemplateVariablesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetNotificationTemplateVariablesV1429ResponseV1 + */ +export interface GetNotificationTemplateVariablesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetNotificationTemplateVariablesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * MAIL FROM attributes for a domain / identity + * @export + * @interface MailfromattributesV1 + */ +export interface MailfromattributesV1 { + /** + * The email identity + * @type {string} + * @memberof MailfromattributesV1 + */ + 'identity'?: string; + /** + * The name of a domain that an email identity uses as a custom MAIL FROM domain + * @type {string} + * @memberof MailfromattributesV1 + */ + 'mailFromDomain'?: string; + /** + * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you + * @type {string} + * @memberof MailfromattributesV1 + */ + 'mxRecord'?: string; + /** + * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain + * @type {string} + * @memberof MailfromattributesV1 + */ + 'txtRecord'?: string; + /** + * The current status of the MAIL FROM verification + * @type {string} + * @memberof MailfromattributesV1 + */ + 'mailFromDomainStatus'?: MailfromattributesV1MailFromDomainStatusV1; +} + +export const MailfromattributesV1MailFromDomainStatusV1 = { + Pending: 'PENDING', + Success: 'SUCCESS', + Failed: 'FAILED' +} as const; + +export type MailfromattributesV1MailFromDomainStatusV1 = typeof MailfromattributesV1MailFromDomainStatusV1[keyof typeof MailfromattributesV1MailFromDomainStatusV1]; + +/** + * MAIL FROM attributes for a domain / identity + * @export + * @interface MailfromattributesdtoV1 + */ +export interface MailfromattributesdtoV1 { + /** + * The identity or domain address + * @type {string} + * @memberof MailfromattributesdtoV1 + */ + 'identity'?: string; + /** + * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. + * @type {string} + * @memberof MailfromattributesdtoV1 + */ + 'mailFromDomain'?: string; +} +/** + * The notification medium (EMAIL, SLACK, or TEAMS) + * @export + * @enum {string} + */ + +export const MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type MediumV1 = typeof MediumV1[keyof typeof MediumV1]; + + +/** + * + * @export + * @interface NotificationtemplatecontextV1 + */ +export interface NotificationtemplatecontextV1 { + /** + * A JSON object that stores the context. + * @type {{ [key: string]: any; }} + * @memberof NotificationtemplatecontextV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * When the global context was created + * @type {string} + * @memberof NotificationtemplatecontextV1 + */ + 'created'?: string; + /** + * When the global context was last modified + * @type {string} + * @memberof NotificationtemplatecontextV1 + */ + 'modified'?: string; +} +/** + * Maps an Identity\'s attribute key to a list of preferred notification mediums. + * @export + * @interface PreferencesdtoV1 + */ +export interface PreferencesdtoV1 { + /** + * The template notification key. + * @type {string} + * @memberof PreferencesdtoV1 + */ + 'key'?: string; + /** + * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. + * @type {Array} + * @memberof PreferencesdtoV1 + */ + 'mediums'?: Array; + /** + * Modified date of preference + * @type {string} + * @memberof PreferencesdtoV1 + */ + 'modified'?: string; +} +/** + * + * @export + * @interface SendtestnotificationrequestdtoV1 + */ +export interface SendtestnotificationrequestdtoV1 { + /** + * The template notification key. + * @type {string} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'key'?: string; + /** + * The notification medium. Has to be one of the following enum values. + * @type {string} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'medium'?: SendtestnotificationrequestdtoV1MediumV1; + /** + * The locale for the message text. + * @type {string} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'locale'?: string; + /** + * A Json object that denotes the context specific to the template. + * @type {object} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'context'?: object; + /** + * A list of override recipient email addresses for the test notification. + * @type {Array} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'recipientEmailList'?: Array; + /** + * A list of CC email addresses for the test notification. + * @type {Array} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'carbonCopy'?: Array; + /** + * A list of BCC email addresses for the test notification. + * @type {Array} + * @memberof SendtestnotificationrequestdtoV1 + */ + 'blindCarbonCopy'?: Array; +} + +export const SendtestnotificationrequestdtoV1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type SendtestnotificationrequestdtoV1MediumV1 = typeof SendtestnotificationrequestdtoV1MediumV1[keyof typeof SendtestnotificationrequestdtoV1MediumV1]; + +/** + * + * @export + * @interface TemplatebulkdeletedtoV1 + */ +export interface TemplatebulkdeletedtoV1 { + /** + * The template key to delete + * @type {string} + * @memberof TemplatebulkdeletedtoV1 + */ + 'key': string; + /** + * The notification medium (EMAIL, SLACK, or TEAMS) + * @type {string} + * @memberof TemplatebulkdeletedtoV1 + */ + 'medium'?: TemplatebulkdeletedtoV1MediumV1; + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof TemplatebulkdeletedtoV1 + */ + 'locale'?: string; +} + +export const TemplatebulkdeletedtoV1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type TemplatebulkdeletedtoV1MediumV1 = typeof TemplatebulkdeletedtoV1MediumV1[keyof typeof TemplatebulkdeletedtoV1MediumV1]; + +/** + * + * @export + * @interface TemplatedtoSlackTemplateV1 + */ +export interface TemplatedtoSlackTemplateV1 { + /** + * The template key + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'key'?: string | null; + /** + * The main text content of the Slack message + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'text'?: string; + /** + * JSON string of Slack Block Kit blocks for rich formatting + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'blocks'?: string | null; + /** + * JSON string of Slack attachments + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'attachments'?: string; + /** + * The type of notification + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'notificationType'?: string | null; + /** + * The approval request ID + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'approvalId'?: string | null; + /** + * The request ID + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'requestId'?: string | null; + /** + * The ID of the user who made the request + * @type {string} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'requestedById'?: string | null; + /** + * Whether this is a subscription notification + * @type {boolean} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'isSubscription'?: boolean | null; + /** + * + * @type {TemplateslackAutoApprovalDataV1} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'autoApprovalData'?: TemplateslackAutoApprovalDataV1 | null; + /** + * + * @type {TemplateslackCustomFieldsV1} + * @memberof TemplatedtoSlackTemplateV1 + */ + 'customFields'?: TemplateslackCustomFieldsV1 | null; +} +/** + * + * @export + * @interface TemplatedtoTeamsTemplateV1 + */ +export interface TemplatedtoTeamsTemplateV1 { + /** + * The template key + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'key'?: string | null; + /** + * The title of the Teams message + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'title'?: string | null; + /** + * The main text content of the Teams message + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'text'?: string; + /** + * JSON string of the Teams adaptive card + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'messageJSON'?: string | null; + /** + * Whether this is a subscription notification + * @type {boolean} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'isSubscription'?: boolean | null; + /** + * The approval request ID + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'approvalId'?: string | null; + /** + * The request ID + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'requestId'?: string | null; + /** + * The ID of the user who made the request + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'requestedById'?: string | null; + /** + * The type of notification + * @type {string} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'notificationType'?: string | null; + /** + * + * @type {TemplateslackAutoApprovalDataV1} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'autoApprovalData'?: TemplateslackAutoApprovalDataV1 | null; + /** + * + * @type {TemplateslackCustomFieldsV1} + * @memberof TemplatedtoTeamsTemplateV1 + */ + 'customFields'?: TemplateslackCustomFieldsV1 | null; +} +/** + * + * @export + * @interface TemplatedtoV1 + */ +export interface TemplatedtoV1 { + /** + * The key of the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'key': string; + /** + * The name of the Task Manager Subscription + * @type {string} + * @memberof TemplatedtoV1 + */ + 'name'?: string; + /** + * The message medium. More mediums may be added in the future. + * @type {string} + * @memberof TemplatedtoV1 + */ + 'medium': TemplatedtoV1MediumV1; + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof TemplatedtoV1 + */ + 'locale': string; + /** + * The subject line in the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'subject'?: string; + /** + * The header value is now located within the body field. If included with non-null values, will result in a 400. + * @type {string} + * @memberof TemplatedtoV1 + * @deprecated + */ + 'header'?: string | null; + /** + * The body in the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'body'?: string; + /** + * The footer value is now located within the body field. If included with non-null values, will result in a 400. + * @type {string} + * @memberof TemplatedtoV1 + * @deprecated + */ + 'footer'?: string | null; + /** + * The \"From:\" address in the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'from'?: string; + /** + * The \"Reply To\" line in the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'replyTo'?: string; + /** + * The description in the template + * @type {string} + * @memberof TemplatedtoV1 + */ + 'description'?: string; + /** + * This is auto-generated. + * @type {string} + * @memberof TemplatedtoV1 + */ + 'id'?: string; + /** + * The time when this template is created. This is auto-generated. + * @type {string} + * @memberof TemplatedtoV1 + */ + 'created'?: string; + /** + * The time when this template was last modified. This is auto-generated. + * @type {string} + * @memberof TemplatedtoV1 + */ + 'modified'?: string; + /** + * + * @type {TemplatedtoSlackTemplateV1} + * @memberof TemplatedtoV1 + */ + 'slackTemplate'?: TemplatedtoSlackTemplateV1; + /** + * + * @type {TemplatedtoTeamsTemplateV1} + * @memberof TemplatedtoV1 + */ + 'teamsTemplate'?: TemplatedtoTeamsTemplateV1; +} + +export const TemplatedtoV1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type TemplatedtoV1MediumV1 = typeof TemplatedtoV1MediumV1[keyof typeof TemplatedtoV1MediumV1]; + +/** + * + * @export + * @interface TemplatedtodefaultV1 + */ +export interface TemplatedtodefaultV1 { + /** + * The key of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'key'?: string; + /** + * The name of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'name'?: string; + /** + * The message medium. More mediums may be added in the future. + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'medium'?: TemplatedtodefaultV1MediumV1; + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'locale'?: string; + /** + * The subject of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'subject'?: string | null; + /** + * The header value is now located within the body field. If included with non-null values, will result in a 400. + * @type {string} + * @memberof TemplatedtodefaultV1 + * @deprecated + */ + 'header'?: string | null; + /** + * The body of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'body'?: string; + /** + * The footer value is now located within the body field. If included with non-null values, will result in a 400. + * @type {string} + * @memberof TemplatedtodefaultV1 + * @deprecated + */ + 'footer'?: string | null; + /** + * The \"From:\" address of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'from'?: string | null; + /** + * The \"Reply To\" field of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'replyTo'?: string | null; + /** + * The description of the default template + * @type {string} + * @memberof TemplatedtodefaultV1 + */ + 'description'?: string | null; + /** + * + * @type {TemplateslackV1} + * @memberof TemplatedtodefaultV1 + */ + 'slackTemplate'?: TemplateslackV1 | null; + /** + * + * @type {TemplateteamsV1} + * @memberof TemplatedtodefaultV1 + */ + 'teamsTemplate'?: TemplateteamsV1 | null; +} + +export const TemplatedtodefaultV1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type TemplatedtodefaultV1MediumV1 = typeof TemplatedtodefaultV1MediumV1[keyof typeof TemplatedtodefaultV1MediumV1]; + +/** + * The notification delivery medium. + * @export + * @enum {string} + */ + +export const TemplatemediumdtoV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; + +export type TemplatemediumdtoV1 = typeof TemplatemediumdtoV1[keyof typeof TemplatemediumdtoV1]; + + +/** + * + * @export + * @interface TemplateslackAutoApprovalDataV1 + */ +export interface TemplateslackAutoApprovalDataV1 { + /** + * Whether the request was auto-approved + * @type {string} + * @memberof TemplateslackAutoApprovalDataV1 + */ + 'isAutoApproved'?: string | null; + /** + * The item ID + * @type {string} + * @memberof TemplateslackAutoApprovalDataV1 + */ + 'itemId'?: string | null; + /** + * The item type + * @type {string} + * @memberof TemplateslackAutoApprovalDataV1 + */ + 'itemType'?: string | null; + /** + * JSON message for auto-approval + * @type {string} + * @memberof TemplateslackAutoApprovalDataV1 + */ + 'autoApprovalMessageJSON'?: string | null; + /** + * Title for auto-approval + * @type {string} + * @memberof TemplateslackAutoApprovalDataV1 + */ + 'autoApprovalTitle'?: string | null; +} +/** + * + * @export + * @interface TemplateslackCustomFieldsV1 + */ +export interface TemplateslackCustomFieldsV1 { + /** + * The type of request + * @type {string} + * @memberof TemplateslackCustomFieldsV1 + */ + 'requestType'?: string | null; + /** + * Whether the request contains a deny action + * @type {string} + * @memberof TemplateslackCustomFieldsV1 + */ + 'containsDeny'?: string | null; + /** + * The campaign ID + * @type {string} + * @memberof TemplateslackCustomFieldsV1 + */ + 'campaignId'?: string | null; + /** + * The campaign status + * @type {string} + * @memberof TemplateslackCustomFieldsV1 + */ + 'campaignStatus'?: string | null; +} +/** + * + * @export + * @interface TemplateslackV1 + */ +export interface TemplateslackV1 { + /** + * The template key + * @type {string} + * @memberof TemplateslackV1 + */ + 'key'?: string | null; + /** + * The main text content of the Slack message + * @type {string} + * @memberof TemplateslackV1 + */ + 'text'?: string; + /** + * JSON string of Slack Block Kit blocks for rich formatting + * @type {string} + * @memberof TemplateslackV1 + */ + 'blocks'?: string | null; + /** + * JSON string of Slack attachments + * @type {string} + * @memberof TemplateslackV1 + */ + 'attachments'?: string; + /** + * The type of notification + * @type {string} + * @memberof TemplateslackV1 + */ + 'notificationType'?: string | null; + /** + * The approval request ID + * @type {string} + * @memberof TemplateslackV1 + */ + 'approvalId'?: string | null; + /** + * The request ID + * @type {string} + * @memberof TemplateslackV1 + */ + 'requestId'?: string | null; + /** + * The ID of the user who made the request + * @type {string} + * @memberof TemplateslackV1 + */ + 'requestedById'?: string | null; + /** + * Whether this is a subscription notification + * @type {boolean} + * @memberof TemplateslackV1 + */ + 'isSubscription'?: boolean | null; + /** + * + * @type {TemplateslackAutoApprovalDataV1} + * @memberof TemplateslackV1 + */ + 'autoApprovalData'?: TemplateslackAutoApprovalDataV1 | null; + /** + * + * @type {TemplateslackCustomFieldsV1} + * @memberof TemplateslackV1 + */ + 'customFields'?: TemplateslackCustomFieldsV1 | null; +} +/** + * + * @export + * @interface TemplateteamsV1 + */ +export interface TemplateteamsV1 { + /** + * The template key + * @type {string} + * @memberof TemplateteamsV1 + */ + 'key'?: string | null; + /** + * The title of the Teams message + * @type {string} + * @memberof TemplateteamsV1 + */ + 'title'?: string | null; + /** + * The main text content of the Teams message + * @type {string} + * @memberof TemplateteamsV1 + */ + 'text'?: string; + /** + * JSON string of the Teams adaptive card + * @type {string} + * @memberof TemplateteamsV1 + */ + 'messageJSON'?: string | null; + /** + * Whether this is a subscription notification + * @type {boolean} + * @memberof TemplateteamsV1 + */ + 'isSubscription'?: boolean | null; + /** + * The approval request ID + * @type {string} + * @memberof TemplateteamsV1 + */ + 'approvalId'?: string | null; + /** + * The request ID + * @type {string} + * @memberof TemplateteamsV1 + */ + 'requestId'?: string | null; + /** + * The ID of the user who made the request + * @type {string} + * @memberof TemplateteamsV1 + */ + 'requestedById'?: string | null; + /** + * The type of notification + * @type {string} + * @memberof TemplateteamsV1 + */ + 'notificationType'?: string | null; + /** + * + * @type {TemplateslackAutoApprovalDataV1} + * @memberof TemplateteamsV1 + */ + 'autoApprovalData'?: TemplateslackAutoApprovalDataV1 | null; + /** + * + * @type {TemplateslackCustomFieldsV1} + * @memberof TemplateteamsV1 + */ + 'customFields'?: TemplateslackCustomFieldsV1 | null; +} +/** + * A variable available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). Template variables provide self-documenting metadata about what variables are available when customizing notification templates. + * @export + * @interface TemplatevariableV1 + */ +export interface TemplatevariableV1 { + /** + * The variable name as used when rendering context in templates. + * @type {string} + * @memberof TemplatevariableV1 + */ + 'key'?: string; + /** + * The data type for this variable. Use JSON Schema-like names for values (string, boolean, number, object, array) or \"function\" for template utility/helper functions (e.g. __dateTool.format(), __esc.html()). + * @type {string} + * @memberof TemplatevariableV1 + */ + 'type'?: TemplatevariableV1TypeV1; + /** + * Human-readable description explaining what this variable represents. + * @type {string} + * @memberof TemplatevariableV1 + */ + 'description'?: string | null; + /** + * Example value demonstrating the format and usage. For type \"function\", often a Velocity-style call (e.g. $__esc.html($value)). Can be a string, number, boolean, object, array, or null when no example is defined. + * @type {any} + * @memberof TemplatevariableV1 + */ + 'example'?: any | null; +} + +export const TemplatevariableV1TypeV1 = { + String: 'string', + Boolean: 'boolean', + Number: 'number', + Object: 'object', + Array: 'array', + Function: 'function' +} as const; + +export type TemplatevariableV1TypeV1 = typeof TemplatevariableV1TypeV1[keyof typeof TemplatevariableV1TypeV1]; + +/** + * Variables available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). + * @export + * @interface TemplatevariablesdtoV1 + */ +export interface TemplatevariablesdtoV1 { + /** + * The notification template key. + * @type {string} + * @memberof TemplatevariablesdtoV1 + */ + 'key'?: string; + /** + * + * @type {TemplatemediumdtoV1} + * @memberof TemplatevariablesdtoV1 + */ + 'medium'?: TemplatemediumdtoV1; + /** + * Global variables available to all templates for this tenant (e.g. __global.*, __recipient, __util.*, __dateTool.*, __esc.*). Includes both data variables and function-type helpers. + * @type {Array} + * @memberof TemplatevariablesdtoV1 + */ + 'globalVariables'?: Array | null; + /** + * Template-specific variables for the given key and medium (e.g. approverPath, requester, attributes). + * @type {Array} + * @memberof TemplatevariablesdtoV1 + */ + 'templateVariables'?: Array | null; +} + + + +/** + * NotificationsV1Api - axios parameter creator + * @export + */ +export const NotificationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a domain to be verified via DKIM (DomainKeys Identified Mail) + * @summary Verify domain address via dkim + * @param {DomainaddressV1} domainaddressV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDomainDkimV1: async (domainaddressV1: DomainaddressV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'domainaddressV1' is not null or undefined + assertParamExists('createDomainDkimV1', 'domainaddressV1', domainaddressV1) + const localVarPath = `/verified-domains/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(domainaddressV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + * @summary Create notification template + * @param {TemplatedtoV1} templatedtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNotificationTemplateV1: async (templatedtoV1: TemplatedtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'templatedtoV1' is not null or undefined + assertParamExists('createNotificationTemplateV1', 'templatedtoV1', templatedtoV1) + const localVarPath = `/notification-templates/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(templatedtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Create a new sender email address and initiate verification process. + * @summary Create verified from address + * @param {EmailstatusdtoV1} emailstatusdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createVerifiedFromAddressV1: async (emailstatusdtoV1: EmailstatusdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'emailstatusdtoV1' is not null or undefined + assertParamExists('createVerifiedFromAddressV1', 'emailstatusdtoV1', emailstatusdtoV1) + const localVarPath = `/verified-from-addresses/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(emailstatusdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This lets you bulk delete templates that you previously created for your site. + * @summary Bulk delete notification templates + * @param {Array} templatebulkdeletedtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNotificationTemplatesInBulkV1: async (templatebulkdeletedtoV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'templatebulkdeletedtoV1' is not null or undefined + assertParamExists('deleteNotificationTemplatesInBulkV1', 'templatebulkdeletedtoV1', templatebulkdeletedtoV1) + const localVarPath = `/notification-templates/v1/bulk-delete`; + // 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(templatebulkdeletedtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a verified sender email address + * @summary Delete verified from address + * @param {string} id Unique identifier of the verified sender address to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteVerifiedFromAddressV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteVerifiedFromAddressV1', 'id', id) + const localVarPath = `/verified-from-addresses/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, + }; + }, + /** + * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. + * @summary Get dkim attributes + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDkimAttributesV1: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/verified-domains/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieve MAIL FROM attributes for a given AWS SES identity. + * @summary Get mail from attributes + * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMailFromAttributesV1: async (identity: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identity' is not null or undefined + assertParamExists('getMailFromAttributesV1', 'identity', identity) + const localVarPath = `/mail-from-attributes/v1/{identity}` + .replace(`{${"identity"}}`, encodeURIComponent(String(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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns a list of notification preferences for tenant. + * @summary List notification preferences for tenant. + * @param {string} key The key. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationPreferencesV1: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('getNotificationPreferencesV1', 'key', key) + const localVarPath = `/notification-preferences/v1/{key}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a template that you have modified for your site by Id. + * @summary Get notification template by id + * @param {string} id Id of the Notification Template + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getNotificationTemplateV1', 'id', id) + const localVarPath = `/notification-templates/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, + }; + }, + /** + * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). + * @summary Get notification template variables + * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. + * @param {GetNotificationTemplateVariablesV1MediumV1} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. + * @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: **key, type, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationTemplateVariablesV1: async (key: string, medium: GetNotificationTemplateVariablesV1MediumV1, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('getNotificationTemplateVariablesV1', 'key', key) + // verify required parameter 'medium' is not null or undefined + assertParamExists('getNotificationTemplateVariablesV1', 'medium', medium) + const localVarPath = `/notification-template-variables/v1/{key}/{medium}` + .replace(`{${"key"}}`, encodeURIComponent(String(key))) + .replace(`{${"medium"}}`, encodeURIComponent(String(medium))); + // 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 (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, + }; + }, + /** + * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). + * @summary Get notification template context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationsTemplateContextV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/notification-template-context/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieve a list of sender email addresses and their verification statuses + * @summary List from addresses + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **email**: *eq, ge, le, gt, lt* + * @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: **email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listFromAddressesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/verified-from-addresses/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This lists the default templates used for notifications, such as emails from IdentityNow. + * @summary List notification template defaults + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNotificationTemplateDefaultsV1: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/notification-template-defaults/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This lists the templates that you have modified for your site. + * @summary List notification templates + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @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: **key, name, medium** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNotificationTemplatesV1: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/notification-templates/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS + * @summary Change mail from domain + * @param {MailfromattributesdtoV1} mailfromattributesdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putMailFromAttributesV1: async (mailfromattributesdtoV1: MailfromattributesdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'mailfromattributesdtoV1' is not null or undefined + assertParamExists('putMailFromAttributesV1', 'mailfromattributesdtoV1', mailfromattributesdtoV1) + const localVarPath = `/mail-from-attributes/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: 'PUT', ...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(mailfromattributesdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Send a Test Notification + * @summary Send test notification + * @param {SendtestnotificationrequestdtoV1} sendtestnotificationrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendTestNotificationV1: async (sendtestnotificationrequestdtoV1: SendtestnotificationrequestdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sendtestnotificationrequestdtoV1' is not null or undefined + assertParamExists('sendTestNotificationV1', 'sendtestnotificationrequestdtoV1', sendtestnotificationrequestdtoV1) + const localVarPath = `/send-test-notification/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(sendtestnotificationrequestdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * NotificationsV1Api - functional programming interface + * @export + */ +export const NotificationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NotificationsV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a domain to be verified via DKIM (DomainKeys Identified Mail) + * @summary Verify domain address via dkim + * @param {DomainaddressV1} domainaddressV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createDomainDkimV1(domainaddressV1: DomainaddressV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkimV1(domainaddressV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.createDomainDkimV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + * @summary Create notification template + * @param {TemplatedtoV1} templatedtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createNotificationTemplateV1(templatedtoV1: TemplatedtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplateV1(templatedtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.createNotificationTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create a new sender email address and initiate verification process. + * @summary Create verified from address + * @param {EmailstatusdtoV1} emailstatusdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createVerifiedFromAddressV1(emailstatusdtoV1: EmailstatusdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddressV1(emailstatusdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.createVerifiedFromAddressV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lets you bulk delete templates that you previously created for your site. + * @summary Bulk delete notification templates + * @param {Array} templatebulkdeletedtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNotificationTemplatesInBulkV1(templatebulkdeletedtoV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulkV1(templatebulkdeletedtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.deleteNotificationTemplatesInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a verified sender email address + * @summary Delete verified from address + * @param {string} id Unique identifier of the verified sender address to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteVerifiedFromAddressV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddressV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.deleteVerifiedFromAddressV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. + * @summary Get dkim attributes + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDkimAttributesV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributesV1(limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getDkimAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieve MAIL FROM attributes for a given AWS SES identity. + * @summary Get mail from attributes + * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMailFromAttributesV1(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributesV1(identity, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getMailFromAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of notification preferences for tenant. + * @summary List notification preferences for tenant. + * @param {string} key The key. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNotificationPreferencesV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationPreferencesV1(key, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getNotificationPreferencesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a template that you have modified for your site by Id. + * @summary Get notification template by id + * @param {string} id Id of the Notification Template + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNotificationTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplateV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getNotificationTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). + * @summary Get notification template variables + * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. + * @param {GetNotificationTemplateVariablesV1MediumV1} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. + * @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: **key, type, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNotificationTemplateVariablesV1(key: string, medium: GetNotificationTemplateVariablesV1MediumV1, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplateVariablesV1(key, medium, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getNotificationTemplateVariablesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). + * @summary Get notification template context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContextV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.getNotificationsTemplateContextV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieve a list of sender email addresses and their verification statuses + * @summary List from addresses + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **email**: *eq, ge, le, gt, lt* + * @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: **email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listFromAddressesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddressesV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.listFromAddressesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists the default templates used for notifications, such as emails from IdentityNow. + * @summary List notification template defaults + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNotificationTemplateDefaultsV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaultsV1(limit, offset, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.listNotificationTemplateDefaultsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists the templates that you have modified for your site. + * @summary List notification templates + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @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: **key, name, medium** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listNotificationTemplatesV1(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplatesV1(limit, offset, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.listNotificationTemplatesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS + * @summary Change mail from domain + * @param {MailfromattributesdtoV1} mailfromattributesdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putMailFromAttributesV1(mailfromattributesdtoV1: MailfromattributesdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributesV1(mailfromattributesdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.putMailFromAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send a Test Notification + * @summary Send test notification + * @param {SendtestnotificationrequestdtoV1} sendtestnotificationrequestdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendTestNotificationV1(sendtestnotificationrequestdtoV1: SendtestnotificationrequestdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotificationV1(sendtestnotificationrequestdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsV1Api.sendTestNotificationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * NotificationsV1Api - factory interface + * @export + */ +export const NotificationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NotificationsV1ApiFp(configuration) + return { + /** + * Create a domain to be verified via DKIM (DomainKeys Identified Mail) + * @summary Verify domain address via dkim + * @param {NotificationsV1ApiCreateDomainDkimV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDomainDkimV1(requestParameters: NotificationsV1ApiCreateDomainDkimV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDomainDkimV1(requestParameters.domainaddressV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + * @summary Create notification template + * @param {NotificationsV1ApiCreateNotificationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createNotificationTemplateV1(requestParameters: NotificationsV1ApiCreateNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createNotificationTemplateV1(requestParameters.templatedtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create a new sender email address and initiate verification process. + * @summary Create verified from address + * @param {NotificationsV1ApiCreateVerifiedFromAddressV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createVerifiedFromAddressV1(requestParameters: NotificationsV1ApiCreateVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createVerifiedFromAddressV1(requestParameters.emailstatusdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lets you bulk delete templates that you previously created for your site. + * @summary Bulk delete notification templates + * @param {NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNotificationTemplatesInBulkV1(requestParameters: NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNotificationTemplatesInBulkV1(requestParameters.templatebulkdeletedtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a verified sender email address + * @summary Delete verified from address + * @param {NotificationsV1ApiDeleteVerifiedFromAddressV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteVerifiedFromAddressV1(requestParameters: NotificationsV1ApiDeleteVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteVerifiedFromAddressV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. + * @summary Get dkim attributes + * @param {NotificationsV1ApiGetDkimAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDkimAttributesV1(requestParameters: NotificationsV1ApiGetDkimAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getDkimAttributesV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieve MAIL FROM attributes for a given AWS SES identity. + * @summary Get mail from attributes + * @param {NotificationsV1ApiGetMailFromAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMailFromAttributesV1(requestParameters: NotificationsV1ApiGetMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMailFromAttributesV1(requestParameters.identity, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of notification preferences for tenant. + * @summary List notification preferences for tenant. + * @param {NotificationsV1ApiGetNotificationPreferencesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationPreferencesV1(requestParameters: NotificationsV1ApiGetNotificationPreferencesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNotificationPreferencesV1(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a template that you have modified for your site by Id. + * @summary Get notification template by id + * @param {NotificationsV1ApiGetNotificationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationTemplateV1(requestParameters: NotificationsV1ApiGetNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNotificationTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). + * @summary Get notification template variables + * @param {NotificationsV1ApiGetNotificationTemplateVariablesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationTemplateVariablesV1(requestParameters: NotificationsV1ApiGetNotificationTemplateVariablesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNotificationTemplateVariablesV1(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). + * @summary Get notification template context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNotificationsTemplateContextV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieve a list of sender email addresses and their verification statuses + * @summary List from addresses + * @param {NotificationsV1ApiListFromAddressesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listFromAddressesV1(requestParameters: NotificationsV1ApiListFromAddressesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listFromAddressesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists the default templates used for notifications, such as emails from IdentityNow. + * @summary List notification template defaults + * @param {NotificationsV1ApiListNotificationTemplateDefaultsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNotificationTemplateDefaultsV1(requestParameters: NotificationsV1ApiListNotificationTemplateDefaultsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNotificationTemplateDefaultsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists the templates that you have modified for your site. + * @summary List notification templates + * @param {NotificationsV1ApiListNotificationTemplatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listNotificationTemplatesV1(requestParameters: NotificationsV1ApiListNotificationTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listNotificationTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS + * @summary Change mail from domain + * @param {NotificationsV1ApiPutMailFromAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putMailFromAttributesV1(requestParameters: NotificationsV1ApiPutMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putMailFromAttributesV1(requestParameters.mailfromattributesdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Send a Test Notification + * @summary Send test notification + * @param {NotificationsV1ApiSendTestNotificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendTestNotificationV1(requestParameters: NotificationsV1ApiSendTestNotificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendTestNotificationV1(requestParameters.sendtestnotificationrequestdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDomainDkimV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiCreateDomainDkimV1Request + */ +export interface NotificationsV1ApiCreateDomainDkimV1Request { + /** + * + * @type {DomainaddressV1} + * @memberof NotificationsV1ApiCreateDomainDkimV1 + */ + readonly domainaddressV1: DomainaddressV1 +} + +/** + * Request parameters for createNotificationTemplateV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiCreateNotificationTemplateV1Request + */ +export interface NotificationsV1ApiCreateNotificationTemplateV1Request { + /** + * + * @type {TemplatedtoV1} + * @memberof NotificationsV1ApiCreateNotificationTemplateV1 + */ + readonly templatedtoV1: TemplatedtoV1 +} + +/** + * Request parameters for createVerifiedFromAddressV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiCreateVerifiedFromAddressV1Request + */ +export interface NotificationsV1ApiCreateVerifiedFromAddressV1Request { + /** + * + * @type {EmailstatusdtoV1} + * @memberof NotificationsV1ApiCreateVerifiedFromAddressV1 + */ + readonly emailstatusdtoV1: EmailstatusdtoV1 +} + +/** + * Request parameters for deleteNotificationTemplatesInBulkV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request + */ +export interface NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request { + /** + * + * @type {Array} + * @memberof NotificationsV1ApiDeleteNotificationTemplatesInBulkV1 + */ + readonly templatebulkdeletedtoV1: Array +} + +/** + * Request parameters for deleteVerifiedFromAddressV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiDeleteVerifiedFromAddressV1Request + */ +export interface NotificationsV1ApiDeleteVerifiedFromAddressV1Request { + /** + * Unique identifier of the verified sender address to delete. + * @type {string} + * @memberof NotificationsV1ApiDeleteVerifiedFromAddressV1 + */ + readonly id: string +} + +/** + * Request parameters for getDkimAttributesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiGetDkimAttributesV1Request + */ +export interface NotificationsV1ApiGetDkimAttributesV1Request { + /** + * 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 NotificationsV1ApiGetDkimAttributesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NotificationsV1ApiGetDkimAttributesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for getMailFromAttributesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiGetMailFromAttributesV1Request + */ +export interface NotificationsV1ApiGetMailFromAttributesV1Request { + /** + * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + * @type {string} + * @memberof NotificationsV1ApiGetMailFromAttributesV1 + */ + readonly identity: string +} + +/** + * Request parameters for getNotificationPreferencesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiGetNotificationPreferencesV1Request + */ +export interface NotificationsV1ApiGetNotificationPreferencesV1Request { + /** + * The key. + * @type {string} + * @memberof NotificationsV1ApiGetNotificationPreferencesV1 + */ + readonly key: string +} + +/** + * Request parameters for getNotificationTemplateV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiGetNotificationTemplateV1Request + */ +export interface NotificationsV1ApiGetNotificationTemplateV1Request { + /** + * Id of the Notification Template + * @type {string} + * @memberof NotificationsV1ApiGetNotificationTemplateV1 + */ + readonly id: string +} + +/** + * Request parameters for getNotificationTemplateVariablesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiGetNotificationTemplateVariablesV1Request + */ +export interface NotificationsV1ApiGetNotificationTemplateVariablesV1Request { + /** + * The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. + * @type {string} + * @memberof NotificationsV1ApiGetNotificationTemplateVariablesV1 + */ + readonly key: string + + /** + * The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. + * @type {'EMAIL' | 'SLACK' | 'TEAMS'} + * @memberof NotificationsV1ApiGetNotificationTemplateVariablesV1 + */ + readonly medium: GetNotificationTemplateVariablesV1MediumV1 + + /** + * 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: **key, type, description** + * @type {string} + * @memberof NotificationsV1ApiGetNotificationTemplateVariablesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listFromAddressesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiListFromAddressesV1Request + */ +export interface NotificationsV1ApiListFromAddressesV1Request { + /** + * 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 NotificationsV1ApiListFromAddressesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NotificationsV1ApiListFromAddressesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof NotificationsV1ApiListFromAddressesV1 + */ + 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: **email**: *eq, ge, le, gt, lt* + * @type {string} + * @memberof NotificationsV1ApiListFromAddressesV1 + */ + 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: **email** + * @type {string} + * @memberof NotificationsV1ApiListFromAddressesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listNotificationTemplateDefaultsV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiListNotificationTemplateDefaultsV1Request + */ +export interface NotificationsV1ApiListNotificationTemplateDefaultsV1Request { + /** + * 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 NotificationsV1ApiListNotificationTemplateDefaultsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NotificationsV1ApiListNotificationTemplateDefaultsV1 + */ + readonly offset?: number + + /** + * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @type {string} + * @memberof NotificationsV1ApiListNotificationTemplateDefaultsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listNotificationTemplatesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiListNotificationTemplatesV1Request + */ +export interface NotificationsV1ApiListNotificationTemplatesV1Request { + /** + * 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 NotificationsV1ApiListNotificationTemplatesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof NotificationsV1ApiListNotificationTemplatesV1 + */ + readonly offset?: number + + /** + * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + * @type {string} + * @memberof NotificationsV1ApiListNotificationTemplatesV1 + */ + 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: **key, name, medium** + * @type {string} + * @memberof NotificationsV1ApiListNotificationTemplatesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for putMailFromAttributesV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiPutMailFromAttributesV1Request + */ +export interface NotificationsV1ApiPutMailFromAttributesV1Request { + /** + * + * @type {MailfromattributesdtoV1} + * @memberof NotificationsV1ApiPutMailFromAttributesV1 + */ + readonly mailfromattributesdtoV1: MailfromattributesdtoV1 +} + +/** + * Request parameters for sendTestNotificationV1 operation in NotificationsV1Api. + * @export + * @interface NotificationsV1ApiSendTestNotificationV1Request + */ +export interface NotificationsV1ApiSendTestNotificationV1Request { + /** + * + * @type {SendtestnotificationrequestdtoV1} + * @memberof NotificationsV1ApiSendTestNotificationV1 + */ + readonly sendtestnotificationrequestdtoV1: SendtestnotificationrequestdtoV1 +} + +/** + * NotificationsV1Api - object-oriented interface + * @export + * @class NotificationsV1Api + * @extends {BaseAPI} + */ +export class NotificationsV1Api extends BaseAPI { + /** + * Create a domain to be verified via DKIM (DomainKeys Identified Mail) + * @summary Verify domain address via dkim + * @param {NotificationsV1ApiCreateDomainDkimV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public createDomainDkimV1(requestParameters: NotificationsV1ApiCreateDomainDkimV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).createDomainDkimV1(requestParameters.domainaddressV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + * @summary Create notification template + * @param {NotificationsV1ApiCreateNotificationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public createNotificationTemplateV1(requestParameters: NotificationsV1ApiCreateNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).createNotificationTemplateV1(requestParameters.templatedtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create a new sender email address and initiate verification process. + * @summary Create verified from address + * @param {NotificationsV1ApiCreateVerifiedFromAddressV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public createVerifiedFromAddressV1(requestParameters: NotificationsV1ApiCreateVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).createVerifiedFromAddressV1(requestParameters.emailstatusdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lets you bulk delete templates that you previously created for your site. + * @summary Bulk delete notification templates + * @param {NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public deleteNotificationTemplatesInBulkV1(requestParameters: NotificationsV1ApiDeleteNotificationTemplatesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).deleteNotificationTemplatesInBulkV1(requestParameters.templatebulkdeletedtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a verified sender email address + * @summary Delete verified from address + * @param {NotificationsV1ApiDeleteVerifiedFromAddressV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public deleteVerifiedFromAddressV1(requestParameters: NotificationsV1ApiDeleteVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).deleteVerifiedFromAddressV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. + * @summary Get dkim attributes + * @param {NotificationsV1ApiGetDkimAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getDkimAttributesV1(requestParameters: NotificationsV1ApiGetDkimAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getDkimAttributesV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieve MAIL FROM attributes for a given AWS SES identity. + * @summary Get mail from attributes + * @param {NotificationsV1ApiGetMailFromAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getMailFromAttributesV1(requestParameters: NotificationsV1ApiGetMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getMailFromAttributesV1(requestParameters.identity, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of notification preferences for tenant. + * @summary List notification preferences for tenant. + * @param {NotificationsV1ApiGetNotificationPreferencesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getNotificationPreferencesV1(requestParameters: NotificationsV1ApiGetNotificationPreferencesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getNotificationPreferencesV1(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a template that you have modified for your site by Id. + * @summary Get notification template by id + * @param {NotificationsV1ApiGetNotificationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getNotificationTemplateV1(requestParameters: NotificationsV1ApiGetNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getNotificationTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). + * @summary Get notification template variables + * @param {NotificationsV1ApiGetNotificationTemplateVariablesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getNotificationTemplateVariablesV1(requestParameters: NotificationsV1ApiGetNotificationTemplateVariablesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getNotificationTemplateVariablesV1(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). + * @summary Get notification template context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).getNotificationsTemplateContextV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieve a list of sender email addresses and their verification statuses + * @summary List from addresses + * @param {NotificationsV1ApiListFromAddressesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public listFromAddressesV1(requestParameters: NotificationsV1ApiListFromAddressesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).listFromAddressesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists the default templates used for notifications, such as emails from IdentityNow. + * @summary List notification template defaults + * @param {NotificationsV1ApiListNotificationTemplateDefaultsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public listNotificationTemplateDefaultsV1(requestParameters: NotificationsV1ApiListNotificationTemplateDefaultsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).listNotificationTemplateDefaultsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists the templates that you have modified for your site. + * @summary List notification templates + * @param {NotificationsV1ApiListNotificationTemplatesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public listNotificationTemplatesV1(requestParameters: NotificationsV1ApiListNotificationTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).listNotificationTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS + * @summary Change mail from domain + * @param {NotificationsV1ApiPutMailFromAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public putMailFromAttributesV1(requestParameters: NotificationsV1ApiPutMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).putMailFromAttributesV1(requestParameters.mailfromattributesdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send a Test Notification + * @summary Send test notification + * @param {NotificationsV1ApiSendTestNotificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsV1Api + */ + public sendTestNotificationV1(requestParameters: NotificationsV1ApiSendTestNotificationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return NotificationsV1ApiFp(this.configuration).sendTestNotificationV1(requestParameters.sendtestnotificationrequestdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetNotificationTemplateVariablesV1MediumV1 = { + Email: 'EMAIL', + Slack: 'SLACK', + Teams: 'TEAMS' +} as const; +export type GetNotificationTemplateVariablesV1MediumV1 = typeof GetNotificationTemplateVariablesV1MediumV1[keyof typeof GetNotificationTemplateVariablesV1MediumV1]; + + diff --git a/sdk-output/notifications/base.ts b/sdk-output/notifications/base.ts new file mode 100644 index 00000000..11877af2 --- /dev/null +++ b/sdk-output/notifications/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Notifications + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/notifications/common.ts b/sdk-output/notifications/common.ts new file mode 100644 index 00000000..758a61e3 --- /dev/null +++ b/sdk-output/notifications/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Notifications + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/notifications/configuration.ts b/sdk-output/notifications/configuration.ts new file mode 100644 index 00000000..8edf4a29 --- /dev/null +++ b/sdk-output/notifications/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Notifications + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/notifications/git_push.sh b/sdk-output/notifications/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/notifications/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/notifications/index.ts b/sdk-output/notifications/index.ts new file mode 100644 index 00000000..be8a2324 --- /dev/null +++ b/sdk-output/notifications/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Notifications + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/notifications/package.json b/sdk-output/notifications/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/notifications/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/notifications/tsconfig.json b/sdk-output/notifications/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/notifications/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/oauth_clients/.gitignore b/sdk-output/oauth_clients/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/oauth_clients/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/oauth_clients/.npmignore b/sdk-output/oauth_clients/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/oauth_clients/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/oauth_clients/.openapi-generator-ignore b/sdk-output/oauth_clients/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/oauth_clients/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/oauth_clients/.openapi-generator/FILES b/sdk-output/oauth_clients/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/oauth_clients/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/oauth_clients/.openapi-generator/VERSION b/sdk-output/oauth_clients/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/oauth_clients/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/oauth_clients/.sdk-partition b/sdk-output/oauth_clients/.sdk-partition new file mode 100644 index 00000000..aaff69c0 --- /dev/null +++ b/sdk-output/oauth_clients/.sdk-partition @@ -0,0 +1 @@ +oauth-clients \ No newline at end of file diff --git a/sdk-output/oauth_clients/README.md b/sdk-output/oauth_clients/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/oauth_clients/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/oauth_clients/api.ts b/sdk-output/oauth_clients/api.ts new file mode 100644 index 00000000..012880e9 --- /dev/null +++ b/sdk-output/oauth_clients/api.ts @@ -0,0 +1,1046 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - OAuth 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'; + +/** + * Access type of API Client indicating online or offline use + * @export + * @enum {string} + */ + +export const AccesstypeV1 = { + Online: 'ONLINE', + Offline: 'OFFLINE' +} as const; + +export type AccesstypeV1 = typeof AccesstypeV1[keyof typeof AccesstypeV1]; + + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Type of an API Client indicating public or confidentials use + * @export + * @enum {string} + */ + +export const ClienttypeV1 = { + Confidential: 'CONFIDENTIAL', + Public: 'PUBLIC' +} as const; + +export type ClienttypeV1 = typeof ClienttypeV1[keyof typeof ClienttypeV1]; + + +/** + * + * @export + * @interface CreateoauthclientrequestV1 + */ +export interface CreateoauthclientrequestV1 { + /** + * The name of the business the API Client should belong to + * @type {string} + * @memberof CreateoauthclientrequestV1 + */ + 'businessName'?: string | null; + /** + * The homepage URL associated with the owner of the API Client + * @type {string} + * @memberof CreateoauthclientrequestV1 + */ + 'homepageUrl'?: string | null; + /** + * A human-readable name for the API Client + * @type {string} + * @memberof CreateoauthclientrequestV1 + */ + 'name': string | null; + /** + * A description of the API Client + * @type {string} + * @memberof CreateoauthclientrequestV1 + */ + 'description': string | null; + /** + * The number of seconds an access token generated for this API Client is valid for + * @type {number} + * @memberof CreateoauthclientrequestV1 + */ + 'accessTokenValiditySeconds': number; + /** + * The number of seconds a refresh token generated for this API Client is valid for + * @type {number} + * @memberof CreateoauthclientrequestV1 + */ + 'refreshTokenValiditySeconds'?: number; + /** + * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. + * @type {Array} + * @memberof CreateoauthclientrequestV1 + */ + 'redirectUris'?: Array | null; + /** + * A list of OAuth 2.0 grant types this API Client can be used with + * @type {Array} + * @memberof CreateoauthclientrequestV1 + */ + 'grantTypes': Array | null; + /** + * + * @type {AccesstypeV1} + * @memberof CreateoauthclientrequestV1 + */ + 'accessType': AccesstypeV1; + /** + * + * @type {ClienttypeV1} + * @memberof CreateoauthclientrequestV1 + */ + 'type'?: ClienttypeV1; + /** + * An indicator of whether the API Client can be used for requests internal within the product. + * @type {boolean} + * @memberof CreateoauthclientrequestV1 + */ + 'internal'?: boolean; + /** + * An indicator of whether the API Client is enabled for use + * @type {boolean} + * @memberof CreateoauthclientrequestV1 + */ + 'enabled': boolean; + /** + * An indicator of whether the API Client supports strong authentication + * @type {boolean} + * @memberof CreateoauthclientrequestV1 + */ + 'strongAuthSupported'?: boolean; + /** + * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + * @type {boolean} + * @memberof CreateoauthclientrequestV1 + */ + 'claimsSupported'?: boolean; + /** + * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. + * @type {Array} + * @memberof CreateoauthclientrequestV1 + */ + 'scope'?: Array | null; +} + + +/** + * + * @export + * @interface CreateoauthclientresponseV1 + */ +export interface CreateoauthclientresponseV1 { + /** + * ID of the OAuth client + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'id': string; + /** + * Secret of the OAuth client (This field is only returned on the intial create call.) + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'secret': string; + /** + * The name of the business the API Client should belong to + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'businessName': string; + /** + * The homepage URL associated with the owner of the API Client + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'homepageUrl': string; + /** + * A human-readable name for the API Client + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'name': string; + /** + * A description of the API Client + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'description': string; + /** + * The number of seconds an access token generated for this API Client is valid for + * @type {number} + * @memberof CreateoauthclientresponseV1 + */ + 'accessTokenValiditySeconds': number; + /** + * The number of seconds a refresh token generated for this API Client is valid for + * @type {number} + * @memberof CreateoauthclientresponseV1 + */ + 'refreshTokenValiditySeconds': number; + /** + * A list of the approved redirect URIs used with the authorization_code flow + * @type {Array} + * @memberof CreateoauthclientresponseV1 + */ + 'redirectUris': Array; + /** + * A list of OAuth 2.0 grant types this API Client can be used with + * @type {Array} + * @memberof CreateoauthclientresponseV1 + */ + 'grantTypes': Array; + /** + * + * @type {AccesstypeV1} + * @memberof CreateoauthclientresponseV1 + */ + 'accessType': AccesstypeV1; + /** + * + * @type {ClienttypeV1} + * @memberof CreateoauthclientresponseV1 + */ + 'type': ClienttypeV1; + /** + * An indicator of whether the API Client can be used for requests internal to IDN + * @type {boolean} + * @memberof CreateoauthclientresponseV1 + */ + 'internal': boolean; + /** + * An indicator of whether the API Client is enabled for use + * @type {boolean} + * @memberof CreateoauthclientresponseV1 + */ + 'enabled': boolean; + /** + * An indicator of whether the API Client supports strong authentication + * @type {boolean} + * @memberof CreateoauthclientresponseV1 + */ + 'strongAuthSupported': boolean; + /** + * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + * @type {boolean} + * @memberof CreateoauthclientresponseV1 + */ + 'claimsSupported': boolean; + /** + * The date and time, down to the millisecond, when the API Client was created + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'created': string; + /** + * The date and time, down to the millisecond, when the API Client was last updated + * @type {string} + * @memberof CreateoauthclientresponseV1 + */ + 'modified': string; + /** + * Scopes of the API Client. + * @type {Array} + * @memberof CreateoauthclientresponseV1 + */ + 'scope': Array | null; +} + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetoauthclientresponseV1 + */ +export interface GetoauthclientresponseV1 { + /** + * ID of the OAuth client + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'id': string; + /** + * The name of the business the API Client should belong to + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'businessName': string | null; + /** + * The homepage URL associated with the owner of the API Client + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'homepageUrl': string | null; + /** + * A human-readable name for the API Client + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'name': string; + /** + * A description of the API Client + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'description': string | null; + /** + * The number of seconds an access token generated for this API Client is valid for + * @type {number} + * @memberof GetoauthclientresponseV1 + */ + 'accessTokenValiditySeconds': number; + /** + * The number of seconds a refresh token generated for this API Client is valid for + * @type {number} + * @memberof GetoauthclientresponseV1 + */ + 'refreshTokenValiditySeconds': number; + /** + * A list of the approved redirect URIs used with the authorization_code flow + * @type {Array} + * @memberof GetoauthclientresponseV1 + */ + 'redirectUris': Array | null; + /** + * A list of OAuth 2.0 grant types this API Client can be used with + * @type {Array} + * @memberof GetoauthclientresponseV1 + */ + 'grantTypes': Array; + /** + * + * @type {AccesstypeV1} + * @memberof GetoauthclientresponseV1 + */ + 'accessType': AccesstypeV1; + /** + * + * @type {ClienttypeV1} + * @memberof GetoauthclientresponseV1 + */ + 'type': ClienttypeV1; + /** + * An indicator of whether the API Client can be used for requests internal to IDN + * @type {boolean} + * @memberof GetoauthclientresponseV1 + */ + 'internal': boolean; + /** + * An indicator of whether the API Client is enabled for use + * @type {boolean} + * @memberof GetoauthclientresponseV1 + */ + 'enabled': boolean; + /** + * An indicator of whether the API Client supports strong authentication + * @type {boolean} + * @memberof GetoauthclientresponseV1 + */ + 'strongAuthSupported': boolean; + /** + * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow + * @type {boolean} + * @memberof GetoauthclientresponseV1 + */ + 'claimsSupported': boolean; + /** + * The date and time, down to the millisecond, when the API Client was created + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'created': string; + /** + * The date and time, down to the millisecond, when the API Client was last updated + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'modified': string; + /** + * + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'secret'?: string | null; + /** + * + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'metadata'?: string | null; + /** + * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. + * @type {string} + * @memberof GetoauthclientresponseV1 + */ + 'lastUsed'?: string | null; + /** + * Scopes of the API Client. + * @type {Array} + * @memberof GetoauthclientresponseV1 + */ + 'scope': Array | null; +} + + +/** + * OAuth2 Grant Type + * @export + * @enum {string} + */ + +export const GranttypeV1 = { + ClientCredentials: 'CLIENT_CREDENTIALS', + AuthorizationCode: 'AUTHORIZATION_CODE', + RefreshToken: 'REFRESH_TOKEN' +} as const; + +export type GranttypeV1 = typeof GranttypeV1[keyof typeof GranttypeV1]; + + +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListOauthClientsV1401ResponseV1 + */ +export interface ListOauthClientsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListOauthClientsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListOauthClientsV1429ResponseV1 + */ +export interface ListOauthClientsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListOauthClientsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * OAuthClientsV1Api - axios parameter creator + * @export + */ +export const OAuthClientsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This creates an OAuth client. + * @summary Create oauth client + * @param {CreateoauthclientrequestV1} createoauthclientrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createOauthClientV1: async (createoauthclientrequestV1: CreateoauthclientrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createoauthclientrequestV1' is not null or undefined + assertParamExists('createOauthClientV1', 'createoauthclientrequestV1', createoauthclientrequestV1) + const localVarPath = `/oauth-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(createoauthclientrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes an OAuth client. + * @summary Delete oauth client + * @param {string} id The OAuth client id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteOauthClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteOauthClientV1', 'id', id) + const localVarPath = `/oauth-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, + }; + }, + /** + * This gets details of an OAuth client. + * @summary Get oauth client + * @param {string} id The OAuth client id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOauthClientV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getOauthClientV1', 'id', id) + const localVarPath = `/oauth-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, + }; + }, + /** + * This gets a list of OAuth clients. + * @summary List oauth clients + * @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: **lastUsed**: *le, isnull* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOauthClientsV1: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/oauth-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 (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This performs a targeted update to the field(s) of an OAuth client. + * @summary Patch oauth client + * @param {string} id The OAuth client id + * @param {Array} jsonpatchoperationV1 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchOauthClientV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchOauthClientV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchOauthClientV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/oauth-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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * OAuthClientsV1Api - functional programming interface + * @export + */ +export const OAuthClientsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = OAuthClientsV1ApiAxiosParamCreator(configuration) + return { + /** + * This creates an OAuth client. + * @summary Create oauth client + * @param {CreateoauthclientrequestV1} createoauthclientrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createOauthClientV1(createoauthclientrequestV1: CreateoauthclientrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClientV1(createoauthclientrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OAuthClientsV1Api.createOauthClientV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes an OAuth client. + * @summary Delete oauth client + * @param {string} id The OAuth client id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteOauthClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClientV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OAuthClientsV1Api.deleteOauthClientV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets details of an OAuth client. + * @summary Get oauth client + * @param {string} id The OAuth client id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getOauthClientV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClientV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OAuthClientsV1Api.getOauthClientV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a list of OAuth clients. + * @summary List oauth clients + * @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: **lastUsed**: *le, isnull* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listOauthClientsV1(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClientsV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OAuthClientsV1Api.listOauthClientsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This performs a targeted update to the field(s) of an OAuth client. + * @summary Patch oauth client + * @param {string} id The OAuth client id + * @param {Array} jsonpatchoperationV1 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchOauthClientV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClientV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OAuthClientsV1Api.patchOauthClientV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * OAuthClientsV1Api - factory interface + * @export + */ +export const OAuthClientsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = OAuthClientsV1ApiFp(configuration) + return { + /** + * This creates an OAuth client. + * @summary Create oauth client + * @param {OAuthClientsV1ApiCreateOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createOauthClientV1(requestParameters: OAuthClientsV1ApiCreateOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createOauthClientV1(requestParameters.createoauthclientrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes an OAuth client. + * @summary Delete oauth client + * @param {OAuthClientsV1ApiDeleteOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteOauthClientV1(requestParameters: OAuthClientsV1ApiDeleteOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets details of an OAuth client. + * @summary Get oauth client + * @param {OAuthClientsV1ApiGetOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOauthClientV1(requestParameters: OAuthClientsV1ApiGetOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a list of OAuth clients. + * @summary List oauth clients + * @param {OAuthClientsV1ApiListOauthClientsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listOauthClientsV1(requestParameters: OAuthClientsV1ApiListOauthClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listOauthClientsV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This performs a targeted update to the field(s) of an OAuth client. + * @summary Patch oauth client + * @param {OAuthClientsV1ApiPatchOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchOauthClientV1(requestParameters: OAuthClientsV1ApiPatchOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchOauthClientV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createOauthClientV1 operation in OAuthClientsV1Api. + * @export + * @interface OAuthClientsV1ApiCreateOauthClientV1Request + */ +export interface OAuthClientsV1ApiCreateOauthClientV1Request { + /** + * + * @type {CreateoauthclientrequestV1} + * @memberof OAuthClientsV1ApiCreateOauthClientV1 + */ + readonly createoauthclientrequestV1: CreateoauthclientrequestV1 +} + +/** + * Request parameters for deleteOauthClientV1 operation in OAuthClientsV1Api. + * @export + * @interface OAuthClientsV1ApiDeleteOauthClientV1Request + */ +export interface OAuthClientsV1ApiDeleteOauthClientV1Request { + /** + * The OAuth client id + * @type {string} + * @memberof OAuthClientsV1ApiDeleteOauthClientV1 + */ + readonly id: string +} + +/** + * Request parameters for getOauthClientV1 operation in OAuthClientsV1Api. + * @export + * @interface OAuthClientsV1ApiGetOauthClientV1Request + */ +export interface OAuthClientsV1ApiGetOauthClientV1Request { + /** + * The OAuth client id + * @type {string} + * @memberof OAuthClientsV1ApiGetOauthClientV1 + */ + readonly id: string +} + +/** + * Request parameters for listOauthClientsV1 operation in OAuthClientsV1Api. + * @export + * @interface OAuthClientsV1ApiListOauthClientsV1Request + */ +export interface OAuthClientsV1ApiListOauthClientsV1Request { + /** + * 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: **lastUsed**: *le, isnull* + * @type {string} + * @memberof OAuthClientsV1ApiListOauthClientsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for patchOauthClientV1 operation in OAuthClientsV1Api. + * @export + * @interface OAuthClientsV1ApiPatchOauthClientV1Request + */ +export interface OAuthClientsV1ApiPatchOauthClientV1Request { + /** + * The OAuth client id + * @type {string} + * @memberof OAuthClientsV1ApiPatchOauthClientV1 + */ + readonly id: string + + /** + * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + * @type {Array} + * @memberof OAuthClientsV1ApiPatchOauthClientV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * OAuthClientsV1Api - object-oriented interface + * @export + * @class OAuthClientsV1Api + * @extends {BaseAPI} + */ +export class OAuthClientsV1Api extends BaseAPI { + /** + * This creates an OAuth client. + * @summary Create oauth client + * @param {OAuthClientsV1ApiCreateOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OAuthClientsV1Api + */ + public createOauthClientV1(requestParameters: OAuthClientsV1ApiCreateOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return OAuthClientsV1ApiFp(this.configuration).createOauthClientV1(requestParameters.createoauthclientrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes an OAuth client. + * @summary Delete oauth client + * @param {OAuthClientsV1ApiDeleteOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OAuthClientsV1Api + */ + public deleteOauthClientV1(requestParameters: OAuthClientsV1ApiDeleteOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return OAuthClientsV1ApiFp(this.configuration).deleteOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets details of an OAuth client. + * @summary Get oauth client + * @param {OAuthClientsV1ApiGetOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OAuthClientsV1Api + */ + public getOauthClientV1(requestParameters: OAuthClientsV1ApiGetOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return OAuthClientsV1ApiFp(this.configuration).getOauthClientV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a list of OAuth clients. + * @summary List oauth clients + * @param {OAuthClientsV1ApiListOauthClientsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OAuthClientsV1Api + */ + public listOauthClientsV1(requestParameters: OAuthClientsV1ApiListOauthClientsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return OAuthClientsV1ApiFp(this.configuration).listOauthClientsV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This performs a targeted update to the field(s) of an OAuth client. + * @summary Patch oauth client + * @param {OAuthClientsV1ApiPatchOauthClientV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OAuthClientsV1Api + */ + public patchOauthClientV1(requestParameters: OAuthClientsV1ApiPatchOauthClientV1Request, axiosOptions?: RawAxiosRequestConfig) { + return OAuthClientsV1ApiFp(this.configuration).patchOauthClientV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/oauth_clients/base.ts b/sdk-output/oauth_clients/base.ts new file mode 100644 index 00000000..ec6b828a --- /dev/null +++ b/sdk-output/oauth_clients/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - OAuth 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/oauth_clients/common.ts b/sdk-output/oauth_clients/common.ts new file mode 100644 index 00000000..f4e9b793 --- /dev/null +++ b/sdk-output/oauth_clients/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - OAuth 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/oauth_clients/configuration.ts b/sdk-output/oauth_clients/configuration.ts new file mode 100644 index 00000000..8687c198 --- /dev/null +++ b/sdk-output/oauth_clients/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - OAuth 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/oauth_clients/git_push.sh b/sdk-output/oauth_clients/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/oauth_clients/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/oauth_clients/index.ts b/sdk-output/oauth_clients/index.ts new file mode 100644 index 00000000..36abdd68 --- /dev/null +++ b/sdk-output/oauth_clients/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - OAuth 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/oauth_clients/package.json b/sdk-output/oauth_clients/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/oauth_clients/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/oauth_clients/tsconfig.json b/sdk-output/oauth_clients/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/oauth_clients/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/org_config/.gitignore b/sdk-output/org_config/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/org_config/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/org_config/.npmignore b/sdk-output/org_config/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/org_config/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/org_config/.openapi-generator-ignore b/sdk-output/org_config/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/org_config/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/org_config/.openapi-generator/FILES b/sdk-output/org_config/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/org_config/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/org_config/.openapi-generator/VERSION b/sdk-output/org_config/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/org_config/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/org_config/.sdk-partition b/sdk-output/org_config/.sdk-partition new file mode 100644 index 00000000..37a22db6 --- /dev/null +++ b/sdk-output/org_config/.sdk-partition @@ -0,0 +1 @@ +org-config \ No newline at end of file diff --git a/sdk-output/org_config/README.md b/sdk-output/org_config/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/org_config/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/org_config/api.ts b/sdk-output/org_config/api.ts new file mode 100644 index 00000000..1c85c315 --- /dev/null +++ b/sdk-output/org_config/api.ts @@ -0,0 +1,585 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Org Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetOrgConfigV1401ResponseV1 + */ +export interface GetOrgConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetOrgConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetOrgConfigV1429ResponseV1 + */ +export interface GetOrgConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetOrgConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users + * @export + * @interface OrgconfigV1 + */ +export interface OrgconfigV1 { + /** + * The name of the org. + * @type {string} + * @memberof OrgconfigV1 + */ + 'orgName'?: string; + /** + * The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones + * @type {string} + * @memberof OrgconfigV1 + */ + 'timeZone'?: string; + /** + * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. + * @type {boolean} + * @memberof OrgconfigV1 + */ + 'lcsChangeHonorsSourceEnableFeature'?: boolean; + /** + * ARM Customer ID + * @type {string} + * @memberof OrgconfigV1 + */ + 'armCustomerId'?: string | null; + /** + * A list of IDN::sourceId to ARM::systemId mappings. + * @type {string} + * @memberof OrgconfigV1 + */ + 'armSapSystemIdMappings'?: string | null; + /** + * ARM authentication string + * @type {string} + * @memberof OrgconfigV1 + */ + 'armAuth'?: string | null; + /** + * ARM database name + * @type {string} + * @memberof OrgconfigV1 + */ + 'armDb'?: string | null; + /** + * ARM SSO URL + * @type {string} + * @memberof OrgconfigV1 + */ + 'armSsoUrl'?: string | null; + /** + * Flag to determine whether IAI Certification Recommendations are enabled for the current org + * @type {boolean} + * @memberof OrgconfigV1 + */ + 'iaiEnableCertificationRecommendations'?: boolean; + /** + * + * @type {Array} + * @memberof OrgconfigV1 + */ + 'sodReportConfigs'?: Array; +} +/** + * + * @export + * @interface ReportconfigdtoV1 + */ +export interface ReportconfigdtoV1 { + /** + * Name of column in report + * @type {string} + * @memberof ReportconfigdtoV1 + */ + 'columnName'?: string; + /** + * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. + * @type {boolean} + * @memberof ReportconfigdtoV1 + */ + 'required'?: boolean; + /** + * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. + * @type {boolean} + * @memberof ReportconfigdtoV1 + */ + 'included'?: boolean; + /** + * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. + * @type {number} + * @memberof ReportconfigdtoV1 + */ + 'order'?: number; +} + +/** + * OrgConfigV1Api - axios parameter creator + * @export + */ +export const OrgConfigV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get the current organization\'s configuration settings, only external accessible properties. + * @summary Get org config settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOrgConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/org-config/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * List the valid time zones that can be set in organization configurations. + * @summary Get valid time zones + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getValidTimeZonesV1: async (xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/org-config/v1/valid-time-zones`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. + * @summary Patch org config + * @param {Array} jsonpatchoperationV1 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchOrgConfigV1: async (jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchOrgConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/org-config/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; + + + + 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * OrgConfigV1Api - functional programming interface + * @export + */ +export const OrgConfigV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = OrgConfigV1ApiAxiosParamCreator(configuration) + return { + /** + * Get the current organization\'s configuration settings, only external accessible properties. + * @summary Get org config settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OrgConfigV1Api.getOrgConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List the valid time zones that can be set in organization configurations. + * @summary Get valid time zones + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getValidTimeZonesV1(xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZonesV1(xSailPointExperimental, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OrgConfigV1Api.getValidTimeZonesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. + * @summary Patch org config + * @param {Array} jsonpatchoperationV1 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchOrgConfigV1(jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfigV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OrgConfigV1Api.patchOrgConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * OrgConfigV1Api - factory interface + * @export + */ +export const OrgConfigV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = OrgConfigV1ApiFp(configuration) + return { + /** + * Get the current organization\'s configuration settings, only external accessible properties. + * @summary Get org config settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getOrgConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List the valid time zones that can be set in organization configurations. + * @summary Get valid time zones + * @param {OrgConfigV1ApiGetValidTimeZonesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getValidTimeZonesV1(requestParameters: OrgConfigV1ApiGetValidTimeZonesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getValidTimeZonesV1(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. + * @summary Patch org config + * @param {OrgConfigV1ApiPatchOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchOrgConfigV1(requestParameters: OrgConfigV1ApiPatchOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchOrgConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getValidTimeZonesV1 operation in OrgConfigV1Api. + * @export + * @interface OrgConfigV1ApiGetValidTimeZonesV1Request + */ +export interface OrgConfigV1ApiGetValidTimeZonesV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof OrgConfigV1ApiGetValidTimeZonesV1 + */ + readonly xSailPointExperimental?: string + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof OrgConfigV1ApiGetValidTimeZonesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof OrgConfigV1ApiGetValidTimeZonesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof OrgConfigV1ApiGetValidTimeZonesV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for patchOrgConfigV1 operation in OrgConfigV1Api. + * @export + * @interface OrgConfigV1ApiPatchOrgConfigV1Request + */ +export interface OrgConfigV1ApiPatchOrgConfigV1Request { + /** + * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof OrgConfigV1ApiPatchOrgConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * OrgConfigV1Api - object-oriented interface + * @export + * @class OrgConfigV1Api + * @extends {BaseAPI} + */ +export class OrgConfigV1Api extends BaseAPI { + /** + * Get the current organization\'s configuration settings, only external accessible properties. + * @summary Get org config settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OrgConfigV1Api + */ + public getOrgConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return OrgConfigV1ApiFp(this.configuration).getOrgConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List the valid time zones that can be set in organization configurations. + * @summary Get valid time zones + * @param {OrgConfigV1ApiGetValidTimeZonesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OrgConfigV1Api + */ + public getValidTimeZonesV1(requestParameters: OrgConfigV1ApiGetValidTimeZonesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return OrgConfigV1ApiFp(this.configuration).getValidTimeZonesV1(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. + * @summary Patch org config + * @param {OrgConfigV1ApiPatchOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof OrgConfigV1Api + */ + public patchOrgConfigV1(requestParameters: OrgConfigV1ApiPatchOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return OrgConfigV1ApiFp(this.configuration).patchOrgConfigV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/org_config/base.ts b/sdk-output/org_config/base.ts new file mode 100644 index 00000000..a9a0f396 --- /dev/null +++ b/sdk-output/org_config/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Org Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/org_config/common.ts b/sdk-output/org_config/common.ts new file mode 100644 index 00000000..0796401c --- /dev/null +++ b/sdk-output/org_config/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Org Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/org_config/configuration.ts b/sdk-output/org_config/configuration.ts new file mode 100644 index 00000000..0c44e948 --- /dev/null +++ b/sdk-output/org_config/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Org Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/org_config/git_push.sh b/sdk-output/org_config/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/org_config/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/org_config/index.ts b/sdk-output/org_config/index.ts new file mode 100644 index 00000000..8d67c8cd --- /dev/null +++ b/sdk-output/org_config/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Org Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/org_config/package.json b/sdk-output/org_config/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/org_config/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/org_config/tsconfig.json b/sdk-output/org_config/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/org_config/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/package.json b/sdk-output/package.json index c5f21681..e99a7d12 100644 --- a/sdk-output/package.json +++ b/sdk-output/package.json @@ -56,12 +56,10 @@ "/node_modules/" ], "modulePathIgnorePatterns": [ - "/beta/", + "/.*_v1/", "/generic/", - "/v3/", - "/v2024/", - "/v2025/", - "/v2026/", + "/nerm/", + "/nermv2025/", "/dist/" ] } diff --git a/sdk-output/paginator.ts b/sdk-output/paginator.ts index 413bd3ab..3e2c45d0 100644 --- a/sdk-output/paginator.ts +++ b/sdk-output/paginator.ts @@ -1,24 +1,9 @@ import type { AxiosResponse, RawAxiosRequestConfig } from "axios"; import { - Search, - SearchApi, - SearchApiSearchPostRequest, - SearchDocument, -} from "./v3"; - -import { - SearchDocumentV2024, - SearchV2024, - SearchV2024Api, - SearchV2024ApiSearchPostRequest, -} from "./v2024/api"; - -import { - SearchDocumentV2025, - SearchV2025, - SearchV2025Api, - SearchV2025ApiSearchPostRequest, -} from "./v2025/api"; + SearchV1, + SearchV1Api, + SearchV1ApiSearchPostV1Request, +} from "./search/api"; export interface PaginationParams { /** @@ -53,31 +38,17 @@ export interface ExtraParams { } interface SearchApiTypeMap { - SearchApi: { - search: Search; - searchParams: SearchApiSearchPostRequest; - document: SearchDocument; - }; - SearchV2024Api: { - search: SearchV2024; - searchParams: SearchV2024ApiSearchPostRequest; - document: SearchDocumentV2024; - }; - SearchV2025Api: { - search: SearchV2025; - searchParams: SearchV2025ApiSearchPostRequest; - document: SearchDocumentV2025; + SearchV1Api: { + search: SearchV1; + searchParams: SearchV1ApiSearchPostV1Request; + document: object; }; } -// Create a union type for all possible API types type ApiType = keyof SearchApiTypeMap; -// Define the actual API instances mapping type ApiInstanceMap = { - SearchApi: SearchApi; - SearchV2024Api: SearchV2024Api; - SearchV2025Api: SearchV2025Api; + SearchV1Api: SearchV1Api; }; export class Paginator { @@ -203,34 +174,13 @@ export class Paginator { let results: AxiosResponse; try { - // Handle each API type separately to avoid type conflicts - if (searchAPI instanceof SearchApi) { - const searchParams: SearchApiSearchPostRequest = { - search: search as Search, - limit: increment, - }; - results = (await (searchAPI as SearchApi).searchPost( - searchParams - )) as AxiosResponse; - } else if (searchAPI instanceof SearchV2024Api) { - const searchParams: SearchV2024ApiSearchPostRequest = { - searchV2024: search as SearchV2024, - limit: increment, - }; - results = (await (searchAPI as SearchV2024Api).searchPost( - searchParams - )) as AxiosResponse; - } else if (searchAPI instanceof SearchV2025Api) { - const searchParams: SearchV2025ApiSearchPostRequest = { - searchV2025: search as SearchV2025, - limit: increment, - }; - results = (await (searchAPI as SearchV2025Api).searchPost( - searchParams - )) as AxiosResponse; - } else { - throw new Error("Unsupported API type"); - } + const searchParams: SearchV1ApiSearchPostV1Request = { + searchV1: search as SearchV1, + limit: increment, + }; + results = (await (searchAPI as SearchV1Api).searchPostV1( + searchParams + )) as AxiosResponse; } catch (e: any) { // When total results are an exact multiple of increment, some APIs return a // 4xx error instead of an empty array for the out-of-bounds offset request. @@ -285,34 +235,13 @@ export class Paginator { let results: AxiosResponse; try { - // Handle each API type separately to avoid type conflicts - if (searchAPI instanceof SearchApi) { - const searchParams: SearchApiSearchPostRequest = { - search: search as Search, - limit: increment, - }; - results = (await (searchAPI as SearchApi).searchPost( - searchParams - )) as AxiosResponse; - } else if (searchAPI instanceof SearchV2024Api) { - const searchParams: SearchV2024ApiSearchPostRequest = { - searchV2024: search as SearchV2024, - limit: increment, - }; - results = (await (searchAPI as SearchV2024Api).searchPost( - searchParams - )) as AxiosResponse; - } else if (searchAPI instanceof SearchV2025Api) { - const searchParams: SearchV2025ApiSearchPostRequest = { - searchV2025: search as SearchV2025, - limit: increment, - }; - results = (await (searchAPI as SearchV2025Api).searchPost( - searchParams - )) as AxiosResponse; - } else { - throw new Error("Unsupported API type"); - } + const searchParams: SearchV1ApiSearchPostV1Request = { + searchV1: search as SearchV1, + limit: increment, + }; + results = (await (searchAPI as SearchV1Api).searchPostV1( + searchParams + )) as AxiosResponse; } catch (e: any) { // When total results are an exact multiple of increment, some APIs return a // 4xx error instead of an empty array for the out-of-bounds offset request. diff --git a/sdk-output/parameter_storage/.gitignore b/sdk-output/parameter_storage/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/parameter_storage/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/parameter_storage/.npmignore b/sdk-output/parameter_storage/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/parameter_storage/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/parameter_storage/.openapi-generator-ignore b/sdk-output/parameter_storage/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/parameter_storage/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/parameter_storage/.openapi-generator/FILES b/sdk-output/parameter_storage/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/parameter_storage/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/parameter_storage/.openapi-generator/VERSION b/sdk-output/parameter_storage/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/parameter_storage/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/parameter_storage/.sdk-partition b/sdk-output/parameter_storage/.sdk-partition new file mode 100644 index 00000000..361ffc80 --- /dev/null +++ b/sdk-output/parameter_storage/.sdk-partition @@ -0,0 +1 @@ +parameter-storage \ No newline at end of file diff --git a/sdk-output/parameter_storage/README.md b/sdk-output/parameter_storage/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/parameter_storage/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/parameter_storage/api.ts b/sdk-output/parameter_storage/api.ts new file mode 100644 index 00000000..5f0a53d1 --- /dev/null +++ b/sdk-output/parameter_storage/api.ts @@ -0,0 +1,1196 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Parameter Storage + * 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 DeleteParameterV1409ResponseV1 + */ +export interface DeleteParameterV1409ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof DeleteParameterV1409ResponseV1 + */ + 'errorName'?: any; + /** + * Description of the error + * @type {any} + * @memberof DeleteParameterV1409ResponseV1 + */ + 'errorMessage'?: any; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof DeleteParameterV1409ResponseV1 + */ + 'trackingId'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAttestationDocumentV1401ResponseV1 + */ +export interface GetAttestationDocumentV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAttestationDocumentV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAttestationDocumentV1429ResponseV1 + */ +export interface GetAttestationDocumentV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAttestationDocumentV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The attestation document. This is Base64Url encoded binary data containing the attestation document. This has a cert with a public key that needs to be used to encrypt the private fields of the parameter on creation or update. + * @export + * @interface ParameterstorageattestationdocumentV1 + */ +export interface ParameterstorageattestationdocumentV1 { + /** + * The Base64Url encoded attestation document. + * @type {string} + * @memberof ParameterstorageattestationdocumentV1 + */ + 'attestationDocument'?: string; +} +/** + * RFC 6902 JSON Patch operation + * @export + * @interface ParameterstoragejsonpatchV1 + */ +export interface ParameterstoragejsonpatchV1 { + /** + * The operation to perform (add, remove, replace, move, copy, test) + * @type {string} + * @memberof ParameterstoragejsonpatchV1 + */ + 'op': ParameterstoragejsonpatchV1OpV1; + /** + * A JSON-Pointer describing the target location + * @type {string} + * @memberof ParameterstoragejsonpatchV1 + */ + 'path': string; + /** + * The value to be used within the operations. Required for add/replace/test. + * @type {any} + * @memberof ParameterstoragejsonpatchV1 + */ + 'value'?: any; + /** + * A JSON-Pointer describing the source location for move/copy. + * @type {string} + * @memberof ParameterstoragejsonpatchV1 + */ + 'from'?: string; +} + +export const ParameterstoragejsonpatchV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type ParameterstoragejsonpatchV1OpV1 = typeof ParameterstoragejsonpatchV1OpV1[keyof typeof ParameterstoragejsonpatchV1OpV1]; + +/** + * A parameter to add to parameter storage. The public and private fields must match the type specification. + * @export + * @interface ParameterstoragenewparameterV1 + */ +export interface ParameterstoragenewparameterV1 { + /** + * The UUID of the parameter owner. + * @type {string} + * @memberof ParameterstoragenewparameterV1 + */ + 'ownerId': string; + /** + * The human-readable name for the parameter. + * @type {string} + * @memberof ParameterstoragenewparameterV1 + */ + 'name': string; + /** + * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. + * @type {string} + * @memberof ParameterstoragenewparameterV1 + */ + 'type': string; + /** + * The content must be a JSON object containing the public fields that can be stored with this parameter. + * @type {object} + * @memberof ParameterstoragenewparameterV1 + */ + 'publicFields'?: object; + /** + * Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter. + * @type {string} + * @memberof ParameterstoragenewparameterV1 + */ + 'privateFields'?: string; + /** + * Describe the parameter + * @type {string} + * @memberof ParameterstoragenewparameterV1 + */ + 'description'?: string; +} +/** + * A parameter that has been retrieved from the store. + * @export + * @interface ParameterstorageparameterV1 + */ +export interface ParameterstorageparameterV1 { + /** + * The ID of the reference + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'id': string; + /** + * The ID of the user who owns the parameter. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'ownerId': string; + /** + * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'type'?: string; + /** + * The human-readable name of the parameter. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'name': string; + /** + * The name of the primary field in the public fields. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'primaryField'?: string; + /** + * The public fields stored for this parameter. See the types document for information about what can be stored. + * @type {object} + * @memberof ParameterstorageparameterV1 + */ + 'publicFields': object; + /** + * Describe the parameter + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'description'?: string; + /** + * ISO8606 format datetime of the last time any field of the parameter was changed. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'lastModifiedAt'?: string; + /** + * The ID of the user who last modified the parameter. Empty when identity is not known. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'lastModifiedBy'?: string; + /** + * ISO8606 format datetime of the time the secret fields were changed on the parameter. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'privateFieldsLastModifiedAt'?: string; + /** + * The ID of the user who last modified the private fields. Empty when identity is not known. + * @type {string} + * @memberof ParameterstorageparameterV1 + */ + 'privateFieldsLastModifiedBy'?: string; +} +/** + * Reference information returned in response to a request. + * @export + * @interface ParameterstoragereferenceV1 + */ +export interface ParameterstoragereferenceV1 { + /** + * The ID of the reference + * @type {string} + * @memberof ParameterstoragereferenceV1 + */ + 'id': string; + /** + * The ID of the consumer holding the reference + * @type {string} + * @memberof ParameterstoragereferenceV1 + */ + 'consumerId': string; + /** + * The ID of the parameter that the reference is pointing to. + * @type {string} + * @memberof ParameterstoragereferenceV1 + */ + 'parameterId': string; + /** + * The human-readable name of the reference + * @type {string} + * @memberof ParameterstoragereferenceV1 + */ + 'name': string; + /** + * The hint string used to validate the reference + * @type {string} + * @memberof ParameterstoragereferenceV1 + */ + 'usageHint'?: string; +} +/** + * An existing parameter that needs to be updated. The type cannot be changed once the parameter is created. + * @export + * @interface ParameterstorageupdateparameterV1 + */ +export interface ParameterstorageupdateparameterV1 { + /** + * The UUID of the parameter owner. + * @type {string} + * @memberof ParameterstorageupdateparameterV1 + */ + 'ownerId'?: string; + /** + * The human-readable name for the parameter. + * @type {string} + * @memberof ParameterstorageupdateparameterV1 + */ + 'name'?: string; + /** + * The public fields that can be stored with this parameter. + * @type {object} + * @memberof ParameterstorageupdateparameterV1 + */ + 'publicFields'?: object; + /** + * The private fields that can be stored with this parameter. + * @type {string} + * @memberof ParameterstorageupdateparameterV1 + */ + 'privateFields'?: string; + /** + * Describe the parameter + * @type {string} + * @memberof ParameterstorageupdateparameterV1 + */ + 'description'?: string; +} + +/** + * ParameterStorageV1Api - axios parameter creator + * @export + */ +export const ParameterStorageV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add a new parameter. + * @summary Add a new parameter. + * @param {ParameterstoragenewparameterV1} [parameterstoragenewparameterV1] The parameter to add to the store. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createParameterV1: async (parameterstoragenewparameterV1?: ParameterstoragenewparameterV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/parameter-storage/v1/parameters`; + // 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(parameterstoragenewparameterV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a parameter. Will only delete parameters without existing references. + * @summary Delete a parameter. + * @param {string} id The ID of the parameter to be deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteParameterV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteParameterV1', 'id', id) + const localVarPath = `/parameter-storage/v1/parameters/{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 an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. + * @summary Get an attestation document. + * @param {string} key Base64Url encoded NIST P-384 public key + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAttestationDocumentV1: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'key' is not null or undefined + assertParamExists('getAttestationDocumentV1', 'key', key) + const localVarPath = `/parameter-storage/v1/attestation`; + // 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 (key !== undefined) { + localVarQueryParameter['key'] = key; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the references for a given parameter. + * @summary Get parameter references. + * @param {string} id The ID of the parameter which you want to fetch the references for. + * @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, consumerId, parameterId, name, usageHint** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterReferencesV1: async (id: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getParameterReferencesV1', 'id', id) + const localVarPath = `/parameter-storage/v1/parameters/{id}/references` + .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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the specifications for all parameter types. All parameters must conform to this specification document. + * @summary Get specifications for parameter types. + * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterStorageSpecificationV1: async (acceptLanguage?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (acceptLanguage === undefined) { + acceptLanguage = 'en'; + } + + const localVarPath = `/parameter-storage/v1/specification`; + // 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 (acceptLanguage != null) { + localVarHeaderParameter['Accept-Language'] = String(acceptLanguage); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a parameter by ID. This will only return the public fields for the parameter. + * @summary Get a specific parameter. + * @param {string} id The ID of the parameter to be fetched + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getParameterV1', 'id', id) + const localVarPath = `/parameter-storage/v1/parameters/{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, + }; + }, + /** + * Query a stored parameter. + * @summary Query stored parameters. + * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* + * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchParametersV1: async (filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/parameter-storage/v1/parameters`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. + * @summary Update a parameter. + * @param {string} id The ID of the parameter to be updated. + * @param {ParameterstorageupdateparameterV1} [parameterstorageupdateparameterV1] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateParameterV1: async (id: string, parameterstorageupdateparameterV1?: ParameterstorageupdateparameterV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateParameterV1', 'id', id) + const localVarPath = `/parameter-storage/v1/parameters/{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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(parameterstorageupdateparameterV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ParameterStorageV1Api - functional programming interface + * @export + */ +export const ParameterStorageV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ParameterStorageV1ApiAxiosParamCreator(configuration) + return { + /** + * Add a new parameter. + * @summary Add a new parameter. + * @param {ParameterstoragenewparameterV1} [parameterstoragenewparameterV1] The parameter to add to the store. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createParameterV1(parameterstoragenewparameterV1?: ParameterstoragenewparameterV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createParameterV1(parameterstoragenewparameterV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.createParameterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a parameter. Will only delete parameters without existing references. + * @summary Delete a parameter. + * @param {string} id The ID of the parameter to be deleted. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteParameterV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteParameterV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.deleteParameterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. + * @summary Get an attestation document. + * @param {string} key Base64Url encoded NIST P-384 public key + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAttestationDocumentV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAttestationDocumentV1(key, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.getAttestationDocumentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the references for a given parameter. + * @summary Get parameter references. + * @param {string} id The ID of the parameter which you want to fetch the references for. + * @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, consumerId, parameterId, name, usageHint** + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getParameterReferencesV1(id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterReferencesV1(id, sorters, limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.getParameterReferencesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the specifications for all parameter types. All parameters must conform to this specification document. + * @summary Get specifications for parameter types. + * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getParameterStorageSpecificationV1(acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterStorageSpecificationV1(acceptLanguage, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.getParameterStorageSpecificationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a parameter by ID. This will only return the public fields for the parameter. + * @summary Get a specific parameter. + * @param {string} id The ID of the parameter to be fetched + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getParameterV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.getParameterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Query a stored parameter. + * @summary Query stored parameters. + * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* + * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchParametersV1(filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchParametersV1(filters, sorters, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.searchParametersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. + * @summary Update a parameter. + * @param {string} id The ID of the parameter to be updated. + * @param {ParameterstorageupdateparameterV1} [parameterstorageupdateparameterV1] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateParameterV1(id: string, parameterstorageupdateparameterV1?: ParameterstorageupdateparameterV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateParameterV1(id, parameterstorageupdateparameterV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ParameterStorageV1Api.updateParameterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ParameterStorageV1Api - factory interface + * @export + */ +export const ParameterStorageV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ParameterStorageV1ApiFp(configuration) + return { + /** + * Add a new parameter. + * @summary Add a new parameter. + * @param {ParameterStorageV1ApiCreateParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createParameterV1(requestParameters: ParameterStorageV1ApiCreateParameterV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createParameterV1(requestParameters.parameterstoragenewparameterV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a parameter. Will only delete parameters without existing references. + * @summary Delete a parameter. + * @param {ParameterStorageV1ApiDeleteParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteParameterV1(requestParameters: ParameterStorageV1ApiDeleteParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteParameterV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. + * @summary Get an attestation document. + * @param {ParameterStorageV1ApiGetAttestationDocumentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAttestationDocumentV1(requestParameters: ParameterStorageV1ApiGetAttestationDocumentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAttestationDocumentV1(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the references for a given parameter. + * @summary Get parameter references. + * @param {ParameterStorageV1ApiGetParameterReferencesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterReferencesV1(requestParameters: ParameterStorageV1ApiGetParameterReferencesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getParameterReferencesV1(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the specifications for all parameter types. All parameters must conform to this specification document. + * @summary Get specifications for parameter types. + * @param {ParameterStorageV1ApiGetParameterStorageSpecificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterStorageSpecificationV1(requestParameters: ParameterStorageV1ApiGetParameterStorageSpecificationV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getParameterStorageSpecificationV1(requestParameters.acceptLanguage, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a parameter by ID. This will only return the public fields for the parameter. + * @summary Get a specific parameter. + * @param {ParameterStorageV1ApiGetParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getParameterV1(requestParameters: ParameterStorageV1ApiGetParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getParameterV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Query a stored parameter. + * @summary Query stored parameters. + * @param {ParameterStorageV1ApiSearchParametersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchParametersV1(requestParameters: ParameterStorageV1ApiSearchParametersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.searchParametersV1(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. + * @summary Update a parameter. + * @param {ParameterStorageV1ApiUpdateParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateParameterV1(requestParameters: ParameterStorageV1ApiUpdateParameterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateParameterV1(requestParameters.id, requestParameters.parameterstorageupdateparameterV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createParameterV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiCreateParameterV1Request + */ +export interface ParameterStorageV1ApiCreateParameterV1Request { + /** + * The parameter to add to the store. + * @type {ParameterstoragenewparameterV1} + * @memberof ParameterStorageV1ApiCreateParameterV1 + */ + readonly parameterstoragenewparameterV1?: ParameterstoragenewparameterV1 +} + +/** + * Request parameters for deleteParameterV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiDeleteParameterV1Request + */ +export interface ParameterStorageV1ApiDeleteParameterV1Request { + /** + * The ID of the parameter to be deleted. + * @type {string} + * @memberof ParameterStorageV1ApiDeleteParameterV1 + */ + readonly id: string +} + +/** + * Request parameters for getAttestationDocumentV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiGetAttestationDocumentV1Request + */ +export interface ParameterStorageV1ApiGetAttestationDocumentV1Request { + /** + * Base64Url encoded NIST P-384 public key + * @type {string} + * @memberof ParameterStorageV1ApiGetAttestationDocumentV1 + */ + readonly key: string +} + +/** + * Request parameters for getParameterReferencesV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiGetParameterReferencesV1Request + */ +export interface ParameterStorageV1ApiGetParameterReferencesV1Request { + /** + * The ID of the parameter which you want to fetch the references for. + * @type {string} + * @memberof ParameterStorageV1ApiGetParameterReferencesV1 + */ + readonly id: 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, consumerId, parameterId, name, usageHint** + * @type {string} + * @memberof ParameterStorageV1ApiGetParameterReferencesV1 + */ + readonly sorters?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ParameterStorageV1ApiGetParameterReferencesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof ParameterStorageV1ApiGetParameterReferencesV1 + */ + readonly offset?: number +} + +/** + * Request parameters for getParameterStorageSpecificationV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiGetParameterStorageSpecificationV1Request + */ +export interface ParameterStorageV1ApiGetParameterStorageSpecificationV1Request { + /** + * The i18n internationalization code for the language that the spec is in. Defaults to english. + * @type {string} + * @memberof ParameterStorageV1ApiGetParameterStorageSpecificationV1 + */ + readonly acceptLanguage?: string +} + +/** + * Request parameters for getParameterV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiGetParameterV1Request + */ +export interface ParameterStorageV1ApiGetParameterV1Request { + /** + * The ID of the parameter to be fetched + * @type {string} + * @memberof ParameterStorageV1ApiGetParameterV1 + */ + readonly id: string +} + +/** + * Request parameters for searchParametersV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiSearchParametersV1Request + */ +export interface ParameterStorageV1ApiSearchParametersV1Request { + /** + * 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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* + * @type {string} + * @memberof ParameterStorageV1ApiSearchParametersV1 + */ + 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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** + * @type {string} + * @memberof ParameterStorageV1ApiSearchParametersV1 + */ + readonly sorters?: string + + /** + * 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 ParameterStorageV1ApiSearchParametersV1 + */ + 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 ParameterStorageV1ApiSearchParametersV1 + */ + readonly limit?: number +} + +/** + * Request parameters for updateParameterV1 operation in ParameterStorageV1Api. + * @export + * @interface ParameterStorageV1ApiUpdateParameterV1Request + */ +export interface ParameterStorageV1ApiUpdateParameterV1Request { + /** + * The ID of the parameter to be updated. + * @type {string} + * @memberof ParameterStorageV1ApiUpdateParameterV1 + */ + readonly id: string + + /** + * The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. + * @type {ParameterstorageupdateparameterV1} + * @memberof ParameterStorageV1ApiUpdateParameterV1 + */ + readonly parameterstorageupdateparameterV1?: ParameterstorageupdateparameterV1 +} + +/** + * ParameterStorageV1Api - object-oriented interface + * @export + * @class ParameterStorageV1Api + * @extends {BaseAPI} + */ +export class ParameterStorageV1Api extends BaseAPI { + /** + * Add a new parameter. + * @summary Add a new parameter. + * @param {ParameterStorageV1ApiCreateParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public createParameterV1(requestParameters: ParameterStorageV1ApiCreateParameterV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).createParameterV1(requestParameters.parameterstoragenewparameterV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a parameter. Will only delete parameters without existing references. + * @summary Delete a parameter. + * @param {ParameterStorageV1ApiDeleteParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public deleteParameterV1(requestParameters: ParameterStorageV1ApiDeleteParameterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).deleteParameterV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. + * @summary Get an attestation document. + * @param {ParameterStorageV1ApiGetAttestationDocumentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public getAttestationDocumentV1(requestParameters: ParameterStorageV1ApiGetAttestationDocumentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).getAttestationDocumentV1(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the references for a given parameter. + * @summary Get parameter references. + * @param {ParameterStorageV1ApiGetParameterReferencesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public getParameterReferencesV1(requestParameters: ParameterStorageV1ApiGetParameterReferencesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).getParameterReferencesV1(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the specifications for all parameter types. All parameters must conform to this specification document. + * @summary Get specifications for parameter types. + * @param {ParameterStorageV1ApiGetParameterStorageSpecificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public getParameterStorageSpecificationV1(requestParameters: ParameterStorageV1ApiGetParameterStorageSpecificationV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).getParameterStorageSpecificationV1(requestParameters.acceptLanguage, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a parameter by ID. This will only return the public fields for the parameter. + * @summary Get a specific parameter. + * @param {ParameterStorageV1ApiGetParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public getParameterV1(requestParameters: ParameterStorageV1ApiGetParameterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).getParameterV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Query a stored parameter. + * @summary Query stored parameters. + * @param {ParameterStorageV1ApiSearchParametersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public searchParametersV1(requestParameters: ParameterStorageV1ApiSearchParametersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).searchParametersV1(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. + * @summary Update a parameter. + * @param {ParameterStorageV1ApiUpdateParameterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ParameterStorageV1Api + */ + public updateParameterV1(requestParameters: ParameterStorageV1ApiUpdateParameterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ParameterStorageV1ApiFp(this.configuration).updateParameterV1(requestParameters.id, requestParameters.parameterstorageupdateparameterV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/parameter_storage/base.ts b/sdk-output/parameter_storage/base.ts new file mode 100644 index 00000000..679f57f5 --- /dev/null +++ b/sdk-output/parameter_storage/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Parameter Storage + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/parameter_storage/common.ts b/sdk-output/parameter_storage/common.ts new file mode 100644 index 00000000..f53cb9e2 --- /dev/null +++ b/sdk-output/parameter_storage/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Parameter Storage + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/parameter_storage/configuration.ts b/sdk-output/parameter_storage/configuration.ts new file mode 100644 index 00000000..3217f6b9 --- /dev/null +++ b/sdk-output/parameter_storage/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Parameter Storage + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/parameter_storage/git_push.sh b/sdk-output/parameter_storage/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/parameter_storage/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/parameter_storage/index.ts b/sdk-output/parameter_storage/index.ts new file mode 100644 index 00000000..864967bf --- /dev/null +++ b/sdk-output/parameter_storage/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Parameter Storage + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/parameter_storage/package.json b/sdk-output/parameter_storage/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/parameter_storage/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/parameter_storage/tsconfig.json b/sdk-output/parameter_storage/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/parameter_storage/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/password_configuration/.gitignore b/sdk-output/password_configuration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/password_configuration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/password_configuration/.npmignore b/sdk-output/password_configuration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/password_configuration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/password_configuration/.openapi-generator-ignore b/sdk-output/password_configuration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/password_configuration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/password_configuration/.openapi-generator/FILES b/sdk-output/password_configuration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/password_configuration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/password_configuration/.openapi-generator/VERSION b/sdk-output/password_configuration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/password_configuration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/password_configuration/.sdk-partition b/sdk-output/password_configuration/.sdk-partition new file mode 100644 index 00000000..5a86345c --- /dev/null +++ b/sdk-output/password_configuration/.sdk-partition @@ -0,0 +1 @@ +password-configuration \ No newline at end of file diff --git a/sdk-output/password_configuration/README.md b/sdk-output/password_configuration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_configuration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_configuration/api.ts b/sdk-output/password_configuration/api.ts new file mode 100644 index 00000000..1b48ccba --- /dev/null +++ b/sdk-output/password_configuration/api.ts @@ -0,0 +1,426 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Configuration + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPasswordOrgConfigV1401ResponseV1 + */ +export interface GetPasswordOrgConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordOrgConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPasswordOrgConfigV1429ResponseV1 + */ +export interface GetPasswordOrgConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordOrgConfigV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PasswordorgconfigV1 + */ +export interface PasswordorgconfigV1 { + /** + * Indicator whether custom password instructions feature is enabled. The default value is false. + * @type {boolean} + * @memberof PasswordorgconfigV1 + */ + 'customInstructionsEnabled'?: boolean; + /** + * Indicator whether \"digit token\" feature is enabled. The default value is false. + * @type {boolean} + * @memberof PasswordorgconfigV1 + */ + 'digitTokenEnabled'?: boolean; + /** + * The duration of \"digit token\" in minutes. The default value is 5. + * @type {number} + * @memberof PasswordorgconfigV1 + */ + 'digitTokenDurationMinutes'?: number; + /** + * The length of \"digit token\". The default value is 6. + * @type {number} + * @memberof PasswordorgconfigV1 + */ + 'digitTokenLength'?: number; +} + +/** + * PasswordConfigurationV1Api - axios parameter creator + * @export + */ +export const PasswordConfigurationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Create password org config + * @param {PasswordorgconfigV1} passwordorgconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordOrgConfigV1: async (passwordorgconfigV1: PasswordorgconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordorgconfigV1' is not null or undefined + assertParamExists('createPasswordOrgConfigV1', 'passwordorgconfigV1', passwordorgconfigV1) + const localVarPath = `/password-org-config/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(passwordorgconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' + * @summary Get password org config + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordOrgConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/password-org-config/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Update password org config + * @param {PasswordorgconfigV1} passwordorgconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPasswordOrgConfigV1: async (passwordorgconfigV1: PasswordorgconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordorgconfigV1' is not null or undefined + assertParamExists('putPasswordOrgConfigV1', 'passwordorgconfigV1', passwordorgconfigV1) + const localVarPath = `/password-org-config/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: 'PUT', ...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(passwordorgconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PasswordConfigurationV1Api - functional programming interface + * @export + */ +export const PasswordConfigurationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PasswordConfigurationV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Create password org config + * @param {PasswordorgconfigV1} passwordorgconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createPasswordOrgConfigV1(passwordorgconfigV1: PasswordorgconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfigV1(passwordorgconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV1Api.createPasswordOrgConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' + * @summary Get password org config + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV1Api.getPasswordOrgConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Update password org config + * @param {PasswordorgconfigV1} passwordorgconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putPasswordOrgConfigV1(passwordorgconfigV1: PasswordorgconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfigV1(passwordorgconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV1Api.putPasswordOrgConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PasswordConfigurationV1Api - factory interface + * @export + */ +export const PasswordConfigurationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PasswordConfigurationV1ApiFp(configuration) + return { + /** + * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Create password org config + * @param {PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordOrgConfigV1(requestParameters: PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createPasswordOrgConfigV1(requestParameters.passwordorgconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' + * @summary Get password org config + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordOrgConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPasswordOrgConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Update password org config + * @param {PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPasswordOrgConfigV1(requestParameters: PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putPasswordOrgConfigV1(requestParameters.passwordorgconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createPasswordOrgConfigV1 operation in PasswordConfigurationV1Api. + * @export + * @interface PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request + */ +export interface PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request { + /** + * + * @type {PasswordorgconfigV1} + * @memberof PasswordConfigurationV1ApiCreatePasswordOrgConfigV1 + */ + readonly passwordorgconfigV1: PasswordorgconfigV1 +} + +/** + * Request parameters for putPasswordOrgConfigV1 operation in PasswordConfigurationV1Api. + * @export + * @interface PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request + */ +export interface PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request { + /** + * + * @type {PasswordorgconfigV1} + * @memberof PasswordConfigurationV1ApiPutPasswordOrgConfigV1 + */ + readonly passwordorgconfigV1: PasswordorgconfigV1 +} + +/** + * PasswordConfigurationV1Api - object-oriented interface + * @export + * @class PasswordConfigurationV1Api + * @extends {BaseAPI} + */ +export class PasswordConfigurationV1Api extends BaseAPI { + /** + * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Create password org config + * @param {PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordConfigurationV1Api + */ + public createPasswordOrgConfigV1(requestParameters: PasswordConfigurationV1ApiCreatePasswordOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordConfigurationV1ApiFp(this.configuration).createPasswordOrgConfigV1(requestParameters.passwordorgconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' + * @summary Get password org config + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordConfigurationV1Api + */ + public getPasswordOrgConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return PasswordConfigurationV1ApiFp(this.configuration).getPasswordOrgConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' + * @summary Update password org config + * @param {PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordConfigurationV1Api + */ + public putPasswordOrgConfigV1(requestParameters: PasswordConfigurationV1ApiPutPasswordOrgConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordConfigurationV1ApiFp(this.configuration).putPasswordOrgConfigV1(requestParameters.passwordorgconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/password_configuration/base.ts b/sdk-output/password_configuration/base.ts new file mode 100644 index 00000000..72f7da13 --- /dev/null +++ b/sdk-output/password_configuration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Configuration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/password_configuration/common.ts b/sdk-output/password_configuration/common.ts new file mode 100644 index 00000000..acc91b4e --- /dev/null +++ b/sdk-output/password_configuration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Configuration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/password_configuration/configuration.ts b/sdk-output/password_configuration/configuration.ts new file mode 100644 index 00000000..48f6aaa5 --- /dev/null +++ b/sdk-output/password_configuration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Configuration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/password_configuration/git_push.sh b/sdk-output/password_configuration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/password_configuration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/password_configuration/index.ts b/sdk-output/password_configuration/index.ts new file mode 100644 index 00000000..b20e0f6a --- /dev/null +++ b/sdk-output/password_configuration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Configuration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/password_configuration/package.json b/sdk-output/password_configuration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/password_configuration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/password_configuration/tsconfig.json b/sdk-output/password_configuration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/password_configuration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/password_dictionary/.gitignore b/sdk-output/password_dictionary/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/password_dictionary/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/password_dictionary/.npmignore b/sdk-output/password_dictionary/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/password_dictionary/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/password_dictionary/.openapi-generator-ignore b/sdk-output/password_dictionary/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/password_dictionary/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/password_dictionary/.openapi-generator/FILES b/sdk-output/password_dictionary/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/password_dictionary/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/password_dictionary/.openapi-generator/VERSION b/sdk-output/password_dictionary/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/password_dictionary/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/password_dictionary/.sdk-partition b/sdk-output/password_dictionary/.sdk-partition new file mode 100644 index 00000000..49ba838f --- /dev/null +++ b/sdk-output/password_dictionary/.sdk-partition @@ -0,0 +1 @@ +password-dictionary \ No newline at end of file diff --git a/sdk-output/password_dictionary/README.md b/sdk-output/password_dictionary/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_dictionary/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_dictionary/api.ts b/sdk-output/password_dictionary/api.ts new file mode 100644 index 00000000..766555b5 --- /dev/null +++ b/sdk-output/password_dictionary/api.ts @@ -0,0 +1,326 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Dictionary + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPasswordDictionaryV1401ResponseV1 + */ +export interface GetPasswordDictionaryV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordDictionaryV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPasswordDictionaryV1429ResponseV1 + */ +export interface GetPasswordDictionaryV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordDictionaryV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PutPasswordDictionaryV1RequestV1 + */ +export interface PutPasswordDictionaryV1RequestV1 { + /** + * + * @type {File} + * @memberof PutPasswordDictionaryV1RequestV1 + */ + 'file'?: File; +} + +/** + * PasswordDictionaryV1Api - axios parameter creator + * @export + */ +export const PasswordDictionaryV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Get password dictionary + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordDictionaryV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/password-dictionary/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Update password dictionary + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPasswordDictionaryV1: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/password-dictionary/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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PasswordDictionaryV1Api - functional programming interface + * @export + */ +export const PasswordDictionaryV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PasswordDictionaryV1ApiAxiosParamCreator(configuration) + return { + /** + * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Get password dictionary + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordDictionaryV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionaryV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV1Api.getPasswordDictionaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Update password dictionary + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putPasswordDictionaryV1(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionaryV1(file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV1Api.putPasswordDictionaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PasswordDictionaryV1Api - factory interface + * @export + */ +export const PasswordDictionaryV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PasswordDictionaryV1ApiFp(configuration) + return { + /** + * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Get password dictionary + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordDictionaryV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPasswordDictionaryV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Update password dictionary + * @param {PasswordDictionaryV1ApiPutPasswordDictionaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPasswordDictionaryV1(requestParameters: PasswordDictionaryV1ApiPutPasswordDictionaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putPasswordDictionaryV1(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for putPasswordDictionaryV1 operation in PasswordDictionaryV1Api. + * @export + * @interface PasswordDictionaryV1ApiPutPasswordDictionaryV1Request + */ +export interface PasswordDictionaryV1ApiPutPasswordDictionaryV1Request { + /** + * + * @type {File} + * @memberof PasswordDictionaryV1ApiPutPasswordDictionaryV1 + */ + readonly file?: File +} + +/** + * PasswordDictionaryV1Api - object-oriented interface + * @export + * @class PasswordDictionaryV1Api + * @extends {BaseAPI} + */ +export class PasswordDictionaryV1Api extends BaseAPI { + /** + * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Get password dictionary + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordDictionaryV1Api + */ + public getPasswordDictionaryV1(axiosOptions?: RawAxiosRequestConfig) { + return PasswordDictionaryV1ApiFp(this.configuration).getPasswordDictionaryV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` + * @summary Update password dictionary + * @param {PasswordDictionaryV1ApiPutPasswordDictionaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordDictionaryV1Api + */ + public putPasswordDictionaryV1(requestParameters: PasswordDictionaryV1ApiPutPasswordDictionaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return PasswordDictionaryV1ApiFp(this.configuration).putPasswordDictionaryV1(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/password_dictionary/base.ts b/sdk-output/password_dictionary/base.ts new file mode 100644 index 00000000..28b65742 --- /dev/null +++ b/sdk-output/password_dictionary/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Dictionary + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/password_dictionary/common.ts b/sdk-output/password_dictionary/common.ts new file mode 100644 index 00000000..34e85aec --- /dev/null +++ b/sdk-output/password_dictionary/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Dictionary + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/password_dictionary/configuration.ts b/sdk-output/password_dictionary/configuration.ts new file mode 100644 index 00000000..70557bfc --- /dev/null +++ b/sdk-output/password_dictionary/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Dictionary + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/password_dictionary/git_push.sh b/sdk-output/password_dictionary/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/password_dictionary/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/password_dictionary/index.ts b/sdk-output/password_dictionary/index.ts new file mode 100644 index 00000000..bdf60cb4 --- /dev/null +++ b/sdk-output/password_dictionary/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Dictionary + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/password_dictionary/package.json b/sdk-output/password_dictionary/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/password_dictionary/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/password_dictionary/tsconfig.json b/sdk-output/password_dictionary/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/password_dictionary/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/password_management/.gitignore b/sdk-output/password_management/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/password_management/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/password_management/.npmignore b/sdk-output/password_management/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/password_management/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/password_management/.openapi-generator-ignore b/sdk-output/password_management/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/password_management/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/password_management/.openapi-generator/FILES b/sdk-output/password_management/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/password_management/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/password_management/.openapi-generator/VERSION b/sdk-output/password_management/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/password_management/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/password_management/.sdk-partition b/sdk-output/password_management/.sdk-partition new file mode 100644 index 00000000..60113940 --- /dev/null +++ b/sdk-output/password_management/.sdk-partition @@ -0,0 +1 @@ +password-management \ No newline at end of file diff --git a/sdk-output/password_management/README.md b/sdk-output/password_management/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_management/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_management/api.ts b/sdk-output/password_management/api.ts new file mode 100644 index 00000000..fdf39566 --- /dev/null +++ b/sdk-output/password_management/api.ts @@ -0,0 +1,747 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Management + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PasswordchangerequestV1 + */ +export interface PasswordchangerequestV1 { + /** + * The identity ID that requested the password change + * @type {string} + * @memberof PasswordchangerequestV1 + */ + 'identityId'?: string; + /** + * The RSA encrypted password + * @type {string} + * @memberof PasswordchangerequestV1 + */ + 'encryptedPassword'?: string; + /** + * The encryption key ID + * @type {string} + * @memberof PasswordchangerequestV1 + */ + 'publicKeyId'?: string; + /** + * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 + * @type {string} + * @memberof PasswordchangerequestV1 + */ + 'accountId'?: string; + /** + * The ID of the source for which identity is requesting the password change + * @type {string} + * @memberof PasswordchangerequestV1 + */ + 'sourceId'?: string; +} +/** + * + * @export + * @interface PasswordchangeresponseV1 + */ +export interface PasswordchangeresponseV1 { + /** + * The password change request ID + * @type {string} + * @memberof PasswordchangeresponseV1 + */ + 'requestId'?: string | null; + /** + * Password change state + * @type {string} + * @memberof PasswordchangeresponseV1 + */ + 'state'?: PasswordchangeresponseV1StateV1; +} + +export const PasswordchangeresponseV1StateV1 = { + InProgress: 'IN_PROGRESS', + Finished: 'FINISHED', + Failed: 'FAILED' +} as const; + +export type PasswordchangeresponseV1StateV1 = typeof PasswordchangeresponseV1StateV1[keyof typeof PasswordchangeresponseV1StateV1]; + +/** + * + * @export + * @interface PassworddigittokenV1 + */ +export interface PassworddigittokenV1 { + /** + * The digit token for password management + * @type {string} + * @memberof PassworddigittokenV1 + */ + 'digitToken'?: string; + /** + * The reference ID of the digit token generation request + * @type {string} + * @memberof PassworddigittokenV1 + */ + 'requestId'?: string; +} +/** + * + * @export + * @interface PassworddigittokenresetV1 + */ +export interface PassworddigittokenresetV1 { + /** + * The uid of the user requested for digit token + * @type {string} + * @memberof PassworddigittokenresetV1 + */ + 'userId': string; + /** + * The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. + * @type {number} + * @memberof PassworddigittokenresetV1 + */ + 'length'?: number; + /** + * The time to live for the digit token in minutes. The default value is 5 minutes. + * @type {number} + * @memberof PassworddigittokenresetV1 + */ + 'durationMinutes'?: number; +} +/** + * + * @export + * @interface PasswordinfoV1 + */ +export interface PasswordinfoV1 { + /** + * Identity ID + * @type {string} + * @memberof PasswordinfoV1 + */ + 'identityId'?: string; + /** + * source ID + * @type {string} + * @memberof PasswordinfoV1 + */ + 'sourceId'?: string; + /** + * public key ID + * @type {string} + * @memberof PasswordinfoV1 + */ + 'publicKeyId'?: string; + /** + * User\'s public key with Base64 encoding + * @type {string} + * @memberof PasswordinfoV1 + */ + 'publicKey'?: string; + /** + * Account info related to queried identity and source + * @type {Array} + * @memberof PasswordinfoV1 + */ + 'accounts'?: Array; + /** + * Password constraints + * @type {Array} + * @memberof PasswordinfoV1 + */ + 'policies'?: Array; +} +/** + * + * @export + * @interface PasswordinfoaccountV1 + */ +export interface PasswordinfoaccountV1 { + /** + * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 + * @type {string} + * @memberof PasswordinfoaccountV1 + */ + 'accountId'?: string; + /** + * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 + * @type {string} + * @memberof PasswordinfoaccountV1 + */ + 'accountName'?: string; +} +/** + * + * @export + * @interface PasswordinfoquerydtoV1 + */ +export interface PasswordinfoquerydtoV1 { + /** + * The login name of the user + * @type {string} + * @memberof PasswordinfoquerydtoV1 + */ + 'userName'?: string; + /** + * The display name of the source + * @type {string} + * @memberof PasswordinfoquerydtoV1 + */ + 'sourceName'?: string; +} +/** + * + * @export + * @interface PasswordstatusV1 + */ +export interface PasswordstatusV1 { + /** + * The password change request ID + * @type {string} + * @memberof PasswordstatusV1 + */ + 'requestId'?: string | null; + /** + * Password change state + * @type {string} + * @memberof PasswordstatusV1 + */ + 'state'?: PasswordstatusV1StateV1; + /** + * The errors during the password change request + * @type {Array} + * @memberof PasswordstatusV1 + */ + 'errors'?: Array; + /** + * List of source IDs in the password change request + * @type {Array} + * @memberof PasswordstatusV1 + */ + 'sourceIds'?: Array; +} + +export const PasswordstatusV1StateV1 = { + InProgress: 'IN_PROGRESS', + Finished: 'FINISHED', + Failed: 'FAILED' +} as const; + +export type PasswordstatusV1StateV1 = typeof PasswordstatusV1StateV1[keyof typeof PasswordstatusV1StateV1]; + +/** + * + * @export + * @interface QueryPasswordInfoV1401ResponseV1 + */ +export interface QueryPasswordInfoV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof QueryPasswordInfoV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface QueryPasswordInfoV1429ResponseV1 + */ +export interface QueryPasswordInfoV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof QueryPasswordInfoV1429ResponseV1 + */ + 'message'?: any; +} + +/** + * PasswordManagementV1Api - axios parameter creator + * @export + */ +export const PasswordManagementV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". + * @summary Generate a digit token + * @param {PassworddigittokenresetV1} passworddigittokenresetV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDigitTokenV1: async (passworddigittokenresetV1: PassworddigittokenresetV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passworddigittokenresetV1' is not null or undefined + assertParamExists('createDigitTokenV1', 'passworddigittokenresetV1', passworddigittokenresetV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/generate-password-reset-token/v1/digit`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(passworddigittokenresetV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the status of a password change request. + * @summary Get password change request status + * @param {string} id Password change request ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordChangeStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getPasswordChangeStatusV1', 'id', id) + const localVarPath = `/password-change-status/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, + }; + }, + /** + * This API is used to query password related information. + * @summary Query password info + * @param {PasswordinfoquerydtoV1} passwordinfoquerydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + queryPasswordInfoV1: async (passwordinfoquerydtoV1: PasswordinfoquerydtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordinfoquerydtoV1' is not null or undefined + assertParamExists('queryPasswordInfoV1', 'passwordinfoquerydtoV1', passwordinfoquerydtoV1) + const localVarPath = `/query-password-info/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(passwordinfoquerydtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + * @summary Set identity\'s password + * @param {PasswordchangerequestV1} passwordchangerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setPasswordV1: async (passwordchangerequestV1: PasswordchangerequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordchangerequestV1' is not null or undefined + assertParamExists('setPasswordV1', 'passwordchangerequestV1', passwordchangerequestV1) + const localVarPath = `/set-password/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(passwordchangerequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PasswordManagementV1Api - functional programming interface + * @export + */ +export const PasswordManagementV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PasswordManagementV1ApiAxiosParamCreator(configuration) + return { + /** + * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". + * @summary Generate a digit token + * @param {PassworddigittokenresetV1} passworddigittokenresetV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createDigitTokenV1(passworddigittokenresetV1: PassworddigittokenresetV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDigitTokenV1(passworddigittokenresetV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordManagementV1Api.createDigitTokenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the status of a password change request. + * @summary Get password change request status + * @param {string} id Password change request ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordChangeStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordChangeStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordManagementV1Api.getPasswordChangeStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API is used to query password related information. + * @summary Query password info + * @param {PasswordinfoquerydtoV1} passwordinfoquerydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async queryPasswordInfoV1(passwordinfoquerydtoV1: PasswordinfoquerydtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfoV1(passwordinfoquerydtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordManagementV1Api.queryPasswordInfoV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + * @summary Set identity\'s password + * @param {PasswordchangerequestV1} passwordchangerequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setPasswordV1(passwordchangerequestV1: PasswordchangerequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordV1(passwordchangerequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordManagementV1Api.setPasswordV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PasswordManagementV1Api - factory interface + * @export + */ +export const PasswordManagementV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PasswordManagementV1ApiFp(configuration) + return { + /** + * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". + * @summary Generate a digit token + * @param {PasswordManagementV1ApiCreateDigitTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createDigitTokenV1(requestParameters: PasswordManagementV1ApiCreateDigitTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDigitTokenV1(requestParameters.passworddigittokenresetV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the status of a password change request. + * @summary Get password change request status + * @param {PasswordManagementV1ApiGetPasswordChangeStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordChangeStatusV1(requestParameters: PasswordManagementV1ApiGetPasswordChangeStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPasswordChangeStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API is used to query password related information. + * @summary Query password info + * @param {PasswordManagementV1ApiQueryPasswordInfoV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + queryPasswordInfoV1(requestParameters: PasswordManagementV1ApiQueryPasswordInfoV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.queryPasswordInfoV1(requestParameters.passwordinfoquerydtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + * @summary Set identity\'s password + * @param {PasswordManagementV1ApiSetPasswordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setPasswordV1(requestParameters: PasswordManagementV1ApiSetPasswordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setPasswordV1(requestParameters.passwordchangerequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createDigitTokenV1 operation in PasswordManagementV1Api. + * @export + * @interface PasswordManagementV1ApiCreateDigitTokenV1Request + */ +export interface PasswordManagementV1ApiCreateDigitTokenV1Request { + /** + * + * @type {PassworddigittokenresetV1} + * @memberof PasswordManagementV1ApiCreateDigitTokenV1 + */ + readonly passworddigittokenresetV1: PassworddigittokenresetV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordManagementV1ApiCreateDigitTokenV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPasswordChangeStatusV1 operation in PasswordManagementV1Api. + * @export + * @interface PasswordManagementV1ApiGetPasswordChangeStatusV1Request + */ +export interface PasswordManagementV1ApiGetPasswordChangeStatusV1Request { + /** + * Password change request ID + * @type {string} + * @memberof PasswordManagementV1ApiGetPasswordChangeStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for queryPasswordInfoV1 operation in PasswordManagementV1Api. + * @export + * @interface PasswordManagementV1ApiQueryPasswordInfoV1Request + */ +export interface PasswordManagementV1ApiQueryPasswordInfoV1Request { + /** + * + * @type {PasswordinfoquerydtoV1} + * @memberof PasswordManagementV1ApiQueryPasswordInfoV1 + */ + readonly passwordinfoquerydtoV1: PasswordinfoquerydtoV1 +} + +/** + * Request parameters for setPasswordV1 operation in PasswordManagementV1Api. + * @export + * @interface PasswordManagementV1ApiSetPasswordV1Request + */ +export interface PasswordManagementV1ApiSetPasswordV1Request { + /** + * + * @type {PasswordchangerequestV1} + * @memberof PasswordManagementV1ApiSetPasswordV1 + */ + readonly passwordchangerequestV1: PasswordchangerequestV1 +} + +/** + * PasswordManagementV1Api - object-oriented interface + * @export + * @class PasswordManagementV1Api + * @extends {BaseAPI} + */ +export class PasswordManagementV1Api extends BaseAPI { + /** + * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". + * @summary Generate a digit token + * @param {PasswordManagementV1ApiCreateDigitTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordManagementV1Api + */ + public createDigitTokenV1(requestParameters: PasswordManagementV1ApiCreateDigitTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordManagementV1ApiFp(this.configuration).createDigitTokenV1(requestParameters.passworddigittokenresetV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the status of a password change request. + * @summary Get password change request status + * @param {PasswordManagementV1ApiGetPasswordChangeStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordManagementV1Api + */ + public getPasswordChangeStatusV1(requestParameters: PasswordManagementV1ApiGetPasswordChangeStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordManagementV1ApiFp(this.configuration).getPasswordChangeStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API is used to query password related information. + * @summary Query password info + * @param {PasswordManagementV1ApiQueryPasswordInfoV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordManagementV1Api + */ + public queryPasswordInfoV1(requestParameters: PasswordManagementV1ApiQueryPasswordInfoV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordManagementV1ApiFp(this.configuration).queryPasswordInfoV1(requestParameters.passwordinfoquerydtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + * @summary Set identity\'s password + * @param {PasswordManagementV1ApiSetPasswordV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordManagementV1Api + */ + public setPasswordV1(requestParameters: PasswordManagementV1ApiSetPasswordV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordManagementV1ApiFp(this.configuration).setPasswordV1(requestParameters.passwordchangerequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/password_management/base.ts b/sdk-output/password_management/base.ts new file mode 100644 index 00000000..16abe498 --- /dev/null +++ b/sdk-output/password_management/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Management + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/password_management/common.ts b/sdk-output/password_management/common.ts new file mode 100644 index 00000000..9de3a9c8 --- /dev/null +++ b/sdk-output/password_management/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Management + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/password_management/configuration.ts b/sdk-output/password_management/configuration.ts new file mode 100644 index 00000000..fd05fd32 --- /dev/null +++ b/sdk-output/password_management/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Management + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/password_management/git_push.sh b/sdk-output/password_management/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/password_management/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/password_management/index.ts b/sdk-output/password_management/index.ts new file mode 100644 index 00000000..c4db6c6e --- /dev/null +++ b/sdk-output/password_management/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Management + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/password_management/package.json b/sdk-output/password_management/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/password_management/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/password_management/tsconfig.json b/sdk-output/password_management/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/password_management/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/password_policies/.gitignore b/sdk-output/password_policies/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/password_policies/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/password_policies/.npmignore b/sdk-output/password_policies/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/password_policies/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/password_policies/.openapi-generator-ignore b/sdk-output/password_policies/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/password_policies/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/password_policies/.openapi-generator/FILES b/sdk-output/password_policies/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/password_policies/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/password_policies/.openapi-generator/VERSION b/sdk-output/password_policies/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/password_policies/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/password_policies/.sdk-partition b/sdk-output/password_policies/.sdk-partition new file mode 100644 index 00000000..5d0d3304 --- /dev/null +++ b/sdk-output/password_policies/.sdk-partition @@ -0,0 +1 @@ +password-policies \ No newline at end of file diff --git a/sdk-output/password_policies/README.md b/sdk-output/password_policies/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_policies/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_policies/api.ts b/sdk-output/password_policies/api.ts new file mode 100644 index 00000000..5eaecc23 --- /dev/null +++ b/sdk-output/password_policies/api.ts @@ -0,0 +1,894 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Policies + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPasswordPolicyByIdV1401ResponseV1 + */ +export interface GetPasswordPolicyByIdV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordPolicyByIdV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPasswordPolicyByIdV1429ResponseV1 + */ +export interface GetPasswordPolicyByIdV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordPolicyByIdV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface Passwordpolicyv3dtoV1 + */ +export interface Passwordpolicyv3dtoV1 { + /** + * The password policy Id. + * @type {string} + * @memberof Passwordpolicyv3dtoV1 + */ + 'id'?: string; + /** + * Description for current password policy. + * @type {string} + * @memberof Passwordpolicyv3dtoV1 + */ + 'description'?: string | null; + /** + * The name of the password policy. + * @type {string} + * @memberof Passwordpolicyv3dtoV1 + */ + 'name'?: string; + /** + * Date the Password Policy was created. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'dateCreated'?: number; + /** + * Date the Password Policy was updated. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'lastUpdated'?: number | null; + /** + * The number of days before expiration remaninder. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'firstExpirationReminder'?: number; + /** + * The minimun length of account Id. By default is equals to -1. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'accountIdMinWordLength'?: number; + /** + * The minimun length of account name. By default is equals to -1. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'accountNameMinWordLength'?: number; + /** + * Maximum alpha. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minAlpha'?: number; + /** + * MinCharacterTypes. By default is equals to -1. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minCharacterTypes'?: number; + /** + * Maximum length of the password. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'maxLength'?: number; + /** + * Minimum length of the password. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minLength'?: number; + /** + * Maximum repetition of the same character in the password. By default is equals to -1. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'maxRepeatedChars'?: number; + /** + * Minimum amount of lower case character in the password. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minLower'?: number; + /** + * Minimum amount of numeric characters in the password. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minNumeric'?: number; + /** + * Minimum amount of special symbols in the password. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minSpecial'?: number; + /** + * Minimum amount of upper case symbols in the password. By default is equals to 0. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'minUpper'?: number; + /** + * Number of days before current password expires. By default is equals to 90. + * @type {number} + * @memberof Passwordpolicyv3dtoV1 + */ + 'passwordExpiration'?: number; + /** + * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'defaultPolicy'?: boolean; + /** + * Defines whether this policy is enabled to expire or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'enablePasswdExpiration'?: boolean; + /** + * Defines whether this policy require strong Auth or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'requireStrongAuthn'?: boolean; + /** + * Defines whether this policy require strong Auth of network or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'requireStrongAuthOffNetwork'?: boolean; + /** + * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'requireStrongAuthUntrustedGeographies'?: boolean; + /** + * Defines whether this policy uses account attributes or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'useAccountAttributes'?: boolean; + /** + * Defines whether this policy uses dictionary or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'useDictionary'?: boolean; + /** + * Defines whether this policy uses identity attributes or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'useIdentityAttributes'?: boolean; + /** + * Defines whether this policy validate against account id or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'validateAgainstAccountId'?: boolean; + /** + * Defines whether this policy validate against account name or not. This field is false by default. + * @type {boolean} + * @memberof Passwordpolicyv3dtoV1 + */ + 'validateAgainstAccountName'?: boolean; + /** + * + * @type {string} + * @memberof Passwordpolicyv3dtoV1 + */ + 'created'?: string | null; + /** + * + * @type {string} + * @memberof Passwordpolicyv3dtoV1 + */ + 'modified'?: string | null; + /** + * List of sources IDs managed by this password policy. + * @type {Array} + * @memberof Passwordpolicyv3dtoV1 + */ + 'sourceIds'?: Array; +} + +/** + * PasswordPoliciesV1Api - axios parameter creator + * @export + */ +export const PasswordPoliciesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates the specified password policy. + * @summary Create password policy + * @param {Passwordpolicyv3dtoV1} passwordpolicyv3dtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordPolicyV1: async (passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordpolicyv3dtoV1' is not null or undefined + assertParamExists('createPasswordPolicyV1', 'passwordpolicyv3dtoV1', passwordpolicyv3dtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/password-policies/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(passwordpolicyv3dtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes the specified password policy. + * @summary Delete password policy by id + * @param {string} id The ID of password policy to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePasswordPolicyV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deletePasswordPolicyV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/password-policies/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the password policy for the specified ID. + * @summary Get password policy by id + * @param {string} id The ID of password policy to retrieve. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordPolicyByIdV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getPasswordPolicyByIdV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/password-policies/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets list of all Password Policies. Requires role of ORG_ADMIN + * @summary List password policies + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPasswordPoliciesV1: async (limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/password-policies/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates the specified password policy. + * @summary Update password policy by id + * @param {string} id The ID of password policy to update. + * @param {Passwordpolicyv3dtoV1} passwordpolicyv3dtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setPasswordPolicyV1: async (id: string, passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('setPasswordPolicyV1', 'id', id) + // verify required parameter 'passwordpolicyv3dtoV1' is not null or undefined + assertParamExists('setPasswordPolicyV1', 'passwordpolicyv3dtoV1', passwordpolicyv3dtoV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/password-policies/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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(passwordpolicyv3dtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PasswordPoliciesV1Api - functional programming interface + * @export + */ +export const PasswordPoliciesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PasswordPoliciesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates the specified password policy. + * @summary Create password policy + * @param {Passwordpolicyv3dtoV1} passwordpolicyv3dtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createPasswordPolicyV1(passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicyV1(passwordpolicyv3dtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV1Api.createPasswordPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes the specified password policy. + * @summary Delete password policy by id + * @param {string} id The ID of password policy to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deletePasswordPolicyV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicyV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV1Api.deletePasswordPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the password policy for the specified ID. + * @summary Get password policy by id + * @param {string} id The ID of password policy to retrieve. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordPolicyByIdV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyByIdV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV1Api.getPasswordPolicyByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets list of all Password Policies. Requires role of ORG_ADMIN + * @summary List password policies + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPasswordPoliciesV1(limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPoliciesV1(limit, offset, count, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV1Api.listPasswordPoliciesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates the specified password policy. + * @summary Update password policy by id + * @param {string} id The ID of password policy to update. + * @param {Passwordpolicyv3dtoV1} passwordpolicyv3dtoV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setPasswordPolicyV1(id: string, passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicyV1(id, passwordpolicyv3dtoV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV1Api.setPasswordPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PasswordPoliciesV1Api - factory interface + * @export + */ +export const PasswordPoliciesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PasswordPoliciesV1ApiFp(configuration) + return { + /** + * This API creates the specified password policy. + * @summary Create password policy + * @param {PasswordPoliciesV1ApiCreatePasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiCreatePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createPasswordPolicyV1(requestParameters.passwordpolicyv3dtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes the specified password policy. + * @summary Delete password policy by id + * @param {PasswordPoliciesV1ApiDeletePasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiDeletePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deletePasswordPolicyV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the password policy for the specified ID. + * @summary Get password policy by id + * @param {PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordPolicyByIdV1(requestParameters: PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPasswordPolicyByIdV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets list of all Password Policies. Requires role of ORG_ADMIN + * @summary List password policies + * @param {PasswordPoliciesV1ApiListPasswordPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPasswordPoliciesV1(requestParameters: PasswordPoliciesV1ApiListPasswordPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPasswordPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates the specified password policy. + * @summary Update password policy by id + * @param {PasswordPoliciesV1ApiSetPasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setPasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiSetPasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setPasswordPolicyV1(requestParameters.id, requestParameters.passwordpolicyv3dtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createPasswordPolicyV1 operation in PasswordPoliciesV1Api. + * @export + * @interface PasswordPoliciesV1ApiCreatePasswordPolicyV1Request + */ +export interface PasswordPoliciesV1ApiCreatePasswordPolicyV1Request { + /** + * + * @type {Passwordpolicyv3dtoV1} + * @memberof PasswordPoliciesV1ApiCreatePasswordPolicyV1 + */ + readonly passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordPoliciesV1ApiCreatePasswordPolicyV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deletePasswordPolicyV1 operation in PasswordPoliciesV1Api. + * @export + * @interface PasswordPoliciesV1ApiDeletePasswordPolicyV1Request + */ +export interface PasswordPoliciesV1ApiDeletePasswordPolicyV1Request { + /** + * The ID of password policy to delete. + * @type {string} + * @memberof PasswordPoliciesV1ApiDeletePasswordPolicyV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordPoliciesV1ApiDeletePasswordPolicyV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getPasswordPolicyByIdV1 operation in PasswordPoliciesV1Api. + * @export + * @interface PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request + */ +export interface PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request { + /** + * The ID of password policy to retrieve. + * @type {string} + * @memberof PasswordPoliciesV1ApiGetPasswordPolicyByIdV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordPoliciesV1ApiGetPasswordPolicyByIdV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listPasswordPoliciesV1 operation in PasswordPoliciesV1Api. + * @export + * @interface PasswordPoliciesV1ApiListPasswordPoliciesV1Request + */ +export interface PasswordPoliciesV1ApiListPasswordPoliciesV1Request { + /** + * 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 PasswordPoliciesV1ApiListPasswordPoliciesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof PasswordPoliciesV1ApiListPasswordPoliciesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof PasswordPoliciesV1ApiListPasswordPoliciesV1 + */ + readonly count?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordPoliciesV1ApiListPasswordPoliciesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setPasswordPolicyV1 operation in PasswordPoliciesV1Api. + * @export + * @interface PasswordPoliciesV1ApiSetPasswordPolicyV1Request + */ +export interface PasswordPoliciesV1ApiSetPasswordPolicyV1Request { + /** + * The ID of password policy to update. + * @type {string} + * @memberof PasswordPoliciesV1ApiSetPasswordPolicyV1 + */ + readonly id: string + + /** + * + * @type {Passwordpolicyv3dtoV1} + * @memberof PasswordPoliciesV1ApiSetPasswordPolicyV1 + */ + readonly passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof PasswordPoliciesV1ApiSetPasswordPolicyV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * PasswordPoliciesV1Api - object-oriented interface + * @export + * @class PasswordPoliciesV1Api + * @extends {BaseAPI} + */ +export class PasswordPoliciesV1Api extends BaseAPI { + /** + * This API creates the specified password policy. + * @summary Create password policy + * @param {PasswordPoliciesV1ApiCreatePasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordPoliciesV1Api + */ + public createPasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiCreatePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordPoliciesV1ApiFp(this.configuration).createPasswordPolicyV1(requestParameters.passwordpolicyv3dtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes the specified password policy. + * @summary Delete password policy by id + * @param {PasswordPoliciesV1ApiDeletePasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordPoliciesV1Api + */ + public deletePasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiDeletePasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordPoliciesV1ApiFp(this.configuration).deletePasswordPolicyV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the password policy for the specified ID. + * @summary Get password policy by id + * @param {PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordPoliciesV1Api + */ + public getPasswordPolicyByIdV1(requestParameters: PasswordPoliciesV1ApiGetPasswordPolicyByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordPoliciesV1ApiFp(this.configuration).getPasswordPolicyByIdV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets list of all Password Policies. Requires role of ORG_ADMIN + * @summary List password policies + * @param {PasswordPoliciesV1ApiListPasswordPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordPoliciesV1Api + */ + public listPasswordPoliciesV1(requestParameters: PasswordPoliciesV1ApiListPasswordPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return PasswordPoliciesV1ApiFp(this.configuration).listPasswordPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates the specified password policy. + * @summary Update password policy by id + * @param {PasswordPoliciesV1ApiSetPasswordPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordPoliciesV1Api + */ + public setPasswordPolicyV1(requestParameters: PasswordPoliciesV1ApiSetPasswordPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordPoliciesV1ApiFp(this.configuration).setPasswordPolicyV1(requestParameters.id, requestParameters.passwordpolicyv3dtoV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/password_policies/base.ts b/sdk-output/password_policies/base.ts new file mode 100644 index 00000000..a08515d5 --- /dev/null +++ b/sdk-output/password_policies/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Policies + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/password_policies/common.ts b/sdk-output/password_policies/common.ts new file mode 100644 index 00000000..5e8aedaa --- /dev/null +++ b/sdk-output/password_policies/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Policies + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/password_policies/configuration.ts b/sdk-output/password_policies/configuration.ts new file mode 100644 index 00000000..de5879db --- /dev/null +++ b/sdk-output/password_policies/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Policies + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/password_policies/git_push.sh b/sdk-output/password_policies/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/password_policies/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/password_policies/index.ts b/sdk-output/password_policies/index.ts new file mode 100644 index 00000000..9ad4dc74 --- /dev/null +++ b/sdk-output/password_policies/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Policies + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/password_policies/package.json b/sdk-output/password_policies/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/password_policies/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/password_policies/tsconfig.json b/sdk-output/password_policies/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/password_policies/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/password_sync_groups/.gitignore b/sdk-output/password_sync_groups/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/password_sync_groups/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/password_sync_groups/.npmignore b/sdk-output/password_sync_groups/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/password_sync_groups/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/password_sync_groups/.openapi-generator-ignore b/sdk-output/password_sync_groups/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/password_sync_groups/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/password_sync_groups/.openapi-generator/FILES b/sdk-output/password_sync_groups/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/password_sync_groups/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/password_sync_groups/.openapi-generator/VERSION b/sdk-output/password_sync_groups/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/password_sync_groups/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/password_sync_groups/.sdk-partition b/sdk-output/password_sync_groups/.sdk-partition new file mode 100644 index 00000000..a456c6c7 --- /dev/null +++ b/sdk-output/password_sync_groups/.sdk-partition @@ -0,0 +1 @@ +password-sync-groups \ No newline at end of file diff --git a/sdk-output/password_sync_groups/README.md b/sdk-output/password_sync_groups/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_sync_groups/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_sync_groups/api.ts b/sdk-output/password_sync_groups/api.ts new file mode 100644 index 00000000..4e06ff62 --- /dev/null +++ b/sdk-output/password_sync_groups/api.ts @@ -0,0 +1,664 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Sync Groups + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPasswordSyncGroupsV1401ResponseV1 + */ +export interface GetPasswordSyncGroupsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordSyncGroupsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPasswordSyncGroupsV1429ResponseV1 + */ +export interface GetPasswordSyncGroupsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPasswordSyncGroupsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PasswordsyncgroupV1 + */ +export interface PasswordsyncgroupV1 { + /** + * ID of the sync group + * @type {string} + * @memberof PasswordsyncgroupV1 + */ + 'id'?: string; + /** + * Name of the sync group + * @type {string} + * @memberof PasswordsyncgroupV1 + */ + 'name'?: string; + /** + * ID of the password policy + * @type {string} + * @memberof PasswordsyncgroupV1 + */ + 'passwordPolicyId'?: string; + /** + * List of password managed sources IDs + * @type {Array} + * @memberof PasswordsyncgroupV1 + */ + 'sourceIds'?: Array; + /** + * The date and time this sync group was created + * @type {string} + * @memberof PasswordsyncgroupV1 + */ + 'created'?: string | null; + /** + * The date and time this sync group was last modified + * @type {string} + * @memberof PasswordsyncgroupV1 + */ + 'modified'?: string | null; +} + +/** + * PasswordSyncGroupsV1Api - axios parameter creator + * @export + */ +export const PasswordSyncGroupsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a password sync group based on the specifications provided. + * @summary Create password sync group + * @param {PasswordsyncgroupV1} passwordsyncgroupV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordSyncGroupV1: async (passwordsyncgroupV1: PasswordsyncgroupV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'passwordsyncgroupV1' is not null or undefined + assertParamExists('createPasswordSyncGroupV1', 'passwordsyncgroupV1', passwordsyncgroupV1) + const localVarPath = `/password-sync-groups/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(passwordsyncgroupV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes the specified password sync group. + * @summary Delete password sync group by id + * @param {string} id The ID of password sync group to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePasswordSyncGroupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deletePasswordSyncGroupV1', 'id', id) + const localVarPath = `/password-sync-groups/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, + }; + }, + /** + * This API returns the sync group for the specified ID. + * @summary Get password sync group by id + * @param {string} id The ID of password sync group to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordSyncGroupV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getPasswordSyncGroupV1', 'id', id) + const localVarPath = `/password-sync-groups/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, + }; + }, + /** + * This API returns a list of password sync groups. + * @summary Get password sync group list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordSyncGroupsV1: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/password-sync-groups/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates the specified password sync group. + * @summary Update password sync group by id + * @param {string} id The ID of password sync group to update. + * @param {PasswordsyncgroupV1} passwordsyncgroupV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePasswordSyncGroupV1: async (id: string, passwordsyncgroupV1: PasswordsyncgroupV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updatePasswordSyncGroupV1', 'id', id) + // verify required parameter 'passwordsyncgroupV1' is not null or undefined + assertParamExists('updatePasswordSyncGroupV1', 'passwordsyncgroupV1', passwordsyncgroupV1) + const localVarPath = `/password-sync-groups/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: 'PUT', ...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(passwordsyncgroupV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PasswordSyncGroupsV1Api - functional programming interface + * @export + */ +export const PasswordSyncGroupsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PasswordSyncGroupsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a password sync group based on the specifications provided. + * @summary Create password sync group + * @param {PasswordsyncgroupV1} passwordsyncgroupV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createPasswordSyncGroupV1(passwordsyncgroupV1: PasswordsyncgroupV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroupV1(passwordsyncgroupV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV1Api.createPasswordSyncGroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes the specified password sync group. + * @summary Delete password sync group by id + * @param {string} id The ID of password sync group to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deletePasswordSyncGroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroupV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV1Api.deletePasswordSyncGroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the sync group for the specified ID. + * @summary Get password sync group by id + * @param {string} id The ID of password sync group to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordSyncGroupV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroupV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV1Api.getPasswordSyncGroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of password sync groups. + * @summary Get password sync group list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPasswordSyncGroupsV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroupsV1(limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV1Api.getPasswordSyncGroupsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates the specified password sync group. + * @summary Update password sync group by id + * @param {string} id The ID of password sync group to update. + * @param {PasswordsyncgroupV1} passwordsyncgroupV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updatePasswordSyncGroupV1(id: string, passwordsyncgroupV1: PasswordsyncgroupV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroupV1(id, passwordsyncgroupV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV1Api.updatePasswordSyncGroupV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PasswordSyncGroupsV1Api - factory interface + * @export + */ +export const PasswordSyncGroupsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PasswordSyncGroupsV1ApiFp(configuration) + return { + /** + * This API creates a password sync group based on the specifications provided. + * @summary Create password sync group + * @param {PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createPasswordSyncGroupV1(requestParameters.passwordsyncgroupV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes the specified password sync group. + * @summary Delete password sync group by id + * @param {PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deletePasswordSyncGroupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the sync group for the specified ID. + * @summary Get password sync group by id + * @param {PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPasswordSyncGroupV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of password sync groups. + * @summary Get password sync group list + * @param {PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPasswordSyncGroupsV1(requestParameters: PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPasswordSyncGroupsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates the specified password sync group. + * @summary Update password sync group by id + * @param {PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updatePasswordSyncGroupV1(requestParameters.id, requestParameters.passwordsyncgroupV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createPasswordSyncGroupV1 operation in PasswordSyncGroupsV1Api. + * @export + * @interface PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request + */ +export interface PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request { + /** + * + * @type {PasswordsyncgroupV1} + * @memberof PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1 + */ + readonly passwordsyncgroupV1: PasswordsyncgroupV1 +} + +/** + * Request parameters for deletePasswordSyncGroupV1 operation in PasswordSyncGroupsV1Api. + * @export + * @interface PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request + */ +export interface PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request { + /** + * The ID of password sync group to delete. + * @type {string} + * @memberof PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1 + */ + readonly id: string +} + +/** + * Request parameters for getPasswordSyncGroupV1 operation in PasswordSyncGroupsV1Api. + * @export + * @interface PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request + */ +export interface PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request { + /** + * The ID of password sync group to retrieve. + * @type {string} + * @memberof PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1 + */ + readonly id: string +} + +/** + * Request parameters for getPasswordSyncGroupsV1 operation in PasswordSyncGroupsV1Api. + * @export + * @interface PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request + */ +export interface PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request { + /** + * 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 PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for updatePasswordSyncGroupV1 operation in PasswordSyncGroupsV1Api. + * @export + * @interface PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request + */ +export interface PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request { + /** + * The ID of password sync group to update. + * @type {string} + * @memberof PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1 + */ + readonly id: string + + /** + * + * @type {PasswordsyncgroupV1} + * @memberof PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1 + */ + readonly passwordsyncgroupV1: PasswordsyncgroupV1 +} + +/** + * PasswordSyncGroupsV1Api - object-oriented interface + * @export + * @class PasswordSyncGroupsV1Api + * @extends {BaseAPI} + */ +export class PasswordSyncGroupsV1Api extends BaseAPI { + /** + * This API creates a password sync group based on the specifications provided. + * @summary Create password sync group + * @param {PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordSyncGroupsV1Api + */ + public createPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiCreatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordSyncGroupsV1ApiFp(this.configuration).createPasswordSyncGroupV1(requestParameters.passwordsyncgroupV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes the specified password sync group. + * @summary Delete password sync group by id + * @param {PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordSyncGroupsV1Api + */ + public deletePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiDeletePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordSyncGroupsV1ApiFp(this.configuration).deletePasswordSyncGroupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the sync group for the specified ID. + * @summary Get password sync group by id + * @param {PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordSyncGroupsV1Api + */ + public getPasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiGetPasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordSyncGroupsV1ApiFp(this.configuration).getPasswordSyncGroupV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of password sync groups. + * @summary Get password sync group list + * @param {PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordSyncGroupsV1Api + */ + public getPasswordSyncGroupsV1(requestParameters: PasswordSyncGroupsV1ApiGetPasswordSyncGroupsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return PasswordSyncGroupsV1ApiFp(this.configuration).getPasswordSyncGroupsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates the specified password sync group. + * @summary Update password sync group by id + * @param {PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PasswordSyncGroupsV1Api + */ + public updatePasswordSyncGroupV1(requestParameters: PasswordSyncGroupsV1ApiUpdatePasswordSyncGroupV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PasswordSyncGroupsV1ApiFp(this.configuration).updatePasswordSyncGroupV1(requestParameters.id, requestParameters.passwordsyncgroupV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/password_sync_groups/base.ts b/sdk-output/password_sync_groups/base.ts new file mode 100644 index 00000000..115b721d --- /dev/null +++ b/sdk-output/password_sync_groups/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Sync Groups + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/password_sync_groups/common.ts b/sdk-output/password_sync_groups/common.ts new file mode 100644 index 00000000..6499748c --- /dev/null +++ b/sdk-output/password_sync_groups/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Sync Groups + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/password_sync_groups/configuration.ts b/sdk-output/password_sync_groups/configuration.ts new file mode 100644 index 00000000..26cf0fec --- /dev/null +++ b/sdk-output/password_sync_groups/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Sync Groups + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/password_sync_groups/git_push.sh b/sdk-output/password_sync_groups/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/password_sync_groups/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/password_sync_groups/index.ts b/sdk-output/password_sync_groups/index.ts new file mode 100644 index 00000000..7d261456 --- /dev/null +++ b/sdk-output/password_sync_groups/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Password Sync Groups + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/password_sync_groups/package.json b/sdk-output/password_sync_groups/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/password_sync_groups/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/password_sync_groups/tsconfig.json b/sdk-output/password_sync_groups/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/password_sync_groups/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/personal_access_tokens/.gitignore b/sdk-output/personal_access_tokens/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/personal_access_tokens/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/personal_access_tokens/.npmignore b/sdk-output/personal_access_tokens/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/personal_access_tokens/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/personal_access_tokens/.openapi-generator-ignore b/sdk-output/personal_access_tokens/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/personal_access_tokens/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/personal_access_tokens/.openapi-generator/FILES b/sdk-output/personal_access_tokens/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/personal_access_tokens/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/personal_access_tokens/.openapi-generator/VERSION b/sdk-output/personal_access_tokens/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/personal_access_tokens/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/personal_access_tokens/.sdk-partition b/sdk-output/personal_access_tokens/.sdk-partition new file mode 100644 index 00000000..414eb650 --- /dev/null +++ b/sdk-output/personal_access_tokens/.sdk-partition @@ -0,0 +1 @@ +personal-access-tokens \ No newline at end of file diff --git a/sdk-output/personal_access_tokens/README.md b/sdk-output/personal_access_tokens/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/personal_access_tokens/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/personal_access_tokens/api.ts b/sdk-output/personal_access_tokens/api.ts new file mode 100644 index 00000000..910c2d01 --- /dev/null +++ b/sdk-output/personal_access_tokens/api.ts @@ -0,0 +1,767 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Personal Access Tokens + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Object for specifying the name of a personal access token to create + * @export + * @interface CreatepersonalaccesstokenrequestV1 + */ +export interface CreatepersonalaccesstokenrequestV1 { + /** + * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. + * @type {string} + * @memberof CreatepersonalaccesstokenrequestV1 + */ + 'name': string; + /** + * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. + * @type {Array} + * @memberof CreatepersonalaccesstokenrequestV1 + */ + 'scope'?: Array | null; + /** + * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. + * @type {number} + * @memberof CreatepersonalaccesstokenrequestV1 + */ + 'accessTokenValiditySeconds'?: number | null; + /** + * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Valid Values (dependent on `userAwareTokenNeverExpires`):** * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (after the current date/time). There is no upper limit on how far in the future the expiration date can be set. `expirationDate` cannot be `null` in this case. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. + * @type {string} + * @memberof CreatepersonalaccesstokenrequestV1 + */ + 'expirationDate'?: string | null; + /** + * Indicates that the user creating this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When set to `true`, this flag confirms that the user understands the security risks associated with non-expiring tokens. **Security Awareness:** Setting this field to `true` serves as an explicit acknowledgment that the user creating the token understands: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Required Validation:** If `expirationDate` is `null` or empty (not included in the request body), `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Behavior:** * When set to `true`: Indicates that the user acknowledges they are creating a token that will never expire. When `expirationDate` is `null` or empty, the token will never expire. * When set to `false` or not specified (and `expirationDate` is provided): The token will follow normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. + * @type {boolean} + * @memberof CreatepersonalaccesstokenrequestV1 + */ + 'userAwareTokenNeverExpires'?: boolean | null; +} +/** + * + * @export + * @interface CreatepersonalaccesstokenresponseV1 + */ +export interface CreatepersonalaccesstokenresponseV1 { + /** + * The ID of the personal access token (to be used as the username for Basic Auth). + * @type {string} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'id': string; + /** + * The secret of the personal access token (to be used as the password for Basic Auth). + * @type {string} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'secret': string; + /** + * Scopes of the personal access token. + * @type {Array} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'scope': Array | null; + /** + * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + * @type {string} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'name': string; + /** + * + * @type {PatownerV1} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'owner': PatownerV1; + /** + * The date and time, down to the millisecond, when this personal access token was created. + * @type {string} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'created': string; + /** + * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. + * @type {number} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'accessTokenValiditySeconds': number; + /** + * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. + * @type {string} + * @memberof CreatepersonalaccesstokenresponseV1 + */ + 'expirationDate': string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetpersonalaccesstokenresponseV1 + */ +export interface GetpersonalaccesstokenresponseV1 { + /** + * The ID of the personal access token (to be used as the username for Basic Auth). + * @type {string} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'id': string; + /** + * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + * @type {string} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'name': string; + /** + * Scopes of the personal access token. + * @type {Array} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'scope': Array | null; + /** + * + * @type {PatownerV1} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'owner': PatownerV1; + /** + * The date and time, down to the millisecond, when this personal access token was created. + * @type {string} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'created': string; + /** + * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. + * @type {string} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'lastUsed'?: string | null; + /** + * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. + * @type {boolean} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'managed'?: boolean; + /** + * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. + * @type {number} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'accessTokenValiditySeconds'?: number; + /** + * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty, the token will never expire (and `userAwareTokenNeverExpires` will be `true`). When `expirationDate` is provided, this value must be a future date. There is no upper limit on how far in the future the expiration date can be set. + * @type {string} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'expirationDate'?: string | null; + /** + * Indicates that the user who created or updated this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When `true`, this flag confirms that the user understood the security risks associated with non-expiring tokens at the time of creation or update. **Security Awareness:** This field serves as a record that the user acknowledged: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Behavior:** * When `true`: Indicates that the user acknowledged they were creating a token that will never expire. When `expirationDate` is `null`, the token will never expire. * When `false`: The token follows normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. + * @type {boolean} + * @memberof GetpersonalaccesstokenresponseV1 + */ + 'userAwareTokenNeverExpires'?: boolean; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListPersonalAccessTokensV1401ResponseV1 + */ +export interface ListPersonalAccessTokensV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPersonalAccessTokensV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListPersonalAccessTokensV1429ResponseV1 + */ +export interface ListPersonalAccessTokensV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPersonalAccessTokensV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Personal access token owner\'s identity. + * @export + * @interface PatownerV1 + */ +export interface PatownerV1 { + /** + * Personal access token owner\'s DTO type. + * @type {string} + * @memberof PatownerV1 + */ + 'type'?: PatownerV1TypeV1; + /** + * Personal access token owner\'s identity ID. + * @type {string} + * @memberof PatownerV1 + */ + 'id'?: string; + /** + * Personal access token owner\'s human-readable display name. + * @type {string} + * @memberof PatownerV1 + */ + 'name'?: string; +} + +export const PatownerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type PatownerV1TypeV1 = typeof PatownerV1TypeV1[keyof typeof PatownerV1TypeV1]; + + +/** + * PersonalAccessTokensV1Api - axios parameter creator + * @export + */ +export const PersonalAccessTokensV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Create personal access token + * @param {CreatepersonalaccesstokenrequestV1} createpersonalaccesstokenrequestV1 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPersonalAccessTokenV1: async (createpersonalaccesstokenrequestV1: CreatepersonalaccesstokenrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createpersonalaccesstokenrequestV1' is not null or undefined + assertParamExists('createPersonalAccessTokenV1', 'createpersonalaccesstokenrequestV1', createpersonalaccesstokenrequestV1) + const localVarPath = `/personal-access-tokens/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(createpersonalaccesstokenrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes a personal access token. + * @summary Delete personal access token + * @param {string} id The personal access token id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePersonalAccessTokenV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deletePersonalAccessTokenV1', 'id', id) + const localVarPath = `/personal-access-tokens/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, + }; + }, + /** + * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. + * @summary List personal access tokens + * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' + * @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: **lastUsed**: *le, isnull* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPersonalAccessTokensV1: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/personal-access-tokens/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 (ownerId !== undefined) { + localVarQueryParameter['owner-id'] = ownerId; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Patch personal access token + * @param {string} id The Personal Access Token id + * @param {Array} jsonpatchoperationV1 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPersonalAccessTokenV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchPersonalAccessTokenV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchPersonalAccessTokenV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/personal-access-tokens/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PersonalAccessTokensV1Api - functional programming interface + * @export + */ +export const PersonalAccessTokensV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PersonalAccessTokensV1ApiAxiosParamCreator(configuration) + return { + /** + * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Create personal access token + * @param {CreatepersonalaccesstokenrequestV1} createpersonalaccesstokenrequestV1 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createPersonalAccessTokenV1(createpersonalaccesstokenrequestV1: CreatepersonalaccesstokenrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessTokenV1(createpersonalaccesstokenrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV1Api.createPersonalAccessTokenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes a personal access token. + * @summary Delete personal access token + * @param {string} id The personal access token id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deletePersonalAccessTokenV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessTokenV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV1Api.deletePersonalAccessTokenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. + * @summary List personal access tokens + * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' + * @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: **lastUsed**: *le, isnull* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPersonalAccessTokensV1(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokensV1(ownerId, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV1Api.listPersonalAccessTokensV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Patch personal access token + * @param {string} id The Personal Access Token id + * @param {Array} jsonpatchoperationV1 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchPersonalAccessTokenV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessTokenV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV1Api.patchPersonalAccessTokenV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PersonalAccessTokensV1Api - factory interface + * @export + */ +export const PersonalAccessTokensV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PersonalAccessTokensV1ApiFp(configuration) + return { + /** + * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Create personal access token + * @param {PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createPersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createPersonalAccessTokenV1(requestParameters.createpersonalaccesstokenrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes a personal access token. + * @summary Delete personal access token + * @param {PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deletePersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deletePersonalAccessTokenV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. + * @summary List personal access tokens + * @param {PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPersonalAccessTokensV1(requestParameters: PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPersonalAccessTokensV1(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Patch personal access token + * @param {PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchPersonalAccessTokenV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createPersonalAccessTokenV1 operation in PersonalAccessTokensV1Api. + * @export + * @interface PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request + */ +export interface PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request { + /** + * Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @type {CreatepersonalaccesstokenrequestV1} + * @memberof PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1 + */ + readonly createpersonalaccesstokenrequestV1: CreatepersonalaccesstokenrequestV1 +} + +/** + * Request parameters for deletePersonalAccessTokenV1 operation in PersonalAccessTokensV1Api. + * @export + * @interface PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request + */ +export interface PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request { + /** + * The personal access token id + * @type {string} + * @memberof PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1 + */ + readonly id: string +} + +/** + * Request parameters for listPersonalAccessTokensV1 operation in PersonalAccessTokensV1Api. + * @export + * @interface PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request + */ +export interface PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request { + /** + * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' + * @type {string} + * @memberof PersonalAccessTokensV1ApiListPersonalAccessTokensV1 + */ + readonly ownerId?: 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: **lastUsed**: *le, isnull* + * @type {string} + * @memberof PersonalAccessTokensV1ApiListPersonalAccessTokensV1 + */ + readonly filters?: string +} + +/** + * Request parameters for patchPersonalAccessTokenV1 operation in PersonalAccessTokensV1Api. + * @export + * @interface PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request + */ +export interface PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request { + /** + * The Personal Access Token id + * @type {string} + * @memberof PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1 + */ + readonly id: string + + /** + * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + * @type {Array} + * @memberof PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * PersonalAccessTokensV1Api - object-oriented interface + * @export + * @class PersonalAccessTokensV1Api + * @extends {BaseAPI} + */ +export class PersonalAccessTokensV1Api extends BaseAPI { + /** + * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Create personal access token + * @param {PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PersonalAccessTokensV1Api + */ + public createPersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiCreatePersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PersonalAccessTokensV1ApiFp(this.configuration).createPersonalAccessTokenV1(requestParameters.createpersonalaccesstokenrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes a personal access token. + * @summary Delete personal access token + * @param {PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PersonalAccessTokensV1Api + */ + public deletePersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiDeletePersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PersonalAccessTokensV1ApiFp(this.configuration).deletePersonalAccessTokenV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. + * @summary List personal access tokens + * @param {PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PersonalAccessTokensV1Api + */ + public listPersonalAccessTokensV1(requestParameters: PersonalAccessTokensV1ApiListPersonalAccessTokensV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return PersonalAccessTokensV1ApiFp(this.configuration).listPersonalAccessTokensV1(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + * @summary Patch personal access token + * @param {PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PersonalAccessTokensV1Api + */ + public patchPersonalAccessTokenV1(requestParameters: PersonalAccessTokensV1ApiPatchPersonalAccessTokenV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PersonalAccessTokensV1ApiFp(this.configuration).patchPersonalAccessTokenV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/personal_access_tokens/base.ts b/sdk-output/personal_access_tokens/base.ts new file mode 100644 index 00000000..737bc519 --- /dev/null +++ b/sdk-output/personal_access_tokens/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Personal Access Tokens + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/personal_access_tokens/common.ts b/sdk-output/personal_access_tokens/common.ts new file mode 100644 index 00000000..d9cb4e58 --- /dev/null +++ b/sdk-output/personal_access_tokens/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Personal Access Tokens + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/personal_access_tokens/configuration.ts b/sdk-output/personal_access_tokens/configuration.ts new file mode 100644 index 00000000..9fd0c5e7 --- /dev/null +++ b/sdk-output/personal_access_tokens/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Personal Access Tokens + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/personal_access_tokens/git_push.sh b/sdk-output/personal_access_tokens/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/personal_access_tokens/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/personal_access_tokens/index.ts b/sdk-output/personal_access_tokens/index.ts new file mode 100644 index 00000000..3cfe145f --- /dev/null +++ b/sdk-output/personal_access_tokens/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Personal Access Tokens + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/personal_access_tokens/package.json b/sdk-output/personal_access_tokens/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/personal_access_tokens/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/personal_access_tokens/tsconfig.json b/sdk-output/personal_access_tokens/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/personal_access_tokens/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/privilege_criteria/.gitignore b/sdk-output/privilege_criteria/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/privilege_criteria/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/privilege_criteria/.npmignore b/sdk-output/privilege_criteria/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/privilege_criteria/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/privilege_criteria/.openapi-generator-ignore b/sdk-output/privilege_criteria/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/privilege_criteria/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/privilege_criteria/.openapi-generator/FILES b/sdk-output/privilege_criteria/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/privilege_criteria/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/privilege_criteria/.openapi-generator/VERSION b/sdk-output/privilege_criteria/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/privilege_criteria/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/privilege_criteria/.sdk-partition b/sdk-output/privilege_criteria/.sdk-partition new file mode 100644 index 00000000..b342370e --- /dev/null +++ b/sdk-output/privilege_criteria/.sdk-partition @@ -0,0 +1 @@ +privilege-criteria \ No newline at end of file diff --git a/sdk-output/privilege_criteria/README.md b/sdk-output/privilege_criteria/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/privilege_criteria/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/privilege_criteria/api.ts b/sdk-output/privilege_criteria/api.ts new file mode 100644 index 00000000..2c70593b --- /dev/null +++ b/sdk-output/privilege_criteria/api.ts @@ -0,0 +1,880 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria + * 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 CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + */ +export interface CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 { + /** + * The target type of the criteria item. + * @type {string} + * @memberof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + */ + 'targetType'?: CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1TargetTypeV1; + /** + * + * @type {string} + * @memberof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + */ + 'operator'?: CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1OperatorV1 | null; + /** + * The values to evaluate the property against. + * @type {Array} + * @memberof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + */ + 'values'?: Array; + /** + * Whether to ignore case when evaluating the property against the values. + * @type {boolean} + * @memberof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + */ + 'ignoreCase'?: boolean; +} + +export const CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1TargetTypeV1 = { + Group: 'group' +} as const; + +export type CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1TargetTypeV1 = typeof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1TargetTypeV1[keyof typeof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1TargetTypeV1]; +export const CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1OperatorV1 = { + DisplayName: 'displayName', + Description: 'description', + Value: 'value' +} as const; + +export type CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1OperatorV1 = typeof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1OperatorV1[keyof typeof CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1OperatorV1]; + +/** + * + * @export + * @interface CreateprivilegecriteriarequestGroupsInnerV1 + */ +export interface CreateprivilegecriteriarequestGroupsInnerV1 { + /** + * The logical operator to apply between criteria items in the group. + * @type {string} + * @memberof CreateprivilegecriteriarequestGroupsInnerV1 + */ + 'operator'?: CreateprivilegecriteriarequestGroupsInnerV1OperatorV1; + /** + * + * @type {Array} + * @memberof CreateprivilegecriteriarequestGroupsInnerV1 + */ + 'criteriaItems'?: Array; +} + +export const CreateprivilegecriteriarequestGroupsInnerV1OperatorV1 = { + And: 'AND', + Or: 'OR' +} as const; + +export type CreateprivilegecriteriarequestGroupsInnerV1OperatorV1 = typeof CreateprivilegecriteriarequestGroupsInnerV1OperatorV1[keyof typeof CreateprivilegecriteriarequestGroupsInnerV1OperatorV1]; + +/** + * + * @export + * @interface CreateprivilegecriteriarequestV1 + */ +export interface CreateprivilegecriteriarequestV1 { + /** + * The Id of the source that the criteria is applied to. + * @type {string} + * @memberof CreateprivilegecriteriarequestV1 + */ + 'sourceId'?: string; + /** + * The type of criteria being created. Expects \"CUSTOM\". + * @type {string} + * @memberof CreateprivilegecriteriarequestV1 + */ + 'type'?: CreateprivilegecriteriarequestV1TypeV1; + /** + * The logical operator to apply between groups. + * @type {string} + * @memberof CreateprivilegecriteriarequestV1 + */ + 'operator'?: CreateprivilegecriteriarequestV1OperatorV1; + /** + * + * @type {Array} + * @memberof CreateprivilegecriteriarequestV1 + */ + 'groups'?: Array; + /** + * The privilege level assigned by this criteria. + * @type {string} + * @memberof CreateprivilegecriteriarequestV1 + */ + 'privilegeLevel'?: CreateprivilegecriteriarequestV1PrivilegeLevelV1; +} + +export const CreateprivilegecriteriarequestV1TypeV1 = { + Custom: 'CUSTOM' +} as const; + +export type CreateprivilegecriteriarequestV1TypeV1 = typeof CreateprivilegecriteriarequestV1TypeV1[keyof typeof CreateprivilegecriteriarequestV1TypeV1]; +export const CreateprivilegecriteriarequestV1OperatorV1 = { + And: 'AND', + Or: 'OR' +} as const; + +export type CreateprivilegecriteriarequestV1OperatorV1 = typeof CreateprivilegecriteriarequestV1OperatorV1[keyof typeof CreateprivilegecriteriarequestV1OperatorV1]; +export const CreateprivilegecriteriarequestV1PrivilegeLevelV1 = { + High: 'HIGH', + Medium: 'MEDIUM', + Low: 'LOW' +} as const; + +export type CreateprivilegecriteriarequestV1PrivilegeLevelV1 = typeof CreateprivilegecriteriarequestV1PrivilegeLevelV1[keyof typeof CreateprivilegecriteriarequestV1PrivilegeLevelV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListPrivilegeCriteriaV1401ResponseV1 + */ +export interface ListPrivilegeCriteriaV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPrivilegeCriteriaV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListPrivilegeCriteriaV1429ResponseV1 + */ +export interface ListPrivilegeCriteriaV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListPrivilegeCriteriaV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ +export interface PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 { + /** + * The target type for the criteria item. + * @type {string} + * @memberof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ + 'targetType'?: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1TargetTypeV1; + /** + * The operator to apply to the property and values. + * @type {string} + * @memberof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ + 'operator'?: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1OperatorV1; + /** + * + * @type {string} + * @memberof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ + 'property'?: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1PropertyV1 | null; + /** + * The values to evaluate the property against. + * @type {Array} + * @memberof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ + 'values'?: Array; + /** + * Whether to ignore case when evaluating the property against the values. + * @type {boolean} + * @memberof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + */ + 'ignoreCase'?: boolean; +} + +export const PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1TargetTypeV1 = { + Group: 'group' +} as const; + +export type PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1TargetTypeV1 = typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1TargetTypeV1[keyof typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1TargetTypeV1]; +export const PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1OperatorV1 = { + In: 'IN', + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + Contains: 'CONTAINS', + DoesNotContain: 'DOES_NOT_CONTAIN', + StartsWith: 'STARTS_WITH', + EndsWith: 'ENDS_WITH' +} as const; + +export type PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1OperatorV1 = typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1OperatorV1[keyof typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1OperatorV1]; +export const PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1PropertyV1 = { + DisplayName: 'displayName', + Description: 'description', + Value: 'value' +} as const; + +export type PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1PropertyV1 = typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1PropertyV1[keyof typeof PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1PropertyV1]; + +/** + * + * @export + * @interface PrivilegecriteriadtoGroupsInnerV1 + */ +export interface PrivilegecriteriadtoGroupsInnerV1 { + /** + * The logical operator to apply between criteria items in the group. + * @type {string} + * @memberof PrivilegecriteriadtoGroupsInnerV1 + */ + 'operator'?: PrivilegecriteriadtoGroupsInnerV1OperatorV1; + /** + * + * @type {Array} + * @memberof PrivilegecriteriadtoGroupsInnerV1 + */ + 'criteriaItems'?: Array; +} + +export const PrivilegecriteriadtoGroupsInnerV1OperatorV1 = { + And: 'AND', + Or: 'OR' +} as const; + +export type PrivilegecriteriadtoGroupsInnerV1OperatorV1 = typeof PrivilegecriteriadtoGroupsInnerV1OperatorV1[keyof typeof PrivilegecriteriadtoGroupsInnerV1OperatorV1]; + +/** + * + * @export + * @interface PrivilegecriteriadtoV1 + */ +export interface PrivilegecriteriadtoV1 { + /** + * The Id of the criteria. + * @type {string} + * @memberof PrivilegecriteriadtoV1 + */ + 'id'?: string; + /** + * The Id of the source that the criteria is applied to. + * @type {string} + * @memberof PrivilegecriteriadtoV1 + */ + 'sourceId'?: string; + /** + * The type of criteria. + * @type {string} + * @memberof PrivilegecriteriadtoV1 + */ + 'type'?: PrivilegecriteriadtoV1TypeV1; + /** + * The logical operator to apply between groups. + * @type {string} + * @memberof PrivilegecriteriadtoV1 + */ + 'operator'?: PrivilegecriteriadtoV1OperatorV1; + /** + * + * @type {Array} + * @memberof PrivilegecriteriadtoV1 + */ + 'groups'?: Array; + /** + * The privilege level assigned by this criteria. + * @type {string} + * @memberof PrivilegecriteriadtoV1 + */ + 'privilegeLevel'?: PrivilegecriteriadtoV1PrivilegeLevelV1; +} + +export const PrivilegecriteriadtoV1TypeV1 = { + Custom: 'CUSTOM', + Connector: 'CONNECTOR', + SingleLevel: 'SINGLE_LEVEL' +} as const; + +export type PrivilegecriteriadtoV1TypeV1 = typeof PrivilegecriteriadtoV1TypeV1[keyof typeof PrivilegecriteriadtoV1TypeV1]; +export const PrivilegecriteriadtoV1OperatorV1 = { + And: 'AND', + Or: 'OR' +} as const; + +export type PrivilegecriteriadtoV1OperatorV1 = typeof PrivilegecriteriadtoV1OperatorV1[keyof typeof PrivilegecriteriadtoV1OperatorV1]; +export const PrivilegecriteriadtoV1PrivilegeLevelV1 = { + High: 'HIGH', + Medium: 'MEDIUM', + Low: 'LOW' +} as const; + +export type PrivilegecriteriadtoV1PrivilegeLevelV1 = typeof PrivilegecriteriadtoV1PrivilegeLevelV1[keyof typeof PrivilegecriteriadtoV1PrivilegeLevelV1]; + + +/** + * PrivilegeCriteriaV1Api - axios parameter creator + * @export + */ +export const PrivilegeCriteriaV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to create a custom privilege criteria + * @summary Create custom privilege criteria + * @param {CreateprivilegecriteriarequestV1} createprivilegecriteriarequestV1 Create custom privilege criteria request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomPrivilegeCriteriaV1: async (createprivilegecriteriarequestV1: CreateprivilegecriteriarequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createprivilegecriteriarequestV1' is not null or undefined + assertParamExists('createCustomPrivilegeCriteriaV1', 'createprivilegecriteriarequestV1', createprivilegecriteriarequestV1) + const localVarPath = `/criteria/v1/privilege`; + // 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(createprivilegecriteriarequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to delete a specific custom privilege criteria. + * @summary Delete privilege criteria + * @param {string} criteriaId The Id of the custom privilege criteria to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomPrivilegeCriteriaV1: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'criteriaId' is not null or undefined + assertParamExists('deleteCustomPrivilegeCriteriaV1', 'criteriaId', criteriaId) + const localVarPath = `/criteria/v1/privilege/{criteriaId}` + .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); + // 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, + }; + }, + /** + * Use this API to get a specific privilege criteria. + * @summary Get privilege criteria + * @param {string} criteriaId The Id of the privilege criteria record to return. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPrivilegeCriteriaV1: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'criteriaId' is not null or undefined + assertParamExists('getPrivilegeCriteriaV1', 'criteriaId', criteriaId) + const localVarPath = `/criteria/v1/privilege/{criteriaId}` + .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); + // 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, + }; + }, + /** + * Use this API to list all privilege criteria matching a filter + * @summary List privilege criteria + * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegeCriteriaV1: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'filters' is not null or undefined + assertParamExists('listPrivilegeCriteriaV1', 'filters', filters) + const localVarPath = `/criteria/v1/privilege`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update a specific custom privilege criteria by overwriting the information with new information. + * @summary Update privilege criteria + * @param {string} criteriaId The Id of the privilege criteria record to return. + * @param {PrivilegecriteriadtoV1} privilegecriteriadtoV1 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putCustomPrivilegeCriteriaValueV1: async (criteriaId: string, privilegecriteriadtoV1: PrivilegecriteriadtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'criteriaId' is not null or undefined + assertParamExists('putCustomPrivilegeCriteriaValueV1', 'criteriaId', criteriaId) + // verify required parameter 'privilegecriteriadtoV1' is not null or undefined + assertParamExists('putCustomPrivilegeCriteriaValueV1', 'privilegecriteriadtoV1', privilegecriteriadtoV1) + const localVarPath = `/criteria/v1/privilege/{criteriaId}` + .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); + // 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: 'PUT', ...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(privilegecriteriadtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PrivilegeCriteriaV1Api - functional programming interface + * @export + */ +export const PrivilegeCriteriaV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PrivilegeCriteriaV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to create a custom privilege criteria + * @summary Create custom privilege criteria + * @param {CreateprivilegecriteriarequestV1} createprivilegecriteriarequestV1 Create custom privilege criteria request body. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createCustomPrivilegeCriteriaV1(createprivilegecriteriarequestV1: CreateprivilegecriteriarequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPrivilegeCriteriaV1(createprivilegecriteriarequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV1Api.createCustomPrivilegeCriteriaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete a specific custom privilege criteria. + * @summary Delete privilege criteria + * @param {string} criteriaId The Id of the custom privilege criteria to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteCustomPrivilegeCriteriaV1(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPrivilegeCriteriaV1(criteriaId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV1Api.deleteCustomPrivilegeCriteriaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a specific privilege criteria. + * @summary Get privilege criteria + * @param {string} criteriaId The Id of the privilege criteria record to return. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPrivilegeCriteriaV1(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteriaV1(criteriaId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV1Api.getPrivilegeCriteriaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list all privilege criteria matching a filter + * @summary List privilege criteria + * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPrivilegeCriteriaV1(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteriaV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV1Api.listPrivilegeCriteriaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update a specific custom privilege criteria by overwriting the information with new information. + * @summary Update privilege criteria + * @param {string} criteriaId The Id of the privilege criteria record to return. + * @param {PrivilegecriteriadtoV1} privilegecriteriadtoV1 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putCustomPrivilegeCriteriaValueV1(criteriaId: string, privilegecriteriadtoV1: PrivilegecriteriadtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putCustomPrivilegeCriteriaValueV1(criteriaId, privilegecriteriadtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV1Api.putCustomPrivilegeCriteriaValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PrivilegeCriteriaV1Api - factory interface + * @export + */ +export const PrivilegeCriteriaV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PrivilegeCriteriaV1ApiFp(configuration) + return { + /** + * Use this API to create a custom privilege criteria + * @summary Create custom privilege criteria + * @param {PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createCustomPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createCustomPrivilegeCriteriaV1(requestParameters.createprivilegecriteriarequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete a specific custom privilege criteria. + * @summary Delete privilege criteria + * @param {PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteCustomPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCustomPrivilegeCriteriaV1(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a specific privilege criteria. + * @summary Get privilege criteria + * @param {PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPrivilegeCriteriaV1(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list all privilege criteria matching a filter + * @summary List privilege criteria + * @param {PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPrivilegeCriteriaV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update a specific custom privilege criteria by overwriting the information with new information. + * @summary Update privilege criteria + * @param {PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putCustomPrivilegeCriteriaValueV1(requestParameters: PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putCustomPrivilegeCriteriaValueV1(requestParameters.criteriaId, requestParameters.privilegecriteriadtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createCustomPrivilegeCriteriaV1 operation in PrivilegeCriteriaV1Api. + * @export + * @interface PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request + */ +export interface PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request { + /** + * Create custom privilege criteria request body. + * @type {CreateprivilegecriteriarequestV1} + * @memberof PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1 + */ + readonly createprivilegecriteriarequestV1: CreateprivilegecriteriarequestV1 +} + +/** + * Request parameters for deleteCustomPrivilegeCriteriaV1 operation in PrivilegeCriteriaV1Api. + * @export + * @interface PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request + */ +export interface PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request { + /** + * The Id of the custom privilege criteria to delete. + * @type {string} + * @memberof PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1 + */ + readonly criteriaId: string +} + +/** + * Request parameters for getPrivilegeCriteriaV1 operation in PrivilegeCriteriaV1Api. + * @export + * @interface PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request + */ +export interface PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request { + /** + * The Id of the privilege criteria record to return. + * @type {string} + * @memberof PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1 + */ + readonly criteriaId: string +} + +/** + * Request parameters for listPrivilegeCriteriaV1 operation in PrivilegeCriteriaV1Api. + * @export + * @interface PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request + */ +export interface PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request { + /** + * 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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @type {string} + * @memberof PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1 + */ + readonly filters: string +} + +/** + * Request parameters for putCustomPrivilegeCriteriaValueV1 operation in PrivilegeCriteriaV1Api. + * @export + * @interface PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request + */ +export interface PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request { + /** + * The Id of the privilege criteria record to return. + * @type {string} + * @memberof PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1 + */ + readonly criteriaId: string + + /** + * The new version of the custom privilege criteria. This overwrites the existing privilege criteria. + * @type {PrivilegecriteriadtoV1} + * @memberof PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1 + */ + readonly privilegecriteriadtoV1: PrivilegecriteriadtoV1 +} + +/** + * PrivilegeCriteriaV1Api - object-oriented interface + * @export + * @class PrivilegeCriteriaV1Api + * @extends {BaseAPI} + */ +export class PrivilegeCriteriaV1Api extends BaseAPI { + /** + * Use this API to create a custom privilege criteria + * @summary Create custom privilege criteria + * @param {PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaV1Api + */ + public createCustomPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiCreateCustomPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaV1ApiFp(this.configuration).createCustomPrivilegeCriteriaV1(requestParameters.createprivilegecriteriarequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete a specific custom privilege criteria. + * @summary Delete privilege criteria + * @param {PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaV1Api + */ + public deleteCustomPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiDeleteCustomPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaV1ApiFp(this.configuration).deleteCustomPrivilegeCriteriaV1(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a specific privilege criteria. + * @summary Get privilege criteria + * @param {PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaV1Api + */ + public getPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiGetPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaV1ApiFp(this.configuration).getPrivilegeCriteriaV1(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list all privilege criteria matching a filter + * @summary List privilege criteria + * @param {PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaV1Api + */ + public listPrivilegeCriteriaV1(requestParameters: PrivilegeCriteriaV1ApiListPrivilegeCriteriaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaV1ApiFp(this.configuration).listPrivilegeCriteriaV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update a specific custom privilege criteria by overwriting the information with new information. + * @summary Update privilege criteria + * @param {PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaV1Api + */ + public putCustomPrivilegeCriteriaValueV1(requestParameters: PrivilegeCriteriaV1ApiPutCustomPrivilegeCriteriaValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaV1ApiFp(this.configuration).putCustomPrivilegeCriteriaValueV1(requestParameters.criteriaId, requestParameters.privilegecriteriadtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/privilege_criteria/base.ts b/sdk-output/privilege_criteria/base.ts new file mode 100644 index 00000000..803042ef --- /dev/null +++ b/sdk-output/privilege_criteria/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/privilege_criteria/common.ts b/sdk-output/privilege_criteria/common.ts new file mode 100644 index 00000000..63e5ec59 --- /dev/null +++ b/sdk-output/privilege_criteria/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/privilege_criteria/configuration.ts b/sdk-output/privilege_criteria/configuration.ts new file mode 100644 index 00000000..5e9abff9 --- /dev/null +++ b/sdk-output/privilege_criteria/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/privilege_criteria/git_push.sh b/sdk-output/privilege_criteria/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/privilege_criteria/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/privilege_criteria/index.ts b/sdk-output/privilege_criteria/index.ts new file mode 100644 index 00000000..4022bc52 --- /dev/null +++ b/sdk-output/privilege_criteria/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/privilege_criteria/package.json b/sdk-output/privilege_criteria/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/privilege_criteria/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/privilege_criteria/tsconfig.json b/sdk-output/privilege_criteria/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/privilege_criteria/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/privilege_criteria_configuration/.gitignore b/sdk-output/privilege_criteria_configuration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/privilege_criteria_configuration/.npmignore b/sdk-output/privilege_criteria_configuration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/privilege_criteria_configuration/.openapi-generator-ignore b/sdk-output/privilege_criteria_configuration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES b/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/privilege_criteria_configuration/.openapi-generator/VERSION b/sdk-output/privilege_criteria_configuration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/privilege_criteria_configuration/.sdk-partition b/sdk-output/privilege_criteria_configuration/.sdk-partition new file mode 100644 index 00000000..a1133f6a --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/.sdk-partition @@ -0,0 +1 @@ +privilege-criteria-configuration \ No newline at end of file diff --git a/sdk-output/privilege_criteria_configuration/README.md b/sdk-output/privilege_criteria_configuration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/privilege_criteria_configuration/api.ts b/sdk-output/privilege_criteria_configuration/api.ts new file mode 100644 index 00000000..f07b16a9 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/api.ts @@ -0,0 +1,466 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria Configuration + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPrivilegeCriteriaConfigV1401ResponseV1 + */ +export interface GetPrivilegeCriteriaConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPrivilegeCriteriaConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPrivilegeCriteriaConfigV1429ResponseV1 + */ +export interface GetPrivilegeCriteriaConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPrivilegeCriteriaConfigV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PrivilegecriteriaconfigdtoV1 + */ +export interface PrivilegecriteriaconfigdtoV1 { + /** + * The Id of the task which is executing the bulk update. + * @type {string} + * @memberof PrivilegecriteriaconfigdtoV1 + */ + 'id'?: string; + /** + * The Id of the source that the criteria configuration is applied to. + * @type {string} + * @memberof PrivilegecriteriaconfigdtoV1 + */ + 'sourceId'?: string; + /** + * The configuration settings for privilege criteria evaluation. + * @type {object} + * @memberof PrivilegecriteriaconfigdtoV1 + */ + 'config'?: object; + /** + * The date and time when the privilege criteria configuration was created. + * @type {string} + * @memberof PrivilegecriteriaconfigdtoV1 + */ + 'created'?: string; + /** + * The date and time when the privilege criteria configuration was last modified. + * @type {string} + * @memberof PrivilegecriteriaconfigdtoV1 + */ + 'modified'?: string; +} + +/** + * PrivilegeCriteriaConfigurationV1Api - axios parameter creator + * @export + */ +export const PrivilegeCriteriaConfigurationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to get the privilege criteria configuration by Id. + * @summary Get privilege criteria config + * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPrivilegeCriteriaConfigV1: async (criteriaConfigId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'criteriaConfigId' is not null or undefined + assertParamExists('getPrivilegeCriteriaConfigV1', 'criteriaConfigId', criteriaConfigId) + const localVarPath = `/criteria-config/v1/privilege/{criteriaConfigId}` + .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); + // 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, + }; + }, + /** + * Use this API to list the privilege criteria configuration. + * @summary List privilege criteria config + * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegeCriteriaConfigV1: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'filters' is not null or undefined + assertParamExists('listPrivilegeCriteriaConfigV1', 'filters', filters) + const localVarPath = `/criteria-config/v1/privilege`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update the privilege criteria configuration. + * @summary Update privilege criteria configuration + * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. + * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPrivilegeCriteriaConfigV1: async (criteriaConfigId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'criteriaConfigId' is not null or undefined + assertParamExists('patchPrivilegeCriteriaConfigV1', 'criteriaConfigId', criteriaConfigId) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('patchPrivilegeCriteriaConfigV1', 'requestBody', requestBody) + const localVarPath = `/criteria-config/v1/privilege/{criteriaConfigId}` + .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); + // 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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PrivilegeCriteriaConfigurationV1Api - functional programming interface + * @export + */ +export const PrivilegeCriteriaConfigurationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PrivilegeCriteriaConfigurationV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to get the privilege criteria configuration by Id. + * @summary Get privilege criteria config + * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPrivilegeCriteriaConfigV1(criteriaConfigId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteriaConfigV1(criteriaConfigId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV1Api.getPrivilegeCriteriaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list the privilege criteria configuration. + * @summary List privilege criteria config + * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPrivilegeCriteriaConfigV1(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteriaConfigV1(filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV1Api.listPrivilegeCriteriaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update the privilege criteria configuration. + * @summary Update privilege criteria configuration + * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. + * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchPrivilegeCriteriaConfigV1(criteriaConfigId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchPrivilegeCriteriaConfigV1(criteriaConfigId, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV1Api.patchPrivilegeCriteriaConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PrivilegeCriteriaConfigurationV1Api - factory interface + * @export + */ +export const PrivilegeCriteriaConfigurationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PrivilegeCriteriaConfigurationV1ApiFp(configuration) + return { + /** + * Use this API to get the privilege criteria configuration by Id. + * @summary Get privilege criteria config + * @param {PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPrivilegeCriteriaConfigV1(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list the privilege criteria configuration. + * @summary List privilege criteria config + * @param {PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPrivilegeCriteriaConfigV1(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update the privilege criteria configuration. + * @summary Update privilege criteria configuration + * @param {PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchPrivilegeCriteriaConfigV1(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getPrivilegeCriteriaConfigV1 operation in PrivilegeCriteriaConfigurationV1Api. + * @export + * @interface PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request + */ +export interface PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request { + /** + * The Id of the privilege criteria configuration record to retrieve. + * @type {string} + * @memberof PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1 + */ + readonly criteriaConfigId: string +} + +/** + * Request parameters for listPrivilegeCriteriaConfigV1 operation in PrivilegeCriteriaConfigurationV1Api. + * @export + * @interface PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request + */ +export interface PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request { + /** + * 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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` + * @type {string} + * @memberof PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1 + */ + readonly filters: string +} + +/** + * Request parameters for patchPrivilegeCriteriaConfigV1 operation in PrivilegeCriteriaConfigurationV1Api. + * @export + * @interface PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request + */ +export interface PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request { + /** + * The Id of the privilege criteria configuration to update. + * @type {string} + * @memberof PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1 + */ + readonly criteriaConfigId: string + + /** + * A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + * @type {Array} + * @memberof PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1 + */ + readonly requestBody: Array +} + +/** + * PrivilegeCriteriaConfigurationV1Api - object-oriented interface + * @export + * @class PrivilegeCriteriaConfigurationV1Api + * @extends {BaseAPI} + */ +export class PrivilegeCriteriaConfigurationV1Api extends BaseAPI { + /** + * Use this API to get the privilege criteria configuration by Id. + * @summary Get privilege criteria config + * @param {PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaConfigurationV1Api + */ + public getPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiGetPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaConfigurationV1ApiFp(this.configuration).getPrivilegeCriteriaConfigV1(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list the privilege criteria configuration. + * @summary List privilege criteria config + * @param {PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaConfigurationV1Api + */ + public listPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiListPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaConfigurationV1ApiFp(this.configuration).listPrivilegeCriteriaConfigV1(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update the privilege criteria configuration. + * @summary Update privilege criteria configuration + * @param {PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PrivilegeCriteriaConfigurationV1Api + */ + public patchPrivilegeCriteriaConfigV1(requestParameters: PrivilegeCriteriaConfigurationV1ApiPatchPrivilegeCriteriaConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PrivilegeCriteriaConfigurationV1ApiFp(this.configuration).patchPrivilegeCriteriaConfigV1(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/privilege_criteria_configuration/base.ts b/sdk-output/privilege_criteria_configuration/base.ts new file mode 100644 index 00000000..428b0bd0 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria Configuration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/privilege_criteria_configuration/common.ts b/sdk-output/privilege_criteria_configuration/common.ts new file mode 100644 index 00000000..3f7d24b5 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria Configuration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/privilege_criteria_configuration/configuration.ts b/sdk-output/privilege_criteria_configuration/configuration.ts new file mode 100644 index 00000000..b9fe0850 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria Configuration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/privilege_criteria_configuration/git_push.sh b/sdk-output/privilege_criteria_configuration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/privilege_criteria_configuration/index.ts b/sdk-output/privilege_criteria_configuration/index.ts new file mode 100644 index 00000000..037fbea2 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Privilege Criteria Configuration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/privilege_criteria_configuration/package.json b/sdk-output/privilege_criteria_configuration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/privilege_criteria_configuration/tsconfig.json b/sdk-output/privilege_criteria_configuration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/prompt_insights/.gitignore b/sdk-output/prompt_insights/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/prompt_insights/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/prompt_insights/.npmignore b/sdk-output/prompt_insights/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/prompt_insights/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/prompt_insights/.openapi-generator-ignore b/sdk-output/prompt_insights/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/prompt_insights/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/prompt_insights/.openapi-generator/FILES b/sdk-output/prompt_insights/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/prompt_insights/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/prompt_insights/.openapi-generator/VERSION b/sdk-output/prompt_insights/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/prompt_insights/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/prompt_insights/.sdk-partition b/sdk-output/prompt_insights/.sdk-partition new file mode 100644 index 00000000..64aa3c3d --- /dev/null +++ b/sdk-output/prompt_insights/.sdk-partition @@ -0,0 +1 @@ +prompt-insights \ No newline at end of file diff --git a/sdk-output/prompt_insights/README.md b/sdk-output/prompt_insights/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/prompt_insights/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/prompt_insights/api.ts b/sdk-output/prompt_insights/api.ts new file mode 100644 index 00000000..3a43558b --- /dev/null +++ b/sdk-output/prompt_insights/api.ts @@ -0,0 +1,497 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Prompt Insights + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPromptInsightsMetricsV1401ResponseV1 + */ +export interface GetPromptInsightsMetricsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPromptInsightsMetricsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPromptInsightsMetricsV1429ResponseV1 + */ +export interface GetPromptInsightsMetricsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPromptInsightsMetricsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * A prompt security insight event. + * @export + * @interface PromptinsightV1 + */ +export interface PromptinsightV1 { + /** + * Event time in UTC. + * @type {string} + * @memberof PromptinsightV1 + */ + 'timestamp'?: string; + /** + * User identifier or display name. + * @type {string} + * @memberof PromptinsightV1 + */ + 'user'?: string; + /** + * The AI agent that processed the prompt. + * @type {string} + * @memberof PromptinsightV1 + */ + 'agent'?: string; + /** + * The policy decision applied to the prompt. + * @type {string} + * @memberof PromptinsightV1 + */ + 'policyDecision'?: PromptinsightV1PolicyDecisionV1; + /** + * The category of the prompt security finding. + * @type {string} + * @memberof PromptinsightV1 + */ + 'category'?: PromptinsightV1CategoryV1; + /** + * The severity of the prompt security finding. + * @type {string} + * @memberof PromptinsightV1 + */ + 'severity'?: PromptinsightV1SeverityV1; + /** + * Human-readable or structured reason for the policy decision. + * @type {string} + * @memberof PromptinsightV1 + */ + 'reason'?: string; + /** + * The rule that matched the prompt. + * @type {string} + * @memberof PromptinsightV1 + */ + 'rule'?: string; + /** + * The policy that matched the prompt. + * @type {string} + * @memberof PromptinsightV1 + */ + 'policy'?: string; +} + +export const PromptinsightV1PolicyDecisionV1 = { + Allowed: 'ALLOWED', + Redacted: 'REDACTED' +} as const; + +export type PromptinsightV1PolicyDecisionV1 = typeof PromptinsightV1PolicyDecisionV1[keyof typeof PromptinsightV1PolicyDecisionV1]; +export const PromptinsightV1CategoryV1 = { + Anomalies: 'ANOMALIES', + DataUploads: 'DATA_UPLOADS', + McpToolCalls: 'MCP_TOOL_CALLS' +} as const; + +export type PromptinsightV1CategoryV1 = typeof PromptinsightV1CategoryV1[keyof typeof PromptinsightV1CategoryV1]; +export const PromptinsightV1SeverityV1 = { + Low: 'LOW', + Medium: 'MEDIUM', + High: 'HIGH', + Critical: 'CRITICAL' +} as const; + +export type PromptinsightV1SeverityV1 = typeof PromptinsightV1SeverityV1[keyof typeof PromptinsightV1SeverityV1]; + +/** + * Aggregate prompt insights metrics for the requested time window. + * @export + * @interface PromptinsightsmetricsV1 + */ +export interface PromptinsightsmetricsV1 { + /** + * Count of prompts scanned in the interval. + * @type {number} + * @memberof PromptinsightsmetricsV1 + */ + 'promptsScanned'?: number; + /** + * Count of prompts redacted in the interval. + * @type {number} + * @memberof PromptinsightsmetricsV1 + */ + 'promptsRedacted'?: number; +} + +/** + * PromptInsightsV1Api - axios parameter creator + * @export + */ +export const PromptInsightsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Returns aggregate prompt insights metrics for the requested time window. + * @summary Get prompt insights metrics + * @param {GetPromptInsightsMetricsV1IntervalV1} interval Relative lookback window for metrics aggregation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPromptInsightsMetricsV1: async (interval: GetPromptInsightsMetricsV1IntervalV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'interval' is not null or undefined + assertParamExists('getPromptInsightsMetricsV1', 'interval', interval) + const localVarPath = `/prompt-insights/v1/metrics`; + // 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 (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). + * @summary List prompt insights + * @param {ListPromptInsightsV1IntervalV1} interval Relative lookback window for prompt insights. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPromptInsightsV1: async (interval: ListPromptInsightsV1IntervalV1, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'interval' is not null or undefined + assertParamExists('listPromptInsightsV1', 'interval', interval) + const localVarPath = `/prompt-insights/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 (interval !== undefined) { + localVarQueryParameter['interval'] = interval; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + } +}; + +/** + * PromptInsightsV1Api - functional programming interface + * @export + */ +export const PromptInsightsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PromptInsightsV1ApiAxiosParamCreator(configuration) + return { + /** + * Returns aggregate prompt insights metrics for the requested time window. + * @summary Get prompt insights metrics + * @param {GetPromptInsightsMetricsV1IntervalV1} interval Relative lookback window for metrics aggregation. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPromptInsightsMetricsV1(interval: GetPromptInsightsMetricsV1IntervalV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPromptInsightsMetricsV1(interval, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PromptInsightsV1Api.getPromptInsightsMetricsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). + * @summary List prompt insights + * @param {ListPromptInsightsV1IntervalV1} interval Relative lookback window for prompt insights. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPromptInsightsV1(interval: ListPromptInsightsV1IntervalV1, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPromptInsightsV1(interval, limit, offset, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PromptInsightsV1Api.listPromptInsightsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PromptInsightsV1Api - factory interface + * @export + */ +export const PromptInsightsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PromptInsightsV1ApiFp(configuration) + return { + /** + * Returns aggregate prompt insights metrics for the requested time window. + * @summary Get prompt insights metrics + * @param {PromptInsightsV1ApiGetPromptInsightsMetricsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPromptInsightsMetricsV1(requestParameters: PromptInsightsV1ApiGetPromptInsightsMetricsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPromptInsightsMetricsV1(requestParameters.interval, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). + * @summary List prompt insights + * @param {PromptInsightsV1ApiListPromptInsightsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPromptInsightsV1(requestParameters: PromptInsightsV1ApiListPromptInsightsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPromptInsightsV1(requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getPromptInsightsMetricsV1 operation in PromptInsightsV1Api. + * @export + * @interface PromptInsightsV1ApiGetPromptInsightsMetricsV1Request + */ +export interface PromptInsightsV1ApiGetPromptInsightsMetricsV1Request { + /** + * Relative lookback window for metrics aggregation. + * @type {'-1h' | '-1d' | '-7d' | '-30d'} + * @memberof PromptInsightsV1ApiGetPromptInsightsMetricsV1 + */ + readonly interval: GetPromptInsightsMetricsV1IntervalV1 +} + +/** + * Request parameters for listPromptInsightsV1 operation in PromptInsightsV1Api. + * @export + * @interface PromptInsightsV1ApiListPromptInsightsV1Request + */ +export interface PromptInsightsV1ApiListPromptInsightsV1Request { + /** + * Relative lookback window for prompt insights. + * @type {'-1h' | '-1d' | '-7d' | '-30d'} + * @memberof PromptInsightsV1ApiListPromptInsightsV1 + */ + readonly interval: ListPromptInsightsV1IntervalV1 + + /** + * 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 PromptInsightsV1ApiListPromptInsightsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof PromptInsightsV1ApiListPromptInsightsV1 + */ + readonly offset?: number + + /** + * 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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* + * @type {string} + * @memberof PromptInsightsV1ApiListPromptInsightsV1 + */ + readonly filters?: string +} + +/** + * PromptInsightsV1Api - object-oriented interface + * @export + * @class PromptInsightsV1Api + * @extends {BaseAPI} + */ +export class PromptInsightsV1Api extends BaseAPI { + /** + * Returns aggregate prompt insights metrics for the requested time window. + * @summary Get prompt insights metrics + * @param {PromptInsightsV1ApiGetPromptInsightsMetricsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PromptInsightsV1Api + */ + public getPromptInsightsMetricsV1(requestParameters: PromptInsightsV1ApiGetPromptInsightsMetricsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PromptInsightsV1ApiFp(this.configuration).getPromptInsightsMetricsV1(requestParameters.interval, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). + * @summary List prompt insights + * @param {PromptInsightsV1ApiListPromptInsightsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PromptInsightsV1Api + */ + public listPromptInsightsV1(requestParameters: PromptInsightsV1ApiListPromptInsightsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PromptInsightsV1ApiFp(this.configuration).listPromptInsightsV1(requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetPromptInsightsMetricsV1IntervalV1 = { + _1h: '-1h', + _1d: '-1d', + _7d: '-7d', + _30d: '-30d' +} as const; +export type GetPromptInsightsMetricsV1IntervalV1 = typeof GetPromptInsightsMetricsV1IntervalV1[keyof typeof GetPromptInsightsMetricsV1IntervalV1]; +/** + * @export + */ +export const ListPromptInsightsV1IntervalV1 = { + _1h: '-1h', + _1d: '-1d', + _7d: '-7d', + _30d: '-30d' +} as const; +export type ListPromptInsightsV1IntervalV1 = typeof ListPromptInsightsV1IntervalV1[keyof typeof ListPromptInsightsV1IntervalV1]; + + diff --git a/sdk-output/prompt_insights/base.ts b/sdk-output/prompt_insights/base.ts new file mode 100644 index 00000000..4abc1248 --- /dev/null +++ b/sdk-output/prompt_insights/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Prompt Insights + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/prompt_insights/common.ts b/sdk-output/prompt_insights/common.ts new file mode 100644 index 00000000..263843fe --- /dev/null +++ b/sdk-output/prompt_insights/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Prompt Insights + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/prompt_insights/configuration.ts b/sdk-output/prompt_insights/configuration.ts new file mode 100644 index 00000000..877b61d3 --- /dev/null +++ b/sdk-output/prompt_insights/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Prompt Insights + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/prompt_insights/git_push.sh b/sdk-output/prompt_insights/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/prompt_insights/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/prompt_insights/index.ts b/sdk-output/prompt_insights/index.ts new file mode 100644 index 00000000..5ba473ba --- /dev/null +++ b/sdk-output/prompt_insights/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Prompt Insights + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/prompt_insights/package.json b/sdk-output/prompt_insights/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/prompt_insights/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/prompt_insights/tsconfig.json b/sdk-output/prompt_insights/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/prompt_insights/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/public_identities/.gitignore b/sdk-output/public_identities/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/public_identities/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/public_identities/.npmignore b/sdk-output/public_identities/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/public_identities/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/public_identities/.openapi-generator-ignore b/sdk-output/public_identities/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/public_identities/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/public_identities/.openapi-generator/FILES b/sdk-output/public_identities/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/public_identities/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/public_identities/.openapi-generator/VERSION b/sdk-output/public_identities/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/public_identities/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/public_identities/.sdk-partition b/sdk-output/public_identities/.sdk-partition new file mode 100644 index 00000000..1f98b513 --- /dev/null +++ b/sdk-output/public_identities/.sdk-partition @@ -0,0 +1 @@ +public-identities \ No newline at end of file diff --git a/sdk-output/public_identities/README.md b/sdk-output/public_identities/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/public_identities/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/public_identities/api.ts b/sdk-output/public_identities/api.ts new file mode 100644 index 00000000..45782429 --- /dev/null +++ b/sdk-output/public_identities/api.ts @@ -0,0 +1,469 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities + * 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'; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPublicIdentitiesV1401ResponseV1 + */ +export interface GetPublicIdentitiesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPublicIdentitiesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPublicIdentitiesV1429ResponseV1 + */ +export interface GetPublicIdentitiesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPublicIdentitiesV1429ResponseV1 + */ + 'message'?: any; +} +/** + * The manager for the identity. + * @export + * @interface IdentityreferenceV1 + */ +export interface IdentityreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof IdentityreferenceV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'name'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface PublicidentityAttributesInnerV1 + */ +export interface PublicidentityAttributesInnerV1 { + /** + * The attribute key + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'key'?: string; + /** + * Human-readable display name of the attribute + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'name'?: string; + /** + * The attribute value + * @type {string} + * @memberof PublicidentityAttributesInnerV1 + */ + 'value'?: string | null; +} +/** + * Details about a public identity + * @export + * @interface PublicidentityV1 + */ +export interface PublicidentityV1 { + /** + * Identity id + * @type {string} + * @memberof PublicidentityV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'name'?: string; + /** + * Alternate unique identifier for the identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'alias'?: string; + /** + * Email address of identity. + * @type {string} + * @memberof PublicidentityV1 + */ + 'email'?: string | null; + /** + * The lifecycle status for the identity + * @type {string} + * @memberof PublicidentityV1 + */ + 'status'?: string | null; + /** + * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. + * @type {string} + * @memberof PublicidentityV1 + */ + 'identityState'?: PublicidentityV1IdentityStateV1 | null; + /** + * + * @type {IdentityreferenceV1} + * @memberof PublicidentityV1 + */ + 'manager'?: IdentityreferenceV1 | null; + /** + * The public identity attributes of the identity + * @type {Array} + * @memberof PublicidentityV1 + */ + 'attributes'?: Array; +} + +export const PublicidentityV1IdentityStateV1 = { + Active: 'ACTIVE', + InactiveShortTerm: 'INACTIVE_SHORT_TERM', + InactiveLongTerm: 'INACTIVE_LONG_TERM' +} as const; + +export type PublicidentityV1IdentityStateV1 = typeof PublicidentityV1IdentityStateV1[keyof typeof PublicidentityV1IdentityStateV1]; + + +/** + * PublicIdentitiesV1Api - axios parameter creator + * @export + */ +export const PublicIdentitiesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + * @summary Get list of public identities + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPublicIdentitiesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/public-identities/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (addCoreFilters !== undefined) { + localVarQueryParameter['add-core-filters'] = addCoreFilters; + } + + 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, + }; + }, + } +}; + +/** + * PublicIdentitiesV1Api - functional programming interface + * @export + */ +export const PublicIdentitiesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PublicIdentitiesV1ApiAxiosParamCreator(configuration) + return { + /** + * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + * @summary Get list of public identities + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPublicIdentitiesV1(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentitiesV1(limit, offset, count, filters, addCoreFilters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesV1Api.getPublicIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PublicIdentitiesV1Api - factory interface + * @export + */ +export const PublicIdentitiesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PublicIdentitiesV1ApiFp(configuration) + return { + /** + * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + * @summary Get list of public identities + * @param {PublicIdentitiesV1ApiGetPublicIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPublicIdentitiesV1(requestParameters: PublicIdentitiesV1ApiGetPublicIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getPublicIdentitiesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getPublicIdentitiesV1 operation in PublicIdentitiesV1Api. + * @export + * @interface PublicIdentitiesV1ApiGetPublicIdentitiesV1Request + */ +export interface PublicIdentitiesV1ApiGetPublicIdentitiesV1Request { + /** + * 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 PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + 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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + * @type {string} + * @memberof PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + readonly filters?: string + + /** + * If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. + * @type {boolean} + * @memberof PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + readonly addCoreFilters?: boolean + + /** + * 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: **name** + * @type {string} + * @memberof PublicIdentitiesV1ApiGetPublicIdentitiesV1 + */ + readonly sorters?: string +} + +/** + * PublicIdentitiesV1Api - object-oriented interface + * @export + * @class PublicIdentitiesV1Api + * @extends {BaseAPI} + */ +export class PublicIdentitiesV1Api extends BaseAPI { + /** + * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + * @summary Get list of public identities + * @param {PublicIdentitiesV1ApiGetPublicIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PublicIdentitiesV1Api + */ + public getPublicIdentitiesV1(requestParameters: PublicIdentitiesV1ApiGetPublicIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return PublicIdentitiesV1ApiFp(this.configuration).getPublicIdentitiesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/public_identities/base.ts b/sdk-output/public_identities/base.ts new file mode 100644 index 00000000..ed5cd468 --- /dev/null +++ b/sdk-output/public_identities/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/public_identities/common.ts b/sdk-output/public_identities/common.ts new file mode 100644 index 00000000..d319a47c --- /dev/null +++ b/sdk-output/public_identities/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/public_identities/configuration.ts b/sdk-output/public_identities/configuration.ts new file mode 100644 index 00000000..80fb2497 --- /dev/null +++ b/sdk-output/public_identities/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/public_identities/git_push.sh b/sdk-output/public_identities/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/public_identities/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/public_identities/index.ts b/sdk-output/public_identities/index.ts new file mode 100644 index 00000000..fa8aabe6 --- /dev/null +++ b/sdk-output/public_identities/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/public_identities/package.json b/sdk-output/public_identities/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/public_identities/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/public_identities/tsconfig.json b/sdk-output/public_identities/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/public_identities/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/public_identities_config/.gitignore b/sdk-output/public_identities_config/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/public_identities_config/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/public_identities_config/.npmignore b/sdk-output/public_identities_config/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/public_identities_config/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/public_identities_config/.openapi-generator-ignore b/sdk-output/public_identities_config/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/public_identities_config/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/public_identities_config/.openapi-generator/FILES b/sdk-output/public_identities_config/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/public_identities_config/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/public_identities_config/.openapi-generator/VERSION b/sdk-output/public_identities_config/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/public_identities_config/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/public_identities_config/.sdk-partition b/sdk-output/public_identities_config/.sdk-partition new file mode 100644 index 00000000..b5de5047 --- /dev/null +++ b/sdk-output/public_identities_config/.sdk-partition @@ -0,0 +1 @@ +public-identities-config \ No newline at end of file diff --git a/sdk-output/public_identities_config/README.md b/sdk-output/public_identities_config/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/public_identities_config/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/public_identities_config/api.ts b/sdk-output/public_identities_config/api.ts new file mode 100644 index 00000000..d9db3fb9 --- /dev/null +++ b/sdk-output/public_identities_config/api.ts @@ -0,0 +1,422 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetPublicIdentityConfigV1401ResponseV1 + */ +export interface GetPublicIdentityConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPublicIdentityConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetPublicIdentityConfigV1429ResponseV1 + */ +export interface GetPublicIdentityConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetPublicIdentityConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * The manager for the identity. + * @export + * @interface IdentityreferenceV1 + */ +export interface IdentityreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof IdentityreferenceV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof IdentityreferenceV1 + */ + 'name'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Used to map an attribute key for an Identity to its display name. + * @export + * @interface PublicidentityattributeconfigV1 + */ +export interface PublicidentityattributeconfigV1 { + /** + * The attribute key + * @type {string} + * @memberof PublicidentityattributeconfigV1 + */ + 'key'?: string; + /** + * The attribute display name + * @type {string} + * @memberof PublicidentityattributeconfigV1 + */ + 'name'?: string; +} +/** + * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. + * @export + * @interface PublicidentityconfigV1 + */ +export interface PublicidentityconfigV1 { + /** + * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. + * @type {Array} + * @memberof PublicidentityconfigV1 + */ + 'attributes'?: Array; + /** + * When this configuration was last modified. + * @type {string} + * @memberof PublicidentityconfigV1 + */ + 'modified'?: string | null; + /** + * + * @type {IdentityreferenceV1} + * @memberof PublicidentityconfigV1 + */ + 'modifiedBy'?: IdentityreferenceV1 | null; +} + +/** + * PublicIdentitiesConfigV1Api - axios parameter creator + * @export + */ +export const PublicIdentitiesConfigV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Get the public identities configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPublicIdentityConfigV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/public-identities-config/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Update the public identities configuration + * @param {PublicidentityconfigV1} publicidentityconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePublicIdentityConfigV1: async (publicidentityconfigV1: PublicidentityconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'publicidentityconfigV1' is not null or undefined + assertParamExists('updatePublicIdentityConfigV1', 'publicidentityconfigV1', publicidentityconfigV1) + const localVarPath = `/public-identities-config/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: 'PUT', ...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(publicidentityconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * PublicIdentitiesConfigV1Api - functional programming interface + * @export + */ +export const PublicIdentitiesConfigV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PublicIdentitiesConfigV1ApiAxiosParamCreator(configuration) + return { + /** + * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Get the public identities configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfigV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV1Api.getPublicIdentityConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Update the public identities configuration + * @param {PublicidentityconfigV1} publicidentityconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updatePublicIdentityConfigV1(publicidentityconfigV1: PublicidentityconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfigV1(publicidentityconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV1Api.updatePublicIdentityConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PublicIdentitiesConfigV1Api - factory interface + * @export + */ +export const PublicIdentitiesConfigV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PublicIdentitiesConfigV1ApiFp(configuration) + return { + /** + * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Get the public identities configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getPublicIdentityConfigV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Update the public identities configuration + * @param {PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePublicIdentityConfigV1(requestParameters: PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updatePublicIdentityConfigV1(requestParameters.publicidentityconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for updatePublicIdentityConfigV1 operation in PublicIdentitiesConfigV1Api. + * @export + * @interface PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request + */ +export interface PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request { + /** + * + * @type {PublicidentityconfigV1} + * @memberof PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1 + */ + readonly publicidentityconfigV1: PublicidentityconfigV1 +} + +/** + * PublicIdentitiesConfigV1Api - object-oriented interface + * @export + * @class PublicIdentitiesConfigV1Api + * @extends {BaseAPI} + */ +export class PublicIdentitiesConfigV1Api extends BaseAPI { + /** + * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Get the public identities configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PublicIdentitiesConfigV1Api + */ + public getPublicIdentityConfigV1(axiosOptions?: RawAxiosRequestConfig) { + return PublicIdentitiesConfigV1ApiFp(this.configuration).getPublicIdentityConfigV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + * @summary Update the public identities configuration + * @param {PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof PublicIdentitiesConfigV1Api + */ + public updatePublicIdentityConfigV1(requestParameters: PublicIdentitiesConfigV1ApiUpdatePublicIdentityConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return PublicIdentitiesConfigV1ApiFp(this.configuration).updatePublicIdentityConfigV1(requestParameters.publicidentityconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/public_identities_config/base.ts b/sdk-output/public_identities_config/base.ts new file mode 100644 index 00000000..c44c8f55 --- /dev/null +++ b/sdk-output/public_identities_config/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/public_identities_config/common.ts b/sdk-output/public_identities_config/common.ts new file mode 100644 index 00000000..e9453179 --- /dev/null +++ b/sdk-output/public_identities_config/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/public_identities_config/configuration.ts b/sdk-output/public_identities_config/configuration.ts new file mode 100644 index 00000000..8edc9335 --- /dev/null +++ b/sdk-output/public_identities_config/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/public_identities_config/git_push.sh b/sdk-output/public_identities_config/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/public_identities_config/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/public_identities_config/index.ts b/sdk-output/public_identities_config/index.ts new file mode 100644 index 00000000..3fdafc62 --- /dev/null +++ b/sdk-output/public_identities_config/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Public Identities Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/public_identities_config/package.json b/sdk-output/public_identities_config/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/public_identities_config/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/public_identities_config/tsconfig.json b/sdk-output/public_identities_config/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/public_identities_config/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/reports_data_extraction/.gitignore b/sdk-output/reports_data_extraction/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/reports_data_extraction/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/reports_data_extraction/.npmignore b/sdk-output/reports_data_extraction/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/reports_data_extraction/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/reports_data_extraction/.openapi-generator-ignore b/sdk-output/reports_data_extraction/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/reports_data_extraction/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/reports_data_extraction/.openapi-generator/FILES b/sdk-output/reports_data_extraction/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/reports_data_extraction/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/reports_data_extraction/.openapi-generator/VERSION b/sdk-output/reports_data_extraction/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/reports_data_extraction/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/reports_data_extraction/.sdk-partition b/sdk-output/reports_data_extraction/.sdk-partition new file mode 100644 index 00000000..68e71344 --- /dev/null +++ b/sdk-output/reports_data_extraction/.sdk-partition @@ -0,0 +1 @@ +reports-data-extraction \ No newline at end of file diff --git a/sdk-output/reports_data_extraction/README.md b/sdk-output/reports_data_extraction/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/reports_data_extraction/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/reports_data_extraction/api.ts b/sdk-output/reports_data_extraction/api.ts new file mode 100644 index 00000000..016ef147 --- /dev/null +++ b/sdk-output/reports_data_extraction/api.ts @@ -0,0 +1,1078 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Reports Data Extraction + * 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'; + +/** + * Arguments for Account Export report (ACCOUNTS) + * @export + * @interface AccountsExportReportArgumentsV1 + */ +export interface AccountsExportReportArgumentsV1 { + /** + * Source ID. + * @type {string} + * @memberof AccountsExportReportArgumentsV1 + */ + 'application': string; + /** + * Source name. + * @type {string} + * @memberof AccountsExportReportArgumentsV1 + */ + 'sourceName': string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetReportResultV1401ResponseV1 + */ +export interface GetReportResultV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetReportResultV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetReportResultV1429ResponseV1 + */ +export interface GetReportResultV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetReportResultV1429ResponseV1 + */ + 'message'?: any; +} +/** + * Arguments for Identities Details report (IDENTITIES_DETAILS) + * @export + * @interface IdentitiesDetailsReportArgumentsV1 + */ +export interface IdentitiesDetailsReportArgumentsV1 { + /** + * Flag to specify if only correlated identities are included in report. + * @type {boolean} + * @memberof IdentitiesDetailsReportArgumentsV1 + */ + 'correlatedOnly': boolean; +} +/** + * Arguments for Identities report (IDENTITIES) + * @export + * @interface IdentitiesReportArgumentsV1 + */ +export interface IdentitiesReportArgumentsV1 { + /** + * Flag to specify if only correlated identities are included in report. + * @type {boolean} + * @memberof IdentitiesReportArgumentsV1 + */ + 'correlatedOnly'?: boolean; +} +/** + * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) + * @export + * @interface IdentityProfileIdentityErrorReportArgumentsV1 + */ +export interface IdentityProfileIdentityErrorReportArgumentsV1 { + /** + * Source ID. + * @type {string} + * @memberof IdentityProfileIdentityErrorReportArgumentsV1 + */ + 'authoritativeSource': string; +} +/** + * Enum representing the currently supported indices. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const IndexV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Events: 'events', + Identities: 'identities', + Roles: 'roles', + Star: '*' +} as const; + +export type IndexV1 = typeof IndexV1[keyof typeof IndexV1]; + + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) + * @export + * @interface OrphanIdentitiesReportArgumentsV1 + */ +export interface OrphanIdentitiesReportArgumentsV1 { + /** + * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. + * @type {Array} + * @memberof OrphanIdentitiesReportArgumentsV1 + */ + 'selectedFormats'?: Array; +} + +export const OrphanIdentitiesReportArgumentsV1SelectedFormatsV1 = { + Csv: 'CSV', + Pdf: 'PDF' +} as const; + +export type OrphanIdentitiesReportArgumentsV1SelectedFormatsV1 = typeof OrphanIdentitiesReportArgumentsV1SelectedFormatsV1[keyof typeof OrphanIdentitiesReportArgumentsV1SelectedFormatsV1]; + +/** + * The string-object map(dictionary) with the arguments needed for report processing. + * @export + * @interface ReportdetailsArgumentsV1 + */ +export interface ReportdetailsArgumentsV1 { + /** + * Source ID. + * @type {string} + * @memberof ReportdetailsArgumentsV1 + */ + 'application': string; + /** + * Source name. + * @type {string} + * @memberof ReportdetailsArgumentsV1 + */ + 'sourceName': string; + /** + * Flag to specify if only correlated identities are included in report. + * @type {boolean} + * @memberof ReportdetailsArgumentsV1 + */ + 'correlatedOnly': boolean; + /** + * Source ID. + * @type {string} + * @memberof ReportdetailsArgumentsV1 + */ + 'authoritativeSource': string; + /** + * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. + * @type {Array} + * @memberof ReportdetailsArgumentsV1 + */ + 'selectedFormats'?: Array; + /** + * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. + * @type {Array} + * @memberof ReportdetailsArgumentsV1 + */ + 'indices'?: Array; + /** + * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof ReportdetailsArgumentsV1 + */ + 'query': string; + /** + * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. + * @type {string} + * @memberof ReportdetailsArgumentsV1 + */ + 'columns'?: string; + /** + * The fields to be used to sort the search results. Use + or - to specify the sort direction. + * @type {Array} + * @memberof ReportdetailsArgumentsV1 + */ + 'sort'?: Array; +} + +export const ReportdetailsArgumentsV1SelectedFormatsV1 = { + Csv: 'CSV', + Pdf: 'PDF' +} as const; + +export type ReportdetailsArgumentsV1SelectedFormatsV1 = typeof ReportdetailsArgumentsV1SelectedFormatsV1[keyof typeof ReportdetailsArgumentsV1SelectedFormatsV1]; + +/** + * Details about report to be processed. + * @export + * @interface ReportdetailsV1 + */ +export interface ReportdetailsV1 { + /** + * Use this property to define what report should be processed in the RDE service. + * @type {string} + * @memberof ReportdetailsV1 + */ + 'reportType'?: ReportdetailsV1ReportTypeV1; + /** + * + * @type {ReportdetailsArgumentsV1} + * @memberof ReportdetailsV1 + */ + 'arguments'?: ReportdetailsArgumentsV1; +} + +export const ReportdetailsV1ReportTypeV1 = { + Accounts: 'ACCOUNTS', + IdentitiesDetails: 'IDENTITIES_DETAILS', + Identities: 'IDENTITIES', + IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', + OrphanIdentities: 'ORPHAN_IDENTITIES', + SearchExport: 'SEARCH_EXPORT', + UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' +} as const; + +export type ReportdetailsV1ReportTypeV1 = typeof ReportdetailsV1ReportTypeV1[keyof typeof ReportdetailsV1ReportTypeV1]; + +/** + * Details about report result or current state. + * @export + * @interface ReportresultsV1 + */ +export interface ReportresultsV1 { + /** + * Use this property to define what report should be processed in the RDE service. + * @type {string} + * @memberof ReportresultsV1 + */ + 'reportType'?: ReportresultsV1ReportTypeV1; + /** + * Name of the task definition which is started to process requesting report. Usually the same as report name + * @type {string} + * @memberof ReportresultsV1 + */ + 'taskDefName'?: string; + /** + * Unique task definition identifier. + * @type {string} + * @memberof ReportresultsV1 + */ + 'id'?: string; + /** + * Report processing start date + * @type {string} + * @memberof ReportresultsV1 + */ + 'created'?: string; + /** + * Report current state or result status. + * @type {string} + * @memberof ReportresultsV1 + */ + 'status'?: ReportresultsV1StatusV1; + /** + * Report processing time in ms. + * @type {number} + * @memberof ReportresultsV1 + */ + 'duration'?: number; + /** + * Report size in rows. + * @type {number} + * @memberof ReportresultsV1 + */ + 'rows'?: number; + /** + * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. + * @type {Array} + * @memberof ReportresultsV1 + */ + 'availableFormats'?: Array; +} + +export const ReportresultsV1ReportTypeV1 = { + Accounts: 'ACCOUNTS', + IdentitiesDetails: 'IDENTITIES_DETAILS', + Identities: 'IDENTITIES', + IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', + OrphanIdentities: 'ORPHAN_IDENTITIES', + SearchExport: 'SEARCH_EXPORT', + UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' +} as const; + +export type ReportresultsV1ReportTypeV1 = typeof ReportresultsV1ReportTypeV1[keyof typeof ReportresultsV1ReportTypeV1]; +export const ReportresultsV1StatusV1 = { + Success: 'SUCCESS', + Failure: 'FAILURE', + Warning: 'WARNING', + Terminated: 'TERMINATED' +} as const; + +export type ReportresultsV1StatusV1 = typeof ReportresultsV1StatusV1[keyof typeof ReportresultsV1StatusV1]; +export const ReportresultsV1AvailableFormatsV1 = { + Csv: 'CSV', + Pdf: 'PDF' +} as const; + +export type ReportresultsV1AvailableFormatsV1 = typeof ReportresultsV1AvailableFormatsV1[keyof typeof ReportresultsV1AvailableFormatsV1]; + +/** + * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. + * @export + * @interface SearchExportReportArgumentsV1 + */ +export interface SearchExportReportArgumentsV1 { + /** + * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. + * @type {Array} + * @memberof SearchExportReportArgumentsV1 + */ + 'indices'?: Array; + /** + * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof SearchExportReportArgumentsV1 + */ + 'query': string; + /** + * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. + * @type {string} + * @memberof SearchExportReportArgumentsV1 + */ + 'columns'?: string; + /** + * The fields to be used to sort the search results. Use + or - to specify the sort direction. + * @type {Array} + * @memberof SearchExportReportArgumentsV1 + */ + 'sort'?: Array; +} +/** + * + * @export + * @interface TaskresultdetailsMessagesInnerV1 + */ +export interface TaskresultdetailsMessagesInnerV1 { + /** + * Type of the message. + * @type {string} + * @memberof TaskresultdetailsMessagesInnerV1 + */ + 'type'?: TaskresultdetailsMessagesInnerV1TypeV1; + /** + * Flag whether message is an error. + * @type {boolean} + * @memberof TaskresultdetailsMessagesInnerV1 + */ + 'error'?: boolean; + /** + * Flag whether message is a warning. + * @type {boolean} + * @memberof TaskresultdetailsMessagesInnerV1 + */ + 'warning'?: boolean; + /** + * Message string identifier. + * @type {string} + * @memberof TaskresultdetailsMessagesInnerV1 + */ + 'key'?: string; + /** + * Message context with the locale based language. + * @type {string} + * @memberof TaskresultdetailsMessagesInnerV1 + */ + 'localizedText'?: string; +} + +export const TaskresultdetailsMessagesInnerV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type TaskresultdetailsMessagesInnerV1TypeV1 = typeof TaskresultdetailsMessagesInnerV1TypeV1[keyof typeof TaskresultdetailsMessagesInnerV1TypeV1]; + +/** + * + * @export + * @interface TaskresultdetailsReturnsInnerV1 + */ +export interface TaskresultdetailsReturnsInnerV1 { + /** + * Attribute description. + * @type {string} + * @memberof TaskresultdetailsReturnsInnerV1 + */ + 'displayLabel'?: string; + /** + * System or database attribute name. + * @type {string} + * @memberof TaskresultdetailsReturnsInnerV1 + */ + 'attributeName'?: string; +} +/** + * Details about job or task type, state and lifecycle. + * @export + * @interface TaskresultdetailsV1 + */ +export interface TaskresultdetailsV1 { + /** + * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'type'?: TaskresultdetailsV1TypeV1; + /** + * Unique task definition identifier. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'id'?: string; + /** + * Use this property to define what report should be processed in the RDE service. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'reportType'?: TaskresultdetailsV1ReportTypeV1; + /** + * Description of the report purpose and/or contents. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'description'?: string; + /** + * Name of the parent task/report if exists. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'parentName'?: string | null; + /** + * Name of the report processing initiator. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'launcher'?: string; + /** + * Report creation date + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'created'?: string; + /** + * Report start date + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'launched'?: string | null; + /** + * Report completion date + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'completed'?: string | null; + /** + * Report completion status. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'completionStatus'?: TaskresultdetailsV1CompletionStatusV1 | null; + /** + * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. + * @type {Array} + * @memberof TaskresultdetailsV1 + */ + 'messages'?: Array; + /** + * Task definition results, if necessary. + * @type {Array} + * @memberof TaskresultdetailsV1 + */ + 'returns'?: Array; + /** + * Extra attributes map(dictionary) needed for the report. + * @type {object} + * @memberof TaskresultdetailsV1 + */ + 'attributes'?: object; + /** + * Current report state. + * @type {string} + * @memberof TaskresultdetailsV1 + */ + 'progress'?: string | null; +} + +export const TaskresultdetailsV1TypeV1 = { + Quartz: 'QUARTZ', + Qpoc: 'QPOC', + Mentos: 'MENTOS', + QueuedTask: 'QUEUED_TASK' +} as const; + +export type TaskresultdetailsV1TypeV1 = typeof TaskresultdetailsV1TypeV1[keyof typeof TaskresultdetailsV1TypeV1]; +export const TaskresultdetailsV1ReportTypeV1 = { + Accounts: 'ACCOUNTS', + IdentitiesDetails: 'IDENTITIES_DETAILS', + Identities: 'IDENTITIES', + IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', + OrphanIdentities: 'ORPHAN_IDENTITIES', + SearchExport: 'SEARCH_EXPORT', + UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' +} as const; + +export type TaskresultdetailsV1ReportTypeV1 = typeof TaskresultdetailsV1ReportTypeV1[keyof typeof TaskresultdetailsV1ReportTypeV1]; +export const TaskresultdetailsV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR' +} as const; + +export type TaskresultdetailsV1CompletionStatusV1 = typeof TaskresultdetailsV1CompletionStatusV1[keyof typeof TaskresultdetailsV1CompletionStatusV1]; + +/** + * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) + * @export + * @interface UncorrelatedAccountsReportArgumentsV1 + */ +export interface UncorrelatedAccountsReportArgumentsV1 { + /** + * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. + * @type {Array} + * @memberof UncorrelatedAccountsReportArgumentsV1 + */ + 'selectedFormats'?: Array; +} + +export const UncorrelatedAccountsReportArgumentsV1SelectedFormatsV1 = { + Csv: 'CSV', + Pdf: 'PDF' +} as const; + +export type UncorrelatedAccountsReportArgumentsV1SelectedFormatsV1 = typeof UncorrelatedAccountsReportArgumentsV1SelectedFormatsV1[keyof typeof UncorrelatedAccountsReportArgumentsV1SelectedFormatsV1]; + + +/** + * ReportsDataExtractionV1Api - axios parameter creator + * @export + */ +export const ReportsDataExtractionV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Cancels a running report. + * @summary Cancel report + * @param {string} id ID of the running Report to cancel + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelReportV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cancelReportV1', 'id', id) + const localVarPath = `/reports/v1/{id}/cancel` + .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: 'POST', ...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 the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + * @summary Get report result + * @param {string} taskResultId Unique identifier of the task result which handled report + * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReportResultV1: async (taskResultId: string, completed?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'taskResultId' is not null or undefined + assertParamExists('getReportResultV1', 'taskResultId', taskResultId) + const localVarPath = `/reports/v1/{taskResultId}/result` + .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); + // 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 (completed !== undefined) { + localVarQueryParameter['completed'] = completed; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Gets a report in file format. + * @summary Get report file + * @param {string} taskResultId Unique identifier of the task result which handled report + * @param {GetReportV1FileFormatV1} fileFormat Output format of the requested report file + * @param {string} [name] preferred Report file name, by default will be used report name from task result. + * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReportV1: async (taskResultId: string, fileFormat: GetReportV1FileFormatV1, name?: string, auditable?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'taskResultId' is not null or undefined + assertParamExists('getReportV1', 'taskResultId', taskResultId) + // verify required parameter 'fileFormat' is not null or undefined + assertParamExists('getReportV1', 'fileFormat', fileFormat) + const localVarPath = `/reports/v1/{taskResultId}` + .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); + // 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 (fileFormat !== undefined) { + localVarQueryParameter['fileFormat'] = fileFormat; + } + + if (name !== undefined) { + localVarQueryParameter['name'] = name; + } + + if (auditable !== undefined) { + localVarQueryParameter['auditable'] = auditable; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + * @summary Run report + * @param {ReportdetailsV1} reportdetailsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startReportV1: async (reportdetailsV1: ReportdetailsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'reportdetailsV1' is not null or undefined + assertParamExists('startReportV1', 'reportdetailsV1', reportdetailsV1) + const localVarPath = `/reports/v1/run`; + // 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(reportdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ReportsDataExtractionV1Api - functional programming interface + * @export + */ +export const ReportsDataExtractionV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ReportsDataExtractionV1ApiAxiosParamCreator(configuration) + return { + /** + * Cancels a running report. + * @summary Cancel report + * @param {string} id ID of the running Report to cancel + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelReportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReportV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV1Api.cancelReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + * @summary Get report result + * @param {string} taskResultId Unique identifier of the task result which handled report + * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getReportResultV1(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getReportResultV1(taskResultId, completed, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV1Api.getReportResultV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a report in file format. + * @summary Get report file + * @param {string} taskResultId Unique identifier of the task result which handled report + * @param {GetReportV1FileFormatV1} fileFormat Output format of the requested report file + * @param {string} [name] preferred Report file name, by default will be used report name from task result. + * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getReportV1(taskResultId: string, fileFormat: GetReportV1FileFormatV1, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getReportV1(taskResultId, fileFormat, name, auditable, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV1Api.getReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + * @summary Run report + * @param {ReportdetailsV1} reportdetailsV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startReportV1(reportdetailsV1: ReportdetailsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startReportV1(reportdetailsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV1Api.startReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ReportsDataExtractionV1Api - factory interface + * @export + */ +export const ReportsDataExtractionV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ReportsDataExtractionV1ApiFp(configuration) + return { + /** + * Cancels a running report. + * @summary Cancel report + * @param {ReportsDataExtractionV1ApiCancelReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelReportV1(requestParameters: ReportsDataExtractionV1ApiCancelReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelReportV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + * @summary Get report result + * @param {ReportsDataExtractionV1ApiGetReportResultV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReportResultV1(requestParameters: ReportsDataExtractionV1ApiGetReportResultV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getReportResultV1(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a report in file format. + * @summary Get report file + * @param {ReportsDataExtractionV1ApiGetReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReportV1(requestParameters: ReportsDataExtractionV1ApiGetReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getReportV1(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + * @summary Run report + * @param {ReportsDataExtractionV1ApiStartReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startReportV1(requestParameters: ReportsDataExtractionV1ApiStartReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startReportV1(requestParameters.reportdetailsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for cancelReportV1 operation in ReportsDataExtractionV1Api. + * @export + * @interface ReportsDataExtractionV1ApiCancelReportV1Request + */ +export interface ReportsDataExtractionV1ApiCancelReportV1Request { + /** + * ID of the running Report to cancel + * @type {string} + * @memberof ReportsDataExtractionV1ApiCancelReportV1 + */ + readonly id: string +} + +/** + * Request parameters for getReportResultV1 operation in ReportsDataExtractionV1Api. + * @export + * @interface ReportsDataExtractionV1ApiGetReportResultV1Request + */ +export interface ReportsDataExtractionV1ApiGetReportResultV1Request { + /** + * Unique identifier of the task result which handled report + * @type {string} + * @memberof ReportsDataExtractionV1ApiGetReportResultV1 + */ + readonly taskResultId: string + + /** + * state of task result to apply ordering when results are fetching from the DB + * @type {boolean} + * @memberof ReportsDataExtractionV1ApiGetReportResultV1 + */ + readonly completed?: boolean +} + +/** + * Request parameters for getReportV1 operation in ReportsDataExtractionV1Api. + * @export + * @interface ReportsDataExtractionV1ApiGetReportV1Request + */ +export interface ReportsDataExtractionV1ApiGetReportV1Request { + /** + * Unique identifier of the task result which handled report + * @type {string} + * @memberof ReportsDataExtractionV1ApiGetReportV1 + */ + readonly taskResultId: string + + /** + * Output format of the requested report file + * @type {'csv' | 'pdf'} + * @memberof ReportsDataExtractionV1ApiGetReportV1 + */ + readonly fileFormat: GetReportV1FileFormatV1 + + /** + * preferred Report file name, by default will be used report name from task result. + * @type {string} + * @memberof ReportsDataExtractionV1ApiGetReportV1 + */ + readonly name?: string + + /** + * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + * @type {boolean} + * @memberof ReportsDataExtractionV1ApiGetReportV1 + */ + readonly auditable?: boolean +} + +/** + * Request parameters for startReportV1 operation in ReportsDataExtractionV1Api. + * @export + * @interface ReportsDataExtractionV1ApiStartReportV1Request + */ +export interface ReportsDataExtractionV1ApiStartReportV1Request { + /** + * + * @type {ReportdetailsV1} + * @memberof ReportsDataExtractionV1ApiStartReportV1 + */ + readonly reportdetailsV1: ReportdetailsV1 +} + +/** + * ReportsDataExtractionV1Api - object-oriented interface + * @export + * @class ReportsDataExtractionV1Api + * @extends {BaseAPI} + */ +export class ReportsDataExtractionV1Api extends BaseAPI { + /** + * Cancels a running report. + * @summary Cancel report + * @param {ReportsDataExtractionV1ApiCancelReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ReportsDataExtractionV1Api + */ + public cancelReportV1(requestParameters: ReportsDataExtractionV1ApiCancelReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ReportsDataExtractionV1ApiFp(this.configuration).cancelReportV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + * @summary Get report result + * @param {ReportsDataExtractionV1ApiGetReportResultV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ReportsDataExtractionV1Api + */ + public getReportResultV1(requestParameters: ReportsDataExtractionV1ApiGetReportResultV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ReportsDataExtractionV1ApiFp(this.configuration).getReportResultV1(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a report in file format. + * @summary Get report file + * @param {ReportsDataExtractionV1ApiGetReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ReportsDataExtractionV1Api + */ + public getReportV1(requestParameters: ReportsDataExtractionV1ApiGetReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ReportsDataExtractionV1ApiFp(this.configuration).getReportV1(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + * @summary Run report + * @param {ReportsDataExtractionV1ApiStartReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ReportsDataExtractionV1Api + */ + public startReportV1(requestParameters: ReportsDataExtractionV1ApiStartReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ReportsDataExtractionV1ApiFp(this.configuration).startReportV1(requestParameters.reportdetailsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const GetReportV1FileFormatV1 = { + Csv: 'csv', + Pdf: 'pdf' +} as const; +export type GetReportV1FileFormatV1 = typeof GetReportV1FileFormatV1[keyof typeof GetReportV1FileFormatV1]; + + diff --git a/sdk-output/reports_data_extraction/base.ts b/sdk-output/reports_data_extraction/base.ts new file mode 100644 index 00000000..d92ab983 --- /dev/null +++ b/sdk-output/reports_data_extraction/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Reports Data Extraction + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/reports_data_extraction/common.ts b/sdk-output/reports_data_extraction/common.ts new file mode 100644 index 00000000..12109c11 --- /dev/null +++ b/sdk-output/reports_data_extraction/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Reports Data Extraction + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/reports_data_extraction/configuration.ts b/sdk-output/reports_data_extraction/configuration.ts new file mode 100644 index 00000000..addd9a36 --- /dev/null +++ b/sdk-output/reports_data_extraction/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Reports Data Extraction + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/reports_data_extraction/git_push.sh b/sdk-output/reports_data_extraction/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/reports_data_extraction/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/reports_data_extraction/index.ts b/sdk-output/reports_data_extraction/index.ts new file mode 100644 index 00000000..07626c9f --- /dev/null +++ b/sdk-output/reports_data_extraction/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Reports Data Extraction + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/reports_data_extraction/package.json b/sdk-output/reports_data_extraction/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/reports_data_extraction/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/reports_data_extraction/tsconfig.json b/sdk-output/reports_data_extraction/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/reports_data_extraction/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/requestable_objects/.gitignore b/sdk-output/requestable_objects/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/requestable_objects/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/requestable_objects/.npmignore b/sdk-output/requestable_objects/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/requestable_objects/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/requestable_objects/.openapi-generator-ignore b/sdk-output/requestable_objects/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/requestable_objects/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/requestable_objects/.openapi-generator/FILES b/sdk-output/requestable_objects/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/requestable_objects/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/requestable_objects/.openapi-generator/VERSION b/sdk-output/requestable_objects/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/requestable_objects/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/requestable_objects/.sdk-partition b/sdk-output/requestable_objects/.sdk-partition new file mode 100644 index 00000000..eefb68c2 --- /dev/null +++ b/sdk-output/requestable_objects/.sdk-partition @@ -0,0 +1 @@ +requestable-objects \ No newline at end of file diff --git a/sdk-output/requestable_objects/README.md b/sdk-output/requestable_objects/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/requestable_objects/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/requestable_objects/api.ts b/sdk-output/requestable_objects/api.ts new file mode 100644 index 00000000..b9289db8 --- /dev/null +++ b/sdk-output/requestable_objects/api.ts @@ -0,0 +1,489 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Requestable Objects + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface IdentityreferencewithnameandemailV1 + */ +export interface IdentityreferencewithnameandemailV1 { + /** + * The type can only be IDENTITY. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'type'?: string; + /** + * Identity ID. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'id'?: string; + /** + * Identity\'s human-readable display name. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'name'?: string; + /** + * Identity\'s email address. This is read-only. + * @type {string} + * @memberof IdentityreferencewithnameandemailV1 + */ + 'email'?: string | null; +} +/** + * + * @export + * @interface ListRequestableObjectsV1401ResponseV1 + */ +export interface ListRequestableObjectsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListRequestableObjectsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListRequestableObjectsV1429ResponseV1 + */ +export interface ListRequestableObjectsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListRequestableObjectsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface RequestableobjectV1 + */ +export interface RequestableobjectV1 { + /** + * Id of the requestable object itself + * @type {string} + * @memberof RequestableobjectV1 + */ + 'id'?: string; + /** + * Human-readable display name of the requestable object + * @type {string} + * @memberof RequestableobjectV1 + */ + 'name'?: string; + /** + * The time when the requestable object was created + * @type {string} + * @memberof RequestableobjectV1 + */ + 'created'?: string; + /** + * The time when the requestable object was last modified + * @type {string} + * @memberof RequestableobjectV1 + */ + 'modified'?: string | null; + /** + * Description of the requestable object. + * @type {string} + * @memberof RequestableobjectV1 + */ + 'description'?: string | null; + /** + * + * @type {RequestableobjecttypeV1} + * @memberof RequestableobjectV1 + */ + 'type'?: RequestableobjecttypeV1; + /** + * + * @type {RequestableobjectrequeststatusV1} + * @memberof RequestableobjectV1 + */ + 'requestStatus'?: RequestableobjectrequeststatusV1; + /** + * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. + * @type {string} + * @memberof RequestableobjectV1 + */ + 'identityRequestId'?: string | null; + /** + * + * @type {IdentityreferencewithnameandemailV1} + * @memberof RequestableobjectV1 + */ + 'ownerRef'?: IdentityreferencewithnameandemailV1 | null; + /** + * Whether the requester must provide comments when requesting the object. + * @type {boolean} + * @memberof RequestableobjectV1 + */ + 'requestCommentsRequired'?: boolean; +} + + +/** + * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. + * @export + * @enum {string} + */ + +export const RequestableobjectrequeststatusV1 = { + Available: 'AVAILABLE', + Pending: 'PENDING', + Assigned: 'ASSIGNED' +} as const; + +export type RequestableobjectrequeststatusV1 = typeof RequestableobjectrequeststatusV1[keyof typeof RequestableobjectrequeststatusV1]; + + +/** + * Currently supported requestable object types. + * @export + * @enum {string} + */ + +export const RequestableobjecttypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RequestableobjecttypeV1 = typeof RequestableobjecttypeV1[keyof typeof RequestableobjecttypeV1]; + + + +/** + * RequestableObjectsV1Api - axios parameter creator + * @export + */ +export const RequestableObjectsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. + * @summary Requestable objects list + * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. + * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. + * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listRequestableObjectsV1: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/requestable-objects/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 (identityId !== undefined) { + localVarQueryParameter['identity-id'] = identityId; + } + + if (types) { + localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); + } + + if (term !== undefined) { + localVarQueryParameter['term'] = term; + } + + if (statuses) { + localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + } +}; + +/** + * RequestableObjectsV1Api - functional programming interface + * @export + */ +export const RequestableObjectsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RequestableObjectsV1ApiAxiosParamCreator(configuration) + return { + /** + * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. + * @summary Requestable objects list + * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. + * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. + * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* + * @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: **name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listRequestableObjectsV1(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjectsV1(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RequestableObjectsV1Api.listRequestableObjectsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RequestableObjectsV1Api - factory interface + * @export + */ +export const RequestableObjectsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RequestableObjectsV1ApiFp(configuration) + return { + /** + * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. + * @summary Requestable objects list + * @param {RequestableObjectsV1ApiListRequestableObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listRequestableObjectsV1(requestParameters: RequestableObjectsV1ApiListRequestableObjectsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listRequestableObjectsV1(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for listRequestableObjectsV1 operation in RequestableObjectsV1Api. + * @export + * @interface RequestableObjectsV1ApiListRequestableObjectsV1Request + */ +export interface RequestableObjectsV1ApiListRequestableObjectsV1Request { + /** + * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + * @type {string} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly identityId?: string + + /** + * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. + * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly types?: Array + + /** + * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. + * @type {string} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly term?: string + + /** + * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. + * @type {Array} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly statuses?: Array + + /** + * 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 RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + 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, in* **name**: *eq, in, sw* + * @type {string} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + 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: **name** + * @type {string} + * @memberof RequestableObjectsV1ApiListRequestableObjectsV1 + */ + readonly sorters?: string +} + +/** + * RequestableObjectsV1Api - object-oriented interface + * @export + * @class RequestableObjectsV1Api + * @extends {BaseAPI} + */ +export class RequestableObjectsV1Api extends BaseAPI { + /** + * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. + * @summary Requestable objects list + * @param {RequestableObjectsV1ApiListRequestableObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RequestableObjectsV1Api + */ + public listRequestableObjectsV1(requestParameters: RequestableObjectsV1ApiListRequestableObjectsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RequestableObjectsV1ApiFp(this.configuration).listRequestableObjectsV1(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ListRequestableObjectsV1TypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE' +} as const; +export type ListRequestableObjectsV1TypesV1 = typeof ListRequestableObjectsV1TypesV1[keyof typeof ListRequestableObjectsV1TypesV1]; + + diff --git a/sdk-output/requestable_objects/base.ts b/sdk-output/requestable_objects/base.ts new file mode 100644 index 00000000..1041a3cc --- /dev/null +++ b/sdk-output/requestable_objects/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Requestable Objects + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/requestable_objects/common.ts b/sdk-output/requestable_objects/common.ts new file mode 100644 index 00000000..96ed9c20 --- /dev/null +++ b/sdk-output/requestable_objects/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Requestable Objects + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/requestable_objects/configuration.ts b/sdk-output/requestable_objects/configuration.ts new file mode 100644 index 00000000..4665b6a9 --- /dev/null +++ b/sdk-output/requestable_objects/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Requestable Objects + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/requestable_objects/git_push.sh b/sdk-output/requestable_objects/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/requestable_objects/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/requestable_objects/index.ts b/sdk-output/requestable_objects/index.ts new file mode 100644 index 00000000..6b9524a2 --- /dev/null +++ b/sdk-output/requestable_objects/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Requestable Objects + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/requestable_objects/package.json b/sdk-output/requestable_objects/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/requestable_objects/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/requestable_objects/tsconfig.json b/sdk-output/requestable_objects/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/requestable_objects/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/role_insights/.gitignore b/sdk-output/role_insights/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/role_insights/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/role_insights/.npmignore b/sdk-output/role_insights/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/role_insights/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/role_insights/.openapi-generator-ignore b/sdk-output/role_insights/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/role_insights/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/role_insights/.openapi-generator/FILES b/sdk-output/role_insights/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/role_insights/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/role_insights/.openapi-generator/VERSION b/sdk-output/role_insights/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/role_insights/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/role_insights/.sdk-partition b/sdk-output/role_insights/.sdk-partition new file mode 100644 index 00000000..b4b86c3f --- /dev/null +++ b/sdk-output/role_insights/.sdk-partition @@ -0,0 +1 @@ +role-insights \ No newline at end of file diff --git a/sdk-output/role_insights/README.md b/sdk-output/role_insights/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/role_insights/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/role_insights/api.ts b/sdk-output/role_insights/api.ts new file mode 100644 index 00000000..7d494101 --- /dev/null +++ b/sdk-output/role_insights/api.ts @@ -0,0 +1,1576 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Insights + * 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 CreateRoleInsightRequestsV1401ResponseV1 + */ +export interface CreateRoleInsightRequestsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateRoleInsightRequestsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface CreateRoleInsightRequestsV1429ResponseV1 + */ +export interface CreateRoleInsightRequestsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateRoleInsightRequestsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface RoleinsightV1 + */ +export interface RoleinsightV1 { + /** + * Insight id + * @type {string} + * @memberof RoleinsightV1 + */ + 'id'?: string; + /** + * Total number of updates for this role + * @type {number} + * @memberof RoleinsightV1 + */ + 'numberOfUpdates'?: number; + /** + * The date-time insights were last created for this role. + * @type {string} + * @memberof RoleinsightV1 + */ + 'createdDate'?: string; + /** + * The date-time insights were last modified for this role. + * @type {string} + * @memberof RoleinsightV1 + */ + 'modifiedDate'?: string | null; + /** + * + * @type {RoleinsightsroleV1} + * @memberof RoleinsightV1 + */ + 'role'?: RoleinsightsroleV1; + /** + * + * @type {RoleinsightsinsightV1} + * @memberof RoleinsightV1 + */ + 'insight'?: RoleinsightsinsightV1; +} +/** + * + * @export + * @interface RoleinsightsentitlementV1 + */ +export interface RoleinsightsentitlementV1 { + /** + * Name of the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'name'?: string; + /** + * Id of the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'id'?: string; + /** + * Description for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'description'?: string | null; + /** + * Source or the application for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'source'?: string; + /** + * Attribute for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'attribute'?: string; + /** + * Attribute value for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface RoleinsightsentitlementchangesV1 + */ +export interface RoleinsightsentitlementchangesV1 { + /** + * Name of the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'name'?: string; + /** + * Id of the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'id'?: string; + /** + * Description for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'description'?: string | null; + /** + * Attribute for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'attribute'?: string; + /** + * Attribute value for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'value'?: string; + /** + * Source or the application for the entitlement + * @type {string} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'source'?: string; + /** + * + * @type {RoleinsightsinsightV1} + * @memberof RoleinsightsentitlementchangesV1 + */ + 'insight'?: RoleinsightsinsightV1; +} +/** + * + * @export + * @interface RoleinsightsidentitiesV1 + */ +export interface RoleinsightsidentitiesV1 { + /** + * Id for identity + * @type {string} + * @memberof RoleinsightsidentitiesV1 + */ + 'id'?: string; + /** + * Name for identity + * @type {string} + * @memberof RoleinsightsidentitiesV1 + */ + 'name'?: string; + /** + * + * @type {{ [key: string]: string; }} + * @memberof RoleinsightsidentitiesV1 + */ + 'attributes'?: { [key: string]: string; }; +} +/** + * + * @export + * @interface RoleinsightsinsightV1 + */ +export interface RoleinsightsinsightV1 { + /** + * The number of identities in this role with the entitlement. + * @type {string} + * @memberof RoleinsightsinsightV1 + */ + 'type'?: string; + /** + * The number of identities in this role with the entitlement. + * @type {number} + * @memberof RoleinsightsinsightV1 + */ + 'identitiesWithAccess'?: number; + /** + * The number of identities in this role that do not have the specified entitlement. + * @type {number} + * @memberof RoleinsightsinsightV1 + */ + 'identitiesImpacted'?: number; + /** + * The total number of identities. + * @type {number} + * @memberof RoleinsightsinsightV1 + */ + 'totalNumberOfIdentities'?: number; + /** + * + * @type {string} + * @memberof RoleinsightsinsightV1 + */ + 'impactedIdentityNames'?: string | null; +} +/** + * + * @export + * @interface RoleinsightsresponseV1 + */ +export interface RoleinsightsresponseV1 { + /** + * Request Id for a role insight generation request + * @type {string} + * @memberof RoleinsightsresponseV1 + */ + 'id'?: string; + /** + * The date-time role insights request was created. + * @type {string} + * @memberof RoleinsightsresponseV1 + */ + 'createdDate'?: string; + /** + * The date-time role insights request was completed. + * @type {string} + * @memberof RoleinsightsresponseV1 + */ + 'lastGenerated'?: string; + /** + * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. + * @type {number} + * @memberof RoleinsightsresponseV1 + */ + 'numberOfUpdates'?: number; + /** + * The role IDs that are in this request. + * @type {Array} + * @memberof RoleinsightsresponseV1 + */ + 'roleIds'?: Array; + /** + * Request status + * @type {string} + * @memberof RoleinsightsresponseV1 + */ + 'status'?: RoleinsightsresponseV1StatusV1; +} + +export const RoleinsightsresponseV1StatusV1 = { + Created: 'CREATED', + InProgress: 'IN PROGRESS', + Completed: 'COMPLETED', + Failed: 'FAILED' +} as const; + +export type RoleinsightsresponseV1StatusV1 = typeof RoleinsightsresponseV1StatusV1[keyof typeof RoleinsightsresponseV1StatusV1]; + +/** + * + * @export + * @interface RoleinsightsroleV1 + */ +export interface RoleinsightsroleV1 { + /** + * Role name + * @type {string} + * @memberof RoleinsightsroleV1 + */ + 'name'?: string; + /** + * Role id + * @type {string} + * @memberof RoleinsightsroleV1 + */ + 'id'?: string; + /** + * Role description + * @type {string} + * @memberof RoleinsightsroleV1 + */ + 'description'?: string; + /** + * Role owner name + * @type {string} + * @memberof RoleinsightsroleV1 + */ + 'ownerName'?: string; + /** + * Role owner id + * @type {string} + * @memberof RoleinsightsroleV1 + */ + 'ownerId'?: string; +} +/** + * + * @export + * @interface RoleinsightssummaryV1 + */ +export interface RoleinsightssummaryV1 { + /** + * Total number of roles with updates + * @type {number} + * @memberof RoleinsightssummaryV1 + */ + 'numberOfUpdates'?: number; + /** + * The date-time role insights were last found. + * @type {string} + * @memberof RoleinsightssummaryV1 + */ + 'lastGenerated'?: string; + /** + * The number of entitlements included in roles (vs free radicals). + * @type {number} + * @memberof RoleinsightssummaryV1 + */ + 'entitlementsIncludedInRoles'?: number; + /** + * The total number of entitlements. + * @type {number} + * @memberof RoleinsightssummaryV1 + */ + 'totalNumberOfEntitlements'?: number; + /** + * The number of identities in roles vs. identities with just entitlements and not in roles. + * @type {number} + * @memberof RoleinsightssummaryV1 + */ + 'identitiesWithAccessViaRoles'?: number; + /** + * The total number of identities. + * @type {number} + * @memberof RoleinsightssummaryV1 + */ + 'totalNumberOfIdentities'?: number; +} + +/** + * RoleInsightsV1Api - axios parameter creator + * @export + */ +export const RoleInsightsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + * @summary Generate insights for roles + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + createRoleInsightRequestsV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/requests`; + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the entitlement insights for a role. + * @summary Download entitlement insights for a role + * @param {string} insightId The role insight id + * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + downloadRoleInsightsEntitlementsChangesV1: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'insightId' is not null or undefined + assertParamExists('downloadRoleInsightsEntitlementsChangesV1', 'insightId', insightId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes/download` + .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + * @summary Get identities for a suggested entitlement (for a role) + * @param {string} insightId The role insight id + * @param {string} entitlementId The entitlement id + * @param {boolean} [hasEntitlement] Identity has this entitlement or not + * @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} [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: **name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementChangesIdentitiesV1: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'insightId' is not null or undefined + assertParamExists('getEntitlementChangesIdentitiesV1', 'insightId', insightId) + // verify required parameter 'entitlementId' is not null or undefined + assertParamExists('getEntitlementChangesIdentitiesV1', 'entitlementId', entitlementId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes/{entitlementId}/identities` + .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) + .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); + // 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 (hasEntitlement !== undefined) { + localVarQueryParameter['hasEntitlement'] = hasEntitlement; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint gets role insights information for a role. + * @summary Get a single role insight + * @param {string} insightId The role insight id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightV1: async (insightId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'insightId' is not null or undefined + assertParamExists('getRoleInsightV1', 'insightId', insightId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/{insightId}` + .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. + * @summary Get current entitlement for a role + * @param {string} insightId The role insight id + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsCurrentEntitlementsV1: async (insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'insightId' is not null or undefined + assertParamExists('getRoleInsightsCurrentEntitlementsV1', 'insightId', insightId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/{insightId}/current-entitlements` + .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns entitlement insights for a role. + * @summary Get entitlement insights for a role + * @param {string} insightId The role insight id + * @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: **identitiesWithAccess, name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsEntitlementsChangesV1: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'insightId' is not null or undefined + assertParamExists('getRoleInsightsEntitlementsChangesV1', 'insightId', insightId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/{insightId}/entitlement-changes` + .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); + // 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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns details of a prior role insights request. + * @summary Returns metadata from prior request. + * @param {string} id The role insights request id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getRoleInsightsRequestsV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getRoleInsightsRequestsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/requests/{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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns high level summary information for role insights for a customer. + * @summary Get role insights summary information + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsSummaryV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/v1/summary`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This method returns detailed role insights for each role. + * @summary Get role insights + * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsV1: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-insights/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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * RoleInsightsV1Api - functional programming interface + * @export + */ +export const RoleInsightsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RoleInsightsV1ApiAxiosParamCreator(configuration) + return { + /** + * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + * @summary Generate insights for roles + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async createRoleInsightRequestsV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequestsV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.createRoleInsightRequestsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the entitlement insights for a role. + * @summary Download entitlement insights for a role + * @param {string} insightId The role insight id + * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async downloadRoleInsightsEntitlementsChangesV1(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChangesV1(insightId, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.downloadRoleInsightsEntitlementsChangesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + * @summary Get identities for a suggested entitlement (for a role) + * @param {string} insightId The role insight id + * @param {string} entitlementId The entitlement id + * @param {boolean} [hasEntitlement] Identity has this entitlement or not + * @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} [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: **name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementChangesIdentitiesV1(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentitiesV1(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getEntitlementChangesIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint gets role insights information for a role. + * @summary Get a single role insight + * @param {string} insightId The role insight id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleInsightV1(insightId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightV1(insightId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. + * @summary Get current entitlement for a role + * @param {string} insightId The role insight id + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleInsightsCurrentEntitlementsV1(insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlementsV1(insightId, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightsCurrentEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns entitlement insights for a role. + * @summary Get entitlement insights for a role + * @param {string} insightId The role insight id + * @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: **identitiesWithAccess, name** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleInsightsEntitlementsChangesV1(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChangesV1(insightId, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightsEntitlementsChangesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns details of a prior role insights request. + * @summary Returns metadata from prior request. + * @param {string} id The role insights request id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + async getRoleInsightsRequestsV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequestsV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightsRequestsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns high level summary information for role insights for a customer. + * @summary Get role insights summary information + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleInsightsSummaryV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummaryV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightsSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This method returns detailed role insights for each role. + * @summary Get role insights + * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleInsightsV1(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsV1(offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RoleInsightsV1Api.getRoleInsightsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RoleInsightsV1Api - factory interface + * @export + */ +export const RoleInsightsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RoleInsightsV1ApiFp(configuration) + return { + /** + * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + * @summary Generate insights for roles + * @param {RoleInsightsV1ApiCreateRoleInsightRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + createRoleInsightRequestsV1(requestParameters: RoleInsightsV1ApiCreateRoleInsightRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createRoleInsightRequestsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the entitlement insights for a role. + * @summary Download entitlement insights for a role + * @param {RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + downloadRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.downloadRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + * @summary Get identities for a suggested entitlement (for a role) + * @param {RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementChangesIdentitiesV1(requestParameters: RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getEntitlementChangesIdentitiesV1(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint gets role insights information for a role. + * @summary Get a single role insight + * @param {RoleInsightsV1ApiGetRoleInsightV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightV1(requestParameters: RoleInsightsV1ApiGetRoleInsightV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleInsightV1(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. + * @summary Get current entitlement for a role + * @param {RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsCurrentEntitlementsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleInsightsCurrentEntitlementsV1(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns entitlement insights for a role. + * @summary Get entitlement insights for a role + * @param {RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns details of a prior role insights request. + * @summary Returns metadata from prior request. + * @param {RoleInsightsV1ApiGetRoleInsightsRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + */ + getRoleInsightsRequestsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsRequestsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleInsightsRequestsV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns high level summary information for role insights for a customer. + * @summary Get role insights summary information + * @param {RoleInsightsV1ApiGetRoleInsightsSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsSummaryV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleInsightsSummaryV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This method returns detailed role insights for each role. + * @summary Get role insights + * @param {RoleInsightsV1ApiGetRoleInsightsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleInsightsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleInsightsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createRoleInsightRequestsV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiCreateRoleInsightRequestsV1Request + */ +export interface RoleInsightsV1ApiCreateRoleInsightRequestsV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiCreateRoleInsightRequestsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for downloadRoleInsightsEntitlementsChangesV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request + */ +export interface RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request { + /** + * The role insight id + * @type {string} + * @memberof RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1 + */ + readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + * @type {string} + * @memberof RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1 + */ + readonly sorters?: 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: **name**: *sw* **description**: *sw* + * @type {string} + * @memberof RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getEntitlementChangesIdentitiesV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request + */ +export interface RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request { + /** + * The role insight id + * @type {string} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly insightId: string + + /** + * The entitlement id + * @type {string} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly entitlementId: string + + /** + * Identity has this entitlement or not + * @type {boolean} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly hasEntitlement?: boolean + + /** + * 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 RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + 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 RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + 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 RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly count?: boolean + + /** + * 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: **name** + * @type {string} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly sorters?: 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: **name**: *sw* + * @type {string} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightV1Request { + /** + * The role insight id + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightV1 + */ + readonly insightId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightsCurrentEntitlementsV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request { + /** + * The role insight id + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1 + */ + readonly insightId: 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: **name**: *sw* **description**: *sw* + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightsEntitlementsChangesV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request { + /** + * The role insight id + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1 + */ + readonly insightId: 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: **identitiesWithAccess, name** + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1 + */ + readonly sorters?: 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: **name**: *sw* **description**: *sw* + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightsRequestsV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightsRequestsV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightsRequestsV1Request { + /** + * The role insights request id + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsRequestsV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsRequestsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightsSummaryV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightsSummaryV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightsSummaryV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsSummaryV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleInsightsV1 operation in RoleInsightsV1Api. + * @export + * @interface RoleInsightsV1ApiGetRoleInsightsV1Request + */ +export interface RoleInsightsV1ApiGetRoleInsightsV1Request { + /** + * 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 RoleInsightsV1ApiGetRoleInsightsV1 + */ + 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 RoleInsightsV1ApiGetRoleInsightsV1 + */ + 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 RoleInsightsV1ApiGetRoleInsightsV1 + */ + readonly count?: boolean + + /** + * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsV1 + */ + readonly sorters?: 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsV1 + */ + readonly filters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RoleInsightsV1ApiGetRoleInsightsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * RoleInsightsV1Api - object-oriented interface + * @export + * @class RoleInsightsV1Api + * @extends {BaseAPI} + */ +export class RoleInsightsV1Api extends BaseAPI { + /** + * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + * @summary Generate insights for roles + * @param {RoleInsightsV1ApiCreateRoleInsightRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public createRoleInsightRequestsV1(requestParameters: RoleInsightsV1ApiCreateRoleInsightRequestsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).createRoleInsightRequestsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the entitlement insights for a role. + * @summary Download entitlement insights for a role + * @param {RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public downloadRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsV1ApiDownloadRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).downloadRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + * @summary Get identities for a suggested entitlement (for a role) + * @param {RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getEntitlementChangesIdentitiesV1(requestParameters: RoleInsightsV1ApiGetEntitlementChangesIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getEntitlementChangesIdentitiesV1(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint gets role insights information for a role. + * @summary Get a single role insight + * @param {RoleInsightsV1ApiGetRoleInsightV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightV1(requestParameters: RoleInsightsV1ApiGetRoleInsightV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightV1(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. + * @summary Get current entitlement for a role + * @param {RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightsCurrentEntitlementsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsCurrentEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightsCurrentEntitlementsV1(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns entitlement insights for a role. + * @summary Get entitlement insights for a role + * @param {RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightsEntitlementsChangesV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsEntitlementsChangesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightsEntitlementsChangesV1(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns details of a prior role insights request. + * @summary Returns metadata from prior request. + * @param {RoleInsightsV1ApiGetRoleInsightsRequestsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @deprecated + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightsRequestsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsRequestsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightsRequestsV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns high level summary information for role insights for a customer. + * @summary Get role insights summary information + * @param {RoleInsightsV1ApiGetRoleInsightsSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightsSummaryV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightsSummaryV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This method returns detailed role insights for each role. + * @summary Get role insights + * @param {RoleInsightsV1ApiGetRoleInsightsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RoleInsightsV1Api + */ + public getRoleInsightsV1(requestParameters: RoleInsightsV1ApiGetRoleInsightsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RoleInsightsV1ApiFp(this.configuration).getRoleInsightsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/role_insights/base.ts b/sdk-output/role_insights/base.ts new file mode 100644 index 00000000..5a2ddd56 --- /dev/null +++ b/sdk-output/role_insights/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Insights + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/role_insights/common.ts b/sdk-output/role_insights/common.ts new file mode 100644 index 00000000..710bcd24 --- /dev/null +++ b/sdk-output/role_insights/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Insights + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/role_insights/configuration.ts b/sdk-output/role_insights/configuration.ts new file mode 100644 index 00000000..568236c6 --- /dev/null +++ b/sdk-output/role_insights/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Insights + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/role_insights/git_push.sh b/sdk-output/role_insights/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/role_insights/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/role_insights/index.ts b/sdk-output/role_insights/index.ts new file mode 100644 index 00000000..70dfa112 --- /dev/null +++ b/sdk-output/role_insights/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Insights + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/role_insights/package.json b/sdk-output/role_insights/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/role_insights/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/role_insights/tsconfig.json b/sdk-output/role_insights/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/role_insights/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/role_propagation/.gitignore b/sdk-output/role_propagation/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/role_propagation/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/role_propagation/.npmignore b/sdk-output/role_propagation/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/role_propagation/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/role_propagation/.openapi-generator-ignore b/sdk-output/role_propagation/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/role_propagation/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/role_propagation/.openapi-generator/FILES b/sdk-output/role_propagation/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/role_propagation/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/role_propagation/.openapi-generator/VERSION b/sdk-output/role_propagation/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/role_propagation/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/role_propagation/.sdk-partition b/sdk-output/role_propagation/.sdk-partition new file mode 100644 index 00000000..a3c1b731 --- /dev/null +++ b/sdk-output/role_propagation/.sdk-partition @@ -0,0 +1 @@ +role-propagation \ No newline at end of file diff --git a/sdk-output/role_propagation/README.md b/sdk-output/role_propagation/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/role_propagation/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/role_propagation/api.ts b/sdk-output/role_propagation/api.ts new file mode 100644 index 00000000..9b900872 --- /dev/null +++ b/sdk-output/role_propagation/api.ts @@ -0,0 +1,1022 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Propagation + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Role Change Propagation Config Input + * @export + * @interface RolePropagationConfigInputV1 + */ +export interface RolePropagationConfigInputV1 { + /** + * Indicates if the Role Change Propagation process should be enabled for the tenant + * @type {boolean} + * @memberof RolePropagationConfigInputV1 + */ + 'enabled'?: boolean; +} +/** + * Role Change Propagation Config Response + * @export + * @interface RolePropagationConfigResponseV1 + */ +export interface RolePropagationConfigResponseV1 { + /** + * Indicates if the Role Change Propagation process is enabled for the tenant + * @type {boolean} + * @memberof RolePropagationConfigResponseV1 + */ + 'enabled'?: boolean; + /** + * The time when Role Change Propagation Process was last enabled on the tenant + * @type {string} + * @memberof RolePropagationConfigResponseV1 + */ + 'enabledDate'?: string; + /** + * The time when Role Change Propagation Configuration was first created for the tenant + * @type {string} + * @memberof RolePropagationConfigResponseV1 + */ + 'createdDate'?: string; + /** + * The time when Role Change Propagation Config was updated on the tenant + * @type {string} + * @memberof RolePropagationConfigResponseV1 + */ + 'modifiedDate'?: string; +} +/** + * Details of the ongoing role propagation process + * @export + * @interface RolePropagationOngoingResponseRolePropagationDetailsV1 + */ +export interface RolePropagationOngoingResponseRolePropagationDetailsV1 { + /** + * Id of the Role Propagation process triggered. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'id'?: string; + /** + * Status of the Role Propagation process. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'status'?: RolePropagationOngoingResponseRolePropagationDetailsV1StatusV1; + /** + * Current execution stage of the Role Propagation process. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'executionStage'?: RolePropagationOngoingResponseRolePropagationDetailsV1ExecutionStageV1; + /** + * Time when the Role Propagation process was launched. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'launched'?: string; + /** + * + * @type {RolePropagationStatusResponseLaunchedByV1} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'launchedBy'?: RolePropagationStatusResponseLaunchedByV1; + /** + * + * @type {RolePropagationStatusResponseTerminatedByV1} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV1; + /** + * Time when the Role Propagation process was completed. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'completed'?: string; + /** + * Reason for failure if the Role Propagation process failed. + * @type {string} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'failureReason'?: string; + /** + * Indicates if the role refresh was skipped during the Role Propagation process. + * @type {boolean} + * @memberof RolePropagationOngoingResponseRolePropagationDetailsV1 + */ + 'skipRoleRefresh'?: boolean; +} + +export const RolePropagationOngoingResponseRolePropagationDetailsV1StatusV1 = { + Running: 'RUNNING', + Completed: 'COMPLETED' +} as const; + +export type RolePropagationOngoingResponseRolePropagationDetailsV1StatusV1 = typeof RolePropagationOngoingResponseRolePropagationDetailsV1StatusV1[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV1StatusV1]; +export const RolePropagationOngoingResponseRolePropagationDetailsV1ExecutionStageV1 = { + Pending: 'PENDING', + DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', + LaunchProvisioning: 'LAUNCH_PROVISIONING', + Succeeded: 'SUCCEEDED', + Failed: 'FAILED', + Terminated: 'TERMINATED' +} as const; + +export type RolePropagationOngoingResponseRolePropagationDetailsV1ExecutionStageV1 = typeof RolePropagationOngoingResponseRolePropagationDetailsV1ExecutionStageV1[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV1ExecutionStageV1]; + +/** + * Running Role Propagation Response + * @export + * @interface RolePropagationOngoingResponseV1 + */ +export interface RolePropagationOngoingResponseV1 { + /** + * Indicates if the role propagation process is currently running on the tenant + * @type {boolean} + * @memberof RolePropagationOngoingResponseV1 + */ + 'isRunning'?: boolean; + /** + * + * @type {RolePropagationOngoingResponseRolePropagationDetailsV1} + * @memberof RolePropagationOngoingResponseV1 + */ + 'rolePropagationDetails'?: RolePropagationOngoingResponseRolePropagationDetailsV1; +} +/** + * Role Propagation Response + * @export + * @interface RolePropagationResponseV1 + */ +export interface RolePropagationResponseV1 { + /** + * Id of the Role Propagation process triggered. + * @type {string} + * @memberof RolePropagationResponseV1 + */ + 'rolePropagationId'?: string; +} +/** + * Identity who launched the Role Propagation process. + * @export + * @interface RolePropagationStatusResponseLaunchedByV1 + */ +export interface RolePropagationStatusResponseLaunchedByV1 { + /** + * DTO type of the identity who launched the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseLaunchedByV1 + */ + 'type'?: RolePropagationStatusResponseLaunchedByV1TypeV1; + /** + * ID of the identity who launched the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseLaunchedByV1 + */ + 'id'?: string; + /** + * Name of the identity who launched the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseLaunchedByV1 + */ + 'name'?: string; +} + +export const RolePropagationStatusResponseLaunchedByV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type RolePropagationStatusResponseLaunchedByV1TypeV1 = typeof RolePropagationStatusResponseLaunchedByV1TypeV1[keyof typeof RolePropagationStatusResponseLaunchedByV1TypeV1]; + +/** + * Identity who terminated the Role Propagation process. + * @export + * @interface RolePropagationStatusResponseTerminatedByV1 + */ +export interface RolePropagationStatusResponseTerminatedByV1 { + /** + * DTO type of the Identity who terminated the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseTerminatedByV1 + */ + 'type'?: RolePropagationStatusResponseTerminatedByV1TypeV1; + /** + * ID of the Identity who terminated the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseTerminatedByV1 + */ + 'id'?: string; + /** + * Name of the Identity who terminated the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseTerminatedByV1 + */ + 'name'?: string; +} + +export const RolePropagationStatusResponseTerminatedByV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type RolePropagationStatusResponseTerminatedByV1TypeV1 = typeof RolePropagationStatusResponseTerminatedByV1TypeV1[keyof typeof RolePropagationStatusResponseTerminatedByV1TypeV1]; + +/** + * Role Propagation Status Response + * @export + * @interface RolePropagationStatusResponseV1 + */ +export interface RolePropagationStatusResponseV1 { + /** + * Id of the Role Propagation process triggered. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'id'?: string; + /** + * Status of the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'status'?: RolePropagationStatusResponseV1StatusV1; + /** + * Current execution stage of the Role Propagation process. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'executionStage'?: RolePropagationStatusResponseV1ExecutionStageV1; + /** + * Time when the Role Propagation process was launched. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'launched'?: string; + /** + * + * @type {RolePropagationStatusResponseLaunchedByV1} + * @memberof RolePropagationStatusResponseV1 + */ + 'launchedBy'?: RolePropagationStatusResponseLaunchedByV1; + /** + * + * @type {RolePropagationStatusResponseTerminatedByV1} + * @memberof RolePropagationStatusResponseV1 + */ + 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV1; + /** + * Time when the Role Propagation process was completed. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'completed'?: string; + /** + * Reason for failure if the Role Propagation process failed. + * @type {string} + * @memberof RolePropagationStatusResponseV1 + */ + 'failureReason'?: string; + /** + * Indicates if the role refresh was skipped during the Role Propagation process. + * @type {boolean} + * @memberof RolePropagationStatusResponseV1 + */ + 'skipRoleRefresh'?: boolean; +} + +export const RolePropagationStatusResponseV1StatusV1 = { + Running: 'RUNNING', + Completed: 'COMPLETED' +} as const; + +export type RolePropagationStatusResponseV1StatusV1 = typeof RolePropagationStatusResponseV1StatusV1[keyof typeof RolePropagationStatusResponseV1StatusV1]; +export const RolePropagationStatusResponseV1ExecutionStageV1 = { + Pending: 'PENDING', + DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', + LaunchProvisioning: 'LAUNCH_PROVISIONING', + Succeeded: 'SUCCEEDED', + Failed: 'FAILED', + Terminated: 'TERMINATED' +} as const; + +export type RolePropagationStatusResponseV1ExecutionStageV1 = typeof RolePropagationStatusResponseV1ExecutionStageV1[keyof typeof RolePropagationStatusResponseV1ExecutionStageV1]; + +/** + * + * @export + * @interface StartRolePropagationV1401ResponseV1 + */ +export interface StartRolePropagationV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartRolePropagationV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface StartRolePropagationV1429ResponseV1 + */ +export interface StartRolePropagationV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartRolePropagationV1429ResponseV1 + */ + 'message'?: any; +} + +/** + * RolePropagationV1Api - axios parameter creator + * @export + */ +export const RolePropagationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This endpoint terminates the ongoing role change propagation process for a tenant. + * @summary Terminate Role Propagation process + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelRolePropagationV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation/v1/terminate`; + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get ongoing Role Propagation process + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOngoingRolePropagationV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation/v1/is-running`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint fetches the Role Change Propagation Configuration for the tenant + * @summary Get Role Change Propagation Configuration + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRolePropagationConfigV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation-config/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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get status of Role-Propagation process + * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRolePropagationStatusV1: async (rolePropagationId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolePropagationId' is not null or undefined + assertParamExists('getRolePropagationStatusV1', 'rolePropagationId', rolePropagationId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation/v1/{rolePropagationId}/status` + .replace(`{${"rolePropagationId"}}`, encodeURIComponent(String(rolePropagationId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint enables or disables the Role Change Propagation Process for the tenant + * @summary Update Role Change Propagation Configuration + * @param {RolePropagationConfigInputV1} rolePropagationConfigInputV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setRolePropagationConfigV1: async (rolePropagationConfigInputV1: RolePropagationConfigInputV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolePropagationConfigInputV1' is not null or undefined + assertParamExists('setRolePropagationConfigV1', 'rolePropagationConfigInputV1', rolePropagationConfigInputV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation-config/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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(rolePropagationConfigInputV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant + * @summary Initiate Role Propagation process + * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startRolePropagationV1: async (skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/role-propagation/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; + + if (skipRoleRefresh !== undefined) { + localVarQueryParameter['skipRoleRefresh'] = skipRoleRefresh; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * RolePropagationV1Api - functional programming interface + * @export + */ +export const RolePropagationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RolePropagationV1ApiAxiosParamCreator(configuration) + return { + /** + * This endpoint terminates the ongoing role change propagation process for a tenant. + * @summary Terminate Role Propagation process + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelRolePropagationV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRolePropagationV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.cancelRolePropagationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get ongoing Role Propagation process + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getOngoingRolePropagationV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOngoingRolePropagationV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.getOngoingRolePropagationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint fetches the Role Change Propagation Configuration for the tenant + * @summary Get Role Change Propagation Configuration + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRolePropagationConfigV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationConfigV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.getRolePropagationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get status of Role-Propagation process + * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRolePropagationStatusV1(rolePropagationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationStatusV1(rolePropagationId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.getRolePropagationStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint enables or disables the Role Change Propagation Process for the tenant + * @summary Update Role Change Propagation Configuration + * @param {RolePropagationConfigInputV1} rolePropagationConfigInputV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setRolePropagationConfigV1(rolePropagationConfigInputV1: RolePropagationConfigInputV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setRolePropagationConfigV1(rolePropagationConfigInputV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.setRolePropagationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant + * @summary Initiate Role Propagation process + * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startRolePropagationV1(skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startRolePropagationV1(skipRoleRefresh, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolePropagationV1Api.startRolePropagationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RolePropagationV1Api - factory interface + * @export + */ +export const RolePropagationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RolePropagationV1ApiFp(configuration) + return { + /** + * This endpoint terminates the ongoing role change propagation process for a tenant. + * @summary Terminate Role Propagation process + * @param {RolePropagationV1ApiCancelRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelRolePropagationV1(requestParameters: RolePropagationV1ApiCancelRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelRolePropagationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get ongoing Role Propagation process + * @param {RolePropagationV1ApiGetOngoingRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getOngoingRolePropagationV1(requestParameters: RolePropagationV1ApiGetOngoingRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getOngoingRolePropagationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint fetches the Role Change Propagation Configuration for the tenant + * @summary Get Role Change Propagation Configuration + * @param {RolePropagationV1ApiGetRolePropagationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRolePropagationConfigV1(requestParameters: RolePropagationV1ApiGetRolePropagationConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRolePropagationConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get status of Role-Propagation process + * @param {RolePropagationV1ApiGetRolePropagationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRolePropagationStatusV1(requestParameters: RolePropagationV1ApiGetRolePropagationStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRolePropagationStatusV1(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint enables or disables the Role Change Propagation Process for the tenant + * @summary Update Role Change Propagation Configuration + * @param {RolePropagationV1ApiSetRolePropagationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setRolePropagationConfigV1(requestParameters: RolePropagationV1ApiSetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setRolePropagationConfigV1(requestParameters.rolePropagationConfigInputV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant + * @summary Initiate Role Propagation process + * @param {RolePropagationV1ApiStartRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startRolePropagationV1(requestParameters: RolePropagationV1ApiStartRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startRolePropagationV1(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for cancelRolePropagationV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiCancelRolePropagationV1Request + */ +export interface RolePropagationV1ApiCancelRolePropagationV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiCancelRolePropagationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getOngoingRolePropagationV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiGetOngoingRolePropagationV1Request + */ +export interface RolePropagationV1ApiGetOngoingRolePropagationV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiGetOngoingRolePropagationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRolePropagationConfigV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiGetRolePropagationConfigV1Request + */ +export interface RolePropagationV1ApiGetRolePropagationConfigV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiGetRolePropagationConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRolePropagationStatusV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiGetRolePropagationStatusV1Request + */ +export interface RolePropagationV1ApiGetRolePropagationStatusV1Request { + /** + * The ID of the role propagation process to retrieve the status for. + * @type {string} + * @memberof RolePropagationV1ApiGetRolePropagationStatusV1 + */ + readonly rolePropagationId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiGetRolePropagationStatusV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setRolePropagationConfigV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiSetRolePropagationConfigV1Request + */ +export interface RolePropagationV1ApiSetRolePropagationConfigV1Request { + /** + * + * @type {RolePropagationConfigInputV1} + * @memberof RolePropagationV1ApiSetRolePropagationConfigV1 + */ + readonly rolePropagationConfigInputV1: RolePropagationConfigInputV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiSetRolePropagationConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for startRolePropagationV1 operation in RolePropagationV1Api. + * @export + * @interface RolePropagationV1ApiStartRolePropagationV1Request + */ +export interface RolePropagationV1ApiStartRolePropagationV1Request { + /** + * When true, the role refresh is not performed. Keeping it false is recommended. + * @type {boolean} + * @memberof RolePropagationV1ApiStartRolePropagationV1 + */ + readonly skipRoleRefresh?: boolean + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolePropagationV1ApiStartRolePropagationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * RolePropagationV1Api - object-oriented interface + * @export + * @class RolePropagationV1Api + * @extends {BaseAPI} + */ +export class RolePropagationV1Api extends BaseAPI { + /** + * This endpoint terminates the ongoing role change propagation process for a tenant. + * @summary Terminate Role Propagation process + * @param {RolePropagationV1ApiCancelRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public cancelRolePropagationV1(requestParameters: RolePropagationV1ApiCancelRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).cancelRolePropagationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get ongoing Role Propagation process + * @param {RolePropagationV1ApiGetOngoingRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public getOngoingRolePropagationV1(requestParameters: RolePropagationV1ApiGetOngoingRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).getOngoingRolePropagationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint fetches the Role Change Propagation Configuration for the tenant + * @summary Get Role Change Propagation Configuration + * @param {RolePropagationV1ApiGetRolePropagationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public getRolePropagationConfigV1(requestParameters: RolePropagationV1ApiGetRolePropagationConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).getRolePropagationConfigV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + * @summary Get status of Role-Propagation process + * @param {RolePropagationV1ApiGetRolePropagationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public getRolePropagationStatusV1(requestParameters: RolePropagationV1ApiGetRolePropagationStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).getRolePropagationStatusV1(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint enables or disables the Role Change Propagation Process for the tenant + * @summary Update Role Change Propagation Configuration + * @param {RolePropagationV1ApiSetRolePropagationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public setRolePropagationConfigV1(requestParameters: RolePropagationV1ApiSetRolePropagationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).setRolePropagationConfigV1(requestParameters.rolePropagationConfigInputV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant + * @summary Initiate Role Propagation process + * @param {RolePropagationV1ApiStartRolePropagationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolePropagationV1Api + */ + public startRolePropagationV1(requestParameters: RolePropagationV1ApiStartRolePropagationV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolePropagationV1ApiFp(this.configuration).startRolePropagationV1(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/role_propagation/base.ts b/sdk-output/role_propagation/base.ts new file mode 100644 index 00000000..dfd066ce --- /dev/null +++ b/sdk-output/role_propagation/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Propagation + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/role_propagation/common.ts b/sdk-output/role_propagation/common.ts new file mode 100644 index 00000000..3b07d4dc --- /dev/null +++ b/sdk-output/role_propagation/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Propagation + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/role_propagation/configuration.ts b/sdk-output/role_propagation/configuration.ts new file mode 100644 index 00000000..3533b3c4 --- /dev/null +++ b/sdk-output/role_propagation/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Propagation + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/role_propagation/git_push.sh b/sdk-output/role_propagation/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/role_propagation/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/role_propagation/index.ts b/sdk-output/role_propagation/index.ts new file mode 100644 index 00000000..8862e43c --- /dev/null +++ b/sdk-output/role_propagation/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Role Propagation + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/role_propagation/package.json b/sdk-output/role_propagation/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/role_propagation/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/role_propagation/tsconfig.json b/sdk-output/role_propagation/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/role_propagation/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/roles/.gitignore b/sdk-output/roles/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/roles/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/roles/.npmignore b/sdk-output/roles/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/roles/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/roles/.openapi-generator-ignore b/sdk-output/roles/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/roles/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/roles/.openapi-generator/FILES b/sdk-output/roles/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/roles/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/roles/.openapi-generator/VERSION b/sdk-output/roles/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/roles/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/roles/.sdk-partition b/sdk-output/roles/.sdk-partition new file mode 100644 index 00000000..6d194966 --- /dev/null +++ b/sdk-output/roles/.sdk-partition @@ -0,0 +1 @@ +roles \ No newline at end of file diff --git a/sdk-output/roles/README.md b/sdk-output/roles/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/roles/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/roles/api.ts b/sdk-output/roles/api.ts new file mode 100644 index 00000000..14ea3b0e --- /dev/null +++ b/sdk-output/roles/api.ts @@ -0,0 +1,3463 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Roles + * 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 AccessdurationV1 + */ +export interface AccessdurationV1 { + /** + * The numeric value representing the amount of time, which is defined in the **timeUnit**. + * @type {number} + * @memberof AccessdurationV1 + */ + 'value'?: number; + /** + * The unit of time that corresponds to the **value**. It defines the scale of the time period. + * @type {string} + * @memberof AccessdurationV1 + */ + 'timeUnit'?: AccessdurationV1TimeUnitV1; +} + +export const AccessdurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type AccessdurationV1TimeUnitV1 = typeof AccessdurationV1TimeUnitV1[keyof typeof AccessdurationV1TimeUnitV1]; + +/** + * Metadata that describes an access item + * @export + * @interface AccessmodelmetadataV1 + */ +export interface AccessmodelmetadataV1 { + /** + * Unique identifier for the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'key'?: string; + /** + * Human readable name of the metadata type + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'name'?: string; + /** + * Allows selecting multiple values + * @type {boolean} + * @memberof AccessmodelmetadataV1 + */ + 'multiselect'?: boolean; + /** + * The state of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'status'?: string; + /** + * The type of the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'type'?: string; + /** + * The types of objects + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'objectTypes'?: Array; + /** + * Describes the metadata item + * @type {string} + * @memberof AccessmodelmetadataV1 + */ + 'description'?: string; + /** + * The value to assign to the metadata item + * @type {Array} + * @memberof AccessmodelmetadataV1 + */ + 'values'?: Array; +} +/** + * An individual value to assign to the metadata item + * @export + * @interface AccessmodelmetadataValuesInnerV1 + */ +export interface AccessmodelmetadataValuesInnerV1 { + /** + * The value to assign to the metdata item + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'value'?: string; + /** + * Display name of the value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'name'?: string; + /** + * The status of the individual value + * @type {string} + * @memberof AccessmodelmetadataValuesInnerV1 + */ + 'status'?: string; +} +/** + * + * @export + * @interface AccessprofilerefV1 + */ +export interface AccessprofilerefV1 { + /** + * ID of the Access Profile + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'id'?: string; + /** + * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'type'?: AccessprofilerefV1TypeV1; + /** + * Human-readable display name of the Access Profile. This field is ignored on input. + * @type {string} + * @memberof AccessprofilerefV1 + */ + 'name'?: string; +} + +export const AccessprofilerefV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE' +} as const; + +export type AccessprofilerefV1TypeV1 = typeof AccessprofilerefV1TypeV1[keyof typeof AccessprofilerefV1TypeV1]; + +/** + * Reference to an additional owner (identity or governance group). + * @export + * @interface AdditionalownerrefV1 + */ +export interface AdditionalownerrefV1 { + /** + * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'type'?: AdditionalownerrefV1TypeV1; + /** + * ID of the identity or governance group. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'id'?: string; + /** + * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. + * @type {string} + * @memberof AdditionalownerrefV1 + */ + 'name'?: string | null; +} + +export const AdditionalownerrefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type AdditionalownerrefV1TypeV1 = typeof AdditionalownerrefV1TypeV1[keyof typeof AdditionalownerrefV1TypeV1]; + +/** + * + * @export + * @interface ApprovalschemeforroleV1 + */ +export interface ApprovalschemeforroleV1 { + /** + * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field + * @type {string} + * @memberof ApprovalschemeforroleV1 + */ + 'approverType'?: ApprovalschemeforroleV1ApproverTypeV1; + /** + * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. + * @type {string} + * @memberof ApprovalschemeforroleV1 + */ + 'approverId'?: string | null; +} + +export const ApprovalschemeforroleV1ApproverTypeV1 = { + Owner: 'OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW', + AllOwners: 'ALL_OWNERS', + AdditionalOwner: 'ADDITIONAL_OWNER', + AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' +} as const; + +export type ApprovalschemeforroleV1ApproverTypeV1 = typeof ApprovalschemeforroleV1ApproverTypeV1[keyof typeof ApprovalschemeforroleV1ApproverTypeV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface AttributedtoV1 + */ +export interface AttributedtoV1 { + /** + * Technical name of the Attribute. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributedtoV1 + */ + 'key'?: string; + /** + * The display name of the key. + * @type {string} + * @memberof AttributedtoV1 + */ + 'name'?: string; + /** + * Indicates whether the attribute can have multiple values. + * @type {boolean} + * @memberof AttributedtoV1 + */ + 'multiselect'?: boolean; + /** + * The status of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'status'?: string; + /** + * The type of the Attribute. This can be either \"custom\" or \"governance\". + * @type {string} + * @memberof AttributedtoV1 + */ + 'type'?: string; + /** + * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. + * @type {Array} + * @memberof AttributedtoV1 + */ + 'objectTypes'?: Array | null; + /** + * The description of the Attribute. + * @type {string} + * @memberof AttributedtoV1 + */ + 'description'?: string; + /** + * + * @type {Array} + * @memberof AttributedtoV1 + */ + 'values'?: Array | null; +} +/** + * + * @export + * @interface AttributedtolistV1 + */ +export interface AttributedtolistV1 { + /** + * + * @type {Array} + * @memberof AttributedtolistV1 + */ + 'attributes'?: Array | null; +} +/** + * + * @export + * @interface AttributevaluedtoV1 + */ +export interface AttributevaluedtoV1 { + /** + * Technical name of the Attribute value. This is unique and cannot be changed after creation. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'value'?: string; + /** + * The display name of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'name'?: string; + /** + * The status of the Attribute value. + * @type {string} + * @memberof AttributevaluedtoV1 + */ + 'status'?: string; +} +/** + * A dimension attribute + * @export + * @interface DimensionattributeV1 + */ +export interface DimensionattributeV1 { + /** + * Name of the attribute + * @type {string} + * @memberof DimensionattributeV1 + */ + 'name'?: string; + /** + * Display name of the attribute + * @type {string} + * @memberof DimensionattributeV1 + */ + 'displayName'?: string; + /** + * If an attribute is derived, its value comes from the identity. Otherwise, it can be provided with access request + * @type {boolean} + * @memberof DimensionattributeV1 + */ + 'derived'?: boolean; +} +/** + * + * @export + * @interface DimensionrefV1 + */ +export interface DimensionrefV1 { + /** + * The type of the object to which this reference applies + * @type {string} + * @memberof DimensionrefV1 + */ + 'type'?: DimensionrefV1TypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof DimensionrefV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof DimensionrefV1 + */ + 'name'?: string; +} + +export const DimensionrefV1TypeV1 = { + Dimension: 'DIMENSION' +} as const; + +export type DimensionrefV1TypeV1 = typeof DimensionrefV1TypeV1[keyof typeof DimensionrefV1TypeV1]; + +/** + * Contains a list of dimension attributes. Required only for Dynamic Roles + * @export + * @interface DimensionschemaV1 + */ +export interface DimensionschemaV1 { + /** + * + * @type {Array} + * @memberof DimensionschemaV1 + */ + 'dimensionAttributes'?: Array; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * Additional data to classify the entitlement + * @export + * @interface EntitlementAccessModelMetadataV1 + */ +export interface EntitlementAccessModelMetadataV1 { + /** + * + * @type {Array} + * @memberof EntitlementAccessModelMetadataV1 + */ + 'attributes'?: Array; +} +/** + * The identity that owns the entitlement + * @export + * @interface EntitlementOwnerV1 + */ +export interface EntitlementOwnerV1 { + /** + * The identity ID + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'id'?: string; + /** + * The type of object + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'type'?: EntitlementOwnerV1TypeV1; + /** + * The display name of the identity + * @type {string} + * @memberof EntitlementOwnerV1 + */ + 'name'?: string; +} + +export const EntitlementOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type EntitlementOwnerV1TypeV1 = typeof EntitlementOwnerV1TypeV1[keyof typeof EntitlementOwnerV1TypeV1]; + +/** + * + * @export + * @interface EntitlementSourceV1 + */ +export interface EntitlementSourceV1 { + /** + * The source ID + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'id'?: string; + /** + * The source type, will always be \"SOURCE\" + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'type'?: string; + /** + * The source name + * @type {string} + * @memberof EntitlementSourceV1 + */ + 'name'?: string; +} +/** + * + * @export + * @interface EntitlementV1 + */ +export interface EntitlementV1 { + /** + * The entitlement id + * @type {string} + * @memberof EntitlementV1 + */ + 'id'?: string; + /** + * The entitlement name + * @type {string} + * @memberof EntitlementV1 + */ + 'name'?: string; + /** + * The entitlement attribute name + * @type {string} + * @memberof EntitlementV1 + */ + 'attribute'?: string; + /** + * The value of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'value'?: string; + /** + * The object type of the entitlement from the source schema + * @type {string} + * @memberof EntitlementV1 + */ + 'sourceSchemaObjectType'?: string; + /** + * The description of the entitlement + * @type {string} + * @memberof EntitlementV1 + */ + 'description'?: string | null; + /** + * True if the entitlement is privileged + * @type {boolean} + * @memberof EntitlementV1 + */ + 'privileged'?: boolean; + /** + * True if the entitlement is cloud governed + * @type {boolean} + * @memberof EntitlementV1 + */ + 'cloudGoverned'?: boolean; + /** + * True if the entitlement is able to be directly requested + * @type {boolean} + * @memberof EntitlementV1 + */ + 'requestable'?: boolean; + /** + * + * @type {EntitlementOwnerV1} + * @memberof EntitlementV1 + */ + 'owner'?: EntitlementOwnerV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof EntitlementV1 + */ + 'additionalOwners'?: Array | null; + /** + * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'manuallyUpdatedFields'?: { [key: string]: any; } | null; + /** + * + * @type {EntitlementAccessModelMetadataV1} + * @memberof EntitlementV1 + */ + 'accessModelMetadata'?: EntitlementAccessModelMetadataV1; + /** + * Time when the entitlement was created + * @type {string} + * @memberof EntitlementV1 + */ + 'created'?: string; + /** + * Time when the entitlement was last modified + * @type {string} + * @memberof EntitlementV1 + */ + 'modified'?: string; + /** + * + * @type {EntitlementSourceV1} + * @memberof EntitlementV1 + */ + 'source'?: EntitlementSourceV1; + /** + * A map of free-form key-value pairs from the source system + * @type {{ [key: string]: any; }} + * @memberof EntitlementV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * List of IDs of segments, if any, to which this Entitlement is assigned. + * @type {Array} + * @memberof EntitlementV1 + */ + 'segments'?: Array | null; + /** + * + * @type {Array} + * @memberof EntitlementV1 + */ + 'directPermissions'?: Array; +} +/** + * Entitlement including a specific set of access. + * @export + * @interface EntitlementrefV1 + */ +export interface EntitlementrefV1 { + /** + * Entitlement\'s DTO type. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'type'?: EntitlementrefV1TypeV1; + /** + * Entitlement\'s ID. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'id'?: string; + /** + * Entitlement\'s display name. + * @type {string} + * @memberof EntitlementrefV1 + */ + 'name'?: string | null; +} + +export const EntitlementrefV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type EntitlementrefV1TypeV1 = typeof EntitlementrefV1TypeV1[keyof typeof EntitlementrefV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListRolesV1401ResponseV1 + */ +export interface ListRolesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListRolesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListRolesV1429ResponseV1 + */ +export interface ListRolesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListRolesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner of the object. + * @export + * @interface OwnerreferenceV1 + */ +export interface OwnerreferenceV1 { + /** + * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'type'?: OwnerreferenceV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'id'?: string; + /** + * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferenceV1 + */ + 'name'?: string; +} + +export const OwnerreferenceV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerreferenceV1TypeV1 = typeof OwnerreferenceV1TypeV1[keyof typeof OwnerreferenceV1TypeV1]; + +/** + * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. + * @export + * @interface PermissiondtoV1 + */ +export interface PermissiondtoV1 { + /** + * All the rights (e.g. actions) that this permission allows on the target + * @type {Array} + * @memberof PermissiondtoV1 + */ + 'rights'?: Array; + /** + * The target the permission would grants rights on. + * @type {string} + * @memberof PermissiondtoV1 + */ + 'target'?: string; +} +/** + * + * @export + * @interface RequestabilityforroleV1 + */ +export interface RequestabilityforroleV1 { + /** + * Whether the requester of the containing object must provide comments justifying the request + * @type {boolean} + * @memberof RequestabilityforroleV1 + */ + 'commentsRequired'?: boolean | null; + /** + * Whether an approver must provide comments when denying the request + * @type {boolean} + * @memberof RequestabilityforroleV1 + */ + 'denialCommentsRequired'?: boolean | null; + /** + * Indicates whether reauthorization is required for the request. + * @type {boolean} + * @memberof RequestabilityforroleV1 + */ + 'reauthorizationRequired'?: boolean | null; + /** + * Indicates whether the requester of the containing object must provide access end date. + * @type {boolean} + * @memberof RequestabilityforroleV1 + */ + 'requireEndDate'?: boolean; + /** + * + * @type {AccessdurationV1} + * @memberof RequestabilityforroleV1 + */ + 'maxPermittedAccessDuration'?: AccessdurationV1 | null; + /** + * List describing the steps in approving the request + * @type {Array} + * @memberof RequestabilityforroleV1 + */ + 'approvalSchemes'?: Array; + /** + * + * @type {DimensionschemaV1} + * @memberof RequestabilityforroleV1 + */ + 'dimensionSchema'?: DimensionschemaV1; + /** + * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. + * @type {string} + * @memberof RequestabilityforroleV1 + */ + 'formDefinitionId'?: string | null; +} +/** + * + * @export + * @interface RevocabilityforroleV1 + */ +export interface RevocabilityforroleV1 { + /** + * Whether the requester of the containing object must provide comments justifying the request + * @type {boolean} + * @memberof RevocabilityforroleV1 + */ + 'commentsRequired'?: boolean | null; + /** + * Whether an approver must provide comments when denying the request + * @type {boolean} + * @memberof RevocabilityforroleV1 + */ + 'denialCommentsRequired'?: boolean | null; + /** + * List describing the steps in approving the revocation request + * @type {Array} + * @memberof RevocabilityforroleV1 + */ + 'approvalSchemes'?: Array; +} +/** + * A Role + * @export + * @interface RoleV1 + */ +export interface RoleV1 { + /** + * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof RoleV1 + */ + 'id'?: string; + /** + * The human-readable display name of the Role + * @type {string} + * @memberof RoleV1 + */ + 'name': string; + /** + * Date the Role was created + * @type {string} + * @memberof RoleV1 + */ + 'created'?: string; + /** + * Date the Role was last modified. + * @type {string} + * @memberof RoleV1 + */ + 'modified'?: string; + /** + * A human-readable description of the Role + * @type {string} + * @memberof RoleV1 + */ + 'description'?: string | null; + /** + * + * @type {OwnerreferenceV1} + * @memberof RoleV1 + */ + 'owner': OwnerreferenceV1 | null; + /** + * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). + * @type {Array} + * @memberof RoleV1 + */ + 'additionalOwners'?: Array | null; + /** + * + * @type {Array} + * @memberof RoleV1 + */ + 'accessProfiles'?: Array | null; + /** + * + * @type {Array} + * @memberof RoleV1 + */ + 'entitlements'?: Array; + /** + * + * @type {RolemembershipselectorV1} + * @memberof RoleV1 + */ + 'membership'?: RolemembershipselectorV1 | null; + /** + * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. + * @type {{ [key: string]: any; }} + * @memberof RoleV1 + */ + 'legacyMembershipInfo'?: { [key: string]: any; } | null; + /** + * Whether the Role is enabled or not. + * @type {boolean} + * @memberof RoleV1 + */ + 'enabled'?: boolean; + /** + * Whether the Role can be the target of access requests. + * @type {boolean} + * @memberof RoleV1 + */ + 'requestable'?: boolean; + /** + * + * @type {RequestabilityforroleV1} + * @memberof RoleV1 + */ + 'accessRequestConfig'?: RequestabilityforroleV1; + /** + * + * @type {RevocabilityforroleV1} + * @memberof RoleV1 + */ + 'revocationRequestConfig'?: RevocabilityforroleV1; + /** + * List of IDs of segments, if any, to which this Role is assigned. + * @type {Array} + * @memberof RoleV1 + */ + 'segments'?: Array | null; + /** + * Whether the Role is dimensional. + * @type {boolean} + * @memberof RoleV1 + */ + 'dimensional'?: boolean | null; + /** + * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. + * @type {Array} + * @memberof RoleV1 + */ + 'dimensionRefs'?: Array | null; + /** + * + * @type {AttributedtolistV1} + * @memberof RoleV1 + */ + 'accessModelMetadata'?: AttributedtolistV1; + /** + * The privilege level of the role, if applicable. + * @type {string} + * @memberof RoleV1 + */ + 'privilegeLevel'?: string | null; +} +/** + * Type which indicates how a particular Identity obtained a particular Role + * @export + * @enum {string} + */ + +export const RoleassignmentsourcetypeV1 = { + AccessRequest: 'ACCESS_REQUEST', + RoleMembership: 'ROLE_MEMBERSHIP' +} as const; + +export type RoleassignmentsourcetypeV1 = typeof RoleassignmentsourcetypeV1[keyof typeof RoleassignmentsourcetypeV1]; + + +/** + * + * @export + * @interface RolebulkdeleterequestV1 + */ +export interface RolebulkdeleterequestV1 { + /** + * List of IDs of Roles to be deleted. + * @type {Array} + * @memberof RolebulkdeleterequestV1 + */ + 'roleIds': Array; +} +/** + * + * @export + * @interface RolebulkupdateresponseV1 + */ +export interface RolebulkupdateresponseV1 { + /** + * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. + * @type {string} + * @memberof RolebulkupdateresponseV1 + */ + 'id'?: string; + /** + * Type of the bulk update object. + * @type {string} + * @memberof RolebulkupdateresponseV1 + */ + 'type'?: string; + /** + * The status of the bulk update request, could also checked by getBulkUpdateStatus API + * @type {string} + * @memberof RolebulkupdateresponseV1 + */ + 'status'?: RolebulkupdateresponseV1StatusV1; + /** + * Time when the bulk update request was created + * @type {string} + * @memberof RolebulkupdateresponseV1 + */ + 'created'?: string; +} + +export const RolebulkupdateresponseV1StatusV1 = { + Created: 'CREATED', + PreProcess: 'PRE_PROCESS', + PreProcessCompleted: 'PRE_PROCESS_COMPLETED', + PostProcess: 'POST_PROCESS', + Completed: 'COMPLETED', + ChunkPending: 'CHUNK_PENDING', + ChunkProcessing: 'CHUNK_PROCESSING' +} as const; + +export type RolebulkupdateresponseV1StatusV1 = typeof RolebulkupdateresponseV1StatusV1[keyof typeof RolebulkupdateresponseV1StatusV1]; + +/** + * Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + * @export + * @interface RolecriteriakeyV1 + */ +export interface RolecriteriakeyV1 { + /** + * + * @type {RolecriteriakeytypeV1} + * @memberof RolecriteriakeyV1 + */ + 'type': RolecriteriakeytypeV1; + /** + * The name of the attribute or entitlement to which the associated criteria applies. + * @type {string} + * @memberof RolecriteriakeyV1 + */ + 'property': string; + /** + * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT + * @type {string} + * @memberof RolecriteriakeyV1 + */ + 'sourceId'?: string | null; +} + + +/** + * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. + * @export + * @enum {string} + */ + +export const RolecriteriakeytypeV1 = { + Identity: 'IDENTITY', + Account: 'ACCOUNT', + Entitlement: 'ENTITLEMENT' +} as const; + +export type RolecriteriakeytypeV1 = typeof RolecriteriakeytypeV1[keyof typeof RolecriteriakeytypeV1]; + + +/** + * Defines STANDARD type Role membership + * @export + * @interface Rolecriterialevel1V1 + */ +export interface Rolecriterialevel1V1 { + /** + * + * @type {RolecriteriaoperationV1} + * @memberof Rolecriterialevel1V1 + */ + 'operation'?: RolecriteriaoperationV1; + /** + * + * @type {RolecriteriakeyV1} + * @memberof Rolecriterialevel1V1 + */ + 'key'?: RolecriteriakeyV1 | null; + /** + * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Rolecriterialevel1V1 + */ + 'stringValue'?: string | null; + /** + * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + * @type {Array} + * @memberof Rolecriterialevel1V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines STANDARD type Role membership + * @export + * @interface Rolecriterialevel2V1 + */ +export interface Rolecriterialevel2V1 { + /** + * + * @type {RolecriteriaoperationV1} + * @memberof Rolecriterialevel2V1 + */ + 'operation'?: RolecriteriaoperationV1; + /** + * + * @type {RolecriteriakeyV1} + * @memberof Rolecriterialevel2V1 + */ + 'key'?: RolecriteriakeyV1 | null; + /** + * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Rolecriterialevel2V1 + */ + 'stringValue'?: string | null; + /** + * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. + * @type {Array} + * @memberof Rolecriterialevel2V1 + */ + 'children'?: Array | null; +} + + +/** + * Defines STANDARD type Role membership + * @export + * @interface Rolecriterialevel3V1 + */ +export interface Rolecriterialevel3V1 { + /** + * + * @type {RolecriteriaoperationV1} + * @memberof Rolecriterialevel3V1 + */ + 'operation'?: RolecriteriaoperationV1; + /** + * + * @type {RolecriteriakeyV1} + * @memberof Rolecriterialevel3V1 + */ + 'key'?: RolecriteriakeyV1 | null; + /** + * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. + * @type {string} + * @memberof Rolecriterialevel3V1 + */ + 'stringValue'?: string | null; +} + + +/** + * An operation + * @export + * @enum {string} + */ + +export const RolecriteriaoperationV1 = { + Equals: 'EQUALS', + NotEquals: 'NOT_EQUALS', + Contains: 'CONTAINS', + DoesNotContain: 'DOES_NOT_CONTAIN', + StartsWith: 'STARTS_WITH', + EndsWith: 'ENDS_WITH', + GreaterThan: 'GREATER_THAN', + LessThan: 'LESS_THAN', + GreaterThanEquals: 'GREATER_THAN_EQUALS', + LessThanEquals: 'LESS_THAN_EQUALS', + And: 'AND', + Or: 'OR' +} as const; + +export type RolecriteriaoperationV1 = typeof RolecriteriaoperationV1[keyof typeof RolecriteriaoperationV1]; + + +/** + * + * @export + * @interface RolegetallbulkupdateresponseV1 + */ +export interface RolegetallbulkupdateresponseV1 { + /** + * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. + * @type {string} + * @memberof RolegetallbulkupdateresponseV1 + */ + 'id'?: string; + /** + * Type of the bulk update object. + * @type {string} + * @memberof RolegetallbulkupdateresponseV1 + */ + 'type'?: string; + /** + * The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API + * @type {string} + * @memberof RolegetallbulkupdateresponseV1 + */ + 'status'?: RolegetallbulkupdateresponseV1StatusV1; + /** + * Time when the bulk update request was created + * @type {string} + * @memberof RolegetallbulkupdateresponseV1 + */ + 'created'?: string; +} + +export const RolegetallbulkupdateresponseV1StatusV1 = { + Created: 'CREATED', + PreProcess: 'PRE_PROCESS', + PostProcess: 'POST_PROCESS', + ChunkPending: 'CHUNK_PENDING', + ChunkProcessing: 'CHUNK_PROCESSING' +} as const; + +export type RolegetallbulkupdateresponseV1StatusV1 = typeof RolegetallbulkupdateresponseV1StatusV1[keyof typeof RolegetallbulkupdateresponseV1StatusV1]; + +/** + * A subset of the fields of an Identity which is a member of a Role. + * @export + * @interface RoleidentityV1 + */ +export interface RoleidentityV1 { + /** + * The ID of the Identity + * @type {string} + * @memberof RoleidentityV1 + */ + 'id'?: string; + /** + * The alias / username of the Identity + * @type {string} + * @memberof RoleidentityV1 + */ + 'aliasName'?: string; + /** + * The human-readable display name of the Identity + * @type {string} + * @memberof RoleidentityV1 + */ + 'name'?: string; + /** + * Email address of the Identity + * @type {string} + * @memberof RoleidentityV1 + */ + 'email'?: string; + /** + * + * @type {RoleassignmentsourcetypeV1} + * @memberof RoleidentityV1 + */ + 'roleAssignmentSource'?: RoleassignmentsourcetypeV1; +} + + +/** + * + * @export + * @interface RolelistfilterdtoAmmKeyValuesInnerV1 + */ +export interface RolelistfilterdtoAmmKeyValuesInnerV1 { + /** + * attribute key of a metadata. + * @type {string} + * @memberof RolelistfilterdtoAmmKeyValuesInnerV1 + */ + 'attribute'?: string; + /** + * A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. + * @type {Array} + * @memberof RolelistfilterdtoAmmKeyValuesInnerV1 + */ + 'values'?: Array; +} +/** + * AMMFilterValues + * @export + * @interface RolelistfilterdtoV1 + */ +export interface RolelistfilterdtoV1 { + /** + * 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + * @type {string} + * @memberof RolelistfilterdtoV1 + */ + 'filters'?: string | null; + /** + * + * @type {Array} + * @memberof RolelistfilterdtoV1 + */ + 'ammKeyValues'?: Array | null; +} +/** + * A reference to an Identity in an IDENTITY_LIST role membership criteria. + * @export + * @interface RolemembershipidentityV1 + */ +export interface RolemembershipidentityV1 { + /** + * + * @type {DtotypeV1} + * @memberof RolemembershipidentityV1 + */ + 'type'?: DtotypeV1; + /** + * Identity id + * @type {string} + * @memberof RolemembershipidentityV1 + */ + 'id'?: string; + /** + * Human-readable display name of the Identity. + * @type {string} + * @memberof RolemembershipidentityV1 + */ + 'name'?: string | null; + /** + * User name of the Identity + * @type {string} + * @memberof RolemembershipidentityV1 + */ + 'aliasName'?: string | null; +} + + +/** + * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. + * @export + * @interface RolemembershipselectorV1 + */ +export interface RolemembershipselectorV1 { + /** + * + * @type {RolemembershipselectortypeV1} + * @memberof RolemembershipselectorV1 + */ + 'type'?: RolemembershipselectortypeV1; + /** + * + * @type {Rolecriterialevel1V1} + * @memberof RolemembershipselectorV1 + */ + 'criteria'?: Rolecriterialevel1V1 | null; + /** + * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + * @type {Array} + * @memberof RolemembershipselectorV1 + */ + 'identities'?: Array | null; +} + + +/** + * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed + * @export + * @enum {string} + */ + +export const RolemembershipselectortypeV1 = { + Standard: 'STANDARD', + IdentityList: 'IDENTITY_LIST' +} as const; + +export type RolemembershipselectortypeV1 = typeof RolemembershipselectortypeV1[keyof typeof RolemembershipselectortypeV1]; + + +/** + * This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. + * @export + * @interface RolemetadatabulkupdatebyfilterrequestV1 + */ +export interface RolemetadatabulkupdatebyfilterrequestV1 { + /** + * Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* + * @type {string} + * @memberof RolemetadatabulkupdatebyfilterrequestV1 + */ + 'filters': string; + /** + * The operation to be performed + * @type {string} + * @memberof RolemetadatabulkupdatebyfilterrequestV1 + */ + 'operation': RolemetadatabulkupdatebyfilterrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof RolemetadatabulkupdatebyfilterrequestV1 + */ + 'replaceScope'?: RolemetadatabulkupdatebyfilterrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute key and value. + * @type {Array} + * @memberof RolemetadatabulkupdatebyfilterrequestV1 + */ + 'values': Array; +} + +export const RolemetadatabulkupdatebyfilterrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type RolemetadatabulkupdatebyfilterrequestV1OperationV1 = typeof RolemetadatabulkupdatebyfilterrequestV1OperationV1[keyof typeof RolemetadatabulkupdatebyfilterrequestV1OperationV1]; +export const RolemetadatabulkupdatebyfilterrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type RolemetadatabulkupdatebyfilterrequestV1ReplaceScopeV1 = typeof RolemetadatabulkupdatebyfilterrequestV1ReplaceScopeV1[keyof typeof RolemetadatabulkupdatebyfilterrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface RolemetadatabulkupdatebyfilterrequestValuesInnerV1 + */ +export interface RolemetadatabulkupdatebyfilterrequestValuesInnerV1 { + /** + * the key of metadata attribute + * @type {string} + * @memberof RolemetadatabulkupdatebyfilterrequestValuesInnerV1 + */ + 'attributeKey'?: string; + /** + * the values of attribute to be updated + * @type {Array} + * @memberof RolemetadatabulkupdatebyfilterrequestValuesInnerV1 + */ + 'values': Array | null; +} +/** + * This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. + * @export + * @interface RolemetadatabulkupdatebyidrequestV1 + */ +export interface RolemetadatabulkupdatebyidrequestV1 { + /** + * Roles\' Id to be updated + * @type {Array} + * @memberof RolemetadatabulkupdatebyidrequestV1 + */ + 'roles': Array; + /** + * The operation to be performed + * @type {string} + * @memberof RolemetadatabulkupdatebyidrequestV1 + */ + 'operation': RolemetadatabulkupdatebyidrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof RolemetadatabulkupdatebyidrequestV1 + */ + 'replaceScope'?: RolemetadatabulkupdatebyidrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute key and value. + * @type {Array} + * @memberof RolemetadatabulkupdatebyidrequestV1 + */ + 'values': Array; +} + +export const RolemetadatabulkupdatebyidrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type RolemetadatabulkupdatebyidrequestV1OperationV1 = typeof RolemetadatabulkupdatebyidrequestV1OperationV1[keyof typeof RolemetadatabulkupdatebyidrequestV1OperationV1]; +export const RolemetadatabulkupdatebyidrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type RolemetadatabulkupdatebyidrequestV1ReplaceScopeV1 = typeof RolemetadatabulkupdatebyidrequestV1ReplaceScopeV1[keyof typeof RolemetadatabulkupdatebyidrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface RolemetadatabulkupdatebyidrequestValuesInnerV1 + */ +export interface RolemetadatabulkupdatebyidrequestValuesInnerV1 { + /** + * the key of metadata attribute + * @type {string} + * @memberof RolemetadatabulkupdatebyidrequestValuesInnerV1 + */ + 'attribute': string; + /** + * the values of attribute to be updated + * @type {Array} + * @memberof RolemetadatabulkupdatebyidrequestValuesInnerV1 + */ + 'values': Array | null; +} +/** + * Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) + * @export + * @interface RolemetadatabulkupdatebyqueryrequestV1 + */ +export interface RolemetadatabulkupdatebyqueryrequestV1 { + /** + * query the identities to be updated + * @type {object} + * @memberof RolemetadatabulkupdatebyqueryrequestV1 + */ + 'query': object; + /** + * The operation to be performed + * @type {string} + * @memberof RolemetadatabulkupdatebyqueryrequestV1 + */ + 'operation': RolemetadatabulkupdatebyqueryrequestV1OperationV1; + /** + * The choice of update scope. + * @type {string} + * @memberof RolemetadatabulkupdatebyqueryrequestV1 + */ + 'replaceScope'?: RolemetadatabulkupdatebyqueryrequestV1ReplaceScopeV1; + /** + * The metadata to be updated, including attribute key and value. + * @type {Array} + * @memberof RolemetadatabulkupdatebyqueryrequestV1 + */ + 'values': Array; +} + +export const RolemetadatabulkupdatebyqueryrequestV1OperationV1 = { + Add: 'ADD', + Remove: 'REMOVE', + Replace: 'REPLACE' +} as const; + +export type RolemetadatabulkupdatebyqueryrequestV1OperationV1 = typeof RolemetadatabulkupdatebyqueryrequestV1OperationV1[keyof typeof RolemetadatabulkupdatebyqueryrequestV1OperationV1]; +export const RolemetadatabulkupdatebyqueryrequestV1ReplaceScopeV1 = { + All: 'ALL', + Attribute: 'ATTRIBUTE' +} as const; + +export type RolemetadatabulkupdatebyqueryrequestV1ReplaceScopeV1 = typeof RolemetadatabulkupdatebyqueryrequestV1ReplaceScopeV1[keyof typeof RolemetadatabulkupdatebyqueryrequestV1ReplaceScopeV1]; + +/** + * + * @export + * @interface RolemetadatabulkupdatebyqueryrequestValuesInnerV1 + */ +export interface RolemetadatabulkupdatebyqueryrequestValuesInnerV1 { + /** + * the key of metadata attribute + * @type {string} + * @memberof RolemetadatabulkupdatebyqueryrequestValuesInnerV1 + */ + 'attributeKey'?: string; + /** + * the values of attribute to be updated + * @type {Array} + * @memberof RolemetadatabulkupdatebyqueryrequestValuesInnerV1 + */ + 'attributeValue'?: Array; +} +/** + * Task result. + * @export + * @interface TaskresultdtoV1 + */ +export interface TaskresultdtoV1 { + /** + * Task result DTO type. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'type'?: TaskresultdtoV1TypeV1; + /** + * Task result ID. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'id'?: string; + /** + * Task result display name. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'name'?: string | null; +} + +export const TaskresultdtoV1TypeV1 = { + TaskResult: 'TASK_RESULT' +} as const; + +export type TaskresultdtoV1TypeV1 = typeof TaskresultdtoV1TypeV1[keyof typeof TaskresultdtoV1TypeV1]; + + +/** + * RolesV1Api - axios parameter creator + * @export + */ +export const RolesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + * @summary Create a role + * @param {RoleV1} roleV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createRoleV1: async (roleV1: RoleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'roleV1' is not null or undefined + assertParamExists('createRoleV1', 'roleV1', roleV1) + const localVarPath = `/roles/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(roleV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete role(s) + * @param {RolebulkdeleterequestV1} rolebulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBulkRolesV1: async (rolebulkdeleterequestV1: RolebulkdeleterequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolebulkdeleterequestV1' is not null or undefined + assertParamExists('deleteBulkRolesV1', 'rolebulkdeleterequestV1', rolebulkdeleterequestV1) + const localVarPath = `/roles/v1/bulk-delete`; + // 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(rolebulkdeleterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Remove a metadata from role. + * @param {string} id The role\'s id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMetadataFromRoleByKeyAndValueV1: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteMetadataFromRoleByKeyAndValueV1', 'id', id) + // verify required parameter 'attributeKey' is not null or undefined + assertParamExists('deleteMetadataFromRoleByKeyAndValueV1', 'attributeKey', attributeKey) + // verify required parameter 'attributeValue' is not null or undefined + assertParamExists('deleteMetadataFromRoleByKeyAndValueV1', 'attributeValue', attributeValue) + const localVarPath = `/roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) + .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a role + * @param {string} id ID of the Role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteRoleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteRoleV1', 'id', id) + const localVarPath = `/roles/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, + }; + }, + /** + * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Get bulk-update status by id + * @param {string} id The Id of the bulk update task. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBulkUpdateStatusByIdV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getBulkUpdateStatusByIdV1', 'id', id) + const localVarPath = `/roles/v1/access-model-metadata/bulk-update/id` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of all unfinished bulk update process status of the tenant. + * @summary Get bulk-update statuses + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBulkUpdateStatusV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/roles/v1/access-model-metadata/bulk-update`; + // 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, + }; + }, + /** + * + * @summary List identities assigned a role + * @param {string} id ID of the Role for which the assigned Identities are to be listed + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + * @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, name, aliasName, email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignedIdentitiesV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getRoleAssignedIdentitiesV1', 'id', id) + const localVarPath = `/roles/v1/{id}/assigned-identities` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Get a list of entitlements associated with a specified role. + * @summary List role\'s entitlements + * @param {string} id Containing role\'s ID. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, attribute, value, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleEntitlementsV1: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getRoleEntitlementsV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/roles/v1/{id}/entitlements` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a role + * @param {string} id ID of the Role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getRoleV1', 'id', id) + const localVarPath = `/roles/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, + }; + }, + /** + * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List roles + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* + * @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: **name, created, modified** + * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listRolesV1: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/roles/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 (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (forSegmentIds !== undefined) { + localVarQueryParameter['for-segment-ids'] = forSegmentIds; + } + + if (includeUnsegmented !== undefined) { + localVarQueryParameter['include-unsegmented'] = includeUnsegmented; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified role + * @param {string} id ID of the Role to patch + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchRoleV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchRoleV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchRoleV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/roles/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + * @summary Filter roles by metadata + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @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: **name, created, modified** + * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @param {RolelistfilterdtoV1} [rolelistfilterdtoV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchRolesByFilterV1: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, rolelistfilterdtoV1?: RolelistfilterdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/roles/v1/filter`; + // 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; + + if (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (forSegmentIds !== undefined) { + localVarQueryParameter['for-segment-ids'] = forSegmentIds; + } + + if (includeUnsegmented !== undefined) { + localVarQueryParameter['include-unsegmented'] = includeUnsegmented; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(rolelistfilterdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + * @summary Add a metadata to role. + * @param {string} id The Id of a role + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAttributeKeyAndValueToRoleV1: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateAttributeKeyAndValueToRoleV1', 'id', id) + // verify required parameter 'attributeKey' is not null or undefined + assertParamExists('updateAttributeKeyAndValueToRoleV1', 'attributeKey', attributeKey) + // verify required parameter 'attributeValue' is not null or undefined + assertParamExists('updateAttributeKeyAndValueToRoleV1', 'attributeValue', attributeValue) + const localVarPath = `/roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) + .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by filters + * @param {RolemetadatabulkupdatebyfilterrequestV1} rolemetadatabulkupdatebyfilterrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByFilterV1: async (rolemetadatabulkupdatebyfilterrequestV1: RolemetadatabulkupdatebyfilterrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolemetadatabulkupdatebyfilterrequestV1' is not null or undefined + assertParamExists('updateRolesMetadataByFilterV1', 'rolemetadatabulkupdatebyfilterrequestV1', rolemetadatabulkupdatebyfilterrequestV1) + const localVarPath = `/roles/v1/access-model-metadata/bulk-update/filter`; + // 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(rolemetadatabulkupdatebyfilterrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by id + * @param {RolemetadatabulkupdatebyidrequestV1} rolemetadatabulkupdatebyidrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByIdsV1: async (rolemetadatabulkupdatebyidrequestV1: RolemetadatabulkupdatebyidrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolemetadatabulkupdatebyidrequestV1' is not null or undefined + assertParamExists('updateRolesMetadataByIdsV1', 'rolemetadatabulkupdatebyidrequestV1', rolemetadatabulkupdatebyidrequestV1) + const localVarPath = `/roles/v1/access-model-metadata/bulk-update/ids`; + // 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(rolemetadatabulkupdatebyidrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by query + * @param {RolemetadatabulkupdatebyqueryrequestV1} rolemetadatabulkupdatebyqueryrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByQueryV1: async (rolemetadatabulkupdatebyqueryrequestV1: RolemetadatabulkupdatebyqueryrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'rolemetadatabulkupdatebyqueryrequestV1' is not null or undefined + assertParamExists('updateRolesMetadataByQueryV1', 'rolemetadatabulkupdatebyqueryrequestV1', rolemetadatabulkupdatebyqueryrequestV1) + const localVarPath = `/roles/v1/access-model-metadata/bulk-update/query`; + // 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(rolemetadatabulkupdatebyqueryrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * RolesV1Api - functional programming interface + * @export + */ +export const RolesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RolesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + * @summary Create a role + * @param {RoleV1} roleV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createRoleV1(roleV1: RoleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleV1(roleV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.createRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete role(s) + * @param {RolebulkdeleterequestV1} rolebulkdeleterequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteBulkRolesV1(rolebulkdeleterequestV1: RolebulkdeleterequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRolesV1(rolebulkdeleterequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.deleteBulkRolesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Remove a metadata from role. + * @param {string} id The role\'s id. + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteMetadataFromRoleByKeyAndValueV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetadataFromRoleByKeyAndValueV1(id, attributeKey, attributeValue, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.deleteMetadataFromRoleByKeyAndValueV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a role + * @param {string} id ID of the Role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteRoleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRoleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.deleteRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Get bulk-update status by id + * @param {string} id The Id of the bulk update task. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getBulkUpdateStatusByIdV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatusByIdV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.getBulkUpdateStatusByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all unfinished bulk update process status of the tenant. + * @summary Get bulk-update statuses + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getBulkUpdateStatusV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatusV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.getBulkUpdateStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary List identities assigned a role + * @param {string} id ID of the Role for which the assigned Identities are to be listed + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + * @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, name, aliasName, email** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleAssignedIdentitiesV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentitiesV1(id, limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.getRoleAssignedIdentitiesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of entitlements associated with a specified role. + * @summary List role\'s entitlements + * @param {string} id Containing role\'s ID. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @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: **name, attribute, value, created, modified** + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleEntitlementsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleEntitlementsV1(id, limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.getRoleEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a role + * @param {string} id ID of the Role + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getRoleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.getRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List roles + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* + * @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: **name, created, modified** + * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listRolesV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listRolesV1(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.listRolesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified role + * @param {string} id ID of the Role to patch + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchRoleV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.patchRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + * @summary Filter roles by metadata + * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @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: **name, created, modified** + * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @param {RolelistfilterdtoV1} [rolelistfilterdtoV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchRolesByFilterV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, rolelistfilterdtoV1?: RolelistfilterdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchRolesByFilterV1(forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, rolelistfilterdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.searchRolesByFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + * @summary Add a metadata to role. + * @param {string} id The Id of a role + * @param {string} attributeKey Technical name of the Attribute. + * @param {string} attributeValue Technical name of the Attribute Value. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAttributeKeyAndValueToRoleV1(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAttributeKeyAndValueToRoleV1(id, attributeKey, attributeValue, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.updateAttributeKeyAndValueToRoleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by filters + * @param {RolemetadatabulkupdatebyfilterrequestV1} rolemetadatabulkupdatebyfilterrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateRolesMetadataByFilterV1(rolemetadatabulkupdatebyfilterrequestV1: RolemetadatabulkupdatebyfilterrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByFilterV1(rolemetadatabulkupdatebyfilterrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.updateRolesMetadataByFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by id + * @param {RolemetadatabulkupdatebyidrequestV1} rolemetadatabulkupdatebyidrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateRolesMetadataByIdsV1(rolemetadatabulkupdatebyidrequestV1: RolemetadatabulkupdatebyidrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByIdsV1(rolemetadatabulkupdatebyidrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.updateRolesMetadataByIdsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by query + * @param {RolemetadatabulkupdatebyqueryrequestV1} rolemetadatabulkupdatebyqueryrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateRolesMetadataByQueryV1(rolemetadatabulkupdatebyqueryrequestV1: RolemetadatabulkupdatebyqueryrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByQueryV1(rolemetadatabulkupdatebyqueryrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RolesV1Api.updateRolesMetadataByQueryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RolesV1Api - factory interface + * @export + */ +export const RolesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RolesV1ApiFp(configuration) + return { + /** + * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + * @summary Create a role + * @param {RolesV1ApiCreateRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createRoleV1(requestParameters: RolesV1ApiCreateRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createRoleV1(requestParameters.roleV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete role(s) + * @param {RolesV1ApiDeleteBulkRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteBulkRolesV1(requestParameters: RolesV1ApiDeleteBulkRolesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteBulkRolesV1(requestParameters.rolebulkdeleterequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Remove a metadata from role. + * @param {RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteMetadataFromRoleByKeyAndValueV1(requestParameters: RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMetadataFromRoleByKeyAndValueV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a role + * @param {RolesV1ApiDeleteRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteRoleV1(requestParameters: RolesV1ApiDeleteRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteRoleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Get bulk-update status by id + * @param {RolesV1ApiGetBulkUpdateStatusByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBulkUpdateStatusByIdV1(requestParameters: RolesV1ApiGetBulkUpdateStatusByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getBulkUpdateStatusByIdV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all unfinished bulk update process status of the tenant. + * @summary Get bulk-update statuses + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getBulkUpdateStatusV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getBulkUpdateStatusV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary List identities assigned a role + * @param {RolesV1ApiGetRoleAssignedIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleAssignedIdentitiesV1(requestParameters: RolesV1ApiGetRoleAssignedIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleAssignedIdentitiesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of entitlements associated with a specified role. + * @summary List role\'s entitlements + * @param {RolesV1ApiGetRoleEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleEntitlementsV1(requestParameters: RolesV1ApiGetRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getRoleEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a role + * @param {RolesV1ApiGetRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getRoleV1(requestParameters: RolesV1ApiGetRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getRoleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List roles + * @param {RolesV1ApiListRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listRolesV1(requestParameters: RolesV1ApiListRolesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listRolesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified role + * @param {RolesV1ApiPatchRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchRoleV1(requestParameters: RolesV1ApiPatchRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchRoleV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + * @summary Filter roles by metadata + * @param {RolesV1ApiSearchRolesByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchRolesByFilterV1(requestParameters: RolesV1ApiSearchRolesByFilterV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.searchRolesByFilterV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.rolelistfilterdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + * @summary Add a metadata to role. + * @param {RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAttributeKeyAndValueToRoleV1(requestParameters: RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAttributeKeyAndValueToRoleV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by filters + * @param {RolesV1ApiUpdateRolesMetadataByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByFilterV1(requestParameters: RolesV1ApiUpdateRolesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateRolesMetadataByFilterV1(requestParameters.rolemetadatabulkupdatebyfilterrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by id + * @param {RolesV1ApiUpdateRolesMetadataByIdsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByIdsV1(requestParameters: RolesV1ApiUpdateRolesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateRolesMetadataByIdsV1(requestParameters.rolemetadatabulkupdatebyidrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by query + * @param {RolesV1ApiUpdateRolesMetadataByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateRolesMetadataByQueryV1(requestParameters: RolesV1ApiUpdateRolesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateRolesMetadataByQueryV1(requestParameters.rolemetadatabulkupdatebyqueryrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createRoleV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiCreateRoleV1Request + */ +export interface RolesV1ApiCreateRoleV1Request { + /** + * + * @type {RoleV1} + * @memberof RolesV1ApiCreateRoleV1 + */ + readonly roleV1: RoleV1 +} + +/** + * Request parameters for deleteBulkRolesV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiDeleteBulkRolesV1Request + */ +export interface RolesV1ApiDeleteBulkRolesV1Request { + /** + * + * @type {RolebulkdeleterequestV1} + * @memberof RolesV1ApiDeleteBulkRolesV1 + */ + readonly rolebulkdeleterequestV1: RolebulkdeleterequestV1 +} + +/** + * Request parameters for deleteMetadataFromRoleByKeyAndValueV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request + */ +export interface RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request { + /** + * The role\'s id. + * @type {string} + * @memberof RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1 + */ + readonly id: string + + /** + * Technical name of the Attribute. + * @type {string} + * @memberof RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1 + */ + readonly attributeKey: string + + /** + * Technical name of the Attribute Value. + * @type {string} + * @memberof RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1 + */ + readonly attributeValue: string +} + +/** + * Request parameters for deleteRoleV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiDeleteRoleV1Request + */ +export interface RolesV1ApiDeleteRoleV1Request { + /** + * ID of the Role + * @type {string} + * @memberof RolesV1ApiDeleteRoleV1 + */ + readonly id: string +} + +/** + * Request parameters for getBulkUpdateStatusByIdV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiGetBulkUpdateStatusByIdV1Request + */ +export interface RolesV1ApiGetBulkUpdateStatusByIdV1Request { + /** + * The Id of the bulk update task. + * @type {string} + * @memberof RolesV1ApiGetBulkUpdateStatusByIdV1 + */ + readonly id: string +} + +/** + * Request parameters for getRoleAssignedIdentitiesV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiGetRoleAssignedIdentitiesV1Request + */ +export interface RolesV1ApiGetRoleAssignedIdentitiesV1Request { + /** + * ID of the Role for which the assigned Identities are to be listed + * @type {string} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + * @type {string} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + 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, name, aliasName, email** + * @type {string} + * @memberof RolesV1ApiGetRoleAssignedIdentitiesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getRoleEntitlementsV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiGetRoleEntitlementsV1Request + */ +export interface RolesV1ApiGetRoleEntitlementsV1Request { + /** + * Containing role\'s ID. + * @type {string} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + readonly id: string + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + * @type {string} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + 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: **name, attribute, value, created, modified** + * @type {string} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + readonly sorters?: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof RolesV1ApiGetRoleEntitlementsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getRoleV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiGetRoleV1Request + */ +export interface RolesV1ApiGetRoleV1Request { + /** + * ID of the Role + * @type {string} + * @memberof RolesV1ApiGetRoleV1 + */ + readonly id: string +} + +/** + * Request parameters for listRolesV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiListRolesV1Request + */ +export interface RolesV1ApiListRolesV1Request { + /** + * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @type {string} + * @memberof RolesV1ApiListRolesV1 + */ + readonly forSubadmin?: string + + /** + * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiListRolesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiListRolesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof RolesV1ApiListRolesV1 + */ + 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* + * @type {string} + * @memberof RolesV1ApiListRolesV1 + */ + 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: **name, created, modified** + * @type {string} + * @memberof RolesV1ApiListRolesV1 + */ + readonly sorters?: string + + /** + * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @type {string} + * @memberof RolesV1ApiListRolesV1 + */ + readonly forSegmentIds?: string + + /** + * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @type {boolean} + * @memberof RolesV1ApiListRolesV1 + */ + readonly includeUnsegmented?: boolean +} + +/** + * Request parameters for patchRoleV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiPatchRoleV1Request + */ +export interface RolesV1ApiPatchRoleV1Request { + /** + * ID of the Role to patch + * @type {string} + * @memberof RolesV1ApiPatchRoleV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof RolesV1ApiPatchRoleV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for searchRolesByFilterV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiSearchRolesByFilterV1Request + */ +export interface RolesV1ApiSearchRolesByFilterV1Request { + /** + * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + * @type {string} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly forSubadmin?: string + + /** + * Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly offset?: number + + /** + * Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly count?: boolean + + /** + * 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: **name, created, modified** + * @type {string} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly sorters?: string + + /** + * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + * @type {string} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly forSegmentIds?: string + + /** + * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + * @type {boolean} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly includeUnsegmented?: boolean + + /** + * + * @type {RolelistfilterdtoV1} + * @memberof RolesV1ApiSearchRolesByFilterV1 + */ + readonly rolelistfilterdtoV1?: RolelistfilterdtoV1 +} + +/** + * Request parameters for updateAttributeKeyAndValueToRoleV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request + */ +export interface RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request { + /** + * The Id of a role + * @type {string} + * @memberof RolesV1ApiUpdateAttributeKeyAndValueToRoleV1 + */ + readonly id: string + + /** + * Technical name of the Attribute. + * @type {string} + * @memberof RolesV1ApiUpdateAttributeKeyAndValueToRoleV1 + */ + readonly attributeKey: string + + /** + * Technical name of the Attribute Value. + * @type {string} + * @memberof RolesV1ApiUpdateAttributeKeyAndValueToRoleV1 + */ + readonly attributeValue: string +} + +/** + * Request parameters for updateRolesMetadataByFilterV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiUpdateRolesMetadataByFilterV1Request + */ +export interface RolesV1ApiUpdateRolesMetadataByFilterV1Request { + /** + * + * @type {RolemetadatabulkupdatebyfilterrequestV1} + * @memberof RolesV1ApiUpdateRolesMetadataByFilterV1 + */ + readonly rolemetadatabulkupdatebyfilterrequestV1: RolemetadatabulkupdatebyfilterrequestV1 +} + +/** + * Request parameters for updateRolesMetadataByIdsV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiUpdateRolesMetadataByIdsV1Request + */ +export interface RolesV1ApiUpdateRolesMetadataByIdsV1Request { + /** + * + * @type {RolemetadatabulkupdatebyidrequestV1} + * @memberof RolesV1ApiUpdateRolesMetadataByIdsV1 + */ + readonly rolemetadatabulkupdatebyidrequestV1: RolemetadatabulkupdatebyidrequestV1 +} + +/** + * Request parameters for updateRolesMetadataByQueryV1 operation in RolesV1Api. + * @export + * @interface RolesV1ApiUpdateRolesMetadataByQueryV1Request + */ +export interface RolesV1ApiUpdateRolesMetadataByQueryV1Request { + /** + * + * @type {RolemetadatabulkupdatebyqueryrequestV1} + * @memberof RolesV1ApiUpdateRolesMetadataByQueryV1 + */ + readonly rolemetadatabulkupdatebyqueryrequestV1: RolemetadatabulkupdatebyqueryrequestV1 +} + +/** + * RolesV1Api - object-oriented interface + * @export + * @class RolesV1Api + * @extends {BaseAPI} + */ +export class RolesV1Api extends BaseAPI { + /** + * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + * @summary Create a role + * @param {RolesV1ApiCreateRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public createRoleV1(requestParameters: RolesV1ApiCreateRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).createRoleV1(requestParameters.roleV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + * @summary Delete role(s) + * @param {RolesV1ApiDeleteBulkRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public deleteBulkRolesV1(requestParameters: RolesV1ApiDeleteBulkRolesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).deleteBulkRolesV1(requestParameters.rolebulkdeleterequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Remove a metadata from role. + * @param {RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public deleteMetadataFromRoleByKeyAndValueV1(requestParameters: RolesV1ApiDeleteMetadataFromRoleByKeyAndValueV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).deleteMetadataFromRoleByKeyAndValueV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Delete a role + * @param {RolesV1ApiDeleteRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public deleteRoleV1(requestParameters: RolesV1ApiDeleteRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).deleteRoleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + * @summary Get bulk-update status by id + * @param {RolesV1ApiGetBulkUpdateStatusByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public getBulkUpdateStatusByIdV1(requestParameters: RolesV1ApiGetBulkUpdateStatusByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).getBulkUpdateStatusByIdV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all unfinished bulk update process status of the tenant. + * @summary Get bulk-update statuses + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public getBulkUpdateStatusV1(axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).getBulkUpdateStatusV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary List identities assigned a role + * @param {RolesV1ApiGetRoleAssignedIdentitiesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public getRoleAssignedIdentitiesV1(requestParameters: RolesV1ApiGetRoleAssignedIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).getRoleAssignedIdentitiesV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of entitlements associated with a specified role. + * @summary List role\'s entitlements + * @param {RolesV1ApiGetRoleEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public getRoleEntitlementsV1(requestParameters: RolesV1ApiGetRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).getRoleEntitlementsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + * @summary Get a role + * @param {RolesV1ApiGetRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public getRoleV1(requestParameters: RolesV1ApiGetRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).getRoleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + * @summary List roles + * @param {RolesV1ApiListRolesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public listRolesV1(requestParameters: RolesV1ApiListRolesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).listRolesV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. + * @summary Patch a specified role + * @param {RolesV1ApiPatchRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public patchRoleV1(requestParameters: RolesV1ApiPatchRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).patchRoleV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + * @summary Filter roles by metadata + * @param {RolesV1ApiSearchRolesByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public searchRolesByFilterV1(requestParameters: RolesV1ApiSearchRolesByFilterV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).searchRolesByFilterV1(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.rolelistfilterdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + * @summary Add a metadata to role. + * @param {RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public updateAttributeKeyAndValueToRoleV1(requestParameters: RolesV1ApiUpdateAttributeKeyAndValueToRoleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).updateAttributeKeyAndValueToRoleV1(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by filters + * @param {RolesV1ApiUpdateRolesMetadataByFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public updateRolesMetadataByFilterV1(requestParameters: RolesV1ApiUpdateRolesMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).updateRolesMetadataByFilterV1(requestParameters.rolemetadatabulkupdatebyfilterrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by id + * @param {RolesV1ApiUpdateRolesMetadataByIdsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public updateRolesMetadataByIdsV1(requestParameters: RolesV1ApiUpdateRolesMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).updateRolesMetadataByIdsV1(requestParameters.rolemetadatabulkupdatebyidrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. + * @summary Bulk-update roles\' metadata by query + * @param {RolesV1ApiUpdateRolesMetadataByQueryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof RolesV1Api + */ + public updateRolesMetadataByQueryV1(requestParameters: RolesV1ApiUpdateRolesMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return RolesV1ApiFp(this.configuration).updateRolesMetadataByQueryV1(requestParameters.rolemetadatabulkupdatebyqueryrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/v2026/base.ts b/sdk-output/roles/base.ts similarity index 83% rename from sdk-output/v2026/base.ts rename to sdk-output/roles/base.ts index da8f26b2..e0d7fd73 100644 --- a/sdk-output/v2026/base.ts +++ b/sdk-output/roles/base.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud v2026 API + * Identity Security Cloud API - Roles * 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: v2026 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -19,7 +19,7 @@ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://sailpoint.api.identitynow.com/v2026".replace(/\/+$/, ""); +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); /** * @@ -50,10 +50,10 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; - this.basePath = configuration.basePath + "/v2026"|| this.basePath; + this.basePath = configuration.basePath || this.basePath; } } }; diff --git a/sdk-output/v2026/common.ts b/sdk-output/roles/common.ts similarity index 83% rename from sdk-output/v2026/common.ts rename to sdk-output/roles/common.ts index bbf90ebe..59918b79 100644 --- a/sdk-output/v2026/common.ts +++ b/sdk-output/roles/common.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud v2026 API + * Identity Security Cloud API - Roles * 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: v2026 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,16 +143,15 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) - let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; } userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; const headers = { ...axiosArgs.axiosOptions.headers, - ...{'X-SailPoint-SDK':'typescript-1.8.69'}, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, ...{'User-Agent': userAgent}, } @@ -163,8 +161,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath+ "/v2026" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/v2026/configuration.ts b/sdk-output/roles/configuration.ts similarity index 97% rename from sdk-output/v2026/configuration.ts rename to sdk-output/roles/configuration.ts index af697e29..ace8651e 100644 --- a/sdk-output/v2026/configuration.ts +++ b/sdk-output/roles/configuration.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud v2026 API + * Identity Security Cloud API - Roles * 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: v2026 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/roles/git_push.sh b/sdk-output/roles/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/roles/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/v2026/index.ts b/sdk-output/roles/index.ts similarity index 87% rename from sdk-output/v2026/index.ts rename to sdk-output/roles/index.ts index a7588c4a..211f8b5e 100644 --- a/sdk-output/v2026/index.ts +++ b/sdk-output/roles/index.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud v2026 API + * Identity Security Cloud API - Roles * 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: v2026 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/roles/package.json b/sdk-output/roles/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/roles/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/roles/tsconfig.json b/sdk-output/roles/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/roles/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/saved_search/.gitignore b/sdk-output/saved_search/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/saved_search/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/saved_search/.npmignore b/sdk-output/saved_search/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/saved_search/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/saved_search/.openapi-generator-ignore b/sdk-output/saved_search/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/saved_search/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/saved_search/.openapi-generator/FILES b/sdk-output/saved_search/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/saved_search/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/saved_search/.openapi-generator/VERSION b/sdk-output/saved_search/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/saved_search/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/saved_search/.sdk-partition b/sdk-output/saved_search/.sdk-partition new file mode 100644 index 00000000..6e98c5d3 --- /dev/null +++ b/sdk-output/saved_search/.sdk-partition @@ -0,0 +1 @@ +saved-search \ No newline at end of file diff --git a/sdk-output/saved_search/README.md b/sdk-output/saved_search/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/saved_search/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/saved_search/api.ts b/sdk-output/saved_search/api.ts new file mode 100644 index 00000000..9aa5c7c9 --- /dev/null +++ b/sdk-output/saved_search/api.ts @@ -0,0 +1,1225 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Saved Search + * 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 BoundV1 + */ +export interface BoundV1 { + /** + * The value of the range\'s endpoint. + * @type {string} + * @memberof BoundV1 + */ + 'value': string; + /** + * Indicates if the endpoint is included in the range. + * @type {boolean} + * @memberof BoundV1 + */ + 'inclusive'?: boolean; +} +/** + * + * @export + * @interface ColumnV1 + */ +export interface ColumnV1 { + /** + * The name of the field. + * @type {string} + * @memberof ColumnV1 + */ + 'field': string; + /** + * The value of the header. + * @type {string} + * @memberof ColumnV1 + */ + 'header'?: string; +} +/** + * + * @export + * @interface CreateSavedSearchV1RequestV1 + */ +export interface CreateSavedSearchV1RequestV1 { + /** + * The name of the saved search. + * @type {string} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'name'?: string; + /** + * The description of the saved search. + * @type {string} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'description'?: string | null; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'created'?: string | null; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'modified'?: string | null; + /** + * The names of the Elasticsearch indices in which to search. + * @type {Array} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'indices': Array; + /** + * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + * @type {{ [key: string]: Array; }} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'columns'?: { [key: string]: Array; }; + /** + * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + * @type {string} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'query': string; + /** + * The fields to be searched against in a multi-field query. + * @type {Array} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'fields'?: Array | null; + /** + * Sort by index. This takes precedence over the `sort` property. + * @type {{ [key: string]: Array; }} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'orderBy'?: { [key: string]: Array; } | null; + /** + * The fields to be used to sort the search results. + * @type {Array} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'sort'?: Array | null; + /** + * + * @type {SavedsearchdetailFiltersV1} + * @memberof CreateSavedSearchV1RequestV1 + */ + 'filters'?: SavedsearchdetailFiltersV1 | null; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FilterV1 + */ +export interface FilterV1 { + /** + * + * @type {FiltertypeV1} + * @memberof FilterV1 + */ + 'type'?: FiltertypeV1; + /** + * + * @type {RangeV1} + * @memberof FilterV1 + */ + 'range'?: RangeV1; + /** + * The terms to be filtered. + * @type {Array} + * @memberof FilterV1 + */ + 'terms'?: Array; + /** + * Indicates if the filter excludes results. + * @type {boolean} + * @memberof FilterV1 + */ + 'exclude'?: boolean; +} + + +/** + * Enum representing the currently supported filter types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const FiltertypeV1 = { + Exists: 'EXISTS', + Range: 'RANGE', + Terms: 'TERMS' +} as const; + +export type FiltertypeV1 = typeof FiltertypeV1[keyof typeof FiltertypeV1]; + + +/** + * Enum representing the currently supported indices. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const IndexV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Events: 'events', + Identities: 'identities', + Roles: 'roles', + Star: '*' +} as const; + +export type IndexV1 = typeof IndexV1[keyof typeof IndexV1]; + + +/** + * + * @export + * @interface ListSavedSearchesV1401ResponseV1 + */ +export interface ListSavedSearchesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSavedSearchesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListSavedSearchesV1429ResponseV1 + */ +export interface ListSavedSearchesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSavedSearchesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The range of values to be filtered. + * @export + * @interface RangeV1 + */ +export interface RangeV1 { + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'lower'?: BoundV1; + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'upper'?: BoundV1; +} +/** + * + * @export + * @interface SavedsearchV1 + */ +export interface SavedsearchV1 { + /** + * The name of the saved search. + * @type {string} + * @memberof SavedsearchV1 + */ + 'name'?: string; + /** + * The description of the saved search. + * @type {string} + * @memberof SavedsearchV1 + */ + 'description'?: string | null; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof SavedsearchV1 + */ + 'created'?: string | null; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof SavedsearchV1 + */ + 'modified'?: string | null; + /** + * The names of the Elasticsearch indices in which to search. + * @type {Array} + * @memberof SavedsearchV1 + */ + 'indices': Array; + /** + * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + * @type {{ [key: string]: Array; }} + * @memberof SavedsearchV1 + */ + 'columns'?: { [key: string]: Array; }; + /** + * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + * @type {string} + * @memberof SavedsearchV1 + */ + 'query': string; + /** + * The fields to be searched against in a multi-field query. + * @type {Array} + * @memberof SavedsearchV1 + */ + 'fields'?: Array | null; + /** + * Sort by index. This takes precedence over the `sort` property. + * @type {{ [key: string]: Array; }} + * @memberof SavedsearchV1 + */ + 'orderBy'?: { [key: string]: Array; } | null; + /** + * The fields to be used to sort the search results. + * @type {Array} + * @memberof SavedsearchV1 + */ + 'sort'?: Array | null; + /** + * + * @type {SavedsearchdetailFiltersV1} + * @memberof SavedsearchV1 + */ + 'filters'?: SavedsearchdetailFiltersV1 | null; + /** + * The saved search ID. + * @type {string} + * @memberof SavedsearchV1 + */ + 'id'?: string; + /** + * + * @type {TypedreferenceV1} + * @memberof SavedsearchV1 + */ + 'owner'?: TypedreferenceV1; + /** + * The ID of the identity that owns this saved search. + * @type {string} + * @memberof SavedsearchV1 + */ + 'ownerId'?: string; + /** + * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. + * @type {boolean} + * @memberof SavedsearchV1 + */ + 'public'?: boolean; +} +/** + * + * @export + * @interface SavedsearchdetailFiltersV1 + */ +export interface SavedsearchdetailFiltersV1 { + /** + * + * @type {FiltertypeV1} + * @memberof SavedsearchdetailFiltersV1 + */ + 'type'?: FiltertypeV1; + /** + * + * @type {RangeV1} + * @memberof SavedsearchdetailFiltersV1 + */ + 'range'?: RangeV1; + /** + * The terms to be filtered. + * @type {Array} + * @memberof SavedsearchdetailFiltersV1 + */ + 'terms'?: Array; + /** + * Indicates if the filter excludes results. + * @type {boolean} + * @memberof SavedsearchdetailFiltersV1 + */ + 'exclude'?: boolean; +} + + +/** + * + * @export + * @interface SavedsearchdetailV1 + */ +export interface SavedsearchdetailV1 { + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof SavedsearchdetailV1 + */ + 'created'?: string | null; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof SavedsearchdetailV1 + */ + 'modified'?: string | null; + /** + * The names of the Elasticsearch indices in which to search. + * @type {Array} + * @memberof SavedsearchdetailV1 + */ + 'indices': Array; + /** + * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. + * @type {{ [key: string]: Array; }} + * @memberof SavedsearchdetailV1 + */ + 'columns'?: { [key: string]: Array; }; + /** + * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. + * @type {string} + * @memberof SavedsearchdetailV1 + */ + 'query': string; + /** + * The fields to be searched against in a multi-field query. + * @type {Array} + * @memberof SavedsearchdetailV1 + */ + 'fields'?: Array | null; + /** + * Sort by index. This takes precedence over the `sort` property. + * @type {{ [key: string]: Array; }} + * @memberof SavedsearchdetailV1 + */ + 'orderBy'?: { [key: string]: Array; } | null; + /** + * The fields to be used to sort the search results. + * @type {Array} + * @memberof SavedsearchdetailV1 + */ + 'sort'?: Array | null; + /** + * + * @type {SavedsearchdetailFiltersV1} + * @memberof SavedsearchdetailV1 + */ + 'filters'?: SavedsearchdetailFiltersV1 | null; +} +/** + * + * @export + * @interface SavedsearchnameV1 + */ +export interface SavedsearchnameV1 { + /** + * The name of the saved search. + * @type {string} + * @memberof SavedsearchnameV1 + */ + 'name'?: string; + /** + * The description of the saved search. + * @type {string} + * @memberof SavedsearchnameV1 + */ + 'description'?: string | null; +} +/** + * + * @export + * @interface SearchargumentsV1 + */ +export interface SearchargumentsV1 { + /** + * The ID of the scheduled search that triggered the saved search execution. + * @type {string} + * @memberof SearchargumentsV1 + */ + 'scheduleId'?: string; + /** + * The owner of the scheduled search being tested. + * @type {TypedreferenceV1} + * @memberof SearchargumentsV1 + */ + 'owner'?: TypedreferenceV1; + /** + * The email recipients of the scheduled search being tested. + * @type {Array} + * @memberof SearchargumentsV1 + */ + 'recipients'?: Array; +} +/** + * A typed reference to the object. + * @export + * @interface TypedreferenceV1 + */ +export interface TypedreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof TypedreferenceV1 + */ + 'type': DtotypeV1; + /** + * The id of the object. + * @type {string} + * @memberof TypedreferenceV1 + */ + 'id': string; +} + + + +/** + * SavedSearchV1Api - axios parameter creator + * @export + */ +export const SavedSearchV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new saved search. + * @summary Create a saved search + * @param {CreateSavedSearchV1RequestV1} createSavedSearchV1RequestV1 The saved search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSavedSearchV1: async (createSavedSearchV1RequestV1: CreateSavedSearchV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createSavedSearchV1RequestV1' is not null or undefined + assertParamExists('createSavedSearchV1', 'createSavedSearchV1RequestV1', createSavedSearchV1RequestV1) + const localVarPath = `/saved-searches/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(createSavedSearchV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes the specified saved search. + * @summary Delete document by id + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSavedSearchV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSavedSearchV1', 'id', id) + const localVarPath = `/saved-searches/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, + }; + }, + /** + * Executes the specified saved search. + * @summary Execute a saved search by id + * @param {string} id ID of the requested document. + * @param {SearchargumentsV1} searchargumentsV1 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + executeSavedSearchV1: async (id: string, searchargumentsV1: SearchargumentsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('executeSavedSearchV1', 'id', id) + // verify required parameter 'searchargumentsV1' is not null or undefined + assertParamExists('executeSavedSearchV1', 'searchargumentsV1', searchargumentsV1) + const localVarPath = `/saved-searches/v1/{id}/execute` + .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: '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(searchargumentsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns the specified saved search. + * @summary Return saved search by id + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSavedSearchV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSavedSearchV1', 'id', id) + const localVarPath = `/saved-searches/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, + }; + }, + /** + * Returns a list of saved searches. + * @summary A list of saved searches + * @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: **owner.id**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSavedSearchesV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/saved-searches/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, + }; + }, + /** + * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** + * @summary Updates an existing saved search + * @param {string} id ID of the requested document. + * @param {SavedsearchV1} savedsearchV1 The saved search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSavedSearchV1: async (id: string, savedsearchV1: SavedsearchV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putSavedSearchV1', 'id', id) + // verify required parameter 'savedsearchV1' is not null or undefined + assertParamExists('putSavedSearchV1', 'savedsearchV1', savedsearchV1) + const localVarPath = `/saved-searches/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: 'PUT', ...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(savedsearchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SavedSearchV1Api - functional programming interface + * @export + */ +export const SavedSearchV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SavedSearchV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates a new saved search. + * @summary Create a saved search + * @param {CreateSavedSearchV1RequestV1} createSavedSearchV1RequestV1 The saved search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSavedSearchV1(createSavedSearchV1RequestV1: CreateSavedSearchV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSavedSearchV1(createSavedSearchV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.createSavedSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes the specified saved search. + * @summary Delete document by id + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSavedSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSavedSearchV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.deleteSavedSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Executes the specified saved search. + * @summary Execute a saved search by id + * @param {string} id ID of the requested document. + * @param {SearchargumentsV1} searchargumentsV1 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async executeSavedSearchV1(id: string, searchargumentsV1: SearchargumentsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.executeSavedSearchV1(id, searchargumentsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.executeSavedSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns the specified saved search. + * @summary Return saved search by id + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSavedSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedSearchV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.getSavedSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of saved searches. + * @summary A list of saved searches + * @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: **owner.id**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSavedSearchesV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSavedSearchesV1(offset, limit, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.listSavedSearchesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** + * @summary Updates an existing saved search + * @param {string} id ID of the requested document. + * @param {SavedsearchV1} savedsearchV1 The saved search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSavedSearchV1(id: string, savedsearchV1: SavedsearchV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSavedSearchV1(id, savedsearchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SavedSearchV1Api.putSavedSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SavedSearchV1Api - factory interface + * @export + */ +export const SavedSearchV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SavedSearchV1ApiFp(configuration) + return { + /** + * Creates a new saved search. + * @summary Create a saved search + * @param {SavedSearchV1ApiCreateSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSavedSearchV1(requestParameters: SavedSearchV1ApiCreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSavedSearchV1(requestParameters.createSavedSearchV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes the specified saved search. + * @summary Delete document by id + * @param {SavedSearchV1ApiDeleteSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSavedSearchV1(requestParameters: SavedSearchV1ApiDeleteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSavedSearchV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Executes the specified saved search. + * @summary Execute a saved search by id + * @param {SavedSearchV1ApiExecuteSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + executeSavedSearchV1(requestParameters: SavedSearchV1ApiExecuteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.executeSavedSearchV1(requestParameters.id, requestParameters.searchargumentsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns the specified saved search. + * @summary Return saved search by id + * @param {SavedSearchV1ApiGetSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSavedSearchV1(requestParameters: SavedSearchV1ApiGetSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSavedSearchV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of saved searches. + * @summary A list of saved searches + * @param {SavedSearchV1ApiListSavedSearchesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSavedSearchesV1(requestParameters: SavedSearchV1ApiListSavedSearchesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSavedSearchesV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** + * @summary Updates an existing saved search + * @param {SavedSearchV1ApiPutSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSavedSearchV1(requestParameters: SavedSearchV1ApiPutSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSavedSearchV1(requestParameters.id, requestParameters.savedsearchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSavedSearchV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiCreateSavedSearchV1Request + */ +export interface SavedSearchV1ApiCreateSavedSearchV1Request { + /** + * The saved search to persist. + * @type {CreateSavedSearchV1RequestV1} + * @memberof SavedSearchV1ApiCreateSavedSearchV1 + */ + readonly createSavedSearchV1RequestV1: CreateSavedSearchV1RequestV1 +} + +/** + * Request parameters for deleteSavedSearchV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiDeleteSavedSearchV1Request + */ +export interface SavedSearchV1ApiDeleteSavedSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof SavedSearchV1ApiDeleteSavedSearchV1 + */ + readonly id: string +} + +/** + * Request parameters for executeSavedSearchV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiExecuteSavedSearchV1Request + */ +export interface SavedSearchV1ApiExecuteSavedSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof SavedSearchV1ApiExecuteSavedSearchV1 + */ + readonly id: string + + /** + * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + * @type {SearchargumentsV1} + * @memberof SavedSearchV1ApiExecuteSavedSearchV1 + */ + readonly searchargumentsV1: SearchargumentsV1 +} + +/** + * Request parameters for getSavedSearchV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiGetSavedSearchV1Request + */ +export interface SavedSearchV1ApiGetSavedSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof SavedSearchV1ApiGetSavedSearchV1 + */ + readonly id: string +} + +/** + * Request parameters for listSavedSearchesV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiListSavedSearchesV1Request + */ +export interface SavedSearchV1ApiListSavedSearchesV1Request { + /** + * 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 SavedSearchV1ApiListSavedSearchesV1 + */ + 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 SavedSearchV1ApiListSavedSearchesV1 + */ + 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 SavedSearchV1ApiListSavedSearchesV1 + */ + 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: **owner.id**: *eq* + * @type {string} + * @memberof SavedSearchV1ApiListSavedSearchesV1 + */ + readonly filters?: string +} + +/** + * Request parameters for putSavedSearchV1 operation in SavedSearchV1Api. + * @export + * @interface SavedSearchV1ApiPutSavedSearchV1Request + */ +export interface SavedSearchV1ApiPutSavedSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof SavedSearchV1ApiPutSavedSearchV1 + */ + readonly id: string + + /** + * The saved search to persist. + * @type {SavedsearchV1} + * @memberof SavedSearchV1ApiPutSavedSearchV1 + */ + readonly savedsearchV1: SavedsearchV1 +} + +/** + * SavedSearchV1Api - object-oriented interface + * @export + * @class SavedSearchV1Api + * @extends {BaseAPI} + */ +export class SavedSearchV1Api extends BaseAPI { + /** + * Creates a new saved search. + * @summary Create a saved search + * @param {SavedSearchV1ApiCreateSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public createSavedSearchV1(requestParameters: SavedSearchV1ApiCreateSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).createSavedSearchV1(requestParameters.createSavedSearchV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes the specified saved search. + * @summary Delete document by id + * @param {SavedSearchV1ApiDeleteSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public deleteSavedSearchV1(requestParameters: SavedSearchV1ApiDeleteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).deleteSavedSearchV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Executes the specified saved search. + * @summary Execute a saved search by id + * @param {SavedSearchV1ApiExecuteSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public executeSavedSearchV1(requestParameters: SavedSearchV1ApiExecuteSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).executeSavedSearchV1(requestParameters.id, requestParameters.searchargumentsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns the specified saved search. + * @summary Return saved search by id + * @param {SavedSearchV1ApiGetSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public getSavedSearchV1(requestParameters: SavedSearchV1ApiGetSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).getSavedSearchV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of saved searches. + * @summary A list of saved searches + * @param {SavedSearchV1ApiListSavedSearchesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public listSavedSearchesV1(requestParameters: SavedSearchV1ApiListSavedSearchesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).listSavedSearchesV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** + * @summary Updates an existing saved search + * @param {SavedSearchV1ApiPutSavedSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SavedSearchV1Api + */ + public putSavedSearchV1(requestParameters: SavedSearchV1ApiPutSavedSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SavedSearchV1ApiFp(this.configuration).putSavedSearchV1(requestParameters.id, requestParameters.savedsearchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/saved_search/base.ts b/sdk-output/saved_search/base.ts new file mode 100644 index 00000000..72a3c642 --- /dev/null +++ b/sdk-output/saved_search/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Saved Search + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/saved_search/common.ts b/sdk-output/saved_search/common.ts new file mode 100644 index 00000000..a7705062 --- /dev/null +++ b/sdk-output/saved_search/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Saved Search + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/saved_search/configuration.ts b/sdk-output/saved_search/configuration.ts new file mode 100644 index 00000000..1afcd844 --- /dev/null +++ b/sdk-output/saved_search/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Saved Search + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/saved_search/git_push.sh b/sdk-output/saved_search/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/saved_search/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/saved_search/index.ts b/sdk-output/saved_search/index.ts new file mode 100644 index 00000000..b46e5653 --- /dev/null +++ b/sdk-output/saved_search/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Saved Search + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/saved_search/package.json b/sdk-output/saved_search/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/saved_search/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/saved_search/tsconfig.json b/sdk-output/saved_search/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/saved_search/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/scheduled_search/.gitignore b/sdk-output/scheduled_search/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/scheduled_search/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/scheduled_search/.npmignore b/sdk-output/scheduled_search/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/scheduled_search/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/scheduled_search/.openapi-generator-ignore b/sdk-output/scheduled_search/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/scheduled_search/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/scheduled_search/.openapi-generator/FILES b/sdk-output/scheduled_search/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/scheduled_search/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/scheduled_search/.openapi-generator/VERSION b/sdk-output/scheduled_search/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/scheduled_search/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/scheduled_search/.sdk-partition b/sdk-output/scheduled_search/.sdk-partition new file mode 100644 index 00000000..fdccd08a --- /dev/null +++ b/sdk-output/scheduled_search/.sdk-partition @@ -0,0 +1 @@ +scheduled-search \ No newline at end of file diff --git a/sdk-output/scheduled_search/README.md b/sdk-output/scheduled_search/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/scheduled_search/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/scheduled_search/api.ts b/sdk-output/scheduled_search/api.ts new file mode 100644 index 00000000..38364f3e --- /dev/null +++ b/sdk-output/scheduled_search/api.ts @@ -0,0 +1,1256 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Scheduled Search + * 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 CreateScheduledSearchV1RequestV1 + */ +export interface CreateScheduledSearchV1RequestV1 { + /** + * The name of the scheduled search. + * @type {string} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'name'?: string | null; + /** + * The description of the scheduled search. + * @type {string} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'description'?: string | null; + /** + * The ID of the saved search that will be executed. + * @type {string} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'savedSearchId': string; + /** + * The date the scheduled search was initially created. + * @type {string} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'created'?: string | null; + /** + * The last date the scheduled search was modified. + * @type {string} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'modified'?: string | null; + /** + * + * @type {ScheduleV1} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'schedule': ScheduleV1; + /** + * A list of identities that should receive the scheduled search report via email. + * @type {Array} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'recipients': Array; + /** + * Indicates if the scheduled search is enabled. + * @type {boolean} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'enabled'?: boolean; + /** + * Indicates if email generation should occur when search returns no results. + * @type {boolean} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'emailEmptyResults'?: boolean; + /** + * Indicates if the generated email should include the query and search results preview (which could include PII). + * @type {boolean} + * @memberof CreateScheduledSearchV1RequestV1 + */ + 'displayQueryDetails'?: boolean; +} +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListScheduledSearchV1401ResponseV1 + */ +export interface ListScheduledSearchV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListScheduledSearchV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListScheduledSearchV1429ResponseV1 + */ +export interface ListScheduledSearchV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListScheduledSearchV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ScheduleDaysV1 + */ +export interface ScheduleDaysV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleDaysV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleDaysV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleDaysV1 + */ + 'interval'?: number | null; +} + + +/** + * + * @export + * @interface ScheduleHoursV1 + */ +export interface ScheduleHoursV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleHoursV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleHoursV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleHoursV1 + */ + 'interval'?: number | null; +} + + +/** + * + * @export + * @interface ScheduleMonthsV1 + */ +export interface ScheduleMonthsV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleMonthsV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleMonthsV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleMonthsV1 + */ + 'interval'?: number | null; +} + + +/** + * The schedule information. + * @export + * @interface ScheduleV1 + */ +export interface ScheduleV1 { + /** + * + * @type {ScheduletypeV1} + * @memberof ScheduleV1 + */ + 'type': ScheduletypeV1; + /** + * + * @type {ScheduleMonthsV1} + * @memberof ScheduleV1 + */ + 'months'?: ScheduleMonthsV1; + /** + * + * @type {ScheduleDaysV1} + * @memberof ScheduleV1 + */ + 'days'?: ScheduleDaysV1; + /** + * + * @type {ScheduleHoursV1} + * @memberof ScheduleV1 + */ + 'hours': ScheduleHoursV1; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof ScheduleV1 + */ + 'expiration'?: string | null; + /** + * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. + * @type {string} + * @memberof ScheduleV1 + */ + 'timeZoneId'?: string | null; +} + + +/** + * The owner of the scheduled search + * @export + * @interface ScheduledsearchAllOfOwnerV1 + */ +export interface ScheduledsearchAllOfOwnerV1 { + /** + * The type of object being referenced + * @type {string} + * @memberof ScheduledsearchAllOfOwnerV1 + */ + 'type': ScheduledsearchAllOfOwnerV1TypeV1; + /** + * The ID of the referenced object + * @type {string} + * @memberof ScheduledsearchAllOfOwnerV1 + */ + 'id': string; +} + +export const ScheduledsearchAllOfOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ScheduledsearchAllOfOwnerV1TypeV1 = typeof ScheduledsearchAllOfOwnerV1TypeV1[keyof typeof ScheduledsearchAllOfOwnerV1TypeV1]; + +/** + * + * @export + * @interface ScheduledsearchV1 + */ +export interface ScheduledsearchV1 { + /** + * The name of the scheduled search. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'name'?: string | null; + /** + * The description of the scheduled search. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'description'?: string | null; + /** + * The ID of the saved search that will be executed. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'savedSearchId': string; + /** + * The date the scheduled search was initially created. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'created'?: string | null; + /** + * The last date the scheduled search was modified. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'modified'?: string | null; + /** + * + * @type {ScheduleV1} + * @memberof ScheduledsearchV1 + */ + 'schedule': ScheduleV1; + /** + * A list of identities that should receive the scheduled search report via email. + * @type {Array} + * @memberof ScheduledsearchV1 + */ + 'recipients': Array; + /** + * Indicates if the scheduled search is enabled. + * @type {boolean} + * @memberof ScheduledsearchV1 + */ + 'enabled'?: boolean; + /** + * Indicates if email generation should occur when search returns no results. + * @type {boolean} + * @memberof ScheduledsearchV1 + */ + 'emailEmptyResults'?: boolean; + /** + * Indicates if the generated email should include the query and search results preview (which could include PII). + * @type {boolean} + * @memberof ScheduledsearchV1 + */ + 'displayQueryDetails'?: boolean; + /** + * The scheduled search ID. + * @type {string} + * @memberof ScheduledsearchV1 + */ + 'id': string; + /** + * + * @type {ScheduledsearchAllOfOwnerV1} + * @memberof ScheduledsearchV1 + */ + 'owner': ScheduledsearchAllOfOwnerV1; + /** + * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. + * @type {string} + * @memberof ScheduledsearchV1 + * @deprecated + */ + 'ownerId': string; +} +/** + * + * @export + * @interface ScheduledsearchnameV1 + */ +export interface ScheduledsearchnameV1 { + /** + * The name of the scheduled search. + * @type {string} + * @memberof ScheduledsearchnameV1 + */ + 'name'?: string | null; + /** + * The description of the scheduled search. + * @type {string} + * @memberof ScheduledsearchnameV1 + */ + 'description'?: string | null; +} +/** + * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const ScheduletypeV1 = { + Daily: 'DAILY', + Weekly: 'WEEKLY', + Monthly: 'MONTHLY', + Calendar: 'CALENDAR', + Annually: 'ANNUALLY' +} as const; + +export type ScheduletypeV1 = typeof ScheduletypeV1[keyof typeof ScheduletypeV1]; + + +/** + * + * @export + * @interface SearchscheduleRecipientsInnerV1 + */ +export interface SearchscheduleRecipientsInnerV1 { + /** + * The type of object being referenced + * @type {string} + * @memberof SearchscheduleRecipientsInnerV1 + */ + 'type': SearchscheduleRecipientsInnerV1TypeV1; + /** + * The ID of the referenced object + * @type {string} + * @memberof SearchscheduleRecipientsInnerV1 + */ + 'id': string; +} + +export const SearchscheduleRecipientsInnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SearchscheduleRecipientsInnerV1TypeV1 = typeof SearchscheduleRecipientsInnerV1TypeV1[keyof typeof SearchscheduleRecipientsInnerV1TypeV1]; + +/** + * + * @export + * @interface SearchscheduleV1 + */ +export interface SearchscheduleV1 { + /** + * The ID of the saved search that will be executed. + * @type {string} + * @memberof SearchscheduleV1 + */ + 'savedSearchId': string; + /** + * The date the scheduled search was initially created. + * @type {string} + * @memberof SearchscheduleV1 + */ + 'created'?: string | null; + /** + * The last date the scheduled search was modified. + * @type {string} + * @memberof SearchscheduleV1 + */ + 'modified'?: string | null; + /** + * + * @type {ScheduleV1} + * @memberof SearchscheduleV1 + */ + 'schedule': ScheduleV1; + /** + * A list of identities that should receive the scheduled search report via email. + * @type {Array} + * @memberof SearchscheduleV1 + */ + 'recipients': Array; + /** + * Indicates if the scheduled search is enabled. + * @type {boolean} + * @memberof SearchscheduleV1 + */ + 'enabled'?: boolean; + /** + * Indicates if email generation should occur when search returns no results. + * @type {boolean} + * @memberof SearchscheduleV1 + */ + 'emailEmptyResults'?: boolean; + /** + * Indicates if the generated email should include the query and search results preview (which could include PII). + * @type {boolean} + * @memberof SearchscheduleV1 + */ + 'displayQueryDetails'?: boolean; +} +/** + * + * @export + * @interface SelectorV1 + */ +export interface SelectorV1 { + /** + * + * @type {SelectortypeV1} + * @memberof SelectorV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof SelectorV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof SelectorV1 + */ + 'interval'?: number | null; +} + + +/** + * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const SelectortypeV1 = { + List: 'LIST', + Range: 'RANGE' +} as const; + +export type SelectortypeV1 = typeof SelectortypeV1[keyof typeof SelectortypeV1]; + + +/** + * A typed reference to the object. + * @export + * @interface TypedreferenceV1 + */ +export interface TypedreferenceV1 { + /** + * + * @type {DtotypeV1} + * @memberof TypedreferenceV1 + */ + 'type': DtotypeV1; + /** + * The id of the object. + * @type {string} + * @memberof TypedreferenceV1 + */ + 'id': string; +} + + + +/** + * ScheduledSearchV1Api - axios parameter creator + * @export + */ +export const ScheduledSearchV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new scheduled search. + * @summary Create a new scheduled search + * @param {CreateScheduledSearchV1RequestV1} createScheduledSearchV1RequestV1 The scheduled search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduledSearchV1: async (createScheduledSearchV1RequestV1: CreateScheduledSearchV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createScheduledSearchV1RequestV1' is not null or undefined + assertParamExists('createScheduledSearchV1', 'createScheduledSearchV1RequestV1', createScheduledSearchV1RequestV1) + const localVarPath = `/scheduled-searches/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(createScheduledSearchV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes the specified scheduled search. + * @summary Delete a scheduled search + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduledSearchV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteScheduledSearchV1', 'id', id) + const localVarPath = `/scheduled-searches/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, + }; + }, + /** + * Returns the specified scheduled search. + * @summary Get a scheduled search + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getScheduledSearchV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getScheduledSearchV1', 'id', id) + const localVarPath = `/scheduled-searches/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, + }; + }, + /** + * Returns a list of scheduled searches. + * @summary List scheduled searches + * @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: **owner.id**: *eq* **savedSearchId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listScheduledSearchV1: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/scheduled-searches/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, + }; + }, + /** + * Unsubscribes a recipient from the specified scheduled search. + * @summary Unsubscribe a recipient from scheduled search + * @param {string} id ID of the requested document. + * @param {TypedreferenceV1} typedreferenceV1 The recipient to be removed from the scheduled search. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unsubscribeScheduledSearchV1: async (id: string, typedreferenceV1: TypedreferenceV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('unsubscribeScheduledSearchV1', 'id', id) + // verify required parameter 'typedreferenceV1' is not null or undefined + assertParamExists('unsubscribeScheduledSearchV1', 'typedreferenceV1', typedreferenceV1) + const localVarPath = `/scheduled-searches/v1/{id}/unsubscribe` + .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: '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(typedreferenceV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates an existing scheduled search. + * @summary Update an existing scheduled search + * @param {string} id ID of the requested document. + * @param {ScheduledsearchV1} scheduledsearchV1 The scheduled search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateScheduledSearchV1: async (id: string, scheduledsearchV1: ScheduledsearchV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateScheduledSearchV1', 'id', id) + // verify required parameter 'scheduledsearchV1' is not null or undefined + assertParamExists('updateScheduledSearchV1', 'scheduledsearchV1', scheduledsearchV1) + const localVarPath = `/scheduled-searches/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: 'PUT', ...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(scheduledsearchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ScheduledSearchV1Api - functional programming interface + * @export + */ +export const ScheduledSearchV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ScheduledSearchV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates a new scheduled search. + * @summary Create a new scheduled search + * @param {CreateScheduledSearchV1RequestV1} createScheduledSearchV1RequestV1 The scheduled search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createScheduledSearchV1(createScheduledSearchV1RequestV1: CreateScheduledSearchV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledSearchV1(createScheduledSearchV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.createScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes the specified scheduled search. + * @summary Delete a scheduled search + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteScheduledSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledSearchV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.deleteScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns the specified scheduled search. + * @summary Get a scheduled search + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getScheduledSearchV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledSearchV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.getScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of scheduled searches. + * @summary List scheduled searches + * @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: **owner.id**: *eq* **savedSearchId**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listScheduledSearchV1(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledSearchV1(offset, limit, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.listScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Unsubscribes a recipient from the specified scheduled search. + * @summary Unsubscribe a recipient from scheduled search + * @param {string} id ID of the requested document. + * @param {TypedreferenceV1} typedreferenceV1 The recipient to be removed from the scheduled search. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async unsubscribeScheduledSearchV1(id: string, typedreferenceV1: TypedreferenceV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribeScheduledSearchV1(id, typedreferenceV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.unsubscribeScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates an existing scheduled search. + * @summary Update an existing scheduled search + * @param {string} id ID of the requested document. + * @param {ScheduledsearchV1} scheduledsearchV1 The scheduled search to persist. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateScheduledSearchV1(id: string, scheduledsearchV1: ScheduledsearchV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledSearchV1(id, scheduledsearchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV1Api.updateScheduledSearchV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ScheduledSearchV1Api - factory interface + * @export + */ +export const ScheduledSearchV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ScheduledSearchV1ApiFp(configuration) + return { + /** + * Creates a new scheduled search. + * @summary Create a new scheduled search + * @param {ScheduledSearchV1ApiCreateScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createScheduledSearchV1(requestParameters: ScheduledSearchV1ApiCreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createScheduledSearchV1(requestParameters.createScheduledSearchV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes the specified scheduled search. + * @summary Delete a scheduled search + * @param {ScheduledSearchV1ApiDeleteScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteScheduledSearchV1(requestParameters: ScheduledSearchV1ApiDeleteScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteScheduledSearchV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns the specified scheduled search. + * @summary Get a scheduled search + * @param {ScheduledSearchV1ApiGetScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getScheduledSearchV1(requestParameters: ScheduledSearchV1ApiGetScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getScheduledSearchV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of scheduled searches. + * @summary List scheduled searches + * @param {ScheduledSearchV1ApiListScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listScheduledSearchV1(requestParameters: ScheduledSearchV1ApiListScheduledSearchV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listScheduledSearchV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Unsubscribes a recipient from the specified scheduled search. + * @summary Unsubscribe a recipient from scheduled search + * @param {ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + unsubscribeScheduledSearchV1(requestParameters: ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unsubscribeScheduledSearchV1(requestParameters.id, requestParameters.typedreferenceV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates an existing scheduled search. + * @summary Update an existing scheduled search + * @param {ScheduledSearchV1ApiUpdateScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateScheduledSearchV1(requestParameters: ScheduledSearchV1ApiUpdateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateScheduledSearchV1(requestParameters.id, requestParameters.scheduledsearchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiCreateScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiCreateScheduledSearchV1Request { + /** + * The scheduled search to persist. + * @type {CreateScheduledSearchV1RequestV1} + * @memberof ScheduledSearchV1ApiCreateScheduledSearchV1 + */ + readonly createScheduledSearchV1RequestV1: CreateScheduledSearchV1RequestV1 +} + +/** + * Request parameters for deleteScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiDeleteScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiDeleteScheduledSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof ScheduledSearchV1ApiDeleteScheduledSearchV1 + */ + readonly id: string +} + +/** + * Request parameters for getScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiGetScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiGetScheduledSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof ScheduledSearchV1ApiGetScheduledSearchV1 + */ + readonly id: string +} + +/** + * Request parameters for listScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiListScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiListScheduledSearchV1Request { + /** + * 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 ScheduledSearchV1ApiListScheduledSearchV1 + */ + 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 ScheduledSearchV1ApiListScheduledSearchV1 + */ + 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 ScheduledSearchV1ApiListScheduledSearchV1 + */ + 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: **owner.id**: *eq* **savedSearchId**: *eq* + * @type {string} + * @memberof ScheduledSearchV1ApiListScheduledSearchV1 + */ + readonly filters?: string +} + +/** + * Request parameters for unsubscribeScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof ScheduledSearchV1ApiUnsubscribeScheduledSearchV1 + */ + readonly id: string + + /** + * The recipient to be removed from the scheduled search. + * @type {TypedreferenceV1} + * @memberof ScheduledSearchV1ApiUnsubscribeScheduledSearchV1 + */ + readonly typedreferenceV1: TypedreferenceV1 +} + +/** + * Request parameters for updateScheduledSearchV1 operation in ScheduledSearchV1Api. + * @export + * @interface ScheduledSearchV1ApiUpdateScheduledSearchV1Request + */ +export interface ScheduledSearchV1ApiUpdateScheduledSearchV1Request { + /** + * ID of the requested document. + * @type {string} + * @memberof ScheduledSearchV1ApiUpdateScheduledSearchV1 + */ + readonly id: string + + /** + * The scheduled search to persist. + * @type {ScheduledsearchV1} + * @memberof ScheduledSearchV1ApiUpdateScheduledSearchV1 + */ + readonly scheduledsearchV1: ScheduledsearchV1 +} + +/** + * ScheduledSearchV1Api - object-oriented interface + * @export + * @class ScheduledSearchV1Api + * @extends {BaseAPI} + */ +export class ScheduledSearchV1Api extends BaseAPI { + /** + * Creates a new scheduled search. + * @summary Create a new scheduled search + * @param {ScheduledSearchV1ApiCreateScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public createScheduledSearchV1(requestParameters: ScheduledSearchV1ApiCreateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).createScheduledSearchV1(requestParameters.createScheduledSearchV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes the specified scheduled search. + * @summary Delete a scheduled search + * @param {ScheduledSearchV1ApiDeleteScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public deleteScheduledSearchV1(requestParameters: ScheduledSearchV1ApiDeleteScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).deleteScheduledSearchV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns the specified scheduled search. + * @summary Get a scheduled search + * @param {ScheduledSearchV1ApiGetScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public getScheduledSearchV1(requestParameters: ScheduledSearchV1ApiGetScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).getScheduledSearchV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of scheduled searches. + * @summary List scheduled searches + * @param {ScheduledSearchV1ApiListScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public listScheduledSearchV1(requestParameters: ScheduledSearchV1ApiListScheduledSearchV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).listScheduledSearchV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Unsubscribes a recipient from the specified scheduled search. + * @summary Unsubscribe a recipient from scheduled search + * @param {ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public unsubscribeScheduledSearchV1(requestParameters: ScheduledSearchV1ApiUnsubscribeScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).unsubscribeScheduledSearchV1(requestParameters.id, requestParameters.typedreferenceV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates an existing scheduled search. + * @summary Update an existing scheduled search + * @param {ScheduledSearchV1ApiUpdateScheduledSearchV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ScheduledSearchV1Api + */ + public updateScheduledSearchV1(requestParameters: ScheduledSearchV1ApiUpdateScheduledSearchV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ScheduledSearchV1ApiFp(this.configuration).updateScheduledSearchV1(requestParameters.id, requestParameters.scheduledsearchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/scheduled_search/base.ts b/sdk-output/scheduled_search/base.ts new file mode 100644 index 00000000..50a561b9 --- /dev/null +++ b/sdk-output/scheduled_search/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Scheduled Search + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/scheduled_search/common.ts b/sdk-output/scheduled_search/common.ts new file mode 100644 index 00000000..066667c4 --- /dev/null +++ b/sdk-output/scheduled_search/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Scheduled Search + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/scheduled_search/configuration.ts b/sdk-output/scheduled_search/configuration.ts new file mode 100644 index 00000000..321e4df8 --- /dev/null +++ b/sdk-output/scheduled_search/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Scheduled Search + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/scheduled_search/git_push.sh b/sdk-output/scheduled_search/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/scheduled_search/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/scheduled_search/index.ts b/sdk-output/scheduled_search/index.ts new file mode 100644 index 00000000..7ec716b8 --- /dev/null +++ b/sdk-output/scheduled_search/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Scheduled Search + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/scheduled_search/package.json b/sdk-output/scheduled_search/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/scheduled_search/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/scheduled_search/tsconfig.json b/sdk-output/scheduled_search/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/scheduled_search/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/search/.gitignore b/sdk-output/search/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/search/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/search/.npmignore b/sdk-output/search/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/search/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/search/.openapi-generator-ignore b/sdk-output/search/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/search/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/search/.openapi-generator/FILES b/sdk-output/search/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/search/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/search/.openapi-generator/VERSION b/sdk-output/search/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/search/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/search/.sdk-partition b/sdk-output/search/.sdk-partition new file mode 100644 index 00000000..a9437ed7 --- /dev/null +++ b/sdk-output/search/.sdk-partition @@ -0,0 +1 @@ +search \ No newline at end of file diff --git a/sdk-output/search/README.md b/sdk-output/search/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/search/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/search/api.ts b/sdk-output/search/api.ts new file mode 100644 index 00000000..b27e0f29 --- /dev/null +++ b/sdk-output/search/api.ts @@ -0,0 +1,1279 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search + * 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 AggregationresultV1 + */ +export interface AggregationresultV1 { + /** + * The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. + * @type {object} + * @memberof AggregationresultV1 + */ + 'aggregations'?: object; + /** + * The results of the aggregation search query. + * @type {Array} + * @memberof AggregationresultV1 + */ + 'hits'?: Array; +} +/** + * + * @export + * @interface AggregationsV1 + */ +export interface AggregationsV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof AggregationsV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof AggregationsV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof AggregationsV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof AggregationsV1 + */ + 'bucket'?: BucketaggregationV1; +} +/** + * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const AggregationtypeV1 = { + Dsl: 'DSL', + Sailpoint: 'SAILPOINT' +} as const; + +export type AggregationtypeV1 = typeof AggregationtypeV1[keyof typeof AggregationtypeV1]; + + +/** + * + * @export + * @interface BoundV1 + */ +export interface BoundV1 { + /** + * The value of the range\'s endpoint. + * @type {string} + * @memberof BoundV1 + */ + 'value': string; + /** + * Indicates if the endpoint is included in the range. + * @type {boolean} + * @memberof BoundV1 + */ + 'inclusive'?: boolean; +} +/** + * The bucket to group the results of the aggregation query by. + * @export + * @interface BucketaggregationV1 + */ +export interface BucketaggregationV1 { + /** + * The name of the bucket aggregate to be included in the result. + * @type {string} + * @memberof BucketaggregationV1 + */ + 'name': string; + /** + * + * @type {BuckettypeV1} + * @memberof BucketaggregationV1 + */ + 'type'?: BuckettypeV1; + /** + * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof BucketaggregationV1 + */ + 'field': string; + /** + * Maximum number of buckets to include. + * @type {number} + * @memberof BucketaggregationV1 + */ + 'size'?: number; + /** + * Minimum number of documents a bucket should have. + * @type {number} + * @memberof BucketaggregationV1 + */ + 'minDocCount'?: number; +} + + +/** + * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const BuckettypeV1 = { + Terms: 'TERMS' +} as const; + +export type BuckettypeV1 = typeof BuckettypeV1[keyof typeof BuckettypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FilterV1 + */ +export interface FilterV1 { + /** + * + * @type {FiltertypeV1} + * @memberof FilterV1 + */ + 'type'?: FiltertypeV1; + /** + * + * @type {RangeV1} + * @memberof FilterV1 + */ + 'range'?: RangeV1; + /** + * The terms to be filtered. + * @type {Array} + * @memberof FilterV1 + */ + 'terms'?: Array; + /** + * Indicates if the filter excludes results. + * @type {boolean} + * @memberof FilterV1 + */ + 'exclude'?: boolean; +} + + +/** + * An additional filter to constrain the results of the search query. + * @export + * @interface FilteraggregationV1 + */ +export interface FilteraggregationV1 { + /** + * The name of the filter aggregate to be included in the result. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'name': string; + /** + * + * @type {SearchfiltertypeV1} + * @memberof FilteraggregationV1 + */ + 'type'?: SearchfiltertypeV1; + /** + * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'field': string; + /** + * The value to filter on. + * @type {string} + * @memberof FilteraggregationV1 + */ + 'value': string; +} + + +/** + * Enum representing the currently supported filter types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const FiltertypeV1 = { + Exists: 'EXISTS', + Range: 'RANGE', + Terms: 'TERMS' +} as const; + +export type FiltertypeV1 = typeof FiltertypeV1[keyof typeof FiltertypeV1]; + + +/** + * Enum representing the currently supported indices. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const IndexV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Events: 'events', + Identities: 'identities', + Roles: 'roles', + Star: '*' +} as const; + +export type IndexV1 = typeof IndexV1[keyof typeof IndexV1]; + + +/** + * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. + * @export + * @interface InnerhitV1 + */ +export interface InnerhitV1 { + /** + * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof InnerhitV1 + */ + 'query': string; + /** + * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. + * @type {string} + * @memberof InnerhitV1 + */ + 'type': 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The calculation done on the results of the query + * @export + * @interface MetricaggregationV1 + */ +export interface MetricaggregationV1 { + /** + * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. + * @type {string} + * @memberof MetricaggregationV1 + */ + 'name': string; + /** + * + * @type {MetrictypeV1} + * @memberof MetricaggregationV1 + */ + 'type'?: MetrictypeV1; + /** + * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. + * @type {string} + * @memberof MetricaggregationV1 + */ + 'field': string; +} + + +/** + * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const MetrictypeV1 = { + Count: 'COUNT', + UniqueCount: 'UNIQUE_COUNT', + Avg: 'AVG', + Sum: 'SUM', + Median: 'MEDIAN', + Min: 'MIN', + Max: 'MAX' +} as const; + +export type MetrictypeV1 = typeof MetrictypeV1[keyof typeof MetrictypeV1]; + + +/** + * The nested aggregation object. + * @export + * @interface NestedaggregationV1 + */ +export interface NestedaggregationV1 { + /** + * The name of the nested aggregate to be included in the result. + * @type {string} + * @memberof NestedaggregationV1 + */ + 'name': string; + /** + * The type of the nested object. + * @type {string} + * @memberof NestedaggregationV1 + */ + 'type': string; +} +/** + * Query parameters used to construct an Elasticsearch query object. + * @export + * @interface QueryV1 + */ +export interface QueryV1 { + /** + * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. + * @type {string} + * @memberof QueryV1 + */ + 'query'?: string; + /** + * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. + * @type {string} + * @memberof QueryV1 + */ + 'fields'?: string; + /** + * The time zone to be applied to any range query related to dates. + * @type {string} + * @memberof QueryV1 + */ + 'timeZone'?: string; + /** + * + * @type {InnerhitV1} + * @memberof QueryV1 + */ + 'innerHit'?: InnerhitV1; +} +/** + * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. + * @export + * @interface QueryresultfilterV1 + */ +export interface QueryresultfilterV1 { + /** + * The list of field names to include in the result documents. + * @type {Array} + * @memberof QueryresultfilterV1 + */ + 'includes'?: Array; + /** + * The list of field names to exclude from the result documents. + * @type {Array} + * @memberof QueryresultfilterV1 + */ + 'excludes'?: Array; +} +/** + * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const QuerytypeV1 = { + Dsl: 'DSL', + Sailpoint: 'SAILPOINT', + Text: 'TEXT', + Typeahead: 'TYPEAHEAD' +} as const; + +export type QuerytypeV1 = typeof QuerytypeV1[keyof typeof QuerytypeV1]; + + +/** + * The range of values to be filtered. + * @export + * @interface RangeV1 + */ +export interface RangeV1 { + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'lower'?: BoundV1; + /** + * + * @type {BoundV1} + * @memberof RangeV1 + */ + 'upper'?: BoundV1; +} +/** + * + * @export + * @interface SearchPostV1401ResponseV1 + */ +export interface SearchPostV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SearchPostV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface SearchPostV1429ResponseV1 + */ +export interface SearchPostV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof SearchPostV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface SearchV1 + */ +export interface SearchV1 { + /** + * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. + * @type {Array} + * @memberof SearchV1 + */ + 'indices'?: Array; + /** + * + * @type {QuerytypeV1} + * @memberof SearchV1 + */ + 'queryType'?: QuerytypeV1; + /** + * + * @type {string} + * @memberof SearchV1 + */ + 'queryVersion'?: string; + /** + * + * @type {QueryV1} + * @memberof SearchV1 + */ + 'query'?: QueryV1; + /** + * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. + * @type {object} + * @memberof SearchV1 + */ + 'queryDsl'?: object; + /** + * + * @type {TextqueryV1} + * @memberof SearchV1 + */ + 'textQuery'?: TextqueryV1; + /** + * + * @type {TypeaheadqueryV1} + * @memberof SearchV1 + */ + 'typeAheadQuery'?: TypeaheadqueryV1; + /** + * Indicates whether nested objects from returned search results should be included. + * @type {boolean} + * @memberof SearchV1 + */ + 'includeNested'?: boolean; + /** + * + * @type {QueryresultfilterV1} + * @memberof SearchV1 + */ + 'queryResultFilter'?: QueryresultfilterV1; + /** + * + * @type {AggregationtypeV1} + * @memberof SearchV1 + */ + 'aggregationType'?: AggregationtypeV1; + /** + * + * @type {string} + * @memberof SearchV1 + */ + 'aggregationsVersion'?: string; + /** + * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. + * @type {object} + * @memberof SearchV1 + */ + 'aggregationsDsl'?: object; + /** + * + * @type {SearchaggregationspecificationV1} + * @memberof SearchV1 + */ + 'aggregations'?: SearchaggregationspecificationV1; + /** + * The fields to be used to sort the search results. Use + or - to specify the sort direction. + * @type {Array} + * @memberof SearchV1 + */ + 'sort'?: Array; + /** + * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] + * @type {Array} + * @memberof SearchV1 + */ + 'searchAfter'?: Array; + /** + * The filters to be applied for each filtered field name. + * @type {{ [key: string]: FilterV1; }} + * @memberof SearchV1 + */ + 'filters'?: { [key: string]: FilterV1; }; +} + + +/** + * + * @export + * @interface SearchaggregationspecificationV1 + */ +export interface SearchaggregationspecificationV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'bucket'?: BucketaggregationV1; + /** + * + * @type {SubsearchaggregationspecificationV1} + * @memberof SearchaggregationspecificationV1 + */ + 'subAggregation'?: SubsearchaggregationspecificationV1; +} +/** + * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const SearchfiltertypeV1 = { + Term: 'TERM' +} as const; + +export type SearchfiltertypeV1 = typeof SearchfiltertypeV1[keyof typeof SearchfiltertypeV1]; + + +/** + * + * @export + * @interface SubsearchaggregationspecificationV1 + */ +export interface SubsearchaggregationspecificationV1 { + /** + * + * @type {NestedaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'nested'?: NestedaggregationV1; + /** + * + * @type {MetricaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'metric'?: MetricaggregationV1; + /** + * + * @type {FilteraggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'filter'?: FilteraggregationV1; + /** + * + * @type {BucketaggregationV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'bucket'?: BucketaggregationV1; + /** + * + * @type {AggregationsV1} + * @memberof SubsearchaggregationspecificationV1 + */ + 'subAggregation'?: AggregationsV1; +} +/** + * Query parameters used to construct an Elasticsearch text query object. + * @export + * @interface TextqueryV1 + */ +export interface TextqueryV1 { + /** + * Words or characters that specify a particular thing to be searched for. + * @type {Array} + * @memberof TextqueryV1 + */ + 'terms': Array; + /** + * The fields to be searched. + * @type {Array} + * @memberof TextqueryV1 + */ + 'fields': Array; + /** + * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. + * @type {boolean} + * @memberof TextqueryV1 + */ + 'matchAny'?: boolean; + /** + * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. + * @type {boolean} + * @memberof TextqueryV1 + */ + 'contains'?: boolean; +} +/** + * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" + * @export + * @interface TypeaheadqueryV1 + */ +export interface TypeaheadqueryV1 { + /** + * The type ahead query string used to construct a phrase prefix match query. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'query': string; + /** + * The field on which to perform the type ahead search. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'field': string; + /** + * The nested type. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'nestedType'?: string; + /** + * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. + * @type {number} + * @memberof TypeaheadqueryV1 + */ + 'maxExpansions'?: number; + /** + * The max amount of records the search will return. + * @type {number} + * @memberof TypeaheadqueryV1 + */ + 'size'?: number; + /** + * The sort order of the returned records. + * @type {string} + * @memberof TypeaheadqueryV1 + */ + 'sort'?: string; + /** + * The flag that defines the sort type, by count or value. + * @type {boolean} + * @memberof TypeaheadqueryV1 + */ + 'sortByValue'?: boolean; +} + +/** + * SearchV1Api - axios parameter creator + * @export + */ +export const SearchV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + * @summary Perform a search query aggregation + * @param {SearchV1} searchV1 + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchAggregateV1: async (searchV1: SearchV1, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'searchV1' is not null or undefined + assertParamExists('searchAggregateV1', 'searchV1', searchV1) + const localVarPath = `/search/v1/aggregate`; + // 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; + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(searchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Performs a search with a provided query and returns the count of results in the X-Total-Count header. + * @summary Count documents satisfying a query + * @param {SearchV1} searchV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchCountV1: async (searchV1: SearchV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'searchV1' is not null or undefined + assertParamExists('searchCountV1', 'searchV1', searchV1) + const localVarPath = `/search/v1/count`; + // 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(searchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Fetches a single document from the specified index, using the specified document ID. + * @summary Get a document by id + * @param {SearchGetV1IndexV1} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchGetV1: async (index: SearchGetV1IndexV1, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'index' is not null or undefined + assertParamExists('searchGetV1', 'index', index) + // verify required parameter 'id' is not null or undefined + assertParamExists('searchGetV1', 'id', id) + const localVarPath = `/search/v1/{index}/{id}` + .replace(`{${"index"}}`, encodeURIComponent(String(index))) + .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, + }; + }, + /** + * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). + * @summary Perform search + * @param {SearchV1} searchV1 + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchPostV1: async (searchV1: SearchV1, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'searchV1' is not null or undefined + assertParamExists('searchPostV1', 'searchV1', searchV1) + const localVarPath = `/search/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; + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(searchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SearchV1Api - functional programming interface + * @export + */ +export const SearchV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SearchV1ApiAxiosParamCreator(configuration) + return { + /** + * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + * @summary Perform a search query aggregation + * @param {SearchV1} searchV1 + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchAggregateV1(searchV1: SearchV1, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchAggregateV1(searchV1, offset, limit, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchV1Api.searchAggregateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Performs a search with a provided query and returns the count of results in the X-Total-Count header. + * @summary Count documents satisfying a query + * @param {SearchV1} searchV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchCountV1(searchV1: SearchV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchCountV1(searchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchV1Api.searchCountV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Fetches a single document from the specified index, using the specified document ID. + * @summary Get a document by id + * @param {SearchGetV1IndexV1} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + * @param {string} id ID of the requested document. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchGetV1(index: SearchGetV1IndexV1, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchGetV1(index, id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchV1Api.searchGetV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). + * @summary Perform search + * @param {SearchV1} searchV1 + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchPostV1(searchV1: SearchV1, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchPostV1(searchV1, offset, limit, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchV1Api.searchPostV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SearchV1Api - factory interface + * @export + */ +export const SearchV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SearchV1ApiFp(configuration) + return { + /** + * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + * @summary Perform a search query aggregation + * @param {SearchV1ApiSearchAggregateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchAggregateV1(requestParameters: SearchV1ApiSearchAggregateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchAggregateV1(requestParameters.searchV1, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Performs a search with a provided query and returns the count of results in the X-Total-Count header. + * @summary Count documents satisfying a query + * @param {SearchV1ApiSearchCountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchCountV1(requestParameters: SearchV1ApiSearchCountV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchCountV1(requestParameters.searchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Fetches a single document from the specified index, using the specified document ID. + * @summary Get a document by id + * @param {SearchV1ApiSearchGetV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchGetV1(requestParameters: SearchV1ApiSearchGetV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchGetV1(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). + * @summary Perform search + * @param {SearchV1ApiSearchPostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchPostV1(requestParameters: SearchV1ApiSearchPostV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.searchPostV1(requestParameters.searchV1, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for searchAggregateV1 operation in SearchV1Api. + * @export + * @interface SearchV1ApiSearchAggregateV1Request + */ +export interface SearchV1ApiSearchAggregateV1Request { + /** + * + * @type {SearchV1} + * @memberof SearchV1ApiSearchAggregateV1 + */ + readonly searchV1: SearchV1 + + /** + * 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 SearchV1ApiSearchAggregateV1 + */ + 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 SearchV1ApiSearchAggregateV1 + */ + 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 SearchV1ApiSearchAggregateV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for searchCountV1 operation in SearchV1Api. + * @export + * @interface SearchV1ApiSearchCountV1Request + */ +export interface SearchV1ApiSearchCountV1Request { + /** + * + * @type {SearchV1} + * @memberof SearchV1ApiSearchCountV1 + */ + readonly searchV1: SearchV1 +} + +/** + * Request parameters for searchGetV1 operation in SearchV1Api. + * @export + * @interface SearchV1ApiSearchGetV1Request + */ +export interface SearchV1ApiSearchGetV1Request { + /** + * The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + * @type {'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'} + * @memberof SearchV1ApiSearchGetV1 + */ + readonly index: SearchGetV1IndexV1 + + /** + * ID of the requested document. + * @type {string} + * @memberof SearchV1ApiSearchGetV1 + */ + readonly id: string +} + +/** + * Request parameters for searchPostV1 operation in SearchV1Api. + * @export + * @interface SearchV1ApiSearchPostV1Request + */ +export interface SearchV1ApiSearchPostV1Request { + /** + * + * @type {SearchV1} + * @memberof SearchV1ApiSearchPostV1 + */ + readonly searchV1: SearchV1 + + /** + * 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 SearchV1ApiSearchPostV1 + */ + 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 SearchV1ApiSearchPostV1 + */ + 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 SearchV1ApiSearchPostV1 + */ + readonly count?: boolean +} + +/** + * SearchV1Api - object-oriented interface + * @export + * @class SearchV1Api + * @extends {BaseAPI} + */ +export class SearchV1Api extends BaseAPI { + /** + * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + * @summary Perform a search query aggregation + * @param {SearchV1ApiSearchAggregateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchV1Api + */ + public searchAggregateV1(requestParameters: SearchV1ApiSearchAggregateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchV1ApiFp(this.configuration).searchAggregateV1(requestParameters.searchV1, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Performs a search with a provided query and returns the count of results in the X-Total-Count header. + * @summary Count documents satisfying a query + * @param {SearchV1ApiSearchCountV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchV1Api + */ + public searchCountV1(requestParameters: SearchV1ApiSearchCountV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchV1ApiFp(this.configuration).searchCountV1(requestParameters.searchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches a single document from the specified index, using the specified document ID. + * @summary Get a document by id + * @param {SearchV1ApiSearchGetV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchV1Api + */ + public searchGetV1(requestParameters: SearchV1ApiSearchGetV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchV1ApiFp(this.configuration).searchGetV1(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). + * @summary Perform search + * @param {SearchV1ApiSearchPostV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchV1Api + */ + public searchPostV1(requestParameters: SearchV1ApiSearchPostV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchV1ApiFp(this.configuration).searchPostV1(requestParameters.searchV1, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const SearchGetV1IndexV1 = { + Accessprofiles: 'accessprofiles', + Accountactivities: 'accountactivities', + Entitlements: 'entitlements', + Events: 'events', + Identities: 'identities', + Roles: 'roles' +} as const; +export type SearchGetV1IndexV1 = typeof SearchGetV1IndexV1[keyof typeof SearchGetV1IndexV1]; + + diff --git a/sdk-output/search/base.ts b/sdk-output/search/base.ts new file mode 100644 index 00000000..f388cd33 --- /dev/null +++ b/sdk-output/search/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/search/common.ts b/sdk-output/search/common.ts new file mode 100644 index 00000000..121fe13c --- /dev/null +++ b/sdk-output/search/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/v2024/configuration.ts b/sdk-output/search/configuration.ts similarity index 97% rename from sdk-output/v2024/configuration.ts rename to sdk-output/search/configuration.ts index 60b70316..899457e9 100644 --- a/sdk-output/v2024/configuration.ts +++ b/sdk-output/search/configuration.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2024 API + * Identity Security Cloud API - Search * 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: v2024 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/search/git_push.sh b/sdk-output/search/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/search/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/v2024/index.ts b/sdk-output/search/index.ts similarity index 87% rename from sdk-output/v2024/index.ts rename to sdk-output/search/index.ts index 0a44da13..75e0caf1 100644 --- a/sdk-output/v2024/index.ts +++ b/sdk-output/search/index.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2024 API + * Identity Security Cloud API - Search * 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: v2024 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/sdk-output/search/package.json b/sdk-output/search/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/search/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/search/tsconfig.json b/sdk-output/search/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/search/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/search_attribute_configuration/.gitignore b/sdk-output/search_attribute_configuration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/search_attribute_configuration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/search_attribute_configuration/.npmignore b/sdk-output/search_attribute_configuration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/search_attribute_configuration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/search_attribute_configuration/.openapi-generator-ignore b/sdk-output/search_attribute_configuration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/search_attribute_configuration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/search_attribute_configuration/.openapi-generator/FILES b/sdk-output/search_attribute_configuration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/search_attribute_configuration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/search_attribute_configuration/.openapi-generator/VERSION b/sdk-output/search_attribute_configuration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/search_attribute_configuration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/search_attribute_configuration/.sdk-partition b/sdk-output/search_attribute_configuration/.sdk-partition new file mode 100644 index 00000000..3c1b8788 --- /dev/null +++ b/sdk-output/search_attribute_configuration/.sdk-partition @@ -0,0 +1 @@ +search-attribute-configuration \ No newline at end of file diff --git a/sdk-output/search_attribute_configuration/README.md b/sdk-output/search_attribute_configuration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/search_attribute_configuration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/search_attribute_configuration/api.ts b/sdk-output/search_attribute_configuration/api.ts new file mode 100644 index 00000000..10e340fd --- /dev/null +++ b/sdk-output/search_attribute_configuration/api.ts @@ -0,0 +1,764 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search Attribute Configuration + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetSearchAttributeConfigV1401ResponseV1 + */ +export interface GetSearchAttributeConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSearchAttributeConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetSearchAttributeConfigV1429ResponseV1 + */ +export interface GetSearchAttributeConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSearchAttributeConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SearchattributeconfigV1 + */ +export interface SearchattributeconfigV1 { + /** + * Name of the new attribute + * @type {string} + * @memberof SearchattributeconfigV1 + */ + 'name'?: string; + /** + * The display name of the new attribute + * @type {string} + * @memberof SearchattributeconfigV1 + */ + 'displayName'?: string; + /** + * Map of application id and their associated attribute. + * @type {object} + * @memberof SearchattributeconfigV1 + */ + 'applicationAttributes'?: object; +} + +/** + * SearchAttributeConfigurationV1Api - axios parameter creator + * @export + */ +export const SearchAttributeConfigurationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** + * @summary Create extended search attributes + * @param {SearchattributeconfigV1} searchattributeconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSearchAttributeConfigV1: async (searchattributeconfigV1: SearchattributeconfigV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'searchattributeconfigV1' is not null or undefined + assertParamExists('createSearchAttributeConfigV1', 'searchattributeconfigV1', searchattributeconfigV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/accounts/v1/search-attribute-config`; + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(searchattributeconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an extended attribute configuration by name. + * @summary Delete extended search attribute + * @param {string} name Name of the extended search attribute configuration to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSearchAttributeConfigV1: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('deleteSearchAttributeConfigV1', 'name', name) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/accounts/v1/search-attribute-config/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + * @summary List extended search attributes + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSearchAttributeConfigV1: async (limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/accounts/v1/search-attribute-config`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get an extended attribute configuration by name. + * @summary Get extended search attribute + * @param {string} name Name of the extended search attribute configuration to get. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSingleSearchAttributeConfigV1: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('getSingleSearchAttributeConfigV1', 'name', name) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/accounts/v1/search-attribute-config/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes + * @summary Update extended search attribute + * @param {string} name Name of the search attribute configuration to patch. + * @param {Array} jsonpatchoperationV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSearchAttributeConfigV1: async (name: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'name' is not null or undefined + assertParamExists('patchSearchAttributeConfigV1', 'name', name) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchSearchAttributeConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/accounts/v1/search-attribute-config/{name}` + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + // 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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SearchAttributeConfigurationV1Api - functional programming interface + * @export + */ +export const SearchAttributeConfigurationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SearchAttributeConfigurationV1ApiAxiosParamCreator(configuration) + return { + /** + * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** + * @summary Create extended search attributes + * @param {SearchattributeconfigV1} searchattributeconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSearchAttributeConfigV1(searchattributeconfigV1: SearchattributeconfigV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfigV1(searchattributeconfigV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV1Api.createSearchAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an extended attribute configuration by name. + * @summary Delete extended search attribute + * @param {string} name Name of the extended search attribute configuration to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSearchAttributeConfigV1(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfigV1(name, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV1Api.deleteSearchAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + * @summary List extended search attributes + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSearchAttributeConfigV1(limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfigV1(limit, offset, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV1Api.getSearchAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get an extended attribute configuration by name. + * @summary Get extended search attribute + * @param {string} name Name of the extended search attribute configuration to get. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSingleSearchAttributeConfigV1(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfigV1(name, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV1Api.getSingleSearchAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes + * @summary Update extended search attribute + * @param {string} name Name of the search attribute configuration to patch. + * @param {Array} jsonpatchoperationV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSearchAttributeConfigV1(name: string, jsonpatchoperationV1: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfigV1(name, jsonpatchoperationV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV1Api.patchSearchAttributeConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SearchAttributeConfigurationV1Api - factory interface + * @export + */ +export const SearchAttributeConfigurationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SearchAttributeConfigurationV1ApiFp(configuration) + return { + /** + * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** + * @summary Create extended search attributes + * @param {SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSearchAttributeConfigV1(requestParameters.searchattributeconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an extended attribute configuration by name. + * @summary Delete extended search attribute + * @param {SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSearchAttributeConfigV1(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + * @summary List extended search attributes + * @param {SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSearchAttributeConfigV1(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get an extended attribute configuration by name. + * @summary Get extended search attribute + * @param {SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSingleSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSingleSearchAttributeConfigV1(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes + * @summary Update extended search attribute + * @param {SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSearchAttributeConfigV1(requestParameters.name, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSearchAttributeConfigV1 operation in SearchAttributeConfigurationV1Api. + * @export + * @interface SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request + */ +export interface SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request { + /** + * + * @type {SearchattributeconfigV1} + * @memberof SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1 + */ + readonly searchattributeconfigV1: SearchattributeconfigV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteSearchAttributeConfigV1 operation in SearchAttributeConfigurationV1Api. + * @export + * @interface SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request + */ +export interface SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request { + /** + * Name of the extended search attribute configuration to delete. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1 + */ + readonly name: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSearchAttributeConfigV1 operation in SearchAttributeConfigurationV1Api. + * @export + * @interface SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request + */ +export interface SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request { + /** + * 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 SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1 + */ + readonly offset?: number + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSingleSearchAttributeConfigV1 operation in SearchAttributeConfigurationV1Api. + * @export + * @interface SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request + */ +export interface SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request { + /** + * Name of the extended search attribute configuration to get. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1 + */ + readonly name: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchSearchAttributeConfigV1 operation in SearchAttributeConfigurationV1Api. + * @export + * @interface SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request + */ +export interface SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request { + /** + * Name of the search attribute configuration to patch. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1 + */ + readonly name: string + + /** + * + * @type {Array} + * @memberof SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1 + */ + readonly jsonpatchoperationV1: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * SearchAttributeConfigurationV1Api - object-oriented interface + * @export + * @class SearchAttributeConfigurationV1Api + * @extends {BaseAPI} + */ +export class SearchAttributeConfigurationV1Api extends BaseAPI { + /** + * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** + * @summary Create extended search attributes + * @param {SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchAttributeConfigurationV1Api + */ + public createSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiCreateSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchAttributeConfigurationV1ApiFp(this.configuration).createSearchAttributeConfigV1(requestParameters.searchattributeconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an extended attribute configuration by name. + * @summary Delete extended search attribute + * @param {SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchAttributeConfigurationV1Api + */ + public deleteSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiDeleteSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchAttributeConfigurationV1ApiFp(this.configuration).deleteSearchAttributeConfigV1(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + * @summary List extended search attributes + * @param {SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchAttributeConfigurationV1Api + */ + public getSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiGetSearchAttributeConfigV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SearchAttributeConfigurationV1ApiFp(this.configuration).getSearchAttributeConfigV1(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get an extended attribute configuration by name. + * @summary Get extended search attribute + * @param {SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchAttributeConfigurationV1Api + */ + public getSingleSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiGetSingleSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchAttributeConfigurationV1ApiFp(this.configuration).getSingleSearchAttributeConfigV1(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes + * @summary Update extended search attribute + * @param {SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SearchAttributeConfigurationV1Api + */ + public patchSearchAttributeConfigV1(requestParameters: SearchAttributeConfigurationV1ApiPatchSearchAttributeConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SearchAttributeConfigurationV1ApiFp(this.configuration).patchSearchAttributeConfigV1(requestParameters.name, requestParameters.jsonpatchoperationV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/search_attribute_configuration/base.ts b/sdk-output/search_attribute_configuration/base.ts new file mode 100644 index 00000000..cf73e8e3 --- /dev/null +++ b/sdk-output/search_attribute_configuration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search Attribute Configuration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/search_attribute_configuration/common.ts b/sdk-output/search_attribute_configuration/common.ts new file mode 100644 index 00000000..60ef4679 --- /dev/null +++ b/sdk-output/search_attribute_configuration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search Attribute Configuration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/search_attribute_configuration/configuration.ts b/sdk-output/search_attribute_configuration/configuration.ts new file mode 100644 index 00000000..df0222c5 --- /dev/null +++ b/sdk-output/search_attribute_configuration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search Attribute Configuration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/search_attribute_configuration/git_push.sh b/sdk-output/search_attribute_configuration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/search_attribute_configuration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/search_attribute_configuration/index.ts b/sdk-output/search_attribute_configuration/index.ts new file mode 100644 index 00000000..733b94bc --- /dev/null +++ b/sdk-output/search_attribute_configuration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Search Attribute Configuration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/search_attribute_configuration/package.json b/sdk-output/search_attribute_configuration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/search_attribute_configuration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/search_attribute_configuration/tsconfig.json b/sdk-output/search_attribute_configuration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/search_attribute_configuration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/segments/.gitignore b/sdk-output/segments/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/segments/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/segments/.npmignore b/sdk-output/segments/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/segments/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/segments/.openapi-generator-ignore b/sdk-output/segments/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/segments/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/segments/.openapi-generator/FILES b/sdk-output/segments/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/segments/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/segments/.openapi-generator/VERSION b/sdk-output/segments/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/segments/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/segments/.sdk-partition b/sdk-output/segments/.sdk-partition new file mode 100644 index 00000000..b25f7f33 --- /dev/null +++ b/sdk-output/segments/.sdk-partition @@ -0,0 +1 @@ +segments \ No newline at end of file diff --git a/sdk-output/segments/README.md b/sdk-output/segments/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/segments/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/segments/api.ts b/sdk-output/segments/api.ts new file mode 100644 index 00000000..abd67a1e --- /dev/null +++ b/sdk-output/segments/api.ts @@ -0,0 +1,831 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Segments + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ExpressionChildrenInnerV1 + */ +export interface ExpressionChildrenInnerV1 { + /** + * Operator for the expression + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'operator'?: ExpressionChildrenInnerV1OperatorV1; + /** + * Name for the attribute + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'attribute'?: string | null; + /** + * + * @type {ValueV1} + * @memberof ExpressionChildrenInnerV1 + */ + 'value'?: ValueV1 | null; + /** + * There cannot be anymore nested children. This will always be null. + * @type {string} + * @memberof ExpressionChildrenInnerV1 + */ + 'children'?: string | null; +} + +export const ExpressionChildrenInnerV1OperatorV1 = { + And: 'AND', + Equals: 'EQUALS' +} as const; + +export type ExpressionChildrenInnerV1OperatorV1 = typeof ExpressionChildrenInnerV1OperatorV1[keyof typeof ExpressionChildrenInnerV1OperatorV1]; + +/** + * + * @export + * @interface ExpressionV1 + */ +export interface ExpressionV1 { + /** + * Operator for the expression + * @type {string} + * @memberof ExpressionV1 + */ + 'operator'?: ExpressionV1OperatorV1; + /** + * Name for the attribute + * @type {string} + * @memberof ExpressionV1 + */ + 'attribute'?: string | null; + /** + * + * @type {ValueV1} + * @memberof ExpressionV1 + */ + 'value'?: ValueV1 | null; + /** + * List of expressions + * @type {Array} + * @memberof ExpressionV1 + */ + 'children'?: Array | null; +} + +export const ExpressionV1OperatorV1 = { + And: 'AND', + Equals: 'EQUALS' +} as const; + +export type ExpressionV1OperatorV1 = typeof ExpressionV1OperatorV1[keyof typeof ExpressionV1OperatorV1]; + +/** + * + * @export + * @interface ListSegmentsV1401ResponseV1 + */ +export interface ListSegmentsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSegmentsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListSegmentsV1429ResponseV1 + */ +export interface ListSegmentsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSegmentsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The owner of this object. + * @export + * @interface OwnerreferencesegmentsV1 + */ +export interface OwnerreferencesegmentsV1 { + /** + * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferencesegmentsV1 + */ + 'type'?: OwnerreferencesegmentsV1TypeV1; + /** + * Identity id + * @type {string} + * @memberof OwnerreferencesegmentsV1 + */ + 'id'?: string; + /** + * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. + * @type {string} + * @memberof OwnerreferencesegmentsV1 + */ + 'name'?: string; +} + +export const OwnerreferencesegmentsV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerreferencesegmentsV1TypeV1 = typeof OwnerreferencesegmentsV1TypeV1[keyof typeof OwnerreferencesegmentsV1TypeV1]; + +/** + * + * @export + * @interface SegmentV1 + */ +export interface SegmentV1 { + /** + * The segment\'s ID. + * @type {string} + * @memberof SegmentV1 + */ + 'id'?: string; + /** + * The segment\'s business name. + * @type {string} + * @memberof SegmentV1 + */ + 'name'?: string; + /** + * The time when the segment is created. + * @type {string} + * @memberof SegmentV1 + */ + 'created'?: string; + /** + * The time when the segment is modified. + * @type {string} + * @memberof SegmentV1 + */ + 'modified'?: string; + /** + * The segment\'s optional description. + * @type {string} + * @memberof SegmentV1 + */ + 'description'?: string; + /** + * + * @type {OwnerreferencesegmentsV1} + * @memberof SegmentV1 + */ + 'owner'?: OwnerreferencesegmentsV1 | null; + /** + * + * @type {SegmentVisibilityCriteriaV1} + * @memberof SegmentV1 + */ + 'visibilityCriteria'?: SegmentVisibilityCriteriaV1; + /** + * This boolean indicates whether the segment is currently active. Inactive segments have no effect. + * @type {boolean} + * @memberof SegmentV1 + */ + 'active'?: boolean; +} +/** + * + * @export + * @interface SegmentVisibilityCriteriaV1 + */ +export interface SegmentVisibilityCriteriaV1 { + /** + * + * @type {ExpressionV1} + * @memberof SegmentVisibilityCriteriaV1 + */ + 'expression'?: ExpressionV1; +} +/** + * + * @export + * @interface ValueV1 + */ +export interface ValueV1 { + /** + * The type of attribute value + * @type {string} + * @memberof ValueV1 + */ + 'type'?: string; + /** + * The attribute value + * @type {string} + * @memberof ValueV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface VisibilitycriteriaV1 + */ +export interface VisibilitycriteriaV1 { + /** + * + * @type {ExpressionV1} + * @memberof VisibilitycriteriaV1 + */ + 'expression'?: ExpressionV1; +} + +/** + * SegmentsV1Api - axios parameter creator + * @export + */ +export const SegmentsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {SegmentV1} segmentV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSegmentV1: async (segmentV1: SegmentV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'segmentV1' is not null or undefined + assertParamExists('createSegmentV1', 'segmentV1', segmentV1) + const localVarPath = `/segments/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(segmentV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. + * @summary Delete segment by id + * @param {string} id The segment ID to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSegmentV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSegmentV1', 'id', id) + const localVarPath = `/segments/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, + }; + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {string} id The segment ID to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSegmentV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSegmentV1', 'id', id) + const localVarPath = `/segments/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, + }; + }, + /** + * This API returns a list of all segments. + * @summary List segments + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSegmentsV1: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/segments/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. + * @summary Update segment + * @param {string} id The segment ID to modify. + * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSegmentV1: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSegmentV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('patchSegmentV1', 'requestBody', requestBody) + const localVarPath = `/segments/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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SegmentsV1Api - functional programming interface + * @export + */ +export const SegmentsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SegmentsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {SegmentV1} segmentV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSegmentV1(segmentV1: SegmentV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSegmentV1(segmentV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SegmentsV1Api.createSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. + * @summary Delete segment by id + * @param {string} id The segment ID to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSegmentV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegmentV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SegmentsV1Api.deleteSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {string} id The segment ID to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSegmentV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSegmentV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SegmentsV1Api.getSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all segments. + * @summary List segments + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSegmentsV1(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSegmentsV1(limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SegmentsV1Api.listSegmentsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. + * @summary Update segment + * @param {string} id The segment ID to modify. + * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSegmentV1(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegmentV1(id, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SegmentsV1Api.patchSegmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SegmentsV1Api - factory interface + * @export + */ +export const SegmentsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SegmentsV1ApiFp(configuration) + return { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {SegmentsV1ApiCreateSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSegmentV1(requestParameters: SegmentsV1ApiCreateSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSegmentV1(requestParameters.segmentV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. + * @summary Delete segment by id + * @param {SegmentsV1ApiDeleteSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSegmentV1(requestParameters: SegmentsV1ApiDeleteSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSegmentV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {SegmentsV1ApiGetSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSegmentV1(requestParameters: SegmentsV1ApiGetSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSegmentV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all segments. + * @summary List segments + * @param {SegmentsV1ApiListSegmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSegmentsV1(requestParameters: SegmentsV1ApiListSegmentsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSegmentsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. + * @summary Update segment + * @param {SegmentsV1ApiPatchSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSegmentV1(requestParameters: SegmentsV1ApiPatchSegmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSegmentV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSegmentV1 operation in SegmentsV1Api. + * @export + * @interface SegmentsV1ApiCreateSegmentV1Request + */ +export interface SegmentsV1ApiCreateSegmentV1Request { + /** + * + * @type {SegmentV1} + * @memberof SegmentsV1ApiCreateSegmentV1 + */ + readonly segmentV1: SegmentV1 +} + +/** + * Request parameters for deleteSegmentV1 operation in SegmentsV1Api. + * @export + * @interface SegmentsV1ApiDeleteSegmentV1Request + */ +export interface SegmentsV1ApiDeleteSegmentV1Request { + /** + * The segment ID to delete. + * @type {string} + * @memberof SegmentsV1ApiDeleteSegmentV1 + */ + readonly id: string +} + +/** + * Request parameters for getSegmentV1 operation in SegmentsV1Api. + * @export + * @interface SegmentsV1ApiGetSegmentV1Request + */ +export interface SegmentsV1ApiGetSegmentV1Request { + /** + * The segment ID to retrieve. + * @type {string} + * @memberof SegmentsV1ApiGetSegmentV1 + */ + readonly id: string +} + +/** + * Request parameters for listSegmentsV1 operation in SegmentsV1Api. + * @export + * @interface SegmentsV1ApiListSegmentsV1Request + */ +export interface SegmentsV1ApiListSegmentsV1Request { + /** + * 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 SegmentsV1ApiListSegmentsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SegmentsV1ApiListSegmentsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof SegmentsV1ApiListSegmentsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for patchSegmentV1 operation in SegmentsV1Api. + * @export + * @interface SegmentsV1ApiPatchSegmentV1Request + */ +export interface SegmentsV1ApiPatchSegmentV1Request { + /** + * The segment ID to modify. + * @type {string} + * @memberof SegmentsV1ApiPatchSegmentV1 + */ + readonly id: string + + /** + * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + * @type {Array} + * @memberof SegmentsV1ApiPatchSegmentV1 + */ + readonly requestBody: Array +} + +/** + * SegmentsV1Api - object-oriented interface + * @export + * @class SegmentsV1Api + * @extends {BaseAPI} + */ +export class SegmentsV1Api extends BaseAPI { + /** + * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. + * @summary Create segment + * @param {SegmentsV1ApiCreateSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SegmentsV1Api + */ + public createSegmentV1(requestParameters: SegmentsV1ApiCreateSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SegmentsV1ApiFp(this.configuration).createSegmentV1(requestParameters.segmentV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. + * @summary Delete segment by id + * @param {SegmentsV1ApiDeleteSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SegmentsV1Api + */ + public deleteSegmentV1(requestParameters: SegmentsV1ApiDeleteSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SegmentsV1ApiFp(this.configuration).deleteSegmentV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the segment specified by the given ID. + * @summary Get segment by id + * @param {SegmentsV1ApiGetSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SegmentsV1Api + */ + public getSegmentV1(requestParameters: SegmentsV1ApiGetSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SegmentsV1ApiFp(this.configuration).getSegmentV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all segments. + * @summary List segments + * @param {SegmentsV1ApiListSegmentsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SegmentsV1Api + */ + public listSegmentsV1(requestParameters: SegmentsV1ApiListSegmentsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SegmentsV1ApiFp(this.configuration).listSegmentsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. + * @summary Update segment + * @param {SegmentsV1ApiPatchSegmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SegmentsV1Api + */ + public patchSegmentV1(requestParameters: SegmentsV1ApiPatchSegmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SegmentsV1ApiFp(this.configuration).patchSegmentV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/segments/base.ts b/sdk-output/segments/base.ts new file mode 100644 index 00000000..d8dcf415 --- /dev/null +++ b/sdk-output/segments/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Segments + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/segments/common.ts b/sdk-output/segments/common.ts new file mode 100644 index 00000000..285539ce --- /dev/null +++ b/sdk-output/segments/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Segments + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/segments/configuration.ts b/sdk-output/segments/configuration.ts new file mode 100644 index 00000000..b14095db --- /dev/null +++ b/sdk-output/segments/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Segments + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/segments/git_push.sh b/sdk-output/segments/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/segments/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/segments/index.ts b/sdk-output/segments/index.ts new file mode 100644 index 00000000..f0e4bd90 --- /dev/null +++ b/sdk-output/segments/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Segments + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/segments/package.json b/sdk-output/segments/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/segments/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/segments/tsconfig.json b/sdk-output/segments/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/segments/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/service_desk_integration/.gitignore b/sdk-output/service_desk_integration/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/service_desk_integration/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/service_desk_integration/.npmignore b/sdk-output/service_desk_integration/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/service_desk_integration/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/service_desk_integration/.openapi-generator-ignore b/sdk-output/service_desk_integration/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/service_desk_integration/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/service_desk_integration/.openapi-generator/FILES b/sdk-output/service_desk_integration/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/service_desk_integration/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/service_desk_integration/.openapi-generator/VERSION b/sdk-output/service_desk_integration/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/service_desk_integration/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/service_desk_integration/.sdk-partition b/sdk-output/service_desk_integration/.sdk-partition new file mode 100644 index 00000000..96dac0e2 --- /dev/null +++ b/sdk-output/service_desk_integration/.sdk-partition @@ -0,0 +1 @@ +service-desk-integration \ No newline at end of file diff --git a/sdk-output/service_desk_integration/README.md b/sdk-output/service_desk_integration/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/service_desk_integration/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/service_desk_integration/api.ts b/sdk-output/service_desk_integration/api.ts new file mode 100644 index 00000000..327ee5a8 --- /dev/null +++ b/sdk-output/service_desk_integration/api.ts @@ -0,0 +1,1476 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Service Desk Integration + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * Before Provisioning Rule. + * @export + * @interface BeforeprovisioningruledtoV1 + */ +export interface BeforeprovisioningruledtoV1 { + /** + * Before Provisioning Rule DTO type. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'type'?: BeforeprovisioningruledtoV1TypeV1; + /** + * Before Provisioning Rule ID. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'id'?: string; + /** + * Rule display name. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'name'?: string; +} + +export const BeforeprovisioningruledtoV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type BeforeprovisioningruledtoV1TypeV1 = typeof BeforeprovisioningruledtoV1TypeV1[keyof typeof BeforeprovisioningruledtoV1TypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetServiceDeskIntegrationsV1401ResponseV1 + */ +export interface GetServiceDeskIntegrationsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetServiceDeskIntegrationsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetServiceDeskIntegrationsV1429ResponseV1 + */ +export interface GetServiceDeskIntegrationsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetServiceDeskIntegrationsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner\'s identity. + * @export + * @interface OwnerdtoV1 + */ +export interface OwnerdtoV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'type'?: OwnerdtoV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'name'?: string; +} + +export const OwnerdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerdtoV1TypeV1 = typeof OwnerdtoV1TypeV1[keyof typeof OwnerdtoV1TypeV1]; + +/** + * This is a reference to a plan initializer script. + * @export + * @interface ProvisioningconfigPlanInitializerScriptV1 + */ +export interface ProvisioningconfigPlanInitializerScriptV1 { + /** + * This is a Rule that allows provisioning instruction changes. + * @type {string} + * @memberof ProvisioningconfigPlanInitializerScriptV1 + */ + 'source'?: string; +} +/** + * Specification of a Service Desk integration provisioning configuration. + * @export + * @interface ProvisioningconfigV1 + */ +export interface ProvisioningconfigV1 { + /** + * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. + * @type {boolean} + * @memberof ProvisioningconfigV1 + */ + 'universalManager'?: boolean; + /** + * References to sources for the Service Desk integration template. May only be specified if universalManager is false. + * @type {Array} + * @memberof ProvisioningconfigV1 + */ + 'managedResourceRefs'?: Array; + /** + * + * @type {ProvisioningconfigPlanInitializerScriptV1} + * @memberof ProvisioningconfigV1 + */ + 'planInitializerScript'?: ProvisioningconfigPlanInitializerScriptV1 | null; + /** + * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + * @type {boolean} + * @memberof ProvisioningconfigV1 + */ + 'noProvisioningRequests'?: boolean; + /** + * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. + * @type {number} + * @memberof ProvisioningconfigV1 + */ + 'provisioningRequestExpiration'?: number; +} +/** + * Configuration of maximum number of days and interval for checking Service Desk integration queue status. + * @export + * @interface QueuedcheckconfigdetailsV1 + */ +export interface QueuedcheckconfigdetailsV1 { + /** + * Interval in minutes between status checks + * @type {string} + * @memberof QueuedcheckconfigdetailsV1 + */ + 'provisioningStatusCheckIntervalMinutes': string; + /** + * Maximum number of days to check + * @type {string} + * @memberof QueuedcheckconfigdetailsV1 + */ + 'provisioningMaxStatusCheckDays': string; +} +/** + * + * @export + * @interface ServicedeskintegrationdtoV1 + */ +export interface ServicedeskintegrationdtoV1 { + /** + * Unique identifier for the Service Desk integration + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'id'?: string; + /** + * Service Desk integration\'s name. The name must be unique. + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'name': string; + /** + * The date and time the Service Desk integration was created + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'created'?: string; + /** + * The date and time the Service Desk integration was last modified + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'modified'?: string; + /** + * Service Desk integration\'s description. + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'description': string; + /** + * Service Desk integration types: - ServiceNowSDIM - ServiceNow + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'type': string; + /** + * + * @type {OwnerdtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'ownerRef'?: OwnerdtoV1; + /** + * + * @type {SourceclusterdtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'clusterRef'?: SourceclusterdtoV1; + /** + * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + * @deprecated + */ + 'cluster'?: string | null; + /** + * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). + * @type {Array} + * @memberof ServicedeskintegrationdtoV1 + * @deprecated + */ + 'managedSources'?: Array; + /** + * + * @type {ProvisioningconfigV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'provisioningConfig'?: ProvisioningconfigV1; + /** + * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. + * @type {{ [key: string]: any; }} + * @memberof ServicedeskintegrationdtoV1 + */ + 'attributes': { [key: string]: any; }; + /** + * + * @type {BeforeprovisioningruledtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'beforeProvisioningRule'?: BeforeprovisioningruledtoV1; +} +/** + * + * @export + * @interface ServicedeskintegrationtemplatedtoV1 + */ +export interface ServicedeskintegrationtemplatedtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'modified'?: string; + /** + * The \'type\' property specifies the type of the Service Desk integration template. + * @type {string} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'type': string; + /** + * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. + * @type {{ [key: string]: any; }} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'attributes': { [key: string]: any; }; + /** + * + * @type {ProvisioningconfigV1} + * @memberof ServicedeskintegrationtemplatedtoV1 + */ + 'provisioningConfig': ProvisioningconfigV1; +} +/** + * This represents a Service Desk Integration template type. + * @export + * @interface ServicedeskintegrationtemplatetypeV1 + */ +export interface ServicedeskintegrationtemplatetypeV1 { + /** + * This is the name of the type. + * @type {string} + * @memberof ServicedeskintegrationtemplatetypeV1 + */ + 'name'?: string; + /** + * This is the type value for the type. + * @type {string} + * @memberof ServicedeskintegrationtemplatetypeV1 + */ + 'type': string; + /** + * This is the scriptName attribute value for the type. + * @type {string} + * @memberof ServicedeskintegrationtemplatetypeV1 + */ + 'scriptName': string; +} +/** + * Source for Service Desk integration template. + * @export + * @interface ServicedesksourceV1 + */ +export interface ServicedesksourceV1 { + /** + * DTO type of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'type'?: ServicedesksourceV1TypeV1; + /** + * ID of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'id'?: string; + /** + * Human-readable name of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'name'?: string; +} + +export const ServicedesksourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type ServicedesksourceV1TypeV1 = typeof ServicedesksourceV1TypeV1[keyof typeof ServicedesksourceV1TypeV1]; + +/** + * Source cluster. + * @export + * @interface SourceclusterdtoV1 + */ +export interface SourceclusterdtoV1 { + /** + * Source cluster DTO type. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'type'?: SourceclusterdtoV1TypeV1; + /** + * Source cluster ID. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'id'?: string; + /** + * Source cluster display name. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'name'?: string; +} + +export const SourceclusterdtoV1TypeV1 = { + Cluster: 'CLUSTER' +} as const; + +export type SourceclusterdtoV1TypeV1 = typeof SourceclusterdtoV1TypeV1[keyof typeof SourceclusterdtoV1TypeV1]; + + +/** + * ServiceDeskIntegrationV1Api - axios parameter creator + * @export + */ +export const ServiceDeskIntegrationV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new Service Desk integration. + * @summary Create new service desk integration + * @param {ServicedeskintegrationdtoV1} servicedeskintegrationdtoV1 The specifics of a new integration to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createServiceDeskIntegrationV1: async (servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'servicedeskintegrationdtoV1' is not null or undefined + assertParamExists('createServiceDeskIntegrationV1', 'servicedeskintegrationdtoV1', servicedeskintegrationdtoV1) + const localVarPath = `/service-desk-integrations/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(servicedeskintegrationdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete an existing Service Desk integration by ID. + * @summary Delete a service desk integration + * @param {string} id ID of Service Desk integration to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteServiceDeskIntegrationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteServiceDeskIntegrationV1', 'id', id) + const localVarPath = `/service-desk-integrations/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, + }; + }, + /** + * This API endpoint returns an existing Service Desk integration template by scriptName. + * @summary Service desk integration template by scriptname + * @param {string} scriptName The scriptName value of the Service Desk integration template to get + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationTemplateV1: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'scriptName' is not null or undefined + assertParamExists('getServiceDeskIntegrationTemplateV1', 'scriptName', scriptName) + const localVarPath = `/service-desk-integrations/v1/templates/{scriptName}` + .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint returns the current list of supported Service Desk integration types. + * @summary List service desk integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationTypesV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/service-desk-integrations/v1/types`; + // 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 an existing Service Desk integration by ID. + * @summary Get a service desk integration + * @param {string} id ID of the Service Desk integration to get + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getServiceDeskIntegrationV1', 'id', id) + const localVarPath = `/service-desk-integrations/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, + }; + }, + /** + * Get a list of Service Desk integration objects. + * @summary List existing service desk integrations + * @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 {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: **name** + * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationsV1: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/service-desk-integrations/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 (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the time check configuration of queued SDIM tickets. + * @summary Get the time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStatusCheckDetailsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/service-desk-integrations/v1/status-check-configuration`; + // 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, + }; + }, + /** + * Update an existing Service Desk integration by ID with a PATCH request. + * @summary Patch a service desk integration + * @param {string} id ID of the Service Desk integration to update + * @param {Array} jsonpatchoperationV1 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchServiceDeskIntegrationV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchServiceDeskIntegrationV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchServiceDeskIntegrationV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/service-desk-integrations/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update an existing Service Desk integration by ID. + * @summary Update a service desk integration + * @param {string} id ID of the Service Desk integration to update + * @param {ServicedeskintegrationdtoV1} servicedeskintegrationdtoV1 The specifics of the integration to update + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putServiceDeskIntegrationV1: async (id: string, servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putServiceDeskIntegrationV1', 'id', id) + // verify required parameter 'servicedeskintegrationdtoV1' is not null or undefined + assertParamExists('putServiceDeskIntegrationV1', 'servicedeskintegrationdtoV1', servicedeskintegrationdtoV1) + const localVarPath = `/service-desk-integrations/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: 'PUT', ...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(servicedeskintegrationdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update the time check configuration of queued SDIM tickets. + * @summary Update the time check configuration + * @param {QueuedcheckconfigdetailsV1} queuedcheckconfigdetailsV1 The modified time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStatusCheckDetailsV1: async (queuedcheckconfigdetailsV1: QueuedcheckconfigdetailsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'queuedcheckconfigdetailsV1' is not null or undefined + assertParamExists('updateStatusCheckDetailsV1', 'queuedcheckconfigdetailsV1', queuedcheckconfigdetailsV1) + const localVarPath = `/service-desk-integrations/v1/status-check-configuration`; + // 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: 'PUT', ...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(queuedcheckconfigdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * ServiceDeskIntegrationV1Api - functional programming interface + * @export + */ +export const ServiceDeskIntegrationV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ServiceDeskIntegrationV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new Service Desk integration. + * @summary Create new service desk integration + * @param {ServicedeskintegrationdtoV1} servicedeskintegrationdtoV1 The specifics of a new integration to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createServiceDeskIntegrationV1(servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegrationV1(servicedeskintegrationdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.createServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete an existing Service Desk integration by ID. + * @summary Delete a service desk integration + * @param {string} id ID of Service Desk integration to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteServiceDeskIntegrationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegrationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.deleteServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint returns an existing Service Desk integration template by scriptName. + * @summary Service desk integration template by scriptname + * @param {string} scriptName The scriptName value of the Service Desk integration template to get + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getServiceDeskIntegrationTemplateV1(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplateV1(scriptName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.getServiceDeskIntegrationTemplateV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint returns the current list of supported Service Desk integration types. + * @summary List service desk integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypesV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.getServiceDeskIntegrationTypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get an existing Service Desk integration by ID. + * @summary Get a service desk integration + * @param {string} id ID of the Service Desk integration to get + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getServiceDeskIntegrationV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.getServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of Service Desk integration objects. + * @summary List existing service desk integrations + * @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 {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: **name** + * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getServiceDeskIntegrationsV1(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationsV1(offset, limit, sorters, filters, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.getServiceDeskIntegrationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the time check configuration of queued SDIM tickets. + * @summary Get the time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetailsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.getStatusCheckDetailsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing Service Desk integration by ID with a PATCH request. + * @summary Patch a service desk integration + * @param {string} id ID of the Service Desk integration to update + * @param {Array} jsonpatchoperationV1 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchServiceDeskIntegrationV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegrationV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.patchServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing Service Desk integration by ID. + * @summary Update a service desk integration + * @param {string} id ID of the Service Desk integration to update + * @param {ServicedeskintegrationdtoV1} servicedeskintegrationdtoV1 The specifics of the integration to update + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putServiceDeskIntegrationV1(id: string, servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegrationV1(id, servicedeskintegrationdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.putServiceDeskIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update the time check configuration of queued SDIM tickets. + * @summary Update the time check configuration + * @param {QueuedcheckconfigdetailsV1} queuedcheckconfigdetailsV1 The modified time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateStatusCheckDetailsV1(queuedcheckconfigdetailsV1: QueuedcheckconfigdetailsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetailsV1(queuedcheckconfigdetailsV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV1Api.updateStatusCheckDetailsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ServiceDeskIntegrationV1Api - factory interface + * @export + */ +export const ServiceDeskIntegrationV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ServiceDeskIntegrationV1ApiFp(configuration) + return { + /** + * Create a new Service Desk integration. + * @summary Create new service desk integration + * @param {ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createServiceDeskIntegrationV1(requestParameters.servicedeskintegrationdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete an existing Service Desk integration by ID. + * @summary Delete a service desk integration + * @param {ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint returns an existing Service Desk integration template by scriptName. + * @summary Service desk integration template by scriptname + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationTemplateV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getServiceDeskIntegrationTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint returns the current list of supported Service Desk integration types. + * @summary List service desk integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getServiceDeskIntegrationTypesV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get an existing Service Desk integration by ID. + * @summary Get a service desk integration + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of Service Desk integration objects. + * @summary List existing service desk integrations + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getServiceDeskIntegrationsV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getServiceDeskIntegrationsV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the time check configuration of queued SDIM tickets. + * @summary Get the time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getStatusCheckDetailsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing Service Desk integration by ID with a PATCH request. + * @summary Patch a service desk integration + * @param {ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchServiceDeskIntegrationV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing Service Desk integration by ID. + * @summary Update a service desk integration + * @param {ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putServiceDeskIntegrationV1(requestParameters.id, requestParameters.servicedeskintegrationdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update the time check configuration of queued SDIM tickets. + * @summary Update the time check configuration + * @param {ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStatusCheckDetailsV1(requestParameters: ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateStatusCheckDetailsV1(requestParameters.queuedcheckconfigdetailsV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createServiceDeskIntegrationV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request + */ +export interface ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request { + /** + * The specifics of a new integration to create + * @type {ServicedeskintegrationdtoV1} + * @memberof ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1 + */ + readonly servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 +} + +/** + * Request parameters for deleteServiceDeskIntegrationV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request + */ +export interface ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request { + /** + * ID of Service Desk integration to delete + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1 + */ + readonly id: string +} + +/** + * Request parameters for getServiceDeskIntegrationTemplateV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request + */ +export interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request { + /** + * The scriptName value of the Service Desk integration template to get + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1 + */ + readonly scriptName: string +} + +/** + * Request parameters for getServiceDeskIntegrationV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request + */ +export interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request { + /** + * ID of the Service Desk integration to get + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1 + */ + readonly id: string +} + +/** + * Request parameters for getServiceDeskIntegrationsV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request + */ +export interface ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request { + /** + * 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 ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1 + */ + 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 ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1 + */ + readonly limit?: number + + /** + * 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: **name** + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1 + */ + readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1 + */ + readonly filters?: string + + /** + * 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 ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for patchServiceDeskIntegrationV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request + */ +export interface ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request { + /** + * ID of the Service Desk integration to update + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1 + */ + readonly id: string + + /** + * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + * @type {Array} + * @memberof ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for putServiceDeskIntegrationV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request + */ +export interface ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request { + /** + * ID of the Service Desk integration to update + * @type {string} + * @memberof ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1 + */ + readonly id: string + + /** + * The specifics of the integration to update + * @type {ServicedeskintegrationdtoV1} + * @memberof ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1 + */ + readonly servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 +} + +/** + * Request parameters for updateStatusCheckDetailsV1 operation in ServiceDeskIntegrationV1Api. + * @export + * @interface ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request + */ +export interface ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request { + /** + * The modified time check configuration + * @type {QueuedcheckconfigdetailsV1} + * @memberof ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1 + */ + readonly queuedcheckconfigdetailsV1: QueuedcheckconfigdetailsV1 +} + +/** + * ServiceDeskIntegrationV1Api - object-oriented interface + * @export + * @class ServiceDeskIntegrationV1Api + * @extends {BaseAPI} + */ +export class ServiceDeskIntegrationV1Api extends BaseAPI { + /** + * Create a new Service Desk integration. + * @summary Create new service desk integration + * @param {ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public createServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiCreateServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).createServiceDeskIntegrationV1(requestParameters.servicedeskintegrationdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete an existing Service Desk integration by ID. + * @summary Delete a service desk integration + * @param {ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public deleteServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiDeleteServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).deleteServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint returns an existing Service Desk integration template by scriptName. + * @summary Service desk integration template by scriptname + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public getServiceDeskIntegrationTemplateV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).getServiceDeskIntegrationTemplateV1(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint returns the current list of supported Service Desk integration types. + * @summary List service desk integration types + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public getServiceDeskIntegrationTypesV1(axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).getServiceDeskIntegrationTypesV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get an existing Service Desk integration by ID. + * @summary Get a service desk integration + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public getServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).getServiceDeskIntegrationV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of Service Desk integration objects. + * @summary List existing service desk integrations + * @param {ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public getServiceDeskIntegrationsV1(requestParameters: ServiceDeskIntegrationV1ApiGetServiceDeskIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).getServiceDeskIntegrationsV1(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the time check configuration of queued SDIM tickets. + * @summary Get the time check configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public getStatusCheckDetailsV1(axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).getStatusCheckDetailsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing Service Desk integration by ID with a PATCH request. + * @summary Patch a service desk integration + * @param {ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public patchServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiPatchServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).patchServiceDeskIntegrationV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing Service Desk integration by ID. + * @summary Update a service desk integration + * @param {ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public putServiceDeskIntegrationV1(requestParameters: ServiceDeskIntegrationV1ApiPutServiceDeskIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).putServiceDeskIntegrationV1(requestParameters.id, requestParameters.servicedeskintegrationdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update the time check configuration of queued SDIM tickets. + * @summary Update the time check configuration + * @param {ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof ServiceDeskIntegrationV1Api + */ + public updateStatusCheckDetailsV1(requestParameters: ServiceDeskIntegrationV1ApiUpdateStatusCheckDetailsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return ServiceDeskIntegrationV1ApiFp(this.configuration).updateStatusCheckDetailsV1(requestParameters.queuedcheckconfigdetailsV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/service_desk_integration/base.ts b/sdk-output/service_desk_integration/base.ts new file mode 100644 index 00000000..e573886d --- /dev/null +++ b/sdk-output/service_desk_integration/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Service Desk Integration + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/service_desk_integration/common.ts b/sdk-output/service_desk_integration/common.ts new file mode 100644 index 00000000..17fe778d --- /dev/null +++ b/sdk-output/service_desk_integration/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Service Desk Integration + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/service_desk_integration/configuration.ts b/sdk-output/service_desk_integration/configuration.ts new file mode 100644 index 00000000..0eb32156 --- /dev/null +++ b/sdk-output/service_desk_integration/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Service Desk Integration + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/service_desk_integration/git_push.sh b/sdk-output/service_desk_integration/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/service_desk_integration/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/service_desk_integration/index.ts b/sdk-output/service_desk_integration/index.ts new file mode 100644 index 00000000..9e39d10b --- /dev/null +++ b/sdk-output/service_desk_integration/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Service Desk Integration + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/service_desk_integration/package.json b/sdk-output/service_desk_integration/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/service_desk_integration/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/service_desk_integration/tsconfig.json b/sdk-output/service_desk_integration/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/service_desk_integration/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/shared_signals_framework_ssf/.gitignore b/sdk-output/shared_signals_framework_ssf/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/shared_signals_framework_ssf/.npmignore b/sdk-output/shared_signals_framework_ssf/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/shared_signals_framework_ssf/.openapi-generator-ignore b/sdk-output/shared_signals_framework_ssf/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES b/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/shared_signals_framework_ssf/.openapi-generator/VERSION b/sdk-output/shared_signals_framework_ssf/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/shared_signals_framework_ssf/.sdk-partition b/sdk-output/shared_signals_framework_ssf/.sdk-partition new file mode 100644 index 00000000..961a4ed0 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/.sdk-partition @@ -0,0 +1 @@ +shared-signals-framework-ssf \ No newline at end of file diff --git a/sdk-output/shared_signals_framework_ssf/README.md b/sdk-output/shared_signals_framework_ssf/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/shared_signals_framework_ssf/api.ts b/sdk-output/shared_signals_framework_ssf/api.ts new file mode 100644 index 00000000..fdef0d4d --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/api.ts @@ -0,0 +1,1506 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Shared Signals Framework (SSF) + * 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'; + +/** + * Authorization scheme supported by the transmitter. + * @export + * @interface AuthorizationschemeV1 + */ +export interface AuthorizationschemeV1 { + /** + * URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`. + * @type {string} + * @memberof AuthorizationschemeV1 + */ + 'spec_urn'?: string; +} +/** + * Full delivery configuration. method and endpoint_url are required. + * @export + * @interface CreatestreamdeliveryrequestV1 + */ +export interface CreatestreamdeliveryrequestV1 { + /** + * Delivery method (only push is supported). + * @type {string} + * @memberof CreatestreamdeliveryrequestV1 + */ + 'method': string; + /** + * Receiver endpoint URL for push delivery. + * @type {string} + * @memberof CreatestreamdeliveryrequestV1 + */ + 'endpoint_url': string; + /** + * Authorization header value for delivery requests. + * @type {string} + * @memberof CreatestreamdeliveryrequestV1 + */ + 'authorization_header'?: string; +} +/** + * Request body for POST /ssf/streams (create stream). + * @export + * @interface CreatestreamrequestV1 + */ +export interface CreatestreamrequestV1 { + /** + * + * @type {CreatestreamdeliveryrequestV1} + * @memberof CreatestreamrequestV1 + */ + 'delivery': CreatestreamdeliveryrequestV1; + /** + * Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). + * @type {Array} + * @memberof CreatestreamrequestV1 + */ + 'events_requested'?: Array; + /** + * Optional human-readable description of the stream. + * @type {string} + * @memberof CreatestreamrequestV1 + */ + 'description'?: string; +} +/** + * Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated. + * @export + * @interface DeliveryrequestV1 + */ +export interface DeliveryrequestV1 { + /** + * Delivery method (optional for PATCH). + * @type {string} + * @memberof DeliveryrequestV1 + */ + 'method'?: string; + /** + * Receiver endpoint URL (optional for PATCH). + * @type {string} + * @memberof DeliveryrequestV1 + */ + 'endpoint_url'?: string; + /** + * Optional authorization header value. + * @type {string} + * @memberof DeliveryrequestV1 + */ + 'authorization_header'?: string; +} +/** + * Delivery configuration returned in stream responses. + * @export + * @interface DeliveryresponseV1 + */ +export interface DeliveryresponseV1 { + /** + * Delivery method. + * @type {string} + * @memberof DeliveryresponseV1 + */ + 'method'?: string; + /** + * Receiver endpoint URL. + * @type {string} + * @memberof DeliveryresponseV1 + */ + 'endpoint_url'?: string; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetSSFConfigurationV1401ResponseV1 + */ +export interface GetSSFConfigurationV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSSFConfigurationV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetSSFConfigurationV1429ResponseV1 + */ +export interface GetSSFConfigurationV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSSFConfigurationV1429ResponseV1 + */ + 'message'?: any; +} +/** + * @type GetStreamV1200ResponseV1 + * @export + */ +export type GetStreamV1200ResponseV1 = Array | StreamconfigresponseV1; + +/** + * A single JSON Web Key used for verifying signed delivery requests. + * @export + * @interface JwkV1 + */ +export interface JwkV1 { + /** + * Algorithm intended for use with the key (e.g. RS256). + * @type {string} + * @memberof JwkV1 + */ + 'alg'?: string; + /** + * RSA public exponent (Base64url encoded). + * @type {string} + * @memberof JwkV1 + */ + 'e'?: string; + /** + * Key ID - unique identifier for the key. + * @type {string} + * @memberof JwkV1 + */ + 'kid'?: string; + /** + * Key type (e.g. RSA). + * @type {string} + * @memberof JwkV1 + */ + 'kty'?: string; + /** + * RSA modulus (Base64url encoded). + * @type {string} + * @memberof JwkV1 + */ + 'n'?: string; + /** + * Intended use of the key (e.g. sig for signature verification). + * @type {string} + * @memberof JwkV1 + */ + 'use'?: string; +} +/** + * JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests. + * @export + * @interface JwksV1 + */ +export interface JwksV1 { + /** + * Array of JSON Web Keys. + * @type {Array} + * @memberof JwksV1 + */ + 'keys': Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ReplacestreamconfigurationrequestDeliveryV1 + */ +export interface ReplacestreamconfigurationrequestDeliveryV1 { + /** + * Delivery method (only push is supported). + * @type {string} + * @memberof ReplacestreamconfigurationrequestDeliveryV1 + */ + 'method': string; + /** + * Receiver endpoint URL for push delivery. + * @type {string} + * @memberof ReplacestreamconfigurationrequestDeliveryV1 + */ + 'endpoint_url': string; + /** + * Authorization header value for delivery requests. + * @type {string} + * @memberof ReplacestreamconfigurationrequestDeliveryV1 + */ + 'authorization_header'?: string; +} +/** + * Request body for PUT /ssf/streams (full replace). + * @export + * @interface ReplacestreamconfigurationrequestV1 + */ +export interface ReplacestreamconfigurationrequestV1 { + /** + * ID of the stream to replace. + * @type {string} + * @memberof ReplacestreamconfigurationrequestV1 + */ + 'stream_id': string; + /** + * + * @type {ReplacestreamconfigurationrequestDeliveryV1} + * @memberof ReplacestreamconfigurationrequestV1 + */ + 'delivery': ReplacestreamconfigurationrequestDeliveryV1; + /** + * Event types the receiver wants. Use CAEP event-type URIs. + * @type {Array} + * @memberof ReplacestreamconfigurationrequestV1 + */ + 'events_requested'?: Array; + /** + * Optional human-readable description of the stream. + * @type {string} + * @memberof ReplacestreamconfigurationrequestV1 + */ + 'description'?: string; +} +/** + * Full stream configuration returned by create/get/update/replace. + * @export + * @interface StreamconfigresponseV1 + */ +export interface StreamconfigresponseV1 { + /** + * Unique stream identifier. + * @type {string} + * @memberof StreamconfigresponseV1 + */ + 'stream_id'?: string; + /** + * Issuer (transmitter) URL. + * @type {string} + * @memberof StreamconfigresponseV1 + */ + 'iss'?: string; + /** + * Audience for the stream. + * @type {string} + * @memberof StreamconfigresponseV1 + */ + 'aud'?: string; + /** + * + * @type {DeliveryresponseV1} + * @memberof StreamconfigresponseV1 + */ + 'delivery'?: DeliveryresponseV1; + /** + * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). + * @type {Array} + * @memberof StreamconfigresponseV1 + */ + 'events_supported'?: Array; + /** + * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). + * @type {Array} + * @memberof StreamconfigresponseV1 + */ + 'events_requested'?: Array; + /** + * Event types currently being delivered (intersection of supported and requested). + * @type {Array} + * @memberof StreamconfigresponseV1 + */ + 'events_delivered'?: Array; + /** + * Optional stream description. + * @type {string} + * @memberof StreamconfigresponseV1 + */ + 'description'?: string; + /** + * Inactivity timeout in seconds (optional). + * @type {number} + * @memberof StreamconfigresponseV1 + */ + 'inactivity_timeout'?: number; + /** + * Minimum verification interval in seconds (optional). + * @type {number} + * @memberof StreamconfigresponseV1 + */ + 'min_verification_interval'?: number; +} +/** + * Stream status returned by GET/POST /ssf/streams/status. + * @export + * @interface StreamstatusresponseV1 + */ +export interface StreamstatusresponseV1 { + /** + * Stream identifier. + * @type {string} + * @memberof StreamstatusresponseV1 + */ + 'stream_id'?: string; + /** + * Operational status of the stream (enabled, paused, or disabled). + * @type {string} + * @memberof StreamstatusresponseV1 + */ + 'status'?: StreamstatusresponseV1StatusV1; + /** + * Optional reason for the current status (e.g. set when status is updated). + * @type {string} + * @memberof StreamstatusresponseV1 + */ + 'reason'?: string; +} + +export const StreamstatusresponseV1StatusV1 = { + Enabled: 'enabled', + Paused: 'paused', + Disabled: 'disabled' +} as const; + +export type StreamstatusresponseV1StatusV1 = typeof StreamstatusresponseV1StatusV1[keyof typeof StreamstatusresponseV1StatusV1]; + +/** + * SSF transmitter discovery metadata per the SSF specification. + * @export + * @interface TransmittermetadataV1 + */ +export interface TransmittermetadataV1 { + /** + * Version of the SSF specification supported. + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'spec_version'?: string; + /** + * Base URL of the transmitter (issuer). + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'issuer'?: string; + /** + * URL of the transmitter\'s JSON Web Key Set. + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'jwks_uri'?: string; + /** + * Supported delivery methods (e.g. push URN). + * @type {Array} + * @memberof TransmittermetadataV1 + */ + 'delivery_methods_supported'?: Array; + /** + * Endpoint for stream configuration (create, read, update, replace, delete). + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'configuration_endpoint'?: string; + /** + * Endpoint for reading and updating stream status. + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'status_endpoint'?: string; + /** + * Endpoint for receiver verification. + * @type {string} + * @memberof TransmittermetadataV1 + */ + 'verification_endpoint'?: string; + /** + * Supported authorization schemes (e.g. OAuth2, Bearer). + * @type {Array} + * @memberof TransmittermetadataV1 + */ + 'authorization_schemes'?: Array; +} +/** + * Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt. + * @export + * @interface UpdatestreamconfigresponseV1 + */ +export interface UpdatestreamconfigresponseV1 { + /** + * Unique stream identifier. + * @type {string} + * @memberof UpdatestreamconfigresponseV1 + */ + 'stream_id'?: string; + /** + * Issuer (transmitter) URL. + * @type {string} + * @memberof UpdatestreamconfigresponseV1 + */ + 'iss'?: string; + /** + * Audience for the stream. + * @type {string} + * @memberof UpdatestreamconfigresponseV1 + */ + 'aud'?: string; + /** + * + * @type {DeliveryresponseV1} + * @memberof UpdatestreamconfigresponseV1 + */ + 'delivery'?: DeliveryresponseV1; + /** + * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). + * @type {Array} + * @memberof UpdatestreamconfigresponseV1 + */ + 'events_supported'?: Array; + /** + * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). + * @type {Array} + * @memberof UpdatestreamconfigresponseV1 + */ + 'events_requested'?: Array; + /** + * Event types currently being delivered (intersection of supported and requested). + * @type {Array} + * @memberof UpdatestreamconfigresponseV1 + */ + 'events_delivered'?: Array; + /** + * Optional stream description. + * @type {string} + * @memberof UpdatestreamconfigresponseV1 + */ + 'description'?: string; + /** + * Inactivity timeout in seconds (optional). + * @type {number} + * @memberof UpdatestreamconfigresponseV1 + */ + 'inactivity_timeout'?: number; + /** + * Minimum verification interval in seconds (optional). + * @type {number} + * @memberof UpdatestreamconfigresponseV1 + */ + 'min_verification_interval'?: number; + /** + * Timestamp of the last configuration update. + * @type {string} + * @memberof UpdatestreamconfigresponseV1 + */ + 'updatedAt'?: string; +} +/** + * Request body for PATCH /ssf/streams (partial update). + * @export + * @interface UpdatestreamconfigurationrequestV1 + */ +export interface UpdatestreamconfigurationrequestV1 { + /** + * ID of the stream to update. + * @type {string} + * @memberof UpdatestreamconfigurationrequestV1 + */ + 'stream_id': string; + /** + * + * @type {DeliveryrequestV1} + * @memberof UpdatestreamconfigurationrequestV1 + */ + 'delivery'?: DeliveryrequestV1; + /** + * Event types the receiver wants. Use CAEP event-type URIs. + * @type {Array} + * @memberof UpdatestreamconfigurationrequestV1 + */ + 'events_requested'?: Array; + /** + * Optional human-readable description of the stream. + * @type {string} + * @memberof UpdatestreamconfigurationrequestV1 + */ + 'description'?: string; +} +/** + * Request body for POST /ssf/streams/status. + * @export + * @interface UpdatestreamstatusrequestV1 + */ +export interface UpdatestreamstatusrequestV1 { + /** + * ID of the stream whose status to update. + * @type {string} + * @memberof UpdatestreamstatusrequestV1 + */ + 'stream_id': string; + /** + * Desired stream status. + * @type {string} + * @memberof UpdatestreamstatusrequestV1 + */ + 'status': UpdatestreamstatusrequestV1StatusV1; + /** + * Optional reason for the status change. + * @type {string} + * @memberof UpdatestreamstatusrequestV1 + */ + 'reason'?: string; +} + +export const UpdatestreamstatusrequestV1StatusV1 = { + Enabled: 'enabled', + Paused: 'paused', + Disabled: 'disabled' +} as const; + +export type UpdatestreamstatusrequestV1StatusV1 = typeof UpdatestreamstatusrequestV1StatusV1[keyof typeof UpdatestreamstatusrequestV1StatusV1]; + +/** + * Request body for POST /ssf/streams/verify (receiver verification). + * @export + * @interface VerificationrequestV1 + */ +export interface VerificationrequestV1 { + /** + * Stream ID for verification. + * @type {string} + * @memberof VerificationrequestV1 + */ + 'stream_id': string; + /** + * Optional state value for verification challenge. + * @type {string} + * @memberof VerificationrequestV1 + */ + 'state'?: string; +} + +/** + * SharedSignalsFrameworkSSFV1Api - axios parameter creator + * @export + */ +export const SharedSignalsFrameworkSSFV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. + * @summary Create stream + * @param {CreatestreamrequestV1} createstreamrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createStreamV1: async (createstreamrequestV1: CreatestreamrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createstreamrequestV1' is not null or undefined + assertParamExists('createStreamV1', 'createstreamrequestV1', createstreamrequestV1) + const localVarPath = `/ssf/v1/streams`; + // 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(createstreamrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. + * @summary Delete stream + * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteStreamV1: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'streamId' is not null or undefined + assertParamExists('deleteStreamV1', 'streamId', streamId) + const localVarPath = `/ssf/v1/streams`; + // 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; + + if (streamId !== undefined) { + localVarQueryParameter['stream_id'] = streamId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. + * @summary Get JWKS + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getJWKSDataV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/ssf/v1/jwks`; + // 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, + }; + }, + /** + * Returns the SSF transmitter discovery metadata (well-known configuration). + * @summary Get SSF configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSSFConfigurationV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/.well-known/v1/ssf-configuration`; + // 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, + }; + }, + /** + * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. + * @summary Get stream status + * @param {string} streamId ID of the stream whose status to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStreamStatusV1: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'streamId' is not null or undefined + assertParamExists('getStreamStatusV1', 'streamId', streamId) + const localVarPath = `/ssf/v1/streams/status`; + // 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 (streamId !== undefined) { + localVarQueryParameter['stream_id'] = streamId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. + * @summary Get stream(s) + * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStreamV1: async (streamId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/ssf/v1/streams`; + // 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 (streamId !== undefined) { + localVarQueryParameter['stream_id'] = streamId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Verifies an SSF stream by publishing a verification event requested by a security events provider. + * @summary Verify stream + * @param {VerificationrequestV1} verificationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendStreamVerificationV1: async (verificationrequestV1: VerificationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'verificationrequestV1' is not null or undefined + assertParamExists('sendStreamVerificationV1', 'verificationrequestV1', verificationrequestV1) + const localVarPath = `/ssf/v1/streams/verify`; + // 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(verificationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. + * @summary Replace stream configuration + * @param {ReplacestreamconfigurationrequestV1} replacestreamconfigurationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setStreamConfigurationV1: async (replacestreamconfigurationrequestV1: ReplacestreamconfigurationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'replacestreamconfigurationrequestV1' is not null or undefined + assertParamExists('setStreamConfigurationV1', 'replacestreamconfigurationrequestV1', replacestreamconfigurationrequestV1) + const localVarPath = `/ssf/v1/streams`; + // 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: 'PUT', ...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(replacestreamconfigurationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. + * @summary Update stream configuration + * @param {UpdatestreamconfigurationrequestV1} updatestreamconfigurationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStreamConfigurationV1: async (updatestreamconfigurationrequestV1: UpdatestreamconfigurationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'updatestreamconfigurationrequestV1' is not null or undefined + assertParamExists('updateStreamConfigurationV1', 'updatestreamconfigurationrequestV1', updatestreamconfigurationrequestV1) + const localVarPath = `/ssf/v1/streams`; + // 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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updatestreamconfigurationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. + * @summary Update stream status + * @param {UpdatestreamstatusrequestV1} updatestreamstatusrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStreamStatusV1: async (updatestreamstatusrequestV1: UpdatestreamstatusrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'updatestreamstatusrequestV1' is not null or undefined + assertParamExists('updateStreamStatusV1', 'updatestreamstatusrequestV1', updatestreamstatusrequestV1) + const localVarPath = `/ssf/v1/streams/status`; + // 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(updatestreamstatusrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SharedSignalsFrameworkSSFV1Api - functional programming interface + * @export + */ +export const SharedSignalsFrameworkSSFV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SharedSignalsFrameworkSSFV1ApiAxiosParamCreator(configuration) + return { + /** + * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. + * @summary Create stream + * @param {CreatestreamrequestV1} createstreamrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createStreamV1(createstreamrequestV1: CreatestreamrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createStreamV1(createstreamrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.createStreamV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. + * @summary Delete stream + * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteStreamV1(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStreamV1(streamId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.deleteStreamV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. + * @summary Get JWKS + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getJWKSDataV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.getJWKSDataV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns the SSF transmitter discovery metadata (well-known configuration). + * @summary Get SSF configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSSFConfigurationV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.getSSFConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. + * @summary Get stream status + * @param {string} streamId ID of the stream whose status to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getStreamStatusV1(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamStatusV1(streamId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.getStreamStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. + * @summary Get stream(s) + * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getStreamV1(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamV1(streamId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.getStreamV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Verifies an SSF stream by publishing a verification event requested by a security events provider. + * @summary Verify stream + * @param {VerificationrequestV1} verificationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async sendStreamVerificationV1(verificationrequestV1: VerificationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendStreamVerificationV1(verificationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.sendStreamVerificationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. + * @summary Replace stream configuration + * @param {ReplacestreamconfigurationrequestV1} replacestreamconfigurationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setStreamConfigurationV1(replacestreamconfigurationrequestV1: ReplacestreamconfigurationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setStreamConfigurationV1(replacestreamconfigurationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.setStreamConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. + * @summary Update stream configuration + * @param {UpdatestreamconfigurationrequestV1} updatestreamconfigurationrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateStreamConfigurationV1(updatestreamconfigurationrequestV1: UpdatestreamconfigurationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamConfigurationV1(updatestreamconfigurationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.updateStreamConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. + * @summary Update stream status + * @param {UpdatestreamstatusrequestV1} updatestreamstatusrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateStreamStatusV1(updatestreamstatusrequestV1: UpdatestreamstatusrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamStatusV1(updatestreamstatusrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV1Api.updateStreamStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SharedSignalsFrameworkSSFV1Api - factory interface + * @export + */ +export const SharedSignalsFrameworkSSFV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SharedSignalsFrameworkSSFV1ApiFp(configuration) + return { + /** + * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. + * @summary Create stream + * @param {SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createStreamV1(requestParameters.createstreamrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. + * @summary Delete stream + * @param {SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteStreamV1(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. + * @summary Get JWKS + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getJWKSDataV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns the SSF transmitter discovery metadata (well-known configuration). + * @summary Get SSF configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSSFConfigurationV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. + * @summary Get stream status + * @param {SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getStreamStatusV1(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. + * @summary Get stream(s) + * @param {SharedSignalsFrameworkSSFV1ApiGetStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiGetStreamV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getStreamV1(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Verifies an SSF stream by publishing a verification event requested by a security events provider. + * @summary Verify stream + * @param {SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + sendStreamVerificationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.sendStreamVerificationV1(requestParameters.verificationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. + * @summary Replace stream configuration + * @param {SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setStreamConfigurationV1(requestParameters.replacestreamconfigurationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. + * @summary Update stream configuration + * @param {SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateStreamConfigurationV1(requestParameters.updatestreamconfigurationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. + * @summary Update stream status + * @param {SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateStreamStatusV1(requestParameters.updatestreamstatusrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createStreamV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request { + /** + * + * @type {CreatestreamrequestV1} + * @memberof SharedSignalsFrameworkSSFV1ApiCreateStreamV1 + */ + readonly createstreamrequestV1: CreatestreamrequestV1 +} + +/** + * Request parameters for deleteStreamV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request { + /** + * ID of the stream to delete. Required; omitted or empty returns 400. + * @type {string} + * @memberof SharedSignalsFrameworkSSFV1ApiDeleteStreamV1 + */ + readonly streamId: string +} + +/** + * Request parameters for getStreamStatusV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request { + /** + * ID of the stream whose status to retrieve. + * @type {string} + * @memberof SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1 + */ + readonly streamId: string +} + +/** + * Request parameters for getStreamV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiGetStreamV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiGetStreamV1Request { + /** + * If provided, returns that stream; otherwise returns list of all streams. + * @type {string} + * @memberof SharedSignalsFrameworkSSFV1ApiGetStreamV1 + */ + readonly streamId?: string +} + +/** + * Request parameters for sendStreamVerificationV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request { + /** + * + * @type {VerificationrequestV1} + * @memberof SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1 + */ + readonly verificationrequestV1: VerificationrequestV1 +} + +/** + * Request parameters for setStreamConfigurationV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request { + /** + * + * @type {ReplacestreamconfigurationrequestV1} + * @memberof SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1 + */ + readonly replacestreamconfigurationrequestV1: ReplacestreamconfigurationrequestV1 +} + +/** + * Request parameters for updateStreamConfigurationV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request { + /** + * + * @type {UpdatestreamconfigurationrequestV1} + * @memberof SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1 + */ + readonly updatestreamconfigurationrequestV1: UpdatestreamconfigurationrequestV1 +} + +/** + * Request parameters for updateStreamStatusV1 operation in SharedSignalsFrameworkSSFV1Api. + * @export + * @interface SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request + */ +export interface SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request { + /** + * + * @type {UpdatestreamstatusrequestV1} + * @memberof SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1 + */ + readonly updatestreamstatusrequestV1: UpdatestreamstatusrequestV1 +} + +/** + * SharedSignalsFrameworkSSFV1Api - object-oriented interface + * @export + * @class SharedSignalsFrameworkSSFV1Api + * @extends {BaseAPI} + */ +export class SharedSignalsFrameworkSSFV1Api extends BaseAPI { + /** + * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. + * @summary Create stream + * @param {SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public createStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiCreateStreamV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).createStreamV1(requestParameters.createstreamrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. + * @summary Delete stream + * @param {SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public deleteStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiDeleteStreamV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).deleteStreamV1(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. + * @summary Get JWKS + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).getJWKSDataV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns the SSF transmitter discovery metadata (well-known configuration). + * @summary Get SSF configuration + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).getSSFConfigurationV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. + * @summary Get stream status + * @param {SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public getStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFV1ApiGetStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).getStreamStatusV1(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. + * @summary Get stream(s) + * @param {SharedSignalsFrameworkSSFV1ApiGetStreamV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public getStreamV1(requestParameters: SharedSignalsFrameworkSSFV1ApiGetStreamV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).getStreamV1(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Verifies an SSF stream by publishing a verification event requested by a security events provider. + * @summary Verify stream + * @param {SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public sendStreamVerificationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiSendStreamVerificationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).sendStreamVerificationV1(requestParameters.verificationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. + * @summary Replace stream configuration + * @param {SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public setStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiSetStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).setStreamConfigurationV1(requestParameters.replacestreamconfigurationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. + * @summary Update stream configuration + * @param {SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public updateStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFV1ApiUpdateStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).updateStreamConfigurationV1(requestParameters.updatestreamconfigurationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. + * @summary Update stream status + * @param {SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SharedSignalsFrameworkSSFV1Api + */ + public updateStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFV1ApiUpdateStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SharedSignalsFrameworkSSFV1ApiFp(this.configuration).updateStreamStatusV1(requestParameters.updatestreamstatusrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/shared_signals_framework_ssf/base.ts b/sdk-output/shared_signals_framework_ssf/base.ts new file mode 100644 index 00000000..1e638db0 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Shared Signals Framework (SSF) + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/shared_signals_framework_ssf/common.ts b/sdk-output/shared_signals_framework_ssf/common.ts new file mode 100644 index 00000000..b15b457c --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Shared Signals Framework (SSF) + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/shared_signals_framework_ssf/configuration.ts b/sdk-output/shared_signals_framework_ssf/configuration.ts new file mode 100644 index 00000000..6de9cc7e --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Shared Signals Framework (SSF) + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/shared_signals_framework_ssf/git_push.sh b/sdk-output/shared_signals_framework_ssf/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/shared_signals_framework_ssf/index.ts b/sdk-output/shared_signals_framework_ssf/index.ts new file mode 100644 index 00000000..37cfe3e8 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Shared Signals Framework (SSF) + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/shared_signals_framework_ssf/package.json b/sdk-output/shared_signals_framework_ssf/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/shared_signals_framework_ssf/tsconfig.json b/sdk-output/shared_signals_framework_ssf/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/sim_integrations/.gitignore b/sdk-output/sim_integrations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/sim_integrations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/sim_integrations/.npmignore b/sdk-output/sim_integrations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/sim_integrations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/sim_integrations/.openapi-generator-ignore b/sdk-output/sim_integrations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/sim_integrations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/sim_integrations/.openapi-generator/FILES b/sdk-output/sim_integrations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/sim_integrations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/sim_integrations/.openapi-generator/VERSION b/sdk-output/sim_integrations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/sim_integrations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/sim_integrations/.sdk-partition b/sdk-output/sim_integrations/.sdk-partition new file mode 100644 index 00000000..ad851e3a --- /dev/null +++ b/sdk-output/sim_integrations/.sdk-partition @@ -0,0 +1 @@ +sim-integrations \ No newline at end of file diff --git a/sdk-output/sim_integrations/README.md b/sdk-output/sim_integrations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sim_integrations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sim_integrations/api.ts b/sdk-output/sim_integrations/api.ts new file mode 100644 index 00000000..e8891d11 --- /dev/null +++ b/sdk-output/sim_integrations/api.ts @@ -0,0 +1,1395 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SIM Integrations + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface BasecommondtoV1 + */ +export interface BasecommondtoV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof BasecommondtoV1 + */ + 'modified'?: string; +} +/** + * Before Provisioning Rule. + * @export + * @interface BeforeprovisioningruledtoV1 + */ +export interface BeforeprovisioningruledtoV1 { + /** + * Before Provisioning Rule DTO type. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'type'?: BeforeprovisioningruledtoV1TypeV1; + /** + * Before Provisioning Rule ID. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'id'?: string; + /** + * Rule display name. + * @type {string} + * @memberof BeforeprovisioningruledtoV1 + */ + 'name'?: string; +} + +export const BeforeprovisioningruledtoV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type BeforeprovisioningruledtoV1TypeV1 = typeof BeforeprovisioningruledtoV1TypeV1[keyof typeof BeforeprovisioningruledtoV1TypeV1]; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetSIMIntegrationV1401ResponseV1 + */ +export interface GetSIMIntegrationV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSIMIntegrationV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetSIMIntegrationV1429ResponseV1 + */ +export interface GetSIMIntegrationV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetSIMIntegrationV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchV1 + */ +export interface JsonpatchV1 { + /** + * Operations to be applied + * @type {Array} + * @memberof JsonpatchV1 + */ + 'operations'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Owner\'s identity. + * @export + * @interface OwnerdtoV1 + */ +export interface OwnerdtoV1 { + /** + * Owner\'s DTO type. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'type'?: OwnerdtoV1TypeV1; + /** + * Owner\'s identity ID. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof OwnerdtoV1 + */ + 'name'?: string; +} + +export const OwnerdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type OwnerdtoV1TypeV1 = typeof OwnerdtoV1TypeV1[keyof typeof OwnerdtoV1TypeV1]; + +/** + * This is a reference to a plan initializer script. + * @export + * @interface ProvisioningconfigPlanInitializerScriptV1 + */ +export interface ProvisioningconfigPlanInitializerScriptV1 { + /** + * This is a Rule that allows provisioning instruction changes. + * @type {string} + * @memberof ProvisioningconfigPlanInitializerScriptV1 + */ + 'source'?: string; +} +/** + * Specification of a Service Desk integration provisioning configuration. + * @export + * @interface ProvisioningconfigV1 + */ +export interface ProvisioningconfigV1 { + /** + * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. + * @type {boolean} + * @memberof ProvisioningconfigV1 + */ + 'universalManager'?: boolean; + /** + * References to sources for the Service Desk integration template. May only be specified if universalManager is false. + * @type {Array} + * @memberof ProvisioningconfigV1 + */ + 'managedResourceRefs'?: Array; + /** + * + * @type {ProvisioningconfigPlanInitializerScriptV1} + * @memberof ProvisioningconfigV1 + */ + 'planInitializerScript'?: ProvisioningconfigPlanInitializerScriptV1 | null; + /** + * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. + * @type {boolean} + * @memberof ProvisioningconfigV1 + */ + 'noProvisioningRequests'?: boolean; + /** + * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. + * @type {number} + * @memberof ProvisioningconfigV1 + */ + 'provisioningRequestExpiration'?: number; +} +/** + * + * @export + * @interface ServicedeskintegrationdtoV1 + */ +export interface ServicedeskintegrationdtoV1 { + /** + * Unique identifier for the Service Desk integration + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'id'?: string; + /** + * Service Desk integration\'s name. The name must be unique. + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'name': string; + /** + * The date and time the Service Desk integration was created + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'created'?: string; + /** + * The date and time the Service Desk integration was last modified + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'modified'?: string; + /** + * Service Desk integration\'s description. + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'description': string; + /** + * Service Desk integration types: - ServiceNowSDIM - ServiceNow + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + */ + 'type': string; + /** + * + * @type {OwnerdtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'ownerRef'?: OwnerdtoV1; + /** + * + * @type {SourceclusterdtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'clusterRef'?: SourceclusterdtoV1; + /** + * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). + * @type {string} + * @memberof ServicedeskintegrationdtoV1 + * @deprecated + */ + 'cluster'?: string | null; + /** + * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). + * @type {Array} + * @memberof ServicedeskintegrationdtoV1 + * @deprecated + */ + 'managedSources'?: Array; + /** + * + * @type {ProvisioningconfigV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'provisioningConfig'?: ProvisioningconfigV1; + /** + * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. + * @type {{ [key: string]: any; }} + * @memberof ServicedeskintegrationdtoV1 + */ + 'attributes': { [key: string]: any; }; + /** + * + * @type {BeforeprovisioningruledtoV1} + * @memberof ServicedeskintegrationdtoV1 + */ + 'beforeProvisioningRule'?: BeforeprovisioningruledtoV1; +} +/** + * Source for Service Desk integration template. + * @export + * @interface ServicedesksourceV1 + */ +export interface ServicedesksourceV1 { + /** + * DTO type of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'type'?: ServicedesksourceV1TypeV1; + /** + * ID of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'id'?: string; + /** + * Human-readable name of source for service desk integration template. + * @type {string} + * @memberof ServicedesksourceV1 + */ + 'name'?: string; +} + +export const ServicedesksourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type ServicedesksourceV1TypeV1 = typeof ServicedesksourceV1TypeV1[keyof typeof ServicedesksourceV1TypeV1]; + +/** + * Before provisioning rule of integration + * @export + * @interface SimintegrationdetailsAllOfBeforeProvisioningRuleV1 + */ +export interface SimintegrationdetailsAllOfBeforeProvisioningRuleV1 { + /** + * + * @type {DtotypeV1} + * @memberof SimintegrationdetailsAllOfBeforeProvisioningRuleV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the rule + * @type {string} + * @memberof SimintegrationdetailsAllOfBeforeProvisioningRuleV1 + */ + 'id'?: string; + /** + * Human-readable display name of the rule + * @type {string} + * @memberof SimintegrationdetailsAllOfBeforeProvisioningRuleV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface SimintegrationdetailsV1 + */ +export interface SimintegrationdetailsV1 { + /** + * System-generated unique ID of the Object + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'id'?: string; + /** + * Name of the Object + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'name': string | null; + /** + * Creation date of the Object + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'created'?: string; + /** + * Last modification date of the Object + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'modified'?: string; + /** + * The description of the integration + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'description'?: string; + /** + * The integration type + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'type'?: string; + /** + * The attributes map containing the credentials used to configure the integration. + * @type {object} + * @memberof SimintegrationdetailsV1 + */ + 'attributes'?: object | null; + /** + * The list of sources (managed resources) + * @type {Array} + * @memberof SimintegrationdetailsV1 + */ + 'sources'?: Array; + /** + * The cluster/proxy + * @type {string} + * @memberof SimintegrationdetailsV1 + */ + 'cluster'?: string; + /** + * Custom mapping between the integration result and the provisioning result + * @type {object} + * @memberof SimintegrationdetailsV1 + */ + 'statusMap'?: object; + /** + * Request data to customize desc and body of the created ticket + * @type {object} + * @memberof SimintegrationdetailsV1 + */ + 'request'?: object; + /** + * + * @type {SimintegrationdetailsAllOfBeforeProvisioningRuleV1} + * @memberof SimintegrationdetailsV1 + */ + 'beforeProvisioningRule'?: SimintegrationdetailsAllOfBeforeProvisioningRuleV1; +} +/** + * Source cluster. + * @export + * @interface SourceclusterdtoV1 + */ +export interface SourceclusterdtoV1 { + /** + * Source cluster DTO type. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'type'?: SourceclusterdtoV1TypeV1; + /** + * Source cluster ID. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'id'?: string; + /** + * Source cluster display name. + * @type {string} + * @memberof SourceclusterdtoV1 + */ + 'name'?: string; +} + +export const SourceclusterdtoV1TypeV1 = { + Cluster: 'CLUSTER' +} as const; + +export type SourceclusterdtoV1TypeV1 = typeof SourceclusterdtoV1TypeV1[keyof typeof SourceclusterdtoV1TypeV1]; + + +/** + * SIMIntegrationsV1Api - axios parameter creator + * @export + */ +export const SIMIntegrationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new SIM Integrations. + * @summary Create new sim integration + * @param {SimintegrationdetailsV1} simintegrationdetailsV1 DTO containing the details of the SIM integration + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSIMIntegrationV1: async (simintegrationdetailsV1: SimintegrationdetailsV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'simintegrationdetailsV1' is not null or undefined + assertParamExists('createSIMIntegrationV1', 'simintegrationdetailsV1', simintegrationdetailsV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(simintegrationdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the details of a SIM integration. + * @summary Delete a sim integration + * @param {string} id The id of the integration to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSIMIntegrationV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSIMIntegrationV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the details of a SIM integration. + * @summary Get a sim integration details. + * @param {string} id The id of the integration. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSIMIntegrationV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSIMIntegrationV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * List the existing SIM integrations. + * @summary List the existing sim integrations. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSIMIntegrationsV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + * @summary Patch a sim beforeprovisioningrule attribute. + * @param {string} id SIM integration id + * @param {JsonpatchV1} jsonpatchV1 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchBeforeProvisioningRuleV1: async (id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchBeforeProvisioningRuleV1', 'id', id) + // verify required parameter 'jsonpatchV1' is not null or undefined + assertParamExists('patchBeforeProvisioningRuleV1', 'jsonpatchV1', jsonpatchV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/v1/{id}/beforeProvisioningRule` + .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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Patch a SIM attribute given a JsonPatch object. + * @summary Patch a sim attribute. + * @param {string} id SIM integration id + * @param {JsonpatchV1} jsonpatchV1 The JsonPatch object that describes the changes of SIM + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSIMAttributesV1: async (id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSIMAttributesV1', 'id', id) + // verify required parameter 'jsonpatchV1' is not null or undefined + assertParamExists('patchSIMAttributesV1', 'jsonpatchV1', jsonpatchV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(jsonpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Update an existing SIM integration. + * @summary Update an existing sim integration + * @param {string} id The id of the integration. + * @param {SimintegrationdetailsV1} simintegrationdetailsV1 The full DTO of the integration containing the updated model + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSIMIntegrationV1: async (id: string, simintegrationdetailsV1: SimintegrationdetailsV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putSIMIntegrationV1', 'id', id) + // verify required parameter 'simintegrationdetailsV1' is not null or undefined + assertParamExists('putSIMIntegrationV1', 'simintegrationdetailsV1', simintegrationdetailsV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sim-integrations/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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(simintegrationdetailsV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SIMIntegrationsV1Api - functional programming interface + * @export + */ +export const SIMIntegrationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SIMIntegrationsV1ApiAxiosParamCreator(configuration) + return { + /** + * Create a new SIM Integrations. + * @summary Create new sim integration + * @param {SimintegrationdetailsV1} simintegrationdetailsV1 DTO containing the details of the SIM integration + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSIMIntegrationV1(simintegrationdetailsV1: SimintegrationdetailsV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSIMIntegrationV1(simintegrationdetailsV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.createSIMIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the details of a SIM integration. + * @summary Delete a sim integration + * @param {string} id The id of the integration to delete. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSIMIntegrationV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSIMIntegrationV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.deleteSIMIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the details of a SIM integration. + * @summary Get a sim integration details. + * @param {string} id The id of the integration. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSIMIntegrationV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrationV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.getSIMIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List the existing SIM integrations. + * @summary List the existing sim integrations. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSIMIntegrationsV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrationsV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.getSIMIntegrationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + * @summary Patch a sim beforeprovisioningrule attribute. + * @param {string} id SIM integration id + * @param {JsonpatchV1} jsonpatchV1 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchBeforeProvisioningRuleV1(id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchBeforeProvisioningRuleV1(id, jsonpatchV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.patchBeforeProvisioningRuleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Patch a SIM attribute given a JsonPatch object. + * @summary Patch a sim attribute. + * @param {string} id SIM integration id + * @param {JsonpatchV1} jsonpatchV1 The JsonPatch object that describes the changes of SIM + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSIMAttributesV1(id: string, jsonpatchV1: JsonpatchV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSIMAttributesV1(id, jsonpatchV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.patchSIMAttributesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update an existing SIM integration. + * @summary Update an existing sim integration + * @param {string} id The id of the integration. + * @param {SimintegrationdetailsV1} simintegrationdetailsV1 The full DTO of the integration containing the updated model + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSIMIntegrationV1(id: string, simintegrationdetailsV1: SimintegrationdetailsV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSIMIntegrationV1(id, simintegrationdetailsV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV1Api.putSIMIntegrationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SIMIntegrationsV1Api - factory interface + * @export + */ +export const SIMIntegrationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SIMIntegrationsV1ApiFp(configuration) + return { + /** + * Create a new SIM Integrations. + * @summary Create new sim integration + * @param {SIMIntegrationsV1ApiCreateSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiCreateSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSIMIntegrationV1(requestParameters.simintegrationdetailsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the details of a SIM integration. + * @summary Delete a sim integration + * @param {SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSIMIntegrationV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the details of a SIM integration. + * @summary Get a sim integration details. + * @param {SIMIntegrationsV1ApiGetSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiGetSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSIMIntegrationV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List the existing SIM integrations. + * @summary List the existing sim integrations. + * @param {SIMIntegrationsV1ApiGetSIMIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSIMIntegrationsV1(requestParameters: SIMIntegrationsV1ApiGetSIMIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSIMIntegrationsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + * @summary Patch a sim beforeprovisioningrule attribute. + * @param {SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchBeforeProvisioningRuleV1(requestParameters: SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchBeforeProvisioningRuleV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Patch a SIM attribute given a JsonPatch object. + * @summary Patch a sim attribute. + * @param {SIMIntegrationsV1ApiPatchSIMAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSIMAttributesV1(requestParameters: SIMIntegrationsV1ApiPatchSIMAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSIMAttributesV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update an existing SIM integration. + * @summary Update an existing sim integration + * @param {SIMIntegrationsV1ApiPutSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiPutSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSIMIntegrationV1(requestParameters.id, requestParameters.simintegrationdetailsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSIMIntegrationV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiCreateSIMIntegrationV1Request + */ +export interface SIMIntegrationsV1ApiCreateSIMIntegrationV1Request { + /** + * DTO containing the details of the SIM integration + * @type {SimintegrationdetailsV1} + * @memberof SIMIntegrationsV1ApiCreateSIMIntegrationV1 + */ + readonly simintegrationdetailsV1: SimintegrationdetailsV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiCreateSIMIntegrationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteSIMIntegrationV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request + */ +export interface SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request { + /** + * The id of the integration to delete. + * @type {string} + * @memberof SIMIntegrationsV1ApiDeleteSIMIntegrationV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiDeleteSIMIntegrationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSIMIntegrationV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiGetSIMIntegrationV1Request + */ +export interface SIMIntegrationsV1ApiGetSIMIntegrationV1Request { + /** + * The id of the integration. + * @type {string} + * @memberof SIMIntegrationsV1ApiGetSIMIntegrationV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiGetSIMIntegrationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSIMIntegrationsV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiGetSIMIntegrationsV1Request + */ +export interface SIMIntegrationsV1ApiGetSIMIntegrationsV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiGetSIMIntegrationsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchBeforeProvisioningRuleV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request + */ +export interface SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request { + /** + * SIM integration id + * @type {string} + * @memberof SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1 + */ + readonly id: string + + /** + * The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + * @type {JsonpatchV1} + * @memberof SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1 + */ + readonly jsonpatchV1: JsonpatchV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for patchSIMAttributesV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiPatchSIMAttributesV1Request + */ +export interface SIMIntegrationsV1ApiPatchSIMAttributesV1Request { + /** + * SIM integration id + * @type {string} + * @memberof SIMIntegrationsV1ApiPatchSIMAttributesV1 + */ + readonly id: string + + /** + * The JsonPatch object that describes the changes of SIM + * @type {JsonpatchV1} + * @memberof SIMIntegrationsV1ApiPatchSIMAttributesV1 + */ + readonly jsonpatchV1: JsonpatchV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiPatchSIMAttributesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for putSIMIntegrationV1 operation in SIMIntegrationsV1Api. + * @export + * @interface SIMIntegrationsV1ApiPutSIMIntegrationV1Request + */ +export interface SIMIntegrationsV1ApiPutSIMIntegrationV1Request { + /** + * The id of the integration. + * @type {string} + * @memberof SIMIntegrationsV1ApiPutSIMIntegrationV1 + */ + readonly id: string + + /** + * The full DTO of the integration containing the updated model + * @type {SimintegrationdetailsV1} + * @memberof SIMIntegrationsV1ApiPutSIMIntegrationV1 + */ + readonly simintegrationdetailsV1: SimintegrationdetailsV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SIMIntegrationsV1ApiPutSIMIntegrationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * SIMIntegrationsV1Api - object-oriented interface + * @export + * @class SIMIntegrationsV1Api + * @extends {BaseAPI} + */ +export class SIMIntegrationsV1Api extends BaseAPI { + /** + * Create a new SIM Integrations. + * @summary Create new sim integration + * @param {SIMIntegrationsV1ApiCreateSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public createSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiCreateSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).createSIMIntegrationV1(requestParameters.simintegrationdetailsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the details of a SIM integration. + * @summary Delete a sim integration + * @param {SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public deleteSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiDeleteSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).deleteSIMIntegrationV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the details of a SIM integration. + * @summary Get a sim integration details. + * @param {SIMIntegrationsV1ApiGetSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public getSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiGetSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).getSIMIntegrationV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List the existing SIM integrations. + * @summary List the existing sim integrations. + * @param {SIMIntegrationsV1ApiGetSIMIntegrationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public getSIMIntegrationsV1(requestParameters: SIMIntegrationsV1ApiGetSIMIntegrationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).getSIMIntegrationsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + * @summary Patch a sim beforeprovisioningrule attribute. + * @param {SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public patchBeforeProvisioningRuleV1(requestParameters: SIMIntegrationsV1ApiPatchBeforeProvisioningRuleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).patchBeforeProvisioningRuleV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Patch a SIM attribute given a JsonPatch object. + * @summary Patch a sim attribute. + * @param {SIMIntegrationsV1ApiPatchSIMAttributesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public patchSIMAttributesV1(requestParameters: SIMIntegrationsV1ApiPatchSIMAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).patchSIMAttributesV1(requestParameters.id, requestParameters.jsonpatchV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update an existing SIM integration. + * @summary Update an existing sim integration + * @param {SIMIntegrationsV1ApiPutSIMIntegrationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SIMIntegrationsV1Api + */ + public putSIMIntegrationV1(requestParameters: SIMIntegrationsV1ApiPutSIMIntegrationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SIMIntegrationsV1ApiFp(this.configuration).putSIMIntegrationV1(requestParameters.id, requestParameters.simintegrationdetailsV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/sim_integrations/base.ts b/sdk-output/sim_integrations/base.ts new file mode 100644 index 00000000..e4f8e224 --- /dev/null +++ b/sdk-output/sim_integrations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SIM Integrations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/sim_integrations/common.ts b/sdk-output/sim_integrations/common.ts new file mode 100644 index 00000000..73801b73 --- /dev/null +++ b/sdk-output/sim_integrations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SIM Integrations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/sim_integrations/configuration.ts b/sdk-output/sim_integrations/configuration.ts new file mode 100644 index 00000000..823a1961 --- /dev/null +++ b/sdk-output/sim_integrations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SIM Integrations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/sim_integrations/git_push.sh b/sdk-output/sim_integrations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/sim_integrations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/sim_integrations/index.ts b/sdk-output/sim_integrations/index.ts new file mode 100644 index 00000000..7884be1f --- /dev/null +++ b/sdk-output/sim_integrations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SIM Integrations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/sim_integrations/package.json b/sdk-output/sim_integrations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/sim_integrations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/sim_integrations/tsconfig.json b/sdk-output/sim_integrations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/sim_integrations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/sod_policies/.gitignore b/sdk-output/sod_policies/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/sod_policies/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/sod_policies/.npmignore b/sdk-output/sod_policies/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/sod_policies/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/sod_policies/.openapi-generator-ignore b/sdk-output/sod_policies/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/sod_policies/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/sod_policies/.openapi-generator/FILES b/sdk-output/sod_policies/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/sod_policies/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/sod_policies/.openapi-generator/VERSION b/sdk-output/sod_policies/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/sod_policies/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/sod_policies/.sdk-partition b/sdk-output/sod_policies/.sdk-partition new file mode 100644 index 00000000..032cebd0 --- /dev/null +++ b/sdk-output/sod_policies/.sdk-partition @@ -0,0 +1 @@ +sod-policies \ No newline at end of file diff --git a/sdk-output/sod_policies/README.md b/sdk-output/sod_policies/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sod_policies/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sod_policies/api.ts b/sdk-output/sod_policies/api.ts new file mode 100644 index 00000000..d06b7487 --- /dev/null +++ b/sdk-output/sod_policies/api.ts @@ -0,0 +1,2408 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Policies + * 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 AccesscriteriaCriteriaListInnerV1 + */ +export interface AccesscriteriaCriteriaListInnerV1 { + /** + * Type of the propery to which this reference applies to + * @type {string} + * @memberof AccesscriteriaCriteriaListInnerV1 + */ + 'type'?: AccesscriteriaCriteriaListInnerV1TypeV1; + /** + * ID of the object to which this reference applies to + * @type {string} + * @memberof AccesscriteriaCriteriaListInnerV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies to + * @type {string} + * @memberof AccesscriteriaCriteriaListInnerV1 + */ + 'name'?: string; +} + +export const AccesscriteriaCriteriaListInnerV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccesscriteriaCriteriaListInnerV1TypeV1 = typeof AccesscriteriaCriteriaListInnerV1TypeV1[keyof typeof AccesscriteriaCriteriaListInnerV1TypeV1]; + +/** + * + * @export + * @interface AccesscriteriaV1 + */ +export interface AccesscriteriaV1 { + /** + * Business name for the access construct list + * @type {string} + * @memberof AccesscriteriaV1 + */ + 'name'?: string; + /** + * List of criteria. There is a min of 1 and max of 50 items in the list. + * @type {Array} + * @memberof AccesscriteriaV1 + */ + 'criteriaList'?: Array; +} +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ConflictingaccesscriteriaV1 + */ +export interface ConflictingaccesscriteriaV1 { + /** + * + * @type {AccesscriteriaV1} + * @memberof ConflictingaccesscriteriaV1 + */ + 'leftCriteria'?: AccesscriteriaV1; + /** + * + * @type {AccesscriteriaV1} + * @memberof ConflictingaccesscriteriaV1 + */ + 'rightCriteria'?: AccesscriteriaV1; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListSodPoliciesV1401ResponseV1 + */ +export interface ListSodPoliciesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSodPoliciesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListSodPoliciesV1429ResponseV1 + */ +export interface ListSodPoliciesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSodPoliciesV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface MultipolicyrequestV1 + */ +export interface MultipolicyrequestV1 { + /** + * Multi-policy report will be run for this list of ids + * @type {Array} + * @memberof MultipolicyrequestV1 + */ + 'filteredPolicyList'?: Array; +} +/** + * + * @export + * @interface ReportresultreferenceV1 + */ +export interface ReportresultreferenceV1 { + /** + * SOD policy violation report result DTO type. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'type'?: ReportresultreferenceV1TypeV1; + /** + * SOD policy violation report result ID. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'id'?: string; + /** + * Human-readable name of the SOD policy violation report result. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'name'?: string; + /** + * Status of a SOD policy violation report. + * @type {string} + * @memberof ReportresultreferenceV1 + */ + 'status'?: ReportresultreferenceV1StatusV1; +} + +export const ReportresultreferenceV1TypeV1 = { + ReportResult: 'REPORT_RESULT' +} as const; + +export type ReportresultreferenceV1TypeV1 = typeof ReportresultreferenceV1TypeV1[keyof typeof ReportresultreferenceV1TypeV1]; +export const ReportresultreferenceV1StatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR', + Pending: 'PENDING' +} as const; + +export type ReportresultreferenceV1StatusV1 = typeof ReportresultreferenceV1StatusV1[keyof typeof ReportresultreferenceV1StatusV1]; + +/** + * + * @export + * @interface ScheduleDaysV1 + */ +export interface ScheduleDaysV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleDaysV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleDaysV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleDaysV1 + */ + 'interval'?: number | null; +} + + +/** + * + * @export + * @interface ScheduleHoursV1 + */ +export interface ScheduleHoursV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleHoursV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleHoursV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleHoursV1 + */ + 'interval'?: number | null; +} + + +/** + * + * @export + * @interface ScheduleMonthsV1 + */ +export interface ScheduleMonthsV1 { + /** + * + * @type {SelectortypeV1} + * @memberof ScheduleMonthsV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof ScheduleMonthsV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof ScheduleMonthsV1 + */ + 'interval'?: number | null; +} + + +/** + * The schedule information. + * @export + * @interface ScheduleV1 + */ +export interface ScheduleV1 { + /** + * + * @type {ScheduletypeV1} + * @memberof ScheduleV1 + */ + 'type': ScheduletypeV1; + /** + * + * @type {ScheduleMonthsV1} + * @memberof ScheduleV1 + */ + 'months'?: ScheduleMonthsV1; + /** + * + * @type {ScheduleDaysV1} + * @memberof ScheduleV1 + */ + 'days'?: ScheduleDaysV1; + /** + * + * @type {ScheduleHoursV1} + * @memberof ScheduleV1 + */ + 'hours': ScheduleHoursV1; + /** + * A date-time in ISO-8601 format + * @type {string} + * @memberof ScheduleV1 + */ + 'expiration'?: string | null; + /** + * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. + * @type {string} + * @memberof ScheduleV1 + */ + 'timeZoneId'?: string | null; +} + + +/** + * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const ScheduletypeV1 = { + Daily: 'DAILY', + Weekly: 'WEEKLY', + Monthly: 'MONTHLY', + Calendar: 'CALENDAR', + Annually: 'ANNUALLY' +} as const; + +export type ScheduletypeV1 = typeof ScheduletypeV1[keyof typeof ScheduletypeV1]; + + +/** + * + * @export + * @interface SelectorV1 + */ +export interface SelectorV1 { + /** + * + * @type {SelectortypeV1} + * @memberof SelectorV1 + */ + 'type': SelectortypeV1; + /** + * The selected values. + * @type {Array} + * @memberof SelectorV1 + */ + 'values': Array; + /** + * The selected interval for RANGE selectors. + * @type {number} + * @memberof SelectorV1 + */ + 'interval'?: number | null; +} + + +/** + * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const SelectortypeV1 = { + List: 'LIST', + Range: 'RANGE' +} as const; + +export type SelectortypeV1 = typeof SelectortypeV1[keyof typeof SelectortypeV1]; + + +/** + * + * @export + * @interface SodpolicyConflictingAccessCriteriaV1 + */ +export interface SodpolicyConflictingAccessCriteriaV1 { + /** + * + * @type {AccesscriteriaV1} + * @memberof SodpolicyConflictingAccessCriteriaV1 + */ + 'leftCriteria'?: AccesscriteriaV1; + /** + * + * @type {AccesscriteriaV1} + * @memberof SodpolicyConflictingAccessCriteriaV1 + */ + 'rightCriteria'?: AccesscriteriaV1; +} +/** + * The owner of the SOD policy. + * @export + * @interface SodpolicyOwnerRefV1 + */ +export interface SodpolicyOwnerRefV1 { + /** + * Owner type. + * @type {string} + * @memberof SodpolicyOwnerRefV1 + */ + 'type'?: SodpolicyOwnerRefV1TypeV1; + /** + * Owner\'s ID. + * @type {string} + * @memberof SodpolicyOwnerRefV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof SodpolicyOwnerRefV1 + */ + 'name'?: string; +} + +export const SodpolicyOwnerRefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type SodpolicyOwnerRefV1TypeV1 = typeof SodpolicyOwnerRefV1TypeV1[keyof typeof SodpolicyOwnerRefV1TypeV1]; + +/** + * + * @export + * @interface SodpolicyV1 + */ +export interface SodpolicyV1 { + /** + * Policy id + * @type {string} + * @memberof SodpolicyV1 + */ + 'id'?: string; + /** + * Policy Business Name + * @type {string} + * @memberof SodpolicyV1 + */ + 'name'?: string; + /** + * The time when this SOD policy is created. + * @type {string} + * @memberof SodpolicyV1 + */ + 'created'?: string; + /** + * The time when this SOD policy is modified. + * @type {string} + * @memberof SodpolicyV1 + */ + 'modified'?: string; + /** + * Optional description of the SOD policy + * @type {string} + * @memberof SodpolicyV1 + */ + 'description'?: string | null; + /** + * + * @type {SodpolicyOwnerRefV1} + * @memberof SodpolicyV1 + */ + 'ownerRef'?: SodpolicyOwnerRefV1; + /** + * Optional External Policy Reference + * @type {string} + * @memberof SodpolicyV1 + */ + 'externalPolicyReference'?: string | null; + /** + * Search query of the SOD policy + * @type {string} + * @memberof SodpolicyV1 + */ + 'policyQuery'?: string; + /** + * Optional compensating controls(Mitigating Controls) + * @type {string} + * @memberof SodpolicyV1 + */ + 'compensatingControls'?: string | null; + /** + * Optional correction advice + * @type {string} + * @memberof SodpolicyV1 + */ + 'correctionAdvice'?: string | null; + /** + * whether the policy is enforced or not + * @type {string} + * @memberof SodpolicyV1 + */ + 'state'?: SodpolicyV1StateV1; + /** + * tags for this policy object + * @type {Array} + * @memberof SodpolicyV1 + */ + 'tags'?: Array; + /** + * Policy\'s creator ID + * @type {string} + * @memberof SodpolicyV1 + */ + 'creatorId'?: string; + /** + * Policy\'s modifier ID + * @type {string} + * @memberof SodpolicyV1 + */ + 'modifierId'?: string | null; + /** + * + * @type {ViolationownerassignmentconfigV1} + * @memberof SodpolicyV1 + */ + 'violationOwnerAssignmentConfig'?: ViolationownerassignmentconfigV1; + /** + * defines whether a policy has been scheduled or not + * @type {boolean} + * @memberof SodpolicyV1 + */ + 'scheduled'?: boolean; + /** + * whether a policy is query based or conflicting access based + * @type {string} + * @memberof SodpolicyV1 + */ + 'type'?: SodpolicyV1TypeV1; + /** + * + * @type {SodpolicyConflictingAccessCriteriaV1} + * @memberof SodpolicyV1 + */ + 'conflictingAccessCriteria'?: SodpolicyConflictingAccessCriteriaV1; +} + +export const SodpolicyV1StateV1 = { + Enforced: 'ENFORCED', + NotEnforced: 'NOT_ENFORCED' +} as const; + +export type SodpolicyV1StateV1 = typeof SodpolicyV1StateV1[keyof typeof SodpolicyV1StateV1]; +export const SodpolicyV1TypeV1 = { + General: 'GENERAL', + ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' +} as const; + +export type SodpolicyV1TypeV1 = typeof SodpolicyV1TypeV1[keyof typeof SodpolicyV1TypeV1]; + +/** + * + * @export + * @interface SodpolicyscheduleV1 + */ +export interface SodpolicyscheduleV1 { + /** + * SOD Policy schedule name + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'name'?: string; + /** + * The time when this SOD policy schedule is created. + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'created'?: string; + /** + * The time when this SOD policy schedule is modified. + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'modified'?: string; + /** + * SOD Policy schedule description + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'description'?: string; + /** + * + * @type {ScheduleV1} + * @memberof SodpolicyscheduleV1 + */ + 'schedule'?: ScheduleV1; + /** + * + * @type {Array} + * @memberof SodpolicyscheduleV1 + */ + 'recipients'?: Array; + /** + * Indicates if empty results need to be emailed + * @type {boolean} + * @memberof SodpolicyscheduleV1 + */ + 'emailEmptyResults'?: boolean; + /** + * Policy\'s creator ID + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'creatorId'?: string; + /** + * Policy\'s modifier ID + * @type {string} + * @memberof SodpolicyscheduleV1 + */ + 'modifierId'?: string; +} +/** + * SOD policy recipient. + * @export + * @interface SodrecipientV1 + */ +export interface SodrecipientV1 { + /** + * SOD policy recipient DTO type. + * @type {string} + * @memberof SodrecipientV1 + */ + 'type'?: SodrecipientV1TypeV1; + /** + * SOD policy recipient\'s identity ID. + * @type {string} + * @memberof SodrecipientV1 + */ + 'id'?: string; + /** + * SOD policy recipient\'s display name. + * @type {string} + * @memberof SodrecipientV1 + */ + 'name'?: string; +} + +export const SodrecipientV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SodrecipientV1TypeV1 = typeof SodrecipientV1TypeV1[keyof typeof SodrecipientV1TypeV1]; + +/** + * SOD policy violation report result. + * @export + * @interface SodreportresultdtoV1 + */ +export interface SodreportresultdtoV1 { + /** + * SOD policy violation report result DTO type. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'type'?: SodreportresultdtoV1TypeV1; + /** + * SOD policy violation report result ID. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'id'?: string; + /** + * Human-readable name of the SOD policy violation report result. + * @type {string} + * @memberof SodreportresultdtoV1 + */ + 'name'?: string; +} + +export const SodreportresultdtoV1TypeV1 = { + ReportResult: 'REPORT_RESULT' +} as const; + +export type SodreportresultdtoV1TypeV1 = typeof SodreportresultdtoV1TypeV1[keyof typeof SodreportresultdtoV1TypeV1]; + +/** + * The owner of the violation assignment config. + * @export + * @interface ViolationownerassignmentconfigOwnerRefV1 + */ +export interface ViolationownerassignmentconfigOwnerRefV1 { + /** + * Owner type. + * @type {string} + * @memberof ViolationownerassignmentconfigOwnerRefV1 + */ + 'type'?: ViolationownerassignmentconfigOwnerRefV1TypeV1 | null; + /** + * Owner\'s ID. + * @type {string} + * @memberof ViolationownerassignmentconfigOwnerRefV1 + */ + 'id'?: string; + /** + * Owner\'s name. + * @type {string} + * @memberof ViolationownerassignmentconfigOwnerRefV1 + */ + 'name'?: string; +} + +export const ViolationownerassignmentconfigOwnerRefV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP', + Manager: 'MANAGER' +} as const; + +export type ViolationownerassignmentconfigOwnerRefV1TypeV1 = typeof ViolationownerassignmentconfigOwnerRefV1TypeV1[keyof typeof ViolationownerassignmentconfigOwnerRefV1TypeV1]; + +/** + * + * @export + * @interface ViolationownerassignmentconfigV1 + */ +export interface ViolationownerassignmentconfigV1 { + /** + * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity + * @type {string} + * @memberof ViolationownerassignmentconfigV1 + */ + 'assignmentRule'?: ViolationownerassignmentconfigV1AssignmentRuleV1 | null; + /** + * + * @type {ViolationownerassignmentconfigOwnerRefV1} + * @memberof ViolationownerassignmentconfigV1 + */ + 'ownerRef'?: ViolationownerassignmentconfigOwnerRefV1 | null; +} + +export const ViolationownerassignmentconfigV1AssignmentRuleV1 = { + Manager: 'MANAGER', + Static: 'STATIC' +} as const; + +export type ViolationownerassignmentconfigV1AssignmentRuleV1 = typeof ViolationownerassignmentconfigV1AssignmentRuleV1[keyof typeof ViolationownerassignmentconfigV1AssignmentRuleV1]; + + +/** + * SODPoliciesV1Api - axios parameter creator + * @export + */ +export const SODPoliciesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. + * @summary Create sod policy + * @param {SodpolicyV1} sodpolicyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSodPolicyV1: async (sodpolicyV1: SodpolicyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sodpolicyV1' is not null or undefined + assertParamExists('createSodPolicyV1', 'sodpolicyV1', sodpolicyV1) + const localVarPath = `/sod-policies/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(sodpolicyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes schedule for a specified SOD policy by ID. + * @summary Delete sod policy schedule + * @param {string} id The ID of the SOD policy the schedule must be deleted for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSodPolicyScheduleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSodPolicyScheduleV1', 'id', id) + const localVarPath = `/sod-policies/v1/{id}/schedule` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This deletes a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Delete sod policy by id + * @param {string} id The ID of the SOD Policy to delete. + * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSodPolicyV1: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSodPolicyV1', 'id', id) + const localVarPath = `/sod-policies/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; + + if (logical !== undefined) { + localVarQueryParameter['logical'] = logical; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This allows to download a specified named violation report for a given report reference. + * @summary Download custom violation report + * @param {string} reportResultId The ID of the report reference to download. + * @param {string} fileName Custom Name for the file. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCustomViolationReportV1: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'reportResultId' is not null or undefined + assertParamExists('getCustomViolationReportV1', 'reportResultId', reportResultId) + // verify required parameter 'fileName' is not null or undefined + assertParamExists('getCustomViolationReportV1', 'fileName', fileName) + const localVarPath = `/sod-violation-report/v1/{reportResultId}/download/{fileName}` + .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) + .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This allows to download a violation report for a given report reference. + * @summary Download violation report + * @param {string} reportResultId The ID of the report reference to download. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDefaultViolationReportV1: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'reportResultId' is not null or undefined + assertParamExists('getDefaultViolationReportV1', 'reportResultId', reportResultId) + const localVarPath = `/sod-violation-report/v1/{reportResultId}/download` + .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint gets the status for a violation report for all policy run. + * @summary Get multi-report run task status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodAllReportRunStatusV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/sod-violation-report/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint gets a specified SOD policy\'s schedule. + * @summary Get sod policy schedule + * @param {string} id The ID of the SOD policy schedule to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodPolicyScheduleV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSodPolicyScheduleV1', 'id', id) + const localVarPath = `/sod-policies/v1/{id}/schedule` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets specified SOD policy. Requires role of ORG_ADMIN. + * @summary Get sod policy by id + * @param {string} id The ID of the SOD Policy to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodPolicyV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSodPolicyV1', 'id', id) + const localVarPath = `/sod-policies/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, + }; + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get violation report run status + * @param {string} reportResultId The ID of the report reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodViolationReportRunStatusV1: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'reportResultId' is not null or undefined + assertParamExists('getSodViolationReportRunStatusV1', 'reportResultId', reportResultId) + const localVarPath = `/sod-policies/v1/sod-violation-report-status/{reportResultId}` + .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get sod violation report status + * @param {string} id The ID of the violation report to retrieve status for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodViolationReportStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSodViolationReportStatusV1', 'id', id) + const localVarPath = `/sod-policies/v1/{id}/violation-report` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets list of all SOD policies. Requires role of ORG_ADMIN + * @summary List sod policies + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in* **state**: *eq, in* + * @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, name, created, modified, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSodPoliciesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/sod-policies/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + * @summary Patch sod policy by id + * @param {string} id The ID of the SOD policy being modified. + * @param {Array} jsonpatchoperationV1 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSodPolicyV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSodPolicyV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchSodPolicyV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sod-policies/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This updates schedule for a specified SOD policy. + * @summary Update sod policy schedule + * @param {string} id The ID of the SOD policy to update its schedule. + * @param {SodpolicyscheduleV1} sodpolicyscheduleV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPolicyScheduleV1: async (id: string, sodpolicyscheduleV1: SodpolicyscheduleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putPolicyScheduleV1', 'id', id) + // verify required parameter 'sodpolicyscheduleV1' is not null or undefined + assertParamExists('putPolicyScheduleV1', 'sodpolicyscheduleV1', sodpolicyscheduleV1) + const localVarPath = `/sod-policies/v1/{id}/schedule` + .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: 'PUT', ...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(sodpolicyscheduleV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This updates a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Update sod policy by id + * @param {string} id The ID of the SOD policy to update. + * @param {SodpolicyV1} sodpolicyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSodPolicyV1: async (id: string, sodpolicyV1: SodpolicyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putSodPolicyV1', 'id', id) + // verify required parameter 'sodpolicyV1' is not null or undefined + assertParamExists('putSodPolicyV1', 'sodpolicyV1', sodpolicyV1) + const localVarPath = `/sod-policies/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: 'PUT', ...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(sodpolicyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + * @summary Evaluate one policy by id + * @param {string} id The SOD policy ID to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startEvaluateSodPolicyV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startEvaluateSodPolicyV1', 'id', id) + const localVarPath = `/sod-policies/v1/{id}/evaluate` + .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: 'POST', ...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, + }; + }, + /** + * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + * @summary Runs all policies for org + * @param {MultipolicyrequestV1} [multipolicyrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startSodAllPoliciesForOrgV1: async (multipolicyrequestV1?: MultipolicyrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/sod-violation-report/v1/run`; + // 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(multipolicyrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + * @summary Runs sod policy violation report + * @param {string} id The SOD policy ID to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startSodPolicyV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('startSodPolicyV1', 'id', id) + const localVarPath = `/sod-policies/v1/{id}/violation-report/run` + .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: 'POST', ...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, + }; + }, + } +}; + +/** + * SODPoliciesV1Api - functional programming interface + * @export + */ +export const SODPoliciesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SODPoliciesV1ApiAxiosParamCreator(configuration) + return { + /** + * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. + * @summary Create sod policy + * @param {SodpolicyV1} sodpolicyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSodPolicyV1(sodpolicyV1: SodpolicyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicyV1(sodpolicyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.createSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes schedule for a specified SOD policy by ID. + * @summary Delete sod policy schedule + * @param {string} id The ID of the SOD policy the schedule must be deleted for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSodPolicyScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicyScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.deleteSodPolicyScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This deletes a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Delete sod policy by id + * @param {string} id The ID of the SOD Policy to delete. + * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSodPolicyV1(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicyV1(id, logical, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.deleteSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This allows to download a specified named violation report for a given report reference. + * @summary Download custom violation report + * @param {string} reportResultId The ID of the report reference to download. + * @param {string} fileName Custom Name for the file. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCustomViolationReportV1(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReportV1(reportResultId, fileName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getCustomViolationReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This allows to download a violation report for a given report reference. + * @summary Download violation report + * @param {string} reportResultId The ID of the report reference to download. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getDefaultViolationReportV1(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReportV1(reportResultId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getDefaultViolationReportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint gets the status for a violation report for all policy run. + * @summary Get multi-report run task status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatusV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getSodAllReportRunStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint gets a specified SOD policy\'s schedule. + * @summary Get sod policy schedule + * @param {string} id The ID of the SOD policy schedule to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSodPolicyScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicyScheduleV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getSodPolicyScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets specified SOD policy. Requires role of ORG_ADMIN. + * @summary Get sod policy by id + * @param {string} id The ID of the SOD Policy to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicyV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get violation report run status + * @param {string} reportResultId The ID of the report reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSodViolationReportRunStatusV1(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatusV1(reportResultId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getSodViolationReportRunStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get sod violation report status + * @param {string} id The ID of the violation report to retrieve status for. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSodViolationReportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.getSodViolationReportStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets list of all SOD policies. Requires role of ORG_ADMIN + * @summary List sod policies + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in* **state**: *eq, in* + * @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, name, created, modified, description** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSodPoliciesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPoliciesV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.listSodPoliciesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + * @summary Patch sod policy by id + * @param {string} id The ID of the SOD policy being modified. + * @param {Array} jsonpatchoperationV1 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSodPolicyV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicyV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.patchSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates schedule for a specified SOD policy. + * @summary Update sod policy schedule + * @param {string} id The ID of the SOD policy to update its schedule. + * @param {SodpolicyscheduleV1} sodpolicyscheduleV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putPolicyScheduleV1(id: string, sodpolicyscheduleV1: SodpolicyscheduleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicyScheduleV1(id, sodpolicyscheduleV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.putPolicyScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Update sod policy by id + * @param {string} id The ID of the SOD policy to update. + * @param {SodpolicyV1} sodpolicyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSodPolicyV1(id: string, sodpolicyV1: SodpolicyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicyV1(id, sodpolicyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.putSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + * @summary Evaluate one policy by id + * @param {string} id The SOD policy ID to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startEvaluateSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startEvaluateSodPolicyV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.startEvaluateSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + * @summary Runs all policies for org + * @param {MultipolicyrequestV1} [multipolicyrequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startSodAllPoliciesForOrgV1(multipolicyrequestV1?: MultipolicyrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrgV1(multipolicyrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.startSodAllPoliciesForOrgV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + * @summary Runs sod policy violation report + * @param {string} id The SOD policy ID to run. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicyV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODPoliciesV1Api.startSodPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SODPoliciesV1Api - factory interface + * @export + */ +export const SODPoliciesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SODPoliciesV1ApiFp(configuration) + return { + /** + * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. + * @summary Create sod policy + * @param {SODPoliciesV1ApiCreateSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSodPolicyV1(requestParameters: SODPoliciesV1ApiCreateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSodPolicyV1(requestParameters.sodpolicyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes schedule for a specified SOD policy by ID. + * @summary Delete sod policy schedule + * @param {SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSodPolicyScheduleV1(requestParameters: SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSodPolicyScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This deletes a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Delete sod policy by id + * @param {SODPoliciesV1ApiDeleteSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSodPolicyV1(requestParameters: SODPoliciesV1ApiDeleteSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSodPolicyV1(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This allows to download a specified named violation report for a given report reference. + * @summary Download custom violation report + * @param {SODPoliciesV1ApiGetCustomViolationReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCustomViolationReportV1(requestParameters: SODPoliciesV1ApiGetCustomViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCustomViolationReportV1(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This allows to download a violation report for a given report reference. + * @summary Download violation report + * @param {SODPoliciesV1ApiGetDefaultViolationReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getDefaultViolationReportV1(requestParameters: SODPoliciesV1ApiGetDefaultViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDefaultViolationReportV1(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint gets the status for a violation report for all policy run. + * @summary Get multi-report run task status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSodAllReportRunStatusV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint gets a specified SOD policy\'s schedule. + * @summary Get sod policy schedule + * @param {SODPoliciesV1ApiGetSodPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodPolicyScheduleV1(requestParameters: SODPoliciesV1ApiGetSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSodPolicyScheduleV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets specified SOD policy. Requires role of ORG_ADMIN. + * @summary Get sod policy by id + * @param {SODPoliciesV1ApiGetSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodPolicyV1(requestParameters: SODPoliciesV1ApiGetSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get violation report run status + * @param {SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodViolationReportRunStatusV1(requestParameters: SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSodViolationReportRunStatusV1(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get sod violation report status + * @param {SODPoliciesV1ApiGetSodViolationReportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSodViolationReportStatusV1(requestParameters: SODPoliciesV1ApiGetSodViolationReportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSodViolationReportStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets list of all SOD policies. Requires role of ORG_ADMIN + * @summary List sod policies + * @param {SODPoliciesV1ApiListSodPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSodPoliciesV1(requestParameters: SODPoliciesV1ApiListSodPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSodPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + * @summary Patch sod policy by id + * @param {SODPoliciesV1ApiPatchSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSodPolicyV1(requestParameters: SODPoliciesV1ApiPatchSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSodPolicyV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates schedule for a specified SOD policy. + * @summary Update sod policy schedule + * @param {SODPoliciesV1ApiPutPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putPolicyScheduleV1(requestParameters: SODPoliciesV1ApiPutPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putPolicyScheduleV1(requestParameters.id, requestParameters.sodpolicyscheduleV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Update sod policy by id + * @param {SODPoliciesV1ApiPutSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSodPolicyV1(requestParameters: SODPoliciesV1ApiPutSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSodPolicyV1(requestParameters.id, requestParameters.sodpolicyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + * @summary Evaluate one policy by id + * @param {SODPoliciesV1ApiStartEvaluateSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startEvaluateSodPolicyV1(requestParameters: SODPoliciesV1ApiStartEvaluateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startEvaluateSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + * @summary Runs all policies for org + * @param {SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startSodAllPoliciesForOrgV1(requestParameters: SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startSodAllPoliciesForOrgV1(requestParameters.multipolicyrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + * @summary Runs sod policy violation report + * @param {SODPoliciesV1ApiStartSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startSodPolicyV1(requestParameters: SODPoliciesV1ApiStartSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiCreateSodPolicyV1Request + */ +export interface SODPoliciesV1ApiCreateSodPolicyV1Request { + /** + * + * @type {SodpolicyV1} + * @memberof SODPoliciesV1ApiCreateSodPolicyV1 + */ + readonly sodpolicyV1: SodpolicyV1 +} + +/** + * Request parameters for deleteSodPolicyScheduleV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request + */ +export interface SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request { + /** + * The ID of the SOD policy the schedule must be deleted for. + * @type {string} + * @memberof SODPoliciesV1ApiDeleteSodPolicyScheduleV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiDeleteSodPolicyV1Request + */ +export interface SODPoliciesV1ApiDeleteSodPolicyV1Request { + /** + * The ID of the SOD Policy to delete. + * @type {string} + * @memberof SODPoliciesV1ApiDeleteSodPolicyV1 + */ + readonly id: string + + /** + * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + * @type {boolean} + * @memberof SODPoliciesV1ApiDeleteSodPolicyV1 + */ + readonly logical?: boolean +} + +/** + * Request parameters for getCustomViolationReportV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetCustomViolationReportV1Request + */ +export interface SODPoliciesV1ApiGetCustomViolationReportV1Request { + /** + * The ID of the report reference to download. + * @type {string} + * @memberof SODPoliciesV1ApiGetCustomViolationReportV1 + */ + readonly reportResultId: string + + /** + * Custom Name for the file. + * @type {string} + * @memberof SODPoliciesV1ApiGetCustomViolationReportV1 + */ + readonly fileName: string +} + +/** + * Request parameters for getDefaultViolationReportV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetDefaultViolationReportV1Request + */ +export interface SODPoliciesV1ApiGetDefaultViolationReportV1Request { + /** + * The ID of the report reference to download. + * @type {string} + * @memberof SODPoliciesV1ApiGetDefaultViolationReportV1 + */ + readonly reportResultId: string +} + +/** + * Request parameters for getSodPolicyScheduleV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetSodPolicyScheduleV1Request + */ +export interface SODPoliciesV1ApiGetSodPolicyScheduleV1Request { + /** + * The ID of the SOD policy schedule to retrieve. + * @type {string} + * @memberof SODPoliciesV1ApiGetSodPolicyScheduleV1 + */ + readonly id: string +} + +/** + * Request parameters for getSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetSodPolicyV1Request + */ +export interface SODPoliciesV1ApiGetSodPolicyV1Request { + /** + * The ID of the SOD Policy to retrieve. + * @type {string} + * @memberof SODPoliciesV1ApiGetSodPolicyV1 + */ + readonly id: string +} + +/** + * Request parameters for getSodViolationReportRunStatusV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request + */ +export interface SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request { + /** + * The ID of the report reference to retrieve. + * @type {string} + * @memberof SODPoliciesV1ApiGetSodViolationReportRunStatusV1 + */ + readonly reportResultId: string +} + +/** + * Request parameters for getSodViolationReportStatusV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiGetSodViolationReportStatusV1Request + */ +export interface SODPoliciesV1ApiGetSodViolationReportStatusV1Request { + /** + * The ID of the violation report to retrieve status for. + * @type {string} + * @memberof SODPoliciesV1ApiGetSodViolationReportStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for listSodPoliciesV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiListSodPoliciesV1Request + */ +export interface SODPoliciesV1ApiListSodPoliciesV1Request { + /** + * 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 SODPoliciesV1ApiListSodPoliciesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SODPoliciesV1ApiListSodPoliciesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof SODPoliciesV1ApiListSodPoliciesV1 + */ + 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, in* **name**: *eq, in* **state**: *eq, in* + * @type {string} + * @memberof SODPoliciesV1ApiListSodPoliciesV1 + */ + 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, name, created, modified, description** + * @type {string} + * @memberof SODPoliciesV1ApiListSodPoliciesV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiPatchSodPolicyV1Request + */ +export interface SODPoliciesV1ApiPatchSodPolicyV1Request { + /** + * The ID of the SOD policy being modified. + * @type {string} + * @memberof SODPoliciesV1ApiPatchSodPolicyV1 + */ + readonly id: string + + /** + * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + * @type {Array} + * @memberof SODPoliciesV1ApiPatchSodPolicyV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for putPolicyScheduleV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiPutPolicyScheduleV1Request + */ +export interface SODPoliciesV1ApiPutPolicyScheduleV1Request { + /** + * The ID of the SOD policy to update its schedule. + * @type {string} + * @memberof SODPoliciesV1ApiPutPolicyScheduleV1 + */ + readonly id: string + + /** + * + * @type {SodpolicyscheduleV1} + * @memberof SODPoliciesV1ApiPutPolicyScheduleV1 + */ + readonly sodpolicyscheduleV1: SodpolicyscheduleV1 +} + +/** + * Request parameters for putSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiPutSodPolicyV1Request + */ +export interface SODPoliciesV1ApiPutSodPolicyV1Request { + /** + * The ID of the SOD policy to update. + * @type {string} + * @memberof SODPoliciesV1ApiPutSodPolicyV1 + */ + readonly id: string + + /** + * + * @type {SodpolicyV1} + * @memberof SODPoliciesV1ApiPutSodPolicyV1 + */ + readonly sodpolicyV1: SodpolicyV1 +} + +/** + * Request parameters for startEvaluateSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiStartEvaluateSodPolicyV1Request + */ +export interface SODPoliciesV1ApiStartEvaluateSodPolicyV1Request { + /** + * The SOD policy ID to run. + * @type {string} + * @memberof SODPoliciesV1ApiStartEvaluateSodPolicyV1 + */ + readonly id: string +} + +/** + * Request parameters for startSodAllPoliciesForOrgV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request + */ +export interface SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request { + /** + * + * @type {MultipolicyrequestV1} + * @memberof SODPoliciesV1ApiStartSodAllPoliciesForOrgV1 + */ + readonly multipolicyrequestV1?: MultipolicyrequestV1 +} + +/** + * Request parameters for startSodPolicyV1 operation in SODPoliciesV1Api. + * @export + * @interface SODPoliciesV1ApiStartSodPolicyV1Request + */ +export interface SODPoliciesV1ApiStartSodPolicyV1Request { + /** + * The SOD policy ID to run. + * @type {string} + * @memberof SODPoliciesV1ApiStartSodPolicyV1 + */ + readonly id: string +} + +/** + * SODPoliciesV1Api - object-oriented interface + * @export + * @class SODPoliciesV1Api + * @extends {BaseAPI} + */ +export class SODPoliciesV1Api extends BaseAPI { + /** + * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. + * @summary Create sod policy + * @param {SODPoliciesV1ApiCreateSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public createSodPolicyV1(requestParameters: SODPoliciesV1ApiCreateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).createSodPolicyV1(requestParameters.sodpolicyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes schedule for a specified SOD policy by ID. + * @summary Delete sod policy schedule + * @param {SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public deleteSodPolicyScheduleV1(requestParameters: SODPoliciesV1ApiDeleteSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).deleteSodPolicyScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This deletes a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Delete sod policy by id + * @param {SODPoliciesV1ApiDeleteSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public deleteSodPolicyV1(requestParameters: SODPoliciesV1ApiDeleteSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).deleteSodPolicyV1(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This allows to download a specified named violation report for a given report reference. + * @summary Download custom violation report + * @param {SODPoliciesV1ApiGetCustomViolationReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getCustomViolationReportV1(requestParameters: SODPoliciesV1ApiGetCustomViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getCustomViolationReportV1(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This allows to download a violation report for a given report reference. + * @summary Download violation report + * @param {SODPoliciesV1ApiGetDefaultViolationReportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getDefaultViolationReportV1(requestParameters: SODPoliciesV1ApiGetDefaultViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getDefaultViolationReportV1(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint gets the status for a violation report for all policy run. + * @summary Get multi-report run task status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getSodAllReportRunStatusV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint gets a specified SOD policy\'s schedule. + * @summary Get sod policy schedule + * @param {SODPoliciesV1ApiGetSodPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getSodPolicyScheduleV1(requestParameters: SODPoliciesV1ApiGetSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getSodPolicyScheduleV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets specified SOD policy. Requires role of ORG_ADMIN. + * @summary Get sod policy by id + * @param {SODPoliciesV1ApiGetSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getSodPolicyV1(requestParameters: SODPoliciesV1ApiGetSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get violation report run status + * @param {SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getSodViolationReportRunStatusV1(requestParameters: SODPoliciesV1ApiGetSodViolationReportRunStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getSodViolationReportRunStatusV1(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets the status for a violation report run task that has already been invoked. + * @summary Get sod violation report status + * @param {SODPoliciesV1ApiGetSodViolationReportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public getSodViolationReportStatusV1(requestParameters: SODPoliciesV1ApiGetSodViolationReportStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).getSodViolationReportStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets list of all SOD policies. Requires role of ORG_ADMIN + * @summary List sod policies + * @param {SODPoliciesV1ApiListSodPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public listSodPoliciesV1(requestParameters: SODPoliciesV1ApiListSodPoliciesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).listSodPoliciesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + * @summary Patch sod policy by id + * @param {SODPoliciesV1ApiPatchSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public patchSodPolicyV1(requestParameters: SODPoliciesV1ApiPatchSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).patchSodPolicyV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates schedule for a specified SOD policy. + * @summary Update sod policy schedule + * @param {SODPoliciesV1ApiPutPolicyScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public putPolicyScheduleV1(requestParameters: SODPoliciesV1ApiPutPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).putPolicyScheduleV1(requestParameters.id, requestParameters.sodpolicyscheduleV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates a specified SOD policy. Requires role of ORG_ADMIN. + * @summary Update sod policy by id + * @param {SODPoliciesV1ApiPutSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public putSodPolicyV1(requestParameters: SODPoliciesV1ApiPutSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).putSodPolicyV1(requestParameters.id, requestParameters.sodpolicyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + * @summary Evaluate one policy by id + * @param {SODPoliciesV1ApiStartEvaluateSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public startEvaluateSodPolicyV1(requestParameters: SODPoliciesV1ApiStartEvaluateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).startEvaluateSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + * @summary Runs all policies for org + * @param {SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public startSodAllPoliciesForOrgV1(requestParameters: SODPoliciesV1ApiStartSodAllPoliciesForOrgV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).startSodAllPoliciesForOrgV1(requestParameters.multipolicyrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + * @summary Runs sod policy violation report + * @param {SODPoliciesV1ApiStartSodPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODPoliciesV1Api + */ + public startSodPolicyV1(requestParameters: SODPoliciesV1ApiStartSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODPoliciesV1ApiFp(this.configuration).startSodPolicyV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/sod_policies/base.ts b/sdk-output/sod_policies/base.ts new file mode 100644 index 00000000..bfa82d70 --- /dev/null +++ b/sdk-output/sod_policies/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Policies + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/sod_policies/common.ts b/sdk-output/sod_policies/common.ts new file mode 100644 index 00000000..3548f599 --- /dev/null +++ b/sdk-output/sod_policies/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Policies + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/sod_policies/configuration.ts b/sdk-output/sod_policies/configuration.ts new file mode 100644 index 00000000..b62b0ad4 --- /dev/null +++ b/sdk-output/sod_policies/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Policies + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/sod_policies/git_push.sh b/sdk-output/sod_policies/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/sod_policies/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/sod_policies/index.ts b/sdk-output/sod_policies/index.ts new file mode 100644 index 00000000..edadc108 --- /dev/null +++ b/sdk-output/sod_policies/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Policies + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/sod_policies/package.json b/sdk-output/sod_policies/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/sod_policies/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/sod_policies/tsconfig.json b/sdk-output/sod_policies/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/sod_policies/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/sod_violations/.gitignore b/sdk-output/sod_violations/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/sod_violations/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/sod_violations/.npmignore b/sdk-output/sod_violations/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/sod_violations/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/sod_violations/.openapi-generator-ignore b/sdk-output/sod_violations/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/sod_violations/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/sod_violations/.openapi-generator/FILES b/sdk-output/sod_violations/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/sod_violations/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/sod_violations/.openapi-generator/VERSION b/sdk-output/sod_violations/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/sod_violations/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/sod_violations/.sdk-partition b/sdk-output/sod_violations/.sdk-partition new file mode 100644 index 00000000..aa2a8e78 --- /dev/null +++ b/sdk-output/sod_violations/.sdk-partition @@ -0,0 +1 @@ +sod-violations \ No newline at end of file diff --git a/sdk-output/sod_violations/README.md b/sdk-output/sod_violations/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sod_violations/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sod_violations/api.ts b/sdk-output/sod_violations/api.ts new file mode 100644 index 00000000..1b223047 --- /dev/null +++ b/sdk-output/sod_violations/api.ts @@ -0,0 +1,637 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Violations + * 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'; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ExceptionaccesscriteriaV1 + */ +export interface ExceptionaccesscriteriaV1 { + /** + * + * @type {ExceptioncriteriaV1} + * @memberof ExceptionaccesscriteriaV1 + */ + 'leftCriteria'?: ExceptioncriteriaV1; + /** + * + * @type {ExceptioncriteriaV1} + * @memberof ExceptionaccesscriteriaV1 + */ + 'rightCriteria'?: ExceptioncriteriaV1; +} +/** + * The types of objects supported for SOD violations + * @export + * @interface ExceptioncriteriaCriteriaListInnerV1 + */ +export interface ExceptioncriteriaCriteriaListInnerV1 { + /** + * The type of object that is referenced + * @type {string} + * @memberof ExceptioncriteriaCriteriaListInnerV1 + */ + 'type'?: ExceptioncriteriaCriteriaListInnerV1TypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof ExceptioncriteriaCriteriaListInnerV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof ExceptioncriteriaCriteriaListInnerV1 + */ + 'name'?: string; + /** + * Whether the subject identity already had that access or not + * @type {boolean} + * @memberof ExceptioncriteriaCriteriaListInnerV1 + */ + 'existing'?: boolean; +} + +export const ExceptioncriteriaCriteriaListInnerV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type ExceptioncriteriaCriteriaListInnerV1TypeV1 = typeof ExceptioncriteriaCriteriaListInnerV1TypeV1[keyof typeof ExceptioncriteriaCriteriaListInnerV1TypeV1]; + +/** + * + * @export + * @interface ExceptioncriteriaV1 + */ +export interface ExceptioncriteriaV1 { + /** + * List of exception criteria. There is a min of 1 and max of 50 items in the list. + * @type {Array} + * @memberof ExceptioncriteriaV1 + */ + 'criteriaList'?: Array; +} +/** + * Access reference with addition of boolean existing flag to indicate whether the access was extant + * @export + * @interface ExceptioncriteriaaccessV1 + */ +export interface ExceptioncriteriaaccessV1 { + /** + * + * @type {DtotypeV1} + * @memberof ExceptioncriteriaaccessV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof ExceptioncriteriaaccessV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof ExceptioncriteriaaccessV1 + */ + 'name'?: string; + /** + * Whether the subject identity already had that access or not + * @type {boolean} + * @memberof ExceptioncriteriaaccessV1 + */ + 'existing'?: boolean; +} + + +/** + * Entitlement including a specific set of access. + * @export + * @interface IdentitywithnewaccessAccessRefsInnerV1 + */ +export interface IdentitywithnewaccessAccessRefsInnerV1 { + /** + * Entitlement\'s DTO type. + * @type {string} + * @memberof IdentitywithnewaccessAccessRefsInnerV1 + */ + 'type'?: IdentitywithnewaccessAccessRefsInnerV1TypeV1; + /** + * Entitlement\'s ID. + * @type {string} + * @memberof IdentitywithnewaccessAccessRefsInnerV1 + */ + 'id'?: string; +} + +export const IdentitywithnewaccessAccessRefsInnerV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type IdentitywithnewaccessAccessRefsInnerV1TypeV1 = typeof IdentitywithnewaccessAccessRefsInnerV1TypeV1[keyof typeof IdentitywithnewaccessAccessRefsInnerV1TypeV1]; + +/** + * An identity with a set of access to be added + * @export + * @interface IdentitywithnewaccessV1 + */ +export interface IdentitywithnewaccessV1 { + /** + * Identity id to be checked. + * @type {string} + * @memberof IdentitywithnewaccessV1 + */ + 'identityId': string; + /** + * The list of entitlements to consider for possible violations in a preventive check. + * @type {Array} + * @memberof IdentitywithnewaccessV1 + */ + 'accessRefs': Array; +} +/** + * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + * @export + * @enum {string} + */ + +export const LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * SOD policy. + * @export + * @interface Sodpolicydto2V1 + */ +export interface Sodpolicydto2V1 { + /** + * SOD policy DTO type. + * @type {string} + * @memberof Sodpolicydto2V1 + */ + 'type'?: Sodpolicydto2V1TypeV1; + /** + * SOD policy ID. + * @type {string} + * @memberof Sodpolicydto2V1 + */ + 'id'?: string; + /** + * SOD policy display name. + * @type {string} + * @memberof Sodpolicydto2V1 + */ + 'name'?: string; +} + +export const Sodpolicydto2V1TypeV1 = { + SodPolicy: 'SOD_POLICY' +} as const; + +export type Sodpolicydto2V1TypeV1 = typeof Sodpolicydto2V1TypeV1[keyof typeof Sodpolicydto2V1TypeV1]; + +/** + * An object referencing an SOD violation check + * @export + * @interface SodviolationcheckV1 + */ +export interface SodviolationcheckV1 { + /** + * The id of the original request + * @type {string} + * @memberof SodviolationcheckV1 + */ + 'requestId': string; + /** + * The date-time when this request was created. + * @type {string} + * @memberof SodviolationcheckV1 + */ + 'created'?: string; +} +/** + * + * @export + * @interface StartPredictSodViolationsV1401ResponseV1 + */ +export interface StartPredictSodViolationsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartPredictSodViolationsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface StartPredictSodViolationsV1429ResponseV1 + */ +export interface StartPredictSodViolationsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof StartPredictSodViolationsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * The types of objects supported for SOD violations + * @export + * @interface ViolationcontextPolicyV1 + */ +export interface ViolationcontextPolicyV1 { + /** + * The type of object that is referenced + * @type {string} + * @memberof ViolationcontextPolicyV1 + */ + 'type'?: ViolationcontextPolicyV1TypeV1; + /** + * SOD policy ID. + * @type {string} + * @memberof ViolationcontextPolicyV1 + */ + 'id'?: string; + /** + * + * @type {string} + * @memberof ViolationcontextPolicyV1 + */ + 'name'?: string; +} + +export const ViolationcontextPolicyV1TypeV1 = { + Entitlement: 'ENTITLEMENT' +} as const; + +export type ViolationcontextPolicyV1TypeV1 = typeof ViolationcontextPolicyV1TypeV1[keyof typeof ViolationcontextPolicyV1TypeV1]; + +/** + * + * @export + * @interface ViolationcontextV1 + */ +export interface ViolationcontextV1 { + /** + * + * @type {ViolationcontextPolicyV1} + * @memberof ViolationcontextV1 + */ + 'policy'?: ViolationcontextPolicyV1; + /** + * + * @type {ExceptionaccesscriteriaV1} + * @memberof ViolationcontextV1 + */ + 'conflictingAccessCriteria'?: ExceptionaccesscriteriaV1; +} +/** + * An object containing a listing of the SOD violation reasons detected by this check. + * @export + * @interface ViolationpredictionV1 + */ +export interface ViolationpredictionV1 { + /** + * List of Violation Contexts + * @type {Array} + * @memberof ViolationpredictionV1 + */ + 'violationContexts'?: Array; +} + +/** + * SODViolationsV1Api - axios parameter creator + * @export + */ +export const SODViolationsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + * @summary Predict sod violations for identity. + * @param {IdentitywithnewaccessV1} identitywithnewaccessV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startPredictSodViolationsV1: async (identitywithnewaccessV1: IdentitywithnewaccessV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identitywithnewaccessV1' is not null or undefined + assertParamExists('startPredictSodViolationsV1', 'identitywithnewaccessV1', identitywithnewaccessV1) + const localVarPath = `/sod-violations/v1/predict`; + // 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(identitywithnewaccessV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API initiates a SOD policy verification asynchronously. + * @summary Check sod violations + * @param {IdentitywithnewaccessV1} identitywithnewaccessV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startViolationCheckV1: async (identitywithnewaccessV1: IdentitywithnewaccessV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identitywithnewaccessV1' is not null or undefined + assertParamExists('startViolationCheckV1', 'identitywithnewaccessV1', identitywithnewaccessV1) + const localVarPath = `/sod-violations/v1/check`; + // 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(identitywithnewaccessV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SODViolationsV1Api - functional programming interface + * @export + */ +export const SODViolationsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SODViolationsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + * @summary Predict sod violations for identity. + * @param {IdentitywithnewaccessV1} identitywithnewaccessV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startPredictSodViolationsV1(identitywithnewaccessV1: IdentitywithnewaccessV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolationsV1(identitywithnewaccessV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODViolationsV1Api.startPredictSodViolationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API initiates a SOD policy verification asynchronously. + * @summary Check sod violations + * @param {IdentitywithnewaccessV1} identitywithnewaccessV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startViolationCheckV1(identitywithnewaccessV1: IdentitywithnewaccessV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startViolationCheckV1(identitywithnewaccessV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SODViolationsV1Api.startViolationCheckV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SODViolationsV1Api - factory interface + * @export + */ +export const SODViolationsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SODViolationsV1ApiFp(configuration) + return { + /** + * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + * @summary Predict sod violations for identity. + * @param {SODViolationsV1ApiStartPredictSodViolationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startPredictSodViolationsV1(requestParameters: SODViolationsV1ApiStartPredictSodViolationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startPredictSodViolationsV1(requestParameters.identitywithnewaccessV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API initiates a SOD policy verification asynchronously. + * @summary Check sod violations + * @param {SODViolationsV1ApiStartViolationCheckV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startViolationCheckV1(requestParameters: SODViolationsV1ApiStartViolationCheckV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.startViolationCheckV1(requestParameters.identitywithnewaccessV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for startPredictSodViolationsV1 operation in SODViolationsV1Api. + * @export + * @interface SODViolationsV1ApiStartPredictSodViolationsV1Request + */ +export interface SODViolationsV1ApiStartPredictSodViolationsV1Request { + /** + * + * @type {IdentitywithnewaccessV1} + * @memberof SODViolationsV1ApiStartPredictSodViolationsV1 + */ + readonly identitywithnewaccessV1: IdentitywithnewaccessV1 +} + +/** + * Request parameters for startViolationCheckV1 operation in SODViolationsV1Api. + * @export + * @interface SODViolationsV1ApiStartViolationCheckV1Request + */ +export interface SODViolationsV1ApiStartViolationCheckV1Request { + /** + * + * @type {IdentitywithnewaccessV1} + * @memberof SODViolationsV1ApiStartViolationCheckV1 + */ + readonly identitywithnewaccessV1: IdentitywithnewaccessV1 +} + +/** + * SODViolationsV1Api - object-oriented interface + * @export + * @class SODViolationsV1Api + * @extends {BaseAPI} + */ +export class SODViolationsV1Api extends BaseAPI { + /** + * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + * @summary Predict sod violations for identity. + * @param {SODViolationsV1ApiStartPredictSodViolationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODViolationsV1Api + */ + public startPredictSodViolationsV1(requestParameters: SODViolationsV1ApiStartPredictSodViolationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODViolationsV1ApiFp(this.configuration).startPredictSodViolationsV1(requestParameters.identitywithnewaccessV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API initiates a SOD policy verification asynchronously. + * @summary Check sod violations + * @param {SODViolationsV1ApiStartViolationCheckV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SODViolationsV1Api + */ + public startViolationCheckV1(requestParameters: SODViolationsV1ApiStartViolationCheckV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SODViolationsV1ApiFp(this.configuration).startViolationCheckV1(requestParameters.identitywithnewaccessV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/sod_violations/base.ts b/sdk-output/sod_violations/base.ts new file mode 100644 index 00000000..bc845dba --- /dev/null +++ b/sdk-output/sod_violations/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Violations + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/sod_violations/common.ts b/sdk-output/sod_violations/common.ts new file mode 100644 index 00000000..4f52360c --- /dev/null +++ b/sdk-output/sod_violations/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Violations + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/sod_violations/configuration.ts b/sdk-output/sod_violations/configuration.ts new file mode 100644 index 00000000..5d840096 --- /dev/null +++ b/sdk-output/sod_violations/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Violations + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/sod_violations/git_push.sh b/sdk-output/sod_violations/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/sod_violations/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/sod_violations/index.ts b/sdk-output/sod_violations/index.ts new file mode 100644 index 00000000..c06bea14 --- /dev/null +++ b/sdk-output/sod_violations/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SOD Violations + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/sod_violations/package.json b/sdk-output/sod_violations/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/sod_violations/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/sod_violations/tsconfig.json b/sdk-output/sod_violations/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/sod_violations/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/source_usages/.gitignore b/sdk-output/source_usages/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/source_usages/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/source_usages/.npmignore b/sdk-output/source_usages/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/source_usages/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/source_usages/.openapi-generator-ignore b/sdk-output/source_usages/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/source_usages/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/source_usages/.openapi-generator/FILES b/sdk-output/source_usages/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/source_usages/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/source_usages/.openapi-generator/VERSION b/sdk-output/source_usages/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/source_usages/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/source_usages/.sdk-partition b/sdk-output/source_usages/.sdk-partition new file mode 100644 index 00000000..d3d10b87 --- /dev/null +++ b/sdk-output/source_usages/.sdk-partition @@ -0,0 +1 @@ +source-usages \ No newline at end of file diff --git a/sdk-output/source_usages/README.md b/sdk-output/source_usages/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/source_usages/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/source_usages/api.ts b/sdk-output/source_usages/api.ts new file mode 100644 index 00000000..a7a61a7c --- /dev/null +++ b/sdk-output/source_usages/api.ts @@ -0,0 +1,421 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Source Usages + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetStatusBySourceIdV1401ResponseV1 + */ +export interface GetStatusBySourceIdV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetStatusBySourceIdV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetStatusBySourceIdV1429ResponseV1 + */ +export interface GetStatusBySourceIdV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetStatusBySourceIdV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface SourceusageV1 + */ +export interface SourceusageV1 { + /** + * The first day of the month for which activity is aggregated. + * @type {string} + * @memberof SourceusageV1 + */ + 'date'?: string; + /** + * The average number of days that accounts were active within this source, for the month. + * @type {number} + * @memberof SourceusageV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface SourceusagestatusV1 + */ +export interface SourceusagestatusV1 { + /** + * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. + * @type {string} + * @memberof SourceusagestatusV1 + */ + 'status'?: SourceusagestatusV1StatusV1; +} + +export const SourceusagestatusV1StatusV1 = { + Complete: 'COMPLETE', + Incomplete: 'INCOMPLETE' +} as const; + +export type SourceusagestatusV1StatusV1 = typeof SourceusagestatusV1StatusV1[keyof typeof SourceusagestatusV1StatusV1]; + + +/** + * SourceUsagesV1Api - axios parameter creator + * @export + */ +export const SourceUsagesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API returns the status of the source usage insights setup by IDN source ID. + * @summary Finds status of source usage + * @param {string} sourceId ID of IDN source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStatusBySourceIdV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getStatusBySourceIdV1', 'sourceId', sourceId) + const localVarPath = `/source-usages/v1/{sourceId}/status` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a summary of source usage insights for past 12 months. + * @summary Returns source usage insights + * @param {string} sourceId ID of IDN source + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **date** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUsagesBySourceIdV1: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getUsagesBySourceIdV1', 'sourceId', sourceId) + const localVarPath = `/source-usages/v1/{sourceId}/summaries` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + } +}; + +/** + * SourceUsagesV1Api - functional programming interface + * @export + */ +export const SourceUsagesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SourceUsagesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API returns the status of the source usage insights setup by IDN source ID. + * @summary Finds status of source usage + * @param {string} sourceId ID of IDN source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getStatusBySourceIdV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceIdV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourceUsagesV1Api.getStatusBySourceIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a summary of source usage insights for past 12 months. + * @summary Returns source usage insights + * @param {string} sourceId ID of IDN source + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **date** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getUsagesBySourceIdV1(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceIdV1(sourceId, limit, offset, count, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourceUsagesV1Api.getUsagesBySourceIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SourceUsagesV1Api - factory interface + * @export + */ +export const SourceUsagesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SourceUsagesV1ApiFp(configuration) + return { + /** + * This API returns the status of the source usage insights setup by IDN source ID. + * @summary Finds status of source usage + * @param {SourceUsagesV1ApiGetStatusBySourceIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getStatusBySourceIdV1(requestParameters: SourceUsagesV1ApiGetStatusBySourceIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getStatusBySourceIdV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a summary of source usage insights for past 12 months. + * @summary Returns source usage insights + * @param {SourceUsagesV1ApiGetUsagesBySourceIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getUsagesBySourceIdV1(requestParameters: SourceUsagesV1ApiGetUsagesBySourceIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getUsagesBySourceIdV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getStatusBySourceIdV1 operation in SourceUsagesV1Api. + * @export + * @interface SourceUsagesV1ApiGetStatusBySourceIdV1Request + */ +export interface SourceUsagesV1ApiGetStatusBySourceIdV1Request { + /** + * ID of IDN source + * @type {string} + * @memberof SourceUsagesV1ApiGetStatusBySourceIdV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getUsagesBySourceIdV1 operation in SourceUsagesV1Api. + * @export + * @interface SourceUsagesV1ApiGetUsagesBySourceIdV1Request + */ +export interface SourceUsagesV1ApiGetUsagesBySourceIdV1Request { + /** + * ID of IDN source + * @type {string} + * @memberof SourceUsagesV1ApiGetUsagesBySourceIdV1 + */ + readonly sourceId: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SourceUsagesV1ApiGetUsagesBySourceIdV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SourceUsagesV1ApiGetUsagesBySourceIdV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof SourceUsagesV1ApiGetUsagesBySourceIdV1 + */ + readonly count?: boolean + + /** + * 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: **date** + * @type {string} + * @memberof SourceUsagesV1ApiGetUsagesBySourceIdV1 + */ + readonly sorters?: string +} + +/** + * SourceUsagesV1Api - object-oriented interface + * @export + * @class SourceUsagesV1Api + * @extends {BaseAPI} + */ +export class SourceUsagesV1Api extends BaseAPI { + /** + * This API returns the status of the source usage insights setup by IDN source ID. + * @summary Finds status of source usage + * @param {SourceUsagesV1ApiGetStatusBySourceIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourceUsagesV1Api + */ + public getStatusBySourceIdV1(requestParameters: SourceUsagesV1ApiGetStatusBySourceIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourceUsagesV1ApiFp(this.configuration).getStatusBySourceIdV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a summary of source usage insights for past 12 months. + * @summary Returns source usage insights + * @param {SourceUsagesV1ApiGetUsagesBySourceIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourceUsagesV1Api + */ + public getUsagesBySourceIdV1(requestParameters: SourceUsagesV1ApiGetUsagesBySourceIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourceUsagesV1ApiFp(this.configuration).getUsagesBySourceIdV1(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/source_usages/base.ts b/sdk-output/source_usages/base.ts new file mode 100644 index 00000000..5dd6bb32 --- /dev/null +++ b/sdk-output/source_usages/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Source Usages + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/source_usages/common.ts b/sdk-output/source_usages/common.ts new file mode 100644 index 00000000..e151a9c4 --- /dev/null +++ b/sdk-output/source_usages/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Source Usages + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/source_usages/configuration.ts b/sdk-output/source_usages/configuration.ts new file mode 100644 index 00000000..d695caef --- /dev/null +++ b/sdk-output/source_usages/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Source Usages + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/source_usages/git_push.sh b/sdk-output/source_usages/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/source_usages/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/source_usages/index.ts b/sdk-output/source_usages/index.ts new file mode 100644 index 00000000..cc5e4b45 --- /dev/null +++ b/sdk-output/source_usages/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Source Usages + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/source_usages/package.json b/sdk-output/source_usages/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/source_usages/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/source_usages/tsconfig.json b/sdk-output/source_usages/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/source_usages/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/sources/.gitignore b/sdk-output/sources/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/sources/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/sources/.npmignore b/sdk-output/sources/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/sources/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/sources/.openapi-generator-ignore b/sdk-output/sources/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/sources/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/sources/.openapi-generator/FILES b/sdk-output/sources/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/sources/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/sources/.openapi-generator/VERSION b/sdk-output/sources/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/sources/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/sources/.sdk-partition b/sdk-output/sources/.sdk-partition new file mode 100644 index 00000000..0b21f408 --- /dev/null +++ b/sdk-output/sources/.sdk-partition @@ -0,0 +1 @@ +sources \ No newline at end of file diff --git a/sdk-output/sources/README.md b/sdk-output/sources/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sources/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sources/api.ts b/sdk-output/sources/api.ts new file mode 100644 index 00000000..0b6afdb5 --- /dev/null +++ b/sdk-output/sources/api.ts @@ -0,0 +1,8916 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Sources + * 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'; + +/** + * detailed information about account delete approval config + * @export + * @interface AccountdeleteconfigdtoV1 + */ +export interface AccountdeleteconfigdtoV1 { + /** + * Specifies if an account deletion request requires approval. + * @type {boolean} + * @memberof AccountdeleteconfigdtoV1 + */ + 'approvalRequired'?: boolean; + /** + * + * @type {ApprovalconfigV1} + * @memberof AccountdeleteconfigdtoV1 + */ + 'approvalConfig'?: ApprovalconfigV1; +} +/** + * Timezone configuration for cron schedules. + * @export + * @interface ApprovalconfigCronTimezoneV1 + */ +export interface ApprovalconfigCronTimezoneV1 { + /** + * Timezone location for cron schedules. + * @type {string} + * @memberof ApprovalconfigCronTimezoneV1 + */ + 'location'?: string; + /** + * Timezone offset for cron schedules. + * @type {string} + * @memberof ApprovalconfigCronTimezoneV1 + */ + 'offset'?: string; +} +/** + * + * @export + * @interface ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ +export interface ApprovalconfigEscalationConfigEscalationChainInnerV1 { + /** + * Starting at 1 defines the order in which the identities will get assigned + * @type {number} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'tier'?: number; + /** + * Optional Identity ID of the type of identity defined in the \'identityType\' field. + * @type {string} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'identityId'?: string; + /** + * Type of identityId in the escalation chain. + * @type {string} + * @memberof ApprovalconfigEscalationConfigEscalationChainInnerV1 + */ + 'identityType'?: ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1; +} + +export const ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1 = { + Identity: 'IDENTITY', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER' +} as const; + +export type ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1 = typeof ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1[keyof typeof ApprovalconfigEscalationConfigEscalationChainInnerV1IdentityTypeV1]; + +/** + * Configuration for escalations. + * @export + * @interface ApprovalconfigEscalationConfigV1 + */ +export interface ApprovalconfigEscalationConfigV1 { + /** + * Indicates if escalations are enabled. + * @type {boolean} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until the first escalation. + * @type {number} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'daysUntilFirstEscalation'?: number; + /** + * Cron schedule for escalations. + * @type {string} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'escalationCronSchedule'?: string; + /** + * Escalation chain configuration. + * @type {Array} + * @memberof ApprovalconfigEscalationConfigV1 + */ + 'escalationChain'?: Array; +} +/** + * Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. + * @export + * @interface ApprovalconfigFallbackApproverV1 + */ +export interface ApprovalconfigFallbackApproverV1 { + /** + * Optional Identity ID of the type of identity defined in the \'type\' field. + * @type {string} + * @memberof ApprovalconfigFallbackApproverV1 + */ + 'identityID'?: string; + /** + * Type of identityID for the fallback approver. + * @type {string} + * @memberof ApprovalconfigFallbackApproverV1 + */ + 'type'?: ApprovalconfigFallbackApproverV1TypeV1; +} + +export const ApprovalconfigFallbackApproverV1TypeV1 = { + Identity: 'IDENTITY', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', + RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER' +} as const; + +export type ApprovalconfigFallbackApproverV1TypeV1 = typeof ApprovalconfigFallbackApproverV1TypeV1[keyof typeof ApprovalconfigFallbackApproverV1TypeV1]; + +/** + * Configuration for reminders. + * @export + * @interface ApprovalconfigReminderConfigV1 + */ +export interface ApprovalconfigReminderConfigV1 { + /** + * Indicates if reminders are enabled. + * @type {boolean} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until the first reminder. + * @type {number} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'daysUntilFirstReminder'?: number; + /** + * Cron schedule for reminders. + * @type {string} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'reminderCronSchedule'?: string; + /** + * Maximum number of reminders. Max is 20. + * @type {number} + * @memberof ApprovalconfigReminderConfigV1 + */ + 'maxReminders'?: number; +} +/** + * + * @export + * @interface ApprovalconfigSerialChainInnerV1 + */ +export interface ApprovalconfigSerialChainInnerV1 { + /** + * Starting at 1 defines the order in which the identities will get assigned + * @type {number} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'tier'?: number; + /** + * Optional Identity ID of the type of identity defined in the \'identityType\' field. + * @type {string} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'identityId'?: string; + /** + * Type of identityId in the serial chain. + * @type {string} + * @memberof ApprovalconfigSerialChainInnerV1 + */ + 'identityType'?: ApprovalconfigSerialChainInnerV1IdentityTypeV1; +} + +export const ApprovalconfigSerialChainInnerV1IdentityTypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP', + ManagerOf: 'MANAGER_OF', + AccountOwner: 'ACCOUNT_OWNER', + MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', + ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', + ManagerOfOwner: 'MANAGER_OF_OWNER', + AccessProfileOwner: 'ACCESS_PROFILE_OWNER', + ApplicationOwner: 'APPLICATION_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER', + RoleOwner: 'ROLE_OWNER', + SourceOwner: 'SOURCE_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', + ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', + EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', + RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', + SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', + RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', + AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', + ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', + EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', + RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', + SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', + RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', + AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', + ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', + EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', + RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', + SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', + RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' +} as const; + +export type ApprovalconfigSerialChainInnerV1IdentityTypeV1 = typeof ApprovalconfigSerialChainInnerV1IdentityTypeV1[keyof typeof ApprovalconfigSerialChainInnerV1IdentityTypeV1]; + +/** + * TimeoutConfig contains configurations around when the approval request should expire. + * @export + * @interface ApprovalconfigTimeoutConfigV1 + */ +export interface ApprovalconfigTimeoutConfigV1 { + /** + * Indicates if timeout is enabled. + * @type {boolean} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'enabled'?: boolean; + /** + * Number of days until approval request times out. Max value is 90. + * @type {number} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'daysUntilTimeout'?: number; + /** + * Result of timeout. + * @type {string} + * @memberof ApprovalconfigTimeoutConfigV1 + */ + 'timeoutResult'?: ApprovalconfigTimeoutConfigV1TimeoutResultV1; +} + +export const ApprovalconfigTimeoutConfigV1TimeoutResultV1 = { + Expired: 'EXPIRED', + Approved: 'APPROVED' +} as const; + +export type ApprovalconfigTimeoutConfigV1TimeoutResultV1 = typeof ApprovalconfigTimeoutConfigV1TimeoutResultV1[keyof typeof ApprovalconfigTimeoutConfigV1TimeoutResultV1]; + +/** + * Approval config Object + * @export + * @interface ApprovalconfigV1 + */ +export interface ApprovalconfigV1 { + /** + * + * @type {ApprovalconfigReminderConfigV1} + * @memberof ApprovalconfigV1 + */ + 'reminderConfig'?: ApprovalconfigReminderConfigV1; + /** + * + * @type {ApprovalconfigEscalationConfigV1} + * @memberof ApprovalconfigV1 + */ + 'escalationConfig'?: ApprovalconfigEscalationConfigV1; + /** + * + * @type {ApprovalconfigTimeoutConfigV1} + * @memberof ApprovalconfigV1 + */ + 'timeoutConfig'?: ApprovalconfigTimeoutConfigV1; + /** + * + * @type {ApprovalconfigCronTimezoneV1} + * @memberof ApprovalconfigV1 + */ + 'cronTimezone'?: ApprovalconfigCronTimezoneV1; + /** + * If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. + * @type {Array} + * @memberof ApprovalconfigV1 + */ + 'serialChain'?: Array; + /** + * Determines whether a comment is required when approving or rejecting the approval request. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'requiresComment'?: ApprovalconfigV1RequiresCommentV1; + /** + * + * @type {ApprovalconfigFallbackApproverV1} + * @memberof ApprovalconfigV1 + */ + 'fallbackApprover'?: ApprovalconfigFallbackApproverV1; + /** + * Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'machineIdentityManagerAssignment'?: ApprovalconfigV1MachineIdentityManagerAssignmentV1; + /** + * When true, all approvals will be created with the status \"PASSED\". + * @type {boolean} + * @memberof ApprovalconfigV1 + */ + 'circumventApprovalProcess'?: boolean; + /** + * OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. + * @type {string} + * @memberof ApprovalconfigV1 + */ + 'autoApprove'?: ApprovalconfigV1AutoApproveV1; +} + +export const ApprovalconfigV1RequiresCommentV1 = { + Approval: 'APPROVAL', + Rejection: 'REJECTION', + All: 'ALL', + Off: 'OFF' +} as const; + +export type ApprovalconfigV1RequiresCommentV1 = typeof ApprovalconfigV1RequiresCommentV1[keyof typeof ApprovalconfigV1RequiresCommentV1]; +export const ApprovalconfigV1MachineIdentityManagerAssignmentV1 = { + ManagerOfRequester: 'MANAGER_OF_REQUESTER', + MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', + ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', + RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', + ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', + AccountOwner: 'ACCOUNT_OWNER', + ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER' +} as const; + +export type ApprovalconfigV1MachineIdentityManagerAssignmentV1 = typeof ApprovalconfigV1MachineIdentityManagerAssignmentV1[keyof typeof ApprovalconfigV1MachineIdentityManagerAssignmentV1]; +export const ApprovalconfigV1AutoApproveV1 = { + Off: 'OFF', + Direct: 'DIRECT', + Indirect: 'INDIRECT' +} as const; + +export type ApprovalconfigV1AutoApproveV1 = typeof ApprovalconfigV1AutoApproveV1[keyof typeof ApprovalconfigV1AutoApproveV1]; + +/** + * + * @export + * @interface ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * A reference to the schema on the source to the attribute values map to. + * @export + * @interface AttributedefinitionSchemaV1 + */ +export interface AttributedefinitionSchemaV1 { + /** + * The type of object being referenced + * @type {string} + * @memberof AttributedefinitionSchemaV1 + */ + 'type'?: AttributedefinitionSchemaV1TypeV1; + /** + * The object ID this reference applies to. + * @type {string} + * @memberof AttributedefinitionSchemaV1 + */ + 'id'?: string; + /** + * The human-readable display name of the object. + * @type {string} + * @memberof AttributedefinitionSchemaV1 + */ + 'name'?: string; +} + +export const AttributedefinitionSchemaV1TypeV1 = { + ConnectorSchema: 'CONNECTOR_SCHEMA' +} as const; + +export type AttributedefinitionSchemaV1TypeV1 = typeof AttributedefinitionSchemaV1TypeV1[keyof typeof AttributedefinitionSchemaV1TypeV1]; + +/** + * + * @export + * @interface AttributedefinitionV1 + */ +export interface AttributedefinitionV1 { + /** + * The name of the attribute. + * @type {string} + * @memberof AttributedefinitionV1 + */ + 'name'?: string; + /** + * Attribute name in the native system. + * @type {string} + * @memberof AttributedefinitionV1 + */ + 'nativeName'?: string | null; + /** + * + * @type {AttributedefinitiontypeV1} + * @memberof AttributedefinitionV1 + */ + 'type'?: AttributedefinitiontypeV1; + /** + * + * @type {AttributedefinitionSchemaV1} + * @memberof AttributedefinitionV1 + */ + 'schema'?: AttributedefinitionSchemaV1 | null; + /** + * A human-readable description of the attribute. + * @type {string} + * @memberof AttributedefinitionV1 + */ + 'description'?: string; + /** + * Flag indicating whether or not the attribute is multi-valued. + * @type {boolean} + * @memberof AttributedefinitionV1 + */ + 'isMulti'?: boolean; + /** + * Flag indicating whether or not the attribute is an entitlement. + * @type {boolean} + * @memberof AttributedefinitionV1 + */ + 'isEntitlement'?: boolean; + /** + * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + * @type {boolean} + * @memberof AttributedefinitionV1 + */ + 'isGroup'?: boolean; +} + + +/** + * The underlying type of the value which an AttributeDefinition represents. + * @export + * @enum {string} + */ + +export const AttributedefinitiontypeV1 = { + String: 'STRING', + Long: 'LONG', + Int: 'INT', + Boolean: 'BOOLEAN', + Date: 'DATE' +} as const; + +export type AttributedefinitiontypeV1 = typeof AttributedefinitiontypeV1[keyof typeof AttributedefinitiontypeV1]; + + +/** + * Target source for attribute synchronization. + * @export + * @interface AttrsyncsourceV1 + */ +export interface AttrsyncsourceV1 { + /** + * DTO type of target source for attribute synchronization. + * @type {string} + * @memberof AttrsyncsourceV1 + */ + 'type'?: AttrsyncsourceV1TypeV1; + /** + * ID of target source for attribute synchronization. + * @type {string} + * @memberof AttrsyncsourceV1 + */ + 'id'?: string; + /** + * Human-readable name of target source for attribute synchronization. + * @type {string} + * @memberof AttrsyncsourceV1 + */ + 'name'?: string | null; +} + +export const AttrsyncsourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AttrsyncsourceV1TypeV1 = typeof AttrsyncsourceV1TypeV1[keyof typeof AttrsyncsourceV1TypeV1]; + +/** + * Specification of source attribute sync mapping configuration for an identity attribute + * @export + * @interface AttrsyncsourceattributeconfigV1 + */ +export interface AttrsyncsourceattributeconfigV1 { + /** + * Name of the identity attribute + * @type {string} + * @memberof AttrsyncsourceattributeconfigV1 + */ + 'name': string; + /** + * Display name of the identity attribute + * @type {string} + * @memberof AttrsyncsourceattributeconfigV1 + */ + 'displayName': string; + /** + * Determines whether or not the attribute is enabled for synchronization + * @type {boolean} + * @memberof AttrsyncsourceattributeconfigV1 + */ + 'enabled': boolean; + /** + * Name of the source account attribute to which the identity attribute value will be synchronized if enabled + * @type {string} + * @memberof AttrsyncsourceattributeconfigV1 + */ + 'target': string; +} +/** + * Specification of attribute sync configuration for a source + * @export + * @interface AttrsyncsourceconfigV1 + */ +export interface AttrsyncsourceconfigV1 { + /** + * + * @type {AttrsyncsourceV1} + * @memberof AttrsyncsourceconfigV1 + */ + 'source': AttrsyncsourceV1; + /** + * Attribute synchronization configuration for specific identity attributes in the context of a source + * @type {Array} + * @memberof AttrsyncsourceconfigV1 + */ + 'attributes': Array; +} +/** + * + * @export + * @interface BasereferencedtoV1 + */ +export interface BasereferencedtoV1 { + /** + * + * @type {DtotypeV1} + * @memberof BasereferencedtoV1 + */ + 'type'?: DtotypeV1; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof BasereferencedtoV1 + */ + 'name'?: string; +} + + +/** + * + * @export + * @interface ConnectordetailV1 + */ +export interface ConnectordetailV1 { + /** + * The connector name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'name'?: string; + /** + * The connector type + * @type {string} + * @memberof ConnectordetailV1 + */ + 'type'?: string; + /** + * The connector class name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'className'?: string; + /** + * The connector script name + * @type {string} + * @memberof ConnectordetailV1 + */ + 'scriptName'?: string; + /** + * The connector application xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'applicationXml'?: string; + /** + * The connector correlation config xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'correlationConfigXml'?: string; + /** + * The connector source config xml + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfigXml'?: string; + /** + * The connector source config + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfig'?: string | null; + /** + * The connector source config origin + * @type {string} + * @memberof ConnectordetailV1 + */ + 'sourceConfigFrom'?: string | null; + /** + * storage path key for this connector + * @type {string} + * @memberof ConnectordetailV1 + */ + 's3Location'?: string; + /** + * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. + * @type {Array} + * @memberof ConnectordetailV1 + */ + 'uploadedFiles'?: Array | null; + /** + * true if the source is file upload + * @type {boolean} + * @memberof ConnectordetailV1 + */ + 'fileUpload'?: boolean; + /** + * true if the source is a direct connect source + * @type {boolean} + * @memberof ConnectordetailV1 + */ + 'directConnect'?: boolean; + /** + * A map containing translation attributes by loacale key + * @type {{ [key: string]: any; }} + * @memberof ConnectordetailV1 + */ + 'translationProperties'?: { [key: string]: any; }; + /** + * A map containing metadata pertinent to the UI to be used + * @type {{ [key: string]: any; }} + * @memberof ConnectordetailV1 + */ + 'connectorMetadata'?: { [key: string]: any; }; + /** + * The connector status + * @type {string} + * @memberof ConnectordetailV1 + */ + 'status'?: ConnectordetailV1StatusV1; +} + +export const ConnectordetailV1StatusV1 = { + Deprecated: 'DEPRECATED', + Development: 'DEVELOPMENT', + Demo: 'DEMO', + Released: 'RELEASED' +} as const; + +export type ConnectordetailV1StatusV1 = typeof ConnectordetailV1StatusV1[keyof typeof ConnectordetailV1StatusV1]; + +/** + * The attribute assignment of the correlation configuration. + * @export + * @interface CorrelationconfigAttributeAssignmentsInnerV1 + */ +export interface CorrelationconfigAttributeAssignmentsInnerV1 { + /** + * The property of the attribute assignment. + * @type {string} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'property'?: string; + /** + * The value of the attribute assignment. + * @type {string} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'value'?: string; + /** + * The operation of the attribute assignment. + * @type {string} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'operation'?: CorrelationconfigAttributeAssignmentsInnerV1OperationV1; + /** + * Whether or not the it\'s a complex attribute assignment. + * @type {boolean} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'complex'?: boolean; + /** + * Whether or not the attribute assignment should ignore case. + * @type {boolean} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'ignoreCase'?: boolean; + /** + * The match mode of the attribute assignment. + * @type {string} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'matchMode'?: CorrelationconfigAttributeAssignmentsInnerV1MatchModeV1; + /** + * The filter string of the attribute assignment. + * @type {string} + * @memberof CorrelationconfigAttributeAssignmentsInnerV1 + */ + 'filterString'?: string; +} + +export const CorrelationconfigAttributeAssignmentsInnerV1OperationV1 = { + Eq: 'EQ' +} as const; + +export type CorrelationconfigAttributeAssignmentsInnerV1OperationV1 = typeof CorrelationconfigAttributeAssignmentsInnerV1OperationV1[keyof typeof CorrelationconfigAttributeAssignmentsInnerV1OperationV1]; +export const CorrelationconfigAttributeAssignmentsInnerV1MatchModeV1 = { + Anywhere: 'ANYWHERE', + Start: 'START', + End: 'END' +} as const; + +export type CorrelationconfigAttributeAssignmentsInnerV1MatchModeV1 = typeof CorrelationconfigAttributeAssignmentsInnerV1MatchModeV1[keyof typeof CorrelationconfigAttributeAssignmentsInnerV1MatchModeV1]; + +/** + * Source configuration information that is used by correlation process. + * @export + * @interface CorrelationconfigV1 + */ +export interface CorrelationconfigV1 { + /** + * The ID of the correlation configuration. + * @type {string} + * @memberof CorrelationconfigV1 + */ + 'id'?: string | null; + /** + * The name of the correlation configuration. + * @type {string} + * @memberof CorrelationconfigV1 + */ + 'name'?: string | null; + /** + * The list of attribute assignments of the correlation configuration. + * @type {Array} + * @memberof CorrelationconfigV1 + */ + 'attributeAssignments'?: Array | null; +} +/** + * + * @export + * @interface DeleteSourceV1202ResponseV1 + */ +export interface DeleteSourceV1202ResponseV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof DeleteSourceV1202ResponseV1 + */ + 'type'?: DeleteSourceV1202ResponseV1TypeV1; + /** + * Task result ID. + * @type {string} + * @memberof DeleteSourceV1202ResponseV1 + */ + 'id'?: string; + /** + * Task result\'s human-readable display name (this should be null/empty). + * @type {string} + * @memberof DeleteSourceV1202ResponseV1 + */ + 'name'?: string; +} + +export const DeleteSourceV1202ResponseV1TypeV1 = { + TaskResult: 'TASK_RESULT' +} as const; + +export type DeleteSourceV1202ResponseV1TypeV1 = typeof DeleteSourceV1202ResponseV1TypeV1[keyof typeof DeleteSourceV1202ResponseV1TypeV1]; + +/** + * + * @export + * @interface DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 + */ +export interface DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 { + /** + * DTO type + * @type {string} + * @memberof DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 + */ + 'type'?: string; + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 + */ + 'name'?: string; +} +/** + * The Account Source of the connected Application + * @export + * @interface DependantappconnectionsAccountSourceV1 + */ +export interface DependantappconnectionsAccountSourceV1 { + /** + * Use this Account Source for password management + * @type {boolean} + * @memberof DependantappconnectionsAccountSourceV1 + */ + 'useForPasswordManagement'?: boolean; + /** + * A list of Password Policies for this Account Source + * @type {Array} + * @memberof DependantappconnectionsAccountSourceV1 + */ + 'passwordPolicies'?: Array; +} +/** + * + * @export + * @interface DependantappconnectionsV1 + */ +export interface DependantappconnectionsV1 { + /** + * Id of the connected Application + * @type {string} + * @memberof DependantappconnectionsV1 + */ + 'cloudAppId'?: string; + /** + * Description of the connected Application + * @type {string} + * @memberof DependantappconnectionsV1 + */ + 'description'?: string; + /** + * Is the Application enabled + * @type {boolean} + * @memberof DependantappconnectionsV1 + */ + 'enabled'?: boolean; + /** + * Is Provisioning enabled for connected Application + * @type {boolean} + * @memberof DependantappconnectionsV1 + */ + 'provisionRequestEnabled'?: boolean; + /** + * + * @type {DependantappconnectionsAccountSourceV1} + * @memberof DependantappconnectionsV1 + */ + 'accountSource'?: DependantappconnectionsAccountSourceV1; + /** + * The amount of launchers for connected Application (long type) + * @type {number} + * @memberof DependantappconnectionsV1 + */ + 'launcherCount'?: number; + /** + * Is Provisioning enabled for connected Application + * @type {boolean} + * @memberof DependantappconnectionsV1 + */ + 'matchAllAccount'?: boolean; + /** + * The owner of the connected Application + * @type {Array} + * @memberof DependantappconnectionsV1 + */ + 'owner'?: Array; + /** + * Is App Center enabled for connected Application + * @type {boolean} + * @memberof DependantappconnectionsV1 + */ + 'appCenterEnabled'?: boolean; +} +/** + * + * @export + * @interface DependantconnectionsmissingdtoV1 + */ +export interface DependantconnectionsmissingdtoV1 { + /** + * The type of dependency type that is missing in the SourceConnections + * @type {string} + * @memberof DependantconnectionsmissingdtoV1 + */ + 'dependencyType'?: DependantconnectionsmissingdtoV1DependencyTypeV1; + /** + * The reason why this dependency is missing + * @type {string} + * @memberof DependantconnectionsmissingdtoV1 + */ + 'reason'?: string; +} + +export const DependantconnectionsmissingdtoV1DependencyTypeV1 = { + IdentityProfiles: 'identityProfiles', + CredentialProfiles: 'credentialProfiles', + MappingProfiles: 'mappingProfiles', + SourceAttributes: 'sourceAttributes', + DependantCustomTransforms: 'dependantCustomTransforms', + DependantApps: 'dependantApps' +} as const; + +export type DependantconnectionsmissingdtoV1DependencyTypeV1 = typeof DependantconnectionsmissingdtoV1DependencyTypeV1[keyof typeof DependantconnectionsmissingdtoV1DependencyTypeV1]; + +/** + * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + * @export + * @enum {string} + */ + +export const DtotypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', + AccessProfile: 'ACCESS_PROFILE', + AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', + Account: 'ACCOUNT', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + CampaignFilter: 'CAMPAIGN_FILTER', + Certification: 'CERTIFICATION', + Cluster: 'CLUSTER', + ConnectorSchema: 'CONNECTOR_SCHEMA', + Entitlement: 'ENTITLEMENT', + GovernanceGroup: 'GOVERNANCE_GROUP', + Identity: 'IDENTITY', + IdentityProfile: 'IDENTITY_PROFILE', + IdentityRequest: 'IDENTITY_REQUEST', + MachineIdentity: 'MACHINE_IDENTITY', + LifecycleState: 'LIFECYCLE_STATE', + PasswordPolicy: 'PASSWORD_POLICY', + Role: 'ROLE', + Rule: 'RULE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + TagCategory: 'TAG_CATEGORY', + TaskResult: 'TASK_RESULT', + ReportResult: 'REPORT_RESULT', + SodViolation: 'SOD_VIOLATION', + AccountActivity: 'ACCOUNT_ACTIVITY', + Workgroup: 'WORKGROUP' +} as const; + +export type DtotypeV1 = typeof DtotypeV1[keyof typeof DtotypeV1]; + + +/** + * The maximum duration for which the access is permitted. + * @export + * @interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ +export interface EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 { + /** + * The numeric value of the duration. + * @type {number} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'value'?: number; + /** + * The time unit for the duration. + * @type {string} + * @memberof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + */ + 'timeUnit'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1; +} + +export const EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = { + Hours: 'HOURS', + Days: 'DAYS', + Weeks: 'WEEKS', + Months: 'MONTHS' +} as const; + +export type EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1 = typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1[keyof typeof EntitlementaccessrequestconfigMaxPermittedAccessDurationV1TimeUnitV1]; + +/** + * + * @export + * @interface EntitlementaccessrequestconfigV1 + */ +export interface EntitlementaccessrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'approvalSchemes'?: Array; + /** + * If the requester must provide a comment during access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requestCommentRequired'?: boolean; + /** + * If the reviewer must provide a comment when denying the access request. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'denialCommentRequired'?: boolean; + /** + * Is Reauthorization Required + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'reauthorizationRequired'?: boolean; + /** + * If true, then remove date or sunset date is required in access request of the entitlement. + * @type {boolean} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'requireEndDate'?: boolean; + /** + * + * @type {EntitlementaccessrequestconfigMaxPermittedAccessDurationV1} + * @memberof EntitlementaccessrequestconfigV1 + */ + 'maxPermittedAccessDuration'?: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 | null; +} +/** + * + * @export + * @interface EntitlementapprovalschemeV1 + */ +export interface EntitlementapprovalschemeV1 { + /** + * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverType'?: EntitlementapprovalschemeV1ApproverTypeV1; + /** + * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW + * @type {string} + * @memberof EntitlementapprovalschemeV1 + */ + 'approverId'?: string | null; +} + +export const EntitlementapprovalschemeV1ApproverTypeV1 = { + EntitlementOwner: 'ENTITLEMENT_OWNER', + SourceOwner: 'SOURCE_OWNER', + Manager: 'MANAGER', + GovernanceGroup: 'GOVERNANCE_GROUP', + Workflow: 'WORKFLOW' +} as const; + +export type EntitlementapprovalschemeV1ApproverTypeV1 = typeof EntitlementapprovalschemeV1ApproverTypeV1[keyof typeof EntitlementapprovalschemeV1ApproverTypeV1]; + +/** + * + * @export + * @interface EntitlementrevocationrequestconfigV1 + */ +export interface EntitlementrevocationrequestconfigV1 { + /** + * Ordered list of approval steps for the access request. Empty when no approval is required. + * @type {Array} + * @memberof EntitlementrevocationrequestconfigV1 + */ + 'approvalSchemes'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FielddetailsdtoV1 + */ +export interface FielddetailsdtoV1 { + /** + * The name of the attribute. + * @type {string} + * @memberof FielddetailsdtoV1 + */ + 'name'?: string; + /** + * The transform to apply to the field + * @type {object} + * @memberof FielddetailsdtoV1 + */ + 'transform'?: object; + /** + * Attributes required for the transform + * @type {object} + * @memberof FielddetailsdtoV1 + */ + 'attributes'?: object; + /** + * Flag indicating whether or not the attribute is required. + * @type {boolean} + * @memberof FielddetailsdtoV1 + */ + 'isRequired'?: boolean; + /** + * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. + * @type {string} + * @memberof FielddetailsdtoV1 + */ + 'type'?: FielddetailsdtoV1TypeV1; + /** + * Flag indicating whether or not the attribute is multi-valued. + * @type {boolean} + * @memberof FielddetailsdtoV1 + */ + 'isMultiValued'?: boolean; +} + +export const FielddetailsdtoV1TypeV1 = { + String: 'string', + Int: 'int', + Long: 'long', + Date: 'date', + Boolean: 'boolean', + Secret: 'secret' +} as const; + +export type FielddetailsdtoV1TypeV1 = typeof FielddetailsdtoV1TypeV1[keyof typeof FielddetailsdtoV1TypeV1]; + +/** + * + * @export + * @interface IdentityprofilesconnectionsV1 + */ +export interface IdentityprofilesconnectionsV1 { + /** + * ID of the IdentityProfile this reference applies + * @type {string} + * @memberof IdentityprofilesconnectionsV1 + */ + 'id'?: string; + /** + * Human-readable display name of the IdentityProfile to which this reference applies + * @type {string} + * @memberof IdentityprofilesconnectionsV1 + */ + 'name'?: string; + /** + * The Number of Identities managed by this IdentityProfile + * @type {number} + * @memberof IdentityprofilesconnectionsV1 + */ + 'identityCount'?: number; +} +/** + * + * @export + * @interface ImportAccountsSchemaV1RequestV1 + */ +export interface ImportAccountsSchemaV1RequestV1 { + /** + * + * @type {File} + * @memberof ImportAccountsSchemaV1RequestV1 + */ + 'file'?: File; +} +/** + * + * @export + * @interface ImportAccountsV1RequestV1 + */ +export interface ImportAccountsV1RequestV1 { + /** + * The CSV file containing the source accounts to aggregate. + * @type {File} + * @memberof ImportAccountsV1RequestV1 + */ + 'file'?: File; + /** + * Use this flag to reprocess every account whether or not the data has changed. + * @type {string} + * @memberof ImportAccountsV1RequestV1 + */ + 'disableOptimization'?: string; +} +/** + * + * @export + * @interface ImportEntitlementsV1RequestV1 + */ +export interface ImportEntitlementsV1RequestV1 { + /** + * The CSV file containing the source entitlements to aggregate. + * @type {File} + * @memberof ImportEntitlementsV1RequestV1 + */ + 'file'?: File; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListSourcesV1401ResponseV1 + */ +export interface ListSourcesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSourcesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListSourcesV1429ResponseV1 + */ +export interface ListSourcesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListSourcesV1429ResponseV1 + */ + 'message'?: any; +} +/** + * Extra attributes map(dictionary) for the task. + * @export + * @interface LoadaccountstaskTaskAttributesV1 + */ +export interface LoadaccountstaskTaskAttributesV1 { + [key: string]: object | any; + + /** + * The id of the source + * @type {string} + * @memberof LoadaccountstaskTaskAttributesV1 + */ + 'appId'?: string; + /** + * The indicator if the aggregation process was enabled/disabled for the aggregation job + * @type {string} + * @memberof LoadaccountstaskTaskAttributesV1 + */ + 'optimizedAggregation'?: string; +} +/** + * + * @export + * @interface LoadaccountstaskTaskMessagesInnerV1 + */ +export interface LoadaccountstaskTaskMessagesInnerV1 { + /** + * Type of the message. + * @type {string} + * @memberof LoadaccountstaskTaskMessagesInnerV1 + */ + 'type'?: LoadaccountstaskTaskMessagesInnerV1TypeV1; + /** + * Flag whether message is an error. + * @type {boolean} + * @memberof LoadaccountstaskTaskMessagesInnerV1 + */ + 'error'?: boolean; + /** + * Flag whether message is a warning. + * @type {boolean} + * @memberof LoadaccountstaskTaskMessagesInnerV1 + */ + 'warning'?: boolean; + /** + * Message string identifier. + * @type {string} + * @memberof LoadaccountstaskTaskMessagesInnerV1 + */ + 'key'?: string; + /** + * Message context with the locale based language. + * @type {string} + * @memberof LoadaccountstaskTaskMessagesInnerV1 + */ + 'localizedText'?: string; +} + +export const LoadaccountstaskTaskMessagesInnerV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type LoadaccountstaskTaskMessagesInnerV1TypeV1 = typeof LoadaccountstaskTaskMessagesInnerV1TypeV1[keyof typeof LoadaccountstaskTaskMessagesInnerV1TypeV1]; + +/** + * + * @export + * @interface LoadaccountstaskTaskReturnsInnerV1 + */ +export interface LoadaccountstaskTaskReturnsInnerV1 { + /** + * The display label of the return value + * @type {string} + * @memberof LoadaccountstaskTaskReturnsInnerV1 + */ + 'displayLabel'?: string; + /** + * The attribute name of the return value + * @type {string} + * @memberof LoadaccountstaskTaskReturnsInnerV1 + */ + 'attributeName'?: string; +} +/** + * + * @export + * @interface LoadaccountstaskTaskV1 + */ +export interface LoadaccountstaskTaskV1 { + /** + * System-generated unique ID of the task this taskStatus represents + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'id'?: string; + /** + * Type of task this task represents + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'type'?: string; + /** + * The name of the aggregation process + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'name'?: string; + /** + * The description of the task + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'description'?: string; + /** + * The user who initiated the task + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'launcher'?: string; + /** + * The Task creation date + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'created'?: string; + /** + * The task start date + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'launched'?: string | null; + /** + * The task completion date + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'completed'?: string | null; + /** + * Task completion status. + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'completionStatus'?: LoadaccountstaskTaskV1CompletionStatusV1 | null; + /** + * Name of the parent task if exists. + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'parentName'?: string | null; + /** + * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. + * @type {Array} + * @memberof LoadaccountstaskTaskV1 + */ + 'messages'?: Array; + /** + * Current task state. + * @type {string} + * @memberof LoadaccountstaskTaskV1 + */ + 'progress'?: string | null; + /** + * + * @type {LoadaccountstaskTaskAttributesV1} + * @memberof LoadaccountstaskTaskV1 + */ + 'attributes'?: LoadaccountstaskTaskAttributesV1; + /** + * Return values from the task + * @type {Array} + * @memberof LoadaccountstaskTaskV1 + */ + 'returns'?: Array; +} + +export const LoadaccountstaskTaskV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR' +} as const; + +export type LoadaccountstaskTaskV1CompletionStatusV1 = typeof LoadaccountstaskTaskV1CompletionStatusV1[keyof typeof LoadaccountstaskTaskV1CompletionStatusV1]; + +/** + * + * @export + * @interface LoadaccountstaskV1 + */ +export interface LoadaccountstaskV1 { + /** + * The status of the result + * @type {boolean} + * @memberof LoadaccountstaskV1 + */ + 'success'?: boolean; + /** + * + * @type {LoadaccountstaskTaskV1} + * @memberof LoadaccountstaskV1 + */ + 'task'?: LoadaccountstaskTaskV1; +} +/** + * + * @export + * @interface LoadentitlementtaskReturnsInnerV1 + */ +export interface LoadentitlementtaskReturnsInnerV1 { + /** + * The display label for the return value + * @type {string} + * @memberof LoadentitlementtaskReturnsInnerV1 + */ + 'displayLabel'?: string; + /** + * The attribute name for the return value + * @type {string} + * @memberof LoadentitlementtaskReturnsInnerV1 + */ + 'attributeName'?: string; +} +/** + * + * @export + * @interface LoadentitlementtaskV1 + */ +export interface LoadentitlementtaskV1 { + /** + * System-generated unique ID of the task this taskStatus represents + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'id'?: string; + /** + * Type of task this task represents + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'type'?: string; + /** + * The name of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'uniqueName'?: string; + /** + * The description of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'description'?: string; + /** + * The user who initiated the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'launcher'?: string; + /** + * The creation date of the task + * @type {string} + * @memberof LoadentitlementtaskV1 + */ + 'created'?: string; + /** + * Return values from the task + * @type {Array} + * @memberof LoadentitlementtaskV1 + */ + 'returns'?: Array; +} +/** + * Extra attributes map(dictionary) for the task. + * @export + * @interface LoaduncorrelatedaccountstaskTaskAttributesV1 + */ +export interface LoaduncorrelatedaccountstaskTaskAttributesV1 { + /** + * The id of qpoc job + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskAttributesV1 + */ + 'qpocJobId'?: string; + /** + * the task start delay value + * @type {any} + * @memberof LoaduncorrelatedaccountstaskTaskAttributesV1 + */ + 'taskStartDelay'?: any; +} +/** + * + * @export + * @interface LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ +export interface LoaduncorrelatedaccountstaskTaskMessagesInnerV1 { + /** + * Type of the message. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ + 'type'?: LoaduncorrelatedaccountstaskTaskMessagesInnerV1TypeV1; + /** + * Flag whether message is an error. + * @type {boolean} + * @memberof LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ + 'error'?: boolean; + /** + * Flag whether message is a warning. + * @type {boolean} + * @memberof LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ + 'warning'?: boolean; + /** + * Message string identifier. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ + 'key'?: string; + /** + * Message context with the locale based language. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + */ + 'localizedText'?: string; +} + +export const LoaduncorrelatedaccountstaskTaskMessagesInnerV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type LoaduncorrelatedaccountstaskTaskMessagesInnerV1TypeV1 = typeof LoaduncorrelatedaccountstaskTaskMessagesInnerV1TypeV1[keyof typeof LoaduncorrelatedaccountstaskTaskMessagesInnerV1TypeV1]; + +/** + * + * @export + * @interface LoaduncorrelatedaccountstaskTaskV1 + */ +export interface LoaduncorrelatedaccountstaskTaskV1 { + /** + * System-generated unique ID of the task this taskStatus represents + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'id'?: string; + /** + * Type of task this task represents + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'type'?: string; + /** + * The name of uncorrelated accounts process + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'name'?: string; + /** + * The description of the task + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'description'?: string; + /** + * The user who initiated the task + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'launcher'?: string; + /** + * The Task creation date + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'created'?: string; + /** + * The task start date + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'launched'?: string | null; + /** + * The task completion date + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'completed'?: string | null; + /** + * Task completion status. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'completionStatus'?: LoaduncorrelatedaccountstaskTaskV1CompletionStatusV1 | null; + /** + * Name of the parent task if exists. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'parentName'?: string | null; + /** + * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. + * @type {Array} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'messages'?: Array; + /** + * Current task state. + * @type {string} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'progress'?: string | null; + /** + * + * @type {LoaduncorrelatedaccountstaskTaskAttributesV1} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'attributes'?: LoaduncorrelatedaccountstaskTaskAttributesV1; + /** + * Return values from the task + * @type {object} + * @memberof LoaduncorrelatedaccountstaskTaskV1 + */ + 'returns'?: object; +} + +export const LoaduncorrelatedaccountstaskTaskV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + TempError: 'TEMP_ERROR' +} as const; + +export type LoaduncorrelatedaccountstaskTaskV1CompletionStatusV1 = typeof LoaduncorrelatedaccountstaskTaskV1CompletionStatusV1[keyof typeof LoaduncorrelatedaccountstaskTaskV1CompletionStatusV1]; + +/** + * + * @export + * @interface LoaduncorrelatedaccountstaskV1 + */ +export interface LoaduncorrelatedaccountstaskV1 { + /** + * The status of the result + * @type {boolean} + * @memberof LoaduncorrelatedaccountstaskV1 + */ + 'success'?: boolean; + /** + * + * @type {LoaduncorrelatedaccountstaskTaskV1} + * @memberof LoaduncorrelatedaccountstaskV1 + */ + 'task'?: LoaduncorrelatedaccountstaskTaskV1; +} +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ManagercorrelationmappingV1 + */ +export interface ManagercorrelationmappingV1 { + /** + * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. + * @type {string} + * @memberof ManagercorrelationmappingV1 + */ + 'accountAttributeName'?: string; + /** + * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + * @type {string} + * @memberof ManagercorrelationmappingV1 + */ + 'identityAttributeName'?: string; +} +/** + * Source configuration information for Native Change Detection that is read and used by account aggregation process. + * @export + * @interface NativechangedetectionconfigV1 + */ +export interface NativechangedetectionconfigV1 { + /** + * A flag indicating if Native Change Detection is enabled for a source. + * @type {boolean} + * @memberof NativechangedetectionconfigV1 + */ + 'enabled'?: boolean; + /** + * Operation types for which Native Change Detection is enabled for a source. + * @type {Array} + * @memberof NativechangedetectionconfigV1 + */ + 'operations'?: Array; + /** + * A flag indicating that all entitlements participate in Native Change Detection. + * @type {boolean} + * @memberof NativechangedetectionconfigV1 + */ + 'allEntitlements'?: boolean; + /** + * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. + * @type {boolean} + * @memberof NativechangedetectionconfigV1 + */ + 'allNonEntitlementAttributes'?: boolean; + /** + * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. + * @type {Array} + * @memberof NativechangedetectionconfigV1 + */ + 'selectedEntitlements'?: Array; + /** + * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. + * @type {Array} + * @memberof NativechangedetectionconfigV1 + */ + 'selectedNonEntitlementAttributes'?: Array; +} + +export const NativechangedetectionconfigV1OperationsV1 = { + AccountUpdated: 'ACCOUNT_UPDATED', + AccountCreated: 'ACCOUNT_CREATED', + AccountDeleted: 'ACCOUNT_DELETED' +} as const; + +export type NativechangedetectionconfigV1OperationsV1 = typeof NativechangedetectionconfigV1OperationsV1[keyof typeof NativechangedetectionconfigV1OperationsV1]; + +/** + * + * @export + * @interface PasswordpolicyholdersdtoInnerV1 + */ +export interface PasswordpolicyholdersdtoInnerV1 { + /** + * The password policy Id. + * @type {string} + * @memberof PasswordpolicyholdersdtoInnerV1 + */ + 'policyId'?: string; + /** + * The name of the password policy. + * @type {string} + * @memberof PasswordpolicyholdersdtoInnerV1 + */ + 'policyName'?: string; + /** + * + * @type {PasswordpolicyholdersdtoattributesV1} + * @memberof PasswordpolicyholdersdtoInnerV1 + */ + 'selectors'?: PasswordpolicyholdersdtoattributesV1; +} +/** + * + * @export + * @interface PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 + */ +export interface PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 { + /** + * Attribute\'s name + * @type {string} + * @memberof PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 + */ + 'name'?: string; + /** + * Attribute\'s value + * @type {string} + * @memberof PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface PasswordpolicyholdersdtoattributesV1 + */ +export interface PasswordpolicyholdersdtoattributesV1 { + /** + * Attributes of PasswordPolicyHoldersDto + * @type {Array} + * @memberof PasswordpolicyholdersdtoattributesV1 + */ + 'identityAttr'?: Array; +} +/** + * + * @export + * @interface ProvisioningpolicydtoV1 + */ +export interface ProvisioningpolicydtoV1 { + /** + * the provisioning policy name + * @type {string} + * @memberof ProvisioningpolicydtoV1 + */ + 'name': string | null; + /** + * the description of the provisioning policy + * @type {string} + * @memberof ProvisioningpolicydtoV1 + */ + 'description'?: string; + /** + * + * @type {UsagetypeV1} + * @memberof ProvisioningpolicydtoV1 + */ + 'usageType'?: UsagetypeV1; + /** + * + * @type {Array} + * @memberof ProvisioningpolicydtoV1 + */ + 'fields'?: Array; +} + + +/** + * Representation of the object which is returned from source connectors. + * @export + * @interface ResourceobjectV1 + */ +export interface ResourceobjectV1 { + /** + * Identifier of the specific instance where this object resides. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'instance'?: string; + /** + * Native identity of the object in the Source. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'identity'?: string; + /** + * Universal unique identifier of the object in the Source. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'uuid'?: string; + /** + * Native identity that the object has previously. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'previousIdentity'?: string; + /** + * Display name for this object. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'name'?: string; + /** + * Type of object. + * @type {string} + * @memberof ResourceobjectV1 + */ + 'objectType'?: string; + /** + * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. + * @type {boolean} + * @memberof ResourceobjectV1 + */ + 'incomplete'?: boolean; + /** + * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. + * @type {boolean} + * @memberof ResourceobjectV1 + */ + 'incremental'?: boolean; + /** + * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. + * @type {boolean} + * @memberof ResourceobjectV1 + */ + 'delete'?: boolean; + /** + * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. + * @type {boolean} + * @memberof ResourceobjectV1 + */ + 'remove'?: boolean; + /** + * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". + * @type {Array} + * @memberof ResourceobjectV1 + */ + 'missing'?: Array; + /** + * Attributes of this ResourceObject. + * @type {object} + * @memberof ResourceobjectV1 + */ + 'attributes'?: object; + /** + * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. + * @type {boolean} + * @memberof ResourceobjectV1 + */ + 'finalUpdate'?: boolean; +} +/** + * Request model for peek resource objects from source connectors. + * @export + * @interface ResourceobjectsrequestV1 + */ +export interface ResourceobjectsrequestV1 { + /** + * The type of resource objects to iterate over. + * @type {string} + * @memberof ResourceobjectsrequestV1 + */ + 'objectType'?: string; + /** + * The maximum number of resource objects to iterate over and return. + * @type {number} + * @memberof ResourceobjectsrequestV1 + */ + 'maxCount'?: number; +} +/** + * Response model for peek resource objects from source connectors. + * @export + * @interface ResourceobjectsresponseV1 + */ +export interface ResourceobjectsresponseV1 { + /** + * ID of the source + * @type {string} + * @memberof ResourceobjectsresponseV1 + */ + 'id'?: string; + /** + * Name of the source + * @type {string} + * @memberof ResourceobjectsresponseV1 + */ + 'name'?: string; + /** + * The number of objects that were fetched by the connector. + * @type {number} + * @memberof ResourceobjectsresponseV1 + */ + 'objectCount'?: number; + /** + * The number of milliseconds spent on the entire request. + * @type {number} + * @memberof ResourceobjectsresponseV1 + */ + 'elapsedMillis'?: number; + /** + * Fetched objects from the source connector. + * @type {Array} + * @memberof ResourceobjectsresponseV1 + */ + 'resourceObjects'?: Array; +} +/** + * + * @export + * @interface Schedule3V1 + */ +export interface Schedule3V1 { + /** + * The type of the Schedule. + * @type {string} + * @memberof Schedule3V1 + */ + 'type': Schedule3V1TypeV1; + /** + * The cron expression of the schedule. + * @type {string} + * @memberof Schedule3V1 + */ + 'cronExpression': string; +} + +export const Schedule3V1TypeV1 = { + AccountAggregation: 'ACCOUNT_AGGREGATION', + GroupAggregation: 'GROUP_AGGREGATION' +} as const; + +export type Schedule3V1TypeV1 = typeof Schedule3V1TypeV1[keyof typeof Schedule3V1TypeV1]; + +/** + * + * @export + * @interface SchemaV1 + */ +export interface SchemaV1 { + /** + * The id of the Schema. + * @type {string} + * @memberof SchemaV1 + */ + 'id'?: string; + /** + * The name of the Schema. + * @type {string} + * @memberof SchemaV1 + */ + 'name'?: string; + /** + * The name of the object type on the native system that the schema represents. + * @type {string} + * @memberof SchemaV1 + */ + 'nativeObjectType'?: string; + /** + * The name of the attribute used to calculate the unique identifier for an object in the schema. + * @type {string} + * @memberof SchemaV1 + */ + 'identityAttribute'?: string; + /** + * The name of the attribute used to calculate the display value for an object in the schema. + * @type {string} + * @memberof SchemaV1 + */ + 'displayAttribute'?: string; + /** + * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. + * @type {string} + * @memberof SchemaV1 + */ + 'hierarchyAttribute'?: string | null; + /** + * Flag indicating whether or not the include permissions with the object data when aggregating the schema. + * @type {boolean} + * @memberof SchemaV1 + */ + 'includePermissions'?: boolean; + /** + * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM + * @type {Array} + * @memberof SchemaV1 + */ + 'features'?: Array; + /** + * Holds any extra configuration data that the schema may require. + * @type {object} + * @memberof SchemaV1 + */ + 'configuration'?: object; + /** + * The attribute definitions which form the schema. + * @type {Array} + * @memberof SchemaV1 + */ + 'attributes'?: Array; + /** + * The date the Schema was created. + * @type {string} + * @memberof SchemaV1 + */ + 'created'?: string; + /** + * The date the Schema was last modified. + * @type {string} + * @memberof SchemaV1 + */ + 'modified'?: string | null; +} + +export const SchemaV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', + PreferUuid: 'PREFER_UUID', + ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', + ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', + ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', + UsesUuid: 'USES_UUID', + ApplicationDiscovery: 'APPLICATION_DISCOVERY', + Delete: 'DELETE' +} as const; + +export type SchemaV1FeaturesV1 = typeof SchemaV1FeaturesV1[keyof typeof SchemaV1FeaturesV1]; + +/** + * Reference to account correlation config object. + * @export + * @interface SourceAccountCorrelationConfigV1 + */ +export interface SourceAccountCorrelationConfigV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceAccountCorrelationConfigV1 + */ + 'type'?: SourceAccountCorrelationConfigV1TypeV1; + /** + * Account correlation config ID. + * @type {string} + * @memberof SourceAccountCorrelationConfigV1 + */ + 'id'?: string; + /** + * Account correlation config\'s human-readable display name. + * @type {string} + * @memberof SourceAccountCorrelationConfigV1 + */ + 'name'?: string; +} + +export const SourceAccountCorrelationConfigV1TypeV1 = { + AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' +} as const; + +export type SourceAccountCorrelationConfigV1TypeV1 = typeof SourceAccountCorrelationConfigV1TypeV1[keyof typeof SourceAccountCorrelationConfigV1TypeV1]; + +/** + * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. + * @export + * @interface SourceAccountCorrelationRuleV1 + */ +export interface SourceAccountCorrelationRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceAccountCorrelationRuleV1 + */ + 'type'?: SourceAccountCorrelationRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof SourceAccountCorrelationRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof SourceAccountCorrelationRuleV1 + */ + 'name'?: string; +} + +export const SourceAccountCorrelationRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type SourceAccountCorrelationRuleV1TypeV1 = typeof SourceAccountCorrelationRuleV1TypeV1[keyof typeof SourceAccountCorrelationRuleV1TypeV1]; + +/** + * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. + * @export + * @interface SourceBeforeProvisioningRuleV1 + */ +export interface SourceBeforeProvisioningRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceBeforeProvisioningRuleV1 + */ + 'type'?: SourceBeforeProvisioningRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof SourceBeforeProvisioningRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof SourceBeforeProvisioningRuleV1 + */ + 'name'?: string; +} + +export const SourceBeforeProvisioningRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type SourceBeforeProvisioningRuleV1TypeV1 = typeof SourceBeforeProvisioningRuleV1TypeV1[keyof typeof SourceBeforeProvisioningRuleV1TypeV1]; + +/** + * Reference to the source\'s associated cluster. + * @export + * @interface SourceClusterV1 + */ +export interface SourceClusterV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceClusterV1 + */ + 'type': SourceClusterV1TypeV1; + /** + * Cluster ID. + * @type {string} + * @memberof SourceClusterV1 + */ + 'id': string; + /** + * Cluster\'s human-readable display name. + * @type {string} + * @memberof SourceClusterV1 + */ + 'name': string; +} + +export const SourceClusterV1TypeV1 = { + Cluster: 'CLUSTER' +} as const; + +export type SourceClusterV1TypeV1 = typeof SourceClusterV1TypeV1[keyof typeof SourceClusterV1TypeV1]; + +/** + * Reference to management workgroup for the source. + * @export + * @interface SourceManagementWorkgroupV1 + */ +export interface SourceManagementWorkgroupV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceManagementWorkgroupV1 + */ + 'type'?: SourceManagementWorkgroupV1TypeV1; + /** + * Management workgroup ID. + * @type {string} + * @memberof SourceManagementWorkgroupV1 + */ + 'id'?: string; + /** + * Management workgroup\'s human-readable display name. + * @type {string} + * @memberof SourceManagementWorkgroupV1 + */ + 'name'?: string; +} + +export const SourceManagementWorkgroupV1TypeV1 = { + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type SourceManagementWorkgroupV1TypeV1 = typeof SourceManagementWorkgroupV1TypeV1[keyof typeof SourceManagementWorkgroupV1TypeV1]; + +/** + * + * @export + * @interface SourceManagerCorrelationMappingV1 + */ +export interface SourceManagerCorrelationMappingV1 { + /** + * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. + * @type {string} + * @memberof SourceManagerCorrelationMappingV1 + */ + 'accountAttributeName'?: string; + /** + * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. + * @type {string} + * @memberof SourceManagerCorrelationMappingV1 + */ + 'identityAttributeName'?: string; +} +/** + * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. + * @export + * @interface SourceManagerCorrelationRuleV1 + */ +export interface SourceManagerCorrelationRuleV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceManagerCorrelationRuleV1 + */ + 'type'?: SourceManagerCorrelationRuleV1TypeV1; + /** + * Rule ID. + * @type {string} + * @memberof SourceManagerCorrelationRuleV1 + */ + 'id'?: string; + /** + * Rule\'s human-readable display name. + * @type {string} + * @memberof SourceManagerCorrelationRuleV1 + */ + 'name'?: string; +} + +export const SourceManagerCorrelationRuleV1TypeV1 = { + Rule: 'RULE' +} as const; + +export type SourceManagerCorrelationRuleV1TypeV1 = typeof SourceManagerCorrelationRuleV1TypeV1[keyof typeof SourceManagerCorrelationRuleV1TypeV1]; + +/** + * Reference to identity object who owns the source. + * @export + * @interface SourceOwnerV1 + */ +export interface SourceOwnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceOwnerV1 + */ + 'type'?: SourceOwnerV1TypeV1; + /** + * Owner identity\'s ID. + * @type {string} + * @memberof SourceOwnerV1 + */ + 'id'?: string; + /** + * Owner identity\'s human-readable display name. + * @type {string} + * @memberof SourceOwnerV1 + */ + 'name'?: string; +} + +export const SourceOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SourceOwnerV1TypeV1 = typeof SourceOwnerV1TypeV1[keyof typeof SourceOwnerV1TypeV1]; + +/** + * + * @export + * @interface SourcePasswordPoliciesInnerV1 + */ +export interface SourcePasswordPoliciesInnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourcePasswordPoliciesInnerV1 + */ + 'type'?: SourcePasswordPoliciesInnerV1TypeV1; + /** + * Policy ID. + * @type {string} + * @memberof SourcePasswordPoliciesInnerV1 + */ + 'id'?: string; + /** + * Policy\'s human-readable display name. + * @type {string} + * @memberof SourcePasswordPoliciesInnerV1 + */ + 'name'?: string; +} + +export const SourcePasswordPoliciesInnerV1TypeV1 = { + PasswordPolicy: 'PASSWORD_POLICY' +} as const; + +export type SourcePasswordPoliciesInnerV1TypeV1 = typeof SourcePasswordPoliciesInnerV1TypeV1[keyof typeof SourcePasswordPoliciesInnerV1TypeV1]; + +/** + * + * @export + * @interface SourceSchemasInnerV1 + */ +export interface SourceSchemasInnerV1 { + /** + * Type of object being referenced. + * @type {string} + * @memberof SourceSchemasInnerV1 + */ + 'type'?: SourceSchemasInnerV1TypeV1; + /** + * Schema ID. + * @type {string} + * @memberof SourceSchemasInnerV1 + */ + 'id'?: string; + /** + * Schema\'s human-readable display name. + * @type {string} + * @memberof SourceSchemasInnerV1 + */ + 'name'?: string; +} + +export const SourceSchemasInnerV1TypeV1 = { + ConnectorSchema: 'CONNECTOR_SCHEMA' +} as const; + +export type SourceSchemasInnerV1TypeV1 = typeof SourceSchemasInnerV1TypeV1[keyof typeof SourceSchemasInnerV1TypeV1]; + +/** + * + * @export + * @interface SourceV1 + */ +export interface SourceV1 { + /** + * Source ID. + * @type {string} + * @memberof SourceV1 + */ + 'id'?: string; + /** + * Source\'s human-readable name. + * @type {string} + * @memberof SourceV1 + */ + 'name': string; + /** + * Source\'s human-readable description. + * @type {string} + * @memberof SourceV1 + */ + 'description'?: string; + /** + * + * @type {SourceOwnerV1} + * @memberof SourceV1 + */ + 'owner': SourceOwnerV1 | null; + /** + * + * @type {SourceClusterV1} + * @memberof SourceV1 + */ + 'cluster'?: SourceClusterV1 | null; + /** + * + * @type {SourceAccountCorrelationConfigV1} + * @memberof SourceV1 + */ + 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV1 | null; + /** + * + * @type {SourceAccountCorrelationRuleV1} + * @memberof SourceV1 + */ + 'accountCorrelationRule'?: SourceAccountCorrelationRuleV1 | null; + /** + * + * @type {SourceManagerCorrelationMappingV1} + * @memberof SourceV1 + */ + 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV1; + /** + * + * @type {SourceManagerCorrelationRuleV1} + * @memberof SourceV1 + */ + 'managerCorrelationRule'?: SourceManagerCorrelationRuleV1 | null; + /** + * + * @type {SourceBeforeProvisioningRuleV1} + * @memberof SourceV1 + */ + 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV1 | null; + /** + * List of references to schema objects. + * @type {Array} + * @memberof SourceV1 + */ + 'schemas'?: Array; + /** + * List of references to the associated PasswordPolicy objects. + * @type {Array} + * @memberof SourceV1 + */ + 'passwordPolicies'?: Array | null; + /** + * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM + * @type {Array} + * @memberof SourceV1 + */ + 'features'?: Array; + /** + * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. + * @type {string} + * @memberof SourceV1 + */ + 'type'?: string; + /** + * Connector script name. + * @type {string} + * @memberof SourceV1 + */ + 'connector': string; + /** + * Fully qualified name of the Java class that implements the connector interface. + * @type {string} + * @memberof SourceV1 + */ + 'connectorClass'?: string; + /** + * Connector specific configuration. This configuration will differ from type to type. + * @type {object} + * @memberof SourceV1 + */ + 'connectorAttributes'?: object; + /** + * Number from 0 to 100 that specifies when to skip the delete phase. + * @type {number} + * @memberof SourceV1 + */ + 'deleteThreshold'?: number; + /** + * When this is true, it indicates that the source is referenced by an identity profile. + * @type {boolean} + * @memberof SourceV1 + */ + 'authoritative'?: boolean; + /** + * + * @type {SourceManagementWorkgroupV1} + * @memberof SourceV1 + */ + 'managementWorkgroup'?: SourceManagementWorkgroupV1 | null; + /** + * When this is true, it indicates that the source is healthy. + * @type {boolean} + * @memberof SourceV1 + */ + 'healthy'?: boolean; + /** + * Status identifier that gives specific information about why a source is or isn\'t healthy. + * @type {string} + * @memberof SourceV1 + */ + 'status'?: SourceV1StatusV1; + /** + * Timestamp that shows when a source health check was last performed. + * @type {string} + * @memberof SourceV1 + */ + 'since'?: string; + /** + * Connector ID + * @type {string} + * @memberof SourceV1 + */ + 'connectorId'?: string; + /** + * Name of the connector that was chosen during source creation. + * @type {string} + * @memberof SourceV1 + */ + 'connectorName'?: string; + /** + * Type of connection (direct or file). + * @type {string} + * @memberof SourceV1 + */ + 'connectionType'?: string; + /** + * Connector implementation ID. + * @type {string} + * @memberof SourceV1 + */ + 'connectorImplementationId'?: string; + /** + * Date-time when the source was created + * @type {string} + * @memberof SourceV1 + */ + 'created'?: string; + /** + * Date-time when the source was last modified. + * @type {string} + * @memberof SourceV1 + */ + 'modified'?: string; + /** + * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. + * @type {boolean} + * @memberof SourceV1 + */ + 'credentialProviderEnabled'?: boolean; + /** + * Source category (e.g. null, CredentialProvider). + * @type {string} + * @memberof SourceV1 + */ + 'category'?: string | null; +} + +export const SourceV1FeaturesV1 = { + Authenticate: 'AUTHENTICATE', + Composite: 'COMPOSITE', + DirectPermissions: 'DIRECT_PERMISSIONS', + DiscoverSchema: 'DISCOVER_SCHEMA', + Enable: 'ENABLE', + ManagerLookup: 'MANAGER_LOOKUP', + NoRandomAccess: 'NO_RANDOM_ACCESS', + Proxy: 'PROXY', + Search: 'SEARCH', + Template: 'TEMPLATE', + Unlock: 'UNLOCK', + UnstructuredTargets: 'UNSTRUCTURED_TARGETS', + SharepointTarget: 'SHAREPOINT_TARGET', + Provisioning: 'PROVISIONING', + GroupProvisioning: 'GROUP_PROVISIONING', + SyncProvisioning: 'SYNC_PROVISIONING', + Password: 'PASSWORD', + CurrentPassword: 'CURRENT_PASSWORD', + AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', + AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', + NoAggregation: 'NO_AGGREGATION', + GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', + NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', + NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', + NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', + NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', + PreferUuid: 'PREFER_UUID', + ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', + ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', + ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', + UsesUuid: 'USES_UUID', + ApplicationDiscovery: 'APPLICATION_DISCOVERY', + Delete: 'DELETE' +} as const; + +export type SourceV1FeaturesV1 = typeof SourceV1FeaturesV1[keyof typeof SourceV1FeaturesV1]; +export const SourceV1StatusV1 = { + SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', + SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', + SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', + SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', + SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', + SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', + SourceStateHealthy: 'SOURCE_STATE_HEALTHY', + SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', + SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', + SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', + SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' +} as const; + +export type SourceV1StatusV1 = typeof SourceV1StatusV1[keyof typeof SourceV1StatusV1]; + +/** + * + * @export + * @interface SourceconnectionsdtoV1 + */ +export interface SourceconnectionsdtoV1 { + /** + * The IdentityProfile attached to this source + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'identityProfiles'?: Array; + /** + * Name of the CredentialProfile attached to this source + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'credentialProfiles'?: Array; + /** + * The attributes attached to this source + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'sourceAttributes'?: Array; + /** + * The profiles attached to this source + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'mappingProfiles'?: Array; + /** + * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'dependentCustomTransforms'?: Array; + /** + * + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'dependentApps'?: Array; + /** + * + * @type {Array} + * @memberof SourceconnectionsdtoV1 + */ + 'missingDependents'?: Array; +} +/** + * Entitlement Request Configuration + * @export + * @interface SourceentitlementrequestconfigV1 + */ +export interface SourceentitlementrequestconfigV1 { + /** + * + * @type {EntitlementaccessrequestconfigV1} + * @memberof SourceentitlementrequestconfigV1 + */ + 'accessRequestConfig'?: EntitlementaccessrequestconfigV1; + /** + * + * @type {EntitlementrevocationrequestconfigV1} + * @memberof SourceentitlementrequestconfigV1 + */ + 'revocationRequestConfig'?: EntitlementrevocationrequestconfigV1; +} +/** + * Dto for source health data + * @export + * @interface SourcehealthdtoV1 + */ +export interface SourcehealthdtoV1 { + /** + * the id of the Source + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'id'?: string; + /** + * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'type'?: string; + /** + * the name of the source + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'name'?: string; + /** + * source\'s org + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'org'?: string; + /** + * Is the source authoritative + * @type {boolean} + * @memberof SourcehealthdtoV1 + */ + 'isAuthoritative'?: boolean; + /** + * Is the source in a cluster + * @type {boolean} + * @memberof SourcehealthdtoV1 + */ + 'isCluster'?: boolean; + /** + * source\'s hostname + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'hostname'?: string; + /** + * source\'s pod + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'pod'?: string; + /** + * The version of the iqService + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'iqServiceVersion'?: string | null; + /** + * connection test result + * @type {string} + * @memberof SourcehealthdtoV1 + */ + 'status'?: SourcehealthdtoV1StatusV1; +} + +export const SourcehealthdtoV1StatusV1 = { + SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', + SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', + SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', + SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', + SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', + SourceStateHealthy: 'SOURCE_STATE_HEALTHY', + SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', + SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', + SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', + SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', + SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' +} as const; + +export type SourcehealthdtoV1StatusV1 = typeof SourcehealthdtoV1StatusV1[keyof typeof SourcehealthdtoV1StatusV1]; + +/** + * + * @export + * @interface SourcesyncjobV1 + */ +export interface SourcesyncjobV1 { + /** + * Job ID. + * @type {string} + * @memberof SourcesyncjobV1 + */ + 'id': string; + /** + * The job status. + * @type {string} + * @memberof SourcesyncjobV1 + */ + 'status': SourcesyncjobV1StatusV1; + /** + * + * @type {SourcesyncpayloadV1} + * @memberof SourcesyncjobV1 + */ + 'payload': SourcesyncpayloadV1; +} + +export const SourcesyncjobV1StatusV1 = { + Queued: 'QUEUED', + InProgress: 'IN_PROGRESS', + Success: 'SUCCESS', + Error: 'ERROR' +} as const; + +export type SourcesyncjobV1StatusV1 = typeof SourcesyncjobV1StatusV1[keyof typeof SourcesyncjobV1StatusV1]; + +/** + * + * @export + * @interface SourcesyncpayloadV1 + */ +export interface SourcesyncpayloadV1 { + /** + * Payload type. + * @type {string} + * @memberof SourcesyncpayloadV1 + */ + 'type': string; + /** + * Payload type. + * @type {string} + * @memberof SourcesyncpayloadV1 + */ + 'dataJson': string; +} +/** + * Response model for connection check, configuration test and ping of source connectors. + * @export + * @interface StatusresponseV1 + */ +export interface StatusresponseV1 { + /** + * ID of the source + * @type {string} + * @memberof StatusresponseV1 + */ + 'id'?: string; + /** + * Name of the source + * @type {string} + * @memberof StatusresponseV1 + */ + 'name'?: string; + /** + * The status of the health check. + * @type {string} + * @memberof StatusresponseV1 + */ + 'status'?: StatusresponseV1StatusV1; + /** + * The number of milliseconds spent on the entire request. + * @type {number} + * @memberof StatusresponseV1 + */ + 'elapsedMillis'?: number; + /** + * The document contains the results of the health check. The schema of this document depends on the type of source used. + * @type {object} + * @memberof StatusresponseV1 + */ + 'details'?: object; +} + +export const StatusresponseV1StatusV1 = { + Success: 'SUCCESS', + Failure: 'FAILURE' +} as const; + +export type StatusresponseV1StatusV1 = typeof StatusresponseV1StatusV1[keyof typeof StatusresponseV1StatusV1]; + +/** + * Task result. + * @export + * @interface TaskresultdtoV1 + */ +export interface TaskresultdtoV1 { + /** + * Task result DTO type. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'type'?: TaskresultdtoV1TypeV1; + /** + * Task result ID. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'id'?: string; + /** + * Task result display name. + * @type {string} + * @memberof TaskresultdtoV1 + */ + 'name'?: string | null; +} + +export const TaskresultdtoV1TypeV1 = { + TaskResult: 'TASK_RESULT' +} as const; + +export type TaskresultdtoV1TypeV1 = typeof TaskresultdtoV1TypeV1[keyof typeof TaskresultdtoV1TypeV1]; + +/** + * The representation of an internally- or customer-defined transform. + * @export + * @interface TransformV1 + */ +export interface TransformV1 { + /** + * Unique name of this transform + * @type {string} + * @memberof TransformV1 + */ + 'name': string; + /** + * The type of transform operation + * @type {string} + * @memberof TransformV1 + */ + 'type': TransformV1TypeV1; + /** + * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + * @type {object} + * @memberof TransformV1 + */ + 'attributes': object | null; +} + +export const TransformV1TypeV1 = { + AccountAttribute: 'accountAttribute', + Base64Decode: 'base64Decode', + Base64Encode: 'base64Encode', + Concat: 'concat', + Conditional: 'conditional', + DateCompare: 'dateCompare', + DateFormat: 'dateFormat', + DateMath: 'dateMath', + DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', + E164phone: 'e164phone', + FirstValid: 'firstValid', + Rule: 'rule', + IdentityAttribute: 'identityAttribute', + IndexOf: 'indexOf', + Iso3166: 'iso3166', + LastIndexOf: 'lastIndexOf', + LeftPad: 'leftPad', + Lookup: 'lookup', + Lower: 'lower', + NormalizeNames: 'normalizeNames', + RandomAlphaNumeric: 'randomAlphaNumeric', + RandomNumeric: 'randomNumeric', + Reference: 'reference', + ReplaceAll: 'replaceAll', + Replace: 'replace', + RightPad: 'rightPad', + Split: 'split', + Static: 'static', + Substring: 'substring', + Trim: 'trim', + Upper: 'upper', + UsernameGenerator: 'usernameGenerator', + Uuid: 'uuid', + DisplayName: 'displayName', + Rfc5646: 'rfc5646' +} as const; + +export type TransformV1TypeV1 = typeof TransformV1TypeV1[keyof typeof TransformV1TypeV1]; + +/** + * + * @export + * @interface TransformreadV1 + */ +export interface TransformreadV1 { + /** + * Unique name of this transform + * @type {string} + * @memberof TransformreadV1 + */ + 'name': string; + /** + * The type of transform operation + * @type {string} + * @memberof TransformreadV1 + */ + 'type': TransformreadV1TypeV1; + /** + * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + * @type {object} + * @memberof TransformreadV1 + */ + 'attributes': object | null; + /** + * Unique ID of this transform + * @type {string} + * @memberof TransformreadV1 + */ + 'id': string; + /** + * Indicates whether this is an internal SailPoint-created transform or a customer-created transform + * @type {boolean} + * @memberof TransformreadV1 + */ + 'internal': boolean; +} + +export const TransformreadV1TypeV1 = { + AccountAttribute: 'accountAttribute', + Base64Decode: 'base64Decode', + Base64Encode: 'base64Encode', + Concat: 'concat', + Conditional: 'conditional', + DateCompare: 'dateCompare', + DateFormat: 'dateFormat', + DateMath: 'dateMath', + DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', + E164phone: 'e164phone', + FirstValid: 'firstValid', + Rule: 'rule', + IdentityAttribute: 'identityAttribute', + IndexOf: 'indexOf', + Iso3166: 'iso3166', + LastIndexOf: 'lastIndexOf', + LeftPad: 'leftPad', + Lookup: 'lookup', + Lower: 'lower', + NormalizeNames: 'normalizeNames', + RandomAlphaNumeric: 'randomAlphaNumeric', + RandomNumeric: 'randomNumeric', + Reference: 'reference', + ReplaceAll: 'replaceAll', + Replace: 'replace', + RightPad: 'rightPad', + Split: 'split', + Static: 'static', + Substring: 'substring', + Trim: 'trim', + Upper: 'upper', + UsernameGenerator: 'usernameGenerator', + Uuid: 'uuid', + DisplayName: 'displayName', + Rfc5646: 'rfc5646' +} as const; + +export type TransformreadV1TypeV1 = typeof TransformreadV1TypeV1[keyof typeof TransformreadV1TypeV1]; + +/** + * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @export + * @enum {string} + */ + +export const UsagetypeV1 = { + Create: 'CREATE', + Update: 'UPDATE', + Enable: 'ENABLE', + Disable: 'DISABLE', + Delete: 'DELETE', + Assign: 'ASSIGN', + Unassign: 'UNASSIGN', + CreateGroup: 'CREATE_GROUP', + UpdateGroup: 'UPDATE_GROUP', + DeleteGroup: 'DELETE_GROUP', + Register: 'REGISTER', + CreateIdentity: 'CREATE_IDENTITY', + UpdateIdentity: 'UPDATE_IDENTITY', + EditGroup: 'EDIT_GROUP', + Unlock: 'UNLOCK', + ChangePassword: 'CHANGE_PASSWORD' +} as const; + +export type UsagetypeV1 = typeof UsagetypeV1[keyof typeof UsagetypeV1]; + + + +/** + * SourcesV1Api - axios parameter creator + * @export + */ +export const SourcesV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Create provisioning policy + * @param {string} sourceId The Source id + * @param {ProvisioningpolicydtoV1} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createProvisioningPolicyV1: async (sourceId: string, provisioningpolicydtoV1: ProvisioningpolicydtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createProvisioningPolicyV1', 'sourceId', sourceId) + // verify required parameter 'provisioningpolicydtoV1' is not null or undefined + assertParamExists('createProvisioningPolicyV1', 'provisioningpolicydtoV1', provisioningpolicydtoV1) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(provisioningpolicydtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + * @summary Create schedule on source + * @param {string} sourceId Source ID. + * @param {Schedule3V1} schedule3V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceScheduleV1: async (sourceId: string, schedule3V1: Schedule3V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createSourceScheduleV1', 'sourceId', sourceId) + // verify required parameter 'schedule3V1' is not null or undefined + assertParamExists('createSourceScheduleV1', 'schedule3V1', schedule3V1) + const localVarPath = `/sources/v1/{sourceId}/schedules` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(schedule3V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + * @summary Create schema on source + * @param {string} sourceId Source ID. + * @param {SchemaV1} schemaV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceSchemaV1: async (sourceId: string, schemaV1: SchemaV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('createSourceSchemaV1', 'sourceId', sourceId) + // verify required parameter 'schemaV1' is not null or undefined + assertParamExists('createSourceSchemaV1', 'schemaV1', schemaV1) + const localVarPath = `/sources/v1/{sourceId}/schemas` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(schemaV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + * @summary Creates a source in identitynow. + * @param {SourceV1} sourceV1 + * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceV1: async (sourceV1: SourceV1, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceV1' is not null or undefined + assertParamExists('createSourceV1', 'sourceV1', sourceV1) + const localVarPath = `/sources/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; + + if (provisionAsCsv !== undefined) { + localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sourceV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove all accounts in source + * @param {string} id The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountsAsyncV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteAccountsAsyncV1', 'id', id) + const localVarPath = `/sources/v1/{id}/remove-accounts` + .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: 'POST', ...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, + }; + }, + /** + * Deletes the native change detection configuration for the source specified by the given ID. + * @summary Delete native change detection configuration + * @param {string} sourceId The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNativeChangeDetectionConfigV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteNativeChangeDetectionConfigV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/native-change-detection-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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, + }; + }, + /** + * Deletes the provisioning policy with the specified usage on an application. + * @summary Delete provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteProvisioningPolicyV1: async (sourceId: string, usageType: UsagetypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteProvisioningPolicyV1', 'sourceId', sourceId) + // verify required parameter 'usageType' is not null or undefined + assertParamExists('deleteProvisioningPolicyV1', 'usageType', usageType) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies/{usageType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); + // 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, + }; + }, + /** + * + * @summary Delete source schedule by type. + * @param {string} sourceId The Source id. + * @param {DeleteSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceScheduleV1: async (sourceId: string, scheduleType: DeleteSourceScheduleV1ScheduleTypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteSourceScheduleV1', 'sourceId', sourceId) + // verify required parameter 'scheduleType' is not null or undefined + assertParamExists('deleteSourceScheduleV1', 'scheduleType', scheduleType) + const localVarPath = `/sources/v1/{sourceId}/schedules/{scheduleType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); + // 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, + }; + }, + /** + * + * @summary Delete source schema by id + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceSchemaV1: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('deleteSourceSchemaV1', 'sourceId', sourceId) + // verify required parameter 'schemaId' is not null or undefined + assertParamExists('deleteSourceSchemaV1', 'schemaId', schemaId) + const localVarPath = `/sources/v1/{sourceId}/schemas/{schemaId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); + // 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, + }; + }, + /** + * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + * @summary Delete source by id + * @param {string} id Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSourceV1', 'id', id) + const localVarPath = `/sources/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, + }; + }, + /** + * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. + * @summary Human Account Deletion Approval Config + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountDeleteApprovalConfigV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getAccountDeleteApprovalConfigV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/approval-config/account-delete` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source accounts schema template + * @param {string} id The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountsSchemaV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getAccountsSchemaV1', 'id', id) + const localVarPath = `/sources/v1/{id}/schemas/accounts` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the existing correlation configuration for a source specified by the given ID. + * @summary Get source correlation configuration + * @param {string} id The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCorrelationConfigV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getCorrelationConfigV1', 'id', id) + const localVarPath = `/sources/v1/{id}/correlation-config` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source entitlements schema template + * @param {string} id The Source id + * @param {string} [schemaName] Name of entitlement schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementsSchemaV1: async (id: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getEntitlementsSchemaV1', 'id', id) + const localVarPath = `/sources/v1/{id}/schemas/entitlements` + .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 (schemaName !== undefined) { + localVarQueryParameter['schemaName'] = schemaName; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. + * @summary Machine Account Deletion Approval Config + * @param {string} sourceId source id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountDeletionApprovalConfigBySourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getMachineAccountDeletionApprovalConfigBySourceV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/approval-config/machine-account-delete` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the existing native change detection configuration for a source specified by the given ID. + * @summary Native change detection configuration + * @param {string} sourceId The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNativeChangeDetectionConfigV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getNativeChangeDetectionConfigV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/native-change-detection-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + * @summary Get provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProvisioningPolicyV1: async (sourceId: string, usageType: UsagetypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getProvisioningPolicyV1', 'sourceId', sourceId) + // verify required parameter 'usageType' is not null or undefined + assertParamExists('getProvisioningPolicyV1', 'usageType', usageType) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies/{usageType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + * @summary Attribute sync config + * @param {string} id The source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceAttrSyncConfigV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSourceAttrSyncConfigV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{id}/attribute-sync-config` + .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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + * @summary Gets source config with language-translations + * @param {string} id The Source id + * @param {GetSourceConfigV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceConfigV1: async (id: string, locale?: GetSourceConfigV1LocaleV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSourceConfigV1', 'id', id) + const localVarPath = `/sources/v1/{id}/connectors/source-config` + .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 (locale !== undefined) { + localVarQueryParameter['locale'] = locale; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source connections by id + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceConnectionsV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceConnectionsV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/connections` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Get source entitlement request configuration + * @param {string} id The Source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceEntitlementRequestConfigV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSourceEntitlementRequestConfigV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{id}/entitlement-request-config` + .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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint fetches source health by source\'s id + * @summary Fetches source health by id + * @param {string} sourceId The Source id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceHealthV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceHealthV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/source-health` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 the source schedule by type in Identity Security Cloud (ISC). + * @summary Get source schedule by type + * @param {string} sourceId The Source id. + * @param {GetSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceScheduleV1: async (sourceId: string, scheduleType: GetSourceScheduleV1ScheduleTypeV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceScheduleV1', 'sourceId', sourceId) + // verify required parameter 'scheduleType' is not null or undefined + assertParamExists('getSourceScheduleV1', 'scheduleType', scheduleType) + const localVarPath = `/sources/v1/{sourceId}/schedules/{scheduleType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); + // 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, + }; + }, + /** + * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: + * @summary List schedules on source + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchedulesV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceSchedulesV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/schedules` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 the Source Schema by ID in IdentityNow. + * @summary Get source schema by id + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchemaV1: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceSchemaV1', 'sourceId', sourceId) + // verify required parameter 'schemaId' is not null or undefined + assertParamExists('getSourceSchemaV1', 'schemaId', schemaId) + const localVarPath = `/sources/v1/{sourceId}/schemas/{schemaId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); + // 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, + }; + }, + /** + * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + * @summary List schemas on source + * @param {string} sourceId Source ID. + * @param {GetSourceSchemasV1IncludeTypesV1} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + * @param {string} [includeNames] A comma-separated list of schema names to filter result. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchemasV1: async (sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesV1, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('getSourceSchemasV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/schemas` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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 (includeTypes !== undefined) { + localVarQueryParameter['include-types'] = includeTypes; + } + + if (includeNames !== undefined) { + localVarQueryParameter['include-names'] = includeNames; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source by id + * @param {string} id Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSourceV1', 'id', id) + const localVarPath = `/sources/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, + }; + }, + /** + * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source accounts schema template + * @param {string} id The Source id + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importAccountsSchemaV1: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importAccountsSchemaV1', 'id', id) + const localVarPath = `/sources/v1/{id}/schemas/accounts` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Account aggregation + * @param {string} id Source Id + * @param {File} [file] The CSV file containing the source accounts to aggregate. + * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importAccountsV1: async (id: string, file?: File, disableOptimization?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importAccountsV1', 'id', id) + const localVarPath = `/sources/v1/{id}/load-accounts` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + if (disableOptimization !== undefined) { + localVarFormParams.append('disableOptimization', disableOptimization as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. + * @summary Upload connector file to source + * @param {string} sourceId The Source id. + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importConnectorFileV1: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('importConnectorFileV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/upload-connector-file` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source entitlements schema template + * @param {string} id The Source id + * @param {string} [schemaName] Name of entitlement schema + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importEntitlementsSchemaV1: async (id: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importEntitlementsSchemaV1', 'id', id) + const localVarPath = `/sources/v1/{id}/schemas/entitlements` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + if (schemaName !== undefined) { + localVarQueryParameter['schemaName'] = schemaName; + } + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Entitlement aggregation + * @param {string} sourceId Source Id + * @param {File} [file] The CSV file containing the source entitlements to aggregate. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importEntitlementsV1: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('importEntitlementsV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/load-entitlements` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + * @summary Process uncorrelated accounts + * @param {string} id Source Id + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importUncorrelatedAccountsV1: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('importUncorrelatedAccountsV1', 'id', id) + const localVarPath = `/sources/v1/{id}/load-uncorrelated-accounts` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Get Password Policy for source + * @param {string} sourceId The Source id + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPasswordPolicyHoldersOnSourceV1: async (sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('listPasswordPolicyHoldersOnSourceV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/password-policies` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point lists all the ProvisioningPolicies in IdentityNow. + * @summary Lists provisioningpolicies + * @param {string} sourceId The Source id + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listProvisioningPoliciesV1: async (sourceId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('listProvisioningPoliciesV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point lists all the sources in IdentityNow. + * @summary Lists all sources in identitynow. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSourcesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/sources/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (forSubadmin !== undefined) { + localVarQueryParameter['for-subadmin'] = forSubadmin; + } + + if (includeIDNSource !== undefined) { + localVarQueryParameter['includeIDNSource'] = includeIDNSource; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + * @summary Ping cluster for source connector + * @param {string} sourceId The ID of the Source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + pingClusterV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('pingClusterV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/connector/ping-cluster` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update source correlation configuration + * @param {string} id The source id + * @param {CorrelationconfigV1} correlationconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putCorrelationConfigV1: async (id: string, correlationconfigV1: CorrelationconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putCorrelationConfigV1', 'id', id) + // verify required parameter 'correlationconfigV1' is not null or undefined + assertParamExists('putCorrelationConfigV1', 'correlationconfigV1', correlationconfigV1) + const localVarPath = `/sources/v1/{id}/correlation-config` + .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: 'PUT', ...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(correlationconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update native change detection configuration + * @param {string} sourceId The source id + * @param {NativechangedetectionconfigV1} nativechangedetectionconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putNativeChangeDetectionConfigV1: async (sourceId: string, nativechangedetectionconfigV1: NativechangedetectionconfigV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('putNativeChangeDetectionConfigV1', 'sourceId', sourceId) + // verify required parameter 'nativechangedetectionconfigV1' is not null or undefined + assertParamExists('putNativeChangeDetectionConfigV1', 'nativechangedetectionconfigV1', nativechangedetectionconfigV1) + const localVarPath = `/sources/v1/{sourceId}/native-change-detection-config` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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: 'PUT', ...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(nativechangedetectionconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Update provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {ProvisioningpolicydtoV1} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putProvisioningPolicyV1: async (sourceId: string, usageType: UsagetypeV1, provisioningpolicydtoV1: ProvisioningpolicydtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('putProvisioningPolicyV1', 'sourceId', sourceId) + // verify required parameter 'usageType' is not null or undefined + assertParamExists('putProvisioningPolicyV1', 'usageType', usageType) + // verify required parameter 'provisioningpolicydtoV1' is not null or undefined + assertParamExists('putProvisioningPolicyV1', 'provisioningpolicydtoV1', provisioningpolicydtoV1) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies/{usageType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); + // 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: 'PUT', ...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(provisioningpolicydtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. + * @summary Update attribute sync config + * @param {string} id The source id + * @param {AttrsyncsourceconfigV1} attrsyncsourceconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceAttrSyncConfigV1: async (id: string, attrsyncsourceconfigV1: AttrsyncsourceconfigV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putSourceAttrSyncConfigV1', 'id', id) + // verify required parameter 'attrsyncsourceconfigV1' is not null or undefined + assertParamExists('putSourceAttrSyncConfigV1', 'attrsyncsourceconfigV1', attrsyncsourceconfigV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{id}/attribute-sync-config` + .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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(attrsyncsourceconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + * @summary Update source schema (full) + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {SchemaV1} schemaV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceSchemaV1: async (sourceId: string, schemaId: string, schemaV1: SchemaV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('putSourceSchemaV1', 'sourceId', sourceId) + // verify required parameter 'schemaId' is not null or undefined + assertParamExists('putSourceSchemaV1', 'schemaId', schemaId) + // verify required parameter 'schemaV1' is not null or undefined + assertParamExists('putSourceSchemaV1', 'schemaV1', schemaV1) + const localVarPath = `/sources/v1/{sourceId}/schemas/{schemaId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); + // 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: 'PUT', ...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(schemaV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (full) + * @param {string} id Source ID. + * @param {SourceV1} sourceV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceV1: async (id: string, sourceV1: SourceV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putSourceV1', 'id', id) + // verify required parameter 'sourceV1' is not null or undefined + assertParamExists('putSourceV1', 'sourceV1', sourceV1) + const localVarPath = `/sources/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: 'PUT', ...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(sourceV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Retrieves a sample of data returned from account and group aggregation requests. + * @summary Peek source connector\'s resource objects + * @param {string} sourceId The ID of the Source + * @param {ResourceobjectsrequestV1} resourceobjectsrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchResourceObjectsV1: async (sourceId: string, resourceobjectsrequestV1: ResourceobjectsrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('searchResourceObjectsV1', 'sourceId', sourceId) + // verify required parameter 'resourceobjectsrequestV1' is not null or undefined + assertParamExists('searchResourceObjectsV1', 'resourceobjectsrequestV1', resourceobjectsrequestV1) + const localVarPath = `/sources/v1/{sourceId}/connector/peek-resource-objects` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(resourceobjectsrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point performs attribute synchronization for a selected source. + * @summary Synchronize single source attributes. + * @param {string} id The Source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + syncAttributesForSourceV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('syncAttributesForSourceV1', 'id', id) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{id}/synchronize-attributes` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + * @summary Test configuration for source connector + * @param {string} sourceId The ID of the Source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConfigurationV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('testSourceConfigurationV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/connector/test-configuration` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + * @summary Check connection for source connector. + * @param {string} sourceId The ID of the Source. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConnectionV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('testSourceConnectionV1', 'sourceId', sourceId) + const localVarPath = `/sources/v1/{sourceId}/connector/check-connection` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. + * @summary Human Account Deletion Approval Config + * @param {string} sourceId Human account source ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccountDeletionApprovalConfigV1: async (sourceId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateAccountDeletionApprovalConfigV1', 'sourceId', sourceId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateAccountDeletionApprovalConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/v1/{sourceId}/approval-config/account-delete` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. + * @summary Machine Account Deletion Approval Config + * @param {string} sourceId machine account source ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountDeletionApprovalConfigV1: async (sourceId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateMachineAccountDeletionApprovalConfigV1', 'sourceId', sourceId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateMachineAccountDeletionApprovalConfigV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/v1/{sourceId}/approval-config/machine-account-delete` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Update password policy + * @param {string} sourceId The Source id + * @param {Array} passwordpolicyholdersdtoInnerV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePasswordPolicyHoldersV1: async (sourceId: string, passwordpolicyholdersdtoInnerV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updatePasswordPolicyHoldersV1', 'sourceId', sourceId) + // verify required parameter 'passwordpolicyholdersdtoInnerV1' is not null or undefined + assertParamExists('updatePasswordPolicyHoldersV1', 'passwordpolicyholdersdtoInnerV1', passwordpolicyholdersdtoInnerV1) + const localVarPath = `/sources/v1/{sourceId}/password-policies` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(passwordpolicyholdersdtoInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This end-point updates a list of provisioning policies on the specified source in IdentityNow. + * @summary Bulk update provisioning policies + * @param {string} sourceId The Source id. + * @param {Array} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateProvisioningPoliciesInBulkV1: async (sourceId: string, provisioningpolicydtoV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateProvisioningPoliciesInBulkV1', 'sourceId', sourceId) + // verify required parameter 'provisioningpolicydtoV1' is not null or undefined + assertParamExists('updateProvisioningPoliciesInBulkV1', 'provisioningpolicydtoV1', provisioningpolicydtoV1) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies/bulk-update` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); + // 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(provisioningpolicydtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Partial update of provisioning policy + * @param {string} sourceId The Source id. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateProvisioningPolicyV1: async (sourceId: string, usageType: UsagetypeV1, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateProvisioningPolicyV1', 'sourceId', sourceId) + // verify required parameter 'usageType' is not null or undefined + assertParamExists('updateProvisioningPolicyV1', 'usageType', usageType) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateProvisioningPolicyV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/v1/{sourceId}/provisioning-policies/{usageType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Update source entitlement request configuration + * @param {string} id The Source id + * @param {SourceentitlementrequestconfigV1} sourceentitlementrequestconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceEntitlementRequestConfigV1: async (id: string, sourceentitlementrequestconfigV1: SourceentitlementrequestconfigV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateSourceEntitlementRequestConfigV1', 'id', id) + // verify required parameter 'sourceentitlementrequestconfigV1' is not null or undefined + assertParamExists('updateSourceEntitlementRequestConfigV1', 'sourceentitlementrequestconfigV1', sourceentitlementrequestconfigV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/sources/v1/{id}/entitlement-request-config` + .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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sourceentitlementrequestconfigV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type + * @summary Update source schedule (partial) + * @param {string} sourceId The Source id. + * @param {UpdateSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schedule. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceScheduleV1: async (sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeV1, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateSourceScheduleV1', 'sourceId', sourceId) + // verify required parameter 'scheduleType' is not null or undefined + assertParamExists('updateSourceScheduleV1', 'scheduleType', scheduleType) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateSourceScheduleV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/v1/{sourceId}/schedules/{scheduleType}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` + * @summary Update source schema (partial) + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceSchemaV1: async (sourceId: string, schemaId: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sourceId' is not null or undefined + assertParamExists('updateSourceSchemaV1', 'sourceId', sourceId) + // verify required parameter 'schemaId' is not null or undefined + assertParamExists('updateSourceSchemaV1', 'schemaId', schemaId) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateSourceSchemaV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/v1/{sourceId}/schemas/{schemaId}` + .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) + .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); + // 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (partial) + * @param {string} id Source ID. + * @param {Array} jsonpatchoperationV1 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateSourceV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateSourceV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/sources/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SourcesV1Api - functional programming interface + * @export + */ +export const SourcesV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SourcesV1ApiAxiosParamCreator(configuration) + return { + /** + * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Create provisioning policy + * @param {string} sourceId The Source id + * @param {ProvisioningpolicydtoV1} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createProvisioningPolicyV1(sourceId: string, provisioningpolicydtoV1: ProvisioningpolicydtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicyV1(sourceId, provisioningpolicydtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.createProvisioningPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + * @summary Create schedule on source + * @param {string} sourceId Source ID. + * @param {Schedule3V1} schedule3V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourceScheduleV1(sourceId: string, schedule3V1: Schedule3V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceScheduleV1(sourceId, schedule3V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.createSourceScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + * @summary Create schema on source + * @param {string} sourceId Source ID. + * @param {SchemaV1} schemaV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourceSchemaV1(sourceId: string, schemaV1: SchemaV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchemaV1(sourceId, schemaV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.createSourceSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + * @summary Creates a source in identitynow. + * @param {SourceV1} sourceV1 + * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSourceV1(sourceV1: SourceV1, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceV1(sourceV1, provisionAsCsv, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.createSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove all accounts in source + * @param {string} id The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteAccountsAsyncV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountsAsyncV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteAccountsAsyncV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes the native change detection configuration for the source specified by the given ID. + * @summary Delete native change detection configuration + * @param {string} sourceId The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteNativeChangeDetectionConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNativeChangeDetectionConfigV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteNativeChangeDetectionConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes the provisioning policy with the specified usage on an application. + * @summary Delete provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteProvisioningPolicyV1(sourceId: string, usageType: UsagetypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicyV1(sourceId, usageType, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteProvisioningPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Delete source schedule by type. + * @param {string} sourceId The Source id. + * @param {DeleteSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSourceScheduleV1(sourceId: string, scheduleType: DeleteSourceScheduleV1ScheduleTypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceScheduleV1(sourceId, scheduleType, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteSourceScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @summary Delete source schema by id + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSourceSchemaV1(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchemaV1(sourceId, schemaId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteSourceSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + * @summary Delete source by id + * @param {string} id Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSourceV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.deleteSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. + * @summary Human Account Deletion Approval Config + * @param {string} sourceId The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountDeleteApprovalConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountDeleteApprovalConfigV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getAccountDeleteApprovalConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source accounts schema template + * @param {string} id The Source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAccountsSchemaV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountsSchemaV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getAccountsSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the existing correlation configuration for a source specified by the given ID. + * @summary Get source correlation configuration + * @param {string} id The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCorrelationConfigV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCorrelationConfigV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source entitlements schema template + * @param {string} id The Source id + * @param {string} [schemaName] Name of entitlement schema + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEntitlementsSchemaV1(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsSchemaV1(id, schemaName, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getEntitlementsSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. + * @summary Machine Account Deletion Approval Config + * @param {string} sourceId source id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getMachineAccountDeletionApprovalConfigBySourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountDeletionApprovalConfigBySourceV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getMachineAccountDeletionApprovalConfigBySourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the existing native change detection configuration for a source specified by the given ID. + * @summary Native change detection configuration + * @param {string} sourceId The source id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getNativeChangeDetectionConfigV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNativeChangeDetectionConfigV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getNativeChangeDetectionConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + * @summary Get provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getProvisioningPolicyV1(sourceId: string, usageType: UsagetypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicyV1(sourceId, usageType, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getProvisioningPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + * @summary Attribute sync config + * @param {string} id The source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceAttrSyncConfigV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAttrSyncConfigV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceAttrSyncConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + * @summary Gets source config with language-translations + * @param {string} id The Source id + * @param {GetSourceConfigV1LocaleV1} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceConfigV1(id: string, locale?: GetSourceConfigV1LocaleV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConfigV1(id, locale, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source connections by id + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceConnectionsV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnectionsV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceConnectionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Get source entitlement request configuration + * @param {string} id The Source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceEntitlementRequestConfigV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementRequestConfigV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceEntitlementRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint fetches source health by source\'s id + * @summary Fetches source health by id + * @param {string} sourceId The Source id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceHealthV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceHealthV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceHealthV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the source schedule by type in Identity Security Cloud (ISC). + * @summary Get source schedule by type + * @param {string} sourceId The Source id. + * @param {GetSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceScheduleV1(sourceId: string, scheduleType: GetSourceScheduleV1ScheduleTypeV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceScheduleV1(sourceId, scheduleType, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: + * @summary List schedules on source + * @param {string} sourceId Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceSchedulesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedulesV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceSchedulesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the Source Schema by ID in IdentityNow. + * @summary Get source schema by id + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceSchemaV1(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemaV1(sourceId, schemaId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + * @summary List schemas on source + * @param {string} sourceId Source ID. + * @param {GetSourceSchemasV1IncludeTypesV1} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + * @param {string} [includeNames] A comma-separated list of schema names to filter result. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceSchemasV1(sourceId: string, includeTypes?: GetSourceSchemasV1IncludeTypesV1, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemasV1(sourceId, includeTypes, includeNames, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceSchemasV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source by id + * @param {string} id Source ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSourceV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.getSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source accounts schema template + * @param {string} id The Source id + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importAccountsSchemaV1(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsSchemaV1(id, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importAccountsSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Account aggregation + * @param {string} id Source Id + * @param {File} [file] The CSV file containing the source accounts to aggregate. + * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importAccountsV1(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsV1(id, file, disableOptimization, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importAccountsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. + * @summary Upload connector file to source + * @param {string} sourceId The Source id. + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importConnectorFileV1(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importConnectorFileV1(sourceId, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importConnectorFileV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source entitlements schema template + * @param {string} id The Source id + * @param {string} [schemaName] Name of entitlement schema + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importEntitlementsSchemaV1(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsSchemaV1(id, schemaName, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importEntitlementsSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Entitlement aggregation + * @param {string} sourceId Source Id + * @param {File} [file] The CSV file containing the source entitlements to aggregate. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importEntitlementsV1(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsV1(sourceId, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importEntitlementsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + * @summary Process uncorrelated accounts + * @param {string} id Source Id + * @param {File} [file] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importUncorrelatedAccountsV1(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importUncorrelatedAccountsV1(id, file, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.importUncorrelatedAccountsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Get Password Policy for source + * @param {string} sourceId The Source id + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPasswordPolicyHoldersOnSourceV1(sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicyHoldersOnSourceV1(sourceId, offset, limit, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.listPasswordPolicyHoldersOnSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point lists all the ProvisioningPolicies in IdentityNow. + * @summary Lists provisioningpolicies + * @param {string} sourceId The Source id + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listProvisioningPoliciesV1(sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPoliciesV1(sourceId, offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.listProvisioningPoliciesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point lists all the sources in IdentityNow. + * @summary Lists all sources in identitynow. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSourcesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSourcesV1(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.listSourcesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + * @summary Ping cluster for source connector + * @param {string} sourceId The ID of the Source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async pingClusterV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pingClusterV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.pingClusterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update source correlation configuration + * @param {string} id The source id + * @param {CorrelationconfigV1} correlationconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putCorrelationConfigV1(id: string, correlationconfigV1: CorrelationconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putCorrelationConfigV1(id, correlationconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putCorrelationConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update native change detection configuration + * @param {string} sourceId The source id + * @param {NativechangedetectionconfigV1} nativechangedetectionconfigV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putNativeChangeDetectionConfigV1(sourceId: string, nativechangedetectionconfigV1: NativechangedetectionconfigV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putNativeChangeDetectionConfigV1(sourceId, nativechangedetectionconfigV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putNativeChangeDetectionConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Update provisioning policy by usagetype + * @param {string} sourceId The Source ID. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {ProvisioningpolicydtoV1} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putProvisioningPolicyV1(sourceId: string, usageType: UsagetypeV1, provisioningpolicydtoV1: ProvisioningpolicydtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicyV1(sourceId, usageType, provisioningpolicydtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putProvisioningPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. + * @summary Update attribute sync config + * @param {string} id The source id + * @param {AttrsyncsourceconfigV1} attrsyncsourceconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSourceAttrSyncConfigV1(id: string, attrsyncsourceconfigV1: AttrsyncsourceconfigV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceAttrSyncConfigV1(id, attrsyncsourceconfigV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putSourceAttrSyncConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + * @summary Update source schema (full) + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {SchemaV1} schemaV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSourceSchemaV1(sourceId: string, schemaId: string, schemaV1: SchemaV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchemaV1(sourceId, schemaId, schemaV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putSourceSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (full) + * @param {string} id Source ID. + * @param {SourceV1} sourceV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putSourceV1(id: string, sourceV1: SourceV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceV1(id, sourceV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.putSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieves a sample of data returned from account and group aggregation requests. + * @summary Peek source connector\'s resource objects + * @param {string} sourceId The ID of the Source + * @param {ResourceobjectsrequestV1} resourceobjectsrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async searchResourceObjectsV1(sourceId: string, resourceobjectsrequestV1: ResourceobjectsrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchResourceObjectsV1(sourceId, resourceobjectsrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.searchResourceObjectsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point performs attribute synchronization for a selected source. + * @summary Synchronize single source attributes. + * @param {string} id The Source id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async syncAttributesForSourceV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.syncAttributesForSourceV1(id, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.syncAttributesForSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + * @summary Test configuration for source connector + * @param {string} sourceId The ID of the Source + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testSourceConfigurationV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConfigurationV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.testSourceConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + * @summary Check connection for source connector. + * @param {string} sourceId The ID of the Source. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testSourceConnectionV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionV1(sourceId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.testSourceConnectionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. + * @summary Human Account Deletion Approval Config + * @param {string} sourceId Human account source ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAccountDeletionApprovalConfigV1(sourceId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateAccountDeletionApprovalConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. + * @summary Machine Account Deletion Approval Config + * @param {string} sourceId machine account source ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateMachineAccountDeletionApprovalConfigV1(sourceId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateMachineAccountDeletionApprovalConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Update password policy + * @param {string} sourceId The Source id + * @param {Array} passwordpolicyholdersdtoInnerV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updatePasswordPolicyHoldersV1(sourceId: string, passwordpolicyholdersdtoInnerV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordPolicyHoldersV1(sourceId, passwordpolicyholdersdtoInnerV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updatePasswordPolicyHoldersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This end-point updates a list of provisioning policies on the specified source in IdentityNow. + * @summary Bulk update provisioning policies + * @param {string} sourceId The Source id. + * @param {Array} provisioningpolicydtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateProvisioningPoliciesInBulkV1(sourceId: string, provisioningpolicydtoV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulkV1(sourceId, provisioningpolicydtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateProvisioningPoliciesInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Partial update of provisioning policy + * @param {string} sourceId The Source id. + * @param {UsagetypeV1} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateProvisioningPolicyV1(sourceId: string, usageType: UsagetypeV1, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicyV1(sourceId, usageType, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateProvisioningPolicyV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Update source entitlement request configuration + * @param {string} id The Source id + * @param {SourceentitlementrequestconfigV1} sourceentitlementrequestconfigV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSourceEntitlementRequestConfigV1(id: string, sourceentitlementrequestconfigV1: SourceentitlementrequestconfigV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceEntitlementRequestConfigV1(id, sourceentitlementrequestconfigV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateSourceEntitlementRequestConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type + * @summary Update source schedule (partial) + * @param {string} sourceId The Source id. + * @param {UpdateSourceScheduleV1ScheduleTypeV1} scheduleType The Schedule type. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schedule. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSourceScheduleV1(sourceId: string, scheduleType: UpdateSourceScheduleV1ScheduleTypeV1, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceScheduleV1(sourceId, scheduleType, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateSourceScheduleV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` + * @summary Update source schema (partial) + * @param {string} sourceId The Source id. + * @param {string} schemaId The Schema id. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the schema. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSourceSchemaV1(sourceId: string, schemaId: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchemaV1(sourceId, schemaId, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateSourceSchemaV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (partial) + * @param {string} id Source ID. + * @param {Array} jsonpatchoperationV1 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSourceV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SourcesV1Api.updateSourceV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SourcesV1Api - factory interface + * @export + */ +export const SourcesV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SourcesV1ApiFp(configuration) + return { + /** + * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Create provisioning policy + * @param {SourcesV1ApiCreateProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createProvisioningPolicyV1(requestParameters: SourcesV1ApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createProvisioningPolicyV1(requestParameters.sourceId, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + * @summary Create schedule on source + * @param {SourcesV1ApiCreateSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceScheduleV1(requestParameters: SourcesV1ApiCreateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourceScheduleV1(requestParameters.sourceId, requestParameters.schedule3V1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + * @summary Create schema on source + * @param {SourcesV1ApiCreateSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceSchemaV1(requestParameters: SourcesV1ApiCreateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + * @summary Creates a source in identitynow. + * @param {SourcesV1ApiCreateSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSourceV1(requestParameters: SourcesV1ApiCreateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSourceV1(requestParameters.sourceV1, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove all accounts in source + * @param {SourcesV1ApiDeleteAccountsAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteAccountsAsyncV1(requestParameters: SourcesV1ApiDeleteAccountsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteAccountsAsyncV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes the native change detection configuration for the source specified by the given ID. + * @summary Delete native change detection configuration + * @param {SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNativeChangeDetectionConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes the provisioning policy with the specified usage on an application. + * @summary Delete provisioning policy by usagetype + * @param {SourcesV1ApiDeleteProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteProvisioningPolicyV1(requestParameters: SourcesV1ApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Delete source schedule by type. + * @param {SourcesV1ApiDeleteSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceScheduleV1(requestParameters: SourcesV1ApiDeleteSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Delete source schema by id + * @param {SourcesV1ApiDeleteSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceSchemaV1(requestParameters: SourcesV1ApiDeleteSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + * @summary Delete source by id + * @param {SourcesV1ApiDeleteSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSourceV1(requestParameters: SourcesV1ApiDeleteSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSourceV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. + * @summary Human Account Deletion Approval Config + * @param {SourcesV1ApiGetAccountDeleteApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountDeleteApprovalConfigV1(requestParameters: SourcesV1ApiGetAccountDeleteApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccountDeleteApprovalConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source accounts schema template + * @param {SourcesV1ApiGetAccountsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAccountsSchemaV1(requestParameters: SourcesV1ApiGetAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAccountsSchemaV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the existing correlation configuration for a source specified by the given ID. + * @summary Get source correlation configuration + * @param {SourcesV1ApiGetCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCorrelationConfigV1(requestParameters: SourcesV1ApiGetCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCorrelationConfigV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source entitlements schema template + * @param {SourcesV1ApiGetEntitlementsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEntitlementsSchemaV1(requestParameters: SourcesV1ApiGetEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getEntitlementsSchemaV1(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. + * @summary Machine Account Deletion Approval Config + * @param {SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters: SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the existing native change detection configuration for a source specified by the given ID. + * @summary Native change detection configuration + * @param {SourcesV1ApiGetNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiGetNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getNativeChangeDetectionConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + * @summary Get provisioning policy by usagetype + * @param {SourcesV1ApiGetProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getProvisioningPolicyV1(requestParameters: SourcesV1ApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + * @summary Attribute sync config + * @param {SourcesV1ApiGetSourceAttrSyncConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceAttrSyncConfigV1(requestParameters: SourcesV1ApiGetSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceAttrSyncConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + * @summary Gets source config with language-translations + * @param {SourcesV1ApiGetSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceConfigV1(requestParameters: SourcesV1ApiGetSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceConfigV1(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source connections by id + * @param {SourcesV1ApiGetSourceConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceConnectionsV1(requestParameters: SourcesV1ApiGetSourceConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceConnectionsV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Get source entitlement request configuration + * @param {SourcesV1ApiGetSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceEntitlementRequestConfigV1(requestParameters: SourcesV1ApiGetSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceEntitlementRequestConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint fetches source health by source\'s id + * @summary Fetches source health by id + * @param {SourcesV1ApiGetSourceHealthV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceHealthV1(requestParameters: SourcesV1ApiGetSourceHealthV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceHealthV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the source schedule by type in Identity Security Cloud (ISC). + * @summary Get source schedule by type + * @param {SourcesV1ApiGetSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceScheduleV1(requestParameters: SourcesV1ApiGetSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: + * @summary List schedules on source + * @param {SourcesV1ApiGetSourceSchedulesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchedulesV1(requestParameters: SourcesV1ApiGetSourceSchedulesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSourceSchedulesV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the Source Schema by ID in IdentityNow. + * @summary Get source schema by id + * @param {SourcesV1ApiGetSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchemaV1(requestParameters: SourcesV1ApiGetSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + * @summary List schemas on source + * @param {SourcesV1ApiGetSourceSchemasV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceSchemasV1(requestParameters: SourcesV1ApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSourceSchemasV1(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source by id + * @param {SourcesV1ApiGetSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSourceV1(requestParameters: SourcesV1ApiGetSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSourceV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source accounts schema template + * @param {SourcesV1ApiImportAccountsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importAccountsSchemaV1(requestParameters: SourcesV1ApiImportAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importAccountsSchemaV1(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Account aggregation + * @param {SourcesV1ApiImportAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importAccountsV1(requestParameters: SourcesV1ApiImportAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importAccountsV1(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. + * @summary Upload connector file to source + * @param {SourcesV1ApiImportConnectorFileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importConnectorFileV1(requestParameters: SourcesV1ApiImportConnectorFileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importConnectorFileV1(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source entitlements schema template + * @param {SourcesV1ApiImportEntitlementsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importEntitlementsSchemaV1(requestParameters: SourcesV1ApiImportEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importEntitlementsSchemaV1(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Entitlement aggregation + * @param {SourcesV1ApiImportEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importEntitlementsV1(requestParameters: SourcesV1ApiImportEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importEntitlementsV1(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + * @summary Process uncorrelated accounts + * @param {SourcesV1ApiImportUncorrelatedAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importUncorrelatedAccountsV1(requestParameters: SourcesV1ApiImportUncorrelatedAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importUncorrelatedAccountsV1(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Get Password Policy for source + * @param {SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPasswordPolicyHoldersOnSourceV1(requestParameters: SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPasswordPolicyHoldersOnSourceV1(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point lists all the ProvisioningPolicies in IdentityNow. + * @summary Lists provisioningpolicies + * @param {SourcesV1ApiListProvisioningPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listProvisioningPoliciesV1(requestParameters: SourcesV1ApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listProvisioningPoliciesV1(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point lists all the sources in IdentityNow. + * @summary Lists all sources in identitynow. + * @param {SourcesV1ApiListSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSourcesV1(requestParameters: SourcesV1ApiListSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + * @summary Ping cluster for source connector + * @param {SourcesV1ApiPingClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + pingClusterV1(requestParameters: SourcesV1ApiPingClusterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pingClusterV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update source correlation configuration + * @param {SourcesV1ApiPutCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putCorrelationConfigV1(requestParameters: SourcesV1ApiPutCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putCorrelationConfigV1(requestParameters.id, requestParameters.correlationconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update native change detection configuration + * @param {SourcesV1ApiPutNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiPutNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putNativeChangeDetectionConfigV1(requestParameters.sourceId, requestParameters.nativechangedetectionconfigV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Update provisioning policy by usagetype + * @param {SourcesV1ApiPutProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putProvisioningPolicyV1(requestParameters: SourcesV1ApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. + * @summary Update attribute sync config + * @param {SourcesV1ApiPutSourceAttrSyncConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceAttrSyncConfigV1(requestParameters: SourcesV1ApiPutSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSourceAttrSyncConfigV1(requestParameters.id, requestParameters.attrsyncsourceconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + * @summary Update source schema (full) + * @param {SourcesV1ApiPutSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceSchemaV1(requestParameters: SourcesV1ApiPutSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (full) + * @param {SourcesV1ApiPutSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putSourceV1(requestParameters: SourcesV1ApiPutSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putSourceV1(requestParameters.id, requestParameters.sourceV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Retrieves a sample of data returned from account and group aggregation requests. + * @summary Peek source connector\'s resource objects + * @param {SourcesV1ApiSearchResourceObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + searchResourceObjectsV1(requestParameters: SourcesV1ApiSearchResourceObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchResourceObjectsV1(requestParameters.sourceId, requestParameters.resourceobjectsrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point performs attribute synchronization for a selected source. + * @summary Synchronize single source attributes. + * @param {SourcesV1ApiSyncAttributesForSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + syncAttributesForSourceV1(requestParameters: SourcesV1ApiSyncAttributesForSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.syncAttributesForSourceV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + * @summary Test configuration for source connector + * @param {SourcesV1ApiTestSourceConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConfigurationV1(requestParameters: SourcesV1ApiTestSourceConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testSourceConfigurationV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + * @summary Check connection for source connector. + * @param {SourcesV1ApiTestSourceConnectionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSourceConnectionV1(requestParameters: SourcesV1ApiTestSourceConnectionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testSourceConnectionV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. + * @summary Human Account Deletion Approval Config + * @param {SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAccountDeletionApprovalConfigV1(requestParameters: SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAccountDeletionApprovalConfigV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. + * @summary Machine Account Deletion Approval Config + * @param {SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateMachineAccountDeletionApprovalConfigV1(requestParameters: SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateMachineAccountDeletionApprovalConfigV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Update password policy + * @param {SourcesV1ApiUpdatePasswordPolicyHoldersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updatePasswordPolicyHoldersV1(requestParameters: SourcesV1ApiUpdatePasswordPolicyHoldersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.updatePasswordPolicyHoldersV1(requestParameters.sourceId, requestParameters.passwordpolicyholdersdtoInnerV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This end-point updates a list of provisioning policies on the specified source in IdentityNow. + * @summary Bulk update provisioning policies + * @param {SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateProvisioningPoliciesInBulkV1(requestParameters: SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.updateProvisioningPoliciesInBulkV1(requestParameters.sourceId, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Partial update of provisioning policy + * @param {SourcesV1ApiUpdateProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateProvisioningPolicyV1(requestParameters: SourcesV1ApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Update source entitlement request configuration + * @param {SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceEntitlementRequestConfigV1(requestParameters: SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSourceEntitlementRequestConfigV1(requestParameters.id, requestParameters.sourceentitlementrequestconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type + * @summary Update source schedule (partial) + * @param {SourcesV1ApiUpdateSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceScheduleV1(requestParameters: SourcesV1ApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` + * @summary Update source schema (partial) + * @param {SourcesV1ApiUpdateSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceSchemaV1(requestParameters: SourcesV1ApiUpdateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (partial) + * @param {SourcesV1ApiUpdateSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSourceV1(requestParameters: SourcesV1ApiUpdateSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSourceV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createProvisioningPolicyV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiCreateProvisioningPolicyV1Request + */ +export interface SourcesV1ApiCreateProvisioningPolicyV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiCreateProvisioningPolicyV1 + */ + readonly sourceId: string + + /** + * + * @type {ProvisioningpolicydtoV1} + * @memberof SourcesV1ApiCreateProvisioningPolicyV1 + */ + readonly provisioningpolicydtoV1: ProvisioningpolicydtoV1 +} + +/** + * Request parameters for createSourceScheduleV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiCreateSourceScheduleV1Request + */ +export interface SourcesV1ApiCreateSourceScheduleV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiCreateSourceScheduleV1 + */ + readonly sourceId: string + + /** + * + * @type {Schedule3V1} + * @memberof SourcesV1ApiCreateSourceScheduleV1 + */ + readonly schedule3V1: Schedule3V1 +} + +/** + * Request parameters for createSourceSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiCreateSourceSchemaV1Request + */ +export interface SourcesV1ApiCreateSourceSchemaV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiCreateSourceSchemaV1 + */ + readonly sourceId: string + + /** + * + * @type {SchemaV1} + * @memberof SourcesV1ApiCreateSourceSchemaV1 + */ + readonly schemaV1: SchemaV1 +} + +/** + * Request parameters for createSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiCreateSourceV1Request + */ +export interface SourcesV1ApiCreateSourceV1Request { + /** + * + * @type {SourceV1} + * @memberof SourcesV1ApiCreateSourceV1 + */ + readonly sourceV1: SourceV1 + + /** + * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. + * @type {boolean} + * @memberof SourcesV1ApiCreateSourceV1 + */ + readonly provisionAsCsv?: boolean +} + +/** + * Request parameters for deleteAccountsAsyncV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteAccountsAsyncV1Request + */ +export interface SourcesV1ApiDeleteAccountsAsyncV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiDeleteAccountsAsyncV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteNativeChangeDetectionConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request + */ +export interface SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiDeleteNativeChangeDetectionConfigV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for deleteProvisioningPolicyV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteProvisioningPolicyV1Request + */ +export interface SourcesV1ApiDeleteProvisioningPolicyV1Request { + /** + * The Source ID. + * @type {string} + * @memberof SourcesV1ApiDeleteProvisioningPolicyV1 + */ + readonly sourceId: string + + /** + * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @type {UsagetypeV1} + * @memberof SourcesV1ApiDeleteProvisioningPolicyV1 + */ + readonly usageType: UsagetypeV1 +} + +/** + * Request parameters for deleteSourceScheduleV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteSourceScheduleV1Request + */ +export interface SourcesV1ApiDeleteSourceScheduleV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiDeleteSourceScheduleV1 + */ + readonly sourceId: string + + /** + * The Schedule type. + * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} + * @memberof SourcesV1ApiDeleteSourceScheduleV1 + */ + readonly scheduleType: DeleteSourceScheduleV1ScheduleTypeV1 +} + +/** + * Request parameters for deleteSourceSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteSourceSchemaV1Request + */ +export interface SourcesV1ApiDeleteSourceSchemaV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiDeleteSourceSchemaV1 + */ + readonly sourceId: string + + /** + * The Schema id. + * @type {string} + * @memberof SourcesV1ApiDeleteSourceSchemaV1 + */ + readonly schemaId: string +} + +/** + * Request parameters for deleteSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiDeleteSourceV1Request + */ +export interface SourcesV1ApiDeleteSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiDeleteSourceV1 + */ + readonly id: string +} + +/** + * Request parameters for getAccountDeleteApprovalConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetAccountDeleteApprovalConfigV1Request + */ +export interface SourcesV1ApiGetAccountDeleteApprovalConfigV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiGetAccountDeleteApprovalConfigV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getAccountsSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetAccountsSchemaV1Request + */ +export interface SourcesV1ApiGetAccountsSchemaV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiGetAccountsSchemaV1 + */ + readonly id: string +} + +/** + * Request parameters for getCorrelationConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetCorrelationConfigV1Request + */ +export interface SourcesV1ApiGetCorrelationConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiGetCorrelationConfigV1 + */ + readonly id: string +} + +/** + * Request parameters for getEntitlementsSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetEntitlementsSchemaV1Request + */ +export interface SourcesV1ApiGetEntitlementsSchemaV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiGetEntitlementsSchemaV1 + */ + readonly id: string + + /** + * Name of entitlement schema + * @type {string} + * @memberof SourcesV1ApiGetEntitlementsSchemaV1 + */ + readonly schemaName?: string +} + +/** + * Request parameters for getMachineAccountDeletionApprovalConfigBySourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request + */ +export interface SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request { + /** + * source id. + * @type {string} + * @memberof SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getNativeChangeDetectionConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetNativeChangeDetectionConfigV1Request + */ +export interface SourcesV1ApiGetNativeChangeDetectionConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiGetNativeChangeDetectionConfigV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getProvisioningPolicyV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetProvisioningPolicyV1Request + */ +export interface SourcesV1ApiGetProvisioningPolicyV1Request { + /** + * The Source ID. + * @type {string} + * @memberof SourcesV1ApiGetProvisioningPolicyV1 + */ + readonly sourceId: string + + /** + * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @type {UsagetypeV1} + * @memberof SourcesV1ApiGetProvisioningPolicyV1 + */ + readonly usageType: UsagetypeV1 +} + +/** + * Request parameters for getSourceAttrSyncConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceAttrSyncConfigV1Request + */ +export interface SourcesV1ApiGetSourceAttrSyncConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiGetSourceAttrSyncConfigV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SourcesV1ApiGetSourceAttrSyncConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSourceConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceConfigV1Request + */ +export interface SourcesV1ApiGetSourceConfigV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiGetSourceConfigV1 + */ + readonly id: string + + /** + * The locale to apply to the config. If no viable locale is given, it will default to \"en\" + * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} + * @memberof SourcesV1ApiGetSourceConfigV1 + */ + readonly locale?: GetSourceConfigV1LocaleV1 +} + +/** + * Request parameters for getSourceConnectionsV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceConnectionsV1Request + */ +export interface SourcesV1ApiGetSourceConnectionsV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiGetSourceConnectionsV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getSourceEntitlementRequestConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceEntitlementRequestConfigV1Request + */ +export interface SourcesV1ApiGetSourceEntitlementRequestConfigV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiGetSourceEntitlementRequestConfigV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SourcesV1ApiGetSourceEntitlementRequestConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getSourceHealthV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceHealthV1Request + */ +export interface SourcesV1ApiGetSourceHealthV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiGetSourceHealthV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getSourceScheduleV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceScheduleV1Request + */ +export interface SourcesV1ApiGetSourceScheduleV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiGetSourceScheduleV1 + */ + readonly sourceId: string + + /** + * The Schedule type. + * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} + * @memberof SourcesV1ApiGetSourceScheduleV1 + */ + readonly scheduleType: GetSourceScheduleV1ScheduleTypeV1 +} + +/** + * Request parameters for getSourceSchedulesV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceSchedulesV1Request + */ +export interface SourcesV1ApiGetSourceSchedulesV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiGetSourceSchedulesV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for getSourceSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceSchemaV1Request + */ +export interface SourcesV1ApiGetSourceSchemaV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiGetSourceSchemaV1 + */ + readonly sourceId: string + + /** + * The Schema id. + * @type {string} + * @memberof SourcesV1ApiGetSourceSchemaV1 + */ + readonly schemaId: string +} + +/** + * Request parameters for getSourceSchemasV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceSchemasV1Request + */ +export interface SourcesV1ApiGetSourceSchemasV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiGetSourceSchemasV1 + */ + readonly sourceId: string + + /** + * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + * @type {'group' | 'user'} + * @memberof SourcesV1ApiGetSourceSchemasV1 + */ + readonly includeTypes?: GetSourceSchemasV1IncludeTypesV1 + + /** + * A comma-separated list of schema names to filter result. + * @type {string} + * @memberof SourcesV1ApiGetSourceSchemasV1 + */ + readonly includeNames?: string +} + +/** + * Request parameters for getSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiGetSourceV1Request + */ +export interface SourcesV1ApiGetSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiGetSourceV1 + */ + readonly id: string +} + +/** + * Request parameters for importAccountsSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportAccountsSchemaV1Request + */ +export interface SourcesV1ApiImportAccountsSchemaV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiImportAccountsSchemaV1 + */ + readonly id: string + + /** + * + * @type {File} + * @memberof SourcesV1ApiImportAccountsSchemaV1 + */ + readonly file?: File +} + +/** + * Request parameters for importAccountsV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportAccountsV1Request + */ +export interface SourcesV1ApiImportAccountsV1Request { + /** + * Source Id + * @type {string} + * @memberof SourcesV1ApiImportAccountsV1 + */ + readonly id: string + + /** + * The CSV file containing the source accounts to aggregate. + * @type {File} + * @memberof SourcesV1ApiImportAccountsV1 + */ + readonly file?: File + + /** + * Use this flag to reprocess every account whether or not the data has changed. + * @type {string} + * @memberof SourcesV1ApiImportAccountsV1 + */ + readonly disableOptimization?: string +} + +/** + * Request parameters for importConnectorFileV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportConnectorFileV1Request + */ +export interface SourcesV1ApiImportConnectorFileV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiImportConnectorFileV1 + */ + readonly sourceId: string + + /** + * + * @type {File} + * @memberof SourcesV1ApiImportConnectorFileV1 + */ + readonly file?: File +} + +/** + * Request parameters for importEntitlementsSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportEntitlementsSchemaV1Request + */ +export interface SourcesV1ApiImportEntitlementsSchemaV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiImportEntitlementsSchemaV1 + */ + readonly id: string + + /** + * Name of entitlement schema + * @type {string} + * @memberof SourcesV1ApiImportEntitlementsSchemaV1 + */ + readonly schemaName?: string + + /** + * + * @type {File} + * @memberof SourcesV1ApiImportEntitlementsSchemaV1 + */ + readonly file?: File +} + +/** + * Request parameters for importEntitlementsV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportEntitlementsV1Request + */ +export interface SourcesV1ApiImportEntitlementsV1Request { + /** + * Source Id + * @type {string} + * @memberof SourcesV1ApiImportEntitlementsV1 + */ + readonly sourceId: string + + /** + * The CSV file containing the source entitlements to aggregate. + * @type {File} + * @memberof SourcesV1ApiImportEntitlementsV1 + */ + readonly file?: File +} + +/** + * Request parameters for importUncorrelatedAccountsV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiImportUncorrelatedAccountsV1Request + */ +export interface SourcesV1ApiImportUncorrelatedAccountsV1Request { + /** + * Source Id + * @type {string} + * @memberof SourcesV1ApiImportUncorrelatedAccountsV1 + */ + readonly id: string + + /** + * + * @type {File} + * @memberof SourcesV1ApiImportUncorrelatedAccountsV1 + */ + readonly file?: File +} + +/** + * Request parameters for listPasswordPolicyHoldersOnSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request + */ +export interface SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiListPasswordPolicyHoldersOnSourceV1 + */ + readonly sourceId: string + + /** + * 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 SourcesV1ApiListPasswordPolicyHoldersOnSourceV1 + */ + 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 SourcesV1ApiListPasswordPolicyHoldersOnSourceV1 + */ + 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 SourcesV1ApiListPasswordPolicyHoldersOnSourceV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for listProvisioningPoliciesV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiListProvisioningPoliciesV1Request + */ +export interface SourcesV1ApiListProvisioningPoliciesV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiListProvisioningPoliciesV1 + */ + readonly sourceId: string + + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof SourcesV1ApiListProvisioningPoliciesV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof SourcesV1ApiListProvisioningPoliciesV1 + */ + readonly limit?: number +} + +/** + * Request parameters for listSourcesV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiListSourcesV1Request + */ +export interface SourcesV1ApiListSourcesV1Request { + /** + * 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 SourcesV1ApiListSourcesV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SourcesV1ApiListSourcesV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof SourcesV1ApiListSourcesV1 + */ + 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + * @type {string} + * @memberof SourcesV1ApiListSourcesV1 + */ + 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + * @type {string} + * @memberof SourcesV1ApiListSourcesV1 + */ + readonly sorters?: string + + /** + * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + * @type {string} + * @memberof SourcesV1ApiListSourcesV1 + */ + readonly forSubadmin?: string + + /** + * Include the IdentityNow source in the response. + * @type {boolean} + * @memberof SourcesV1ApiListSourcesV1 + */ + readonly includeIDNSource?: boolean +} + +/** + * Request parameters for pingClusterV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPingClusterV1Request + */ +export interface SourcesV1ApiPingClusterV1Request { + /** + * The ID of the Source + * @type {string} + * @memberof SourcesV1ApiPingClusterV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for putCorrelationConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutCorrelationConfigV1Request + */ +export interface SourcesV1ApiPutCorrelationConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiPutCorrelationConfigV1 + */ + readonly id: string + + /** + * + * @type {CorrelationconfigV1} + * @memberof SourcesV1ApiPutCorrelationConfigV1 + */ + readonly correlationconfigV1: CorrelationconfigV1 +} + +/** + * Request parameters for putNativeChangeDetectionConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutNativeChangeDetectionConfigV1Request + */ +export interface SourcesV1ApiPutNativeChangeDetectionConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiPutNativeChangeDetectionConfigV1 + */ + readonly sourceId: string + + /** + * + * @type {NativechangedetectionconfigV1} + * @memberof SourcesV1ApiPutNativeChangeDetectionConfigV1 + */ + readonly nativechangedetectionconfigV1: NativechangedetectionconfigV1 +} + +/** + * Request parameters for putProvisioningPolicyV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutProvisioningPolicyV1Request + */ +export interface SourcesV1ApiPutProvisioningPolicyV1Request { + /** + * The Source ID. + * @type {string} + * @memberof SourcesV1ApiPutProvisioningPolicyV1 + */ + readonly sourceId: string + + /** + * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @type {UsagetypeV1} + * @memberof SourcesV1ApiPutProvisioningPolicyV1 + */ + readonly usageType: UsagetypeV1 + + /** + * + * @type {ProvisioningpolicydtoV1} + * @memberof SourcesV1ApiPutProvisioningPolicyV1 + */ + readonly provisioningpolicydtoV1: ProvisioningpolicydtoV1 +} + +/** + * Request parameters for putSourceAttrSyncConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutSourceAttrSyncConfigV1Request + */ +export interface SourcesV1ApiPutSourceAttrSyncConfigV1Request { + /** + * The source id + * @type {string} + * @memberof SourcesV1ApiPutSourceAttrSyncConfigV1 + */ + readonly id: string + + /** + * + * @type {AttrsyncsourceconfigV1} + * @memberof SourcesV1ApiPutSourceAttrSyncConfigV1 + */ + readonly attrsyncsourceconfigV1: AttrsyncsourceconfigV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SourcesV1ApiPutSourceAttrSyncConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for putSourceSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutSourceSchemaV1Request + */ +export interface SourcesV1ApiPutSourceSchemaV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiPutSourceSchemaV1 + */ + readonly sourceId: string + + /** + * The Schema id. + * @type {string} + * @memberof SourcesV1ApiPutSourceSchemaV1 + */ + readonly schemaId: string + + /** + * + * @type {SchemaV1} + * @memberof SourcesV1ApiPutSourceSchemaV1 + */ + readonly schemaV1: SchemaV1 +} + +/** + * Request parameters for putSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiPutSourceV1Request + */ +export interface SourcesV1ApiPutSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiPutSourceV1 + */ + readonly id: string + + /** + * + * @type {SourceV1} + * @memberof SourcesV1ApiPutSourceV1 + */ + readonly sourceV1: SourceV1 +} + +/** + * Request parameters for searchResourceObjectsV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiSearchResourceObjectsV1Request + */ +export interface SourcesV1ApiSearchResourceObjectsV1Request { + /** + * The ID of the Source + * @type {string} + * @memberof SourcesV1ApiSearchResourceObjectsV1 + */ + readonly sourceId: string + + /** + * + * @type {ResourceobjectsrequestV1} + * @memberof SourcesV1ApiSearchResourceObjectsV1 + */ + readonly resourceobjectsrequestV1: ResourceobjectsrequestV1 +} + +/** + * Request parameters for syncAttributesForSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiSyncAttributesForSourceV1Request + */ +export interface SourcesV1ApiSyncAttributesForSourceV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiSyncAttributesForSourceV1 + */ + readonly id: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SourcesV1ApiSyncAttributesForSourceV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for testSourceConfigurationV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiTestSourceConfigurationV1Request + */ +export interface SourcesV1ApiTestSourceConfigurationV1Request { + /** + * The ID of the Source + * @type {string} + * @memberof SourcesV1ApiTestSourceConfigurationV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for testSourceConnectionV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiTestSourceConnectionV1Request + */ +export interface SourcesV1ApiTestSourceConnectionV1Request { + /** + * The ID of the Source. + * @type {string} + * @memberof SourcesV1ApiTestSourceConnectionV1 + */ + readonly sourceId: string +} + +/** + * Request parameters for updateAccountDeletionApprovalConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request + */ +export interface SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request { + /** + * Human account source ID. + * @type {string} + * @memberof SourcesV1ApiUpdateAccountDeletionApprovalConfigV1 + */ + readonly sourceId: string + + /** + * The JSONPatch payload used to update the object. + * @type {Array} + * @memberof SourcesV1ApiUpdateAccountDeletionApprovalConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateMachineAccountDeletionApprovalConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request + */ +export interface SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request { + /** + * machine account source ID. + * @type {string} + * @memberof SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1 + */ + readonly sourceId: string + + /** + * The JSONPatch payload used to update the object. + * @type {Array} + * @memberof SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updatePasswordPolicyHoldersV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdatePasswordPolicyHoldersV1Request + */ +export interface SourcesV1ApiUpdatePasswordPolicyHoldersV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiUpdatePasswordPolicyHoldersV1 + */ + readonly sourceId: string + + /** + * + * @type {Array} + * @memberof SourcesV1ApiUpdatePasswordPolicyHoldersV1 + */ + readonly passwordpolicyholdersdtoInnerV1: Array +} + +/** + * Request parameters for updateProvisioningPoliciesInBulkV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request + */ +export interface SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiUpdateProvisioningPoliciesInBulkV1 + */ + readonly sourceId: string + + /** + * + * @type {Array} + * @memberof SourcesV1ApiUpdateProvisioningPoliciesInBulkV1 + */ + readonly provisioningpolicydtoV1: Array +} + +/** + * Request parameters for updateProvisioningPolicyV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateProvisioningPolicyV1Request + */ +export interface SourcesV1ApiUpdateProvisioningPolicyV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiUpdateProvisioningPolicyV1 + */ + readonly sourceId: string + + /** + * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + * @type {UsagetypeV1} + * @memberof SourcesV1ApiUpdateProvisioningPolicyV1 + */ + readonly usageType: UsagetypeV1 + + /** + * The JSONPatch payload used to update the schema. + * @type {Array} + * @memberof SourcesV1ApiUpdateProvisioningPolicyV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateSourceEntitlementRequestConfigV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request + */ +export interface SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request { + /** + * The Source id + * @type {string} + * @memberof SourcesV1ApiUpdateSourceEntitlementRequestConfigV1 + */ + readonly id: string + + /** + * + * @type {SourceentitlementrequestconfigV1} + * @memberof SourcesV1ApiUpdateSourceEntitlementRequestConfigV1 + */ + readonly sourceentitlementrequestconfigV1: SourceentitlementrequestconfigV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof SourcesV1ApiUpdateSourceEntitlementRequestConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for updateSourceScheduleV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateSourceScheduleV1Request + */ +export interface SourcesV1ApiUpdateSourceScheduleV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiUpdateSourceScheduleV1 + */ + readonly sourceId: string + + /** + * The Schedule type. + * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} + * @memberof SourcesV1ApiUpdateSourceScheduleV1 + */ + readonly scheduleType: UpdateSourceScheduleV1ScheduleTypeV1 + + /** + * The JSONPatch payload used to update the schedule. + * @type {Array} + * @memberof SourcesV1ApiUpdateSourceScheduleV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateSourceSchemaV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateSourceSchemaV1Request + */ +export interface SourcesV1ApiUpdateSourceSchemaV1Request { + /** + * The Source id. + * @type {string} + * @memberof SourcesV1ApiUpdateSourceSchemaV1 + */ + readonly sourceId: string + + /** + * The Schema id. + * @type {string} + * @memberof SourcesV1ApiUpdateSourceSchemaV1 + */ + readonly schemaId: string + + /** + * The JSONPatch payload used to update the schema. + * @type {Array} + * @memberof SourcesV1ApiUpdateSourceSchemaV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for updateSourceV1 operation in SourcesV1Api. + * @export + * @interface SourcesV1ApiUpdateSourceV1Request + */ +export interface SourcesV1ApiUpdateSourceV1Request { + /** + * Source ID. + * @type {string} + * @memberof SourcesV1ApiUpdateSourceV1 + */ + readonly id: string + + /** + * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + * @type {Array} + * @memberof SourcesV1ApiUpdateSourceV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * SourcesV1Api - object-oriented interface + * @export + * @class SourcesV1Api + * @extends {BaseAPI} + */ +export class SourcesV1Api extends BaseAPI { + /** + * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Create provisioning policy + * @param {SourcesV1ApiCreateProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public createProvisioningPolicyV1(requestParameters: SourcesV1ApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).createProvisioningPolicyV1(requestParameters.sourceId, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + * @summary Create schedule on source + * @param {SourcesV1ApiCreateSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public createSourceScheduleV1(requestParameters: SourcesV1ApiCreateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).createSourceScheduleV1(requestParameters.sourceId, requestParameters.schedule3V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + * @summary Create schema on source + * @param {SourcesV1ApiCreateSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public createSourceSchemaV1(requestParameters: SourcesV1ApiCreateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).createSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + * @summary Creates a source in identitynow. + * @param {SourcesV1ApiCreateSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public createSourceV1(requestParameters: SourcesV1ApiCreateSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).createSourceV1(requestParameters.sourceV1, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + * @summary Remove all accounts in source + * @param {SourcesV1ApiDeleteAccountsAsyncV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteAccountsAsyncV1(requestParameters: SourcesV1ApiDeleteAccountsAsyncV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteAccountsAsyncV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes the native change detection configuration for the source specified by the given ID. + * @summary Delete native change detection configuration + * @param {SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiDeleteNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteNativeChangeDetectionConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes the provisioning policy with the specified usage on an application. + * @summary Delete provisioning policy by usagetype + * @param {SourcesV1ApiDeleteProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteProvisioningPolicyV1(requestParameters: SourcesV1ApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Delete source schedule by type. + * @param {SourcesV1ApiDeleteSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteSourceScheduleV1(requestParameters: SourcesV1ApiDeleteSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Delete source schema by id + * @param {SourcesV1ApiDeleteSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteSourceSchemaV1(requestParameters: SourcesV1ApiDeleteSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + * @summary Delete source by id + * @param {SourcesV1ApiDeleteSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public deleteSourceV1(requestParameters: SourcesV1ApiDeleteSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).deleteSourceV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. + * @summary Human Account Deletion Approval Config + * @param {SourcesV1ApiGetAccountDeleteApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getAccountDeleteApprovalConfigV1(requestParameters: SourcesV1ApiGetAccountDeleteApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getAccountDeleteApprovalConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source accounts schema template + * @param {SourcesV1ApiGetAccountsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getAccountsSchemaV1(requestParameters: SourcesV1ApiGetAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getAccountsSchemaV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the existing correlation configuration for a source specified by the given ID. + * @summary Get source correlation configuration + * @param {SourcesV1ApiGetCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getCorrelationConfigV1(requestParameters: SourcesV1ApiGetCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getCorrelationConfigV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** + * @summary Downloads source entitlements schema template + * @param {SourcesV1ApiGetEntitlementsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getEntitlementsSchemaV1(requestParameters: SourcesV1ApiGetEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getEntitlementsSchemaV1(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. + * @summary Machine Account Deletion Approval Config + * @param {SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters: SourcesV1ApiGetMachineAccountDeletionApprovalConfigBySourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getMachineAccountDeletionApprovalConfigBySourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the existing native change detection configuration for a source specified by the given ID. + * @summary Native change detection configuration + * @param {SourcesV1ApiGetNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiGetNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getNativeChangeDetectionConfigV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + * @summary Get provisioning policy by usagetype + * @param {SourcesV1ApiGetProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getProvisioningPolicyV1(requestParameters: SourcesV1ApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + * @summary Attribute sync config + * @param {SourcesV1ApiGetSourceAttrSyncConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceAttrSyncConfigV1(requestParameters: SourcesV1ApiGetSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceAttrSyncConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + * @summary Gets source config with language-translations + * @param {SourcesV1ApiGetSourceConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceConfigV1(requestParameters: SourcesV1ApiGetSourceConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceConfigV1(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source connections by id + * @param {SourcesV1ApiGetSourceConnectionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceConnectionsV1(requestParameters: SourcesV1ApiGetSourceConnectionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceConnectionsV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Get source entitlement request configuration + * @param {SourcesV1ApiGetSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceEntitlementRequestConfigV1(requestParameters: SourcesV1ApiGetSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceEntitlementRequestConfigV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint fetches source health by source\'s id + * @summary Fetches source health by id + * @param {SourcesV1ApiGetSourceHealthV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceHealthV1(requestParameters: SourcesV1ApiGetSourceHealthV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceHealthV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the source schedule by type in Identity Security Cloud (ISC). + * @summary Get source schedule by type + * @param {SourcesV1ApiGetSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceScheduleV1(requestParameters: SourcesV1ApiGetSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: + * @summary List schedules on source + * @param {SourcesV1ApiGetSourceSchedulesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceSchedulesV1(requestParameters: SourcesV1ApiGetSourceSchedulesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceSchedulesV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the Source Schema by ID in IdentityNow. + * @summary Get source schema by id + * @param {SourcesV1ApiGetSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceSchemaV1(requestParameters: SourcesV1ApiGetSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + * @summary List schemas on source + * @param {SourcesV1ApiGetSourceSchemasV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceSchemasV1(requestParameters: SourcesV1ApiGetSourceSchemasV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceSchemasV1(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + * @summary Get source by id + * @param {SourcesV1ApiGetSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public getSourceV1(requestParameters: SourcesV1ApiGetSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).getSourceV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source accounts schema template + * @param {SourcesV1ApiImportAccountsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importAccountsSchemaV1(requestParameters: SourcesV1ApiImportAccountsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importAccountsSchemaV1(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + * @summary Account aggregation + * @param {SourcesV1ApiImportAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importAccountsV1(requestParameters: SourcesV1ApiImportAccountsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importAccountsV1(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. + * @summary Upload connector file to source + * @param {SourcesV1ApiImportConnectorFileV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importConnectorFileV1(requestParameters: SourcesV1ApiImportConnectorFileV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importConnectorFileV1(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** + * @summary Uploads source entitlements schema template + * @param {SourcesV1ApiImportEntitlementsSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importEntitlementsSchemaV1(requestParameters: SourcesV1ApiImportEntitlementsSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importEntitlementsSchemaV1(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Entitlement aggregation + * @param {SourcesV1ApiImportEntitlementsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importEntitlementsV1(requestParameters: SourcesV1ApiImportEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importEntitlementsV1(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + * @summary Process uncorrelated accounts + * @param {SourcesV1ApiImportUncorrelatedAccountsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public importUncorrelatedAccountsV1(requestParameters: SourcesV1ApiImportUncorrelatedAccountsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).importUncorrelatedAccountsV1(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Get Password Policy for source + * @param {SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public listPasswordPolicyHoldersOnSourceV1(requestParameters: SourcesV1ApiListPasswordPolicyHoldersOnSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).listPasswordPolicyHoldersOnSourceV1(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point lists all the ProvisioningPolicies in IdentityNow. + * @summary Lists provisioningpolicies + * @param {SourcesV1ApiListProvisioningPoliciesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public listProvisioningPoliciesV1(requestParameters: SourcesV1ApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).listProvisioningPoliciesV1(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point lists all the sources in IdentityNow. + * @summary Lists all sources in identitynow. + * @param {SourcesV1ApiListSourcesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public listSourcesV1(requestParameters: SourcesV1ApiListSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).listSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + * @summary Ping cluster for source connector + * @param {SourcesV1ApiPingClusterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public pingClusterV1(requestParameters: SourcesV1ApiPingClusterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).pingClusterV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update source correlation configuration + * @param {SourcesV1ApiPutCorrelationConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putCorrelationConfigV1(requestParameters: SourcesV1ApiPutCorrelationConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putCorrelationConfigV1(requestParameters.id, requestParameters.correlationconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + * @summary Update native change detection configuration + * @param {SourcesV1ApiPutNativeChangeDetectionConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putNativeChangeDetectionConfigV1(requestParameters: SourcesV1ApiPutNativeChangeDetectionConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putNativeChangeDetectionConfigV1(requestParameters.sourceId, requestParameters.nativechangedetectionconfigV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Update provisioning policy by usagetype + * @param {SourcesV1ApiPutProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putProvisioningPolicyV1(requestParameters: SourcesV1ApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. + * @summary Update attribute sync config + * @param {SourcesV1ApiPutSourceAttrSyncConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putSourceAttrSyncConfigV1(requestParameters: SourcesV1ApiPutSourceAttrSyncConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putSourceAttrSyncConfigV1(requestParameters.id, requestParameters.attrsyncsourceconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + * @summary Update source schema (full) + * @param {SourcesV1ApiPutSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putSourceSchemaV1(requestParameters: SourcesV1ApiPutSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (full) + * @param {SourcesV1ApiPutSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public putSourceV1(requestParameters: SourcesV1ApiPutSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).putSourceV1(requestParameters.id, requestParameters.sourceV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieves a sample of data returned from account and group aggregation requests. + * @summary Peek source connector\'s resource objects + * @param {SourcesV1ApiSearchResourceObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public searchResourceObjectsV1(requestParameters: SourcesV1ApiSearchResourceObjectsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).searchResourceObjectsV1(requestParameters.sourceId, requestParameters.resourceobjectsrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point performs attribute synchronization for a selected source. + * @summary Synchronize single source attributes. + * @param {SourcesV1ApiSyncAttributesForSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public syncAttributesForSourceV1(requestParameters: SourcesV1ApiSyncAttributesForSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).syncAttributesForSourceV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + * @summary Test configuration for source connector + * @param {SourcesV1ApiTestSourceConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public testSourceConfigurationV1(requestParameters: SourcesV1ApiTestSourceConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).testSourceConfigurationV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + * @summary Check connection for source connector. + * @param {SourcesV1ApiTestSourceConnectionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public testSourceConnectionV1(requestParameters: SourcesV1ApiTestSourceConnectionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).testSourceConnectionV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. + * @summary Human Account Deletion Approval Config + * @param {SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateAccountDeletionApprovalConfigV1(requestParameters: SourcesV1ApiUpdateAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateAccountDeletionApprovalConfigV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. + * @summary Machine Account Deletion Approval Config + * @param {SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateMachineAccountDeletionApprovalConfigV1(requestParameters: SourcesV1ApiUpdateMachineAccountDeletionApprovalConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateMachineAccountDeletionApprovalConfigV1(requestParameters.sourceId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. + * @summary Update password policy + * @param {SourcesV1ApiUpdatePasswordPolicyHoldersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updatePasswordPolicyHoldersV1(requestParameters: SourcesV1ApiUpdatePasswordPolicyHoldersV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updatePasswordPolicyHoldersV1(requestParameters.sourceId, requestParameters.passwordpolicyholdersdtoInnerV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This end-point updates a list of provisioning policies on the specified source in IdentityNow. + * @summary Bulk update provisioning policies + * @param {SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateProvisioningPoliciesInBulkV1(requestParameters: SourcesV1ApiUpdateProvisioningPoliciesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateProvisioningPoliciesInBulkV1(requestParameters.sourceId, requestParameters.provisioningpolicydtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + * @summary Partial update of provisioning policy + * @param {SourcesV1ApiUpdateProvisioningPolicyV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateProvisioningPolicyV1(requestParameters: SourcesV1ApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateProvisioningPolicyV1(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. + * @summary Update source entitlement request configuration + * @param {SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateSourceEntitlementRequestConfigV1(requestParameters: SourcesV1ApiUpdateSourceEntitlementRequestConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateSourceEntitlementRequestConfigV1(requestParameters.id, requestParameters.sourceentitlementrequestconfigV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type + * @summary Update source schedule (partial) + * @param {SourcesV1ApiUpdateSourceScheduleV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateSourceScheduleV1(requestParameters: SourcesV1ApiUpdateSourceScheduleV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateSourceScheduleV1(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` + * @summary Update source schema (partial) + * @param {SourcesV1ApiUpdateSourceSchemaV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateSourceSchemaV1(requestParameters: SourcesV1ApiUpdateSourceSchemaV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateSourceSchemaV1(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. + * @summary Update source (partial) + * @param {SourcesV1ApiUpdateSourceV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SourcesV1Api + */ + public updateSourceV1(requestParameters: SourcesV1ApiUpdateSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SourcesV1ApiFp(this.configuration).updateSourceV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DeleteSourceScheduleV1ScheduleTypeV1 = { + AccountAggregation: 'ACCOUNT_AGGREGATION', + GroupAggregation: 'GROUP_AGGREGATION' +} as const; +export type DeleteSourceScheduleV1ScheduleTypeV1 = typeof DeleteSourceScheduleV1ScheduleTypeV1[keyof typeof DeleteSourceScheduleV1ScheduleTypeV1]; +/** + * @export + */ +export const GetSourceConfigV1LocaleV1 = { + De: 'de', + False: 'false', + Fi: 'fi', + Sv: 'sv', + Ru: 'ru', + Pt: 'pt', + Ko: 'ko', + ZhTw: 'zh-TW', + En: 'en', + It: 'it', + Fr: 'fr', + ZhCn: 'zh-CN', + Hu: 'hu', + Es: 'es', + Cs: 'cs', + Ja: 'ja', + Pl: 'pl', + Da: 'da', + Nl: 'nl' +} as const; +export type GetSourceConfigV1LocaleV1 = typeof GetSourceConfigV1LocaleV1[keyof typeof GetSourceConfigV1LocaleV1]; +/** + * @export + */ +export const GetSourceScheduleV1ScheduleTypeV1 = { + AccountAggregation: 'ACCOUNT_AGGREGATION', + GroupAggregation: 'GROUP_AGGREGATION' +} as const; +export type GetSourceScheduleV1ScheduleTypeV1 = typeof GetSourceScheduleV1ScheduleTypeV1[keyof typeof GetSourceScheduleV1ScheduleTypeV1]; +/** + * @export + */ +export const GetSourceSchemasV1IncludeTypesV1 = { + Group: 'group', + User: 'user' +} as const; +export type GetSourceSchemasV1IncludeTypesV1 = typeof GetSourceSchemasV1IncludeTypesV1[keyof typeof GetSourceSchemasV1IncludeTypesV1]; +/** + * @export + */ +export const UpdateSourceScheduleV1ScheduleTypeV1 = { + AccountAggregation: 'ACCOUNT_AGGREGATION', + GroupAggregation: 'GROUP_AGGREGATION' +} as const; +export type UpdateSourceScheduleV1ScheduleTypeV1 = typeof UpdateSourceScheduleV1ScheduleTypeV1[keyof typeof UpdateSourceScheduleV1ScheduleTypeV1]; + + diff --git a/sdk-output/sources/base.ts b/sdk-output/sources/base.ts new file mode 100644 index 00000000..bdbb690c --- /dev/null +++ b/sdk-output/sources/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Sources + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/sources/common.ts b/sdk-output/sources/common.ts new file mode 100644 index 00000000..ee63475a --- /dev/null +++ b/sdk-output/sources/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Sources + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/sources/configuration.ts b/sdk-output/sources/configuration.ts new file mode 100644 index 00000000..b5d503e5 --- /dev/null +++ b/sdk-output/sources/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Sources + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/sources/git_push.sh b/sdk-output/sources/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/sources/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/sources/index.ts b/sdk-output/sources/index.ts new file mode 100644 index 00000000..3d6cbcc9 --- /dev/null +++ b/sdk-output/sources/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Sources + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/sources/package.json b/sdk-output/sources/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/sources/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/sources/tsconfig.json b/sdk-output/sources/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/sources/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/sp_config/.gitignore b/sdk-output/sp_config/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/sp_config/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/sp_config/.npmignore b/sdk-output/sp_config/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/sp_config/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/sp_config/.openapi-generator-ignore b/sdk-output/sp_config/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/sp_config/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/sp_config/.openapi-generator/FILES b/sdk-output/sp_config/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/sp_config/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/sp_config/.openapi-generator/VERSION b/sdk-output/sp_config/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/sp_config/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/sp_config/.sdk-partition b/sdk-output/sp_config/.sdk-partition new file mode 100644 index 00000000..da8daf06 --- /dev/null +++ b/sdk-output/sp_config/.sdk-partition @@ -0,0 +1 @@ +sp-config \ No newline at end of file diff --git a/sdk-output/sp_config/README.md b/sdk-output/sp_config/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sp_config/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sp_config/api.ts b/sdk-output/sp_config/api.ts new file mode 100644 index 00000000..e2b59f87 --- /dev/null +++ b/sdk-output/sp_config/api.ts @@ -0,0 +1,1672 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SP-Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * Config export and import format for individual object configurations. + * @export + * @interface ConfigobjectV1 + */ +export interface ConfigobjectV1 { + /** + * Current version of configuration object. + * @type {number} + * @memberof ConfigobjectV1 + */ + 'version'?: number; + /** + * + * @type {SelfimportexportdtoV1} + * @memberof ConfigobjectV1 + */ + 'self'?: SelfimportexportdtoV1; + /** + * Object details. Format dependant on the object type. + * @type {{ [key: string]: any; }} + * @memberof ConfigobjectV1 + */ + 'object'?: { [key: string]: any; }; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ExportSpConfigV1401ResponseV1 + */ +export interface ExportSpConfigV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ExportSpConfigV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ExportSpConfigV1429ResponseV1 + */ +export interface ExportSpConfigV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ExportSpConfigV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface ExportoptionsV1 + */ +export interface ExportoptionsV1 { + /** + * Object type names to be excluded from an sp-config export command. + * @type {Array} + * @memberof ExportoptionsV1 + */ + 'excludeTypes'?: Array; + /** + * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. + * @type {Array} + * @memberof ExportoptionsV1 + */ + 'includeTypes'?: Array; + /** + * Additional options targeting specific objects related to each item in the includeTypes field + * @type {{ [key: string]: ObjectexportimportoptionsV1; }} + * @memberof ExportoptionsV1 + */ + 'objectOptions'?: { [key: string]: ObjectexportimportoptionsV1; }; +} + +export const ExportoptionsV1ExcludeTypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + ConnectorRule: 'CONNECTOR_RULE', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ExportoptionsV1ExcludeTypesV1 = typeof ExportoptionsV1ExcludeTypesV1[keyof typeof ExportoptionsV1ExcludeTypesV1]; +export const ExportoptionsV1IncludeTypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + ConnectorRule: 'CONNECTOR_RULE', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ExportoptionsV1IncludeTypesV1 = typeof ExportoptionsV1IncludeTypesV1[keyof typeof ExportoptionsV1IncludeTypesV1]; + +/** + * + * @export + * @interface ExportpayloadV1 + */ +export interface ExportpayloadV1 { + /** + * Optional user defined description/name for export job. + * @type {string} + * @memberof ExportpayloadV1 + */ + 'description'?: string; + /** + * Object type names to be excluded from an sp-config export command. + * @type {Array} + * @memberof ExportpayloadV1 + */ + 'excludeTypes'?: Array; + /** + * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. + * @type {Array} + * @memberof ExportpayloadV1 + */ + 'includeTypes'?: Array; + /** + * Additional options targeting specific objects related to each item in the includeTypes field + * @type {{ [key: string]: ObjectexportimportoptionsV1; }} + * @memberof ExportpayloadV1 + */ + 'objectOptions'?: { [key: string]: ObjectexportimportoptionsV1; }; +} + +export const ExportpayloadV1ExcludeTypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + ConnectorRule: 'CONNECTOR_RULE', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ExportpayloadV1ExcludeTypesV1 = typeof ExportpayloadV1ExcludeTypesV1[keyof typeof ExportpayloadV1ExcludeTypesV1]; +export const ExportpayloadV1IncludeTypesV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + ConnectorRule: 'CONNECTOR_RULE', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type ExportpayloadV1IncludeTypesV1 = typeof ExportpayloadV1IncludeTypesV1[keyof typeof ExportpayloadV1IncludeTypesV1]; + +/** + * + * @export + * @interface ImportSpConfigV1RequestV1 + */ +export interface ImportSpConfigV1RequestV1 { + /** + * JSON file containing the objects to be imported. + * @type {File} + * @memberof ImportSpConfigV1RequestV1 + */ + 'data': File; + /** + * + * @type {ImportoptionsV1} + * @memberof ImportSpConfigV1RequestV1 + */ + 'options'?: ImportoptionsV1; +} +/** + * Object created or updated by import. + * @export + * @interface ImportobjectV1 + */ +export interface ImportobjectV1 { + /** + * DTO type of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'type'?: ImportobjectV1TypeV1; + /** + * ID of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'id'?: string; + /** + * Display name of object created or updated by import. + * @type {string} + * @memberof ImportobjectV1 + */ + 'name'?: string; +} + +export const ImportobjectV1TypeV1 = { + ConnectorRule: 'CONNECTOR_RULE', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + Rule: 'RULE', + Source: 'SOURCE', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION' +} as const; + +export type ImportobjectV1TypeV1 = typeof ImportobjectV1TypeV1[keyof typeof ImportobjectV1TypeV1]; + +/** + * + * @export + * @interface ImportoptionsV1 + */ +export interface ImportoptionsV1 { + /** + * Object type names to be excluded from an sp-config export command. + * @type {Array} + * @memberof ImportoptionsV1 + */ + 'excludeTypes'?: Array; + /** + * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. + * @type {Array} + * @memberof ImportoptionsV1 + */ + 'includeTypes'?: Array; + /** + * Additional options targeting specific objects related to each item in the includeTypes field + * @type {{ [key: string]: ObjectexportimportoptionsV1; }} + * @memberof ImportoptionsV1 + */ + 'objectOptions'?: { [key: string]: ObjectexportimportoptionsV1; }; + /** + * List of object types that can be used to resolve references on import. + * @type {Array} + * @memberof ImportoptionsV1 + */ + 'defaultReferences'?: Array; + /** + * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. + * @type {boolean} + * @memberof ImportoptionsV1 + */ + 'excludeBackup'?: boolean; +} + +export const ImportoptionsV1ExcludeTypesV1 = { + ConnectorRule: 'CONNECTOR_RULE', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + Rule: 'RULE', + Source: 'SOURCE', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION' +} as const; + +export type ImportoptionsV1ExcludeTypesV1 = typeof ImportoptionsV1ExcludeTypesV1[keyof typeof ImportoptionsV1ExcludeTypesV1]; +export const ImportoptionsV1IncludeTypesV1 = { + ConnectorRule: 'CONNECTOR_RULE', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + Rule: 'RULE', + Source: 'SOURCE', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION' +} as const; + +export type ImportoptionsV1IncludeTypesV1 = typeof ImportoptionsV1IncludeTypesV1[keyof typeof ImportoptionsV1IncludeTypesV1]; +export const ImportoptionsV1DefaultReferencesV1 = { + ConnectorRule: 'CONNECTOR_RULE', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + Rule: 'RULE', + Source: 'SOURCE', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION' +} as const; + +export type ImportoptionsV1DefaultReferencesV1 = typeof ImportoptionsV1DefaultReferencesV1[keyof typeof ImportoptionsV1DefaultReferencesV1]; + +/** + * 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ObjectexportimportoptionsV1 + */ +export interface ObjectexportimportoptionsV1 { + /** + * Object ids to be included in an import or export. + * @type {Array} + * @memberof ObjectexportimportoptionsV1 + */ + 'includedIds'?: Array; + /** + * Object names to be included in an import or export. + * @type {Array} + * @memberof ObjectexportimportoptionsV1 + */ + 'includedNames'?: Array; +} +/** + * Response model for import of a single object. + * @export + * @interface Objectimportresult2V1 + */ +export interface Objectimportresult2V1 { + /** + * Informational messages returned from the target service on import. + * @type {Array} + * @memberof Objectimportresult2V1 + */ + 'infos': Array; + /** + * Warning messages returned from the target service on import. + * @type {Array} + * @memberof Objectimportresult2V1 + */ + 'warnings': Array; + /** + * Error messages returned from the target service on import. + * @type {Array} + * @memberof Objectimportresult2V1 + */ + 'errors': Array; + /** + * References to objects that were created or updated by the import. + * @type {Array} + * @memberof Objectimportresult2V1 + */ + 'importedObjects': Array; +} +/** + * Self block for imported/exported object. + * @export + * @interface SelfimportexportdtoV1 + */ +export interface SelfimportexportdtoV1 { + /** + * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. + * @type {string} + * @memberof SelfimportexportdtoV1 + */ + 'type'?: SelfimportexportdtoV1TypeV1; + /** + * Imported/exported object\'s ID. + * @type {string} + * @memberof SelfimportexportdtoV1 + */ + 'id'?: string; + /** + * Imported/exported object\'s display name. + * @type {string} + * @memberof SelfimportexportdtoV1 + */ + 'name'?: string; +} + +export const SelfimportexportdtoV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', + AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', + AuthOrg: 'AUTH_ORG', + CampaignFilter: 'CAMPAIGN_FILTER', + ConnectorRule: 'CONNECTOR_RULE', + FormDefinition: 'FORM_DEFINITION', + GovernanceGroup: 'GOVERNANCE_GROUP', + IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', + IdentityProfile: 'IDENTITY_PROFILE', + LifecycleState: 'LIFECYCLE_STATE', + NotificationTemplate: 'NOTIFICATION_TEMPLATE', + PasswordPolicy: 'PASSWORD_POLICY', + PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', + PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', + Role: 'ROLE', + Rule: 'RULE', + Segment: 'SEGMENT', + ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE', + Tag: 'TAG', + Transform: 'TRANSFORM', + TriggerSubscription: 'TRIGGER_SUBSCRIPTION', + Workflow: 'WORKFLOW' +} as const; + +export type SelfimportexportdtoV1TypeV1 = typeof SelfimportexportdtoV1TypeV1[keyof typeof SelfimportexportdtoV1TypeV1]; + +/** + * + * @export + * @interface SpconfigexportjobV1 + */ +export interface SpconfigexportjobV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'jobId': string; + /** + * Status of the job. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'status': SpconfigexportjobV1StatusV1; + /** + * Type of the job, either export or import. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'type': SpconfigexportjobV1TypeV1; + /** + * The time until which the artifacts will be available for download. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'expiration'?: string; + /** + * The time the job was started. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'created': string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'modified': string; + /** + * Optional user defined description/name for export job. + * @type {string} + * @memberof SpconfigexportjobV1 + */ + 'description'?: string; +} + +export const SpconfigexportjobV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type SpconfigexportjobV1StatusV1 = typeof SpconfigexportjobV1StatusV1[keyof typeof SpconfigexportjobV1StatusV1]; +export const SpconfigexportjobV1TypeV1 = { + Export: 'EXPORT', + Import: 'IMPORT' +} as const; + +export type SpconfigexportjobV1TypeV1 = typeof SpconfigexportjobV1TypeV1[keyof typeof SpconfigexportjobV1TypeV1]; + +/** + * + * @export + * @interface SpconfigexportjobstatusV1 + */ +export interface SpconfigexportjobstatusV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'jobId': string; + /** + * Status of the job. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'status': SpconfigexportjobstatusV1StatusV1; + /** + * Type of the job, either export or import. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'type': SpconfigexportjobstatusV1TypeV1; + /** + * The time until which the artifacts will be available for download. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'expiration'?: string; + /** + * The time the job was started. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'created': string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'modified': string; + /** + * Optional user defined description/name for export job. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'description'?: string; + /** + * The time the job was completed. + * @type {string} + * @memberof SpconfigexportjobstatusV1 + */ + 'completed'?: string; +} + +export const SpconfigexportjobstatusV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type SpconfigexportjobstatusV1StatusV1 = typeof SpconfigexportjobstatusV1StatusV1[keyof typeof SpconfigexportjobstatusV1StatusV1]; +export const SpconfigexportjobstatusV1TypeV1 = { + Export: 'EXPORT', + Import: 'IMPORT' +} as const; + +export type SpconfigexportjobstatusV1TypeV1 = typeof SpconfigexportjobstatusV1TypeV1[keyof typeof SpconfigexportjobstatusV1TypeV1]; + +/** + * Response model for config export download response. + * @export + * @interface SpconfigexportresultsV1 + */ +export interface SpconfigexportresultsV1 { + /** + * Current version of the export results object. + * @type {number} + * @memberof SpconfigexportresultsV1 + */ + 'version'?: number; + /** + * Time the export was completed. + * @type {string} + * @memberof SpconfigexportresultsV1 + */ + 'timestamp'?: string; + /** + * Name of the tenant where this export originated. + * @type {string} + * @memberof SpconfigexportresultsV1 + */ + 'tenant'?: string; + /** + * Optional user defined description/name for export job. + * @type {string} + * @memberof SpconfigexportresultsV1 + */ + 'description'?: string; + /** + * + * @type {ExportoptionsV1} + * @memberof SpconfigexportresultsV1 + */ + 'options'?: ExportoptionsV1; + /** + * + * @type {Array} + * @memberof SpconfigexportresultsV1 + */ + 'objects'?: Array; +} +/** + * + * @export + * @interface SpconfigimportjobstatusV1 + */ +export interface SpconfigimportjobstatusV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'jobId': string; + /** + * Status of the job. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'status': SpconfigimportjobstatusV1StatusV1; + /** + * Type of the job, either export or import. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'type': SpconfigimportjobstatusV1TypeV1; + /** + * The time until which the artifacts will be available for download. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'expiration'?: string; + /** + * The time the job was started. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'created': string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'modified': string; + /** + * This message contains additional information about the overall status of the job. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'message'?: string; + /** + * The time the job was completed. + * @type {string} + * @memberof SpconfigimportjobstatusV1 + */ + 'completed'?: string; +} + +export const SpconfigimportjobstatusV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type SpconfigimportjobstatusV1StatusV1 = typeof SpconfigimportjobstatusV1StatusV1[keyof typeof SpconfigimportjobstatusV1StatusV1]; +export const SpconfigimportjobstatusV1TypeV1 = { + Export: 'EXPORT', + Import: 'IMPORT' +} as const; + +export type SpconfigimportjobstatusV1TypeV1 = typeof SpconfigimportjobstatusV1TypeV1[keyof typeof SpconfigimportjobstatusV1TypeV1]; + +/** + * Response Body for Config Import command. + * @export + * @interface SpconfigimportresultsV1 + */ +export interface SpconfigimportresultsV1 { + /** + * The results of an object configuration import job. + * @type {{ [key: string]: Objectimportresult2V1; }} + * @memberof SpconfigimportresultsV1 + */ + 'results': { [key: string]: Objectimportresult2V1; }; + /** + * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. + * @type {string} + * @memberof SpconfigimportresultsV1 + */ + 'exportJobId'?: string; +} +/** + * + * @export + * @interface SpconfigjobV1 + */ +export interface SpconfigjobV1 { + /** + * Unique id assigned to this job. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'jobId': string; + /** + * Status of the job. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'status': SpconfigjobV1StatusV1; + /** + * Type of the job, either export or import. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'type': SpconfigjobV1TypeV1; + /** + * The time until which the artifacts will be available for download. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'expiration'?: string; + /** + * The time the job was started. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'created': string; + /** + * The time of the last update to the job. + * @type {string} + * @memberof SpconfigjobV1 + */ + 'modified': string; +} + +export const SpconfigjobV1StatusV1 = { + NotStarted: 'NOT_STARTED', + InProgress: 'IN_PROGRESS', + Complete: 'COMPLETE', + Cancelled: 'CANCELLED', + Failed: 'FAILED' +} as const; + +export type SpconfigjobV1StatusV1 = typeof SpconfigjobV1StatusV1[keyof typeof SpconfigjobV1StatusV1]; +export const SpconfigjobV1TypeV1 = { + Export: 'EXPORT', + Import: 'IMPORT' +} as const; + +export type SpconfigjobV1TypeV1 = typeof SpconfigjobV1TypeV1[keyof typeof SpconfigjobV1TypeV1]; + +/** + * Message model for Config Import/Export. + * @export + * @interface Spconfigmessage2V1 + */ +export interface Spconfigmessage2V1 { + /** + * Message key. + * @type {string} + * @memberof Spconfigmessage2V1 + */ + 'key': string; + /** + * Message text. + * @type {string} + * @memberof Spconfigmessage2V1 + */ + 'text': string; + /** + * Message details if any, in key:value pairs. + * @type {{ [key: string]: object; }} + * @memberof Spconfigmessage2V1 + */ + 'details': { [key: string]: object; }; +} +/** + * Response model for object configuration. + * @export + * @interface SpconfigobjectV1 + */ +export interface SpconfigobjectV1 { + /** + * Object type the configuration is for. + * @type {string} + * @memberof SpconfigobjectV1 + */ + 'objectType'?: string; + /** + * List of JSON paths within an exported object of this type, representing references that must be resolved. + * @type {Array} + * @memberof SpconfigobjectV1 + */ + 'referenceExtractors'?: Array | null; + /** + * Indicates whether this type of object will be JWS signed and cannot be modified before import. + * @type {boolean} + * @memberof SpconfigobjectV1 + */ + 'signatureRequired'?: boolean; + /** + * Indicates whether this object type must be always be resolved by ID. + * @type {boolean} + * @memberof SpconfigobjectV1 + */ + 'alwaysResolveById'?: boolean; + /** + * Indicates whether this is a legacy object. + * @type {boolean} + * @memberof SpconfigobjectV1 + */ + 'legacyObject'?: boolean; + /** + * Indicates whether there is only one object of this type. + * @type {boolean} + * @memberof SpconfigobjectV1 + */ + 'onePerTenant'?: boolean; + /** + * Indicates whether the object can be exported or is just a reference object. + * @type {boolean} + * @memberof SpconfigobjectV1 + */ + 'exportable'?: boolean; + /** + * + * @type {SpconfigrulesV1} + * @memberof SpconfigobjectV1 + */ + 'rules'?: SpconfigrulesV1; +} +/** + * Format of Config Hub object rules. + * @export + * @interface SpconfigruleV1 + */ +export interface SpconfigruleV1 { + /** + * JSONPath expression denoting the path within the object where a value substitution should be applied. + * @type {string} + * @memberof SpconfigruleV1 + */ + 'path'?: string; + /** + * + * @type {SpconfigruleValueV1} + * @memberof SpconfigruleV1 + */ + 'value'?: SpconfigruleValueV1 | null; + /** + * Draft modes the rule will apply to. + * @type {Array} + * @memberof SpconfigruleV1 + */ + 'modes'?: Array; +} + +export const SpconfigruleV1ModesV1 = { + Restore: 'RESTORE', + Promote: 'PROMOTE', + Upload: 'UPLOAD' +} as const; + +export type SpconfigruleV1ModesV1 = typeof SpconfigruleV1ModesV1[keyof typeof SpconfigruleV1ModesV1]; + +/** + * Value to be assigned at the jsonPath location within the object. + * @export + * @interface SpconfigruleValueV1 + */ +export interface SpconfigruleValueV1 { +} +/** + * Rules to be applied to the config object during the draft process. + * @export + * @interface SpconfigrulesV1 + */ +export interface SpconfigrulesV1 { + /** + * + * @type {Array} + * @memberof SpconfigrulesV1 + */ + 'takeFromTargetRules'?: Array; + /** + * + * @type {Array} + * @memberof SpconfigrulesV1 + */ + 'defaultRules'?: Array; + /** + * Indicates whether the object can be edited. + * @type {boolean} + * @memberof SpconfigrulesV1 + */ + 'editable'?: boolean; +} + +/** + * SPConfigV1Api - axios parameter creator + * @export + */ +export const SPConfigV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects export job + * @param {ExportpayloadV1} exportpayloadV1 Export options control what will be included in the export. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportSpConfigV1: async (exportpayloadV1: ExportpayloadV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'exportpayloadV1' is not null or undefined + assertParamExists('exportSpConfigV1', 'exportpayloadV1', exportpayloadV1) + const localVarPath = `/sp-config/v1/export`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(exportpayloadV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Get export job status + * @param {string} id The ID of the export job whose status will be returned. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigExportStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSpConfigExportStatusV1', 'id', id) + const localVarPath = `/sp-config/v1/export/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Download export job result. + * @param {string} id The ID of the export job whose results will be downloaded. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigExportV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSpConfigExportV1', 'id', id) + const localVarPath = `/sp-config/v1/export/{id}/download` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' + * @summary Get import job status + * @param {string} id The ID of the import job whose status will be returned. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigImportStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSpConfigImportStatusV1', 'id', id) + const localVarPath = `/sp-config/v1/import/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage + * @summary Download import job result + * @param {string} id The ID of the import job whose results will be downloaded. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigImportV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getSpConfigImportV1', 'id', id) + const localVarPath = `/sp-config/v1/import/{id}/download` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects import job + * @param {File} data JSON file containing the objects to be imported. + * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + * @param {ImportoptionsV1} [_options] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importSpConfigV1: async (data: File, preview?: boolean, _options?: ImportoptionsV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'data' is not null or undefined + assertParamExists('importSpConfigV1', 'data', data) + const localVarPath = `/sp-config/v1/import`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + if (preview !== undefined) { + localVarQueryParameter['preview'] = preview; + } + + + if (data !== undefined) { + localVarFormParams.append('data', data as any); + } + + if (_options !== undefined) { + localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get a list of object configurations that the tenant export/import service knows. + * @summary List config objects + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSpConfigObjectsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/sp-config/v1/config-objects`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SPConfigV1Api - functional programming interface + * @export + */ +export const SPConfigV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SPConfigV1ApiAxiosParamCreator(configuration) + return { + /** + * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects export job + * @param {ExportpayloadV1} exportpayloadV1 Export options control what will be included in the export. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async exportSpConfigV1(exportpayloadV1: ExportpayloadV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfigV1(exportpayloadV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.exportSpConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Get export job status + * @param {string} id The ID of the export job whose status will be returned. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSpConfigExportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.getSpConfigExportStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Download export job result. + * @param {string} id The ID of the export job whose results will be downloaded. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSpConfigExportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.getSpConfigExportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' + * @summary Get import job status + * @param {string} id The ID of the import job whose status will be returned. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSpConfigImportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.getSpConfigImportStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage + * @summary Download import job result + * @param {string} id The ID of the import job whose results will be downloaded. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSpConfigImportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.getSpConfigImportV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects import job + * @param {File} data JSON file containing the objects to be imported. + * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + * @param {ImportoptionsV1} [_options] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async importSpConfigV1(data: File, preview?: boolean, _options?: ImportoptionsV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfigV1(data, preview, _options, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.importSpConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a list of object configurations that the tenant export/import service knows. + * @summary List config objects + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjectsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SPConfigV1Api.listSpConfigObjectsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SPConfigV1Api - factory interface + * @export + */ +export const SPConfigV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SPConfigV1ApiFp(configuration) + return { + /** + * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects export job + * @param {SPConfigV1ApiExportSpConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + exportSpConfigV1(requestParameters: SPConfigV1ApiExportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.exportSpConfigV1(requestParameters.exportpayloadV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Get export job status + * @param {SPConfigV1ApiGetSpConfigExportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigExportStatusV1(requestParameters: SPConfigV1ApiGetSpConfigExportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSpConfigExportStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Download export job result. + * @param {SPConfigV1ApiGetSpConfigExportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigExportV1(requestParameters: SPConfigV1ApiGetSpConfigExportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSpConfigExportV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' + * @summary Get import job status + * @param {SPConfigV1ApiGetSpConfigImportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigImportStatusV1(requestParameters: SPConfigV1ApiGetSpConfigImportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSpConfigImportStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage + * @summary Download import job result + * @param {SPConfigV1ApiGetSpConfigImportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSpConfigImportV1(requestParameters: SPConfigV1ApiGetSpConfigImportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSpConfigImportV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects import job + * @param {SPConfigV1ApiImportSpConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + importSpConfigV1(requestParameters: SPConfigV1ApiImportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.importSpConfigV1(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a list of object configurations that the tenant export/import service knows. + * @summary List config objects + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSpConfigObjectsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for exportSpConfigV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiExportSpConfigV1Request + */ +export interface SPConfigV1ApiExportSpConfigV1Request { + /** + * Export options control what will be included in the export. + * @type {ExportpayloadV1} + * @memberof SPConfigV1ApiExportSpConfigV1 + */ + readonly exportpayloadV1: ExportpayloadV1 +} + +/** + * Request parameters for getSpConfigExportStatusV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiGetSpConfigExportStatusV1Request + */ +export interface SPConfigV1ApiGetSpConfigExportStatusV1Request { + /** + * The ID of the export job whose status will be returned. + * @type {string} + * @memberof SPConfigV1ApiGetSpConfigExportStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for getSpConfigExportV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiGetSpConfigExportV1Request + */ +export interface SPConfigV1ApiGetSpConfigExportV1Request { + /** + * The ID of the export job whose results will be downloaded. + * @type {string} + * @memberof SPConfigV1ApiGetSpConfigExportV1 + */ + readonly id: string +} + +/** + * Request parameters for getSpConfigImportStatusV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiGetSpConfigImportStatusV1Request + */ +export interface SPConfigV1ApiGetSpConfigImportStatusV1Request { + /** + * The ID of the import job whose status will be returned. + * @type {string} + * @memberof SPConfigV1ApiGetSpConfigImportStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for getSpConfigImportV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiGetSpConfigImportV1Request + */ +export interface SPConfigV1ApiGetSpConfigImportV1Request { + /** + * The ID of the import job whose results will be downloaded. + * @type {string} + * @memberof SPConfigV1ApiGetSpConfigImportV1 + */ + readonly id: string +} + +/** + * Request parameters for importSpConfigV1 operation in SPConfigV1Api. + * @export + * @interface SPConfigV1ApiImportSpConfigV1Request + */ +export interface SPConfigV1ApiImportSpConfigV1Request { + /** + * JSON file containing the objects to be imported. + * @type {File} + * @memberof SPConfigV1ApiImportSpConfigV1 + */ + readonly data: File + + /** + * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + * @type {boolean} + * @memberof SPConfigV1ApiImportSpConfigV1 + */ + readonly preview?: boolean + + /** + * + * @type {ImportoptionsV1} + * @memberof SPConfigV1ApiImportSpConfigV1 + */ + readonly _options?: ImportoptionsV1 +} + +/** + * SPConfigV1Api - object-oriented interface + * @export + * @class SPConfigV1Api + * @extends {BaseAPI} + */ +export class SPConfigV1Api extends BaseAPI { + /** + * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects export job + * @param {SPConfigV1ApiExportSpConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public exportSpConfigV1(requestParameters: SPConfigV1ApiExportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).exportSpConfigV1(requestParameters.exportpayloadV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Get export job status + * @param {SPConfigV1ApiGetSpConfigExportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public getSpConfigExportStatusV1(requestParameters: SPConfigV1ApiGetSpConfigExportStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).getSpConfigExportStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage + * @summary Download export job result. + * @param {SPConfigV1ApiGetSpConfigExportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public getSpConfigExportV1(requestParameters: SPConfigV1ApiGetSpConfigExportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).getSpConfigExportV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' + * @summary Get import job status + * @param {SPConfigV1ApiGetSpConfigImportStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public getSpConfigImportStatusV1(requestParameters: SPConfigV1ApiGetSpConfigImportStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).getSpConfigImportStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage + * @summary Download import job result + * @param {SPConfigV1ApiGetSpConfigImportV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public getSpConfigImportV1(requestParameters: SPConfigV1ApiGetSpConfigImportV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).getSpConfigImportV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + * @summary Initiates configuration objects import job + * @param {SPConfigV1ApiImportSpConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public importSpConfigV1(requestParameters: SPConfigV1ApiImportSpConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).importSpConfigV1(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a list of object configurations that the tenant export/import service knows. + * @summary List config objects + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SPConfigV1Api + */ + public listSpConfigObjectsV1(axiosOptions?: RawAxiosRequestConfig) { + return SPConfigV1ApiFp(this.configuration).listSpConfigObjectsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/sp_config/base.ts b/sdk-output/sp_config/base.ts new file mode 100644 index 00000000..0c5841b1 --- /dev/null +++ b/sdk-output/sp_config/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SP-Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/sp_config/common.ts b/sdk-output/sp_config/common.ts new file mode 100644 index 00000000..93727579 --- /dev/null +++ b/sdk-output/sp_config/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SP-Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "../configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/sp_config/configuration.ts b/sdk-output/sp_config/configuration.ts new file mode 100644 index 00000000..69112116 --- /dev/null +++ b/sdk-output/sp_config/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SP-Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/sp_config/git_push.sh b/sdk-output/sp_config/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/sp_config/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/sp_config/index.ts b/sdk-output/sp_config/index.ts new file mode 100644 index 00000000..1494f9b6 --- /dev/null +++ b/sdk-output/sp_config/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - SP-Config + * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/sp_config/package.json b/sdk-output/sp_config/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/sp_config/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/sp_config/tsconfig.json b/sdk-output/sp_config/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/sp_config/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/suggested_entitlement_description/.gitignore b/sdk-output/suggested_entitlement_description/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/suggested_entitlement_description/.npmignore b/sdk-output/suggested_entitlement_description/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/suggested_entitlement_description/.openapi-generator-ignore b/sdk-output/suggested_entitlement_description/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/suggested_entitlement_description/.openapi-generator/FILES b/sdk-output/suggested_entitlement_description/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/suggested_entitlement_description/.openapi-generator/VERSION b/sdk-output/suggested_entitlement_description/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/suggested_entitlement_description/.sdk-partition b/sdk-output/suggested_entitlement_description/.sdk-partition new file mode 100644 index 00000000..3259277b --- /dev/null +++ b/sdk-output/suggested_entitlement_description/.sdk-partition @@ -0,0 +1 @@ +suggested-entitlement-description \ No newline at end of file diff --git a/sdk-output/suggested_entitlement_description/README.md b/sdk-output/suggested_entitlement_description/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/suggested_entitlement_description/api.ts b/sdk-output/suggested_entitlement_description/api.ts new file mode 100644 index 00000000..362c898d --- /dev/null +++ b/sdk-output/suggested_entitlement_description/api.ts @@ -0,0 +1,2708 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Suggested Entitlement Description + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * Auto-Write Setting for SED + * @export + * @interface AutowritesettingV1 + */ +export interface AutowritesettingV1 { + /** + * Whether auto-write is currently enabled for the tenant + * @type {boolean} + * @memberof AutowritesettingV1 + */ + 'enabled'?: boolean; + /** + * Source IDs in the allowlist. Empty array means not in allowlist mode. + * @type {Array} + * @memberof AutowritesettingV1 + */ + 'includedSourceIds'?: Array | null; + /** + * Source IDs to exclude from auto-write. Always applied. + * @type {Array} + * @memberof AutowritesettingV1 + */ + 'excludedSourceIds'?: Array | null; +} +/** + * Patch operation for Auto-Write Setting + * @export + * @interface AutowritesettingpatchV1 + */ +export interface AutowritesettingpatchV1 { + /** + * The operation to perform. Only \"replace\" is supported. + * @type {string} + * @memberof AutowritesettingpatchV1 + */ + 'op': AutowritesettingpatchV1OpV1; + /** + * The field to update. Allowed values: /enabled, /includedSourceIds, /excludedSourceIds + * @type {string} + * @memberof AutowritesettingpatchV1 + */ + 'path': string; + /** + * + * @type {AutowritesettingpatchValueV1} + * @memberof AutowritesettingpatchV1 + */ + 'value': AutowritesettingpatchValueV1; +} + +export const AutowritesettingpatchV1OpV1 = { + Replace: 'replace' +} as const; + +export type AutowritesettingpatchV1OpV1 = typeof AutowritesettingpatchV1OpV1[keyof typeof AutowritesettingpatchV1OpV1]; + +/** + * @type AutowritesettingpatchValueV1 + * The new value for the field + * @export + */ +export type AutowritesettingpatchValueV1 = Array | boolean; + +/** + * Auto-Write Setting response with timestamps + * @export + * @interface AutowritesettingresponseV1 + */ +export interface AutowritesettingresponseV1 { + /** + * Whether auto-write is currently enabled for the tenant + * @type {boolean} + * @memberof AutowritesettingresponseV1 + */ + 'enabled'?: boolean; + /** + * Source IDs in the allowlist. Empty array means not in allowlist mode. + * @type {Array} + * @memberof AutowritesettingresponseV1 + */ + 'includedSourceIds'?: Array | null; + /** + * Source IDs to exclude from auto-write. Always applied. + * @type {Array} + * @memberof AutowritesettingresponseV1 + */ + 'excludedSourceIds'?: Array | null; + /** + * When settings were first created + * @type {string} + * @memberof AutowritesettingresponseV1 + */ + 'createdAt'?: string; + /** + * When settings were last modified + * @type {string} + * @memberof AutowritesettingresponseV1 + */ + 'updatedAt'?: string; +} +/** + * A single item in a bulk entitlement recommendation approval request. The recordType is optional; the backend resolves the type by ID lookup when omitted. Description applies to SED items only; privilegeLevel is required for privilege items. + * @export + * @interface BulkapproveentitlementrecommendationitemV1 + */ +export interface BulkapproveentitlementrecommendationitemV1 { + /** + * The unique identifier of the recommendation record to approve. + * @type {string} + * @memberof BulkapproveentitlementrecommendationitemV1 + */ + 'id': string; + /** + * The type of the recommendation. When omitted, the backend resolves the type by looking up the ID. + * @type {string} + * @memberof BulkapproveentitlementrecommendationitemV1 + */ + 'recordType'?: BulkapproveentitlementrecommendationitemV1RecordTypeV1 | null; + /** + * The approved description text. Required for SED-type items; ignored for privilege items. + * @type {string} + * @memberof BulkapproveentitlementrecommendationitemV1 + */ + 'description'?: string | null; + /** + * The approved privilege level. Required for privilege-type items; ignored for SED items. + * @type {string} + * @memberof BulkapproveentitlementrecommendationitemV1 + */ + 'privilegeLevel'?: string | null; +} + +export const BulkapproveentitlementrecommendationitemV1RecordTypeV1 = { + Sed: 'SED', + Privilege: 'privilege' +} as const; + +export type BulkapproveentitlementrecommendationitemV1RecordTypeV1 = typeof BulkapproveentitlementrecommendationitemV1RecordTypeV1[keyof typeof BulkapproveentitlementrecommendationitemV1RecordTypeV1]; + +/** + * Request body for bulk-approving a set of entitlement recommendations. + * @export + * @interface BulkapproveentitlementrecommendationrequestV1 + */ +export interface BulkapproveentitlementrecommendationrequestV1 { + /** + * The list of recommendation items to approve. + * @type {Array} + * @memberof BulkapproveentitlementrecommendationrequestV1 + */ + 'items': Array; +} +/** + * The result for a single item in a bulk entitlement recommendation approval response. + * @export + * @interface BulkapproveentitlementrecommendationresultV1 + */ +export interface BulkapproveentitlementrecommendationresultV1 { + /** + * The unique identifier of the processed recommendation record. + * @type {string} + * @memberof BulkapproveentitlementrecommendationresultV1 + */ + 'id'?: string; + /** + * The outcome of the approval for this item. + * @type {string} + * @memberof BulkapproveentitlementrecommendationresultV1 + */ + 'status'?: BulkapproveentitlementrecommendationresultV1StatusV1; + /** + * The reason for failure if status is FAILURE; null on success. + * @type {string} + * @memberof BulkapproveentitlementrecommendationresultV1 + */ + 'failedReason'?: string | null; +} + +export const BulkapproveentitlementrecommendationresultV1StatusV1 = { + Success: 'SUCCESS', + Failure: 'FAILURE' +} as const; + +export type BulkapproveentitlementrecommendationresultV1StatusV1 = typeof BulkapproveentitlementrecommendationresultV1StatusV1[keyof typeof BulkapproveentitlementrecommendationresultV1StatusV1]; + +/** + * + * @export + * @interface CreateAutoWriteSettingsV1409ResponseV1 + */ +export interface CreateAutoWriteSettingsV1409ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof CreateAutoWriteSettingsV1409ResponseV1 + */ + 'errorName'?: any; + /** + * Description of the error + * @type {any} + * @memberof CreateAutoWriteSettingsV1409ResponseV1 + */ + 'errorMessage'?: any; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof CreateAutoWriteSettingsV1409ResponseV1 + */ + 'trackingId'?: string; +} +/** + * Assign to the source owner or entitlement owner role. No value field is required. + * @export + * @interface EntitlementrecommendationassigneeOneOf1V1 + */ +export interface EntitlementrecommendationassigneeOneOf1V1 { + /** + * The type of assignee. + * @type {string} + * @memberof EntitlementrecommendationassigneeOneOf1V1 + */ + 'type': EntitlementrecommendationassigneeOneOf1V1TypeV1; +} + +export const EntitlementrecommendationassigneeOneOf1V1TypeV1 = { + SourceOwner: 'SOURCE_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER' +} as const; + +export type EntitlementrecommendationassigneeOneOf1V1TypeV1 = typeof EntitlementrecommendationassigneeOneOf1V1TypeV1[keyof typeof EntitlementrecommendationassigneeOneOf1V1TypeV1]; + +/** + * Assign to a specific identity or governance group. The value field is required and must be the ID of the identity or governance group. + * @export + * @interface EntitlementrecommendationassigneeOneOfV1 + */ +export interface EntitlementrecommendationassigneeOneOfV1 { + /** + * The type of assignee. + * @type {string} + * @memberof EntitlementrecommendationassigneeOneOfV1 + */ + 'type': EntitlementrecommendationassigneeOneOfV1TypeV1; + /** + * The ID of the identity or governance group to assign to. + * @type {string} + * @memberof EntitlementrecommendationassigneeOneOfV1 + */ + 'value': string; +} + +export const EntitlementrecommendationassigneeOneOfV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type EntitlementrecommendationassigneeOneOfV1TypeV1 = typeof EntitlementrecommendationassigneeOneOfV1TypeV1[keyof typeof EntitlementrecommendationassigneeOneOfV1TypeV1]; + +/** + * @type EntitlementrecommendationassigneeV1 + * Describes the target assignee for entitlement recommendations. + * @export + */ +export type EntitlementrecommendationassigneeV1 = EntitlementrecommendationassigneeOneOf1V1 | EntitlementrecommendationassigneeOneOfV1; + +/** + * Request body for assigning a set of entitlement recommendations to a reviewer. + * @export + * @interface EntitlementrecommendationassignrequestV1 + */ +export interface EntitlementrecommendationassignrequestV1 { + /** + * The list of recommendation record IDs to assign. + * @type {Array} + * @memberof EntitlementrecommendationassignrequestV1 + */ + 'items': Array; + /** + * + * @type {EntitlementrecommendationassigneeV1} + * @memberof EntitlementrecommendationassignrequestV1 + */ + 'assignee': EntitlementrecommendationassigneeV1; +} +/** + * Response body returned when entitlement recommendations are successfully queued for assignment. + * @export + * @interface EntitlementrecommendationassignresultV1 + */ +export interface EntitlementrecommendationassignresultV1 { + /** + * The unique identifier of the assignment batch created by this request. + * @type {string} + * @memberof EntitlementrecommendationassignresultV1 + */ + 'batchId'?: string; +} +/** + * A unified entitlement recommendation record representing either a SED (Suggested Entitlement Description) or a privilege recommendation. + * @export + * @interface EntitlementrecommendationrecordV1 + */ +export interface EntitlementrecommendationrecordV1 { + /** + * The type of recommendation. \"SED\" indicates a suggested description recommendation; \"privilege\" indicates a privilege-level recommendation. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'recordType'?: EntitlementrecommendationrecordV1RecordTypeV1; + /** + * The unique identifier for this recommendation record. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'id'?: string; + /** + * The entitlement attribute name (e.g. \"groups\"). + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'attribute'?: string | null; + /** + * The human-readable display name of the entitlement. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'displayName'?: string | null; + /** + * The internal name of the entitlement. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'name'?: string | null; + /** + * The ID of the source that owns this entitlement. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'sourceId'?: string; + /** + * The display name of the source that owns this entitlement. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'sourceName'?: string; + /** + * The current review status of the recommendation. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'status'?: string; + /** + * The entitlement type (e.g. \"group\"). + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'type'?: string | null; + /** + * The entitlement value or identifier. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'value'?: string; + /** + * The current description of the entitlement, if one exists. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'description'?: string | null; + /** + * The AI-generated suggested description for the entitlement (SED records only). + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'suggestedDescription'?: string | null; + /** + * The current privilege level assigned to the entitlement. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'privilege'?: string | null; + /** + * The AI-suggested privilege level for the entitlement (privilege records only). + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'suggestedPrivilege'?: string | null; + /** + * The ID of the identity who approved this recommendation. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'approvedBy'?: string | null; + /** + * How the recommendation was approved (e.g. \"direct\"). + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'approvedType'?: string | null; + /** + * The timestamp when the recommendation was approved. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'approvedWhen'?: string | null; + /** + * The timestamp when the LLM batch that generated this recommendation was created. + * @type {string} + * @memberof EntitlementrecommendationrecordV1 + */ + 'llmBatchCreatedAt'?: string | null; +} + +export const EntitlementrecommendationrecordV1RecordTypeV1 = { + Sed: 'SED', + Privilege: 'privilege' +} as const; + +export type EntitlementrecommendationrecordV1RecordTypeV1 = typeof EntitlementrecommendationrecordV1RecordTypeV1[keyof typeof EntitlementrecommendationrecordV1RecordTypeV1]; + +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetAutoWriteSettingsV1401ResponseV1 + */ +export interface GetAutoWriteSettingsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAutoWriteSettingsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetAutoWriteSettingsV1429ResponseV1 + */ +export interface GetAutoWriteSettingsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetAutoWriteSettingsV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * A group of entitlement instances that share the same entitlement name and connector type, aggregated for privileged-access review. + * @export + * @interface PrivilegedrecommendationgroupV1 + */ +export interface PrivilegedrecommendationgroupV1 { + /** + * The name of the entitlement shared across all instances in this group. + * @type {string} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'entitlementName'?: string; + /** + * The connector type associated with all instances in this group. + * @type {string} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'connectorType'?: string; + /** + * A decimal string representing the confidence score of the privilege recommendation (0.0-1.0). + * @type {string} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'recommendationScore'?: string; + /** + * The number of organizations in which this entitlement appears as privileged. + * @type {number} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'orgCount'?: number; + /** + * The total number of individual entitlement instances in this group. + * @type {number} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'instanceCount'?: number; + /** + * The individual entitlement instances belonging to this group. + * @type {Array} + * @memberof PrivilegedrecommendationgroupV1 + */ + 'instances'?: Array; +} +/** + * An individual entitlement instance within a privileged recommendation group. + * @export + * @interface PrivilegedrecommendationinstanceV1 + */ +export interface PrivilegedrecommendationinstanceV1 { + /** + * The unique identifier for this entitlement instance. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'id'?: string; + /** + * The entitlement attribute name. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'attribute'?: string; + /** + * The ID of the source that owns this entitlement. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'sourceId'?: string; + /** + * The display name of the source. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'sourceName'?: string; + /** + * The entitlement type. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'type'?: string; + /** + * The entitlement value or distinguished name. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'value'?: string; + /** + * The current review status of this instance. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'status'?: string; + /** + * The currently assigned privilege level, if any. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'privilegeLevel'?: string | null; + /** + * The current description of the entitlement, if one exists. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'description'?: string | null; + /** + * The timestamp when this instance was recommended. + * @type {string} + * @memberof PrivilegedrecommendationinstanceV1 + */ + 'recommendedAt'?: string; +} +/** + * + * @export + * @interface SearchcriteriaFiltersValueRangeLowerV1 + */ +export interface SearchcriteriaFiltersValueRangeLowerV1 { + /** + * The lower bound value. + * @type {string} + * @memberof SearchcriteriaFiltersValueRangeLowerV1 + */ + 'value'?: string; + /** + * Whether the lower bound is inclusive. + * @type {boolean} + * @memberof SearchcriteriaFiltersValueRangeLowerV1 + */ + 'inclusive'?: boolean; +} +/** + * + * @export + * @interface SearchcriteriaFiltersValueRangeUpperV1 + */ +export interface SearchcriteriaFiltersValueRangeUpperV1 { + /** + * The upper bound value. + * @type {string} + * @memberof SearchcriteriaFiltersValueRangeUpperV1 + */ + 'value'?: string; + /** + * Whether the upper bound is inclusive. + * @type {boolean} + * @memberof SearchcriteriaFiltersValueRangeUpperV1 + */ + 'inclusive'?: boolean; +} +/** + * + * @export + * @interface SearchcriteriaFiltersValueRangeV1 + */ +export interface SearchcriteriaFiltersValueRangeV1 { + /** + * + * @type {SearchcriteriaFiltersValueRangeLowerV1} + * @memberof SearchcriteriaFiltersValueRangeV1 + */ + 'lower'?: SearchcriteriaFiltersValueRangeLowerV1; + /** + * + * @type {SearchcriteriaFiltersValueRangeUpperV1} + * @memberof SearchcriteriaFiltersValueRangeV1 + */ + 'upper'?: SearchcriteriaFiltersValueRangeUpperV1; +} +/** + * + * @export + * @interface SearchcriteriaFiltersValueV1 + */ +export interface SearchcriteriaFiltersValueV1 { + /** + * The type of filter, e.g., \"TERMS\" or \"RANGE\". + * @type {string} + * @memberof SearchcriteriaFiltersValueV1 + */ + 'type'?: string; + /** + * Terms to filter by (for \"TERMS\" type). + * @type {Array} + * @memberof SearchcriteriaFiltersValueV1 + */ + 'terms'?: Array; + /** + * + * @type {SearchcriteriaFiltersValueRangeV1} + * @memberof SearchcriteriaFiltersValueV1 + */ + 'range'?: SearchcriteriaFiltersValueRangeV1; +} +/** + * + * @export + * @interface SearchcriteriaQueryV1 + */ +export interface SearchcriteriaQueryV1 { + /** + * A structured query for advanced search. + * @type {string} + * @memberof SearchcriteriaQueryV1 + */ + 'query'?: string; +} +/** + * + * @export + * @interface SearchcriteriaTextQueryV1 + */ +export interface SearchcriteriaTextQueryV1 { + /** + * Terms to search for. + * @type {Array} + * @memberof SearchcriteriaTextQueryV1 + */ + 'terms'?: Array; + /** + * Fields to search within. + * @type {Array} + * @memberof SearchcriteriaTextQueryV1 + */ + 'fields'?: Array; + /** + * Whether to match any of the terms. + * @type {boolean} + * @memberof SearchcriteriaTextQueryV1 + */ + 'matchAny'?: boolean; +} +/** + * Represents the search criteria for querying entitlements. + * @export + * @interface SearchcriteriaV1 + */ +export interface SearchcriteriaV1 { + /** + * A list of indices to search within. Must contain exactly one item, typically \"entitlements\". + * @type {Array} + * @memberof SearchcriteriaV1 + */ + 'indices': Array; + /** + * A map of filters applied to the search. Keys are filter names, and values are filter definitions. + * @type {{ [key: string]: SearchcriteriaFiltersValueV1; }} + * @memberof SearchcriteriaV1 + */ + 'filters'?: { [key: string]: SearchcriteriaFiltersValueV1; }; + /** + * + * @type {SearchcriteriaQueryV1} + * @memberof SearchcriteriaV1 + */ + 'query'?: SearchcriteriaQueryV1; + /** + * Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. + * @type {string} + * @memberof SearchcriteriaV1 + */ + 'queryType'?: string; + /** + * + * @type {SearchcriteriaTextQueryV1} + * @memberof SearchcriteriaV1 + */ + 'textQuery'?: SearchcriteriaTextQueryV1; + /** + * Whether to include nested objects in the search results. + * @type {boolean} + * @memberof SearchcriteriaV1 + */ + 'includeNested'?: boolean; + /** + * Specifies the sorting order for the results. + * @type {Array} + * @memberof SearchcriteriaV1 + */ + 'sort'?: Array; + /** + * Used for pagination to fetch results after a specific point. + * @type {Array} + * @memberof SearchcriteriaV1 + */ + 'searchAfter'?: Array; +} +/** + * Suggested Entitlement Description + * @export + * @interface SedV1 + */ +export interface SedV1 { + /** + * name of the entitlement + * @type {string} + * @memberof SedV1 + */ + 'Name'?: string; + /** + * entitlement approved by + * @type {string} + * @memberof SedV1 + */ + 'approved_by'?: string; + /** + * entitlement approved type + * @type {string} + * @memberof SedV1 + */ + 'approved_type'?: string; + /** + * entitlement approved then + * @type {string} + * @memberof SedV1 + */ + 'approved_when'?: string; + /** + * entitlement attribute + * @type {string} + * @memberof SedV1 + */ + 'attribute'?: string; + /** + * description of entitlement + * @type {string} + * @memberof SedV1 + */ + 'description'?: string; + /** + * entitlement display name + * @type {string} + * @memberof SedV1 + */ + 'displayName'?: string; + /** + * sed id + * @type {string} + * @memberof SedV1 + */ + 'id'?: string; + /** + * entitlement source id + * @type {string} + * @memberof SedV1 + */ + 'sourceId'?: string; + /** + * entitlement source name + * @type {string} + * @memberof SedV1 + */ + 'sourceName'?: string; + /** + * entitlement status + * @type {string} + * @memberof SedV1 + */ + 'status'?: string; + /** + * llm suggested entitlement description + * @type {string} + * @memberof SedV1 + */ + 'suggestedDescription'?: string; + /** + * entitlement type + * @type {string} + * @memberof SedV1 + */ + 'type'?: string; + /** + * entitlement value + * @type {string} + * @memberof SedV1 + */ + 'value'?: string; +} +/** + * Sed Approval Request Body + * @export + * @interface SedapprovalV1 + */ +export interface SedapprovalV1 { + /** + * List of SED id\'s + * @type {Array} + * @memberof SedapprovalV1 + */ + 'items'?: Array; +} +/** + * SED Approval Status + * @export + * @interface SedapprovalstatusV1 + */ +export interface SedapprovalstatusV1 { + /** + * failed reason will be display if status is failed + * @type {string} + * @memberof SedapprovalstatusV1 + */ + 'failedReason'?: string; + /** + * Sed id + * @type {string} + * @memberof SedapprovalstatusV1 + */ + 'id'?: string; + /** + * SUCCESS | FAILED + * @type {string} + * @memberof SedapprovalstatusV1 + */ + 'status'?: string; +} +/** + * Sed Assignee + * @export + * @interface SedassigneeV1 + */ +export interface SedassigneeV1 { + /** + * Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE + * @type {string} + * @memberof SedassigneeV1 + */ + 'type': SedassigneeV1TypeV1; + /** + * Identity or Group identifier Empty when using source/entitlement owner personas + * @type {string} + * @memberof SedassigneeV1 + */ + 'value'?: string; +} + +export const SedassigneeV1TypeV1 = { + Identity: 'IDENTITY', + Group: 'GROUP', + SourceOwner: 'SOURCE_OWNER', + EntitlementOwner: 'ENTITLEMENT_OWNER' +} as const; + +export type SedassigneeV1TypeV1 = typeof SedassigneeV1TypeV1[keyof typeof SedassigneeV1TypeV1]; + +/** + * Sed Assignment + * @export + * @interface SedassignmentV1 + */ +export interface SedassignmentV1 { + /** + * + * @type {SedassigneeV1} + * @memberof SedassignmentV1 + */ + 'assignee'?: SedassigneeV1; + /** + * List of SED id\'s + * @type {Array} + * @memberof SedassignmentV1 + */ + 'items'?: Array; +} +/** + * Sed Assignment Response + * @export + * @interface SedassignmentresponseV1 + */ +export interface SedassignmentresponseV1 { + /** + * BatchId that groups all the ids together + * @type {string} + * @memberof SedassignmentresponseV1 + */ + 'batchId'?: string; +} +/** + * Sed Batch Record + * @export + * @interface SedbatchrecordV1 + */ +export interface SedbatchrecordV1 { + /** + * The tenant ID associated with the batch. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'tenantId'?: string; + /** + * The unique ID of the batch. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'batchId'?: string; + /** + * The name of the batch. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'name'?: string | null; + /** + * The current state of the batch (e.g., submitted, materialized, completed). + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'processedState'?: string | null; + /** + * The ID of the user who requested the batch. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'requestedBy'?: string; + /** + * The number of items materialized in the batch. + * @type {number} + * @memberof SedbatchrecordV1 + */ + 'materializedCount'?: number; + /** + * The number of items processed in the batch. + * @type {number} + * @memberof SedbatchrecordV1 + */ + 'processedCount'?: number; + /** + * The timestamp when the batch was created. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'createdAt'?: string; + /** + * The timestamp when the batch was last updated. + * @type {string} + * @memberof SedbatchrecordV1 + */ + 'updatedAt'?: string | null; +} +/** + * Sed Batch Request + * @export + * @interface SedbatchrequestV1 + */ +export interface SedbatchrequestV1 { + /** + * list of entitlement ids + * @type {Array} + * @memberof SedbatchrequestV1 + */ + 'entitlements'?: Array | null; + /** + * list of sed ids + * @type {Array} + * @memberof SedbatchrequestV1 + */ + 'seds'?: Array | null; + /** + * Search criteria for the batch request. + * @type {{ [key: string]: SearchcriteriaV1; }} + * @memberof SedbatchrequestV1 + */ + 'searchCriteria'?: { [key: string]: SearchcriteriaV1; } | null; +} +/** + * Sed Batch Response + * @export + * @interface SedbatchresponseV1 + */ +export interface SedbatchresponseV1 { + /** + * BatchId that groups all the ids together + * @type {string} + * @memberof SedbatchresponseV1 + */ + 'batchId'?: string; +} +/** + * Sed Batch Stats + * @export + * @interface SedbatchstatsV1 + */ +export interface SedbatchstatsV1 { + /** + * batch complete + * @type {boolean} + * @memberof SedbatchstatsV1 + */ + 'batchComplete'?: boolean; + /** + * batch Id + * @type {string} + * @memberof SedbatchstatsV1 + */ + 'batchId'?: string; + /** + * discovered count + * @type {number} + * @memberof SedbatchstatsV1 + */ + 'discoveredCount'?: number; + /** + * discovery complete + * @type {boolean} + * @memberof SedbatchstatsV1 + */ + 'discoveryComplete'?: boolean; + /** + * processed count + * @type {number} + * @memberof SedbatchstatsV1 + */ + 'processedCount'?: number; +} +/** + * Patch for Suggested Entitlement Description + * @export + * @interface SedpatchV1 + */ +export interface SedpatchV1 { + /** + * desired operation + * @type {string} + * @memberof SedpatchV1 + */ + 'op'?: string; + /** + * field to be patched + * @type {string} + * @memberof SedpatchV1 + */ + 'path'?: string; + /** + * value to replace with + * @type {any} + * @memberof SedpatchV1 + */ + 'value'?: any; +} + +/** + * SuggestedEntitlementDescriptionV1Api - axios parameter creator + * @export + */ +export const SuggestedEntitlementDescriptionV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. + * @summary Bulk approve entitlement recommendations + * @param {BulkapproveentitlementrecommendationrequestV1} bulkapproveentitlementrecommendationrequestV1 The list of recommendation items to approve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveBulkEntitlementRecommendationsV1: async (bulkapproveentitlementrecommendationrequestV1: BulkapproveentitlementrecommendationrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkapproveentitlementrecommendationrequestV1' is not null or undefined + assertParamExists('approveBulkEntitlementRecommendationsV1', 'bulkapproveentitlementrecommendationrequestV1', bulkapproveentitlementrecommendationrequestV1) + const localVarPath = `/entitlement-recommendations/v1/bulk-approve`; + // 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(bulkapproveentitlementrecommendationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. + * @summary Create auto-write settings for SED + * @param {AutowritesettingV1} autowritesettingV1 Auto-write settings to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAutoWriteSettingsV1: async (autowritesettingV1: AutowritesettingV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'autowritesettingV1' is not null or undefined + assertParamExists('createAutoWriteSettingsV1', 'autowritesettingV1', autowritesettingV1) + const localVarPath = `/suggested-entitlement-descriptions/v1/auto-write-settings`; + // 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(autowritesettingV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. + * @summary Get auto-write settings for SED + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAutoWriteSettingsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/suggested-entitlement-descriptions/v1/auto-write-settings`; + // 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, + }; + }, + /** + * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' + * @summary Submit sed batch stats request + * @param {string} batchId Batch Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSedBatchStatsV1: async (batchId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'batchId' is not null or undefined + assertParamExists('getSedBatchStatsV1', 'batchId', batchId) + const localVarPath = `/suggested-entitlement-description-batches/v1/{batchId}/stats` + .replace(`{${"batchId"}}`, encodeURIComponent(String(batchId))); + // 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 Sed Batches. API responses with Sed Batch Records + * @summary List Sed Batch Record + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. + * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @param {string} [status] Batch Status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSedBatchesV1: async (offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/suggested-entitlement-description-batches/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 (countOnly !== undefined) { + localVarQueryParameter['count-only'] = countOnly; + } + + if (status !== undefined) { + localVarQueryParameter['status'] = status; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. + * @summary List pending entitlement recommendation approvals + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPendingEntitlementRecommendationApprovalsV1: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/entitlement-recommendations/v1/pending-approvals`; + // 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. + * @summary List privileged entitlement recommendations + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegedEntitlementRecommendationsV1: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/privileged-recommendations/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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + * @summary List suggested entitlement descriptions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* + * @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: **displayName, sourceName, status** + * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSedsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/suggested-entitlement-descriptions/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + if (sorters !== undefined) { + localVarQueryParameter['sorters'] = sorters; + } + + if (countOnly !== undefined) { + localVarQueryParameter['count-only'] = countOnly; + } + + if (requestedByAnyone !== undefined) { + localVarQueryParameter['requested-by-anyone'] = requestedByAnyone; + } + + if (showPendingStatusOnly !== undefined) { + localVarQueryParameter['show-pending-status-only'] = showPendingStatusOnly; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. + * @summary Update an entitlement recommendation + * @param {string} id The unique identifier of the entitlement recommendation to update. + * @param {Array} jsonpatchoperationV1 The patch operations to apply to the entitlement recommendation record. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementRecommendationV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchEntitlementRecommendationV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchEntitlementRecommendationV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/entitlement-recommendations/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Patch Suggested Entitlement Description + * @summary Patch suggested entitlement description + * @param {string} id id is sed id + * @param {Array} sedpatchV1 Sed Patch Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSedV1: async (id: string, sedpatchV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSedV1', 'id', id) + // verify required parameter 'sedpatchV1' is not null or undefined + assertParamExists('patchSedV1', 'sedpatchV1', sedpatchV1) + const localVarPath = `/suggested-entitlement-descriptions/v1` + .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(sedpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. + * @summary Assign entitlement recommendations for review + * @param {EntitlementrecommendationassignrequestV1} entitlementrecommendationassignrequestV1 The recommendation IDs and the target assignee. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitEntitlementRecommendationsAssignmentV1: async (entitlementrecommendationassignrequestV1: EntitlementrecommendationassignrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'entitlementrecommendationassignrequestV1' is not null or undefined + assertParamExists('submitEntitlementRecommendationsAssignmentV1', 'entitlementrecommendationassignrequestV1', entitlementrecommendationassignrequestV1) + const localVarPath = `/entitlement-recommendations/v1/assign`; + // 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(entitlementrecommendationassignrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status + * @summary Submit bulk approval request + * @param {Array} sedapprovalV1 Sed Approval + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedApprovalV1: async (sedapprovalV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sedapprovalV1' is not null or undefined + assertParamExists('submitSedApprovalV1', 'sedapprovalV1', sedapprovalV1) + const localVarPath = `/suggested-entitlement-description-approvals/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-patch+json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sedapprovalV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + * @summary Submit sed assignment request + * @param {SedassignmentV1} sedassignmentV1 Sed Assignment Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedAssignmentV1: async (sedassignmentV1: SedassignmentV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sedassignmentV1' is not null or undefined + assertParamExists('submitSedAssignmentV1', 'sedassignmentV1', sedassignmentV1) + const localVarPath = `/suggested-entitlement-description-assignments/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-patch+json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sedassignmentV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + * @summary Submit sed batch request + * @param {SedbatchrequestV1} [sedbatchrequestV1] Sed Batch Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedBatchRequestV1: async (sedbatchrequestV1?: SedbatchrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/suggested-entitlement-description-batches/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-patch+json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sedbatchrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. + * @summary Update auto-write settings for SED + * @param {Array} autowritesettingpatchV1 Patch operations for auto-write settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAutoWriteSettingsV1: async (autowritesettingpatchV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'autowritesettingpatchV1' is not null or undefined + assertParamExists('updateAutoWriteSettingsV1', 'autowritesettingpatchV1', autowritesettingpatchV1) + const localVarPath = `/suggested-entitlement-descriptions/v1/auto-write-settings`; + // 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(autowritesettingpatchV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * SuggestedEntitlementDescriptionV1Api - functional programming interface + * @export + */ +export const SuggestedEntitlementDescriptionV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SuggestedEntitlementDescriptionV1ApiAxiosParamCreator(configuration) + return { + /** + * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. + * @summary Bulk approve entitlement recommendations + * @param {BulkapproveentitlementrecommendationrequestV1} bulkapproveentitlementrecommendationrequestV1 The list of recommendation items to approve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveBulkEntitlementRecommendationsV1(bulkapproveentitlementrecommendationrequestV1: BulkapproveentitlementrecommendationrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkEntitlementRecommendationsV1(bulkapproveentitlementrecommendationrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.approveBulkEntitlementRecommendationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. + * @summary Create auto-write settings for SED + * @param {AutowritesettingV1} autowritesettingV1 Auto-write settings to create + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createAutoWriteSettingsV1(autowritesettingV1: AutowritesettingV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createAutoWriteSettingsV1(autowritesettingV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.createAutoWriteSettingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. + * @summary Get auto-write settings for SED + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getAutoWriteSettingsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAutoWriteSettingsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.getAutoWriteSettingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' + * @summary Submit sed batch stats request + * @param {string} batchId Batch Id + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSedBatchStatsV1(batchId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchStatsV1(batchId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.getSedBatchStatsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List Sed Batches. API responses with Sed Batch Records + * @summary List Sed Batch Record + * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. + * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @param {string} [status] Batch Status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getSedBatchesV1(offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchesV1(offset, limit, count, countOnly, status, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.getSedBatchesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. + * @summary List pending entitlement recommendation approvals + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPendingEntitlementRecommendationApprovalsV1(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingEntitlementRecommendationApprovalsV1(offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.listPendingEntitlementRecommendationApprovalsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. + * @summary List privileged entitlement recommendations + * @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 {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listPrivilegedEntitlementRecommendationsV1(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegedEntitlementRecommendationsV1(offset, limit, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.listPrivilegedEntitlementRecommendationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + * @summary List suggested entitlement descriptions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* + * @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: **displayName, sourceName, status** + * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSedsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSedsV1(limit, offset, count, filters, sorters, countOnly, requestedByAnyone, showPendingStatusOnly, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.listSedsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. + * @summary Update an entitlement recommendation + * @param {string} id The unique identifier of the entitlement recommendation to update. + * @param {Array} jsonpatchoperationV1 The patch operations to apply to the entitlement recommendation record. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchEntitlementRecommendationV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementRecommendationV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.patchEntitlementRecommendationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Patch Suggested Entitlement Description + * @summary Patch suggested entitlement description + * @param {string} id id is sed id + * @param {Array} sedpatchV1 Sed Patch Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSedV1(id: string, sedpatchV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSedV1(id, sedpatchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.patchSedV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. + * @summary Assign entitlement recommendations for review + * @param {EntitlementrecommendationassignrequestV1} entitlementrecommendationassignrequestV1 The recommendation IDs and the target assignee. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitEntitlementRecommendationsAssignmentV1(entitlementrecommendationassignrequestV1: EntitlementrecommendationassignrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitEntitlementRecommendationsAssignmentV1(entitlementrecommendationassignrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.submitEntitlementRecommendationsAssignmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status + * @summary Submit bulk approval request + * @param {Array} sedapprovalV1 Sed Approval + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitSedApprovalV1(sedapprovalV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedApprovalV1(sedapprovalV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.submitSedApprovalV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + * @summary Submit sed assignment request + * @param {SedassignmentV1} sedassignmentV1 Sed Assignment Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitSedAssignmentV1(sedassignmentV1: SedassignmentV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedAssignmentV1(sedassignmentV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.submitSedAssignmentV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + * @summary Submit sed batch request + * @param {SedbatchrequestV1} [sedbatchrequestV1] Sed Batch Request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitSedBatchRequestV1(sedbatchrequestV1?: SedbatchrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedBatchRequestV1(sedbatchrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.submitSedBatchRequestV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. + * @summary Update auto-write settings for SED + * @param {Array} autowritesettingpatchV1 Patch operations for auto-write settings + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateAutoWriteSettingsV1(autowritesettingpatchV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateAutoWriteSettingsV1(autowritesettingpatchV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV1Api.updateAutoWriteSettingsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SuggestedEntitlementDescriptionV1Api - factory interface + * @export + */ +export const SuggestedEntitlementDescriptionV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SuggestedEntitlementDescriptionV1ApiFp(configuration) + return { + /** + * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. + * @summary Bulk approve entitlement recommendations + * @param {SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveBulkEntitlementRecommendationsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.approveBulkEntitlementRecommendationsV1(requestParameters.bulkapproveentitlementrecommendationrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. + * @summary Create auto-write settings for SED + * @param {SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createAutoWriteSettingsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createAutoWriteSettingsV1(requestParameters.autowritesettingV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. + * @summary Get auto-write settings for SED + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getAutoWriteSettingsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getAutoWriteSettingsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' + * @summary Submit sed batch stats request + * @param {SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSedBatchStatsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getSedBatchStatsV1(requestParameters.batchId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List Sed Batches. API responses with Sed Batch Records + * @summary List Sed Batch Record + * @param {SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getSedBatchesV1(requestParameters: SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getSedBatchesV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. + * @summary List pending entitlement recommendation approvals + * @param {SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPendingEntitlementRecommendationApprovalsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPendingEntitlementRecommendationApprovalsV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. + * @summary List privileged entitlement recommendations + * @param {SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listPrivilegedEntitlementRecommendationsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listPrivilegedEntitlementRecommendationsV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + * @summary List suggested entitlement descriptions + * @param {SuggestedEntitlementDescriptionV1ApiListSedsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSedsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListSedsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSedsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. + * @summary Update an entitlement recommendation + * @param {SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchEntitlementRecommendationV1(requestParameters: SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchEntitlementRecommendationV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Patch Suggested Entitlement Description + * @summary Patch suggested entitlement description + * @param {SuggestedEntitlementDescriptionV1ApiPatchSedV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSedV1(requestParameters: SuggestedEntitlementDescriptionV1ApiPatchSedV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSedV1(requestParameters.id, requestParameters.sedpatchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. + * @summary Assign entitlement recommendations for review + * @param {SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitEntitlementRecommendationsAssignmentV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitEntitlementRecommendationsAssignmentV1(requestParameters.entitlementrecommendationassignrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status + * @summary Submit bulk approval request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedApprovalV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.submitSedApprovalV1(requestParameters.sedapprovalV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + * @summary Submit sed assignment request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedAssignmentV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitSedAssignmentV1(requestParameters.sedassignmentV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + * @summary Submit sed batch request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitSedBatchRequestV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitSedBatchRequestV1(requestParameters.sedbatchrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. + * @summary Update auto-write settings for SED + * @param {SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateAutoWriteSettingsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateAutoWriteSettingsV1(requestParameters.autowritesettingpatchV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveBulkEntitlementRecommendationsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request { + /** + * The list of recommendation items to approve. + * @type {BulkapproveentitlementrecommendationrequestV1} + * @memberof SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1 + */ + readonly bulkapproveentitlementrecommendationrequestV1: BulkapproveentitlementrecommendationrequestV1 +} + +/** + * Request parameters for createAutoWriteSettingsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request { + /** + * Auto-write settings to create + * @type {AutowritesettingV1} + * @memberof SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1 + */ + readonly autowritesettingV1: AutowritesettingV1 +} + +/** + * Request parameters for getSedBatchStatsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request { + /** + * Batch Id + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1 + */ + readonly batchId: string +} + +/** + * Request parameters for getSedBatchesV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request { + /** + * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + * @type {number} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1 + */ + readonly offset?: number + + /** + * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + * @type {number} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1 + */ + 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1 + */ + readonly count?: boolean + + /** + * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1 + */ + readonly countOnly?: boolean + + /** + * Batch Status + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1 + */ + readonly status?: string +} + +/** + * Request parameters for listPendingEntitlementRecommendationApprovalsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request { + /** + * 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 SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1 + */ + 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 SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1 + */ + readonly limit?: number +} + +/** + * Request parameters for listPrivilegedEntitlementRecommendationsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request { + /** + * 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 SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1 + */ + 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 SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1 + */ + readonly limit?: number +} + +/** + * Request parameters for listSedsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiListSedsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiListSedsV1Request { + /** + * 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 SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + 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: **displayName, sourceName, status** + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly sorters?: string + + /** + * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly countOnly?: boolean + + /** + * By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly requestedByAnyone?: boolean + + /** + * Will limit records to items that are in \"suggested\" or \"approved\" status + * @type {boolean} + * @memberof SuggestedEntitlementDescriptionV1ApiListSedsV1 + */ + readonly showPendingStatusOnly?: boolean +} + +/** + * Request parameters for patchEntitlementRecommendationV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request { + /** + * The unique identifier of the entitlement recommendation to update. + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1 + */ + readonly id: string + + /** + * The patch operations to apply to the entitlement recommendation record. + * @type {Array} + * @memberof SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for patchSedV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiPatchSedV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiPatchSedV1Request { + /** + * id is sed id + * @type {string} + * @memberof SuggestedEntitlementDescriptionV1ApiPatchSedV1 + */ + readonly id: string + + /** + * Sed Patch Request + * @type {Array} + * @memberof SuggestedEntitlementDescriptionV1ApiPatchSedV1 + */ + readonly sedpatchV1: Array +} + +/** + * Request parameters for submitEntitlementRecommendationsAssignmentV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request { + /** + * The recommendation IDs and the target assignee. + * @type {EntitlementrecommendationassignrequestV1} + * @memberof SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1 + */ + readonly entitlementrecommendationassignrequestV1: EntitlementrecommendationassignrequestV1 +} + +/** + * Request parameters for submitSedApprovalV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request { + /** + * Sed Approval + * @type {Array} + * @memberof SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1 + */ + readonly sedapprovalV1: Array +} + +/** + * Request parameters for submitSedAssignmentV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request { + /** + * Sed Assignment Request + * @type {SedassignmentV1} + * @memberof SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1 + */ + readonly sedassignmentV1: SedassignmentV1 +} + +/** + * Request parameters for submitSedBatchRequestV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request { + /** + * Sed Batch Request + * @type {SedbatchrequestV1} + * @memberof SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1 + */ + readonly sedbatchrequestV1?: SedbatchrequestV1 +} + +/** + * Request parameters for updateAutoWriteSettingsV1 operation in SuggestedEntitlementDescriptionV1Api. + * @export + * @interface SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request + */ +export interface SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request { + /** + * Patch operations for auto-write settings + * @type {Array} + * @memberof SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1 + */ + readonly autowritesettingpatchV1: Array +} + +/** + * SuggestedEntitlementDescriptionV1Api - object-oriented interface + * @export + * @class SuggestedEntitlementDescriptionV1Api + * @extends {BaseAPI} + */ +export class SuggestedEntitlementDescriptionV1Api extends BaseAPI { + /** + * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. + * @summary Bulk approve entitlement recommendations + * @param {SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public approveBulkEntitlementRecommendationsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiApproveBulkEntitlementRecommendationsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).approveBulkEntitlementRecommendationsV1(requestParameters.bulkapproveentitlementrecommendationrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. + * @summary Create auto-write settings for SED + * @param {SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public createAutoWriteSettingsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiCreateAutoWriteSettingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).createAutoWriteSettingsV1(requestParameters.autowritesettingV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. + * @summary Get auto-write settings for SED + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public getAutoWriteSettingsV1(axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).getAutoWriteSettingsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' + * @summary Submit sed batch stats request + * @param {SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public getSedBatchStatsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiGetSedBatchStatsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).getSedBatchStatsV1(requestParameters.batchId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List Sed Batches. API responses with Sed Batch Records + * @summary List Sed Batch Record + * @param {SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public getSedBatchesV1(requestParameters: SuggestedEntitlementDescriptionV1ApiGetSedBatchesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).getSedBatchesV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. + * @summary List pending entitlement recommendation approvals + * @param {SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public listPendingEntitlementRecommendationApprovalsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListPendingEntitlementRecommendationApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).listPendingEntitlementRecommendationApprovalsV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. + * @summary List privileged entitlement recommendations + * @param {SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public listPrivilegedEntitlementRecommendationsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListPrivilegedEntitlementRecommendationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).listPrivilegedEntitlementRecommendationsV1(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + * @summary List suggested entitlement descriptions + * @param {SuggestedEntitlementDescriptionV1ApiListSedsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public listSedsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiListSedsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).listSedsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. + * @summary Update an entitlement recommendation + * @param {SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public patchEntitlementRecommendationV1(requestParameters: SuggestedEntitlementDescriptionV1ApiPatchEntitlementRecommendationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).patchEntitlementRecommendationV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Patch Suggested Entitlement Description + * @summary Patch suggested entitlement description + * @param {SuggestedEntitlementDescriptionV1ApiPatchSedV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public patchSedV1(requestParameters: SuggestedEntitlementDescriptionV1ApiPatchSedV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).patchSedV1(requestParameters.id, requestParameters.sedpatchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. + * @summary Assign entitlement recommendations for review + * @param {SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public submitEntitlementRecommendationsAssignmentV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitEntitlementRecommendationsAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).submitEntitlementRecommendationsAssignmentV1(requestParameters.entitlementrecommendationassignrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status + * @summary Submit bulk approval request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public submitSedApprovalV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).submitSedApprovalV1(requestParameters.sedapprovalV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + * @summary Submit sed assignment request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public submitSedAssignmentV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedAssignmentV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).submitSedAssignmentV1(requestParameters.sedassignmentV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + * @summary Submit sed batch request + * @param {SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public submitSedBatchRequestV1(requestParameters: SuggestedEntitlementDescriptionV1ApiSubmitSedBatchRequestV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).submitSedBatchRequestV1(requestParameters.sedbatchrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. + * @summary Update auto-write settings for SED + * @param {SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof SuggestedEntitlementDescriptionV1Api + */ + public updateAutoWriteSettingsV1(requestParameters: SuggestedEntitlementDescriptionV1ApiUpdateAutoWriteSettingsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return SuggestedEntitlementDescriptionV1ApiFp(this.configuration).updateAutoWriteSettingsV1(requestParameters.autowritesettingpatchV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/suggested_entitlement_description/base.ts b/sdk-output/suggested_entitlement_description/base.ts new file mode 100644 index 00000000..1054e88a --- /dev/null +++ b/sdk-output/suggested_entitlement_description/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Suggested Entitlement Description + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/suggested_entitlement_description/common.ts b/sdk-output/suggested_entitlement_description/common.ts new file mode 100644 index 00000000..f84676c0 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Suggested Entitlement Description + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/suggested_entitlement_description/configuration.ts b/sdk-output/suggested_entitlement_description/configuration.ts new file mode 100644 index 00000000..d2351725 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Suggested Entitlement Description + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/suggested_entitlement_description/git_push.sh b/sdk-output/suggested_entitlement_description/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/suggested_entitlement_description/index.ts b/sdk-output/suggested_entitlement_description/index.ts new file mode 100644 index 00000000..6702274c --- /dev/null +++ b/sdk-output/suggested_entitlement_description/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Suggested Entitlement Description + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/suggested_entitlement_description/package.json b/sdk-output/suggested_entitlement_description/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/suggested_entitlement_description/tsconfig.json b/sdk-output/suggested_entitlement_description/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/tagged_objects/.gitignore b/sdk-output/tagged_objects/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/tagged_objects/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/tagged_objects/.npmignore b/sdk-output/tagged_objects/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/tagged_objects/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/tagged_objects/.openapi-generator-ignore b/sdk-output/tagged_objects/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/tagged_objects/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/tagged_objects/.openapi-generator/FILES b/sdk-output/tagged_objects/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/tagged_objects/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/tagged_objects/.openapi-generator/VERSION b/sdk-output/tagged_objects/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/tagged_objects/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/tagged_objects/.sdk-partition b/sdk-output/tagged_objects/.sdk-partition new file mode 100644 index 00000000..23d8b667 --- /dev/null +++ b/sdk-output/tagged_objects/.sdk-partition @@ -0,0 +1 @@ +tagged-objects \ No newline at end of file diff --git a/sdk-output/tagged_objects/README.md b/sdk-output/tagged_objects/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tagged_objects/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tagged_objects/api.ts b/sdk-output/tagged_objects/api.ts new file mode 100644 index 00000000..e8c551da --- /dev/null +++ b/sdk-output/tagged_objects/api.ts @@ -0,0 +1,1160 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tagged Objects + * 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 BulkaddtaggedobjectV1 + */ +export interface BulkaddtaggedobjectV1 { + /** + * + * @type {Array} + * @memberof BulkaddtaggedobjectV1 + */ + 'objectRefs'?: Array; + /** + * Label to be applied to an Object + * @type {Array} + * @memberof BulkaddtaggedobjectV1 + */ + 'tags'?: Array; + /** + * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + * @type {string} + * @memberof BulkaddtaggedobjectV1 + */ + 'operation'?: BulkaddtaggedobjectV1OperationV1; +} + +export const BulkaddtaggedobjectV1OperationV1 = { + Append: 'APPEND', + Merge: 'MERGE' +} as const; + +export type BulkaddtaggedobjectV1OperationV1 = typeof BulkaddtaggedobjectV1OperationV1[keyof typeof BulkaddtaggedobjectV1OperationV1]; + +/** + * + * @export + * @interface BulkremovetaggedobjectV1 + */ +export interface BulkremovetaggedobjectV1 { + /** + * + * @type {Array} + * @memberof BulkremovetaggedobjectV1 + */ + 'objectRefs'?: Array; + /** + * Label to be applied to an Object + * @type {Array} + * @memberof BulkremovetaggedobjectV1 + */ + 'tags'?: Array; +} +/** + * + * @export + * @interface BulktaggedobjectresponseV1 + */ +export interface BulktaggedobjectresponseV1 { + /** + * + * @type {Array} + * @memberof BulktaggedobjectresponseV1 + */ + 'objectRefs'?: Array; + /** + * Label to be applied to an Object + * @type {Array} + * @memberof BulktaggedobjectresponseV1 + */ + 'tags'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListTaggedObjectsV1401ResponseV1 + */ +export interface ListTaggedObjectsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTaggedObjectsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListTaggedObjectsV1429ResponseV1 + */ +export interface ListTaggedObjectsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTaggedObjectsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Tagged object. + * @export + * @interface TaggedobjectV1 + */ +export interface TaggedobjectV1 { + /** + * + * @type {TaggedobjectdtoV1} + * @memberof TaggedobjectV1 + */ + 'objectRef'?: TaggedobjectdtoV1; + /** + * Labels to be applied to an Object + * @type {Array} + * @memberof TaggedobjectV1 + */ + 'tags'?: Array; +} +/** + * + * @export + * @interface TaggedobjectdtoV1 + */ +export interface TaggedobjectdtoV1 { + /** + * DTO type + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'type'?: TaggedobjectdtoV1TypeV1; + /** + * ID of the object this reference applies to + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of the object this reference applies to + * @type {string} + * @memberof TaggedobjectdtoV1 + */ + 'name'?: string | null; +} + +export const TaggedobjectdtoV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; + +export type TaggedobjectdtoV1TypeV1 = typeof TaggedobjectdtoV1TypeV1[keyof typeof TaggedobjectdtoV1TypeV1]; + + +/** + * TaggedObjectsV1Api - axios parameter creator + * @export + */ +export const TaggedObjectsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete all tags from a tagged object. + * @summary Delete object tags + * @param {DeleteTaggedObjectV1TypeV1} type The type of object to delete tags from. + * @param {string} id The ID of the object to delete tags from. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTaggedObjectV1: async (type: DeleteTaggedObjectV1TypeV1, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'type' is not null or undefined + assertParamExists('deleteTaggedObjectV1', 'type', type) + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteTaggedObjectV1', 'id', id) + const localVarPath = `/tagged-objects/v1/{type}/{id}` + .replace(`{${"type"}}`, encodeURIComponent(String(type))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API removes tags from multiple objects. + * @summary Remove tags from multiple objects + * @param {BulkremovetaggedobjectV1} bulkremovetaggedobjectV1 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTagsToManyObjectV1: async (bulkremovetaggedobjectV1: BulkremovetaggedobjectV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkremovetaggedobjectV1' is not null or undefined + assertParamExists('deleteTagsToManyObjectV1', 'bulkremovetaggedobjectV1', bulkremovetaggedobjectV1) + const localVarPath = `/tagged-objects/v1/bulk-remove`; + // 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(bulkremovetaggedobjectV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a tagged object for the specified type. + * @summary Get tagged object + * @param {GetTaggedObjectV1TypeV1} type The type of tagged object to retrieve. + * @param {string} id The ID of the object reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaggedObjectV1: async (type: GetTaggedObjectV1TypeV1, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'type' is not null or undefined + assertParamExists('getTaggedObjectV1', 'type', type) + // verify required parameter 'id' is not null or undefined + assertParamExists('getTaggedObjectV1', 'id', id) + const localVarPath = `/tagged-objects/v1/{type}/{id}` + .replace(`{${"type"}}`, encodeURIComponent(String(type))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API returns a list of all tagged objects by type. + * @summary List tagged objects by type + * @param {ListTaggedObjectsByTypeV1TypeV1} type The type of tagged object to retrieve. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTaggedObjectsByTypeV1: async (type: ListTaggedObjectsByTypeV1TypeV1, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'type' is not null or undefined + assertParamExists('listTaggedObjectsByTypeV1', 'type', type) + const localVarPath = `/tagged-objects/v1/{type}` + .replace(`{${"type"}}`, encodeURIComponent(String(type))); + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * This API returns a list of all tagged objects. + * @summary List tagged objects + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTaggedObjectsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/tagged-objects/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * This updates a tagged object for the specified type. + * @summary Update tagged object + * @param {PutTaggedObjectV1TypeV1} type The type of tagged object to update. + * @param {string} id The ID of the object reference to update. + * @param {TaggedobjectV1} taggedobjectV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putTaggedObjectV1: async (type: PutTaggedObjectV1TypeV1, id: string, taggedobjectV1: TaggedobjectV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'type' is not null or undefined + assertParamExists('putTaggedObjectV1', 'type', type) + // verify required parameter 'id' is not null or undefined + assertParamExists('putTaggedObjectV1', 'id', id) + // verify required parameter 'taggedobjectV1' is not null or undefined + assertParamExists('putTaggedObjectV1', 'taggedobjectV1', taggedobjectV1) + const localVarPath = `/tagged-objects/v1/{type}/{id}` + .replace(`{${"type"}}`, encodeURIComponent(String(type))) + .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: 'PUT', ...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(taggedobjectV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This adds a tag to an object. + * @summary Add tag to object + * @param {TaggedobjectV1} taggedobjectV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTagToObjectV1: async (taggedobjectV1: TaggedobjectV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'taggedobjectV1' is not null or undefined + assertParamExists('setTagToObjectV1', 'taggedobjectV1', taggedobjectV1) + const localVarPath = `/tagged-objects/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(taggedobjectV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API adds tags to multiple objects. + * @summary Tag multiple objects + * @param {BulkaddtaggedobjectV1} bulkaddtaggedobjectV1 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTagsToManyObjectsV1: async (bulkaddtaggedobjectV1: BulkaddtaggedobjectV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'bulkaddtaggedobjectV1' is not null or undefined + assertParamExists('setTagsToManyObjectsV1', 'bulkaddtaggedobjectV1', bulkaddtaggedobjectV1) + const localVarPath = `/tagged-objects/v1/bulk-add`; + // 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(bulkaddtaggedobjectV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TaggedObjectsV1Api - functional programming interface + * @export + */ +export const TaggedObjectsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TaggedObjectsV1ApiAxiosParamCreator(configuration) + return { + /** + * Delete all tags from a tagged object. + * @summary Delete object tags + * @param {DeleteTaggedObjectV1TypeV1} type The type of object to delete tags from. + * @param {string} id The ID of the object to delete tags from. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteTaggedObjectV1(type: DeleteTaggedObjectV1TypeV1, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObjectV1(type, id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.deleteTaggedObjectV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API removes tags from multiple objects. + * @summary Remove tags from multiple objects + * @param {BulkremovetaggedobjectV1} bulkremovetaggedobjectV1 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteTagsToManyObjectV1(bulkremovetaggedobjectV1: BulkremovetaggedobjectV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObjectV1(bulkremovetaggedobjectV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.deleteTagsToManyObjectV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a tagged object for the specified type. + * @summary Get tagged object + * @param {GetTaggedObjectV1TypeV1} type The type of tagged object to retrieve. + * @param {string} id The ID of the object reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTaggedObjectV1(type: GetTaggedObjectV1TypeV1, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObjectV1(type, id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.getTaggedObjectV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all tagged objects by type. + * @summary List tagged objects by type + * @param {ListTaggedObjectsByTypeV1TypeV1} type The type of tagged object to retrieve. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTaggedObjectsByTypeV1(type: ListTaggedObjectsByTypeV1TypeV1, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByTypeV1(type, limit, offset, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.listTaggedObjectsByTypeV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of all tagged objects. + * @summary List tagged objects + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTaggedObjectsV1(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsV1(limit, offset, count, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.listTaggedObjectsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This updates a tagged object for the specified type. + * @summary Update tagged object + * @param {PutTaggedObjectV1TypeV1} type The type of tagged object to update. + * @param {string} id The ID of the object reference to update. + * @param {TaggedobjectV1} taggedobjectV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putTaggedObjectV1(type: PutTaggedObjectV1TypeV1, id: string, taggedobjectV1: TaggedobjectV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObjectV1(type, id, taggedobjectV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.putTaggedObjectV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This adds a tag to an object. + * @summary Add tag to object + * @param {TaggedobjectV1} taggedobjectV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setTagToObjectV1(taggedobjectV1: TaggedobjectV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObjectV1(taggedobjectV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.setTagToObjectV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API adds tags to multiple objects. + * @summary Tag multiple objects + * @param {BulkaddtaggedobjectV1} bulkaddtaggedobjectV1 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setTagsToManyObjectsV1(bulkaddtaggedobjectV1: BulkaddtaggedobjectV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjectsV1(bulkaddtaggedobjectV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV1Api.setTagsToManyObjectsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TaggedObjectsV1Api - factory interface + * @export + */ +export const TaggedObjectsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TaggedObjectsV1ApiFp(configuration) + return { + /** + * Delete all tags from a tagged object. + * @summary Delete object tags + * @param {TaggedObjectsV1ApiDeleteTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTaggedObjectV1(requestParameters: TaggedObjectsV1ApiDeleteTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteTaggedObjectV1(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API removes tags from multiple objects. + * @summary Remove tags from multiple objects + * @param {TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTagsToManyObjectV1(requestParameters: TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteTagsToManyObjectV1(requestParameters.bulkremovetaggedobjectV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a tagged object for the specified type. + * @summary Get tagged object + * @param {TaggedObjectsV1ApiGetTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaggedObjectV1(requestParameters: TaggedObjectsV1ApiGetTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTaggedObjectV1(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all tagged objects by type. + * @summary List tagged objects by type + * @param {TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTaggedObjectsByTypeV1(requestParameters: TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTaggedObjectsByTypeV1(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of all tagged objects. + * @summary List tagged objects + * @param {TaggedObjectsV1ApiListTaggedObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTaggedObjectsV1(requestParameters: TaggedObjectsV1ApiListTaggedObjectsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTaggedObjectsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This updates a tagged object for the specified type. + * @summary Update tagged object + * @param {TaggedObjectsV1ApiPutTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putTaggedObjectV1(requestParameters: TaggedObjectsV1ApiPutTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putTaggedObjectV1(requestParameters.type, requestParameters.id, requestParameters.taggedobjectV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This adds a tag to an object. + * @summary Add tag to object + * @param {TaggedObjectsV1ApiSetTagToObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTagToObjectV1(requestParameters: TaggedObjectsV1ApiSetTagToObjectV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setTagToObjectV1(requestParameters.taggedobjectV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API adds tags to multiple objects. + * @summary Tag multiple objects + * @param {TaggedObjectsV1ApiSetTagsToManyObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTagsToManyObjectsV1(requestParameters: TaggedObjectsV1ApiSetTagsToManyObjectsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.setTagsToManyObjectsV1(requestParameters.bulkaddtaggedobjectV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteTaggedObjectV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiDeleteTaggedObjectV1Request + */ +export interface TaggedObjectsV1ApiDeleteTaggedObjectV1Request { + /** + * The type of object to delete tags from. + * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} + * @memberof TaggedObjectsV1ApiDeleteTaggedObjectV1 + */ + readonly type: DeleteTaggedObjectV1TypeV1 + + /** + * The ID of the object to delete tags from. + * @type {string} + * @memberof TaggedObjectsV1ApiDeleteTaggedObjectV1 + */ + readonly id: string +} + +/** + * Request parameters for deleteTagsToManyObjectV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request + */ +export interface TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request { + /** + * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @type {BulkremovetaggedobjectV1} + * @memberof TaggedObjectsV1ApiDeleteTagsToManyObjectV1 + */ + readonly bulkremovetaggedobjectV1: BulkremovetaggedobjectV1 +} + +/** + * Request parameters for getTaggedObjectV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiGetTaggedObjectV1Request + */ +export interface TaggedObjectsV1ApiGetTaggedObjectV1Request { + /** + * The type of tagged object to retrieve. + * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} + * @memberof TaggedObjectsV1ApiGetTaggedObjectV1 + */ + readonly type: GetTaggedObjectV1TypeV1 + + /** + * The ID of the object reference to retrieve. + * @type {string} + * @memberof TaggedObjectsV1ApiGetTaggedObjectV1 + */ + readonly id: string +} + +/** + * Request parameters for listTaggedObjectsByTypeV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request + */ +export interface TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request { + /** + * The type of tagged object to retrieve. + * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} + * @memberof TaggedObjectsV1ApiListTaggedObjectsByTypeV1 + */ + readonly type: ListTaggedObjectsByTypeV1TypeV1 + + /** + * 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 TaggedObjectsV1ApiListTaggedObjectsByTypeV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TaggedObjectsV1ApiListTaggedObjectsByTypeV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TaggedObjectsV1ApiListTaggedObjectsByTypeV1 + */ + 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: **objectRef.id**: *eq* **objectRef.type**: *eq* + * @type {string} + * @memberof TaggedObjectsV1ApiListTaggedObjectsByTypeV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listTaggedObjectsV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiListTaggedObjectsV1Request + */ +export interface TaggedObjectsV1ApiListTaggedObjectsV1Request { + /** + * 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 TaggedObjectsV1ApiListTaggedObjectsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TaggedObjectsV1ApiListTaggedObjectsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TaggedObjectsV1ApiListTaggedObjectsV1 + */ + 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + * @type {string} + * @memberof TaggedObjectsV1ApiListTaggedObjectsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for putTaggedObjectV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiPutTaggedObjectV1Request + */ +export interface TaggedObjectsV1ApiPutTaggedObjectV1Request { + /** + * The type of tagged object to update. + * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} + * @memberof TaggedObjectsV1ApiPutTaggedObjectV1 + */ + readonly type: PutTaggedObjectV1TypeV1 + + /** + * The ID of the object reference to update. + * @type {string} + * @memberof TaggedObjectsV1ApiPutTaggedObjectV1 + */ + readonly id: string + + /** + * + * @type {TaggedobjectV1} + * @memberof TaggedObjectsV1ApiPutTaggedObjectV1 + */ + readonly taggedobjectV1: TaggedobjectV1 +} + +/** + * Request parameters for setTagToObjectV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiSetTagToObjectV1Request + */ +export interface TaggedObjectsV1ApiSetTagToObjectV1Request { + /** + * + * @type {TaggedobjectV1} + * @memberof TaggedObjectsV1ApiSetTagToObjectV1 + */ + readonly taggedobjectV1: TaggedobjectV1 +} + +/** + * Request parameters for setTagsToManyObjectsV1 operation in TaggedObjectsV1Api. + * @export + * @interface TaggedObjectsV1ApiSetTagsToManyObjectsV1Request + */ +export interface TaggedObjectsV1ApiSetTagsToManyObjectsV1Request { + /** + * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + * @type {BulkaddtaggedobjectV1} + * @memberof TaggedObjectsV1ApiSetTagsToManyObjectsV1 + */ + readonly bulkaddtaggedobjectV1: BulkaddtaggedobjectV1 +} + +/** + * TaggedObjectsV1Api - object-oriented interface + * @export + * @class TaggedObjectsV1Api + * @extends {BaseAPI} + */ +export class TaggedObjectsV1Api extends BaseAPI { + /** + * Delete all tags from a tagged object. + * @summary Delete object tags + * @param {TaggedObjectsV1ApiDeleteTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public deleteTaggedObjectV1(requestParameters: TaggedObjectsV1ApiDeleteTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).deleteTaggedObjectV1(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API removes tags from multiple objects. + * @summary Remove tags from multiple objects + * @param {TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public deleteTagsToManyObjectV1(requestParameters: TaggedObjectsV1ApiDeleteTagsToManyObjectV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).deleteTagsToManyObjectV1(requestParameters.bulkremovetaggedobjectV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a tagged object for the specified type. + * @summary Get tagged object + * @param {TaggedObjectsV1ApiGetTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public getTaggedObjectV1(requestParameters: TaggedObjectsV1ApiGetTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).getTaggedObjectV1(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all tagged objects by type. + * @summary List tagged objects by type + * @param {TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public listTaggedObjectsByTypeV1(requestParameters: TaggedObjectsV1ApiListTaggedObjectsByTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).listTaggedObjectsByTypeV1(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of all tagged objects. + * @summary List tagged objects + * @param {TaggedObjectsV1ApiListTaggedObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public listTaggedObjectsV1(requestParameters: TaggedObjectsV1ApiListTaggedObjectsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).listTaggedObjectsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This updates a tagged object for the specified type. + * @summary Update tagged object + * @param {TaggedObjectsV1ApiPutTaggedObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public putTaggedObjectV1(requestParameters: TaggedObjectsV1ApiPutTaggedObjectV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).putTaggedObjectV1(requestParameters.type, requestParameters.id, requestParameters.taggedobjectV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This adds a tag to an object. + * @summary Add tag to object + * @param {TaggedObjectsV1ApiSetTagToObjectV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public setTagToObjectV1(requestParameters: TaggedObjectsV1ApiSetTagToObjectV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).setTagToObjectV1(requestParameters.taggedobjectV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API adds tags to multiple objects. + * @summary Tag multiple objects + * @param {TaggedObjectsV1ApiSetTagsToManyObjectsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaggedObjectsV1Api + */ + public setTagsToManyObjectsV1(requestParameters: TaggedObjectsV1ApiSetTagsToManyObjectsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaggedObjectsV1ApiFp(this.configuration).setTagsToManyObjectsV1(requestParameters.bulkaddtaggedobjectV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DeleteTaggedObjectV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; +export type DeleteTaggedObjectV1TypeV1 = typeof DeleteTaggedObjectV1TypeV1[keyof typeof DeleteTaggedObjectV1TypeV1]; +/** + * @export + */ +export const GetTaggedObjectV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; +export type GetTaggedObjectV1TypeV1 = typeof GetTaggedObjectV1TypeV1[keyof typeof GetTaggedObjectV1TypeV1]; +/** + * @export + */ +export const ListTaggedObjectsByTypeV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; +export type ListTaggedObjectsByTypeV1TypeV1 = typeof ListTaggedObjectsByTypeV1TypeV1[keyof typeof ListTaggedObjectsByTypeV1TypeV1]; +/** + * @export + */ +export const PutTaggedObjectV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; +export type PutTaggedObjectV1TypeV1 = typeof PutTaggedObjectV1TypeV1[keyof typeof PutTaggedObjectV1TypeV1]; + + diff --git a/sdk-output/tagged_objects/base.ts b/sdk-output/tagged_objects/base.ts new file mode 100644 index 00000000..1aaa859c --- /dev/null +++ b/sdk-output/tagged_objects/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tagged Objects + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/tagged_objects/common.ts b/sdk-output/tagged_objects/common.ts new file mode 100644 index 00000000..7a6fb038 --- /dev/null +++ b/sdk-output/tagged_objects/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tagged Objects + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/tagged_objects/configuration.ts b/sdk-output/tagged_objects/configuration.ts new file mode 100644 index 00000000..a012c9a6 --- /dev/null +++ b/sdk-output/tagged_objects/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tagged Objects + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/tagged_objects/git_push.sh b/sdk-output/tagged_objects/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/tagged_objects/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/tagged_objects/index.ts b/sdk-output/tagged_objects/index.ts new file mode 100644 index 00000000..fccbf13b --- /dev/null +++ b/sdk-output/tagged_objects/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tagged Objects + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/tagged_objects/package.json b/sdk-output/tagged_objects/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/tagged_objects/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/tagged_objects/tsconfig.json b/sdk-output/tagged_objects/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/tagged_objects/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/tags/.gitignore b/sdk-output/tags/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/tags/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/tags/.npmignore b/sdk-output/tags/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/tags/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/tags/.openapi-generator-ignore b/sdk-output/tags/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/tags/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/tags/.openapi-generator/FILES b/sdk-output/tags/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/tags/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/tags/.openapi-generator/VERSION b/sdk-output/tags/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/tags/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/tags/.sdk-partition b/sdk-output/tags/.sdk-partition new file mode 100644 index 00000000..55cf7354 --- /dev/null +++ b/sdk-output/tags/.sdk-partition @@ -0,0 +1 @@ +tags \ No newline at end of file diff --git a/sdk-output/tags/README.md b/sdk-output/tags/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tags/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tags/api.ts b/sdk-output/tags/api.ts new file mode 100644 index 00000000..cd6e0f70 --- /dev/null +++ b/sdk-output/tags/api.ts @@ -0,0 +1,626 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tags + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListTagsV1401ResponseV1 + */ +export interface ListTagsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTagsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListTagsV1429ResponseV1 + */ +export interface ListTagsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTagsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Tagged object\'s category. + * @export + * @interface Tag2TagCategoryRefsInnerV1 + */ +export interface Tag2TagCategoryRefsInnerV1 { + /** + * DTO type of the tagged object\'s category. + * @type {string} + * @memberof Tag2TagCategoryRefsInnerV1 + */ + 'type'?: Tag2TagCategoryRefsInnerV1TypeV1; + /** + * Tagged object\'s ID. + * @type {string} + * @memberof Tag2TagCategoryRefsInnerV1 + */ + 'id'?: string; + /** + * Tagged object\'s display name. + * @type {string} + * @memberof Tag2TagCategoryRefsInnerV1 + */ + 'name'?: string; +} + +export const Tag2TagCategoryRefsInnerV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Application: 'APPLICATION', + Campaign: 'CAMPAIGN', + Entitlement: 'ENTITLEMENT', + Identity: 'IDENTITY', + Role: 'ROLE', + SodPolicy: 'SOD_POLICY', + Source: 'SOURCE' +} as const; + +export type Tag2TagCategoryRefsInnerV1TypeV1 = typeof Tag2TagCategoryRefsInnerV1TypeV1[keyof typeof Tag2TagCategoryRefsInnerV1TypeV1]; + +/** + * + * @export + * @interface Tag2V1 + */ +export interface Tag2V1 { + /** + * Tag id + * @type {string} + * @memberof Tag2V1 + */ + 'id': string; + /** + * Name of the tag. + * @type {string} + * @memberof Tag2V1 + */ + 'name': string; + /** + * Date the tag was created. + * @type {string} + * @memberof Tag2V1 + */ + 'created': string; + /** + * Date the tag was last modified. + * @type {string} + * @memberof Tag2V1 + */ + 'modified': string; + /** + * + * @type {Array} + * @memberof Tag2V1 + */ + 'tagCategoryRefs': Array; +} + +/** + * TagsV1Api - axios parameter creator + * @export + */ +export const TagsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create tag + * @param {Tag2V1} tag2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createTagV1: async (tag2V1: Tag2V1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'tag2V1' is not null or undefined + assertParamExists('createTagV1', 'tag2V1', tag2V1) + const localVarPath = `/tags/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(tag2V1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete tag + * @param {string} id The ID of the object reference to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTagByIdV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteTagByIdV1', 'id', id) + const localVarPath = `/tags/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, + }; + }, + /** + * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Get tag by id + * @param {string} id The ID of the object reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTagByIdV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getTagByIdV1', 'id', id) + const localVarPath = `/tags/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, + }; + }, + /** + * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary List tags + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* + * @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, name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTagsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/tags/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + } +}; + +/** + * TagsV1Api - functional programming interface + * @export + */ +export const TagsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TagsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create tag + * @param {Tag2V1} tag2V1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createTagV1(tag2V1: Tag2V1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createTagV1(tag2V1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TagsV1Api.createTagV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete tag + * @param {string} id The ID of the object reference to delete. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteTagByIdV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagByIdV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TagsV1Api.deleteTagByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Get tag by id + * @param {string} id The ID of the object reference to retrieve. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTagByIdV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTagByIdV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TagsV1Api.getTagByIdV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary List tags + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **name**: *eq, in, sw* + * @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, name, created, modified** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTagsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTagsV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TagsV1Api.listTagsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TagsV1Api - factory interface + * @export + */ +export const TagsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TagsV1ApiFp(configuration) + return { + /** + * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create tag + * @param {TagsV1ApiCreateTagV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createTagV1(requestParameters: TagsV1ApiCreateTagV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createTagV1(requestParameters.tag2V1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete tag + * @param {TagsV1ApiDeleteTagByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTagByIdV1(requestParameters: TagsV1ApiDeleteTagByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteTagByIdV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Get tag by id + * @param {TagsV1ApiGetTagByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTagByIdV1(requestParameters: TagsV1ApiGetTagByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTagByIdV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary List tags + * @param {TagsV1ApiListTagsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTagsV1(requestParameters: TagsV1ApiListTagsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTagsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createTagV1 operation in TagsV1Api. + * @export + * @interface TagsV1ApiCreateTagV1Request + */ +export interface TagsV1ApiCreateTagV1Request { + /** + * + * @type {Tag2V1} + * @memberof TagsV1ApiCreateTagV1 + */ + readonly tag2V1: Tag2V1 +} + +/** + * Request parameters for deleteTagByIdV1 operation in TagsV1Api. + * @export + * @interface TagsV1ApiDeleteTagByIdV1Request + */ +export interface TagsV1ApiDeleteTagByIdV1Request { + /** + * The ID of the object reference to delete. + * @type {string} + * @memberof TagsV1ApiDeleteTagByIdV1 + */ + readonly id: string +} + +/** + * Request parameters for getTagByIdV1 operation in TagsV1Api. + * @export + * @interface TagsV1ApiGetTagByIdV1Request + */ +export interface TagsV1ApiGetTagByIdV1Request { + /** + * The ID of the object reference to retrieve. + * @type {string} + * @memberof TagsV1ApiGetTagByIdV1 + */ + readonly id: string +} + +/** + * Request parameters for listTagsV1 operation in TagsV1Api. + * @export + * @interface TagsV1ApiListTagsV1Request + */ +export interface TagsV1ApiListTagsV1Request { + /** + * 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 TagsV1ApiListTagsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TagsV1ApiListTagsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TagsV1ApiListTagsV1 + */ + 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, in* **name**: *eq, in, sw* + * @type {string} + * @memberof TagsV1ApiListTagsV1 + */ + 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, name, created, modified** + * @type {string} + * @memberof TagsV1ApiListTagsV1 + */ + readonly sorters?: string +} + +/** + * TagsV1Api - object-oriented interface + * @export + * @class TagsV1Api + * @extends {BaseAPI} + */ +export class TagsV1Api extends BaseAPI { + /** + * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Create tag + * @param {TagsV1ApiCreateTagV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TagsV1Api + */ + public createTagV1(requestParameters: TagsV1ApiCreateTagV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TagsV1ApiFp(this.configuration).createTagV1(requestParameters.tag2V1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Delete tag + * @param {TagsV1ApiDeleteTagByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TagsV1Api + */ + public deleteTagByIdV1(requestParameters: TagsV1ApiDeleteTagByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TagsV1ApiFp(this.configuration).deleteTagByIdV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary Get tag by id + * @param {TagsV1ApiGetTagByIdV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TagsV1Api + */ + public getTagByIdV1(requestParameters: TagsV1ApiGetTagByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TagsV1ApiFp(this.configuration).getTagByIdV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + * @summary List tags + * @param {TagsV1ApiListTagsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TagsV1Api + */ + public listTagsV1(requestParameters: TagsV1ApiListTagsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TagsV1ApiFp(this.configuration).listTagsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/v2025/base.ts b/sdk-output/tags/base.ts similarity index 83% rename from sdk-output/v2025/base.ts rename to sdk-output/tags/base.ts index 87c63aba..6d655a93 100644 --- a/sdk-output/v2025/base.ts +++ b/sdk-output/tags/base.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2025 API + * Identity Security Cloud API - Tags * 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: v2025 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -19,7 +19,7 @@ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://sailpoint.api.identitynow.com/v2025".replace(/\/+$/, ""); +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); /** * @@ -50,10 +50,10 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; - this.basePath = configuration.basePath + "/v2025"|| this.basePath; + this.basePath = configuration.basePath || this.basePath; } } }; diff --git a/sdk-output/v2025/common.ts b/sdk-output/tags/common.ts similarity index 83% rename from sdk-output/v2025/common.ts rename to sdk-output/tags/common.ts index 34c5e841..eb73c315 100644 --- a/sdk-output/v2025/common.ts +++ b/sdk-output/tags/common.ts @@ -1,10 +1,10 @@ /* tslint:disable */ /* eslint-disable */ /** - * Identity Security Cloud V2025 API + * Identity Security Cloud API - Tags * 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: v2025 + * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -17,7 +17,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; /** * @@ -144,16 +143,15 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) - let userAgent = `SailPoint-SDK-TypeScript/1.8.69`; + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; } userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; const headers = { ...axiosArgs.axiosOptions.headers, - ...{'X-SailPoint-SDK':'typescript-1.8.69'}, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, ...{'User-Agent': userAgent}, } @@ -163,8 +161,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.basePath+ "/v2025" || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-output/tags/configuration.ts b/sdk-output/tags/configuration.ts new file mode 100644 index 00000000..a1015681 --- /dev/null +++ b/sdk-output/tags/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tags + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/tags/git_push.sh b/sdk-output/tags/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/tags/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/tags/index.ts b/sdk-output/tags/index.ts new file mode 100644 index 00000000..5e7a1a7a --- /dev/null +++ b/sdk-output/tags/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tags + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/tags/package.json b/sdk-output/tags/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/tags/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/tags/tsconfig.json b/sdk-output/tags/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/tags/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/task_management/.gitignore b/sdk-output/task_management/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/task_management/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/task_management/.npmignore b/sdk-output/task_management/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/task_management/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/task_management/.openapi-generator-ignore b/sdk-output/task_management/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/task_management/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/task_management/.openapi-generator/FILES b/sdk-output/task_management/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/task_management/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/task_management/.openapi-generator/VERSION b/sdk-output/task_management/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/task_management/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/task_management/.sdk-partition b/sdk-output/task_management/.sdk-partition new file mode 100644 index 00000000..26aa5703 --- /dev/null +++ b/sdk-output/task_management/.sdk-partition @@ -0,0 +1 @@ +task-management \ No newline at end of file diff --git a/sdk-output/task_management/README.md b/sdk-output/task_management/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/task_management/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/task_management/api.ts b/sdk-output/task_management/api.ts new file mode 100644 index 00000000..71d71156 --- /dev/null +++ b/sdk-output/task_management/api.ts @@ -0,0 +1,824 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Task Management + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTaskStatusV1401ResponseV1 + */ +export interface GetTaskStatusV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTaskStatusV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTaskStatusV1429ResponseV1 + */ +export interface GetTaskStatusV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTaskStatusV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Localized error message to indicate a failed invocation or error if any. + * @export + * @interface LocalizedmessageV1 + */ +export interface LocalizedmessageV1 { + /** + * Message locale + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'locale': string; + /** + * Message text + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'message': string; +} +/** + * + * @export + * @interface TargetV1 + */ +export interface TargetV1 { + /** + * Target ID + * @type {string} + * @memberof TargetV1 + */ + 'id'?: string; + /** + * Target type + * @type {string} + * @memberof TargetV1 + */ + 'type'?: TargetV1TypeV1 | null; + /** + * Target name + * @type {string} + * @memberof TargetV1 + */ + 'name'?: string; +} + +export const TargetV1TypeV1 = { + Application: 'APPLICATION', + Identity: 'IDENTITY' +} as const; + +export type TargetV1TypeV1 = typeof TargetV1TypeV1[keyof typeof TargetV1TypeV1]; + +/** + * Definition of a type of task, used to invoke tasks + * @export + * @interface TaskdefinitionsummaryV1 + */ +export interface TaskdefinitionsummaryV1 { + /** + * System-generated unique ID of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'id': string; + /** + * Name of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'uniqueName': string; + /** + * Description of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'description': string | null; + /** + * Name of the parent of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'parentName': string; + /** + * Executor of the TaskDefinition + * @type {string} + * @memberof TaskdefinitionsummaryV1 + */ + 'executor': string | null; + /** + * Formal parameters of the TaskDefinition, without values + * @type {{ [key: string]: any; }} + * @memberof TaskdefinitionsummaryV1 + */ + 'arguments': { [key: string]: any; }; +} +/** + * Task return details + * @export + * @interface TaskreturndetailsV1 + */ +export interface TaskreturndetailsV1 { + /** + * Display name of the TaskReturnDetails + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'name': string; + /** + * Attribute the TaskReturnDetails is for + * @type {string} + * @memberof TaskreturndetailsV1 + */ + 'attributeName': string; +} +/** + * Details and current status of a specific task + * @export + * @interface TaskstatusV1 + */ +export interface TaskstatusV1 { + /** + * System-generated unique ID of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'id': string; + /** + * Type of task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'type': TaskstatusV1TypeV1; + /** + * Name of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'uniqueName': string; + /** + * Description of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'description': string; + /** + * Name of the parent of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'parentName': string | null; + /** + * Service to execute the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'launcher': string; + /** + * + * @type {TargetV1} + * @memberof TaskstatusV1 + */ + 'target'?: TargetV1 | null; + /** + * Creation date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'created': string; + /** + * Last modification date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'modified': string | null; + /** + * Launch date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'launched': string | null; + /** + * Completion date of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'completed': string | null; + /** + * Completion status of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'completionStatus': TaskstatusV1CompletionStatusV1 | null; + /** + * Messages associated with the task this TaskStatus represents + * @type {Array} + * @memberof TaskstatusV1 + */ + 'messages': Array; + /** + * Return values from the task this TaskStatus represents + * @type {Array} + * @memberof TaskstatusV1 + */ + 'returns': Array; + /** + * Attributes of the task this TaskStatus represents + * @type {{ [key: string]: any; }} + * @memberof TaskstatusV1 + */ + 'attributes': { [key: string]: any; }; + /** + * Current progress of the task this TaskStatus represents + * @type {string} + * @memberof TaskstatusV1 + */ + 'progress': string | null; + /** + * Current percentage completion of the task this TaskStatus represents + * @type {number} + * @memberof TaskstatusV1 + */ + 'percentComplete': number; + /** + * + * @type {TaskdefinitionsummaryV1} + * @memberof TaskstatusV1 + */ + 'taskDefinitionSummary'?: TaskdefinitionsummaryV1; +} + +export const TaskstatusV1TypeV1 = { + Quartz: 'QUARTZ', + Qpoc: 'QPOC', + QueuedTask: 'QUEUED_TASK' +} as const; + +export type TaskstatusV1TypeV1 = typeof TaskstatusV1TypeV1[keyof typeof TaskstatusV1TypeV1]; +export const TaskstatusV1CompletionStatusV1 = { + Success: 'SUCCESS', + Warning: 'WARNING', + Error: 'ERROR', + Terminated: 'TERMINATED', + Temperror: 'TEMPERROR' +} as const; + +export type TaskstatusV1CompletionStatusV1 = typeof TaskstatusV1CompletionStatusV1[keyof typeof TaskstatusV1CompletionStatusV1]; + +/** + * + * @export + * @interface TaskstatusmessageParametersInnerV1 + */ +export interface TaskstatusmessageParametersInnerV1 { +} +/** + * TaskStatus Message + * @export + * @interface TaskstatusmessageV1 + */ +export interface TaskstatusmessageV1 { + /** + * Type of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'type': TaskstatusmessageV1TypeV1; + /** + * + * @type {LocalizedmessageV1} + * @memberof TaskstatusmessageV1 + */ + 'localizedText': LocalizedmessageV1 | null; + /** + * Key of the message + * @type {string} + * @memberof TaskstatusmessageV1 + */ + 'key': string; + /** + * Message parameters for internationalization + * @type {Array} + * @memberof TaskstatusmessageV1 + */ + 'parameters': Array | null; +} + +export const TaskstatusmessageV1TypeV1 = { + Info: 'INFO', + Warn: 'WARN', + Error: 'ERROR' +} as const; + +export type TaskstatusmessageV1TypeV1 = typeof TaskstatusmessageV1TypeV1[keyof typeof TaskstatusmessageV1TypeV1]; + + +/** + * TaskManagementV1Api - axios parameter creator + * @export + */ +export const TaskManagementV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. + * @summary Retrieve task status list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION + * @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: **created** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskStatusListV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/task-status/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + * @summary Get task status by id + * @param {string} id Task ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getTaskStatusV1', 'id', id) + const localVarPath = `/task-status/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, + }; + }, + /** + * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + * @summary Update task status by id + * @param {string} id Task ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateTaskStatusV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateTaskStatusV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('updateTaskStatusV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/task-status/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TaskManagementV1Api - functional programming interface + * @export + */ +export const TaskManagementV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TaskManagementV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. + * @summary Retrieve task status list + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION + * @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: **created** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTaskStatusListV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusListV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaskManagementV1Api.getTaskStatusListV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + * @summary Get task status by id + * @param {string} id Task ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTaskStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaskManagementV1Api.getTaskStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + * @summary Update task status by id + * @param {string} id Task ID. + * @param {Array} jsonpatchoperationV1 The JSONPatch payload used to update the object. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateTaskStatusV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatusV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TaskManagementV1Api.updateTaskStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TaskManagementV1Api - factory interface + * @export + */ +export const TaskManagementV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TaskManagementV1ApiFp(configuration) + return { + /** + * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. + * @summary Retrieve task status list + * @param {TaskManagementV1ApiGetTaskStatusListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskStatusListV1(requestParameters: TaskManagementV1ApiGetTaskStatusListV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getTaskStatusListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + * @summary Get task status by id + * @param {TaskManagementV1ApiGetTaskStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTaskStatusV1(requestParameters: TaskManagementV1ApiGetTaskStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTaskStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + * @summary Update task status by id + * @param {TaskManagementV1ApiUpdateTaskStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateTaskStatusV1(requestParameters: TaskManagementV1ApiUpdateTaskStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateTaskStatusV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getTaskStatusListV1 operation in TaskManagementV1Api. + * @export + * @interface TaskManagementV1ApiGetTaskStatusListV1Request + */ +export interface TaskManagementV1ApiGetTaskStatusListV1Request { + /** + * 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 TaskManagementV1ApiGetTaskStatusListV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TaskManagementV1ApiGetTaskStatusListV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TaskManagementV1ApiGetTaskStatusListV1 + */ + 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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION + * @type {string} + * @memberof TaskManagementV1ApiGetTaskStatusListV1 + */ + 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: **created** + * @type {string} + * @memberof TaskManagementV1ApiGetTaskStatusListV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for getTaskStatusV1 operation in TaskManagementV1Api. + * @export + * @interface TaskManagementV1ApiGetTaskStatusV1Request + */ +export interface TaskManagementV1ApiGetTaskStatusV1Request { + /** + * Task ID. + * @type {string} + * @memberof TaskManagementV1ApiGetTaskStatusV1 + */ + readonly id: string +} + +/** + * Request parameters for updateTaskStatusV1 operation in TaskManagementV1Api. + * @export + * @interface TaskManagementV1ApiUpdateTaskStatusV1Request + */ +export interface TaskManagementV1ApiUpdateTaskStatusV1Request { + /** + * Task ID. + * @type {string} + * @memberof TaskManagementV1ApiUpdateTaskStatusV1 + */ + readonly id: string + + /** + * The JSONPatch payload used to update the object. + * @type {Array} + * @memberof TaskManagementV1ApiUpdateTaskStatusV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * TaskManagementV1Api - object-oriented interface + * @export + * @class TaskManagementV1Api + * @extends {BaseAPI} + */ +export class TaskManagementV1Api extends BaseAPI { + /** + * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. + * @summary Retrieve task status list + * @param {TaskManagementV1ApiGetTaskStatusListV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaskManagementV1Api + */ + public getTaskStatusListV1(requestParameters: TaskManagementV1ApiGetTaskStatusListV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TaskManagementV1ApiFp(this.configuration).getTaskStatusListV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + * @summary Get task status by id + * @param {TaskManagementV1ApiGetTaskStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaskManagementV1Api + */ + public getTaskStatusV1(requestParameters: TaskManagementV1ApiGetTaskStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaskManagementV1ApiFp(this.configuration).getTaskStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + * @summary Update task status by id + * @param {TaskManagementV1ApiUpdateTaskStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TaskManagementV1Api + */ + public updateTaskStatusV1(requestParameters: TaskManagementV1ApiUpdateTaskStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TaskManagementV1ApiFp(this.configuration).updateTaskStatusV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/task_management/base.ts b/sdk-output/task_management/base.ts new file mode 100644 index 00000000..f86312c4 --- /dev/null +++ b/sdk-output/task_management/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Task Management + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/task_management/common.ts b/sdk-output/task_management/common.ts new file mode 100644 index 00000000..0a295219 --- /dev/null +++ b/sdk-output/task_management/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Task Management + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/task_management/configuration.ts b/sdk-output/task_management/configuration.ts new file mode 100644 index 00000000..41db8c15 --- /dev/null +++ b/sdk-output/task_management/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Task Management + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/task_management/git_push.sh b/sdk-output/task_management/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/task_management/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/task_management/index.ts b/sdk-output/task_management/index.ts new file mode 100644 index 00000000..63e5a8ec --- /dev/null +++ b/sdk-output/task_management/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Task Management + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/task_management/package.json b/sdk-output/task_management/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/task_management/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/task_management/tsconfig.json b/sdk-output/task_management/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/task_management/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/tenant/.gitignore b/sdk-output/tenant/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/tenant/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/tenant/.npmignore b/sdk-output/tenant/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/tenant/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/tenant/.openapi-generator-ignore b/sdk-output/tenant/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/tenant/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/tenant/.openapi-generator/FILES b/sdk-output/tenant/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/tenant/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/tenant/.openapi-generator/VERSION b/sdk-output/tenant/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/tenant/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/tenant/.sdk-partition b/sdk-output/tenant/.sdk-partition new file mode 100644 index 00000000..34f104e4 --- /dev/null +++ b/sdk-output/tenant/.sdk-partition @@ -0,0 +1 @@ +tenant \ No newline at end of file diff --git a/sdk-output/tenant/README.md b/sdk-output/tenant/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tenant/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tenant/api.ts b/sdk-output/tenant/api.ts new file mode 100644 index 00000000..b186c88c --- /dev/null +++ b/sdk-output/tenant/api.ts @@ -0,0 +1,410 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTenantV1401ResponseV1 + */ +export interface GetTenantV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTenantV1429ResponseV1 + */ +export interface GetTenantV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantV1429ResponseV1 + */ + 'message'?: any; +} +/** + * + * @export + * @interface LicenseV1 + */ +export interface LicenseV1 { + /** + * Name of the license + * @type {string} + * @memberof LicenseV1 + */ + 'licenseId'?: string; + /** + * Legacy name of the license + * @type {string} + * @memberof LicenseV1 + */ + 'legacyFeatureName'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface ProductV1 + */ +export interface ProductV1 { + /** + * Name of the Product + * @type {string} + * @memberof ProductV1 + */ + 'productName'?: string; + /** + * URL of the Product + * @type {string} + * @memberof ProductV1 + */ + 'url'?: string; + /** + * An identifier for a specific product-tenant combination + * @type {string} + * @memberof ProductV1 + */ + 'productTenantId'?: string; + /** + * Product region + * @type {string} + * @memberof ProductV1 + */ + 'productRegion'?: string; + /** + * Right needed for the Product + * @type {string} + * @memberof ProductV1 + */ + 'productRight'?: string; + /** + * API URL of the Product + * @type {string} + * @memberof ProductV1 + */ + 'apiUrl'?: string | null; + /** + * + * @type {Array} + * @memberof ProductV1 + */ + 'licenses'?: Array; + /** + * Additional attributes for a product + * @type {{ [key: string]: any; }} + * @memberof ProductV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Zone + * @type {string} + * @memberof ProductV1 + */ + 'zone'?: string; + /** + * Status of the product + * @type {string} + * @memberof ProductV1 + */ + 'status'?: string; + /** + * Status datetime + * @type {string} + * @memberof ProductV1 + */ + 'statusDateTime'?: string; + /** + * If there\'s a tenant provisioning failure then reason will have the description of error + * @type {string} + * @memberof ProductV1 + */ + 'reason'?: string; + /** + * Product could have additional notes added during tenant provisioning. + * @type {string} + * @memberof ProductV1 + */ + 'notes'?: string; + /** + * Date when the product was created + * @type {string} + * @memberof ProductV1 + */ + 'dateCreated'?: string | null; + /** + * Date when the product was last updated + * @type {string} + * @memberof ProductV1 + */ + 'lastUpdated'?: string | null; + /** + * Type of org + * @type {string} + * @memberof ProductV1 + */ + 'orgType'?: ProductV1OrgTypeV1 | null; +} + +export const ProductV1OrgTypeV1 = { + Development: 'development', + Staging: 'staging', + Production: 'production', + Test: 'test', + Partner: 'partner', + Training: 'training', + Demonstration: 'demonstration', + Sandbox: 'sandbox' +} as const; + +export type ProductV1OrgTypeV1 = typeof ProductV1OrgTypeV1[keyof typeof ProductV1OrgTypeV1]; + +/** + * + * @export + * @interface TenantV1 + */ +export interface TenantV1 { + /** + * The unique identifier for the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'id'?: string; + /** + * Abbreviated name of the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'name'?: string; + /** + * Human-readable name of the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'fullName'?: string; + /** + * Deployment pod for the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'pod'?: string; + /** + * Deployment region for the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'region'?: string; + /** + * Description of the Tenant + * @type {string} + * @memberof TenantV1 + */ + 'description'?: string; + /** + * + * @type {Array} + * @memberof TenantV1 + */ + 'products'?: Array; +} + +/** + * TenantV1Api - axios parameter creator + * @export + */ +export const TenantV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This rest endpoint can be used to retrieve tenant details. + * @summary Get tenant information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/tenant/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TenantV1Api - functional programming interface + * @export + */ +export const TenantV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TenantV1ApiAxiosParamCreator(configuration) + return { + /** + * This rest endpoint can be used to retrieve tenant details. + * @summary Get tenant information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTenantV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TenantV1Api.getTenantV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TenantV1Api - factory interface + * @export + */ +export const TenantV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TenantV1ApiFp(configuration) + return { + /** + * This rest endpoint can be used to retrieve tenant details. + * @summary Get tenant information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTenantV1(axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * TenantV1Api - object-oriented interface + * @export + * @class TenantV1Api + * @extends {BaseAPI} + */ +export class TenantV1Api extends BaseAPI { + /** + * This rest endpoint can be used to retrieve tenant details. + * @summary Get tenant information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TenantV1Api + */ + public getTenantV1(axiosOptions?: RawAxiosRequestConfig) { + return TenantV1ApiFp(this.configuration).getTenantV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/tenant/base.ts b/sdk-output/tenant/base.ts new file mode 100644 index 00000000..8add2c98 --- /dev/null +++ b/sdk-output/tenant/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/tenant/common.ts b/sdk-output/tenant/common.ts new file mode 100644 index 00000000..d482c9a2 --- /dev/null +++ b/sdk-output/tenant/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/tenant/configuration.ts b/sdk-output/tenant/configuration.ts new file mode 100644 index 00000000..77dea1bc --- /dev/null +++ b/sdk-output/tenant/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/tenant/git_push.sh b/sdk-output/tenant/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/tenant/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/tenant/index.ts b/sdk-output/tenant/index.ts new file mode 100644 index 00000000..ad07ac4a --- /dev/null +++ b/sdk-output/tenant/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/tenant/package.json b/sdk-output/tenant/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/tenant/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/tenant/tsconfig.json b/sdk-output/tenant/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/tenant/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/tenant_context/.gitignore b/sdk-output/tenant_context/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/tenant_context/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/tenant_context/.npmignore b/sdk-output/tenant_context/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/tenant_context/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/tenant_context/.openapi-generator-ignore b/sdk-output/tenant_context/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/tenant_context/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/tenant_context/.openapi-generator/FILES b/sdk-output/tenant_context/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/tenant_context/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/tenant_context/.openapi-generator/VERSION b/sdk-output/tenant_context/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/tenant_context/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/tenant_context/.sdk-partition b/sdk-output/tenant_context/.sdk-partition new file mode 100644 index 00000000..56ff2aa1 --- /dev/null +++ b/sdk-output/tenant_context/.sdk-partition @@ -0,0 +1 @@ +tenant-context \ No newline at end of file diff --git a/sdk-output/tenant_context/README.md b/sdk-output/tenant_context/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tenant_context/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tenant_context/api.ts b/sdk-output/tenant_context/api.ts new file mode 100644 index 00000000..929778c6 --- /dev/null +++ b/sdk-output/tenant_context/api.ts @@ -0,0 +1,380 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant Context + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTenantContextV1200ResponseInnerV1 + */ +export interface GetTenantContextV1200ResponseInnerV1 { + /** + * + * @type {string} + * @memberof GetTenantContextV1200ResponseInnerV1 + */ + 'key'?: string; + /** + * + * @type {string} + * @memberof GetTenantContextV1200ResponseInnerV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface GetTenantContextV1401ResponseV1 + */ +export interface GetTenantContextV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantContextV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTenantContextV1429ResponseV1 + */ +export interface GetTenantContextV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantContextV1429ResponseV1 + */ + 'message'?: any; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + + +/** + * TenantContextV1Api - axios parameter creator + * @export + */ +export const TenantContextV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. + * @summary Retrieve tenant context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantContextV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/tenant-context/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. + * @summary Update tenant context + * @param {JsonpatchoperationV1} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchTenantContextV1: async (jsonpatchoperationV1: JsonpatchoperationV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchTenantContextV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/tenant-context/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; + + + + 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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TenantContextV1Api - functional programming interface + * @export + */ +export const TenantContextV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TenantContextV1ApiAxiosParamCreator(configuration) + return { + /** + * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. + * @summary Retrieve tenant context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTenantContextV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantContextV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TenantContextV1Api.getTenantContextV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. + * @summary Update tenant context + * @param {JsonpatchoperationV1} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchTenantContextV1(jsonpatchoperationV1: JsonpatchoperationV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchTenantContextV1(jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TenantContextV1Api.patchTenantContextV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TenantContextV1Api - factory interface + * @export + */ +export const TenantContextV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TenantContextV1ApiFp(configuration) + return { + /** + * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. + * @summary Retrieve tenant context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantContextV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getTenantContextV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. + * @summary Update tenant context + * @param {TenantContextV1ApiPatchTenantContextV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchTenantContextV1(requestParameters: TenantContextV1ApiPatchTenantContextV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchTenantContextV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for patchTenantContextV1 operation in TenantContextV1Api. + * @export + * @interface TenantContextV1ApiPatchTenantContextV1Request + */ +export interface TenantContextV1ApiPatchTenantContextV1Request { + /** + * + * @type {JsonpatchoperationV1} + * @memberof TenantContextV1ApiPatchTenantContextV1 + */ + readonly jsonpatchoperationV1: JsonpatchoperationV1 +} + +/** + * TenantContextV1Api - object-oriented interface + * @export + * @class TenantContextV1Api + * @extends {BaseAPI} + */ +export class TenantContextV1Api extends BaseAPI { + /** + * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. + * @summary Retrieve tenant context + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TenantContextV1Api + */ + public getTenantContextV1(axiosOptions?: RawAxiosRequestConfig) { + return TenantContextV1ApiFp(this.configuration).getTenantContextV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. + * @summary Update tenant context + * @param {TenantContextV1ApiPatchTenantContextV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TenantContextV1Api + */ + public patchTenantContextV1(requestParameters: TenantContextV1ApiPatchTenantContextV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TenantContextV1ApiFp(this.configuration).patchTenantContextV1(requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/tenant_context/base.ts b/sdk-output/tenant_context/base.ts new file mode 100644 index 00000000..6e79bba2 --- /dev/null +++ b/sdk-output/tenant_context/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant Context + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/tenant_context/common.ts b/sdk-output/tenant_context/common.ts new file mode 100644 index 00000000..7a682b74 --- /dev/null +++ b/sdk-output/tenant_context/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant Context + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/tenant_context/configuration.ts b/sdk-output/tenant_context/configuration.ts new file mode 100644 index 00000000..4dd96888 --- /dev/null +++ b/sdk-output/tenant_context/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant Context + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/tenant_context/git_push.sh b/sdk-output/tenant_context/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/tenant_context/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/tenant_context/index.ts b/sdk-output/tenant_context/index.ts new file mode 100644 index 00000000..09edfbb7 --- /dev/null +++ b/sdk-output/tenant_context/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Tenant Context + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/tenant_context/package.json b/sdk-output/tenant_context/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/tenant_context/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/tenant_context/tsconfig.json b/sdk-output/tenant_context/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/tenant_context/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/transforms/.gitignore b/sdk-output/transforms/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/transforms/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/transforms/.npmignore b/sdk-output/transforms/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/transforms/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/transforms/.openapi-generator-ignore b/sdk-output/transforms/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/transforms/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/transforms/.openapi-generator/FILES b/sdk-output/transforms/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/transforms/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/transforms/.openapi-generator/VERSION b/sdk-output/transforms/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/transforms/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/transforms/.sdk-partition b/sdk-output/transforms/.sdk-partition new file mode 100644 index 00000000..cceb29a0 --- /dev/null +++ b/sdk-output/transforms/.sdk-partition @@ -0,0 +1 @@ +transforms \ No newline at end of file diff --git a/sdk-output/transforms/README.md b/sdk-output/transforms/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/transforms/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/transforms/api.ts b/sdk-output/transforms/api.ts new file mode 100644 index 00000000..619b18c4 --- /dev/null +++ b/sdk-output/transforms/api.ts @@ -0,0 +1,789 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Transforms + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface ListTransformsV1401ResponseV1 + */ +export interface ListTransformsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTransformsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListTransformsV1429ResponseV1 + */ +export interface ListTransformsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTransformsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The representation of an internally- or customer-defined transform. + * @export + * @interface TransformV1 + */ +export interface TransformV1 { + /** + * Unique name of this transform + * @type {string} + * @memberof TransformV1 + */ + 'name': string; + /** + * The type of transform operation + * @type {string} + * @memberof TransformV1 + */ + 'type': TransformV1TypeV1; + /** + * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + * @type {object} + * @memberof TransformV1 + */ + 'attributes': object | null; +} + +export const TransformV1TypeV1 = { + AccountAttribute: 'accountAttribute', + Base64Decode: 'base64Decode', + Base64Encode: 'base64Encode', + Concat: 'concat', + Conditional: 'conditional', + DateCompare: 'dateCompare', + DateFormat: 'dateFormat', + DateMath: 'dateMath', + DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', + E164phone: 'e164phone', + FirstValid: 'firstValid', + Rule: 'rule', + IdentityAttribute: 'identityAttribute', + IndexOf: 'indexOf', + Iso3166: 'iso3166', + LastIndexOf: 'lastIndexOf', + LeftPad: 'leftPad', + Lookup: 'lookup', + Lower: 'lower', + NormalizeNames: 'normalizeNames', + RandomAlphaNumeric: 'randomAlphaNumeric', + RandomNumeric: 'randomNumeric', + Reference: 'reference', + ReplaceAll: 'replaceAll', + Replace: 'replace', + RightPad: 'rightPad', + Split: 'split', + Static: 'static', + Substring: 'substring', + Trim: 'trim', + Upper: 'upper', + UsernameGenerator: 'usernameGenerator', + Uuid: 'uuid', + DisplayName: 'displayName', + Rfc5646: 'rfc5646' +} as const; + +export type TransformV1TypeV1 = typeof TransformV1TypeV1[keyof typeof TransformV1TypeV1]; + +/** + * + * @export + * @interface TransformreadV1 + */ +export interface TransformreadV1 { + /** + * Unique name of this transform + * @type {string} + * @memberof TransformreadV1 + */ + 'name': string; + /** + * The type of transform operation + * @type {string} + * @memberof TransformreadV1 + */ + 'type': TransformreadV1TypeV1; + /** + * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. + * @type {object} + * @memberof TransformreadV1 + */ + 'attributes': object | null; + /** + * Unique ID of this transform + * @type {string} + * @memberof TransformreadV1 + */ + 'id': string; + /** + * Indicates whether this is an internal SailPoint-created transform or a customer-created transform + * @type {boolean} + * @memberof TransformreadV1 + */ + 'internal': boolean; +} + +export const TransformreadV1TypeV1 = { + AccountAttribute: 'accountAttribute', + Base64Decode: 'base64Decode', + Base64Encode: 'base64Encode', + Concat: 'concat', + Conditional: 'conditional', + DateCompare: 'dateCompare', + DateFormat: 'dateFormat', + DateMath: 'dateMath', + DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', + E164phone: 'e164phone', + FirstValid: 'firstValid', + Rule: 'rule', + IdentityAttribute: 'identityAttribute', + IndexOf: 'indexOf', + Iso3166: 'iso3166', + LastIndexOf: 'lastIndexOf', + LeftPad: 'leftPad', + Lookup: 'lookup', + Lower: 'lower', + NormalizeNames: 'normalizeNames', + RandomAlphaNumeric: 'randomAlphaNumeric', + RandomNumeric: 'randomNumeric', + Reference: 'reference', + ReplaceAll: 'replaceAll', + Replace: 'replace', + RightPad: 'rightPad', + Split: 'split', + Static: 'static', + Substring: 'substring', + Trim: 'trim', + Upper: 'upper', + UsernameGenerator: 'usernameGenerator', + Uuid: 'uuid', + DisplayName: 'displayName', + Rfc5646: 'rfc5646' +} as const; + +export type TransformreadV1TypeV1 = typeof TransformreadV1TypeV1[keyof typeof TransformreadV1TypeV1]; + + +/** + * TransformsV1Api - axios parameter creator + * @export + */ +export const TransformsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + * @summary Create transform + * @param {TransformV1} transformV1 The transform to be created. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createTransformV1: async (transformV1: TransformV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'transformV1' is not null or undefined + assertParamExists('createTransformV1', 'transformV1', transformV1) + const localVarPath = `/transforms/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(transformV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + * @summary Delete a transform + * @param {string} id ID of the transform to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTransformV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteTransformV1', 'id', id) + const localVarPath = `/transforms/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, + }; + }, + /** + * This API returns the transform specified by the given ID. + * @summary Transform by id + * @param {string} id ID of the transform to retrieve + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTransformV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getTransformV1', 'id', id) + const localVarPath = `/transforms/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, + }; + }, + /** + * Gets a list of all saved transform objects. + * @summary List transforms + * @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} [name] Name of the transform to retrieve from the list. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTransformsV1: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/transforms/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 (name !== undefined) { + localVarQueryParameter['name'] = name; + } + + 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, + }; + }, + /** + * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. + * @summary Update a transform + * @param {string} id ID of the transform to update + * @param {TransformV1} [transformV1] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateTransformV1: async (id: string, transformV1?: TransformV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateTransformV1', 'id', id) + const localVarPath = `/transforms/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: 'PUT', ...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(transformV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TransformsV1Api - functional programming interface + * @export + */ +export const TransformsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TransformsV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + * @summary Create transform + * @param {TransformV1} transformV1 The transform to be created. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createTransformV1(transformV1: TransformV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createTransformV1(transformV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TransformsV1Api.createTransformV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + * @summary Delete a transform + * @param {string} id ID of the transform to delete + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteTransformV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransformV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TransformsV1Api.deleteTransformV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API returns the transform specified by the given ID. + * @summary Transform by id + * @param {string} id ID of the transform to retrieve + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTransformV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTransformV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TransformsV1Api.getTransformV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a list of all saved transform objects. + * @summary List transforms + * @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} [name] Name of the transform to retrieve from the list. + * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTransformsV1(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTransformsV1(offset, limit, count, name, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TransformsV1Api.listTransformsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. + * @summary Update a transform + * @param {string} id ID of the transform to update + * @param {TransformV1} [transformV1] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateTransformV1(id: string, transformV1?: TransformV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransformV1(id, transformV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TransformsV1Api.updateTransformV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TransformsV1Api - factory interface + * @export + */ +export const TransformsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TransformsV1ApiFp(configuration) + return { + /** + * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + * @summary Create transform + * @param {TransformsV1ApiCreateTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createTransformV1(requestParameters: TransformsV1ApiCreateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createTransformV1(requestParameters.transformV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + * @summary Delete a transform + * @param {TransformsV1ApiDeleteTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteTransformV1(requestParameters: TransformsV1ApiDeleteTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteTransformV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API returns the transform specified by the given ID. + * @summary Transform by id + * @param {TransformsV1ApiGetTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTransformV1(requestParameters: TransformsV1ApiGetTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTransformV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of all saved transform objects. + * @summary List transforms + * @param {TransformsV1ApiListTransformsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTransformsV1(requestParameters: TransformsV1ApiListTransformsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTransformsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. + * @summary Update a transform + * @param {TransformsV1ApiUpdateTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateTransformV1(requestParameters: TransformsV1ApiUpdateTransformV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateTransformV1(requestParameters.id, requestParameters.transformV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createTransformV1 operation in TransformsV1Api. + * @export + * @interface TransformsV1ApiCreateTransformV1Request + */ +export interface TransformsV1ApiCreateTransformV1Request { + /** + * The transform to be created. + * @type {TransformV1} + * @memberof TransformsV1ApiCreateTransformV1 + */ + readonly transformV1: TransformV1 +} + +/** + * Request parameters for deleteTransformV1 operation in TransformsV1Api. + * @export + * @interface TransformsV1ApiDeleteTransformV1Request + */ +export interface TransformsV1ApiDeleteTransformV1Request { + /** + * ID of the transform to delete + * @type {string} + * @memberof TransformsV1ApiDeleteTransformV1 + */ + readonly id: string +} + +/** + * Request parameters for getTransformV1 operation in TransformsV1Api. + * @export + * @interface TransformsV1ApiGetTransformV1Request + */ +export interface TransformsV1ApiGetTransformV1Request { + /** + * ID of the transform to retrieve + * @type {string} + * @memberof TransformsV1ApiGetTransformV1 + */ + readonly id: string +} + +/** + * Request parameters for listTransformsV1 operation in TransformsV1Api. + * @export + * @interface TransformsV1ApiListTransformsV1Request + */ +export interface TransformsV1ApiListTransformsV1Request { + /** + * 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 TransformsV1ApiListTransformsV1 + */ + 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 TransformsV1ApiListTransformsV1 + */ + 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 TransformsV1ApiListTransformsV1 + */ + readonly count?: boolean + + /** + * Name of the transform to retrieve from the list. + * @type {string} + * @memberof TransformsV1ApiListTransformsV1 + */ + readonly name?: 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: **internal**: *eq* **name**: *eq, sw* + * @type {string} + * @memberof TransformsV1ApiListTransformsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for updateTransformV1 operation in TransformsV1Api. + * @export + * @interface TransformsV1ApiUpdateTransformV1Request + */ +export interface TransformsV1ApiUpdateTransformV1Request { + /** + * ID of the transform to update + * @type {string} + * @memberof TransformsV1ApiUpdateTransformV1 + */ + readonly id: string + + /** + * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. + * @type {TransformV1} + * @memberof TransformsV1ApiUpdateTransformV1 + */ + readonly transformV1?: TransformV1 +} + +/** + * TransformsV1Api - object-oriented interface + * @export + * @class TransformsV1Api + * @extends {BaseAPI} + */ +export class TransformsV1Api extends BaseAPI { + /** + * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + * @summary Create transform + * @param {TransformsV1ApiCreateTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TransformsV1Api + */ + public createTransformV1(requestParameters: TransformsV1ApiCreateTransformV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TransformsV1ApiFp(this.configuration).createTransformV1(requestParameters.transformV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + * @summary Delete a transform + * @param {TransformsV1ApiDeleteTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TransformsV1Api + */ + public deleteTransformV1(requestParameters: TransformsV1ApiDeleteTransformV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TransformsV1ApiFp(this.configuration).deleteTransformV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API returns the transform specified by the given ID. + * @summary Transform by id + * @param {TransformsV1ApiGetTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TransformsV1Api + */ + public getTransformV1(requestParameters: TransformsV1ApiGetTransformV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TransformsV1ApiFp(this.configuration).getTransformV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of all saved transform objects. + * @summary List transforms + * @param {TransformsV1ApiListTransformsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TransformsV1Api + */ + public listTransformsV1(requestParameters: TransformsV1ApiListTransformsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TransformsV1ApiFp(this.configuration).listTransformsV1(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. + * @summary Update a transform + * @param {TransformsV1ApiUpdateTransformV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TransformsV1Api + */ + public updateTransformV1(requestParameters: TransformsV1ApiUpdateTransformV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TransformsV1ApiFp(this.configuration).updateTransformV1(requestParameters.id, requestParameters.transformV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/transforms/base.ts b/sdk-output/transforms/base.ts new file mode 100644 index 00000000..df29c258 --- /dev/null +++ b/sdk-output/transforms/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Transforms + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/transforms/common.ts b/sdk-output/transforms/common.ts new file mode 100644 index 00000000..7c229c22 --- /dev/null +++ b/sdk-output/transforms/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Transforms + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/transforms/configuration.ts b/sdk-output/transforms/configuration.ts new file mode 100644 index 00000000..ddfa4978 --- /dev/null +++ b/sdk-output/transforms/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Transforms + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/transforms/git_push.sh b/sdk-output/transforms/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/transforms/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/transforms/index.ts b/sdk-output/transforms/index.ts new file mode 100644 index 00000000..615d09e6 --- /dev/null +++ b/sdk-output/transforms/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Transforms + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/transforms/package.json b/sdk-output/transforms/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/transforms/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/transforms/tsconfig.json b/sdk-output/transforms/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/transforms/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/triggers/.gitignore b/sdk-output/triggers/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/triggers/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/triggers/.npmignore b/sdk-output/triggers/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/triggers/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/triggers/.openapi-generator-ignore b/sdk-output/triggers/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/triggers/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/triggers/.openapi-generator/FILES b/sdk-output/triggers/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/triggers/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/triggers/.openapi-generator/VERSION b/sdk-output/triggers/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/triggers/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/triggers/.sdk-partition b/sdk-output/triggers/.sdk-partition new file mode 100644 index 00000000..fa05d2b3 --- /dev/null +++ b/sdk-output/triggers/.sdk-partition @@ -0,0 +1 @@ +triggers \ No newline at end of file diff --git a/sdk-output/triggers/README.md b/sdk-output/triggers/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/triggers/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/triggers/api.ts b/sdk-output/triggers/api.ts new file mode 100644 index 00000000..3f190919 --- /dev/null +++ b/sdk-output/triggers/api.ts @@ -0,0 +1,6196 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Triggers + * 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'; + +/** + * Identity who approved the access item request. + * @export + * @interface AccessitemapproverdtoV1 + */ +export interface AccessitemapproverdtoV1 { + /** + * DTO type of identity who approved the access item request. + * @type {string} + * @memberof AccessitemapproverdtoV1 + */ + 'type'?: AccessitemapproverdtoV1TypeV1; + /** + * ID of identity who approved the access item request. + * @type {string} + * @memberof AccessitemapproverdtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity who approved the access item request. + * @type {string} + * @memberof AccessitemapproverdtoV1 + */ + 'name'?: string; +} + +export const AccessitemapproverdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemapproverdtoV1TypeV1 = typeof AccessitemapproverdtoV1TypeV1[keyof typeof AccessitemapproverdtoV1TypeV1]; + +/** + * Identity the access item is requested for. + * @export + * @interface AccessitemrequestedfordtoV1 + */ +export interface AccessitemrequestedfordtoV1 { + /** + * DTO type of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedfordtoV1 + */ + 'type'?: AccessitemrequestedfordtoV1TypeV1; + /** + * ID of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedfordtoV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity the access item is requested for. + * @type {string} + * @memberof AccessitemrequestedfordtoV1 + */ + 'name'?: string; +} + +export const AccessitemrequestedfordtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemrequestedfordtoV1TypeV1 = typeof AccessitemrequestedfordtoV1TypeV1[keyof typeof AccessitemrequestedfordtoV1TypeV1]; + +/** + * Access item requester\'s identity. + * @export + * @interface AccessitemrequesterdtoV1 + */ +export interface AccessitemrequesterdtoV1 { + /** + * Access item requester\'s DTO type. + * @type {string} + * @memberof AccessitemrequesterdtoV1 + */ + 'type'?: AccessitemrequesterdtoV1TypeV1; + /** + * Access item requester\'s identity ID. + * @type {string} + * @memberof AccessitemrequesterdtoV1 + */ + 'id'?: string; + /** + * Access item owner\'s human-readable display name. + * @type {string} + * @memberof AccessitemrequesterdtoV1 + */ + 'name'?: string; +} + +export const AccessitemrequesterdtoV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessitemrequesterdtoV1TypeV1 = typeof AccessitemrequesterdtoV1TypeV1[keyof typeof AccessitemrequesterdtoV1TypeV1]; + +/** + * + * @export + * @interface Accessrequestdynamicapprover2V1 + */ +export interface Accessrequestdynamicapprover2V1 { + /** + * The unique ID of the identity to add to the approver list for the access request. + * @type {string} + * @memberof Accessrequestdynamicapprover2V1 + */ + 'id': string; + /** + * The name of the identity to add to the approver list for the access request. + * @type {string} + * @memberof Accessrequestdynamicapprover2V1 + */ + 'name': string; + /** + * The type of object being referenced. + * @type {string} + * @memberof Accessrequestdynamicapprover2V1 + */ + 'type': Accessrequestdynamicapprover2V1TypeV1; +} + +export const Accessrequestdynamicapprover2V1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type Accessrequestdynamicapprover2V1TypeV1 = typeof Accessrequestdynamicapprover2V1TypeV1[keyof typeof Accessrequestdynamicapprover2V1TypeV1]; + +/** + * + * @export + * @interface AccessrequestdynamicapproverRequestedItemsInnerV1 + */ +export interface AccessrequestdynamicapproverRequestedItemsInnerV1 { + /** + * The unique ID of the access item. + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'id': string; + /** + * Human friendly name of the access item. + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'name': string; + /** + * Extended description of the access item. + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'description'?: string | null; + /** + * The type of access item being requested. + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'type': AccessrequestdynamicapproverRequestedItemsInnerV1TypeV1; + /** + * Grant or revoke the access item + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'operation': AccessrequestdynamicapproverRequestedItemsInnerV1OperationV1; + /** + * A comment from the requestor on why the access is needed. + * @type {string} + * @memberof AccessrequestdynamicapproverRequestedItemsInnerV1 + */ + 'comment'?: string | null; +} + +export const AccessrequestdynamicapproverRequestedItemsInnerV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccessrequestdynamicapproverRequestedItemsInnerV1TypeV1 = typeof AccessrequestdynamicapproverRequestedItemsInnerV1TypeV1[keyof typeof AccessrequestdynamicapproverRequestedItemsInnerV1TypeV1]; +export const AccessrequestdynamicapproverRequestedItemsInnerV1OperationV1 = { + Add: 'Add', + Remove: 'Remove' +} as const; + +export type AccessrequestdynamicapproverRequestedItemsInnerV1OperationV1 = typeof AccessrequestdynamicapproverRequestedItemsInnerV1OperationV1[keyof typeof AccessrequestdynamicapproverRequestedItemsInnerV1OperationV1]; + +/** + * + * @export + * @interface AccessrequestdynamicapproverV1 + */ +export interface AccessrequestdynamicapproverV1 { + /** + * The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. + * @type {string} + * @memberof AccessrequestdynamicapproverV1 + */ + 'accessRequestId': string; + /** + * Identities access was requested for. + * @type {Array} + * @memberof AccessrequestdynamicapproverV1 + */ + 'requestedFor': Array; + /** + * The access items that are being requested. + * @type {Array} + * @memberof AccessrequestdynamicapproverV1 + */ + 'requestedItems': Array; + /** + * + * @type {AccessitemrequesterdtoV1} + * @memberof AccessrequestdynamicapproverV1 + */ + 'requestedBy': AccessitemrequesterdtoV1; +} +/** + * The identity of the approver. + * @export + * @interface AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 + */ +export interface AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 { + /** + * The type of object that is referenced + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 + */ + 'type': AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1TypeV1; + /** + * ID of identity who approved the access item request. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 + */ + 'id': string; + /** + * Human-readable display name of identity who approved the access item request. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 + */ + 'name': string; +} + +export const AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1TypeV1 = typeof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1TypeV1[keyof typeof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1TypeV1]; + +/** + * + * @export + * @interface AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + */ +export interface AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 { + /** + * A comment left by the approver. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + */ + 'approvalComment'?: string | null; + /** + * The final decision of the approver. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + */ + 'approvalDecision': AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1ApprovalDecisionV1; + /** + * The name of the approver + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + */ + 'approverName': string; + /** + * + * @type {AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + */ + 'approver': AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1; +} + +export const AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1ApprovalDecisionV1 = { + Approved: 'APPROVED', + Denied: 'DENIED' +} as const; + +export type AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1ApprovalDecisionV1 = typeof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1ApprovalDecisionV1[keyof typeof AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1ApprovalDecisionV1]; + +/** + * + * @export + * @interface AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ +export interface AccessrequestpostapprovalRequestedItemsStatusInnerV1 { + /** + * The unique ID of the access item being requested. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'id': string; + /** + * The human friendly name of the access item. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'name': string; + /** + * Detailed description of the access item. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'description'?: string | null; + /** + * The type of access item. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'type': AccessrequestpostapprovalRequestedItemsStatusInnerV1TypeV1; + /** + * The action to perform on the access item. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'operation': AccessrequestpostapprovalRequestedItemsStatusInnerV1OperationV1; + /** + * A comment from the identity requesting the access. + * @type {string} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'comment'?: string | null; + /** + * Additional customer defined metadata about the access item. + * @type {{ [key: string]: any; }} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'clientMetadata'?: { [key: string]: any; } | null; + /** + * A list of one or more approvers for the access request. + * @type {Array} + * @memberof AccessrequestpostapprovalRequestedItemsStatusInnerV1 + */ + 'approvalInfo': Array; +} + +export const AccessrequestpostapprovalRequestedItemsStatusInnerV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccessrequestpostapprovalRequestedItemsStatusInnerV1TypeV1 = typeof AccessrequestpostapprovalRequestedItemsStatusInnerV1TypeV1[keyof typeof AccessrequestpostapprovalRequestedItemsStatusInnerV1TypeV1]; +export const AccessrequestpostapprovalRequestedItemsStatusInnerV1OperationV1 = { + Add: 'Add', + Remove: 'Remove' +} as const; + +export type AccessrequestpostapprovalRequestedItemsStatusInnerV1OperationV1 = typeof AccessrequestpostapprovalRequestedItemsStatusInnerV1OperationV1[keyof typeof AccessrequestpostapprovalRequestedItemsStatusInnerV1OperationV1]; + +/** + * + * @export + * @interface AccessrequestpostapprovalV1 + */ +export interface AccessrequestpostapprovalV1 { + /** + * The unique ID of the access request. + * @type {string} + * @memberof AccessrequestpostapprovalV1 + */ + 'accessRequestId': string; + /** + * Identities access was requested for. + * @type {Array} + * @memberof AccessrequestpostapprovalV1 + */ + 'requestedFor': Array; + /** + * Details on the outcome of each access item. + * @type {Array} + * @memberof AccessrequestpostapprovalV1 + */ + 'requestedItemsStatus': Array; + /** + * + * @type {AccessitemrequesterdtoV1} + * @memberof AccessrequestpostapprovalV1 + */ + 'requestedBy': AccessitemrequesterdtoV1; +} +/** + * + * @export + * @interface Accessrequestpreapproval2V1 + */ +export interface Accessrequestpreapproval2V1 { + /** + * Whether or not to approve the access request. + * @type {boolean} + * @memberof Accessrequestpreapproval2V1 + */ + 'approved': boolean; + /** + * A comment about the decision to approve or deny the request. + * @type {string} + * @memberof Accessrequestpreapproval2V1 + */ + 'comment': string; + /** + * The name of the entity that approved or denied the request. + * @type {string} + * @memberof Accessrequestpreapproval2V1 + */ + 'approver': string; +} +/** + * + * @export + * @interface AccessrequestpreapprovalRequestedItemsInnerV1 + */ +export interface AccessrequestpreapprovalRequestedItemsInnerV1 { + /** + * The unique ID of the access item being requested. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'id': string; + /** + * The human friendly name of the access item. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'name': string; + /** + * Detailed description of the access item. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'description'?: string | null; + /** + * The type of access item. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'type': AccessrequestpreapprovalRequestedItemsInnerV1TypeV1; + /** + * The action to perform on the access item. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'operation': AccessrequestpreapprovalRequestedItemsInnerV1OperationV1; + /** + * A comment from the identity requesting the access. + * @type {string} + * @memberof AccessrequestpreapprovalRequestedItemsInnerV1 + */ + 'comment'?: string | null; +} + +export const AccessrequestpreapprovalRequestedItemsInnerV1TypeV1 = { + AccessProfile: 'ACCESS_PROFILE', + Role: 'ROLE', + Entitlement: 'ENTITLEMENT' +} as const; + +export type AccessrequestpreapprovalRequestedItemsInnerV1TypeV1 = typeof AccessrequestpreapprovalRequestedItemsInnerV1TypeV1[keyof typeof AccessrequestpreapprovalRequestedItemsInnerV1TypeV1]; +export const AccessrequestpreapprovalRequestedItemsInnerV1OperationV1 = { + Add: 'Add', + Remove: 'Remove' +} as const; + +export type AccessrequestpreapprovalRequestedItemsInnerV1OperationV1 = typeof AccessrequestpreapprovalRequestedItemsInnerV1OperationV1[keyof typeof AccessrequestpreapprovalRequestedItemsInnerV1OperationV1]; + +/** + * + * @export + * @interface AccessrequestpreapprovalV1 + */ +export interface AccessrequestpreapprovalV1 { + /** + * The unique ID of the access request. + * @type {string} + * @memberof AccessrequestpreapprovalV1 + */ + 'accessRequestId': string; + /** + * Identities access was requested for. + * @type {Array} + * @memberof AccessrequestpreapprovalV1 + */ + 'requestedFor': Array; + /** + * Details of the access items being requested. + * @type {Array} + * @memberof AccessrequestpreapprovalV1 + */ + 'requestedItems': Array; + /** + * + * @type {AccessitemrequesterdtoV1} + * @memberof AccessrequestpreapprovalV1 + */ + 'requestedBy': AccessitemrequesterdtoV1; +} +/** + * The source the accounts are being aggregated from. + * @export + * @interface AccountaggregationcompletedSourceV1 + */ +export interface AccountaggregationcompletedSourceV1 { + /** + * The DTO type of the source the accounts are being aggregated from. + * @type {string} + * @memberof AccountaggregationcompletedSourceV1 + */ + 'type': AccountaggregationcompletedSourceV1TypeV1; + /** + * The ID of the source the accounts are being aggregated from. + * @type {string} + * @memberof AccountaggregationcompletedSourceV1 + */ + 'id': string; + /** + * Display name of the source the accounts are being aggregated from. + * @type {string} + * @memberof AccountaggregationcompletedSourceV1 + */ + 'name': string; +} + +export const AccountaggregationcompletedSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccountaggregationcompletedSourceV1TypeV1 = typeof AccountaggregationcompletedSourceV1TypeV1[keyof typeof AccountaggregationcompletedSourceV1TypeV1]; + +/** + * Overall statistics about the account aggregation. + * @export + * @interface AccountaggregationcompletedStatsV1 + */ +export interface AccountaggregationcompletedStatsV1 { + /** + * The number of accounts which were scanned / iterated over. + * @type {number} + * @memberof AccountaggregationcompletedStatsV1 + */ + 'scanned': number; + /** + * The number of accounts which existed before, but had no changes. + * @type {number} + * @memberof AccountaggregationcompletedStatsV1 + */ + 'unchanged': number; + /** + * The number of accounts which existed before, but had changes. + * @type {number} + * @memberof AccountaggregationcompletedStatsV1 + */ + 'changed': number; + /** + * The number of accounts which are new - have not existed before. + * @type {number} + * @memberof AccountaggregationcompletedStatsV1 + */ + 'added': number; + /** + * The number accounts which existed before, but no longer exist (thus getting removed). + * @type {number} + * @memberof AccountaggregationcompletedStatsV1 + */ + 'removed': number; +} +/** + * + * @export + * @interface AccountaggregationcompletedV1 + */ +export interface AccountaggregationcompletedV1 { + /** + * + * @type {AccountaggregationcompletedSourceV1} + * @memberof AccountaggregationcompletedV1 + */ + 'source': AccountaggregationcompletedSourceV1; + /** + * The overall status of the aggregation. + * @type {string} + * @memberof AccountaggregationcompletedV1 + */ + 'status': AccountaggregationcompletedV1StatusV1; + /** + * The date and time when the account aggregation started. + * @type {string} + * @memberof AccountaggregationcompletedV1 + */ + 'started': string; + /** + * The date and time when the account aggregation finished. + * @type {string} + * @memberof AccountaggregationcompletedV1 + */ + 'completed': string; + /** + * A list of errors that occurred during the aggregation. + * @type {Array} + * @memberof AccountaggregationcompletedV1 + */ + 'errors': Array | null; + /** + * A list of warnings that occurred during the aggregation. + * @type {Array} + * @memberof AccountaggregationcompletedV1 + */ + 'warnings': Array | null; + /** + * + * @type {AccountaggregationcompletedStatsV1} + * @memberof AccountaggregationcompletedV1 + */ + 'stats': AccountaggregationcompletedStatsV1; +} + +export const AccountaggregationcompletedV1StatusV1 = { + Success: 'Success', + Failed: 'Failed', + Terminated: 'Terminated' +} as const; + +export type AccountaggregationcompletedV1StatusV1 = typeof AccountaggregationcompletedV1StatusV1[keyof typeof AccountaggregationcompletedV1StatusV1]; + +/** + * Details of the account where the attributes changed. + * @export + * @interface AccountattributeschangedAccountV1 + */ +export interface AccountattributeschangedAccountV1 { + /** + * SailPoint generated unique identifier. + * @type {string} + * @memberof AccountattributeschangedAccountV1 + */ + 'id': string; + /** + * The source\'s unique identifier for the account. UUID is generated by the source system. + * @type {string} + * @memberof AccountattributeschangedAccountV1 + */ + 'uuid': string | null; + /** + * Name of the account. + * @type {string} + * @memberof AccountattributeschangedAccountV1 + */ + 'name': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof AccountattributeschangedAccountV1 + */ + 'nativeIdentity': string; + /** + * The type of the account + * @type {string} + * @memberof AccountattributeschangedAccountV1 + */ + 'type': AccountattributeschangedAccountV1TypeV1; +} + +export const AccountattributeschangedAccountV1TypeV1 = { + Account: 'ACCOUNT' +} as const; + +export type AccountattributeschangedAccountV1TypeV1 = typeof AccountattributeschangedAccountV1TypeV1[keyof typeof AccountattributeschangedAccountV1TypeV1]; + +/** + * @type AccountattributeschangedChangesInnerNewValueV1 + * The new value of the attribute. + * @export + */ +export type AccountattributeschangedChangesInnerNewValueV1 = Array | boolean | string; + +/** + * @type AccountattributeschangedChangesInnerOldValueV1 + * The previous value of the attribute. + * @export + */ +export type AccountattributeschangedChangesInnerOldValueV1 = Array | boolean | string; + +/** + * + * @export + * @interface AccountattributeschangedChangesInnerV1 + */ +export interface AccountattributeschangedChangesInnerV1 { + /** + * The name of the attribute. + * @type {string} + * @memberof AccountattributeschangedChangesInnerV1 + */ + 'attribute': string; + /** + * + * @type {AccountattributeschangedChangesInnerOldValueV1} + * @memberof AccountattributeschangedChangesInnerV1 + */ + 'oldValue': AccountattributeschangedChangesInnerOldValueV1 | null; + /** + * + * @type {AccountattributeschangedChangesInnerNewValueV1} + * @memberof AccountattributeschangedChangesInnerV1 + */ + 'newValue': AccountattributeschangedChangesInnerNewValueV1 | null; +} +/** + * The identity whose account attributes were updated. + * @export + * @interface AccountattributeschangedIdentityV1 + */ +export interface AccountattributeschangedIdentityV1 { + /** + * DTO type of the identity whose account attributes were updated. + * @type {string} + * @memberof AccountattributeschangedIdentityV1 + */ + 'type': AccountattributeschangedIdentityV1TypeV1; + /** + * ID of the identity whose account attributes were updated. + * @type {string} + * @memberof AccountattributeschangedIdentityV1 + */ + 'id': string; + /** + * Display name of the identity whose account attributes were updated. + * @type {string} + * @memberof AccountattributeschangedIdentityV1 + */ + 'name': string; +} + +export const AccountattributeschangedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccountattributeschangedIdentityV1TypeV1 = typeof AccountattributeschangedIdentityV1TypeV1[keyof typeof AccountattributeschangedIdentityV1TypeV1]; + +/** + * The source that contains the account. + * @export + * @interface AccountattributeschangedSourceV1 + */ +export interface AccountattributeschangedSourceV1 { + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof AccountattributeschangedSourceV1 + */ + 'id': string; + /** + * The type of object that is referenced + * @type {string} + * @memberof AccountattributeschangedSourceV1 + */ + 'type': AccountattributeschangedSourceV1TypeV1; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof AccountattributeschangedSourceV1 + */ + 'name': string; +} + +export const AccountattributeschangedSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccountattributeschangedSourceV1TypeV1 = typeof AccountattributeschangedSourceV1TypeV1[keyof typeof AccountattributeschangedSourceV1TypeV1]; + +/** + * + * @export + * @interface AccountattributeschangedV1 + */ +export interface AccountattributeschangedV1 { + /** + * + * @type {AccountattributeschangedIdentityV1} + * @memberof AccountattributeschangedV1 + */ + 'identity': AccountattributeschangedIdentityV1; + /** + * + * @type {AccountattributeschangedSourceV1} + * @memberof AccountattributeschangedV1 + */ + 'source': AccountattributeschangedSourceV1; + /** + * + * @type {AccountattributeschangedAccountV1} + * @memberof AccountattributeschangedV1 + */ + 'account': AccountattributeschangedAccountV1; + /** + * A list of attributes that changed. + * @type {Array} + * @memberof AccountattributeschangedV1 + */ + 'changes': Array; +} +/** + * The correlated account. + * @export + * @interface AccountcorrelatedAccountV1 + */ +export interface AccountcorrelatedAccountV1 { + /** + * The correlated account\'s DTO type. + * @type {string} + * @memberof AccountcorrelatedAccountV1 + */ + 'type': AccountcorrelatedAccountV1TypeV1; + /** + * The correlated account\'s ID. + * @type {string} + * @memberof AccountcorrelatedAccountV1 + */ + 'id': string; + /** + * The correlated account\'s display name. + * @type {string} + * @memberof AccountcorrelatedAccountV1 + */ + 'name': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof AccountcorrelatedAccountV1 + */ + 'nativeIdentity': string; + /** + * The source\'s unique identifier for the account. UUID is generated by the source system. + * @type {string} + * @memberof AccountcorrelatedAccountV1 + */ + 'uuid'?: string | null; +} + +export const AccountcorrelatedAccountV1TypeV1 = { + Account: 'ACCOUNT' +} as const; + +export type AccountcorrelatedAccountV1TypeV1 = typeof AccountcorrelatedAccountV1TypeV1[keyof typeof AccountcorrelatedAccountV1TypeV1]; + +/** + * Identity the account is correlated with. + * @export + * @interface AccountcorrelatedIdentityV1 + */ +export interface AccountcorrelatedIdentityV1 { + /** + * DTO type of the identity the account is correlated with. + * @type {string} + * @memberof AccountcorrelatedIdentityV1 + */ + 'type': AccountcorrelatedIdentityV1TypeV1; + /** + * ID of the identity the account is correlated with. + * @type {string} + * @memberof AccountcorrelatedIdentityV1 + */ + 'id': string; + /** + * Display name of the identity the account is correlated with. + * @type {string} + * @memberof AccountcorrelatedIdentityV1 + */ + 'name': string; +} + +export const AccountcorrelatedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccountcorrelatedIdentityV1TypeV1 = typeof AccountcorrelatedIdentityV1TypeV1[keyof typeof AccountcorrelatedIdentityV1TypeV1]; + +/** + * The source the accounts are being correlated from. + * @export + * @interface AccountcorrelatedSourceV1 + */ +export interface AccountcorrelatedSourceV1 { + /** + * The DTO type of the source the accounts are being correlated from. + * @type {string} + * @memberof AccountcorrelatedSourceV1 + */ + 'type': AccountcorrelatedSourceV1TypeV1; + /** + * The ID of the source the accounts are being correlated from. + * @type {string} + * @memberof AccountcorrelatedSourceV1 + */ + 'id': string; + /** + * Display name of the source the accounts are being correlated from. + * @type {string} + * @memberof AccountcorrelatedSourceV1 + */ + 'name': string; +} + +export const AccountcorrelatedSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccountcorrelatedSourceV1TypeV1 = typeof AccountcorrelatedSourceV1TypeV1[keyof typeof AccountcorrelatedSourceV1TypeV1]; + +/** + * + * @export + * @interface AccountcorrelatedV1 + */ +export interface AccountcorrelatedV1 { + /** + * + * @type {AccountcorrelatedIdentityV1} + * @memberof AccountcorrelatedV1 + */ + 'identity': AccountcorrelatedIdentityV1; + /** + * + * @type {AccountcorrelatedSourceV1} + * @memberof AccountcorrelatedV1 + */ + 'source': AccountcorrelatedSourceV1; + /** + * + * @type {AccountcorrelatedAccountV1} + * @memberof AccountcorrelatedV1 + */ + 'account': AccountcorrelatedAccountV1; + /** + * The attributes associated with the account. Attributes are unique per source. + * @type {{ [key: string]: any; }} + * @memberof AccountcorrelatedV1 + */ + 'attributes': { [key: string]: any; }; + /** + * The number of entitlements associated with this account. + * @type {number} + * @memberof AccountcorrelatedV1 + */ + 'entitlementCount'?: number; +} +/** + * Details about the event. + * @export + * @interface AccountcreatedEventV1 + */ +export interface AccountcreatedEventV1 { + /** + * The type of event. + * @type {string} + * @memberof AccountcreatedEventV1 + */ + 'type': AccountcreatedEventV1TypeV1; + /** + * The cause of the event. + * @type {string} + * @memberof AccountcreatedEventV1 + */ + 'cause': AccountcreatedEventV1CauseV1; +} + +export const AccountcreatedEventV1TypeV1 = { + AccountCreatedV2: 'ACCOUNT_CREATED_V2' +} as const; + +export type AccountcreatedEventV1TypeV1 = typeof AccountcreatedEventV1TypeV1[keyof typeof AccountcreatedEventV1TypeV1]; +export const AccountcreatedEventV1CauseV1 = { + Aggregation: 'AGGREGATION', + Provisioning: 'PROVISIONING' +} as const; + +export type AccountcreatedEventV1CauseV1 = typeof AccountcreatedEventV1CauseV1[keyof typeof AccountcreatedEventV1CauseV1]; + +/** + * + * @export + * @interface AccountcreatedV1 + */ +export interface AccountcreatedV1 { + /** + * + * @type {AccountcreatedEventV1} + * @memberof AccountcreatedV1 + */ + 'event': AccountcreatedEventV1; + /** + * + * @type {AccountsourcereferenceV1} + * @memberof AccountcreatedV1 + */ + 'source': AccountsourcereferenceV1; + /** + * + * @type {AccountV2} + * @memberof AccountcreatedV1 + */ + 'account': AccountV2; + /** + * + * @type {Identityreference2V1} + * @memberof AccountcreatedV1 + */ + 'identity': Identityreference2V1; +} +/** + * Details about the event. + * @export + * @interface AccountdeletedEventV1 + */ +export interface AccountdeletedEventV1 { + /** + * The type of event. + * @type {string} + * @memberof AccountdeletedEventV1 + */ + 'type': AccountdeletedEventV1TypeV1; + /** + * The cause of the event. + * @type {string} + * @memberof AccountdeletedEventV1 + */ + 'cause': AccountdeletedEventV1CauseV1; +} + +export const AccountdeletedEventV1TypeV1 = { + AccountDeletedV2: 'ACCOUNT_DELETED_V2' +} as const; + +export type AccountdeletedEventV1TypeV1 = typeof AccountdeletedEventV1TypeV1[keyof typeof AccountdeletedEventV1TypeV1]; +export const AccountdeletedEventV1CauseV1 = { + Aggregation: 'AGGREGATION', + Provisioning: 'PROVISIONING' +} as const; + +export type AccountdeletedEventV1CauseV1 = typeof AccountdeletedEventV1CauseV1[keyof typeof AccountdeletedEventV1CauseV1]; + +/** + * + * @export + * @interface AccountdeletedV1 + */ +export interface AccountdeletedV1 { + /** + * + * @type {AccountdeletedEventV1} + * @memberof AccountdeletedV1 + */ + 'event': AccountdeletedEventV1; + /** + * + * @type {AccountsourcereferenceV1} + * @memberof AccountdeletedV1 + */ + 'source': AccountsourcereferenceV1; + /** + * + * @type {AccountV2} + * @memberof AccountdeletedV1 + */ + 'account': AccountV2; + /** + * + * @type {Identityreference2V1} + * @memberof AccountdeletedV1 + */ + 'identity': Identityreference2V1; +} +/** + * Reference to the source that has been aggregated. + * @export + * @interface AccountscollectedforaggregationSourceV1 + */ +export interface AccountscollectedforaggregationSourceV1 { + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof AccountscollectedforaggregationSourceV1 + */ + 'id': string; + /** + * The type of object that is referenced + * @type {string} + * @memberof AccountscollectedforaggregationSourceV1 + */ + 'type': AccountscollectedforaggregationSourceV1TypeV1; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof AccountscollectedforaggregationSourceV1 + */ + 'name': string; +} + +export const AccountscollectedforaggregationSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccountscollectedforaggregationSourceV1TypeV1 = typeof AccountscollectedforaggregationSourceV1TypeV1[keyof typeof AccountscollectedforaggregationSourceV1TypeV1]; + +/** + * Overall statistics about the account collection. + * @export + * @interface AccountscollectedforaggregationStatsV1 + */ +export interface AccountscollectedforaggregationStatsV1 { + /** + * The number of accounts which were scanned / iterated over. + * @type {number} + * @memberof AccountscollectedforaggregationStatsV1 + */ + 'scanned': number; + /** + * The number of accounts which existed before, but had no changes. + * @type {number} + * @memberof AccountscollectedforaggregationStatsV1 + */ + 'unchanged': number; + /** + * The number of accounts which existed before, but had changes. + * @type {number} + * @memberof AccountscollectedforaggregationStatsV1 + */ + 'changed': number; + /** + * The number of accounts which are new - have not existed before. + * @type {number} + * @memberof AccountscollectedforaggregationStatsV1 + */ + 'added': number; + /** + * The number accounts which existed before, but no longer exist (thus getting removed). + * @type {number} + * @memberof AccountscollectedforaggregationStatsV1 + */ + 'removed': number; +} +/** + * + * @export + * @interface AccountscollectedforaggregationV1 + */ +export interface AccountscollectedforaggregationV1 { + /** + * + * @type {AccountscollectedforaggregationSourceV1} + * @memberof AccountscollectedforaggregationV1 + */ + 'source': AccountscollectedforaggregationSourceV1; + /** + * The overall status of the collection. + * @type {string} + * @memberof AccountscollectedforaggregationV1 + */ + 'status': AccountscollectedforaggregationV1StatusV1; + /** + * The date and time when the account collection started. + * @type {string} + * @memberof AccountscollectedforaggregationV1 + */ + 'started': string; + /** + * The date and time when the account collection finished. + * @type {string} + * @memberof AccountscollectedforaggregationV1 + */ + 'completed': string; + /** + * A list of errors that occurred during the collection. + * @type {Array} + * @memberof AccountscollectedforaggregationV1 + */ + 'errors': Array | null; + /** + * A list of warnings that occurred during the collection. + * @type {Array} + * @memberof AccountscollectedforaggregationV1 + */ + 'warnings': Array | null; + /** + * + * @type {AccountscollectedforaggregationStatsV1} + * @memberof AccountscollectedforaggregationV1 + */ + 'stats': AccountscollectedforaggregationStatsV1; +} + +export const AccountscollectedforaggregationV1StatusV1 = { + Success: 'Success', + Failed: 'Failed', + Terminated: 'Terminated' +} as const; + +export type AccountscollectedforaggregationV1StatusV1 = typeof AccountscollectedforaggregationV1StatusV1[keyof typeof AccountscollectedforaggregationV1StatusV1]; + +/** + * Details about the governance group of the source. + * @export + * @interface AccountsourcereferenceGovernanceGroupV1 + */ +export interface AccountsourcereferenceGovernanceGroupV1 { + /** + * ID of the governance group. + * @type {string} + * @memberof AccountsourcereferenceGovernanceGroupV1 + */ + 'id': string; + /** + * Name of the governance group. + * @type {string} + * @memberof AccountsourcereferenceGovernanceGroupV1 + */ + 'name': string; +} +/** + * Details about the owner of the source. + * @export + * @interface AccountsourcereferenceOwnerV1 + */ +export interface AccountsourcereferenceOwnerV1 { + /** + * ID of the source owner. + * @type {string} + * @memberof AccountsourcereferenceOwnerV1 + */ + 'id': string; + /** + * Name of the source owner. + * @type {string} + * @memberof AccountsourcereferenceOwnerV1 + */ + 'name': string; +} +/** + * Details about the account source. + * @export + * @interface AccountsourcereferenceV1 + */ +export interface AccountsourcereferenceV1 { + /** + * The unique ID of the source. + * @type {string} + * @memberof AccountsourcereferenceV1 + */ + 'id': string; + /** + * The name of the source. + * @type {string} + * @memberof AccountsourcereferenceV1 + */ + 'name': string; + /** + * The alias of the source. + * @type {string} + * @memberof AccountsourcereferenceV1 + */ + 'alias': string; + /** + * + * @type {AccountsourcereferenceOwnerV1} + * @memberof AccountsourcereferenceV1 + */ + 'owner': AccountsourcereferenceOwnerV1; + /** + * + * @type {AccountsourcereferenceGovernanceGroupV1} + * @memberof AccountsourcereferenceV1 + */ + 'governanceGroup': AccountsourcereferenceGovernanceGroupV1; +} +/** + * Uncorrelated account. + * @export + * @interface AccountuncorrelatedAccountV1 + */ +export interface AccountuncorrelatedAccountV1 { + /** + * Uncorrelated account\'s DTO type. + * @type {string} + * @memberof AccountuncorrelatedAccountV1 + */ + 'type': AccountuncorrelatedAccountV1TypeV1; + /** + * Uncorrelated account\'s ID. + * @type {string} + * @memberof AccountuncorrelatedAccountV1 + */ + 'id': string; + /** + * Uncorrelated account\'s display name. + * @type {string} + * @memberof AccountuncorrelatedAccountV1 + */ + 'name': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof AccountuncorrelatedAccountV1 + */ + 'nativeIdentity': string; + /** + * The source\'s unique identifier for the account. UUID is generated by the source system. + * @type {string} + * @memberof AccountuncorrelatedAccountV1 + */ + 'uuid'?: string | null; +} + +export const AccountuncorrelatedAccountV1TypeV1 = { + Account: 'ACCOUNT' +} as const; + +export type AccountuncorrelatedAccountV1TypeV1 = typeof AccountuncorrelatedAccountV1TypeV1[keyof typeof AccountuncorrelatedAccountV1TypeV1]; + +/** + * Identity the account is uncorrelated with. + * @export + * @interface AccountuncorrelatedIdentityV1 + */ +export interface AccountuncorrelatedIdentityV1 { + /** + * DTO type of the identity the account is uncorrelated with. + * @type {string} + * @memberof AccountuncorrelatedIdentityV1 + */ + 'type': AccountuncorrelatedIdentityV1TypeV1; + /** + * ID of the identity the account is uncorrelated with. + * @type {string} + * @memberof AccountuncorrelatedIdentityV1 + */ + 'id': string; + /** + * Display name of the identity the account is uncorrelated with. + * @type {string} + * @memberof AccountuncorrelatedIdentityV1 + */ + 'name': string; +} + +export const AccountuncorrelatedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type AccountuncorrelatedIdentityV1TypeV1 = typeof AccountuncorrelatedIdentityV1TypeV1[keyof typeof AccountuncorrelatedIdentityV1TypeV1]; + +/** + * The source the accounts are uncorrelated from. + * @export + * @interface AccountuncorrelatedSourceV1 + */ +export interface AccountuncorrelatedSourceV1 { + /** + * The DTO type of the source the accounts are uncorrelated from. + * @type {string} + * @memberof AccountuncorrelatedSourceV1 + */ + 'type': AccountuncorrelatedSourceV1TypeV1; + /** + * The ID of the source the accounts are uncorrelated from. + * @type {string} + * @memberof AccountuncorrelatedSourceV1 + */ + 'id': string; + /** + * Display name of the source the accounts are uncorrelated from. + * @type {string} + * @memberof AccountuncorrelatedSourceV1 + */ + 'name': string; +} + +export const AccountuncorrelatedSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type AccountuncorrelatedSourceV1TypeV1 = typeof AccountuncorrelatedSourceV1TypeV1[keyof typeof AccountuncorrelatedSourceV1TypeV1]; + +/** + * + * @export + * @interface AccountuncorrelatedV1 + */ +export interface AccountuncorrelatedV1 { + /** + * + * @type {AccountuncorrelatedIdentityV1} + * @memberof AccountuncorrelatedV1 + */ + 'identity': AccountuncorrelatedIdentityV1; + /** + * + * @type {AccountuncorrelatedSourceV1} + * @memberof AccountuncorrelatedV1 + */ + 'source': AccountuncorrelatedSourceV1; + /** + * + * @type {AccountuncorrelatedAccountV1} + * @memberof AccountuncorrelatedV1 + */ + 'account': AccountuncorrelatedAccountV1; + /** + * The number of entitlements associated with this account. + * @type {number} + * @memberof AccountuncorrelatedV1 + */ + 'entitlementCount'?: number; +} +/** + * The type of the entitlement. + * @export + * @interface AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 + */ +export interface AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 { + /** + * The unique identifier of the owner. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 + */ + 'id'?: string; + /** + * The name of the owner. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 + */ + 'name'?: string | null; + /** + * The type of the owner. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 + */ + 'type'?: string; +} +/** + * + * @export + * @interface AccountupdatedEntitlementChangesInnerAddedInnerV1 + */ +export interface AccountupdatedEntitlementChangesInnerAddedInnerV1 { + /** + * The unique identifier of the entitlement. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerV1 + */ + 'id'?: string | null; + /** + * The name of the entitlement. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerV1 + */ + 'name'?: string | null; + /** + * + * @type {AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerV1 + */ + 'owner'?: AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1; + /** + * The value of the entitlement. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerAddedInnerV1 + */ + 'value'?: string; +} +/** + * + * @export + * @interface AccountupdatedEntitlementChangesInnerV1 + */ +export interface AccountupdatedEntitlementChangesInnerV1 { + /** + * The name of the entitlement attribute that was changed. + * @type {string} + * @memberof AccountupdatedEntitlementChangesInnerV1 + */ + 'attributeName': string; + /** + * The entitlements that were added. + * @type {Array} + * @memberof AccountupdatedEntitlementChangesInnerV1 + */ + 'added': Array | null; + /** + * The entitlements that were removed. + * @type {Array} + * @memberof AccountupdatedEntitlementChangesInnerV1 + */ + 'removed': Array | null; +} +/** + * Details about the event. + * @export + * @interface AccountupdatedEventV1 + */ +export interface AccountupdatedEventV1 { + /** + * The type of event. + * @type {string} + * @memberof AccountupdatedEventV1 + */ + 'type': AccountupdatedEventV1TypeV1; + /** + * The cause of the event. + * @type {string} + * @memberof AccountupdatedEventV1 + */ + 'cause': AccountupdatedEventV1CauseV1; +} + +export const AccountupdatedEventV1TypeV1 = { + AccountUpdatedV2: 'ACCOUNT_UPDATED_V2' +} as const; + +export type AccountupdatedEventV1TypeV1 = typeof AccountupdatedEventV1TypeV1[keyof typeof AccountupdatedEventV1TypeV1]; +export const AccountupdatedEventV1CauseV1 = { + Aggregation: 'AGGREGATION', + Provisioning: 'PROVISIONING', + PasswordChange: 'PASSWORD_CHANGE' +} as const; + +export type AccountupdatedEventV1CauseV1 = typeof AccountupdatedEventV1CauseV1[keyof typeof AccountupdatedEventV1CauseV1]; + +/** + * @type AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 + * @export + */ +export type AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 = Array | boolean | number | string; + +/** + * + * @export + * @interface AccountupdatedMultiValueAttributeChangesInnerV1 + */ +export interface AccountupdatedMultiValueAttributeChangesInnerV1 { + /** + * The name of the attribute that was changed. + * @type {string} + * @memberof AccountupdatedMultiValueAttributeChangesInnerV1 + */ + 'name': string; + /** + * The values that were added to the attribute. + * @type {Array} + * @memberof AccountupdatedMultiValueAttributeChangesInnerV1 + */ + 'addedValues': Array; + /** + * The values that were removed from the attribute. + * @type {Array} + * @memberof AccountupdatedMultiValueAttributeChangesInnerV1 + */ + 'removedValues': Array; +} +/** + * @type AccountupdatedSingleValueAttributeChangesInnerNewValueV1 + * The new value of the attribute after the change. + * @export + */ +export type AccountupdatedSingleValueAttributeChangesInnerNewValueV1 = Array | boolean | number | string; + +/** + * @type AccountupdatedSingleValueAttributeChangesInnerOldValueV1 + * The old value of the attribute before the change. + * @export + */ +export type AccountupdatedSingleValueAttributeChangesInnerOldValueV1 = Array | boolean | number | string; + +/** + * + * @export + * @interface AccountupdatedSingleValueAttributeChangesInnerV1 + */ +export interface AccountupdatedSingleValueAttributeChangesInnerV1 { + /** + * The name of the attribute that was changed. + * @type {string} + * @memberof AccountupdatedSingleValueAttributeChangesInnerV1 + */ + 'name': string; + /** + * + * @type {AccountupdatedSingleValueAttributeChangesInnerOldValueV1} + * @memberof AccountupdatedSingleValueAttributeChangesInnerV1 + */ + 'oldValue': AccountupdatedSingleValueAttributeChangesInnerOldValueV1 | null; + /** + * + * @type {AccountupdatedSingleValueAttributeChangesInnerNewValueV1} + * @memberof AccountupdatedSingleValueAttributeChangesInnerV1 + */ + 'newValue': AccountupdatedSingleValueAttributeChangesInnerNewValueV1 | null; +} +/** + * + * @export + * @interface AccountupdatedV1 + */ +export interface AccountupdatedV1 { + /** + * + * @type {AccountupdatedEventV1} + * @memberof AccountupdatedV1 + */ + 'event': AccountupdatedEventV1; + /** + * + * @type {AccountsourcereferenceV1} + * @memberof AccountupdatedV1 + */ + 'source': AccountsourcereferenceV1; + /** + * + * @type {AccountV2} + * @memberof AccountupdatedV1 + */ + 'account': AccountV2; + /** + * + * @type {Identityreference2V1} + * @memberof AccountupdatedV1 + */ + 'identity': Identityreference2V1; + /** + * The types of changes that occurred to the account. + * @type {Array} + * @memberof AccountupdatedV1 + */ + 'accountChangeTypes': Array; + /** + * Details about the single-value attribute changes that occurred to the account. + * @type {Array} + * @memberof AccountupdatedV1 + */ + 'singleValueAttributeChanges': Array | null; + /** + * Details about the multi-value attribute changes that occurred to the account. + * @type {Array} + * @memberof AccountupdatedV1 + */ + 'multiValueAttributeChanges': Array | null; + /** + * Details about the entitlement changes that occurred to the account. + * @type {Array} + * @memberof AccountupdatedV1 + */ + 'entitlementChanges': Array | null; +} + +export const AccountupdatedV1AccountChangeTypesV1 = { + AttributesChanged: 'ATTRIBUTES_CHANGED', + EntitlementsAdded: 'ENTITLEMENTS_ADDED', + EntitlementsRemoved: 'ENTITLEMENTS_REMOVED' +} as const; + +export type AccountupdatedV1AccountChangeTypesV1 = typeof AccountupdatedV1AccountChangeTypesV1[keyof typeof AccountupdatedV1AccountChangeTypesV1]; + +/** + * Details about the account. + * @export + * @interface AccountV2 + */ +export interface AccountV2 { + /** + * The unique identifier of the account. + * @type {string} + * @memberof AccountV2 + */ + 'id': string; + /** + * The name of the account. + * @type {string} + * @memberof AccountV2 + */ + 'name': string; + /** + * The unique ID of the account generated by the source system. + * @type {string} + * @memberof AccountV2 + */ + 'nativeIdentity': string; + /** + * The unique ID associated with this account. + * @type {string} + * @memberof AccountV2 + */ + 'uuid': string | null; + /** + * Indicates if the account is correlated to an identity. + * @type {boolean} + * @memberof AccountV2 + */ + 'correlated': boolean; + /** + * Indicates if the account is a machine account. + * @type {boolean} + * @memberof AccountV2 + */ + 'isMachine': boolean; + /** + * The origin of the account. + * @type {string} + * @memberof AccountV2 + */ + 'origin': string | null; + /** + * The attributes of the account. The contents of attributes depends on the account schema for the source. + * @type {{ [key: string]: any; }} + * @memberof AccountV2 + */ + 'attributes': { [key: string]: any; } | null; +} +/** + * Config required if BASIC_AUTH is used. + * @export + * @interface BasicauthconfigV1 + */ +export interface BasicauthconfigV1 { + /** + * The username to authenticate. + * @type {string} + * @memberof BasicauthconfigV1 + */ + 'userName'?: string; + /** + * The password to authenticate. On response, this field is set to null as to not return secrets. + * @type {string} + * @memberof BasicauthconfigV1 + */ + 'password'?: string | null; +} +/** + * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + * @export + * @interface BearertokenauthconfigV1 + */ +export interface BearertokenauthconfigV1 { + /** + * Bearer token + * @type {string} + * @memberof BearertokenauthconfigV1 + */ + 'bearerToken'?: string | null; +} +/** + * Details of the identity that owns the campaign. + * @export + * @interface CampaignactivatedCampaignCampaignOwnerV1 + */ +export interface CampaignactivatedCampaignCampaignOwnerV1 { + /** + * The unique ID of the identity. + * @type {string} + * @memberof CampaignactivatedCampaignCampaignOwnerV1 + */ + 'id': string; + /** + * The human friendly name of the identity. + * @type {string} + * @memberof CampaignactivatedCampaignCampaignOwnerV1 + */ + 'displayName': string; + /** + * The primary email address of the identity. + * @type {string} + * @memberof CampaignactivatedCampaignCampaignOwnerV1 + */ + 'email': string; +} +/** + * Details about the certification campaign that was activated. + * @export + * @interface CampaignactivatedCampaignV1 + */ +export interface CampaignactivatedCampaignV1 { + /** + * Unique ID for the campaign. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'id': string; + /** + * The human friendly name of the campaign. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'name': string; + /** + * Extended description of the campaign. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'description': string; + /** + * The date and time the campaign was created. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'created': string; + /** + * The date and time the campaign was last modified. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'modified'?: string | null; + /** + * The date and time the campaign is due. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'deadline': string; + /** + * The type of campaign. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'type': CampaignactivatedCampaignV1TypeV1; + /** + * + * @type {CampaignactivatedCampaignCampaignOwnerV1} + * @memberof CampaignactivatedCampaignV1 + */ + 'campaignOwner': CampaignactivatedCampaignCampaignOwnerV1; + /** + * The current status of the campaign. + * @type {string} + * @memberof CampaignactivatedCampaignV1 + */ + 'status': CampaignactivatedCampaignV1StatusV1; +} + +export const CampaignactivatedCampaignV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION' +} as const; + +export type CampaignactivatedCampaignV1TypeV1 = typeof CampaignactivatedCampaignV1TypeV1[keyof typeof CampaignactivatedCampaignV1TypeV1]; +export const CampaignactivatedCampaignV1StatusV1 = { + Active: 'ACTIVE' +} as const; + +export type CampaignactivatedCampaignV1StatusV1 = typeof CampaignactivatedCampaignV1StatusV1[keyof typeof CampaignactivatedCampaignV1StatusV1]; + +/** + * + * @export + * @interface CampaignactivatedV1 + */ +export interface CampaignactivatedV1 { + /** + * + * @type {CampaignactivatedCampaignV1} + * @memberof CampaignactivatedV1 + */ + 'campaign': CampaignactivatedCampaignV1; +} +/** + * Details about the certification campaign that ended. + * @export + * @interface CampaignendedCampaignV1 + */ +export interface CampaignendedCampaignV1 { + /** + * Unique ID for the campaign. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'id': string; + /** + * The human friendly name of the campaign. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'name': string; + /** + * Extended description of the campaign. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'description': string; + /** + * The date and time the campaign was created. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'created': string; + /** + * The date and time the campaign was last modified. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'modified'?: string | null; + /** + * The date and time the campaign is due. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'deadline': string; + /** + * The type of campaign. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'type': CampaignendedCampaignV1TypeV1; + /** + * + * @type {CampaignactivatedCampaignCampaignOwnerV1} + * @memberof CampaignendedCampaignV1 + */ + 'campaignOwner': CampaignactivatedCampaignCampaignOwnerV1; + /** + * The current status of the campaign. + * @type {string} + * @memberof CampaignendedCampaignV1 + */ + 'status': CampaignendedCampaignV1StatusV1; +} + +export const CampaignendedCampaignV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION' +} as const; + +export type CampaignendedCampaignV1TypeV1 = typeof CampaignendedCampaignV1TypeV1[keyof typeof CampaignendedCampaignV1TypeV1]; +export const CampaignendedCampaignV1StatusV1 = { + Completed: 'COMPLETED' +} as const; + +export type CampaignendedCampaignV1StatusV1 = typeof CampaignendedCampaignV1StatusV1[keyof typeof CampaignendedCampaignV1StatusV1]; + +/** + * + * @export + * @interface CampaignendedV1 + */ +export interface CampaignendedV1 { + /** + * + * @type {CampaignendedCampaignV1} + * @memberof CampaignendedV1 + */ + 'campaign': CampaignendedCampaignV1; +} +/** + * The identity that owns the campaign. + * @export + * @interface CampaigngeneratedCampaignCampaignOwnerV1 + */ +export interface CampaigngeneratedCampaignCampaignOwnerV1 { + /** + * The unique ID of the identity. + * @type {string} + * @memberof CampaigngeneratedCampaignCampaignOwnerV1 + */ + 'id': string; + /** + * The display name of the identity. + * @type {string} + * @memberof CampaigngeneratedCampaignCampaignOwnerV1 + */ + 'displayName': string; + /** + * The primary email address of the identity. + * @type {string} + * @memberof CampaigngeneratedCampaignCampaignOwnerV1 + */ + 'email': string; +} +/** + * Details about the campaign that was generated. + * @export + * @interface CampaigngeneratedCampaignV1 + */ +export interface CampaigngeneratedCampaignV1 { + /** + * The unique ID of the campaign. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'id': string; + /** + * Human friendly name of the campaign. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'name': string; + /** + * Extended description of the campaign. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'description': string; + /** + * The date and time the campaign was created. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'created': string; + /** + * The date and time the campaign was last modified. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'modified'?: string | null; + /** + * The date and time when the campaign must be finished by. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'deadline'?: string | null; + /** + * The type of campaign that was generated. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'type': CampaigngeneratedCampaignV1TypeV1; + /** + * + * @type {CampaigngeneratedCampaignCampaignOwnerV1} + * @memberof CampaigngeneratedCampaignV1 + */ + 'campaignOwner': CampaigngeneratedCampaignCampaignOwnerV1; + /** + * The current status of the campaign. + * @type {string} + * @memberof CampaigngeneratedCampaignV1 + */ + 'status': CampaigngeneratedCampaignV1StatusV1; +} + +export const CampaigngeneratedCampaignV1TypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION' +} as const; + +export type CampaigngeneratedCampaignV1TypeV1 = typeof CampaigngeneratedCampaignV1TypeV1[keyof typeof CampaigngeneratedCampaignV1TypeV1]; +export const CampaigngeneratedCampaignV1StatusV1 = { + Staged: 'STAGED', + Activating: 'ACTIVATING', + Active: 'ACTIVE' +} as const; + +export type CampaigngeneratedCampaignV1StatusV1 = typeof CampaigngeneratedCampaignV1StatusV1[keyof typeof CampaigngeneratedCampaignV1StatusV1]; + +/** + * + * @export + * @interface CampaigngeneratedV1 + */ +export interface CampaigngeneratedV1 { + /** + * + * @type {CampaigngeneratedCampaignV1} + * @memberof CampaigngeneratedV1 + */ + 'campaign': CampaigngeneratedCampaignV1; +} +/** + * + * @export + * @interface CampaignreferenceV1 + */ +export interface CampaignreferenceV1 { + /** + * The unique ID of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'id': string; + /** + * The name of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'name': string; + /** + * The type of object that is being referenced. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'type': CampaignreferenceV1TypeV1; + /** + * The type of the campaign. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'campaignType': CampaignreferenceV1CampaignTypeV1; + /** + * The description of the campaign set by the admin who created it. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'description': string | null; + /** + * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'correlatedStatus': CampaignreferenceV1CorrelatedStatusV1; + /** + * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + * @type {string} + * @memberof CampaignreferenceV1 + */ + 'mandatoryCommentRequirement': CampaignreferenceV1MandatoryCommentRequirementV1; +} + +export const CampaignreferenceV1TypeV1 = { + Campaign: 'CAMPAIGN' +} as const; + +export type CampaignreferenceV1TypeV1 = typeof CampaignreferenceV1TypeV1[keyof typeof CampaignreferenceV1TypeV1]; +export const CampaignreferenceV1CampaignTypeV1 = { + Manager: 'MANAGER', + SourceOwner: 'SOURCE_OWNER', + Search: 'SEARCH', + RoleComposition: 'ROLE_COMPOSITION', + MachineAccount: 'MACHINE_ACCOUNT' +} as const; + +export type CampaignreferenceV1CampaignTypeV1 = typeof CampaignreferenceV1CampaignTypeV1[keyof typeof CampaignreferenceV1CampaignTypeV1]; +export const CampaignreferenceV1CorrelatedStatusV1 = { + Correlated: 'CORRELATED', + Uncorrelated: 'UNCORRELATED' +} as const; + +export type CampaignreferenceV1CorrelatedStatusV1 = typeof CampaignreferenceV1CorrelatedStatusV1[keyof typeof CampaignreferenceV1CorrelatedStatusV1]; +export const CampaignreferenceV1MandatoryCommentRequirementV1 = { + AllDecisions: 'ALL_DECISIONS', + RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', + NoDecisions: 'NO_DECISIONS' +} as const; + +export type CampaignreferenceV1MandatoryCommentRequirementV1 = typeof CampaignreferenceV1MandatoryCommentRequirementV1[keyof typeof CampaignreferenceV1MandatoryCommentRequirementV1]; + +/** + * + * @export + * @interface CertificationdtoV1 + */ +export interface CertificationdtoV1 { + /** + * + * @type {CampaignreferenceV1} + * @memberof CertificationdtoV1 + */ + 'campaignRef': CampaignreferenceV1; + /** + * + * @type {CertificationphaseV1} + * @memberof CertificationdtoV1 + */ + 'phase': CertificationphaseV1; + /** + * The due date of the certification. + * @type {string} + * @memberof CertificationdtoV1 + */ + 'due': string; + /** + * The date the reviewer signed off on the certification. + * @type {string} + * @memberof CertificationdtoV1 + */ + 'signed': string; + /** + * + * @type {ReviewerV1} + * @memberof CertificationdtoV1 + */ + 'reviewer': ReviewerV1; + /** + * + * @type {ReassignmentV1} + * @memberof CertificationdtoV1 + */ + 'reassignment'?: ReassignmentV1 | null; + /** + * Indicates it the certification has any errors. + * @type {boolean} + * @memberof CertificationdtoV1 + */ + 'hasErrors': boolean; + /** + * A message indicating what the error is. + * @type {string} + * @memberof CertificationdtoV1 + */ + 'errorMessage'?: string | null; + /** + * Indicates if all certification decisions have been made. + * @type {boolean} + * @memberof CertificationdtoV1 + */ + 'completed': boolean; + /** + * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. + * @type {number} + * @memberof CertificationdtoV1 + */ + 'decisionsMade': number; + /** + * The total number of approve/revoke/acknowledge decisions for the certification. + * @type {number} + * @memberof CertificationdtoV1 + */ + 'decisionsTotal': number; + /** + * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. + * @type {number} + * @memberof CertificationdtoV1 + */ + 'entitiesCompleted': number; + /** + * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. + * @type {number} + * @memberof CertificationdtoV1 + */ + 'entitiesTotal': number; +} + + +/** + * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. + * @export + * @enum {string} + */ + +export const CertificationphaseV1 = { + Staged: 'STAGED', + Active: 'ACTIVE', + Signed: 'SIGNED' +} as const; + +export type CertificationphaseV1 = typeof CertificationphaseV1[keyof typeof CertificationphaseV1]; + + +/** + * + * @export + * @interface CertificationreferenceV1 + */ +export interface CertificationreferenceV1 { + /** + * The id of the certification. + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'id'?: string; + /** + * The name of the certification. + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'name'?: string; + /** + * + * @type {string} + * @memberof CertificationreferenceV1 + */ + 'type'?: CertificationreferenceV1TypeV1; + /** + * + * @type {ReviewerV1} + * @memberof CertificationreferenceV1 + */ + 'reviewer'?: ReviewerV1; +} + +export const CertificationreferenceV1TypeV1 = { + Certification: 'CERTIFICATION' +} as const; + +export type CertificationreferenceV1TypeV1 = typeof CertificationreferenceV1TypeV1[keyof typeof CertificationreferenceV1TypeV1]; + +/** + * The certification campaign that was signed off on. + * @export + * @interface CertificationsignedoffCertificationV1 + */ +export interface CertificationsignedoffCertificationV1 { + /** + * Unique ID of the certification. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'id': string; + /** + * The name of the certification. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'name': string; + /** + * The date and time the certification was created. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'created': string; + /** + * The date and time the certification was last modified. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'modified'?: string | null; + /** + * + * @type {CampaignreferenceV1} + * @memberof CertificationsignedoffCertificationV1 + */ + 'campaignRef': CampaignreferenceV1; + /** + * + * @type {CertificationphaseV1} + * @memberof CertificationsignedoffCertificationV1 + */ + 'phase': CertificationphaseV1; + /** + * The due date of the certification. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'due': string; + /** + * The date the reviewer signed off on the certification. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'signed': string; + /** + * + * @type {ReviewerV1} + * @memberof CertificationsignedoffCertificationV1 + */ + 'reviewer': ReviewerV1; + /** + * + * @type {ReassignmentV1} + * @memberof CertificationsignedoffCertificationV1 + */ + 'reassignment'?: ReassignmentV1 | null; + /** + * Indicates it the certification has any errors. + * @type {boolean} + * @memberof CertificationsignedoffCertificationV1 + */ + 'hasErrors': boolean; + /** + * A message indicating what the error is. + * @type {string} + * @memberof CertificationsignedoffCertificationV1 + */ + 'errorMessage'?: string | null; + /** + * Indicates if all certification decisions have been made. + * @type {boolean} + * @memberof CertificationsignedoffCertificationV1 + */ + 'completed': boolean; + /** + * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. + * @type {number} + * @memberof CertificationsignedoffCertificationV1 + */ + 'decisionsMade': number; + /** + * The total number of approve/revoke/acknowledge decisions for the certification. + * @type {number} + * @memberof CertificationsignedoffCertificationV1 + */ + 'decisionsTotal': number; + /** + * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. + * @type {number} + * @memberof CertificationsignedoffCertificationV1 + */ + 'entitiesCompleted': number; + /** + * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. + * @type {number} + * @memberof CertificationsignedoffCertificationV1 + */ + 'entitiesTotal': number; +} + + +/** + * + * @export + * @interface CertificationsignedoffV1 + */ +export interface CertificationsignedoffV1 { + /** + * + * @type {CertificationsignedoffCertificationV1} + * @memberof CertificationsignedoffV1 + */ + 'certification': CertificationsignedoffCertificationV1; +} +/** + * + * @export + * @interface CompleteinvocationV1 + */ +export interface CompleteinvocationV1 { + /** + * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. + * @type {string} + * @memberof CompleteinvocationV1 + */ + 'secret': string; + /** + * The error message to indicate a failed invocation or error if any. + * @type {string} + * @memberof CompleteinvocationV1 + */ + 'error'?: string; + /** + * Trigger output to complete the invocation. Its schema is defined in the trigger definition. + * @type {object} + * @memberof CompleteinvocationV1 + */ + 'output': object; +} +/** + * + * @export + * @interface CompleteinvocationinputV1 + */ +export interface CompleteinvocationinputV1 { + /** + * + * @type {LocalizedmessageV1} + * @memberof CompleteinvocationinputV1 + */ + 'localizedError'?: LocalizedmessageV1 | null; + /** + * Trigger output that completed the invocation. Its schema is defined in the trigger definition. + * @type {object} + * @memberof CompleteinvocationinputV1 + */ + 'output'?: object | null; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface EventbridgeconfigV1 + */ +export interface EventbridgeconfigV1 { + /** + * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. + * @type {string} + * @memberof EventbridgeconfigV1 + */ + 'awsAccount': string; + /** + * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. + * @type {string} + * @memberof EventbridgeconfigV1 + */ + 'awsRegion': string; +} +/** + * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. + * @export + * @enum {string} + */ + +export const HttpauthenticationtypeV1 = { + NoAuth: 'NO_AUTH', + BasicAuth: 'BASIC_AUTH', + BearerToken: 'BEARER_TOKEN' +} as const; + +export type HttpauthenticationtypeV1 = typeof HttpauthenticationtypeV1[keyof typeof HttpauthenticationtypeV1]; + + +/** + * + * @export + * @interface HttpconfigV1 + */ +export interface HttpconfigV1 { + /** + * URL of the external/custom integration. + * @type {string} + * @memberof HttpconfigV1 + */ + 'url': string; + /** + * + * @type {HttpdispatchmodeV1} + * @memberof HttpconfigV1 + */ + 'httpDispatchMode': HttpdispatchmodeV1; + /** + * + * @type {HttpauthenticationtypeV1} + * @memberof HttpconfigV1 + */ + 'httpAuthenticationType'?: HttpauthenticationtypeV1; + /** + * + * @type {BasicauthconfigV1} + * @memberof HttpconfigV1 + */ + 'basicAuthConfig'?: BasicauthconfigV1 | null; + /** + * + * @type {BearertokenauthconfigV1} + * @memberof HttpconfigV1 + */ + 'bearerTokenAuthConfig'?: BearertokenauthconfigV1 | null; +} + + +/** + * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. + * @export + * @enum {string} + */ + +export const HttpdispatchmodeV1 = { + Sync: 'SYNC', + Async: 'ASYNC', + Dynamic: 'DYNAMIC' +} as const; + +export type HttpdispatchmodeV1 = typeof HttpdispatchmodeV1[keyof typeof HttpdispatchmodeV1]; + + +/** + * @type IdentityattributeschangedChangesInnerNewValueV1 + * The value of the identity attribute after it changed. + * @export + */ +export type IdentityattributeschangedChangesInnerNewValueV1 = Array | boolean | string | { [key: string]: IdentityattributeschangedChangesInnerOldValueOneOfValueV1; }; + +/** + * @type IdentityattributeschangedChangesInnerOldValueOneOfValueV1 + * @export + */ +export type IdentityattributeschangedChangesInnerOldValueOneOfValueV1 = boolean | number | string; + +/** + * @type IdentityattributeschangedChangesInnerOldValueV1 + * The value of the identity attribute before it changed. + * @export + */ +export type IdentityattributeschangedChangesInnerOldValueV1 = Array | boolean | string | { [key: string]: IdentityattributeschangedChangesInnerOldValueOneOfValueV1; }; + +/** + * + * @export + * @interface IdentityattributeschangedChangesInnerV1 + */ +export interface IdentityattributeschangedChangesInnerV1 { + /** + * The name of the identity attribute that changed. + * @type {string} + * @memberof IdentityattributeschangedChangesInnerV1 + */ + 'attribute': string; + /** + * + * @type {IdentityattributeschangedChangesInnerOldValueV1} + * @memberof IdentityattributeschangedChangesInnerV1 + */ + 'oldValue'?: IdentityattributeschangedChangesInnerOldValueV1 | null; + /** + * + * @type {IdentityattributeschangedChangesInnerNewValueV1} + * @memberof IdentityattributeschangedChangesInnerV1 + */ + 'newValue'?: IdentityattributeschangedChangesInnerNewValueV1; +} +/** + * Identity whose attributes changed. + * @export + * @interface IdentityattributeschangedIdentityV1 + */ +export interface IdentityattributeschangedIdentityV1 { + /** + * DTO type of identity whose attributes changed. + * @type {string} + * @memberof IdentityattributeschangedIdentityV1 + */ + 'type': IdentityattributeschangedIdentityV1TypeV1; + /** + * ID of identity whose attributes changed. + * @type {string} + * @memberof IdentityattributeschangedIdentityV1 + */ + 'id': string; + /** + * Display name of identity whose attributes changed. + * @type {string} + * @memberof IdentityattributeschangedIdentityV1 + */ + 'name': string; +} + +export const IdentityattributeschangedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentityattributeschangedIdentityV1TypeV1 = typeof IdentityattributeschangedIdentityV1TypeV1[keyof typeof IdentityattributeschangedIdentityV1TypeV1]; + +/** + * + * @export + * @interface IdentityattributeschangedV1 + */ +export interface IdentityattributeschangedV1 { + /** + * + * @type {IdentityattributeschangedIdentityV1} + * @memberof IdentityattributeschangedV1 + */ + 'identity': IdentityattributeschangedIdentityV1; + /** + * A list of one or more identity attributes that changed on the identity. + * @type {Array} + * @memberof IdentityattributeschangedV1 + */ + 'changes': Array; +} +/** + * Created identity. + * @export + * @interface IdentitycreatedIdentityV1 + */ +export interface IdentitycreatedIdentityV1 { + /** + * Created identity\'s DTO type. + * @type {string} + * @memberof IdentitycreatedIdentityV1 + */ + 'type': IdentitycreatedIdentityV1TypeV1; + /** + * Created identity ID. + * @type {string} + * @memberof IdentitycreatedIdentityV1 + */ + 'id': string; + /** + * Created identity\'s display name. + * @type {string} + * @memberof IdentitycreatedIdentityV1 + */ + 'name': string; +} + +export const IdentitycreatedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentitycreatedIdentityV1TypeV1 = typeof IdentitycreatedIdentityV1TypeV1[keyof typeof IdentitycreatedIdentityV1TypeV1]; + +/** + * + * @export + * @interface IdentitycreatedV1 + */ +export interface IdentitycreatedV1 { + /** + * + * @type {IdentitycreatedIdentityV1} + * @memberof IdentitycreatedV1 + */ + 'identity': IdentitycreatedIdentityV1; + /** + * The attributes assigned to the identity. Attributes are determined by the identity profile. + * @type {{ [key: string]: any; }} + * @memberof IdentitycreatedV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * Deleted identity. + * @export + * @interface IdentitydeletedIdentityV1 + */ +export interface IdentitydeletedIdentityV1 { + /** + * Deleted identity\'s DTO type. + * @type {string} + * @memberof IdentitydeletedIdentityV1 + */ + 'type': IdentitydeletedIdentityV1TypeV1; + /** + * Deleted identity ID. + * @type {string} + * @memberof IdentitydeletedIdentityV1 + */ + 'id': string; + /** + * Deleted identity\'s display name. + * @type {string} + * @memberof IdentitydeletedIdentityV1 + */ + 'name': string; +} + +export const IdentitydeletedIdentityV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type IdentitydeletedIdentityV1TypeV1 = typeof IdentitydeletedIdentityV1TypeV1[keyof typeof IdentitydeletedIdentityV1TypeV1]; + +/** + * + * @export + * @interface IdentitydeletedV1 + */ +export interface IdentitydeletedV1 { + /** + * + * @type {IdentitydeletedIdentityV1} + * @memberof IdentitydeletedV1 + */ + 'identity': IdentitydeletedIdentityV1; + /** + * The attributes assigned to the identity. Attributes are determined by the identity profile. + * @type {{ [key: string]: any; }} + * @memberof IdentitydeletedV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * Details about the identity correlated with the account. + * @export + * @interface Identityreference2V1 + */ +export interface Identityreference2V1 { + /** + * The ID of the identity that is correlated with this account. + * @type {string} + * @memberof Identityreference2V1 + */ + 'id': string; + /** + * The name of the identity that is correlated with this account. + * @type {string} + * @memberof Identityreference2V1 + */ + 'name': string; + /** + * The alias of the identity. + * @type {string} + * @memberof Identityreference2V1 + */ + 'alias': string; + /** + * The email of the identity. + * @type {string} + * @memberof Identityreference2V1 + */ + 'email': string; +} +/** + * + * @export + * @interface InvocationV1 + */ +export interface InvocationV1 { + /** + * Invocation ID + * @type {string} + * @memberof InvocationV1 + */ + 'id'?: string; + /** + * Trigger ID + * @type {string} + * @memberof InvocationV1 + */ + 'triggerId'?: string; + /** + * Unique invocation secret. + * @type {string} + * @memberof InvocationV1 + */ + 'secret'?: string; + /** + * JSON map of invocation metadata. + * @type {object} + * @memberof InvocationV1 + */ + 'contentJson'?: object; +} +/** + * + * @export + * @interface InvocationstatusV1 + */ +export interface InvocationstatusV1 { + /** + * Invocation ID + * @type {string} + * @memberof InvocationstatusV1 + */ + 'id': string; + /** + * Trigger ID + * @type {string} + * @memberof InvocationstatusV1 + */ + 'triggerId': string; + /** + * Subscription name + * @type {string} + * @memberof InvocationstatusV1 + */ + 'subscriptionName': string; + /** + * Subscription ID + * @type {string} + * @memberof InvocationstatusV1 + */ + 'subscriptionId': string; + /** + * + * @type {InvocationstatustypeV1} + * @memberof InvocationstatusV1 + */ + 'type': InvocationstatustypeV1; + /** + * Invocation created timestamp. ISO-8601 in UTC. + * @type {string} + * @memberof InvocationstatusV1 + */ + 'created': string; + /** + * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. + * @type {string} + * @memberof InvocationstatusV1 + */ + 'completed'?: string; + /** + * + * @type {StartinvocationinputV1} + * @memberof InvocationstatusV1 + */ + 'startInvocationInput': StartinvocationinputV1; + /** + * + * @type {CompleteinvocationinputV1} + * @memberof InvocationstatusV1 + */ + 'completeInvocationInput'?: CompleteinvocationinputV1; +} + + +/** + * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. + * @export + * @enum {string} + */ + +export const InvocationstatustypeV1 = { + Test: 'TEST', + RealTime: 'REAL_TIME' +} as const; + +export type InvocationstatustypeV1 = typeof InvocationstatustypeV1[keyof typeof InvocationstatustypeV1]; + + +/** + * + * @export + * @interface ListTriggersV1401ResponseV1 + */ +export interface ListTriggersV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTriggersV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListTriggersV1429ResponseV1 + */ +export interface ListTriggersV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListTriggersV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * Localized error message to indicate a failed invocation or error if any. + * @export + * @interface LocalizedmessageV1 + */ +export interface LocalizedmessageV1 { + /** + * Message locale + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'locale': string; + /** + * Message text + * @type {string} + * @memberof LocalizedmessageV1 + */ + 'message': string; +} +/** + * Details of the created machine identity. + * @export + * @interface MachineidentitycreatedMachineIdentityV1 + */ +export interface MachineidentitycreatedMachineIdentityV1 { + /** + * Unique identifier for the machine identity. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'id': string; + /** + * Name of the machine identity. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'name'?: string; + /** + * Creation timestamp. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'created': string; + /** + * Last modified timestamp. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'modified': string; + /** + * Associated business application. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'businessApplication'?: string; + /** + * Description of the machine identity. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'description'?: string; + /** + * The attributes assigned to the identity. + * @type {{ [key: string]: any; }} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Subtype of the machine identity. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'subtype': MachineidentitycreatedMachineIdentityV1SubtypeV1; + /** + * List of owners. + * @type {Array} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'owners'?: Array; + /** + * Source identifier. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'sourceId'?: string; + /** + * UUID of the machine identity. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'uuid'?: string; + /** + * Native identity value. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'nativeIdentity'?: string; + /** + * Indicates if manually edited. + * @type {boolean} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'manuallyEdited': boolean; + /** + * Indicates if manually created. + * @type {boolean} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'manuallyCreated'?: boolean; + /** + * Dataset identifier. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'datasetId'?: string; + /** + * + * @type {MachineidentitysourcereferenceV1} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'source'?: MachineidentitysourcereferenceV1; + /** + * List of user entitlements. + * @type {Array} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'userEntitlements'?: Array; + /** + * Existence status on source. + * @type {string} + * @memberof MachineidentitycreatedMachineIdentityV1 + */ + 'existsOnSource'?: string; +} + +export const MachineidentitycreatedMachineIdentityV1SubtypeV1 = { + AiAgent: 'AI Agent', + Application: 'Application' +} as const; + +export type MachineidentitycreatedMachineIdentityV1SubtypeV1 = typeof MachineidentitycreatedMachineIdentityV1SubtypeV1[keyof typeof MachineidentitycreatedMachineIdentityV1SubtypeV1]; + +/** + * + * @export + * @interface MachineidentitycreatedV1 + */ +export interface MachineidentitycreatedV1 { + /** + * Type of the event. + * @type {string} + * @memberof MachineidentitycreatedV1 + */ + 'eventType': MachineidentitycreatedV1EventTypeV1; + /** + * + * @type {MachineidentitycreatedMachineIdentityV1} + * @memberof MachineidentitycreatedV1 + */ + 'machineIdentity': MachineidentitycreatedMachineIdentityV1; +} + +export const MachineidentitycreatedV1EventTypeV1 = { + MachineIdentityCreated: 'MACHINE_IDENTITY_CREATED' +} as const; + +export type MachineidentitycreatedV1EventTypeV1 = typeof MachineidentitycreatedV1EventTypeV1[keyof typeof MachineidentitycreatedV1EventTypeV1]; + +/** + * Details of the deleted machine identity. + * @export + * @interface MachineidentitydeletedMachineIdentityV1 + */ +export interface MachineidentitydeletedMachineIdentityV1 { + /** + * Unique identifier for the machine identity. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'id': string; + /** + * Name of the machine identity. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'name'?: string; + /** + * Creation timestamp. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'created': string; + /** + * Last modified timestamp. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'modified': string; + /** + * Associated business application. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'businessApplication'?: string; + /** + * Description of the machine identity. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'description'?: string; + /** + * The attributes assigned to the identity. + * @type {{ [key: string]: any; }} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Subtype of the machine identity. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'subtype': MachineidentitydeletedMachineIdentityV1SubtypeV1; + /** + * List of owners. + * @type {Array} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'owners'?: Array; + /** + * Source identifier. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'sourceId'?: string; + /** + * UUID of the machine identity. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'uuid'?: string; + /** + * Native identity value. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'nativeIdentity'?: string; + /** + * Indicates if manually edited. + * @type {boolean} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'manuallyEdited': boolean; + /** + * Indicates if manually created. + * @type {boolean} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'manuallyCreated'?: boolean; + /** + * Dataset identifier. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'datasetId'?: string; + /** + * + * @type {MachineidentitysourcereferenceV1} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'source'?: MachineidentitysourcereferenceV1; + /** + * List of user entitlements. + * @type {Array} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'userEntitlements'?: Array; + /** + * Existence status on source. + * @type {string} + * @memberof MachineidentitydeletedMachineIdentityV1 + */ + 'existsOnSource'?: string; +} + +export const MachineidentitydeletedMachineIdentityV1SubtypeV1 = { + AiAgent: 'AI Agent', + Application: 'Application' +} as const; + +export type MachineidentitydeletedMachineIdentityV1SubtypeV1 = typeof MachineidentitydeletedMachineIdentityV1SubtypeV1[keyof typeof MachineidentitydeletedMachineIdentityV1SubtypeV1]; + +/** + * + * @export + * @interface MachineidentitydeletedV1 + */ +export interface MachineidentitydeletedV1 { + /** + * Type of the event. + * @type {string} + * @memberof MachineidentitydeletedV1 + */ + 'eventType': MachineidentitydeletedV1EventTypeV1; + /** + * + * @type {MachineidentitydeletedMachineIdentityV1} + * @memberof MachineidentitydeletedV1 + */ + 'machineIdentity': MachineidentitydeletedMachineIdentityV1; +} + +export const MachineidentitydeletedV1EventTypeV1 = { + MachineIdentityDeleted: 'MACHINE_IDENTITY_DELETED' +} as const; + +export type MachineidentitydeletedV1EventTypeV1 = typeof MachineidentitydeletedV1EventTypeV1[keyof typeof MachineidentitydeletedV1EventTypeV1]; + +/** + * Reference to an owner of the machine identity. + * @export + * @interface MachineidentityownerreferenceV1 + */ +export interface MachineidentityownerreferenceV1 { + [key: string]: any; + + /** + * Owner\'s type. + * @type {string} + * @memberof MachineidentityownerreferenceV1 + */ + 'type': string; + /** + * Owner ID. + * @type {string} + * @memberof MachineidentityownerreferenceV1 + */ + 'id': string; + /** + * Owner\'s display name. + * @type {string} + * @memberof MachineidentityownerreferenceV1 + */ + 'name': string; + /** + * Indicates if this owner is the primary owner. + * @type {boolean} + * @memberof MachineidentityownerreferenceV1 + */ + 'isPrimary'?: boolean; +} +/** + * Reference to a source of entity. + * @export + * @interface MachineidentitysourcereferenceV1 + */ +export interface MachineidentitysourcereferenceV1 { + [key: string]: any; + + /** + * Source Type. + * @type {string} + * @memberof MachineidentitysourcereferenceV1 + */ + 'type': string; + /** + * Unique identifier. + * @type {string} + * @memberof MachineidentitysourcereferenceV1 + */ + 'id': string; + /** + * Display name. + * @type {string} + * @memberof MachineidentitysourcereferenceV1 + */ + 'name': string; +} +/** + * Details of the updated machine identity. + * @export + * @interface MachineidentityupdatedMachineIdentityV1 + */ +export interface MachineidentityupdatedMachineIdentityV1 { + /** + * Unique identifier for the machine identity. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'id': string; + /** + * Name of the machine identity. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'name'?: string; + /** + * Creation timestamp. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'created': string; + /** + * Last modified timestamp. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'modified': string; + /** + * Associated business application. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'businessApplication'?: string; + /** + * Description of the machine identity. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'description'?: string; + /** + * The attributes assigned to the identity. + * @type {{ [key: string]: any; }} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'attributes'?: { [key: string]: any; }; + /** + * Subtype of the machine identity. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'subtype': MachineidentityupdatedMachineIdentityV1SubtypeV1; + /** + * List of owners. + * @type {Array} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'owners'?: Array; + /** + * Source identifier. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'sourceId'?: string; + /** + * UUID of the machine identity. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'uuid'?: string; + /** + * Native identity value. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'nativeIdentity'?: string; + /** + * Indicates if manually edited. + * @type {boolean} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'manuallyEdited': boolean; + /** + * Indicates if manually created. + * @type {boolean} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'manuallyCreated'?: boolean; + /** + * Dataset identifier. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'datasetId'?: string; + /** + * + * @type {MachineidentitysourcereferenceV1} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'source'?: MachineidentitysourcereferenceV1; + /** + * List of user entitlements. + * @type {Array} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'userEntitlements'?: Array; + /** + * Existence status on source. + * @type {string} + * @memberof MachineidentityupdatedMachineIdentityV1 + */ + 'existsOnSource'?: string; +} + +export const MachineidentityupdatedMachineIdentityV1SubtypeV1 = { + AiAgent: 'AI Agent', + Application: 'Application' +} as const; + +export type MachineidentityupdatedMachineIdentityV1SubtypeV1 = typeof MachineidentityupdatedMachineIdentityV1SubtypeV1[keyof typeof MachineidentityupdatedMachineIdentityV1SubtypeV1]; + +/** + * Changes to owners. + * @export + * @interface MachineidentityupdatedOwnerChangesV1 + */ +export interface MachineidentityupdatedOwnerChangesV1 { + /** + * Name of the attribute that changed. + * @type {string} + * @memberof MachineidentityupdatedOwnerChangesV1 + */ + 'attributeName'?: string; + /** + * Owners that were added. + * @type {Array} + * @memberof MachineidentityupdatedOwnerChangesV1 + */ + 'added'?: Array; + /** + * Owners that were removed. + * @type {Array} + * @memberof MachineidentityupdatedOwnerChangesV1 + */ + 'removed'?: Array; +} +/** + * @type MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 + * The new value of the attribute after the change. + * @export + */ +export type MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 = Array | boolean | number | string; + +/** + * @type MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 + * The old value of the attribute before the change. + * @export + */ +export type MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 = Array | boolean | number | string; + +/** + * + * @export + * @interface MachineidentityupdatedSingleValueAttributeChangesInnerV1 + */ +export interface MachineidentityupdatedSingleValueAttributeChangesInnerV1 { + /** + * The name of the attribute that was changed. + * @type {string} + * @memberof MachineidentityupdatedSingleValueAttributeChangesInnerV1 + */ + 'name': string; + /** + * + * @type {MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1} + * @memberof MachineidentityupdatedSingleValueAttributeChangesInnerV1 + */ + 'oldValue': MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 | null; + /** + * + * @type {MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1} + * @memberof MachineidentityupdatedSingleValueAttributeChangesInnerV1 + */ + 'newValue': MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 | null; +} +/** + * Changes to user entitlements. + * @export + * @interface MachineidentityupdatedUserEntitlementChangesV1 + */ +export interface MachineidentityupdatedUserEntitlementChangesV1 { + /** + * Name of the attribute that changed. + * @type {string} + * @memberof MachineidentityupdatedUserEntitlementChangesV1 + */ + 'attributeName'?: string; + /** + * User entitlements that were added. + * @type {Array} + * @memberof MachineidentityupdatedUserEntitlementChangesV1 + */ + 'added'?: Array; + /** + * User entitlements that were removed. + * @type {Array} + * @memberof MachineidentityupdatedUserEntitlementChangesV1 + */ + 'removed'?: Array; +} +/** + * + * @export + * @interface MachineidentityupdatedV1 + */ +export interface MachineidentityupdatedV1 { + /** + * Type of the event. + * @type {string} + * @memberof MachineidentityupdatedV1 + */ + 'eventType': MachineidentityupdatedV1EventTypeV1; + /** + * + * @type {MachineidentityupdatedMachineIdentityV1} + * @memberof MachineidentityupdatedV1 + */ + 'machineIdentity': MachineidentityupdatedMachineIdentityV1; + /** + * Types of changes that occurred to the machine identity. + * @type {Array} + * @memberof MachineidentityupdatedV1 + */ + 'machineIdentityChangeTypes': Array; + /** + * + * @type {MachineidentityupdatedUserEntitlementChangesV1} + * @memberof MachineidentityupdatedV1 + */ + 'userEntitlementChanges': MachineidentityupdatedUserEntitlementChangesV1; + /** + * + * @type {MachineidentityupdatedOwnerChangesV1} + * @memberof MachineidentityupdatedV1 + */ + 'ownerChanges': MachineidentityupdatedOwnerChangesV1; + /** + * Details about the single-value attribute changes that occurred. + * @type {Array} + * @memberof MachineidentityupdatedV1 + */ + 'singleValueAttributeChanges': Array | null; +} + +export const MachineidentityupdatedV1EventTypeV1 = { + MachineIdentityUpdated: 'MACHINE_IDENTITY_UPDATED' +} as const; + +export type MachineidentityupdatedV1EventTypeV1 = typeof MachineidentityupdatedV1EventTypeV1[keyof typeof MachineidentityupdatedV1EventTypeV1]; +export const MachineidentityupdatedV1MachineIdentityChangeTypesV1 = { + AttributesChanged: 'ATTRIBUTES_CHANGED', + UserEntitlementsAdded: 'USER_ENTITLEMENTS_ADDED', + UserEntitlementsRemoved: 'USER_ENTITLEMENTS_REMOVED', + OwnersAdded: 'OWNERS_ADDED', + OwnersRemoved: 'OWNERS_REMOVED' +} as const; + +export type MachineidentityupdatedV1MachineIdentityChangeTypesV1 = typeof MachineidentityupdatedV1MachineIdentityChangeTypesV1[keyof typeof MachineidentityupdatedV1MachineIdentityChangeTypesV1]; + +/** + * Reference to a user entitlement. + * @export + * @interface MachineidentityuserentitlementsV1 + */ +export interface MachineidentityuserentitlementsV1 { + [key: string]: any; + + /** + * Entitlement identifier. + * @type {string} + * @memberof MachineidentityuserentitlementsV1 + */ + 'entitlementId': string; + /** + * Display name of the entitlement. + * @type {string} + * @memberof MachineidentityuserentitlementsV1 + */ + 'displayName': string; + /** + * + * @type {MachineidentitysourcereferenceV1} + * @memberof MachineidentityuserentitlementsV1 + */ + 'source': MachineidentitysourcereferenceV1; +} +/** + * + * @export + * @interface ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 + */ +export interface ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 { + /** + * The name of the attribute being provisioned. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 + */ + 'attributeName': string; + /** + * The value of the attribute being provisioned. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 + */ + 'attributeValue'?: string | null; + /** + * The operation to handle the attribute. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 + */ + 'operation': ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1OperationV1; +} + +export const ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1OperationV1 = { + Add: 'Add', + Set: 'Set', + Remove: 'Remove' +} as const; + +export type ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1OperationV1 = typeof ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1OperationV1[keyof typeof ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1OperationV1]; + +/** + * Reference to the source being provisioned against. + * @export + * @interface ProvisioningcompletedAccountRequestsInnerSourceV1 + */ +export interface ProvisioningcompletedAccountRequestsInnerSourceV1 { + /** + * ID of the object to which this reference applies + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerSourceV1 + */ + 'id': string; + /** + * The type of object that is referenced + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerSourceV1 + */ + 'type': ProvisioningcompletedAccountRequestsInnerSourceV1TypeV1; + /** + * Human-readable display name of the object to which this reference applies + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerSourceV1 + */ + 'name': string; +} + +export const ProvisioningcompletedAccountRequestsInnerSourceV1TypeV1 = { + Source: 'SOURCE' +} as const; + +export type ProvisioningcompletedAccountRequestsInnerSourceV1TypeV1 = typeof ProvisioningcompletedAccountRequestsInnerSourceV1TypeV1[keyof typeof ProvisioningcompletedAccountRequestsInnerSourceV1TypeV1]; + +/** + * + * @export + * @interface ProvisioningcompletedAccountRequestsInnerV1 + */ +export interface ProvisioningcompletedAccountRequestsInnerV1 { + /** + * + * @type {ProvisioningcompletedAccountRequestsInnerSourceV1} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'source': ProvisioningcompletedAccountRequestsInnerSourceV1; + /** + * The unique idenfier of the account being provisioned. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'accountId'?: string; + /** + * The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'accountOperation': string; + /** + * The overall result of the provisioning transaction; this could be success, pending, failed, etc. + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'provisioningResult': ProvisioningcompletedAccountRequestsInnerV1ProvisioningResultV1; + /** + * The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'provisioningTarget': string; + /** + * A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). + * @type {string} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'ticketId'?: string | null; + /** + * A list of attributes as part of the provisioning transaction. + * @type {Array} + * @memberof ProvisioningcompletedAccountRequestsInnerV1 + */ + 'attributeRequests'?: Array | null; +} + +export const ProvisioningcompletedAccountRequestsInnerV1ProvisioningResultV1 = { + Success: 'SUCCESS', + Pending: 'PENDING', + Failed: 'FAILED' +} as const; + +export type ProvisioningcompletedAccountRequestsInnerV1ProvisioningResultV1 = typeof ProvisioningcompletedAccountRequestsInnerV1ProvisioningResultV1[keyof typeof ProvisioningcompletedAccountRequestsInnerV1ProvisioningResultV1]; + +/** + * Provisioning recpient. + * @export + * @interface ProvisioningcompletedRecipientV1 + */ +export interface ProvisioningcompletedRecipientV1 { + /** + * Provisioning recipient DTO type. + * @type {string} + * @memberof ProvisioningcompletedRecipientV1 + */ + 'type': ProvisioningcompletedRecipientV1TypeV1; + /** + * Provisioning recipient\'s identity ID. + * @type {string} + * @memberof ProvisioningcompletedRecipientV1 + */ + 'id': string; + /** + * Provisioning recipient\'s display name. + * @type {string} + * @memberof ProvisioningcompletedRecipientV1 + */ + 'name': string; +} + +export const ProvisioningcompletedRecipientV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ProvisioningcompletedRecipientV1TypeV1 = typeof ProvisioningcompletedRecipientV1TypeV1[keyof typeof ProvisioningcompletedRecipientV1TypeV1]; + +/** + * Provisioning requester\'s identity. + * @export + * @interface ProvisioningcompletedRequesterV1 + */ +export interface ProvisioningcompletedRequesterV1 { + /** + * Provisioning requester\'s DTO type. + * @type {string} + * @memberof ProvisioningcompletedRequesterV1 + */ + 'type': ProvisioningcompletedRequesterV1TypeV1; + /** + * Provisioning requester\'s identity ID. + * @type {string} + * @memberof ProvisioningcompletedRequesterV1 + */ + 'id': string; + /** + * Provisioning owner\'s human-readable display name. + * @type {string} + * @memberof ProvisioningcompletedRequesterV1 + */ + 'name': string; +} + +export const ProvisioningcompletedRequesterV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type ProvisioningcompletedRequesterV1TypeV1 = typeof ProvisioningcompletedRequesterV1TypeV1[keyof typeof ProvisioningcompletedRequesterV1TypeV1]; + +/** + * + * @export + * @interface ProvisioningcompletedV1 + */ +export interface ProvisioningcompletedV1 { + /** + * The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. + * @type {string} + * @memberof ProvisioningcompletedV1 + */ + 'trackingNumber': string; + /** + * One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. + * @type {string} + * @memberof ProvisioningcompletedV1 + */ + 'sources': string; + /** + * Origin of where the provisioning request came from. + * @type {string} + * @memberof ProvisioningcompletedV1 + */ + 'action'?: string | null; + /** + * A list of any accumulated error messages that occurred during provisioning. + * @type {Array} + * @memberof ProvisioningcompletedV1 + */ + 'errors'?: Array | null; + /** + * A list of any accumulated warning messages that occurred during provisioning. + * @type {Array} + * @memberof ProvisioningcompletedV1 + */ + 'warnings'?: Array | null; + /** + * + * @type {ProvisioningcompletedRecipientV1} + * @memberof ProvisioningcompletedV1 + */ + 'recipient': ProvisioningcompletedRecipientV1; + /** + * + * @type {ProvisioningcompletedRequesterV1} + * @memberof ProvisioningcompletedV1 + */ + 'requester'?: ProvisioningcompletedRequesterV1 | null; + /** + * A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. + * @type {Array} + * @memberof ProvisioningcompletedV1 + */ + 'accountRequests': Array; +} +/** + * + * @export + * @interface ReassignmentV1 + */ +export interface ReassignmentV1 { + /** + * + * @type {CertificationreferenceV1} + * @memberof ReassignmentV1 + */ + 'from'?: CertificationreferenceV1; + /** + * The comment entered when the Certification was reassigned + * @type {string} + * @memberof ReassignmentV1 + */ + 'comment'?: string; +} +/** + * + * @export + * @interface ReviewerV1 + */ +export interface ReviewerV1 { + /** + * The id of the reviewer. + * @type {string} + * @memberof ReviewerV1 + */ + 'id'?: string; + /** + * The name of the reviewer. + * @type {string} + * @memberof ReviewerV1 + */ + 'name'?: string; + /** + * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. + * @type {string} + * @memberof ReviewerV1 + */ + 'email'?: string | null; + /** + * The type of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'type'?: ReviewerV1TypeV1; + /** + * The created date of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'created'?: string | null; + /** + * The modified date of the reviewing identity. + * @type {string} + * @memberof ReviewerV1 + */ + 'modified'?: string | null; +} + +export const ReviewerV1TypeV1 = { + Identity: 'IDENTITY', + GovernanceGroup: 'GOVERNANCE_GROUP' +} as const; + +export type ReviewerV1TypeV1 = typeof ReviewerV1TypeV1[keyof typeof ReviewerV1TypeV1]; + +/** + * A table of accounts that match the search criteria. + * @export + * @interface SavedsearchcompleteSearchResultsAccountV1 + */ +export interface SavedsearchcompleteSearchResultsAccountV1 { + /** + * The number of rows in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsAccountV1 + */ + 'count': string; + /** + * The type of object represented in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsAccountV1 + */ + 'noun': string; + /** + * A sample of the data in the table. + * @type {Array>} + * @memberof SavedsearchcompleteSearchResultsAccountV1 + */ + 'preview': Array>; +} +/** + * A table of entitlements that match the search criteria. + * @export + * @interface SavedsearchcompleteSearchResultsEntitlementV1 + */ +export interface SavedsearchcompleteSearchResultsEntitlementV1 { + /** + * The number of rows in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsEntitlementV1 + */ + 'count': string; + /** + * The type of object represented in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsEntitlementV1 + */ + 'noun': string; + /** + * A sample of the data in the table. + * @type {Array>} + * @memberof SavedsearchcompleteSearchResultsEntitlementV1 + */ + 'preview': Array>; +} +/** + * A table of identities that match the search criteria. + * @export + * @interface SavedsearchcompleteSearchResultsIdentityV1 + */ +export interface SavedsearchcompleteSearchResultsIdentityV1 { + /** + * The number of rows in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsIdentityV1 + */ + 'count': string; + /** + * The type of object represented in the table. + * @type {string} + * @memberof SavedsearchcompleteSearchResultsIdentityV1 + */ + 'noun': string; + /** + * A sample of the data in the table. + * @type {Array>} + * @memberof SavedsearchcompleteSearchResultsIdentityV1 + */ + 'preview': Array>; +} +/** + * A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. + * @export + * @interface SavedsearchcompleteSearchResultsV1 + */ +export interface SavedsearchcompleteSearchResultsV1 { + /** + * + * @type {SavedsearchcompleteSearchResultsAccountV1} + * @memberof SavedsearchcompleteSearchResultsV1 + */ + 'Account'?: SavedsearchcompleteSearchResultsAccountV1 | null; + /** + * + * @type {SavedsearchcompleteSearchResultsEntitlementV1} + * @memberof SavedsearchcompleteSearchResultsV1 + */ + 'Entitlement'?: SavedsearchcompleteSearchResultsEntitlementV1 | null; + /** + * + * @type {SavedsearchcompleteSearchResultsIdentityV1} + * @memberof SavedsearchcompleteSearchResultsV1 + */ + 'Identity'?: SavedsearchcompleteSearchResultsIdentityV1 | null; +} +/** + * + * @export + * @interface SavedsearchcompleteV1 + */ +export interface SavedsearchcompleteV1 { + /** + * A name for the report file. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'fileName': string; + /** + * The email address of the identity that owns the saved search. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'ownerEmail': string; + /** + * The name of the identity that owns the saved search. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'ownerName': string; + /** + * The search query that was used to generate the report. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'query': string; + /** + * The name of the saved search. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'searchName': string; + /** + * + * @type {SavedsearchcompleteSearchResultsV1} + * @memberof SavedsearchcompleteV1 + */ + 'searchResults': SavedsearchcompleteSearchResultsV1; + /** + * The Amazon S3 URL to download the report from. + * @type {string} + * @memberof SavedsearchcompleteV1 + */ + 'signedS3Url': string; +} +/** + * + * @export + * @interface SourceaccountcreatedV1 + */ +export interface SourceaccountcreatedV1 { + /** + * Source unique identifier for the identity. UUID is generated by the source system. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'uuid'?: string; + /** + * SailPoint generated unique identifier. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'id': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'nativeIdentifier': string; + /** + * The ID of the source. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'sourceId': string; + /** + * The name of the source. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'sourceName': string; + /** + * The ID of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'identityId': string; + /** + * The name of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountcreatedV1 + */ + 'identityName': string; + /** + * The attributes of the account. The contents of attributes depends on the account schema for the source. + * @type {{ [key: string]: any; }} + * @memberof SourceaccountcreatedV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * + * @export + * @interface SourceaccountdeletedV1 + */ +export interface SourceaccountdeletedV1 { + /** + * Source unique identifier for the identity. UUID is generated by the source system. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'uuid'?: string; + /** + * SailPoint generated unique identifier. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'id': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'nativeIdentifier': string; + /** + * The ID of the source. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'sourceId': string; + /** + * The name of the source. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'sourceName': string; + /** + * The ID of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'identityId': string; + /** + * The name of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountdeletedV1 + */ + 'identityName': string; + /** + * The attributes of the account. The contents of attributes depends on the account schema for the source. + * @type {{ [key: string]: any; }} + * @memberof SourceaccountdeletedV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * + * @export + * @interface SourceaccountupdatedV1 + */ +export interface SourceaccountupdatedV1 { + /** + * Source unique identifier for the identity. UUID is generated by the source system. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'uuid'?: string; + /** + * SailPoint generated unique identifier. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'id': string; + /** + * Unique ID of the account on the source. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'nativeIdentifier': string; + /** + * The ID of the source. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'sourceId': string; + /** + * The name of the source. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'sourceName': string; + /** + * The ID of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'identityId': string; + /** + * The name of the identity that is correlated with this account. + * @type {string} + * @memberof SourceaccountupdatedV1 + */ + 'identityName': string; + /** + * The attributes of the account. The contents of attributes depends on the account schema for the source. + * @type {{ [key: string]: any; }} + * @memberof SourceaccountupdatedV1 + */ + 'attributes': { [key: string]: any; }; +} +/** + * Identity who created the source. + * @export + * @interface SourcecreatedActorV1 + */ +export interface SourcecreatedActorV1 { + /** + * DTO type of identity who created the source. + * @type {string} + * @memberof SourcecreatedActorV1 + */ + 'type': SourcecreatedActorV1TypeV1; + /** + * ID of identity who created the source. + * @type {string} + * @memberof SourcecreatedActorV1 + */ + 'id': string; + /** + * Display name of identity who created the source. + * @type {string} + * @memberof SourcecreatedActorV1 + */ + 'name': string; +} + +export const SourcecreatedActorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SourcecreatedActorV1TypeV1 = typeof SourcecreatedActorV1TypeV1[keyof typeof SourcecreatedActorV1TypeV1]; + +/** + * + * @export + * @interface SourcecreatedV1 + */ +export interface SourcecreatedV1 { + /** + * The unique ID of the source. + * @type {string} + * @memberof SourcecreatedV1 + */ + 'id': string; + /** + * Human friendly name of the source. + * @type {string} + * @memberof SourcecreatedV1 + */ + 'name': string; + /** + * The connection type. + * @type {string} + * @memberof SourcecreatedV1 + */ + 'type': string; + /** + * The date and time the source was created. + * @type {string} + * @memberof SourcecreatedV1 + */ + 'created': string; + /** + * The connector type used to connect to the source. + * @type {string} + * @memberof SourcecreatedV1 + */ + 'connector': string; + /** + * + * @type {SourcecreatedActorV1} + * @memberof SourcecreatedV1 + */ + 'actor': SourcecreatedActorV1; +} +/** + * Identity who deleted the source. + * @export + * @interface SourcedeletedActorV1 + */ +export interface SourcedeletedActorV1 { + /** + * DTO type of identity who deleted the source. + * @type {string} + * @memberof SourcedeletedActorV1 + */ + 'type': SourcedeletedActorV1TypeV1; + /** + * ID of identity who deleted the source. + * @type {string} + * @memberof SourcedeletedActorV1 + */ + 'id': string; + /** + * Display name of identity who deleted the source. + * @type {string} + * @memberof SourcedeletedActorV1 + */ + 'name': string; +} + +export const SourcedeletedActorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SourcedeletedActorV1TypeV1 = typeof SourcedeletedActorV1TypeV1[keyof typeof SourcedeletedActorV1TypeV1]; + +/** + * + * @export + * @interface SourcedeletedV1 + */ +export interface SourcedeletedV1 { + /** + * The unique ID of the source. + * @type {string} + * @memberof SourcedeletedV1 + */ + 'id': string; + /** + * Human friendly name of the source. + * @type {string} + * @memberof SourcedeletedV1 + */ + 'name': string; + /** + * The connection type. + * @type {string} + * @memberof SourcedeletedV1 + */ + 'type': string; + /** + * The date and time the source was deleted. + * @type {string} + * @memberof SourcedeletedV1 + */ + 'deleted': string; + /** + * The connector type used to connect to the source. + * @type {string} + * @memberof SourcedeletedV1 + */ + 'connector': string; + /** + * + * @type {SourcedeletedActorV1} + * @memberof SourcedeletedV1 + */ + 'actor': SourcedeletedActorV1; +} +/** + * Identity who updated the source. + * @export + * @interface SourceupdatedActorV1 + */ +export interface SourceupdatedActorV1 { + /** + * DTO type of identity who updated the source. + * @type {string} + * @memberof SourceupdatedActorV1 + */ + 'type': SourceupdatedActorV1TypeV1; + /** + * ID of identity who updated the source. + * @type {string} + * @memberof SourceupdatedActorV1 + */ + 'id'?: string; + /** + * Display name of identity who updated the source. + * @type {string} + * @memberof SourceupdatedActorV1 + */ + 'name': string; +} + +export const SourceupdatedActorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type SourceupdatedActorV1TypeV1 = typeof SourceupdatedActorV1TypeV1[keyof typeof SourceupdatedActorV1TypeV1]; + +/** + * + * @export + * @interface SourceupdatedV1 + */ +export interface SourceupdatedV1 { + /** + * The unique ID of the source. + * @type {string} + * @memberof SourceupdatedV1 + */ + 'id': string; + /** + * The user friendly name of the source. + * @type {string} + * @memberof SourceupdatedV1 + */ + 'name': string; + /** + * The connection type of the source. + * @type {string} + * @memberof SourceupdatedV1 + */ + 'type': string; + /** + * The date and time the source was modified. + * @type {string} + * @memberof SourceupdatedV1 + */ + 'modified': string; + /** + * The connector type used to connect to the source. + * @type {string} + * @memberof SourceupdatedV1 + */ + 'connector': string; + /** + * + * @type {SourceupdatedActorV1} + * @memberof SourceupdatedV1 + */ + 'actor': SourceupdatedActorV1; +} +/** + * + * @export + * @interface StartinvocationinputV1 + */ +export interface StartinvocationinputV1 { + /** + * Trigger ID + * @type {string} + * @memberof StartinvocationinputV1 + */ + 'triggerId'?: string; + /** + * Trigger input payload. Its schema is defined in the trigger definition. + * @type {object} + * @memberof StartinvocationinputV1 + */ + 'input'?: object; + /** + * JSON map of invocation metadata + * @type {object} + * @memberof StartinvocationinputV1 + */ + 'contentJson'?: object; +} +/** + * + * @export + * @interface SubscriptionV1 + */ +export interface SubscriptionV1 { + /** + * Subscription ID. + * @type {string} + * @memberof SubscriptionV1 + */ + 'id': string; + /** + * Subscription name. + * @type {string} + * @memberof SubscriptionV1 + */ + 'name': string; + /** + * Subscription description. + * @type {string} + * @memberof SubscriptionV1 + */ + 'description'?: string; + /** + * ID of trigger subscribed to. + * @type {string} + * @memberof SubscriptionV1 + */ + 'triggerId': string; + /** + * Trigger name of trigger subscribed to. + * @type {string} + * @memberof SubscriptionV1 + */ + 'triggerName': string; + /** + * + * @type {SubscriptiontypeV1} + * @memberof SubscriptionV1 + */ + 'type': SubscriptiontypeV1; + /** + * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. + * @type {string} + * @memberof SubscriptionV1 + */ + 'responseDeadline'?: string; + /** + * + * @type {HttpconfigV1} + * @memberof SubscriptionV1 + */ + 'httpConfig'?: HttpconfigV1; + /** + * + * @type {EventbridgeconfigV1} + * @memberof SubscriptionV1 + */ + 'eventBridgeConfig'?: EventbridgeconfigV1; + /** + * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. + * @type {boolean} + * @memberof SubscriptionV1 + */ + 'enabled': boolean; + /** + * JSONPath filter to conditionally invoke trigger when expression evaluates to true. + * @type {string} + * @memberof SubscriptionV1 + */ + 'filter'?: string; +} + + +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface SubscriptionpatchrequestInnerV1 + */ +export interface SubscriptionpatchrequestInnerV1 { + /** + * The operation to be performed + * @type {string} + * @memberof SubscriptionpatchrequestInnerV1 + */ + 'op': SubscriptionpatchrequestInnerV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof SubscriptionpatchrequestInnerV1 + */ + 'path': string; + /** + * + * @type {SubscriptionpatchrequestInnerValueV1} + * @memberof SubscriptionpatchrequestInnerV1 + */ + 'value'?: SubscriptionpatchrequestInnerValueV1; +} + +export const SubscriptionpatchrequestInnerV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy' +} as const; + +export type SubscriptionpatchrequestInnerV1OpV1 = typeof SubscriptionpatchrequestInnerV1OpV1[keyof typeof SubscriptionpatchrequestInnerV1OpV1]; + +/** + * + * @export + * @interface SubscriptionpatchrequestInnerValueAnyOfInnerV1 + */ +export interface SubscriptionpatchrequestInnerValueAnyOfInnerV1 { +} +/** + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + * @interface SubscriptionpatchrequestInnerValueV1 + */ +export interface SubscriptionpatchrequestInnerValueV1 { +} +/** + * + * @export + * @interface SubscriptionpostrequestV1 + */ +export interface SubscriptionpostrequestV1 { + /** + * Subscription name. + * @type {string} + * @memberof SubscriptionpostrequestV1 + */ + 'name': string; + /** + * Subscription description. + * @type {string} + * @memberof SubscriptionpostrequestV1 + */ + 'description'?: string; + /** + * ID of trigger subscribed to. + * @type {string} + * @memberof SubscriptionpostrequestV1 + */ + 'triggerId': string; + /** + * + * @type {SubscriptiontypeV1} + * @memberof SubscriptionpostrequestV1 + */ + 'type': SubscriptiontypeV1; + /** + * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. + * @type {string} + * @memberof SubscriptionpostrequestV1 + */ + 'responseDeadline'?: string; + /** + * + * @type {HttpconfigV1} + * @memberof SubscriptionpostrequestV1 + */ + 'httpConfig'?: HttpconfigV1; + /** + * + * @type {EventbridgeconfigV1} + * @memberof SubscriptionpostrequestV1 + */ + 'eventBridgeConfig'?: EventbridgeconfigV1; + /** + * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. + * @type {boolean} + * @memberof SubscriptionpostrequestV1 + */ + 'enabled'?: boolean; + /** + * JSONPath filter to conditionally invoke trigger when expression evaluates to true. + * @type {string} + * @memberof SubscriptionpostrequestV1 + */ + 'filter'?: string; +} + + +/** + * + * @export + * @interface SubscriptionputrequestV1 + */ +export interface SubscriptionputrequestV1 { + /** + * Subscription name. + * @type {string} + * @memberof SubscriptionputrequestV1 + */ + 'name'?: string; + /** + * Subscription description. + * @type {string} + * @memberof SubscriptionputrequestV1 + */ + 'description'?: string; + /** + * + * @type {SubscriptiontypeV1} + * @memberof SubscriptionputrequestV1 + */ + 'type'?: SubscriptiontypeV1; + /** + * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. + * @type {string} + * @memberof SubscriptionputrequestV1 + */ + 'responseDeadline'?: string; + /** + * + * @type {HttpconfigV1} + * @memberof SubscriptionputrequestV1 + */ + 'httpConfig'?: HttpconfigV1; + /** + * + * @type {EventbridgeconfigV1} + * @memberof SubscriptionputrequestV1 + */ + 'eventBridgeConfig'?: EventbridgeconfigV1; + /** + * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. + * @type {boolean} + * @memberof SubscriptionputrequestV1 + */ + 'enabled'?: boolean; + /** + * JSONPath filter to conditionally invoke trigger when expression evaluates to true. + * @type {string} + * @memberof SubscriptionputrequestV1 + */ + 'filter'?: string; +} + + +/** + * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. + * @export + * @enum {string} + */ + +export const SubscriptiontypeV1 = { + Http: 'HTTP', + Eventbridge: 'EVENTBRIDGE', + Inline: 'INLINE', + Script: 'SCRIPT', + Workflow: 'WORKFLOW' +} as const; + +export type SubscriptiontypeV1 = typeof SubscriptiontypeV1[keyof typeof SubscriptiontypeV1]; + + +/** + * + * @export + * @interface TestinvocationV1 + */ +export interface TestinvocationV1 { + /** + * Trigger ID + * @type {string} + * @memberof TestinvocationV1 + */ + 'triggerId': string; + /** + * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. + * @type {object} + * @memberof TestinvocationV1 + */ + 'input'?: object; + /** + * JSON map of invocation metadata. + * @type {object} + * @memberof TestinvocationV1 + */ + 'contentJson': object; + /** + * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. + * @type {Array} + * @memberof TestinvocationV1 + */ + 'subscriptionIds'?: Array; +} +/** + * @type TriggerExampleInputV1 + * An example of the JSON payload that will be sent by the trigger to the subscribed service. + * @export + */ +export type TriggerExampleInputV1 = AccessrequestdynamicapproverV1 | AccessrequestpostapprovalV1 | AccessrequestpreapprovalV1 | AccountaggregationcompletedV1 | AccountattributeschangedV1 | AccountcorrelatedV1 | AccountcreatedV1 | AccountdeletedV1 | AccountscollectedforaggregationV1 | AccountuncorrelatedV1 | AccountupdatedV1 | CampaignactivatedV1 | CampaignendedV1 | CampaigngeneratedV1 | CertificationsignedoffV1 | IdentityattributeschangedV1 | IdentitycreatedV1 | IdentitydeletedV1 | MachineidentitycreatedV1 | MachineidentitydeletedV1 | MachineidentityupdatedV1 | ProvisioningcompletedV1 | SavedsearchcompleteV1 | SourceaccountcreatedV1 | SourceaccountdeletedV1 | SourceaccountupdatedV1 | SourcecreatedV1 | SourcedeletedV1 | SourceupdatedV1 | VaclusterstatuschangeeventV1; + +/** + * @type TriggerExampleOutputV1 + * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. + * @export + */ +export type TriggerExampleOutputV1 = Accessrequestdynamicapprover2V1 | Accessrequestpreapproval2V1; + +/** + * + * @export + * @interface TriggerV1 + */ +export interface TriggerV1 { + /** + * Unique identifier of the trigger. + * @type {string} + * @memberof TriggerV1 + */ + 'id': string; + /** + * Trigger Name. + * @type {string} + * @memberof TriggerV1 + */ + 'name': string; + /** + * + * @type {TriggertypeV1} + * @memberof TriggerV1 + */ + 'type': TriggertypeV1; + /** + * Trigger Description. + * @type {string} + * @memberof TriggerV1 + */ + 'description'?: string; + /** + * The JSON schema of the payload that will be sent by the trigger to the subscribed service. + * @type {string} + * @memberof TriggerV1 + */ + 'inputSchema': string; + /** + * + * @type {TriggerExampleInputV1} + * @memberof TriggerV1 + */ + 'exampleInput': TriggerExampleInputV1; + /** + * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. + * @type {string} + * @memberof TriggerV1 + */ + 'outputSchema'?: string | null; + /** + * + * @type {TriggerExampleOutputV1} + * @memberof TriggerV1 + */ + 'exampleOutput'?: TriggerExampleOutputV1 | null; +} + + +/** + * The type of trigger. + * @export + * @enum {string} + */ + +export const TriggertypeV1 = { + RequestResponse: 'REQUEST_RESPONSE', + FireAndForget: 'FIRE_AND_FORGET' +} as const; + +export type TriggertypeV1 = typeof TriggertypeV1[keyof typeof TriggertypeV1]; + + +/** + * Details about the `CLUSTER` or `SOURCE` that initiated this event. + * @export + * @interface VaclusterstatuschangeeventApplicationV1 + */ +export interface VaclusterstatuschangeeventApplicationV1 { + /** + * The GUID of the application + * @type {string} + * @memberof VaclusterstatuschangeeventApplicationV1 + */ + 'id': string; + /** + * The name of the application + * @type {string} + * @memberof VaclusterstatuschangeeventApplicationV1 + */ + 'name': string; + /** + * Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. + * @type {{ [key: string]: any; }} + * @memberof VaclusterstatuschangeeventApplicationV1 + */ + 'attributes': { [key: string]: any; } | null; +} +/** + * The results of the most recent health check. + * @export + * @interface VaclusterstatuschangeeventHealthCheckResultV1 + */ +export interface VaclusterstatuschangeeventHealthCheckResultV1 { + /** + * Detailed message of the result of the health check. + * @type {string} + * @memberof VaclusterstatuschangeeventHealthCheckResultV1 + */ + 'message': string; + /** + * The type of the health check result. + * @type {string} + * @memberof VaclusterstatuschangeeventHealthCheckResultV1 + */ + 'resultType': string; + /** + * The status of the health check. + * @type {string} + * @memberof VaclusterstatuschangeeventHealthCheckResultV1 + */ + 'status': VaclusterstatuschangeeventHealthCheckResultV1StatusV1; +} + +export const VaclusterstatuschangeeventHealthCheckResultV1StatusV1 = { + Succeeded: 'Succeeded', + Failed: 'Failed' +} as const; + +export type VaclusterstatuschangeeventHealthCheckResultV1StatusV1 = typeof VaclusterstatuschangeeventHealthCheckResultV1StatusV1[keyof typeof VaclusterstatuschangeeventHealthCheckResultV1StatusV1]; + +/** + * The results of the last health check. + * @export + * @interface VaclusterstatuschangeeventPreviousHealthCheckResultV1 + */ +export interface VaclusterstatuschangeeventPreviousHealthCheckResultV1 { + /** + * Detailed message of the result of the health check. + * @type {string} + * @memberof VaclusterstatuschangeeventPreviousHealthCheckResultV1 + */ + 'message': string; + /** + * The type of the health check result. + * @type {string} + * @memberof VaclusterstatuschangeeventPreviousHealthCheckResultV1 + */ + 'resultType': string; + /** + * The status of the health check. + * @type {string} + * @memberof VaclusterstatuschangeeventPreviousHealthCheckResultV1 + */ + 'status': VaclusterstatuschangeeventPreviousHealthCheckResultV1StatusV1; +} + +export const VaclusterstatuschangeeventPreviousHealthCheckResultV1StatusV1 = { + Succeeded: 'Succeeded', + Failed: 'Failed' +} as const; + +export type VaclusterstatuschangeeventPreviousHealthCheckResultV1StatusV1 = typeof VaclusterstatuschangeeventPreviousHealthCheckResultV1StatusV1[keyof typeof VaclusterstatuschangeeventPreviousHealthCheckResultV1StatusV1]; + +/** + * + * @export + * @interface VaclusterstatuschangeeventV1 + */ +export interface VaclusterstatuschangeeventV1 { + /** + * The date and time the status change occurred. + * @type {string} + * @memberof VaclusterstatuschangeeventV1 + */ + 'created': string; + /** + * The type of the object that initiated this event. + * @type {string} + * @memberof VaclusterstatuschangeeventV1 + */ + 'type': VaclusterstatuschangeeventV1TypeV1; + /** + * + * @type {VaclusterstatuschangeeventApplicationV1} + * @memberof VaclusterstatuschangeeventV1 + */ + 'application': VaclusterstatuschangeeventApplicationV1; + /** + * + * @type {VaclusterstatuschangeeventHealthCheckResultV1} + * @memberof VaclusterstatuschangeeventV1 + */ + 'healthCheckResult': VaclusterstatuschangeeventHealthCheckResultV1; + /** + * + * @type {VaclusterstatuschangeeventPreviousHealthCheckResultV1} + * @memberof VaclusterstatuschangeeventV1 + */ + 'previousHealthCheckResult': VaclusterstatuschangeeventPreviousHealthCheckResultV1; +} + +export const VaclusterstatuschangeeventV1TypeV1 = { + Source: 'SOURCE', + Cluster: 'CLUSTER' +} as const; + +export type VaclusterstatuschangeeventV1TypeV1 = typeof VaclusterstatuschangeeventV1TypeV1[keyof typeof VaclusterstatuschangeeventV1TypeV1]; + +/** + * + * @export + * @interface ValidatefilterinputdtoV1 + */ +export interface ValidatefilterinputdtoV1 { + /** + * Mock input to evaluate filter expression against. + * @type {object} + * @memberof ValidatefilterinputdtoV1 + */ + 'input': object; + /** + * JSONPath filter to conditionally invoke trigger when expression evaluates to true. + * @type {string} + * @memberof ValidatefilterinputdtoV1 + */ + 'filter': string; +} +/** + * + * @export + * @interface ValidatefilteroutputdtoV1 + */ +export interface ValidatefilteroutputdtoV1 { + /** + * When this field is true, the filter expression is valid against the input. + * @type {boolean} + * @memberof ValidatefilteroutputdtoV1 + */ + 'isValid'?: boolean; + /** + * When this field is true, the filter expression is using a valid JSON path. + * @type {boolean} + * @memberof ValidatefilteroutputdtoV1 + */ + 'isValidJSONPath'?: boolean; + /** + * When this field is true, the filter expression is using an existing path. + * @type {boolean} + * @memberof ValidatefilteroutputdtoV1 + */ + 'isPathExist'?: boolean; +} + +/** + * TriggersV1Api - axios parameter creator + * @export + */ +export const TriggersV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Completes an invocation to a REQUEST_RESPONSE type trigger. + * @summary Complete trigger invocation + * @param {string} id The ID of the invocation to complete. + * @param {CompleteinvocationV1} completeinvocationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeTriggerInvocationV1: async (id: string, completeinvocationV1: CompleteinvocationV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('completeTriggerInvocationV1', 'id', id) + // verify required parameter 'completeinvocationV1' is not null or undefined + assertParamExists('completeTriggerInvocationV1', 'completeinvocationV1', completeinvocationV1) + const localVarPath = `/trigger-invocations/v1/{id}/complete` + .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: '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(completeinvocationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig + * @summary Create a subscription + * @param {SubscriptionpostrequestV1} subscriptionpostrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSubscriptionV1: async (subscriptionpostrequestV1: SubscriptionpostrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'subscriptionpostrequestV1' is not null or undefined + assertParamExists('createSubscriptionV1', 'subscriptionpostrequestV1', subscriptionpostrequestV1) + const localVarPath = `/trigger-subscriptions/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(subscriptionpostrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes an existing subscription to a trigger. + * @summary Delete a subscription + * @param {string} id Subscription ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSubscriptionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteSubscriptionV1', 'id', id) + const localVarPath = `/trigger-subscriptions/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, + }; + }, + /** + * Gets a list of all trigger subscriptions. + * @summary List subscriptions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSubscriptionsV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/trigger-subscriptions/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + * @summary List latest invocation statuses + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* + * @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: **triggerId, subscriptionName, created, completed** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTriggerInvocationStatusV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/trigger-invocations/v1/status`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * Gets a list of triggers that are available in the tenant. + * @summary List triggers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, 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, name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTriggersV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/triggers/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + 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, + }; + }, + /** + * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + * @summary Patch a subscription + * @param {string} id ID of the Subscription to patch + * @param {Array} subscriptionpatchrequestInnerV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSubscriptionV1: async (id: string, subscriptionpatchrequestInnerV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchSubscriptionV1', 'id', id) + // verify required parameter 'subscriptionpatchrequestInnerV1' is not null or undefined + assertParamExists('patchSubscriptionV1', 'subscriptionpatchrequestInnerV1', subscriptionpatchrequestInnerV1) + const localVarPath = `/trigger-subscriptions/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(subscriptionpatchrequestInnerV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + * @summary Start a test invocation + * @param {TestinvocationV1} testinvocationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startTestTriggerInvocationV1: async (testinvocationV1: TestinvocationV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'testinvocationV1' is not null or undefined + assertParamExists('startTestTriggerInvocationV1', 'testinvocationV1', testinvocationV1) + const localVarPath = `/trigger-invocations/v1/test`; + // 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(testinvocationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: + * @summary Validate a subscription filter + * @param {ValidatefilterinputdtoV1} validatefilterinputdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSubscriptionFilterV1: async (validatefilterinputdtoV1: ValidatefilterinputdtoV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'validatefilterinputdtoV1' is not null or undefined + assertParamExists('testSubscriptionFilterV1', 'validatefilterinputdtoV1', validatefilterinputdtoV1) + const localVarPath = `/trigger-subscriptions/v1/validate-filter`; + // 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(validatefilterinputdtoV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. + * @summary Update a subscription + * @param {string} id Subscription ID + * @param {SubscriptionputrequestV1} subscriptionputrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSubscriptionV1: async (id: string, subscriptionputrequestV1: SubscriptionputrequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('updateSubscriptionV1', 'id', id) + // verify required parameter 'subscriptionputrequestV1' is not null or undefined + assertParamExists('updateSubscriptionV1', 'subscriptionputrequestV1', subscriptionputrequestV1) + const localVarPath = `/trigger-subscriptions/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: 'PUT', ...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(subscriptionputrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * TriggersV1Api - functional programming interface + * @export + */ +export const TriggersV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TriggersV1ApiAxiosParamCreator(configuration) + return { + /** + * Completes an invocation to a REQUEST_RESPONSE type trigger. + * @summary Complete trigger invocation + * @param {string} id The ID of the invocation to complete. + * @param {CompleteinvocationV1} completeinvocationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async completeTriggerInvocationV1(id: string, completeinvocationV1: CompleteinvocationV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocationV1(id, completeinvocationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.completeTriggerInvocationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig + * @summary Create a subscription + * @param {SubscriptionpostrequestV1} subscriptionpostrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createSubscriptionV1(subscriptionpostrequestV1: SubscriptionpostrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscriptionV1(subscriptionpostrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.createSubscriptionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes an existing subscription to a trigger. + * @summary Delete a subscription + * @param {string} id Subscription ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteSubscriptionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscriptionV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.deleteSubscriptionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a list of all trigger subscriptions. + * @summary List subscriptions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listSubscriptionsV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptionsV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.listSubscriptionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + * @summary List latest invocation statuses + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* + * @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: **triggerId, subscriptionName, created, completed** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTriggerInvocationStatusV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatusV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.listTriggerInvocationStatusV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a list of triggers that are available in the tenant. + * @summary List triggers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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, 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, name** + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listTriggersV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggersV1(limit, offset, count, filters, sorters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.listTriggersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + * @summary Patch a subscription + * @param {string} id ID of the Subscription to patch + * @param {Array} subscriptionpatchrequestInnerV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchSubscriptionV1(id: string, subscriptionpatchrequestInnerV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscriptionV1(id, subscriptionpatchrequestInnerV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.patchSubscriptionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + * @summary Start a test invocation + * @param {TestinvocationV1} testinvocationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async startTestTriggerInvocationV1(testinvocationV1: TestinvocationV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocationV1(testinvocationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.startTestTriggerInvocationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: + * @summary Validate a subscription filter + * @param {ValidatefilterinputdtoV1} validatefilterinputdtoV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testSubscriptionFilterV1(validatefilterinputdtoV1: ValidatefilterinputdtoV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilterV1(validatefilterinputdtoV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.testSubscriptionFilterV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. + * @summary Update a subscription + * @param {string} id Subscription ID + * @param {SubscriptionputrequestV1} subscriptionputrequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async updateSubscriptionV1(id: string, subscriptionputrequestV1: SubscriptionputrequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscriptionV1(id, subscriptionputrequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TriggersV1Api.updateSubscriptionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TriggersV1Api - factory interface + * @export + */ +export const TriggersV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TriggersV1ApiFp(configuration) + return { + /** + * Completes an invocation to a REQUEST_RESPONSE type trigger. + * @summary Complete trigger invocation + * @param {TriggersV1ApiCompleteTriggerInvocationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeTriggerInvocationV1(requestParameters: TriggersV1ApiCompleteTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.completeTriggerInvocationV1(requestParameters.id, requestParameters.completeinvocationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig + * @summary Create a subscription + * @param {TriggersV1ApiCreateSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createSubscriptionV1(requestParameters: TriggersV1ApiCreateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSubscriptionV1(requestParameters.subscriptionpostrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes an existing subscription to a trigger. + * @summary Delete a subscription + * @param {TriggersV1ApiDeleteSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteSubscriptionV1(requestParameters: TriggersV1ApiDeleteSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteSubscriptionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of all trigger subscriptions. + * @summary List subscriptions + * @param {TriggersV1ApiListSubscriptionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listSubscriptionsV1(requestParameters: TriggersV1ApiListSubscriptionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listSubscriptionsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + * @summary List latest invocation statuses + * @param {TriggersV1ApiListTriggerInvocationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTriggerInvocationStatusV1(requestParameters: TriggersV1ApiListTriggerInvocationStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTriggerInvocationStatusV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a list of triggers that are available in the tenant. + * @summary List triggers + * @param {TriggersV1ApiListTriggersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listTriggersV1(requestParameters: TriggersV1ApiListTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + * @summary Patch a subscription + * @param {TriggersV1ApiPatchSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchSubscriptionV1(requestParameters: TriggersV1ApiPatchSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchSubscriptionV1(requestParameters.id, requestParameters.subscriptionpatchrequestInnerV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + * @summary Start a test invocation + * @param {TriggersV1ApiStartTestTriggerInvocationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + startTestTriggerInvocationV1(requestParameters: TriggersV1ApiStartTestTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.startTestTriggerInvocationV1(requestParameters.testinvocationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: + * @summary Validate a subscription filter + * @param {TriggersV1ApiTestSubscriptionFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testSubscriptionFilterV1(requestParameters: TriggersV1ApiTestSubscriptionFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testSubscriptionFilterV1(requestParameters.validatefilterinputdtoV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. + * @summary Update a subscription + * @param {TriggersV1ApiUpdateSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + updateSubscriptionV1(requestParameters: TriggersV1ApiUpdateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateSubscriptionV1(requestParameters.id, requestParameters.subscriptionputrequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for completeTriggerInvocationV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiCompleteTriggerInvocationV1Request + */ +export interface TriggersV1ApiCompleteTriggerInvocationV1Request { + /** + * The ID of the invocation to complete. + * @type {string} + * @memberof TriggersV1ApiCompleteTriggerInvocationV1 + */ + readonly id: string + + /** + * + * @type {CompleteinvocationV1} + * @memberof TriggersV1ApiCompleteTriggerInvocationV1 + */ + readonly completeinvocationV1: CompleteinvocationV1 +} + +/** + * Request parameters for createSubscriptionV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiCreateSubscriptionV1Request + */ +export interface TriggersV1ApiCreateSubscriptionV1Request { + /** + * + * @type {SubscriptionpostrequestV1} + * @memberof TriggersV1ApiCreateSubscriptionV1 + */ + readonly subscriptionpostrequestV1: SubscriptionpostrequestV1 +} + +/** + * Request parameters for deleteSubscriptionV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiDeleteSubscriptionV1Request + */ +export interface TriggersV1ApiDeleteSubscriptionV1Request { + /** + * Subscription ID + * @type {string} + * @memberof TriggersV1ApiDeleteSubscriptionV1 + */ + readonly id: string +} + +/** + * Request parameters for listSubscriptionsV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiListSubscriptionsV1Request + */ +export interface TriggersV1ApiListSubscriptionsV1Request { + /** + * 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 TriggersV1ApiListSubscriptionsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TriggersV1ApiListSubscriptionsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TriggersV1ApiListSubscriptionsV1 + */ + 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* **triggerId**: *eq* **type**: *eq, le* + * @type {string} + * @memberof TriggersV1ApiListSubscriptionsV1 + */ + 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: **triggerId, triggerName** + * @type {string} + * @memberof TriggersV1ApiListSubscriptionsV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listTriggerInvocationStatusV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiListTriggerInvocationStatusV1Request + */ +export interface TriggersV1ApiListTriggerInvocationStatusV1Request { + /** + * 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 TriggersV1ApiListTriggerInvocationStatusV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TriggersV1ApiListTriggerInvocationStatusV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TriggersV1ApiListTriggerInvocationStatusV1 + */ + 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: **triggerId**: *eq* **subscriptionId**: *eq* + * @type {string} + * @memberof TriggersV1ApiListTriggerInvocationStatusV1 + */ + 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: **triggerId, subscriptionName, created, completed** + * @type {string} + * @memberof TriggersV1ApiListTriggerInvocationStatusV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for listTriggersV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiListTriggersV1Request + */ +export interface TriggersV1ApiListTriggersV1Request { + /** + * 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 TriggersV1ApiListTriggersV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof TriggersV1ApiListTriggersV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof TriggersV1ApiListTriggersV1 + */ + 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, ge, le* + * @type {string} + * @memberof TriggersV1ApiListTriggersV1 + */ + 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, name** + * @type {string} + * @memberof TriggersV1ApiListTriggersV1 + */ + readonly sorters?: string +} + +/** + * Request parameters for patchSubscriptionV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiPatchSubscriptionV1Request + */ +export interface TriggersV1ApiPatchSubscriptionV1Request { + /** + * ID of the Subscription to patch + * @type {string} + * @memberof TriggersV1ApiPatchSubscriptionV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof TriggersV1ApiPatchSubscriptionV1 + */ + readonly subscriptionpatchrequestInnerV1: Array +} + +/** + * Request parameters for startTestTriggerInvocationV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiStartTestTriggerInvocationV1Request + */ +export interface TriggersV1ApiStartTestTriggerInvocationV1Request { + /** + * + * @type {TestinvocationV1} + * @memberof TriggersV1ApiStartTestTriggerInvocationV1 + */ + readonly testinvocationV1: TestinvocationV1 +} + +/** + * Request parameters for testSubscriptionFilterV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiTestSubscriptionFilterV1Request + */ +export interface TriggersV1ApiTestSubscriptionFilterV1Request { + /** + * + * @type {ValidatefilterinputdtoV1} + * @memberof TriggersV1ApiTestSubscriptionFilterV1 + */ + readonly validatefilterinputdtoV1: ValidatefilterinputdtoV1 +} + +/** + * Request parameters for updateSubscriptionV1 operation in TriggersV1Api. + * @export + * @interface TriggersV1ApiUpdateSubscriptionV1Request + */ +export interface TriggersV1ApiUpdateSubscriptionV1Request { + /** + * Subscription ID + * @type {string} + * @memberof TriggersV1ApiUpdateSubscriptionV1 + */ + readonly id: string + + /** + * + * @type {SubscriptionputrequestV1} + * @memberof TriggersV1ApiUpdateSubscriptionV1 + */ + readonly subscriptionputrequestV1: SubscriptionputrequestV1 +} + +/** + * TriggersV1Api - object-oriented interface + * @export + * @class TriggersV1Api + * @extends {BaseAPI} + */ +export class TriggersV1Api extends BaseAPI { + /** + * Completes an invocation to a REQUEST_RESPONSE type trigger. + * @summary Complete trigger invocation + * @param {TriggersV1ApiCompleteTriggerInvocationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public completeTriggerInvocationV1(requestParameters: TriggersV1ApiCompleteTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).completeTriggerInvocationV1(requestParameters.id, requestParameters.completeinvocationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig + * @summary Create a subscription + * @param {TriggersV1ApiCreateSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public createSubscriptionV1(requestParameters: TriggersV1ApiCreateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).createSubscriptionV1(requestParameters.subscriptionpostrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes an existing subscription to a trigger. + * @summary Delete a subscription + * @param {TriggersV1ApiDeleteSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public deleteSubscriptionV1(requestParameters: TriggersV1ApiDeleteSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).deleteSubscriptionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of all trigger subscriptions. + * @summary List subscriptions + * @param {TriggersV1ApiListSubscriptionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public listSubscriptionsV1(requestParameters: TriggersV1ApiListSubscriptionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).listSubscriptionsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + * @summary List latest invocation statuses + * @param {TriggersV1ApiListTriggerInvocationStatusV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public listTriggerInvocationStatusV1(requestParameters: TriggersV1ApiListTriggerInvocationStatusV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).listTriggerInvocationStatusV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a list of triggers that are available in the tenant. + * @summary List triggers + * @param {TriggersV1ApiListTriggersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public listTriggersV1(requestParameters: TriggersV1ApiListTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).listTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + * @summary Patch a subscription + * @param {TriggersV1ApiPatchSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public patchSubscriptionV1(requestParameters: TriggersV1ApiPatchSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).patchSubscriptionV1(requestParameters.id, requestParameters.subscriptionpatchrequestInnerV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + * @summary Start a test invocation + * @param {TriggersV1ApiStartTestTriggerInvocationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public startTestTriggerInvocationV1(requestParameters: TriggersV1ApiStartTestTriggerInvocationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).startTestTriggerInvocationV1(requestParameters.testinvocationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: + * @summary Validate a subscription filter + * @param {TriggersV1ApiTestSubscriptionFilterV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public testSubscriptionFilterV1(requestParameters: TriggersV1ApiTestSubscriptionFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).testSubscriptionFilterV1(requestParameters.validatefilterinputdtoV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. + * @summary Update a subscription + * @param {TriggersV1ApiUpdateSubscriptionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof TriggersV1Api + */ + public updateSubscriptionV1(requestParameters: TriggersV1ApiUpdateSubscriptionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return TriggersV1ApiFp(this.configuration).updateSubscriptionV1(requestParameters.id, requestParameters.subscriptionputrequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/triggers/base.ts b/sdk-output/triggers/base.ts new file mode 100644 index 00000000..88414fe0 --- /dev/null +++ b/sdk-output/triggers/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Triggers + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/triggers/common.ts b/sdk-output/triggers/common.ts new file mode 100644 index 00000000..2ca5f4c2 --- /dev/null +++ b/sdk-output/triggers/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Triggers + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/triggers/configuration.ts b/sdk-output/triggers/configuration.ts new file mode 100644 index 00000000..3b462274 --- /dev/null +++ b/sdk-output/triggers/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Triggers + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/triggers/git_push.sh b/sdk-output/triggers/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/triggers/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/triggers/index.ts b/sdk-output/triggers/index.ts new file mode 100644 index 00000000..2c2b17bd --- /dev/null +++ b/sdk-output/triggers/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Triggers + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/triggers/package.json b/sdk-output/triggers/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/triggers/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/triggers/tsconfig.json b/sdk-output/triggers/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/triggers/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/tsconfig.json b/sdk-output/tsconfig.json index bcb03159..21bb3ed4 100644 --- a/sdk-output/tsconfig.json +++ b/sdk-output/tsconfig.json @@ -14,6 +14,10 @@ "typeRoots": [ "node_modules/@types" ], + "types": [ + "jest", + "node" + ], "sourceMap": true }, "exclude": [ diff --git a/sdk-output/ui_metadata/.gitignore b/sdk-output/ui_metadata/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/ui_metadata/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/ui_metadata/.npmignore b/sdk-output/ui_metadata/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/ui_metadata/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/ui_metadata/.openapi-generator-ignore b/sdk-output/ui_metadata/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/ui_metadata/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/ui_metadata/.openapi-generator/FILES b/sdk-output/ui_metadata/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/ui_metadata/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/ui_metadata/.openapi-generator/VERSION b/sdk-output/ui_metadata/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/ui_metadata/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/ui_metadata/.sdk-partition b/sdk-output/ui_metadata/.sdk-partition new file mode 100644 index 00000000..7a609d1a --- /dev/null +++ b/sdk-output/ui_metadata/.sdk-partition @@ -0,0 +1 @@ +ui-metadata \ No newline at end of file diff --git a/sdk-output/ui_metadata/README.md b/sdk-output/ui_metadata/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/ui_metadata/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/ui_metadata/api.ts b/sdk-output/ui_metadata/api.ts new file mode 100644 index 00000000..d477de38 --- /dev/null +++ b/sdk-output/ui_metadata/api.ts @@ -0,0 +1,401 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - UI Metadata + * 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 ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface GetTenantUiMetadataV1401ResponseV1 + */ +export interface GetTenantUiMetadataV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantUiMetadataV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetTenantUiMetadataV1429ResponseV1 + */ +export interface GetTenantUiMetadataV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetTenantUiMetadataV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface TenantuimetadataitemresponseV1 + */ +export interface TenantuimetadataitemresponseV1 { + /** + * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. + * @type {string} + * @memberof TenantuimetadataitemresponseV1 + */ + 'iframeWhiteList'?: string | null; + /** + * Descriptor for the username input field. If you would like to reset the value use \"null\". + * @type {string} + * @memberof TenantuimetadataitemresponseV1 + */ + 'usernameLabel'?: string | null; + /** + * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". + * @type {string} + * @memberof TenantuimetadataitemresponseV1 + */ + 'usernameEmptyText'?: string | null; +} +/** + * + * @export + * @interface TenantuimetadataitemupdaterequestV1 + */ +export interface TenantuimetadataitemupdaterequestV1 { + /** + * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. + * @type {string} + * @memberof TenantuimetadataitemupdaterequestV1 + */ + 'iframeWhiteList'?: string | null; + /** + * Descriptor for the username input field. If you would like to reset the value use \"null\". + * @type {string} + * @memberof TenantuimetadataitemupdaterequestV1 + */ + 'usernameLabel'?: string | null; + /** + * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". + * @type {string} + * @memberof TenantuimetadataitemupdaterequestV1 + */ + 'usernameEmptyText'?: string | null; +} + +/** + * UIMetadataV1Api - axios parameter creator + * @export + */ +export const UIMetadataV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API endpoint retrieves UI metadata configured for your tenant. + * @summary Get a tenant ui metadata + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantUiMetadataV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ui-metadata/v1/tenant`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + * @summary Update tenant ui metadata + * @param {TenantuimetadataitemupdaterequestV1} tenantuimetadataitemupdaterequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTenantUiMetadataV1: async (tenantuimetadataitemupdaterequestV1: TenantuimetadataitemupdaterequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'tenantuimetadataitemupdaterequestV1' is not null or undefined + assertParamExists('setTenantUiMetadataV1', 'tenantuimetadataitemupdaterequestV1', tenantuimetadataitemupdaterequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/ui-metadata/v1/tenant`; + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(tenantuimetadataitemupdaterequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * UIMetadataV1Api - functional programming interface + * @export + */ +export const UIMetadataV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = UIMetadataV1ApiAxiosParamCreator(configuration) + return { + /** + * This API endpoint retrieves UI metadata configured for your tenant. + * @summary Get a tenant ui metadata + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTenantUiMetadataV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantUiMetadataV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['UIMetadataV1Api.getTenantUiMetadataV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + * @summary Update tenant ui metadata + * @param {TenantuimetadataitemupdaterequestV1} tenantuimetadataitemupdaterequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async setTenantUiMetadataV1(tenantuimetadataitemupdaterequestV1: TenantuimetadataitemupdaterequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setTenantUiMetadataV1(tenantuimetadataitemupdaterequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['UIMetadataV1Api.setTenantUiMetadataV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * UIMetadataV1Api - factory interface + * @export + */ +export const UIMetadataV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = UIMetadataV1ApiFp(configuration) + return { + /** + * This API endpoint retrieves UI metadata configured for your tenant. + * @summary Get a tenant ui metadata + * @param {UIMetadataV1ApiGetTenantUiMetadataV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantUiMetadataV1(requestParameters: UIMetadataV1ApiGetTenantUiMetadataV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTenantUiMetadataV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + * @summary Update tenant ui metadata + * @param {UIMetadataV1ApiSetTenantUiMetadataV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + setTenantUiMetadataV1(requestParameters: UIMetadataV1ApiSetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setTenantUiMetadataV1(requestParameters.tenantuimetadataitemupdaterequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getTenantUiMetadataV1 operation in UIMetadataV1Api. + * @export + * @interface UIMetadataV1ApiGetTenantUiMetadataV1Request + */ +export interface UIMetadataV1ApiGetTenantUiMetadataV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof UIMetadataV1ApiGetTenantUiMetadataV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for setTenantUiMetadataV1 operation in UIMetadataV1Api. + * @export + * @interface UIMetadataV1ApiSetTenantUiMetadataV1Request + */ +export interface UIMetadataV1ApiSetTenantUiMetadataV1Request { + /** + * + * @type {TenantuimetadataitemupdaterequestV1} + * @memberof UIMetadataV1ApiSetTenantUiMetadataV1 + */ + readonly tenantuimetadataitemupdaterequestV1: TenantuimetadataitemupdaterequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof UIMetadataV1ApiSetTenantUiMetadataV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * UIMetadataV1Api - object-oriented interface + * @export + * @class UIMetadataV1Api + * @extends {BaseAPI} + */ +export class UIMetadataV1Api extends BaseAPI { + /** + * This API endpoint retrieves UI metadata configured for your tenant. + * @summary Get a tenant ui metadata + * @param {UIMetadataV1ApiGetTenantUiMetadataV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof UIMetadataV1Api + */ + public getTenantUiMetadataV1(requestParameters: UIMetadataV1ApiGetTenantUiMetadataV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return UIMetadataV1ApiFp(this.configuration).getTenantUiMetadataV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + * @summary Update tenant ui metadata + * @param {UIMetadataV1ApiSetTenantUiMetadataV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof UIMetadataV1Api + */ + public setTenantUiMetadataV1(requestParameters: UIMetadataV1ApiSetTenantUiMetadataV1Request, axiosOptions?: RawAxiosRequestConfig) { + return UIMetadataV1ApiFp(this.configuration).setTenantUiMetadataV1(requestParameters.tenantuimetadataitemupdaterequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/ui_metadata/base.ts b/sdk-output/ui_metadata/base.ts new file mode 100644 index 00000000..61188beb --- /dev/null +++ b/sdk-output/ui_metadata/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - UI Metadata + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/ui_metadata/common.ts b/sdk-output/ui_metadata/common.ts new file mode 100644 index 00000000..1275eece --- /dev/null +++ b/sdk-output/ui_metadata/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - UI Metadata + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/ui_metadata/configuration.ts b/sdk-output/ui_metadata/configuration.ts new file mode 100644 index 00000000..c889db37 --- /dev/null +++ b/sdk-output/ui_metadata/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - UI Metadata + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/ui_metadata/git_push.sh b/sdk-output/ui_metadata/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/ui_metadata/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/ui_metadata/index.ts b/sdk-output/ui_metadata/index.ts new file mode 100644 index 00000000..ea2249e2 --- /dev/null +++ b/sdk-output/ui_metadata/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - UI Metadata + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/ui_metadata/package.json b/sdk-output/ui_metadata/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/ui_metadata/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/ui_metadata/tsconfig.json b/sdk-output/ui_metadata/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/ui_metadata/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/v2024/api.ts b/sdk-output/v2024/api.ts deleted file mode 100644 index 7a95f1aa..00000000 --- a/sdk-output/v2024/api.ts +++ /dev/null @@ -1,130021 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud V2024 API - * 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: v2024 - * - * - * 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'; - -/** - * Owner\'s identity. - * @export - * @interface AccessAppsOwnerV2024 - */ -export interface AccessAppsOwnerV2024 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof AccessAppsOwnerV2024 - */ - 'type'?: AccessAppsOwnerV2024TypeV2024; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof AccessAppsOwnerV2024 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof AccessAppsOwnerV2024 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof AccessAppsOwnerV2024 - */ - 'email'?: string; -} - -export const AccessAppsOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessAppsOwnerV2024TypeV2024 = typeof AccessAppsOwnerV2024TypeV2024[keyof typeof AccessAppsOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface AccessAppsV2024 - */ -export interface AccessAppsV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessAppsV2024 - */ - 'id'?: string; - /** - * Name of application - * @type {string} - * @memberof AccessAppsV2024 - */ - 'name'?: string; - /** - * Description of application. - * @type {string} - * @memberof AccessAppsV2024 - */ - 'description'?: string; - /** - * - * @type {AccessAppsOwnerV2024} - * @memberof AccessAppsV2024 - */ - 'owner'?: AccessAppsOwnerV2024; -} -/** - * - * @export - * @interface AccessConstraintV2024 - */ -export interface AccessConstraintV2024 { - /** - * Type of Access - * @type {string} - * @memberof AccessConstraintV2024 - */ - 'type': AccessConstraintV2024TypeV2024; - /** - * Must be set only if operator is SELECTED. - * @type {Array} - * @memberof AccessConstraintV2024 - */ - 'ids'?: Array; - /** - * Used to determine whether the scope of the campaign should be reduced for selected ids or all. - * @type {string} - * @memberof AccessConstraintV2024 - */ - 'operator': AccessConstraintV2024OperatorV2024; -} - -export const AccessConstraintV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessConstraintV2024TypeV2024 = typeof AccessConstraintV2024TypeV2024[keyof typeof AccessConstraintV2024TypeV2024]; -export const AccessConstraintV2024OperatorV2024 = { - All: 'ALL', - Selected: 'SELECTED' -} as const; - -export type AccessConstraintV2024OperatorV2024 = typeof AccessConstraintV2024OperatorV2024[keyof typeof AccessConstraintV2024OperatorV2024]; - -/** - * - * @export - * @interface AccessCriteriaCriteriaListInnerV2024 - */ -export interface AccessCriteriaCriteriaListInnerV2024 { - /** - * Type of the propery to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2024 - */ - 'type'?: AccessCriteriaCriteriaListInnerV2024TypeV2024; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2024 - */ - 'name'?: string; -} - -export const AccessCriteriaCriteriaListInnerV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaCriteriaListInnerV2024TypeV2024 = typeof AccessCriteriaCriteriaListInnerV2024TypeV2024[keyof typeof AccessCriteriaCriteriaListInnerV2024TypeV2024]; - -/** - * - * @export - * @interface AccessCriteriaV2024 - */ -export interface AccessCriteriaV2024 { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteriaV2024 - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteriaV2024 - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessDurationV2024 - */ -export interface AccessDurationV2024 { - /** - * The numeric value representing the amount of time, which is defined in the **timeUnit**. - * @type {number} - * @memberof AccessDurationV2024 - */ - 'value'?: number; - /** - * The unit of time that corresponds to the **value**. It defines the scale of the time period. - * @type {string} - * @memberof AccessDurationV2024 - */ - 'timeUnit'?: AccessDurationV2024TimeUnitV2024; -} - -export const AccessDurationV2024TimeUnitV2024 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type AccessDurationV2024TimeUnitV2024 = typeof AccessDurationV2024TimeUnitV2024[keyof typeof AccessDurationV2024TimeUnitV2024]; - -/** - * - * @export - * @interface AccessItemAccessProfileResponseAppRefsInnerV2024 - */ -export interface AccessItemAccessProfileResponseAppRefsInnerV2024 { - /** - * the cloud app id associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2024 - */ - 'cloudAppId'?: string; - /** - * the cloud app name associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2024 - */ - 'cloudAppName'?: string; -} -/** - * - * @export - * @interface AccessItemAccessProfileResponseV2024 - */ -export interface AccessItemAccessProfileResponseV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'id'?: string; - /** - * the access item type. accessProfile in this case - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'sourceName'?: string; - /** - * the number of entitlements the access profile will create - * @type {number} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'entitlementCount': number; - /** - * the description for the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'sourceId'?: string; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'startDate'?: string | null; - /** - * the date the access profile is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'removeDate'?: string | null; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'standalone': boolean | null; - /** - * indicates whether the access profile is revocable - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2024 - */ - 'revocable': boolean | null; -} -/** - * - * @export - * @interface AccessItemAccountResponseV2024 - */ -export interface AccessItemAccountResponseV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'id'?: string; - /** - * the access item type. account in this case - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'sourceName'?: string; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'nativeIdentity': string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccountResponseV2024 - */ - 'sourceId'?: string; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAccountResponseV2024 - */ - 'entitlementCount'?: number; -} -/** - * - * @export - * @interface AccessItemAppResponseV2024 - */ -export interface AccessItemAppResponseV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAppResponseV2024 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAppResponseV2024 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAppResponseV2024 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAppResponseV2024 - */ - 'sourceName'?: string | null; - /** - * the app role id - * @type {string} - * @memberof AccessItemAppResponseV2024 - */ - 'appRoleId': string | null; -} -/** - * Identity who approved the access item request. - * @export - * @interface AccessItemApproverDtoV2024 - */ -export interface AccessItemApproverDtoV2024 { - /** - * DTO type of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2024 - */ - 'type'?: AccessItemApproverDtoV2024TypeV2024; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2024 - */ - 'name'?: string; -} - -export const AccessItemApproverDtoV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemApproverDtoV2024TypeV2024 = typeof AccessItemApproverDtoV2024TypeV2024[keyof typeof AccessItemApproverDtoV2024TypeV2024]; - -/** - * - * @export - * @interface AccessItemAssociatedAccessItemV2024 - */ -export interface AccessItemAssociatedAccessItemV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2024 - */ - 'appRoleId': string | null; -} -/** - * - * @export - * @interface AccessItemAssociatedV2024 - */ -export interface AccessItemAssociatedV2024 { - /** - * the event type - * @type {string} - * @memberof AccessItemAssociatedV2024 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemAssociatedV2024 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof AccessItemAssociatedV2024 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2024} - * @memberof AccessItemAssociatedV2024 - */ - 'accessItem': AccessItemAssociatedAccessItemV2024; - /** - * - * @type {CorrelatedGovernanceEventV2024} - * @memberof AccessItemAssociatedV2024 - */ - 'governanceEvent': CorrelatedGovernanceEventV2024 | null; - /** - * the access item type - * @type {string} - * @memberof AccessItemAssociatedV2024 - */ - 'accessItemType'?: AccessItemAssociatedV2024AccessItemTypeV2024; -} - -export const AccessItemAssociatedV2024AccessItemTypeV2024 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemAssociatedV2024AccessItemTypeV2024 = typeof AccessItemAssociatedV2024AccessItemTypeV2024[keyof typeof AccessItemAssociatedV2024AccessItemTypeV2024]; - -/** - * - * @export - * @interface AccessItemDiffV2024 - */ -export interface AccessItemDiffV2024 { - /** - * the id of the access item - * @type {string} - * @memberof AccessItemDiffV2024 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccessItemDiffV2024 - */ - 'eventType'?: AccessItemDiffV2024EventTypeV2024; - /** - * the display name of the access item - * @type {string} - * @memberof AccessItemDiffV2024 - */ - 'displayName'?: string; - /** - * the source name of the access item - * @type {string} - * @memberof AccessItemDiffV2024 - */ - 'sourceName'?: string; -} - -export const AccessItemDiffV2024EventTypeV2024 = { - Add: 'ADD', - Remove: 'REMOVE' -} as const; - -export type AccessItemDiffV2024EventTypeV2024 = typeof AccessItemDiffV2024EventTypeV2024[keyof typeof AccessItemDiffV2024EventTypeV2024]; - -/** - * - * @export - * @interface AccessItemEntitlementResponseV2024 - */ -export interface AccessItemEntitlementResponseV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'sourceName'?: string; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'type': string; - /** - * the description for the entitlment - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'sourceId'?: string; - /** - * indicates whether the entitlement is standalone - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2024 - */ - 'cloudGoverned': boolean | null; -} -/** - * - * @export - * @interface AccessItemRefV2024 - */ -export interface AccessItemRefV2024 { - /** - * ID of the access item to retrieve the recommendation for. - * @type {string} - * @memberof AccessItemRefV2024 - */ - 'id'?: string; - /** - * Access item\'s type. - * @type {string} - * @memberof AccessItemRefV2024 - */ - 'type'?: AccessItemRefV2024TypeV2024; -} - -export const AccessItemRefV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessItemRefV2024TypeV2024 = typeof AccessItemRefV2024TypeV2024[keyof typeof AccessItemRefV2024TypeV2024]; - -/** - * - * @export - * @interface AccessItemRemovedV2024 - */ -export interface AccessItemRemovedV2024 { - /** - * - * @type {AccessItemAssociatedAccessItemV2024} - * @memberof AccessItemRemovedV2024 - */ - 'accessItem': AccessItemAssociatedAccessItemV2024; - /** - * the identity id - * @type {string} - * @memberof AccessItemRemovedV2024 - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessItemRemovedV2024 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemRemovedV2024 - */ - 'dateTime'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessItemRemovedV2024 - */ - 'accessItemType'?: AccessItemRemovedV2024AccessItemTypeV2024; - /** - * - * @type {CorrelatedGovernanceEventV2024} - * @memberof AccessItemRemovedV2024 - */ - 'governanceEvent'?: CorrelatedGovernanceEventV2024 | null; -} - -export const AccessItemRemovedV2024AccessItemTypeV2024 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemRemovedV2024AccessItemTypeV2024 = typeof AccessItemRemovedV2024AccessItemTypeV2024[keyof typeof AccessItemRemovedV2024AccessItemTypeV2024]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForDtoV2024 - */ -export interface AccessItemRequestedForDtoV2024 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2024 - */ - 'type'?: AccessItemRequestedForDtoV2024TypeV2024; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2024 - */ - 'name'?: string; -} - -export const AccessItemRequestedForDtoV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForDtoV2024TypeV2024 = typeof AccessItemRequestedForDtoV2024TypeV2024[keyof typeof AccessItemRequestedForDtoV2024TypeV2024]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForV2024 - */ -export interface AccessItemRequestedForV2024 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2024 - */ - 'type'?: AccessItemRequestedForV2024TypeV2024; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2024 - */ - 'name'?: string; -} - -export const AccessItemRequestedForV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForV2024TypeV2024 = typeof AccessItemRequestedForV2024TypeV2024[keyof typeof AccessItemRequestedForV2024TypeV2024]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterDtoV2024 - */ -export interface AccessItemRequesterDtoV2024 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterDtoV2024 - */ - 'type'?: AccessItemRequesterDtoV2024TypeV2024; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterDtoV2024 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterDtoV2024 - */ - 'name'?: string; -} - -export const AccessItemRequesterDtoV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterDtoV2024TypeV2024 = typeof AccessItemRequesterDtoV2024TypeV2024[keyof typeof AccessItemRequesterDtoV2024TypeV2024]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterV2024 - */ -export interface AccessItemRequesterV2024 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterV2024 - */ - 'type'?: AccessItemRequesterV2024TypeV2024; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterV2024 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterV2024 - */ - 'name'?: string; -} - -export const AccessItemRequesterV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterV2024TypeV2024 = typeof AccessItemRequesterV2024TypeV2024[keyof typeof AccessItemRequesterV2024TypeV2024]; - -/** - * Identity who reviewed the access item request. - * @export - * @interface AccessItemReviewedByV2024 - */ -export interface AccessItemReviewedByV2024 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2024 - */ - 'type'?: AccessItemReviewedByV2024TypeV2024; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2024 - */ - 'name'?: string; -} - -export const AccessItemReviewedByV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemReviewedByV2024TypeV2024 = typeof AccessItemReviewedByV2024TypeV2024[keyof typeof AccessItemReviewedByV2024TypeV2024]; - -/** - * - * @export - * @interface AccessItemRoleResponseV2024 - */ -export interface AccessItemRoleResponseV2024 { - /** - * the access item id - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'id'?: string; - /** - * the access item type. role in this case - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'accessType'?: string; - /** - * the role display name - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'sourceName'?: string | null; - /** - * the description for the role - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'description'?: string; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemRoleResponseV2024 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemRoleResponseV2024 - */ - 'revocable': boolean; -} -/** - * Metadata that describes an access item - * @export - * @interface AccessModelMetadataV2024 - */ -export interface AccessModelMetadataV2024 { - /** - * Unique identifier for the metadata type - * @type {string} - * @memberof AccessModelMetadataV2024 - */ - 'key'?: string; - /** - * Human readable name of the metadata type - * @type {string} - * @memberof AccessModelMetadataV2024 - */ - 'name'?: string; - /** - * Allows selecting multiple values - * @type {boolean} - * @memberof AccessModelMetadataV2024 - */ - 'multiselect'?: boolean; - /** - * The state of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2024 - */ - 'status'?: string; - /** - * The type of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2024 - */ - 'type'?: string; - /** - * The types of objects - * @type {Array} - * @memberof AccessModelMetadataV2024 - */ - 'objectTypes'?: Array; - /** - * Describes the metadata item - * @type {string} - * @memberof AccessModelMetadataV2024 - */ - 'description'?: string; - /** - * The value to assign to the metadata item - * @type {Array} - * @memberof AccessModelMetadataV2024 - */ - 'values'?: Array; -} -/** - * An individual value to assign to the metadata item - * @export - * @interface AccessModelMetadataValuesInnerV2024 - */ -export interface AccessModelMetadataValuesInnerV2024 { - /** - * The value to assign to the metdata item - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2024 - */ - 'value'?: string; - /** - * Display name of the value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2024 - */ - 'name'?: string; - /** - * The status of the individual value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2024 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AccessProfileApprovalSchemeV2024 - */ -export interface AccessProfileApprovalSchemeV2024 { - /** - * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof AccessProfileApprovalSchemeV2024 - */ - 'approverType'?: AccessProfileApprovalSchemeV2024ApproverTypeV2024; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof AccessProfileApprovalSchemeV2024 - */ - 'approverId'?: string | null; -} - -export const AccessProfileApprovalSchemeV2024ApproverTypeV2024 = { - AppOwner: 'APP_OWNER', - Owner: 'OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type AccessProfileApprovalSchemeV2024ApproverTypeV2024 = typeof AccessProfileApprovalSchemeV2024ApproverTypeV2024[keyof typeof AccessProfileApprovalSchemeV2024ApproverTypeV2024]; - -/** - * - * @export - * @interface AccessProfileBulkDeleteRequestV2024 - */ -export interface AccessProfileBulkDeleteRequestV2024 { - /** - * List of IDs of Access Profiles to be deleted. - * @type {Array} - * @memberof AccessProfileBulkDeleteRequestV2024 - */ - 'accessProfileIds'?: Array; - /** - * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - * @type {boolean} - * @memberof AccessProfileBulkDeleteRequestV2024 - */ - 'bestEffortOnly'?: boolean; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteResponseV2024 - */ -export interface AccessProfileBulkDeleteResponseV2024 { - /** - * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. - * @type {string} - * @memberof AccessProfileBulkDeleteResponseV2024 - */ - 'taskId'?: string; - /** - * List of IDs of Access Profiles which are pending deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2024 - */ - 'pending'?: Array; - /** - * List of usages of Access Profiles targeted for deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2024 - */ - 'inUse'?: Array; -} -/** - * Access Profile\'s basic details. - * @export - * @interface AccessProfileBulkUpdateRequestInnerV2024 - */ -export interface AccessProfileBulkUpdateRequestInnerV2024 { - /** - * Access Profile ID. - * @type {string} - * @memberof AccessProfileBulkUpdateRequestInnerV2024 - */ - 'id'?: string; - /** - * Access Profile is requestable or not. - * @type {boolean} - * @memberof AccessProfileBulkUpdateRequestInnerV2024 - */ - 'requestable'?: boolean; -} -/** - * How to select account when there are multiple accounts for the user - * @export - * @interface AccessProfileDetailsAccountSelectorV2024 - */ -export interface AccessProfileDetailsAccountSelectorV2024 { - /** - * - * @type {Array} - * @memberof AccessProfileDetailsAccountSelectorV2024 - */ - 'selectors'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileDetailsV2024 - */ -export interface AccessProfileDetailsV2024 { - /** - * The ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'description'?: string | null; - /** - * Date the Access Profile was created - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'modified'?: string; - /** - * Whether the Access Profile is enabled. - * @type {boolean} - * @memberof AccessProfileDetailsV2024 - */ - 'disabled'?: boolean; - /** - * Whether the Access Profile is requestable via access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2024 - */ - 'requestable'?: boolean; - /** - * Whether the Access Profile is protected. - * @type {boolean} - * @memberof AccessProfileDetailsV2024 - */ - 'protected'?: boolean; - /** - * The owner ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'ownerId'?: string; - /** - * The source ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2024 - */ - 'sourceId'?: number | null; - /** - * The source name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'sourceName'?: string; - /** - * The source app ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2024 - */ - 'appId'?: number | null; - /** - * The source app name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'appName'?: string | null; - /** - * The id of the application - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'applicationId'?: string; - /** - * The type of the access profile - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'type'?: string; - /** - * List of IDs of entitlements - * @type {Array} - * @memberof AccessProfileDetailsV2024 - */ - 'entitlements'?: Array; - /** - * The number of entitlements in the access profile - * @type {number} - * @memberof AccessProfileDetailsV2024 - */ - 'entitlementCount'?: number; - /** - * List of IDs of segments, if any, to which this Access Profile is assigned. - * @type {Array} - * @memberof AccessProfileDetailsV2024 - */ - 'segments'?: Array; - /** - * Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'approvalSchemes'?: string; - /** - * Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2024 - */ - 'revokeRequestApprovalSchemes'?: string; - /** - * Whether the access profile require request comment for access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * Whether denied comment is required when access request is denied. - * @type {boolean} - * @memberof AccessProfileDetailsV2024 - */ - 'deniedCommentsRequired'?: boolean; - /** - * - * @type {AccessProfileDetailsAccountSelectorV2024} - * @memberof AccessProfileDetailsV2024 - */ - 'accountSelector'?: AccessProfileDetailsAccountSelectorV2024; -} -/** - * Access profile\'s source. - * @export - * @interface AccessProfileDocumentAllOfSourceV2024 - */ -export interface AccessProfileDocumentAllOfSourceV2024 { - /** - * Source\'s ID. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2024 - */ - 'id'?: string; - /** - * Source\'s name. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2024 - */ - 'name'?: string; -} -/** - * More complete representation of an access profile. - * @export - * @interface AccessProfileDocumentV2024 - */ -export interface AccessProfileDocumentV2024 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentV2024 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2024} - * @memberof AccessProfileDocumentV2024 - */ - 'owner'?: BaseAccessOwnerV2024; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentV2024 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2024} - * @memberof AccessProfileDocumentV2024 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2024; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentV2024 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentV2024 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentV2024 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentV2024 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentV2024 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentV2024 - */ - 'apps'?: Array; -} -/** - * - * @export - * @interface AccessProfileDocumentsV2024 - */ -export interface AccessProfileDocumentsV2024 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentsV2024 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentsV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentsV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2024} - * @memberof AccessProfileDocumentsV2024 - */ - 'owner'?: BaseAccessOwnerV2024; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2024} - * @memberof AccessProfileDocumentsV2024 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2024; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentsV2024 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentsV2024 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentsV2024 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentsV2024 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentsV2024 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentsV2024 - */ - 'apps'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof AccessProfileDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof AccessProfileDocumentsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof AccessProfileDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * EntitlementReference - * @export - * @interface AccessProfileEntitlementV2024 - */ -export interface AccessProfileEntitlementV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2024} - * @memberof AccessProfileEntitlementV2024 - */ - 'source'?: Reference1V2024; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2024 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2024 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2024 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface AccessProfileRefV2024 - */ -export interface AccessProfileRefV2024 { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfileRefV2024 - */ - 'id'?: string; - /** - * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof AccessProfileRefV2024 - */ - 'type'?: AccessProfileRefV2024TypeV2024; - /** - * Human-readable display name of the Access Profile. This field is ignored on input. - * @type {string} - * @memberof AccessProfileRefV2024 - */ - 'name'?: string; -} - -export const AccessProfileRefV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE' -} as const; - -export type AccessProfileRefV2024TypeV2024 = typeof AccessProfileRefV2024TypeV2024[keyof typeof AccessProfileRefV2024TypeV2024]; - -/** - * Role - * @export - * @interface AccessProfileRoleV2024 - */ -export interface AccessProfileRoleV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileRoleV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileRoleV2024 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileRoleV2024 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2024} - * @memberof AccessProfileRoleV2024 - */ - 'owner'?: DisplayReferenceV2024; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2024 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2024 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileSourceRefV2024 - */ -export interface AccessProfileSourceRefV2024 { - /** - * ID of the source the access profile is associated with. - * @type {string} - * @memberof AccessProfileSourceRefV2024 - */ - 'id'?: string; - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccessProfileSourceRefV2024 - */ - 'type'?: AccessProfileSourceRefV2024TypeV2024; - /** - * Source name. - * @type {string} - * @memberof AccessProfileSourceRefV2024 - */ - 'name'?: string; -} - -export const AccessProfileSourceRefV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccessProfileSourceRefV2024TypeV2024 = typeof AccessProfileSourceRefV2024TypeV2024[keyof typeof AccessProfileSourceRefV2024TypeV2024]; - -/** - * This is a summary representation of an access profile. - * @export - * @interface AccessProfileSummaryV2024 - */ -export interface AccessProfileSummaryV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileSummaryV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileSummaryV2024 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileSummaryV2024 - */ - 'type'?: string; - /** - * - * @type {Reference1V2024} - * @memberof AccessProfileSummaryV2024 - */ - 'source'?: Reference1V2024; - /** - * - * @type {DisplayReferenceV2024} - * @memberof AccessProfileSummaryV2024 - */ - 'owner'?: DisplayReferenceV2024; - /** - * - * @type {boolean} - * @memberof AccessProfileSummaryV2024 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileUpdateItemV2024 - */ -export interface AccessProfileUpdateItemV2024 { - /** - * Identifier of Access Profile in bulk update request. - * @type {string} - * @memberof AccessProfileUpdateItemV2024 - */ - 'id': string; - /** - * Access Profile requestable or not. - * @type {boolean} - * @memberof AccessProfileUpdateItemV2024 - */ - 'requestable': boolean; - /** - * The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. - * @type {string} - * @memberof AccessProfileUpdateItemV2024 - */ - 'status': string; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof AccessProfileUpdateItemV2024 - */ - 'description'?: string; -} -/** - * Role using the access profile. - * @export - * @interface AccessProfileUsageUsedByInnerV2024 - */ -export interface AccessProfileUsageUsedByInnerV2024 { - /** - * DTO type of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2024 - */ - 'type'?: AccessProfileUsageUsedByInnerV2024TypeV2024; - /** - * ID of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2024 - */ - 'id'?: string; - /** - * Display name of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2024 - */ - 'name'?: string; -} - -export const AccessProfileUsageUsedByInnerV2024TypeV2024 = { - Role: 'ROLE' -} as const; - -export type AccessProfileUsageUsedByInnerV2024TypeV2024 = typeof AccessProfileUsageUsedByInnerV2024TypeV2024[keyof typeof AccessProfileUsageUsedByInnerV2024TypeV2024]; - -/** - * - * @export - * @interface AccessProfileUsageV2024 - */ -export interface AccessProfileUsageV2024 { - /** - * ID of the Access Profile that is in use - * @type {string} - * @memberof AccessProfileUsageV2024 - */ - 'accessProfileId'?: string; - /** - * List of references to objects which are using the indicated Access Profile - * @type {Array} - * @memberof AccessProfileUsageV2024 - */ - 'usedBy'?: Array; -} -/** - * Access profile. - * @export - * @interface AccessProfileV2024 - */ -export interface AccessProfileV2024 { - /** - * Access profile ID. - * @type {string} - * @memberof AccessProfileV2024 - */ - 'id'?: string; - /** - * Access profile name. - * @type {string} - * @memberof AccessProfileV2024 - */ - 'name': string; - /** - * Access profile description. - * @type {string} - * @memberof AccessProfileV2024 - */ - 'description'?: string | null; - /** - * Date and time when the access profile was created. - * @type {string} - * @memberof AccessProfileV2024 - */ - 'created'?: string; - /** - * Date and time when the access profile was last modified. - * @type {string} - * @memberof AccessProfileV2024 - */ - 'modified'?: string; - /** - * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. - * @type {boolean} - * @memberof AccessProfileV2024 - */ - 'enabled'?: boolean; - /** - * - * @type {OwnerReferenceV2024} - * @memberof AccessProfileV2024 - */ - 'owner': OwnerReferenceV2024 | null; - /** - * - * @type {AccessProfileSourceRefV2024} - * @memberof AccessProfileV2024 - */ - 'source': AccessProfileSourceRefV2024; - /** - * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. - * @type {Array} - * @memberof AccessProfileV2024 - */ - 'entitlements'?: Array | null; - /** - * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. - * @type {boolean} - * @memberof AccessProfileV2024 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityV2024} - * @memberof AccessProfileV2024 - */ - 'accessRequestConfig'?: RequestabilityV2024 | null; - /** - * - * @type {RevocabilityV2024} - * @memberof AccessProfileV2024 - */ - 'revocationRequestConfig'?: RevocabilityV2024 | null; - /** - * List of segment IDs, if any, that the access profile is assigned to. - * @type {Array} - * @memberof AccessProfileV2024 - */ - 'segments'?: Array | null; - /** - * - * @type {AttributeDTOListV2024} - * @memberof AccessProfileV2024 - */ - 'accessModelMetadata'?: AttributeDTOListV2024; - /** - * - * @type {ProvisioningCriteriaLevel1V2024} - * @memberof AccessProfileV2024 - */ - 'provisioningCriteria'?: ProvisioningCriteriaLevel1V2024 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof AccessProfileV2024 - */ - 'additionalOwners'?: Array | null; -} -/** - * - * @export - * @interface AccessRecommendationMessageV2024 - */ -export interface AccessRecommendationMessageV2024 { - /** - * Information about why the access item was recommended. - * @type {string} - * @memberof AccessRecommendationMessageV2024 - */ - 'interpretation'?: string; -} -/** - * - * @export - * @interface AccessRequestAdminItemStatusV2024 - */ -export interface AccessRequestAdminItemStatusV2024 { - /** - * ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'type'?: AccessRequestAdminItemStatusV2024TypeV2024 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2024; - /** - * List of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'state'?: RequestedItemStatusRequestStateV2024; - /** - * Approval details for each item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'approvalDetails'?: Array; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'requester'?: AccessItemRequesterV2024; - /** - * - * @type {RequestedItemStatusRequestedForV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2024; - /** - * - * @type {RequestedItemStatusRequesterCommentV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2024; - /** - * - * @type {RequestedItemStatusSodViolationContextV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2024; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2024; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2024} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2024; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'cancelable'?: boolean; - /** - * True if re-auth is required. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'reauthorizationRequired'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccessRequestAdminItemStatusV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - -export const AccessRequestAdminItemStatusV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestAdminItemStatusV2024TypeV2024 = typeof AccessRequestAdminItemStatusV2024TypeV2024[keyof typeof AccessRequestAdminItemStatusV2024TypeV2024]; - -/** - * - * @export - * @interface AccessRequestApproversListResponseV2024 - */ -export interface AccessRequestApproversListResponseV2024 { - /** - * Approver id. - * @type {string} - * @memberof AccessRequestApproversListResponseV2024 - */ - 'id'?: string; - /** - * Email of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2024 - */ - 'email'?: string; - /** - * Name of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2024 - */ - 'name'?: string; - /** - * Id of the approval item. - * @type {string} - * @memberof AccessRequestApproversListResponseV2024 - */ - 'approvalId'?: string; - /** - * Type of the object returned. In this case, the value for this field will always Identity. - * @type {string} - * @memberof AccessRequestApproversListResponseV2024 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccessRequestConfigV2024 - */ -export interface AccessRequestConfigV2024 { - /** - * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. - * @type {boolean} - * @memberof AccessRequestConfigV2024 - */ - 'approvalsMustBeExternal'?: boolean; - /** - * If this is true and the requester and reviewer are the same, the request is automatically approved. - * @type {boolean} - * @memberof AccessRequestConfigV2024 - */ - 'autoApprovalEnabled'?: boolean; - /** - * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - * @type {boolean} - * @memberof AccessRequestConfigV2024 - */ - 'reauthorizationEnabled'?: boolean; - /** - * - * @type {RequestOnBehalfOfConfigV2024} - * @memberof AccessRequestConfigV2024 - */ - 'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfigV2024; - /** - * - * @type {ApprovalReminderAndEscalationConfigV2024} - * @memberof AccessRequestConfigV2024 - */ - 'approvalReminderAndEscalationConfig'?: ApprovalReminderAndEscalationConfigV2024; - /** - * - * @type {EntitlementRequestConfigV2024} - * @memberof AccessRequestConfigV2024 - */ - 'entitlementRequestConfig'?: EntitlementRequestConfigV2024; -} -/** - * - * @export - * @interface AccessRequestContextV2024 - */ -export interface AccessRequestContextV2024 { - /** - * - * @type {Array} - * @memberof AccessRequestContextV2024 - */ - 'contextAttributes'?: Array; -} -/** - * - * @export - * @interface AccessRequestDynamicApprover1V2024 - */ -export interface AccessRequestDynamicApprover1V2024 { - /** - * The unique ID of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2024 - */ - 'id': string; - /** - * The name of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2024 - */ - 'name': string; - /** - * The type of object being referenced. - * @type {object} - * @memberof AccessRequestDynamicApprover1V2024 - */ - 'type': AccessRequestDynamicApprover1V2024TypeV2024; -} - -export const AccessRequestDynamicApprover1V2024TypeV2024 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AccessRequestDynamicApprover1V2024TypeV2024 = typeof AccessRequestDynamicApprover1V2024TypeV2024[keyof typeof AccessRequestDynamicApprover1V2024TypeV2024]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ -export interface AccessRequestDynamicApproverRequestedItemsInnerV2024 { - /** - * The unique ID of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'id': string; - /** - * Human friendly name of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'name': string; - /** - * Extended description of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'description'?: string | null; - /** - * The type of access item being requested. - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'type': AccessRequestDynamicApproverRequestedItemsInnerV2024TypeV2024; - /** - * Grant or revoke the access item - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'operation': AccessRequestDynamicApproverRequestedItemsInnerV2024OperationV2024; - /** - * A comment from the requestor on why the access is needed. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2024 - */ - 'comment'?: string | null; -} - -export const AccessRequestDynamicApproverRequestedItemsInnerV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2024TypeV2024 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2024TypeV2024[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2024TypeV2024]; -export const AccessRequestDynamicApproverRequestedItemsInnerV2024OperationV2024 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2024OperationV2024 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2024OperationV2024[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2024OperationV2024]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverV2024 - */ -export interface AccessRequestDynamicApproverV2024 { - /** - * The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. - * @type {string} - * @memberof AccessRequestDynamicApproverV2024 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2024 - */ - 'requestedFor': Array; - /** - * The access items that are being requested. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2024 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2024} - * @memberof AccessRequestDynamicApproverV2024 - */ - 'requestedBy': AccessItemRequesterDtoV2024; -} -/** - * - * @export - * @interface AccessRequestItemV2024 - */ -export interface AccessRequestItemV2024 { - /** - * The type of the item being requested. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'type': AccessRequestItemV2024TypeV2024; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestItemV2024 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'removeDate'?: string; - /** - * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'assignmentId'?: string | null; - /** - * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2024 - */ - 'nativeIdentity'?: string | null; -} - -export const AccessRequestItemV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestItemV2024TypeV2024 = typeof AccessRequestItemV2024TypeV2024[keyof typeof AccessRequestItemV2024TypeV2024]; - -/** - * Provides additional details about this access request phase. - * @export - * @interface AccessRequestPhasesV2024 - */ -export interface AccessRequestPhasesV2024 { - /** - * The time that this phase started. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'started'?: string; - /** - * The time that this phase finished. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'finished'?: string | null; - /** - * The name of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'name'?: string; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'state'?: AccessRequestPhasesV2024StateV2024; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'result'?: AccessRequestPhasesV2024ResultV2024 | null; - /** - * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - * @type {string} - * @memberof AccessRequestPhasesV2024 - */ - 'phaseReference'?: string | null; -} - -export const AccessRequestPhasesV2024StateV2024 = { - Pending: 'PENDING', - Executing: 'EXECUTING', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - NotExecuted: 'NOT_EXECUTED' -} as const; - -export type AccessRequestPhasesV2024StateV2024 = typeof AccessRequestPhasesV2024StateV2024[keyof typeof AccessRequestPhasesV2024StateV2024]; -export const AccessRequestPhasesV2024ResultV2024 = { - Successful: 'SUCCESSFUL', - Failed: 'FAILED' -} as const; - -export type AccessRequestPhasesV2024ResultV2024 = typeof AccessRequestPhasesV2024ResultV2024[keyof typeof AccessRequestPhasesV2024ResultV2024]; - -/** - * The identity of the approver. - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024 { - /** - * The type of object that is referenced - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024TypeV2024; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024 - */ - 'id': string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024 - */ - 'name': string; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024TypeV2024 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024TypeV2024[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024TypeV2024]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 { - /** - * A comment left by the approver. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 - */ - 'approvalComment'?: string | null; - /** - * The final decision of the approver. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 - */ - 'approvalDecision': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024ApprovalDecisionV2024; - /** - * The name of the approver - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 - */ - 'approverName': string; - /** - * - * @type {AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024 - */ - 'approver': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2024; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024ApprovalDecisionV2024 = { - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024ApprovalDecisionV2024 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024ApprovalDecisionV2024[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2024ApprovalDecisionV2024]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerV2024 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerV2024TypeV2024; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'operation': AccessRequestPostApprovalRequestedItemsStatusInnerV2024OperationV2024; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'comment'?: string | null; - /** - * Additional customer defined metadata about the access item. - * @type {{ [key: string]: any; }} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'clientMetadata'?: { [key: string]: any; } | null; - /** - * A list of one or more approvers for the access request. - * @type {Array} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2024 - */ - 'approvalInfo': Array; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2024TypeV2024 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2024TypeV2024[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2024TypeV2024]; -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2024OperationV2024 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2024OperationV2024 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2024OperationV2024[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2024OperationV2024]; - -/** - * - * @export - * @interface AccessRequestPostApprovalV2024 - */ -export interface AccessRequestPostApprovalV2024 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPostApprovalV2024 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPostApprovalV2024 - */ - 'requestedFor': Array; - /** - * Details on the outcome of each access item. - * @type {Array} - * @memberof AccessRequestPostApprovalV2024 - */ - 'requestedItemsStatus': Array; - /** - * - * @type {AccessItemRequesterDtoV2024} - * @memberof AccessRequestPostApprovalV2024 - */ - 'requestedBy': AccessItemRequesterDtoV2024; -} -/** - * - * @export - * @interface AccessRequestPreApproval1V2024 - */ -export interface AccessRequestPreApproval1V2024 { - /** - * Whether or not to approve the access request. - * @type {boolean} - * @memberof AccessRequestPreApproval1V2024 - */ - 'approved': boolean; - /** - * A comment about the decision to approve or deny the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2024 - */ - 'comment': string; - /** - * The name of the entity that approved or denied the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2024 - */ - 'approver': string; -} -/** - * - * @export - * @interface AccessRequestPreApprovalRequestedItemsInnerV2024 - */ -export interface AccessRequestPreApprovalRequestedItemsInnerV2024 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'type': AccessRequestPreApprovalRequestedItemsInnerV2024TypeV2024; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'operation': AccessRequestPreApprovalRequestedItemsInnerV2024OperationV2024; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2024 - */ - 'comment'?: string | null; -} - -export const AccessRequestPreApprovalRequestedItemsInnerV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2024TypeV2024 = typeof AccessRequestPreApprovalRequestedItemsInnerV2024TypeV2024[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2024TypeV2024]; -export const AccessRequestPreApprovalRequestedItemsInnerV2024OperationV2024 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2024OperationV2024 = typeof AccessRequestPreApprovalRequestedItemsInnerV2024OperationV2024[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2024OperationV2024]; - -/** - * - * @export - * @interface AccessRequestPreApprovalV2024 - */ -export interface AccessRequestPreApprovalV2024 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPreApprovalV2024 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPreApprovalV2024 - */ - 'requestedFor': Array; - /** - * Details of the access items being requested. - * @type {Array} - * @memberof AccessRequestPreApprovalV2024 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2024} - * @memberof AccessRequestPreApprovalV2024 - */ - 'requestedBy': AccessItemRequesterDtoV2024; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemDtoV2024 - */ -export interface AccessRequestRecommendationActionItemDtoV2024 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemDtoV2024 - */ - 'identityId': string; - /** - * - * @type {AccessRequestRecommendationItemV2024} - * @memberof AccessRequestRecommendationActionItemDtoV2024 - */ - 'access': AccessRequestRecommendationItemV2024; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemResponseDtoV2024 - */ -export interface AccessRequestRecommendationActionItemResponseDtoV2024 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2024 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemV2024} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2024 - */ - 'access'?: AccessRequestRecommendationItemV2024; - /** - * - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2024 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface AccessRequestRecommendationConfigDtoV2024 - */ -export interface AccessRequestRecommendationConfigDtoV2024 { - /** - * The value that internal calculations need to exceed for recommendations to be made. - * @type {number} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'scoreThreshold': number; - /** - * Use to map an attribute name for determining identities\' start date. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'startDateAttribute'?: string; - /** - * Use to only give recommendations based on this attribute. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'restrictionAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are movers. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'moverAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are joiners. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'joinerAttribute'?: string; - /** - * Use only the attribute named in restrictionAttribute to make recommendations. - * @type {boolean} - * @memberof AccessRequestRecommendationConfigDtoV2024 - */ - 'useRestrictionAttribute'?: boolean; -} -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailAccessV2024 - */ -export interface AccessRequestRecommendationItemDetailAccessV2024 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2024 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2024} - * @memberof AccessRequestRecommendationItemDetailAccessV2024 - */ - 'type'?: AccessRequestRecommendationItemTypeV2024; - /** - * Name of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2024 - */ - 'name'?: string; - /** - * Description of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2024 - */ - 'description'?: string; -} - - -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailV2024 - */ -export interface AccessRequestRecommendationItemDetailV2024 { - /** - * Identity ID for the recommendation - * @type {string} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemDetailAccessV2024} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'access'?: AccessRequestRecommendationItemDetailAccessV2024; - /** - * Whether or not the identity has already chosen to ignore this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'ignored'?: boolean; - /** - * Whether or not the identity has already chosen to request this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'requested'?: boolean; - /** - * Whether or not the identity reportedly viewed this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'viewed'?: boolean; - /** - * - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'messages'?: Array; - /** - * The list of translation messages - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2024 - */ - 'translationMessages'?: Array; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const AccessRequestRecommendationItemTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessRequestRecommendationItemTypeV2024 = typeof AccessRequestRecommendationItemTypeV2024[keyof typeof AccessRequestRecommendationItemTypeV2024]; - - -/** - * - * @export - * @interface AccessRequestRecommendationItemV2024 - */ -export interface AccessRequestRecommendationItemV2024 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemV2024 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2024} - * @memberof AccessRequestRecommendationItemV2024 - */ - 'type'?: AccessRequestRecommendationItemTypeV2024; -} - - -/** - * - * @export - * @interface AccessRequestResponseV2024 - */ -export interface AccessRequestResponseV2024 { - /** - * A list of new access request tracking data mapped to the values requested. - * @type {Array} - * @memberof AccessRequestResponseV2024 - */ - 'newRequests'?: Array; - /** - * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - * @type {Array} - * @memberof AccessRequestResponseV2024 - */ - 'existingRequests'?: Array; -} -/** - * - * @export - * @interface AccessRequestTrackingV2024 - */ -export interface AccessRequestTrackingV2024 { - /** - * The identity id in which the access request is for. - * @type {string} - * @memberof AccessRequestTrackingV2024 - */ - 'requestedFor'?: string; - /** - * The details of the item requested. - * @type {Array} - * @memberof AccessRequestTrackingV2024 - */ - 'requestedItemsDetails'?: Array; - /** - * a hash representation of the access requested, useful for longer term tracking client side. - * @type {number} - * @memberof AccessRequestTrackingV2024 - */ - 'attributesHash'?: number; - /** - * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - * @type {Array} - * @memberof AccessRequestTrackingV2024 - */ - 'accessRequestIds'?: Array; -} -/** - * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. - * @export - * @enum {string} - */ - -export const AccessRequestTypeV2024 = { - GrantAccess: 'GRANT_ACCESS', - RevokeAccess: 'REVOKE_ACCESS', - ModifyAccess: 'MODIFY_ACCESS' -} as const; - -export type AccessRequestTypeV2024 = typeof AccessRequestTypeV2024[keyof typeof AccessRequestTypeV2024]; - - -/** - * - * @export - * @interface AccessRequestV2024 - */ -export interface AccessRequestV2024 { - /** - * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. - * @type {Array} - * @memberof AccessRequestV2024 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof AccessRequestV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * - * @type {Array} - * @memberof AccessRequestV2024 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestV2024 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests - * @type {Array} - * @memberof AccessRequestV2024 - */ - 'requestedForWithRequestedItems'?: Array | null; -} - - -/** - * - * @export - * @interface AccessRequestedAccountV2024 - */ -export interface AccessRequestedAccountV2024 { - /** - * the ID of the account in the database - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'id'?: string; - /** - * the native identifier of the account - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'nativeIdentity'?: string; - /** - * the display name of the account - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'displayName'?: string; - /** - * the ID of the source for this account - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'sourceId'?: string; - /** - * the name of the source for this account - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'sourceName'?: string; - /** - * the number of entitlements on this account - * @type {number} - * @memberof AccessRequestedAccountV2024 - */ - 'entitlementCount'?: number; - /** - * this value is always \"account\" - * @type {string} - * @memberof AccessRequestedAccountV2024 - */ - 'accessType'?: string; -} -/** - * - * @export - * @interface AccessRequestedStatusChangeV2024 - */ -export interface AccessRequestedStatusChangeV2024 { - /** - * the previous status of the account - * @type {string} - * @memberof AccessRequestedStatusChangeV2024 - */ - 'previousStatus'?: AccessRequestedStatusChangeV2024PreviousStatusV2024; - /** - * the new status of the account - * @type {string} - * @memberof AccessRequestedStatusChangeV2024 - */ - 'newStatus'?: AccessRequestedStatusChangeV2024NewStatusV2024; -} - -export const AccessRequestedStatusChangeV2024PreviousStatusV2024 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccessRequestedStatusChangeV2024PreviousStatusV2024 = typeof AccessRequestedStatusChangeV2024PreviousStatusV2024[keyof typeof AccessRequestedStatusChangeV2024PreviousStatusV2024]; -export const AccessRequestedStatusChangeV2024NewStatusV2024 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccessRequestedStatusChangeV2024NewStatusV2024 = typeof AccessRequestedStatusChangeV2024NewStatusV2024[keyof typeof AccessRequestedStatusChangeV2024NewStatusV2024]; - -/** - * - * @export - * @interface AccessRequestedV2024 - */ -export interface AccessRequestedV2024 { - /** - * the event type - * @type {string} - * @memberof AccessRequestedV2024 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AccessRequestedV2024 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessRequestedV2024 - */ - 'dateTime'?: string; - /** - * - * @type {AccessRequestedAccountV2024} - * @memberof AccessRequestedV2024 - */ - 'account': AccessRequestedAccountV2024; - /** - * - * @type {AccessRequestedStatusChangeV2024} - * @memberof AccessRequestedV2024 - */ - 'statusChange': AccessRequestedStatusChangeV2024; -} -/** - * - * @export - * @interface AccessReviewItemV2024 - */ -export interface AccessReviewItemV2024 { - /** - * - * @type {AccessSummaryV2024} - * @memberof AccessReviewItemV2024 - */ - 'accessSummary'?: AccessSummaryV2024; - /** - * - * @type {CertificationIdentitySummaryV2024} - * @memberof AccessReviewItemV2024 - */ - 'identitySummary'?: CertificationIdentitySummaryV2024; - /** - * The review item\'s id - * @type {string} - * @memberof AccessReviewItemV2024 - */ - 'id'?: string; - /** - * Whether the review item is complete - * @type {boolean} - * @memberof AccessReviewItemV2024 - */ - 'completed'?: boolean; - /** - * Indicates whether the review item is for new access to a source - * @type {boolean} - * @memberof AccessReviewItemV2024 - */ - 'newAccess'?: boolean; - /** - * - * @type {CertificationDecisionV2024} - * @memberof AccessReviewItemV2024 - */ - 'decision'?: CertificationDecisionV2024; - /** - * Comments for this review item - * @type {string} - * @memberof AccessReviewItemV2024 - */ - 'comments'?: string | null; -} - - -/** - * - * @export - * @interface AccessReviewReassignmentV2024 - */ -export interface AccessReviewReassignmentV2024 { - /** - * - * @type {Array} - * @memberof AccessReviewReassignmentV2024 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof AccessReviewReassignmentV2024 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof AccessReviewReassignmentV2024 - */ - 'reason': string; -} -/** - * - * @export - * @interface AccessSummaryAccessV2024 - */ -export interface AccessSummaryAccessV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof AccessSummaryAccessV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The ID of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2024 - */ - 'id'?: string; - /** - * The name of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2024 - */ - 'name'?: string; -} - - -/** - * An object holding the access that is being reviewed - * @export - * @interface AccessSummaryV2024 - */ -export interface AccessSummaryV2024 { - /** - * - * @type {AccessSummaryAccessV2024} - * @memberof AccessSummaryV2024 - */ - 'access'?: AccessSummaryAccessV2024; - /** - * - * @type {ReviewableEntitlementV2024} - * @memberof AccessSummaryV2024 - */ - 'entitlement'?: ReviewableEntitlementV2024 | null; - /** - * - * @type {ReviewableAccessProfileV2024} - * @memberof AccessSummaryV2024 - */ - 'accessProfile'?: ReviewableAccessProfileV2024; - /** - * - * @type {ReviewableRoleV2024} - * @memberof AccessSummaryV2024 - */ - 'role'?: ReviewableRoleV2024 | null; -} -/** - * Access type of API Client indicating online or offline use - * @export - * @enum {string} - */ - -export const AccessTypeV2024 = { - Online: 'ONLINE', - Offline: 'OFFLINE' -} as const; - -export type AccessTypeV2024 = typeof AccessTypeV2024[keyof typeof AccessTypeV2024]; - - -/** - * - * @export - * @interface AccessV2024 - */ -export interface AccessV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessV2024 - */ - 'description'?: string | null; -} -/** - * Object for specifying Actions to be performed on a specified list of sources\' account. - * @export - * @interface AccountActionV2024 - */ -export interface AccountActionV2024 { - /** - * Describes if action will be enable, disable or delete. - * @type {string} - * @memberof AccountActionV2024 - */ - 'action'?: AccountActionV2024ActionV2024; - /** - * List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. - * @type {Set} - * @memberof AccountActionV2024 - */ - 'sourceIds'?: Set; -} - -export const AccountActionV2024ActionV2024 = { - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE' -} as const; - -export type AccountActionV2024ActionV2024 = typeof AccountActionV2024ActionV2024[keyof typeof AccountActionV2024ActionV2024]; - -/** - * The state of an approval status - * @export - * @enum {string} - */ - -export const AccountActivityApprovalStatusV2024 = { - Finished: 'FINISHED', - Rejected: 'REJECTED', - Returned: 'RETURNED', - Expired: 'EXPIRED', - Pending: 'PENDING', - Canceled: 'CANCELED' -} as const; - -export type AccountActivityApprovalStatusV2024 = typeof AccountActivityApprovalStatusV2024[keyof typeof AccountActivityApprovalStatusV2024]; - - -/** - * AccountActivity - * @export - * @interface AccountActivityDocumentV2024 - */ -export interface AccountActivityDocumentV2024 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivityDocumentV2024 - */ - 'requester'?: ActivityIdentityV2024; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivityDocumentV2024 - */ - 'recipient'?: ActivityIdentityV2024; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentV2024 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentV2024 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityDocumentsV2024 - */ -export interface AccountActivityDocumentsV2024 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivityDocumentsV2024 - */ - 'requester'?: ActivityIdentityV2024; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivityDocumentsV2024 - */ - 'recipient'?: ActivityIdentityV2024; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentsV2024 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'sources'?: string; - /** - * Name of the pod. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof AccountActivityDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof AccountActivityDocumentsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof AccountActivityDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * Represents an operation in an account activity item - * @export - * @enum {string} - */ - -export const AccountActivityItemOperationV2024 = { - Add: 'ADD', - Create: 'CREATE', - Modify: 'MODIFY', - Delete: 'DELETE', - Disable: 'DISABLE', - Enable: 'ENABLE', - Unlock: 'UNLOCK', - Lock: 'LOCK', - Remove: 'REMOVE', - Set: 'SET' -} as const; - -export type AccountActivityItemOperationV2024 = typeof AccountActivityItemOperationV2024[keyof typeof AccountActivityItemOperationV2024]; - - -/** - * - * @export - * @interface AccountActivityItemV2024 - */ -export interface AccountActivityItemV2024 { - /** - * Item id - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'id'?: string; - /** - * Human-readable display name of item - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'name'?: string; - /** - * Date and time item was requested - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'requested'?: string; - /** - * - * @type {AccountActivityApprovalStatusV2024} - * @memberof AccountActivityItemV2024 - */ - 'approvalStatus'?: AccountActivityApprovalStatusV2024 | null; - /** - * - * @type {ProvisioningStateV2024} - * @memberof AccountActivityItemV2024 - */ - 'provisioningStatus'?: ProvisioningStateV2024; - /** - * - * @type {CommentV2024} - * @memberof AccountActivityItemV2024 - */ - 'requesterComment'?: CommentV2024 | null; - /** - * - * @type {IdentitySummaryV2024} - * @memberof AccountActivityItemV2024 - */ - 'reviewerIdentitySummary'?: IdentitySummaryV2024 | null; - /** - * - * @type {CommentV2024} - * @memberof AccountActivityItemV2024 - */ - 'reviewerComment'?: CommentV2024 | null; - /** - * - * @type {AccountActivityItemOperationV2024} - * @memberof AccountActivityItemV2024 - */ - 'operation'?: AccountActivityItemOperationV2024 | null; - /** - * Attribute to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'attribute'?: string | null; - /** - * Value of attribute - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'value'?: string | null; - /** - * Native identity in the target system to which the account activity applies - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'nativeIdentity'?: string | null; - /** - * Id of Source to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'sourceId'?: string; - /** - * - * @type {AccountRequestInfoV2024} - * @memberof AccountActivityItemV2024 - */ - 'accountRequestInfo'?: AccountRequestInfoV2024 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof AccountActivityItemV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof AccountActivityItemV2024 - */ - 'removeDate'?: string | null; -} - - -/** - * AccountActivity - * @export - * @interface AccountActivitySearchedItemV2024 - */ -export interface AccountActivitySearchedItemV2024 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivitySearchedItemV2024 - */ - 'requester'?: ActivityIdentityV2024; - /** - * - * @type {ActivityIdentityV2024} - * @memberof AccountActivitySearchedItemV2024 - */ - 'recipient'?: ActivityIdentityV2024; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivitySearchedItemV2024 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2024 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityV2024 - */ -export interface AccountActivityV2024 { - /** - * Id of the account activity - * @type {string} - * @memberof AccountActivityV2024 - */ - 'id'?: string; - /** - * The name of the activity - * @type {string} - * @memberof AccountActivityV2024 - */ - 'name'?: string; - /** - * When the activity was first created - * @type {string} - * @memberof AccountActivityV2024 - */ - 'created'?: string; - /** - * When the activity was last modified - * @type {string} - * @memberof AccountActivityV2024 - */ - 'modified'?: string | null; - /** - * When the activity was completed - * @type {string} - * @memberof AccountActivityV2024 - */ - 'completed'?: string | null; - /** - * - * @type {CompletionStatusV2024} - * @memberof AccountActivityV2024 - */ - 'completionStatus'?: CompletionStatusV2024 | null; - /** - * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - * @type {string} - * @memberof AccountActivityV2024 - */ - 'type'?: string | null; - /** - * - * @type {IdentitySummaryV2024} - * @memberof AccountActivityV2024 - */ - 'requesterIdentitySummary'?: IdentitySummaryV2024 | null; - /** - * - * @type {IdentitySummaryV2024} - * @memberof AccountActivityV2024 - */ - 'targetIdentitySummary'?: IdentitySummaryV2024 | null; - /** - * A list of error messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2024 - */ - 'errors'?: Array | null; - /** - * A list of warning messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2024 - */ - 'warnings'?: Array | null; - /** - * Individual actions performed as part of this account activity - * @type {Array} - * @memberof AccountActivityV2024 - */ - 'items'?: Array | null; - /** - * - * @type {ExecutionStatusV2024} - * @memberof AccountActivityV2024 - */ - 'executionStatus'?: ExecutionStatusV2024; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccountActivityV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - - -/** - * The source the accounts are being aggregated from. - * @export - * @interface AccountAggregationCompletedSourceV2024 - */ -export interface AccountAggregationCompletedSourceV2024 { - /** - * The DTO type of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2024 - */ - 'type': AccountAggregationCompletedSourceV2024TypeV2024; - /** - * The ID of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2024 - */ - 'id': string; - /** - * Display name of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2024 - */ - 'name': string; -} - -export const AccountAggregationCompletedSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccountAggregationCompletedSourceV2024TypeV2024 = typeof AccountAggregationCompletedSourceV2024TypeV2024[keyof typeof AccountAggregationCompletedSourceV2024TypeV2024]; - -/** - * Overall statistics about the account aggregation. - * @export - * @interface AccountAggregationCompletedStatsV2024 - */ -export interface AccountAggregationCompletedStatsV2024 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2024 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2024 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2024 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2024 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountAggregationCompletedStatsV2024 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountAggregationCompletedV2024 - */ -export interface AccountAggregationCompletedV2024 { - /** - * - * @type {AccountAggregationCompletedSourceV2024} - * @memberof AccountAggregationCompletedV2024 - */ - 'source': AccountAggregationCompletedSourceV2024; - /** - * The overall status of the aggregation. - * @type {object} - * @memberof AccountAggregationCompletedV2024 - */ - 'status': AccountAggregationCompletedV2024StatusV2024; - /** - * The date and time when the account aggregation started. - * @type {string} - * @memberof AccountAggregationCompletedV2024 - */ - 'started': string; - /** - * The date and time when the account aggregation finished. - * @type {string} - * @memberof AccountAggregationCompletedV2024 - */ - 'completed': string; - /** - * A list of errors that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2024 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2024 - */ - 'warnings': Array | null; - /** - * - * @type {AccountAggregationCompletedStatsV2024} - * @memberof AccountAggregationCompletedV2024 - */ - 'stats': AccountAggregationCompletedStatsV2024; -} - -export const AccountAggregationCompletedV2024StatusV2024 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountAggregationCompletedV2024StatusV2024 = typeof AccountAggregationCompletedV2024StatusV2024[keyof typeof AccountAggregationCompletedV2024StatusV2024]; - -/** - * - * @export - * @interface AccountAggregationStatusV2024 - */ -export interface AccountAggregationStatusV2024 { - /** - * When the aggregation started. - * @type {string} - * @memberof AccountAggregationStatusV2024 - */ - 'start'?: string | null; - /** - * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - * @type {string} - * @memberof AccountAggregationStatusV2024 - */ - 'status'?: AccountAggregationStatusV2024StatusV2024; - /** - * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'totalAccounts'?: number; - /** - * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'processedAccounts'?: number; - /** - * The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'totalAccountsMarkedForDeletion'?: number; - /** - * The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'deletedAccounts'?: number; - /** - * The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'totalIdentities'?: number; - /** - * The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2024 - */ - 'processedIdentities'?: number; -} - -export const AccountAggregationStatusV2024StatusV2024 = { - Started: 'STARTED', - AccountsCollected: 'ACCOUNTS_COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Retried: 'RETRIED', - Terminated: 'TERMINATED', - NotFound: 'NOT_FOUND' -} as const; - -export type AccountAggregationStatusV2024StatusV2024 = typeof AccountAggregationStatusV2024StatusV2024[keyof typeof AccountAggregationStatusV2024StatusV2024]; - -/** - * The identity this account is correlated to - * @export - * @interface AccountAllOfIdentityV2024 - */ -export interface AccountAllOfIdentityV2024 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfIdentityV2024 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfIdentityV2024 - */ - 'type'?: AccountAllOfIdentityV2024TypeV2024; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfIdentityV2024 - */ - 'name'?: string; -} - -export const AccountAllOfIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfIdentityV2024TypeV2024 = typeof AccountAllOfIdentityV2024TypeV2024[keyof typeof AccountAllOfIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface AccountAllOfOwnerIdentityV2024 - */ -export interface AccountAllOfOwnerIdentityV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof AccountAllOfOwnerIdentityV2024 - */ - 'type'?: DtoTypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountAllOfRecommendationV2024 - */ -export interface AccountAllOfRecommendationV2024 { - /** - * Recommended type of account. - * @type {string} - * @memberof AccountAllOfRecommendationV2024 - */ - 'type': AccountAllOfRecommendationV2024TypeV2024; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof AccountAllOfRecommendationV2024 - */ - 'method': AccountAllOfRecommendationV2024MethodV2024; -} - -export const AccountAllOfRecommendationV2024TypeV2024 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type AccountAllOfRecommendationV2024TypeV2024 = typeof AccountAllOfRecommendationV2024TypeV2024[keyof typeof AccountAllOfRecommendationV2024TypeV2024]; -export const AccountAllOfRecommendationV2024MethodV2024 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type AccountAllOfRecommendationV2024MethodV2024 = typeof AccountAllOfRecommendationV2024MethodV2024[keyof typeof AccountAllOfRecommendationV2024MethodV2024]; - -/** - * The owner of the source this account belongs to. - * @export - * @interface AccountAllOfSourceOwnerV2024 - */ -export interface AccountAllOfSourceOwnerV2024 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2024 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfSourceOwnerV2024 - */ - 'type'?: AccountAllOfSourceOwnerV2024TypeV2024; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2024 - */ - 'name'?: string; -} - -export const AccountAllOfSourceOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfSourceOwnerV2024TypeV2024 = typeof AccountAllOfSourceOwnerV2024TypeV2024[keyof typeof AccountAllOfSourceOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface AccountAttributeV2024 - */ -export interface AccountAttributeV2024 { - /** - * A reference to the source to search for the account - * @type {string} - * @memberof AccountAttributeV2024 - */ - 'sourceName': string; - /** - * The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - * @type {string} - * @memberof AccountAttributeV2024 - */ - 'attributeName': string; - /** - * The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - * @type {string} - * @memberof AccountAttributeV2024 - */ - 'accountSortAttribute'?: string; - /** - * The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - * @type {boolean} - * @memberof AccountAttributeV2024 - */ - 'accountSortDescending'?: boolean; - /** - * The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - * @type {boolean} - * @memberof AccountAttributeV2024 - */ - 'accountReturnFirstLink'?: boolean; - /** - * This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - * @type {string} - * @memberof AccountAttributeV2024 - */ - 'accountFilter'?: string; - /** - * This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. - * @type {string} - * @memberof AccountAttributeV2024 - */ - 'accountPropertyFilter'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof AccountAttributeV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof AccountAttributeV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Details of the account where the attributes changed. - * @export - * @interface AccountAttributesChangedAccountV2024 - */ -export interface AccountAttributesChangedAccountV2024 { - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof AccountAttributesChangedAccountV2024 - */ - 'id': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountAttributesChangedAccountV2024 - */ - 'uuid': string | null; - /** - * Name of the account. - * @type {string} - * @memberof AccountAttributesChangedAccountV2024 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountAttributesChangedAccountV2024 - */ - 'nativeIdentity': string; - /** - * The type of the account - * @type {object} - * @memberof AccountAttributesChangedAccountV2024 - */ - 'type': AccountAttributesChangedAccountV2024TypeV2024; -} - -export const AccountAttributesChangedAccountV2024TypeV2024 = { - Account: 'ACCOUNT' -} as const; - -export type AccountAttributesChangedAccountV2024TypeV2024 = typeof AccountAttributesChangedAccountV2024TypeV2024[keyof typeof AccountAttributesChangedAccountV2024TypeV2024]; - -/** - * @type AccountAttributesChangedChangesInnerNewValueV2024 - * The new value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerNewValueV2024 = Array | boolean | string; - -/** - * @type AccountAttributesChangedChangesInnerOldValueV2024 - * The previous value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerOldValueV2024 = Array | boolean | string; - -/** - * - * @export - * @interface AccountAttributesChangedChangesInnerV2024 - */ -export interface AccountAttributesChangedChangesInnerV2024 { - /** - * The name of the attribute. - * @type {string} - * @memberof AccountAttributesChangedChangesInnerV2024 - */ - 'attribute': string; - /** - * - * @type {AccountAttributesChangedChangesInnerOldValueV2024} - * @memberof AccountAttributesChangedChangesInnerV2024 - */ - 'oldValue': AccountAttributesChangedChangesInnerOldValueV2024 | null; - /** - * - * @type {AccountAttributesChangedChangesInnerNewValueV2024} - * @memberof AccountAttributesChangedChangesInnerV2024 - */ - 'newValue': AccountAttributesChangedChangesInnerNewValueV2024 | null; -} -/** - * The identity whose account attributes were updated. - * @export - * @interface AccountAttributesChangedIdentityV2024 - */ -export interface AccountAttributesChangedIdentityV2024 { - /** - * DTO type of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2024 - */ - 'type': AccountAttributesChangedIdentityV2024TypeV2024; - /** - * ID of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2024 - */ - 'id': string; - /** - * Display name of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2024 - */ - 'name': string; -} - -export const AccountAttributesChangedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAttributesChangedIdentityV2024TypeV2024 = typeof AccountAttributesChangedIdentityV2024TypeV2024[keyof typeof AccountAttributesChangedIdentityV2024TypeV2024]; - -/** - * The source that contains the account. - * @export - * @interface AccountAttributesChangedSourceV2024 - */ -export interface AccountAttributesChangedSourceV2024 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2024 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountAttributesChangedSourceV2024 - */ - 'type': AccountAttributesChangedSourceV2024TypeV2024; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2024 - */ - 'name': string; -} - -export const AccountAttributesChangedSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccountAttributesChangedSourceV2024TypeV2024 = typeof AccountAttributesChangedSourceV2024TypeV2024[keyof typeof AccountAttributesChangedSourceV2024TypeV2024]; - -/** - * - * @export - * @interface AccountAttributesChangedV2024 - */ -export interface AccountAttributesChangedV2024 { - /** - * - * @type {AccountAttributesChangedIdentityV2024} - * @memberof AccountAttributesChangedV2024 - */ - 'identity': AccountAttributesChangedIdentityV2024; - /** - * - * @type {AccountAttributesChangedSourceV2024} - * @memberof AccountAttributesChangedV2024 - */ - 'source': AccountAttributesChangedSourceV2024; - /** - * - * @type {AccountAttributesChangedAccountV2024} - * @memberof AccountAttributesChangedV2024 - */ - 'account': AccountAttributesChangedAccountV2024; - /** - * A list of attributes that changed. - * @type {Array} - * @memberof AccountAttributesChangedV2024 - */ - 'changes': Array; -} -/** - * The schema attribute values for the account - * @export - * @interface AccountAttributesCreateAttributesV2024 - */ -export interface AccountAttributesCreateAttributesV2024 { - [key: string]: string | any; - - /** - * Target source to create an account - * @type {string} - * @memberof AccountAttributesCreateAttributesV2024 - */ - 'sourceId': string; -} -/** - * - * @export - * @interface AccountAttributesCreateV2024 - */ -export interface AccountAttributesCreateV2024 { - /** - * - * @type {AccountAttributesCreateAttributesV2024} - * @memberof AccountAttributesCreateV2024 - */ - 'attributes': AccountAttributesCreateAttributesV2024; -} -/** - * - * @export - * @interface AccountAttributesV2024 - */ -export interface AccountAttributesV2024 { - /** - * The schema attribute values for the account - * @type {{ [key: string]: any; }} - * @memberof AccountAttributesV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * The correlated account. - * @export - * @interface AccountCorrelatedAccountV2024 - */ -export interface AccountCorrelatedAccountV2024 { - /** - * The correlated account\'s DTO type. - * @type {string} - * @memberof AccountCorrelatedAccountV2024 - */ - 'type': AccountCorrelatedAccountV2024TypeV2024; - /** - * The correlated account\'s ID. - * @type {string} - * @memberof AccountCorrelatedAccountV2024 - */ - 'id': string; - /** - * The correlated account\'s display name. - * @type {string} - * @memberof AccountCorrelatedAccountV2024 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountCorrelatedAccountV2024 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountCorrelatedAccountV2024 - */ - 'uuid'?: string | null; -} - -export const AccountCorrelatedAccountV2024TypeV2024 = { - Account: 'ACCOUNT' -} as const; - -export type AccountCorrelatedAccountV2024TypeV2024 = typeof AccountCorrelatedAccountV2024TypeV2024[keyof typeof AccountCorrelatedAccountV2024TypeV2024]; - -/** - * Identity the account is correlated with. - * @export - * @interface AccountCorrelatedIdentityV2024 - */ -export interface AccountCorrelatedIdentityV2024 { - /** - * DTO type of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2024 - */ - 'type': AccountCorrelatedIdentityV2024TypeV2024; - /** - * ID of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2024 - */ - 'id': string; - /** - * Display name of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2024 - */ - 'name': string; -} - -export const AccountCorrelatedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccountCorrelatedIdentityV2024TypeV2024 = typeof AccountCorrelatedIdentityV2024TypeV2024[keyof typeof AccountCorrelatedIdentityV2024TypeV2024]; - -/** - * The source the accounts are being correlated from. - * @export - * @interface AccountCorrelatedSourceV2024 - */ -export interface AccountCorrelatedSourceV2024 { - /** - * The DTO type of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2024 - */ - 'type': AccountCorrelatedSourceV2024TypeV2024; - /** - * The ID of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2024 - */ - 'id': string; - /** - * Display name of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2024 - */ - 'name': string; -} - -export const AccountCorrelatedSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccountCorrelatedSourceV2024TypeV2024 = typeof AccountCorrelatedSourceV2024TypeV2024[keyof typeof AccountCorrelatedSourceV2024TypeV2024]; - -/** - * - * @export - * @interface AccountCorrelatedV2024 - */ -export interface AccountCorrelatedV2024 { - /** - * - * @type {AccountCorrelatedIdentityV2024} - * @memberof AccountCorrelatedV2024 - */ - 'identity': AccountCorrelatedIdentityV2024; - /** - * - * @type {AccountCorrelatedSourceV2024} - * @memberof AccountCorrelatedV2024 - */ - 'source': AccountCorrelatedSourceV2024; - /** - * - * @type {AccountCorrelatedAccountV2024} - * @memberof AccountCorrelatedV2024 - */ - 'account': AccountCorrelatedAccountV2024; - /** - * The attributes associated with the account. Attributes are unique per source. - * @type {{ [key: string]: any; }} - * @memberof AccountCorrelatedV2024 - */ - 'attributes': { [key: string]: any; }; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountCorrelatedV2024 - */ - 'entitlementCount'?: number; -} -/** - * - * @export - * @interface AccountInfoDtoV2024 - */ -export interface AccountInfoDtoV2024 { - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountInfoDtoV2024 - */ - 'nativeIdentity'?: string; - /** - * Display name for this account - * @type {string} - * @memberof AccountInfoDtoV2024 - */ - 'displayName'?: string; - /** - * UUID associated with this account - * @type {string} - * @memberof AccountInfoDtoV2024 - */ - 'uuid'?: string; -} -/** - * - * @export - * @interface AccountInfoRefV2024 - */ -export interface AccountInfoRefV2024 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountInfoRefV2024 - */ - 'uuid'?: string; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountInfoRefV2024 - */ - 'nativeIdentity'?: string; - /** - * - * @type {DtoTypeV2024} - * @memberof AccountInfoRefV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The account id - * @type {string} - * @memberof AccountInfoRefV2024 - */ - 'id'?: string; - /** - * The account display name - * @type {string} - * @memberof AccountInfoRefV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountItemRefV2024 - */ -export interface AccountItemRefV2024 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountItemRefV2024 - */ - 'accountUuid'?: string | null; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountItemRefV2024 - */ - 'nativeIdentity'?: string; -} -/** - * If an account activity item is associated with an access request, captures details of that request. - * @export - * @interface AccountRequestInfoV2024 - */ -export interface AccountRequestInfoV2024 { - /** - * Id of requested object - * @type {string} - * @memberof AccountRequestInfoV2024 - */ - 'requestedObjectId'?: string; - /** - * Human-readable name of requested object - * @type {string} - * @memberof AccountRequestInfoV2024 - */ - 'requestedObjectName'?: string; - /** - * - * @type {RequestableObjectTypeV2024} - * @memberof AccountRequestInfoV2024 - */ - 'requestedObjectType'?: RequestableObjectTypeV2024; -} - - -/** - * - * @export - * @interface AccountRequestResultV2024 - */ -export interface AccountRequestResultV2024 { - /** - * Error message. - * @type {Array} - * @memberof AccountRequestResultV2024 - */ - 'errors'?: Array; - /** - * The status of the account request - * @type {string} - * @memberof AccountRequestResultV2024 - */ - 'status'?: string; - /** - * ID of associated ticket. - * @type {string} - * @memberof AccountRequestResultV2024 - */ - 'ticketId'?: string | null; -} -/** - * - * @export - * @interface AccountRequestV2024 - */ -export interface AccountRequestV2024 { - /** - * Unique ID of the account - * @type {string} - * @memberof AccountRequestV2024 - */ - 'accountId'?: string; - /** - * - * @type {Array} - * @memberof AccountRequestV2024 - */ - 'attributeRequests'?: Array; - /** - * The operation that was performed - * @type {string} - * @memberof AccountRequestV2024 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2024} - * @memberof AccountRequestV2024 - */ - 'provisioningTarget'?: AccountSourceV2024; - /** - * - * @type {AccountRequestResultV2024} - * @memberof AccountRequestV2024 - */ - 'result'?: AccountRequestResultV2024; - /** - * - * @type {AccountSourceV2024} - * @memberof AccountRequestV2024 - */ - 'source'?: AccountSourceV2024; -} -/** - * - * @export - * @interface AccountSourceV2024 - */ -export interface AccountSourceV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccountSourceV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccountSourceV2024 - */ - 'name'?: string; - /** - * Type of source returned. - * @type {string} - * @memberof AccountSourceV2024 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedV2024 - */ -export interface AccountStatusChangedV2024 { - /** - * the event type - * @type {string} - * @memberof AccountStatusChangedV2024 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AccountStatusChangedV2024 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AccountStatusChangedV2024 - */ - 'dateTime'?: string; - /** - * - * @type {AccessRequestedAccountV2024} - * @memberof AccountStatusChangedV2024 - */ - 'account': AccessRequestedAccountV2024; - /** - * - * @type {AccessRequestedStatusChangeV2024} - * @memberof AccountStatusChangedV2024 - */ - 'statusChange': AccessRequestedStatusChangeV2024; -} -/** - * Request used for account enable/disable - * @export - * @interface AccountToggleRequestV2024 - */ -export interface AccountToggleRequestV2024 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountToggleRequestV2024 - */ - 'externalVerificationId'?: string; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. - * @type {boolean} - * @memberof AccountToggleRequestV2024 - */ - 'forceProvisioning'?: boolean; -} -/** - * Uncorrelated account. - * @export - * @interface AccountUncorrelatedAccountV2024 - */ -export interface AccountUncorrelatedAccountV2024 { - /** - * Uncorrelated account\'s DTO type. - * @type {object} - * @memberof AccountUncorrelatedAccountV2024 - */ - 'type': AccountUncorrelatedAccountV2024TypeV2024; - /** - * Uncorrelated account\'s ID. - * @type {string} - * @memberof AccountUncorrelatedAccountV2024 - */ - 'id': string; - /** - * Uncorrelated account\'s display name. - * @type {string} - * @memberof AccountUncorrelatedAccountV2024 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountUncorrelatedAccountV2024 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountUncorrelatedAccountV2024 - */ - 'uuid'?: string | null; -} - -export const AccountUncorrelatedAccountV2024TypeV2024 = { - Account: 'ACCOUNT' -} as const; - -export type AccountUncorrelatedAccountV2024TypeV2024 = typeof AccountUncorrelatedAccountV2024TypeV2024[keyof typeof AccountUncorrelatedAccountV2024TypeV2024]; - -/** - * Identity the account is uncorrelated with. - * @export - * @interface AccountUncorrelatedIdentityV2024 - */ -export interface AccountUncorrelatedIdentityV2024 { - /** - * DTO type of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2024 - */ - 'type': AccountUncorrelatedIdentityV2024TypeV2024; - /** - * ID of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2024 - */ - 'id': string; - /** - * Display name of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2024 - */ - 'name': string; -} - -export const AccountUncorrelatedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AccountUncorrelatedIdentityV2024TypeV2024 = typeof AccountUncorrelatedIdentityV2024TypeV2024[keyof typeof AccountUncorrelatedIdentityV2024TypeV2024]; - -/** - * The source the accounts are uncorrelated from. - * @export - * @interface AccountUncorrelatedSourceV2024 - */ -export interface AccountUncorrelatedSourceV2024 { - /** - * The DTO type of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2024 - */ - 'type': AccountUncorrelatedSourceV2024TypeV2024; - /** - * The ID of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2024 - */ - 'id': string; - /** - * Display name of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2024 - */ - 'name': string; -} - -export const AccountUncorrelatedSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccountUncorrelatedSourceV2024TypeV2024 = typeof AccountUncorrelatedSourceV2024TypeV2024[keyof typeof AccountUncorrelatedSourceV2024TypeV2024]; - -/** - * - * @export - * @interface AccountUncorrelatedV2024 - */ -export interface AccountUncorrelatedV2024 { - /** - * - * @type {AccountUncorrelatedIdentityV2024} - * @memberof AccountUncorrelatedV2024 - */ - 'identity': AccountUncorrelatedIdentityV2024; - /** - * - * @type {AccountUncorrelatedSourceV2024} - * @memberof AccountUncorrelatedV2024 - */ - 'source': AccountUncorrelatedSourceV2024; - /** - * - * @type {AccountUncorrelatedAccountV2024} - * @memberof AccountUncorrelatedV2024 - */ - 'account': AccountUncorrelatedAccountV2024; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountUncorrelatedV2024 - */ - 'entitlementCount'?: number; -} -/** - * Request used for account unlock - * @export - * @interface AccountUnlockRequestV2024 - */ -export interface AccountUnlockRequestV2024 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountUnlockRequestV2024 - */ - 'externalVerificationId'?: string; - /** - * If set, the IDN account is unlocked after the workflow completes. - * @type {boolean} - * @memberof AccountUnlockRequestV2024 - */ - 'unlockIDNAccount'?: boolean; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountUnlockRequestV2024 - */ - 'forceProvisioning'?: boolean; -} -/** - * - * @export - * @interface AccountUsageV2024 - */ -export interface AccountUsageV2024 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof AccountUsageV2024 - */ - 'date'?: string; - /** - * The number of days within the month that the account was active in a source. - * @type {number} - * @memberof AccountUsageV2024 - */ - 'count'?: number; -} -/** - * - * @export - * @interface AccountV2024 - */ -export interface AccountV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof AccountV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof AccountV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof AccountV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof AccountV2024 - */ - 'modified'?: string; - /** - * The unique ID of the source this account belongs to - * @type {string} - * @memberof AccountV2024 - */ - 'sourceId': string; - /** - * The display name of the source this account belongs to - * @type {string} - * @memberof AccountV2024 - */ - 'sourceName': string | null; - /** - * The unique ID of the identity this account is correlated to - * @type {string} - * @memberof AccountV2024 - */ - 'identityId'?: string; - /** - * The lifecycle state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2024 - */ - 'cloudLifecycleState'?: string | null; - /** - * The identity state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2024 - */ - 'identityState'?: string | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof AccountV2024 - */ - 'connectionType'?: string | null; - /** - * Indicates if the account is of machine type - * @type {boolean} - * @memberof AccountV2024 - */ - 'isMachine'?: boolean; - /** - * - * @type {AccountAllOfRecommendationV2024} - * @memberof AccountV2024 - */ - 'recommendation'?: AccountAllOfRecommendationV2024; - /** - * The account attributes that are aggregated - * @type {{ [key: string]: any; }} - * @memberof AccountV2024 - */ - 'attributes': { [key: string]: any; } | null; - /** - * Indicates if this account is from an authoritative source - * @type {boolean} - * @memberof AccountV2024 - */ - 'authoritative': boolean; - /** - * A description of the account - * @type {string} - * @memberof AccountV2024 - */ - 'description'?: string | null; - /** - * Indicates if the account is currently disabled - * @type {boolean} - * @memberof AccountV2024 - */ - 'disabled': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof AccountV2024 - */ - 'locked': boolean; - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountV2024 - */ - 'nativeIdentity': string; - /** - * If true, this is a user account within IdentityNow. If false, this is an account from a source system. - * @type {boolean} - * @memberof AccountV2024 - */ - 'systemAccount': boolean; - /** - * Indicates if this account is not correlated to an identity - * @type {boolean} - * @memberof AccountV2024 - */ - 'uncorrelated': boolean; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof AccountV2024 - */ - 'uuid'?: string | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof AccountV2024 - */ - 'manuallyCorrelated': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof AccountV2024 - */ - 'hasEntitlements': boolean; - /** - * - * @type {AccountAllOfIdentityV2024} - * @memberof AccountV2024 - */ - 'identity'?: AccountAllOfIdentityV2024; - /** - * - * @type {AccountAllOfSourceOwnerV2024} - * @memberof AccountV2024 - */ - 'sourceOwner'?: AccountAllOfSourceOwnerV2024 | null; - /** - * A string list containing the owning source\'s features - * @type {string} - * @memberof AccountV2024 - */ - 'features'?: string | null; - /** - * The origin of the account either aggregated or provisioned - * @type {string} - * @memberof AccountV2024 - */ - 'origin'?: AccountV2024OriginV2024 | null; - /** - * - * @type {AccountAllOfOwnerIdentityV2024} - * @memberof AccountV2024 - */ - 'ownerIdentity'?: AccountAllOfOwnerIdentityV2024; -} - -export const AccountV2024OriginV2024 = { - Aggregated: 'AGGREGATED', - Provisioned: 'PROVISIONED' -} as const; - -export type AccountV2024OriginV2024 = typeof AccountV2024OriginV2024[keyof typeof AccountV2024OriginV2024]; - -/** - * Accounts async response containing details on started async process - * @export - * @interface AccountsAsyncResultV2024 - */ -export interface AccountsAsyncResultV2024 { - /** - * id of the task - * @type {string} - * @memberof AccountsAsyncResultV2024 - */ - 'id': string; -} -/** - * Reference to the source that has been aggregated. - * @export - * @interface AccountsCollectedForAggregationSourceV2024 - */ -export interface AccountsCollectedForAggregationSourceV2024 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2024 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2024 - */ - 'type': AccountsCollectedForAggregationSourceV2024TypeV2024; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2024 - */ - 'name': string; -} - -export const AccountsCollectedForAggregationSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AccountsCollectedForAggregationSourceV2024TypeV2024 = typeof AccountsCollectedForAggregationSourceV2024TypeV2024[keyof typeof AccountsCollectedForAggregationSourceV2024TypeV2024]; - -/** - * Overall statistics about the account collection. - * @export - * @interface AccountsCollectedForAggregationStatsV2024 - */ -export interface AccountsCollectedForAggregationStatsV2024 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2024 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2024 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2024 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2024 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2024 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountsCollectedForAggregationV2024 - */ -export interface AccountsCollectedForAggregationV2024 { - /** - * - * @type {AccountsCollectedForAggregationSourceV2024} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'source': AccountsCollectedForAggregationSourceV2024; - /** - * The overall status of the collection. - * @type {object} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'status': AccountsCollectedForAggregationV2024StatusV2024; - /** - * The date and time when the account collection started. - * @type {string} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'started': string; - /** - * The date and time when the account collection finished. - * @type {string} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'completed': string; - /** - * A list of errors that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'warnings': Array | null; - /** - * - * @type {AccountsCollectedForAggregationStatsV2024} - * @memberof AccountsCollectedForAggregationV2024 - */ - 'stats': AccountsCollectedForAggregationStatsV2024; -} - -export const AccountsCollectedForAggregationV2024StatusV2024 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountsCollectedForAggregationV2024StatusV2024 = typeof AccountsCollectedForAggregationV2024StatusV2024[keyof typeof AccountsCollectedForAggregationV2024StatusV2024]; - -/** - * Arguments for Account Export report (ACCOUNTS) - * @export - * @interface AccountsExportReportArgumentsV2024 - */ -export interface AccountsExportReportArgumentsV2024 { - /** - * Source ID. - * @type {string} - * @memberof AccountsExportReportArgumentsV2024 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof AccountsExportReportArgumentsV2024 - */ - 'sourceName': string; -} -/** - * - * @export - * @interface AccountsSelectionRequestV2024 - */ -export interface AccountsSelectionRequestV2024 { - /** - * A list of Identity IDs for whom the Access is requested. - * @type {Array} - * @memberof AccountsSelectionRequestV2024 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof AccountsSelectionRequestV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * - * @type {Array} - * @memberof AccountsSelectionRequestV2024 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccountsSelectionRequestV2024 - */ - 'clientMetadata'?: { [key: string]: string; }; -} - - -/** - * - * @export - * @interface AccountsSelectionResponseV2024 - */ -export interface AccountsSelectionResponseV2024 { - /** - * A list of available account selections per identity in the request, for all the requested items - * @type {Array} - * @memberof AccountsSelectionResponseV2024 - */ - 'identities'?: Array; -} -/** - * - * @export - * @interface ActivateCampaignOptionsV2024 - */ -export interface ActivateCampaignOptionsV2024 { - /** - * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - * @type {string} - * @memberof ActivateCampaignOptionsV2024 - */ - 'timeZone'?: string; -} -/** - * - * @export - * @interface ActivityIdentityV2024 - */ -export interface ActivityIdentityV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2024 - */ - 'name'?: string; - /** - * Type of object - * @type {string} - * @memberof ActivityIdentityV2024 - */ - 'type'?: string; -} -/** - * Insights into account activity - * @export - * @interface ActivityInsightsV2024 - */ -export interface ActivityInsightsV2024 { - /** - * UUID of the account - * @type {string} - * @memberof ActivityInsightsV2024 - */ - 'accountID'?: string; - /** - * The number of days of activity - * @type {number} - * @memberof ActivityInsightsV2024 - */ - 'usageDays'?: number; - /** - * Status indicating if the activity is complete or unknown - * @type {string} - * @memberof ActivityInsightsV2024 - */ - 'usageDaysState'?: ActivityInsightsV2024UsageDaysStateV2024; -} - -export const ActivityInsightsV2024UsageDaysStateV2024 = { - Complete: 'COMPLETE', - Unknown: 'UNKNOWN' -} as const; - -export type ActivityInsightsV2024UsageDaysStateV2024 = typeof ActivityInsightsV2024UsageDaysStateV2024[keyof typeof ActivityInsightsV2024UsageDaysStateV2024]; - -/** - * Reference to an additional owner (identity or governance group). - * @export - * @interface AdditionalOwnerRefV2024 - */ -export interface AdditionalOwnerRefV2024 { - /** - * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2024 - */ - 'type'?: AdditionalOwnerRefV2024TypeV2024; - /** - * ID of the identity or governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2024 - */ - 'id'?: string; - /** - * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. - * @type {string} - * @memberof AdditionalOwnerRefV2024 - */ - 'name'?: string | null; -} - -export const AdditionalOwnerRefV2024TypeV2024 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AdditionalOwnerRefV2024TypeV2024 = typeof AdditionalOwnerRefV2024TypeV2024[keyof typeof AdditionalOwnerRefV2024TypeV2024]; - -/** - * - * @export - * @interface AdminReviewReassignReassignToV2024 - */ -export interface AdminReviewReassignReassignToV2024 { - /** - * The identity ID to which the review is being assigned. - * @type {string} - * @memberof AdminReviewReassignReassignToV2024 - */ - 'id'?: string; - /** - * The type of the ID provided. - * @type {string} - * @memberof AdminReviewReassignReassignToV2024 - */ - 'type'?: AdminReviewReassignReassignToV2024TypeV2024; -} - -export const AdminReviewReassignReassignToV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type AdminReviewReassignReassignToV2024TypeV2024 = typeof AdminReviewReassignReassignToV2024TypeV2024[keyof typeof AdminReviewReassignReassignToV2024TypeV2024]; - -/** - * - * @export - * @interface AdminReviewReassignV2024 - */ -export interface AdminReviewReassignV2024 { - /** - * List of certification IDs to reassign - * @type {Array} - * @memberof AdminReviewReassignV2024 - */ - 'certificationIds'?: Array; - /** - * - * @type {AdminReviewReassignReassignToV2024} - * @memberof AdminReviewReassignV2024 - */ - 'reassignTo'?: AdminReviewReassignReassignToV2024; - /** - * Comment to explain why the certification was reassigned - * @type {string} - * @memberof AdminReviewReassignV2024 - */ - 'reason'?: string; -} -/** - * - * @export - * @interface AggregationResultV2024 - */ -export interface AggregationResultV2024 { - /** - * The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - * @type {object} - * @memberof AggregationResultV2024 - */ - 'aggregations'?: object; - /** - * The results of the aggregation search query. - * @type {Array} - * @memberof AggregationResultV2024 - */ - 'hits'?: Array; -} -/** - * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const AggregationTypeV2024 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT' -} as const; - -export type AggregationTypeV2024 = typeof AggregationTypeV2024[keyof typeof AggregationTypeV2024]; - - -/** - * - * @export - * @interface AggregationsV2024 - */ -export interface AggregationsV2024 { - /** - * - * @type {NestedAggregationV2024} - * @memberof AggregationsV2024 - */ - 'nested'?: NestedAggregationV2024; - /** - * - * @type {MetricAggregationV2024} - * @memberof AggregationsV2024 - */ - 'metric'?: MetricAggregationV2024; - /** - * - * @type {FilterAggregationV2024} - * @memberof AggregationsV2024 - */ - 'filter'?: FilterAggregationV2024; - /** - * - * @type {BucketAggregationV2024} - * @memberof AggregationsV2024 - */ - 'bucket'?: BucketAggregationV2024; -} -/** - * - * @export - * @interface AppAccountDetailsSourceAccountV2024 - */ -export interface AppAccountDetailsSourceAccountV2024 { - /** - * The account ID - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2024 - */ - 'id'?: string; - /** - * The native identity of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2024 - */ - 'nativeIdentity'?: string; - /** - * The display name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2024 - */ - 'displayName'?: string; - /** - * The source ID of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2024 - */ - 'sourceId'?: string; - /** - * The source name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2024 - */ - 'sourceDisplayName'?: string; -} -/** - * - * @export - * @interface AppAccountDetailsV2024 - */ -export interface AppAccountDetailsV2024 { - /** - * The source app ID - * @type {string} - * @memberof AppAccountDetailsV2024 - */ - 'appId'?: string; - /** - * The source app display name - * @type {string} - * @memberof AppAccountDetailsV2024 - */ - 'appDisplayName'?: string; - /** - * - * @type {AppAccountDetailsSourceAccountV2024} - * @memberof AppAccountDetailsV2024 - */ - 'sourceAccount'?: AppAccountDetailsSourceAccountV2024; -} -/** - * - * @export - * @interface AppAllOfAccountV2024 - */ -export interface AppAllOfAccountV2024 { - /** - * The SailPoint generated unique ID - * @type {string} - * @memberof AppAllOfAccountV2024 - */ - 'id'?: string; - /** - * The account ID generated by the source - * @type {string} - * @memberof AppAllOfAccountV2024 - */ - 'accountId'?: string; -} -/** - * - * @export - * @interface AppV2024 - */ -export interface AppV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AppV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AppV2024 - */ - 'name'?: string; - /** - * - * @type {Reference1V2024} - * @memberof AppV2024 - */ - 'source'?: Reference1V2024; - /** - * - * @type {AppAllOfAccountV2024} - * @memberof AppV2024 - */ - 'account'?: AppAllOfAccountV2024; -} -/** - * - * @export - * @interface Approval1V2024 - */ -export interface Approval1V2024 { - /** - * - * @type {Array} - * @memberof Approval1V2024 - */ - 'comments'?: Array; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Approval1V2024 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityIdentityV2024} - * @memberof Approval1V2024 - */ - 'owner'?: ActivityIdentityV2024; - /** - * The result of the approval - * @type {string} - * @memberof Approval1V2024 - */ - 'result'?: string; - /** - * - * @type {AttributeRequestV2024} - * @memberof Approval1V2024 - */ - 'attributeRequest'?: AttributeRequestV2024; - /** - * - * @type {AccountSourceV2024} - * @memberof Approval1V2024 - */ - 'source'?: AccountSourceV2024; -} -/** - * Batch properties if an approval is sent via batching. - * @export - * @interface ApprovalBatchV2024 - */ -export interface ApprovalBatchV2024 { - /** - * ID of the batch - * @type {string} - * @memberof ApprovalBatchV2024 - */ - 'batchId'?: string; - /** - * How many approvals are going to be in this batch. Defaults to 1 if not provided. - * @type {number} - * @memberof ApprovalBatchV2024 - */ - 'batchSize'?: number; -} -/** - * Comments Object - * @export - * @interface ApprovalComment1V2024 - */ -export interface ApprovalComment1V2024 { - /** - * - * @type {ApprovalIdentityV2024} - * @memberof ApprovalComment1V2024 - */ - 'author'?: ApprovalIdentityV2024; - /** - * Comment to be left on an approval - * @type {string} - * @memberof ApprovalComment1V2024 - */ - 'comment'?: string; - /** - * Date the comment was created - * @type {string} - * @memberof ApprovalComment1V2024 - */ - 'createdDate'?: string; -} -/** - * - * @export - * @interface ApprovalComment2V2024 - */ -export interface ApprovalComment2V2024 { - /** - * The comment text - * @type {string} - * @memberof ApprovalComment2V2024 - */ - 'comment'?: string; - /** - * The name of the commenter - * @type {string} - * @memberof ApprovalComment2V2024 - */ - 'commenter'?: string; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ApprovalComment2V2024 - */ - 'date'?: string | null; -} -/** - * - * @export - * @interface ApprovalCommentV2024 - */ -export interface ApprovalCommentV2024 { - /** - * Comment provided either by the approval requester or the approver. - * @type {string} - * @memberof ApprovalCommentV2024 - */ - 'comment': string; - /** - * The time when this comment was provided. - * @type {string} - * @memberof ApprovalCommentV2024 - */ - 'timestamp': string; - /** - * Name of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2024 - */ - 'user': string; - /** - * Id of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2024 - */ - 'id': string; - /** - * Status transition of the draft. - * @type {string} - * @memberof ApprovalCommentV2024 - */ - 'changedToStatus': ApprovalCommentV2024ChangedToStatusV2024; -} - -export const ApprovalCommentV2024ChangedToStatusV2024 = { - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type ApprovalCommentV2024ChangedToStatusV2024 = typeof ApprovalCommentV2024ChangedToStatusV2024[keyof typeof ApprovalCommentV2024ChangedToStatusV2024]; - -/** - * The description of what the approval is asking for - * @export - * @interface ApprovalDescriptionV2024 - */ -export interface ApprovalDescriptionV2024 { - /** - * The description of what the approval is asking for - * @type {string} - * @memberof ApprovalDescriptionV2024 - */ - 'value'?: string; - /** - * What locale the description of the approval is using - * @type {string} - * @memberof ApprovalDescriptionV2024 - */ - 'locale'?: string; -} -/** - * - * @export - * @interface ApprovalForwardHistoryV2024 - */ -export interface ApprovalForwardHistoryV2024 { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2024 - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2024 - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistoryV2024 - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2024 - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistoryV2024 - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentTypeV2024} - * @memberof ApprovalForwardHistoryV2024 - */ - 'reassignmentType'?: ReassignmentTypeV2024; -} - - -/** - * Identity Object - * @export - * @interface ApprovalIdentityV2024 - */ -export interface ApprovalIdentityV2024 { - /** - * The identity ID - * @type {string} - * @memberof ApprovalIdentityV2024 - */ - 'id'?: string; - /** - * Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc - * @type {string} - * @memberof ApprovalIdentityV2024 - */ - 'type'?: ApprovalIdentityV2024TypeV2024; - /** - * Name of the identity - * @type {string} - * @memberof ApprovalIdentityV2024 - */ - 'name'?: string; -} - -export const ApprovalIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalIdentityV2024TypeV2024 = typeof ApprovalIdentityV2024TypeV2024[keyof typeof ApprovalIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface ApprovalItemDetailsV2024 - */ -export interface ApprovalItemDetailsV2024 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemDetailsV2024 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2024 & object} - * @memberof ApprovalItemDetailsV2024 - */ - 'state'?: WorkItemStateV2024 & object; -} -/** - * - * @export - * @interface ApprovalItemsV2024 - */ -export interface ApprovalItemsV2024 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemsV2024 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2024 & object} - * @memberof ApprovalItemsV2024 - */ - 'state'?: WorkItemStateV2024 & object; -} -/** - * Approval Name Object - * @export - * @interface ApprovalNameV2024 - */ -export interface ApprovalNameV2024 { - /** - * Name of the approval - * @type {string} - * @memberof ApprovalNameV2024 - */ - 'value'?: string; - /** - * What locale the name of the approval is using - * @type {string} - * @memberof ApprovalNameV2024 - */ - 'locale'?: string; -} -/** - * Reference objects related to the approval - * @export - * @interface ApprovalReferenceV2024 - */ -export interface ApprovalReferenceV2024 { - /** - * Id of the reference object - * @type {string} - * @memberof ApprovalReferenceV2024 - */ - 'id'?: string; - /** - * What reference object does this ID correspond to - * @type {string} - * @memberof ApprovalReferenceV2024 - */ - 'type'?: string; -} -/** - * Configuration for approval reminder and escalation behavior. Important: Modifying this object will override the sp-approval service\'s reminderConfig and escalationConfig settings. Changes made here take precedence over any configuration set directly in the sp-approval service. - * @export - * @interface ApprovalReminderAndEscalationConfigV2024 - */ -export interface ApprovalReminderAndEscalationConfigV2024 { - /** - * Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2024 - */ - 'daysUntilEscalation'?: number | null; - /** - * Number of days to wait between reminder notifications. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2024 - */ - 'daysBetweenReminders'?: number | null; - /** - * Maximum number of reminder notifications to send to the reviewer before approval escalation. The maximum allowed value is 20. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2024 - */ - 'maxReminders'?: number | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2024} - * @memberof ApprovalReminderAndEscalationConfigV2024 - */ - 'fallbackApproverRef'?: IdentityReferenceWithNameAndEmailV2024 | null; -} -/** - * - * @export - * @interface ApprovalSchemeForRoleV2024 - */ -export interface ApprovalSchemeForRoleV2024 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof ApprovalSchemeForRoleV2024 - */ - 'approverType'?: ApprovalSchemeForRoleV2024ApproverTypeV2024; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof ApprovalSchemeForRoleV2024 - */ - 'approverId'?: string | null; -} - -export const ApprovalSchemeForRoleV2024ApproverTypeV2024 = { - Owner: 'OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeForRoleV2024ApproverTypeV2024 = typeof ApprovalSchemeForRoleV2024ApproverTypeV2024[keyof typeof ApprovalSchemeForRoleV2024ApproverTypeV2024]; - -/** - * Describes the individual or group that is responsible for an approval step. - * @export - * @enum {string} - */ - -export const ApprovalSchemeV2024 = { - AppOwner: 'APP_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - RoleOwner: 'ROLE_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeV2024 = typeof ApprovalSchemeV2024[keyof typeof ApprovalSchemeV2024]; - - -/** - * - * @export - * @interface ApprovalStatusDtoCurrentOwnerV2024 - */ -export interface ApprovalStatusDtoCurrentOwnerV2024 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2024 - */ - 'type'?: ApprovalStatusDtoCurrentOwnerV2024TypeV2024; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2024 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoCurrentOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoCurrentOwnerV2024TypeV2024 = typeof ApprovalStatusDtoCurrentOwnerV2024TypeV2024[keyof typeof ApprovalStatusDtoCurrentOwnerV2024TypeV2024]; - -/** - * Identity of orginal approval owner. - * @export - * @interface ApprovalStatusDtoOriginalOwnerV2024 - */ -export interface ApprovalStatusDtoOriginalOwnerV2024 { - /** - * DTO type of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2024 - */ - 'type'?: ApprovalStatusDtoOriginalOwnerV2024TypeV2024; - /** - * ID of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2024 - */ - 'id'?: string; - /** - * Display name of original approval owner. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2024 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoOriginalOwnerV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoOriginalOwnerV2024TypeV2024 = typeof ApprovalStatusDtoOriginalOwnerV2024TypeV2024[keyof typeof ApprovalStatusDtoOriginalOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface ApprovalStatusDtoV2024 - */ -export interface ApprovalStatusDtoV2024 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDtoV2024 - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwnerV2024} - * @memberof ApprovalStatusDtoV2024 - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwnerV2024; - /** - * - * @type {ApprovalStatusDtoCurrentOwnerV2024} - * @memberof ApprovalStatusDtoV2024 - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwnerV2024; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDtoV2024 - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemStateV2024} - * @memberof ApprovalStatusDtoV2024 - */ - 'status'?: ManualWorkItemStateV2024; - /** - * - * @type {ApprovalSchemeV2024} - * @memberof ApprovalStatusDtoV2024 - */ - 'scheme'?: ApprovalSchemeV2024; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDtoV2024 - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDtoV2024 - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDtoV2024 - */ - 'removeDate'?: string | null; -} - - -/** - * Enum representing the non-employee request approval status - * @export - * @enum {string} - */ - -export const ApprovalStatusV2024 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Pending: 'PENDING', - NotReady: 'NOT_READY', - Cancelled: 'CANCELLED' -} as const; - -export type ApprovalStatusV2024 = typeof ApprovalStatusV2024[keyof typeof ApprovalStatusV2024]; - - -/** - * - * @export - * @interface ApprovalSummaryV2024 - */ -export interface ApprovalSummaryV2024 { - /** - * The number of pending access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2024 - */ - 'pending'?: number; - /** - * The number of approved access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2024 - */ - 'approved'?: number; - /** - * The number of rejected access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2024 - */ - 'rejected'?: number; -} -/** - * Approval Object - * @export - * @interface ApprovalV2024 - */ -export interface ApprovalV2024 { - /** - * The Approval ID - * @type {string} - * @memberof ApprovalV2024 - */ - 'approvalId'?: string; - /** - * Object representation of an approver of an approval - * @type {Array} - * @memberof ApprovalV2024 - */ - 'approvers'?: Array; - /** - * Date the approval was created - * @type {string} - * @memberof ApprovalV2024 - */ - 'createdDate'?: string; - /** - * Type of approval - * @type {string} - * @memberof ApprovalV2024 - */ - 'type'?: string; - /** - * The name of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2024 - */ - 'name'?: Array; - /** - * The name of the approval for a given locale - * @type {ApprovalBatchV2024} - * @memberof ApprovalV2024 - */ - 'batchRequest'?: ApprovalBatchV2024; - /** - * The description of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2024 - */ - 'description'?: Array; - /** - * The priority of the approval - * @type {string} - * @memberof ApprovalV2024 - */ - 'priority'?: ApprovalV2024PriorityV2024; - /** - * Object representation of the requester of the approval - * @type {ApprovalIdentityV2024} - * @memberof ApprovalV2024 - */ - 'requester'?: ApprovalIdentityV2024; - /** - * Object representation of a comment on the approval - * @type {Array} - * @memberof ApprovalV2024 - */ - 'comments'?: Array; - /** - * Array of approvers who have approved the approval - * @type {Array} - * @memberof ApprovalV2024 - */ - 'approvedBy'?: Array; - /** - * Array of approvers who have rejected the approval - * @type {Array} - * @memberof ApprovalV2024 - */ - 'rejectedBy'?: Array; - /** - * Date the approval was completed - * @type {string} - * @memberof ApprovalV2024 - */ - 'completedDate'?: string; - /** - * Criteria that needs to be met for an approval to be marked as approved - * @type {string} - * @memberof ApprovalV2024 - */ - 'approvalCriteria'?: ApprovalV2024ApprovalCriteriaV2024; - /** - * The current status of the approval - * @type {string} - * @memberof ApprovalV2024 - */ - 'status'?: ApprovalV2024StatusV2024; - /** - * Json string representing additional attributes known about the object to be approved. - * @type {string} - * @memberof ApprovalV2024 - */ - 'additionalAttributes'?: string; - /** - * Reference data related to the approval - * @type {Array} - * @memberof ApprovalV2024 - */ - 'referenceData'?: Array; -} - -export const ApprovalV2024PriorityV2024 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type ApprovalV2024PriorityV2024 = typeof ApprovalV2024PriorityV2024[keyof typeof ApprovalV2024PriorityV2024]; -export const ApprovalV2024ApprovalCriteriaV2024 = { - Single: 'SINGLE', - Double: 'DOUBLE', - Triple: 'TRIPLE', - Quarter: 'QUARTER', - Half: 'HALF', - All: 'ALL' -} as const; - -export type ApprovalV2024ApprovalCriteriaV2024 = typeof ApprovalV2024ApprovalCriteriaV2024[keyof typeof ApprovalV2024ApprovalCriteriaV2024]; -export const ApprovalV2024StatusV2024 = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type ApprovalV2024StatusV2024 = typeof ApprovalV2024StatusV2024[keyof typeof ApprovalV2024StatusV2024]; - -/** - * - * @export - * @interface ArgumentV2024 - */ -export interface ArgumentV2024 { - /** - * the name of the argument - * @type {string} - * @memberof ArgumentV2024 - */ - 'name': string; - /** - * the description of the argument - * @type {string} - * @memberof ArgumentV2024 - */ - 'description'?: string | null; - /** - * the programmatic type of the argument - * @type {string} - * @memberof ArgumentV2024 - */ - 'type'?: string | null; -} -/** - * - * @export - * @interface ArrayInner1V2024 - */ -export interface ArrayInner1V2024 { -} -/** - * - * @export - * @interface ArrayInnerV2024 - */ -export interface ArrayInnerV2024 { -} -/** - * - * @export - * @interface AssignmentContextDtoV2024 - */ -export interface AssignmentContextDtoV2024 { - /** - * - * @type {AccessRequestContextV2024} - * @memberof AssignmentContextDtoV2024 - */ - 'requested'?: AccessRequestContextV2024; - /** - * - * @type {Array} - * @memberof AssignmentContextDtoV2024 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof AssignmentContextDtoV2024 - */ - 'computedDate'?: string; -} -/** - * Specification of source attribute sync mapping configuration for an identity attribute - * @export - * @interface AttrSyncSourceAttributeConfigV2024 - */ -export interface AttrSyncSourceAttributeConfigV2024 { - /** - * Name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2024 - */ - 'name': string; - /** - * Display name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2024 - */ - 'displayName': string; - /** - * Determines whether or not the attribute is enabled for synchronization - * @type {boolean} - * @memberof AttrSyncSourceAttributeConfigV2024 - */ - 'enabled': boolean; - /** - * Name of the source account attribute to which the identity attribute value will be synchronized if enabled - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2024 - */ - 'target': string; -} -/** - * Specification of attribute sync configuration for a source - * @export - * @interface AttrSyncSourceConfigV2024 - */ -export interface AttrSyncSourceConfigV2024 { - /** - * - * @type {AttrSyncSourceV2024} - * @memberof AttrSyncSourceConfigV2024 - */ - 'source': AttrSyncSourceV2024; - /** - * Attribute synchronization configuration for specific identity attributes in the context of a source - * @type {Array} - * @memberof AttrSyncSourceConfigV2024 - */ - 'attributes': Array; -} -/** - * Target source for attribute synchronization. - * @export - * @interface AttrSyncSourceV2024 - */ -export interface AttrSyncSourceV2024 { - /** - * DTO type of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2024 - */ - 'type'?: AttrSyncSourceV2024TypeV2024; - /** - * ID of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2024 - */ - 'id'?: string; - /** - * Human-readable name of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2024 - */ - 'name'?: string | null; -} - -export const AttrSyncSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type AttrSyncSourceV2024TypeV2024 = typeof AttrSyncSourceV2024TypeV2024[keyof typeof AttrSyncSourceV2024TypeV2024]; - -/** - * - * @export - * @interface AttributeChangeV2024 - */ -export interface AttributeChangeV2024 { - /** - * the attribute name - * @type {string} - * @memberof AttributeChangeV2024 - */ - 'name'?: string; - /** - * the old value of attribute - * @type {string} - * @memberof AttributeChangeV2024 - */ - 'previousValue'?: string; - /** - * the new value of attribute - * @type {string} - * @memberof AttributeChangeV2024 - */ - 'newValue'?: string; -} -/** - * - * @export - * @interface AttributeDTOListV2024 - */ -export interface AttributeDTOListV2024 { - /** - * - * @type {Array} - * @memberof AttributeDTOListV2024 - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface AttributeDTOV2024 - */ -export interface AttributeDTOV2024 { - /** - * Technical name of the Attribute. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeDTOV2024 - */ - 'key'?: string; - /** - * The display name of the key. - * @type {string} - * @memberof AttributeDTOV2024 - */ - 'name'?: string; - /** - * Indicates whether the attribute can have multiple values. - * @type {boolean} - * @memberof AttributeDTOV2024 - */ - 'multiselect'?: boolean; - /** - * The status of the Attribute. - * @type {string} - * @memberof AttributeDTOV2024 - */ - 'status'?: string; - /** - * The type of the Attribute. This can be either \"custom\" or \"governance\". - * @type {string} - * @memberof AttributeDTOV2024 - */ - 'type'?: string; - /** - * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. - * @type {Array} - * @memberof AttributeDTOV2024 - */ - 'objectTypes'?: Array | null; - /** - * The description of the Attribute. - * @type {string} - * @memberof AttributeDTOV2024 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof AttributeDTOV2024 - */ - 'values'?: Array | null; -} -/** - * A reference to the schema on the source to the attribute values map to. - * @export - * @interface AttributeDefinitionSchemaV2024 - */ -export interface AttributeDefinitionSchemaV2024 { - /** - * The type of object being referenced - * @type {string} - * @memberof AttributeDefinitionSchemaV2024 - */ - 'type'?: AttributeDefinitionSchemaV2024TypeV2024; - /** - * The object ID this reference applies to. - * @type {string} - * @memberof AttributeDefinitionSchemaV2024 - */ - 'id'?: string; - /** - * The human-readable display name of the object. - * @type {string} - * @memberof AttributeDefinitionSchemaV2024 - */ - 'name'?: string; -} - -export const AttributeDefinitionSchemaV2024TypeV2024 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type AttributeDefinitionSchemaV2024TypeV2024 = typeof AttributeDefinitionSchemaV2024TypeV2024[keyof typeof AttributeDefinitionSchemaV2024TypeV2024]; - -/** - * The underlying type of the value which an AttributeDefinition represents. - * @export - * @enum {string} - */ - -export const AttributeDefinitionTypeV2024 = { - String: 'STRING', - Long: 'LONG', - Int: 'INT', - Boolean: 'BOOLEAN', - Date: 'DATE' -} as const; - -export type AttributeDefinitionTypeV2024 = typeof AttributeDefinitionTypeV2024[keyof typeof AttributeDefinitionTypeV2024]; - - -/** - * - * @export - * @interface AttributeDefinitionV2024 - */ -export interface AttributeDefinitionV2024 { - /** - * The name of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2024 - */ - 'name'?: string; - /** - * Attribute name in the native system. - * @type {string} - * @memberof AttributeDefinitionV2024 - */ - 'nativeName'?: string | null; - /** - * - * @type {AttributeDefinitionTypeV2024} - * @memberof AttributeDefinitionV2024 - */ - 'type'?: AttributeDefinitionTypeV2024; - /** - * - * @type {AttributeDefinitionSchemaV2024} - * @memberof AttributeDefinitionV2024 - */ - 'schema'?: AttributeDefinitionSchemaV2024 | null; - /** - * A human-readable description of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2024 - */ - 'description'?: string; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof AttributeDefinitionV2024 - */ - 'isMulti'?: boolean; - /** - * Flag indicating whether or not the attribute is an entitlement. - * @type {boolean} - * @memberof AttributeDefinitionV2024 - */ - 'isEntitlement'?: boolean; - /** - * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - * @type {boolean} - * @memberof AttributeDefinitionV2024 - */ - 'isGroup'?: boolean; -} - - -/** - * Targeted Entity - * @export - * @interface AttributeMappingsAllOfTargetV2024 - */ -export interface AttributeMappingsAllOfTargetV2024 { - /** - * The type of target entity - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2024 - */ - 'type'?: AttributeMappingsAllOfTargetV2024TypeV2024; - /** - * Name of the targeted attribute - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2024 - */ - 'attributeName'?: string; - /** - * The ID of Source - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2024 - */ - 'sourceId'?: string; -} - -export const AttributeMappingsAllOfTargetV2024TypeV2024 = { - Account: 'ACCOUNT', - Identity: 'IDENTITY', - OwnerAccount: 'OWNER_ACCOUNT', - OwnerIdentity: 'OWNER_IDENTITY' -} as const; - -export type AttributeMappingsAllOfTargetV2024TypeV2024 = typeof AttributeMappingsAllOfTargetV2024TypeV2024[keyof typeof AttributeMappingsAllOfTargetV2024TypeV2024]; - -/** - * Attibute Mapping Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024 { - /** - * The name of attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024 - */ - 'attributeName'?: string; - /** - * Name of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024 - */ - 'sourceName'?: string; - /** - * ID of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024 - */ - 'name'?: string; -} -/** - * Input Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2024 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2024 { - /** - * The Type of Attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2024 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2024 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2024; -} -/** - * attributes object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesV2024 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesV2024 { - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputV2024} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesV2024 - */ - 'input'?: AttributeMappingsAllOfTransformDefinitionAttributesInputV2024; -} -/** - * - * @export - * @interface AttributeMappingsAllOfTransformDefinitionV2024 - */ -export interface AttributeMappingsAllOfTransformDefinitionV2024 { - /** - * The type of transform - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2024 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesV2024} - * @memberof AttributeMappingsAllOfTransformDefinitionV2024 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesV2024; - /** - * Transform Operation - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2024 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AttributeMappingsV2024 - */ -export interface AttributeMappingsV2024 { - /** - * - * @type {AttributeMappingsAllOfTargetV2024} - * @memberof AttributeMappingsV2024 - */ - 'target'?: AttributeMappingsAllOfTargetV2024; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionV2024} - * @memberof AttributeMappingsV2024 - */ - 'transformDefinition'?: AttributeMappingsAllOfTransformDefinitionV2024; -} -/** - * - * @export - * @interface AttributeRequestV2024 - */ -export interface AttributeRequestV2024 { - /** - * Attribute name. - * @type {string} - * @memberof AttributeRequestV2024 - */ - 'name'?: string; - /** - * Operation to perform on attribute. - * @type {string} - * @memberof AttributeRequestV2024 - */ - 'op'?: string; - /** - * - * @type {AttributeRequestValueV2024} - * @memberof AttributeRequestV2024 - */ - 'value'?: AttributeRequestValueV2024; -} -/** - * @type AttributeRequestValueV2024 - * Value of attribute. - * @export - */ -export type AttributeRequestValueV2024 = Array | string; - -/** - * - * @export - * @interface AttributeValueDTOV2024 - */ -export interface AttributeValueDTOV2024 { - /** - * Technical name of the Attribute value. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeValueDTOV2024 - */ - 'value'?: string; - /** - * The display name of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2024 - */ - 'name'?: string; - /** - * The status of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2024 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AttributesChangedV2024 - */ -export interface AttributesChangedV2024 { - /** - * - * @type {Array} - * @memberof AttributesChangedV2024 - */ - 'attributeChanges': Array; - /** - * the event type - * @type {string} - * @memberof AttributesChangedV2024 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AttributesChangedV2024 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AttributesChangedV2024 - */ - 'dateTime'?: string; -} -/** - * Audit details for the reassignment configuration of an identity - * @export - * @interface AuditDetailsV2024 - */ -export interface AuditDetailsV2024 { - /** - * Initial date and time when the record was created - * @type {string} - * @memberof AuditDetailsV2024 - */ - 'created'?: string; - /** - * - * @type {Identity1V2024} - * @memberof AuditDetailsV2024 - */ - 'createdBy'?: Identity1V2024; - /** - * Last modified date and time for the record - * @type {string} - * @memberof AuditDetailsV2024 - */ - 'modified'?: string; - /** - * - * @type {Identity1V2024} - * @memberof AuditDetailsV2024 - */ - 'modifiedBy'?: Identity1V2024; -} -/** - * - * @export - * @interface AuthProfileSummaryV2024 - */ -export interface AuthProfileSummaryV2024 { - /** - * Tenant name. - * @type {string} - * @memberof AuthProfileSummaryV2024 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthProfileSummaryV2024 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AuthProfileV2024 - */ -export interface AuthProfileV2024 { - /** - * Authentication Profile name. - * @type {string} - * @memberof AuthProfileV2024 - */ - 'name'?: string; - /** - * Use it to block access from off network. - * @type {boolean} - * @memberof AuthProfileV2024 - */ - 'offNetwork'?: boolean; - /** - * Use it to block access from untrusted geoographies. - * @type {boolean} - * @memberof AuthProfileV2024 - */ - 'untrustedGeography'?: boolean; - /** - * Application ID. - * @type {string} - * @memberof AuthProfileV2024 - */ - 'applicationId'?: string | null; - /** - * Application name. - * @type {string} - * @memberof AuthProfileV2024 - */ - 'applicationName'?: string | null; - /** - * Type of the Authentication Profile. - * @type {string} - * @memberof AuthProfileV2024 - */ - 'type'?: AuthProfileV2024TypeV2024; - /** - * Use it to enable strong authentication. - * @type {boolean} - * @memberof AuthProfileV2024 - */ - 'strongAuthLogin'?: boolean; -} - -export const AuthProfileV2024TypeV2024 = { - Block: 'BLOCK', - Mfa: 'MFA', - NonPta: 'NON_PTA', - Pta: 'PTA' -} as const; - -export type AuthProfileV2024TypeV2024 = typeof AuthProfileV2024TypeV2024[keyof typeof AuthProfileV2024TypeV2024]; - -/** - * - * @export - * @interface AuthUserV2024 - */ -export interface AuthUserV2024 { - /** - * Tenant name. - * @type {string} - * @memberof AuthUserV2024 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthUserV2024 - */ - 'id'?: string; - /** - * Identity\'s unique identitifier. - * @type {string} - * @memberof AuthUserV2024 - */ - 'uid'?: string; - /** - * ID of the auth profile associated with the auth user. - * @type {string} - * @memberof AuthUserV2024 - */ - 'profile'?: string; - /** - * Auth user\'s employee number. - * @type {string} - * @memberof AuthUserV2024 - */ - 'identificationNumber'?: string | null; - /** - * Auth user\'s email. - * @type {string} - * @memberof AuthUserV2024 - */ - 'email'?: string | null; - /** - * Auth user\'s phone number. - * @type {string} - * @memberof AuthUserV2024 - */ - 'phone'?: string | null; - /** - * Auth user\'s work phone number. - * @type {string} - * @memberof AuthUserV2024 - */ - 'workPhone'?: string | null; - /** - * Auth user\'s personal email. - * @type {string} - * @memberof AuthUserV2024 - */ - 'personalEmail'?: string | null; - /** - * Auth user\'s first name. - * @type {string} - * @memberof AuthUserV2024 - */ - 'firstname'?: string | null; - /** - * Auth user\'s last name. - * @type {string} - * @memberof AuthUserV2024 - */ - 'lastname'?: string | null; - /** - * Auth user\'s name in displayed format. - * @type {string} - * @memberof AuthUserV2024 - */ - 'displayName'?: string; - /** - * Auth user\'s alias. - * @type {string} - * @memberof AuthUserV2024 - */ - 'alias'?: string; - /** - * Date of last password change. - * @type {string} - * @memberof AuthUserV2024 - */ - 'lastPasswordChangeDate'?: string | null; - /** - * Timestamp of the last login (long type value). - * @type {number} - * @memberof AuthUserV2024 - */ - 'lastLoginTimestamp'?: number; - /** - * Timestamp of the current login (long type value). - * @type {number} - * @memberof AuthUserV2024 - */ - 'currentLoginTimestamp'?: number; - /** - * The date and time when the user was last unlocked. - * @type {string} - * @memberof AuthUserV2024 - */ - 'lastUnlockTimestamp'?: string | null; - /** - * Array of the auth user\'s capabilities. - * @type {Array} - * @memberof AuthUserV2024 - */ - 'capabilities'?: Array | null; -} - -export const AuthUserV2024CapabilitiesV2024 = { - CertAdmin: 'CERT_ADMIN', - CloudGovAdmin: 'CLOUD_GOV_ADMIN', - CloudGovUser: 'CLOUD_GOV_USER', - Helpdesk: 'HELPDESK', - OrgAdmin: 'ORG_ADMIN', - ReportAdmin: 'REPORT_ADMIN', - RoleAdmin: 'ROLE_ADMIN', - RoleSubadmin: 'ROLE_SUBADMIN', - SaasManagementAdmin: 'SAAS_MANAGEMENT_ADMIN', - SaasManagementReader: 'SAAS_MANAGEMENT_READER', - SourceAdmin: 'SOURCE_ADMIN', - SourceSubadmin: 'SOURCE_SUBADMIN', - DasUiAdministrator: 'das:ui-administrator', - DasUiComplianceManager: 'das:ui-compliance_manager', - DasUiAuditor: 'das:ui-auditor', - DasUiDataScope: 'das:ui-data-scope', - SpAicDashboardRead: 'sp:aic-dashboard-read', - SpAicDashboardWrite: 'sp:aic-dashboard-write', - SpUiConfigHubAdmin: 'sp:ui-config-hub-admin', - SpUiConfigHubBackupAdmin: 'sp:ui-config-hub-backup-admin', - SpUiConfigHubRead: 'sp:ui-config-hub-read' -} as const; - -export type AuthUserV2024CapabilitiesV2024 = typeof AuthUserV2024CapabilitiesV2024[keyof typeof AuthUserV2024CapabilitiesV2024]; - -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptionsV2024 - */ -export interface BackupOptionsV2024 { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptionsV2024 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNamesV2024; }} - * @memberof BackupOptionsV2024 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNamesV2024; }; -} - -export const BackupOptionsV2024IncludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptionsV2024IncludeTypesV2024 = typeof BackupOptionsV2024IncludeTypesV2024[keyof typeof BackupOptionsV2024IncludeTypesV2024]; - -/** - * - * @export - * @interface BackupResponseV2024 - */ -export interface BackupResponseV2024 { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'status'?: BackupResponseV2024StatusV2024; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'type'?: BackupResponseV2024TypeV2024; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponseV2024 - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponseV2024 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponseV2024 - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponseV2024 - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'backupType'?: BackupResponseV2024BackupTypeV2024; - /** - * - * @type {BackupOptionsV2024} - * @memberof BackupResponseV2024 - */ - 'options'?: BackupOptionsV2024 | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'hydrationStatus'?: BackupResponseV2024HydrationStatusV2024; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponseV2024 - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponseV2024 - */ - 'cloudStorageStatus'?: BackupResponseV2024CloudStorageStatusV2024; -} - -export const BackupResponseV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponseV2024StatusV2024 = typeof BackupResponseV2024StatusV2024[keyof typeof BackupResponseV2024StatusV2024]; -export const BackupResponseV2024TypeV2024 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponseV2024TypeV2024 = typeof BackupResponseV2024TypeV2024[keyof typeof BackupResponseV2024TypeV2024]; -export const BackupResponseV2024BackupTypeV2024 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponseV2024BackupTypeV2024 = typeof BackupResponseV2024BackupTypeV2024[keyof typeof BackupResponseV2024BackupTypeV2024]; -export const BackupResponseV2024HydrationStatusV2024 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponseV2024HydrationStatusV2024 = typeof BackupResponseV2024HydrationStatusV2024[keyof typeof BackupResponseV2024HydrationStatusV2024]; -export const BackupResponseV2024CloudStorageStatusV2024 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponseV2024CloudStorageStatusV2024 = typeof BackupResponseV2024CloudStorageStatusV2024[keyof typeof BackupResponseV2024CloudStorageStatusV2024]; - -/** - * - * @export - * @interface Base64DecodeV2024 - */ -export interface Base64DecodeV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64DecodeV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64DecodeV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Base64EncodeV2024 - */ -export interface Base64EncodeV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64EncodeV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64EncodeV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Owner\'s identity. - * @export - * @interface BaseAccessOwnerV2024 - */ -export interface BaseAccessOwnerV2024 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof BaseAccessOwnerV2024 - */ - 'type'?: BaseAccessOwnerV2024TypeV2024; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof BaseAccessOwnerV2024 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof BaseAccessOwnerV2024 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof BaseAccessOwnerV2024 - */ - 'email'?: string; -} - -export const BaseAccessOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type BaseAccessOwnerV2024TypeV2024 = typeof BaseAccessOwnerV2024TypeV2024[keyof typeof BaseAccessOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface BaseAccessProfileV2024 - */ -export interface BaseAccessProfileV2024 { - /** - * Access profile\'s unique ID. - * @type {string} - * @memberof BaseAccessProfileV2024 - */ - 'id'?: string; - /** - * Access profile\'s display name. - * @type {string} - * @memberof BaseAccessProfileV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseAccessV2024 - */ -export interface BaseAccessV2024 { - /** - * Access item\'s description. - * @type {string} - * @memberof BaseAccessV2024 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccessV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof BaseAccessV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof BaseAccessV2024 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof BaseAccessV2024 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof BaseAccessV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof BaseAccessV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2024} - * @memberof BaseAccessV2024 - */ - 'owner'?: BaseAccessOwnerV2024; -} -/** - * - * @export - * @interface BaseAccountV2024 - */ -export interface BaseAccountV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof BaseAccountV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseAccountV2024 - */ - 'name'?: string; - /** - * Account ID. - * @type {string} - * @memberof BaseAccountV2024 - */ - 'accountId'?: string; - /** - * - * @type {AccountSourceV2024} - * @memberof BaseAccountV2024 - */ - 'source'?: AccountSourceV2024; - /** - * Indicates whether the account is disabled. - * @type {boolean} - * @memberof BaseAccountV2024 - */ - 'disabled'?: boolean; - /** - * Indicates whether the account is locked. - * @type {boolean} - * @memberof BaseAccountV2024 - */ - 'locked'?: boolean; - /** - * Indicates whether the account is privileged. - * @type {boolean} - * @memberof BaseAccountV2024 - */ - 'privileged'?: boolean; - /** - * Indicates whether the account has been manually correlated to an identity. - * @type {boolean} - * @memberof BaseAccountV2024 - */ - 'manuallyCorrelated'?: boolean; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof BaseAccountV2024 - */ - 'passwordLastSet'?: string | null; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2024 - */ - 'entitlementAttributes'?: { [key: string]: any; } | null; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccountV2024 - */ - 'created'?: string | null; - /** - * Indicates whether the account supports password change. - * @type {boolean} - * @memberof BaseAccountV2024 - */ - 'supportsPasswordChange'?: boolean; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2024 - */ - 'accountAttributes'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface BaseCommonDtoV2024 - */ -export interface BaseCommonDtoV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDtoV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDtoV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDtoV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDtoV2024 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseDocumentV2024 - */ -export interface BaseDocumentV2024 { - /** - * ID of the referenced object. - * @type {string} - * @memberof BaseDocumentV2024 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseDocumentV2024 - */ - 'name': string; -} -/** - * - * @export - * @interface BaseEntitlementV2024 - */ -export interface BaseEntitlementV2024 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof BaseEntitlementV2024 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof BaseEntitlementV2024 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof BaseEntitlementV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseReferenceDtoV2024 - */ -export interface BaseReferenceDtoV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof BaseReferenceDtoV2024 - */ - 'type'?: DtoTypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface BaseSegmentV2024 - */ -export interface BaseSegmentV2024 { - /** - * Segment\'s unique ID. - * @type {string} - * @memberof BaseSegmentV2024 - */ - 'id'?: string; - /** - * Segment\'s display name. - * @type {string} - * @memberof BaseSegmentV2024 - */ - 'name'?: string; -} -/** - * Config required if BASIC_AUTH is used. - * @export - * @interface BasicAuthConfigV2024 - */ -export interface BasicAuthConfigV2024 { - /** - * The username to authenticate. - * @type {string} - * @memberof BasicAuthConfigV2024 - */ - 'userName'?: string; - /** - * The password to authenticate. On response, this field is set to null as to not return secrets. - * @type {string} - * @memberof BasicAuthConfigV2024 - */ - 'password'?: string | null; -} -/** - * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. - * @export - * @interface BearerTokenAuthConfigV2024 - */ -export interface BearerTokenAuthConfigV2024 { - /** - * Bearer token - * @type {string} - * @memberof BearerTokenAuthConfigV2024 - */ - 'bearerToken'?: string | null; -} -/** - * Before Provisioning Rule. - * @export - * @interface BeforeProvisioningRuleDtoV2024 - */ -export interface BeforeProvisioningRuleDtoV2024 { - /** - * Before Provisioning Rule DTO type. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2024 - */ - 'type'?: BeforeProvisioningRuleDtoV2024TypeV2024; - /** - * Before Provisioning Rule ID. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2024 - */ - 'id'?: string; - /** - * Rule display name. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2024 - */ - 'name'?: string; -} - -export const BeforeProvisioningRuleDtoV2024TypeV2024 = { - Rule: 'RULE' -} as const; - -export type BeforeProvisioningRuleDtoV2024TypeV2024 = typeof BeforeProvisioningRuleDtoV2024TypeV2024[keyof typeof BeforeProvisioningRuleDtoV2024TypeV2024]; - -/** - * - * @export - * @interface BoundV2024 - */ -export interface BoundV2024 { - /** - * The value of the range\'s endpoint. - * @type {string} - * @memberof BoundV2024 - */ - 'value': string; - /** - * Indicates if the endpoint is included in the range. - * @type {boolean} - * @memberof BoundV2024 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface BrandingItemCreateV2024 - */ -export interface BrandingItemCreateV2024 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'name': string; - /** - * product name - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'productName': string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'actionButtonColor'?: string; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'activeLinkColor'?: string; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'navigationColor'?: string; - /** - * email from address - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'emailFromAddress'?: string; - /** - * login information message - * @type {string} - * @memberof BrandingItemCreateV2024 - */ - 'loginInformationalMessage'?: string; - /** - * png file with logo - * @type {File} - * @memberof BrandingItemCreateV2024 - */ - 'fileStandard'?: File; -} -/** - * - * @export - * @interface BrandingItemV2024 - */ -export interface BrandingItemV2024 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemV2024 - */ - 'name'?: string; - /** - * product name - * @type {string} - * @memberof BrandingItemV2024 - */ - 'productName'?: string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemV2024 - */ - 'actionButtonColor'?: string | null; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemV2024 - */ - 'activeLinkColor'?: string | null; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemV2024 - */ - 'navigationColor'?: string | null; - /** - * email from address - * @type {string} - * @memberof BrandingItemV2024 - */ - 'emailFromAddress'?: string | null; - /** - * url to standard logo - * @type {string} - * @memberof BrandingItemV2024 - */ - 'standardLogoURL'?: string | null; - /** - * login information message - * @type {string} - * @memberof BrandingItemV2024 - */ - 'loginInformationalMessage'?: string | null; -} -/** - * The bucket to group the results of the aggregation query by. - * @export - * @interface BucketAggregationV2024 - */ -export interface BucketAggregationV2024 { - /** - * The name of the bucket aggregate to be included in the result. - * @type {string} - * @memberof BucketAggregationV2024 - */ - 'name': string; - /** - * - * @type {BucketTypeV2024} - * @memberof BucketAggregationV2024 - */ - 'type'?: BucketTypeV2024; - /** - * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof BucketAggregationV2024 - */ - 'field': string; - /** - * Maximum number of buckets to include. - * @type {number} - * @memberof BucketAggregationV2024 - */ - 'size'?: number; - /** - * Minimum number of documents a bucket should have. - * @type {number} - * @memberof BucketAggregationV2024 - */ - 'minDocCount'?: number; -} - - -/** - * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const BucketTypeV2024 = { - Terms: 'TERMS' -} as const; - -export type BucketTypeV2024 = typeof BucketTypeV2024[keyof typeof BucketTypeV2024]; - - -/** - * - * @export - * @interface BulkAddTaggedObjectV2024 - */ -export interface BulkAddTaggedObjectV2024 { - /** - * - * @type {Array} - * @memberof BulkAddTaggedObjectV2024 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkAddTaggedObjectV2024 - */ - 'tags'?: Array; - /** - * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - * @type {string} - * @memberof BulkAddTaggedObjectV2024 - */ - 'operation'?: BulkAddTaggedObjectV2024OperationV2024; -} - -export const BulkAddTaggedObjectV2024OperationV2024 = { - Append: 'APPEND', - Merge: 'MERGE' -} as const; - -export type BulkAddTaggedObjectV2024OperationV2024 = typeof BulkAddTaggedObjectV2024OperationV2024[keyof typeof BulkAddTaggedObjectV2024OperationV2024]; - -/** - * Request body payload for bulk approve access request endpoint. - * @export - * @interface BulkApproveAccessRequestV2024 - */ -export interface BulkApproveAccessRequestV2024 { - /** - * List of approval ids to approve the pending requests - * @type {Array} - * @memberof BulkApproveAccessRequestV2024 - */ - 'approvalIds': Array; - /** - * Reason for approving the pending access request. - * @type {string} - * @memberof BulkApproveAccessRequestV2024 - */ - 'comment': string; -} -/** - * Request body payload for bulk cancel access request endpoint. - * @export - * @interface BulkCancelAccessRequestV2024 - */ -export interface BulkCancelAccessRequestV2024 { - /** - * List of access requests ids to cancel the pending requests - * @type {Array} - * @memberof BulkCancelAccessRequestV2024 - */ - 'accessRequestIds': Array; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof BulkCancelAccessRequestV2024 - */ - 'comment': string; -} -/** - * Bulk response object. - * @export - * @interface BulkIdentitiesAccountsResponseV2024 - */ -export interface BulkIdentitiesAccountsResponseV2024 { - /** - * Identifier of bulk request item. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2024 - */ - 'id'?: string; - /** - * Response status value. - * @type {number} - * @memberof BulkIdentitiesAccountsResponseV2024 - */ - 'statusCode'?: number; - /** - * Status containing additional context information about failures. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2024 - */ - 'message'?: string; -} -/** - * - * @export - * @interface BulkRemoveTaggedObjectV2024 - */ -export interface BulkRemoveTaggedObjectV2024 { - /** - * - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2024 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2024 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface BulkTaggedObjectResponseV2024 - */ -export interface BulkTaggedObjectResponseV2024 { - /** - * - * @type {Array} - * @memberof BulkTaggedObjectResponseV2024 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkTaggedObjectResponseV2024 - */ - 'tags'?: Array; -} -/** - * Details of the identity that owns the campaign. - * @export - * @interface CampaignActivatedCampaignCampaignOwnerV2024 - */ -export interface CampaignActivatedCampaignCampaignOwnerV2024 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2024 - */ - 'id': string; - /** - * The human friendly name of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2024 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2024 - */ - 'email': string; -} -/** - * Details about the certification campaign that was activated. - * @export - * @interface CampaignActivatedCampaignV2024 - */ -export interface CampaignActivatedCampaignV2024 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignActivatedCampaignV2024 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2024 - */ - 'type': CampaignActivatedCampaignV2024TypeV2024; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2024} - * @memberof CampaignActivatedCampaignV2024 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2024; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2024 - */ - 'status': CampaignActivatedCampaignV2024StatusV2024; -} - -export const CampaignActivatedCampaignV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignActivatedCampaignV2024TypeV2024 = typeof CampaignActivatedCampaignV2024TypeV2024[keyof typeof CampaignActivatedCampaignV2024TypeV2024]; -export const CampaignActivatedCampaignV2024StatusV2024 = { - Active: 'ACTIVE' -} as const; - -export type CampaignActivatedCampaignV2024StatusV2024 = typeof CampaignActivatedCampaignV2024StatusV2024[keyof typeof CampaignActivatedCampaignV2024StatusV2024]; - -/** - * - * @export - * @interface CampaignActivatedV2024 - */ -export interface CampaignActivatedV2024 { - /** - * - * @type {CampaignActivatedCampaignV2024} - * @memberof CampaignActivatedV2024 - */ - 'campaign': CampaignActivatedCampaignV2024; -} -/** - * - * @export - * @interface CampaignAlertV2024 - */ -export interface CampaignAlertV2024 { - /** - * Denotes the level of the message - * @type {string} - * @memberof CampaignAlertV2024 - */ - 'level'?: CampaignAlertV2024LevelV2024; - /** - * - * @type {Array} - * @memberof CampaignAlertV2024 - */ - 'localizations'?: Array; -} - -export const CampaignAlertV2024LevelV2024 = { - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO' -} as const; - -export type CampaignAlertV2024LevelV2024 = typeof CampaignAlertV2024LevelV2024[keyof typeof CampaignAlertV2024LevelV2024]; - -/** - * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - * @export - * @interface CampaignAllOfFilterV2024 - */ -export interface CampaignAllOfFilterV2024 { - /** - * The ID of whatever type of filter is being used. - * @type {string} - * @memberof CampaignAllOfFilterV2024 - */ - 'id'?: string; - /** - * Type of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2024 - */ - 'type'?: CampaignAllOfFilterV2024TypeV2024; - /** - * Name of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2024 - */ - 'name'?: string; -} - -export const CampaignAllOfFilterV2024TypeV2024 = { - CampaignFilter: 'CAMPAIGN_FILTER' -} as const; - -export type CampaignAllOfFilterV2024TypeV2024 = typeof CampaignAllOfFilterV2024TypeV2024[keyof typeof CampaignAllOfFilterV2024TypeV2024]; - -/** - * Must be set only if the campaign type is MACHINE_ACCOUNT. - * @export - * @interface CampaignAllOfMachineAccountCampaignInfoV2024 - */ -export interface CampaignAllOfMachineAccountCampaignInfoV2024 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2024 - */ - 'sourceIds'?: Array; - /** - * The reviewer\'s type. - * @type {string} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2024 - */ - 'reviewerType'?: CampaignAllOfMachineAccountCampaignInfoV2024ReviewerTypeV2024; -} - -export const CampaignAllOfMachineAccountCampaignInfoV2024ReviewerTypeV2024 = { - AccountOwner: 'ACCOUNT_OWNER' -} as const; - -export type CampaignAllOfMachineAccountCampaignInfoV2024ReviewerTypeV2024 = typeof CampaignAllOfMachineAccountCampaignInfoV2024ReviewerTypeV2024[keyof typeof CampaignAllOfMachineAccountCampaignInfoV2024ReviewerTypeV2024]; - -/** - * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024 { - /** - * Legal Remediator Type - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024 - */ - 'type': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024TypeV2024; - /** - * The ID of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024 - */ - 'id': string; - /** - * The name of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024TypeV2024 = typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024TypeV2024[keyof typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024TypeV2024]; - -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 - */ - 'type'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2024TypeV2024; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoReviewerV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoReviewerV2024TypeV2024 = typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2024TypeV2024[keyof typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2024TypeV2024]; - -/** - * Optional configuration options for role composition campaigns. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoV2024 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoV2024 { - /** - * The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - * @deprecated - */ - 'reviewerId'?: string | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoReviewerV2024} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - */ - 'reviewer'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2024 | null; - /** - * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {Array} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - */ - 'roleIds'?: Array; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - */ - 'remediatorRef': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2024; - /** - * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - */ - 'query'?: string | null; - /** - * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2024 - */ - 'description'?: string | null; -} -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfSearchCampaignInfoReviewerV2024 - */ -export interface CampaignAllOfSearchCampaignInfoReviewerV2024 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2024 - */ - 'type'?: CampaignAllOfSearchCampaignInfoReviewerV2024TypeV2024; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2024 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2024 - */ - 'name'?: string | null; -} - -export const CampaignAllOfSearchCampaignInfoReviewerV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfSearchCampaignInfoReviewerV2024TypeV2024 = typeof CampaignAllOfSearchCampaignInfoReviewerV2024TypeV2024[keyof typeof CampaignAllOfSearchCampaignInfoReviewerV2024TypeV2024]; - -/** - * Must be set only if the campaign type is SEARCH. - * @export - * @interface CampaignAllOfSearchCampaignInfoV2024 - */ -export interface CampaignAllOfSearchCampaignInfoV2024 { - /** - * The type of search campaign represented. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'type': CampaignAllOfSearchCampaignInfoV2024TypeV2024; - /** - * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'description'?: string; - /** - * - * @type {CampaignAllOfSearchCampaignInfoReviewerV2024} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'reviewer'?: CampaignAllOfSearchCampaignInfoReviewerV2024 | null; - /** - * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'query'?: string | null; - /** - * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'identityIds'?: Array | null; - /** - * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2024 - */ - 'accessConstraints'?: Array; -} - -export const CampaignAllOfSearchCampaignInfoV2024TypeV2024 = { - Identity: 'IDENTITY', - Access: 'ACCESS' -} as const; - -export type CampaignAllOfSearchCampaignInfoV2024TypeV2024 = typeof CampaignAllOfSearchCampaignInfoV2024TypeV2024[keyof typeof CampaignAllOfSearchCampaignInfoV2024TypeV2024]; - -/** - * Must be set only if the campaign type is SOURCE_OWNER. - * @export - * @interface CampaignAllOfSourceOwnerCampaignInfoV2024 - */ -export interface CampaignAllOfSourceOwnerCampaignInfoV2024 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfSourceOwnerCampaignInfoV2024 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface CampaignAllOfSourcesWithOrphanEntitlementsV2024 - */ -export interface CampaignAllOfSourcesWithOrphanEntitlementsV2024 { - /** - * Id of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2024 - */ - 'id'?: string; - /** - * Type - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2024 - */ - 'type'?: CampaignAllOfSourcesWithOrphanEntitlementsV2024TypeV2024; - /** - * Name of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2024 - */ - 'name'?: string; -} - -export const CampaignAllOfSourcesWithOrphanEntitlementsV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type CampaignAllOfSourcesWithOrphanEntitlementsV2024TypeV2024 = typeof CampaignAllOfSourcesWithOrphanEntitlementsV2024TypeV2024[keyof typeof CampaignAllOfSourcesWithOrphanEntitlementsV2024TypeV2024]; - -/** - * - * @export - * @interface CampaignCompleteOptionsV2024 - */ -export interface CampaignCompleteOptionsV2024 { - /** - * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - * @type {string} - * @memberof CampaignCompleteOptionsV2024 - */ - 'autoCompleteAction'?: CampaignCompleteOptionsV2024AutoCompleteActionV2024; -} - -export const CampaignCompleteOptionsV2024AutoCompleteActionV2024 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CampaignCompleteOptionsV2024AutoCompleteActionV2024 = typeof CampaignCompleteOptionsV2024AutoCompleteActionV2024[keyof typeof CampaignCompleteOptionsV2024AutoCompleteActionV2024]; - -/** - * Details about the certification campaign that ended. - * @export - * @interface CampaignEndedCampaignV2024 - */ -export interface CampaignEndedCampaignV2024 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignEndedCampaignV2024 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2024 - */ - 'type': CampaignEndedCampaignV2024TypeV2024; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2024} - * @memberof CampaignEndedCampaignV2024 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2024; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2024 - */ - 'status': CampaignEndedCampaignV2024StatusV2024; -} - -export const CampaignEndedCampaignV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignEndedCampaignV2024TypeV2024 = typeof CampaignEndedCampaignV2024TypeV2024[keyof typeof CampaignEndedCampaignV2024TypeV2024]; -export const CampaignEndedCampaignV2024StatusV2024 = { - Completed: 'COMPLETED' -} as const; - -export type CampaignEndedCampaignV2024StatusV2024 = typeof CampaignEndedCampaignV2024StatusV2024[keyof typeof CampaignEndedCampaignV2024StatusV2024]; - -/** - * - * @export - * @interface CampaignEndedV2024 - */ -export interface CampaignEndedV2024 { - /** - * - * @type {CampaignEndedCampaignV2024} - * @memberof CampaignEndedV2024 - */ - 'campaign': CampaignEndedCampaignV2024; -} -/** - * - * @export - * @interface CampaignFilterDetailsCriteriaListInnerV2024 - */ -export interface CampaignFilterDetailsCriteriaListInnerV2024 { - /** - * - * @type {CriteriaTypeV2024} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'type': CriteriaTypeV2024; - /** - * - * @type {OperationV2024} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'operation'?: OperationV2024 | null; - /** - * Specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'property': string | null; - /** - * Value for the specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'value': string | null; - /** - * If true, the filter will negate the result of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'negateResult'?: boolean; - /** - * If true, the filter will short circuit the evaluation of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'shortCircuit'?: boolean; - /** - * If true, the filter will record child matches for the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'recordChildMatches'?: boolean; - /** - * The unique ID of the criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'id'?: string | null; - /** - * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'suppressMatchedItems'?: boolean; - /** - * List of child criteria. - * @type {Array} - * @memberof CampaignFilterDetailsCriteriaListInnerV2024 - */ - 'children'?: Array; -} - - -/** - * Campaign Filter Details - * @export - * @interface CampaignFilterDetailsV2024 - */ -export interface CampaignFilterDetailsV2024 { - /** - * The unique ID of the campaign filter - * @type {string} - * @memberof CampaignFilterDetailsV2024 - */ - 'id': string; - /** - * Campaign filter name. - * @type {string} - * @memberof CampaignFilterDetailsV2024 - */ - 'name': string; - /** - * Campaign filter description. - * @type {string} - * @memberof CampaignFilterDetailsV2024 - */ - 'description'?: string; - /** - * Owner of the filter. This field automatically populates at creation time with the current user. - * @type {string} - * @memberof CampaignFilterDetailsV2024 - */ - 'owner': string | null; - /** - * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. - * @type {string} - * @memberof CampaignFilterDetailsV2024 - */ - 'mode': CampaignFilterDetailsV2024ModeV2024; - /** - * List of criteria. - * @type {Array} - * @memberof CampaignFilterDetailsV2024 - */ - 'criteriaList'?: Array; - /** - * If true, the filter is created by the system. If false, the filter is created by a user. - * @type {boolean} - * @memberof CampaignFilterDetailsV2024 - */ - 'isSystemFilter': boolean; -} - -export const CampaignFilterDetailsV2024ModeV2024 = { - Inclusion: 'INCLUSION', - Exclusion: 'EXCLUSION' -} as const; - -export type CampaignFilterDetailsV2024ModeV2024 = typeof CampaignFilterDetailsV2024ModeV2024[keyof typeof CampaignFilterDetailsV2024ModeV2024]; - -/** - * The identity that owns the campaign. - * @export - * @interface CampaignGeneratedCampaignCampaignOwnerV2024 - */ -export interface CampaignGeneratedCampaignCampaignOwnerV2024 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2024 - */ - 'id': string; - /** - * The display name of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2024 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2024 - */ - 'email': string; -} -/** - * Details about the campaign that was generated. - * @export - * @interface CampaignGeneratedCampaignV2024 - */ -export interface CampaignGeneratedCampaignV2024 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'id': string; - /** - * Human friendly name of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'modified'?: string | null; - /** - * The date and time when the campaign must be finished by. - * @type {string} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'deadline'?: string | null; - /** - * The type of campaign that was generated. - * @type {object} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'type': CampaignGeneratedCampaignV2024TypeV2024; - /** - * - * @type {CampaignGeneratedCampaignCampaignOwnerV2024} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'campaignOwner': CampaignGeneratedCampaignCampaignOwnerV2024; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignGeneratedCampaignV2024 - */ - 'status': CampaignGeneratedCampaignV2024StatusV2024; -} - -export const CampaignGeneratedCampaignV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignGeneratedCampaignV2024TypeV2024 = typeof CampaignGeneratedCampaignV2024TypeV2024[keyof typeof CampaignGeneratedCampaignV2024TypeV2024]; -export const CampaignGeneratedCampaignV2024StatusV2024 = { - Staged: 'STAGED', - Activating: 'ACTIVATING', - Active: 'ACTIVE' -} as const; - -export type CampaignGeneratedCampaignV2024StatusV2024 = typeof CampaignGeneratedCampaignV2024StatusV2024[keyof typeof CampaignGeneratedCampaignV2024StatusV2024]; - -/** - * - * @export - * @interface CampaignGeneratedV2024 - */ -export interface CampaignGeneratedV2024 { - /** - * - * @type {CampaignGeneratedCampaignV2024} - * @memberof CampaignGeneratedV2024 - */ - 'campaign': CampaignGeneratedCampaignV2024; -} -/** - * - * @export - * @interface CampaignReferenceV2024 - */ -export interface CampaignReferenceV2024 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'id': string; - /** - * The name of the campaign. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'name': string; - /** - * The type of object that is being referenced. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'type': CampaignReferenceV2024TypeV2024; - /** - * The type of the campaign. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'campaignType': CampaignReferenceV2024CampaignTypeV2024; - /** - * The description of the campaign set by the admin who created it. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'description': string | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'correlatedStatus': CampaignReferenceV2024CorrelatedStatusV2024; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignReferenceV2024 - */ - 'mandatoryCommentRequirement': CampaignReferenceV2024MandatoryCommentRequirementV2024; -} - -export const CampaignReferenceV2024TypeV2024 = { - Campaign: 'CAMPAIGN' -} as const; - -export type CampaignReferenceV2024TypeV2024 = typeof CampaignReferenceV2024TypeV2024[keyof typeof CampaignReferenceV2024TypeV2024]; -export const CampaignReferenceV2024CampaignTypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignReferenceV2024CampaignTypeV2024 = typeof CampaignReferenceV2024CampaignTypeV2024[keyof typeof CampaignReferenceV2024CampaignTypeV2024]; -export const CampaignReferenceV2024CorrelatedStatusV2024 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignReferenceV2024CorrelatedStatusV2024 = typeof CampaignReferenceV2024CorrelatedStatusV2024[keyof typeof CampaignReferenceV2024CorrelatedStatusV2024]; -export const CampaignReferenceV2024MandatoryCommentRequirementV2024 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignReferenceV2024MandatoryCommentRequirementV2024 = typeof CampaignReferenceV2024MandatoryCommentRequirementV2024[keyof typeof CampaignReferenceV2024MandatoryCommentRequirementV2024]; - -/** - * - * @export - * @interface CampaignReportV2024 - */ -export interface CampaignReportV2024 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof CampaignReportV2024 - */ - 'type'?: CampaignReportV2024TypeV2024; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof CampaignReportV2024 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof CampaignReportV2024 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof CampaignReportV2024 - */ - 'status'?: CampaignReportV2024StatusV2024; - /** - * - * @type {ReportTypeV2024} - * @memberof CampaignReportV2024 - */ - 'reportType': ReportTypeV2024; - /** - * The most recent date and time this report was run - * @type {string} - * @memberof CampaignReportV2024 - */ - 'lastRunAt'?: string; -} - -export const CampaignReportV2024TypeV2024 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type CampaignReportV2024TypeV2024 = typeof CampaignReportV2024TypeV2024[keyof typeof CampaignReportV2024TypeV2024]; -export const CampaignReportV2024StatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type CampaignReportV2024StatusV2024 = typeof CampaignReportV2024StatusV2024[keyof typeof CampaignReportV2024StatusV2024]; - -/** - * - * @export - * @interface CampaignReportsConfigV2024 - */ -export interface CampaignReportsConfigV2024 { - /** - * list of identity attribute columns - * @type {Array} - * @memberof CampaignReportsConfigV2024 - */ - 'identityAttributeColumns'?: Array | null; -} -/** - * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. - * @export - * @interface CampaignTemplateOwnerRefV2024 - */ -export interface CampaignTemplateOwnerRefV2024 { - /** - * Id of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2024 - */ - 'id'?: string; - /** - * Type of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2024 - */ - 'type'?: CampaignTemplateOwnerRefV2024TypeV2024; - /** - * Name of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2024 - */ - 'name'?: string; - /** - * Email of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2024 - */ - 'email'?: string; -} - -export const CampaignTemplateOwnerRefV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignTemplateOwnerRefV2024TypeV2024 = typeof CampaignTemplateOwnerRefV2024TypeV2024[keyof typeof CampaignTemplateOwnerRefV2024TypeV2024]; - -/** - * Campaign Template - * @export - * @interface CampaignTemplateV2024 - */ -export interface CampaignTemplateV2024 { - /** - * Id of the campaign template - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'id'?: string; - /** - * This template\'s name. Has no bearing on generated campaigns\' names. - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'name': string; - /** - * This template\'s description. Has no bearing on generated campaigns\' descriptions. - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'description': string; - /** - * Creation date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'created': string; - /** - * Modification date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'modified': string | null; - /** - * Indicates if this campaign template has been scheduled. - * @type {boolean} - * @memberof CampaignTemplateV2024 - */ - 'scheduled'?: boolean; - /** - * - * @type {CampaignTemplateOwnerRefV2024} - * @memberof CampaignTemplateV2024 - */ - 'ownerRef'?: CampaignTemplateOwnerRefV2024; - /** - * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). - * @type {string} - * @memberof CampaignTemplateV2024 - */ - 'deadlineDuration'?: string | null; - /** - * - * @type {CampaignV2024} - * @memberof CampaignTemplateV2024 - */ - 'campaign': CampaignV2024; -} -/** - * - * @export - * @interface CampaignV2024 - */ -export interface CampaignV2024 { - /** - * Id of the campaign - * @type {string} - * @memberof CampaignV2024 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2024 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2024 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof CampaignV2024 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof CampaignV2024 - */ - 'type': CampaignV2024TypeV2024; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof CampaignV2024 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof CampaignV2024 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof CampaignV2024 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof CampaignV2024 - */ - 'status'?: CampaignV2024StatusV2024 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignV2024 - */ - 'correlatedStatus'?: CampaignV2024CorrelatedStatusV2024; - /** - * Created time of the campaign - * @type {string} - * @memberof CampaignV2024 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof CampaignV2024 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof CampaignV2024 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof CampaignV2024 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof CampaignV2024 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2024} - * @memberof CampaignV2024 - */ - 'filter'?: CampaignAllOfFilterV2024 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof CampaignV2024 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2024} - * @memberof CampaignV2024 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2024} - * @memberof CampaignV2024 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2024} - * @memberof CampaignV2024 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2024} - * @memberof CampaignV2024 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2024 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof CampaignV2024 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignV2024 - */ - 'mandatoryCommentRequirement'?: CampaignV2024MandatoryCommentRequirementV2024; -} - -export const CampaignV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignV2024TypeV2024 = typeof CampaignV2024TypeV2024[keyof typeof CampaignV2024TypeV2024]; -export const CampaignV2024StatusV2024 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type CampaignV2024StatusV2024 = typeof CampaignV2024StatusV2024[keyof typeof CampaignV2024StatusV2024]; -export const CampaignV2024CorrelatedStatusV2024 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignV2024CorrelatedStatusV2024 = typeof CampaignV2024CorrelatedStatusV2024[keyof typeof CampaignV2024CorrelatedStatusV2024]; -export const CampaignV2024MandatoryCommentRequirementV2024 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignV2024MandatoryCommentRequirementV2024 = typeof CampaignV2024MandatoryCommentRequirementV2024[keyof typeof CampaignV2024MandatoryCommentRequirementV2024]; - -/** - * - * @export - * @interface CampaignsDeleteRequestV2024 - */ -export interface CampaignsDeleteRequestV2024 { - /** - * The ids of the campaigns to delete - * @type {Array} - * @memberof CampaignsDeleteRequestV2024 - */ - 'ids'?: Array; -} -/** - * Request body payload for cancel access request endpoint. - * @export - * @interface CancelAccessRequestV2024 - */ -export interface CancelAccessRequestV2024 { - /** - * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - * @type {string} - * @memberof CancelAccessRequestV2024 - */ - 'accountActivityId': string; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof CancelAccessRequestV2024 - */ - 'comment': string; -} -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetailsV2024 - */ -export interface CancelledRequestDetailsV2024 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2024 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2024} - * @memberof CancelledRequestDetailsV2024 - */ - 'owner'?: OwnerDtoV2024; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2024 - */ - 'modified'?: string; -} -/** - * The decision to approve or revoke the review item - * @export - * @enum {string} - */ - -export const CertificationDecisionV2024 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CertificationDecisionV2024 = typeof CertificationDecisionV2024[keyof typeof CertificationDecisionV2024]; - - -/** - * - * @export - * @interface CertificationDtoV2024 - */ -export interface CertificationDtoV2024 { - /** - * - * @type {CampaignReferenceV2024} - * @memberof CertificationDtoV2024 - */ - 'campaignRef': CampaignReferenceV2024; - /** - * - * @type {CertificationPhaseV2024} - * @memberof CertificationDtoV2024 - */ - 'phase': CertificationPhaseV2024; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationDtoV2024 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationDtoV2024 - */ - 'signed': string; - /** - * - * @type {ReviewerV2024} - * @memberof CertificationDtoV2024 - */ - 'reviewer': ReviewerV2024; - /** - * - * @type {ReassignmentV2024} - * @memberof CertificationDtoV2024 - */ - 'reassignment'?: ReassignmentV2024 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationDtoV2024 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationDtoV2024 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationDtoV2024 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationDtoV2024 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationDtoV2024 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationDtoV2024 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationDtoV2024 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationIdentitySummaryV2024 - */ -export interface CertificationIdentitySummaryV2024 { - /** - * The ID of the identity summary - * @type {string} - * @memberof CertificationIdentitySummaryV2024 - */ - 'id'?: string; - /** - * Name of the linked identity - * @type {string} - * @memberof CertificationIdentitySummaryV2024 - */ - 'name'?: string; - /** - * The ID of the identity being certified - * @type {string} - * @memberof CertificationIdentitySummaryV2024 - */ - 'identityId'?: string; - /** - * Indicates whether the review items for the linked identity\'s certification have been completed - * @type {boolean} - * @memberof CertificationIdentitySummaryV2024 - */ - 'completed'?: boolean; -} -/** - * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - * @export - * @enum {string} - */ - -export const CertificationPhaseV2024 = { - Staged: 'STAGED', - Active: 'ACTIVE', - Signed: 'SIGNED' -} as const; - -export type CertificationPhaseV2024 = typeof CertificationPhaseV2024[keyof typeof CertificationPhaseV2024]; - - -/** - * - * @export - * @interface CertificationReferenceV2024 - */ -export interface CertificationReferenceV2024 { - /** - * The id of the certification. - * @type {string} - * @memberof CertificationReferenceV2024 - */ - 'id'?: string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationReferenceV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof CertificationReferenceV2024 - */ - 'type'?: CertificationReferenceV2024TypeV2024; - /** - * - * @type {ReviewerV2024} - * @memberof CertificationReferenceV2024 - */ - 'reviewer'?: ReviewerV2024; -} - -export const CertificationReferenceV2024TypeV2024 = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceV2024TypeV2024 = typeof CertificationReferenceV2024TypeV2024[keyof typeof CertificationReferenceV2024TypeV2024]; - -/** - * The certification campaign that was signed off on. - * @export - * @interface CertificationSignedOffCertificationV2024 - */ -export interface CertificationSignedOffCertificationV2024 { - /** - * Unique ID of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'id': string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'name': string; - /** - * The date and time the certification was created. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'created': string; - /** - * The date and time the certification was last modified. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignReferenceV2024} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'campaignRef': CampaignReferenceV2024; - /** - * - * @type {CertificationPhaseV2024} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'phase': CertificationPhaseV2024; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'signed': string; - /** - * - * @type {ReviewerV2024} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'reviewer': ReviewerV2024; - /** - * - * @type {ReassignmentV2024} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'reassignment'?: ReassignmentV2024 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2024 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationSignedOffV2024 - */ -export interface CertificationSignedOffV2024 { - /** - * - * @type {CertificationSignedOffCertificationV2024} - * @memberof CertificationSignedOffV2024 - */ - 'certification': CertificationSignedOffCertificationV2024; -} -/** - * - * @export - * @interface CertificationTaskV2024 - */ -export interface CertificationTaskV2024 { - /** - * The ID of the certification task. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'id'?: string; - /** - * The type of the certification task. More values may be added in the future. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'type'?: CertificationTaskV2024TypeV2024; - /** - * The type of item that is being operated on by this task whose ID is stored in the targetId field. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'targetType'?: CertificationTaskV2024TargetTypeV2024; - /** - * The ID of the item being operated on by this task. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'targetId'?: string; - /** - * The status of the task. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'status'?: CertificationTaskV2024StatusV2024; - /** - * List of error messages - * @type {Array} - * @memberof CertificationTaskV2024 - */ - 'errors'?: Array; - /** - * Reassignment trails that lead to self certification identity - * @type {Array} - * @memberof CertificationTaskV2024 - */ - 'reassignmentTrailDTOs'?: Array; - /** - * The date and time on which this task was created. - * @type {string} - * @memberof CertificationTaskV2024 - */ - 'created'?: string; -} - -export const CertificationTaskV2024TypeV2024 = { - Reassign: 'REASSIGN', - AdminReassign: 'ADMIN_REASSIGN', - CompleteCertification: 'COMPLETE_CERTIFICATION', - FinishCertification: 'FINISH_CERTIFICATION', - CompleteCampaign: 'COMPLETE_CAMPAIGN', - ActivateCampaign: 'ACTIVATE_CAMPAIGN', - CampaignCreate: 'CAMPAIGN_CREATE', - CampaignDelete: 'CAMPAIGN_DELETE' -} as const; - -export type CertificationTaskV2024TypeV2024 = typeof CertificationTaskV2024TypeV2024[keyof typeof CertificationTaskV2024TypeV2024]; -export const CertificationTaskV2024TargetTypeV2024 = { - Certification: 'CERTIFICATION', - Campaign: 'CAMPAIGN' -} as const; - -export type CertificationTaskV2024TargetTypeV2024 = typeof CertificationTaskV2024TargetTypeV2024[keyof typeof CertificationTaskV2024TargetTypeV2024]; -export const CertificationTaskV2024StatusV2024 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type CertificationTaskV2024StatusV2024 = typeof CertificationTaskV2024StatusV2024[keyof typeof CertificationTaskV2024StatusV2024]; - -/** - * - * @export - * @interface CertificationV2024 - */ -export interface CertificationV2024 { - /** - * id of the certification - * @type {string} - * @memberof CertificationV2024 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof CertificationV2024 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2024} - * @memberof CertificationV2024 - */ - 'campaign'?: CampaignReferenceV2024; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof CertificationV2024 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof CertificationV2024 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof CertificationV2024 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof CertificationV2024 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof CertificationV2024 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof CertificationV2024 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof CertificationV2024 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationV2024 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof CertificationV2024 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2024} - * @memberof CertificationV2024 - */ - 'reviewer'?: ReviewerV2024; - /** - * - * @type {ReassignmentV2024} - * @memberof CertificationV2024 - */ - 'reassignment'?: ReassignmentV2024 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof CertificationV2024 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof CertificationV2024 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2024} - * @memberof CertificationV2024 - */ - 'phase'?: CertificationPhaseV2024; -} - - -/** - * - * @export - * @interface CertifierResponseV2024 - */ -export interface CertifierResponseV2024 { - /** - * the id of the certifier - * @type {string} - * @memberof CertifierResponseV2024 - */ - 'id'?: string; - /** - * the name of the certifier - * @type {string} - * @memberof CertifierResponseV2024 - */ - 'displayName'?: string; -} -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationDurationMinutesV2024 - */ -export interface ClientLogConfigurationDurationMinutesV2024 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationDurationMinutesV2024 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationDurationMinutesV2024 - */ - 'durationMinutes'?: number; - /** - * - * @type {StandardLevelV2024} - * @memberof ClientLogConfigurationDurationMinutesV2024 - */ - 'rootLevel': StandardLevelV2024; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2024; }} - * @memberof ClientLogConfigurationDurationMinutesV2024 - */ - 'logLevels'?: { [key: string]: StandardLevelV2024; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationExpirationV2024 - */ -export interface ClientLogConfigurationExpirationV2024 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationExpirationV2024 - */ - 'clientId'?: string; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationExpirationV2024 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2024} - * @memberof ClientLogConfigurationExpirationV2024 - */ - 'rootLevel': StandardLevelV2024; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2024; }} - * @memberof ClientLogConfigurationExpirationV2024 - */ - 'logLevels'?: { [key: string]: StandardLevelV2024; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationV2024 - */ -export interface ClientLogConfigurationV2024 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationV2024 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationV2024 - */ - 'durationMinutes'?: number; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationV2024 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2024} - * @memberof ClientLogConfigurationV2024 - */ - 'rootLevel': StandardLevelV2024; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2024; }} - * @memberof ClientLogConfigurationV2024 - */ - 'logLevels'?: { [key: string]: StandardLevelV2024; }; -} - - -/** - * Type of an API Client indicating public or confidentials use - * @export - * @enum {string} - */ - -export const ClientTypeV2024 = { - Confidential: 'CONFIDENTIAL', - Public: 'PUBLIC' -} as const; - -export type ClientTypeV2024 = typeof ClientTypeV2024[keyof typeof ClientTypeV2024]; - - -/** - * Request body payload for close access requests endpoint. - * @export - * @interface CloseAccessRequestV2024 - */ -export interface CloseAccessRequestV2024 { - /** - * Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. - * @type {Array} - * @memberof CloseAccessRequestV2024 - */ - 'accessRequestIds': Array; - /** - * Reason for closing the access request. Displayed under Warnings in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2024 - */ - 'message'?: string; - /** - * The request\'s provisioning status. Displayed as Stage in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2024 - */ - 'executionStatus'?: CloseAccessRequestV2024ExecutionStatusV2024; - /** - * The request\'s overall status. Displayed as Status in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2024 - */ - 'completionStatus'?: CloseAccessRequestV2024CompletionStatusV2024; -} - -export const CloseAccessRequestV2024ExecutionStatusV2024 = { - Terminated: 'Terminated', - Completed: 'Completed' -} as const; - -export type CloseAccessRequestV2024ExecutionStatusV2024 = typeof CloseAccessRequestV2024ExecutionStatusV2024[keyof typeof CloseAccessRequestV2024ExecutionStatusV2024]; -export const CloseAccessRequestV2024CompletionStatusV2024 = { - Success: 'Success', - Incomplete: 'Incomplete', - Failure: 'Failure' -} as const; - -export type CloseAccessRequestV2024CompletionStatusV2024 = typeof CloseAccessRequestV2024CompletionStatusV2024[keyof typeof CloseAccessRequestV2024CompletionStatusV2024]; - -/** - * Configuration details for the \'ccg\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 { - /** - * Version of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ - 'version': string; - /** - * Path to the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ - 'path': string; - /** - * A brief description of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ - 'restartNeeded': boolean; - /** - * A map of dependencies for the \'ccg\' process. - * @type {{ [key: string]: string; }} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024 - */ - 'dependencies': { [key: string]: string; }; -} -/** - * Configuration details for the \'charon\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 { - /** - * Version of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 - */ - 'version': string; - /** - * Path to the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 - */ - 'path': string; - /** - * A brief description of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'otel_agent\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 { - /** - * Version of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 - */ - 'version': string; - /** - * Path to the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 - */ - 'path': string; - /** - * A brief description of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'relay\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 { - /** - * Version of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 - */ - 'version': string; - /** - * Path to the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 - */ - 'path': string; - /** - * A brief description of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'toolbox\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 { - /** - * Version of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 - */ - 'version': string; - /** - * Path to the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 - */ - 'path': string; - /** - * A brief description of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024 - */ - 'restartNeeded': boolean; -} -/** - * Configuration of the managed processes involved in the upgrade. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 { - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ - 'charon'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2024; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ - 'ccg'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2024; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ - 'otel_agent'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2024; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ - 'relay'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2024; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024 - */ - 'toolbox'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2024; -} -/** - * - * @export - * @interface ClusterManualUpgradeJobsInnerV2024 - */ -export interface ClusterManualUpgradeJobsInnerV2024 { - /** - * Unique identifier for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'uuid': string; - /** - * Identifier for the cookbook used in the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'cookbook': string; - /** - * Current state of the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'state': string; - /** - * The type of upgrade job (e.g., VA_UPGRADE). - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'type': string; - /** - * Unique identifier of the target for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'targetId': string; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024} - * @memberof ClusterManualUpgradeJobsInnerV2024 - */ - 'managedProcessConfiguration': ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2024; -} -/** - * Manual Upgrade Job Response - * @export - * @interface ClusterManualUpgradeV2024 - */ -export interface ClusterManualUpgradeV2024 { - /** - * List of job objects for the upgrade request. - * @type {Array} - * @memberof ClusterManualUpgradeV2024 - */ - 'jobs'?: Array; -} -/** - * - * @export - * @interface ColumnV2024 - */ -export interface ColumnV2024 { - /** - * The name of the field. - * @type {string} - * @memberof ColumnV2024 - */ - 'field': string; - /** - * The value of the header. - * @type {string} - * @memberof ColumnV2024 - */ - 'header'?: string; -} -/** - * Author of the comment - * @export - * @interface CommentDtoAuthorV2024 - */ -export interface CommentDtoAuthorV2024 { - /** - * The type of object - * @type {string} - * @memberof CommentDtoAuthorV2024 - */ - 'type'?: CommentDtoAuthorV2024TypeV2024; - /** - * The unique ID of the object - * @type {string} - * @memberof CommentDtoAuthorV2024 - */ - 'id'?: string; - /** - * The display name of the object - * @type {string} - * @memberof CommentDtoAuthorV2024 - */ - 'name'?: string; -} - -export const CommentDtoAuthorV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type CommentDtoAuthorV2024TypeV2024 = typeof CommentDtoAuthorV2024TypeV2024[keyof typeof CommentDtoAuthorV2024TypeV2024]; - -/** - * - * @export - * @interface CommentDtoV2024 - */ -export interface CommentDtoV2024 { - /** - * Comment content. - * @type {string} - * @memberof CommentDtoV2024 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDtoV2024 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2024} - * @memberof CommentDtoV2024 - */ - 'author'?: CommentDtoAuthorV2024; -} -/** - * - * @export - * @interface CommentV2024 - */ -export interface CommentV2024 { - /** - * Id of the identity making the comment - * @type {string} - * @memberof CommentV2024 - */ - 'commenterId'?: string; - /** - * Human-readable display name of the identity making the comment - * @type {string} - * @memberof CommentV2024 - */ - 'commenterName'?: string; - /** - * Content of the comment - * @type {string} - * @memberof CommentV2024 - */ - 'body'?: string; - /** - * Date and time comment was made - * @type {string} - * @memberof CommentV2024 - */ - 'date'?: string; -} -/** - * - * @export - * @interface CommonAccessIDStatusV2024 - */ -export interface CommonAccessIDStatusV2024 { - /** - * List of confirmed common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2024 - */ - 'confirmedIds'?: Array; - /** - * List of denied common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2024 - */ - 'deniedIds'?: Array; -} -/** - * - * @export - * @interface CommonAccessItemAccessV2024 - */ -export interface CommonAccessItemAccessV2024 { - /** - * Common access ID - * @type {string} - * @memberof CommonAccessItemAccessV2024 - */ - 'id'?: string; - /** - * - * @type {CommonAccessTypeV2024} - * @memberof CommonAccessItemAccessV2024 - */ - 'type'?: CommonAccessTypeV2024; - /** - * Common access name - * @type {string} - * @memberof CommonAccessItemAccessV2024 - */ - 'name'?: string; - /** - * Common access description - * @type {string} - * @memberof CommonAccessItemAccessV2024 - */ - 'description'?: string | null; - /** - * Common access owner name - * @type {string} - * @memberof CommonAccessItemAccessV2024 - */ - 'ownerName'?: string; - /** - * Common access owner ID - * @type {string} - * @memberof CommonAccessItemAccessV2024 - */ - 'ownerId'?: string; -} - - -/** - * - * @export - * @interface CommonAccessItemRequestV2024 - */ -export interface CommonAccessItemRequestV2024 { - /** - * - * @type {CommonAccessItemAccessV2024} - * @memberof CommonAccessItemRequestV2024 - */ - 'access'?: CommonAccessItemAccessV2024; - /** - * - * @type {CommonAccessItemStateV2024} - * @memberof CommonAccessItemRequestV2024 - */ - 'status'?: CommonAccessItemStateV2024; -} - - -/** - * - * @export - * @interface CommonAccessItemResponseV2024 - */ -export interface CommonAccessItemResponseV2024 { - /** - * Common Access Item ID - * @type {string} - * @memberof CommonAccessItemResponseV2024 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2024} - * @memberof CommonAccessItemResponseV2024 - */ - 'access'?: CommonAccessItemAccessV2024; - /** - * - * @type {CommonAccessItemStateV2024} - * @memberof CommonAccessItemResponseV2024 - */ - 'status'?: CommonAccessItemStateV2024; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2024 - */ - 'lastUpdated'?: string; - /** - * - * @type {boolean} - * @memberof CommonAccessItemResponseV2024 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2024 - */ - 'lastReviewed'?: string; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2024 - */ - 'createdByUser'?: string; -} - - -/** - * State of common access item. - * @export - * @enum {string} - */ - -export const CommonAccessItemStateV2024 = { - Confirmed: 'CONFIRMED', - Denied: 'DENIED' -} as const; - -export type CommonAccessItemStateV2024 = typeof CommonAccessItemStateV2024[keyof typeof CommonAccessItemStateV2024]; - - -/** - * - * @export - * @interface CommonAccessResponseV2024 - */ -export interface CommonAccessResponseV2024 { - /** - * Unique ID of the common access item - * @type {string} - * @memberof CommonAccessResponseV2024 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2024} - * @memberof CommonAccessResponseV2024 - */ - 'access'?: CommonAccessItemAccessV2024; - /** - * CONFIRMED or DENIED - * @type {string} - * @memberof CommonAccessResponseV2024 - */ - 'status'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2024 - */ - 'commonAccessType'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2024 - */ - 'lastUpdated'?: string; - /** - * true if user has confirmed or denied status - * @type {boolean} - * @memberof CommonAccessResponseV2024 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2024 - */ - 'lastReviewed'?: string | null; - /** - * - * @type {boolean} - * @memberof CommonAccessResponseV2024 - */ - 'createdByUser'?: boolean; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const CommonAccessTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type CommonAccessTypeV2024 = typeof CommonAccessTypeV2024[keyof typeof CommonAccessTypeV2024]; - - -/** - * - * @export - * @interface CompleteInvocationInputV2024 - */ -export interface CompleteInvocationInputV2024 { - /** - * - * @type {LocalizedMessageV2024} - * @memberof CompleteInvocationInputV2024 - */ - 'localizedError'?: LocalizedMessageV2024 | null; - /** - * Trigger output that completed the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationInputV2024 - */ - 'output'?: object | null; -} -/** - * - * @export - * @interface CompleteInvocationV2024 - */ -export interface CompleteInvocationV2024 { - /** - * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. - * @type {string} - * @memberof CompleteInvocationV2024 - */ - 'secret': string; - /** - * The error message to indicate a failed invocation or error if any. - * @type {string} - * @memberof CompleteInvocationV2024 - */ - 'error'?: string; - /** - * Trigger output to complete the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationV2024 - */ - 'output': object; -} -/** - * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. - * @export - * @interface CompletedApprovalPreApprovalTriggerResultV2024 - */ -export interface CompletedApprovalPreApprovalTriggerResultV2024 { - /** - * The comment from the trigger - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2024 - */ - 'comment'?: string; - /** - * - * @type {CompletedApprovalStateV2024} - * @memberof CompletedApprovalPreApprovalTriggerResultV2024 - */ - 'decision'?: CompletedApprovalStateV2024; - /** - * The name of the approver - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2024 - */ - 'reviewer'?: string; - /** - * The date and time the trigger decided on the request - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2024 - */ - 'date'?: string; -} - - -/** - * - * @export - * @interface CompletedApprovalRequesterCommentV2024 - */ -export interface CompletedApprovalRequesterCommentV2024 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2024 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2024 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2024} - * @memberof CompletedApprovalRequesterCommentV2024 - */ - 'author'?: CommentDtoAuthorV2024; -} -/** - * - * @export - * @interface CompletedApprovalReviewerCommentV2024 - */ -export interface CompletedApprovalReviewerCommentV2024 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2024 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2024 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2024} - * @memberof CompletedApprovalReviewerCommentV2024 - */ - 'author'?: CommentDtoAuthorV2024; -} -/** - * Enum represents completed approval object\'s state. - * @export - * @enum {string} - */ - -export const CompletedApprovalStateV2024 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type CompletedApprovalStateV2024 = typeof CompletedApprovalStateV2024[keyof typeof CompletedApprovalStateV2024]; - - -/** - * - * @export - * @interface CompletedApprovalV2024 - */ -export interface CompletedApprovalV2024 { - /** - * The approval id. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof CompletedApprovalV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * - * @type {AccessItemRequesterV2024} - * @memberof CompletedApprovalV2024 - */ - 'requester'?: AccessItemRequesterV2024; - /** - * - * @type {RequestedItemStatusRequestedForV2024} - * @memberof CompletedApprovalV2024 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2024; - /** - * - * @type {AccessItemReviewedByV2024} - * @memberof CompletedApprovalV2024 - */ - 'reviewedBy'?: AccessItemReviewedByV2024; - /** - * - * @type {OwnerDtoV2024} - * @memberof CompletedApprovalV2024 - */ - 'owner'?: OwnerDtoV2024; - /** - * - * @type {RequestableObjectReferenceV2024} - * @memberof CompletedApprovalV2024 - */ - 'requestedObject'?: RequestableObjectReferenceV2024; - /** - * - * @type {CompletedApprovalRequesterCommentV2024} - * @memberof CompletedApprovalV2024 - */ - 'requesterComment'?: CompletedApprovalRequesterCommentV2024; - /** - * - * @type {CompletedApprovalReviewerCommentV2024} - * @memberof CompletedApprovalV2024 - */ - 'reviewerComment'?: CompletedApprovalReviewerCommentV2024; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof CompletedApprovalV2024 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof CompletedApprovalV2024 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof CompletedApprovalV2024 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {CompletedApprovalStateV2024} - * @memberof CompletedApprovalV2024 - */ - 'state'?: CompletedApprovalStateV2024; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'removeDate'?: string | null; - /** - * If true, then the request was to change the remove date or sunset date. - * @type {boolean} - * @memberof CompletedApprovalV2024 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'currentRemoveDate'?: string | null; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof CompletedApprovalV2024 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2024} - * @memberof CompletedApprovalV2024 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2024 | null; - /** - * - * @type {CompletedApprovalPreApprovalTriggerResultV2024} - * @memberof CompletedApprovalV2024 - */ - 'preApprovalTriggerResult'?: CompletedApprovalPreApprovalTriggerResultV2024 | null; - /** - * Arbitrary key-value pairs provided during the request. - * @type {{ [key: string]: string; }} - * @memberof CompletedApprovalV2024 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof CompletedApprovalV2024 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof CompletedApprovalV2024 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2024} - * @memberof CompletedApprovalV2024 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2024 | null; -} - - -/** - * The status after completion. - * @export - * @enum {string} - */ - -export const CompletionStatusV2024 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Incomplete: 'INCOMPLETE', - Pending: 'PENDING' -} as const; - -export type CompletionStatusV2024 = typeof CompletionStatusV2024[keyof typeof CompletionStatusV2024]; - - -/** - * - * @export - * @interface ConcatenationV2024 - */ -export interface ConcatenationV2024 { - /** - * An array of items to join together - * @type {Array} - * @memberof ConcatenationV2024 - */ - 'values': Array; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConcatenationV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConcatenationV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Arbitrary map containing a configuration based on the EffectType. - * @export - * @interface ConditionEffectConfigV2024 - */ -export interface ConditionEffectConfigV2024 { - /** - * Effect type\'s label. - * @type {string} - * @memberof ConditionEffectConfigV2024 - */ - 'defaultValueLabel'?: string; - /** - * Element\'s identifier. - * @type {string} - * @memberof ConditionEffectConfigV2024 - */ - 'element'?: string; -} -/** - * Effect produced by a condition. - * @export - * @interface ConditionEffectV2024 - */ -export interface ConditionEffectV2024 { - /** - * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - * @type {string} - * @memberof ConditionEffectV2024 - */ - 'effectType'?: ConditionEffectV2024EffectTypeV2024; - /** - * - * @type {ConditionEffectConfigV2024} - * @memberof ConditionEffectV2024 - */ - 'config'?: ConditionEffectConfigV2024; -} - -export const ConditionEffectV2024EffectTypeV2024 = { - Hide: 'HIDE', - Show: 'SHOW', - Disable: 'DISABLE', - Enable: 'ENABLE', - Require: 'REQUIRE', - Optional: 'OPTIONAL', - SubmitMessage: 'SUBMIT_MESSAGE', - SubmitNotification: 'SUBMIT_NOTIFICATION', - SetDefaultValue: 'SET_DEFAULT_VALUE' -} as const; - -export type ConditionEffectV2024EffectTypeV2024 = typeof ConditionEffectV2024EffectTypeV2024[keyof typeof ConditionEffectV2024EffectTypeV2024]; - -/** - * - * @export - * @interface ConditionRuleV2024 - */ -export interface ConditionRuleV2024 { - /** - * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement - * @type {string} - * @memberof ConditionRuleV2024 - */ - 'sourceType'?: ConditionRuleV2024SourceTypeV2024; - /** - * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. - * @type {string} - * @memberof ConditionRuleV2024 - */ - 'source'?: string; - /** - * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - * @type {string} - * @memberof ConditionRuleV2024 - */ - 'operator'?: ConditionRuleV2024OperatorV2024; - /** - * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean - * @type {string} - * @memberof ConditionRuleV2024 - */ - 'valueType'?: ConditionRuleV2024ValueTypeV2024; - /** - * Based on the ValueType. - * @type {string} - * @memberof ConditionRuleV2024 - */ - 'value'?: string; -} - -export const ConditionRuleV2024SourceTypeV2024 = { - Input: 'INPUT', - Element: 'ELEMENT' -} as const; - -export type ConditionRuleV2024SourceTypeV2024 = typeof ConditionRuleV2024SourceTypeV2024[keyof typeof ConditionRuleV2024SourceTypeV2024]; -export const ConditionRuleV2024OperatorV2024 = { - Eq: 'EQ', - Ne: 'NE', - Co: 'CO', - NotCo: 'NOT_CO', - In: 'IN', - NotIn: 'NOT_IN', - Em: 'EM', - NotEm: 'NOT_EM', - Sw: 'SW', - NotSw: 'NOT_SW', - Ew: 'EW', - NotEw: 'NOT_EW' -} as const; - -export type ConditionRuleV2024OperatorV2024 = typeof ConditionRuleV2024OperatorV2024[keyof typeof ConditionRuleV2024OperatorV2024]; -export const ConditionRuleV2024ValueTypeV2024 = { - String: 'STRING', - StringList: 'STRING_LIST', - Input: 'INPUT', - Element: 'ELEMENT', - List: 'LIST', - Boolean: 'BOOLEAN' -} as const; - -export type ConditionRuleV2024ValueTypeV2024 = typeof ConditionRuleV2024ValueTypeV2024[keyof typeof ConditionRuleV2024ValueTypeV2024]; - -/** - * - * @export - * @interface ConditionalV2024 - */ -export interface ConditionalV2024 { - /** - * A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison - * @type {string} - * @memberof ConditionalV2024 - */ - 'expression': string; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof ConditionalV2024 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof ConditionalV2024 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConditionalV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConditionalV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Config export and import format for individual object configurations. - * @export - * @interface ConfigObjectV2024 - */ -export interface ConfigObjectV2024 { - /** - * Current version of configuration object. - * @type {number} - * @memberof ConfigObjectV2024 - */ - 'version'?: number; - /** - * - * @type {SelfImportExportDtoV2024} - * @memberof ConfigObjectV2024 - */ - 'self'?: SelfImportExportDtoV2024; - /** - * Object details. Format dependant on the object type. - * @type {{ [key: string]: any; }} - * @memberof ConfigObjectV2024 - */ - 'object'?: { [key: string]: any; }; -} -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumCamelV2024 = { - AccessRequests: 'accessRequests', - Certifications: 'certifications', - ManualTasks: 'manualTasks' -} as const; - -export type ConfigTypeEnumCamelV2024 = typeof ConfigTypeEnumCamelV2024[keyof typeof ConfigTypeEnumCamelV2024]; - - -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumV2024 = { - AccessRequests: 'ACCESS_REQUESTS', - Certifications: 'CERTIFICATIONS', - ManualTasks: 'MANUAL_TASKS' -} as const; - -export type ConfigTypeEnumV2024 = typeof ConfigTypeEnumV2024[keyof typeof ConfigTypeEnumV2024]; - - -/** - * Type of Reassignment Configuration. - * @export - * @interface ConfigTypeV2024 - */ -export interface ConfigTypeV2024 { - /** - * - * @type {number} - * @memberof ConfigTypeV2024 - */ - 'priority'?: number; - /** - * - * @type {ConfigTypeEnumCamelV2024} - * @memberof ConfigTypeV2024 - */ - 'internalName'?: ConfigTypeEnumCamelV2024; - /** - * - * @type {ConfigTypeEnumV2024} - * @memberof ConfigTypeV2024 - */ - 'internalNameCamel'?: ConfigTypeEnumV2024; - /** - * Human readable display name of the type to be shown on UI - * @type {string} - * @memberof ConfigTypeV2024 - */ - 'displayName'?: string; - /** - * Description of the type of work to be reassigned, displayed by the UI. - * @type {string} - * @memberof ConfigTypeV2024 - */ - 'description'?: string; -} - - -/** - * The request body of Reassignment Configuration Details for a specific identity and config type - * @export - * @interface ConfigurationDetailsResponseV2024 - */ -export interface ConfigurationDetailsResponseV2024 { - /** - * - * @type {ConfigTypeEnumV2024} - * @memberof ConfigurationDetailsResponseV2024 - */ - 'configType'?: ConfigTypeEnumV2024; - /** - * - * @type {Identity1V2024} - * @memberof ConfigurationDetailsResponseV2024 - */ - 'targetIdentity'?: Identity1V2024; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationDetailsResponseV2024 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationDetailsResponseV2024 - */ - 'endDate'?: string; - /** - * - * @type {AuditDetailsV2024} - * @memberof ConfigurationDetailsResponseV2024 - */ - 'auditDetails'?: AuditDetailsV2024; -} - - -/** - * The request body for creation or update of a Reassignment Configuration for a single identity and work type - * @export - * @interface ConfigurationItemRequestV2024 - */ -export interface ConfigurationItemRequestV2024 { - /** - * The identity id to reassign an item from - * @type {string} - * @memberof ConfigurationItemRequestV2024 - */ - 'reassignedFromId'?: string; - /** - * The identity id to reassign an item to - * @type {string} - * @memberof ConfigurationItemRequestV2024 - */ - 'reassignedToId'?: string; - /** - * - * @type {ConfigTypeEnumV2024} - * @memberof ConfigurationItemRequestV2024 - */ - 'configType'?: ConfigTypeEnumV2024; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationItemRequestV2024 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationItemRequestV2024 - */ - 'endDate'?: string | null; -} - - -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationItemResponseV2024 - */ -export interface ConfigurationItemResponseV2024 { - /** - * - * @type {Identity1V2024} - * @memberof ConfigurationItemResponseV2024 - */ - 'identity'?: Identity1V2024; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationItemResponseV2024 - */ - 'configDetails'?: Array; -} -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationResponseV2024 - */ -export interface ConfigurationResponseV2024 { - /** - * - * @type {Identity1V2024} - * @memberof ConfigurationResponseV2024 - */ - 'identity'?: Identity1V2024; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationResponseV2024 - */ - 'configDetails'?: Array; -} -/** - * - * @export - * @interface ConflictingAccessCriteriaV2024 - */ -export interface ConflictingAccessCriteriaV2024 { - /** - * - * @type {AccessCriteriaV2024} - * @memberof ConflictingAccessCriteriaV2024 - */ - 'leftCriteria'?: AccessCriteriaV2024; - /** - * - * @type {AccessCriteriaV2024} - * @memberof ConflictingAccessCriteriaV2024 - */ - 'rightCriteria'?: AccessCriteriaV2024; -} -/** - * An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - * @export - * @enum {string} - */ - -export const ConnectedObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type ConnectedObjectTypeV2024 = typeof ConnectedObjectTypeV2024[keyof typeof ConnectedObjectTypeV2024]; - - -/** - * - * @export - * @interface ConnectedObjectV2024 - */ -export interface ConnectedObjectV2024 { - /** - * - * @type {ConnectedObjectTypeV2024 & object} - * @memberof ConnectedObjectV2024 - */ - 'type'?: ConnectedObjectTypeV2024 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ConnectedObjectV2024 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof ConnectedObjectV2024 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof ConnectedObjectV2024 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ConnectorCustomizerCreateRequestV2024 - */ -export interface ConnectorCustomizerCreateRequestV2024 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerCreateRequestV2024 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerResponse - * @export - * @interface ConnectorCustomizerCreateResponseV2024 - */ -export interface ConnectorCustomizerCreateResponseV2024 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2024 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2024 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2024 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2024 - */ - 'created'?: string; -} -/** - * ConnectorCustomizerUpdateRequest - * @export - * @interface ConnectorCustomizerUpdateRequestV2024 - */ -export interface ConnectorCustomizerUpdateRequestV2024 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerUpdateRequestV2024 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerUpdateResponse - * @export - * @interface ConnectorCustomizerUpdateResponseV2024 - */ -export interface ConnectorCustomizerUpdateResponseV2024 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'created'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2024 - */ - 'imageID'?: string; -} -/** - * ConnectorCustomizerVersionCreateResponse - * @export - * @interface ConnectorCustomizerVersionCreateResponseV2024 - */ -export interface ConnectorCustomizerVersionCreateResponseV2024 { - /** - * ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2024 - */ - 'customizerID'?: string; - /** - * ImageID of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2024 - */ - 'imageID'?: string; - /** - * Image version of the connector customizer. - * @type {number} - * @memberof ConnectorCustomizerVersionCreateResponseV2024 - */ - 'version'?: number; - /** - * Date-time when the connector customizer version was created. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2024 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorCustomizersResponseV2024 - */ -export interface ConnectorCustomizersResponseV2024 { - /** - * Connector customizer ID. - * @type {string} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'id'?: string; - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'name'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'imageID'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created - * @type {string} - * @memberof ConnectorCustomizersResponseV2024 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorDetailV2024 - */ -export interface ConnectorDetailV2024 { - /** - * The connector name - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'type'?: string; - /** - * The connector class name - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'className'?: string; - /** - * The connector script name - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'scriptName'?: string; - /** - * The connector application xml - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'applicationXml'?: string; - /** - * The connector correlation config xml - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'correlationConfigXml'?: string; - /** - * The connector source config xml - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'sourceConfigXml'?: string; - /** - * The connector source config - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'sourceConfig'?: string | null; - /** - * The connector source config origin - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'sourceConfigFrom'?: string | null; - /** - * storage path key for this connector - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 's3Location'?: string; - /** - * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. - * @type {Array} - * @memberof ConnectorDetailV2024 - */ - 'uploadedFiles'?: Array | null; - /** - * true if the source is file upload - * @type {boolean} - * @memberof ConnectorDetailV2024 - */ - 'fileUpload'?: boolean; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof ConnectorDetailV2024 - */ - 'directConnect'?: boolean; - /** - * A map containing translation attributes by loacale key - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2024 - */ - 'translationProperties'?: { [key: string]: any; }; - /** - * A map containing metadata pertinent to the UI to be used - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2024 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof ConnectorDetailV2024 - */ - 'status'?: ConnectorDetailV2024StatusV2024; -} - -export const ConnectorDetailV2024StatusV2024 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type ConnectorDetailV2024StatusV2024 = typeof ConnectorDetailV2024StatusV2024[keyof typeof ConnectorDetailV2024StatusV2024]; - -/** - * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) - * @export - * @interface ConnectorRuleCreateRequestSignatureV2024 - */ -export interface ConnectorRuleCreateRequestSignatureV2024 { - /** - * - * @type {Array} - * @memberof ConnectorRuleCreateRequestSignatureV2024 - */ - 'input': Array; - /** - * - * @type {ArgumentV2024} - * @memberof ConnectorRuleCreateRequestSignatureV2024 - */ - 'output'?: ArgumentV2024 | null; -} -/** - * ConnectorRuleCreateRequest - * @export - * @interface ConnectorRuleCreateRequestV2024 - */ -export interface ConnectorRuleCreateRequestV2024 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'type': ConnectorRuleCreateRequestV2024TypeV2024; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2024} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2024; - /** - * - * @type {SourceCodeV2024} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'sourceCode': SourceCodeV2024; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleCreateRequestV2024 - */ - 'attributes'?: object | null; -} - -export const ConnectorRuleCreateRequestV2024TypeV2024 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleCreateRequestV2024TypeV2024 = typeof ConnectorRuleCreateRequestV2024TypeV2024[keyof typeof ConnectorRuleCreateRequestV2024TypeV2024]; - -/** - * ConnectorRuleResponse - * @export - * @interface ConnectorRuleResponseV2024 - */ -export interface ConnectorRuleResponseV2024 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'type': ConnectorRuleResponseV2024TypeV2024; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2024} - * @memberof ConnectorRuleResponseV2024 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2024; - /** - * - * @type {SourceCodeV2024} - * @memberof ConnectorRuleResponseV2024 - */ - 'sourceCode': SourceCodeV2024; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleResponseV2024 - */ - 'attributes'?: object | null; - /** - * the ID of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'id': string; - /** - * an ISO 8601 UTC timestamp when this rule was created - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'created': string; - /** - * an ISO 8601 UTC timestamp when this rule was last modified - * @type {string} - * @memberof ConnectorRuleResponseV2024 - */ - 'modified'?: string | null; -} - -export const ConnectorRuleResponseV2024TypeV2024 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleResponseV2024TypeV2024 = typeof ConnectorRuleResponseV2024TypeV2024[keyof typeof ConnectorRuleResponseV2024TypeV2024]; - -/** - * ConnectorRuleUpdateRequest - * @export - * @interface ConnectorRuleUpdateRequestV2024 - */ -export interface ConnectorRuleUpdateRequestV2024 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'type': ConnectorRuleUpdateRequestV2024TypeV2024; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2024} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2024; - /** - * - * @type {SourceCodeV2024} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'sourceCode': SourceCodeV2024; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'attributes'?: object | null; - /** - * the ID of the rule to update - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2024 - */ - 'id': string; -} - -export const ConnectorRuleUpdateRequestV2024TypeV2024 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleUpdateRequestV2024TypeV2024 = typeof ConnectorRuleUpdateRequestV2024TypeV2024[keyof typeof ConnectorRuleUpdateRequestV2024TypeV2024]; - -/** - * CodeErrorDetail - * @export - * @interface ConnectorRuleValidationResponseDetailsInnerV2024 - */ -export interface ConnectorRuleValidationResponseDetailsInnerV2024 { - /** - * The line number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2024 - */ - 'line': number; - /** - * the column number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2024 - */ - 'column': number; - /** - * a description of the issue in the code - * @type {string} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2024 - */ - 'messsage'?: string; -} -/** - * ConnectorRuleValidationResponse - * @export - * @interface ConnectorRuleValidationResponseV2024 - */ -export interface ConnectorRuleValidationResponseV2024 { - /** - * - * @type {string} - * @memberof ConnectorRuleValidationResponseV2024 - */ - 'state': ConnectorRuleValidationResponseV2024StateV2024; - /** - * - * @type {Array} - * @memberof ConnectorRuleValidationResponseV2024 - */ - 'details': Array; -} - -export const ConnectorRuleValidationResponseV2024StateV2024 = { - Ok: 'OK', - Error: 'ERROR' -} as const; - -export type ConnectorRuleValidationResponseV2024StateV2024 = typeof ConnectorRuleValidationResponseV2024StateV2024[keyof typeof ConnectorRuleValidationResponseV2024StateV2024]; - -/** - * - * @export - * @interface ContextAttributeDtoV2024 - */ -export interface ContextAttributeDtoV2024 { - /** - * The name of the attribute - * @type {string} - * @memberof ContextAttributeDtoV2024 - */ - 'attribute'?: string; - /** - * - * @type {ContextAttributeDtoValueV2024} - * @memberof ContextAttributeDtoV2024 - */ - 'value'?: ContextAttributeDtoValueV2024; - /** - * True if the attribute was derived. - * @type {boolean} - * @memberof ContextAttributeDtoV2024 - */ - 'derived'?: boolean; -} -/** - * @type ContextAttributeDtoValueV2024 - * The value of the attribute. This can be either a string or a multi-valued string - * @export - */ -export type ContextAttributeDtoValueV2024 = Array | string; - -/** - * - * @export - * @interface CorrelatedGovernanceEventV2024 - */ -export interface CorrelatedGovernanceEventV2024 { - /** - * The name of the governance event, such as the certification name or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'name'?: string; - /** - * The date that the certification or access request was completed. - * @type {string} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'dateTime'?: string; - /** - * The type of governance event. - * @type {string} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'type'?: CorrelatedGovernanceEventV2024TypeV2024; - /** - * The ID of the instance that caused the event - either the certification ID or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'governanceId'?: string; - /** - * The owners of the governance event (the certifiers or approvers) - * @type {Array} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'owners'?: Array; - /** - * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners - * @type {Array} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2024} - * @memberof CorrelatedGovernanceEventV2024 - */ - 'decisionMaker'?: CertifierResponseV2024; -} - -export const CorrelatedGovernanceEventV2024TypeV2024 = { - Certification: 'certification', - AccessRequest: 'accessRequest' -} as const; - -export type CorrelatedGovernanceEventV2024TypeV2024 = typeof CorrelatedGovernanceEventV2024TypeV2024[keyof typeof CorrelatedGovernanceEventV2024TypeV2024]; - -/** - * The attribute assignment of the correlation configuration. - * @export - * @interface CorrelationConfigAttributeAssignmentsInnerV2024 - */ -export interface CorrelationConfigAttributeAssignmentsInnerV2024 { - /** - * The property of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'property'?: string; - /** - * The value of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'value'?: string; - /** - * The operation of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'operation'?: CorrelationConfigAttributeAssignmentsInnerV2024OperationV2024; - /** - * Whether or not the it\'s a complex attribute assignment. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'complex'?: boolean; - /** - * Whether or not the attribute assignment should ignore case. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'ignoreCase'?: boolean; - /** - * The match mode of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'matchMode'?: CorrelationConfigAttributeAssignmentsInnerV2024MatchModeV2024; - /** - * The filter string of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2024 - */ - 'filterString'?: string; -} - -export const CorrelationConfigAttributeAssignmentsInnerV2024OperationV2024 = { - Eq: 'EQ' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2024OperationV2024 = typeof CorrelationConfigAttributeAssignmentsInnerV2024OperationV2024[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2024OperationV2024]; -export const CorrelationConfigAttributeAssignmentsInnerV2024MatchModeV2024 = { - Anywhere: 'ANYWHERE', - Start: 'START', - End: 'END' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2024MatchModeV2024 = typeof CorrelationConfigAttributeAssignmentsInnerV2024MatchModeV2024[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2024MatchModeV2024]; - -/** - * Source configuration information that is used by correlation process. - * @export - * @interface CorrelationConfigV2024 - */ -export interface CorrelationConfigV2024 { - /** - * The ID of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2024 - */ - 'id'?: string | null; - /** - * The name of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2024 - */ - 'name'?: string | null; - /** - * The list of attribute assignments of the correlation configuration. - * @type {Array} - * @memberof CorrelationConfigV2024 - */ - 'attributeAssignments'?: Array | null; -} -/** - * - * @export - * @interface CreateDomainDkim405ResponseV2024 - */ -export interface CreateDomainDkim405ResponseV2024 { - /** - * A message describing the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2024 - */ - 'errorName'?: object; - /** - * Description of the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2024 - */ - 'errorMessage'?: object; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof CreateDomainDkim405ResponseV2024 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflow200ResponseV2024 - */ -export interface CreateExternalExecuteWorkflow200ResponseV2024 { - /** - * The workflow execution id - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2024 - */ - 'workflowExecutionId'?: string; - /** - * An error message if any errors occurred - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2024 - */ - 'message'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflowRequestV2024 - */ -export interface CreateExternalExecuteWorkflowRequestV2024 { - /** - * The input for the workflow - * @type {object} - * @memberof CreateExternalExecuteWorkflowRequestV2024 - */ - 'input'?: object; -} -/** - * - * @export - * @interface CreateFormDefinitionFileRequestRequestV2024 - */ -export interface CreateFormDefinitionFileRequestRequestV2024 { - /** - * File specifying the multipart - * @type {File} - * @memberof CreateFormDefinitionFileRequestRequestV2024 - */ - 'file': File; -} -/** - * - * @export - * @interface CreateFormDefinitionRequestV2024 - */ -export interface CreateFormDefinitionRequestV2024 { - /** - * Description is the form definition description - * @type {string} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'description'?: string; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'formConditions'?: Array; - /** - * FormElements is a list of nested form elements - * @type {Array} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'formElements'?: Array; - /** - * FormInput is a list of form inputs that are required when creating a form-instance object - * @type {Array} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'formInput'?: Array; - /** - * Name is the form definition name - * @type {string} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'name': string; - /** - * - * @type {FormOwnerV2024} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'owner': FormOwnerV2024; - /** - * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used - * @type {Array} - * @memberof CreateFormDefinitionRequestV2024 - */ - 'usedBy'?: Array; -} -/** - * - * @export - * @interface CreateFormInstanceRequestV2024 - */ -export interface CreateFormInstanceRequestV2024 { - /** - * - * @type {FormInstanceCreatedByV2024} - * @memberof CreateFormInstanceRequestV2024 - */ - 'createdBy': FormInstanceCreatedByV2024; - /** - * Expire is required - * @type {string} - * @memberof CreateFormInstanceRequestV2024 - */ - 'expire': string; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof CreateFormInstanceRequestV2024 - */ - 'formDefinitionId': string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: any; }} - * @memberof CreateFormInstanceRequestV2024 - */ - 'formInput'?: { [key: string]: any; }; - /** - * Recipients is required - * @type {Array} - * @memberof CreateFormInstanceRequestV2024 - */ - 'recipients': Array; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof CreateFormInstanceRequestV2024 - */ - 'standAloneForm'?: boolean; - /** - * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof CreateFormInstanceRequestV2024 - */ - 'state'?: CreateFormInstanceRequestV2024StateV2024; - /** - * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html - * @type {number} - * @memberof CreateFormInstanceRequestV2024 - */ - 'ttl'?: number; -} - -export const CreateFormInstanceRequestV2024StateV2024 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type CreateFormInstanceRequestV2024StateV2024 = typeof CreateFormInstanceRequestV2024StateV2024[keyof typeof CreateFormInstanceRequestV2024StateV2024]; - -/** - * - * @export - * @interface CreateOAuthClientRequestV2024 - */ -export interface CreateOAuthClientRequestV2024 { - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientRequestV2024 - */ - 'businessName'?: string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2024 - */ - 'homepageUrl'?: string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2024 - */ - 'name': string | null; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2024 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2024 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2024 - */ - 'refreshTokenValiditySeconds'?: number; - /** - * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - * @type {Array} - * @memberof CreateOAuthClientRequestV2024 - */ - 'redirectUris'?: Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientRequestV2024 - */ - 'grantTypes': Array | null; - /** - * - * @type {AccessTypeV2024} - * @memberof CreateOAuthClientRequestV2024 - */ - 'accessType': AccessTypeV2024; - /** - * - * @type {ClientTypeV2024} - * @memberof CreateOAuthClientRequestV2024 - */ - 'type'?: ClientTypeV2024; - /** - * An indicator of whether the API Client can be used for requests internal within the product. - * @type {boolean} - * @memberof CreateOAuthClientRequestV2024 - */ - 'internal'?: boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientRequestV2024 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientRequestV2024 - */ - 'strongAuthSupported'?: boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientRequestV2024 - */ - 'claimsSupported'?: boolean; - /** - * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreateOAuthClientRequestV2024 - */ - 'scope'?: Array | null; -} - - -/** - * - * @export - * @interface CreateOAuthClientResponseV2024 - */ -export interface CreateOAuthClientResponseV2024 { - /** - * ID of the OAuth client - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'id': string; - /** - * Secret of the OAuth client (This field is only returned on the intial create call.) - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'secret': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'businessName': string; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'homepageUrl': string; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'description': string; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2024 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2024 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof CreateOAuthClientResponseV2024 - */ - 'redirectUris': Array; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientResponseV2024 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2024} - * @memberof CreateOAuthClientResponseV2024 - */ - 'accessType': AccessTypeV2024; - /** - * - * @type {ClientTypeV2024} - * @memberof CreateOAuthClientResponseV2024 - */ - 'type': ClientTypeV2024; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof CreateOAuthClientResponseV2024 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientResponseV2024 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientResponseV2024 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientResponseV2024 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof CreateOAuthClientResponseV2024 - */ - 'modified': string; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof CreateOAuthClientResponseV2024 - */ - 'scope': Array | null; -} - - -/** - * Object for specifying the name of a personal access token to create - * @export - * @interface CreatePersonalAccessTokenRequestV2024 - */ -export interface CreatePersonalAccessTokenRequestV2024 { - /** - * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2024 - */ - 'name': string; - /** - * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreatePersonalAccessTokenRequestV2024 - */ - 'scope'?: Array | null; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenRequestV2024 - */ - 'accessTokenValiditySeconds'?: number | null; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2024 - */ - 'expirationDate'?: string | null; -} -/** - * - * @export - * @interface CreatePersonalAccessTokenResponseV2024 - */ -export interface CreatePersonalAccessTokenResponseV2024 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'id': string; - /** - * The secret of the personal access token (to be used as the password for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'secret': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'scope': Array | null; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'name': string; - /** - * - * @type {PatOwnerV2024} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'owner': PatOwnerV2024; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'created': string; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'accessTokenValiditySeconds': number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2024 - */ - 'expirationDate': string; -} -/** - * - * @export - * @interface CreateSavedSearchRequestV2024 - */ -export interface CreateSavedSearchRequestV2024 { - /** - * The name of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2024 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2024 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2024 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2024 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof CreateSavedSearchRequestV2024 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2024 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof CreateSavedSearchRequestV2024 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof CreateSavedSearchRequestV2024 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2024 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof CreateSavedSearchRequestV2024 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2024} - * @memberof CreateSavedSearchRequestV2024 - */ - 'filters'?: SavedSearchDetailFiltersV2024 | null; -} -/** - * - * @export - * @interface CreateScheduledSearchRequestV2024 - */ -export interface CreateScheduledSearchRequestV2024 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2024} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'schedule': Schedule2V2024; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2024 - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface CreateUploadedConfigurationRequestV2024 - */ -export interface CreateUploadedConfigurationRequestV2024 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof CreateUploadedConfigurationRequestV2024 - */ - 'data': File; - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof CreateUploadedConfigurationRequestV2024 - */ - 'name': string; -} -/** - * - * @export - * @interface CreateWorkflowRequestV2024 - */ -export interface CreateWorkflowRequestV2024 { - /** - * The name of the workflow - * @type {string} - * @memberof CreateWorkflowRequestV2024 - */ - 'name': string; - /** - * - * @type {WorkflowBodyOwnerV2024} - * @memberof CreateWorkflowRequestV2024 - */ - 'owner'?: WorkflowBodyOwnerV2024; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof CreateWorkflowRequestV2024 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2024} - * @memberof CreateWorkflowRequestV2024 - */ - 'definition'?: WorkflowDefinitionV2024; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof CreateWorkflowRequestV2024 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2024} - * @memberof CreateWorkflowRequestV2024 - */ - 'trigger'?: WorkflowTriggerV2024; -} -/** - * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. - * @export - * @enum {string} - */ - -export const CriteriaTypeV2024 = { - Composite: 'COMPOSITE', - Role: 'ROLE', - Identity: 'IDENTITY', - IdentityAttribute: 'IDENTITY_ATTRIBUTE', - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Source: 'SOURCE', - Account: 'ACCOUNT', - AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', - InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', - InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' -} as const; - -export type CriteriaTypeV2024 = typeof CriteriaTypeV2024[keyof typeof CriteriaTypeV2024]; - - -/** - * - * @export - * @interface CustomPasswordInstructionV2024 - */ -export interface CustomPasswordInstructionV2024 { - /** - * The page ID that represents the page for forget user name, reset password and unlock account flow. - * @type {string} - * @memberof CustomPasswordInstructionV2024 - */ - 'pageId'?: CustomPasswordInstructionV2024PageIdV2024; - /** - * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. - * @type {string} - * @memberof CustomPasswordInstructionV2024 - */ - 'pageContent'?: string; - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionV2024 - */ - 'locale'?: string; -} - -export const CustomPasswordInstructionV2024PageIdV2024 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; - -export type CustomPasswordInstructionV2024PageIdV2024 = typeof CustomPasswordInstructionV2024PageIdV2024[keyof typeof CustomPasswordInstructionV2024PageIdV2024]; - -/** - * - * @export - * @interface DataAccessCategoriesInnerV2024 - */ -export interface DataAccessCategoriesInnerV2024 { - /** - * Value of the category - * @type {string} - * @memberof DataAccessCategoriesInnerV2024 - */ - 'value'?: string; - /** - * Number of matched for each category - * @type {number} - * @memberof DataAccessCategoriesInnerV2024 - */ - 'matchCount'?: number; -} -/** - * - * @export - * @interface DataAccessImpactScoreV2024 - */ -export interface DataAccessImpactScoreV2024 { - /** - * Impact Score for this data - * @type {string} - * @memberof DataAccessImpactScoreV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface DataAccessPoliciesInnerV2024 - */ -export interface DataAccessPoliciesInnerV2024 { - /** - * Value of the policy - * @type {string} - * @memberof DataAccessPoliciesInnerV2024 - */ - 'value'?: string; -} -/** - * DAS data for the entitlement - * @export - * @interface DataAccessV2024 - */ -export interface DataAccessV2024 { - /** - * List of classification policies that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2024 - */ - 'policies'?: Array; - /** - * List of classification categories that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2024 - */ - 'categories'?: Array; - /** - * - * @type {DataAccessImpactScoreV2024} - * @memberof DataAccessV2024 - */ - 'impactScore'?: DataAccessImpactScoreV2024; -} -/** - * - * @export - * @interface DataSegmentV2024 - */ -export interface DataSegmentV2024 { - /** - * The segment\'s ID. - * @type {string} - * @memberof DataSegmentV2024 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof DataSegmentV2024 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof DataSegmentV2024 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof DataSegmentV2024 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof DataSegmentV2024 - */ - 'description'?: string; - /** - * List of Scopes that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2024 - */ - 'scopes'?: Array; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2024 - */ - 'memberSelection'?: Array; - /** - * - * @type {VisibilityCriteriaV2024} - * @memberof DataSegmentV2024 - */ - 'memberFilter'?: VisibilityCriteriaV2024; - /** - * - * @type {MembershipTypeV2024} - * @memberof DataSegmentV2024 - */ - 'membership'?: MembershipTypeV2024; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentV2024 - */ - 'enabled'?: boolean; - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published - * @type {boolean} - * @memberof DataSegmentV2024 - */ - 'published'?: boolean; -} - - -/** - * @type DateCompareFirstDateV2024 - * This is the first date to consider (The date that would be on the left hand side of the comparison operation). - * @export - */ -export type DateCompareFirstDateV2024 = AccountAttributeV2024 | DateFormatV2024; - -/** - * @type DateCompareSecondDateV2024 - * This is the second date to consider (The date that would be on the right hand side of the comparison operation). - * @export - */ -export type DateCompareSecondDateV2024 = AccountAttributeV2024 | DateFormatV2024; - -/** - * - * @export - * @interface DateCompareV2024 - */ -export interface DateCompareV2024 { - /** - * - * @type {DateCompareFirstDateV2024} - * @memberof DateCompareV2024 - */ - 'firstDate': DateCompareFirstDateV2024; - /** - * - * @type {DateCompareSecondDateV2024} - * @memberof DateCompareV2024 - */ - 'secondDate': DateCompareSecondDateV2024; - /** - * This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | - * @type {string} - * @memberof DateCompareV2024 - */ - 'operator': DateCompareV2024OperatorV2024; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof DateCompareV2024 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof DateCompareV2024 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateCompareV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateCompareV2024 - */ - 'input'?: { [key: string]: any; }; -} - -export const DateCompareV2024OperatorV2024 = { - Lt: 'LT', - Lte: 'LTE', - Gt: 'GT', - Gte: 'GTE' -} as const; - -export type DateCompareV2024OperatorV2024 = typeof DateCompareV2024OperatorV2024[keyof typeof DateCompareV2024OperatorV2024]; - -/** - * @type DateFormatInputFormatV2024 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatInputFormatV2024 = NamedConstructsV2024 | string; - -/** - * @type DateFormatOutputFormatV2024 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatOutputFormatV2024 = NamedConstructsV2024 | string; - -/** - * - * @export - * @interface DateFormatV2024 - */ -export interface DateFormatV2024 { - /** - * - * @type {DateFormatInputFormatV2024} - * @memberof DateFormatV2024 - */ - 'inputFormat'?: DateFormatInputFormatV2024; - /** - * - * @type {DateFormatOutputFormatV2024} - * @memberof DateFormatV2024 - */ - 'outputFormat'?: DateFormatOutputFormatV2024; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateFormatV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateFormatV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DateMathV2024 - */ -export interface DateMathV2024 { - /** - * A string value of the date and time components to operation on, along with the math operations to execute. - * @type {string} - * @memberof DateMathV2024 - */ - 'expression': string; - /** - * A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - * @type {boolean} - * @memberof DateMathV2024 - */ - 'roundUp'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateMathV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateMathV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DecomposeDiacriticalMarksV2024 - */ -export interface DecomposeDiacriticalMarksV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DecomposeDiacriticalMarksV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DecomposeDiacriticalMarksV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DeleteNonEmployeeRecordsInBulkRequestV2024 - */ -export interface DeleteNonEmployeeRecordsInBulkRequestV2024 { - /** - * List of non-employee ids. - * @type {Array} - * @memberof DeleteNonEmployeeRecordsInBulkRequestV2024 - */ - 'ids': Array; -} -/** - * - * @export - * @interface DeleteSource202ResponseV2024 - */ -export interface DeleteSource202ResponseV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof DeleteSource202ResponseV2024 - */ - 'type'?: DeleteSource202ResponseV2024TypeV2024; - /** - * Task result ID. - * @type {string} - * @memberof DeleteSource202ResponseV2024 - */ - 'id'?: string; - /** - * Task result\'s human-readable display name (this should be null/empty). - * @type {string} - * @memberof DeleteSource202ResponseV2024 - */ - 'name'?: string; -} - -export const DeleteSource202ResponseV2024TypeV2024 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type DeleteSource202ResponseV2024TypeV2024 = typeof DeleteSource202ResponseV2024TypeV2024[keyof typeof DeleteSource202ResponseV2024TypeV2024]; - -/** - * - * @export - * @interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2024 - */ -export interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2024 { - /** - * DTO type - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2024 - */ - 'type'?: string; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2024 - */ - 'name'?: string; -} -/** - * The Account Source of the connected Application - * @export - * @interface DependantAppConnectionsAccountSourceV2024 - */ -export interface DependantAppConnectionsAccountSourceV2024 { - /** - * Use this Account Source for password management - * @type {boolean} - * @memberof DependantAppConnectionsAccountSourceV2024 - */ - 'useForPasswordManagement'?: boolean; - /** - * A list of Password Policies for this Account Source - * @type {Array} - * @memberof DependantAppConnectionsAccountSourceV2024 - */ - 'passwordPolicies'?: Array; -} -/** - * - * @export - * @interface DependantAppConnectionsV2024 - */ -export interface DependantAppConnectionsV2024 { - /** - * Id of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2024 - */ - 'cloudAppId'?: string; - /** - * Description of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2024 - */ - 'description'?: string; - /** - * Is the Application enabled - * @type {boolean} - * @memberof DependantAppConnectionsV2024 - */ - 'enabled'?: boolean; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2024 - */ - 'provisionRequestEnabled'?: boolean; - /** - * - * @type {DependantAppConnectionsAccountSourceV2024} - * @memberof DependantAppConnectionsV2024 - */ - 'accountSource'?: DependantAppConnectionsAccountSourceV2024; - /** - * The amount of launchers for connected Application (long type) - * @type {number} - * @memberof DependantAppConnectionsV2024 - */ - 'launcherCount'?: number; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2024 - */ - 'matchAllAccount'?: boolean; - /** - * The owner of the connected Application - * @type {Array} - * @memberof DependantAppConnectionsV2024 - */ - 'owner'?: Array; - /** - * Is App Center enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2024 - */ - 'appCenterEnabled'?: boolean; -} -/** - * - * @export - * @interface DependantConnectionsMissingDtoV2024 - */ -export interface DependantConnectionsMissingDtoV2024 { - /** - * The type of dependency type that is missing in the SourceConnections - * @type {string} - * @memberof DependantConnectionsMissingDtoV2024 - */ - 'dependencyType'?: DependantConnectionsMissingDtoV2024DependencyTypeV2024; - /** - * The reason why this dependency is missing - * @type {string} - * @memberof DependantConnectionsMissingDtoV2024 - */ - 'reason'?: string; -} - -export const DependantConnectionsMissingDtoV2024DependencyTypeV2024 = { - IdentityProfiles: 'identityProfiles', - CredentialProfiles: 'credentialProfiles', - MappingProfiles: 'mappingProfiles', - SourceAttributes: 'sourceAttributes', - DependantCustomTransforms: 'dependantCustomTransforms', - DependantApps: 'dependantApps' -} as const; - -export type DependantConnectionsMissingDtoV2024DependencyTypeV2024 = typeof DependantConnectionsMissingDtoV2024DependencyTypeV2024[keyof typeof DependantConnectionsMissingDtoV2024DependencyTypeV2024]; - -/** - * - * @export - * @interface DeployRequestV2024 - */ -export interface DeployRequestV2024 { - /** - * The id of the draft to be used by this deploy. - * @type {string} - * @memberof DeployRequestV2024 - */ - 'draftId': string; -} -/** - * - * @export - * @interface DeployResponseV2024 - */ -export interface DeployResponseV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'status'?: DeployResponseV2024StatusV2024; - /** - * Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'type'?: DeployResponseV2024TypeV2024; - /** - * Message providing information about the outcome of the deploy process. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'message'?: string; - /** - * The name of the user that initiated the deploy process. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'requesterName'?: string; - /** - * Whether or not a results file was created and stored for this deploy. - * @type {boolean} - * @memberof DeployResponseV2024 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'completed'?: string; - /** - * The id of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'draftId'?: string; - /** - * The name of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'draftName'?: string; - /** - * Whether this deploy results file has been transferred to a customer storage location. - * @type {string} - * @memberof DeployResponseV2024 - */ - 'cloudStorageStatus'?: DeployResponseV2024CloudStorageStatusV2024; -} - -export const DeployResponseV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DeployResponseV2024StatusV2024 = typeof DeployResponseV2024StatusV2024[keyof typeof DeployResponseV2024StatusV2024]; -export const DeployResponseV2024TypeV2024 = { - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type DeployResponseV2024TypeV2024 = typeof DeployResponseV2024TypeV2024[keyof typeof DeployResponseV2024TypeV2024]; -export const DeployResponseV2024CloudStorageStatusV2024 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type DeployResponseV2024CloudStorageStatusV2024 = typeof DeployResponseV2024CloudStorageStatusV2024[keyof typeof DeployResponseV2024CloudStorageStatusV2024]; - -/** - * - * @export - * @interface DimensionBulkDeleteRequestV2024 - */ -export interface DimensionBulkDeleteRequestV2024 { - /** - * List of IDs of Dimensions to be deleted. - * @type {Array} - * @memberof DimensionBulkDeleteRequestV2024 - */ - 'dimensionIds': Array; -} -/** - * Indicates whether the associated criteria represents an expression on identity attributes. - * @export - * @enum {string} - */ - -export const DimensionCriteriaKeyTypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type DimensionCriteriaKeyTypeV2024 = typeof DimensionCriteriaKeyTypeV2024[keyof typeof DimensionCriteriaKeyTypeV2024]; - - -/** - * Refers to a specific Identity attribute used in Dimension membership criteria. - * @export - * @interface DimensionCriteriaKeyV2024 - */ -export interface DimensionCriteriaKeyV2024 { - /** - * - * @type {DimensionCriteriaKeyTypeV2024} - * @memberof DimensionCriteriaKeyV2024 - */ - 'type': DimensionCriteriaKeyTypeV2024; - /** - * The name of the identity attribute to which the associated criteria applies. - * @type {string} - * @memberof DimensionCriteriaKeyV2024 - */ - 'property': string; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel1V2024 - */ -export interface DimensionCriteriaLevel1V2024 { - /** - * - * @type {DimensionCriteriaOperationV2024} - * @memberof DimensionCriteriaLevel1V2024 - */ - 'operation'?: DimensionCriteriaOperationV2024; - /** - * - * @type {DimensionCriteriaKeyV2024} - * @memberof DimensionCriteriaLevel1V2024 - */ - 'key'?: DimensionCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel1V2024 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel1V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface DimensionCriteriaLevel2V2024 - */ -export interface DimensionCriteriaLevel2V2024 { - /** - * - * @type {DimensionCriteriaOperationV2024} - * @memberof DimensionCriteriaLevel2V2024 - */ - 'operation'?: DimensionCriteriaOperationV2024; - /** - * - * @type {DimensionCriteriaKeyV2024} - * @memberof DimensionCriteriaLevel2V2024 - */ - 'key'?: DimensionCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel2V2024 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel2V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel3V2024 - */ -export interface DimensionCriteriaLevel3V2024 { - /** - * - * @type {DimensionCriteriaOperationV2024} - * @memberof DimensionCriteriaLevel3V2024 - */ - 'operation'?: DimensionCriteriaOperationV2024; - /** - * - * @type {DimensionCriteriaKeyV2024} - * @memberof DimensionCriteriaLevel3V2024 - */ - 'key'?: DimensionCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel3V2024 - */ - 'stringValue'?: string; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const DimensionCriteriaOperationV2024 = { - Equals: 'EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type DimensionCriteriaOperationV2024 = typeof DimensionCriteriaOperationV2024[keyof typeof DimensionCriteriaOperationV2024]; - - -/** - * This enum characterizes the type of a Dimension\'s membership selector. Only the STANDARD type supported: STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression - * @export - * @enum {string} - */ - -export const DimensionMembershipSelectorTypeV2024 = { - Standard: 'STANDARD' -} as const; - -export type DimensionMembershipSelectorTypeV2024 = typeof DimensionMembershipSelectorTypeV2024[keyof typeof DimensionMembershipSelectorTypeV2024]; - - -/** - * When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. - * @export - * @interface DimensionMembershipSelectorV2024 - */ -export interface DimensionMembershipSelectorV2024 { - /** - * - * @type {DimensionMembershipSelectorTypeV2024} - * @memberof DimensionMembershipSelectorV2024 - */ - 'type'?: DimensionMembershipSelectorTypeV2024; - /** - * - * @type {DimensionCriteriaLevel1V2024} - * @memberof DimensionMembershipSelectorV2024 - */ - 'criteria'?: DimensionCriteriaLevel1V2024 | null; -} - - -/** - * - * @export - * @interface DimensionRefV2024 - */ -export interface DimensionRefV2024 { - /** - * The type of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2024 - */ - 'type'?: DimensionRefV2024TypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2024 - */ - 'name'?: string; -} - -export const DimensionRefV2024TypeV2024 = { - Dimension: 'DIMENSION' -} as const; - -export type DimensionRefV2024TypeV2024 = typeof DimensionRefV2024TypeV2024[keyof typeof DimensionRefV2024TypeV2024]; - -/** - * A Dimension - * @export - * @interface DimensionV2024 - */ -export interface DimensionV2024 { - /** - * The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof DimensionV2024 - */ - 'id'?: string; - /** - * The human-readable display name of the Dimension - * @type {string} - * @memberof DimensionV2024 - */ - 'name': string; - /** - * Date the Dimension was created - * @type {string} - * @memberof DimensionV2024 - */ - 'created'?: string; - /** - * Date the Dimension was last modified. - * @type {string} - * @memberof DimensionV2024 - */ - 'modified'?: string; - /** - * A human-readable description of the Dimension - * @type {string} - * @memberof DimensionV2024 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2024} - * @memberof DimensionV2024 - */ - 'owner': OwnerReferenceV2024 | null; - /** - * - * @type {Array} - * @memberof DimensionV2024 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof DimensionV2024 - */ - 'entitlements'?: Array; - /** - * - * @type {DimensionMembershipSelectorV2024} - * @memberof DimensionV2024 - */ - 'membership'?: DimensionMembershipSelectorV2024 | null; - /** - * The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. - * @type {string} - * @memberof DimensionV2024 - */ - 'parentId'?: string | null; -} -/** - * - * @export - * @interface DisplayReferenceV2024 - */ -export interface DisplayReferenceV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof DisplayReferenceV2024 - */ - 'displayName'?: string; -} -/** - * DKIM attributes for a domain or identity - * @export - * @interface DkimAttributesV2024 - */ -export interface DkimAttributesV2024 { - /** - * UUID associated with domain to be verified - * @type {string} - * @memberof DkimAttributesV2024 - */ - 'id'?: string; - /** - * The identity or domain address - * @type {string} - * @memberof DkimAttributesV2024 - */ - 'address'?: string; - /** - * Whether or not DKIM has been enabled for this domain / identity - * @type {boolean} - * @memberof DkimAttributesV2024 - */ - 'dkimEnabled'?: boolean; - /** - * The tokens to be added to a DNS for verification - * @type {Array} - * @memberof DkimAttributesV2024 - */ - 'dkimTokens'?: Array; - /** - * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING - * @type {string} - * @memberof DkimAttributesV2024 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DkimAttributesV2024 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DocumentFieldsV2024 - */ -export interface DocumentFieldsV2024 { - /** - * Name of the pod. - * @type {string} - * @memberof DocumentFieldsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof DocumentFieldsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof DocumentFieldsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof DocumentFieldsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof DocumentFieldsV2024 - */ - '_version'?: string; -} - - -/** - * Enum representing the currently supported document types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const DocumentTypeV2024 = { - Accessprofile: 'accessprofile', - Accountactivity: 'accountactivity', - Entitlement: 'entitlement', - Event: 'event', - Identity: 'identity', - Role: 'role' -} as const; - -export type DocumentTypeV2024 = typeof DocumentTypeV2024[keyof typeof DocumentTypeV2024]; - - -/** - * - * @export - * @interface DomainAddressV2024 - */ -export interface DomainAddressV2024 { - /** - * A domain address - * @type {string} - * @memberof DomainAddressV2024 - */ - 'domain'?: string; -} -/** - * Domain status DTO containing everything required to verify via DKIM - * @export - * @interface DomainStatusDtoV2024 - */ -export interface DomainStatusDtoV2024 { - /** - * New UUID associated with domain to be verified - * @type {string} - * @memberof DomainStatusDtoV2024 - */ - 'id'?: string; - /** - * A domain address - * @type {string} - * @memberof DomainStatusDtoV2024 - */ - 'domain'?: string; - /** - * DKIM is enabled for this domain - * @type {boolean} - * @memberof DomainStatusDtoV2024 - */ - 'dkimEnabled'?: boolean; - /** - * DKIM tokens required for authentication - * @type {Array} - * @memberof DomainStatusDtoV2024 - */ - 'dkimTokens'?: Array; - /** - * Status of DKIM authentication - * @type {string} - * @memberof DomainStatusDtoV2024 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DomainStatusDtoV2024 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DraftResponseV2024 - */ -export interface DraftResponseV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'status'?: DraftResponseV2024StatusV2024; - /** - * Type of the job, will always be CREATE_DRAFT for this type of job. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'type'?: DraftResponseV2024TypeV2024; - /** - * Message providing information about the outcome of the draft process. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'message'?: string; - /** - * The name of user that that initiated the draft process. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'requesterName'?: string; - /** - * Whether or not a file was generated for this draft. - * @type {boolean} - * @memberof DraftResponseV2024 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'completed'?: string; - /** - * Name of the draft. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'name'?: string; - /** - * Tenant owner of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'sourceTenant'?: string; - /** - * Id of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'sourceBackupId'?: string; - /** - * Name of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'sourceBackupName'?: string; - /** - * Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'mode'?: DraftResponseV2024ModeV2024; - /** - * Approval status of the draft used to determine whether or not the draft can be deployed. - * @type {string} - * @memberof DraftResponseV2024 - */ - 'approvalStatus'?: DraftResponseV2024ApprovalStatusV2024; - /** - * List of comments that have been exchanged between an approval requester and an approver. - * @type {Array} - * @memberof DraftResponseV2024 - */ - 'approvalComment'?: Array; -} - -export const DraftResponseV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DraftResponseV2024StatusV2024 = typeof DraftResponseV2024StatusV2024[keyof typeof DraftResponseV2024StatusV2024]; -export const DraftResponseV2024TypeV2024 = { - CreateDraft: 'CREATE_DRAFT' -} as const; - -export type DraftResponseV2024TypeV2024 = typeof DraftResponseV2024TypeV2024[keyof typeof DraftResponseV2024TypeV2024]; -export const DraftResponseV2024ModeV2024 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type DraftResponseV2024ModeV2024 = typeof DraftResponseV2024ModeV2024[keyof typeof DraftResponseV2024ModeV2024]; -export const DraftResponseV2024ApprovalStatusV2024 = { - Default: 'DEFAULT', - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type DraftResponseV2024ApprovalStatusV2024 = typeof DraftResponseV2024ApprovalStatusV2024[keyof typeof DraftResponseV2024ApprovalStatusV2024]; - -/** - * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - * @export - * @enum {string} - */ - -export const DtoTypeV2024 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', - AccessProfile: 'ACCESS_PROFILE', - AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', - Account: 'ACCOUNT', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - CampaignFilter: 'CAMPAIGN_FILTER', - Certification: 'CERTIFICATION', - Cluster: 'CLUSTER', - ConnectorSchema: 'CONNECTOR_SCHEMA', - Entitlement: 'ENTITLEMENT', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityProfile: 'IDENTITY_PROFILE', - IdentityRequest: 'IDENTITY_REQUEST', - MachineIdentity: 'MACHINE_IDENTITY', - LifecycleState: 'LIFECYCLE_STATE', - PasswordPolicy: 'PASSWORD_POLICY', - Role: 'ROLE', - Rule: 'RULE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - TagCategory: 'TAG_CATEGORY', - TaskResult: 'TASK_RESULT', - ReportResult: 'REPORT_RESULT', - SodViolation: 'SOD_VIOLATION', - AccountActivity: 'ACCOUNT_ACTIVITY', - Workgroup: 'WORKGROUP' -} as const; - -export type DtoTypeV2024 = typeof DtoTypeV2024[keyof typeof DtoTypeV2024]; - - -/** - * - * @export - * @interface E164phoneV2024 - */ -export interface E164phoneV2024 { - /** - * This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - * @type {string} - * @memberof E164phoneV2024 - */ - 'defaultRegion'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof E164phoneV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof E164phoneV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * This is used for representing email configuration for a lifecycle state - * @export - * @interface EmailNotificationOptionV2024 - */ -export interface EmailNotificationOptionV2024 { - /** - * If true, then the manager is notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2024 - */ - 'notifyManagers'?: boolean; - /** - * If true, then all the admins are notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2024 - */ - 'notifyAllAdmins'?: boolean; - /** - * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2024 - */ - 'notifySpecificUsers'?: boolean; - /** - * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. - * @type {Array} - * @memberof EmailNotificationOptionV2024 - */ - 'emailAddressList'?: Array; -} -/** - * - * @export - * @interface EmailStatusDtoV2024 - */ -export interface EmailStatusDtoV2024 { - /** - * Unique identifier for the verified sender address - * @type {string} - * @memberof EmailStatusDtoV2024 - */ - 'id'?: string | null; - /** - * The verified sender email address - * @type {string} - * @memberof EmailStatusDtoV2024 - */ - 'email'?: string; - /** - * Whether the sender address is verified by domain - * @type {boolean} - * @memberof EmailStatusDtoV2024 - */ - 'isVerifiedByDomain'?: boolean; - /** - * The verification status of the sender address - * @type {string} - * @memberof EmailStatusDtoV2024 - */ - 'verificationStatus'?: EmailStatusDtoV2024VerificationStatusV2024; - /** - * The AWS SES region the sender address is associated with - * @type {string} - * @memberof EmailStatusDtoV2024 - */ - 'region'?: string | null; -} - -export const EmailStatusDtoV2024VerificationStatusV2024 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Na: 'NA' -} as const; - -export type EmailStatusDtoV2024VerificationStatusV2024 = typeof EmailStatusDtoV2024VerificationStatusV2024[keyof typeof EmailStatusDtoV2024VerificationStatusV2024]; - -/** - * Additional data to classify the entitlement - * @export - * @interface EntitlementAccessModelMetadataV2024 - */ -export interface EntitlementAccessModelMetadataV2024 { - /** - * - * @type {Array} - * @memberof EntitlementAccessModelMetadataV2024 - */ - 'attributes'?: Array; -} -/** - * - * @export - * @interface EntitlementAccessRequestConfigV2024 - */ -export interface EntitlementAccessRequestConfigV2024 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'approvalSchemes'?: Array; - /** - * If the requester must provide a comment during access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'requestCommentRequired'?: boolean; - /** - * If the reviewer must provide a comment when denying the access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'denialCommentRequired'?: boolean; - /** - * Is Reauthorization Required - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'reauthorizationRequired'?: boolean; - /** - * If true, then remove date or sunset date is required in access request of the entitlement. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2024} - * @memberof EntitlementAccessRequestConfigV2024 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2024 | null; -} -/** - * - * @export - * @interface EntitlementApprovalSchemeV2024 - */ -export interface EntitlementApprovalSchemeV2024 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. - * @type {string} - * @memberof EntitlementApprovalSchemeV2024 - */ - 'approverType'?: EntitlementApprovalSchemeV2024ApproverTypeV2024; - /** - * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW - * @type {string} - * @memberof EntitlementApprovalSchemeV2024 - */ - 'approverId'?: string | null; -} - -export const EntitlementApprovalSchemeV2024ApproverTypeV2024 = { - EntitlementOwner: 'ENTITLEMENT_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW' -} as const; - -export type EntitlementApprovalSchemeV2024ApproverTypeV2024 = typeof EntitlementApprovalSchemeV2024ApproverTypeV2024[keyof typeof EntitlementApprovalSchemeV2024ApproverTypeV2024]; - -/** - * Object for specifying the bulk update request - * @export - * @interface EntitlementBulkUpdateRequestV2024 - */ -export interface EntitlementBulkUpdateRequestV2024 { - /** - * List of entitlement ids to update - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2024 - */ - 'entitlementIds': Array; - /** - * - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2024 - */ - 'jsonPatch': Array; -} -/** - * Indicates whether the entitlement\'s display name and/or description have been manually updated. - * @export - * @interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 - */ -export interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 { - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 - */ - 'DESCRIPTION'?: boolean; - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 - */ - 'DISPLAY_NAME'?: boolean; -} -/** - * - * @export - * @interface EntitlementDocumentAllOfPermissionsV2024 - */ -export interface EntitlementDocumentAllOfPermissionsV2024 { - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof EntitlementDocumentAllOfPermissionsV2024 - */ - 'target'?: string; - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof EntitlementDocumentAllOfPermissionsV2024 - */ - 'rights'?: Array; -} -/** - * Entitlement\'s source. - * @export - * @interface EntitlementDocumentAllOfSourceV2024 - */ -export interface EntitlementDocumentAllOfSourceV2024 { - /** - * ID of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2024 - */ - 'id'?: string; - /** - * Display name of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2024 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2024 - */ - 'type'?: string; -} -/** - * Entitlement - * @export - * @interface EntitlementDocumentV2024 - */ -export interface EntitlementDocumentV2024 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2024} - * @memberof EntitlementDocumentV2024 - */ - 'source'?: EntitlementDocumentAllOfSourceV2024; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2024 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentV2024 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentV2024 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentV2024 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentV2024 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentV2024 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2024 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentV2024 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2024} - * @memberof EntitlementDocumentV2024 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentV2024 - */ - 'permissions'?: Array; -} -/** - * - * @export - * @interface EntitlementDocumentsV2024 - */ -export interface EntitlementDocumentsV2024 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2024} - * @memberof EntitlementDocumentsV2024 - */ - 'source'?: EntitlementDocumentAllOfSourceV2024; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2024 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentsV2024 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentsV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentsV2024 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentsV2024 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentsV2024 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentsV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2024 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentsV2024 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2024} - * @memberof EntitlementDocumentsV2024 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2024 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentsV2024 - */ - 'permissions'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof EntitlementDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof EntitlementDocumentsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof EntitlementDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * The identity that owns the entitlement - * @export - * @interface EntitlementOwnerV2024 - */ -export interface EntitlementOwnerV2024 { - /** - * The identity ID - * @type {string} - * @memberof EntitlementOwnerV2024 - */ - 'id'?: string; - /** - * The type of object - * @type {string} - * @memberof EntitlementOwnerV2024 - */ - 'type'?: EntitlementOwnerV2024TypeV2024; - /** - * The display name of the identity - * @type {string} - * @memberof EntitlementOwnerV2024 - */ - 'name'?: string; -} - -export const EntitlementOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type EntitlementOwnerV2024TypeV2024 = typeof EntitlementOwnerV2024TypeV2024[keyof typeof EntitlementOwnerV2024TypeV2024]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface EntitlementRefV2024 - */ -export interface EntitlementRefV2024 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof EntitlementRefV2024 - */ - 'type'?: EntitlementRefV2024TypeV2024; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof EntitlementRefV2024 - */ - 'id'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementRefV2024 - */ - 'name'?: string | null; -} - -export const EntitlementRefV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type EntitlementRefV2024TypeV2024 = typeof EntitlementRefV2024TypeV2024[keyof typeof EntitlementRefV2024TypeV2024]; - -/** - * - * @export - * @interface EntitlementRequestConfigV2024 - */ -export interface EntitlementRequestConfigV2024 { - /** - * - * @type {EntitlementAccessRequestConfigV2024} - * @memberof EntitlementRequestConfigV2024 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2024; - /** - * - * @type {EntitlementRevocationRequestConfigV2024} - * @memberof EntitlementRequestConfigV2024 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2024; -} -/** - * - * @export - * @interface EntitlementRevocationRequestConfigV2024 - */ -export interface EntitlementRevocationRequestConfigV2024 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementRevocationRequestConfigV2024 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface EntitlementSourceResetBaseReferenceDtoV2024 - */ -export interface EntitlementSourceResetBaseReferenceDtoV2024 { - /** - * The DTO type - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2024 - */ - 'type'?: string; - /** - * The task ID of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface EntitlementSourceV2024 - */ -export interface EntitlementSourceV2024 { - /** - * The source ID - * @type {string} - * @memberof EntitlementSourceV2024 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementSourceV2024 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementSourceV2024 - */ - 'name'?: string; -} -/** - * EntitlementReference - * @export - * @interface EntitlementSummaryV2024 - */ -export interface EntitlementSummaryV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2024} - * @memberof EntitlementSummaryV2024 - */ - 'source'?: Reference1V2024; - /** - * Type of the access item. - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2024 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2024 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2024 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface EntitlementV2024 - */ -export interface EntitlementV2024 { - /** - * The entitlement id - * @type {string} - * @memberof EntitlementV2024 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof EntitlementV2024 - */ - 'name'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof EntitlementV2024 - */ - 'attribute'?: string; - /** - * The value of the entitlement - * @type {string} - * @memberof EntitlementV2024 - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof EntitlementV2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof EntitlementV2024 - */ - 'description'?: string | null; - /** - * True if the entitlement is privileged - * @type {boolean} - * @memberof EntitlementV2024 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof EntitlementV2024 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement is able to be directly requested - * @type {boolean} - * @memberof EntitlementV2024 - */ - 'requestable'?: boolean; - /** - * - * @type {EntitlementOwnerV2024} - * @memberof EntitlementV2024 - */ - 'owner'?: EntitlementOwnerV2024 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof EntitlementV2024 - */ - 'additionalOwners'?: Array | null; - /** - * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2024 - */ - 'manuallyUpdatedFields'?: { [key: string]: any; } | null; - /** - * - * @type {EntitlementAccessModelMetadataV2024} - * @memberof EntitlementV2024 - */ - 'accessModelMetadata'?: EntitlementAccessModelMetadataV2024; - /** - * Time when the entitlement was created - * @type {string} - * @memberof EntitlementV2024 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof EntitlementV2024 - */ - 'modified'?: string; - /** - * - * @type {EntitlementSourceV2024} - * @memberof EntitlementV2024 - */ - 'source'?: EntitlementSourceV2024; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof EntitlementV2024 - */ - 'segments'?: Array | null; - /** - * - * @type {Array} - * @memberof EntitlementV2024 - */ - 'directPermissions'?: Array; -} -/** - * - * @export - * @interface EntityCreatedByDTOV2024 - */ -export interface EntityCreatedByDTOV2024 { - /** - * ID of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2024 - */ - 'id'?: string; - /** - * The display name of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2024 - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface ErrorMessageDtoV2024 - */ -export interface ErrorMessageDtoV2024 { - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof ErrorMessageDtoV2024 - */ - 'locale'?: string | null; - /** - * - * @type {LocaleOriginV2024} - * @memberof ErrorMessageDtoV2024 - */ - 'localeOrigin'?: LocaleOriginV2024 | null; - /** - * Actual text of the error message in the indicated locale. - * @type {string} - * @memberof ErrorMessageDtoV2024 - */ - 'text'?: string; -} - - -/** - * - * @export - * @interface ErrorMessageV2024 - */ -export interface ErrorMessageV2024 { - /** - * Locale is the current Locale - * @type {string} - * @memberof ErrorMessageV2024 - */ - 'locale'?: string; - /** - * LocaleOrigin holds possible values of how the locale was selected - * @type {string} - * @memberof ErrorMessageV2024 - */ - 'localeOrigin'?: string; - /** - * Text is the actual text of the error message - * @type {string} - * @memberof ErrorMessageV2024 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ErrorResponseDtoV2024 - */ -export interface ErrorResponseDtoV2024 { - /** - * Fine-grained error code providing more detail of the error. - * @type {string} - * @memberof ErrorResponseDtoV2024 - */ - 'detailCode'?: string; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof ErrorResponseDtoV2024 - */ - 'trackingId'?: string; - /** - * Generic localized reason for error - * @type {Array} - * @memberof ErrorResponseDtoV2024 - */ - 'messages'?: Array; - /** - * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - * @type {Array} - * @memberof ErrorResponseDtoV2024 - */ - 'causes'?: Array; -} -/** - * - * @export - * @interface ErrorV2024 - */ -export interface ErrorV2024 { - /** - * DetailCode is the text of the status code returned - * @type {string} - * @memberof ErrorV2024 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof ErrorV2024 - */ - 'messages'?: Array; - /** - * TrackingID is the request tracking unique identifier - * @type {string} - * @memberof ErrorV2024 - */ - 'trackingId'?: string; -} -/** - * The response body for Evaluate Reassignment Configuration - * @export - * @interface EvaluateResponseV2024 - */ -export interface EvaluateResponseV2024 { - /** - * The Identity ID which should be the recipient of any work items sent to a specific identity & work type - * @type {string} - * @memberof EvaluateResponseV2024 - */ - 'reassignToId'?: string; - /** - * List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration - * @type {Array} - * @memberof EvaluateResponseV2024 - */ - 'lookupTrail'?: Array; -} -/** - * - * @export - * @interface EventActorV2024 - */ -export interface EventActorV2024 { - /** - * Name of the actor that generated the event. - * @type {string} - * @memberof EventActorV2024 - */ - 'name'?: string; -} -/** - * Attributes related to an IdentityNow ETS event - * @export - * @interface EventAttributesV2024 - */ -export interface EventAttributesV2024 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof EventAttributesV2024 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof EventAttributesV2024 - */ - 'filter.$'?: string | null; - /** - * Description of the event trigger - * @type {string} - * @memberof EventAttributesV2024 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof EventAttributesV2024 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof EventAttributesV2024 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface EventBridgeConfigV2024 - */ -export interface EventBridgeConfigV2024 { - /** - * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. - * @type {string} - * @memberof EventBridgeConfigV2024 - */ - 'awsAccount': string; - /** - * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. - * @type {string} - * @memberof EventBridgeConfigV2024 - */ - 'awsRegion': string; -} -/** - * Event - * @export - * @interface EventDocumentV2024 - */ -export interface EventDocumentV2024 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'type'?: string; - /** - * - * @type {EventActorV2024} - * @memberof EventDocumentV2024 - */ - 'actor'?: EventActorV2024; - /** - * - * @type {EventTargetV2024} - * @memberof EventDocumentV2024 - */ - 'target'?: EventTargetV2024; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentV2024 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentV2024 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface EventDocumentsV2024 - */ -export interface EventDocumentsV2024 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'type'?: string; - /** - * - * @type {EventActorV2024} - * @memberof EventDocumentsV2024 - */ - 'actor'?: EventActorV2024; - /** - * - * @type {EventTargetV2024} - * @memberof EventDocumentsV2024 - */ - 'target'?: EventTargetV2024; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentsV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentsV2024 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'technicalName'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'pod'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof EventDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {string} - * @memberof EventDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface EventTargetV2024 - */ -export interface EventTargetV2024 { - /** - * Name of the target, or recipient, of the event. - * @type {string} - * @memberof EventTargetV2024 - */ - 'name'?: string; -} -/** - * Event - * @export - * @interface EventV2024 - */ -export interface EventV2024 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventV2024 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventV2024 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventV2024 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventV2024 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventV2024 - */ - 'type'?: string; - /** - * - * @type {EventActorV2024} - * @memberof EventV2024 - */ - 'actor'?: EventActorV2024; - /** - * - * @type {EventTargetV2024} - * @memberof EventV2024 - */ - 'target'?: EventTargetV2024; - /** - * The event\'s stack. - * @type {string} - * @memberof EventV2024 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventV2024 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventV2024 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventV2024 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventV2024 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventV2024 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventV2024 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventV2024 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface ExceptionAccessCriteriaV2024 - */ -export interface ExceptionAccessCriteriaV2024 { - /** - * - * @type {ExceptionCriteriaV2024} - * @memberof ExceptionAccessCriteriaV2024 - */ - 'leftCriteria'?: ExceptionCriteriaV2024; - /** - * - * @type {ExceptionCriteriaV2024} - * @memberof ExceptionAccessCriteriaV2024 - */ - 'rightCriteria'?: ExceptionCriteriaV2024; -} -/** - * Access reference with addition of boolean existing flag to indicate whether the access was extant - * @export - * @interface ExceptionCriteriaAccessV2024 - */ -export interface ExceptionCriteriaAccessV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof ExceptionCriteriaAccessV2024 - */ - 'type'?: DtoTypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2024 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaAccessV2024 - */ - 'existing'?: boolean; -} - - -/** - * The types of objects supported for SOD violations - * @export - * @interface ExceptionCriteriaCriteriaListInnerV2024 - */ -export interface ExceptionCriteriaCriteriaListInnerV2024 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ExceptionCriteriaCriteriaListInnerV2024 - */ - 'type'?: ExceptionCriteriaCriteriaListInnerV2024TypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2024 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaCriteriaListInnerV2024 - */ - 'existing'?: boolean; -} - -export const ExceptionCriteriaCriteriaListInnerV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ExceptionCriteriaCriteriaListInnerV2024TypeV2024 = typeof ExceptionCriteriaCriteriaListInnerV2024TypeV2024[keyof typeof ExceptionCriteriaCriteriaListInnerV2024TypeV2024]; - -/** - * - * @export - * @interface ExceptionCriteriaV2024 - */ -export interface ExceptionCriteriaV2024 { - /** - * List of exception criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof ExceptionCriteriaV2024 - */ - 'criteriaList'?: Array; -} -/** - * The current state of execution. - * @export - * @enum {string} - */ - -export const ExecutionStatusV2024 = { - Executing: 'EXECUTING', - Verifying: 'VERIFYING', - Terminated: 'TERMINATED', - Completed: 'COMPLETED' -} as const; - -export type ExecutionStatusV2024 = typeof ExecutionStatusV2024[keyof typeof ExecutionStatusV2024]; - - -/** - * - * @export - * @interface ExpansionItemV2024 - */ -export interface ExpansionItemV2024 { - /** - * The ID of the account - * @type {string} - * @memberof ExpansionItemV2024 - */ - 'accountId'?: string; - /** - * Cause of the expansion item. - * @type {string} - * @memberof ExpansionItemV2024 - */ - 'cause'?: string; - /** - * The name of the item - * @type {string} - * @memberof ExpansionItemV2024 - */ - 'name'?: string; - /** - * - * @type {AttributeRequestV2024} - * @memberof ExpansionItemV2024 - */ - 'attributeRequest'?: AttributeRequestV2024; - /** - * - * @type {AccountSourceV2024} - * @memberof ExpansionItemV2024 - */ - 'source'?: AccountSourceV2024; - /** - * ID of the expansion item - * @type {string} - * @memberof ExpansionItemV2024 - */ - 'id'?: string; - /** - * State of the expansion item - * @type {string} - * @memberof ExpansionItemV2024 - */ - 'state'?: string; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2024 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2024 { - /** - * - * @type {FormDefinitionSelfImportExportDtoV2024} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerSelfV2024 - */ - 'object'?: FormDefinitionSelfImportExportDtoV2024; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerV2024 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerV2024 { - /** - * - * @type {FormDefinitionResponseV2024} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2024 - */ - 'object'?: FormDefinitionResponseV2024; - /** - * - * @type {ExportFormDefinitionsByTenant200ResponseInnerSelfV2024} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2024 - */ - 'self'?: ExportFormDefinitionsByTenant200ResponseInnerSelfV2024; - /** - * - * @type {number} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2024 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ExportOptions1V2024 - */ -export interface ExportOptions1V2024 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptions1V2024 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptions1V2024 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2024; }} - * @memberof ExportOptions1V2024 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2024; }; -} - -export const ExportOptions1V2024ExcludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2024ExcludeTypesV2024 = typeof ExportOptions1V2024ExcludeTypesV2024[keyof typeof ExportOptions1V2024ExcludeTypesV2024]; -export const ExportOptions1V2024IncludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2024IncludeTypesV2024 = typeof ExportOptions1V2024IncludeTypesV2024[keyof typeof ExportOptions1V2024IncludeTypesV2024]; - -/** - * - * @export - * @interface ExportOptionsV2024 - */ -export interface ExportOptionsV2024 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptionsV2024 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptionsV2024 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2024; }} - * @memberof ExportOptionsV2024 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2024; }; -} - -export const ExportOptionsV2024ExcludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2024ExcludeTypesV2024 = typeof ExportOptionsV2024ExcludeTypesV2024[keyof typeof ExportOptionsV2024ExcludeTypesV2024]; -export const ExportOptionsV2024IncludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2024IncludeTypesV2024 = typeof ExportOptionsV2024IncludeTypesV2024[keyof typeof ExportOptionsV2024IncludeTypesV2024]; - -/** - * - * @export - * @interface ExportPayloadV2024 - */ -export interface ExportPayloadV2024 { - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof ExportPayloadV2024 - */ - 'description'?: string; - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportPayloadV2024 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportPayloadV2024 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2024; }} - * @memberof ExportPayloadV2024 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2024; }; -} - -export const ExportPayloadV2024ExcludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2024ExcludeTypesV2024 = typeof ExportPayloadV2024ExcludeTypesV2024[keyof typeof ExportPayloadV2024ExcludeTypesV2024]; -export const ExportPayloadV2024IncludeTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2024IncludeTypesV2024 = typeof ExportPayloadV2024IncludeTypesV2024[keyof typeof ExportPayloadV2024IncludeTypesV2024]; - -/** - * - * @export - * @interface ExpressionChildrenInnerV2024 - */ -export interface ExpressionChildrenInnerV2024 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionChildrenInnerV2024 - */ - 'operator'?: ExpressionChildrenInnerV2024OperatorV2024; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionChildrenInnerV2024 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2024} - * @memberof ExpressionChildrenInnerV2024 - */ - 'value'?: ValueV2024 | null; - /** - * There cannot be anymore nested children. This will always be null. - * @type {string} - * @memberof ExpressionChildrenInnerV2024 - */ - 'children'?: string | null; -} - -export const ExpressionChildrenInnerV2024OperatorV2024 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionChildrenInnerV2024OperatorV2024 = typeof ExpressionChildrenInnerV2024OperatorV2024[keyof typeof ExpressionChildrenInnerV2024OperatorV2024]; - -/** - * - * @export - * @interface ExpressionV2024 - */ -export interface ExpressionV2024 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionV2024 - */ - 'operator'?: ExpressionV2024OperatorV2024; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionV2024 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2024} - * @memberof ExpressionV2024 - */ - 'value'?: ValueV2024 | null; - /** - * List of expressions - * @type {Array} - * @memberof ExpressionV2024 - */ - 'children'?: Array | null; -} - -export const ExpressionV2024OperatorV2024 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionV2024OperatorV2024 = typeof ExpressionV2024OperatorV2024[keyof typeof ExpressionV2024OperatorV2024]; - -/** - * Attributes related to an external trigger - * @export - * @interface ExternalAttributesV2024 - */ -export interface ExternalAttributesV2024 { - /** - * A unique name for the external trigger - * @type {string} - * @memberof ExternalAttributesV2024 - */ - 'name'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof ExternalAttributesV2024 - */ - 'description'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof ExternalAttributesV2024 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof ExternalAttributesV2024 - */ - 'url'?: string | null; -} -/** - * - * @export - * @interface FeatureValueDtoV2024 - */ -export interface FeatureValueDtoV2024 { - /** - * The type of feature - * @type {string} - * @memberof FeatureValueDtoV2024 - */ - 'feature'?: string; - /** - * The number of identities that have access to the feature - * @type {number} - * @memberof FeatureValueDtoV2024 - */ - 'numerator'?: number; - /** - * The number of identities with the corresponding feature - * @type {number} - * @memberof FeatureValueDtoV2024 - */ - 'denominator'?: number; -} -/** - * - * @export - * @interface FederationProtocolDetailsV2024 - */ -export interface FederationProtocolDetailsV2024 { - /** - * Federation protocol role - * @type {string} - * @memberof FederationProtocolDetailsV2024 - */ - 'role'?: FederationProtocolDetailsV2024RoleV2024; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof FederationProtocolDetailsV2024 - */ - 'entityId'?: string; -} - -export const FederationProtocolDetailsV2024RoleV2024 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type FederationProtocolDetailsV2024RoleV2024 = typeof FederationProtocolDetailsV2024RoleV2024[keyof typeof FederationProtocolDetailsV2024RoleV2024]; - -/** - * - * @export - * @interface FieldDetailsDtoV2024 - */ -export interface FieldDetailsDtoV2024 { - /** - * The name of the attribute. - * @type {string} - * @memberof FieldDetailsDtoV2024 - */ - 'name'?: string; - /** - * The transform to apply to the field - * @type {object} - * @memberof FieldDetailsDtoV2024 - */ - 'transform'?: object; - /** - * Attributes required for the transform - * @type {object} - * @memberof FieldDetailsDtoV2024 - */ - 'attributes'?: object; - /** - * Flag indicating whether or not the attribute is required. - * @type {boolean} - * @memberof FieldDetailsDtoV2024 - */ - 'isRequired'?: boolean; - /** - * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. - * @type {string} - * @memberof FieldDetailsDtoV2024 - */ - 'type'?: FieldDetailsDtoV2024TypeV2024; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof FieldDetailsDtoV2024 - */ - 'isMultiValued'?: boolean; -} - -export const FieldDetailsDtoV2024TypeV2024 = { - String: 'string', - Int: 'int', - Long: 'long', - Date: 'date', - Boolean: 'boolean', - Secret: 'secret' -} as const; - -export type FieldDetailsDtoV2024TypeV2024 = typeof FieldDetailsDtoV2024TypeV2024[keyof typeof FieldDetailsDtoV2024TypeV2024]; - -/** - * An additional filter to constrain the results of the search query. - * @export - * @interface FilterAggregationV2024 - */ -export interface FilterAggregationV2024 { - /** - * The name of the filter aggregate to be included in the result. - * @type {string} - * @memberof FilterAggregationV2024 - */ - 'name': string; - /** - * - * @type {SearchFilterTypeV2024} - * @memberof FilterAggregationV2024 - */ - 'type'?: SearchFilterTypeV2024; - /** - * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof FilterAggregationV2024 - */ - 'field': string; - /** - * The value to filter on. - * @type {string} - * @memberof FilterAggregationV2024 - */ - 'value': string; -} - - -/** - * Enum representing the currently supported filter types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const FilterTypeV2024 = { - Exists: 'EXISTS', - Range: 'RANGE', - Terms: 'TERMS' -} as const; - -export type FilterTypeV2024 = typeof FilterTypeV2024[keyof typeof FilterTypeV2024]; - - -/** - * - * @export - * @interface FilterV2024 - */ -export interface FilterV2024 { - /** - * - * @type {FilterTypeV2024} - * @memberof FilterV2024 - */ - 'type'?: FilterTypeV2024; - /** - * - * @type {RangeV2024} - * @memberof FilterV2024 - */ - 'range'?: RangeV2024; - /** - * The terms to be filtered. - * @type {Array} - * @memberof FilterV2024 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof FilterV2024 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface FirstValidV2024 - */ -export interface FirstValidV2024 { - /** - * An array of attributes to evaluate for existence. - * @type {Array} - * @memberof FirstValidV2024 - */ - 'values': Array; - /** - * a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - * @type {boolean} - * @memberof FirstValidV2024 - */ - 'ignoreErrors'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof FirstValidV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Represent a form conditional. - * @export - * @interface FormConditionV2024 - */ -export interface FormConditionV2024 { - /** - * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr - * @type {string} - * @memberof FormConditionV2024 - */ - 'ruleOperator'?: FormConditionV2024RuleOperatorV2024; - /** - * List of rules. - * @type {Array} - * @memberof FormConditionV2024 - */ - 'rules'?: Array; - /** - * List of effects. - * @type {Array} - * @memberof FormConditionV2024 - */ - 'effects'?: Array; -} - -export const FormConditionV2024RuleOperatorV2024 = { - And: 'AND', - Or: 'OR' -} as const; - -export type FormConditionV2024RuleOperatorV2024 = typeof FormConditionV2024RuleOperatorV2024[keyof typeof FormConditionV2024RuleOperatorV2024]; - -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestAttributesV2024 - */ -export interface FormDefinitionDynamicSchemaRequestAttributesV2024 { - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestAttributesV2024 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestV2024 - */ -export interface FormDefinitionDynamicSchemaRequestV2024 { - /** - * - * @type {FormDefinitionDynamicSchemaRequestAttributesV2024} - * @memberof FormDefinitionDynamicSchemaRequestV2024 - */ - 'attributes'?: FormDefinitionDynamicSchemaRequestAttributesV2024; - /** - * Description is the form definition dynamic schema description text - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2024 - */ - 'description'?: string; - /** - * ID is a unique identifier - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2024 - */ - 'id'?: string; - /** - * Type is the form definition dynamic schema type - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2024 - */ - 'type'?: string; - /** - * VersionNumber is the form definition dynamic schema version number - * @type {number} - * @memberof FormDefinitionDynamicSchemaRequestV2024 - */ - 'versionNumber'?: number; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaResponseV2024 - */ -export interface FormDefinitionDynamicSchemaResponseV2024 { - /** - * OutputSchema holds a JSON schema generated dynamically - * @type {{ [key: string]: object; }} - * @memberof FormDefinitionDynamicSchemaResponseV2024 - */ - 'outputSchema'?: { [key: string]: object; }; -} -/** - * - * @export - * @interface FormDefinitionFileUploadResponseV2024 - */ -export interface FormDefinitionFileUploadResponseV2024 { - /** - * Created is the date the file was uploaded - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2024 - */ - 'created'?: string; - /** - * fileId is a unique ULID that serves as an identifier for the form definition file - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2024 - */ - 'fileId'?: string; - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2024 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionInputV2024 - */ -export interface FormDefinitionInputV2024 { - /** - * Unique identifier for the form input. - * @type {string} - * @memberof FormDefinitionInputV2024 - */ - 'id'?: string; - /** - * FormDefinitionInputType value. STRING FormDefinitionInputTypeString - * @type {string} - * @memberof FormDefinitionInputV2024 - */ - 'type'?: FormDefinitionInputV2024TypeV2024; - /** - * Name for the form input. - * @type {string} - * @memberof FormDefinitionInputV2024 - */ - 'label'?: string; - /** - * Form input\'s description. - * @type {string} - * @memberof FormDefinitionInputV2024 - */ - 'description'?: string; -} - -export const FormDefinitionInputV2024TypeV2024 = { - String: 'STRING', - Array: 'ARRAY' -} as const; - -export type FormDefinitionInputV2024TypeV2024 = typeof FormDefinitionInputV2024TypeV2024[keyof typeof FormDefinitionInputV2024TypeV2024]; - -/** - * - * @export - * @interface FormDefinitionResponseV2024 - */ -export interface FormDefinitionResponseV2024 { - /** - * Unique guid identifying the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2024 - */ - 'id'?: string; - /** - * Name of the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2024 - */ - 'name'?: string; - /** - * Form definition\'s description. - * @type {string} - * @memberof FormDefinitionResponseV2024 - */ - 'description'?: string; - /** - * - * @type {FormOwnerV2024} - * @memberof FormDefinitionResponseV2024 - */ - 'owner'?: FormOwnerV2024; - /** - * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. - * @type {Array} - * @memberof FormDefinitionResponseV2024 - */ - 'usedBy'?: Array; - /** - * List of form inputs required to create a form-instance object. - * @type {Array} - * @memberof FormDefinitionResponseV2024 - */ - 'formInput'?: Array; - /** - * List of nested form elements. - * @type {Array} - * @memberof FormDefinitionResponseV2024 - */ - 'formElements'?: Array; - /** - * Conditional logic that can dynamically modify the form as the recipient is interacting with it. - * @type {Array} - * @memberof FormDefinitionResponseV2024 - */ - 'formConditions'?: Array; - /** - * Created is the date the form definition was created - * @type {string} - * @memberof FormDefinitionResponseV2024 - */ - 'created'?: string; - /** - * Modified is the last date the form definition was modified - * @type {string} - * @memberof FormDefinitionResponseV2024 - */ - 'modified'?: string; -} -/** - * Self block for imported/exported object. - * @export - * @interface FormDefinitionSelfImportExportDtoV2024 - */ -export interface FormDefinitionSelfImportExportDtoV2024 { - /** - * Imported/exported object\'s DTO type. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2024 - */ - 'type'?: FormDefinitionSelfImportExportDtoV2024TypeV2024; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2024 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2024 - */ - 'name'?: string; -} - -export const FormDefinitionSelfImportExportDtoV2024TypeV2024 = { - FormDefinition: 'FORM_DEFINITION' -} as const; - -export type FormDefinitionSelfImportExportDtoV2024TypeV2024 = typeof FormDefinitionSelfImportExportDtoV2024TypeV2024[keyof typeof FormDefinitionSelfImportExportDtoV2024TypeV2024]; - -/** - * - * @export - * @interface FormDetailsV2024 - */ -export interface FormDetailsV2024 { - /** - * ID of the form - * @type {string} - * @memberof FormDetailsV2024 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormDetailsV2024 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormDetailsV2024 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof FormDetailsV2024 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormDetailsV2024 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof FormDetailsV2024 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface FormElementDataSourceConfigOptionsV2024 - */ -export interface FormElementDataSourceConfigOptionsV2024 { - /** - * Label is the main label to display to the user when selecting this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2024 - */ - 'label'?: string; - /** - * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2024 - */ - 'subLabel'?: string; - /** - * Value is the value to save as an entry when the user selects this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface FormElementDynamicDataSourceConfigV2024 - */ -export interface FormElementDynamicDataSourceConfigV2024 { - /** - * AggregationBucketField is the aggregation bucket field name - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2024 - */ - 'aggregationBucketField'?: string; - /** - * Indices is a list of indices to use - * @type {Array} - * @memberof FormElementDynamicDataSourceConfigV2024 - */ - 'indices'?: Array; - /** - * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2024 - */ - 'objectType'?: FormElementDynamicDataSourceConfigV2024ObjectTypeV2024; - /** - * Query is a text - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2024 - */ - 'query'?: string; -} - -export const FormElementDynamicDataSourceConfigV2024IndicesV2024 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Identities: 'identities', - Events: 'events', - Roles: 'roles', - Star: '*' -} as const; - -export type FormElementDynamicDataSourceConfigV2024IndicesV2024 = typeof FormElementDynamicDataSourceConfigV2024IndicesV2024[keyof typeof FormElementDynamicDataSourceConfigV2024IndicesV2024]; -export const FormElementDynamicDataSourceConfigV2024ObjectTypeV2024 = { - Identity: 'IDENTITY', - AccessProfile: 'ACCESS_PROFILE', - Sources: 'SOURCES', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type FormElementDynamicDataSourceConfigV2024ObjectTypeV2024 = typeof FormElementDynamicDataSourceConfigV2024ObjectTypeV2024[keyof typeof FormElementDynamicDataSourceConfigV2024ObjectTypeV2024]; - -/** - * - * @export - * @interface FormElementDynamicDataSourceV2024 - */ -export interface FormElementDynamicDataSourceV2024 { - /** - * - * @type {FormElementDynamicDataSourceConfigV2024} - * @memberof FormElementDynamicDataSourceV2024 - */ - 'config'?: FormElementDynamicDataSourceConfigV2024; - /** - * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput - * @type {string} - * @memberof FormElementDynamicDataSourceV2024 - */ - 'dataSourceType'?: FormElementDynamicDataSourceV2024DataSourceTypeV2024; -} - -export const FormElementDynamicDataSourceV2024DataSourceTypeV2024 = { - Static: 'STATIC', - Internal: 'INTERNAL', - Search: 'SEARCH', - FormInput: 'FORM_INPUT' -} as const; - -export type FormElementDynamicDataSourceV2024DataSourceTypeV2024 = typeof FormElementDynamicDataSourceV2024DataSourceTypeV2024[keyof typeof FormElementDynamicDataSourceV2024DataSourceTypeV2024]; - -/** - * - * @export - * @interface FormElementPreviewRequestV2024 - */ -export interface FormElementPreviewRequestV2024 { - /** - * - * @type {FormElementDynamicDataSourceV2024} - * @memberof FormElementPreviewRequestV2024 - */ - 'dataSource'?: FormElementDynamicDataSourceV2024; -} -/** - * - * @export - * @interface FormElementV2024 - */ -export interface FormElementV2024 { - /** - * Form element identifier. - * @type {string} - * @memberof FormElementV2024 - */ - 'id'?: string; - /** - * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription - * @type {string} - * @memberof FormElementV2024 - */ - 'elementType'?: FormElementV2024ElementTypeV2024; - /** - * Config object. - * @type {{ [key: string]: any; }} - * @memberof FormElementV2024 - */ - 'config'?: { [key: string]: any; }; - /** - * Technical key. - * @type {string} - * @memberof FormElementV2024 - */ - 'key'?: string; - /** - * - * @type {Array} - * @memberof FormElementV2024 - */ - 'validations'?: Array | null; -} - -export const FormElementV2024ElementTypeV2024 = { - Text: 'TEXT', - Toggle: 'TOGGLE', - Textarea: 'TEXTAREA', - Hidden: 'HIDDEN', - Phone: 'PHONE', - Email: 'EMAIL', - Select: 'SELECT', - Date: 'DATE', - Section: 'SECTION', - ColumnSet: 'COLUMN_SET', - Image: 'IMAGE', - Description: 'DESCRIPTION' -} as const; - -export type FormElementV2024ElementTypeV2024 = typeof FormElementV2024ElementTypeV2024[keyof typeof FormElementV2024ElementTypeV2024]; - -/** - * Set of FormElementValidation items. - * @export - * @interface FormElementValidationsSetV2024 - */ -export interface FormElementValidationsSetV2024 { - /** - * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. - * @type {string} - * @memberof FormElementValidationsSetV2024 - */ - 'validationType'?: FormElementValidationsSetV2024ValidationTypeV2024; -} - -export const FormElementValidationsSetV2024ValidationTypeV2024 = { - Required: 'REQUIRED', - MinLength: 'MIN_LENGTH', - MaxLength: 'MAX_LENGTH', - Regex: 'REGEX', - Date: 'DATE', - MaxDate: 'MAX_DATE', - MinDate: 'MIN_DATE', - LessThanDate: 'LESS_THAN_DATE', - Phone: 'PHONE', - Email: 'EMAIL', - DataSource: 'DATA_SOURCE', - Textarea: 'TEXTAREA' -} as const; - -export type FormElementValidationsSetV2024ValidationTypeV2024 = typeof FormElementValidationsSetV2024ValidationTypeV2024[keyof typeof FormElementValidationsSetV2024ValidationTypeV2024]; - -/** - * - * @export - * @interface FormErrorV2024 - */ -export interface FormErrorV2024 { - /** - * Key is the technical key - * @type {string} - * @memberof FormErrorV2024 - */ - 'key'?: string; - /** - * Messages is a list of web.ErrorMessage items - * @type {Array} - * @memberof FormErrorV2024 - */ - 'messages'?: Array; - /** - * Value is the value associated with a Key - * @type {object} - * @memberof FormErrorV2024 - */ - 'value'?: object; -} -/** - * - * @export - * @interface FormInstanceCreatedByV2024 - */ -export interface FormInstanceCreatedByV2024 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceCreatedByV2024 - */ - 'id'?: string; - /** - * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource - * @type {string} - * @memberof FormInstanceCreatedByV2024 - */ - 'type'?: FormInstanceCreatedByV2024TypeV2024; -} - -export const FormInstanceCreatedByV2024TypeV2024 = { - WorkflowExecution: 'WORKFLOW_EXECUTION', - Source: 'SOURCE' -} as const; - -export type FormInstanceCreatedByV2024TypeV2024 = typeof FormInstanceCreatedByV2024TypeV2024[keyof typeof FormInstanceCreatedByV2024TypeV2024]; - -/** - * - * @export - * @interface FormInstanceRecipientV2024 - */ -export interface FormInstanceRecipientV2024 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceRecipientV2024 - */ - 'id'?: string; - /** - * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity - * @type {string} - * @memberof FormInstanceRecipientV2024 - */ - 'type'?: FormInstanceRecipientV2024TypeV2024; -} - -export const FormInstanceRecipientV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type FormInstanceRecipientV2024TypeV2024 = typeof FormInstanceRecipientV2024TypeV2024[keyof typeof FormInstanceRecipientV2024TypeV2024]; - -/** - * - * @export - * @interface FormInstanceResponseV2024 - */ -export interface FormInstanceResponseV2024 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'state'?: FormInstanceResponseV2024StateV2024; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof FormInstanceResponseV2024 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2024} - * @memberof FormInstanceResponseV2024 - */ - 'createdBy'?: FormInstanceCreatedByV2024; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof FormInstanceResponseV2024 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof FormInstanceResponseV2024 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof FormInstanceResponseV2024 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof FormInstanceResponseV2024 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof FormInstanceResponseV2024 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof FormInstanceResponseV2024 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof FormInstanceResponseV2024 - */ - 'recipients'?: Array; -} - -export const FormInstanceResponseV2024StateV2024 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type FormInstanceResponseV2024StateV2024 = typeof FormInstanceResponseV2024StateV2024[keyof typeof FormInstanceResponseV2024StateV2024]; - -/** - * - * @export - * @interface FormItemDetailsV2024 - */ -export interface FormItemDetailsV2024 { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemDetailsV2024 - */ - 'name'?: string | null; -} -/** - * - * @export - * @interface FormOwnerV2024 - */ -export interface FormOwnerV2024 { - /** - * FormOwnerType value. IDENTITY FormOwnerTypeIdentity - * @type {string} - * @memberof FormOwnerV2024 - */ - 'type'?: FormOwnerV2024TypeV2024; - /** - * Unique identifier of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2024 - */ - 'id'?: string; - /** - * Name of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2024 - */ - 'name'?: string; -} - -export const FormOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type FormOwnerV2024TypeV2024 = typeof FormOwnerV2024TypeV2024[keyof typeof FormOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface FormUsedByV2024 - */ -export interface FormUsedByV2024 { - /** - * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType - * @type {string} - * @memberof FormUsedByV2024 - */ - 'type'?: FormUsedByV2024TypeV2024; - /** - * Unique identifier of the system using the form. - * @type {string} - * @memberof FormUsedByV2024 - */ - 'id'?: string; - /** - * Name of the system using the form. - * @type {string} - * @memberof FormUsedByV2024 - */ - 'name'?: string; -} - -export const FormUsedByV2024TypeV2024 = { - Workflow: 'WORKFLOW', - Source: 'SOURCE', - MySailPoint: 'MySailPoint' -} as const; - -export type FormUsedByV2024TypeV2024 = typeof FormUsedByV2024TypeV2024[keyof typeof FormUsedByV2024TypeV2024]; - -/** - * - * @export - * @interface ForwardApprovalDtoV2024 - */ -export interface ForwardApprovalDtoV2024 { - /** - * The Id of the new owner - * @type {string} - * @memberof ForwardApprovalDtoV2024 - */ - 'newOwnerId': string; - /** - * The comment provided by the forwarder - * @type {string} - * @memberof ForwardApprovalDtoV2024 - */ - 'comment': string; -} -/** - * Discovered applications with their respective associated sources - * @export - * @interface FullDiscoveredApplicationsV2024 - */ -export interface FullDiscoveredApplicationsV2024 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'status'?: string; - /** - * List of associated sources related to this discovered application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'associatedSources'?: Array; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2024 - */ - 'riskLevel'?: FullDiscoveredApplicationsV2024RiskLevelV2024; -} - -export const FullDiscoveredApplicationsV2024RiskLevelV2024 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type FullDiscoveredApplicationsV2024RiskLevelV2024 = typeof FullDiscoveredApplicationsV2024RiskLevelV2024[keyof typeof FullDiscoveredApplicationsV2024RiskLevelV2024]; - -/** - * - * @export - * @interface GenerateRandomStringV2024 - */ -export interface GenerateRandomStringV2024 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GenerateRandomStringV2024 - */ - 'name': string; - /** - * The operation to perform `generateRandomString` - * @type {string} - * @memberof GenerateRandomStringV2024 - */ - 'operation': string; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers - * @type {boolean} - * @memberof GenerateRandomStringV2024 - */ - 'includeNumbers': boolean; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters - * @type {boolean} - * @memberof GenerateRandomStringV2024 - */ - 'includeSpecialChars': boolean; - /** - * This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - * @type {string} - * @memberof GenerateRandomStringV2024 - */ - 'length': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GenerateRandomStringV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetActiveCampaigns200ResponseInnerV2024 - */ -export interface GetActiveCampaigns200ResponseInnerV2024 { - /** - * Id of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'type': GetActiveCampaigns200ResponseInnerV2024TypeV2024; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'status'?: GetActiveCampaigns200ResponseInnerV2024StatusV2024 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'correlatedStatus'?: GetActiveCampaigns200ResponseInnerV2024CorrelatedStatusV2024; - /** - * Created time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2024} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'filter'?: CampaignAllOfFilterV2024 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2024} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2024} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2024} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2024} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2024 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2024 - */ - 'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerV2024MandatoryCommentRequirementV2024; -} - -export const GetActiveCampaigns200ResponseInnerV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2024TypeV2024 = typeof GetActiveCampaigns200ResponseInnerV2024TypeV2024[keyof typeof GetActiveCampaigns200ResponseInnerV2024TypeV2024]; -export const GetActiveCampaigns200ResponseInnerV2024StatusV2024 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2024StatusV2024 = typeof GetActiveCampaigns200ResponseInnerV2024StatusV2024[keyof typeof GetActiveCampaigns200ResponseInnerV2024StatusV2024]; -export const GetActiveCampaigns200ResponseInnerV2024CorrelatedStatusV2024 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2024CorrelatedStatusV2024 = typeof GetActiveCampaigns200ResponseInnerV2024CorrelatedStatusV2024[keyof typeof GetActiveCampaigns200ResponseInnerV2024CorrelatedStatusV2024]; -export const GetActiveCampaigns200ResponseInnerV2024MandatoryCommentRequirementV2024 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2024MandatoryCommentRequirementV2024 = typeof GetActiveCampaigns200ResponseInnerV2024MandatoryCommentRequirementV2024[keyof typeof GetActiveCampaigns200ResponseInnerV2024MandatoryCommentRequirementV2024]; - -/** - * - * @export - * @interface GetCampaign200ResponseV2024 - */ -export interface GetCampaign200ResponseV2024 { - /** - * Id of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'type': GetCampaign200ResponseV2024TypeV2024; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2024 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2024 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetCampaign200ResponseV2024 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'status'?: GetCampaign200ResponseV2024StatusV2024 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'correlatedStatus'?: GetCampaign200ResponseV2024CorrelatedStatusV2024; - /** - * Created time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2024 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2024 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetCampaign200ResponseV2024 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2024} - * @memberof GetCampaign200ResponseV2024 - */ - 'filter'?: CampaignAllOfFilterV2024 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetCampaign200ResponseV2024 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2024} - * @memberof GetCampaign200ResponseV2024 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2024} - * @memberof GetCampaign200ResponseV2024 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2024} - * @memberof GetCampaign200ResponseV2024 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2024 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2024} - * @memberof GetCampaign200ResponseV2024 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2024 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetCampaign200ResponseV2024 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetCampaign200ResponseV2024 - */ - 'mandatoryCommentRequirement'?: GetCampaign200ResponseV2024MandatoryCommentRequirementV2024; -} - -export const GetCampaign200ResponseV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetCampaign200ResponseV2024TypeV2024 = typeof GetCampaign200ResponseV2024TypeV2024[keyof typeof GetCampaign200ResponseV2024TypeV2024]; -export const GetCampaign200ResponseV2024StatusV2024 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetCampaign200ResponseV2024StatusV2024 = typeof GetCampaign200ResponseV2024StatusV2024[keyof typeof GetCampaign200ResponseV2024StatusV2024]; -export const GetCampaign200ResponseV2024CorrelatedStatusV2024 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetCampaign200ResponseV2024CorrelatedStatusV2024 = typeof GetCampaign200ResponseV2024CorrelatedStatusV2024[keyof typeof GetCampaign200ResponseV2024CorrelatedStatusV2024]; -export const GetCampaign200ResponseV2024MandatoryCommentRequirementV2024 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetCampaign200ResponseV2024MandatoryCommentRequirementV2024 = typeof GetCampaign200ResponseV2024MandatoryCommentRequirementV2024[keyof typeof GetCampaign200ResponseV2024MandatoryCommentRequirementV2024]; - -/** - * @type GetDiscoveredApplications200ResponseInnerV2024 - * @export - */ -export type GetDiscoveredApplications200ResponseInnerV2024 = FullDiscoveredApplicationsV2024 | SlimDiscoveredApplicationsV2024; - -/** - * - * @export - * @interface GetHistoricalIdentityEvents200ResponseInnerV2024 - */ -export interface GetHistoricalIdentityEvents200ResponseInnerV2024 { - /** - * the id of the certification item - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2024} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'signer'?: CertifierResponseV2024; - /** - * the event type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2024} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'accessItem': AccessItemAssociatedAccessItemV2024; - /** - * - * @type {CorrelatedGovernanceEventV2024} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'governanceEvent': CorrelatedGovernanceEventV2024 | null; - /** - * the access item type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'accessItemType'?: GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024; - /** - * - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'attributeChanges': Array; - /** - * - * @type {AccessRequestedAccountV2024} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'account': AccessRequestedAccountV2024; - /** - * - * @type {AccessRequestedStatusChangeV2024} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2024 - */ - 'statusChange': AccessRequestedStatusChangeV2024; -} - -export const GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024 = typeof GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024[keyof typeof GetHistoricalIdentityEvents200ResponseInnerV2024AccessItemTypeV2024]; - -/** - * - * @export - * @interface GetLaunchers200ResponseV2024 - */ -export interface GetLaunchers200ResponseV2024 { - /** - * Pagination marker - * @type {string} - * @memberof GetLaunchers200ResponseV2024 - */ - 'next'?: string; - /** - * - * @type {Array} - * @memberof GetLaunchers200ResponseV2024 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface GetOAuthClientResponseV2024 - */ -export interface GetOAuthClientResponseV2024 { - /** - * ID of the OAuth client - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'id': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'businessName': string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'homepageUrl': string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2024 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2024 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof GetOAuthClientResponseV2024 - */ - 'redirectUris': Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof GetOAuthClientResponseV2024 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2024} - * @memberof GetOAuthClientResponseV2024 - */ - 'accessType': AccessTypeV2024; - /** - * - * @type {ClientTypeV2024} - * @memberof GetOAuthClientResponseV2024 - */ - 'type': ClientTypeV2024; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof GetOAuthClientResponseV2024 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof GetOAuthClientResponseV2024 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof GetOAuthClientResponseV2024 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof GetOAuthClientResponseV2024 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'modified': string; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'secret'?: string | null; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'metadata'?: string | null; - /** - * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - * @type {string} - * @memberof GetOAuthClientResponseV2024 - */ - 'lastUsed'?: string | null; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof GetOAuthClientResponseV2024 - */ - 'scope': Array | null; -} - - -/** - * - * @export - * @interface GetPersonalAccessTokenResponseV2024 - */ -export interface GetPersonalAccessTokenResponseV2024 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'id': string; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'name': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'scope': Array | null; - /** - * - * @type {PatOwnerV2024} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'owner': PatOwnerV2024; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'lastUsed'?: string | null; - /** - * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'managed'?: boolean; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'accessTokenValiditySeconds'?: number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2024 - */ - 'expirationDate'?: string; -} -/** - * - * @export - * @interface GetReferenceIdentityAttributeV2024 - */ -export interface GetReferenceIdentityAttributeV2024 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GetReferenceIdentityAttributeV2024 - */ - 'name': string; - /** - * The operation to perform `getReferenceIdentityAttribute` - * @type {string} - * @memberof GetReferenceIdentityAttributeV2024 - */ - 'operation': string; - /** - * This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user\'s manager and then get that manager\'s identity attribute. - * @type {string} - * @memberof GetReferenceIdentityAttributeV2024 - */ - 'uid': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GetReferenceIdentityAttributeV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetRoleAssignments200ResponseInnerV2024 - */ -export interface GetRoleAssignments200ResponseInnerV2024 { - /** - * Assignment Id - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'role'?: BaseReferenceDtoV2024; - /** - * Date that the assignment was added - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'removeDate'?: string | null; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2024} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2024; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2024} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2024; - /** - * - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2024 - */ - 'accountTargets'?: Array; -} -/** - * - * @export - * @interface GetTenantContext200ResponseInnerV2024 - */ -export interface GetTenantContext200ResponseInnerV2024 { - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2024 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2024 - */ - 'value'?: string; -} -/** - * OAuth2 Grant Type - * @export - * @enum {string} - */ - -export const GrantTypeV2024 = { - ClientCredentials: 'CLIENT_CREDENTIALS', - AuthorizationCode: 'AUTHORIZATION_CODE', - RefreshToken: 'REFRESH_TOKEN' -} as const; - -export type GrantTypeV2024 = typeof GrantTypeV2024[keyof typeof GrantTypeV2024]; - - -/** - * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. - * @export - * @enum {string} - */ - -export const HttpAuthenticationTypeV2024 = { - NoAuth: 'NO_AUTH', - BasicAuth: 'BASIC_AUTH', - BearerToken: 'BEARER_TOKEN' -} as const; - -export type HttpAuthenticationTypeV2024 = typeof HttpAuthenticationTypeV2024[keyof typeof HttpAuthenticationTypeV2024]; - - -/** - * - * @export - * @interface HttpConfigV2024 - */ -export interface HttpConfigV2024 { - /** - * URL of the external/custom integration. - * @type {string} - * @memberof HttpConfigV2024 - */ - 'url': string; - /** - * - * @type {HttpDispatchModeV2024} - * @memberof HttpConfigV2024 - */ - 'httpDispatchMode': HttpDispatchModeV2024; - /** - * - * @type {HttpAuthenticationTypeV2024} - * @memberof HttpConfigV2024 - */ - 'httpAuthenticationType'?: HttpAuthenticationTypeV2024; - /** - * - * @type {BasicAuthConfigV2024} - * @memberof HttpConfigV2024 - */ - 'basicAuthConfig'?: BasicAuthConfigV2024 | null; - /** - * - * @type {BearerTokenAuthConfigV2024} - * @memberof HttpConfigV2024 - */ - 'bearerTokenAuthConfig'?: BearerTokenAuthConfigV2024 | null; -} - - -/** - * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. - * @export - * @enum {string} - */ - -export const HttpDispatchModeV2024 = { - Sync: 'SYNC', - Async: 'ASYNC', - Dynamic: 'DYNAMIC' -} as const; - -export type HttpDispatchModeV2024 = typeof HttpDispatchModeV2024[keyof typeof HttpDispatchModeV2024]; - - -/** - * - * @export - * @interface ISO3166V2024 - */ -export interface ISO3166V2024 { - /** - * An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., \"USA\") `numeric` - The numeric country code (e.g., \"840\") - * @type {string} - * @memberof ISO3166V2024 - */ - 'format'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ISO3166V2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ISO3166V2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentitiesAccountsBulkRequestV2024 - */ -export interface IdentitiesAccountsBulkRequestV2024 { - /** - * The ids of the identities for which enable/disable accounts. - * @type {Array} - * @memberof IdentitiesAccountsBulkRequestV2024 - */ - 'identityIds'?: Array; -} -/** - * Arguments for Identities Details report (IDENTITIES_DETAILS) - * @export - * @interface IdentitiesDetailsReportArgumentsV2024 - */ -export interface IdentitiesDetailsReportArgumentsV2024 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesDetailsReportArgumentsV2024 - */ - 'correlatedOnly': boolean; -} -/** - * Arguments for Identities report (IDENTITIES) - * @export - * @interface IdentitiesReportArgumentsV2024 - */ -export interface IdentitiesReportArgumentsV2024 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesReportArgumentsV2024 - */ - 'correlatedOnly'?: boolean; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface Identity1V2024 - */ -export interface Identity1V2024 { - /** - * The ID of the object - * @type {string} - * @memberof Identity1V2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object - * @type {string} - * @memberof Identity1V2024 - */ - 'name'?: string; -} -/** - * @type IdentityAccessV2024 - * @export - */ -export type IdentityAccessV2024 = { type: 'ACCESS_PROFILE' } & AccessProfileSummaryV2024 | { type: 'ENTITLEMENT' } & AccessProfileEntitlementV2024 | { type: 'ROLE' } & AccessProfileRoleV2024; - -/** - * - * @export - * @interface IdentityAccountSelectionsV2024 - */ -export interface IdentityAccountSelectionsV2024 { - /** - * Available account selections for the identity, per requested item - * @type {Array} - * @memberof IdentityAccountSelectionsV2024 - */ - 'requestedItems'?: Array; - /** - * A boolean indicating whether any account selections will be required for the user to raise an access request - * @type {boolean} - * @memberof IdentityAccountSelectionsV2024 - */ - 'accountsSelectionRequired'?: boolean; - /** - * - * @type {DtoTypeV2024} - * @memberof IdentityAccountSelectionsV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The identity id for the user - * @type {string} - * @memberof IdentityAccountSelectionsV2024 - */ - 'id'?: string; - /** - * The name of the identity - * @type {string} - * @memberof IdentityAccountSelectionsV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityAssociationDetailsAssociationDetailsInnerV2024 - */ -export interface IdentityAssociationDetailsAssociationDetailsInnerV2024 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2024 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2024 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityAssociationDetailsV2024 - */ -export interface IdentityAssociationDetailsV2024 { - /** - * any additional context information of the http call result - * @type {string} - * @memberof IdentityAssociationDetailsV2024 - */ - 'message'?: string; - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityAssociationDetailsV2024 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityAttribute1V2024 - */ -export interface IdentityAttribute1V2024 { - /** - * The system (camel-cased) name of the identity attribute to bring in - * @type {string} - * @memberof IdentityAttribute1V2024 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IdentityAttribute1V2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IdentityAttribute1V2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - * @export - * @interface IdentityAttributeConfigV2024 - */ -export interface IdentityAttributeConfigV2024 { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfigV2024 - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfigV2024 - */ - 'attributeTransforms'?: Array; -} -/** - * Identity attribute IDs. - * @export - * @interface IdentityAttributeNamesV2024 - */ -export interface IdentityAttributeNamesV2024 { - /** - * List of identity attributes\' technical names. - * @type {Array} - * @memberof IdentityAttributeNamesV2024 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface IdentityAttributePreviewV2024 - */ -export interface IdentityAttributePreviewV2024 { - /** - * Name of the attribute that is being previewed. - * @type {string} - * @memberof IdentityAttributePreviewV2024 - */ - 'name'?: string; - /** - * Value that was derived during the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2024 - */ - 'value'?: string; - /** - * The value of the attribute before the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2024 - */ - 'previousValue'?: string; - /** - * List of error messages - * @type {Array} - * @memberof IdentityAttributePreviewV2024 - */ - 'errorMessages'?: Array; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransformV2024 - */ -export interface IdentityAttributeTransformV2024 { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransformV2024 - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinitionV2024} - * @memberof IdentityAttributeTransformV2024 - */ - 'transformDefinition'?: TransformDefinitionV2024; -} -/** - * - * @export - * @interface IdentityAttributeV2024 - */ -export interface IdentityAttributeV2024 { - /** - * Identity attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributeV2024 - */ - 'name': string; - /** - * Identity attribute\'s business-friendly name. - * @type {string} - * @memberof IdentityAttributeV2024 - */ - 'displayName'?: string; - /** - * Indicates whether the attribute is \'standard\' or \'default\'. - * @type {boolean} - * @memberof IdentityAttributeV2024 - */ - 'standard'?: boolean; - /** - * Identity attribute\'s type. - * @type {string} - * @memberof IdentityAttributeV2024 - */ - 'type'?: string | null; - /** - * Indicates whether the identity attribute is multi-valued. - * @type {boolean} - * @memberof IdentityAttributeV2024 - */ - 'multi'?: boolean; - /** - * Indicates whether the identity attribute is searchable. - * @type {boolean} - * @memberof IdentityAttributeV2024 - */ - 'searchable'?: boolean; - /** - * Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. - * @type {boolean} - * @memberof IdentityAttributeV2024 - */ - 'system'?: boolean; - /** - * Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. - * @type {Array} - * @memberof IdentityAttributeV2024 - */ - 'sources'?: Array; -} -/** - * @type IdentityAttributesChangedChangesInnerNewValueV2024 - * The value of the identity attribute after it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerNewValueV2024 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2024; }; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2024 - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2024 = boolean | number | string; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueV2024 - * The value of the identity attribute before it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueV2024 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2024; }; - -/** - * - * @export - * @interface IdentityAttributesChangedChangesInnerV2024 - */ -export interface IdentityAttributesChangedChangesInnerV2024 { - /** - * The name of the identity attribute that changed. - * @type {string} - * @memberof IdentityAttributesChangedChangesInnerV2024 - */ - 'attribute': string; - /** - * - * @type {IdentityAttributesChangedChangesInnerOldValueV2024} - * @memberof IdentityAttributesChangedChangesInnerV2024 - */ - 'oldValue'?: IdentityAttributesChangedChangesInnerOldValueV2024 | null; - /** - * - * @type {IdentityAttributesChangedChangesInnerNewValueV2024} - * @memberof IdentityAttributesChangedChangesInnerV2024 - */ - 'newValue'?: IdentityAttributesChangedChangesInnerNewValueV2024; -} -/** - * Identity whose attributes changed. - * @export - * @interface IdentityAttributesChangedIdentityV2024 - */ -export interface IdentityAttributesChangedIdentityV2024 { - /** - * DTO type of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2024 - */ - 'type': IdentityAttributesChangedIdentityV2024TypeV2024; - /** - * ID of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2024 - */ - 'id': string; - /** - * Display name of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2024 - */ - 'name': string; -} - -export const IdentityAttributesChangedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityAttributesChangedIdentityV2024TypeV2024 = typeof IdentityAttributesChangedIdentityV2024TypeV2024[keyof typeof IdentityAttributesChangedIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface IdentityAttributesChangedV2024 - */ -export interface IdentityAttributesChangedV2024 { - /** - * - * @type {IdentityAttributesChangedIdentityV2024} - * @memberof IdentityAttributesChangedV2024 - */ - 'identity': IdentityAttributesChangedIdentityV2024; - /** - * A list of one or more identity attributes that changed on the identity. - * @type {Array} - * @memberof IdentityAttributesChangedV2024 - */ - 'changes': Array; -} -/** - * - * @export - * @interface IdentityCertDecisionSummaryV2024 - */ -export interface IdentityCertDecisionSummaryV2024 { - /** - * Number of entitlement decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'entitlementDecisionsMade'?: number; - /** - * Number of access profile decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accessProfileDecisionsMade'?: number; - /** - * Number of role decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'roleDecisionsMade'?: number; - /** - * Number of account decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accountDecisionsMade'?: number; - /** - * The total number of entitlement decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'entitlementDecisionsTotal'?: number; - /** - * The total number of access profile decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accessProfileDecisionsTotal'?: number; - /** - * The total number of role decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'roleDecisionsTotal'?: number; - /** - * The total number of account decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accountDecisionsTotal'?: number; - /** - * The number of entitlement decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'entitlementsApproved'?: number; - /** - * The number of entitlement decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'entitlementsRevoked'?: number; - /** - * The number of access profile decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accessProfilesApproved'?: number; - /** - * The number of access profile decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accessProfilesRevoked'?: number; - /** - * The number of role decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'rolesApproved'?: number; - /** - * The number of role decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'rolesRevoked'?: number; - /** - * The number of account decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accountsApproved'?: number; - /** - * The number of account decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2024 - */ - 'accountsRevoked'?: number; -} -/** - * - * @export - * @interface IdentityCertificationDtoV2024 - */ -export interface IdentityCertificationDtoV2024 { - /** - * id of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2024} - * @memberof IdentityCertificationDtoV2024 - */ - 'campaign'?: CampaignReferenceV2024; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof IdentityCertificationDtoV2024 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof IdentityCertificationDtoV2024 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof IdentityCertificationDtoV2024 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof IdentityCertificationDtoV2024 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof IdentityCertificationDtoV2024 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2024} - * @memberof IdentityCertificationDtoV2024 - */ - 'reviewer'?: ReviewerV2024; - /** - * - * @type {ReassignmentV2024} - * @memberof IdentityCertificationDtoV2024 - */ - 'reassignment'?: ReassignmentV2024 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof IdentityCertificationDtoV2024 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof IdentityCertificationDtoV2024 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2024} - * @memberof IdentityCertificationDtoV2024 - */ - 'phase'?: CertificationPhaseV2024; -} - - -/** - * - * @export - * @interface IdentityCertifiedV2024 - */ -export interface IdentityCertifiedV2024 { - /** - * the id of the certification item - * @type {string} - * @memberof IdentityCertifiedV2024 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof IdentityCertifiedV2024 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof IdentityCertifiedV2024 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof IdentityCertifiedV2024 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof IdentityCertifiedV2024 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2024} - * @memberof IdentityCertifiedV2024 - */ - 'signer'?: CertifierResponseV2024; - /** - * the event type - * @type {string} - * @memberof IdentityCertifiedV2024 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof IdentityCertifiedV2024 - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface IdentityCompareResponseV2024 - */ -export interface IdentityCompareResponseV2024 { - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: object; }} - * @memberof IdentityCompareResponseV2024 - */ - 'accessItemDiff'?: { [key: string]: object; }; -} -/** - * Created identity. - * @export - * @interface IdentityCreatedIdentityV2024 - */ -export interface IdentityCreatedIdentityV2024 { - /** - * Created identity\'s DTO type. - * @type {string} - * @memberof IdentityCreatedIdentityV2024 - */ - 'type': IdentityCreatedIdentityV2024TypeV2024; - /** - * Created identity ID. - * @type {string} - * @memberof IdentityCreatedIdentityV2024 - */ - 'id': string; - /** - * Created identity\'s display name. - * @type {string} - * @memberof IdentityCreatedIdentityV2024 - */ - 'name': string; -} - -export const IdentityCreatedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityCreatedIdentityV2024TypeV2024 = typeof IdentityCreatedIdentityV2024TypeV2024[keyof typeof IdentityCreatedIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface IdentityCreatedV2024 - */ -export interface IdentityCreatedV2024 { - /** - * - * @type {IdentityCreatedIdentityV2024} - * @memberof IdentityCreatedV2024 - */ - 'identity': IdentityCreatedIdentityV2024; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityCreatedV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Deleted identity. - * @export - * @interface IdentityDeletedIdentityV2024 - */ -export interface IdentityDeletedIdentityV2024 { - /** - * Deleted identity\'s DTO type. - * @type {string} - * @memberof IdentityDeletedIdentityV2024 - */ - 'type': IdentityDeletedIdentityV2024TypeV2024; - /** - * Deleted identity ID. - * @type {string} - * @memberof IdentityDeletedIdentityV2024 - */ - 'id': string; - /** - * Deleted identity\'s display name. - * @type {string} - * @memberof IdentityDeletedIdentityV2024 - */ - 'name': string; -} - -export const IdentityDeletedIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityDeletedIdentityV2024TypeV2024 = typeof IdentityDeletedIdentityV2024TypeV2024[keyof typeof IdentityDeletedIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface IdentityDeletedV2024 - */ -export interface IdentityDeletedV2024 { - /** - * - * @type {IdentityDeletedIdentityV2024} - * @memberof IdentityDeletedV2024 - */ - 'identity': IdentityDeletedIdentityV2024; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityDeletedV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Identity\'s identity profile. - * @export - * @interface IdentityDocumentAllOfIdentityProfileV2024 - */ -export interface IdentityDocumentAllOfIdentityProfileV2024 { - /** - * Identity profile\'s ID. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2024 - */ - 'id'?: string; - /** - * Identity profile\'s name. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2024 - */ - 'name'?: string; -} -/** - * Identity\'s manager. - * @export - * @interface IdentityDocumentAllOfManagerV2024 - */ -export interface IdentityDocumentAllOfManagerV2024 { - /** - * ID of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2024 - */ - 'id'?: string; - /** - * Name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2024 - */ - 'name'?: string; - /** - * Display name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2024 - */ - 'displayName'?: string; -} -/** - * Identity\'s source. - * @export - * @interface IdentityDocumentAllOfSourceV2024 - */ -export interface IdentityDocumentAllOfSourceV2024 { - /** - * ID of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2024 - */ - 'id'?: string; - /** - * Display name of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2024 - */ - 'name'?: string; -} -/** - * Identity - * @export - * @interface IdentityDocumentV2024 - */ -export interface IdentityDocumentV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentV2024 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentV2024 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2024} - * @memberof IdentityDocumentV2024 - */ - 'manager'?: IdentityDocumentAllOfManagerV2024 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentV2024 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2024} - * @memberof IdentityDocumentV2024 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2024; - /** - * - * @type {IdentityDocumentAllOfSourceV2024} - * @memberof IdentityDocumentV2024 - */ - 'source'?: IdentityDocumentAllOfSourceV2024; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentV2024 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentV2024 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentV2024 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2024} - * @memberof IdentityDocumentV2024 - */ - 'processingDetails'?: ProcessingDetailsV2024; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentV2024 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentV2024 - */ - 'visibleSegmentCount'?: number; -} -/** - * - * @export - * @interface IdentityDocumentsV2024 - */ -export interface IdentityDocumentsV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentsV2024 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentsV2024 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2024} - * @memberof IdentityDocumentsV2024 - */ - 'manager'?: IdentityDocumentAllOfManagerV2024 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentsV2024 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2024} - * @memberof IdentityDocumentsV2024 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2024; - /** - * - * @type {IdentityDocumentAllOfSourceV2024} - * @memberof IdentityDocumentsV2024 - */ - 'source'?: IdentityDocumentAllOfSourceV2024; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentsV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentsV2024 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentsV2024 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2024} - * @memberof IdentityDocumentsV2024 - */ - 'processingDetails'?: ProcessingDetailsV2024; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentsV2024 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentsV2024 - */ - 'visibleSegmentCount'?: number; - /** - * Name of the pod. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof IdentityDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof IdentityDocumentsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof IdentityDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface IdentityEntitiesIdentityEntityV2024 - */ -export interface IdentityEntitiesIdentityEntityV2024 { - /** - * id of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2024 - */ - 'id'?: string; - /** - * name of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2024 - */ - 'name'?: string; - /** - * type of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2024 - */ - 'type'?: string; -} -/** - * - * @export - * @interface IdentityEntitiesV2024 - */ -export interface IdentityEntitiesV2024 { - /** - * - * @type {IdentityEntitiesIdentityEntityV2024} - * @memberof IdentityEntitiesV2024 - */ - 'identityEntity'?: IdentityEntitiesIdentityEntityV2024; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsAccountTargetV2024 - */ -export interface IdentityEntitlementDetailsAccountTargetV2024 { - /** - * The id of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'accountId'?: string; - /** - * The name of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'accountName'?: string; - /** - * The UUID representation of the account if available - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'accountUUID'?: string | null; - /** - * The id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'sourceId'?: string; - /** - * The name of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'sourceName'?: string; - /** - * The removal date scheduled for the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'removeDate'?: string | null; - /** - * The assignmentId of the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'assignmentId'?: string | null; - /** - * If the entitlement can be revoked - * @type {boolean} - * @memberof IdentityEntitlementDetailsAccountTargetV2024 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsEntitlementDtoV2024 - */ -export interface IdentityEntitlementDetailsEntitlementDtoV2024 { - /** - * The entitlement id - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'name'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'modified'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'description'?: string | null; - /** - * The type of the object, will always be \"ENTITLEMENT\" - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'type'?: string; - /** - * The source ID - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'sourceId'?: string; - /** - * The source name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'sourceName'?: string; - /** - * - * @type {OwnerDtoV2024} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'owner'?: OwnerDtoV2024; - /** - * The value of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'value'?: string; - /** - * a list of properties informing the viewer about the entitlement - * @type {Array} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2024 - */ - 'flags'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsV2024 - */ -export interface IdentityEntitlementDetailsV2024 { - /** - * Id of Identity - * @type {string} - * @memberof IdentityEntitlementDetailsV2024 - */ - 'identityId'?: string; - /** - * - * @type {IdentityEntitlementDetailsEntitlementDtoV2024} - * @memberof IdentityEntitlementDetailsV2024 - */ - 'entitlement'?: IdentityEntitlementDetailsEntitlementDtoV2024; - /** - * Id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsV2024 - */ - 'sourceId'?: string; - /** - * A list of account targets on the identity provisioned with the requested entitlement. - * @type {Array} - * @memberof IdentityEntitlementDetailsV2024 - */ - 'accountTargets'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementsV2024 - */ -export interface IdentityEntitlementsV2024 { - /** - * - * @type {TaggedObjectDtoV2024} - * @memberof IdentityEntitlementsV2024 - */ - 'objectRef'?: TaggedObjectDtoV2024; - /** - * Labels to be applied to object. - * @type {Array} - * @memberof IdentityEntitlementsV2024 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface IdentityExceptionReportReferenceV2024 - */ -export interface IdentityExceptionReportReferenceV2024 { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2024 - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2024 - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityHistoryResponseV2024 - */ -export interface IdentityHistoryResponseV2024 { - /** - * the identity ID - * @type {string} - * @memberof IdentityHistoryResponseV2024 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityHistoryResponseV2024 - */ - 'displayName'?: string; - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentityHistoryResponseV2024 - */ - 'snapshot'?: string; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityHistoryResponseV2024 - */ - 'deletedDate'?: string; - /** - * A map containing the count of each access item - * @type {{ [key: string]: number; }} - * @memberof IdentityHistoryResponseV2024 - */ - 'accessItemCount'?: { [key: string]: number; }; - /** - * A map containing the identity attributes - * @type {{ [key: string]: any; }} - * @memberof IdentityHistoryResponseV2024 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentityLifecycleStateV2024 - */ -export interface IdentityLifecycleStateV2024 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof IdentityLifecycleStateV2024 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof IdentityLifecycleStateV2024 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface IdentityListItemV2024 - */ -export interface IdentityListItemV2024 { - /** - * the identity ID - * @type {string} - * @memberof IdentityListItemV2024 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityListItemV2024 - */ - 'displayName'?: string; - /** - * the first name of the identity - * @type {string} - * @memberof IdentityListItemV2024 - */ - 'firstName'?: string | null; - /** - * the last name of the identity - * @type {string} - * @memberof IdentityListItemV2024 - */ - 'lastName'?: string | null; - /** - * indicates if an identity is active or not - * @type {boolean} - * @memberof IdentityListItemV2024 - */ - 'active'?: boolean; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityListItemV2024 - */ - 'deletedDate'?: string | null; -} -/** - * Identity\'s manager - * @export - * @interface IdentityManagerRefV2024 - */ -export interface IdentityManagerRefV2024 { - /** - * DTO type of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2024 - */ - 'type'?: IdentityManagerRefV2024TypeV2024; - /** - * ID of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2024 - */ - 'name'?: string; -} - -export const IdentityManagerRefV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityManagerRefV2024TypeV2024 = typeof IdentityManagerRefV2024TypeV2024[keyof typeof IdentityManagerRefV2024TypeV2024]; - -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2024 - */ -export interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2024 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2024 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2024 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsV2024 - */ -export interface IdentityOwnershipAssociationDetailsV2024 { - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsV2024 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityPreviewRequestV2024 - */ -export interface IdentityPreviewRequestV2024 { - /** - * The Identity id - * @type {string} - * @memberof IdentityPreviewRequestV2024 - */ - 'identityId'?: string; - /** - * - * @type {IdentityAttributeConfigV2024} - * @memberof IdentityPreviewRequestV2024 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2024; -} -/** - * Identity\'s basic details. - * @export - * @interface IdentityPreviewResponseIdentityV2024 - */ -export interface IdentityPreviewResponseIdentityV2024 { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2024 - */ - 'type'?: IdentityPreviewResponseIdentityV2024TypeV2024; - /** - * Identity ID. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2024 - */ - 'id'?: string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2024 - */ - 'name'?: string; -} - -export const IdentityPreviewResponseIdentityV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityPreviewResponseIdentityV2024TypeV2024 = typeof IdentityPreviewResponseIdentityV2024TypeV2024[keyof typeof IdentityPreviewResponseIdentityV2024TypeV2024]; - -/** - * - * @export - * @interface IdentityPreviewResponseV2024 - */ -export interface IdentityPreviewResponseV2024 { - /** - * - * @type {IdentityPreviewResponseIdentityV2024} - * @memberof IdentityPreviewResponseV2024 - */ - 'identity'?: IdentityPreviewResponseIdentityV2024; - /** - * - * @type {Array} - * @memberof IdentityPreviewResponseV2024 - */ - 'previewAttributes'?: Array; -} -/** - * - * @export - * @interface IdentityProfileAllOfAuthoritativeSourceV2024 - */ -export interface IdentityProfileAllOfAuthoritativeSourceV2024 { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2024 - */ - 'type'?: IdentityProfileAllOfAuthoritativeSourceV2024TypeV2024; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2024 - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2024 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfAuthoritativeSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type IdentityProfileAllOfAuthoritativeSourceV2024TypeV2024 = typeof IdentityProfileAllOfAuthoritativeSourceV2024TypeV2024[keyof typeof IdentityProfileAllOfAuthoritativeSourceV2024TypeV2024]; - -/** - * Identity profile\'s owner. - * @export - * @interface IdentityProfileAllOfOwnerV2024 - */ -export interface IdentityProfileAllOfOwnerV2024 { - /** - * Owner\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2024 - */ - 'type'?: IdentityProfileAllOfOwnerV2024TypeV2024; - /** - * Owner\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2024 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2024 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityProfileAllOfOwnerV2024TypeV2024 = typeof IdentityProfileAllOfOwnerV2024TypeV2024[keyof typeof IdentityProfileAllOfOwnerV2024TypeV2024]; - -/** - * Self block for exported object. - * @export - * @interface IdentityProfileExportedObjectSelfV2024 - */ -export interface IdentityProfileExportedObjectSelfV2024 { - /** - * Exported object\'s DTO type. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2024 - */ - 'type'?: IdentityProfileExportedObjectSelfV2024TypeV2024; - /** - * Exported object\'s ID. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2024 - */ - 'id'?: string; - /** - * Exported object\'s display name. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2024 - */ - 'name'?: string; -} - -export const IdentityProfileExportedObjectSelfV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type IdentityProfileExportedObjectSelfV2024TypeV2024 = typeof IdentityProfileExportedObjectSelfV2024TypeV2024[keyof typeof IdentityProfileExportedObjectSelfV2024TypeV2024]; - -/** - * Identity profile exported object. - * @export - * @interface IdentityProfileExportedObjectV2024 - */ -export interface IdentityProfileExportedObjectV2024 { - /** - * Version or object from the target service. - * @type {number} - * @memberof IdentityProfileExportedObjectV2024 - */ - 'version'?: number; - /** - * - * @type {IdentityProfileExportedObjectSelfV2024} - * @memberof IdentityProfileExportedObjectV2024 - */ - 'self'?: IdentityProfileExportedObjectSelfV2024; - /** - * - * @type {IdentityProfileV2024} - * @memberof IdentityProfileExportedObjectV2024 - */ - 'object'?: IdentityProfileV2024; -} -/** - * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) - * @export - * @interface IdentityProfileIdentityErrorReportArgumentsV2024 - */ -export interface IdentityProfileIdentityErrorReportArgumentsV2024 { - /** - * Source ID. - * @type {string} - * @memberof IdentityProfileIdentityErrorReportArgumentsV2024 - */ - 'authoritativeSource': string; -} -/** - * - * @export - * @interface IdentityProfileV2024 - */ -export interface IdentityProfileV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfileV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfileV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfileV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfileV2024 - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfileV2024 - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwnerV2024} - * @memberof IdentityProfileV2024 - */ - 'owner'?: IdentityProfileAllOfOwnerV2024 | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfileV2024 - */ - 'priority'?: number; - /** - * - * @type {IdentityProfileAllOfAuthoritativeSourceV2024} - * @memberof IdentityProfileV2024 - */ - 'authoritativeSource': IdentityProfileAllOfAuthoritativeSourceV2024; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfileV2024 - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfileV2024 - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfigV2024} - * @memberof IdentityProfileV2024 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2024; - /** - * - * @type {IdentityExceptionReportReferenceV2024} - * @memberof IdentityProfileV2024 - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReferenceV2024 | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfileV2024 - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * - * @export - * @interface IdentityProfilesConnectionsV2024 - */ -export interface IdentityProfilesConnectionsV2024 { - /** - * ID of the IdentityProfile this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the IdentityProfile to which this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2024 - */ - 'name'?: string; - /** - * The Number of Identities managed by this IdentityProfile - * @type {number} - * @memberof IdentityProfilesConnectionsV2024 - */ - 'identityCount'?: number; -} -/** - * The manager for the identity. - * @export - * @interface IdentityReferenceV2024 - */ -export interface IdentityReferenceV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof IdentityReferenceV2024 - */ - 'type'?: DtoTypeV2024; - /** - * Identity id - * @type {string} - * @memberof IdentityReferenceV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof IdentityReferenceV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithNameAndEmailV2024 - */ -export interface IdentityReferenceWithNameAndEmailV2024 { - /** - * The type can only be IDENTITY. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2024 - */ - 'type'?: string; - /** - * Identity ID. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2024 - */ - 'id'?: string; - /** - * Identity\'s human-readable display name. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2024 - */ - 'name'?: string; - /** - * Identity\'s email address. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2024 - */ - 'email'?: string | null; -} -/** - * - * @export - * @interface IdentitySnapshotSummaryResponseV2024 - */ -export interface IdentitySnapshotSummaryResponseV2024 { - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentitySnapshotSummaryResponseV2024 - */ - 'snapshot'?: string; -} -/** - * - * @export - * @interface IdentitySummaryV2024 - */ -export interface IdentitySummaryV2024 { - /** - * ID of this identity summary - * @type {string} - * @memberof IdentitySummaryV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity - * @type {string} - * @memberof IdentitySummaryV2024 - */ - 'name'?: string; - /** - * ID of the identity that this summary represents - * @type {string} - * @memberof IdentitySummaryV2024 - */ - 'identityId'?: string; - /** - * Indicates if all access items for this summary have been decided on - * @type {boolean} - * @memberof IdentitySummaryV2024 - */ - 'completed'?: boolean; -} -/** - * - * @export - * @interface IdentitySyncJobV2024 - */ -export interface IdentitySyncJobV2024 { - /** - * Job ID. - * @type {string} - * @memberof IdentitySyncJobV2024 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof IdentitySyncJobV2024 - */ - 'status': IdentitySyncJobV2024StatusV2024; - /** - * - * @type {IdentitySyncPayloadV2024} - * @memberof IdentitySyncJobV2024 - */ - 'payload': IdentitySyncPayloadV2024; -} - -export const IdentitySyncJobV2024StatusV2024 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type IdentitySyncJobV2024StatusV2024 = typeof IdentitySyncJobV2024StatusV2024[keyof typeof IdentitySyncJobV2024StatusV2024]; - -/** - * - * @export - * @interface IdentitySyncPayloadV2024 - */ -export interface IdentitySyncPayloadV2024 { - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2024 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2024 - */ - 'dataJson': string; -} -/** - * - * @export - * @interface IdentityV2024 - */ -export interface IdentityV2024 { - /** - * System-generated unique ID of the identity - * @type {string} - * @memberof IdentityV2024 - */ - 'id'?: string; - /** - * The identity\'s name is equivalent to its Display Name attribute. - * @type {string} - * @memberof IdentityV2024 - */ - 'name': string; - /** - * Creation date of the identity - * @type {string} - * @memberof IdentityV2024 - */ - 'created'?: string; - /** - * Last modification date of the identity - * @type {string} - * @memberof IdentityV2024 - */ - 'modified'?: string; - /** - * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. - * @type {string} - * @memberof IdentityV2024 - */ - 'alias'?: string; - /** - * The email address of the identity - * @type {string} - * @memberof IdentityV2024 - */ - 'emailAddress'?: string | null; - /** - * The processing state of the identity - * @type {string} - * @memberof IdentityV2024 - */ - 'processingState'?: IdentityV2024ProcessingStateV2024 | null; - /** - * The identity\'s status in the system - * @type {string} - * @memberof IdentityV2024 - */ - 'identityStatus'?: IdentityV2024IdentityStatusV2024; - /** - * - * @type {IdentityManagerRefV2024} - * @memberof IdentityV2024 - */ - 'managerRef'?: IdentityManagerRefV2024 | null; - /** - * Whether this identity is a manager of another identity - * @type {boolean} - * @memberof IdentityV2024 - */ - 'isManager'?: boolean; - /** - * The last time the identity was refreshed by the system - * @type {string} - * @memberof IdentityV2024 - */ - 'lastRefresh'?: string; - /** - * A map with the identity attributes for the identity - * @type {object} - * @memberof IdentityV2024 - */ - 'attributes'?: object; - /** - * - * @type {IdentityLifecycleStateV2024} - * @memberof IdentityV2024 - */ - 'lifecycleState'?: IdentityLifecycleStateV2024; -} - -export const IdentityV2024ProcessingStateV2024 = { - Error: 'ERROR', - Ok: 'OK' -} as const; - -export type IdentityV2024ProcessingStateV2024 = typeof IdentityV2024ProcessingStateV2024[keyof typeof IdentityV2024ProcessingStateV2024]; -export const IdentityV2024IdentityStatusV2024 = { - Unregistered: 'UNREGISTERED', - Registered: 'REGISTERED', - Pending: 'PENDING', - Warning: 'WARNING', - Disabled: 'DISABLED', - Active: 'ACTIVE', - Deactivated: 'DEACTIVATED', - Terminated: 'TERMINATED', - Error: 'ERROR', - Locked: 'LOCKED' -} as const; - -export type IdentityV2024IdentityStatusV2024 = typeof IdentityV2024IdentityStatusV2024[keyof typeof IdentityV2024IdentityStatusV2024]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface IdentityWithNewAccessAccessRefsInnerV2024 - */ -export interface IdentityWithNewAccessAccessRefsInnerV2024 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2024 - */ - 'type'?: IdentityWithNewAccessAccessRefsInnerV2024TypeV2024; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2024 - */ - 'id'?: string; -} - -export const IdentityWithNewAccessAccessRefsInnerV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type IdentityWithNewAccessAccessRefsInnerV2024TypeV2024 = typeof IdentityWithNewAccessAccessRefsInnerV2024TypeV2024[keyof typeof IdentityWithNewAccessAccessRefsInnerV2024TypeV2024]; - -/** - * An identity with a set of access to be added - * @export - * @interface IdentityWithNewAccessV2024 - */ -export interface IdentityWithNewAccessV2024 { - /** - * Identity id to be checked. - * @type {string} - * @memberof IdentityWithNewAccessV2024 - */ - 'identityId': string; - /** - * The list of entitlements to consider for possible violations in a preventive check. - * @type {Array} - * @memberof IdentityWithNewAccessV2024 - */ - 'accessRefs': Array; -} -/** - * - * @export - * @interface IdpDetailsV2024 - */ -export interface IdpDetailsV2024 { - /** - * Federation protocol role - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'role'?: IdpDetailsV2024RoleV2024; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof IdpDetailsV2024 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2024} - * @memberof IdpDetailsV2024 - */ - 'jitConfiguration'?: JITConfigurationV2024; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2024 - */ - 'certificateName'?: string; -} - -export const IdpDetailsV2024RoleV2024 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type IdpDetailsV2024RoleV2024 = typeof IdpDetailsV2024RoleV2024[keyof typeof IdpDetailsV2024RoleV2024]; - -/** - * - * @export - * @interface ImportAccountsRequestV2024 - */ -export interface ImportAccountsRequestV2024 { - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof ImportAccountsRequestV2024 - */ - 'file'?: File; - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof ImportAccountsRequestV2024 - */ - 'disableOptimization'?: string; -} -/** - * - * @export - * @interface ImportEntitlementsBySourceRequestV2024 - */ -export interface ImportEntitlementsBySourceRequestV2024 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsBySourceRequestV2024 - */ - 'csvFile'?: File; -} -/** - * - * @export - * @interface ImportEntitlementsRequestV2024 - */ -export interface ImportEntitlementsRequestV2024 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsRequestV2024 - */ - 'file'?: File; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseErrorsInnerV2024 - */ -export interface ImportFormDefinitions202ResponseErrorsInnerV2024 { - /** - * - * @type {{ [key: string]: object; }} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2024 - */ - 'detail'?: { [key: string]: object; }; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2024 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2024 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseV2024 - */ -export interface ImportFormDefinitions202ResponseV2024 { - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2024 - */ - 'errors'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2024 - */ - 'importedObjects'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2024 - */ - 'infos'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2024 - */ - 'warnings'?: Array; -} -/** - * - * @export - * @interface ImportFormDefinitionsRequestInnerV2024 - */ -export interface ImportFormDefinitionsRequestInnerV2024 { - /** - * - * @type {FormDefinitionResponseV2024} - * @memberof ImportFormDefinitionsRequestInnerV2024 - */ - 'object'?: FormDefinitionResponseV2024; - /** - * - * @type {string} - * @memberof ImportFormDefinitionsRequestInnerV2024 - */ - 'self'?: string; - /** - * - * @type {number} - * @memberof ImportFormDefinitionsRequestInnerV2024 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ImportNonEmployeeRecordsInBulkRequestV2024 - */ -export interface ImportNonEmployeeRecordsInBulkRequestV2024 { - /** - * - * @type {File} - * @memberof ImportNonEmployeeRecordsInBulkRequestV2024 - */ - 'data': File; -} -/** - * Object created or updated by import. - * @export - * @interface ImportObjectV2024 - */ -export interface ImportObjectV2024 { - /** - * DTO type of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2024 - */ - 'type'?: ImportObjectV2024TypeV2024; - /** - * ID of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2024 - */ - 'id'?: string; - /** - * Display name of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2024 - */ - 'name'?: string; -} - -export const ImportObjectV2024TypeV2024 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportObjectV2024TypeV2024 = typeof ImportObjectV2024TypeV2024[keyof typeof ImportObjectV2024TypeV2024]; - -/** - * - * @export - * @interface ImportOptionsV2024 - */ -export interface ImportOptionsV2024 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ImportOptionsV2024 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ImportOptionsV2024 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2024; }} - * @memberof ImportOptionsV2024 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2024; }; - /** - * List of object types that can be used to resolve references on import. - * @type {Array} - * @memberof ImportOptionsV2024 - */ - 'defaultReferences'?: Array; - /** - * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. - * @type {boolean} - * @memberof ImportOptionsV2024 - */ - 'excludeBackup'?: boolean; -} - -export const ImportOptionsV2024ExcludeTypesV2024 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2024ExcludeTypesV2024 = typeof ImportOptionsV2024ExcludeTypesV2024[keyof typeof ImportOptionsV2024ExcludeTypesV2024]; -export const ImportOptionsV2024IncludeTypesV2024 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2024IncludeTypesV2024 = typeof ImportOptionsV2024IncludeTypesV2024[keyof typeof ImportOptionsV2024IncludeTypesV2024]; -export const ImportOptionsV2024DefaultReferencesV2024 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2024DefaultReferencesV2024 = typeof ImportOptionsV2024DefaultReferencesV2024[keyof typeof ImportOptionsV2024DefaultReferencesV2024]; - -/** - * - * @export - * @interface ImportSpConfigRequestV2024 - */ -export interface ImportSpConfigRequestV2024 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ImportSpConfigRequestV2024 - */ - 'data': File; - /** - * - * @type {ImportOptionsV2024} - * @memberof ImportSpConfigRequestV2024 - */ - 'options'?: ImportOptionsV2024; -} -/** - * - * @export - * @interface IndexOfV2024 - */ -export interface IndexOfV2024 { - /** - * A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - * @type {string} - * @memberof IndexOfV2024 - */ - 'substring': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IndexOfV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IndexOfV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Enum representing the currently supported indices. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const IndexV2024 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles', - Star: '*' -} as const; - -export type IndexV2024 = typeof IndexV2024[keyof typeof IndexV2024]; - - -/** - * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - * @export - * @interface InnerHitV2024 - */ -export interface InnerHitV2024 { - /** - * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof InnerHitV2024 - */ - 'query': string; - /** - * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. - * @type {string} - * @memberof InnerHitV2024 - */ - 'type': string; -} -/** - * - * @export - * @interface InviteIdentitiesRequestV2024 - */ -export interface InviteIdentitiesRequestV2024 { - /** - * The list of Identities IDs to invite - required when \'uninvited\' is false - * @type {Array} - * @memberof InviteIdentitiesRequestV2024 - */ - 'ids'?: Array | null; - /** - * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. - * @type {boolean} - * @memberof InviteIdentitiesRequestV2024 - */ - 'uninvited'?: boolean; -} -/** - * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. - * @export - * @enum {string} - */ - -export const InvocationStatusTypeV2024 = { - Test: 'TEST', - RealTime: 'REAL_TIME' -} as const; - -export type InvocationStatusTypeV2024 = typeof InvocationStatusTypeV2024[keyof typeof InvocationStatusTypeV2024]; - - -/** - * - * @export - * @interface InvocationStatusV2024 - */ -export interface InvocationStatusV2024 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'id': string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'triggerId': string; - /** - * Subscription name - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'subscriptionName': string; - /** - * Subscription ID - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'subscriptionId': string; - /** - * - * @type {InvocationStatusTypeV2024} - * @memberof InvocationStatusV2024 - */ - 'type': InvocationStatusTypeV2024; - /** - * Invocation created timestamp. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'created': string; - /** - * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2024 - */ - 'completed'?: string; - /** - * - * @type {StartInvocationInputV2024} - * @memberof InvocationStatusV2024 - */ - 'startInvocationInput': StartInvocationInputV2024; - /** - * - * @type {CompleteInvocationInputV2024} - * @memberof InvocationStatusV2024 - */ - 'completeInvocationInput'?: CompleteInvocationInputV2024; -} - - -/** - * - * @export - * @interface InvocationV2024 - */ -export interface InvocationV2024 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationV2024 - */ - 'id'?: string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationV2024 - */ - 'triggerId'?: string; - /** - * Unique invocation secret. - * @type {string} - * @memberof InvocationV2024 - */ - 'secret'?: string; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof InvocationV2024 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface JITConfigurationV2024 - */ -export interface JITConfigurationV2024 { - /** - * The indicator for just-in-time provisioning enabled - * @type {boolean} - * @memberof JITConfigurationV2024 - */ - 'enabled'?: boolean; - /** - * the sourceId that mapped to just-in-time provisioning configuration - * @type {string} - * @memberof JITConfigurationV2024 - */ - 'sourceId'?: string; - /** - * A mapping of identity profile attribute names to SAML assertion attribute names - * @type {{ [key: string]: string; }} - * @memberof JITConfigurationV2024 - */ - 'sourceAttributeMappings'?: { [key: string]: string; }; -} -/** - * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationRoleMiningV2024 - */ -export interface JsonPatchOperationRoleMiningV2024 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2024 - */ - 'op': JsonPatchOperationRoleMiningV2024OpV2024; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2024 - */ - 'path': string; - /** - * - * @type {JsonPatchOperationRoleMiningValueV2024} - * @memberof JsonPatchOperationRoleMiningV2024 - */ - 'value'?: JsonPatchOperationRoleMiningValueV2024; -} - -export const JsonPatchOperationRoleMiningV2024OpV2024 = { - Remove: 'remove', - Replace: 'replace' -} as const; - -export type JsonPatchOperationRoleMiningV2024OpV2024 = typeof JsonPatchOperationRoleMiningV2024OpV2024[keyof typeof JsonPatchOperationRoleMiningV2024OpV2024]; - -/** - * @type JsonPatchOperationRoleMiningValueV2024 - * The value to be used for the operation, required for \"replace\" operations - * @export - */ -export type JsonPatchOperationRoleMiningValueV2024 = Array | boolean | number | object | string; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationV2024 - */ -export interface JsonPatchOperationV2024 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationV2024 - */ - 'op': JsonPatchOperationV2024OpV2024; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationV2024 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2024} - * @memberof JsonPatchOperationV2024 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2024; -} - -export const JsonPatchOperationV2024OpV2024 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type JsonPatchOperationV2024OpV2024 = typeof JsonPatchOperationV2024OpV2024[keyof typeof JsonPatchOperationV2024OpV2024]; - -/** - * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchV2024 - */ -export interface JsonPatchV2024 { - /** - * Operations to be applied - * @type {Array} - * @memberof JsonPatchV2024 - */ - 'operations'?: Array; -} -/** - * - * @export - * @interface KbaAnswerRequestItemV2024 - */ -export interface KbaAnswerRequestItemV2024 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerRequestItemV2024 - */ - 'id': string; - /** - * An answer for the KBA question - * @type {string} - * @memberof KbaAnswerRequestItemV2024 - */ - 'answer': string; -} -/** - * - * @export - * @interface KbaAnswerResponseItemV2024 - */ -export interface KbaAnswerResponseItemV2024 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerResponseItemV2024 - */ - 'id': string; - /** - * Question description - * @type {string} - * @memberof KbaAnswerResponseItemV2024 - */ - 'question': string; - /** - * Denotes whether the KBA question has an answer configured for the current user - * @type {boolean} - * @memberof KbaAnswerResponseItemV2024 - */ - 'hasAnswer': boolean; -} -/** - * KBA Configuration - * @export - * @interface KbaQuestionV2024 - */ -export interface KbaQuestionV2024 { - /** - * KBA Question Id - * @type {string} - * @memberof KbaQuestionV2024 - */ - 'id': string; - /** - * KBA Question description - * @type {string} - * @memberof KbaQuestionV2024 - */ - 'text': string; - /** - * Denotes whether the KBA question has an answer configured for any user in the tenant - * @type {boolean} - * @memberof KbaQuestionV2024 - */ - 'hasAnswer': boolean; - /** - * Denotes the number of KBA configurations for this question - * @type {number} - * @memberof KbaQuestionV2024 - */ - 'numAnswers': number; -} -/** - * - * @export - * @interface LatestOutlierSummaryV2024 - */ -export interface LatestOutlierSummaryV2024 { - /** - * The type of outlier summary - * @type {string} - * @memberof LatestOutlierSummaryV2024 - */ - 'type'?: LatestOutlierSummaryV2024TypeV2024; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof LatestOutlierSummaryV2024 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2024 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2024 - */ - 'totalIdentities'?: number; - /** - * Total number of ignored outliers - * @type {number} - * @memberof LatestOutlierSummaryV2024 - */ - 'totalIgnored'?: number; -} - -export const LatestOutlierSummaryV2024TypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type LatestOutlierSummaryV2024TypeV2024 = typeof LatestOutlierSummaryV2024TypeV2024[keyof typeof LatestOutlierSummaryV2024TypeV2024]; - -/** - * Owner of the Launcher - * @export - * @interface LauncherOwnerV2024 - */ -export interface LauncherOwnerV2024 { - /** - * Owner type - * @type {string} - * @memberof LauncherOwnerV2024 - */ - 'type': string; - /** - * Owner ID - * @type {string} - * @memberof LauncherOwnerV2024 - */ - 'id': string; -} -/** - * - * @export - * @interface LauncherReferenceV2024 - */ -export interface LauncherReferenceV2024 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2024 - */ - 'type'?: LauncherReferenceV2024TypeV2024; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2024 - */ - 'id'?: string; -} - -export const LauncherReferenceV2024TypeV2024 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherReferenceV2024TypeV2024 = typeof LauncherReferenceV2024TypeV2024[keyof typeof LauncherReferenceV2024TypeV2024]; - -/** - * - * @export - * @interface LauncherRequestReferenceV2024 - */ -export interface LauncherRequestReferenceV2024 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2024 - */ - 'type': LauncherRequestReferenceV2024TypeV2024; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2024 - */ - 'id': string; -} - -export const LauncherRequestReferenceV2024TypeV2024 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherRequestReferenceV2024TypeV2024 = typeof LauncherRequestReferenceV2024TypeV2024[keyof typeof LauncherRequestReferenceV2024TypeV2024]; - -/** - * - * @export - * @interface LauncherRequestV2024 - */ -export interface LauncherRequestV2024 { - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherRequestV2024 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherRequestV2024 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherRequestV2024 - */ - 'type': LauncherRequestV2024TypeV2024; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherRequestV2024 - */ - 'disabled': boolean; - /** - * - * @type {LauncherRequestReferenceV2024} - * @memberof LauncherRequestV2024 - */ - 'reference'?: LauncherRequestReferenceV2024; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherRequestV2024 - */ - 'config': string; -} - -export const LauncherRequestV2024TypeV2024 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherRequestV2024TypeV2024 = typeof LauncherRequestV2024TypeV2024[keyof typeof LauncherRequestV2024TypeV2024]; - -/** - * - * @export - * @interface LauncherV2024 - */ -export interface LauncherV2024 { - /** - * ID of the Launcher - * @type {string} - * @memberof LauncherV2024 - */ - 'id': string; - /** - * Date the Launcher was created - * @type {string} - * @memberof LauncherV2024 - */ - 'created': string; - /** - * Date the Launcher was last modified - * @type {string} - * @memberof LauncherV2024 - */ - 'modified': string; - /** - * - * @type {LauncherOwnerV2024} - * @memberof LauncherV2024 - */ - 'owner': LauncherOwnerV2024; - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherV2024 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherV2024 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherV2024 - */ - 'type': LauncherV2024TypeV2024; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherV2024 - */ - 'disabled': boolean; - /** - * - * @type {LauncherReferenceV2024} - * @memberof LauncherV2024 - */ - 'reference'?: LauncherReferenceV2024; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherV2024 - */ - 'config': string; -} - -export const LauncherV2024TypeV2024 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherV2024TypeV2024 = typeof LauncherV2024TypeV2024[keyof typeof LauncherV2024TypeV2024]; - -/** - * - * @export - * @interface LeftPadV2024 - */ -export interface LeftPadV2024 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof LeftPadV2024 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof LeftPadV2024 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LeftPadV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LeftPadV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LicenseV2024 - */ -export interface LicenseV2024 { - /** - * Name of the license - * @type {string} - * @memberof LicenseV2024 - */ - 'licenseId'?: string; - /** - * Legacy name of the license - * @type {string} - * @memberof LicenseV2024 - */ - 'legacyFeatureName'?: string; -} -/** - * - * @export - * @interface LifecycleStateDtoV2024 - */ -export interface LifecycleStateDtoV2024 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof LifecycleStateDtoV2024 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof LifecycleStateDtoV2024 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface LifecycleStateV2024 - */ -export interface LifecycleStateV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'modified'?: string; - /** - * Indicates whether the lifecycle state is enabled or disabled. - * @type {boolean} - * @memberof LifecycleStateV2024 - */ - 'enabled'?: boolean; - /** - * The lifecycle state\'s technical name. This is for internal use. - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'technicalName': string; - /** - * Lifecycle state\'s description. - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'description'?: string | null; - /** - * Number of identities that have the lifecycle state. - * @type {number} - * @memberof LifecycleStateV2024 - */ - 'identityCount'?: number; - /** - * - * @type {EmailNotificationOptionV2024} - * @memberof LifecycleStateV2024 - */ - 'emailNotificationOption'?: EmailNotificationOptionV2024; - /** - * - * @type {Array} - * @memberof LifecycleStateV2024 - */ - 'accountActions'?: Array; - /** - * List of unique access-profile IDs that are associated with the lifecycle state. - * @type {Set} - * @memberof LifecycleStateV2024 - */ - 'accessProfileIds'?: Set; - /** - * The lifecycle state\'s associated identity state. This field is generally \'null\'. - * @type {string} - * @memberof LifecycleStateV2024 - */ - 'identityState'?: string | null; -} -/** - * Deleted lifecycle state. - * @export - * @interface LifecyclestateDeletedV2024 - */ -export interface LifecyclestateDeletedV2024 { - /** - * Deleted lifecycle state\'s DTO type. - * @type {string} - * @memberof LifecyclestateDeletedV2024 - */ - 'type'?: LifecyclestateDeletedV2024TypeV2024; - /** - * Deleted lifecycle state ID. - * @type {string} - * @memberof LifecyclestateDeletedV2024 - */ - 'id'?: string; - /** - * Deleted lifecycle state\'s display name. - * @type {string} - * @memberof LifecyclestateDeletedV2024 - */ - 'name'?: string; -} - -export const LifecyclestateDeletedV2024TypeV2024 = { - LifecycleState: 'LIFECYCLE_STATE', - TaskResult: 'TASK_RESULT' -} as const; - -export type LifecyclestateDeletedV2024TypeV2024 = typeof LifecyclestateDeletedV2024TypeV2024[keyof typeof LifecyclestateDeletedV2024TypeV2024]; - -/** - * - * @export - * @interface ListAccessProfiles401ResponseV2024 - */ -export interface ListAccessProfiles401ResponseV2024 { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles401ResponseV2024 - */ - 'error'?: object; -} -/** - * - * @export - * @interface ListAccessProfiles429ResponseV2024 - */ -export interface ListAccessProfiles429ResponseV2024 { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles429ResponseV2024 - */ - 'message'?: object; -} -/** - * - * @export - * @interface ListCampaignFilters200ResponseV2024 - */ -export interface ListCampaignFilters200ResponseV2024 { - /** - * List of campaign filters. - * @type {Array} - * @memberof ListCampaignFilters200ResponseV2024 - */ - 'items'?: Array; - /** - * Number of filters returned. - * @type {number} - * @memberof ListCampaignFilters200ResponseV2024 - */ - 'count'?: number; -} -/** - * - * @export - * @interface ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ -export interface ListCompleteWorkflowLibrary200ResponseInnerV2024 { - /** - * Operator ID. - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'description'?: string; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2024} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2024; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'isDynamicSchema'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'outputSchema'?: object; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2024 - */ - 'inputExample'?: object | null; -} -/** - * - * @export - * @interface ListDeploys200ResponseV2024 - */ -export interface ListDeploys200ResponseV2024 { - /** - * list of deployments - * @type {Array} - * @memberof ListDeploys200ResponseV2024 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface ListFormDefinitionsByTenantResponseV2024 - */ -export interface ListFormDefinitionsByTenantResponseV2024 { - /** - * Count number of results. - * @type {number} - * @memberof ListFormDefinitionsByTenantResponseV2024 - */ - 'count'?: number; - /** - * List of FormDefinitionResponse items. - * @type {Array} - * @memberof ListFormDefinitionsByTenantResponseV2024 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ListFormElementDataByElementIDResponseV2024 - */ -export interface ListFormElementDataByElementIDResponseV2024 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof ListFormElementDataByElementIDResponseV2024 - */ - 'results'?: Array; -} -/** - * List of FormInstanceResponse items - * @export - * @interface ListFormInstancesByTenantResponseV2024 - */ -export interface ListFormInstancesByTenantResponseV2024 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'state'?: ListFormInstancesByTenantResponseV2024StateV2024; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2024} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'createdBy'?: FormInstanceCreatedByV2024; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2024 - */ - 'recipients'?: Array; -} - -export const ListFormInstancesByTenantResponseV2024StateV2024 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type ListFormInstancesByTenantResponseV2024StateV2024 = typeof ListFormInstancesByTenantResponseV2024StateV2024[keyof typeof ListFormInstancesByTenantResponseV2024StateV2024]; - -/** - * - * @export - * @interface ListIdentityAccessItems200ResponseInnerV2024 - */ -export interface ListIdentityAccessItems200ResponseInnerV2024 { - /** - * the access item id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2024 - */ - 'appRoleId': string | null; -} -/** - * @type ListIdentitySnapshotAccessItems200ResponseInnerV2024 - * @export - */ -export type ListIdentitySnapshotAccessItems200ResponseInnerV2024 = AccessItemAccessProfileResponseV2024 | AccessItemAccountResponseV2024 | AccessItemAppResponseV2024 | AccessItemEntitlementResponseV2024 | AccessItemRoleResponseV2024; - -/** - * - * @export - * @interface ListPredefinedSelectOptionsResponseV2024 - */ -export interface ListPredefinedSelectOptionsResponseV2024 { - /** - * Results holds a list of PreDefinedSelectOption items - * @type {Array} - * @memberof ListPredefinedSelectOptionsResponseV2024 - */ - 'results'?: Array; -} -/** - * Identity of workgroup member. - * @export - * @interface ListWorkgroupMembers200ResponseInnerV2024 - */ -export interface ListWorkgroupMembers200ResponseInnerV2024 { - /** - * Workgroup member identity DTO type. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2024 - */ - 'type'?: ListWorkgroupMembers200ResponseInnerV2024TypeV2024; - /** - * Workgroup member identity ID. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2024 - */ - 'id'?: string; - /** - * Workgroup member identity display name. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2024 - */ - 'name'?: string; - /** - * Workgroup member identity email. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2024 - */ - 'email'?: string; -} - -export const ListWorkgroupMembers200ResponseInnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ListWorkgroupMembers200ResponseInnerV2024TypeV2024 = typeof ListWorkgroupMembers200ResponseInnerV2024TypeV2024[keyof typeof ListWorkgroupMembers200ResponseInnerV2024TypeV2024]; - -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadAccountsTaskTaskAttributesV2024 - */ -export interface LoadAccountsTaskTaskAttributesV2024 { - [key: string]: object | any; - - /** - * The id of the source - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2024 - */ - 'appId'?: string; - /** - * The indicator if the aggregation process was enabled/disabled for the aggregation job - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2024 - */ - 'optimizedAggregation'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskMessagesInnerV2024 - */ -export interface LoadAccountsTaskTaskMessagesInnerV2024 { - /** - * Type of the message. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2024 - */ - 'type'?: LoadAccountsTaskTaskMessagesInnerV2024TypeV2024; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2024 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2024 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2024 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2024 - */ - 'localizedText'?: string; -} - -export const LoadAccountsTaskTaskMessagesInnerV2024TypeV2024 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadAccountsTaskTaskMessagesInnerV2024TypeV2024 = typeof LoadAccountsTaskTaskMessagesInnerV2024TypeV2024[keyof typeof LoadAccountsTaskTaskMessagesInnerV2024TypeV2024]; - -/** - * - * @export - * @interface LoadAccountsTaskTaskReturnsInnerV2024 - */ -export interface LoadAccountsTaskTaskReturnsInnerV2024 { - /** - * The display label of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2024 - */ - 'displayLabel'?: string; - /** - * The attribute name of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2024 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskV2024 - */ -export interface LoadAccountsTaskTaskV2024 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'type'?: string; - /** - * The name of the aggregation process - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'completionStatus'?: LoadAccountsTaskTaskV2024CompletionStatusV2024 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'progress'?: string | null; - /** - * - * @type {LoadAccountsTaskTaskAttributesV2024} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'attributes'?: LoadAccountsTaskTaskAttributesV2024; - /** - * Return values from the task - * @type {Array} - * @memberof LoadAccountsTaskTaskV2024 - */ - 'returns'?: Array; -} - -export const LoadAccountsTaskTaskV2024CompletionStatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadAccountsTaskTaskV2024CompletionStatusV2024 = typeof LoadAccountsTaskTaskV2024CompletionStatusV2024[keyof typeof LoadAccountsTaskTaskV2024CompletionStatusV2024]; - -/** - * - * @export - * @interface LoadAccountsTaskV2024 - */ -export interface LoadAccountsTaskV2024 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadAccountsTaskV2024 - */ - 'success'?: boolean; - /** - * - * @type {LoadAccountsTaskTaskV2024} - * @memberof LoadAccountsTaskV2024 - */ - 'task'?: LoadAccountsTaskTaskV2024; -} -/** - * - * @export - * @interface LoadEntitlementTaskReturnsInnerV2024 - */ -export interface LoadEntitlementTaskReturnsInnerV2024 { - /** - * The display label for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2024 - */ - 'displayLabel'?: string; - /** - * The attribute name for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2024 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadEntitlementTaskV2024 - */ -export interface LoadEntitlementTaskV2024 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'type'?: string; - /** - * The name of the task - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'uniqueName'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'launcher'?: string; - /** - * The creation date of the task - * @type {string} - * @memberof LoadEntitlementTaskV2024 - */ - 'created'?: string; - /** - * Return values from the task - * @type {Array} - * @memberof LoadEntitlementTaskV2024 - */ - 'returns'?: Array; -} -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadUncorrelatedAccountsTaskTaskAttributesV2024 - */ -export interface LoadUncorrelatedAccountsTaskTaskAttributesV2024 { - /** - * The id of qpoc job - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2024 - */ - 'qpocJobId'?: string; - /** - * the task start delay value - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2024 - */ - 'taskStartDelay'?: object; -} -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ -export interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 { - /** - * Type of the message. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ - 'type'?: LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024TypeV2024; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024 - */ - 'localizedText'?: string; -} - -export const LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024TypeV2024 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024TypeV2024 = typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024TypeV2024[keyof typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2024TypeV2024]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskV2024 - */ -export interface LoadUncorrelatedAccountsTaskTaskV2024 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'type'?: string; - /** - * The name of uncorrelated accounts process - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'completionStatus'?: LoadUncorrelatedAccountsTaskTaskV2024CompletionStatusV2024 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'progress'?: string | null; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskAttributesV2024} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'attributes'?: LoadUncorrelatedAccountsTaskTaskAttributesV2024; - /** - * Return values from the task - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskV2024 - */ - 'returns'?: object; -} - -export const LoadUncorrelatedAccountsTaskTaskV2024CompletionStatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskV2024CompletionStatusV2024 = typeof LoadUncorrelatedAccountsTaskTaskV2024CompletionStatusV2024[keyof typeof LoadUncorrelatedAccountsTaskTaskV2024CompletionStatusV2024]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskV2024 - */ -export interface LoadUncorrelatedAccountsTaskV2024 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskV2024 - */ - 'success'?: boolean; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskV2024} - * @memberof LoadUncorrelatedAccountsTaskV2024 - */ - 'task'?: LoadUncorrelatedAccountsTaskTaskV2024; -} -/** - * 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 LocaleOriginV2024 = { - Default: 'DEFAULT', - Request: 'REQUEST' -} as const; - -export type LocaleOriginV2024 = typeof LocaleOriginV2024[keyof typeof LocaleOriginV2024]; - - -/** - * Localized error message to indicate a failed invocation or error if any. - * @export - * @interface LocalizedMessageV2024 - */ -export interface LocalizedMessageV2024 { - /** - * Message locale - * @type {string} - * @memberof LocalizedMessageV2024 - */ - 'locale': string; - /** - * Message text - * @type {string} - * @memberof LocalizedMessageV2024 - */ - 'message': string; -} -/** - * - * @export - * @interface LockoutConfigurationV2024 - */ -export interface LockoutConfigurationV2024 { - /** - * The maximum attempts allowed before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2024 - */ - 'maximumAttempts'?: number; - /** - * The total time in minutes a user will be locked out. - * @type {number} - * @memberof LockoutConfigurationV2024 - */ - 'lockoutDuration'?: number; - /** - * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2024 - */ - 'lockoutWindow'?: number; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface LookupStepV2024 - */ -export interface LookupStepV2024 { - /** - * The ID of the Identity who work is reassigned to - * @type {string} - * @memberof LookupStepV2024 - */ - 'reassignedToId'?: string; - /** - * The ID of the Identity who work is reassigned from - * @type {string} - * @memberof LookupStepV2024 - */ - 'reassignedFromId'?: string; - /** - * - * @type {ReassignmentTypeEnumV2024} - * @memberof LookupStepV2024 - */ - 'reassignmentType'?: ReassignmentTypeEnumV2024; -} - - -/** - * - * @export - * @interface LookupV2024 - */ -export interface LookupV2024 { - /** - * This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform. - * @type {{ [key: string]: any; }} - * @memberof LookupV2024 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LookupV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LookupV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LowerV2024 - */ -export interface LowerV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LowerV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LowerV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MachineAccountV2024 - */ -export interface MachineAccountV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineAccountV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineAccountV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineAccountV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineAccountV2024 - */ - 'modified'?: string; - /** - * A description of the machine account - * @type {string} - * @memberof MachineAccountV2024 - */ - 'description'?: string | null; - /** - * The unique ID of the machine account generated by the source system - * @type {string} - * @memberof MachineAccountV2024 - */ - 'nativeIdentity': string; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof MachineAccountV2024 - */ - 'uuid'?: string | null; - /** - * Classification Method - * @type {string} - * @memberof MachineAccountV2024 - */ - 'classificationMethod': MachineAccountV2024ClassificationMethodV2024; - /** - * The machine identity this account is associated with - * @type {object} - * @memberof MachineAccountV2024 - */ - 'machineIdentity'?: object; - /** - * The identity who owns this account. - * @type {object} - * @memberof MachineAccountV2024 - */ - 'ownerIdentity'?: object | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof MachineAccountV2024 - */ - 'accessType'?: string; - /** - * The sub-type - * @type {string} - * @memberof MachineAccountV2024 - */ - 'subtype'?: string | null; - /** - * Environment - * @type {string} - * @memberof MachineAccountV2024 - */ - 'environment'?: string | null; - /** - * Custom attributes specific to the machine account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2024 - */ - 'attributes'?: { [key: string]: any; } | null; - /** - * The connector attributes for the account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2024 - */ - 'connectorAttributes': { [key: string]: any; } | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof MachineAccountV2024 - */ - 'manuallyCorrelated'?: boolean; - /** - * Indicates if the account has been manually edited - * @type {boolean} - * @memberof MachineAccountV2024 - */ - 'manuallyEdited': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof MachineAccountV2024 - */ - 'locked': boolean; - /** - * Indicates if the account is enabled - * @type {boolean} - * @memberof MachineAccountV2024 - */ - 'enabled': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof MachineAccountV2024 - */ - 'hasEntitlements': boolean; - /** - * The source this machine account belongs to. - * @type {object} - * @memberof MachineAccountV2024 - */ - 'source': object; -} - -export const MachineAccountV2024ClassificationMethodV2024 = { - Source: 'SOURCE', - Criteria: 'CRITERIA', - Discovery: 'DISCOVERY', - Manual: 'MANUAL' -} as const; - -export type MachineAccountV2024ClassificationMethodV2024 = typeof MachineAccountV2024ClassificationMethodV2024[keyof typeof MachineAccountV2024ClassificationMethodV2024]; - -/** - * - * @export - * @interface MachineClassificationConfigV2024 - */ -export interface MachineClassificationConfigV2024 { - /** - * Indicates whether Classification is enabled for a Source - * @type {boolean} - * @memberof MachineClassificationConfigV2024 - */ - 'enabled'?: boolean; - /** - * Classification Method - * @type {string} - * @memberof MachineClassificationConfigV2024 - */ - 'classificationMethod'?: MachineClassificationConfigV2024ClassificationMethodV2024; - /** - * - * @type {MachineClassificationCriteriaLevel1V2024} - * @memberof MachineClassificationConfigV2024 - */ - 'criteria'?: MachineClassificationCriteriaLevel1V2024; - /** - * Date the config was created - * @type {string} - * @memberof MachineClassificationConfigV2024 - */ - 'created'?: string; - /** - * Date the config was last updated - * @type {string} - * @memberof MachineClassificationConfigV2024 - */ - 'modified'?: string | null; -} - -export const MachineClassificationConfigV2024ClassificationMethodV2024 = { - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type MachineClassificationConfigV2024ClassificationMethodV2024 = typeof MachineClassificationConfigV2024ClassificationMethodV2024[keyof typeof MachineClassificationConfigV2024ClassificationMethodV2024]; - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel1V2024 - */ -export interface MachineClassificationCriteriaLevel1V2024 { - /** - * - * @type {MachineClassificationCriteriaOperationV2024} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'operation'?: MachineClassificationCriteriaOperationV2024; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel1V2024 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel2V2024 - */ -export interface MachineClassificationCriteriaLevel2V2024 { - /** - * - * @type {MachineClassificationCriteriaOperationV2024} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'operation'?: MachineClassificationCriteriaOperationV2024; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel2V2024 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel3V2024 - */ -export interface MachineClassificationCriteriaLevel3V2024 { - /** - * - * @type {MachineClassificationCriteriaOperationV2024} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'operation'?: MachineClassificationCriteriaOperationV2024; - /** - * Indicates whether or not case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel3V2024 - */ - 'children'?: Array | null; -} - - -/** - * An operation to perform on the classification criteria - * @export - * @enum {string} - */ - -export const MachineClassificationCriteriaOperationV2024 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - Contains: 'CONTAINS', - And: 'AND', - Or: 'OR' -} as const; - -export type MachineClassificationCriteriaOperationV2024 = typeof MachineClassificationCriteriaOperationV2024[keyof typeof MachineClassificationCriteriaOperationV2024]; - - -/** - * - * @export - * @interface MachineIdentityV2024 - */ -export interface MachineIdentityV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'modified'?: string; - /** - * The business application that the identity represents - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'businessApplication': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityV2024 - */ - 'description'?: string; - /** - * Indicates if the machine identity has been manually edited - * @type {boolean} - * @memberof MachineIdentityV2024 - */ - 'manuallyEdited'?: boolean; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityV2024 - */ - 'attributes'?: object; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesDtoV2024 - */ -export interface MailFromAttributesDtoV2024 { - /** - * The identity or domain address - * @type {string} - * @memberof MailFromAttributesDtoV2024 - */ - 'identity'?: string; - /** - * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. - * @type {string} - * @memberof MailFromAttributesDtoV2024 - */ - 'mailFromDomain'?: string; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesV2024 - */ -export interface MailFromAttributesV2024 { - /** - * The email identity - * @type {string} - * @memberof MailFromAttributesV2024 - */ - 'identity'?: string; - /** - * The name of a domain that an email identity uses as a custom MAIL FROM domain - * @type {string} - * @memberof MailFromAttributesV2024 - */ - 'mailFromDomain'?: string; - /** - * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you - * @type {string} - * @memberof MailFromAttributesV2024 - */ - 'mxRecord'?: string; - /** - * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain - * @type {string} - * @memberof MailFromAttributesV2024 - */ - 'txtRecord'?: string; - /** - * The current status of the MAIL FROM verification - * @type {string} - * @memberof MailFromAttributesV2024 - */ - 'mailFromDomainStatus'?: MailFromAttributesV2024MailFromDomainStatusV2024; -} - -export const MailFromAttributesV2024MailFromDomainStatusV2024 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MailFromAttributesV2024MailFromDomainStatusV2024 = typeof MailFromAttributesV2024MailFromDomainStatusV2024[keyof typeof MailFromAttributesV2024MailFromDomainStatusV2024]; - -/** - * Managed Client Request - * @export - * @interface ManagedClientRequestV2024 - */ -export interface ManagedClientRequestV2024 { - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientRequestV2024 - */ - 'clusterId': string; - /** - * description for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2024 - */ - 'description'?: string | null; - /** - * name for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2024 - */ - 'name'?: string | null; - /** - * Type of the ManagedClient (VA, CCG) to create - * @type {string} - * @memberof ManagedClientRequestV2024 - */ - 'type'?: string | null; -} -/** - * Status of a Managed Client - * @export - * @enum {string} - */ - -export const ManagedClientStatusCodeV2024 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientStatusCodeV2024 = typeof ManagedClientStatusCodeV2024[keyof typeof ManagedClientStatusCodeV2024]; - - -/** - * Managed Client Status - * @export - * @interface ManagedClientStatusV2024 - */ -export interface ManagedClientStatusV2024 { - /** - * ManagedClientStatus body information - * @type {object} - * @memberof ManagedClientStatusV2024 - */ - 'body': object; - /** - * - * @type {ManagedClientStatusCodeV2024} - * @memberof ManagedClientStatusV2024 - */ - 'status': ManagedClientStatusCodeV2024; - /** - * - * @type {ManagedClientTypeV2024} - * @memberof ManagedClientStatusV2024 - */ - 'type': ManagedClientTypeV2024 | null; - /** - * timestamp on the Client Status update - * @type {string} - * @memberof ManagedClientStatusV2024 - */ - 'timestamp': string; -} - - -/** - * Managed Client type - * @export - * @enum {string} - */ - -export const ManagedClientTypeV2024 = { - Ccg: 'CCG', - Va: 'VA', - Internal: 'INTERNAL', - IiqHarvester: 'IIQ_HARVESTER' -} as const; - -export type ManagedClientTypeV2024 = typeof ManagedClientTypeV2024[keyof typeof ManagedClientTypeV2024]; - - -/** - * Managed Client - * @export - * @interface ManagedClientV2024 - */ -export interface ManagedClientV2024 { - /** - * ManagedClient ID - * @type {string} - * @memberof ManagedClientV2024 - */ - 'id'?: string | null; - /** - * ManagedClient alert key - * @type {string} - * @memberof ManagedClientV2024 - */ - 'alertKey'?: string | null; - /** - * apiGatewayBaseUrl for the Managed client - * @type {string} - * @memberof ManagedClientV2024 - */ - 'apiGatewayBaseUrl'?: string | null; - /** - * cookbook id for the Managed client - * @type {string} - * @memberof ManagedClientV2024 - */ - 'cookbook'?: string | null; - /** - * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - * @type {number} - * @memberof ManagedClientV2024 - */ - 'ccId'?: number | null; - /** - * The client ID used in API management - * @type {string} - * @memberof ManagedClientV2024 - */ - 'clientId': string; - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientV2024 - */ - 'clusterId': string; - /** - * ManagedClient description - * @type {string} - * @memberof ManagedClientV2024 - */ - 'description': string; - /** - * The public IP address of the ManagedClient - * @type {string} - * @memberof ManagedClientV2024 - */ - 'ipAddress'?: string | null; - /** - * When the ManagedClient was last seen by the server - * @type {string} - * @memberof ManagedClientV2024 - */ - 'lastSeen'?: string | null; - /** - * ManagedClient name - * @type {string} - * @memberof ManagedClientV2024 - */ - 'name'?: string | null; - /** - * Milliseconds since the ManagedClient has polled the server - * @type {string} - * @memberof ManagedClientV2024 - */ - 'sinceLastSeen'?: string | null; - /** - * Status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2024 - */ - 'status'?: ManagedClientV2024StatusV2024 | null; - /** - * Type of the ManagedClient (VA, CCG) - * @type {string} - * @memberof ManagedClientV2024 - */ - 'type': string; - /** - * Cluster Type of the ManagedClient - * @type {string} - * @memberof ManagedClientV2024 - */ - 'clusterType'?: ManagedClientV2024ClusterTypeV2024 | null; - /** - * ManagedClient VA download URL - * @type {string} - * @memberof ManagedClientV2024 - */ - 'vaDownloadUrl'?: string | null; - /** - * Version that the ManagedClient\'s VA is running - * @type {string} - * @memberof ManagedClientV2024 - */ - 'vaVersion'?: string | null; - /** - * Client\'s apiKey - * @type {string} - * @memberof ManagedClientV2024 - */ - 'secret'?: string | null; - /** - * The date/time this ManagedClient was created - * @type {string} - * @memberof ManagedClientV2024 - */ - 'createdAt'?: string | null; - /** - * The date/time this ManagedClient was last updated - * @type {string} - * @memberof ManagedClientV2024 - */ - 'updatedAt'?: string | null; - /** - * The provisioning status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2024 - */ - 'provisionStatus'?: ManagedClientV2024ProvisionStatusV2024 | null; - /** - * The health indicators of the ManagedClient - * @type {object} - * @memberof ManagedClientV2024 - */ - 'healthIndicators'?: object | null; -} - -export const ManagedClientV2024StatusV2024 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientV2024StatusV2024 = typeof ManagedClientV2024StatusV2024[keyof typeof ManagedClientV2024StatusV2024]; -export const ManagedClientV2024ClusterTypeV2024 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc' -} as const; - -export type ManagedClientV2024ClusterTypeV2024 = typeof ManagedClientV2024ClusterTypeV2024[keyof typeof ManagedClientV2024ClusterTypeV2024]; -export const ManagedClientV2024ProvisionStatusV2024 = { - Provisioned: 'PROVISIONED', - Draft: 'DRAFT' -} as const; - -export type ManagedClientV2024ProvisionStatusV2024 = typeof ManagedClientV2024ProvisionStatusV2024[keyof typeof ManagedClientV2024ProvisionStatusV2024]; - -/** - * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - * @export - * @interface ManagedClusterAttributesV2024 - */ -export interface ManagedClusterAttributesV2024 { - /** - * - * @type {ManagedClusterQueueV2024} - * @memberof ManagedClusterAttributesV2024 - */ - 'queue'?: ManagedClusterQueueV2024; - /** - * ManagedCluster keystore for spConnectCluster type - * @type {string} - * @memberof ManagedClusterAttributesV2024 - */ - 'keystore'?: string | null; -} -/** - * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. - * @export - * @interface ManagedClusterEncryptionConfigV2024 - */ -export interface ManagedClusterEncryptionConfigV2024 { - /** - * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. - * @type {string} - * @memberof ManagedClusterEncryptionConfigV2024 - */ - 'format'?: ManagedClusterEncryptionConfigV2024FormatV2024; -} - -export const ManagedClusterEncryptionConfigV2024FormatV2024 = { - V2: 'V2', - V3: 'V3' -} as const; - -export type ManagedClusterEncryptionConfigV2024FormatV2024 = typeof ManagedClusterEncryptionConfigV2024FormatV2024[keyof typeof ManagedClusterEncryptionConfigV2024FormatV2024]; - -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterKeyPairV2024 - */ -export interface ManagedClusterKeyPairV2024 { - /** - * ManagedCluster publicKey - * @type {string} - * @memberof ManagedClusterKeyPairV2024 - */ - 'publicKey'?: string | null; - /** - * ManagedCluster publicKeyThumbprint - * @type {string} - * @memberof ManagedClusterKeyPairV2024 - */ - 'publicKeyThumbprint'?: string | null; - /** - * ManagedCluster publicKeyCertificate - * @type {string} - * @memberof ManagedClusterKeyPairV2024 - */ - 'publicKeyCertificate'?: string | null; -} -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterQueueV2024 - */ -export interface ManagedClusterQueueV2024 { - /** - * ManagedCluster queue name - * @type {string} - * @memberof ManagedClusterQueueV2024 - */ - 'name'?: string; - /** - * ManagedCluster queue aws region - * @type {string} - * @memberof ManagedClusterQueueV2024 - */ - 'region'?: string; -} -/** - * Managed Cluster Redis Configuration - * @export - * @interface ManagedClusterRedisV2024 - */ -export interface ManagedClusterRedisV2024 { - /** - * ManagedCluster redisHost - * @type {string} - * @memberof ManagedClusterRedisV2024 - */ - 'redisHost'?: string; - /** - * ManagedCluster redisPort - * @type {number} - * @memberof ManagedClusterRedisV2024 - */ - 'redisPort'?: number; -} -/** - * Request to create Managed Cluster - * @export - * @interface ManagedClusterRequestV2024 - */ -export interface ManagedClusterRequestV2024 { - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterRequestV2024 - */ - 'name': string; - /** - * - * @type {ManagedClusterTypesV2024} - * @memberof ManagedClusterRequestV2024 - */ - 'type'?: ManagedClusterTypesV2024; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string; }} - * @memberof ManagedClusterRequestV2024 - */ - 'configuration'?: { [key: string]: string; }; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterRequestV2024 - */ - 'description'?: string | null; -} - - -/** - * Managed Cluster Type for Cluster upgrade configuration information - * @export - * @interface ManagedClusterTypeV2024 - */ -export interface ManagedClusterTypeV2024 { - /** - * ManagedClusterType ID - * @type {string} - * @memberof ManagedClusterTypeV2024 - */ - 'id'?: string; - /** - * ManagedClusterType type name - * @type {string} - * @memberof ManagedClusterTypeV2024 - */ - 'type': string; - /** - * ManagedClusterType pod - * @type {string} - * @memberof ManagedClusterTypeV2024 - */ - 'pod': string; - /** - * ManagedClusterType org - * @type {string} - * @memberof ManagedClusterTypeV2024 - */ - 'org': string; - /** - * List of processes for the cluster type - * @type {Array} - * @memberof ManagedClusterTypeV2024 - */ - 'managedProcessIds'?: Array; -} -/** - * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products - * @export - * @enum {string} - */ - -export const ManagedClusterTypesV2024 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc', - Pag: 'pag', - DasAm: 'das-am', - Standard: 'standard' -} as const; - -export type ManagedClusterTypesV2024 = typeof ManagedClusterTypesV2024[keyof typeof ManagedClusterTypesV2024]; - - -/** - * The preference for applying updates for the cluster - * @export - * @interface ManagedClusterUpdatePreferencesV2024 - */ -export interface ManagedClusterUpdatePreferencesV2024 { - /** - * The processGroups for updatePreferences - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2024 - */ - 'processGroups'?: string | null; - /** - * The current updateState for the cluster - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2024 - */ - 'updateState'?: ManagedClusterUpdatePreferencesV2024UpdateStateV2024 | null; - /** - * The mail id to which new releases will be notified - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2024 - */ - 'notificationEmail'?: string | null; -} - -export const ManagedClusterUpdatePreferencesV2024UpdateStateV2024 = { - Auto: 'AUTO', - Disabled: 'DISABLED' -} as const; - -export type ManagedClusterUpdatePreferencesV2024UpdateStateV2024 = typeof ManagedClusterUpdatePreferencesV2024UpdateStateV2024[keyof typeof ManagedClusterUpdatePreferencesV2024UpdateStateV2024]; - -/** - * Managed Cluster - * @export - * @interface ManagedClusterV2024 - */ -export interface ManagedClusterV2024 { - /** - * ManagedCluster ID - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'id': string; - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'name'?: string; - /** - * ManagedCluster pod - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'pod'?: string; - /** - * ManagedCluster org - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'org'?: string; - /** - * - * @type {ManagedClusterTypesV2024} - * @memberof ManagedClusterV2024 - */ - 'type'?: ManagedClusterTypesV2024; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string | null; }} - * @memberof ManagedClusterV2024 - */ - 'configuration'?: { [key: string]: string | null; }; - /** - * - * @type {ManagedClusterKeyPairV2024} - * @memberof ManagedClusterV2024 - */ - 'keyPair'?: ManagedClusterKeyPairV2024; - /** - * - * @type {ManagedClusterAttributesV2024} - * @memberof ManagedClusterV2024 - */ - 'attributes'?: ManagedClusterAttributesV2024; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'description'?: string; - /** - * - * @type {ManagedClusterRedisV2024} - * @memberof ManagedClusterV2024 - */ - 'redis'?: ManagedClusterRedisV2024; - /** - * - * @type {ManagedClientTypeV2024} - * @memberof ManagedClusterV2024 - */ - 'clientType': ManagedClientTypeV2024 | null; - /** - * CCG version used by the ManagedCluster - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'ccgVersion': string; - /** - * boolean flag indicating whether or not the cluster configuration is pinned - * @type {boolean} - * @memberof ManagedClusterV2024 - */ - 'pinnedConfig'?: boolean; - /** - * - * @type {ClientLogConfigurationV2024} - * @memberof ManagedClusterV2024 - */ - 'logConfiguration'?: ClientLogConfigurationV2024 | null; - /** - * Whether or not the cluster is operational or not - * @type {boolean} - * @memberof ManagedClusterV2024 - */ - 'operational'?: boolean; - /** - * Cluster status - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'status'?: ManagedClusterV2024StatusV2024; - /** - * Public key certificate - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'publicKeyCertificate'?: string | null; - /** - * Public key thumbprint - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'publicKeyThumbprint'?: string | null; - /** - * Public key - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'publicKey'?: string | null; - /** - * - * @type {ManagedClusterEncryptionConfigV2024} - * @memberof ManagedClusterV2024 - */ - 'encryptionConfiguration'?: ManagedClusterEncryptionConfigV2024; - /** - * Key describing any immediate cluster alerts - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'alertKey'?: string; - /** - * List of clients in a cluster - * @type {Array} - * @memberof ManagedClusterV2024 - */ - 'clientIds'?: Array; - /** - * Number of services bound to a cluster - * @type {number} - * @memberof ManagedClusterV2024 - */ - 'serviceCount'?: number; - /** - * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'ccId'?: string; - /** - * The date/time this cluster was created - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'createdAt'?: string | null; - /** - * The date/time this cluster was last updated - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'updatedAt'?: string | null; - /** - * The date/time this cluster was notified for the last release - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'lastReleaseNotifiedAt'?: string | null; - /** - * - * @type {ManagedClusterUpdatePreferencesV2024} - * @memberof ManagedClusterV2024 - */ - 'updatePreferences'?: ManagedClusterUpdatePreferencesV2024; - /** - * The current installed release on the Managed cluster - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'currentInstalledReleaseVersion'?: string | null; - /** - * New available updates for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'updatePackage'?: string | null; - /** - * The time at which out of date notification was sent for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'isOutOfDateNotifiedAt'?: string | null; - /** - * The consolidated Health Status for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2024 - */ - 'consolidatedHealthIndicatorsStatus'?: ManagedClusterV2024ConsolidatedHealthIndicatorsStatusV2024 | null; -} - -export const ManagedClusterV2024StatusV2024 = { - Configuring: 'CONFIGURING', - Failed: 'FAILED', - NoClients: 'NO_CLIENTS', - Normal: 'NORMAL', - Warning: 'WARNING' -} as const; - -export type ManagedClusterV2024StatusV2024 = typeof ManagedClusterV2024StatusV2024[keyof typeof ManagedClusterV2024StatusV2024]; -export const ManagedClusterV2024ConsolidatedHealthIndicatorsStatusV2024 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClusterV2024ConsolidatedHealthIndicatorsStatusV2024 = typeof ManagedClusterV2024ConsolidatedHealthIndicatorsStatusV2024[keyof typeof ManagedClusterV2024ConsolidatedHealthIndicatorsStatusV2024]; - -/** - * - * @export - * @interface ManagerCorrelationMappingV2024 - */ -export interface ManagerCorrelationMappingV2024 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof ManagerCorrelationMappingV2024 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof ManagerCorrelationMappingV2024 - */ - 'identityAttributeName'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsTemplateV2024 - */ -export interface ManualDiscoverApplicationsTemplateV2024 { - /** - * Name of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2024 - */ - 'application_name'?: string; - /** - * Description of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2024 - */ - 'description'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsV2024 - */ -export interface ManualDiscoverApplicationsV2024 { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ManualDiscoverApplicationsV2024 - */ - 'file': File; -} -/** - * Identity of current work item owner. - * @export - * @interface ManualWorkItemDetailsCurrentOwnerV2024 - */ -export interface ManualWorkItemDetailsCurrentOwnerV2024 { - /** - * DTO type of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2024 - */ - 'type'?: ManualWorkItemDetailsCurrentOwnerV2024TypeV2024; - /** - * ID of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2024 - */ - 'id'?: string; - /** - * Display name of current work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2024 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsCurrentOwnerV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsCurrentOwnerV2024TypeV2024 = typeof ManualWorkItemDetailsCurrentOwnerV2024TypeV2024[keyof typeof ManualWorkItemDetailsCurrentOwnerV2024TypeV2024]; - -/** - * Identity of original work item owner, if the work item has been forwarded. - * @export - * @interface ManualWorkItemDetailsOriginalOwnerV2024 - */ -export interface ManualWorkItemDetailsOriginalOwnerV2024 { - /** - * DTO type of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2024 - */ - 'type'?: ManualWorkItemDetailsOriginalOwnerV2024TypeV2024; - /** - * ID of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2024 - */ - 'id'?: string; - /** - * Display name of original work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2024 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsOriginalOwnerV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsOriginalOwnerV2024TypeV2024 = typeof ManualWorkItemDetailsOriginalOwnerV2024TypeV2024[keyof typeof ManualWorkItemDetailsOriginalOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface ManualWorkItemDetailsV2024 - */ -export interface ManualWorkItemDetailsV2024 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetailsV2024 - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwnerV2024} - * @memberof ManualWorkItemDetailsV2024 - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwnerV2024 | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwnerV2024} - * @memberof ManualWorkItemDetailsV2024 - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwnerV2024 | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetailsV2024 - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemStateV2024} - * @memberof ManualWorkItemDetailsV2024 - */ - 'status'?: ManualWorkItemStateV2024; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetailsV2024 - */ - 'forwardHistory'?: Array | null; -} - - -/** - * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. - * @export - * @enum {string} - */ - -export const ManualWorkItemStateV2024 = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Expired: 'EXPIRED', - Cancelled: 'CANCELLED', - Archived: 'ARCHIVED' -} as const; - -export type ManualWorkItemStateV2024 = typeof ManualWorkItemStateV2024[keyof typeof ManualWorkItemStateV2024]; - - -/** - * - * @export - * @interface MatchTermV2024 - */ -export interface MatchTermV2024 { - /** - * The attribute name - * @type {string} - * @memberof MatchTermV2024 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof MatchTermV2024 - */ - 'value'?: string; - /** - * The operator between name and value - * @type {string} - * @memberof MatchTermV2024 - */ - 'op'?: string; - /** - * If it is a container or a real match term - * @type {boolean} - * @memberof MatchTermV2024 - */ - 'container'?: boolean; - /** - * If it is AND logical operator for the children match terms - * @type {boolean} - * @memberof MatchTermV2024 - */ - 'and'?: boolean; - /** - * The children under this match term - * @type {Array<{ [key: string]: any; }>} - * @memberof MatchTermV2024 - */ - 'children'?: Array<{ [key: string]: any; }> | null; -} -/** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @export - * @enum {string} - */ - -export const MediumV2024 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type MediumV2024 = typeof MediumV2024[keyof typeof MediumV2024]; - - -/** - * An enumeration of the types of membership choices - * @export - * @enum {string} - */ - -export const MembershipTypeV2024 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION' -} as const; - -export type MembershipTypeV2024 = typeof MembershipTypeV2024[keyof typeof MembershipTypeV2024]; - - -/** - * The calculation done on the results of the query - * @export - * @interface MetricAggregationV2024 - */ -export interface MetricAggregationV2024 { - /** - * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - * @type {string} - * @memberof MetricAggregationV2024 - */ - 'name': string; - /** - * - * @type {MetricTypeV2024} - * @memberof MetricAggregationV2024 - */ - 'type'?: MetricTypeV2024; - /** - * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof MetricAggregationV2024 - */ - 'field': string; -} - - -/** - * - * @export - * @interface MetricResponseV2024 - */ -export interface MetricResponseV2024 { - /** - * the name of metric - * @type {string} - * @memberof MetricResponseV2024 - */ - 'name'?: string; - /** - * the value associated to the metric - * @type {number} - * @memberof MetricResponseV2024 - */ - 'value'?: number; -} -/** - * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const MetricTypeV2024 = { - Count: 'COUNT', - UniqueCount: 'UNIQUE_COUNT', - Avg: 'AVG', - Sum: 'SUM', - Median: 'MEDIAN', - Min: 'MIN', - Max: 'MAX' -} as const; - -export type MetricTypeV2024 = typeof MetricTypeV2024[keyof typeof MetricTypeV2024]; - - -/** - * Response model for configuration test of a given MFA method - * @export - * @interface MfaConfigTestResponseV2024 - */ -export interface MfaConfigTestResponseV2024 { - /** - * The configuration test result. - * @type {string} - * @memberof MfaConfigTestResponseV2024 - */ - 'state'?: MfaConfigTestResponseV2024StateV2024; - /** - * The error message to indicate the failure of configuration test. - * @type {string} - * @memberof MfaConfigTestResponseV2024 - */ - 'error'?: string; -} - -export const MfaConfigTestResponseV2024StateV2024 = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MfaConfigTestResponseV2024StateV2024 = typeof MfaConfigTestResponseV2024StateV2024[keyof typeof MfaConfigTestResponseV2024StateV2024]; - -/** - * - * @export - * @interface MfaDuoConfigV2024 - */ -export interface MfaDuoConfigV2024 { - /** - * Mfa method name - * @type {string} - * @memberof MfaDuoConfigV2024 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaDuoConfigV2024 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2024 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2024 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2024 - */ - 'identityAttribute'?: string | null; - /** - * A map with additional config properties for the given MFA method - duo-web. - * @type {{ [key: string]: any; }} - * @memberof MfaDuoConfigV2024 - */ - 'configProperties'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface MfaOktaConfigV2024 - */ -export interface MfaOktaConfigV2024 { - /** - * Mfa method name - * @type {string} - * @memberof MfaOktaConfigV2024 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaOktaConfigV2024 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2024 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2024 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2024 - */ - 'identityAttribute'?: string | null; -} -/** - * This represents a Multi-Host Integration template type. - * @export - * @interface MultiHostIntegrationTemplateTypeV2024 - */ -export interface MultiHostIntegrationTemplateTypeV2024 { - /** - * This is the name of the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2024 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2024 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2024 - */ - 'scriptName': string; -} -/** - * Reference to accounts file for the source. - * @export - * @interface MultiHostIntegrationsAccountsFileV2024 - */ -export interface MultiHostIntegrationsAccountsFileV2024 { - /** - * Name of the accounts file. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2024 - */ - 'name'?: string; - /** - * The accounts file key. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2024 - */ - 'key'?: string; - /** - * Date-time when the file was uploaded - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2024 - */ - 'uploadTime'?: string; - /** - * Date-time when the accounts file expired. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2024 - */ - 'expiry'?: string; - /** - * If this is true, it indicates that the accounts file has expired. - * @type {boolean} - * @memberof MultiHostIntegrationsAccountsFileV2024 - */ - 'expired'?: boolean; -} -/** - * - * @export - * @interface MultiHostIntegrationsAggScheduleUpdateV2024 - */ -export interface MultiHostIntegrationsAggScheduleUpdateV2024 { - /** - * Multi-Host Integration ID. The ID must be unique - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'multihostId': string; - /** - * Multi-Host Integration aggregation group ID - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'aggregation_grp_id': string; - /** - * Multi-Host Integration name - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'aggregation_grp_name': string; - /** - * Cron expression to schedule aggregation - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'aggregation_cron_schedule': string; - /** - * Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. - * @type {boolean} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'enableSchedule': boolean; - /** - * Source IDs of the Multi-Host Integration - * @type {Array} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'source_id_list': Array; - /** - * Created date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'created'?: string; - /** - * Modified date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2024 - */ - 'modified'?: string; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface MultiHostIntegrationsBeforeProvisioningRuleV2024 - */ -export interface MultiHostIntegrationsBeforeProvisioningRuleV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2024 - */ - 'type'?: MultiHostIntegrationsBeforeProvisioningRuleV2024TypeV2024; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2024 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2024 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsBeforeProvisioningRuleV2024TypeV2024 = { - Rule: 'RULE' -} as const; - -export type MultiHostIntegrationsBeforeProvisioningRuleV2024TypeV2024 = typeof MultiHostIntegrationsBeforeProvisioningRuleV2024TypeV2024[keyof typeof MultiHostIntegrationsBeforeProvisioningRuleV2024TypeV2024]; - -/** - * - * @export - * @interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2024 - */ -export interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2024 { - /** - * File name of the connector JAR - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2024 - */ - 'connectorFileNameUploadedDate'?: string; -} -/** - * Attributes of Multi-Host Integration - * @export - * @interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 - */ -export interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 { - /** - * Password. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 - */ - 'password'?: string; - /** - * Connector file. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 - */ - 'connector_files'?: string; - /** - * Authentication type. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 - */ - 'authType'?: string; - /** - * Username. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024 - */ - 'user'?: string; -} -/** - * Connector specific configuration. This configuration will differ for Multi-Host Integration type. - * @export - * @interface MultiHostIntegrationsConnectorAttributesV2024 - */ -export interface MultiHostIntegrationsConnectorAttributesV2024 { - [key: string]: string | any; - - /** - * Maximum sources allowed count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'maxAllowedSources'?: number; - /** - * Last upload sources count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'lastSourceUploadCount'?: number; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2024} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'connectorFileUploadHistory'?: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2024; - /** - * Multi-Host integration status. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'multihost_status'?: MultiHostIntegrationsConnectorAttributesV2024MultihostStatusV2024; - /** - * Show account schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'showAccountSchema'?: boolean; - /** - * Show entitlement schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'showEntitlementSchema'?: boolean; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024} - * @memberof MultiHostIntegrationsConnectorAttributesV2024 - */ - 'multiHostAttributes'?: MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2024; -} - -export const MultiHostIntegrationsConnectorAttributesV2024MultihostStatusV2024 = { - Ready: 'ready', - Processing: 'processing', - FileUploadInProgress: 'fileUploadInProgress', - SourceCreationInProgress: 'sourceCreationInProgress', - AggregationGroupingInProgress: 'aggregationGroupingInProgress', - AggregationScheduleInProgress: 'aggregationScheduleInProgress', - DeleteInProgress: 'deleteInProgress', - DeleteFailed: 'deleteFailed' -} as const; - -export type MultiHostIntegrationsConnectorAttributesV2024MultihostStatusV2024 = typeof MultiHostIntegrationsConnectorAttributesV2024MultihostStatusV2024[keyof typeof MultiHostIntegrationsConnectorAttributesV2024MultihostStatusV2024]; - -/** - * This represents sources to be created of same type. - * @export - * @interface MultiHostIntegrationsCreateSourcesV2024 - */ -export interface MultiHostIntegrationsCreateSourcesV2024 { - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2024 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2024 - */ - 'description'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateSourcesV2024 - */ - 'connectorAttributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MultiHostIntegrationsCreateV2024 - */ -export interface MultiHostIntegrationsCreateV2024 { - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2024} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'owner': MultiHostIntegrationsOwnerV2024; - /** - * - * @type {SourceClusterV2024} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'cluster'?: SourceClusterV2024 | null; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'connector': string; - /** - * Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * - * @type {SourceManagementWorkgroupV2024} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2024 | null; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2024 - */ - 'modified'?: string; -} -/** - * Reference to identity object who owns the source. - * @export - * @interface MultiHostIntegrationsOwnerV2024 - */ -export interface MultiHostIntegrationsOwnerV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2024 - */ - 'type'?: MultiHostIntegrationsOwnerV2024TypeV2024; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2024 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2024 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type MultiHostIntegrationsOwnerV2024TypeV2024 = typeof MultiHostIntegrationsOwnerV2024TypeV2024[keyof typeof MultiHostIntegrationsOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface MultiHostIntegrationsV2024 - */ -export interface MultiHostIntegrationsV2024 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'id': string; - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'owner': MultiHostIntegrationsOwnerV2024; - /** - * - * @type {SourceClusterV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'cluster'?: SourceClusterV2024 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2024 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2024 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2024; - /** - * - * @type {SourceManagerCorrelationRuleV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2024 | null; - /** - * - * @type {MultiHostIntegrationsBeforeProvisioningRuleV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'beforeProvisioningRule'?: MultiHostIntegrationsBeforeProvisioningRuleV2024 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2024 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2024 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostIntegrationsV2024 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectorClass'?: string; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectorAttributes'?: MultiHostIntegrationsConnectorAttributesV2024; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostIntegrationsV2024 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostIntegrationsV2024 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2024 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostIntegrationsV2024 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'status'?: MultiHostIntegrationsV2024StatusV2024; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectionType'?: MultiHostIntegrationsV2024ConnectionTypeV2024; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostIntegrationsV2024 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostIntegrationsV2024 - */ - 'category'?: string | null; - /** - * - * @type {MultiHostIntegrationsAccountsFileV2024} - * @memberof MultiHostIntegrationsV2024 - */ - 'accountsFile'?: MultiHostIntegrationsAccountsFileV2024 | null; -} - -export const MultiHostIntegrationsV2024FeaturesV2024 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostIntegrationsV2024FeaturesV2024 = typeof MultiHostIntegrationsV2024FeaturesV2024[keyof typeof MultiHostIntegrationsV2024FeaturesV2024]; -export const MultiHostIntegrationsV2024StatusV2024 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostIntegrationsV2024StatusV2024 = typeof MultiHostIntegrationsV2024StatusV2024[keyof typeof MultiHostIntegrationsV2024StatusV2024]; -export const MultiHostIntegrationsV2024ConnectionTypeV2024 = { - Direct: 'direct', - File: 'file' -} as const; - -export type MultiHostIntegrationsV2024ConnectionTypeV2024 = typeof MultiHostIntegrationsV2024ConnectionTypeV2024[keyof typeof MultiHostIntegrationsV2024ConnectionTypeV2024]; - -/** - * - * @export - * @interface MultiHostSourcesV2024 - */ -export interface MultiHostSourcesV2024 { - /** - * Source ID. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'id': string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'description'?: string; - /** - * - * @type {MultiHostIntegrationsOwnerV2024} - * @memberof MultiHostSourcesV2024 - */ - 'owner': MultiHostIntegrationsOwnerV2024; - /** - * - * @type {SourceClusterV2024} - * @memberof MultiHostSourcesV2024 - */ - 'cluster'?: SourceClusterV2024 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2024} - * @memberof MultiHostSourcesV2024 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2024 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2024} - * @memberof MultiHostSourcesV2024 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2024 | null; - /** - * - * @type {ManagerCorrelationMappingV2024} - * @memberof MultiHostSourcesV2024 - */ - 'managerCorrelationMapping'?: ManagerCorrelationMappingV2024; - /** - * - * @type {SourceManagerCorrelationRuleV2024} - * @memberof MultiHostSourcesV2024 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2024 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2024} - * @memberof MultiHostSourcesV2024 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2024 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostSourcesV2024 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostSourcesV2024 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostSourcesV2024 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostSourcesV2024 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostSourcesV2024 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostSourcesV2024 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2024} - * @memberof MultiHostSourcesV2024 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2024 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostSourcesV2024 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'status'?: MultiHostSourcesV2024StatusV2024; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connectorName': string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostSourcesV2024 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostSourcesV2024 - */ - 'category'?: string | null; -} - -export const MultiHostSourcesV2024FeaturesV2024 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostSourcesV2024FeaturesV2024 = typeof MultiHostSourcesV2024FeaturesV2024[keyof typeof MultiHostSourcesV2024FeaturesV2024]; -export const MultiHostSourcesV2024StatusV2024 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostSourcesV2024StatusV2024 = typeof MultiHostSourcesV2024StatusV2024[keyof typeof MultiHostSourcesV2024StatusV2024]; - -/** - * - * @export - * @interface MultiPolicyRequestV2024 - */ -export interface MultiPolicyRequestV2024 { - /** - * Multi-policy report will be run for this list of ids - * @type {Array} - * @memberof MultiPolicyRequestV2024 - */ - 'filteredPolicyList'?: Array; -} -/** - * - * @export - * @interface NameNormalizerV2024 - */ -export interface NameNormalizerV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof NameNormalizerV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof NameNormalizerV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * | Construct | Date Time Pattern | Description | | --------- | ----------------- | ----------- | | ISO8601 | `yyyy-MM-dd\'T\'HH:mm:ss.SSSX` | The ISO8601 standard. | | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - * @export - * @enum {string} - */ - -export const NamedConstructsV2024 = { - Iso8601: 'ISO8601', - Ldap: 'LDAP', - PeopleSoft: 'PEOPLE_SOFT', - EpochTimeJava: 'EPOCH_TIME_JAVA', - EpochTimeWin32: 'EPOCH_TIME_WIN32' -} as const; - -export type NamedConstructsV2024 = typeof NamedConstructsV2024[keyof typeof NamedConstructsV2024]; - - -/** - * Source configuration information for Native Change Detection that is read and used by account aggregation process. - * @export - * @interface NativeChangeDetectionConfigV2024 - */ -export interface NativeChangeDetectionConfigV2024 { - /** - * A flag indicating if Native Change Detection is enabled for a source. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'enabled'?: boolean; - /** - * Operation types for which Native Change Detection is enabled for a source. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'operations'?: Array; - /** - * A flag indicating that all entitlements participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'allEntitlements'?: boolean; - /** - * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'allNonEntitlementAttributes'?: boolean; - /** - * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'selectedEntitlements'?: Array; - /** - * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2024 - */ - 'selectedNonEntitlementAttributes'?: Array; -} - -export const NativeChangeDetectionConfigV2024OperationsV2024 = { - AccountUpdated: 'ACCOUNT_UPDATED', - AccountCreated: 'ACCOUNT_CREATED', - AccountDeleted: 'ACCOUNT_DELETED' -} as const; - -export type NativeChangeDetectionConfigV2024OperationsV2024 = typeof NativeChangeDetectionConfigV2024OperationsV2024[keyof typeof NativeChangeDetectionConfigV2024OperationsV2024]; - -/** - * The nested aggregation object. - * @export - * @interface NestedAggregationV2024 - */ -export interface NestedAggregationV2024 { - /** - * The name of the nested aggregate to be included in the result. - * @type {string} - * @memberof NestedAggregationV2024 - */ - 'name': string; - /** - * The type of the nested object. - * @type {string} - * @memberof NestedAggregationV2024 - */ - 'type': string; -} -/** - * - * @export - * @interface NetworkConfigurationV2024 - */ -export interface NetworkConfigurationV2024 { - /** - * The collection of ip ranges. - * @type {Array} - * @memberof NetworkConfigurationV2024 - */ - 'range'?: Array | null; - /** - * The collection of country codes. - * @type {Array} - * @memberof NetworkConfigurationV2024 - */ - 'geolocation'?: Array | null; - /** - * Denotes whether the provided lists are whitelisted or blacklisted for geo location. - * @type {boolean} - * @memberof NetworkConfigurationV2024 - */ - 'whitelisted'?: boolean; -} -/** - * - * @export - * @interface NonEmployeeApprovalDecisionV2024 - */ -export interface NonEmployeeApprovalDecisionV2024 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeApprovalDecisionV2024 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface NonEmployeeApprovalItemBaseV2024 - */ -export interface NonEmployeeApprovalItemBaseV2024 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2024} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2024; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2024} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'approvalStatus'?: ApprovalStatusV2024; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2024 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemDetailV2024 - */ -export interface NonEmployeeApprovalItemDetailV2024 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2024} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2024; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2024} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'approvalStatus'?: ApprovalStatusV2024; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestWithoutApprovalItemV2024} - * @memberof NonEmployeeApprovalItemDetailV2024 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItemV2024; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemV2024 - */ -export interface NonEmployeeApprovalItemV2024 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2024} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2024; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2024} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'approvalStatus'?: ApprovalStatusV2024; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestLiteV2024} - * @memberof NonEmployeeApprovalItemV2024 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestLiteV2024; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalSummaryV2024 - */ -export interface NonEmployeeApprovalSummaryV2024 { - /** - * The number of approved non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2024 - */ - 'approved'?: number; - /** - * The number of pending non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2024 - */ - 'pending'?: number; - /** - * The number of rejected non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2024 - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface NonEmployeeBulkUploadJobV2024 - */ -export interface NonEmployeeBulkUploadJobV2024 { - /** - * The bulk upload job\'s ID. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2024 - */ - 'id'?: string; - /** - * The ID of the source to bulk-upload non-employees to. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2024 - */ - 'sourceId'?: string; - /** - * The date-time the job was submitted. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2024 - */ - 'created'?: string; - /** - * The date-time that the job was last updated. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2024 - */ - 'modified'?: string; - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2024 - */ - 'status'?: NonEmployeeBulkUploadJobV2024StatusV2024; -} - -export const NonEmployeeBulkUploadJobV2024StatusV2024 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadJobV2024StatusV2024 = typeof NonEmployeeBulkUploadJobV2024StatusV2024[keyof typeof NonEmployeeBulkUploadJobV2024StatusV2024]; - -/** - * - * @export - * @interface NonEmployeeBulkUploadStatusV2024 - */ -export interface NonEmployeeBulkUploadStatusV2024 { - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. - * @type {string} - * @memberof NonEmployeeBulkUploadStatusV2024 - */ - 'status'?: NonEmployeeBulkUploadStatusV2024StatusV2024; -} - -export const NonEmployeeBulkUploadStatusV2024StatusV2024 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadStatusV2024StatusV2024 = typeof NonEmployeeBulkUploadStatusV2024StatusV2024[keyof typeof NonEmployeeBulkUploadStatusV2024StatusV2024]; - -/** - * Identifies if the identity is a normal identity or a governance group - * @export - * @enum {string} - */ - -export const NonEmployeeIdentityDtoTypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeIdentityDtoTypeV2024 = typeof NonEmployeeIdentityDtoTypeV2024[keyof typeof NonEmployeeIdentityDtoTypeV2024]; - - -/** - * - * @export - * @interface NonEmployeeIdentityReferenceWithIdV2024 - */ -export interface NonEmployeeIdentityReferenceWithIdV2024 { - /** - * - * @type {NonEmployeeIdentityDtoTypeV2024} - * @memberof NonEmployeeIdentityReferenceWithIdV2024 - */ - 'type'?: NonEmployeeIdentityDtoTypeV2024; - /** - * Identity id - * @type {string} - * @memberof NonEmployeeIdentityReferenceWithIdV2024 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeIdnUserRequestV2024 - */ -export interface NonEmployeeIdnUserRequestV2024 { - /** - * Identity id. - * @type {string} - * @memberof NonEmployeeIdnUserRequestV2024 - */ - 'id': string; -} -/** - * - * @export - * @interface NonEmployeeRecordV2024 - */ -export interface NonEmployeeRecordV2024 { - /** - * Non-Employee record id. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'id'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'manager'?: string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'sourceId'?: string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRecordV2024 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRecordV2024 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeRejectApprovalDecisionV2024 - */ -export interface NonEmployeeRejectApprovalDecisionV2024 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeRejectApprovalDecisionV2024 - */ - 'comment': string; -} -/** - * - * @export - * @interface NonEmployeeRequestBodyV2024 - */ -export interface NonEmployeeRequestBodyV2024 { - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'accountName': string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'firstName': string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'lastName': string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'email': string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'phone': string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'manager': string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'sourceId': string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'startDate': string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2024 - */ - 'endDate': string; -} -/** - * - * @export - * @interface NonEmployeeRequestLiteV2024 - */ -export interface NonEmployeeRequestLiteV2024 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestLiteV2024 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2024} - * @memberof NonEmployeeRequestLiteV2024 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2024; -} -/** - * - * @export - * @interface NonEmployeeRequestSummaryV2024 - */ -export interface NonEmployeeRequestSummaryV2024 { - /** - * The number of approved non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2024 - */ - 'approved'?: number; - /** - * The number of rejected non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2024 - */ - 'rejected'?: number; - /** - * The number of pending non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2024 - */ - 'pending'?: number; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2024 - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NonEmployeeRequestV2024 - */ -export interface NonEmployeeRequestV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'description'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteV2024} - * @memberof NonEmployeeRequestV2024 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteV2024; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestV2024 - */ - 'data'?: { [key: string]: string; }; - /** - * List of approval item for the request - * @type {Array} - * @memberof NonEmployeeRequestV2024 - */ - 'approvalItems'?: Array; - /** - * - * @type {ApprovalStatusV2024} - * @memberof NonEmployeeRequestV2024 - */ - 'approvalStatus'?: ApprovalStatusV2024; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestV2024 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeRequestWithoutApprovalItemV2024 - */ -export interface NonEmployeeRequestWithoutApprovalItemV2024 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2024} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2024; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteWithSchemaAttributesV2024} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributesV2024; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'data'?: { [key: string]: string; }; - /** - * - * @type {ApprovalStatusV2024} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'approvalStatus'?: ApprovalStatusV2024; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2024 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBodyV2024 - */ -export interface NonEmployeeSchemaAttributeBodyV2024 { - /** - * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'type': string; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBodyV2024 - */ - 'required'?: boolean; -} -/** - * Enum representing the type of data a schema attribute accepts. - * @export - * @enum {string} - */ - -export const NonEmployeeSchemaAttributeTypeV2024 = { - Text: 'TEXT', - Date: 'DATE', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeSchemaAttributeTypeV2024 = typeof NonEmployeeSchemaAttributeTypeV2024[keyof typeof NonEmployeeSchemaAttributeTypeV2024]; - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeV2024 - */ -export interface NonEmployeeSchemaAttributeV2024 { - /** - * Schema Attribute Id - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'id'?: string; - /** - * True if this schema attribute is mandatory on all non-employees sources. - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'system'?: boolean; - /** - * When the schema attribute was last modified. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'modified'?: string; - /** - * When the schema attribute was created. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeSchemaAttributeTypeV2024} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'type': NonEmployeeSchemaAttributeTypeV2024; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2024 - */ - 'required'?: boolean; -} - - -/** - * - * @export - * @interface NonEmployeeSourceLiteV2024 - */ -export interface NonEmployeeSourceLiteV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2024 - */ - 'description'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ -export interface NonEmployeeSourceLiteWithSchemaAttributesV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ - 'description'?: string; - /** - * List of schema attributes associated with this non-employee source. - * @type {Array} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2024 - */ - 'schemaAttributes'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceRequestBodyV2024 - */ -export interface NonEmployeeSourceRequestBodyV2024 { - /** - * Name of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'name': string; - /** - * Description of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'description': string; - /** - * - * @type {NonEmployeeIdnUserRequestV2024} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'owner': NonEmployeeIdnUserRequestV2024; - /** - * The ID for the management workgroup that contains source sub-admins - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'managementWorkgroup'?: string; - /** - * List of approvers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'approvers'?: Array; - /** - * List of account managers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2024 - */ - 'accountManagers'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceV2024 - */ -export interface NonEmployeeSourceV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceV2024 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceV2024 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceV2024 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithCloudExternalIdV2024 - */ -export interface NonEmployeeSourceWithCloudExternalIdV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'created'?: string; - /** - * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2024 - */ - 'cloudExternalId'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithNECountV2024 - */ -export interface NonEmployeeSourceWithNECountV2024 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'created'?: string; - /** - * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. - * @type {number} - * @memberof NonEmployeeSourceWithNECountV2024 - */ - 'nonEmployeeCount'?: number | null; -} -/** - * - * @export - * @interface NotificationTemplateContextV2024 - */ -export interface NotificationTemplateContextV2024 { - /** - * A JSON object that stores the context. - * @type {{ [key: string]: any; }} - * @memberof NotificationTemplateContextV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * When the global context was created - * @type {string} - * @memberof NotificationTemplateContextV2024 - */ - 'created'?: string; - /** - * When the global context was last modified - * @type {string} - * @memberof NotificationTemplateContextV2024 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface ObjectExportImportNamesV2024 - */ -export interface ObjectExportImportNamesV2024 { - /** - * Object names to be included in a backup. - * @type {Array} - * @memberof ObjectExportImportNamesV2024 - */ - 'includedNames'?: Array; -} -/** - * - * @export - * @interface ObjectExportImportOptionsV2024 - */ -export interface ObjectExportImportOptionsV2024 { - /** - * Object ids to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2024 - */ - 'includedIds'?: Array; - /** - * Object names to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2024 - */ - 'includedNames'?: Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResult1V2024 - */ -export interface ObjectImportResult1V2024 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2024 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2024 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2024 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResult1V2024 - */ - 'importedObjects': Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResultV2024 - */ -export interface ObjectImportResultV2024 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2024 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2024 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2024 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResultV2024 - */ - 'importedObjects': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateRequestV2024 - */ -export interface ObjectMappingBulkCreateRequestV2024 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateRequestV2024 - */ - 'newObjectsMappings': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateResponseV2024 - */ -export interface ObjectMappingBulkCreateResponseV2024 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateResponseV2024 - */ - 'addedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchRequestV2024 - */ -export interface ObjectMappingBulkPatchRequestV2024 { - /** - * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. - * @type {{ [key: string]: Array; }} - * @memberof ObjectMappingBulkPatchRequestV2024 - */ - 'patches': { [key: string]: Array; }; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchResponseV2024 - */ -export interface ObjectMappingBulkPatchResponseV2024 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkPatchResponseV2024 - */ - 'patchedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingRequestV2024 - */ -export interface ObjectMappingRequestV2024 { - /** - * Type of the object the mapping value applies to, must be one from enum - * @type {string} - * @memberof ObjectMappingRequestV2024 - */ - 'objectType': ObjectMappingRequestV2024ObjectTypeV2024; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingRequestV2024 - */ - 'jsonPath': string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2024 - */ - 'sourceValue': string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2024 - */ - 'targetValue': string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingRequestV2024 - */ - 'enabled'?: boolean; -} - -export const ObjectMappingRequestV2024ObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingRequestV2024ObjectTypeV2024 = typeof ObjectMappingRequestV2024ObjectTypeV2024[keyof typeof ObjectMappingRequestV2024ObjectTypeV2024]; - -/** - * - * @export - * @interface ObjectMappingResponseV2024 - */ -export interface ObjectMappingResponseV2024 { - /** - * Id of the object mapping - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'objectMappingId'?: string; - /** - * Type of the object the mapping value applies to - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'objectType'?: ObjectMappingResponseV2024ObjectTypeV2024; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'jsonPath'?: string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'sourceValue'?: string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'targetValue'?: string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingResponseV2024 - */ - 'enabled'?: boolean; - /** - * Object mapping creation timestamp - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'created'?: string; - /** - * Object mapping latest update timestamp - * @type {string} - * @memberof ObjectMappingResponseV2024 - */ - 'modified'?: string; -} - -export const ObjectMappingResponseV2024ObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingResponseV2024ObjectTypeV2024 = typeof ObjectMappingResponseV2024ObjectTypeV2024[keyof typeof ObjectMappingResponseV2024ObjectTypeV2024]; - -/** - * Operation on a specific criteria - * @export - * @enum {string} - */ - -export const OperationV2024 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - And: 'AND', - Or: 'OR' -} as const; - -export type OperationV2024 = typeof OperationV2024[keyof typeof OperationV2024]; - - -/** - * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users - * @export - * @interface OrgConfigV2024 - */ -export interface OrgConfigV2024 { - /** - * The name of the org. - * @type {string} - * @memberof OrgConfigV2024 - */ - 'orgName'?: string; - /** - * The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones - * @type {string} - * @memberof OrgConfigV2024 - */ - 'timeZone'?: string; - /** - * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. - * @type {boolean} - * @memberof OrgConfigV2024 - */ - 'lcsChangeHonorsSourceEnableFeature'?: boolean; - /** - * ARM Customer ID - * @type {string} - * @memberof OrgConfigV2024 - */ - 'armCustomerId'?: string | null; - /** - * A list of IDN::sourceId to ARM::systemId mappings. - * @type {string} - * @memberof OrgConfigV2024 - */ - 'armSapSystemIdMappings'?: string | null; - /** - * ARM authentication string - * @type {string} - * @memberof OrgConfigV2024 - */ - 'armAuth'?: string | null; - /** - * ARM database name - * @type {string} - * @memberof OrgConfigV2024 - */ - 'armDb'?: string | null; - /** - * ARM SSO URL - * @type {string} - * @memberof OrgConfigV2024 - */ - 'armSsoUrl'?: string | null; - /** - * Flag to determine whether IAI Certification Recommendations are enabled for the current org - * @type {boolean} - * @memberof OrgConfigV2024 - */ - 'iaiEnableCertificationRecommendations'?: boolean; - /** - * - * @type {Array} - * @memberof OrgConfigV2024 - */ - 'sodReportConfigs'?: Array; -} -/** - * - * @export - * @interface OriginalRequestV2024 - */ -export interface OriginalRequestV2024 { - /** - * Account ID. - * @type {string} - * @memberof OriginalRequestV2024 - */ - 'accountId'?: string; - /** - * - * @type {ResultV2024} - * @memberof OriginalRequestV2024 - */ - 'result'?: ResultV2024; - /** - * Attribute changes requested for account. - * @type {Array} - * @memberof OriginalRequestV2024 - */ - 'attributeRequests'?: Array; - /** - * Operation used. - * @type {string} - * @memberof OriginalRequestV2024 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2024} - * @memberof OriginalRequestV2024 - */ - 'source'?: AccountSourceV2024; -} -/** - * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) - * @export - * @interface OrphanIdentitiesReportArgumentsV2024 - */ -export interface OrphanIdentitiesReportArgumentsV2024 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof OrphanIdentitiesReportArgumentsV2024 - */ - 'selectedFormats'?: Array; -} - -export const OrphanIdentitiesReportArgumentsV2024SelectedFormatsV2024 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type OrphanIdentitiesReportArgumentsV2024SelectedFormatsV2024 = typeof OrphanIdentitiesReportArgumentsV2024SelectedFormatsV2024[keyof typeof OrphanIdentitiesReportArgumentsV2024SelectedFormatsV2024]; - -/** - * - * @export - * @interface OutlierContributingFeatureV2024 - */ -export interface OutlierContributingFeatureV2024 { - /** - * Contributing feature id - * @type {string} - * @memberof OutlierContributingFeatureV2024 - */ - 'id'?: string; - /** - * The name of the feature - * @type {string} - * @memberof OutlierContributingFeatureV2024 - */ - 'name'?: string; - /** - * - * @type {OutlierValueTypeV2024} - * @memberof OutlierContributingFeatureV2024 - */ - 'valueType'?: OutlierValueTypeV2024; - /** - * The feature value - * @type {number} - * @memberof OutlierContributingFeatureV2024 - */ - 'value'?: number; - /** - * The importance of the feature. This can also be a negative value - * @type {number} - * @memberof OutlierContributingFeatureV2024 - */ - 'importance'?: number; - /** - * The (translated if header is passed) displayName for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2024 - */ - 'displayName'?: string; - /** - * The (translated if header is passed) description for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2024 - */ - 'description'?: string; - /** - * - * @type {OutlierFeatureTranslationV2024} - * @memberof OutlierContributingFeatureV2024 - */ - 'translationMessages'?: OutlierFeatureTranslationV2024 | null; -} -/** - * - * @export - * @interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2024 - */ -export interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2024 { - /** - * display name - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2024 - */ - 'displayName'?: string; - /** - * value - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2024 - */ - 'value'?: string; - /** - * - * @type {OutlierValueTypeV2024} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2024 - */ - 'valueType'?: OutlierValueTypeV2024; -} -/** - * - * @export - * @interface OutlierFeatureSummaryV2024 - */ -export interface OutlierFeatureSummaryV2024 { - /** - * Contributing feature name - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'contributingFeatureName'?: string; - /** - * Identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'identityOutlierDisplayName'?: string; - /** - * - * @type {Array} - * @memberof OutlierFeatureSummaryV2024 - */ - 'outlierFeatureDisplayValues'?: Array; - /** - * Definition of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'featureDefinition'?: string; - /** - * Detailed explanation of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'featureExplanation'?: string; - /** - * outlier\'s peer identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'peerDisplayName'?: string | null; - /** - * outlier\'s peer identity id - * @type {string} - * @memberof OutlierFeatureSummaryV2024 - */ - 'peerIdentityId'?: string | null; - /** - * Access Item reference - * @type {object} - * @memberof OutlierFeatureSummaryV2024 - */ - 'accessItemReference'?: object; -} -/** - * - * @export - * @interface OutlierFeatureTranslationV2024 - */ -export interface OutlierFeatureTranslationV2024 { - /** - * - * @type {TranslationMessageV2024} - * @memberof OutlierFeatureTranslationV2024 - */ - 'displayName'?: TranslationMessageV2024; - /** - * - * @type {TranslationMessageV2024} - * @memberof OutlierFeatureTranslationV2024 - */ - 'description'?: TranslationMessageV2024; -} -/** - * - * @export - * @interface OutlierSummaryV2024 - */ -export interface OutlierSummaryV2024 { - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierSummaryV2024 - */ - 'type'?: OutlierSummaryV2024TypeV2024; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof OutlierSummaryV2024 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2024 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2024 - */ - 'totalIdentities'?: number; - /** - * - * @type {number} - * @memberof OutlierSummaryV2024 - */ - 'totalIgnored'?: number; -} - -export const OutlierSummaryV2024TypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierSummaryV2024TypeV2024 = typeof OutlierSummaryV2024TypeV2024[keyof typeof OutlierSummaryV2024TypeV2024]; - -/** - * - * @export - * @interface OutlierV2024 - */ -export interface OutlierV2024 { - /** - * The identity\'s unique identifier for the outlier record - * @type {string} - * @memberof OutlierV2024 - */ - 'id'?: string; - /** - * The ID of the identity that is detected as an outlier - * @type {string} - * @memberof OutlierV2024 - */ - 'identityId'?: string; - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierV2024 - */ - 'type'?: OutlierV2024TypeV2024; - /** - * The first date the outlier was detected - * @type {string} - * @memberof OutlierV2024 - */ - 'firstDetectionDate'?: string; - /** - * The most recent date the outlier was detected - * @type {string} - * @memberof OutlierV2024 - */ - 'latestDetectionDate'?: string; - /** - * Flag whether or not the outlier has been ignored - * @type {boolean} - * @memberof OutlierV2024 - */ - 'ignored'?: boolean; - /** - * Object containing mapped identity attributes - * @type {object} - * @memberof OutlierV2024 - */ - 'attributes'?: object; - /** - * The outlier score determined by the detection engine ranging from 0..1 - * @type {number} - * @memberof OutlierV2024 - */ - 'score'?: number; - /** - * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored - * @type {string} - * @memberof OutlierV2024 - */ - 'unignoreType'?: OutlierV2024UnignoreTypeV2024 | null; - /** - * shows date when last time has been unignored outlier - * @type {string} - * @memberof OutlierV2024 - */ - 'unignoreDate'?: string | null; - /** - * shows date when last time has been ignored outlier - * @type {string} - * @memberof OutlierV2024 - */ - 'ignoreDate'?: string | null; -} - -export const OutlierV2024TypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierV2024TypeV2024 = typeof OutlierV2024TypeV2024[keyof typeof OutlierV2024TypeV2024]; -export const OutlierV2024UnignoreTypeV2024 = { - Manual: 'MANUAL', - Automatic: 'AUTOMATIC' -} as const; - -export type OutlierV2024UnignoreTypeV2024 = typeof OutlierV2024UnignoreTypeV2024[keyof typeof OutlierV2024UnignoreTypeV2024]; - -/** - * The data type of the value field - * @export - * @interface OutlierValueTypeV2024 - */ -export interface OutlierValueTypeV2024 { - /** - * The data type of the value field - * @type {string} - * @memberof OutlierValueTypeV2024 - */ - 'name'?: OutlierValueTypeV2024NameV2024; - /** - * The position of the value type - * @type {number} - * @memberof OutlierValueTypeV2024 - */ - 'ordinal'?: number; -} - -export const OutlierValueTypeV2024NameV2024 = { - Integer: 'INTEGER', - Float: 'FLOAT' -} as const; - -export type OutlierValueTypeV2024NameV2024 = typeof OutlierValueTypeV2024NameV2024[keyof typeof OutlierValueTypeV2024NameV2024]; - -/** - * - * @export - * @interface OutliersContributingFeatureAccessItemsV2024 - */ -export interface OutliersContributingFeatureAccessItemsV2024 { - /** - * The ID of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'id'?: string; - /** - * the display name of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'displayName'?: string; - /** - * Description of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'description'?: string | null; - /** - * The type of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'accessType'?: OutliersContributingFeatureAccessItemsV2024AccessTypeV2024; - /** - * the associated source name if it exists - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'sourceName'?: string; - /** - * rarest access - * @type {boolean} - * @memberof OutliersContributingFeatureAccessItemsV2024 - */ - 'extremelyRare'?: boolean; -} - -export const OutliersContributingFeatureAccessItemsV2024AccessTypeV2024 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type OutliersContributingFeatureAccessItemsV2024AccessTypeV2024 = typeof OutliersContributingFeatureAccessItemsV2024AccessTypeV2024[keyof typeof OutliersContributingFeatureAccessItemsV2024AccessTypeV2024]; - -/** - * Owner\'s identity. - * @export - * @interface OwnerDtoV2024 - */ -export interface OwnerDtoV2024 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof OwnerDtoV2024 - */ - 'type'?: OwnerDtoV2024TypeV2024; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerDtoV2024 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof OwnerDtoV2024 - */ - 'name'?: string; -} - -export const OwnerDtoV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerDtoV2024TypeV2024 = typeof OwnerDtoV2024TypeV2024[keyof typeof OwnerDtoV2024TypeV2024]; - -/** - * The owner of this object. - * @export - * @interface OwnerReferenceSegmentsV2024 - */ -export interface OwnerReferenceSegmentsV2024 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2024 - */ - 'type'?: OwnerReferenceSegmentsV2024TypeV2024; - /** - * Identity id - * @type {string} - * @memberof OwnerReferenceSegmentsV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2024 - */ - 'name'?: string; -} - -export const OwnerReferenceSegmentsV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceSegmentsV2024TypeV2024 = typeof OwnerReferenceSegmentsV2024TypeV2024[keyof typeof OwnerReferenceSegmentsV2024TypeV2024]; - -/** - * Owner of the object. - * @export - * @interface OwnerReferenceV2024 - */ -export interface OwnerReferenceV2024 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2024 - */ - 'type'?: OwnerReferenceV2024TypeV2024; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerReferenceV2024 - */ - 'id'?: string; - /** - * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2024 - */ - 'name'?: string; -} - -export const OwnerReferenceV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceV2024TypeV2024 = typeof OwnerReferenceV2024TypeV2024[keyof typeof OwnerReferenceV2024TypeV2024]; - -/** - * - * @export - * @interface OwnsV2024 - */ -export interface OwnsV2024 { - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'sources'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'entitlements'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'accessProfiles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'roles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'apps'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2024 - */ - 'governanceGroups'?: Array; - /** - * - * @type {boolean} - * @memberof OwnsV2024 - */ - 'fallbackApprover'?: boolean; -} -/** - * - * @export - * @interface PasswordChangeRequestV2024 - */ -export interface PasswordChangeRequestV2024 { - /** - * The identity ID that requested the password change - * @type {string} - * @memberof PasswordChangeRequestV2024 - */ - 'identityId'?: string; - /** - * The RSA encrypted password - * @type {string} - * @memberof PasswordChangeRequestV2024 - */ - 'encryptedPassword'?: string; - /** - * The encryption key ID - * @type {string} - * @memberof PasswordChangeRequestV2024 - */ - 'publicKeyId'?: string; - /** - * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordChangeRequestV2024 - */ - 'accountId'?: string; - /** - * The ID of the source for which identity is requesting the password change - * @type {string} - * @memberof PasswordChangeRequestV2024 - */ - 'sourceId'?: string; -} -/** - * - * @export - * @interface PasswordChangeResponseV2024 - */ -export interface PasswordChangeResponseV2024 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordChangeResponseV2024 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordChangeResponseV2024 - */ - 'state'?: PasswordChangeResponseV2024StateV2024; -} - -export const PasswordChangeResponseV2024StateV2024 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordChangeResponseV2024StateV2024 = typeof PasswordChangeResponseV2024StateV2024[keyof typeof PasswordChangeResponseV2024StateV2024]; - -/** - * - * @export - * @interface PasswordDigitTokenResetV2024 - */ -export interface PasswordDigitTokenResetV2024 { - /** - * The uid of the user requested for digit token - * @type {string} - * @memberof PasswordDigitTokenResetV2024 - */ - 'userId': string; - /** - * The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. - * @type {number} - * @memberof PasswordDigitTokenResetV2024 - */ - 'length'?: number; - /** - * The time to live for the digit token in minutes. The default value is 5 minutes. - * @type {number} - * @memberof PasswordDigitTokenResetV2024 - */ - 'durationMinutes'?: number; -} -/** - * - * @export - * @interface PasswordDigitTokenV2024 - */ -export interface PasswordDigitTokenV2024 { - /** - * The digit token for password management - * @type {string} - * @memberof PasswordDigitTokenV2024 - */ - 'digitToken'?: string; - /** - * The reference ID of the digit token generation request - * @type {string} - * @memberof PasswordDigitTokenV2024 - */ - 'requestId'?: string; -} -/** - * - * @export - * @interface PasswordInfoAccountV2024 - */ -export interface PasswordInfoAccountV2024 { - /** - * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordInfoAccountV2024 - */ - 'accountId'?: string; - /** - * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - * @type {string} - * @memberof PasswordInfoAccountV2024 - */ - 'accountName'?: string; -} -/** - * - * @export - * @interface PasswordInfoQueryDTOV2024 - */ -export interface PasswordInfoQueryDTOV2024 { - /** - * The login name of the user - * @type {string} - * @memberof PasswordInfoQueryDTOV2024 - */ - 'userName'?: string; - /** - * The display name of the source - * @type {string} - * @memberof PasswordInfoQueryDTOV2024 - */ - 'sourceName'?: string; -} -/** - * - * @export - * @interface PasswordInfoV2024 - */ -export interface PasswordInfoV2024 { - /** - * Identity ID - * @type {string} - * @memberof PasswordInfoV2024 - */ - 'identityId'?: string; - /** - * source ID - * @type {string} - * @memberof PasswordInfoV2024 - */ - 'sourceId'?: string; - /** - * public key ID - * @type {string} - * @memberof PasswordInfoV2024 - */ - 'publicKeyId'?: string; - /** - * User\'s public key with Base64 encoding - * @type {string} - * @memberof PasswordInfoV2024 - */ - 'publicKey'?: string; - /** - * Account info related to queried identity and source - * @type {Array} - * @memberof PasswordInfoV2024 - */ - 'accounts'?: Array; - /** - * Password constraints - * @type {Array} - * @memberof PasswordInfoV2024 - */ - 'policies'?: Array; -} -/** - * - * @export - * @interface PasswordOrgConfigV2024 - */ -export interface PasswordOrgConfigV2024 { - /** - * Indicator whether custom password instructions feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2024 - */ - 'customInstructionsEnabled'?: boolean; - /** - * Indicator whether \"digit token\" feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2024 - */ - 'digitTokenEnabled'?: boolean; - /** - * The duration of \"digit token\" in minutes. The default value is 5. - * @type {number} - * @memberof PasswordOrgConfigV2024 - */ - 'digitTokenDurationMinutes'?: number; - /** - * The length of \"digit token\". The default value is 6. - * @type {number} - * @memberof PasswordOrgConfigV2024 - */ - 'digitTokenLength'?: number; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2024 - */ -export interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2024 { - /** - * Attribute\'s name - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2024 - */ - 'name'?: string; - /** - * Attribute\'s value - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesV2024 - */ -export interface PasswordPolicyHoldersDtoAttributesV2024 { - /** - * Attributes of PasswordPolicyHoldersDto - * @type {Array} - * @memberof PasswordPolicyHoldersDtoAttributesV2024 - */ - 'identityAttr'?: Array; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoInnerV2024 - */ -export interface PasswordPolicyHoldersDtoInnerV2024 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2024 - */ - 'policyId'?: string; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2024 - */ - 'policyName'?: string; - /** - * - * @type {PasswordPolicyHoldersDtoAttributesV2024} - * @memberof PasswordPolicyHoldersDtoInnerV2024 - */ - 'selectors'?: PasswordPolicyHoldersDtoAttributesV2024; -} -/** - * - * @export - * @interface PasswordPolicyV3DtoV2024 - */ -export interface PasswordPolicyV3DtoV2024 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'id'?: string; - /** - * Description for current password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'description'?: string | null; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'name'?: string; - /** - * Date the Password Policy was created. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'dateCreated'?: number; - /** - * Date the Password Policy was updated. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'lastUpdated'?: number | null; - /** - * The number of days before expiration remaninder. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'firstExpirationReminder'?: number; - /** - * The minimun length of account Id. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'accountIdMinWordLength'?: number; - /** - * The minimun length of account name. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'accountNameMinWordLength'?: number; - /** - * Maximum alpha. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minAlpha'?: number; - /** - * MinCharacterTypes. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minCharacterTypes'?: number; - /** - * Maximum length of the password. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'maxLength'?: number; - /** - * Minimum length of the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minLength'?: number; - /** - * Maximum repetition of the same character in the password. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'maxRepeatedChars'?: number; - /** - * Minimum amount of lower case character in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minLower'?: number; - /** - * Minimum amount of numeric characters in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minNumeric'?: number; - /** - * Minimum amount of special symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minSpecial'?: number; - /** - * Minimum amount of upper case symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'minUpper'?: number; - /** - * Number of days before current password expires. By default is equals to 90. - * @type {number} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'passwordExpiration'?: number; - /** - * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'defaultPolicy'?: boolean; - /** - * Defines whether this policy is enabled to expire or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'enablePasswdExpiration'?: boolean; - /** - * Defines whether this policy require strong Auth or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'requireStrongAuthn'?: boolean; - /** - * Defines whether this policy require strong Auth of network or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'requireStrongAuthOffNetwork'?: boolean; - /** - * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'requireStrongAuthUntrustedGeographies'?: boolean; - /** - * Defines whether this policy uses account attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'useAccountAttributes'?: boolean; - /** - * Defines whether this policy uses dictionary or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'useDictionary'?: boolean; - /** - * Defines whether this policy uses identity attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'useIdentityAttributes'?: boolean; - /** - * Defines whether this policy validate against account id or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'validateAgainstAccountId'?: boolean; - /** - * Defines whether this policy validate against account name or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'validateAgainstAccountName'?: boolean; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'created'?: string | null; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'modified'?: string | null; - /** - * List of sources IDs managed by this password policy. - * @type {Array} - * @memberof PasswordPolicyV3DtoV2024 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface PasswordStatusV2024 - */ -export interface PasswordStatusV2024 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordStatusV2024 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordStatusV2024 - */ - 'state'?: PasswordStatusV2024StateV2024; - /** - * The errors during the password change request - * @type {Array} - * @memberof PasswordStatusV2024 - */ - 'errors'?: Array; - /** - * List of source IDs in the password change request - * @type {Array} - * @memberof PasswordStatusV2024 - */ - 'sourceIds'?: Array; -} - -export const PasswordStatusV2024StateV2024 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordStatusV2024StateV2024 = typeof PasswordStatusV2024StateV2024[keyof typeof PasswordStatusV2024StateV2024]; - -/** - * - * @export - * @interface PasswordSyncGroupV2024 - */ -export interface PasswordSyncGroupV2024 { - /** - * ID of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2024 - */ - 'id'?: string; - /** - * Name of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2024 - */ - 'name'?: string; - /** - * ID of the password policy - * @type {string} - * @memberof PasswordSyncGroupV2024 - */ - 'passwordPolicyId'?: string; - /** - * List of password managed sources IDs - * @type {Array} - * @memberof PasswordSyncGroupV2024 - */ - 'sourceIds'?: Array; - /** - * The date and time this sync group was created - * @type {string} - * @memberof PasswordSyncGroupV2024 - */ - 'created'?: string | null; - /** - * The date and time this sync group was last modified - * @type {string} - * @memberof PasswordSyncGroupV2024 - */ - 'modified'?: string | null; -} -/** - * Personal access token owner\'s identity. - * @export - * @interface PatOwnerV2024 - */ -export interface PatOwnerV2024 { - /** - * Personal access token owner\'s DTO type. - * @type {string} - * @memberof PatOwnerV2024 - */ - 'type'?: PatOwnerV2024TypeV2024; - /** - * Personal access token owner\'s identity ID. - * @type {string} - * @memberof PatOwnerV2024 - */ - 'id'?: string; - /** - * Personal access token owner\'s human-readable display name. - * @type {string} - * @memberof PatOwnerV2024 - */ - 'name'?: string; -} - -export const PatOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type PatOwnerV2024TypeV2024 = typeof PatOwnerV2024TypeV2024[keyof typeof PatOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface PeerGroupMemberV2024 - */ -export interface PeerGroupMemberV2024 { - /** - * A unique identifier for the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2024 - */ - 'id'?: string; - /** - * The type of the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2024 - */ - 'type'?: string; - /** - * The ID of the peer group. - * @type {string} - * @memberof PeerGroupMemberV2024 - */ - 'peer_group_id'?: string; - /** - * Arbitrary key-value pairs, belonging to the peer group member. - * @type {{ [key: string]: object; }} - * @memberof PeerGroupMemberV2024 - */ - 'attributes'?: { [key: string]: object; }; -} -/** - * Enum represents action that is being processed on an approval. - * @export - * @enum {string} - */ - -export const PendingApprovalActionV2024 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Forwarded: 'FORWARDED' -} as const; - -export type PendingApprovalActionV2024 = typeof PendingApprovalActionV2024[keyof typeof PendingApprovalActionV2024]; - - -/** - * The maximum duration for which the access is permitted. - * @export - * @interface PendingApprovalMaxPermittedAccessDurationV2024 - */ -export interface PendingApprovalMaxPermittedAccessDurationV2024 { - /** - * The numeric value of the duration. - * @type {number} - * @memberof PendingApprovalMaxPermittedAccessDurationV2024 - */ - 'value'?: number; - /** - * The time unit for the duration. - * @type {string} - * @memberof PendingApprovalMaxPermittedAccessDurationV2024 - */ - 'timeUnit'?: PendingApprovalMaxPermittedAccessDurationV2024TimeUnitV2024; -} - -export const PendingApprovalMaxPermittedAccessDurationV2024TimeUnitV2024 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type PendingApprovalMaxPermittedAccessDurationV2024TimeUnitV2024 = typeof PendingApprovalMaxPermittedAccessDurationV2024TimeUnitV2024[keyof typeof PendingApprovalMaxPermittedAccessDurationV2024TimeUnitV2024]; - -/** - * Access item owner\'s identity. - * @export - * @interface PendingApprovalOwnerV2024 - */ -export interface PendingApprovalOwnerV2024 { - /** - * Access item owner\'s DTO type. - * @type {string} - * @memberof PendingApprovalOwnerV2024 - */ - 'type'?: PendingApprovalOwnerV2024TypeV2024; - /** - * Access item owner\'s identity ID. - * @type {string} - * @memberof PendingApprovalOwnerV2024 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof PendingApprovalOwnerV2024 - */ - 'name'?: string; -} - -export const PendingApprovalOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type PendingApprovalOwnerV2024TypeV2024 = typeof PendingApprovalOwnerV2024TypeV2024[keyof typeof PendingApprovalOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface PendingApprovalV2024 - */ -export interface PendingApprovalV2024 { - /** - * The approval id. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'id'?: string; - /** - * This is the access request id. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'accessRequestId'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof PendingApprovalV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * - * @type {AccessItemRequesterV2024} - * @memberof PendingApprovalV2024 - */ - 'requester'?: AccessItemRequesterV2024; - /** - * - * @type {AccessItemRequestedForV2024} - * @memberof PendingApprovalV2024 - */ - 'requestedFor'?: AccessItemRequestedForV2024; - /** - * - * @type {PendingApprovalOwnerV2024} - * @memberof PendingApprovalV2024 - */ - 'owner'?: PendingApprovalOwnerV2024; - /** - * - * @type {RequestableObjectReferenceV2024} - * @memberof PendingApprovalV2024 - */ - 'requestedObject'?: RequestableObjectReferenceV2024; - /** - * - * @type {CommentDtoV2024} - * @memberof PendingApprovalV2024 - */ - 'requesterComment'?: CommentDtoV2024; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof PendingApprovalV2024 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof PendingApprovalV2024 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof PendingApprovalV2024 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {PendingApprovalActionV2024} - * @memberof PendingApprovalV2024 - */ - 'actionInProcess'?: PendingApprovalActionV2024; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'removeDate'?: string; - /** - * If true, then the request is to change the remove date or sunset date. - * @type {boolean} - * @memberof PendingApprovalV2024 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'currentRemoveDate'?: string; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof PendingApprovalV2024 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2024} - * @memberof PendingApprovalV2024 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2024 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof PendingApprovalV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof PendingApprovalV2024 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof PendingApprovalV2024 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2024} - * @memberof PendingApprovalV2024 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2024 | null; -} - - -/** - * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - * @export - * @interface PermissionDtoV2024 - */ -export interface PermissionDtoV2024 { - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof PermissionDtoV2024 - */ - 'rights'?: Array; - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof PermissionDtoV2024 - */ - 'target'?: string; -} -/** - * Provides additional details about the pre-approval trigger for this request. - * @export - * @interface PreApprovalTriggerDetailsV2024 - */ -export interface PreApprovalTriggerDetailsV2024 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2024 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2024 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof PreApprovalTriggerDetailsV2024 - */ - 'decision'?: PreApprovalTriggerDetailsV2024DecisionV2024; -} - -export const PreApprovalTriggerDetailsV2024DecisionV2024 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type PreApprovalTriggerDetailsV2024DecisionV2024 = typeof PreApprovalTriggerDetailsV2024DecisionV2024[keyof typeof PreApprovalTriggerDetailsV2024DecisionV2024]; - -/** - * Maps an Identity\'s attribute key to a list of preferred notification mediums. - * @export - * @interface PreferencesDtoV2024 - */ -export interface PreferencesDtoV2024 { - /** - * The template notification key. - * @type {string} - * @memberof PreferencesDtoV2024 - */ - 'key'?: string; - /** - * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - * @type {Array} - * @memberof PreferencesDtoV2024 - */ - 'mediums'?: Array; - /** - * Modified date of preference - * @type {string} - * @memberof PreferencesDtoV2024 - */ - 'modified'?: string; -} -/** - * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint - * @export - * @interface PreviewDataSourceResponseV2024 - */ -export interface PreviewDataSourceResponseV2024 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof PreviewDataSourceResponseV2024 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ProcessIdentitiesRequestV2024 - */ -export interface ProcessIdentitiesRequestV2024 { - /** - * List of up to 250 identity IDs to process. - * @type {Array} - * @memberof ProcessIdentitiesRequestV2024 - */ - 'identityIds'?: Array; -} -/** - * - * @export - * @interface ProcessingDetailsV2024 - */ -export interface ProcessingDetailsV2024 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ProcessingDetailsV2024 - */ - 'date'?: string | null; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2024 - */ - 'stage'?: string; - /** - * - * @type {number} - * @memberof ProcessingDetailsV2024 - */ - 'retryCount'?: number; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2024 - */ - 'stackTrace'?: string; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2024 - */ - 'message'?: string; -} -/** - * - * @export - * @interface ProductV2024 - */ -export interface ProductV2024 { - /** - * Name of the Product - * @type {string} - * @memberof ProductV2024 - */ - 'productName'?: string; - /** - * URL of the Product - * @type {string} - * @memberof ProductV2024 - */ - 'url'?: string; - /** - * An identifier for a specific product-tenant combination - * @type {string} - * @memberof ProductV2024 - */ - 'productTenantId'?: string; - /** - * Product region - * @type {string} - * @memberof ProductV2024 - */ - 'productRegion'?: string; - /** - * Right needed for the Product - * @type {string} - * @memberof ProductV2024 - */ - 'productRight'?: string; - /** - * API URL of the Product - * @type {string} - * @memberof ProductV2024 - */ - 'apiUrl'?: string | null; - /** - * - * @type {Array} - * @memberof ProductV2024 - */ - 'licenses'?: Array; - /** - * Additional attributes for a product - * @type {{ [key: string]: any; }} - * @memberof ProductV2024 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Zone - * @type {string} - * @memberof ProductV2024 - */ - 'zone'?: string; - /** - * Status of the product - * @type {string} - * @memberof ProductV2024 - */ - 'status'?: string; - /** - * Status datetime - * @type {string} - * @memberof ProductV2024 - */ - 'statusDateTime'?: string; - /** - * If there\'s a tenant provisioning failure then reason will have the description of error - * @type {string} - * @memberof ProductV2024 - */ - 'reason'?: string; - /** - * Product could have additional notes added during tenant provisioning. - * @type {string} - * @memberof ProductV2024 - */ - 'notes'?: string; - /** - * Date when the product was created - * @type {string} - * @memberof ProductV2024 - */ - 'dateCreated'?: string | null; - /** - * Date when the product was last updated - * @type {string} - * @memberof ProductV2024 - */ - 'lastUpdated'?: string | null; - /** - * Type of org - * @type {string} - * @memberof ProductV2024 - */ - 'orgType'?: ProductV2024OrgTypeV2024 | null; -} - -export const ProductV2024OrgTypeV2024 = { - Development: 'development', - Staging: 'staging', - Production: 'production', - Test: 'test', - Partner: 'partner', - Training: 'training', - Demonstration: 'demonstration', - Sandbox: 'sandbox' -} as const; - -export type ProductV2024OrgTypeV2024 = typeof ProductV2024OrgTypeV2024[keyof typeof ProductV2024OrgTypeV2024]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024 - */ -export interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024 { - /** - * The name of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024 - */ - 'attributeName': string; - /** - * The value of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024 - */ - 'attributeValue'?: string | null; - /** - * The operation to handle the attribute. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024 - */ - 'operation': ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024OperationV2024; -} - -export const ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024OperationV2024 = { - Add: 'Add', - Set: 'Set', - Remove: 'Remove' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024OperationV2024 = typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024OperationV2024[keyof typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2024OperationV2024]; - -/** - * Reference to the source being provisioned against. - * @export - * @interface ProvisioningCompletedAccountRequestsInnerSourceV2024 - */ -export interface ProvisioningCompletedAccountRequestsInnerSourceV2024 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2024 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2024 - */ - 'type': ProvisioningCompletedAccountRequestsInnerSourceV2024TypeV2024; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2024 - */ - 'name': string; -} - -export const ProvisioningCompletedAccountRequestsInnerSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerSourceV2024TypeV2024 = typeof ProvisioningCompletedAccountRequestsInnerSourceV2024TypeV2024[keyof typeof ProvisioningCompletedAccountRequestsInnerSourceV2024TypeV2024]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerV2024 - */ -export interface ProvisioningCompletedAccountRequestsInnerV2024 { - /** - * - * @type {ProvisioningCompletedAccountRequestsInnerSourceV2024} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'source': ProvisioningCompletedAccountRequestsInnerSourceV2024; - /** - * The unique idenfier of the account being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'accountId'?: string; - /** - * The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'accountOperation': string; - /** - * The overall result of the provisioning transaction; this could be success, pending, failed, etc. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'provisioningResult': ProvisioningCompletedAccountRequestsInnerV2024ProvisioningResultV2024; - /** - * The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'provisioningTarget': string; - /** - * A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'ticketId'?: string | null; - /** - * A list of attributes as part of the provisioning transaction. - * @type {Array} - * @memberof ProvisioningCompletedAccountRequestsInnerV2024 - */ - 'attributeRequests'?: Array | null; -} - -export const ProvisioningCompletedAccountRequestsInnerV2024ProvisioningResultV2024 = { - Success: 'SUCCESS', - Pending: 'PENDING', - Failed: 'FAILED' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerV2024ProvisioningResultV2024 = typeof ProvisioningCompletedAccountRequestsInnerV2024ProvisioningResultV2024[keyof typeof ProvisioningCompletedAccountRequestsInnerV2024ProvisioningResultV2024]; - -/** - * Provisioning recpient. - * @export - * @interface ProvisioningCompletedRecipientV2024 - */ -export interface ProvisioningCompletedRecipientV2024 { - /** - * Provisioning recipient DTO type. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2024 - */ - 'type': ProvisioningCompletedRecipientV2024TypeV2024; - /** - * Provisioning recipient\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2024 - */ - 'id': string; - /** - * Provisioning recipient\'s display name. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2024 - */ - 'name': string; -} - -export const ProvisioningCompletedRecipientV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRecipientV2024TypeV2024 = typeof ProvisioningCompletedRecipientV2024TypeV2024[keyof typeof ProvisioningCompletedRecipientV2024TypeV2024]; - -/** - * Provisioning requester\'s identity. - * @export - * @interface ProvisioningCompletedRequesterV2024 - */ -export interface ProvisioningCompletedRequesterV2024 { - /** - * Provisioning requester\'s DTO type. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2024 - */ - 'type': ProvisioningCompletedRequesterV2024TypeV2024; - /** - * Provisioning requester\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2024 - */ - 'id': string; - /** - * Provisioning owner\'s human-readable display name. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2024 - */ - 'name': string; -} - -export const ProvisioningCompletedRequesterV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRequesterV2024TypeV2024 = typeof ProvisioningCompletedRequesterV2024TypeV2024[keyof typeof ProvisioningCompletedRequesterV2024TypeV2024]; - -/** - * - * @export - * @interface ProvisioningCompletedV2024 - */ -export interface ProvisioningCompletedV2024 { - /** - * The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. - * @type {string} - * @memberof ProvisioningCompletedV2024 - */ - 'trackingNumber': string; - /** - * One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. - * @type {string} - * @memberof ProvisioningCompletedV2024 - */ - 'sources': string; - /** - * Origin of where the provisioning request came from. - * @type {string} - * @memberof ProvisioningCompletedV2024 - */ - 'action'?: string | null; - /** - * A list of any accumulated error messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2024 - */ - 'errors'?: Array | null; - /** - * A list of any accumulated warning messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2024 - */ - 'warnings'?: Array | null; - /** - * - * @type {ProvisioningCompletedRecipientV2024} - * @memberof ProvisioningCompletedV2024 - */ - 'recipient': ProvisioningCompletedRecipientV2024; - /** - * - * @type {ProvisioningCompletedRequesterV2024} - * @memberof ProvisioningCompletedV2024 - */ - 'requester'?: ProvisioningCompletedRequesterV2024 | null; - /** - * A list of provisioning instructions to perform on an account-by-account basis. - * @type {Array} - * @memberof ProvisioningCompletedV2024 - */ - 'accountRequests': Array; -} -/** - * This is a reference to a plan initializer script. - * @export - * @interface ProvisioningConfigPlanInitializerScriptV2024 - */ -export interface ProvisioningConfigPlanInitializerScriptV2024 { - /** - * This is a Rule that allows provisioning instruction changes. - * @type {string} - * @memberof ProvisioningConfigPlanInitializerScriptV2024 - */ - 'source'?: string; -} -/** - * Specification of a Service Desk integration provisioning configuration. - * @export - * @interface ProvisioningConfigV2024 - */ -export interface ProvisioningConfigV2024 { - /** - * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - * @type {boolean} - * @memberof ProvisioningConfigV2024 - */ - 'universalManager'?: boolean; - /** - * References to sources for the Service Desk integration template. May only be specified if universalManager is false. - * @type {Array} - * @memberof ProvisioningConfigV2024 - */ - 'managedResourceRefs'?: Array; - /** - * - * @type {ProvisioningConfigPlanInitializerScriptV2024} - * @memberof ProvisioningConfigV2024 - */ - 'planInitializerScript'?: ProvisioningConfigPlanInitializerScriptV2024 | null; - /** - * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - * @type {boolean} - * @memberof ProvisioningConfigV2024 - */ - 'noProvisioningRequests'?: boolean; - /** - * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - * @type {number} - * @memberof ProvisioningConfigV2024 - */ - 'provisioningRequestExpiration'?: number; -} -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel1V2024 - */ -export interface ProvisioningCriteriaLevel1V2024 { - /** - * - * @type {ProvisioningCriteriaOperationV2024} - * @memberof ProvisioningCriteriaLevel1V2024 - */ - 'operation'?: ProvisioningCriteriaOperationV2024; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2024 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2024 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel1V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel2V2024 - */ -export interface ProvisioningCriteriaLevel2V2024 { - /** - * - * @type {ProvisioningCriteriaOperationV2024} - * @memberof ProvisioningCriteriaLevel2V2024 - */ - 'operation'?: ProvisioningCriteriaOperationV2024; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2024 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2024 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel2V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel3V2024 - */ -export interface ProvisioningCriteriaLevel3V2024 { - /** - * - * @type {ProvisioningCriteriaOperationV2024} - * @memberof ProvisioningCriteriaLevel3V2024 - */ - 'operation'?: ProvisioningCriteriaOperationV2024; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2024 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2024 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2024 - */ - 'children'?: string | null; -} - - -/** - * Supported operations on `ProvisioningCriteria`. - * @export - * @enum {string} - */ - -export const ProvisioningCriteriaOperationV2024 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - Has: 'HAS', - And: 'AND', - Or: 'OR' -} as const; - -export type ProvisioningCriteriaOperationV2024 = typeof ProvisioningCriteriaOperationV2024[keyof typeof ProvisioningCriteriaOperationV2024]; - - -/** - * Provides additional details about provisioning for this request. - * @export - * @interface ProvisioningDetailsV2024 - */ -export interface ProvisioningDetailsV2024 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof ProvisioningDetailsV2024 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * - * @export - * @interface ProvisioningPolicyDtoV2024 - */ -export interface ProvisioningPolicyDtoV2024 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyDtoV2024 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyDtoV2024 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2024} - * @memberof ProvisioningPolicyDtoV2024 - */ - 'usageType'?: UsageTypeV2024; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyDtoV2024 - */ - 'fields'?: Array; -} - - -/** - * - * @export - * @interface ProvisioningPolicyV2024 - */ -export interface ProvisioningPolicyV2024 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyV2024 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyV2024 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2024} - * @memberof ProvisioningPolicyV2024 - */ - 'usageType'?: UsageTypeV2024; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyV2024 - */ - 'fields'?: Array; -} - - -/** - * Provisioning state of an account activity item - * @export - * @enum {string} - */ - -export const ProvisioningStateV2024 = { - Pending: 'PENDING', - Finished: 'FINISHED', - Unverifiable: 'UNVERIFIABLE', - Commited: 'COMMITED', - Failed: 'FAILED', - Retry: 'RETRY' -} as const; - -export type ProvisioningStateV2024 = typeof ProvisioningStateV2024[keyof typeof ProvisioningStateV2024]; - - -/** - * Used to map an attribute key for an Identity to its display name. - * @export - * @interface PublicIdentityAttributeConfigV2024 - */ -export interface PublicIdentityAttributeConfigV2024 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributeConfigV2024 - */ - 'key'?: string; - /** - * The attribute display name - * @type {string} - * @memberof PublicIdentityAttributeConfigV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface PublicIdentityAttributesInnerV2024 - */ -export interface PublicIdentityAttributesInnerV2024 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributesInnerV2024 - */ - 'key'?: string; - /** - * Human-readable display name of the attribute - * @type {string} - * @memberof PublicIdentityAttributesInnerV2024 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof PublicIdentityAttributesInnerV2024 - */ - 'value'?: string | null; -} -/** - * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - * @export - * @interface PublicIdentityConfigV2024 - */ -export interface PublicIdentityConfigV2024 { - /** - * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - * @type {Array} - * @memberof PublicIdentityConfigV2024 - */ - 'attributes'?: Array; - /** - * When this configuration was last modified. - * @type {string} - * @memberof PublicIdentityConfigV2024 - */ - 'modified'?: string | null; - /** - * - * @type {IdentityReferenceV2024} - * @memberof PublicIdentityConfigV2024 - */ - 'modifiedBy'?: IdentityReferenceV2024 | null; -} -/** - * Details about a public identity - * @export - * @interface PublicIdentityV2024 - */ -export interface PublicIdentityV2024 { - /** - * Identity id - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'name'?: string; - /** - * Alternate unique identifier for the identity. - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'alias'?: string; - /** - * Email address of identity. - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'email'?: string | null; - /** - * The lifecycle status for the identity - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'status'?: string | null; - /** - * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. - * @type {string} - * @memberof PublicIdentityV2024 - */ - 'identityState'?: PublicIdentityV2024IdentityStateV2024 | null; - /** - * - * @type {IdentityReferenceV2024} - * @memberof PublicIdentityV2024 - */ - 'manager'?: IdentityReferenceV2024 | null; - /** - * The public identity attributes of the identity - * @type {Array} - * @memberof PublicIdentityV2024 - */ - 'attributes'?: Array; -} - -export const PublicIdentityV2024IdentityStateV2024 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type PublicIdentityV2024IdentityStateV2024 = typeof PublicIdentityV2024IdentityStateV2024[keyof typeof PublicIdentityV2024IdentityStateV2024]; - -/** - * @type PutClientLogConfigurationRequestV2024 - * @export - */ -export type PutClientLogConfigurationRequestV2024 = ClientLogConfigurationDurationMinutesV2024 | ClientLogConfigurationExpirationV2024; - -/** - * - * @export - * @interface PutConnectorCorrelationConfigRequestV2024 - */ -export interface PutConnectorCorrelationConfigRequestV2024 { - /** - * connector correlation config xml file - * @type {File} - * @memberof PutConnectorCorrelationConfigRequestV2024 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceConfigRequestV2024 - */ -export interface PutConnectorSourceConfigRequestV2024 { - /** - * connector source config xml file - * @type {File} - * @memberof PutConnectorSourceConfigRequestV2024 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceTemplateRequestV2024 - */ -export interface PutConnectorSourceTemplateRequestV2024 { - /** - * connector source template xml file - * @type {File} - * @memberof PutConnectorSourceTemplateRequestV2024 - */ - 'file': File; -} -/** - * - * @export - * @interface PutPasswordDictionaryRequestV2024 - */ -export interface PutPasswordDictionaryRequestV2024 { - /** - * - * @type {File} - * @memberof PutPasswordDictionaryRequestV2024 - */ - 'file'?: File; -} -/** - * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - * @export - * @interface QueryResultFilterV2024 - */ -export interface QueryResultFilterV2024 { - /** - * The list of field names to include in the result documents. - * @type {Array} - * @memberof QueryResultFilterV2024 - */ - 'includes'?: Array; - /** - * The list of field names to exclude from the result documents. - * @type {Array} - * @memberof QueryResultFilterV2024 - */ - 'excludes'?: Array; -} -/** - * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const QueryTypeV2024 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT', - Text: 'TEXT', - Typeahead: 'TYPEAHEAD' -} as const; - -export type QueryTypeV2024 = typeof QueryTypeV2024[keyof typeof QueryTypeV2024]; - - -/** - * Query parameters used to construct an Elasticsearch query object. - * @export - * @interface QueryV2024 - */ -export interface QueryV2024 { - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof QueryV2024 - */ - 'query'?: string; - /** - * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. - * @type {string} - * @memberof QueryV2024 - */ - 'fields'?: string; - /** - * The time zone to be applied to any range query related to dates. - * @type {string} - * @memberof QueryV2024 - */ - 'timeZone'?: string; - /** - * - * @type {InnerHitV2024} - * @memberof QueryV2024 - */ - 'innerHit'?: InnerHitV2024; -} -/** - * Configuration of maximum number of days and interval for checking Service Desk integration queue status. - * @export - * @interface QueuedCheckConfigDetailsV2024 - */ -export interface QueuedCheckConfigDetailsV2024 { - /** - * Interval in minutes between status checks - * @type {string} - * @memberof QueuedCheckConfigDetailsV2024 - */ - 'provisioningStatusCheckIntervalMinutes': string; - /** - * Maximum number of days to check - * @type {string} - * @memberof QueuedCheckConfigDetailsV2024 - */ - 'provisioningMaxStatusCheckDays': string; -} -/** - * - * @export - * @interface RandomAlphaNumericV2024 - */ -export interface RandomAlphaNumericV2024 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomAlphaNumericV2024 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomAlphaNumericV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomAlphaNumericV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RandomNumericV2024 - */ -export interface RandomNumericV2024 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomNumericV2024 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomNumericV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomNumericV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The range of values to be filtered. - * @export - * @interface RangeV2024 - */ -export interface RangeV2024 { - /** - * - * @type {BoundV2024} - * @memberof RangeV2024 - */ - 'lower'?: BoundV2024; - /** - * - * @type {BoundV2024} - * @memberof RangeV2024 - */ - 'upper'?: BoundV2024; -} -/** - * - * @export - * @interface ReassignReferenceV2024 - */ -export interface ReassignReferenceV2024 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2024 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2024 - */ - 'type': ReassignReferenceV2024TypeV2024; -} - -export const ReassignReferenceV2024TypeV2024 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignReferenceV2024TypeV2024 = typeof ReassignReferenceV2024TypeV2024[keyof typeof ReassignReferenceV2024TypeV2024]; - -/** - * - * @export - * @interface ReassignmentReferenceV2024 - */ -export interface ReassignmentReferenceV2024 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2024 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2024 - */ - 'type': ReassignmentReferenceV2024TypeV2024; -} - -export const ReassignmentReferenceV2024TypeV2024 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignmentReferenceV2024TypeV2024 = typeof ReassignmentReferenceV2024TypeV2024[keyof typeof ReassignmentReferenceV2024TypeV2024]; - -/** - * - * @export - * @interface ReassignmentTrailDTOV2024 - */ -export interface ReassignmentTrailDTOV2024 { - /** - * The ID of previous owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2024 - */ - 'previousOwner'?: string; - /** - * The ID of new owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2024 - */ - 'newOwner'?: string; - /** - * The type of reassignment. - * @type {string} - * @memberof ReassignmentTrailDTOV2024 - */ - 'reassignmentType'?: string; -} -/** - * Enum list containing types of Reassignment that can be found in the evaluate response. - * @export - * @enum {string} - */ - -export const ReassignmentTypeEnumV2024 = { - ManualReassignment: 'MANUAL_REASSIGNMENT,', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT,', - AutoEscalation: 'AUTO_ESCALATION,', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeEnumV2024 = typeof ReassignmentTypeEnumV2024[keyof typeof ReassignmentTypeEnumV2024]; - - -/** - * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - * @export - * @enum {string} - */ - -export const ReassignmentTypeV2024 = { - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', - AutoEscalation: 'AUTO_ESCALATION', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeV2024 = typeof ReassignmentTypeV2024[keyof typeof ReassignmentTypeV2024]; - - -/** - * - * @export - * @interface ReassignmentV2024 - */ -export interface ReassignmentV2024 { - /** - * - * @type {CertificationReferenceV2024} - * @memberof ReassignmentV2024 - */ - 'from'?: CertificationReferenceV2024; - /** - * The comment entered when the Certification was reassigned - * @type {string} - * @memberof ReassignmentV2024 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface RecommendationConfigDtoV2024 - */ -export interface RecommendationConfigDtoV2024 { - /** - * List of identity attributes to use for calculating certification recommendations - * @type {Array} - * @memberof RecommendationConfigDtoV2024 - */ - 'recommenderFeatures'?: Array; - /** - * The percent value that the recommendation calculation must surpass to produce a YES recommendation - * @type {number} - * @memberof RecommendationConfigDtoV2024 - */ - 'peerGroupPercentageThreshold'?: number; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2024 - */ - 'runAutoSelectOnce'?: boolean; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2024 - */ - 'onlyTuneThreshold'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestDtoV2024 - */ -export interface RecommendationRequestDtoV2024 { - /** - * - * @type {Array} - * @memberof RecommendationRequestDtoV2024 - */ - 'requests'?: Array; - /** - * Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. - * @type {boolean} - * @memberof RecommendationRequestDtoV2024 - */ - 'excludeInterpretations'?: boolean; - /** - * When set to true, the calling system uses the translated messages for the specified language - * @type {boolean} - * @memberof RecommendationRequestDtoV2024 - */ - 'includeTranslationMessages'?: boolean; - /** - * Returns the recommender calculations if set to true - * @type {boolean} - * @memberof RecommendationRequestDtoV2024 - */ - 'includeDebugInformation'?: boolean; - /** - * When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. - * @type {boolean} - * @memberof RecommendationRequestDtoV2024 - */ - 'prescribeMode'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestV2024 - */ -export interface RecommendationRequestV2024 { - /** - * The identity ID - * @type {string} - * @memberof RecommendationRequestV2024 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemRefV2024} - * @memberof RecommendationRequestV2024 - */ - 'item'?: AccessItemRefV2024; -} -/** - * - * @export - * @interface RecommendationResponseDtoV2024 - */ -export interface RecommendationResponseDtoV2024 { - /** - * - * @type {Array} - * @memberof RecommendationResponseDtoV2024 - */ - 'response'?: Array; -} -/** - * - * @export - * @interface RecommendationResponseV2024 - */ -export interface RecommendationResponseV2024 { - /** - * - * @type {RecommendationRequestV2024} - * @memberof RecommendationResponseV2024 - */ - 'request'?: RecommendationRequestV2024; - /** - * The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system - * @type {string} - * @memberof RecommendationResponseV2024 - */ - 'recommendation'?: RecommendationResponseV2024RecommendationV2024; - /** - * The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. - * @type {Array} - * @memberof RecommendationResponseV2024 - */ - 'interpretations'?: Array; - /** - * The list of translation messages, if they have been requested. - * @type {Array} - * @memberof RecommendationResponseV2024 - */ - 'translationMessages'?: Array; - /** - * - * @type {RecommenderCalculationsV2024} - * @memberof RecommendationResponseV2024 - */ - 'recommenderCalculations'?: RecommenderCalculationsV2024; -} - -export const RecommendationResponseV2024RecommendationV2024 = { - True: 'true', - False: 'false', - Maybe: 'MAYBE', - NotFound: 'NOT_FOUND' -} as const; - -export type RecommendationResponseV2024RecommendationV2024 = typeof RecommendationResponseV2024RecommendationV2024[keyof typeof RecommendationResponseV2024RecommendationV2024]; - -/** - * - * @export - * @interface RecommendationV2024 - */ -export interface RecommendationV2024 { - /** - * Recommended type of account. - * @type {string} - * @memberof RecommendationV2024 - */ - 'type': RecommendationV2024TypeV2024; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof RecommendationV2024 - */ - 'method': RecommendationV2024MethodV2024; -} - -export const RecommendationV2024TypeV2024 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type RecommendationV2024TypeV2024 = typeof RecommendationV2024TypeV2024[keyof typeof RecommendationV2024TypeV2024]; -export const RecommendationV2024MethodV2024 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type RecommendationV2024MethodV2024 = typeof RecommendationV2024MethodV2024[keyof typeof RecommendationV2024MethodV2024]; - -/** - * - * @export - * @interface RecommenderCalculationsIdentityAttributesValueV2024 - */ -export interface RecommenderCalculationsIdentityAttributesValueV2024 { - /** - * - * @type {string} - * @memberof RecommenderCalculationsIdentityAttributesValueV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RecommenderCalculationsV2024 - */ -export interface RecommenderCalculationsV2024 { - /** - * The ID of the identity - * @type {string} - * @memberof RecommenderCalculationsV2024 - */ - 'identityId'?: string; - /** - * The entitlement ID - * @type {string} - * @memberof RecommenderCalculationsV2024 - */ - 'entitlementId'?: string; - /** - * The actual recommendation - * @type {string} - * @memberof RecommenderCalculationsV2024 - */ - 'recommendation'?: string; - /** - * The overall weighted score - * @type {number} - * @memberof RecommenderCalculationsV2024 - */ - 'overallWeightedScore'?: number; - /** - * The weighted score of each individual feature - * @type {{ [key: string]: number; }} - * @memberof RecommenderCalculationsV2024 - */ - 'featureWeightedScores'?: { [key: string]: number; }; - /** - * The configured value against which the overallWeightedScore is compared - * @type {number} - * @memberof RecommenderCalculationsV2024 - */ - 'threshold'?: number; - /** - * The values for your configured features - * @type {{ [key: string]: RecommenderCalculationsIdentityAttributesValueV2024; }} - * @memberof RecommenderCalculationsV2024 - */ - 'identityAttributes'?: { [key: string]: RecommenderCalculationsIdentityAttributesValueV2024; }; - /** - * - * @type {FeatureValueDtoV2024} - * @memberof RecommenderCalculationsV2024 - */ - 'featureValues'?: FeatureValueDtoV2024; -} -/** - * - * @export - * @interface RefV2024 - */ -export interface RefV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof RefV2024 - */ - 'type'?: DtoTypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RefV2024 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface Reference1V2024 - */ -export interface Reference1V2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof Reference1V2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof Reference1V2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface ReferenceV2024 - */ -export interface ReferenceV2024 { - /** - * This ID specifies the name of the pre-existing transform which you want to use within your current transform - * @type {string} - * @memberof ReferenceV2024 - */ - 'id': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReferenceV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReferenceV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RemediationItemDetailsV2024 - */ -export interface RemediationItemDetailsV2024 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemDetailsV2024 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface RemediationItemsV2024 - */ -export interface RemediationItemsV2024 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemsV2024 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface ReplaceAllV2024 - */ -export interface ReplaceAllV2024 { - /** - * An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2024 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceAllV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReplaceV2024 - */ -export interface ReplaceV2024 { - /** - * This can be a string or a regex pattern in which you want to replace. - * @type {string} - * @memberof ReplaceV2024 - */ - 'regex': string; - /** - * This is the replacement string that should be substituded wherever the string or pattern is found. - * @type {string} - * @memberof ReplaceV2024 - */ - 'replacement': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReportConfigDTOV2024 - */ -export interface ReportConfigDTOV2024 { - /** - * Name of column in report - * @type {string} - * @memberof ReportConfigDTOV2024 - */ - 'columnName'?: string; - /** - * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. - * @type {boolean} - * @memberof ReportConfigDTOV2024 - */ - 'required'?: boolean; - /** - * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. - * @type {boolean} - * @memberof ReportConfigDTOV2024 - */ - 'included'?: boolean; - /** - * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. - * @type {number} - * @memberof ReportConfigDTOV2024 - */ - 'order'?: number; -} -/** - * The string-object map(dictionary) with the arguments needed for report processing. - * @export - * @interface ReportDetailsArgumentsV2024 - */ -export interface ReportDetailsArgumentsV2024 { - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2024 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof ReportDetailsArgumentsV2024 - */ - 'sourceName': string; - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof ReportDetailsArgumentsV2024 - */ - 'correlatedOnly': boolean; - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2024 - */ - 'authoritativeSource': string; - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportDetailsArgumentsV2024 - */ - 'selectedFormats'?: Array; - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof ReportDetailsArgumentsV2024 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof ReportDetailsArgumentsV2024 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof ReportDetailsArgumentsV2024 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof ReportDetailsArgumentsV2024 - */ - 'sort'?: Array; -} - -export const ReportDetailsArgumentsV2024SelectedFormatsV2024 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportDetailsArgumentsV2024SelectedFormatsV2024 = typeof ReportDetailsArgumentsV2024SelectedFormatsV2024[keyof typeof ReportDetailsArgumentsV2024SelectedFormatsV2024]; - -/** - * Details about report to be processed. - * @export - * @interface ReportDetailsV2024 - */ -export interface ReportDetailsV2024 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportDetailsV2024 - */ - 'reportType'?: ReportDetailsV2024ReportTypeV2024; - /** - * - * @type {ReportDetailsArgumentsV2024} - * @memberof ReportDetailsV2024 - */ - 'arguments'?: ReportDetailsArgumentsV2024; -} - -export const ReportDetailsV2024ReportTypeV2024 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportDetailsV2024ReportTypeV2024 = typeof ReportDetailsV2024ReportTypeV2024[keyof typeof ReportDetailsV2024ReportTypeV2024]; - -/** - * - * @export - * @interface ReportResultReferenceV2024 - */ -export interface ReportResultReferenceV2024 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof ReportResultReferenceV2024 - */ - 'type'?: ReportResultReferenceV2024TypeV2024; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof ReportResultReferenceV2024 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof ReportResultReferenceV2024 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof ReportResultReferenceV2024 - */ - 'status'?: ReportResultReferenceV2024StatusV2024; -} - -export const ReportResultReferenceV2024TypeV2024 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type ReportResultReferenceV2024TypeV2024 = typeof ReportResultReferenceV2024TypeV2024[keyof typeof ReportResultReferenceV2024TypeV2024]; -export const ReportResultReferenceV2024StatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type ReportResultReferenceV2024StatusV2024 = typeof ReportResultReferenceV2024StatusV2024[keyof typeof ReportResultReferenceV2024StatusV2024]; - -/** - * Details about report result or current state. - * @export - * @interface ReportResultsV2024 - */ -export interface ReportResultsV2024 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportResultsV2024 - */ - 'reportType'?: ReportResultsV2024ReportTypeV2024; - /** - * Name of the task definition which is started to process requesting report. Usually the same as report name - * @type {string} - * @memberof ReportResultsV2024 - */ - 'taskDefName'?: string; - /** - * Unique task definition identifier. - * @type {string} - * @memberof ReportResultsV2024 - */ - 'id'?: string; - /** - * Report processing start date - * @type {string} - * @memberof ReportResultsV2024 - */ - 'created'?: string; - /** - * Report current state or result status. - * @type {string} - * @memberof ReportResultsV2024 - */ - 'status'?: ReportResultsV2024StatusV2024; - /** - * Report processing time in ms. - * @type {number} - * @memberof ReportResultsV2024 - */ - 'duration'?: number; - /** - * Report size in rows. - * @type {number} - * @memberof ReportResultsV2024 - */ - 'rows'?: number; - /** - * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportResultsV2024 - */ - 'availableFormats'?: Array; -} - -export const ReportResultsV2024ReportTypeV2024 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportResultsV2024ReportTypeV2024 = typeof ReportResultsV2024ReportTypeV2024[keyof typeof ReportResultsV2024ReportTypeV2024]; -export const ReportResultsV2024StatusV2024 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Warning: 'WARNING', - Terminated: 'TERMINATED' -} as const; - -export type ReportResultsV2024StatusV2024 = typeof ReportResultsV2024StatusV2024[keyof typeof ReportResultsV2024StatusV2024]; -export const ReportResultsV2024AvailableFormatsV2024 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportResultsV2024AvailableFormatsV2024 = typeof ReportResultsV2024AvailableFormatsV2024[keyof typeof ReportResultsV2024AvailableFormatsV2024]; - -/** - * type of a Report - * @export - * @enum {string} - */ - -export const ReportTypeV2024 = { - CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', - CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', - CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', - CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' -} as const; - -export type ReportTypeV2024 = typeof ReportTypeV2024[keyof typeof ReportTypeV2024]; - - -/** - * - * @export - * @interface RequestOnBehalfOfConfigV2024 - */ -export interface RequestOnBehalfOfConfigV2024 { - /** - * If this is true, anyone can request access for anyone. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2024 - */ - 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; - /** - * If this is true, a manager can request access for his or her direct reports. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2024 - */ - 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; -} -/** - * - * @export - * @interface RequestabilityForRoleV2024 - */ -export interface RequestabilityForRoleV2024 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2024 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2024 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityForRoleV2024 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityForRoleV2024 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {AccessDurationV2024} - * @memberof RequestabilityForRoleV2024 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2024 | null; - /** - * List describing the steps in approving the request - * @type {Array} - * @memberof RequestabilityForRoleV2024 - */ - 'approvalSchemes'?: Array; - /** - * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. - * @type {string} - * @memberof RequestabilityForRoleV2024 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface RequestabilityV2024 - */ -export interface RequestabilityV2024 { - /** - * Indicates whether the requester of the containing object must provide comments justifying the request. - * @type {boolean} - * @memberof RequestabilityV2024 - */ - 'commentsRequired'?: boolean | null; - /** - * Indicates whether an approver must provide comments when denying the request. - * @type {boolean} - * @memberof RequestabilityV2024 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityV2024 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityV2024 - */ - 'requireEndDate'?: boolean | null; - /** - * - * @type {AccessDurationV2024} - * @memberof RequestabilityV2024 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2024 | null; - /** - * List describing the steps involved in approving the request. - * @type {Array} - * @memberof RequestabilityV2024 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RequestableObjectReferenceV2024 - */ -export interface RequestableObjectReferenceV2024 { - /** - * Id of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2024 - */ - 'id'?: string; - /** - * Name of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2024 - */ - 'name'?: string; - /** - * Description of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2024 - */ - 'description'?: string; - /** - * Type of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2024 - */ - 'type'?: RequestableObjectReferenceV2024TypeV2024; -} - -export const RequestableObjectReferenceV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectReferenceV2024TypeV2024 = typeof RequestableObjectReferenceV2024TypeV2024[keyof typeof RequestableObjectReferenceV2024TypeV2024]; - -/** - * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - * @export - * @enum {string} - */ - -export const RequestableObjectRequestStatusV2024 = { - Available: 'AVAILABLE', - Pending: 'PENDING', - Assigned: 'ASSIGNED' -} as const; - -export type RequestableObjectRequestStatusV2024 = typeof RequestableObjectRequestStatusV2024[keyof typeof RequestableObjectRequestStatusV2024]; - - -/** - * Currently supported requestable object types. - * @export - * @enum {string} - */ - -export const RequestableObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectTypeV2024 = typeof RequestableObjectTypeV2024[keyof typeof RequestableObjectTypeV2024]; - - -/** - * - * @export - * @interface RequestableObjectV2024 - */ -export interface RequestableObjectV2024 { - /** - * Id of the requestable object itself - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the requestable object - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'name'?: string; - /** - * The time when the requestable object was created - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'created'?: string; - /** - * The time when the requestable object was last modified - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'modified'?: string | null; - /** - * Description of the requestable object. - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'description'?: string | null; - /** - * - * @type {RequestableObjectTypeV2024} - * @memberof RequestableObjectV2024 - */ - 'type'?: RequestableObjectTypeV2024; - /** - * - * @type {RequestableObjectRequestStatusV2024 & object} - * @memberof RequestableObjectV2024 - */ - 'requestStatus'?: RequestableObjectRequestStatusV2024 & object; - /** - * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - * @type {string} - * @memberof RequestableObjectV2024 - */ - 'identityRequestId'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2024} - * @memberof RequestableObjectV2024 - */ - 'ownerRef'?: IdentityReferenceWithNameAndEmailV2024 | null; - /** - * Whether the requester must provide comments when requesting the object. - * @type {boolean} - * @memberof RequestableObjectV2024 - */ - 'requestCommentsRequired'?: boolean; -} - - -/** - * - * @export - * @interface RequestedAccountRefV2024 - */ -export interface RequestedAccountRefV2024 { - /** - * Display name of the account for the user - * @type {string} - * @memberof RequestedAccountRefV2024 - */ - 'name'?: string; - /** - * - * @type {DtoTypeV2024} - * @memberof RequestedAccountRefV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The uuid for the account - * @type {string} - * @memberof RequestedAccountRefV2024 - */ - 'accountUuid'?: string | null; - /** - * The native identity for the account - * @type {string} - * @memberof RequestedAccountRefV2024 - */ - 'accountId'?: string | null; - /** - * Display name of the source for the account - * @type {string} - * @memberof RequestedAccountRefV2024 - */ - 'sourceName'?: string; -} - - -/** - * - * @export - * @interface RequestedForDtoRefV2024 - */ -export interface RequestedForDtoRefV2024 { - /** - * The identity id for which the access is requested - * @type {string} - * @memberof RequestedForDtoRefV2024 - */ - 'identityId': string; - /** - * the details for the access items that are requested for the identity - * @type {Array} - * @memberof RequestedForDtoRefV2024 - */ - 'requestedItems': Array; -} -/** - * - * @export - * @interface RequestedItemAccountSelectionsV2024 - */ -export interface RequestedItemAccountSelectionsV2024 { - /** - * The description for this requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'description'?: string; - /** - * This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. - * @type {boolean} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'accountsSelectionBlocked'?: boolean; - /** - * If account selections are not allowed for an item, this field will denote the reason. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'accountsSelectionBlockedReason'?: string | null; - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'type'?: RequestedItemAccountSelectionsV2024TypeV2024; - /** - * The id of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'id'?: string; - /** - * The name of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'name'?: string; - /** - * The details for the sources and accounts for the requested item and identity combination - * @type {Array} - * @memberof RequestedItemAccountSelectionsV2024 - */ - 'sources'?: Array; -} - -export const RequestedItemAccountSelectionsV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemAccountSelectionsV2024TypeV2024 = typeof RequestedItemAccountSelectionsV2024TypeV2024[keyof typeof RequestedItemAccountSelectionsV2024TypeV2024]; - -/** - * - * @export - * @interface RequestedItemDetailsV2024 - */ -export interface RequestedItemDetailsV2024 { - /** - * The type of access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2024 - */ - 'type'?: RequestedItemDetailsV2024TypeV2024; - /** - * The id of the access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2024 - */ - 'id'?: string; -} - -export const RequestedItemDetailsV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - Role: 'ROLE' -} as const; - -export type RequestedItemDetailsV2024TypeV2024 = typeof RequestedItemDetailsV2024TypeV2024[keyof typeof RequestedItemDetailsV2024TypeV2024]; - -/** - * - * @export - * @interface RequestedItemDtoRefV2024 - */ -export interface RequestedItemDtoRefV2024 { - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2024 - */ - 'type': RequestedItemDtoRefV2024TypeV2024; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2024 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof RequestedItemDtoRefV2024 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof RequestedItemDtoRefV2024 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof RequestedItemDtoRefV2024 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof RequestedItemDtoRefV2024 - */ - 'removeDate'?: string; - /** - * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account - * @type {Array} - * @memberof RequestedItemDtoRefV2024 - */ - 'accountSelection'?: Array | null; -} - -export const RequestedItemDtoRefV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemDtoRefV2024TypeV2024 = typeof RequestedItemDtoRefV2024TypeV2024[keyof typeof RequestedItemDtoRefV2024TypeV2024]; - -/** - * - * @export - * @interface RequestedItemStatusCancelledRequestDetailsV2024 - */ -export interface RequestedItemStatusCancelledRequestDetailsV2024 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2024 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2024} - * @memberof RequestedItemStatusCancelledRequestDetailsV2024 - */ - 'owner'?: OwnerDtoV2024; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2024 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface RequestedItemStatusPreApprovalTriggerDetailsV2024 - */ -export interface RequestedItemStatusPreApprovalTriggerDetailsV2024 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2024 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2024 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2024 - */ - 'decision'?: RequestedItemStatusPreApprovalTriggerDetailsV2024DecisionV2024; -} - -export const RequestedItemStatusPreApprovalTriggerDetailsV2024DecisionV2024 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type RequestedItemStatusPreApprovalTriggerDetailsV2024DecisionV2024 = typeof RequestedItemStatusPreApprovalTriggerDetailsV2024DecisionV2024[keyof typeof RequestedItemStatusPreApprovalTriggerDetailsV2024DecisionV2024]; - -/** - * - * @export - * @interface RequestedItemStatusProvisioningDetailsV2024 - */ -export interface RequestedItemStatusProvisioningDetailsV2024 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof RequestedItemStatusProvisioningDetailsV2024 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. - * @export - * @enum {string} - */ - -export const RequestedItemStatusRequestStateV2024 = { - Executing: 'EXECUTING', - RequestCompleted: 'REQUEST_COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED', - ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', - Rejected: 'REJECTED', - ProvisioningFailed: 'PROVISIONING_FAILED', - NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusRequestStateV2024 = typeof RequestedItemStatusRequestStateV2024[keyof typeof RequestedItemStatusRequestStateV2024]; - - -/** - * Identity access was requested for. - * @export - * @interface RequestedItemStatusRequestedForV2024 - */ -export interface RequestedItemStatusRequestedForV2024 { - /** - * Type of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2024 - */ - 'type'?: RequestedItemStatusRequestedForV2024TypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2024 - */ - 'name'?: string; -} - -export const RequestedItemStatusRequestedForV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type RequestedItemStatusRequestedForV2024TypeV2024 = typeof RequestedItemStatusRequestedForV2024TypeV2024[keyof typeof RequestedItemStatusRequestedForV2024TypeV2024]; - -/** - * - * @export - * @interface RequestedItemStatusRequesterCommentV2024 - */ -export interface RequestedItemStatusRequesterCommentV2024 { - /** - * Comment content. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2024 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2024 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2024} - * @memberof RequestedItemStatusRequesterCommentV2024 - */ - 'author'?: CommentDtoAuthorV2024; -} -/** - * - * @export - * @interface RequestedItemStatusSodViolationContextV2024 - */ -export interface RequestedItemStatusSodViolationContextV2024 { - /** - * The status of SOD violation check - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2024 - */ - 'state'?: RequestedItemStatusSodViolationContextV2024StateV2024 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2024 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2024} - * @memberof RequestedItemStatusSodViolationContextV2024 - */ - 'violationCheckResult'?: SodViolationCheckResultV2024; -} - -export const RequestedItemStatusSodViolationContextV2024StateV2024 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusSodViolationContextV2024StateV2024 = typeof RequestedItemStatusSodViolationContextV2024StateV2024[keyof typeof RequestedItemStatusSodViolationContextV2024StateV2024]; - -/** - * - * @export - * @interface RequestedItemStatusV2024 - */ -export interface RequestedItemStatusV2024 { - /** - * The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'type'?: RequestedItemStatusV2024TypeV2024 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2024} - * @memberof RequestedItemStatusV2024 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2024; - /** - * List of list of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof RequestedItemStatusV2024 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2024} - * @memberof RequestedItemStatusV2024 - */ - 'state'?: RequestedItemStatusRequestStateV2024; - /** - * Approval details for each item. - * @type {Array} - * @memberof RequestedItemStatusV2024 - */ - 'approvalDetails'?: Array; - /** - * List of approval IDs associated with the request. - * @type {Array} - * @memberof RequestedItemStatusV2024 - */ - 'approvalIds'?: Array | null; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof RequestedItemStatusV2024 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2024} - * @memberof RequestedItemStatusV2024 - */ - 'requestType'?: AccessRequestTypeV2024 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2024} - * @memberof RequestedItemStatusV2024 - */ - 'requester'?: AccessItemRequesterV2024; - /** - * - * @type {RequestedItemStatusRequestedForV2024} - * @memberof RequestedItemStatusV2024 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2024; - /** - * - * @type {RequestedItemStatusRequesterCommentV2024} - * @memberof RequestedItemStatusV2024 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2024; - /** - * - * @type {RequestedItemStatusSodViolationContextV2024} - * @memberof RequestedItemStatusV2024 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2024; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2024} - * @memberof RequestedItemStatusV2024 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2024; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2024} - * @memberof RequestedItemStatusV2024 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2024; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof RequestedItemStatusV2024 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof RequestedItemStatusV2024 - */ - 'cancelable'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof RequestedItemStatusV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof RequestedItemStatusV2024 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof RequestedItemStatusV2024 - */ - 'privilegeLevel'?: string | null; -} - -export const RequestedItemStatusV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemStatusV2024TypeV2024 = typeof RequestedItemStatusV2024TypeV2024[keyof typeof RequestedItemStatusV2024TypeV2024]; - -/** - * Representation of the object which is returned from source connectors. - * @export - * @interface ResourceObjectV2024 - */ -export interface ResourceObjectV2024 { - /** - * Identifier of the specific instance where this object resides. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'instance'?: string; - /** - * Native identity of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'identity'?: string; - /** - * Universal unique identifier of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'uuid'?: string; - /** - * Native identity that the object has previously. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'previousIdentity'?: string; - /** - * Display name for this object. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof ResourceObjectV2024 - */ - 'objectType'?: string; - /** - * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - * @type {boolean} - * @memberof ResourceObjectV2024 - */ - 'incomplete'?: boolean; - /** - * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - * @type {boolean} - * @memberof ResourceObjectV2024 - */ - 'incremental'?: boolean; - /** - * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - * @type {boolean} - * @memberof ResourceObjectV2024 - */ - 'delete'?: boolean; - /** - * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - * @type {boolean} - * @memberof ResourceObjectV2024 - */ - 'remove'?: boolean; - /** - * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". - * @type {Array} - * @memberof ResourceObjectV2024 - */ - 'missing'?: Array; - /** - * Attributes of this ResourceObject. - * @type {object} - * @memberof ResourceObjectV2024 - */ - 'attributes'?: object; - /** - * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - * @type {boolean} - * @memberof ResourceObjectV2024 - */ - 'finalUpdate'?: boolean; -} -/** - * Request model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsRequestV2024 - */ -export interface ResourceObjectsRequestV2024 { - /** - * The type of resource objects to iterate over. - * @type {string} - * @memberof ResourceObjectsRequestV2024 - */ - 'objectType'?: string; - /** - * The maximum number of resource objects to iterate over and return. - * @type {number} - * @memberof ResourceObjectsRequestV2024 - */ - 'maxCount'?: number; -} -/** - * Response model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsResponseV2024 - */ -export interface ResourceObjectsResponseV2024 { - /** - * ID of the source - * @type {string} - * @memberof ResourceObjectsResponseV2024 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof ResourceObjectsResponseV2024 - */ - 'name'?: string; - /** - * The number of objects that were fetched by the connector. - * @type {number} - * @memberof ResourceObjectsResponseV2024 - */ - 'objectCount'?: number; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof ResourceObjectsResponseV2024 - */ - 'elapsedMillis'?: number; - /** - * Fetched objects from the source connector. - * @type {Array} - * @memberof ResourceObjectsResponseV2024 - */ - 'resourceObjects'?: Array; -} -/** - * - * @export - * @interface ResultV2024 - */ -export interface ResultV2024 { - /** - * Request result status - * @type {string} - * @memberof ResultV2024 - */ - 'status'?: string; -} -/** - * - * @export - * @interface ReviewDecisionV2024 - */ -export interface ReviewDecisionV2024 { - /** - * The id of the review decision - * @type {string} - * @memberof ReviewDecisionV2024 - */ - 'id': string; - /** - * - * @type {CertificationDecisionV2024} - * @memberof ReviewDecisionV2024 - */ - 'decision': CertificationDecisionV2024; - /** - * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. - * @type {string} - * @memberof ReviewDecisionV2024 - */ - 'proposedEndDate'?: string; - /** - * Indicates whether decision should be marked as part of a larger bulk decision - * @type {boolean} - * @memberof ReviewDecisionV2024 - */ - 'bulk': boolean; - /** - * - * @type {ReviewRecommendationV2024} - * @memberof ReviewDecisionV2024 - */ - 'recommendation'?: ReviewRecommendationV2024; - /** - * Comments recorded when the decision was made - * @type {string} - * @memberof ReviewDecisionV2024 - */ - 'comments'?: string; -} - - -/** - * - * @export - * @interface ReviewReassignV2024 - */ -export interface ReviewReassignV2024 { - /** - * - * @type {Array} - * @memberof ReviewReassignV2024 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof ReviewReassignV2024 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof ReviewReassignV2024 - */ - 'reason': string; -} -/** - * - * @export - * @interface ReviewRecommendationV2024 - */ -export interface ReviewRecommendationV2024 { - /** - * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - * @type {string} - * @memberof ReviewRecommendationV2024 - */ - 'recommendation'?: string | null; - /** - * A list of reasons for the recommendation. - * @type {Array} - * @memberof ReviewRecommendationV2024 - */ - 'reasons'?: Array; - /** - * The time at which the recommendation was recorded. - * @type {string} - * @memberof ReviewRecommendationV2024 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface ReviewableAccessProfileV2024 - */ -export interface ReviewableAccessProfileV2024 { - /** - * The id of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableAccessProfileV2024 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableAccessProfileV2024 - */ - 'cloudGoverned'?: boolean; - /** - * The date at which a user\'s access expires - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'endDate'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2024} - * @memberof ReviewableAccessProfileV2024 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2024 | null; - /** - * A list of entitlements associated with this Access Profile - * @type {Array} - * @memberof ReviewableAccessProfileV2024 - */ - 'entitlements'?: Array; - /** - * Date the Access Profile was created. - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof ReviewableAccessProfileV2024 - */ - 'modified'?: string; -} -/** - * Information about the machine account owner - * @export - * @interface ReviewableEntitlementAccountOwnerV2024 - */ -export interface ReviewableEntitlementAccountOwnerV2024 { - /** - * The id associated with the machine account owner - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2024 - */ - 'id'?: string | null; - /** - * An enumeration of the types of Owner supported within the IdentityNow infrastructure. - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2024 - */ - 'type'?: ReviewableEntitlementAccountOwnerV2024TypeV2024; - /** - * The machine account owner\'s display name - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2024 - */ - 'displayName'?: string | null; -} - -export const ReviewableEntitlementAccountOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ReviewableEntitlementAccountOwnerV2024TypeV2024 = typeof ReviewableEntitlementAccountOwnerV2024TypeV2024[keyof typeof ReviewableEntitlementAccountOwnerV2024TypeV2024]; - -/** - * Information about the status of the entitlement - * @export - * @interface ReviewableEntitlementAccountV2024 - */ -export interface ReviewableEntitlementAccountV2024 { - /** - * The native identity for this account - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'nativeIdentity'?: string; - /** - * Indicates whether this account is currently disabled - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'disabled'?: boolean; - /** - * Indicates whether this account is currently locked - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'locked'?: boolean; - /** - * - * @type {DtoTypeV2024} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The id associated with the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'id'?: string | null; - /** - * The account name - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'name'?: string | null; - /** - * When the account was created - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'created'?: string | null; - /** - * When the account was last modified - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityInsightsV2024} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'activityInsights'?: ActivityInsightsV2024; - /** - * Information about the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'description'?: string | null; - /** - * The id associated with the machine Account Governance Group - * @type {string} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'governanceGroupId'?: string | null; - /** - * - * @type {ReviewableEntitlementAccountOwnerV2024} - * @memberof ReviewableEntitlementAccountV2024 - */ - 'owner'?: ReviewableEntitlementAccountOwnerV2024 | null; -} - - -/** - * - * @export - * @interface ReviewableEntitlementV2024 - */ -export interface ReviewableEntitlementV2024 { - /** - * The id for the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'id'?: string; - /** - * The name of the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'name'?: string; - /** - * Information about the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'description'?: string | null; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2024} - * @memberof ReviewableEntitlementV2024 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2024 | null; - /** - * The name of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'attributeName'?: string; - /** - * The value of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'attributeValue'?: string; - /** - * The schema object type on the source used to represent the entitlement and its attributes - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * The name of the source for which this entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'sourceName'?: string; - /** - * The type of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'sourceType'?: string; - /** - * The ID of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2024 - */ - 'sourceId'?: string; - /** - * Indicates if the entitlement has permissions - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'hasPermissions'?: boolean; - /** - * Indicates if the entitlement is a representation of an account permission - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'isPermission'?: boolean; - /** - * Indicates whether the entitlement can be revoked - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'revocable'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement has DAS data - * @type {boolean} - * @memberof ReviewableEntitlementV2024 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {DataAccessV2024} - * @memberof ReviewableEntitlementV2024 - */ - 'dataAccess'?: DataAccessV2024 | null; - /** - * - * @type {ReviewableEntitlementAccountV2024} - * @memberof ReviewableEntitlementV2024 - */ - 'account'?: ReviewableEntitlementAccountV2024 | null; -} -/** - * - * @export - * @interface ReviewableRoleV2024 - */ -export interface ReviewableRoleV2024 { - /** - * The id for the Role - * @type {string} - * @memberof ReviewableRoleV2024 - */ - 'id'?: string; - /** - * The name of the Role - * @type {string} - * @memberof ReviewableRoleV2024 - */ - 'name'?: string; - /** - * Information about the Role - * @type {string} - * @memberof ReviewableRoleV2024 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableRoleV2024 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2024} - * @memberof ReviewableRoleV2024 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2024 | null; - /** - * Indicates whether the Role can be revoked or requested - * @type {boolean} - * @memberof ReviewableRoleV2024 - */ - 'revocable'?: boolean; - /** - * The date when a user\'s access expires. - * @type {string} - * @memberof ReviewableRoleV2024 - */ - 'endDate'?: string; - /** - * The list of Access Profiles associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2024 - */ - 'accessProfiles'?: Array; - /** - * The list of entitlements associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2024 - */ - 'entitlements'?: Array; -} -/** - * - * @export - * @interface ReviewerV2024 - */ -export interface ReviewerV2024 { - /** - * The id of the reviewer. - * @type {string} - * @memberof ReviewerV2024 - */ - 'id'?: string; - /** - * The name of the reviewer. - * @type {string} - * @memberof ReviewerV2024 - */ - 'name'?: string; - /** - * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. - * @type {string} - * @memberof ReviewerV2024 - */ - 'email'?: string | null; - /** - * The type of the reviewing identity. - * @type {string} - * @memberof ReviewerV2024 - */ - 'type'?: ReviewerV2024TypeV2024; - /** - * The created date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2024 - */ - 'created'?: string | null; - /** - * The modified date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2024 - */ - 'modified'?: string | null; -} - -export const ReviewerV2024TypeV2024 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ReviewerV2024TypeV2024 = typeof ReviewerV2024TypeV2024[keyof typeof ReviewerV2024TypeV2024]; - -/** - * - * @export - * @interface RevocabilityForRoleV2024 - */ -export interface RevocabilityForRoleV2024 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2024 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2024 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * List describing the steps in approving the revocation request - * @type {Array} - * @memberof RevocabilityForRoleV2024 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface RevocabilityV2024 - */ -export interface RevocabilityV2024 { - /** - * List describing the steps involved in approving the revocation request. - * @type {Array} - * @memberof RevocabilityV2024 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RightPadV2024 - */ -export interface RightPadV2024 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof RightPadV2024 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof RightPadV2024 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RightPadV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RightPadV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The identity that performed the assignment. This could be blank or system - * @export - * @interface RoleAssignmentDtoAssignerV2024 - */ -export interface RoleAssignmentDtoAssignerV2024 { - /** - * Object type - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2024 - */ - 'type'?: RoleAssignmentDtoAssignerV2024TypeV2024; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2024 - */ - 'name'?: string | null; -} - -export const RoleAssignmentDtoAssignerV2024TypeV2024 = { - Identity: 'IDENTITY', - Unknown: 'UNKNOWN' -} as const; - -export type RoleAssignmentDtoAssignerV2024TypeV2024 = typeof RoleAssignmentDtoAssignerV2024TypeV2024[keyof typeof RoleAssignmentDtoAssignerV2024TypeV2024]; - -/** - * - * @export - * @interface RoleAssignmentDtoAssignmentContextV2024 - */ -export interface RoleAssignmentDtoAssignmentContextV2024 { - /** - * - * @type {AccessRequestContextV2024} - * @memberof RoleAssignmentDtoAssignmentContextV2024 - */ - 'requested'?: AccessRequestContextV2024; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoAssignmentContextV2024 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof RoleAssignmentDtoAssignmentContextV2024 - */ - 'computedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentDtoV2024 - */ -export interface RoleAssignmentDtoV2024 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof RoleAssignmentDtoV2024 - */ - 'role'?: BaseReferenceDtoV2024; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2024} - * @memberof RoleAssignmentDtoV2024 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2024; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof RoleAssignmentDtoV2024 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2024} - * @memberof RoleAssignmentDtoV2024 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2024; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoV2024 - */ - 'accountTargets'?: Array; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'removeDate'?: string | null; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentDtoV2024 - */ - 'addedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentRefV2024 - */ -export interface RoleAssignmentRefV2024 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentRefV2024 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof RoleAssignmentRefV2024 - */ - 'role'?: BaseReferenceDtoV2024; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentRefV2024 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentRefV2024 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentRefV2024 - */ - 'removeDate'?: string | null; -} -/** - * Type which indicates how a particular Identity obtained a particular Role - * @export - * @enum {string} - */ - -export const RoleAssignmentSourceTypeV2024 = { - AccessRequest: 'ACCESS_REQUEST', - RoleMembership: 'ROLE_MEMBERSHIP' -} as const; - -export type RoleAssignmentSourceTypeV2024 = typeof RoleAssignmentSourceTypeV2024[keyof typeof RoleAssignmentSourceTypeV2024]; - - -/** - * - * @export - * @interface RoleBulkDeleteRequestV2024 - */ -export interface RoleBulkDeleteRequestV2024 { - /** - * List of IDs of Roles to be deleted. - * @type {Array} - * @memberof RoleBulkDeleteRequestV2024 - */ - 'roleIds': Array; -} -/** - * - * @export - * @interface RoleBulkUpdateResponseV2024 - */ -export interface RoleBulkUpdateResponseV2024 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleBulkUpdateResponseV2024 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleBulkUpdateResponseV2024 - */ - 'type'?: string; - /** - * The status of the bulk update request, could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleBulkUpdateResponseV2024 - */ - 'status'?: RoleBulkUpdateResponseV2024StatusV2024; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleBulkUpdateResponseV2024 - */ - 'created'?: string; -} - -export const RoleBulkUpdateResponseV2024StatusV2024 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PreProcessCompleted: 'PRE_PROCESS_COMPLETED', - PostProcess: 'POST_PROCESS', - Completed: 'COMPLETED', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleBulkUpdateResponseV2024StatusV2024 = typeof RoleBulkUpdateResponseV2024StatusV2024[keyof typeof RoleBulkUpdateResponseV2024StatusV2024]; - -/** - * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - * @export - * @enum {string} - */ - -export const RoleCriteriaKeyTypeV2024 = { - Identity: 'IDENTITY', - Account: 'ACCOUNT', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RoleCriteriaKeyTypeV2024 = typeof RoleCriteriaKeyTypeV2024[keyof typeof RoleCriteriaKeyTypeV2024]; - - -/** - * Refers to a specific Identity attribute, Account attribute, or Entitlement used in Role membership criteria - * @export - * @interface RoleCriteriaKeyV2024 - */ -export interface RoleCriteriaKeyV2024 { - /** - * - * @type {RoleCriteriaKeyTypeV2024} - * @memberof RoleCriteriaKeyV2024 - */ - 'type': RoleCriteriaKeyTypeV2024; - /** - * The name of the attribute or entitlement to which the associated criteria applies. - * @type {string} - * @memberof RoleCriteriaKeyV2024 - */ - 'property': string; - /** - * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - * @type {string} - * @memberof RoleCriteriaKeyV2024 - */ - 'sourceId'?: string | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel1V2024 - */ -export interface RoleCriteriaLevel1V2024 { - /** - * - * @type {RoleCriteriaOperationV2024} - * @memberof RoleCriteriaLevel1V2024 - */ - 'operation'?: RoleCriteriaOperationV2024; - /** - * - * @type {RoleCriteriaKeyV2024} - * @memberof RoleCriteriaLevel1V2024 - */ - 'key'?: RoleCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel1V2024 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel1V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel2V2024 - */ -export interface RoleCriteriaLevel2V2024 { - /** - * - * @type {RoleCriteriaOperationV2024} - * @memberof RoleCriteriaLevel2V2024 - */ - 'operation'?: RoleCriteriaOperationV2024; - /** - * - * @type {RoleCriteriaKeyV2024} - * @memberof RoleCriteriaLevel2V2024 - */ - 'key'?: RoleCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel2V2024 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel2V2024 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel3V2024 - */ -export interface RoleCriteriaLevel3V2024 { - /** - * - * @type {RoleCriteriaOperationV2024} - * @memberof RoleCriteriaLevel3V2024 - */ - 'operation'?: RoleCriteriaOperationV2024; - /** - * - * @type {RoleCriteriaKeyV2024} - * @memberof RoleCriteriaLevel3V2024 - */ - 'key'?: RoleCriteriaKeyV2024 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel3V2024 - */ - 'stringValue'?: string | null; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const RoleCriteriaOperationV2024 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - GreaterThan: 'GREATER_THAN', - LessThan: 'LESS_THAN', - GreaterThanEquals: 'GREATER_THAN_EQUALS', - LessThanEquals: 'LESS_THAN_EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type RoleCriteriaOperationV2024 = typeof RoleCriteriaOperationV2024[keyof typeof RoleCriteriaOperationV2024]; - - -/** - * - * @export - * @interface RoleDocumentAllOfDimensionSchemaAttributesV2024 - */ -export interface RoleDocumentAllOfDimensionSchemaAttributesV2024 { - /** - * - * @type {boolean} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2024 - */ - 'derived'?: boolean; - /** - * Displayname of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2024 - */ - 'displayName'?: string; - /** - * Name of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfDimensionsV2024 - */ -export interface RoleDocumentAllOfDimensionsV2024 { - /** - * Unique ID of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2024 - */ - 'id'?: string; - /** - * Name of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2024 - */ - 'name'?: string; - /** - * Description of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2024 - */ - 'description'?: string | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2024 - */ - 'entitlements'?: Array | null; - /** - * Access profiles included in the dimension. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2024 - */ - 'accessProfiles'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlements1V2024 - */ -export interface RoleDocumentAllOfEntitlements1V2024 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2024 - */ - 'hash'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlementsV2024 - */ -export interface RoleDocumentAllOfEntitlementsV2024 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2024 - */ - 'hash'?: string; -} -/** - * Role - * @export - * @interface RoleDocumentV2024 - */ -export interface RoleDocumentV2024 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentV2024 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2024} - * @memberof RoleDocumentV2024 - */ - 'owner'?: BaseAccessOwnerV2024; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentV2024 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentV2024 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentV2024 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentV2024 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentV2024 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentV2024 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentV2024 - */ - 'dimensions'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentsV2024 - */ -export interface RoleDocumentsV2024 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentsV2024 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentsV2024 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentsV2024 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2024} - * @memberof RoleDocumentsV2024 - */ - 'owner'?: BaseAccessOwnerV2024; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentsV2024 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentsV2024 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentsV2024 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentsV2024 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentsV2024 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentsV2024 - */ - 'dimensions'?: Array | null; - /** - * Name of the pod. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2024} - * @memberof RoleDocumentsV2024 - */ - '_type'?: DocumentTypeV2024; - /** - * - * @type {DocumentTypeV2024} - * @memberof RoleDocumentsV2024 - */ - 'type'?: DocumentTypeV2024; - /** - * Version number. - * @type {string} - * @memberof RoleDocumentsV2024 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface RoleGetAllBulkUpdateResponseV2024 - */ -export interface RoleGetAllBulkUpdateResponseV2024 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2024 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2024 - */ - 'type'?: string; - /** - * The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2024 - */ - 'status'?: RoleGetAllBulkUpdateResponseV2024StatusV2024; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2024 - */ - 'created'?: string; -} - -export const RoleGetAllBulkUpdateResponseV2024StatusV2024 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PostProcess: 'POST_PROCESS', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleGetAllBulkUpdateResponseV2024StatusV2024 = typeof RoleGetAllBulkUpdateResponseV2024StatusV2024[keyof typeof RoleGetAllBulkUpdateResponseV2024StatusV2024]; - -/** - * A subset of the fields of an Identity which is a member of a Role. - * @export - * @interface RoleIdentityV2024 - */ -export interface RoleIdentityV2024 { - /** - * The ID of the Identity - * @type {string} - * @memberof RoleIdentityV2024 - */ - 'id'?: string; - /** - * The alias / username of the Identity - * @type {string} - * @memberof RoleIdentityV2024 - */ - 'aliasName'?: string; - /** - * The human-readable display name of the Identity - * @type {string} - * @memberof RoleIdentityV2024 - */ - 'name'?: string; - /** - * Email address of the Identity - * @type {string} - * @memberof RoleIdentityV2024 - */ - 'email'?: string; - /** - * - * @type {RoleAssignmentSourceTypeV2024} - * @memberof RoleIdentityV2024 - */ - 'roleAssignmentSource'?: RoleAssignmentSourceTypeV2024; -} - - -/** - * - * @export - * @interface RoleInsightV2024 - */ -export interface RoleInsightV2024 { - /** - * Insight id - * @type {string} - * @memberof RoleInsightV2024 - */ - 'id'?: string; - /** - * Total number of updates for this role - * @type {number} - * @memberof RoleInsightV2024 - */ - 'numberOfUpdates'?: number; - /** - * The date-time insights were last created for this role. - * @type {string} - * @memberof RoleInsightV2024 - */ - 'createdDate'?: string; - /** - * The date-time insights were last modified for this role. - * @type {string} - * @memberof RoleInsightV2024 - */ - 'modifiedDate'?: string | null; - /** - * - * @type {RoleInsightsRoleV2024} - * @memberof RoleInsightV2024 - */ - 'role'?: RoleInsightsRoleV2024; - /** - * - * @type {RoleInsightsInsightV2024} - * @memberof RoleInsightV2024 - */ - 'insight'?: RoleInsightsInsightV2024; -} -/** - * - * @export - * @interface RoleInsightsEntitlementChangesV2024 - */ -export interface RoleInsightsEntitlementChangesV2024 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'description'?: string | null; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'value'?: string; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'source'?: string; - /** - * - * @type {RoleInsightsInsightV2024} - * @memberof RoleInsightsEntitlementChangesV2024 - */ - 'insight'?: RoleInsightsInsightV2024; -} -/** - * - * @export - * @interface RoleInsightsEntitlementV2024 - */ -export interface RoleInsightsEntitlementV2024 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'description'?: string | null; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'source'?: string; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RoleInsightsIdentitiesV2024 - */ -export interface RoleInsightsIdentitiesV2024 { - /** - * Id for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2024 - */ - 'id'?: string; - /** - * Name for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2024 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string; }} - * @memberof RoleInsightsIdentitiesV2024 - */ - 'attributes'?: { [key: string]: string; }; -} -/** - * - * @export - * @interface RoleInsightsInsightV2024 - */ -export interface RoleInsightsInsightV2024 { - /** - * The number of identities in this role with the entitlement. - * @type {string} - * @memberof RoleInsightsInsightV2024 - */ - 'type'?: string; - /** - * The number of identities in this role with the entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2024 - */ - 'identitiesWithAccess'?: number; - /** - * The number of identities in this role that do not have the specified entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2024 - */ - 'identitiesImpacted'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsInsightV2024 - */ - 'totalNumberOfIdentities'?: number; - /** - * - * @type {string} - * @memberof RoleInsightsInsightV2024 - */ - 'impactedIdentityNames'?: string | null; -} -/** - * - * @export - * @interface RoleInsightsResponseV2024 - */ -export interface RoleInsightsResponseV2024 { - /** - * Request Id for a role insight generation request - * @type {string} - * @memberof RoleInsightsResponseV2024 - */ - 'id'?: string; - /** - * The date-time role insights request was created. - * @type {string} - * @memberof RoleInsightsResponseV2024 - */ - 'createdDate'?: string; - /** - * The date-time role insights request was completed. - * @type {string} - * @memberof RoleInsightsResponseV2024 - */ - 'lastGenerated'?: string; - /** - * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. - * @type {number} - * @memberof RoleInsightsResponseV2024 - */ - 'numberOfUpdates'?: number; - /** - * The role IDs that are in this request. - * @type {Array} - * @memberof RoleInsightsResponseV2024 - */ - 'roleIds'?: Array; - /** - * Request status - * @type {string} - * @memberof RoleInsightsResponseV2024 - */ - 'status'?: RoleInsightsResponseV2024StatusV2024; -} - -export const RoleInsightsResponseV2024StatusV2024 = { - Created: 'CREATED', - InProgress: 'IN PROGRESS', - Completed: 'COMPLETED', - Failed: 'FAILED' -} as const; - -export type RoleInsightsResponseV2024StatusV2024 = typeof RoleInsightsResponseV2024StatusV2024[keyof typeof RoleInsightsResponseV2024StatusV2024]; - -/** - * - * @export - * @interface RoleInsightsRoleV2024 - */ -export interface RoleInsightsRoleV2024 { - /** - * Role name - * @type {string} - * @memberof RoleInsightsRoleV2024 - */ - 'name'?: string; - /** - * Role id - * @type {string} - * @memberof RoleInsightsRoleV2024 - */ - 'id'?: string; - /** - * Role description - * @type {string} - * @memberof RoleInsightsRoleV2024 - */ - 'description'?: string; - /** - * Role owner name - * @type {string} - * @memberof RoleInsightsRoleV2024 - */ - 'ownerName'?: string; - /** - * Role owner id - * @type {string} - * @memberof RoleInsightsRoleV2024 - */ - 'ownerId'?: string; -} -/** - * - * @export - * @interface RoleInsightsSummaryV2024 - */ -export interface RoleInsightsSummaryV2024 { - /** - * Total number of roles with updates - * @type {number} - * @memberof RoleInsightsSummaryV2024 - */ - 'numberOfUpdates'?: number; - /** - * The date-time role insights were last found. - * @type {string} - * @memberof RoleInsightsSummaryV2024 - */ - 'lastGenerated'?: string; - /** - * The number of entitlements included in roles (vs free radicals). - * @type {number} - * @memberof RoleInsightsSummaryV2024 - */ - 'entitlementsIncludedInRoles'?: number; - /** - * The total number of entitlements. - * @type {number} - * @memberof RoleInsightsSummaryV2024 - */ - 'totalNumberOfEntitlements'?: number; - /** - * The number of identities in roles vs. identities with just entitlements and not in roles. - * @type {number} - * @memberof RoleInsightsSummaryV2024 - */ - 'identitiesWithAccessViaRoles'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsSummaryV2024 - */ - 'totalNumberOfIdentities'?: number; -} -/** - * - * @export - * @interface RoleListFilterDTOAmmKeyValuesInnerV2024 - */ -export interface RoleListFilterDTOAmmKeyValuesInnerV2024 { - /** - * attribute key of a metadata. - * @type {string} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2024 - */ - 'attribute'?: string; - /** - * A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. - * @type {Array} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2024 - */ - 'values'?: Array; -} -/** - * AMMFilterValues - * @export - * @interface RoleListFilterDTOV2024 - */ -export interface RoleListFilterDTOV2024 { - /** - * 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* - * @type {string} - * @memberof RoleListFilterDTOV2024 - */ - 'filters'?: string | null; - /** - * - * @type {Array} - * @memberof RoleListFilterDTOV2024 - */ - 'ammKeyValues'?: Array | null; -} -/** - * - * @export - * @interface RoleMatchDtoV2024 - */ -export interface RoleMatchDtoV2024 { - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof RoleMatchDtoV2024 - */ - 'roleRef'?: BaseReferenceDtoV2024; - /** - * - * @type {Array} - * @memberof RoleMatchDtoV2024 - */ - 'matchedAttributes'?: Array; -} -/** - * A reference to an Identity in an IDENTITY_LIST role membership criteria. - * @export - * @interface RoleMembershipIdentityV2024 - */ -export interface RoleMembershipIdentityV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof RoleMembershipIdentityV2024 - */ - 'type'?: DtoTypeV2024; - /** - * Identity id - * @type {string} - * @memberof RoleMembershipIdentityV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the Identity. - * @type {string} - * @memberof RoleMembershipIdentityV2024 - */ - 'name'?: string | null; - /** - * User name of the Identity - * @type {string} - * @memberof RoleMembershipIdentityV2024 - */ - 'aliasName'?: string | null; -} - - -/** - * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - * @export - * @enum {string} - */ - -export const RoleMembershipSelectorTypeV2024 = { - Standard: 'STANDARD', - IdentityList: 'IDENTITY_LIST' -} as const; - -export type RoleMembershipSelectorTypeV2024 = typeof RoleMembershipSelectorTypeV2024[keyof typeof RoleMembershipSelectorTypeV2024]; - - -/** - * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - * @export - * @interface RoleMembershipSelectorV2024 - */ -export interface RoleMembershipSelectorV2024 { - /** - * - * @type {RoleMembershipSelectorTypeV2024} - * @memberof RoleMembershipSelectorV2024 - */ - 'type'?: RoleMembershipSelectorTypeV2024; - /** - * - * @type {RoleCriteriaLevel1V2024} - * @memberof RoleMembershipSelectorV2024 - */ - 'criteria'?: RoleCriteriaLevel1V2024 | null; - /** - * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - * @type {Array} - * @memberof RoleMembershipSelectorV2024 - */ - 'identities'?: Array | null; -} - - -/** - * This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestV2024 - */ -export interface RoleMetadataBulkUpdateByFilterRequestV2024 { - /** - * Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2024 - */ - 'filters': string; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2024 - */ - 'operation': RoleMetadataBulkUpdateByFilterRequestV2024OperationV2024; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2024 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeV2024; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2024 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByFilterRequestV2024OperationV2024 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2024OperationV2024 = typeof RoleMetadataBulkUpdateByFilterRequestV2024OperationV2024[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2024OperationV2024]; -export const RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeV2024 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeV2024 = typeof RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeV2024[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2024ReplaceScopeV2024]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2024 - */ -export interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2024 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2024 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2024 - */ - 'values': Array | null; -} -/** - * This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByIdRequestV2024 - */ -export interface RoleMetadataBulkUpdateByIdRequestV2024 { - /** - * Roles\' Id to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2024 - */ - 'roles': Array; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2024 - */ - 'operation': RoleMetadataBulkUpdateByIdRequestV2024OperationV2024; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2024 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeV2024; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2024 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByIdRequestV2024OperationV2024 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2024OperationV2024 = typeof RoleMetadataBulkUpdateByIdRequestV2024OperationV2024[keyof typeof RoleMetadataBulkUpdateByIdRequestV2024OperationV2024]; -export const RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeV2024 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeV2024 = typeof RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeV2024[keyof typeof RoleMetadataBulkUpdateByIdRequestV2024ReplaceScopeV2024]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2024 - */ -export interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2024 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2024 - */ - 'attribute': string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2024 - */ - 'values': Array | null; -} -/** - * Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestV2024 - */ -export interface RoleMetadataBulkUpdateByQueryRequestV2024 { - /** - * query the identities to be updated - * @type {object} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2024 - */ - 'query': object; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2024 - */ - 'operation': RoleMetadataBulkUpdateByQueryRequestV2024OperationV2024; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2024 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeV2024; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2024 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByQueryRequestV2024OperationV2024 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2024OperationV2024 = typeof RoleMetadataBulkUpdateByQueryRequestV2024OperationV2024[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2024OperationV2024]; -export const RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeV2024 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeV2024 = typeof RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeV2024[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2024ReplaceScopeV2024]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2024 - */ -export interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2024 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2024 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2024 - */ - 'attributeValue'?: Array; -} -/** - * - * @export - * @interface RoleMiningEntitlementRefV2024 - */ -export interface RoleMiningEntitlementRefV2024 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2024 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2024 - */ - 'name'?: string; - /** - * Description forthe entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2024 - */ - 'description'?: string | null; - /** - * The entitlement attribute - * @type {string} - * @memberof RoleMiningEntitlementRefV2024 - */ - 'attribute'?: string; -} -/** - * - * @export - * @interface RoleMiningEntitlementV2024 - */ -export interface RoleMiningEntitlementV2024 { - /** - * - * @type {RoleMiningEntitlementRefV2024} - * @memberof RoleMiningEntitlementV2024 - */ - 'entitlementRef'?: RoleMiningEntitlementRefV2024; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2024 - */ - 'name'?: string; - /** - * Application name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2024 - */ - 'applicationName'?: string; - /** - * The number of identities with this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2024 - */ - 'identityCount'?: number; - /** - * The % popularity of this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2024 - */ - 'popularity'?: number; - /** - * The % popularity of this entitlement in the org. - * @type {number} - * @memberof RoleMiningEntitlementV2024 - */ - 'popularityInOrg'?: number; - /** - * The ID of the source/application. - * @type {string} - * @memberof RoleMiningEntitlementV2024 - */ - 'sourceId'?: string; - /** - * The status of activity data for the source. Value is complete or notComplete. - * @type {string} - * @memberof RoleMiningEntitlementV2024 - */ - 'activitySourceState'?: string | null; - /** - * The percentage of identities in the potential role that have usage of the source/application of this entitlement. - * @type {number} - * @memberof RoleMiningEntitlementV2024 - */ - 'sourceUsagePercent'?: number | null; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionDistributionInnerV2024 - */ -export interface RoleMiningIdentityDistributionDistributionInnerV2024 { - /** - * The attribute value that identities are grouped by - * @type {string} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2024 - */ - 'attributeValue'?: string | null; - /** - * The number of identities that have this attribute value - * @type {number} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2024 - */ - 'count'?: number; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionV2024 - */ -export interface RoleMiningIdentityDistributionV2024 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningIdentityDistributionV2024 - */ - 'attributeName'?: string; - /** - * - * @type {Array} - * @memberof RoleMiningIdentityDistributionV2024 - */ - 'distribution'?: Array; -} -/** - * - * @export - * @interface RoleMiningIdentityV2024 - */ -export interface RoleMiningIdentityV2024 { - /** - * Id of the identity - * @type {string} - * @memberof RoleMiningIdentityV2024 - */ - 'id'?: string; - /** - * Name of the identity - * @type {string} - * @memberof RoleMiningIdentityV2024 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string | null; }} - * @memberof RoleMiningIdentityV2024 - */ - 'attributes'?: { [key: string]: string | null; }; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleApplicationV2024 - */ -export interface RoleMiningPotentialRoleApplicationV2024 { - /** - * Id of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2024 - */ - 'id'?: string; - /** - * Name of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEditEntitlementsV2024 - */ -export interface RoleMiningPotentialRoleEditEntitlementsV2024 { - /** - * The list of entitlement ids to be edited - * @type {Array} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2024 - */ - 'ids'?: Array; - /** - * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. - * @type {boolean} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2024 - */ - 'exclude'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEntitlementsV2024 - */ -export interface RoleMiningPotentialRoleEntitlementsV2024 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2024 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportRequestV2024 - */ -export interface RoleMiningPotentialRoleExportRequestV2024 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportRequestV2024 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportRequestV2024 - */ - 'includeCommonAccess'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportResponseV2024 - */ -export interface RoleMiningPotentialRoleExportResponseV2024 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportResponseV2024 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportResponseV2024 - */ - 'includeCommonAccess'?: boolean; - /** - * ID used to reference this export - * @type {string} - * @memberof RoleMiningPotentialRoleExportResponseV2024 - */ - 'exportId'?: string; - /** - * - * @type {RoleMiningPotentialRoleExportStateV2024} - * @memberof RoleMiningPotentialRoleExportResponseV2024 - */ - 'status'?: RoleMiningPotentialRoleExportStateV2024; -} - - -/** - * - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleExportStateV2024 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RoleMiningPotentialRoleExportStateV2024 = typeof RoleMiningPotentialRoleExportStateV2024[keyof typeof RoleMiningPotentialRoleExportStateV2024]; - - -/** - * The potential role reference - * @export - * @interface RoleMiningPotentialRolePotentialRoleRefV2024 - */ -export interface RoleMiningPotentialRolePotentialRoleRefV2024 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2024 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleProvisionRequestV2024 - */ -export interface RoleMiningPotentialRoleProvisionRequestV2024 { - /** - * Name of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2024 - */ - 'roleName'?: string; - /** - * Short description of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2024 - */ - 'roleDescription'?: string; - /** - * ID of the identity that will own this role - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2024 - */ - 'ownerId'?: string; - /** - * When true, create access requests for the identities associated with the potential role - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2024 - */ - 'includeIdentities'?: boolean; - /** - * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2024 - */ - 'directlyAssignedEntitlements'?: boolean; -} -/** - * Provision state - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleProvisionStateV2024 = { - Potential: 'POTENTIAL', - Pending: 'PENDING', - Complete: 'COMPLETE', - Failed: 'FAILED' -} as const; - -export type RoleMiningPotentialRoleProvisionStateV2024 = typeof RoleMiningPotentialRoleProvisionStateV2024[keyof typeof RoleMiningPotentialRoleProvisionStateV2024]; - - -/** - * - * @export - * @interface RoleMiningPotentialRoleRefV2024 - */ -export interface RoleMiningPotentialRoleRefV2024 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2024 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleSourceUsageV2024 - */ -export interface RoleMiningPotentialRoleSourceUsageV2024 { - /** - * The identity ID - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2024 - */ - 'id'?: string; - /** - * Display name for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2024 - */ - 'displayName'?: string; - /** - * Email address for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2024 - */ - 'email'?: string; - /** - * The number of days there has been usage of the source by the identity. - * @type {number} - * @memberof RoleMiningPotentialRoleSourceUsageV2024 - */ - 'usageCount'?: number; -} -/** - * @type RoleMiningPotentialRoleSummaryCreatedByV2024 - * The potential role created by details - * @export - */ -export type RoleMiningPotentialRoleSummaryCreatedByV2024 = EntityCreatedByDTOV2024 | string; - -/** - * - * @export - * @interface RoleMiningPotentialRoleSummaryV2024 - */ -export interface RoleMiningPotentialRoleSummaryV2024 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRoleRefV2024} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'potentialRoleRef'?: RoleMiningPotentialRoleRefV2024; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'identityCount'?: number; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'entitlementCount'?: number; - /** - * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'identityGroupStatus'?: string; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2024} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2024; - /** - * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'roleId'?: string | null; - /** - * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'density'?: number; - /** - * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'freshness'?: number; - /** - * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'quality'?: number; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; - /** - * - * @type {RoleMiningPotentialRoleSummaryCreatedByV2024} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'createdBy'?: RoleMiningPotentialRoleSummaryCreatedByV2024; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'createdDate'?: string; - /** - * The potential role\'s saved status - * @type {boolean} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'saved'?: boolean; - /** - * Description of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'description'?: string | null; - /** - * - * @type {RoleMiningSessionParametersDtoV2024} - * @memberof RoleMiningPotentialRoleSummaryV2024 - */ - 'session'?: RoleMiningSessionParametersDtoV2024; -} - - -/** - * - * @export - * @interface RoleMiningPotentialRoleV2024 - */ -export interface RoleMiningPotentialRoleV2024 { - /** - * - * @type {RoleMiningSessionResponseCreatedByV2024} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2024; - /** - * The density of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'density'?: number; - /** - * The description of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'description'?: string | null; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'entitlementCount'?: number; - /** - * The list of entitlement ids to be excluded. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'excludedEntitlements'?: Array | null; - /** - * The freshness of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'freshness'?: number; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'identityCount'?: number; - /** - * Identity attribute distribution. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'identityDistribution'?: Array | null; - /** - * The list of ids in a potential role. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'identityIds'?: Array; - /** - * The status for this identity group which can be OBTAINED or COMPRESSED - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'identityGroupStatus'?: string | null; - /** - * Name of the potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRolePotentialRoleRefV2024} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefV2024 | null; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2024 & object} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2024 & object; - /** - * The quality of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'quality'?: number; - /** - * The roleId of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'roleId'?: string | null; - /** - * The potential role\'s saved status. - * @type {boolean} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionParametersDtoV2024} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'session'?: RoleMiningSessionParametersDtoV2024; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'id'?: string; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'createdDate'?: string; - /** - * The date-time when this potential role was modified. - * @type {string} - * @memberof RoleMiningPotentialRoleV2024 - */ - 'modifiedDate'?: string; -} - - -/** - * Role type - * @export - * @enum {string} - */ - -export const RoleMiningRoleTypeV2024 = { - Specialized: 'SPECIALIZED', - Common: 'COMMON' -} as const; - -export type RoleMiningRoleTypeV2024 = typeof RoleMiningRoleTypeV2024[keyof typeof RoleMiningRoleTypeV2024]; - - -/** - * - * @export - * @interface RoleMiningSessionDraftRoleDtoV2024 - */ -export interface RoleMiningSessionDraftRoleDtoV2024 { - /** - * Name of the draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'name'?: string; - /** - * Draft role description - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'description'?: string; - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'identityIds'?: Array; - /** - * The list of entitlement ids for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'entitlementIds'?: Array; - /** - * The list of excluded entitlement ids. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'excludedEntitlements'?: Array; - /** - * Last modified date - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'modified'?: string; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; - /** - * Id of the potential draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'id'?: string; - /** - * The date-time when this potential draft role was created. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'createdDate'?: string; - /** - * The date-time when this potential draft role was modified. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2024 - */ - 'modifiedDate'?: string; -} - - -/** - * - * @export - * @interface RoleMiningSessionDtoV2024 - */ -export interface RoleMiningSessionDtoV2024 { - /** - * - * @type {RoleMiningSessionScopeV2024} - * @memberof RoleMiningSessionDtoV2024 - */ - 'scope'?: RoleMiningSessionScopeV2024; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'pruneThreshold'?: number | null; - /** - * The calculated prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * Number of potential roles - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'potentialRoleCount'?: number; - /** - * Number of potential roles ready - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningSessionDtoV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionDtoV2024 - */ - 'emailRecipientId'?: string | null; - /** - * Number of identities in the population which meet the search criteria or identity list provided - * @type {number} - * @memberof RoleMiningSessionDtoV2024 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionDtoV2024 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionDtoV2024 - */ - 'name'?: string | null; -} - - -/** - * - * @export - * @interface RoleMiningSessionParametersDtoV2024 - */ -export interface RoleMiningSessionParametersDtoV2024 { - /** - * The ID of the role mining session - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'id'?: string; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'name'?: string | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'pruneThreshold'?: number | null; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionScopeV2024} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'scope'?: RoleMiningSessionScopeV2024; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; - /** - * - * @type {RoleMiningSessionStateV2024} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'state'?: RoleMiningSessionStateV2024; - /** - * - * @type {RoleMiningSessionScopingMethodV2024} - * @memberof RoleMiningSessionParametersDtoV2024 - */ - 'scopingMethod'?: RoleMiningSessionScopingMethodV2024; -} - - -/** - * @type RoleMiningSessionResponseCreatedByV2024 - * The session created by details - * @export - */ -export type RoleMiningSessionResponseCreatedByV2024 = EntityCreatedByDTOV2024 | string; - -/** - * - * @export - * @interface RoleMiningSessionResponseV2024 - */ -export interface RoleMiningSessionResponseV2024 { - /** - * - * @type {RoleMiningSessionScopeV2024} - * @memberof RoleMiningSessionResponseV2024 - */ - 'scope'?: RoleMiningSessionScopeV2024; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The scoping method of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'scopingMethod'?: string | null; - /** - * The computed (or prescribed) prune threshold for this session - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * The prune threshold to be used for this role mining session - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'pruneThreshold'?: number | null; - /** - * The number of potential roles - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'potentialRoleCount'?: number; - /** - * The number of potential roles which have completed processing - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningSessionStatusV2024} - * @memberof RoleMiningSessionResponseV2024 - */ - 'status'?: RoleMiningSessionStatusV2024; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'emailRecipientId'?: string | null; - /** - * - * @type {RoleMiningSessionResponseCreatedByV2024} - * @memberof RoleMiningSessionResponseV2024 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2024; - /** - * The number of identities - * @type {number} - * @memberof RoleMiningSessionResponseV2024 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionResponseV2024 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'name'?: string | null; - /** - * The data file path of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'dataFilePath'?: string | null; - /** - * Session Id for this role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'id'?: string; - /** - * The date-time when this role mining session was created. - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'createdDate'?: string; - /** - * The date-time when this role mining session was completed. - * @type {string} - * @memberof RoleMiningSessionResponseV2024 - */ - 'modifiedDate'?: string; - /** - * - * @type {RoleMiningRoleTypeV2024} - * @memberof RoleMiningSessionResponseV2024 - */ - 'type'?: RoleMiningRoleTypeV2024; -} - - -/** - * - * @export - * @interface RoleMiningSessionScopeV2024 - */ -export interface RoleMiningSessionScopeV2024 { - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2024 - */ - 'identityIds'?: Array; - /** - * The \"search\" criteria that produces the list of identities for this role mining session. - * @type {string} - * @memberof RoleMiningSessionScopeV2024 - */ - 'criteria'?: string | null; - /** - * The filter criteria for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2024 - */ - 'attributeFilterCriteria'?: Array | null; -} -/** - * The scoping method used in the current role mining session. - * @export - * @enum {string} - */ - -export const RoleMiningSessionScopingMethodV2024 = { - Manual: 'MANUAL', - AutoRm: 'AUTO_RM' -} as const; - -export type RoleMiningSessionScopingMethodV2024 = typeof RoleMiningSessionScopingMethodV2024[keyof typeof RoleMiningSessionScopingMethodV2024]; - - -/** - * Role mining session status - * @export - * @enum {string} - */ - -export const RoleMiningSessionStateV2024 = { - Created: 'CREATED', - Updated: 'UPDATED', - IdentitiesObtained: 'IDENTITIES_OBTAINED', - PruneThresholdObtained: 'PRUNE_THRESHOLD_OBTAINED', - PotentialRolesProcessing: 'POTENTIAL_ROLES_PROCESSING', - PotentialRolesCreated: 'POTENTIAL_ROLES_CREATED' -} as const; - -export type RoleMiningSessionStateV2024 = typeof RoleMiningSessionStateV2024[keyof typeof RoleMiningSessionStateV2024]; - - -/** - * - * @export - * @interface RoleMiningSessionStatusV2024 - */ -export interface RoleMiningSessionStatusV2024 { - /** - * - * @type {RoleMiningSessionStateV2024} - * @memberof RoleMiningSessionStatusV2024 - */ - 'state'?: RoleMiningSessionStateV2024; -} - - -/** - * Role - * @export - * @interface RoleSummaryV2024 - */ -export interface RoleSummaryV2024 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof RoleSummaryV2024 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof RoleSummaryV2024 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof RoleSummaryV2024 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof RoleSummaryV2024 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof RoleSummaryV2024 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2024} - * @memberof RoleSummaryV2024 - */ - 'owner'?: DisplayReferenceV2024; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2024 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2024 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface RoleTargetDtoV2024 - */ -export interface RoleTargetDtoV2024 { - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof RoleTargetDtoV2024 - */ - 'source'?: BaseReferenceDtoV2024; - /** - * - * @type {AccountInfoDtoV2024} - * @memberof RoleTargetDtoV2024 - */ - 'accountInfo'?: AccountInfoDtoV2024; - /** - * - * @type {BaseReferenceDtoV2024} - * @memberof RoleTargetDtoV2024 - */ - 'role'?: BaseReferenceDtoV2024; -} -/** - * A Role - * @export - * @interface RoleV2024 - */ -export interface RoleV2024 { - /** - * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof RoleV2024 - */ - 'id'?: string; - /** - * The human-readable display name of the Role - * @type {string} - * @memberof RoleV2024 - */ - 'name': string; - /** - * Date the Role was created - * @type {string} - * @memberof RoleV2024 - */ - 'created'?: string; - /** - * Date the Role was last modified. - * @type {string} - * @memberof RoleV2024 - */ - 'modified'?: string; - /** - * A human-readable description of the Role - * @type {string} - * @memberof RoleV2024 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2024} - * @memberof RoleV2024 - */ - 'owner': OwnerReferenceV2024 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof RoleV2024 - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2024 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2024 - */ - 'entitlements'?: Array; - /** - * - * @type {RoleMembershipSelectorV2024} - * @memberof RoleV2024 - */ - 'membership'?: RoleMembershipSelectorV2024 | null; - /** - * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - * @type {{ [key: string]: any; }} - * @memberof RoleV2024 - */ - 'legacyMembershipInfo'?: { [key: string]: any; } | null; - /** - * Whether the Role is enabled or not. - * @type {boolean} - * @memberof RoleV2024 - */ - 'enabled'?: boolean; - /** - * Whether the Role can be the target of access requests. - * @type {boolean} - * @memberof RoleV2024 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityForRoleV2024} - * @memberof RoleV2024 - */ - 'accessRequestConfig'?: RequestabilityForRoleV2024; - /** - * - * @type {RevocabilityForRoleV2024} - * @memberof RoleV2024 - */ - 'revocationRequestConfig'?: RevocabilityForRoleV2024; - /** - * List of IDs of segments, if any, to which this Role is assigned. - * @type {Array} - * @memberof RoleV2024 - */ - 'segments'?: Array | null; - /** - * Whether the Role is dimensional. - * @type {boolean} - * @memberof RoleV2024 - */ - 'dimensional'?: boolean | null; - /** - * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - * @type {Array} - * @memberof RoleV2024 - */ - 'dimensionRefs'?: Array | null; - /** - * - * @type {AttributeDTOListV2024} - * @memberof RoleV2024 - */ - 'accessModelMetadata'?: AttributeDTOListV2024; - /** - * The privilege level of the role, if applicable. - * @type {string} - * @memberof RoleV2024 - */ - 'privilegeLevel'?: string | null; -} -/** - * @type RuleV2024 - * @export - */ -export type RuleV2024 = GenerateRandomStringV2024 | GetReferenceIdentityAttributeV2024 | TransformRuleV2024; - -/** - * A table of accounts that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsAccountV2024 - */ -export interface SavedSearchCompleteSearchResultsAccountV2024 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2024 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2024 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsAccountV2024 - */ - 'preview': Array>; -} -/** - * A table of entitlements that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsEntitlementV2024 - */ -export interface SavedSearchCompleteSearchResultsEntitlementV2024 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2024 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2024 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2024 - */ - 'preview': Array>; -} -/** - * A table of identities that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsIdentityV2024 - */ -export interface SavedSearchCompleteSearchResultsIdentityV2024 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2024 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2024 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsIdentityV2024 - */ - 'preview': Array>; -} -/** - * A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. - * @export - * @interface SavedSearchCompleteSearchResultsV2024 - */ -export interface SavedSearchCompleteSearchResultsV2024 { - /** - * - * @type {SavedSearchCompleteSearchResultsAccountV2024} - * @memberof SavedSearchCompleteSearchResultsV2024 - */ - 'Account'?: SavedSearchCompleteSearchResultsAccountV2024 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsEntitlementV2024} - * @memberof SavedSearchCompleteSearchResultsV2024 - */ - 'Entitlement'?: SavedSearchCompleteSearchResultsEntitlementV2024 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsIdentityV2024} - * @memberof SavedSearchCompleteSearchResultsV2024 - */ - 'Identity'?: SavedSearchCompleteSearchResultsIdentityV2024 | null; -} -/** - * - * @export - * @interface SavedSearchCompleteV2024 - */ -export interface SavedSearchCompleteV2024 { - /** - * A name for the report file. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'fileName': string; - /** - * The email address of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'ownerEmail': string; - /** - * The name of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'ownerName': string; - /** - * The search query that was used to generate the report. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'query': string; - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'searchName': string; - /** - * - * @type {SavedSearchCompleteSearchResultsV2024} - * @memberof SavedSearchCompleteV2024 - */ - 'searchResults': SavedSearchCompleteSearchResultsV2024; - /** - * The Amazon S3 URL to download the report from. - * @type {string} - * @memberof SavedSearchCompleteV2024 - */ - 'signedS3Url': string; -} -/** - * - * @export - * @interface SavedSearchDetailFiltersV2024 - */ -export interface SavedSearchDetailFiltersV2024 { - /** - * - * @type {FilterTypeV2024} - * @memberof SavedSearchDetailFiltersV2024 - */ - 'type'?: FilterTypeV2024; - /** - * - * @type {RangeV2024} - * @memberof SavedSearchDetailFiltersV2024 - */ - 'range'?: RangeV2024; - /** - * The terms to be filtered. - * @type {Array} - * @memberof SavedSearchDetailFiltersV2024 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof SavedSearchDetailFiltersV2024 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface SavedSearchDetailV2024 - */ -export interface SavedSearchDetailV2024 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2024 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2024 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchDetailV2024 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2024 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchDetailV2024 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchDetailV2024 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2024 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchDetailV2024 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2024} - * @memberof SavedSearchDetailV2024 - */ - 'filters'?: SavedSearchDetailFiltersV2024 | null; -} -/** - * - * @export - * @interface SavedSearchNameV2024 - */ -export interface SavedSearchNameV2024 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchNameV2024 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchNameV2024 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface SavedSearchV2024 - */ -export interface SavedSearchV2024 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchV2024 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchV2024 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2024 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2024 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchV2024 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2024 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchV2024 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchV2024 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2024 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchV2024 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2024} - * @memberof SavedSearchV2024 - */ - 'filters'?: SavedSearchDetailFiltersV2024 | null; - /** - * The saved search ID. - * @type {string} - * @memberof SavedSearchV2024 - */ - 'id'?: string; - /** - * - * @type {TypedReferenceV2024} - * @memberof SavedSearchV2024 - */ - 'owner'?: TypedReferenceV2024; - /** - * The ID of the identity that owns this saved search. - * @type {string} - * @memberof SavedSearchV2024 - */ - 'ownerId'?: string; - /** - * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - * @type {boolean} - * @memberof SavedSearchV2024 - */ - 'public'?: boolean; -} -/** - * - * @export - * @interface Schedule1V2024 - */ -export interface Schedule1V2024 { - /** - * The type of the Schedule. - * @type {string} - * @memberof Schedule1V2024 - */ - 'type': Schedule1V2024TypeV2024; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof Schedule1V2024 - */ - 'cronExpression': string; -} - -export const Schedule1V2024TypeV2024 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type Schedule1V2024TypeV2024 = typeof Schedule1V2024TypeV2024[keyof typeof Schedule1V2024TypeV2024]; - -/** - * - * @export - * @interface Schedule2DaysV2024 - */ -export interface Schedule2DaysV2024 { - /** - * The application id - * @type {string} - * @memberof Schedule2DaysV2024 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2024} - * @memberof Schedule2DaysV2024 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2024; -} -/** - * - * @export - * @interface Schedule2HoursV2024 - */ -export interface Schedule2HoursV2024 { - /** - * The application id - * @type {string} - * @memberof Schedule2HoursV2024 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2024} - * @memberof Schedule2HoursV2024 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2024; -} -/** - * - * @export - * @interface Schedule2MonthsV2024 - */ -export interface Schedule2MonthsV2024 { - /** - * The application id - * @type {string} - * @memberof Schedule2MonthsV2024 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2024} - * @memberof Schedule2MonthsV2024 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2024; -} -/** - * The schedule information. - * @export - * @interface Schedule2V2024 - */ -export interface Schedule2V2024 { - /** - * - * @type {ScheduleTypeV2024} - * @memberof Schedule2V2024 - */ - 'type': ScheduleTypeV2024; - /** - * - * @type {Schedule2MonthsV2024} - * @memberof Schedule2V2024 - */ - 'months'?: Schedule2MonthsV2024; - /** - * - * @type {Schedule2DaysV2024} - * @memberof Schedule2V2024 - */ - 'days'?: Schedule2DaysV2024; - /** - * - * @type {Schedule2HoursV2024} - * @memberof Schedule2V2024 - */ - 'hours': Schedule2HoursV2024; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Schedule2V2024 - */ - 'expiration'?: string | null; - /** - * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. - * @type {string} - * @memberof Schedule2V2024 - */ - 'timeZoneId'?: string | null; -} - - -/** - * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" - * @export - * @interface ScheduleDaysV2024 - */ -export interface ScheduleDaysV2024 { - /** - * Enum type to specify days value - * @type {string} - * @memberof ScheduleDaysV2024 - */ - 'type': ScheduleDaysV2024TypeV2024; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleDaysV2024 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleDaysV2024 - */ - 'interval'?: number | null; -} - -export const ScheduleDaysV2024TypeV2024 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleDaysV2024TypeV2024 = typeof ScheduleDaysV2024TypeV2024[keyof typeof ScheduleDaysV2024TypeV2024]; - -/** - * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" - * @export - * @interface ScheduleHoursV2024 - */ -export interface ScheduleHoursV2024 { - /** - * Enum type to specify hours value - * @type {string} - * @memberof ScheduleHoursV2024 - */ - 'type': ScheduleHoursV2024TypeV2024; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleHoursV2024 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleHoursV2024 - */ - 'interval'?: number | null; -} - -export const ScheduleHoursV2024TypeV2024 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleHoursV2024TypeV2024 = typeof ScheduleHoursV2024TypeV2024[keyof typeof ScheduleHoursV2024TypeV2024]; - -/** - * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 - * @export - * @interface ScheduleMonthsV2024 - */ -export interface ScheduleMonthsV2024 { - /** - * Enum type to specify months value - * @type {string} - * @memberof ScheduleMonthsV2024 - */ - 'type': ScheduleMonthsV2024TypeV2024; - /** - * Values of the months based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleMonthsV2024 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleMonthsV2024 - */ - 'interval'?: number; -} - -export const ScheduleMonthsV2024TypeV2024 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleMonthsV2024TypeV2024 = typeof ScheduleMonthsV2024TypeV2024[keyof typeof ScheduleMonthsV2024TypeV2024]; - -/** - * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const ScheduleTypeV2024 = { - Daily: 'DAILY', - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Calendar: 'CALENDAR', - Annually: 'ANNUALLY' -} as const; - -export type ScheduleTypeV2024 = typeof ScheduleTypeV2024[keyof typeof ScheduleTypeV2024]; - - -/** - * - * @export - * @interface ScheduleV2024 - */ -export interface ScheduleV2024 { - /** - * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. - * @type {string} - * @memberof ScheduleV2024 - */ - 'type': ScheduleV2024TypeV2024; - /** - * - * @type {ScheduleMonthsV2024} - * @memberof ScheduleV2024 - */ - 'months'?: ScheduleMonthsV2024 | null; - /** - * - * @type {ScheduleDaysV2024} - * @memberof ScheduleV2024 - */ - 'days'?: ScheduleDaysV2024; - /** - * - * @type {ScheduleHoursV2024} - * @memberof ScheduleV2024 - */ - 'hours': ScheduleHoursV2024; - /** - * Specifies the time after which this schedule will no longer occur. - * @type {string} - * @memberof ScheduleV2024 - */ - 'expiration'?: string | null; - /** - * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. - * @type {string} - * @memberof ScheduleV2024 - */ - 'timeZoneId'?: string; -} - -export const ScheduleV2024TypeV2024 = { - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Annually: 'ANNUALLY', - Calendar: 'CALENDAR' -} as const; - -export type ScheduleV2024TypeV2024 = typeof ScheduleV2024TypeV2024[keyof typeof ScheduleV2024TypeV2024]; - -/** - * Options for BACKUP type jobs. Required for BACKUP jobs. - * @export - * @interface ScheduledActionPayloadContentBackupOptionsV2024 - */ -export interface ScheduledActionPayloadContentBackupOptionsV2024 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionPayloadContentBackupOptionsV2024 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024; }} - * @memberof ScheduledActionPayloadContentBackupOptionsV2024 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024; }; -} -/** - * - * @export - * @interface ScheduledActionPayloadContentV2024 - */ -export interface ScheduledActionPayloadContentV2024 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionPayloadContentV2024 - */ - 'name': string; - /** - * - * @type {ScheduledActionPayloadContentBackupOptionsV2024} - * @memberof ScheduledActionPayloadContentV2024 - */ - 'backupOptions'?: ScheduledActionPayloadContentBackupOptionsV2024; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2024 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2024 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2024 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionPayloadV2024 - */ -export interface ScheduledActionPayloadV2024 { - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionPayloadV2024 - */ - 'jobType': ScheduledActionPayloadV2024JobTypeV2024; - /** - * The time when this scheduled action should start. Optional. - * @type {string} - * @memberof ScheduledActionPayloadV2024 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. Optional for repeated events. - * @type {string} - * @memberof ScheduledActionPayloadV2024 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. Optional, will default to current time zone. - * @type {string} - * @memberof ScheduledActionPayloadV2024 - */ - 'timeZoneId'?: string; - /** - * - * @type {ScheduledActionPayloadContentV2024} - * @memberof ScheduledActionPayloadV2024 - */ - 'content': ScheduledActionPayloadContentV2024; -} - -export const ScheduledActionPayloadV2024JobTypeV2024 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionPayloadV2024JobTypeV2024 = typeof ScheduledActionPayloadV2024JobTypeV2024[keyof typeof ScheduledActionPayloadV2024JobTypeV2024]; - -/** - * - * @export - * @interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024 - */ -export interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024 { - /** - * Set of names to be included. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024 - */ - 'includedNames'?: Array; -} -/** - * Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. - * @export - * @interface ScheduledActionResponseContentBackupOptionsV2024 - */ -export interface ScheduledActionResponseContentBackupOptionsV2024 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsV2024 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024; }} - * @memberof ScheduledActionResponseContentBackupOptionsV2024 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2024; }; -} -/** - * Content details for the scheduled action. - * @export - * @interface ScheduledActionResponseContentV2024 - */ -export interface ScheduledActionResponseContentV2024 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionResponseContentV2024 - */ - 'name'?: string; - /** - * - * @type {ScheduledActionResponseContentBackupOptionsV2024} - * @memberof ScheduledActionResponseContentV2024 - */ - 'backupOptions'?: ScheduledActionResponseContentBackupOptionsV2024; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2024 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2024 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2024 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionResponseV2024 - */ -export interface ScheduledActionResponseV2024 { - /** - * Unique identifier for this scheduled action. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'id'?: string; - /** - * The time when this scheduled action was created. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'created'?: string; - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'jobType'?: ScheduledActionResponseV2024JobTypeV2024; - /** - * - * @type {ScheduledActionResponseContentV2024} - * @memberof ScheduledActionResponseV2024 - */ - 'content'?: ScheduledActionResponseContentV2024; - /** - * The time when this scheduled action should start. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. - * @type {string} - * @memberof ScheduledActionResponseV2024 - */ - 'timeZoneId'?: string; -} - -export const ScheduledActionResponseV2024JobTypeV2024 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionResponseV2024JobTypeV2024 = typeof ScheduledActionResponseV2024JobTypeV2024[keyof typeof ScheduledActionResponseV2024JobTypeV2024]; - -/** - * Attributes related to a scheduled trigger - * @export - * @interface ScheduledAttributesV2024 - */ -export interface ScheduledAttributesV2024 { - /** - * Frequency of execution - * @type {string} - * @memberof ScheduledAttributesV2024 - */ - 'frequency': ScheduledAttributesV2024FrequencyV2024 | null; - /** - * Time zone identifier - * @type {string} - * @memberof ScheduledAttributesV2024 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof ScheduledAttributesV2024 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof ScheduledAttributesV2024 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2024 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2024 - */ - 'yearlyTimes'?: Array | null; -} - -export const ScheduledAttributesV2024FrequencyV2024 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type ScheduledAttributesV2024FrequencyV2024 = typeof ScheduledAttributesV2024FrequencyV2024[keyof typeof ScheduledAttributesV2024FrequencyV2024]; - -/** - * The owner of the scheduled search - * @export - * @interface ScheduledSearchAllOfOwnerV2024 - */ -export interface ScheduledSearchAllOfOwnerV2024 { - /** - * The type of object being referenced - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2024 - */ - 'type': ScheduledSearchAllOfOwnerV2024TypeV2024; - /** - * The ID of the referenced object - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2024 - */ - 'id': string; -} - -export const ScheduledSearchAllOfOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type ScheduledSearchAllOfOwnerV2024TypeV2024 = typeof ScheduledSearchAllOfOwnerV2024TypeV2024[keyof typeof ScheduledSearchAllOfOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface ScheduledSearchNameV2024 - */ -export interface ScheduledSearchNameV2024 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2024 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2024 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ScheduledSearchV2024 - */ -export interface ScheduledSearchV2024 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2024} - * @memberof ScheduledSearchV2024 - */ - 'schedule': Schedule2V2024; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof ScheduledSearchV2024 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof ScheduledSearchV2024 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof ScheduledSearchV2024 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof ScheduledSearchV2024 - */ - 'displayQueryDetails'?: boolean; - /** - * The scheduled search ID. - * @type {string} - * @memberof ScheduledSearchV2024 - */ - 'id': string; - /** - * - * @type {ScheduledSearchAllOfOwnerV2024} - * @memberof ScheduledSearchV2024 - */ - 'owner': ScheduledSearchAllOfOwnerV2024; - /** - * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. - * @type {string} - * @memberof ScheduledSearchV2024 - * @deprecated - */ - 'ownerId': string; -} -/** - * - * @export - * @interface SchemaV2024 - */ -export interface SchemaV2024 { - /** - * The id of the Schema. - * @type {string} - * @memberof SchemaV2024 - */ - 'id'?: string; - /** - * The name of the Schema. - * @type {string} - * @memberof SchemaV2024 - */ - 'name'?: string; - /** - * The name of the object type on the native system that the schema represents. - * @type {string} - * @memberof SchemaV2024 - */ - 'nativeObjectType'?: string; - /** - * The name of the attribute used to calculate the unique identifier for an object in the schema. - * @type {string} - * @memberof SchemaV2024 - */ - 'identityAttribute'?: string; - /** - * The name of the attribute used to calculate the display value for an object in the schema. - * @type {string} - * @memberof SchemaV2024 - */ - 'displayAttribute'?: string; - /** - * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - * @type {string} - * @memberof SchemaV2024 - */ - 'hierarchyAttribute'?: string | null; - /** - * Flag indicating whether or not the include permissions with the object data when aggregating the schema. - * @type {boolean} - * @memberof SchemaV2024 - */ - 'includePermissions'?: boolean; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SchemaV2024 - */ - 'features'?: Array; - /** - * Holds any extra configuration data that the schema may require. - * @type {object} - * @memberof SchemaV2024 - */ - 'configuration'?: object; - /** - * The attribute definitions which form the schema. - * @type {Array} - * @memberof SchemaV2024 - */ - 'attributes'?: Array; - /** - * The date the Schema was created. - * @type {string} - * @memberof SchemaV2024 - */ - 'created'?: string; - /** - * The date the Schema was last modified. - * @type {string} - * @memberof SchemaV2024 - */ - 'modified'?: string | null; -} - -export const SchemaV2024FeaturesV2024 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SchemaV2024FeaturesV2024 = typeof SchemaV2024FeaturesV2024[keyof typeof SchemaV2024FeaturesV2024]; - -/** - * An enumeration of the types of scope choices - * @export - * @enum {string} - */ - -export const ScopeTypeV2024 = { - Entitlement: 'ENTITLEMENT', - Certification: 'CERTIFICATION', - Identity: 'IDENTITY', - Entitlementrequest: 'ENTITLEMENTREQUEST' -} as const; - -export type ScopeTypeV2024 = typeof ScopeTypeV2024[keyof typeof ScopeTypeV2024]; - - -/** - * This defines what access the segment is giving - * @export - * @interface ScopeV2024 - */ -export interface ScopeV2024 { - /** - * - * @type {ScopeTypeV2024} - * @memberof ScopeV2024 - */ - 'scope'?: ScopeTypeV2024; - /** - * - * @type {ScopeVisibilityTypeV2024} - * @memberof ScopeV2024 - */ - 'visibility'?: ScopeVisibilityTypeV2024; - /** - * - * @type {VisibilityCriteriaV2024} - * @memberof ScopeV2024 - */ - 'scopeFilter'?: VisibilityCriteriaV2024; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof ScopeV2024 - */ - 'scopeSelection'?: Array; -} - - -/** - * An enumeration of the types of scope visibility choices - * @export - * @enum {string} - */ - -export const ScopeVisibilityTypeV2024 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION', - Unsegmented: 'UNSEGMENTED' -} as const; - -export type ScopeVisibilityTypeV2024 = typeof ScopeVisibilityTypeV2024[keyof typeof ScopeVisibilityTypeV2024]; - - -/** - * - * @export - * @interface SearchAggregationSpecificationV2024 - */ -export interface SearchAggregationSpecificationV2024 { - /** - * - * @type {NestedAggregationV2024} - * @memberof SearchAggregationSpecificationV2024 - */ - 'nested'?: NestedAggregationV2024; - /** - * - * @type {MetricAggregationV2024} - * @memberof SearchAggregationSpecificationV2024 - */ - 'metric'?: MetricAggregationV2024; - /** - * - * @type {FilterAggregationV2024} - * @memberof SearchAggregationSpecificationV2024 - */ - 'filter'?: FilterAggregationV2024; - /** - * - * @type {BucketAggregationV2024} - * @memberof SearchAggregationSpecificationV2024 - */ - 'bucket'?: BucketAggregationV2024; - /** - * - * @type {SubSearchAggregationSpecificationV2024} - * @memberof SearchAggregationSpecificationV2024 - */ - 'subAggregation'?: SubSearchAggregationSpecificationV2024; -} -/** - * - * @export - * @interface SearchArgumentsV2024 - */ -export interface SearchArgumentsV2024 { - /** - * The ID of the scheduled search that triggered the saved search execution. - * @type {string} - * @memberof SearchArgumentsV2024 - */ - 'scheduleId'?: string; - /** - * The owner of the scheduled search being tested. - * @type {TypedReferenceV2024} - * @memberof SearchArgumentsV2024 - */ - 'owner'?: TypedReferenceV2024; - /** - * The email recipients of the scheduled search being tested. - * @type {Array} - * @memberof SearchArgumentsV2024 - */ - 'recipients'?: Array; -} -/** - * - * @export - * @interface SearchAttributeConfigV2024 - */ -export interface SearchAttributeConfigV2024 { - /** - * Name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2024 - */ - 'name'?: string; - /** - * The display name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2024 - */ - 'displayName'?: string; - /** - * Map of application id and their associated attribute. - * @type {object} - * @memberof SearchAttributeConfigV2024 - */ - 'applicationAttributes'?: object; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeLowerV2024 - */ -export interface SearchCriteriaFiltersValueRangeLowerV2024 { - /** - * The lower bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeLowerV2024 - */ - 'value'?: string; - /** - * Whether the lower bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeLowerV2024 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeUpperV2024 - */ -export interface SearchCriteriaFiltersValueRangeUpperV2024 { - /** - * The upper bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeUpperV2024 - */ - 'value'?: string; - /** - * Whether the upper bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeUpperV2024 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeV2024 - */ -export interface SearchCriteriaFiltersValueRangeV2024 { - /** - * - * @type {SearchCriteriaFiltersValueRangeLowerV2024} - * @memberof SearchCriteriaFiltersValueRangeV2024 - */ - 'lower'?: SearchCriteriaFiltersValueRangeLowerV2024; - /** - * - * @type {SearchCriteriaFiltersValueRangeUpperV2024} - * @memberof SearchCriteriaFiltersValueRangeV2024 - */ - 'upper'?: SearchCriteriaFiltersValueRangeUpperV2024; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueV2024 - */ -export interface SearchCriteriaFiltersValueV2024 { - /** - * The type of filter, e.g., \"TERMS\" or \"RANGE\". - * @type {string} - * @memberof SearchCriteriaFiltersValueV2024 - */ - 'type'?: string; - /** - * Terms to filter by (for \"TERMS\" type). - * @type {Array} - * @memberof SearchCriteriaFiltersValueV2024 - */ - 'terms'?: Array; - /** - * - * @type {SearchCriteriaFiltersValueRangeV2024} - * @memberof SearchCriteriaFiltersValueV2024 - */ - 'range'?: SearchCriteriaFiltersValueRangeV2024; -} -/** - * - * @export - * @interface SearchCriteriaQueryV2024 - */ -export interface SearchCriteriaQueryV2024 { - /** - * A structured query for advanced search. - * @type {string} - * @memberof SearchCriteriaQueryV2024 - */ - 'query'?: string; -} -/** - * - * @export - * @interface SearchCriteriaTextQueryV2024 - */ -export interface SearchCriteriaTextQueryV2024 { - /** - * Terms to search for. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2024 - */ - 'terms'?: Array; - /** - * Fields to search within. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2024 - */ - 'fields'?: Array; - /** - * Whether to match any of the terms. - * @type {boolean} - * @memberof SearchCriteriaTextQueryV2024 - */ - 'matchAny'?: boolean; -} -/** - * Represents the search criteria for querying entitlements. - * @export - * @interface SearchCriteriaV2024 - */ -export interface SearchCriteriaV2024 { - /** - * A list of indices to search within. Must contain exactly one item, typically \"entitlements\". - * @type {Array} - * @memberof SearchCriteriaV2024 - */ - 'indices': Array; - /** - * A map of filters applied to the search. Keys are filter names, and values are filter definitions. - * @type {{ [key: string]: SearchCriteriaFiltersValueV2024; }} - * @memberof SearchCriteriaV2024 - */ - 'filters'?: { [key: string]: SearchCriteriaFiltersValueV2024; }; - /** - * - * @type {SearchCriteriaQueryV2024} - * @memberof SearchCriteriaV2024 - */ - 'query'?: SearchCriteriaQueryV2024; - /** - * Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. - * @type {string} - * @memberof SearchCriteriaV2024 - */ - 'queryType'?: string; - /** - * - * @type {SearchCriteriaTextQueryV2024} - * @memberof SearchCriteriaV2024 - */ - 'textQuery'?: SearchCriteriaTextQueryV2024; - /** - * Whether to include nested objects in the search results. - * @type {boolean} - * @memberof SearchCriteriaV2024 - */ - 'includeNested'?: boolean; - /** - * Specifies the sorting order for the results. - * @type {Array} - * @memberof SearchCriteriaV2024 - */ - 'sort'?: Array; - /** - * Used for pagination to fetch results after a specific point. - * @type {Array} - * @memberof SearchCriteriaV2024 - */ - 'searchAfter'?: Array; -} -/** - * @type SearchDocumentV2024 - * @export - */ -export type SearchDocumentV2024 = AccessProfileDocumentV2024 | AccountActivityDocumentV2024 | EntitlementDocumentV2024 | EventDocumentV2024 | IdentityDocumentV2024 | RoleDocumentV2024; - -/** - * @type SearchDocumentsV2024 - * @export - */ -export type SearchDocumentsV2024 = AccessProfileDocumentsV2024 | AccountActivityDocumentsV2024 | EntitlementDocumentsV2024 | EventDocumentsV2024 | IdentityDocumentsV2024 | RoleDocumentsV2024; - -/** - * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. - * @export - * @interface SearchExportReportArgumentsV2024 - */ -export interface SearchExportReportArgumentsV2024 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchExportReportArgumentsV2024 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof SearchExportReportArgumentsV2024 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof SearchExportReportArgumentsV2024 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchExportReportArgumentsV2024 - */ - 'sort'?: Array; -} -/** - * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SearchFilterTypeV2024 = { - Term: 'TERM' -} as const; - -export type SearchFilterTypeV2024 = typeof SearchFilterTypeV2024[keyof typeof SearchFilterTypeV2024]; - - -/** - * - * @export - * @interface SearchFormDefinitionsByTenant400ResponseV2024 - */ -export interface SearchFormDefinitionsByTenant400ResponseV2024 { - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2024 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof SearchFormDefinitionsByTenant400ResponseV2024 - */ - 'messages'?: Array; - /** - * - * @type {number} - * @memberof SearchFormDefinitionsByTenant400ResponseV2024 - */ - 'statusCode'?: number; - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2024 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface SearchScheduleRecipientsInnerV2024 - */ -export interface SearchScheduleRecipientsInnerV2024 { - /** - * The type of object being referenced - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2024 - */ - 'type': SearchScheduleRecipientsInnerV2024TypeV2024; - /** - * The ID of the referenced object - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2024 - */ - 'id': string; -} - -export const SearchScheduleRecipientsInnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SearchScheduleRecipientsInnerV2024TypeV2024 = typeof SearchScheduleRecipientsInnerV2024TypeV2024[keyof typeof SearchScheduleRecipientsInnerV2024TypeV2024]; - -/** - * - * @export - * @interface SearchScheduleV2024 - */ -export interface SearchScheduleV2024 { - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof SearchScheduleV2024 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof SearchScheduleV2024 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof SearchScheduleV2024 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2024} - * @memberof SearchScheduleV2024 - */ - 'schedule': Schedule2V2024; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof SearchScheduleV2024 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof SearchScheduleV2024 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof SearchScheduleV2024 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof SearchScheduleV2024 - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface SearchV2024 - */ -export interface SearchV2024 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchV2024 - */ - 'indices'?: Array; - /** - * - * @type {QueryTypeV2024} - * @memberof SearchV2024 - */ - 'queryType'?: QueryTypeV2024; - /** - * - * @type {string} - * @memberof SearchV2024 - */ - 'queryVersion'?: string; - /** - * - * @type {QueryV2024} - * @memberof SearchV2024 - */ - 'query'?: QueryV2024; - /** - * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - * @type {object} - * @memberof SearchV2024 - */ - 'queryDsl'?: object; - /** - * - * @type {TextQueryV2024} - * @memberof SearchV2024 - */ - 'textQuery'?: TextQueryV2024; - /** - * - * @type {TypeAheadQueryV2024} - * @memberof SearchV2024 - */ - 'typeAheadQuery'?: TypeAheadQueryV2024; - /** - * Indicates whether nested objects from returned search results should be included. - * @type {boolean} - * @memberof SearchV2024 - */ - 'includeNested'?: boolean; - /** - * - * @type {QueryResultFilterV2024} - * @memberof SearchV2024 - */ - 'queryResultFilter'?: QueryResultFilterV2024; - /** - * - * @type {AggregationTypeV2024} - * @memberof SearchV2024 - */ - 'aggregationType'?: AggregationTypeV2024; - /** - * - * @type {string} - * @memberof SearchV2024 - */ - 'aggregationsVersion'?: string; - /** - * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - * @type {object} - * @memberof SearchV2024 - */ - 'aggregationsDsl'?: object; - /** - * - * @type {SearchAggregationSpecificationV2024} - * @memberof SearchV2024 - */ - 'aggregations'?: SearchAggregationSpecificationV2024; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchV2024 - */ - 'sort'?: Array; - /** - * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] - * @type {Array} - * @memberof SearchV2024 - */ - 'searchAfter'?: Array; - /** - * The filters to be applied for each filtered field name. - * @type {{ [key: string]: FilterV2024; }} - * @memberof SearchV2024 - */ - 'filters'?: { [key: string]: FilterV2024; }; -} - - -/** - * - * @export - * @interface SectionDetailsV2024 - */ -export interface SectionDetailsV2024 { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionDetailsV2024 - */ - 'name'?: string | null; - /** - * Label of the section - * @type {string} - * @memberof SectionDetailsV2024 - */ - 'label'?: string | null; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionDetailsV2024 - */ - 'formItems'?: Array; -} -/** - * SED Approval Status - * @export - * @interface SedApprovalStatusV2024 - */ -export interface SedApprovalStatusV2024 { - /** - * failed reason will be display if status is failed - * @type {string} - * @memberof SedApprovalStatusV2024 - */ - 'failedReason'?: string; - /** - * Sed id - * @type {string} - * @memberof SedApprovalStatusV2024 - */ - 'id'?: string; - /** - * SUCCESS | FAILED - * @type {string} - * @memberof SedApprovalStatusV2024 - */ - 'status'?: string; -} -/** - * Sed Approval Request Body - * @export - * @interface SedApprovalV2024 - */ -export interface SedApprovalV2024 { - /** - * List of SED id\'s - * @type {Array} - * @memberof SedApprovalV2024 - */ - 'items'?: Array; -} -/** - * Sed Assignee - * @export - * @interface SedAssigneeV2024 - */ -export interface SedAssigneeV2024 { - /** - * Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE - * @type {string} - * @memberof SedAssigneeV2024 - */ - 'type': SedAssigneeV2024TypeV2024; - /** - * Identity or Group identifier Empty when using source/entitlement owner personas - * @type {string} - * @memberof SedAssigneeV2024 - */ - 'value'?: string; -} - -export const SedAssigneeV2024TypeV2024 = { - Identity: 'IDENTITY', - Group: 'GROUP', - SourceOwner: 'SOURCE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER' -} as const; - -export type SedAssigneeV2024TypeV2024 = typeof SedAssigneeV2024TypeV2024[keyof typeof SedAssigneeV2024TypeV2024]; - -/** - * Sed Assignment Response - * @export - * @interface SedAssignmentResponseV2024 - */ -export interface SedAssignmentResponseV2024 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedAssignmentResponseV2024 - */ - 'batchId'?: string; -} -/** - * Sed Assignment - * @export - * @interface SedAssignmentV2024 - */ -export interface SedAssignmentV2024 { - /** - * - * @type {SedAssigneeV2024} - * @memberof SedAssignmentV2024 - */ - 'assignee'?: SedAssigneeV2024; - /** - * List of SED id\'s - * @type {Array} - * @memberof SedAssignmentV2024 - */ - 'items'?: Array; -} -/** - * Sed Batch Record - * @export - * @interface SedBatchRecordV2024 - */ -export interface SedBatchRecordV2024 { - /** - * The tenant ID associated with the batch. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'tenantId'?: string; - /** - * The unique ID of the batch. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'batchId'?: string; - /** - * The name of the batch. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'name'?: string | null; - /** - * The current state of the batch (e.g., submitted, materialized, completed). - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'processedState'?: string | null; - /** - * The ID of the user who requested the batch. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'requestedBy'?: string; - /** - * The number of items materialized in the batch. - * @type {number} - * @memberof SedBatchRecordV2024 - */ - 'materializedCount'?: number; - /** - * The number of items processed in the batch. - * @type {number} - * @memberof SedBatchRecordV2024 - */ - 'processedCount'?: number; - /** - * The timestamp when the batch was created. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'createdAt'?: string; - /** - * The timestamp when the batch was last updated. - * @type {string} - * @memberof SedBatchRecordV2024 - */ - 'updatedAt'?: string | null; -} -/** - * Sed Batch Request - * @export - * @interface SedBatchRequestV2024 - */ -export interface SedBatchRequestV2024 { - /** - * list of entitlement ids - * @type {Array} - * @memberof SedBatchRequestV2024 - */ - 'entitlements'?: Array | null; - /** - * list of sed ids - * @type {Array} - * @memberof SedBatchRequestV2024 - */ - 'seds'?: Array | null; - /** - * Search criteria for the batch request. - * @type {{ [key: string]: SearchCriteriaV2024; }} - * @memberof SedBatchRequestV2024 - */ - 'searchCriteria'?: { [key: string]: SearchCriteriaV2024; } | null; -} -/** - * Sed Batch Response - * @export - * @interface SedBatchResponseV2024 - */ -export interface SedBatchResponseV2024 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedBatchResponseV2024 - */ - 'batchId'?: string; -} -/** - * Sed Batch Stats - * @export - * @interface SedBatchStatsV2024 - */ -export interface SedBatchStatsV2024 { - /** - * batch complete - * @type {boolean} - * @memberof SedBatchStatsV2024 - */ - 'batchComplete'?: boolean; - /** - * batch Id - * @type {string} - * @memberof SedBatchStatsV2024 - */ - 'batchId'?: string; - /** - * discovered count - * @type {number} - * @memberof SedBatchStatsV2024 - */ - 'discoveredCount'?: number; - /** - * discovery complete - * @type {boolean} - * @memberof SedBatchStatsV2024 - */ - 'discoveryComplete'?: boolean; - /** - * processed count - * @type {number} - * @memberof SedBatchStatsV2024 - */ - 'processedCount'?: number; -} -/** - * Patch for Suggested Entitlement Description - * @export - * @interface SedPatchV2024 - */ -export interface SedPatchV2024 { - /** - * desired operation - * @type {string} - * @memberof SedPatchV2024 - */ - 'op'?: string; - /** - * field to be patched - * @type {string} - * @memberof SedPatchV2024 - */ - 'path'?: string; - /** - * value to replace with - * @type {object} - * @memberof SedPatchV2024 - */ - 'value'?: object; -} -/** - * Suggested Entitlement Description - * @export - * @interface SedV2024 - */ -export interface SedV2024 { - /** - * name of the entitlement - * @type {string} - * @memberof SedV2024 - */ - 'Name'?: string; - /** - * entitlement approved by - * @type {string} - * @memberof SedV2024 - */ - 'approved_by'?: string; - /** - * entitlement approved type - * @type {string} - * @memberof SedV2024 - */ - 'approved_type'?: string; - /** - * entitlement approved then - * @type {string} - * @memberof SedV2024 - */ - 'approved_when'?: string; - /** - * entitlement attribute - * @type {string} - * @memberof SedV2024 - */ - 'attribute'?: string; - /** - * description of entitlement - * @type {string} - * @memberof SedV2024 - */ - 'description'?: string; - /** - * entitlement display name - * @type {string} - * @memberof SedV2024 - */ - 'displayName'?: string; - /** - * sed id - * @type {string} - * @memberof SedV2024 - */ - 'id'?: string; - /** - * entitlement source id - * @type {string} - * @memberof SedV2024 - */ - 'sourceId'?: string; - /** - * entitlement source name - * @type {string} - * @memberof SedV2024 - */ - 'sourceName'?: string; - /** - * entitlement status - * @type {string} - * @memberof SedV2024 - */ - 'status'?: string; - /** - * llm suggested entitlement description - * @type {string} - * @memberof SedV2024 - */ - 'suggestedDescription'?: string; - /** - * entitlement type - * @type {string} - * @memberof SedV2024 - */ - 'type'?: string; - /** - * entitlement value - * @type {string} - * @memberof SedV2024 - */ - 'value'?: string; -} -/** - * - * @export - * @interface SegmentV2024 - */ -export interface SegmentV2024 { - /** - * The segment\'s ID. - * @type {string} - * @memberof SegmentV2024 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof SegmentV2024 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof SegmentV2024 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof SegmentV2024 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof SegmentV2024 - */ - 'description'?: string; - /** - * - * @type {OwnerReferenceSegmentsV2024} - * @memberof SegmentV2024 - */ - 'owner'?: OwnerReferenceSegmentsV2024 | null; - /** - * - * @type {SegmentVisibilityCriteriaV2024} - * @memberof SegmentV2024 - */ - 'visibilityCriteria'?: SegmentVisibilityCriteriaV2024; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof SegmentV2024 - */ - 'active'?: boolean; -} -/** - * - * @export - * @interface SegmentVisibilityCriteriaV2024 - */ -export interface SegmentVisibilityCriteriaV2024 { - /** - * - * @type {ExpressionV2024} - * @memberof SegmentVisibilityCriteriaV2024 - */ - 'expression'?: ExpressionV2024; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigMatchExpressionV2024 - */ -export interface SelectorAccountMatchConfigMatchExpressionV2024 { - /** - * - * @type {Array} - * @memberof SelectorAccountMatchConfigMatchExpressionV2024 - */ - 'matchTerms'?: Array; - /** - * If it is AND operators for match terms - * @type {boolean} - * @memberof SelectorAccountMatchConfigMatchExpressionV2024 - */ - 'and'?: boolean; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigV2024 - */ -export interface SelectorAccountMatchConfigV2024 { - /** - * - * @type {SelectorAccountMatchConfigMatchExpressionV2024} - * @memberof SelectorAccountMatchConfigV2024 - */ - 'matchExpression'?: SelectorAccountMatchConfigMatchExpressionV2024; -} -/** - * - * @export - * @interface SelectorV2024 - */ -export interface SelectorV2024 { - /** - * The application id - * @type {string} - * @memberof SelectorV2024 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2024} - * @memberof SelectorV2024 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2024; -} -/** - * Self block for imported/exported object. - * @export - * @interface SelfImportExportDtoV2024 - */ -export interface SelfImportExportDtoV2024 { - /** - * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. - * @type {string} - * @memberof SelfImportExportDtoV2024 - */ - 'type'?: SelfImportExportDtoV2024TypeV2024; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof SelfImportExportDtoV2024 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof SelfImportExportDtoV2024 - */ - 'name'?: string; -} - -export const SelfImportExportDtoV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type SelfImportExportDtoV2024TypeV2024 = typeof SelfImportExportDtoV2024TypeV2024[keyof typeof SelfImportExportDtoV2024TypeV2024]; - -/** - * - * @export - * @interface SendAccountVerificationRequestV2024 - */ -export interface SendAccountVerificationRequestV2024 { - /** - * The source name where identity account password should be reset - * @type {string} - * @memberof SendAccountVerificationRequestV2024 - */ - 'sourceName'?: string | null; - /** - * The method to send notification - * @type {string} - * @memberof SendAccountVerificationRequestV2024 - */ - 'via': SendAccountVerificationRequestV2024ViaV2024; -} - -export const SendAccountVerificationRequestV2024ViaV2024 = { - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL', - LinkWork: 'LINK_WORK', - LinkPersonal: 'LINK_PERSONAL' -} as const; - -export type SendAccountVerificationRequestV2024ViaV2024 = typeof SendAccountVerificationRequestV2024ViaV2024[keyof typeof SendAccountVerificationRequestV2024ViaV2024]; - -/** - * - * @export - * @interface SendClassifyMachineAccount200ResponseV2024 - */ -export interface SendClassifyMachineAccount200ResponseV2024 { - /** - * Indicates if account is classified as machine - * @type {boolean} - * @memberof SendClassifyMachineAccount200ResponseV2024 - */ - 'isMachine'?: boolean; -} -/** - * - * @export - * @interface SendTestNotificationRequestDtoV2024 - */ -export interface SendTestNotificationRequestDtoV2024 { - /** - * The template notification key. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'key'?: string; - /** - * The notification medium. Has to be one of the following enum values. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'medium'?: SendTestNotificationRequestDtoV2024MediumV2024; - /** - * The locale for the message text. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'locale'?: string; - /** - * A Json object that denotes the context specific to the template. - * @type {object} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'context'?: object; - /** - * A list of override recipient email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'recipientEmailList'?: Array; - /** - * A list of CC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'carbonCopy'?: Array; - /** - * A list of BCC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2024 - */ - 'blindCarbonCopy'?: Array; -} - -export const SendTestNotificationRequestDtoV2024MediumV2024 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type SendTestNotificationRequestDtoV2024MediumV2024 = typeof SendTestNotificationRequestDtoV2024MediumV2024[keyof typeof SendTestNotificationRequestDtoV2024MediumV2024]; - -/** - * - * @export - * @interface ServiceDeskIntegrationDtoV2024 - */ -export interface ServiceDeskIntegrationDtoV2024 { - /** - * Unique identifier for the Service Desk integration - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'id'?: string; - /** - * Service Desk integration\'s name. The name must be unique. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'name': string; - /** - * The date and time the Service Desk integration was created - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'created'?: string; - /** - * The date and time the Service Desk integration was last modified - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'modified'?: string; - /** - * Service Desk integration\'s description. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'description': string; - /** - * Service Desk integration types: - ServiceNowSDIM - ServiceNow - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'type': string; - /** - * - * @type {OwnerDtoV2024} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'ownerRef'?: OwnerDtoV2024; - /** - * - * @type {SourceClusterDtoV2024} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'clusterRef'?: SourceClusterDtoV2024; - /** - * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2024 - * @deprecated - */ - 'cluster'?: string | null; - /** - * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - * @type {Array} - * @memberof ServiceDeskIntegrationDtoV2024 - * @deprecated - */ - 'managedSources'?: Array; - /** - * - * @type {ProvisioningConfigV2024} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'provisioningConfig'?: ProvisioningConfigV2024; - /** - * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {BeforeProvisioningRuleDtoV2024} - * @memberof ServiceDeskIntegrationDtoV2024 - */ - 'beforeProvisioningRule'?: BeforeProvisioningRuleDtoV2024; -} -/** - * - * @export - * @interface ServiceDeskIntegrationTemplateDtoV2024 - */ -export interface ServiceDeskIntegrationTemplateDtoV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'modified'?: string; - /** - * The \'type\' property specifies the type of the Service Desk integration template. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'type': string; - /** - * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {ProvisioningConfigV2024} - * @memberof ServiceDeskIntegrationTemplateDtoV2024 - */ - 'provisioningConfig': ProvisioningConfigV2024; -} -/** - * This represents a Service Desk Integration template type. - * @export - * @interface ServiceDeskIntegrationTemplateTypeV2024 - */ -export interface ServiceDeskIntegrationTemplateTypeV2024 { - /** - * This is the name of the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2024 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2024 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2024 - */ - 'scriptName': string; -} -/** - * Source for Service Desk integration template. - * @export - * @interface ServiceDeskSourceV2024 - */ -export interface ServiceDeskSourceV2024 { - /** - * DTO type of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2024 - */ - 'type'?: ServiceDeskSourceV2024TypeV2024; - /** - * ID of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2024 - */ - 'id'?: string; - /** - * Human-readable name of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2024 - */ - 'name'?: string; -} - -export const ServiceDeskSourceV2024TypeV2024 = { - Source: 'SOURCE' -} as const; - -export type ServiceDeskSourceV2024TypeV2024 = typeof ServiceDeskSourceV2024TypeV2024[keyof typeof ServiceDeskSourceV2024TypeV2024]; - -/** - * - * @export - * @interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ -export interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 { - /** - * Federation protocol role - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerV2024RoleV2024; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2024} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'jitConfiguration'?: JITConfigurationV2024; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'certificateName'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024 - */ - 'legacyAcsUrl'?: string; -} - -export const ServiceProviderConfigurationFederationProtocolDetailsInnerV2024RoleV2024 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type ServiceProviderConfigurationFederationProtocolDetailsInnerV2024RoleV2024 = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024RoleV2024[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2024RoleV2024]; - -/** - * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider - * @export - * @interface ServiceProviderConfigurationV2024 - */ -export interface ServiceProviderConfigurationV2024 { - /** - * This determines whether or not the SAML authentication flow is enabled for an org - * @type {boolean} - * @memberof ServiceProviderConfigurationV2024 - */ - 'enabled'?: boolean; - /** - * This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2024 - */ - 'bypassIdp'?: boolean; - /** - * This indicates whether or not the SAML configuration is valid. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2024 - */ - 'samlConfigurationValid'?: boolean; - /** - * A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). - * @type {Array} - * @memberof ServiceProviderConfigurationV2024 - */ - 'federationProtocolDetails'?: Array; -} -/** - * - * @export - * @interface SessionConfigurationV2024 - */ -export interface SessionConfigurationV2024 { - /** - * The maximum time in minutes a session can be idle. - * @type {number} - * @memberof SessionConfigurationV2024 - */ - 'maxIdleTime'?: number; - /** - * Denotes if \'remember me\' is enabled. - * @type {boolean} - * @memberof SessionConfigurationV2024 - */ - 'rememberMe'?: boolean; - /** - * The maximum allowable session time in minutes. - * @type {number} - * @memberof SessionConfigurationV2024 - */ - 'maxSessionTime'?: number; -} -/** - * - * @export - * @interface SetIcon200ResponseV2024 - */ -export interface SetIcon200ResponseV2024 { - /** - * url to file with icon - * @type {string} - * @memberof SetIcon200ResponseV2024 - */ - 'icon'?: string; -} -/** - * - * @export - * @interface SetIconRequestV2024 - */ -export interface SetIconRequestV2024 { - /** - * file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] - * @type {File} - * @memberof SetIconRequestV2024 - */ - 'image': File; -} -/** - * - * @export - * @interface SetLifecycleState200ResponseV2024 - */ -export interface SetLifecycleState200ResponseV2024 { - /** - * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - * @type {string} - * @memberof SetLifecycleState200ResponseV2024 - */ - 'accountActivityId'?: string; -} -/** - * - * @export - * @interface SetLifecycleStateRequestV2024 - */ -export interface SetLifecycleStateRequestV2024 { - /** - * ID of the lifecycle state to set. - * @type {string} - * @memberof SetLifecycleStateRequestV2024 - */ - 'lifecycleStateId'?: string; -} -/** - * Before provisioning rule of integration - * @export - * @interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024 - */ -export interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024 - */ - 'type'?: DtoTypeV2024; - /** - * ID of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SimIntegrationDetailsV2024 - */ -export interface SimIntegrationDetailsV2024 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'modified'?: string; - /** - * The description of the integration - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'description'?: string; - /** - * The integration type - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'type'?: string; - /** - * The attributes map containing the credentials used to configure the integration. - * @type {object} - * @memberof SimIntegrationDetailsV2024 - */ - 'attributes'?: object | null; - /** - * The list of sources (managed resources) - * @type {Array} - * @memberof SimIntegrationDetailsV2024 - */ - 'sources'?: Array; - /** - * The cluster/proxy - * @type {string} - * @memberof SimIntegrationDetailsV2024 - */ - 'cluster'?: string; - /** - * Custom mapping between the integration result and the provisioning result - * @type {object} - * @memberof SimIntegrationDetailsV2024 - */ - 'statusMap'?: object; - /** - * Request data to customize desc and body of the created ticket - * @type {object} - * @memberof SimIntegrationDetailsV2024 - */ - 'request'?: object; - /** - * - * @type {SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024} - * @memberof SimIntegrationDetailsV2024 - */ - 'beforeProvisioningRule'?: SimIntegrationDetailsAllOfBeforeProvisioningRuleV2024; -} -/** - * - * @export - * @interface SlimCampaignV2024 - */ -export interface SlimCampaignV2024 { - /** - * Id of the campaign - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'type': SlimCampaignV2024TypeV2024; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof SlimCampaignV2024 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof SlimCampaignV2024 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof SlimCampaignV2024 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'status'?: SlimCampaignV2024StatusV2024 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'correlatedStatus'?: SlimCampaignV2024CorrelatedStatusV2024; - /** - * Created time of the campaign - * @type {string} - * @memberof SlimCampaignV2024 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2024 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2024 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof SlimCampaignV2024 - */ - 'alerts'?: Array | null; -} - -export const SlimCampaignV2024TypeV2024 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type SlimCampaignV2024TypeV2024 = typeof SlimCampaignV2024TypeV2024[keyof typeof SlimCampaignV2024TypeV2024]; -export const SlimCampaignV2024StatusV2024 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type SlimCampaignV2024StatusV2024 = typeof SlimCampaignV2024StatusV2024[keyof typeof SlimCampaignV2024StatusV2024]; -export const SlimCampaignV2024CorrelatedStatusV2024 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type SlimCampaignV2024CorrelatedStatusV2024 = typeof SlimCampaignV2024CorrelatedStatusV2024[keyof typeof SlimCampaignV2024CorrelatedStatusV2024]; - -/** - * Discovered applications - * @export - * @interface SlimDiscoveredApplicationsV2024 - */ -export interface SlimDiscoveredApplicationsV2024 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'status'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2024 - */ - 'riskLevel'?: SlimDiscoveredApplicationsV2024RiskLevelV2024; -} - -export const SlimDiscoveredApplicationsV2024RiskLevelV2024 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type SlimDiscoveredApplicationsV2024RiskLevelV2024 = typeof SlimDiscoveredApplicationsV2024RiskLevelV2024[keyof typeof SlimDiscoveredApplicationsV2024RiskLevelV2024]; - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteriaV2024 - */ -export interface SodExemptCriteriaV2024 { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteriaV2024 - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeV2024} - * @memberof SodExemptCriteriaV2024 - */ - 'type'?: DtoTypeV2024; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteriaV2024 - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteriaV2024 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SodPolicyConflictingAccessCriteriaV2024 - */ -export interface SodPolicyConflictingAccessCriteriaV2024 { - /** - * - * @type {AccessCriteriaV2024} - * @memberof SodPolicyConflictingAccessCriteriaV2024 - */ - 'leftCriteria'?: AccessCriteriaV2024; - /** - * - * @type {AccessCriteriaV2024} - * @memberof SodPolicyConflictingAccessCriteriaV2024 - */ - 'rightCriteria'?: AccessCriteriaV2024; -} -/** - * SOD policy. - * @export - * @interface SodPolicyDto1V2024 - */ -export interface SodPolicyDto1V2024 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto1V2024 - */ - 'type'?: SodPolicyDto1V2024TypeV2024; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto1V2024 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto1V2024 - */ - 'name'?: string; -} - -export const SodPolicyDto1V2024TypeV2024 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDto1V2024TypeV2024 = typeof SodPolicyDto1V2024TypeV2024[keyof typeof SodPolicyDto1V2024TypeV2024]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDtoV2024 - */ -export interface SodPolicyDtoV2024 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDtoV2024 - */ - 'type'?: SodPolicyDtoV2024TypeV2024; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDtoV2024 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDtoV2024 - */ - 'name'?: string; -} - -export const SodPolicyDtoV2024TypeV2024 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDtoV2024TypeV2024 = typeof SodPolicyDtoV2024TypeV2024[keyof typeof SodPolicyDtoV2024TypeV2024]; - -/** - * The owner of the SOD policy. - * @export - * @interface SodPolicyOwnerRefV2024 - */ -export interface SodPolicyOwnerRefV2024 { - /** - * Owner type. - * @type {string} - * @memberof SodPolicyOwnerRefV2024 - */ - 'type'?: SodPolicyOwnerRefV2024TypeV2024; - /** - * Owner\'s ID. - * @type {string} - * @memberof SodPolicyOwnerRefV2024 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof SodPolicyOwnerRefV2024 - */ - 'name'?: string; -} - -export const SodPolicyOwnerRefV2024TypeV2024 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SodPolicyOwnerRefV2024TypeV2024 = typeof SodPolicyOwnerRefV2024TypeV2024[keyof typeof SodPolicyOwnerRefV2024TypeV2024]; - -/** - * - * @export - * @interface SodPolicyScheduleV2024 - */ -export interface SodPolicyScheduleV2024 { - /** - * SOD Policy schedule name - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'name'?: string; - /** - * The time when this SOD policy schedule is created. - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'created'?: string; - /** - * The time when this SOD policy schedule is modified. - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'modified'?: string; - /** - * SOD Policy schedule description - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'description'?: string; - /** - * - * @type {Schedule2V2024} - * @memberof SodPolicyScheduleV2024 - */ - 'schedule'?: Schedule2V2024; - /** - * - * @type {Array} - * @memberof SodPolicyScheduleV2024 - */ - 'recipients'?: Array; - /** - * Indicates if empty results need to be emailed - * @type {boolean} - * @memberof SodPolicyScheduleV2024 - */ - 'emailEmptyResults'?: boolean; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyScheduleV2024 - */ - 'modifierId'?: string; -} -/** - * - * @export - * @interface SodPolicyV2024 - */ -export interface SodPolicyV2024 { - /** - * Policy id - * @type {string} - * @memberof SodPolicyV2024 - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicyV2024 - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyV2024 - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyV2024 - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicyV2024 - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRefV2024} - * @memberof SodPolicyV2024 - */ - 'ownerRef'?: SodPolicyOwnerRefV2024; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicyV2024 - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicyV2024 - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicyV2024 - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicyV2024 - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicyV2024 - */ - 'state'?: SodPolicyV2024StateV2024; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicyV2024 - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyV2024 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyV2024 - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfigV2024} - * @memberof SodPolicyV2024 - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfigV2024; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicyV2024 - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicyV2024 - */ - 'type'?: SodPolicyV2024TypeV2024; - /** - * - * @type {SodPolicyConflictingAccessCriteriaV2024} - * @memberof SodPolicyV2024 - */ - 'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteriaV2024; -} - -export const SodPolicyV2024StateV2024 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyV2024StateV2024 = typeof SodPolicyV2024StateV2024[keyof typeof SodPolicyV2024StateV2024]; -export const SodPolicyV2024TypeV2024 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyV2024TypeV2024 = typeof SodPolicyV2024TypeV2024[keyof typeof SodPolicyV2024TypeV2024]; - -/** - * SOD policy recipient. - * @export - * @interface SodRecipientV2024 - */ -export interface SodRecipientV2024 { - /** - * SOD policy recipient DTO type. - * @type {string} - * @memberof SodRecipientV2024 - */ - 'type'?: SodRecipientV2024TypeV2024; - /** - * SOD policy recipient\'s identity ID. - * @type {string} - * @memberof SodRecipientV2024 - */ - 'id'?: string; - /** - * SOD policy recipient\'s display name. - * @type {string} - * @memberof SodRecipientV2024 - */ - 'name'?: string; -} - -export const SodRecipientV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SodRecipientV2024TypeV2024 = typeof SodRecipientV2024TypeV2024[keyof typeof SodRecipientV2024TypeV2024]; - -/** - * SOD policy violation report result. - * @export - * @interface SodReportResultDtoV2024 - */ -export interface SodReportResultDtoV2024 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof SodReportResultDtoV2024 - */ - 'type'?: SodReportResultDtoV2024TypeV2024; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof SodReportResultDtoV2024 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof SodReportResultDtoV2024 - */ - 'name'?: string; -} - -export const SodReportResultDtoV2024TypeV2024 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type SodReportResultDtoV2024TypeV2024 = typeof SodReportResultDtoV2024TypeV2024[keyof typeof SodReportResultDtoV2024TypeV2024]; - -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResultV2024 - */ -export interface SodViolationCheckResultV2024 { - /** - * - * @type {ErrorMessageDtoV2024} - * @memberof SodViolationCheckResultV2024 - */ - 'message'?: ErrorMessageDtoV2024; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResultV2024 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResultV2024 - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResultV2024 - */ - 'violatedPolicies'?: Array | null; -} -/** - * An object referencing an SOD violation check - * @export - * @interface SodViolationCheckV2024 - */ -export interface SodViolationCheckV2024 { - /** - * The id of the original request - * @type {string} - * @memberof SodViolationCheckV2024 - */ - 'requestId': string; - /** - * The date-time when this request was created. - * @type {string} - * @memberof SodViolationCheckV2024 - */ - 'created'?: string; -} -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompletedV2024 - */ -export interface SodViolationContextCheckCompletedV2024 { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompletedV2024 - */ - 'state'?: SodViolationContextCheckCompletedV2024StateV2024 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompletedV2024 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2024} - * @memberof SodViolationContextCheckCompletedV2024 - */ - 'violationCheckResult'?: SodViolationCheckResultV2024; -} - -export const SodViolationContextCheckCompletedV2024StateV2024 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompletedV2024StateV2024 = typeof SodViolationContextCheckCompletedV2024StateV2024[keyof typeof SodViolationContextCheckCompletedV2024StateV2024]; - -/** - * - * @export - * @interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024 - */ -export interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024 { - /** - * - * @type {Array} - * @memberof SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024 - */ - 'criteriaList'?: Array; -} -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContextConflictingAccessCriteriaV2024 - */ -export interface SodViolationContextConflictingAccessCriteriaV2024 { - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024} - * @memberof SodViolationContextConflictingAccessCriteriaV2024 - */ - 'leftCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024} - * @memberof SodViolationContextConflictingAccessCriteriaV2024 - */ - 'rightCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2024; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContextV2024 - */ -export interface SodViolationContextV2024 { - /** - * - * @type {SodPolicyDto1V2024} - * @memberof SodViolationContextV2024 - */ - 'policy'?: SodPolicyDto1V2024; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaV2024} - * @memberof SodViolationContextV2024 - */ - 'conflictingAccessCriteria'?: SodViolationContextConflictingAccessCriteriaV2024; -} -/** - * - * @export - * @interface Source1V2024 - */ -export interface Source1V2024 { - /** - * Attribute mapping type. - * @type {string} - * @memberof Source1V2024 - */ - 'type'?: string; - /** - * Attribute mapping properties. - * @type {object} - * @memberof Source1V2024 - */ - 'properties'?: object; -} -/** - * Reference to account correlation config object. - * @export - * @interface SourceAccountCorrelationConfigV2024 - */ -export interface SourceAccountCorrelationConfigV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2024 - */ - 'type'?: SourceAccountCorrelationConfigV2024TypeV2024; - /** - * Account correlation config ID. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2024 - */ - 'id'?: string; - /** - * Account correlation config\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2024 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationConfigV2024TypeV2024 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' -} as const; - -export type SourceAccountCorrelationConfigV2024TypeV2024 = typeof SourceAccountCorrelationConfigV2024TypeV2024[keyof typeof SourceAccountCorrelationConfigV2024TypeV2024]; - -/** - * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. - * @export - * @interface SourceAccountCorrelationRuleV2024 - */ -export interface SourceAccountCorrelationRuleV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2024 - */ - 'type'?: SourceAccountCorrelationRuleV2024TypeV2024; - /** - * Rule ID. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2024 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2024 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationRuleV2024TypeV2024 = { - Rule: 'RULE' -} as const; - -export type SourceAccountCorrelationRuleV2024TypeV2024 = typeof SourceAccountCorrelationRuleV2024TypeV2024[keyof typeof SourceAccountCorrelationRuleV2024TypeV2024]; - -/** - * - * @export - * @interface SourceAccountCreatedV2024 - */ -export interface SourceAccountCreatedV2024 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2024 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountCreatedV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountDeletedV2024 - */ -export interface SourceAccountDeletedV2024 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2024 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountDeletedV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountSelectionsV2024 - */ -export interface SourceAccountSelectionsV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof SourceAccountSelectionsV2024 - */ - 'type'?: DtoTypeV2024; - /** - * The source id - * @type {string} - * @memberof SourceAccountSelectionsV2024 - */ - 'id'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAccountSelectionsV2024 - */ - 'name'?: string; - /** - * The accounts information for a particular source in the requested item - * @type {Array} - * @memberof SourceAccountSelectionsV2024 - */ - 'accounts'?: Array; -} - - -/** - * - * @export - * @interface SourceAccountUpdatedV2024 - */ -export interface SourceAccountUpdatedV2024 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2024 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountUpdatedV2024 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAppAccountSourceV2024 - */ -export interface SourceAppAccountSourceV2024 { - /** - * The source ID - * @type {string} - * @memberof SourceAppAccountSourceV2024 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppAccountSourceV2024 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppAccountSourceV2024 - */ - 'name'?: string; - /** - * If the source is used for password management - * @type {boolean} - * @memberof SourceAppAccountSourceV2024 - */ - 'useForPasswordManagement'?: boolean; - /** - * The password policies for the source - * @type {Array} - * @memberof SourceAppAccountSourceV2024 - */ - 'passwordPolicies'?: Array | null; -} -/** - * - * @export - * @interface SourceAppBulkUpdateRequestV2024 - */ -export interface SourceAppBulkUpdateRequestV2024 { - /** - * List of source app ids to update - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2024 - */ - 'appIds': Array; - /** - * The JSONPatch payload used to update the source app. - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2024 - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface SourceAppCreateDtoAccountSourceV2024 - */ -export interface SourceAppCreateDtoAccountSourceV2024 { - /** - * The source ID - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2024 - */ - 'id': string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2024 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface SourceAppCreateDtoV2024 - */ -export interface SourceAppCreateDtoV2024 { - /** - * The source app name - * @type {string} - * @memberof SourceAppCreateDtoV2024 - */ - 'name': string; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppCreateDtoV2024 - */ - 'description': string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppCreateDtoV2024 - */ - 'matchAllAccounts'?: boolean; - /** - * - * @type {SourceAppCreateDtoAccountSourceV2024} - * @memberof SourceAppCreateDtoV2024 - */ - 'accountSource': SourceAppCreateDtoAccountSourceV2024; -} -/** - * - * @export - * @interface SourceAppPatchDtoV2024 - */ -export interface SourceAppPatchDtoV2024 { - /** - * The source app id - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppPatchDtoV2024 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppPatchDtoV2024 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppPatchDtoV2024 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppPatchDtoV2024 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppPatchDtoV2024 - */ - 'appCenterEnabled'?: boolean; - /** - * List of IDs of access profiles - * @type {Array} - * @memberof SourceAppPatchDtoV2024 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {SourceAppAccountSourceV2024} - * @memberof SourceAppPatchDtoV2024 - */ - 'accountSource'?: SourceAppAccountSourceV2024 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2024} - * @memberof SourceAppPatchDtoV2024 - */ - 'owner'?: BaseReferenceDtoV2024 | null; -} -/** - * - * @export - * @interface SourceAppV2024 - */ -export interface SourceAppV2024 { - /** - * The source app id - * @type {string} - * @memberof SourceAppV2024 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppV2024 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppV2024 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppV2024 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppV2024 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppV2024 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppV2024 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppV2024 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppV2024 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppV2024 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {SourceAppAccountSourceV2024} - * @memberof SourceAppV2024 - */ - 'accountSource'?: SourceAppAccountSourceV2024 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2024} - * @memberof SourceAppV2024 - */ - 'owner'?: BaseReferenceDtoV2024 | null; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface SourceBeforeProvisioningRuleV2024 - */ -export interface SourceBeforeProvisioningRuleV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2024 - */ - 'type'?: SourceBeforeProvisioningRuleV2024TypeV2024; - /** - * Rule ID. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2024 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2024 - */ - 'name'?: string; -} - -export const SourceBeforeProvisioningRuleV2024TypeV2024 = { - Rule: 'RULE' -} as const; - -export type SourceBeforeProvisioningRuleV2024TypeV2024 = typeof SourceBeforeProvisioningRuleV2024TypeV2024[keyof typeof SourceBeforeProvisioningRuleV2024TypeV2024]; - -/** - * Source cluster. - * @export - * @interface SourceClusterDtoV2024 - */ -export interface SourceClusterDtoV2024 { - /** - * Source cluster DTO type. - * @type {string} - * @memberof SourceClusterDtoV2024 - */ - 'type'?: SourceClusterDtoV2024TypeV2024; - /** - * Source cluster ID. - * @type {string} - * @memberof SourceClusterDtoV2024 - */ - 'id'?: string; - /** - * Source cluster display name. - * @type {string} - * @memberof SourceClusterDtoV2024 - */ - 'name'?: string; -} - -export const SourceClusterDtoV2024TypeV2024 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterDtoV2024TypeV2024 = typeof SourceClusterDtoV2024TypeV2024[keyof typeof SourceClusterDtoV2024TypeV2024]; - -/** - * Reference to the source\'s associated cluster. - * @export - * @interface SourceClusterV2024 - */ -export interface SourceClusterV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceClusterV2024 - */ - 'type': SourceClusterV2024TypeV2024; - /** - * Cluster ID. - * @type {string} - * @memberof SourceClusterV2024 - */ - 'id': string; - /** - * Cluster\'s human-readable display name. - * @type {string} - * @memberof SourceClusterV2024 - */ - 'name': string; -} - -export const SourceClusterV2024TypeV2024 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterV2024TypeV2024 = typeof SourceClusterV2024TypeV2024[keyof typeof SourceClusterV2024TypeV2024]; - -/** - * SourceCode - * @export - * @interface SourceCodeV2024 - */ -export interface SourceCodeV2024 { - /** - * the version of the code - * @type {string} - * @memberof SourceCodeV2024 - */ - 'version': string; - /** - * The code - * @type {string} - * @memberof SourceCodeV2024 - */ - 'script': string; -} -/** - * - * @export - * @interface SourceConnectionsDtoV2024 - */ -export interface SourceConnectionsDtoV2024 { - /** - * The IdentityProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'identityProfiles'?: Array; - /** - * Name of the CredentialProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'credentialProfiles'?: Array; - /** - * The attributes attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'sourceAttributes'?: Array; - /** - * The profiles attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'mappingProfiles'?: Array; - /** - * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'dependentCustomTransforms'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'dependentApps'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2024 - */ - 'missingDependents'?: Array; -} -/** - * Identity who created the source. - * @export - * @interface SourceCreatedActorV2024 - */ -export interface SourceCreatedActorV2024 { - /** - * DTO type of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2024 - */ - 'type': SourceCreatedActorV2024TypeV2024; - /** - * ID of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2024 - */ - 'id': string; - /** - * Display name of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2024 - */ - 'name': string; -} - -export const SourceCreatedActorV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SourceCreatedActorV2024TypeV2024 = typeof SourceCreatedActorV2024TypeV2024[keyof typeof SourceCreatedActorV2024TypeV2024]; - -/** - * - * @export - * @interface SourceCreatedV2024 - */ -export interface SourceCreatedV2024 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceCreatedV2024 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceCreatedV2024 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceCreatedV2024 - */ - 'type': string; - /** - * The date and time the source was created. - * @type {string} - * @memberof SourceCreatedV2024 - */ - 'created': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceCreatedV2024 - */ - 'connector': string; - /** - * - * @type {SourceCreatedActorV2024} - * @memberof SourceCreatedV2024 - */ - 'actor': SourceCreatedActorV2024; -} -/** - * - * @export - * @interface SourceCreationErrorsV2024 - */ -export interface SourceCreationErrorsV2024 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'multihostId'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'source_name'?: string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'source_error'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'modified'?: string; - /** - * operation category (e.g. DELETE). - * @type {string} - * @memberof SourceCreationErrorsV2024 - */ - 'operation'?: string | null; -} -/** - * Identity who deleted the source. - * @export - * @interface SourceDeletedActorV2024 - */ -export interface SourceDeletedActorV2024 { - /** - * DTO type of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2024 - */ - 'type': SourceDeletedActorV2024TypeV2024; - /** - * ID of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2024 - */ - 'id': string; - /** - * Display name of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2024 - */ - 'name': string; -} - -export const SourceDeletedActorV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SourceDeletedActorV2024TypeV2024 = typeof SourceDeletedActorV2024TypeV2024[keyof typeof SourceDeletedActorV2024TypeV2024]; - -/** - * - * @export - * @interface SourceDeletedV2024 - */ -export interface SourceDeletedV2024 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceDeletedV2024 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceDeletedV2024 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceDeletedV2024 - */ - 'type': string; - /** - * The date and time the source was deleted. - * @type {string} - * @memberof SourceDeletedV2024 - */ - 'deleted': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceDeletedV2024 - */ - 'connector': string; - /** - * - * @type {SourceDeletedActorV2024} - * @memberof SourceDeletedV2024 - */ - 'actor': SourceDeletedActorV2024; -} -/** - * Entitlement Request Configuration - * @export - * @interface SourceEntitlementRequestConfigV2024 - */ -export interface SourceEntitlementRequestConfigV2024 { - /** - * - * @type {EntitlementAccessRequestConfigV2024} - * @memberof SourceEntitlementRequestConfigV2024 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2024; - /** - * - * @type {EntitlementRevocationRequestConfigV2024} - * @memberof SourceEntitlementRequestConfigV2024 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2024; -} -/** - * Dto for source health data - * @export - * @interface SourceHealthDtoV2024 - */ -export interface SourceHealthDtoV2024 { - /** - * the id of the Source - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'id'?: string; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'type'?: string; - /** - * the name of the source - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'name'?: string; - /** - * source\'s org - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'org'?: string; - /** - * Is the source authoritative - * @type {boolean} - * @memberof SourceHealthDtoV2024 - */ - 'isAuthoritative'?: boolean; - /** - * Is the source in a cluster - * @type {boolean} - * @memberof SourceHealthDtoV2024 - */ - 'isCluster'?: boolean; - /** - * source\'s hostname - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'hostname'?: string; - /** - * source\'s pod - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'pod'?: string; - /** - * The version of the iqService - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'iqServiceVersion'?: string | null; - /** - * connection test result - * @type {string} - * @memberof SourceHealthDtoV2024 - */ - 'status'?: SourceHealthDtoV2024StatusV2024; -} - -export const SourceHealthDtoV2024StatusV2024 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type SourceHealthDtoV2024StatusV2024 = typeof SourceHealthDtoV2024StatusV2024[keyof typeof SourceHealthDtoV2024StatusV2024]; - -/** - * - * @export - * @interface SourceItemRefV2024 - */ -export interface SourceItemRefV2024 { - /** - * The id for the source on which account selections are made - * @type {string} - * @memberof SourceItemRefV2024 - */ - 'sourceId'?: string | null; - /** - * A list of account selections on the source. Currently, only one selection per source is supported. - * @type {Array} - * @memberof SourceItemRefV2024 - */ - 'accounts'?: Array | null; -} -/** - * Reference to management workgroup for the source. - * @export - * @interface SourceManagementWorkgroupV2024 - */ -export interface SourceManagementWorkgroupV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagementWorkgroupV2024 - */ - 'type'?: SourceManagementWorkgroupV2024TypeV2024; - /** - * Management workgroup ID. - * @type {string} - * @memberof SourceManagementWorkgroupV2024 - */ - 'id'?: string; - /** - * Management workgroup\'s human-readable display name. - * @type {string} - * @memberof SourceManagementWorkgroupV2024 - */ - 'name'?: string; -} - -export const SourceManagementWorkgroupV2024TypeV2024 = { - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SourceManagementWorkgroupV2024TypeV2024 = typeof SourceManagementWorkgroupV2024TypeV2024[keyof typeof SourceManagementWorkgroupV2024TypeV2024]; - -/** - * - * @export - * @interface SourceManagerCorrelationMappingV2024 - */ -export interface SourceManagerCorrelationMappingV2024 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2024 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2024 - */ - 'identityAttributeName'?: string; -} -/** - * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. - * @export - * @interface SourceManagerCorrelationRuleV2024 - */ -export interface SourceManagerCorrelationRuleV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2024 - */ - 'type'?: SourceManagerCorrelationRuleV2024TypeV2024; - /** - * Rule ID. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2024 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2024 - */ - 'name'?: string; -} - -export const SourceManagerCorrelationRuleV2024TypeV2024 = { - Rule: 'RULE' -} as const; - -export type SourceManagerCorrelationRuleV2024TypeV2024 = typeof SourceManagerCorrelationRuleV2024TypeV2024[keyof typeof SourceManagerCorrelationRuleV2024TypeV2024]; - -/** - * Reference to identity object who owns the source. - * @export - * @interface SourceOwnerV2024 - */ -export interface SourceOwnerV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceOwnerV2024 - */ - 'type'?: SourceOwnerV2024TypeV2024; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof SourceOwnerV2024 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof SourceOwnerV2024 - */ - 'name'?: string; -} - -export const SourceOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SourceOwnerV2024TypeV2024 = typeof SourceOwnerV2024TypeV2024[keyof typeof SourceOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface SourcePasswordPoliciesInnerV2024 - */ -export interface SourcePasswordPoliciesInnerV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2024 - */ - 'type'?: SourcePasswordPoliciesInnerV2024TypeV2024; - /** - * Policy ID. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2024 - */ - 'id'?: string; - /** - * Policy\'s human-readable display name. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2024 - */ - 'name'?: string; -} - -export const SourcePasswordPoliciesInnerV2024TypeV2024 = { - PasswordPolicy: 'PASSWORD_POLICY' -} as const; - -export type SourcePasswordPoliciesInnerV2024TypeV2024 = typeof SourcePasswordPoliciesInnerV2024TypeV2024[keyof typeof SourcePasswordPoliciesInnerV2024TypeV2024]; - -/** - * - * @export - * @interface SourceScheduleV2024 - */ -export interface SourceScheduleV2024 { - /** - * The type of the Schedule. - * @type {string} - * @memberof SourceScheduleV2024 - */ - 'type': SourceScheduleV2024TypeV2024; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof SourceScheduleV2024 - */ - 'cronExpression': string; -} - -export const SourceScheduleV2024TypeV2024 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type SourceScheduleV2024TypeV2024 = typeof SourceScheduleV2024TypeV2024[keyof typeof SourceScheduleV2024TypeV2024]; - -/** - * - * @export - * @interface SourceSchemasInnerV2024 - */ -export interface SourceSchemasInnerV2024 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceSchemasInnerV2024 - */ - 'type'?: SourceSchemasInnerV2024TypeV2024; - /** - * Schema ID. - * @type {string} - * @memberof SourceSchemasInnerV2024 - */ - 'id'?: string; - /** - * Schema\'s human-readable display name. - * @type {string} - * @memberof SourceSchemasInnerV2024 - */ - 'name'?: string; -} - -export const SourceSchemasInnerV2024TypeV2024 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type SourceSchemasInnerV2024TypeV2024 = typeof SourceSchemasInnerV2024TypeV2024[keyof typeof SourceSchemasInnerV2024TypeV2024]; - -/** - * - * @export - * @interface SourceSyncJobV2024 - */ -export interface SourceSyncJobV2024 { - /** - * Job ID. - * @type {string} - * @memberof SourceSyncJobV2024 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof SourceSyncJobV2024 - */ - 'status': SourceSyncJobV2024StatusV2024; - /** - * - * @type {SourceSyncPayloadV2024} - * @memberof SourceSyncJobV2024 - */ - 'payload': SourceSyncPayloadV2024; -} - -export const SourceSyncJobV2024StatusV2024 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SourceSyncJobV2024StatusV2024 = typeof SourceSyncJobV2024StatusV2024[keyof typeof SourceSyncJobV2024StatusV2024]; - -/** - * - * @export - * @interface SourceSyncPayloadV2024 - */ -export interface SourceSyncPayloadV2024 { - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2024 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2024 - */ - 'dataJson': string; -} -/** - * Identity who updated the source. - * @export - * @interface SourceUpdatedActorV2024 - */ -export interface SourceUpdatedActorV2024 { - /** - * DTO type of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2024 - */ - 'type': SourceUpdatedActorV2024TypeV2024; - /** - * ID of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2024 - */ - 'id'?: string; - /** - * Display name of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2024 - */ - 'name': string; -} - -export const SourceUpdatedActorV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type SourceUpdatedActorV2024TypeV2024 = typeof SourceUpdatedActorV2024TypeV2024[keyof typeof SourceUpdatedActorV2024TypeV2024]; - -/** - * - * @export - * @interface SourceUpdatedV2024 - */ -export interface SourceUpdatedV2024 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceUpdatedV2024 - */ - 'id': string; - /** - * The user friendly name of the source. - * @type {string} - * @memberof SourceUpdatedV2024 - */ - 'name': string; - /** - * The connection type of the source. - * @type {string} - * @memberof SourceUpdatedV2024 - */ - 'type': string; - /** - * The date and time the source was modified. - * @type {string} - * @memberof SourceUpdatedV2024 - */ - 'modified': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceUpdatedV2024 - */ - 'connector': string; - /** - * - * @type {SourceUpdatedActorV2024} - * @memberof SourceUpdatedV2024 - */ - 'actor': SourceUpdatedActorV2024; -} -/** - * - * @export - * @interface SourceUsageStatusV2024 - */ -export interface SourceUsageStatusV2024 { - /** - * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. - * @type {string} - * @memberof SourceUsageStatusV2024 - */ - 'status'?: SourceUsageStatusV2024StatusV2024; -} - -export const SourceUsageStatusV2024StatusV2024 = { - Complete: 'COMPLETE', - Incomplete: 'INCOMPLETE' -} as const; - -export type SourceUsageStatusV2024StatusV2024 = typeof SourceUsageStatusV2024StatusV2024[keyof typeof SourceUsageStatusV2024StatusV2024]; - -/** - * - * @export - * @interface SourceUsageV2024 - */ -export interface SourceUsageV2024 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof SourceUsageV2024 - */ - 'date'?: string; - /** - * The average number of days that accounts were active within this source, for the month. - * @type {number} - * @memberof SourceUsageV2024 - */ - 'count'?: number; -} -/** - * - * @export - * @interface SourceV2024 - */ -export interface SourceV2024 { - /** - * Source ID. - * @type {string} - * @memberof SourceV2024 - */ - 'id'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceV2024 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceV2024 - */ - 'description'?: string; - /** - * - * @type {SourceOwnerV2024} - * @memberof SourceV2024 - */ - 'owner': SourceOwnerV2024 | null; - /** - * - * @type {SourceClusterV2024} - * @memberof SourceV2024 - */ - 'cluster'?: SourceClusterV2024 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2024} - * @memberof SourceV2024 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2024 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2024} - * @memberof SourceV2024 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2024 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2024} - * @memberof SourceV2024 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2024; - /** - * - * @type {SourceManagerCorrelationRuleV2024} - * @memberof SourceV2024 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2024 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2024} - * @memberof SourceV2024 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2024 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof SourceV2024 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof SourceV2024 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SourceV2024 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceV2024 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof SourceV2024 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof SourceV2024 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {object} - * @memberof SourceV2024 - */ - 'connectorAttributes'?: object; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof SourceV2024 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof SourceV2024 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2024} - * @memberof SourceV2024 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2024 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof SourceV2024 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof SourceV2024 - */ - 'status'?: SourceV2024StatusV2024; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof SourceV2024 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof SourceV2024 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof SourceV2024 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof SourceV2024 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof SourceV2024 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceV2024 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceV2024 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof SourceV2024 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof SourceV2024 - */ - 'category'?: string | null; -} - -export const SourceV2024FeaturesV2024 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SourceV2024FeaturesV2024 = typeof SourceV2024FeaturesV2024[keyof typeof SourceV2024FeaturesV2024]; -export const SourceV2024StatusV2024 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceV2024StatusV2024 = typeof SourceV2024StatusV2024[keyof typeof SourceV2024StatusV2024]; - -/** - * - * @export - * @interface SpConfigExportJobStatusV2024 - */ -export interface SpConfigExportJobStatusV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'status': SpConfigExportJobStatusV2024StatusV2024; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'type': SpConfigExportJobStatusV2024TypeV2024; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'description'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigExportJobStatusV2024 - */ - 'completed'?: string; -} - -export const SpConfigExportJobStatusV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobStatusV2024StatusV2024 = typeof SpConfigExportJobStatusV2024StatusV2024[keyof typeof SpConfigExportJobStatusV2024StatusV2024]; -export const SpConfigExportJobStatusV2024TypeV2024 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobStatusV2024TypeV2024 = typeof SpConfigExportJobStatusV2024TypeV2024[keyof typeof SpConfigExportJobStatusV2024TypeV2024]; - -/** - * - * @export - * @interface SpConfigExportJobV2024 - */ -export interface SpConfigExportJobV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'status': SpConfigExportJobV2024StatusV2024; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'type': SpConfigExportJobV2024TypeV2024; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobV2024 - */ - 'description'?: string; -} - -export const SpConfigExportJobV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobV2024StatusV2024 = typeof SpConfigExportJobV2024StatusV2024[keyof typeof SpConfigExportJobV2024StatusV2024]; -export const SpConfigExportJobV2024TypeV2024 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobV2024TypeV2024 = typeof SpConfigExportJobV2024TypeV2024[keyof typeof SpConfigExportJobV2024TypeV2024]; - -/** - * Response model for config export download response. - * @export - * @interface SpConfigExportResultsV2024 - */ -export interface SpConfigExportResultsV2024 { - /** - * Current version of the export results object. - * @type {number} - * @memberof SpConfigExportResultsV2024 - */ - 'version'?: number; - /** - * Time the export was completed. - * @type {string} - * @memberof SpConfigExportResultsV2024 - */ - 'timestamp'?: string; - /** - * Name of the tenant where this export originated. - * @type {string} - * @memberof SpConfigExportResultsV2024 - */ - 'tenant'?: string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportResultsV2024 - */ - 'description'?: string; - /** - * - * @type {ExportOptions1V2024} - * @memberof SpConfigExportResultsV2024 - */ - 'options'?: ExportOptions1V2024; - /** - * - * @type {Array} - * @memberof SpConfigExportResultsV2024 - */ - 'objects'?: Array; -} -/** - * - * @export - * @interface SpConfigImportJobStatusV2024 - */ -export interface SpConfigImportJobStatusV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'status': SpConfigImportJobStatusV2024StatusV2024; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'type': SpConfigImportJobStatusV2024TypeV2024; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'modified': string; - /** - * This message contains additional information about the overall status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'message'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigImportJobStatusV2024 - */ - 'completed'?: string; -} - -export const SpConfigImportJobStatusV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigImportJobStatusV2024StatusV2024 = typeof SpConfigImportJobStatusV2024StatusV2024[keyof typeof SpConfigImportJobStatusV2024StatusV2024]; -export const SpConfigImportJobStatusV2024TypeV2024 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigImportJobStatusV2024TypeV2024 = typeof SpConfigImportJobStatusV2024TypeV2024[keyof typeof SpConfigImportJobStatusV2024TypeV2024]; - -/** - * Response Body for Config Import command. - * @export - * @interface SpConfigImportResultsV2024 - */ -export interface SpConfigImportResultsV2024 { - /** - * The results of an object configuration import job. - * @type {{ [key: string]: ObjectImportResult1V2024; }} - * @memberof SpConfigImportResultsV2024 - */ - 'results': { [key: string]: ObjectImportResult1V2024; }; - /** - * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. - * @type {string} - * @memberof SpConfigImportResultsV2024 - */ - 'exportJobId'?: string; -} -/** - * - * @export - * @interface SpConfigJobV2024 - */ -export interface SpConfigJobV2024 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'status': SpConfigJobV2024StatusV2024; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'type': SpConfigJobV2024TypeV2024; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigJobV2024 - */ - 'modified': string; -} - -export const SpConfigJobV2024StatusV2024 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigJobV2024StatusV2024 = typeof SpConfigJobV2024StatusV2024[keyof typeof SpConfigJobV2024StatusV2024]; -export const SpConfigJobV2024TypeV2024 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigJobV2024TypeV2024 = typeof SpConfigJobV2024TypeV2024[keyof typeof SpConfigJobV2024TypeV2024]; - -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessage1V2024 - */ -export interface SpConfigMessage1V2024 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessage1V2024 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessage1V2024 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: object; }} - * @memberof SpConfigMessage1V2024 - */ - 'details': { [key: string]: object; }; -} -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessageV2024 - */ -export interface SpConfigMessageV2024 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessageV2024 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessageV2024 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: any; }} - * @memberof SpConfigMessageV2024 - */ - 'details': { [key: string]: any; }; -} -/** - * Response model for object configuration. - * @export - * @interface SpConfigObjectV2024 - */ -export interface SpConfigObjectV2024 { - /** - * Object type the configuration is for. - * @type {string} - * @memberof SpConfigObjectV2024 - */ - 'objectType'?: string; - /** - * List of JSON paths within an exported object of this type, representing references that must be resolved. - * @type {Array} - * @memberof SpConfigObjectV2024 - */ - 'referenceExtractors'?: Array | null; - /** - * Indicates whether this type of object will be JWS signed and cannot be modified before import. - * @type {boolean} - * @memberof SpConfigObjectV2024 - */ - 'signatureRequired'?: boolean; - /** - * Indicates whether this object type must be always be resolved by ID. - * @type {boolean} - * @memberof SpConfigObjectV2024 - */ - 'alwaysResolveById'?: boolean; - /** - * Indicates whether this is a legacy object. - * @type {boolean} - * @memberof SpConfigObjectV2024 - */ - 'legacyObject'?: boolean; - /** - * Indicates whether there is only one object of this type. - * @type {boolean} - * @memberof SpConfigObjectV2024 - */ - 'onePerTenant'?: boolean; - /** - * Indicates whether the object can be exported or is just a reference object. - * @type {boolean} - * @memberof SpConfigObjectV2024 - */ - 'exportable'?: boolean; - /** - * - * @type {SpConfigRulesV2024} - * @memberof SpConfigObjectV2024 - */ - 'rules'?: SpConfigRulesV2024; -} -/** - * Format of Config Hub object rules. - * @export - * @interface SpConfigRuleV2024 - */ -export interface SpConfigRuleV2024 { - /** - * JSONPath expression denoting the path within the object where a value substitution should be applied. - * @type {string} - * @memberof SpConfigRuleV2024 - */ - 'path'?: string; - /** - * - * @type {SpConfigRuleValueV2024} - * @memberof SpConfigRuleV2024 - */ - 'value'?: SpConfigRuleValueV2024 | null; - /** - * Draft modes the rule will apply to. - * @type {Array} - * @memberof SpConfigRuleV2024 - */ - 'modes'?: Array; -} - -export const SpConfigRuleV2024ModesV2024 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type SpConfigRuleV2024ModesV2024 = typeof SpConfigRuleV2024ModesV2024[keyof typeof SpConfigRuleV2024ModesV2024]; - -/** - * Value to be assigned at the jsonPath location within the object. - * @export - * @interface SpConfigRuleValueV2024 - */ -export interface SpConfigRuleValueV2024 { -} -/** - * Rules to be applied to the config object during the draft process. - * @export - * @interface SpConfigRulesV2024 - */ -export interface SpConfigRulesV2024 { - /** - * - * @type {Array} - * @memberof SpConfigRulesV2024 - */ - 'takeFromTargetRules'?: Array; - /** - * - * @type {Array} - * @memberof SpConfigRulesV2024 - */ - 'defaultRules'?: Array; - /** - * Indicates whether the object can be edited. - * @type {boolean} - * @memberof SpConfigRulesV2024 - */ - 'editable'?: boolean; -} -/** - * - * @export - * @interface SpDetailsV2024 - */ -export interface SpDetailsV2024 { - /** - * Federation protocol role - * @type {string} - * @memberof SpDetailsV2024 - */ - 'role'?: SpDetailsV2024RoleV2024; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof SpDetailsV2024 - */ - 'entityId'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2024 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2024 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2024 - */ - 'legacyAcsUrl'?: string; -} - -export const SpDetailsV2024RoleV2024 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type SpDetailsV2024RoleV2024 = typeof SpDetailsV2024RoleV2024[keyof typeof SpDetailsV2024RoleV2024]; - -/** - * - * @export - * @interface SplitV2024 - */ -export interface SplitV2024 { - /** - * This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - * @type {string} - * @memberof SplitV2024 - */ - 'delimiter': string; - /** - * An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - * @type {string} - * @memberof SplitV2024 - */ - 'index': string; - /** - * A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return \"IndexOutOfBoundsException\" `false` - The transform should return null If not provided, the transform will default to false and return a null - * @type {boolean} - * @memberof SplitV2024 - */ - 'throws'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SplitV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SplitV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Standard Log4j log level - * @export - * @enum {string} - */ - -export const StandardLevelV2024 = { - False: 'false', - Fatal: 'FATAL', - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO', - Debug: 'DEBUG', - Trace: 'TRACE' -} as const; - -export type StandardLevelV2024 = typeof StandardLevelV2024[keyof typeof StandardLevelV2024]; - - -/** - * - * @export - * @interface StartInvocationInputV2024 - */ -export interface StartInvocationInputV2024 { - /** - * Trigger ID - * @type {string} - * @memberof StartInvocationInputV2024 - */ - 'triggerId'?: string; - /** - * Trigger input payload. Its schema is defined in the trigger definition. - * @type {object} - * @memberof StartInvocationInputV2024 - */ - 'input'?: object; - /** - * JSON map of invocation metadata - * @type {object} - * @memberof StartInvocationInputV2024 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface StartLauncher200ResponseV2024 - */ -export interface StartLauncher200ResponseV2024 { - /** - * ID of the Interactive Process that was launched - * @type {string} - * @memberof StartLauncher200ResponseV2024 - */ - 'interactiveProcessId': string; -} -/** - * - * @export - * @interface StaticV2024 - */ -export interface StaticV2024 { - /** - * This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - * @type {string} - * @memberof StaticV2024 - */ - 'values': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof StaticV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Response model for connection check, configuration test and ping of source connectors. - * @export - * @interface StatusResponseV2024 - */ -export interface StatusResponseV2024 { - /** - * ID of the source - * @type {string} - * @memberof StatusResponseV2024 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof StatusResponseV2024 - */ - 'name'?: string; - /** - * The status of the health check. - * @type {string} - * @memberof StatusResponseV2024 - */ - 'status'?: StatusResponseV2024StatusV2024; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof StatusResponseV2024 - */ - 'elapsedMillis'?: number; - /** - * The document contains the results of the health check. The schema of this document depends on the type of source used. - * @type {object} - * @memberof StatusResponseV2024 - */ - 'details'?: object; -} - -export const StatusResponseV2024StatusV2024 = { - Success: 'SUCCESS', - Failure: 'FAILURE' -} as const; - -export type StatusResponseV2024StatusV2024 = typeof StatusResponseV2024StatusV2024[keyof typeof StatusResponseV2024StatusV2024]; - -/** - * - * @export - * @interface SubSearchAggregationSpecificationV2024 - */ -export interface SubSearchAggregationSpecificationV2024 { - /** - * - * @type {NestedAggregationV2024} - * @memberof SubSearchAggregationSpecificationV2024 - */ - 'nested'?: NestedAggregationV2024; - /** - * - * @type {MetricAggregationV2024} - * @memberof SubSearchAggregationSpecificationV2024 - */ - 'metric'?: MetricAggregationV2024; - /** - * - * @type {FilterAggregationV2024} - * @memberof SubSearchAggregationSpecificationV2024 - */ - 'filter'?: FilterAggregationV2024; - /** - * - * @type {BucketAggregationV2024} - * @memberof SubSearchAggregationSpecificationV2024 - */ - 'bucket'?: BucketAggregationV2024; - /** - * - * @type {AggregationsV2024} - * @memberof SubSearchAggregationSpecificationV2024 - */ - 'subAggregation'?: AggregationsV2024; -} -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface SubscriptionPatchRequestInnerV2024 - */ -export interface SubscriptionPatchRequestInnerV2024 { - /** - * The operation to be performed - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2024 - */ - 'op': SubscriptionPatchRequestInnerV2024OpV2024; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2024 - */ - 'path': string; - /** - * - * @type {SubscriptionPatchRequestInnerValueV2024} - * @memberof SubscriptionPatchRequestInnerV2024 - */ - 'value'?: SubscriptionPatchRequestInnerValueV2024; -} - -export const SubscriptionPatchRequestInnerV2024OpV2024 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy' -} as const; - -export type SubscriptionPatchRequestInnerV2024OpV2024 = typeof SubscriptionPatchRequestInnerV2024OpV2024[keyof typeof SubscriptionPatchRequestInnerV2024OpV2024]; - -/** - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - * @interface SubscriptionPatchRequestInnerValueV2024 - */ -export interface SubscriptionPatchRequestInnerValueV2024 { -} -/** - * - * @export - * @interface SubscriptionPostRequestV2024 - */ -export interface SubscriptionPostRequestV2024 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPostRequestV2024 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPostRequestV2024 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionPostRequestV2024 - */ - 'triggerId': string; - /** - * - * @type {SubscriptionTypeV2024} - * @memberof SubscriptionPostRequestV2024 - */ - 'type': SubscriptionTypeV2024; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPostRequestV2024 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2024} - * @memberof SubscriptionPostRequestV2024 - */ - 'httpConfig'?: HttpConfigV2024; - /** - * - * @type {EventBridgeConfigV2024} - * @memberof SubscriptionPostRequestV2024 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2024; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPostRequestV2024 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPostRequestV2024 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubscriptionPutRequestV2024 - */ -export interface SubscriptionPutRequestV2024 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPutRequestV2024 - */ - 'name'?: string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPutRequestV2024 - */ - 'description'?: string; - /** - * - * @type {SubscriptionTypeV2024} - * @memberof SubscriptionPutRequestV2024 - */ - 'type'?: SubscriptionTypeV2024; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPutRequestV2024 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2024} - * @memberof SubscriptionPutRequestV2024 - */ - 'httpConfig'?: HttpConfigV2024; - /** - * - * @type {EventBridgeConfigV2024} - * @memberof SubscriptionPutRequestV2024 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2024; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPutRequestV2024 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPutRequestV2024 - */ - 'filter'?: string; -} - - -/** - * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. - * @export - * @enum {string} - */ - -export const SubscriptionTypeV2024 = { - Http: 'HTTP', - Eventbridge: 'EVENTBRIDGE', - Inline: 'INLINE', - Script: 'SCRIPT', - Workflow: 'WORKFLOW' -} as const; - -export type SubscriptionTypeV2024 = typeof SubscriptionTypeV2024[keyof typeof SubscriptionTypeV2024]; - - -/** - * - * @export - * @interface SubscriptionV2024 - */ -export interface SubscriptionV2024 { - /** - * Subscription ID. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'id': string; - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'triggerId': string; - /** - * Trigger name of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'triggerName': string; - /** - * - * @type {SubscriptionTypeV2024} - * @memberof SubscriptionV2024 - */ - 'type': SubscriptionTypeV2024; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2024} - * @memberof SubscriptionV2024 - */ - 'httpConfig'?: HttpConfigV2024; - /** - * - * @type {EventBridgeConfigV2024} - * @memberof SubscriptionV2024 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2024; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionV2024 - */ - 'enabled': boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionV2024 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubstringV2024 - */ -export interface SubstringV2024 { - /** - * The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data - * @type {number} - * @memberof SubstringV2024 - */ - 'begin': number; - /** - * This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. - * @type {number} - * @memberof SubstringV2024 - */ - 'beginOffset'?: number; - /** - * The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - * @type {number} - * @memberof SubstringV2024 - */ - 'end'?: number; - /** - * This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. - * @type {number} - * @memberof SubstringV2024 - */ - 'endOffset'?: number; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SubstringV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SubstringV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Tagged object\'s category. - * @export - * @interface TagTagCategoryRefsInnerV2024 - */ -export interface TagTagCategoryRefsInnerV2024 { - /** - * DTO type of the tagged object\'s category. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2024 - */ - 'type'?: TagTagCategoryRefsInnerV2024TypeV2024; - /** - * Tagged object\'s ID. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2024 - */ - 'id'?: string; - /** - * Tagged object\'s display name. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2024 - */ - 'name'?: string; -} - -export const TagTagCategoryRefsInnerV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TagTagCategoryRefsInnerV2024TypeV2024 = typeof TagTagCategoryRefsInnerV2024TypeV2024[keyof typeof TagTagCategoryRefsInnerV2024TypeV2024]; - -/** - * - * @export - * @interface TagV2024 - */ -export interface TagV2024 { - /** - * Tag id - * @type {string} - * @memberof TagV2024 - */ - 'id': string; - /** - * Name of the tag. - * @type {string} - * @memberof TagV2024 - */ - 'name': string; - /** - * Date the tag was created. - * @type {string} - * @memberof TagV2024 - */ - 'created': string; - /** - * Date the tag was last modified. - * @type {string} - * @memberof TagV2024 - */ - 'modified': string; - /** - * - * @type {Array} - * @memberof TagV2024 - */ - 'tagCategoryRefs': Array; -} -/** - * - * @export - * @interface TaggedObjectDtoV2024 - */ -export interface TaggedObjectDtoV2024 { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectDtoV2024 - */ - 'type'?: TaggedObjectDtoV2024TypeV2024; - /** - * ID of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2024 - */ - 'id'?: string; - /** - * Human-readable display name of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2024 - */ - 'name'?: string | null; -} - -export const TaggedObjectDtoV2024TypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectDtoV2024TypeV2024 = typeof TaggedObjectDtoV2024TypeV2024[keyof typeof TaggedObjectDtoV2024TypeV2024]; - -/** - * Tagged object. - * @export - * @interface TaggedObjectV2024 - */ -export interface TaggedObjectV2024 { - /** - * - * @type {TaggedObjectDtoV2024} - * @memberof TaggedObjectV2024 - */ - 'objectRef'?: TaggedObjectDtoV2024; - /** - * Labels to be applied to an Object - * @type {Array} - * @memberof TaggedObjectV2024 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface TargetV2024 - */ -export interface TargetV2024 { - /** - * Target ID - * @type {string} - * @memberof TargetV2024 - */ - 'id'?: string; - /** - * Target type - * @type {string} - * @memberof TargetV2024 - */ - 'type'?: TargetV2024TypeV2024 | null; - /** - * Target name - * @type {string} - * @memberof TargetV2024 - */ - 'name'?: string; -} - -export const TargetV2024TypeV2024 = { - Application: 'APPLICATION', - Identity: 'IDENTITY' -} as const; - -export type TargetV2024TypeV2024 = typeof TargetV2024TypeV2024[keyof typeof TargetV2024TypeV2024]; - -/** - * Definition of a type of task, used to invoke tasks - * @export - * @interface TaskDefinitionSummaryV2024 - */ -export interface TaskDefinitionSummaryV2024 { - /** - * System-generated unique ID of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2024 - */ - 'id': string; - /** - * Name of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2024 - */ - 'uniqueName': string; - /** - * Description of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2024 - */ - 'description': string | null; - /** - * Name of the parent of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2024 - */ - 'parentName': string; - /** - * Executor of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2024 - */ - 'executor': string | null; - /** - * Formal parameters of the TaskDefinition, without values - * @type {{ [key: string]: any; }} - * @memberof TaskDefinitionSummaryV2024 - */ - 'arguments': { [key: string]: any; }; -} -/** - * - * @export - * @interface TaskResultDetailsMessagesInnerV2024 - */ -export interface TaskResultDetailsMessagesInnerV2024 { - /** - * Type of the message. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2024 - */ - 'type'?: TaskResultDetailsMessagesInnerV2024TypeV2024; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2024 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2024 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2024 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2024 - */ - 'localizedText'?: string; -} - -export const TaskResultDetailsMessagesInnerV2024TypeV2024 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskResultDetailsMessagesInnerV2024TypeV2024 = typeof TaskResultDetailsMessagesInnerV2024TypeV2024[keyof typeof TaskResultDetailsMessagesInnerV2024TypeV2024]; - -/** - * - * @export - * @interface TaskResultDetailsReturnsInnerV2024 - */ -export interface TaskResultDetailsReturnsInnerV2024 { - /** - * Attribute description. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2024 - */ - 'displayLabel'?: string; - /** - * System or database attribute name. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2024 - */ - 'attributeName'?: string; -} -/** - * Details about job or task type, state and lifecycle. - * @export - * @interface TaskResultDetailsV2024 - */ -export interface TaskResultDetailsV2024 { - /** - * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'type'?: TaskResultDetailsV2024TypeV2024; - /** - * Unique task definition identifier. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'id'?: string; - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'reportType'?: TaskResultDetailsV2024ReportTypeV2024; - /** - * Description of the report purpose and/or contents. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'description'?: string; - /** - * Name of the parent task/report if exists. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'parentName'?: string | null; - /** - * Name of the report processing initiator. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'launcher'?: string; - /** - * Report creation date - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'created'?: string; - /** - * Report start date - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'launched'?: string | null; - /** - * Report completion date - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'completed'?: string | null; - /** - * Report completion status. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'completionStatus'?: TaskResultDetailsV2024CompletionStatusV2024 | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof TaskResultDetailsV2024 - */ - 'messages'?: Array; - /** - * Task definition results, if necessary. - * @type {Array} - * @memberof TaskResultDetailsV2024 - */ - 'returns'?: Array; - /** - * Extra attributes map(dictionary) needed for the report. - * @type {object} - * @memberof TaskResultDetailsV2024 - */ - 'attributes'?: object; - /** - * Current report state. - * @type {string} - * @memberof TaskResultDetailsV2024 - */ - 'progress'?: string | null; -} - -export const TaskResultDetailsV2024TypeV2024 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - Mentos: 'MENTOS', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskResultDetailsV2024TypeV2024 = typeof TaskResultDetailsV2024TypeV2024[keyof typeof TaskResultDetailsV2024TypeV2024]; -export const TaskResultDetailsV2024ReportTypeV2024 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type TaskResultDetailsV2024ReportTypeV2024 = typeof TaskResultDetailsV2024ReportTypeV2024[keyof typeof TaskResultDetailsV2024ReportTypeV2024]; -export const TaskResultDetailsV2024CompletionStatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type TaskResultDetailsV2024CompletionStatusV2024 = typeof TaskResultDetailsV2024CompletionStatusV2024[keyof typeof TaskResultDetailsV2024CompletionStatusV2024]; - -/** - * Task result. - * @export - * @interface TaskResultDtoV2024 - */ -export interface TaskResultDtoV2024 { - /** - * Task result DTO type. - * @type {string} - * @memberof TaskResultDtoV2024 - */ - 'type'?: TaskResultDtoV2024TypeV2024; - /** - * Task result ID. - * @type {string} - * @memberof TaskResultDtoV2024 - */ - 'id'?: string; - /** - * Task result display name. - * @type {string} - * @memberof TaskResultDtoV2024 - */ - 'name'?: string | null; -} - -export const TaskResultDtoV2024TypeV2024 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type TaskResultDtoV2024TypeV2024 = typeof TaskResultDtoV2024TypeV2024[keyof typeof TaskResultDtoV2024TypeV2024]; - -/** - * - * @export - * @interface TaskResultResponseV2024 - */ -export interface TaskResultResponseV2024 { - /** - * the type of response reference - * @type {string} - * @memberof TaskResultResponseV2024 - */ - 'type'?: string; - /** - * the task ID - * @type {string} - * @memberof TaskResultResponseV2024 - */ - 'id'?: string; - /** - * the task name (not used in this endpoint, always null) - * @type {string} - * @memberof TaskResultResponseV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface TaskResultSimplifiedV2024 - */ -export interface TaskResultSimplifiedV2024 { - /** - * Task identifier - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'id'?: string; - /** - * Task name - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'name'?: string; - /** - * Task description - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'description'?: string; - /** - * User or process who launched the task - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'launcher'?: string; - /** - * Date time of completion - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'completed'?: string; - /** - * Date time when the task was launched - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'launched'?: string; - /** - * Task result status - * @type {string} - * @memberof TaskResultSimplifiedV2024 - */ - 'completionStatus'?: TaskResultSimplifiedV2024CompletionStatusV2024; -} - -export const TaskResultSimplifiedV2024CompletionStatusV2024 = { - Success: 'Success', - Warning: 'Warning', - Error: 'Error', - Terminated: 'Terminated', - TempError: 'TempError' -} as const; - -export type TaskResultSimplifiedV2024CompletionStatusV2024 = typeof TaskResultSimplifiedV2024CompletionStatusV2024[keyof typeof TaskResultSimplifiedV2024CompletionStatusV2024]; - -/** - * Task return details - * @export - * @interface TaskReturnDetailsV2024 - */ -export interface TaskReturnDetailsV2024 { - /** - * Display name of the TaskReturnDetails - * @type {string} - * @memberof TaskReturnDetailsV2024 - */ - 'name': string; - /** - * Attribute the TaskReturnDetails is for - * @type {string} - * @memberof TaskReturnDetailsV2024 - */ - 'attributeName': string; -} -/** - * - * @export - * @interface TaskStatusMessageParametersInnerV2024 - */ -export interface TaskStatusMessageParametersInnerV2024 { -} -/** - * TaskStatus Message - * @export - * @interface TaskStatusMessageV2024 - */ -export interface TaskStatusMessageV2024 { - /** - * Type of the message - * @type {string} - * @memberof TaskStatusMessageV2024 - */ - 'type': TaskStatusMessageV2024TypeV2024; - /** - * - * @type {LocalizedMessageV2024} - * @memberof TaskStatusMessageV2024 - */ - 'localizedText': LocalizedMessageV2024 | null; - /** - * Key of the message - * @type {string} - * @memberof TaskStatusMessageV2024 - */ - 'key': string; - /** - * Message parameters for internationalization - * @type {Array} - * @memberof TaskStatusMessageV2024 - */ - 'parameters': Array | null; -} - -export const TaskStatusMessageV2024TypeV2024 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskStatusMessageV2024TypeV2024 = typeof TaskStatusMessageV2024TypeV2024[keyof typeof TaskStatusMessageV2024TypeV2024]; - -/** - * Details and current status of a specific task - * @export - * @interface TaskStatusV2024 - */ -export interface TaskStatusV2024 { - /** - * System-generated unique ID of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'id': string; - /** - * Type of task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'type': TaskStatusV2024TypeV2024; - /** - * Name of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'uniqueName': string; - /** - * Description of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'description': string; - /** - * Name of the parent of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'parentName': string | null; - /** - * Service to execute the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'launcher': string; - /** - * - * @type {TargetV2024} - * @memberof TaskStatusV2024 - */ - 'target'?: TargetV2024 | null; - /** - * Creation date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'created': string; - /** - * Last modification date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'modified': string | null; - /** - * Launch date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'launched': string | null; - /** - * Completion date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'completed': string | null; - /** - * Completion status of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'completionStatus': TaskStatusV2024CompletionStatusV2024 | null; - /** - * Messages associated with the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2024 - */ - 'messages': Array; - /** - * Return values from the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2024 - */ - 'returns': Array; - /** - * Attributes of the task this TaskStatus represents - * @type {{ [key: string]: any; }} - * @memberof TaskStatusV2024 - */ - 'attributes': { [key: string]: any; }; - /** - * Current progress of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2024 - */ - 'progress': string | null; - /** - * Current percentage completion of the task this TaskStatus represents - * @type {number} - * @memberof TaskStatusV2024 - */ - 'percentComplete': number; - /** - * - * @type {TaskDefinitionSummaryV2024} - * @memberof TaskStatusV2024 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2024; -} - -export const TaskStatusV2024TypeV2024 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskStatusV2024TypeV2024 = typeof TaskStatusV2024TypeV2024[keyof typeof TaskStatusV2024TypeV2024]; -export const TaskStatusV2024CompletionStatusV2024 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type TaskStatusV2024CompletionStatusV2024 = typeof TaskStatusV2024CompletionStatusV2024[keyof typeof TaskStatusV2024CompletionStatusV2024]; - -/** - * - * @export - * @interface TemplateBulkDeleteDtoV2024 - */ -export interface TemplateBulkDeleteDtoV2024 { - /** - * The template key to delete - * @type {string} - * @memberof TemplateBulkDeleteDtoV2024 - */ - 'key': string; - /** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @type {string} - * @memberof TemplateBulkDeleteDtoV2024 - */ - 'medium'?: TemplateBulkDeleteDtoV2024MediumV2024; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateBulkDeleteDtoV2024 - */ - 'locale'?: string; -} - -export const TemplateBulkDeleteDtoV2024MediumV2024 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateBulkDeleteDtoV2024MediumV2024 = typeof TemplateBulkDeleteDtoV2024MediumV2024[keyof typeof TemplateBulkDeleteDtoV2024MediumV2024]; - -/** - * - * @export - * @interface TemplateDtoDefaultV2024 - */ -export interface TemplateDtoDefaultV2024 { - /** - * The key of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'key'?: string; - /** - * The name of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'medium'?: TemplateDtoDefaultV2024MediumV2024; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'locale'?: string; - /** - * The subject of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'subject'?: string | null; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2024 - * @deprecated - */ - 'header'?: string | null; - /** - * The body of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2024 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'from'?: string | null; - /** - * The \"Reply To\" field of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'replyTo'?: string | null; - /** - * The description of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2024 - */ - 'description'?: string | null; - /** - * - * @type {TemplateSlackV2024} - * @memberof TemplateDtoDefaultV2024 - */ - 'slackTemplate'?: TemplateSlackV2024 | null; - /** - * - * @type {TemplateTeamsV2024} - * @memberof TemplateDtoDefaultV2024 - */ - 'teamsTemplate'?: TemplateTeamsV2024 | null; -} - -export const TemplateDtoDefaultV2024MediumV2024 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoDefaultV2024MediumV2024 = typeof TemplateDtoDefaultV2024MediumV2024[keyof typeof TemplateDtoDefaultV2024MediumV2024]; - -/** - * - * @export - * @interface TemplateDtoSlackTemplateV2024 - */ -export interface TemplateDtoSlackTemplateV2024 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2024} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2024} - * @memberof TemplateDtoSlackTemplateV2024 - */ - 'customFields'?: TemplateSlackCustomFieldsV2024 | null; -} -/** - * - * @export - * @interface TemplateDtoTeamsTemplateV2024 - */ -export interface TemplateDtoTeamsTemplateV2024 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2024} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2024} - * @memberof TemplateDtoTeamsTemplateV2024 - */ - 'customFields'?: TemplateSlackCustomFieldsV2024 | null; -} -/** - * - * @export - * @interface TemplateDtoV2024 - */ -export interface TemplateDtoV2024 { - /** - * The key of the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'key': string; - /** - * The name of the Task Manager Subscription - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'medium': TemplateDtoV2024MediumV2024; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'locale': string; - /** - * The subject line in the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'subject'?: string; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2024 - * @deprecated - */ - 'header'?: string | null; - /** - * The body in the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2024 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address in the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'from'?: string; - /** - * The \"Reply To\" line in the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'replyTo'?: string; - /** - * The description in the template - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'description'?: string; - /** - * This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'id'?: string; - /** - * The time when this template is created. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'created'?: string; - /** - * The time when this template was last modified. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2024 - */ - 'modified'?: string; - /** - * - * @type {TemplateDtoSlackTemplateV2024} - * @memberof TemplateDtoV2024 - */ - 'slackTemplate'?: TemplateDtoSlackTemplateV2024; - /** - * - * @type {TemplateDtoTeamsTemplateV2024} - * @memberof TemplateDtoV2024 - */ - 'teamsTemplate'?: TemplateDtoTeamsTemplateV2024; -} - -export const TemplateDtoV2024MediumV2024 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoV2024MediumV2024 = typeof TemplateDtoV2024MediumV2024[keyof typeof TemplateDtoV2024MediumV2024]; - -/** - * - * @export - * @interface TemplateSlackAutoApprovalDataV2024 - */ -export interface TemplateSlackAutoApprovalDataV2024 { - /** - * Whether the request was auto-approved - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2024 - */ - 'isAutoApproved'?: string | null; - /** - * The item ID - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2024 - */ - 'itemId'?: string | null; - /** - * The item type - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2024 - */ - 'itemType'?: string | null; - /** - * JSON message for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2024 - */ - 'autoApprovalMessageJSON'?: string | null; - /** - * Title for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2024 - */ - 'autoApprovalTitle'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackCustomFieldsV2024 - */ -export interface TemplateSlackCustomFieldsV2024 { - /** - * The type of request - * @type {string} - * @memberof TemplateSlackCustomFieldsV2024 - */ - 'requestType'?: string | null; - /** - * Whether the request contains a deny action - * @type {string} - * @memberof TemplateSlackCustomFieldsV2024 - */ - 'containsDeny'?: string | null; - /** - * The campaign ID - * @type {string} - * @memberof TemplateSlackCustomFieldsV2024 - */ - 'campaignId'?: string | null; - /** - * The campaign status - * @type {string} - * @memberof TemplateSlackCustomFieldsV2024 - */ - 'campaignStatus'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackV2024 - */ -export interface TemplateSlackV2024 { - /** - * The template key - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateSlackV2024 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateSlackV2024 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2024} - * @memberof TemplateSlackV2024 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2024} - * @memberof TemplateSlackV2024 - */ - 'customFields'?: TemplateSlackCustomFieldsV2024 | null; -} -/** - * - * @export - * @interface TemplateTeamsV2024 - */ -export interface TemplateTeamsV2024 { - /** - * The template key - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateTeamsV2024 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateTeamsV2024 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2024} - * @memberof TemplateTeamsV2024 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2024 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2024} - * @memberof TemplateTeamsV2024 - */ - 'customFields'?: TemplateSlackCustomFieldsV2024 | null; -} -/** - * Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) - * @export - * @interface TenantConfigurationDetailsV2024 - */ -export interface TenantConfigurationDetailsV2024 { - /** - * Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. - * @type {boolean} - * @memberof TenantConfigurationDetailsV2024 - */ - 'disabled'?: boolean | null; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationRequestV2024 - */ -export interface TenantConfigurationRequestV2024 { - /** - * - * @type {TenantConfigurationDetailsV2024} - * @memberof TenantConfigurationRequestV2024 - */ - 'configDetails'?: TenantConfigurationDetailsV2024; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationResponseV2024 - */ -export interface TenantConfigurationResponseV2024 { - /** - * - * @type {AuditDetailsV2024} - * @memberof TenantConfigurationResponseV2024 - */ - 'auditDetails'?: AuditDetailsV2024; - /** - * - * @type {TenantConfigurationDetailsV2024} - * @memberof TenantConfigurationResponseV2024 - */ - 'configDetails'?: TenantConfigurationDetailsV2024; -} -/** - * - * @export - * @interface TenantUiMetadataItemResponseV2024 - */ -export interface TenantUiMetadataItemResponseV2024 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemResponseV2024 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2024 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2024 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantUiMetadataItemUpdateRequestV2024 - */ -export interface TenantUiMetadataItemUpdateRequestV2024 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2024 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2024 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2024 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantV2024 - */ -export interface TenantV2024 { - /** - * The unique identifier for the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'id'?: string; - /** - * Abbreviated name of the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'name'?: string; - /** - * Human-readable name of the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'fullName'?: string; - /** - * Deployment pod for the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'pod'?: string; - /** - * Deployment region for the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'region'?: string; - /** - * Description of the Tenant - * @type {string} - * @memberof TenantV2024 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof TenantV2024 - */ - 'products'?: Array; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflow200ResponseV2024 - */ -export interface TestExternalExecuteWorkflow200ResponseV2024 { - /** - * The input that was received - * @type {object} - * @memberof TestExternalExecuteWorkflow200ResponseV2024 - */ - 'payload'?: object; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflowRequestV2024 - */ -export interface TestExternalExecuteWorkflowRequestV2024 { - /** - * The test input for the workflow - * @type {object} - * @memberof TestExternalExecuteWorkflowRequestV2024 - */ - 'input'?: object; -} -/** - * - * @export - * @interface TestInvocationV2024 - */ -export interface TestInvocationV2024 { - /** - * Trigger ID - * @type {string} - * @memberof TestInvocationV2024 - */ - 'triggerId': string; - /** - * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. - * @type {object} - * @memberof TestInvocationV2024 - */ - 'input'?: object; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof TestInvocationV2024 - */ - 'contentJson': object; - /** - * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. - * @type {Array} - * @memberof TestInvocationV2024 - */ - 'subscriptionIds'?: Array; -} -/** - * - * @export - * @interface TestSourceConnectionMultihost200ResponseV2024 - */ -export interface TestSourceConnectionMultihost200ResponseV2024 { - /** - * Source\'s test connection status. - * @type {boolean} - * @memberof TestSourceConnectionMultihost200ResponseV2024 - */ - 'success'?: boolean; - /** - * Source\'s test connection message. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2024 - */ - 'message'?: string; - /** - * Source\'s test connection timing. - * @type {number} - * @memberof TestSourceConnectionMultihost200ResponseV2024 - */ - 'timing'?: number; - /** - * Source\'s human-readable result type. - * @type {object} - * @memberof TestSourceConnectionMultihost200ResponseV2024 - */ - 'resultType'?: TestSourceConnectionMultihost200ResponseV2024ResultTypeV2024; - /** - * Source\'s human-readable test connection details. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2024 - */ - 'testConnectionDetails'?: string; -} - -export const TestSourceConnectionMultihost200ResponseV2024ResultTypeV2024 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type TestSourceConnectionMultihost200ResponseV2024ResultTypeV2024 = typeof TestSourceConnectionMultihost200ResponseV2024ResultTypeV2024[keyof typeof TestSourceConnectionMultihost200ResponseV2024ResultTypeV2024]; - -/** - * - * @export - * @interface TestWorkflow200ResponseV2024 - */ -export interface TestWorkflow200ResponseV2024 { - /** - * The workflow execution id - * @type {string} - * @memberof TestWorkflow200ResponseV2024 - */ - 'workflowExecutionId'?: string; -} -/** - * - * @export - * @interface TestWorkflowRequestV2024 - */ -export interface TestWorkflowRequestV2024 { - /** - * The test input for the workflow. - * @type {object} - * @memberof TestWorkflowRequestV2024 - */ - 'input': object; -} -/** - * Query parameters used to construct an Elasticsearch text query object. - * @export - * @interface TextQueryV2024 - */ -export interface TextQueryV2024 { - /** - * Words or characters that specify a particular thing to be searched for. - * @type {Array} - * @memberof TextQueryV2024 - */ - 'terms': Array; - /** - * The fields to be searched. - * @type {Array} - * @memberof TextQueryV2024 - */ - 'fields': Array; - /** - * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - * @type {boolean} - * @memberof TextQueryV2024 - */ - 'matchAny'?: boolean; - /** - * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - * @type {boolean} - * @memberof TextQueryV2024 - */ - 'contains'?: boolean; -} -/** - * @type TransformAttributesV2024 - * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - * @export - */ -export type TransformAttributesV2024 = AccountAttributeV2024 | Base64DecodeV2024 | Base64EncodeV2024 | ConcatenationV2024 | ConditionalV2024 | DateCompareV2024 | DateFormatV2024 | DateMathV2024 | DecomposeDiacriticalMarksV2024 | E164phoneV2024 | FirstValidV2024 | ISO3166V2024 | IdentityAttribute1V2024 | IndexOfV2024 | LeftPadV2024 | LookupV2024 | LowerV2024 | NameNormalizerV2024 | RandomAlphaNumericV2024 | RandomNumericV2024 | ReferenceV2024 | ReplaceAllV2024 | ReplaceV2024 | RightPadV2024 | RuleV2024 | SplitV2024 | StaticV2024 | SubstringV2024 | TrimV2024 | UUIDGeneratorV2024 | UpperV2024; - -/** - * - * @export - * @interface TransformDefinitionV2024 - */ -export interface TransformDefinitionV2024 { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinitionV2024 - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinitionV2024 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TransformReadV2024 - */ -export interface TransformReadV2024 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformReadV2024 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformReadV2024 - */ - 'type': TransformReadV2024TypeV2024; - /** - * - * @type {TransformAttributesV2024} - * @memberof TransformReadV2024 - */ - 'attributes': TransformAttributesV2024 | null; - /** - * Unique ID of this transform - * @type {string} - * @memberof TransformReadV2024 - */ - 'id': string; - /** - * Indicates whether this is an internal SailPoint-created transform or a customer-created transform - * @type {boolean} - * @memberof TransformReadV2024 - */ - 'internal': boolean; -} - -export const TransformReadV2024TypeV2024 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformReadV2024TypeV2024 = typeof TransformReadV2024TypeV2024[keyof typeof TransformReadV2024TypeV2024]; - -/** - * - * @export - * @interface TransformRuleV2024 - */ -export interface TransformRuleV2024 { - /** - * This is the name of the Transform rule that needs to be invoked by the transform - * @type {string} - * @memberof TransformRuleV2024 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TransformRuleV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * The representation of an internally- or customer-defined transform. - * @export - * @interface TransformV2024 - */ -export interface TransformV2024 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformV2024 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformV2024 - */ - 'type': TransformV2024TypeV2024; - /** - * - * @type {TransformAttributesV2024} - * @memberof TransformV2024 - */ - 'attributes': TransformAttributesV2024 | null; -} - -export const TransformV2024TypeV2024 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformV2024TypeV2024 = typeof TransformV2024TypeV2024[keyof typeof TransformV2024TypeV2024]; - -/** - * - * @export - * @interface TranslationMessageV2024 - */ -export interface TranslationMessageV2024 { - /** - * The key of the translation message - * @type {string} - * @memberof TranslationMessageV2024 - */ - 'key'?: string; - /** - * The values corresponding to the translation messages - * @type {Array} - * @memberof TranslationMessageV2024 - */ - 'values'?: Array; -} -/** - * @type TriggerExampleInputV2024 - * An example of the JSON payload that will be sent by the trigger to the subscribed service. - * @export - */ -export type TriggerExampleInputV2024 = AccessRequestDynamicApproverV2024 | AccessRequestPostApprovalV2024 | AccessRequestPreApprovalV2024 | AccountAggregationCompletedV2024 | AccountAttributesChangedV2024 | AccountCorrelatedV2024 | AccountUncorrelatedV2024 | AccountsCollectedForAggregationV2024 | CampaignActivatedV2024 | CampaignEndedV2024 | CampaignGeneratedV2024 | CertificationSignedOffV2024 | IdentityAttributesChangedV2024 | IdentityCreatedV2024 | IdentityDeletedV2024 | ProvisioningCompletedV2024 | SavedSearchCompleteV2024 | SourceAccountCreatedV2024 | SourceAccountDeletedV2024 | SourceAccountUpdatedV2024 | SourceCreatedV2024 | SourceDeletedV2024 | SourceUpdatedV2024 | VAClusterStatusChangeEventV2024; - -/** - * @type TriggerExampleOutputV2024 - * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. - * @export - */ -export type TriggerExampleOutputV2024 = AccessRequestDynamicApprover1V2024 | AccessRequestPreApproval1V2024; - -/** - * The type of trigger. - * @export - * @enum {string} - */ - -export const TriggerTypeV2024 = { - RequestResponse: 'REQUEST_RESPONSE', - FireAndForget: 'FIRE_AND_FORGET' -} as const; - -export type TriggerTypeV2024 = typeof TriggerTypeV2024[keyof typeof TriggerTypeV2024]; - - -/** - * - * @export - * @interface TriggerV2024 - */ -export interface TriggerV2024 { - /** - * Unique identifier of the trigger. - * @type {string} - * @memberof TriggerV2024 - */ - 'id': string; - /** - * Trigger Name. - * @type {string} - * @memberof TriggerV2024 - */ - 'name': string; - /** - * - * @type {TriggerTypeV2024} - * @memberof TriggerV2024 - */ - 'type': TriggerTypeV2024; - /** - * Trigger Description. - * @type {string} - * @memberof TriggerV2024 - */ - 'description'?: string; - /** - * The JSON schema of the payload that will be sent by the trigger to the subscribed service. - * @type {string} - * @memberof TriggerV2024 - */ - 'inputSchema': string; - /** - * - * @type {TriggerExampleInputV2024} - * @memberof TriggerV2024 - */ - 'exampleInput': TriggerExampleInputV2024; - /** - * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. - * @type {string} - * @memberof TriggerV2024 - */ - 'outputSchema'?: string | null; - /** - * - * @type {TriggerExampleOutputV2024} - * @memberof TriggerV2024 - */ - 'exampleOutput'?: TriggerExampleOutputV2024 | null; -} - - -/** - * - * @export - * @interface TrimV2024 - */ -export interface TrimV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TrimV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof TrimV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" - * @export - * @interface TypeAheadQueryV2024 - */ -export interface TypeAheadQueryV2024 { - /** - * The type ahead query string used to construct a phrase prefix match query. - * @type {string} - * @memberof TypeAheadQueryV2024 - */ - 'query': string; - /** - * The field on which to perform the type ahead search. - * @type {string} - * @memberof TypeAheadQueryV2024 - */ - 'field': string; - /** - * The nested type. - * @type {string} - * @memberof TypeAheadQueryV2024 - */ - 'nestedType'?: string; - /** - * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. - * @type {number} - * @memberof TypeAheadQueryV2024 - */ - 'maxExpansions'?: number; - /** - * The max amount of records the search will return. - * @type {number} - * @memberof TypeAheadQueryV2024 - */ - 'size'?: number; - /** - * The sort order of the returned records. - * @type {string} - * @memberof TypeAheadQueryV2024 - */ - 'sort'?: string; - /** - * The flag that defines the sort type, by count or value. - * @type {boolean} - * @memberof TypeAheadQueryV2024 - */ - 'sortByValue'?: boolean; -} -/** - * A typed reference to the object. - * @export - * @interface TypedReferenceV2024 - */ -export interface TypedReferenceV2024 { - /** - * - * @type {DtoTypeV2024} - * @memberof TypedReferenceV2024 - */ - 'type': DtoTypeV2024; - /** - * The id of the object. - * @type {string} - * @memberof TypedReferenceV2024 - */ - 'id': string; -} - - -/** - * - * @export - * @interface UUIDGeneratorV2024 - */ -export interface UUIDGeneratorV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UUIDGeneratorV2024 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) - * @export - * @interface UncorrelatedAccountsReportArgumentsV2024 - */ -export interface UncorrelatedAccountsReportArgumentsV2024 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof UncorrelatedAccountsReportArgumentsV2024 - */ - 'selectedFormats'?: Array; -} - -export const UncorrelatedAccountsReportArgumentsV2024SelectedFormatsV2024 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type UncorrelatedAccountsReportArgumentsV2024SelectedFormatsV2024 = typeof UncorrelatedAccountsReportArgumentsV2024SelectedFormatsV2024[keyof typeof UncorrelatedAccountsReportArgumentsV2024SelectedFormatsV2024]; - -/** - * - * @export - * @interface UpdateAccessProfilesInBulk412ResponseV2024 - */ -export interface UpdateAccessProfilesInBulk412ResponseV2024 { - /** - * A message describing the error - * @type {object} - * @memberof UpdateAccessProfilesInBulk412ResponseV2024 - */ - 'message'?: object; -} -/** - * - * @export - * @interface UpdateDetailV2024 - */ -export interface UpdateDetailV2024 { - /** - * The detailed message for an update. Typically the relevent error message when status is error. - * @type {string} - * @memberof UpdateDetailV2024 - */ - 'message'?: string; - /** - * The connector script name - * @type {string} - * @memberof UpdateDetailV2024 - */ - 'scriptName'?: string; - /** - * The list of updated files supported by the connector - * @type {Array} - * @memberof UpdateDetailV2024 - */ - 'updatedFiles'?: Array | null; - /** - * The connector update status - * @type {string} - * @memberof UpdateDetailV2024 - */ - 'status'?: UpdateDetailV2024StatusV2024; -} - -export const UpdateDetailV2024StatusV2024 = { - Error: 'ERROR', - Updated: 'UPDATED', - Unchanged: 'UNCHANGED', - Skipped: 'SKIPPED' -} as const; - -export type UpdateDetailV2024StatusV2024 = typeof UpdateDetailV2024StatusV2024[keyof typeof UpdateDetailV2024StatusV2024]; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface UpdateMultiHostSourcesRequestInnerV2024 - */ -export interface UpdateMultiHostSourcesRequestInnerV2024 { - /** - * The operation to be performed - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2024 - */ - 'op': UpdateMultiHostSourcesRequestInnerV2024OpV2024; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2024 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2024} - * @memberof UpdateMultiHostSourcesRequestInnerV2024 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2024; -} - -export const UpdateMultiHostSourcesRequestInnerV2024OpV2024 = { - Add: 'add', - Replace: 'replace' -} as const; - -export type UpdateMultiHostSourcesRequestInnerV2024OpV2024 = typeof UpdateMultiHostSourcesRequestInnerV2024OpV2024[keyof typeof UpdateMultiHostSourcesRequestInnerV2024OpV2024]; - -/** - * @type UpdateMultiHostSourcesRequestInnerValueV2024 - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - */ -export type UpdateMultiHostSourcesRequestInnerValueV2024 = Array | boolean | number | object | string; - -/** - * - * @export - * @interface UpperV2024 - */ -export interface UpperV2024 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UpperV2024 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof UpperV2024 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @export - * @enum {string} - */ - -export const UsageTypeV2024 = { - Create: 'CREATE', - Update: 'UPDATE', - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE', - Assign: 'ASSIGN', - Unassign: 'UNASSIGN', - CreateGroup: 'CREATE_GROUP', - UpdateGroup: 'UPDATE_GROUP', - DeleteGroup: 'DELETE_GROUP', - Register: 'REGISTER', - CreateIdentity: 'CREATE_IDENTITY', - UpdateIdentity: 'UPDATE_IDENTITY', - EditGroup: 'EDIT_GROUP', - Unlock: 'UNLOCK', - ChangePassword: 'CHANGE_PASSWORD' -} as const; - -export type UsageTypeV2024 = typeof UsageTypeV2024[keyof typeof UsageTypeV2024]; - - -/** - * - * @export - * @interface UserAppAccountV2024 - */ -export interface UserAppAccountV2024 { - /** - * the account ID - * @type {string} - * @memberof UserAppAccountV2024 - */ - 'id'?: string; - /** - * It will always be \"ACCOUNT\" - * @type {string} - * @memberof UserAppAccountV2024 - */ - 'type'?: string; - /** - * the account name - * @type {string} - * @memberof UserAppAccountV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppOwnerV2024 - */ -export interface UserAppOwnerV2024 { - /** - * The identity ID - * @type {string} - * @memberof UserAppOwnerV2024 - */ - 'id'?: string; - /** - * It will always be \"IDENTITY\" - * @type {string} - * @memberof UserAppOwnerV2024 - */ - 'type'?: string; - /** - * The identity name - * @type {string} - * @memberof UserAppOwnerV2024 - */ - 'name'?: string; - /** - * The identity alias - * @type {string} - * @memberof UserAppOwnerV2024 - */ - 'alias'?: string; -} -/** - * - * @export - * @interface UserAppSourceAppV2024 - */ -export interface UserAppSourceAppV2024 { - /** - * the source app ID - * @type {string} - * @memberof UserAppSourceAppV2024 - */ - 'id'?: string; - /** - * It will always be \"APPLICATION\" - * @type {string} - * @memberof UserAppSourceAppV2024 - */ - 'type'?: string; - /** - * the source app name - * @type {string} - * @memberof UserAppSourceAppV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppSourceV2024 - */ -export interface UserAppSourceV2024 { - /** - * the source ID - * @type {string} - * @memberof UserAppSourceV2024 - */ - 'id'?: string; - /** - * It will always be \"SOURCE\" - * @type {string} - * @memberof UserAppSourceV2024 - */ - 'type'?: string; - /** - * the source name - * @type {string} - * @memberof UserAppSourceV2024 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppV2024 - */ -export interface UserAppV2024 { - /** - * The user app id - * @type {string} - * @memberof UserAppV2024 - */ - 'id'?: string; - /** - * Time when the user app was created - * @type {string} - * @memberof UserAppV2024 - */ - 'created'?: string; - /** - * Time when the user app was last modified - * @type {string} - * @memberof UserAppV2024 - */ - 'modified'?: string; - /** - * True if the owner has multiple accounts for the source - * @type {boolean} - * @memberof UserAppV2024 - */ - 'hasMultipleAccounts'?: boolean; - /** - * True if the source has password feature - * @type {boolean} - * @memberof UserAppV2024 - */ - 'useForPasswordManagement'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof UserAppV2024 - */ - 'provisionRequestEnabled'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof UserAppV2024 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {UserAppSourceAppV2024} - * @memberof UserAppV2024 - */ - 'sourceApp'?: UserAppSourceAppV2024; - /** - * - * @type {UserAppSourceV2024} - * @memberof UserAppV2024 - */ - 'source'?: UserAppSourceV2024; - /** - * - * @type {UserAppAccountV2024} - * @memberof UserAppV2024 - */ - 'account'?: UserAppAccountV2024; - /** - * - * @type {UserAppOwnerV2024} - * @memberof UserAppV2024 - */ - 'owner'?: UserAppOwnerV2024; -} -/** - * - * @export - * @interface V3ConnectorDtoV2024 - */ -export interface V3ConnectorDtoV2024 { - /** - * The connector name - * @type {string} - * @memberof V3ConnectorDtoV2024 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof V3ConnectorDtoV2024 - */ - 'type'?: string; - /** - * The connector script name - * @type {string} - * @memberof V3ConnectorDtoV2024 - */ - 'scriptName'?: string; - /** - * The connector class name. - * @type {string} - * @memberof V3ConnectorDtoV2024 - */ - 'className'?: string | null; - /** - * The list of features supported by the connector - * @type {Array} - * @memberof V3ConnectorDtoV2024 - */ - 'features'?: Array | null; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3ConnectorDtoV2024 - */ - 'directConnect'?: boolean; - /** - * A map containing metadata pertinent to the connector - * @type {{ [key: string]: any; }} - * @memberof V3ConnectorDtoV2024 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof V3ConnectorDtoV2024 - */ - 'status'?: V3ConnectorDtoV2024StatusV2024; -} - -export const V3ConnectorDtoV2024StatusV2024 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3ConnectorDtoV2024StatusV2024 = typeof V3ConnectorDtoV2024StatusV2024[keyof typeof V3ConnectorDtoV2024StatusV2024]; - -/** - * - * @export - * @interface V3CreateConnectorDtoV2024 - */ -export interface V3CreateConnectorDtoV2024 { - /** - * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - * @type {string} - * @memberof V3CreateConnectorDtoV2024 - */ - 'name': string; - /** - * The connector type. If not specified will be defaulted to \'custom \'+name - * @type {string} - * @memberof V3CreateConnectorDtoV2024 - */ - 'type'?: string; - /** - * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - * @type {string} - * @memberof V3CreateConnectorDtoV2024 - */ - 'className': string; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3CreateConnectorDtoV2024 - */ - 'directConnect'?: boolean; - /** - * The connector status - * @type {string} - * @memberof V3CreateConnectorDtoV2024 - */ - 'status'?: V3CreateConnectorDtoV2024StatusV2024; -} - -export const V3CreateConnectorDtoV2024StatusV2024 = { - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3CreateConnectorDtoV2024StatusV2024 = typeof V3CreateConnectorDtoV2024StatusV2024[keyof typeof V3CreateConnectorDtoV2024StatusV2024]; - -/** - * Details about the `CLUSTER` or `SOURCE` that initiated this event. - * @export - * @interface VAClusterStatusChangeEventApplicationV2024 - */ -export interface VAClusterStatusChangeEventApplicationV2024 { - /** - * The GUID of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2024 - */ - 'id': string; - /** - * The name of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2024 - */ - 'name': string; - /** - * Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. - * @type {{ [key: string]: any; }} - * @memberof VAClusterStatusChangeEventApplicationV2024 - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * The results of the most recent health check. - * @export - * @interface VAClusterStatusChangeEventHealthCheckResultV2024 - */ -export interface VAClusterStatusChangeEventHealthCheckResultV2024 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2024 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2024 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2024 - */ - 'status': VAClusterStatusChangeEventHealthCheckResultV2024StatusV2024; -} - -export const VAClusterStatusChangeEventHealthCheckResultV2024StatusV2024 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventHealthCheckResultV2024StatusV2024 = typeof VAClusterStatusChangeEventHealthCheckResultV2024StatusV2024[keyof typeof VAClusterStatusChangeEventHealthCheckResultV2024StatusV2024]; - -/** - * The results of the last health check. - * @export - * @interface VAClusterStatusChangeEventPreviousHealthCheckResultV2024 - */ -export interface VAClusterStatusChangeEventPreviousHealthCheckResultV2024 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2024 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2024 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2024 - */ - 'status': VAClusterStatusChangeEventPreviousHealthCheckResultV2024StatusV2024; -} - -export const VAClusterStatusChangeEventPreviousHealthCheckResultV2024StatusV2024 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventPreviousHealthCheckResultV2024StatusV2024 = typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2024StatusV2024[keyof typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2024StatusV2024]; - -/** - * - * @export - * @interface VAClusterStatusChangeEventV2024 - */ -export interface VAClusterStatusChangeEventV2024 { - /** - * The date and time the status change occurred. - * @type {string} - * @memberof VAClusterStatusChangeEventV2024 - */ - 'created': string; - /** - * The type of the object that initiated this event. - * @type {object} - * @memberof VAClusterStatusChangeEventV2024 - */ - 'type': VAClusterStatusChangeEventV2024TypeV2024; - /** - * - * @type {VAClusterStatusChangeEventApplicationV2024} - * @memberof VAClusterStatusChangeEventV2024 - */ - 'application': VAClusterStatusChangeEventApplicationV2024; - /** - * - * @type {VAClusterStatusChangeEventHealthCheckResultV2024} - * @memberof VAClusterStatusChangeEventV2024 - */ - 'healthCheckResult': VAClusterStatusChangeEventHealthCheckResultV2024; - /** - * - * @type {VAClusterStatusChangeEventPreviousHealthCheckResultV2024} - * @memberof VAClusterStatusChangeEventV2024 - */ - 'previousHealthCheckResult': VAClusterStatusChangeEventPreviousHealthCheckResultV2024; -} - -export const VAClusterStatusChangeEventV2024TypeV2024 = { - Source: 'SOURCE', - Cluster: 'CLUSTER' -} as const; - -export type VAClusterStatusChangeEventV2024TypeV2024 = typeof VAClusterStatusChangeEventV2024TypeV2024[keyof typeof VAClusterStatusChangeEventV2024TypeV2024]; - -/** - * - * @export - * @interface ValidateFilterInputDtoV2024 - */ -export interface ValidateFilterInputDtoV2024 { - /** - * Mock input to evaluate filter expression against. - * @type {object} - * @memberof ValidateFilterInputDtoV2024 - */ - 'input': object; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof ValidateFilterInputDtoV2024 - */ - 'filter': string; -} -/** - * - * @export - * @interface ValidateFilterOutputDtoV2024 - */ -export interface ValidateFilterOutputDtoV2024 { - /** - * When this field is true, the filter expression is valid against the input. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2024 - */ - 'isValid'?: boolean; - /** - * When this field is true, the filter expression is using a valid JSON path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2024 - */ - 'isValidJSONPath'?: boolean; - /** - * When this field is true, the filter expression is using an existing path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2024 - */ - 'isPathExist'?: boolean; -} -/** - * - * @export - * @interface ValueV2024 - */ -export interface ValueV2024 { - /** - * The type of attribute value - * @type {string} - * @memberof ValueV2024 - */ - 'type'?: string; - /** - * The attribute value - * @type {string} - * @memberof ValueV2024 - */ - 'value'?: string; -} -/** - * The types of objects supported for SOD violations - * @export - * @interface ViolationContextPolicyV2024 - */ -export interface ViolationContextPolicyV2024 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ViolationContextPolicyV2024 - */ - 'type'?: ViolationContextPolicyV2024TypeV2024; - /** - * SOD policy ID. - * @type {string} - * @memberof ViolationContextPolicyV2024 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof ViolationContextPolicyV2024 - */ - 'name'?: string; -} - -export const ViolationContextPolicyV2024TypeV2024 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ViolationContextPolicyV2024TypeV2024 = typeof ViolationContextPolicyV2024TypeV2024[keyof typeof ViolationContextPolicyV2024TypeV2024]; - -/** - * - * @export - * @interface ViolationContextV2024 - */ -export interface ViolationContextV2024 { - /** - * - * @type {ViolationContextPolicyV2024} - * @memberof ViolationContextV2024 - */ - 'policy'?: ViolationContextPolicyV2024; - /** - * - * @type {ExceptionAccessCriteriaV2024} - * @memberof ViolationContextV2024 - */ - 'conflictingAccessCriteria'?: ExceptionAccessCriteriaV2024; -} -/** - * The owner of the violation assignment config. - * @export - * @interface ViolationOwnerAssignmentConfigOwnerRefV2024 - */ -export interface ViolationOwnerAssignmentConfigOwnerRefV2024 { - /** - * Owner type. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2024 - */ - 'type'?: ViolationOwnerAssignmentConfigOwnerRefV2024TypeV2024 | null; - /** - * Owner\'s ID. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2024 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2024 - */ - 'name'?: string; -} - -export const ViolationOwnerAssignmentConfigOwnerRefV2024TypeV2024 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - Manager: 'MANAGER' -} as const; - -export type ViolationOwnerAssignmentConfigOwnerRefV2024TypeV2024 = typeof ViolationOwnerAssignmentConfigOwnerRefV2024TypeV2024[keyof typeof ViolationOwnerAssignmentConfigOwnerRefV2024TypeV2024]; - -/** - * - * @export - * @interface ViolationOwnerAssignmentConfigV2024 - */ -export interface ViolationOwnerAssignmentConfigV2024 { - /** - * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity - * @type {string} - * @memberof ViolationOwnerAssignmentConfigV2024 - */ - 'assignmentRule'?: ViolationOwnerAssignmentConfigV2024AssignmentRuleV2024 | null; - /** - * - * @type {ViolationOwnerAssignmentConfigOwnerRefV2024} - * @memberof ViolationOwnerAssignmentConfigV2024 - */ - 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRefV2024 | null; -} - -export const ViolationOwnerAssignmentConfigV2024AssignmentRuleV2024 = { - Manager: 'MANAGER', - Static: 'STATIC' -} as const; - -export type ViolationOwnerAssignmentConfigV2024AssignmentRuleV2024 = typeof ViolationOwnerAssignmentConfigV2024AssignmentRuleV2024[keyof typeof ViolationOwnerAssignmentConfigV2024AssignmentRuleV2024]; - -/** - * An object containing a listing of the SOD violation reasons detected by this check. - * @export - * @interface ViolationPredictionV2024 - */ -export interface ViolationPredictionV2024 { - /** - * List of Violation Contexts - * @type {Array} - * @memberof ViolationPredictionV2024 - */ - 'violationContexts'?: Array; -} -/** - * - * @export - * @interface VisibilityCriteriaV2024 - */ -export interface VisibilityCriteriaV2024 { - /** - * - * @type {ExpressionV2024} - * @memberof VisibilityCriteriaV2024 - */ - 'expression'?: ExpressionV2024; -} -/** - * - * @export - * @interface WorkItemForwardV2024 - */ -export interface WorkItemForwardV2024 { - /** - * The ID of the identity to forward this work item to. - * @type {string} - * @memberof WorkItemForwardV2024 - */ - 'targetOwnerId': string; - /** - * Comments to send to the target owner - * @type {string} - * @memberof WorkItemForwardV2024 - */ - 'comment': string; - /** - * If true, send a notification to the target owner. - * @type {boolean} - * @memberof WorkItemForwardV2024 - */ - 'sendNotifications'?: boolean; -} -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateManualWorkItemsV2024 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateManualWorkItemsV2024 = typeof WorkItemStateManualWorkItemsV2024[keyof typeof WorkItemStateManualWorkItemsV2024]; - - -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateV2024 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateV2024 = typeof WorkItemStateV2024[keyof typeof WorkItemStateV2024]; - - -/** - * The type of the work item - * @export - * @enum {string} - */ - -export const WorkItemTypeManualWorkItemsV2024 = { - Generic: 'Generic', - Certification: 'Certification', - Remediation: 'Remediation', - Delegation: 'Delegation', - Approval: 'Approval', - ViolationReview: 'ViolationReview', - Form: 'Form', - PolicyViolation: 'PolicyViolation', - Challenge: 'Challenge', - ImpactAnalysis: 'ImpactAnalysis', - Signoff: 'Signoff', - Event: 'Event', - ManualAction: 'ManualAction', - Test: 'Test' -} as const; - -export type WorkItemTypeManualWorkItemsV2024 = typeof WorkItemTypeManualWorkItemsV2024[keyof typeof WorkItemTypeManualWorkItemsV2024]; - - -/** - * - * @export - * @interface WorkItemsCountV2024 - */ -export interface WorkItemsCountV2024 { - /** - * The count of work items - * @type {number} - * @memberof WorkItemsCountV2024 - */ - 'count'?: number; -} -/** - * - * @export - * @interface WorkItemsFormV2024 - */ -export interface WorkItemsFormV2024 { - /** - * ID of the form - * @type {string} - * @memberof WorkItemsFormV2024 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof WorkItemsFormV2024 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof WorkItemsFormV2024 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof WorkItemsFormV2024 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof WorkItemsFormV2024 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof WorkItemsFormV2024 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface WorkItemsSummaryV2024 - */ -export interface WorkItemsSummaryV2024 { - /** - * The count of open work items - * @type {number} - * @memberof WorkItemsSummaryV2024 - */ - 'open'?: number; - /** - * The count of completed work items - * @type {number} - * @memberof WorkItemsSummaryV2024 - */ - 'completed'?: number; - /** - * The count of total work items - * @type {number} - * @memberof WorkItemsSummaryV2024 - */ - 'total'?: number; -} -/** - * - * @export - * @interface WorkItemsV2024 - */ -export interface WorkItemsV2024 { - /** - * ID of the work item - * @type {string} - * @memberof WorkItemsV2024 - */ - 'id'?: string; - /** - * ID of the requester - * @type {string} - * @memberof WorkItemsV2024 - */ - 'requesterId'?: string | null; - /** - * The displayname of the requester - * @type {string} - * @memberof WorkItemsV2024 - */ - 'requesterDisplayName'?: string | null; - /** - * The ID of the owner - * @type {string} - * @memberof WorkItemsV2024 - */ - 'ownerId'?: string | null; - /** - * The name of the owner - * @type {string} - * @memberof WorkItemsV2024 - */ - 'ownerName'?: string; - /** - * Time when the work item was created - * @type {string} - * @memberof WorkItemsV2024 - */ - 'created'?: string; - /** - * Time when the work item was last updated - * @type {string} - * @memberof WorkItemsV2024 - */ - 'modified'?: string | null; - /** - * The description of the work item - * @type {string} - * @memberof WorkItemsV2024 - */ - 'description'?: string; - /** - * - * @type {WorkItemStateManualWorkItemsV2024} - * @memberof WorkItemsV2024 - */ - 'state'?: WorkItemStateManualWorkItemsV2024; - /** - * - * @type {WorkItemTypeManualWorkItemsV2024} - * @memberof WorkItemsV2024 - */ - 'type'?: WorkItemTypeManualWorkItemsV2024; - /** - * A list of remediation items - * @type {Array} - * @memberof WorkItemsV2024 - */ - 'remediationItems'?: Array | null; - /** - * A list of items that need to be approved - * @type {Array} - * @memberof WorkItemsV2024 - */ - 'approvalItems'?: Array | null; - /** - * The work item name - * @type {string} - * @memberof WorkItemsV2024 - */ - 'name'?: string | null; - /** - * The time at which the work item completed - * @type {string} - * @memberof WorkItemsV2024 - */ - 'completed'?: string | null; - /** - * The number of items in the work item - * @type {number} - * @memberof WorkItemsV2024 - */ - 'numItems'?: number | null; - /** - * - * @type {WorkItemsFormV2024} - * @memberof WorkItemsV2024 - */ - 'form'?: WorkItemsFormV2024; - /** - * An array of errors that ocurred during the work item - * @type {Array} - * @memberof WorkItemsV2024 - */ - 'errors'?: Array; -} - - -/** - * Workflow creator\'s identity. - * @export - * @interface WorkflowAllOfCreatorV2024 - */ -export interface WorkflowAllOfCreatorV2024 { - /** - * Workflow creator\'s DTO type. - * @type {string} - * @memberof WorkflowAllOfCreatorV2024 - */ - 'type'?: WorkflowAllOfCreatorV2024TypeV2024; - /** - * Workflow creator\'s identity ID. - * @type {string} - * @memberof WorkflowAllOfCreatorV2024 - */ - 'id'?: string; - /** - * Workflow creator\'s display name. - * @type {string} - * @memberof WorkflowAllOfCreatorV2024 - */ - 'name'?: string; -} - -export const WorkflowAllOfCreatorV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowAllOfCreatorV2024TypeV2024 = typeof WorkflowAllOfCreatorV2024TypeV2024[keyof typeof WorkflowAllOfCreatorV2024TypeV2024]; - -/** - * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - * @export - * @interface WorkflowBodyOwnerV2024 - */ -export interface WorkflowBodyOwnerV2024 { - /** - * The type of object that is referenced - * @type {string} - * @memberof WorkflowBodyOwnerV2024 - */ - 'type'?: WorkflowBodyOwnerV2024TypeV2024; - /** - * The unique ID of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2024 - */ - 'id'?: string; - /** - * The name of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2024 - */ - 'name'?: string; -} - -export const WorkflowBodyOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowBodyOwnerV2024TypeV2024 = typeof WorkflowBodyOwnerV2024TypeV2024[keyof typeof WorkflowBodyOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowBodyV2024 - */ -export interface WorkflowBodyV2024 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBodyV2024 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2024} - * @memberof WorkflowBodyV2024 - */ - 'owner'?: WorkflowBodyOwnerV2024; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBodyV2024 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2024} - * @memberof WorkflowBodyV2024 - */ - 'definition'?: WorkflowDefinitionV2024; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBodyV2024 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2024} - * @memberof WorkflowBodyV2024 - */ - 'trigger'?: WorkflowTriggerV2024; -} -/** - * The map of steps that the workflow will execute. - * @export - * @interface WorkflowDefinitionV2024 - */ -export interface WorkflowDefinitionV2024 { - /** - * The name of the starting step. - * @type {string} - * @memberof WorkflowDefinitionV2024 - */ - 'start'?: string; - /** - * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - * @type {{ [key: string]: any; }} - * @memberof WorkflowDefinitionV2024 - */ - 'steps'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface WorkflowExecutionEventV2024 - */ -export interface WorkflowExecutionEventV2024 { - /** - * The type of event - * @type {string} - * @memberof WorkflowExecutionEventV2024 - */ - 'type'?: WorkflowExecutionEventV2024TypeV2024; - /** - * The date-time when the event occurred - * @type {string} - * @memberof WorkflowExecutionEventV2024 - */ - 'timestamp'?: string; - /** - * Additional attributes associated with the event - * @type {object} - * @memberof WorkflowExecutionEventV2024 - */ - 'attributes'?: object; -} - -export const WorkflowExecutionEventV2024TypeV2024 = { - WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', - WorkflowExecutionStarted: 'WorkflowExecutionStarted', - WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', - WorkflowExecutionFailed: 'WorkflowExecutionFailed', - WorkflowTaskScheduled: 'WorkflowTaskScheduled', - WorkflowTaskStarted: 'WorkflowTaskStarted', - WorkflowTaskCompleted: 'WorkflowTaskCompleted', - WorkflowTaskFailed: 'WorkflowTaskFailed', - ActivityTaskScheduled: 'ActivityTaskScheduled', - ActivityTaskStarted: 'ActivityTaskStarted', - ActivityTaskCompleted: 'ActivityTaskCompleted', - ActivityTaskFailed: 'ActivityTaskFailed', - StartChildWorkflowExecutionInitiated: 'StartChildWorkflowExecutionInitiated', - ChildWorkflowExecutionStarted: 'ChildWorkflowExecutionStarted', - ChildWorkflowExecutionCompleted: 'ChildWorkflowExecutionCompleted', - ChildWorkflowExecutionFailed: 'ChildWorkflowExecutionFailed' -} as const; - -export type WorkflowExecutionEventV2024TypeV2024 = typeof WorkflowExecutionEventV2024TypeV2024[keyof typeof WorkflowExecutionEventV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowExecutionV2024 - */ -export interface WorkflowExecutionV2024 { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'id'?: string; - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'workflowId'?: string; - /** - * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'requestId'?: string; - /** - * Date/time when the workflow started. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'startTime'?: string; - /** - * Date/time when the workflow ended. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'closeTime'?: string; - /** - * Workflow execution status. - * @type {string} - * @memberof WorkflowExecutionV2024 - */ - 'status'?: WorkflowExecutionV2024StatusV2024; -} - -export const WorkflowExecutionV2024StatusV2024 = { - Completed: 'Completed', - Failed: 'Failed', - Canceled: 'Canceled', - Queued: 'Queued', - Running: 'Running' -} as const; - -export type WorkflowExecutionV2024StatusV2024 = typeof WorkflowExecutionV2024StatusV2024[keyof typeof WorkflowExecutionV2024StatusV2024]; - -/** - * @type WorkflowLibraryActionExampleOutputV2024 - * @export - */ -export type WorkflowLibraryActionExampleOutputV2024 = Array | object; - -/** - * - * @export - * @interface WorkflowLibraryActionV2024 - */ -export interface WorkflowLibraryActionV2024 { - /** - * Action ID. This is a static namespaced ID for the action - * @type {string} - * @memberof WorkflowLibraryActionV2024 - */ - 'id'?: string; - /** - * Action Name - * @type {string} - * @memberof WorkflowLibraryActionV2024 - */ - 'name'?: string; - /** - * Action type - * @type {string} - * @memberof WorkflowLibraryActionV2024 - */ - 'type'?: string; - /** - * Action Description - * @type {string} - * @memberof WorkflowLibraryActionV2024 - */ - 'description'?: string; - /** - * One or more inputs that the action accepts - * @type {Array} - * @memberof WorkflowLibraryActionV2024 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2024} - * @memberof WorkflowLibraryActionV2024 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2024; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2024 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryActionV2024 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof WorkflowLibraryActionV2024 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2024 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryActionV2024 - */ - 'isDynamicSchema'?: boolean; - /** - * Defines the output schema, if any, that this action produces. - * @type {object} - * @memberof WorkflowLibraryActionV2024 - */ - 'outputSchema'?: object; -} -/** - * - * @export - * @interface WorkflowLibraryFormFieldsV2024 - */ -export interface WorkflowLibraryFormFieldsV2024 { - /** - * Description of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'description'?: string; - /** - * Describes the form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'helpText'?: string; - /** - * A human readable name for this form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'label'?: string; - /** - * The name of the input attribute - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'name'?: string; - /** - * Denotes if this field is a required attribute - * @type {boolean} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'required'?: boolean; - /** - * The type of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2024 - */ - 'type'?: WorkflowLibraryFormFieldsV2024TypeV2024 | null; -} - -export const WorkflowLibraryFormFieldsV2024TypeV2024 = { - Text: 'text', - Textarea: 'textarea', - Boolean: 'boolean', - Email: 'email', - Url: 'url', - Number: 'number', - Json: 'json', - Checkbox: 'checkbox', - Jsonpath: 'jsonpath', - Select: 'select', - MultiType: 'multiType', - Duration: 'duration', - Toggle: 'toggle', - FormPicker: 'formPicker', - IdentityPicker: 'identityPicker', - GovernanceGroupPicker: 'governanceGroupPicker', - String: 'string', - Object: 'object', - Array: 'array', - Secret: 'secret', - KeyValuePairs: 'keyValuePairs', - EmailPicker: 'emailPicker', - AdvancedToggle: 'advancedToggle', - VariableCreator: 'variableCreator', - HtmlEditor: 'htmlEditor' -} as const; - -export type WorkflowLibraryFormFieldsV2024TypeV2024 = typeof WorkflowLibraryFormFieldsV2024TypeV2024[keyof typeof WorkflowLibraryFormFieldsV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowLibraryOperatorV2024 - */ -export interface WorkflowLibraryOperatorV2024 { - /** - * Operator ID. - * @type {string} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'isDynamicSchema'?: boolean; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'isSimulationEnabled'?: boolean; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof WorkflowLibraryOperatorV2024 - */ - 'formFields'?: Array | null; -} -/** - * - * @export - * @interface WorkflowLibraryTriggerV2024 - */ -export interface WorkflowLibraryTriggerV2024 { - /** - * Trigger ID. This is a static namespaced ID for the trigger. - * @type {string} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'id'?: string; - /** - * Trigger type - * @type {string} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'type'?: WorkflowLibraryTriggerV2024TypeV2024; - /** - * Whether the trigger is deprecated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'deprecated'?: boolean; - /** - * Date the trigger was deprecated, if applicable. - * @type {string} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'deprecatedBy'?: string; - /** - * Whether the trigger can be simulated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'isSimulationEnabled'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'outputSchema'?: object; - /** - * Trigger Name - * @type {string} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'name'?: string; - /** - * Trigger Description - * @type {string} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'isDynamicSchema'?: boolean; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'inputExample'?: object | null; - /** - * One or more inputs that the trigger accepts - * @type {Array} - * @memberof WorkflowLibraryTriggerV2024 - */ - 'formFields'?: Array | null; -} - -export const WorkflowLibraryTriggerV2024TypeV2024 = { - Event: 'EVENT', - Scheduled: 'SCHEDULED', - External: 'EXTERNAL', - AccessRequestTrigger: 'AccessRequestTrigger' -} as const; - -export type WorkflowLibraryTriggerV2024TypeV2024 = typeof WorkflowLibraryTriggerV2024TypeV2024[keyof typeof WorkflowLibraryTriggerV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowModifiedByV2024 - */ -export interface WorkflowModifiedByV2024 { - /** - * - * @type {string} - * @memberof WorkflowModifiedByV2024 - */ - 'type'?: WorkflowModifiedByV2024TypeV2024; - /** - * Identity ID - * @type {string} - * @memberof WorkflowModifiedByV2024 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof WorkflowModifiedByV2024 - */ - 'name'?: string; -} - -export const WorkflowModifiedByV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowModifiedByV2024TypeV2024 = typeof WorkflowModifiedByV2024TypeV2024[keyof typeof WorkflowModifiedByV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowOAuthClientV2024 - */ -export interface WorkflowOAuthClientV2024 { - /** - * OAuth client ID for the trigger. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowOAuthClientV2024 - */ - 'id'?: string; - /** - * OAuthClient secret. - * @type {string} - * @memberof WorkflowOAuthClientV2024 - */ - 'secret'?: string; - /** - * URL for the external trigger to invoke - * @type {string} - * @memberof WorkflowOAuthClientV2024 - */ - 'url'?: string; -} -/** - * Workflow Trigger Attributes. - * @export - * @interface WorkflowTriggerAttributesV2024 - */ -export interface WorkflowTriggerAttributesV2024 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'filter.$'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'formDefinitionId'?: string | null; - /** - * A unique name for the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'name'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'url'?: string | null; - /** - * Frequency of execution - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'frequency': WorkflowTriggerAttributesV2024FrequencyV2024 | null; - /** - * Time zone identifier - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2024 - */ - 'yearlyTimes'?: Array | null; -} - -export const WorkflowTriggerAttributesV2024FrequencyV2024 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type WorkflowTriggerAttributesV2024FrequencyV2024 = typeof WorkflowTriggerAttributesV2024FrequencyV2024[keyof typeof WorkflowTriggerAttributesV2024FrequencyV2024]; - -/** - * The trigger that starts the workflow - * @export - * @interface WorkflowTriggerV2024 - */ -export interface WorkflowTriggerV2024 { - /** - * The trigger type - * @type {string} - * @memberof WorkflowTriggerV2024 - */ - 'type': WorkflowTriggerV2024TypeV2024; - /** - * - * @type {string} - * @memberof WorkflowTriggerV2024 - */ - 'displayName'?: string | null; - /** - * - * @type {WorkflowTriggerAttributesV2024} - * @memberof WorkflowTriggerV2024 - */ - 'attributes': WorkflowTriggerAttributesV2024 | null; -} - -export const WorkflowTriggerV2024TypeV2024 = { - Event: 'EVENT', - External: 'EXTERNAL', - Scheduled: 'SCHEDULED', - Empty: '' -} as const; - -export type WorkflowTriggerV2024TypeV2024 = typeof WorkflowTriggerV2024TypeV2024[keyof typeof WorkflowTriggerV2024TypeV2024]; - -/** - * - * @export - * @interface WorkflowV2024 - */ -export interface WorkflowV2024 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowV2024 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2024} - * @memberof WorkflowV2024 - */ - 'owner'?: WorkflowBodyOwnerV2024; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowV2024 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2024} - * @memberof WorkflowV2024 - */ - 'definition'?: WorkflowDefinitionV2024; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowV2024 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2024} - * @memberof WorkflowV2024 - */ - 'trigger'?: WorkflowTriggerV2024; - /** - * Workflow ID. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowV2024 - */ - 'id'?: string; - /** - * The number of times this workflow has been executed. - * @type {number} - * @memberof WorkflowV2024 - */ - 'executionCount'?: number; - /** - * The number of times this workflow has failed during execution. - * @type {number} - * @memberof WorkflowV2024 - */ - 'failureCount'?: number; - /** - * The date and time the workflow was created. - * @type {string} - * @memberof WorkflowV2024 - */ - 'created'?: string; - /** - * The date and time the workflow was modified. - * @type {string} - * @memberof WorkflowV2024 - */ - 'modified'?: string; - /** - * - * @type {WorkflowModifiedByV2024} - * @memberof WorkflowV2024 - */ - 'modifiedBy'?: WorkflowModifiedByV2024; - /** - * - * @type {WorkflowAllOfCreatorV2024} - * @memberof WorkflowV2024 - */ - 'creator'?: WorkflowAllOfCreatorV2024; -} -/** - * - * @export - * @interface WorkgroupBulkDeleteRequestV2024 - */ -export interface WorkgroupBulkDeleteRequestV2024 { - /** - * List of IDs of Governance Groups to be deleted. - * @type {Array} - * @memberof WorkgroupBulkDeleteRequestV2024 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoObjectV2024 - */ -export interface WorkgroupConnectionDtoObjectV2024 { - /** - * - * @type {ConnectedObjectTypeV2024 & object} - * @memberof WorkgroupConnectionDtoObjectV2024 - */ - 'type'?: ConnectedObjectTypeV2024 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2024 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2024 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2024 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoV2024 - */ -export interface WorkgroupConnectionDtoV2024 { - /** - * - * @type {WorkgroupConnectionDtoObjectV2024} - * @memberof WorkgroupConnectionDtoV2024 - */ - 'object'?: WorkgroupConnectionDtoObjectV2024; - /** - * Connection Type. - * @type {string} - * @memberof WorkgroupConnectionDtoV2024 - */ - 'connectionType'?: WorkgroupConnectionDtoV2024ConnectionTypeV2024; -} - -export const WorkgroupConnectionDtoV2024ConnectionTypeV2024 = { - AccessRequestReviewer: 'AccessRequestReviewer', - Owner: 'Owner', - ManagementWorkgroup: 'ManagementWorkgroup' -} as const; - -export type WorkgroupConnectionDtoV2024ConnectionTypeV2024 = typeof WorkgroupConnectionDtoV2024ConnectionTypeV2024[keyof typeof WorkgroupConnectionDtoV2024ConnectionTypeV2024]; - -/** - * - * @export - * @interface WorkgroupDeleteItemV2024 - */ -export interface WorkgroupDeleteItemV2024 { - /** - * Id of the Governance Group. - * @type {string} - * @memberof WorkgroupDeleteItemV2024 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. - * @type {number} - * @memberof WorkgroupDeleteItemV2024 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupDeleteItemV2024 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupDtoOwnerV2024 - */ -export interface WorkgroupDtoOwnerV2024 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof WorkgroupDtoOwnerV2024 - */ - 'type'?: WorkgroupDtoOwnerV2024TypeV2024; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof WorkgroupDtoOwnerV2024 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof WorkgroupDtoOwnerV2024 - */ - 'name'?: string; - /** - * The display name of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2024 - */ - 'displayName'?: string; - /** - * The primary email address of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2024 - */ - 'emailAddress'?: string; -} - -export const WorkgroupDtoOwnerV2024TypeV2024 = { - Identity: 'IDENTITY' -} as const; - -export type WorkgroupDtoOwnerV2024TypeV2024 = typeof WorkgroupDtoOwnerV2024TypeV2024[keyof typeof WorkgroupDtoOwnerV2024TypeV2024]; - -/** - * - * @export - * @interface WorkgroupDtoV2024 - */ -export interface WorkgroupDtoV2024 { - /** - * - * @type {WorkgroupDtoOwnerV2024} - * @memberof WorkgroupDtoV2024 - */ - 'owner'?: WorkgroupDtoOwnerV2024; - /** - * Governance group ID. - * @type {string} - * @memberof WorkgroupDtoV2024 - */ - 'id'?: string; - /** - * Governance group name. - * @type {string} - * @memberof WorkgroupDtoV2024 - */ - 'name'?: string; - /** - * Governance group description. - * @type {string} - * @memberof WorkgroupDtoV2024 - */ - 'description'?: string; - /** - * Number of members in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2024 - */ - 'memberCount'?: number; - /** - * Number of connections in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2024 - */ - 'connectionCount'?: number; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2024 - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2024 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberAddItemV2024 - */ -export interface WorkgroupMemberAddItemV2024 { - /** - * Identifier of identity in bulk member add request. - * @type {string} - * @memberof WorkgroupMemberAddItemV2024 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberAddItemV2024 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberAddItemV2024 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberDeleteItemV2024 - */ -export interface WorkgroupMemberDeleteItemV2024 { - /** - * Identifier of identity in bulk member add /remove request. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2024 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberDeleteItemV2024 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2024 - */ - 'description'?: string; -} - -/** - * AccessModelMetadataV2024Api - axios parameter creator - * @export - */ -export const AccessModelMetadataV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2024} attributeDTOV2024 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute: async (attributeDTOV2024: AttributeDTOV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeDTOV2024' is not null or undefined - assertParamExists('createAccessModelMetadataAttribute', 'attributeDTOV2024', attributeDTOV2024) - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeDTOV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2024} attributeValueDTOV2024 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue: async (key: string, attributeValueDTOV2024: AttributeValueDTOV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'attributeValueDTOV2024' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'attributeValueDTOV2024', attributeValueDTOV2024) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeValueDTOV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttribute', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'value', value) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('listAccessModelMetadataAttributeValue', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2024 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute: async (key: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'key', key) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2024 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue: async (key: string, value: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'value', value) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessModelMetadataV2024Api - functional programming interface - * @export - */ -export const AccessModelMetadataV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessModelMetadataV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2024} attributeDTOV2024 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttribute(attributeDTOV2024: AttributeDTOV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttribute(attributeDTOV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.createAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2024} attributeValueDTOV2024 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttributeValue(key: string, attributeValueDTOV2024: AttributeValueDTOV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValue(key, attributeValueDTOV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.createAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttribute(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttribute(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.getAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttributeValue(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValue(key, value, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.getAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttribute(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttribute(filters, sorters, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.listAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttributeValue(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValue(key, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.listAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2024 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttribute(key: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttribute(key, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.updateAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2024 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttributeValue(key: string, value: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValue(key, value, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2024Api.updateAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessModelMetadataV2024Api - factory interface - * @export - */ -export const AccessModelMetadataV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessModelMetadataV2024ApiFp(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttribute(requestParameters.attributeDTOV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataAttribute operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest { - /** - * Attribute to create - * @type {AttributeDTOV2024} - * @memberof AccessModelMetadataV2024ApiCreateAccessModelMetadataAttribute - */ - readonly attributeDTOV2024: AttributeDTOV2024 -} - -/** - * Request parameters for createAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Attribute value to create - * @type {AttributeValueDTOV2024} - * @memberof AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValue - */ - readonly attributeValueDTOV2024: AttributeValueDTOV2024 -} - -/** - * Request parameters for getAccessModelMetadataAttribute operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttribute - */ - readonly key: string -} - -/** - * Request parameters for getAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValue - */ - readonly value: string -} - -/** - * Request parameters for listAccessModelMetadataAttribute operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest { - /** - * 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute - */ - 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: **name, key** - * @type {string} - * @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttribute - */ - 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 AccessModelMetadataV2024ApiListAccessModelMetadataAttribute - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue - */ - 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 AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValue - */ - readonly count?: boolean -} - -/** - * Request parameters for updateAccessModelMetadataAttribute operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttribute - */ - readonly key: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttribute - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for updateAccessModelMetadataAttributeValue operation in AccessModelMetadataV2024Api. - * @export - * @interface AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValue - */ - readonly value: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValue - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * AccessModelMetadataV2024Api - object-oriented interface - * @export - * @class AccessModelMetadataV2024Api - * @extends {BaseAPI} - */ -export class AccessModelMetadataV2024Api extends BaseAPI { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).createAccessModelMetadataAttribute(requestParameters.attributeDTOV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2024Api - */ - public updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2024ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2024ApiFp(this.configuration).updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessProfilesV2024Api - axios parameter creator - * @export - */ -export const AccessProfilesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2024} accessProfileV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile: async (accessProfileV2024: AccessProfileV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileV2024' is not null or undefined - assertParamExists('createAccessProfile', 'accessProfileV2024', accessProfileV2024) - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2024} accessProfileBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk: async (accessProfileBulkDeleteRequestV2024: AccessProfileBulkDeleteRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkDeleteRequestV2024' is not null or undefined - assertParamExists('deleteAccessProfilesInBulk', 'accessProfileBulkDeleteRequestV2024', accessProfileBulkDeleteRequestV2024) - const localVarPath = `/access-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfileEntitlements', 'id', id) - const localVarPath = `/access-profiles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAccessProfile', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAccessProfile', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk: async (accessProfileBulkUpdateRequestInnerV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkUpdateRequestInnerV2024' is not null or undefined - assertParamExists('updateAccessProfilesInBulk', 'accessProfileBulkUpdateRequestInnerV2024', accessProfileBulkUpdateRequestInnerV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-profiles/bulk-update-requestable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkUpdateRequestInnerV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessProfilesV2024Api - functional programming interface - * @export - */ -export const AccessProfilesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessProfilesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2024} accessProfileV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessProfile(accessProfileV2024: AccessProfileV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfile(accessProfileV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.createAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.deleteAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2024} accessProfileBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2024: AccessProfileBulkDeleteRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.deleteAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.getAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.getAccessProfileEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfiles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.listAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAccessProfile(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfile(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.patchAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2024Api.updateAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessProfilesV2024Api - factory interface - * @export - */ -export const AccessProfilesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessProfilesV2024ApiFp(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2024ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile(requestParameters: AccessProfilesV2024ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessProfile(requestParameters.accessProfileV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2024ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile(requestParameters: AccessProfilesV2024ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2024ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile(requestParameters: AccessProfilesV2024ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements(requestParameters: AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2024ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles(requestParameters: AccessProfilesV2024ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2024ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile(requestParameters: AccessProfilesV2024ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk(requestParameters: AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessProfile operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiCreateAccessProfileRequest - */ -export interface AccessProfilesV2024ApiCreateAccessProfileRequest { - /** - * - * @type {AccessProfileV2024} - * @memberof AccessProfilesV2024ApiCreateAccessProfile - */ - readonly accessProfileV2024: AccessProfileV2024 -} - -/** - * Request parameters for deleteAccessProfile operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiDeleteAccessProfileRequest - */ -export interface AccessProfilesV2024ApiDeleteAccessProfileRequest { - /** - * ID of the Access Profile to delete - * @type {string} - * @memberof AccessProfilesV2024ApiDeleteAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest { - /** - * - * @type {AccessProfileBulkDeleteRequestV2024} - * @memberof AccessProfilesV2024ApiDeleteAccessProfilesInBulk - */ - readonly accessProfileBulkDeleteRequestV2024: AccessProfileBulkDeleteRequestV2024 -} - -/** - * Request parameters for getAccessProfile operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiGetAccessProfileRequest - */ -export interface AccessProfilesV2024ApiGetAccessProfileRequest { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfilesV2024ApiGetAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for getAccessProfileEntitlements operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest - */ -export interface AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest { - /** - * ID of the access profile containing the entitlements. - * @type {string} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof AccessProfilesV2024ApiGetAccessProfileEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listAccessProfiles operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiListAccessProfilesRequest - */ -export interface AccessProfilesV2024ApiListAccessProfilesRequest { - /** - * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @type {string} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly forSubadmin?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly sorters?: string - - /** - * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly forSegmentIds?: string - - /** - * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @type {boolean} - * @memberof AccessProfilesV2024ApiListAccessProfiles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchAccessProfile operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiPatchAccessProfileRequest - */ -export interface AccessProfilesV2024ApiPatchAccessProfileRequest { - /** - * ID of the Access Profile to patch - * @type {string} - * @memberof AccessProfilesV2024ApiPatchAccessProfile - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AccessProfilesV2024ApiPatchAccessProfile - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for updateAccessProfilesInBulk operation in AccessProfilesV2024Api. - * @export - * @interface AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest { - /** - * - * @type {Array} - * @memberof AccessProfilesV2024ApiUpdateAccessProfilesInBulk - */ - readonly accessProfileBulkUpdateRequestInnerV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessProfilesV2024ApiUpdateAccessProfilesInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * AccessProfilesV2024Api - object-oriented interface - * @export - * @class AccessProfilesV2024Api - * @extends {BaseAPI} - */ -export class AccessProfilesV2024Api extends BaseAPI { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2024ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public createAccessProfile(requestParameters: AccessProfilesV2024ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).createAccessProfile(requestParameters.accessProfileV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2024ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public deleteAccessProfile(requestParameters: AccessProfilesV2024ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2024ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2024ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public getAccessProfile(requestParameters: AccessProfilesV2024ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public getAccessProfileEntitlements(requestParameters: AccessProfilesV2024ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2024ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public listAccessProfiles(requestParameters: AccessProfilesV2024ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2024ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public patchAccessProfile(requestParameters: AccessProfilesV2024ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2024Api - */ - public updateAccessProfilesInBulk(requestParameters: AccessProfilesV2024ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2024ApiFp(this.configuration).updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestApprovalsV2024Api - axios parameter creator - * @export - */ -export const AccessRequestApprovalsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2024} [commentDtoV2024] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest: async (approvalId: string, commentDtoV2024?: CommentDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('approveAccessRequest', 'approvalId', approvalId) - const localVarPath = `/access-request-approvals/{approvalId}/approve` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2024} forwardApprovalDtoV2024 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest: async (approvalId: string, forwardApprovalDtoV2024: ForwardApprovalDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('forwardAccessRequest', 'approvalId', approvalId) - // verify required parameter 'forwardApprovalDtoV2024' is not null or undefined - assertParamExists('forwardAccessRequest', 'forwardApprovalDtoV2024', forwardApprovalDtoV2024) - const localVarPath = `/access-request-approvals/{approvalId}/forward` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(forwardApprovalDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/approval-summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (fromDate !== undefined) { - localVarQueryParameter['from-date'] = fromDate; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers: async (accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestId' is not null or undefined - assertParamExists('listAccessRequestApprovers', 'accessRequestId', accessRequestId) - const localVarPath = `/access-request-approvals/{accessRequestId}/approvers` - .replace(`{${"accessRequestId"}}`, encodeURIComponent(String(accessRequestId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/pending`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2024} commentDtoV2024 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest: async (approvalId: string, commentDtoV2024: CommentDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('rejectAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDtoV2024' is not null or undefined - assertParamExists('rejectAccessRequest', 'commentDtoV2024', commentDtoV2024) - const localVarPath = `/access-request-approvals/{approvalId}/reject` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestApprovalsV2024Api - functional programming interface - * @export - */ -export const AccessRequestApprovalsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestApprovalsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2024} [commentDtoV2024] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveAccessRequest(approvalId: string, commentDtoV2024?: CommentDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequest(approvalId, commentDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.approveAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2024} forwardApprovalDtoV2024 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardAccessRequest(approvalId: string, forwardApprovalDtoV2024: ForwardApprovalDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequest(approvalId, forwardApprovalDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.forwardAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummary(ownerId, fromDate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.getAccessRequestApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestApprovers(accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestApprovers(accessRequestId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.listAccessRequestApprovers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.listCompletedApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.listPendingApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2024} commentDtoV2024 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectAccessRequest(approvalId: string, commentDtoV2024: CommentDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequest(approvalId, commentDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2024Api.rejectAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestApprovalsV2024Api - factory interface - * @export - */ -export const AccessRequestApprovalsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestApprovalsV2024ApiFp(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2024ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2024ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals(requestParameters: AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2024ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals(requestParameters: AccessRequestApprovalsV2024ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2024ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveAccessRequest operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiApproveAccessRequestRequest - */ -export interface AccessRequestApprovalsV2024ApiApproveAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiApproveAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2024} - * @memberof AccessRequestApprovalsV2024ApiApproveAccessRequest - */ - readonly commentDtoV2024?: CommentDtoV2024 -} - -/** - * Request parameters for forwardAccessRequest operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiForwardAccessRequestRequest - */ -export interface AccessRequestApprovalsV2024ApiForwardAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiForwardAccessRequest - */ - readonly approvalId: string - - /** - * Information about the forwarded approval. - * @type {ForwardApprovalDtoV2024} - * @memberof AccessRequestApprovalsV2024ApiForwardAccessRequest - */ - readonly forwardApprovalDtoV2024: ForwardApprovalDtoV2024 -} - -/** - * Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest - */ -export interface AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest { - /** - * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummary - */ - readonly ownerId?: string - - /** - * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummary - */ - readonly fromDate?: string -} - -/** - * Request parameters for listAccessRequestApprovers operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest - */ -export interface AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest { - /** - * Access Request ID. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListAccessRequestApprovers - */ - readonly accessRequestId: string - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListAccessRequestApprovers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListAccessRequestApprovers - */ - readonly offset?: number - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestApprovalsV2024ApiListAccessRequestApprovers - */ - readonly count?: boolean -} - -/** - * Request parameters for listCompletedApprovals operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest - */ -export interface AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest { - /** - * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListCompletedApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listPendingApprovals operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiListPendingApprovalsRequest - */ -export interface AccessRequestApprovalsV2024ApiListPendingApprovalsRequest { - /** - * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiListPendingApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for rejectAccessRequest operation in AccessRequestApprovalsV2024Api. - * @export - * @interface AccessRequestApprovalsV2024ApiRejectAccessRequestRequest - */ -export interface AccessRequestApprovalsV2024ApiRejectAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2024ApiRejectAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2024} - * @memberof AccessRequestApprovalsV2024ApiRejectAccessRequest - */ - readonly commentDtoV2024: CommentDtoV2024 -} - -/** - * AccessRequestApprovalsV2024Api - object-oriented interface - * @export - * @class AccessRequestApprovalsV2024Api - * @extends {BaseAPI} - */ -export class AccessRequestApprovalsV2024Api extends BaseAPI { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2024ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public approveAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2024ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public forwardAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2024ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2024ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public listCompletedApprovals(requestParameters: AccessRequestApprovalsV2024ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2024ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public listPendingApprovals(requestParameters: AccessRequestApprovalsV2024ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2024ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2024Api - */ - public rejectAccessRequest(requestParameters: AccessRequestApprovalsV2024ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2024ApiFp(this.configuration).rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestIdentityMetricsV2024Api - axios parameter creator - * @export - */ -export const AccessRequestIdentityMetricsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2024} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics: async (identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'identityId', identityId) - // verify required parameter 'requestedObjectId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'requestedObjectId', requestedObjectId) - // verify required parameter 'type' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'type', type) - const localVarPath = `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"requestedObjectId"}}`, encodeURIComponent(String(requestedObjectId))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2024Api - functional programming interface - * @export - */ -export const AccessRequestIdentityMetricsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestIdentityMetricsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2024} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestIdentityMetrics(identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestIdentityMetrics(identityId, requestedObjectId, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestIdentityMetricsV2024Api.getAccessRequestIdentityMetrics']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2024Api - factory interface - * @export - */ -export const AccessRequestIdentityMetricsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestIdentityMetricsV2024ApiFp(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccessRequestIdentityMetrics operation in AccessRequestIdentityMetricsV2024Api. - * @export - * @interface AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest - */ -export interface AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest { - /** - * Manager\'s identity ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetrics - */ - readonly identityId: string - - /** - * Requested access item\'s ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetrics - */ - readonly requestedObjectId: string - - /** - * Requested access item\'s type. - * @type {'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE'} - * @memberof AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetrics - */ - readonly type: GetAccessRequestIdentityMetricsTypeV2024 -} - -/** - * AccessRequestIdentityMetricsV2024Api - object-oriented interface - * @export - * @class AccessRequestIdentityMetricsV2024Api - * @extends {BaseAPI} - */ -export class AccessRequestIdentityMetricsV2024Api extends BaseAPI { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestIdentityMetricsV2024Api - */ - public getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2024ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestIdentityMetricsV2024ApiFp(this.configuration).getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetAccessRequestIdentityMetricsTypeV2024 = { - Entitlement: 'ENTITLEMENT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE' -} as const; -export type GetAccessRequestIdentityMetricsTypeV2024 = typeof GetAccessRequestIdentityMetricsTypeV2024[keyof typeof GetAccessRequestIdentityMetricsTypeV2024]; - - -/** - * AccessRequestsV2024Api - axios parameter creator - * @export - */ -export const AccessRequestsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2024} bulkApproveAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest: async (bulkApproveAccessRequestV2024: BulkApproveAccessRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveAccessRequestV2024' is not null or undefined - assertParamExists('approveBulkAccessRequest', 'bulkApproveAccessRequestV2024', bulkApproveAccessRequestV2024) - const localVarPath = `/access-request-approvals/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveAccessRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2024} cancelAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest: async (cancelAccessRequestV2024: CancelAccessRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cancelAccessRequestV2024' is not null or undefined - assertParamExists('cancelAccessRequest', 'cancelAccessRequestV2024', cancelAccessRequestV2024) - const localVarPath = `/access-requests/cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(cancelAccessRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2024} bulkCancelAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk: async (bulkCancelAccessRequestV2024: BulkCancelAccessRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkCancelAccessRequestV2024' is not null or undefined - assertParamExists('cancelAccessRequestInBulk', 'bulkCancelAccessRequestV2024', bulkCancelAccessRequestV2024) - const localVarPath = `/access-requests/bulk-cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkCancelAccessRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2024} closeAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest: async (closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'closeAccessRequestV2024' is not null or undefined - assertParamExists('closeAccessRequest', 'closeAccessRequestV2024', closeAccessRequestV2024) - const localVarPath = `/access-requests/close`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(closeAccessRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2024} accessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest: async (accessRequestV2024: AccessRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestV2024' is not null or undefined - assertParamExists('createAccessRequest', 'accessRequestV2024', accessRequestV2024) - const localVarPath = `/access-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity: async (identityId: string, entitlementId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'identityId', identityId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'entitlementId', entitlementId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/revocable-objects` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus: async (xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('listAdministratorsAccessRequestStatus', 'xSailPointExperimental', xSailPointExperimental) - const localVarPath = `/access-request-administration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2024} accountsSelectionRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections: async (accountsSelectionRequestV2024: AccountsSelectionRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountsSelectionRequestV2024' is not null or undefined - assertParamExists('loadAccountSelections', 'accountsSelectionRequestV2024', accountsSelectionRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-requests/accounts-selection`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountsSelectionRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2024} accessRequestConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig: async (accessRequestConfigV2024: AccessRequestConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestConfigV2024' is not null or undefined - assertParamExists('setAccessRequestConfig', 'accessRequestConfigV2024', accessRequestConfigV2024) - const localVarPath = `/access-request-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestsV2024Api - functional programming interface - * @export - */ -export const AccessRequestsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2024} bulkApproveAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveBulkAccessRequest(bulkApproveAccessRequestV2024: BulkApproveAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkAccessRequest(bulkApproveAccessRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.approveBulkAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2024} cancelAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequest(cancelAccessRequestV2024: CancelAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequest(cancelAccessRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.cancelAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2024} bulkCancelAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequestInBulk(bulkCancelAccessRequestV2024: BulkCancelAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequestInBulk(bulkCancelAccessRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.cancelAccessRequestInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2024} closeAccessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async closeAccessRequest(closeAccessRequestV2024: CloseAccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.closeAccessRequest(closeAccessRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.closeAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2024} accessRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessRequest(accessRequestV2024: AccessRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequest(accessRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.createAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.getAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDetailsForIdentity(identityId: string, entitlementId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDetailsForIdentity(identityId, entitlementId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.getEntitlementDetailsForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatus(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.listAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAdministratorsAccessRequestStatus(xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAdministratorsAccessRequestStatus(xSailPointExperimental, requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.listAdministratorsAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2024} accountsSelectionRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async loadAccountSelections(accountsSelectionRequestV2024: AccountsSelectionRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.loadAccountSelections(accountsSelectionRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.loadAccountSelections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2024} accessRequestConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setAccessRequestConfig(accessRequestConfigV2024: AccessRequestConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfig(accessRequestConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2024Api.setAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestsV2024Api - factory interface - * @export - */ -export const AccessRequestsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestsV2024ApiFp(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2024ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest(requestParameters: AccessRequestsV2024ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2024ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest(requestParameters: AccessRequestsV2024ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2024ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk(requestParameters: AccessRequestsV2024ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2024ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest(requestParameters: AccessRequestsV2024ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.closeAccessRequest(requestParameters.closeAccessRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2024ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest(requestParameters: AccessRequestsV2024ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessRequest(requestParameters.accessRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2024ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus(requestParameters: AccessRequestsV2024ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2024ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections(requestParameters: AccessRequestsV2024ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.loadAccountSelections(requestParameters.accountsSelectionRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2024ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig(requestParameters: AccessRequestsV2024ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestConfig(requestParameters.accessRequestConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveBulkAccessRequest operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiApproveBulkAccessRequestRequest - */ -export interface AccessRequestsV2024ApiApproveBulkAccessRequestRequest { - /** - * - * @type {BulkApproveAccessRequestV2024} - * @memberof AccessRequestsV2024ApiApproveBulkAccessRequest - */ - readonly bulkApproveAccessRequestV2024: BulkApproveAccessRequestV2024 -} - -/** - * Request parameters for cancelAccessRequest operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiCancelAccessRequestRequest - */ -export interface AccessRequestsV2024ApiCancelAccessRequestRequest { - /** - * - * @type {CancelAccessRequestV2024} - * @memberof AccessRequestsV2024ApiCancelAccessRequest - */ - readonly cancelAccessRequestV2024: CancelAccessRequestV2024 -} - -/** - * Request parameters for cancelAccessRequestInBulk operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiCancelAccessRequestInBulkRequest - */ -export interface AccessRequestsV2024ApiCancelAccessRequestInBulkRequest { - /** - * - * @type {BulkCancelAccessRequestV2024} - * @memberof AccessRequestsV2024ApiCancelAccessRequestInBulk - */ - readonly bulkCancelAccessRequestV2024: BulkCancelAccessRequestV2024 -} - -/** - * Request parameters for closeAccessRequest operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiCloseAccessRequestRequest - */ -export interface AccessRequestsV2024ApiCloseAccessRequestRequest { - /** - * - * @type {CloseAccessRequestV2024} - * @memberof AccessRequestsV2024ApiCloseAccessRequest - */ - readonly closeAccessRequestV2024: CloseAccessRequestV2024 -} - -/** - * Request parameters for createAccessRequest operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiCreateAccessRequestRequest - */ -export interface AccessRequestsV2024ApiCreateAccessRequestRequest { - /** - * - * @type {AccessRequestV2024} - * @memberof AccessRequestsV2024ApiCreateAccessRequest - */ - readonly accessRequestV2024: AccessRequestV2024 -} - -/** - * Request parameters for getEntitlementDetailsForIdentity operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest - */ -export interface AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest { - /** - * The identity ID. - * @type {string} - * @memberof AccessRequestsV2024ApiGetEntitlementDetailsForIdentity - */ - readonly identityId: string - - /** - * The entitlement ID - * @type {string} - * @memberof AccessRequestsV2024ApiGetEntitlementDetailsForIdentity - */ - readonly entitlementId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2024ApiGetEntitlementDetailsForIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAccessRequestStatus operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiListAccessRequestStatusRequest - */ -export interface AccessRequestsV2024ApiListAccessRequestStatusRequest { - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name** - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for listAdministratorsAccessRequestStatus operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest - */ -export interface AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly xSailPointExperimental: string - - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name, accessRequestId** - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2024ApiListAdministratorsAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for loadAccountSelections operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiLoadAccountSelectionsRequest - */ -export interface AccessRequestsV2024ApiLoadAccountSelectionsRequest { - /** - * - * @type {AccountsSelectionRequestV2024} - * @memberof AccessRequestsV2024ApiLoadAccountSelections - */ - readonly accountsSelectionRequestV2024: AccountsSelectionRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2024ApiLoadAccountSelections - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestConfig operation in AccessRequestsV2024Api. - * @export - * @interface AccessRequestsV2024ApiSetAccessRequestConfigRequest - */ -export interface AccessRequestsV2024ApiSetAccessRequestConfigRequest { - /** - * - * @type {AccessRequestConfigV2024} - * @memberof AccessRequestsV2024ApiSetAccessRequestConfig - */ - readonly accessRequestConfigV2024: AccessRequestConfigV2024 -} - -/** - * AccessRequestsV2024Api - object-oriented interface - * @export - * @class AccessRequestsV2024Api - * @extends {BaseAPI} - */ -export class AccessRequestsV2024Api extends BaseAPI { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2024ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public approveBulkAccessRequest(requestParameters: AccessRequestsV2024ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2024ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public cancelAccessRequest(requestParameters: AccessRequestsV2024ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2024ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public cancelAccessRequestInBulk(requestParameters: AccessRequestsV2024ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2024ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public closeAccessRequest(requestParameters: AccessRequestsV2024ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).closeAccessRequest(requestParameters.closeAccessRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2024ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public createAccessRequest(requestParameters: AccessRequestsV2024ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).createAccessRequest(requestParameters.accessRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).getAccessRequestConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2024ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2024ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public listAccessRequestStatus(requestParameters: AccessRequestsV2024ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2024ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2024ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public loadAccountSelections(requestParameters: AccessRequestsV2024ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).loadAccountSelections(requestParameters.accountsSelectionRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2024ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsV2024Api - */ - public setAccessRequestConfig(requestParameters: AccessRequestsV2024ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2024ApiFp(this.configuration).setAccessRequestConfig(requestParameters.accessRequestConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountActivitiesV2024Api - axios parameter creator - * @export - */ -export const AccountActivitiesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountActivity', 'id', id) - const localVarPath = `/account-activities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-activities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountActivitiesV2024Api - functional programming interface - * @export - */ -export const AccountActivitiesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountActivitiesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountActivity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2024Api.getAccountActivity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccountActivities(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivities(requestedFor, requestedBy, regardingIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2024Api.listAccountActivities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountActivitiesV2024Api - factory interface - * @export - */ -export const AccountActivitiesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountActivitiesV2024ApiFp(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2024ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity(requestParameters: AccountActivitiesV2024ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2024ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities(requestParameters: AccountActivitiesV2024ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountActivity operation in AccountActivitiesV2024Api. - * @export - * @interface AccountActivitiesV2024ApiGetAccountActivityRequest - */ -export interface AccountActivitiesV2024ApiGetAccountActivityRequest { - /** - * The account activity id - * @type {string} - * @memberof AccountActivitiesV2024ApiGetAccountActivity - */ - readonly id: string -} - -/** - * Request parameters for listAccountActivities operation in AccountActivitiesV2024Api. - * @export - * @interface AccountActivitiesV2024ApiListAccountActivitiesRequest - */ -export interface AccountActivitiesV2024ApiListAccountActivitiesRequest { - /** - * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly requestedFor?: string - - /** - * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly requestedBy?: string - - /** - * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly regardingIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @type {string} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - 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: **type, created, modified** - * @type {string} - * @memberof AccountActivitiesV2024ApiListAccountActivities - */ - readonly sorters?: string -} - -/** - * AccountActivitiesV2024Api - object-oriented interface - * @export - * @class AccountActivitiesV2024Api - * @extends {BaseAPI} - */ -export class AccountActivitiesV2024Api extends BaseAPI { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2024ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2024Api - */ - public getAccountActivity(requestParameters: AccountActivitiesV2024ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2024ApiFp(this.configuration).getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2024ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2024Api - */ - public listAccountActivities(requestParameters: AccountActivitiesV2024ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2024ApiFp(this.configuration).listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountAggregationsV2024Api - axios parameter creator - * @export - */ -export const AccountAggregationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountAggregationStatus', 'id', id) - const localVarPath = `/account-aggregations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountAggregationsV2024Api - functional programming interface - * @export - */ -export const AccountAggregationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountAggregationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountAggregationStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountAggregationStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountAggregationsV2024Api.getAccountAggregationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountAggregationsV2024Api - factory interface - * @export - */ -export const AccountAggregationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountAggregationsV2024ApiFp(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2024ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus(requestParameters: AccountAggregationsV2024ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountAggregationStatus operation in AccountAggregationsV2024Api. - * @export - * @interface AccountAggregationsV2024ApiGetAccountAggregationStatusRequest - */ -export interface AccountAggregationsV2024ApiGetAccountAggregationStatusRequest { - /** - * The account aggregation id - * @type {string} - * @memberof AccountAggregationsV2024ApiGetAccountAggregationStatus - */ - readonly id: string -} - -/** - * AccountAggregationsV2024Api - object-oriented interface - * @export - * @class AccountAggregationsV2024Api - * @extends {BaseAPI} - */ -export class AccountAggregationsV2024Api extends BaseAPI { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2024ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountAggregationsV2024Api - */ - public getAccountAggregationStatus(requestParameters: AccountAggregationsV2024ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountAggregationsV2024ApiFp(this.configuration).getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountUsagesV2024Api - axios parameter creator - * @export - */ -export const AccountUsagesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('getUsagesByAccountId', 'accountId', accountId) - const localVarPath = `/account-usages/{accountId}/summaries` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountUsagesV2024Api - functional programming interface - * @export - */ -export const AccountUsagesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountUsagesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountId(accountId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountUsagesV2024Api.getUsagesByAccountId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountUsagesV2024Api - factory interface - * @export - */ -export const AccountUsagesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountUsagesV2024ApiFp(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2024ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId(requestParameters: AccountUsagesV2024ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getUsagesByAccountId operation in AccountUsagesV2024Api. - * @export - * @interface AccountUsagesV2024ApiGetUsagesByAccountIdRequest - */ -export interface AccountUsagesV2024ApiGetUsagesByAccountIdRequest { - /** - * ID of IDN account - * @type {string} - * @memberof AccountUsagesV2024ApiGetUsagesByAccountId - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2024ApiGetUsagesByAccountId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2024ApiGetUsagesByAccountId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountUsagesV2024ApiGetUsagesByAccountId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof AccountUsagesV2024ApiGetUsagesByAccountId - */ - readonly sorters?: string -} - -/** - * AccountUsagesV2024Api - object-oriented interface - * @export - * @class AccountUsagesV2024Api - * @extends {BaseAPI} - */ -export class AccountUsagesV2024Api extends BaseAPI { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2024ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountUsagesV2024Api - */ - public getUsagesByAccountId(requestParameters: AccountUsagesV2024ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountUsagesV2024ApiFp(this.configuration).getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountsV2024Api - axios parameter creator - * @export - */ -export const AccountsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2024} accountAttributesCreateV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount: async (accountAttributesCreateV2024: AccountAttributesCreateV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountAttributesCreateV2024' is not null or undefined - assertParamExists('createAccount', 'accountAttributesCreateV2024', accountAttributesCreateV2024) - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesCreateV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountAsync', 'id', id) - const localVarPath = `/accounts/{id}/remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2024} accountToggleRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount: async (id: string, accountToggleRequestV2024: AccountToggleRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2024' is not null or undefined - assertParamExists('disableAccount', 'accountToggleRequestV2024', accountToggleRequestV2024) - const localVarPath = `/accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities: async (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2024' is not null or undefined - assertParamExists('disableAccountsForIdentities', 'identitiesAccountsBulkRequestV2024', identitiesAccountsBulkRequestV2024) - const localVarPath = `/identities-accounts/disable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2024} accountToggleRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount: async (id: string, accountToggleRequestV2024: AccountToggleRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2024' is not null or undefined - assertParamExists('enableAccount', 'accountToggleRequestV2024', accountToggleRequestV2024) - const localVarPath = `/accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities: async (identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2024' is not null or undefined - assertParamExists('enableAccountsForIdentities', 'identitiesAccountsBulkRequestV2024', identitiesAccountsBulkRequestV2024) - const localVarPath = `/identities-accounts/enable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountEntitlements', 'id', id) - const localVarPath = `/accounts/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2024} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts: async (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2024, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - 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, - }; - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2024} accountAttributesV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount: async (id: string, accountAttributesV2024: AccountAttributesV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putAccount', 'id', id) - // verify required parameter 'accountAttributesV2024' is not null or undefined - assertParamExists('putAccount', 'accountAttributesV2024', accountAttributesV2024) - const localVarPath = `/accounts/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReloadAccount', 'id', id) - const localVarPath = `/accounts/{id}/reload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2024} accountUnlockRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount: async (id: string, accountUnlockRequestV2024: AccountUnlockRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unlockAccount', 'id', id) - // verify required parameter 'accountUnlockRequestV2024' is not null or undefined - assertParamExists('unlockAccount', 'accountUnlockRequestV2024', accountUnlockRequestV2024) - const localVarPath = `/accounts/{id}/unlock` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountUnlockRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateAccount', 'requestBody', requestBody) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountsV2024Api - functional programming interface - * @export - */ -export const AccountsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2024} accountAttributesCreateV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccount(accountAttributesCreateV2024: AccountAttributesCreateV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccount(accountAttributesCreateV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.createAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.deleteAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.deleteAccountAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2024} accountToggleRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccount(id: string, accountToggleRequestV2024: AccountToggleRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccount(id, accountToggleRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.disableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.disableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountsForIdentities(identitiesAccountsBulkRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.disableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2024} accountToggleRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccount(id: string, accountToggleRequestV2024: AccountToggleRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccount(id, accountToggleRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.enableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.enableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2024} identitiesAccountsBulkRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountsForIdentities(identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountsForIdentities(identitiesAccountsBulkRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.enableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.getAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.getAccountEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2024} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccounts(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2024, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(limit, offset, count, detailLevel, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.listAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2024} accountAttributesV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putAccount(id: string, accountAttributesV2024: AccountAttributesV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putAccount(id, accountAttributesV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.putAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReloadAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.submitReloadAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2024} accountUnlockRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unlockAccount(id: string, accountUnlockRequestV2024: AccountUnlockRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(id, accountUnlockRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.unlockAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2024Api.updateAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountsV2024Api - factory interface - * @export - */ -export const AccountsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountsV2024ApiFp(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2024ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount(requestParameters: AccountsV2024ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccount(requestParameters.accountAttributesCreateV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2024ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount(requestParameters: AccountsV2024ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2024ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync(requestParameters: AccountsV2024ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2024ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount(requestParameters: AccountsV2024ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2024ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity(requestParameters: AccountsV2024ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2024ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities(requestParameters: AccountsV2024ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2024ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount(requestParameters: AccountsV2024ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2024ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity(requestParameters: AccountsV2024ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2024ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities(requestParameters: AccountsV2024ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2024ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount(requestParameters: AccountsV2024ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2024ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements(requestParameters: AccountsV2024ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2024ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts(requestParameters: AccountsV2024ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2024ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount(requestParameters: AccountsV2024ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putAccount(requestParameters.id, requestParameters.accountAttributesV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2024ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount(requestParameters: AccountsV2024ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2024ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount(requestParameters: AccountsV2024ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2024ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount(requestParameters: AccountsV2024ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiCreateAccountRequest - */ -export interface AccountsV2024ApiCreateAccountRequest { - /** - * - * @type {AccountAttributesCreateV2024} - * @memberof AccountsV2024ApiCreateAccount - */ - readonly accountAttributesCreateV2024: AccountAttributesCreateV2024 -} - -/** - * Request parameters for deleteAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiDeleteAccountRequest - */ -export interface AccountsV2024ApiDeleteAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2024ApiDeleteAccount - */ - readonly id: string -} - -/** - * Request parameters for deleteAccountAsync operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiDeleteAccountAsyncRequest - */ -export interface AccountsV2024ApiDeleteAccountAsyncRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2024ApiDeleteAccountAsync - */ - readonly id: string -} - -/** - * Request parameters for disableAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiDisableAccountRequest - */ -export interface AccountsV2024ApiDisableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2024ApiDisableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2024} - * @memberof AccountsV2024ApiDisableAccount - */ - readonly accountToggleRequestV2024: AccountToggleRequestV2024 -} - -/** - * Request parameters for disableAccountForIdentity operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiDisableAccountForIdentityRequest - */ -export interface AccountsV2024ApiDisableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2024ApiDisableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for disableAccountsForIdentities operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiDisableAccountsForIdentitiesRequest - */ -export interface AccountsV2024ApiDisableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2024} - * @memberof AccountsV2024ApiDisableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024 -} - -/** - * Request parameters for enableAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiEnableAccountRequest - */ -export interface AccountsV2024ApiEnableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2024ApiEnableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2024} - * @memberof AccountsV2024ApiEnableAccount - */ - readonly accountToggleRequestV2024: AccountToggleRequestV2024 -} - -/** - * Request parameters for enableAccountForIdentity operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiEnableAccountForIdentityRequest - */ -export interface AccountsV2024ApiEnableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2024ApiEnableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for enableAccountsForIdentities operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiEnableAccountsForIdentitiesRequest - */ -export interface AccountsV2024ApiEnableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2024} - * @memberof AccountsV2024ApiEnableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2024: IdentitiesAccountsBulkRequestV2024 -} - -/** - * Request parameters for getAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiGetAccountRequest - */ -export interface AccountsV2024ApiGetAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2024ApiGetAccount - */ - readonly id: string -} - -/** - * Request parameters for getAccountEntitlements operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiGetAccountEntitlementsRequest - */ -export interface AccountsV2024ApiGetAccountEntitlementsRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2024ApiGetAccountEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2024ApiGetAccountEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2024ApiGetAccountEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2024ApiGetAccountEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccounts operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiListAccountsRequest - */ -export interface AccountsV2024ApiListAccountsRequest { - /** - * 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 AccountsV2024ApiListAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2024ApiListAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2024ApiListAccounts - */ - readonly count?: boolean - - /** - * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof AccountsV2024ApiListAccounts - */ - readonly detailLevel?: ListAccountsDetailLevelV2024 - - /** - * 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @type {string} - * @memberof AccountsV2024ApiListAccounts - */ - 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @type {string} - * @memberof AccountsV2024ApiListAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for putAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiPutAccountRequest - */ -export interface AccountsV2024ApiPutAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2024ApiPutAccount - */ - readonly id: string - - /** - * - * @type {AccountAttributesV2024} - * @memberof AccountsV2024ApiPutAccount - */ - readonly accountAttributesV2024: AccountAttributesV2024 -} - -/** - * Request parameters for submitReloadAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiSubmitReloadAccountRequest - */ -export interface AccountsV2024ApiSubmitReloadAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2024ApiSubmitReloadAccount - */ - readonly id: string -} - -/** - * Request parameters for unlockAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiUnlockAccountRequest - */ -export interface AccountsV2024ApiUnlockAccountRequest { - /** - * The account ID. - * @type {string} - * @memberof AccountsV2024ApiUnlockAccount - */ - readonly id: string - - /** - * - * @type {AccountUnlockRequestV2024} - * @memberof AccountsV2024ApiUnlockAccount - */ - readonly accountUnlockRequestV2024: AccountUnlockRequestV2024 -} - -/** - * Request parameters for updateAccount operation in AccountsV2024Api. - * @export - * @interface AccountsV2024ApiUpdateAccountRequest - */ -export interface AccountsV2024ApiUpdateAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2024ApiUpdateAccount - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AccountsV2024ApiUpdateAccount - */ - readonly requestBody: Array -} - -/** - * AccountsV2024Api - object-oriented interface - * @export - * @class AccountsV2024Api - * @extends {BaseAPI} - */ -export class AccountsV2024Api extends BaseAPI { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2024ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public createAccount(requestParameters: AccountsV2024ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).createAccount(requestParameters.accountAttributesCreateV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2024ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public deleteAccount(requestParameters: AccountsV2024ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).deleteAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2024ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public deleteAccountAsync(requestParameters: AccountsV2024ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2024ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public disableAccount(requestParameters: AccountsV2024ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2024ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public disableAccountForIdentity(requestParameters: AccountsV2024ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2024ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public disableAccountsForIdentities(requestParameters: AccountsV2024ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2024ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public enableAccount(requestParameters: AccountsV2024ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2024ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public enableAccountForIdentity(requestParameters: AccountsV2024ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2024ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public enableAccountsForIdentities(requestParameters: AccountsV2024ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2024ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public getAccount(requestParameters: AccountsV2024ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).getAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2024ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public getAccountEntitlements(requestParameters: AccountsV2024ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2024ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public listAccounts(requestParameters: AccountsV2024ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2024ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public putAccount(requestParameters: AccountsV2024ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).putAccount(requestParameters.id, requestParameters.accountAttributesV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2024ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public submitReloadAccount(requestParameters: AccountsV2024ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2024ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public unlockAccount(requestParameters: AccountsV2024ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2024ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2024Api - */ - public updateAccount(requestParameters: AccountsV2024ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2024ApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListAccountsDetailLevelV2024 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type ListAccountsDetailLevelV2024 = typeof ListAccountsDetailLevelV2024[keyof typeof ListAccountsDetailLevelV2024]; - - -/** - * ApplicationDiscoveryV2024Api - axios parameter creator - * @export - */ -export const ApplicationDiscoveryV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2024, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/discovered-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (filter !== undefined) { - localVarQueryParameter['filter'] = filter; - } - - 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, - }; - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/manual-discover-applications-template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'file' is not null or undefined - assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file) - const localVarPath = `/manual-discover-applications`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApplicationDiscoveryV2024Api - functional programming interface - * @export - */ -export const ApplicationDiscoveryV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApplicationDiscoveryV2024ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplications(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2024, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, detail, filter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2024Api.getDiscoveredApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2024Api.getManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendManualDiscoverApplicationsCsvTemplate(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2024Api.sendManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApplicationDiscoveryV2024Api - factory interface - * @export - */ -export const ApplicationDiscoveryV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApplicationDiscoveryV2024ApiFp(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryV2024Api. - * @export - * @interface ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest - */ -export interface ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest { - /** - * 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 ApplicationDiscoveryV2024ApiGetDiscoveredApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApplicationDiscoveryV2024ApiGetDiscoveredApplications - */ - readonly offset?: number - - /** - * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof ApplicationDiscoveryV2024ApiGetDiscoveredApplications - */ - readonly detail?: GetDiscoveredApplicationsDetailV2024 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @type {string} - * @memberof ApplicationDiscoveryV2024ApiGetDiscoveredApplications - */ - readonly filter?: 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: **name, description, discoveredAt, discoverySource** - * @type {string} - * @memberof ApplicationDiscoveryV2024ApiGetDiscoveredApplications - */ - readonly sorters?: string -} - -/** - * Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryV2024Api. - * @export - * @interface ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest - */ -export interface ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplate - */ - readonly file: File -} - -/** - * ApplicationDiscoveryV2024Api - object-oriented interface - * @export - * @class ApplicationDiscoveryV2024Api - * @extends {BaseAPI} - */ -export class ApplicationDiscoveryV2024Api extends BaseAPI { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2024Api - */ - public getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2024ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2024ApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2024Api - */ - public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2024ApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2024Api - */ - public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2024ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2024ApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetDiscoveredApplicationsDetailV2024 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetDiscoveredApplicationsDetailV2024 = typeof GetDiscoveredApplicationsDetailV2024[keyof typeof GetDiscoveredApplicationsDetailV2024]; - - -/** - * ApprovalsV2024Api - axios parameter creator - * @export - */ -export const ApprovalsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApproval', 'id', id) - const localVarPath = `/generic-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. - * @summary Get approvals - * @param {boolean} [mine] Returns the list of approvals for the current caller - * @param {string} [requesterId] Returns the list of approvals for a given requester ID - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals: async (mine?: boolean, requesterId?: string, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/generic-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (mine !== undefined) { - localVarQueryParameter['mine'] = mine; - } - - if (requesterId !== undefined) { - localVarQueryParameter['requesterId'] = requesterId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApprovalsV2024Api - functional programming interface - * @export - */ -export const ApprovalsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApprovalsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApproval(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2024Api.getApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. - * @summary Get approvals - * @param {boolean} [mine] Returns the list of approvals for the current caller - * @param {string} [requesterId] Returns the list of approvals for a given requester ID - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApprovals(mine?: boolean, requesterId?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, filters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2024Api.getApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApprovalsV2024Api - factory interface - * @export - */ -export const ApprovalsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApprovalsV2024ApiFp(configuration) - return { - /** - * Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - * @summary Get an approval - * @param {ApprovalsV2024ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval(requestParameters: ApprovalsV2024ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApproval(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. - * @summary Get approvals - * @param {ApprovalsV2024ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals(requestParameters: ApprovalsV2024ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getApproval operation in ApprovalsV2024Api. - * @export - * @interface ApprovalsV2024ApiGetApprovalRequest - */ -export interface ApprovalsV2024ApiGetApprovalRequest { - /** - * ID of the approval that is to be returned - * @type {string} - * @memberof ApprovalsV2024ApiGetApproval - */ - readonly id: string -} - -/** - * Request parameters for getApprovals operation in ApprovalsV2024Api. - * @export - * @interface ApprovalsV2024ApiGetApprovalsRequest - */ -export interface ApprovalsV2024ApiGetApprovalsRequest { - /** - * Returns the list of approvals for the current caller - * @type {boolean} - * @memberof ApprovalsV2024ApiGetApprovals - */ - readonly mine?: boolean - - /** - * Returns the list of approvals for a given requester ID - * @type {string} - * @memberof ApprovalsV2024ApiGetApprovals - */ - readonly requesterId?: 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: **status**: *eq* **referenceType**: *eq* - * @type {string} - * @memberof ApprovalsV2024ApiGetApprovals - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2024ApiGetApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2024ApiGetApprovals - */ - readonly offset?: number -} - -/** - * ApprovalsV2024Api - object-oriented interface - * @export - * @class ApprovalsV2024Api - * @extends {BaseAPI} - */ -export class ApprovalsV2024Api extends BaseAPI { - /** - * Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. - * @summary Get an approval - * @param {ApprovalsV2024ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2024Api - */ - public getApproval(requestParameters: ApprovalsV2024ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2024ApiFp(this.configuration).getApproval(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. \"Mine\" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. - * @summary Get approvals - * @param {ApprovalsV2024ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2024Api - */ - public getApprovals(requestParameters: ApprovalsV2024ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2024ApiFp(this.configuration).getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AppsV2024Api - axios parameter creator - * @export - */ -export const AppsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2024} sourceAppCreateDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp: async (sourceAppCreateDtoV2024: SourceAppCreateDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceAppCreateDtoV2024' is not null or undefined - assertParamExists('createSourceApp', 'sourceAppCreateDtoV2024', sourceAppCreateDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppCreateDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk: async (id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles/bulk-remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp: async (id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAccessProfilesForSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps: async (filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listAllUserApps', 'filters', filters) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/assigned`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp: async (id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAvailableAccountsForUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{id}/available-accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps: async (limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2024?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2024?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2024} [sourceAppBulkUpdateRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk: async (xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2024?: SourceAppBulkUpdateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppBulkUpdateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AppsV2024Api - functional programming interface - * @export - */ -export const AppsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AppsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2024} sourceAppCreateDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceApp(sourceAppCreateDtoV2024: SourceAppCreateDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceApp(sourceAppCreateDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.createSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesFromSourceAppByBulk(id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesFromSourceAppByBulk(id, requestBody, limit, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.deleteAccessProfilesFromSourceAppByBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.deleteSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.getSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesForSourceApp(id, limit, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAccessProfilesForSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAllSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllUserApps(filters, limit, count, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAllUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignedSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAssignedSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAccountsForUserApp(id, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAvailableAccountsForUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableSourceApps(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listAvailableSourceApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnedUserApps(limit, count, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.listOwnedUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSourceApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2024?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSourceApp(id, xSailPointExperimental, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.patchSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchUserApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2024?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchUserApp(id, xSailPointExperimental, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.patchUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2024} [sourceAppBulkUpdateRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceAppsInBulk(xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2024?: SourceAppBulkUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceAppsInBulk(xSailPointExperimental, sourceAppBulkUpdateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2024Api.updateSourceAppsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AppsV2024Api - factory interface - * @export - */ -export const AppsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AppsV2024ApiFp(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2024ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp(requestParameters: AppsV2024ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceApp(requestParameters.sourceAppCreateDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2024ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp(requestParameters: AppsV2024ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2024ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp(requestParameters: AppsV2024ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2024ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp(requestParameters: AppsV2024ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2024ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp(requestParameters: AppsV2024ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2024ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps(requestParameters: AppsV2024ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2024ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp(requestParameters: AppsV2024ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2024ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp(requestParameters: AppsV2024ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2024ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps(requestParameters: AppsV2024ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2024ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps(requestParameters: AppsV2024ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2024ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp(requestParameters: AppsV2024ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2024ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp(requestParameters: AppsV2024ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2024ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk(requestParameters: AppsV2024ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiCreateSourceAppRequest - */ -export interface AppsV2024ApiCreateSourceAppRequest { - /** - * - * @type {SourceAppCreateDtoV2024} - * @memberof AppsV2024ApiCreateSourceApp - */ - readonly sourceAppCreateDtoV2024: SourceAppCreateDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiCreateSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteAccessProfilesFromSourceAppByBulk operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest - */ -export interface AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly requestBody: Array - - /** - * 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 AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly limit?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiDeleteSourceAppRequest - */ -export interface AppsV2024ApiDeleteSourceAppRequest { - /** - * source app ID. - * @type {string} - * @memberof AppsV2024ApiDeleteSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiDeleteSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiGetSourceAppRequest - */ -export interface AppsV2024ApiGetSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2024ApiGetSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiGetSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAccessProfilesForSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAccessProfilesForSourceAppRequest - */ -export interface AppsV2024ApiListAccessProfilesForSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2024ApiListAccessProfilesForSourceApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2024ApiListAccessProfilesForSourceApp - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2024ApiListAccessProfilesForSourceApp - */ - readonly offset?: number - - /** - * 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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof AppsV2024ApiListAccessProfilesForSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAccessProfilesForSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAllSourceAppRequest - */ -export interface AppsV2024ApiListAllSourceAppRequest { - /** - * 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 AppsV2024ApiListAllSourceApp - */ - 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 AppsV2024ApiListAllSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2024ApiListAllSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2024ApiListAllSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @type {string} - * @memberof AppsV2024ApiListAllSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAllSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllUserApps operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAllUserAppsRequest - */ -export interface AppsV2024ApiListAllUserAppsRequest { - /** - * 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2024ApiListAllUserApps - */ - readonly filters: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2024ApiListAllUserApps - */ - 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 AppsV2024ApiListAllUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2024ApiListAllUserApps - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAllUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAssignedSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAssignedSourceAppRequest - */ -export interface AppsV2024ApiListAssignedSourceAppRequest { - /** - * 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 AppsV2024ApiListAssignedSourceApp - */ - 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 AppsV2024ApiListAssignedSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2024ApiListAssignedSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, accountSource.id** - * @type {string} - * @memberof AppsV2024ApiListAssignedSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2024ApiListAssignedSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAssignedSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableAccountsForUserApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAvailableAccountsForUserAppRequest - */ -export interface AppsV2024ApiListAvailableAccountsForUserAppRequest { - /** - * ID of the user app - * @type {string} - * @memberof AppsV2024ApiListAvailableAccountsForUserApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2024ApiListAvailableAccountsForUserApp - */ - 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 AppsV2024ApiListAvailableAccountsForUserApp - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAvailableAccountsForUserApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableSourceApps operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListAvailableSourceAppsRequest - */ -export interface AppsV2024ApiListAvailableSourceAppsRequest { - /** - * 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 AppsV2024ApiListAvailableSourceApps - */ - 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 AppsV2024ApiListAvailableSourceApps - */ - readonly count?: boolean - - /** - * 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 AppsV2024ApiListAvailableSourceApps - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2024ApiListAvailableSourceApps - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2024ApiListAvailableSourceApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListAvailableSourceApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOwnedUserApps operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiListOwnedUserAppsRequest - */ -export interface AppsV2024ApiListOwnedUserAppsRequest { - /** - * 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 AppsV2024ApiListOwnedUserApps - */ - 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 AppsV2024ApiListOwnedUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2024ApiListOwnedUserApps - */ - readonly offset?: number - - /** - * 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2024ApiListOwnedUserApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiListOwnedUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSourceApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiPatchSourceAppRequest - */ -export interface AppsV2024ApiPatchSourceAppRequest { - /** - * ID of the source app to patch - * @type {string} - * @memberof AppsV2024ApiPatchSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiPatchSourceApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2024ApiPatchSourceApp - */ - readonly jsonPatchOperationV2024?: Array -} - -/** - * Request parameters for patchUserApp operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiPatchUserAppRequest - */ -export interface AppsV2024ApiPatchUserAppRequest { - /** - * ID of the user app to patch - * @type {string} - * @memberof AppsV2024ApiPatchUserApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiPatchUserApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2024ApiPatchUserApp - */ - readonly jsonPatchOperationV2024?: Array -} - -/** - * Request parameters for updateSourceAppsInBulk operation in AppsV2024Api. - * @export - * @interface AppsV2024ApiUpdateSourceAppsInBulkRequest - */ -export interface AppsV2024ApiUpdateSourceAppsInBulkRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2024ApiUpdateSourceAppsInBulk - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {SourceAppBulkUpdateRequestV2024} - * @memberof AppsV2024ApiUpdateSourceAppsInBulk - */ - readonly sourceAppBulkUpdateRequestV2024?: SourceAppBulkUpdateRequestV2024 -} - -/** - * AppsV2024Api - object-oriented interface - * @export - * @class AppsV2024Api - * @extends {BaseAPI} - */ -export class AppsV2024Api extends BaseAPI { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2024ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public createSourceApp(requestParameters: AppsV2024ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).createSourceApp(requestParameters.sourceAppCreateDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2024ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2024ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public deleteSourceApp(requestParameters: AppsV2024ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2024ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public getSourceApp(requestParameters: AppsV2024ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2024ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAccessProfilesForSourceApp(requestParameters: AppsV2024ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2024ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAllSourceApp(requestParameters: AppsV2024ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2024ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAllUserApps(requestParameters: AppsV2024ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2024ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAssignedSourceApp(requestParameters: AppsV2024ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2024ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAvailableAccountsForUserApp(requestParameters: AppsV2024ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2024ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listAvailableSourceApps(requestParameters: AppsV2024ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2024ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public listOwnedUserApps(requestParameters: AppsV2024ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2024ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public patchSourceApp(requestParameters: AppsV2024ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2024ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public patchUserApp(requestParameters: AppsV2024ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2024ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2024Api - */ - public updateSourceAppsInBulk(requestParameters: AppsV2024ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2024ApiFp(this.configuration).updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthProfileV2024Api - axios parameter creator - * @export - */ -export const AuthProfileV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getProfileConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig: async (id: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchProfileConfig', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchProfileConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthProfileV2024Api - functional programming interface - * @export - */ -export const AuthProfileV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthProfileV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2024Api.getProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfigList(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigList(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2024Api.getProfileConfigList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchProfileConfig(id: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchProfileConfig(id, jsonPatchOperationV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2024Api.patchProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthProfileV2024Api - factory interface - * @export - */ -export const AuthProfileV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthProfileV2024ApiFp(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2024ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig(requestParameters: AuthProfileV2024ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2024ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList(requestParameters: AuthProfileV2024ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2024ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig(requestParameters: AuthProfileV2024ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getProfileConfig operation in AuthProfileV2024Api. - * @export - * @interface AuthProfileV2024ApiGetProfileConfigRequest - */ -export interface AuthProfileV2024ApiGetProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2024ApiGetProfileConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2024ApiGetProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getProfileConfigList operation in AuthProfileV2024Api. - * @export - * @interface AuthProfileV2024ApiGetProfileConfigListRequest - */ -export interface AuthProfileV2024ApiGetProfileConfigListRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2024ApiGetProfileConfigList - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchProfileConfig operation in AuthProfileV2024Api. - * @export - * @interface AuthProfileV2024ApiPatchProfileConfigRequest - */ -export interface AuthProfileV2024ApiPatchProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2024ApiPatchProfileConfig - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AuthProfileV2024ApiPatchProfileConfig - */ - readonly jsonPatchOperationV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2024ApiPatchProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * AuthProfileV2024Api - object-oriented interface - * @export - * @class AuthProfileV2024Api - * @extends {BaseAPI} - */ -export class AuthProfileV2024Api extends BaseAPI { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2024ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2024Api - */ - public getProfileConfig(requestParameters: AuthProfileV2024ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2024ApiFp(this.configuration).getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2024ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2024Api - */ - public getProfileConfigList(requestParameters: AuthProfileV2024ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2024ApiFp(this.configuration).getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2024ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2024Api - */ - public patchProfileConfig(requestParameters: AuthProfileV2024ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2024ApiFp(this.configuration).patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthUsersV2024Api - axios parameter creator - * @export - */ -export const AuthUsersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAuthUser', 'id', id) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2024 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAuthUser', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAuthUser', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthUsersV2024Api - functional programming interface - * @export - */ -export const AuthUsersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthUsersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthUser(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2024Api.getAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2024 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthUser(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthUser(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2024Api.patchAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthUsersV2024Api - factory interface - * @export - */ -export const AuthUsersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthUsersV2024ApiFp(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2024ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser(requestParameters: AuthUsersV2024ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthUser(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2024ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser(requestParameters: AuthUsersV2024ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAuthUser operation in AuthUsersV2024Api. - * @export - * @interface AuthUsersV2024ApiGetAuthUserRequest - */ -export interface AuthUsersV2024ApiGetAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2024ApiGetAuthUser - */ - readonly id: string -} - -/** - * Request parameters for patchAuthUser operation in AuthUsersV2024Api. - * @export - * @interface AuthUsersV2024ApiPatchAuthUserRequest - */ -export interface AuthUsersV2024ApiPatchAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2024ApiPatchAuthUser - */ - readonly id: string - - /** - * A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AuthUsersV2024ApiPatchAuthUser - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * AuthUsersV2024Api - object-oriented interface - * @export - * @class AuthUsersV2024Api - * @extends {BaseAPI} - */ -export class AuthUsersV2024Api extends BaseAPI { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2024ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2024Api - */ - public getAuthUser(requestParameters: AuthUsersV2024ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2024ApiFp(this.configuration).getAuthUser(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2024ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2024Api - */ - public patchAuthUser(requestParameters: AuthUsersV2024ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2024ApiFp(this.configuration).patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * BrandingV2024Api - axios parameter creator - * @export - */ -export const BrandingV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('createBrandingItem', 'name', name) - // verify required parameter 'productName' is not null or undefined - assertParamExists('createBrandingItem', 'productName', productName) - const localVarPath = `/brandings`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/brandings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('setBrandingItem', 'name', name) - // verify required parameter 'name2' is not null or undefined - assertParamExists('setBrandingItem', 'name2', name2) - // verify required parameter 'productName' is not null or undefined - assertParamExists('setBrandingItem', 'productName', productName) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name2 !== undefined) { - localVarFormParams.append('name', name2 as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * BrandingV2024Api - functional programming interface - * @export - */ -export const BrandingV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = BrandingV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createBrandingItem(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItem(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2024Api.createBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2024Api.deleteBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2024Api.getBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBrandingList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2024Api.getBrandingList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setBrandingItem(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItem(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2024Api.setBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * BrandingV2024Api - factory interface - * @export - */ -export const BrandingV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = BrandingV2024ApiFp(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2024ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem(requestParameters: BrandingV2024ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2024ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding(requestParameters: BrandingV2024ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2024ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding(requestParameters: BrandingV2024ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBrandingList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2024ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem(requestParameters: BrandingV2024ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createBrandingItem operation in BrandingV2024Api. - * @export - * @interface BrandingV2024ApiCreateBrandingItemRequest - */ -export interface BrandingV2024ApiCreateBrandingItemRequest { - /** - * name of branding item - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly name: string - - /** - * product name - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2024ApiCreateBrandingItem - */ - readonly fileStandard?: File -} - -/** - * Request parameters for deleteBranding operation in BrandingV2024Api. - * @export - * @interface BrandingV2024ApiDeleteBrandingRequest - */ -export interface BrandingV2024ApiDeleteBrandingRequest { - /** - * The name of the branding item to be deleted - * @type {string} - * @memberof BrandingV2024ApiDeleteBranding - */ - readonly name: string -} - -/** - * Request parameters for getBranding operation in BrandingV2024Api. - * @export - * @interface BrandingV2024ApiGetBrandingRequest - */ -export interface BrandingV2024ApiGetBrandingRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2024ApiGetBranding - */ - readonly name: string -} - -/** - * Request parameters for setBrandingItem operation in BrandingV2024Api. - * @export - * @interface BrandingV2024ApiSetBrandingItemRequest - */ -export interface BrandingV2024ApiSetBrandingItemRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly name: string - - /** - * name of branding item - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly name2: string - - /** - * product name - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2024ApiSetBrandingItem - */ - readonly fileStandard?: File -} - -/** - * BrandingV2024Api - object-oriented interface - * @export - * @class BrandingV2024Api - * @extends {BaseAPI} - */ -export class BrandingV2024Api extends BaseAPI { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2024ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2024Api - */ - public createBrandingItem(requestParameters: BrandingV2024ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2024ApiFp(this.configuration).createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2024ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2024Api - */ - public deleteBranding(requestParameters: BrandingV2024ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2024ApiFp(this.configuration).deleteBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2024ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2024Api - */ - public getBranding(requestParameters: BrandingV2024ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2024ApiFp(this.configuration).getBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2024Api - */ - public getBrandingList(axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2024ApiFp(this.configuration).getBrandingList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2024ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2024Api - */ - public setBrandingItem(requestParameters: BrandingV2024ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2024ApiFp(this.configuration).setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignFiltersV2024Api - axios parameter creator - * @export - */ -export const CertificationCampaignFiltersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2024} campaignFilterDetailsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter: async (campaignFilterDetailsV2024: CampaignFilterDetailsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignFilterDetailsV2024' is not null or undefined - assertParamExists('createCampaignFilter', 'campaignFilterDetailsV2024', campaignFilterDetailsV2024) - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteCampaignFilters', 'requestBody', requestBody) - const localVarPath = `/campaign-filters/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignFilterById', 'id', id) - const localVarPath = `/campaign-filters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (includeSystemFilters !== undefined) { - localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2024} campaignFilterDetailsV2024 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter: async (filterId: string, campaignFilterDetailsV2024: CampaignFilterDetailsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filterId' is not null or undefined - assertParamExists('updateCampaignFilter', 'filterId', filterId) - // verify required parameter 'campaignFilterDetailsV2024' is not null or undefined - assertParamExists('updateCampaignFilter', 'campaignFilterDetailsV2024', campaignFilterDetailsV2024) - const localVarPath = `/campaign-filters/{id}` - .replace(`{${"filterId"}}`, encodeURIComponent(String(filterId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignFiltersV2024Api - functional programming interface - * @export - */ -export const CertificationCampaignFiltersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignFiltersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2024} campaignFilterDetailsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignFilter(campaignFilterDetailsV2024: CampaignFilterDetailsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilter(campaignFilterDetailsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2024Api.createCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignFilters(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFilters(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2024Api.deleteCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignFilterById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2024Api.getCampaignFilterById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCampaignFilters(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFilters(limit, start, includeSystemFilters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2024Api.listCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2024} campaignFilterDetailsV2024 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaignFilter(filterId: string, campaignFilterDetailsV2024: CampaignFilterDetailsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilter(filterId, campaignFilterDetailsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2024Api.updateCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignFiltersV2024Api - factory interface - * @export - */ -export const CertificationCampaignFiltersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignFiltersV2024ApiFp(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter(requestParameters: CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignFilter(requestParameters.campaignFilterDetailsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters(requestParameters: CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCampaignFilter operation in CertificationCampaignFiltersV2024Api. - * @export - * @interface CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest { - /** - * - * @type {CampaignFilterDetailsV2024} - * @memberof CertificationCampaignFiltersV2024ApiCreateCampaignFilter - */ - readonly campaignFilterDetailsV2024: CampaignFilterDetailsV2024 -} - -/** - * Request parameters for deleteCampaignFilters operation in CertificationCampaignFiltersV2024Api. - * @export - * @interface CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest { - /** - * A json list of IDs of campaign filters to delete. - * @type {Array} - * @memberof CertificationCampaignFiltersV2024ApiDeleteCampaignFilters - */ - readonly requestBody: Array -} - -/** - * Request parameters for getCampaignFilterById operation in CertificationCampaignFiltersV2024Api. - * @export - * @interface CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest - */ -export interface CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest { - /** - * The ID of the campaign filter to be retrieved. - * @type {string} - * @memberof CertificationCampaignFiltersV2024ApiGetCampaignFilterById - */ - readonly id: string -} - -/** - * Request parameters for listCampaignFilters operation in CertificationCampaignFiltersV2024Api. - * @export - * @interface CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest { - /** - * 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 CertificationCampaignFiltersV2024ApiListCampaignFilters - */ - readonly limit?: number - - /** - * Start/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 CertificationCampaignFiltersV2024ApiListCampaignFilters - */ - readonly start?: number - - /** - * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @type {boolean} - * @memberof CertificationCampaignFiltersV2024ApiListCampaignFilters - */ - readonly includeSystemFilters?: boolean -} - -/** - * Request parameters for updateCampaignFilter operation in CertificationCampaignFiltersV2024Api. - * @export - * @interface CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest { - /** - * The ID of the campaign filter being modified. - * @type {string} - * @memberof CertificationCampaignFiltersV2024ApiUpdateCampaignFilter - */ - readonly filterId: string - - /** - * A campaign filter details with updated field values. - * @type {CampaignFilterDetailsV2024} - * @memberof CertificationCampaignFiltersV2024ApiUpdateCampaignFilter - */ - readonly campaignFilterDetailsV2024: CampaignFilterDetailsV2024 -} - -/** - * CertificationCampaignFiltersV2024Api - object-oriented interface - * @export - * @class CertificationCampaignFiltersV2024Api - * @extends {BaseAPI} - */ -export class CertificationCampaignFiltersV2024Api extends BaseAPI { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2024Api - */ - public createCampaignFilter(requestParameters: CertificationCampaignFiltersV2024ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2024ApiFp(this.configuration).createCampaignFilter(requestParameters.campaignFilterDetailsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2024Api - */ - public deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2024ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2024ApiFp(this.configuration).deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2024Api - */ - public getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2024ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2024ApiFp(this.configuration).getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2024Api - */ - public listCampaignFilters(requestParameters: CertificationCampaignFiltersV2024ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2024ApiFp(this.configuration).listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2024Api - */ - public updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2024ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2024ApiFp(this.configuration).updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignsV2024Api - axios parameter creator - * @export - */ -export const CertificationCampaignsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2024} [campaignCompleteOptionsV2024] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign: async (id: string, campaignCompleteOptionsV2024?: CampaignCompleteOptionsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignCompleteOptionsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2024} campaignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign: async (campaignV2024: CampaignV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignV2024' is not null or undefined - assertParamExists('createCampaign', 'campaignV2024', campaignV2024) - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2024} campaignTemplateV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate: async (campaignTemplateV2024: CampaignTemplateV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignTemplateV2024' is not null or undefined - assertParamExists('createCampaignTemplate', 'campaignTemplateV2024', campaignTemplateV2024) - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignTemplateV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2024} campaignsDeleteRequestV2024 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns: async (campaignsDeleteRequestV2024: CampaignsDeleteRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignsDeleteRequestV2024' is not null or undefined - assertParamExists('deleteCampaigns', 'campaignsDeleteRequestV2024', campaignsDeleteRequestV2024) - const localVarPath = `/campaigns/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignsDeleteRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns: async (detail?: GetActiveCampaignsDetailV2024, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign: async (id: string, detail?: GetCampaignDetailV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaign', 'id', id) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignReports', 'id', id) - const localVarPath = `/campaigns/{id}/reports` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns/reports-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2024} adminReviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move: async (id: string, adminReviewReassignV2024: AdminReviewReassignV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('move', 'id', id) - // verify required parameter 'adminReviewReassignV2024' is not null or undefined - assertParamExists('move', 'adminReviewReassignV2024', adminReviewReassignV2024) - const localVarPath = `/campaigns/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(adminReviewReassignV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2024 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchCampaignTemplate', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchCampaignTemplate', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2024} campaignReportsConfigV2024 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig: async (campaignReportsConfigV2024: CampaignReportsConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignReportsConfigV2024' is not null or undefined - assertParamExists('setCampaignReportsConfig', 'campaignReportsConfigV2024', campaignReportsConfigV2024) - const localVarPath = `/campaigns/reports-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignReportsConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2024} [scheduleV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule: async (id: string, scheduleV2024?: ScheduleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduleV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2024} [activateCampaignOptionsV2024] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign: async (id: string, activateCampaignOptionsV2024?: ActivateCampaignOptionsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/activate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(activateCampaignOptionsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignRemediationScan', 'id', id) - const localVarPath = `/campaigns/{id}/run-remediation-scan` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2024} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport: async (id: string, type: ReportTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignReport', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('startCampaignReport', 'type', type) - const localVarPath = `/campaigns/{id}/run-report/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startGenerateCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{id}/generate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2024 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateCampaign', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateCampaign', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignsV2024Api - functional programming interface - * @export - */ -export const CertificationCampaignsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignsV2024ApiAxiosParamCreator(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2024} [campaignCompleteOptionsV2024] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeCampaign(id: string, campaignCompleteOptionsV2024?: CampaignCompleteOptionsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaign(id, campaignCompleteOptionsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.completeCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2024} campaignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaign(campaignV2024: CampaignV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaign(campaignV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.createCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2024} campaignTemplateV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignTemplate(campaignTemplateV2024: CampaignTemplateV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplate(campaignTemplateV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.createCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.deleteCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.deleteCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2024} campaignsDeleteRequestV2024 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaigns(campaignsDeleteRequestV2024: CampaignsDeleteRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaigns(campaignsDeleteRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.deleteCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getActiveCampaigns(detail?: GetActiveCampaignsDetailV2024, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getActiveCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2024} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaign(id: string, detail?: GetCampaignDetailV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaign(id, detail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReports(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReports(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaignReports']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.getCampaignTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2024} adminReviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async move(id: string, adminReviewReassignV2024: AdminReviewReassignV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.move(id, adminReviewReassignV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.move']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2024 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchCampaignTemplate(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplate(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.patchCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2024} campaignReportsConfigV2024 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignReportsConfig(campaignReportsConfigV2024: CampaignReportsConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfig(campaignReportsConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.setCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2024} [scheduleV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignTemplateSchedule(id: string, scheduleV2024?: ScheduleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateSchedule(id, scheduleV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.setCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2024} [activateCampaignOptionsV2024] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaign(id: string, activateCampaignOptionsV2024?: ActivateCampaignOptionsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaign(id, activateCampaignOptionsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.startCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignRemediationScan(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScan(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.startCampaignRemediationScan']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2024} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignReport(id: string, type: ReportTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReport(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.startCampaignReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startGenerateCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.startGenerateCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2024 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaign(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaign(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2024Api.updateCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignsV2024Api - factory interface - * @export - */ -export const CertificationCampaignsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignsV2024ApiFp(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2024ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign(requestParameters: CertificationCampaignsV2024ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2024ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign(requestParameters: CertificationCampaignsV2024ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaign(requestParameters.campaignV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2024ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignTemplate(requestParameters.campaignTemplateV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2024ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaigns(requestParameters.campaignsDeleteRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2024ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns(requestParameters: CertificationCampaignsV2024ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2024ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign(requestParameters: CertificationCampaignsV2024ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2024ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports(requestParameters: CertificationCampaignsV2024ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2024ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2024ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2024ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move(requestParameters: CertificationCampaignsV2024ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.move(requestParameters.id, requestParameters.adminReviewReassignV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2024ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig(requestParameters: CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignReportsConfig(requestParameters.campaignReportsConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2024ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign(requestParameters: CertificationCampaignsV2024ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan(requestParameters: CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2024ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport(requestParameters: CertificationCampaignsV2024ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2024ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign(requestParameters: CertificationCampaignsV2024ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeCampaign operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiCompleteCampaignRequest - */ -export interface CertificationCampaignsV2024ApiCompleteCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2024ApiCompleteCampaign - */ - readonly id: string - - /** - * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @type {CampaignCompleteOptionsV2024} - * @memberof CertificationCampaignsV2024ApiCompleteCampaign - */ - readonly campaignCompleteOptionsV2024?: CampaignCompleteOptionsV2024 -} - -/** - * Request parameters for createCampaign operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiCreateCampaignRequest - */ -export interface CertificationCampaignsV2024ApiCreateCampaignRequest { - /** - * - * @type {CampaignV2024} - * @memberof CertificationCampaignsV2024ApiCreateCampaign - */ - readonly campaignV2024: CampaignV2024 -} - -/** - * Request parameters for createCampaignTemplate operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiCreateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2024ApiCreateCampaignTemplateRequest { - /** - * - * @type {CampaignTemplateV2024} - * @memberof CertificationCampaignsV2024ApiCreateCampaignTemplate - */ - readonly campaignTemplateV2024: CampaignTemplateV2024 -} - -/** - * Request parameters for deleteCampaignTemplate operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest - */ -export interface CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest { - /** - * ID of the campaign template being deleted. - * @type {string} - * @memberof CertificationCampaignsV2024ApiDeleteCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaignTemplateSchedule operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being deleted. - * @type {string} - * @memberof CertificationCampaignsV2024ApiDeleteCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaigns operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiDeleteCampaignsRequest - */ -export interface CertificationCampaignsV2024ApiDeleteCampaignsRequest { - /** - * IDs of the campaigns to delete. - * @type {CampaignsDeleteRequestV2024} - * @memberof CertificationCampaignsV2024ApiDeleteCampaigns - */ - readonly campaignsDeleteRequestV2024: CampaignsDeleteRequestV2024 -} - -/** - * Request parameters for getActiveCampaigns operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetActiveCampaignsRequest - */ -export interface CertificationCampaignsV2024ApiGetActiveCampaignsRequest { - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2024ApiGetActiveCampaigns - */ - readonly detail?: GetActiveCampaignsDetailV2024 - - /** - * 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 CertificationCampaignsV2024ApiGetActiveCampaigns - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2024ApiGetActiveCampaigns - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2024ApiGetActiveCampaigns - */ - 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, in* **name**: *eq, sw* **status**: *eq, in* - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetActiveCampaigns - */ - 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: **name, created** - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetActiveCampaigns - */ - readonly sorters?: string -} - -/** - * Request parameters for getCampaign operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetCampaignRequest - */ -export interface CertificationCampaignsV2024ApiGetCampaignRequest { - /** - * ID of the campaign to be retrieved. - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaign - */ - readonly id: string - - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2024ApiGetCampaign - */ - readonly detail?: GetCampaignDetailV2024 -} - -/** - * Request parameters for getCampaignReports operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetCampaignReportsRequest - */ -export interface CertificationCampaignsV2024ApiGetCampaignReportsRequest { - /** - * ID of the campaign whose reports are being fetched. - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaignReports - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplate operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetCampaignTemplateRequest - */ -export interface CertificationCampaignsV2024ApiGetCampaignTemplateRequest { - /** - * Requested campaign template\'s ID. - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplateSchedule operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being fetched. - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplates operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiGetCampaignTemplatesRequest - */ -export interface CertificationCampaignsV2024ApiGetCampaignTemplatesRequest { - /** - * 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 CertificationCampaignsV2024ApiGetCampaignTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplates - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplates - */ - readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof CertificationCampaignsV2024ApiGetCampaignTemplates - */ - readonly filters?: string -} - -/** - * Request parameters for move operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiMoveRequest - */ -export interface CertificationCampaignsV2024ApiMoveRequest { - /** - * The certification campaign ID - * @type {string} - * @memberof CertificationCampaignsV2024ApiMove - */ - readonly id: string - - /** - * - * @type {AdminReviewReassignV2024} - * @memberof CertificationCampaignsV2024ApiMove - */ - readonly adminReviewReassignV2024: AdminReviewReassignV2024 -} - -/** - * Request parameters for patchCampaignTemplate operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiPatchCampaignTemplateRequest - */ -export interface CertificationCampaignsV2024ApiPatchCampaignTemplateRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2024ApiPatchCampaignTemplate - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @type {Array} - * @memberof CertificationCampaignsV2024ApiPatchCampaignTemplate - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for setCampaignReportsConfig operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest - */ -export interface CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest { - /** - * Campaign report configuration. - * @type {CampaignReportsConfigV2024} - * @memberof CertificationCampaignsV2024ApiSetCampaignReportsConfig - */ - readonly campaignReportsConfigV2024: CampaignReportsConfigV2024 -} - -/** - * Request parameters for setCampaignTemplateSchedule operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template being scheduled. - * @type {string} - * @memberof CertificationCampaignsV2024ApiSetCampaignTemplateSchedule - */ - readonly id: string - - /** - * - * @type {ScheduleV2024} - * @memberof CertificationCampaignsV2024ApiSetCampaignTemplateSchedule - */ - readonly scheduleV2024?: ScheduleV2024 -} - -/** - * Request parameters for startCampaign operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiStartCampaignRequest - */ -export interface CertificationCampaignsV2024ApiStartCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2024ApiStartCampaign - */ - readonly id: string - - /** - * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @type {ActivateCampaignOptionsV2024} - * @memberof CertificationCampaignsV2024ApiStartCampaign - */ - readonly activateCampaignOptionsV2024?: ActivateCampaignOptionsV2024 -} - -/** - * Request parameters for startCampaignRemediationScan operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest - */ -export interface CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest { - /** - * ID of the campaign the remediation scan is being run for. - * @type {string} - * @memberof CertificationCampaignsV2024ApiStartCampaignRemediationScan - */ - readonly id: string -} - -/** - * Request parameters for startCampaignReport operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiStartCampaignReportRequest - */ -export interface CertificationCampaignsV2024ApiStartCampaignReportRequest { - /** - * ID of the campaign the report is being run for. - * @type {string} - * @memberof CertificationCampaignsV2024ApiStartCampaignReport - */ - readonly id: string - - /** - * Type of the report to run. - * @type {ReportTypeV2024} - * @memberof CertificationCampaignsV2024ApiStartCampaignReport - */ - readonly type: ReportTypeV2024 -} - -/** - * Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest { - /** - * ID of the campaign template to use for generation. - * @type {string} - * @memberof CertificationCampaignsV2024ApiStartGenerateCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for updateCampaign operation in CertificationCampaignsV2024Api. - * @export - * @interface CertificationCampaignsV2024ApiUpdateCampaignRequest - */ -export interface CertificationCampaignsV2024ApiUpdateCampaignRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2024ApiUpdateCampaign - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @type {Array} - * @memberof CertificationCampaignsV2024ApiUpdateCampaign - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * CertificationCampaignsV2024Api - object-oriented interface - * @export - * @class CertificationCampaignsV2024Api - * @extends {BaseAPI} - */ -export class CertificationCampaignsV2024Api extends BaseAPI { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2024ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public completeCampaign(requestParameters: CertificationCampaignsV2024ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2024ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public createCampaign(requestParameters: CertificationCampaignsV2024ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).createCampaign(requestParameters.campaignV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2024ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public createCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).createCampaignTemplate(requestParameters.campaignTemplateV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public deleteCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2024ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public deleteCampaigns(requestParameters: CertificationCampaignsV2024ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).deleteCampaigns(requestParameters.campaignsDeleteRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2024ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getActiveCampaigns(requestParameters: CertificationCampaignsV2024ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2024ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaign(requestParameters: CertificationCampaignsV2024ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2024ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaignReports(requestParameters: CertificationCampaignsV2024ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaignReportsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2024ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2024ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public getCampaignTemplates(requestParameters: CertificationCampaignsV2024ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2024ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public move(requestParameters: CertificationCampaignsV2024ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).move(requestParameters.id, requestParameters.adminReviewReassignV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2024ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public patchCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public setCampaignReportsConfig(requestParameters: CertificationCampaignsV2024ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).setCampaignReportsConfig(requestParameters.campaignReportsConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2024ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2024ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public startCampaign(requestParameters: CertificationCampaignsV2024ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public startCampaignRemediationScan(requestParameters: CertificationCampaignsV2024ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2024ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public startCampaignReport(requestParameters: CertificationCampaignsV2024ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2024ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2024ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2024Api - */ - public updateCampaign(requestParameters: CertificationCampaignsV2024ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2024ApiFp(this.configuration).updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetActiveCampaignsDetailV2024 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetActiveCampaignsDetailV2024 = typeof GetActiveCampaignsDetailV2024[keyof typeof GetActiveCampaignsDetailV2024]; -/** - * @export - */ -export const GetCampaignDetailV2024 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetCampaignDetailV2024 = typeof GetCampaignDetailV2024[keyof typeof GetCampaignDetailV2024]; - - -/** - * CertificationSummariesV2024Api - axios parameter creator - * @export - */ -export const CertificationSummariesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2024} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries: async (id: string, type: GetIdentityAccessSummariesTypeV2024, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'type', type) - const localVarPath = `/certifications/{id}/access-summaries/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityDecisionSummary', 'id', id) - const localVarPath = `/certifications/{id}/decision-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummaries', 'id', id) - const localVarPath = `/certifications/{id}/identity-summaries` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummary', 'id', id) - // verify required parameter 'identitySummaryId' is not null or undefined - assertParamExists('getIdentitySummary', 'identitySummaryId', identitySummaryId) - const localVarPath = `/certifications/{id}/identity-summaries/{identitySummaryId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationSummariesV2024Api - functional programming interface - * @export - */ -export const CertificationSummariesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationSummariesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2024} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAccessSummaries(id: string, type: GetIdentityAccessSummariesTypeV2024, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummaries(id, type, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2024Api.getIdentityAccessSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityDecisionSummary(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummary(id, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2024Api.getIdentityDecisionSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummaries(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaries(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2024Api.getIdentitySummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummary(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummary(id, identitySummaryId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2024Api.getIdentitySummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationSummariesV2024Api - factory interface - * @export - */ -export const CertificationSummariesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationSummariesV2024ApiFp(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries(requestParameters: CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary(requestParameters: CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2024ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries(requestParameters: CertificationSummariesV2024ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2024ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary(requestParameters: CertificationSummariesV2024ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getIdentityAccessSummaries operation in CertificationSummariesV2024Api. - * @export - * @interface CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest - */ -export interface CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - readonly id: string - - /** - * The type of access review item to retrieve summaries for - * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - readonly type: GetIdentityAccessSummariesTypeV2024 - - /** - * 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 CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - 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: **access.name** - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentityAccessSummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentityDecisionSummary operation in CertificationSummariesV2024Api. - * @export - * @interface CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest - */ -export interface CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentityDecisionSummary - */ - readonly id: 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: **identitySummary.id**: *eq, in* - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentityDecisionSummary - */ - readonly filters?: string -} - -/** - * Request parameters for getIdentitySummaries operation in CertificationSummariesV2024Api. - * @export - * @interface CertificationSummariesV2024ApiGetIdentitySummariesRequest - */ -export interface CertificationSummariesV2024ApiGetIdentitySummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - 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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - 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: **name** - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentitySummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentitySummary operation in CertificationSummariesV2024Api. - * @export - * @interface CertificationSummariesV2024ApiGetIdentitySummaryRequest - */ -export interface CertificationSummariesV2024ApiGetIdentitySummaryRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentitySummary - */ - readonly id: string - - /** - * The identity summary ID - * @type {string} - * @memberof CertificationSummariesV2024ApiGetIdentitySummary - */ - readonly identitySummaryId: string -} - -/** - * CertificationSummariesV2024Api - object-oriented interface - * @export - * @class CertificationSummariesV2024Api - * @extends {BaseAPI} - */ -export class CertificationSummariesV2024Api extends BaseAPI { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2024Api - */ - public getIdentityAccessSummaries(requestParameters: CertificationSummariesV2024ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2024ApiFp(this.configuration).getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2024Api - */ - public getIdentityDecisionSummary(requestParameters: CertificationSummariesV2024ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2024ApiFp(this.configuration).getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2024ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2024Api - */ - public getIdentitySummaries(requestParameters: CertificationSummariesV2024ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2024ApiFp(this.configuration).getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2024ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2024Api - */ - public getIdentitySummary(requestParameters: CertificationSummariesV2024ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2024ApiFp(this.configuration).getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetIdentityAccessSummariesTypeV2024 = { - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT' -} as const; -export type GetIdentityAccessSummariesTypeV2024 = typeof GetIdentityAccessSummariesTypeV2024[keyof typeof GetIdentityAccessSummariesTypeV2024]; - - -/** - * CertificationsV2024Api - axios parameter creator - * @export - */ -export const CertificationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCertificationTask', 'id', id) - const localVarPath = `/certification-tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertification', 'id', id) - const localVarPath = `/certifications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'certificationId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'certificationId', certificationId) - // verify required parameter 'itemId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'itemId', itemId) - const localVarPath = `/certifications/{certificationId}/access-review-items/{itemId}/permissions` - .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) - .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certification-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listCertificationReviewers', 'id', id) - const localVarPath = `/certifications/{id}/reviewers` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessReviewItems', 'id', id) - const localVarPath = `/certifications/{id}/access-review-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (entitlements !== undefined) { - localVarQueryParameter['entitlements'] = entitlements; - } - - if (accessProfiles !== undefined) { - localVarQueryParameter['access-profiles'] = accessProfiles; - } - - if (roles !== undefined) { - localVarQueryParameter['roles'] = roles; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certifications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2024 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision: async (id: string, reviewDecisionV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('makeIdentityDecision', 'id', id) - // verify required parameter 'reviewDecisionV2024' is not null or undefined - assertParamExists('makeIdentityDecision', 'reviewDecisionV2024', reviewDecisionV2024) - const localVarPath = `/certifications/{id}/decide` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewDecisionV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2024} reviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications: async (id: string, reviewReassignV2024: ReviewReassignV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'id', id) - // verify required parameter 'reviewReassignV2024' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'reviewReassignV2024', reviewReassignV2024) - const localVarPath = `/certifications/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('signOffIdentityCertification', 'id', id) - const localVarPath = `/certifications/{id}/sign-off` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2024} reviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync: async (id: string, reviewReassignV2024: ReviewReassignV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'id', id) - // verify required parameter 'reviewReassignV2024' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'reviewReassignV2024', reviewReassignV2024) - const localVarPath = `/certifications/{id}/reassign-async` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationsV2024Api - functional programming interface - * @export - */ -export const CertificationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCertificationTask(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.getCertificationTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.getIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissions(certificationId, itemId, filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.getIdentityCertificationItemPermissions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasks(reviewerIdentity, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.getPendingCertificationTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewers(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.listCertificationReviewers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessReviewItems(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItems(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.listIdentityAccessReviewItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityCertifications(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertifications(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.listIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2024 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async makeIdentityDecision(id: string, reviewDecisionV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecision(id, reviewDecisionV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.makeIdentityDecision']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2024} reviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async reassignIdentityCertifications(id: string, reviewReassignV2024: ReviewReassignV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertifications(id, reviewReassignV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.reassignIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async signOffIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.signOffIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2024} reviewReassignV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReassignCertsAsync(id: string, reviewReassignV2024: ReviewReassignV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsync(id, reviewReassignV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2024Api.submitReassignCertsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationsV2024Api - factory interface - * @export - */ -export const CertificationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationsV2024ApiFp(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2024ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask(requestParameters: CertificationsV2024ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2024ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification(requestParameters: CertificationsV2024ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions(requestParameters: CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2024ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks(requestParameters: CertificationsV2024ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2024ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers(requestParameters: CertificationsV2024ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2024ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems(requestParameters: CertificationsV2024ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2024ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications(requestParameters: CertificationsV2024ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2024ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision(requestParameters: CertificationsV2024ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2024ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications(requestParameters: CertificationsV2024ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2024ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification(requestParameters: CertificationsV2024ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2024ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync(requestParameters: CertificationsV2024ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getCertificationTask operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiGetCertificationTaskRequest - */ -export interface CertificationsV2024ApiGetCertificationTaskRequest { - /** - * The task ID - * @type {string} - * @memberof CertificationsV2024ApiGetCertificationTask - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertification operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiGetIdentityCertificationRequest - */ -export interface CertificationsV2024ApiGetIdentityCertificationRequest { - /** - * The certification id - * @type {string} - * @memberof CertificationsV2024ApiGetIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertificationItemPermissions operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest - */ -export interface CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly certificationId: string - - /** - * The certification item ID - * @type {string} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @type {string} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2024ApiGetIdentityCertificationItemPermissions - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingCertificationTasks operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiGetPendingCertificationTasksRequest - */ -export interface CertificationsV2024ApiGetPendingCertificationTasksRequest { - /** - * The ID of reviewer identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2024ApiGetPendingCertificationTasks - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiGetPendingCertificationTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiGetPendingCertificationTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2024ApiGetPendingCertificationTasks - */ - 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, in* **targetId**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof CertificationsV2024ApiGetPendingCertificationTasks - */ - readonly filters?: string -} - -/** - * Request parameters for listCertificationReviewers operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiListCertificationReviewersRequest - */ -export interface CertificationsV2024ApiListCertificationReviewersRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - 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, in* **name**: *eq, sw* **email**: *eq, sw* - * @type {string} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - 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: **name, email** - * @type {string} - * @memberof CertificationsV2024ApiListCertificationReviewers - */ - readonly sorters?: string -} - -/** - * Request parameters for listIdentityAccessReviewItems operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiListIdentityAccessReviewItemsRequest - */ -export interface CertificationsV2024ApiListIdentityAccessReviewItemsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - 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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly sorters?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly entitlements?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly accessProfiles?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2024ApiListIdentityAccessReviewItems - */ - readonly roles?: string -} - -/** - * Request parameters for listIdentityCertifications operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiListIdentityCertificationsRequest - */ -export interface CertificationsV2024ApiListIdentityCertificationsRequest { - /** - * Reviewer\'s identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - 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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @type {string} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - 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: **name, due, signed** - * @type {string} - * @memberof CertificationsV2024ApiListIdentityCertifications - */ - readonly sorters?: string -} - -/** - * Request parameters for makeIdentityDecision operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiMakeIdentityDecisionRequest - */ -export interface CertificationsV2024ApiMakeIdentityDecisionRequest { - /** - * The ID of the identity campaign certification on which to make decisions - * @type {string} - * @memberof CertificationsV2024ApiMakeIdentityDecision - */ - readonly id: string - - /** - * A non-empty array of decisions to be made. - * @type {Array} - * @memberof CertificationsV2024ApiMakeIdentityDecision - */ - readonly reviewDecisionV2024: Array -} - -/** - * Request parameters for reassignIdentityCertifications operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiReassignIdentityCertificationsRequest - */ -export interface CertificationsV2024ApiReassignIdentityCertificationsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2024ApiReassignIdentityCertifications - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2024} - * @memberof CertificationsV2024ApiReassignIdentityCertifications - */ - readonly reviewReassignV2024: ReviewReassignV2024 -} - -/** - * Request parameters for signOffIdentityCertification operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiSignOffIdentityCertificationRequest - */ -export interface CertificationsV2024ApiSignOffIdentityCertificationRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2024ApiSignOffIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for submitReassignCertsAsync operation in CertificationsV2024Api. - * @export - * @interface CertificationsV2024ApiSubmitReassignCertsAsyncRequest - */ -export interface CertificationsV2024ApiSubmitReassignCertsAsyncRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2024ApiSubmitReassignCertsAsync - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2024} - * @memberof CertificationsV2024ApiSubmitReassignCertsAsync - */ - readonly reviewReassignV2024: ReviewReassignV2024 -} - -/** - * CertificationsV2024Api - object-oriented interface - * @export - * @class CertificationsV2024Api - * @extends {BaseAPI} - */ -export class CertificationsV2024Api extends BaseAPI { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2024ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public getCertificationTask(requestParameters: CertificationsV2024ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2024ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public getIdentityCertification(requestParameters: CertificationsV2024ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public getIdentityCertificationItemPermissions(requestParameters: CertificationsV2024ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2024ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public getPendingCertificationTasks(requestParameters: CertificationsV2024ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2024ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public listCertificationReviewers(requestParameters: CertificationsV2024ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2024ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public listIdentityAccessReviewItems(requestParameters: CertificationsV2024ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2024ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public listIdentityCertifications(requestParameters: CertificationsV2024ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2024ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public makeIdentityDecision(requestParameters: CertificationsV2024ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2024ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public reassignIdentityCertifications(requestParameters: CertificationsV2024ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2024ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public signOffIdentityCertification(requestParameters: CertificationsV2024ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2024ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2024Api - */ - public submitReassignCertsAsync(requestParameters: CertificationsV2024ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2024ApiFp(this.configuration).submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConfigurationHubV2024Api - axios parameter creator - * @export - */ -export const ConfigurationHubV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2024} deployRequestV2024 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy: async (deployRequestV2024: DeployRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deployRequestV2024' is not null or undefined - assertParamExists('createDeploy', 'deployRequestV2024', deployRequestV2024) - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deployRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2024} objectMappingRequestV2024 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping: async (sourceOrg: string, objectMappingRequestV2024: ObjectMappingRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingRequestV2024' is not null or undefined - assertParamExists('createObjectMapping', 'objectMappingRequestV2024', objectMappingRequestV2024) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2024} objectMappingBulkCreateRequestV2024 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings: async (sourceOrg: string, objectMappingBulkCreateRequestV2024: ObjectMappingBulkCreateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkCreateRequestV2024' is not null or undefined - assertParamExists('createObjectMappings', 'objectMappingBulkCreateRequestV2024', objectMappingBulkCreateRequestV2024) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkCreateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2024} scheduledActionPayloadV2024 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction: async (scheduledActionPayloadV2024: ScheduledActionPayloadV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionPayloadV2024' is not null or undefined - assertParamExists('createScheduledAction', 'scheduledActionPayloadV2024', scheduledActionPayloadV2024) - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledActionPayloadV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('createUploadedConfiguration', 'data', data) - // verify required parameter 'name' is not null or undefined - assertParamExists('createUploadedConfiguration', 'name', name) - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteBackup', 'id', id) - const localVarPath = `/configuration-hub/backups/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDraft', 'id', id) - const localVarPath = `/configuration-hub/drafts/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('deleteObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingId' is not null or undefined - assertParamExists('deleteObjectMapping', 'objectMappingId', objectMappingId) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) - .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction: async (scheduledActionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('deleteScheduledAction', 'scheduledActionId', scheduledActionId) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDeploy', 'id', id) - const localVarPath = `/configuration-hub/deploys/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('getObjectMappings', 'sourceOrg', sourceOrg) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/drafts`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2024} objectMappingBulkPatchRequestV2024 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings: async (sourceOrg: string, objectMappingBulkPatchRequestV2024: ObjectMappingBulkPatchRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('updateObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkPatchRequestV2024' is not null or undefined - assertParamExists('updateObjectMappings', 'objectMappingBulkPatchRequestV2024', objectMappingBulkPatchRequestV2024) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkPatchRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2024} jsonPatchV2024 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction: async (scheduledActionId: string, jsonPatchV2024: JsonPatchV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('updateScheduledAction', 'scheduledActionId', scheduledActionId) - // verify required parameter 'jsonPatchV2024' is not null or undefined - assertParamExists('updateScheduledAction', 'jsonPatchV2024', jsonPatchV2024) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConfigurationHubV2024Api - functional programming interface - * @export - */ -export const ConfigurationHubV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConfigurationHubV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2024} deployRequestV2024 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDeploy(deployRequestV2024: DeployRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDeploy(deployRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.createDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2024} objectMappingRequestV2024 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMapping(sourceOrg: string, objectMappingRequestV2024: ObjectMappingRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMapping(sourceOrg, objectMappingRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.createObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2024} objectMappingBulkCreateRequestV2024 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMappings(sourceOrg: string, objectMappingBulkCreateRequestV2024: ObjectMappingBulkCreateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappings(sourceOrg, objectMappingBulkCreateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.createObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2024} scheduledActionPayloadV2024 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledAction(scheduledActionPayloadV2024: ScheduledActionPayloadV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledAction(scheduledActionPayloadV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.createScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createUploadedConfiguration(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfiguration(data, name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.createUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBackup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBackup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.deleteBackup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDraft(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDraft(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.deleteDraft']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteObjectMapping(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMapping(sourceOrg, objectMappingId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.deleteObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledAction(scheduledActionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledAction(scheduledActionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.deleteScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.deleteUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDeploy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDeploy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.getDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getObjectMappings(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappings(sourceOrg, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.getObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.getUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listBackups(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listBackups(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.listBackups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDeploys(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDeploys(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.listDeploys']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDrafts(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDrafts(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.listDrafts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledActions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledActions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.listScheduledActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUploadedConfigurations(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurations(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.listUploadedConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2024} objectMappingBulkPatchRequestV2024 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateObjectMappings(sourceOrg: string, objectMappingBulkPatchRequestV2024: ObjectMappingBulkPatchRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappings(sourceOrg, objectMappingBulkPatchRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.updateObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2024} jsonPatchV2024 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledAction(scheduledActionId: string, jsonPatchV2024: JsonPatchV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledAction(scheduledActionId, jsonPatchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2024Api.updateScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConfigurationHubV2024Api - factory interface - * @export - */ -export const ConfigurationHubV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConfigurationHubV2024ApiFp(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2024ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy(requestParameters: ConfigurationHubV2024ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDeploy(requestParameters.deployRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2024ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping(requestParameters: ConfigurationHubV2024ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2024ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings(requestParameters: ConfigurationHubV2024ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2024ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction(requestParameters: ConfigurationHubV2024ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledAction(requestParameters.scheduledActionPayloadV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2024ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2024ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup(requestParameters: ConfigurationHubV2024ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBackup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2024ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft(requestParameters: ConfigurationHubV2024ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDraft(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2024ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping(requestParameters: ConfigurationHubV2024ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2024ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction(requestParameters: ConfigurationHubV2024ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2024ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy(requestParameters: ConfigurationHubV2024ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDeploy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2024ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings(requestParameters: ConfigurationHubV2024ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2024ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2024ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups(requestParameters: ConfigurationHubV2024ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listBackups(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listDeploys(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2024ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts(requestParameters: ConfigurationHubV2024ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDrafts(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledActions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2024ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations(requestParameters: ConfigurationHubV2024ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2024ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings(requestParameters: ConfigurationHubV2024ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2024ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction(requestParameters: ConfigurationHubV2024ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDeploy operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiCreateDeployRequest - */ -export interface ConfigurationHubV2024ApiCreateDeployRequest { - /** - * The deploy request body. - * @type {DeployRequestV2024} - * @memberof ConfigurationHubV2024ApiCreateDeploy - */ - readonly deployRequestV2024: DeployRequestV2024 -} - -/** - * Request parameters for createObjectMapping operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiCreateObjectMappingRequest - */ -export interface ConfigurationHubV2024ApiCreateObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2024ApiCreateObjectMapping - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingRequestV2024} - * @memberof ConfigurationHubV2024ApiCreateObjectMapping - */ - readonly objectMappingRequestV2024: ObjectMappingRequestV2024 -} - -/** - * Request parameters for createObjectMappings operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiCreateObjectMappingsRequest - */ -export interface ConfigurationHubV2024ApiCreateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2024ApiCreateObjectMappings - */ - readonly sourceOrg: string - - /** - * The bulk create object mapping request body. - * @type {ObjectMappingBulkCreateRequestV2024} - * @memberof ConfigurationHubV2024ApiCreateObjectMappings - */ - readonly objectMappingBulkCreateRequestV2024: ObjectMappingBulkCreateRequestV2024 -} - -/** - * Request parameters for createScheduledAction operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiCreateScheduledActionRequest - */ -export interface ConfigurationHubV2024ApiCreateScheduledActionRequest { - /** - * The scheduled action creation request body. - * @type {ScheduledActionPayloadV2024} - * @memberof ConfigurationHubV2024ApiCreateScheduledAction - */ - readonly scheduledActionPayloadV2024: ScheduledActionPayloadV2024 -} - -/** - * Request parameters for createUploadedConfiguration operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiCreateUploadedConfigurationRequest - */ -export interface ConfigurationHubV2024ApiCreateUploadedConfigurationRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ConfigurationHubV2024ApiCreateUploadedConfiguration - */ - readonly data: File - - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof ConfigurationHubV2024ApiCreateUploadedConfiguration - */ - readonly name: string -} - -/** - * Request parameters for deleteBackup operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiDeleteBackupRequest - */ -export interface ConfigurationHubV2024ApiDeleteBackupRequest { - /** - * The id of the backup to delete. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteBackup - */ - readonly id: string -} - -/** - * Request parameters for deleteDraft operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiDeleteDraftRequest - */ -export interface ConfigurationHubV2024ApiDeleteDraftRequest { - /** - * The id of the draft to delete. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteDraft - */ - readonly id: string -} - -/** - * Request parameters for deleteObjectMapping operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiDeleteObjectMappingRequest - */ -export interface ConfigurationHubV2024ApiDeleteObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteObjectMapping - */ - readonly sourceOrg: string - - /** - * The id of the object mapping to be deleted. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteObjectMapping - */ - readonly objectMappingId: string -} - -/** - * Request parameters for deleteScheduledAction operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiDeleteScheduledActionRequest - */ -export interface ConfigurationHubV2024ApiDeleteScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteScheduledAction - */ - readonly scheduledActionId: string -} - -/** - * Request parameters for deleteUploadedConfiguration operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest - */ -export interface ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2024ApiDeleteUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getDeploy operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiGetDeployRequest - */ -export interface ConfigurationHubV2024ApiGetDeployRequest { - /** - * The id of the deploy. - * @type {string} - * @memberof ConfigurationHubV2024ApiGetDeploy - */ - readonly id: string -} - -/** - * Request parameters for getObjectMappings operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiGetObjectMappingsRequest - */ -export interface ConfigurationHubV2024ApiGetObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2024ApiGetObjectMappings - */ - readonly sourceOrg: string -} - -/** - * Request parameters for getUploadedConfiguration operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiGetUploadedConfigurationRequest - */ -export interface ConfigurationHubV2024ApiGetUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2024ApiGetUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for listBackups operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiListBackupsRequest - */ -export interface ConfigurationHubV2024ApiListBackupsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2024ApiListBackups - */ - readonly filters?: string -} - -/** - * Request parameters for listDrafts operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiListDraftsRequest - */ -export interface ConfigurationHubV2024ApiListDraftsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @type {string} - * @memberof ConfigurationHubV2024ApiListDrafts - */ - readonly filters?: string -} - -/** - * Request parameters for listUploadedConfigurations operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiListUploadedConfigurationsRequest - */ -export interface ConfigurationHubV2024ApiListUploadedConfigurationsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2024ApiListUploadedConfigurations - */ - readonly filters?: string -} - -/** - * Request parameters for updateObjectMappings operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiUpdateObjectMappingsRequest - */ -export interface ConfigurationHubV2024ApiUpdateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2024ApiUpdateObjectMappings - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingBulkPatchRequestV2024} - * @memberof ConfigurationHubV2024ApiUpdateObjectMappings - */ - readonly objectMappingBulkPatchRequestV2024: ObjectMappingBulkPatchRequestV2024 -} - -/** - * Request parameters for updateScheduledAction operation in ConfigurationHubV2024Api. - * @export - * @interface ConfigurationHubV2024ApiUpdateScheduledActionRequest - */ -export interface ConfigurationHubV2024ApiUpdateScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2024ApiUpdateScheduledAction - */ - readonly scheduledActionId: string - - /** - * The JSON Patch document containing the changes to apply to the scheduled action. - * @type {JsonPatchV2024} - * @memberof ConfigurationHubV2024ApiUpdateScheduledAction - */ - readonly jsonPatchV2024: JsonPatchV2024 -} - -/** - * ConfigurationHubV2024Api - object-oriented interface - * @export - * @class ConfigurationHubV2024Api - * @extends {BaseAPI} - */ -export class ConfigurationHubV2024Api extends BaseAPI { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2024ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public createDeploy(requestParameters: ConfigurationHubV2024ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).createDeploy(requestParameters.deployRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2024ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public createObjectMapping(requestParameters: ConfigurationHubV2024ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2024ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public createObjectMappings(requestParameters: ConfigurationHubV2024ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2024ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public createScheduledAction(requestParameters: ConfigurationHubV2024ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).createScheduledAction(requestParameters.scheduledActionPayloadV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2024ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public createUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2024ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public deleteBackup(requestParameters: ConfigurationHubV2024ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).deleteBackup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2024ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public deleteDraft(requestParameters: ConfigurationHubV2024ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).deleteDraft(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2024ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public deleteObjectMapping(requestParameters: ConfigurationHubV2024ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2024ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public deleteScheduledAction(requestParameters: ConfigurationHubV2024ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public deleteUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2024ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public getDeploy(requestParameters: ConfigurationHubV2024ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).getDeploy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2024ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public getObjectMappings(requestParameters: ConfigurationHubV2024ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2024ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public getUploadedConfiguration(requestParameters: ConfigurationHubV2024ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2024ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public listBackups(requestParameters: ConfigurationHubV2024ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).listBackups(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public listDeploys(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).listDeploys(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2024ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public listDrafts(requestParameters: ConfigurationHubV2024ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).listDrafts(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public listScheduledActions(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).listScheduledActions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2024ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public listUploadedConfigurations(requestParameters: ConfigurationHubV2024ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2024ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public updateObjectMappings(requestParameters: ConfigurationHubV2024ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2024ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2024Api - */ - public updateScheduledAction(requestParameters: ConfigurationHubV2024ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2024ApiFp(this.configuration).updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorCustomizersV2024Api - axios parameter creator - * @export - */ -export const ConnectorCustomizersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2024} connectorCustomizerCreateRequestV2024 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer: async (connectorCustomizerCreateRequestV2024: ConnectorCustomizerCreateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorCustomizerCreateRequestV2024' is not null or undefined - assertParamExists('createConnectorCustomizer', 'connectorCustomizerCreateRequestV2024', connectorCustomizerCreateRequestV2024) - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerCreateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createConnectorCustomizerVersion', 'id', id) - const localVarPath = `/connector-customizers/{id}/versions` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2024} [connectorCustomizerUpdateRequestV2024] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer: async (id: string, connectorCustomizerUpdateRequestV2024?: ConnectorCustomizerUpdateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerUpdateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorCustomizersV2024Api - functional programming interface - * @export - */ -export const ConnectorCustomizersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorCustomizersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2024} connectorCustomizerCreateRequestV2024 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizer(connectorCustomizerCreateRequestV2024: ConnectorCustomizerCreateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizer(connectorCustomizerCreateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.createConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizerVersion(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizerVersion(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.createConnectorCustomizerVersion']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.deleteConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.getConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnectorCustomizers(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnectorCustomizers(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.listConnectorCustomizers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2024} [connectorCustomizerUpdateRequestV2024] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCustomizer(id: string, connectorCustomizerUpdateRequestV2024?: ConnectorCustomizerUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCustomizer(id, connectorCustomizerUpdateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2024Api.putConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorCustomizersV2024Api - factory interface - * @export - */ -export const ConnectorCustomizersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorCustomizersV2024ApiFp(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2024ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers(requestParameters: ConnectorCustomizersV2024ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorCustomizer operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest { - /** - * Connector customizer to create. - * @type {ConnectorCustomizerCreateRequestV2024} - * @memberof ConnectorCustomizersV2024ApiCreateConnectorCustomizer - */ - readonly connectorCustomizerCreateRequestV2024: ConnectorCustomizerCreateRequestV2024 -} - -/** - * Request parameters for createConnectorCustomizerVersion operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest - */ -export interface ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest { - /** - * The id of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersion - */ - readonly id: string -} - -/** - * Request parameters for deleteConnectorCustomizer operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest { - /** - * ID of the connector customizer to delete. - * @type {string} - * @memberof ConnectorCustomizersV2024ApiDeleteConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for getConnectorCustomizer operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest { - /** - * ID of the connector customizer to get. - * @type {string} - * @memberof ConnectorCustomizersV2024ApiGetConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for listConnectorCustomizers operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiListConnectorCustomizersRequest - */ -export interface ConnectorCustomizersV2024ApiListConnectorCustomizersRequest { - /** - * 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 ConnectorCustomizersV2024ApiListConnectorCustomizers - */ - 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 ConnectorCustomizersV2024ApiListConnectorCustomizers - */ - readonly limit?: number -} - -/** - * Request parameters for putConnectorCustomizer operation in ConnectorCustomizersV2024Api. - * @export - * @interface ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest { - /** - * ID of the connector customizer to update. - * @type {string} - * @memberof ConnectorCustomizersV2024ApiPutConnectorCustomizer - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorCustomizerUpdateRequestV2024} - * @memberof ConnectorCustomizersV2024ApiPutConnectorCustomizer - */ - readonly connectorCustomizerUpdateRequestV2024?: ConnectorCustomizerUpdateRequestV2024 -} - -/** - * ConnectorCustomizersV2024Api - object-oriented interface - * @export - * @class ConnectorCustomizersV2024Api - * @extends {BaseAPI} - */ -export class ConnectorCustomizersV2024Api extends BaseAPI { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public createConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2024ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public getConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2024ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public listConnectorCustomizers(requestParameters: ConnectorCustomizersV2024ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2024Api - */ - public putConnectorCustomizer(requestParameters: ConnectorCustomizersV2024ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2024ApiFp(this.configuration).putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorRuleManagementV2024Api - axios parameter creator - * @export - */ -export const ConnectorRuleManagementV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2024} connectorRuleCreateRequestV2024 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule: async (connectorRuleCreateRequestV2024: ConnectorRuleCreateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorRuleCreateRequestV2024' is not null or undefined - assertParamExists('createConnectorRule', 'connectorRuleCreateRequestV2024', connectorRuleCreateRequestV2024) - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleCreateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2024} [connectorRuleUpdateRequestV2024] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule: async (id: string, connectorRuleUpdateRequestV2024?: ConnectorRuleUpdateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleUpdateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2024} sourceCodeV2024 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule: async (sourceCodeV2024: SourceCodeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceCodeV2024' is not null or undefined - assertParamExists('testConnectorRule', 'sourceCodeV2024', sourceCodeV2024) - const localVarPath = `/connector-rules/validate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceCodeV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorRuleManagementV2024Api - functional programming interface - * @export - */ -export const ConnectorRuleManagementV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorRuleManagementV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2024} connectorRuleCreateRequestV2024 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorRule(connectorRuleCreateRequestV2024: ConnectorRuleCreateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRule(connectorRuleCreateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.createConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.deleteConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.getConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRuleList(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleList(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.getConnectorRuleList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2024} [connectorRuleUpdateRequestV2024] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorRule(id: string, connectorRuleUpdateRequestV2024?: ConnectorRuleUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorRule(id, connectorRuleUpdateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.putConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2024} sourceCodeV2024 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectorRule(sourceCodeV2024: SourceCodeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectorRule(sourceCodeV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2024Api.testConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorRuleManagementV2024Api - factory interface - * @export - */ -export const ConnectorRuleManagementV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorRuleManagementV2024ApiFp(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorRule(requestParameters.connectorRuleCreateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2024ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList(requestParameters: ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2024ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2024ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectorRule(requestParameters.sourceCodeV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorRule operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest { - /** - * Connector rule to create. - * @type {ConnectorRuleCreateRequestV2024} - * @memberof ConnectorRuleManagementV2024ApiCreateConnectorRule - */ - readonly connectorRuleCreateRequestV2024: ConnectorRuleCreateRequestV2024 -} - -/** - * Request parameters for deleteConnectorRule operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest { - /** - * ID of the connector rule to delete. - * @type {string} - * @memberof ConnectorRuleManagementV2024ApiDeleteConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRule operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiGetConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2024ApiGetConnectorRuleRequest { - /** - * ID of the connector rule to get. - * @type {string} - * @memberof ConnectorRuleManagementV2024ApiGetConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRuleList operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest - */ -export interface ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest { - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2024ApiGetConnectorRuleList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2024ApiGetConnectorRuleList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorRuleManagementV2024ApiGetConnectorRuleList - */ - readonly count?: boolean -} - -/** - * Request parameters for putConnectorRule operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiPutConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2024ApiPutConnectorRuleRequest { - /** - * ID of the connector rule to update. - * @type {string} - * @memberof ConnectorRuleManagementV2024ApiPutConnectorRule - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorRuleUpdateRequestV2024} - * @memberof ConnectorRuleManagementV2024ApiPutConnectorRule - */ - readonly connectorRuleUpdateRequestV2024?: ConnectorRuleUpdateRequestV2024 -} - -/** - * Request parameters for testConnectorRule operation in ConnectorRuleManagementV2024Api. - * @export - * @interface ConnectorRuleManagementV2024ApiTestConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2024ApiTestConnectorRuleRequest { - /** - * Code to validate. - * @type {SourceCodeV2024} - * @memberof ConnectorRuleManagementV2024ApiTestConnectorRule - */ - readonly sourceCodeV2024: SourceCodeV2024 -} - -/** - * ConnectorRuleManagementV2024Api - object-oriented interface - * @export - * @class ConnectorRuleManagementV2024Api - * @extends {BaseAPI} - */ -export class ConnectorRuleManagementV2024Api extends BaseAPI { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public createConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).createConnectorRule(requestParameters.connectorRuleCreateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public deleteConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2024ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public getConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public getConnectorRuleList(requestParameters: ConnectorRuleManagementV2024ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2024ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public putConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2024ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2024Api - */ - public testConnectorRule(requestParameters: ConnectorRuleManagementV2024ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2024ApiFp(this.configuration).testConnectorRule(requestParameters.sourceCodeV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorsV2024Api - axios parameter creator - * @export - */ -export const ConnectorsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2024} v3CreateConnectorDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector: async (v3CreateConnectorDtoV2024: V3CreateConnectorDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'v3CreateConnectorDtoV2024' is not null or undefined - assertParamExists('createCustomConnector', 'v3CreateConnectorDtoV2024', v3CreateConnectorDtoV2024) - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(v3CreateConnectorDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('deleteCustomConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector: async (scriptName: string, locale?: GetConnectorLocaleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorCorrelationConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceTemplate', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2024} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations: async (scriptName: string, locale: GetConnectorTranslationsLocaleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('getConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2024} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations: async (scriptName: string, locale: PutConnectorTranslationsLocaleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('putConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2024 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector: async (scriptName: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('updateConnector', 'scriptName', scriptName) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateConnector', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorsV2024Api - functional programming interface - * @export - */ -export const ConnectorsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2024} v3CreateConnectorDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomConnector(v3CreateConnectorDtoV2024: V3CreateConnectorDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomConnector(v3CreateConnectorDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.createCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomConnector(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomConnector(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.deleteCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnector(scriptName: string, locale?: GetConnectorLocaleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnector(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCorrelationConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCorrelationConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorList(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorList(filters, limit, offset, count, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnectorList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2024} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorTranslations(scriptName: string, locale: GetConnectorTranslationsLocaleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.getConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCorrelationConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCorrelationConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.putConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.putConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceTemplate(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceTemplate(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.putConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2024} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorTranslations(scriptName: string, locale: PutConnectorTranslationsLocaleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.putConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2024 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateConnector(scriptName: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnector(scriptName, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2024Api.updateConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorsV2024Api - factory interface - * @export - */ -export const ConnectorsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorsV2024ApiFp(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2024ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector(requestParameters: ConnectorsV2024ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomConnector(requestParameters.v3CreateConnectorDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2024ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector(requestParameters: ConnectorsV2024ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2024ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector(requestParameters: ConnectorsV2024ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2024ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig(requestParameters: ConnectorsV2024ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2024ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList(requestParameters: ConnectorsV2024ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2024ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig(requestParameters: ConnectorsV2024ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2024ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate(requestParameters: ConnectorsV2024ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2024ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations(requestParameters: ConnectorsV2024ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2024ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig(requestParameters: ConnectorsV2024ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2024ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig(requestParameters: ConnectorsV2024ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2024ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate(requestParameters: ConnectorsV2024ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2024ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations(requestParameters: ConnectorsV2024ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2024ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector(requestParameters: ConnectorsV2024ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomConnector operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiCreateCustomConnectorRequest - */ -export interface ConnectorsV2024ApiCreateCustomConnectorRequest { - /** - * - * @type {V3CreateConnectorDtoV2024} - * @memberof ConnectorsV2024ApiCreateCustomConnector - */ - readonly v3CreateConnectorDtoV2024: V3CreateConnectorDtoV2024 -} - -/** - * Request parameters for deleteCustomConnector operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiDeleteCustomConnectorRequest - */ -export interface ConnectorsV2024ApiDeleteCustomConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiDeleteCustomConnector - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnector operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorRequest - */ -export interface ConnectorsV2024ApiGetConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiGetConnector - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2024ApiGetConnector - */ - readonly locale?: GetConnectorLocaleV2024 -} - -/** - * Request parameters for getConnectorCorrelationConfig operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2024ApiGetConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiGetConnectorCorrelationConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorList operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorListRequest - */ -export interface ConnectorsV2024ApiGetConnectorListRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @type {string} - * @memberof ConnectorsV2024ApiGetConnectorList - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2024ApiGetConnectorList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2024ApiGetConnectorList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorsV2024ApiGetConnectorList - */ - readonly count?: boolean - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2024ApiGetConnectorList - */ - readonly locale?: GetConnectorListLocaleV2024 -} - -/** - * Request parameters for getConnectorSourceConfig operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorSourceConfigRequest - */ -export interface ConnectorsV2024ApiGetConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiGetConnectorSourceConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorSourceTemplate operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorSourceTemplateRequest - */ -export interface ConnectorsV2024ApiGetConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiGetConnectorSourceTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorTranslations operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiGetConnectorTranslationsRequest - */ -export interface ConnectorsV2024ApiGetConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiGetConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2024ApiGetConnectorTranslations - */ - readonly locale: GetConnectorTranslationsLocaleV2024 -} - -/** - * Request parameters for putConnectorCorrelationConfig operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiPutConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2024ApiPutConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiPutConnectorCorrelationConfig - */ - readonly scriptName: string - - /** - * connector correlation config xml file - * @type {File} - * @memberof ConnectorsV2024ApiPutConnectorCorrelationConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceConfig operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiPutConnectorSourceConfigRequest - */ -export interface ConnectorsV2024ApiPutConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiPutConnectorSourceConfig - */ - readonly scriptName: string - - /** - * connector source config xml file - * @type {File} - * @memberof ConnectorsV2024ApiPutConnectorSourceConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceTemplate operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiPutConnectorSourceTemplateRequest - */ -export interface ConnectorsV2024ApiPutConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiPutConnectorSourceTemplate - */ - readonly scriptName: string - - /** - * connector source template xml file - * @type {File} - * @memberof ConnectorsV2024ApiPutConnectorSourceTemplate - */ - readonly file: File -} - -/** - * Request parameters for putConnectorTranslations operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiPutConnectorTranslationsRequest - */ -export interface ConnectorsV2024ApiPutConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiPutConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2024ApiPutConnectorTranslations - */ - readonly locale: PutConnectorTranslationsLocaleV2024 -} - -/** - * Request parameters for updateConnector operation in ConnectorsV2024Api. - * @export - * @interface ConnectorsV2024ApiUpdateConnectorRequest - */ -export interface ConnectorsV2024ApiUpdateConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2024ApiUpdateConnector - */ - readonly scriptName: string - - /** - * A list of connector detail update operations - * @type {Array} - * @memberof ConnectorsV2024ApiUpdateConnector - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * ConnectorsV2024Api - object-oriented interface - * @export - * @class ConnectorsV2024Api - * @extends {BaseAPI} - */ -export class ConnectorsV2024Api extends BaseAPI { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2024ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public createCustomConnector(requestParameters: ConnectorsV2024ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).createCustomConnector(requestParameters.v3CreateConnectorDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2024ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public deleteCustomConnector(requestParameters: ConnectorsV2024ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2024ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnector(requestParameters: ConnectorsV2024ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2024ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnectorCorrelationConfig(requestParameters: ConnectorsV2024ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2024ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnectorList(requestParameters: ConnectorsV2024ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2024ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnectorSourceConfig(requestParameters: ConnectorsV2024ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2024ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnectorSourceTemplate(requestParameters: ConnectorsV2024ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2024ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public getConnectorTranslations(requestParameters: ConnectorsV2024ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2024ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public putConnectorCorrelationConfig(requestParameters: ConnectorsV2024ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2024ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public putConnectorSourceConfig(requestParameters: ConnectorsV2024ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2024ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public putConnectorSourceTemplate(requestParameters: ConnectorsV2024ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2024ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public putConnectorTranslations(requestParameters: ConnectorsV2024ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2024ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2024Api - */ - public updateConnector(requestParameters: ConnectorsV2024ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2024ApiFp(this.configuration).updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetConnectorLocaleV2024 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorLocaleV2024 = typeof GetConnectorLocaleV2024[keyof typeof GetConnectorLocaleV2024]; -/** - * @export - */ -export const GetConnectorListLocaleV2024 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorListLocaleV2024 = typeof GetConnectorListLocaleV2024[keyof typeof GetConnectorListLocaleV2024]; -/** - * @export - */ -export const GetConnectorTranslationsLocaleV2024 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorTranslationsLocaleV2024 = typeof GetConnectorTranslationsLocaleV2024[keyof typeof GetConnectorTranslationsLocaleV2024]; -/** - * @export - */ -export const PutConnectorTranslationsLocaleV2024 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type PutConnectorTranslationsLocaleV2024 = typeof PutConnectorTranslationsLocaleV2024[keyof typeof PutConnectorTranslationsLocaleV2024]; - - -/** - * CustomFormsV2024Api - axios parameter creator - * @export - */ -export const CustomFormsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2024} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition: async (body?: CreateFormDefinitionRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2024} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema: async (body?: FormDefinitionDynamicSchemaRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/forms-action-dynamic-schema`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest: async (formDefinitionID: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'formDefinitionID', formDefinitionID) - // verify required parameter 'file' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'file', file) - const localVarPath = `/form-definitions/{formDefinitionID}/upload` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2024} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance: async (body?: CreateFormInstanceRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('deleteFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3: async (formDefinitionID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFileFromS3', 'formDefinitionID', formDefinitionID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFileFromS3', 'fileID', fileID) - const localVarPath = `/form-definitions/{formDefinitionID}/file/{fileID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFormDefinitionByKey', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey: async (formInstanceID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceByKey', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile: async (formInstanceID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceFile', 'formInstanceID', formInstanceID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFormInstanceFile', 'fileID', fileID) - const localVarPath = `/form-instances/{formInstanceID}/file/{fileID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions: async (body?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition: async (formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('patchFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance: async (formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('patchFormInstance', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID: async (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formInstanceID', formInstanceID) - // verify required parameter 'formElementID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formElementID', formElementID) - const localVarPath = `/form-instances/{formInstanceID}/data-source/{formElementID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"formElementID"}}`, encodeURIComponent(String(formElementID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/predefined-select-options`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2024} [formElementPreviewRequestV2024] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource: async (formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2024?: FormElementPreviewRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('showPreviewDataSource', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}/data-source` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(formElementPreviewRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomFormsV2024Api - functional programming interface - * @export - */ -export const CustomFormsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomFormsV2024ApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2024} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinition(body?: CreateFormDefinitionRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinition(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.createFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2024} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionDynamicSchema(body?: FormDefinitionDynamicSchemaRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionDynamicSchema(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.createFormDefinitionDynamicSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionFileRequest(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionFileRequest(formDefinitionID, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.createFormDefinitionFileRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2024} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormInstance(body?: CreateFormInstanceRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormInstance(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.createFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteFormDefinition(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFormDefinition(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.deleteFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.exportFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFileFromS3(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFileFromS3(formDefinitionID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.getFileFromS3']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormDefinitionByKey(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormDefinitionByKey(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.getFormDefinitionByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceByKey(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceByKey(formInstanceID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.getFormInstanceByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceFile(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceFile(formInstanceID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.getFormInstanceFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importFormDefinitions(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importFormDefinitions(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.importFormDefinitions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormDefinition(formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormDefinition(formDefinitionID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.patchFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormInstance(formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormInstance(formInstanceID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.patchFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.searchFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormElementDataByElementID(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormElementDataByElementID(formInstanceID, formElementID, limit, filters, query, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.searchFormElementDataByElementID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPreDefinedSelectOptions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.searchPreDefinedSelectOptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2024} [formElementPreviewRequestV2024] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showPreviewDataSource(formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2024?: FormElementPreviewRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showPreviewDataSource(formDefinitionID, limit, filters, query, formElementPreviewRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2024Api.showPreviewDataSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomFormsV2024Api - factory interface - * @export - */ -export const CustomFormsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomFormsV2024ApiFp(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2024ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition(requestParameters: CustomFormsV2024ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest(requestParameters: CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2024ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance(requestParameters: CustomFormsV2024ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormInstance(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2024ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition(requestParameters: CustomFormsV2024ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2024ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant(requestParameters: CustomFormsV2024ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2024ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3(requestParameters: CustomFormsV2024ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2024ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey(requestParameters: CustomFormsV2024ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2024ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey(requestParameters: CustomFormsV2024ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2024ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile(requestParameters: CustomFormsV2024ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2024ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions(requestParameters: CustomFormsV2024ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2024ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition(requestParameters: CustomFormsV2024ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2024ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance(requestParameters: CustomFormsV2024ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant(requestParameters: CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2024ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID(requestParameters: CustomFormsV2024ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2024ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant(requestParameters: CustomFormsV2024ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchPreDefinedSelectOptions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2024ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource(requestParameters: CustomFormsV2024ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createFormDefinition operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiCreateFormDefinitionRequest - */ -export interface CustomFormsV2024ApiCreateFormDefinitionRequest { - /** - * Body is the request payload to create form definition request - * @type {CreateFormDefinitionRequestV2024} - * @memberof CustomFormsV2024ApiCreateFormDefinition - */ - readonly body?: CreateFormDefinitionRequestV2024 -} - -/** - * Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest - */ -export interface CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest { - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormDefinitionDynamicSchemaRequestV2024} - * @memberof CustomFormsV2024ApiCreateFormDefinitionDynamicSchema - */ - readonly body?: FormDefinitionDynamicSchemaRequestV2024 -} - -/** - * Request parameters for createFormDefinitionFileRequest operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest - */ -export interface CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest { - /** - * FormDefinitionID String specifying FormDefinitionID - * @type {string} - * @memberof CustomFormsV2024ApiCreateFormDefinitionFileRequest - */ - readonly formDefinitionID: string - - /** - * File specifying the multipart - * @type {File} - * @memberof CustomFormsV2024ApiCreateFormDefinitionFileRequest - */ - readonly file: File -} - -/** - * Request parameters for createFormInstance operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiCreateFormInstanceRequest - */ -export interface CustomFormsV2024ApiCreateFormInstanceRequest { - /** - * Body is the request payload to create a form instance - * @type {CreateFormInstanceRequestV2024} - * @memberof CustomFormsV2024ApiCreateFormInstance - */ - readonly body?: CreateFormInstanceRequestV2024 -} - -/** - * Request parameters for deleteFormDefinition operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiDeleteFormDefinitionRequest - */ -export interface CustomFormsV2024ApiDeleteFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2024ApiDeleteFormDefinition - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for exportFormDefinitionsByTenant operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiExportFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2024ApiExportFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2024ApiExportFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2024ApiExportFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2024ApiExportFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2024ApiExportFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for getFileFromS3 operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiGetFileFromS3Request - */ -export interface CustomFormsV2024ApiGetFileFromS3Request { - /** - * FormDefinitionID Form definition ID - * @type {string} - * @memberof CustomFormsV2024ApiGetFileFromS3 - */ - readonly formDefinitionID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2024ApiGetFileFromS3 - */ - readonly fileID: string -} - -/** - * Request parameters for getFormDefinitionByKey operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiGetFormDefinitionByKeyRequest - */ -export interface CustomFormsV2024ApiGetFormDefinitionByKeyRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2024ApiGetFormDefinitionByKey - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for getFormInstanceByKey operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiGetFormInstanceByKeyRequest - */ -export interface CustomFormsV2024ApiGetFormInstanceByKeyRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2024ApiGetFormInstanceByKey - */ - readonly formInstanceID: string -} - -/** - * Request parameters for getFormInstanceFile operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiGetFormInstanceFileRequest - */ -export interface CustomFormsV2024ApiGetFormInstanceFileRequest { - /** - * FormInstanceID Form instance ID - * @type {string} - * @memberof CustomFormsV2024ApiGetFormInstanceFile - */ - readonly formInstanceID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2024ApiGetFormInstanceFile - */ - readonly fileID: string -} - -/** - * Request parameters for importFormDefinitions operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiImportFormDefinitionsRequest - */ -export interface CustomFormsV2024ApiImportFormDefinitionsRequest { - /** - * Body is the request payload to import form definitions - * @type {Array} - * @memberof CustomFormsV2024ApiImportFormDefinitions - */ - readonly body?: Array -} - -/** - * Request parameters for patchFormDefinition operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiPatchFormDefinitionRequest - */ -export interface CustomFormsV2024ApiPatchFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2024ApiPatchFormDefinition - */ - readonly formDefinitionID: string - - /** - * Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2024ApiPatchFormDefinition - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for patchFormInstance operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiPatchFormInstanceRequest - */ -export interface CustomFormsV2024ApiPatchFormInstanceRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2024ApiPatchFormInstance - */ - readonly formInstanceID: string - - /** - * Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2024ApiPatchFormInstance - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for searchFormDefinitionsByTenant operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2024ApiSearchFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2024ApiSearchFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for searchFormElementDataByElementID operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiSearchFormElementDataByElementIDRequest - */ -export interface CustomFormsV2024ApiSearchFormElementDataByElementIDRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormElementDataByElementID - */ - readonly formInstanceID: string - - /** - * Form element ID - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormElementDataByElementID - */ - readonly formElementID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2024ApiSearchFormElementDataByElementID - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormElementDataByElementID - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormElementDataByElementID - */ - readonly query?: string -} - -/** - * Request parameters for searchFormInstancesByTenant operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiSearchFormInstancesByTenantRequest - */ -export interface CustomFormsV2024ApiSearchFormInstancesByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2024ApiSearchFormInstancesByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2024ApiSearchFormInstancesByTenant - */ - readonly limit?: number - - /** - * 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: **formDefinitionId**: *eq* - * @type {string} - * @memberof CustomFormsV2024ApiSearchFormInstancesByTenant - */ - readonly filters?: string -} - -/** - * Request parameters for showPreviewDataSource operation in CustomFormsV2024Api. - * @export - * @interface CustomFormsV2024ApiShowPreviewDataSourceRequest - */ -export interface CustomFormsV2024ApiShowPreviewDataSourceRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2024ApiShowPreviewDataSource - */ - readonly formDefinitionID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2024ApiShowPreviewDataSource - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2024ApiShowPreviewDataSource - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2024ApiShowPreviewDataSource - */ - readonly query?: string - - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormElementPreviewRequestV2024} - * @memberof CustomFormsV2024ApiShowPreviewDataSource - */ - readonly formElementPreviewRequestV2024?: FormElementPreviewRequestV2024 -} - -/** - * CustomFormsV2024Api - object-oriented interface - * @export - * @class CustomFormsV2024Api - * @extends {BaseAPI} - */ -export class CustomFormsV2024Api extends BaseAPI { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2024ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public createFormDefinition(requestParameters: CustomFormsV2024ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2024ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public createFormDefinitionFileRequest(requestParameters: CustomFormsV2024ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2024ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public createFormInstance(requestParameters: CustomFormsV2024ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).createFormInstance(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2024ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public deleteFormDefinition(requestParameters: CustomFormsV2024ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2024ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public exportFormDefinitionsByTenant(requestParameters: CustomFormsV2024ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2024ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public getFileFromS3(requestParameters: CustomFormsV2024ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2024ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public getFormDefinitionByKey(requestParameters: CustomFormsV2024ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2024ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public getFormInstanceByKey(requestParameters: CustomFormsV2024ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2024ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public getFormInstanceFile(requestParameters: CustomFormsV2024ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2024ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public importFormDefinitions(requestParameters: CustomFormsV2024ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2024ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public patchFormDefinition(requestParameters: CustomFormsV2024ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2024ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public patchFormInstance(requestParameters: CustomFormsV2024ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public searchFormDefinitionsByTenant(requestParameters: CustomFormsV2024ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2024ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public searchFormElementDataByElementID(requestParameters: CustomFormsV2024ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2024ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public searchFormInstancesByTenant(requestParameters: CustomFormsV2024ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).searchPreDefinedSelectOptions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2024ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2024Api - */ - public showPreviewDataSource(requestParameters: CustomFormsV2024ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2024ApiFp(this.configuration).showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CustomPasswordInstructionsV2024Api - axios parameter creator - * @export - */ -export const CustomPasswordInstructionsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2024} customPasswordInstructionV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions: async (customPasswordInstructionV2024: CustomPasswordInstructionV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'customPasswordInstructionV2024' is not null or undefined - assertParamExists('createCustomPasswordInstructions', 'customPasswordInstructionV2024', customPasswordInstructionV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(customPasswordInstructionV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2024} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions: async (pageId: DeleteCustomPasswordInstructionsPageIdV2024, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('deleteCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2024} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions: async (pageId: GetCustomPasswordInstructionsPageIdV2024, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('getCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomPasswordInstructionsV2024Api - functional programming interface - * @export - */ -export const CustomPasswordInstructionsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomPasswordInstructionsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2024} customPasswordInstructionV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPasswordInstructions(customPasswordInstructionV2024: CustomPasswordInstructionV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPasswordInstructions(customPasswordInstructionV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2024Api.createCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2024} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPasswordInstructions(pageId: DeleteCustomPasswordInstructionsPageIdV2024, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2024Api.deleteCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2024} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomPasswordInstructions(pageId: GetCustomPasswordInstructionsPageIdV2024, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2024Api.getCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomPasswordInstructionsV2024Api - factory interface - * @export - */ -export const CustomPasswordInstructionsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomPasswordInstructionsV2024ApiFp(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPasswordInstructions operation in CustomPasswordInstructionsV2024Api. - * @export - * @interface CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest { - /** - * - * @type {CustomPasswordInstructionV2024} - * @memberof CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructions - */ - readonly customPasswordInstructionV2024: CustomPasswordInstructionV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteCustomPasswordInstructions operation in CustomPasswordInstructionsV2024Api. - * @export - * @interface CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to delete. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructions - */ - readonly pageId: DeleteCustomPasswordInstructionsPageIdV2024 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCustomPasswordInstructions operation in CustomPasswordInstructionsV2024Api. - * @export - * @interface CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to query. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructions - */ - readonly pageId: GetCustomPasswordInstructionsPageIdV2024 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * CustomPasswordInstructionsV2024Api - object-oriented interface - * @export - * @class CustomPasswordInstructionsV2024Api - * @extends {BaseAPI} - */ -export class CustomPasswordInstructionsV2024Api extends BaseAPI { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2024Api - */ - public createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2024ApiFp(this.configuration).createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2024Api - */ - public deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2024ApiFp(this.configuration).deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2024Api - */ - public getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2024ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2024ApiFp(this.configuration).getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteCustomPasswordInstructionsPageIdV2024 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type DeleteCustomPasswordInstructionsPageIdV2024 = typeof DeleteCustomPasswordInstructionsPageIdV2024[keyof typeof DeleteCustomPasswordInstructionsPageIdV2024]; -/** - * @export - */ -export const GetCustomPasswordInstructionsPageIdV2024 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type GetCustomPasswordInstructionsPageIdV2024 = typeof GetCustomPasswordInstructionsPageIdV2024[keyof typeof GetCustomPasswordInstructionsPageIdV2024]; - - -/** - * DataSegmentationV2024Api - axios parameter creator - * @export - */ -export const DataSegmentationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2024} dataSegmentV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment: async (dataSegmentV2024: DataSegmentV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'dataSegmentV2024' is not null or undefined - assertParamExists('createDataSegment', 'dataSegmentV2024', dataSegmentV2024) - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dataSegmentV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment: async (id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentIdentityMembership', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/membership/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentationEnabledForUser', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/user-enabled/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments: async (enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (enabled !== undefined) { - localVarQueryParameter['enabled'] = enabled; - } - - if (unique !== undefined) { - localVarQueryParameter['unique'] = unique; - } - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchDataSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment: async (requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('publishDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (publishAll !== undefined) { - localVarQueryParameter['publishAll'] = publishAll; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DataSegmentationV2024Api - functional programming interface - * @export - */ -export const DataSegmentationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DataSegmentationV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2024} dataSegmentV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDataSegment(dataSegmentV2024: DataSegmentV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDataSegment(dataSegmentV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.createDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDataSegment(id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDataSegment(id, published, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.deleteDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegment(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegment(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.getDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentIdentityMembership(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentIdentityMembership(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.getDataSegmentIdentityMembership']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentationEnabledForUser(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentationEnabledForUser(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.getDataSegmentationEnabledForUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDataSegments(enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDataSegments(enabled, unique, published, limit, offset, count, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.listDataSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDataSegment(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDataSegment(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.patchDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async publishDataSegment(requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishDataSegment(requestBody, publishAll, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2024Api.publishDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DataSegmentationV2024Api - factory interface - * @export - */ -export const DataSegmentationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DataSegmentationV2024ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2024ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment(requestParameters: DataSegmentationV2024ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDataSegment(requestParameters.dataSegmentV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2024ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment(requestParameters: DataSegmentationV2024ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2024ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment(requestParameters: DataSegmentationV2024ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2024ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments(requestParameters: DataSegmentationV2024ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2024ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment(requestParameters: DataSegmentationV2024ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2024ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment(requestParameters: DataSegmentationV2024ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDataSegment operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiCreateDataSegmentRequest - */ -export interface DataSegmentationV2024ApiCreateDataSegmentRequest { - /** - * - * @type {DataSegmentV2024} - * @memberof DataSegmentationV2024ApiCreateDataSegment - */ - readonly dataSegmentV2024: DataSegmentV2024 -} - -/** - * Request parameters for deleteDataSegment operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiDeleteDataSegmentRequest - */ -export interface DataSegmentationV2024ApiDeleteDataSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof DataSegmentationV2024ApiDeleteDataSegment - */ - readonly id: string - - /** - * This determines which version of the segment to delete - * @type {boolean} - * @memberof DataSegmentationV2024ApiDeleteDataSegment - */ - readonly published?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiDeleteDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegment operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiGetDataSegmentRequest - */ -export interface DataSegmentationV2024ApiGetDataSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegment - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentIdentityMembership operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest - */ -export interface DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest { - /** - * The identity ID to retrieve the segments they are in. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegmentIdentityMembership - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegmentIdentityMembership - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentationEnabledForUser operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest - */ -export interface DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest { - /** - * The identity ID to retrieve if segmentation is enabled for the identity. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegmentationEnabledForUser - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiGetDataSegmentationEnabledForUser - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listDataSegments operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiListDataSegmentsRequest - */ -export interface DataSegmentationV2024ApiListDataSegmentsRequest { - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly enabled?: boolean - - /** - * This returns only one record if set to true and that would be the published record if exists. - * @type {boolean} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly unique?: boolean - - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @type {boolean} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly published?: boolean - - /** - * 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 DataSegmentationV2024ApiListDataSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - 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, in, sw* **name**: *eq, in, sw* - * @type {string} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiListDataSegments - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchDataSegment operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiPatchDataSegmentRequest - */ -export interface DataSegmentationV2024ApiPatchDataSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof DataSegmentationV2024ApiPatchDataSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @type {Array} - * @memberof DataSegmentationV2024ApiPatchDataSegment - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiPatchDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for publishDataSegment operation in DataSegmentationV2024Api. - * @export - * @interface DataSegmentationV2024ApiPublishDataSegmentRequest - */ -export interface DataSegmentationV2024ApiPublishDataSegmentRequest { - /** - * A list of segment ids that you wish to publish - * @type {Array} - * @memberof DataSegmentationV2024ApiPublishDataSegment - */ - readonly requestBody: Array - - /** - * This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @type {boolean} - * @memberof DataSegmentationV2024ApiPublishDataSegment - */ - readonly publishAll?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2024ApiPublishDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * DataSegmentationV2024Api - object-oriented interface - * @export - * @class DataSegmentationV2024Api - * @extends {BaseAPI} - */ -export class DataSegmentationV2024Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2024ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public createDataSegment(requestParameters: DataSegmentationV2024ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).createDataSegment(requestParameters.dataSegmentV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2024ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public deleteDataSegment(requestParameters: DataSegmentationV2024ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2024ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public getDataSegment(requestParameters: DataSegmentationV2024ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2024ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2024ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2024ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public listDataSegments(requestParameters: DataSegmentationV2024ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2024ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public patchDataSegment(requestParameters: DataSegmentationV2024ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2024ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2024Api - */ - public publishDataSegment(requestParameters: DataSegmentationV2024ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2024ApiFp(this.configuration).publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DimensionsV2024Api - axios parameter creator - * @export - */ -export const DimensionsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2024} dimensionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension: async (roleId: string, dimensionV2024: DimensionV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('createDimension', 'roleId', roleId) - // verify required parameter 'dimensionV2024' is not null or undefined - assertParamExists('createDimension', 'dimensionV2024', dimensionV2024) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2024} dimensionBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions: async (roleId: string, dimensionBulkDeleteRequestV2024: DimensionBulkDeleteRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteBulkDimensions', 'roleId', roleId) - // verify required parameter 'dimensionBulkDeleteRequestV2024' is not null or undefined - assertParamExists('deleteBulkDimensions', 'dimensionBulkDeleteRequestV2024', dimensionBulkDeleteRequestV2024) - const localVarPath = `/roles/{roleId}/dimensions/bulk-delete` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionBulkDeleteRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('deleteDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/entitlements` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions: async (roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensions', 'roleId', roleId) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension: async (roleId: string, dimensionId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('patchDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('patchDimension', 'dimensionId', dimensionId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchDimension', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DimensionsV2024Api - functional programming interface - * @export - */ -export const DimensionsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DimensionsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2024} dimensionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDimension(roleId: string, dimensionV2024: DimensionV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDimension(roleId, dimensionV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.createDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2024} dimensionBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkDimensions(roleId: string, dimensionBulkDeleteRequestV2024: DimensionBulkDeleteRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkDimensions(roleId, dimensionBulkDeleteRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.deleteBulkDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.deleteDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.getDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimensionEntitlements(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimensionEntitlements(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.getDimensionEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensionAccessProfiles(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensionAccessProfiles(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.listDimensionAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensions(roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensions(roleId, forSubadmin, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.listDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDimension(roleId: string, dimensionId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDimension(roleId, dimensionId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2024Api.patchDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DimensionsV2024Api - factory interface - * @export - */ -export const DimensionsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DimensionsV2024ApiFp(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2024ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension(requestParameters: DimensionsV2024ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDimension(requestParameters.roleId, requestParameters.dimensionV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2024ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions(requestParameters: DimensionsV2024ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2024ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension(requestParameters: DimensionsV2024ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2024ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension(requestParameters: DimensionsV2024ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2024ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements(requestParameters: DimensionsV2024ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2024ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles(requestParameters: DimensionsV2024ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2024ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions(requestParameters: DimensionsV2024ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2024ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension(requestParameters: DimensionsV2024ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDimension operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiCreateDimensionRequest - */ -export interface DimensionsV2024ApiCreateDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiCreateDimension - */ - readonly roleId: string - - /** - * - * @type {DimensionV2024} - * @memberof DimensionsV2024ApiCreateDimension - */ - readonly dimensionV2024: DimensionV2024 -} - -/** - * Request parameters for deleteBulkDimensions operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiDeleteBulkDimensionsRequest - */ -export interface DimensionsV2024ApiDeleteBulkDimensionsRequest { - /** - * Parent Role Id of the dimensions. - * @type {string} - * @memberof DimensionsV2024ApiDeleteBulkDimensions - */ - readonly roleId: string - - /** - * - * @type {DimensionBulkDeleteRequestV2024} - * @memberof DimensionsV2024ApiDeleteBulkDimensions - */ - readonly dimensionBulkDeleteRequestV2024: DimensionBulkDeleteRequestV2024 -} - -/** - * Request parameters for deleteDimension operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiDeleteDimensionRequest - */ -export interface DimensionsV2024ApiDeleteDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiDeleteDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2024ApiDeleteDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimension operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiGetDimensionRequest - */ -export interface DimensionsV2024ApiGetDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiGetDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2024ApiGetDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimensionEntitlements operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiGetDimensionEntitlementsRequest - */ -export interface DimensionsV2024ApiGetDimensionEntitlementsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof DimensionsV2024ApiGetDimensionEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensionAccessProfiles operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiListDimensionAccessProfilesRequest - */ -export interface DimensionsV2024ApiListDimensionAccessProfilesRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2024ApiListDimensionAccessProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensions operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiListDimensionsRequest - */ -export interface DimensionsV2024ApiListDimensionsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiListDimensions - */ - readonly roleId: string - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof DimensionsV2024ApiListDimensions - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiListDimensions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2024ApiListDimensions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2024ApiListDimensions - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2024ApiListDimensions - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2024ApiListDimensions - */ - readonly sorters?: string -} - -/** - * Request parameters for patchDimension operation in DimensionsV2024Api. - * @export - * @interface DimensionsV2024ApiPatchDimensionRequest - */ -export interface DimensionsV2024ApiPatchDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2024ApiPatchDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2024ApiPatchDimension - */ - readonly dimensionId: string - - /** - * - * @type {Array} - * @memberof DimensionsV2024ApiPatchDimension - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * DimensionsV2024Api - object-oriented interface - * @export - * @class DimensionsV2024Api - * @extends {BaseAPI} - */ -export class DimensionsV2024Api extends BaseAPI { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2024ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public createDimension(requestParameters: DimensionsV2024ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).createDimension(requestParameters.roleId, requestParameters.dimensionV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2024ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public deleteBulkDimensions(requestParameters: DimensionsV2024ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2024ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public deleteDimension(requestParameters: DimensionsV2024ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2024ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public getDimension(requestParameters: DimensionsV2024ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2024ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public getDimensionEntitlements(requestParameters: DimensionsV2024ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2024ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public listDimensionAccessProfiles(requestParameters: DimensionsV2024ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2024ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public listDimensions(requestParameters: DimensionsV2024ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2024ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2024Api - */ - public patchDimension(requestParameters: DimensionsV2024ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2024ApiFp(this.configuration).patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * EntitlementsV2024Api - axios parameter creator - * @export - */ -export const EntitlementsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementRequestConfig', 'id', id) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource: async (id: string, csvFile?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsBySource', 'id', id) - const localVarPath = `/entitlements/aggregate/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (csvFile !== undefined) { - localVarFormParams.append('csvFile', csvFile as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementChildren', 'id', id) - const localVarPath = `/entitlements/{id}/children` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementParents', 'id', id) - const localVarPath = `/entitlements/{id}/parents` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements: async (accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accountId !== undefined) { - localVarQueryParameter['account-id'] = accountId; - } - - if (segmentedForIdentity !== undefined) { - localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement: async (id: string, jsonPatchOperationV2024?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2024} entitlementRequestConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig: async (id: string, entitlementRequestConfigV2024: EntitlementRequestConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'id', id) - // verify required parameter 'entitlementRequestConfigV2024' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'entitlementRequestConfigV2024', entitlementRequestConfigV2024) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementRequestConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('resetSourceEntitlements', 'id', id) - const localVarPath = `/entitlements/reset/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2024} entitlementBulkUpdateRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk: async (entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementBulkUpdateRequestV2024' is not null or undefined - assertParamExists('updateEntitlementsInBulk', 'entitlementBulkUpdateRequestV2024', entitlementBulkUpdateRequestV2024) - const localVarPath = `/entitlements/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementBulkUpdateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * EntitlementsV2024Api - functional programming interface - * @export - */ -export const EntitlementsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = EntitlementsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataForEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.createAccessModelMetadataForEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessModelMetadataFromEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.deleteAccessModelMetadataFromEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlement(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.getEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementRequestConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementRequestConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.getEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async importEntitlementsBySource(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsBySource(id, csvFile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.importEntitlementsBySource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildren(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.listEntitlementChildren']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParents(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.listEntitlementParents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlements(accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlements(accountId, segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.listEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlement(id: string, jsonPatchOperationV2024?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlement(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.patchEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2024} entitlementRequestConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putEntitlementRequestConfig(id: string, entitlementRequestConfigV2024: EntitlementRequestConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putEntitlementRequestConfig(id, entitlementRequestConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.putEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetSourceEntitlements(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetSourceEntitlements(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.resetSourceEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2024} entitlementBulkUpdateRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsInBulk(entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulk(entitlementBulkUpdateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2024Api.updateEntitlementsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * EntitlementsV2024Api - factory interface - * @export - */ -export const EntitlementsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = EntitlementsV2024ApiFp(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2024ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement(requestParameters: EntitlementsV2024ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlement(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2024ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig(requestParameters: EntitlementsV2024ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2024ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource(requestParameters: EntitlementsV2024ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2024ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren(requestParameters: EntitlementsV2024ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2024ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents(requestParameters: EntitlementsV2024ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2024ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements(requestParameters: EntitlementsV2024ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2024ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement(requestParameters: EntitlementsV2024ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2024ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig(requestParameters: EntitlementsV2024ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2024ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements(requestParameters: EntitlementsV2024ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2024ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk(requestParameters: EntitlementsV2024ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataForEntitlement operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest - */ -export interface EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2024ApiCreateAccessModelMetadataForEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2024ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2024ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest - */ -export interface EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for getEntitlement operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiGetEntitlementRequest - */ -export interface EntitlementsV2024ApiGetEntitlementRequest { - /** - * The entitlement ID - * @type {string} - * @memberof EntitlementsV2024ApiGetEntitlement - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementRequestConfig operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiGetEntitlementRequestConfigRequest - */ -export interface EntitlementsV2024ApiGetEntitlementRequestConfigRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2024ApiGetEntitlementRequestConfig - */ - readonly id: string -} - -/** - * Request parameters for importEntitlementsBySource operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiImportEntitlementsBySourceRequest - */ -export interface EntitlementsV2024ApiImportEntitlementsBySourceRequest { - /** - * Source Id - * @type {string} - * @memberof EntitlementsV2024ApiImportEntitlementsBySource - */ - readonly id: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof EntitlementsV2024ApiImportEntitlementsBySource - */ - readonly csvFile?: File -} - -/** - * Request parameters for listEntitlementChildren operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiListEntitlementChildrenRequest - */ -export interface EntitlementsV2024ApiListEntitlementChildrenRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementChildren - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlementParents operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiListEntitlementParentsRequest - */ -export interface EntitlementsV2024ApiListEntitlementParentsRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlementParents - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlements operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiListEntitlementsRequest - */ -export interface EntitlementsV2024ApiListEntitlementsRequest { - /** - * The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly accountId?: string - - /** - * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly segmentedForIdentity?: string - - /** - * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @type {boolean} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly includeUnsegmented?: boolean - - /** - * 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 EntitlementsV2024ApiListEntitlements - */ - 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 EntitlementsV2024ApiListEntitlements - */ - 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 EntitlementsV2024ApiListEntitlements - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof EntitlementsV2024ApiListEntitlements - */ - readonly filters?: string -} - -/** - * Request parameters for patchEntitlement operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiPatchEntitlementRequest - */ -export interface EntitlementsV2024ApiPatchEntitlementRequest { - /** - * ID of the entitlement to patch - * @type {string} - * @memberof EntitlementsV2024ApiPatchEntitlement - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof EntitlementsV2024ApiPatchEntitlement - */ - readonly jsonPatchOperationV2024?: Array -} - -/** - * Request parameters for putEntitlementRequestConfig operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiPutEntitlementRequestConfigRequest - */ -export interface EntitlementsV2024ApiPutEntitlementRequestConfigRequest { - /** - * Entitlement ID - * @type {string} - * @memberof EntitlementsV2024ApiPutEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {EntitlementRequestConfigV2024} - * @memberof EntitlementsV2024ApiPutEntitlementRequestConfig - */ - readonly entitlementRequestConfigV2024: EntitlementRequestConfigV2024 -} - -/** - * Request parameters for resetSourceEntitlements operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiResetSourceEntitlementsRequest - */ -export interface EntitlementsV2024ApiResetSourceEntitlementsRequest { - /** - * ID of source for the entitlement reset - * @type {string} - * @memberof EntitlementsV2024ApiResetSourceEntitlements - */ - readonly id: string -} - -/** - * Request parameters for updateEntitlementsInBulk operation in EntitlementsV2024Api. - * @export - * @interface EntitlementsV2024ApiUpdateEntitlementsInBulkRequest - */ -export interface EntitlementsV2024ApiUpdateEntitlementsInBulkRequest { - /** - * - * @type {EntitlementBulkUpdateRequestV2024} - * @memberof EntitlementsV2024ApiUpdateEntitlementsInBulk - */ - readonly entitlementBulkUpdateRequestV2024: EntitlementBulkUpdateRequestV2024 -} - -/** - * EntitlementsV2024Api - object-oriented interface - * @export - * @class EntitlementsV2024Api - * @extends {BaseAPI} - */ -export class EntitlementsV2024Api extends BaseAPI { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2024ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2024ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2024ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public getEntitlement(requestParameters: EntitlementsV2024ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).getEntitlement(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2024ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public getEntitlementRequestConfig(requestParameters: EntitlementsV2024ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2024ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public importEntitlementsBySource(requestParameters: EntitlementsV2024ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2024ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public listEntitlementChildren(requestParameters: EntitlementsV2024ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2024ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public listEntitlementParents(requestParameters: EntitlementsV2024ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2024ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public listEntitlements(requestParameters: EntitlementsV2024ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2024ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public patchEntitlement(requestParameters: EntitlementsV2024ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2024ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public putEntitlementRequestConfig(requestParameters: EntitlementsV2024ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2024ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public resetSourceEntitlements(requestParameters: EntitlementsV2024ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2024ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2024Api - */ - public updateEntitlementsInBulk(requestParameters: EntitlementsV2024ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2024ApiFp(this.configuration).updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GlobalTenantSecuritySettingsV2024Api - axios parameter creator - * @export - */ -export const GlobalTenantSecuritySettingsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2024} networkConfigurationV2024 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig: async (networkConfigurationV2024: NetworkConfigurationV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'networkConfigurationV2024' is not null or undefined - assertParamExists('createAuthOrgNetworkConfig', 'networkConfigurationV2024', networkConfigurationV2024) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(networkConfigurationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig: async (jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAuthOrgLockoutConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2024 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig: async (jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAuthOrgNetworkConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig: async (jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAuthOrgServiceProviderConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig: async (jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchAuthOrgSessionConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2024Api - functional programming interface - * @export - */ -export const GlobalTenantSecuritySettingsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GlobalTenantSecuritySettingsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2024} networkConfigurationV2024 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAuthOrgNetworkConfig(networkConfigurationV2024: NetworkConfigurationV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAuthOrgNetworkConfig(networkConfigurationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.createAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgLockoutConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.getAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgNetworkConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.getAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgServiceProviderConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.getAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgSessionConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.getAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgLockoutConfig(jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgLockoutConfig(jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.patchAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2024 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgNetworkConfig(jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgNetworkConfig(jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.patchAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgServiceProviderConfig(jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgServiceProviderConfig(jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.patchAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2024 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgSessionConfig(jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgSessionConfig(jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2024Api.patchAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2024Api - factory interface - * @export - */ -export const GlobalTenantSecuritySettingsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GlobalTenantSecuritySettingsV2024ApiFp(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgLockoutConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgNetworkConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgSessionConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2024Api. - * @export - * @interface GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest { - /** - * Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {NetworkConfigurationV2024} - * @memberof GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfig - */ - readonly networkConfigurationV2024: NetworkConfigurationV2024 -} - -/** - * Request parameters for patchAuthOrgLockoutConfig operation in GlobalTenantSecuritySettingsV2024Api. - * @export - * @interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest { - /** - * A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfig - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2024Api. - * @export - * @interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest { - /** - * A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfig - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for patchAuthOrgServiceProviderConfig operation in GlobalTenantSecuritySettingsV2024Api. - * @export - * @interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest { - /** - * A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfig - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for patchAuthOrgSessionConfig operation in GlobalTenantSecuritySettingsV2024Api. - * @export - * @interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest { - /** - * A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfig - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * GlobalTenantSecuritySettingsV2024Api - object-oriented interface - * @export - * @class GlobalTenantSecuritySettingsV2024Api - * @extends {BaseAPI} - */ -export class GlobalTenantSecuritySettingsV2024Api extends BaseAPI { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).getAuthOrgLockoutConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).getAuthOrgNetworkConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).getAuthOrgSessionConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2024Api - */ - public patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2024ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2024ApiFp(this.configuration).patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GovernanceGroupsV2024Api - axios parameter creator - * @export - */ -export const GovernanceGroupsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2024} workgroupDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup: async (workgroupDtoV2024: WorkgroupDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupDtoV2024' is not null or undefined - assertParamExists('createWorkgroup', 'workgroupDtoV2024', workgroupDtoV2024) - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2024 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2024' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'identityPreviewResponseIdentityV2024', identityPreviewResponseIdentityV2024) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-delete` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2024} workgroupBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk: async (workgroupBulkDeleteRequestV2024: WorkgroupBulkDeleteRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupBulkDeleteRequestV2024' is not null or undefined - assertParamExists('deleteWorkgroupsInBulk', 'workgroupBulkDeleteRequestV2024', workgroupBulkDeleteRequestV2024) - const localVarPath = `/workgroups/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupBulkDeleteRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listConnections', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/connections` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listWorkgroupMembers', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/members` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup: async (id: string, jsonPatchOperationV2024?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2024 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2024' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'identityPreviewResponseIdentityV2024', identityPreviewResponseIdentityV2024) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-add` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GovernanceGroupsV2024Api - functional programming interface - * @export - */ -export const GovernanceGroupsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GovernanceGroupsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2024} workgroupDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkgroup(workgroupDtoV2024: WorkgroupDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkgroup(workgroupDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.createWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.deleteWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2024 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.deleteWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2024} workgroupBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2024: WorkgroupBulkDeleteRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.deleteWorkgroupsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.getWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnections(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.listConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroupMembers(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupMembers(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.listWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroups(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroups(offset, limit, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.listWorkgroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkgroup(id: string, jsonPatchOperationV2024?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkgroup(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.patchWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2024 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2024Api.updateWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GovernanceGroupsV2024Api - factory interface - * @export - */ -export const GovernanceGroupsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GovernanceGroupsV2024ApiFp(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2024ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup(requestParameters: GovernanceGroupsV2024ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkgroup(requestParameters.workgroupDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2024ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup(requestParameters: GovernanceGroupsV2024ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2024ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections(requestParameters: GovernanceGroupsV2024ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2024ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2024ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups(requestParameters: GovernanceGroupsV2024ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2024ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup(requestParameters: GovernanceGroupsV2024ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createWorkgroup operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiCreateWorkgroupRequest - */ -export interface GovernanceGroupsV2024ApiCreateWorkgroupRequest { - /** - * - * @type {WorkgroupDtoV2024} - * @memberof GovernanceGroupsV2024ApiCreateWorkgroup - */ - readonly workgroupDtoV2024: WorkgroupDtoV2024 -} - -/** - * Request parameters for deleteWorkgroup operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiDeleteWorkgroupRequest - */ -export interface GovernanceGroupsV2024ApiDeleteWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2024ApiDeleteWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkgroupMembers operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2024ApiDeleteWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be removed from a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2024ApiDeleteWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2024: Array -} - -/** - * Request parameters for deleteWorkgroupsInBulk operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest - */ -export interface GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest { - /** - * - * @type {WorkgroupBulkDeleteRequestV2024} - * @memberof GovernanceGroupsV2024ApiDeleteWorkgroupsInBulk - */ - readonly workgroupBulkDeleteRequestV2024: WorkgroupBulkDeleteRequestV2024 -} - -/** - * Request parameters for getWorkgroup operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiGetWorkgroupRequest - */ -export interface GovernanceGroupsV2024ApiGetWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2024ApiGetWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for listConnections operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiListConnectionsRequest - */ -export interface GovernanceGroupsV2024ApiListConnectionsRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2024ApiListConnections - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2024ApiListConnections - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2024ApiListConnections - */ - 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 GovernanceGroupsV2024ApiListConnections - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2024ApiListConnections - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroupMembers operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiListWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2024ApiListWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2024ApiListWorkgroupMembers - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2024ApiListWorkgroupMembers - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2024ApiListWorkgroupMembers - */ - 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 GovernanceGroupsV2024ApiListWorkgroupMembers - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2024ApiListWorkgroupMembers - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroups operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiListWorkgroupsRequest - */ -export interface GovernanceGroupsV2024ApiListWorkgroupsRequest { - /** - * 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 GovernanceGroupsV2024ApiListWorkgroups - */ - 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 GovernanceGroupsV2024ApiListWorkgroups - */ - 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 GovernanceGroupsV2024ApiListWorkgroups - */ - 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @type {string} - * @memberof GovernanceGroupsV2024ApiListWorkgroups - */ - 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: **name, created, modified, id, description** - * @type {string} - * @memberof GovernanceGroupsV2024ApiListWorkgroups - */ - readonly sorters?: string -} - -/** - * Request parameters for patchWorkgroup operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiPatchWorkgroupRequest - */ -export interface GovernanceGroupsV2024ApiPatchWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2024ApiPatchWorkgroup - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof GovernanceGroupsV2024ApiPatchWorkgroup - */ - readonly jsonPatchOperationV2024?: Array -} - -/** - * Request parameters for updateWorkgroupMembers operation in GovernanceGroupsV2024Api. - * @export - * @interface GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2024ApiUpdateWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be added to a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2024ApiUpdateWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2024: Array -} - -/** - * GovernanceGroupsV2024Api - object-oriented interface - * @export - * @class GovernanceGroupsV2024Api - * @extends {BaseAPI} - */ -export class GovernanceGroupsV2024Api extends BaseAPI { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2024ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public createWorkgroup(requestParameters: GovernanceGroupsV2024ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).createWorkgroup(requestParameters.workgroupDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public deleteWorkgroup(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2024ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2024ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public getWorkgroup(requestParameters: GovernanceGroupsV2024ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2024ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public listConnections(requestParameters: GovernanceGroupsV2024ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2024ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public listWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2024ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public listWorkgroups(requestParameters: GovernanceGroupsV2024ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2024ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public patchWorkgroup(requestParameters: GovernanceGroupsV2024ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2024Api - */ - public updateWorkgroupMembers(requestParameters: GovernanceGroupsV2024ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2024ApiFp(this.configuration).updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIAccessRequestRecommendationsV2024Api - axios parameter creator - * @export - */ -export const IAIAccessRequestRecommendationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem: async (accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2024' is not null or undefined - assertParamExists('addAccessRequestRecommendationsIgnoredItem', 'accessRequestRecommendationActionItemDtoV2024', accessRequestRecommendationActionItemDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem: async (accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2024' is not null or undefined - assertParamExists('addAccessRequestRecommendationsRequestedItem', 'accessRequestRecommendationActionItemDtoV2024', accessRequestRecommendationActionItemDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem: async (accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2024' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItem', 'accessRequestRecommendationActionItemDtoV2024', accessRequestRecommendationActionItemDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2024 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems: async (accessRequestRecommendationActionItemDtoV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2024' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItems', 'accessRequestRecommendationActionItemDtoV2024', accessRequestRecommendationActionItemDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items/bulk-create`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations: async (identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2024} accessRequestRecommendationConfigDtoV2024 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig: async (accessRequestRecommendationConfigDtoV2024: AccessRequestRecommendationConfigDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationConfigDtoV2024' is not null or undefined - assertParamExists('setAccessRequestRecommendationsConfig', 'accessRequestRecommendationConfigDtoV2024', accessRequestRecommendationConfigDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationConfigDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2024Api - functional programming interface - * @export - */ -export const IAIAccessRequestRecommendationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIAccessRequestRecommendationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.addAccessRequestRecommendationsIgnoredItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.addAccessRequestRecommendationsRequestedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2024} accessRequestRecommendationActionItemDtoV2024 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.addAccessRequestRecommendationsViewedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2024 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.addAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendations(identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendations(identityId, limit, offset, count, includeTranslationMessages, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.getAccessRequestRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.getAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsIgnoredItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsIgnoredItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.getAccessRequestRecommendationsIgnoredItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsRequestedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsRequestedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.getAccessRequestRecommendationsRequestedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsViewedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsViewedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.getAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2024} accessRequestRecommendationConfigDtoV2024 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2024: AccessRequestRecommendationConfigDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2024Api.setAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2024Api - factory interface - * @export - */ -export const IAIAccessRequestRecommendationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIAccessRequestRecommendationsV2024ApiFp(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for addAccessRequestRecommendationsIgnoredItem operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest { - /** - * The recommended access item to ignore for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2024} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsRequestedItem operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest { - /** - * The recommended access item that was requested for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2024} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItem operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest { - /** - * The recommended access that was viewed for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2024} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItem - */ - readonly accessRequestRecommendationActionItemDtoV2024: AccessRequestRecommendationActionItemDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest { - /** - * The recommended access items that were viewed for an identity. - * @type {Array} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItems - */ - readonly accessRequestRecommendationActionItemDtoV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendations operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest { - /** - * Get access request recommendations for an identityId. *me* indicates the current user. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly identityId?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly count?: boolean - - /** - * If *true* it will populate a list of translation messages in the response. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly includeTranslationMessages?: 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsIgnoredItems operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsRequestedItems operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2024Api. - * @export - * @interface IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest { - /** - * The desired configurations for Access Request Recommender for the tenant. - * @type {AccessRequestRecommendationConfigDtoV2024} - * @memberof IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfig - */ - readonly accessRequestRecommendationConfigDtoV2024: AccessRequestRecommendationConfigDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIAccessRequestRecommendationsV2024Api - object-oriented interface - * @export - * @class IAIAccessRequestRecommendationsV2024Api - * @extends {BaseAPI} - */ -export class IAIAccessRequestRecommendationsV2024Api extends BaseAPI { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2024ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2024Api - */ - public setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2024ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2024ApiFp(this.configuration).setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAICommonAccessV2024Api - axios parameter creator - * @export - */ -export const IAICommonAccessV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2024} commonAccessItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess: async (commonAccessItemRequestV2024: CommonAccessItemRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessItemRequestV2024' is not null or undefined - assertParamExists('createCommonAccess', 'commonAccessItemRequestV2024', commonAccessItemRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessItemRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2024 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk: async (commonAccessIDStatusV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessIDStatusV2024' is not null or undefined - assertParamExists('updateCommonAccessStatusInBulk', 'commonAccessIDStatusV2024', commonAccessIDStatusV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access/update-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessIDStatusV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAICommonAccessV2024Api - functional programming interface - * @export - */ -export const IAICommonAccessV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAICommonAccessV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2024} commonAccessItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCommonAccess(commonAccessItemRequestV2024: CommonAccessItemRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCommonAccess(commonAccessItemRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2024Api.createCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCommonAccess(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCommonAccess(offset, limit, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2024Api.getCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2024 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCommonAccessStatusInBulk(commonAccessIDStatusV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommonAccessStatusInBulk(commonAccessIDStatusV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2024Api.updateCommonAccessStatusInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAICommonAccessV2024Api - factory interface - * @export - */ -export const IAICommonAccessV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAICommonAccessV2024ApiFp(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2024ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess(requestParameters: IAICommonAccessV2024ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCommonAccess(requestParameters.commonAccessItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2024ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess(requestParameters: IAICommonAccessV2024ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCommonAccess operation in IAICommonAccessV2024Api. - * @export - * @interface IAICommonAccessV2024ApiCreateCommonAccessRequest - */ -export interface IAICommonAccessV2024ApiCreateCommonAccessRequest { - /** - * - * @type {CommonAccessItemRequestV2024} - * @memberof IAICommonAccessV2024ApiCreateCommonAccess - */ - readonly commonAccessItemRequestV2024: CommonAccessItemRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2024ApiCreateCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCommonAccess operation in IAICommonAccessV2024Api. - * @export - * @interface IAICommonAccessV2024ApiGetCommonAccessRequest - */ -export interface IAICommonAccessV2024ApiGetCommonAccessRequest { - /** - * 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 IAICommonAccessV2024ApiGetCommonAccess - */ - 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 IAICommonAccessV2024ApiGetCommonAccess - */ - 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 IAICommonAccessV2024ApiGetCommonAccess - */ - 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @type {string} - * @memberof IAICommonAccessV2024ApiGetCommonAccess - */ - 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: **access.name, status** By default the common access items are sorted by name, ascending. - * @type {string} - * @memberof IAICommonAccessV2024ApiGetCommonAccess - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2024ApiGetCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateCommonAccessStatusInBulk operation in IAICommonAccessV2024Api. - * @export - * @interface IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest - */ -export interface IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest { - /** - * Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @type {Array} - * @memberof IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulk - */ - readonly commonAccessIDStatusV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * IAICommonAccessV2024Api - object-oriented interface - * @export - * @class IAICommonAccessV2024Api - * @extends {BaseAPI} - */ -export class IAICommonAccessV2024Api extends BaseAPI { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2024ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2024Api - */ - public createCommonAccess(requestParameters: IAICommonAccessV2024ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2024ApiFp(this.configuration).createCommonAccess(requestParameters.commonAccessItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2024ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2024Api - */ - public getCommonAccess(requestParameters: IAICommonAccessV2024ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2024ApiFp(this.configuration).getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2024Api - */ - public updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2024ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2024ApiFp(this.configuration).updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIOutliersV2024Api - axios parameter creator - * @export - */ -export const IAIOutliersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip: async (type?: ExportOutliersZipTypeV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2024, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2024, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots: async (type?: GetLatestIdentityOutlierSnapshotsTypeV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries/latest`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary: async (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierFeatureId' is not null or undefined - assertParamExists('getOutlierContributingFeatureSummary', 'outlierFeatureId', outlierFeatureId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-feature-summaries/{outlierFeatureId}` - .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('getPeerGroupOutliersContributingFeatures', 'outlierId', outlierId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/contributing-features` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('ignoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/ignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'outlierId', outlierId) - // verify required parameter 'contributingFeatureName' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'contributingFeatureName', contributingFeatureName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) - .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (accessType !== undefined) { - localVarQueryParameter['accessType'] = accessType; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('unIgnoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/unignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIOutliersV2024Api - functional programming interface - * @export - */ -export const IAIOutliersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIOutliersV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportOutliersZip(type?: ExportOutliersZipTypeV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZip(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.exportOutliersZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2024, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshots(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.getIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2024, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliers(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.getIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2024} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLatestIdentityOutlierSnapshots(type?: GetLatestIdentityOutlierSnapshotsTypeV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshots(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.getLatestIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummary(outlierFeatureId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.getOutlierContributingFeatureSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeatures(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.getPeerGroupOutliersContributingFeatures']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async ignoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.ignoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItems(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.listOutliersContributingFeatureAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unIgnoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2024Api.unIgnoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIOutliersV2024Api - factory interface - * @export - */ -export const IAIOutliersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIOutliersV2024ApiFp(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2024ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip(requestParameters: IAIOutliersV2024ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2024ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers(requestParameters: IAIOutliersV2024ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2024ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportOutliersZip operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiExportOutliersZipRequest - */ -export interface IAIOutliersV2024ApiExportOutliersZipRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2024ApiExportOutliersZip - */ - readonly type?: ExportOutliersZipTypeV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiExportOutliersZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutlierSnapshots operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest { - /** - * 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 IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - readonly offset?: number - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - readonly type?: GetIdentityOutlierSnapshotsTypeV2024 - - /** - * 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: **snapshotDate**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - 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: **snapshotDate** - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutliers operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiGetIdentityOutliersRequest - */ -export interface IAIOutliersV2024ApiGetIdentityOutliersRequest { - /** - * 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 IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly count?: boolean - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly type?: GetIdentityOutliersTypeV2024 - - /** - * 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - 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: **firstDetectionDate, attributes, score** - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiGetIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getLatestIdentityOutlierSnapshots operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshots - */ - readonly type?: GetLatestIdentityOutlierSnapshotsTypeV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getOutlierContributingFeatureSummary operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest - */ -export interface IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest { - /** - * Contributing feature id - * @type {string} - * @memberof IAIOutliersV2024ApiGetOutlierContributingFeatureSummary - */ - readonly outlierFeatureId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiGetOutlierContributingFeatureSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPeerGroupOutliersContributingFeatures operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest - */ -export interface IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly outlierId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly count?: boolean - - /** - * Whether or not to include translation messages object in returned response - * @type {string} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly includeTranslationMessages?: 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: **importance** - * @type {string} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeatures - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for ignoreIdentityOutliers operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2024ApiIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2024ApiIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOutliersContributingFeatureAccessItems operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest - */ -export interface IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly outlierId: string - - /** - * The name of contributing feature - * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024 - - /** - * 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 IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly count?: boolean - - /** - * The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @type {string} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly accessType?: 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: **displayName** - * @type {string} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiListOutliersContributingFeatureAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for unIgnoreIdentityOutliers operation in IAIOutliersV2024Api. - * @export - * @interface IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2024ApiUnIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2024ApiUnIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIOutliersV2024Api - object-oriented interface - * @export - * @class IAIOutliersV2024Api - * @extends {BaseAPI} - */ -export class IAIOutliersV2024Api extends BaseAPI { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2024ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public exportOutliersZip(requestParameters: IAIOutliersV2024ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2024ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2024ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public getIdentityOutliers(requestParameters: IAIOutliersV2024ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2024ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2024ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2024ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2024ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public ignoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2024ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2024Api - */ - public unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2024ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2024ApiFp(this.configuration).unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ExportOutliersZipTypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type ExportOutliersZipTypeV2024 = typeof ExportOutliersZipTypeV2024[keyof typeof ExportOutliersZipTypeV2024]; -/** - * @export - */ -export const GetIdentityOutlierSnapshotsTypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutlierSnapshotsTypeV2024 = typeof GetIdentityOutlierSnapshotsTypeV2024[keyof typeof GetIdentityOutlierSnapshotsTypeV2024]; -/** - * @export - */ -export const GetIdentityOutliersTypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutliersTypeV2024 = typeof GetIdentityOutliersTypeV2024[keyof typeof GetIdentityOutliersTypeV2024]; -/** - * @export - */ -export const GetLatestIdentityOutlierSnapshotsTypeV2024 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetLatestIdentityOutlierSnapshotsTypeV2024 = typeof GetLatestIdentityOutlierSnapshotsTypeV2024[keyof typeof GetLatestIdentityOutlierSnapshotsTypeV2024]; -/** - * @export - */ -export const ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024 = { - RadicalEntitlementCount: 'radical_entitlement_count', - EntitlementCount: 'entitlement_count', - MaxJaccardSimilarity: 'max_jaccard_similarity', - MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', - SingleEntitlementBundleCount: 'single_entitlement_bundle_count', - PeerlessScore: 'peerless_score' -} as const; -export type ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024 = typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024[keyof typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2024]; - - -/** - * IAIPeerGroupStrategiesV2024Api - axios parameter creator - * @export - */ -export const IAIPeerGroupStrategiesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2024} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers: async (strategy: GetPeerGroupOutliersStrategyV2024, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'strategy' is not null or undefined - assertParamExists('getPeerGroupOutliers', 'strategy', strategy) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/peer-group-strategies/{strategy}/identity-outliers` - .replace(`{${"strategy"}}`, encodeURIComponent(String(strategy))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2024Api - functional programming interface - * @export - */ -export const IAIPeerGroupStrategiesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIPeerGroupStrategiesV2024ApiAxiosParamCreator(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2024} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPeerGroupOutliers(strategy: GetPeerGroupOutliersStrategyV2024, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliers(strategy, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIPeerGroupStrategiesV2024Api.getPeerGroupOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2024Api - factory interface - * @export - */ -export const IAIPeerGroupStrategiesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIPeerGroupStrategiesV2024ApiFp(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPeerGroupOutliers operation in IAIPeerGroupStrategiesV2024Api. - * @export - * @interface IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest - */ -export interface IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest { - /** - * The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @type {'entitlement'} - * @memberof IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliers - */ - readonly strategy: GetPeerGroupOutliersStrategyV2024 - - /** - * 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 IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliers - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIPeerGroupStrategiesV2024Api - object-oriented interface - * @export - * @class IAIPeerGroupStrategiesV2024Api - * @extends {BaseAPI} - */ -export class IAIPeerGroupStrategiesV2024Api extends BaseAPI { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof IAIPeerGroupStrategiesV2024Api - */ - public getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2024ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIPeerGroupStrategiesV2024ApiFp(this.configuration).getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetPeerGroupOutliersStrategyV2024 = { - Entitlement: 'entitlement' -} as const; -export type GetPeerGroupOutliersStrategyV2024 = typeof GetPeerGroupOutliersStrategyV2024[keyof typeof GetPeerGroupOutliersStrategyV2024]; - - -/** - * IAIRecommendationsV2024Api - axios parameter creator - * @export - */ -export const IAIRecommendationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2024} recommendationRequestDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations: async (recommendationRequestDtoV2024: RecommendationRequestDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationRequestDtoV2024' is not null or undefined - assertParamExists('getRecommendations', 'recommendationRequestDtoV2024', recommendationRequestDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/request`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationRequestDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2024} recommendationConfigDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig: async (recommendationConfigDtoV2024: RecommendationConfigDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationConfigDtoV2024' is not null or undefined - assertParamExists('updateRecommendationsConfig', 'recommendationConfigDtoV2024', recommendationConfigDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationConfigDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRecommendationsV2024Api - functional programming interface - * @export - */ -export const IAIRecommendationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRecommendationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2024} recommendationRequestDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendations(recommendationRequestDtoV2024: RecommendationRequestDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendations(recommendationRequestDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2024Api.getRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2024Api.getRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2024} recommendationConfigDtoV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRecommendationsConfig(recommendationConfigDtoV2024: RecommendationConfigDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRecommendationsConfig(recommendationConfigDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2024Api.updateRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRecommendationsV2024Api - factory interface - * @export - */ -export const IAIRecommendationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRecommendationsV2024ApiFp(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2024ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations(requestParameters: IAIRecommendationsV2024ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendations(requestParameters.recommendationRequestDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2024ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig(requestParameters: IAIRecommendationsV2024ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig(requestParameters: IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getRecommendations operation in IAIRecommendationsV2024Api. - * @export - * @interface IAIRecommendationsV2024ApiGetRecommendationsRequest - */ -export interface IAIRecommendationsV2024ApiGetRecommendationsRequest { - /** - * - * @type {RecommendationRequestDtoV2024} - * @memberof IAIRecommendationsV2024ApiGetRecommendations - */ - readonly recommendationRequestDtoV2024: RecommendationRequestDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2024ApiGetRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRecommendationsConfig operation in IAIRecommendationsV2024Api. - * @export - * @interface IAIRecommendationsV2024ApiGetRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2024ApiGetRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2024ApiGetRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateRecommendationsConfig operation in IAIRecommendationsV2024Api. - * @export - * @interface IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest { - /** - * - * @type {RecommendationConfigDtoV2024} - * @memberof IAIRecommendationsV2024ApiUpdateRecommendationsConfig - */ - readonly recommendationConfigDtoV2024: RecommendationConfigDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2024ApiUpdateRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRecommendationsV2024Api - object-oriented interface - * @export - * @class IAIRecommendationsV2024Api - * @extends {BaseAPI} - */ -export class IAIRecommendationsV2024Api extends BaseAPI { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2024ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2024Api - */ - public getRecommendations(requestParameters: IAIRecommendationsV2024ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2024ApiFp(this.configuration).getRecommendations(requestParameters.recommendationRequestDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2024ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2024Api - */ - public getRecommendationsConfig(requestParameters: IAIRecommendationsV2024ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2024ApiFp(this.configuration).getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2024Api - */ - public updateRecommendationsConfig(requestParameters: IAIRecommendationsV2024ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2024ApiFp(this.configuration).updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIRoleMiningV2024Api - axios parameter creator - * @export - */ -export const IAIRoleMiningV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2024} [roleMiningPotentialRoleProvisionRequestV2024] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest: async (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2024?: RoleMiningPotentialRoleProvisionRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (minEntitlementPopularity !== undefined) { - localVarQueryParameter['min-entitlement-popularity'] = minEntitlementPopularity; - } - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['include-common-access'] = includeCommonAccess; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleProvisionRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2024} roleMiningSessionDtoV2024 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions: async (roleMiningSessionDtoV2024: RoleMiningSessionDtoV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMiningSessionDtoV2024' is not null or undefined - assertParamExists('createRoleMiningSessions', 'roleMiningSessionDtoV2024', roleMiningSessionDtoV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningSessionDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2024} [roleMiningPotentialRoleExportRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2024?: RoleMiningPotentialRoleExportRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleExportRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries: async (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage: async (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'potentialRoleId', potentialRoleId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'sourceId', sourceId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries: async (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleSummaries', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole: async (potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSession', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSessionStatus', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/status` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions: async (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles: async (sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/saved`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2024' is not null or undefined - assertParamExists('patchPotentialRole', 'jsonPatchOperationRoleMiningV2024', jsonPatchOperationRoleMiningV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2024' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'jsonPatchOperationRoleMiningV2024', jsonPatchOperationRoleMiningV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2024 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession: async (sessionId: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchRoleMiningSession', 'sessionId', sessionId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchRoleMiningSession', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2024} roleMiningPotentialRoleEditEntitlementsV2024 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2024: RoleMiningPotentialRoleEditEntitlementsV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'roleMiningPotentialRoleEditEntitlementsV2024' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'roleMiningPotentialRoleEditEntitlementsV2024', roleMiningPotentialRoleEditEntitlementsV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleEditEntitlementsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRoleMiningV2024Api - functional programming interface - * @export - */ -export const IAIRoleMiningV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRoleMiningV2024ApiAxiosParamCreator(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2024} [roleMiningPotentialRoleProvisionRequestV2024] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPotentialRoleProvisionRequest(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2024?: RoleMiningPotentialRoleProvisionRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPotentialRoleProvisionRequest(sessionId, potentialRoleId, minEntitlementPopularity, includeCommonAccess, xSailPointExperimental, roleMiningPotentialRoleProvisionRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.createPotentialRoleProvisionRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2024} roleMiningSessionDtoV2024 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRoleMiningSessions(roleMiningSessionDtoV2024: RoleMiningSessionDtoV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMiningSessions(roleMiningSessionDtoV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.createRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleMiningPotentialRoleZip(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleMiningPotentialRoleZip(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.downloadRoleMiningPotentialRoleZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.exportRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2024} [roleMiningPotentialRoleExportRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleAsync(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2024?: RoleMiningPotentialRoleExportRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleAsync(sessionId, potentialRoleId, xSailPointExperimental, roleMiningPotentialRoleExportRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.exportRoleMiningPotentialRoleAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleStatus(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleStatus(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.exportRoleMiningPotentialRoleStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAllPotentialRoleSummaries(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPotentialRoleSummaries(sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getAllPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDistributionPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDistributionPotentialRole(sessionId, potentialRoleId, includeCommonAccess, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getEntitlementDistributionPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsPotentialRole(sessionId, potentialRoleId, includeCommonAccess, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getExcludedEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getExcludedEntitlementsPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getExcludedEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitiesPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getIdentitiesPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleApplications(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleApplications(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getPotentialRoleApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleEntitlements(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleEntitlements(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getPotentialRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSourceIdentityUsage(potentialRoleId, sourceId, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getPotentialRoleSourceIdentityUsage']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSummaries(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSummaries(sessionId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningPotentialRole(potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningPotentialRole(potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSession(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSession(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessionStatus(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionStatus(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getRoleMiningSessionStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessions(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessions(filters, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedPotentialRoles(sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.getSavedPotentialRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRole(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRole(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.patchPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleSession(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.patchPotentialRoleSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2024 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRoleMiningSession(sessionId: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningSession(sessionId, jsonPatchOperationV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.patchRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2024} roleMiningPotentialRoleEditEntitlementsV2024 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2024: RoleMiningPotentialRoleEditEntitlementsV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsPotentialRole(sessionId, potentialRoleId, roleMiningPotentialRoleEditEntitlementsV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2024Api.updateEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRoleMiningV2024Api - factory interface - * @export - */ -export const IAIRoleMiningV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRoleMiningV2024ApiFp(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions(requestParameters: IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }> { - return localVarFp.getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2024ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles(requestParameters: IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2024ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole(requestParameters: IAIRoleMiningV2024ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession(requestParameters: IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession(requestParameters: IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPotentialRoleProvisionRequest operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest - */ -export interface IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly potentialRoleId: string - - /** - * Minimum popularity required for an entitlement to be included in the provisioned role. - * @type {number} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly minEntitlementPopularity?: number - - /** - * Boolean determining whether common access entitlements will be included in the provisioned role. - * @type {boolean} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly xSailPointExperimental?: string - - /** - * Required information to create a new role - * @type {RoleMiningPotentialRoleProvisionRequestV2024} - * @memberof IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequest - */ - readonly roleMiningPotentialRoleProvisionRequestV2024?: RoleMiningPotentialRoleProvisionRequestV2024 -} - -/** - * Request parameters for createRoleMiningSessions operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest { - /** - * Role mining session parameters - * @type {RoleMiningSessionDtoV2024} - * @memberof IAIRoleMiningV2024ApiCreateRoleMiningSessions - */ - readonly roleMiningSessionDtoV2024: RoleMiningSessionDtoV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiCreateRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleMiningPotentialRoleZip operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest - */ -export interface IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZip - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZip - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZip - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRoleAsync operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest - */ -export interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsync - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsync - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsync - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {RoleMiningPotentialRoleExportRequestV2024} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsync - */ - readonly roleMiningPotentialRoleExportRequestV2024?: RoleMiningPotentialRoleExportRequestV2024 -} - -/** - * Request parameters for exportRoleMiningPotentialRoleStatus operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest - */ -export interface IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatus - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatus - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatus - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAllPotentialRoleSummaries operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest { - /** - * 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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetAllPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementDistributionPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementsPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getExcludedEntitlementsPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly potentialRoleId: 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: **popularity** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitiesPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly potentialRoleId: 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: **name** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetIdentitiesPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleApplications operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest - */ -export interface IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - readonly potentialRoleId: 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: **applicationName**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleApplications - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleEntitlements operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest - */ -export interface IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - readonly potentialRoleId: 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: **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSourceIdentityUsage operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest - */ -export interface IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - readonly potentialRoleId: string - - /** - * A source id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sourceId: string - - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsage - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSummaries operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - readonly sessionId: 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: **createdDate** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSession operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2024ApiGetRoleMiningSessionRequest { - /** - * The role mining session id to be retrieved. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSession - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessionStatus operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest - */ -export interface IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSessionStatus - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSessionStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessions operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest { - /** - * 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: **saved**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - 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: **createdBy, createdDate** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSavedPotentialRoles operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest - */ -export interface IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest { - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetSavedPotentialRoles - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2024ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2024ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2024ApiGetSavedPotentialRoles - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiGetSavedPotentialRoles - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiPatchPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiPatchPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRole - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRole - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRole - */ - readonly jsonPatchOperationRoleMiningV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRoleSession operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest - */ -export interface IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRoleSession - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRoleSession - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRoleSession - */ - readonly jsonPatchOperationRoleMiningV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchPotentialRoleSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchRoleMiningSession operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest { - /** - * The role mining session id to be patched - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchRoleMiningSession - */ - readonly sessionId: string - - /** - * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @type {Array} - * @memberof IAIRoleMiningV2024ApiPatchRoleMiningSession - */ - readonly jsonPatchOperationV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiPatchRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateEntitlementsPotentialRole operation in IAIRoleMiningV2024Api. - * @export - * @interface IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Role mining session parameters - * @type {RoleMiningPotentialRoleEditEntitlementsV2024} - * @memberof IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRole - */ - readonly roleMiningPotentialRoleEditEntitlementsV2024: RoleMiningPotentialRoleEditEntitlementsV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRoleMiningV2024Api - object-oriented interface - * @export - * @class IAIRoleMiningV2024Api - * @extends {BaseAPI} - */ -export class IAIRoleMiningV2024Api extends BaseAPI { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2024ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public createRoleMiningSessions(requestParameters: IAIRoleMiningV2024ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2024ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2024ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2024ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2024ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getPotentialRoleApplications(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2024ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getRoleMiningSession(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getRoleMiningSessions(requestParameters: IAIRoleMiningV2024ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public getSavedPotentialRoles(requestParameters: IAIRoleMiningV2024ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2024ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public patchPotentialRole(requestParameters: IAIRoleMiningV2024ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public patchPotentialRoleSession(requestParameters: IAIRoleMiningV2024ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public patchRoleMiningSession(requestParameters: IAIRoleMiningV2024ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2024Api - */ - public updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2024ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2024ApiFp(this.configuration).updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IconsV2024Api - axios parameter creator - * @export - */ -export const IconsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2024} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon: async (objectType: DeleteIconObjectTypeV2024, objectId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('deleteIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('deleteIcon', 'objectId', objectId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2024} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon: async (objectType: SetIconObjectTypeV2024, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('setIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('setIcon', 'objectId', objectId) - // verify required parameter 'image' is not null or undefined - assertParamExists('setIcon', 'image', image) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (image !== undefined) { - localVarFormParams.append('image', image as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IconsV2024Api - functional programming interface - * @export - */ -export const IconsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IconsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2024} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIcon(objectType: DeleteIconObjectTypeV2024, objectId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIcon(objectType, objectId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2024Api.deleteIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2024} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setIcon(objectType: SetIconObjectTypeV2024, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setIcon(objectType, objectId, image, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2024Api.setIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IconsV2024Api - factory interface - * @export - */ -export const IconsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IconsV2024ApiFp(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2024ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon(requestParameters: IconsV2024ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2024ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon(requestParameters: IconsV2024ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIcon operation in IconsV2024Api. - * @export - * @interface IconsV2024ApiDeleteIconRequest - */ -export interface IconsV2024ApiDeleteIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2024ApiDeleteIcon - */ - readonly objectType: DeleteIconObjectTypeV2024 - - /** - * Object id. - * @type {string} - * @memberof IconsV2024ApiDeleteIcon - */ - readonly objectId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2024ApiDeleteIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setIcon operation in IconsV2024Api. - * @export - * @interface IconsV2024ApiSetIconRequest - */ -export interface IconsV2024ApiSetIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2024ApiSetIcon - */ - readonly objectType: SetIconObjectTypeV2024 - - /** - * Object id. - * @type {string} - * @memberof IconsV2024ApiSetIcon - */ - readonly objectId: string - - /** - * file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @type {File} - * @memberof IconsV2024ApiSetIcon - */ - readonly image: File - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2024ApiSetIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * IconsV2024Api - object-oriented interface - * @export - * @class IconsV2024Api - * @extends {BaseAPI} - */ -export class IconsV2024Api extends BaseAPI { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2024ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2024Api - */ - public deleteIcon(requestParameters: IconsV2024ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2024ApiFp(this.configuration).deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2024ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2024Api - */ - public setIcon(requestParameters: IconsV2024ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2024ApiFp(this.configuration).setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteIconObjectTypeV2024 = { - Application: 'application' -} as const; -export type DeleteIconObjectTypeV2024 = typeof DeleteIconObjectTypeV2024[keyof typeof DeleteIconObjectTypeV2024]; -/** - * @export - */ -export const SetIconObjectTypeV2024 = { - Application: 'application' -} as const; -export type SetIconObjectTypeV2024 = typeof SetIconObjectTypeV2024[keyof typeof SetIconObjectTypeV2024]; - - -/** - * IdentitiesV2024Api - axios parameter creator - * @export - */ -export const IdentitiesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getIdentityOwnershipDetails', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/ownership` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignment', 'identityId', identityId) - // verify required parameter 'assignmentId' is not null or undefined - assertParamExists('getRoleAssignment', 'assignmentId', assignmentId) - const localVarPath = `/identities/{identityId}/role-assignments/{assignmentId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignments', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/role-assignments` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (roleId !== undefined) { - localVarQueryParameter['roleId'] = roleId; - } - - if (roleName !== undefined) { - localVarQueryParameter['roleName'] = roleName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementsByIdentity', 'id', id) - const localVarPath = `/entitlements/identities/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2024} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2024, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (defaultFilter !== undefined) { - localVarQueryParameter['defaultFilter'] = defaultFilter; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('resetIdentity', 'identityId', identityId) - const localVarPath = `/identities/{id}/reset` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2024} sendAccountVerificationRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken: async (id: string, sendAccountVerificationRequestV2024: SendAccountVerificationRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'id', id) - // verify required parameter 'sendAccountVerificationRequestV2024' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'sendAccountVerificationRequestV2024', sendAccountVerificationRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{id}/verification/account/send` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendAccountVerificationRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2024} inviteIdentitiesRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite: async (inviteIdentitiesRequestV2024: InviteIdentitiesRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'inviteIdentitiesRequestV2024' is not null or undefined - assertParamExists('startIdentitiesInvite', 'inviteIdentitiesRequestV2024', inviteIdentitiesRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/invite`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(inviteIdentitiesRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2024} processIdentitiesRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing: async (processIdentitiesRequestV2024: ProcessIdentitiesRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'processIdentitiesRequestV2024' is not null or undefined - assertParamExists('startIdentityProcessing', 'processIdentitiesRequestV2024', processIdentitiesRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/process`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(processIdentitiesRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('synchronizeAttributesForIdentity', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{identityId}/synchronize-attributes` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentitiesV2024Api - functional programming interface - * @export - */ -export const IdentitiesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentitiesV2024ApiAxiosParamCreator(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.deleteIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.getIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOwnershipDetails(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetails(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.getIdentityOwnershipDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignment(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignment(identityId, assignmentId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.getRoleAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignments(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignments(identityId, roleId, roleName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.getRoleAssignments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementsByIdentity(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByIdentity(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.listEntitlementsByIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2024} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentities(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2024, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentities(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.listIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetIdentity(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentity(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.resetIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2024} sendAccountVerificationRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestV2024: SendAccountVerificationRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountToken(id, sendAccountVerificationRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.sendIdentityVerificationAccountToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2024} inviteIdentitiesRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentitiesInvite(inviteIdentitiesRequestV2024: InviteIdentitiesRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInvite(inviteIdentitiesRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.startIdentitiesInvite']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2024} processIdentitiesRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentityProcessing(processIdentitiesRequestV2024: ProcessIdentitiesRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessing(processIdentitiesRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.startIdentityProcessing']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async synchronizeAttributesForIdentity(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentity(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2024Api.synchronizeAttributesForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentitiesV2024Api - factory interface - * @export - */ -export const IdentitiesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentitiesV2024ApiFp(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2024ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity(requestParameters: IdentitiesV2024ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2024ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity(requestParameters: IdentitiesV2024ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails(requestParameters: IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Role assignment details - * @param {IdentitiesV2024ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment(requestParameters: IdentitiesV2024ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2024ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments(requestParameters: IdentitiesV2024ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2024ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity(requestParameters: IdentitiesV2024ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2024ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities(requestParameters: IdentitiesV2024ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2024ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity(requestParameters: IdentitiesV2024ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2024ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite(requestParameters: IdentitiesV2024ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2024ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing(requestParameters: IdentitiesV2024ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentityProcessing(requestParameters.processIdentitiesRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity(requestParameters: IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIdentity operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiDeleteIdentityRequest - */ -export interface IdentitiesV2024ApiDeleteIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2024ApiDeleteIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentity operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiGetIdentityRequest - */ -export interface IdentitiesV2024ApiGetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2024ApiGetIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentityOwnershipDetails operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest - */ -export interface IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest { - /** - * Identity ID. - * @type {string} - * @memberof IdentitiesV2024ApiGetIdentityOwnershipDetails - */ - readonly identityId: string -} - -/** - * Request parameters for getRoleAssignment operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiGetRoleAssignmentRequest - */ -export interface IdentitiesV2024ApiGetRoleAssignmentRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2024ApiGetRoleAssignment - */ - readonly identityId: string - - /** - * Assignment Id - * @type {string} - * @memberof IdentitiesV2024ApiGetRoleAssignment - */ - readonly assignmentId: string -} - -/** - * Request parameters for getRoleAssignments operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiGetRoleAssignmentsRequest - */ -export interface IdentitiesV2024ApiGetRoleAssignmentsRequest { - /** - * Identity Id to get the role assignments for - * @type {string} - * @memberof IdentitiesV2024ApiGetRoleAssignments - */ - readonly identityId: string - - /** - * Role Id to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2024ApiGetRoleAssignments - */ - readonly roleId?: string - - /** - * Role name to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2024ApiGetRoleAssignments - */ - readonly roleName?: string -} - -/** - * Request parameters for listEntitlementsByIdentity operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiListEntitlementsByIdentityRequest - */ -export interface IdentitiesV2024ApiListEntitlementsByIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2024ApiListEntitlementsByIdentity - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2024ApiListEntitlementsByIdentity - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2024ApiListEntitlementsByIdentity - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentitiesV2024ApiListEntitlementsByIdentity - */ - readonly count?: boolean -} - -/** - * Request parameters for listIdentities operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiListIdentitiesRequest - */ -export interface IdentitiesV2024ApiListIdentitiesRequest { - /** - * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @type {string} - * @memberof IdentitiesV2024ApiListIdentities - */ - 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: **name, alias, cloudStatus** - * @type {string} - * @memberof IdentitiesV2024ApiListIdentities - */ - readonly sorters?: string - - /** - * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @type {'CORRELATED_ONLY' | 'NONE'} - * @memberof IdentitiesV2024ApiListIdentities - */ - readonly defaultFilter?: ListIdentitiesDefaultFilterV2024 - - /** - * 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 IdentitiesV2024ApiListIdentities - */ - readonly count?: boolean - - /** - * 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 IdentitiesV2024ApiListIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2024ApiListIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for resetIdentity operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiResetIdentityRequest - */ -export interface IdentitiesV2024ApiResetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2024ApiResetIdentity - */ - readonly identityId: string -} - -/** - * Request parameters for sendIdentityVerificationAccountToken operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest - */ -export interface IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest { - /** - * Identity ID - * @type {string} - * @memberof IdentitiesV2024ApiSendIdentityVerificationAccountToken - */ - readonly id: string - - /** - * - * @type {SendAccountVerificationRequestV2024} - * @memberof IdentitiesV2024ApiSendIdentityVerificationAccountToken - */ - readonly sendAccountVerificationRequestV2024: SendAccountVerificationRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2024ApiSendIdentityVerificationAccountToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentitiesInvite operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiStartIdentitiesInviteRequest - */ -export interface IdentitiesV2024ApiStartIdentitiesInviteRequest { - /** - * - * @type {InviteIdentitiesRequestV2024} - * @memberof IdentitiesV2024ApiStartIdentitiesInvite - */ - readonly inviteIdentitiesRequestV2024: InviteIdentitiesRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2024ApiStartIdentitiesInvite - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentityProcessing operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiStartIdentityProcessingRequest - */ -export interface IdentitiesV2024ApiStartIdentityProcessingRequest { - /** - * - * @type {ProcessIdentitiesRequestV2024} - * @memberof IdentitiesV2024ApiStartIdentityProcessing - */ - readonly processIdentitiesRequestV2024: ProcessIdentitiesRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2024ApiStartIdentityProcessing - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for synchronizeAttributesForIdentity operation in IdentitiesV2024Api. - * @export - * @interface IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest - */ -export interface IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest { - /** - * The Identity id - * @type {string} - * @memberof IdentitiesV2024ApiSynchronizeAttributesForIdentity - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2024ApiSynchronizeAttributesForIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentitiesV2024Api - object-oriented interface - * @export - * @class IdentitiesV2024Api - * @extends {BaseAPI} - */ -export class IdentitiesV2024Api extends BaseAPI { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2024ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public deleteIdentity(requestParameters: IdentitiesV2024ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).deleteIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2024ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public getIdentity(requestParameters: IdentitiesV2024ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).getIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public getIdentityOwnershipDetails(requestParameters: IdentitiesV2024ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Role assignment details - * @param {IdentitiesV2024ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public getRoleAssignment(requestParameters: IdentitiesV2024ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2024ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public getRoleAssignments(requestParameters: IdentitiesV2024ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2024ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public listEntitlementsByIdentity(requestParameters: IdentitiesV2024ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2024ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public listIdentities(requestParameters: IdentitiesV2024ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2024ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public resetIdentity(requestParameters: IdentitiesV2024ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2024ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2024ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public startIdentitiesInvite(requestParameters: IdentitiesV2024ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2024ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public startIdentityProcessing(requestParameters: IdentitiesV2024ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).startIdentityProcessing(requestParameters.processIdentitiesRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2024Api - */ - public synchronizeAttributesForIdentity(requestParameters: IdentitiesV2024ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2024ApiFp(this.configuration).synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListIdentitiesDefaultFilterV2024 = { - CorrelatedOnly: 'CORRELATED_ONLY', - None: 'NONE' -} as const; -export type ListIdentitiesDefaultFilterV2024 = typeof ListIdentitiesDefaultFilterV2024[keyof typeof ListIdentitiesDefaultFilterV2024]; - - -/** - * IdentityAttributesV2024Api - axios parameter creator - * @export - */ -export const IdentityAttributesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2024} identityAttributeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute: async (identityAttributeV2024: IdentityAttributeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeV2024' is not null or undefined - assertParamExists('createIdentityAttribute', 'identityAttributeV2024', identityAttributeV2024) - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2024} identityAttributeNamesV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk: async (identityAttributeNamesV2024: IdentityAttributeNamesV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeNamesV2024' is not null or undefined - assertParamExists('deleteIdentityAttributesInBulk', 'identityAttributeNamesV2024', identityAttributeNamesV2024) - const localVarPath = `/identity-attributes/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeNamesV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes: async (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeSystem !== undefined) { - localVarQueryParameter['includeSystem'] = includeSystem; - } - - if (includeSilent !== undefined) { - localVarQueryParameter['includeSilent'] = includeSilent; - } - - if (searchableOnly !== undefined) { - localVarQueryParameter['searchableOnly'] = searchableOnly; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2024} identityAttributeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute: async (name: string, identityAttributeV2024: IdentityAttributeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('putIdentityAttribute', 'name', name) - // verify required parameter 'identityAttributeV2024' is not null or undefined - assertParamExists('putIdentityAttribute', 'identityAttributeV2024', identityAttributeV2024) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityAttributesV2024Api - functional programming interface - * @export - */ -export const IdentityAttributesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityAttributesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2024} identityAttributeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityAttribute(identityAttributeV2024: IdentityAttributeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityAttribute(identityAttributeV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.createIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.deleteIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2024} identityAttributeNamesV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttributesInBulk(identityAttributeNamesV2024: IdentityAttributeNamesV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributesInBulk(identityAttributeNamesV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.deleteIdentityAttributesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.getIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAttributes(includeSystem, includeSilent, searchableOnly, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.listIdentityAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2024} identityAttributeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putIdentityAttribute(name: string, identityAttributeV2024: IdentityAttributeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityAttribute(name, identityAttributeV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2024Api.putIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityAttributesV2024Api - factory interface - * @export - */ -export const IdentityAttributesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityAttributesV2024ApiFp(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2024ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute(requestParameters: IdentityAttributesV2024ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityAttribute(requestParameters.identityAttributeV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2024ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute(requestParameters: IdentityAttributesV2024ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2024ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute(requestParameters: IdentityAttributesV2024ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2024ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes(requestParameters: IdentityAttributesV2024ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2024ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute(requestParameters: IdentityAttributesV2024ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityAttribute operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiCreateIdentityAttributeRequest - */ -export interface IdentityAttributesV2024ApiCreateIdentityAttributeRequest { - /** - * - * @type {IdentityAttributeV2024} - * @memberof IdentityAttributesV2024ApiCreateIdentityAttribute - */ - readonly identityAttributeV2024: IdentityAttributeV2024 -} - -/** - * Request parameters for deleteIdentityAttribute operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiDeleteIdentityAttributeRequest - */ -export interface IdentityAttributesV2024ApiDeleteIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2024ApiDeleteIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for deleteIdentityAttributesInBulk operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest - */ -export interface IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest { - /** - * - * @type {IdentityAttributeNamesV2024} - * @memberof IdentityAttributesV2024ApiDeleteIdentityAttributesInBulk - */ - readonly identityAttributeNamesV2024: IdentityAttributeNamesV2024 -} - -/** - * Request parameters for getIdentityAttribute operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiGetIdentityAttributeRequest - */ -export interface IdentityAttributesV2024ApiGetIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2024ApiGetIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for listIdentityAttributes operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiListIdentityAttributesRequest - */ -export interface IdentityAttributesV2024ApiListIdentityAttributesRequest { - /** - * Include \'system\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2024ApiListIdentityAttributes - */ - readonly includeSystem?: boolean - - /** - * Include \'silent\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2024ApiListIdentityAttributes - */ - readonly includeSilent?: boolean - - /** - * Include only \'searchable\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2024ApiListIdentityAttributes - */ - readonly searchableOnly?: boolean - - /** - * 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 IdentityAttributesV2024ApiListIdentityAttributes - */ - readonly count?: boolean -} - -/** - * Request parameters for putIdentityAttribute operation in IdentityAttributesV2024Api. - * @export - * @interface IdentityAttributesV2024ApiPutIdentityAttributeRequest - */ -export interface IdentityAttributesV2024ApiPutIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2024ApiPutIdentityAttribute - */ - readonly name: string - - /** - * - * @type {IdentityAttributeV2024} - * @memberof IdentityAttributesV2024ApiPutIdentityAttribute - */ - readonly identityAttributeV2024: IdentityAttributeV2024 -} - -/** - * IdentityAttributesV2024Api - object-oriented interface - * @export - * @class IdentityAttributesV2024Api - * @extends {BaseAPI} - */ -export class IdentityAttributesV2024Api extends BaseAPI { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2024ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public createIdentityAttribute(requestParameters: IdentityAttributesV2024ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).createIdentityAttribute(requestParameters.identityAttributeV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2024ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public deleteIdentityAttribute(requestParameters: IdentityAttributesV2024ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2024ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2024ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public getIdentityAttribute(requestParameters: IdentityAttributesV2024ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2024ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public listIdentityAttributes(requestParameters: IdentityAttributesV2024ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2024ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2024Api - */ - public putIdentityAttribute(requestParameters: IdentityAttributesV2024ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2024ApiFp(this.configuration).putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IdentityHistoryV2024Api - axios parameter creator - * @export - */ -export const IdentityHistoryV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2024} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2024, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'id', id) - // verify required parameter 'accessType' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'accessType', accessType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare/{access-type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accessAssociated !== undefined) { - localVarQueryParameter['access-associated'] = accessAssociated; - } - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentityEvents', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/events` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (from !== undefined) { - localVarQueryParameter['from'] = from; - } - - if (eventTypes) { - localVarQueryParameter['eventTypes'] = eventTypes.join(COLLECTION_FORMATS.csv); - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot: async (id: string, date: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshot', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('getIdentitySnapshot', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2024} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2024, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshotSummary', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshot-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (before !== undefined) { - localVarQueryParameter['before'] = before; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (timeZone !== undefined) { - localVarQueryParameter['time-zone'] = timeZone; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityStartDate', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/start-date` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (startsWithQuery !== undefined) { - localVarQueryParameter['starts-with-query'] = startsWithQuery; - } - - if (isDeleted !== undefined) { - localVarQueryParameter['is-deleted'] = isDeleted; - } - - if (isActive !== undefined) { - localVarQueryParameter['is-active'] = isActive; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2024} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems: async (id: string, type?: ListIdentityAccessItemsTypeV2024, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessItems', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/access-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems: async (id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}/access-items` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2024} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots: async (id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2024, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityHistoryV2024Api - functional programming interface - * @export - */ -export const IdentityHistoryV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityHistoryV2024ApiAxiosParamCreator(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshots(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshots(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.compareIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2024} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshotsAccessType(id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2024, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessType(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.compareIdentitySnapshotsAccessType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.getHistoricalIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentityEvents(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEvents(id, from, eventTypes, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.getHistoricalIdentityEvents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshot(id: string, date: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshot(id, date, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.getIdentitySnapshot']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2024} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshotSummary(id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2024, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummary(id, before, interval, timeZone, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.getIdentitySnapshotSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityStartDate(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDate(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.getIdentityStartDate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentities(startsWithQuery, isDeleted, isActive, limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.listHistoricalIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2024} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessItems(id: string, type?: ListIdentityAccessItemsTypeV2024, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, xSailPointExperimental, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.listIdentityAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshotAccessItems(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItems(id, date, type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.listIdentitySnapshotAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2024} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshots(id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2024, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshots(id, start, interval, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2024Api.listIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityHistoryV2024Api - factory interface - * @export - */ -export const IdentityHistoryV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityHistoryV2024ApiFp(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots(requestParameters: IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2024ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2024ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot(requestParameters: IdentityHistoryV2024ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2024ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate(requestParameters: IdentityHistoryV2024ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2024ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities(requestParameters: IdentityHistoryV2024ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2024ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2024ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for compareIdentitySnapshots operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly id: string - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly snapshot2?: string - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for compareIdentitySnapshotsAccessType operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest - */ -export interface IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly id: string - - /** - * The specific type which needs to be compared - * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2024 - - /** - * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @type {boolean} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly accessAssociated?: boolean - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot2?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessType - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentity operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiGetHistoricalIdentityRequest - */ -export interface IdentityHistoryV2024ApiGetHistoricalIdentityRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentityEvents operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest - */ -export interface IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly id: string - - /** - * The optional instant until which access events are returned - * @type {string} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly from?: string - - /** - * An optional list of event types to return. If null or empty, all events are returned - * @type {Array} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly eventTypes?: Array - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiGetHistoricalIdentityEvents - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshot operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiGetIdentitySnapshotRequest - */ -export interface IdentityHistoryV2024ApiGetIdentitySnapshotRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshot - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshot - */ - readonly date: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshot - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshotSummary operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest - */ -export interface IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly id: string - - /** - * The date before which snapshot summary is required - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly before?: string - - /** - * The interval indicating day or month. Defaults to month if not specified - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly interval?: GetIdentitySnapshotSummaryIntervalV2024 - - /** - * The time zone. Defaults to UTC if not provided - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly timeZone?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentitySnapshotSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityStartDate operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiGetIdentityStartDateRequest - */ -export interface IdentityHistoryV2024ApiGetIdentityStartDateRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentityStartDate - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiGetIdentityStartDate - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listHistoricalIdentities operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiListHistoricalIdentitiesRequest - */ -export interface IdentityHistoryV2024ApiListHistoricalIdentitiesRequest { - /** - * This param is used for starts-with search for first, last and display name of the identity - * @type {string} - * @memberof IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly startsWithQuery?: string - - /** - * Indicates if we want to only list down deleted identities or not. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly isDeleted?: boolean - - /** - * Indicates if we want to only list active or inactive identities. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly isActive?: boolean - - /** - * 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 IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiListHistoricalIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentityAccessItems operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiListIdentityAccessItemsRequest - */ -export interface IdentityHistoryV2024ApiListIdentityAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentityAccessItems - */ - readonly id: string - - /** - * The type of access item for the identity. If not provided, it defaults to account - * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} - * @memberof IdentityHistoryV2024ApiListIdentityAccessItems - */ - readonly type?: ListIdentityAccessItemsTypeV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentityAccessItems - */ - readonly xSailPointExperimental?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiListIdentityAccessItems - */ - 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 IdentityHistoryV2024ApiListIdentityAccessItems - */ - readonly count?: boolean - - /** - * 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 IdentityHistoryV2024ApiListIdentityAccessItems - */ - readonly offset?: number -} - -/** - * Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest - */ -export interface IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshotAccessItems - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshotAccessItems - */ - readonly date: string - - /** - * The access item type - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshotAccessItems - */ - readonly type?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshotAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentitySnapshots operation in IdentityHistoryV2024Api. - * @export - * @interface IdentityHistoryV2024ApiListIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2024ApiListIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly id: string - - /** - * The specified start date - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly start?: string - - /** - * The interval indicating the range in day or month for the specified interval-name - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly interval?: ListIdentitySnapshotsIntervalV2024 - - /** - * 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 IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2024ApiListIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentityHistoryV2024Api - object-oriented interface - * @export - * @class IdentityHistoryV2024Api - * @extends {BaseAPI} - */ -export class IdentityHistoryV2024Api extends BaseAPI { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public compareIdentitySnapshots(requestParameters: IdentityHistoryV2024ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2024ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2024ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public getHistoricalIdentity(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2024ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2024ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public getIdentitySnapshot(requestParameters: IdentityHistoryV2024ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2024ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2024ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public getIdentityStartDate(requestParameters: IdentityHistoryV2024ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2024ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public listHistoricalIdentities(requestParameters: IdentityHistoryV2024ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2024ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public listIdentityAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2024ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2024Api - */ - public listIdentitySnapshots(requestParameters: IdentityHistoryV2024ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2024ApiFp(this.configuration).listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const CompareIdentitySnapshotsAccessTypeAccessTypeV2024 = { - AccessProfile: 'accessProfile', - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role' -} as const; -export type CompareIdentitySnapshotsAccessTypeAccessTypeV2024 = typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2024[keyof typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2024]; -/** - * @export - */ -export const GetIdentitySnapshotSummaryIntervalV2024 = { - Day: 'day', - Month: 'month' -} as const; -export type GetIdentitySnapshotSummaryIntervalV2024 = typeof GetIdentitySnapshotSummaryIntervalV2024[keyof typeof GetIdentitySnapshotSummaryIntervalV2024]; -/** - * @export - */ -export const ListIdentityAccessItemsTypeV2024 = { - Account: 'account', - Entitlement: 'entitlement', - App: 'app', - AccessProfile: 'accessProfile', - Role: 'role' -} as const; -export type ListIdentityAccessItemsTypeV2024 = typeof ListIdentityAccessItemsTypeV2024[keyof typeof ListIdentityAccessItemsTypeV2024]; -/** - * @export - */ -export const ListIdentitySnapshotsIntervalV2024 = { - Day: 'day', - Month: 'month' -} as const; -export type ListIdentitySnapshotsIntervalV2024 = typeof ListIdentitySnapshotsIntervalV2024[keyof typeof ListIdentitySnapshotsIntervalV2024]; - - -/** - * IdentityProfilesV2024Api - axios parameter creator - * @export - */ -export const IdentityProfilesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2024} identityProfileV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile: async (identityProfileV2024: IdentityProfileV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileV2024' is not null or undefined - assertParamExists('createIdentityProfile', 'identityProfileV2024', identityProfileV2024) - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteIdentityProfiles', 'requestBody', requestBody) - const localVarPath = `/identity-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2024} identityPreviewRequestV2024 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview: async (identityPreviewRequestV2024: IdentityPreviewRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityPreviewRequestV2024' is not null or undefined - assertParamExists('generateIdentityPreview', 'identityPreviewRequestV2024', identityPreviewRequestV2024) - const localVarPath = `/identity-profiles/identity-preview`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2024 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles: async (identityProfileExportedObjectV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileExportedObjectV2024' is not null or undefined - assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectV2024', identityProfileExportedObjectV2024) - const localVarPath = `/identity-profiles/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('syncIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/process-identities` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2024 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile: async (identityProfileId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateIdentityProfile', 'identityProfileId', identityProfileId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateIdentityProfile', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityProfilesV2024Api - functional programming interface - * @export - */ -export const IdentityProfilesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityProfilesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2024} identityProfileV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityProfile(identityProfileV2024: IdentityProfileV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfile(identityProfileV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.createIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.deleteIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfiles(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfiles(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.deleteIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.exportIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2024} identityPreviewRequestV2024 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async generateIdentityPreview(identityPreviewRequestV2024: IdentityPreviewRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreview(identityPreviewRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.generateIdentityPreview']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.getDefaultIdentityAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.getIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2024 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importIdentityProfiles(identityProfileExportedObjectV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfiles(identityProfileExportedObjectV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.importIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.listIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.syncIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2024 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateIdentityProfile(identityProfileId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfile(identityProfileId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2024Api.updateIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityProfilesV2024Api - factory interface - * @export - */ -export const IdentityProfilesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityProfilesV2024ApiFp(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2024ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile(requestParameters: IdentityProfilesV2024ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityProfile(requestParameters.identityProfileV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2024ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile(requestParameters: IdentityProfilesV2024ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2024ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles(requestParameters: IdentityProfilesV2024ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2024ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles(requestParameters: IdentityProfilesV2024ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2024ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview(requestParameters: IdentityProfilesV2024ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.generateIdentityPreview(requestParameters.identityPreviewRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2024ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile(requestParameters: IdentityProfilesV2024ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2024ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles(requestParameters: IdentityProfilesV2024ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importIdentityProfiles(requestParameters.identityProfileExportedObjectV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2024ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles(requestParameters: IdentityProfilesV2024ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2024ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile(requestParameters: IdentityProfilesV2024ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2024ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile(requestParameters: IdentityProfilesV2024ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityProfile operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiCreateIdentityProfileRequest - */ -export interface IdentityProfilesV2024ApiCreateIdentityProfileRequest { - /** - * - * @type {IdentityProfileV2024} - * @memberof IdentityProfilesV2024ApiCreateIdentityProfile - */ - readonly identityProfileV2024: IdentityProfileV2024 -} - -/** - * Request parameters for deleteIdentityProfile operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiDeleteIdentityProfileRequest - */ -export interface IdentityProfilesV2024ApiDeleteIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2024ApiDeleteIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for deleteIdentityProfiles operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiDeleteIdentityProfilesRequest - */ -export interface IdentityProfilesV2024ApiDeleteIdentityProfilesRequest { - /** - * Identity Profile bulk delete request body. - * @type {Array} - * @memberof IdentityProfilesV2024ApiDeleteIdentityProfiles - */ - readonly requestBody: Array -} - -/** - * Request parameters for exportIdentityProfiles operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiExportIdentityProfilesRequest - */ -export interface IdentityProfilesV2024ApiExportIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2024ApiExportIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2024ApiExportIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2024ApiExportIdentityProfiles - */ - 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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2024ApiExportIdentityProfiles - */ - 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, name, priority** - * @type {string} - * @memberof IdentityProfilesV2024ApiExportIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for generateIdentityPreview operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiGenerateIdentityPreviewRequest - */ -export interface IdentityProfilesV2024ApiGenerateIdentityPreviewRequest { - /** - * Identity Preview request body. - * @type {IdentityPreviewRequestV2024} - * @memberof IdentityProfilesV2024ApiGenerateIdentityPreview - */ - readonly identityPreviewRequestV2024: IdentityPreviewRequestV2024 -} - -/** - * Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest - */ -export interface IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest { - /** - * The Identity Profile ID. - * @type {string} - * @memberof IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfig - */ - readonly identityProfileId: string -} - -/** - * Request parameters for getIdentityProfile operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiGetIdentityProfileRequest - */ -export interface IdentityProfilesV2024ApiGetIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2024ApiGetIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for importIdentityProfiles operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiImportIdentityProfilesRequest - */ -export interface IdentityProfilesV2024ApiImportIdentityProfilesRequest { - /** - * Previously exported Identity Profiles. - * @type {Array} - * @memberof IdentityProfilesV2024ApiImportIdentityProfiles - */ - readonly identityProfileExportedObjectV2024: Array -} - -/** - * Request parameters for listIdentityProfiles operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiListIdentityProfilesRequest - */ -export interface IdentityProfilesV2024ApiListIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2024ApiListIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2024ApiListIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2024ApiListIdentityProfiles - */ - 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2024ApiListIdentityProfiles - */ - 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, name, priority, created, modified, owner.id, owner.name** - * @type {string} - * @memberof IdentityProfilesV2024ApiListIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for syncIdentityProfile operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiSyncIdentityProfileRequest - */ -export interface IdentityProfilesV2024ApiSyncIdentityProfileRequest { - /** - * The Identity Profile ID to be processed - * @type {string} - * @memberof IdentityProfilesV2024ApiSyncIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for updateIdentityProfile operation in IdentityProfilesV2024Api. - * @export - * @interface IdentityProfilesV2024ApiUpdateIdentityProfileRequest - */ -export interface IdentityProfilesV2024ApiUpdateIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2024ApiUpdateIdentityProfile - */ - readonly identityProfileId: string - - /** - * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof IdentityProfilesV2024ApiUpdateIdentityProfile - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * IdentityProfilesV2024Api - object-oriented interface - * @export - * @class IdentityProfilesV2024Api - * @extends {BaseAPI} - */ -export class IdentityProfilesV2024Api extends BaseAPI { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2024ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public createIdentityProfile(requestParameters: IdentityProfilesV2024ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).createIdentityProfile(requestParameters.identityProfileV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2024ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public deleteIdentityProfile(requestParameters: IdentityProfilesV2024ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2024ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public deleteIdentityProfiles(requestParameters: IdentityProfilesV2024ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2024ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public exportIdentityProfiles(requestParameters: IdentityProfilesV2024ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2024ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public generateIdentityPreview(requestParameters: IdentityProfilesV2024ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).generateIdentityPreview(requestParameters.identityPreviewRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2024ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2024ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public getIdentityProfile(requestParameters: IdentityProfilesV2024ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2024ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public importIdentityProfiles(requestParameters: IdentityProfilesV2024ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).importIdentityProfiles(requestParameters.identityProfileExportedObjectV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2024ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public listIdentityProfiles(requestParameters: IdentityProfilesV2024ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2024ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public syncIdentityProfile(requestParameters: IdentityProfilesV2024ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2024ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2024Api - */ - public updateIdentityProfile(requestParameters: IdentityProfilesV2024ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2024ApiFp(this.configuration).updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LaunchersV2024Api - axios parameter creator - * @export - */ -export const LaunchersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2024} launcherRequestV2024 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher: async (launcherRequestV2024: LauncherRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherRequestV2024' is not null or undefined - assertParamExists('createLauncher', 'launcherRequestV2024', launcherRequestV2024) - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('deleteLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('getLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers: async (filters?: string, next?: string, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (next !== undefined) { - localVarQueryParameter['next'] = next; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2024} launcherRequestV2024 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher: async (launcherID: string, launcherRequestV2024: LauncherRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('putLauncher', 'launcherID', launcherID) - // verify required parameter 'launcherRequestV2024' is not null or undefined - assertParamExists('putLauncher', 'launcherRequestV2024', launcherRequestV2024) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('startLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}/launch` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LaunchersV2024Api - functional programming interface - * @export - */ -export const LaunchersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LaunchersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2024} launcherRequestV2024 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLauncher(launcherRequestV2024: LauncherRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLauncher(launcherRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.createLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.deleteLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.getLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLaunchers(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLaunchers(filters, next, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.getLaunchers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2024} launcherRequestV2024 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putLauncher(launcherID: string, launcherRequestV2024: LauncherRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putLauncher(launcherID, launcherRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.putLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2024Api.startLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LaunchersV2024Api - factory interface - * @export - */ -export const LaunchersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LaunchersV2024ApiFp(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2024ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher(requestParameters: LaunchersV2024ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLauncher(requestParameters.launcherRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2024ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher(requestParameters: LaunchersV2024ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2024ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher(requestParameters: LaunchersV2024ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2024ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers(requestParameters: LaunchersV2024ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2024ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher(requestParameters: LaunchersV2024ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2024ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher(requestParameters: LaunchersV2024ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLauncher operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiCreateLauncherRequest - */ -export interface LaunchersV2024ApiCreateLauncherRequest { - /** - * Payload to create a Launcher - * @type {LauncherRequestV2024} - * @memberof LaunchersV2024ApiCreateLauncher - */ - readonly launcherRequestV2024: LauncherRequestV2024 -} - -/** - * Request parameters for deleteLauncher operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiDeleteLauncherRequest - */ -export interface LaunchersV2024ApiDeleteLauncherRequest { - /** - * ID of the Launcher to be deleted - * @type {string} - * @memberof LaunchersV2024ApiDeleteLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLauncher operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiGetLauncherRequest - */ -export interface LaunchersV2024ApiGetLauncherRequest { - /** - * ID of the Launcher to be retrieved - * @type {string} - * @memberof LaunchersV2024ApiGetLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLaunchers operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiGetLaunchersRequest - */ -export interface LaunchersV2024ApiGetLaunchersRequest { - /** - * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @type {string} - * @memberof LaunchersV2024ApiGetLaunchers - */ - readonly filters?: string - - /** - * Pagination marker - * @type {string} - * @memberof LaunchersV2024ApiGetLaunchers - */ - readonly next?: string - - /** - * Number of Launchers to return - * @type {number} - * @memberof LaunchersV2024ApiGetLaunchers - */ - readonly limit?: number -} - -/** - * Request parameters for putLauncher operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiPutLauncherRequest - */ -export interface LaunchersV2024ApiPutLauncherRequest { - /** - * ID of the Launcher to be replaced - * @type {string} - * @memberof LaunchersV2024ApiPutLauncher - */ - readonly launcherID: string - - /** - * Payload to replace Launcher - * @type {LauncherRequestV2024} - * @memberof LaunchersV2024ApiPutLauncher - */ - readonly launcherRequestV2024: LauncherRequestV2024 -} - -/** - * Request parameters for startLauncher operation in LaunchersV2024Api. - * @export - * @interface LaunchersV2024ApiStartLauncherRequest - */ -export interface LaunchersV2024ApiStartLauncherRequest { - /** - * ID of the Launcher to be launched - * @type {string} - * @memberof LaunchersV2024ApiStartLauncher - */ - readonly launcherID: string -} - -/** - * LaunchersV2024Api - object-oriented interface - * @export - * @class LaunchersV2024Api - * @extends {BaseAPI} - */ -export class LaunchersV2024Api extends BaseAPI { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2024ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public createLauncher(requestParameters: LaunchersV2024ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).createLauncher(requestParameters.launcherRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2024ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public deleteLauncher(requestParameters: LaunchersV2024ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2024ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public getLauncher(requestParameters: LaunchersV2024ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2024ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public getLaunchers(requestParameters: LaunchersV2024ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2024ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public putLauncher(requestParameters: LaunchersV2024ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2024ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2024Api - */ - public startLauncher(requestParameters: LaunchersV2024ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2024ApiFp(this.configuration).startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LifecycleStatesV2024Api - axios parameter creator - * @export - */ -export const LifecycleStatesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2024} lifecycleStateV2024 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState: async (identityProfileId: string, lifecycleStateV2024: LifecycleStateV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('createLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateV2024' is not null or undefined - assertParamExists('createLifecycleState', 'lifecycleStateV2024', lifecycleStateV2024) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(lifecycleStateV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('deleteLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('getLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates: async (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleStates', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2024} setLifecycleStateRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState: async (identityId: string, setLifecycleStateRequestV2024: SetLifecycleStateRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('setLifecycleState', 'identityId', identityId) - // verify required parameter 'setLifecycleStateRequestV2024' is not null or undefined - assertParamExists('setLifecycleState', 'setLifecycleStateRequestV2024', setLifecycleStateRequestV2024) - const localVarPath = `/identities/{identity-id}/set-lifecycle-state` - .replace(`{${"identity-id"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(setLifecycleStateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2024 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('updateLifecycleStates', 'lifecycleStateId', lifecycleStateId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateLifecycleStates', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LifecycleStatesV2024Api - functional programming interface - * @export - */ -export const LifecycleStatesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LifecycleStatesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2024} lifecycleStateV2024 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLifecycleState(identityProfileId: string, lifecycleStateV2024: LifecycleStateV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLifecycleState(identityProfileId, lifecycleStateV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.createLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.deleteLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.getLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStates(identityProfileId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.getLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2024} setLifecycleStateRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setLifecycleState(identityId: string, setLifecycleStateRequestV2024: SetLifecycleStateRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setLifecycleState(identityId, setLifecycleStateRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.setLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2024 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateLifecycleStates(identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStates(identityProfileId, lifecycleStateId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2024Api.updateLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LifecycleStatesV2024Api - factory interface - * @export - */ -export const LifecycleStatesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LifecycleStatesV2024ApiFp(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2024ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState(requestParameters: LifecycleStatesV2024ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2024ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState(requestParameters: LifecycleStatesV2024ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2024ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState(requestParameters: LifecycleStatesV2024ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2024ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates(requestParameters: LifecycleStatesV2024ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2024ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState(requestParameters: LifecycleStatesV2024ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2024ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates(requestParameters: LifecycleStatesV2024ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLifecycleState operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiCreateLifecycleStateRequest - */ -export interface LifecycleStatesV2024ApiCreateLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiCreateLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state to be created. - * @type {LifecycleStateV2024} - * @memberof LifecycleStatesV2024ApiCreateLifecycleState - */ - readonly lifecycleStateV2024: LifecycleStateV2024 -} - -/** - * Request parameters for deleteLifecycleState operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiDeleteLifecycleStateRequest - */ -export interface LifecycleStatesV2024ApiDeleteLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiDeleteLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiDeleteLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleState operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiGetLifecycleStateRequest - */ -export interface LifecycleStatesV2024ApiGetLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiGetLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiGetLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleStates operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiGetLifecycleStatesRequest - */ -export interface LifecycleStatesV2024ApiGetLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiGetLifecycleStates - */ - readonly identityProfileId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2024ApiGetLifecycleStates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2024ApiGetLifecycleStates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof LifecycleStatesV2024ApiGetLifecycleStates - */ - readonly count?: boolean - - /** - * 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: **name, priority, created, modified** - * @type {string} - * @memberof LifecycleStatesV2024ApiGetLifecycleStates - */ - readonly sorters?: string -} - -/** - * Request parameters for setLifecycleState operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiSetLifecycleStateRequest - */ -export interface LifecycleStatesV2024ApiSetLifecycleStateRequest { - /** - * ID of the identity to update. - * @type {string} - * @memberof LifecycleStatesV2024ApiSetLifecycleState - */ - readonly identityId: string - - /** - * - * @type {SetLifecycleStateRequestV2024} - * @memberof LifecycleStatesV2024ApiSetLifecycleState - */ - readonly setLifecycleStateRequestV2024: SetLifecycleStateRequestV2024 -} - -/** - * Request parameters for updateLifecycleStates operation in LifecycleStatesV2024Api. - * @export - * @interface LifecycleStatesV2024ApiUpdateLifecycleStatesRequest - */ -export interface LifecycleStatesV2024ApiUpdateLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiUpdateLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2024ApiUpdateLifecycleStates - */ - readonly lifecycleStateId: string - - /** - * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @type {Array} - * @memberof LifecycleStatesV2024ApiUpdateLifecycleStates - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * LifecycleStatesV2024Api - object-oriented interface - * @export - * @class LifecycleStatesV2024Api - * @extends {BaseAPI} - */ -export class LifecycleStatesV2024Api extends BaseAPI { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2024ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public createLifecycleState(requestParameters: LifecycleStatesV2024ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2024ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public deleteLifecycleState(requestParameters: LifecycleStatesV2024ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2024ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public getLifecycleState(requestParameters: LifecycleStatesV2024ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2024ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public getLifecycleStates(requestParameters: LifecycleStatesV2024ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2024ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public setLifecycleState(requestParameters: LifecycleStatesV2024ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2024ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2024Api - */ - public updateLifecycleStates(requestParameters: LifecycleStatesV2024ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2024ApiFp(this.configuration).updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MFAConfigurationV2024Api - axios parameter creator - * @export - */ -export const MFAConfigurationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/duo-web/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/kba/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (allLanguages !== undefined) { - localVarQueryParameter['allLanguages'] = allLanguages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/okta-verify/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2024} mfaDuoConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig: async (mfaDuoConfigV2024: MfaDuoConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaDuoConfigV2024' is not null or undefined - assertParamExists('setMFADuoConfig', 'mfaDuoConfigV2024', mfaDuoConfigV2024) - const localVarPath = `/mfa/duo-web/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaDuoConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig: async (kbaAnswerRequestItemV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItemV2024' is not null or undefined - assertParamExists('setMFAKBAConfig', 'kbaAnswerRequestItemV2024', kbaAnswerRequestItemV2024) - const localVarPath = `/mfa/kba/config/answers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItemV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2024} mfaOktaConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig: async (mfaOktaConfigV2024: MfaOktaConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaOktaConfigV2024' is not null or undefined - assertParamExists('setMFAOktaConfig', 'mfaOktaConfigV2024', mfaOktaConfigV2024) - const localVarPath = `/mfa/okta-verify/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaOktaConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2024} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig: async (method: TestMFAConfigMethodV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('testMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/test` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAConfigurationV2024Api - functional programming interface - * @export - */ -export const MFAConfigurationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAConfigurationV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.getMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAKbaConfig(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfig(allLanguages, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.getMFAKbaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.getMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2024} mfaDuoConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFADuoConfig(mfaDuoConfigV2024: MfaDuoConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfig(mfaDuoConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.setMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAKBAConfig(kbaAnswerRequestItemV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfig(kbaAnswerRequestItemV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.setMFAKBAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2024} mfaOktaConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAOktaConfig(mfaOktaConfigV2024: MfaOktaConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfig(mfaOktaConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.setMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2024} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testMFAConfig(method: TestMFAConfigMethodV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2024Api.testMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAConfigurationV2024Api - factory interface - * @export - */ -export const MFAConfigurationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAConfigurationV2024ApiFp(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFADuoConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2024ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig(requestParameters: MFAConfigurationV2024ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFAOktaConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2024ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig(requestParameters: MFAConfigurationV2024ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFADuoConfig(requestParameters.mfaDuoConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2024ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig(requestParameters: MFAConfigurationV2024ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2024ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig(requestParameters: MFAConfigurationV2024ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFAOktaConfig(requestParameters.mfaOktaConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2024ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig(requestParameters: MFAConfigurationV2024ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getMFAKbaConfig operation in MFAConfigurationV2024Api. - * @export - * @interface MFAConfigurationV2024ApiGetMFAKbaConfigRequest - */ -export interface MFAConfigurationV2024ApiGetMFAKbaConfigRequest { - /** - * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @type {boolean} - * @memberof MFAConfigurationV2024ApiGetMFAKbaConfig - */ - readonly allLanguages?: boolean -} - -/** - * Request parameters for setMFADuoConfig operation in MFAConfigurationV2024Api. - * @export - * @interface MFAConfigurationV2024ApiSetMFADuoConfigRequest - */ -export interface MFAConfigurationV2024ApiSetMFADuoConfigRequest { - /** - * - * @type {MfaDuoConfigV2024} - * @memberof MFAConfigurationV2024ApiSetMFADuoConfig - */ - readonly mfaDuoConfigV2024: MfaDuoConfigV2024 -} - -/** - * Request parameters for setMFAKBAConfig operation in MFAConfigurationV2024Api. - * @export - * @interface MFAConfigurationV2024ApiSetMFAKBAConfigRequest - */ -export interface MFAConfigurationV2024ApiSetMFAKBAConfigRequest { - /** - * - * @type {Array} - * @memberof MFAConfigurationV2024ApiSetMFAKBAConfig - */ - readonly kbaAnswerRequestItemV2024: Array -} - -/** - * Request parameters for setMFAOktaConfig operation in MFAConfigurationV2024Api. - * @export - * @interface MFAConfigurationV2024ApiSetMFAOktaConfigRequest - */ -export interface MFAConfigurationV2024ApiSetMFAOktaConfigRequest { - /** - * - * @type {MfaOktaConfigV2024} - * @memberof MFAConfigurationV2024ApiSetMFAOktaConfig - */ - readonly mfaOktaConfigV2024: MfaOktaConfigV2024 -} - -/** - * Request parameters for testMFAConfig operation in MFAConfigurationV2024Api. - * @export - * @interface MFAConfigurationV2024ApiTestMFAConfigRequest - */ -export interface MFAConfigurationV2024ApiTestMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationV2024ApiTestMFAConfig - */ - readonly method: TestMFAConfigMethodV2024 -} - -/** - * MFAConfigurationV2024Api - object-oriented interface - * @export - * @class MFAConfigurationV2024Api - * @extends {BaseAPI} - */ -export class MFAConfigurationV2024Api extends BaseAPI { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).getMFADuoConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2024ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public getMFAKbaConfig(requestParameters: MFAConfigurationV2024ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).getMFAOktaConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2024ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public setMFADuoConfig(requestParameters: MFAConfigurationV2024ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).setMFADuoConfig(requestParameters.mfaDuoConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2024ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public setMFAKBAConfig(requestParameters: MFAConfigurationV2024ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2024ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public setMFAOktaConfig(requestParameters: MFAConfigurationV2024ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).setMFAOktaConfig(requestParameters.mfaOktaConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2024ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2024Api - */ - public testMFAConfig(requestParameters: MFAConfigurationV2024ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2024ApiFp(this.configuration).testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const TestMFAConfigMethodV2024 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type TestMFAConfigMethodV2024 = typeof TestMFAConfigMethodV2024[keyof typeof TestMFAConfigMethodV2024]; - - -/** - * MachineAccountClassifyV2024Api - axios parameter creator - * @export - */ -export const MachineAccountClassifyV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2024} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount: async (id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendClassifyMachineAccount', 'id', id) - const localVarPath = `/accounts/{id}/classify` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (classificationMode !== undefined) { - localVarQueryParameter['classificationMode'] = classificationMode; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountClassifyV2024Api - functional programming interface - * @export - */ -export const MachineAccountClassifyV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountClassifyV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2024} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendClassifyMachineAccount(id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccount(id, classificationMode, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountClassifyV2024Api.sendClassifyMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountClassifyV2024Api - factory interface - * @export - */ -export const MachineAccountClassifyV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountClassifyV2024ApiFp(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for sendClassifyMachineAccount operation in MachineAccountClassifyV2024Api. - * @export - * @interface MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest - */ -export interface MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof MachineAccountClassifyV2024ApiSendClassifyMachineAccount - */ - readonly id: string - - /** - * Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @type {'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman'} - * @memberof MachineAccountClassifyV2024ApiSendClassifyMachineAccount - */ - readonly classificationMode?: SendClassifyMachineAccountClassificationModeV2024 -} - -/** - * MachineAccountClassifyV2024Api - object-oriented interface - * @export - * @class MachineAccountClassifyV2024Api - * @extends {BaseAPI} - */ -export class MachineAccountClassifyV2024Api extends BaseAPI { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountClassifyV2024Api - */ - public sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2024ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountClassifyV2024ApiFp(this.configuration).sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SendClassifyMachineAccountClassificationModeV2024 = { - Default: 'default', - IgnoreManual: 'ignoreManual', - ForceMachine: 'forceMachine', - ForceHuman: 'forceHuman' -} as const; -export type SendClassifyMachineAccountClassificationModeV2024 = typeof SendClassifyMachineAccountClassificationModeV2024[keyof typeof SendClassifyMachineAccountClassificationModeV2024]; - - -/** - * MachineAccountMappingsV2024Api - axios parameter creator - * @export - */ -export const MachineAccountMappingsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2024} attributeMappingsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings: async (id: string, attributeMappingsV2024: AttributeMappingsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2024' is not null or undefined - assertParamExists('createMachineAccountMappings', 'attributeMappingsV2024', attributeMappingsV2024) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings: async (id: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2024} attributeMappingsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings: async (id: string, attributeMappingsV2024: AttributeMappingsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2024' is not null or undefined - assertParamExists('setMachineAccountMappings', 'attributeMappingsV2024', attributeMappingsV2024) - const localVarPath = `/sources/{sourceId}/machine-mappings` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountMappingsV2024Api - functional programming interface - * @export - */ -export const MachineAccountMappingsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountMappingsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2024} attributeMappingsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineAccountMappings(id: string, attributeMappingsV2024: AttributeMappingsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountMappings(id, attributeMappingsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2024Api.createMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineAccountMappings(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountMappings(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2024Api.deleteMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccountMappings(id: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountMappings(id, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2024Api.listMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2024} attributeMappingsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineAccountMappings(id: string, attributeMappingsV2024: AttributeMappingsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineAccountMappings(id, attributeMappingsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2024Api.setMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountMappingsV2024Api - factory interface - * @export - */ -export const MachineAccountMappingsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountMappingsV2024ApiFp(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountMappings operation in MachineAccountMappingsV2024Api. - * @export - * @interface MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2024ApiCreateMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2024} - * @memberof MachineAccountMappingsV2024ApiCreateMachineAccountMappings - */ - readonly attributeMappingsV2024: AttributeMappingsV2024 -} - -/** - * Request parameters for deleteMachineAccountMappings operation in MachineAccountMappingsV2024Api. - * @export - * @interface MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest { - /** - * source ID. - * @type {string} - * @memberof MachineAccountMappingsV2024ApiDeleteMachineAccountMappings - */ - readonly id: string -} - -/** - * Request parameters for listMachineAccountMappings operation in MachineAccountMappingsV2024Api. - * @export - * @interface MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest { - /** - * Source ID - * @type {string} - * @memberof MachineAccountMappingsV2024ApiListMachineAccountMappings - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2024ApiListMachineAccountMappings - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2024ApiListMachineAccountMappings - */ - readonly offset?: number -} - -/** - * Request parameters for setMachineAccountMappings operation in MachineAccountMappingsV2024Api. - * @export - * @interface MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2024ApiSetMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2024} - * @memberof MachineAccountMappingsV2024ApiSetMachineAccountMappings - */ - readonly attributeMappingsV2024: AttributeMappingsV2024 -} - -/** - * MachineAccountMappingsV2024Api - object-oriented interface - * @export - * @class MachineAccountMappingsV2024Api - * @extends {BaseAPI} - */ -export class MachineAccountMappingsV2024Api extends BaseAPI { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2024Api - */ - public createMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2024ApiFp(this.configuration).createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2024Api - */ - public deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2024ApiFp(this.configuration).deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2024Api - */ - public listMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2024ApiFp(this.configuration).listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2024Api - */ - public setMachineAccountMappings(requestParameters: MachineAccountMappingsV2024ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2024ApiFp(this.configuration).setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineAccountsV2024Api - axios parameter creator - * @export - */ -export const MachineAccountsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineAccount', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineAccount', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountsV2024Api - functional programming interface - * @export - */ -export const MachineAccountsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccount(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccount(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2024Api.getMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccounts(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2024Api.listMachineAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineAccount(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccount(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2024Api.updateMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountsV2024Api - factory interface - * @export - */ -export const MachineAccountsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountsV2024ApiFp(configuration) - return { - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2024ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount(requestParameters: MachineAccountsV2024ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccount(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2024ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts(requestParameters: MachineAccountsV2024ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2024ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount(requestParameters: MachineAccountsV2024ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineAccount(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getMachineAccount operation in MachineAccountsV2024Api. - * @export - * @interface MachineAccountsV2024ApiGetMachineAccountRequest - */ -export interface MachineAccountsV2024ApiGetMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2024ApiGetMachineAccount - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2024ApiGetMachineAccount - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineAccounts operation in MachineAccountsV2024Api. - * @export - * @interface MachineAccountsV2024ApiListMachineAccountsRequest - */ -export interface MachineAccountsV2024ApiListMachineAccountsRequest { - /** - * 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 MachineAccountsV2024ApiListMachineAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountsV2024ApiListMachineAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof MachineAccountsV2024ApiListMachineAccounts - */ - 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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* - * @type {string} - * @memberof MachineAccountsV2024ApiListMachineAccounts - */ - 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @type {string} - * @memberof MachineAccountsV2024ApiListMachineAccounts - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2024ApiListMachineAccounts - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineAccount operation in MachineAccountsV2024Api. - * @export - * @interface MachineAccountsV2024ApiUpdateMachineAccountRequest - */ -export interface MachineAccountsV2024ApiUpdateMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2024ApiUpdateMachineAccount - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @type {Array} - * @memberof MachineAccountsV2024ApiUpdateMachineAccount - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2024ApiUpdateMachineAccount - */ - readonly xSailPointExperimental?: string -} - -/** - * MachineAccountsV2024Api - object-oriented interface - * @export - * @class MachineAccountsV2024Api - * @extends {BaseAPI} - */ -export class MachineAccountsV2024Api extends BaseAPI { - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2024ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2024Api - */ - public getMachineAccount(requestParameters: MachineAccountsV2024ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2024ApiFp(this.configuration).getMachineAccount(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2024ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2024Api - */ - public listMachineAccounts(requestParameters: MachineAccountsV2024ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2024ApiFp(this.configuration).listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2024ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2024Api - */ - public updateMachineAccount(requestParameters: MachineAccountsV2024ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2024ApiFp(this.configuration).updateMachineAccount(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineClassificationConfigV2024Api - axios parameter creator - * @export - */ -export const MachineClassificationConfigV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2024} machineClassificationConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig: async (id: string, machineClassificationConfigV2024: MachineClassificationConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'id', id) - // verify required parameter 'machineClassificationConfigV2024' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'machineClassificationConfigV2024', machineClassificationConfigV2024) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineClassificationConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineClassificationConfigV2024Api - functional programming interface - * @export - */ -export const MachineClassificationConfigV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineClassificationConfigV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2024Api.deleteMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2024Api.getMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2024} machineClassificationConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineClassificationConfig(id: string, machineClassificationConfigV2024: MachineClassificationConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineClassificationConfig(id, machineClassificationConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2024Api.setMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineClassificationConfigV2024Api - factory interface - * @export - */ -export const MachineClassificationConfigV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineClassificationConfigV2024ApiFp(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteMachineClassificationConfig operation in MachineClassificationConfigV2024Api. - * @export - * @interface MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2024ApiDeleteMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for getMachineClassificationConfig operation in MachineClassificationConfigV2024Api. - * @export - * @interface MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest { - /** - * Source ID - * @type {string} - * @memberof MachineClassificationConfigV2024ApiGetMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for setMachineClassificationConfig operation in MachineClassificationConfigV2024Api. - * @export - * @interface MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2024ApiSetMachineClassificationConfig - */ - readonly id: string - - /** - * - * @type {MachineClassificationConfigV2024} - * @memberof MachineClassificationConfigV2024ApiSetMachineClassificationConfig - */ - readonly machineClassificationConfigV2024: MachineClassificationConfigV2024 -} - -/** - * MachineClassificationConfigV2024Api - object-oriented interface - * @export - * @class MachineClassificationConfigV2024Api - * @extends {BaseAPI} - */ -export class MachineClassificationConfigV2024Api extends BaseAPI { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2024Api - */ - public deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2024ApiFp(this.configuration).deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2024Api - */ - public getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2024ApiFp(this.configuration).getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2024Api - */ - public setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2024ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2024ApiFp(this.configuration).setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineIdentitiesV2024Api - axios parameter creator - * @export - */ -export const MachineIdentitiesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityV2024} machineIdentityV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity: async (machineIdentityV2024: MachineIdentityV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'machineIdentityV2024' is not null or undefined - assertParamExists('createMachineIdentity', 'machineIdentityV2024', machineIdentityV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* - * @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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineIdentity', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineIdentity', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineIdentitiesV2024Api - functional programming interface - * @export - */ -export const MachineIdentitiesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineIdentitiesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityV2024} machineIdentityV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineIdentity(machineIdentityV2024: MachineIdentityV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentity(machineIdentityV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2024Api.createMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2024Api.deleteMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2024Api.getMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* - * @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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineIdentities(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentities(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2024Api.listMachineIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineIdentity(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentity(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2024Api.updateMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineIdentitiesV2024Api - factory interface - * @export - */ -export const MachineIdentitiesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineIdentitiesV2024ApiFp(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2024ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity(requestParameters: MachineIdentitiesV2024ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineIdentity(requestParameters.machineIdentityV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2024ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity(requestParameters: MachineIdentitiesV2024ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2024ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity(requestParameters: MachineIdentitiesV2024ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2024ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities(requestParameters: MachineIdentitiesV2024ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2024ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity(requestParameters: MachineIdentitiesV2024ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineIdentity operation in MachineIdentitiesV2024Api. - * @export - * @interface MachineIdentitiesV2024ApiCreateMachineIdentityRequest - */ -export interface MachineIdentitiesV2024ApiCreateMachineIdentityRequest { - /** - * - * @type {MachineIdentityV2024} - * @memberof MachineIdentitiesV2024ApiCreateMachineIdentity - */ - readonly machineIdentityV2024: MachineIdentityV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2024ApiCreateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineIdentity operation in MachineIdentitiesV2024Api. - * @export - * @interface MachineIdentitiesV2024ApiDeleteMachineIdentityRequest - */ -export interface MachineIdentitiesV2024ApiDeleteMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2024ApiDeleteMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2024ApiDeleteMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineIdentity operation in MachineIdentitiesV2024Api. - * @export - * @interface MachineIdentitiesV2024ApiGetMachineIdentityRequest - */ -export interface MachineIdentitiesV2024ApiGetMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2024ApiGetMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2024ApiGetMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineIdentities operation in MachineIdentitiesV2024Api. - * @export - * @interface MachineIdentitiesV2024ApiListMachineIdentitiesRequest - */ -export interface MachineIdentitiesV2024ApiListMachineIdentitiesRequest { - /** - * 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* - * @type {string} - * @memberof MachineIdentitiesV2024ApiListMachineIdentities - */ - 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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @type {string} - * @memberof MachineIdentitiesV2024ApiListMachineIdentities - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2024ApiListMachineIdentities - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineIdentitiesV2024ApiListMachineIdentities - */ - readonly count?: boolean - - /** - * 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 MachineIdentitiesV2024ApiListMachineIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineIdentitiesV2024ApiListMachineIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for updateMachineIdentity operation in MachineIdentitiesV2024Api. - * @export - * @interface MachineIdentitiesV2024ApiUpdateMachineIdentityRequest - */ -export interface MachineIdentitiesV2024ApiUpdateMachineIdentityRequest { - /** - * Machine Identity ID. - * @type {string} - * @memberof MachineIdentitiesV2024ApiUpdateMachineIdentity - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineIdentitiesV2024ApiUpdateMachineIdentity - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2024ApiUpdateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * MachineIdentitiesV2024Api - object-oriented interface - * @export - * @class MachineIdentitiesV2024Api - * @extends {BaseAPI} - */ -export class MachineIdentitiesV2024Api extends BaseAPI { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2024ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2024Api - */ - public createMachineIdentity(requestParameters: MachineIdentitiesV2024ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2024ApiFp(this.configuration).createMachineIdentity(requestParameters.machineIdentityV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2024ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2024Api - */ - public deleteMachineIdentity(requestParameters: MachineIdentitiesV2024ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2024ApiFp(this.configuration).deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2024ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2024Api - */ - public getMachineIdentity(requestParameters: MachineIdentitiesV2024ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2024ApiFp(this.configuration).getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2024ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2024Api - */ - public listMachineIdentities(requestParameters: MachineIdentitiesV2024ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2024ApiFp(this.configuration).listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2024ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2024Api - */ - public updateMachineIdentity(requestParameters: MachineIdentitiesV2024ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2024ApiFp(this.configuration).updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClientsV2024Api - axios parameter creator - * @export - */ -export const ManagedClientsV2024ApiAxiosParamCreator = 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 {ManagedClientRequestV2024} managedClientRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient: async (managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClientRequestV2024' is not null or undefined - assertParamExists('createManagedClient', 'managedClientRequestV2024', managedClientRequestV2024) - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClientRequestV2024, 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} - */ - deleteManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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} - */ - getManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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 {ManagedClientTypeV2024} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus: async (id: string, type: ManagedClientTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientStatus', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getManagedClientStatus', 'type', type) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * 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} - */ - getManagedClients: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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} jsonPatchOperationV2024 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateManagedClient', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClientsV2024Api - functional programming interface - * @export - */ -export const ManagedClientsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClientsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientRequestV2024} managedClientRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClient(managedClientRequestV2024: ManagedClientRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClient(managedClientRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.createManagedClient']?.[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 deleteManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.deleteManagedClient']?.[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 getManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.getManagedClient']?.[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 {ManagedClientTypeV2024} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClientStatus(id: string, type: ManagedClientTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatus(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.getManagedClientStatus']?.[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 getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClients(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.getManagedClients']?.[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} jsonPatchOperationV2024 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClient(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClient(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2024Api.updateManagedClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClientsV2024Api - factory interface - * @export - */ -export const ManagedClientsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClientsV2024ApiFp(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2024ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient(requestParameters: ManagedClientsV2024ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClient(requestParameters.managedClientRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2024ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClient(requestParameters: ManagedClientsV2024ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2024ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClient(requestParameters: ManagedClientsV2024ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed client\'s status, using its ID. - * @summary Get managed client status - * @param {ManagedClientsV2024ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus(requestParameters: ManagedClientsV2024ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2024ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClients(requestParameters: ManagedClientsV2024ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClients(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed client. - * @summary Update managed client - * @param {ManagedClientsV2024ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient(requestParameters: ManagedClientsV2024ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClient operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiCreateManagedClientRequest - */ -export interface ManagedClientsV2024ApiCreateManagedClientRequest { - /** - * - * @type {ManagedClientRequestV2024} - * @memberof ManagedClientsV2024ApiCreateManagedClient - */ - readonly managedClientRequestV2024: ManagedClientRequestV2024 -} - -/** - * Request parameters for deleteManagedClient operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiDeleteManagedClientRequest - */ -export interface ManagedClientsV2024ApiDeleteManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2024ApiDeleteManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClient operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiGetManagedClientRequest - */ -export interface ManagedClientsV2024ApiGetManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2024ApiGetManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientStatus operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiGetManagedClientStatusRequest - */ -export interface ManagedClientsV2024ApiGetManagedClientStatusRequest { - /** - * Managed client ID to get status for. - * @type {string} - * @memberof ManagedClientsV2024ApiGetManagedClientStatus - */ - readonly id: string - - /** - * Managed client type to get status for. - * @type {ManagedClientTypeV2024} - * @memberof ManagedClientsV2024ApiGetManagedClientStatus - */ - readonly type: ManagedClientTypeV2024 -} - -/** - * Request parameters for getManagedClients operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiGetManagedClientsRequest - */ -export interface ManagedClientsV2024ApiGetManagedClientsRequest { - /** - * 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 ManagedClientsV2024ApiGetManagedClients - */ - 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 ManagedClientsV2024ApiGetManagedClients - */ - 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 ManagedClientsV2024ApiGetManagedClients - */ - 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 ManagedClientsV2024ApiGetManagedClients - */ - readonly filters?: string -} - -/** - * Request parameters for updateManagedClient operation in ManagedClientsV2024Api. - * @export - * @interface ManagedClientsV2024ApiUpdateManagedClientRequest - */ -export interface ManagedClientsV2024ApiUpdateManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2024ApiUpdateManagedClient - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClientsV2024ApiUpdateManagedClient - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * ManagedClientsV2024Api - object-oriented interface - * @export - * @class ManagedClientsV2024Api - * @extends {BaseAPI} - */ -export class ManagedClientsV2024Api extends BaseAPI { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2024ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public createManagedClient(requestParameters: ManagedClientsV2024ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).createManagedClient(requestParameters.managedClientRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2024ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public deleteManagedClient(requestParameters: ManagedClientsV2024ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2024ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public getManagedClient(requestParameters: ManagedClientsV2024ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).getManagedClient(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 {ManagedClientsV2024ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public getManagedClientStatus(requestParameters: ManagedClientsV2024ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2024ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public getManagedClients(requestParameters: ManagedClientsV2024ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).getManagedClients(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 {ManagedClientsV2024ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2024Api - */ - public updateManagedClient(requestParameters: ManagedClientsV2024ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2024ApiFp(this.configuration).updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClusterTypesV2024Api - axios parameter creator - * @export - */ -export const ManagedClusterTypesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2024} managedClusterTypeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType: async (managedClusterTypeV2024: ManagedClusterTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterTypeV2024' is not null or undefined - assertParamExists('createManagedClusterType', 'managedClusterTypeV2024', managedClusterTypeV2024) - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterTypeV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Managed Cluster Types. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes: async (type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (pod !== undefined) { - localVarQueryParameter['pod'] = pod; - } - - if (org !== undefined) { - localVarQueryParameter['org'] = org; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2024} jsonPatchV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType: async (id: string, jsonPatchV2024: JsonPatchV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClusterType', 'id', id) - // verify required parameter 'jsonPatchV2024' is not null or undefined - assertParamExists('updateManagedClusterType', 'jsonPatchV2024', jsonPatchV2024) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClusterTypesV2024Api - functional programming interface - * @export - */ -export const ManagedClusterTypesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClusterTypesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2024} managedClusterTypeV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClusterType(managedClusterTypeV2024: ManagedClusterTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClusterType(managedClusterTypeV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2024Api.createManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2024Api.deleteManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2024Api.getManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Managed Cluster Types. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterTypes(type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterTypes(type, pod, org, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2024Api.getManagedClusterTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2024} jsonPatchV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClusterType(id: string, jsonPatchV2024: JsonPatchV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClusterType(id, jsonPatchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2024Api.updateManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClusterTypesV2024Api - factory interface - * @export - */ -export const ManagedClusterTypesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClusterTypesV2024ApiFp(configuration) - return { - /** - * Create a new Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClusterType(requestParameters.managedClusterTypeV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Managed Cluster Types. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get managed cluster types - * @param {ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes(requestParameters: ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClusterType operation in ManagedClusterTypesV2024Api. - * @export - * @interface ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest { - /** - * - * @type {ManagedClusterTypeV2024} - * @memberof ManagedClusterTypesV2024ApiCreateManagedClusterType - */ - readonly managedClusterTypeV2024: ManagedClusterTypeV2024 -} - -/** - * Request parameters for deleteManagedClusterType operation in ManagedClusterTypesV2024Api. - * @export - * @interface ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2024ApiDeleteManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterType operation in ManagedClusterTypesV2024Api. - * @export - * @interface ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2024ApiGetManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterTypes operation in ManagedClusterTypesV2024Api. - * @export - * @interface ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest - */ -export interface ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest { - /** - * Type descriptor - * @type {string} - * @memberof ManagedClusterTypesV2024ApiGetManagedClusterTypes - */ - readonly type?: string - - /** - * Pinned pod (or default) - * @type {string} - * @memberof ManagedClusterTypesV2024ApiGetManagedClusterTypes - */ - readonly pod?: string - - /** - * Pinned org (or default) - * @type {string} - * @memberof ManagedClusterTypesV2024ApiGetManagedClusterTypes - */ - readonly org?: string - - /** - * 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 ManagedClusterTypesV2024ApiGetManagedClusterTypes - */ - 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 ManagedClusterTypesV2024ApiGetManagedClusterTypes - */ - readonly limit?: number -} - -/** - * Request parameters for updateManagedClusterType operation in ManagedClusterTypesV2024Api. - * @export - * @interface ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2024ApiUpdateManagedClusterType - */ - readonly id: string - - /** - * The JSONPatch payload used to update the schema. - * @type {JsonPatchV2024} - * @memberof ManagedClusterTypesV2024ApiUpdateManagedClusterType - */ - readonly jsonPatchV2024: JsonPatchV2024 -} - -/** - * ManagedClusterTypesV2024Api - object-oriented interface - * @export - * @class ManagedClusterTypesV2024Api - * @extends {BaseAPI} - */ -export class ManagedClusterTypesV2024Api extends BaseAPI { - /** - * Create a new Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2024Api - */ - public createManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2024ApiFp(this.configuration).createManagedClusterType(requestParameters.managedClusterTypeV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2024Api - */ - public deleteManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2024ApiFp(this.configuration).deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2024Api - */ - public getManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2024ApiFp(this.configuration).getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Managed Cluster Types. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Get managed cluster types - * @param {ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2024Api - */ - public getManagedClusterTypes(requestParameters: ManagedClusterTypesV2024ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2024ApiFp(this.configuration).getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Managed Cluster Type. AMS Security: Devops, Internal A token with SaaS Platform Internal or DevOps is required to access this endpoint. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2024Api - */ - public updateManagedClusterType(requestParameters: ManagedClusterTypesV2024ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2024ApiFp(this.configuration).updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClustersV2024Api - axios parameter creator - * @export - */ -export const ManagedClustersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2024} managedClusterRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster: async (managedClusterRequestV2024: ManagedClusterRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterRequestV2024' is not null or undefined - assertParamExists('createManagedCluster', 'managedClusterRequestV2024', managedClusterRequestV2024) - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster: async (id: string, removeClients?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (removeClients !== undefined) { - localVarQueryParameter['removeClients'] = removeClients; - } - - - - 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 cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClientLogConfiguration', 'id', id) - const localVarPath = `/managed-clusters/{id}/log-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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 a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2024} putClientLogConfigurationRequestV2024 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration: async (id: string, putClientLogConfigurationRequestV2024: PutClientLogConfigurationRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putClientLogConfiguration', 'id', id) - // verify required parameter 'putClientLogConfigurationRequestV2024' is not null or undefined - assertParamExists('putClientLogConfiguration', 'putClientLogConfigurationRequestV2024', putClientLogConfigurationRequestV2024) - const localVarPath = `/managed-clusters/{id}/log-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(putClientLogConfigurationRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('update', 'id', id) - const localVarPath = `/managed-clusters/{id}/manualUpgrade` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2024 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedCluster', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateManagedCluster', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClustersV2024Api - functional programming interface - * @export - */ -export const ManagedClustersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClustersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2024} managedClusterRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedCluster(managedClusterRequestV2024: ManagedClusterRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedCluster(managedClusterRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.createManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedCluster(id: string, removeClients?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedCluster(id, removeClients, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.deleteManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClientLogConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.getClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedCluster(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedCluster(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.getManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusters(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusters(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.getManagedClusters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2024} putClientLogConfigurationRequestV2024 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putClientLogConfiguration(id: string, putClientLogConfigurationRequestV2024: PutClientLogConfigurationRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfiguration(id, putClientLogConfigurationRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.putClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async update(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.update(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.update']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2024 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedCluster(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedCluster(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2024Api.updateManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClustersV2024Api - factory interface - * @export - */ -export const ManagedClustersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClustersV2024ApiFp(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2024ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster(requestParameters: ManagedClustersV2024ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedCluster(requestParameters.managedClusterRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2024ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster(requestParameters: ManagedClustersV2024ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2024ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration(requestParameters: ManagedClustersV2024ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2024ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster(requestParameters: ManagedClustersV2024ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2024ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters(requestParameters: ManagedClustersV2024ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2024ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration(requestParameters: ManagedClustersV2024ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2024ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update(requestParameters: ManagedClustersV2024ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.update(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2024ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster(requestParameters: ManagedClustersV2024ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedCluster operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiCreateManagedClusterRequest - */ -export interface ManagedClustersV2024ApiCreateManagedClusterRequest { - /** - * - * @type {ManagedClusterRequestV2024} - * @memberof ManagedClustersV2024ApiCreateManagedCluster - */ - readonly managedClusterRequestV2024: ManagedClusterRequestV2024 -} - -/** - * Request parameters for deleteManagedCluster operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiDeleteManagedClusterRequest - */ -export interface ManagedClustersV2024ApiDeleteManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2024ApiDeleteManagedCluster - */ - readonly id: string - - /** - * Flag to determine the need to delete a cluster with clients. - * @type {boolean} - * @memberof ManagedClustersV2024ApiDeleteManagedCluster - */ - readonly removeClients?: boolean -} - -/** - * Request parameters for getClientLogConfiguration operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiGetClientLogConfigurationRequest - */ -export interface ManagedClustersV2024ApiGetClientLogConfigurationRequest { - /** - * ID of managed cluster to get log configuration for. - * @type {string} - * @memberof ManagedClustersV2024ApiGetClientLogConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getManagedCluster operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiGetManagedClusterRequest - */ -export interface ManagedClustersV2024ApiGetManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2024ApiGetManagedCluster - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusters operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiGetManagedClustersRequest - */ -export interface ManagedClustersV2024ApiGetManagedClustersRequest { - /** - * 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 ManagedClustersV2024ApiGetManagedClusters - */ - 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 ManagedClustersV2024ApiGetManagedClusters - */ - 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 ManagedClustersV2024ApiGetManagedClusters - */ - 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @type {string} - * @memberof ManagedClustersV2024ApiGetManagedClusters - */ - readonly filters?: string -} - -/** - * Request parameters for putClientLogConfiguration operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiPutClientLogConfigurationRequest - */ -export interface ManagedClustersV2024ApiPutClientLogConfigurationRequest { - /** - * ID of the managed cluster to update the log configuration for. - * @type {string} - * @memberof ManagedClustersV2024ApiPutClientLogConfiguration - */ - readonly id: string - - /** - * Client log configuration for the given managed cluster. - * @type {PutClientLogConfigurationRequestV2024} - * @memberof ManagedClustersV2024ApiPutClientLogConfiguration - */ - readonly putClientLogConfigurationRequestV2024: PutClientLogConfigurationRequestV2024 -} - -/** - * Request parameters for update operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiUpdateRequest - */ -export interface ManagedClustersV2024ApiUpdateRequest { - /** - * ID of managed cluster to trigger manual upgrade. - * @type {string} - * @memberof ManagedClustersV2024ApiUpdate - */ - readonly id: string -} - -/** - * Request parameters for updateManagedCluster operation in ManagedClustersV2024Api. - * @export - * @interface ManagedClustersV2024ApiUpdateManagedClusterRequest - */ -export interface ManagedClustersV2024ApiUpdateManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2024ApiUpdateManagedCluster - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClustersV2024ApiUpdateManagedCluster - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * ManagedClustersV2024Api - object-oriented interface - * @export - * @class ManagedClustersV2024Api - * @extends {BaseAPI} - */ -export class ManagedClustersV2024Api extends BaseAPI { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2024ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public createManagedCluster(requestParameters: ManagedClustersV2024ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).createManagedCluster(requestParameters.managedClusterRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2024ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public deleteManagedCluster(requestParameters: ManagedClustersV2024ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2024ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public getClientLogConfiguration(requestParameters: ManagedClustersV2024ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2024ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public getManagedCluster(requestParameters: ManagedClustersV2024ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2024ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public getManagedClusters(requestParameters: ManagedClustersV2024ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2024ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public putClientLogConfiguration(requestParameters: ManagedClustersV2024ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2024ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public update(requestParameters: ManagedClustersV2024ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).update(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2024ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2024Api - */ - public updateManagedCluster(requestParameters: ManagedClustersV2024ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2024ApiFp(this.configuration).updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MultiHostIntegrationV2024Api - axios parameter creator - * @export - */ -export const MultiHostIntegrationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2024} multiHostIntegrationsCreateV2024 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration: async (multiHostIntegrationsCreateV2024: MultiHostIntegrationsCreateV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostIntegrationsCreateV2024' is not null or undefined - assertParamExists('createMultiHostIntegration', 'multiHostIntegrationsCreateV2024', multiHostIntegrationsCreateV2024) - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2024 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost: async (multihostId: string, multiHostIntegrationsCreateSourcesV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multihostId', multihostId) - // verify required parameter 'multiHostIntegrationsCreateSourcesV2024' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multiHostIntegrationsCreateSourcesV2024', multiHostIntegrationsCreateSourcesV2024) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateSourcesV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('deleteMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups: async (multihostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getAcctAggregationGroups', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/acctAggregationGroups` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups: async (multiHostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getEntitlementAggregationGroups', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/entitlementAggregationGroups` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getMultiHostIntegrations', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getMultiHostSourceCreationErrors', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/sources/errors` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost: async (multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getSourcesWithinMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testConnectionMultiHostSources', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost: async (multihostId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'multihostId', multihostId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'sourceId', sourceId) - const localVarPath = `/multihosts/{multihostId}/sources/{sourceId}/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2024 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources: async (multihostId: string, updateMultiHostSourcesRequestInnerV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('updateMultiHostSources', 'multihostId', multihostId) - // verify required parameter 'updateMultiHostSourcesRequestInnerV2024' is not null or undefined - assertParamExists('updateMultiHostSources', 'updateMultiHostSourcesRequestInnerV2024', updateMultiHostSourcesRequestInnerV2024) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(updateMultiHostSourcesRequestInnerV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MultiHostIntegrationV2024Api - functional programming interface - * @export - */ -export const MultiHostIntegrationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MultiHostIntegrationV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2024} multiHostIntegrationsCreateV2024 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMultiHostIntegration(multiHostIntegrationsCreateV2024: MultiHostIntegrationsCreateV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMultiHostIntegration(multiHostIntegrationsCreateV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.createMultiHostIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2024 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourcesWithinMultiHost(multihostId: string, multiHostIntegrationsCreateSourcesV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourcesWithinMultiHost(multihostId, multiHostIntegrationsCreateSourcesV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.createSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHost(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHost(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.deleteMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAcctAggregationGroups(multihostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAcctAggregationGroups(multihostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getAcctAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementAggregationGroups(multiHostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementAggregationGroups(multiHostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getEntitlementAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrations(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrations(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getMultiHostIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrationsList(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsList(offset, limit, sorters, filters, count, forSubadmin, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getMultiHostIntegrationsList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostSourceCreationErrors(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostSourceCreationErrors(multiHostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getMultiHostSourceCreationErrors']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultihostIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getMultihostIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourcesWithinMultiHost(multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourcesWithinMultiHost(multihostId, offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.getSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectionMultiHostSources(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionMultiHostSources(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.testConnectionMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnectionMultihost(multihostId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionMultihost(multihostId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.testSourceConnectionMultihost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2024 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMultiHostSources(multihostId: string, updateMultiHostSourcesRequestInnerV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMultiHostSources(multihostId, updateMultiHostSourcesRequestInnerV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2024Api.updateMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MultiHostIntegrationV2024Api - factory interface - * @export - */ -export const MultiHostIntegrationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MultiHostIntegrationV2024ApiFp(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration(requestParameters: MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2024ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost(requestParameters: MultiHostIntegrationV2024ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultihostIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources(requestParameters: MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMultiHostIntegration operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest - */ -export interface MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest { - /** - * The specifics of the Multi-Host Integration to create - * @type {MultiHostIntegrationsCreateV2024} - * @memberof MultiHostIntegrationV2024ApiCreateMultiHostIntegration - */ - readonly multiHostIntegrationsCreateV2024: MultiHostIntegrationsCreateV2024 -} - -/** - * Request parameters for createSourcesWithinMultiHost operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * The specifics of the sources to create within Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHost - */ - readonly multiHostIntegrationsCreateSourcesV2024: Array -} - -/** - * Request parameters for deleteMultiHost operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiDeleteMultiHostRequest - */ -export interface MultiHostIntegrationV2024ApiDeleteMultiHostRequest { - /** - * ID of Multi-Host Integration to delete. - * @type {string} - * @memberof MultiHostIntegrationV2024ApiDeleteMultiHost - */ - readonly multihostId: string -} - -/** - * Request parameters for getAcctAggregationGroups operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetAcctAggregationGroups - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2024ApiGetAcctAggregationGroups - */ - 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 MultiHostIntegrationV2024ApiGetAcctAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getEntitlementAggregationGroups operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetEntitlementAggregationGroups - */ - readonly multiHostId: string - - /** - * 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 MultiHostIntegrationV2024ApiGetEntitlementAggregationGroups - */ - 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 MultiHostIntegrationV2024ApiGetEntitlementAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getMultiHostIntegrations operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest - */ -export interface MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetMultiHostIntegrations - */ - readonly multihostId: string -} - -/** - * Request parameters for getMultiHostIntegrationsList operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest - */ -export interface MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest { - /** - * 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 MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - 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 MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - readonly sorters?: 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: **type**: *in* **forSubAdminId**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - readonly count?: boolean - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetMultiHostIntegrationsList - */ - readonly forSubadmin?: string -} - -/** - * Request parameters for getMultiHostSourceCreationErrors operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest - */ -export interface MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrors - */ - readonly multiHostId: string -} - -/** - * Request parameters for getSourcesWithinMultiHost operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - 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 MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - readonly sorters?: 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: **id**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2024ApiGetSourcesWithinMultiHost - */ - readonly count?: boolean -} - -/** - * Request parameters for testConnectionMultiHostSources operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2024ApiTestConnectionMultiHostSources - */ - readonly multihostId: string -} - -/** - * Request parameters for testSourceConnectionMultihost operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest - */ -export interface MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2024ApiTestSourceConnectionMultihost - */ - readonly multihostId: string - - /** - * ID of the source within the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2024ApiTestSourceConnectionMultihost - */ - readonly sourceId: string -} - -/** - * Request parameters for updateMultiHostSources operation in MultiHostIntegrationV2024Api. - * @export - * @interface MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration to update. - * @type {string} - * @memberof MultiHostIntegrationV2024ApiUpdateMultiHostSources - */ - readonly multihostId: string - - /** - * This endpoint allows you to update a Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2024ApiUpdateMultiHostSources - */ - readonly updateMultiHostSourcesRequestInnerV2024: Array -} - -/** - * MultiHostIntegrationV2024Api - object-oriented interface - * @export - * @class MultiHostIntegrationV2024Api - * @extends {BaseAPI} - */ -export class MultiHostIntegrationV2024Api extends BaseAPI { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public createMultiHostIntegration(requestParameters: MultiHostIntegrationV2024ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2024ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2024ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public deleteMultiHost(requestParameters: MultiHostIntegrationV2024ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2024ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2024ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2024ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getMultihostIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2024ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2024ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2024ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2024Api - */ - public updateMultiHostSources(requestParameters: MultiHostIntegrationV2024ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2024ApiFp(this.configuration).updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NonEmployeeLifecycleManagementV2024Api - axios parameter creator - * @export - */ -export const NonEmployeeLifecycleManagementV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2024} nonEmployeeApprovalDecisionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest: async (id: string, nonEmployeeApprovalDecisionV2024: NonEmployeeApprovalDecisionV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeApprovalDecisionV2024' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'nonEmployeeApprovalDecisionV2024', nonEmployeeApprovalDecisionV2024) - const localVarPath = `/non-employee-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecisionV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord: async (nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2024' is not null or undefined - assertParamExists('createNonEmployeeRecord', 'nonEmployeeRequestBodyV2024', nonEmployeeRequestBodyV2024) - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest: async (nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2024' is not null or undefined - assertParamExists('createNonEmployeeRequest', 'nonEmployeeRequestBodyV2024', nonEmployeeRequestBodyV2024) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2024} nonEmployeeSourceRequestBodyV2024 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource: async (nonEmployeeSourceRequestBodyV2024: NonEmployeeSourceRequestBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeSourceRequestBodyV2024' is not null or undefined - assertParamExists('createNonEmployeeSource', 'nonEmployeeSourceRequestBodyV2024', nonEmployeeSourceRequestBodyV2024) - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2024} nonEmployeeSchemaAttributeBodyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes: async (sourceId: string, nonEmployeeSchemaAttributeBodyV2024: NonEmployeeSchemaAttributeBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - // verify required parameter 'nonEmployeeSchemaAttributeBodyV2024' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'nonEmployeeSchemaAttributeBodyV2024', nonEmployeeSchemaAttributeBodyV2024) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2024} deleteNonEmployeeRecordsInBulkRequestV2024 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk: async (deleteNonEmployeeRecordsInBulkRequestV2024: DeleteNonEmployeeRecordsInBulkRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteNonEmployeeRecordsInBulkRequestV2024' is not null or undefined - assertParamExists('deleteNonEmployeeRecordsInBulk', 'deleteNonEmployeeRecordsInBulkRequestV2024', deleteNonEmployeeRecordsInBulkRequestV2024) - const localVarPath = `/non-employee-records/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordsInBulkRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeRecords', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employees/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeSourceSchemaTemplate', 'id', id) - const localVarPath = `/non-employee-sources/{id}/schema-attributes-template/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeApproval', 'id', id) - const localVarPath = `/non-employee-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeDetail !== undefined) { - localVarQueryParameter['include-detail'] = includeDetail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeApprovalSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-approvals/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeBulkUploadStatus', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeRequestSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'id', id) - // verify required parameter 'data' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'data', data) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('listNonEmployeeRequests', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (nonEmployeeCount !== undefined) { - localVarQueryParameter['non-employee-count'] = nonEmployeeCount; - } - - 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, - }; - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2024 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2024 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2024 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource: async (sourceId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2024} nonEmployeeRejectApprovalDecisionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest: async (id: string, nonEmployeeRejectApprovalDecisionV2024: NonEmployeeRejectApprovalDecisionV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeRejectApprovalDecisionV2024' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'nonEmployeeRejectApprovalDecisionV2024', nonEmployeeRejectApprovalDecisionV2024) - const localVarPath = `/non-employee-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecisionV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord: async (id: string, nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'id', id) - // verify required parameter 'nonEmployeeRequestBodyV2024' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'nonEmployeeRequestBodyV2024', nonEmployeeRequestBodyV2024) - const localVarPath = `/non-employee-records/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2024Api - functional programming interface - * @export - */ -export const NonEmployeeLifecycleManagementV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NonEmployeeLifecycleManagementV2024ApiAxiosParamCreator(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2024} nonEmployeeApprovalDecisionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveNonEmployeeRequest(id: string, nonEmployeeApprovalDecisionV2024: NonEmployeeApprovalDecisionV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequest(id, nonEmployeeApprovalDecisionV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.approveNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRecord(nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecord(nonEmployeeRequestBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.createNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRequest(nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequest(nonEmployeeRequestBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.createNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2024} nonEmployeeSourceRequestBodyV2024 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSource(nonEmployeeSourceRequestBodyV2024: NonEmployeeSourceRequestBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSource(nonEmployeeSourceRequestBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.createNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2024} nonEmployeeSchemaAttributeBodyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSourceSchemaAttributes(sourceId: string, nonEmployeeSchemaAttributeBodyV2024: NonEmployeeSchemaAttributeBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributes(sourceId, nonEmployeeSchemaAttributeBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.createNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2024} deleteNonEmployeeRecordsInBulkRequestV2024 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2024: DeleteNonEmployeeRecordsInBulkRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.deleteNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeRecords(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecords(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.exportNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeSourceSchemaTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.exportNonEmployeeSourceSchemaTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApproval(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApproval(id, includeDetail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApprovalSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeBulkUploadStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeBulkUploadStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequestSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeRequestSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.getNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importNonEmployeeRecordsInBulk(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulk(id, data, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.importNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeApprovals(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovals(requestedFor, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.listNonEmployeeApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRecords(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecords(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.listNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRequests(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequests(requestedFor, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.listNonEmployeeRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeSources(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSources(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.listNonEmployeeSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2024 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeRecord(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecord(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.patchNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2024 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttribute(attributeId, sourceId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.patchNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2024 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSource(sourceId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSource(sourceId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.patchNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2024} nonEmployeeRejectApprovalDecisionV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectNonEmployeeRequest(id: string, nonEmployeeRejectApprovalDecisionV2024: NonEmployeeRejectApprovalDecisionV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequest(id, nonEmployeeRejectApprovalDecisionV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.rejectNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2024} nonEmployeeRequestBodyV2024 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateNonEmployeeRecord(id: string, nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecord(id, nonEmployeeRequestBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2024Api.updateNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2024Api - factory interface - * @export - */ -export const NonEmployeeLifecycleManagementV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NonEmployeeLifecycleManagementV2024ApiFp(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeApprovalDecisionV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequest - */ - readonly nonEmployeeApprovalDecisionV2024: NonEmployeeApprovalDecisionV2024 -} - -/** - * Request parameters for createNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest { - /** - * Non-Employee record creation request body. - * @type {NonEmployeeRequestBodyV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024 -} - -/** - * Request parameters for createNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest { - /** - * Non-Employee creation request body - * @type {NonEmployeeRequestBodyV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequest - */ - readonly nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024 -} - -/** - * Request parameters for createNonEmployeeSource operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest { - /** - * Non-Employee source creation request body. - * @type {NonEmployeeSourceRequestBodyV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSource - */ - readonly nonEmployeeSourceRequestBodyV2024: NonEmployeeSourceRequestBodyV2024 -} - -/** - * Request parameters for createNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * - * @type {NonEmployeeSchemaAttributeBodyV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly nonEmployeeSchemaAttributeBodyV2024: NonEmployeeSchemaAttributeBodyV2024 -} - -/** - * Request parameters for deleteNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest { - /** - * Non-Employee bulk delete request body. - * @type {DeleteNonEmployeeRecordsInBulkRequestV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulk - */ - readonly deleteNonEmployeeRecordsInBulkRequestV2024: DeleteNonEmployeeRecordsInBulkRequestV2024 -} - -/** - * Request parameters for deleteNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest { - /** - * Non-Employee request id in the UUID format - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSource operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for exportNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecords - */ - readonly id: string -} - -/** - * Request parameters for exportNonEmployeeSourceSchemaTemplate operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeApproval operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApproval - */ - readonly id: string - - /** - * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApproval - */ - readonly includeDetail?: boolean -} - -/** - * Request parameters for getNonEmployeeApprovalSummary operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest { - /** - * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeBulkUploadStatus operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest { - /** - * Source ID (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatus - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest { - /** - * Non-Employee request id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequestSummary operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest { - /** - * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSource operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for importNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulk - */ - readonly id: string - - /** - * - * @type {File} - * @memberof NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulk - */ - readonly data: File -} - -/** - * Request parameters for listNonEmployeeApprovals operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - readonly requestedFor?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - 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: **approvalStatus**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest { - /** - * 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 NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecords - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecords - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecords - */ - readonly count?: boolean - - /** - * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecords - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecords - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeRequests operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly requestedFor: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly count?: boolean - - /** - * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequests - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeSources operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest { - /** - * 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 NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly count?: boolean - - /** - * Identity the request was made for. Use \'me\' to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly requestedFor?: string - - /** - * Flag that determines whether the API will return a non-employee count associated with the source. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly nonEmployeeCount?: boolean - - /** - * 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: **name, created, sourceId** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSources - */ - readonly sorters?: string -} - -/** - * Request parameters for patchNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecord - */ - readonly id: string - - /** - * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecord - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for patchNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttribute - */ - readonly sourceId: string - - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttribute - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for patchNonEmployeeSource operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSource - */ - readonly sourceId: string - - /** - * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSource - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for rejectNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeRejectApprovalDecisionV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequest - */ - readonly nonEmployeeRejectApprovalDecisionV2024: NonEmployeeRejectApprovalDecisionV2024 -} - -/** - * Request parameters for updateNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2024Api. - * @export - * @interface NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecord - */ - readonly id: string - - /** - * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {NonEmployeeRequestBodyV2024} - * @memberof NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2024: NonEmployeeRequestBodyV2024 -} - -/** - * NonEmployeeLifecycleManagementV2024Api - object-oriented interface - * @export - * @class NonEmployeeLifecycleManagementV2024Api - * @extends {BaseAPI} - */ -export class NonEmployeeLifecycleManagementV2024Api extends BaseAPI { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2024ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2024ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2024ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2024ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2024ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2024ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2024Api - */ - public updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2024ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2024ApiFp(this.configuration).updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NotificationsV2024Api - axios parameter creator - * @export - */ -export const NotificationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2024} domainAddressV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim: async (domainAddressV2024: DomainAddressV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'domainAddressV2024' is not null or undefined - assertParamExists('createDomainDkim', 'domainAddressV2024', domainAddressV2024) - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(domainAddressV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2024} templateDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate: async (templateDtoV2024: TemplateDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateDtoV2024' is not null or undefined - assertParamExists('createNotificationTemplate', 'templateDtoV2024', templateDtoV2024) - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2024} emailStatusDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress: async (emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'emailStatusDtoV2024' is not null or undefined - assertParamExists('createVerifiedFromAddress', 'emailStatusDtoV2024', emailStatusDtoV2024) - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailStatusDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk: async (templateBulkDeleteDtoV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateBulkDeleteDtoV2024' is not null or undefined - assertParamExists('deleteNotificationTemplatesInBulk', 'templateBulkDeleteDtoV2024', templateBulkDeleteDtoV2024) - const localVarPath = `/notification-templates/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateBulkDeleteDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteVerifiedFromAddress', 'id', id) - const localVarPath = `/verified-from-addresses/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes: async (identity: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identity' is not null or undefined - assertParamExists('getMailFromAttributes', 'identity', identity) - const localVarPath = `/mail-from-attributes/{identity}` - .replace(`{${"identity"}}`, encodeURIComponent(String(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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-preferences/{key}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNotificationTemplate', 'id', id) - const localVarPath = `/notification-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-defaults`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes: async (mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mailFromAttributesDtoV2024' is not null or undefined - assertParamExists('putMailFromAttributes', 'mailFromAttributesDtoV2024', mailFromAttributesDtoV2024) - const localVarPath = `/mail-from-attributes`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mailFromAttributesDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification: async (sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTestNotificationRequestDtoV2024' is not null or undefined - assertParamExists('sendTestNotification', 'sendTestNotificationRequestDtoV2024', sendTestNotificationRequestDtoV2024) - const localVarPath = `/send-test-notification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTestNotificationRequestDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NotificationsV2024Api - functional programming interface - * @export - */ -export const NotificationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NotificationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2024} domainAddressV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDomainDkim(domainAddressV2024: DomainAddressV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkim(domainAddressV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.createDomainDkim']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2024} templateDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNotificationTemplate(templateDtoV2024: TemplateDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplate(templateDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.createNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2024} emailStatusDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createVerifiedFromAddress(emailStatusDtoV2024: EmailStatusDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddress(emailStatusDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.createVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.deleteNotificationTemplatesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddress(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.deleteVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributes(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.getDkimAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMailFromAttributes(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributes(identity, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.getMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationPreferences(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.getNotificationPreferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.getNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.getNotificationsTemplateContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddresses(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.listFromAddresses']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaults(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.listNotificationTemplateDefaults']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplates(limit, offset, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.listNotificationTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2024} mailFromAttributesDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putMailFromAttributes(mailFromAttributesDtoV2024: MailFromAttributesDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributes(mailFromAttributesDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.putMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2024} sendTestNotificationRequestDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTestNotification(sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotification(sendTestNotificationRequestDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2024Api.sendTestNotification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NotificationsV2024Api - factory interface - * @export - */ -export const NotificationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NotificationsV2024ApiFp(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2024ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim(requestParameters: NotificationsV2024ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDomainDkim(requestParameters.domainAddressV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2024ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate(requestParameters: NotificationsV2024ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNotificationTemplate(requestParameters.templateDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2024ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress(requestParameters: NotificationsV2024ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createVerifiedFromAddress(requestParameters.emailStatusDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2024ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress(requestParameters: NotificationsV2024ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2024ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes(requestParameters: NotificationsV2024ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2024ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes(requestParameters: NotificationsV2024ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationPreferences(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2024ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate(requestParameters: NotificationsV2024ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationsTemplateContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2024ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses(requestParameters: NotificationsV2024ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2024ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults(requestParameters: NotificationsV2024ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2024ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates(requestParameters: NotificationsV2024ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2024ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes(requestParameters: NotificationsV2024ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putMailFromAttributes(requestParameters.mailFromAttributesDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2024ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification(requestParameters: NotificationsV2024ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDomainDkim operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiCreateDomainDkimRequest - */ -export interface NotificationsV2024ApiCreateDomainDkimRequest { - /** - * - * @type {DomainAddressV2024} - * @memberof NotificationsV2024ApiCreateDomainDkim - */ - readonly domainAddressV2024: DomainAddressV2024 -} - -/** - * Request parameters for createNotificationTemplate operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiCreateNotificationTemplateRequest - */ -export interface NotificationsV2024ApiCreateNotificationTemplateRequest { - /** - * - * @type {TemplateDtoV2024} - * @memberof NotificationsV2024ApiCreateNotificationTemplate - */ - readonly templateDtoV2024: TemplateDtoV2024 -} - -/** - * Request parameters for createVerifiedFromAddress operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiCreateVerifiedFromAddressRequest - */ -export interface NotificationsV2024ApiCreateVerifiedFromAddressRequest { - /** - * - * @type {EmailStatusDtoV2024} - * @memberof NotificationsV2024ApiCreateVerifiedFromAddress - */ - readonly emailStatusDtoV2024: EmailStatusDtoV2024 -} - -/** - * Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest - */ -export interface NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest { - /** - * - * @type {Array} - * @memberof NotificationsV2024ApiDeleteNotificationTemplatesInBulk - */ - readonly templateBulkDeleteDtoV2024: Array -} - -/** - * Request parameters for deleteVerifiedFromAddress operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest - */ -export interface NotificationsV2024ApiDeleteVerifiedFromAddressRequest { - /** - * Unique identifier of the verified sender address to delete. - * @type {string} - * @memberof NotificationsV2024ApiDeleteVerifiedFromAddress - */ - readonly id: string -} - -/** - * Request parameters for getDkimAttributes operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiGetDkimAttributesRequest - */ -export interface NotificationsV2024ApiGetDkimAttributesRequest { - /** - * 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 NotificationsV2024ApiGetDkimAttributes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2024ApiGetDkimAttributes - */ - readonly offset?: number -} - -/** - * Request parameters for getMailFromAttributes operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiGetMailFromAttributesRequest - */ -export interface NotificationsV2024ApiGetMailFromAttributesRequest { - /** - * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @type {string} - * @memberof NotificationsV2024ApiGetMailFromAttributes - */ - readonly identity: string -} - -/** - * Request parameters for getNotificationTemplate operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiGetNotificationTemplateRequest - */ -export interface NotificationsV2024ApiGetNotificationTemplateRequest { - /** - * Id of the Notification Template - * @type {string} - * @memberof NotificationsV2024ApiGetNotificationTemplate - */ - readonly id: string -} - -/** - * Request parameters for listFromAddresses operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiListFromAddressesRequest - */ -export interface NotificationsV2024ApiListFromAddressesRequest { - /** - * 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 NotificationsV2024ApiListFromAddresses - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2024ApiListFromAddresses - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NotificationsV2024ApiListFromAddresses - */ - 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: **email**: *eq, ge, le, gt, lt* - * @type {string} - * @memberof NotificationsV2024ApiListFromAddresses - */ - 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: **email** - * @type {string} - * @memberof NotificationsV2024ApiListFromAddresses - */ - readonly sorters?: string -} - -/** - * Request parameters for listNotificationTemplateDefaults operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiListNotificationTemplateDefaultsRequest - */ -export interface NotificationsV2024ApiListNotificationTemplateDefaultsRequest { - /** - * 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 NotificationsV2024ApiListNotificationTemplateDefaults - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2024ApiListNotificationTemplateDefaults - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2024ApiListNotificationTemplateDefaults - */ - readonly filters?: string -} - -/** - * Request parameters for listNotificationTemplates operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiListNotificationTemplatesRequest - */ -export interface NotificationsV2024ApiListNotificationTemplatesRequest { - /** - * 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 NotificationsV2024ApiListNotificationTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2024ApiListNotificationTemplates - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2024ApiListNotificationTemplates - */ - 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: **key, name, medium** - * @type {string} - * @memberof NotificationsV2024ApiListNotificationTemplates - */ - readonly sorters?: string -} - -/** - * Request parameters for putMailFromAttributes operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiPutMailFromAttributesRequest - */ -export interface NotificationsV2024ApiPutMailFromAttributesRequest { - /** - * - * @type {MailFromAttributesDtoV2024} - * @memberof NotificationsV2024ApiPutMailFromAttributes - */ - readonly mailFromAttributesDtoV2024: MailFromAttributesDtoV2024 -} - -/** - * Request parameters for sendTestNotification operation in NotificationsV2024Api. - * @export - * @interface NotificationsV2024ApiSendTestNotificationRequest - */ -export interface NotificationsV2024ApiSendTestNotificationRequest { - /** - * - * @type {SendTestNotificationRequestDtoV2024} - * @memberof NotificationsV2024ApiSendTestNotification - */ - readonly sendTestNotificationRequestDtoV2024: SendTestNotificationRequestDtoV2024 -} - -/** - * NotificationsV2024Api - object-oriented interface - * @export - * @class NotificationsV2024Api - * @extends {BaseAPI} - */ -export class NotificationsV2024Api extends BaseAPI { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2024ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public createDomainDkim(requestParameters: NotificationsV2024ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).createDomainDkim(requestParameters.domainAddressV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2024ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public createNotificationTemplate(requestParameters: NotificationsV2024ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).createNotificationTemplate(requestParameters.templateDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2024ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public createVerifiedFromAddress(requestParameters: NotificationsV2024ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).createVerifiedFromAddress(requestParameters.emailStatusDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2024ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2024ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public deleteVerifiedFromAddress(requestParameters: NotificationsV2024ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2024ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public getDkimAttributes(requestParameters: NotificationsV2024ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2024ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public getMailFromAttributes(requestParameters: NotificationsV2024ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).getNotificationPreferences(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2024ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public getNotificationTemplate(requestParameters: NotificationsV2024ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).getNotificationsTemplateContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2024ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public listFromAddresses(requestParameters: NotificationsV2024ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2024ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public listNotificationTemplateDefaults(requestParameters: NotificationsV2024ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2024ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public listNotificationTemplates(requestParameters: NotificationsV2024ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2024ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public putMailFromAttributes(requestParameters: NotificationsV2024ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).putMailFromAttributes(requestParameters.mailFromAttributesDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2024ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2024Api - */ - public sendTestNotification(requestParameters: NotificationsV2024ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2024ApiFp(this.configuration).sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OAuthClientsV2024Api - axios parameter creator - * @export - */ -export const OAuthClientsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2024} createOAuthClientRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient: async (createOAuthClientRequestV2024: CreateOAuthClientRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createOAuthClientRequestV2024' is not null or undefined - assertParamExists('createOauthClient', 'createOAuthClientRequestV2024', createOAuthClientRequestV2024) - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2024 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchOauthClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchOauthClient', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OAuthClientsV2024Api - functional programming interface - * @export - */ -export const OAuthClientsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OAuthClientsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2024} createOAuthClientRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createOauthClient(createOAuthClientRequestV2024: CreateOAuthClientRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClient(createOAuthClientRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2024Api.createOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2024Api.deleteOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2024Api.getOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOauthClients(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClients(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2024Api.listOauthClients']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2024 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOauthClient(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClient(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2024Api.patchOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OAuthClientsV2024Api - factory interface - * @export - */ -export const OAuthClientsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OAuthClientsV2024ApiFp(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2024ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient(requestParameters: OAuthClientsV2024ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createOauthClient(requestParameters.createOAuthClientRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2024ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient(requestParameters: OAuthClientsV2024ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2024ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient(requestParameters: OAuthClientsV2024ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2024ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients(requestParameters: OAuthClientsV2024ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2024ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient(requestParameters: OAuthClientsV2024ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createOauthClient operation in OAuthClientsV2024Api. - * @export - * @interface OAuthClientsV2024ApiCreateOauthClientRequest - */ -export interface OAuthClientsV2024ApiCreateOauthClientRequest { - /** - * - * @type {CreateOAuthClientRequestV2024} - * @memberof OAuthClientsV2024ApiCreateOauthClient - */ - readonly createOAuthClientRequestV2024: CreateOAuthClientRequestV2024 -} - -/** - * Request parameters for deleteOauthClient operation in OAuthClientsV2024Api. - * @export - * @interface OAuthClientsV2024ApiDeleteOauthClientRequest - */ -export interface OAuthClientsV2024ApiDeleteOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2024ApiDeleteOauthClient - */ - readonly id: string -} - -/** - * Request parameters for getOauthClient operation in OAuthClientsV2024Api. - * @export - * @interface OAuthClientsV2024ApiGetOauthClientRequest - */ -export interface OAuthClientsV2024ApiGetOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2024ApiGetOauthClient - */ - readonly id: string -} - -/** - * Request parameters for listOauthClients operation in OAuthClientsV2024Api. - * @export - * @interface OAuthClientsV2024ApiListOauthClientsRequest - */ -export interface OAuthClientsV2024ApiListOauthClientsRequest { - /** - * 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof OAuthClientsV2024ApiListOauthClients - */ - readonly filters?: string -} - -/** - * Request parameters for patchOauthClient operation in OAuthClientsV2024Api. - * @export - * @interface OAuthClientsV2024ApiPatchOauthClientRequest - */ -export interface OAuthClientsV2024ApiPatchOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2024ApiPatchOauthClient - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @type {Array} - * @memberof OAuthClientsV2024ApiPatchOauthClient - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * OAuthClientsV2024Api - object-oriented interface - * @export - * @class OAuthClientsV2024Api - * @extends {BaseAPI} - */ -export class OAuthClientsV2024Api extends BaseAPI { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2024ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2024Api - */ - public createOauthClient(requestParameters: OAuthClientsV2024ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2024ApiFp(this.configuration).createOauthClient(requestParameters.createOAuthClientRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2024ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2024Api - */ - public deleteOauthClient(requestParameters: OAuthClientsV2024ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2024ApiFp(this.configuration).deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2024ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2024Api - */ - public getOauthClient(requestParameters: OAuthClientsV2024ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2024ApiFp(this.configuration).getOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2024ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2024Api - */ - public listOauthClients(requestParameters: OAuthClientsV2024ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2024ApiFp(this.configuration).listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2024ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2024Api - */ - public patchOauthClient(requestParameters: OAuthClientsV2024ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2024ApiFp(this.configuration).patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OrgConfigV2024Api - axios parameter creator - * @export - */ -export const OrgConfigV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones: async (xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/org-config/valid-time-zones`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2024 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig: async (jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchOrgConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OrgConfigV2024Api - functional programming interface - * @export - */ -export const OrgConfigV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrgConfigV2024ApiAxiosParamCreator(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOrgConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2024Api.getOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getValidTimeZones(xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZones(xSailPointExperimental, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2024Api.getValidTimeZones']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2024 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOrgConfig(jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfig(jsonPatchOperationV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2024Api.patchOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OrgConfigV2024Api - factory interface - * @export - */ -export const OrgConfigV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrgConfigV2024ApiFp(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {OrgConfigV2024ApiGetOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig(requestParameters: OrgConfigV2024ApiGetOrgConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOrgConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2024ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones(requestParameters: OrgConfigV2024ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2024ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig(requestParameters: OrgConfigV2024ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOrgConfig(requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getOrgConfig operation in OrgConfigV2024Api. - * @export - * @interface OrgConfigV2024ApiGetOrgConfigRequest - */ -export interface OrgConfigV2024ApiGetOrgConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof OrgConfigV2024ApiGetOrgConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getValidTimeZones operation in OrgConfigV2024Api. - * @export - * @interface OrgConfigV2024ApiGetValidTimeZonesRequest - */ -export interface OrgConfigV2024ApiGetValidTimeZonesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof OrgConfigV2024ApiGetValidTimeZones - */ - readonly xSailPointExperimental?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2024ApiGetValidTimeZones - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2024ApiGetValidTimeZones - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof OrgConfigV2024ApiGetValidTimeZones - */ - readonly count?: boolean -} - -/** - * Request parameters for patchOrgConfig operation in OrgConfigV2024Api. - * @export - * @interface OrgConfigV2024ApiPatchOrgConfigRequest - */ -export interface OrgConfigV2024ApiPatchOrgConfigRequest { - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof OrgConfigV2024ApiPatchOrgConfig - */ - readonly jsonPatchOperationV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof OrgConfigV2024ApiPatchOrgConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * OrgConfigV2024Api - object-oriented interface - * @export - * @class OrgConfigV2024Api - * @extends {BaseAPI} - */ -export class OrgConfigV2024Api extends BaseAPI { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {OrgConfigV2024ApiGetOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2024Api - */ - public getOrgConfig(requestParameters: OrgConfigV2024ApiGetOrgConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2024ApiFp(this.configuration).getOrgConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2024ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2024Api - */ - public getValidTimeZones(requestParameters: OrgConfigV2024ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2024ApiFp(this.configuration).getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2024ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2024Api - */ - public patchOrgConfig(requestParameters: OrgConfigV2024ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2024ApiFp(this.configuration).patchOrgConfig(requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordConfigurationV2024Api - axios parameter creator - * @export - */ -export const PasswordConfigurationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2024} passwordOrgConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig: async (passwordOrgConfigV2024: PasswordOrgConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2024' is not null or undefined - assertParamExists('createPasswordOrgConfig', 'passwordOrgConfigV2024', passwordOrgConfigV2024) - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2024} passwordOrgConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig: async (passwordOrgConfigV2024: PasswordOrgConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2024' is not null or undefined - assertParamExists('putPasswordOrgConfig', 'passwordOrgConfigV2024', passwordOrgConfigV2024) - const localVarPath = `/password-org-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordConfigurationV2024Api - functional programming interface - * @export - */ -export const PasswordConfigurationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordConfigurationV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2024} passwordOrgConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordOrgConfig(passwordOrgConfigV2024: PasswordOrgConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfig(passwordOrgConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2024Api.createPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2024Api.getPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2024} passwordOrgConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordOrgConfig(passwordOrgConfigV2024: PasswordOrgConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfig(passwordOrgConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2024Api.putPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordConfigurationV2024Api - factory interface - * @export - */ -export const PasswordConfigurationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordConfigurationV2024ApiFp(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig(requestParameters: PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordOrgConfig(requestParameters.passwordOrgConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig(requestParameters: PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordOrgConfig(requestParameters.passwordOrgConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordOrgConfig operation in PasswordConfigurationV2024Api. - * @export - * @interface PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2024} - * @memberof PasswordConfigurationV2024ApiCreatePasswordOrgConfig - */ - readonly passwordOrgConfigV2024: PasswordOrgConfigV2024 -} - -/** - * Request parameters for putPasswordOrgConfig operation in PasswordConfigurationV2024Api. - * @export - * @interface PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2024} - * @memberof PasswordConfigurationV2024ApiPutPasswordOrgConfig - */ - readonly passwordOrgConfigV2024: PasswordOrgConfigV2024 -} - -/** - * PasswordConfigurationV2024Api - object-oriented interface - * @export - * @class PasswordConfigurationV2024Api - * @extends {BaseAPI} - */ -export class PasswordConfigurationV2024Api extends BaseAPI { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2024Api - */ - public createPasswordOrgConfig(requestParameters: PasswordConfigurationV2024ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2024ApiFp(this.configuration).createPasswordOrgConfig(requestParameters.passwordOrgConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2024Api - */ - public getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2024ApiFp(this.configuration).getPasswordOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2024Api - */ - public putPasswordOrgConfig(requestParameters: PasswordConfigurationV2024ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2024ApiFp(this.configuration).putPasswordOrgConfig(requestParameters.passwordOrgConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordDictionaryV2024Api - axios parameter creator - * @export - */ -export const PasswordDictionaryV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordDictionaryV2024Api - functional programming interface - * @export - */ -export const PasswordDictionaryV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordDictionaryV2024ApiAxiosParamCreator(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2024Api.getPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordDictionary(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionary(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2024Api.putPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordDictionaryV2024Api - factory interface - * @export - */ -export const PasswordDictionaryV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordDictionaryV2024ApiFp(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordDictionary(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2024ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary(requestParameters: PasswordDictionaryV2024ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for putPasswordDictionary operation in PasswordDictionaryV2024Api. - * @export - * @interface PasswordDictionaryV2024ApiPutPasswordDictionaryRequest - */ -export interface PasswordDictionaryV2024ApiPutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PasswordDictionaryV2024ApiPutPasswordDictionary - */ - readonly file?: File -} - -/** - * PasswordDictionaryV2024Api - object-oriented interface - * @export - * @class PasswordDictionaryV2024Api - * @extends {BaseAPI} - */ -export class PasswordDictionaryV2024Api extends BaseAPI { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2024Api - */ - public getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2024ApiFp(this.configuration).getPasswordDictionary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2024ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2024Api - */ - public putPasswordDictionary(requestParameters: PasswordDictionaryV2024ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2024ApiFp(this.configuration).putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordManagementV2024Api - axios parameter creator - * @export - */ -export const PasswordManagementV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2024} passwordDigitTokenResetV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken: async (passwordDigitTokenResetV2024: PasswordDigitTokenResetV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordDigitTokenResetV2024' is not null or undefined - assertParamExists('createDigitToken', 'passwordDigitTokenResetV2024', passwordDigitTokenResetV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/generate-password-reset-token/digit`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordDigitTokenResetV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordChangeStatus', 'id', id) - const localVarPath = `/password-change-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2024} passwordInfoQueryDTOV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo: async (passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordInfoQueryDTOV2024' is not null or undefined - assertParamExists('queryPasswordInfo', 'passwordInfoQueryDTOV2024', passwordInfoQueryDTOV2024) - const localVarPath = `/query-password-info`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordInfoQueryDTOV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword: async (passwordChangeRequestV2024: PasswordChangeRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordChangeRequestV2024' is not null or undefined - assertParamExists('setPassword', 'passwordChangeRequestV2024', passwordChangeRequestV2024) - const localVarPath = `/set-password`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordChangeRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordManagementV2024Api - functional programming interface - * @export - */ -export const PasswordManagementV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordManagementV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2024} passwordDigitTokenResetV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDigitToken(passwordDigitTokenResetV2024: PasswordDigitTokenResetV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDigitToken(passwordDigitTokenResetV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2024Api.createDigitToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordChangeStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordChangeStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2024Api.getPasswordChangeStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2024} passwordInfoQueryDTOV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async queryPasswordInfo(passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfo(passwordInfoQueryDTOV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2024Api.queryPasswordInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2024} passwordChangeRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPassword(passwordChangeRequestV2024: PasswordChangeRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPassword(passwordChangeRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2024Api.setPassword']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordManagementV2024Api - factory interface - * @export - */ -export const PasswordManagementV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordManagementV2024ApiFp(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2024ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken(requestParameters: PasswordManagementV2024ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDigitToken(requestParameters.passwordDigitTokenResetV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2024ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus(requestParameters: PasswordManagementV2024ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2024ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo(requestParameters: PasswordManagementV2024ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2024ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword(requestParameters: PasswordManagementV2024ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPassword(requestParameters.passwordChangeRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDigitToken operation in PasswordManagementV2024Api. - * @export - * @interface PasswordManagementV2024ApiCreateDigitTokenRequest - */ -export interface PasswordManagementV2024ApiCreateDigitTokenRequest { - /** - * - * @type {PasswordDigitTokenResetV2024} - * @memberof PasswordManagementV2024ApiCreateDigitToken - */ - readonly passwordDigitTokenResetV2024: PasswordDigitTokenResetV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordManagementV2024ApiCreateDigitToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPasswordChangeStatus operation in PasswordManagementV2024Api. - * @export - * @interface PasswordManagementV2024ApiGetPasswordChangeStatusRequest - */ -export interface PasswordManagementV2024ApiGetPasswordChangeStatusRequest { - /** - * Password change request ID - * @type {string} - * @memberof PasswordManagementV2024ApiGetPasswordChangeStatus - */ - readonly id: string -} - -/** - * Request parameters for queryPasswordInfo operation in PasswordManagementV2024Api. - * @export - * @interface PasswordManagementV2024ApiQueryPasswordInfoRequest - */ -export interface PasswordManagementV2024ApiQueryPasswordInfoRequest { - /** - * - * @type {PasswordInfoQueryDTOV2024} - * @memberof PasswordManagementV2024ApiQueryPasswordInfo - */ - readonly passwordInfoQueryDTOV2024: PasswordInfoQueryDTOV2024 -} - -/** - * Request parameters for setPassword operation in PasswordManagementV2024Api. - * @export - * @interface PasswordManagementV2024ApiSetPasswordRequest - */ -export interface PasswordManagementV2024ApiSetPasswordRequest { - /** - * - * @type {PasswordChangeRequestV2024} - * @memberof PasswordManagementV2024ApiSetPassword - */ - readonly passwordChangeRequestV2024: PasswordChangeRequestV2024 -} - -/** - * PasswordManagementV2024Api - object-oriented interface - * @export - * @class PasswordManagementV2024Api - * @extends {BaseAPI} - */ -export class PasswordManagementV2024Api extends BaseAPI { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2024ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2024Api - */ - public createDigitToken(requestParameters: PasswordManagementV2024ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2024ApiFp(this.configuration).createDigitToken(requestParameters.passwordDigitTokenResetV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2024ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2024Api - */ - public getPasswordChangeStatus(requestParameters: PasswordManagementV2024ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2024ApiFp(this.configuration).getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2024ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2024Api - */ - public queryPasswordInfo(requestParameters: PasswordManagementV2024ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2024ApiFp(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2024ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2024Api - */ - public setPassword(requestParameters: PasswordManagementV2024ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2024ApiFp(this.configuration).setPassword(requestParameters.passwordChangeRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordPoliciesV2024Api - axios parameter creator - * @export - */ -export const PasswordPoliciesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2024} passwordPolicyV3DtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy: async (passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordPolicyV3DtoV2024' is not null or undefined - assertParamExists('createPasswordPolicy', 'passwordPolicyV3DtoV2024', passwordPolicyV3DtoV2024) - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordPolicy', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordPolicyById', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2024} passwordPolicyV3DtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy: async (id: string, passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setPasswordPolicy', 'id', id) - // verify required parameter 'passwordPolicyV3DtoV2024' is not null or undefined - assertParamExists('setPasswordPolicy', 'passwordPolicyV3DtoV2024', passwordPolicyV3DtoV2024) - const localVarPath = `/password-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordPoliciesV2024Api - functional programming interface - * @export - */ -export const PasswordPoliciesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordPoliciesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2024} passwordPolicyV3DtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordPolicy(passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicy(passwordPolicyV3DtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2024Api.createPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2024Api.deletePasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordPolicyById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2024Api.getPasswordPolicyById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicies(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicies(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2024Api.listPasswordPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2024} passwordPolicyV3DtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPasswordPolicy(id: string, passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicy(id, passwordPolicyV3DtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2024Api.setPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordPoliciesV2024Api - factory interface - * @export - */ -export const PasswordPoliciesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordPoliciesV2024ApiFp(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2024ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy(requestParameters: PasswordPoliciesV2024ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2024ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy(requestParameters: PasswordPoliciesV2024ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById(requestParameters: PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2024ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies(requestParameters: PasswordPoliciesV2024ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2024ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy(requestParameters: PasswordPoliciesV2024ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordPolicy operation in PasswordPoliciesV2024Api. - * @export - * @interface PasswordPoliciesV2024ApiCreatePasswordPolicyRequest - */ -export interface PasswordPoliciesV2024ApiCreatePasswordPolicyRequest { - /** - * - * @type {PasswordPolicyV3DtoV2024} - * @memberof PasswordPoliciesV2024ApiCreatePasswordPolicy - */ - readonly passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024 -} - -/** - * Request parameters for deletePasswordPolicy operation in PasswordPoliciesV2024Api. - * @export - * @interface PasswordPoliciesV2024ApiDeletePasswordPolicyRequest - */ -export interface PasswordPoliciesV2024ApiDeletePasswordPolicyRequest { - /** - * The ID of password policy to delete. - * @type {string} - * @memberof PasswordPoliciesV2024ApiDeletePasswordPolicy - */ - readonly id: string -} - -/** - * Request parameters for getPasswordPolicyById operation in PasswordPoliciesV2024Api. - * @export - * @interface PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest - */ -export interface PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest { - /** - * The ID of password policy to retrieve. - * @type {string} - * @memberof PasswordPoliciesV2024ApiGetPasswordPolicyById - */ - readonly id: string -} - -/** - * Request parameters for listPasswordPolicies operation in PasswordPoliciesV2024Api. - * @export - * @interface PasswordPoliciesV2024ApiListPasswordPoliciesRequest - */ -export interface PasswordPoliciesV2024ApiListPasswordPoliciesRequest { - /** - * 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 PasswordPoliciesV2024ApiListPasswordPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordPoliciesV2024ApiListPasswordPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordPoliciesV2024ApiListPasswordPolicies - */ - readonly count?: boolean -} - -/** - * Request parameters for setPasswordPolicy operation in PasswordPoliciesV2024Api. - * @export - * @interface PasswordPoliciesV2024ApiSetPasswordPolicyRequest - */ -export interface PasswordPoliciesV2024ApiSetPasswordPolicyRequest { - /** - * The ID of password policy to update. - * @type {string} - * @memberof PasswordPoliciesV2024ApiSetPasswordPolicy - */ - readonly id: string - - /** - * - * @type {PasswordPolicyV3DtoV2024} - * @memberof PasswordPoliciesV2024ApiSetPasswordPolicy - */ - readonly passwordPolicyV3DtoV2024: PasswordPolicyV3DtoV2024 -} - -/** - * PasswordPoliciesV2024Api - object-oriented interface - * @export - * @class PasswordPoliciesV2024Api - * @extends {BaseAPI} - */ -export class PasswordPoliciesV2024Api extends BaseAPI { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2024ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2024Api - */ - public createPasswordPolicy(requestParameters: PasswordPoliciesV2024ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2024ApiFp(this.configuration).createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2024ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2024Api - */ - public deletePasswordPolicy(requestParameters: PasswordPoliciesV2024ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2024ApiFp(this.configuration).deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2024Api - */ - public getPasswordPolicyById(requestParameters: PasswordPoliciesV2024ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2024ApiFp(this.configuration).getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2024ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2024Api - */ - public listPasswordPolicies(requestParameters: PasswordPoliciesV2024ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2024ApiFp(this.configuration).listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2024ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2024Api - */ - public setPasswordPolicy(requestParameters: PasswordPoliciesV2024ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2024ApiFp(this.configuration).setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordSyncGroupsV2024Api - axios parameter creator - * @export - */ -export const PasswordSyncGroupsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2024} passwordSyncGroupV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup: async (passwordSyncGroupV2024: PasswordSyncGroupV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordSyncGroupV2024' is not null or undefined - assertParamExists('createPasswordSyncGroup', 'passwordSyncGroupV2024', passwordSyncGroupV2024) - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2024} passwordSyncGroupV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup: async (id: string, passwordSyncGroupV2024: PasswordSyncGroupV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'id', id) - // verify required parameter 'passwordSyncGroupV2024' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'passwordSyncGroupV2024', passwordSyncGroupV2024) - const localVarPath = `/password-sync-groups/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordSyncGroupsV2024Api - functional programming interface - * @export - */ -export const PasswordSyncGroupsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordSyncGroupsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2024} passwordSyncGroupV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordSyncGroup(passwordSyncGroupV2024: PasswordSyncGroupV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroup(passwordSyncGroupV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2024Api.createPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2024Api.deletePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2024Api.getPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroups(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2024Api.getPasswordSyncGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2024} passwordSyncGroupV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordSyncGroup(id: string, passwordSyncGroupV2024: PasswordSyncGroupV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroup(id, passwordSyncGroupV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2024Api.updatePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordSyncGroupsV2024Api - factory interface - * @export - */ -export const PasswordSyncGroupsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordSyncGroupsV2024ApiFp(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordSyncGroup(requestParameters.passwordSyncGroupV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsV2024Api. - * @export - * @interface PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest { - /** - * - * @type {PasswordSyncGroupV2024} - * @memberof PasswordSyncGroupsV2024ApiCreatePasswordSyncGroup - */ - readonly passwordSyncGroupV2024: PasswordSyncGroupV2024 -} - -/** - * Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsV2024Api. - * @export - * @interface PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest { - /** - * The ID of password sync group to delete. - * @type {string} - * @memberof PasswordSyncGroupsV2024ApiDeletePasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsV2024Api. - * @export - * @interface PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest { - /** - * The ID of password sync group to retrieve. - * @type {string} - * @memberof PasswordSyncGroupsV2024ApiGetPasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsV2024Api. - * @export - * @interface PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest - */ -export interface PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest { - /** - * 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 PasswordSyncGroupsV2024ApiGetPasswordSyncGroups - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordSyncGroupsV2024ApiGetPasswordSyncGroups - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordSyncGroupsV2024ApiGetPasswordSyncGroups - */ - readonly count?: boolean -} - -/** - * Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsV2024Api. - * @export - * @interface PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest { - /** - * The ID of password sync group to update. - * @type {string} - * @memberof PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroup - */ - readonly id: string - - /** - * - * @type {PasswordSyncGroupV2024} - * @memberof PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroup - */ - readonly passwordSyncGroupV2024: PasswordSyncGroupV2024 -} - -/** - * PasswordSyncGroupsV2024Api - object-oriented interface - * @export - * @class PasswordSyncGroupsV2024Api - * @extends {BaseAPI} - */ -export class PasswordSyncGroupsV2024Api extends BaseAPI { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2024Api - */ - public createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2024ApiFp(this.configuration).createPasswordSyncGroup(requestParameters.passwordSyncGroupV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2024Api - */ - public deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2024ApiFp(this.configuration).deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2024Api - */ - public getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2024ApiFp(this.configuration).getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2024Api - */ - public getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2024ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2024ApiFp(this.configuration).getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2024Api - */ - public updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2024ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2024ApiFp(this.configuration).updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PersonalAccessTokensV2024Api - axios parameter creator - * @export - */ -export const PersonalAccessTokensV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2024} createPersonalAccessTokenRequestV2024 Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken: async (createPersonalAccessTokenRequestV2024: CreatePersonalAccessTokenRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPersonalAccessTokenRequestV2024' is not null or undefined - assertParamExists('createPersonalAccessToken', 'createPersonalAccessTokenRequestV2024', createPersonalAccessTokenRequestV2024) - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPersonalAccessTokenRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePersonalAccessToken', 'id', id) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2024 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PersonalAccessTokensV2024Api - functional programming interface - * @export - */ -export const PersonalAccessTokensV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PersonalAccessTokensV2024ApiAxiosParamCreator(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2024} createPersonalAccessTokenRequestV2024 Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPersonalAccessToken(createPersonalAccessTokenRequestV2024: CreatePersonalAccessTokenRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessToken(createPersonalAccessTokenRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2024Api.createPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePersonalAccessToken(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessToken(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2024Api.deletePersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokens(ownerId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2024Api.listPersonalAccessTokens']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2024 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPersonalAccessToken(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessToken(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2024Api.patchPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PersonalAccessTokensV2024Api - factory interface - * @export - */ -export const PersonalAccessTokensV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PersonalAccessTokensV2024ApiFp(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPersonalAccessToken operation in PersonalAccessTokensV2024Api. - * @export - * @interface PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest { - /** - * Name and scope of personal access token. - * @type {CreatePersonalAccessTokenRequestV2024} - * @memberof PersonalAccessTokensV2024ApiCreatePersonalAccessToken - */ - readonly createPersonalAccessTokenRequestV2024: CreatePersonalAccessTokenRequestV2024 -} - -/** - * Request parameters for deletePersonalAccessToken operation in PersonalAccessTokensV2024Api. - * @export - * @interface PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest { - /** - * The personal access token id - * @type {string} - * @memberof PersonalAccessTokensV2024ApiDeletePersonalAccessToken - */ - readonly id: string -} - -/** - * Request parameters for listPersonalAccessTokens operation in PersonalAccessTokensV2024Api. - * @export - * @interface PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest - */ -export interface PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest { - /** - * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @type {string} - * @memberof PersonalAccessTokensV2024ApiListPersonalAccessTokens - */ - readonly ownerId?: 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof PersonalAccessTokensV2024ApiListPersonalAccessTokens - */ - readonly filters?: string -} - -/** - * Request parameters for patchPersonalAccessToken operation in PersonalAccessTokensV2024Api. - * @export - * @interface PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest { - /** - * The Personal Access Token id - * @type {string} - * @memberof PersonalAccessTokensV2024ApiPatchPersonalAccessToken - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @type {Array} - * @memberof PersonalAccessTokensV2024ApiPatchPersonalAccessToken - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * PersonalAccessTokensV2024Api - object-oriented interface - * @export - * @class PersonalAccessTokensV2024Api - * @extends {BaseAPI} - */ -export class PersonalAccessTokensV2024Api extends BaseAPI { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2024Api - */ - public createPersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2024ApiFp(this.configuration).createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2024Api - */ - public deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2024ApiFp(this.configuration).deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2024Api - */ - public listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2024ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2024ApiFp(this.configuration).listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2024Api - */ - public patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2024ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2024ApiFp(this.configuration).patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesV2024Api - axios parameter creator - * @export - */ -export const PublicIdentitiesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities: async (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (addCoreFilters !== undefined) { - localVarQueryParameter['add-core-filters'] = addCoreFilters; - } - - 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, - }; - }, - } -}; - -/** - * PublicIdentitiesV2024Api - functional programming interface - * @export - */ -export const PublicIdentitiesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesV2024ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentities(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentities(limit, offset, count, filters, addCoreFilters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesV2024Api.getPublicIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesV2024Api - factory interface - * @export - */ -export const PublicIdentitiesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesV2024ApiFp(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2024ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities(requestParameters: PublicIdentitiesV2024ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPublicIdentities operation in PublicIdentitiesV2024Api. - * @export - * @interface PublicIdentitiesV2024ApiGetPublicIdentitiesRequest - */ -export interface PublicIdentitiesV2024ApiGetPublicIdentitiesRequest { - /** - * 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 PublicIdentitiesV2024ApiGetPublicIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PublicIdentitiesV2024ApiGetPublicIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PublicIdentitiesV2024ApiGetPublicIdentities - */ - 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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @type {string} - * @memberof PublicIdentitiesV2024ApiGetPublicIdentities - */ - readonly filters?: string - - /** - * If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @type {boolean} - * @memberof PublicIdentitiesV2024ApiGetPublicIdentities - */ - readonly addCoreFilters?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof PublicIdentitiesV2024ApiGetPublicIdentities - */ - readonly sorters?: string -} - -/** - * PublicIdentitiesV2024Api - object-oriented interface - * @export - * @class PublicIdentitiesV2024Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesV2024Api extends BaseAPI { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2024ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesV2024Api - */ - public getPublicIdentities(requestParameters: PublicIdentitiesV2024ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesV2024ApiFp(this.configuration).getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesConfigV2024Api - axios parameter creator - * @export - */ -export const PublicIdentitiesConfigV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2024} publicIdentityConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig: async (publicIdentityConfigV2024: PublicIdentityConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'publicIdentityConfigV2024' is not null or undefined - assertParamExists('updatePublicIdentityConfig', 'publicIdentityConfigV2024', publicIdentityConfigV2024) - const localVarPath = `/public-identities-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(publicIdentityConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PublicIdentitiesConfigV2024Api - functional programming interface - * @export - */ -export const PublicIdentitiesConfigV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesConfigV2024ApiAxiosParamCreator(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2024Api.getPublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2024} publicIdentityConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePublicIdentityConfig(publicIdentityConfigV2024: PublicIdentityConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfig(publicIdentityConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2024Api.updatePublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesConfigV2024Api - factory interface - * @export - */ -export const PublicIdentitiesConfigV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesConfigV2024ApiFp(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPublicIdentityConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updatePublicIdentityConfig operation in PublicIdentitiesConfigV2024Api. - * @export - * @interface PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest - */ -export interface PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest { - /** - * - * @type {PublicIdentityConfigV2024} - * @memberof PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfig - */ - readonly publicIdentityConfigV2024: PublicIdentityConfigV2024 -} - -/** - * PublicIdentitiesConfigV2024Api - object-oriented interface - * @export - * @class PublicIdentitiesConfigV2024Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesConfigV2024Api extends BaseAPI { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2024Api - */ - public getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2024ApiFp(this.configuration).getPublicIdentityConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2024Api - */ - public updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2024ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2024ApiFp(this.configuration).updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ReportsDataExtractionV2024Api - axios parameter creator - * @export - */ -export const ReportsDataExtractionV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelReport', 'id', id) - const localVarPath = `/reports/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2024} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport: async (taskResultId: string, fileFormat: GetReportFileFormatV2024, name?: string, auditable?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReport', 'taskResultId', taskResultId) - // verify required parameter 'fileFormat' is not null or undefined - assertParamExists('getReport', 'fileFormat', fileFormat) - const localVarPath = `/reports/{taskResultId}` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (fileFormat !== undefined) { - localVarQueryParameter['fileFormat'] = fileFormat; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (auditable !== undefined) { - localVarQueryParameter['auditable'] = auditable; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult: async (taskResultId: string, completed?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReportResult', 'taskResultId', taskResultId) - const localVarPath = `/reports/{taskResultId}/result` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (completed !== undefined) { - localVarQueryParameter['completed'] = completed; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2024} reportDetailsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport: async (reportDetailsV2024: ReportDetailsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportDetailsV2024' is not null or undefined - assertParamExists('startReport', 'reportDetailsV2024', reportDetailsV2024) - const localVarPath = `/reports/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reportDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ReportsDataExtractionV2024Api - functional programming interface - * @export - */ -export const ReportsDataExtractionV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ReportsDataExtractionV2024ApiAxiosParamCreator(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelReport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2024Api.cancelReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2024} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReport(taskResultId: string, fileFormat: GetReportFileFormatV2024, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(taskResultId, fileFormat, name, auditable, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2024Api.getReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReportResult(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReportResult(taskResultId, completed, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2024Api.getReportResult']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2024} reportDetailsV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startReport(reportDetailsV2024: ReportDetailsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startReport(reportDetailsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2024Api.startReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ReportsDataExtractionV2024Api - factory interface - * @export - */ -export const ReportsDataExtractionV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ReportsDataExtractionV2024ApiFp(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2024ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport(requestParameters: ReportsDataExtractionV2024ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelReport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2024ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport(requestParameters: ReportsDataExtractionV2024ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2024ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult(requestParameters: ReportsDataExtractionV2024ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2024ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport(requestParameters: ReportsDataExtractionV2024ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startReport(requestParameters.reportDetailsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelReport operation in ReportsDataExtractionV2024Api. - * @export - * @interface ReportsDataExtractionV2024ApiCancelReportRequest - */ -export interface ReportsDataExtractionV2024ApiCancelReportRequest { - /** - * ID of the running Report to cancel - * @type {string} - * @memberof ReportsDataExtractionV2024ApiCancelReport - */ - readonly id: string -} - -/** - * Request parameters for getReport operation in ReportsDataExtractionV2024Api. - * @export - * @interface ReportsDataExtractionV2024ApiGetReportRequest - */ -export interface ReportsDataExtractionV2024ApiGetReportRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2024ApiGetReport - */ - readonly taskResultId: string - - /** - * Output format of the requested report file - * @type {'csv' | 'pdf'} - * @memberof ReportsDataExtractionV2024ApiGetReport - */ - readonly fileFormat: GetReportFileFormatV2024 - - /** - * preferred Report file name, by default will be used report name from task result. - * @type {string} - * @memberof ReportsDataExtractionV2024ApiGetReport - */ - readonly name?: string - - /** - * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @type {boolean} - * @memberof ReportsDataExtractionV2024ApiGetReport - */ - readonly auditable?: boolean -} - -/** - * Request parameters for getReportResult operation in ReportsDataExtractionV2024Api. - * @export - * @interface ReportsDataExtractionV2024ApiGetReportResultRequest - */ -export interface ReportsDataExtractionV2024ApiGetReportResultRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2024ApiGetReportResult - */ - readonly taskResultId: string - - /** - * state of task result to apply ordering when results are fetching from the DB - * @type {boolean} - * @memberof ReportsDataExtractionV2024ApiGetReportResult - */ - readonly completed?: boolean -} - -/** - * Request parameters for startReport operation in ReportsDataExtractionV2024Api. - * @export - * @interface ReportsDataExtractionV2024ApiStartReportRequest - */ -export interface ReportsDataExtractionV2024ApiStartReportRequest { - /** - * - * @type {ReportDetailsV2024} - * @memberof ReportsDataExtractionV2024ApiStartReport - */ - readonly reportDetailsV2024: ReportDetailsV2024 -} - -/** - * ReportsDataExtractionV2024Api - object-oriented interface - * @export - * @class ReportsDataExtractionV2024Api - * @extends {BaseAPI} - */ -export class ReportsDataExtractionV2024Api extends BaseAPI { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2024ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2024Api - */ - public cancelReport(requestParameters: ReportsDataExtractionV2024ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2024ApiFp(this.configuration).cancelReport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2024ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2024Api - */ - public getReport(requestParameters: ReportsDataExtractionV2024ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2024ApiFp(this.configuration).getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2024ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2024Api - */ - public getReportResult(requestParameters: ReportsDataExtractionV2024ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2024ApiFp(this.configuration).getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2024ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2024Api - */ - public startReport(requestParameters: ReportsDataExtractionV2024ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2024ApiFp(this.configuration).startReport(requestParameters.reportDetailsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetReportFileFormatV2024 = { - Csv: 'csv', - Pdf: 'pdf' -} as const; -export type GetReportFileFormatV2024 = typeof GetReportFileFormatV2024[keyof typeof GetReportFileFormatV2024]; - - -/** - * RequestableObjectsV2024Api - axios parameter creator - * @export - */ -export const RequestableObjectsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/requestable-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (types) { - localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); - } - - if (term !== undefined) { - localVarQueryParameter['term'] = term; - } - - if (statuses) { - localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * RequestableObjectsV2024Api - functional programming interface - * @export - */ -export const RequestableObjectsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RequestableObjectsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRequestableObjects(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjects(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RequestableObjectsV2024Api.listRequestableObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RequestableObjectsV2024Api - factory interface - * @export - */ -export const RequestableObjectsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RequestableObjectsV2024ApiFp(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2024ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects(requestParameters: RequestableObjectsV2024ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listRequestableObjects operation in RequestableObjectsV2024Api. - * @export - * @interface RequestableObjectsV2024ApiListRequestableObjectsRequest - */ -export interface RequestableObjectsV2024ApiListRequestableObjectsRequest { - /** - * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @type {string} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly identityId?: string - - /** - * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly types?: Array - - /** - * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @type {string} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly term?: string - - /** - * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @type {Array} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly statuses?: Array - - /** - * 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 RequestableObjectsV2024ApiListRequestableObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - 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: **name** - * @type {string} - * @memberof RequestableObjectsV2024ApiListRequestableObjects - */ - readonly sorters?: string -} - -/** - * RequestableObjectsV2024Api - object-oriented interface - * @export - * @class RequestableObjectsV2024Api - * @extends {BaseAPI} - */ -export class RequestableObjectsV2024Api extends BaseAPI { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2024ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RequestableObjectsV2024Api - */ - public listRequestableObjects(requestParameters: RequestableObjectsV2024ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RequestableObjectsV2024ApiFp(this.configuration).listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListRequestableObjectsTypesV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type ListRequestableObjectsTypesV2024 = typeof ListRequestableObjectsTypesV2024[keyof typeof ListRequestableObjectsTypesV2024]; - - -/** - * RoleInsightsV2024Api - axios parameter creator - * @export - */ -export const RoleInsightsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('downloadRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/download` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'insightId', insightId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'entitlementId', entitlementId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (hasEntitlement !== undefined) { - localVarQueryParameter['hasEntitlement'] = hasEntitlement; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight: async (insightId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsight', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements: async (insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsCurrentEntitlements', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/current-entitlements` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleInsightsRequests', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RoleInsightsV2024Api - functional programming interface - * @export - */ -export const RoleInsightsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RoleInsightsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createRoleInsightRequests(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequests(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.createRoleInsightRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.downloadRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementChangesIdentities(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentities(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getEntitlementChangesIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsight(insightId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsight(insightId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsight']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsights(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsights(offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsights']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsCurrentEntitlements(insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlements(insightId, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsightsCurrentEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getRoleInsightsRequests(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequests(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsightsRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsSummary(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummary(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2024Api.getRoleInsightsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RoleInsightsV2024Api - factory interface - * @export - */ -export const RoleInsightsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RoleInsightsV2024ApiFp(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2024ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests(requestParameters: RoleInsightsV2024ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities(requestParameters: RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2024ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight(requestParameters: RoleInsightsV2024ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2024ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights(requestParameters: RoleInsightsV2024ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2024ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests(requestParameters: RoleInsightsV2024ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2024ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary(requestParameters: RoleInsightsV2024ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRoleInsightRequests operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiCreateRoleInsightRequestsRequest - */ -export interface RoleInsightsV2024ApiCreateRoleInsightRequestsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiCreateRoleInsightRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleInsightsEntitlementsChanges operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @type {string} - * @memberof RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementChangesIdentities operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest - */ -export interface RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly insightId: string - - /** - * The entitlement id - * @type {string} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly entitlementId: string - - /** - * Identity has this entitlement or not - * @type {boolean} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly hasEntitlement?: boolean - - /** - * 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 RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly count?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetEntitlementChangesIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsight operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsight - */ - readonly insightId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsight - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsights operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightsRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightsRequest { - /** - * 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 RoleInsightsV2024ApiGetRoleInsights - */ - 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 RoleInsightsV2024ApiGetRoleInsights - */ - 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 RoleInsightsV2024ApiGetRoleInsights - */ - readonly count?: boolean - - /** - * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsights - */ - readonly sorters?: 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsights - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsights - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsCurrentEntitlements operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlements - */ - readonly insightId: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlements - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsEntitlementsChanges operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess, name** - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsRequests operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightsRequestsRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightsRequestsRequest { - /** - * The role insights request id - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsRequests - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsSummary operation in RoleInsightsV2024Api. - * @export - * @interface RoleInsightsV2024ApiGetRoleInsightsSummaryRequest - */ -export interface RoleInsightsV2024ApiGetRoleInsightsSummaryRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2024ApiGetRoleInsightsSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * RoleInsightsV2024Api - object-oriented interface - * @export - * @class RoleInsightsV2024Api - * @extends {BaseAPI} - */ -export class RoleInsightsV2024Api extends BaseAPI { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2024ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public createRoleInsightRequests(requestParameters: RoleInsightsV2024ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2024ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getEntitlementChangesIdentities(requestParameters: RoleInsightsV2024ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2024ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsight(requestParameters: RoleInsightsV2024ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2024ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsights(requestParameters: RoleInsightsV2024ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2024ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2024ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2024ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsightsRequests(requestParameters: RoleInsightsV2024ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2024ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2024Api - */ - public getRoleInsightsSummary(requestParameters: RoleInsightsV2024ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2024ApiFp(this.configuration).getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolesV2024Api - axios parameter creator - * @export - */ -export const RolesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2024} roleV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole: async (roleV2024: RoleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleV2024' is not null or undefined - assertParamExists('createRole', 'roleV2024', roleV2024) - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2024} roleBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles: async (roleBulkDeleteRequestV2024: RoleBulkDeleteRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBulkDeleteRequestV2024' is not null or undefined - assertParamExists('deleteBulkRoles', 'roleBulkDeleteRequestV2024', roleBulkDeleteRequestV2024) - const localVarPath = `/roles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBulkDeleteRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/access-model-metadata/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getBulkUpdateStatusById', 'id', id) - const localVarPath = `/roles/access-model-metadata/bulk-update/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleAssignedIdentities', 'id', id) - const localVarPath = `/roles/{id}/assigned-identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleEntitlements', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/roles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchRole', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchRole', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2024} [roleListFilterDTOV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2024?: RoleListFilterDTOV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleListFilterDTOV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2024} roleMetadataBulkUpdateByFilterRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter: async (roleMetadataBulkUpdateByFilterRequestV2024: RoleMetadataBulkUpdateByFilterRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByFilterRequestV2024' is not null or undefined - assertParamExists('updateRolesMetadataByFilter', 'roleMetadataBulkUpdateByFilterRequestV2024', roleMetadataBulkUpdateByFilterRequestV2024) - const localVarPath = `/roles/access-model-metadata/bulk-update/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByFilterRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2024} roleMetadataBulkUpdateByIdRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds: async (roleMetadataBulkUpdateByIdRequestV2024: RoleMetadataBulkUpdateByIdRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByIdRequestV2024' is not null or undefined - assertParamExists('updateRolesMetadataByIds', 'roleMetadataBulkUpdateByIdRequestV2024', roleMetadataBulkUpdateByIdRequestV2024) - const localVarPath = `/roles/access-model-metadata/bulk-update/ids`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByIdRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2024} roleMetadataBulkUpdateByQueryRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery: async (roleMetadataBulkUpdateByQueryRequestV2024: RoleMetadataBulkUpdateByQueryRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByQueryRequestV2024' is not null or undefined - assertParamExists('updateRolesMetadataByQuery', 'roleMetadataBulkUpdateByQueryRequestV2024', roleMetadataBulkUpdateByQueryRequestV2024) - const localVarPath = `/roles/access-model-metadata/bulk-update/query`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByQueryRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolesV2024Api - functional programming interface - * @export - */ -export const RolesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2024} roleV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRole(roleV2024: RoleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRole(roleV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.createRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2024} roleBulkDeleteRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkRoles(roleBulkDeleteRequestV2024: RoleBulkDeleteRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRoles(roleBulkDeleteRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.deleteBulkRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMetadataFromRoleByKeyAndValue(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetadataFromRoleByKeyAndValue(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.deleteMetadataFromRoleByKeyAndValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.deleteRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.getBulkUpdateStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatusById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatusById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.getBulkUpdateStatusById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.getRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentities(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.getRoleAssignedIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleEntitlements(id, limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.getRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.listRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRole(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRole(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.patchRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2024} [roleListFilterDTOV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchRolesByFilter(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2024?: RoleListFilterDTOV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchRolesByFilter(forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, roleListFilterDTOV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.searchRolesByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAttributeKeyAndValueToRole(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAttributeKeyAndValueToRole(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.updateAttributeKeyAndValueToRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2024} roleMetadataBulkUpdateByFilterRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2024: RoleMetadataBulkUpdateByFilterRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.updateRolesMetadataByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2024} roleMetadataBulkUpdateByIdRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2024: RoleMetadataBulkUpdateByIdRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.updateRolesMetadataByIds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2024} roleMetadataBulkUpdateByQueryRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2024: RoleMetadataBulkUpdateByQueryRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2024Api.updateRolesMetadataByQuery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolesV2024Api - factory interface - * @export - */ -export const RolesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolesV2024ApiFp(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2024ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole(requestParameters: RolesV2024ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRole(requestParameters.roleV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2024ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles(requestParameters: RolesV2024ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2024ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole(requestParameters: RolesV2024ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBulkUpdateStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2024ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById(requestParameters: RolesV2024ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2024ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole(requestParameters: RolesV2024ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List identities assigned a role - * @param {RolesV2024ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities(requestParameters: RolesV2024ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2024ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements(requestParameters: RolesV2024ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2024ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles(requestParameters: RolesV2024ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2024ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole(requestParameters: RolesV2024ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2024ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter(requestParameters: RolesV2024ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole(requestParameters: RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2024ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter(requestParameters: RolesV2024ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2024ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds(requestParameters: RolesV2024ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2024ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery(requestParameters: RolesV2024ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRole operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiCreateRoleRequest - */ -export interface RolesV2024ApiCreateRoleRequest { - /** - * - * @type {RoleV2024} - * @memberof RolesV2024ApiCreateRole - */ - readonly roleV2024: RoleV2024 -} - -/** - * Request parameters for deleteBulkRoles operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiDeleteBulkRolesRequest - */ -export interface RolesV2024ApiDeleteBulkRolesRequest { - /** - * - * @type {RoleBulkDeleteRequestV2024} - * @memberof RolesV2024ApiDeleteBulkRoles - */ - readonly roleBulkDeleteRequestV2024: RoleBulkDeleteRequestV2024 -} - -/** - * Request parameters for deleteMetadataFromRoleByKeyAndValue operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest - */ -export interface RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest { - /** - * The role\'s id. - * @type {string} - * @memberof RolesV2024ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2024ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2024ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteRole operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiDeleteRoleRequest - */ -export interface RolesV2024ApiDeleteRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2024ApiDeleteRole - */ - readonly id: string -} - -/** - * Request parameters for getBulkUpdateStatusById operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiGetBulkUpdateStatusByIdRequest - */ -export interface RolesV2024ApiGetBulkUpdateStatusByIdRequest { - /** - * The Id of the bulk update task. - * @type {string} - * @memberof RolesV2024ApiGetBulkUpdateStatusById - */ - readonly id: string -} - -/** - * Request parameters for getRole operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiGetRoleRequest - */ -export interface RolesV2024ApiGetRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2024ApiGetRole - */ - readonly id: string -} - -/** - * Request parameters for getRoleAssignedIdentities operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiGetRoleAssignedIdentitiesRequest - */ -export interface RolesV2024ApiGetRoleAssignedIdentitiesRequest { - /** - * ID of the Role for which the assigned Identities are to be listed - * @type {string} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @type {string} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - 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, name, aliasName, email** - * @type {string} - * @memberof RolesV2024ApiGetRoleAssignedIdentities - */ - readonly sorters?: string -} - -/** - * Request parameters for getRoleEntitlements operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiGetRoleEntitlementsRequest - */ -export interface RolesV2024ApiGetRoleEntitlementsRequest { - /** - * Containing role\'s ID. - * @type {string} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - readonly id: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolesV2024ApiGetRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listRoles operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiListRolesRequest - */ -export interface RolesV2024ApiListRolesRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2024ApiListRoles - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiListRoles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiListRoles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2024ApiListRoles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @type {string} - * @memberof RolesV2024ApiListRoles - */ - 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: **name, created, modified** - * @type {string} - * @memberof RolesV2024ApiListRoles - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2024ApiListRoles - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2024ApiListRoles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchRole operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiPatchRoleRequest - */ -export interface RolesV2024ApiPatchRoleRequest { - /** - * ID of the Role to patch - * @type {string} - * @memberof RolesV2024ApiPatchRole - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof RolesV2024ApiPatchRole - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for searchRolesByFilter operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiSearchRolesByFilterRequest - */ -export interface RolesV2024ApiSearchRolesByFilterRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly forSubadmin?: string - - /** - * Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly includeUnsegmented?: boolean - - /** - * - * @type {RoleListFilterDTOV2024} - * @memberof RolesV2024ApiSearchRolesByFilter - */ - readonly roleListFilterDTOV2024?: RoleListFilterDTOV2024 -} - -/** - * Request parameters for updateAttributeKeyAndValueToRole operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest - */ -export interface RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest { - /** - * The Id of a role - * @type {string} - * @memberof RolesV2024ApiUpdateAttributeKeyAndValueToRole - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2024ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2024ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeValue: string -} - -/** - * Request parameters for updateRolesMetadataByFilter operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiUpdateRolesMetadataByFilterRequest - */ -export interface RolesV2024ApiUpdateRolesMetadataByFilterRequest { - /** - * - * @type {RoleMetadataBulkUpdateByFilterRequestV2024} - * @memberof RolesV2024ApiUpdateRolesMetadataByFilter - */ - readonly roleMetadataBulkUpdateByFilterRequestV2024: RoleMetadataBulkUpdateByFilterRequestV2024 -} - -/** - * Request parameters for updateRolesMetadataByIds operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiUpdateRolesMetadataByIdsRequest - */ -export interface RolesV2024ApiUpdateRolesMetadataByIdsRequest { - /** - * - * @type {RoleMetadataBulkUpdateByIdRequestV2024} - * @memberof RolesV2024ApiUpdateRolesMetadataByIds - */ - readonly roleMetadataBulkUpdateByIdRequestV2024: RoleMetadataBulkUpdateByIdRequestV2024 -} - -/** - * Request parameters for updateRolesMetadataByQuery operation in RolesV2024Api. - * @export - * @interface RolesV2024ApiUpdateRolesMetadataByQueryRequest - */ -export interface RolesV2024ApiUpdateRolesMetadataByQueryRequest { - /** - * - * @type {RoleMetadataBulkUpdateByQueryRequestV2024} - * @memberof RolesV2024ApiUpdateRolesMetadataByQuery - */ - readonly roleMetadataBulkUpdateByQueryRequestV2024: RoleMetadataBulkUpdateByQueryRequestV2024 -} - -/** - * RolesV2024Api - object-oriented interface - * @export - * @class RolesV2024Api - * @extends {BaseAPI} - */ -export class RolesV2024Api extends BaseAPI { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2024ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public createRole(requestParameters: RolesV2024ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).createRole(requestParameters.roleV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2024ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public deleteBulkRoles(requestParameters: RolesV2024ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2024ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2024ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public deleteRole(requestParameters: RolesV2024ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).deleteRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).getBulkUpdateStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2024ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public getBulkUpdateStatusById(requestParameters: RolesV2024ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2024ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public getRole(requestParameters: RolesV2024ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).getRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List identities assigned a role - * @param {RolesV2024ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public getRoleAssignedIdentities(requestParameters: RolesV2024ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2024ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public getRoleEntitlements(requestParameters: RolesV2024ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2024ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public listRoles(requestParameters: RolesV2024ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2024ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public patchRole(requestParameters: RolesV2024ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2024ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public searchRolesByFilter(requestParameters: RolesV2024ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public updateAttributeKeyAndValueToRole(requestParameters: RolesV2024ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2024ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public updateRolesMetadataByFilter(requestParameters: RolesV2024ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2024ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public updateRolesMetadataByIds(requestParameters: RolesV2024ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2024ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2024Api - */ - public updateRolesMetadataByQuery(requestParameters: RolesV2024ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2024ApiFp(this.configuration).updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SIMIntegrationsV2024Api - axios parameter creator - * @export - */ -export const SIMIntegrationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2024} simIntegrationDetailsV2024 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration: async (simIntegrationDetailsV2024: SimIntegrationDetailsV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'simIntegrationDetailsV2024' is not null or undefined - assertParamExists('createSIMIntegration', 'simIntegrationDetailsV2024', simIntegrationDetailsV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2024} jsonPatchV2024 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule: async (id: string, jsonPatchV2024: JsonPatchV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'id', id) - // verify required parameter 'jsonPatchV2024' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'jsonPatchV2024', jsonPatchV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{id}/beforeProvisioningRule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2024} jsonPatchV2024 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes: async (id: string, jsonPatchV2024: JsonPatchV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSIMAttributes', 'id', id) - // verify required parameter 'jsonPatchV2024' is not null or undefined - assertParamExists('patchSIMAttributes', 'jsonPatchV2024', jsonPatchV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2024} simIntegrationDetailsV2024 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration: async (id: string, simIntegrationDetailsV2024: SimIntegrationDetailsV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSIMIntegration', 'id', id) - // verify required parameter 'simIntegrationDetailsV2024' is not null or undefined - assertParamExists('putSIMIntegration', 'simIntegrationDetailsV2024', simIntegrationDetailsV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SIMIntegrationsV2024Api - functional programming interface - * @export - */ -export const SIMIntegrationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SIMIntegrationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2024} simIntegrationDetailsV2024 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSIMIntegration(simIntegrationDetailsV2024: SimIntegrationDetailsV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSIMIntegration(simIntegrationDetailsV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.createSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.deleteSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.getSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegrations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.getSIMIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2024} jsonPatchV2024 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchBeforeProvisioningRule(id: string, jsonPatchV2024: JsonPatchV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchBeforeProvisioningRule(id, jsonPatchV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.patchBeforeProvisioningRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2024} jsonPatchV2024 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSIMAttributes(id: string, jsonPatchV2024: JsonPatchV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSIMAttributes(id, jsonPatchV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.patchSIMAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2024} simIntegrationDetailsV2024 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSIMIntegration(id: string, simIntegrationDetailsV2024: SimIntegrationDetailsV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSIMIntegration(id, simIntegrationDetailsV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2024Api.putSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SIMIntegrationsV2024Api - factory interface - * @export - */ -export const SIMIntegrationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SIMIntegrationsV2024ApiFp(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2024ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration(requestParameters: SIMIntegrationsV2024ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSIMIntegration(requestParameters.simIntegrationDetailsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration(requestParameters: SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2024ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration(requestParameters: SIMIntegrationsV2024ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2024ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations(requestParameters: SIMIntegrationsV2024ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2024ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes(requestParameters: SIMIntegrationsV2024ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2024ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration(requestParameters: SIMIntegrationsV2024ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSIMIntegration operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiCreateSIMIntegrationRequest - */ -export interface SIMIntegrationsV2024ApiCreateSIMIntegrationRequest { - /** - * DTO containing the details of the SIM integration - * @type {SimIntegrationDetailsV2024} - * @memberof SIMIntegrationsV2024ApiCreateSIMIntegration - */ - readonly simIntegrationDetailsV2024: SimIntegrationDetailsV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiCreateSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSIMIntegration operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest - */ -export interface SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest { - /** - * The id of the integration to delete. - * @type {string} - * @memberof SIMIntegrationsV2024ApiDeleteSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiDeleteSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegration operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiGetSIMIntegrationRequest - */ -export interface SIMIntegrationsV2024ApiGetSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2024ApiGetSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiGetSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegrations operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiGetSIMIntegrationsRequest - */ -export interface SIMIntegrationsV2024ApiGetSIMIntegrationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiGetSIMIntegrations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchBeforeProvisioningRule operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest - */ -export interface SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2024ApiPatchBeforeProvisioningRule - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @type {JsonPatchV2024} - * @memberof SIMIntegrationsV2024ApiPatchBeforeProvisioningRule - */ - readonly jsonPatchV2024: JsonPatchV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiPatchBeforeProvisioningRule - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSIMAttributes operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiPatchSIMAttributesRequest - */ -export interface SIMIntegrationsV2024ApiPatchSIMAttributesRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2024ApiPatchSIMAttributes - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM - * @type {JsonPatchV2024} - * @memberof SIMIntegrationsV2024ApiPatchSIMAttributes - */ - readonly jsonPatchV2024: JsonPatchV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiPatchSIMAttributes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSIMIntegration operation in SIMIntegrationsV2024Api. - * @export - * @interface SIMIntegrationsV2024ApiPutSIMIntegrationRequest - */ -export interface SIMIntegrationsV2024ApiPutSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2024ApiPutSIMIntegration - */ - readonly id: string - - /** - * The full DTO of the integration containing the updated model - * @type {SimIntegrationDetailsV2024} - * @memberof SIMIntegrationsV2024ApiPutSIMIntegration - */ - readonly simIntegrationDetailsV2024: SimIntegrationDetailsV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2024ApiPutSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * SIMIntegrationsV2024Api - object-oriented interface - * @export - * @class SIMIntegrationsV2024Api - * @extends {BaseAPI} - */ -export class SIMIntegrationsV2024Api extends BaseAPI { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2024ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public createSIMIntegration(requestParameters: SIMIntegrationsV2024ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).createSIMIntegration(requestParameters.simIntegrationDetailsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public deleteSIMIntegration(requestParameters: SIMIntegrationsV2024ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2024ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public getSIMIntegration(requestParameters: SIMIntegrationsV2024ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2024ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public getSIMIntegrations(requestParameters: SIMIntegrationsV2024ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2024ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2024ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public patchSIMAttributes(requestParameters: SIMIntegrationsV2024ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2024ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2024Api - */ - public putSIMIntegration(requestParameters: SIMIntegrationsV2024ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2024ApiFp(this.configuration).putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODPoliciesV2024Api - axios parameter creator - * @export - */ -export const SODPoliciesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2024} sodPolicyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy: async (sodPolicyV2024: SodPolicyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sodPolicyV2024' is not null or undefined - assertParamExists('createSodPolicy', 'sodPolicyV2024', sodPolicyV2024) - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (logical !== undefined) { - localVarQueryParameter['logical'] = logical; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getCustomViolationReport', 'reportResultId', reportResultId) - // verify required parameter 'fileName' is not null or undefined - assertParamExists('getCustomViolationReport', 'fileName', fileName) - const localVarPath = `/sod-violation-report/{reportResultId}/download/{fileName}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) - .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getDefaultViolationReport', 'reportResultId', reportResultId) - const localVarPath = `/sod-violation-report/{reportResultId}/download` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getSodViolationReportRunStatus', 'reportResultId', reportResultId) - const localVarPath = `/sod-policies/sod-violation-report-status/{reportResultId}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodViolationReportStatus', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2024 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSodPolicy', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchSodPolicy', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2024} sodPolicyScheduleV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule: async (id: string, sodPolicyScheduleV2024: SodPolicyScheduleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putPolicySchedule', 'id', id) - // verify required parameter 'sodPolicyScheduleV2024' is not null or undefined - assertParamExists('putPolicySchedule', 'sodPolicyScheduleV2024', sodPolicyScheduleV2024) - const localVarPath = `/sod-policies/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyScheduleV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2024} sodPolicyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy: async (id: string, sodPolicyV2024: SodPolicyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSodPolicy', 'id', id) - // verify required parameter 'sodPolicyV2024' is not null or undefined - assertParamExists('putSodPolicy', 'sodPolicyV2024', sodPolicyV2024) - const localVarPath = `/sod-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startEvaluateSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/evaluate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2024} [multiPolicyRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg: async (multiPolicyRequestV2024?: MultiPolicyRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiPolicyRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report/run` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODPoliciesV2024Api - functional programming interface - * @export - */ -export const SODPoliciesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODPoliciesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2024} sodPolicyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSodPolicy(sodPolicyV2024: SodPolicyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.createSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicy(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicy(id, logical, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.deleteSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.deleteSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomViolationReport(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReport(reportResultId, fileName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getCustomViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultViolationReport(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReport(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getDefaultViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getSodAllReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportRunStatus(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatus(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getSodViolationReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.getSodViolationReportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.listSodPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2024 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSodPolicy(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.patchSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2024} sodPolicyScheduleV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPolicySchedule(id: string, sodPolicyScheduleV2024: SodPolicyScheduleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicySchedule(id, sodPolicyScheduleV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.putPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2024} sodPolicyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSodPolicy(id: string, sodPolicyV2024: SodPolicyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.putSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startEvaluateSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startEvaluateSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.startEvaluateSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2024} [multiPolicyRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodAllPoliciesForOrg(multiPolicyRequestV2024?: MultiPolicyRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrg(multiPolicyRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.startSodAllPoliciesForOrg']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2024Api.startSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODPoliciesV2024Api - factory interface - * @export - */ -export const SODPoliciesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODPoliciesV2024ApiFp(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2024ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy(requestParameters: SODPoliciesV2024ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSodPolicy(requestParameters.sodPolicyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2024ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy(requestParameters: SODPoliciesV2024ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule(requestParameters: SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2024ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport(requestParameters: SODPoliciesV2024ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2024ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport(requestParameters: SODPoliciesV2024ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodAllReportRunStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2024ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy(requestParameters: SODPoliciesV2024ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2024ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule(requestParameters: SODPoliciesV2024ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus(requestParameters: SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2024ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus(requestParameters: SODPoliciesV2024ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2024ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies(requestParameters: SODPoliciesV2024ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2024ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy(requestParameters: SODPoliciesV2024ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2024ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule(requestParameters: SODPoliciesV2024ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2024ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy(requestParameters: SODPoliciesV2024ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2024ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy(requestParameters: SODPoliciesV2024ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2024ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy(requestParameters: SODPoliciesV2024ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiCreateSodPolicyRequest - */ -export interface SODPoliciesV2024ApiCreateSodPolicyRequest { - /** - * - * @type {SodPolicyV2024} - * @memberof SODPoliciesV2024ApiCreateSodPolicy - */ - readonly sodPolicyV2024: SodPolicyV2024 -} - -/** - * Request parameters for deleteSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiDeleteSodPolicyRequest - */ -export interface SODPoliciesV2024ApiDeleteSodPolicyRequest { - /** - * The ID of the SOD Policy to delete. - * @type {string} - * @memberof SODPoliciesV2024ApiDeleteSodPolicy - */ - readonly id: string - - /** - * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @type {boolean} - * @memberof SODPoliciesV2024ApiDeleteSodPolicy - */ - readonly logical?: boolean -} - -/** - * Request parameters for deleteSodPolicySchedule operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest - */ -export interface SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest { - /** - * The ID of the SOD policy the schedule must be deleted for. - * @type {string} - * @memberof SODPoliciesV2024ApiDeleteSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getCustomViolationReport operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetCustomViolationReportRequest - */ -export interface SODPoliciesV2024ApiGetCustomViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2024ApiGetCustomViolationReport - */ - readonly reportResultId: string - - /** - * Custom Name for the file. - * @type {string} - * @memberof SODPoliciesV2024ApiGetCustomViolationReport - */ - readonly fileName: string -} - -/** - * Request parameters for getDefaultViolationReport operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetDefaultViolationReportRequest - */ -export interface SODPoliciesV2024ApiGetDefaultViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2024ApiGetDefaultViolationReport - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetSodPolicyRequest - */ -export interface SODPoliciesV2024ApiGetSodPolicyRequest { - /** - * The ID of the SOD Policy to retrieve. - * @type {string} - * @memberof SODPoliciesV2024ApiGetSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for getSodPolicySchedule operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetSodPolicyScheduleRequest - */ -export interface SODPoliciesV2024ApiGetSodPolicyScheduleRequest { - /** - * The ID of the SOD policy schedule to retrieve. - * @type {string} - * @memberof SODPoliciesV2024ApiGetSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getSodViolationReportRunStatus operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest - */ -export interface SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest { - /** - * The ID of the report reference to retrieve. - * @type {string} - * @memberof SODPoliciesV2024ApiGetSodViolationReportRunStatus - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodViolationReportStatus operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiGetSodViolationReportStatusRequest - */ -export interface SODPoliciesV2024ApiGetSodViolationReportStatusRequest { - /** - * The ID of the violation report to retrieve status for. - * @type {string} - * @memberof SODPoliciesV2024ApiGetSodViolationReportStatus - */ - readonly id: string -} - -/** - * Request parameters for listSodPolicies operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiListSodPoliciesRequest - */ -export interface SODPoliciesV2024ApiListSodPoliciesRequest { - /** - * 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 SODPoliciesV2024ApiListSodPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SODPoliciesV2024ApiListSodPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SODPoliciesV2024ApiListSodPolicies - */ - 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, in* **name**: *eq, in* **state**: *eq, in* - * @type {string} - * @memberof SODPoliciesV2024ApiListSodPolicies - */ - 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, name, created, modified, description** - * @type {string} - * @memberof SODPoliciesV2024ApiListSodPolicies - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiPatchSodPolicyRequest - */ -export interface SODPoliciesV2024ApiPatchSodPolicyRequest { - /** - * The ID of the SOD policy being modified. - * @type {string} - * @memberof SODPoliciesV2024ApiPatchSodPolicy - */ - readonly id: string - - /** - * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @type {Array} - * @memberof SODPoliciesV2024ApiPatchSodPolicy - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for putPolicySchedule operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiPutPolicyScheduleRequest - */ -export interface SODPoliciesV2024ApiPutPolicyScheduleRequest { - /** - * The ID of the SOD policy to update its schedule. - * @type {string} - * @memberof SODPoliciesV2024ApiPutPolicySchedule - */ - readonly id: string - - /** - * - * @type {SodPolicyScheduleV2024} - * @memberof SODPoliciesV2024ApiPutPolicySchedule - */ - readonly sodPolicyScheduleV2024: SodPolicyScheduleV2024 -} - -/** - * Request parameters for putSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiPutSodPolicyRequest - */ -export interface SODPoliciesV2024ApiPutSodPolicyRequest { - /** - * The ID of the SOD policy to update. - * @type {string} - * @memberof SODPoliciesV2024ApiPutSodPolicy - */ - readonly id: string - - /** - * - * @type {SodPolicyV2024} - * @memberof SODPoliciesV2024ApiPutSodPolicy - */ - readonly sodPolicyV2024: SodPolicyV2024 -} - -/** - * Request parameters for startEvaluateSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiStartEvaluateSodPolicyRequest - */ -export interface SODPoliciesV2024ApiStartEvaluateSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2024ApiStartEvaluateSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for startSodAllPoliciesForOrg operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest - */ -export interface SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest { - /** - * - * @type {MultiPolicyRequestV2024} - * @memberof SODPoliciesV2024ApiStartSodAllPoliciesForOrg - */ - readonly multiPolicyRequestV2024?: MultiPolicyRequestV2024 -} - -/** - * Request parameters for startSodPolicy operation in SODPoliciesV2024Api. - * @export - * @interface SODPoliciesV2024ApiStartSodPolicyRequest - */ -export interface SODPoliciesV2024ApiStartSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2024ApiStartSodPolicy - */ - readonly id: string -} - -/** - * SODPoliciesV2024Api - object-oriented interface - * @export - * @class SODPoliciesV2024Api - * @extends {BaseAPI} - */ -export class SODPoliciesV2024Api extends BaseAPI { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2024ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public createSodPolicy(requestParameters: SODPoliciesV2024ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2024ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public deleteSodPolicy(requestParameters: SODPoliciesV2024ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public deleteSodPolicySchedule(requestParameters: SODPoliciesV2024ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2024ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getCustomViolationReport(requestParameters: SODPoliciesV2024ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2024ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getDefaultViolationReport(requestParameters: SODPoliciesV2024ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getSodAllReportRunStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2024ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getSodPolicy(requestParameters: SODPoliciesV2024ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2024ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getSodPolicySchedule(requestParameters: SODPoliciesV2024ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getSodViolationReportRunStatus(requestParameters: SODPoliciesV2024ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2024ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public getSodViolationReportStatus(requestParameters: SODPoliciesV2024ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2024ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public listSodPolicies(requestParameters: SODPoliciesV2024ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2024ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public patchSodPolicy(requestParameters: SODPoliciesV2024ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2024ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public putPolicySchedule(requestParameters: SODPoliciesV2024ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2024ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public putSodPolicy(requestParameters: SODPoliciesV2024ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2024ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public startEvaluateSodPolicy(requestParameters: SODPoliciesV2024ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2024ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2024ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2024Api - */ - public startSodPolicy(requestParameters: SODPoliciesV2024ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2024ApiFp(this.configuration).startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODViolationsV2024Api - axios parameter creator - * @export - */ -export const SODViolationsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2024} identityWithNewAccessV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations: async (identityWithNewAccessV2024: IdentityWithNewAccessV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2024' is not null or undefined - assertParamExists('startPredictSodViolations', 'identityWithNewAccessV2024', identityWithNewAccessV2024) - const localVarPath = `/sod-violations/predict`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2024} identityWithNewAccessV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck: async (identityWithNewAccessV2024: IdentityWithNewAccessV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2024' is not null or undefined - assertParamExists('startViolationCheck', 'identityWithNewAccessV2024', identityWithNewAccessV2024) - const localVarPath = `/sod-violations/check`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODViolationsV2024Api - functional programming interface - * @export - */ -export const SODViolationsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODViolationsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2024} identityWithNewAccessV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startPredictSodViolations(identityWithNewAccessV2024: IdentityWithNewAccessV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolations(identityWithNewAccessV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2024Api.startPredictSodViolations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2024} identityWithNewAccessV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startViolationCheck(identityWithNewAccessV2024: IdentityWithNewAccessV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startViolationCheck(identityWithNewAccessV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2024Api.startViolationCheck']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODViolationsV2024Api - factory interface - * @export - */ -export const SODViolationsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODViolationsV2024ApiFp(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2024ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations(requestParameters: SODViolationsV2024ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startPredictSodViolations(requestParameters.identityWithNewAccessV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2024ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck(requestParameters: SODViolationsV2024ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startViolationCheck(requestParameters.identityWithNewAccessV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startPredictSodViolations operation in SODViolationsV2024Api. - * @export - * @interface SODViolationsV2024ApiStartPredictSodViolationsRequest - */ -export interface SODViolationsV2024ApiStartPredictSodViolationsRequest { - /** - * - * @type {IdentityWithNewAccessV2024} - * @memberof SODViolationsV2024ApiStartPredictSodViolations - */ - readonly identityWithNewAccessV2024: IdentityWithNewAccessV2024 -} - -/** - * Request parameters for startViolationCheck operation in SODViolationsV2024Api. - * @export - * @interface SODViolationsV2024ApiStartViolationCheckRequest - */ -export interface SODViolationsV2024ApiStartViolationCheckRequest { - /** - * - * @type {IdentityWithNewAccessV2024} - * @memberof SODViolationsV2024ApiStartViolationCheck - */ - readonly identityWithNewAccessV2024: IdentityWithNewAccessV2024 -} - -/** - * SODViolationsV2024Api - object-oriented interface - * @export - * @class SODViolationsV2024Api - * @extends {BaseAPI} - */ -export class SODViolationsV2024Api extends BaseAPI { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2024ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2024Api - */ - public startPredictSodViolations(requestParameters: SODViolationsV2024ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2024ApiFp(this.configuration).startPredictSodViolations(requestParameters.identityWithNewAccessV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2024ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2024Api - */ - public startViolationCheck(requestParameters: SODViolationsV2024ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2024ApiFp(this.configuration).startViolationCheck(requestParameters.identityWithNewAccessV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SPConfigV2024Api - axios parameter creator - * @export - */ -export const SPConfigV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2024} exportPayloadV2024 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig: async (exportPayloadV2024: ExportPayloadV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'exportPayloadV2024' is not null or undefined - assertParamExists('exportSpConfig', 'exportPayloadV2024', exportPayloadV2024) - const localVarPath = `/sp-config/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(exportPayloadV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExport', 'id', id) - const localVarPath = `/sp-config/export/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExportStatus', 'id', id) - const localVarPath = `/sp-config/export/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImport', 'id', id) - const localVarPath = `/sp-config/import/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImportStatus', 'id', id) - const localVarPath = `/sp-config/import/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2024} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig: async (data: File, preview?: boolean, _options?: ImportOptionsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('importSpConfig', 'data', data) - const localVarPath = `/sp-config/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (preview !== undefined) { - localVarQueryParameter['preview'] = preview; - } - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (_options !== undefined) { - localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sp-config/config-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SPConfigV2024Api - functional programming interface - * @export - */ -export const SPConfigV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SPConfigV2024ApiAxiosParamCreator(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2024} exportPayloadV2024 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportSpConfig(exportPayloadV2024: ExportPayloadV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfig(exportPayloadV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.exportSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.getSpConfigExport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.getSpConfigExportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.getSpConfigImport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.getSpConfigImportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2024} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSpConfig(data: File, preview?: boolean, _options?: ImportOptionsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfig(data, preview, _options, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.importSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjects(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2024Api.listSpConfigObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SPConfigV2024Api - factory interface - * @export - */ -export const SPConfigV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SPConfigV2024ApiFp(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2024ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig(requestParameters: SPConfigV2024ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportSpConfig(requestParameters.exportPayloadV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2024ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport(requestParameters: SPConfigV2024ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2024ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus(requestParameters: SPConfigV2024ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2024ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport(requestParameters: SPConfigV2024ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2024ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus(requestParameters: SPConfigV2024ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2024ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig(requestParameters: SPConfigV2024ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSpConfigObjects(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportSpConfig operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiExportSpConfigRequest - */ -export interface SPConfigV2024ApiExportSpConfigRequest { - /** - * Export options control what will be included in the export. - * @type {ExportPayloadV2024} - * @memberof SPConfigV2024ApiExportSpConfig - */ - readonly exportPayloadV2024: ExportPayloadV2024 -} - -/** - * Request parameters for getSpConfigExport operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiGetSpConfigExportRequest - */ -export interface SPConfigV2024ApiGetSpConfigExportRequest { - /** - * The ID of the export job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2024ApiGetSpConfigExport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigExportStatus operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiGetSpConfigExportStatusRequest - */ -export interface SPConfigV2024ApiGetSpConfigExportStatusRequest { - /** - * The ID of the export job whose status will be returned. - * @type {string} - * @memberof SPConfigV2024ApiGetSpConfigExportStatus - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImport operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiGetSpConfigImportRequest - */ -export interface SPConfigV2024ApiGetSpConfigImportRequest { - /** - * The ID of the import job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2024ApiGetSpConfigImport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImportStatus operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiGetSpConfigImportStatusRequest - */ -export interface SPConfigV2024ApiGetSpConfigImportStatusRequest { - /** - * The ID of the import job whose status will be returned. - * @type {string} - * @memberof SPConfigV2024ApiGetSpConfigImportStatus - */ - readonly id: string -} - -/** - * Request parameters for importSpConfig operation in SPConfigV2024Api. - * @export - * @interface SPConfigV2024ApiImportSpConfigRequest - */ -export interface SPConfigV2024ApiImportSpConfigRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof SPConfigV2024ApiImportSpConfig - */ - readonly data: File - - /** - * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @type {boolean} - * @memberof SPConfigV2024ApiImportSpConfig - */ - readonly preview?: boolean - - /** - * - * @type {ImportOptionsV2024} - * @memberof SPConfigV2024ApiImportSpConfig - */ - readonly _options?: ImportOptionsV2024 -} - -/** - * SPConfigV2024Api - object-oriented interface - * @export - * @class SPConfigV2024Api - * @extends {BaseAPI} - */ -export class SPConfigV2024Api extends BaseAPI { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2024ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public exportSpConfig(requestParameters: SPConfigV2024ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).exportSpConfig(requestParameters.exportPayloadV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2024ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public getSpConfigExport(requestParameters: SPConfigV2024ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2024ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public getSpConfigExportStatus(requestParameters: SPConfigV2024ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2024ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public getSpConfigImport(requestParameters: SPConfigV2024ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2024ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public getSpConfigImportStatus(requestParameters: SPConfigV2024ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2024ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public importSpConfig(requestParameters: SPConfigV2024ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2024Api - */ - public listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2024ApiFp(this.configuration).listSpConfigObjects(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SavedSearchV2024Api - axios parameter creator - * @export - */ -export const SavedSearchV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2024} createSavedSearchRequestV2024 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch: async (createSavedSearchRequestV2024: CreateSavedSearchRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createSavedSearchRequestV2024' is not null or undefined - assertParamExists('createSavedSearch', 'createSavedSearchRequestV2024', createSavedSearchRequestV2024) - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createSavedSearchRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2024} searchArgumentsV2024 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch: async (id: string, searchArgumentsV2024: SearchArgumentsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('executeSavedSearch', 'id', id) - // verify required parameter 'searchArgumentsV2024' is not null or undefined - assertParamExists('executeSavedSearch', 'searchArgumentsV2024', searchArgumentsV2024) - const localVarPath = `/saved-searches/{id}/execute` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchArgumentsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2024} savedSearchV2024 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch: async (id: string, savedSearchV2024: SavedSearchV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSavedSearch', 'id', id) - // verify required parameter 'savedSearchV2024' is not null or undefined - assertParamExists('putSavedSearch', 'savedSearchV2024', savedSearchV2024) - const localVarPath = `/saved-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(savedSearchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SavedSearchV2024Api - functional programming interface - * @export - */ -export const SavedSearchV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SavedSearchV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2024} createSavedSearchRequestV2024 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSavedSearch(createSavedSearchRequestV2024: CreateSavedSearchRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSavedSearch(createSavedSearchRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.createSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.deleteSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2024} searchArgumentsV2024 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async executeSavedSearch(id: string, searchArgumentsV2024: SearchArgumentsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.executeSavedSearch(id, searchArgumentsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.executeSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.getSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSavedSearches(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSavedSearches(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.listSavedSearches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2024} savedSearchV2024 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSavedSearch(id: string, savedSearchV2024: SavedSearchV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSavedSearch(id, savedSearchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2024Api.putSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SavedSearchV2024Api - factory interface - * @export - */ -export const SavedSearchV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SavedSearchV2024ApiFp(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2024ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch(requestParameters: SavedSearchV2024ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSavedSearch(requestParameters.createSavedSearchRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2024ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch(requestParameters: SavedSearchV2024ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2024ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch(requestParameters: SavedSearchV2024ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2024ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch(requestParameters: SavedSearchV2024ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2024ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches(requestParameters: SavedSearchV2024ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2024ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch(requestParameters: SavedSearchV2024ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSavedSearch(requestParameters.id, requestParameters.savedSearchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSavedSearch operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiCreateSavedSearchRequest - */ -export interface SavedSearchV2024ApiCreateSavedSearchRequest { - /** - * The saved search to persist. - * @type {CreateSavedSearchRequestV2024} - * @memberof SavedSearchV2024ApiCreateSavedSearch - */ - readonly createSavedSearchRequestV2024: CreateSavedSearchRequestV2024 -} - -/** - * Request parameters for deleteSavedSearch operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiDeleteSavedSearchRequest - */ -export interface SavedSearchV2024ApiDeleteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2024ApiDeleteSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for executeSavedSearch operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiExecuteSavedSearchRequest - */ -export interface SavedSearchV2024ApiExecuteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2024ApiExecuteSavedSearch - */ - readonly id: string - - /** - * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @type {SearchArgumentsV2024} - * @memberof SavedSearchV2024ApiExecuteSavedSearch - */ - readonly searchArgumentsV2024: SearchArgumentsV2024 -} - -/** - * Request parameters for getSavedSearch operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiGetSavedSearchRequest - */ -export interface SavedSearchV2024ApiGetSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2024ApiGetSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for listSavedSearches operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiListSavedSearchesRequest - */ -export interface SavedSearchV2024ApiListSavedSearchesRequest { - /** - * 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 SavedSearchV2024ApiListSavedSearches - */ - 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 SavedSearchV2024ApiListSavedSearches - */ - 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 SavedSearchV2024ApiListSavedSearches - */ - 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: **owner.id**: *eq* - * @type {string} - * @memberof SavedSearchV2024ApiListSavedSearches - */ - readonly filters?: string -} - -/** - * Request parameters for putSavedSearch operation in SavedSearchV2024Api. - * @export - * @interface SavedSearchV2024ApiPutSavedSearchRequest - */ -export interface SavedSearchV2024ApiPutSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2024ApiPutSavedSearch - */ - readonly id: string - - /** - * The saved search to persist. - * @type {SavedSearchV2024} - * @memberof SavedSearchV2024ApiPutSavedSearch - */ - readonly savedSearchV2024: SavedSearchV2024 -} - -/** - * SavedSearchV2024Api - object-oriented interface - * @export - * @class SavedSearchV2024Api - * @extends {BaseAPI} - */ -export class SavedSearchV2024Api extends BaseAPI { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2024ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public createSavedSearch(requestParameters: SavedSearchV2024ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).createSavedSearch(requestParameters.createSavedSearchRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2024ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public deleteSavedSearch(requestParameters: SavedSearchV2024ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2024ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public executeSavedSearch(requestParameters: SavedSearchV2024ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2024ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public getSavedSearch(requestParameters: SavedSearchV2024ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2024ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public listSavedSearches(requestParameters: SavedSearchV2024ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2024ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2024Api - */ - public putSavedSearch(requestParameters: SavedSearchV2024ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2024ApiFp(this.configuration).putSavedSearch(requestParameters.id, requestParameters.savedSearchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ScheduledSearchV2024Api - axios parameter creator - * @export - */ -export const ScheduledSearchV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2024} createScheduledSearchRequestV2024 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch: async (createScheduledSearchRequestV2024: CreateScheduledSearchRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduledSearchRequestV2024' is not null or undefined - assertParamExists('createScheduledSearch', 'createScheduledSearchRequestV2024', createScheduledSearchRequestV2024) - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduledSearchRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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, - }; - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2024} typedReferenceV2024 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch: async (id: string, typedReferenceV2024: TypedReferenceV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'id', id) - // verify required parameter 'typedReferenceV2024' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'typedReferenceV2024', typedReferenceV2024) - const localVarPath = `/scheduled-searches/{id}/unsubscribe` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(typedReferenceV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2024} scheduledSearchV2024 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch: async (id: string, scheduledSearchV2024: ScheduledSearchV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateScheduledSearch', 'id', id) - // verify required parameter 'scheduledSearchV2024' is not null or undefined - assertParamExists('updateScheduledSearch', 'scheduledSearchV2024', scheduledSearchV2024) - const localVarPath = `/scheduled-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledSearchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ScheduledSearchV2024Api - functional programming interface - * @export - */ -export const ScheduledSearchV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ScheduledSearchV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2024} createScheduledSearchRequestV2024 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledSearch(createScheduledSearchRequestV2024: CreateScheduledSearchRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledSearch(createScheduledSearchRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.createScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.deleteScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.getScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledSearch(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledSearch(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.listScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2024} typedReferenceV2024 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unsubscribeScheduledSearch(id: string, typedReferenceV2024: TypedReferenceV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribeScheduledSearch(id, typedReferenceV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.unsubscribeScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2024} scheduledSearchV2024 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledSearch(id: string, scheduledSearchV2024: ScheduledSearchV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledSearch(id, scheduledSearchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2024Api.updateScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ScheduledSearchV2024Api - factory interface - * @export - */ -export const ScheduledSearchV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ScheduledSearchV2024ApiFp(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2024ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch(requestParameters: ScheduledSearchV2024ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledSearch(requestParameters.createScheduledSearchRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2024ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch(requestParameters: ScheduledSearchV2024ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2024ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch(requestParameters: ScheduledSearchV2024ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2024ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch(requestParameters: ScheduledSearchV2024ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2024ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch(requestParameters: ScheduledSearchV2024ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiCreateScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiCreateScheduledSearchRequest { - /** - * The scheduled search to persist. - * @type {CreateScheduledSearchRequestV2024} - * @memberof ScheduledSearchV2024ApiCreateScheduledSearch - */ - readonly createScheduledSearchRequestV2024: CreateScheduledSearchRequestV2024 -} - -/** - * Request parameters for deleteScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiDeleteScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiDeleteScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2024ApiDeleteScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for getScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiGetScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiGetScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2024ApiGetScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for listScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiListScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiListScheduledSearchRequest { - /** - * 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 ScheduledSearchV2024ApiListScheduledSearch - */ - 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 ScheduledSearchV2024ApiListScheduledSearch - */ - 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 ScheduledSearchV2024ApiListScheduledSearch - */ - 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: **owner.id**: *eq* **savedSearchId**: *eq* - * @type {string} - * @memberof ScheduledSearchV2024ApiListScheduledSearch - */ - readonly filters?: string -} - -/** - * Request parameters for unsubscribeScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2024ApiUnsubscribeScheduledSearch - */ - readonly id: string - - /** - * The recipient to be removed from the scheduled search. - * @type {TypedReferenceV2024} - * @memberof ScheduledSearchV2024ApiUnsubscribeScheduledSearch - */ - readonly typedReferenceV2024: TypedReferenceV2024 -} - -/** - * Request parameters for updateScheduledSearch operation in ScheduledSearchV2024Api. - * @export - * @interface ScheduledSearchV2024ApiUpdateScheduledSearchRequest - */ -export interface ScheduledSearchV2024ApiUpdateScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2024ApiUpdateScheduledSearch - */ - readonly id: string - - /** - * The scheduled search to persist. - * @type {ScheduledSearchV2024} - * @memberof ScheduledSearchV2024ApiUpdateScheduledSearch - */ - readonly scheduledSearchV2024: ScheduledSearchV2024 -} - -/** - * ScheduledSearchV2024Api - object-oriented interface - * @export - * @class ScheduledSearchV2024Api - * @extends {BaseAPI} - */ -export class ScheduledSearchV2024Api extends BaseAPI { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2024ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public createScheduledSearch(requestParameters: ScheduledSearchV2024ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).createScheduledSearch(requestParameters.createScheduledSearchRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2024ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public deleteScheduledSearch(requestParameters: ScheduledSearchV2024ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2024ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public getScheduledSearch(requestParameters: ScheduledSearchV2024ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2024ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public listScheduledSearch(requestParameters: ScheduledSearchV2024ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2024ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2024ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2024Api - */ - public updateScheduledSearch(requestParameters: ScheduledSearchV2024ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2024ApiFp(this.configuration).updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SearchV2024Api - axios parameter creator - * @export - */ -export const SearchV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2024} searchV2024 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate: async (searchV2024: SearchV2024, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2024' is not null or undefined - assertParamExists('searchAggregate', 'searchV2024', searchV2024) - const localVarPath = `/search/aggregate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2024} searchV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount: async (searchV2024: SearchV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2024' is not null or undefined - assertParamExists('searchCount', 'searchV2024', searchV2024) - const localVarPath = `/search/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2024} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet: async (index: SearchGetIndexV2024, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'index' is not null or undefined - assertParamExists('searchGet', 'index', index) - // verify required parameter 'id' is not null or undefined - assertParamExists('searchGet', 'id', id) - const localVarPath = `/search/{index}/{id}` - .replace(`{${"index"}}`, encodeURIComponent(String(index))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2024} searchV2024 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost: async (searchV2024: SearchV2024, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2024' is not null or undefined - assertParamExists('searchPost', 'searchV2024', searchV2024) - const localVarPath = `/search`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchV2024Api - functional programming interface - * @export - */ -export const SearchV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchV2024ApiAxiosParamCreator(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2024} searchV2024 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchAggregate(searchV2024: SearchV2024, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchAggregate(searchV2024, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2024Api.searchAggregate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2024} searchV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchCount(searchV2024: SearchV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchCount(searchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2024Api.searchCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2024} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchGet(index: SearchGetIndexV2024, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchGet(index, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2024Api.searchGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2024} searchV2024 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPost(searchV2024: SearchV2024, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPost(searchV2024, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2024Api.searchPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchV2024Api - factory interface - * @export - */ -export const SearchV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchV2024ApiFp(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2024ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate(requestParameters: SearchV2024ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchAggregate(requestParameters.searchV2024, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2024ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount(requestParameters: SearchV2024ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchCount(requestParameters.searchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2024ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet(requestParameters: SearchV2024ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2024ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost(requestParameters: SearchV2024ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchPost(requestParameters.searchV2024, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for searchAggregate operation in SearchV2024Api. - * @export - * @interface SearchV2024ApiSearchAggregateRequest - */ -export interface SearchV2024ApiSearchAggregateRequest { - /** - * - * @type {SearchV2024} - * @memberof SearchV2024ApiSearchAggregate - */ - readonly searchV2024: SearchV2024 - - /** - * 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 SearchV2024ApiSearchAggregate - */ - 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 SearchV2024ApiSearchAggregate - */ - 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 SearchV2024ApiSearchAggregate - */ - readonly count?: boolean -} - -/** - * Request parameters for searchCount operation in SearchV2024Api. - * @export - * @interface SearchV2024ApiSearchCountRequest - */ -export interface SearchV2024ApiSearchCountRequest { - /** - * - * @type {SearchV2024} - * @memberof SearchV2024ApiSearchCount - */ - readonly searchV2024: SearchV2024 -} - -/** - * Request parameters for searchGet operation in SearchV2024Api. - * @export - * @interface SearchV2024ApiSearchGetRequest - */ -export interface SearchV2024ApiSearchGetRequest { - /** - * The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @type {'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'} - * @memberof SearchV2024ApiSearchGet - */ - readonly index: SearchGetIndexV2024 - - /** - * ID of the requested document. - * @type {string} - * @memberof SearchV2024ApiSearchGet - */ - readonly id: string -} - -/** - * Request parameters for searchPost operation in SearchV2024Api. - * @export - * @interface SearchV2024ApiSearchPostRequest - */ -export interface SearchV2024ApiSearchPostRequest { - /** - * - * @type {SearchV2024} - * @memberof SearchV2024ApiSearchPost - */ - readonly searchV2024: SearchV2024 - - /** - * 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 SearchV2024ApiSearchPost - */ - 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 SearchV2024ApiSearchPost - */ - 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 SearchV2024ApiSearchPost - */ - readonly count?: boolean -} - -/** - * SearchV2024Api - object-oriented interface - * @export - * @class SearchV2024Api - * @extends {BaseAPI} - */ -export class SearchV2024Api extends BaseAPI { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2024ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2024Api - */ - public searchAggregate(requestParameters: SearchV2024ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2024ApiFp(this.configuration).searchAggregate(requestParameters.searchV2024, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2024ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2024Api - */ - public searchCount(requestParameters: SearchV2024ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2024ApiFp(this.configuration).searchCount(requestParameters.searchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2024ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2024Api - */ - public searchGet(requestParameters: SearchV2024ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2024ApiFp(this.configuration).searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2024ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2024Api - */ - public searchPost(requestParameters: SearchV2024ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2024ApiFp(this.configuration).searchPost(requestParameters.searchV2024, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SearchGetIndexV2024 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles' -} as const; -export type SearchGetIndexV2024 = typeof SearchGetIndexV2024[keyof typeof SearchGetIndexV2024]; - - -/** - * SearchAttributeConfigurationV2024Api - axios parameter creator - * @export - */ -export const SearchAttributeConfigurationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2024} searchAttributeConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig: async (searchAttributeConfigV2024: SearchAttributeConfigV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchAttributeConfigV2024' is not null or undefined - assertParamExists('createSearchAttributeConfig', 'searchAttributeConfigV2024', searchAttributeConfigV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchAttributeConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig: async (limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getSingleSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig: async (name: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'name', name) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchAttributeConfigurationV2024Api - functional programming interface - * @export - */ -export const SearchAttributeConfigurationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchAttributeConfigurationV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2024} searchAttributeConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSearchAttributeConfig(searchAttributeConfigV2024: SearchAttributeConfigV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfig(searchAttributeConfigV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2024Api.createSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2024Api.deleteSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSearchAttributeConfig(limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2024Api.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSingleSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2024Api.getSingleSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSearchAttributeConfig(name: string, jsonPatchOperationV2024: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfig(name, jsonPatchOperationV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2024Api.patchSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchAttributeConfigurationV2024Api - factory interface - * @export - */ -export const SearchAttributeConfigurationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchAttributeConfigurationV2024ApiFp(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSearchAttributeConfig(requestParameters.searchAttributeConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationV2024Api. - * @export - * @interface SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest { - /** - * - * @type {SearchAttributeConfigV2024} - * @memberof SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfig - */ - readonly searchAttributeConfigV2024: SearchAttributeConfigV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationV2024Api. - * @export - * @interface SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to delete. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationV2024Api. - * @export - * @interface SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest { - /** - * 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 SearchAttributeConfigurationV2024ApiGetSearchAttributeConfig - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SearchAttributeConfigurationV2024ApiGetSearchAttributeConfig - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiGetSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationV2024Api. - * @export - * @interface SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to get. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationV2024Api. - * @export - * @interface SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest { - /** - * Name of the search attribute configuration to patch. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfig - */ - readonly name: string - - /** - * - * @type {Array} - * @memberof SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfig - */ - readonly jsonPatchOperationV2024: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * SearchAttributeConfigurationV2024Api - object-oriented interface - * @export - * @class SearchAttributeConfigurationV2024Api - * @extends {BaseAPI} - */ -export class SearchAttributeConfigurationV2024Api extends BaseAPI { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2024Api - */ - public createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2024ApiFp(this.configuration).createSearchAttributeConfig(requestParameters.searchAttributeConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2024Api - */ - public deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2024ApiFp(this.configuration).deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2024Api - */ - public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2024ApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2024Api - */ - public getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2024ApiFp(this.configuration).getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2024Api - */ - public patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2024ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2024ApiFp(this.configuration).patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SegmentsV2024Api - axios parameter creator - * @export - */ -export const SegmentsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2024} segmentV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment: async (segmentV2024: SegmentV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'segmentV2024' is not null or undefined - assertParamExists('createSegment', 'segmentV2024', segmentV2024) - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(segmentV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSegment', 'requestBody', requestBody) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SegmentsV2024Api - functional programming interface - * @export - */ -export const SegmentsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SegmentsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2024} segmentV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSegment(segmentV2024: SegmentV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSegment(segmentV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2024Api.createSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2024Api.deleteSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2024Api.getSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSegments(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2024Api.listSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSegment(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegment(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2024Api.patchSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SegmentsV2024Api - factory interface - * @export - */ -export const SegmentsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SegmentsV2024ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2024ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment(requestParameters: SegmentsV2024ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSegment(requestParameters.segmentV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2024ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment(requestParameters: SegmentsV2024ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2024ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment(requestParameters: SegmentsV2024ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2024ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments(requestParameters: SegmentsV2024ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2024ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment(requestParameters: SegmentsV2024ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSegment operation in SegmentsV2024Api. - * @export - * @interface SegmentsV2024ApiCreateSegmentRequest - */ -export interface SegmentsV2024ApiCreateSegmentRequest { - /** - * - * @type {SegmentV2024} - * @memberof SegmentsV2024ApiCreateSegment - */ - readonly segmentV2024: SegmentV2024 -} - -/** - * Request parameters for deleteSegment operation in SegmentsV2024Api. - * @export - * @interface SegmentsV2024ApiDeleteSegmentRequest - */ -export interface SegmentsV2024ApiDeleteSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof SegmentsV2024ApiDeleteSegment - */ - readonly id: string -} - -/** - * Request parameters for getSegment operation in SegmentsV2024Api. - * @export - * @interface SegmentsV2024ApiGetSegmentRequest - */ -export interface SegmentsV2024ApiGetSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof SegmentsV2024ApiGetSegment - */ - readonly id: string -} - -/** - * Request parameters for listSegments operation in SegmentsV2024Api. - * @export - * @interface SegmentsV2024ApiListSegmentsRequest - */ -export interface SegmentsV2024ApiListSegmentsRequest { - /** - * 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 SegmentsV2024ApiListSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SegmentsV2024ApiListSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SegmentsV2024ApiListSegments - */ - readonly count?: boolean -} - -/** - * Request parameters for patchSegment operation in SegmentsV2024Api. - * @export - * @interface SegmentsV2024ApiPatchSegmentRequest - */ -export interface SegmentsV2024ApiPatchSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof SegmentsV2024ApiPatchSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @type {Array} - * @memberof SegmentsV2024ApiPatchSegment - */ - readonly requestBody: Array -} - -/** - * SegmentsV2024Api - object-oriented interface - * @export - * @class SegmentsV2024Api - * @extends {BaseAPI} - */ -export class SegmentsV2024Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2024ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2024Api - */ - public createSegment(requestParameters: SegmentsV2024ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2024ApiFp(this.configuration).createSegment(requestParameters.segmentV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2024ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2024Api - */ - public deleteSegment(requestParameters: SegmentsV2024ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2024ApiFp(this.configuration).deleteSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2024ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2024Api - */ - public getSegment(requestParameters: SegmentsV2024ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2024ApiFp(this.configuration).getSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2024ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2024Api - */ - public listSegments(requestParameters: SegmentsV2024ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2024ApiFp(this.configuration).listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2024ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2024Api - */ - public patchSegment(requestParameters: SegmentsV2024ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2024ApiFp(this.configuration).patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ServiceDeskIntegrationV2024Api - axios parameter creator - * @export - */ -export const ServiceDeskIntegrationV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2024} serviceDeskIntegrationDtoV2024 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration: async (serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'serviceDeskIntegrationDtoV2024' is not null or undefined - assertParamExists('createServiceDeskIntegration', 'serviceDeskIntegrationDtoV2024', serviceDeskIntegrationDtoV2024) - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getServiceDeskIntegrationTemplate', 'scriptName', scriptName) - const localVarPath = `/service-desk-integrations/templates/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2024 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2024} serviceDeskIntegrationDtoV2024 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration: async (id: string, serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'id', id) - // verify required parameter 'serviceDeskIntegrationDtoV2024' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'serviceDeskIntegrationDtoV2024', serviceDeskIntegrationDtoV2024) - const localVarPath = `/service-desk-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2024} queuedCheckConfigDetailsV2024 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails: async (queuedCheckConfigDetailsV2024: QueuedCheckConfigDetailsV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'queuedCheckConfigDetailsV2024' is not null or undefined - assertParamExists('updateStatusCheckDetails', 'queuedCheckConfigDetailsV2024', queuedCheckConfigDetailsV2024) - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetailsV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ServiceDeskIntegrationV2024Api - functional programming interface - * @export - */ -export const ServiceDeskIntegrationV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ServiceDeskIntegrationV2024ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2024} serviceDeskIntegrationDtoV2024 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createServiceDeskIntegration(serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegration(serviceDeskIntegrationDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.createServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.deleteServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.getServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.getServiceDeskIntegrationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.getServiceDeskIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrations(offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.getServiceDeskIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetails(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.getStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2024 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchServiceDeskIntegration(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2024} serviceDeskIntegrationDtoV2024 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putServiceDeskIntegration(id: string, serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegration(id, serviceDeskIntegrationDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.putServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2024} queuedCheckConfigDetailsV2024 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStatusCheckDetails(queuedCheckConfigDetailsV2024: QueuedCheckConfigDetailsV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetails(queuedCheckConfigDetailsV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2024Api.updateStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ServiceDeskIntegrationV2024Api - factory interface - * @export - */ -export const ServiceDeskIntegrationV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ServiceDeskIntegrationV2024ApiFp(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusCheckDetails(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createServiceDeskIntegration operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest { - /** - * The specifics of a new integration to create - * @type {ServiceDeskIntegrationDtoV2024} - * @memberof ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024 -} - -/** - * Request parameters for deleteServiceDeskIntegration operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest { - /** - * ID of Service Desk integration to delete - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegration operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to get - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiGetServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegrationTemplate operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest - */ -export interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest { - /** - * The scriptName value of the Service Desk integration template to get - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getServiceDeskIntegrations operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest - */ -export interface ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest { - /** - * 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 ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrations - */ - 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 ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrations - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrations - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrations - */ - readonly filters?: string - - /** - * 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 ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrations - */ - readonly count?: boolean -} - -/** - * Request parameters for patchServiceDeskIntegration operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegration - */ - readonly id: string - - /** - * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @type {Array} - * @memberof ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegration - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2024ApiPutServiceDeskIntegration - */ - readonly id: string - - /** - * The specifics of the integration to update - * @type {ServiceDeskIntegrationDtoV2024} - * @memberof ServiceDeskIntegrationV2024ApiPutServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2024: ServiceDeskIntegrationDtoV2024 -} - -/** - * Request parameters for updateStatusCheckDetails operation in ServiceDeskIntegrationV2024Api. - * @export - * @interface ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest - */ -export interface ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest { - /** - * The modified time check configuration - * @type {QueuedCheckConfigDetailsV2024} - * @memberof ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetails - */ - readonly queuedCheckConfigDetailsV2024: QueuedCheckConfigDetailsV2024 -} - -/** - * ServiceDeskIntegrationV2024Api - object-oriented interface - * @export - * @class ServiceDeskIntegrationV2024Api - * @extends {BaseAPI} - */ -export class ServiceDeskIntegrationV2024Api extends BaseAPI { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2024ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).getStatusCheckDetails(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2024ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2024Api - */ - public updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2024ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2024ApiFp(this.configuration).updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourceUsagesV2024Api - axios parameter creator - * @export - */ -export const SourceUsagesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getStatusBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/status` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getUsagesBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/summaries` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * SourceUsagesV2024Api - functional programming interface - * @export - */ -export const SourceUsagesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourceUsagesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusBySourceId(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceId(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2024Api.getStatusBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceId(sourceId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2024Api.getUsagesBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourceUsagesV2024Api - factory interface - * @export - */ -export const SourceUsagesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourceUsagesV2024ApiFp(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2024ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId(requestParameters: SourceUsagesV2024ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2024ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId(requestParameters: SourceUsagesV2024ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getStatusBySourceId operation in SourceUsagesV2024Api. - * @export - * @interface SourceUsagesV2024ApiGetStatusBySourceIdRequest - */ -export interface SourceUsagesV2024ApiGetStatusBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2024ApiGetStatusBySourceId - */ - readonly sourceId: string -} - -/** - * Request parameters for getUsagesBySourceId operation in SourceUsagesV2024Api. - * @export - * @interface SourceUsagesV2024ApiGetUsagesBySourceIdRequest - */ -export interface SourceUsagesV2024ApiGetUsagesBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2024ApiGetUsagesBySourceId - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2024ApiGetUsagesBySourceId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2024ApiGetUsagesBySourceId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourceUsagesV2024ApiGetUsagesBySourceId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof SourceUsagesV2024ApiGetUsagesBySourceId - */ - readonly sorters?: string -} - -/** - * SourceUsagesV2024Api - object-oriented interface - * @export - * @class SourceUsagesV2024Api - * @extends {BaseAPI} - */ -export class SourceUsagesV2024Api extends BaseAPI { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2024ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2024Api - */ - public getStatusBySourceId(requestParameters: SourceUsagesV2024ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2024ApiFp(this.configuration).getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2024ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2024Api - */ - public getUsagesBySourceId(requestParameters: SourceUsagesV2024ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2024ApiFp(this.configuration).getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourcesV2024Api - axios parameter creator - * @export - */ -export const SourcesV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2024} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy: async (sourceId: string, provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2024' is not null or undefined - assertParamExists('createProvisioningPolicy', 'provisioningPolicyDtoV2024', provisioningPolicyDtoV2024) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2024} sourceV2024 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource: async (sourceV2024: SourceV2024, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceV2024' is not null or undefined - assertParamExists('createSource', 'sourceV2024', sourceV2024) - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (provisionAsCsv !== undefined) { - localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2024} schedule1V2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule: async (sourceId: string, schedule1V2024: Schedule1V2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'schedule1V2024' is not null or undefined - assertParamExists('createSourceSchedule', 'schedule1V2024', schedule1V2024) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schedule1V2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2024} schemaV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema: async (sourceId: string, schemaV2024: SchemaV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaV2024' is not null or undefined - assertParamExists('createSourceSchema', 'schemaV2024', schemaV2024) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountsAsync', 'id', id) - const localVarPath = `/sources/{id}/remove-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule: async (sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('deleteSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('deleteSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCorrelationConfig', 'id', id) - const localVarPath = `/sources/{id}/correlation-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema: async (id: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('getProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceAttrSyncConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig: async (id: string, locale?: GetSourceConfigLocaleV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceConfig', 'id', id) - const localVarPath = `/sources/{id}/connectors/source-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceConnections', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connections` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceEntitlementRequestConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceHealth', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/source-health` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule: async (sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('getSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedules', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('getSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2024} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas: async (sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2024, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchemas', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeTypes !== undefined) { - localVarQueryParameter['include-types'] = includeTypes; - } - - if (includeNames !== undefined) { - localVarQueryParameter['include-names'] = includeNames; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts: async (id: string, file?: File, disableOptimization?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - if (disableOptimization !== undefined) { - localVarFormParams.append('disableOptimization', disableOptimization as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importConnectorFile', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/upload-connector-file` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importEntitlements', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema: async (id: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importUncorrelatedAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-uncorrelated-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listProvisioningPolicies', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (includeIDNSource !== undefined) { - localVarQueryParameter['includeIDNSource'] = includeIDNSource; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('pingCluster', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/ping-cluster` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2024} correlationConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig: async (id: string, correlationConfigV2024: CorrelationConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putCorrelationConfig', 'id', id) - // verify required parameter 'correlationConfigV2024' is not null or undefined - assertParamExists('putCorrelationConfig', 'correlationConfigV2024', correlationConfigV2024) - const localVarPath = `/sources/{id}/correlation-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(correlationConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2024} nativeChangeDetectionConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig: async (id: string, nativeChangeDetectionConfigV2024: NativeChangeDetectionConfigV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'id', id) - // verify required parameter 'nativeChangeDetectionConfigV2024' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'nativeChangeDetectionConfigV2024', nativeChangeDetectionConfigV2024) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nativeChangeDetectionConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2024} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2024, provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('putProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'provisioningPolicyDtoV2024' is not null or undefined - assertParamExists('putProvisioningPolicy', 'provisioningPolicyDtoV2024', provisioningPolicyDtoV2024) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2024} sourceV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource: async (id: string, sourceV2024: SourceV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSource', 'id', id) - // verify required parameter 'sourceV2024' is not null or undefined - assertParamExists('putSource', 'sourceV2024', sourceV2024) - const localVarPath = `/sources/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2024} attrSyncSourceConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig: async (id: string, attrSyncSourceConfigV2024: AttrSyncSourceConfigV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'id', id) - // verify required parameter 'attrSyncSourceConfigV2024' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'attrSyncSourceConfigV2024', attrSyncSourceConfigV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attrSyncSourceConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2024} schemaV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema: async (sourceId: string, schemaId: string, schemaV2024: SchemaV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('putSourceSchema', 'schemaId', schemaId) - // verify required parameter 'schemaV2024' is not null or undefined - assertParamExists('putSourceSchema', 'schemaV2024', schemaV2024) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2024} resourceObjectsRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects: async (sourceId: string, resourceObjectsRequestV2024: ResourceObjectsRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('searchResourceObjects', 'sourceId', sourceId) - // verify required parameter 'resourceObjectsRequestV2024' is not null or undefined - assertParamExists('searchResourceObjects', 'resourceObjectsRequestV2024', resourceObjectsRequestV2024) - const localVarPath = `/sources/{sourceId}/connector/peek-resource-objects` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(resourceObjectsRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('syncAttributesForSource', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/synchronize-attributes` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConfiguration', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/test-configuration` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnection', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/check-connection` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders: async (sourceId: string, passwordPolicyHoldersDtoInnerV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'sourceId', sourceId) - // verify required parameter 'passwordPolicyHoldersDtoInnerV2024' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'passwordPolicyHoldersDtoInnerV2024', passwordPolicyHoldersDtoInnerV2024) - const localVarPath = `/sources/{sourceId}/password-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyHoldersDtoInnerV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk: async (sourceId: string, provisioningPolicyDtoV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2024' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'provisioningPolicyDtoV2024', provisioningPolicyDtoV2024) - const localVarPath = `/sources/{sourceId}/provisioning-policies/bulk-update` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2024, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2024 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSource', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateSource', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2024} sourceEntitlementRequestConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig: async (id: string, sourceEntitlementRequestConfigV2024: SourceEntitlementRequestConfigV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'id', id) - // verify required parameter 'sourceEntitlementRequestConfigV2024' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'sourceEntitlementRequestConfigV2024', sourceEntitlementRequestConfigV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceEntitlementRequestConfigV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule: async (sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2024, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('updateSourceSchedule', 'scheduleType', scheduleType) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateSourceSchedule', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema: async (sourceId: string, schemaId: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('updateSourceSchema', 'schemaId', schemaId) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateSourceSchema', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SourcesV2024Api - functional programming interface - * @export - */ -export const SourcesV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourcesV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2024} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createProvisioningPolicy(sourceId: string, provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicy(sourceId, provisioningPolicyDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.createProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2024} sourceV2024 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSource(sourceV2024: SourceV2024, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSource(sourceV2024, provisionAsCsv, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.createSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2024} schedule1V2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchedule(sourceId: string, schedule1V2024: Schedule1V2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchedule(sourceId, schedule1V2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.createSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2024} schemaV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchema(sourceId: string, schemaV2024: SchemaV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchema(sourceId, schemaV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.createSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountsAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountsAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteAccountsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteProvisioningPolicy(sourceId: string, usageType: UsageTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchedule(sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.deleteSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountsSchema(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountsSchema(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCorrelationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCorrelationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsSchema(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsSchema(id, schemaName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProvisioningPolicy(sourceId: string, usageType: UsageTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceAttrSyncConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAttrSyncConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2024} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConfig(id: string, locale?: GetSourceConfigLocaleV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConfig(id, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceEntitlementRequestConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementRequestConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceHealth(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceHealth(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceHealth']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedule(sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedules(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedules(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceSchedules']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2024} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchemas(sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2024, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemas(sourceId, includeTypes, includeNames, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.getSourceSchemas']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccounts(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccounts(id, file, disableOptimization, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccountsSchema(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsSchema(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importConnectorFile(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importConnectorFile(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importConnectorFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlements(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlements(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlementsSchema(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsSchema(id, schemaName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importUncorrelatedAccounts(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importUncorrelatedAccounts(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.importUncorrelatedAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listProvisioningPolicies(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPolicies(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.listProvisioningPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSources(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSources(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.listSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingCluster(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingCluster(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.pingCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2024} correlationConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCorrelationConfig(id: string, correlationConfigV2024: CorrelationConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCorrelationConfig(id, correlationConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2024} nativeChangeDetectionConfigV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putNativeChangeDetectionConfig(id: string, nativeChangeDetectionConfigV2024: NativeChangeDetectionConfigV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putNativeChangeDetectionConfig(id, nativeChangeDetectionConfigV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2024} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putProvisioningPolicy(sourceId: string, usageType: UsageTypeV2024, provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicy(sourceId, usageType, provisioningPolicyDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2024} sourceV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSource(id: string, sourceV2024: SourceV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSource(id, sourceV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2024} attrSyncSourceConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceAttrSyncConfig(id: string, attrSyncSourceConfigV2024: AttrSyncSourceConfigV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceAttrSyncConfig(id, attrSyncSourceConfigV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2024} schemaV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceSchema(sourceId: string, schemaId: string, schemaV2024: SchemaV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchema(sourceId, schemaId, schemaV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.putSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2024} resourceObjectsRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchResourceObjects(sourceId: string, resourceObjectsRequestV2024: ResourceObjectsRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchResourceObjects(sourceId, resourceObjectsRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.searchResourceObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncAttributesForSource(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncAttributesForSource(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.syncAttributesForSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConfiguration(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConfiguration(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.testSourceConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnection(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnection(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.testSourceConnection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordPolicyHolders(sourceId: string, passwordPolicyHoldersDtoInnerV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordPolicyHolders(sourceId, passwordPolicyHoldersDtoInnerV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updatePasswordPolicyHolders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDtoV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulk(sourceId, provisioningPolicyDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateProvisioningPoliciesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2024} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPolicy(sourceId: string, usageType: UsageTypeV2024, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicy(sourceId, usageType, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2024 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSource(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSource(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2024} sourceEntitlementRequestConfigV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceEntitlementRequestConfig(id: string, sourceEntitlementRequestConfigV2024: SourceEntitlementRequestConfigV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceEntitlementRequestConfig(id, sourceEntitlementRequestConfigV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2024} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchedule(sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2024, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchedule(sourceId, scheduleType, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchema(sourceId, schemaId, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2024Api.updateSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourcesV2024Api - factory interface - * @export - */ -export const SourcesV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourcesV2024ApiFp(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2024ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy(requestParameters: SourcesV2024ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2024ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource(requestParameters: SourcesV2024ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSource(requestParameters.sourceV2024, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2024ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule(requestParameters: SourcesV2024ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2024ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema(requestParameters: SourcesV2024ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2024ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync(requestParameters: SourcesV2024ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2024ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy(requestParameters: SourcesV2024ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2024ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource(requestParameters: SourcesV2024ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2024ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule(requestParameters: SourcesV2024ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schema by id - * @param {SourcesV2024ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema(requestParameters: SourcesV2024ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2024ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema(requestParameters: SourcesV2024ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2024ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig(requestParameters: SourcesV2024ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2024ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema(requestParameters: SourcesV2024ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2024ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2024ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy(requestParameters: SourcesV2024ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2024ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource(requestParameters: SourcesV2024ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2024ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig(requestParameters: SourcesV2024ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2024ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig(requestParameters: SourcesV2024ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2024ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections(requestParameters: SourcesV2024ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2024ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig(requestParameters: SourcesV2024ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2024ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth(requestParameters: SourcesV2024ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2024ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule(requestParameters: SourcesV2024ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2024ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules(requestParameters: SourcesV2024ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2024ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema(requestParameters: SourcesV2024ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2024ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas(requestParameters: SourcesV2024ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2024ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts(requestParameters: SourcesV2024ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2024ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema(requestParameters: SourcesV2024ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2024ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile(requestParameters: SourcesV2024ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2024ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements(requestParameters: SourcesV2024ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2024ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema(requestParameters: SourcesV2024ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2024ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts(requestParameters: SourcesV2024ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2024ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies(requestParameters: SourcesV2024ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2024ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources(requestParameters: SourcesV2024ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2024ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster(requestParameters: SourcesV2024ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2024ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig(requestParameters: SourcesV2024ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2024ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2024ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy(requestParameters: SourcesV2024ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2024ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource(requestParameters: SourcesV2024ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSource(requestParameters.id, requestParameters.sourceV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2024ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig(requestParameters: SourcesV2024ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2024ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema(requestParameters: SourcesV2024ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2024ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects(requestParameters: SourcesV2024ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2024ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource(requestParameters: SourcesV2024ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2024ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration(requestParameters: SourcesV2024ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2024ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection(requestParameters: SourcesV2024ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2024ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders(requestParameters: SourcesV2024ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk(requestParameters: SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2024ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy(requestParameters: SourcesV2024ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2024ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource(requestParameters: SourcesV2024ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig(requestParameters: SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2024ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule(requestParameters: SourcesV2024ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2024ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema(requestParameters: SourcesV2024ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createProvisioningPolicy operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiCreateProvisioningPolicyRequest - */ -export interface SourcesV2024ApiCreateProvisioningPolicyRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiCreateProvisioningPolicy - */ - readonly sourceId: string - - /** - * - * @type {ProvisioningPolicyDtoV2024} - * @memberof SourcesV2024ApiCreateProvisioningPolicy - */ - readonly provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024 -} - -/** - * Request parameters for createSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiCreateSourceRequest - */ -export interface SourcesV2024ApiCreateSourceRequest { - /** - * - * @type {SourceV2024} - * @memberof SourcesV2024ApiCreateSource - */ - readonly sourceV2024: SourceV2024 - - /** - * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @type {boolean} - * @memberof SourcesV2024ApiCreateSource - */ - readonly provisionAsCsv?: boolean -} - -/** - * Request parameters for createSourceSchedule operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiCreateSourceScheduleRequest - */ -export interface SourcesV2024ApiCreateSourceScheduleRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiCreateSourceSchedule - */ - readonly sourceId: string - - /** - * - * @type {Schedule1V2024} - * @memberof SourcesV2024ApiCreateSourceSchedule - */ - readonly schedule1V2024: Schedule1V2024 -} - -/** - * Request parameters for createSourceSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiCreateSourceSchemaRequest - */ -export interface SourcesV2024ApiCreateSourceSchemaRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiCreateSourceSchema - */ - readonly sourceId: string - - /** - * - * @type {SchemaV2024} - * @memberof SourcesV2024ApiCreateSourceSchema - */ - readonly schemaV2024: SchemaV2024 -} - -/** - * Request parameters for deleteAccountsAsync operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteAccountsAsyncRequest - */ -export interface SourcesV2024ApiDeleteAccountsAsyncRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiDeleteAccountsAsync - */ - readonly id: string -} - -/** - * Request parameters for deleteNativeChangeDetectionConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest - */ -export interface SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiDeleteNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for deleteProvisioningPolicy operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteProvisioningPolicyRequest - */ -export interface SourcesV2024ApiDeleteProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2024ApiDeleteProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2024} - * @memberof SourcesV2024ApiDeleteProvisioningPolicy - */ - readonly usageType: UsageTypeV2024 -} - -/** - * Request parameters for deleteSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteSourceRequest - */ -export interface SourcesV2024ApiDeleteSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiDeleteSource - */ - readonly id: string -} - -/** - * Request parameters for deleteSourceSchedule operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteSourceScheduleRequest - */ -export interface SourcesV2024ApiDeleteSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiDeleteSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2024ApiDeleteSourceSchedule - */ - readonly scheduleType: DeleteSourceScheduleScheduleTypeV2024 -} - -/** - * Request parameters for deleteSourceSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiDeleteSourceSchemaRequest - */ -export interface SourcesV2024ApiDeleteSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiDeleteSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2024ApiDeleteSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getAccountsSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetAccountsSchemaRequest - */ -export interface SourcesV2024ApiGetAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiGetAccountsSchema - */ - readonly id: string -} - -/** - * Request parameters for getCorrelationConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetCorrelationConfigRequest - */ -export interface SourcesV2024ApiGetCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiGetCorrelationConfig - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementsSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetEntitlementsSchemaRequest - */ -export interface SourcesV2024ApiGetEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiGetEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2024ApiGetEntitlementsSchema - */ - readonly schemaName?: string -} - -/** - * Request parameters for getNativeChangeDetectionConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetNativeChangeDetectionConfigRequest - */ -export interface SourcesV2024ApiGetNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiGetNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for getProvisioningPolicy operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetProvisioningPolicyRequest - */ -export interface SourcesV2024ApiGetProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2024ApiGetProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2024} - * @memberof SourcesV2024ApiGetProvisioningPolicy - */ - readonly usageType: UsageTypeV2024 -} - -/** - * Request parameters for getSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceRequest - */ -export interface SourcesV2024ApiGetSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiGetSource - */ - readonly id: string -} - -/** - * Request parameters for getSourceAttrSyncConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceAttrSyncConfigRequest - */ -export interface SourcesV2024ApiGetSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiGetSourceAttrSyncConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2024ApiGetSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceConfigRequest - */ -export interface SourcesV2024ApiGetSourceConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiGetSourceConfig - */ - readonly id: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof SourcesV2024ApiGetSourceConfig - */ - readonly locale?: GetSourceConfigLocaleV2024 -} - -/** - * Request parameters for getSourceConnections operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceConnectionsRequest - */ -export interface SourcesV2024ApiGetSourceConnectionsRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiGetSourceConnections - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceEntitlementRequestConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2024ApiGetSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiGetSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2024ApiGetSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceHealth operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceHealthRequest - */ -export interface SourcesV2024ApiGetSourceHealthRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiGetSourceHealth - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchedule operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceScheduleRequest - */ -export interface SourcesV2024ApiGetSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2024ApiGetSourceSchedule - */ - readonly scheduleType: GetSourceScheduleScheduleTypeV2024 -} - -/** - * Request parameters for getSourceSchedules operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceSchedulesRequest - */ -export interface SourcesV2024ApiGetSourceSchedulesRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchedules - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceSchemaRequest - */ -export interface SourcesV2024ApiGetSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getSourceSchemas operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiGetSourceSchemasRequest - */ -export interface SourcesV2024ApiGetSourceSchemasRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchemas - */ - readonly sourceId: string - - /** - * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @type {'group' | 'user'} - * @memberof SourcesV2024ApiGetSourceSchemas - */ - readonly includeTypes?: GetSourceSchemasIncludeTypesV2024 - - /** - * A comma-separated list of schema names to filter result. - * @type {string} - * @memberof SourcesV2024ApiGetSourceSchemas - */ - readonly includeNames?: string -} - -/** - * Request parameters for importAccounts operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportAccountsRequest - */ -export interface SourcesV2024ApiImportAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2024ApiImportAccounts - */ - readonly id: string - - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof SourcesV2024ApiImportAccounts - */ - readonly file?: File - - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof SourcesV2024ApiImportAccounts - */ - readonly disableOptimization?: string -} - -/** - * Request parameters for importAccountsSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportAccountsSchemaRequest - */ -export interface SourcesV2024ApiImportAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiImportAccountsSchema - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2024ApiImportAccountsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importConnectorFile operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportConnectorFileRequest - */ -export interface SourcesV2024ApiImportConnectorFileRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiImportConnectorFile - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesV2024ApiImportConnectorFile - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlements operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportEntitlementsRequest - */ -export interface SourcesV2024ApiImportEntitlementsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2024ApiImportEntitlements - */ - readonly sourceId: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof SourcesV2024ApiImportEntitlements - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlementsSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportEntitlementsSchemaRequest - */ -export interface SourcesV2024ApiImportEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiImportEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2024ApiImportEntitlementsSchema - */ - readonly schemaName?: string - - /** - * - * @type {File} - * @memberof SourcesV2024ApiImportEntitlementsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importUncorrelatedAccounts operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiImportUncorrelatedAccountsRequest - */ -export interface SourcesV2024ApiImportUncorrelatedAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2024ApiImportUncorrelatedAccounts - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2024ApiImportUncorrelatedAccounts - */ - readonly file?: File -} - -/** - * Request parameters for listProvisioningPolicies operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiListProvisioningPoliciesRequest - */ -export interface SourcesV2024ApiListProvisioningPoliciesRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiListProvisioningPolicies - */ - readonly sourceId: string -} - -/** - * Request parameters for listSources operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiListSourcesRequest - */ -export interface SourcesV2024ApiListSourcesRequest { - /** - * 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 SourcesV2024ApiListSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourcesV2024ApiListSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourcesV2024ApiListSources - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof SourcesV2024ApiListSources - */ - 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @type {string} - * @memberof SourcesV2024ApiListSources - */ - readonly sorters?: string - - /** - * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @type {string} - * @memberof SourcesV2024ApiListSources - */ - readonly forSubadmin?: string - - /** - * Include the IdentityNow source in the response. - * @type {boolean} - * @memberof SourcesV2024ApiListSources - */ - readonly includeIDNSource?: boolean -} - -/** - * Request parameters for pingCluster operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPingClusterRequest - */ -export interface SourcesV2024ApiPingClusterRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2024ApiPingCluster - */ - readonly sourceId: string -} - -/** - * Request parameters for putCorrelationConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutCorrelationConfigRequest - */ -export interface SourcesV2024ApiPutCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiPutCorrelationConfig - */ - readonly id: string - - /** - * - * @type {CorrelationConfigV2024} - * @memberof SourcesV2024ApiPutCorrelationConfig - */ - readonly correlationConfigV2024: CorrelationConfigV2024 -} - -/** - * Request parameters for putNativeChangeDetectionConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutNativeChangeDetectionConfigRequest - */ -export interface SourcesV2024ApiPutNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiPutNativeChangeDetectionConfig - */ - readonly id: string - - /** - * - * @type {NativeChangeDetectionConfigV2024} - * @memberof SourcesV2024ApiPutNativeChangeDetectionConfig - */ - readonly nativeChangeDetectionConfigV2024: NativeChangeDetectionConfigV2024 -} - -/** - * Request parameters for putProvisioningPolicy operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutProvisioningPolicyRequest - */ -export interface SourcesV2024ApiPutProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2024ApiPutProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2024} - * @memberof SourcesV2024ApiPutProvisioningPolicy - */ - readonly usageType: UsageTypeV2024 - - /** - * - * @type {ProvisioningPolicyDtoV2024} - * @memberof SourcesV2024ApiPutProvisioningPolicy - */ - readonly provisioningPolicyDtoV2024: ProvisioningPolicyDtoV2024 -} - -/** - * Request parameters for putSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutSourceRequest - */ -export interface SourcesV2024ApiPutSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiPutSource - */ - readonly id: string - - /** - * - * @type {SourceV2024} - * @memberof SourcesV2024ApiPutSource - */ - readonly sourceV2024: SourceV2024 -} - -/** - * Request parameters for putSourceAttrSyncConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutSourceAttrSyncConfigRequest - */ -export interface SourcesV2024ApiPutSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2024ApiPutSourceAttrSyncConfig - */ - readonly id: string - - /** - * - * @type {AttrSyncSourceConfigV2024} - * @memberof SourcesV2024ApiPutSourceAttrSyncConfig - */ - readonly attrSyncSourceConfigV2024: AttrSyncSourceConfigV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2024ApiPutSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSourceSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiPutSourceSchemaRequest - */ -export interface SourcesV2024ApiPutSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiPutSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2024ApiPutSourceSchema - */ - readonly schemaId: string - - /** - * - * @type {SchemaV2024} - * @memberof SourcesV2024ApiPutSourceSchema - */ - readonly schemaV2024: SchemaV2024 -} - -/** - * Request parameters for searchResourceObjects operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiSearchResourceObjectsRequest - */ -export interface SourcesV2024ApiSearchResourceObjectsRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2024ApiSearchResourceObjects - */ - readonly sourceId: string - - /** - * - * @type {ResourceObjectsRequestV2024} - * @memberof SourcesV2024ApiSearchResourceObjects - */ - readonly resourceObjectsRequestV2024: ResourceObjectsRequestV2024 -} - -/** - * Request parameters for syncAttributesForSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiSyncAttributesForSourceRequest - */ -export interface SourcesV2024ApiSyncAttributesForSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiSyncAttributesForSource - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2024ApiSyncAttributesForSource - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for testSourceConfiguration operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiTestSourceConfigurationRequest - */ -export interface SourcesV2024ApiTestSourceConfigurationRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2024ApiTestSourceConfiguration - */ - readonly sourceId: string -} - -/** - * Request parameters for testSourceConnection operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiTestSourceConnectionRequest - */ -export interface SourcesV2024ApiTestSourceConnectionRequest { - /** - * The ID of the Source. - * @type {string} - * @memberof SourcesV2024ApiTestSourceConnection - */ - readonly sourceId: string -} - -/** - * Request parameters for updatePasswordPolicyHolders operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdatePasswordPolicyHoldersRequest - */ -export interface SourcesV2024ApiUpdatePasswordPolicyHoldersRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiUpdatePasswordPolicyHolders - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2024ApiUpdatePasswordPolicyHolders - */ - readonly passwordPolicyHoldersDtoInnerV2024: Array -} - -/** - * Request parameters for updateProvisioningPoliciesInBulk operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest - */ -export interface SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiUpdateProvisioningPoliciesInBulk - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2024ApiUpdateProvisioningPoliciesInBulk - */ - readonly provisioningPolicyDtoV2024: Array -} - -/** - * Request parameters for updateProvisioningPolicy operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateProvisioningPolicyRequest - */ -export interface SourcesV2024ApiUpdateProvisioningPolicyRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiUpdateProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2024} - * @memberof SourcesV2024ApiUpdateProvisioningPolicy - */ - readonly usageType: UsageTypeV2024 - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2024ApiUpdateProvisioningPolicy - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for updateSource operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateSourceRequest - */ -export interface SourcesV2024ApiUpdateSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2024ApiUpdateSource - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @type {Array} - * @memberof SourcesV2024ApiUpdateSource - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for updateSourceEntitlementRequestConfig operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2024ApiUpdateSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {SourceEntitlementRequestConfigV2024} - * @memberof SourcesV2024ApiUpdateSourceEntitlementRequestConfig - */ - readonly sourceEntitlementRequestConfigV2024: SourceEntitlementRequestConfigV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2024ApiUpdateSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateSourceSchedule operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateSourceScheduleRequest - */ -export interface SourcesV2024ApiUpdateSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiUpdateSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2024ApiUpdateSourceSchedule - */ - readonly scheduleType: UpdateSourceScheduleScheduleTypeV2024 - - /** - * The JSONPatch payload used to update the schedule. - * @type {Array} - * @memberof SourcesV2024ApiUpdateSourceSchedule - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for updateSourceSchema operation in SourcesV2024Api. - * @export - * @interface SourcesV2024ApiUpdateSourceSchemaRequest - */ -export interface SourcesV2024ApiUpdateSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2024ApiUpdateSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2024ApiUpdateSourceSchema - */ - readonly schemaId: string - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2024ApiUpdateSourceSchema - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * SourcesV2024Api - object-oriented interface - * @export - * @class SourcesV2024Api - * @extends {BaseAPI} - */ -export class SourcesV2024Api extends BaseAPI { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2024ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public createProvisioningPolicy(requestParameters: SourcesV2024ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2024ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public createSource(requestParameters: SourcesV2024ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).createSource(requestParameters.sourceV2024, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2024ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public createSourceSchedule(requestParameters: SourcesV2024ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2024ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public createSourceSchema(requestParameters: SourcesV2024ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2024ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteAccountsAsync(requestParameters: SourcesV2024ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2024ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteProvisioningPolicy(requestParameters: SourcesV2024ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2024ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteSource(requestParameters: SourcesV2024ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2024ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteSourceSchedule(requestParameters: SourcesV2024ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schema by id - * @param {SourcesV2024ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public deleteSourceSchema(requestParameters: SourcesV2024ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2024ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getAccountsSchema(requestParameters: SourcesV2024ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2024ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getCorrelationConfig(requestParameters: SourcesV2024ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2024ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getEntitlementsSchema(requestParameters: SourcesV2024ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2024ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2024ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getProvisioningPolicy(requestParameters: SourcesV2024ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2024ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSource(requestParameters: SourcesV2024ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2024ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceAttrSyncConfig(requestParameters: SourcesV2024ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2024ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceConfig(requestParameters: SourcesV2024ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2024ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceConnections(requestParameters: SourcesV2024ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2024ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceEntitlementRequestConfig(requestParameters: SourcesV2024ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2024ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceHealth(requestParameters: SourcesV2024ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2024ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceSchedule(requestParameters: SourcesV2024ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2024ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceSchedules(requestParameters: SourcesV2024ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2024ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceSchema(requestParameters: SourcesV2024ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2024ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public getSourceSchemas(requestParameters: SourcesV2024ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2024ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importAccounts(requestParameters: SourcesV2024ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2024ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importAccountsSchema(requestParameters: SourcesV2024ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2024ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importConnectorFile(requestParameters: SourcesV2024ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2024ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importEntitlements(requestParameters: SourcesV2024ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2024ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importEntitlementsSchema(requestParameters: SourcesV2024ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2024ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public importUncorrelatedAccounts(requestParameters: SourcesV2024ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2024ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public listProvisioningPolicies(requestParameters: SourcesV2024ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2024ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public listSources(requestParameters: SourcesV2024ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2024ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public pingCluster(requestParameters: SourcesV2024ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2024ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putCorrelationConfig(requestParameters: SourcesV2024ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2024ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putNativeChangeDetectionConfig(requestParameters: SourcesV2024ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2024ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putProvisioningPolicy(requestParameters: SourcesV2024ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2024ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putSource(requestParameters: SourcesV2024ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putSource(requestParameters.id, requestParameters.sourceV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2024ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putSourceAttrSyncConfig(requestParameters: SourcesV2024ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2024ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public putSourceSchema(requestParameters: SourcesV2024ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2024ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public searchResourceObjects(requestParameters: SourcesV2024ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2024ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public syncAttributesForSource(requestParameters: SourcesV2024ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2024ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public testSourceConfiguration(requestParameters: SourcesV2024ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2024ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public testSourceConnection(requestParameters: SourcesV2024ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2024ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updatePasswordPolicyHolders(requestParameters: SourcesV2024ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateProvisioningPoliciesInBulk(requestParameters: SourcesV2024ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2024ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateProvisioningPolicy(requestParameters: SourcesV2024ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2024ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateSource(requestParameters: SourcesV2024ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateSourceEntitlementRequestConfig(requestParameters: SourcesV2024ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2024ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateSourceSchedule(requestParameters: SourcesV2024ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2024ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2024Api - */ - public updateSourceSchema(requestParameters: SourcesV2024ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2024ApiFp(this.configuration).updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteSourceScheduleScheduleTypeV2024 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type DeleteSourceScheduleScheduleTypeV2024 = typeof DeleteSourceScheduleScheduleTypeV2024[keyof typeof DeleteSourceScheduleScheduleTypeV2024]; -/** - * @export - */ -export const GetSourceConfigLocaleV2024 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetSourceConfigLocaleV2024 = typeof GetSourceConfigLocaleV2024[keyof typeof GetSourceConfigLocaleV2024]; -/** - * @export - */ -export const GetSourceScheduleScheduleTypeV2024 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type GetSourceScheduleScheduleTypeV2024 = typeof GetSourceScheduleScheduleTypeV2024[keyof typeof GetSourceScheduleScheduleTypeV2024]; -/** - * @export - */ -export const GetSourceSchemasIncludeTypesV2024 = { - Group: 'group', - User: 'user' -} as const; -export type GetSourceSchemasIncludeTypesV2024 = typeof GetSourceSchemasIncludeTypesV2024[keyof typeof GetSourceSchemasIncludeTypesV2024]; -/** - * @export - */ -export const UpdateSourceScheduleScheduleTypeV2024 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type UpdateSourceScheduleScheduleTypeV2024 = typeof UpdateSourceScheduleScheduleTypeV2024[keyof typeof UpdateSourceScheduleScheduleTypeV2024]; - - -/** - * SuggestedEntitlementDescriptionV2024Api - axios parameter creator - * @export - */ -export const SuggestedEntitlementDescriptionV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats: async (batchId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'batchId' is not null or undefined - assertParamExists('getSedBatchStats', 'batchId', batchId) - const localVarPath = `/suggested-entitlement-description-batches/{batchId}/stats` - .replace(`{${"batchId"}}`, encodeURIComponent(String(batchId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches: async (offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-descriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (requestedByAnyone !== undefined) { - localVarQueryParameter['requested-by-anyone'] = requestedByAnyone; - } - - if (showPendingStatusOnly !== undefined) { - localVarQueryParameter['show-pending-status-only'] = showPendingStatusOnly; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2024 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed: async (id: string, sedPatchV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSed', 'id', id) - // verify required parameter 'sedPatchV2024' is not null or undefined - assertParamExists('patchSed', 'sedPatchV2024', sedPatchV2024) - const localVarPath = `/suggested-entitlement-descriptions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedPatchV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2024 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval: async (sedApprovalV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedApprovalV2024' is not null or undefined - assertParamExists('submitSedApproval', 'sedApprovalV2024', sedApprovalV2024) - const localVarPath = `/suggested-entitlement-description-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedApprovalV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2024} sedAssignmentV2024 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment: async (sedAssignmentV2024: SedAssignmentV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedAssignmentV2024' is not null or undefined - assertParamExists('submitSedAssignment', 'sedAssignmentV2024', sedAssignmentV2024) - const localVarPath = `/suggested-entitlement-description-assignments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedAssignmentV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2024} [sedBatchRequestV2024] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest: async (sedBatchRequestV2024?: SedBatchRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedBatchRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2024Api - functional programming interface - * @export - */ -export const SuggestedEntitlementDescriptionV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SuggestedEntitlementDescriptionV2024ApiAxiosParamCreator(configuration) - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatchStats(batchId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchStats(batchId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.getSedBatchStats']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatches(offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatches(offset, limit, count, countOnly, status, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.getSedBatches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSeds(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSeds(limit, offset, count, filters, sorters, countOnly, requestedByAnyone, showPendingStatusOnly, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.listSeds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2024 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSed(id: string, sedPatchV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSed(id, sedPatchV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.patchSed']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2024 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedApproval(sedApprovalV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedApproval(sedApprovalV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.submitSedApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2024} sedAssignmentV2024 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedAssignment(sedAssignmentV2024: SedAssignmentV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedAssignment(sedAssignmentV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.submitSedAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2024} [sedBatchRequestV2024] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedBatchRequest(sedBatchRequestV2024?: SedBatchRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedBatchRequest(sedBatchRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2024Api.submitSedBatchRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2024Api - factory interface - * @export - */ -export const SuggestedEntitlementDescriptionV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SuggestedEntitlementDescriptionV2024ApiFp(configuration) - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2024ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds(requestParameters: SuggestedEntitlementDescriptionV2024ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2024ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed(requestParameters: SuggestedEntitlementDescriptionV2024ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSed(requestParameters.id, requestParameters.sedPatchV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.submitSedApproval(requestParameters.sedApprovalV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedAssignment(requestParameters.sedAssignmentV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedBatchRequest(requestParameters.sedBatchRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getSedBatchStats operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest { - /** - * Batch Id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatchStats - */ - readonly batchId: string -} - -/** - * Request parameters for getSedBatches operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatches - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatches - */ - 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatches - */ - readonly count?: boolean - - /** - * 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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatches - */ - readonly countOnly?: boolean - - /** - * Batch Status - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2024ApiGetSedBatches - */ - readonly status?: string -} - -/** - * Request parameters for listSeds operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiListSedsRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiListSedsRequest { - /** - * 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 SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - 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: **displayName, sourceName, status** - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly sorters?: string - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly countOnly?: boolean - - /** - * By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly requestedByAnyone?: boolean - - /** - * Will limit records to items that are in \"suggested\" or \"approved\" status - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2024ApiListSeds - */ - readonly showPendingStatusOnly?: boolean -} - -/** - * Request parameters for patchSed operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiPatchSedRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiPatchSedRequest { - /** - * id is sed id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2024ApiPatchSed - */ - readonly id: string - - /** - * Sed Patch Request - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2024ApiPatchSed - */ - readonly sedPatchV2024: Array -} - -/** - * Request parameters for submitSedApproval operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest { - /** - * Sed Approval - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2024ApiSubmitSedApproval - */ - readonly sedApprovalV2024: Array -} - -/** - * Request parameters for submitSedAssignment operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest { - /** - * Sed Assignment Request - * @type {SedAssignmentV2024} - * @memberof SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignment - */ - readonly sedAssignmentV2024: SedAssignmentV2024 -} - -/** - * Request parameters for submitSedBatchRequest operation in SuggestedEntitlementDescriptionV2024Api. - * @export - * @interface SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest - */ -export interface SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest { - /** - * Sed Batch Request - * @type {SedBatchRequestV2024} - * @memberof SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequest - */ - readonly sedBatchRequestV2024?: SedBatchRequestV2024 -} - -/** - * SuggestedEntitlementDescriptionV2024Api - object-oriented interface - * @export - * @class SuggestedEntitlementDescriptionV2024Api - * @extends {BaseAPI} - */ -export class SuggestedEntitlementDescriptionV2024Api extends BaseAPI { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2024ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2024ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2024ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public listSeds(requestParameters: SuggestedEntitlementDescriptionV2024ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2024ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public patchSed(requestParameters: SuggestedEntitlementDescriptionV2024ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).patchSed(requestParameters.id, requestParameters.sedPatchV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).submitSedApproval(requestParameters.sedApprovalV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).submitSedAssignment(requestParameters.sedAssignmentV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2024Api - */ - public submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2024ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2024ApiFp(this.configuration).submitSedBatchRequest(requestParameters.sedBatchRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaggedObjectsV2024Api - axios parameter creator - * @export - */ -export const TaggedObjectsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2024} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject: async (type: DeleteTaggedObjectTypeV2024, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('deleteTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2024} bulkRemoveTaggedObjectV2024 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject: async (bulkRemoveTaggedObjectV2024: BulkRemoveTaggedObjectV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRemoveTaggedObjectV2024' is not null or undefined - assertParamExists('deleteTagsToManyObject', 'bulkRemoveTaggedObjectV2024', bulkRemoveTaggedObjectV2024) - const localVarPath = `/tagged-objects/bulk-remove`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRemoveTaggedObjectV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2024} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject: async (type: GetTaggedObjectTypeV2024, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('getTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2024} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType: async (type: ListTaggedObjectsByTypeTypeV2024, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('listTaggedObjectsByType', 'type', type) - const localVarPath = `/tagged-objects/{type}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2024} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2024} taggedObjectV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject: async (type: PutTaggedObjectTypeV2024, id: string, taggedObjectV2024: TaggedObjectV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('putTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('putTaggedObject', 'id', id) - // verify required parameter 'taggedObjectV2024' is not null or undefined - assertParamExists('putTaggedObject', 'taggedObjectV2024', taggedObjectV2024) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2024} taggedObjectV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject: async (taggedObjectV2024: TaggedObjectV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taggedObjectV2024' is not null or undefined - assertParamExists('setTagToObject', 'taggedObjectV2024', taggedObjectV2024) - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2024} bulkAddTaggedObjectV2024 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects: async (bulkAddTaggedObjectV2024: BulkAddTaggedObjectV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkAddTaggedObjectV2024' is not null or undefined - assertParamExists('setTagsToManyObjects', 'bulkAddTaggedObjectV2024', bulkAddTaggedObjectV2024) - const localVarPath = `/tagged-objects/bulk-add`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkAddTaggedObjectV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaggedObjectsV2024Api - functional programming interface - * @export - */ -export const TaggedObjectsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaggedObjectsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2024} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTaggedObject(type: DeleteTaggedObjectTypeV2024, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.deleteTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2024} bulkRemoveTaggedObjectV2024 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagsToManyObject(bulkRemoveTaggedObjectV2024: BulkRemoveTaggedObjectV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObject(bulkRemoveTaggedObjectV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.deleteTagsToManyObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2024} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaggedObject(type: GetTaggedObjectTypeV2024, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.getTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjects(limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.listTaggedObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2024} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjectsByType(type: ListTaggedObjectsByTypeTypeV2024, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByType(type, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.listTaggedObjectsByType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2024} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2024} taggedObjectV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTaggedObject(type: PutTaggedObjectTypeV2024, id: string, taggedObjectV2024: TaggedObjectV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObject(type, id, taggedObjectV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.putTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2024} taggedObjectV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagToObject(taggedObjectV2024: TaggedObjectV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObject(taggedObjectV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.setTagToObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2024} bulkAddTaggedObjectV2024 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagsToManyObjects(bulkAddTaggedObjectV2024: BulkAddTaggedObjectV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjects(bulkAddTaggedObjectV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2024Api.setTagsToManyObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaggedObjectsV2024Api - factory interface - * @export - */ -export const TaggedObjectsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaggedObjectsV2024ApiFp(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2024ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject(requestParameters: TaggedObjectsV2024ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject(requestParameters: TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2024ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject(requestParameters: TaggedObjectsV2024ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2024ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects(requestParameters: TaggedObjectsV2024ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType(requestParameters: TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2024ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject(requestParameters: TaggedObjectsV2024ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2024ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject(requestParameters: TaggedObjectsV2024ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagToObject(requestParameters.taggedObjectV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2024ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects(requestParameters: TaggedObjectsV2024ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteTaggedObject operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiDeleteTaggedObjectRequest - */ -export interface TaggedObjectsV2024ApiDeleteTaggedObjectRequest { - /** - * The type of object to delete tags from. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2024ApiDeleteTaggedObject - */ - readonly type: DeleteTaggedObjectTypeV2024 - - /** - * The ID of the object to delete tags from. - * @type {string} - * @memberof TaggedObjectsV2024ApiDeleteTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for deleteTagsToManyObject operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest - */ -export interface TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkRemoveTaggedObjectV2024} - * @memberof TaggedObjectsV2024ApiDeleteTagsToManyObject - */ - readonly bulkRemoveTaggedObjectV2024: BulkRemoveTaggedObjectV2024 -} - -/** - * Request parameters for getTaggedObject operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiGetTaggedObjectRequest - */ -export interface TaggedObjectsV2024ApiGetTaggedObjectRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2024ApiGetTaggedObject - */ - readonly type: GetTaggedObjectTypeV2024 - - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TaggedObjectsV2024ApiGetTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for listTaggedObjects operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiListTaggedObjectsRequest - */ -export interface TaggedObjectsV2024ApiListTaggedObjectsRequest { - /** - * 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 TaggedObjectsV2024ApiListTaggedObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2024ApiListTaggedObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2024ApiListTaggedObjects - */ - 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @type {string} - * @memberof TaggedObjectsV2024ApiListTaggedObjects - */ - readonly filters?: string -} - -/** - * Request parameters for listTaggedObjectsByType operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest - */ -export interface TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2024ApiListTaggedObjectsByType - */ - readonly type: ListTaggedObjectsByTypeTypeV2024 - - /** - * 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 TaggedObjectsV2024ApiListTaggedObjectsByType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2024ApiListTaggedObjectsByType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2024ApiListTaggedObjectsByType - */ - 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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @type {string} - * @memberof TaggedObjectsV2024ApiListTaggedObjectsByType - */ - readonly filters?: string -} - -/** - * Request parameters for putTaggedObject operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiPutTaggedObjectRequest - */ -export interface TaggedObjectsV2024ApiPutTaggedObjectRequest { - /** - * The type of tagged object to update. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2024ApiPutTaggedObject - */ - readonly type: PutTaggedObjectTypeV2024 - - /** - * The ID of the object reference to update. - * @type {string} - * @memberof TaggedObjectsV2024ApiPutTaggedObject - */ - readonly id: string - - /** - * - * @type {TaggedObjectV2024} - * @memberof TaggedObjectsV2024ApiPutTaggedObject - */ - readonly taggedObjectV2024: TaggedObjectV2024 -} - -/** - * Request parameters for setTagToObject operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiSetTagToObjectRequest - */ -export interface TaggedObjectsV2024ApiSetTagToObjectRequest { - /** - * - * @type {TaggedObjectV2024} - * @memberof TaggedObjectsV2024ApiSetTagToObject - */ - readonly taggedObjectV2024: TaggedObjectV2024 -} - -/** - * Request parameters for setTagsToManyObjects operation in TaggedObjectsV2024Api. - * @export - * @interface TaggedObjectsV2024ApiSetTagsToManyObjectsRequest - */ -export interface TaggedObjectsV2024ApiSetTagsToManyObjectsRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkAddTaggedObjectV2024} - * @memberof TaggedObjectsV2024ApiSetTagsToManyObjects - */ - readonly bulkAddTaggedObjectV2024: BulkAddTaggedObjectV2024 -} - -/** - * TaggedObjectsV2024Api - object-oriented interface - * @export - * @class TaggedObjectsV2024Api - * @extends {BaseAPI} - */ -export class TaggedObjectsV2024Api extends BaseAPI { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2024ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public deleteTaggedObject(requestParameters: TaggedObjectsV2024ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public deleteTagsToManyObject(requestParameters: TaggedObjectsV2024ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2024ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public getTaggedObject(requestParameters: TaggedObjectsV2024ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2024ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public listTaggedObjects(requestParameters: TaggedObjectsV2024ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public listTaggedObjectsByType(requestParameters: TaggedObjectsV2024ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2024ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public putTaggedObject(requestParameters: TaggedObjectsV2024ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2024ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public setTagToObject(requestParameters: TaggedObjectsV2024ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).setTagToObject(requestParameters.taggedObjectV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2024ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2024Api - */ - public setTagsToManyObjects(requestParameters: TaggedObjectsV2024ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2024ApiFp(this.configuration).setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteTaggedObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type DeleteTaggedObjectTypeV2024 = typeof DeleteTaggedObjectTypeV2024[keyof typeof DeleteTaggedObjectTypeV2024]; -/** - * @export - */ -export const GetTaggedObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type GetTaggedObjectTypeV2024 = typeof GetTaggedObjectTypeV2024[keyof typeof GetTaggedObjectTypeV2024]; -/** - * @export - */ -export const ListTaggedObjectsByTypeTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type ListTaggedObjectsByTypeTypeV2024 = typeof ListTaggedObjectsByTypeTypeV2024[keyof typeof ListTaggedObjectsByTypeTypeV2024]; -/** - * @export - */ -export const PutTaggedObjectTypeV2024 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type PutTaggedObjectTypeV2024 = typeof PutTaggedObjectTypeV2024[keyof typeof PutTaggedObjectTypeV2024]; - - -/** - * TagsV2024Api - axios parameter creator - * @export - */ -export const TagsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2024} tagV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag: async (tagV2024: TagV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tagV2024' is not null or undefined - assertParamExists('createTag', 'tagV2024', tagV2024) - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tagV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * TagsV2024Api - functional programming interface - * @export - */ -export const TagsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TagsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2024} tagV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTag(tagV2024: TagV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTag(tagV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2024Api.createTag']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2024Api.deleteTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2024Api.getTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTags(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2024Api.listTags']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TagsV2024Api - factory interface - * @export - */ -export const TagsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TagsV2024ApiFp(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2024ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag(requestParameters: TagsV2024ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTag(requestParameters.tagV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2024ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById(requestParameters: TagsV2024ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2024ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById(requestParameters: TagsV2024ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2024ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags(requestParameters: TagsV2024ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTag operation in TagsV2024Api. - * @export - * @interface TagsV2024ApiCreateTagRequest - */ -export interface TagsV2024ApiCreateTagRequest { - /** - * - * @type {TagV2024} - * @memberof TagsV2024ApiCreateTag - */ - readonly tagV2024: TagV2024 -} - -/** - * Request parameters for deleteTagById operation in TagsV2024Api. - * @export - * @interface TagsV2024ApiDeleteTagByIdRequest - */ -export interface TagsV2024ApiDeleteTagByIdRequest { - /** - * The ID of the object reference to delete. - * @type {string} - * @memberof TagsV2024ApiDeleteTagById - */ - readonly id: string -} - -/** - * Request parameters for getTagById operation in TagsV2024Api. - * @export - * @interface TagsV2024ApiGetTagByIdRequest - */ -export interface TagsV2024ApiGetTagByIdRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TagsV2024ApiGetTagById - */ - readonly id: string -} - -/** - * Request parameters for listTags operation in TagsV2024Api. - * @export - * @interface TagsV2024ApiListTagsRequest - */ -export interface TagsV2024ApiListTagsRequest { - /** - * 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 TagsV2024ApiListTags - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TagsV2024ApiListTags - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TagsV2024ApiListTags - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof TagsV2024ApiListTags - */ - 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, name, created, modified** - * @type {string} - * @memberof TagsV2024ApiListTags - */ - readonly sorters?: string -} - -/** - * TagsV2024Api - object-oriented interface - * @export - * @class TagsV2024Api - * @extends {BaseAPI} - */ -export class TagsV2024Api extends BaseAPI { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2024ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2024Api - */ - public createTag(requestParameters: TagsV2024ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2024ApiFp(this.configuration).createTag(requestParameters.tagV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2024ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2024Api - */ - public deleteTagById(requestParameters: TagsV2024ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2024ApiFp(this.configuration).deleteTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2024ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2024Api - */ - public getTagById(requestParameters: TagsV2024ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2024ApiFp(this.configuration).getTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2024ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2024Api - */ - public listTags(requestParameters: TagsV2024ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2024ApiFp(this.configuration).listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaskManagementV2024Api - axios parameter creator - * @export - */ -export const TaskManagementV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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: 'HEAD', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaskStatus', 'id', id) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTaskStatus', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('updateTaskStatus', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaskManagementV2024Api - functional programming interface - * @export - */ -export const TaskManagementV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaskManagementV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2024Api.getPendingTaskHeaders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTasks(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2024Api.getPendingTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2024Api.getTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2024Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2024 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTaskStatus(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2024Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaskManagementV2024Api - factory interface - * @export - */ -export const TaskManagementV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaskManagementV2024ApiFp(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementV2024ApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders(requestParameters: TaskManagementV2024ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementV2024ApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks(requestParameters: TaskManagementV2024ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2024ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus(requestParameters: TaskManagementV2024ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {TaskManagementV2024ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList(requestParameters: TaskManagementV2024ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2024ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus(requestParameters: TaskManagementV2024ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPendingTaskHeaders operation in TaskManagementV2024Api. - * @export - * @interface TaskManagementV2024ApiGetPendingTaskHeadersRequest - */ -export interface TaskManagementV2024ApiGetPendingTaskHeadersRequest { - /** - * 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 TaskManagementV2024ApiGetPendingTaskHeaders - */ - 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 TaskManagementV2024ApiGetPendingTaskHeaders - */ - 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 TaskManagementV2024ApiGetPendingTaskHeaders - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingTasks operation in TaskManagementV2024Api. - * @export - * @interface TaskManagementV2024ApiGetPendingTasksRequest - */ -export interface TaskManagementV2024ApiGetPendingTasksRequest { - /** - * 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 TaskManagementV2024ApiGetPendingTasks - */ - 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 TaskManagementV2024ApiGetPendingTasks - */ - 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 TaskManagementV2024ApiGetPendingTasks - */ - readonly count?: boolean -} - -/** - * Request parameters for getTaskStatus operation in TaskManagementV2024Api. - * @export - * @interface TaskManagementV2024ApiGetTaskStatusRequest - */ -export interface TaskManagementV2024ApiGetTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2024ApiGetTaskStatus - */ - readonly id: string -} - -/** - * Request parameters for getTaskStatusList operation in TaskManagementV2024Api. - * @export - * @interface TaskManagementV2024ApiGetTaskStatusListRequest - */ -export interface TaskManagementV2024ApiGetTaskStatusListRequest { - /** - * 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 TaskManagementV2024ApiGetTaskStatusList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaskManagementV2024ApiGetTaskStatusList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaskManagementV2024ApiGetTaskStatusList - */ - 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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof TaskManagementV2024ApiGetTaskStatusList - */ - 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: **created** - * @type {string} - * @memberof TaskManagementV2024ApiGetTaskStatusList - */ - readonly sorters?: string -} - -/** - * Request parameters for updateTaskStatus operation in TaskManagementV2024Api. - * @export - * @interface TaskManagementV2024ApiUpdateTaskStatusRequest - */ -export interface TaskManagementV2024ApiUpdateTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2024ApiUpdateTaskStatus - */ - readonly id: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof TaskManagementV2024ApiUpdateTaskStatus - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * TaskManagementV2024Api - object-oriented interface - * @export - * @class TaskManagementV2024Api - * @extends {BaseAPI} - */ -export class TaskManagementV2024Api extends BaseAPI { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2025/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementV2024ApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementV2024Api - */ - public getPendingTaskHeaders(requestParameters: TaskManagementV2024ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2024ApiFp(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2025/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2025/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementV2024ApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementV2024Api - */ - public getPendingTasks(requestParameters: TaskManagementV2024ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2024ApiFp(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2024ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2024Api - */ - public getTaskStatus(requestParameters: TaskManagementV2024ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2024ApiFp(this.configuration).getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. - * @summary Retrieve task status list - * @param {TaskManagementV2024ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2024Api - */ - public getTaskStatusList(requestParameters: TaskManagementV2024ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2024ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2024ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2024Api - */ - public updateTaskStatus(requestParameters: TaskManagementV2024ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2024ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantV2024Api - axios parameter creator - * @export - */ -export const TenantV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantV2024Api - functional programming interface - * @export - */ -export const TenantV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantV2024ApiAxiosParamCreator(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenant(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenant(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantV2024Api.getTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantV2024Api - factory interface - * @export - */ -export const TenantV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantV2024ApiFp(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenant(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * TenantV2024Api - object-oriented interface - * @export - * @class TenantV2024Api - * @extends {BaseAPI} - */ -export class TenantV2024Api extends BaseAPI { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantV2024Api - */ - public getTenant(axiosOptions?: RawAxiosRequestConfig) { - return TenantV2024ApiFp(this.configuration).getTenant(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantContextV2024Api - axios parameter creator - * @export - */ -export const TenantContextV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2024} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext: async (jsonPatchOperationV2024: JsonPatchOperationV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchTenantContext', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantContextV2024Api - functional programming interface - * @export - */ -export const TenantContextV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantContextV2024ApiAxiosParamCreator(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2024Api.getTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2024} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchTenantContext(jsonPatchOperationV2024: JsonPatchOperationV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchTenantContext(jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2024Api.patchTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantContextV2024Api - factory interface - * @export - */ -export const TenantContextV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantContextV2024ApiFp(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTenantContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2024ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext(requestParameters: TenantContextV2024ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchTenantContext(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for patchTenantContext operation in TenantContextV2024Api. - * @export - * @interface TenantContextV2024ApiPatchTenantContextRequest - */ -export interface TenantContextV2024ApiPatchTenantContextRequest { - /** - * - * @type {JsonPatchOperationV2024} - * @memberof TenantContextV2024ApiPatchTenantContext - */ - readonly jsonPatchOperationV2024: JsonPatchOperationV2024 -} - -/** - * TenantContextV2024Api - object-oriented interface - * @export - * @class TenantContextV2024Api - * @extends {BaseAPI} - */ -export class TenantContextV2024Api extends BaseAPI { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2024Api - */ - public getTenantContext(axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2024ApiFp(this.configuration).getTenantContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2024ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2024Api - */ - public patchTenantContext(requestParameters: TenantContextV2024ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2024ApiFp(this.configuration).patchTenantContext(requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TransformsV2024Api - axios parameter creator - * @export - */ -export const TransformsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2024} transformV2024 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform: async (transformV2024: TransformV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'transformV2024' is not null or undefined - assertParamExists('createTransform', 'transformV2024', transformV2024) - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - 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, - }; - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2024} [transformV2024] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform: async (id: string, transformV2024?: TransformV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTransform', 'id', id) - const localVarPath = `/transforms/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TransformsV2024Api - functional programming interface - * @export - */ -export const TransformsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TransformsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2024} transformV2024 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTransform(transformV2024: TransformV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTransform(transformV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2024Api.createTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2024Api.deleteTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2024Api.getTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTransforms(offset, limit, count, name, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2024Api.listTransforms']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2024} [transformV2024] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTransform(id: string, transformV2024?: TransformV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransform(id, transformV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2024Api.updateTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TransformsV2024Api - factory interface - * @export - */ -export const TransformsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TransformsV2024ApiFp(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2024ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform(requestParameters: TransformsV2024ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTransform(requestParameters.transformV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2024ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform(requestParameters: TransformsV2024ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2024ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform(requestParameters: TransformsV2024ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2024ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms(requestParameters: TransformsV2024ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2024ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform(requestParameters: TransformsV2024ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTransform(requestParameters.id, requestParameters.transformV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTransform operation in TransformsV2024Api. - * @export - * @interface TransformsV2024ApiCreateTransformRequest - */ -export interface TransformsV2024ApiCreateTransformRequest { - /** - * The transform to be created. - * @type {TransformV2024} - * @memberof TransformsV2024ApiCreateTransform - */ - readonly transformV2024: TransformV2024 -} - -/** - * Request parameters for deleteTransform operation in TransformsV2024Api. - * @export - * @interface TransformsV2024ApiDeleteTransformRequest - */ -export interface TransformsV2024ApiDeleteTransformRequest { - /** - * ID of the transform to delete - * @type {string} - * @memberof TransformsV2024ApiDeleteTransform - */ - readonly id: string -} - -/** - * Request parameters for getTransform operation in TransformsV2024Api. - * @export - * @interface TransformsV2024ApiGetTransformRequest - */ -export interface TransformsV2024ApiGetTransformRequest { - /** - * ID of the transform to retrieve - * @type {string} - * @memberof TransformsV2024ApiGetTransform - */ - readonly id: string -} - -/** - * Request parameters for listTransforms operation in TransformsV2024Api. - * @export - * @interface TransformsV2024ApiListTransformsRequest - */ -export interface TransformsV2024ApiListTransformsRequest { - /** - * 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 TransformsV2024ApiListTransforms - */ - 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 TransformsV2024ApiListTransforms - */ - 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 TransformsV2024ApiListTransforms - */ - readonly count?: boolean - - /** - * Name of the transform to retrieve from the list. - * @type {string} - * @memberof TransformsV2024ApiListTransforms - */ - readonly name?: 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: **internal**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof TransformsV2024ApiListTransforms - */ - readonly filters?: string -} - -/** - * Request parameters for updateTransform operation in TransformsV2024Api. - * @export - * @interface TransformsV2024ApiUpdateTransformRequest - */ -export interface TransformsV2024ApiUpdateTransformRequest { - /** - * ID of the transform to update - * @type {string} - * @memberof TransformsV2024ApiUpdateTransform - */ - readonly id: string - - /** - * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @type {TransformV2024} - * @memberof TransformsV2024ApiUpdateTransform - */ - readonly transformV2024?: TransformV2024 -} - -/** - * TransformsV2024Api - object-oriented interface - * @export - * @class TransformsV2024Api - * @extends {BaseAPI} - */ -export class TransformsV2024Api extends BaseAPI { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2024ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2024Api - */ - public createTransform(requestParameters: TransformsV2024ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2024ApiFp(this.configuration).createTransform(requestParameters.transformV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2024ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2024Api - */ - public deleteTransform(requestParameters: TransformsV2024ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2024ApiFp(this.configuration).deleteTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2024ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2024Api - */ - public getTransform(requestParameters: TransformsV2024ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2024ApiFp(this.configuration).getTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2024ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2024Api - */ - public listTransforms(requestParameters: TransformsV2024ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2024ApiFp(this.configuration).listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2024ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2024Api - */ - public updateTransform(requestParameters: TransformsV2024ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2024ApiFp(this.configuration).updateTransform(requestParameters.id, requestParameters.transformV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TriggersV2024Api - axios parameter creator - * @export - */ -export const TriggersV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2024} completeInvocationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation: async (id: string, completeInvocationV2024: CompleteInvocationV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeTriggerInvocation', 'id', id) - // verify required parameter 'completeInvocationV2024' is not null or undefined - assertParamExists('completeTriggerInvocation', 'completeInvocationV2024', completeInvocationV2024) - const localVarPath = `/trigger-invocations/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(completeInvocationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2024} subscriptionPostRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription: async (subscriptionPostRequestV2024: SubscriptionPostRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subscriptionPostRequestV2024' is not null or undefined - assertParamExists('createSubscription', 'subscriptionPostRequestV2024', subscriptionPostRequestV2024) - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPostRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSubscription', 'id', id) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-invocations/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription: async (id: string, subscriptionPatchRequestInnerV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSubscription', 'id', id) - // verify required parameter 'subscriptionPatchRequestInnerV2024' is not null or undefined - assertParamExists('patchSubscription', 'subscriptionPatchRequestInnerV2024', subscriptionPatchRequestInnerV2024) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(subscriptionPatchRequestInnerV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2024} testInvocationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation: async (testInvocationV2024: TestInvocationV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'testInvocationV2024' is not null or undefined - assertParamExists('startTestTriggerInvocation', 'testInvocationV2024', testInvocationV2024) - const localVarPath = `/trigger-invocations/test`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testInvocationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2024} validateFilterInputDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter: async (validateFilterInputDtoV2024: ValidateFilterInputDtoV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'validateFilterInputDtoV2024' is not null or undefined - assertParamExists('testSubscriptionFilter', 'validateFilterInputDtoV2024', validateFilterInputDtoV2024) - const localVarPath = `/trigger-subscriptions/validate-filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(validateFilterInputDtoV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2024} subscriptionPutRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription: async (id: string, subscriptionPutRequestV2024: SubscriptionPutRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSubscription', 'id', id) - // verify required parameter 'subscriptionPutRequestV2024' is not null or undefined - assertParamExists('updateSubscription', 'subscriptionPutRequestV2024', subscriptionPutRequestV2024) - const localVarPath = `/trigger-subscriptions/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPutRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TriggersV2024Api - functional programming interface - * @export - */ -export const TriggersV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TriggersV2024ApiAxiosParamCreator(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2024} completeInvocationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeTriggerInvocation(id: string, completeInvocationV2024: CompleteInvocationV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocation(id, completeInvocationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.completeTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2024} subscriptionPostRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSubscription(subscriptionPostRequestV2024: SubscriptionPostRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(subscriptionPostRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.createSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSubscription(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscription(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.deleteSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSubscriptions(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptions(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.listSubscriptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggerInvocationStatus(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatus(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.listTriggerInvocationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggers(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggers(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.listTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSubscription(id: string, subscriptionPatchRequestInnerV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscription(id, subscriptionPatchRequestInnerV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.patchSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2024} testInvocationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTestTriggerInvocation(testInvocationV2024: TestInvocationV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocation(testInvocationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.startTestTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2024} validateFilterInputDtoV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSubscriptionFilter(validateFilterInputDtoV2024: ValidateFilterInputDtoV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilter(validateFilterInputDtoV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.testSubscriptionFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2024} subscriptionPutRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSubscription(id: string, subscriptionPutRequestV2024: SubscriptionPutRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscription(id, subscriptionPutRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2024Api.updateSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TriggersV2024Api - factory interface - * @export - */ -export const TriggersV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TriggersV2024ApiFp(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2024ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation(requestParameters: TriggersV2024ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2024ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription(requestParameters: TriggersV2024ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSubscription(requestParameters.subscriptionPostRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2024ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription(requestParameters: TriggersV2024ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2024ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions(requestParameters: TriggersV2024ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2024ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus(requestParameters: TriggersV2024ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2024ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers(requestParameters: TriggersV2024ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2024ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription(requestParameters: TriggersV2024ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2024ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation(requestParameters: TriggersV2024ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.startTestTriggerInvocation(requestParameters.testInvocationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2024ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter(requestParameters: TriggersV2024ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSubscriptionFilter(requestParameters.validateFilterInputDtoV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2024ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription(requestParameters: TriggersV2024ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeTriggerInvocation operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiCompleteTriggerInvocationRequest - */ -export interface TriggersV2024ApiCompleteTriggerInvocationRequest { - /** - * The ID of the invocation to complete. - * @type {string} - * @memberof TriggersV2024ApiCompleteTriggerInvocation - */ - readonly id: string - - /** - * - * @type {CompleteInvocationV2024} - * @memberof TriggersV2024ApiCompleteTriggerInvocation - */ - readonly completeInvocationV2024: CompleteInvocationV2024 -} - -/** - * Request parameters for createSubscription operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiCreateSubscriptionRequest - */ -export interface TriggersV2024ApiCreateSubscriptionRequest { - /** - * - * @type {SubscriptionPostRequestV2024} - * @memberof TriggersV2024ApiCreateSubscription - */ - readonly subscriptionPostRequestV2024: SubscriptionPostRequestV2024 -} - -/** - * Request parameters for deleteSubscription operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiDeleteSubscriptionRequest - */ -export interface TriggersV2024ApiDeleteSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2024ApiDeleteSubscription - */ - readonly id: string -} - -/** - * Request parameters for listSubscriptions operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiListSubscriptionsRequest - */ -export interface TriggersV2024ApiListSubscriptionsRequest { - /** - * 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 TriggersV2024ApiListSubscriptions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2024ApiListSubscriptions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2024ApiListSubscriptions - */ - 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* **triggerId**: *eq* **type**: *eq, le* - * @type {string} - * @memberof TriggersV2024ApiListSubscriptions - */ - 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: **triggerId, triggerName** - * @type {string} - * @memberof TriggersV2024ApiListSubscriptions - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggerInvocationStatus operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiListTriggerInvocationStatusRequest - */ -export interface TriggersV2024ApiListTriggerInvocationStatusRequest { - /** - * 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 TriggersV2024ApiListTriggerInvocationStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2024ApiListTriggerInvocationStatus - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2024ApiListTriggerInvocationStatus - */ - 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: **triggerId**: *eq* **subscriptionId**: *eq* - * @type {string} - * @memberof TriggersV2024ApiListTriggerInvocationStatus - */ - 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: **triggerId, subscriptionName, created, completed** - * @type {string} - * @memberof TriggersV2024ApiListTriggerInvocationStatus - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggers operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiListTriggersRequest - */ -export interface TriggersV2024ApiListTriggersRequest { - /** - * 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 TriggersV2024ApiListTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2024ApiListTriggers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2024ApiListTriggers - */ - 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, ge, le* - * @type {string} - * @memberof TriggersV2024ApiListTriggers - */ - 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, name** - * @type {string} - * @memberof TriggersV2024ApiListTriggers - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSubscription operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiPatchSubscriptionRequest - */ -export interface TriggersV2024ApiPatchSubscriptionRequest { - /** - * ID of the Subscription to patch - * @type {string} - * @memberof TriggersV2024ApiPatchSubscription - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof TriggersV2024ApiPatchSubscription - */ - readonly subscriptionPatchRequestInnerV2024: Array -} - -/** - * Request parameters for startTestTriggerInvocation operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiStartTestTriggerInvocationRequest - */ -export interface TriggersV2024ApiStartTestTriggerInvocationRequest { - /** - * - * @type {TestInvocationV2024} - * @memberof TriggersV2024ApiStartTestTriggerInvocation - */ - readonly testInvocationV2024: TestInvocationV2024 -} - -/** - * Request parameters for testSubscriptionFilter operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiTestSubscriptionFilterRequest - */ -export interface TriggersV2024ApiTestSubscriptionFilterRequest { - /** - * - * @type {ValidateFilterInputDtoV2024} - * @memberof TriggersV2024ApiTestSubscriptionFilter - */ - readonly validateFilterInputDtoV2024: ValidateFilterInputDtoV2024 -} - -/** - * Request parameters for updateSubscription operation in TriggersV2024Api. - * @export - * @interface TriggersV2024ApiUpdateSubscriptionRequest - */ -export interface TriggersV2024ApiUpdateSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2024ApiUpdateSubscription - */ - readonly id: string - - /** - * - * @type {SubscriptionPutRequestV2024} - * @memberof TriggersV2024ApiUpdateSubscription - */ - readonly subscriptionPutRequestV2024: SubscriptionPutRequestV2024 -} - -/** - * TriggersV2024Api - object-oriented interface - * @export - * @class TriggersV2024Api - * @extends {BaseAPI} - */ -export class TriggersV2024Api extends BaseAPI { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2024ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public completeTriggerInvocation(requestParameters: TriggersV2024ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2024ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public createSubscription(requestParameters: TriggersV2024ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).createSubscription(requestParameters.subscriptionPostRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2024ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public deleteSubscription(requestParameters: TriggersV2024ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2024ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public listSubscriptions(requestParameters: TriggersV2024ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2024ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public listTriggerInvocationStatus(requestParameters: TriggersV2024ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2024ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public listTriggers(requestParameters: TriggersV2024ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2024ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public patchSubscription(requestParameters: TriggersV2024ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2024ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public startTestTriggerInvocation(requestParameters: TriggersV2024ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).startTestTriggerInvocation(requestParameters.testInvocationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2024ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public testSubscriptionFilter(requestParameters: TriggersV2024ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).testSubscriptionFilter(requestParameters.validateFilterInputDtoV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2024ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2024Api - */ - public updateSubscription(requestParameters: TriggersV2024ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2024ApiFp(this.configuration).updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * UIMetadataV2024Api - axios parameter creator - * @export - */ -export const UIMetadataV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2024} tenantUiMetadataItemUpdateRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata: async (tenantUiMetadataItemUpdateRequestV2024: TenantUiMetadataItemUpdateRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantUiMetadataItemUpdateRequestV2024' is not null or undefined - assertParamExists('setTenantUiMetadata', 'tenantUiMetadataItemUpdateRequestV2024', tenantUiMetadataItemUpdateRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantUiMetadataItemUpdateRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * UIMetadataV2024Api - functional programming interface - * @export - */ -export const UIMetadataV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UIMetadataV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantUiMetadata(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantUiMetadata(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2024Api.getTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2024} tenantUiMetadataItemUpdateRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2024: TenantUiMetadataItemUpdateRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2024Api.setTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * UIMetadataV2024Api - factory interface - * @export - */ -export const UIMetadataV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UIMetadataV2024ApiFp(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2024ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata(requestParameters: UIMetadataV2024ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2024ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata(requestParameters: UIMetadataV2024ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTenantUiMetadata operation in UIMetadataV2024Api. - * @export - * @interface UIMetadataV2024ApiGetTenantUiMetadataRequest - */ -export interface UIMetadataV2024ApiGetTenantUiMetadataRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2024ApiGetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setTenantUiMetadata operation in UIMetadataV2024Api. - * @export - * @interface UIMetadataV2024ApiSetTenantUiMetadataRequest - */ -export interface UIMetadataV2024ApiSetTenantUiMetadataRequest { - /** - * - * @type {TenantUiMetadataItemUpdateRequestV2024} - * @memberof UIMetadataV2024ApiSetTenantUiMetadata - */ - readonly tenantUiMetadataItemUpdateRequestV2024: TenantUiMetadataItemUpdateRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2024ApiSetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * UIMetadataV2024Api - object-oriented interface - * @export - * @class UIMetadataV2024Api - * @extends {BaseAPI} - */ -export class UIMetadataV2024Api extends BaseAPI { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2024ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2024Api - */ - public getTenantUiMetadata(requestParameters: UIMetadataV2024ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2024ApiFp(this.configuration).getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2024ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2024Api - */ - public setTenantUiMetadata(requestParameters: UIMetadataV2024ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2024ApiFp(this.configuration).setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkItemsV2024Api - axios parameter creator - * @export - */ -export const WorkItemsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('approveApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/approve/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeWorkItem', 'id', id) - const localVarPath = `/work-items/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2024} workItemForwardV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem: async (id: string, workItemForwardV2024: WorkItemForwardV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('forwardWorkItem', 'id', id) - // verify required parameter 'workItemForwardV2024' is not null or undefined - assertParamExists('forwardWorkItem', 'workItemForwardV2024', workItemForwardV2024) - const localVarPath = `/work-items/{id}/forward` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workItemForwardV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkItem', 'id', id) - const localVarPath = `/work-items/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('rejectApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/reject/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitAccountSelection', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('submitAccountSelection', 'requestBody', requestBody) - const localVarPath = `/work-items/{id}/submit-account-selection` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkItemsV2024Api - functional programming interface - * @export - */ -export const WorkItemsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkItemsV2024ApiAxiosParamCreator(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.approveApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.approveApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.completeWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2024} workItemForwardV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardWorkItem(id: string, workItemForwardV2024: WorkItemForwardV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardWorkItem(id, workItemForwardV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.forwardWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItems(ownerId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.getCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountCompletedWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.getCountCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.getCountWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItem(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.getWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItemsSummary(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummary(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.getWorkItemsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkItems(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItems(limit, offset, count, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.listWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.rejectApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.rejectApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitAccountSelection(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelection(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2024Api.submitAccountSelection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkItemsV2024Api - factory interface - * @export - */ -export const WorkItemsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkItemsV2024ApiFp(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2024ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem(requestParameters: WorkItemsV2024ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2024ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk(requestParameters: WorkItemsV2024ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2024ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem(requestParameters: WorkItemsV2024ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2024ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem(requestParameters: WorkItemsV2024ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2024ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems(requestParameters: WorkItemsV2024ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2024ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems(requestParameters: WorkItemsV2024ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2024ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems(requestParameters: WorkItemsV2024ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2024ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem(requestParameters: WorkItemsV2024ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItem(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2024ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary(requestParameters: WorkItemsV2024ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2024ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems(requestParameters: WorkItemsV2024ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2024ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem(requestParameters: WorkItemsV2024ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2024ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk(requestParameters: WorkItemsV2024ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2024ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection(requestParameters: WorkItemsV2024ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApprovalItem operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiApproveApprovalItemRequest - */ -export interface WorkItemsV2024ApiApproveApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiApproveApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2024ApiApproveApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for approveApprovalItemsInBulk operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiApproveApprovalItemsInBulkRequest - */ -export interface WorkItemsV2024ApiApproveApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiApproveApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for completeWorkItem operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiCompleteWorkItemRequest - */ -export interface WorkItemsV2024ApiCompleteWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiCompleteWorkItem - */ - readonly id: string - - /** - * Body is the request payload to create form definition request - * @type {string} - * @memberof WorkItemsV2024ApiCompleteWorkItem - */ - readonly body?: string | null -} - -/** - * Request parameters for forwardWorkItem operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiForwardWorkItemRequest - */ -export interface WorkItemsV2024ApiForwardWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiForwardWorkItem - */ - readonly id: string - - /** - * - * @type {WorkItemForwardV2024} - * @memberof WorkItemsV2024ApiForwardWorkItem - */ - readonly workItemForwardV2024: WorkItemForwardV2024 -} - -/** - * Request parameters for getCompletedWorkItems operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiGetCompletedWorkItemsRequest - */ -export interface WorkItemsV2024ApiGetCompletedWorkItemsRequest { - /** - * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @type {string} - * @memberof WorkItemsV2024ApiGetCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2024ApiGetCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2024ApiGetCompletedWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2024ApiGetCompletedWorkItems - */ - readonly count?: boolean -} - -/** - * Request parameters for getCountCompletedWorkItems operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiGetCountCompletedWorkItemsRequest - */ -export interface WorkItemsV2024ApiGetCountCompletedWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2024ApiGetCountCompletedWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getCountWorkItems operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiGetCountWorkItemsRequest - */ -export interface WorkItemsV2024ApiGetCountWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2024ApiGetCountWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItem operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiGetWorkItemRequest - */ -export interface WorkItemsV2024ApiGetWorkItemRequest { - /** - * ID of the work item. - * @type {string} - * @memberof WorkItemsV2024ApiGetWorkItem - */ - readonly id: string -} - -/** - * Request parameters for getWorkItemsSummary operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiGetWorkItemsSummaryRequest - */ -export interface WorkItemsV2024ApiGetWorkItemsSummaryRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2024ApiGetWorkItemsSummary - */ - readonly ownerId?: string -} - -/** - * Request parameters for listWorkItems operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiListWorkItemsRequest - */ -export interface WorkItemsV2024ApiListWorkItemsRequest { - /** - * 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 WorkItemsV2024ApiListWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2024ApiListWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2024ApiListWorkItems - */ - readonly count?: boolean - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2024ApiListWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for rejectApprovalItem operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiRejectApprovalItemRequest - */ -export interface WorkItemsV2024ApiRejectApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiRejectApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2024ApiRejectApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for rejectApprovalItemsInBulk operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiRejectApprovalItemsInBulkRequest - */ -export interface WorkItemsV2024ApiRejectApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiRejectApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for submitAccountSelection operation in WorkItemsV2024Api. - * @export - * @interface WorkItemsV2024ApiSubmitAccountSelectionRequest - */ -export interface WorkItemsV2024ApiSubmitAccountSelectionRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2024ApiSubmitAccountSelection - */ - readonly id: string - - /** - * Account Selection Data map, keyed on fieldName - * @type {{ [key: string]: any; }} - * @memberof WorkItemsV2024ApiSubmitAccountSelection - */ - readonly requestBody: { [key: string]: any; } -} - -/** - * WorkItemsV2024Api - object-oriented interface - * @export - * @class WorkItemsV2024Api - * @extends {BaseAPI} - */ -export class WorkItemsV2024Api extends BaseAPI { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2024ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public approveApprovalItem(requestParameters: WorkItemsV2024ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2024ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public approveApprovalItemsInBulk(requestParameters: WorkItemsV2024ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2024ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public completeWorkItem(requestParameters: WorkItemsV2024ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2024ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public forwardWorkItem(requestParameters: WorkItemsV2024ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2024ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public getCompletedWorkItems(requestParameters: WorkItemsV2024ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2024ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public getCountCompletedWorkItems(requestParameters: WorkItemsV2024ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2024ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public getCountWorkItems(requestParameters: WorkItemsV2024ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2024ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public getWorkItem(requestParameters: WorkItemsV2024ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).getWorkItem(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2024ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public getWorkItemsSummary(requestParameters: WorkItemsV2024ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2024ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public listWorkItems(requestParameters: WorkItemsV2024ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2024ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public rejectApprovalItem(requestParameters: WorkItemsV2024ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2024ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public rejectApprovalItemsInBulk(requestParameters: WorkItemsV2024ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2024ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2024Api - */ - public submitAccountSelection(requestParameters: WorkItemsV2024ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2024ApiFp(this.configuration).submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkReassignmentV2024Api - axios parameter creator - * @export - */ -export const WorkReassignmentV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2024} configurationItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration: async (configurationItemRequestV2024: ConfigurationItemRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configurationItemRequestV2024' is not null or undefined - assertParamExists('createReassignmentConfiguration', 'configurationItemRequestV2024', configurationItemRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2024} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2024} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2024, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/evaluate/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (exclusionFilters) { - localVarQueryParameter['exclusionFilters'] = exclusionFilters.join(COLLECTION_FORMATS.csv); - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getReassignmentConfiguration', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2024} configurationItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig: async (identityId: string, configurationItemRequestV2024: ConfigurationItemRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('putReassignmentConfig', 'identityId', identityId) - // verify required parameter 'configurationItemRequestV2024' is not null or undefined - assertParamExists('putReassignmentConfig', 'configurationItemRequestV2024', configurationItemRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2024} tenantConfigurationRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration: async (tenantConfigurationRequestV2024: TenantConfigurationRequestV2024, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantConfigurationRequestV2024' is not null or undefined - assertParamExists('putTenantConfiguration', 'tenantConfigurationRequestV2024', tenantConfigurationRequestV2024) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantConfigurationRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkReassignmentV2024Api - functional programming interface - * @export - */ -export const WorkReassignmentV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkReassignmentV2024ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2024} configurationItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createReassignmentConfiguration(configurationItemRequestV2024: ConfigurationItemRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createReassignmentConfiguration(configurationItemRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.createReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2024} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReassignmentConfiguration(identityId, configType, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.deleteReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2024} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEvaluateReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2024, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluateReassignmentConfiguration(identityId, configType, exclusionFilters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.getEvaluateReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfigTypes(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigTypes(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.getReassignmentConfigTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfiguration(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfiguration(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.getReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantConfigConfiguration(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantConfigConfiguration(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.getTenantConfigConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listReassignmentConfigurations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReassignmentConfigurations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.listReassignmentConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2024} configurationItemRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putReassignmentConfig(identityId: string, configurationItemRequestV2024: ConfigurationItemRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putReassignmentConfig(identityId, configurationItemRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.putReassignmentConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2024} tenantConfigurationRequestV2024 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTenantConfiguration(tenantConfigurationRequestV2024: TenantConfigurationRequestV2024, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTenantConfiguration(tenantConfigurationRequestV2024, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2024Api.putTenantConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkReassignmentV2024Api - factory interface - * @export - */ -export const WorkReassignmentV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkReassignmentV2024ApiFp(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createReassignmentConfiguration(requestParameters.configurationItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes(requestParameters: WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2024ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration(requestParameters: WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2024ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations(requestParameters: WorkReassignmentV2024ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2024ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig(requestParameters: WorkReassignmentV2024ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2024ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration(requestParameters: WorkReassignmentV2024ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTenantConfiguration(requestParameters.tenantConfigurationRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createReassignmentConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest { - /** - * - * @type {ConfigurationItemRequestV2024} - * @memberof WorkReassignmentV2024ApiCreateReassignmentConfiguration - */ - readonly configurationItemRequestV2024: ConfigurationItemRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiCreateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteReassignmentConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2024ApiDeleteReassignmentConfiguration - */ - readonly identityId: string - - /** - * - * @type {ConfigTypeEnumV2024} - * @memberof WorkReassignmentV2024ApiDeleteReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiDeleteReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEvaluateReassignmentConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2024ApiGetEvaluateReassignmentConfiguration - */ - readonly identityId: string - - /** - * Reassignment work type - * @type {ConfigTypeEnumV2024} - * @memberof WorkReassignmentV2024ApiGetEvaluateReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2024 - - /** - * Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @type {Array} - * @memberof WorkReassignmentV2024ApiGetEvaluateReassignmentConfiguration - */ - readonly exclusionFilters?: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiGetEvaluateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfigTypes operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest - */ -export interface WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiGetReassignmentConfigTypes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiGetReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2024ApiGetReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2024ApiGetReassignmentConfiguration - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiGetReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getTenantConfigConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest - */ -export interface WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiGetTenantConfigConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listReassignmentConfigurations operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiListReassignmentConfigurationsRequest - */ -export interface WorkReassignmentV2024ApiListReassignmentConfigurationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiListReassignmentConfigurations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putReassignmentConfig operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiPutReassignmentConfigRequest - */ -export interface WorkReassignmentV2024ApiPutReassignmentConfigRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2024ApiPutReassignmentConfig - */ - readonly identityId: string - - /** - * - * @type {ConfigurationItemRequestV2024} - * @memberof WorkReassignmentV2024ApiPutReassignmentConfig - */ - readonly configurationItemRequestV2024: ConfigurationItemRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiPutReassignmentConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putTenantConfiguration operation in WorkReassignmentV2024Api. - * @export - * @interface WorkReassignmentV2024ApiPutTenantConfigurationRequest - */ -export interface WorkReassignmentV2024ApiPutTenantConfigurationRequest { - /** - * - * @type {TenantConfigurationRequestV2024} - * @memberof WorkReassignmentV2024ApiPutTenantConfiguration - */ - readonly tenantConfigurationRequestV2024: TenantConfigurationRequestV2024 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2024ApiPutTenantConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * WorkReassignmentV2024Api - object-oriented interface - * @export - * @class WorkReassignmentV2024Api - * @extends {BaseAPI} - */ -export class WorkReassignmentV2024Api extends BaseAPI { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public createReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).createReassignmentConfiguration(requestParameters.configurationItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public getReassignmentConfigTypes(requestParameters: WorkReassignmentV2024ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2024ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public getReassignmentConfiguration(requestParameters: WorkReassignmentV2024ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public getTenantConfigConfiguration(requestParameters: WorkReassignmentV2024ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2024ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public listReassignmentConfigurations(requestParameters: WorkReassignmentV2024ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2024ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public putReassignmentConfig(requestParameters: WorkReassignmentV2024ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2024ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2024Api - */ - public putTenantConfiguration(requestParameters: WorkReassignmentV2024ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2024ApiFp(this.configuration).putTenantConfiguration(requestParameters.tenantConfigurationRequestV2024, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkflowsV2024Api - axios parameter creator - * @export - */ -export const WorkflowsV2024ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2024} [createExternalExecuteWorkflowRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow: async (id: string, createExternalExecuteWorkflowRequestV2024?: CreateExternalExecuteWorkflowRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createExternalExecuteWorkflowRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2024} createWorkflowRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow: async (createWorkflowRequestV2024: CreateWorkflowRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createWorkflowRequestV2024' is not null or undefined - assertParamExists('createWorkflow', 'createWorkflowRequestV2024', createWorkflowRequestV2024) - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createWorkflowRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createWorkflowExternalTrigger', 'id', id) - const localVarPath = `/workflows/{id}/external/oauth-clients` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistory', 'id', id) - const localVarPath = `/workflow-executions/{id}/history` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutions', 'id', id) - const localVarPath = `/workflows/{id}/executions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/operators`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow: async (id: string, jsonPatchOperationV2024: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkflow', 'id', id) - // verify required parameter 'jsonPatchOperationV2024' is not null or undefined - assertParamExists('patchWorkflow', 'jsonPatchOperationV2024', jsonPatchOperationV2024) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2024} workflowBodyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow: async (id: string, workflowBodyV2024: WorkflowBodyV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putWorkflow', 'id', id) - // verify required parameter 'workflowBodyV2024' is not null or undefined - assertParamExists('putWorkflow', 'workflowBodyV2024', workflowBodyV2024) - const localVarPath = `/workflows/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workflowBodyV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2024} [testExternalExecuteWorkflowRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow: async (id: string, testExternalExecuteWorkflowRequestV2024?: TestExternalExecuteWorkflowRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testExternalExecuteWorkflowRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2024} testWorkflowRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow: async (id: string, testWorkflowRequestV2024: TestWorkflowRequestV2024, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testWorkflow', 'id', id) - // verify required parameter 'testWorkflowRequestV2024' is not null or undefined - assertParamExists('testWorkflow', 'testWorkflowRequestV2024', testWorkflowRequestV2024) - const localVarPath = `/workflows/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testWorkflowRequestV2024, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkflowsV2024Api - functional programming interface - * @export - */ -export const WorkflowsV2024ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkflowsV2024ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.cancelWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2024} [createExternalExecuteWorkflowRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createExternalExecuteWorkflow(id: string, createExternalExecuteWorkflowRequestV2024?: CreateExternalExecuteWorkflowRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createExternalExecuteWorkflow(id, createExternalExecuteWorkflowRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.createExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2024} createWorkflowRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflow(createWorkflowRequestV2024: CreateWorkflowRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflow(createWorkflowRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.createWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowExternalTrigger(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.createWorkflowExternalTrigger']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.deleteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.getWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.getWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutionHistory(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistory(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.getWorkflowExecutionHistory']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutions(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.getWorkflowExecutions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompleteWorkflowLibrary(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibrary(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.listCompleteWorkflowLibrary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryActions(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActions(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.listWorkflowLibraryActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperators(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.listWorkflowLibraryOperators']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryTriggers(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggers(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.listWorkflowLibraryTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflows(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.listWorkflows']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkflow(id: string, jsonPatchOperationV2024: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflow(id, jsonPatchOperationV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.patchWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2024} workflowBodyV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putWorkflow(id: string, workflowBodyV2024: WorkflowBodyV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflow(id, workflowBodyV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.putWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2024} [testExternalExecuteWorkflowRequestV2024] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequestV2024?: TestExternalExecuteWorkflowRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflow(id, testExternalExecuteWorkflowRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.testExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2024} testWorkflowRequestV2024 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testWorkflow(id: string, testWorkflowRequestV2024: TestWorkflowRequestV2024, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflow(id, testWorkflowRequestV2024, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2024Api.testWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkflowsV2024Api - factory interface - * @export - */ -export const WorkflowsV2024ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkflowsV2024ApiFp(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2024ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution(requestParameters: WorkflowsV2024ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow(requestParameters: WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2024ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow(requestParameters: WorkflowsV2024ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflow(requestParameters.createWorkflowRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger(requestParameters: WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2024ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow(requestParameters: WorkflowsV2024ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2024ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow(requestParameters: WorkflowsV2024ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2024ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2024ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2024ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary(requestParameters: WorkflowsV2024ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2024ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions(requestParameters: WorkflowsV2024ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryOperators(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2024ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers(requestParameters: WorkflowsV2024ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflows(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2024ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow(requestParameters: WorkflowsV2024ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2024ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow(requestParameters: WorkflowsV2024ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putWorkflow(requestParameters.id, requestParameters.workflowBodyV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2024ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow(requestParameters: WorkflowsV2024ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2024ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow(requestParameters: WorkflowsV2024ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2024, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelWorkflowExecution operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiCancelWorkflowExecutionRequest - */ -export interface WorkflowsV2024ApiCancelWorkflowExecutionRequest { - /** - * The workflow execution ID - * @type {string} - * @memberof WorkflowsV2024ApiCancelWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for createExternalExecuteWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2024ApiCreateExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {CreateExternalExecuteWorkflowRequestV2024} - * @memberof WorkflowsV2024ApiCreateExternalExecuteWorkflow - */ - readonly createExternalExecuteWorkflowRequestV2024?: CreateExternalExecuteWorkflowRequestV2024 -} - -/** - * Request parameters for createWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiCreateWorkflowRequest - */ -export interface WorkflowsV2024ApiCreateWorkflowRequest { - /** - * - * @type {CreateWorkflowRequestV2024} - * @memberof WorkflowsV2024ApiCreateWorkflow - */ - readonly createWorkflowRequestV2024: CreateWorkflowRequestV2024 -} - -/** - * Request parameters for createWorkflowExternalTrigger operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest - */ -export interface WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2024ApiCreateWorkflowExternalTrigger - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiDeleteWorkflowRequest - */ -export interface WorkflowsV2024ApiDeleteWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2024ApiDeleteWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiGetWorkflowRequest - */ -export interface WorkflowsV2024ApiGetWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2024ApiGetWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecution operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiGetWorkflowExecutionRequest - */ -export interface WorkflowsV2024ApiGetWorkflowExecutionRequest { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowsV2024ApiGetWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistory operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest - */ -export interface WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsV2024ApiGetWorkflowExecutionHistory - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutions operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiGetWorkflowExecutionsRequest - */ -export interface WorkflowsV2024ApiGetWorkflowExecutionsRequest { - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowsV2024ApiGetWorkflowExecutions - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2024ApiGetWorkflowExecutions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2024ApiGetWorkflowExecutions - */ - readonly offset?: number - - /** - * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @type {string} - * @memberof WorkflowsV2024ApiGetWorkflowExecutions - */ - readonly filters?: string -} - -/** - * Request parameters for listCompleteWorkflowLibrary operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiListCompleteWorkflowLibraryRequest - */ -export interface WorkflowsV2024ApiListCompleteWorkflowLibraryRequest { - /** - * 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 WorkflowsV2024ApiListCompleteWorkflowLibrary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2024ApiListCompleteWorkflowLibrary - */ - readonly offset?: number -} - -/** - * Request parameters for listWorkflowLibraryActions operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiListWorkflowLibraryActionsRequest - */ -export interface WorkflowsV2024ApiListWorkflowLibraryActionsRequest { - /** - * 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 WorkflowsV2024ApiListWorkflowLibraryActions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2024ApiListWorkflowLibraryActions - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsV2024ApiListWorkflowLibraryActions - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflowLibraryTriggers operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiListWorkflowLibraryTriggersRequest - */ -export interface WorkflowsV2024ApiListWorkflowLibraryTriggersRequest { - /** - * 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 WorkflowsV2024ApiListWorkflowLibraryTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2024ApiListWorkflowLibraryTriggers - */ - readonly offset?: number - - /** - * 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* **type**: *eq* - * @type {string} - * @memberof WorkflowsV2024ApiListWorkflowLibraryTriggers - */ - readonly filters?: string -} - -/** - * Request parameters for patchWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiPatchWorkflowRequest - */ -export interface WorkflowsV2024ApiPatchWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2024ApiPatchWorkflow - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof WorkflowsV2024ApiPatchWorkflow - */ - readonly jsonPatchOperationV2024: Array -} - -/** - * Request parameters for putWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiPutWorkflowRequest - */ -export interface WorkflowsV2024ApiPutWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2024ApiPutWorkflow - */ - readonly id: string - - /** - * - * @type {WorkflowBodyV2024} - * @memberof WorkflowsV2024ApiPutWorkflow - */ - readonly workflowBodyV2024: WorkflowBodyV2024 -} - -/** - * Request parameters for testExternalExecuteWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiTestExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2024ApiTestExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2024ApiTestExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {TestExternalExecuteWorkflowRequestV2024} - * @memberof WorkflowsV2024ApiTestExternalExecuteWorkflow - */ - readonly testExternalExecuteWorkflowRequestV2024?: TestExternalExecuteWorkflowRequestV2024 -} - -/** - * Request parameters for testWorkflow operation in WorkflowsV2024Api. - * @export - * @interface WorkflowsV2024ApiTestWorkflowRequest - */ -export interface WorkflowsV2024ApiTestWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2024ApiTestWorkflow - */ - readonly id: string - - /** - * - * @type {TestWorkflowRequestV2024} - * @memberof WorkflowsV2024ApiTestWorkflow - */ - readonly testWorkflowRequestV2024: TestWorkflowRequestV2024 -} - -/** - * WorkflowsV2024Api - object-oriented interface - * @export - * @class WorkflowsV2024Api - * @extends {BaseAPI} - */ -export class WorkflowsV2024Api extends BaseAPI { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2024ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public cancelWorkflowExecution(requestParameters: WorkflowsV2024ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public createExternalExecuteWorkflow(requestParameters: WorkflowsV2024ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2024ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public createWorkflow(requestParameters: WorkflowsV2024ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).createWorkflow(requestParameters.createWorkflowRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public createWorkflowExternalTrigger(requestParameters: WorkflowsV2024ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2024ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public deleteWorkflow(requestParameters: WorkflowsV2024ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2024ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public getWorkflow(requestParameters: WorkflowsV2024ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).getWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2024ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public getWorkflowExecution(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public getWorkflowExecutionHistory(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2024ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public getWorkflowExecutions(requestParameters: WorkflowsV2024ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2024ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public listCompleteWorkflowLibrary(requestParameters: WorkflowsV2024ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2024ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public listWorkflowLibraryActions(requestParameters: WorkflowsV2024ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).listWorkflowLibraryOperators(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2024ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public listWorkflowLibraryTriggers(requestParameters: WorkflowsV2024ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public listWorkflows(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).listWorkflows(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2024ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public patchWorkflow(requestParameters: WorkflowsV2024ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2024ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public putWorkflow(requestParameters: WorkflowsV2024ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).putWorkflow(requestParameters.id, requestParameters.workflowBodyV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2024ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public testExternalExecuteWorkflow(requestParameters: WorkflowsV2024ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2024ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2024Api - */ - public testWorkflow(requestParameters: WorkflowsV2024ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2024ApiFp(this.configuration).testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2024, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - diff --git a/sdk-output/v2025/api.ts b/sdk-output/v2025/api.ts deleted file mode 100644 index a55a6fd4..00000000 --- a/sdk-output/v2025/api.ts +++ /dev/null @@ -1,147752 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud V2025 API - * 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: v2025 - * - * - * 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'; - -/** - * This is used for access configuration for a lifecycle state - * @export - * @interface AccessActionConfigurationV2025 - */ -export interface AccessActionConfigurationV2025 { - /** - * If true, then all accesses are marked for removal. - * @type {boolean} - * @memberof AccessActionConfigurationV2025 - */ - 'removeAllAccessEnabled'?: boolean; -} -/** - * Owner\'s identity. - * @export - * @interface AccessAppsOwnerV2025 - */ -export interface AccessAppsOwnerV2025 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof AccessAppsOwnerV2025 - */ - 'type'?: AccessAppsOwnerV2025TypeV2025; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof AccessAppsOwnerV2025 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof AccessAppsOwnerV2025 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof AccessAppsOwnerV2025 - */ - 'email'?: string; -} - -export const AccessAppsOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessAppsOwnerV2025TypeV2025 = typeof AccessAppsOwnerV2025TypeV2025[keyof typeof AccessAppsOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface AccessAppsV2025 - */ -export interface AccessAppsV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessAppsV2025 - */ - 'id'?: string; - /** - * Name of application - * @type {string} - * @memberof AccessAppsV2025 - */ - 'name'?: string; - /** - * Description of application. - * @type {string} - * @memberof AccessAppsV2025 - */ - 'description'?: string; - /** - * - * @type {AccessAppsOwnerV2025} - * @memberof AccessAppsV2025 - */ - 'owner'?: AccessAppsOwnerV2025; -} -/** - * - * @export - * @interface AccessConstraintV2025 - */ -export interface AccessConstraintV2025 { - /** - * Type of Access - * @type {string} - * @memberof AccessConstraintV2025 - */ - 'type': AccessConstraintV2025TypeV2025; - /** - * Must be set only if operator is SELECTED. - * @type {Array} - * @memberof AccessConstraintV2025 - */ - 'ids'?: Array; - /** - * Used to determine whether the scope of the campaign should be reduced for selected ids or all. - * @type {string} - * @memberof AccessConstraintV2025 - */ - 'operator': AccessConstraintV2025OperatorV2025; -} - -export const AccessConstraintV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessConstraintV2025TypeV2025 = typeof AccessConstraintV2025TypeV2025[keyof typeof AccessConstraintV2025TypeV2025]; -export const AccessConstraintV2025OperatorV2025 = { - All: 'ALL', - Selected: 'SELECTED' -} as const; - -export type AccessConstraintV2025OperatorV2025 = typeof AccessConstraintV2025OperatorV2025[keyof typeof AccessConstraintV2025OperatorV2025]; - -/** - * - * @export - * @interface AccessCriteriaCriteriaListInnerV2025 - */ -export interface AccessCriteriaCriteriaListInnerV2025 { - /** - * Type of the propery to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2025 - */ - 'type'?: AccessCriteriaCriteriaListInnerV2025TypeV2025; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2025 - */ - 'name'?: string; -} - -export const AccessCriteriaCriteriaListInnerV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaCriteriaListInnerV2025TypeV2025 = typeof AccessCriteriaCriteriaListInnerV2025TypeV2025[keyof typeof AccessCriteriaCriteriaListInnerV2025TypeV2025]; - -/** - * - * @export - * @interface AccessCriteriaV2025 - */ -export interface AccessCriteriaV2025 { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteriaV2025 - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteriaV2025 - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessDurationV2025 - */ -export interface AccessDurationV2025 { - /** - * The numeric value representing the amount of time, which is defined in the **timeUnit**. - * @type {number} - * @memberof AccessDurationV2025 - */ - 'value'?: number; - /** - * The unit of time that corresponds to the **value**. It defines the scale of the time period. - * @type {string} - * @memberof AccessDurationV2025 - */ - 'timeUnit'?: AccessDurationV2025TimeUnitV2025; -} - -export const AccessDurationV2025TimeUnitV2025 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type AccessDurationV2025TimeUnitV2025 = typeof AccessDurationV2025TimeUnitV2025[keyof typeof AccessDurationV2025TimeUnitV2025]; - -/** - * - * @export - * @interface AccessItemAccessProfileResponseAppRefsInnerV2025 - */ -export interface AccessItemAccessProfileResponseAppRefsInnerV2025 { - /** - * the cloud app id associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2025 - */ - 'cloudAppId'?: string; - /** - * the cloud app name associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2025 - */ - 'cloudAppName'?: string; -} -/** - * - * @export - * @interface AccessItemAccessProfileResponseV2025 - */ -export interface AccessItemAccessProfileResponseV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'id'?: string; - /** - * the access item type. accessProfile in this case - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'sourceName'?: string; - /** - * the number of entitlements the access profile will create - * @type {number} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'entitlementCount': number; - /** - * the description for the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'sourceId'?: string; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'startDate'?: string | null; - /** - * the date the access profile is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'removeDate'?: string | null; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'standalone': boolean | null; - /** - * indicates whether the access profile is revocable - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2025 - */ - 'revocable': boolean | null; -} -/** - * - * @export - * @interface AccessItemAccountResponseV2025 - */ -export interface AccessItemAccountResponseV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'id'?: string; - /** - * the access item type. account in this case - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'sourceName'?: string; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'nativeIdentity': string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccountResponseV2025 - */ - 'sourceId'?: string; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAccountResponseV2025 - */ - 'entitlementCount'?: number; -} -/** - * - * @export - * @interface AccessItemAppResponseV2025 - */ -export interface AccessItemAppResponseV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAppResponseV2025 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAppResponseV2025 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAppResponseV2025 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAppResponseV2025 - */ - 'sourceName'?: string | null; - /** - * the app role id - * @type {string} - * @memberof AccessItemAppResponseV2025 - */ - 'appRoleId': string | null; -} -/** - * Identity who approved the access item request. - * @export - * @interface AccessItemApproverDtoV2025 - */ -export interface AccessItemApproverDtoV2025 { - /** - * DTO type of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2025 - */ - 'type'?: AccessItemApproverDtoV2025TypeV2025; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2025 - */ - 'name'?: string; -} - -export const AccessItemApproverDtoV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemApproverDtoV2025TypeV2025 = typeof AccessItemApproverDtoV2025TypeV2025[keyof typeof AccessItemApproverDtoV2025TypeV2025]; - -/** - * - * @export - * @interface AccessItemAssociatedAccessItemV2025 - */ -export interface AccessItemAssociatedAccessItemV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2025 - */ - 'appRoleId': string | null; -} -/** - * - * @export - * @interface AccessItemAssociatedV2025 - */ -export interface AccessItemAssociatedV2025 { - /** - * the event type - * @type {string} - * @memberof AccessItemAssociatedV2025 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemAssociatedV2025 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof AccessItemAssociatedV2025 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2025} - * @memberof AccessItemAssociatedV2025 - */ - 'accessItem': AccessItemAssociatedAccessItemV2025; - /** - * - * @type {CorrelatedGovernanceEventV2025} - * @memberof AccessItemAssociatedV2025 - */ - 'governanceEvent': CorrelatedGovernanceEventV2025 | null; - /** - * the access item type - * @type {string} - * @memberof AccessItemAssociatedV2025 - */ - 'accessItemType'?: AccessItemAssociatedV2025AccessItemTypeV2025; -} - -export const AccessItemAssociatedV2025AccessItemTypeV2025 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemAssociatedV2025AccessItemTypeV2025 = typeof AccessItemAssociatedV2025AccessItemTypeV2025[keyof typeof AccessItemAssociatedV2025AccessItemTypeV2025]; - -/** - * - * @export - * @interface AccessItemDiffV2025 - */ -export interface AccessItemDiffV2025 { - /** - * the id of the access item - * @type {string} - * @memberof AccessItemDiffV2025 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccessItemDiffV2025 - */ - 'eventType'?: AccessItemDiffV2025EventTypeV2025; - /** - * the display name of the access item - * @type {string} - * @memberof AccessItemDiffV2025 - */ - 'displayName'?: string; - /** - * the source name of the access item - * @type {string} - * @memberof AccessItemDiffV2025 - */ - 'sourceName'?: string; -} - -export const AccessItemDiffV2025EventTypeV2025 = { - Add: 'ADD', - Remove: 'REMOVE' -} as const; - -export type AccessItemDiffV2025EventTypeV2025 = typeof AccessItemDiffV2025EventTypeV2025[keyof typeof AccessItemDiffV2025EventTypeV2025]; - -/** - * - * @export - * @interface AccessItemEntitlementResponseV2025 - */ -export interface AccessItemEntitlementResponseV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'sourceName'?: string; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'type': string; - /** - * the description for the entitlment - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'sourceId'?: string; - /** - * indicates whether the entitlement is standalone - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2025 - */ - 'cloudGoverned': boolean | null; -} -/** - * - * @export - * @interface AccessItemRefV2025 - */ -export interface AccessItemRefV2025 { - /** - * ID of the access item to retrieve the recommendation for. - * @type {string} - * @memberof AccessItemRefV2025 - */ - 'id'?: string; - /** - * Access item\'s type. - * @type {string} - * @memberof AccessItemRefV2025 - */ - 'type'?: AccessItemRefV2025TypeV2025; -} - -export const AccessItemRefV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessItemRefV2025TypeV2025 = typeof AccessItemRefV2025TypeV2025[keyof typeof AccessItemRefV2025TypeV2025]; - -/** - * - * @export - * @interface AccessItemRemovedV2025 - */ -export interface AccessItemRemovedV2025 { - /** - * - * @type {AccessItemAssociatedAccessItemV2025} - * @memberof AccessItemRemovedV2025 - */ - 'accessItem': AccessItemAssociatedAccessItemV2025; - /** - * the identity id - * @type {string} - * @memberof AccessItemRemovedV2025 - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessItemRemovedV2025 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemRemovedV2025 - */ - 'dateTime'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessItemRemovedV2025 - */ - 'accessItemType'?: AccessItemRemovedV2025AccessItemTypeV2025; - /** - * - * @type {CorrelatedGovernanceEventV2025} - * @memberof AccessItemRemovedV2025 - */ - 'governanceEvent'?: CorrelatedGovernanceEventV2025 | null; -} - -export const AccessItemRemovedV2025AccessItemTypeV2025 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemRemovedV2025AccessItemTypeV2025 = typeof AccessItemRemovedV2025AccessItemTypeV2025[keyof typeof AccessItemRemovedV2025AccessItemTypeV2025]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForDtoV2025 - */ -export interface AccessItemRequestedForDtoV2025 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2025 - */ - 'type'?: AccessItemRequestedForDtoV2025TypeV2025; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2025 - */ - 'name'?: string; -} - -export const AccessItemRequestedForDtoV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForDtoV2025TypeV2025 = typeof AccessItemRequestedForDtoV2025TypeV2025[keyof typeof AccessItemRequestedForDtoV2025TypeV2025]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForV2025 - */ -export interface AccessItemRequestedForV2025 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2025 - */ - 'type'?: AccessItemRequestedForV2025TypeV2025; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2025 - */ - 'name'?: string; -} - -export const AccessItemRequestedForV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForV2025TypeV2025 = typeof AccessItemRequestedForV2025TypeV2025[keyof typeof AccessItemRequestedForV2025TypeV2025]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterDtoV2025 - */ -export interface AccessItemRequesterDtoV2025 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterDtoV2025 - */ - 'type'?: AccessItemRequesterDtoV2025TypeV2025; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterDtoV2025 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterDtoV2025 - */ - 'name'?: string; -} - -export const AccessItemRequesterDtoV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterDtoV2025TypeV2025 = typeof AccessItemRequesterDtoV2025TypeV2025[keyof typeof AccessItemRequesterDtoV2025TypeV2025]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterV2025 - */ -export interface AccessItemRequesterV2025 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterV2025 - */ - 'type'?: AccessItemRequesterV2025TypeV2025; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterV2025 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterV2025 - */ - 'name'?: string; -} - -export const AccessItemRequesterV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterV2025TypeV2025 = typeof AccessItemRequesterV2025TypeV2025[keyof typeof AccessItemRequesterV2025TypeV2025]; - -/** - * Identity who reviewed the access item request. - * @export - * @interface AccessItemReviewedByV2025 - */ -export interface AccessItemReviewedByV2025 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2025 - */ - 'type'?: AccessItemReviewedByV2025TypeV2025; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2025 - */ - 'name'?: string; -} - -export const AccessItemReviewedByV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemReviewedByV2025TypeV2025 = typeof AccessItemReviewedByV2025TypeV2025[keyof typeof AccessItemReviewedByV2025TypeV2025]; - -/** - * - * @export - * @interface AccessItemRoleResponseV2025 - */ -export interface AccessItemRoleResponseV2025 { - /** - * the access item id - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'id'?: string; - /** - * the access item type. role in this case - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'accessType'?: string; - /** - * the role display name - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'sourceName'?: string | null; - /** - * the description for the role - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'description'?: string; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemRoleResponseV2025 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemRoleResponseV2025 - */ - 'revocable': boolean; -} -/** - * - * @export - * @interface AccessModelMetadataBulkUpdateResponseV2025 - */ -export interface AccessModelMetadataBulkUpdateResponseV2025 { - /** - * ID of the task which is executing the bulk update. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2025 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2025 - */ - 'type'?: string; - /** - * The status of the bulk update request, only list unfinished request\'s status. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2025 - */ - 'status'?: AccessModelMetadataBulkUpdateResponseV2025StatusV2025; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2025 - */ - 'created'?: string; -} - -export const AccessModelMetadataBulkUpdateResponseV2025StatusV2025 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PreProcessCompleted: 'PRE_PROCESS_COMPLETED', - PostProcess: 'POST_PROCESS', - Completed: 'COMPLETED', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING', - ReProcessing: 'RE_PROCESSING', - PreProcessFailed: 'PRE_PROCESS_FAILED', - Failed: 'FAILED' -} as const; - -export type AccessModelMetadataBulkUpdateResponseV2025StatusV2025 = typeof AccessModelMetadataBulkUpdateResponseV2025StatusV2025[keyof typeof AccessModelMetadataBulkUpdateResponseV2025StatusV2025]; - -/** - * Metadata that describes an access item - * @export - * @interface AccessModelMetadataV2025 - */ -export interface AccessModelMetadataV2025 { - /** - * Unique identifier for the metadata type - * @type {string} - * @memberof AccessModelMetadataV2025 - */ - 'key'?: string; - /** - * Human readable name of the metadata type - * @type {string} - * @memberof AccessModelMetadataV2025 - */ - 'name'?: string; - /** - * Allows selecting multiple values - * @type {boolean} - * @memberof AccessModelMetadataV2025 - */ - 'multiselect'?: boolean; - /** - * The state of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2025 - */ - 'status'?: string; - /** - * The type of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2025 - */ - 'type'?: string; - /** - * The types of objects - * @type {Array} - * @memberof AccessModelMetadataV2025 - */ - 'objectTypes'?: Array; - /** - * Describes the metadata item - * @type {string} - * @memberof AccessModelMetadataV2025 - */ - 'description'?: string; - /** - * The value to assign to the metadata item - * @type {Array} - * @memberof AccessModelMetadataV2025 - */ - 'values'?: Array; -} -/** - * An individual value to assign to the metadata item - * @export - * @interface AccessModelMetadataValuesInnerV2025 - */ -export interface AccessModelMetadataValuesInnerV2025 { - /** - * The value to assign to the metdata item - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2025 - */ - 'value'?: string; - /** - * Display name of the value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2025 - */ - 'name'?: string; - /** - * The status of the individual value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2025 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AccessProfileApprovalSchemeV2025 - */ -export interface AccessProfileApprovalSchemeV2025 { - /** - * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof AccessProfileApprovalSchemeV2025 - */ - 'approverType'?: AccessProfileApprovalSchemeV2025ApproverTypeV2025; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof AccessProfileApprovalSchemeV2025 - */ - 'approverId'?: string | null; -} - -export const AccessProfileApprovalSchemeV2025ApproverTypeV2025 = { - AppOwner: 'APP_OWNER', - Owner: 'OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type AccessProfileApprovalSchemeV2025ApproverTypeV2025 = typeof AccessProfileApprovalSchemeV2025ApproverTypeV2025[keyof typeof AccessProfileApprovalSchemeV2025ApproverTypeV2025]; - -/** - * - * @export - * @interface AccessProfileBulkDeleteRequestV2025 - */ -export interface AccessProfileBulkDeleteRequestV2025 { - /** - * List of IDs of Access Profiles to be deleted. - * @type {Array} - * @memberof AccessProfileBulkDeleteRequestV2025 - */ - 'accessProfileIds'?: Array; - /** - * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - * @type {boolean} - * @memberof AccessProfileBulkDeleteRequestV2025 - */ - 'bestEffortOnly'?: boolean; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteResponseV2025 - */ -export interface AccessProfileBulkDeleteResponseV2025 { - /** - * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. - * @type {string} - * @memberof AccessProfileBulkDeleteResponseV2025 - */ - 'taskId'?: string; - /** - * List of IDs of Access Profiles which are pending deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2025 - */ - 'pending'?: Array; - /** - * List of usages of Access Profiles targeted for deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2025 - */ - 'inUse'?: Array; -} -/** - * Access Profile\'s basic details. - * @export - * @interface AccessProfileBulkUpdateRequestInnerV2025 - */ -export interface AccessProfileBulkUpdateRequestInnerV2025 { - /** - * Access Profile ID. - * @type {string} - * @memberof AccessProfileBulkUpdateRequestInnerV2025 - */ - 'id'?: string; - /** - * Access Profile is requestable or not. - * @type {boolean} - * @memberof AccessProfileBulkUpdateRequestInnerV2025 - */ - 'requestable'?: boolean; -} -/** - * How to select account when there are multiple accounts for the user - * @export - * @interface AccessProfileDetailsAccountSelectorV2025 - */ -export interface AccessProfileDetailsAccountSelectorV2025 { - /** - * - * @type {Array} - * @memberof AccessProfileDetailsAccountSelectorV2025 - */ - 'selectors'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileDetailsV2025 - */ -export interface AccessProfileDetailsV2025 { - /** - * The ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'description'?: string | null; - /** - * Date the Access Profile was created - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'modified'?: string; - /** - * Whether the Access Profile is enabled. - * @type {boolean} - * @memberof AccessProfileDetailsV2025 - */ - 'disabled'?: boolean; - /** - * Whether the Access Profile is requestable via access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2025 - */ - 'requestable'?: boolean; - /** - * Whether the Access Profile is protected. - * @type {boolean} - * @memberof AccessProfileDetailsV2025 - */ - 'protected'?: boolean; - /** - * The owner ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'ownerId'?: string; - /** - * The source ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2025 - */ - 'sourceId'?: number | null; - /** - * The source name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'sourceName'?: string; - /** - * The source app ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2025 - */ - 'appId'?: number | null; - /** - * The source app name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'appName'?: string | null; - /** - * The id of the application - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'applicationId'?: string; - /** - * The type of the access profile - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'type'?: string; - /** - * List of IDs of entitlements - * @type {Array} - * @memberof AccessProfileDetailsV2025 - */ - 'entitlements'?: Array; - /** - * The number of entitlements in the access profile - * @type {number} - * @memberof AccessProfileDetailsV2025 - */ - 'entitlementCount'?: number; - /** - * List of IDs of segments, if any, to which this Access Profile is assigned. - * @type {Array} - * @memberof AccessProfileDetailsV2025 - */ - 'segments'?: Array; - /** - * Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'approvalSchemes'?: string; - /** - * Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2025 - */ - 'revokeRequestApprovalSchemes'?: string; - /** - * Whether the access profile require request comment for access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * Whether denied comment is required when access request is denied. - * @type {boolean} - * @memberof AccessProfileDetailsV2025 - */ - 'deniedCommentsRequired'?: boolean; - /** - * - * @type {AccessProfileDetailsAccountSelectorV2025} - * @memberof AccessProfileDetailsV2025 - */ - 'accountSelector'?: AccessProfileDetailsAccountSelectorV2025; -} -/** - * Access profile\'s source. - * @export - * @interface AccessProfileDocumentAllOfSourceV2025 - */ -export interface AccessProfileDocumentAllOfSourceV2025 { - /** - * Source\'s ID. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2025 - */ - 'id'?: string; - /** - * Source\'s name. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2025 - */ - 'name'?: string; -} -/** - * More complete representation of an access profile. - * @export - * @interface AccessProfileDocumentV2025 - */ -export interface AccessProfileDocumentV2025 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentV2025 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2025} - * @memberof AccessProfileDocumentV2025 - */ - 'owner'?: BaseAccessOwnerV2025; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentV2025 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2025} - * @memberof AccessProfileDocumentV2025 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2025; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentV2025 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentV2025 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentV2025 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentV2025 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentV2025 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentV2025 - */ - 'apps'?: Array; -} -/** - * - * @export - * @interface AccessProfileDocumentsV2025 - */ -export interface AccessProfileDocumentsV2025 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentsV2025 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentsV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentsV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2025} - * @memberof AccessProfileDocumentsV2025 - */ - 'owner'?: BaseAccessOwnerV2025; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2025} - * @memberof AccessProfileDocumentsV2025 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2025; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentsV2025 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentsV2025 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentsV2025 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentsV2025 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentsV2025 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentsV2025 - */ - 'apps'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof AccessProfileDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof AccessProfileDocumentsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof AccessProfileDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * EntitlementReference - * @export - * @interface AccessProfileEntitlementV2025 - */ -export interface AccessProfileEntitlementV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2025} - * @memberof AccessProfileEntitlementV2025 - */ - 'source'?: Reference1V2025; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2025 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2025 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2025 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface AccessProfileRefV2025 - */ -export interface AccessProfileRefV2025 { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfileRefV2025 - */ - 'id'?: string; - /** - * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof AccessProfileRefV2025 - */ - 'type'?: AccessProfileRefV2025TypeV2025; - /** - * Human-readable display name of the Access Profile. This field is ignored on input. - * @type {string} - * @memberof AccessProfileRefV2025 - */ - 'name'?: string; -} - -export const AccessProfileRefV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE' -} as const; - -export type AccessProfileRefV2025TypeV2025 = typeof AccessProfileRefV2025TypeV2025[keyof typeof AccessProfileRefV2025TypeV2025]; - -/** - * Role - * @export - * @interface AccessProfileRoleV2025 - */ -export interface AccessProfileRoleV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileRoleV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileRoleV2025 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileRoleV2025 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2025} - * @memberof AccessProfileRoleV2025 - */ - 'owner'?: DisplayReferenceV2025; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2025 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2025 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileSourceRefV2025 - */ -export interface AccessProfileSourceRefV2025 { - /** - * ID of the source the access profile is associated with. - * @type {string} - * @memberof AccessProfileSourceRefV2025 - */ - 'id'?: string; - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccessProfileSourceRefV2025 - */ - 'type'?: AccessProfileSourceRefV2025TypeV2025; - /** - * Source name. - * @type {string} - * @memberof AccessProfileSourceRefV2025 - */ - 'name'?: string; -} - -export const AccessProfileSourceRefV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccessProfileSourceRefV2025TypeV2025 = typeof AccessProfileSourceRefV2025TypeV2025[keyof typeof AccessProfileSourceRefV2025TypeV2025]; - -/** - * This is a summary representation of an access profile. - * @export - * @interface AccessProfileSummaryV2025 - */ -export interface AccessProfileSummaryV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileSummaryV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileSummaryV2025 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileSummaryV2025 - */ - 'type'?: string; - /** - * - * @type {Reference1V2025} - * @memberof AccessProfileSummaryV2025 - */ - 'source'?: Reference1V2025; - /** - * - * @type {DisplayReferenceV2025} - * @memberof AccessProfileSummaryV2025 - */ - 'owner'?: DisplayReferenceV2025; - /** - * - * @type {boolean} - * @memberof AccessProfileSummaryV2025 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileUpdateItemV2025 - */ -export interface AccessProfileUpdateItemV2025 { - /** - * Identifier of Access Profile in bulk update request. - * @type {string} - * @memberof AccessProfileUpdateItemV2025 - */ - 'id': string; - /** - * Access Profile requestable or not. - * @type {boolean} - * @memberof AccessProfileUpdateItemV2025 - */ - 'requestable': boolean; - /** - * The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. - * @type {string} - * @memberof AccessProfileUpdateItemV2025 - */ - 'status': string; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof AccessProfileUpdateItemV2025 - */ - 'description'?: string; -} -/** - * Role using the access profile. - * @export - * @interface AccessProfileUsageUsedByInnerV2025 - */ -export interface AccessProfileUsageUsedByInnerV2025 { - /** - * DTO type of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2025 - */ - 'type'?: AccessProfileUsageUsedByInnerV2025TypeV2025; - /** - * ID of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2025 - */ - 'id'?: string; - /** - * Display name of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2025 - */ - 'name'?: string; -} - -export const AccessProfileUsageUsedByInnerV2025TypeV2025 = { - Role: 'ROLE' -} as const; - -export type AccessProfileUsageUsedByInnerV2025TypeV2025 = typeof AccessProfileUsageUsedByInnerV2025TypeV2025[keyof typeof AccessProfileUsageUsedByInnerV2025TypeV2025]; - -/** - * - * @export - * @interface AccessProfileUsageV2025 - */ -export interface AccessProfileUsageV2025 { - /** - * ID of the Access Profile that is in use - * @type {string} - * @memberof AccessProfileUsageV2025 - */ - 'accessProfileId'?: string; - /** - * List of references to objects which are using the indicated Access Profile - * @type {Array} - * @memberof AccessProfileUsageV2025 - */ - 'usedBy'?: Array; -} -/** - * Access profile. - * @export - * @interface AccessProfileV2025 - */ -export interface AccessProfileV2025 { - /** - * Access profile ID. - * @type {string} - * @memberof AccessProfileV2025 - */ - 'id'?: string; - /** - * Access profile name. - * @type {string} - * @memberof AccessProfileV2025 - */ - 'name': string; - /** - * Access profile description. - * @type {string} - * @memberof AccessProfileV2025 - */ - 'description'?: string | null; - /** - * Date and time when the access profile was created. - * @type {string} - * @memberof AccessProfileV2025 - */ - 'created'?: string; - /** - * Date and time when the access profile was last modified. - * @type {string} - * @memberof AccessProfileV2025 - */ - 'modified'?: string; - /** - * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. - * @type {boolean} - * @memberof AccessProfileV2025 - */ - 'enabled'?: boolean; - /** - * - * @type {OwnerReferenceV2025} - * @memberof AccessProfileV2025 - */ - 'owner': OwnerReferenceV2025 | null; - /** - * - * @type {AccessProfileSourceRefV2025} - * @memberof AccessProfileV2025 - */ - 'source': AccessProfileSourceRefV2025; - /** - * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. - * @type {Array} - * @memberof AccessProfileV2025 - */ - 'entitlements'?: Array | null; - /** - * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. - * @type {boolean} - * @memberof AccessProfileV2025 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityV2025} - * @memberof AccessProfileV2025 - */ - 'accessRequestConfig'?: RequestabilityV2025 | null; - /** - * - * @type {RevocabilityV2025} - * @memberof AccessProfileV2025 - */ - 'revocationRequestConfig'?: RevocabilityV2025 | null; - /** - * List of segment IDs, if any, that the access profile is assigned to. - * @type {Array} - * @memberof AccessProfileV2025 - */ - 'segments'?: Array | null; - /** - * - * @type {AttributeDTOListV2025} - * @memberof AccessProfileV2025 - */ - 'accessModelMetadata'?: AttributeDTOListV2025; - /** - * - * @type {ProvisioningCriteriaLevel1V2025} - * @memberof AccessProfileV2025 - */ - 'provisioningCriteria'?: ProvisioningCriteriaLevel1V2025 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof AccessProfileV2025 - */ - 'additionalOwners'?: Array | null; -} -/** - * - * @export - * @interface AccessRecommendationMessageV2025 - */ -export interface AccessRecommendationMessageV2025 { - /** - * Information about why the access item was recommended. - * @type {string} - * @memberof AccessRecommendationMessageV2025 - */ - 'interpretation'?: string; -} -/** - * - * @export - * @interface AccessRequestAdminItemStatusV2025 - */ -export interface AccessRequestAdminItemStatusV2025 { - /** - * ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'type'?: AccessRequestAdminItemStatusV2025TypeV2025 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2025; - /** - * List of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'state'?: RequestedItemStatusRequestStateV2025; - /** - * Approval details for each item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'approvalDetails'?: Array; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'requester'?: AccessItemRequesterV2025; - /** - * - * @type {RequestedItemStatusRequestedForV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2025; - /** - * - * @type {RequestedItemStatusRequesterCommentV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2025; - /** - * - * @type {RequestedItemStatusSodViolationContextV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2025; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2025; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2025} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2025; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'cancelable'?: boolean; - /** - * True if re-auth is required. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'reauthorizationRequired'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccessRequestAdminItemStatusV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - -export const AccessRequestAdminItemStatusV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestAdminItemStatusV2025TypeV2025 = typeof AccessRequestAdminItemStatusV2025TypeV2025[keyof typeof AccessRequestAdminItemStatusV2025TypeV2025]; - -/** - * - * @export - * @interface AccessRequestApproversListResponseV2025 - */ -export interface AccessRequestApproversListResponseV2025 { - /** - * Approver id. - * @type {string} - * @memberof AccessRequestApproversListResponseV2025 - */ - 'id'?: string; - /** - * Email of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2025 - */ - 'email'?: string; - /** - * Name of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2025 - */ - 'name'?: string; - /** - * Id of the approval item. - * @type {string} - * @memberof AccessRequestApproversListResponseV2025 - */ - 'approvalId'?: string; - /** - * Type of the object returned. In this case, the value for this field will always Identity. - * @type {string} - * @memberof AccessRequestApproversListResponseV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccessRequestConfigV2025 - */ -export interface AccessRequestConfigV2025 { - /** - * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. - * @type {boolean} - * @memberof AccessRequestConfigV2025 - */ - 'approvalsMustBeExternal'?: boolean; - /** - * If this is true and the requester and reviewer are the same, the request is automatically approved. - * @type {boolean} - * @memberof AccessRequestConfigV2025 - */ - 'autoApprovalEnabled'?: boolean; - /** - * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - * @type {boolean} - * @memberof AccessRequestConfigV2025 - */ - 'reauthorizationEnabled'?: boolean; - /** - * - * @type {RequestOnBehalfOfConfigV2025} - * @memberof AccessRequestConfigV2025 - */ - 'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfigV2025; - /** - * - * @type {ApprovalReminderAndEscalationConfigV2025} - * @memberof AccessRequestConfigV2025 - */ - 'approvalReminderAndEscalationConfig'?: ApprovalReminderAndEscalationConfigV2025; - /** - * - * @type {EntitlementRequestConfigV2025} - * @memberof AccessRequestConfigV2025 - */ - 'entitlementRequestConfig'?: EntitlementRequestConfigV2025; -} -/** - * - * @export - * @interface AccessRequestContextV2025 - */ -export interface AccessRequestContextV2025 { - /** - * - * @type {Array} - * @memberof AccessRequestContextV2025 - */ - 'contextAttributes'?: Array; -} -/** - * - * @export - * @interface AccessRequestDynamicApprover1V2025 - */ -export interface AccessRequestDynamicApprover1V2025 { - /** - * The unique ID of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2025 - */ - 'id': string; - /** - * The name of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2025 - */ - 'name': string; - /** - * The type of object being referenced. - * @type {object} - * @memberof AccessRequestDynamicApprover1V2025 - */ - 'type': AccessRequestDynamicApprover1V2025TypeV2025; -} - -export const AccessRequestDynamicApprover1V2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AccessRequestDynamicApprover1V2025TypeV2025 = typeof AccessRequestDynamicApprover1V2025TypeV2025[keyof typeof AccessRequestDynamicApprover1V2025TypeV2025]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ -export interface AccessRequestDynamicApproverRequestedItemsInnerV2025 { - /** - * The unique ID of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'id': string; - /** - * Human friendly name of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'name': string; - /** - * Extended description of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'description'?: string | null; - /** - * The type of access item being requested. - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'type': AccessRequestDynamicApproverRequestedItemsInnerV2025TypeV2025; - /** - * Grant or revoke the access item - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'operation': AccessRequestDynamicApproverRequestedItemsInnerV2025OperationV2025; - /** - * A comment from the requestor on why the access is needed. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2025 - */ - 'comment'?: string | null; -} - -export const AccessRequestDynamicApproverRequestedItemsInnerV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2025TypeV2025 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2025TypeV2025[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2025TypeV2025]; -export const AccessRequestDynamicApproverRequestedItemsInnerV2025OperationV2025 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2025OperationV2025 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2025OperationV2025[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2025OperationV2025]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverV2025 - */ -export interface AccessRequestDynamicApproverV2025 { - /** - * The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. - * @type {string} - * @memberof AccessRequestDynamicApproverV2025 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2025 - */ - 'requestedFor': Array; - /** - * The access items that are being requested. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2025 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2025} - * @memberof AccessRequestDynamicApproverV2025 - */ - 'requestedBy': AccessItemRequesterDtoV2025; -} -/** - * - * @export - * @interface AccessRequestItemResponseV2025 - */ -export interface AccessRequestItemResponseV2025 { - /** - * the access request item operation - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'operation'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'accessItemType'?: string; - /** - * the name of access request item - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'name'?: string; - /** - * the final decision for the access request - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'decision'?: AccessRequestItemResponseV2025DecisionV2025; - /** - * the description of access request item - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'description'?: string; - /** - * the source id - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'sourceId'?: string; - /** - * the source Name - * @type {string} - * @memberof AccessRequestItemResponseV2025 - */ - 'sourceName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestItemResponseV2025 - */ - 'approvalInfos'?: Array; -} - -export const AccessRequestItemResponseV2025DecisionV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type AccessRequestItemResponseV2025DecisionV2025 = typeof AccessRequestItemResponseV2025DecisionV2025[keyof typeof AccessRequestItemResponseV2025DecisionV2025]; - -/** - * - * @export - * @interface AccessRequestItemV2025 - */ -export interface AccessRequestItemV2025 { - /** - * The type of the item being requested. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'type': AccessRequestItemV2025TypeV2025; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestItemV2025 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'removeDate'?: string; - /** - * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'assignmentId'?: string | null; - /** - * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2025 - */ - 'nativeIdentity'?: string | null; -} - -export const AccessRequestItemV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestItemV2025TypeV2025 = typeof AccessRequestItemV2025TypeV2025[keyof typeof AccessRequestItemV2025TypeV2025]; - -/** - * Provides additional details about this access request phase. - * @export - * @interface AccessRequestPhasesV2025 - */ -export interface AccessRequestPhasesV2025 { - /** - * The time that this phase started. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'started'?: string; - /** - * The time that this phase finished. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'finished'?: string | null; - /** - * The name of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'name'?: string; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'state'?: AccessRequestPhasesV2025StateV2025; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'result'?: AccessRequestPhasesV2025ResultV2025 | null; - /** - * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - * @type {string} - * @memberof AccessRequestPhasesV2025 - */ - 'phaseReference'?: string | null; -} - -export const AccessRequestPhasesV2025StateV2025 = { - Pending: 'PENDING', - Executing: 'EXECUTING', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - NotExecuted: 'NOT_EXECUTED' -} as const; - -export type AccessRequestPhasesV2025StateV2025 = typeof AccessRequestPhasesV2025StateV2025[keyof typeof AccessRequestPhasesV2025StateV2025]; -export const AccessRequestPhasesV2025ResultV2025 = { - Successful: 'SUCCESSFUL', - Failed: 'FAILED' -} as const; - -export type AccessRequestPhasesV2025ResultV2025 = typeof AccessRequestPhasesV2025ResultV2025[keyof typeof AccessRequestPhasesV2025ResultV2025]; - -/** - * The identity of the approver. - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025 { - /** - * The type of object that is referenced - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025TypeV2025; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025 - */ - 'id': string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025 - */ - 'name': string; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025TypeV2025 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025TypeV2025[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025TypeV2025]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 { - /** - * A comment left by the approver. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 - */ - 'approvalComment'?: string | null; - /** - * The final decision of the approver. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 - */ - 'approvalDecision': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025ApprovalDecisionV2025; - /** - * The name of the approver - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 - */ - 'approverName': string; - /** - * - * @type {AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025 - */ - 'approver': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2025; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025ApprovalDecisionV2025 = { - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025ApprovalDecisionV2025 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025ApprovalDecisionV2025[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2025ApprovalDecisionV2025]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerV2025 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerV2025TypeV2025; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'operation': AccessRequestPostApprovalRequestedItemsStatusInnerV2025OperationV2025; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'comment'?: string | null; - /** - * Additional customer defined metadata about the access item. - * @type {{ [key: string]: any; }} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'clientMetadata'?: { [key: string]: any; } | null; - /** - * A list of one or more approvers for the access request. - * @type {Array} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2025 - */ - 'approvalInfo': Array; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2025TypeV2025 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2025TypeV2025[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2025TypeV2025]; -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2025OperationV2025 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2025OperationV2025 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2025OperationV2025[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2025OperationV2025]; - -/** - * - * @export - * @interface AccessRequestPostApprovalV2025 - */ -export interface AccessRequestPostApprovalV2025 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPostApprovalV2025 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPostApprovalV2025 - */ - 'requestedFor': Array; - /** - * Details on the outcome of each access item. - * @type {Array} - * @memberof AccessRequestPostApprovalV2025 - */ - 'requestedItemsStatus': Array; - /** - * - * @type {AccessItemRequesterDtoV2025} - * @memberof AccessRequestPostApprovalV2025 - */ - 'requestedBy': AccessItemRequesterDtoV2025; -} -/** - * - * @export - * @interface AccessRequestPreApproval1V2025 - */ -export interface AccessRequestPreApproval1V2025 { - /** - * Whether or not to approve the access request. - * @type {boolean} - * @memberof AccessRequestPreApproval1V2025 - */ - 'approved': boolean; - /** - * A comment about the decision to approve or deny the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2025 - */ - 'comment': string; - /** - * The name of the entity that approved or denied the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2025 - */ - 'approver': string; -} -/** - * - * @export - * @interface AccessRequestPreApprovalRequestedItemsInnerV2025 - */ -export interface AccessRequestPreApprovalRequestedItemsInnerV2025 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'type': AccessRequestPreApprovalRequestedItemsInnerV2025TypeV2025; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'operation': AccessRequestPreApprovalRequestedItemsInnerV2025OperationV2025; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2025 - */ - 'comment'?: string | null; -} - -export const AccessRequestPreApprovalRequestedItemsInnerV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2025TypeV2025 = typeof AccessRequestPreApprovalRequestedItemsInnerV2025TypeV2025[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2025TypeV2025]; -export const AccessRequestPreApprovalRequestedItemsInnerV2025OperationV2025 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2025OperationV2025 = typeof AccessRequestPreApprovalRequestedItemsInnerV2025OperationV2025[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2025OperationV2025]; - -/** - * - * @export - * @interface AccessRequestPreApprovalV2025 - */ -export interface AccessRequestPreApprovalV2025 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPreApprovalV2025 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPreApprovalV2025 - */ - 'requestedFor': Array; - /** - * Details of the access items being requested. - * @type {Array} - * @memberof AccessRequestPreApprovalV2025 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2025} - * @memberof AccessRequestPreApprovalV2025 - */ - 'requestedBy': AccessItemRequesterDtoV2025; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemDtoV2025 - */ -export interface AccessRequestRecommendationActionItemDtoV2025 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemDtoV2025 - */ - 'identityId': string; - /** - * - * @type {AccessRequestRecommendationItemV2025} - * @memberof AccessRequestRecommendationActionItemDtoV2025 - */ - 'access': AccessRequestRecommendationItemV2025; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemResponseDtoV2025 - */ -export interface AccessRequestRecommendationActionItemResponseDtoV2025 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2025 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemV2025} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2025 - */ - 'access'?: AccessRequestRecommendationItemV2025; - /** - * - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2025 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface AccessRequestRecommendationConfigDtoV2025 - */ -export interface AccessRequestRecommendationConfigDtoV2025 { - /** - * The value that internal calculations need to exceed for recommendations to be made. - * @type {number} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'scoreThreshold': number; - /** - * Use to map an attribute name for determining identities\' start date. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'startDateAttribute'?: string; - /** - * Use to only give recommendations based on this attribute. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'restrictionAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are movers. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'moverAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are joiners. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'joinerAttribute'?: string; - /** - * Use only the attribute named in restrictionAttribute to make recommendations. - * @type {boolean} - * @memberof AccessRequestRecommendationConfigDtoV2025 - */ - 'useRestrictionAttribute'?: boolean; -} -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailAccessV2025 - */ -export interface AccessRequestRecommendationItemDetailAccessV2025 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2025 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2025} - * @memberof AccessRequestRecommendationItemDetailAccessV2025 - */ - 'type'?: AccessRequestRecommendationItemTypeV2025; - /** - * Name of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2025 - */ - 'name'?: string; - /** - * Description of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2025 - */ - 'description'?: string; -} - - -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailV2025 - */ -export interface AccessRequestRecommendationItemDetailV2025 { - /** - * Identity ID for the recommendation - * @type {string} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemDetailAccessV2025} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'access'?: AccessRequestRecommendationItemDetailAccessV2025; - /** - * Whether or not the identity has already chosen to ignore this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'ignored'?: boolean; - /** - * Whether or not the identity has already chosen to request this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'requested'?: boolean; - /** - * Whether or not the identity reportedly viewed this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'viewed'?: boolean; - /** - * - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'messages'?: Array; - /** - * The list of translation messages - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2025 - */ - 'translationMessages'?: Array; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const AccessRequestRecommendationItemTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessRequestRecommendationItemTypeV2025 = typeof AccessRequestRecommendationItemTypeV2025[keyof typeof AccessRequestRecommendationItemTypeV2025]; - - -/** - * - * @export - * @interface AccessRequestRecommendationItemV2025 - */ -export interface AccessRequestRecommendationItemV2025 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemV2025 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2025} - * @memberof AccessRequestRecommendationItemV2025 - */ - 'type'?: AccessRequestRecommendationItemTypeV2025; -} - - -/** - * - * @export - * @interface AccessRequestResponse1V2025 - */ -export interface AccessRequestResponse1V2025 { - /** - * the requester Id - * @type {string} - * @memberof AccessRequestResponse1V2025 - */ - 'requesterId'?: string; - /** - * the requesterName - * @type {string} - * @memberof AccessRequestResponse1V2025 - */ - 'requesterName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestResponse1V2025 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface AccessRequestResponseV2025 - */ -export interface AccessRequestResponseV2025 { - /** - * A list of new access request tracking data mapped to the values requested. - * @type {Array} - * @memberof AccessRequestResponseV2025 - */ - 'newRequests'?: Array; - /** - * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - * @type {Array} - * @memberof AccessRequestResponseV2025 - */ - 'existingRequests'?: Array; -} -/** - * - * @export - * @interface AccessRequestTrackingV2025 - */ -export interface AccessRequestTrackingV2025 { - /** - * The identity id in which the access request is for. - * @type {string} - * @memberof AccessRequestTrackingV2025 - */ - 'requestedFor'?: string; - /** - * The details of the item requested. - * @type {Array} - * @memberof AccessRequestTrackingV2025 - */ - 'requestedItemsDetails'?: Array; - /** - * a hash representation of the access requested, useful for longer term tracking client side. - * @type {number} - * @memberof AccessRequestTrackingV2025 - */ - 'attributesHash'?: number; - /** - * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - * @type {Array} - * @memberof AccessRequestTrackingV2025 - */ - 'accessRequestIds'?: Array; -} -/** - * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. - * @export - * @enum {string} - */ - -export const AccessRequestTypeV2025 = { - GrantAccess: 'GRANT_ACCESS', - RevokeAccess: 'REVOKE_ACCESS', - ModifyAccess: 'MODIFY_ACCESS' -} as const; - -export type AccessRequestTypeV2025 = typeof AccessRequestTypeV2025[keyof typeof AccessRequestTypeV2025]; - - -/** - * - * @export - * @interface AccessRequestV2025 - */ -export interface AccessRequestV2025 { - /** - * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. - * @type {Array} - * @memberof AccessRequestV2025 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof AccessRequestV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * - * @type {Array} - * @memberof AccessRequestV2025 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestV2025 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests - * @type {Array} - * @memberof AccessRequestV2025 - */ - 'requestedForWithRequestedItems'?: Array | null; -} - - -/** - * - * @export - * @interface AccessRequestedV2025 - */ -export interface AccessRequestedV2025 { - /** - * - * @type {AccessRequestResponse1V2025} - * @memberof AccessRequestedV2025 - */ - 'accessRequest': AccessRequestResponse1V2025; - /** - * the identity id - * @type {string} - * @memberof AccessRequestedV2025 - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessRequestedV2025 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessRequestedV2025 - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface AccessReviewItemV2025 - */ -export interface AccessReviewItemV2025 { - /** - * - * @type {AccessSummaryV2025} - * @memberof AccessReviewItemV2025 - */ - 'accessSummary'?: AccessSummaryV2025; - /** - * - * @type {CertificationIdentitySummaryV2025} - * @memberof AccessReviewItemV2025 - */ - 'identitySummary'?: CertificationIdentitySummaryV2025; - /** - * The review item\'s id - * @type {string} - * @memberof AccessReviewItemV2025 - */ - 'id'?: string; - /** - * Whether the review item is complete - * @type {boolean} - * @memberof AccessReviewItemV2025 - */ - 'completed'?: boolean; - /** - * Indicates whether the review item is for new access to a source - * @type {boolean} - * @memberof AccessReviewItemV2025 - */ - 'newAccess'?: boolean; - /** - * - * @type {CertificationDecisionV2025} - * @memberof AccessReviewItemV2025 - */ - 'decision'?: CertificationDecisionV2025; - /** - * Comments for this review item - * @type {string} - * @memberof AccessReviewItemV2025 - */ - 'comments'?: string | null; -} - - -/** - * - * @export - * @interface AccessReviewReassignmentV2025 - */ -export interface AccessReviewReassignmentV2025 { - /** - * - * @type {Array} - * @memberof AccessReviewReassignmentV2025 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof AccessReviewReassignmentV2025 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof AccessReviewReassignmentV2025 - */ - 'reason': string; -} -/** - * - * @export - * @interface AccessSummaryAccessV2025 - */ -export interface AccessSummaryAccessV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof AccessSummaryAccessV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The ID of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2025 - */ - 'id'?: string; - /** - * The name of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2025 - */ - 'name'?: string; -} - - -/** - * An object holding the access that is being reviewed - * @export - * @interface AccessSummaryV2025 - */ -export interface AccessSummaryV2025 { - /** - * - * @type {AccessSummaryAccessV2025} - * @memberof AccessSummaryV2025 - */ - 'access'?: AccessSummaryAccessV2025; - /** - * - * @type {ReviewableEntitlementV2025} - * @memberof AccessSummaryV2025 - */ - 'entitlement'?: ReviewableEntitlementV2025 | null; - /** - * - * @type {ReviewableAccessProfileV2025} - * @memberof AccessSummaryV2025 - */ - 'accessProfile'?: ReviewableAccessProfileV2025; - /** - * - * @type {ReviewableRoleV2025} - * @memberof AccessSummaryV2025 - */ - 'role'?: ReviewableRoleV2025 | null; -} -/** - * Access type of API Client indicating online or offline use - * @export - * @enum {string} - */ - -export const AccessTypeV2025 = { - Online: 'ONLINE', - Offline: 'OFFLINE' -} as const; - -export type AccessTypeV2025 = typeof AccessTypeV2025[keyof typeof AccessTypeV2025]; - - -/** - * - * @export - * @interface AccessV2025 - */ -export interface AccessV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessV2025 - */ - 'description'?: string | null; -} -/** - * Object for specifying Actions to be performed on a specified list of sources\' account. - * @export - * @interface AccountActionV2025 - */ -export interface AccountActionV2025 { - /** - * Describes if action will be enable, disable or delete. - * @type {string} - * @memberof AccountActionV2025 - */ - 'action'?: AccountActionV2025ActionV2025; - /** - * A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. - * @type {Set} - * @memberof AccountActionV2025 - */ - 'sourceIds'?: Set | null; - /** - * A list of source IDs to exclude from the action. Cannot be used together with sourceIds. - * @type {Set} - * @memberof AccountActionV2025 - */ - 'excludeSourceIds'?: Set | null; - /** - * If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. - * @type {boolean} - * @memberof AccountActionV2025 - */ - 'allSources'?: boolean; -} - -export const AccountActionV2025ActionV2025 = { - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE' -} as const; - -export type AccountActionV2025ActionV2025 = typeof AccountActionV2025ActionV2025[keyof typeof AccountActionV2025ActionV2025]; - -/** - * The state of an approval status - * @export - * @enum {string} - */ - -export const AccountActivityApprovalStatusV2025 = { - Finished: 'FINISHED', - Rejected: 'REJECTED', - Returned: 'RETURNED', - Expired: 'EXPIRED', - Pending: 'PENDING', - Canceled: 'CANCELED' -} as const; - -export type AccountActivityApprovalStatusV2025 = typeof AccountActivityApprovalStatusV2025[keyof typeof AccountActivityApprovalStatusV2025]; - - -/** - * AccountActivity - * @export - * @interface AccountActivityDocumentV2025 - */ -export interface AccountActivityDocumentV2025 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivityDocumentV2025 - */ - 'requester'?: ActivityIdentityV2025; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivityDocumentV2025 - */ - 'recipient'?: ActivityIdentityV2025; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentV2025 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentV2025 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityDocumentsV2025 - */ -export interface AccountActivityDocumentsV2025 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivityDocumentsV2025 - */ - 'requester'?: ActivityIdentityV2025; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivityDocumentsV2025 - */ - 'recipient'?: ActivityIdentityV2025; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentsV2025 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'sources'?: string; - /** - * Name of the pod. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof AccountActivityDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof AccountActivityDocumentsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof AccountActivityDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * Represents an operation in an account activity item - * @export - * @enum {string} - */ - -export const AccountActivityItemOperationV2025 = { - Add: 'ADD', - Create: 'CREATE', - Modify: 'MODIFY', - Delete: 'DELETE', - Disable: 'DISABLE', - Enable: 'ENABLE', - Unlock: 'UNLOCK', - Lock: 'LOCK', - Remove: 'REMOVE', - Set: 'SET' -} as const; - -export type AccountActivityItemOperationV2025 = typeof AccountActivityItemOperationV2025[keyof typeof AccountActivityItemOperationV2025]; - - -/** - * - * @export - * @interface AccountActivityItemV2025 - */ -export interface AccountActivityItemV2025 { - /** - * Item id - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'id'?: string; - /** - * Human-readable display name of item - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'name'?: string; - /** - * Date and time item was requested - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'requested'?: string; - /** - * - * @type {AccountActivityApprovalStatusV2025} - * @memberof AccountActivityItemV2025 - */ - 'approvalStatus'?: AccountActivityApprovalStatusV2025 | null; - /** - * - * @type {ProvisioningStateV2025} - * @memberof AccountActivityItemV2025 - */ - 'provisioningStatus'?: ProvisioningStateV2025; - /** - * - * @type {CommentV2025} - * @memberof AccountActivityItemV2025 - */ - 'requesterComment'?: CommentV2025 | null; - /** - * - * @type {IdentitySummaryV2025} - * @memberof AccountActivityItemV2025 - */ - 'reviewerIdentitySummary'?: IdentitySummaryV2025 | null; - /** - * - * @type {CommentV2025} - * @memberof AccountActivityItemV2025 - */ - 'reviewerComment'?: CommentV2025 | null; - /** - * - * @type {AccountActivityItemOperationV2025} - * @memberof AccountActivityItemV2025 - */ - 'operation'?: AccountActivityItemOperationV2025 | null; - /** - * Attribute to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'attribute'?: string | null; - /** - * Value of attribute - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'value'?: string | null; - /** - * Native identity in the target system to which the account activity applies - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'nativeIdentity'?: string | null; - /** - * Id of Source to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'sourceId'?: string; - /** - * - * @type {AccountRequestInfoV2025} - * @memberof AccountActivityItemV2025 - */ - 'accountRequestInfo'?: AccountRequestInfoV2025 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof AccountActivityItemV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof AccountActivityItemV2025 - */ - 'removeDate'?: string | null; -} - - -/** - * AccountActivity - * @export - * @interface AccountActivitySearchedItemV2025 - */ -export interface AccountActivitySearchedItemV2025 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivitySearchedItemV2025 - */ - 'requester'?: ActivityIdentityV2025; - /** - * - * @type {ActivityIdentityV2025} - * @memberof AccountActivitySearchedItemV2025 - */ - 'recipient'?: ActivityIdentityV2025; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivitySearchedItemV2025 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2025 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityV2025 - */ -export interface AccountActivityV2025 { - /** - * Id of the account activity - * @type {string} - * @memberof AccountActivityV2025 - */ - 'id'?: string; - /** - * The name of the activity - * @type {string} - * @memberof AccountActivityV2025 - */ - 'name'?: string; - /** - * When the activity was first created - * @type {string} - * @memberof AccountActivityV2025 - */ - 'created'?: string; - /** - * When the activity was last modified - * @type {string} - * @memberof AccountActivityV2025 - */ - 'modified'?: string | null; - /** - * When the activity was completed - * @type {string} - * @memberof AccountActivityV2025 - */ - 'completed'?: string | null; - /** - * - * @type {CompletionStatusV2025} - * @memberof AccountActivityV2025 - */ - 'completionStatus'?: CompletionStatusV2025 | null; - /** - * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - * @type {string} - * @memberof AccountActivityV2025 - */ - 'type'?: string | null; - /** - * - * @type {IdentitySummaryV2025} - * @memberof AccountActivityV2025 - */ - 'requesterIdentitySummary'?: IdentitySummaryV2025 | null; - /** - * - * @type {IdentitySummaryV2025} - * @memberof AccountActivityV2025 - */ - 'targetIdentitySummary'?: IdentitySummaryV2025 | null; - /** - * A list of error messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2025 - */ - 'errors'?: Array | null; - /** - * A list of warning messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2025 - */ - 'warnings'?: Array | null; - /** - * Individual actions performed as part of this account activity - * @type {Array} - * @memberof AccountActivityV2025 - */ - 'items'?: Array | null; - /** - * - * @type {ExecutionStatusV2025} - * @memberof AccountActivityV2025 - */ - 'executionStatus'?: ExecutionStatusV2025; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccountActivityV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - - -/** - * The source the accounts are being aggregated from. - * @export - * @interface AccountAggregationCompletedSourceV2025 - */ -export interface AccountAggregationCompletedSourceV2025 { - /** - * The DTO type of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2025 - */ - 'type': AccountAggregationCompletedSourceV2025TypeV2025; - /** - * The ID of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2025 - */ - 'id': string; - /** - * Display name of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2025 - */ - 'name': string; -} - -export const AccountAggregationCompletedSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccountAggregationCompletedSourceV2025TypeV2025 = typeof AccountAggregationCompletedSourceV2025TypeV2025[keyof typeof AccountAggregationCompletedSourceV2025TypeV2025]; - -/** - * Overall statistics about the account aggregation. - * @export - * @interface AccountAggregationCompletedStatsV2025 - */ -export interface AccountAggregationCompletedStatsV2025 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2025 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2025 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2025 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2025 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountAggregationCompletedStatsV2025 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountAggregationCompletedV2025 - */ -export interface AccountAggregationCompletedV2025 { - /** - * - * @type {AccountAggregationCompletedSourceV2025} - * @memberof AccountAggregationCompletedV2025 - */ - 'source': AccountAggregationCompletedSourceV2025; - /** - * The overall status of the aggregation. - * @type {object} - * @memberof AccountAggregationCompletedV2025 - */ - 'status': AccountAggregationCompletedV2025StatusV2025; - /** - * The date and time when the account aggregation started. - * @type {string} - * @memberof AccountAggregationCompletedV2025 - */ - 'started': string; - /** - * The date and time when the account aggregation finished. - * @type {string} - * @memberof AccountAggregationCompletedV2025 - */ - 'completed': string; - /** - * A list of errors that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2025 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2025 - */ - 'warnings': Array | null; - /** - * - * @type {AccountAggregationCompletedStatsV2025} - * @memberof AccountAggregationCompletedV2025 - */ - 'stats': AccountAggregationCompletedStatsV2025; -} - -export const AccountAggregationCompletedV2025StatusV2025 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountAggregationCompletedV2025StatusV2025 = typeof AccountAggregationCompletedV2025StatusV2025[keyof typeof AccountAggregationCompletedV2025StatusV2025]; - -/** - * - * @export - * @interface AccountAggregationStatusV2025 - */ -export interface AccountAggregationStatusV2025 { - /** - * When the aggregation started. - * @type {string} - * @memberof AccountAggregationStatusV2025 - */ - 'start'?: string | null; - /** - * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - * @type {string} - * @memberof AccountAggregationStatusV2025 - */ - 'status'?: AccountAggregationStatusV2025StatusV2025; - /** - * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'totalAccounts'?: number; - /** - * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'processedAccounts'?: number; - /** - * The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'totalAccountsMarkedForDeletion'?: number; - /** - * The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'deletedAccounts'?: number; - /** - * The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'totalIdentities'?: number; - /** - * The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2025 - */ - 'processedIdentities'?: number; -} - -export const AccountAggregationStatusV2025StatusV2025 = { - Started: 'STARTED', - AccountsCollected: 'ACCOUNTS_COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Retried: 'RETRIED', - Terminated: 'TERMINATED', - NotFound: 'NOT_FOUND' -} as const; - -export type AccountAggregationStatusV2025StatusV2025 = typeof AccountAggregationStatusV2025StatusV2025[keyof typeof AccountAggregationStatusV2025StatusV2025]; - -/** - * The identity this account is correlated to - * @export - * @interface AccountAllOfIdentityV2025 - */ -export interface AccountAllOfIdentityV2025 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfIdentityV2025 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfIdentityV2025 - */ - 'type'?: AccountAllOfIdentityV2025TypeV2025; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfIdentityV2025 - */ - 'name'?: string; -} - -export const AccountAllOfIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfIdentityV2025TypeV2025 = typeof AccountAllOfIdentityV2025TypeV2025[keyof typeof AccountAllOfIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface AccountAllOfOwnerIdentityV2025 - */ -export interface AccountAllOfOwnerIdentityV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof AccountAllOfOwnerIdentityV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountAllOfRecommendationV2025 - */ -export interface AccountAllOfRecommendationV2025 { - /** - * Recommended type of account. - * @type {string} - * @memberof AccountAllOfRecommendationV2025 - */ - 'type': AccountAllOfRecommendationV2025TypeV2025; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof AccountAllOfRecommendationV2025 - */ - 'method': AccountAllOfRecommendationV2025MethodV2025; -} - -export const AccountAllOfRecommendationV2025TypeV2025 = { - Human: 'HUMAN', - Machine: 'MACHINE', - Agent: 'AGENT' -} as const; - -export type AccountAllOfRecommendationV2025TypeV2025 = typeof AccountAllOfRecommendationV2025TypeV2025[keyof typeof AccountAllOfRecommendationV2025TypeV2025]; -export const AccountAllOfRecommendationV2025MethodV2025 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type AccountAllOfRecommendationV2025MethodV2025 = typeof AccountAllOfRecommendationV2025MethodV2025[keyof typeof AccountAllOfRecommendationV2025MethodV2025]; - -/** - * The owner of the source this account belongs to. - * @export - * @interface AccountAllOfSourceOwnerV2025 - */ -export interface AccountAllOfSourceOwnerV2025 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2025 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfSourceOwnerV2025 - */ - 'type'?: AccountAllOfSourceOwnerV2025TypeV2025; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2025 - */ - 'name'?: string; -} - -export const AccountAllOfSourceOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfSourceOwnerV2025TypeV2025 = typeof AccountAllOfSourceOwnerV2025TypeV2025[keyof typeof AccountAllOfSourceOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface AccountAttributeV2025 - */ -export interface AccountAttributeV2025 { - /** - * A reference to the source to search for the account - * @type {string} - * @memberof AccountAttributeV2025 - */ - 'sourceName': string; - /** - * The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - * @type {string} - * @memberof AccountAttributeV2025 - */ - 'attributeName': string; - /** - * The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - * @type {string} - * @memberof AccountAttributeV2025 - */ - 'accountSortAttribute'?: string; - /** - * The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - * @type {boolean} - * @memberof AccountAttributeV2025 - */ - 'accountSortDescending'?: boolean; - /** - * The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - * @type {boolean} - * @memberof AccountAttributeV2025 - */ - 'accountReturnFirstLink'?: boolean; - /** - * This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - * @type {string} - * @memberof AccountAttributeV2025 - */ - 'accountFilter'?: string; - /** - * This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. - * @type {string} - * @memberof AccountAttributeV2025 - */ - 'accountPropertyFilter'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof AccountAttributeV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof AccountAttributeV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Details of the account where the attributes changed. - * @export - * @interface AccountAttributesChangedAccountV2025 - */ -export interface AccountAttributesChangedAccountV2025 { - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof AccountAttributesChangedAccountV2025 - */ - 'id': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountAttributesChangedAccountV2025 - */ - 'uuid': string | null; - /** - * Name of the account. - * @type {string} - * @memberof AccountAttributesChangedAccountV2025 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountAttributesChangedAccountV2025 - */ - 'nativeIdentity': string; - /** - * The type of the account - * @type {object} - * @memberof AccountAttributesChangedAccountV2025 - */ - 'type': AccountAttributesChangedAccountV2025TypeV2025; -} - -export const AccountAttributesChangedAccountV2025TypeV2025 = { - Account: 'ACCOUNT' -} as const; - -export type AccountAttributesChangedAccountV2025TypeV2025 = typeof AccountAttributesChangedAccountV2025TypeV2025[keyof typeof AccountAttributesChangedAccountV2025TypeV2025]; - -/** - * @type AccountAttributesChangedChangesInnerNewValueV2025 - * The new value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerNewValueV2025 = Array | boolean | string; - -/** - * @type AccountAttributesChangedChangesInnerOldValueV2025 - * The previous value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerOldValueV2025 = Array | boolean | string; - -/** - * - * @export - * @interface AccountAttributesChangedChangesInnerV2025 - */ -export interface AccountAttributesChangedChangesInnerV2025 { - /** - * The name of the attribute. - * @type {string} - * @memberof AccountAttributesChangedChangesInnerV2025 - */ - 'attribute': string; - /** - * - * @type {AccountAttributesChangedChangesInnerOldValueV2025} - * @memberof AccountAttributesChangedChangesInnerV2025 - */ - 'oldValue': AccountAttributesChangedChangesInnerOldValueV2025 | null; - /** - * - * @type {AccountAttributesChangedChangesInnerNewValueV2025} - * @memberof AccountAttributesChangedChangesInnerV2025 - */ - 'newValue': AccountAttributesChangedChangesInnerNewValueV2025 | null; -} -/** - * The identity whose account attributes were updated. - * @export - * @interface AccountAttributesChangedIdentityV2025 - */ -export interface AccountAttributesChangedIdentityV2025 { - /** - * DTO type of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2025 - */ - 'type': AccountAttributesChangedIdentityV2025TypeV2025; - /** - * ID of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2025 - */ - 'id': string; - /** - * Display name of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2025 - */ - 'name': string; -} - -export const AccountAttributesChangedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAttributesChangedIdentityV2025TypeV2025 = typeof AccountAttributesChangedIdentityV2025TypeV2025[keyof typeof AccountAttributesChangedIdentityV2025TypeV2025]; - -/** - * The source that contains the account. - * @export - * @interface AccountAttributesChangedSourceV2025 - */ -export interface AccountAttributesChangedSourceV2025 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2025 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountAttributesChangedSourceV2025 - */ - 'type': AccountAttributesChangedSourceV2025TypeV2025; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2025 - */ - 'name': string; -} - -export const AccountAttributesChangedSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccountAttributesChangedSourceV2025TypeV2025 = typeof AccountAttributesChangedSourceV2025TypeV2025[keyof typeof AccountAttributesChangedSourceV2025TypeV2025]; - -/** - * - * @export - * @interface AccountAttributesChangedV2025 - */ -export interface AccountAttributesChangedV2025 { - /** - * - * @type {AccountAttributesChangedIdentityV2025} - * @memberof AccountAttributesChangedV2025 - */ - 'identity': AccountAttributesChangedIdentityV2025; - /** - * - * @type {AccountAttributesChangedSourceV2025} - * @memberof AccountAttributesChangedV2025 - */ - 'source': AccountAttributesChangedSourceV2025; - /** - * - * @type {AccountAttributesChangedAccountV2025} - * @memberof AccountAttributesChangedV2025 - */ - 'account': AccountAttributesChangedAccountV2025; - /** - * A list of attributes that changed. - * @type {Array} - * @memberof AccountAttributesChangedV2025 - */ - 'changes': Array; -} -/** - * The schema attribute values for the account - * @export - * @interface AccountAttributesCreateAttributesV2025 - */ -export interface AccountAttributesCreateAttributesV2025 { - [key: string]: string | any; - - /** - * Target source to create an account - * @type {string} - * @memberof AccountAttributesCreateAttributesV2025 - */ - 'sourceId': string; -} -/** - * - * @export - * @interface AccountAttributesCreateV2025 - */ -export interface AccountAttributesCreateV2025 { - /** - * - * @type {AccountAttributesCreateAttributesV2025} - * @memberof AccountAttributesCreateV2025 - */ - 'attributes': AccountAttributesCreateAttributesV2025; -} -/** - * - * @export - * @interface AccountAttributesV2025 - */ -export interface AccountAttributesV2025 { - /** - * The schema attribute values for the account - * @type {{ [key: string]: any; }} - * @memberof AccountAttributesV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * The correlated account. - * @export - * @interface AccountCorrelatedAccountV2025 - */ -export interface AccountCorrelatedAccountV2025 { - /** - * The correlated account\'s DTO type. - * @type {string} - * @memberof AccountCorrelatedAccountV2025 - */ - 'type': AccountCorrelatedAccountV2025TypeV2025; - /** - * The correlated account\'s ID. - * @type {string} - * @memberof AccountCorrelatedAccountV2025 - */ - 'id': string; - /** - * The correlated account\'s display name. - * @type {string} - * @memberof AccountCorrelatedAccountV2025 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountCorrelatedAccountV2025 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountCorrelatedAccountV2025 - */ - 'uuid'?: string | null; -} - -export const AccountCorrelatedAccountV2025TypeV2025 = { - Account: 'ACCOUNT' -} as const; - -export type AccountCorrelatedAccountV2025TypeV2025 = typeof AccountCorrelatedAccountV2025TypeV2025[keyof typeof AccountCorrelatedAccountV2025TypeV2025]; - -/** - * Identity the account is correlated with. - * @export - * @interface AccountCorrelatedIdentityV2025 - */ -export interface AccountCorrelatedIdentityV2025 { - /** - * DTO type of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2025 - */ - 'type': AccountCorrelatedIdentityV2025TypeV2025; - /** - * ID of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2025 - */ - 'id': string; - /** - * Display name of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2025 - */ - 'name': string; -} - -export const AccountCorrelatedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccountCorrelatedIdentityV2025TypeV2025 = typeof AccountCorrelatedIdentityV2025TypeV2025[keyof typeof AccountCorrelatedIdentityV2025TypeV2025]; - -/** - * The source the accounts are being correlated from. - * @export - * @interface AccountCorrelatedSourceV2025 - */ -export interface AccountCorrelatedSourceV2025 { - /** - * The DTO type of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2025 - */ - 'type': AccountCorrelatedSourceV2025TypeV2025; - /** - * The ID of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2025 - */ - 'id': string; - /** - * Display name of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2025 - */ - 'name': string; -} - -export const AccountCorrelatedSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccountCorrelatedSourceV2025TypeV2025 = typeof AccountCorrelatedSourceV2025TypeV2025[keyof typeof AccountCorrelatedSourceV2025TypeV2025]; - -/** - * - * @export - * @interface AccountCorrelatedV2025 - */ -export interface AccountCorrelatedV2025 { - /** - * - * @type {AccountCorrelatedIdentityV2025} - * @memberof AccountCorrelatedV2025 - */ - 'identity': AccountCorrelatedIdentityV2025; - /** - * - * @type {AccountCorrelatedSourceV2025} - * @memberof AccountCorrelatedV2025 - */ - 'source': AccountCorrelatedSourceV2025; - /** - * - * @type {AccountCorrelatedAccountV2025} - * @memberof AccountCorrelatedV2025 - */ - 'account': AccountCorrelatedAccountV2025; - /** - * The attributes associated with the account. Attributes are unique per source. - * @type {{ [key: string]: any; }} - * @memberof AccountCorrelatedV2025 - */ - 'attributes': { [key: string]: any; }; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountCorrelatedV2025 - */ - 'entitlementCount'?: number; -} -/** - * Details about the event. - * @export - * @interface AccountCreatedEventV2025 - */ -export interface AccountCreatedEventV2025 { - /** - * The type of event. - * @type {string} - * @memberof AccountCreatedEventV2025 - */ - 'type': AccountCreatedEventV2025TypeV2025; - /** - * The cause of the event. - * @type {string} - * @memberof AccountCreatedEventV2025 - */ - 'cause': AccountCreatedEventV2025CauseV2025; -} - -export const AccountCreatedEventV2025TypeV2025 = { - AccountCreatedV2: 'ACCOUNT_CREATED_V2' -} as const; - -export type AccountCreatedEventV2025TypeV2025 = typeof AccountCreatedEventV2025TypeV2025[keyof typeof AccountCreatedEventV2025TypeV2025]; -export const AccountCreatedEventV2025CauseV2025 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING' -} as const; - -export type AccountCreatedEventV2025CauseV2025 = typeof AccountCreatedEventV2025CauseV2025[keyof typeof AccountCreatedEventV2025CauseV2025]; - -/** - * - * @export - * @interface AccountCreatedV2025 - */ -export interface AccountCreatedV2025 { - /** - * - * @type {AccountCreatedEventV2025} - * @memberof AccountCreatedV2025 - */ - 'event': AccountCreatedEventV2025; - /** - * - * @type {AccountSourceReferenceV2025} - * @memberof AccountCreatedV2025 - */ - 'source': AccountSourceReferenceV2025; - /** - * - * @type {AccountV2V2025} - * @memberof AccountCreatedV2025 - */ - 'account': AccountV2V2025; - /** - * - * @type {IdentityReference1V2025} - * @memberof AccountCreatedV2025 - */ - 'identity': IdentityReference1V2025; -} -/** - * Details about the event. - * @export - * @interface AccountDeletedEventV2025 - */ -export interface AccountDeletedEventV2025 { - /** - * The type of event. - * @type {string} - * @memberof AccountDeletedEventV2025 - */ - 'type': AccountDeletedEventV2025TypeV2025; - /** - * The cause of the event. - * @type {string} - * @memberof AccountDeletedEventV2025 - */ - 'cause': AccountDeletedEventV2025CauseV2025; -} - -export const AccountDeletedEventV2025TypeV2025 = { - AccountDeletedV2: 'ACCOUNT_DELETED_V2' -} as const; - -export type AccountDeletedEventV2025TypeV2025 = typeof AccountDeletedEventV2025TypeV2025[keyof typeof AccountDeletedEventV2025TypeV2025]; -export const AccountDeletedEventV2025CauseV2025 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING' -} as const; - -export type AccountDeletedEventV2025CauseV2025 = typeof AccountDeletedEventV2025CauseV2025[keyof typeof AccountDeletedEventV2025CauseV2025]; - -/** - * - * @export - * @interface AccountDeletedV2025 - */ -export interface AccountDeletedV2025 { - /** - * - * @type {AccountDeletedEventV2025} - * @memberof AccountDeletedV2025 - */ - 'event': AccountDeletedEventV2025; - /** - * - * @type {AccountSourceReferenceV2025} - * @memberof AccountDeletedV2025 - */ - 'source': AccountSourceReferenceV2025; - /** - * - * @type {AccountV2V2025} - * @memberof AccountDeletedV2025 - */ - 'account': AccountV2V2025; - /** - * - * @type {IdentityReference1V2025} - * @memberof AccountDeletedV2025 - */ - 'identity': IdentityReference1V2025; -} -/** - * - * @export - * @interface AccountInfoDtoV2025 - */ -export interface AccountInfoDtoV2025 { - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountInfoDtoV2025 - */ - 'nativeIdentity'?: string; - /** - * Display name for this account - * @type {string} - * @memberof AccountInfoDtoV2025 - */ - 'displayName'?: string; - /** - * UUID associated with this account - * @type {string} - * @memberof AccountInfoDtoV2025 - */ - 'uuid'?: string; -} -/** - * - * @export - * @interface AccountInfoRefV2025 - */ -export interface AccountInfoRefV2025 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountInfoRefV2025 - */ - 'uuid'?: string; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountInfoRefV2025 - */ - 'nativeIdentity'?: string; - /** - * - * @type {DtoTypeV2025} - * @memberof AccountInfoRefV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The account id - * @type {string} - * @memberof AccountInfoRefV2025 - */ - 'id'?: string; - /** - * The account display name - * @type {string} - * @memberof AccountInfoRefV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountItemRefV2025 - */ -export interface AccountItemRefV2025 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountItemRefV2025 - */ - 'accountUuid'?: string | null; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountItemRefV2025 - */ - 'nativeIdentity'?: string; -} -/** - * If an account activity item is associated with an access request, captures details of that request. - * @export - * @interface AccountRequestInfoV2025 - */ -export interface AccountRequestInfoV2025 { - /** - * Id of requested object - * @type {string} - * @memberof AccountRequestInfoV2025 - */ - 'requestedObjectId'?: string; - /** - * Human-readable name of requested object - * @type {string} - * @memberof AccountRequestInfoV2025 - */ - 'requestedObjectName'?: string; - /** - * - * @type {RequestableObjectTypeV2025} - * @memberof AccountRequestInfoV2025 - */ - 'requestedObjectType'?: RequestableObjectTypeV2025; -} - - -/** - * - * @export - * @interface AccountRequestResultV2025 - */ -export interface AccountRequestResultV2025 { - /** - * Error message. - * @type {Array} - * @memberof AccountRequestResultV2025 - */ - 'errors'?: Array; - /** - * The status of the account request - * @type {string} - * @memberof AccountRequestResultV2025 - */ - 'status'?: string; - /** - * ID of associated ticket. - * @type {string} - * @memberof AccountRequestResultV2025 - */ - 'ticketId'?: string | null; -} -/** - * - * @export - * @interface AccountRequestV2025 - */ -export interface AccountRequestV2025 { - /** - * Unique ID of the account - * @type {string} - * @memberof AccountRequestV2025 - */ - 'accountId'?: string; - /** - * - * @type {Array} - * @memberof AccountRequestV2025 - */ - 'attributeRequests'?: Array; - /** - * The operation that was performed - * @type {string} - * @memberof AccountRequestV2025 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2025} - * @memberof AccountRequestV2025 - */ - 'provisioningTarget'?: AccountSourceV2025; - /** - * - * @type {AccountRequestResultV2025} - * @memberof AccountRequestV2025 - */ - 'result'?: AccountRequestResultV2025; - /** - * - * @type {AccountSourceV2025} - * @memberof AccountRequestV2025 - */ - 'source'?: AccountSourceV2025; -} -/** - * Details about the governance group of the source. - * @export - * @interface AccountSourceReferenceGovernanceGroupV2025 - */ -export interface AccountSourceReferenceGovernanceGroupV2025 { - /** - * ID of the governance group. - * @type {string} - * @memberof AccountSourceReferenceGovernanceGroupV2025 - */ - 'id': string; - /** - * Name of the governance group. - * @type {string} - * @memberof AccountSourceReferenceGovernanceGroupV2025 - */ - 'name': string; -} -/** - * Details about the owner of the source. - * @export - * @interface AccountSourceReferenceOwnerV2025 - */ -export interface AccountSourceReferenceOwnerV2025 { - /** - * ID of the source owner. - * @type {string} - * @memberof AccountSourceReferenceOwnerV2025 - */ - 'id': string; - /** - * Name of the source owner. - * @type {string} - * @memberof AccountSourceReferenceOwnerV2025 - */ - 'name': string; -} -/** - * Details about the account source. - * @export - * @interface AccountSourceReferenceV2025 - */ -export interface AccountSourceReferenceV2025 { - /** - * The unique ID of the source. - * @type {string} - * @memberof AccountSourceReferenceV2025 - */ - 'id': string; - /** - * The name of the source. - * @type {string} - * @memberof AccountSourceReferenceV2025 - */ - 'name': string; - /** - * The alias of the source. - * @type {string} - * @memberof AccountSourceReferenceV2025 - */ - 'alias': string; - /** - * - * @type {AccountSourceReferenceOwnerV2025} - * @memberof AccountSourceReferenceV2025 - */ - 'owner': AccountSourceReferenceOwnerV2025; - /** - * - * @type {AccountSourceReferenceGovernanceGroupV2025} - * @memberof AccountSourceReferenceV2025 - */ - 'governanceGroup': AccountSourceReferenceGovernanceGroupV2025; -} -/** - * - * @export - * @interface AccountSourceV2025 - */ -export interface AccountSourceV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccountSourceV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccountSourceV2025 - */ - 'name'?: string; - /** - * Type of source returned. - * @type {string} - * @memberof AccountSourceV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedAccountV2025 - */ -export interface AccountStatusChangedAccountV2025 { - /** - * the ID of the account in the database - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'id'?: string; - /** - * the native identifier of the account - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'nativeIdentity'?: string; - /** - * the display name of the account - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'displayName'?: string; - /** - * the ID of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'sourceId'?: string; - /** - * the name of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'sourceName'?: string; - /** - * the number of entitlements on this account - * @type {number} - * @memberof AccountStatusChangedAccountV2025 - */ - 'entitlementCount'?: number; - /** - * this value is always \"account\" - * @type {string} - * @memberof AccountStatusChangedAccountV2025 - */ - 'accessType'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedStatusChangeV2025 - */ -export interface AccountStatusChangedStatusChangeV2025 { - /** - * the previous status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeV2025 - */ - 'previousStatus'?: AccountStatusChangedStatusChangeV2025PreviousStatusV2025; - /** - * the new status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeV2025 - */ - 'newStatus'?: AccountStatusChangedStatusChangeV2025NewStatusV2025; -} - -export const AccountStatusChangedStatusChangeV2025PreviousStatusV2025 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeV2025PreviousStatusV2025 = typeof AccountStatusChangedStatusChangeV2025PreviousStatusV2025[keyof typeof AccountStatusChangedStatusChangeV2025PreviousStatusV2025]; -export const AccountStatusChangedStatusChangeV2025NewStatusV2025 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeV2025NewStatusV2025 = typeof AccountStatusChangedStatusChangeV2025NewStatusV2025[keyof typeof AccountStatusChangedStatusChangeV2025NewStatusV2025]; - -/** - * - * @export - * @interface AccountStatusChangedV2025 - */ -export interface AccountStatusChangedV2025 { - /** - * the event type - * @type {string} - * @memberof AccountStatusChangedV2025 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AccountStatusChangedV2025 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AccountStatusChangedV2025 - */ - 'dateTime'?: string; - /** - * - * @type {AccountStatusChangedAccountV2025} - * @memberof AccountStatusChangedV2025 - */ - 'account': AccountStatusChangedAccountV2025; - /** - * - * @type {AccountStatusChangedStatusChangeV2025} - * @memberof AccountStatusChangedV2025 - */ - 'statusChange': AccountStatusChangedStatusChangeV2025; -} -/** - * Request used for account enable/disable - * @export - * @interface AccountToggleRequestV2025 - */ -export interface AccountToggleRequestV2025 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountToggleRequestV2025 - */ - 'externalVerificationId'?: string; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. - * @type {boolean} - * @memberof AccountToggleRequestV2025 - */ - 'forceProvisioning'?: boolean; -} -/** - * Uncorrelated account. - * @export - * @interface AccountUncorrelatedAccountV2025 - */ -export interface AccountUncorrelatedAccountV2025 { - /** - * Uncorrelated account\'s DTO type. - * @type {object} - * @memberof AccountUncorrelatedAccountV2025 - */ - 'type': AccountUncorrelatedAccountV2025TypeV2025; - /** - * Uncorrelated account\'s ID. - * @type {string} - * @memberof AccountUncorrelatedAccountV2025 - */ - 'id': string; - /** - * Uncorrelated account\'s display name. - * @type {string} - * @memberof AccountUncorrelatedAccountV2025 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountUncorrelatedAccountV2025 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountUncorrelatedAccountV2025 - */ - 'uuid'?: string | null; -} - -export const AccountUncorrelatedAccountV2025TypeV2025 = { - Account: 'ACCOUNT' -} as const; - -export type AccountUncorrelatedAccountV2025TypeV2025 = typeof AccountUncorrelatedAccountV2025TypeV2025[keyof typeof AccountUncorrelatedAccountV2025TypeV2025]; - -/** - * Identity the account is uncorrelated with. - * @export - * @interface AccountUncorrelatedIdentityV2025 - */ -export interface AccountUncorrelatedIdentityV2025 { - /** - * DTO type of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2025 - */ - 'type': AccountUncorrelatedIdentityV2025TypeV2025; - /** - * ID of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2025 - */ - 'id': string; - /** - * Display name of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2025 - */ - 'name': string; -} - -export const AccountUncorrelatedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AccountUncorrelatedIdentityV2025TypeV2025 = typeof AccountUncorrelatedIdentityV2025TypeV2025[keyof typeof AccountUncorrelatedIdentityV2025TypeV2025]; - -/** - * The source the accounts are uncorrelated from. - * @export - * @interface AccountUncorrelatedSourceV2025 - */ -export interface AccountUncorrelatedSourceV2025 { - /** - * The DTO type of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2025 - */ - 'type': AccountUncorrelatedSourceV2025TypeV2025; - /** - * The ID of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2025 - */ - 'id': string; - /** - * Display name of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2025 - */ - 'name': string; -} - -export const AccountUncorrelatedSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccountUncorrelatedSourceV2025TypeV2025 = typeof AccountUncorrelatedSourceV2025TypeV2025[keyof typeof AccountUncorrelatedSourceV2025TypeV2025]; - -/** - * - * @export - * @interface AccountUncorrelatedV2025 - */ -export interface AccountUncorrelatedV2025 { - /** - * - * @type {AccountUncorrelatedIdentityV2025} - * @memberof AccountUncorrelatedV2025 - */ - 'identity': AccountUncorrelatedIdentityV2025; - /** - * - * @type {AccountUncorrelatedSourceV2025} - * @memberof AccountUncorrelatedV2025 - */ - 'source': AccountUncorrelatedSourceV2025; - /** - * - * @type {AccountUncorrelatedAccountV2025} - * @memberof AccountUncorrelatedV2025 - */ - 'account': AccountUncorrelatedAccountV2025; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountUncorrelatedV2025 - */ - 'entitlementCount'?: number; -} -/** - * Request used for account unlock - * @export - * @interface AccountUnlockRequestV2025 - */ -export interface AccountUnlockRequestV2025 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountUnlockRequestV2025 - */ - 'externalVerificationId'?: string; - /** - * If set, the IDN account is unlocked after the workflow completes. - * @type {boolean} - * @memberof AccountUnlockRequestV2025 - */ - 'unlockIDNAccount'?: boolean; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountUnlockRequestV2025 - */ - 'forceProvisioning'?: boolean; -} -/** - * The type of the entitlement. - * @export - * @interface AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025 - */ -export interface AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025 { - /** - * The unique identifier of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025 - */ - 'id'?: string; - /** - * The name of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025 - */ - 'name'?: string | null; - /** - * The type of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccountUpdatedEntitlementChangesInnerAddedInnerV2025 - */ -export interface AccountUpdatedEntitlementChangesInnerAddedInnerV2025 { - /** - * The unique identifier of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2025 - */ - 'id'?: string | null; - /** - * The name of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2025 - */ - 'name'?: string | null; - /** - * - * @type {AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2025 - */ - 'owner'?: AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2025; - /** - * The value of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface AccountUpdatedEntitlementChangesInnerV2025 - */ -export interface AccountUpdatedEntitlementChangesInnerV2025 { - /** - * The name of the entitlement attribute that was changed. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerV2025 - */ - 'attributeName': string; - /** - * The entitlements that were added. - * @type {Array} - * @memberof AccountUpdatedEntitlementChangesInnerV2025 - */ - 'added': Array | null; - /** - * The entitlements that were removed. - * @type {Array} - * @memberof AccountUpdatedEntitlementChangesInnerV2025 - */ - 'removed': Array | null; -} -/** - * Details about the event. - * @export - * @interface AccountUpdatedEventV2025 - */ -export interface AccountUpdatedEventV2025 { - /** - * The type of event. - * @type {string} - * @memberof AccountUpdatedEventV2025 - */ - 'type': AccountUpdatedEventV2025TypeV2025; - /** - * The cause of the event. - * @type {string} - * @memberof AccountUpdatedEventV2025 - */ - 'cause': AccountUpdatedEventV2025CauseV2025; -} - -export const AccountUpdatedEventV2025TypeV2025 = { - AccountUpdatedV2: 'ACCOUNT_UPDATED_V2' -} as const; - -export type AccountUpdatedEventV2025TypeV2025 = typeof AccountUpdatedEventV2025TypeV2025[keyof typeof AccountUpdatedEventV2025TypeV2025]; -export const AccountUpdatedEventV2025CauseV2025 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING', - PasswordChange: 'PASSWORD_CHANGE' -} as const; - -export type AccountUpdatedEventV2025CauseV2025 = typeof AccountUpdatedEventV2025CauseV2025[keyof typeof AccountUpdatedEventV2025CauseV2025]; - -/** - * @type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInnerV2025 - * @export - */ -export type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInnerV2025 = Array | boolean | number | string; - -/** - * - * @export - * @interface AccountUpdatedMultiValueAttributeChangesInnerV2025 - */ -export interface AccountUpdatedMultiValueAttributeChangesInnerV2025 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2025 - */ - 'name': string; - /** - * The values that were added to the attribute. - * @type {Array} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2025 - */ - 'addedValues': Array; - /** - * The values that were removed from the attribute. - * @type {Array} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2025 - */ - 'removedValues': Array; -} -/** - * @type AccountUpdatedSingleValueAttributeChangesInnerNewValueV2025 - * The new value of the attribute after the change. - * @export - */ -export type AccountUpdatedSingleValueAttributeChangesInnerNewValueV2025 = Array | boolean | number | string; - -/** - * @type AccountUpdatedSingleValueAttributeChangesInnerOldValueV2025 - * The old value of the attribute before the change. - * @export - */ -export type AccountUpdatedSingleValueAttributeChangesInnerOldValueV2025 = Array | boolean | number | string; - -/** - * - * @export - * @interface AccountUpdatedSingleValueAttributeChangesInnerV2025 - */ -export interface AccountUpdatedSingleValueAttributeChangesInnerV2025 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'name': string; - /** - * - * @type {AccountUpdatedSingleValueAttributeChangesInnerOldValueV2025} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'oldValue': AccountUpdatedSingleValueAttributeChangesInnerOldValueV2025 | null; - /** - * - * @type {AccountUpdatedSingleValueAttributeChangesInnerNewValueV2025} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'newValue': AccountUpdatedSingleValueAttributeChangesInnerNewValueV2025 | null; -} -/** - * - * @export - * @interface AccountUpdatedV2025 - */ -export interface AccountUpdatedV2025 { - /** - * - * @type {AccountUpdatedEventV2025} - * @memberof AccountUpdatedV2025 - */ - 'event': AccountUpdatedEventV2025; - /** - * - * @type {AccountSourceReferenceV2025} - * @memberof AccountUpdatedV2025 - */ - 'source': AccountSourceReferenceV2025; - /** - * - * @type {AccountV2V2025} - * @memberof AccountUpdatedV2025 - */ - 'account': AccountV2V2025; - /** - * - * @type {IdentityReference1V2025} - * @memberof AccountUpdatedV2025 - */ - 'identity': IdentityReference1V2025; - /** - * The types of changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2025 - */ - 'accountChangeTypes': Array; - /** - * Details about the single-value attribute changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2025 - */ - 'singleValueAttributeChanges': Array | null; - /** - * Details about the multi-value attribute changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2025 - */ - 'multiValueAttributeChanges': Array | null; - /** - * Details about the entitlement changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2025 - */ - 'entitlementChanges': Array | null; -} - -export const AccountUpdatedV2025AccountChangeTypesV2025 = { - AttributesChanged: 'ATTRIBUTES_CHANGED', - EntitlementsAdded: 'ENTITLEMENTS_ADDED', - EntitlementsRemoved: 'ENTITLEMENTS_REMOVED' -} as const; - -export type AccountUpdatedV2025AccountChangeTypesV2025 = typeof AccountUpdatedV2025AccountChangeTypesV2025[keyof typeof AccountUpdatedV2025AccountChangeTypesV2025]; - -/** - * - * @export - * @interface AccountUsageV2025 - */ -export interface AccountUsageV2025 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof AccountUsageV2025 - */ - 'date'?: string; - /** - * The number of days within the month that the account was active in a source. - * @type {number} - * @memberof AccountUsageV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface AccountV2025 - */ -export interface AccountV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof AccountV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof AccountV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof AccountV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof AccountV2025 - */ - 'modified'?: string; - /** - * The unique ID of the source this account belongs to - * @type {string} - * @memberof AccountV2025 - */ - 'sourceId': string; - /** - * The display name of the source this account belongs to - * @type {string} - * @memberof AccountV2025 - */ - 'sourceName': string | null; - /** - * The unique ID of the identity this account is correlated to - * @type {string} - * @memberof AccountV2025 - */ - 'identityId'?: string; - /** - * The lifecycle state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2025 - */ - 'cloudLifecycleState'?: string | null; - /** - * The identity state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2025 - */ - 'identityState'?: string | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof AccountV2025 - */ - 'connectionType'?: string | null; - /** - * Indicates if the account is of machine type - * @type {boolean} - * @memberof AccountV2025 - */ - 'isMachine'?: boolean; - /** - * - * @type {AccountAllOfRecommendationV2025} - * @memberof AccountV2025 - */ - 'recommendation'?: AccountAllOfRecommendationV2025; - /** - * The account attributes that are aggregated - * @type {{ [key: string]: any; }} - * @memberof AccountV2025 - */ - 'attributes': { [key: string]: any; } | null; - /** - * Indicates if this account is from an authoritative source - * @type {boolean} - * @memberof AccountV2025 - */ - 'authoritative': boolean; - /** - * A description of the account - * @type {string} - * @memberof AccountV2025 - */ - 'description'?: string | null; - /** - * Indicates if the account is currently disabled - * @type {boolean} - * @memberof AccountV2025 - */ - 'disabled': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof AccountV2025 - */ - 'locked': boolean; - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountV2025 - */ - 'nativeIdentity': string; - /** - * If true, this is a user account within IdentityNow. If false, this is an account from a source system. - * @type {boolean} - * @memberof AccountV2025 - */ - 'systemAccount': boolean; - /** - * Indicates if this account is not correlated to an identity - * @type {boolean} - * @memberof AccountV2025 - */ - 'uncorrelated': boolean; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof AccountV2025 - */ - 'uuid'?: string | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof AccountV2025 - */ - 'manuallyCorrelated': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof AccountV2025 - */ - 'hasEntitlements': boolean; - /** - * - * @type {AccountAllOfIdentityV2025} - * @memberof AccountV2025 - */ - 'identity'?: AccountAllOfIdentityV2025; - /** - * - * @type {AccountAllOfSourceOwnerV2025} - * @memberof AccountV2025 - */ - 'sourceOwner'?: AccountAllOfSourceOwnerV2025 | null; - /** - * A string list containing the owning source\'s features - * @type {string} - * @memberof AccountV2025 - */ - 'features'?: string | null; - /** - * The origin of the account either aggregated or provisioned - * @type {string} - * @memberof AccountV2025 - */ - 'origin'?: AccountV2025OriginV2025 | null; - /** - * - * @type {AccountAllOfOwnerIdentityV2025} - * @memberof AccountV2025 - */ - 'ownerIdentity'?: AccountAllOfOwnerIdentityV2025; -} - -export const AccountV2025OriginV2025 = { - Aggregated: 'AGGREGATED', - Provisioned: 'PROVISIONED' -} as const; - -export type AccountV2025OriginV2025 = typeof AccountV2025OriginV2025[keyof typeof AccountV2025OriginV2025]; - -/** - * Details about the account. - * @export - * @interface AccountV2V2025 - */ -export interface AccountV2V2025 { - /** - * The unique identifier of the account. - * @type {string} - * @memberof AccountV2V2025 - */ - 'id': string; - /** - * The name of the account. - * @type {string} - * @memberof AccountV2V2025 - */ - 'name': string; - /** - * The unique ID of the account generated by the source system. - * @type {string} - * @memberof AccountV2V2025 - */ - 'nativeIdentity': string; - /** - * The unique ID associated with this account. - * @type {string} - * @memberof AccountV2V2025 - */ - 'uuid': string | null; - /** - * Indicates if the account is correlated to an identity. - * @type {boolean} - * @memberof AccountV2V2025 - */ - 'correlated': boolean; - /** - * Indicates if the account is a machine account. - * @type {boolean} - * @memberof AccountV2V2025 - */ - 'isMachine': boolean; - /** - * The origin of the account. - * @type {string} - * @memberof AccountV2V2025 - */ - 'origin': string | null; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof AccountV2V2025 - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * Accounts async response containing details on started async process - * @export - * @interface AccountsAsyncResultV2025 - */ -export interface AccountsAsyncResultV2025 { - /** - * id of the task - * @type {string} - * @memberof AccountsAsyncResultV2025 - */ - 'id': string; -} -/** - * Reference to the source that has been aggregated. - * @export - * @interface AccountsCollectedForAggregationSourceV2025 - */ -export interface AccountsCollectedForAggregationSourceV2025 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2025 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2025 - */ - 'type': AccountsCollectedForAggregationSourceV2025TypeV2025; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2025 - */ - 'name': string; -} - -export const AccountsCollectedForAggregationSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AccountsCollectedForAggregationSourceV2025TypeV2025 = typeof AccountsCollectedForAggregationSourceV2025TypeV2025[keyof typeof AccountsCollectedForAggregationSourceV2025TypeV2025]; - -/** - * Overall statistics about the account collection. - * @export - * @interface AccountsCollectedForAggregationStatsV2025 - */ -export interface AccountsCollectedForAggregationStatsV2025 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2025 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2025 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2025 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2025 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2025 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountsCollectedForAggregationV2025 - */ -export interface AccountsCollectedForAggregationV2025 { - /** - * - * @type {AccountsCollectedForAggregationSourceV2025} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'source': AccountsCollectedForAggregationSourceV2025; - /** - * The overall status of the collection. - * @type {object} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'status': AccountsCollectedForAggregationV2025StatusV2025; - /** - * The date and time when the account collection started. - * @type {string} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'started': string; - /** - * The date and time when the account collection finished. - * @type {string} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'completed': string; - /** - * A list of errors that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'warnings': Array | null; - /** - * - * @type {AccountsCollectedForAggregationStatsV2025} - * @memberof AccountsCollectedForAggregationV2025 - */ - 'stats': AccountsCollectedForAggregationStatsV2025; -} - -export const AccountsCollectedForAggregationV2025StatusV2025 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountsCollectedForAggregationV2025StatusV2025 = typeof AccountsCollectedForAggregationV2025StatusV2025[keyof typeof AccountsCollectedForAggregationV2025StatusV2025]; - -/** - * Arguments for Account Export report (ACCOUNTS) - * @export - * @interface AccountsExportReportArgumentsV2025 - */ -export interface AccountsExportReportArgumentsV2025 { - /** - * Source ID. - * @type {string} - * @memberof AccountsExportReportArgumentsV2025 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof AccountsExportReportArgumentsV2025 - */ - 'sourceName': string; -} -/** - * - * @export - * @interface AccountsSelectionRequestV2025 - */ -export interface AccountsSelectionRequestV2025 { - /** - * A list of Identity IDs for whom the Access is requested. - * @type {Array} - * @memberof AccountsSelectionRequestV2025 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof AccountsSelectionRequestV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * - * @type {Array} - * @memberof AccountsSelectionRequestV2025 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccountsSelectionRequestV2025 - */ - 'clientMetadata'?: { [key: string]: string; }; -} - - -/** - * - * @export - * @interface AccountsSelectionResponseV2025 - */ -export interface AccountsSelectionResponseV2025 { - /** - * A list of available account selections per identity in the request, for all the requested items - * @type {Array} - * @memberof AccountsSelectionResponseV2025 - */ - 'identities'?: Array; -} -/** - * - * @export - * @interface ActivateCampaignOptionsV2025 - */ -export interface ActivateCampaignOptionsV2025 { - /** - * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - * @type {string} - * @memberof ActivateCampaignOptionsV2025 - */ - 'timeZone'?: string; -} -/** - * - * @export - * @interface ActivityConfigurationSettingsV2025 - */ -export interface ActivityConfigurationSettingsV2025 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'clusterId'?: string | null; - /** - * The time period for retaining activity logs. - * @type {number} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'retentionTimePeriod'?: number; - /** - * The type of retention period (e.g., days, months, years). - * @type {string} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'retentionTimeType'?: string | null; - /** - * List of user identifiers to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'excludeUsers'?: Array | null; - /** - * List of folder paths to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'excludeFolders'?: Array | null; - /** - * List of file extensions to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'excludeFileExtensions'?: Array | null; - /** - * List of actions to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2025 - */ - 'excludeActions'?: Array | null; -} -/** - * - * @export - * @interface ActivityIdentityV2025 - */ -export interface ActivityIdentityV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2025 - */ - 'name'?: string; - /** - * Type of object - * @type {string} - * @memberof ActivityIdentityV2025 - */ - 'type'?: string; -} -/** - * Insights into account activity - * @export - * @interface ActivityInsightsV2025 - */ -export interface ActivityInsightsV2025 { - /** - * UUID of the account - * @type {string} - * @memberof ActivityInsightsV2025 - */ - 'accountID'?: string; - /** - * The number of days of activity - * @type {number} - * @memberof ActivityInsightsV2025 - */ - 'usageDays'?: number; - /** - * Status indicating if the activity is complete or unknown - * @type {string} - * @memberof ActivityInsightsV2025 - */ - 'usageDaysState'?: ActivityInsightsV2025UsageDaysStateV2025; -} - -export const ActivityInsightsV2025UsageDaysStateV2025 = { - Complete: 'COMPLETE', - Unknown: 'UNKNOWN' -} as const; - -export type ActivityInsightsV2025UsageDaysStateV2025 = typeof ActivityInsightsV2025UsageDaysStateV2025[keyof typeof ActivityInsightsV2025UsageDaysStateV2025]; - -/** - * Reference to an additional owner (identity or governance group). - * @export - * @interface AdditionalOwnerRefV2025 - */ -export interface AdditionalOwnerRefV2025 { - /** - * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2025 - */ - 'type'?: AdditionalOwnerRefV2025TypeV2025; - /** - * ID of the identity or governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2025 - */ - 'id'?: string; - /** - * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. - * @type {string} - * @memberof AdditionalOwnerRefV2025 - */ - 'name'?: string | null; -} - -export const AdditionalOwnerRefV2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AdditionalOwnerRefV2025TypeV2025 = typeof AdditionalOwnerRefV2025TypeV2025[keyof typeof AdditionalOwnerRefV2025TypeV2025]; - -/** - * - * @export - * @interface AdminReviewReassignReassignToV2025 - */ -export interface AdminReviewReassignReassignToV2025 { - /** - * The identity ID to which the review is being assigned. - * @type {string} - * @memberof AdminReviewReassignReassignToV2025 - */ - 'id'?: string; - /** - * The type of the ID provided. - * @type {string} - * @memberof AdminReviewReassignReassignToV2025 - */ - 'type'?: AdminReviewReassignReassignToV2025TypeV2025; -} - -export const AdminReviewReassignReassignToV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type AdminReviewReassignReassignToV2025TypeV2025 = typeof AdminReviewReassignReassignToV2025TypeV2025[keyof typeof AdminReviewReassignReassignToV2025TypeV2025]; - -/** - * - * @export - * @interface AdminReviewReassignV2025 - */ -export interface AdminReviewReassignV2025 { - /** - * List of certification IDs to reassign - * @type {Array} - * @memberof AdminReviewReassignV2025 - */ - 'certificationIds'?: Array; - /** - * - * @type {AdminReviewReassignReassignToV2025} - * @memberof AdminReviewReassignV2025 - */ - 'reassignTo'?: AdminReviewReassignReassignToV2025; - /** - * Comment to explain why the certification was reassigned - * @type {string} - * @memberof AdminReviewReassignV2025 - */ - 'reason'?: string; -} -/** - * - * @export - * @interface AggregationResultV2025 - */ -export interface AggregationResultV2025 { - /** - * The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - * @type {object} - * @memberof AggregationResultV2025 - */ - 'aggregations'?: object; - /** - * The results of the aggregation search query. - * @type {Array} - * @memberof AggregationResultV2025 - */ - 'hits'?: Array; -} -/** - * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const AggregationTypeV2025 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT' -} as const; - -export type AggregationTypeV2025 = typeof AggregationTypeV2025[keyof typeof AggregationTypeV2025]; - - -/** - * - * @export - * @interface AggregationsV2025 - */ -export interface AggregationsV2025 { - /** - * - * @type {NestedAggregationV2025} - * @memberof AggregationsV2025 - */ - 'nested'?: NestedAggregationV2025; - /** - * - * @type {MetricAggregationV2025} - * @memberof AggregationsV2025 - */ - 'metric'?: MetricAggregationV2025; - /** - * - * @type {FilterAggregationV2025} - * @memberof AggregationsV2025 - */ - 'filter'?: FilterAggregationV2025; - /** - * - * @type {BucketAggregationV2025} - * @memberof AggregationsV2025 - */ - 'bucket'?: BucketAggregationV2025; -} -/** - * - * @export - * @interface AppAccountDetailsSourceAccountV2025 - */ -export interface AppAccountDetailsSourceAccountV2025 { - /** - * The account ID - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2025 - */ - 'id'?: string; - /** - * The native identity of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2025 - */ - 'nativeIdentity'?: string; - /** - * The display name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2025 - */ - 'displayName'?: string; - /** - * The source ID of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2025 - */ - 'sourceId'?: string; - /** - * The source name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2025 - */ - 'sourceDisplayName'?: string; -} -/** - * - * @export - * @interface AppAccountDetailsV2025 - */ -export interface AppAccountDetailsV2025 { - /** - * The source app ID - * @type {string} - * @memberof AppAccountDetailsV2025 - */ - 'appId'?: string; - /** - * The source app display name - * @type {string} - * @memberof AppAccountDetailsV2025 - */ - 'appDisplayName'?: string; - /** - * - * @type {AppAccountDetailsSourceAccountV2025} - * @memberof AppAccountDetailsV2025 - */ - 'sourceAccount'?: AppAccountDetailsSourceAccountV2025; -} -/** - * - * @export - * @interface AppAllOfAccountV2025 - */ -export interface AppAllOfAccountV2025 { - /** - * The SailPoint generated unique ID - * @type {string} - * @memberof AppAllOfAccountV2025 - */ - 'id'?: string; - /** - * The account ID generated by the source - * @type {string} - * @memberof AppAllOfAccountV2025 - */ - 'accountId'?: string; -} -/** - * - * @export - * @interface AppV2025 - */ -export interface AppV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AppV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AppV2025 - */ - 'name'?: string; - /** - * - * @type {Reference1V2025} - * @memberof AppV2025 - */ - 'source'?: Reference1V2025; - /** - * - * @type {AppAllOfAccountV2025} - * @memberof AppV2025 - */ - 'account'?: AppAllOfAccountV2025; -} -/** - * - * @export - * @interface ApplicationCrawlerSettingsV2025 - */ -export interface ApplicationCrawlerSettingsV2025 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'clusterId'?: string | null; - /** - * - * @type {CrawlResourcesSizesOptionsV2025} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'calculateResourceSize'?: CrawlResourcesSizesOptionsV2025; - /** - * Indicates whether to crawl the snapshots folder. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'crawlSnapshotsFolder'?: boolean | null; - /** - * Indicates whether to crawl mailboxes. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'crawlMailboxes'?: boolean | null; - /** - * Indicates whether to crawl public folders. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'crawlPublicFolders'?: boolean | null; - /** - * Regular expression pattern for paths to exclude from crawling. - * @type {string} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'excludedPathsByRegex'?: string | null; - /** - * List of top-level shares to crawl. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'crawlTopLevelShares'?: Array | null; - /** - * List of resource identifiers to exclude from crawling. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'excludedResources'?: Array | null; - /** - * List of resource identifiers to include in crawling. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2025 - */ - 'includeResources'?: Array | null; -} - - -/** - * - * @export - * @interface ApplicationDiscoveryRequestV2025 - */ -export interface ApplicationDiscoveryRequestV2025 { - /** - * List of dataset Ids to discover applications - * @type {Array} - * @memberof ApplicationDiscoveryRequestV2025 - */ - 'datasetIds': Array; -} -/** - * The target(source) of app discovery - * @export - * @interface ApplicationDiscoveryResponseTargetV2025 - */ -export interface ApplicationDiscoveryResponseTargetV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof ApplicationDiscoveryResponseTargetV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ApplicationDiscoveryResponseTargetV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ApplicationDiscoveryResponseTargetV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface ApplicationDiscoveryResponseV2025 - */ -export interface ApplicationDiscoveryResponseV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'id'?: string; - /** - * Type of task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'type'?: ApplicationDiscoveryResponseV2025TypeV2025; - /** - * Name of the task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'uniqueName'?: string; - /** - * Description of the app discovery aggregation - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'description'?: string; - /** - * Name of the parent of the task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'parentName'?: string | null; - /** - * Service to execute app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'launcher'?: string; - /** - * - * @type {ApplicationDiscoveryResponseTargetV2025} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'target'?: ApplicationDiscoveryResponseTargetV2025; - /** - * Creation date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'created'?: string; - /** - * Last modification date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'modified'?: string; - /** - * Launch date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'launched'?: string | null; - /** - * Completion date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'completed'?: string | null; - /** - * - * @type {TaskDefinitionSummaryV2025} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2025; - /** - * Completion status of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'completionStatus'?: ApplicationDiscoveryResponseV2025CompletionStatusV2025 | null; - /** - * Messages associated with the app discovery task - * @type {Array} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'messages'?: Array; - /** - * Return values associated with the app discovery task - * @type {Array} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'returns'?: Array; - /** - * Attributes of the app discovery task - * @type {{ [key: string]: any; }} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Current progress of aggregation - * @type {string} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'progress'?: string | null; - /** - * Current percentage completion of app discovery task - * @type {number} - * @memberof ApplicationDiscoveryResponseV2025 - */ - 'percentComplete'?: number; -} - -export const ApplicationDiscoveryResponseV2025TypeV2025 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type ApplicationDiscoveryResponseV2025TypeV2025 = typeof ApplicationDiscoveryResponseV2025TypeV2025[keyof typeof ApplicationDiscoveryResponseV2025TypeV2025]; -export const ApplicationDiscoveryResponseV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type ApplicationDiscoveryResponseV2025CompletionStatusV2025 = typeof ApplicationDiscoveryResponseV2025CompletionStatusV2025[keyof typeof ApplicationDiscoveryResponseV2025CompletionStatusV2025]; - -/** - * - * @export - * @interface ApplicationItemV2025 - */ -export interface ApplicationItemV2025 { - /** - * The unique identifier of the application. - * @type {number} - * @memberof ApplicationItemV2025 - */ - 'id'?: number; - /** - * The display name of the application. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'name'?: string | null; - /** - * A brief description of the application and its purpose. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'description'?: string | null; - /** - * The type of the application. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'type'?: string | null; - /** - * A list of tags associated with the application. - * @type {Array} - * @memberof ApplicationItemV2025 - */ - 'tags'?: Array | null; - /** - * The status of the last connection test performed on the application. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'testConnectionStatus'?: string | null; - /** - * The timestamp of the last connection test performed on the application, in milliseconds since epoch. - * @type {number} - * @memberof ApplicationItemV2025 - */ - 'testConnectionDate'?: number | null; - /** - * The identifier of the cluster used for crawling resources. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'rcClusterId'?: string | null; - /** - * The identifier of the cluster used for data classification. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'dcClusterId'?: string | null; - /** - * The identifier of the cluster used for permission collection. - * @type {string} - * @memberof ApplicationItemV2025 - */ - 'pcClusterId'?: string | null; -} -/** - * Specifies the type of application. Possible values: 1 - Sharepoint 8 - WindowsFileServer 9 - ActiveDirectory 11 - EmcCelerraCifs 15 - NetappCifs 20 - EmcIsilon 21 - GoogleDrive 24 - Box 25 - Dropbox 27 - OneDriveForBusiness 28 - SharepointOnline 29 - ExchangeOnline 33 - Cifs 35 - AwsS3 37 - Snowflake - * @export - * @enum {number} - */ - -export const ApplicationTypeV2025 = { - NUMBER_1: 1, - NUMBER_8: 8, - NUMBER_9: 9, - NUMBER_11: 11, - NUMBER_15: 15, - NUMBER_20: 20, - NUMBER_21: 21, - NUMBER_24: 24, - NUMBER_25: 25, - NUMBER_27: 27, - NUMBER_28: 28, - NUMBER_29: 29, - NUMBER_33: 33, - NUMBER_35: 35, - NUMBER_37: 37 -} as const; - -export type ApplicationTypeV2025 = typeof ApplicationTypeV2025[keyof typeof ApplicationTypeV2025]; - - -/** - * - * @export - * @interface Approval1V2025 - */ -export interface Approval1V2025 { - /** - * - * @type {Array} - * @memberof Approval1V2025 - */ - 'comments'?: Array; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Approval1V2025 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityIdentityV2025} - * @memberof Approval1V2025 - */ - 'owner'?: ActivityIdentityV2025; - /** - * The result of the approval - * @type {string} - * @memberof Approval1V2025 - */ - 'result'?: string; - /** - * - * @type {AttributeRequestV2025} - * @memberof Approval1V2025 - */ - 'attributeRequest'?: AttributeRequestV2025; - /** - * - * @type {AccountSourceV2025} - * @memberof Approval1V2025 - */ - 'source'?: AccountSourceV2025; -} -/** - * Criteria for approval - * @export - * @interface ApprovalApprovalCriteriaApprovalV2025 - */ -export interface ApprovalApprovalCriteriaApprovalV2025 { - /** - * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to approve - * @type {string} - * @memberof ApprovalApprovalCriteriaApprovalV2025 - */ - 'calculationType'?: ApprovalApprovalCriteriaApprovalV2025CalculationTypeV2025; - /** - * The value that needs to be met for the approval criteria - * @type {number} - * @memberof ApprovalApprovalCriteriaApprovalV2025 - */ - 'value'?: number; -} - -export const ApprovalApprovalCriteriaApprovalV2025CalculationTypeV2025 = { - Count: 'COUNT', - Percent: 'PERCENT' -} as const; - -export type ApprovalApprovalCriteriaApprovalV2025CalculationTypeV2025 = typeof ApprovalApprovalCriteriaApprovalV2025CalculationTypeV2025[keyof typeof ApprovalApprovalCriteriaApprovalV2025CalculationTypeV2025]; - -/** - * Criteria for rejection - * @export - * @interface ApprovalApprovalCriteriaRejectionV2025 - */ -export interface ApprovalApprovalCriteriaRejectionV2025 { - /** - * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to reject - * @type {string} - * @memberof ApprovalApprovalCriteriaRejectionV2025 - */ - 'calculationType'?: ApprovalApprovalCriteriaRejectionV2025CalculationTypeV2025; - /** - * The value that needs to be met for the rejection criteria - * @type {number} - * @memberof ApprovalApprovalCriteriaRejectionV2025 - */ - 'value'?: number; -} - -export const ApprovalApprovalCriteriaRejectionV2025CalculationTypeV2025 = { - Count: 'COUNT', - Percent: 'PERCENT' -} as const; - -export type ApprovalApprovalCriteriaRejectionV2025CalculationTypeV2025 = typeof ApprovalApprovalCriteriaRejectionV2025CalculationTypeV2025[keyof typeof ApprovalApprovalCriteriaRejectionV2025CalculationTypeV2025]; - -/** - * Criteria that needs to be met for an approval or rejection - * @export - * @interface ApprovalApprovalCriteriaV2025 - */ -export interface ApprovalApprovalCriteriaV2025 { - /** - * Type of approval criteria, such as SERIAL or PARALLEL - * @type {string} - * @memberof ApprovalApprovalCriteriaV2025 - */ - 'type'?: string; - /** - * - * @type {ApprovalApprovalCriteriaApprovalV2025} - * @memberof ApprovalApprovalCriteriaV2025 - */ - 'approval'?: ApprovalApprovalCriteriaApprovalV2025; - /** - * - * @type {ApprovalApprovalCriteriaRejectionV2025} - * @memberof ApprovalApprovalCriteriaV2025 - */ - 'rejection'?: ApprovalApprovalCriteriaRejectionV2025; -} -/** - * Approval Approve Request - * @export - * @interface ApprovalApproveRequestV2025 - */ -export interface ApprovalApproveRequestV2025 { - /** - * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. - * @type {{ [key: string]: string; }} - * @memberof ApprovalApproveRequestV2025 - */ - 'additionalAttributes'?: { [key: string]: string; }; - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalApproveRequestV2025 - */ - 'comment'?: string; -} -/** - * Approval Attributes Request - * @export - * @interface ApprovalAttributesRequestV2025 - */ -export interface ApprovalAttributesRequestV2025 { - /** - * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. - * @type {{ [key: string]: string; }} - * @memberof ApprovalAttributesRequestV2025 - */ - 'additionalAttributes'?: { [key: string]: string; }; - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalAttributesRequestV2025 - */ - 'comment'?: string; - /** - * List of attribute keys to be removed. - * @type {Array} - * @memberof ApprovalAttributesRequestV2025 - */ - 'removeAttributeKeys'?: Array; -} -/** - * Batch properties if an approval is sent via batching. - * @export - * @interface ApprovalBatchV2025 - */ -export interface ApprovalBatchV2025 { - /** - * ID of the batch - * @type {string} - * @memberof ApprovalBatchV2025 - */ - 'batchId'?: string; - /** - * How many approvals are going to be in this batch. Defaults to 1 if not provided. - * @type {number} - * @memberof ApprovalBatchV2025 - */ - 'batchSize'?: number; -} -/** - * Comments Object - * @export - * @interface ApprovalComment1V2025 - */ -export interface ApprovalComment1V2025 { - /** - * - * @type {ApprovalIdentityV2025} - * @memberof ApprovalComment1V2025 - */ - 'author'?: ApprovalIdentityV2025; - /** - * Comment to be left on an approval - * @type {string} - * @memberof ApprovalComment1V2025 - */ - 'comment'?: string; - /** - * Date the comment was created - * @type {string} - * @memberof ApprovalComment1V2025 - */ - 'createdDate'?: string; - /** - * ID of the comment - * @type {string} - * @memberof ApprovalComment1V2025 - */ - 'commentId'?: string; -} -/** - * - * @export - * @interface ApprovalComment2V2025 - */ -export interface ApprovalComment2V2025 { - /** - * The comment text - * @type {string} - * @memberof ApprovalComment2V2025 - */ - 'comment'?: string; - /** - * The name of the commenter - * @type {string} - * @memberof ApprovalComment2V2025 - */ - 'commenter'?: string; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ApprovalComment2V2025 - */ - 'date'?: string | null; -} -/** - * - * @export - * @interface ApprovalCommentV2025 - */ -export interface ApprovalCommentV2025 { - /** - * Comment provided either by the approval requester or the approver. - * @type {string} - * @memberof ApprovalCommentV2025 - */ - 'comment': string; - /** - * The time when this comment was provided. - * @type {string} - * @memberof ApprovalCommentV2025 - */ - 'timestamp': string; - /** - * Name of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2025 - */ - 'user': string; - /** - * Id of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2025 - */ - 'id': string; - /** - * Status transition of the draft. - * @type {string} - * @memberof ApprovalCommentV2025 - */ - 'changedToStatus': ApprovalCommentV2025ChangedToStatusV2025; -} - -export const ApprovalCommentV2025ChangedToStatusV2025 = { - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type ApprovalCommentV2025ChangedToStatusV2025 = typeof ApprovalCommentV2025ChangedToStatusV2025[keyof typeof ApprovalCommentV2025ChangedToStatusV2025]; - -/** - * - * @export - * @interface ApprovalCommentsRequestV2025 - */ -export interface ApprovalCommentsRequestV2025 { - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalCommentsRequestV2025 - */ - 'comment'?: string; -} -/** - * Timezone configuration for cron schedules. - * @export - * @interface ApprovalConfigCronTimezoneV2025 - */ -export interface ApprovalConfigCronTimezoneV2025 { - /** - * Timezone location for cron schedules. - * @type {string} - * @memberof ApprovalConfigCronTimezoneV2025 - */ - 'location'?: string; - /** - * Timezone offset for cron schedules. - * @type {string} - * @memberof ApprovalConfigCronTimezoneV2025 - */ - 'offset'?: string; -} -/** - * - * @export - * @interface ApprovalConfigEscalationConfigEscalationChainInnerV2025 - */ -export interface ApprovalConfigEscalationConfigEscalationChainInnerV2025 { - /** - * Starting at 1 defines the order in which the identities will get assigned - * @type {number} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2025 - */ - 'tier'?: number; - /** - * Optional Identity ID of the type of identity defined in the \'identityType\' field. - * @type {string} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2025 - */ - 'identityId'?: string; - /** - * Type of identityId in the escalation chain. - * @type {string} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2025 - */ - 'identityType'?: ApprovalConfigEscalationConfigEscalationChainInnerV2025IdentityTypeV2025; -} - -export const ApprovalConfigEscalationConfigEscalationChainInnerV2025IdentityTypeV2025 = { - Identity: 'IDENTITY', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER' -} as const; - -export type ApprovalConfigEscalationConfigEscalationChainInnerV2025IdentityTypeV2025 = typeof ApprovalConfigEscalationConfigEscalationChainInnerV2025IdentityTypeV2025[keyof typeof ApprovalConfigEscalationConfigEscalationChainInnerV2025IdentityTypeV2025]; - -/** - * Configuration for escalations. - * @export - * @interface ApprovalConfigEscalationConfigV2025 - */ -export interface ApprovalConfigEscalationConfigV2025 { - /** - * Indicates if escalations are enabled. - * @type {boolean} - * @memberof ApprovalConfigEscalationConfigV2025 - */ - 'enabled'?: boolean; - /** - * Number of days until the first escalation. - * @type {number} - * @memberof ApprovalConfigEscalationConfigV2025 - */ - 'daysUntilFirstEscalation'?: number; - /** - * Cron schedule for escalations. - * @type {string} - * @memberof ApprovalConfigEscalationConfigV2025 - */ - 'escalationCronSchedule'?: string; - /** - * Escalation chain configuration. - * @type {Array} - * @memberof ApprovalConfigEscalationConfigV2025 - */ - 'escalationChain'?: Array; -} -/** - * Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. - * @export - * @interface ApprovalConfigFallbackApproverV2025 - */ -export interface ApprovalConfigFallbackApproverV2025 { - /** - * Optional Identity ID of the type of identity defined in the \'type\' field. - * @type {string} - * @memberof ApprovalConfigFallbackApproverV2025 - */ - 'identityID'?: string; - /** - * Type of identityID for the fallback approver. - * @type {string} - * @memberof ApprovalConfigFallbackApproverV2025 - */ - 'type'?: ApprovalConfigFallbackApproverV2025TypeV2025; -} - -export const ApprovalConfigFallbackApproverV2025TypeV2025 = { - Identity: 'IDENTITY', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER' -} as const; - -export type ApprovalConfigFallbackApproverV2025TypeV2025 = typeof ApprovalConfigFallbackApproverV2025TypeV2025[keyof typeof ApprovalConfigFallbackApproverV2025TypeV2025]; - -/** - * Configuration for reminders. - * @export - * @interface ApprovalConfigReminderConfigV2025 - */ -export interface ApprovalConfigReminderConfigV2025 { - /** - * Indicates if reminders are enabled. - * @type {boolean} - * @memberof ApprovalConfigReminderConfigV2025 - */ - 'enabled'?: boolean; - /** - * Number of days until the first reminder. - * @type {number} - * @memberof ApprovalConfigReminderConfigV2025 - */ - 'daysUntilFirstReminder'?: number; - /** - * Cron schedule for reminders. - * @type {string} - * @memberof ApprovalConfigReminderConfigV2025 - */ - 'reminderCronSchedule'?: string; - /** - * Maximum number of reminders. Max is 20. - * @type {number} - * @memberof ApprovalConfigReminderConfigV2025 - */ - 'maxReminders'?: number; -} -/** - * - * @export - * @interface ApprovalConfigSerialChainInnerV2025 - */ -export interface ApprovalConfigSerialChainInnerV2025 { - /** - * Starting at 1 defines the order in which the identities will get assigned - * @type {number} - * @memberof ApprovalConfigSerialChainInnerV2025 - */ - 'tier'?: number; - /** - * Optional Identity ID of the type of identity defined in the \'identityType\' field. - * @type {string} - * @memberof ApprovalConfigSerialChainInnerV2025 - */ - 'identityId'?: string; - /** - * Type of identityId in the serial chain. - * @type {string} - * @memberof ApprovalConfigSerialChainInnerV2025 - */ - 'identityType'?: ApprovalConfigSerialChainInnerV2025IdentityTypeV2025; -} - -export const ApprovalConfigSerialChainInnerV2025IdentityTypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', - AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', - ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', - EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', - RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', - SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', - RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', - AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', - ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', - EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', - RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', - SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', - RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' -} as const; - -export type ApprovalConfigSerialChainInnerV2025IdentityTypeV2025 = typeof ApprovalConfigSerialChainInnerV2025IdentityTypeV2025[keyof typeof ApprovalConfigSerialChainInnerV2025IdentityTypeV2025]; - -/** - * TimeoutConfig contains configurations around when the approval request should expire. - * @export - * @interface ApprovalConfigTimeoutConfigV2025 - */ -export interface ApprovalConfigTimeoutConfigV2025 { - /** - * Indicates if timeout is enabled. - * @type {boolean} - * @memberof ApprovalConfigTimeoutConfigV2025 - */ - 'enabled'?: boolean; - /** - * Number of days until approval request times out. Max value is 90. - * @type {number} - * @memberof ApprovalConfigTimeoutConfigV2025 - */ - 'daysUntilTimeout'?: number; - /** - * Result of timeout. - * @type {string} - * @memberof ApprovalConfigTimeoutConfigV2025 - */ - 'timeoutResult'?: ApprovalConfigTimeoutConfigV2025TimeoutResultV2025; -} - -export const ApprovalConfigTimeoutConfigV2025TimeoutResultV2025 = { - Expired: 'EXPIRED', - Approved: 'APPROVED' -} as const; - -export type ApprovalConfigTimeoutConfigV2025TimeoutResultV2025 = typeof ApprovalConfigTimeoutConfigV2025TimeoutResultV2025[keyof typeof ApprovalConfigTimeoutConfigV2025TimeoutResultV2025]; - -/** - * Approval config Object - * @export - * @interface ApprovalConfigV2025 - */ -export interface ApprovalConfigV2025 { - /** - * - * @type {ApprovalConfigReminderConfigV2025} - * @memberof ApprovalConfigV2025 - */ - 'reminderConfig'?: ApprovalConfigReminderConfigV2025; - /** - * - * @type {ApprovalConfigEscalationConfigV2025} - * @memberof ApprovalConfigV2025 - */ - 'escalationConfig'?: ApprovalConfigEscalationConfigV2025; - /** - * - * @type {ApprovalConfigTimeoutConfigV2025} - * @memberof ApprovalConfigV2025 - */ - 'timeoutConfig'?: ApprovalConfigTimeoutConfigV2025; - /** - * - * @type {ApprovalConfigCronTimezoneV2025} - * @memberof ApprovalConfigV2025 - */ - 'cronTimezone'?: ApprovalConfigCronTimezoneV2025; - /** - * If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. - * @type {Array} - * @memberof ApprovalConfigV2025 - */ - 'serialChain'?: Array; - /** - * Determines whether a comment is required when approving or rejecting the approval request. - * @type {string} - * @memberof ApprovalConfigV2025 - */ - 'requiresComment'?: ApprovalConfigV2025RequiresCommentV2025; - /** - * - * @type {ApprovalConfigFallbackApproverV2025} - * @memberof ApprovalConfigV2025 - */ - 'fallbackApprover'?: ApprovalConfigFallbackApproverV2025; - /** - * Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. - * @type {string} - * @memberof ApprovalConfigV2025 - */ - 'machineIdentityManagerAssignment'?: ApprovalConfigV2025MachineIdentityManagerAssignmentV2025; - /** - * When true, all approvals will be created with the status \"PASSED\". - * @type {boolean} - * @memberof ApprovalConfigV2025 - */ - 'circumventApprovalProcess'?: boolean; - /** - * OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. - * @type {string} - * @memberof ApprovalConfigV2025 - */ - 'autoApprove'?: ApprovalConfigV2025AutoApproveV2025; -} - -export const ApprovalConfigV2025RequiresCommentV2025 = { - Approval: 'APPROVAL', - Rejection: 'REJECTION', - All: 'ALL', - Off: 'OFF' -} as const; - -export type ApprovalConfigV2025RequiresCommentV2025 = typeof ApprovalConfigV2025RequiresCommentV2025[keyof typeof ApprovalConfigV2025RequiresCommentV2025]; -export const ApprovalConfigV2025MachineIdentityManagerAssignmentV2025 = { - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - AccountOwner: 'ACCOUNT_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER' -} as const; - -export type ApprovalConfigV2025MachineIdentityManagerAssignmentV2025 = typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025[keyof typeof ApprovalConfigV2025MachineIdentityManagerAssignmentV2025]; -export const ApprovalConfigV2025AutoApproveV2025 = { - Off: 'OFF', - Direct: 'DIRECT', - Indirect: 'INDIRECT' -} as const; - -export type ApprovalConfigV2025AutoApproveV2025 = typeof ApprovalConfigV2025AutoApproveV2025[keyof typeof ApprovalConfigV2025AutoApproveV2025]; - -/** - * The description of what the approval is asking for - * @export - * @interface ApprovalDescriptionV2025 - */ -export interface ApprovalDescriptionV2025 { - /** - * The description of what the approval is asking for - * @type {string} - * @memberof ApprovalDescriptionV2025 - */ - 'value'?: string; - /** - * What locale the description of the approval is using - * @type {string} - * @memberof ApprovalDescriptionV2025 - */ - 'locale'?: string; -} -/** - * - * @export - * @interface ApprovalForwardHistoryV2025 - */ -export interface ApprovalForwardHistoryV2025 { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2025 - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2025 - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistoryV2025 - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2025 - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistoryV2025 - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentTypeV2025} - * @memberof ApprovalForwardHistoryV2025 - */ - 'reassignmentType'?: ReassignmentTypeV2025; -} - - -/** - * - * @export - * @interface ApprovalIdentityMembersInnerV2025 - */ -export interface ApprovalIdentityMembersInnerV2025 { - /** - * Email of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2025 - */ - 'email'?: string; - /** - * ID of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2025 - */ - 'id'?: string; - /** - * Name of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2025 - */ - 'name'?: string; - /** - * Type of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface ApprovalIdentityOwnerOfInnerV2025 - */ -export interface ApprovalIdentityOwnerOfInnerV2025 { - /** - * ID of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2025 - */ - 'id'?: string; - /** - * Name of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2025 - */ - 'name'?: string; - /** - * Type of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2025 - */ - 'type'?: string; -} -/** - * Identity Record Object - * @export - * @interface ApprovalIdentityRecordV2025 - */ -export interface ApprovalIdentityRecordV2025 { - /** - * Identity ID. - * @type {string} - * @memberof ApprovalIdentityRecordV2025 - */ - 'identityID'?: string; - /** - * Type of identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2025 - */ - 'type'?: ApprovalIdentityRecordV2025TypeV2025; - /** - * Name of the identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2025 - */ - 'name'?: string; - /** - * List of references representing actions taken by the identity. - * @type {Array} - * @memberof ApprovalIdentityRecordV2025 - */ - 'actionedAs'?: Array; - /** - * List of references representing members of the identity. - * @type {Array} - * @memberof ApprovalIdentityRecordV2025 - */ - 'members'?: Array; - /** - * Date when the decision was made. - * @type {string} - * @memberof ApprovalIdentityRecordV2025 - */ - 'decisionDate'?: string; - /** - * Email associated with the identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2025 - */ - 'email'?: string; -} - -export const ApprovalIdentityRecordV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalIdentityRecordV2025TypeV2025 = typeof ApprovalIdentityRecordV2025TypeV2025[keyof typeof ApprovalIdentityRecordV2025TypeV2025]; - -/** - * Approval Identity Object - * @export - * @interface ApprovalIdentityV2025 - */ -export interface ApprovalIdentityV2025 { - /** - * Email address. - * @type {string} - * @memberof ApprovalIdentityV2025 - */ - 'email'?: string; - /** - * Identity ID of the type of identity defined in the \'type\' field. - * @type {string} - * @memberof ApprovalIdentityV2025 - */ - 'identityID'?: string; - /** - * List of members of a governance group. Will be omitted if the identity is not a governance group. - * @type {Array} - * @memberof ApprovalIdentityV2025 - */ - 'members'?: Array; - /** - * Name of the identity. - * @type {string} - * @memberof ApprovalIdentityV2025 - */ - 'name'?: string; - /** - * List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. - * @type {Array} - * @memberof ApprovalIdentityV2025 - */ - 'ownerOf'?: Array; - /** - * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalIdentityV2025 - */ - 'serialOrder'?: number; - /** - * Type of identityID. - * @type {string} - * @memberof ApprovalIdentityV2025 - */ - 'type'?: ApprovalIdentityV2025TypeV2025; -} - -export const ApprovalIdentityV2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', - AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', - ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', - EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', - RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', - SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', - RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', - AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', - ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', - EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', - RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', - SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', - RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' -} as const; - -export type ApprovalIdentityV2025TypeV2025 = typeof ApprovalIdentityV2025TypeV2025[keyof typeof ApprovalIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface ApprovalInfoResponseV2025 - */ -export interface ApprovalInfoResponseV2025 { - /** - * the id of approver - * @type {string} - * @memberof ApprovalInfoResponseV2025 - */ - 'id'?: string; - /** - * the name of approver - * @type {string} - * @memberof ApprovalInfoResponseV2025 - */ - 'name'?: string; - /** - * the status of the approval request - * @type {string} - * @memberof ApprovalInfoResponseV2025 - */ - 'status'?: string; -} -/** - * - * @export - * @interface ApprovalItemDetailsV2025 - */ -export interface ApprovalItemDetailsV2025 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemDetailsV2025 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2025 & object} - * @memberof ApprovalItemDetailsV2025 - */ - 'state'?: WorkItemStateV2025 & object; -} -/** - * - * @export - * @interface ApprovalItemsV2025 - */ -export interface ApprovalItemsV2025 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemsV2025 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2025 & object} - * @memberof ApprovalItemsV2025 - */ - 'state'?: WorkItemStateV2025 & object; -} -/** - * Approval Name Object - * @export - * @interface ApprovalNameV2025 - */ -export interface ApprovalNameV2025 { - /** - * Name of the approval - * @type {string} - * @memberof ApprovalNameV2025 - */ - 'value'?: string; - /** - * What locale the name of the approval is using - * @type {string} - * @memberof ApprovalNameV2025 - */ - 'locale'?: string; -} -/** - * Request body for reassigning an approval request to another identity. This results in that identity being added as an authorized approver. - * @export - * @interface ApprovalReassignRequestV2025 - */ -export interface ApprovalReassignRequestV2025 { - /** - * Comment associated with the reassign request. - * @type {string} - * @memberof ApprovalReassignRequestV2025 - */ - 'comment'?: string; - /** - * Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user\'s identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. - * @type {string} - * @memberof ApprovalReassignRequestV2025 - */ - 'reassignFrom'?: string; - /** - * Identity to which the approval is being reassigned. - * @type {string} - * @memberof ApprovalReassignRequestV2025 - */ - 'reassignTo'?: string; -} -/** - * ReassignmentHistoryRecord holds a history record of reassignment and escalation actions for an approval request - * @export - * @interface ApprovalReassignmentHistoryV2025 - */ -export interface ApprovalReassignmentHistoryV2025 { - /** - * Unique identifier for the comment associated with the reassignment. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'commentID'?: string; - /** - * - * @type {ApprovalIdentityV2025} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'reassignedFrom'?: ApprovalIdentityV2025; - /** - * - * @type {ApprovalIdentityV2025} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'reassignedTo'?: ApprovalIdentityV2025; - /** - * - * @type {ApprovalIdentityV2025} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'reassigner'?: ApprovalIdentityV2025; - /** - * Date and time when the reassignment occurred. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'reassignmentDate'?: string; - /** - * Type of reassignment, such as escalation or manual reassignment. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2025 - */ - 'reassignmentType'?: ApprovalReassignmentHistoryV2025ReassignmentTypeV2025; -} - -export const ApprovalReassignmentHistoryV2025ReassignmentTypeV2025 = { - Escalation: 'ESCALATION', - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutoReassignment: 'AUTO_REASSIGNMENT' -} as const; - -export type ApprovalReassignmentHistoryV2025ReassignmentTypeV2025 = typeof ApprovalReassignmentHistoryV2025ReassignmentTypeV2025[keyof typeof ApprovalReassignmentHistoryV2025ReassignmentTypeV2025]; - -/** - * Reference objects related to the approval - * @export - * @interface ApprovalReferenceV2025 - */ -export interface ApprovalReferenceV2025 { - /** - * Id of the reference object - * @type {string} - * @memberof ApprovalReferenceV2025 - */ - 'id'?: string; - /** - * What reference object does this ID correspond to - * @type {string} - * @memberof ApprovalReferenceV2025 - */ - 'type'?: string; - /** - * Name of the reference object - * @type {string} - * @memberof ApprovalReferenceV2025 - */ - 'name'?: string; - /** - * Email associated with the reference object - * @type {string} - * @memberof ApprovalReferenceV2025 - */ - 'email'?: string; - /** - * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalReferenceV2025 - */ - 'serialOrder'?: number; -} -/** - * Request body for rejecting an approval request. - * @export - * @interface ApprovalRejectRequestV2025 - */ -export interface ApprovalRejectRequestV2025 { - /** - * Comment associated with the reject request. - * @type {string} - * @memberof ApprovalRejectRequestV2025 - */ - 'comment'?: string; -} -/** - * Configuration for approval reminder and escalation behavior. Important: Modifying this object will override the sp-approval service\'s reminderConfig and escalationConfig settings. Changes made here take precedence over any configuration set directly in the sp-approval service. - * @export - * @interface ApprovalReminderAndEscalationConfigV2025 - */ -export interface ApprovalReminderAndEscalationConfigV2025 { - /** - * Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2025 - */ - 'daysUntilEscalation'?: number | null; - /** - * Number of days to wait between reminder notifications. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2025 - */ - 'daysBetweenReminders'?: number | null; - /** - * Maximum number of reminder notifications to send to the reviewer before approval escalation. The maximum allowed value is 20. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfigV2025 - */ - 'maxReminders'?: number | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2025} - * @memberof ApprovalReminderAndEscalationConfigV2025 - */ - 'fallbackApproverRef'?: IdentityReferenceWithNameAndEmailV2025 | null; -} -/** - * Represents a requested target in an approval process, including details such as ID, name, reauthentication requirements, and removal date. - * @export - * @interface ApprovalRequestedTargetV2025 - */ -export interface ApprovalRequestedTargetV2025 { - /** - * Signature required for forced authentication. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'forcedAuthSignature'?: string; - /** - * ID of the requested target. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'id'?: string; - /** - * Name of the requested target. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'name'?: string; - /** - * Indicates if reauthentication is required. - * @type {boolean} - * @memberof ApprovalRequestedTargetV2025 - */ - 'reauthRequired'?: boolean; - /** - * Date when the target will be removed. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'removalDate'?: string; - /** - * Type of the request. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'requestType'?: string; - /** - * Type of the target. - * @type {string} - * @memberof ApprovalRequestedTargetV2025 - */ - 'targetType'?: string; -} -/** - * - * @export - * @interface ApprovalSchemeForRoleV2025 - */ -export interface ApprovalSchemeForRoleV2025 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof ApprovalSchemeForRoleV2025 - */ - 'approverType'?: ApprovalSchemeForRoleV2025ApproverTypeV2025; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof ApprovalSchemeForRoleV2025 - */ - 'approverId'?: string | null; -} - -export const ApprovalSchemeForRoleV2025ApproverTypeV2025 = { - Owner: 'OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeForRoleV2025ApproverTypeV2025 = typeof ApprovalSchemeForRoleV2025ApproverTypeV2025[keyof typeof ApprovalSchemeForRoleV2025ApproverTypeV2025]; - -/** - * Describes the individual or group that is responsible for an approval step. - * @export - * @enum {string} - */ - -export const ApprovalSchemeV2025 = { - AppOwner: 'APP_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - RoleOwner: 'ROLE_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeV2025 = typeof ApprovalSchemeV2025[keyof typeof ApprovalSchemeV2025]; - - -/** - * - * @export - * @interface ApprovalStatusDtoCurrentOwnerV2025 - */ -export interface ApprovalStatusDtoCurrentOwnerV2025 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2025 - */ - 'type'?: ApprovalStatusDtoCurrentOwnerV2025TypeV2025; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2025 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoCurrentOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoCurrentOwnerV2025TypeV2025 = typeof ApprovalStatusDtoCurrentOwnerV2025TypeV2025[keyof typeof ApprovalStatusDtoCurrentOwnerV2025TypeV2025]; - -/** - * Identity of orginal approval owner. - * @export - * @interface ApprovalStatusDtoOriginalOwnerV2025 - */ -export interface ApprovalStatusDtoOriginalOwnerV2025 { - /** - * DTO type of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2025 - */ - 'type'?: ApprovalStatusDtoOriginalOwnerV2025TypeV2025; - /** - * ID of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2025 - */ - 'id'?: string; - /** - * Display name of original approval owner. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2025 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoOriginalOwnerV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoOriginalOwnerV2025TypeV2025 = typeof ApprovalStatusDtoOriginalOwnerV2025TypeV2025[keyof typeof ApprovalStatusDtoOriginalOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface ApprovalStatusDtoV2025 - */ -export interface ApprovalStatusDtoV2025 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDtoV2025 - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwnerV2025} - * @memberof ApprovalStatusDtoV2025 - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwnerV2025; - /** - * - * @type {ApprovalStatusDtoCurrentOwnerV2025} - * @memberof ApprovalStatusDtoV2025 - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwnerV2025; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDtoV2025 - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemStateV2025} - * @memberof ApprovalStatusDtoV2025 - */ - 'status'?: ManualWorkItemStateV2025; - /** - * - * @type {ApprovalSchemeV2025} - * @memberof ApprovalStatusDtoV2025 - */ - 'scheme'?: ApprovalSchemeV2025; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDtoV2025 - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDtoV2025 - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDtoV2025 - */ - 'removeDate'?: string | null; -} - - -/** - * Enum representing the non-employee request approval status - * @export - * @enum {string} - */ - -export const ApprovalStatusV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Pending: 'PENDING', - NotReady: 'NOT_READY', - Cancelled: 'CANCELLED' -} as const; - -export type ApprovalStatusV2025 = typeof ApprovalStatusV2025[keyof typeof ApprovalStatusV2025]; - - -/** - * - * @export - * @interface ApprovalSummaryV2025 - */ -export interface ApprovalSummaryV2025 { - /** - * The number of pending access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2025 - */ - 'pending'?: number; - /** - * The number of approved access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2025 - */ - 'approved'?: number; - /** - * The number of rejected access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2025 - */ - 'rejected'?: number; -} -/** - * Approval Object - * @export - * @interface ApprovalV2025 - */ -export interface ApprovalV2025 { - /** - * The Approval ID - * @type {string} - * @memberof ApprovalV2025 - */ - 'id'?: string; - /** - * The Tenant ID of the Approval - * @type {string} - * @memberof ApprovalV2025 - */ - 'tenantId'?: string; - /** - * The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL - * @type {string} - * @memberof ApprovalV2025 - */ - 'type'?: string; - /** - * Object representation of an approver of an approval - * @type {Array} - * @memberof ApprovalV2025 - */ - 'approvers'?: Array; - /** - * Date the approval was created - * @type {string} - * @memberof ApprovalV2025 - */ - 'createdDate'?: string; - /** - * Date the approval is due - * @type {string} - * @memberof ApprovalV2025 - */ - 'dueDate'?: string; - /** - * Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. - * @type {string} - * @memberof ApprovalV2025 - */ - 'escalationStep'?: string; - /** - * The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalV2025 - */ - 'serialStep'?: number; - /** - * Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. - * @type {boolean} - * @memberof ApprovalV2025 - */ - 'isEscalated'?: boolean; - /** - * The name of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2025 - */ - 'name'?: Array; - /** - * The name of the approval for a given locale - * @type {ApprovalBatchV2025} - * @memberof ApprovalV2025 - */ - 'batchRequest'?: ApprovalBatchV2025; - /** - * The configuration of the approval, such as the approval criteria and whether it is a parallel or serial approval - * @type {ApprovalConfigV2025} - * @memberof ApprovalV2025 - */ - 'approvalConfig'?: ApprovalConfigV2025; - /** - * The description of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2025 - */ - 'description'?: Array; - /** - * Signifies what medium to use when sending notifications (currently only email is utilized) - * @type {string} - * @memberof ApprovalV2025 - */ - 'medium'?: ApprovalV2025MediumV2025; - /** - * The priority of the approval - * @type {string} - * @memberof ApprovalV2025 - */ - 'priority'?: ApprovalV2025PriorityV2025; - /** - * Object representation of the requester of the approval - * @type {ApprovalIdentityV2025} - * @memberof ApprovalV2025 - */ - 'requester'?: ApprovalIdentityV2025; - /** - * Object representation of the requestee of the approval - * @type {ApprovalIdentityV2025} - * @memberof ApprovalV2025 - */ - 'requestee'?: ApprovalIdentityV2025; - /** - * Object representation of a comment on the approval - * @type {Array} - * @memberof ApprovalV2025 - */ - 'comments'?: Array; - /** - * Array of approvers who have approved the approval - * @type {Array} - * @memberof ApprovalV2025 - */ - 'approvedBy'?: Array; - /** - * Array of approvers who have rejected the approval - * @type {Array} - * @memberof ApprovalV2025 - */ - 'rejectedBy'?: Array; - /** - * Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. - * @type {Array} - * @memberof ApprovalV2025 - */ - 'assignedTo'?: Array; - /** - * Date the approval was completed - * @type {string} - * @memberof ApprovalV2025 - */ - 'completedDate'?: string; - /** - * - * @type {ApprovalApprovalCriteriaV2025} - * @memberof ApprovalV2025 - */ - 'approvalCriteria'?: ApprovalApprovalCriteriaV2025; - /** - * Json string representing additional attributes known about the object to be approved. - * @type {string} - * @memberof ApprovalV2025 - */ - 'additionalAttributes'?: string; - /** - * Reference data related to the approval - * @type {Array} - * @memberof ApprovalV2025 - */ - 'referenceData'?: Array; - /** - * History of whom the approval request was assigned to - * @type {Array} - * @memberof ApprovalV2025 - */ - 'reassignmentHistory'?: Array; - /** - * Field that can include any static additional info that may be needed by the service that the approval request originated from - * @type {{ [key: string]: object; }} - * @memberof ApprovalV2025 - */ - 'staticAttributes'?: { [key: string]: object; }; - /** - * Date/time that the approval request was last updated - * @type {string} - * @memberof ApprovalV2025 - */ - 'modifiedDate'?: string; - /** - * RequestedTarget used to specify the actual object or target the approval request is for - * @type {Array} - * @memberof ApprovalV2025 - */ - 'requestedTarget'?: Array; -} - -export const ApprovalV2025MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type ApprovalV2025MediumV2025 = typeof ApprovalV2025MediumV2025[keyof typeof ApprovalV2025MediumV2025]; -export const ApprovalV2025PriorityV2025 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type ApprovalV2025PriorityV2025 = typeof ApprovalV2025PriorityV2025[keyof typeof ApprovalV2025PriorityV2025]; - -/** - * - * @export - * @interface ArgumentV2025 - */ -export interface ArgumentV2025 { - /** - * the name of the argument - * @type {string} - * @memberof ArgumentV2025 - */ - 'name': string; - /** - * the description of the argument - * @type {string} - * @memberof ArgumentV2025 - */ - 'description'?: string | null; - /** - * the programmatic type of the argument - * @type {string} - * @memberof ArgumentV2025 - */ - 'type'?: string | null; -} -/** - * - * @export - * @interface ArrayInner1V2025 - */ -export interface ArrayInner1V2025 { -} -/** - * - * @export - * @interface ArrayInnerV2025 - */ -export interface ArrayInnerV2025 { -} -/** - * - * @export - * @interface AssignResourceOwnerRequestV2025 - */ -export interface AssignResourceOwnerRequestV2025 { - /** - * The unique identifier of the application containing the resource. - * @type {number} - * @memberof AssignResourceOwnerRequestV2025 - */ - 'appId'?: number; - /** - * The full path to the resource within the application (e.g., file path or object path). - * @type {string} - * @memberof AssignResourceOwnerRequestV2025 - */ - 'fullPath'?: string | null; - /** - * The unique identifier (UUID) of the identity to be assigned as the resource owner. - * @type {string} - * @memberof AssignResourceOwnerRequestV2025 - */ - 'identityId'?: string; -} -/** - * - * @export - * @interface AssignmentContextDtoV2025 - */ -export interface AssignmentContextDtoV2025 { - /** - * - * @type {AccessRequestContextV2025} - * @memberof AssignmentContextDtoV2025 - */ - 'requested'?: AccessRequestContextV2025; - /** - * - * @type {Array} - * @memberof AssignmentContextDtoV2025 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof AssignmentContextDtoV2025 - */ - 'computedDate'?: string; -} -/** - * Specification of source attribute sync mapping configuration for an identity attribute - * @export - * @interface AttrSyncSourceAttributeConfigV2025 - */ -export interface AttrSyncSourceAttributeConfigV2025 { - /** - * Name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2025 - */ - 'name': string; - /** - * Display name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2025 - */ - 'displayName': string; - /** - * Determines whether or not the attribute is enabled for synchronization - * @type {boolean} - * @memberof AttrSyncSourceAttributeConfigV2025 - */ - 'enabled': boolean; - /** - * Name of the source account attribute to which the identity attribute value will be synchronized if enabled - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2025 - */ - 'target': string; -} -/** - * Specification of attribute sync configuration for a source - * @export - * @interface AttrSyncSourceConfigV2025 - */ -export interface AttrSyncSourceConfigV2025 { - /** - * - * @type {AttrSyncSourceV2025} - * @memberof AttrSyncSourceConfigV2025 - */ - 'source': AttrSyncSourceV2025; - /** - * Attribute synchronization configuration for specific identity attributes in the context of a source - * @type {Array} - * @memberof AttrSyncSourceConfigV2025 - */ - 'attributes': Array; -} -/** - * Target source for attribute synchronization. - * @export - * @interface AttrSyncSourceV2025 - */ -export interface AttrSyncSourceV2025 { - /** - * DTO type of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2025 - */ - 'type'?: AttrSyncSourceV2025TypeV2025; - /** - * ID of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2025 - */ - 'id'?: string; - /** - * Human-readable name of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2025 - */ - 'name'?: string | null; -} - -export const AttrSyncSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type AttrSyncSourceV2025TypeV2025 = typeof AttrSyncSourceV2025TypeV2025[keyof typeof AttrSyncSourceV2025TypeV2025]; - -/** - * - * @export - * @interface AttributeChangeV2025 - */ -export interface AttributeChangeV2025 { - /** - * the attribute name - * @type {string} - * @memberof AttributeChangeV2025 - */ - 'name'?: string; - /** - * the old value of attribute - * @type {string} - * @memberof AttributeChangeV2025 - */ - 'previousValue'?: string; - /** - * the new value of attribute - * @type {string} - * @memberof AttributeChangeV2025 - */ - 'newValue'?: string; -} -/** - * - * @export - * @interface AttributeDTOListV2025 - */ -export interface AttributeDTOListV2025 { - /** - * - * @type {Array} - * @memberof AttributeDTOListV2025 - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface AttributeDTOV2025 - */ -export interface AttributeDTOV2025 { - /** - * Technical name of the Attribute. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeDTOV2025 - */ - 'key'?: string; - /** - * The display name of the key. - * @type {string} - * @memberof AttributeDTOV2025 - */ - 'name'?: string; - /** - * Indicates whether the attribute can have multiple values. - * @type {boolean} - * @memberof AttributeDTOV2025 - */ - 'multiselect'?: boolean; - /** - * The status of the Attribute. - * @type {string} - * @memberof AttributeDTOV2025 - */ - 'status'?: string; - /** - * The type of the Attribute. This can be either \"custom\" or \"governance\". - * @type {string} - * @memberof AttributeDTOV2025 - */ - 'type'?: string; - /** - * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. - * @type {Array} - * @memberof AttributeDTOV2025 - */ - 'objectTypes'?: Array | null; - /** - * The description of the Attribute. - * @type {string} - * @memberof AttributeDTOV2025 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof AttributeDTOV2025 - */ - 'values'?: Array | null; -} -/** - * A reference to the schema on the source to the attribute values map to. - * @export - * @interface AttributeDefinitionSchemaV2025 - */ -export interface AttributeDefinitionSchemaV2025 { - /** - * The type of object being referenced - * @type {string} - * @memberof AttributeDefinitionSchemaV2025 - */ - 'type'?: AttributeDefinitionSchemaV2025TypeV2025; - /** - * The object ID this reference applies to. - * @type {string} - * @memberof AttributeDefinitionSchemaV2025 - */ - 'id'?: string; - /** - * The human-readable display name of the object. - * @type {string} - * @memberof AttributeDefinitionSchemaV2025 - */ - 'name'?: string; -} - -export const AttributeDefinitionSchemaV2025TypeV2025 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type AttributeDefinitionSchemaV2025TypeV2025 = typeof AttributeDefinitionSchemaV2025TypeV2025[keyof typeof AttributeDefinitionSchemaV2025TypeV2025]; - -/** - * The underlying type of the value which an AttributeDefinition represents. - * @export - * @enum {string} - */ - -export const AttributeDefinitionTypeV2025 = { - String: 'STRING', - Long: 'LONG', - Int: 'INT', - Boolean: 'BOOLEAN', - Date: 'DATE' -} as const; - -export type AttributeDefinitionTypeV2025 = typeof AttributeDefinitionTypeV2025[keyof typeof AttributeDefinitionTypeV2025]; - - -/** - * - * @export - * @interface AttributeDefinitionV2025 - */ -export interface AttributeDefinitionV2025 { - /** - * The name of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2025 - */ - 'name'?: string; - /** - * Attribute name in the native system. - * @type {string} - * @memberof AttributeDefinitionV2025 - */ - 'nativeName'?: string | null; - /** - * - * @type {AttributeDefinitionTypeV2025} - * @memberof AttributeDefinitionV2025 - */ - 'type'?: AttributeDefinitionTypeV2025; - /** - * - * @type {AttributeDefinitionSchemaV2025} - * @memberof AttributeDefinitionV2025 - */ - 'schema'?: AttributeDefinitionSchemaV2025 | null; - /** - * A human-readable description of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2025 - */ - 'description'?: string; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof AttributeDefinitionV2025 - */ - 'isMulti'?: boolean; - /** - * Flag indicating whether or not the attribute is an entitlement. - * @type {boolean} - * @memberof AttributeDefinitionV2025 - */ - 'isEntitlement'?: boolean; - /** - * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - * @type {boolean} - * @memberof AttributeDefinitionV2025 - */ - 'isGroup'?: boolean; -} - - -/** - * Targeted Entity - * @export - * @interface AttributeMappingsAllOfTargetV2025 - */ -export interface AttributeMappingsAllOfTargetV2025 { - /** - * The type of target entity - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2025 - */ - 'type'?: AttributeMappingsAllOfTargetV2025TypeV2025; - /** - * Name of the targeted attribute - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2025 - */ - 'attributeName'?: string; - /** - * The ID of Source - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2025 - */ - 'sourceId'?: string; -} - -export const AttributeMappingsAllOfTargetV2025TypeV2025 = { - Account: 'ACCOUNT', - Identity: 'IDENTITY', - OwnerAccount: 'OWNER_ACCOUNT', - OwnerIdentity: 'OWNER_IDENTITY' -} as const; - -export type AttributeMappingsAllOfTargetV2025TypeV2025 = typeof AttributeMappingsAllOfTargetV2025TypeV2025[keyof typeof AttributeMappingsAllOfTargetV2025TypeV2025]; - -/** - * Attibute Mapping Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025 { - /** - * The name of attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025 - */ - 'attributeName'?: string; - /** - * Name of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025 - */ - 'sourceName'?: string; - /** - * ID of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025 - */ - 'name'?: string; -} -/** - * Input Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2025 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2025 { - /** - * The Type of Attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2025 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2025 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2025; -} -/** - * attributes object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesV2025 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesV2025 { - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputV2025} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesV2025 - */ - 'input'?: AttributeMappingsAllOfTransformDefinitionAttributesInputV2025; -} -/** - * - * @export - * @interface AttributeMappingsAllOfTransformDefinitionV2025 - */ -export interface AttributeMappingsAllOfTransformDefinitionV2025 { - /** - * The type of transform - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2025 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesV2025} - * @memberof AttributeMappingsAllOfTransformDefinitionV2025 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesV2025; - /** - * Transform Operation - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2025 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AttributeMappingsV2025 - */ -export interface AttributeMappingsV2025 { - /** - * - * @type {AttributeMappingsAllOfTargetV2025} - * @memberof AttributeMappingsV2025 - */ - 'target'?: AttributeMappingsAllOfTargetV2025; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionV2025} - * @memberof AttributeMappingsV2025 - */ - 'transformDefinition'?: AttributeMappingsAllOfTransformDefinitionV2025; -} -/** - * - * @export - * @interface AttributeRequestV2025 - */ -export interface AttributeRequestV2025 { - /** - * Attribute name. - * @type {string} - * @memberof AttributeRequestV2025 - */ - 'name'?: string; - /** - * Operation to perform on attribute. - * @type {string} - * @memberof AttributeRequestV2025 - */ - 'op'?: string; - /** - * - * @type {AttributeRequestValueV2025} - * @memberof AttributeRequestV2025 - */ - 'value'?: AttributeRequestValueV2025; -} -/** - * @type AttributeRequestValueV2025 - * Value of attribute. - * @export - */ -export type AttributeRequestValueV2025 = Array | string; - -/** - * - * @export - * @interface AttributeValueDTOV2025 - */ -export interface AttributeValueDTOV2025 { - /** - * Technical name of the Attribute value. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeValueDTOV2025 - */ - 'value'?: string; - /** - * The display name of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2025 - */ - 'name'?: string; - /** - * The status of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2025 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AttributesChangedV2025 - */ -export interface AttributesChangedV2025 { - /** - * - * @type {Array} - * @memberof AttributesChangedV2025 - */ - 'attributeChanges': Array; - /** - * the event type - * @type {string} - * @memberof AttributesChangedV2025 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AttributesChangedV2025 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AttributesChangedV2025 - */ - 'dateTime'?: string; -} -/** - * Audit details for the reassignment configuration of an identity - * @export - * @interface AuditDetailsV2025 - */ -export interface AuditDetailsV2025 { - /** - * Initial date and time when the record was created - * @type {string} - * @memberof AuditDetailsV2025 - */ - 'created'?: string; - /** - * - * @type {Identity1V2025} - * @memberof AuditDetailsV2025 - */ - 'createdBy'?: Identity1V2025; - /** - * Last modified date and time for the record - * @type {string} - * @memberof AuditDetailsV2025 - */ - 'modified'?: string; - /** - * - * @type {Identity1V2025} - * @memberof AuditDetailsV2025 - */ - 'modifiedBy'?: Identity1V2025; -} -/** - * - * @export - * @interface AuthProfileSummaryV2025 - */ -export interface AuthProfileSummaryV2025 { - /** - * Tenant name. - * @type {string} - * @memberof AuthProfileSummaryV2025 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthProfileSummaryV2025 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AuthProfileV2025 - */ -export interface AuthProfileV2025 { - /** - * Authentication Profile name. - * @type {string} - * @memberof AuthProfileV2025 - */ - 'name'?: string; - /** - * Use it to block access from off network. - * @type {boolean} - * @memberof AuthProfileV2025 - */ - 'offNetwork'?: boolean; - /** - * Use it to block access from untrusted geoographies. - * @type {boolean} - * @memberof AuthProfileV2025 - */ - 'untrustedGeography'?: boolean; - /** - * Application ID. - * @type {string} - * @memberof AuthProfileV2025 - */ - 'applicationId'?: string | null; - /** - * Application name. - * @type {string} - * @memberof AuthProfileV2025 - */ - 'applicationName'?: string | null; - /** - * Type of the Authentication Profile. - * @type {string} - * @memberof AuthProfileV2025 - */ - 'type'?: AuthProfileV2025TypeV2025; - /** - * Use it to enable strong authentication. - * @type {boolean} - * @memberof AuthProfileV2025 - */ - 'strongAuthLogin'?: boolean; -} - -export const AuthProfileV2025TypeV2025 = { - Block: 'BLOCK', - Mfa: 'MFA', - NonPta: 'NON_PTA', - Pta: 'PTA' -} as const; - -export type AuthProfileV2025TypeV2025 = typeof AuthProfileV2025TypeV2025[keyof typeof AuthProfileV2025TypeV2025]; - -/** - * - * @export - * @interface AuthUserLevelsIdentityCountV2025 - */ -export interface AuthUserLevelsIdentityCountV2025 { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof AuthUserLevelsIdentityCountV2025 - */ - 'id'?: string; - /** - * Number of identities having this user level. - * @type {number} - * @memberof AuthUserLevelsIdentityCountV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface AuthUserSlimResponseV2025 - */ -export interface AuthUserSlimResponseV2025 { - /** - * Identity ID. - * @type {string} - * @memberof AuthUserSlimResponseV2025 - */ - 'id'?: string; - /** - * Identity unique identifier. - * @type {string} - * @memberof AuthUserSlimResponseV2025 - */ - 'uid'?: string; - /** - * Identity alias. - * @type {string} - * @memberof AuthUserSlimResponseV2025 - */ - 'alias'?: string; - /** - * Identity name in display format. - * @type {string} - * @memberof AuthUserSlimResponseV2025 - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface AuthUserV2025 - */ -export interface AuthUserV2025 { - /** - * Tenant name. - * @type {string} - * @memberof AuthUserV2025 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthUserV2025 - */ - 'id'?: string; - /** - * Identity\'s unique identitifier. - * @type {string} - * @memberof AuthUserV2025 - */ - 'uid'?: string; - /** - * ID of the auth profile associated with the auth user. - * @type {string} - * @memberof AuthUserV2025 - */ - 'profile'?: string; - /** - * Auth user\'s employee number. - * @type {string} - * @memberof AuthUserV2025 - */ - 'identificationNumber'?: string | null; - /** - * Auth user\'s email. - * @type {string} - * @memberof AuthUserV2025 - */ - 'email'?: string | null; - /** - * Auth user\'s phone number. - * @type {string} - * @memberof AuthUserV2025 - */ - 'phone'?: string | null; - /** - * Auth user\'s work phone number. - * @type {string} - * @memberof AuthUserV2025 - */ - 'workPhone'?: string | null; - /** - * Auth user\'s personal email. - * @type {string} - * @memberof AuthUserV2025 - */ - 'personalEmail'?: string | null; - /** - * Auth user\'s first name. - * @type {string} - * @memberof AuthUserV2025 - */ - 'firstname'?: string | null; - /** - * Auth user\'s last name. - * @type {string} - * @memberof AuthUserV2025 - */ - 'lastname'?: string | null; - /** - * Auth user\'s name in displayed format. - * @type {string} - * @memberof AuthUserV2025 - */ - 'displayName'?: string; - /** - * Auth user\'s alias. - * @type {string} - * @memberof AuthUserV2025 - */ - 'alias'?: string; - /** - * Date of last password change. - * @type {string} - * @memberof AuthUserV2025 - */ - 'lastPasswordChangeDate'?: string | null; - /** - * Timestamp of the last login (long type value). - * @type {number} - * @memberof AuthUserV2025 - */ - 'lastLoginTimestamp'?: number; - /** - * Timestamp of the current login (long type value). - * @type {number} - * @memberof AuthUserV2025 - */ - 'currentLoginTimestamp'?: number; - /** - * The date and time when the user was last unlocked. - * @type {string} - * @memberof AuthUserV2025 - */ - 'lastUnlockTimestamp'?: string | null; - /** - * Array of the auth user\'s capabilities. - * @type {Array} - * @memberof AuthUserV2025 - */ - 'capabilities'?: Array | null; -} - -export const AuthUserV2025CapabilitiesV2025 = { - CertAdmin: 'CERT_ADMIN', - CloudGovAdmin: 'CLOUD_GOV_ADMIN', - CloudGovUser: 'CLOUD_GOV_USER', - Helpdesk: 'HELPDESK', - OrgAdmin: 'ORG_ADMIN', - ReportAdmin: 'REPORT_ADMIN', - RoleAdmin: 'ROLE_ADMIN', - RoleSubadmin: 'ROLE_SUBADMIN', - SaasManagementAdmin: 'SAAS_MANAGEMENT_ADMIN', - SaasManagementReader: 'SAAS_MANAGEMENT_READER', - SourceAdmin: 'SOURCE_ADMIN', - SourceSubadmin: 'SOURCE_SUBADMIN', - DasUiAdministrator: 'das:ui-administrator', - DasUiComplianceManager: 'das:ui-compliance_manager', - DasUiAuditor: 'das:ui-auditor', - DasUiDataScope: 'das:ui-data-scope', - SpAicDashboardRead: 'sp:aic-dashboard-read', - SpAicDashboardWrite: 'sp:aic-dashboard-write', - SpUiConfigHubAdmin: 'sp:ui-config-hub-admin', - SpUiConfigHubBackupAdmin: 'sp:ui-config-hub-backup-admin', - SpUiConfigHubRead: 'sp:ui-config-hub-read' -} as const; - -export type AuthUserV2025CapabilitiesV2025 = typeof AuthUserV2025CapabilitiesV2025[keyof typeof AuthUserV2025CapabilitiesV2025]; - -/** - * Authorization scheme supported by the transmitter. - * @export - * @interface AuthorizationSchemeV2025 - */ -export interface AuthorizationSchemeV2025 { - /** - * URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`. - * @type {string} - * @memberof AuthorizationSchemeV2025 - */ - 'spec_urn'?: string; -} -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptions1V2025 - */ -export interface BackupOptions1V2025 { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptions1V2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNamesV2025; }} - * @memberof BackupOptions1V2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNamesV2025; }; -} - -export const BackupOptions1V2025IncludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptions1V2025IncludeTypesV2025 = typeof BackupOptions1V2025IncludeTypesV2025[keyof typeof BackupOptions1V2025IncludeTypesV2025]; - -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptionsV2025 - */ -export interface BackupOptionsV2025 { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptionsV2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNamesV2025; }} - * @memberof BackupOptionsV2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNamesV2025; }; -} - -export const BackupOptionsV2025IncludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptionsV2025IncludeTypesV2025 = typeof BackupOptionsV2025IncludeTypesV2025[keyof typeof BackupOptionsV2025IncludeTypesV2025]; - -/** - * - * @export - * @interface BackupResponse1V2025 - */ -export interface BackupResponse1V2025 { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'status'?: BackupResponse1V2025StatusV2025; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'type'?: BackupResponse1V2025TypeV2025; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponse1V2025 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponse1V2025 - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponse1V2025 - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'backupType'?: BackupResponse1V2025BackupTypeV2025; - /** - * - * @type {BackupOptions1V2025} - * @memberof BackupResponse1V2025 - */ - 'options'?: BackupOptions1V2025 | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'hydrationStatus'?: BackupResponse1V2025HydrationStatusV2025; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponse1V2025 - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponse1V2025 - */ - 'cloudStorageStatus'?: BackupResponse1V2025CloudStorageStatusV2025; -} - -export const BackupResponse1V2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponse1V2025StatusV2025 = typeof BackupResponse1V2025StatusV2025[keyof typeof BackupResponse1V2025StatusV2025]; -export const BackupResponse1V2025TypeV2025 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponse1V2025TypeV2025 = typeof BackupResponse1V2025TypeV2025[keyof typeof BackupResponse1V2025TypeV2025]; -export const BackupResponse1V2025BackupTypeV2025 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponse1V2025BackupTypeV2025 = typeof BackupResponse1V2025BackupTypeV2025[keyof typeof BackupResponse1V2025BackupTypeV2025]; -export const BackupResponse1V2025HydrationStatusV2025 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponse1V2025HydrationStatusV2025 = typeof BackupResponse1V2025HydrationStatusV2025[keyof typeof BackupResponse1V2025HydrationStatusV2025]; -export const BackupResponse1V2025CloudStorageStatusV2025 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponse1V2025CloudStorageStatusV2025 = typeof BackupResponse1V2025CloudStorageStatusV2025[keyof typeof BackupResponse1V2025CloudStorageStatusV2025]; - -/** - * - * @export - * @interface BackupResponseV2025 - */ -export interface BackupResponseV2025 { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'status'?: BackupResponseV2025StatusV2025; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'type'?: BackupResponseV2025TypeV2025; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponseV2025 - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponseV2025 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponseV2025 - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponseV2025 - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'backupType'?: BackupResponseV2025BackupTypeV2025; - /** - * - * @type {BackupOptionsV2025} - * @memberof BackupResponseV2025 - */ - 'options'?: BackupOptionsV2025 | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'hydrationStatus'?: BackupResponseV2025HydrationStatusV2025; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponseV2025 - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponseV2025 - */ - 'cloudStorageStatus'?: BackupResponseV2025CloudStorageStatusV2025; -} - -export const BackupResponseV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponseV2025StatusV2025 = typeof BackupResponseV2025StatusV2025[keyof typeof BackupResponseV2025StatusV2025]; -export const BackupResponseV2025TypeV2025 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponseV2025TypeV2025 = typeof BackupResponseV2025TypeV2025[keyof typeof BackupResponseV2025TypeV2025]; -export const BackupResponseV2025BackupTypeV2025 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponseV2025BackupTypeV2025 = typeof BackupResponseV2025BackupTypeV2025[keyof typeof BackupResponseV2025BackupTypeV2025]; -export const BackupResponseV2025HydrationStatusV2025 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponseV2025HydrationStatusV2025 = typeof BackupResponseV2025HydrationStatusV2025[keyof typeof BackupResponseV2025HydrationStatusV2025]; -export const BackupResponseV2025CloudStorageStatusV2025 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponseV2025CloudStorageStatusV2025 = typeof BackupResponseV2025CloudStorageStatusV2025[keyof typeof BackupResponseV2025CloudStorageStatusV2025]; - -/** - * - * @export - * @interface Base64DecodeV2025 - */ -export interface Base64DecodeV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64DecodeV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64DecodeV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Base64EncodeV2025 - */ -export interface Base64EncodeV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64EncodeV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64EncodeV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Owner\'s identity. - * @export - * @interface BaseAccessOwnerV2025 - */ -export interface BaseAccessOwnerV2025 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof BaseAccessOwnerV2025 - */ - 'type'?: BaseAccessOwnerV2025TypeV2025; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof BaseAccessOwnerV2025 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof BaseAccessOwnerV2025 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof BaseAccessOwnerV2025 - */ - 'email'?: string; -} - -export const BaseAccessOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type BaseAccessOwnerV2025TypeV2025 = typeof BaseAccessOwnerV2025TypeV2025[keyof typeof BaseAccessOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface BaseAccessProfileV2025 - */ -export interface BaseAccessProfileV2025 { - /** - * Access profile\'s unique ID. - * @type {string} - * @memberof BaseAccessProfileV2025 - */ - 'id'?: string; - /** - * Access profile\'s display name. - * @type {string} - * @memberof BaseAccessProfileV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseAccessV2025 - */ -export interface BaseAccessV2025 { - /** - * Access item\'s description. - * @type {string} - * @memberof BaseAccessV2025 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccessV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof BaseAccessV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof BaseAccessV2025 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof BaseAccessV2025 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof BaseAccessV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof BaseAccessV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2025} - * @memberof BaseAccessV2025 - */ - 'owner'?: BaseAccessOwnerV2025; -} -/** - * - * @export - * @interface BaseAccountV2025 - */ -export interface BaseAccountV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof BaseAccountV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseAccountV2025 - */ - 'name'?: string; - /** - * Account ID. - * @type {string} - * @memberof BaseAccountV2025 - */ - 'accountId'?: string; - /** - * - * @type {AccountSourceV2025} - * @memberof BaseAccountV2025 - */ - 'source'?: AccountSourceV2025; - /** - * Indicates whether the account is disabled. - * @type {boolean} - * @memberof BaseAccountV2025 - */ - 'disabled'?: boolean; - /** - * Indicates whether the account is locked. - * @type {boolean} - * @memberof BaseAccountV2025 - */ - 'locked'?: boolean; - /** - * Indicates whether the account is privileged. - * @type {boolean} - * @memberof BaseAccountV2025 - */ - 'privileged'?: boolean; - /** - * Indicates whether the account has been manually correlated to an identity. - * @type {boolean} - * @memberof BaseAccountV2025 - */ - 'manuallyCorrelated'?: boolean; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof BaseAccountV2025 - */ - 'passwordLastSet'?: string | null; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2025 - */ - 'entitlementAttributes'?: { [key: string]: any; } | null; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccountV2025 - */ - 'created'?: string | null; - /** - * Indicates whether the account supports password change. - * @type {boolean} - * @memberof BaseAccountV2025 - */ - 'supportsPasswordChange'?: boolean; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2025 - */ - 'accountAttributes'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface BaseCommonDtoV2025 - */ -export interface BaseCommonDtoV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDtoV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDtoV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDtoV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDtoV2025 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseCreateApplicationRequestV2025 - */ -export interface BaseCreateApplicationRequestV2025 { - /** - * - * @type {ApplicationTypeV2025} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'applicationType': ApplicationTypeV2025; - /** - * The display name of the application. - * @type {string} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'name': string; - /** - * A brief description of the application and its purpose. - * @type {string} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'description'?: string | null; - /** - * A list of tags to categorize or identify the application. - * @type {Array} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'tags'?: Array | null; - /** - * The unique identifier for the identity collector associated with this application. - * @type {number} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'identityCollectorId'?: number | null; - /** - * The unique identifier for the AD identity collector. - * @type {number} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'adIdentityCollectorId'?: number | null; - /** - * The unique identifier for the NIS identity collector. - * @type {number} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'nisIdentityCollectorId'?: number | null; - /** - * - * @type {ApplicationCrawlerSettingsV2025} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'applicationCrawlerSettings'?: ApplicationCrawlerSettingsV2025; - /** - * - * @type {PermissionCollectorSettingsV2025} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'permissionCollectorSettings'?: PermissionCollectorSettingsV2025; - /** - * - * @type {DataClassificationSettingsV2025} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'dataClassificationSettings'?: DataClassificationSettingsV2025; - /** - * - * @type {ActivityConfigurationSettingsV2025} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'activityConfigurationSettings'?: ActivityConfigurationSettingsV2025; - /** - * If true, the application setup will be executed immediately after creation. - * @type {boolean} - * @memberof BaseCreateApplicationRequestV2025 - */ - 'executeNow'?: boolean; -} - - -/** - * - * @export - * @interface BaseDocumentV2025 - */ -export interface BaseDocumentV2025 { - /** - * ID of the referenced object. - * @type {string} - * @memberof BaseDocumentV2025 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseDocumentV2025 - */ - 'name': string; -} -/** - * - * @export - * @interface BaseEntitlementV2025 - */ -export interface BaseEntitlementV2025 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof BaseEntitlementV2025 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof BaseEntitlementV2025 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof BaseEntitlementV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseReferenceDtoV2025 - */ -export interface BaseReferenceDtoV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof BaseReferenceDtoV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface BaseSegmentV2025 - */ -export interface BaseSegmentV2025 { - /** - * Segment\'s unique ID. - * @type {string} - * @memberof BaseSegmentV2025 - */ - 'id'?: string; - /** - * Segment\'s display name. - * @type {string} - * @memberof BaseSegmentV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseSettingsV2025 - */ -export interface BaseSettingsV2025 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof BaseSettingsV2025 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof BaseSettingsV2025 - */ - 'clusterId'?: string | null; -} -/** - * Config required if BASIC_AUTH is used. - * @export - * @interface BasicAuthConfigV2025 - */ -export interface BasicAuthConfigV2025 { - /** - * The username to authenticate. - * @type {string} - * @memberof BasicAuthConfigV2025 - */ - 'userName'?: string; - /** - * The password to authenticate. On response, this field is set to null as to not return secrets. - * @type {string} - * @memberof BasicAuthConfigV2025 - */ - 'password'?: string | null; -} -/** - * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. - * @export - * @interface BearerTokenAuthConfigV2025 - */ -export interface BearerTokenAuthConfigV2025 { - /** - * Bearer token - * @type {string} - * @memberof BearerTokenAuthConfigV2025 - */ - 'bearerToken'?: string | null; -} -/** - * Before Provisioning Rule. - * @export - * @interface BeforeProvisioningRuleDtoV2025 - */ -export interface BeforeProvisioningRuleDtoV2025 { - /** - * Before Provisioning Rule DTO type. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2025 - */ - 'type'?: BeforeProvisioningRuleDtoV2025TypeV2025; - /** - * Before Provisioning Rule ID. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2025 - */ - 'id'?: string; - /** - * Rule display name. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2025 - */ - 'name'?: string; -} - -export const BeforeProvisioningRuleDtoV2025TypeV2025 = { - Rule: 'RULE' -} as const; - -export type BeforeProvisioningRuleDtoV2025TypeV2025 = typeof BeforeProvisioningRuleDtoV2025TypeV2025[keyof typeof BeforeProvisioningRuleDtoV2025TypeV2025]; - -/** - * - * @export - * @interface BoundV2025 - */ -export interface BoundV2025 { - /** - * The value of the range\'s endpoint. - * @type {string} - * @memberof BoundV2025 - */ - 'value': string; - /** - * Indicates if the endpoint is included in the range. - * @type {boolean} - * @memberof BoundV2025 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface BrandingItemCreateV2025 - */ -export interface BrandingItemCreateV2025 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'name': string; - /** - * product name - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'productName': string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'actionButtonColor'?: string; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'activeLinkColor'?: string; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'navigationColor'?: string; - /** - * email from address - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'emailFromAddress'?: string; - /** - * login information message - * @type {string} - * @memberof BrandingItemCreateV2025 - */ - 'loginInformationalMessage'?: string; - /** - * png file with logo - * @type {File} - * @memberof BrandingItemCreateV2025 - */ - 'fileStandard'?: File; -} -/** - * - * @export - * @interface BrandingItemV2025 - */ -export interface BrandingItemV2025 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemV2025 - */ - 'name'?: string; - /** - * product name - * @type {string} - * @memberof BrandingItemV2025 - */ - 'productName'?: string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemV2025 - */ - 'actionButtonColor'?: string | null; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemV2025 - */ - 'activeLinkColor'?: string | null; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemV2025 - */ - 'navigationColor'?: string | null; - /** - * email from address - * @type {string} - * @memberof BrandingItemV2025 - */ - 'emailFromAddress'?: string | null; - /** - * url to standard logo - * @type {string} - * @memberof BrandingItemV2025 - */ - 'standardLogoURL'?: string | null; - /** - * login information message - * @type {string} - * @memberof BrandingItemV2025 - */ - 'loginInformationalMessage'?: string | null; -} -/** - * The bucket to group the results of the aggregation query by. - * @export - * @interface BucketAggregationV2025 - */ -export interface BucketAggregationV2025 { - /** - * The name of the bucket aggregate to be included in the result. - * @type {string} - * @memberof BucketAggregationV2025 - */ - 'name': string; - /** - * - * @type {BucketTypeV2025} - * @memberof BucketAggregationV2025 - */ - 'type'?: BucketTypeV2025; - /** - * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof BucketAggregationV2025 - */ - 'field': string; - /** - * Maximum number of buckets to include. - * @type {number} - * @memberof BucketAggregationV2025 - */ - 'size'?: number; - /** - * Minimum number of documents a bucket should have. - * @type {number} - * @memberof BucketAggregationV2025 - */ - 'minDocCount'?: number; -} - - -/** - * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const BucketTypeV2025 = { - Terms: 'TERMS' -} as const; - -export type BucketTypeV2025 = typeof BucketTypeV2025[keyof typeof BucketTypeV2025]; - - -/** - * - * @export - * @interface BulkAddTaggedObjectV2025 - */ -export interface BulkAddTaggedObjectV2025 { - /** - * - * @type {Array} - * @memberof BulkAddTaggedObjectV2025 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkAddTaggedObjectV2025 - */ - 'tags'?: Array; - /** - * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - * @type {string} - * @memberof BulkAddTaggedObjectV2025 - */ - 'operation'?: BulkAddTaggedObjectV2025OperationV2025; -} - -export const BulkAddTaggedObjectV2025OperationV2025 = { - Append: 'APPEND', - Merge: 'MERGE' -} as const; - -export type BulkAddTaggedObjectV2025OperationV2025 = typeof BulkAddTaggedObjectV2025OperationV2025[keyof typeof BulkAddTaggedObjectV2025OperationV2025]; - -/** - * Request body payload for bulk approve access request endpoint. - * @export - * @interface BulkApproveAccessRequestV2025 - */ -export interface BulkApproveAccessRequestV2025 { - /** - * List of approval ids to approve the pending requests - * @type {Array} - * @memberof BulkApproveAccessRequestV2025 - */ - 'approvalIds': Array; - /** - * Reason for approving the pending access request. - * @type {string} - * @memberof BulkApproveAccessRequestV2025 - */ - 'comment': string; -} -/** - * BulkApproveRequestDTO is the input struct that represents the request body required to facilitate a bulk approval action for a set of generic approval requests. - * @export - * @interface BulkApproveRequestDTOV2025 - */ -export interface BulkApproveRequestDTOV2025 { - /** - * Array of Approval IDs to be bulk approved - * @type {Array} - * @memberof BulkApproveRequestDTOV2025 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk approval request - * @type {string} - * @memberof BulkApproveRequestDTOV2025 - */ - 'comment'?: string; - /** - * Additional attributes to include with the bulk approval request - * @type {{ [key: string]: object; }} - * @memberof BulkApproveRequestDTOV2025 - */ - 'additionalAttributes'?: { [key: string]: object; }; -} -/** - * Request body payload for bulk cancel access request endpoint. - * @export - * @interface BulkCancelAccessRequestV2025 - */ -export interface BulkCancelAccessRequestV2025 { - /** - * List of access requests ids to cancel the pending requests - * @type {Array} - * @memberof BulkCancelAccessRequestV2025 - */ - 'accessRequestIds': Array; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof BulkCancelAccessRequestV2025 - */ - 'comment': string; -} -/** - * BulkCancelRequestDTO is the input struct that represents the request body required to facilitate a bulk cancellation action for a set of generic approval requests. - * @export - * @interface BulkCancelRequestDTOV2025 - */ -export interface BulkCancelRequestDTOV2025 { - /** - * Array of Approval IDs to be bulk cancelled - * @type {Array} - * @memberof BulkCancelRequestDTOV2025 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk cancellation request - * @type {string} - * @memberof BulkCancelRequestDTOV2025 - */ - 'comment'?: string; -} -/** - * Bulk response object. - * @export - * @interface BulkIdentitiesAccountsResponseV2025 - */ -export interface BulkIdentitiesAccountsResponseV2025 { - /** - * Identifier of bulk request item. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2025 - */ - 'id'?: string; - /** - * Response status value. - * @type {number} - * @memberof BulkIdentitiesAccountsResponseV2025 - */ - 'statusCode'?: number; - /** - * Status containing additional context information about failures. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2025 - */ - 'message'?: string; -} -/** - * BulkReassignRequestDTO is the input struct that represents the request body required to facilitate a bulk reassignment action for a set of generic approval requests. - * @export - * @interface BulkReassignRequestDTOV2025 - */ -export interface BulkReassignRequestDTOV2025 { - /** - * Array of Approval IDs to be bulk reassigned - * @type {Array} - * @memberof BulkReassignRequestDTOV2025 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk reassignment request - * @type {string} - * @memberof BulkReassignRequestDTOV2025 - */ - 'comment'?: string; - /** - * Identity ID from which the approval requests are being reassigned - * @type {string} - * @memberof BulkReassignRequestDTOV2025 - */ - 'reassignFrom'?: string; - /** - * ReassignTo signifies the Identity ID that the approval request is being reassigned to - * @type {string} - * @memberof BulkReassignRequestDTOV2025 - */ - 'reassignTo'?: string; -} -/** - * BulkRejectRequestDTO is the input struct that represents the request body required to facilitate a bulk reject action for a set of generic approval requests. - * @export - * @interface BulkRejectRequestDTOV2025 - */ -export interface BulkRejectRequestDTOV2025 { - /** - * Array of Approval IDs to be bulk rejected - * @type {Array} - * @memberof BulkRejectRequestDTOV2025 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk reject request - * @type {string} - * @memberof BulkRejectRequestDTOV2025 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface BulkRemoveTaggedObjectV2025 - */ -export interface BulkRemoveTaggedObjectV2025 { - /** - * - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2025 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2025 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface BulkTaggedObjectResponseV2025 - */ -export interface BulkTaggedObjectResponseV2025 { - /** - * - * @type {Array} - * @memberof BulkTaggedObjectResponseV2025 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkTaggedObjectResponseV2025 - */ - 'tags'?: Array; -} -/** - * Specifies the type of business service or resource. Possible values include: 0 - Folder 1 - Computer 2 - Container 3 - Domain 4 - Group / GPO 5 - OrganizationalUnit 6 - User 7 - Document 8 - List / WindowsFileServer / SharepointOnline 9 - ListItem 10 - Site 11 - Unknown / DropboxUser 12 - WSSFolder 13 - Web 14 - ExchangeFolder 15 - Mailbox 16 - PublicFolder 18 - UserSAMAccountName 24 - (reserved) 25 - GroupPolicyContainer 30 - File 801 - WindowsClusterServerName 908 - GoogleFolder 909 - GoogleUser 910 - DropboxFolder 912 - BoxFolder 913 - BoxUser 914 - BoxFile 950 - WSSFile 951 - HiddenList 952 - HiddenWSSFolder 953 - HiddenWSSFile 1000 - BuiltinDomain 1100 - DfsNamespace 1101 - DfsLink 1200 - SqlServerInstance 1201 - SqlServerDatabase 1202 - SqlServerSchema 1203 - SqlServerTable 1204 - SqlServerView 1205 - SqlServerStoredProcedure 1206 - SqlServerFunction 1207 - SqlServerAssemblie 1208 - SqlServerType 1209 - SqlServerDatabaseRole 1210 - SqlServerDatabaseUser 1211 - SqlServerApplicationRole 1212 - SqlServerLogin 1213 - SqlServerServerRole 1214 - SqlServerVirtualContainer 1215 - SqlServerSynonym 1216 - SqlServerExtendedStoredProcedure 1300 - AwsS3Root 1301 - AwsS3OU 1302 - AwsS3Account 1303 - AwsS3Bucket 1304 - AwsS3Folder 1305 - AwsS3File 1400 - SnowflakeDatabase 1401 - SnowflakeSchema 1402 - SnowflakeTable 1403 - SnowflakeView 1404 - SnowflakeFunction 1405 - SnowflakeProcedure 1406 - SnowflakeVirtualContainer 1407 - SnowflakeDatabaseApplication 1408 - SnowflakeDatabaseApplicationPackage 1409 - SnowflakeDatabasePersonal 1410 - SnowflakeDatabaseImported 1411 - SnowflakeViewMaterialized - * @export - * @enum {number} - */ - -export const BusinessServiceTypeV2025 = { - NUMBER_0: 0, - NUMBER_1: 1, - NUMBER_2: 2, - NUMBER_3: 3, - NUMBER_4: 4, - NUMBER_5: 5, - NUMBER_6: 6, - NUMBER_7: 7, - NUMBER_8: 8, - NUMBER_9: 9, - NUMBER_10: 10, - NUMBER_11: 11, - NUMBER_12: 12, - NUMBER_13: 13, - NUMBER_14: 14, - NUMBER_15: 15, - NUMBER_16: 16, - NUMBER_18: 18, - NUMBER_24: 24, - NUMBER_25: 25, - NUMBER_30: 30, - NUMBER_801: 801, - NUMBER_908: 908, - NUMBER_909: 909, - NUMBER_910: 910, - NUMBER_912: 912, - NUMBER_913: 913, - NUMBER_914: 914, - NUMBER_950: 950, - NUMBER_951: 951, - NUMBER_952: 952, - NUMBER_953: 953, - NUMBER_1000: 1000, - NUMBER_1100: 1100, - NUMBER_1101: 1101, - NUMBER_1200: 1200, - NUMBER_1201: 1201, - NUMBER_1202: 1202, - NUMBER_1203: 1203, - NUMBER_1204: 1204, - NUMBER_1205: 1205, - NUMBER_1206: 1206, - NUMBER_1207: 1207, - NUMBER_1208: 1208, - NUMBER_1209: 1209, - NUMBER_1210: 1210, - NUMBER_1211: 1211, - NUMBER_1212: 1212, - NUMBER_1213: 1213, - NUMBER_1214: 1214, - NUMBER_1215: 1215, - NUMBER_1216: 1216, - NUMBER_1300: 1300, - NUMBER_1301: 1301, - NUMBER_1302: 1302, - NUMBER_1303: 1303, - NUMBER_1304: 1304, - NUMBER_1305: 1305, - NUMBER_1400: 1400, - NUMBER_1401: 1401, - NUMBER_1402: 1402, - NUMBER_1403: 1403, - NUMBER_1404: 1404, - NUMBER_1405: 1405, - NUMBER_1406: 1406, - NUMBER_1407: 1407, - NUMBER_1408: 1408, - NUMBER_1409: 1409, - NUMBER_1410: 1410, - NUMBER_1411: 1411 -} as const; - -export type BusinessServiceTypeV2025 = typeof BusinessServiceTypeV2025[keyof typeof BusinessServiceTypeV2025]; - - -/** - * Details of the identity that owns the campaign. - * @export - * @interface CampaignActivatedCampaignCampaignOwnerV2025 - */ -export interface CampaignActivatedCampaignCampaignOwnerV2025 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2025 - */ - 'id': string; - /** - * The human friendly name of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2025 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2025 - */ - 'email': string; -} -/** - * Details about the certification campaign that was activated. - * @export - * @interface CampaignActivatedCampaignV2025 - */ -export interface CampaignActivatedCampaignV2025 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignActivatedCampaignV2025 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2025 - */ - 'type': CampaignActivatedCampaignV2025TypeV2025; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2025} - * @memberof CampaignActivatedCampaignV2025 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2025; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2025 - */ - 'status': CampaignActivatedCampaignV2025StatusV2025; -} - -export const CampaignActivatedCampaignV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignActivatedCampaignV2025TypeV2025 = typeof CampaignActivatedCampaignV2025TypeV2025[keyof typeof CampaignActivatedCampaignV2025TypeV2025]; -export const CampaignActivatedCampaignV2025StatusV2025 = { - Active: 'ACTIVE' -} as const; - -export type CampaignActivatedCampaignV2025StatusV2025 = typeof CampaignActivatedCampaignV2025StatusV2025[keyof typeof CampaignActivatedCampaignV2025StatusV2025]; - -/** - * - * @export - * @interface CampaignActivatedV2025 - */ -export interface CampaignActivatedV2025 { - /** - * - * @type {CampaignActivatedCampaignV2025} - * @memberof CampaignActivatedV2025 - */ - 'campaign': CampaignActivatedCampaignV2025; -} -/** - * - * @export - * @interface CampaignAlertV2025 - */ -export interface CampaignAlertV2025 { - /** - * Denotes the level of the message - * @type {string} - * @memberof CampaignAlertV2025 - */ - 'level'?: CampaignAlertV2025LevelV2025; - /** - * - * @type {Array} - * @memberof CampaignAlertV2025 - */ - 'localizations'?: Array; -} - -export const CampaignAlertV2025LevelV2025 = { - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO' -} as const; - -export type CampaignAlertV2025LevelV2025 = typeof CampaignAlertV2025LevelV2025[keyof typeof CampaignAlertV2025LevelV2025]; - -/** - * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - * @export - * @interface CampaignAllOfFilterV2025 - */ -export interface CampaignAllOfFilterV2025 { - /** - * The ID of whatever type of filter is being used. - * @type {string} - * @memberof CampaignAllOfFilterV2025 - */ - 'id'?: string; - /** - * Type of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2025 - */ - 'type'?: CampaignAllOfFilterV2025TypeV2025; - /** - * Name of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2025 - */ - 'name'?: string; -} - -export const CampaignAllOfFilterV2025TypeV2025 = { - CampaignFilter: 'CAMPAIGN_FILTER' -} as const; - -export type CampaignAllOfFilterV2025TypeV2025 = typeof CampaignAllOfFilterV2025TypeV2025[keyof typeof CampaignAllOfFilterV2025TypeV2025]; - -/** - * Must be set only if the campaign type is MACHINE_ACCOUNT. - * @export - * @interface CampaignAllOfMachineAccountCampaignInfoV2025 - */ -export interface CampaignAllOfMachineAccountCampaignInfoV2025 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2025 - */ - 'sourceIds'?: Array; - /** - * The reviewer\'s type. - * @type {string} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2025 - */ - 'reviewerType'?: CampaignAllOfMachineAccountCampaignInfoV2025ReviewerTypeV2025; -} - -export const CampaignAllOfMachineAccountCampaignInfoV2025ReviewerTypeV2025 = { - AccountOwner: 'ACCOUNT_OWNER' -} as const; - -export type CampaignAllOfMachineAccountCampaignInfoV2025ReviewerTypeV2025 = typeof CampaignAllOfMachineAccountCampaignInfoV2025ReviewerTypeV2025[keyof typeof CampaignAllOfMachineAccountCampaignInfoV2025ReviewerTypeV2025]; - -/** - * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025 { - /** - * Legal Remediator Type - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025 - */ - 'type': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025TypeV2025; - /** - * The ID of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025 - */ - 'id': string; - /** - * The name of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025TypeV2025 = typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025TypeV2025[keyof typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025TypeV2025]; - -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 - */ - 'type'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2025TypeV2025; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoReviewerV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoReviewerV2025TypeV2025 = typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2025TypeV2025[keyof typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2025TypeV2025]; - -/** - * Optional configuration options for role composition campaigns. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoV2025 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoV2025 { - /** - * The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - * @deprecated - */ - 'reviewerId'?: string | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoReviewerV2025} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - */ - 'reviewer'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2025 | null; - /** - * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {Array} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - */ - 'roleIds'?: Array; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - */ - 'remediatorRef': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2025; - /** - * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - */ - 'query'?: string | null; - /** - * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2025 - */ - 'description'?: string | null; -} -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfSearchCampaignInfoReviewerV2025 - */ -export interface CampaignAllOfSearchCampaignInfoReviewerV2025 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2025 - */ - 'type'?: CampaignAllOfSearchCampaignInfoReviewerV2025TypeV2025; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2025 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2025 - */ - 'name'?: string | null; -} - -export const CampaignAllOfSearchCampaignInfoReviewerV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfSearchCampaignInfoReviewerV2025TypeV2025 = typeof CampaignAllOfSearchCampaignInfoReviewerV2025TypeV2025[keyof typeof CampaignAllOfSearchCampaignInfoReviewerV2025TypeV2025]; - -/** - * Must be set only if the campaign type is SEARCH. - * @export - * @interface CampaignAllOfSearchCampaignInfoV2025 - */ -export interface CampaignAllOfSearchCampaignInfoV2025 { - /** - * The type of search campaign represented. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'type': CampaignAllOfSearchCampaignInfoV2025TypeV2025; - /** - * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'description'?: string; - /** - * - * @type {CampaignAllOfSearchCampaignInfoReviewerV2025} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'reviewer'?: CampaignAllOfSearchCampaignInfoReviewerV2025 | null; - /** - * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'query'?: string | null; - /** - * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'identityIds'?: Array | null; - /** - * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2025 - */ - 'accessConstraints'?: Array; -} - -export const CampaignAllOfSearchCampaignInfoV2025TypeV2025 = { - Identity: 'IDENTITY', - Access: 'ACCESS' -} as const; - -export type CampaignAllOfSearchCampaignInfoV2025TypeV2025 = typeof CampaignAllOfSearchCampaignInfoV2025TypeV2025[keyof typeof CampaignAllOfSearchCampaignInfoV2025TypeV2025]; - -/** - * Must be set only if the campaign type is SOURCE_OWNER. - * @export - * @interface CampaignAllOfSourceOwnerCampaignInfoV2025 - */ -export interface CampaignAllOfSourceOwnerCampaignInfoV2025 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfSourceOwnerCampaignInfoV2025 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface CampaignAllOfSourcesWithOrphanEntitlementsV2025 - */ -export interface CampaignAllOfSourcesWithOrphanEntitlementsV2025 { - /** - * Id of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2025 - */ - 'id'?: string; - /** - * Type - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2025 - */ - 'type'?: CampaignAllOfSourcesWithOrphanEntitlementsV2025TypeV2025; - /** - * Name of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2025 - */ - 'name'?: string; -} - -export const CampaignAllOfSourcesWithOrphanEntitlementsV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type CampaignAllOfSourcesWithOrphanEntitlementsV2025TypeV2025 = typeof CampaignAllOfSourcesWithOrphanEntitlementsV2025TypeV2025[keyof typeof CampaignAllOfSourcesWithOrphanEntitlementsV2025TypeV2025]; - -/** - * - * @export - * @interface CampaignCompleteOptionsV2025 - */ -export interface CampaignCompleteOptionsV2025 { - /** - * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - * @type {string} - * @memberof CampaignCompleteOptionsV2025 - */ - 'autoCompleteAction'?: CampaignCompleteOptionsV2025AutoCompleteActionV2025; -} - -export const CampaignCompleteOptionsV2025AutoCompleteActionV2025 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CampaignCompleteOptionsV2025AutoCompleteActionV2025 = typeof CampaignCompleteOptionsV2025AutoCompleteActionV2025[keyof typeof CampaignCompleteOptionsV2025AutoCompleteActionV2025]; - -/** - * Details about the certification campaign that ended. - * @export - * @interface CampaignEndedCampaignV2025 - */ -export interface CampaignEndedCampaignV2025 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignEndedCampaignV2025 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2025 - */ - 'type': CampaignEndedCampaignV2025TypeV2025; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2025} - * @memberof CampaignEndedCampaignV2025 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2025; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2025 - */ - 'status': CampaignEndedCampaignV2025StatusV2025; -} - -export const CampaignEndedCampaignV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignEndedCampaignV2025TypeV2025 = typeof CampaignEndedCampaignV2025TypeV2025[keyof typeof CampaignEndedCampaignV2025TypeV2025]; -export const CampaignEndedCampaignV2025StatusV2025 = { - Completed: 'COMPLETED' -} as const; - -export type CampaignEndedCampaignV2025StatusV2025 = typeof CampaignEndedCampaignV2025StatusV2025[keyof typeof CampaignEndedCampaignV2025StatusV2025]; - -/** - * - * @export - * @interface CampaignEndedV2025 - */ -export interface CampaignEndedV2025 { - /** - * - * @type {CampaignEndedCampaignV2025} - * @memberof CampaignEndedV2025 - */ - 'campaign': CampaignEndedCampaignV2025; -} -/** - * - * @export - * @interface CampaignFilterDetailsCriteriaListInnerV2025 - */ -export interface CampaignFilterDetailsCriteriaListInnerV2025 { - /** - * - * @type {CriteriaTypeV2025} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'type': CriteriaTypeV2025; - /** - * - * @type {OperationV2025} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'operation'?: OperationV2025 | null; - /** - * Specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'property': string | null; - /** - * Value for the specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'value': string | null; - /** - * If true, the filter will negate the result of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'negateResult'?: boolean; - /** - * If true, the filter will short circuit the evaluation of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'shortCircuit'?: boolean; - /** - * If true, the filter will record child matches for the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'recordChildMatches'?: boolean; - /** - * The unique ID of the criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'id'?: string | null; - /** - * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'suppressMatchedItems'?: boolean; - /** - * List of child criteria. - * @type {Array} - * @memberof CampaignFilterDetailsCriteriaListInnerV2025 - */ - 'children'?: Array; -} - - -/** - * Campaign Filter Details - * @export - * @interface CampaignFilterDetailsV2025 - */ -export interface CampaignFilterDetailsV2025 { - /** - * The unique ID of the campaign filter - * @type {string} - * @memberof CampaignFilterDetailsV2025 - */ - 'id': string; - /** - * Campaign filter name. - * @type {string} - * @memberof CampaignFilterDetailsV2025 - */ - 'name': string; - /** - * Campaign filter description. - * @type {string} - * @memberof CampaignFilterDetailsV2025 - */ - 'description'?: string; - /** - * Owner of the filter. This field automatically populates at creation time with the current user. - * @type {string} - * @memberof CampaignFilterDetailsV2025 - */ - 'owner': string | null; - /** - * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. - * @type {string} - * @memberof CampaignFilterDetailsV2025 - */ - 'mode': CampaignFilterDetailsV2025ModeV2025; - /** - * List of criteria. - * @type {Array} - * @memberof CampaignFilterDetailsV2025 - */ - 'criteriaList'?: Array; - /** - * If true, the filter is created by the system. If false, the filter is created by a user. - * @type {boolean} - * @memberof CampaignFilterDetailsV2025 - */ - 'isSystemFilter': boolean; -} - -export const CampaignFilterDetailsV2025ModeV2025 = { - Inclusion: 'INCLUSION', - Exclusion: 'EXCLUSION' -} as const; - -export type CampaignFilterDetailsV2025ModeV2025 = typeof CampaignFilterDetailsV2025ModeV2025[keyof typeof CampaignFilterDetailsV2025ModeV2025]; - -/** - * The identity that owns the campaign. - * @export - * @interface CampaignGeneratedCampaignCampaignOwnerV2025 - */ -export interface CampaignGeneratedCampaignCampaignOwnerV2025 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2025 - */ - 'id': string; - /** - * The display name of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2025 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2025 - */ - 'email': string; -} -/** - * Details about the campaign that was generated. - * @export - * @interface CampaignGeneratedCampaignV2025 - */ -export interface CampaignGeneratedCampaignV2025 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'id': string; - /** - * Human friendly name of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'modified'?: string | null; - /** - * The date and time when the campaign must be finished by. - * @type {string} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'deadline'?: string | null; - /** - * The type of campaign that was generated. - * @type {object} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'type': CampaignGeneratedCampaignV2025TypeV2025; - /** - * - * @type {CampaignGeneratedCampaignCampaignOwnerV2025} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'campaignOwner': CampaignGeneratedCampaignCampaignOwnerV2025; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignGeneratedCampaignV2025 - */ - 'status': CampaignGeneratedCampaignV2025StatusV2025; -} - -export const CampaignGeneratedCampaignV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignGeneratedCampaignV2025TypeV2025 = typeof CampaignGeneratedCampaignV2025TypeV2025[keyof typeof CampaignGeneratedCampaignV2025TypeV2025]; -export const CampaignGeneratedCampaignV2025StatusV2025 = { - Staged: 'STAGED', - Activating: 'ACTIVATING', - Active: 'ACTIVE' -} as const; - -export type CampaignGeneratedCampaignV2025StatusV2025 = typeof CampaignGeneratedCampaignV2025StatusV2025[keyof typeof CampaignGeneratedCampaignV2025StatusV2025]; - -/** - * - * @export - * @interface CampaignGeneratedV2025 - */ -export interface CampaignGeneratedV2025 { - /** - * - * @type {CampaignGeneratedCampaignV2025} - * @memberof CampaignGeneratedV2025 - */ - 'campaign': CampaignGeneratedCampaignV2025; -} -/** - * - * @export - * @interface CampaignReferenceV2025 - */ -export interface CampaignReferenceV2025 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'id': string; - /** - * The name of the campaign. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'name': string; - /** - * The type of object that is being referenced. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'type': CampaignReferenceV2025TypeV2025; - /** - * The type of the campaign. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'campaignType': CampaignReferenceV2025CampaignTypeV2025; - /** - * The description of the campaign set by the admin who created it. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'description': string | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'correlatedStatus': CampaignReferenceV2025CorrelatedStatusV2025; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignReferenceV2025 - */ - 'mandatoryCommentRequirement': CampaignReferenceV2025MandatoryCommentRequirementV2025; -} - -export const CampaignReferenceV2025TypeV2025 = { - Campaign: 'CAMPAIGN' -} as const; - -export type CampaignReferenceV2025TypeV2025 = typeof CampaignReferenceV2025TypeV2025[keyof typeof CampaignReferenceV2025TypeV2025]; -export const CampaignReferenceV2025CampaignTypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignReferenceV2025CampaignTypeV2025 = typeof CampaignReferenceV2025CampaignTypeV2025[keyof typeof CampaignReferenceV2025CampaignTypeV2025]; -export const CampaignReferenceV2025CorrelatedStatusV2025 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignReferenceV2025CorrelatedStatusV2025 = typeof CampaignReferenceV2025CorrelatedStatusV2025[keyof typeof CampaignReferenceV2025CorrelatedStatusV2025]; -export const CampaignReferenceV2025MandatoryCommentRequirementV2025 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignReferenceV2025MandatoryCommentRequirementV2025 = typeof CampaignReferenceV2025MandatoryCommentRequirementV2025[keyof typeof CampaignReferenceV2025MandatoryCommentRequirementV2025]; - -/** - * - * @export - * @interface CampaignReportV2025 - */ -export interface CampaignReportV2025 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof CampaignReportV2025 - */ - 'type'?: CampaignReportV2025TypeV2025; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof CampaignReportV2025 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof CampaignReportV2025 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof CampaignReportV2025 - */ - 'status'?: CampaignReportV2025StatusV2025; - /** - * - * @type {ReportTypeV2025} - * @memberof CampaignReportV2025 - */ - 'reportType': ReportTypeV2025; - /** - * The most recent date and time this report was run - * @type {string} - * @memberof CampaignReportV2025 - */ - 'lastRunAt'?: string; -} - -export const CampaignReportV2025TypeV2025 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type CampaignReportV2025TypeV2025 = typeof CampaignReportV2025TypeV2025[keyof typeof CampaignReportV2025TypeV2025]; -export const CampaignReportV2025StatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type CampaignReportV2025StatusV2025 = typeof CampaignReportV2025StatusV2025[keyof typeof CampaignReportV2025StatusV2025]; - -/** - * - * @export - * @interface CampaignReportsConfigV2025 - */ -export interface CampaignReportsConfigV2025 { - /** - * list of identity attribute columns - * @type {Array} - * @memberof CampaignReportsConfigV2025 - */ - 'identityAttributeColumns'?: Array | null; -} -/** - * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. - * @export - * @interface CampaignTemplateOwnerRefV2025 - */ -export interface CampaignTemplateOwnerRefV2025 { - /** - * Id of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2025 - */ - 'id'?: string; - /** - * Type of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2025 - */ - 'type'?: CampaignTemplateOwnerRefV2025TypeV2025; - /** - * Name of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2025 - */ - 'name'?: string; - /** - * Email of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2025 - */ - 'email'?: string; -} - -export const CampaignTemplateOwnerRefV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignTemplateOwnerRefV2025TypeV2025 = typeof CampaignTemplateOwnerRefV2025TypeV2025[keyof typeof CampaignTemplateOwnerRefV2025TypeV2025]; - -/** - * Campaign Template - * @export - * @interface CampaignTemplateV2025 - */ -export interface CampaignTemplateV2025 { - /** - * Id of the campaign template - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'id'?: string; - /** - * This template\'s name. Has no bearing on generated campaigns\' names. - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'name': string; - /** - * This template\'s description. Has no bearing on generated campaigns\' descriptions. - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'description': string; - /** - * Creation date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'created': string; - /** - * Modification date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'modified': string | null; - /** - * Indicates if this campaign template has been scheduled. - * @type {boolean} - * @memberof CampaignTemplateV2025 - */ - 'scheduled'?: boolean; - /** - * - * @type {CampaignTemplateOwnerRefV2025} - * @memberof CampaignTemplateV2025 - */ - 'ownerRef'?: CampaignTemplateOwnerRefV2025; - /** - * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). - * @type {string} - * @memberof CampaignTemplateV2025 - */ - 'deadlineDuration'?: string | null; - /** - * - * @type {CampaignV2025} - * @memberof CampaignTemplateV2025 - */ - 'campaign': CampaignV2025; -} -/** - * - * @export - * @interface CampaignV2025 - */ -export interface CampaignV2025 { - /** - * Id of the campaign - * @type {string} - * @memberof CampaignV2025 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2025 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2025 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof CampaignV2025 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof CampaignV2025 - */ - 'type': CampaignV2025TypeV2025; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof CampaignV2025 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof CampaignV2025 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof CampaignV2025 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof CampaignV2025 - */ - 'status'?: CampaignV2025StatusV2025 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignV2025 - */ - 'correlatedStatus'?: CampaignV2025CorrelatedStatusV2025; - /** - * Created time of the campaign - * @type {string} - * @memberof CampaignV2025 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof CampaignV2025 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof CampaignV2025 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof CampaignV2025 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof CampaignV2025 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2025} - * @memberof CampaignV2025 - */ - 'filter'?: CampaignAllOfFilterV2025 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof CampaignV2025 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2025} - * @memberof CampaignV2025 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2025} - * @memberof CampaignV2025 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2025} - * @memberof CampaignV2025 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2025} - * @memberof CampaignV2025 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2025 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof CampaignV2025 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignV2025 - */ - 'mandatoryCommentRequirement'?: CampaignV2025MandatoryCommentRequirementV2025; -} - -export const CampaignV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignV2025TypeV2025 = typeof CampaignV2025TypeV2025[keyof typeof CampaignV2025TypeV2025]; -export const CampaignV2025StatusV2025 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type CampaignV2025StatusV2025 = typeof CampaignV2025StatusV2025[keyof typeof CampaignV2025StatusV2025]; -export const CampaignV2025CorrelatedStatusV2025 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignV2025CorrelatedStatusV2025 = typeof CampaignV2025CorrelatedStatusV2025[keyof typeof CampaignV2025CorrelatedStatusV2025]; -export const CampaignV2025MandatoryCommentRequirementV2025 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignV2025MandatoryCommentRequirementV2025 = typeof CampaignV2025MandatoryCommentRequirementV2025[keyof typeof CampaignV2025MandatoryCommentRequirementV2025]; - -/** - * - * @export - * @interface CampaignsDeleteRequestV2025 - */ -export interface CampaignsDeleteRequestV2025 { - /** - * The ids of the campaigns to delete - * @type {Array} - * @memberof CampaignsDeleteRequestV2025 - */ - 'ids'?: Array; -} -/** - * Request body payload for cancel access request endpoint. - * @export - * @interface CancelAccessRequestV2025 - */ -export interface CancelAccessRequestV2025 { - /** - * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - * @type {string} - * @memberof CancelAccessRequestV2025 - */ - 'accountActivityId': string; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof CancelAccessRequestV2025 - */ - 'comment': string; -} -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetailsV2025 - */ -export interface CancelledRequestDetailsV2025 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2025 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2025} - * @memberof CancelledRequestDetailsV2025 - */ - 'owner'?: OwnerDtoV2025; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2025 - */ - 'modified'?: string; -} -/** - * The decision to approve or revoke the review item - * @export - * @enum {string} - */ - -export const CertificationDecisionV2025 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CertificationDecisionV2025 = typeof CertificationDecisionV2025[keyof typeof CertificationDecisionV2025]; - - -/** - * - * @export - * @interface CertificationDtoV2025 - */ -export interface CertificationDtoV2025 { - /** - * - * @type {CampaignReferenceV2025} - * @memberof CertificationDtoV2025 - */ - 'campaignRef': CampaignReferenceV2025; - /** - * - * @type {CertificationPhaseV2025} - * @memberof CertificationDtoV2025 - */ - 'phase': CertificationPhaseV2025; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationDtoV2025 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationDtoV2025 - */ - 'signed': string; - /** - * - * @type {ReviewerV2025} - * @memberof CertificationDtoV2025 - */ - 'reviewer': ReviewerV2025; - /** - * - * @type {ReassignmentV2025} - * @memberof CertificationDtoV2025 - */ - 'reassignment'?: ReassignmentV2025 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationDtoV2025 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationDtoV2025 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationDtoV2025 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationDtoV2025 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationDtoV2025 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationDtoV2025 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationDtoV2025 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationIdentitySummaryV2025 - */ -export interface CertificationIdentitySummaryV2025 { - /** - * The ID of the identity summary - * @type {string} - * @memberof CertificationIdentitySummaryV2025 - */ - 'id'?: string; - /** - * Name of the linked identity - * @type {string} - * @memberof CertificationIdentitySummaryV2025 - */ - 'name'?: string; - /** - * The ID of the identity being certified - * @type {string} - * @memberof CertificationIdentitySummaryV2025 - */ - 'identityId'?: string; - /** - * Indicates whether the review items for the linked identity\'s certification have been completed - * @type {boolean} - * @memberof CertificationIdentitySummaryV2025 - */ - 'completed'?: boolean; -} -/** - * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - * @export - * @enum {string} - */ - -export const CertificationPhaseV2025 = { - Staged: 'STAGED', - Active: 'ACTIVE', - Signed: 'SIGNED' -} as const; - -export type CertificationPhaseV2025 = typeof CertificationPhaseV2025[keyof typeof CertificationPhaseV2025]; - - -/** - * - * @export - * @interface CertificationReferenceV2025 - */ -export interface CertificationReferenceV2025 { - /** - * The id of the certification. - * @type {string} - * @memberof CertificationReferenceV2025 - */ - 'id'?: string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationReferenceV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof CertificationReferenceV2025 - */ - 'type'?: CertificationReferenceV2025TypeV2025; - /** - * - * @type {ReviewerV2025} - * @memberof CertificationReferenceV2025 - */ - 'reviewer'?: ReviewerV2025; -} - -export const CertificationReferenceV2025TypeV2025 = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceV2025TypeV2025 = typeof CertificationReferenceV2025TypeV2025[keyof typeof CertificationReferenceV2025TypeV2025]; - -/** - * The certification campaign that was signed off on. - * @export - * @interface CertificationSignedOffCertificationV2025 - */ -export interface CertificationSignedOffCertificationV2025 { - /** - * Unique ID of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'id': string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'name': string; - /** - * The date and time the certification was created. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'created': string; - /** - * The date and time the certification was last modified. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignReferenceV2025} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'campaignRef': CampaignReferenceV2025; - /** - * - * @type {CertificationPhaseV2025} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'phase': CertificationPhaseV2025; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'signed': string; - /** - * - * @type {ReviewerV2025} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'reviewer': ReviewerV2025; - /** - * - * @type {ReassignmentV2025} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'reassignment'?: ReassignmentV2025 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2025 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationSignedOffV2025 - */ -export interface CertificationSignedOffV2025 { - /** - * - * @type {CertificationSignedOffCertificationV2025} - * @memberof CertificationSignedOffV2025 - */ - 'certification': CertificationSignedOffCertificationV2025; -} -/** - * - * @export - * @interface CertificationTaskV2025 - */ -export interface CertificationTaskV2025 { - /** - * The ID of the certification task. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'id'?: string; - /** - * The type of the certification task. More values may be added in the future. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'type'?: CertificationTaskV2025TypeV2025; - /** - * The type of item that is being operated on by this task whose ID is stored in the targetId field. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'targetType'?: CertificationTaskV2025TargetTypeV2025; - /** - * The ID of the item being operated on by this task. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'targetId'?: string; - /** - * The status of the task. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'status'?: CertificationTaskV2025StatusV2025; - /** - * List of error messages - * @type {Array} - * @memberof CertificationTaskV2025 - */ - 'errors'?: Array; - /** - * Reassignment trails that lead to self certification identity - * @type {Array} - * @memberof CertificationTaskV2025 - */ - 'reassignmentTrailDTOs'?: Array; - /** - * The date and time on which this task was created. - * @type {string} - * @memberof CertificationTaskV2025 - */ - 'created'?: string; -} - -export const CertificationTaskV2025TypeV2025 = { - Reassign: 'REASSIGN', - AdminReassign: 'ADMIN_REASSIGN', - CompleteCertification: 'COMPLETE_CERTIFICATION', - FinishCertification: 'FINISH_CERTIFICATION', - CompleteCampaign: 'COMPLETE_CAMPAIGN', - ActivateCampaign: 'ACTIVATE_CAMPAIGN', - CampaignCreate: 'CAMPAIGN_CREATE', - CampaignDelete: 'CAMPAIGN_DELETE' -} as const; - -export type CertificationTaskV2025TypeV2025 = typeof CertificationTaskV2025TypeV2025[keyof typeof CertificationTaskV2025TypeV2025]; -export const CertificationTaskV2025TargetTypeV2025 = { - Certification: 'CERTIFICATION', - Campaign: 'CAMPAIGN' -} as const; - -export type CertificationTaskV2025TargetTypeV2025 = typeof CertificationTaskV2025TargetTypeV2025[keyof typeof CertificationTaskV2025TargetTypeV2025]; -export const CertificationTaskV2025StatusV2025 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type CertificationTaskV2025StatusV2025 = typeof CertificationTaskV2025StatusV2025[keyof typeof CertificationTaskV2025StatusV2025]; - -/** - * - * @export - * @interface CertificationV2025 - */ -export interface CertificationV2025 { - /** - * id of the certification - * @type {string} - * @memberof CertificationV2025 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof CertificationV2025 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2025} - * @memberof CertificationV2025 - */ - 'campaign'?: CampaignReferenceV2025; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof CertificationV2025 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof CertificationV2025 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof CertificationV2025 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof CertificationV2025 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof CertificationV2025 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof CertificationV2025 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof CertificationV2025 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationV2025 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof CertificationV2025 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2025} - * @memberof CertificationV2025 - */ - 'reviewer'?: ReviewerV2025; - /** - * - * @type {ReassignmentV2025} - * @memberof CertificationV2025 - */ - 'reassignment'?: ReassignmentV2025 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof CertificationV2025 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof CertificationV2025 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2025} - * @memberof CertificationV2025 - */ - 'phase'?: CertificationPhaseV2025; -} - - -/** - * - * @export - * @interface CertifierResponseV2025 - */ -export interface CertifierResponseV2025 { - /** - * the id of the certifier - * @type {string} - * @memberof CertifierResponseV2025 - */ - 'id'?: string; - /** - * the name of the certifier - * @type {string} - * @memberof CertifierResponseV2025 - */ - 'displayName'?: string; -} -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationDurationMinutesV2025 - */ -export interface ClientLogConfigurationDurationMinutesV2025 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationDurationMinutesV2025 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationDurationMinutesV2025 - */ - 'durationMinutes'?: number; - /** - * - * @type {StandardLevelV2025} - * @memberof ClientLogConfigurationDurationMinutesV2025 - */ - 'rootLevel': StandardLevelV2025; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2025; }} - * @memberof ClientLogConfigurationDurationMinutesV2025 - */ - 'logLevels'?: { [key: string]: StandardLevelV2025; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationExpirationV2025 - */ -export interface ClientLogConfigurationExpirationV2025 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationExpirationV2025 - */ - 'clientId'?: string; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationExpirationV2025 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2025} - * @memberof ClientLogConfigurationExpirationV2025 - */ - 'rootLevel': StandardLevelV2025; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2025; }} - * @memberof ClientLogConfigurationExpirationV2025 - */ - 'logLevels'?: { [key: string]: StandardLevelV2025; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationV2025 - */ -export interface ClientLogConfigurationV2025 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationV2025 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationV2025 - */ - 'durationMinutes'?: number; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationV2025 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2025} - * @memberof ClientLogConfigurationV2025 - */ - 'rootLevel': StandardLevelV2025; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2025; }} - * @memberof ClientLogConfigurationV2025 - */ - 'logLevels'?: { [key: string]: StandardLevelV2025; }; -} - - -/** - * Type of an API Client indicating public or confidentials use - * @export - * @enum {string} - */ - -export const ClientTypeV2025 = { - Confidential: 'CONFIDENTIAL', - Public: 'PUBLIC' -} as const; - -export type ClientTypeV2025 = typeof ClientTypeV2025[keyof typeof ClientTypeV2025]; - - -/** - * Request body payload for close access requests endpoint. - * @export - * @interface CloseAccessRequestV2025 - */ -export interface CloseAccessRequestV2025 { - /** - * Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. - * @type {Array} - * @memberof CloseAccessRequestV2025 - */ - 'accessRequestIds': Array; - /** - * Reason for closing the access request. Displayed under Warnings in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2025 - */ - 'message'?: string; - /** - * The request\'s provisioning status. Displayed as Stage in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2025 - */ - 'executionStatus'?: CloseAccessRequestV2025ExecutionStatusV2025; - /** - * The request\'s overall status. Displayed as Status in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2025 - */ - 'completionStatus'?: CloseAccessRequestV2025CompletionStatusV2025; -} - -export const CloseAccessRequestV2025ExecutionStatusV2025 = { - Terminated: 'Terminated', - Completed: 'Completed' -} as const; - -export type CloseAccessRequestV2025ExecutionStatusV2025 = typeof CloseAccessRequestV2025ExecutionStatusV2025[keyof typeof CloseAccessRequestV2025ExecutionStatusV2025]; -export const CloseAccessRequestV2025CompletionStatusV2025 = { - Success: 'Success', - Incomplete: 'Incomplete', - Failure: 'Failure' -} as const; - -export type CloseAccessRequestV2025CompletionStatusV2025 = typeof CloseAccessRequestV2025CompletionStatusV2025[keyof typeof CloseAccessRequestV2025CompletionStatusV2025]; - -/** - * Configuration details for the \'ccg\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 { - /** - * Version of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ - 'version': string; - /** - * Path to the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ - 'path': string; - /** - * A brief description of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ - 'restartNeeded': boolean; - /** - * A map of dependencies for the \'ccg\' process. - * @type {{ [key: string]: string; }} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025 - */ - 'dependencies': { [key: string]: string; }; -} -/** - * Configuration details for the \'charon\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 { - /** - * Version of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 - */ - 'version': string; - /** - * Path to the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 - */ - 'path': string; - /** - * A brief description of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'otel_agent\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 { - /** - * Version of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 - */ - 'version': string; - /** - * Path to the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 - */ - 'path': string; - /** - * A brief description of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'relay\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 { - /** - * Version of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 - */ - 'version': string; - /** - * Path to the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 - */ - 'path': string; - /** - * A brief description of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'toolbox\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 { - /** - * Version of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 - */ - 'version': string; - /** - * Path to the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 - */ - 'path': string; - /** - * A brief description of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025 - */ - 'restartNeeded': boolean; -} -/** - * Configuration of the managed processes involved in the upgrade. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 { - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ - 'charon'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2025; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ - 'ccg'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2025; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ - 'otel_agent'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2025; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ - 'relay'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2025; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025 - */ - 'toolbox'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2025; -} -/** - * - * @export - * @interface ClusterManualUpgradeJobsInnerV2025 - */ -export interface ClusterManualUpgradeJobsInnerV2025 { - /** - * Unique identifier for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'uuid': string; - /** - * Identifier for the cookbook used in the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'cookbook': string; - /** - * Current state of the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'state': string; - /** - * The type of upgrade job (e.g., VA_UPGRADE). - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'type': string; - /** - * Unique identifier of the target for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'targetId': string; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025} - * @memberof ClusterManualUpgradeJobsInnerV2025 - */ - 'managedProcessConfiguration': ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2025; -} -/** - * Manual Upgrade Job Response - * @export - * @interface ClusterManualUpgradeV2025 - */ -export interface ClusterManualUpgradeV2025 { - /** - * List of job objects for the upgrade request. - * @type {Array} - * @memberof ClusterManualUpgradeV2025 - */ - 'jobs'?: Array; -} -/** - * - * @export - * @interface ColumnV2025 - */ -export interface ColumnV2025 { - /** - * The name of the field. - * @type {string} - * @memberof ColumnV2025 - */ - 'field': string; - /** - * The value of the header. - * @type {string} - * @memberof ColumnV2025 - */ - 'header'?: string; -} -/** - * Author of the comment - * @export - * @interface CommentDtoAuthorV2025 - */ -export interface CommentDtoAuthorV2025 { - /** - * The type of object - * @type {string} - * @memberof CommentDtoAuthorV2025 - */ - 'type'?: CommentDtoAuthorV2025TypeV2025; - /** - * The unique ID of the object - * @type {string} - * @memberof CommentDtoAuthorV2025 - */ - 'id'?: string; - /** - * The display name of the object - * @type {string} - * @memberof CommentDtoAuthorV2025 - */ - 'name'?: string; -} - -export const CommentDtoAuthorV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type CommentDtoAuthorV2025TypeV2025 = typeof CommentDtoAuthorV2025TypeV2025[keyof typeof CommentDtoAuthorV2025TypeV2025]; - -/** - * - * @export - * @interface CommentDtoV2025 - */ -export interface CommentDtoV2025 { - /** - * Comment content. - * @type {string} - * @memberof CommentDtoV2025 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDtoV2025 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2025} - * @memberof CommentDtoV2025 - */ - 'author'?: CommentDtoAuthorV2025; -} -/** - * - * @export - * @interface CommentV2025 - */ -export interface CommentV2025 { - /** - * Id of the identity making the comment - * @type {string} - * @memberof CommentV2025 - */ - 'commenterId'?: string; - /** - * Human-readable display name of the identity making the comment - * @type {string} - * @memberof CommentV2025 - */ - 'commenterName'?: string; - /** - * Content of the comment - * @type {string} - * @memberof CommentV2025 - */ - 'body'?: string; - /** - * Date and time comment was made - * @type {string} - * @memberof CommentV2025 - */ - 'date'?: string; -} -/** - * - * @export - * @interface CommonAccessIDStatusV2025 - */ -export interface CommonAccessIDStatusV2025 { - /** - * List of confirmed common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2025 - */ - 'confirmedIds'?: Array; - /** - * List of denied common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2025 - */ - 'deniedIds'?: Array; -} -/** - * - * @export - * @interface CommonAccessItemAccessV2025 - */ -export interface CommonAccessItemAccessV2025 { - /** - * Common access ID - * @type {string} - * @memberof CommonAccessItemAccessV2025 - */ - 'id'?: string; - /** - * - * @type {CommonAccessTypeV2025} - * @memberof CommonAccessItemAccessV2025 - */ - 'type'?: CommonAccessTypeV2025; - /** - * Common access name - * @type {string} - * @memberof CommonAccessItemAccessV2025 - */ - 'name'?: string; - /** - * Common access description - * @type {string} - * @memberof CommonAccessItemAccessV2025 - */ - 'description'?: string | null; - /** - * Common access owner name - * @type {string} - * @memberof CommonAccessItemAccessV2025 - */ - 'ownerName'?: string; - /** - * Common access owner ID - * @type {string} - * @memberof CommonAccessItemAccessV2025 - */ - 'ownerId'?: string; -} - - -/** - * - * @export - * @interface CommonAccessItemRequestV2025 - */ -export interface CommonAccessItemRequestV2025 { - /** - * - * @type {CommonAccessItemAccessV2025} - * @memberof CommonAccessItemRequestV2025 - */ - 'access'?: CommonAccessItemAccessV2025; - /** - * - * @type {CommonAccessItemStateV2025} - * @memberof CommonAccessItemRequestV2025 - */ - 'status'?: CommonAccessItemStateV2025; -} - - -/** - * - * @export - * @interface CommonAccessItemResponseV2025 - */ -export interface CommonAccessItemResponseV2025 { - /** - * Common Access Item ID - * @type {string} - * @memberof CommonAccessItemResponseV2025 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2025} - * @memberof CommonAccessItemResponseV2025 - */ - 'access'?: CommonAccessItemAccessV2025; - /** - * - * @type {CommonAccessItemStateV2025} - * @memberof CommonAccessItemResponseV2025 - */ - 'status'?: CommonAccessItemStateV2025; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2025 - */ - 'lastUpdated'?: string; - /** - * - * @type {boolean} - * @memberof CommonAccessItemResponseV2025 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2025 - */ - 'lastReviewed'?: string; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2025 - */ - 'createdByUser'?: string; -} - - -/** - * State of common access item. - * @export - * @enum {string} - */ - -export const CommonAccessItemStateV2025 = { - Confirmed: 'CONFIRMED', - Denied: 'DENIED' -} as const; - -export type CommonAccessItemStateV2025 = typeof CommonAccessItemStateV2025[keyof typeof CommonAccessItemStateV2025]; - - -/** - * - * @export - * @interface CommonAccessResponseV2025 - */ -export interface CommonAccessResponseV2025 { - /** - * Unique ID of the common access item - * @type {string} - * @memberof CommonAccessResponseV2025 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2025} - * @memberof CommonAccessResponseV2025 - */ - 'access'?: CommonAccessItemAccessV2025; - /** - * CONFIRMED or DENIED - * @type {string} - * @memberof CommonAccessResponseV2025 - */ - 'status'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2025 - */ - 'commonAccessType'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2025 - */ - 'lastUpdated'?: string; - /** - * true if user has confirmed or denied status - * @type {boolean} - * @memberof CommonAccessResponseV2025 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2025 - */ - 'lastReviewed'?: string | null; - /** - * - * @type {boolean} - * @memberof CommonAccessResponseV2025 - */ - 'createdByUser'?: boolean; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const CommonAccessTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type CommonAccessTypeV2025 = typeof CommonAccessTypeV2025[keyof typeof CommonAccessTypeV2025]; - - -/** - * - * @export - * @interface CompleteInvocationInputV2025 - */ -export interface CompleteInvocationInputV2025 { - /** - * - * @type {LocalizedMessageV2025} - * @memberof CompleteInvocationInputV2025 - */ - 'localizedError'?: LocalizedMessageV2025 | null; - /** - * Trigger output that completed the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationInputV2025 - */ - 'output'?: object | null; -} -/** - * - * @export - * @interface CompleteInvocationV2025 - */ -export interface CompleteInvocationV2025 { - /** - * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. - * @type {string} - * @memberof CompleteInvocationV2025 - */ - 'secret': string; - /** - * The error message to indicate a failed invocation or error if any. - * @type {string} - * @memberof CompleteInvocationV2025 - */ - 'error'?: string; - /** - * Trigger output to complete the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationV2025 - */ - 'output': object; -} -/** - * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. - * @export - * @interface CompletedApprovalPreApprovalTriggerResultV2025 - */ -export interface CompletedApprovalPreApprovalTriggerResultV2025 { - /** - * The comment from the trigger - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2025 - */ - 'comment'?: string; - /** - * - * @type {CompletedApprovalStateV2025} - * @memberof CompletedApprovalPreApprovalTriggerResultV2025 - */ - 'decision'?: CompletedApprovalStateV2025; - /** - * The name of the approver - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2025 - */ - 'reviewer'?: string; - /** - * The date and time the trigger decided on the request - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2025 - */ - 'date'?: string; -} - - -/** - * - * @export - * @interface CompletedApprovalRequesterCommentV2025 - */ -export interface CompletedApprovalRequesterCommentV2025 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2025 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2025 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2025} - * @memberof CompletedApprovalRequesterCommentV2025 - */ - 'author'?: CommentDtoAuthorV2025; -} -/** - * - * @export - * @interface CompletedApprovalReviewerCommentV2025 - */ -export interface CompletedApprovalReviewerCommentV2025 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2025 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2025 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2025} - * @memberof CompletedApprovalReviewerCommentV2025 - */ - 'author'?: CommentDtoAuthorV2025; -} -/** - * Enum represents completed approval object\'s state. - * @export - * @enum {string} - */ - -export const CompletedApprovalStateV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type CompletedApprovalStateV2025 = typeof CompletedApprovalStateV2025[keyof typeof CompletedApprovalStateV2025]; - - -/** - * - * @export - * @interface CompletedApprovalV2025 - */ -export interface CompletedApprovalV2025 { - /** - * The approval id. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof CompletedApprovalV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * - * @type {AccessItemRequesterV2025} - * @memberof CompletedApprovalV2025 - */ - 'requester'?: AccessItemRequesterV2025; - /** - * - * @type {RequestedItemStatusRequestedForV2025} - * @memberof CompletedApprovalV2025 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2025; - /** - * - * @type {AccessItemReviewedByV2025} - * @memberof CompletedApprovalV2025 - */ - 'reviewedBy'?: AccessItemReviewedByV2025; - /** - * - * @type {OwnerDtoV2025} - * @memberof CompletedApprovalV2025 - */ - 'owner'?: OwnerDtoV2025; - /** - * - * @type {RequestableObjectReferenceV2025} - * @memberof CompletedApprovalV2025 - */ - 'requestedObject'?: RequestableObjectReferenceV2025; - /** - * - * @type {CompletedApprovalRequesterCommentV2025} - * @memberof CompletedApprovalV2025 - */ - 'requesterComment'?: CompletedApprovalRequesterCommentV2025; - /** - * - * @type {CompletedApprovalReviewerCommentV2025} - * @memberof CompletedApprovalV2025 - */ - 'reviewerComment'?: CompletedApprovalReviewerCommentV2025; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof CompletedApprovalV2025 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof CompletedApprovalV2025 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof CompletedApprovalV2025 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {CompletedApprovalStateV2025} - * @memberof CompletedApprovalV2025 - */ - 'state'?: CompletedApprovalStateV2025; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'removeDate'?: string | null; - /** - * If true, then the request was to change the remove date or sunset date. - * @type {boolean} - * @memberof CompletedApprovalV2025 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'currentRemoveDate'?: string | null; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof CompletedApprovalV2025 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2025} - * @memberof CompletedApprovalV2025 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2025 | null; - /** - * - * @type {CompletedApprovalPreApprovalTriggerResultV2025} - * @memberof CompletedApprovalV2025 - */ - 'preApprovalTriggerResult'?: CompletedApprovalPreApprovalTriggerResultV2025 | null; - /** - * Arbitrary key-value pairs provided during the request. - * @type {{ [key: string]: string; }} - * @memberof CompletedApprovalV2025 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof CompletedApprovalV2025 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof CompletedApprovalV2025 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2025} - * @memberof CompletedApprovalV2025 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2025 | null; -} - - -/** - * The status after completion. - * @export - * @enum {string} - */ - -export const CompletionStatusV2025 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Incomplete: 'INCOMPLETE', - Pending: 'PENDING' -} as const; - -export type CompletionStatusV2025 = typeof CompletionStatusV2025[keyof typeof CompletionStatusV2025]; - - -/** - * - * @export - * @interface ConcatenationV2025 - */ -export interface ConcatenationV2025 { - /** - * An array of items to join together - * @type {Array} - * @memberof ConcatenationV2025 - */ - 'values': Array; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConcatenationV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConcatenationV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Arbitrary map containing a configuration based on the EffectType. - * @export - * @interface ConditionEffectConfigV2025 - */ -export interface ConditionEffectConfigV2025 { - /** - * Effect type\'s label. - * @type {string} - * @memberof ConditionEffectConfigV2025 - */ - 'defaultValueLabel'?: string; - /** - * Element\'s identifier. - * @type {string} - * @memberof ConditionEffectConfigV2025 - */ - 'element'?: string; -} -/** - * Effect produced by a condition. - * @export - * @interface ConditionEffectV2025 - */ -export interface ConditionEffectV2025 { - /** - * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - * @type {string} - * @memberof ConditionEffectV2025 - */ - 'effectType'?: ConditionEffectV2025EffectTypeV2025; - /** - * - * @type {ConditionEffectConfigV2025} - * @memberof ConditionEffectV2025 - */ - 'config'?: ConditionEffectConfigV2025; -} - -export const ConditionEffectV2025EffectTypeV2025 = { - Hide: 'HIDE', - Show: 'SHOW', - Disable: 'DISABLE', - Enable: 'ENABLE', - Require: 'REQUIRE', - Optional: 'OPTIONAL', - SubmitMessage: 'SUBMIT_MESSAGE', - SubmitNotification: 'SUBMIT_NOTIFICATION', - SetDefaultValue: 'SET_DEFAULT_VALUE' -} as const; - -export type ConditionEffectV2025EffectTypeV2025 = typeof ConditionEffectV2025EffectTypeV2025[keyof typeof ConditionEffectV2025EffectTypeV2025]; - -/** - * - * @export - * @interface ConditionRuleV2025 - */ -export interface ConditionRuleV2025 { - /** - * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement - * @type {string} - * @memberof ConditionRuleV2025 - */ - 'sourceType'?: ConditionRuleV2025SourceTypeV2025; - /** - * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. - * @type {string} - * @memberof ConditionRuleV2025 - */ - 'source'?: string; - /** - * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - * @type {string} - * @memberof ConditionRuleV2025 - */ - 'operator'?: ConditionRuleV2025OperatorV2025; - /** - * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean - * @type {string} - * @memberof ConditionRuleV2025 - */ - 'valueType'?: ConditionRuleV2025ValueTypeV2025; - /** - * Based on the ValueType. - * @type {string} - * @memberof ConditionRuleV2025 - */ - 'value'?: string; -} - -export const ConditionRuleV2025SourceTypeV2025 = { - Input: 'INPUT', - Element: 'ELEMENT' -} as const; - -export type ConditionRuleV2025SourceTypeV2025 = typeof ConditionRuleV2025SourceTypeV2025[keyof typeof ConditionRuleV2025SourceTypeV2025]; -export const ConditionRuleV2025OperatorV2025 = { - Eq: 'EQ', - Ne: 'NE', - Co: 'CO', - NotCo: 'NOT_CO', - In: 'IN', - NotIn: 'NOT_IN', - Em: 'EM', - NotEm: 'NOT_EM', - Sw: 'SW', - NotSw: 'NOT_SW', - Ew: 'EW', - NotEw: 'NOT_EW' -} as const; - -export type ConditionRuleV2025OperatorV2025 = typeof ConditionRuleV2025OperatorV2025[keyof typeof ConditionRuleV2025OperatorV2025]; -export const ConditionRuleV2025ValueTypeV2025 = { - String: 'STRING', - StringList: 'STRING_LIST', - Input: 'INPUT', - Element: 'ELEMENT', - List: 'LIST', - Boolean: 'BOOLEAN' -} as const; - -export type ConditionRuleV2025ValueTypeV2025 = typeof ConditionRuleV2025ValueTypeV2025[keyof typeof ConditionRuleV2025ValueTypeV2025]; - -/** - * - * @export - * @interface ConditionalV2025 - */ -export interface ConditionalV2025 { - /** - * A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison - * @type {string} - * @memberof ConditionalV2025 - */ - 'expression': string; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof ConditionalV2025 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof ConditionalV2025 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConditionalV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConditionalV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Config export and import format for individual object configurations. - * @export - * @interface ConfigObjectV2025 - */ -export interface ConfigObjectV2025 { - /** - * Current version of configuration object. - * @type {number} - * @memberof ConfigObjectV2025 - */ - 'version'?: number; - /** - * - * @type {SelfImportExportDtoV2025} - * @memberof ConfigObjectV2025 - */ - 'self'?: SelfImportExportDtoV2025; - /** - * Object details. Format dependant on the object type. - * @type {{ [key: string]: any; }} - * @memberof ConfigObjectV2025 - */ - 'object'?: { [key: string]: any; }; -} -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumCamelV2025 = { - AccessRequests: 'accessRequests', - Certifications: 'certifications', - ManualTasks: 'manualTasks' -} as const; - -export type ConfigTypeEnumCamelV2025 = typeof ConfigTypeEnumCamelV2025[keyof typeof ConfigTypeEnumCamelV2025]; - - -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumV2025 = { - AccessRequests: 'ACCESS_REQUESTS', - Certifications: 'CERTIFICATIONS', - ManualTasks: 'MANUAL_TASKS', - GenericApprovals: 'GENERIC_APPROVALS' -} as const; - -export type ConfigTypeEnumV2025 = typeof ConfigTypeEnumV2025[keyof typeof ConfigTypeEnumV2025]; - - -/** - * Type of Reassignment Configuration. - * @export - * @interface ConfigTypeV2025 - */ -export interface ConfigTypeV2025 { - /** - * - * @type {number} - * @memberof ConfigTypeV2025 - */ - 'priority'?: number; - /** - * - * @type {ConfigTypeEnumCamelV2025} - * @memberof ConfigTypeV2025 - */ - 'internalName'?: ConfigTypeEnumCamelV2025; - /** - * - * @type {ConfigTypeEnumV2025} - * @memberof ConfigTypeV2025 - */ - 'internalNameCamel'?: ConfigTypeEnumV2025; - /** - * Human readable display name of the type to be shown on UI - * @type {string} - * @memberof ConfigTypeV2025 - */ - 'displayName'?: string; - /** - * Description of the type of work to be reassigned, displayed by the UI. - * @type {string} - * @memberof ConfigTypeV2025 - */ - 'description'?: string; -} - - -/** - * The request body of Reassignment Configuration Details for a specific identity and config type - * @export - * @interface ConfigurationDetailsResponseV2025 - */ -export interface ConfigurationDetailsResponseV2025 { - /** - * - * @type {ConfigTypeEnumV2025} - * @memberof ConfigurationDetailsResponseV2025 - */ - 'configType'?: ConfigTypeEnumV2025; - /** - * - * @type {Identity1V2025} - * @memberof ConfigurationDetailsResponseV2025 - */ - 'targetIdentity'?: Identity1V2025; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationDetailsResponseV2025 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationDetailsResponseV2025 - */ - 'endDate'?: string; - /** - * - * @type {AuditDetailsV2025} - * @memberof ConfigurationDetailsResponseV2025 - */ - 'auditDetails'?: AuditDetailsV2025; -} - - -/** - * The request body for creation or update of a Reassignment Configuration for a single identity and work type - * @export - * @interface ConfigurationItemRequestV2025 - */ -export interface ConfigurationItemRequestV2025 { - /** - * The identity id to reassign an item from - * @type {string} - * @memberof ConfigurationItemRequestV2025 - */ - 'reassignedFromId'?: string; - /** - * The identity id to reassign an item to - * @type {string} - * @memberof ConfigurationItemRequestV2025 - */ - 'reassignedToId'?: string; - /** - * - * @type {ConfigTypeEnumV2025} - * @memberof ConfigurationItemRequestV2025 - */ - 'configType'?: ConfigTypeEnumV2025; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationItemRequestV2025 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationItemRequestV2025 - */ - 'endDate'?: string | null; -} - - -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationItemResponseV2025 - */ -export interface ConfigurationItemResponseV2025 { - /** - * - * @type {Identity1V2025} - * @memberof ConfigurationItemResponseV2025 - */ - 'identity'?: Identity1V2025; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationItemResponseV2025 - */ - 'configDetails'?: Array; -} -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationResponseV2025 - */ -export interface ConfigurationResponseV2025 { - /** - * - * @type {Identity1V2025} - * @memberof ConfigurationResponseV2025 - */ - 'identity'?: Identity1V2025; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationResponseV2025 - */ - 'configDetails'?: Array; -} -/** - * - * @export - * @interface ConflictingAccessCriteriaV2025 - */ -export interface ConflictingAccessCriteriaV2025 { - /** - * - * @type {AccessCriteriaV2025} - * @memberof ConflictingAccessCriteriaV2025 - */ - 'leftCriteria'?: AccessCriteriaV2025; - /** - * - * @type {AccessCriteriaV2025} - * @memberof ConflictingAccessCriteriaV2025 - */ - 'rightCriteria'?: AccessCriteriaV2025; -} -/** - * An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - * @export - * @enum {string} - */ - -export const ConnectedObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type ConnectedObjectTypeV2025 = typeof ConnectedObjectTypeV2025[keyof typeof ConnectedObjectTypeV2025]; - - -/** - * - * @export - * @interface ConnectedObjectV2025 - */ -export interface ConnectedObjectV2025 { - /** - * - * @type {ConnectedObjectTypeV2025 & object} - * @memberof ConnectedObjectV2025 - */ - 'type'?: ConnectedObjectTypeV2025 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ConnectedObjectV2025 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof ConnectedObjectV2025 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof ConnectedObjectV2025 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ConnectorCustomizerCreateRequestV2025 - */ -export interface ConnectorCustomizerCreateRequestV2025 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerCreateRequestV2025 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerResponse - * @export - * @interface ConnectorCustomizerCreateResponseV2025 - */ -export interface ConnectorCustomizerCreateResponseV2025 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2025 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2025 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2025 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2025 - */ - 'created'?: string; -} -/** - * ConnectorCustomizerUpdateRequest - * @export - * @interface ConnectorCustomizerUpdateRequestV2025 - */ -export interface ConnectorCustomizerUpdateRequestV2025 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerUpdateRequestV2025 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerUpdateResponse - * @export - * @interface ConnectorCustomizerUpdateResponseV2025 - */ -export interface ConnectorCustomizerUpdateResponseV2025 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'created'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2025 - */ - 'imageID'?: string; -} -/** - * ConnectorCustomizerVersionCreateResponse - * @export - * @interface ConnectorCustomizerVersionCreateResponseV2025 - */ -export interface ConnectorCustomizerVersionCreateResponseV2025 { - /** - * ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2025 - */ - 'customizerID'?: string; - /** - * ImageID of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2025 - */ - 'imageID'?: string; - /** - * Image version of the connector customizer. - * @type {number} - * @memberof ConnectorCustomizerVersionCreateResponseV2025 - */ - 'version'?: number; - /** - * Date-time when the connector customizer version was created. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2025 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorCustomizersResponseV2025 - */ -export interface ConnectorCustomizersResponseV2025 { - /** - * Connector customizer ID. - * @type {string} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'id'?: string; - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'name'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'imageID'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created - * @type {string} - * @memberof ConnectorCustomizersResponseV2025 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorDetailV2025 - */ -export interface ConnectorDetailV2025 { - /** - * The connector name - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'type'?: string; - /** - * The connector class name - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'className'?: string; - /** - * The connector script name - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'scriptName'?: string; - /** - * The connector application xml - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'applicationXml'?: string; - /** - * The connector correlation config xml - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'correlationConfigXml'?: string; - /** - * The connector source config xml - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'sourceConfigXml'?: string; - /** - * The connector source config - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'sourceConfig'?: string | null; - /** - * The connector source config origin - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'sourceConfigFrom'?: string | null; - /** - * storage path key for this connector - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 's3Location'?: string; - /** - * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. - * @type {Array} - * @memberof ConnectorDetailV2025 - */ - 'uploadedFiles'?: Array | null; - /** - * true if the source is file upload - * @type {boolean} - * @memberof ConnectorDetailV2025 - */ - 'fileUpload'?: boolean; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof ConnectorDetailV2025 - */ - 'directConnect'?: boolean; - /** - * A map containing translation attributes by loacale key - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2025 - */ - 'translationProperties'?: { [key: string]: any; }; - /** - * A map containing metadata pertinent to the UI to be used - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2025 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof ConnectorDetailV2025 - */ - 'status'?: ConnectorDetailV2025StatusV2025; -} - -export const ConnectorDetailV2025StatusV2025 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type ConnectorDetailV2025StatusV2025 = typeof ConnectorDetailV2025StatusV2025[keyof typeof ConnectorDetailV2025StatusV2025]; - -/** - * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) - * @export - * @interface ConnectorRuleCreateRequestSignatureV2025 - */ -export interface ConnectorRuleCreateRequestSignatureV2025 { - /** - * - * @type {Array} - * @memberof ConnectorRuleCreateRequestSignatureV2025 - */ - 'input': Array; - /** - * - * @type {ArgumentV2025} - * @memberof ConnectorRuleCreateRequestSignatureV2025 - */ - 'output'?: ArgumentV2025 | null; -} -/** - * ConnectorRuleCreateRequest - * @export - * @interface ConnectorRuleCreateRequestV2025 - */ -export interface ConnectorRuleCreateRequestV2025 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'type': ConnectorRuleCreateRequestV2025TypeV2025; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2025} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2025; - /** - * - * @type {SourceCodeV2025} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'sourceCode': SourceCodeV2025; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleCreateRequestV2025 - */ - 'attributes'?: object | null; -} - -export const ConnectorRuleCreateRequestV2025TypeV2025 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleCreateRequestV2025TypeV2025 = typeof ConnectorRuleCreateRequestV2025TypeV2025[keyof typeof ConnectorRuleCreateRequestV2025TypeV2025]; - -/** - * ConnectorRuleResponse - * @export - * @interface ConnectorRuleResponseV2025 - */ -export interface ConnectorRuleResponseV2025 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'type': ConnectorRuleResponseV2025TypeV2025; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2025} - * @memberof ConnectorRuleResponseV2025 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2025; - /** - * - * @type {SourceCodeV2025} - * @memberof ConnectorRuleResponseV2025 - */ - 'sourceCode': SourceCodeV2025; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleResponseV2025 - */ - 'attributes'?: object | null; - /** - * the ID of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'id': string; - /** - * an ISO 8601 UTC timestamp when this rule was created - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'created': string; - /** - * an ISO 8601 UTC timestamp when this rule was last modified - * @type {string} - * @memberof ConnectorRuleResponseV2025 - */ - 'modified'?: string | null; -} - -export const ConnectorRuleResponseV2025TypeV2025 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleResponseV2025TypeV2025 = typeof ConnectorRuleResponseV2025TypeV2025[keyof typeof ConnectorRuleResponseV2025TypeV2025]; - -/** - * ConnectorRuleUpdateRequest - * @export - * @interface ConnectorRuleUpdateRequestV2025 - */ -export interface ConnectorRuleUpdateRequestV2025 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'type': ConnectorRuleUpdateRequestV2025TypeV2025; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2025} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2025; - /** - * - * @type {SourceCodeV2025} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'sourceCode': SourceCodeV2025; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'attributes'?: object | null; - /** - * the ID of the rule to update - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2025 - */ - 'id': string; -} - -export const ConnectorRuleUpdateRequestV2025TypeV2025 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleUpdateRequestV2025TypeV2025 = typeof ConnectorRuleUpdateRequestV2025TypeV2025[keyof typeof ConnectorRuleUpdateRequestV2025TypeV2025]; - -/** - * CodeErrorDetail - * @export - * @interface ConnectorRuleValidationResponseDetailsInnerV2025 - */ -export interface ConnectorRuleValidationResponseDetailsInnerV2025 { - /** - * The line number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2025 - */ - 'line': number; - /** - * the column number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2025 - */ - 'column': number; - /** - * a description of the issue in the code - * @type {string} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2025 - */ - 'messsage'?: string; -} -/** - * ConnectorRuleValidationResponse - * @export - * @interface ConnectorRuleValidationResponseV2025 - */ -export interface ConnectorRuleValidationResponseV2025 { - /** - * - * @type {string} - * @memberof ConnectorRuleValidationResponseV2025 - */ - 'state': ConnectorRuleValidationResponseV2025StateV2025; - /** - * - * @type {Array} - * @memberof ConnectorRuleValidationResponseV2025 - */ - 'details': Array; -} - -export const ConnectorRuleValidationResponseV2025StateV2025 = { - Ok: 'OK', - Error: 'ERROR' -} as const; - -export type ConnectorRuleValidationResponseV2025StateV2025 = typeof ConnectorRuleValidationResponseV2025StateV2025[keyof typeof ConnectorRuleValidationResponseV2025StateV2025]; - -/** - * - * @export - * @interface ContextAttributeDtoV2025 - */ -export interface ContextAttributeDtoV2025 { - /** - * The name of the attribute - * @type {string} - * @memberof ContextAttributeDtoV2025 - */ - 'attribute'?: string; - /** - * - * @type {ContextAttributeDtoValueV2025} - * @memberof ContextAttributeDtoV2025 - */ - 'value'?: ContextAttributeDtoValueV2025; - /** - * True if the attribute was derived. - * @type {boolean} - * @memberof ContextAttributeDtoV2025 - */ - 'derived'?: boolean; -} -/** - * @type ContextAttributeDtoValueV2025 - * The value of the attribute. This can be either a string or a multi-valued string - * @export - */ -export type ContextAttributeDtoValueV2025 = Array | string; - -/** - * - * @export - * @interface CorrelatedGovernanceEventV2025 - */ -export interface CorrelatedGovernanceEventV2025 { - /** - * The name of the governance event, such as the certification name or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'name'?: string; - /** - * The date that the certification or access request was completed. - * @type {string} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'dateTime'?: string; - /** - * The type of governance event. - * @type {string} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'type'?: CorrelatedGovernanceEventV2025TypeV2025; - /** - * The ID of the instance that caused the event - either the certification ID or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'governanceId'?: string; - /** - * The owners of the governance event (the certifiers or approvers) - * @type {Array} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'owners'?: Array; - /** - * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners - * @type {Array} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2025} - * @memberof CorrelatedGovernanceEventV2025 - */ - 'decisionMaker'?: CertifierResponseV2025; -} - -export const CorrelatedGovernanceEventV2025TypeV2025 = { - Certification: 'certification', - AccessRequest: 'accessRequest' -} as const; - -export type CorrelatedGovernanceEventV2025TypeV2025 = typeof CorrelatedGovernanceEventV2025TypeV2025[keyof typeof CorrelatedGovernanceEventV2025TypeV2025]; - -/** - * The attribute assignment of the correlation configuration. - * @export - * @interface CorrelationConfigAttributeAssignmentsInnerV2025 - */ -export interface CorrelationConfigAttributeAssignmentsInnerV2025 { - /** - * The property of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'property'?: string; - /** - * The value of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'value'?: string; - /** - * The operation of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'operation'?: CorrelationConfigAttributeAssignmentsInnerV2025OperationV2025; - /** - * Whether or not the it\'s a complex attribute assignment. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'complex'?: boolean; - /** - * Whether or not the attribute assignment should ignore case. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'ignoreCase'?: boolean; - /** - * The match mode of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'matchMode'?: CorrelationConfigAttributeAssignmentsInnerV2025MatchModeV2025; - /** - * The filter string of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2025 - */ - 'filterString'?: string; -} - -export const CorrelationConfigAttributeAssignmentsInnerV2025OperationV2025 = { - Eq: 'EQ' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2025OperationV2025 = typeof CorrelationConfigAttributeAssignmentsInnerV2025OperationV2025[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2025OperationV2025]; -export const CorrelationConfigAttributeAssignmentsInnerV2025MatchModeV2025 = { - Anywhere: 'ANYWHERE', - Start: 'START', - End: 'END' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2025MatchModeV2025 = typeof CorrelationConfigAttributeAssignmentsInnerV2025MatchModeV2025[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2025MatchModeV2025]; - -/** - * Source configuration information that is used by correlation process. - * @export - * @interface CorrelationConfigV2025 - */ -export interface CorrelationConfigV2025 { - /** - * The ID of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2025 - */ - 'id'?: string | null; - /** - * The name of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2025 - */ - 'name'?: string | null; - /** - * The list of attribute assignments of the correlation configuration. - * @type {Array} - * @memberof CorrelationConfigV2025 - */ - 'attributeAssignments'?: Array | null; -} -/** - * Specifies when resource sizes should be calculated during a crawl operation. - 0: Unspecified - No specific option set. - 1: Never - Resource sizes are never calculated. - 2: Always - Resource sizes are always calculated. - 3: Secondcrawl - Resource sizes are calculated only on a second crawl. - * @export - * @enum {number} - */ - -export const CrawlResourcesSizesOptionsV2025 = { - NUMBER_0: 0, - NUMBER_1: 1, - NUMBER_2: 2, - NUMBER_3: 3 -} as const; - -export type CrawlResourcesSizesOptionsV2025 = typeof CrawlResourcesSizesOptionsV2025[keyof typeof CrawlResourcesSizesOptionsV2025]; - - -/** - * - * @export - * @interface CreateDomainDkim405ResponseV2025 - */ -export interface CreateDomainDkim405ResponseV2025 { - /** - * A message describing the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2025 - */ - 'errorName'?: object; - /** - * Description of the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2025 - */ - 'errorMessage'?: object; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof CreateDomainDkim405ResponseV2025 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflow200ResponseV2025 - */ -export interface CreateExternalExecuteWorkflow200ResponseV2025 { - /** - * The workflow execution id - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2025 - */ - 'workflowExecutionId'?: string; - /** - * An error message if any errors occurred - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2025 - */ - 'message'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflowRequestV2025 - */ -export interface CreateExternalExecuteWorkflowRequestV2025 { - /** - * The input for the workflow - * @type {object} - * @memberof CreateExternalExecuteWorkflowRequestV2025 - */ - 'input'?: object; -} -/** - * - * @export - * @interface CreateFormDefinitionFileRequestRequestV2025 - */ -export interface CreateFormDefinitionFileRequestRequestV2025 { - /** - * File specifying the multipart - * @type {File} - * @memberof CreateFormDefinitionFileRequestRequestV2025 - */ - 'file': File; -} -/** - * - * @export - * @interface CreateFormDefinitionRequestV2025 - */ -export interface CreateFormDefinitionRequestV2025 { - /** - * Description is the form definition description - * @type {string} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'description'?: string; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'formConditions'?: Array; - /** - * FormElements is a list of nested form elements - * @type {Array} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'formElements'?: Array; - /** - * FormInput is a list of form inputs that are required when creating a form-instance object - * @type {Array} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'formInput'?: Array; - /** - * Name is the form definition name - * @type {string} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'name': string; - /** - * - * @type {FormOwnerV2025} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'owner': FormOwnerV2025; - /** - * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used - * @type {Array} - * @memberof CreateFormDefinitionRequestV2025 - */ - 'usedBy'?: Array; -} -/** - * - * @export - * @interface CreateFormInstanceRequestV2025 - */ -export interface CreateFormInstanceRequestV2025 { - /** - * - * @type {FormInstanceCreatedByV2025} - * @memberof CreateFormInstanceRequestV2025 - */ - 'createdBy': FormInstanceCreatedByV2025; - /** - * Expire is required - * @type {string} - * @memberof CreateFormInstanceRequestV2025 - */ - 'expire': string; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof CreateFormInstanceRequestV2025 - */ - 'formDefinitionId': string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: any; }} - * @memberof CreateFormInstanceRequestV2025 - */ - 'formInput'?: { [key: string]: any; }; - /** - * Recipients is required - * @type {Array} - * @memberof CreateFormInstanceRequestV2025 - */ - 'recipients': Array; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof CreateFormInstanceRequestV2025 - */ - 'standAloneForm'?: boolean; - /** - * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof CreateFormInstanceRequestV2025 - */ - 'state'?: CreateFormInstanceRequestV2025StateV2025; - /** - * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html - * @type {number} - * @memberof CreateFormInstanceRequestV2025 - */ - 'ttl'?: number; -} - -export const CreateFormInstanceRequestV2025StateV2025 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type CreateFormInstanceRequestV2025StateV2025 = typeof CreateFormInstanceRequestV2025StateV2025[keyof typeof CreateFormInstanceRequestV2025StateV2025]; - -/** - * - * @export - * @interface CreateMachineAccountSubtypeRequestV2025 - */ -export interface CreateMachineAccountSubtypeRequestV2025 { - /** - * Technical name of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2025 - */ - 'technicalName': string; - /** - * Display name of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2025 - */ - 'displayName': string; - /** - * Description of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2025 - */ - 'description': string; - /** - * Type of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface CreateOAuthClientRequestV2025 - */ -export interface CreateOAuthClientRequestV2025 { - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientRequestV2025 - */ - 'businessName'?: string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2025 - */ - 'homepageUrl'?: string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2025 - */ - 'name': string | null; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2025 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2025 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2025 - */ - 'refreshTokenValiditySeconds'?: number; - /** - * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - * @type {Array} - * @memberof CreateOAuthClientRequestV2025 - */ - 'redirectUris'?: Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientRequestV2025 - */ - 'grantTypes': Array | null; - /** - * - * @type {AccessTypeV2025} - * @memberof CreateOAuthClientRequestV2025 - */ - 'accessType': AccessTypeV2025; - /** - * - * @type {ClientTypeV2025} - * @memberof CreateOAuthClientRequestV2025 - */ - 'type'?: ClientTypeV2025; - /** - * An indicator of whether the API Client can be used for requests internal within the product. - * @type {boolean} - * @memberof CreateOAuthClientRequestV2025 - */ - 'internal'?: boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientRequestV2025 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientRequestV2025 - */ - 'strongAuthSupported'?: boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientRequestV2025 - */ - 'claimsSupported'?: boolean; - /** - * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreateOAuthClientRequestV2025 - */ - 'scope'?: Array | null; -} - - -/** - * - * @export - * @interface CreateOAuthClientResponseV2025 - */ -export interface CreateOAuthClientResponseV2025 { - /** - * ID of the OAuth client - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'id': string; - /** - * Secret of the OAuth client (This field is only returned on the intial create call.) - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'secret': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'businessName': string; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'homepageUrl': string; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'description': string; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2025 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2025 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof CreateOAuthClientResponseV2025 - */ - 'redirectUris': Array; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientResponseV2025 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2025} - * @memberof CreateOAuthClientResponseV2025 - */ - 'accessType': AccessTypeV2025; - /** - * - * @type {ClientTypeV2025} - * @memberof CreateOAuthClientResponseV2025 - */ - 'type': ClientTypeV2025; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof CreateOAuthClientResponseV2025 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientResponseV2025 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientResponseV2025 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientResponseV2025 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof CreateOAuthClientResponseV2025 - */ - 'modified': string; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof CreateOAuthClientResponseV2025 - */ - 'scope': Array | null; -} - - -/** - * Object for specifying the name of a personal access token to create - * @export - * @interface CreatePersonalAccessTokenRequestV2025 - */ -export interface CreatePersonalAccessTokenRequestV2025 { - /** - * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2025 - */ - 'name': string; - /** - * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreatePersonalAccessTokenRequestV2025 - */ - 'scope'?: Array | null; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenRequestV2025 - */ - 'accessTokenValiditySeconds'?: number | null; - /** - * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Valid Values (dependent on `userAwareTokenNeverExpires`):** * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (after the current date/time). There is no upper limit on how far in the future the expiration date can be set. `expirationDate` cannot be `null` in this case. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2025 - */ - 'expirationDate'?: string | null; - /** - * Indicates that the user creating this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When set to `true`, this flag confirms that the user understands the security risks associated with non-expiring tokens. **Security Awareness:** Setting this field to `true` serves as an explicit acknowledgment that the user creating the token understands: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Required Validation:** If `expirationDate` is `null` or empty (not included in the request body), `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Behavior:** * When set to `true`: Indicates that the user acknowledges they are creating a token that will never expire. When `expirationDate` is `null` or empty, the token will never expire. * When set to `false` or not specified (and `expirationDate` is provided): The token will follow normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. - * @type {boolean} - * @memberof CreatePersonalAccessTokenRequestV2025 - */ - 'userAwareTokenNeverExpires'?: boolean | null; -} -/** - * - * @export - * @interface CreatePersonalAccessTokenResponseV2025 - */ -export interface CreatePersonalAccessTokenResponseV2025 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'id': string; - /** - * The secret of the personal access token (to be used as the password for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'secret': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'scope': Array | null; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'name': string; - /** - * - * @type {PatOwnerV2025} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'owner': PatOwnerV2025; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'created': string; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'accessTokenValiditySeconds': number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2025 - */ - 'expirationDate': string; -} -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 - */ -export interface CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 { - /** - * The target type of the criteria item. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 - */ - 'targetType'?: CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025; - /** - * - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 - */ - 'operator'?: CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025OperatorV2025; - /** - * The values to evaluate the property against. - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 - */ - 'values'?: Array; - /** - * Whether to ignore case when evaluating the property against the values. - * @type {boolean} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025 - */ - 'ignoreCase'?: boolean; -} - -export const CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025 = { - Group: 'group' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025 = typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025]; -export const CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025OperatorV2025 = { - In: 'IN', - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025OperatorV2025 = typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025OperatorV2025[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2025OperatorV2025]; - -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestGroupsInnerV2025 - */ -export interface CreatePrivilegeCriteriaRequestGroupsInnerV2025 { - /** - * The logical operator to apply between criteria items in the group. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerV2025 - */ - 'operator'?: CreatePrivilegeCriteriaRequestGroupsInnerV2025OperatorV2025; - /** - * - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerV2025 - */ - 'criteriaItems'?: Array; -} - -export const CreatePrivilegeCriteriaRequestGroupsInnerV2025OperatorV2025 = { - And: 'AND', - Or: 'OR' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerV2025OperatorV2025 = typeof CreatePrivilegeCriteriaRequestGroupsInnerV2025OperatorV2025[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerV2025OperatorV2025]; - -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestV2025 - */ -export interface CreatePrivilegeCriteriaRequestV2025 { - /** - * The Id of the source that the criteria is applied to. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2025 - */ - 'sourceId'?: string; - /** - * The type of criteria being created. Expects \"CUSTOM\". - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2025 - */ - 'type'?: CreatePrivilegeCriteriaRequestV2025TypeV2025; - /** - * The logical operator to apply between groups. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2025 - */ - 'operator'?: CreatePrivilegeCriteriaRequestV2025OperatorV2025; - /** - * - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestV2025 - */ - 'groups'?: Array; - /** - * The privilege level assigned by this criteria. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2025 - */ - 'privilegeLevel'?: CreatePrivilegeCriteriaRequestV2025PrivilegeLevelV2025; -} - -export const CreatePrivilegeCriteriaRequestV2025TypeV2025 = { - Custom: 'CUSTOM' -} as const; - -export type CreatePrivilegeCriteriaRequestV2025TypeV2025 = typeof CreatePrivilegeCriteriaRequestV2025TypeV2025[keyof typeof CreatePrivilegeCriteriaRequestV2025TypeV2025]; -export const CreatePrivilegeCriteriaRequestV2025OperatorV2025 = { - And: 'AND', - Or: 'OR' -} as const; - -export type CreatePrivilegeCriteriaRequestV2025OperatorV2025 = typeof CreatePrivilegeCriteriaRequestV2025OperatorV2025[keyof typeof CreatePrivilegeCriteriaRequestV2025OperatorV2025]; -export const CreatePrivilegeCriteriaRequestV2025PrivilegeLevelV2025 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type CreatePrivilegeCriteriaRequestV2025PrivilegeLevelV2025 = typeof CreatePrivilegeCriteriaRequestV2025PrivilegeLevelV2025[keyof typeof CreatePrivilegeCriteriaRequestV2025PrivilegeLevelV2025]; - -/** - * - * @export - * @interface CreateSavedSearchRequestV2025 - */ -export interface CreateSavedSearchRequestV2025 { - /** - * The name of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2025 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2025 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2025 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2025 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof CreateSavedSearchRequestV2025 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2025 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof CreateSavedSearchRequestV2025 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof CreateSavedSearchRequestV2025 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2025 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof CreateSavedSearchRequestV2025 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2025} - * @memberof CreateSavedSearchRequestV2025 - */ - 'filters'?: SavedSearchDetailFiltersV2025 | null; -} -/** - * - * @export - * @interface CreateScheduleRequestV2025 - */ -export interface CreateScheduleRequestV2025 { - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof CreateScheduleRequestV2025 - */ - 'taskTypeName'?: string | null; - /** - * The scheduling type, such as \"Daily\", \"Weekly\" etc. - * @type {string} - * @memberof CreateScheduleRequestV2025 - */ - 'scheduleType'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof CreateScheduleRequestV2025 - */ - 'interval'?: number | null; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof CreateScheduleRequestV2025 - */ - 'scheduleTaskName'?: string | null; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof CreateScheduleRequestV2025 - */ - 'startTime'?: number; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof CreateScheduleRequestV2025 - */ - 'endTime'?: number; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof CreateScheduleRequestV2025 - */ - 'daysOfWeek'?: Array | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof CreateScheduleRequestV2025 - */ - 'active'?: boolean; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof CreateScheduleRequestV2025 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof CreateScheduleRequestV2025 - */ - 'applicationId'?: number | null; -} -/** - * - * @export - * @interface CreateScheduledSearchRequestV2025 - */ -export interface CreateScheduledSearchRequestV2025 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2025} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'schedule': Schedule2V2025; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2025 - */ - 'displayQueryDetails'?: boolean; -} -/** - * Full delivery configuration. method and endpoint_url are required. - * @export - * @interface CreateStreamDeliveryRequestV2025 - */ -export interface CreateStreamDeliveryRequestV2025 { - /** - * Delivery method (only push is supported). - * @type {string} - * @memberof CreateStreamDeliveryRequestV2025 - */ - 'method': string; - /** - * Receiver endpoint URL for push delivery. - * @type {string} - * @memberof CreateStreamDeliveryRequestV2025 - */ - 'endpoint_url': string; - /** - * Authorization header value for delivery requests. - * @type {string} - * @memberof CreateStreamDeliveryRequestV2025 - */ - 'authorization_header'?: string; -} -/** - * Request body for POST /ssf/streams (create stream). - * @export - * @interface CreateStreamRequestV2025 - */ -export interface CreateStreamRequestV2025 { - /** - * - * @type {CreateStreamDeliveryRequestV2025} - * @memberof CreateStreamRequestV2025 - */ - 'delivery': CreateStreamDeliveryRequestV2025; - /** - * Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof CreateStreamRequestV2025 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof CreateStreamRequestV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface CreateUploadedConfigurationRequestV2025 - */ -export interface CreateUploadedConfigurationRequestV2025 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof CreateUploadedConfigurationRequestV2025 - */ - 'data': File; - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof CreateUploadedConfigurationRequestV2025 - */ - 'name': string; -} -/** - * - * @export - * @interface CreateWorkflowRequestV2025 - */ -export interface CreateWorkflowRequestV2025 { - /** - * The name of the workflow - * @type {string} - * @memberof CreateWorkflowRequestV2025 - */ - 'name': string; - /** - * - * @type {WorkflowBodyOwnerV2025} - * @memberof CreateWorkflowRequestV2025 - */ - 'owner'?: WorkflowBodyOwnerV2025; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof CreateWorkflowRequestV2025 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2025} - * @memberof CreateWorkflowRequestV2025 - */ - 'definition'?: WorkflowDefinitionV2025; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof CreateWorkflowRequestV2025 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2025} - * @memberof CreateWorkflowRequestV2025 - */ - 'trigger'?: WorkflowTriggerV2025; -} -/** - * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. - * @export - * @enum {string} - */ - -export const CriteriaTypeV2025 = { - Composite: 'COMPOSITE', - Role: 'ROLE', - Identity: 'IDENTITY', - IdentityAttribute: 'IDENTITY_ATTRIBUTE', - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Source: 'SOURCE', - Account: 'ACCOUNT', - AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', - InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', - InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' -} as const; - -export type CriteriaTypeV2025 = typeof CriteriaTypeV2025[keyof typeof CriteriaTypeV2025]; - - -/** - * - * @export - * @interface CustomPasswordInstructionV2025 - */ -export interface CustomPasswordInstructionV2025 { - /** - * The page ID that represents the page for forget user name, reset password and unlock account flow. - * @type {string} - * @memberof CustomPasswordInstructionV2025 - */ - 'pageId'?: CustomPasswordInstructionV2025PageIdV2025; - /** - * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. - * @type {string} - * @memberof CustomPasswordInstructionV2025 - */ - 'pageContent'?: string; - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionV2025 - */ - 'locale'?: string; -} - -export const CustomPasswordInstructionV2025PageIdV2025 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; - -export type CustomPasswordInstructionV2025PageIdV2025 = typeof CustomPasswordInstructionV2025PageIdV2025[keyof typeof CustomPasswordInstructionV2025PageIdV2025]; - -/** - * - * @export - * @interface DataAccessCategoriesInnerV2025 - */ -export interface DataAccessCategoriesInnerV2025 { - /** - * Value of the category - * @type {string} - * @memberof DataAccessCategoriesInnerV2025 - */ - 'value'?: string; - /** - * Number of matched for each category - * @type {number} - * @memberof DataAccessCategoriesInnerV2025 - */ - 'matchCount'?: number; -} -/** - * - * @export - * @interface DataAccessImpactScoreV2025 - */ -export interface DataAccessImpactScoreV2025 { - /** - * Impact Score for this data - * @type {string} - * @memberof DataAccessImpactScoreV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface DataAccessPoliciesInnerV2025 - */ -export interface DataAccessPoliciesInnerV2025 { - /** - * Value of the policy - * @type {string} - * @memberof DataAccessPoliciesInnerV2025 - */ - 'value'?: string; -} -/** - * DAS data for the entitlement - * @export - * @interface DataAccessV2025 - */ -export interface DataAccessV2025 { - /** - * List of classification policies that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2025 - */ - 'policies'?: Array; - /** - * List of classification categories that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2025 - */ - 'categories'?: Array; - /** - * - * @type {DataAccessImpactScoreV2025} - * @memberof DataAccessV2025 - */ - 'impactScore'?: DataAccessImpactScoreV2025; -} -/** - * - * @export - * @interface DataClassificationSettingsV2025 - */ -export interface DataClassificationSettingsV2025 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof DataClassificationSettingsV2025 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof DataClassificationSettingsV2025 - */ - 'clusterId'?: string | null; -} -/** - * - * @export - * @interface DataOwnerModelV2025 - */ -export interface DataOwnerModelV2025 { - /** - * The unique identifier (UUID) of the identity assigned as the owner of the resource. - * @type {string} - * @memberof DataOwnerModelV2025 - */ - 'identityId'?: string; - /** - * The unique identifier of the resource owned by the identity. - * @type {number} - * @memberof DataOwnerModelV2025 - */ - 'resourceId'?: number; - /** - * The full path to the resource within the system or application. - * @type {string} - * @memberof DataOwnerModelV2025 - */ - 'fullPath'?: string | null; -} -/** - * - * @export - * @interface DataSegmentV2025 - */ -export interface DataSegmentV2025 { - /** - * The segment\'s ID. - * @type {string} - * @memberof DataSegmentV2025 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof DataSegmentV2025 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof DataSegmentV2025 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof DataSegmentV2025 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof DataSegmentV2025 - */ - 'description'?: string; - /** - * List of Scopes that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2025 - */ - 'scopes'?: Array; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2025 - */ - 'memberSelection'?: Array; - /** - * - * @type {VisibilityCriteriaV2025} - * @memberof DataSegmentV2025 - */ - 'memberFilter'?: VisibilityCriteriaV2025; - /** - * - * @type {MembershipTypeV2025} - * @memberof DataSegmentV2025 - */ - 'membership'?: MembershipTypeV2025; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentV2025 - */ - 'enabled'?: boolean; - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published - * @type {boolean} - * @memberof DataSegmentV2025 - */ - 'published'?: boolean; -} - - -/** - * @type DateCompareFirstDateV2025 - * This is the first date to consider (The date that would be on the left hand side of the comparison operation). - * @export - */ -export type DateCompareFirstDateV2025 = AccountAttributeV2025 | DateFormatV2025; - -/** - * @type DateCompareSecondDateV2025 - * This is the second date to consider (The date that would be on the right hand side of the comparison operation). - * @export - */ -export type DateCompareSecondDateV2025 = AccountAttributeV2025 | DateFormatV2025; - -/** - * - * @export - * @interface DateCompareV2025 - */ -export interface DateCompareV2025 { - /** - * - * @type {DateCompareFirstDateV2025} - * @memberof DateCompareV2025 - */ - 'firstDate': DateCompareFirstDateV2025; - /** - * - * @type {DateCompareSecondDateV2025} - * @memberof DateCompareV2025 - */ - 'secondDate': DateCompareSecondDateV2025; - /** - * This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | - * @type {string} - * @memberof DateCompareV2025 - */ - 'operator': DateCompareV2025OperatorV2025; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof DateCompareV2025 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof DateCompareV2025 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateCompareV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateCompareV2025 - */ - 'input'?: { [key: string]: any; }; -} - -export const DateCompareV2025OperatorV2025 = { - Lt: 'LT', - Lte: 'LTE', - Gt: 'GT', - Gte: 'GTE' -} as const; - -export type DateCompareV2025OperatorV2025 = typeof DateCompareV2025OperatorV2025[keyof typeof DateCompareV2025OperatorV2025]; - -/** - * @type DateFormatInputFormatV2025 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatInputFormatV2025 = NamedConstructsV2025 | string; - -/** - * @type DateFormatOutputFormatV2025 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatOutputFormatV2025 = NamedConstructsV2025 | string; - -/** - * - * @export - * @interface DateFormatV2025 - */ -export interface DateFormatV2025 { - /** - * - * @type {DateFormatInputFormatV2025} - * @memberof DateFormatV2025 - */ - 'inputFormat'?: DateFormatInputFormatV2025; - /** - * - * @type {DateFormatOutputFormatV2025} - * @memberof DateFormatV2025 - */ - 'outputFormat'?: DateFormatOutputFormatV2025; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateFormatV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateFormatV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DateMathV2025 - */ -export interface DateMathV2025 { - /** - * A string value of the date and time components to operation on, along with the math operations to execute. - * @type {string} - * @memberof DateMathV2025 - */ - 'expression': string; - /** - * A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - * @type {boolean} - * @memberof DateMathV2025 - */ - 'roundUp'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateMathV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateMathV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DecomposeDiacriticalMarksV2025 - */ -export interface DecomposeDiacriticalMarksV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DecomposeDiacriticalMarksV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DecomposeDiacriticalMarksV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DeleteNonEmployeeRecordsInBulkRequestV2025 - */ -export interface DeleteNonEmployeeRecordsInBulkRequestV2025 { - /** - * List of non-employee ids. - * @type {Array} - * @memberof DeleteNonEmployeeRecordsInBulkRequestV2025 - */ - 'ids': Array; -} -/** - * - * @export - * @interface DeleteSource202ResponseV2025 - */ -export interface DeleteSource202ResponseV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof DeleteSource202ResponseV2025 - */ - 'type'?: DeleteSource202ResponseV2025TypeV2025; - /** - * Task result ID. - * @type {string} - * @memberof DeleteSource202ResponseV2025 - */ - 'id'?: string; - /** - * Task result\'s human-readable display name (this should be null/empty). - * @type {string} - * @memberof DeleteSource202ResponseV2025 - */ - 'name'?: string; -} - -export const DeleteSource202ResponseV2025TypeV2025 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type DeleteSource202ResponseV2025TypeV2025 = typeof DeleteSource202ResponseV2025TypeV2025[keyof typeof DeleteSource202ResponseV2025TypeV2025]; - -/** - * Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated. - * @export - * @interface DeliveryRequestV2025 - */ -export interface DeliveryRequestV2025 { - /** - * Delivery method (optional for PATCH). - * @type {string} - * @memberof DeliveryRequestV2025 - */ - 'method'?: string; - /** - * Receiver endpoint URL (optional for PATCH). - * @type {string} - * @memberof DeliveryRequestV2025 - */ - 'endpoint_url'?: string; - /** - * Optional authorization header value. - * @type {string} - * @memberof DeliveryRequestV2025 - */ - 'authorization_header'?: string; -} -/** - * Delivery configuration returned in stream responses. - * @export - * @interface DeliveryResponseV2025 - */ -export interface DeliveryResponseV2025 { - /** - * Delivery method. - * @type {string} - * @memberof DeliveryResponseV2025 - */ - 'method'?: string; - /** - * Receiver endpoint URL. - * @type {string} - * @memberof DeliveryResponseV2025 - */ - 'endpoint_url'?: string; -} -/** - * - * @export - * @interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2025 - */ -export interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2025 { - /** - * DTO type - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2025 - */ - 'type'?: string; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2025 - */ - 'name'?: string; -} -/** - * The Account Source of the connected Application - * @export - * @interface DependantAppConnectionsAccountSourceV2025 - */ -export interface DependantAppConnectionsAccountSourceV2025 { - /** - * Use this Account Source for password management - * @type {boolean} - * @memberof DependantAppConnectionsAccountSourceV2025 - */ - 'useForPasswordManagement'?: boolean; - /** - * A list of Password Policies for this Account Source - * @type {Array} - * @memberof DependantAppConnectionsAccountSourceV2025 - */ - 'passwordPolicies'?: Array; -} -/** - * - * @export - * @interface DependantAppConnectionsV2025 - */ -export interface DependantAppConnectionsV2025 { - /** - * Id of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2025 - */ - 'cloudAppId'?: string; - /** - * Description of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2025 - */ - 'description'?: string; - /** - * Is the Application enabled - * @type {boolean} - * @memberof DependantAppConnectionsV2025 - */ - 'enabled'?: boolean; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2025 - */ - 'provisionRequestEnabled'?: boolean; - /** - * - * @type {DependantAppConnectionsAccountSourceV2025} - * @memberof DependantAppConnectionsV2025 - */ - 'accountSource'?: DependantAppConnectionsAccountSourceV2025; - /** - * The amount of launchers for connected Application (long type) - * @type {number} - * @memberof DependantAppConnectionsV2025 - */ - 'launcherCount'?: number; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2025 - */ - 'matchAllAccount'?: boolean; - /** - * The owner of the connected Application - * @type {Array} - * @memberof DependantAppConnectionsV2025 - */ - 'owner'?: Array; - /** - * Is App Center enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2025 - */ - 'appCenterEnabled'?: boolean; -} -/** - * - * @export - * @interface DependantConnectionsMissingDtoV2025 - */ -export interface DependantConnectionsMissingDtoV2025 { - /** - * The type of dependency type that is missing in the SourceConnections - * @type {string} - * @memberof DependantConnectionsMissingDtoV2025 - */ - 'dependencyType'?: DependantConnectionsMissingDtoV2025DependencyTypeV2025; - /** - * The reason why this dependency is missing - * @type {string} - * @memberof DependantConnectionsMissingDtoV2025 - */ - 'reason'?: string; -} - -export const DependantConnectionsMissingDtoV2025DependencyTypeV2025 = { - IdentityProfiles: 'identityProfiles', - CredentialProfiles: 'credentialProfiles', - MappingProfiles: 'mappingProfiles', - SourceAttributes: 'sourceAttributes', - DependantCustomTransforms: 'dependantCustomTransforms', - DependantApps: 'dependantApps' -} as const; - -export type DependantConnectionsMissingDtoV2025DependencyTypeV2025 = typeof DependantConnectionsMissingDtoV2025DependencyTypeV2025[keyof typeof DependantConnectionsMissingDtoV2025DependencyTypeV2025]; - -/** - * - * @export - * @interface DeployRequestV2025 - */ -export interface DeployRequestV2025 { - /** - * The id of the draft to be used by this deploy. - * @type {string} - * @memberof DeployRequestV2025 - */ - 'draftId': string; -} -/** - * - * @export - * @interface DeployResponseV2025 - */ -export interface DeployResponseV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'status'?: DeployResponseV2025StatusV2025; - /** - * Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'type'?: DeployResponseV2025TypeV2025; - /** - * Message providing information about the outcome of the deploy process. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'message'?: string; - /** - * The name of the user that initiated the deploy process. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'requesterName'?: string; - /** - * Whether or not a results file was created and stored for this deploy. - * @type {boolean} - * @memberof DeployResponseV2025 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'completed'?: string; - /** - * The id of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'draftId'?: string; - /** - * The name of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'draftName'?: string; - /** - * Whether this deploy results file has been transferred to a customer storage location. - * @type {string} - * @memberof DeployResponseV2025 - */ - 'cloudStorageStatus'?: DeployResponseV2025CloudStorageStatusV2025; -} - -export const DeployResponseV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DeployResponseV2025StatusV2025 = typeof DeployResponseV2025StatusV2025[keyof typeof DeployResponseV2025StatusV2025]; -export const DeployResponseV2025TypeV2025 = { - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type DeployResponseV2025TypeV2025 = typeof DeployResponseV2025TypeV2025[keyof typeof DeployResponseV2025TypeV2025]; -export const DeployResponseV2025CloudStorageStatusV2025 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type DeployResponseV2025CloudStorageStatusV2025 = typeof DeployResponseV2025CloudStorageStatusV2025[keyof typeof DeployResponseV2025CloudStorageStatusV2025]; - -/** - * A dimension attribute - * @export - * @interface DimensionAttributeV2025 - */ -export interface DimensionAttributeV2025 { - /** - * Name of the attribute - * @type {string} - * @memberof DimensionAttributeV2025 - */ - 'name'?: string; - /** - * Display name of the attribute - * @type {string} - * @memberof DimensionAttributeV2025 - */ - 'displayName'?: string; - /** - * If an attribute is derived, its value comes from the identity. Otherwise, it can be provided with access request - * @type {boolean} - * @memberof DimensionAttributeV2025 - */ - 'derived'?: boolean; -} -/** - * - * @export - * @interface DimensionBulkDeleteRequestV2025 - */ -export interface DimensionBulkDeleteRequestV2025 { - /** - * List of IDs of Dimensions to be deleted. - * @type {Array} - * @memberof DimensionBulkDeleteRequestV2025 - */ - 'dimensionIds': Array; -} -/** - * Indicates whether the associated criteria represents an expression on identity attributes. - * @export - * @enum {string} - */ - -export const DimensionCriteriaKeyTypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type DimensionCriteriaKeyTypeV2025 = typeof DimensionCriteriaKeyTypeV2025[keyof typeof DimensionCriteriaKeyTypeV2025]; - - -/** - * Refers to a specific Identity attribute used in Dimension membership criteria. - * @export - * @interface DimensionCriteriaKeyV2025 - */ -export interface DimensionCriteriaKeyV2025 { - /** - * - * @type {DimensionCriteriaKeyTypeV2025} - * @memberof DimensionCriteriaKeyV2025 - */ - 'type': DimensionCriteriaKeyTypeV2025; - /** - * The name of the identity attribute to which the associated criteria applies. - * @type {string} - * @memberof DimensionCriteriaKeyV2025 - */ - 'property': string; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel1V2025 - */ -export interface DimensionCriteriaLevel1V2025 { - /** - * - * @type {DimensionCriteriaOperationV2025} - * @memberof DimensionCriteriaLevel1V2025 - */ - 'operation'?: DimensionCriteriaOperationV2025; - /** - * - * @type {DimensionCriteriaKeyV2025} - * @memberof DimensionCriteriaLevel1V2025 - */ - 'key'?: DimensionCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel1V2025 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel1V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface DimensionCriteriaLevel2V2025 - */ -export interface DimensionCriteriaLevel2V2025 { - /** - * - * @type {DimensionCriteriaOperationV2025} - * @memberof DimensionCriteriaLevel2V2025 - */ - 'operation'?: DimensionCriteriaOperationV2025; - /** - * - * @type {DimensionCriteriaKeyV2025} - * @memberof DimensionCriteriaLevel2V2025 - */ - 'key'?: DimensionCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel2V2025 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel2V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel3V2025 - */ -export interface DimensionCriteriaLevel3V2025 { - /** - * - * @type {DimensionCriteriaOperationV2025} - * @memberof DimensionCriteriaLevel3V2025 - */ - 'operation'?: DimensionCriteriaOperationV2025; - /** - * - * @type {DimensionCriteriaKeyV2025} - * @memberof DimensionCriteriaLevel3V2025 - */ - 'key'?: DimensionCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel3V2025 - */ - 'stringValue'?: string; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const DimensionCriteriaOperationV2025 = { - Equals: 'EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type DimensionCriteriaOperationV2025 = typeof DimensionCriteriaOperationV2025[keyof typeof DimensionCriteriaOperationV2025]; - - -/** - * This enum characterizes the type of a Dimension\'s membership selector. Only the STANDARD type supported: STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression - * @export - * @enum {string} - */ - -export const DimensionMembershipSelectorTypeV2025 = { - Standard: 'STANDARD' -} as const; - -export type DimensionMembershipSelectorTypeV2025 = typeof DimensionMembershipSelectorTypeV2025[keyof typeof DimensionMembershipSelectorTypeV2025]; - - -/** - * When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. - * @export - * @interface DimensionMembershipSelectorV2025 - */ -export interface DimensionMembershipSelectorV2025 { - /** - * - * @type {DimensionMembershipSelectorTypeV2025} - * @memberof DimensionMembershipSelectorV2025 - */ - 'type'?: DimensionMembershipSelectorTypeV2025; - /** - * - * @type {DimensionCriteriaLevel1V2025} - * @memberof DimensionMembershipSelectorV2025 - */ - 'criteria'?: DimensionCriteriaLevel1V2025 | null; -} - - -/** - * - * @export - * @interface DimensionRefV2025 - */ -export interface DimensionRefV2025 { - /** - * The type of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2025 - */ - 'type'?: DimensionRefV2025TypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2025 - */ - 'name'?: string; -} - -export const DimensionRefV2025TypeV2025 = { - Dimension: 'DIMENSION' -} as const; - -export type DimensionRefV2025TypeV2025 = typeof DimensionRefV2025TypeV2025[keyof typeof DimensionRefV2025TypeV2025]; - -/** - * Contains a list of dimension attributes. Required only for Dynamic Roles - * @export - * @interface DimensionSchemaV2025 - */ -export interface DimensionSchemaV2025 { - /** - * - * @type {Array} - * @memberof DimensionSchemaV2025 - */ - 'dimensionAttributes'?: Array; -} -/** - * A Dimension - * @export - * @interface DimensionV2025 - */ -export interface DimensionV2025 { - /** - * The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof DimensionV2025 - */ - 'id'?: string; - /** - * The human-readable display name of the Dimension - * @type {string} - * @memberof DimensionV2025 - */ - 'name': string; - /** - * Date the Dimension was created - * @type {string} - * @memberof DimensionV2025 - */ - 'created'?: string; - /** - * Date the Dimension was last modified. - * @type {string} - * @memberof DimensionV2025 - */ - 'modified'?: string; - /** - * A human-readable description of the Dimension - * @type {string} - * @memberof DimensionV2025 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2025} - * @memberof DimensionV2025 - */ - 'owner': OwnerReferenceV2025 | null; - /** - * - * @type {Array} - * @memberof DimensionV2025 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof DimensionV2025 - */ - 'entitlements'?: Array; - /** - * - * @type {DimensionMembershipSelectorV2025} - * @memberof DimensionV2025 - */ - 'membership'?: DimensionMembershipSelectorV2025 | null; - /** - * The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. - * @type {string} - * @memberof DimensionV2025 - */ - 'parentId'?: string | null; -} -/** - * - * @export - * @interface DisplayReferenceV2025 - */ -export interface DisplayReferenceV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof DisplayReferenceV2025 - */ - 'displayName'?: string; -} -/** - * DKIM attributes for a domain or identity - * @export - * @interface DkimAttributesV2025 - */ -export interface DkimAttributesV2025 { - /** - * UUID associated with domain to be verified - * @type {string} - * @memberof DkimAttributesV2025 - */ - 'id'?: string; - /** - * The identity or domain address - * @type {string} - * @memberof DkimAttributesV2025 - */ - 'address'?: string; - /** - * Whether or not DKIM has been enabled for this domain / identity - * @type {boolean} - * @memberof DkimAttributesV2025 - */ - 'dkimEnabled'?: boolean; - /** - * The tokens to be added to a DNS for verification - * @type {Array} - * @memberof DkimAttributesV2025 - */ - 'dkimTokens'?: Array; - /** - * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING - * @type {string} - * @memberof DkimAttributesV2025 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DkimAttributesV2025 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DocumentFieldsV2025 - */ -export interface DocumentFieldsV2025 { - /** - * Name of the pod. - * @type {string} - * @memberof DocumentFieldsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof DocumentFieldsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof DocumentFieldsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof DocumentFieldsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof DocumentFieldsV2025 - */ - '_version'?: string; -} - - -/** - * Enum representing the currently supported document types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const DocumentTypeV2025 = { - Accessprofile: 'accessprofile', - Accountactivity: 'accountactivity', - Entitlement: 'entitlement', - Event: 'event', - Identity: 'identity', - Role: 'role' -} as const; - -export type DocumentTypeV2025 = typeof DocumentTypeV2025[keyof typeof DocumentTypeV2025]; - - -/** - * - * @export - * @interface DomainAddressV2025 - */ -export interface DomainAddressV2025 { - /** - * A domain address - * @type {string} - * @memberof DomainAddressV2025 - */ - 'domain'?: string; -} -/** - * Domain status DTO containing everything required to verify via DKIM - * @export - * @interface DomainStatusDtoV2025 - */ -export interface DomainStatusDtoV2025 { - /** - * New UUID associated with domain to be verified - * @type {string} - * @memberof DomainStatusDtoV2025 - */ - 'id'?: string; - /** - * A domain address - * @type {string} - * @memberof DomainStatusDtoV2025 - */ - 'domain'?: string; - /** - * DKIM is enabled for this domain - * @type {boolean} - * @memberof DomainStatusDtoV2025 - */ - 'dkimEnabled'?: boolean; - /** - * DKIM tokens required for authentication - * @type {Array} - * @memberof DomainStatusDtoV2025 - */ - 'dkimTokens'?: Array; - /** - * Status of DKIM authentication - * @type {string} - * @memberof DomainStatusDtoV2025 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DomainStatusDtoV2025 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DraftResponseV2025 - */ -export interface DraftResponseV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'status'?: DraftResponseV2025StatusV2025; - /** - * Type of the job, will always be CREATE_DRAFT for this type of job. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'type'?: DraftResponseV2025TypeV2025; - /** - * Message providing information about the outcome of the draft process. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'message'?: string; - /** - * The name of user that that initiated the draft process. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'requesterName'?: string; - /** - * Whether or not a file was generated for this draft. - * @type {boolean} - * @memberof DraftResponseV2025 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'completed'?: string; - /** - * Name of the draft. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'name'?: string; - /** - * Tenant owner of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'sourceTenant'?: string; - /** - * Id of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'sourceBackupId'?: string; - /** - * Name of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'sourceBackupName'?: string; - /** - * Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'mode'?: DraftResponseV2025ModeV2025; - /** - * Approval status of the draft used to determine whether or not the draft can be deployed. - * @type {string} - * @memberof DraftResponseV2025 - */ - 'approvalStatus'?: DraftResponseV2025ApprovalStatusV2025; - /** - * List of comments that have been exchanged between an approval requester and an approver. - * @type {Array} - * @memberof DraftResponseV2025 - */ - 'approvalComment'?: Array; -} - -export const DraftResponseV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DraftResponseV2025StatusV2025 = typeof DraftResponseV2025StatusV2025[keyof typeof DraftResponseV2025StatusV2025]; -export const DraftResponseV2025TypeV2025 = { - CreateDraft: 'CREATE_DRAFT' -} as const; - -export type DraftResponseV2025TypeV2025 = typeof DraftResponseV2025TypeV2025[keyof typeof DraftResponseV2025TypeV2025]; -export const DraftResponseV2025ModeV2025 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type DraftResponseV2025ModeV2025 = typeof DraftResponseV2025ModeV2025[keyof typeof DraftResponseV2025ModeV2025]; -export const DraftResponseV2025ApprovalStatusV2025 = { - Default: 'DEFAULT', - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type DraftResponseV2025ApprovalStatusV2025 = typeof DraftResponseV2025ApprovalStatusV2025[keyof typeof DraftResponseV2025ApprovalStatusV2025]; - -/** - * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - * @export - * @enum {string} - */ - -export const DtoTypeV2025 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', - AccessProfile: 'ACCESS_PROFILE', - AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', - Account: 'ACCOUNT', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - CampaignFilter: 'CAMPAIGN_FILTER', - Certification: 'CERTIFICATION', - Cluster: 'CLUSTER', - ConnectorSchema: 'CONNECTOR_SCHEMA', - Entitlement: 'ENTITLEMENT', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityProfile: 'IDENTITY_PROFILE', - IdentityRequest: 'IDENTITY_REQUEST', - MachineIdentity: 'MACHINE_IDENTITY', - LifecycleState: 'LIFECYCLE_STATE', - PasswordPolicy: 'PASSWORD_POLICY', - Role: 'ROLE', - Rule: 'RULE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - TagCategory: 'TAG_CATEGORY', - TaskResult: 'TASK_RESULT', - ReportResult: 'REPORT_RESULT', - SodViolation: 'SOD_VIOLATION', - AccountActivity: 'ACCOUNT_ACTIVITY', - Workgroup: 'WORKGROUP' -} as const; - -export type DtoTypeV2025 = typeof DtoTypeV2025[keyof typeof DtoTypeV2025]; - - -/** - * - * @export - * @interface E164phoneV2025 - */ -export interface E164phoneV2025 { - /** - * This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - * @type {string} - * @memberof E164phoneV2025 - */ - 'defaultRegion'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof E164phoneV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof E164phoneV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * This is used for representing email configuration for a lifecycle state - * @export - * @interface EmailNotificationOptionV2025 - */ -export interface EmailNotificationOptionV2025 { - /** - * If true, then the manager is notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2025 - */ - 'notifyManagers'?: boolean; - /** - * If true, then all the admins are notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2025 - */ - 'notifyAllAdmins'?: boolean; - /** - * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2025 - */ - 'notifySpecificUsers'?: boolean; - /** - * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. - * @type {Array} - * @memberof EmailNotificationOptionV2025 - */ - 'emailAddressList'?: Array; -} -/** - * - * @export - * @interface EmailStatusDtoV2025 - */ -export interface EmailStatusDtoV2025 { - /** - * Unique identifier for the verified sender address - * @type {string} - * @memberof EmailStatusDtoV2025 - */ - 'id'?: string | null; - /** - * The verified sender email address - * @type {string} - * @memberof EmailStatusDtoV2025 - */ - 'email'?: string; - /** - * Whether the sender address is verified by domain - * @type {boolean} - * @memberof EmailStatusDtoV2025 - */ - 'isVerifiedByDomain'?: boolean; - /** - * The verification status of the sender address - * @type {string} - * @memberof EmailStatusDtoV2025 - */ - 'verificationStatus'?: EmailStatusDtoV2025VerificationStatusV2025; - /** - * The AWS SES region the sender address is associated with - * @type {string} - * @memberof EmailStatusDtoV2025 - */ - 'region'?: string | null; -} - -export const EmailStatusDtoV2025VerificationStatusV2025 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Na: 'NA' -} as const; - -export type EmailStatusDtoV2025VerificationStatusV2025 = typeof EmailStatusDtoV2025VerificationStatusV2025[keyof typeof EmailStatusDtoV2025VerificationStatusV2025]; - -/** - * Additional data to classify the entitlement - * @export - * @interface EntitlementAccessModelMetadataV2025 - */ -export interface EntitlementAccessModelMetadataV2025 { - /** - * - * @type {Array} - * @memberof EntitlementAccessModelMetadataV2025 - */ - 'attributes'?: Array; -} -/** - * - * @export - * @interface EntitlementAccessRequestConfigV2025 - */ -export interface EntitlementAccessRequestConfigV2025 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'approvalSchemes'?: Array; - /** - * If the requester must provide a comment during access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'requestCommentRequired'?: boolean; - /** - * If the reviewer must provide a comment when denying the access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'denialCommentRequired'?: boolean; - /** - * Is Reauthorization Required - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'reauthorizationRequired'?: boolean; - /** - * If true, then remove date or sunset date is required in access request of the entitlement. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2025} - * @memberof EntitlementAccessRequestConfigV2025 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2025 | null; -} -/** - * - * @export - * @interface EntitlementApprovalSchemeV2025 - */ -export interface EntitlementApprovalSchemeV2025 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. - * @type {string} - * @memberof EntitlementApprovalSchemeV2025 - */ - 'approverType'?: EntitlementApprovalSchemeV2025ApproverTypeV2025; - /** - * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW - * @type {string} - * @memberof EntitlementApprovalSchemeV2025 - */ - 'approverId'?: string | null; -} - -export const EntitlementApprovalSchemeV2025ApproverTypeV2025 = { - EntitlementOwner: 'ENTITLEMENT_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW' -} as const; - -export type EntitlementApprovalSchemeV2025ApproverTypeV2025 = typeof EntitlementApprovalSchemeV2025ApproverTypeV2025[keyof typeof EntitlementApprovalSchemeV2025ApproverTypeV2025]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateFilterRequestV2025 - */ -export interface EntitlementAttributeBulkUpdateFilterRequestV2025 { - /** - * 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* - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2025 - */ - 'filters'?: string; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2025 - */ - 'operation'?: EntitlementAttributeBulkUpdateFilterRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2025 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateFilterRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2025 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateFilterRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateFilterRequestV2025OperationV2025 = typeof EntitlementAttributeBulkUpdateFilterRequestV2025OperationV2025[keyof typeof EntitlementAttributeBulkUpdateFilterRequestV2025OperationV2025]; -export const EntitlementAttributeBulkUpdateFilterRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateFilterRequestV2025ReplaceScopeV2025 = typeof EntitlementAttributeBulkUpdateFilterRequestV2025ReplaceScopeV2025[keyof typeof EntitlementAttributeBulkUpdateFilterRequestV2025ReplaceScopeV2025]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateIdsRequestV2025 - */ -export interface EntitlementAttributeBulkUpdateIdsRequestV2025 { - /** - * List of entitlement IDs to update. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2025 - */ - 'entitlements'?: Array; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2025 - */ - 'operation'?: EntitlementAttributeBulkUpdateIdsRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2025 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateIdsRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2025 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateIdsRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateIdsRequestV2025OperationV2025 = typeof EntitlementAttributeBulkUpdateIdsRequestV2025OperationV2025[keyof typeof EntitlementAttributeBulkUpdateIdsRequestV2025OperationV2025]; -export const EntitlementAttributeBulkUpdateIdsRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateIdsRequestV2025ReplaceScopeV2025 = typeof EntitlementAttributeBulkUpdateIdsRequestV2025ReplaceScopeV2025[keyof typeof EntitlementAttributeBulkUpdateIdsRequestV2025ReplaceScopeV2025]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateQueryRequestV2025 - */ -export interface EntitlementAttributeBulkUpdateQueryRequestV2025 { - /** - * - * @type {SearchV2025} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2025 - */ - 'query'?: SearchV2025; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2025 - */ - 'operation'?: EntitlementAttributeBulkUpdateQueryRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2025 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateQueryRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2025 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateQueryRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateQueryRequestV2025OperationV2025 = typeof EntitlementAttributeBulkUpdateQueryRequestV2025OperationV2025[keyof typeof EntitlementAttributeBulkUpdateQueryRequestV2025OperationV2025]; -export const EntitlementAttributeBulkUpdateQueryRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateQueryRequestV2025ReplaceScopeV2025 = typeof EntitlementAttributeBulkUpdateQueryRequestV2025ReplaceScopeV2025[keyof typeof EntitlementAttributeBulkUpdateQueryRequestV2025ReplaceScopeV2025]; - -/** - * Object for specifying the bulk update request - * @export - * @interface EntitlementBulkUpdateRequestV2025 - */ -export interface EntitlementBulkUpdateRequestV2025 { - /** - * List of entitlement ids to update - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2025 - */ - 'entitlementIds': Array; - /** - * - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2025 - */ - 'jsonPatch': Array; -} -/** - * Indicates whether the entitlement\'s display name and/or description have been manually updated. - * @export - * @interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 - */ -export interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 { - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 - */ - 'DESCRIPTION'?: boolean; - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 - */ - 'DISPLAY_NAME'?: boolean; -} -/** - * - * @export - * @interface EntitlementDocumentAllOfPermissionsV2025 - */ -export interface EntitlementDocumentAllOfPermissionsV2025 { - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof EntitlementDocumentAllOfPermissionsV2025 - */ - 'target'?: string; - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof EntitlementDocumentAllOfPermissionsV2025 - */ - 'rights'?: Array; -} -/** - * Entitlement\'s source. - * @export - * @interface EntitlementDocumentAllOfSourceV2025 - */ -export interface EntitlementDocumentAllOfSourceV2025 { - /** - * ID of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2025 - */ - 'id'?: string; - /** - * Display name of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2025 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2025 - */ - 'type'?: string; -} -/** - * Entitlement - * @export - * @interface EntitlementDocumentV2025 - */ -export interface EntitlementDocumentV2025 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2025} - * @memberof EntitlementDocumentV2025 - */ - 'source'?: EntitlementDocumentAllOfSourceV2025; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2025 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentV2025 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentV2025 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentV2025 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentV2025 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentV2025 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2025 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentV2025 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2025} - * @memberof EntitlementDocumentV2025 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentV2025 - */ - 'permissions'?: Array; -} -/** - * - * @export - * @interface EntitlementDocumentsV2025 - */ -export interface EntitlementDocumentsV2025 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2025} - * @memberof EntitlementDocumentsV2025 - */ - 'source'?: EntitlementDocumentAllOfSourceV2025; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2025 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentsV2025 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentsV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentsV2025 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentsV2025 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentsV2025 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentsV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2025 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentsV2025 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2025} - * @memberof EntitlementDocumentsV2025 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2025 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentsV2025 - */ - 'permissions'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof EntitlementDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof EntitlementDocumentsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof EntitlementDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * The identity that owns the entitlement - * @export - * @interface EntitlementOwnerV2025 - */ -export interface EntitlementOwnerV2025 { - /** - * The identity ID - * @type {string} - * @memberof EntitlementOwnerV2025 - */ - 'id'?: string; - /** - * The type of object - * @type {string} - * @memberof EntitlementOwnerV2025 - */ - 'type'?: EntitlementOwnerV2025TypeV2025; - /** - * The display name of the identity - * @type {string} - * @memberof EntitlementOwnerV2025 - */ - 'name'?: string; -} - -export const EntitlementOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type EntitlementOwnerV2025TypeV2025 = typeof EntitlementOwnerV2025TypeV2025[keyof typeof EntitlementOwnerV2025TypeV2025]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface EntitlementRefV2025 - */ -export interface EntitlementRefV2025 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof EntitlementRefV2025 - */ - 'type'?: EntitlementRefV2025TypeV2025; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof EntitlementRefV2025 - */ - 'id'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementRefV2025 - */ - 'name'?: string | null; -} - -export const EntitlementRefV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type EntitlementRefV2025TypeV2025 = typeof EntitlementRefV2025TypeV2025[keyof typeof EntitlementRefV2025TypeV2025]; - -/** - * - * @export - * @interface EntitlementRequestConfigV2025 - */ -export interface EntitlementRequestConfigV2025 { - /** - * - * @type {EntitlementAccessRequestConfigV2025} - * @memberof EntitlementRequestConfigV2025 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2025; - /** - * - * @type {EntitlementRevocationRequestConfigV2025} - * @memberof EntitlementRequestConfigV2025 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2025; -} -/** - * - * @export - * @interface EntitlementRevocationRequestConfigV2025 - */ -export interface EntitlementRevocationRequestConfigV2025 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementRevocationRequestConfigV2025 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface EntitlementSourceResetBaseReferenceDtoV2025 - */ -export interface EntitlementSourceResetBaseReferenceDtoV2025 { - /** - * The DTO type - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2025 - */ - 'type'?: string; - /** - * The task ID of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface EntitlementSourceV2025 - */ -export interface EntitlementSourceV2025 { - /** - * The source ID - * @type {string} - * @memberof EntitlementSourceV2025 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementSourceV2025 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementSourceV2025 - */ - 'name'?: string; -} -/** - * EntitlementReference - * @export - * @interface EntitlementSummaryV2025 - */ -export interface EntitlementSummaryV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2025} - * @memberof EntitlementSummaryV2025 - */ - 'source'?: Reference1V2025; - /** - * Type of the access item. - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2025 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2025 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2025 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface EntitlementV2025 - */ -export interface EntitlementV2025 { - /** - * The entitlement id - * @type {string} - * @memberof EntitlementV2025 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof EntitlementV2025 - */ - 'name'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof EntitlementV2025 - */ - 'attribute'?: string; - /** - * The value of the entitlement - * @type {string} - * @memberof EntitlementV2025 - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof EntitlementV2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof EntitlementV2025 - */ - 'description'?: string | null; - /** - * True if the entitlement is privileged - * @type {boolean} - * @memberof EntitlementV2025 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof EntitlementV2025 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement is able to be directly requested - * @type {boolean} - * @memberof EntitlementV2025 - */ - 'requestable'?: boolean; - /** - * - * @type {EntitlementOwnerV2025} - * @memberof EntitlementV2025 - */ - 'owner'?: EntitlementOwnerV2025 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof EntitlementV2025 - */ - 'additionalOwners'?: Array | null; - /** - * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2025 - */ - 'manuallyUpdatedFields'?: { [key: string]: any; } | null; - /** - * - * @type {EntitlementAccessModelMetadataV2025} - * @memberof EntitlementV2025 - */ - 'accessModelMetadata'?: EntitlementAccessModelMetadataV2025; - /** - * Time when the entitlement was created - * @type {string} - * @memberof EntitlementV2025 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof EntitlementV2025 - */ - 'modified'?: string; - /** - * - * @type {EntitlementSourceV2025} - * @memberof EntitlementV2025 - */ - 'source'?: EntitlementSourceV2025; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof EntitlementV2025 - */ - 'segments'?: Array | null; - /** - * - * @type {Array} - * @memberof EntitlementV2025 - */ - 'directPermissions'?: Array; -} -/** - * - * @export - * @interface EntityCreatedByDTOV2025 - */ -export interface EntityCreatedByDTOV2025 { - /** - * ID of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2025 - */ - 'id'?: string; - /** - * The display name of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2025 - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface ErrorMessageDtoV2025 - */ -export interface ErrorMessageDtoV2025 { - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof ErrorMessageDtoV2025 - */ - 'locale'?: string | null; - /** - * - * @type {LocaleOriginV2025} - * @memberof ErrorMessageDtoV2025 - */ - 'localeOrigin'?: LocaleOriginV2025 | null; - /** - * Actual text of the error message in the indicated locale. - * @type {string} - * @memberof ErrorMessageDtoV2025 - */ - 'text'?: string; -} - - -/** - * - * @export - * @interface ErrorMessageV2025 - */ -export interface ErrorMessageV2025 { - /** - * Locale is the current Locale - * @type {string} - * @memberof ErrorMessageV2025 - */ - 'locale'?: string; - /** - * LocaleOrigin holds possible values of how the locale was selected - * @type {string} - * @memberof ErrorMessageV2025 - */ - 'localeOrigin'?: string; - /** - * Text is the actual text of the error message - * @type {string} - * @memberof ErrorMessageV2025 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ErrorResponseDtoV2025 - */ -export interface ErrorResponseDtoV2025 { - /** - * Fine-grained error code providing more detail of the error. - * @type {string} - * @memberof ErrorResponseDtoV2025 - */ - 'detailCode'?: string; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof ErrorResponseDtoV2025 - */ - 'trackingId'?: string; - /** - * Generic localized reason for error - * @type {Array} - * @memberof ErrorResponseDtoV2025 - */ - 'messages'?: Array; - /** - * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - * @type {Array} - * @memberof ErrorResponseDtoV2025 - */ - 'causes'?: Array; -} -/** - * - * @export - * @interface ErrorV2025 - */ -export interface ErrorV2025 { - /** - * DetailCode is the text of the status code returned - * @type {string} - * @memberof ErrorV2025 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof ErrorV2025 - */ - 'messages'?: Array; - /** - * TrackingID is the request tracking unique identifier - * @type {string} - * @memberof ErrorV2025 - */ - 'trackingId'?: string; -} -/** - * The response body for Evaluate Reassignment Configuration - * @export - * @interface EvaluateResponseV2025 - */ -export interface EvaluateResponseV2025 { - /** - * The Identity ID which should be the recipient of any work items sent to a specific identity & work type - * @type {string} - * @memberof EvaluateResponseV2025 - */ - 'reassignToId'?: string; - /** - * List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration - * @type {Array} - * @memberof EvaluateResponseV2025 - */ - 'lookupTrail'?: Array; -} -/** - * - * @export - * @interface EventActorV2025 - */ -export interface EventActorV2025 { - /** - * Name of the actor that generated the event. - * @type {string} - * @memberof EventActorV2025 - */ - 'name'?: string; -} -/** - * Attributes related to an IdentityNow ETS event - * @export - * @interface EventAttributesV2025 - */ -export interface EventAttributesV2025 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof EventAttributesV2025 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof EventAttributesV2025 - */ - 'filter.$'?: string | null; - /** - * Description of the event trigger - * @type {string} - * @memberof EventAttributesV2025 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof EventAttributesV2025 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof EventAttributesV2025 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface EventBridgeConfigV2025 - */ -export interface EventBridgeConfigV2025 { - /** - * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. - * @type {string} - * @memberof EventBridgeConfigV2025 - */ - 'awsAccount': string; - /** - * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. - * @type {string} - * @memberof EventBridgeConfigV2025 - */ - 'awsRegion': string; -} -/** - * Event - * @export - * @interface EventDocumentV2025 - */ -export interface EventDocumentV2025 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'type'?: string; - /** - * - * @type {EventActorV2025} - * @memberof EventDocumentV2025 - */ - 'actor'?: EventActorV2025; - /** - * - * @type {EventTargetV2025} - * @memberof EventDocumentV2025 - */ - 'target'?: EventTargetV2025; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentV2025 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentV2025 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface EventDocumentsV2025 - */ -export interface EventDocumentsV2025 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'type'?: string; - /** - * - * @type {EventActorV2025} - * @memberof EventDocumentsV2025 - */ - 'actor'?: EventActorV2025; - /** - * - * @type {EventTargetV2025} - * @memberof EventDocumentsV2025 - */ - 'target'?: EventTargetV2025; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentsV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentsV2025 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'technicalName'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'pod'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof EventDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {string} - * @memberof EventDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface EventTargetV2025 - */ -export interface EventTargetV2025 { - /** - * Name of the target, or recipient, of the event. - * @type {string} - * @memberof EventTargetV2025 - */ - 'name'?: string; -} -/** - * Event - * @export - * @interface EventV2025 - */ -export interface EventV2025 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventV2025 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventV2025 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventV2025 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventV2025 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventV2025 - */ - 'type'?: string; - /** - * - * @type {EventActorV2025} - * @memberof EventV2025 - */ - 'actor'?: EventActorV2025; - /** - * - * @type {EventTargetV2025} - * @memberof EventV2025 - */ - 'target'?: EventTargetV2025; - /** - * The event\'s stack. - * @type {string} - * @memberof EventV2025 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventV2025 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventV2025 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventV2025 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventV2025 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventV2025 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventV2025 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventV2025 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface ExceptionAccessCriteriaV2025 - */ -export interface ExceptionAccessCriteriaV2025 { - /** - * - * @type {ExceptionCriteriaV2025} - * @memberof ExceptionAccessCriteriaV2025 - */ - 'leftCriteria'?: ExceptionCriteriaV2025; - /** - * - * @type {ExceptionCriteriaV2025} - * @memberof ExceptionAccessCriteriaV2025 - */ - 'rightCriteria'?: ExceptionCriteriaV2025; -} -/** - * Access reference with addition of boolean existing flag to indicate whether the access was extant - * @export - * @interface ExceptionCriteriaAccessV2025 - */ -export interface ExceptionCriteriaAccessV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof ExceptionCriteriaAccessV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2025 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaAccessV2025 - */ - 'existing'?: boolean; -} - - -/** - * The types of objects supported for SOD violations - * @export - * @interface ExceptionCriteriaCriteriaListInnerV2025 - */ -export interface ExceptionCriteriaCriteriaListInnerV2025 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ExceptionCriteriaCriteriaListInnerV2025 - */ - 'type'?: ExceptionCriteriaCriteriaListInnerV2025TypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2025 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaCriteriaListInnerV2025 - */ - 'existing'?: boolean; -} - -export const ExceptionCriteriaCriteriaListInnerV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ExceptionCriteriaCriteriaListInnerV2025TypeV2025 = typeof ExceptionCriteriaCriteriaListInnerV2025TypeV2025[keyof typeof ExceptionCriteriaCriteriaListInnerV2025TypeV2025]; - -/** - * - * @export - * @interface ExceptionCriteriaV2025 - */ -export interface ExceptionCriteriaV2025 { - /** - * List of exception criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof ExceptionCriteriaV2025 - */ - 'criteriaList'?: Array; -} -/** - * The current state of execution. - * @export - * @enum {string} - */ - -export const ExecutionStatusV2025 = { - Executing: 'EXECUTING', - Verifying: 'VERIFYING', - Terminated: 'TERMINATED', - Completed: 'COMPLETED' -} as const; - -export type ExecutionStatusV2025 = typeof ExecutionStatusV2025[keyof typeof ExecutionStatusV2025]; - - -/** - * - * @export - * @interface ExpansionItemV2025 - */ -export interface ExpansionItemV2025 { - /** - * The ID of the account - * @type {string} - * @memberof ExpansionItemV2025 - */ - 'accountId'?: string; - /** - * Cause of the expansion item. - * @type {string} - * @memberof ExpansionItemV2025 - */ - 'cause'?: string; - /** - * The name of the item - * @type {string} - * @memberof ExpansionItemV2025 - */ - 'name'?: string; - /** - * - * @type {AttributeRequestV2025} - * @memberof ExpansionItemV2025 - */ - 'attributeRequest'?: AttributeRequestV2025; - /** - * - * @type {AccountSourceV2025} - * @memberof ExpansionItemV2025 - */ - 'source'?: AccountSourceV2025; - /** - * ID of the expansion item - * @type {string} - * @memberof ExpansionItemV2025 - */ - 'id'?: string; - /** - * State of the expansion item - * @type {string} - * @memberof ExpansionItemV2025 - */ - 'state'?: string; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2025 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2025 { - /** - * - * @type {FormDefinitionSelfImportExportDtoV2025} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerSelfV2025 - */ - 'object'?: FormDefinitionSelfImportExportDtoV2025; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerV2025 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerV2025 { - /** - * - * @type {FormDefinitionResponseV2025} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2025 - */ - 'object'?: FormDefinitionResponseV2025; - /** - * - * @type {ExportFormDefinitionsByTenant200ResponseInnerSelfV2025} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2025 - */ - 'self'?: ExportFormDefinitionsByTenant200ResponseInnerSelfV2025; - /** - * - * @type {number} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2025 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ExportOptions1V2025 - */ -export interface ExportOptions1V2025 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptions1V2025 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptions1V2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2025; }} - * @memberof ExportOptions1V2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2025; }; -} - -export const ExportOptions1V2025ExcludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2025ExcludeTypesV2025 = typeof ExportOptions1V2025ExcludeTypesV2025[keyof typeof ExportOptions1V2025ExcludeTypesV2025]; -export const ExportOptions1V2025IncludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2025IncludeTypesV2025 = typeof ExportOptions1V2025IncludeTypesV2025[keyof typeof ExportOptions1V2025IncludeTypesV2025]; - -/** - * - * @export - * @interface ExportOptionsV2025 - */ -export interface ExportOptionsV2025 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptionsV2025 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptionsV2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2025; }} - * @memberof ExportOptionsV2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2025; }; -} - -export const ExportOptionsV2025ExcludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2025ExcludeTypesV2025 = typeof ExportOptionsV2025ExcludeTypesV2025[keyof typeof ExportOptionsV2025ExcludeTypesV2025]; -export const ExportOptionsV2025IncludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2025IncludeTypesV2025 = typeof ExportOptionsV2025IncludeTypesV2025[keyof typeof ExportOptionsV2025IncludeTypesV2025]; - -/** - * - * @export - * @interface ExportPayloadV2025 - */ -export interface ExportPayloadV2025 { - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof ExportPayloadV2025 - */ - 'description'?: string; - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportPayloadV2025 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportPayloadV2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2025; }} - * @memberof ExportPayloadV2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2025; }; -} - -export const ExportPayloadV2025ExcludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2025ExcludeTypesV2025 = typeof ExportPayloadV2025ExcludeTypesV2025[keyof typeof ExportPayloadV2025ExcludeTypesV2025]; -export const ExportPayloadV2025IncludeTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2025IncludeTypesV2025 = typeof ExportPayloadV2025IncludeTypesV2025[keyof typeof ExportPayloadV2025IncludeTypesV2025]; - -/** - * - * @export - * @interface ExpressionChildrenInnerV2025 - */ -export interface ExpressionChildrenInnerV2025 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionChildrenInnerV2025 - */ - 'operator'?: ExpressionChildrenInnerV2025OperatorV2025; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionChildrenInnerV2025 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2025} - * @memberof ExpressionChildrenInnerV2025 - */ - 'value'?: ValueV2025 | null; - /** - * There cannot be anymore nested children. This will always be null. - * @type {string} - * @memberof ExpressionChildrenInnerV2025 - */ - 'children'?: string | null; -} - -export const ExpressionChildrenInnerV2025OperatorV2025 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionChildrenInnerV2025OperatorV2025 = typeof ExpressionChildrenInnerV2025OperatorV2025[keyof typeof ExpressionChildrenInnerV2025OperatorV2025]; - -/** - * - * @export - * @interface ExpressionV2025 - */ -export interface ExpressionV2025 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionV2025 - */ - 'operator'?: ExpressionV2025OperatorV2025; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionV2025 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2025} - * @memberof ExpressionV2025 - */ - 'value'?: ValueV2025 | null; - /** - * List of expressions - * @type {Array} - * @memberof ExpressionV2025 - */ - 'children'?: Array | null; -} - -export const ExpressionV2025OperatorV2025 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionV2025OperatorV2025 = typeof ExpressionV2025OperatorV2025[keyof typeof ExpressionV2025OperatorV2025]; - -/** - * Attributes related to an external trigger - * @export - * @interface ExternalAttributesV2025 - */ -export interface ExternalAttributesV2025 { - /** - * A unique name for the external trigger - * @type {string} - * @memberof ExternalAttributesV2025 - */ - 'name'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof ExternalAttributesV2025 - */ - 'description'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof ExternalAttributesV2025 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof ExternalAttributesV2025 - */ - 'url'?: string | null; -} -/** - * - * @export - * @interface FeatureValueDtoV2025 - */ -export interface FeatureValueDtoV2025 { - /** - * The type of feature - * @type {string} - * @memberof FeatureValueDtoV2025 - */ - 'feature'?: string; - /** - * The number of identities that have access to the feature - * @type {number} - * @memberof FeatureValueDtoV2025 - */ - 'numerator'?: number; - /** - * The number of identities with the corresponding feature - * @type {number} - * @memberof FeatureValueDtoV2025 - */ - 'denominator'?: number; -} -/** - * - * @export - * @interface FederationProtocolDetailsV2025 - */ -export interface FederationProtocolDetailsV2025 { - /** - * Federation protocol role - * @type {string} - * @memberof FederationProtocolDetailsV2025 - */ - 'role'?: FederationProtocolDetailsV2025RoleV2025; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof FederationProtocolDetailsV2025 - */ - 'entityId'?: string; -} - -export const FederationProtocolDetailsV2025RoleV2025 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type FederationProtocolDetailsV2025RoleV2025 = typeof FederationProtocolDetailsV2025RoleV2025[keyof typeof FederationProtocolDetailsV2025RoleV2025]; - -/** - * - * @export - * @interface FieldDetailsDtoV2025 - */ -export interface FieldDetailsDtoV2025 { - /** - * The name of the attribute. - * @type {string} - * @memberof FieldDetailsDtoV2025 - */ - 'name'?: string; - /** - * The transform to apply to the field - * @type {object} - * @memberof FieldDetailsDtoV2025 - */ - 'transform'?: object; - /** - * Attributes required for the transform - * @type {object} - * @memberof FieldDetailsDtoV2025 - */ - 'attributes'?: object; - /** - * Flag indicating whether or not the attribute is required. - * @type {boolean} - * @memberof FieldDetailsDtoV2025 - */ - 'isRequired'?: boolean; - /** - * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. - * @type {string} - * @memberof FieldDetailsDtoV2025 - */ - 'type'?: FieldDetailsDtoV2025TypeV2025; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof FieldDetailsDtoV2025 - */ - 'isMultiValued'?: boolean; -} - -export const FieldDetailsDtoV2025TypeV2025 = { - String: 'string', - Int: 'int', - Long: 'long', - Date: 'date', - Boolean: 'boolean', - Secret: 'secret' -} as const; - -export type FieldDetailsDtoV2025TypeV2025 = typeof FieldDetailsDtoV2025TypeV2025[keyof typeof FieldDetailsDtoV2025TypeV2025]; - -/** - * An additional filter to constrain the results of the search query. - * @export - * @interface FilterAggregationV2025 - */ -export interface FilterAggregationV2025 { - /** - * The name of the filter aggregate to be included in the result. - * @type {string} - * @memberof FilterAggregationV2025 - */ - 'name': string; - /** - * - * @type {SearchFilterTypeV2025} - * @memberof FilterAggregationV2025 - */ - 'type'?: SearchFilterTypeV2025; - /** - * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof FilterAggregationV2025 - */ - 'field': string; - /** - * The value to filter on. - * @type {string} - * @memberof FilterAggregationV2025 - */ - 'value': string; -} - - -/** - * Enum representing the currently supported filter types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const FilterTypeV2025 = { - Exists: 'EXISTS', - Range: 'RANGE', - Terms: 'TERMS' -} as const; - -export type FilterTypeV2025 = typeof FilterTypeV2025[keyof typeof FilterTypeV2025]; - - -/** - * - * @export - * @interface FilterV2025 - */ -export interface FilterV2025 { - /** - * - * @type {FilterTypeV2025} - * @memberof FilterV2025 - */ - 'type'?: FilterTypeV2025; - /** - * - * @type {RangeV2025} - * @memberof FilterV2025 - */ - 'range'?: RangeV2025; - /** - * The terms to be filtered. - * @type {Array} - * @memberof FilterV2025 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof FilterV2025 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface FirstValidV2025 - */ -export interface FirstValidV2025 { - /** - * An array of attributes to evaluate for existence. - * @type {Array} - * @memberof FirstValidV2025 - */ - 'values': Array; - /** - * a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - * @type {boolean} - * @memberof FirstValidV2025 - */ - 'ignoreErrors'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof FirstValidV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Represent a form conditional. - * @export - * @interface FormConditionV2025 - */ -export interface FormConditionV2025 { - /** - * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr - * @type {string} - * @memberof FormConditionV2025 - */ - 'ruleOperator'?: FormConditionV2025RuleOperatorV2025; - /** - * List of rules. - * @type {Array} - * @memberof FormConditionV2025 - */ - 'rules'?: Array; - /** - * List of effects. - * @type {Array} - * @memberof FormConditionV2025 - */ - 'effects'?: Array; -} - -export const FormConditionV2025RuleOperatorV2025 = { - And: 'AND', - Or: 'OR' -} as const; - -export type FormConditionV2025RuleOperatorV2025 = typeof FormConditionV2025RuleOperatorV2025[keyof typeof FormConditionV2025RuleOperatorV2025]; - -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestAttributesV2025 - */ -export interface FormDefinitionDynamicSchemaRequestAttributesV2025 { - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestAttributesV2025 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestV2025 - */ -export interface FormDefinitionDynamicSchemaRequestV2025 { - /** - * - * @type {FormDefinitionDynamicSchemaRequestAttributesV2025} - * @memberof FormDefinitionDynamicSchemaRequestV2025 - */ - 'attributes'?: FormDefinitionDynamicSchemaRequestAttributesV2025; - /** - * Description is the form definition dynamic schema description text - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2025 - */ - 'description'?: string; - /** - * ID is a unique identifier - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2025 - */ - 'id'?: string; - /** - * Type is the form definition dynamic schema type - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2025 - */ - 'type'?: string; - /** - * VersionNumber is the form definition dynamic schema version number - * @type {number} - * @memberof FormDefinitionDynamicSchemaRequestV2025 - */ - 'versionNumber'?: number; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaResponseV2025 - */ -export interface FormDefinitionDynamicSchemaResponseV2025 { - /** - * OutputSchema holds a JSON schema generated dynamically - * @type {{ [key: string]: object; }} - * @memberof FormDefinitionDynamicSchemaResponseV2025 - */ - 'outputSchema'?: { [key: string]: object; }; -} -/** - * - * @export - * @interface FormDefinitionFileUploadResponseV2025 - */ -export interface FormDefinitionFileUploadResponseV2025 { - /** - * Created is the date the file was uploaded - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2025 - */ - 'created'?: string; - /** - * fileId is a unique ULID that serves as an identifier for the form definition file - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2025 - */ - 'fileId'?: string; - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2025 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionInputV2025 - */ -export interface FormDefinitionInputV2025 { - /** - * Unique identifier for the form input. - * @type {string} - * @memberof FormDefinitionInputV2025 - */ - 'id'?: string; - /** - * FormDefinitionInputType value. STRING FormDefinitionInputTypeString - * @type {string} - * @memberof FormDefinitionInputV2025 - */ - 'type'?: FormDefinitionInputV2025TypeV2025; - /** - * Name for the form input. - * @type {string} - * @memberof FormDefinitionInputV2025 - */ - 'label'?: string; - /** - * Form input\'s description. - * @type {string} - * @memberof FormDefinitionInputV2025 - */ - 'description'?: string; -} - -export const FormDefinitionInputV2025TypeV2025 = { - String: 'STRING', - Array: 'ARRAY' -} as const; - -export type FormDefinitionInputV2025TypeV2025 = typeof FormDefinitionInputV2025TypeV2025[keyof typeof FormDefinitionInputV2025TypeV2025]; - -/** - * - * @export - * @interface FormDefinitionResponseV2025 - */ -export interface FormDefinitionResponseV2025 { - /** - * Unique guid identifying the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2025 - */ - 'id'?: string; - /** - * Name of the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2025 - */ - 'name'?: string; - /** - * Form definition\'s description. - * @type {string} - * @memberof FormDefinitionResponseV2025 - */ - 'description'?: string; - /** - * - * @type {FormOwnerV2025} - * @memberof FormDefinitionResponseV2025 - */ - 'owner'?: FormOwnerV2025; - /** - * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. - * @type {Array} - * @memberof FormDefinitionResponseV2025 - */ - 'usedBy'?: Array; - /** - * List of form inputs required to create a form-instance object. - * @type {Array} - * @memberof FormDefinitionResponseV2025 - */ - 'formInput'?: Array; - /** - * List of nested form elements. - * @type {Array} - * @memberof FormDefinitionResponseV2025 - */ - 'formElements'?: Array; - /** - * Conditional logic that can dynamically modify the form as the recipient is interacting with it. - * @type {Array} - * @memberof FormDefinitionResponseV2025 - */ - 'formConditions'?: Array; - /** - * Created is the date the form definition was created - * @type {string} - * @memberof FormDefinitionResponseV2025 - */ - 'created'?: string; - /** - * Modified is the last date the form definition was modified - * @type {string} - * @memberof FormDefinitionResponseV2025 - */ - 'modified'?: string; -} -/** - * Self block for imported/exported object. - * @export - * @interface FormDefinitionSelfImportExportDtoV2025 - */ -export interface FormDefinitionSelfImportExportDtoV2025 { - /** - * Imported/exported object\'s DTO type. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2025 - */ - 'type'?: FormDefinitionSelfImportExportDtoV2025TypeV2025; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2025 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2025 - */ - 'name'?: string; -} - -export const FormDefinitionSelfImportExportDtoV2025TypeV2025 = { - FormDefinition: 'FORM_DEFINITION' -} as const; - -export type FormDefinitionSelfImportExportDtoV2025TypeV2025 = typeof FormDefinitionSelfImportExportDtoV2025TypeV2025[keyof typeof FormDefinitionSelfImportExportDtoV2025TypeV2025]; - -/** - * - * @export - * @interface FormDetailsV2025 - */ -export interface FormDetailsV2025 { - /** - * ID of the form - * @type {string} - * @memberof FormDetailsV2025 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormDetailsV2025 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormDetailsV2025 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof FormDetailsV2025 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormDetailsV2025 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof FormDetailsV2025 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface FormElementDataSourceConfigOptionsV2025 - */ -export interface FormElementDataSourceConfigOptionsV2025 { - /** - * Label is the main label to display to the user when selecting this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2025 - */ - 'label'?: string; - /** - * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2025 - */ - 'subLabel'?: string; - /** - * Value is the value to save as an entry when the user selects this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface FormElementDynamicDataSourceConfigV2025 - */ -export interface FormElementDynamicDataSourceConfigV2025 { - /** - * AggregationBucketField is the aggregation bucket field name - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2025 - */ - 'aggregationBucketField'?: string; - /** - * Indices is a list of indices to use - * @type {Array} - * @memberof FormElementDynamicDataSourceConfigV2025 - */ - 'indices'?: Array; - /** - * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2025 - */ - 'objectType'?: FormElementDynamicDataSourceConfigV2025ObjectTypeV2025; - /** - * Query is a text - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2025 - */ - 'query'?: string; -} - -export const FormElementDynamicDataSourceConfigV2025IndicesV2025 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Identities: 'identities', - Events: 'events', - Roles: 'roles', - Star: '*' -} as const; - -export type FormElementDynamicDataSourceConfigV2025IndicesV2025 = typeof FormElementDynamicDataSourceConfigV2025IndicesV2025[keyof typeof FormElementDynamicDataSourceConfigV2025IndicesV2025]; -export const FormElementDynamicDataSourceConfigV2025ObjectTypeV2025 = { - Identity: 'IDENTITY', - AccessProfile: 'ACCESS_PROFILE', - Sources: 'SOURCES', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type FormElementDynamicDataSourceConfigV2025ObjectTypeV2025 = typeof FormElementDynamicDataSourceConfigV2025ObjectTypeV2025[keyof typeof FormElementDynamicDataSourceConfigV2025ObjectTypeV2025]; - -/** - * - * @export - * @interface FormElementDynamicDataSourceV2025 - */ -export interface FormElementDynamicDataSourceV2025 { - /** - * - * @type {FormElementDynamicDataSourceConfigV2025} - * @memberof FormElementDynamicDataSourceV2025 - */ - 'config'?: FormElementDynamicDataSourceConfigV2025; - /** - * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput - * @type {string} - * @memberof FormElementDynamicDataSourceV2025 - */ - 'dataSourceType'?: FormElementDynamicDataSourceV2025DataSourceTypeV2025; -} - -export const FormElementDynamicDataSourceV2025DataSourceTypeV2025 = { - Static: 'STATIC', - Internal: 'INTERNAL', - Search: 'SEARCH', - FormInput: 'FORM_INPUT' -} as const; - -export type FormElementDynamicDataSourceV2025DataSourceTypeV2025 = typeof FormElementDynamicDataSourceV2025DataSourceTypeV2025[keyof typeof FormElementDynamicDataSourceV2025DataSourceTypeV2025]; - -/** - * - * @export - * @interface FormElementPreviewRequestV2025 - */ -export interface FormElementPreviewRequestV2025 { - /** - * - * @type {FormElementDynamicDataSourceV2025} - * @memberof FormElementPreviewRequestV2025 - */ - 'dataSource'?: FormElementDynamicDataSourceV2025; -} -/** - * - * @export - * @interface FormElementV2025 - */ -export interface FormElementV2025 { - /** - * Form element identifier. - * @type {string} - * @memberof FormElementV2025 - */ - 'id'?: string; - /** - * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription - * @type {string} - * @memberof FormElementV2025 - */ - 'elementType'?: FormElementV2025ElementTypeV2025; - /** - * Config object. - * @type {{ [key: string]: any; }} - * @memberof FormElementV2025 - */ - 'config'?: { [key: string]: any; }; - /** - * Technical key. - * @type {string} - * @memberof FormElementV2025 - */ - 'key'?: string; - /** - * - * @type {Array} - * @memberof FormElementV2025 - */ - 'validations'?: Array | null; -} - -export const FormElementV2025ElementTypeV2025 = { - Text: 'TEXT', - Toggle: 'TOGGLE', - Textarea: 'TEXTAREA', - Hidden: 'HIDDEN', - Phone: 'PHONE', - Email: 'EMAIL', - Select: 'SELECT', - Date: 'DATE', - Section: 'SECTION', - ColumnSet: 'COLUMN_SET', - Image: 'IMAGE', - Description: 'DESCRIPTION' -} as const; - -export type FormElementV2025ElementTypeV2025 = typeof FormElementV2025ElementTypeV2025[keyof typeof FormElementV2025ElementTypeV2025]; - -/** - * Set of FormElementValidation items. - * @export - * @interface FormElementValidationsSetV2025 - */ -export interface FormElementValidationsSetV2025 { - /** - * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. - * @type {string} - * @memberof FormElementValidationsSetV2025 - */ - 'validationType'?: FormElementValidationsSetV2025ValidationTypeV2025; -} - -export const FormElementValidationsSetV2025ValidationTypeV2025 = { - Required: 'REQUIRED', - MinLength: 'MIN_LENGTH', - MaxLength: 'MAX_LENGTH', - Regex: 'REGEX', - Date: 'DATE', - MaxDate: 'MAX_DATE', - MinDate: 'MIN_DATE', - LessThanDate: 'LESS_THAN_DATE', - Phone: 'PHONE', - Email: 'EMAIL', - DataSource: 'DATA_SOURCE', - Textarea: 'TEXTAREA' -} as const; - -export type FormElementValidationsSetV2025ValidationTypeV2025 = typeof FormElementValidationsSetV2025ValidationTypeV2025[keyof typeof FormElementValidationsSetV2025ValidationTypeV2025]; - -/** - * - * @export - * @interface FormErrorV2025 - */ -export interface FormErrorV2025 { - /** - * Key is the technical key - * @type {string} - * @memberof FormErrorV2025 - */ - 'key'?: string; - /** - * Messages is a list of web.ErrorMessage items - * @type {Array} - * @memberof FormErrorV2025 - */ - 'messages'?: Array; - /** - * Value is the value associated with a Key - * @type {object} - * @memberof FormErrorV2025 - */ - 'value'?: object; -} -/** - * - * @export - * @interface FormInstanceCreatedByV2025 - */ -export interface FormInstanceCreatedByV2025 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceCreatedByV2025 - */ - 'id'?: string; - /** - * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource - * @type {string} - * @memberof FormInstanceCreatedByV2025 - */ - 'type'?: FormInstanceCreatedByV2025TypeV2025; -} - -export const FormInstanceCreatedByV2025TypeV2025 = { - WorkflowExecution: 'WORKFLOW_EXECUTION', - Source: 'SOURCE' -} as const; - -export type FormInstanceCreatedByV2025TypeV2025 = typeof FormInstanceCreatedByV2025TypeV2025[keyof typeof FormInstanceCreatedByV2025TypeV2025]; - -/** - * - * @export - * @interface FormInstanceRecipientV2025 - */ -export interface FormInstanceRecipientV2025 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceRecipientV2025 - */ - 'id'?: string; - /** - * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity - * @type {string} - * @memberof FormInstanceRecipientV2025 - */ - 'type'?: FormInstanceRecipientV2025TypeV2025; -} - -export const FormInstanceRecipientV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type FormInstanceRecipientV2025TypeV2025 = typeof FormInstanceRecipientV2025TypeV2025[keyof typeof FormInstanceRecipientV2025TypeV2025]; - -/** - * - * @export - * @interface FormInstanceResponseV2025 - */ -export interface FormInstanceResponseV2025 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'state'?: FormInstanceResponseV2025StateV2025; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof FormInstanceResponseV2025 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2025} - * @memberof FormInstanceResponseV2025 - */ - 'createdBy'?: FormInstanceCreatedByV2025; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof FormInstanceResponseV2025 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof FormInstanceResponseV2025 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof FormInstanceResponseV2025 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof FormInstanceResponseV2025 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof FormInstanceResponseV2025 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof FormInstanceResponseV2025 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof FormInstanceResponseV2025 - */ - 'recipients'?: Array; -} - -export const FormInstanceResponseV2025StateV2025 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type FormInstanceResponseV2025StateV2025 = typeof FormInstanceResponseV2025StateV2025[keyof typeof FormInstanceResponseV2025StateV2025]; - -/** - * - * @export - * @interface FormItemDetailsV2025 - */ -export interface FormItemDetailsV2025 { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemDetailsV2025 - */ - 'name'?: string | null; -} -/** - * - * @export - * @interface FormOwnerV2025 - */ -export interface FormOwnerV2025 { - /** - * FormOwnerType value. IDENTITY FormOwnerTypeIdentity - * @type {string} - * @memberof FormOwnerV2025 - */ - 'type'?: FormOwnerV2025TypeV2025; - /** - * Unique identifier of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2025 - */ - 'id'?: string; - /** - * Name of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2025 - */ - 'name'?: string; -} - -export const FormOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type FormOwnerV2025TypeV2025 = typeof FormOwnerV2025TypeV2025[keyof typeof FormOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface FormUsedByV2025 - */ -export interface FormUsedByV2025 { - /** - * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType - * @type {string} - * @memberof FormUsedByV2025 - */ - 'type'?: FormUsedByV2025TypeV2025; - /** - * Unique identifier of the system using the form. - * @type {string} - * @memberof FormUsedByV2025 - */ - 'id'?: string; - /** - * Name of the system using the form. - * @type {string} - * @memberof FormUsedByV2025 - */ - 'name'?: string; -} - -export const FormUsedByV2025TypeV2025 = { - Workflow: 'WORKFLOW', - Source: 'SOURCE', - MySailPoint: 'MySailPoint' -} as const; - -export type FormUsedByV2025TypeV2025 = typeof FormUsedByV2025TypeV2025[keyof typeof FormUsedByV2025TypeV2025]; - -/** - * - * @export - * @interface ForwardApprovalDtoV2025 - */ -export interface ForwardApprovalDtoV2025 { - /** - * The Id of the new owner - * @type {string} - * @memberof ForwardApprovalDtoV2025 - */ - 'newOwnerId': string; - /** - * The comment provided by the forwarder - * @type {string} - * @memberof ForwardApprovalDtoV2025 - */ - 'comment': string; -} -/** - * Discovered applications with their respective associated sources - * @export - * @interface FullDiscoveredApplicationsV2025 - */ -export interface FullDiscoveredApplicationsV2025 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'status'?: string; - /** - * List of associated sources related to this discovered application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'associatedSources'?: Array; - /** - * The operational status of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'operationalStatus'?: string; - /** - * The category of the discovery source. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'discoverySourceCategory'?: string; - /** - * The number of licenses associated with the application. - * @type {number} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'licenseCount'?: number; - /** - * Indicates whether the application is sanctioned. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'isSanctioned'?: boolean; - /** - * URL of the application\'s logo. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'logo'?: string; - /** - * The URL of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'appUrl'?: string; - /** - * List of groups associated with the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'groups'?: Array; - /** - * The count of users associated with the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'usersCount'?: string; - /** - * The owners of the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'applicationOwner'?: Array; - /** - * The IT owners of the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'itApplicationOwner'?: Array; - /** - * The business criticality level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'businessCriticality'?: string; - /** - * The data classification level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'dataClassification'?: string; - /** - * The business unit associated with the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'businessUnit'?: string; - /** - * The installation type of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'installType'?: string; - /** - * The environment in which the application operates. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'environment'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'riskLevel'?: FullDiscoveredApplicationsV2025RiskLevelV2025; - /** - * Indicates whether the application has privileged access. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'isPrivileged'?: boolean; - /** - * The warranty expiration date of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'warrantyExpiration'?: string; - /** - * Additional attributes of the application useful for visibility of governance posture. - * @type {object} - * @memberof FullDiscoveredApplicationsV2025 - */ - 'attributes'?: object; -} - -export const FullDiscoveredApplicationsV2025RiskLevelV2025 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type FullDiscoveredApplicationsV2025RiskLevelV2025 = typeof FullDiscoveredApplicationsV2025RiskLevelV2025[keyof typeof FullDiscoveredApplicationsV2025RiskLevelV2025]; - -/** - * - * @export - * @interface GenerateRandomStringV2025 - */ -export interface GenerateRandomStringV2025 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GenerateRandomStringV2025 - */ - 'name': string; - /** - * The operation to perform `generateRandomString` - * @type {string} - * @memberof GenerateRandomStringV2025 - */ - 'operation': string; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers - * @type {boolean} - * @memberof GenerateRandomStringV2025 - */ - 'includeNumbers': boolean; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters - * @type {boolean} - * @memberof GenerateRandomStringV2025 - */ - 'includeSpecialChars': boolean; - /** - * This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - * @type {string} - * @memberof GenerateRandomStringV2025 - */ - 'length': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GenerateRandomStringV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetActiveCampaigns200ResponseInnerV2025 - */ -export interface GetActiveCampaigns200ResponseInnerV2025 { - /** - * Id of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'type': GetActiveCampaigns200ResponseInnerV2025TypeV2025; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'status'?: GetActiveCampaigns200ResponseInnerV2025StatusV2025 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'correlatedStatus'?: GetActiveCampaigns200ResponseInnerV2025CorrelatedStatusV2025; - /** - * Created time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2025} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'filter'?: CampaignAllOfFilterV2025 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2025} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2025} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2025} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2025} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2025 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2025 - */ - 'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerV2025MandatoryCommentRequirementV2025; -} - -export const GetActiveCampaigns200ResponseInnerV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2025TypeV2025 = typeof GetActiveCampaigns200ResponseInnerV2025TypeV2025[keyof typeof GetActiveCampaigns200ResponseInnerV2025TypeV2025]; -export const GetActiveCampaigns200ResponseInnerV2025StatusV2025 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2025StatusV2025 = typeof GetActiveCampaigns200ResponseInnerV2025StatusV2025[keyof typeof GetActiveCampaigns200ResponseInnerV2025StatusV2025]; -export const GetActiveCampaigns200ResponseInnerV2025CorrelatedStatusV2025 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2025CorrelatedStatusV2025 = typeof GetActiveCampaigns200ResponseInnerV2025CorrelatedStatusV2025[keyof typeof GetActiveCampaigns200ResponseInnerV2025CorrelatedStatusV2025]; -export const GetActiveCampaigns200ResponseInnerV2025MandatoryCommentRequirementV2025 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2025MandatoryCommentRequirementV2025 = typeof GetActiveCampaigns200ResponseInnerV2025MandatoryCommentRequirementV2025[keyof typeof GetActiveCampaigns200ResponseInnerV2025MandatoryCommentRequirementV2025]; - -/** - * - * @export - * @interface GetCampaign200ResponseV2025 - */ -export interface GetCampaign200ResponseV2025 { - /** - * Id of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'type': GetCampaign200ResponseV2025TypeV2025; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2025 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2025 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetCampaign200ResponseV2025 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'status'?: GetCampaign200ResponseV2025StatusV2025 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'correlatedStatus'?: GetCampaign200ResponseV2025CorrelatedStatusV2025; - /** - * Created time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2025 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2025 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetCampaign200ResponseV2025 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2025} - * @memberof GetCampaign200ResponseV2025 - */ - 'filter'?: CampaignAllOfFilterV2025 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetCampaign200ResponseV2025 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2025} - * @memberof GetCampaign200ResponseV2025 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2025} - * @memberof GetCampaign200ResponseV2025 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2025} - * @memberof GetCampaign200ResponseV2025 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2025 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2025} - * @memberof GetCampaign200ResponseV2025 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2025 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetCampaign200ResponseV2025 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetCampaign200ResponseV2025 - */ - 'mandatoryCommentRequirement'?: GetCampaign200ResponseV2025MandatoryCommentRequirementV2025; -} - -export const GetCampaign200ResponseV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetCampaign200ResponseV2025TypeV2025 = typeof GetCampaign200ResponseV2025TypeV2025[keyof typeof GetCampaign200ResponseV2025TypeV2025]; -export const GetCampaign200ResponseV2025StatusV2025 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetCampaign200ResponseV2025StatusV2025 = typeof GetCampaign200ResponseV2025StatusV2025[keyof typeof GetCampaign200ResponseV2025StatusV2025]; -export const GetCampaign200ResponseV2025CorrelatedStatusV2025 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetCampaign200ResponseV2025CorrelatedStatusV2025 = typeof GetCampaign200ResponseV2025CorrelatedStatusV2025[keyof typeof GetCampaign200ResponseV2025CorrelatedStatusV2025]; -export const GetCampaign200ResponseV2025MandatoryCommentRequirementV2025 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetCampaign200ResponseV2025MandatoryCommentRequirementV2025 = typeof GetCampaign200ResponseV2025MandatoryCommentRequirementV2025[keyof typeof GetCampaign200ResponseV2025MandatoryCommentRequirementV2025]; - -/** - * @type GetDiscoveredApplications200ResponseInnerV2025 - * @export - */ -export type GetDiscoveredApplications200ResponseInnerV2025 = FullDiscoveredApplicationsV2025 | SlimDiscoveredApplicationsV2025; - -/** - * - * @export - * @interface GetHistoricalIdentityEvents200ResponseInnerV2025 - */ -export interface GetHistoricalIdentityEvents200ResponseInnerV2025 { - /** - * the id of the certification item - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'signer'?: CertifierResponseV2025; - /** - * the event type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'accessItem': AccessItemAssociatedAccessItemV2025; - /** - * - * @type {CorrelatedGovernanceEventV2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'governanceEvent': CorrelatedGovernanceEventV2025 | null; - /** - * the access item type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'accessItemType'?: GetHistoricalIdentityEvents200ResponseInnerV2025AccessItemTypeV2025; - /** - * - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'attributeChanges': Array; - /** - * - * @type {AccessRequestResponse1V2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'accessRequest': AccessRequestResponse1V2025; - /** - * - * @type {AccountStatusChangedAccountV2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'account': AccountStatusChangedAccountV2025; - /** - * - * @type {AccountStatusChangedStatusChangeV2025} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2025 - */ - 'statusChange': AccountStatusChangedStatusChangeV2025; -} - -export const GetHistoricalIdentityEvents200ResponseInnerV2025AccessItemTypeV2025 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type GetHistoricalIdentityEvents200ResponseInnerV2025AccessItemTypeV2025 = typeof GetHistoricalIdentityEvents200ResponseInnerV2025AccessItemTypeV2025[keyof typeof GetHistoricalIdentityEvents200ResponseInnerV2025AccessItemTypeV2025]; - -/** - * - * @export - * @interface GetLaunchers200ResponseV2025 - */ -export interface GetLaunchers200ResponseV2025 { - /** - * Pagination marker - * @type {string} - * @memberof GetLaunchers200ResponseV2025 - */ - 'next'?: string; - /** - * - * @type {Array} - * @memberof GetLaunchers200ResponseV2025 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface GetOAuthClientResponseV2025 - */ -export interface GetOAuthClientResponseV2025 { - /** - * ID of the OAuth client - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'id': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'businessName': string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'homepageUrl': string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2025 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2025 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof GetOAuthClientResponseV2025 - */ - 'redirectUris': Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof GetOAuthClientResponseV2025 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2025} - * @memberof GetOAuthClientResponseV2025 - */ - 'accessType': AccessTypeV2025; - /** - * - * @type {ClientTypeV2025} - * @memberof GetOAuthClientResponseV2025 - */ - 'type': ClientTypeV2025; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof GetOAuthClientResponseV2025 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof GetOAuthClientResponseV2025 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof GetOAuthClientResponseV2025 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof GetOAuthClientResponseV2025 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'modified': string; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'secret'?: string | null; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'metadata'?: string | null; - /** - * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - * @type {string} - * @memberof GetOAuthClientResponseV2025 - */ - 'lastUsed'?: string | null; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof GetOAuthClientResponseV2025 - */ - 'scope': Array | null; -} - - -/** - * - * @export - * @interface GetPersonalAccessTokenResponseV2025 - */ -export interface GetPersonalAccessTokenResponseV2025 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'id': string; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'name': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'scope': Array | null; - /** - * - * @type {PatOwnerV2025} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'owner': PatOwnerV2025; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'lastUsed'?: string | null; - /** - * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'managed'?: boolean; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'accessTokenValiditySeconds'?: number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty, the token will never expire (and `userAwareTokenNeverExpires` will be `true`). When `expirationDate` is provided, this value must be a future date. There is no upper limit on how far in the future the expiration date can be set. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'expirationDate'?: string | null; - /** - * Indicates that the user who created or updated this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When `true`, this flag confirms that the user understood the security risks associated with non-expiring tokens at the time of creation or update. **Security Awareness:** This field serves as a record that the user acknowledged: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Behavior:** * When `true`: Indicates that the user acknowledged they were creating a token that will never expire. When `expirationDate` is `null`, the token will never expire. * When `false`: The token follows normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseV2025 - */ - 'userAwareTokenNeverExpires'?: boolean; -} -/** - * - * @export - * @interface GetReferenceIdentityAttributeV2025 - */ -export interface GetReferenceIdentityAttributeV2025 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GetReferenceIdentityAttributeV2025 - */ - 'name': string; - /** - * The operation to perform `getReferenceIdentityAttribute` - * @type {string} - * @memberof GetReferenceIdentityAttributeV2025 - */ - 'operation': string; - /** - * This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user\'s manager and then get that manager\'s identity attribute. - * @type {string} - * @memberof GetReferenceIdentityAttributeV2025 - */ - 'uid': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GetReferenceIdentityAttributeV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetRoleAssignments200ResponseInnerV2025 - */ -export interface GetRoleAssignments200ResponseInnerV2025 { - /** - * Assignment Id - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'role'?: BaseReferenceDtoV2025; - /** - * Date that the assignment was added - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'removeDate'?: string | null; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2025} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2025; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2025} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2025; - /** - * - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2025 - */ - 'accountTargets'?: Array; -} -/** - * @type GetStream200ResponseV2025 - * @export - */ -export type GetStream200ResponseV2025 = Array | StreamConfigResponseV2025; - -/** - * - * @export - * @interface GetTenantContext200ResponseInnerV2025 - */ -export interface GetTenantContext200ResponseInnerV2025 { - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2025 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2025 - */ - 'value'?: string; -} -/** - * OAuth2 Grant Type - * @export - * @enum {string} - */ - -export const GrantTypeV2025 = { - ClientCredentials: 'CLIENT_CREDENTIALS', - AuthorizationCode: 'AUTHORIZATION_CODE', - RefreshToken: 'REFRESH_TOKEN' -} as const; - -export type GrantTypeV2025 = typeof GrantTypeV2025[keyof typeof GrantTypeV2025]; - - -/** - * Individual error or warning event - * @export - * @interface HealthEventV2025 - */ -export interface HealthEventV2025 { - /** - * Description of the issue - * @type {string} - * @memberof HealthEventV2025 - */ - 'detailedMessage'?: string; - /** - * Unique identifier for the health event - * @type {string} - * @memberof HealthEventV2025 - */ - 'uuid'?: string; - /** - * Optional URL associated with the issue - * @type {string} - * @memberof HealthEventV2025 - */ - 'url'?: string | null; - /** - * Time when the event occurred - * @type {string} - * @memberof HealthEventV2025 - */ - 'timestamp'?: string; - /** - * Last time notification was sent for this issue - * @type {string} - * @memberof HealthEventV2025 - */ - 'lastNotifiedTimeStamp'?: string; - /** - * CPU usage percentage - * @type {number} - * @memberof HealthEventV2025 - */ - 'cpuUtilizationPercentage'?: number | null; - /** - * Free memory percentage - * @type {number} - * @memberof HealthEventV2025 - */ - 'freeSpacePercentage'?: number | null; -} -/** - * Health indicator category data with errors and warnings - * @export - * @interface HealthIndicatorCategoryV2025 - */ -export interface HealthIndicatorCategoryV2025 { - /** - * List of error events for this category - * @type {Array} - * @memberof HealthIndicatorCategoryV2025 - */ - 'errors'?: Array; - /** - * List of warning events for this category - * @type {Array} - * @memberof HealthIndicatorCategoryV2025 - */ - 'warnings'?: Array; -} -/** - * A HierarchicalRightSet - * @export - * @interface HierarchicalRightSetV2025 - */ -export interface HierarchicalRightSetV2025 { - /** - * The unique identifier of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2025 - */ - 'id'?: string; - /** - * The human-readable name of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2025 - */ - 'name'?: string; - /** - * A human-readable description of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2025 - */ - 'description'?: string | null; - /** - * The category of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2025 - */ - 'category'?: string; - /** - * - * @type {NestedConfigV2025} - * @memberof HierarchicalRightSetV2025 - */ - 'nestedConfig'?: NestedConfigV2025; - /** - * List of child HierarchicalRightSets. - * @type {Array} - * @memberof HierarchicalRightSetV2025 - */ - 'children'?: Array; -} -/** - * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. - * @export - * @enum {string} - */ - -export const HttpAuthenticationTypeV2025 = { - NoAuth: 'NO_AUTH', - BasicAuth: 'BASIC_AUTH', - BearerToken: 'BEARER_TOKEN' -} as const; - -export type HttpAuthenticationTypeV2025 = typeof HttpAuthenticationTypeV2025[keyof typeof HttpAuthenticationTypeV2025]; - - -/** - * - * @export - * @interface HttpConfigV2025 - */ -export interface HttpConfigV2025 { - /** - * URL of the external/custom integration. - * @type {string} - * @memberof HttpConfigV2025 - */ - 'url': string; - /** - * - * @type {HttpDispatchModeV2025} - * @memberof HttpConfigV2025 - */ - 'httpDispatchMode': HttpDispatchModeV2025; - /** - * - * @type {HttpAuthenticationTypeV2025} - * @memberof HttpConfigV2025 - */ - 'httpAuthenticationType'?: HttpAuthenticationTypeV2025; - /** - * - * @type {BasicAuthConfigV2025} - * @memberof HttpConfigV2025 - */ - 'basicAuthConfig'?: BasicAuthConfigV2025 | null; - /** - * - * @type {BearerTokenAuthConfigV2025} - * @memberof HttpConfigV2025 - */ - 'bearerTokenAuthConfig'?: BearerTokenAuthConfigV2025 | null; -} - - -/** - * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. - * @export - * @enum {string} - */ - -export const HttpDispatchModeV2025 = { - Sync: 'SYNC', - Async: 'ASYNC', - Dynamic: 'DYNAMIC' -} as const; - -export type HttpDispatchModeV2025 = typeof HttpDispatchModeV2025[keyof typeof HttpDispatchModeV2025]; - - -/** - * - * @export - * @interface ISO3166V2025 - */ -export interface ISO3166V2025 { - /** - * An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., \"USA\") `numeric` - The numeric country code (e.g., \"840\") - * @type {string} - * @memberof ISO3166V2025 - */ - 'format'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ISO3166V2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ISO3166V2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentitiesAccountsBulkRequestV2025 - */ -export interface IdentitiesAccountsBulkRequestV2025 { - /** - * The ids of the identities for which enable/disable accounts. - * @type {Array} - * @memberof IdentitiesAccountsBulkRequestV2025 - */ - 'identityIds'?: Array; -} -/** - * Arguments for Identities Details report (IDENTITIES_DETAILS) - * @export - * @interface IdentitiesDetailsReportArgumentsV2025 - */ -export interface IdentitiesDetailsReportArgumentsV2025 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesDetailsReportArgumentsV2025 - */ - 'correlatedOnly': boolean; -} -/** - * Arguments for Identities report (IDENTITIES) - * @export - * @interface IdentitiesReportArgumentsV2025 - */ -export interface IdentitiesReportArgumentsV2025 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesReportArgumentsV2025 - */ - 'correlatedOnly'?: boolean; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface Identity1V2025 - */ -export interface Identity1V2025 { - /** - * The ID of the object - * @type {string} - * @memberof Identity1V2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object - * @type {string} - * @memberof Identity1V2025 - */ - 'name'?: string; -} -/** - * @type IdentityAccessV2025 - * @export - */ -export type IdentityAccessV2025 = { type: 'ACCESS_PROFILE' } & AccessProfileSummaryV2025 | { type: 'ENTITLEMENT' } & AccessProfileEntitlementV2025 | { type: 'ROLE' } & AccessProfileRoleV2025; - -/** - * - * @export - * @interface IdentityAccountSelectionsV2025 - */ -export interface IdentityAccountSelectionsV2025 { - /** - * Available account selections for the identity, per requested item - * @type {Array} - * @memberof IdentityAccountSelectionsV2025 - */ - 'requestedItems'?: Array; - /** - * A boolean indicating whether any account selections will be required for the user to raise an access request - * @type {boolean} - * @memberof IdentityAccountSelectionsV2025 - */ - 'accountsSelectionRequired'?: boolean; - /** - * - * @type {DtoTypeV2025} - * @memberof IdentityAccountSelectionsV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The identity id for the user - * @type {string} - * @memberof IdentityAccountSelectionsV2025 - */ - 'id'?: string; - /** - * The name of the identity - * @type {string} - * @memberof IdentityAccountSelectionsV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityAssociationDetailsAssociationDetailsInnerV2025 - */ -export interface IdentityAssociationDetailsAssociationDetailsInnerV2025 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2025 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2025 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityAssociationDetailsV2025 - */ -export interface IdentityAssociationDetailsV2025 { - /** - * any additional context information of the http call result - * @type {string} - * @memberof IdentityAssociationDetailsV2025 - */ - 'message'?: string; - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityAssociationDetailsV2025 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityAttribute1V2025 - */ -export interface IdentityAttribute1V2025 { - /** - * The system (camel-cased) name of the identity attribute to bring in - * @type {string} - * @memberof IdentityAttribute1V2025 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IdentityAttribute1V2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IdentityAttribute1V2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - * @export - * @interface IdentityAttributeConfigV2025 - */ -export interface IdentityAttributeConfigV2025 { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfigV2025 - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfigV2025 - */ - 'attributeTransforms'?: Array; -} -/** - * Identity attribute IDs. - * @export - * @interface IdentityAttributeNamesV2025 - */ -export interface IdentityAttributeNamesV2025 { - /** - * List of identity attributes\' technical names. - * @type {Array} - * @memberof IdentityAttributeNamesV2025 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface IdentityAttributePreviewV2025 - */ -export interface IdentityAttributePreviewV2025 { - /** - * Name of the attribute that is being previewed. - * @type {string} - * @memberof IdentityAttributePreviewV2025 - */ - 'name'?: string; - /** - * Value that was derived during the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2025 - */ - 'value'?: string; - /** - * The value of the attribute before the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2025 - */ - 'previousValue'?: string; - /** - * List of error messages - * @type {Array} - * @memberof IdentityAttributePreviewV2025 - */ - 'errorMessages'?: Array; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransformV2025 - */ -export interface IdentityAttributeTransformV2025 { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransformV2025 - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinitionV2025} - * @memberof IdentityAttributeTransformV2025 - */ - 'transformDefinition'?: TransformDefinitionV2025; -} -/** - * - * @export - * @interface IdentityAttributeV2025 - */ -export interface IdentityAttributeV2025 { - /** - * Identity attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributeV2025 - */ - 'name': string; - /** - * Identity attribute\'s business-friendly name. - * @type {string} - * @memberof IdentityAttributeV2025 - */ - 'displayName'?: string; - /** - * Indicates whether the attribute is \'standard\' or \'default\'. - * @type {boolean} - * @memberof IdentityAttributeV2025 - */ - 'standard'?: boolean; - /** - * Identity attribute\'s type. - * @type {string} - * @memberof IdentityAttributeV2025 - */ - 'type'?: string | null; - /** - * Indicates whether the identity attribute is multi-valued. - * @type {boolean} - * @memberof IdentityAttributeV2025 - */ - 'multi'?: boolean; - /** - * Indicates whether the identity attribute is searchable. - * @type {boolean} - * @memberof IdentityAttributeV2025 - */ - 'searchable'?: boolean; - /** - * Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. - * @type {boolean} - * @memberof IdentityAttributeV2025 - */ - 'system'?: boolean; - /** - * Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. - * @type {Array} - * @memberof IdentityAttributeV2025 - */ - 'sources'?: Array; -} -/** - * @type IdentityAttributesChangedChangesInnerNewValueV2025 - * The value of the identity attribute after it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerNewValueV2025 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2025; }; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2025 - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2025 = boolean | number | string; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueV2025 - * The value of the identity attribute before it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueV2025 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2025; }; - -/** - * - * @export - * @interface IdentityAttributesChangedChangesInnerV2025 - */ -export interface IdentityAttributesChangedChangesInnerV2025 { - /** - * The name of the identity attribute that changed. - * @type {string} - * @memberof IdentityAttributesChangedChangesInnerV2025 - */ - 'attribute': string; - /** - * - * @type {IdentityAttributesChangedChangesInnerOldValueV2025} - * @memberof IdentityAttributesChangedChangesInnerV2025 - */ - 'oldValue'?: IdentityAttributesChangedChangesInnerOldValueV2025 | null; - /** - * - * @type {IdentityAttributesChangedChangesInnerNewValueV2025} - * @memberof IdentityAttributesChangedChangesInnerV2025 - */ - 'newValue'?: IdentityAttributesChangedChangesInnerNewValueV2025; -} -/** - * Identity whose attributes changed. - * @export - * @interface IdentityAttributesChangedIdentityV2025 - */ -export interface IdentityAttributesChangedIdentityV2025 { - /** - * DTO type of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2025 - */ - 'type': IdentityAttributesChangedIdentityV2025TypeV2025; - /** - * ID of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2025 - */ - 'id': string; - /** - * Display name of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2025 - */ - 'name': string; -} - -export const IdentityAttributesChangedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityAttributesChangedIdentityV2025TypeV2025 = typeof IdentityAttributesChangedIdentityV2025TypeV2025[keyof typeof IdentityAttributesChangedIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface IdentityAttributesChangedV2025 - */ -export interface IdentityAttributesChangedV2025 { - /** - * - * @type {IdentityAttributesChangedIdentityV2025} - * @memberof IdentityAttributesChangedV2025 - */ - 'identity': IdentityAttributesChangedIdentityV2025; - /** - * A list of one or more identity attributes that changed on the identity. - * @type {Array} - * @memberof IdentityAttributesChangedV2025 - */ - 'changes': Array; -} -/** - * - * @export - * @interface IdentityCertDecisionSummaryV2025 - */ -export interface IdentityCertDecisionSummaryV2025 { - /** - * Number of entitlement decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'entitlementDecisionsMade'?: number; - /** - * Number of access profile decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accessProfileDecisionsMade'?: number; - /** - * Number of role decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'roleDecisionsMade'?: number; - /** - * Number of account decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accountDecisionsMade'?: number; - /** - * The total number of entitlement decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'entitlementDecisionsTotal'?: number; - /** - * The total number of access profile decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accessProfileDecisionsTotal'?: number; - /** - * The total number of role decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'roleDecisionsTotal'?: number; - /** - * The total number of account decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accountDecisionsTotal'?: number; - /** - * The number of entitlement decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'entitlementsApproved'?: number; - /** - * The number of entitlement decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'entitlementsRevoked'?: number; - /** - * The number of access profile decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accessProfilesApproved'?: number; - /** - * The number of access profile decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accessProfilesRevoked'?: number; - /** - * The number of role decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'rolesApproved'?: number; - /** - * The number of role decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'rolesRevoked'?: number; - /** - * The number of account decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accountsApproved'?: number; - /** - * The number of account decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2025 - */ - 'accountsRevoked'?: number; -} -/** - * - * @export - * @interface IdentityCertificationDtoV2025 - */ -export interface IdentityCertificationDtoV2025 { - /** - * id of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2025} - * @memberof IdentityCertificationDtoV2025 - */ - 'campaign'?: CampaignReferenceV2025; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof IdentityCertificationDtoV2025 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof IdentityCertificationDtoV2025 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof IdentityCertificationDtoV2025 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof IdentityCertificationDtoV2025 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof IdentityCertificationDtoV2025 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2025} - * @memberof IdentityCertificationDtoV2025 - */ - 'reviewer'?: ReviewerV2025; - /** - * - * @type {ReassignmentV2025} - * @memberof IdentityCertificationDtoV2025 - */ - 'reassignment'?: ReassignmentV2025 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof IdentityCertificationDtoV2025 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof IdentityCertificationDtoV2025 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2025} - * @memberof IdentityCertificationDtoV2025 - */ - 'phase'?: CertificationPhaseV2025; -} - - -/** - * - * @export - * @interface IdentityCertifiedV2025 - */ -export interface IdentityCertifiedV2025 { - /** - * the id of the certification item - * @type {string} - * @memberof IdentityCertifiedV2025 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof IdentityCertifiedV2025 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof IdentityCertifiedV2025 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof IdentityCertifiedV2025 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof IdentityCertifiedV2025 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2025} - * @memberof IdentityCertifiedV2025 - */ - 'signer'?: CertifierResponseV2025; - /** - * the event type - * @type {string} - * @memberof IdentityCertifiedV2025 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof IdentityCertifiedV2025 - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface IdentityCompareResponseV2025 - */ -export interface IdentityCompareResponseV2025 { - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: object; }} - * @memberof IdentityCompareResponseV2025 - */ - 'accessItemDiff'?: { [key: string]: object; }; -} -/** - * Created identity. - * @export - * @interface IdentityCreatedIdentityV2025 - */ -export interface IdentityCreatedIdentityV2025 { - /** - * Created identity\'s DTO type. - * @type {string} - * @memberof IdentityCreatedIdentityV2025 - */ - 'type': IdentityCreatedIdentityV2025TypeV2025; - /** - * Created identity ID. - * @type {string} - * @memberof IdentityCreatedIdentityV2025 - */ - 'id': string; - /** - * Created identity\'s display name. - * @type {string} - * @memberof IdentityCreatedIdentityV2025 - */ - 'name': string; -} - -export const IdentityCreatedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityCreatedIdentityV2025TypeV2025 = typeof IdentityCreatedIdentityV2025TypeV2025[keyof typeof IdentityCreatedIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface IdentityCreatedV2025 - */ -export interface IdentityCreatedV2025 { - /** - * - * @type {IdentityCreatedIdentityV2025} - * @memberof IdentityCreatedV2025 - */ - 'identity': IdentityCreatedIdentityV2025; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityCreatedV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Deleted identity. - * @export - * @interface IdentityDeletedIdentityV2025 - */ -export interface IdentityDeletedIdentityV2025 { - /** - * Deleted identity\'s DTO type. - * @type {string} - * @memberof IdentityDeletedIdentityV2025 - */ - 'type': IdentityDeletedIdentityV2025TypeV2025; - /** - * Deleted identity ID. - * @type {string} - * @memberof IdentityDeletedIdentityV2025 - */ - 'id': string; - /** - * Deleted identity\'s display name. - * @type {string} - * @memberof IdentityDeletedIdentityV2025 - */ - 'name': string; -} - -export const IdentityDeletedIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityDeletedIdentityV2025TypeV2025 = typeof IdentityDeletedIdentityV2025TypeV2025[keyof typeof IdentityDeletedIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface IdentityDeletedV2025 - */ -export interface IdentityDeletedV2025 { - /** - * - * @type {IdentityDeletedIdentityV2025} - * @memberof IdentityDeletedV2025 - */ - 'identity': IdentityDeletedIdentityV2025; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityDeletedV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Identity\'s identity profile. - * @export - * @interface IdentityDocumentAllOfIdentityProfileV2025 - */ -export interface IdentityDocumentAllOfIdentityProfileV2025 { - /** - * Identity profile\'s ID. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2025 - */ - 'id'?: string; - /** - * Identity profile\'s name. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2025 - */ - 'name'?: string; -} -/** - * Identity\'s manager. - * @export - * @interface IdentityDocumentAllOfManagerV2025 - */ -export interface IdentityDocumentAllOfManagerV2025 { - /** - * ID of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2025 - */ - 'id'?: string; - /** - * Name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2025 - */ - 'name'?: string; - /** - * Display name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2025 - */ - 'displayName'?: string; -} -/** - * Identity\'s source. - * @export - * @interface IdentityDocumentAllOfSourceV2025 - */ -export interface IdentityDocumentAllOfSourceV2025 { - /** - * ID of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2025 - */ - 'id'?: string; - /** - * Display name of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2025 - */ - 'name'?: string; -} -/** - * Identity - * @export - * @interface IdentityDocumentV2025 - */ -export interface IdentityDocumentV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentV2025 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentV2025 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2025} - * @memberof IdentityDocumentV2025 - */ - 'manager'?: IdentityDocumentAllOfManagerV2025 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentV2025 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2025} - * @memberof IdentityDocumentV2025 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2025; - /** - * - * @type {IdentityDocumentAllOfSourceV2025} - * @memberof IdentityDocumentV2025 - */ - 'source'?: IdentityDocumentAllOfSourceV2025; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentV2025 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentV2025 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentV2025 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2025} - * @memberof IdentityDocumentV2025 - */ - 'processingDetails'?: ProcessingDetailsV2025; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentV2025 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentV2025 - */ - 'visibleSegmentCount'?: number; -} -/** - * - * @export - * @interface IdentityDocumentsV2025 - */ -export interface IdentityDocumentsV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentsV2025 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentsV2025 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2025} - * @memberof IdentityDocumentsV2025 - */ - 'manager'?: IdentityDocumentAllOfManagerV2025 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentsV2025 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2025} - * @memberof IdentityDocumentsV2025 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2025; - /** - * - * @type {IdentityDocumentAllOfSourceV2025} - * @memberof IdentityDocumentsV2025 - */ - 'source'?: IdentityDocumentAllOfSourceV2025; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentsV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentsV2025 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentsV2025 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2025} - * @memberof IdentityDocumentsV2025 - */ - 'processingDetails'?: ProcessingDetailsV2025; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentsV2025 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentsV2025 - */ - 'visibleSegmentCount'?: number; - /** - * Name of the pod. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof IdentityDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof IdentityDocumentsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof IdentityDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface IdentityEntitiesIdentityEntityV2025 - */ -export interface IdentityEntitiesIdentityEntityV2025 { - /** - * id of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2025 - */ - 'id'?: string; - /** - * name of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2025 - */ - 'name'?: string; - /** - * type of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface IdentityEntitiesV2025 - */ -export interface IdentityEntitiesV2025 { - /** - * - * @type {IdentityEntitiesIdentityEntityV2025} - * @memberof IdentityEntitiesV2025 - */ - 'identityEntity'?: IdentityEntitiesIdentityEntityV2025; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsAccountTargetV2025 - */ -export interface IdentityEntitlementDetailsAccountTargetV2025 { - /** - * The id of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'accountId'?: string; - /** - * The name of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'accountName'?: string; - /** - * The UUID representation of the account if available - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'accountUUID'?: string | null; - /** - * The id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'sourceId'?: string; - /** - * The name of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'sourceName'?: string; - /** - * The removal date scheduled for the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'removeDate'?: string | null; - /** - * The assignmentId of the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'assignmentId'?: string | null; - /** - * If the entitlement can be revoked - * @type {boolean} - * @memberof IdentityEntitlementDetailsAccountTargetV2025 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsEntitlementDtoV2025 - */ -export interface IdentityEntitlementDetailsEntitlementDtoV2025 { - /** - * The entitlement id - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'name'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'modified'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'description'?: string | null; - /** - * The type of the object, will always be \"ENTITLEMENT\" - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'type'?: string; - /** - * The source ID - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'sourceId'?: string; - /** - * The source name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'sourceName'?: string; - /** - * - * @type {OwnerDtoV2025} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'owner'?: OwnerDtoV2025; - /** - * The value of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'value'?: string; - /** - * a list of properties informing the viewer about the entitlement - * @type {Array} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2025 - */ - 'flags'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsV2025 - */ -export interface IdentityEntitlementDetailsV2025 { - /** - * Id of Identity - * @type {string} - * @memberof IdentityEntitlementDetailsV2025 - */ - 'identityId'?: string; - /** - * - * @type {IdentityEntitlementDetailsEntitlementDtoV2025} - * @memberof IdentityEntitlementDetailsV2025 - */ - 'entitlement'?: IdentityEntitlementDetailsEntitlementDtoV2025; - /** - * Id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsV2025 - */ - 'sourceId'?: string; - /** - * A list of account targets on the identity provisioned with the requested entitlement. - * @type {Array} - * @memberof IdentityEntitlementDetailsV2025 - */ - 'accountTargets'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementsV2025 - */ -export interface IdentityEntitlementsV2025 { - /** - * - * @type {TaggedObjectDtoV2025} - * @memberof IdentityEntitlementsV2025 - */ - 'objectRef'?: TaggedObjectDtoV2025; - /** - * Labels to be applied to object. - * @type {Array} - * @memberof IdentityEntitlementsV2025 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface IdentityExceptionReportReferenceV2025 - */ -export interface IdentityExceptionReportReferenceV2025 { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2025 - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2025 - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityHistoryResponseV2025 - */ -export interface IdentityHistoryResponseV2025 { - /** - * the identity ID - * @type {string} - * @memberof IdentityHistoryResponseV2025 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityHistoryResponseV2025 - */ - 'displayName'?: string; - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentityHistoryResponseV2025 - */ - 'snapshot'?: string; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityHistoryResponseV2025 - */ - 'deletedDate'?: string; - /** - * A map containing the count of each access item - * @type {{ [key: string]: number; }} - * @memberof IdentityHistoryResponseV2025 - */ - 'accessItemCount'?: { [key: string]: number; }; - /** - * A map containing the identity attributes - * @type {{ [key: string]: any; }} - * @memberof IdentityHistoryResponseV2025 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentityLifecycleStateV2025 - */ -export interface IdentityLifecycleStateV2025 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof IdentityLifecycleStateV2025 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof IdentityLifecycleStateV2025 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface IdentityListItemV2025 - */ -export interface IdentityListItemV2025 { - /** - * the identity ID - * @type {string} - * @memberof IdentityListItemV2025 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityListItemV2025 - */ - 'displayName'?: string; - /** - * the first name of the identity - * @type {string} - * @memberof IdentityListItemV2025 - */ - 'firstName'?: string | null; - /** - * the last name of the identity - * @type {string} - * @memberof IdentityListItemV2025 - */ - 'lastName'?: string | null; - /** - * indicates if an identity is active or not - * @type {boolean} - * @memberof IdentityListItemV2025 - */ - 'active'?: boolean; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityListItemV2025 - */ - 'deletedDate'?: string | null; -} -/** - * Identity\'s manager - * @export - * @interface IdentityManagerRefV2025 - */ -export interface IdentityManagerRefV2025 { - /** - * DTO type of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2025 - */ - 'type'?: IdentityManagerRefV2025TypeV2025; - /** - * ID of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2025 - */ - 'name'?: string; -} - -export const IdentityManagerRefV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityManagerRefV2025TypeV2025 = typeof IdentityManagerRefV2025TypeV2025[keyof typeof IdentityManagerRefV2025TypeV2025]; - -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2025 - */ -export interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2025 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2025 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2025 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsV2025 - */ -export interface IdentityOwnershipAssociationDetailsV2025 { - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsV2025 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityPreviewRequestV2025 - */ -export interface IdentityPreviewRequestV2025 { - /** - * The Identity id - * @type {string} - * @memberof IdentityPreviewRequestV2025 - */ - 'identityId'?: string; - /** - * - * @type {IdentityAttributeConfigV2025} - * @memberof IdentityPreviewRequestV2025 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2025; -} -/** - * Identity\'s basic details. - * @export - * @interface IdentityPreviewResponseIdentityV2025 - */ -export interface IdentityPreviewResponseIdentityV2025 { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2025 - */ - 'type'?: IdentityPreviewResponseIdentityV2025TypeV2025; - /** - * Identity ID. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2025 - */ - 'id'?: string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2025 - */ - 'name'?: string; -} - -export const IdentityPreviewResponseIdentityV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityPreviewResponseIdentityV2025TypeV2025 = typeof IdentityPreviewResponseIdentityV2025TypeV2025[keyof typeof IdentityPreviewResponseIdentityV2025TypeV2025]; - -/** - * - * @export - * @interface IdentityPreviewResponseV2025 - */ -export interface IdentityPreviewResponseV2025 { - /** - * - * @type {IdentityPreviewResponseIdentityV2025} - * @memberof IdentityPreviewResponseV2025 - */ - 'identity'?: IdentityPreviewResponseIdentityV2025; - /** - * - * @type {Array} - * @memberof IdentityPreviewResponseV2025 - */ - 'previewAttributes'?: Array; -} -/** - * - * @export - * @interface IdentityProfileAllOfAuthoritativeSourceV2025 - */ -export interface IdentityProfileAllOfAuthoritativeSourceV2025 { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2025 - */ - 'type'?: IdentityProfileAllOfAuthoritativeSourceV2025TypeV2025; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2025 - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2025 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfAuthoritativeSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type IdentityProfileAllOfAuthoritativeSourceV2025TypeV2025 = typeof IdentityProfileAllOfAuthoritativeSourceV2025TypeV2025[keyof typeof IdentityProfileAllOfAuthoritativeSourceV2025TypeV2025]; - -/** - * Identity profile\'s owner. - * @export - * @interface IdentityProfileAllOfOwnerV2025 - */ -export interface IdentityProfileAllOfOwnerV2025 { - /** - * Owner\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2025 - */ - 'type'?: IdentityProfileAllOfOwnerV2025TypeV2025; - /** - * Owner\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2025 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2025 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityProfileAllOfOwnerV2025TypeV2025 = typeof IdentityProfileAllOfOwnerV2025TypeV2025[keyof typeof IdentityProfileAllOfOwnerV2025TypeV2025]; - -/** - * Self block for exported object. - * @export - * @interface IdentityProfileExportedObjectSelfV2025 - */ -export interface IdentityProfileExportedObjectSelfV2025 { - /** - * Exported object\'s DTO type. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2025 - */ - 'type'?: IdentityProfileExportedObjectSelfV2025TypeV2025; - /** - * Exported object\'s ID. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2025 - */ - 'id'?: string; - /** - * Exported object\'s display name. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2025 - */ - 'name'?: string; -} - -export const IdentityProfileExportedObjectSelfV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type IdentityProfileExportedObjectSelfV2025TypeV2025 = typeof IdentityProfileExportedObjectSelfV2025TypeV2025[keyof typeof IdentityProfileExportedObjectSelfV2025TypeV2025]; - -/** - * Identity profile exported object. - * @export - * @interface IdentityProfileExportedObjectV2025 - */ -export interface IdentityProfileExportedObjectV2025 { - /** - * Version or object from the target service. - * @type {number} - * @memberof IdentityProfileExportedObjectV2025 - */ - 'version'?: number; - /** - * - * @type {IdentityProfileExportedObjectSelfV2025} - * @memberof IdentityProfileExportedObjectV2025 - */ - 'self'?: IdentityProfileExportedObjectSelfV2025; - /** - * - * @type {IdentityProfileV2025} - * @memberof IdentityProfileExportedObjectV2025 - */ - 'object'?: IdentityProfileV2025; -} -/** - * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) - * @export - * @interface IdentityProfileIdentityErrorReportArgumentsV2025 - */ -export interface IdentityProfileIdentityErrorReportArgumentsV2025 { - /** - * Source ID. - * @type {string} - * @memberof IdentityProfileIdentityErrorReportArgumentsV2025 - */ - 'authoritativeSource': string; -} -/** - * - * @export - * @interface IdentityProfileV2025 - */ -export interface IdentityProfileV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfileV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfileV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfileV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfileV2025 - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfileV2025 - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwnerV2025} - * @memberof IdentityProfileV2025 - */ - 'owner'?: IdentityProfileAllOfOwnerV2025 | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfileV2025 - */ - 'priority'?: number; - /** - * - * @type {IdentityProfileAllOfAuthoritativeSourceV2025} - * @memberof IdentityProfileV2025 - */ - 'authoritativeSource': IdentityProfileAllOfAuthoritativeSourceV2025; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfileV2025 - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfileV2025 - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfigV2025} - * @memberof IdentityProfileV2025 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2025; - /** - * - * @type {IdentityExceptionReportReferenceV2025} - * @memberof IdentityProfileV2025 - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReferenceV2025 | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfileV2025 - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * - * @export - * @interface IdentityProfilesConnectionsV2025 - */ -export interface IdentityProfilesConnectionsV2025 { - /** - * ID of the IdentityProfile this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the IdentityProfile to which this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2025 - */ - 'name'?: string; - /** - * The Number of Identities managed by this IdentityProfile - * @type {number} - * @memberof IdentityProfilesConnectionsV2025 - */ - 'identityCount'?: number; -} -/** - * Details about the identity correlated with the account. - * @export - * @interface IdentityReference1V2025 - */ -export interface IdentityReference1V2025 { - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof IdentityReference1V2025 - */ - 'id': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof IdentityReference1V2025 - */ - 'name': string; - /** - * The alias of the identity. - * @type {string} - * @memberof IdentityReference1V2025 - */ - 'alias': string; - /** - * The email of the identity. - * @type {string} - * @memberof IdentityReference1V2025 - */ - 'email': string; -} -/** - * The manager for the identity. - * @export - * @interface IdentityReferenceV2025 - */ -export interface IdentityReferenceV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof IdentityReferenceV2025 - */ - 'type'?: DtoTypeV2025; - /** - * Identity id - * @type {string} - * @memberof IdentityReferenceV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof IdentityReferenceV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithNameAndEmailV2025 - */ -export interface IdentityReferenceWithNameAndEmailV2025 { - /** - * The type can only be IDENTITY. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2025 - */ - 'type'?: string; - /** - * Identity ID. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2025 - */ - 'id'?: string; - /** - * Identity\'s human-readable display name. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2025 - */ - 'name'?: string; - /** - * Identity\'s email address. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2025 - */ - 'email'?: string | null; -} -/** - * - * @export - * @interface IdentitySnapshotSummaryResponseV2025 - */ -export interface IdentitySnapshotSummaryResponseV2025 { - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentitySnapshotSummaryResponseV2025 - */ - 'snapshot'?: string; -} -/** - * - * @export - * @interface IdentitySummaryV2025 - */ -export interface IdentitySummaryV2025 { - /** - * ID of this identity summary - * @type {string} - * @memberof IdentitySummaryV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity - * @type {string} - * @memberof IdentitySummaryV2025 - */ - 'name'?: string; - /** - * ID of the identity that this summary represents - * @type {string} - * @memberof IdentitySummaryV2025 - */ - 'identityId'?: string; - /** - * Indicates if all access items for this summary have been decided on - * @type {boolean} - * @memberof IdentitySummaryV2025 - */ - 'completed'?: boolean; -} -/** - * - * @export - * @interface IdentitySyncJobV2025 - */ -export interface IdentitySyncJobV2025 { - /** - * Job ID. - * @type {string} - * @memberof IdentitySyncJobV2025 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof IdentitySyncJobV2025 - */ - 'status': IdentitySyncJobV2025StatusV2025; - /** - * - * @type {IdentitySyncPayloadV2025} - * @memberof IdentitySyncJobV2025 - */ - 'payload': IdentitySyncPayloadV2025; -} - -export const IdentitySyncJobV2025StatusV2025 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type IdentitySyncJobV2025StatusV2025 = typeof IdentitySyncJobV2025StatusV2025[keyof typeof IdentitySyncJobV2025StatusV2025]; - -/** - * - * @export - * @interface IdentitySyncPayloadV2025 - */ -export interface IdentitySyncPayloadV2025 { - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2025 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2025 - */ - 'dataJson': string; -} -/** - * - * @export - * @interface IdentityV2025 - */ -export interface IdentityV2025 { - /** - * System-generated unique ID of the identity - * @type {string} - * @memberof IdentityV2025 - */ - 'id'?: string; - /** - * The identity\'s name is equivalent to its Display Name attribute. - * @type {string} - * @memberof IdentityV2025 - */ - 'name': string; - /** - * Creation date of the identity - * @type {string} - * @memberof IdentityV2025 - */ - 'created'?: string; - /** - * Last modification date of the identity - * @type {string} - * @memberof IdentityV2025 - */ - 'modified'?: string; - /** - * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. - * @type {string} - * @memberof IdentityV2025 - */ - 'alias'?: string; - /** - * The email address of the identity - * @type {string} - * @memberof IdentityV2025 - */ - 'emailAddress'?: string | null; - /** - * The processing state of the identity - * @type {string} - * @memberof IdentityV2025 - */ - 'processingState'?: IdentityV2025ProcessingStateV2025 | null; - /** - * The identity\'s status in the system - * @type {string} - * @memberof IdentityV2025 - */ - 'identityStatus'?: IdentityV2025IdentityStatusV2025; - /** - * - * @type {IdentityManagerRefV2025} - * @memberof IdentityV2025 - */ - 'managerRef'?: IdentityManagerRefV2025 | null; - /** - * Whether this identity is a manager of another identity - * @type {boolean} - * @memberof IdentityV2025 - */ - 'isManager'?: boolean; - /** - * The last time the identity was refreshed by the system - * @type {string} - * @memberof IdentityV2025 - */ - 'lastRefresh'?: string; - /** - * A map with the identity attributes for the identity - * @type {object} - * @memberof IdentityV2025 - */ - 'attributes'?: object; - /** - * - * @type {IdentityLifecycleStateV2025} - * @memberof IdentityV2025 - */ - 'lifecycleState'?: IdentityLifecycleStateV2025; -} - -export const IdentityV2025ProcessingStateV2025 = { - Error: 'ERROR', - Ok: 'OK' -} as const; - -export type IdentityV2025ProcessingStateV2025 = typeof IdentityV2025ProcessingStateV2025[keyof typeof IdentityV2025ProcessingStateV2025]; -export const IdentityV2025IdentityStatusV2025 = { - Unregistered: 'UNREGISTERED', - Registered: 'REGISTERED', - Pending: 'PENDING', - Warning: 'WARNING', - Disabled: 'DISABLED', - Active: 'ACTIVE', - Deactivated: 'DEACTIVATED', - Terminated: 'TERMINATED', - Error: 'ERROR', - Locked: 'LOCKED' -} as const; - -export type IdentityV2025IdentityStatusV2025 = typeof IdentityV2025IdentityStatusV2025[keyof typeof IdentityV2025IdentityStatusV2025]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface IdentityWithNewAccessAccessRefsInnerV2025 - */ -export interface IdentityWithNewAccessAccessRefsInnerV2025 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2025 - */ - 'type'?: IdentityWithNewAccessAccessRefsInnerV2025TypeV2025; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2025 - */ - 'id'?: string; -} - -export const IdentityWithNewAccessAccessRefsInnerV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type IdentityWithNewAccessAccessRefsInnerV2025TypeV2025 = typeof IdentityWithNewAccessAccessRefsInnerV2025TypeV2025[keyof typeof IdentityWithNewAccessAccessRefsInnerV2025TypeV2025]; - -/** - * An identity with a set of access to be added - * @export - * @interface IdentityWithNewAccessV2025 - */ -export interface IdentityWithNewAccessV2025 { - /** - * Identity id to be checked. - * @type {string} - * @memberof IdentityWithNewAccessV2025 - */ - 'identityId': string; - /** - * The list of entitlements to consider for possible violations in a preventive check. - * @type {Array} - * @memberof IdentityWithNewAccessV2025 - */ - 'accessRefs': Array; -} -/** - * - * @export - * @interface IdpDetailsV2025 - */ -export interface IdpDetailsV2025 { - /** - * Federation protocol role - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'role'?: IdpDetailsV2025RoleV2025; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof IdpDetailsV2025 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2025} - * @memberof IdpDetailsV2025 - */ - 'jitConfiguration'?: JITConfigurationV2025; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2025 - */ - 'certificateName'?: string; -} - -export const IdpDetailsV2025RoleV2025 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type IdpDetailsV2025RoleV2025 = typeof IdpDetailsV2025RoleV2025[keyof typeof IdpDetailsV2025RoleV2025]; - -/** - * - * @export - * @interface ImportAccountsRequestV2025 - */ -export interface ImportAccountsRequestV2025 { - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof ImportAccountsRequestV2025 - */ - 'file'?: File; - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof ImportAccountsRequestV2025 - */ - 'disableOptimization'?: string; -} -/** - * - * @export - * @interface ImportEntitlementsBySourceRequestV2025 - */ -export interface ImportEntitlementsBySourceRequestV2025 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsBySourceRequestV2025 - */ - 'csvFile'?: File; -} -/** - * - * @export - * @interface ImportEntitlementsRequestV2025 - */ -export interface ImportEntitlementsRequestV2025 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsRequestV2025 - */ - 'file'?: File; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseErrorsInnerV2025 - */ -export interface ImportFormDefinitions202ResponseErrorsInnerV2025 { - /** - * - * @type {{ [key: string]: object; }} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2025 - */ - 'detail'?: { [key: string]: object; }; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2025 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2025 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseV2025 - */ -export interface ImportFormDefinitions202ResponseV2025 { - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2025 - */ - 'errors'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2025 - */ - 'importedObjects'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2025 - */ - 'infos'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2025 - */ - 'warnings'?: Array; -} -/** - * - * @export - * @interface ImportFormDefinitionsRequestInnerV2025 - */ -export interface ImportFormDefinitionsRequestInnerV2025 { - /** - * - * @type {FormDefinitionResponseV2025} - * @memberof ImportFormDefinitionsRequestInnerV2025 - */ - 'object'?: FormDefinitionResponseV2025; - /** - * - * @type {string} - * @memberof ImportFormDefinitionsRequestInnerV2025 - */ - 'self'?: string; - /** - * - * @type {number} - * @memberof ImportFormDefinitionsRequestInnerV2025 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ImportNonEmployeeRecordsInBulkRequestV2025 - */ -export interface ImportNonEmployeeRecordsInBulkRequestV2025 { - /** - * - * @type {File} - * @memberof ImportNonEmployeeRecordsInBulkRequestV2025 - */ - 'data': File; -} -/** - * Object created or updated by import. - * @export - * @interface ImportObjectV2025 - */ -export interface ImportObjectV2025 { - /** - * DTO type of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2025 - */ - 'type'?: ImportObjectV2025TypeV2025; - /** - * ID of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2025 - */ - 'id'?: string; - /** - * Display name of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2025 - */ - 'name'?: string; -} - -export const ImportObjectV2025TypeV2025 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportObjectV2025TypeV2025 = typeof ImportObjectV2025TypeV2025[keyof typeof ImportObjectV2025TypeV2025]; - -/** - * - * @export - * @interface ImportOptionsV2025 - */ -export interface ImportOptionsV2025 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ImportOptionsV2025 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ImportOptionsV2025 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2025; }} - * @memberof ImportOptionsV2025 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2025; }; - /** - * List of object types that can be used to resolve references on import. - * @type {Array} - * @memberof ImportOptionsV2025 - */ - 'defaultReferences'?: Array; - /** - * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. - * @type {boolean} - * @memberof ImportOptionsV2025 - */ - 'excludeBackup'?: boolean; -} - -export const ImportOptionsV2025ExcludeTypesV2025 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2025ExcludeTypesV2025 = typeof ImportOptionsV2025ExcludeTypesV2025[keyof typeof ImportOptionsV2025ExcludeTypesV2025]; -export const ImportOptionsV2025IncludeTypesV2025 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2025IncludeTypesV2025 = typeof ImportOptionsV2025IncludeTypesV2025[keyof typeof ImportOptionsV2025IncludeTypesV2025]; -export const ImportOptionsV2025DefaultReferencesV2025 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2025DefaultReferencesV2025 = typeof ImportOptionsV2025DefaultReferencesV2025[keyof typeof ImportOptionsV2025DefaultReferencesV2025]; - -/** - * - * @export - * @interface ImportSpConfigRequestV2025 - */ -export interface ImportSpConfigRequestV2025 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ImportSpConfigRequestV2025 - */ - 'data': File; - /** - * - * @type {ImportOptionsV2025} - * @memberof ImportSpConfigRequestV2025 - */ - 'options'?: ImportOptionsV2025; -} -/** - * - * @export - * @interface IndexOfV2025 - */ -export interface IndexOfV2025 { - /** - * A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - * @type {string} - * @memberof IndexOfV2025 - */ - 'substring': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IndexOfV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IndexOfV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Enum representing the currently supported indices. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const IndexV2025 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles', - Star: '*' -} as const; - -export type IndexV2025 = typeof IndexV2025[keyof typeof IndexV2025]; - - -/** - * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - * @export - * @interface InnerHitV2025 - */ -export interface InnerHitV2025 { - /** - * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof InnerHitV2025 - */ - 'query': string; - /** - * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. - * @type {string} - * @memberof InnerHitV2025 - */ - 'type': string; -} -/** - * - * @export - * @interface Int64StringKeyValuePairV2025 - */ -export interface Int64StringKeyValuePairV2025 { - /** - * The key for the tag or pair. - * @type {number} - * @memberof Int64StringKeyValuePairV2025 - */ - 'key'?: number; - /** - * The value for the tag or pair. - * @type {string} - * @memberof Int64StringKeyValuePairV2025 - */ - 'value'?: string | null; -} -/** - * - * @export - * @interface InviteIdentitiesRequestV2025 - */ -export interface InviteIdentitiesRequestV2025 { - /** - * The list of Identities IDs to invite - required when \'uninvited\' is false - * @type {Array} - * @memberof InviteIdentitiesRequestV2025 - */ - 'ids'?: Array | null; - /** - * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. - * @type {boolean} - * @memberof InviteIdentitiesRequestV2025 - */ - 'uninvited'?: boolean; -} -/** - * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. - * @export - * @enum {string} - */ - -export const InvocationStatusTypeV2025 = { - Test: 'TEST', - RealTime: 'REAL_TIME' -} as const; - -export type InvocationStatusTypeV2025 = typeof InvocationStatusTypeV2025[keyof typeof InvocationStatusTypeV2025]; - - -/** - * - * @export - * @interface InvocationStatusV2025 - */ -export interface InvocationStatusV2025 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'id': string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'triggerId': string; - /** - * Subscription name - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'subscriptionName': string; - /** - * Subscription ID - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'subscriptionId': string; - /** - * - * @type {InvocationStatusTypeV2025} - * @memberof InvocationStatusV2025 - */ - 'type': InvocationStatusTypeV2025; - /** - * Invocation created timestamp. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'created': string; - /** - * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2025 - */ - 'completed'?: string; - /** - * - * @type {StartInvocationInputV2025} - * @memberof InvocationStatusV2025 - */ - 'startInvocationInput': StartInvocationInputV2025; - /** - * - * @type {CompleteInvocationInputV2025} - * @memberof InvocationStatusV2025 - */ - 'completeInvocationInput'?: CompleteInvocationInputV2025; -} - - -/** - * - * @export - * @interface InvocationV2025 - */ -export interface InvocationV2025 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationV2025 - */ - 'id'?: string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationV2025 - */ - 'triggerId'?: string; - /** - * Unique invocation secret. - * @type {string} - * @memberof InvocationV2025 - */ - 'secret'?: string; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof InvocationV2025 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface JITConfigurationV2025 - */ -export interface JITConfigurationV2025 { - /** - * The indicator for just-in-time provisioning enabled - * @type {boolean} - * @memberof JITConfigurationV2025 - */ - 'enabled'?: boolean; - /** - * the sourceId that mapped to just-in-time provisioning configuration - * @type {string} - * @memberof JITConfigurationV2025 - */ - 'sourceId'?: string; - /** - * A mapping of identity profile attribute names to SAML assertion attribute names - * @type {{ [key: string]: string; }} - * @memberof JITConfigurationV2025 - */ - 'sourceAttributeMappings'?: { [key: string]: string; }; -} -/** - * JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests. - * @export - * @interface JWKSV2025 - */ -export interface JWKSV2025 { - /** - * Array of JSON Web Keys. - * @type {Array} - * @memberof JWKSV2025 - */ - 'keys': Array; -} -/** - * A single JSON Web Key used for verifying signed delivery requests. - * @export - * @interface JWKV2025 - */ -export interface JWKV2025 { - /** - * Algorithm intended for use with the key (e.g. RS256). - * @type {string} - * @memberof JWKV2025 - */ - 'alg'?: string; - /** - * RSA public exponent (Base64url encoded). - * @type {string} - * @memberof JWKV2025 - */ - 'e'?: string; - /** - * Key ID - unique identifier for the key. - * @type {string} - * @memberof JWKV2025 - */ - 'kid'?: string; - /** - * Key type (e.g. RSA). - * @type {string} - * @memberof JWKV2025 - */ - 'kty'?: string; - /** - * RSA modulus (Base64url encoded). - * @type {string} - * @memberof JWKV2025 - */ - 'n'?: string; - /** - * Intended use of the key (e.g. sig for signature verification). - * @type {string} - * @memberof JWKV2025 - */ - 'use'?: string; -} -/** - * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationRoleMiningV2025 - */ -export interface JsonPatchOperationRoleMiningV2025 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2025 - */ - 'op': JsonPatchOperationRoleMiningV2025OpV2025; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2025 - */ - 'path': string; - /** - * - * @type {JsonPatchOperationRoleMiningValueV2025} - * @memberof JsonPatchOperationRoleMiningV2025 - */ - 'value'?: JsonPatchOperationRoleMiningValueV2025; -} - -export const JsonPatchOperationRoleMiningV2025OpV2025 = { - Remove: 'remove', - Replace: 'replace' -} as const; - -export type JsonPatchOperationRoleMiningV2025OpV2025 = typeof JsonPatchOperationRoleMiningV2025OpV2025[keyof typeof JsonPatchOperationRoleMiningV2025OpV2025]; - -/** - * @type JsonPatchOperationRoleMiningValueV2025 - * The value to be used for the operation, required for \"replace\" operations - * @export - */ -export type JsonPatchOperationRoleMiningValueV2025 = Array | boolean | number | object | string; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationV2025 - */ -export interface JsonPatchOperationV2025 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationV2025 - */ - 'op': JsonPatchOperationV2025OpV2025; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationV2025 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2025} - * @memberof JsonPatchOperationV2025 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2025; -} - -export const JsonPatchOperationV2025OpV2025 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type JsonPatchOperationV2025OpV2025 = typeof JsonPatchOperationV2025OpV2025[keyof typeof JsonPatchOperationV2025OpV2025]; - -/** - * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchV2025 - */ -export interface JsonPatchV2025 { - /** - * Operations to be applied - * @type {Array} - * @memberof JsonPatchV2025 - */ - 'operations'?: Array; -} -/** - * - * @export - * @interface KbaAnswerRequestItemV2025 - */ -export interface KbaAnswerRequestItemV2025 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerRequestItemV2025 - */ - 'id': string; - /** - * An answer for the KBA question - * @type {string} - * @memberof KbaAnswerRequestItemV2025 - */ - 'answer': string; -} -/** - * - * @export - * @interface KbaAnswerResponseItemV2025 - */ -export interface KbaAnswerResponseItemV2025 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerResponseItemV2025 - */ - 'id': string; - /** - * Question description - * @type {string} - * @memberof KbaAnswerResponseItemV2025 - */ - 'question': string; - /** - * Denotes whether the KBA question has an answer configured for the current user - * @type {boolean} - * @memberof KbaAnswerResponseItemV2025 - */ - 'hasAnswer': boolean; -} -/** - * KBA Configuration - * @export - * @interface KbaQuestionV2025 - */ -export interface KbaQuestionV2025 { - /** - * KBA Question Id - * @type {string} - * @memberof KbaQuestionV2025 - */ - 'id': string; - /** - * KBA Question description - * @type {string} - * @memberof KbaQuestionV2025 - */ - 'text': string; - /** - * Denotes whether the KBA question has an answer configured for any user in the tenant - * @type {boolean} - * @memberof KbaQuestionV2025 - */ - 'hasAnswer': boolean; - /** - * Denotes the number of KBA configurations for this question - * @type {number} - * @memberof KbaQuestionV2025 - */ - 'numAnswers': number; -} -/** - * - * @export - * @interface LatestOutlierSummaryV2025 - */ -export interface LatestOutlierSummaryV2025 { - /** - * The type of outlier summary - * @type {string} - * @memberof LatestOutlierSummaryV2025 - */ - 'type'?: LatestOutlierSummaryV2025TypeV2025; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof LatestOutlierSummaryV2025 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2025 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2025 - */ - 'totalIdentities'?: number; - /** - * Total number of ignored outliers - * @type {number} - * @memberof LatestOutlierSummaryV2025 - */ - 'totalIgnored'?: number; -} - -export const LatestOutlierSummaryV2025TypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type LatestOutlierSummaryV2025TypeV2025 = typeof LatestOutlierSummaryV2025TypeV2025[keyof typeof LatestOutlierSummaryV2025TypeV2025]; - -/** - * Owner of the Launcher - * @export - * @interface LauncherOwnerV2025 - */ -export interface LauncherOwnerV2025 { - /** - * Owner type - * @type {string} - * @memberof LauncherOwnerV2025 - */ - 'type': string; - /** - * Owner ID - * @type {string} - * @memberof LauncherOwnerV2025 - */ - 'id': string; -} -/** - * - * @export - * @interface LauncherReferenceV2025 - */ -export interface LauncherReferenceV2025 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2025 - */ - 'type'?: LauncherReferenceV2025TypeV2025; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2025 - */ - 'id'?: string; -} - -export const LauncherReferenceV2025TypeV2025 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherReferenceV2025TypeV2025 = typeof LauncherReferenceV2025TypeV2025[keyof typeof LauncherReferenceV2025TypeV2025]; - -/** - * - * @export - * @interface LauncherRequestReferenceV2025 - */ -export interface LauncherRequestReferenceV2025 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2025 - */ - 'type': LauncherRequestReferenceV2025TypeV2025; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2025 - */ - 'id': string; -} - -export const LauncherRequestReferenceV2025TypeV2025 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherRequestReferenceV2025TypeV2025 = typeof LauncherRequestReferenceV2025TypeV2025[keyof typeof LauncherRequestReferenceV2025TypeV2025]; - -/** - * - * @export - * @interface LauncherRequestV2025 - */ -export interface LauncherRequestV2025 { - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherRequestV2025 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherRequestV2025 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherRequestV2025 - */ - 'type': LauncherRequestV2025TypeV2025; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherRequestV2025 - */ - 'disabled': boolean; - /** - * - * @type {LauncherRequestReferenceV2025} - * @memberof LauncherRequestV2025 - */ - 'reference'?: LauncherRequestReferenceV2025; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherRequestV2025 - */ - 'config': string; -} - -export const LauncherRequestV2025TypeV2025 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherRequestV2025TypeV2025 = typeof LauncherRequestV2025TypeV2025[keyof typeof LauncherRequestV2025TypeV2025]; - -/** - * - * @export - * @interface LauncherV2025 - */ -export interface LauncherV2025 { - /** - * ID of the Launcher - * @type {string} - * @memberof LauncherV2025 - */ - 'id': string; - /** - * Date the Launcher was created - * @type {string} - * @memberof LauncherV2025 - */ - 'created': string; - /** - * Date the Launcher was last modified - * @type {string} - * @memberof LauncherV2025 - */ - 'modified': string; - /** - * - * @type {LauncherOwnerV2025} - * @memberof LauncherV2025 - */ - 'owner': LauncherOwnerV2025; - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherV2025 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherV2025 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherV2025 - */ - 'type': LauncherV2025TypeV2025; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherV2025 - */ - 'disabled': boolean; - /** - * - * @type {LauncherReferenceV2025} - * @memberof LauncherV2025 - */ - 'reference'?: LauncherReferenceV2025; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherV2025 - */ - 'config': string; -} - -export const LauncherV2025TypeV2025 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherV2025TypeV2025 = typeof LauncherV2025TypeV2025[keyof typeof LauncherV2025TypeV2025]; - -/** - * - * @export - * @interface LeftPadV2025 - */ -export interface LeftPadV2025 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof LeftPadV2025 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof LeftPadV2025 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LeftPadV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LeftPadV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LicenseV2025 - */ -export interface LicenseV2025 { - /** - * Name of the license - * @type {string} - * @memberof LicenseV2025 - */ - 'licenseId'?: string; - /** - * Legacy name of the license - * @type {string} - * @memberof LicenseV2025 - */ - 'legacyFeatureName'?: string; -} -/** - * - * @export - * @interface LifecycleStateDtoV2025 - */ -export interface LifecycleStateDtoV2025 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof LifecycleStateDtoV2025 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof LifecycleStateDtoV2025 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface LifecycleStateV2025 - */ -export interface LifecycleStateV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'modified'?: string; - /** - * Indicates whether the lifecycle state is enabled or disabled. - * @type {boolean} - * @memberof LifecycleStateV2025 - */ - 'enabled'?: boolean; - /** - * The lifecycle state\'s technical name. This is for internal use. - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'technicalName': string; - /** - * Lifecycle state\'s description. - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'description'?: string | null; - /** - * Number of identities that have the lifecycle state. - * @type {number} - * @memberof LifecycleStateV2025 - */ - 'identityCount'?: number; - /** - * - * @type {EmailNotificationOptionV2025} - * @memberof LifecycleStateV2025 - */ - 'emailNotificationOption'?: EmailNotificationOptionV2025; - /** - * - * @type {Array} - * @memberof LifecycleStateV2025 - */ - 'accountActions'?: Array; - /** - * List of unique access-profile IDs that are associated with the lifecycle state. - * @type {Set} - * @memberof LifecycleStateV2025 - */ - 'accessProfileIds'?: Set; - /** - * The lifecycle state\'s associated identity state. This field is generally \'null\'. - * @type {string} - * @memberof LifecycleStateV2025 - */ - 'identityState'?: LifecycleStateV2025IdentityStateV2025 | null; - /** - * - * @type {AccessActionConfigurationV2025} - * @memberof LifecycleStateV2025 - */ - 'accessActionConfiguration'?: AccessActionConfigurationV2025; - /** - * Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10. - * @type {number} - * @memberof LifecycleStateV2025 - */ - 'priority'?: number | null; -} - -export const LifecycleStateV2025IdentityStateV2025 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type LifecycleStateV2025IdentityStateV2025 = typeof LifecycleStateV2025IdentityStateV2025[keyof typeof LifecycleStateV2025IdentityStateV2025]; - -/** - * Deleted lifecycle state. - * @export - * @interface LifecyclestateDeletedV2025 - */ -export interface LifecyclestateDeletedV2025 { - /** - * Deleted lifecycle state\'s DTO type. - * @type {string} - * @memberof LifecyclestateDeletedV2025 - */ - 'type'?: LifecyclestateDeletedV2025TypeV2025; - /** - * Deleted lifecycle state ID. - * @type {string} - * @memberof LifecyclestateDeletedV2025 - */ - 'id'?: string; - /** - * Deleted lifecycle state\'s display name. - * @type {string} - * @memberof LifecyclestateDeletedV2025 - */ - 'name'?: string; -} - -export const LifecyclestateDeletedV2025TypeV2025 = { - LifecycleState: 'LIFECYCLE_STATE', - TaskResult: 'TASK_RESULT' -} as const; - -export type LifecyclestateDeletedV2025TypeV2025 = typeof LifecyclestateDeletedV2025TypeV2025[keyof typeof LifecyclestateDeletedV2025TypeV2025]; - -/** - * - * @export - * @interface ListAccessProfiles401ResponseV2025 - */ -export interface ListAccessProfiles401ResponseV2025 { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles401ResponseV2025 - */ - 'error'?: object; -} -/** - * - * @export - * @interface ListAccessProfiles429ResponseV2025 - */ -export interface ListAccessProfiles429ResponseV2025 { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles429ResponseV2025 - */ - 'message'?: object; -} -/** - * - * @export - * @interface ListCampaignFilters200ResponseV2025 - */ -export interface ListCampaignFilters200ResponseV2025 { - /** - * List of campaign filters. - * @type {Array} - * @memberof ListCampaignFilters200ResponseV2025 - */ - 'items'?: Array; - /** - * Number of filters returned. - * @type {number} - * @memberof ListCampaignFilters200ResponseV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ -export interface ListCompleteWorkflowLibrary200ResponseInnerV2025 { - /** - * Operator ID. - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'description'?: string; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2025} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2025; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'isDynamicSchema'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'outputSchema'?: object; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2025 - */ - 'inputExample'?: object | null; -} -/** - * - * @export - * @interface ListDeploys200ResponseV2025 - */ -export interface ListDeploys200ResponseV2025 { - /** - * list of deployments - * @type {Array} - * @memberof ListDeploys200ResponseV2025 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface ListFormDefinitionsByTenantResponseV2025 - */ -export interface ListFormDefinitionsByTenantResponseV2025 { - /** - * Count number of results. - * @type {number} - * @memberof ListFormDefinitionsByTenantResponseV2025 - */ - 'count'?: number; - /** - * List of FormDefinitionResponse items. - * @type {Array} - * @memberof ListFormDefinitionsByTenantResponseV2025 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ListFormElementDataByElementIDResponseV2025 - */ -export interface ListFormElementDataByElementIDResponseV2025 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof ListFormElementDataByElementIDResponseV2025 - */ - 'results'?: Array; -} -/** - * List of FormInstanceResponse items - * @export - * @interface ListFormInstancesByTenantResponseV2025 - */ -export interface ListFormInstancesByTenantResponseV2025 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'state'?: ListFormInstancesByTenantResponseV2025StateV2025; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2025} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'createdBy'?: FormInstanceCreatedByV2025; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2025 - */ - 'recipients'?: Array; -} - -export const ListFormInstancesByTenantResponseV2025StateV2025 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type ListFormInstancesByTenantResponseV2025StateV2025 = typeof ListFormInstancesByTenantResponseV2025StateV2025[keyof typeof ListFormInstancesByTenantResponseV2025StateV2025]; - -/** - * - * @export - * @interface ListIdentityAccessItems200ResponseInnerV2025 - */ -export interface ListIdentityAccessItems200ResponseInnerV2025 { - /** - * the access item id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2025 - */ - 'appRoleId': string | null; -} -/** - * @type ListIdentitySnapshotAccessItems200ResponseInnerV2025 - * @export - */ -export type ListIdentitySnapshotAccessItems200ResponseInnerV2025 = AccessItemAccessProfileResponseV2025 | AccessItemAccountResponseV2025 | AccessItemAppResponseV2025 | AccessItemEntitlementResponseV2025 | AccessItemRoleResponseV2025; - -/** - * - * @export - * @interface ListPredefinedSelectOptionsResponseV2025 - */ -export interface ListPredefinedSelectOptionsResponseV2025 { - /** - * Results holds a list of PreDefinedSelectOption items - * @type {Array} - * @memberof ListPredefinedSelectOptionsResponseV2025 - */ - 'results'?: Array; -} -/** - * Identity of workgroup member. - * @export - * @interface ListWorkgroupMembers200ResponseInnerV2025 - */ -export interface ListWorkgroupMembers200ResponseInnerV2025 { - /** - * Workgroup member identity DTO type. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2025 - */ - 'type'?: ListWorkgroupMembers200ResponseInnerV2025TypeV2025; - /** - * Workgroup member identity ID. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2025 - */ - 'id'?: string; - /** - * Workgroup member identity display name. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2025 - */ - 'name'?: string; - /** - * Workgroup member identity email. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2025 - */ - 'email'?: string; -} - -export const ListWorkgroupMembers200ResponseInnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ListWorkgroupMembers200ResponseInnerV2025TypeV2025 = typeof ListWorkgroupMembers200ResponseInnerV2025TypeV2025[keyof typeof ListWorkgroupMembers200ResponseInnerV2025TypeV2025]; - -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadAccountsTaskTaskAttributesV2025 - */ -export interface LoadAccountsTaskTaskAttributesV2025 { - [key: string]: object | any; - - /** - * The id of the source - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2025 - */ - 'appId'?: string; - /** - * The indicator if the aggregation process was enabled/disabled for the aggregation job - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2025 - */ - 'optimizedAggregation'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskMessagesInnerV2025 - */ -export interface LoadAccountsTaskTaskMessagesInnerV2025 { - /** - * Type of the message. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2025 - */ - 'type'?: LoadAccountsTaskTaskMessagesInnerV2025TypeV2025; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2025 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2025 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2025 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2025 - */ - 'localizedText'?: string; -} - -export const LoadAccountsTaskTaskMessagesInnerV2025TypeV2025 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadAccountsTaskTaskMessagesInnerV2025TypeV2025 = typeof LoadAccountsTaskTaskMessagesInnerV2025TypeV2025[keyof typeof LoadAccountsTaskTaskMessagesInnerV2025TypeV2025]; - -/** - * - * @export - * @interface LoadAccountsTaskTaskReturnsInnerV2025 - */ -export interface LoadAccountsTaskTaskReturnsInnerV2025 { - /** - * The display label of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2025 - */ - 'displayLabel'?: string; - /** - * The attribute name of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2025 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskV2025 - */ -export interface LoadAccountsTaskTaskV2025 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'type'?: string; - /** - * The name of the aggregation process - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'completionStatus'?: LoadAccountsTaskTaskV2025CompletionStatusV2025 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'progress'?: string | null; - /** - * - * @type {LoadAccountsTaskTaskAttributesV2025} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'attributes'?: LoadAccountsTaskTaskAttributesV2025; - /** - * Return values from the task - * @type {Array} - * @memberof LoadAccountsTaskTaskV2025 - */ - 'returns'?: Array; -} - -export const LoadAccountsTaskTaskV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadAccountsTaskTaskV2025CompletionStatusV2025 = typeof LoadAccountsTaskTaskV2025CompletionStatusV2025[keyof typeof LoadAccountsTaskTaskV2025CompletionStatusV2025]; - -/** - * - * @export - * @interface LoadAccountsTaskV2025 - */ -export interface LoadAccountsTaskV2025 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadAccountsTaskV2025 - */ - 'success'?: boolean; - /** - * - * @type {LoadAccountsTaskTaskV2025} - * @memberof LoadAccountsTaskV2025 - */ - 'task'?: LoadAccountsTaskTaskV2025; -} -/** - * - * @export - * @interface LoadEntitlementTaskReturnsInnerV2025 - */ -export interface LoadEntitlementTaskReturnsInnerV2025 { - /** - * The display label for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2025 - */ - 'displayLabel'?: string; - /** - * The attribute name for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2025 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadEntitlementTaskV2025 - */ -export interface LoadEntitlementTaskV2025 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'type'?: string; - /** - * The name of the task - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'uniqueName'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'launcher'?: string; - /** - * The creation date of the task - * @type {string} - * @memberof LoadEntitlementTaskV2025 - */ - 'created'?: string; - /** - * Return values from the task - * @type {Array} - * @memberof LoadEntitlementTaskV2025 - */ - 'returns'?: Array; -} -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadUncorrelatedAccountsTaskTaskAttributesV2025 - */ -export interface LoadUncorrelatedAccountsTaskTaskAttributesV2025 { - /** - * The id of qpoc job - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2025 - */ - 'qpocJobId'?: string; - /** - * the task start delay value - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2025 - */ - 'taskStartDelay'?: object; -} -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ -export interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 { - /** - * Type of the message. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ - 'type'?: LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025TypeV2025; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025 - */ - 'localizedText'?: string; -} - -export const LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025TypeV2025 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025TypeV2025 = typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025TypeV2025[keyof typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2025TypeV2025]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskV2025 - */ -export interface LoadUncorrelatedAccountsTaskTaskV2025 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'type'?: string; - /** - * The name of uncorrelated accounts process - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'completionStatus'?: LoadUncorrelatedAccountsTaskTaskV2025CompletionStatusV2025 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'progress'?: string | null; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskAttributesV2025} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'attributes'?: LoadUncorrelatedAccountsTaskTaskAttributesV2025; - /** - * Return values from the task - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskV2025 - */ - 'returns'?: object; -} - -export const LoadUncorrelatedAccountsTaskTaskV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskV2025CompletionStatusV2025 = typeof LoadUncorrelatedAccountsTaskTaskV2025CompletionStatusV2025[keyof typeof LoadUncorrelatedAccountsTaskTaskV2025CompletionStatusV2025]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskV2025 - */ -export interface LoadUncorrelatedAccountsTaskV2025 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskV2025 - */ - 'success'?: boolean; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskV2025} - * @memberof LoadUncorrelatedAccountsTaskV2025 - */ - 'task'?: LoadUncorrelatedAccountsTaskTaskV2025; -} -/** - * 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 LocaleOriginV2025 = { - Default: 'DEFAULT', - Request: 'REQUEST' -} as const; - -export type LocaleOriginV2025 = typeof LocaleOriginV2025[keyof typeof LocaleOriginV2025]; - - -/** - * Localized error message to indicate a failed invocation or error if any. - * @export - * @interface LocalizedMessageV2025 - */ -export interface LocalizedMessageV2025 { - /** - * Message locale - * @type {string} - * @memberof LocalizedMessageV2025 - */ - 'locale': string; - /** - * Message text - * @type {string} - * @memberof LocalizedMessageV2025 - */ - 'message': string; -} -/** - * - * @export - * @interface LockoutConfigurationV2025 - */ -export interface LockoutConfigurationV2025 { - /** - * The maximum attempts allowed before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2025 - */ - 'maximumAttempts'?: number; - /** - * The total time in minutes a user will be locked out. - * @type {number} - * @memberof LockoutConfigurationV2025 - */ - 'lockoutDuration'?: number; - /** - * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2025 - */ - 'lockoutWindow'?: number; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface LookupStepV2025 - */ -export interface LookupStepV2025 { - /** - * The ID of the Identity who work is reassigned to - * @type {string} - * @memberof LookupStepV2025 - */ - 'reassignedToId'?: string; - /** - * The ID of the Identity who work is reassigned from - * @type {string} - * @memberof LookupStepV2025 - */ - 'reassignedFromId'?: string; - /** - * - * @type {ReassignmentTypeEnumV2025} - * @memberof LookupStepV2025 - */ - 'reassignmentType'?: ReassignmentTypeEnumV2025; -} - - -/** - * - * @export - * @interface LookupV2025 - */ -export interface LookupV2025 { - /** - * This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform. - * @type {{ [key: string]: any; }} - * @memberof LookupV2025 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LookupV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LookupV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LowerV2025 - */ -export interface LowerV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LowerV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LowerV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MachineAccountV2025 - */ -export interface MachineAccountV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineAccountV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineAccountV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineAccountV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineAccountV2025 - */ - 'modified'?: string; - /** - * A description of the machine account - * @type {string} - * @memberof MachineAccountV2025 - */ - 'description'?: string | null; - /** - * The unique ID of the machine account generated by the source system - * @type {string} - * @memberof MachineAccountV2025 - */ - 'nativeIdentity': string; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof MachineAccountV2025 - */ - 'uuid'?: string | null; - /** - * Classification Method - * @type {string} - * @memberof MachineAccountV2025 - */ - 'classificationMethod': MachineAccountV2025ClassificationMethodV2025; - /** - * The machine identity this account is associated with - * @type {object} - * @memberof MachineAccountV2025 - */ - 'machineIdentity'?: object; - /** - * The identity who owns this account. - * @type {object} - * @memberof MachineAccountV2025 - */ - 'ownerIdentity'?: object | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof MachineAccountV2025 - */ - 'accessType'?: string; - /** - * The sub-type - * @type {string} - * @memberof MachineAccountV2025 - */ - 'subtype'?: string | null; - /** - * Environment - * @type {string} - * @memberof MachineAccountV2025 - */ - 'environment'?: string | null; - /** - * Custom attributes specific to the machine account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2025 - */ - 'attributes'?: { [key: string]: any; } | null; - /** - * The connector attributes for the account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2025 - */ - 'connectorAttributes': { [key: string]: any; } | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof MachineAccountV2025 - */ - 'manuallyCorrelated'?: boolean; - /** - * Indicates if the account has been manually edited - * @type {boolean} - * @memberof MachineAccountV2025 - */ - 'manuallyEdited': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof MachineAccountV2025 - */ - 'locked': boolean; - /** - * Indicates if the account is enabled - * @type {boolean} - * @memberof MachineAccountV2025 - */ - 'enabled': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof MachineAccountV2025 - */ - 'hasEntitlements': boolean; - /** - * The source this machine account belongs to. - * @type {object} - * @memberof MachineAccountV2025 - */ - 'source': object; -} - -export const MachineAccountV2025ClassificationMethodV2025 = { - Source: 'SOURCE', - Criteria: 'CRITERIA', - Discovery: 'DISCOVERY', - Manual: 'MANUAL' -} as const; - -export type MachineAccountV2025ClassificationMethodV2025 = typeof MachineAccountV2025ClassificationMethodV2025[keyof typeof MachineAccountV2025ClassificationMethodV2025]; - -/** - * - * @export - * @interface MachineClassificationConfigV2025 - */ -export interface MachineClassificationConfigV2025 { - /** - * Indicates whether Classification is enabled for a Source - * @type {boolean} - * @memberof MachineClassificationConfigV2025 - */ - 'enabled'?: boolean; - /** - * Classification Method - * @type {string} - * @memberof MachineClassificationConfigV2025 - */ - 'classificationMethod'?: MachineClassificationConfigV2025ClassificationMethodV2025; - /** - * - * @type {MachineClassificationCriteriaLevel1V2025} - * @memberof MachineClassificationConfigV2025 - */ - 'criteria'?: MachineClassificationCriteriaLevel1V2025; - /** - * Date the config was created - * @type {string} - * @memberof MachineClassificationConfigV2025 - */ - 'created'?: string; - /** - * Date the config was last updated - * @type {string} - * @memberof MachineClassificationConfigV2025 - */ - 'modified'?: string | null; -} - -export const MachineClassificationConfigV2025ClassificationMethodV2025 = { - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type MachineClassificationConfigV2025ClassificationMethodV2025 = typeof MachineClassificationConfigV2025ClassificationMethodV2025[keyof typeof MachineClassificationConfigV2025ClassificationMethodV2025]; - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel1V2025 - */ -export interface MachineClassificationCriteriaLevel1V2025 { - /** - * - * @type {MachineClassificationCriteriaOperationV2025} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'operation'?: MachineClassificationCriteriaOperationV2025; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel1V2025 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel2V2025 - */ -export interface MachineClassificationCriteriaLevel2V2025 { - /** - * - * @type {MachineClassificationCriteriaOperationV2025} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'operation'?: MachineClassificationCriteriaOperationV2025; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel2V2025 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel3V2025 - */ -export interface MachineClassificationCriteriaLevel3V2025 { - /** - * - * @type {MachineClassificationCriteriaOperationV2025} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'operation'?: MachineClassificationCriteriaOperationV2025; - /** - * Indicates whether or not case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel3V2025 - */ - 'children'?: Array | null; -} - - -/** - * An operation to perform on the classification criteria - * @export - * @enum {string} - */ - -export const MachineClassificationCriteriaOperationV2025 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - Contains: 'CONTAINS', - And: 'AND', - Or: 'OR' -} as const; - -export type MachineClassificationCriteriaOperationV2025 = typeof MachineClassificationCriteriaOperationV2025[keyof typeof MachineClassificationCriteriaOperationV2025]; - - -/** - * - * @export - * @interface MachineIdentityAggregationRequestV2025 - */ -export interface MachineIdentityAggregationRequestV2025 { - /** - * List of dataset Ids to aggregate machine identities - * @type {Array} - * @memberof MachineIdentityAggregationRequestV2025 - */ - 'datasetIds': Array; - /** - * Flag to disable optimization for the aggregation. Defaults to false when not provided. When set to true, it disables aggregation optimizations and may increase processing time. - * @type {boolean} - * @memberof MachineIdentityAggregationRequestV2025 - */ - 'disableOptimization'?: boolean; -} -/** - * The target(source) of the aggregation - * @export - * @interface MachineIdentityAggregationResponseTargetV2025 - */ -export interface MachineIdentityAggregationResponseTargetV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof MachineIdentityAggregationResponseTargetV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityAggregationResponseTargetV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityAggregationResponseTargetV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface MachineIdentityAggregationResponseV2025 - */ -export interface MachineIdentityAggregationResponseV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'id'?: string; - /** - * Type of task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'type'?: MachineIdentityAggregationResponseV2025TypeV2025; - /** - * Name of the task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'uniqueName'?: string; - /** - * Description of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'description'?: string; - /** - * Name of the parent of the task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'parentName'?: string | null; - /** - * Service to execute the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'launcher'?: string; - /** - * - * @type {MachineIdentityAggregationResponseTargetV2025} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'target'?: MachineIdentityAggregationResponseTargetV2025; - /** - * Creation date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'created'?: string; - /** - * Last modification date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'modified'?: string; - /** - * Launch date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'launched'?: string | null; - /** - * Completion date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'completed'?: string | null; - /** - * - * @type {TaskDefinitionSummaryV2025} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2025; - /** - * Completion status of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'completionStatus'?: MachineIdentityAggregationResponseV2025CompletionStatusV2025 | null; - /** - * Messages associated with the aggregation - * @type {Array} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'messages'?: Array; - /** - * Return values associated with the aggregation - * @type {Array} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'returns'?: Array; - /** - * Attributes of the aggregation - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Current progress of aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'progress'?: string | null; - /** - * Current percentage completion of aggregation - * @type {number} - * @memberof MachineIdentityAggregationResponseV2025 - */ - 'percentComplete'?: number; -} - -export const MachineIdentityAggregationResponseV2025TypeV2025 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type MachineIdentityAggregationResponseV2025TypeV2025 = typeof MachineIdentityAggregationResponseV2025TypeV2025[keyof typeof MachineIdentityAggregationResponseV2025TypeV2025]; -export const MachineIdentityAggregationResponseV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type MachineIdentityAggregationResponseV2025CompletionStatusV2025 = typeof MachineIdentityAggregationResponseV2025CompletionStatusV2025[keyof typeof MachineIdentityAggregationResponseV2025CompletionStatusV2025]; - -/** - * Details of the created machine identity. - * @export - * @interface MachineIdentityCreatedMachineIdentityV2025 - */ -export interface MachineIdentityCreatedMachineIdentityV2025 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'subtype': MachineIdentityCreatedMachineIdentityV2025SubtypeV2025; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2025} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'source'?: MachineIdentitySourceReferenceV2025; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2025 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityCreatedMachineIdentityV2025SubtypeV2025 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityCreatedMachineIdentityV2025SubtypeV2025 = typeof MachineIdentityCreatedMachineIdentityV2025SubtypeV2025[keyof typeof MachineIdentityCreatedMachineIdentityV2025SubtypeV2025]; - -/** - * - * @export - * @interface MachineIdentityCreatedV2025 - */ -export interface MachineIdentityCreatedV2025 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityCreatedV2025 - */ - 'eventType': MachineIdentityCreatedV2025EventTypeV2025; - /** - * - * @type {MachineIdentityCreatedMachineIdentityV2025} - * @memberof MachineIdentityCreatedV2025 - */ - 'machineIdentity': MachineIdentityCreatedMachineIdentityV2025; -} - -export const MachineIdentityCreatedV2025EventTypeV2025 = { - MachineIdentityCreated: 'MACHINE_IDENTITY_CREATED' -} as const; - -export type MachineIdentityCreatedV2025EventTypeV2025 = typeof MachineIdentityCreatedV2025EventTypeV2025[keyof typeof MachineIdentityCreatedV2025EventTypeV2025]; - -/** - * Details of the deleted machine identity. - * @export - * @interface MachineIdentityDeletedMachineIdentityV2025 - */ -export interface MachineIdentityDeletedMachineIdentityV2025 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'subtype': MachineIdentityDeletedMachineIdentityV2025SubtypeV2025; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2025} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'source'?: MachineIdentitySourceReferenceV2025; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2025 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityDeletedMachineIdentityV2025SubtypeV2025 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityDeletedMachineIdentityV2025SubtypeV2025 = typeof MachineIdentityDeletedMachineIdentityV2025SubtypeV2025[keyof typeof MachineIdentityDeletedMachineIdentityV2025SubtypeV2025]; - -/** - * - * @export - * @interface MachineIdentityDeletedV2025 - */ -export interface MachineIdentityDeletedV2025 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityDeletedV2025 - */ - 'eventType': MachineIdentityDeletedV2025EventTypeV2025; - /** - * - * @type {MachineIdentityDeletedMachineIdentityV2025} - * @memberof MachineIdentityDeletedV2025 - */ - 'machineIdentity': MachineIdentityDeletedMachineIdentityV2025; -} - -export const MachineIdentityDeletedV2025EventTypeV2025 = { - MachineIdentityDeleted: 'MACHINE_IDENTITY_DELETED' -} as const; - -export type MachineIdentityDeletedV2025EventTypeV2025 = typeof MachineIdentityDeletedV2025EventTypeV2025[keyof typeof MachineIdentityDeletedV2025EventTypeV2025]; - -/** - * The owner configuration associated to the machine identity - * @export - * @interface MachineIdentityDtoOwnersV2025 - */ -export interface MachineIdentityDtoOwnersV2025 { - /** - * Defines the identity which is selected as the primary owner - * @type {object} - * @memberof MachineIdentityDtoOwnersV2025 - */ - 'primaryIdentity': object; - /** - * Defines the identities which are selected as secondary owners - * @type {Array} - * @memberof MachineIdentityDtoOwnersV2025 - */ - 'secondaryIdentities': Array; -} -/** - * Reference to an owner of the machine identity. - * @export - * @interface MachineIdentityOwnerReferenceV2025 - */ -export interface MachineIdentityOwnerReferenceV2025 { - [key: string]: any; - - /** - * Owner\'s type. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2025 - */ - 'type': string; - /** - * Owner ID. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2025 - */ - 'id': string; - /** - * Owner\'s display name. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2025 - */ - 'name': string; - /** - * Indicates if this owner is the primary owner. - * @type {boolean} - * @memberof MachineIdentityOwnerReferenceV2025 - */ - 'isPrimary'?: boolean; -} -/** - * - * @export - * @interface MachineIdentityRequestUserEntitlementsV2025 - */ -export interface MachineIdentityRequestUserEntitlementsV2025 { - /** - * The ID of the entitlement - * @type {string} - * @memberof MachineIdentityRequestUserEntitlementsV2025 - */ - 'entitlementId': string; - /** - * The source ID of the entitlement - * @type {string} - * @memberof MachineIdentityRequestUserEntitlementsV2025 - */ - 'sourceId': string; -} -/** - * - * @export - * @interface MachineIdentityRequestV2025 - */ -export interface MachineIdentityRequestV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'modified'?: string; - /** - * The business application that the identity represents - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'businessApplication': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityRequestV2025 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2025} - * @memberof MachineIdentityRequestV2025 - */ - 'owners'?: MachineIdentityDtoOwnersV2025; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'uuid'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityRequestV2025 - */ - 'nativeIdentity'?: string; - /** - * The user entitlements associated to the machine identity - * @type {Array} - * @memberof MachineIdentityRequestV2025 - */ - 'userEntitlements'?: Array; -} -/** - * - * @export - * @interface MachineIdentityResponseUserEntitlementsV2025 - */ -export interface MachineIdentityResponseUserEntitlementsV2025 { - /** - * The source ID of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2025 - */ - 'sourceId'?: string; - /** - * The ID of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2025 - */ - 'entitlementId'?: string; - /** - * The display name of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2025 - */ - 'displayName'?: string; - /** - * The source of the entitlement - * @type {object} - * @memberof MachineIdentityResponseUserEntitlementsV2025 - */ - 'source'?: object; -} -/** - * - * @export - * @interface MachineIdentityResponseV2025 - */ -export interface MachineIdentityResponseV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'modified'?: string; - /** - * The business application that the identity represents - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'businessApplication': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityResponseV2025 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2025} - * @memberof MachineIdentityResponseV2025 - */ - 'owners'?: MachineIdentityDtoOwnersV2025; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'uuid'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'nativeIdentity'?: string; - /** - * Indicates if the machine identity has been manually edited - * @type {boolean} - * @memberof MachineIdentityResponseV2025 - */ - 'manuallyEdited'?: boolean; - /** - * Indicates if the machine identity has been manually created - * @type {boolean} - * @memberof MachineIdentityResponseV2025 - */ - 'manuallyCreated'?: boolean; - /** - * The source of the machine identity - * @type {object} - * @memberof MachineIdentityResponseV2025 - */ - 'source'?: object; - /** - * The dataset id associated to the source in which the identity was retrieved from - * @type {string} - * @memberof MachineIdentityResponseV2025 - */ - 'datasetId'?: string; - /** - * The user entitlements associated to the machine identity - * @type {Array} - * @memberof MachineIdentityResponseV2025 - */ - 'userEntitlements'?: Array; -} -/** - * Reference to a source of entity. - * @export - * @interface MachineIdentitySourceReferenceV2025 - */ -export interface MachineIdentitySourceReferenceV2025 { - [key: string]: any; - - /** - * Source Type. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2025 - */ - 'type': string; - /** - * Unique identifier. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2025 - */ - 'id': string; - /** - * Display name. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2025 - */ - 'name': string; -} -/** - * Details of the updated machine identity. - * @export - * @interface MachineIdentityUpdatedMachineIdentityV2025 - */ -export interface MachineIdentityUpdatedMachineIdentityV2025 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'subtype': MachineIdentityUpdatedMachineIdentityV2025SubtypeV2025; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2025} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'source'?: MachineIdentitySourceReferenceV2025; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2025 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityUpdatedMachineIdentityV2025SubtypeV2025 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityUpdatedMachineIdentityV2025SubtypeV2025 = typeof MachineIdentityUpdatedMachineIdentityV2025SubtypeV2025[keyof typeof MachineIdentityUpdatedMachineIdentityV2025SubtypeV2025]; - -/** - * Changes to owners. - * @export - * @interface MachineIdentityUpdatedOwnerChangesV2025 - */ -export interface MachineIdentityUpdatedOwnerChangesV2025 { - /** - * Name of the attribute that changed. - * @type {string} - * @memberof MachineIdentityUpdatedOwnerChangesV2025 - */ - 'attributeName'?: string; - /** - * Owners that were added. - * @type {Array} - * @memberof MachineIdentityUpdatedOwnerChangesV2025 - */ - 'added'?: Array; - /** - * Owners that were removed. - * @type {Array} - * @memberof MachineIdentityUpdatedOwnerChangesV2025 - */ - 'removed'?: Array; -} -/** - * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2025 - * The new value of the attribute after the change. - * @export - */ -export type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2025 = Array | boolean | number | string; - -/** - * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2025 - * The old value of the attribute before the change. - * @export - */ -export type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2025 = Array | boolean | number | string; - -/** - * - * @export - * @interface MachineIdentityUpdatedSingleValueAttributeChangesInnerV2025 - */ -export interface MachineIdentityUpdatedSingleValueAttributeChangesInnerV2025 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'name': string; - /** - * - * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2025} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'oldValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2025 | null; - /** - * - * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2025} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2025 - */ - 'newValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2025 | null; -} -/** - * Changes to user entitlements. - * @export - * @interface MachineIdentityUpdatedUserEntitlementChangesV2025 - */ -export interface MachineIdentityUpdatedUserEntitlementChangesV2025 { - /** - * Name of the attribute that changed. - * @type {string} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2025 - */ - 'attributeName'?: string; - /** - * User entitlements that were added. - * @type {Array} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2025 - */ - 'added'?: Array; - /** - * User entitlements that were removed. - * @type {Array} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2025 - */ - 'removed'?: Array; -} -/** - * - * @export - * @interface MachineIdentityUpdatedV2025 - */ -export interface MachineIdentityUpdatedV2025 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityUpdatedV2025 - */ - 'eventType': MachineIdentityUpdatedV2025EventTypeV2025; - /** - * - * @type {MachineIdentityUpdatedMachineIdentityV2025} - * @memberof MachineIdentityUpdatedV2025 - */ - 'machineIdentity': MachineIdentityUpdatedMachineIdentityV2025; - /** - * Types of changes that occurred to the machine identity. - * @type {Array} - * @memberof MachineIdentityUpdatedV2025 - */ - 'machineIdentityChangeTypes': Array; - /** - * - * @type {MachineIdentityUpdatedUserEntitlementChangesV2025} - * @memberof MachineIdentityUpdatedV2025 - */ - 'userEntitlementChanges': MachineIdentityUpdatedUserEntitlementChangesV2025; - /** - * - * @type {MachineIdentityUpdatedOwnerChangesV2025} - * @memberof MachineIdentityUpdatedV2025 - */ - 'ownerChanges': MachineIdentityUpdatedOwnerChangesV2025; - /** - * Details about the single-value attribute changes that occurred. - * @type {Array} - * @memberof MachineIdentityUpdatedV2025 - */ - 'singleValueAttributeChanges': Array | null; -} - -export const MachineIdentityUpdatedV2025EventTypeV2025 = { - MachineIdentityUpdated: 'MACHINE_IDENTITY_UPDATED' -} as const; - -export type MachineIdentityUpdatedV2025EventTypeV2025 = typeof MachineIdentityUpdatedV2025EventTypeV2025[keyof typeof MachineIdentityUpdatedV2025EventTypeV2025]; -export const MachineIdentityUpdatedV2025MachineIdentityChangeTypesV2025 = { - AttributesChanged: 'ATTRIBUTES_CHANGED', - UserEntitlementsAdded: 'USER_ENTITLEMENTS_ADDED', - UserEntitlementsRemoved: 'USER_ENTITLEMENTS_REMOVED', - OwnersAdded: 'OWNERS_ADDED', - OwnersRemoved: 'OWNERS_REMOVED' -} as const; - -export type MachineIdentityUpdatedV2025MachineIdentityChangeTypesV2025 = typeof MachineIdentityUpdatedV2025MachineIdentityChangeTypesV2025[keyof typeof MachineIdentityUpdatedV2025MachineIdentityChangeTypesV2025]; - -/** - * The user entitlement - * @export - * @interface MachineIdentityUserEntitlementResponseEntitlementV2025 - */ -export interface MachineIdentityUserEntitlementResponseEntitlementV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2025 - */ - 'name'?: string; -} - - -/** - * The source of the user entitlement - * @export - * @interface MachineIdentityUserEntitlementResponseSourceV2025 - */ -export interface MachineIdentityUserEntitlementResponseSourceV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof MachineIdentityUserEntitlementResponseSourceV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseSourceV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseSourceV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface MachineIdentityUserEntitlementResponseV2025 - */ -export interface MachineIdentityUserEntitlementResponseV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2025 - */ - 'id'?: string; - /** - * System-generated unique ID of the Machine Identity - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2025 - */ - 'machineIdentityId'?: string; - /** - * - * @type {MachineIdentityUserEntitlementResponseSourceV2025} - * @memberof MachineIdentityUserEntitlementResponseV2025 - */ - 'source'?: MachineIdentityUserEntitlementResponseSourceV2025; - /** - * - * @type {MachineIdentityUserEntitlementResponseEntitlementV2025} - * @memberof MachineIdentityUserEntitlementResponseV2025 - */ - 'entitlement'?: MachineIdentityUserEntitlementResponseEntitlementV2025; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2025 - */ - 'created'?: string; -} -/** - * Reference to a user entitlement. - * @export - * @interface MachineIdentityUserEntitlementsV2025 - */ -export interface MachineIdentityUserEntitlementsV2025 { - [key: string]: any; - - /** - * Entitlement identifier. - * @type {string} - * @memberof MachineIdentityUserEntitlementsV2025 - */ - 'entitlementId': string; - /** - * Display name of the entitlement. - * @type {string} - * @memberof MachineIdentityUserEntitlementsV2025 - */ - 'displayName': string; - /** - * - * @type {MachineIdentitySourceReferenceV2025} - * @memberof MachineIdentityUserEntitlementsV2025 - */ - 'source': MachineIdentitySourceReferenceV2025; -} -/** - * - * @export - * @interface MachineIdentityV2025 - */ -export interface MachineIdentityV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'modified'?: string; - /** - * The business application that the identity represents - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'businessApplication': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityV2025 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2025} - * @memberof MachineIdentityV2025 - */ - 'owners'?: MachineIdentityDtoOwnersV2025; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'uuid'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityV2025 - */ - 'nativeIdentity'?: string; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesDtoV2025 - */ -export interface MailFromAttributesDtoV2025 { - /** - * The identity or domain address - * @type {string} - * @memberof MailFromAttributesDtoV2025 - */ - 'identity'?: string; - /** - * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. - * @type {string} - * @memberof MailFromAttributesDtoV2025 - */ - 'mailFromDomain'?: string; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesV2025 - */ -export interface MailFromAttributesV2025 { - /** - * The email identity - * @type {string} - * @memberof MailFromAttributesV2025 - */ - 'identity'?: string; - /** - * The name of a domain that an email identity uses as a custom MAIL FROM domain - * @type {string} - * @memberof MailFromAttributesV2025 - */ - 'mailFromDomain'?: string; - /** - * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you - * @type {string} - * @memberof MailFromAttributesV2025 - */ - 'mxRecord'?: string; - /** - * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain - * @type {string} - * @memberof MailFromAttributesV2025 - */ - 'txtRecord'?: string; - /** - * The current status of the MAIL FROM verification - * @type {string} - * @memberof MailFromAttributesV2025 - */ - 'mailFromDomainStatus'?: MailFromAttributesV2025MailFromDomainStatusV2025; -} - -export const MailFromAttributesV2025MailFromDomainStatusV2025 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MailFromAttributesV2025MailFromDomainStatusV2025 = typeof MailFromAttributesV2025MailFromDomainStatusV2025[keyof typeof MailFromAttributesV2025MailFromDomainStatusV2025]; - -/** - * Health indicators grouped by category - * @export - * @interface ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025 - */ -export interface ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025 { - /** - * - * @type {HealthIndicatorCategoryV2025} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025 - */ - 'container'?: HealthIndicatorCategoryV2025; - /** - * - * @type {HealthIndicatorCategoryV2025} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025 - */ - 'memory'?: HealthIndicatorCategoryV2025; - /** - * - * @type {HealthIndicatorCategoryV2025} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025 - */ - 'cpu'?: HealthIndicatorCategoryV2025; -} -/** - * Health indicator details from the Managed Client - * @export - * @interface ManagedClientHealthIndicatorsBodyV2025 - */ -export interface ManagedClientHealthIndicatorsBodyV2025 { - /** - * Health indicator alert key - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'alertKey'?: string | null; - /** - * Unique identifier for the health report - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'id': string; - /** - * Cluster ID the health report belongs to - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'clusterId': string; - /** - * API user ID sending the health data - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'apiUser': string; - /** - * ETag value for CCG version control - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'ccg_etag'?: string | null; - /** - * PIN value for CCG validation - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'ccg_pin'?: string | null; - /** - * ETag for cookbook version - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'cookbook_etag'?: string | null; - /** - * Hostname of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'hostname': string; - /** - * Internal IP address of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'internal_ip'?: string; - /** - * Epoch timestamp (in millis) when last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'lastSeen'?: string; - /** - * Seconds since last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'sinceSeen'?: string; - /** - * Milliseconds since last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'sinceSeenMillis'?: string; - /** - * Indicates if this is a local development instance - * @type {boolean} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'localDev'?: boolean; - /** - * Stacktrace associated with any error, if available - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'stacktrace'?: string | null; - /** - * Optional state value from the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'state'?: string | null; - /** - * Status of the client at the time of report - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'status': ManagedClientHealthIndicatorsBodyV2025StatusV2025; - /** - * Optional UUID from the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'uuid'?: string | null; - /** - * Product type (e.g., idn) - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'product': string; - /** - * VA version installed on the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'va_version'?: string | null; - /** - * Version of the platform on which VA is running - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'platform_version': string; - /** - * Operating system version - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'os_version': string; - /** - * Operating system type - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'os_type': string; - /** - * Virtualization platform used - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'hypervisor': string; - /** - * Consolidated health indicator status - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'consolidatedHealthIndicatorsStatus': ManagedClientHealthIndicatorsBodyV2025ConsolidatedHealthIndicatorsStatusV2025; - /** - * The last CCG version for which notification was sent - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'lastNotifiedCcgVersion'?: string; - /** - * Information about deployed processes - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'deployed_processes'?: string | null; - /** - * - * @type {ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025} - * @memberof ManagedClientHealthIndicatorsBodyV2025 - */ - 'health_indicators': ManagedClientHealthIndicatorsBodyHealthIndicatorsV2025; -} - -export const ManagedClientHealthIndicatorsBodyV2025StatusV2025 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientHealthIndicatorsBodyV2025StatusV2025 = typeof ManagedClientHealthIndicatorsBodyV2025StatusV2025[keyof typeof ManagedClientHealthIndicatorsBodyV2025StatusV2025]; -export const ManagedClientHealthIndicatorsBodyV2025ConsolidatedHealthIndicatorsStatusV2025 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClientHealthIndicatorsBodyV2025ConsolidatedHealthIndicatorsStatusV2025 = typeof ManagedClientHealthIndicatorsBodyV2025ConsolidatedHealthIndicatorsStatusV2025[keyof typeof ManagedClientHealthIndicatorsBodyV2025ConsolidatedHealthIndicatorsStatusV2025]; - -/** - * Health Indicators for a Managed Client - * @export - * @interface ManagedClientHealthIndicatorsV2025 - */ -export interface ManagedClientHealthIndicatorsV2025 { - /** - * - * @type {ManagedClientHealthIndicatorsBodyV2025} - * @memberof ManagedClientHealthIndicatorsV2025 - */ - 'body': ManagedClientHealthIndicatorsBodyV2025; - /** - * Top-level status of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2025 - */ - 'status': ManagedClientHealthIndicatorsV2025StatusV2025; - /** - * Type of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2025 - */ - 'type': ManagedClientHealthIndicatorsV2025TypeV2025; - /** - * Timestamp when this report was generated - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2025 - */ - 'timestamp': string; -} - -export const ManagedClientHealthIndicatorsV2025StatusV2025 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientHealthIndicatorsV2025StatusV2025 = typeof ManagedClientHealthIndicatorsV2025StatusV2025[keyof typeof ManagedClientHealthIndicatorsV2025StatusV2025]; -export const ManagedClientHealthIndicatorsV2025TypeV2025 = { - Va: 'VA', - Ccg: 'CCG' -} as const; - -export type ManagedClientHealthIndicatorsV2025TypeV2025 = typeof ManagedClientHealthIndicatorsV2025TypeV2025[keyof typeof ManagedClientHealthIndicatorsV2025TypeV2025]; - -/** - * Managed Client Request - * @export - * @interface ManagedClientRequestV2025 - */ -export interface ManagedClientRequestV2025 { - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientRequestV2025 - */ - 'clusterId': string; - /** - * description for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2025 - */ - 'description'?: string | null; - /** - * name for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2025 - */ - 'name'?: string | null; - /** - * Type of the ManagedClient (VA, CCG) to create - * @type {string} - * @memberof ManagedClientRequestV2025 - */ - 'type'?: string | null; -} -/** - * Status of a Managed Client - * @export - * @enum {string} - */ - -export const ManagedClientStatusCodeV2025 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientStatusCodeV2025 = typeof ManagedClientStatusCodeV2025[keyof typeof ManagedClientStatusCodeV2025]; - - -/** - * Managed Client Status - * @export - * @interface ManagedClientStatusV2025 - */ -export interface ManagedClientStatusV2025 { - /** - * ManagedClientStatus body information - * @type {object} - * @memberof ManagedClientStatusV2025 - */ - 'body': object; - /** - * - * @type {ManagedClientStatusCodeV2025} - * @memberof ManagedClientStatusV2025 - */ - 'status': ManagedClientStatusCodeV2025; - /** - * - * @type {ManagedClientTypeV2025} - * @memberof ManagedClientStatusV2025 - */ - 'type': ManagedClientTypeV2025 | null; - /** - * timestamp on the Client Status update - * @type {string} - * @memberof ManagedClientStatusV2025 - */ - 'timestamp': string; -} - - -/** - * Managed Client type - * @export - * @enum {string} - */ - -export const ManagedClientTypeV2025 = { - Ccg: 'CCG', - Va: 'VA', - Internal: 'INTERNAL', - IiqHarvester: 'IIQ_HARVESTER' -} as const; - -export type ManagedClientTypeV2025 = typeof ManagedClientTypeV2025[keyof typeof ManagedClientTypeV2025]; - - -/** - * Managed Client - * @export - * @interface ManagedClientV2025 - */ -export interface ManagedClientV2025 { - /** - * ManagedClient ID - * @type {string} - * @memberof ManagedClientV2025 - */ - 'id'?: string | null; - /** - * ManagedClient alert key - * @type {string} - * @memberof ManagedClientV2025 - */ - 'alertKey'?: string | null; - /** - * - * @type {string} - * @memberof ManagedClientV2025 - */ - 'apiGatewayBaseUrl'?: string | null; - /** - * - * @type {string} - * @memberof ManagedClientV2025 - */ - 'cookbook'?: string | null; - /** - * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - * @type {number} - * @memberof ManagedClientV2025 - */ - 'ccId'?: number | null; - /** - * The client ID used in API management - * @type {string} - * @memberof ManagedClientV2025 - */ - 'clientId': string; - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientV2025 - */ - 'clusterId': string; - /** - * ManagedClient description - * @type {string} - * @memberof ManagedClientV2025 - */ - 'description': string; - /** - * The public IP address of the ManagedClient - * @type {string} - * @memberof ManagedClientV2025 - */ - 'ipAddress'?: string | null; - /** - * When the ManagedClient was last seen by the server - * @type {string} - * @memberof ManagedClientV2025 - */ - 'lastSeen'?: string | null; - /** - * ManagedClient name - * @type {string} - * @memberof ManagedClientV2025 - */ - 'name'?: string | null; - /** - * Milliseconds since the ManagedClient has polled the server - * @type {string} - * @memberof ManagedClientV2025 - */ - 'sinceLastSeen'?: string | null; - /** - * Status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2025 - */ - 'status'?: ManagedClientV2025StatusV2025 | null; - /** - * Type of the ManagedClient (VA, CCG) - * @type {string} - * @memberof ManagedClientV2025 - */ - 'type': string; - /** - * Cluster Type of the ManagedClient - * @type {string} - * @memberof ManagedClientV2025 - */ - 'clusterType'?: ManagedClientV2025ClusterTypeV2025 | null; - /** - * ManagedClient VA download URL - * @type {string} - * @memberof ManagedClientV2025 - */ - 'vaDownloadUrl'?: string | null; - /** - * Version that the ManagedClient\'s VA is running - * @type {string} - * @memberof ManagedClientV2025 - */ - 'vaVersion'?: string | null; - /** - * Client\'s apiKey - * @type {string} - * @memberof ManagedClientV2025 - */ - 'secret'?: string | null; - /** - * The date/time this ManagedClient was created - * @type {string} - * @memberof ManagedClientV2025 - */ - 'createdAt'?: string | null; - /** - * The date/time this ManagedClient was last updated - * @type {string} - * @memberof ManagedClientV2025 - */ - 'updatedAt'?: string | null; - /** - * The provisioning status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2025 - */ - 'provisionStatus'?: ManagedClientV2025ProvisionStatusV2025 | null; -} - -export const ManagedClientV2025StatusV2025 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientV2025StatusV2025 = typeof ManagedClientV2025StatusV2025[keyof typeof ManagedClientV2025StatusV2025]; -export const ManagedClientV2025ClusterTypeV2025 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc' -} as const; - -export type ManagedClientV2025ClusterTypeV2025 = typeof ManagedClientV2025ClusterTypeV2025[keyof typeof ManagedClientV2025ClusterTypeV2025]; -export const ManagedClientV2025ProvisionStatusV2025 = { - Provisioned: 'PROVISIONED', - Draft: 'DRAFT' -} as const; - -export type ManagedClientV2025ProvisionStatusV2025 = typeof ManagedClientV2025ProvisionStatusV2025[keyof typeof ManagedClientV2025ProvisionStatusV2025]; - -/** - * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - * @export - * @interface ManagedClusterAttributesV2025 - */ -export interface ManagedClusterAttributesV2025 { - /** - * - * @type {ManagedClusterQueueV2025} - * @memberof ManagedClusterAttributesV2025 - */ - 'queue'?: ManagedClusterQueueV2025; - /** - * ManagedCluster keystore for spConnectCluster type - * @type {string} - * @memberof ManagedClusterAttributesV2025 - */ - 'keystore'?: string | null; -} -/** - * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. - * @export - * @interface ManagedClusterEncryptionConfigV2025 - */ -export interface ManagedClusterEncryptionConfigV2025 { - /** - * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. - * @type {string} - * @memberof ManagedClusterEncryptionConfigV2025 - */ - 'format'?: ManagedClusterEncryptionConfigV2025FormatV2025; -} - -export const ManagedClusterEncryptionConfigV2025FormatV2025 = { - V2: 'V2', - V3: 'V3' -} as const; - -export type ManagedClusterEncryptionConfigV2025FormatV2025 = typeof ManagedClusterEncryptionConfigV2025FormatV2025[keyof typeof ManagedClusterEncryptionConfigV2025FormatV2025]; - -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterKeyPairV2025 - */ -export interface ManagedClusterKeyPairV2025 { - /** - * ManagedCluster publicKey - * @type {string} - * @memberof ManagedClusterKeyPairV2025 - */ - 'publicKey'?: string | null; - /** - * ManagedCluster publicKeyThumbprint - * @type {string} - * @memberof ManagedClusterKeyPairV2025 - */ - 'publicKeyThumbprint'?: string | null; - /** - * ManagedCluster publicKeyCertificate - * @type {string} - * @memberof ManagedClusterKeyPairV2025 - */ - 'publicKeyCertificate'?: string | null; -} -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterQueueV2025 - */ -export interface ManagedClusterQueueV2025 { - /** - * ManagedCluster queue name - * @type {string} - * @memberof ManagedClusterQueueV2025 - */ - 'name'?: string; - /** - * ManagedCluster queue aws region - * @type {string} - * @memberof ManagedClusterQueueV2025 - */ - 'region'?: string; -} -/** - * Managed Cluster Redis Configuration - * @export - * @interface ManagedClusterRedisV2025 - */ -export interface ManagedClusterRedisV2025 { - /** - * ManagedCluster redisHost - * @type {string} - * @memberof ManagedClusterRedisV2025 - */ - 'redisHost'?: string; - /** - * ManagedCluster redisPort - * @type {number} - * @memberof ManagedClusterRedisV2025 - */ - 'redisPort'?: number; -} -/** - * Request to create Managed Cluster - * @export - * @interface ManagedClusterRequestV2025 - */ -export interface ManagedClusterRequestV2025 { - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterRequestV2025 - */ - 'name': string; - /** - * - * @type {ManagedClusterTypesV2025} - * @memberof ManagedClusterRequestV2025 - */ - 'type'?: ManagedClusterTypesV2025; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string; }} - * @memberof ManagedClusterRequestV2025 - */ - 'configuration'?: { [key: string]: string; }; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterRequestV2025 - */ - 'description'?: string | null; -} - - -/** - * Managed Cluster Type for Cluster upgrade configuration information - * @export - * @interface ManagedClusterTypeV2025 - */ -export interface ManagedClusterTypeV2025 { - /** - * ManagedClusterType ID - * @type {string} - * @memberof ManagedClusterTypeV2025 - */ - 'id'?: string; - /** - * ManagedClusterType type name - * @type {string} - * @memberof ManagedClusterTypeV2025 - */ - 'type': string; - /** - * ManagedClusterType pod - * @type {string} - * @memberof ManagedClusterTypeV2025 - */ - 'pod': string; - /** - * ManagedClusterType org - * @type {string} - * @memberof ManagedClusterTypeV2025 - */ - 'org': string; - /** - * List of processes for the cluster type - * @type {Array} - * @memberof ManagedClusterTypeV2025 - */ - 'managedProcessIds'?: Array; -} -/** - * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products - * @export - * @enum {string} - */ - -export const ManagedClusterTypesV2025 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc', - Pag: 'pag', - DasAm: 'das-am', - Standard: 'standard' -} as const; - -export type ManagedClusterTypesV2025 = typeof ManagedClusterTypesV2025[keyof typeof ManagedClusterTypesV2025]; - - -/** - * The preference for applying updates for the cluster - * @export - * @interface ManagedClusterUpdatePreferencesV2025 - */ -export interface ManagedClusterUpdatePreferencesV2025 { - /** - * The processGroups for updatePreferences - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2025 - */ - 'processGroups'?: string | null; - /** - * The current updateState for the cluster - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2025 - */ - 'updateState'?: ManagedClusterUpdatePreferencesV2025UpdateStateV2025 | null; - /** - * The mail id to which new releases will be notified - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2025 - */ - 'notificationEmail'?: string | null; -} - -export const ManagedClusterUpdatePreferencesV2025UpdateStateV2025 = { - Auto: 'AUTO', - Disabled: 'DISABLED' -} as const; - -export type ManagedClusterUpdatePreferencesV2025UpdateStateV2025 = typeof ManagedClusterUpdatePreferencesV2025UpdateStateV2025[keyof typeof ManagedClusterUpdatePreferencesV2025UpdateStateV2025]; - -/** - * Managed Cluster - * @export - * @interface ManagedClusterV2025 - */ -export interface ManagedClusterV2025 { - /** - * ManagedCluster ID - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'id': string; - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'name'?: string; - /** - * ManagedCluster pod - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'pod'?: string; - /** - * ManagedCluster org - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'org'?: string; - /** - * - * @type {ManagedClusterTypesV2025} - * @memberof ManagedClusterV2025 - */ - 'type'?: ManagedClusterTypesV2025; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string | null; }} - * @memberof ManagedClusterV2025 - */ - 'configuration'?: { [key: string]: string | null; }; - /** - * - * @type {ManagedClusterKeyPairV2025} - * @memberof ManagedClusterV2025 - */ - 'keyPair'?: ManagedClusterKeyPairV2025; - /** - * - * @type {ManagedClusterAttributesV2025} - * @memberof ManagedClusterV2025 - */ - 'attributes'?: ManagedClusterAttributesV2025; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'description'?: string; - /** - * - * @type {ManagedClusterRedisV2025} - * @memberof ManagedClusterV2025 - */ - 'redis'?: ManagedClusterRedisV2025; - /** - * - * @type {ManagedClientTypeV2025} - * @memberof ManagedClusterV2025 - */ - 'clientType': ManagedClientTypeV2025 | null; - /** - * CCG version used by the ManagedCluster - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'ccgVersion': string; - /** - * boolean flag indicating whether or not the cluster configuration is pinned - * @type {boolean} - * @memberof ManagedClusterV2025 - */ - 'pinnedConfig'?: boolean; - /** - * - * @type {ClientLogConfigurationV2025} - * @memberof ManagedClusterV2025 - */ - 'logConfiguration'?: ClientLogConfigurationV2025 | null; - /** - * Whether or not the cluster is operational or not - * @type {boolean} - * @memberof ManagedClusterV2025 - */ - 'operational'?: boolean; - /** - * Cluster status - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'status'?: ManagedClusterV2025StatusV2025; - /** - * Public key certificate - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'publicKeyCertificate'?: string | null; - /** - * Public key thumbprint - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'publicKeyThumbprint'?: string | null; - /** - * Public key - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'publicKey'?: string | null; - /** - * - * @type {ManagedClusterEncryptionConfigV2025} - * @memberof ManagedClusterV2025 - */ - 'encryptionConfiguration'?: ManagedClusterEncryptionConfigV2025; - /** - * Key describing any immediate cluster alerts - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'alertKey'?: string; - /** - * List of clients in a cluster - * @type {Array} - * @memberof ManagedClusterV2025 - */ - 'clientIds'?: Array; - /** - * Number of services bound to a cluster - * @type {number} - * @memberof ManagedClusterV2025 - */ - 'serviceCount'?: number; - /** - * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'ccId'?: string; - /** - * The date/time this cluster was created - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'createdAt'?: string | null; - /** - * The date/time this cluster was last updated - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'updatedAt'?: string | null; - /** - * The date/time this cluster was notified for the last release - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'lastReleaseNotifiedAt'?: string | null; - /** - * - * @type {ManagedClusterUpdatePreferencesV2025} - * @memberof ManagedClusterV2025 - */ - 'updatePreferences'?: ManagedClusterUpdatePreferencesV2025; - /** - * The current installed release on the Managed cluster - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'currentInstalledReleaseVersion'?: string | null; - /** - * New available updates for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'updatePackage'?: string | null; - /** - * The time at which out of date notification was sent for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'isOutOfDateNotifiedAt'?: string | null; - /** - * The consolidated Health Status for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2025 - */ - 'consolidatedHealthIndicatorsStatus'?: ManagedClusterV2025ConsolidatedHealthIndicatorsStatusV2025 | null; -} - -export const ManagedClusterV2025StatusV2025 = { - Configuring: 'CONFIGURING', - Failed: 'FAILED', - NoClients: 'NO_CLIENTS', - Normal: 'NORMAL', - Warning: 'WARNING' -} as const; - -export type ManagedClusterV2025StatusV2025 = typeof ManagedClusterV2025StatusV2025[keyof typeof ManagedClusterV2025StatusV2025]; -export const ManagedClusterV2025ConsolidatedHealthIndicatorsStatusV2025 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClusterV2025ConsolidatedHealthIndicatorsStatusV2025 = typeof ManagedClusterV2025ConsolidatedHealthIndicatorsStatusV2025[keyof typeof ManagedClusterV2025ConsolidatedHealthIndicatorsStatusV2025]; - -/** - * - * @export - * @interface ManagerCorrelationMappingV2025 - */ -export interface ManagerCorrelationMappingV2025 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof ManagerCorrelationMappingV2025 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof ManagerCorrelationMappingV2025 - */ - 'identityAttributeName'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsTemplateV2025 - */ -export interface ManualDiscoverApplicationsTemplateV2025 { - /** - * Name of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2025 - */ - 'application_name'?: string; - /** - * Description of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsV2025 - */ -export interface ManualDiscoverApplicationsV2025 { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ManualDiscoverApplicationsV2025 - */ - 'file': File; -} -/** - * Identity of current work item owner. - * @export - * @interface ManualWorkItemDetailsCurrentOwnerV2025 - */ -export interface ManualWorkItemDetailsCurrentOwnerV2025 { - /** - * DTO type of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2025 - */ - 'type'?: ManualWorkItemDetailsCurrentOwnerV2025TypeV2025; - /** - * ID of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2025 - */ - 'id'?: string; - /** - * Display name of current work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2025 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsCurrentOwnerV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsCurrentOwnerV2025TypeV2025 = typeof ManualWorkItemDetailsCurrentOwnerV2025TypeV2025[keyof typeof ManualWorkItemDetailsCurrentOwnerV2025TypeV2025]; - -/** - * Identity of original work item owner, if the work item has been forwarded. - * @export - * @interface ManualWorkItemDetailsOriginalOwnerV2025 - */ -export interface ManualWorkItemDetailsOriginalOwnerV2025 { - /** - * DTO type of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2025 - */ - 'type'?: ManualWorkItemDetailsOriginalOwnerV2025TypeV2025; - /** - * ID of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2025 - */ - 'id'?: string; - /** - * Display name of original work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2025 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsOriginalOwnerV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsOriginalOwnerV2025TypeV2025 = typeof ManualWorkItemDetailsOriginalOwnerV2025TypeV2025[keyof typeof ManualWorkItemDetailsOriginalOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface ManualWorkItemDetailsV2025 - */ -export interface ManualWorkItemDetailsV2025 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetailsV2025 - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwnerV2025} - * @memberof ManualWorkItemDetailsV2025 - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwnerV2025 | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwnerV2025} - * @memberof ManualWorkItemDetailsV2025 - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwnerV2025 | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetailsV2025 - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemStateV2025} - * @memberof ManualWorkItemDetailsV2025 - */ - 'status'?: ManualWorkItemStateV2025; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetailsV2025 - */ - 'forwardHistory'?: Array | null; -} - - -/** - * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. - * @export - * @enum {string} - */ - -export const ManualWorkItemStateV2025 = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Expired: 'EXPIRED', - Cancelled: 'CANCELLED', - Archived: 'ARCHIVED' -} as const; - -export type ManualWorkItemStateV2025 = typeof ManualWorkItemStateV2025[keyof typeof ManualWorkItemStateV2025]; - - -/** - * - * @export - * @interface MatchTermV2025 - */ -export interface MatchTermV2025 { - /** - * The attribute name - * @type {string} - * @memberof MatchTermV2025 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof MatchTermV2025 - */ - 'value'?: string; - /** - * The operator between name and value - * @type {string} - * @memberof MatchTermV2025 - */ - 'op'?: string; - /** - * If it is a container or a real match term - * @type {boolean} - * @memberof MatchTermV2025 - */ - 'container'?: boolean; - /** - * If it is AND logical operator for the children match terms - * @type {boolean} - * @memberof MatchTermV2025 - */ - 'and'?: boolean; - /** - * The children under this match term - * @type {Array<{ [key: string]: any; }>} - * @memberof MatchTermV2025 - */ - 'children'?: Array<{ [key: string]: any; }> | null; -} -/** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @export - * @enum {string} - */ - -export const MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type MediumV2025 = typeof MediumV2025[keyof typeof MediumV2025]; - - -/** - * An enumeration of the types of membership choices - * @export - * @enum {string} - */ - -export const MembershipTypeV2025 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION' -} as const; - -export type MembershipTypeV2025 = typeof MembershipTypeV2025[keyof typeof MembershipTypeV2025]; - - -/** - * The calculation done on the results of the query - * @export - * @interface MetricAggregationV2025 - */ -export interface MetricAggregationV2025 { - /** - * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - * @type {string} - * @memberof MetricAggregationV2025 - */ - 'name': string; - /** - * - * @type {MetricTypeV2025} - * @memberof MetricAggregationV2025 - */ - 'type'?: MetricTypeV2025; - /** - * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof MetricAggregationV2025 - */ - 'field': string; -} - - -/** - * - * @export - * @interface MetricResponseV2025 - */ -export interface MetricResponseV2025 { - /** - * the name of metric - * @type {string} - * @memberof MetricResponseV2025 - */ - 'name'?: string; - /** - * the value associated to the metric - * @type {number} - * @memberof MetricResponseV2025 - */ - 'value'?: number; -} -/** - * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const MetricTypeV2025 = { - Count: 'COUNT', - UniqueCount: 'UNIQUE_COUNT', - Avg: 'AVG', - Sum: 'SUM', - Median: 'MEDIAN', - Min: 'MIN', - Max: 'MAX' -} as const; - -export type MetricTypeV2025 = typeof MetricTypeV2025[keyof typeof MetricTypeV2025]; - - -/** - * Response model for configuration test of a given MFA method - * @export - * @interface MfaConfigTestResponseV2025 - */ -export interface MfaConfigTestResponseV2025 { - /** - * The configuration test result. - * @type {string} - * @memberof MfaConfigTestResponseV2025 - */ - 'state'?: MfaConfigTestResponseV2025StateV2025; - /** - * The error message to indicate the failure of configuration test. - * @type {string} - * @memberof MfaConfigTestResponseV2025 - */ - 'error'?: string; -} - -export const MfaConfigTestResponseV2025StateV2025 = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MfaConfigTestResponseV2025StateV2025 = typeof MfaConfigTestResponseV2025StateV2025[keyof typeof MfaConfigTestResponseV2025StateV2025]; - -/** - * - * @export - * @interface MfaDuoConfigV2025 - */ -export interface MfaDuoConfigV2025 { - /** - * Mfa method name - * @type {string} - * @memberof MfaDuoConfigV2025 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaDuoConfigV2025 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2025 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2025 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2025 - */ - 'identityAttribute'?: string | null; - /** - * A map with additional config properties for the given MFA method - duo-web. - * @type {{ [key: string]: any; }} - * @memberof MfaDuoConfigV2025 - */ - 'configProperties'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface MfaOktaConfigV2025 - */ -export interface MfaOktaConfigV2025 { - /** - * Mfa method name - * @type {string} - * @memberof MfaOktaConfigV2025 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaOktaConfigV2025 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2025 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2025 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2025 - */ - 'identityAttribute'?: string | null; -} -/** - * This represents a Multi-Host Integration template type. - * @export - * @interface MultiHostIntegrationTemplateTypeV2025 - */ -export interface MultiHostIntegrationTemplateTypeV2025 { - /** - * This is the name of the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2025 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2025 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2025 - */ - 'scriptName': string; -} -/** - * Reference to accounts file for the source. - * @export - * @interface MultiHostIntegrationsAccountsFileV2025 - */ -export interface MultiHostIntegrationsAccountsFileV2025 { - /** - * Name of the accounts file. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2025 - */ - 'name'?: string; - /** - * The accounts file key. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2025 - */ - 'key'?: string; - /** - * Date-time when the file was uploaded - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2025 - */ - 'uploadTime'?: string; - /** - * Date-time when the accounts file expired. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2025 - */ - 'expiry'?: string; - /** - * If this is true, it indicates that the accounts file has expired. - * @type {boolean} - * @memberof MultiHostIntegrationsAccountsFileV2025 - */ - 'expired'?: boolean; -} -/** - * - * @export - * @interface MultiHostIntegrationsAggScheduleUpdateV2025 - */ -export interface MultiHostIntegrationsAggScheduleUpdateV2025 { - /** - * Multi-Host Integration ID. The ID must be unique - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'multihostId': string; - /** - * Multi-Host Integration aggregation group ID - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'aggregation_grp_id': string; - /** - * Multi-Host Integration name - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'aggregation_grp_name': string; - /** - * Cron expression to schedule aggregation - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'aggregation_cron_schedule': string; - /** - * Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. - * @type {boolean} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'enableSchedule': boolean; - /** - * Source IDs of the Multi-Host Integration - * @type {Array} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'source_id_list': Array; - /** - * Created date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'created'?: string; - /** - * Modified date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2025 - */ - 'modified'?: string; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface MultiHostIntegrationsBeforeProvisioningRuleV2025 - */ -export interface MultiHostIntegrationsBeforeProvisioningRuleV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2025 - */ - 'type'?: MultiHostIntegrationsBeforeProvisioningRuleV2025TypeV2025; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2025 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2025 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsBeforeProvisioningRuleV2025TypeV2025 = { - Rule: 'RULE' -} as const; - -export type MultiHostIntegrationsBeforeProvisioningRuleV2025TypeV2025 = typeof MultiHostIntegrationsBeforeProvisioningRuleV2025TypeV2025[keyof typeof MultiHostIntegrationsBeforeProvisioningRuleV2025TypeV2025]; - -/** - * - * @export - * @interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2025 - */ -export interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2025 { - /** - * File name of the connector JAR - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2025 - */ - 'connectorFileNameUploadedDate'?: string; -} -/** - * Attributes of Multi-Host Integration - * @export - * @interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 - */ -export interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 { - /** - * Password. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 - */ - 'password'?: string; - /** - * Connector file. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 - */ - 'connector_files'?: string; - /** - * Authentication type. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 - */ - 'authType'?: string; - /** - * Username. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025 - */ - 'user'?: string; -} -/** - * Connector specific configuration. This configuration will differ for Multi-Host Integration type. - * @export - * @interface MultiHostIntegrationsConnectorAttributesV2025 - */ -export interface MultiHostIntegrationsConnectorAttributesV2025 { - [key: string]: string | any; - - /** - * Maximum sources allowed count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'maxAllowedSources'?: number; - /** - * Last upload sources count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'lastSourceUploadCount'?: number; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2025} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'connectorFileUploadHistory'?: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2025; - /** - * Multi-Host integration status. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'multihost_status'?: MultiHostIntegrationsConnectorAttributesV2025MultihostStatusV2025; - /** - * Show account schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'showAccountSchema'?: boolean; - /** - * Show entitlement schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'showEntitlementSchema'?: boolean; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025} - * @memberof MultiHostIntegrationsConnectorAttributesV2025 - */ - 'multiHostAttributes'?: MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2025; -} - -export const MultiHostIntegrationsConnectorAttributesV2025MultihostStatusV2025 = { - Ready: 'ready', - Processing: 'processing', - FileUploadInProgress: 'fileUploadInProgress', - SourceCreationInProgress: 'sourceCreationInProgress', - AggregationGroupingInProgress: 'aggregationGroupingInProgress', - AggregationScheduleInProgress: 'aggregationScheduleInProgress', - DeleteInProgress: 'deleteInProgress', - DeleteFailed: 'deleteFailed' -} as const; - -export type MultiHostIntegrationsConnectorAttributesV2025MultihostStatusV2025 = typeof MultiHostIntegrationsConnectorAttributesV2025MultihostStatusV2025[keyof typeof MultiHostIntegrationsConnectorAttributesV2025MultihostStatusV2025]; - -/** - * This represents sources to be created of same type. - * @export - * @interface MultiHostIntegrationsCreateSourcesV2025 - */ -export interface MultiHostIntegrationsCreateSourcesV2025 { - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2025 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2025 - */ - 'description'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateSourcesV2025 - */ - 'connectorAttributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MultiHostIntegrationsCreateV2025 - */ -export interface MultiHostIntegrationsCreateV2025 { - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2025} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'owner': MultiHostIntegrationsOwnerV2025; - /** - * - * @type {SourceClusterV2025} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'cluster'?: SourceClusterV2025 | null; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'connector': string; - /** - * Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * - * @type {SourceManagementWorkgroupV2025} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2025 | null; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2025 - */ - 'modified'?: string; -} -/** - * Reference to identity object who owns the source. - * @export - * @interface MultiHostIntegrationsOwnerV2025 - */ -export interface MultiHostIntegrationsOwnerV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2025 - */ - 'type'?: MultiHostIntegrationsOwnerV2025TypeV2025; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2025 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2025 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type MultiHostIntegrationsOwnerV2025TypeV2025 = typeof MultiHostIntegrationsOwnerV2025TypeV2025[keyof typeof MultiHostIntegrationsOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface MultiHostIntegrationsV2025 - */ -export interface MultiHostIntegrationsV2025 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'id': string; - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'owner': MultiHostIntegrationsOwnerV2025; - /** - * - * @type {SourceClusterV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'cluster'?: SourceClusterV2025 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2025 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2025 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2025; - /** - * - * @type {SourceManagerCorrelationRuleV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2025 | null; - /** - * - * @type {MultiHostIntegrationsBeforeProvisioningRuleV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'beforeProvisioningRule'?: MultiHostIntegrationsBeforeProvisioningRuleV2025 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2025 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2025 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostIntegrationsV2025 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectorClass'?: string; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectorAttributes'?: MultiHostIntegrationsConnectorAttributesV2025; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostIntegrationsV2025 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostIntegrationsV2025 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2025 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostIntegrationsV2025 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'status'?: MultiHostIntegrationsV2025StatusV2025; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectionType'?: MultiHostIntegrationsV2025ConnectionTypeV2025; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostIntegrationsV2025 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostIntegrationsV2025 - */ - 'category'?: string | null; - /** - * - * @type {MultiHostIntegrationsAccountsFileV2025} - * @memberof MultiHostIntegrationsV2025 - */ - 'accountsFile'?: MultiHostIntegrationsAccountsFileV2025 | null; -} - -export const MultiHostIntegrationsV2025FeaturesV2025 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostIntegrationsV2025FeaturesV2025 = typeof MultiHostIntegrationsV2025FeaturesV2025[keyof typeof MultiHostIntegrationsV2025FeaturesV2025]; -export const MultiHostIntegrationsV2025StatusV2025 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostIntegrationsV2025StatusV2025 = typeof MultiHostIntegrationsV2025StatusV2025[keyof typeof MultiHostIntegrationsV2025StatusV2025]; -export const MultiHostIntegrationsV2025ConnectionTypeV2025 = { - Direct: 'direct', - File: 'file' -} as const; - -export type MultiHostIntegrationsV2025ConnectionTypeV2025 = typeof MultiHostIntegrationsV2025ConnectionTypeV2025[keyof typeof MultiHostIntegrationsV2025ConnectionTypeV2025]; - -/** - * - * @export - * @interface MultiHostSourcesV2025 - */ -export interface MultiHostSourcesV2025 { - /** - * Source ID. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'id': string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'description'?: string; - /** - * - * @type {MultiHostIntegrationsOwnerV2025} - * @memberof MultiHostSourcesV2025 - */ - 'owner': MultiHostIntegrationsOwnerV2025; - /** - * - * @type {SourceClusterV2025} - * @memberof MultiHostSourcesV2025 - */ - 'cluster'?: SourceClusterV2025 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2025} - * @memberof MultiHostSourcesV2025 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2025 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2025} - * @memberof MultiHostSourcesV2025 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2025 | null; - /** - * - * @type {ManagerCorrelationMappingV2025} - * @memberof MultiHostSourcesV2025 - */ - 'managerCorrelationMapping'?: ManagerCorrelationMappingV2025; - /** - * - * @type {SourceManagerCorrelationRuleV2025} - * @memberof MultiHostSourcesV2025 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2025 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2025} - * @memberof MultiHostSourcesV2025 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2025 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostSourcesV2025 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostSourcesV2025 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostSourcesV2025 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostSourcesV2025 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostSourcesV2025 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostSourcesV2025 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2025} - * @memberof MultiHostSourcesV2025 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2025 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostSourcesV2025 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'status'?: MultiHostSourcesV2025StatusV2025; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connectorName': string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostSourcesV2025 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostSourcesV2025 - */ - 'category'?: string | null; -} - -export const MultiHostSourcesV2025FeaturesV2025 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostSourcesV2025FeaturesV2025 = typeof MultiHostSourcesV2025FeaturesV2025[keyof typeof MultiHostSourcesV2025FeaturesV2025]; -export const MultiHostSourcesV2025StatusV2025 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostSourcesV2025StatusV2025 = typeof MultiHostSourcesV2025StatusV2025[keyof typeof MultiHostSourcesV2025StatusV2025]; - -/** - * - * @export - * @interface MultiPolicyRequestV2025 - */ -export interface MultiPolicyRequestV2025 { - /** - * Multi-policy report will be run for this list of ids - * @type {Array} - * @memberof MultiPolicyRequestV2025 - */ - 'filteredPolicyList'?: Array; -} -/** - * - * @export - * @interface NameNormalizerV2025 - */ -export interface NameNormalizerV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof NameNormalizerV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof NameNormalizerV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * | Construct | Date Time Pattern | Description | | --------- | ----------------- | ----------- | | ISO8601 | `yyyy-MM-dd\'T\'HH:mm:ss.SSSX` | The ISO8601 standard. | | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - * @export - * @enum {string} - */ - -export const NamedConstructsV2025 = { - Iso8601: 'ISO8601', - Ldap: 'LDAP', - PeopleSoft: 'PEOPLE_SOFT', - EpochTimeJava: 'EPOCH_TIME_JAVA', - EpochTimeWin32: 'EPOCH_TIME_WIN32' -} as const; - -export type NamedConstructsV2025 = typeof NamedConstructsV2025[keyof typeof NamedConstructsV2025]; - - -/** - * Source configuration information for Native Change Detection that is read and used by account aggregation process. - * @export - * @interface NativeChangeDetectionConfigV2025 - */ -export interface NativeChangeDetectionConfigV2025 { - /** - * A flag indicating if Native Change Detection is enabled for a source. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'enabled'?: boolean; - /** - * Operation types for which Native Change Detection is enabled for a source. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'operations'?: Array; - /** - * A flag indicating that all entitlements participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'allEntitlements'?: boolean; - /** - * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'allNonEntitlementAttributes'?: boolean; - /** - * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'selectedEntitlements'?: Array; - /** - * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2025 - */ - 'selectedNonEntitlementAttributes'?: Array; -} - -export const NativeChangeDetectionConfigV2025OperationsV2025 = { - AccountUpdated: 'ACCOUNT_UPDATED', - AccountCreated: 'ACCOUNT_CREATED', - AccountDeleted: 'ACCOUNT_DELETED' -} as const; - -export type NativeChangeDetectionConfigV2025OperationsV2025 = typeof NativeChangeDetectionConfigV2025OperationsV2025[keyof typeof NativeChangeDetectionConfigV2025OperationsV2025]; - -/** - * The nested aggregation object. - * @export - * @interface NestedAggregationV2025 - */ -export interface NestedAggregationV2025 { - /** - * The name of the nested aggregate to be included in the result. - * @type {string} - * @memberof NestedAggregationV2025 - */ - 'name': string; - /** - * The type of the nested object. - * @type {string} - * @memberof NestedAggregationV2025 - */ - 'type': string; -} -/** - * A NestedConfig - * @export - * @interface NestedConfigV2025 - */ -export interface NestedConfigV2025 { - /** - * The unique identifier of the ancestor RightSet. - * @type {string} - * @memberof NestedConfigV2025 - */ - 'ancestorId'?: string; - /** - * The depth level of the configuration. - * @type {number} - * @memberof NestedConfigV2025 - */ - 'depth'?: number; - /** - * The unique identifier of the parent RightSet. - * @type {string} - * @memberof NestedConfigV2025 - */ - 'parentId'?: string | null; - /** - * List of unique identifiers for child configurations. - * @type {Array} - * @memberof NestedConfigV2025 - */ - 'childrenIds'?: Array; -} -/** - * - * @export - * @interface NetworkConfigurationV2025 - */ -export interface NetworkConfigurationV2025 { - /** - * The collection of ip ranges. - * @type {Array} - * @memberof NetworkConfigurationV2025 - */ - 'range'?: Array | null; - /** - * The collection of country codes. - * @type {Array} - * @memberof NetworkConfigurationV2025 - */ - 'geolocation'?: Array | null; - /** - * Denotes whether the provided lists are whitelisted or blacklisted for geo location. - * @type {boolean} - * @memberof NetworkConfigurationV2025 - */ - 'whitelisted'?: boolean; -} -/** - * - * @export - * @interface NonEmployeeApprovalDecisionV2025 - */ -export interface NonEmployeeApprovalDecisionV2025 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeApprovalDecisionV2025 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface NonEmployeeApprovalItemBaseV2025 - */ -export interface NonEmployeeApprovalItemBaseV2025 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2025} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2025; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2025} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'approvalStatus'?: ApprovalStatusV2025; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2025 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemDetailV2025 - */ -export interface NonEmployeeApprovalItemDetailV2025 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2025} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2025; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2025} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'approvalStatus'?: ApprovalStatusV2025; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestWithoutApprovalItemV2025} - * @memberof NonEmployeeApprovalItemDetailV2025 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItemV2025; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemV2025 - */ -export interface NonEmployeeApprovalItemV2025 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2025} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2025; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2025} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'approvalStatus'?: ApprovalStatusV2025; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestLiteV2025} - * @memberof NonEmployeeApprovalItemV2025 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestLiteV2025; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalSummaryV2025 - */ -export interface NonEmployeeApprovalSummaryV2025 { - /** - * The number of approved non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2025 - */ - 'approved'?: number; - /** - * The number of pending non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2025 - */ - 'pending'?: number; - /** - * The number of rejected non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2025 - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface NonEmployeeBulkUploadJobV2025 - */ -export interface NonEmployeeBulkUploadJobV2025 { - /** - * The bulk upload job\'s ID. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2025 - */ - 'id'?: string; - /** - * The ID of the source to bulk-upload non-employees to. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2025 - */ - 'sourceId'?: string; - /** - * The date-time the job was submitted. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2025 - */ - 'created'?: string; - /** - * The date-time that the job was last updated. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2025 - */ - 'modified'?: string; - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2025 - */ - 'status'?: NonEmployeeBulkUploadJobV2025StatusV2025; -} - -export const NonEmployeeBulkUploadJobV2025StatusV2025 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadJobV2025StatusV2025 = typeof NonEmployeeBulkUploadJobV2025StatusV2025[keyof typeof NonEmployeeBulkUploadJobV2025StatusV2025]; - -/** - * - * @export - * @interface NonEmployeeBulkUploadStatusV2025 - */ -export interface NonEmployeeBulkUploadStatusV2025 { - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. - * @type {string} - * @memberof NonEmployeeBulkUploadStatusV2025 - */ - 'status'?: NonEmployeeBulkUploadStatusV2025StatusV2025; -} - -export const NonEmployeeBulkUploadStatusV2025StatusV2025 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadStatusV2025StatusV2025 = typeof NonEmployeeBulkUploadStatusV2025StatusV2025[keyof typeof NonEmployeeBulkUploadStatusV2025StatusV2025]; - -/** - * Identifies if the identity is a normal identity or a governance group - * @export - * @enum {string} - */ - -export const NonEmployeeIdentityDtoTypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeIdentityDtoTypeV2025 = typeof NonEmployeeIdentityDtoTypeV2025[keyof typeof NonEmployeeIdentityDtoTypeV2025]; - - -/** - * - * @export - * @interface NonEmployeeIdentityReferenceWithIdV2025 - */ -export interface NonEmployeeIdentityReferenceWithIdV2025 { - /** - * - * @type {NonEmployeeIdentityDtoTypeV2025} - * @memberof NonEmployeeIdentityReferenceWithIdV2025 - */ - 'type'?: NonEmployeeIdentityDtoTypeV2025; - /** - * Identity id - * @type {string} - * @memberof NonEmployeeIdentityReferenceWithIdV2025 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeIdnUserRequestV2025 - */ -export interface NonEmployeeIdnUserRequestV2025 { - /** - * Identity id. - * @type {string} - * @memberof NonEmployeeIdnUserRequestV2025 - */ - 'id': string; -} -/** - * - * @export - * @interface NonEmployeeRecordV2025 - */ -export interface NonEmployeeRecordV2025 { - /** - * Non-Employee record id. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'id'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'manager'?: string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'sourceId'?: string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRecordV2025 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRecordV2025 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeRejectApprovalDecisionV2025 - */ -export interface NonEmployeeRejectApprovalDecisionV2025 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeRejectApprovalDecisionV2025 - */ - 'comment': string; -} -/** - * - * @export - * @interface NonEmployeeRequestBodyV2025 - */ -export interface NonEmployeeRequestBodyV2025 { - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'accountName': string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'firstName': string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'lastName': string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'email': string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'phone': string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'manager': string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'sourceId': string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'startDate': string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2025 - */ - 'endDate': string; -} -/** - * - * @export - * @interface NonEmployeeRequestLiteV2025 - */ -export interface NonEmployeeRequestLiteV2025 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestLiteV2025 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2025} - * @memberof NonEmployeeRequestLiteV2025 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2025; -} -/** - * - * @export - * @interface NonEmployeeRequestSummaryV2025 - */ -export interface NonEmployeeRequestSummaryV2025 { - /** - * The number of approved non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2025 - */ - 'approved'?: number; - /** - * The number of rejected non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2025 - */ - 'rejected'?: number; - /** - * The number of pending non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2025 - */ - 'pending'?: number; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2025 - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NonEmployeeRequestV2025 - */ -export interface NonEmployeeRequestV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'description'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteV2025} - * @memberof NonEmployeeRequestV2025 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteV2025; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestV2025 - */ - 'data'?: { [key: string]: string; }; - /** - * List of approval item for the request - * @type {Array} - * @memberof NonEmployeeRequestV2025 - */ - 'approvalItems'?: Array; - /** - * - * @type {ApprovalStatusV2025} - * @memberof NonEmployeeRequestV2025 - */ - 'approvalStatus'?: ApprovalStatusV2025; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestV2025 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeRequestWithoutApprovalItemV2025 - */ -export interface NonEmployeeRequestWithoutApprovalItemV2025 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2025} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2025; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteWithSchemaAttributesV2025} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributesV2025; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'data'?: { [key: string]: string; }; - /** - * - * @type {ApprovalStatusV2025} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'approvalStatus'?: ApprovalStatusV2025; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2025 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBodyV2025 - */ -export interface NonEmployeeSchemaAttributeBodyV2025 { - /** - * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'type': string; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBodyV2025 - */ - 'required'?: boolean; -} -/** - * Enum representing the type of data a schema attribute accepts. - * @export - * @enum {string} - */ - -export const NonEmployeeSchemaAttributeTypeV2025 = { - Text: 'TEXT', - Date: 'DATE', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeSchemaAttributeTypeV2025 = typeof NonEmployeeSchemaAttributeTypeV2025[keyof typeof NonEmployeeSchemaAttributeTypeV2025]; - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeV2025 - */ -export interface NonEmployeeSchemaAttributeV2025 { - /** - * Schema Attribute Id - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'id'?: string; - /** - * True if this schema attribute is mandatory on all non-employees sources. - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'system'?: boolean; - /** - * When the schema attribute was last modified. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'modified'?: string; - /** - * When the schema attribute was created. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeSchemaAttributeTypeV2025} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'type': NonEmployeeSchemaAttributeTypeV2025; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2025 - */ - 'required'?: boolean; -} - - -/** - * - * @export - * @interface NonEmployeeSourceLiteV2025 - */ -export interface NonEmployeeSourceLiteV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ -export interface NonEmployeeSourceLiteWithSchemaAttributesV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ - 'description'?: string; - /** - * List of schema attributes associated with this non-employee source. - * @type {Array} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2025 - */ - 'schemaAttributes'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceRequestBodyV2025 - */ -export interface NonEmployeeSourceRequestBodyV2025 { - /** - * Name of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'name': string; - /** - * Description of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'description': string; - /** - * - * @type {NonEmployeeIdnUserRequestV2025} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'owner': NonEmployeeIdnUserRequestV2025; - /** - * The ID for the management workgroup that contains source sub-admins - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'managementWorkgroup'?: string; - /** - * List of approvers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'approvers'?: Array; - /** - * List of account managers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2025 - */ - 'accountManagers'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceV2025 - */ -export interface NonEmployeeSourceV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceV2025 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceV2025 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceV2025 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithCloudExternalIdV2025 - */ -export interface NonEmployeeSourceWithCloudExternalIdV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'created'?: string; - /** - * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2025 - */ - 'cloudExternalId'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithNECountV2025 - */ -export interface NonEmployeeSourceWithNECountV2025 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'created'?: string; - /** - * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. - * @type {number} - * @memberof NonEmployeeSourceWithNECountV2025 - */ - 'nonEmployeeCount'?: number | null; -} -/** - * - * @export - * @interface NotificationTemplateContextV2025 - */ -export interface NotificationTemplateContextV2025 { - /** - * A JSON object that stores the context. - * @type {{ [key: string]: any; }} - * @memberof NotificationTemplateContextV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * When the global context was created - * @type {string} - * @memberof NotificationTemplateContextV2025 - */ - 'created'?: string; - /** - * When the global context was last modified - * @type {string} - * @memberof NotificationTemplateContextV2025 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface ObjectExportImportNamesV2025 - */ -export interface ObjectExportImportNamesV2025 { - /** - * Object names to be included in a backup. - * @type {Array} - * @memberof ObjectExportImportNamesV2025 - */ - 'includedNames'?: Array; -} -/** - * - * @export - * @interface ObjectExportImportOptionsV2025 - */ -export interface ObjectExportImportOptionsV2025 { - /** - * Object ids to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2025 - */ - 'includedIds'?: Array; - /** - * Object names to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2025 - */ - 'includedNames'?: Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResult1V2025 - */ -export interface ObjectImportResult1V2025 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2025 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2025 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2025 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResult1V2025 - */ - 'importedObjects': Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResultV2025 - */ -export interface ObjectImportResultV2025 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2025 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2025 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2025 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResultV2025 - */ - 'importedObjects': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateRequestV2025 - */ -export interface ObjectMappingBulkCreateRequestV2025 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateRequestV2025 - */ - 'newObjectsMappings': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateResponseV2025 - */ -export interface ObjectMappingBulkCreateResponseV2025 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateResponseV2025 - */ - 'addedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchRequestV2025 - */ -export interface ObjectMappingBulkPatchRequestV2025 { - /** - * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. - * @type {{ [key: string]: Array; }} - * @memberof ObjectMappingBulkPatchRequestV2025 - */ - 'patches': { [key: string]: Array; }; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchResponseV2025 - */ -export interface ObjectMappingBulkPatchResponseV2025 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkPatchResponseV2025 - */ - 'patchedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingRequestV2025 - */ -export interface ObjectMappingRequestV2025 { - /** - * Type of the object the mapping value applies to, must be one from enum - * @type {string} - * @memberof ObjectMappingRequestV2025 - */ - 'objectType': ObjectMappingRequestV2025ObjectTypeV2025; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingRequestV2025 - */ - 'jsonPath': string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2025 - */ - 'sourceValue': string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2025 - */ - 'targetValue': string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingRequestV2025 - */ - 'enabled'?: boolean; -} - -export const ObjectMappingRequestV2025ObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingRequestV2025ObjectTypeV2025 = typeof ObjectMappingRequestV2025ObjectTypeV2025[keyof typeof ObjectMappingRequestV2025ObjectTypeV2025]; - -/** - * - * @export - * @interface ObjectMappingResponseV2025 - */ -export interface ObjectMappingResponseV2025 { - /** - * Id of the object mapping - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'objectMappingId'?: string; - /** - * Type of the object the mapping value applies to - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'objectType'?: ObjectMappingResponseV2025ObjectTypeV2025; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'jsonPath'?: string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'sourceValue'?: string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'targetValue'?: string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingResponseV2025 - */ - 'enabled'?: boolean; - /** - * Object mapping creation timestamp - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'created'?: string; - /** - * Object mapping latest update timestamp - * @type {string} - * @memberof ObjectMappingResponseV2025 - */ - 'modified'?: string; -} - -export const ObjectMappingResponseV2025ObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingResponseV2025ObjectTypeV2025 = typeof ObjectMappingResponseV2025ObjectTypeV2025[keyof typeof ObjectMappingResponseV2025ObjectTypeV2025]; - -/** - * Operation on a specific criteria - * @export - * @enum {string} - */ - -export const OperationV2025 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - And: 'AND', - Or: 'OR' -} as const; - -export type OperationV2025 = typeof OperationV2025[keyof typeof OperationV2025]; - - -/** - * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users - * @export - * @interface OrgConfigV2025 - */ -export interface OrgConfigV2025 { - /** - * The name of the org. - * @type {string} - * @memberof OrgConfigV2025 - */ - 'orgName'?: string; - /** - * The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones - * @type {string} - * @memberof OrgConfigV2025 - */ - 'timeZone'?: string; - /** - * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. - * @type {boolean} - * @memberof OrgConfigV2025 - */ - 'lcsChangeHonorsSourceEnableFeature'?: boolean; - /** - * ARM Customer ID - * @type {string} - * @memberof OrgConfigV2025 - */ - 'armCustomerId'?: string | null; - /** - * A list of IDN::sourceId to ARM::systemId mappings. - * @type {string} - * @memberof OrgConfigV2025 - */ - 'armSapSystemIdMappings'?: string | null; - /** - * ARM authentication string - * @type {string} - * @memberof OrgConfigV2025 - */ - 'armAuth'?: string | null; - /** - * ARM database name - * @type {string} - * @memberof OrgConfigV2025 - */ - 'armDb'?: string | null; - /** - * ARM SSO URL - * @type {string} - * @memberof OrgConfigV2025 - */ - 'armSsoUrl'?: string | null; - /** - * Flag to determine whether IAI Certification Recommendations are enabled for the current org - * @type {boolean} - * @memberof OrgConfigV2025 - */ - 'iaiEnableCertificationRecommendations'?: boolean; - /** - * - * @type {Array} - * @memberof OrgConfigV2025 - */ - 'sodReportConfigs'?: Array; -} -/** - * - * @export - * @interface OriginalRequestV2025 - */ -export interface OriginalRequestV2025 { - /** - * Account ID. - * @type {string} - * @memberof OriginalRequestV2025 - */ - 'accountId'?: string; - /** - * - * @type {ResultV2025} - * @memberof OriginalRequestV2025 - */ - 'result'?: ResultV2025; - /** - * Attribute changes requested for account. - * @type {Array} - * @memberof OriginalRequestV2025 - */ - 'attributeRequests'?: Array; - /** - * Operation used. - * @type {string} - * @memberof OriginalRequestV2025 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2025} - * @memberof OriginalRequestV2025 - */ - 'source'?: AccountSourceV2025; -} -/** - * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) - * @export - * @interface OrphanIdentitiesReportArgumentsV2025 - */ -export interface OrphanIdentitiesReportArgumentsV2025 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof OrphanIdentitiesReportArgumentsV2025 - */ - 'selectedFormats'?: Array; -} - -export const OrphanIdentitiesReportArgumentsV2025SelectedFormatsV2025 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type OrphanIdentitiesReportArgumentsV2025SelectedFormatsV2025 = typeof OrphanIdentitiesReportArgumentsV2025SelectedFormatsV2025[keyof typeof OrphanIdentitiesReportArgumentsV2025SelectedFormatsV2025]; - -/** - * - * @export - * @interface OutlierContributingFeatureV2025 - */ -export interface OutlierContributingFeatureV2025 { - /** - * Contributing feature id - * @type {string} - * @memberof OutlierContributingFeatureV2025 - */ - 'id'?: string; - /** - * The name of the feature - * @type {string} - * @memberof OutlierContributingFeatureV2025 - */ - 'name'?: string; - /** - * - * @type {OutlierValueTypeV2025} - * @memberof OutlierContributingFeatureV2025 - */ - 'valueType'?: OutlierValueTypeV2025; - /** - * The feature value - * @type {number} - * @memberof OutlierContributingFeatureV2025 - */ - 'value'?: number; - /** - * The importance of the feature. This can also be a negative value - * @type {number} - * @memberof OutlierContributingFeatureV2025 - */ - 'importance'?: number; - /** - * The (translated if header is passed) displayName for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2025 - */ - 'displayName'?: string; - /** - * The (translated if header is passed) description for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2025 - */ - 'description'?: string; - /** - * - * @type {OutlierFeatureTranslationV2025} - * @memberof OutlierContributingFeatureV2025 - */ - 'translationMessages'?: OutlierFeatureTranslationV2025 | null; -} -/** - * - * @export - * @interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2025 - */ -export interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2025 { - /** - * display name - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2025 - */ - 'displayName'?: string; - /** - * value - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2025 - */ - 'value'?: string; - /** - * - * @type {OutlierValueTypeV2025} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2025 - */ - 'valueType'?: OutlierValueTypeV2025; -} -/** - * - * @export - * @interface OutlierFeatureSummaryV2025 - */ -export interface OutlierFeatureSummaryV2025 { - /** - * Contributing feature name - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'contributingFeatureName'?: string; - /** - * Identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'identityOutlierDisplayName'?: string; - /** - * - * @type {Array} - * @memberof OutlierFeatureSummaryV2025 - */ - 'outlierFeatureDisplayValues'?: Array; - /** - * Definition of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'featureDefinition'?: string; - /** - * Detailed explanation of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'featureExplanation'?: string; - /** - * outlier\'s peer identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'peerDisplayName'?: string | null; - /** - * outlier\'s peer identity id - * @type {string} - * @memberof OutlierFeatureSummaryV2025 - */ - 'peerIdentityId'?: string | null; - /** - * Access Item reference - * @type {object} - * @memberof OutlierFeatureSummaryV2025 - */ - 'accessItemReference'?: object; -} -/** - * - * @export - * @interface OutlierFeatureTranslationV2025 - */ -export interface OutlierFeatureTranslationV2025 { - /** - * - * @type {TranslationMessageV2025} - * @memberof OutlierFeatureTranslationV2025 - */ - 'displayName'?: TranslationMessageV2025; - /** - * - * @type {TranslationMessageV2025} - * @memberof OutlierFeatureTranslationV2025 - */ - 'description'?: TranslationMessageV2025; -} -/** - * - * @export - * @interface OutlierSummaryV2025 - */ -export interface OutlierSummaryV2025 { - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierSummaryV2025 - */ - 'type'?: OutlierSummaryV2025TypeV2025; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof OutlierSummaryV2025 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2025 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2025 - */ - 'totalIdentities'?: number; - /** - * - * @type {number} - * @memberof OutlierSummaryV2025 - */ - 'totalIgnored'?: number; -} - -export const OutlierSummaryV2025TypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierSummaryV2025TypeV2025 = typeof OutlierSummaryV2025TypeV2025[keyof typeof OutlierSummaryV2025TypeV2025]; - -/** - * - * @export - * @interface OutlierV2025 - */ -export interface OutlierV2025 { - /** - * The identity\'s unique identifier for the outlier record - * @type {string} - * @memberof OutlierV2025 - */ - 'id'?: string; - /** - * The ID of the identity that is detected as an outlier - * @type {string} - * @memberof OutlierV2025 - */ - 'identityId'?: string; - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierV2025 - */ - 'type'?: OutlierV2025TypeV2025; - /** - * The first date the outlier was detected - * @type {string} - * @memberof OutlierV2025 - */ - 'firstDetectionDate'?: string; - /** - * The most recent date the outlier was detected - * @type {string} - * @memberof OutlierV2025 - */ - 'latestDetectionDate'?: string; - /** - * Flag whether or not the outlier has been ignored - * @type {boolean} - * @memberof OutlierV2025 - */ - 'ignored'?: boolean; - /** - * Object containing mapped identity attributes - * @type {object} - * @memberof OutlierV2025 - */ - 'attributes'?: object; - /** - * The outlier score determined by the detection engine ranging from 0..1 - * @type {number} - * @memberof OutlierV2025 - */ - 'score'?: number; - /** - * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored - * @type {string} - * @memberof OutlierV2025 - */ - 'unignoreType'?: OutlierV2025UnignoreTypeV2025 | null; - /** - * shows date when last time has been unignored outlier - * @type {string} - * @memberof OutlierV2025 - */ - 'unignoreDate'?: string | null; - /** - * shows date when last time has been ignored outlier - * @type {string} - * @memberof OutlierV2025 - */ - 'ignoreDate'?: string | null; -} - -export const OutlierV2025TypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierV2025TypeV2025 = typeof OutlierV2025TypeV2025[keyof typeof OutlierV2025TypeV2025]; -export const OutlierV2025UnignoreTypeV2025 = { - Manual: 'MANUAL', - Automatic: 'AUTOMATIC' -} as const; - -export type OutlierV2025UnignoreTypeV2025 = typeof OutlierV2025UnignoreTypeV2025[keyof typeof OutlierV2025UnignoreTypeV2025]; - -/** - * The data type of the value field - * @export - * @interface OutlierValueTypeV2025 - */ -export interface OutlierValueTypeV2025 { - /** - * The data type of the value field - * @type {string} - * @memberof OutlierValueTypeV2025 - */ - 'name'?: OutlierValueTypeV2025NameV2025; - /** - * The position of the value type - * @type {number} - * @memberof OutlierValueTypeV2025 - */ - 'ordinal'?: number; -} - -export const OutlierValueTypeV2025NameV2025 = { - Integer: 'INTEGER', - Float: 'FLOAT' -} as const; - -export type OutlierValueTypeV2025NameV2025 = typeof OutlierValueTypeV2025NameV2025[keyof typeof OutlierValueTypeV2025NameV2025]; - -/** - * - * @export - * @interface OutliersContributingFeatureAccessItemsV2025 - */ -export interface OutliersContributingFeatureAccessItemsV2025 { - /** - * The ID of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'id'?: string; - /** - * the display name of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'displayName'?: string; - /** - * Description of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'description'?: string | null; - /** - * The type of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'accessType'?: OutliersContributingFeatureAccessItemsV2025AccessTypeV2025; - /** - * the associated source name if it exists - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'sourceName'?: string; - /** - * rarest access - * @type {boolean} - * @memberof OutliersContributingFeatureAccessItemsV2025 - */ - 'extremelyRare'?: boolean; -} - -export const OutliersContributingFeatureAccessItemsV2025AccessTypeV2025 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type OutliersContributingFeatureAccessItemsV2025AccessTypeV2025 = typeof OutliersContributingFeatureAccessItemsV2025AccessTypeV2025[keyof typeof OutliersContributingFeatureAccessItemsV2025AccessTypeV2025]; - -/** - * Owner\'s identity. - * @export - * @interface OwnerDtoV2025 - */ -export interface OwnerDtoV2025 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof OwnerDtoV2025 - */ - 'type'?: OwnerDtoV2025TypeV2025; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerDtoV2025 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof OwnerDtoV2025 - */ - 'name'?: string; -} - -export const OwnerDtoV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerDtoV2025TypeV2025 = typeof OwnerDtoV2025TypeV2025[keyof typeof OwnerDtoV2025TypeV2025]; - -/** - * The owner of this object. - * @export - * @interface OwnerReferenceSegmentsV2025 - */ -export interface OwnerReferenceSegmentsV2025 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2025 - */ - 'type'?: OwnerReferenceSegmentsV2025TypeV2025; - /** - * Identity id - * @type {string} - * @memberof OwnerReferenceSegmentsV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2025 - */ - 'name'?: string; -} - -export const OwnerReferenceSegmentsV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceSegmentsV2025TypeV2025 = typeof OwnerReferenceSegmentsV2025TypeV2025[keyof typeof OwnerReferenceSegmentsV2025TypeV2025]; - -/** - * Owner of the object. - * @export - * @interface OwnerReferenceV2025 - */ -export interface OwnerReferenceV2025 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2025 - */ - 'type'?: OwnerReferenceV2025TypeV2025; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerReferenceV2025 - */ - 'id'?: string; - /** - * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2025 - */ - 'name'?: string; -} - -export const OwnerReferenceV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceV2025TypeV2025 = typeof OwnerReferenceV2025TypeV2025[keyof typeof OwnerReferenceV2025TypeV2025]; - -/** - * - * @export - * @interface OwnsV2025 - */ -export interface OwnsV2025 { - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'sources'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'entitlements'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'accessProfiles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'roles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'apps'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2025 - */ - 'governanceGroups'?: Array; - /** - * - * @type {boolean} - * @memberof OwnsV2025 - */ - 'fallbackApprover'?: boolean; -} -/** - * The attestation document. This is Base64Url encoded binary data containing the attestation document. This has a cert with a public key that needs to be used to encrypt the private fields of the parameter on creation or update. - * @export - * @interface ParameterStorageAttestationDocumentV2025 - */ -export interface ParameterStorageAttestationDocumentV2025 { - /** - * The Base64Url encoded attestation document. - * @type {string} - * @memberof ParameterStorageAttestationDocumentV2025 - */ - 'attestationDocument'?: string; -} -/** - * RFC 6902 JSON Patch operation - * @export - * @interface ParameterStorageJsonPatchV2025 - */ -export interface ParameterStorageJsonPatchV2025 { - /** - * The operation to perform (add, remove, replace, move, copy, test) - * @type {string} - * @memberof ParameterStorageJsonPatchV2025 - */ - 'op': ParameterStorageJsonPatchV2025OpV2025; - /** - * A JSON-Pointer describing the target location - * @type {string} - * @memberof ParameterStorageJsonPatchV2025 - */ - 'path': string; - /** - * The value to be used within the operations. Required for add/replace/test. - * @type {object} - * @memberof ParameterStorageJsonPatchV2025 - */ - 'value'?: object; - /** - * A JSON-Pointer describing the source location for move/copy. - * @type {string} - * @memberof ParameterStorageJsonPatchV2025 - */ - 'from'?: string; -} - -export const ParameterStorageJsonPatchV2025OpV2025 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type ParameterStorageJsonPatchV2025OpV2025 = typeof ParameterStorageJsonPatchV2025OpV2025[keyof typeof ParameterStorageJsonPatchV2025OpV2025]; - -/** - * A parameter to add to parameter storage. The public and private fields must match the type specification. - * @export - * @interface ParameterStorageNewParameterV2025 - */ -export interface ParameterStorageNewParameterV2025 { - /** - * The UUID of the parameter owner. - * @type {string} - * @memberof ParameterStorageNewParameterV2025 - */ - 'ownerId': string; - /** - * The human-readable name for the parameter. - * @type {string} - * @memberof ParameterStorageNewParameterV2025 - */ - 'name': string; - /** - * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. - * @type {string} - * @memberof ParameterStorageNewParameterV2025 - */ - 'type': string; - /** - * The content must be a JSON object containing the public fields that can be stored with this parameter. - * @type {object} - * @memberof ParameterStorageNewParameterV2025 - */ - 'publicFields'?: object; - /** - * Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter. - * @type {string} - * @memberof ParameterStorageNewParameterV2025 - */ - 'privateFields'?: string; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageNewParameterV2025 - */ - 'description'?: string; -} -/** - * A parameter that has been retrieved from the store. - * @export - * @interface ParameterStorageParameterV2025 - */ -export interface ParameterStorageParameterV2025 { - /** - * The ID of the reference - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'id': string; - /** - * The ID of the user who owns the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'ownerId': string; - /** - * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'type'?: string; - /** - * The human-readable name of the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'name': string; - /** - * The name of the primary field in the public fields. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'primaryField'?: string; - /** - * The public fields stored for this parameter. See the types document for information about what can be stored. - * @type {object} - * @memberof ParameterStorageParameterV2025 - */ - 'publicFields': object; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'description'?: string; - /** - * ISO8606 format datetime of the last time any field of the parameter was changed. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'lastModifiedAt'?: string; - /** - * The ID of the user who last modified the parameter. Empty when identity is not known. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'lastModifiedBy'?: string; - /** - * ISO8606 format datetime of the time the secret fields were changed on the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'privateFieldsLastModifiedAt'?: string; - /** - * The ID of the user who last modified the private fields. Empty when identity is not known. - * @type {string} - * @memberof ParameterStorageParameterV2025 - */ - 'privateFieldsLastModifiedBy'?: string; -} -/** - * Reference information returned in response to a request. - * @export - * @interface ParameterStorageReferenceV2025 - */ -export interface ParameterStorageReferenceV2025 { - /** - * The ID of the reference - * @type {string} - * @memberof ParameterStorageReferenceV2025 - */ - 'id': string; - /** - * The ID of the consumer holding the reference - * @type {string} - * @memberof ParameterStorageReferenceV2025 - */ - 'consumerId': string; - /** - * The ID of the parameter that the reference is pointing to. - * @type {string} - * @memberof ParameterStorageReferenceV2025 - */ - 'parameterId': string; - /** - * The human-readable name of the reference - * @type {string} - * @memberof ParameterStorageReferenceV2025 - */ - 'name': string; - /** - * The hint string used to validate the reference - * @type {string} - * @memberof ParameterStorageReferenceV2025 - */ - 'usageHint'?: string; -} -/** - * An existing parameter that needs to be updated. The type cannot be changed once the parameter is created. - * @export - * @interface ParameterStorageUpdateParameterV2025 - */ -export interface ParameterStorageUpdateParameterV2025 { - /** - * The UUID of the parameter owner. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2025 - */ - 'ownerId'?: string; - /** - * The human-readable name for the parameter. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2025 - */ - 'name'?: string; - /** - * The public fields that can be stored with this parameter. - * @type {object} - * @memberof ParameterStorageUpdateParameterV2025 - */ - 'publicFields'?: object; - /** - * The private fields that can be stored with this parameter. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2025 - */ - 'privateFields'?: string; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageUpdateParameterV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface PasswordChangeRequestV2025 - */ -export interface PasswordChangeRequestV2025 { - /** - * The identity ID that requested the password change - * @type {string} - * @memberof PasswordChangeRequestV2025 - */ - 'identityId'?: string; - /** - * The RSA encrypted password - * @type {string} - * @memberof PasswordChangeRequestV2025 - */ - 'encryptedPassword'?: string; - /** - * The encryption key ID - * @type {string} - * @memberof PasswordChangeRequestV2025 - */ - 'publicKeyId'?: string; - /** - * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordChangeRequestV2025 - */ - 'accountId'?: string; - /** - * The ID of the source for which identity is requesting the password change - * @type {string} - * @memberof PasswordChangeRequestV2025 - */ - 'sourceId'?: string; -} -/** - * - * @export - * @interface PasswordChangeResponseV2025 - */ -export interface PasswordChangeResponseV2025 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordChangeResponseV2025 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordChangeResponseV2025 - */ - 'state'?: PasswordChangeResponseV2025StateV2025; -} - -export const PasswordChangeResponseV2025StateV2025 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordChangeResponseV2025StateV2025 = typeof PasswordChangeResponseV2025StateV2025[keyof typeof PasswordChangeResponseV2025StateV2025]; - -/** - * - * @export - * @interface PasswordDigitTokenResetV2025 - */ -export interface PasswordDigitTokenResetV2025 { - /** - * The uid of the user requested for digit token - * @type {string} - * @memberof PasswordDigitTokenResetV2025 - */ - 'userId': string; - /** - * The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. - * @type {number} - * @memberof PasswordDigitTokenResetV2025 - */ - 'length'?: number; - /** - * The time to live for the digit token in minutes. The default value is 5 minutes. - * @type {number} - * @memberof PasswordDigitTokenResetV2025 - */ - 'durationMinutes'?: number; -} -/** - * - * @export - * @interface PasswordDigitTokenV2025 - */ -export interface PasswordDigitTokenV2025 { - /** - * The digit token for password management - * @type {string} - * @memberof PasswordDigitTokenV2025 - */ - 'digitToken'?: string; - /** - * The reference ID of the digit token generation request - * @type {string} - * @memberof PasswordDigitTokenV2025 - */ - 'requestId'?: string; -} -/** - * - * @export - * @interface PasswordInfoAccountV2025 - */ -export interface PasswordInfoAccountV2025 { - /** - * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordInfoAccountV2025 - */ - 'accountId'?: string; - /** - * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - * @type {string} - * @memberof PasswordInfoAccountV2025 - */ - 'accountName'?: string; -} -/** - * - * @export - * @interface PasswordInfoQueryDTOV2025 - */ -export interface PasswordInfoQueryDTOV2025 { - /** - * The login name of the user - * @type {string} - * @memberof PasswordInfoQueryDTOV2025 - */ - 'userName'?: string; - /** - * The display name of the source - * @type {string} - * @memberof PasswordInfoQueryDTOV2025 - */ - 'sourceName'?: string; -} -/** - * - * @export - * @interface PasswordInfoV2025 - */ -export interface PasswordInfoV2025 { - /** - * Identity ID - * @type {string} - * @memberof PasswordInfoV2025 - */ - 'identityId'?: string; - /** - * source ID - * @type {string} - * @memberof PasswordInfoV2025 - */ - 'sourceId'?: string; - /** - * public key ID - * @type {string} - * @memberof PasswordInfoV2025 - */ - 'publicKeyId'?: string; - /** - * User\'s public key with Base64 encoding - * @type {string} - * @memberof PasswordInfoV2025 - */ - 'publicKey'?: string; - /** - * Account info related to queried identity and source - * @type {Array} - * @memberof PasswordInfoV2025 - */ - 'accounts'?: Array; - /** - * Password constraints - * @type {Array} - * @memberof PasswordInfoV2025 - */ - 'policies'?: Array; -} -/** - * - * @export - * @interface PasswordOrgConfigV2025 - */ -export interface PasswordOrgConfigV2025 { - /** - * Indicator whether custom password instructions feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2025 - */ - 'customInstructionsEnabled'?: boolean; - /** - * Indicator whether \"digit token\" feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2025 - */ - 'digitTokenEnabled'?: boolean; - /** - * The duration of \"digit token\" in minutes. The default value is 5. - * @type {number} - * @memberof PasswordOrgConfigV2025 - */ - 'digitTokenDurationMinutes'?: number; - /** - * The length of \"digit token\". The default value is 6. - * @type {number} - * @memberof PasswordOrgConfigV2025 - */ - 'digitTokenLength'?: number; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2025 - */ -export interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2025 { - /** - * Attribute\'s name - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2025 - */ - 'name'?: string; - /** - * Attribute\'s value - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesV2025 - */ -export interface PasswordPolicyHoldersDtoAttributesV2025 { - /** - * Attributes of PasswordPolicyHoldersDto - * @type {Array} - * @memberof PasswordPolicyHoldersDtoAttributesV2025 - */ - 'identityAttr'?: Array; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoInnerV2025 - */ -export interface PasswordPolicyHoldersDtoInnerV2025 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2025 - */ - 'policyId'?: string; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2025 - */ - 'policyName'?: string; - /** - * - * @type {PasswordPolicyHoldersDtoAttributesV2025} - * @memberof PasswordPolicyHoldersDtoInnerV2025 - */ - 'selectors'?: PasswordPolicyHoldersDtoAttributesV2025; -} -/** - * - * @export - * @interface PasswordPolicyV3DtoV2025 - */ -export interface PasswordPolicyV3DtoV2025 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'id'?: string; - /** - * Description for current password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'description'?: string | null; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'name'?: string; - /** - * Date the Password Policy was created. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'dateCreated'?: number; - /** - * Date the Password Policy was updated. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'lastUpdated'?: number | null; - /** - * The number of days before expiration remaninder. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'firstExpirationReminder'?: number; - /** - * The minimun length of account Id. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'accountIdMinWordLength'?: number; - /** - * The minimun length of account name. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'accountNameMinWordLength'?: number; - /** - * Maximum alpha. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minAlpha'?: number; - /** - * MinCharacterTypes. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minCharacterTypes'?: number; - /** - * Maximum length of the password. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'maxLength'?: number; - /** - * Minimum length of the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minLength'?: number; - /** - * Maximum repetition of the same character in the password. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'maxRepeatedChars'?: number; - /** - * Minimum amount of lower case character in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minLower'?: number; - /** - * Minimum amount of numeric characters in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minNumeric'?: number; - /** - * Minimum amount of special symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minSpecial'?: number; - /** - * Minimum amount of upper case symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'minUpper'?: number; - /** - * Number of days before current password expires. By default is equals to 90. - * @type {number} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'passwordExpiration'?: number; - /** - * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'defaultPolicy'?: boolean; - /** - * Defines whether this policy is enabled to expire or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'enablePasswdExpiration'?: boolean; - /** - * Defines whether this policy require strong Auth or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'requireStrongAuthn'?: boolean; - /** - * Defines whether this policy require strong Auth of network or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'requireStrongAuthOffNetwork'?: boolean; - /** - * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'requireStrongAuthUntrustedGeographies'?: boolean; - /** - * Defines whether this policy uses account attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'useAccountAttributes'?: boolean; - /** - * Defines whether this policy uses dictionary or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'useDictionary'?: boolean; - /** - * Defines whether this policy uses identity attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'useIdentityAttributes'?: boolean; - /** - * Defines whether this policy validate against account id or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'validateAgainstAccountId'?: boolean; - /** - * Defines whether this policy validate against account name or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'validateAgainstAccountName'?: boolean; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'created'?: string | null; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'modified'?: string | null; - /** - * List of sources IDs managed by this password policy. - * @type {Array} - * @memberof PasswordPolicyV3DtoV2025 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface PasswordStatusV2025 - */ -export interface PasswordStatusV2025 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordStatusV2025 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordStatusV2025 - */ - 'state'?: PasswordStatusV2025StateV2025; - /** - * The errors during the password change request - * @type {Array} - * @memberof PasswordStatusV2025 - */ - 'errors'?: Array; - /** - * List of source IDs in the password change request - * @type {Array} - * @memberof PasswordStatusV2025 - */ - 'sourceIds'?: Array; -} - -export const PasswordStatusV2025StateV2025 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordStatusV2025StateV2025 = typeof PasswordStatusV2025StateV2025[keyof typeof PasswordStatusV2025StateV2025]; - -/** - * - * @export - * @interface PasswordSyncGroupV2025 - */ -export interface PasswordSyncGroupV2025 { - /** - * ID of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2025 - */ - 'id'?: string; - /** - * Name of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2025 - */ - 'name'?: string; - /** - * ID of the password policy - * @type {string} - * @memberof PasswordSyncGroupV2025 - */ - 'passwordPolicyId'?: string; - /** - * List of password managed sources IDs - * @type {Array} - * @memberof PasswordSyncGroupV2025 - */ - 'sourceIds'?: Array; - /** - * The date and time this sync group was created - * @type {string} - * @memberof PasswordSyncGroupV2025 - */ - 'created'?: string | null; - /** - * The date and time this sync group was last modified - * @type {string} - * @memberof PasswordSyncGroupV2025 - */ - 'modified'?: string | null; -} -/** - * Personal access token owner\'s identity. - * @export - * @interface PatOwnerV2025 - */ -export interface PatOwnerV2025 { - /** - * Personal access token owner\'s DTO type. - * @type {string} - * @memberof PatOwnerV2025 - */ - 'type'?: PatOwnerV2025TypeV2025; - /** - * Personal access token owner\'s identity ID. - * @type {string} - * @memberof PatOwnerV2025 - */ - 'id'?: string; - /** - * Personal access token owner\'s human-readable display name. - * @type {string} - * @memberof PatOwnerV2025 - */ - 'name'?: string; -} - -export const PatOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type PatOwnerV2025TypeV2025 = typeof PatOwnerV2025TypeV2025[keyof typeof PatOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface PeerGroupMemberV2025 - */ -export interface PeerGroupMemberV2025 { - /** - * A unique identifier for the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2025 - */ - 'id'?: string; - /** - * The type of the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2025 - */ - 'type'?: string; - /** - * The ID of the peer group. - * @type {string} - * @memberof PeerGroupMemberV2025 - */ - 'peer_group_id'?: string; - /** - * Arbitrary key-value pairs, belonging to the peer group member. - * @type {{ [key: string]: object; }} - * @memberof PeerGroupMemberV2025 - */ - 'attributes'?: { [key: string]: object; }; -} -/** - * Enum represents action that is being processed on an approval. - * @export - * @enum {string} - */ - -export const PendingApprovalActionV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Forwarded: 'FORWARDED' -} as const; - -export type PendingApprovalActionV2025 = typeof PendingApprovalActionV2025[keyof typeof PendingApprovalActionV2025]; - - -/** - * The maximum duration for which the access is permitted. - * @export - * @interface PendingApprovalMaxPermittedAccessDurationV2025 - */ -export interface PendingApprovalMaxPermittedAccessDurationV2025 { - /** - * The numeric value of the duration. - * @type {number} - * @memberof PendingApprovalMaxPermittedAccessDurationV2025 - */ - 'value'?: number; - /** - * The time unit for the duration. - * @type {string} - * @memberof PendingApprovalMaxPermittedAccessDurationV2025 - */ - 'timeUnit'?: PendingApprovalMaxPermittedAccessDurationV2025TimeUnitV2025; -} - -export const PendingApprovalMaxPermittedAccessDurationV2025TimeUnitV2025 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type PendingApprovalMaxPermittedAccessDurationV2025TimeUnitV2025 = typeof PendingApprovalMaxPermittedAccessDurationV2025TimeUnitV2025[keyof typeof PendingApprovalMaxPermittedAccessDurationV2025TimeUnitV2025]; - -/** - * Access item owner\'s identity. - * @export - * @interface PendingApprovalOwnerV2025 - */ -export interface PendingApprovalOwnerV2025 { - /** - * Access item owner\'s DTO type. - * @type {string} - * @memberof PendingApprovalOwnerV2025 - */ - 'type'?: PendingApprovalOwnerV2025TypeV2025; - /** - * Access item owner\'s identity ID. - * @type {string} - * @memberof PendingApprovalOwnerV2025 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof PendingApprovalOwnerV2025 - */ - 'name'?: string; -} - -export const PendingApprovalOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type PendingApprovalOwnerV2025TypeV2025 = typeof PendingApprovalOwnerV2025TypeV2025[keyof typeof PendingApprovalOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface PendingApprovalV2025 - */ -export interface PendingApprovalV2025 { - /** - * The approval id. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'id'?: string; - /** - * This is the access request id. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'accessRequestId'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof PendingApprovalV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * - * @type {AccessItemRequesterV2025} - * @memberof PendingApprovalV2025 - */ - 'requester'?: AccessItemRequesterV2025; - /** - * - * @type {AccessItemRequestedForV2025} - * @memberof PendingApprovalV2025 - */ - 'requestedFor'?: AccessItemRequestedForV2025; - /** - * - * @type {PendingApprovalOwnerV2025} - * @memberof PendingApprovalV2025 - */ - 'owner'?: PendingApprovalOwnerV2025; - /** - * - * @type {RequestableObjectReferenceV2025} - * @memberof PendingApprovalV2025 - */ - 'requestedObject'?: RequestableObjectReferenceV2025; - /** - * - * @type {CommentDtoV2025} - * @memberof PendingApprovalV2025 - */ - 'requesterComment'?: CommentDtoV2025; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof PendingApprovalV2025 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof PendingApprovalV2025 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof PendingApprovalV2025 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {PendingApprovalActionV2025} - * @memberof PendingApprovalV2025 - */ - 'actionInProcess'?: PendingApprovalActionV2025; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'removeDate'?: string; - /** - * If true, then the request is to change the remove date or sunset date. - * @type {boolean} - * @memberof PendingApprovalV2025 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'currentRemoveDate'?: string; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof PendingApprovalV2025 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2025} - * @memberof PendingApprovalV2025 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2025 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof PendingApprovalV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof PendingApprovalV2025 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof PendingApprovalV2025 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDurationV2025} - * @memberof PendingApprovalV2025 - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDurationV2025 | null; -} - - -/** - * - * @export - * @interface PermissionCollectorSettingsV2025 - */ -export interface PermissionCollectorSettingsV2025 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2025 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof PermissionCollectorSettingsV2025 - */ - 'clusterId'?: string | null; - /** - * Indicates whether unique permissions should be analyzed for resources. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2025 - */ - 'analyzeUniquePermissions'?: boolean | null; - /** - * Indicates whether effective permissions should be calculated. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2025 - */ - 'calculateEffectivePermissions'?: boolean | null; - /** - * Indicates whether riskiest permissions should be calculated. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2025 - */ - 'calculateRiskiestPermissions'?: boolean | null; - /** - * Source for effective permissions calculation. - * @type {string} - * @memberof PermissionCollectorSettingsV2025 - */ - 'effectivePermissionsSource'?: string | null; -} -/** - * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - * @export - * @interface PermissionDtoV2025 - */ -export interface PermissionDtoV2025 { - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof PermissionDtoV2025 - */ - 'rights'?: Array; - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof PermissionDtoV2025 - */ - 'target'?: string; -} -/** - * Provides additional details about the pre-approval trigger for this request. - * @export - * @interface PreApprovalTriggerDetailsV2025 - */ -export interface PreApprovalTriggerDetailsV2025 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2025 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2025 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof PreApprovalTriggerDetailsV2025 - */ - 'decision'?: PreApprovalTriggerDetailsV2025DecisionV2025; -} - -export const PreApprovalTriggerDetailsV2025DecisionV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type PreApprovalTriggerDetailsV2025DecisionV2025 = typeof PreApprovalTriggerDetailsV2025DecisionV2025[keyof typeof PreApprovalTriggerDetailsV2025DecisionV2025]; - -/** - * Maps an Identity\'s attribute key to a list of preferred notification mediums. - * @export - * @interface PreferencesDtoV2025 - */ -export interface PreferencesDtoV2025 { - /** - * The template notification key. - * @type {string} - * @memberof PreferencesDtoV2025 - */ - 'key'?: string; - /** - * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - * @type {Array} - * @memberof PreferencesDtoV2025 - */ - 'mediums'?: Array; - /** - * Modified date of preference - * @type {string} - * @memberof PreferencesDtoV2025 - */ - 'modified'?: string; -} -/** - * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint - * @export - * @interface PreviewDataSourceResponseV2025 - */ -export interface PreviewDataSourceResponseV2025 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof PreviewDataSourceResponseV2025 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface PrivilegeCriteriaConfigDTOV2025 - */ -export interface PrivilegeCriteriaConfigDTOV2025 { - /** - * The Id of the task which is executing the bulk update. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2025 - */ - 'id'?: string; - /** - * The Id of the source that the criteria configuration is applied to. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2025 - */ - 'sourceId'?: string; - /** - * The configuration settings for privilege criteria evaluation. - * @type {object} - * @memberof PrivilegeCriteriaConfigDTOV2025 - */ - 'config'?: object; - /** - * The date and time when the privilege criteria configuration was created. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2025 - */ - 'created'?: string; - /** - * The date and time when the privilege criteria configuration was last modified. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2025 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ -export interface PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 { - /** - * The target type for the criteria item. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ - 'targetType'?: PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025; - /** - * The operator to apply to the property and values. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ - 'operator'?: PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025OperatorV2025; - /** - * - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ - 'property'?: string; - /** - * The values to evaluate the property against. - * @type {Array} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ - 'values'?: Array; - /** - * Whether to ignore case when evaluating the property against the values. - * @type {boolean} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025 - */ - 'ignoreCase'?: boolean; -} - -export const PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025 = { - Group: 'group' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025 = typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025[keyof typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025TargetTypeV2025]; -export const PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025OperatorV2025 = { - In: 'IN', - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025OperatorV2025 = typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025OperatorV2025[keyof typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2025OperatorV2025]; - -/** - * - * @export - * @interface PrivilegeCriteriaDTOGroupsInnerV2025 - */ -export interface PrivilegeCriteriaDTOGroupsInnerV2025 { - /** - * The logical operator to apply between criteria items in the group. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerV2025 - */ - 'operator'?: PrivilegeCriteriaDTOGroupsInnerV2025OperatorV2025; - /** - * - * @type {Array} - * @memberof PrivilegeCriteriaDTOGroupsInnerV2025 - */ - 'criteriaItems'?: Array; -} - -export const PrivilegeCriteriaDTOGroupsInnerV2025OperatorV2025 = { - And: 'AND', - Or: 'OR' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerV2025OperatorV2025 = typeof PrivilegeCriteriaDTOGroupsInnerV2025OperatorV2025[keyof typeof PrivilegeCriteriaDTOGroupsInnerV2025OperatorV2025]; - -/** - * - * @export - * @interface PrivilegeCriteriaDTOV2025 - */ -export interface PrivilegeCriteriaDTOV2025 { - /** - * The Id of the criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'id'?: string; - /** - * The Id of the source that the criteria is applied to. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'sourceId'?: string; - /** - * The type of criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'type'?: PrivilegeCriteriaDTOV2025TypeV2025; - /** - * The logical operator to apply between groups. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'operator'?: PrivilegeCriteriaDTOV2025OperatorV2025; - /** - * - * @type {Array} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'groups'?: Array; - /** - * The privilege level assigned by this criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2025 - */ - 'privilegeLevel'?: PrivilegeCriteriaDTOV2025PrivilegeLevelV2025; -} - -export const PrivilegeCriteriaDTOV2025TypeV2025 = { - Custom: 'CUSTOM', - Connector: 'CONNECTOR', - SingleLevel: 'SINGLE_LEVEL' -} as const; - -export type PrivilegeCriteriaDTOV2025TypeV2025 = typeof PrivilegeCriteriaDTOV2025TypeV2025[keyof typeof PrivilegeCriteriaDTOV2025TypeV2025]; -export const PrivilegeCriteriaDTOV2025OperatorV2025 = { - And: 'AND', - Or: 'OR' -} as const; - -export type PrivilegeCriteriaDTOV2025OperatorV2025 = typeof PrivilegeCriteriaDTOV2025OperatorV2025[keyof typeof PrivilegeCriteriaDTOV2025OperatorV2025]; -export const PrivilegeCriteriaDTOV2025PrivilegeLevelV2025 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type PrivilegeCriteriaDTOV2025PrivilegeLevelV2025 = typeof PrivilegeCriteriaDTOV2025PrivilegeLevelV2025[keyof typeof PrivilegeCriteriaDTOV2025PrivilegeLevelV2025]; - -/** - * - * @export - * @interface ProcessIdentitiesRequestV2025 - */ -export interface ProcessIdentitiesRequestV2025 { - /** - * List of up to 250 identity IDs to process. - * @type {Array} - * @memberof ProcessIdentitiesRequestV2025 - */ - 'identityIds'?: Array; -} -/** - * - * @export - * @interface ProcessingDetailsV2025 - */ -export interface ProcessingDetailsV2025 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ProcessingDetailsV2025 - */ - 'date'?: string | null; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2025 - */ - 'stage'?: string; - /** - * - * @type {number} - * @memberof ProcessingDetailsV2025 - */ - 'retryCount'?: number; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2025 - */ - 'stackTrace'?: string; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2025 - */ - 'message'?: string; -} -/** - * - * @export - * @interface ProductV2025 - */ -export interface ProductV2025 { - /** - * Name of the Product - * @type {string} - * @memberof ProductV2025 - */ - 'productName'?: string; - /** - * URL of the Product - * @type {string} - * @memberof ProductV2025 - */ - 'url'?: string; - /** - * An identifier for a specific product-tenant combination - * @type {string} - * @memberof ProductV2025 - */ - 'productTenantId'?: string; - /** - * Product region - * @type {string} - * @memberof ProductV2025 - */ - 'productRegion'?: string; - /** - * Right needed for the Product - * @type {string} - * @memberof ProductV2025 - */ - 'productRight'?: string; - /** - * API URL of the Product - * @type {string} - * @memberof ProductV2025 - */ - 'apiUrl'?: string | null; - /** - * - * @type {Array} - * @memberof ProductV2025 - */ - 'licenses'?: Array; - /** - * Additional attributes for a product - * @type {{ [key: string]: any; }} - * @memberof ProductV2025 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Zone - * @type {string} - * @memberof ProductV2025 - */ - 'zone'?: string; - /** - * Status of the product - * @type {string} - * @memberof ProductV2025 - */ - 'status'?: string; - /** - * Status datetime - * @type {string} - * @memberof ProductV2025 - */ - 'statusDateTime'?: string; - /** - * If there\'s a tenant provisioning failure then reason will have the description of error - * @type {string} - * @memberof ProductV2025 - */ - 'reason'?: string; - /** - * Product could have additional notes added during tenant provisioning. - * @type {string} - * @memberof ProductV2025 - */ - 'notes'?: string; - /** - * Date when the product was created - * @type {string} - * @memberof ProductV2025 - */ - 'dateCreated'?: string | null; - /** - * Date when the product was last updated - * @type {string} - * @memberof ProductV2025 - */ - 'lastUpdated'?: string | null; - /** - * Type of org - * @type {string} - * @memberof ProductV2025 - */ - 'orgType'?: ProductV2025OrgTypeV2025 | null; -} - -export const ProductV2025OrgTypeV2025 = { - Development: 'development', - Staging: 'staging', - Production: 'production', - Test: 'test', - Partner: 'partner', - Training: 'training', - Demonstration: 'demonstration', - Sandbox: 'sandbox' -} as const; - -export type ProductV2025OrgTypeV2025 = typeof ProductV2025OrgTypeV2025[keyof typeof ProductV2025OrgTypeV2025]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025 - */ -export interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025 { - /** - * The name of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025 - */ - 'attributeName': string; - /** - * The value of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025 - */ - 'attributeValue'?: string | null; - /** - * The operation to handle the attribute. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025 - */ - 'operation': ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025OperationV2025; -} - -export const ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025OperationV2025 = { - Add: 'Add', - Set: 'Set', - Remove: 'Remove' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025OperationV2025 = typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025OperationV2025[keyof typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2025OperationV2025]; - -/** - * Reference to the source being provisioned against. - * @export - * @interface ProvisioningCompletedAccountRequestsInnerSourceV2025 - */ -export interface ProvisioningCompletedAccountRequestsInnerSourceV2025 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2025 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2025 - */ - 'type': ProvisioningCompletedAccountRequestsInnerSourceV2025TypeV2025; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2025 - */ - 'name': string; -} - -export const ProvisioningCompletedAccountRequestsInnerSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerSourceV2025TypeV2025 = typeof ProvisioningCompletedAccountRequestsInnerSourceV2025TypeV2025[keyof typeof ProvisioningCompletedAccountRequestsInnerSourceV2025TypeV2025]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerV2025 - */ -export interface ProvisioningCompletedAccountRequestsInnerV2025 { - /** - * - * @type {ProvisioningCompletedAccountRequestsInnerSourceV2025} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'source': ProvisioningCompletedAccountRequestsInnerSourceV2025; - /** - * The unique idenfier of the account being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'accountId'?: string; - /** - * The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'accountOperation': string; - /** - * The overall result of the provisioning transaction; this could be success, pending, failed, etc. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'provisioningResult': ProvisioningCompletedAccountRequestsInnerV2025ProvisioningResultV2025; - /** - * The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'provisioningTarget': string; - /** - * A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'ticketId'?: string | null; - /** - * A list of attributes as part of the provisioning transaction. - * @type {Array} - * @memberof ProvisioningCompletedAccountRequestsInnerV2025 - */ - 'attributeRequests'?: Array | null; -} - -export const ProvisioningCompletedAccountRequestsInnerV2025ProvisioningResultV2025 = { - Success: 'SUCCESS', - Pending: 'PENDING', - Failed: 'FAILED' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerV2025ProvisioningResultV2025 = typeof ProvisioningCompletedAccountRequestsInnerV2025ProvisioningResultV2025[keyof typeof ProvisioningCompletedAccountRequestsInnerV2025ProvisioningResultV2025]; - -/** - * Provisioning recpient. - * @export - * @interface ProvisioningCompletedRecipientV2025 - */ -export interface ProvisioningCompletedRecipientV2025 { - /** - * Provisioning recipient DTO type. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2025 - */ - 'type': ProvisioningCompletedRecipientV2025TypeV2025; - /** - * Provisioning recipient\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2025 - */ - 'id': string; - /** - * Provisioning recipient\'s display name. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2025 - */ - 'name': string; -} - -export const ProvisioningCompletedRecipientV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRecipientV2025TypeV2025 = typeof ProvisioningCompletedRecipientV2025TypeV2025[keyof typeof ProvisioningCompletedRecipientV2025TypeV2025]; - -/** - * Provisioning requester\'s identity. - * @export - * @interface ProvisioningCompletedRequesterV2025 - */ -export interface ProvisioningCompletedRequesterV2025 { - /** - * Provisioning requester\'s DTO type. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2025 - */ - 'type': ProvisioningCompletedRequesterV2025TypeV2025; - /** - * Provisioning requester\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2025 - */ - 'id': string; - /** - * Provisioning owner\'s human-readable display name. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2025 - */ - 'name': string; -} - -export const ProvisioningCompletedRequesterV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRequesterV2025TypeV2025 = typeof ProvisioningCompletedRequesterV2025TypeV2025[keyof typeof ProvisioningCompletedRequesterV2025TypeV2025]; - -/** - * - * @export - * @interface ProvisioningCompletedV2025 - */ -export interface ProvisioningCompletedV2025 { - /** - * The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. - * @type {string} - * @memberof ProvisioningCompletedV2025 - */ - 'trackingNumber': string; - /** - * One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. - * @type {string} - * @memberof ProvisioningCompletedV2025 - */ - 'sources': string; - /** - * Origin of where the provisioning request came from. - * @type {string} - * @memberof ProvisioningCompletedV2025 - */ - 'action'?: string | null; - /** - * A list of any accumulated error messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2025 - */ - 'errors'?: Array | null; - /** - * A list of any accumulated warning messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2025 - */ - 'warnings'?: Array | null; - /** - * - * @type {ProvisioningCompletedRecipientV2025} - * @memberof ProvisioningCompletedV2025 - */ - 'recipient': ProvisioningCompletedRecipientV2025; - /** - * - * @type {ProvisioningCompletedRequesterV2025} - * @memberof ProvisioningCompletedV2025 - */ - 'requester'?: ProvisioningCompletedRequesterV2025 | null; - /** - * A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. - * @type {Array} - * @memberof ProvisioningCompletedV2025 - */ - 'accountRequests': Array; -} -/** - * This is a reference to a plan initializer script. - * @export - * @interface ProvisioningConfigPlanInitializerScriptV2025 - */ -export interface ProvisioningConfigPlanInitializerScriptV2025 { - /** - * This is a Rule that allows provisioning instruction changes. - * @type {string} - * @memberof ProvisioningConfigPlanInitializerScriptV2025 - */ - 'source'?: string; -} -/** - * Specification of a Service Desk integration provisioning configuration. - * @export - * @interface ProvisioningConfigV2025 - */ -export interface ProvisioningConfigV2025 { - /** - * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - * @type {boolean} - * @memberof ProvisioningConfigV2025 - */ - 'universalManager'?: boolean; - /** - * References to sources for the Service Desk integration template. May only be specified if universalManager is false. - * @type {Array} - * @memberof ProvisioningConfigV2025 - */ - 'managedResourceRefs'?: Array; - /** - * - * @type {ProvisioningConfigPlanInitializerScriptV2025} - * @memberof ProvisioningConfigV2025 - */ - 'planInitializerScript'?: ProvisioningConfigPlanInitializerScriptV2025 | null; - /** - * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - * @type {boolean} - * @memberof ProvisioningConfigV2025 - */ - 'noProvisioningRequests'?: boolean; - /** - * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - * @type {number} - * @memberof ProvisioningConfigV2025 - */ - 'provisioningRequestExpiration'?: number; -} -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel1V2025 - */ -export interface ProvisioningCriteriaLevel1V2025 { - /** - * - * @type {ProvisioningCriteriaOperationV2025} - * @memberof ProvisioningCriteriaLevel1V2025 - */ - 'operation'?: ProvisioningCriteriaOperationV2025; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2025 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2025 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel1V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel2V2025 - */ -export interface ProvisioningCriteriaLevel2V2025 { - /** - * - * @type {ProvisioningCriteriaOperationV2025} - * @memberof ProvisioningCriteriaLevel2V2025 - */ - 'operation'?: ProvisioningCriteriaOperationV2025; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2025 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2025 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel2V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel3V2025 - */ -export interface ProvisioningCriteriaLevel3V2025 { - /** - * - * @type {ProvisioningCriteriaOperationV2025} - * @memberof ProvisioningCriteriaLevel3V2025 - */ - 'operation'?: ProvisioningCriteriaOperationV2025; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2025 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2025 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2025 - */ - 'children'?: string | null; -} - - -/** - * Supported operations on `ProvisioningCriteria`. - * @export - * @enum {string} - */ - -export const ProvisioningCriteriaOperationV2025 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - Has: 'HAS', - And: 'AND', - Or: 'OR' -} as const; - -export type ProvisioningCriteriaOperationV2025 = typeof ProvisioningCriteriaOperationV2025[keyof typeof ProvisioningCriteriaOperationV2025]; - - -/** - * Provides additional details about provisioning for this request. - * @export - * @interface ProvisioningDetailsV2025 - */ -export interface ProvisioningDetailsV2025 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof ProvisioningDetailsV2025 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * - * @export - * @interface ProvisioningPolicyDtoV2025 - */ -export interface ProvisioningPolicyDtoV2025 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyDtoV2025 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyDtoV2025 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2025} - * @memberof ProvisioningPolicyDtoV2025 - */ - 'usageType'?: UsageTypeV2025; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyDtoV2025 - */ - 'fields'?: Array; -} - - -/** - * - * @export - * @interface ProvisioningPolicyV2025 - */ -export interface ProvisioningPolicyV2025 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyV2025 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyV2025 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2025} - * @memberof ProvisioningPolicyV2025 - */ - 'usageType'?: UsageTypeV2025; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyV2025 - */ - 'fields'?: Array; -} - - -/** - * Provisioning state of an account activity item - * @export - * @enum {string} - */ - -export const ProvisioningStateV2025 = { - Pending: 'PENDING', - Finished: 'FINISHED', - Unverifiable: 'UNVERIFIABLE', - Commited: 'COMMITED', - Failed: 'FAILED', - Retry: 'RETRY' -} as const; - -export type ProvisioningStateV2025 = typeof ProvisioningStateV2025[keyof typeof ProvisioningStateV2025]; - - -/** - * Used to map an attribute key for an Identity to its display name. - * @export - * @interface PublicIdentityAttributeConfigV2025 - */ -export interface PublicIdentityAttributeConfigV2025 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributeConfigV2025 - */ - 'key'?: string; - /** - * The attribute display name - * @type {string} - * @memberof PublicIdentityAttributeConfigV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface PublicIdentityAttributesInnerV2025 - */ -export interface PublicIdentityAttributesInnerV2025 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributesInnerV2025 - */ - 'key'?: string; - /** - * Human-readable display name of the attribute - * @type {string} - * @memberof PublicIdentityAttributesInnerV2025 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof PublicIdentityAttributesInnerV2025 - */ - 'value'?: string | null; -} -/** - * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - * @export - * @interface PublicIdentityConfigV2025 - */ -export interface PublicIdentityConfigV2025 { - /** - * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - * @type {Array} - * @memberof PublicIdentityConfigV2025 - */ - 'attributes'?: Array; - /** - * When this configuration was last modified. - * @type {string} - * @memberof PublicIdentityConfigV2025 - */ - 'modified'?: string | null; - /** - * - * @type {IdentityReferenceV2025} - * @memberof PublicIdentityConfigV2025 - */ - 'modifiedBy'?: IdentityReferenceV2025 | null; -} -/** - * Details about a public identity - * @export - * @interface PublicIdentityV2025 - */ -export interface PublicIdentityV2025 { - /** - * Identity id - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'name'?: string; - /** - * Alternate unique identifier for the identity. - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'alias'?: string; - /** - * Email address of identity. - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'email'?: string | null; - /** - * The lifecycle status for the identity - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'status'?: string | null; - /** - * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. - * @type {string} - * @memberof PublicIdentityV2025 - */ - 'identityState'?: PublicIdentityV2025IdentityStateV2025 | null; - /** - * - * @type {IdentityReferenceV2025} - * @memberof PublicIdentityV2025 - */ - 'manager'?: IdentityReferenceV2025 | null; - /** - * The public identity attributes of the identity - * @type {Array} - * @memberof PublicIdentityV2025 - */ - 'attributes'?: Array; -} - -export const PublicIdentityV2025IdentityStateV2025 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type PublicIdentityV2025IdentityStateV2025 = typeof PublicIdentityV2025IdentityStateV2025[keyof typeof PublicIdentityV2025IdentityStateV2025]; - -/** - * @type PutClientLogConfigurationRequestV2025 - * @export - */ -export type PutClientLogConfigurationRequestV2025 = ClientLogConfigurationDurationMinutesV2025 | ClientLogConfigurationExpirationV2025; - -/** - * - * @export - * @interface PutConnectorCorrelationConfigRequestV2025 - */ -export interface PutConnectorCorrelationConfigRequestV2025 { - /** - * connector correlation config xml file - * @type {File} - * @memberof PutConnectorCorrelationConfigRequestV2025 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceConfigRequestV2025 - */ -export interface PutConnectorSourceConfigRequestV2025 { - /** - * connector source config xml file - * @type {File} - * @memberof PutConnectorSourceConfigRequestV2025 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceTemplateRequestV2025 - */ -export interface PutConnectorSourceTemplateRequestV2025 { - /** - * connector source template xml file - * @type {File} - * @memberof PutConnectorSourceTemplateRequestV2025 - */ - 'file': File; -} -/** - * - * @export - * @interface PutPasswordDictionaryRequestV2025 - */ -export interface PutPasswordDictionaryRequestV2025 { - /** - * - * @type {File} - * @memberof PutPasswordDictionaryRequestV2025 - */ - 'file'?: File; -} -/** - * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - * @export - * @interface QueryResultFilterV2025 - */ -export interface QueryResultFilterV2025 { - /** - * The list of field names to include in the result documents. - * @type {Array} - * @memberof QueryResultFilterV2025 - */ - 'includes'?: Array; - /** - * The list of field names to exclude from the result documents. - * @type {Array} - * @memberof QueryResultFilterV2025 - */ - 'excludes'?: Array; -} -/** - * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const QueryTypeV2025 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT', - Text: 'TEXT', - Typeahead: 'TYPEAHEAD' -} as const; - -export type QueryTypeV2025 = typeof QueryTypeV2025[keyof typeof QueryTypeV2025]; - - -/** - * Query parameters used to construct an Elasticsearch query object. - * @export - * @interface QueryV2025 - */ -export interface QueryV2025 { - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof QueryV2025 - */ - 'query'?: string; - /** - * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. - * @type {string} - * @memberof QueryV2025 - */ - 'fields'?: string; - /** - * The time zone to be applied to any range query related to dates. - * @type {string} - * @memberof QueryV2025 - */ - 'timeZone'?: string; - /** - * - * @type {InnerHitV2025} - * @memberof QueryV2025 - */ - 'innerHit'?: InnerHitV2025; -} -/** - * Configuration of maximum number of days and interval for checking Service Desk integration queue status. - * @export - * @interface QueuedCheckConfigDetailsV2025 - */ -export interface QueuedCheckConfigDetailsV2025 { - /** - * Interval in minutes between status checks - * @type {string} - * @memberof QueuedCheckConfigDetailsV2025 - */ - 'provisioningStatusCheckIntervalMinutes': string; - /** - * Maximum number of days to check - * @type {string} - * @memberof QueuedCheckConfigDetailsV2025 - */ - 'provisioningMaxStatusCheckDays': string; -} -/** - * - * @export - * @interface RandomAlphaNumericV2025 - */ -export interface RandomAlphaNumericV2025 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomAlphaNumericV2025 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomAlphaNumericV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomAlphaNumericV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RandomNumericV2025 - */ -export interface RandomNumericV2025 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomNumericV2025 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomNumericV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomNumericV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The range of values to be filtered. - * @export - * @interface RangeV2025 - */ -export interface RangeV2025 { - /** - * - * @type {BoundV2025} - * @memberof RangeV2025 - */ - 'lower'?: BoundV2025; - /** - * - * @type {BoundV2025} - * @memberof RangeV2025 - */ - 'upper'?: BoundV2025; -} -/** - * - * @export - * @interface ReassignReferenceV2025 - */ -export interface ReassignReferenceV2025 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2025 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2025 - */ - 'type': ReassignReferenceV2025TypeV2025; -} - -export const ReassignReferenceV2025TypeV2025 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignReferenceV2025TypeV2025 = typeof ReassignReferenceV2025TypeV2025[keyof typeof ReassignReferenceV2025TypeV2025]; - -/** - * - * @export - * @interface ReassignmentReferenceV2025 - */ -export interface ReassignmentReferenceV2025 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2025 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2025 - */ - 'type': ReassignmentReferenceV2025TypeV2025; -} - -export const ReassignmentReferenceV2025TypeV2025 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignmentReferenceV2025TypeV2025 = typeof ReassignmentReferenceV2025TypeV2025[keyof typeof ReassignmentReferenceV2025TypeV2025]; - -/** - * - * @export - * @interface ReassignmentTrailDTOV2025 - */ -export interface ReassignmentTrailDTOV2025 { - /** - * The ID of previous owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2025 - */ - 'previousOwner'?: string; - /** - * The ID of new owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2025 - */ - 'newOwner'?: string; - /** - * The type of reassignment. - * @type {string} - * @memberof ReassignmentTrailDTOV2025 - */ - 'reassignmentType'?: string; -} -/** - * Enum list containing types of Reassignment that can be found in the evaluate response. - * @export - * @enum {string} - */ - -export const ReassignmentTypeEnumV2025 = { - ManualReassignment: 'MANUAL_REASSIGNMENT,', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT,', - AutoEscalation: 'AUTO_ESCALATION,', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeEnumV2025 = typeof ReassignmentTypeEnumV2025[keyof typeof ReassignmentTypeEnumV2025]; - - -/** - * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - * @export - * @enum {string} - */ - -export const ReassignmentTypeV2025 = { - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', - AutoEscalation: 'AUTO_ESCALATION', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeV2025 = typeof ReassignmentTypeV2025[keyof typeof ReassignmentTypeV2025]; - - -/** - * - * @export - * @interface ReassignmentV2025 - */ -export interface ReassignmentV2025 { - /** - * - * @type {CertificationReferenceV2025} - * @memberof ReassignmentV2025 - */ - 'from'?: CertificationReferenceV2025; - /** - * The comment entered when the Certification was reassigned - * @type {string} - * @memberof ReassignmentV2025 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface RecommendationConfigDtoV2025 - */ -export interface RecommendationConfigDtoV2025 { - /** - * List of identity attributes to use for calculating certification recommendations - * @type {Array} - * @memberof RecommendationConfigDtoV2025 - */ - 'recommenderFeatures'?: Array; - /** - * The percent value that the recommendation calculation must surpass to produce a YES recommendation - * @type {number} - * @memberof RecommendationConfigDtoV2025 - */ - 'peerGroupPercentageThreshold'?: number; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2025 - */ - 'runAutoSelectOnce'?: boolean; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2025 - */ - 'onlyTuneThreshold'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestDtoV2025 - */ -export interface RecommendationRequestDtoV2025 { - /** - * - * @type {Array} - * @memberof RecommendationRequestDtoV2025 - */ - 'requests'?: Array; - /** - * Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. - * @type {boolean} - * @memberof RecommendationRequestDtoV2025 - */ - 'excludeInterpretations'?: boolean; - /** - * When set to true, the calling system uses the translated messages for the specified language - * @type {boolean} - * @memberof RecommendationRequestDtoV2025 - */ - 'includeTranslationMessages'?: boolean; - /** - * Returns the recommender calculations if set to true - * @type {boolean} - * @memberof RecommendationRequestDtoV2025 - */ - 'includeDebugInformation'?: boolean; - /** - * When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. - * @type {boolean} - * @memberof RecommendationRequestDtoV2025 - */ - 'prescribeMode'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestV2025 - */ -export interface RecommendationRequestV2025 { - /** - * The identity ID - * @type {string} - * @memberof RecommendationRequestV2025 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemRefV2025} - * @memberof RecommendationRequestV2025 - */ - 'item'?: AccessItemRefV2025; -} -/** - * - * @export - * @interface RecommendationResponseDtoV2025 - */ -export interface RecommendationResponseDtoV2025 { - /** - * - * @type {Array} - * @memberof RecommendationResponseDtoV2025 - */ - 'response'?: Array; -} -/** - * - * @export - * @interface RecommendationResponseV2025 - */ -export interface RecommendationResponseV2025 { - /** - * - * @type {RecommendationRequestV2025} - * @memberof RecommendationResponseV2025 - */ - 'request'?: RecommendationRequestV2025; - /** - * The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system - * @type {string} - * @memberof RecommendationResponseV2025 - */ - 'recommendation'?: RecommendationResponseV2025RecommendationV2025; - /** - * The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. - * @type {Array} - * @memberof RecommendationResponseV2025 - */ - 'interpretations'?: Array; - /** - * The list of translation messages, if they have been requested. - * @type {Array} - * @memberof RecommendationResponseV2025 - */ - 'translationMessages'?: Array; - /** - * - * @type {RecommenderCalculationsV2025} - * @memberof RecommendationResponseV2025 - */ - 'recommenderCalculations'?: RecommenderCalculationsV2025; -} - -export const RecommendationResponseV2025RecommendationV2025 = { - True: 'true', - False: 'false', - Maybe: 'MAYBE', - NotFound: 'NOT_FOUND' -} as const; - -export type RecommendationResponseV2025RecommendationV2025 = typeof RecommendationResponseV2025RecommendationV2025[keyof typeof RecommendationResponseV2025RecommendationV2025]; - -/** - * - * @export - * @interface RecommendationV2025 - */ -export interface RecommendationV2025 { - /** - * Recommended type of account. - * @type {string} - * @memberof RecommendationV2025 - */ - 'type': RecommendationV2025TypeV2025; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof RecommendationV2025 - */ - 'method': RecommendationV2025MethodV2025; -} - -export const RecommendationV2025TypeV2025 = { - Human: 'HUMAN', - Machine: 'MACHINE', - Agent: 'AGENT' -} as const; - -export type RecommendationV2025TypeV2025 = typeof RecommendationV2025TypeV2025[keyof typeof RecommendationV2025TypeV2025]; -export const RecommendationV2025MethodV2025 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type RecommendationV2025MethodV2025 = typeof RecommendationV2025MethodV2025[keyof typeof RecommendationV2025MethodV2025]; - -/** - * - * @export - * @interface RecommenderCalculationsIdentityAttributesValueV2025 - */ -export interface RecommenderCalculationsIdentityAttributesValueV2025 { - /** - * - * @type {string} - * @memberof RecommenderCalculationsIdentityAttributesValueV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RecommenderCalculationsV2025 - */ -export interface RecommenderCalculationsV2025 { - /** - * The ID of the identity - * @type {string} - * @memberof RecommenderCalculationsV2025 - */ - 'identityId'?: string; - /** - * The entitlement ID - * @type {string} - * @memberof RecommenderCalculationsV2025 - */ - 'entitlementId'?: string; - /** - * The actual recommendation - * @type {string} - * @memberof RecommenderCalculationsV2025 - */ - 'recommendation'?: string; - /** - * The overall weighted score - * @type {number} - * @memberof RecommenderCalculationsV2025 - */ - 'overallWeightedScore'?: number; - /** - * The weighted score of each individual feature - * @type {{ [key: string]: number; }} - * @memberof RecommenderCalculationsV2025 - */ - 'featureWeightedScores'?: { [key: string]: number; }; - /** - * The configured value against which the overallWeightedScore is compared - * @type {number} - * @memberof RecommenderCalculationsV2025 - */ - 'threshold'?: number; - /** - * The values for your configured features - * @type {{ [key: string]: RecommenderCalculationsIdentityAttributesValueV2025; }} - * @memberof RecommenderCalculationsV2025 - */ - 'identityAttributes'?: { [key: string]: RecommenderCalculationsIdentityAttributesValueV2025; }; - /** - * - * @type {FeatureValueDtoV2025} - * @memberof RecommenderCalculationsV2025 - */ - 'featureValues'?: FeatureValueDtoV2025; -} -/** - * - * @export - * @interface ReelectRequestV2025 - */ -export interface ReelectRequestV2025 { - /** - * The UUID of the identity proposed to be re-elected as the resource owner. - * @type {string} - * @memberof ReelectRequestV2025 - */ - 'ownerId'?: string; - /** - * The name of the campaign or election process for re-electing the owner. - * @type {string} - * @memberof ReelectRequestV2025 - */ - 'campaignName'?: string | null; - /** - * A list of UUIDs representing the identities of reviewers participating in the re-election process. - * @type {Array} - * @memberof ReelectRequestV2025 - */ - 'reviewers'?: Array | null; -} -/** - * - * @export - * @interface RefV2025 - */ -export interface RefV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof RefV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RefV2025 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface Reference1V2025 - */ -export interface Reference1V2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof Reference1V2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof Reference1V2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface ReferenceV2025 - */ -export interface ReferenceV2025 { - /** - * This ID specifies the name of the pre-existing transform which you want to use within your current transform - * @type {string} - * @memberof ReferenceV2025 - */ - 'id': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReferenceV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReferenceV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RemediationItemDetailsV2025 - */ -export interface RemediationItemDetailsV2025 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemDetailsV2025 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface RemediationItemsV2025 - */ -export interface RemediationItemsV2025 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemsV2025 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface ReplaceAllV2025 - */ -export interface ReplaceAllV2025 { - /** - * An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2025 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceAllV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReplaceStreamConfigurationRequestDeliveryV2025 - */ -export interface ReplaceStreamConfigurationRequestDeliveryV2025 { - /** - * Delivery method (only push is supported). - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2025 - */ - 'method': string; - /** - * Receiver endpoint URL for push delivery. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2025 - */ - 'endpoint_url': string; - /** - * Authorization header value for delivery requests. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2025 - */ - 'authorization_header'?: string; -} -/** - * Request body for PUT /ssf/streams (full replace). - * @export - * @interface ReplaceStreamConfigurationRequestV2025 - */ -export interface ReplaceStreamConfigurationRequestV2025 { - /** - * ID of the stream to replace. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestV2025 - */ - 'stream_id': string; - /** - * - * @type {ReplaceStreamConfigurationRequestDeliveryV2025} - * @memberof ReplaceStreamConfigurationRequestV2025 - */ - 'delivery': ReplaceStreamConfigurationRequestDeliveryV2025; - /** - * Event types the receiver wants. Use CAEP event-type URIs. - * @type {Array} - * @memberof ReplaceStreamConfigurationRequestV2025 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface ReplaceV2025 - */ -export interface ReplaceV2025 { - /** - * This can be a string or a regex pattern in which you want to replace. - * @type {string} - * @memberof ReplaceV2025 - */ - 'regex': string; - /** - * This is the replacement string that should be substituded wherever the string or pattern is found. - * @type {string} - * @memberof ReplaceV2025 - */ - 'replacement': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReportConfigDTOV2025 - */ -export interface ReportConfigDTOV2025 { - /** - * Name of column in report - * @type {string} - * @memberof ReportConfigDTOV2025 - */ - 'columnName'?: string; - /** - * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. - * @type {boolean} - * @memberof ReportConfigDTOV2025 - */ - 'required'?: boolean; - /** - * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. - * @type {boolean} - * @memberof ReportConfigDTOV2025 - */ - 'included'?: boolean; - /** - * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. - * @type {number} - * @memberof ReportConfigDTOV2025 - */ - 'order'?: number; -} -/** - * The string-object map(dictionary) with the arguments needed for report processing. - * @export - * @interface ReportDetailsArgumentsV2025 - */ -export interface ReportDetailsArgumentsV2025 { - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2025 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof ReportDetailsArgumentsV2025 - */ - 'sourceName': string; - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof ReportDetailsArgumentsV2025 - */ - 'correlatedOnly': boolean; - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2025 - */ - 'authoritativeSource': string; - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportDetailsArgumentsV2025 - */ - 'selectedFormats'?: Array; - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof ReportDetailsArgumentsV2025 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof ReportDetailsArgumentsV2025 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof ReportDetailsArgumentsV2025 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof ReportDetailsArgumentsV2025 - */ - 'sort'?: Array; -} - -export const ReportDetailsArgumentsV2025SelectedFormatsV2025 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportDetailsArgumentsV2025SelectedFormatsV2025 = typeof ReportDetailsArgumentsV2025SelectedFormatsV2025[keyof typeof ReportDetailsArgumentsV2025SelectedFormatsV2025]; - -/** - * Details about report to be processed. - * @export - * @interface ReportDetailsV2025 - */ -export interface ReportDetailsV2025 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportDetailsV2025 - */ - 'reportType'?: ReportDetailsV2025ReportTypeV2025; - /** - * - * @type {ReportDetailsArgumentsV2025} - * @memberof ReportDetailsV2025 - */ - 'arguments'?: ReportDetailsArgumentsV2025; -} - -export const ReportDetailsV2025ReportTypeV2025 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportDetailsV2025ReportTypeV2025 = typeof ReportDetailsV2025ReportTypeV2025[keyof typeof ReportDetailsV2025ReportTypeV2025]; - -/** - * - * @export - * @interface ReportResultReferenceV2025 - */ -export interface ReportResultReferenceV2025 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof ReportResultReferenceV2025 - */ - 'type'?: ReportResultReferenceV2025TypeV2025; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof ReportResultReferenceV2025 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof ReportResultReferenceV2025 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof ReportResultReferenceV2025 - */ - 'status'?: ReportResultReferenceV2025StatusV2025; -} - -export const ReportResultReferenceV2025TypeV2025 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type ReportResultReferenceV2025TypeV2025 = typeof ReportResultReferenceV2025TypeV2025[keyof typeof ReportResultReferenceV2025TypeV2025]; -export const ReportResultReferenceV2025StatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type ReportResultReferenceV2025StatusV2025 = typeof ReportResultReferenceV2025StatusV2025[keyof typeof ReportResultReferenceV2025StatusV2025]; - -/** - * Details about report result or current state. - * @export - * @interface ReportResultsV2025 - */ -export interface ReportResultsV2025 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportResultsV2025 - */ - 'reportType'?: ReportResultsV2025ReportTypeV2025; - /** - * Name of the task definition which is started to process requesting report. Usually the same as report name - * @type {string} - * @memberof ReportResultsV2025 - */ - 'taskDefName'?: string; - /** - * Unique task definition identifier. - * @type {string} - * @memberof ReportResultsV2025 - */ - 'id'?: string; - /** - * Report processing start date - * @type {string} - * @memberof ReportResultsV2025 - */ - 'created'?: string; - /** - * Report current state or result status. - * @type {string} - * @memberof ReportResultsV2025 - */ - 'status'?: ReportResultsV2025StatusV2025; - /** - * Report processing time in ms. - * @type {number} - * @memberof ReportResultsV2025 - */ - 'duration'?: number; - /** - * Report size in rows. - * @type {number} - * @memberof ReportResultsV2025 - */ - 'rows'?: number; - /** - * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportResultsV2025 - */ - 'availableFormats'?: Array; -} - -export const ReportResultsV2025ReportTypeV2025 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportResultsV2025ReportTypeV2025 = typeof ReportResultsV2025ReportTypeV2025[keyof typeof ReportResultsV2025ReportTypeV2025]; -export const ReportResultsV2025StatusV2025 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Warning: 'WARNING', - Terminated: 'TERMINATED' -} as const; - -export type ReportResultsV2025StatusV2025 = typeof ReportResultsV2025StatusV2025[keyof typeof ReportResultsV2025StatusV2025]; -export const ReportResultsV2025AvailableFormatsV2025 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportResultsV2025AvailableFormatsV2025 = typeof ReportResultsV2025AvailableFormatsV2025[keyof typeof ReportResultsV2025AvailableFormatsV2025]; - -/** - * type of a Report - * @export - * @enum {string} - */ - -export const ReportTypeV2025 = { - CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', - CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', - CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', - CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' -} as const; - -export type ReportTypeV2025 = typeof ReportTypeV2025[keyof typeof ReportTypeV2025]; - - -/** - * - * @export - * @interface RequestOnBehalfOfConfigV2025 - */ -export interface RequestOnBehalfOfConfigV2025 { - /** - * If this is true, anyone can request access for anyone. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2025 - */ - 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; - /** - * If this is true, a manager can request access for his or her direct reports. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2025 - */ - 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; -} -/** - * - * @export - * @interface RequestabilityForRoleV2025 - */ -export interface RequestabilityForRoleV2025 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2025 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2025 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityForRoleV2025 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityForRoleV2025 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {AccessDurationV2025} - * @memberof RequestabilityForRoleV2025 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2025 | null; - /** - * List describing the steps in approving the request - * @type {Array} - * @memberof RequestabilityForRoleV2025 - */ - 'approvalSchemes'?: Array; - /** - * - * @type {DimensionSchemaV2025} - * @memberof RequestabilityForRoleV2025 - */ - 'dimensionSchema'?: DimensionSchemaV2025; - /** - * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. - * @type {string} - * @memberof RequestabilityForRoleV2025 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface RequestabilityV2025 - */ -export interface RequestabilityV2025 { - /** - * Indicates whether the requester of the containing object must provide comments justifying the request. - * @type {boolean} - * @memberof RequestabilityV2025 - */ - 'commentsRequired'?: boolean | null; - /** - * Indicates whether an approver must provide comments when denying the request. - * @type {boolean} - * @memberof RequestabilityV2025 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityV2025 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityV2025 - */ - 'requireEndDate'?: boolean | null; - /** - * - * @type {AccessDurationV2025} - * @memberof RequestabilityV2025 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2025 | null; - /** - * List describing the steps involved in approving the request. - * @type {Array} - * @memberof RequestabilityV2025 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RequestableObjectReferenceV2025 - */ -export interface RequestableObjectReferenceV2025 { - /** - * Id of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2025 - */ - 'id'?: string; - /** - * Name of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2025 - */ - 'name'?: string; - /** - * Description of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2025 - */ - 'description'?: string; - /** - * Type of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2025 - */ - 'type'?: RequestableObjectReferenceV2025TypeV2025; -} - -export const RequestableObjectReferenceV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectReferenceV2025TypeV2025 = typeof RequestableObjectReferenceV2025TypeV2025[keyof typeof RequestableObjectReferenceV2025TypeV2025]; - -/** - * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - * @export - * @enum {string} - */ - -export const RequestableObjectRequestStatusV2025 = { - Available: 'AVAILABLE', - Pending: 'PENDING', - Assigned: 'ASSIGNED' -} as const; - -export type RequestableObjectRequestStatusV2025 = typeof RequestableObjectRequestStatusV2025[keyof typeof RequestableObjectRequestStatusV2025]; - - -/** - * Currently supported requestable object types. - * @export - * @enum {string} - */ - -export const RequestableObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectTypeV2025 = typeof RequestableObjectTypeV2025[keyof typeof RequestableObjectTypeV2025]; - - -/** - * - * @export - * @interface RequestableObjectV2025 - */ -export interface RequestableObjectV2025 { - /** - * Id of the requestable object itself - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the requestable object - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'name'?: string; - /** - * The time when the requestable object was created - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'created'?: string; - /** - * The time when the requestable object was last modified - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'modified'?: string | null; - /** - * Description of the requestable object. - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'description'?: string | null; - /** - * - * @type {RequestableObjectTypeV2025} - * @memberof RequestableObjectV2025 - */ - 'type'?: RequestableObjectTypeV2025; - /** - * - * @type {RequestableObjectRequestStatusV2025 & object} - * @memberof RequestableObjectV2025 - */ - 'requestStatus'?: RequestableObjectRequestStatusV2025 & object; - /** - * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - * @type {string} - * @memberof RequestableObjectV2025 - */ - 'identityRequestId'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2025} - * @memberof RequestableObjectV2025 - */ - 'ownerRef'?: IdentityReferenceWithNameAndEmailV2025 | null; - /** - * Whether the requester must provide comments when requesting the object. - * @type {boolean} - * @memberof RequestableObjectV2025 - */ - 'requestCommentsRequired'?: boolean; -} - - -/** - * - * @export - * @interface RequestedAccountRefV2025 - */ -export interface RequestedAccountRefV2025 { - /** - * Display name of the account for the user - * @type {string} - * @memberof RequestedAccountRefV2025 - */ - 'name'?: string; - /** - * - * @type {DtoTypeV2025} - * @memberof RequestedAccountRefV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The uuid for the account - * @type {string} - * @memberof RequestedAccountRefV2025 - */ - 'accountUuid'?: string | null; - /** - * The native identity for the account - * @type {string} - * @memberof RequestedAccountRefV2025 - */ - 'accountId'?: string | null; - /** - * Display name of the source for the account - * @type {string} - * @memberof RequestedAccountRefV2025 - */ - 'sourceName'?: string; -} - - -/** - * - * @export - * @interface RequestedForDtoRefV2025 - */ -export interface RequestedForDtoRefV2025 { - /** - * The identity id for which the access is requested - * @type {string} - * @memberof RequestedForDtoRefV2025 - */ - 'identityId': string; - /** - * the details for the access items that are requested for the identity - * @type {Array} - * @memberof RequestedForDtoRefV2025 - */ - 'requestedItems': Array; -} -/** - * - * @export - * @interface RequestedItemAccountSelectionsV2025 - */ -export interface RequestedItemAccountSelectionsV2025 { - /** - * The description for this requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'description'?: string; - /** - * This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. - * @type {boolean} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'accountsSelectionBlocked'?: boolean; - /** - * If account selections are not allowed for an item, this field will denote the reason. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'accountsSelectionBlockedReason'?: string | null; - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'type'?: RequestedItemAccountSelectionsV2025TypeV2025; - /** - * The id of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'id'?: string; - /** - * The name of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'name'?: string; - /** - * The details for the sources and accounts for the requested item and identity combination - * @type {Array} - * @memberof RequestedItemAccountSelectionsV2025 - */ - 'sources'?: Array; -} - -export const RequestedItemAccountSelectionsV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemAccountSelectionsV2025TypeV2025 = typeof RequestedItemAccountSelectionsV2025TypeV2025[keyof typeof RequestedItemAccountSelectionsV2025TypeV2025]; - -/** - * - * @export - * @interface RequestedItemDetailsV2025 - */ -export interface RequestedItemDetailsV2025 { - /** - * The type of access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2025 - */ - 'type'?: RequestedItemDetailsV2025TypeV2025; - /** - * The id of the access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2025 - */ - 'id'?: string; -} - -export const RequestedItemDetailsV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - Role: 'ROLE' -} as const; - -export type RequestedItemDetailsV2025TypeV2025 = typeof RequestedItemDetailsV2025TypeV2025[keyof typeof RequestedItemDetailsV2025TypeV2025]; - -/** - * - * @export - * @interface RequestedItemDtoRefV2025 - */ -export interface RequestedItemDtoRefV2025 { - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2025 - */ - 'type': RequestedItemDtoRefV2025TypeV2025; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2025 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof RequestedItemDtoRefV2025 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof RequestedItemDtoRefV2025 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof RequestedItemDtoRefV2025 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof RequestedItemDtoRefV2025 - */ - 'removeDate'?: string; - /** - * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account - * @type {Array} - * @memberof RequestedItemDtoRefV2025 - */ - 'accountSelection'?: Array | null; -} - -export const RequestedItemDtoRefV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemDtoRefV2025TypeV2025 = typeof RequestedItemDtoRefV2025TypeV2025[keyof typeof RequestedItemDtoRefV2025TypeV2025]; - -/** - * - * @export - * @interface RequestedItemStatusCancelledRequestDetailsV2025 - */ -export interface RequestedItemStatusCancelledRequestDetailsV2025 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2025 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2025} - * @memberof RequestedItemStatusCancelledRequestDetailsV2025 - */ - 'owner'?: OwnerDtoV2025; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2025 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface RequestedItemStatusPreApprovalTriggerDetailsV2025 - */ -export interface RequestedItemStatusPreApprovalTriggerDetailsV2025 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2025 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2025 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2025 - */ - 'decision'?: RequestedItemStatusPreApprovalTriggerDetailsV2025DecisionV2025; -} - -export const RequestedItemStatusPreApprovalTriggerDetailsV2025DecisionV2025 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type RequestedItemStatusPreApprovalTriggerDetailsV2025DecisionV2025 = typeof RequestedItemStatusPreApprovalTriggerDetailsV2025DecisionV2025[keyof typeof RequestedItemStatusPreApprovalTriggerDetailsV2025DecisionV2025]; - -/** - * - * @export - * @interface RequestedItemStatusProvisioningDetailsV2025 - */ -export interface RequestedItemStatusProvisioningDetailsV2025 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof RequestedItemStatusProvisioningDetailsV2025 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. - * @export - * @enum {string} - */ - -export const RequestedItemStatusRequestStateV2025 = { - Executing: 'EXECUTING', - RequestCompleted: 'REQUEST_COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED', - ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', - Rejected: 'REJECTED', - ProvisioningFailed: 'PROVISIONING_FAILED', - NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusRequestStateV2025 = typeof RequestedItemStatusRequestStateV2025[keyof typeof RequestedItemStatusRequestStateV2025]; - - -/** - * Identity access was requested for. - * @export - * @interface RequestedItemStatusRequestedForV2025 - */ -export interface RequestedItemStatusRequestedForV2025 { - /** - * Type of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2025 - */ - 'type'?: RequestedItemStatusRequestedForV2025TypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2025 - */ - 'name'?: string; -} - -export const RequestedItemStatusRequestedForV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type RequestedItemStatusRequestedForV2025TypeV2025 = typeof RequestedItemStatusRequestedForV2025TypeV2025[keyof typeof RequestedItemStatusRequestedForV2025TypeV2025]; - -/** - * - * @export - * @interface RequestedItemStatusRequesterCommentV2025 - */ -export interface RequestedItemStatusRequesterCommentV2025 { - /** - * Comment content. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2025 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2025 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2025} - * @memberof RequestedItemStatusRequesterCommentV2025 - */ - 'author'?: CommentDtoAuthorV2025; -} -/** - * - * @export - * @interface RequestedItemStatusSodViolationContextV2025 - */ -export interface RequestedItemStatusSodViolationContextV2025 { - /** - * The status of SOD violation check - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2025 - */ - 'state'?: RequestedItemStatusSodViolationContextV2025StateV2025 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2025 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2025} - * @memberof RequestedItemStatusSodViolationContextV2025 - */ - 'violationCheckResult'?: SodViolationCheckResultV2025; -} - -export const RequestedItemStatusSodViolationContextV2025StateV2025 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusSodViolationContextV2025StateV2025 = typeof RequestedItemStatusSodViolationContextV2025StateV2025[keyof typeof RequestedItemStatusSodViolationContextV2025StateV2025]; - -/** - * - * @export - * @interface RequestedItemStatusV2025 - */ -export interface RequestedItemStatusV2025 { - /** - * The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'type'?: RequestedItemStatusV2025TypeV2025 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2025} - * @memberof RequestedItemStatusV2025 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2025; - /** - * List of list of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof RequestedItemStatusV2025 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2025} - * @memberof RequestedItemStatusV2025 - */ - 'state'?: RequestedItemStatusRequestStateV2025; - /** - * Approval details for each item. - * @type {Array} - * @memberof RequestedItemStatusV2025 - */ - 'approvalDetails'?: Array; - /** - * List of approval IDs associated with the request. - * @type {Array} - * @memberof RequestedItemStatusV2025 - */ - 'approvalIds'?: Array | null; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof RequestedItemStatusV2025 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2025} - * @memberof RequestedItemStatusV2025 - */ - 'requestType'?: AccessRequestTypeV2025 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2025} - * @memberof RequestedItemStatusV2025 - */ - 'requester'?: AccessItemRequesterV2025; - /** - * - * @type {RequestedItemStatusRequestedForV2025} - * @memberof RequestedItemStatusV2025 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2025; - /** - * - * @type {RequestedItemStatusRequesterCommentV2025} - * @memberof RequestedItemStatusV2025 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2025; - /** - * - * @type {RequestedItemStatusSodViolationContextV2025} - * @memberof RequestedItemStatusV2025 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2025; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2025} - * @memberof RequestedItemStatusV2025 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2025; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2025} - * @memberof RequestedItemStatusV2025 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2025; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof RequestedItemStatusV2025 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof RequestedItemStatusV2025 - */ - 'cancelable'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof RequestedItemStatusV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof RequestedItemStatusV2025 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof RequestedItemStatusV2025 - */ - 'privilegeLevel'?: string | null; -} - -export const RequestedItemStatusV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemStatusV2025TypeV2025 = typeof RequestedItemStatusV2025TypeV2025[keyof typeof RequestedItemStatusV2025TypeV2025]; - -/** - * - * @export - * @interface ResourceModelV2025 - */ -export interface ResourceModelV2025 { - /** - * The unique identifier for the resource. - * @type {number} - * @memberof ResourceModelV2025 - */ - 'id'?: number; - /** - * The display name or label for the resource. - * @type {string} - * @memberof ResourceModelV2025 - */ - 'name'?: string | null; - /** - * The full path to the resource within the system or application. - * @type {string} - * @memberof ResourceModelV2025 - */ - 'fullPath'?: string | null; - /** - * The unique identifier of the application to which this resource belongs. - * @type {number} - * @memberof ResourceModelV2025 - */ - 'applicationId'?: number; - /** - * - * @type {BusinessServiceTypeV2025} - * @memberof ResourceModelV2025 - */ - 'type'?: BusinessServiceTypeV2025; - /** - * A list of UUIDs representing the owners of the resource. - * @type {Array} - * @memberof ResourceModelV2025 - */ - 'owners'?: Array | null; -} - - -/** - * Representation of the object which is returned from source connectors. - * @export - * @interface ResourceObjectV2025 - */ -export interface ResourceObjectV2025 { - /** - * Identifier of the specific instance where this object resides. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'instance'?: string; - /** - * Native identity of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'identity'?: string; - /** - * Universal unique identifier of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'uuid'?: string; - /** - * Native identity that the object has previously. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'previousIdentity'?: string; - /** - * Display name for this object. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof ResourceObjectV2025 - */ - 'objectType'?: string; - /** - * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - * @type {boolean} - * @memberof ResourceObjectV2025 - */ - 'incomplete'?: boolean; - /** - * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - * @type {boolean} - * @memberof ResourceObjectV2025 - */ - 'incremental'?: boolean; - /** - * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - * @type {boolean} - * @memberof ResourceObjectV2025 - */ - 'delete'?: boolean; - /** - * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - * @type {boolean} - * @memberof ResourceObjectV2025 - */ - 'remove'?: boolean; - /** - * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". - * @type {Array} - * @memberof ResourceObjectV2025 - */ - 'missing'?: Array; - /** - * Attributes of this ResourceObject. - * @type {object} - * @memberof ResourceObjectV2025 - */ - 'attributes'?: object; - /** - * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - * @type {boolean} - * @memberof ResourceObjectV2025 - */ - 'finalUpdate'?: boolean; -} -/** - * Request model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsRequestV2025 - */ -export interface ResourceObjectsRequestV2025 { - /** - * The type of resource objects to iterate over. - * @type {string} - * @memberof ResourceObjectsRequestV2025 - */ - 'objectType'?: string; - /** - * The maximum number of resource objects to iterate over and return. - * @type {number} - * @memberof ResourceObjectsRequestV2025 - */ - 'maxCount'?: number; -} -/** - * Response model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsResponseV2025 - */ -export interface ResourceObjectsResponseV2025 { - /** - * ID of the source - * @type {string} - * @memberof ResourceObjectsResponseV2025 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof ResourceObjectsResponseV2025 - */ - 'name'?: string; - /** - * The number of objects that were fetched by the connector. - * @type {number} - * @memberof ResourceObjectsResponseV2025 - */ - 'objectCount'?: number; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof ResourceObjectsResponseV2025 - */ - 'elapsedMillis'?: number; - /** - * Fetched objects from the source connector. - * @type {Array} - * @memberof ResourceObjectsResponseV2025 - */ - 'resourceObjects'?: Array; -} -/** - * - * @export - * @interface ResultV2025 - */ -export interface ResultV2025 { - /** - * Request result status - * @type {string} - * @memberof ResultV2025 - */ - 'status'?: string; -} -/** - * - * @export - * @interface ReviewDecisionV2025 - */ -export interface ReviewDecisionV2025 { - /** - * The id of the review decision - * @type {string} - * @memberof ReviewDecisionV2025 - */ - 'id': string; - /** - * - * @type {CertificationDecisionV2025} - * @memberof ReviewDecisionV2025 - */ - 'decision': CertificationDecisionV2025; - /** - * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. - * @type {string} - * @memberof ReviewDecisionV2025 - */ - 'proposedEndDate'?: string; - /** - * Indicates whether decision should be marked as part of a larger bulk decision - * @type {boolean} - * @memberof ReviewDecisionV2025 - */ - 'bulk': boolean; - /** - * - * @type {ReviewRecommendationV2025} - * @memberof ReviewDecisionV2025 - */ - 'recommendation'?: ReviewRecommendationV2025; - /** - * Comments recorded when the decision was made - * @type {string} - * @memberof ReviewDecisionV2025 - */ - 'comments'?: string; -} - - -/** - * - * @export - * @interface ReviewReassignV2025 - */ -export interface ReviewReassignV2025 { - /** - * - * @type {Array} - * @memberof ReviewReassignV2025 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof ReviewReassignV2025 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof ReviewReassignV2025 - */ - 'reason': string; -} -/** - * - * @export - * @interface ReviewRecommendationV2025 - */ -export interface ReviewRecommendationV2025 { - /** - * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - * @type {string} - * @memberof ReviewRecommendationV2025 - */ - 'recommendation'?: string | null; - /** - * A list of reasons for the recommendation. - * @type {Array} - * @memberof ReviewRecommendationV2025 - */ - 'reasons'?: Array; - /** - * The time at which the recommendation was recorded. - * @type {string} - * @memberof ReviewRecommendationV2025 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface ReviewableAccessProfileV2025 - */ -export interface ReviewableAccessProfileV2025 { - /** - * The id of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableAccessProfileV2025 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableAccessProfileV2025 - */ - 'cloudGoverned'?: boolean; - /** - * The date at which a user\'s access expires - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'endDate'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2025} - * @memberof ReviewableAccessProfileV2025 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2025 | null; - /** - * A list of entitlements associated with this Access Profile - * @type {Array} - * @memberof ReviewableAccessProfileV2025 - */ - 'entitlements'?: Array; - /** - * Date the Access Profile was created. - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof ReviewableAccessProfileV2025 - */ - 'modified'?: string; -} -/** - * Information about the machine account owner - * @export - * @interface ReviewableEntitlementAccountOwnerV2025 - */ -export interface ReviewableEntitlementAccountOwnerV2025 { - /** - * The id associated with the machine account owner - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2025 - */ - 'id'?: string | null; - /** - * An enumeration of the types of Owner supported within the IdentityNow infrastructure. - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2025 - */ - 'type'?: ReviewableEntitlementAccountOwnerV2025TypeV2025; - /** - * The machine account owner\'s display name - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2025 - */ - 'displayName'?: string | null; -} - -export const ReviewableEntitlementAccountOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ReviewableEntitlementAccountOwnerV2025TypeV2025 = typeof ReviewableEntitlementAccountOwnerV2025TypeV2025[keyof typeof ReviewableEntitlementAccountOwnerV2025TypeV2025]; - -/** - * Information about the status of the entitlement - * @export - * @interface ReviewableEntitlementAccountV2025 - */ -export interface ReviewableEntitlementAccountV2025 { - /** - * The native identity for this account - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'nativeIdentity'?: string; - /** - * Indicates whether this account is currently disabled - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'disabled'?: boolean; - /** - * Indicates whether this account is currently locked - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'locked'?: boolean; - /** - * - * @type {DtoTypeV2025} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The id associated with the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'id'?: string | null; - /** - * The account name - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'name'?: string | null; - /** - * When the account was created - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'created'?: string | null; - /** - * When the account was last modified - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityInsightsV2025} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'activityInsights'?: ActivityInsightsV2025; - /** - * Information about the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'description'?: string | null; - /** - * The id associated with the machine Account Governance Group - * @type {string} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'governanceGroupId'?: string | null; - /** - * - * @type {ReviewableEntitlementAccountOwnerV2025} - * @memberof ReviewableEntitlementAccountV2025 - */ - 'owner'?: ReviewableEntitlementAccountOwnerV2025 | null; -} - - -/** - * - * @export - * @interface ReviewableEntitlementV2025 - */ -export interface ReviewableEntitlementV2025 { - /** - * The id for the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'id'?: string; - /** - * The name of the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'name'?: string; - /** - * Information about the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'description'?: string | null; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2025} - * @memberof ReviewableEntitlementV2025 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2025 | null; - /** - * The name of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'attributeName'?: string; - /** - * The value of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'attributeValue'?: string; - /** - * The schema object type on the source used to represent the entitlement and its attributes - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * The name of the source for which this entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'sourceName'?: string; - /** - * The type of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'sourceType'?: string; - /** - * The ID of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2025 - */ - 'sourceId'?: string; - /** - * Indicates if the entitlement has permissions - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'hasPermissions'?: boolean; - /** - * Indicates if the entitlement is a representation of an account permission - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'isPermission'?: boolean; - /** - * Indicates whether the entitlement can be revoked - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'revocable'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement has DAS data - * @type {boolean} - * @memberof ReviewableEntitlementV2025 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {DataAccessV2025} - * @memberof ReviewableEntitlementV2025 - */ - 'dataAccess'?: DataAccessV2025 | null; - /** - * - * @type {ReviewableEntitlementAccountV2025} - * @memberof ReviewableEntitlementV2025 - */ - 'account'?: ReviewableEntitlementAccountV2025 | null; -} -/** - * - * @export - * @interface ReviewableRoleV2025 - */ -export interface ReviewableRoleV2025 { - /** - * The id for the Role - * @type {string} - * @memberof ReviewableRoleV2025 - */ - 'id'?: string; - /** - * The name of the Role - * @type {string} - * @memberof ReviewableRoleV2025 - */ - 'name'?: string; - /** - * Information about the Role - * @type {string} - * @memberof ReviewableRoleV2025 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableRoleV2025 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2025} - * @memberof ReviewableRoleV2025 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2025 | null; - /** - * Indicates whether the Role can be revoked or requested - * @type {boolean} - * @memberof ReviewableRoleV2025 - */ - 'revocable'?: boolean; - /** - * The date when a user\'s access expires. - * @type {string} - * @memberof ReviewableRoleV2025 - */ - 'endDate'?: string; - /** - * The list of Access Profiles associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2025 - */ - 'accessProfiles'?: Array; - /** - * The list of entitlements associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2025 - */ - 'entitlements'?: Array; -} -/** - * - * @export - * @interface ReviewerV2025 - */ -export interface ReviewerV2025 { - /** - * The id of the reviewer. - * @type {string} - * @memberof ReviewerV2025 - */ - 'id'?: string; - /** - * The name of the reviewer. - * @type {string} - * @memberof ReviewerV2025 - */ - 'name'?: string; - /** - * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. - * @type {string} - * @memberof ReviewerV2025 - */ - 'email'?: string | null; - /** - * The type of the reviewing identity. - * @type {string} - * @memberof ReviewerV2025 - */ - 'type'?: ReviewerV2025TypeV2025; - /** - * The created date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2025 - */ - 'created'?: string | null; - /** - * The modified date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2025 - */ - 'modified'?: string | null; -} - -export const ReviewerV2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ReviewerV2025TypeV2025 = typeof ReviewerV2025TypeV2025[keyof typeof ReviewerV2025TypeV2025]; - -/** - * - * @export - * @interface RevocabilityForRoleV2025 - */ -export interface RevocabilityForRoleV2025 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2025 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2025 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * List describing the steps in approving the revocation request - * @type {Array} - * @memberof RevocabilityForRoleV2025 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface RevocabilityV2025 - */ -export interface RevocabilityV2025 { - /** - * List describing the steps involved in approving the revocation request. - * @type {Array} - * @memberof RevocabilityV2025 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RightPadV2025 - */ -export interface RightPadV2025 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof RightPadV2025 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof RightPadV2025 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RightPadV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RightPadV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs. - * @export - * @interface RightSetDTOV2025 - */ -export interface RightSetDTOV2025 { - /** - * The unique identifier of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'id'?: string; - /** - * The human-readable name of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'name'?: string; - /** - * A human-readable description of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'description'?: string; - /** - * The category of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'category'?: string; - /** - * Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. - * @type {Array} - * @memberof RightSetDTOV2025 - */ - 'rights'?: Array; - /** - * List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. - * @type {Array} - * @memberof RightSetDTOV2025 - */ - 'rightSetIds'?: Array; - /** - * List of unique identifiers for UI-assignable child RightSets, used to build UI components. - * @type {Array} - * @memberof RightSetDTOV2025 - */ - 'uiAssignableChildRightSetIds'?: Array; - /** - * Indicates whether the RightSet is UI-assignable. - * @type {boolean} - * @memberof RightSetDTOV2025 - */ - 'uiAssignable'?: boolean; - /** - * The translated name of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'translatedName'?: string; - /** - * The translated description of the RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'translatedDescription'?: string | null; - /** - * The unique identifier of the parent RightSet for UI Assignable RightSet. - * @type {string} - * @memberof RightSetDTOV2025 - */ - 'parentId'?: string | null; -} -/** - * The identity that performed the assignment. This could be blank or system - * @export - * @interface RoleAssignmentDtoAssignerV2025 - */ -export interface RoleAssignmentDtoAssignerV2025 { - /** - * Object type - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2025 - */ - 'type'?: RoleAssignmentDtoAssignerV2025TypeV2025; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2025 - */ - 'name'?: string | null; -} - -export const RoleAssignmentDtoAssignerV2025TypeV2025 = { - Identity: 'IDENTITY', - Unknown: 'UNKNOWN' -} as const; - -export type RoleAssignmentDtoAssignerV2025TypeV2025 = typeof RoleAssignmentDtoAssignerV2025TypeV2025[keyof typeof RoleAssignmentDtoAssignerV2025TypeV2025]; - -/** - * - * @export - * @interface RoleAssignmentDtoAssignmentContextV2025 - */ -export interface RoleAssignmentDtoAssignmentContextV2025 { - /** - * - * @type {AccessRequestContextV2025} - * @memberof RoleAssignmentDtoAssignmentContextV2025 - */ - 'requested'?: AccessRequestContextV2025; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoAssignmentContextV2025 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof RoleAssignmentDtoAssignmentContextV2025 - */ - 'computedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentDtoV2025 - */ -export interface RoleAssignmentDtoV2025 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof RoleAssignmentDtoV2025 - */ - 'role'?: BaseReferenceDtoV2025; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2025} - * @memberof RoleAssignmentDtoV2025 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2025; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof RoleAssignmentDtoV2025 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2025} - * @memberof RoleAssignmentDtoV2025 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2025; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoV2025 - */ - 'accountTargets'?: Array; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'removeDate'?: string | null; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentDtoV2025 - */ - 'addedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentRefV2025 - */ -export interface RoleAssignmentRefV2025 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentRefV2025 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof RoleAssignmentRefV2025 - */ - 'role'?: BaseReferenceDtoV2025; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentRefV2025 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentRefV2025 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentRefV2025 - */ - 'removeDate'?: string | null; -} -/** - * Type which indicates how a particular Identity obtained a particular Role - * @export - * @enum {string} - */ - -export const RoleAssignmentSourceTypeV2025 = { - AccessRequest: 'ACCESS_REQUEST', - RoleMembership: 'ROLE_MEMBERSHIP' -} as const; - -export type RoleAssignmentSourceTypeV2025 = typeof RoleAssignmentSourceTypeV2025[keyof typeof RoleAssignmentSourceTypeV2025]; - - -/** - * - * @export - * @interface RoleBulkDeleteRequestV2025 - */ -export interface RoleBulkDeleteRequestV2025 { - /** - * List of IDs of Roles to be deleted. - * @type {Array} - * @memberof RoleBulkDeleteRequestV2025 - */ - 'roleIds': Array; -} -/** - * - * @export - * @interface RoleBulkUpdateResponseV2025 - */ -export interface RoleBulkUpdateResponseV2025 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleBulkUpdateResponseV2025 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleBulkUpdateResponseV2025 - */ - 'type'?: string; - /** - * The status of the bulk update request, could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleBulkUpdateResponseV2025 - */ - 'status'?: RoleBulkUpdateResponseV2025StatusV2025; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleBulkUpdateResponseV2025 - */ - 'created'?: string; -} - -export const RoleBulkUpdateResponseV2025StatusV2025 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PreProcessCompleted: 'PRE_PROCESS_COMPLETED', - PostProcess: 'POST_PROCESS', - Completed: 'COMPLETED', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleBulkUpdateResponseV2025StatusV2025 = typeof RoleBulkUpdateResponseV2025StatusV2025[keyof typeof RoleBulkUpdateResponseV2025StatusV2025]; - -/** - * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - * @export - * @enum {string} - */ - -export const RoleCriteriaKeyTypeV2025 = { - Identity: 'IDENTITY', - Account: 'ACCOUNT', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RoleCriteriaKeyTypeV2025 = typeof RoleCriteriaKeyTypeV2025[keyof typeof RoleCriteriaKeyTypeV2025]; - - -/** - * Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - * @export - * @interface RoleCriteriaKeyV2025 - */ -export interface RoleCriteriaKeyV2025 { - /** - * - * @type {RoleCriteriaKeyTypeV2025} - * @memberof RoleCriteriaKeyV2025 - */ - 'type': RoleCriteriaKeyTypeV2025; - /** - * The name of the attribute or entitlement to which the associated criteria applies. - * @type {string} - * @memberof RoleCriteriaKeyV2025 - */ - 'property': string; - /** - * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - * @type {string} - * @memberof RoleCriteriaKeyV2025 - */ - 'sourceId'?: string | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel1V2025 - */ -export interface RoleCriteriaLevel1V2025 { - /** - * - * @type {RoleCriteriaOperationV2025} - * @memberof RoleCriteriaLevel1V2025 - */ - 'operation'?: RoleCriteriaOperationV2025; - /** - * - * @type {RoleCriteriaKeyV2025} - * @memberof RoleCriteriaLevel1V2025 - */ - 'key'?: RoleCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel1V2025 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel1V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel2V2025 - */ -export interface RoleCriteriaLevel2V2025 { - /** - * - * @type {RoleCriteriaOperationV2025} - * @memberof RoleCriteriaLevel2V2025 - */ - 'operation'?: RoleCriteriaOperationV2025; - /** - * - * @type {RoleCriteriaKeyV2025} - * @memberof RoleCriteriaLevel2V2025 - */ - 'key'?: RoleCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel2V2025 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel2V2025 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel3V2025 - */ -export interface RoleCriteriaLevel3V2025 { - /** - * - * @type {RoleCriteriaOperationV2025} - * @memberof RoleCriteriaLevel3V2025 - */ - 'operation'?: RoleCriteriaOperationV2025; - /** - * - * @type {RoleCriteriaKeyV2025} - * @memberof RoleCriteriaLevel3V2025 - */ - 'key'?: RoleCriteriaKeyV2025 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel3V2025 - */ - 'stringValue'?: string | null; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const RoleCriteriaOperationV2025 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - GreaterThan: 'GREATER_THAN', - LessThan: 'LESS_THAN', - GreaterThanEquals: 'GREATER_THAN_EQUALS', - LessThanEquals: 'LESS_THAN_EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type RoleCriteriaOperationV2025 = typeof RoleCriteriaOperationV2025[keyof typeof RoleCriteriaOperationV2025]; - - -/** - * - * @export - * @interface RoleDocumentAllOfDimensionSchemaAttributesV2025 - */ -export interface RoleDocumentAllOfDimensionSchemaAttributesV2025 { - /** - * - * @type {boolean} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2025 - */ - 'derived'?: boolean; - /** - * Displayname of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2025 - */ - 'displayName'?: string; - /** - * Name of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfDimensionsV2025 - */ -export interface RoleDocumentAllOfDimensionsV2025 { - /** - * Unique ID of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2025 - */ - 'id'?: string; - /** - * Name of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2025 - */ - 'name'?: string; - /** - * Description of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2025 - */ - 'description'?: string | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2025 - */ - 'entitlements'?: Array | null; - /** - * Access profiles included in the dimension. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2025 - */ - 'accessProfiles'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlements1V2025 - */ -export interface RoleDocumentAllOfEntitlements1V2025 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2025 - */ - 'hash'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlementsV2025 - */ -export interface RoleDocumentAllOfEntitlementsV2025 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2025 - */ - 'hash'?: string; -} -/** - * Role - * @export - * @interface RoleDocumentV2025 - */ -export interface RoleDocumentV2025 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentV2025 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2025} - * @memberof RoleDocumentV2025 - */ - 'owner'?: BaseAccessOwnerV2025; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentV2025 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentV2025 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentV2025 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentV2025 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentV2025 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentV2025 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentV2025 - */ - 'dimensions'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentsV2025 - */ -export interface RoleDocumentsV2025 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentsV2025 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentsV2025 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentsV2025 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2025} - * @memberof RoleDocumentsV2025 - */ - 'owner'?: BaseAccessOwnerV2025; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentsV2025 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentsV2025 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentsV2025 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentsV2025 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentsV2025 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentsV2025 - */ - 'dimensions'?: Array | null; - /** - * Name of the pod. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2025} - * @memberof RoleDocumentsV2025 - */ - '_type'?: DocumentTypeV2025; - /** - * - * @type {DocumentTypeV2025} - * @memberof RoleDocumentsV2025 - */ - 'type'?: DocumentTypeV2025; - /** - * Version number. - * @type {string} - * @memberof RoleDocumentsV2025 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface RoleGetAllBulkUpdateResponseV2025 - */ -export interface RoleGetAllBulkUpdateResponseV2025 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2025 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2025 - */ - 'type'?: string; - /** - * The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2025 - */ - 'status'?: RoleGetAllBulkUpdateResponseV2025StatusV2025; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2025 - */ - 'created'?: string; -} - -export const RoleGetAllBulkUpdateResponseV2025StatusV2025 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PostProcess: 'POST_PROCESS', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleGetAllBulkUpdateResponseV2025StatusV2025 = typeof RoleGetAllBulkUpdateResponseV2025StatusV2025[keyof typeof RoleGetAllBulkUpdateResponseV2025StatusV2025]; - -/** - * A subset of the fields of an Identity which is a member of a Role. - * @export - * @interface RoleIdentityV2025 - */ -export interface RoleIdentityV2025 { - /** - * The ID of the Identity - * @type {string} - * @memberof RoleIdentityV2025 - */ - 'id'?: string; - /** - * The alias / username of the Identity - * @type {string} - * @memberof RoleIdentityV2025 - */ - 'aliasName'?: string; - /** - * The human-readable display name of the Identity - * @type {string} - * @memberof RoleIdentityV2025 - */ - 'name'?: string; - /** - * Email address of the Identity - * @type {string} - * @memberof RoleIdentityV2025 - */ - 'email'?: string; - /** - * - * @type {RoleAssignmentSourceTypeV2025} - * @memberof RoleIdentityV2025 - */ - 'roleAssignmentSource'?: RoleAssignmentSourceTypeV2025; -} - - -/** - * - * @export - * @interface RoleInsightV2025 - */ -export interface RoleInsightV2025 { - /** - * Insight id - * @type {string} - * @memberof RoleInsightV2025 - */ - 'id'?: string; - /** - * Total number of updates for this role - * @type {number} - * @memberof RoleInsightV2025 - */ - 'numberOfUpdates'?: number; - /** - * The date-time insights were last created for this role. - * @type {string} - * @memberof RoleInsightV2025 - */ - 'createdDate'?: string; - /** - * The date-time insights were last modified for this role. - * @type {string} - * @memberof RoleInsightV2025 - */ - 'modifiedDate'?: string | null; - /** - * - * @type {RoleInsightsRoleV2025} - * @memberof RoleInsightV2025 - */ - 'role'?: RoleInsightsRoleV2025; - /** - * - * @type {RoleInsightsInsightV2025} - * @memberof RoleInsightV2025 - */ - 'insight'?: RoleInsightsInsightV2025; -} -/** - * - * @export - * @interface RoleInsightsEntitlementChangesV2025 - */ -export interface RoleInsightsEntitlementChangesV2025 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'description'?: string | null; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'value'?: string; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'source'?: string; - /** - * - * @type {RoleInsightsInsightV2025} - * @memberof RoleInsightsEntitlementChangesV2025 - */ - 'insight'?: RoleInsightsInsightV2025; -} -/** - * - * @export - * @interface RoleInsightsEntitlementV2025 - */ -export interface RoleInsightsEntitlementV2025 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'description'?: string | null; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'source'?: string; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RoleInsightsIdentitiesV2025 - */ -export interface RoleInsightsIdentitiesV2025 { - /** - * Id for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2025 - */ - 'id'?: string; - /** - * Name for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2025 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string; }} - * @memberof RoleInsightsIdentitiesV2025 - */ - 'attributes'?: { [key: string]: string; }; -} -/** - * - * @export - * @interface RoleInsightsInsightV2025 - */ -export interface RoleInsightsInsightV2025 { - /** - * The number of identities in this role with the entitlement. - * @type {string} - * @memberof RoleInsightsInsightV2025 - */ - 'type'?: string; - /** - * The number of identities in this role with the entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2025 - */ - 'identitiesWithAccess'?: number; - /** - * The number of identities in this role that do not have the specified entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2025 - */ - 'identitiesImpacted'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsInsightV2025 - */ - 'totalNumberOfIdentities'?: number; - /** - * - * @type {string} - * @memberof RoleInsightsInsightV2025 - */ - 'impactedIdentityNames'?: string | null; -} -/** - * - * @export - * @interface RoleInsightsResponseV2025 - */ -export interface RoleInsightsResponseV2025 { - /** - * Request Id for a role insight generation request - * @type {string} - * @memberof RoleInsightsResponseV2025 - */ - 'id'?: string; - /** - * The date-time role insights request was created. - * @type {string} - * @memberof RoleInsightsResponseV2025 - */ - 'createdDate'?: string; - /** - * The date-time role insights request was completed. - * @type {string} - * @memberof RoleInsightsResponseV2025 - */ - 'lastGenerated'?: string; - /** - * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. - * @type {number} - * @memberof RoleInsightsResponseV2025 - */ - 'numberOfUpdates'?: number; - /** - * The role IDs that are in this request. - * @type {Array} - * @memberof RoleInsightsResponseV2025 - */ - 'roleIds'?: Array; - /** - * Request status - * @type {string} - * @memberof RoleInsightsResponseV2025 - */ - 'status'?: RoleInsightsResponseV2025StatusV2025; -} - -export const RoleInsightsResponseV2025StatusV2025 = { - Created: 'CREATED', - InProgress: 'IN PROGRESS', - Completed: 'COMPLETED', - Failed: 'FAILED' -} as const; - -export type RoleInsightsResponseV2025StatusV2025 = typeof RoleInsightsResponseV2025StatusV2025[keyof typeof RoleInsightsResponseV2025StatusV2025]; - -/** - * - * @export - * @interface RoleInsightsRoleV2025 - */ -export interface RoleInsightsRoleV2025 { - /** - * Role name - * @type {string} - * @memberof RoleInsightsRoleV2025 - */ - 'name'?: string; - /** - * Role id - * @type {string} - * @memberof RoleInsightsRoleV2025 - */ - 'id'?: string; - /** - * Role description - * @type {string} - * @memberof RoleInsightsRoleV2025 - */ - 'description'?: string; - /** - * Role owner name - * @type {string} - * @memberof RoleInsightsRoleV2025 - */ - 'ownerName'?: string; - /** - * Role owner id - * @type {string} - * @memberof RoleInsightsRoleV2025 - */ - 'ownerId'?: string; -} -/** - * - * @export - * @interface RoleInsightsSummaryV2025 - */ -export interface RoleInsightsSummaryV2025 { - /** - * Total number of roles with updates - * @type {number} - * @memberof RoleInsightsSummaryV2025 - */ - 'numberOfUpdates'?: number; - /** - * The date-time role insights were last found. - * @type {string} - * @memberof RoleInsightsSummaryV2025 - */ - 'lastGenerated'?: string; - /** - * The number of entitlements included in roles (vs free radicals). - * @type {number} - * @memberof RoleInsightsSummaryV2025 - */ - 'entitlementsIncludedInRoles'?: number; - /** - * The total number of entitlements. - * @type {number} - * @memberof RoleInsightsSummaryV2025 - */ - 'totalNumberOfEntitlements'?: number; - /** - * The number of identities in roles vs. identities with just entitlements and not in roles. - * @type {number} - * @memberof RoleInsightsSummaryV2025 - */ - 'identitiesWithAccessViaRoles'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsSummaryV2025 - */ - 'totalNumberOfIdentities'?: number; -} -/** - * - * @export - * @interface RoleListFilterDTOAmmKeyValuesInnerV2025 - */ -export interface RoleListFilterDTOAmmKeyValuesInnerV2025 { - /** - * attribute key of a metadata. - * @type {string} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2025 - */ - 'attribute'?: string; - /** - * A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. - * @type {Array} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2025 - */ - 'values'?: Array; -} -/** - * AMMFilterValues - * @export - * @interface RoleListFilterDTOV2025 - */ -export interface RoleListFilterDTOV2025 { - /** - * 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* - * @type {string} - * @memberof RoleListFilterDTOV2025 - */ - 'filters'?: string | null; - /** - * - * @type {Array} - * @memberof RoleListFilterDTOV2025 - */ - 'ammKeyValues'?: Array | null; -} -/** - * - * @export - * @interface RoleMatchDtoV2025 - */ -export interface RoleMatchDtoV2025 { - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof RoleMatchDtoV2025 - */ - 'roleRef'?: BaseReferenceDtoV2025; - /** - * - * @type {Array} - * @memberof RoleMatchDtoV2025 - */ - 'matchedAttributes'?: Array; -} -/** - * A reference to an Identity in an IDENTITY_LIST role membership criteria. - * @export - * @interface RoleMembershipIdentityV2025 - */ -export interface RoleMembershipIdentityV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof RoleMembershipIdentityV2025 - */ - 'type'?: DtoTypeV2025; - /** - * Identity id - * @type {string} - * @memberof RoleMembershipIdentityV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the Identity. - * @type {string} - * @memberof RoleMembershipIdentityV2025 - */ - 'name'?: string | null; - /** - * User name of the Identity - * @type {string} - * @memberof RoleMembershipIdentityV2025 - */ - 'aliasName'?: string | null; -} - - -/** - * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - * @export - * @enum {string} - */ - -export const RoleMembershipSelectorTypeV2025 = { - Standard: 'STANDARD', - IdentityList: 'IDENTITY_LIST' -} as const; - -export type RoleMembershipSelectorTypeV2025 = typeof RoleMembershipSelectorTypeV2025[keyof typeof RoleMembershipSelectorTypeV2025]; - - -/** - * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - * @export - * @interface RoleMembershipSelectorV2025 - */ -export interface RoleMembershipSelectorV2025 { - /** - * - * @type {RoleMembershipSelectorTypeV2025} - * @memberof RoleMembershipSelectorV2025 - */ - 'type'?: RoleMembershipSelectorTypeV2025; - /** - * - * @type {RoleCriteriaLevel1V2025} - * @memberof RoleMembershipSelectorV2025 - */ - 'criteria'?: RoleCriteriaLevel1V2025 | null; - /** - * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - * @type {Array} - * @memberof RoleMembershipSelectorV2025 - */ - 'identities'?: Array | null; -} - - -/** - * This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestV2025 - */ -export interface RoleMetadataBulkUpdateByFilterRequestV2025 { - /** - * Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2025 - */ - 'filters': string; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2025 - */ - 'operation': RoleMetadataBulkUpdateByFilterRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2025 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByFilterRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2025 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByFilterRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2025OperationV2025 = typeof RoleMetadataBulkUpdateByFilterRequestV2025OperationV2025[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2025OperationV2025]; -export const RoleMetadataBulkUpdateByFilterRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2025ReplaceScopeV2025 = typeof RoleMetadataBulkUpdateByFilterRequestV2025ReplaceScopeV2025[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2025ReplaceScopeV2025]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2025 - */ -export interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2025 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2025 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2025 - */ - 'values': Array | null; -} -/** - * This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByIdRequestV2025 - */ -export interface RoleMetadataBulkUpdateByIdRequestV2025 { - /** - * Roles\' Id to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2025 - */ - 'roles': Array; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2025 - */ - 'operation': RoleMetadataBulkUpdateByIdRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2025 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByIdRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2025 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByIdRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2025OperationV2025 = typeof RoleMetadataBulkUpdateByIdRequestV2025OperationV2025[keyof typeof RoleMetadataBulkUpdateByIdRequestV2025OperationV2025]; -export const RoleMetadataBulkUpdateByIdRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2025ReplaceScopeV2025 = typeof RoleMetadataBulkUpdateByIdRequestV2025ReplaceScopeV2025[keyof typeof RoleMetadataBulkUpdateByIdRequestV2025ReplaceScopeV2025]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2025 - */ -export interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2025 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2025 - */ - 'attribute': string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2025 - */ - 'values': Array | null; -} -/** - * Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestV2025 - */ -export interface RoleMetadataBulkUpdateByQueryRequestV2025 { - /** - * query the identities to be updated - * @type {object} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2025 - */ - 'query': object; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2025 - */ - 'operation': RoleMetadataBulkUpdateByQueryRequestV2025OperationV2025; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2025 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByQueryRequestV2025ReplaceScopeV2025; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2025 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByQueryRequestV2025OperationV2025 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2025OperationV2025 = typeof RoleMetadataBulkUpdateByQueryRequestV2025OperationV2025[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2025OperationV2025]; -export const RoleMetadataBulkUpdateByQueryRequestV2025ReplaceScopeV2025 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2025ReplaceScopeV2025 = typeof RoleMetadataBulkUpdateByQueryRequestV2025ReplaceScopeV2025[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2025ReplaceScopeV2025]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2025 - */ -export interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2025 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2025 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2025 - */ - 'attributeValue'?: Array; -} -/** - * - * @export - * @interface RoleMiningEntitlementRefV2025 - */ -export interface RoleMiningEntitlementRefV2025 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2025 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2025 - */ - 'name'?: string; - /** - * Description forthe entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2025 - */ - 'description'?: string | null; - /** - * The entitlement attribute - * @type {string} - * @memberof RoleMiningEntitlementRefV2025 - */ - 'attribute'?: string; -} -/** - * - * @export - * @interface RoleMiningEntitlementV2025 - */ -export interface RoleMiningEntitlementV2025 { - /** - * - * @type {RoleMiningEntitlementRefV2025} - * @memberof RoleMiningEntitlementV2025 - */ - 'entitlementRef'?: RoleMiningEntitlementRefV2025; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2025 - */ - 'name'?: string; - /** - * Application name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2025 - */ - 'applicationName'?: string; - /** - * The number of identities with this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2025 - */ - 'identityCount'?: number; - /** - * The % popularity of this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2025 - */ - 'popularity'?: number; - /** - * The % popularity of this entitlement in the org. - * @type {number} - * @memberof RoleMiningEntitlementV2025 - */ - 'popularityInOrg'?: number; - /** - * The ID of the source/application. - * @type {string} - * @memberof RoleMiningEntitlementV2025 - */ - 'sourceId'?: string; - /** - * The status of activity data for the source. Value is complete or notComplete. - * @type {string} - * @memberof RoleMiningEntitlementV2025 - */ - 'activitySourceState'?: string | null; - /** - * The percentage of identities in the potential role that have usage of the source/application of this entitlement. - * @type {number} - * @memberof RoleMiningEntitlementV2025 - */ - 'sourceUsagePercent'?: number | null; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionDistributionInnerV2025 - */ -export interface RoleMiningIdentityDistributionDistributionInnerV2025 { - /** - * The attribute value that identities are grouped by - * @type {string} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2025 - */ - 'attributeValue'?: string | null; - /** - * The number of identities that have this attribute value - * @type {number} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionV2025 - */ -export interface RoleMiningIdentityDistributionV2025 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningIdentityDistributionV2025 - */ - 'attributeName'?: string; - /** - * - * @type {Array} - * @memberof RoleMiningIdentityDistributionV2025 - */ - 'distribution'?: Array; -} -/** - * - * @export - * @interface RoleMiningIdentityV2025 - */ -export interface RoleMiningIdentityV2025 { - /** - * Id of the identity - * @type {string} - * @memberof RoleMiningIdentityV2025 - */ - 'id'?: string; - /** - * Name of the identity - * @type {string} - * @memberof RoleMiningIdentityV2025 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string | null; }} - * @memberof RoleMiningIdentityV2025 - */ - 'attributes'?: { [key: string]: string | null; }; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleApplicationV2025 - */ -export interface RoleMiningPotentialRoleApplicationV2025 { - /** - * Id of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2025 - */ - 'id'?: string; - /** - * Name of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEditEntitlementsV2025 - */ -export interface RoleMiningPotentialRoleEditEntitlementsV2025 { - /** - * The list of entitlement ids to be edited - * @type {Array} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2025 - */ - 'ids'?: Array; - /** - * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. - * @type {boolean} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2025 - */ - 'exclude'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEntitlementsV2025 - */ -export interface RoleMiningPotentialRoleEntitlementsV2025 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2025 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportRequestV2025 - */ -export interface RoleMiningPotentialRoleExportRequestV2025 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportRequestV2025 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportRequestV2025 - */ - 'includeCommonAccess'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportResponseV2025 - */ -export interface RoleMiningPotentialRoleExportResponseV2025 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportResponseV2025 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportResponseV2025 - */ - 'includeCommonAccess'?: boolean; - /** - * ID used to reference this export - * @type {string} - * @memberof RoleMiningPotentialRoleExportResponseV2025 - */ - 'exportId'?: string; - /** - * - * @type {RoleMiningPotentialRoleExportStateV2025} - * @memberof RoleMiningPotentialRoleExportResponseV2025 - */ - 'status'?: RoleMiningPotentialRoleExportStateV2025; -} - - -/** - * - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleExportStateV2025 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RoleMiningPotentialRoleExportStateV2025 = typeof RoleMiningPotentialRoleExportStateV2025[keyof typeof RoleMiningPotentialRoleExportStateV2025]; - - -/** - * The potential role reference - * @export - * @interface RoleMiningPotentialRolePotentialRoleRefV2025 - */ -export interface RoleMiningPotentialRolePotentialRoleRefV2025 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2025 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleProvisionRequestV2025 - */ -export interface RoleMiningPotentialRoleProvisionRequestV2025 { - /** - * Name of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2025 - */ - 'roleName'?: string; - /** - * Short description of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2025 - */ - 'roleDescription'?: string; - /** - * ID of the identity that will own this role - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2025 - */ - 'ownerId'?: string; - /** - * When true, create access requests for the identities associated with the potential role - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2025 - */ - 'includeIdentities'?: boolean; - /** - * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2025 - */ - 'directlyAssignedEntitlements'?: boolean; -} -/** - * Provision state - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleProvisionStateV2025 = { - Potential: 'POTENTIAL', - Pending: 'PENDING', - Complete: 'COMPLETE', - Failed: 'FAILED' -} as const; - -export type RoleMiningPotentialRoleProvisionStateV2025 = typeof RoleMiningPotentialRoleProvisionStateV2025[keyof typeof RoleMiningPotentialRoleProvisionStateV2025]; - - -/** - * - * @export - * @interface RoleMiningPotentialRoleRefV2025 - */ -export interface RoleMiningPotentialRoleRefV2025 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2025 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleSourceUsageV2025 - */ -export interface RoleMiningPotentialRoleSourceUsageV2025 { - /** - * The identity ID - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2025 - */ - 'id'?: string; - /** - * Display name for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2025 - */ - 'displayName'?: string; - /** - * Email address for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2025 - */ - 'email'?: string; - /** - * The number of days there has been usage of the source by the identity. - * @type {number} - * @memberof RoleMiningPotentialRoleSourceUsageV2025 - */ - 'usageCount'?: number; -} -/** - * @type RoleMiningPotentialRoleSummaryCreatedByV2025 - * The potential role created by details - * @export - */ -export type RoleMiningPotentialRoleSummaryCreatedByV2025 = EntityCreatedByDTOV2025 | string; - -/** - * - * @export - * @interface RoleMiningPotentialRoleSummaryV2025 - */ -export interface RoleMiningPotentialRoleSummaryV2025 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRoleRefV2025} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'potentialRoleRef'?: RoleMiningPotentialRoleRefV2025; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'identityCount'?: number; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'entitlementCount'?: number; - /** - * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'identityGroupStatus'?: string; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2025} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2025; - /** - * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'roleId'?: string | null; - /** - * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'density'?: number; - /** - * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'freshness'?: number; - /** - * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'quality'?: number; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; - /** - * - * @type {RoleMiningPotentialRoleSummaryCreatedByV2025} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'createdBy'?: RoleMiningPotentialRoleSummaryCreatedByV2025; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'createdDate'?: string; - /** - * The potential role\'s saved status - * @type {boolean} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'saved'?: boolean; - /** - * Description of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'description'?: string | null; - /** - * - * @type {RoleMiningSessionParametersDtoV2025} - * @memberof RoleMiningPotentialRoleSummaryV2025 - */ - 'session'?: RoleMiningSessionParametersDtoV2025; -} - - -/** - * - * @export - * @interface RoleMiningPotentialRoleV2025 - */ -export interface RoleMiningPotentialRoleV2025 { - /** - * - * @type {RoleMiningSessionResponseCreatedByV2025} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2025; - /** - * The density of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'density'?: number; - /** - * The description of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'description'?: string | null; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'entitlementCount'?: number; - /** - * The list of entitlement ids to be excluded. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'excludedEntitlements'?: Array | null; - /** - * The freshness of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'freshness'?: number; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'identityCount'?: number; - /** - * Identity attribute distribution. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'identityDistribution'?: Array | null; - /** - * The list of ids in a potential role. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'identityIds'?: Array; - /** - * The status for this identity group which can be OBTAINED or COMPRESSED - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'identityGroupStatus'?: string | null; - /** - * Name of the potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRolePotentialRoleRefV2025} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefV2025 | null; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2025 & object} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2025 & object; - /** - * The quality of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'quality'?: number; - /** - * The roleId of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'roleId'?: string | null; - /** - * The potential role\'s saved status. - * @type {boolean} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionParametersDtoV2025} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'session'?: RoleMiningSessionParametersDtoV2025; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'id'?: string; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'createdDate'?: string; - /** - * The date-time when this potential role was modified. - * @type {string} - * @memberof RoleMiningPotentialRoleV2025 - */ - 'modifiedDate'?: string; -} - - -/** - * Role type - * @export - * @enum {string} - */ - -export const RoleMiningRoleTypeV2025 = { - Specialized: 'SPECIALIZED', - Common: 'COMMON' -} as const; - -export type RoleMiningRoleTypeV2025 = typeof RoleMiningRoleTypeV2025[keyof typeof RoleMiningRoleTypeV2025]; - - -/** - * - * @export - * @interface RoleMiningSessionDraftRoleDtoV2025 - */ -export interface RoleMiningSessionDraftRoleDtoV2025 { - /** - * Name of the draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'name'?: string; - /** - * Draft role description - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'description'?: string; - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'identityIds'?: Array; - /** - * The list of entitlement ids for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'entitlementIds'?: Array; - /** - * The list of excluded entitlement ids. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'excludedEntitlements'?: Array; - /** - * Last modified date - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'modified'?: string; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; - /** - * Id of the potential draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'id'?: string; - /** - * The date-time when this potential draft role was created. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'createdDate'?: string; - /** - * The date-time when this potential draft role was modified. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2025 - */ - 'modifiedDate'?: string; -} - - -/** - * - * @export - * @interface RoleMiningSessionDtoV2025 - */ -export interface RoleMiningSessionDtoV2025 { - /** - * - * @type {RoleMiningSessionScopeV2025} - * @memberof RoleMiningSessionDtoV2025 - */ - 'scope'?: RoleMiningSessionScopeV2025; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'pruneThreshold'?: number | null; - /** - * The calculated prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * Number of potential roles - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'potentialRoleCount'?: number; - /** - * Number of potential roles ready - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningSessionDtoV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionDtoV2025 - */ - 'emailRecipientId'?: string | null; - /** - * Number of identities in the population which meet the search criteria or identity list provided - * @type {number} - * @memberof RoleMiningSessionDtoV2025 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionDtoV2025 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionDtoV2025 - */ - 'name'?: string | null; -} - - -/** - * - * @export - * @interface RoleMiningSessionParametersDtoV2025 - */ -export interface RoleMiningSessionParametersDtoV2025 { - /** - * The ID of the role mining session - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'id'?: string; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'name'?: string | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'pruneThreshold'?: number | null; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionScopeV2025} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'scope'?: RoleMiningSessionScopeV2025; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; - /** - * - * @type {RoleMiningSessionStateV2025} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'state'?: RoleMiningSessionStateV2025; - /** - * - * @type {RoleMiningSessionScopingMethodV2025} - * @memberof RoleMiningSessionParametersDtoV2025 - */ - 'scopingMethod'?: RoleMiningSessionScopingMethodV2025; -} - - -/** - * @type RoleMiningSessionResponseCreatedByV2025 - * The session created by details - * @export - */ -export type RoleMiningSessionResponseCreatedByV2025 = EntityCreatedByDTOV2025 | string; - -/** - * - * @export - * @interface RoleMiningSessionResponseV2025 - */ -export interface RoleMiningSessionResponseV2025 { - /** - * - * @type {RoleMiningSessionScopeV2025} - * @memberof RoleMiningSessionResponseV2025 - */ - 'scope'?: RoleMiningSessionScopeV2025; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The scoping method of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'scopingMethod'?: string | null; - /** - * The computed (or prescribed) prune threshold for this session - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * The prune threshold to be used for this role mining session - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'pruneThreshold'?: number | null; - /** - * The number of potential roles - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'potentialRoleCount'?: number; - /** - * The number of potential roles which have completed processing - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningSessionStatusV2025} - * @memberof RoleMiningSessionResponseV2025 - */ - 'status'?: RoleMiningSessionStatusV2025; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'emailRecipientId'?: string | null; - /** - * - * @type {RoleMiningSessionResponseCreatedByV2025} - * @memberof RoleMiningSessionResponseV2025 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2025; - /** - * The number of identities - * @type {number} - * @memberof RoleMiningSessionResponseV2025 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionResponseV2025 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'name'?: string | null; - /** - * The data file path of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'dataFilePath'?: string | null; - /** - * Session Id for this role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'id'?: string; - /** - * The date-time when this role mining session was created. - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'createdDate'?: string; - /** - * The date-time when this role mining session was completed. - * @type {string} - * @memberof RoleMiningSessionResponseV2025 - */ - 'modifiedDate'?: string; - /** - * - * @type {RoleMiningRoleTypeV2025} - * @memberof RoleMiningSessionResponseV2025 - */ - 'type'?: RoleMiningRoleTypeV2025; -} - - -/** - * - * @export - * @interface RoleMiningSessionScopeV2025 - */ -export interface RoleMiningSessionScopeV2025 { - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2025 - */ - 'identityIds'?: Array; - /** - * The \"search\" criteria that produces the list of identities for this role mining session. - * @type {string} - * @memberof RoleMiningSessionScopeV2025 - */ - 'criteria'?: string | null; - /** - * The filter criteria for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2025 - */ - 'attributeFilterCriteria'?: Array | null; -} -/** - * The scoping method used in the current role mining session. - * @export - * @enum {string} - */ - -export const RoleMiningSessionScopingMethodV2025 = { - Manual: 'MANUAL', - AutoRm: 'AUTO_RM' -} as const; - -export type RoleMiningSessionScopingMethodV2025 = typeof RoleMiningSessionScopingMethodV2025[keyof typeof RoleMiningSessionScopingMethodV2025]; - - -/** - * Role mining session status - * @export - * @enum {string} - */ - -export const RoleMiningSessionStateV2025 = { - Created: 'CREATED', - Updated: 'UPDATED', - IdentitiesObtained: 'IDENTITIES_OBTAINED', - PruneThresholdObtained: 'PRUNE_THRESHOLD_OBTAINED', - PotentialRolesProcessing: 'POTENTIAL_ROLES_PROCESSING', - PotentialRolesCreated: 'POTENTIAL_ROLES_CREATED' -} as const; - -export type RoleMiningSessionStateV2025 = typeof RoleMiningSessionStateV2025[keyof typeof RoleMiningSessionStateV2025]; - - -/** - * - * @export - * @interface RoleMiningSessionStatusV2025 - */ -export interface RoleMiningSessionStatusV2025 { - /** - * - * @type {RoleMiningSessionStateV2025} - * @memberof RoleMiningSessionStatusV2025 - */ - 'state'?: RoleMiningSessionStateV2025; -} - - -/** - * Role Change Propagation Config Input - * @export - * @interface RolePropagationConfigInputV2025 - */ -export interface RolePropagationConfigInputV2025 { - /** - * Indicates if the Role Change Propagation process should be enabled for the tenant - * @type {boolean} - * @memberof RolePropagationConfigInputV2025 - */ - 'enabled'?: boolean; -} -/** - * Role Change Propagation Config Response - * @export - * @interface RolePropagationConfigResponseV2025 - */ -export interface RolePropagationConfigResponseV2025 { - /** - * Indicates if the Role Change Propagation process is enabled for the tenant - * @type {boolean} - * @memberof RolePropagationConfigResponseV2025 - */ - 'enabled'?: boolean; - /** - * The time when Role Change Propagation Process was last enabled on the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2025 - */ - 'enabledDate'?: string; - /** - * The time when Role Change Propagation Configuration was first created for the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2025 - */ - 'createdDate'?: string; - /** - * The time when Role Change Propagation Config was updated on the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2025 - */ - 'modifiedDate'?: string; -} -/** - * Details of the ongoing role propagation process - * @export - * @interface RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ -export interface RolePropagationOngoingResponseRolePropagationDetailsV2025 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'id'?: string; - /** - * Status of the Role Propagation process. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'status'?: RolePropagationOngoingResponseRolePropagationDetailsV2025StatusV2025; - /** - * Current execution stage of the Role Propagation process. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'executionStage'?: RolePropagationOngoingResponseRolePropagationDetailsV2025ExecutionStageV2025; - /** - * Time when the Role Propagation process was launched. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'launched'?: string; - /** - * - * @type {RolePropagationStatusResponseLaunchedByV2025} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'launchedBy'?: RolePropagationStatusResponseLaunchedByV2025; - /** - * - * @type {RolePropagationStatusResponseTerminatedByV2025} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV2025; - /** - * Time when the Role Propagation process was completed. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'completed'?: string; - /** - * Reason for failure if the Role Propagation process failed. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'failureReason'?: string; - /** - * Indicates if the role refresh was skipped during the Role Propagation process. - * @type {boolean} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2025 - */ - 'skipRoleRefresh'?: boolean; -} - -export const RolePropagationOngoingResponseRolePropagationDetailsV2025StatusV2025 = { - Running: 'RUNNING', - Completed: 'COMPLETED' -} as const; - -export type RolePropagationOngoingResponseRolePropagationDetailsV2025StatusV2025 = typeof RolePropagationOngoingResponseRolePropagationDetailsV2025StatusV2025[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV2025StatusV2025]; -export const RolePropagationOngoingResponseRolePropagationDetailsV2025ExecutionStageV2025 = { - Pending: 'PENDING', - DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', - LaunchProvisioning: 'LAUNCH_PROVISIONING', - Succeeded: 'SUCCEEDED', - Failed: 'FAILED', - Terminated: 'TERMINATED' -} as const; - -export type RolePropagationOngoingResponseRolePropagationDetailsV2025ExecutionStageV2025 = typeof RolePropagationOngoingResponseRolePropagationDetailsV2025ExecutionStageV2025[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV2025ExecutionStageV2025]; - -/** - * Running Role Propagation Response - * @export - * @interface RolePropagationOngoingResponseV2025 - */ -export interface RolePropagationOngoingResponseV2025 { - /** - * Indicates if the role propagation process is currently running on the tenant - * @type {boolean} - * @memberof RolePropagationOngoingResponseV2025 - */ - 'isRunning'?: boolean; - /** - * - * @type {RolePropagationOngoingResponseRolePropagationDetailsV2025} - * @memberof RolePropagationOngoingResponseV2025 - */ - 'rolePropagationDetails'?: RolePropagationOngoingResponseRolePropagationDetailsV2025; -} -/** - * Role Propagation Response - * @export - * @interface RolePropagationResponseV2025 - */ -export interface RolePropagationResponseV2025 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationResponseV2025 - */ - 'rolePropagationId'?: string; -} -/** - * Identity who launched the Role Propagation process. - * @export - * @interface RolePropagationStatusResponseLaunchedByV2025 - */ -export interface RolePropagationStatusResponseLaunchedByV2025 { - /** - * DTO type of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2025 - */ - 'type'?: RolePropagationStatusResponseLaunchedByV2025TypeV2025; - /** - * ID of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2025 - */ - 'id'?: string; - /** - * Name of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2025 - */ - 'name'?: string; -} - -export const RolePropagationStatusResponseLaunchedByV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type RolePropagationStatusResponseLaunchedByV2025TypeV2025 = typeof RolePropagationStatusResponseLaunchedByV2025TypeV2025[keyof typeof RolePropagationStatusResponseLaunchedByV2025TypeV2025]; - -/** - * Identity who terminated the Role Propagation process. - * @export - * @interface RolePropagationStatusResponseTerminatedByV2025 - */ -export interface RolePropagationStatusResponseTerminatedByV2025 { - /** - * DTO type of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2025 - */ - 'type'?: RolePropagationStatusResponseTerminatedByV2025TypeV2025; - /** - * ID of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2025 - */ - 'id'?: string; - /** - * Name of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2025 - */ - 'name'?: string; -} - -export const RolePropagationStatusResponseTerminatedByV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type RolePropagationStatusResponseTerminatedByV2025TypeV2025 = typeof RolePropagationStatusResponseTerminatedByV2025TypeV2025[keyof typeof RolePropagationStatusResponseTerminatedByV2025TypeV2025]; - -/** - * Role Propagation Status Response - * @export - * @interface RolePropagationStatusResponseV2025 - */ -export interface RolePropagationStatusResponseV2025 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'id'?: string; - /** - * Status of the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'status'?: RolePropagationStatusResponseV2025StatusV2025; - /** - * Current execution stage of the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'executionStage'?: RolePropagationStatusResponseV2025ExecutionStageV2025; - /** - * Time when the Role Propagation process was launched. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'launched'?: string; - /** - * - * @type {RolePropagationStatusResponseLaunchedByV2025} - * @memberof RolePropagationStatusResponseV2025 - */ - 'launchedBy'?: RolePropagationStatusResponseLaunchedByV2025; - /** - * - * @type {RolePropagationStatusResponseTerminatedByV2025} - * @memberof RolePropagationStatusResponseV2025 - */ - 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV2025; - /** - * Time when the Role Propagation process was completed. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'completed'?: string; - /** - * Reason for failure if the Role Propagation process failed. - * @type {string} - * @memberof RolePropagationStatusResponseV2025 - */ - 'failureReason'?: string; - /** - * Indicates if the role refresh was skipped during the Role Propagation process. - * @type {boolean} - * @memberof RolePropagationStatusResponseV2025 - */ - 'skipRoleRefresh'?: boolean; -} - -export const RolePropagationStatusResponseV2025StatusV2025 = { - Running: 'RUNNING', - Completed: 'COMPLETED' -} as const; - -export type RolePropagationStatusResponseV2025StatusV2025 = typeof RolePropagationStatusResponseV2025StatusV2025[keyof typeof RolePropagationStatusResponseV2025StatusV2025]; -export const RolePropagationStatusResponseV2025ExecutionStageV2025 = { - Pending: 'PENDING', - DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', - LaunchProvisioning: 'LAUNCH_PROVISIONING', - Succeeded: 'SUCCEEDED', - Failed: 'FAILED', - Terminated: 'TERMINATED' -} as const; - -export type RolePropagationStatusResponseV2025ExecutionStageV2025 = typeof RolePropagationStatusResponseV2025ExecutionStageV2025[keyof typeof RolePropagationStatusResponseV2025ExecutionStageV2025]; - -/** - * Role - * @export - * @interface RoleSummaryV2025 - */ -export interface RoleSummaryV2025 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof RoleSummaryV2025 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof RoleSummaryV2025 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof RoleSummaryV2025 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof RoleSummaryV2025 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof RoleSummaryV2025 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2025} - * @memberof RoleSummaryV2025 - */ - 'owner'?: DisplayReferenceV2025; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2025 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2025 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface RoleTargetDtoV2025 - */ -export interface RoleTargetDtoV2025 { - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof RoleTargetDtoV2025 - */ - 'source'?: BaseReferenceDtoV2025; - /** - * - * @type {AccountInfoDtoV2025} - * @memberof RoleTargetDtoV2025 - */ - 'accountInfo'?: AccountInfoDtoV2025; - /** - * - * @type {BaseReferenceDtoV2025} - * @memberof RoleTargetDtoV2025 - */ - 'role'?: BaseReferenceDtoV2025; -} -/** - * A Role - * @export - * @interface RoleV2025 - */ -export interface RoleV2025 { - /** - * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof RoleV2025 - */ - 'id'?: string; - /** - * The human-readable display name of the Role - * @type {string} - * @memberof RoleV2025 - */ - 'name': string; - /** - * Date the Role was created - * @type {string} - * @memberof RoleV2025 - */ - 'created'?: string; - /** - * Date the Role was last modified. - * @type {string} - * @memberof RoleV2025 - */ - 'modified'?: string; - /** - * A human-readable description of the Role - * @type {string} - * @memberof RoleV2025 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2025} - * @memberof RoleV2025 - */ - 'owner': OwnerReferenceV2025 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof RoleV2025 - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2025 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2025 - */ - 'entitlements'?: Array; - /** - * - * @type {RoleMembershipSelectorV2025} - * @memberof RoleV2025 - */ - 'membership'?: RoleMembershipSelectorV2025 | null; - /** - * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - * @type {{ [key: string]: any; }} - * @memberof RoleV2025 - */ - 'legacyMembershipInfo'?: { [key: string]: any; } | null; - /** - * Whether the Role is enabled or not. - * @type {boolean} - * @memberof RoleV2025 - */ - 'enabled'?: boolean; - /** - * Whether the Role can be the target of access requests. - * @type {boolean} - * @memberof RoleV2025 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityForRoleV2025} - * @memberof RoleV2025 - */ - 'accessRequestConfig'?: RequestabilityForRoleV2025; - /** - * - * @type {RevocabilityForRoleV2025} - * @memberof RoleV2025 - */ - 'revocationRequestConfig'?: RevocabilityForRoleV2025; - /** - * List of IDs of segments, if any, to which this Role is assigned. - * @type {Array} - * @memberof RoleV2025 - */ - 'segments'?: Array | null; - /** - * Whether the Role is dimensional. - * @type {boolean} - * @memberof RoleV2025 - */ - 'dimensional'?: boolean | null; - /** - * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - * @type {Array} - * @memberof RoleV2025 - */ - 'dimensionRefs'?: Array | null; - /** - * - * @type {AttributeDTOListV2025} - * @memberof RoleV2025 - */ - 'accessModelMetadata'?: AttributeDTOListV2025; - /** - * The privilege level of the role, if applicable. - * @type {string} - * @memberof RoleV2025 - */ - 'privilegeLevel'?: string | null; -} -/** - * @type RuleV2025 - * @export - */ -export type RuleV2025 = GenerateRandomStringV2025 | GetReferenceIdentityAttributeV2025 | TransformRuleV2025; - -/** - * A table of accounts that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsAccountV2025 - */ -export interface SavedSearchCompleteSearchResultsAccountV2025 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2025 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2025 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsAccountV2025 - */ - 'preview': Array>; -} -/** - * A table of entitlements that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsEntitlementV2025 - */ -export interface SavedSearchCompleteSearchResultsEntitlementV2025 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2025 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2025 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2025 - */ - 'preview': Array>; -} -/** - * A table of identities that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsIdentityV2025 - */ -export interface SavedSearchCompleteSearchResultsIdentityV2025 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2025 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2025 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsIdentityV2025 - */ - 'preview': Array>; -} -/** - * A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. - * @export - * @interface SavedSearchCompleteSearchResultsV2025 - */ -export interface SavedSearchCompleteSearchResultsV2025 { - /** - * - * @type {SavedSearchCompleteSearchResultsAccountV2025} - * @memberof SavedSearchCompleteSearchResultsV2025 - */ - 'Account'?: SavedSearchCompleteSearchResultsAccountV2025 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsEntitlementV2025} - * @memberof SavedSearchCompleteSearchResultsV2025 - */ - 'Entitlement'?: SavedSearchCompleteSearchResultsEntitlementV2025 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsIdentityV2025} - * @memberof SavedSearchCompleteSearchResultsV2025 - */ - 'Identity'?: SavedSearchCompleteSearchResultsIdentityV2025 | null; -} -/** - * - * @export - * @interface SavedSearchCompleteV2025 - */ -export interface SavedSearchCompleteV2025 { - /** - * A name for the report file. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'fileName': string; - /** - * The email address of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'ownerEmail': string; - /** - * The name of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'ownerName': string; - /** - * The search query that was used to generate the report. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'query': string; - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'searchName': string; - /** - * - * @type {SavedSearchCompleteSearchResultsV2025} - * @memberof SavedSearchCompleteV2025 - */ - 'searchResults': SavedSearchCompleteSearchResultsV2025; - /** - * The Amazon S3 URL to download the report from. - * @type {string} - * @memberof SavedSearchCompleteV2025 - */ - 'signedS3Url': string; -} -/** - * - * @export - * @interface SavedSearchDetailFiltersV2025 - */ -export interface SavedSearchDetailFiltersV2025 { - /** - * - * @type {FilterTypeV2025} - * @memberof SavedSearchDetailFiltersV2025 - */ - 'type'?: FilterTypeV2025; - /** - * - * @type {RangeV2025} - * @memberof SavedSearchDetailFiltersV2025 - */ - 'range'?: RangeV2025; - /** - * The terms to be filtered. - * @type {Array} - * @memberof SavedSearchDetailFiltersV2025 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof SavedSearchDetailFiltersV2025 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface SavedSearchDetailV2025 - */ -export interface SavedSearchDetailV2025 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2025 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2025 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchDetailV2025 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2025 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchDetailV2025 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchDetailV2025 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2025 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchDetailV2025 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2025} - * @memberof SavedSearchDetailV2025 - */ - 'filters'?: SavedSearchDetailFiltersV2025 | null; -} -/** - * - * @export - * @interface SavedSearchNameV2025 - */ -export interface SavedSearchNameV2025 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchNameV2025 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchNameV2025 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface SavedSearchV2025 - */ -export interface SavedSearchV2025 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchV2025 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchV2025 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2025 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2025 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchV2025 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2025 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchV2025 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchV2025 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2025 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchV2025 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2025} - * @memberof SavedSearchV2025 - */ - 'filters'?: SavedSearchDetailFiltersV2025 | null; - /** - * The saved search ID. - * @type {string} - * @memberof SavedSearchV2025 - */ - 'id'?: string; - /** - * - * @type {TypedReferenceV2025} - * @memberof SavedSearchV2025 - */ - 'owner'?: TypedReferenceV2025; - /** - * The ID of the identity that owns this saved search. - * @type {string} - * @memberof SavedSearchV2025 - */ - 'ownerId'?: string; - /** - * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - * @type {boolean} - * @memberof SavedSearchV2025 - */ - 'public'?: boolean; -} -/** - * - * @export - * @interface Schedule1V2025 - */ -export interface Schedule1V2025 { - /** - * The type of the Schedule. - * @type {string} - * @memberof Schedule1V2025 - */ - 'type': Schedule1V2025TypeV2025; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof Schedule1V2025 - */ - 'cronExpression': string; -} - -export const Schedule1V2025TypeV2025 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type Schedule1V2025TypeV2025 = typeof Schedule1V2025TypeV2025[keyof typeof Schedule1V2025TypeV2025]; - -/** - * - * @export - * @interface Schedule2DaysV2025 - */ -export interface Schedule2DaysV2025 { - /** - * The application id - * @type {string} - * @memberof Schedule2DaysV2025 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2025} - * @memberof Schedule2DaysV2025 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2025; -} -/** - * - * @export - * @interface Schedule2HoursV2025 - */ -export interface Schedule2HoursV2025 { - /** - * The application id - * @type {string} - * @memberof Schedule2HoursV2025 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2025} - * @memberof Schedule2HoursV2025 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2025; -} -/** - * - * @export - * @interface Schedule2MonthsV2025 - */ -export interface Schedule2MonthsV2025 { - /** - * The application id - * @type {string} - * @memberof Schedule2MonthsV2025 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2025} - * @memberof Schedule2MonthsV2025 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2025; -} -/** - * The schedule information. - * @export - * @interface Schedule2V2025 - */ -export interface Schedule2V2025 { - /** - * - * @type {ScheduleTypeV2025} - * @memberof Schedule2V2025 - */ - 'type': ScheduleTypeV2025; - /** - * - * @type {Schedule2MonthsV2025} - * @memberof Schedule2V2025 - */ - 'months'?: Schedule2MonthsV2025; - /** - * - * @type {Schedule2DaysV2025} - * @memberof Schedule2V2025 - */ - 'days'?: Schedule2DaysV2025; - /** - * - * @type {Schedule2HoursV2025} - * @memberof Schedule2V2025 - */ - 'hours': Schedule2HoursV2025; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Schedule2V2025 - */ - 'expiration'?: string | null; - /** - * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. - * @type {string} - * @memberof Schedule2V2025 - */ - 'timeZoneId'?: string | null; -} - - -/** - * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" - * @export - * @interface ScheduleDaysV2025 - */ -export interface ScheduleDaysV2025 { - /** - * Enum type to specify days value - * @type {string} - * @memberof ScheduleDaysV2025 - */ - 'type': ScheduleDaysV2025TypeV2025; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleDaysV2025 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleDaysV2025 - */ - 'interval'?: number | null; -} - -export const ScheduleDaysV2025TypeV2025 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleDaysV2025TypeV2025 = typeof ScheduleDaysV2025TypeV2025[keyof typeof ScheduleDaysV2025TypeV2025]; - -/** - * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" - * @export - * @interface ScheduleHoursV2025 - */ -export interface ScheduleHoursV2025 { - /** - * Enum type to specify hours value - * @type {string} - * @memberof ScheduleHoursV2025 - */ - 'type': ScheduleHoursV2025TypeV2025; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleHoursV2025 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleHoursV2025 - */ - 'interval'?: number | null; -} - -export const ScheduleHoursV2025TypeV2025 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleHoursV2025TypeV2025 = typeof ScheduleHoursV2025TypeV2025[keyof typeof ScheduleHoursV2025TypeV2025]; - -/** - * - * @export - * @interface ScheduleInfoV2025 - */ -export interface ScheduleInfoV2025 { - /** - * The unique identifier for the scheduled task. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'scheduleTaskId'?: number; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2025 - */ - 'scheduleTaskName'?: string | null; - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2025 - */ - 'taskTypeName'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'interval'?: number; - /** - * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. - * @type {string} - * @memberof ScheduleInfoV2025 - */ - 'scheduleType'?: string | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof ScheduleInfoV2025 - */ - 'active'?: boolean; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'startTime'?: number | null; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'endTime'?: number | null; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof ScheduleInfoV2025 - */ - 'daysOfWeek'?: Array | null; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The name of the scheduled task that must complete before this task runs. - * @type {string} - * @memberof ScheduleInfoV2025 - */ - 'runAfterScheduleTaskName'?: string | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'applicationId'?: number | null; - /** - * The display name of the user who created the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2025 - */ - 'createdByDisplayName'?: string | null; - /** - * The next scheduled run time for the task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'nextRun'?: number | null; - /** - * The last run time of the task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2025 - */ - 'lastRun'?: number | null; -} -/** - * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 - * @export - * @interface ScheduleMonthsV2025 - */ -export interface ScheduleMonthsV2025 { - /** - * Enum type to specify months value - * @type {string} - * @memberof ScheduleMonthsV2025 - */ - 'type': ScheduleMonthsV2025TypeV2025; - /** - * Values of the months based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleMonthsV2025 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleMonthsV2025 - */ - 'interval'?: number; -} - -export const ScheduleMonthsV2025TypeV2025 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleMonthsV2025TypeV2025 = typeof ScheduleMonthsV2025TypeV2025[keyof typeof ScheduleMonthsV2025TypeV2025]; - -/** - * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const ScheduleTypeV2025 = { - Daily: 'DAILY', - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Calendar: 'CALENDAR', - Annually: 'ANNUALLY' -} as const; - -export type ScheduleTypeV2025 = typeof ScheduleTypeV2025[keyof typeof ScheduleTypeV2025]; - - -/** - * - * @export - * @interface ScheduleV2025 - */ -export interface ScheduleV2025 { - /** - * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. - * @type {string} - * @memberof ScheduleV2025 - */ - 'type': ScheduleV2025TypeV2025; - /** - * - * @type {ScheduleMonthsV2025} - * @memberof ScheduleV2025 - */ - 'months'?: ScheduleMonthsV2025 | null; - /** - * - * @type {ScheduleDaysV2025} - * @memberof ScheduleV2025 - */ - 'days'?: ScheduleDaysV2025; - /** - * - * @type {ScheduleHoursV2025} - * @memberof ScheduleV2025 - */ - 'hours': ScheduleHoursV2025; - /** - * Specifies the time after which this schedule will no longer occur. - * @type {string} - * @memberof ScheduleV2025 - */ - 'expiration'?: string | null; - /** - * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. - * @type {string} - * @memberof ScheduleV2025 - */ - 'timeZoneId'?: string; -} - -export const ScheduleV2025TypeV2025 = { - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Annually: 'ANNUALLY', - Calendar: 'CALENDAR' -} as const; - -export type ScheduleV2025TypeV2025 = typeof ScheduleV2025TypeV2025[keyof typeof ScheduleV2025TypeV2025]; - -/** - * Options for BACKUP type jobs. Required for BACKUP jobs. - * @export - * @interface ScheduledActionPayloadContentBackupOptionsV2025 - */ -export interface ScheduledActionPayloadContentBackupOptionsV2025 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionPayloadContentBackupOptionsV2025 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025; }} - * @memberof ScheduledActionPayloadContentBackupOptionsV2025 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025; }; -} -/** - * - * @export - * @interface ScheduledActionPayloadContentV2025 - */ -export interface ScheduledActionPayloadContentV2025 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionPayloadContentV2025 - */ - 'name': string; - /** - * - * @type {ScheduledActionPayloadContentBackupOptionsV2025} - * @memberof ScheduledActionPayloadContentV2025 - */ - 'backupOptions'?: ScheduledActionPayloadContentBackupOptionsV2025; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2025 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2025 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2025 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionPayloadV2025 - */ -export interface ScheduledActionPayloadV2025 { - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionPayloadV2025 - */ - 'jobType': ScheduledActionPayloadV2025JobTypeV2025; - /** - * The time when this scheduled action should start. Optional. - * @type {string} - * @memberof ScheduledActionPayloadV2025 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. Optional for repeated events. - * @type {string} - * @memberof ScheduledActionPayloadV2025 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. Optional, will default to current time zone. - * @type {string} - * @memberof ScheduledActionPayloadV2025 - */ - 'timeZoneId'?: string; - /** - * - * @type {ScheduledActionPayloadContentV2025} - * @memberof ScheduledActionPayloadV2025 - */ - 'content': ScheduledActionPayloadContentV2025; -} - -export const ScheduledActionPayloadV2025JobTypeV2025 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionPayloadV2025JobTypeV2025 = typeof ScheduledActionPayloadV2025JobTypeV2025[keyof typeof ScheduledActionPayloadV2025JobTypeV2025]; - -/** - * - * @export - * @interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025 - */ -export interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025 { - /** - * Set of names to be included. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025 - */ - 'includedNames'?: Array; -} -/** - * Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. - * @export - * @interface ScheduledActionResponseContentBackupOptionsV2025 - */ -export interface ScheduledActionResponseContentBackupOptionsV2025 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsV2025 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025; }} - * @memberof ScheduledActionResponseContentBackupOptionsV2025 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2025; }; -} -/** - * Content details for the scheduled action. - * @export - * @interface ScheduledActionResponseContentV2025 - */ -export interface ScheduledActionResponseContentV2025 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionResponseContentV2025 - */ - 'name'?: string; - /** - * - * @type {ScheduledActionResponseContentBackupOptionsV2025} - * @memberof ScheduledActionResponseContentV2025 - */ - 'backupOptions'?: ScheduledActionResponseContentBackupOptionsV2025; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2025 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2025 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2025 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionResponseV2025 - */ -export interface ScheduledActionResponseV2025 { - /** - * Unique identifier for this scheduled action. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'id'?: string; - /** - * The time when this scheduled action was created. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'created'?: string; - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'jobType'?: ScheduledActionResponseV2025JobTypeV2025; - /** - * - * @type {ScheduledActionResponseContentV2025} - * @memberof ScheduledActionResponseV2025 - */ - 'content'?: ScheduledActionResponseContentV2025; - /** - * The time when this scheduled action should start. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. - * @type {string} - * @memberof ScheduledActionResponseV2025 - */ - 'timeZoneId'?: string; -} - -export const ScheduledActionResponseV2025JobTypeV2025 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionResponseV2025JobTypeV2025 = typeof ScheduledActionResponseV2025JobTypeV2025[keyof typeof ScheduledActionResponseV2025JobTypeV2025]; - -/** - * Attributes related to a scheduled trigger - * @export - * @interface ScheduledAttributesV2025 - */ -export interface ScheduledAttributesV2025 { - /** - * Frequency of execution - * @type {string} - * @memberof ScheduledAttributesV2025 - */ - 'frequency': ScheduledAttributesV2025FrequencyV2025 | null; - /** - * Time zone identifier - * @type {string} - * @memberof ScheduledAttributesV2025 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof ScheduledAttributesV2025 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof ScheduledAttributesV2025 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2025 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2025 - */ - 'yearlyTimes'?: Array | null; -} - -export const ScheduledAttributesV2025FrequencyV2025 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type ScheduledAttributesV2025FrequencyV2025 = typeof ScheduledAttributesV2025FrequencyV2025[keyof typeof ScheduledAttributesV2025FrequencyV2025]; - -/** - * The owner of the scheduled search - * @export - * @interface ScheduledSearchAllOfOwnerV2025 - */ -export interface ScheduledSearchAllOfOwnerV2025 { - /** - * The type of object being referenced - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2025 - */ - 'type': ScheduledSearchAllOfOwnerV2025TypeV2025; - /** - * The ID of the referenced object - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2025 - */ - 'id': string; -} - -export const ScheduledSearchAllOfOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type ScheduledSearchAllOfOwnerV2025TypeV2025 = typeof ScheduledSearchAllOfOwnerV2025TypeV2025[keyof typeof ScheduledSearchAllOfOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface ScheduledSearchNameV2025 - */ -export interface ScheduledSearchNameV2025 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2025 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2025 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ScheduledSearchV2025 - */ -export interface ScheduledSearchV2025 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2025} - * @memberof ScheduledSearchV2025 - */ - 'schedule': Schedule2V2025; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof ScheduledSearchV2025 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof ScheduledSearchV2025 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof ScheduledSearchV2025 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof ScheduledSearchV2025 - */ - 'displayQueryDetails'?: boolean; - /** - * The scheduled search ID. - * @type {string} - * @memberof ScheduledSearchV2025 - */ - 'id': string; - /** - * - * @type {ScheduledSearchAllOfOwnerV2025} - * @memberof ScheduledSearchV2025 - */ - 'owner': ScheduledSearchAllOfOwnerV2025; - /** - * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. - * @type {string} - * @memberof ScheduledSearchV2025 - * @deprecated - */ - 'ownerId': string; -} -/** - * - * @export - * @interface SchemaV2025 - */ -export interface SchemaV2025 { - /** - * The id of the Schema. - * @type {string} - * @memberof SchemaV2025 - */ - 'id'?: string; - /** - * The name of the Schema. - * @type {string} - * @memberof SchemaV2025 - */ - 'name'?: string; - /** - * The name of the object type on the native system that the schema represents. - * @type {string} - * @memberof SchemaV2025 - */ - 'nativeObjectType'?: string; - /** - * The name of the attribute used to calculate the unique identifier for an object in the schema. - * @type {string} - * @memberof SchemaV2025 - */ - 'identityAttribute'?: string; - /** - * The name of the attribute used to calculate the display value for an object in the schema. - * @type {string} - * @memberof SchemaV2025 - */ - 'displayAttribute'?: string; - /** - * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - * @type {string} - * @memberof SchemaV2025 - */ - 'hierarchyAttribute'?: string | null; - /** - * Flag indicating whether or not the include permissions with the object data when aggregating the schema. - * @type {boolean} - * @memberof SchemaV2025 - */ - 'includePermissions'?: boolean; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SchemaV2025 - */ - 'features'?: Array; - /** - * Holds any extra configuration data that the schema may require. - * @type {object} - * @memberof SchemaV2025 - */ - 'configuration'?: object; - /** - * The attribute definitions which form the schema. - * @type {Array} - * @memberof SchemaV2025 - */ - 'attributes'?: Array; - /** - * The date the Schema was created. - * @type {string} - * @memberof SchemaV2025 - */ - 'created'?: string; - /** - * The date the Schema was last modified. - * @type {string} - * @memberof SchemaV2025 - */ - 'modified'?: string | null; -} - -export const SchemaV2025FeaturesV2025 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SchemaV2025FeaturesV2025 = typeof SchemaV2025FeaturesV2025[keyof typeof SchemaV2025FeaturesV2025]; - -/** - * An enumeration of the types of scope choices - * @export - * @enum {string} - */ - -export const ScopeTypeV2025 = { - Entitlement: 'ENTITLEMENT', - Certification: 'CERTIFICATION', - Identity: 'IDENTITY', - Entitlementrequest: 'ENTITLEMENTREQUEST' -} as const; - -export type ScopeTypeV2025 = typeof ScopeTypeV2025[keyof typeof ScopeTypeV2025]; - - -/** - * This defines what access the segment is giving - * @export - * @interface ScopeV2025 - */ -export interface ScopeV2025 { - /** - * - * @type {ScopeTypeV2025} - * @memberof ScopeV2025 - */ - 'scope'?: ScopeTypeV2025; - /** - * - * @type {ScopeVisibilityTypeV2025} - * @memberof ScopeV2025 - */ - 'visibility'?: ScopeVisibilityTypeV2025; - /** - * - * @type {VisibilityCriteriaV2025} - * @memberof ScopeV2025 - */ - 'scopeFilter'?: VisibilityCriteriaV2025; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof ScopeV2025 - */ - 'scopeSelection'?: Array; -} - - -/** - * An enumeration of the types of scope visibility choices - * @export - * @enum {string} - */ - -export const ScopeVisibilityTypeV2025 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION', - Unsegmented: 'UNSEGMENTED' -} as const; - -export type ScopeVisibilityTypeV2025 = typeof ScopeVisibilityTypeV2025[keyof typeof ScopeVisibilityTypeV2025]; - - -/** - * - * @export - * @interface SearchAggregationSpecificationV2025 - */ -export interface SearchAggregationSpecificationV2025 { - /** - * - * @type {NestedAggregationV2025} - * @memberof SearchAggregationSpecificationV2025 - */ - 'nested'?: NestedAggregationV2025; - /** - * - * @type {MetricAggregationV2025} - * @memberof SearchAggregationSpecificationV2025 - */ - 'metric'?: MetricAggregationV2025; - /** - * - * @type {FilterAggregationV2025} - * @memberof SearchAggregationSpecificationV2025 - */ - 'filter'?: FilterAggregationV2025; - /** - * - * @type {BucketAggregationV2025} - * @memberof SearchAggregationSpecificationV2025 - */ - 'bucket'?: BucketAggregationV2025; - /** - * - * @type {SubSearchAggregationSpecificationV2025} - * @memberof SearchAggregationSpecificationV2025 - */ - 'subAggregation'?: SubSearchAggregationSpecificationV2025; -} -/** - * - * @export - * @interface SearchArgumentsV2025 - */ -export interface SearchArgumentsV2025 { - /** - * The ID of the scheduled search that triggered the saved search execution. - * @type {string} - * @memberof SearchArgumentsV2025 - */ - 'scheduleId'?: string; - /** - * The owner of the scheduled search being tested. - * @type {TypedReferenceV2025} - * @memberof SearchArgumentsV2025 - */ - 'owner'?: TypedReferenceV2025; - /** - * The email recipients of the scheduled search being tested. - * @type {Array} - * @memberof SearchArgumentsV2025 - */ - 'recipients'?: Array; -} -/** - * - * @export - * @interface SearchAttributeConfigV2025 - */ -export interface SearchAttributeConfigV2025 { - /** - * Name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2025 - */ - 'name'?: string; - /** - * The display name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2025 - */ - 'displayName'?: string; - /** - * Map of application id and their associated attribute. - * @type {object} - * @memberof SearchAttributeConfigV2025 - */ - 'applicationAttributes'?: object; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeLowerV2025 - */ -export interface SearchCriteriaFiltersValueRangeLowerV2025 { - /** - * The lower bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeLowerV2025 - */ - 'value'?: string; - /** - * Whether the lower bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeLowerV2025 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeUpperV2025 - */ -export interface SearchCriteriaFiltersValueRangeUpperV2025 { - /** - * The upper bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeUpperV2025 - */ - 'value'?: string; - /** - * Whether the upper bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeUpperV2025 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeV2025 - */ -export interface SearchCriteriaFiltersValueRangeV2025 { - /** - * - * @type {SearchCriteriaFiltersValueRangeLowerV2025} - * @memberof SearchCriteriaFiltersValueRangeV2025 - */ - 'lower'?: SearchCriteriaFiltersValueRangeLowerV2025; - /** - * - * @type {SearchCriteriaFiltersValueRangeUpperV2025} - * @memberof SearchCriteriaFiltersValueRangeV2025 - */ - 'upper'?: SearchCriteriaFiltersValueRangeUpperV2025; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueV2025 - */ -export interface SearchCriteriaFiltersValueV2025 { - /** - * The type of filter, e.g., \"TERMS\" or \"RANGE\". - * @type {string} - * @memberof SearchCriteriaFiltersValueV2025 - */ - 'type'?: string; - /** - * Terms to filter by (for \"TERMS\" type). - * @type {Array} - * @memberof SearchCriteriaFiltersValueV2025 - */ - 'terms'?: Array; - /** - * - * @type {SearchCriteriaFiltersValueRangeV2025} - * @memberof SearchCriteriaFiltersValueV2025 - */ - 'range'?: SearchCriteriaFiltersValueRangeV2025; -} -/** - * - * @export - * @interface SearchCriteriaQueryV2025 - */ -export interface SearchCriteriaQueryV2025 { - /** - * A structured query for advanced search. - * @type {string} - * @memberof SearchCriteriaQueryV2025 - */ - 'query'?: string; -} -/** - * - * @export - * @interface SearchCriteriaTextQueryV2025 - */ -export interface SearchCriteriaTextQueryV2025 { - /** - * Terms to search for. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2025 - */ - 'terms'?: Array; - /** - * Fields to search within. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2025 - */ - 'fields'?: Array; - /** - * Whether to match any of the terms. - * @type {boolean} - * @memberof SearchCriteriaTextQueryV2025 - */ - 'matchAny'?: boolean; -} -/** - * Represents the search criteria for querying entitlements. - * @export - * @interface SearchCriteriaV2025 - */ -export interface SearchCriteriaV2025 { - /** - * A list of indices to search within. Must contain exactly one item, typically \"entitlements\". - * @type {Array} - * @memberof SearchCriteriaV2025 - */ - 'indices': Array; - /** - * A map of filters applied to the search. Keys are filter names, and values are filter definitions. - * @type {{ [key: string]: SearchCriteriaFiltersValueV2025; }} - * @memberof SearchCriteriaV2025 - */ - 'filters'?: { [key: string]: SearchCriteriaFiltersValueV2025; }; - /** - * - * @type {SearchCriteriaQueryV2025} - * @memberof SearchCriteriaV2025 - */ - 'query'?: SearchCriteriaQueryV2025; - /** - * Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. - * @type {string} - * @memberof SearchCriteriaV2025 - */ - 'queryType'?: string; - /** - * - * @type {SearchCriteriaTextQueryV2025} - * @memberof SearchCriteriaV2025 - */ - 'textQuery'?: SearchCriteriaTextQueryV2025; - /** - * Whether to include nested objects in the search results. - * @type {boolean} - * @memberof SearchCriteriaV2025 - */ - 'includeNested'?: boolean; - /** - * Specifies the sorting order for the results. - * @type {Array} - * @memberof SearchCriteriaV2025 - */ - 'sort'?: Array; - /** - * Used for pagination to fetch results after a specific point. - * @type {Array} - * @memberof SearchCriteriaV2025 - */ - 'searchAfter'?: Array; -} -/** - * @type SearchDocumentV2025 - * @export - */ -export type SearchDocumentV2025 = AccessProfileDocumentV2025 | AccountActivityDocumentV2025 | EntitlementDocumentV2025 | EventDocumentV2025 | IdentityDocumentV2025 | RoleDocumentV2025; - -/** - * @type SearchDocumentsV2025 - * @export - */ -export type SearchDocumentsV2025 = AccessProfileDocumentsV2025 | AccountActivityDocumentsV2025 | EntitlementDocumentsV2025 | EventDocumentsV2025 | IdentityDocumentsV2025 | RoleDocumentsV2025; - -/** - * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. - * @export - * @interface SearchExportReportArgumentsV2025 - */ -export interface SearchExportReportArgumentsV2025 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchExportReportArgumentsV2025 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof SearchExportReportArgumentsV2025 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof SearchExportReportArgumentsV2025 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchExportReportArgumentsV2025 - */ - 'sort'?: Array; -} -/** - * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SearchFilterTypeV2025 = { - Term: 'TERM' -} as const; - -export type SearchFilterTypeV2025 = typeof SearchFilterTypeV2025[keyof typeof SearchFilterTypeV2025]; - - -/** - * - * @export - * @interface SearchFormDefinitionsByTenant400ResponseV2025 - */ -export interface SearchFormDefinitionsByTenant400ResponseV2025 { - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2025 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof SearchFormDefinitionsByTenant400ResponseV2025 - */ - 'messages'?: Array; - /** - * - * @type {number} - * @memberof SearchFormDefinitionsByTenant400ResponseV2025 - */ - 'statusCode'?: number; - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2025 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface SearchScheduleRecipientsInnerV2025 - */ -export interface SearchScheduleRecipientsInnerV2025 { - /** - * The type of object being referenced - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2025 - */ - 'type': SearchScheduleRecipientsInnerV2025TypeV2025; - /** - * The ID of the referenced object - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2025 - */ - 'id': string; -} - -export const SearchScheduleRecipientsInnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SearchScheduleRecipientsInnerV2025TypeV2025 = typeof SearchScheduleRecipientsInnerV2025TypeV2025[keyof typeof SearchScheduleRecipientsInnerV2025TypeV2025]; - -/** - * - * @export - * @interface SearchScheduleV2025 - */ -export interface SearchScheduleV2025 { - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof SearchScheduleV2025 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof SearchScheduleV2025 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof SearchScheduleV2025 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2025} - * @memberof SearchScheduleV2025 - */ - 'schedule': Schedule2V2025; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof SearchScheduleV2025 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof SearchScheduleV2025 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof SearchScheduleV2025 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof SearchScheduleV2025 - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface SearchV2025 - */ -export interface SearchV2025 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchV2025 - */ - 'indices'?: Array; - /** - * - * @type {QueryTypeV2025} - * @memberof SearchV2025 - */ - 'queryType'?: QueryTypeV2025; - /** - * - * @type {string} - * @memberof SearchV2025 - */ - 'queryVersion'?: string; - /** - * - * @type {QueryV2025} - * @memberof SearchV2025 - */ - 'query'?: QueryV2025; - /** - * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - * @type {object} - * @memberof SearchV2025 - */ - 'queryDsl'?: object; - /** - * - * @type {TextQueryV2025} - * @memberof SearchV2025 - */ - 'textQuery'?: TextQueryV2025; - /** - * - * @type {TypeAheadQueryV2025} - * @memberof SearchV2025 - */ - 'typeAheadQuery'?: TypeAheadQueryV2025; - /** - * Indicates whether nested objects from returned search results should be included. - * @type {boolean} - * @memberof SearchV2025 - */ - 'includeNested'?: boolean; - /** - * - * @type {QueryResultFilterV2025} - * @memberof SearchV2025 - */ - 'queryResultFilter'?: QueryResultFilterV2025; - /** - * - * @type {AggregationTypeV2025} - * @memberof SearchV2025 - */ - 'aggregationType'?: AggregationTypeV2025; - /** - * - * @type {string} - * @memberof SearchV2025 - */ - 'aggregationsVersion'?: string; - /** - * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - * @type {object} - * @memberof SearchV2025 - */ - 'aggregationsDsl'?: object; - /** - * - * @type {SearchAggregationSpecificationV2025} - * @memberof SearchV2025 - */ - 'aggregations'?: SearchAggregationSpecificationV2025; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchV2025 - */ - 'sort'?: Array; - /** - * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] - * @type {Array} - * @memberof SearchV2025 - */ - 'searchAfter'?: Array; - /** - * The filters to be applied for each filtered field name. - * @type {{ [key: string]: FilterV2025; }} - * @memberof SearchV2025 - */ - 'filters'?: { [key: string]: FilterV2025; }; -} - - -/** - * - * @export - * @interface SectionDetailsV2025 - */ -export interface SectionDetailsV2025 { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionDetailsV2025 - */ - 'name'?: string | null; - /** - * Label of the section - * @type {string} - * @memberof SectionDetailsV2025 - */ - 'label'?: string | null; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionDetailsV2025 - */ - 'formItems'?: Array; -} -/** - * SED Approval Status - * @export - * @interface SedApprovalStatusV2025 - */ -export interface SedApprovalStatusV2025 { - /** - * failed reason will be display if status is failed - * @type {string} - * @memberof SedApprovalStatusV2025 - */ - 'failedReason'?: string; - /** - * Sed id - * @type {string} - * @memberof SedApprovalStatusV2025 - */ - 'id'?: string; - /** - * SUCCESS | FAILED - * @type {string} - * @memberof SedApprovalStatusV2025 - */ - 'status'?: string; -} -/** - * Sed Approval Request Body - * @export - * @interface SedApprovalV2025 - */ -export interface SedApprovalV2025 { - /** - * List of SED id\'s - * @type {Array} - * @memberof SedApprovalV2025 - */ - 'items'?: Array; -} -/** - * Sed Assignee - * @export - * @interface SedAssigneeV2025 - */ -export interface SedAssigneeV2025 { - /** - * Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE - * @type {string} - * @memberof SedAssigneeV2025 - */ - 'type': SedAssigneeV2025TypeV2025; - /** - * Identity or Group identifier Empty when using source/entitlement owner personas - * @type {string} - * @memberof SedAssigneeV2025 - */ - 'value'?: string; -} - -export const SedAssigneeV2025TypeV2025 = { - Identity: 'IDENTITY', - Group: 'GROUP', - SourceOwner: 'SOURCE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER' -} as const; - -export type SedAssigneeV2025TypeV2025 = typeof SedAssigneeV2025TypeV2025[keyof typeof SedAssigneeV2025TypeV2025]; - -/** - * Sed Assignment Response - * @export - * @interface SedAssignmentResponseV2025 - */ -export interface SedAssignmentResponseV2025 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedAssignmentResponseV2025 - */ - 'batchId'?: string; -} -/** - * Sed Assignment - * @export - * @interface SedAssignmentV2025 - */ -export interface SedAssignmentV2025 { - /** - * - * @type {SedAssigneeV2025} - * @memberof SedAssignmentV2025 - */ - 'assignee'?: SedAssigneeV2025; - /** - * List of SED id\'s - * @type {Array} - * @memberof SedAssignmentV2025 - */ - 'items'?: Array; -} -/** - * Sed Batch Record - * @export - * @interface SedBatchRecordV2025 - */ -export interface SedBatchRecordV2025 { - /** - * The tenant ID associated with the batch. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'tenantId'?: string; - /** - * The unique ID of the batch. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'batchId'?: string; - /** - * The name of the batch. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'name'?: string | null; - /** - * The current state of the batch (e.g., submitted, materialized, completed). - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'processedState'?: string | null; - /** - * The ID of the user who requested the batch. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'requestedBy'?: string; - /** - * The number of items materialized in the batch. - * @type {number} - * @memberof SedBatchRecordV2025 - */ - 'materializedCount'?: number; - /** - * The number of items processed in the batch. - * @type {number} - * @memberof SedBatchRecordV2025 - */ - 'processedCount'?: number; - /** - * The timestamp when the batch was created. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'createdAt'?: string; - /** - * The timestamp when the batch was last updated. - * @type {string} - * @memberof SedBatchRecordV2025 - */ - 'updatedAt'?: string | null; -} -/** - * Sed Batch Request - * @export - * @interface SedBatchRequestV2025 - */ -export interface SedBatchRequestV2025 { - /** - * list of entitlement ids - * @type {Array} - * @memberof SedBatchRequestV2025 - */ - 'entitlements'?: Array | null; - /** - * list of sed ids - * @type {Array} - * @memberof SedBatchRequestV2025 - */ - 'seds'?: Array | null; - /** - * Search criteria for the batch request. - * @type {{ [key: string]: SearchCriteriaV2025; }} - * @memberof SedBatchRequestV2025 - */ - 'searchCriteria'?: { [key: string]: SearchCriteriaV2025; } | null; -} -/** - * Sed Batch Response - * @export - * @interface SedBatchResponseV2025 - */ -export interface SedBatchResponseV2025 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedBatchResponseV2025 - */ - 'batchId'?: string; -} -/** - * Sed Batch Stats - * @export - * @interface SedBatchStatsV2025 - */ -export interface SedBatchStatsV2025 { - /** - * batch complete - * @type {boolean} - * @memberof SedBatchStatsV2025 - */ - 'batchComplete'?: boolean; - /** - * batch Id - * @type {string} - * @memberof SedBatchStatsV2025 - */ - 'batchId'?: string; - /** - * discovered count - * @type {number} - * @memberof SedBatchStatsV2025 - */ - 'discoveredCount'?: number; - /** - * discovery complete - * @type {boolean} - * @memberof SedBatchStatsV2025 - */ - 'discoveryComplete'?: boolean; - /** - * processed count - * @type {number} - * @memberof SedBatchStatsV2025 - */ - 'processedCount'?: number; -} -/** - * Patch for Suggested Entitlement Description - * @export - * @interface SedPatchV2025 - */ -export interface SedPatchV2025 { - /** - * desired operation - * @type {string} - * @memberof SedPatchV2025 - */ - 'op'?: string; - /** - * field to be patched - * @type {string} - * @memberof SedPatchV2025 - */ - 'path'?: string; - /** - * value to replace with - * @type {object} - * @memberof SedPatchV2025 - */ - 'value'?: object; -} -/** - * Suggested Entitlement Description - * @export - * @interface SedV2025 - */ -export interface SedV2025 { - /** - * name of the entitlement - * @type {string} - * @memberof SedV2025 - */ - 'Name'?: string; - /** - * entitlement approved by - * @type {string} - * @memberof SedV2025 - */ - 'approved_by'?: string; - /** - * entitlement approved type - * @type {string} - * @memberof SedV2025 - */ - 'approved_type'?: string; - /** - * entitlement approved then - * @type {string} - * @memberof SedV2025 - */ - 'approved_when'?: string; - /** - * entitlement attribute - * @type {string} - * @memberof SedV2025 - */ - 'attribute'?: string; - /** - * description of entitlement - * @type {string} - * @memberof SedV2025 - */ - 'description'?: string; - /** - * entitlement display name - * @type {string} - * @memberof SedV2025 - */ - 'displayName'?: string; - /** - * sed id - * @type {string} - * @memberof SedV2025 - */ - 'id'?: string; - /** - * entitlement source id - * @type {string} - * @memberof SedV2025 - */ - 'sourceId'?: string; - /** - * entitlement source name - * @type {string} - * @memberof SedV2025 - */ - 'sourceName'?: string; - /** - * entitlement status - * @type {string} - * @memberof SedV2025 - */ - 'status'?: string; - /** - * llm suggested entitlement description - * @type {string} - * @memberof SedV2025 - */ - 'suggestedDescription'?: string; - /** - * entitlement type - * @type {string} - * @memberof SedV2025 - */ - 'type'?: string; - /** - * entitlement value - * @type {string} - * @memberof SedV2025 - */ - 'value'?: string; -} -/** - * - * @export - * @interface SegmentV2025 - */ -export interface SegmentV2025 { - /** - * The segment\'s ID. - * @type {string} - * @memberof SegmentV2025 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof SegmentV2025 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof SegmentV2025 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof SegmentV2025 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof SegmentV2025 - */ - 'description'?: string; - /** - * - * @type {OwnerReferenceSegmentsV2025} - * @memberof SegmentV2025 - */ - 'owner'?: OwnerReferenceSegmentsV2025 | null; - /** - * - * @type {SegmentVisibilityCriteriaV2025} - * @memberof SegmentV2025 - */ - 'visibilityCriteria'?: SegmentVisibilityCriteriaV2025; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof SegmentV2025 - */ - 'active'?: boolean; -} -/** - * - * @export - * @interface SegmentVisibilityCriteriaV2025 - */ -export interface SegmentVisibilityCriteriaV2025 { - /** - * - * @type {ExpressionV2025} - * @memberof SegmentVisibilityCriteriaV2025 - */ - 'expression'?: ExpressionV2025; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigMatchExpressionV2025 - */ -export interface SelectorAccountMatchConfigMatchExpressionV2025 { - /** - * - * @type {Array} - * @memberof SelectorAccountMatchConfigMatchExpressionV2025 - */ - 'matchTerms'?: Array; - /** - * If it is AND operators for match terms - * @type {boolean} - * @memberof SelectorAccountMatchConfigMatchExpressionV2025 - */ - 'and'?: boolean; -} -/** - * - * @export - * @interface SelectorAccountMatchConfigV2025 - */ -export interface SelectorAccountMatchConfigV2025 { - /** - * - * @type {SelectorAccountMatchConfigMatchExpressionV2025} - * @memberof SelectorAccountMatchConfigV2025 - */ - 'matchExpression'?: SelectorAccountMatchConfigMatchExpressionV2025; -} -/** - * - * @export - * @interface SelectorV2025 - */ -export interface SelectorV2025 { - /** - * The application id - * @type {string} - * @memberof SelectorV2025 - */ - 'applicationId'?: string; - /** - * - * @type {SelectorAccountMatchConfigV2025} - * @memberof SelectorV2025 - */ - 'accountMatchConfig'?: SelectorAccountMatchConfigV2025; -} -/** - * Self block for imported/exported object. - * @export - * @interface SelfImportExportDtoV2025 - */ -export interface SelfImportExportDtoV2025 { - /** - * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. - * @type {string} - * @memberof SelfImportExportDtoV2025 - */ - 'type'?: SelfImportExportDtoV2025TypeV2025; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof SelfImportExportDtoV2025 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof SelfImportExportDtoV2025 - */ - 'name'?: string; -} - -export const SelfImportExportDtoV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type SelfImportExportDtoV2025TypeV2025 = typeof SelfImportExportDtoV2025TypeV2025[keyof typeof SelfImportExportDtoV2025TypeV2025]; - -/** - * - * @export - * @interface SendAccountVerificationRequestV2025 - */ -export interface SendAccountVerificationRequestV2025 { - /** - * The source name where identity account password should be reset - * @type {string} - * @memberof SendAccountVerificationRequestV2025 - */ - 'sourceName'?: string | null; - /** - * The method to send notification - * @type {string} - * @memberof SendAccountVerificationRequestV2025 - */ - 'via': SendAccountVerificationRequestV2025ViaV2025; -} - -export const SendAccountVerificationRequestV2025ViaV2025 = { - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL', - LinkWork: 'LINK_WORK', - LinkPersonal: 'LINK_PERSONAL' -} as const; - -export type SendAccountVerificationRequestV2025ViaV2025 = typeof SendAccountVerificationRequestV2025ViaV2025[keyof typeof SendAccountVerificationRequestV2025ViaV2025]; - -/** - * - * @export - * @interface SendClassifyMachineAccount200ResponseV2025 - */ -export interface SendClassifyMachineAccount200ResponseV2025 { - /** - * Indicates if account is classified as machine - * @type {boolean} - * @memberof SendClassifyMachineAccount200ResponseV2025 - */ - 'isMachine'?: boolean; -} -/** - * - * @export - * @interface SendClassifyMachineAccountFromSource200ResponseV2025 - */ -export interface SendClassifyMachineAccountFromSource200ResponseV2025 { - /** - * Returns the number of all the accounts from source submitted for processing. - * @type {number} - * @memberof SendClassifyMachineAccountFromSource200ResponseV2025 - */ - 'Accounts submitted for processing'?: number; -} -/** - * - * @export - * @interface SendTestNotificationRequestDtoV2025 - */ -export interface SendTestNotificationRequestDtoV2025 { - /** - * The template notification key. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'key'?: string; - /** - * The notification medium. Has to be one of the following enum values. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'medium'?: SendTestNotificationRequestDtoV2025MediumV2025; - /** - * The locale for the message text. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'locale'?: string; - /** - * A Json object that denotes the context specific to the template. - * @type {object} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'context'?: object; - /** - * A list of override recipient email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'recipientEmailList'?: Array; - /** - * A list of CC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'carbonCopy'?: Array; - /** - * A list of BCC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2025 - */ - 'blindCarbonCopy'?: Array; -} - -export const SendTestNotificationRequestDtoV2025MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type SendTestNotificationRequestDtoV2025MediumV2025 = typeof SendTestNotificationRequestDtoV2025MediumV2025[keyof typeof SendTestNotificationRequestDtoV2025MediumV2025]; - -/** - * - * @export - * @interface ServiceDeskIntegrationDtoV2025 - */ -export interface ServiceDeskIntegrationDtoV2025 { - /** - * Unique identifier for the Service Desk integration - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'id'?: string; - /** - * Service Desk integration\'s name. The name must be unique. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'name': string; - /** - * The date and time the Service Desk integration was created - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'created'?: string; - /** - * The date and time the Service Desk integration was last modified - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'modified'?: string; - /** - * Service Desk integration\'s description. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'description': string; - /** - * Service Desk integration types: - ServiceNowSDIM - ServiceNow - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'type': string; - /** - * - * @type {OwnerDtoV2025} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'ownerRef'?: OwnerDtoV2025; - /** - * - * @type {SourceClusterDtoV2025} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'clusterRef'?: SourceClusterDtoV2025; - /** - * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2025 - * @deprecated - */ - 'cluster'?: string | null; - /** - * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - * @type {Array} - * @memberof ServiceDeskIntegrationDtoV2025 - * @deprecated - */ - 'managedSources'?: Array; - /** - * - * @type {ProvisioningConfigV2025} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'provisioningConfig'?: ProvisioningConfigV2025; - /** - * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {BeforeProvisioningRuleDtoV2025} - * @memberof ServiceDeskIntegrationDtoV2025 - */ - 'beforeProvisioningRule'?: BeforeProvisioningRuleDtoV2025; -} -/** - * - * @export - * @interface ServiceDeskIntegrationTemplateDtoV2025 - */ -export interface ServiceDeskIntegrationTemplateDtoV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'modified'?: string; - /** - * The \'type\' property specifies the type of the Service Desk integration template. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'type': string; - /** - * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {ProvisioningConfigV2025} - * @memberof ServiceDeskIntegrationTemplateDtoV2025 - */ - 'provisioningConfig': ProvisioningConfigV2025; -} -/** - * This represents a Service Desk Integration template type. - * @export - * @interface ServiceDeskIntegrationTemplateTypeV2025 - */ -export interface ServiceDeskIntegrationTemplateTypeV2025 { - /** - * This is the name of the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2025 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2025 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2025 - */ - 'scriptName': string; -} -/** - * Source for Service Desk integration template. - * @export - * @interface ServiceDeskSourceV2025 - */ -export interface ServiceDeskSourceV2025 { - /** - * DTO type of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2025 - */ - 'type'?: ServiceDeskSourceV2025TypeV2025; - /** - * ID of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2025 - */ - 'id'?: string; - /** - * Human-readable name of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2025 - */ - 'name'?: string; -} - -export const ServiceDeskSourceV2025TypeV2025 = { - Source: 'SOURCE' -} as const; - -export type ServiceDeskSourceV2025TypeV2025 = typeof ServiceDeskSourceV2025TypeV2025[keyof typeof ServiceDeskSourceV2025TypeV2025]; - -/** - * - * @export - * @interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ -export interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 { - /** - * Federation protocol role - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerV2025RoleV2025; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2025} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'jitConfiguration'?: JITConfigurationV2025; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'certificateName'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025 - */ - 'legacyAcsUrl'?: string; -} - -export const ServiceProviderConfigurationFederationProtocolDetailsInnerV2025RoleV2025 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type ServiceProviderConfigurationFederationProtocolDetailsInnerV2025RoleV2025 = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025RoleV2025[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2025RoleV2025]; - -/** - * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider - * @export - * @interface ServiceProviderConfigurationV2025 - */ -export interface ServiceProviderConfigurationV2025 { - /** - * This determines whether or not the SAML authentication flow is enabled for an org - * @type {boolean} - * @memberof ServiceProviderConfigurationV2025 - */ - 'enabled'?: boolean; - /** - * This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2025 - */ - 'bypassIdp'?: boolean; - /** - * This indicates whether or not the SAML configuration is valid. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2025 - */ - 'samlConfigurationValid'?: boolean; - /** - * A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). - * @type {Array} - * @memberof ServiceProviderConfigurationV2025 - */ - 'federationProtocolDetails'?: Array; -} -/** - * - * @export - * @interface SessionConfigurationV2025 - */ -export interface SessionConfigurationV2025 { - /** - * The maximum time in minutes a session can be idle. - * @type {number} - * @memberof SessionConfigurationV2025 - */ - 'maxIdleTime'?: number; - /** - * Denotes if \'remember me\' is enabled. - * @type {boolean} - * @memberof SessionConfigurationV2025 - */ - 'rememberMe'?: boolean; - /** - * The maximum allowable session time in minutes. - * @type {number} - * @memberof SessionConfigurationV2025 - */ - 'maxSessionTime'?: number; -} -/** - * - * @export - * @interface SetIcon200ResponseV2025 - */ -export interface SetIcon200ResponseV2025 { - /** - * url to file with icon - * @type {string} - * @memberof SetIcon200ResponseV2025 - */ - 'icon'?: string; -} -/** - * - * @export - * @interface SetIconRequestV2025 - */ -export interface SetIconRequestV2025 { - /** - * file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] - * @type {File} - * @memberof SetIconRequestV2025 - */ - 'image': File; -} -/** - * - * @export - * @interface SetLifecycleState200ResponseV2025 - */ -export interface SetLifecycleState200ResponseV2025 { - /** - * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - * @type {string} - * @memberof SetLifecycleState200ResponseV2025 - */ - 'accountActivityId'?: string; -} -/** - * - * @export - * @interface SetLifecycleStateRequestV2025 - */ -export interface SetLifecycleStateRequestV2025 { - /** - * ID of the lifecycle state to set. - * @type {string} - * @memberof SetLifecycleStateRequestV2025 - */ - 'lifecycleStateId'?: string; -} -/** - * Before provisioning rule of integration - * @export - * @interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025 - */ -export interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025 - */ - 'type'?: DtoTypeV2025; - /** - * ID of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SimIntegrationDetailsV2025 - */ -export interface SimIntegrationDetailsV2025 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'modified'?: string; - /** - * The description of the integration - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'description'?: string; - /** - * The integration type - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'type'?: string; - /** - * The attributes map containing the credentials used to configure the integration. - * @type {object} - * @memberof SimIntegrationDetailsV2025 - */ - 'attributes'?: object | null; - /** - * The list of sources (managed resources) - * @type {Array} - * @memberof SimIntegrationDetailsV2025 - */ - 'sources'?: Array; - /** - * The cluster/proxy - * @type {string} - * @memberof SimIntegrationDetailsV2025 - */ - 'cluster'?: string; - /** - * Custom mapping between the integration result and the provisioning result - * @type {object} - * @memberof SimIntegrationDetailsV2025 - */ - 'statusMap'?: object; - /** - * Request data to customize desc and body of the created ticket - * @type {object} - * @memberof SimIntegrationDetailsV2025 - */ - 'request'?: object; - /** - * - * @type {SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025} - * @memberof SimIntegrationDetailsV2025 - */ - 'beforeProvisioningRule'?: SimIntegrationDetailsAllOfBeforeProvisioningRuleV2025; -} -/** - * - * @export - * @interface SlimCampaignV2025 - */ -export interface SlimCampaignV2025 { - /** - * Id of the campaign - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'type': SlimCampaignV2025TypeV2025; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof SlimCampaignV2025 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof SlimCampaignV2025 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof SlimCampaignV2025 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'status'?: SlimCampaignV2025StatusV2025 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'correlatedStatus'?: SlimCampaignV2025CorrelatedStatusV2025; - /** - * Created time of the campaign - * @type {string} - * @memberof SlimCampaignV2025 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2025 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2025 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof SlimCampaignV2025 - */ - 'alerts'?: Array | null; -} - -export const SlimCampaignV2025TypeV2025 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type SlimCampaignV2025TypeV2025 = typeof SlimCampaignV2025TypeV2025[keyof typeof SlimCampaignV2025TypeV2025]; -export const SlimCampaignV2025StatusV2025 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type SlimCampaignV2025StatusV2025 = typeof SlimCampaignV2025StatusV2025[keyof typeof SlimCampaignV2025StatusV2025]; -export const SlimCampaignV2025CorrelatedStatusV2025 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type SlimCampaignV2025CorrelatedStatusV2025 = typeof SlimCampaignV2025CorrelatedStatusV2025[keyof typeof SlimCampaignV2025CorrelatedStatusV2025]; - -/** - * Discovered applications - * @export - * @interface SlimDiscoveredApplicationsV2025 - */ -export interface SlimDiscoveredApplicationsV2025 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'status'?: string; - /** - * The operational status of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'operationalStatus'?: string; - /** - * The category of the discovery source. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'discoverySourceCategory'?: string; - /** - * The number of licenses associated with the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'licenseCount'?: number; - /** - * Indicates whether the application is sanctioned. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'isSanctioned'?: boolean; - /** - * URL of the application\'s logo. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'logo'?: string; - /** - * The URL of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'appUrl'?: string; - /** - * List of groups associated with the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'groups'?: Array; - /** - * The count of users associated with the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'usersCount'?: string; - /** - * The owners of the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'applicationOwner'?: Array; - /** - * The IT owners of the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'itApplicationOwner'?: Array; - /** - * The business criticality level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'businessCriticality'?: string; - /** - * The data classification level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'dataClassification'?: string; - /** - * The business unit associated with the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'businessUnit'?: string; - /** - * The installation type of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'installType'?: string; - /** - * The environment in which the application operates. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'environment'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'riskLevel'?: SlimDiscoveredApplicationsV2025RiskLevelV2025; - /** - * Indicates whether the application has privileged access. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'isPrivileged'?: boolean; - /** - * The warranty expiration date of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'warrantyExpiration'?: string; - /** - * Additional attributes of the application useful for visibility of governance posture. - * @type {object} - * @memberof SlimDiscoveredApplicationsV2025 - */ - 'attributes'?: object; -} - -export const SlimDiscoveredApplicationsV2025RiskLevelV2025 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type SlimDiscoveredApplicationsV2025RiskLevelV2025 = typeof SlimDiscoveredApplicationsV2025RiskLevelV2025[keyof typeof SlimDiscoveredApplicationsV2025RiskLevelV2025]; - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteriaV2025 - */ -export interface SodExemptCriteriaV2025 { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteriaV2025 - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeV2025} - * @memberof SodExemptCriteriaV2025 - */ - 'type'?: DtoTypeV2025; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteriaV2025 - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteriaV2025 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SodPolicyConflictingAccessCriteriaV2025 - */ -export interface SodPolicyConflictingAccessCriteriaV2025 { - /** - * - * @type {AccessCriteriaV2025} - * @memberof SodPolicyConflictingAccessCriteriaV2025 - */ - 'leftCriteria'?: AccessCriteriaV2025; - /** - * - * @type {AccessCriteriaV2025} - * @memberof SodPolicyConflictingAccessCriteriaV2025 - */ - 'rightCriteria'?: AccessCriteriaV2025; -} -/** - * SOD policy. - * @export - * @interface SodPolicyDto1V2025 - */ -export interface SodPolicyDto1V2025 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto1V2025 - */ - 'type'?: SodPolicyDto1V2025TypeV2025; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto1V2025 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto1V2025 - */ - 'name'?: string; -} - -export const SodPolicyDto1V2025TypeV2025 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDto1V2025TypeV2025 = typeof SodPolicyDto1V2025TypeV2025[keyof typeof SodPolicyDto1V2025TypeV2025]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDtoV2025 - */ -export interface SodPolicyDtoV2025 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDtoV2025 - */ - 'type'?: SodPolicyDtoV2025TypeV2025; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDtoV2025 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDtoV2025 - */ - 'name'?: string; -} - -export const SodPolicyDtoV2025TypeV2025 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDtoV2025TypeV2025 = typeof SodPolicyDtoV2025TypeV2025[keyof typeof SodPolicyDtoV2025TypeV2025]; - -/** - * The owner of the SOD policy. - * @export - * @interface SodPolicyOwnerRefV2025 - */ -export interface SodPolicyOwnerRefV2025 { - /** - * Owner type. - * @type {string} - * @memberof SodPolicyOwnerRefV2025 - */ - 'type'?: SodPolicyOwnerRefV2025TypeV2025; - /** - * Owner\'s ID. - * @type {string} - * @memberof SodPolicyOwnerRefV2025 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof SodPolicyOwnerRefV2025 - */ - 'name'?: string; -} - -export const SodPolicyOwnerRefV2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SodPolicyOwnerRefV2025TypeV2025 = typeof SodPolicyOwnerRefV2025TypeV2025[keyof typeof SodPolicyOwnerRefV2025TypeV2025]; - -/** - * - * @export - * @interface SodPolicyScheduleV2025 - */ -export interface SodPolicyScheduleV2025 { - /** - * SOD Policy schedule name - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'name'?: string; - /** - * The time when this SOD policy schedule is created. - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'created'?: string; - /** - * The time when this SOD policy schedule is modified. - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'modified'?: string; - /** - * SOD Policy schedule description - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'description'?: string; - /** - * - * @type {Schedule2V2025} - * @memberof SodPolicyScheduleV2025 - */ - 'schedule'?: Schedule2V2025; - /** - * - * @type {Array} - * @memberof SodPolicyScheduleV2025 - */ - 'recipients'?: Array; - /** - * Indicates if empty results need to be emailed - * @type {boolean} - * @memberof SodPolicyScheduleV2025 - */ - 'emailEmptyResults'?: boolean; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyScheduleV2025 - */ - 'modifierId'?: string; -} -/** - * - * @export - * @interface SodPolicyV2025 - */ -export interface SodPolicyV2025 { - /** - * Policy id - * @type {string} - * @memberof SodPolicyV2025 - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicyV2025 - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyV2025 - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyV2025 - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicyV2025 - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRefV2025} - * @memberof SodPolicyV2025 - */ - 'ownerRef'?: SodPolicyOwnerRefV2025; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicyV2025 - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicyV2025 - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicyV2025 - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicyV2025 - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicyV2025 - */ - 'state'?: SodPolicyV2025StateV2025; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicyV2025 - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyV2025 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyV2025 - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfigV2025} - * @memberof SodPolicyV2025 - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfigV2025; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicyV2025 - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicyV2025 - */ - 'type'?: SodPolicyV2025TypeV2025; - /** - * - * @type {SodPolicyConflictingAccessCriteriaV2025} - * @memberof SodPolicyV2025 - */ - 'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteriaV2025; -} - -export const SodPolicyV2025StateV2025 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyV2025StateV2025 = typeof SodPolicyV2025StateV2025[keyof typeof SodPolicyV2025StateV2025]; -export const SodPolicyV2025TypeV2025 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyV2025TypeV2025 = typeof SodPolicyV2025TypeV2025[keyof typeof SodPolicyV2025TypeV2025]; - -/** - * SOD policy recipient. - * @export - * @interface SodRecipientV2025 - */ -export interface SodRecipientV2025 { - /** - * SOD policy recipient DTO type. - * @type {string} - * @memberof SodRecipientV2025 - */ - 'type'?: SodRecipientV2025TypeV2025; - /** - * SOD policy recipient\'s identity ID. - * @type {string} - * @memberof SodRecipientV2025 - */ - 'id'?: string; - /** - * SOD policy recipient\'s display name. - * @type {string} - * @memberof SodRecipientV2025 - */ - 'name'?: string; -} - -export const SodRecipientV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SodRecipientV2025TypeV2025 = typeof SodRecipientV2025TypeV2025[keyof typeof SodRecipientV2025TypeV2025]; - -/** - * SOD policy violation report result. - * @export - * @interface SodReportResultDtoV2025 - */ -export interface SodReportResultDtoV2025 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof SodReportResultDtoV2025 - */ - 'type'?: SodReportResultDtoV2025TypeV2025; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof SodReportResultDtoV2025 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof SodReportResultDtoV2025 - */ - 'name'?: string; -} - -export const SodReportResultDtoV2025TypeV2025 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type SodReportResultDtoV2025TypeV2025 = typeof SodReportResultDtoV2025TypeV2025[keyof typeof SodReportResultDtoV2025TypeV2025]; - -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResultV2025 - */ -export interface SodViolationCheckResultV2025 { - /** - * - * @type {ErrorMessageDtoV2025} - * @memberof SodViolationCheckResultV2025 - */ - 'message'?: ErrorMessageDtoV2025; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResultV2025 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResultV2025 - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResultV2025 - */ - 'violatedPolicies'?: Array | null; -} -/** - * An object referencing an SOD violation check - * @export - * @interface SodViolationCheckV2025 - */ -export interface SodViolationCheckV2025 { - /** - * The id of the original request - * @type {string} - * @memberof SodViolationCheckV2025 - */ - 'requestId': string; - /** - * The date-time when this request was created. - * @type {string} - * @memberof SodViolationCheckV2025 - */ - 'created'?: string; -} -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompletedV2025 - */ -export interface SodViolationContextCheckCompletedV2025 { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompletedV2025 - */ - 'state'?: SodViolationContextCheckCompletedV2025StateV2025 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompletedV2025 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2025} - * @memberof SodViolationContextCheckCompletedV2025 - */ - 'violationCheckResult'?: SodViolationCheckResultV2025; -} - -export const SodViolationContextCheckCompletedV2025StateV2025 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompletedV2025StateV2025 = typeof SodViolationContextCheckCompletedV2025StateV2025[keyof typeof SodViolationContextCheckCompletedV2025StateV2025]; - -/** - * - * @export - * @interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025 - */ -export interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025 { - /** - * - * @type {Array} - * @memberof SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025 - */ - 'criteriaList'?: Array; -} -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContextConflictingAccessCriteriaV2025 - */ -export interface SodViolationContextConflictingAccessCriteriaV2025 { - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025} - * @memberof SodViolationContextConflictingAccessCriteriaV2025 - */ - 'leftCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025} - * @memberof SodViolationContextConflictingAccessCriteriaV2025 - */ - 'rightCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2025; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContextV2025 - */ -export interface SodViolationContextV2025 { - /** - * - * @type {SodPolicyDto1V2025} - * @memberof SodViolationContextV2025 - */ - 'policy'?: SodPolicyDto1V2025; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaV2025} - * @memberof SodViolationContextV2025 - */ - 'conflictingAccessCriteria'?: SodViolationContextConflictingAccessCriteriaV2025; -} -/** - * - * @export - * @interface Source1V2025 - */ -export interface Source1V2025 { - /** - * Attribute mapping type. - * @type {string} - * @memberof Source1V2025 - */ - 'type'?: string; - /** - * Attribute mapping properties. - * @type {object} - * @memberof Source1V2025 - */ - 'properties'?: object; -} -/** - * Reference to account correlation config object. - * @export - * @interface SourceAccountCorrelationConfigV2025 - */ -export interface SourceAccountCorrelationConfigV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2025 - */ - 'type'?: SourceAccountCorrelationConfigV2025TypeV2025; - /** - * Account correlation config ID. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2025 - */ - 'id'?: string; - /** - * Account correlation config\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2025 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationConfigV2025TypeV2025 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' -} as const; - -export type SourceAccountCorrelationConfigV2025TypeV2025 = typeof SourceAccountCorrelationConfigV2025TypeV2025[keyof typeof SourceAccountCorrelationConfigV2025TypeV2025]; - -/** - * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. - * @export - * @interface SourceAccountCorrelationRuleV2025 - */ -export interface SourceAccountCorrelationRuleV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2025 - */ - 'type'?: SourceAccountCorrelationRuleV2025TypeV2025; - /** - * Rule ID. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2025 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2025 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationRuleV2025TypeV2025 = { - Rule: 'RULE' -} as const; - -export type SourceAccountCorrelationRuleV2025TypeV2025 = typeof SourceAccountCorrelationRuleV2025TypeV2025[keyof typeof SourceAccountCorrelationRuleV2025TypeV2025]; - -/** - * - * @export - * @interface SourceAccountCreatedV2025 - */ -export interface SourceAccountCreatedV2025 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2025 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountCreatedV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountDeletedV2025 - */ -export interface SourceAccountDeletedV2025 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2025 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountDeletedV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountSelectionsV2025 - */ -export interface SourceAccountSelectionsV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof SourceAccountSelectionsV2025 - */ - 'type'?: DtoTypeV2025; - /** - * The source id - * @type {string} - * @memberof SourceAccountSelectionsV2025 - */ - 'id'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAccountSelectionsV2025 - */ - 'name'?: string; - /** - * The accounts information for a particular source in the requested item - * @type {Array} - * @memberof SourceAccountSelectionsV2025 - */ - 'accounts'?: Array; -} - - -/** - * - * @export - * @interface SourceAccountUpdatedV2025 - */ -export interface SourceAccountUpdatedV2025 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2025 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountUpdatedV2025 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAppAccountSourceV2025 - */ -export interface SourceAppAccountSourceV2025 { - /** - * The source ID - * @type {string} - * @memberof SourceAppAccountSourceV2025 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppAccountSourceV2025 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppAccountSourceV2025 - */ - 'name'?: string; - /** - * If the source is used for password management - * @type {boolean} - * @memberof SourceAppAccountSourceV2025 - */ - 'useForPasswordManagement'?: boolean; - /** - * The password policies for the source - * @type {Array} - * @memberof SourceAppAccountSourceV2025 - */ - 'passwordPolicies'?: Array | null; -} -/** - * - * @export - * @interface SourceAppBulkUpdateRequestV2025 - */ -export interface SourceAppBulkUpdateRequestV2025 { - /** - * List of source app ids to update - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2025 - */ - 'appIds': Array; - /** - * The JSONPatch payload used to update the source app. - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2025 - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface SourceAppCreateDtoAccountSourceV2025 - */ -export interface SourceAppCreateDtoAccountSourceV2025 { - /** - * The source ID - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2025 - */ - 'id': string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2025 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface SourceAppCreateDtoV2025 - */ -export interface SourceAppCreateDtoV2025 { - /** - * The source app name - * @type {string} - * @memberof SourceAppCreateDtoV2025 - */ - 'name': string; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppCreateDtoV2025 - */ - 'description': string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppCreateDtoV2025 - */ - 'matchAllAccounts'?: boolean; - /** - * - * @type {SourceAppCreateDtoAccountSourceV2025} - * @memberof SourceAppCreateDtoV2025 - */ - 'accountSource': SourceAppCreateDtoAccountSourceV2025; -} -/** - * - * @export - * @interface SourceAppPatchDtoV2025 - */ -export interface SourceAppPatchDtoV2025 { - /** - * The source app id - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppPatchDtoV2025 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppPatchDtoV2025 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppPatchDtoV2025 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppPatchDtoV2025 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppPatchDtoV2025 - */ - 'appCenterEnabled'?: boolean; - /** - * List of IDs of access profiles - * @type {Array} - * @memberof SourceAppPatchDtoV2025 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {SourceAppAccountSourceV2025} - * @memberof SourceAppPatchDtoV2025 - */ - 'accountSource'?: SourceAppAccountSourceV2025 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2025} - * @memberof SourceAppPatchDtoV2025 - */ - 'owner'?: BaseReferenceDtoV2025 | null; -} -/** - * - * @export - * @interface SourceAppV2025 - */ -export interface SourceAppV2025 { - /** - * The source app id - * @type {string} - * @memberof SourceAppV2025 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppV2025 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppV2025 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppV2025 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppV2025 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppV2025 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppV2025 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppV2025 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppV2025 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppV2025 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {SourceAppAccountSourceV2025} - * @memberof SourceAppV2025 - */ - 'accountSource'?: SourceAppAccountSourceV2025 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2025} - * @memberof SourceAppV2025 - */ - 'owner'?: BaseReferenceDtoV2025 | null; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface SourceBeforeProvisioningRuleV2025 - */ -export interface SourceBeforeProvisioningRuleV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2025 - */ - 'type'?: SourceBeforeProvisioningRuleV2025TypeV2025; - /** - * Rule ID. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2025 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2025 - */ - 'name'?: string; -} - -export const SourceBeforeProvisioningRuleV2025TypeV2025 = { - Rule: 'RULE' -} as const; - -export type SourceBeforeProvisioningRuleV2025TypeV2025 = typeof SourceBeforeProvisioningRuleV2025TypeV2025[keyof typeof SourceBeforeProvisioningRuleV2025TypeV2025]; - -/** - * A map containing numbers relevant to the source classification process - * @export - * @interface SourceClassificationStatusAllOfCountsV2025 - */ -export interface SourceClassificationStatusAllOfCountsV2025 { - /** - * total number of source accounts - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2025 - */ - 'EXPECTED': number; - /** - * number of accounts that have been sent for processing (should be the same as expected when all accounts are collected) - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2025 - */ - 'RECEIVED': number; - /** - * number of accounts that have been classified - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2025 - */ - 'COMPLETED': number; -} -/** - * - * @export - * @interface SourceClassificationStatusV2025 - */ -export interface SourceClassificationStatusV2025 { - /** - * Status of Classification Process - * @type {string} - * @memberof SourceClassificationStatusV2025 - */ - 'status'?: SourceClassificationStatusV2025StatusV2025; - /** - * Time when the process was started - * @type {string} - * @memberof SourceClassificationStatusV2025 - */ - 'started'?: string; - /** - * Time when the process status was last updated - * @type {string} - * @memberof SourceClassificationStatusV2025 - */ - 'updated'?: string | null; - /** - * - * @type {SourceClassificationStatusAllOfCountsV2025} - * @memberof SourceClassificationStatusV2025 - */ - 'counts'?: SourceClassificationStatusAllOfCountsV2025; -} - -export const SourceClassificationStatusV2025StatusV2025 = { - Started: 'STARTED', - Collected: 'COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED' -} as const; - -export type SourceClassificationStatusV2025StatusV2025 = typeof SourceClassificationStatusV2025StatusV2025[keyof typeof SourceClassificationStatusV2025StatusV2025]; - -/** - * Source cluster. - * @export - * @interface SourceClusterDtoV2025 - */ -export interface SourceClusterDtoV2025 { - /** - * Source cluster DTO type. - * @type {string} - * @memberof SourceClusterDtoV2025 - */ - 'type'?: SourceClusterDtoV2025TypeV2025; - /** - * Source cluster ID. - * @type {string} - * @memberof SourceClusterDtoV2025 - */ - 'id'?: string; - /** - * Source cluster display name. - * @type {string} - * @memberof SourceClusterDtoV2025 - */ - 'name'?: string; -} - -export const SourceClusterDtoV2025TypeV2025 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterDtoV2025TypeV2025 = typeof SourceClusterDtoV2025TypeV2025[keyof typeof SourceClusterDtoV2025TypeV2025]; - -/** - * Reference to the source\'s associated cluster. - * @export - * @interface SourceClusterV2025 - */ -export interface SourceClusterV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceClusterV2025 - */ - 'type': SourceClusterV2025TypeV2025; - /** - * Cluster ID. - * @type {string} - * @memberof SourceClusterV2025 - */ - 'id': string; - /** - * Cluster\'s human-readable display name. - * @type {string} - * @memberof SourceClusterV2025 - */ - 'name': string; -} - -export const SourceClusterV2025TypeV2025 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterV2025TypeV2025 = typeof SourceClusterV2025TypeV2025[keyof typeof SourceClusterV2025TypeV2025]; - -/** - * SourceCode - * @export - * @interface SourceCodeV2025 - */ -export interface SourceCodeV2025 { - /** - * the version of the code - * @type {string} - * @memberof SourceCodeV2025 - */ - 'version': string; - /** - * The code - * @type {string} - * @memberof SourceCodeV2025 - */ - 'script': string; -} -/** - * - * @export - * @interface SourceConnectionsDtoV2025 - */ -export interface SourceConnectionsDtoV2025 { - /** - * The IdentityProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'identityProfiles'?: Array; - /** - * Name of the CredentialProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'credentialProfiles'?: Array; - /** - * The attributes attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'sourceAttributes'?: Array; - /** - * The profiles attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'mappingProfiles'?: Array; - /** - * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'dependentCustomTransforms'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'dependentApps'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2025 - */ - 'missingDependents'?: Array; -} -/** - * Identity who created the source. - * @export - * @interface SourceCreatedActorV2025 - */ -export interface SourceCreatedActorV2025 { - /** - * DTO type of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2025 - */ - 'type': SourceCreatedActorV2025TypeV2025; - /** - * ID of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2025 - */ - 'id': string; - /** - * Display name of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2025 - */ - 'name': string; -} - -export const SourceCreatedActorV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SourceCreatedActorV2025TypeV2025 = typeof SourceCreatedActorV2025TypeV2025[keyof typeof SourceCreatedActorV2025TypeV2025]; - -/** - * - * @export - * @interface SourceCreatedV2025 - */ -export interface SourceCreatedV2025 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceCreatedV2025 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceCreatedV2025 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceCreatedV2025 - */ - 'type': string; - /** - * The date and time the source was created. - * @type {string} - * @memberof SourceCreatedV2025 - */ - 'created': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceCreatedV2025 - */ - 'connector': string; - /** - * - * @type {SourceCreatedActorV2025} - * @memberof SourceCreatedV2025 - */ - 'actor': SourceCreatedActorV2025; -} -/** - * - * @export - * @interface SourceCreationErrorsV2025 - */ -export interface SourceCreationErrorsV2025 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'multihostId'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'source_name'?: string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'source_error'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'modified'?: string; - /** - * operation category (e.g. DELETE). - * @type {string} - * @memberof SourceCreationErrorsV2025 - */ - 'operation'?: string | null; -} -/** - * Identity who deleted the source. - * @export - * @interface SourceDeletedActorV2025 - */ -export interface SourceDeletedActorV2025 { - /** - * DTO type of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2025 - */ - 'type': SourceDeletedActorV2025TypeV2025; - /** - * ID of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2025 - */ - 'id': string; - /** - * Display name of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2025 - */ - 'name': string; -} - -export const SourceDeletedActorV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SourceDeletedActorV2025TypeV2025 = typeof SourceDeletedActorV2025TypeV2025[keyof typeof SourceDeletedActorV2025TypeV2025]; - -/** - * - * @export - * @interface SourceDeletedV2025 - */ -export interface SourceDeletedV2025 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceDeletedV2025 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceDeletedV2025 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceDeletedV2025 - */ - 'type': string; - /** - * The date and time the source was deleted. - * @type {string} - * @memberof SourceDeletedV2025 - */ - 'deleted': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceDeletedV2025 - */ - 'connector': string; - /** - * - * @type {SourceDeletedActorV2025} - * @memberof SourceDeletedV2025 - */ - 'actor': SourceDeletedActorV2025; -} -/** - * Entitlement Request Configuration - * @export - * @interface SourceEntitlementRequestConfigV2025 - */ -export interface SourceEntitlementRequestConfigV2025 { - /** - * - * @type {EntitlementAccessRequestConfigV2025} - * @memberof SourceEntitlementRequestConfigV2025 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2025; - /** - * - * @type {EntitlementRevocationRequestConfigV2025} - * @memberof SourceEntitlementRequestConfigV2025 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2025; -} -/** - * Dto for source health data - * @export - * @interface SourceHealthDtoV2025 - */ -export interface SourceHealthDtoV2025 { - /** - * the id of the Source - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'id'?: string; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'type'?: string; - /** - * the name of the source - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'name'?: string; - /** - * source\'s org - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'org'?: string; - /** - * Is the source authoritative - * @type {boolean} - * @memberof SourceHealthDtoV2025 - */ - 'isAuthoritative'?: boolean; - /** - * Is the source in a cluster - * @type {boolean} - * @memberof SourceHealthDtoV2025 - */ - 'isCluster'?: boolean; - /** - * source\'s hostname - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'hostname'?: string; - /** - * source\'s pod - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'pod'?: string; - /** - * The version of the iqService - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'iqServiceVersion'?: string | null; - /** - * connection test result - * @type {string} - * @memberof SourceHealthDtoV2025 - */ - 'status'?: SourceHealthDtoV2025StatusV2025; -} - -export const SourceHealthDtoV2025StatusV2025 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type SourceHealthDtoV2025StatusV2025 = typeof SourceHealthDtoV2025StatusV2025[keyof typeof SourceHealthDtoV2025StatusV2025]; - -/** - * - * @export - * @interface SourceItemRefV2025 - */ -export interface SourceItemRefV2025 { - /** - * The id for the source on which account selections are made - * @type {string} - * @memberof SourceItemRefV2025 - */ - 'sourceId'?: string | null; - /** - * A list of account selections on the source. Currently, only one selection per source is supported. - * @type {Array} - * @memberof SourceItemRefV2025 - */ - 'accounts'?: Array | null; -} -/** - * Reference to management workgroup for the source. - * @export - * @interface SourceManagementWorkgroupV2025 - */ -export interface SourceManagementWorkgroupV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagementWorkgroupV2025 - */ - 'type'?: SourceManagementWorkgroupV2025TypeV2025; - /** - * Management workgroup ID. - * @type {string} - * @memberof SourceManagementWorkgroupV2025 - */ - 'id'?: string; - /** - * Management workgroup\'s human-readable display name. - * @type {string} - * @memberof SourceManagementWorkgroupV2025 - */ - 'name'?: string; -} - -export const SourceManagementWorkgroupV2025TypeV2025 = { - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SourceManagementWorkgroupV2025TypeV2025 = typeof SourceManagementWorkgroupV2025TypeV2025[keyof typeof SourceManagementWorkgroupV2025TypeV2025]; - -/** - * - * @export - * @interface SourceManagerCorrelationMappingV2025 - */ -export interface SourceManagerCorrelationMappingV2025 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2025 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2025 - */ - 'identityAttributeName'?: string; -} -/** - * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. - * @export - * @interface SourceManagerCorrelationRuleV2025 - */ -export interface SourceManagerCorrelationRuleV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2025 - */ - 'type'?: SourceManagerCorrelationRuleV2025TypeV2025; - /** - * Rule ID. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2025 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2025 - */ - 'name'?: string; -} - -export const SourceManagerCorrelationRuleV2025TypeV2025 = { - Rule: 'RULE' -} as const; - -export type SourceManagerCorrelationRuleV2025TypeV2025 = typeof SourceManagerCorrelationRuleV2025TypeV2025[keyof typeof SourceManagerCorrelationRuleV2025TypeV2025]; - -/** - * Reference to identity object who owns the source. - * @export - * @interface SourceOwnerV2025 - */ -export interface SourceOwnerV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceOwnerV2025 - */ - 'type'?: SourceOwnerV2025TypeV2025; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof SourceOwnerV2025 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof SourceOwnerV2025 - */ - 'name'?: string; -} - -export const SourceOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SourceOwnerV2025TypeV2025 = typeof SourceOwnerV2025TypeV2025[keyof typeof SourceOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface SourcePasswordPoliciesInnerV2025 - */ -export interface SourcePasswordPoliciesInnerV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2025 - */ - 'type'?: SourcePasswordPoliciesInnerV2025TypeV2025; - /** - * Policy ID. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2025 - */ - 'id'?: string; - /** - * Policy\'s human-readable display name. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2025 - */ - 'name'?: string; -} - -export const SourcePasswordPoliciesInnerV2025TypeV2025 = { - PasswordPolicy: 'PASSWORD_POLICY' -} as const; - -export type SourcePasswordPoliciesInnerV2025TypeV2025 = typeof SourcePasswordPoliciesInnerV2025TypeV2025[keyof typeof SourcePasswordPoliciesInnerV2025TypeV2025]; - -/** - * - * @export - * @interface SourceScheduleV2025 - */ -export interface SourceScheduleV2025 { - /** - * The type of the Schedule. - * @type {string} - * @memberof SourceScheduleV2025 - */ - 'type': SourceScheduleV2025TypeV2025; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof SourceScheduleV2025 - */ - 'cronExpression': string; -} - -export const SourceScheduleV2025TypeV2025 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type SourceScheduleV2025TypeV2025 = typeof SourceScheduleV2025TypeV2025[keyof typeof SourceScheduleV2025TypeV2025]; - -/** - * - * @export - * @interface SourceSchemasInnerV2025 - */ -export interface SourceSchemasInnerV2025 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceSchemasInnerV2025 - */ - 'type'?: SourceSchemasInnerV2025TypeV2025; - /** - * Schema ID. - * @type {string} - * @memberof SourceSchemasInnerV2025 - */ - 'id'?: string; - /** - * Schema\'s human-readable display name. - * @type {string} - * @memberof SourceSchemasInnerV2025 - */ - 'name'?: string; -} - -export const SourceSchemasInnerV2025TypeV2025 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type SourceSchemasInnerV2025TypeV2025 = typeof SourceSchemasInnerV2025TypeV2025[keyof typeof SourceSchemasInnerV2025TypeV2025]; - -/** - * - * @export - * @interface SourceSubtypeV2025 - */ -export interface SourceSubtypeV2025 { - /** - * Unique identifier for the subtype. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'id'?: string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'sourceId'?: string; - /** - * Technical name of the subtype. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'technicalName': string; - /** - * Display name of the subtype. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'displayName': string; - /** - * Description of the subtype. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'description': string; - /** - * Creation timestamp. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'created'?: string; - /** - * Last modified timestamp. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'modified'?: string; - /** - * Type of the subtype. Either MACHINE OR null. - * @type {string} - * @memberof SourceSubtypeV2025 - */ - 'type'?: string; -} -/** - * - * @export - * @interface SourceSyncJobV2025 - */ -export interface SourceSyncJobV2025 { - /** - * Job ID. - * @type {string} - * @memberof SourceSyncJobV2025 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof SourceSyncJobV2025 - */ - 'status': SourceSyncJobV2025StatusV2025; - /** - * - * @type {SourceSyncPayloadV2025} - * @memberof SourceSyncJobV2025 - */ - 'payload': SourceSyncPayloadV2025; -} - -export const SourceSyncJobV2025StatusV2025 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SourceSyncJobV2025StatusV2025 = typeof SourceSyncJobV2025StatusV2025[keyof typeof SourceSyncJobV2025StatusV2025]; - -/** - * - * @export - * @interface SourceSyncPayloadV2025 - */ -export interface SourceSyncPayloadV2025 { - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2025 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2025 - */ - 'dataJson': string; -} -/** - * Identity who updated the source. - * @export - * @interface SourceUpdatedActorV2025 - */ -export interface SourceUpdatedActorV2025 { - /** - * DTO type of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2025 - */ - 'type': SourceUpdatedActorV2025TypeV2025; - /** - * ID of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2025 - */ - 'id'?: string; - /** - * Display name of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2025 - */ - 'name': string; -} - -export const SourceUpdatedActorV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type SourceUpdatedActorV2025TypeV2025 = typeof SourceUpdatedActorV2025TypeV2025[keyof typeof SourceUpdatedActorV2025TypeV2025]; - -/** - * - * @export - * @interface SourceUpdatedV2025 - */ -export interface SourceUpdatedV2025 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceUpdatedV2025 - */ - 'id': string; - /** - * The user friendly name of the source. - * @type {string} - * @memberof SourceUpdatedV2025 - */ - 'name': string; - /** - * The connection type of the source. - * @type {string} - * @memberof SourceUpdatedV2025 - */ - 'type': string; - /** - * The date and time the source was modified. - * @type {string} - * @memberof SourceUpdatedV2025 - */ - 'modified': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceUpdatedV2025 - */ - 'connector': string; - /** - * - * @type {SourceUpdatedActorV2025} - * @memberof SourceUpdatedV2025 - */ - 'actor': SourceUpdatedActorV2025; -} -/** - * - * @export - * @interface SourceUsageStatusV2025 - */ -export interface SourceUsageStatusV2025 { - /** - * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. - * @type {string} - * @memberof SourceUsageStatusV2025 - */ - 'status'?: SourceUsageStatusV2025StatusV2025; -} - -export const SourceUsageStatusV2025StatusV2025 = { - Complete: 'COMPLETE', - Incomplete: 'INCOMPLETE' -} as const; - -export type SourceUsageStatusV2025StatusV2025 = typeof SourceUsageStatusV2025StatusV2025[keyof typeof SourceUsageStatusV2025StatusV2025]; - -/** - * - * @export - * @interface SourceUsageV2025 - */ -export interface SourceUsageV2025 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof SourceUsageV2025 - */ - 'date'?: string; - /** - * The average number of days that accounts were active within this source, for the month. - * @type {number} - * @memberof SourceUsageV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface SourceV2025 - */ -export interface SourceV2025 { - /** - * Source ID. - * @type {string} - * @memberof SourceV2025 - */ - 'id'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceV2025 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceV2025 - */ - 'description'?: string; - /** - * - * @type {SourceOwnerV2025} - * @memberof SourceV2025 - */ - 'owner': SourceOwnerV2025 | null; - /** - * - * @type {SourceClusterV2025} - * @memberof SourceV2025 - */ - 'cluster'?: SourceClusterV2025 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2025} - * @memberof SourceV2025 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2025 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2025} - * @memberof SourceV2025 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2025 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2025} - * @memberof SourceV2025 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2025; - /** - * - * @type {SourceManagerCorrelationRuleV2025} - * @memberof SourceV2025 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2025 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2025} - * @memberof SourceV2025 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2025 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof SourceV2025 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof SourceV2025 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SourceV2025 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceV2025 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof SourceV2025 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof SourceV2025 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {object} - * @memberof SourceV2025 - */ - 'connectorAttributes'?: object; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof SourceV2025 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof SourceV2025 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2025} - * @memberof SourceV2025 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2025 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof SourceV2025 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof SourceV2025 - */ - 'status'?: SourceV2025StatusV2025; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof SourceV2025 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof SourceV2025 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof SourceV2025 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof SourceV2025 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof SourceV2025 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceV2025 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceV2025 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof SourceV2025 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof SourceV2025 - */ - 'category'?: string | null; -} - -export const SourceV2025FeaturesV2025 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SourceV2025FeaturesV2025 = typeof SourceV2025FeaturesV2025[keyof typeof SourceV2025FeaturesV2025]; -export const SourceV2025StatusV2025 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceV2025StatusV2025 = typeof SourceV2025StatusV2025[keyof typeof SourceV2025StatusV2025]; - -/** - * - * @export - * @interface SpConfigExportJobStatusV2025 - */ -export interface SpConfigExportJobStatusV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'status': SpConfigExportJobStatusV2025StatusV2025; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'type': SpConfigExportJobStatusV2025TypeV2025; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'description'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigExportJobStatusV2025 - */ - 'completed'?: string; -} - -export const SpConfigExportJobStatusV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobStatusV2025StatusV2025 = typeof SpConfigExportJobStatusV2025StatusV2025[keyof typeof SpConfigExportJobStatusV2025StatusV2025]; -export const SpConfigExportJobStatusV2025TypeV2025 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobStatusV2025TypeV2025 = typeof SpConfigExportJobStatusV2025TypeV2025[keyof typeof SpConfigExportJobStatusV2025TypeV2025]; - -/** - * - * @export - * @interface SpConfigExportJobV2025 - */ -export interface SpConfigExportJobV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'status': SpConfigExportJobV2025StatusV2025; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'type': SpConfigExportJobV2025TypeV2025; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobV2025 - */ - 'description'?: string; -} - -export const SpConfigExportJobV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobV2025StatusV2025 = typeof SpConfigExportJobV2025StatusV2025[keyof typeof SpConfigExportJobV2025StatusV2025]; -export const SpConfigExportJobV2025TypeV2025 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobV2025TypeV2025 = typeof SpConfigExportJobV2025TypeV2025[keyof typeof SpConfigExportJobV2025TypeV2025]; - -/** - * Response model for config export download response. - * @export - * @interface SpConfigExportResultsV2025 - */ -export interface SpConfigExportResultsV2025 { - /** - * Current version of the export results object. - * @type {number} - * @memberof SpConfigExportResultsV2025 - */ - 'version'?: number; - /** - * Time the export was completed. - * @type {string} - * @memberof SpConfigExportResultsV2025 - */ - 'timestamp'?: string; - /** - * Name of the tenant where this export originated. - * @type {string} - * @memberof SpConfigExportResultsV2025 - */ - 'tenant'?: string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportResultsV2025 - */ - 'description'?: string; - /** - * - * @type {ExportOptions1V2025} - * @memberof SpConfigExportResultsV2025 - */ - 'options'?: ExportOptions1V2025; - /** - * - * @type {Array} - * @memberof SpConfigExportResultsV2025 - */ - 'objects'?: Array; -} -/** - * - * @export - * @interface SpConfigImportJobStatusV2025 - */ -export interface SpConfigImportJobStatusV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'status': SpConfigImportJobStatusV2025StatusV2025; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'type': SpConfigImportJobStatusV2025TypeV2025; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'modified': string; - /** - * This message contains additional information about the overall status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'message'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigImportJobStatusV2025 - */ - 'completed'?: string; -} - -export const SpConfigImportJobStatusV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigImportJobStatusV2025StatusV2025 = typeof SpConfigImportJobStatusV2025StatusV2025[keyof typeof SpConfigImportJobStatusV2025StatusV2025]; -export const SpConfigImportJobStatusV2025TypeV2025 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigImportJobStatusV2025TypeV2025 = typeof SpConfigImportJobStatusV2025TypeV2025[keyof typeof SpConfigImportJobStatusV2025TypeV2025]; - -/** - * Response Body for Config Import command. - * @export - * @interface SpConfigImportResultsV2025 - */ -export interface SpConfigImportResultsV2025 { - /** - * The results of an object configuration import job. - * @type {{ [key: string]: ObjectImportResult1V2025; }} - * @memberof SpConfigImportResultsV2025 - */ - 'results': { [key: string]: ObjectImportResult1V2025; }; - /** - * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. - * @type {string} - * @memberof SpConfigImportResultsV2025 - */ - 'exportJobId'?: string; -} -/** - * - * @export - * @interface SpConfigJobV2025 - */ -export interface SpConfigJobV2025 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'status': SpConfigJobV2025StatusV2025; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'type': SpConfigJobV2025TypeV2025; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigJobV2025 - */ - 'modified': string; -} - -export const SpConfigJobV2025StatusV2025 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigJobV2025StatusV2025 = typeof SpConfigJobV2025StatusV2025[keyof typeof SpConfigJobV2025StatusV2025]; -export const SpConfigJobV2025TypeV2025 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigJobV2025TypeV2025 = typeof SpConfigJobV2025TypeV2025[keyof typeof SpConfigJobV2025TypeV2025]; - -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessage1V2025 - */ -export interface SpConfigMessage1V2025 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessage1V2025 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessage1V2025 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: object; }} - * @memberof SpConfigMessage1V2025 - */ - 'details': { [key: string]: object; }; -} -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessageV2025 - */ -export interface SpConfigMessageV2025 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessageV2025 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessageV2025 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: any; }} - * @memberof SpConfigMessageV2025 - */ - 'details': { [key: string]: any; }; -} -/** - * Response model for object configuration. - * @export - * @interface SpConfigObjectV2025 - */ -export interface SpConfigObjectV2025 { - /** - * Object type the configuration is for. - * @type {string} - * @memberof SpConfigObjectV2025 - */ - 'objectType'?: string; - /** - * List of JSON paths within an exported object of this type, representing references that must be resolved. - * @type {Array} - * @memberof SpConfigObjectV2025 - */ - 'referenceExtractors'?: Array | null; - /** - * Indicates whether this type of object will be JWS signed and cannot be modified before import. - * @type {boolean} - * @memberof SpConfigObjectV2025 - */ - 'signatureRequired'?: boolean; - /** - * Indicates whether this object type must be always be resolved by ID. - * @type {boolean} - * @memberof SpConfigObjectV2025 - */ - 'alwaysResolveById'?: boolean; - /** - * Indicates whether this is a legacy object. - * @type {boolean} - * @memberof SpConfigObjectV2025 - */ - 'legacyObject'?: boolean; - /** - * Indicates whether there is only one object of this type. - * @type {boolean} - * @memberof SpConfigObjectV2025 - */ - 'onePerTenant'?: boolean; - /** - * Indicates whether the object can be exported or is just a reference object. - * @type {boolean} - * @memberof SpConfigObjectV2025 - */ - 'exportable'?: boolean; - /** - * - * @type {SpConfigRulesV2025} - * @memberof SpConfigObjectV2025 - */ - 'rules'?: SpConfigRulesV2025; -} -/** - * Format of Config Hub object rules. - * @export - * @interface SpConfigRuleV2025 - */ -export interface SpConfigRuleV2025 { - /** - * JSONPath expression denoting the path within the object where a value substitution should be applied. - * @type {string} - * @memberof SpConfigRuleV2025 - */ - 'path'?: string; - /** - * - * @type {SpConfigRuleValueV2025} - * @memberof SpConfigRuleV2025 - */ - 'value'?: SpConfigRuleValueV2025 | null; - /** - * Draft modes the rule will apply to. - * @type {Array} - * @memberof SpConfigRuleV2025 - */ - 'modes'?: Array; -} - -export const SpConfigRuleV2025ModesV2025 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type SpConfigRuleV2025ModesV2025 = typeof SpConfigRuleV2025ModesV2025[keyof typeof SpConfigRuleV2025ModesV2025]; - -/** - * Value to be assigned at the jsonPath location within the object. - * @export - * @interface SpConfigRuleValueV2025 - */ -export interface SpConfigRuleValueV2025 { -} -/** - * Rules to be applied to the config object during the draft process. - * @export - * @interface SpConfigRulesV2025 - */ -export interface SpConfigRulesV2025 { - /** - * - * @type {Array} - * @memberof SpConfigRulesV2025 - */ - 'takeFromTargetRules'?: Array; - /** - * - * @type {Array} - * @memberof SpConfigRulesV2025 - */ - 'defaultRules'?: Array; - /** - * Indicates whether the object can be edited. - * @type {boolean} - * @memberof SpConfigRulesV2025 - */ - 'editable'?: boolean; -} -/** - * - * @export - * @interface SpDetailsV2025 - */ -export interface SpDetailsV2025 { - /** - * Federation protocol role - * @type {string} - * @memberof SpDetailsV2025 - */ - 'role'?: SpDetailsV2025RoleV2025; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof SpDetailsV2025 - */ - 'entityId'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2025 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2025 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2025 - */ - 'legacyAcsUrl'?: string; -} - -export const SpDetailsV2025RoleV2025 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type SpDetailsV2025RoleV2025 = typeof SpDetailsV2025RoleV2025[keyof typeof SpDetailsV2025RoleV2025]; - -/** - * - * @export - * @interface SplitV2025 - */ -export interface SplitV2025 { - /** - * This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - * @type {string} - * @memberof SplitV2025 - */ - 'delimiter': string; - /** - * An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - * @type {string} - * @memberof SplitV2025 - */ - 'index': string; - /** - * A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return \"IndexOutOfBoundsException\" `false` - The transform should return null If not provided, the transform will default to false and return a null - * @type {boolean} - * @memberof SplitV2025 - */ - 'throws'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SplitV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SplitV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Standard Log4j log level - * @export - * @enum {string} - */ - -export const StandardLevelV2025 = { - False: 'false', - Fatal: 'FATAL', - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO', - Debug: 'DEBUG', - Trace: 'TRACE' -} as const; - -export type StandardLevelV2025 = typeof StandardLevelV2025[keyof typeof StandardLevelV2025]; - - -/** - * - * @export - * @interface StartApplicationDiscovery403ResponseOneOfV2025 - */ -export interface StartApplicationDiscovery403ResponseOneOfV2025 { - /** - * Error message when quota is exceeded - * @type {string} - * @memberof StartApplicationDiscovery403ResponseOneOfV2025 - */ - 'error': string; -} -/** - * @type StartApplicationDiscovery403ResponseV2025 - * @export - */ -export type StartApplicationDiscovery403ResponseV2025 = ErrorResponseDtoV2025 | StartApplicationDiscovery403ResponseOneOfV2025; - -/** - * - * @export - * @interface StartInvocationInputV2025 - */ -export interface StartInvocationInputV2025 { - /** - * Trigger ID - * @type {string} - * @memberof StartInvocationInputV2025 - */ - 'triggerId'?: string; - /** - * Trigger input payload. Its schema is defined in the trigger definition. - * @type {object} - * @memberof StartInvocationInputV2025 - */ - 'input'?: object; - /** - * JSON map of invocation metadata - * @type {object} - * @memberof StartInvocationInputV2025 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface StartLauncher200ResponseV2025 - */ -export interface StartLauncher200ResponseV2025 { - /** - * ID of the Interactive Process that was launched - * @type {string} - * @memberof StartLauncher200ResponseV2025 - */ - 'interactiveProcessId': string; -} -/** - * - * @export - * @interface StaticV2025 - */ -export interface StaticV2025 { - /** - * This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - * @type {string} - * @memberof StaticV2025 - */ - 'values': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof StaticV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Response model for connection check, configuration test and ping of source connectors. - * @export - * @interface StatusResponseV2025 - */ -export interface StatusResponseV2025 { - /** - * ID of the source - * @type {string} - * @memberof StatusResponseV2025 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof StatusResponseV2025 - */ - 'name'?: string; - /** - * The status of the health check. - * @type {string} - * @memberof StatusResponseV2025 - */ - 'status'?: StatusResponseV2025StatusV2025; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof StatusResponseV2025 - */ - 'elapsedMillis'?: number; - /** - * The document contains the results of the health check. The schema of this document depends on the type of source used. - * @type {object} - * @memberof StatusResponseV2025 - */ - 'details'?: object; -} - -export const StatusResponseV2025StatusV2025 = { - Success: 'SUCCESS', - Failure: 'FAILURE' -} as const; - -export type StatusResponseV2025StatusV2025 = typeof StatusResponseV2025StatusV2025[keyof typeof StatusResponseV2025StatusV2025]; - -/** - * Full stream configuration returned by create/get/update/replace. - * @export - * @interface StreamConfigResponseV2025 - */ -export interface StreamConfigResponseV2025 { - /** - * Unique stream identifier. - * @type {string} - * @memberof StreamConfigResponseV2025 - */ - 'stream_id'?: string; - /** - * Issuer (transmitter) URL. - * @type {string} - * @memberof StreamConfigResponseV2025 - */ - 'iss'?: string; - /** - * Audience for the stream. - * @type {string} - * @memberof StreamConfigResponseV2025 - */ - 'aud'?: string; - /** - * - * @type {DeliveryResponseV2025} - * @memberof StreamConfigResponseV2025 - */ - 'delivery'?: DeliveryResponseV2025; - /** - * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). - * @type {Array} - * @memberof StreamConfigResponseV2025 - */ - 'events_supported'?: Array; - /** - * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof StreamConfigResponseV2025 - */ - 'events_requested'?: Array; - /** - * Event types currently being delivered (intersection of supported and requested). - * @type {Array} - * @memberof StreamConfigResponseV2025 - */ - 'events_delivered'?: Array; - /** - * Optional stream description. - * @type {string} - * @memberof StreamConfigResponseV2025 - */ - 'description'?: string; - /** - * Inactivity timeout in seconds (optional). - * @type {number} - * @memberof StreamConfigResponseV2025 - */ - 'inactivity_timeout'?: number; - /** - * Minimum verification interval in seconds (optional). - * @type {number} - * @memberof StreamConfigResponseV2025 - */ - 'min_verification_interval'?: number; -} -/** - * Stream status returned by GET/POST /ssf/streams/status. - * @export - * @interface StreamStatusResponseV2025 - */ -export interface StreamStatusResponseV2025 { - /** - * Stream identifier. - * @type {string} - * @memberof StreamStatusResponseV2025 - */ - 'stream_id'?: string; - /** - * Operational status of the stream (enabled, paused, or disabled). - * @type {string} - * @memberof StreamStatusResponseV2025 - */ - 'status'?: StreamStatusResponseV2025StatusV2025; - /** - * Optional reason for the current status (e.g. set when status is updated). - * @type {string} - * @memberof StreamStatusResponseV2025 - */ - 'reason'?: string; -} - -export const StreamStatusResponseV2025StatusV2025 = { - Enabled: 'enabled', - Paused: 'paused', - Disabled: 'disabled' -} as const; - -export type StreamStatusResponseV2025StatusV2025 = typeof StreamStatusResponseV2025StatusV2025[keyof typeof StreamStatusResponseV2025StatusV2025]; - -/** - * - * @export - * @interface SubSearchAggregationSpecificationV2025 - */ -export interface SubSearchAggregationSpecificationV2025 { - /** - * - * @type {NestedAggregationV2025} - * @memberof SubSearchAggregationSpecificationV2025 - */ - 'nested'?: NestedAggregationV2025; - /** - * - * @type {MetricAggregationV2025} - * @memberof SubSearchAggregationSpecificationV2025 - */ - 'metric'?: MetricAggregationV2025; - /** - * - * @type {FilterAggregationV2025} - * @memberof SubSearchAggregationSpecificationV2025 - */ - 'filter'?: FilterAggregationV2025; - /** - * - * @type {BucketAggregationV2025} - * @memberof SubSearchAggregationSpecificationV2025 - */ - 'bucket'?: BucketAggregationV2025; - /** - * - * @type {AggregationsV2025} - * @memberof SubSearchAggregationSpecificationV2025 - */ - 'subAggregation'?: AggregationsV2025; -} -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface SubscriptionPatchRequestInnerV2025 - */ -export interface SubscriptionPatchRequestInnerV2025 { - /** - * The operation to be performed - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2025 - */ - 'op': SubscriptionPatchRequestInnerV2025OpV2025; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2025 - */ - 'path': string; - /** - * - * @type {SubscriptionPatchRequestInnerValueV2025} - * @memberof SubscriptionPatchRequestInnerV2025 - */ - 'value'?: SubscriptionPatchRequestInnerValueV2025; -} - -export const SubscriptionPatchRequestInnerV2025OpV2025 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy' -} as const; - -export type SubscriptionPatchRequestInnerV2025OpV2025 = typeof SubscriptionPatchRequestInnerV2025OpV2025[keyof typeof SubscriptionPatchRequestInnerV2025OpV2025]; - -/** - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - * @interface SubscriptionPatchRequestInnerValueV2025 - */ -export interface SubscriptionPatchRequestInnerValueV2025 { -} -/** - * - * @export - * @interface SubscriptionPostRequestV2025 - */ -export interface SubscriptionPostRequestV2025 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPostRequestV2025 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPostRequestV2025 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionPostRequestV2025 - */ - 'triggerId': string; - /** - * - * @type {SubscriptionTypeV2025} - * @memberof SubscriptionPostRequestV2025 - */ - 'type': SubscriptionTypeV2025; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPostRequestV2025 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2025} - * @memberof SubscriptionPostRequestV2025 - */ - 'httpConfig'?: HttpConfigV2025; - /** - * - * @type {EventBridgeConfigV2025} - * @memberof SubscriptionPostRequestV2025 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2025; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPostRequestV2025 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPostRequestV2025 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubscriptionPutRequestV2025 - */ -export interface SubscriptionPutRequestV2025 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPutRequestV2025 - */ - 'name'?: string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPutRequestV2025 - */ - 'description'?: string; - /** - * - * @type {SubscriptionTypeV2025} - * @memberof SubscriptionPutRequestV2025 - */ - 'type'?: SubscriptionTypeV2025; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPutRequestV2025 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2025} - * @memberof SubscriptionPutRequestV2025 - */ - 'httpConfig'?: HttpConfigV2025; - /** - * - * @type {EventBridgeConfigV2025} - * @memberof SubscriptionPutRequestV2025 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2025; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPutRequestV2025 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPutRequestV2025 - */ - 'filter'?: string; -} - - -/** - * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. - * @export - * @enum {string} - */ - -export const SubscriptionTypeV2025 = { - Http: 'HTTP', - Eventbridge: 'EVENTBRIDGE', - Inline: 'INLINE', - Script: 'SCRIPT', - Workflow: 'WORKFLOW' -} as const; - -export type SubscriptionTypeV2025 = typeof SubscriptionTypeV2025[keyof typeof SubscriptionTypeV2025]; - - -/** - * - * @export - * @interface SubscriptionV2025 - */ -export interface SubscriptionV2025 { - /** - * Subscription ID. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'id': string; - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'triggerId': string; - /** - * Trigger name of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'triggerName': string; - /** - * - * @type {SubscriptionTypeV2025} - * @memberof SubscriptionV2025 - */ - 'type': SubscriptionTypeV2025; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2025} - * @memberof SubscriptionV2025 - */ - 'httpConfig'?: HttpConfigV2025; - /** - * - * @type {EventBridgeConfigV2025} - * @memberof SubscriptionV2025 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2025; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionV2025 - */ - 'enabled': boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionV2025 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubstringV2025 - */ -export interface SubstringV2025 { - /** - * The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data - * @type {number} - * @memberof SubstringV2025 - */ - 'begin': number; - /** - * This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. - * @type {number} - * @memberof SubstringV2025 - */ - 'beginOffset'?: number; - /** - * The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - * @type {number} - * @memberof SubstringV2025 - */ - 'end'?: number; - /** - * This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. - * @type {number} - * @memberof SubstringV2025 - */ - 'endOffset'?: number; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SubstringV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SubstringV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface SummaryResponseV2025 - */ -export interface SummaryResponseV2025 { - /** - * The endpoint of a SailPoint API - * @type {string} - * @memberof SummaryResponseV2025 - */ - 'RequestedUri'?: string; - /** - * Number of calls made to a specific SailPoint API - * @type {number} - * @memberof SummaryResponseV2025 - */ - 'NumberOfCalls'?: number; -} -/** - * - * @export - * @interface Tag1V2025 - */ -export interface Tag1V2025 { - /** - * The unique identifier for the tag. - * @type {number} - * @memberof Tag1V2025 - */ - 'id'?: number; - /** - * The display name or label for the tag. - * @type {string} - * @memberof Tag1V2025 - */ - 'name'?: string | null; -} -/** - * Tagged object\'s category. - * @export - * @interface TagTagCategoryRefsInnerV2025 - */ -export interface TagTagCategoryRefsInnerV2025 { - /** - * DTO type of the tagged object\'s category. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2025 - */ - 'type'?: TagTagCategoryRefsInnerV2025TypeV2025; - /** - * Tagged object\'s ID. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2025 - */ - 'id'?: string; - /** - * Tagged object\'s display name. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2025 - */ - 'name'?: string; -} - -export const TagTagCategoryRefsInnerV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TagTagCategoryRefsInnerV2025TypeV2025 = typeof TagTagCategoryRefsInnerV2025TypeV2025[keyof typeof TagTagCategoryRefsInnerV2025TypeV2025]; - -/** - * - * @export - * @interface TagV2025 - */ -export interface TagV2025 { - /** - * Tag id - * @type {string} - * @memberof TagV2025 - */ - 'id': string; - /** - * Name of the tag. - * @type {string} - * @memberof TagV2025 - */ - 'name': string; - /** - * Date the tag was created. - * @type {string} - * @memberof TagV2025 - */ - 'created': string; - /** - * Date the tag was last modified. - * @type {string} - * @memberof TagV2025 - */ - 'modified': string; - /** - * - * @type {Array} - * @memberof TagV2025 - */ - 'tagCategoryRefs': Array; -} -/** - * - * @export - * @interface TaggedObjectDtoV2025 - */ -export interface TaggedObjectDtoV2025 { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectDtoV2025 - */ - 'type'?: TaggedObjectDtoV2025TypeV2025; - /** - * ID of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2025 - */ - 'id'?: string; - /** - * Human-readable display name of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2025 - */ - 'name'?: string | null; -} - -export const TaggedObjectDtoV2025TypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectDtoV2025TypeV2025 = typeof TaggedObjectDtoV2025TypeV2025[keyof typeof TaggedObjectDtoV2025TypeV2025]; - -/** - * Tagged object. - * @export - * @interface TaggedObjectV2025 - */ -export interface TaggedObjectV2025 { - /** - * - * @type {TaggedObjectDtoV2025} - * @memberof TaggedObjectV2025 - */ - 'objectRef'?: TaggedObjectDtoV2025; - /** - * Labels to be applied to an Object - * @type {Array} - * @memberof TaggedObjectV2025 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface TargetV2025 - */ -export interface TargetV2025 { - /** - * Target ID - * @type {string} - * @memberof TargetV2025 - */ - 'id'?: string; - /** - * Target type - * @type {string} - * @memberof TargetV2025 - */ - 'type'?: TargetV2025TypeV2025 | null; - /** - * Target name - * @type {string} - * @memberof TargetV2025 - */ - 'name'?: string; -} - -export const TargetV2025TypeV2025 = { - Application: 'APPLICATION', - Identity: 'IDENTITY' -} as const; - -export type TargetV2025TypeV2025 = typeof TargetV2025TypeV2025[keyof typeof TargetV2025TypeV2025]; - -/** - * Definition of a type of task, used to invoke tasks - * @export - * @interface TaskDefinitionSummaryV2025 - */ -export interface TaskDefinitionSummaryV2025 { - /** - * System-generated unique ID of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2025 - */ - 'id': string; - /** - * Name of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2025 - */ - 'uniqueName': string; - /** - * Description of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2025 - */ - 'description': string | null; - /** - * Name of the parent of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2025 - */ - 'parentName': string; - /** - * Executor of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2025 - */ - 'executor': string | null; - /** - * Formal parameters of the TaskDefinition, without values - * @type {{ [key: string]: any; }} - * @memberof TaskDefinitionSummaryV2025 - */ - 'arguments': { [key: string]: any; }; -} -/** - * - * @export - * @interface TaskInfoV2025 - */ -export interface TaskInfoV2025 { - /** - * The unique identifier for the task. - * @type {number} - * @memberof TaskInfoV2025 - */ - 'taskId'?: number | null; - /** - * The type or category of the task. - * @type {string} - * @memberof TaskInfoV2025 - */ - 'taskTypeName'?: string | null; - /** - * The start time of the task, represented as epoch seconds. - * @type {number} - * @memberof TaskInfoV2025 - */ - 'startTime'?: number | null; - /** - * The end time of the task, represented as epoch seconds. - * @type {number} - * @memberof TaskInfoV2025 - */ - 'endTime'?: number | null; - /** - * The display name of the task. - * @type {string} - * @memberof TaskInfoV2025 - */ - 'taskName'?: string | null; - /** - * The display name of the user who created the task. - * @type {string} - * @memberof TaskInfoV2025 - */ - 'createdByDisplayName'?: string | null; - /** - * The progress of the task, typically represented as a percentage (0-100). - * @type {number} - * @memberof TaskInfoV2025 - */ - 'progress'?: number; - /** - * The current status of the task (e.g., \"Running\", \"Completed\", \"Failed\"). - * @type {string} - * @memberof TaskInfoV2025 - */ - 'status'?: string | null; - /** - * Additional details or information about the task. - * @type {string} - * @memberof TaskInfoV2025 - */ - 'details'?: string | null; - /** - * The unique identifier of the associated scheduled task, if applicable. - * @type {number} - * @memberof TaskInfoV2025 - */ - 'scheduleTaskId'?: number | null; -} -/** - * - * @export - * @interface TaskResultDetailsMessagesInnerV2025 - */ -export interface TaskResultDetailsMessagesInnerV2025 { - /** - * Type of the message. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2025 - */ - 'type'?: TaskResultDetailsMessagesInnerV2025TypeV2025; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2025 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2025 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2025 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2025 - */ - 'localizedText'?: string; -} - -export const TaskResultDetailsMessagesInnerV2025TypeV2025 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskResultDetailsMessagesInnerV2025TypeV2025 = typeof TaskResultDetailsMessagesInnerV2025TypeV2025[keyof typeof TaskResultDetailsMessagesInnerV2025TypeV2025]; - -/** - * - * @export - * @interface TaskResultDetailsReturnsInnerV2025 - */ -export interface TaskResultDetailsReturnsInnerV2025 { - /** - * Attribute description. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2025 - */ - 'displayLabel'?: string; - /** - * System or database attribute name. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2025 - */ - 'attributeName'?: string; -} -/** - * Details about job or task type, state and lifecycle. - * @export - * @interface TaskResultDetailsV2025 - */ -export interface TaskResultDetailsV2025 { - /** - * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'type'?: TaskResultDetailsV2025TypeV2025; - /** - * Unique task definition identifier. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'id'?: string; - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'reportType'?: TaskResultDetailsV2025ReportTypeV2025; - /** - * Description of the report purpose and/or contents. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'description'?: string; - /** - * Name of the parent task/report if exists. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'parentName'?: string | null; - /** - * Name of the report processing initiator. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'launcher'?: string; - /** - * Report creation date - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'created'?: string; - /** - * Report start date - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'launched'?: string | null; - /** - * Report completion date - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'completed'?: string | null; - /** - * Report completion status. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'completionStatus'?: TaskResultDetailsV2025CompletionStatusV2025 | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof TaskResultDetailsV2025 - */ - 'messages'?: Array; - /** - * Task definition results, if necessary. - * @type {Array} - * @memberof TaskResultDetailsV2025 - */ - 'returns'?: Array; - /** - * Extra attributes map(dictionary) needed for the report. - * @type {object} - * @memberof TaskResultDetailsV2025 - */ - 'attributes'?: object; - /** - * Current report state. - * @type {string} - * @memberof TaskResultDetailsV2025 - */ - 'progress'?: string | null; -} - -export const TaskResultDetailsV2025TypeV2025 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - Mentos: 'MENTOS', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskResultDetailsV2025TypeV2025 = typeof TaskResultDetailsV2025TypeV2025[keyof typeof TaskResultDetailsV2025TypeV2025]; -export const TaskResultDetailsV2025ReportTypeV2025 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type TaskResultDetailsV2025ReportTypeV2025 = typeof TaskResultDetailsV2025ReportTypeV2025[keyof typeof TaskResultDetailsV2025ReportTypeV2025]; -export const TaskResultDetailsV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type TaskResultDetailsV2025CompletionStatusV2025 = typeof TaskResultDetailsV2025CompletionStatusV2025[keyof typeof TaskResultDetailsV2025CompletionStatusV2025]; - -/** - * Task result. - * @export - * @interface TaskResultDtoV2025 - */ -export interface TaskResultDtoV2025 { - /** - * Task result DTO type. - * @type {string} - * @memberof TaskResultDtoV2025 - */ - 'type'?: TaskResultDtoV2025TypeV2025; - /** - * Task result ID. - * @type {string} - * @memberof TaskResultDtoV2025 - */ - 'id'?: string; - /** - * Task result display name. - * @type {string} - * @memberof TaskResultDtoV2025 - */ - 'name'?: string | null; -} - -export const TaskResultDtoV2025TypeV2025 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type TaskResultDtoV2025TypeV2025 = typeof TaskResultDtoV2025TypeV2025[keyof typeof TaskResultDtoV2025TypeV2025]; - -/** - * - * @export - * @interface TaskResultResponseV2025 - */ -export interface TaskResultResponseV2025 { - /** - * the type of response reference - * @type {string} - * @memberof TaskResultResponseV2025 - */ - 'type'?: string; - /** - * the task ID - * @type {string} - * @memberof TaskResultResponseV2025 - */ - 'id'?: string; - /** - * the task name (not used in this endpoint, always null) - * @type {string} - * @memberof TaskResultResponseV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface TaskResultSimplifiedV2025 - */ -export interface TaskResultSimplifiedV2025 { - /** - * Task identifier - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'id'?: string; - /** - * Task name - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'name'?: string; - /** - * Task description - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'description'?: string; - /** - * User or process who launched the task - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'launcher'?: string; - /** - * Date time of completion - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'completed'?: string; - /** - * Date time when the task was launched - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'launched'?: string; - /** - * Task result status - * @type {string} - * @memberof TaskResultSimplifiedV2025 - */ - 'completionStatus'?: TaskResultSimplifiedV2025CompletionStatusV2025; -} - -export const TaskResultSimplifiedV2025CompletionStatusV2025 = { - Success: 'Success', - Warning: 'Warning', - Error: 'Error', - Terminated: 'Terminated', - TempError: 'TempError' -} as const; - -export type TaskResultSimplifiedV2025CompletionStatusV2025 = typeof TaskResultSimplifiedV2025CompletionStatusV2025[keyof typeof TaskResultSimplifiedV2025CompletionStatusV2025]; - -/** - * Task return details - * @export - * @interface TaskReturnDetailsV2025 - */ -export interface TaskReturnDetailsV2025 { - /** - * Display name of the TaskReturnDetails - * @type {string} - * @memberof TaskReturnDetailsV2025 - */ - 'name': string; - /** - * Attribute the TaskReturnDetails is for - * @type {string} - * @memberof TaskReturnDetailsV2025 - */ - 'attributeName': string; -} -/** - * - * @export - * @interface TaskStatusMessageParametersInnerV2025 - */ -export interface TaskStatusMessageParametersInnerV2025 { -} -/** - * TaskStatus Message - * @export - * @interface TaskStatusMessageV2025 - */ -export interface TaskStatusMessageV2025 { - /** - * Type of the message - * @type {string} - * @memberof TaskStatusMessageV2025 - */ - 'type': TaskStatusMessageV2025TypeV2025; - /** - * - * @type {LocalizedMessageV2025} - * @memberof TaskStatusMessageV2025 - */ - 'localizedText': LocalizedMessageV2025 | null; - /** - * Key of the message - * @type {string} - * @memberof TaskStatusMessageV2025 - */ - 'key': string; - /** - * Message parameters for internationalization - * @type {Array} - * @memberof TaskStatusMessageV2025 - */ - 'parameters': Array | null; -} - -export const TaskStatusMessageV2025TypeV2025 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskStatusMessageV2025TypeV2025 = typeof TaskStatusMessageV2025TypeV2025[keyof typeof TaskStatusMessageV2025TypeV2025]; - -/** - * Details and current status of a specific task - * @export - * @interface TaskStatusV2025 - */ -export interface TaskStatusV2025 { - /** - * System-generated unique ID of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'id': string; - /** - * Type of task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'type': TaskStatusV2025TypeV2025; - /** - * Name of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'uniqueName': string; - /** - * Description of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'description': string; - /** - * Name of the parent of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'parentName': string | null; - /** - * Service to execute the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'launcher': string; - /** - * - * @type {TargetV2025} - * @memberof TaskStatusV2025 - */ - 'target'?: TargetV2025 | null; - /** - * Creation date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'created': string; - /** - * Last modification date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'modified': string | null; - /** - * Launch date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'launched': string | null; - /** - * Completion date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'completed': string | null; - /** - * Completion status of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'completionStatus': TaskStatusV2025CompletionStatusV2025 | null; - /** - * Messages associated with the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2025 - */ - 'messages': Array; - /** - * Return values from the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2025 - */ - 'returns': Array; - /** - * Attributes of the task this TaskStatus represents - * @type {{ [key: string]: any; }} - * @memberof TaskStatusV2025 - */ - 'attributes': { [key: string]: any; }; - /** - * Current progress of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2025 - */ - 'progress': string | null; - /** - * Current percentage completion of the task this TaskStatus represents - * @type {number} - * @memberof TaskStatusV2025 - */ - 'percentComplete': number; - /** - * - * @type {TaskDefinitionSummaryV2025} - * @memberof TaskStatusV2025 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2025; -} - -export const TaskStatusV2025TypeV2025 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskStatusV2025TypeV2025 = typeof TaskStatusV2025TypeV2025[keyof typeof TaskStatusV2025TypeV2025]; -export const TaskStatusV2025CompletionStatusV2025 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type TaskStatusV2025CompletionStatusV2025 = typeof TaskStatusV2025CompletionStatusV2025[keyof typeof TaskStatusV2025CompletionStatusV2025]; - -/** - * - * @export - * @interface TemplateBulkDeleteDtoV2025 - */ -export interface TemplateBulkDeleteDtoV2025 { - /** - * The template key to delete - * @type {string} - * @memberof TemplateBulkDeleteDtoV2025 - */ - 'key': string; - /** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @type {string} - * @memberof TemplateBulkDeleteDtoV2025 - */ - 'medium'?: TemplateBulkDeleteDtoV2025MediumV2025; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateBulkDeleteDtoV2025 - */ - 'locale'?: string; -} - -export const TemplateBulkDeleteDtoV2025MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateBulkDeleteDtoV2025MediumV2025 = typeof TemplateBulkDeleteDtoV2025MediumV2025[keyof typeof TemplateBulkDeleteDtoV2025MediumV2025]; - -/** - * - * @export - * @interface TemplateDtoDefaultV2025 - */ -export interface TemplateDtoDefaultV2025 { - /** - * The key of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'key'?: string; - /** - * The name of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'medium'?: TemplateDtoDefaultV2025MediumV2025; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'locale'?: string; - /** - * The subject of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'subject'?: string | null; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2025 - * @deprecated - */ - 'header'?: string | null; - /** - * The body of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2025 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'from'?: string | null; - /** - * The \"Reply To\" field of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'replyTo'?: string | null; - /** - * The description of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2025 - */ - 'description'?: string | null; - /** - * - * @type {TemplateSlackV2025} - * @memberof TemplateDtoDefaultV2025 - */ - 'slackTemplate'?: TemplateSlackV2025 | null; - /** - * - * @type {TemplateTeamsV2025} - * @memberof TemplateDtoDefaultV2025 - */ - 'teamsTemplate'?: TemplateTeamsV2025 | null; -} - -export const TemplateDtoDefaultV2025MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoDefaultV2025MediumV2025 = typeof TemplateDtoDefaultV2025MediumV2025[keyof typeof TemplateDtoDefaultV2025MediumV2025]; - -/** - * - * @export - * @interface TemplateDtoSlackTemplateV2025 - */ -export interface TemplateDtoSlackTemplateV2025 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2025} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2025 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2025} - * @memberof TemplateDtoSlackTemplateV2025 - */ - 'customFields'?: TemplateSlackCustomFieldsV2025 | null; -} -/** - * - * @export - * @interface TemplateDtoTeamsTemplateV2025 - */ -export interface TemplateDtoTeamsTemplateV2025 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2025} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2025 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2025} - * @memberof TemplateDtoTeamsTemplateV2025 - */ - 'customFields'?: TemplateSlackCustomFieldsV2025 | null; -} -/** - * - * @export - * @interface TemplateDtoV2025 - */ -export interface TemplateDtoV2025 { - /** - * The key of the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'key': string; - /** - * The name of the Task Manager Subscription - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'medium': TemplateDtoV2025MediumV2025; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'locale': string; - /** - * The subject line in the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'subject'?: string; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2025 - * @deprecated - */ - 'header'?: string | null; - /** - * The body in the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2025 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address in the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'from'?: string; - /** - * The \"Reply To\" line in the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'replyTo'?: string; - /** - * The description in the template - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'description'?: string; - /** - * This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'id'?: string; - /** - * The time when this template is created. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'created'?: string; - /** - * The time when this template was last modified. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2025 - */ - 'modified'?: string; - /** - * - * @type {TemplateDtoSlackTemplateV2025} - * @memberof TemplateDtoV2025 - */ - 'slackTemplate'?: TemplateDtoSlackTemplateV2025; - /** - * - * @type {TemplateDtoTeamsTemplateV2025} - * @memberof TemplateDtoV2025 - */ - 'teamsTemplate'?: TemplateDtoTeamsTemplateV2025; -} - -export const TemplateDtoV2025MediumV2025 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoV2025MediumV2025 = typeof TemplateDtoV2025MediumV2025[keyof typeof TemplateDtoV2025MediumV2025]; - -/** - * - * @export - * @interface TemplateSlackAutoApprovalDataV2025 - */ -export interface TemplateSlackAutoApprovalDataV2025 { - /** - * Whether the request was auto-approved - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2025 - */ - 'isAutoApproved'?: string | null; - /** - * The item ID - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2025 - */ - 'itemId'?: string | null; - /** - * The item type - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2025 - */ - 'itemType'?: string | null; - /** - * JSON message for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2025 - */ - 'autoApprovalMessageJSON'?: string | null; - /** - * Title for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2025 - */ - 'autoApprovalTitle'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackCustomFieldsV2025 - */ -export interface TemplateSlackCustomFieldsV2025 { - /** - * The type of request - * @type {string} - * @memberof TemplateSlackCustomFieldsV2025 - */ - 'requestType'?: string | null; - /** - * Whether the request contains a deny action - * @type {string} - * @memberof TemplateSlackCustomFieldsV2025 - */ - 'containsDeny'?: string | null; - /** - * The campaign ID - * @type {string} - * @memberof TemplateSlackCustomFieldsV2025 - */ - 'campaignId'?: string | null; - /** - * The campaign status - * @type {string} - * @memberof TemplateSlackCustomFieldsV2025 - */ - 'campaignStatus'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackV2025 - */ -export interface TemplateSlackV2025 { - /** - * The template key - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateSlackV2025 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateSlackV2025 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2025} - * @memberof TemplateSlackV2025 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2025 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2025} - * @memberof TemplateSlackV2025 - */ - 'customFields'?: TemplateSlackCustomFieldsV2025 | null; -} -/** - * - * @export - * @interface TemplateTeamsV2025 - */ -export interface TemplateTeamsV2025 { - /** - * The template key - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateTeamsV2025 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateTeamsV2025 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2025} - * @memberof TemplateTeamsV2025 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2025 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2025} - * @memberof TemplateTeamsV2025 - */ - 'customFields'?: TemplateSlackCustomFieldsV2025 | null; -} -/** - * Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) - * @export - * @interface TenantConfigurationDetailsV2025 - */ -export interface TenantConfigurationDetailsV2025 { - /** - * Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. - * @type {boolean} - * @memberof TenantConfigurationDetailsV2025 - */ - 'disabled'?: boolean | null; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationRequestV2025 - */ -export interface TenantConfigurationRequestV2025 { - /** - * - * @type {TenantConfigurationDetailsV2025} - * @memberof TenantConfigurationRequestV2025 - */ - 'configDetails'?: TenantConfigurationDetailsV2025; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationResponseV2025 - */ -export interface TenantConfigurationResponseV2025 { - /** - * - * @type {AuditDetailsV2025} - * @memberof TenantConfigurationResponseV2025 - */ - 'auditDetails'?: AuditDetailsV2025; - /** - * - * @type {TenantConfigurationDetailsV2025} - * @memberof TenantConfigurationResponseV2025 - */ - 'configDetails'?: TenantConfigurationDetailsV2025; -} -/** - * - * @export - * @interface TenantUiMetadataItemResponseV2025 - */ -export interface TenantUiMetadataItemResponseV2025 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemResponseV2025 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2025 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2025 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantUiMetadataItemUpdateRequestV2025 - */ -export interface TenantUiMetadataItemUpdateRequestV2025 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2025 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2025 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2025 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantV2025 - */ -export interface TenantV2025 { - /** - * The unique identifier for the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'id'?: string; - /** - * Abbreviated name of the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'name'?: string; - /** - * Human-readable name of the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'fullName'?: string; - /** - * Deployment pod for the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'pod'?: string; - /** - * Deployment region for the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'region'?: string; - /** - * Description of the Tenant - * @type {string} - * @memberof TenantV2025 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof TenantV2025 - */ - 'products'?: Array; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflow200ResponseV2025 - */ -export interface TestExternalExecuteWorkflow200ResponseV2025 { - /** - * The input that was received - * @type {object} - * @memberof TestExternalExecuteWorkflow200ResponseV2025 - */ - 'payload'?: object; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflowRequestV2025 - */ -export interface TestExternalExecuteWorkflowRequestV2025 { - /** - * The test input for the workflow - * @type {object} - * @memberof TestExternalExecuteWorkflowRequestV2025 - */ - 'input'?: object; -} -/** - * - * @export - * @interface TestInvocationV2025 - */ -export interface TestInvocationV2025 { - /** - * Trigger ID - * @type {string} - * @memberof TestInvocationV2025 - */ - 'triggerId': string; - /** - * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. - * @type {object} - * @memberof TestInvocationV2025 - */ - 'input'?: object; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof TestInvocationV2025 - */ - 'contentJson': object; - /** - * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. - * @type {Array} - * @memberof TestInvocationV2025 - */ - 'subscriptionIds'?: Array; -} -/** - * - * @export - * @interface TestSourceConnectionMultihost200ResponseV2025 - */ -export interface TestSourceConnectionMultihost200ResponseV2025 { - /** - * Source\'s test connection status. - * @type {boolean} - * @memberof TestSourceConnectionMultihost200ResponseV2025 - */ - 'success'?: boolean; - /** - * Source\'s test connection message. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2025 - */ - 'message'?: string; - /** - * Source\'s test connection timing. - * @type {number} - * @memberof TestSourceConnectionMultihost200ResponseV2025 - */ - 'timing'?: number; - /** - * Source\'s human-readable result type. - * @type {object} - * @memberof TestSourceConnectionMultihost200ResponseV2025 - */ - 'resultType'?: TestSourceConnectionMultihost200ResponseV2025ResultTypeV2025; - /** - * Source\'s human-readable test connection details. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2025 - */ - 'testConnectionDetails'?: string; -} - -export const TestSourceConnectionMultihost200ResponseV2025ResultTypeV2025 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type TestSourceConnectionMultihost200ResponseV2025ResultTypeV2025 = typeof TestSourceConnectionMultihost200ResponseV2025ResultTypeV2025[keyof typeof TestSourceConnectionMultihost200ResponseV2025ResultTypeV2025]; - -/** - * - * @export - * @interface TestWorkflow200ResponseV2025 - */ -export interface TestWorkflow200ResponseV2025 { - /** - * The workflow execution id - * @type {string} - * @memberof TestWorkflow200ResponseV2025 - */ - 'workflowExecutionId'?: string; -} -/** - * - * @export - * @interface TestWorkflowRequestV2025 - */ -export interface TestWorkflowRequestV2025 { - /** - * The test input for the workflow. - * @type {object} - * @memberof TestWorkflowRequestV2025 - */ - 'input': object; -} -/** - * Query parameters used to construct an Elasticsearch text query object. - * @export - * @interface TextQueryV2025 - */ -export interface TextQueryV2025 { - /** - * Words or characters that specify a particular thing to be searched for. - * @type {Array} - * @memberof TextQueryV2025 - */ - 'terms': Array; - /** - * The fields to be searched. - * @type {Array} - * @memberof TextQueryV2025 - */ - 'fields': Array; - /** - * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - * @type {boolean} - * @memberof TextQueryV2025 - */ - 'matchAny'?: boolean; - /** - * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - * @type {boolean} - * @memberof TextQueryV2025 - */ - 'contains'?: boolean; -} -/** - * @type TransformAttributesV2025 - * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - * @export - */ -export type TransformAttributesV2025 = AccountAttributeV2025 | Base64DecodeV2025 | Base64EncodeV2025 | ConcatenationV2025 | ConditionalV2025 | DateCompareV2025 | DateFormatV2025 | DateMathV2025 | DecomposeDiacriticalMarksV2025 | E164phoneV2025 | FirstValidV2025 | ISO3166V2025 | IdentityAttribute1V2025 | IndexOfV2025 | LeftPadV2025 | LookupV2025 | LowerV2025 | NameNormalizerV2025 | RandomAlphaNumericV2025 | RandomNumericV2025 | ReferenceV2025 | ReplaceAllV2025 | ReplaceV2025 | RightPadV2025 | RuleV2025 | SplitV2025 | StaticV2025 | SubstringV2025 | TrimV2025 | UUIDGeneratorV2025 | UpperV2025; - -/** - * - * @export - * @interface TransformDefinitionV2025 - */ -export interface TransformDefinitionV2025 { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinitionV2025 - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinitionV2025 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TransformReadV2025 - */ -export interface TransformReadV2025 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformReadV2025 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformReadV2025 - */ - 'type': TransformReadV2025TypeV2025; - /** - * - * @type {TransformAttributesV2025} - * @memberof TransformReadV2025 - */ - 'attributes': TransformAttributesV2025 | null; - /** - * Unique ID of this transform - * @type {string} - * @memberof TransformReadV2025 - */ - 'id': string; - /** - * Indicates whether this is an internal SailPoint-created transform or a customer-created transform - * @type {boolean} - * @memberof TransformReadV2025 - */ - 'internal': boolean; -} - -export const TransformReadV2025TypeV2025 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformReadV2025TypeV2025 = typeof TransformReadV2025TypeV2025[keyof typeof TransformReadV2025TypeV2025]; - -/** - * - * @export - * @interface TransformRuleV2025 - */ -export interface TransformRuleV2025 { - /** - * This is the name of the Transform rule that needs to be invoked by the transform - * @type {string} - * @memberof TransformRuleV2025 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TransformRuleV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * The representation of an internally- or customer-defined transform. - * @export - * @interface TransformV2025 - */ -export interface TransformV2025 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformV2025 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformV2025 - */ - 'type': TransformV2025TypeV2025; - /** - * - * @type {TransformAttributesV2025} - * @memberof TransformV2025 - */ - 'attributes': TransformAttributesV2025 | null; -} - -export const TransformV2025TypeV2025 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformV2025TypeV2025 = typeof TransformV2025TypeV2025[keyof typeof TransformV2025TypeV2025]; - -/** - * - * @export - * @interface TranslationMessageV2025 - */ -export interface TranslationMessageV2025 { - /** - * The key of the translation message - * @type {string} - * @memberof TranslationMessageV2025 - */ - 'key'?: string; - /** - * The values corresponding to the translation messages - * @type {Array} - * @memberof TranslationMessageV2025 - */ - 'values'?: Array; -} -/** - * SSF transmitter discovery metadata per the SSF specification. - * @export - * @interface TransmitterMetadataV2025 - */ -export interface TransmitterMetadataV2025 { - /** - * Version of the SSF specification supported. - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'spec_version'?: string; - /** - * Base URL of the transmitter (issuer). - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'issuer'?: string; - /** - * URL of the transmitter\'s JSON Web Key Set. - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'jwks_uri'?: string; - /** - * Supported delivery methods (e.g. push URN). - * @type {Array} - * @memberof TransmitterMetadataV2025 - */ - 'delivery_methods_supported'?: Array; - /** - * Endpoint for stream configuration (create, read, update, replace, delete). - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'configuration_endpoint'?: string; - /** - * Endpoint for reading and updating stream status. - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'status_endpoint'?: string; - /** - * Endpoint for receiver verification. - * @type {string} - * @memberof TransmitterMetadataV2025 - */ - 'verification_endpoint'?: string; - /** - * Supported authorization schemes (e.g. OAuth2, Bearer). - * @type {Array} - * @memberof TransmitterMetadataV2025 - */ - 'authorization_schemes'?: Array; -} -/** - * @type TriggerExampleInputV2025 - * An example of the JSON payload that will be sent by the trigger to the subscribed service. - * @export - */ -export type TriggerExampleInputV2025 = AccessRequestDynamicApproverV2025 | AccessRequestPostApprovalV2025 | AccessRequestPreApprovalV2025 | AccountAggregationCompletedV2025 | AccountAttributesChangedV2025 | AccountCorrelatedV2025 | AccountCreatedV2025 | AccountDeletedV2025 | AccountUncorrelatedV2025 | AccountUpdatedV2025 | AccountsCollectedForAggregationV2025 | CampaignActivatedV2025 | CampaignEndedV2025 | CampaignGeneratedV2025 | CertificationSignedOffV2025 | IdentityAttributesChangedV2025 | IdentityCreatedV2025 | IdentityDeletedV2025 | MachineIdentityCreatedV2025 | MachineIdentityDeletedV2025 | MachineIdentityUpdatedV2025 | ProvisioningCompletedV2025 | SavedSearchCompleteV2025 | SourceAccountCreatedV2025 | SourceAccountDeletedV2025 | SourceAccountUpdatedV2025 | SourceCreatedV2025 | SourceDeletedV2025 | SourceUpdatedV2025 | VAClusterStatusChangeEventV2025; - -/** - * @type TriggerExampleOutputV2025 - * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. - * @export - */ -export type TriggerExampleOutputV2025 = AccessRequestDynamicApprover1V2025 | AccessRequestPreApproval1V2025; - -/** - * The type of trigger. - * @export - * @enum {string} - */ - -export const TriggerTypeV2025 = { - RequestResponse: 'REQUEST_RESPONSE', - FireAndForget: 'FIRE_AND_FORGET' -} as const; - -export type TriggerTypeV2025 = typeof TriggerTypeV2025[keyof typeof TriggerTypeV2025]; - - -/** - * - * @export - * @interface TriggerV2025 - */ -export interface TriggerV2025 { - /** - * Unique identifier of the trigger. - * @type {string} - * @memberof TriggerV2025 - */ - 'id': string; - /** - * Trigger Name. - * @type {string} - * @memberof TriggerV2025 - */ - 'name': string; - /** - * - * @type {TriggerTypeV2025} - * @memberof TriggerV2025 - */ - 'type': TriggerTypeV2025; - /** - * Trigger Description. - * @type {string} - * @memberof TriggerV2025 - */ - 'description'?: string; - /** - * The JSON schema of the payload that will be sent by the trigger to the subscribed service. - * @type {string} - * @memberof TriggerV2025 - */ - 'inputSchema': string; - /** - * - * @type {TriggerExampleInputV2025} - * @memberof TriggerV2025 - */ - 'exampleInput': TriggerExampleInputV2025; - /** - * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. - * @type {string} - * @memberof TriggerV2025 - */ - 'outputSchema'?: string | null; - /** - * - * @type {TriggerExampleOutputV2025} - * @memberof TriggerV2025 - */ - 'exampleOutput'?: TriggerExampleOutputV2025 | null; -} - - -/** - * - * @export - * @interface TrimV2025 - */ -export interface TrimV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TrimV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof TrimV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" - * @export - * @interface TypeAheadQueryV2025 - */ -export interface TypeAheadQueryV2025 { - /** - * The type ahead query string used to construct a phrase prefix match query. - * @type {string} - * @memberof TypeAheadQueryV2025 - */ - 'query': string; - /** - * The field on which to perform the type ahead search. - * @type {string} - * @memberof TypeAheadQueryV2025 - */ - 'field': string; - /** - * The nested type. - * @type {string} - * @memberof TypeAheadQueryV2025 - */ - 'nestedType'?: string; - /** - * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. - * @type {number} - * @memberof TypeAheadQueryV2025 - */ - 'maxExpansions'?: number; - /** - * The max amount of records the search will return. - * @type {number} - * @memberof TypeAheadQueryV2025 - */ - 'size'?: number; - /** - * The sort order of the returned records. - * @type {string} - * @memberof TypeAheadQueryV2025 - */ - 'sort'?: string; - /** - * The flag that defines the sort type, by count or value. - * @type {boolean} - * @memberof TypeAheadQueryV2025 - */ - 'sortByValue'?: boolean; -} -/** - * A typed reference to the object. - * @export - * @interface TypedReferenceV2025 - */ -export interface TypedReferenceV2025 { - /** - * - * @type {DtoTypeV2025} - * @memberof TypedReferenceV2025 - */ - 'type': DtoTypeV2025; - /** - * The id of the object. - * @type {string} - * @memberof TypedReferenceV2025 - */ - 'id': string; -} - - -/** - * - * @export - * @interface UUIDGeneratorV2025 - */ -export interface UUIDGeneratorV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UUIDGeneratorV2025 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) - * @export - * @interface UncorrelatedAccountsReportArgumentsV2025 - */ -export interface UncorrelatedAccountsReportArgumentsV2025 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof UncorrelatedAccountsReportArgumentsV2025 - */ - 'selectedFormats'?: Array; -} - -export const UncorrelatedAccountsReportArgumentsV2025SelectedFormatsV2025 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type UncorrelatedAccountsReportArgumentsV2025SelectedFormatsV2025 = typeof UncorrelatedAccountsReportArgumentsV2025SelectedFormatsV2025[keyof typeof UncorrelatedAccountsReportArgumentsV2025SelectedFormatsV2025]; - -/** - * - * @export - * @interface UpdateAccessProfilesInBulk412ResponseV2025 - */ -export interface UpdateAccessProfilesInBulk412ResponseV2025 { - /** - * A message describing the error - * @type {object} - * @memberof UpdateAccessProfilesInBulk412ResponseV2025 - */ - 'message'?: object; -} -/** - * - * @export - * @interface UpdateDetailV2025 - */ -export interface UpdateDetailV2025 { - /** - * The detailed message for an update. Typically the relevent error message when status is error. - * @type {string} - * @memberof UpdateDetailV2025 - */ - 'message'?: string; - /** - * The connector script name - * @type {string} - * @memberof UpdateDetailV2025 - */ - 'scriptName'?: string; - /** - * The list of updated files supported by the connector - * @type {Array} - * @memberof UpdateDetailV2025 - */ - 'updatedFiles'?: Array | null; - /** - * The connector update status - * @type {string} - * @memberof UpdateDetailV2025 - */ - 'status'?: UpdateDetailV2025StatusV2025; -} - -export const UpdateDetailV2025StatusV2025 = { - Error: 'ERROR', - Updated: 'UPDATED', - Unchanged: 'UNCHANGED', - Skipped: 'SKIPPED' -} as const; - -export type UpdateDetailV2025StatusV2025 = typeof UpdateDetailV2025StatusV2025[keyof typeof UpdateDetailV2025StatusV2025]; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface UpdateMultiHostSourcesRequestInnerV2025 - */ -export interface UpdateMultiHostSourcesRequestInnerV2025 { - /** - * The operation to be performed - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2025 - */ - 'op': UpdateMultiHostSourcesRequestInnerV2025OpV2025; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2025 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2025} - * @memberof UpdateMultiHostSourcesRequestInnerV2025 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2025; -} - -export const UpdateMultiHostSourcesRequestInnerV2025OpV2025 = { - Add: 'add', - Replace: 'replace' -} as const; - -export type UpdateMultiHostSourcesRequestInnerV2025OpV2025 = typeof UpdateMultiHostSourcesRequestInnerV2025OpV2025[keyof typeof UpdateMultiHostSourcesRequestInnerV2025OpV2025]; - -/** - * @type UpdateMultiHostSourcesRequestInnerValueV2025 - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - */ -export type UpdateMultiHostSourcesRequestInnerValueV2025 = Array | boolean | number | object | string; - -/** - * - * @export - * @interface UpdateScheduleRequestV2025 - */ -export interface UpdateScheduleRequestV2025 { - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof UpdateScheduleRequestV2025 - */ - 'taskTypeName'?: string | null; - /** - * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. - * @type {string} - * @memberof UpdateScheduleRequestV2025 - */ - 'scheduleType'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof UpdateScheduleRequestV2025 - */ - 'interval'?: number | null; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof UpdateScheduleRequestV2025 - */ - 'scheduleTaskName'?: string | null; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof UpdateScheduleRequestV2025 - */ - 'startTime'?: number; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof UpdateScheduleRequestV2025 - */ - 'endTime'?: number; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof UpdateScheduleRequestV2025 - */ - 'daysOfWeek'?: Array | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof UpdateScheduleRequestV2025 - */ - 'active'?: boolean; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof UpdateScheduleRequestV2025 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof UpdateScheduleRequestV2025 - */ - 'applicationId'?: number | null; -} -/** - * Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt. - * @export - * @interface UpdateStreamConfigResponseV2025 - */ -export interface UpdateStreamConfigResponseV2025 { - /** - * Unique stream identifier. - * @type {string} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'stream_id'?: string; - /** - * Issuer (transmitter) URL. - * @type {string} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'iss'?: string; - /** - * Audience for the stream. - * @type {string} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'aud'?: string; - /** - * - * @type {DeliveryResponseV2025} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'delivery'?: DeliveryResponseV2025; - /** - * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'events_supported'?: Array; - /** - * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'events_requested'?: Array; - /** - * Event types currently being delivered (intersection of supported and requested). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'events_delivered'?: Array; - /** - * Optional stream description. - * @type {string} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'description'?: string; - /** - * Inactivity timeout in seconds (optional). - * @type {number} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'inactivity_timeout'?: number; - /** - * Minimum verification interval in seconds (optional). - * @type {number} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'min_verification_interval'?: number; - /** - * Timestamp of the last configuration update. - * @type {string} - * @memberof UpdateStreamConfigResponseV2025 - */ - 'updatedAt'?: string; -} -/** - * Request body for PATCH /ssf/streams (partial update). - * @export - * @interface UpdateStreamConfigurationRequestV2025 - */ -export interface UpdateStreamConfigurationRequestV2025 { - /** - * ID of the stream to update. - * @type {string} - * @memberof UpdateStreamConfigurationRequestV2025 - */ - 'stream_id': string; - /** - * - * @type {DeliveryRequestV2025} - * @memberof UpdateStreamConfigurationRequestV2025 - */ - 'delivery'?: DeliveryRequestV2025; - /** - * Event types the receiver wants. Use CAEP event-type URIs. - * @type {Array} - * @memberof UpdateStreamConfigurationRequestV2025 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof UpdateStreamConfigurationRequestV2025 - */ - 'description'?: string; -} -/** - * Request body for POST /ssf/streams/status. - * @export - * @interface UpdateStreamStatusRequestV2025 - */ -export interface UpdateStreamStatusRequestV2025 { - /** - * ID of the stream whose status to update. - * @type {string} - * @memberof UpdateStreamStatusRequestV2025 - */ - 'stream_id': string; - /** - * Desired stream status. - * @type {string} - * @memberof UpdateStreamStatusRequestV2025 - */ - 'status': UpdateStreamStatusRequestV2025StatusV2025; - /** - * Optional reason for the status change. - * @type {string} - * @memberof UpdateStreamStatusRequestV2025 - */ - 'reason'?: string; -} - -export const UpdateStreamStatusRequestV2025StatusV2025 = { - Enabled: 'enabled', - Paused: 'paused', - Disabled: 'disabled' -} as const; - -export type UpdateStreamStatusRequestV2025StatusV2025 = typeof UpdateStreamStatusRequestV2025StatusV2025[keyof typeof UpdateStreamStatusRequestV2025StatusV2025]; - -/** - * - * @export - * @interface UpperV2025 - */ -export interface UpperV2025 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UpperV2025 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof UpperV2025 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @export - * @enum {string} - */ - -export const UsageTypeV2025 = { - Create: 'CREATE', - Update: 'UPDATE', - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE', - Assign: 'ASSIGN', - Unassign: 'UNASSIGN', - CreateGroup: 'CREATE_GROUP', - UpdateGroup: 'UPDATE_GROUP', - DeleteGroup: 'DELETE_GROUP', - Register: 'REGISTER', - CreateIdentity: 'CREATE_IDENTITY', - UpdateIdentity: 'UPDATE_IDENTITY', - EditGroup: 'EDIT_GROUP', - Unlock: 'UNLOCK', - ChangePassword: 'CHANGE_PASSWORD' -} as const; - -export type UsageTypeV2025 = typeof UsageTypeV2025[keyof typeof UsageTypeV2025]; - - -/** - * - * @export - * @interface UserAppAccountV2025 - */ -export interface UserAppAccountV2025 { - /** - * the account ID - * @type {string} - * @memberof UserAppAccountV2025 - */ - 'id'?: string; - /** - * It will always be \"ACCOUNT\" - * @type {string} - * @memberof UserAppAccountV2025 - */ - 'type'?: string; - /** - * the account name - * @type {string} - * @memberof UserAppAccountV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppOwnerV2025 - */ -export interface UserAppOwnerV2025 { - /** - * The identity ID - * @type {string} - * @memberof UserAppOwnerV2025 - */ - 'id'?: string; - /** - * It will always be \"IDENTITY\" - * @type {string} - * @memberof UserAppOwnerV2025 - */ - 'type'?: string; - /** - * The identity name - * @type {string} - * @memberof UserAppOwnerV2025 - */ - 'name'?: string; - /** - * The identity alias - * @type {string} - * @memberof UserAppOwnerV2025 - */ - 'alias'?: string; -} -/** - * - * @export - * @interface UserAppSourceAppV2025 - */ -export interface UserAppSourceAppV2025 { - /** - * the source app ID - * @type {string} - * @memberof UserAppSourceAppV2025 - */ - 'id'?: string; - /** - * It will always be \"APPLICATION\" - * @type {string} - * @memberof UserAppSourceAppV2025 - */ - 'type'?: string; - /** - * the source app name - * @type {string} - * @memberof UserAppSourceAppV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppSourceV2025 - */ -export interface UserAppSourceV2025 { - /** - * the source ID - * @type {string} - * @memberof UserAppSourceV2025 - */ - 'id'?: string; - /** - * It will always be \"SOURCE\" - * @type {string} - * @memberof UserAppSourceV2025 - */ - 'type'?: string; - /** - * the source name - * @type {string} - * @memberof UserAppSourceV2025 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppV2025 - */ -export interface UserAppV2025 { - /** - * The user app id - * @type {string} - * @memberof UserAppV2025 - */ - 'id'?: string; - /** - * Time when the user app was created - * @type {string} - * @memberof UserAppV2025 - */ - 'created'?: string; - /** - * Time when the user app was last modified - * @type {string} - * @memberof UserAppV2025 - */ - 'modified'?: string; - /** - * True if the owner has multiple accounts for the source - * @type {boolean} - * @memberof UserAppV2025 - */ - 'hasMultipleAccounts'?: boolean; - /** - * True if the source has password feature - * @type {boolean} - * @memberof UserAppV2025 - */ - 'useForPasswordManagement'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof UserAppV2025 - */ - 'provisionRequestEnabled'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof UserAppV2025 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {UserAppSourceAppV2025} - * @memberof UserAppV2025 - */ - 'sourceApp'?: UserAppSourceAppV2025; - /** - * - * @type {UserAppSourceV2025} - * @memberof UserAppV2025 - */ - 'source'?: UserAppSourceV2025; - /** - * - * @type {UserAppAccountV2025} - * @memberof UserAppV2025 - */ - 'account'?: UserAppAccountV2025; - /** - * - * @type {UserAppOwnerV2025} - * @memberof UserAppV2025 - */ - 'owner'?: UserAppOwnerV2025; -} -/** - * It represents a summary of a user level publish operation, including its metadata and status. - * @export - * @interface UserLevelPublishSummaryV2025 - */ -export interface UserLevelPublishSummaryV2025 { - /** - * The unique identifier of the UserLevel. - * @type {string} - * @memberof UserLevelPublishSummaryV2025 - */ - 'userLevelId'?: string; - /** - * Indicates whether the API call triggered a publish operation. - * @type {boolean} - * @memberof UserLevelPublishSummaryV2025 - */ - 'publish'?: boolean; - /** - * The status of the UserLevel publish operation. - * @type {string} - * @memberof UserLevelPublishSummaryV2025 - */ - 'status'?: string; - /** - * The last modification timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelPublishSummaryV2025 - */ - 'modified'?: string; -} -/** - * Payload containing details for creating a custom user level. - * @export - * @interface UserLevelRequestV2025 - */ -export interface UserLevelRequestV2025 { - /** - * The name of the user level. - * @type {string} - * @memberof UserLevelRequestV2025 - */ - 'name': string; - /** - * A brief description of the user level. - * @type {string} - * @memberof UserLevelRequestV2025 - */ - 'description': string; - /** - * - * @type {PublicIdentityV2025} - * @memberof UserLevelRequestV2025 - */ - 'owner': PublicIdentityV2025; - /** - * A list of rights associated with the user level. - * @type {Array} - * @memberof UserLevelRequestV2025 - */ - 'rightSets'?: Array; -} -/** - * It represents a summary of a user level, including its metadata, attributes, and associated properties. - * @export - * @interface UserLevelSummaryDTOV2025 - */ -export interface UserLevelSummaryDTOV2025 { - /** - * The unique identifier of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'id'?: string; - /** - * The human-readable name of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'name'?: string; - /** - * A human-readable description of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'description'?: string | null; - /** - * The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'legacyGroup'?: string | null; - /** - * List of RightSets associated with the UserLevel. - * @type {Array} - * @memberof UserLevelSummaryDTOV2025 - */ - 'rightSets'?: Array; - /** - * Indicates whether the UserLevel is custom. - * @type {boolean} - * @memberof UserLevelSummaryDTOV2025 - */ - 'custom'?: boolean; - /** - * Indicates whether the UserLevel is admin-assignable. - * @type {boolean} - * @memberof UserLevelSummaryDTOV2025 - */ - 'adminAssignable'?: boolean; - /** - * The translated name of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'translatedName'?: string | null; - /** - * The translated grant message for the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'translatedGrant'?: string | null; - /** - * The translated remove message for the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'translatedRemove'?: string | null; - /** - * - * @type {PublicIdentityV2025} - * @memberof UserLevelSummaryDTOV2025 - */ - 'owner'?: PublicIdentityV2025; - /** - * The status of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'status'?: UserLevelSummaryDTOV2025StatusV2025; - /** - * The creation timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'created'?: string; - /** - * The last modification timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2025 - */ - 'modified'?: string; - /** - * The count of associated identities for the UserLevel. - * @type {number} - * @memberof UserLevelSummaryDTOV2025 - */ - 'associatedIdentitiesCount'?: number | null; -} - -export const UserLevelSummaryDTOV2025StatusV2025 = { - Active: 'ACTIVE', - Draft: 'DRAFT' -} as const; - -export type UserLevelSummaryDTOV2025StatusV2025 = typeof UserLevelSummaryDTOV2025StatusV2025[keyof typeof UserLevelSummaryDTOV2025StatusV2025]; - -/** - * - * @export - * @interface V3ConnectorDtoV2025 - */ -export interface V3ConnectorDtoV2025 { - /** - * The connector name - * @type {string} - * @memberof V3ConnectorDtoV2025 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof V3ConnectorDtoV2025 - */ - 'type'?: string; - /** - * The connector script name - * @type {string} - * @memberof V3ConnectorDtoV2025 - */ - 'scriptName'?: string; - /** - * The connector class name. - * @type {string} - * @memberof V3ConnectorDtoV2025 - */ - 'className'?: string | null; - /** - * The list of features supported by the connector - * @type {Array} - * @memberof V3ConnectorDtoV2025 - */ - 'features'?: Array | null; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3ConnectorDtoV2025 - */ - 'directConnect'?: boolean; - /** - * A map containing metadata pertinent to the connector - * @type {{ [key: string]: any; }} - * @memberof V3ConnectorDtoV2025 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof V3ConnectorDtoV2025 - */ - 'status'?: V3ConnectorDtoV2025StatusV2025; -} - -export const V3ConnectorDtoV2025StatusV2025 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3ConnectorDtoV2025StatusV2025 = typeof V3ConnectorDtoV2025StatusV2025[keyof typeof V3ConnectorDtoV2025StatusV2025]; - -/** - * - * @export - * @interface V3CreateConnectorDtoV2025 - */ -export interface V3CreateConnectorDtoV2025 { - /** - * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - * @type {string} - * @memberof V3CreateConnectorDtoV2025 - */ - 'name': string; - /** - * The connector type. If not specified will be defaulted to \'custom \'+name - * @type {string} - * @memberof V3CreateConnectorDtoV2025 - */ - 'type'?: string; - /** - * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - * @type {string} - * @memberof V3CreateConnectorDtoV2025 - */ - 'className': string; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3CreateConnectorDtoV2025 - */ - 'directConnect'?: boolean; - /** - * The connector status - * @type {string} - * @memberof V3CreateConnectorDtoV2025 - */ - 'status'?: V3CreateConnectorDtoV2025StatusV2025; -} - -export const V3CreateConnectorDtoV2025StatusV2025 = { - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3CreateConnectorDtoV2025StatusV2025 = typeof V3CreateConnectorDtoV2025StatusV2025[keyof typeof V3CreateConnectorDtoV2025StatusV2025]; - -/** - * Details about the `CLUSTER` or `SOURCE` that initiated this event. - * @export - * @interface VAClusterStatusChangeEventApplicationV2025 - */ -export interface VAClusterStatusChangeEventApplicationV2025 { - /** - * The GUID of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2025 - */ - 'id': string; - /** - * The name of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2025 - */ - 'name': string; - /** - * Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. - * @type {{ [key: string]: any; }} - * @memberof VAClusterStatusChangeEventApplicationV2025 - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * The results of the most recent health check. - * @export - * @interface VAClusterStatusChangeEventHealthCheckResultV2025 - */ -export interface VAClusterStatusChangeEventHealthCheckResultV2025 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2025 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2025 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2025 - */ - 'status': VAClusterStatusChangeEventHealthCheckResultV2025StatusV2025; -} - -export const VAClusterStatusChangeEventHealthCheckResultV2025StatusV2025 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventHealthCheckResultV2025StatusV2025 = typeof VAClusterStatusChangeEventHealthCheckResultV2025StatusV2025[keyof typeof VAClusterStatusChangeEventHealthCheckResultV2025StatusV2025]; - -/** - * The results of the last health check. - * @export - * @interface VAClusterStatusChangeEventPreviousHealthCheckResultV2025 - */ -export interface VAClusterStatusChangeEventPreviousHealthCheckResultV2025 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2025 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2025 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2025 - */ - 'status': VAClusterStatusChangeEventPreviousHealthCheckResultV2025StatusV2025; -} - -export const VAClusterStatusChangeEventPreviousHealthCheckResultV2025StatusV2025 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventPreviousHealthCheckResultV2025StatusV2025 = typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2025StatusV2025[keyof typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2025StatusV2025]; - -/** - * - * @export - * @interface VAClusterStatusChangeEventV2025 - */ -export interface VAClusterStatusChangeEventV2025 { - /** - * The date and time the status change occurred. - * @type {string} - * @memberof VAClusterStatusChangeEventV2025 - */ - 'created': string; - /** - * The type of the object that initiated this event. - * @type {object} - * @memberof VAClusterStatusChangeEventV2025 - */ - 'type': VAClusterStatusChangeEventV2025TypeV2025; - /** - * - * @type {VAClusterStatusChangeEventApplicationV2025} - * @memberof VAClusterStatusChangeEventV2025 - */ - 'application': VAClusterStatusChangeEventApplicationV2025; - /** - * - * @type {VAClusterStatusChangeEventHealthCheckResultV2025} - * @memberof VAClusterStatusChangeEventV2025 - */ - 'healthCheckResult': VAClusterStatusChangeEventHealthCheckResultV2025; - /** - * - * @type {VAClusterStatusChangeEventPreviousHealthCheckResultV2025} - * @memberof VAClusterStatusChangeEventV2025 - */ - 'previousHealthCheckResult': VAClusterStatusChangeEventPreviousHealthCheckResultV2025; -} - -export const VAClusterStatusChangeEventV2025TypeV2025 = { - Source: 'SOURCE', - Cluster: 'CLUSTER' -} as const; - -export type VAClusterStatusChangeEventV2025TypeV2025 = typeof VAClusterStatusChangeEventV2025TypeV2025[keyof typeof VAClusterStatusChangeEventV2025TypeV2025]; - -/** - * - * @export - * @interface ValidateFilterInputDtoV2025 - */ -export interface ValidateFilterInputDtoV2025 { - /** - * Mock input to evaluate filter expression against. - * @type {object} - * @memberof ValidateFilterInputDtoV2025 - */ - 'input': object; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof ValidateFilterInputDtoV2025 - */ - 'filter': string; -} -/** - * - * @export - * @interface ValidateFilterOutputDtoV2025 - */ -export interface ValidateFilterOutputDtoV2025 { - /** - * When this field is true, the filter expression is valid against the input. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2025 - */ - 'isValid'?: boolean; - /** - * When this field is true, the filter expression is using a valid JSON path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2025 - */ - 'isValidJSONPath'?: boolean; - /** - * When this field is true, the filter expression is using an existing path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2025 - */ - 'isPathExist'?: boolean; -} -/** - * - * @export - * @interface ValueV2025 - */ -export interface ValueV2025 { - /** - * The type of attribute value - * @type {string} - * @memberof ValueV2025 - */ - 'type'?: string; - /** - * The attribute value - * @type {string} - * @memberof ValueV2025 - */ - 'value'?: string; -} -/** - * Request body for POST /ssf/streams/verify (receiver verification). - * @export - * @interface VerificationRequestV2025 - */ -export interface VerificationRequestV2025 { - /** - * Stream ID for verification. - * @type {string} - * @memberof VerificationRequestV2025 - */ - 'stream_id': string; - /** - * Optional state value for verification challenge. - * @type {string} - * @memberof VerificationRequestV2025 - */ - 'state'?: string; -} -/** - * The types of objects supported for SOD violations - * @export - * @interface ViolationContextPolicyV2025 - */ -export interface ViolationContextPolicyV2025 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ViolationContextPolicyV2025 - */ - 'type'?: ViolationContextPolicyV2025TypeV2025; - /** - * SOD policy ID. - * @type {string} - * @memberof ViolationContextPolicyV2025 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof ViolationContextPolicyV2025 - */ - 'name'?: string; -} - -export const ViolationContextPolicyV2025TypeV2025 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ViolationContextPolicyV2025TypeV2025 = typeof ViolationContextPolicyV2025TypeV2025[keyof typeof ViolationContextPolicyV2025TypeV2025]; - -/** - * - * @export - * @interface ViolationContextV2025 - */ -export interface ViolationContextV2025 { - /** - * - * @type {ViolationContextPolicyV2025} - * @memberof ViolationContextV2025 - */ - 'policy'?: ViolationContextPolicyV2025; - /** - * - * @type {ExceptionAccessCriteriaV2025} - * @memberof ViolationContextV2025 - */ - 'conflictingAccessCriteria'?: ExceptionAccessCriteriaV2025; -} -/** - * The owner of the violation assignment config. - * @export - * @interface ViolationOwnerAssignmentConfigOwnerRefV2025 - */ -export interface ViolationOwnerAssignmentConfigOwnerRefV2025 { - /** - * Owner type. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2025 - */ - 'type'?: ViolationOwnerAssignmentConfigOwnerRefV2025TypeV2025 | null; - /** - * Owner\'s ID. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2025 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2025 - */ - 'name'?: string; -} - -export const ViolationOwnerAssignmentConfigOwnerRefV2025TypeV2025 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - Manager: 'MANAGER' -} as const; - -export type ViolationOwnerAssignmentConfigOwnerRefV2025TypeV2025 = typeof ViolationOwnerAssignmentConfigOwnerRefV2025TypeV2025[keyof typeof ViolationOwnerAssignmentConfigOwnerRefV2025TypeV2025]; - -/** - * - * @export - * @interface ViolationOwnerAssignmentConfigV2025 - */ -export interface ViolationOwnerAssignmentConfigV2025 { - /** - * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity - * @type {string} - * @memberof ViolationOwnerAssignmentConfigV2025 - */ - 'assignmentRule'?: ViolationOwnerAssignmentConfigV2025AssignmentRuleV2025 | null; - /** - * - * @type {ViolationOwnerAssignmentConfigOwnerRefV2025} - * @memberof ViolationOwnerAssignmentConfigV2025 - */ - 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRefV2025 | null; -} - -export const ViolationOwnerAssignmentConfigV2025AssignmentRuleV2025 = { - Manager: 'MANAGER', - Static: 'STATIC' -} as const; - -export type ViolationOwnerAssignmentConfigV2025AssignmentRuleV2025 = typeof ViolationOwnerAssignmentConfigV2025AssignmentRuleV2025[keyof typeof ViolationOwnerAssignmentConfigV2025AssignmentRuleV2025]; - -/** - * An object containing a listing of the SOD violation reasons detected by this check. - * @export - * @interface ViolationPredictionV2025 - */ -export interface ViolationPredictionV2025 { - /** - * List of Violation Contexts - * @type {Array} - * @memberof ViolationPredictionV2025 - */ - 'violationContexts'?: Array; -} -/** - * - * @export - * @interface VisibilityCriteriaV2025 - */ -export interface VisibilityCriteriaV2025 { - /** - * - * @type {ExpressionV2025} - * @memberof VisibilityCriteriaV2025 - */ - 'expression'?: ExpressionV2025; -} -/** - * - * @export - * @interface WorkItemForwardV2025 - */ -export interface WorkItemForwardV2025 { - /** - * The ID of the identity to forward this work item to. - * @type {string} - * @memberof WorkItemForwardV2025 - */ - 'targetOwnerId': string; - /** - * Comments to send to the target owner - * @type {string} - * @memberof WorkItemForwardV2025 - */ - 'comment': string; - /** - * If true, send a notification to the target owner. - * @type {boolean} - * @memberof WorkItemForwardV2025 - */ - 'sendNotifications'?: boolean; -} -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateManualWorkItemsV2025 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateManualWorkItemsV2025 = typeof WorkItemStateManualWorkItemsV2025[keyof typeof WorkItemStateManualWorkItemsV2025]; - - -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateV2025 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateV2025 = typeof WorkItemStateV2025[keyof typeof WorkItemStateV2025]; - - -/** - * The type of the work item - * @export - * @enum {string} - */ - -export const WorkItemTypeManualWorkItemsV2025 = { - Generic: 'Generic', - Certification: 'Certification', - Remediation: 'Remediation', - Delegation: 'Delegation', - Approval: 'Approval', - ViolationReview: 'ViolationReview', - Form: 'Form', - PolicyVioloation: 'PolicyVioloation', - Challenge: 'Challenge', - ImpactAnalysis: 'ImpactAnalysis', - Signoff: 'Signoff', - Event: 'Event', - ManualAction: 'ManualAction', - Test: 'Test' -} as const; - -export type WorkItemTypeManualWorkItemsV2025 = typeof WorkItemTypeManualWorkItemsV2025[keyof typeof WorkItemTypeManualWorkItemsV2025]; - - -/** - * - * @export - * @interface WorkItemsCountV2025 - */ -export interface WorkItemsCountV2025 { - /** - * The count of work items - * @type {number} - * @memberof WorkItemsCountV2025 - */ - 'count'?: number; -} -/** - * - * @export - * @interface WorkItemsFormV2025 - */ -export interface WorkItemsFormV2025 { - /** - * ID of the form - * @type {string} - * @memberof WorkItemsFormV2025 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof WorkItemsFormV2025 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof WorkItemsFormV2025 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof WorkItemsFormV2025 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof WorkItemsFormV2025 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof WorkItemsFormV2025 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface WorkItemsSummaryV2025 - */ -export interface WorkItemsSummaryV2025 { - /** - * The count of open work items - * @type {number} - * @memberof WorkItemsSummaryV2025 - */ - 'open'?: number; - /** - * The count of completed work items - * @type {number} - * @memberof WorkItemsSummaryV2025 - */ - 'completed'?: number; - /** - * The count of total work items - * @type {number} - * @memberof WorkItemsSummaryV2025 - */ - 'total'?: number; -} -/** - * - * @export - * @interface WorkItemsV2025 - */ -export interface WorkItemsV2025 { - /** - * ID of the work item - * @type {string} - * @memberof WorkItemsV2025 - */ - 'id'?: string; - /** - * ID of the requester - * @type {string} - * @memberof WorkItemsV2025 - */ - 'requesterId'?: string | null; - /** - * The displayname of the requester - * @type {string} - * @memberof WorkItemsV2025 - */ - 'requesterDisplayName'?: string | null; - /** - * The ID of the owner - * @type {string} - * @memberof WorkItemsV2025 - */ - 'ownerId'?: string | null; - /** - * The name of the owner - * @type {string} - * @memberof WorkItemsV2025 - */ - 'ownerName'?: string; - /** - * Time when the work item was created - * @type {string} - * @memberof WorkItemsV2025 - */ - 'created'?: string; - /** - * Time when the work item was last updated - * @type {string} - * @memberof WorkItemsV2025 - */ - 'modified'?: string | null; - /** - * The description of the work item - * @type {string} - * @memberof WorkItemsV2025 - */ - 'description'?: string; - /** - * - * @type {WorkItemStateManualWorkItemsV2025} - * @memberof WorkItemsV2025 - */ - 'state'?: WorkItemStateManualWorkItemsV2025; - /** - * - * @type {WorkItemTypeManualWorkItemsV2025} - * @memberof WorkItemsV2025 - */ - 'type'?: WorkItemTypeManualWorkItemsV2025; - /** - * A list of remediation items - * @type {Array} - * @memberof WorkItemsV2025 - */ - 'remediationItems'?: Array | null; - /** - * A list of items that need to be approved - * @type {Array} - * @memberof WorkItemsV2025 - */ - 'approvalItems'?: Array | null; - /** - * The work item name - * @type {string} - * @memberof WorkItemsV2025 - */ - 'name'?: string | null; - /** - * The time at which the work item completed - * @type {string} - * @memberof WorkItemsV2025 - */ - 'completed'?: string | null; - /** - * The number of items in the work item - * @type {number} - * @memberof WorkItemsV2025 - */ - 'numItems'?: number | null; - /** - * - * @type {WorkItemsFormV2025} - * @memberof WorkItemsV2025 - */ - 'form'?: WorkItemsFormV2025; - /** - * An array of errors that ocurred during the work item - * @type {Array} - * @memberof WorkItemsV2025 - */ - 'errors'?: Array; -} - - -/** - * Workflow creator\'s identity. - * @export - * @interface WorkflowAllOfCreatorV2025 - */ -export interface WorkflowAllOfCreatorV2025 { - /** - * Workflow creator\'s DTO type. - * @type {string} - * @memberof WorkflowAllOfCreatorV2025 - */ - 'type'?: WorkflowAllOfCreatorV2025TypeV2025; - /** - * Workflow creator\'s identity ID. - * @type {string} - * @memberof WorkflowAllOfCreatorV2025 - */ - 'id'?: string; - /** - * Workflow creator\'s display name. - * @type {string} - * @memberof WorkflowAllOfCreatorV2025 - */ - 'name'?: string; -} - -export const WorkflowAllOfCreatorV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowAllOfCreatorV2025TypeV2025 = typeof WorkflowAllOfCreatorV2025TypeV2025[keyof typeof WorkflowAllOfCreatorV2025TypeV2025]; - -/** - * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - * @export - * @interface WorkflowBodyOwnerV2025 - */ -export interface WorkflowBodyOwnerV2025 { - /** - * The type of object that is referenced - * @type {string} - * @memberof WorkflowBodyOwnerV2025 - */ - 'type'?: WorkflowBodyOwnerV2025TypeV2025; - /** - * The unique ID of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2025 - */ - 'id'?: string; - /** - * The name of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2025 - */ - 'name'?: string; -} - -export const WorkflowBodyOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowBodyOwnerV2025TypeV2025 = typeof WorkflowBodyOwnerV2025TypeV2025[keyof typeof WorkflowBodyOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowBodyV2025 - */ -export interface WorkflowBodyV2025 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBodyV2025 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2025} - * @memberof WorkflowBodyV2025 - */ - 'owner'?: WorkflowBodyOwnerV2025; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBodyV2025 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2025} - * @memberof WorkflowBodyV2025 - */ - 'definition'?: WorkflowDefinitionV2025; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBodyV2025 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2025} - * @memberof WorkflowBodyV2025 - */ - 'trigger'?: WorkflowTriggerV2025; -} -/** - * The map of steps that the workflow will execute. - * @export - * @interface WorkflowDefinitionV2025 - */ -export interface WorkflowDefinitionV2025 { - /** - * The name of the starting step. - * @type {string} - * @memberof WorkflowDefinitionV2025 - */ - 'start'?: string; - /** - * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - * @type {{ [key: string]: any; }} - * @memberof WorkflowDefinitionV2025 - */ - 'steps'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface WorkflowExecutionEventV2025 - */ -export interface WorkflowExecutionEventV2025 { - /** - * The type of event - * @type {string} - * @memberof WorkflowExecutionEventV2025 - */ - 'type'?: WorkflowExecutionEventV2025TypeV2025; - /** - * The date-time when the event occurred - * @type {string} - * @memberof WorkflowExecutionEventV2025 - */ - 'timestamp'?: string; - /** - * Additional attributes associated with the event - * @type {object} - * @memberof WorkflowExecutionEventV2025 - */ - 'attributes'?: object; -} - -export const WorkflowExecutionEventV2025TypeV2025 = { - WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', - WorkflowExecutionStarted: 'WorkflowExecutionStarted', - WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', - WorkflowExecutionFailed: 'WorkflowExecutionFailed', - WorkflowTaskScheduled: 'WorkflowTaskScheduled', - WorkflowTaskStarted: 'WorkflowTaskStarted', - WorkflowTaskCompleted: 'WorkflowTaskCompleted', - WorkflowTaskFailed: 'WorkflowTaskFailed', - ActivityTaskScheduled: 'ActivityTaskScheduled', - ActivityTaskStarted: 'ActivityTaskStarted', - ActivityTaskCompleted: 'ActivityTaskCompleted', - ActivityTaskFailed: 'ActivityTaskFailed', - StartChildWorkflowExecutionInitiated: 'StartChildWorkflowExecutionInitiated', - ChildWorkflowExecutionStarted: 'ChildWorkflowExecutionStarted', - ChildWorkflowExecutionCompleted: 'ChildWorkflowExecutionCompleted', - ChildWorkflowExecutionFailed: 'ChildWorkflowExecutionFailed' -} as const; - -export type WorkflowExecutionEventV2025TypeV2025 = typeof WorkflowExecutionEventV2025TypeV2025[keyof typeof WorkflowExecutionEventV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowExecutionHistoryV2025 - */ -export interface WorkflowExecutionHistoryV2025 { - /** - * The workflow definition for the workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2025 - */ - 'definition'?: object; - /** - * List of workflow execution events for the given workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2025 - */ - 'history'?: object; - /** - * The trigger that initiated the workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2025 - */ - 'trigger'?: object; -} -/** - * - * @export - * @interface WorkflowExecutionV2025 - */ -export interface WorkflowExecutionV2025 { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'id'?: string; - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'workflowId'?: string; - /** - * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'requestId'?: string; - /** - * Date/time when the workflow started. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'startTime'?: string; - /** - * Date/time when the workflow ended. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'closeTime'?: string; - /** - * Workflow execution status. - * @type {string} - * @memberof WorkflowExecutionV2025 - */ - 'status'?: WorkflowExecutionV2025StatusV2025; -} - -export const WorkflowExecutionV2025StatusV2025 = { - Completed: 'Completed', - Failed: 'Failed', - Canceled: 'Canceled', - Running: 'Running', - Queued: 'Queued' -} as const; - -export type WorkflowExecutionV2025StatusV2025 = typeof WorkflowExecutionV2025StatusV2025[keyof typeof WorkflowExecutionV2025StatusV2025]; - -/** - * @type WorkflowLibraryActionExampleOutputV2025 - * @export - */ -export type WorkflowLibraryActionExampleOutputV2025 = Array | object; - -/** - * - * @export - * @interface WorkflowLibraryActionV2025 - */ -export interface WorkflowLibraryActionV2025 { - /** - * Action ID. This is a static namespaced ID for the action - * @type {string} - * @memberof WorkflowLibraryActionV2025 - */ - 'id'?: string; - /** - * Action Name - * @type {string} - * @memberof WorkflowLibraryActionV2025 - */ - 'name'?: string; - /** - * Action type - * @type {string} - * @memberof WorkflowLibraryActionV2025 - */ - 'type'?: string; - /** - * Action Description - * @type {string} - * @memberof WorkflowLibraryActionV2025 - */ - 'description'?: string; - /** - * One or more inputs that the action accepts - * @type {Array} - * @memberof WorkflowLibraryActionV2025 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2025} - * @memberof WorkflowLibraryActionV2025 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2025; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2025 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryActionV2025 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof WorkflowLibraryActionV2025 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2025 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryActionV2025 - */ - 'isDynamicSchema'?: boolean; - /** - * Defines the output schema, if any, that this action produces. - * @type {object} - * @memberof WorkflowLibraryActionV2025 - */ - 'outputSchema'?: object; -} -/** - * - * @export - * @interface WorkflowLibraryFormFieldsV2025 - */ -export interface WorkflowLibraryFormFieldsV2025 { - /** - * Description of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'description'?: string; - /** - * Describes the form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'helpText'?: string; - /** - * A human readable name for this form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'label'?: string; - /** - * The name of the input attribute - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'name'?: string; - /** - * Denotes if this field is a required attribute - * @type {boolean} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'required'?: boolean; - /** - * The type of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2025 - */ - 'type'?: WorkflowLibraryFormFieldsV2025TypeV2025 | null; -} - -export const WorkflowLibraryFormFieldsV2025TypeV2025 = { - Text: 'text', - Textarea: 'textarea', - Boolean: 'boolean', - Email: 'email', - Url: 'url', - Number: 'number', - Json: 'json', - Checkbox: 'checkbox', - Jsonpath: 'jsonpath', - Select: 'select', - MultiType: 'multiType', - Duration: 'duration', - Toggle: 'toggle', - FormPicker: 'formPicker', - IdentityPicker: 'identityPicker', - GovernanceGroupPicker: 'governanceGroupPicker', - String: 'string', - Object: 'object', - Array: 'array', - Secret: 'secret', - KeyValuePairs: 'keyValuePairs', - EmailPicker: 'emailPicker', - AdvancedToggle: 'advancedToggle', - VariableCreator: 'variableCreator', - HtmlEditor: 'htmlEditor' -} as const; - -export type WorkflowLibraryFormFieldsV2025TypeV2025 = typeof WorkflowLibraryFormFieldsV2025TypeV2025[keyof typeof WorkflowLibraryFormFieldsV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowLibraryOperatorV2025 - */ -export interface WorkflowLibraryOperatorV2025 { - /** - * Operator ID. - * @type {string} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'isDynamicSchema'?: boolean; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'isSimulationEnabled'?: boolean; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof WorkflowLibraryOperatorV2025 - */ - 'formFields'?: Array | null; -} -/** - * - * @export - * @interface WorkflowLibraryTriggerV2025 - */ -export interface WorkflowLibraryTriggerV2025 { - /** - * Trigger ID. This is a static namespaced ID for the trigger. - * @type {string} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'id'?: string; - /** - * Trigger type - * @type {string} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'type'?: WorkflowLibraryTriggerV2025TypeV2025; - /** - * Whether the trigger is deprecated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'deprecated'?: boolean; - /** - * Date the trigger was deprecated, if applicable. - * @type {string} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'deprecatedBy'?: string; - /** - * Whether the trigger can be simulated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'isSimulationEnabled'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'outputSchema'?: object; - /** - * Trigger Name - * @type {string} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'name'?: string; - /** - * Trigger Description - * @type {string} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'isDynamicSchema'?: boolean; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'inputExample'?: object | null; - /** - * One or more inputs that the trigger accepts - * @type {Array} - * @memberof WorkflowLibraryTriggerV2025 - */ - 'formFields'?: Array | null; -} - -export const WorkflowLibraryTriggerV2025TypeV2025 = { - Event: 'EVENT', - Scheduled: 'SCHEDULED', - External: 'EXTERNAL', - AccessRequestTrigger: 'AccessRequestTrigger' -} as const; - -export type WorkflowLibraryTriggerV2025TypeV2025 = typeof WorkflowLibraryTriggerV2025TypeV2025[keyof typeof WorkflowLibraryTriggerV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowModifiedByV2025 - */ -export interface WorkflowModifiedByV2025 { - /** - * - * @type {string} - * @memberof WorkflowModifiedByV2025 - */ - 'type'?: WorkflowModifiedByV2025TypeV2025; - /** - * Identity ID - * @type {string} - * @memberof WorkflowModifiedByV2025 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof WorkflowModifiedByV2025 - */ - 'name'?: string; -} - -export const WorkflowModifiedByV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowModifiedByV2025TypeV2025 = typeof WorkflowModifiedByV2025TypeV2025[keyof typeof WorkflowModifiedByV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowOAuthClientV2025 - */ -export interface WorkflowOAuthClientV2025 { - /** - * OAuth client ID for the trigger. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowOAuthClientV2025 - */ - 'id'?: string; - /** - * OAuthClient secret. - * @type {string} - * @memberof WorkflowOAuthClientV2025 - */ - 'secret'?: string; - /** - * URL for the external trigger to invoke - * @type {string} - * @memberof WorkflowOAuthClientV2025 - */ - 'url'?: string; -} -/** - * Workflow Trigger Attributes. - * @export - * @interface WorkflowTriggerAttributesV2025 - */ -export interface WorkflowTriggerAttributesV2025 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'filter.$'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'formDefinitionId'?: string | null; - /** - * A unique name for the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'name'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'url'?: string | null; - /** - * Frequency of execution - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'frequency': WorkflowTriggerAttributesV2025FrequencyV2025 | null; - /** - * Time zone identifier - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2025 - */ - 'yearlyTimes'?: Array | null; -} - -export const WorkflowTriggerAttributesV2025FrequencyV2025 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type WorkflowTriggerAttributesV2025FrequencyV2025 = typeof WorkflowTriggerAttributesV2025FrequencyV2025[keyof typeof WorkflowTriggerAttributesV2025FrequencyV2025]; - -/** - * The trigger that starts the workflow - * @export - * @interface WorkflowTriggerV2025 - */ -export interface WorkflowTriggerV2025 { - /** - * The trigger type - * @type {string} - * @memberof WorkflowTriggerV2025 - */ - 'type': WorkflowTriggerV2025TypeV2025; - /** - * The trigger display name - * @type {string} - * @memberof WorkflowTriggerV2025 - */ - 'displayName'?: string | null; - /** - * - * @type {WorkflowTriggerAttributesV2025} - * @memberof WorkflowTriggerV2025 - */ - 'attributes': WorkflowTriggerAttributesV2025 | null; -} - -export const WorkflowTriggerV2025TypeV2025 = { - Event: 'EVENT', - External: 'EXTERNAL', - Scheduled: 'SCHEDULED', - Empty: '' -} as const; - -export type WorkflowTriggerV2025TypeV2025 = typeof WorkflowTriggerV2025TypeV2025[keyof typeof WorkflowTriggerV2025TypeV2025]; - -/** - * - * @export - * @interface WorkflowV2025 - */ -export interface WorkflowV2025 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowV2025 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2025} - * @memberof WorkflowV2025 - */ - 'owner'?: WorkflowBodyOwnerV2025; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowV2025 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2025} - * @memberof WorkflowV2025 - */ - 'definition'?: WorkflowDefinitionV2025; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowV2025 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2025} - * @memberof WorkflowV2025 - */ - 'trigger'?: WorkflowTriggerV2025; - /** - * Workflow ID. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowV2025 - */ - 'id'?: string; - /** - * The number of times this workflow has been executed. - * @type {number} - * @memberof WorkflowV2025 - */ - 'executionCount'?: number; - /** - * The number of times this workflow has failed during execution. - * @type {number} - * @memberof WorkflowV2025 - */ - 'failureCount'?: number; - /** - * The date and time the workflow was created. - * @type {string} - * @memberof WorkflowV2025 - */ - 'created'?: string; - /** - * The date and time the workflow was modified. - * @type {string} - * @memberof WorkflowV2025 - */ - 'modified'?: string; - /** - * - * @type {WorkflowModifiedByV2025} - * @memberof WorkflowV2025 - */ - 'modifiedBy'?: WorkflowModifiedByV2025; - /** - * - * @type {WorkflowAllOfCreatorV2025} - * @memberof WorkflowV2025 - */ - 'creator'?: WorkflowAllOfCreatorV2025; -} -/** - * - * @export - * @interface WorkgroupBulkDeleteRequestV2025 - */ -export interface WorkgroupBulkDeleteRequestV2025 { - /** - * List of IDs of Governance Groups to be deleted. - * @type {Array} - * @memberof WorkgroupBulkDeleteRequestV2025 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoObjectV2025 - */ -export interface WorkgroupConnectionDtoObjectV2025 { - /** - * - * @type {ConnectedObjectTypeV2025 & object} - * @memberof WorkgroupConnectionDtoObjectV2025 - */ - 'type'?: ConnectedObjectTypeV2025 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2025 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2025 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2025 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoV2025 - */ -export interface WorkgroupConnectionDtoV2025 { - /** - * - * @type {WorkgroupConnectionDtoObjectV2025} - * @memberof WorkgroupConnectionDtoV2025 - */ - 'object'?: WorkgroupConnectionDtoObjectV2025; - /** - * Connection Type. - * @type {string} - * @memberof WorkgroupConnectionDtoV2025 - */ - 'connectionType'?: WorkgroupConnectionDtoV2025ConnectionTypeV2025; -} - -export const WorkgroupConnectionDtoV2025ConnectionTypeV2025 = { - AccessRequestReviewer: 'AccessRequestReviewer', - Owner: 'Owner', - ManagementWorkgroup: 'ManagementWorkgroup' -} as const; - -export type WorkgroupConnectionDtoV2025ConnectionTypeV2025 = typeof WorkgroupConnectionDtoV2025ConnectionTypeV2025[keyof typeof WorkgroupConnectionDtoV2025ConnectionTypeV2025]; - -/** - * - * @export - * @interface WorkgroupDeleteItemV2025 - */ -export interface WorkgroupDeleteItemV2025 { - /** - * Id of the Governance Group. - * @type {string} - * @memberof WorkgroupDeleteItemV2025 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. - * @type {number} - * @memberof WorkgroupDeleteItemV2025 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupDeleteItemV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupDtoOwnerV2025 - */ -export interface WorkgroupDtoOwnerV2025 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof WorkgroupDtoOwnerV2025 - */ - 'type'?: WorkgroupDtoOwnerV2025TypeV2025; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof WorkgroupDtoOwnerV2025 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof WorkgroupDtoOwnerV2025 - */ - 'name'?: string; - /** - * The display name of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2025 - */ - 'displayName'?: string; - /** - * The primary email address of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2025 - */ - 'emailAddress'?: string; -} - -export const WorkgroupDtoOwnerV2025TypeV2025 = { - Identity: 'IDENTITY' -} as const; - -export type WorkgroupDtoOwnerV2025TypeV2025 = typeof WorkgroupDtoOwnerV2025TypeV2025[keyof typeof WorkgroupDtoOwnerV2025TypeV2025]; - -/** - * - * @export - * @interface WorkgroupDtoV2025 - */ -export interface WorkgroupDtoV2025 { - /** - * - * @type {WorkgroupDtoOwnerV2025} - * @memberof WorkgroupDtoV2025 - */ - 'owner'?: WorkgroupDtoOwnerV2025; - /** - * Governance group ID. - * @type {string} - * @memberof WorkgroupDtoV2025 - */ - 'id'?: string; - /** - * Governance group name. - * @type {string} - * @memberof WorkgroupDtoV2025 - */ - 'name'?: string; - /** - * Governance group description. - * @type {string} - * @memberof WorkgroupDtoV2025 - */ - 'description'?: string; - /** - * Number of members in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2025 - */ - 'memberCount'?: number; - /** - * Number of connections in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2025 - */ - 'connectionCount'?: number; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2025 - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2025 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberAddItemV2025 - */ -export interface WorkgroupMemberAddItemV2025 { - /** - * Identifier of identity in bulk member add request. - * @type {string} - * @memberof WorkgroupMemberAddItemV2025 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberAddItemV2025 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberAddItemV2025 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberDeleteItemV2025 - */ -export interface WorkgroupMemberDeleteItemV2025 { - /** - * Identifier of identity in bulk member add /remove request. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2025 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberDeleteItemV2025 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2025 - */ - 'description'?: string; -} - -/** - * AccessModelMetadataV2025Api - axios parameter creator - * @export - */ -export const AccessModelMetadataV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2025} attributeDTOV2025 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute: async (attributeDTOV2025: AttributeDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeDTOV2025' is not null or undefined - assertParamExists('createAccessModelMetadataAttribute', 'attributeDTOV2025', attributeDTOV2025) - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2025} attributeValueDTOV2025 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue: async (key: string, attributeValueDTOV2025: AttributeValueDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'attributeValueDTOV2025' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'attributeValueDTOV2025', attributeValueDTOV2025) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeValueDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttribute', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'value', value) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('listAccessModelMetadataAttributeValue', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2025 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute: async (key: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'key', key) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2025 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue: async (key: string, value: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'value', value) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {EntitlementAttributeBulkUpdateFilterRequestV2025} entitlementAttributeBulkUpdateFilterRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByFilter: async (entitlementAttributeBulkUpdateFilterRequestV2025: EntitlementAttributeBulkUpdateFilterRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateFilterRequestV2025' is not null or undefined - assertParamExists('updateAccessModelMetadataByFilter', 'entitlementAttributeBulkUpdateFilterRequestV2025', entitlementAttributeBulkUpdateFilterRequestV2025) - const localVarPath = `/access-model-metadata/bulk-update/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateFilterRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {EntitlementAttributeBulkUpdateIdsRequestV2025} entitlementAttributeBulkUpdateIdsRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByIds: async (entitlementAttributeBulkUpdateIdsRequestV2025: EntitlementAttributeBulkUpdateIdsRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateIdsRequestV2025' is not null or undefined - assertParamExists('updateAccessModelMetadataByIds', 'entitlementAttributeBulkUpdateIdsRequestV2025', entitlementAttributeBulkUpdateIdsRequestV2025) - const localVarPath = `/access-model-metadata/bulk-update/ids`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateIdsRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {EntitlementAttributeBulkUpdateQueryRequestV2025} entitlementAttributeBulkUpdateQueryRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByQuery: async (entitlementAttributeBulkUpdateQueryRequestV2025: EntitlementAttributeBulkUpdateQueryRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateQueryRequestV2025' is not null or undefined - assertParamExists('updateAccessModelMetadataByQuery', 'entitlementAttributeBulkUpdateQueryRequestV2025', entitlementAttributeBulkUpdateQueryRequestV2025) - const localVarPath = `/access-model-metadata/bulk-update/query`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateQueryRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessModelMetadataV2025Api - functional programming interface - * @export - */ -export const AccessModelMetadataV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessModelMetadataV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2025} attributeDTOV2025 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttribute(attributeDTOV2025: AttributeDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttribute(attributeDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.createAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2025} attributeValueDTOV2025 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttributeValue(key: string, attributeValueDTOV2025: AttributeValueDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValue(key, attributeValueDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.createAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttribute(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttribute(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.getAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttributeValue(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValue(key, value, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.getAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttribute(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttribute(filters, sorters, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.listAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttributeValue(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValue(key, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.listAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2025 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttribute(key: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttribute(key, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.updateAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2025 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttributeValue(key: string, value: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValue(key, value, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.updateAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {EntitlementAttributeBulkUpdateFilterRequestV2025} entitlementAttributeBulkUpdateFilterRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByFilter(entitlementAttributeBulkUpdateFilterRequestV2025: EntitlementAttributeBulkUpdateFilterRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByFilter(entitlementAttributeBulkUpdateFilterRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.updateAccessModelMetadataByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {EntitlementAttributeBulkUpdateIdsRequestV2025} entitlementAttributeBulkUpdateIdsRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByIds(entitlementAttributeBulkUpdateIdsRequestV2025: EntitlementAttributeBulkUpdateIdsRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByIds(entitlementAttributeBulkUpdateIdsRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.updateAccessModelMetadataByIds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {EntitlementAttributeBulkUpdateQueryRequestV2025} entitlementAttributeBulkUpdateQueryRequestV2025 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByQuery(entitlementAttributeBulkUpdateQueryRequestV2025: EntitlementAttributeBulkUpdateQueryRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByQuery(entitlementAttributeBulkUpdateQueryRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2025Api.updateAccessModelMetadataByQuery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessModelMetadataV2025Api - factory interface - * @export - */ -export const AccessModelMetadataV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessModelMetadataV2025ApiFp(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttribute(requestParameters.attributeDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByFilter(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByFilter(requestParameters.entitlementAttributeBulkUpdateFilterRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByIds(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByIds(requestParameters.entitlementAttributeBulkUpdateIdsRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByQuery(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByQuery(requestParameters.entitlementAttributeBulkUpdateQueryRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataAttribute operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest { - /** - * Attribute to create - * @type {AttributeDTOV2025} - * @memberof AccessModelMetadataV2025ApiCreateAccessModelMetadataAttribute - */ - readonly attributeDTOV2025: AttributeDTOV2025 -} - -/** - * Request parameters for createAccessModelMetadataAttributeValue operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Attribute value to create - * @type {AttributeValueDTOV2025} - * @memberof AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValue - */ - readonly attributeValueDTOV2025: AttributeValueDTOV2025 -} - -/** - * Request parameters for getAccessModelMetadataAttribute operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiGetAccessModelMetadataAttribute - */ - readonly key: string -} - -/** - * Request parameters for getAccessModelMetadataAttributeValue operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValue - */ - readonly value: string -} - -/** - * Request parameters for listAccessModelMetadataAttribute operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest { - /** - * 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof AccessModelMetadataV2025ApiListAccessModelMetadataAttribute - */ - 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: **name, key** - * @type {string} - * @memberof AccessModelMetadataV2025ApiListAccessModelMetadataAttribute - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2025ApiListAccessModelMetadataAttribute - */ - 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 AccessModelMetadataV2025ApiListAccessModelMetadataAttribute - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccessModelMetadataAttributeValue operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValue - */ - 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 AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValue - */ - readonly count?: boolean -} - -/** - * Request parameters for updateAccessModelMetadataAttribute operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttribute - */ - readonly key: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttribute - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateAccessModelMetadataAttributeValue operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValue - */ - readonly value: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValue - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateAccessModelMetadataByFilter operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest - */ -export interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateFilterRequestV2025} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilter - */ - readonly entitlementAttributeBulkUpdateFilterRequestV2025: EntitlementAttributeBulkUpdateFilterRequestV2025 -} - -/** - * Request parameters for updateAccessModelMetadataByIds operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest - */ -export interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateIdsRequestV2025} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIds - */ - readonly entitlementAttributeBulkUpdateIdsRequestV2025: EntitlementAttributeBulkUpdateIdsRequestV2025 -} - -/** - * Request parameters for updateAccessModelMetadataByQuery operation in AccessModelMetadataV2025Api. - * @export - * @interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest - */ -export interface AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateQueryRequestV2025} - * @memberof AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQuery - */ - readonly entitlementAttributeBulkUpdateQueryRequestV2025: EntitlementAttributeBulkUpdateQueryRequestV2025 -} - -/** - * AccessModelMetadataV2025Api - object-oriented interface - * @export - * @class AccessModelMetadataV2025Api - * @extends {BaseAPI} - */ -export class AccessModelMetadataV2025Api extends BaseAPI { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).createAccessModelMetadataAttribute(requestParameters.attributeDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public updateAccessModelMetadataByFilter(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).updateAccessModelMetadataByFilter(requestParameters.entitlementAttributeBulkUpdateFilterRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public updateAccessModelMetadataByIds(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).updateAccessModelMetadataByIds(requestParameters.entitlementAttributeBulkUpdateIdsRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2025Api - */ - public updateAccessModelMetadataByQuery(requestParameters: AccessModelMetadataV2025ApiUpdateAccessModelMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2025ApiFp(this.configuration).updateAccessModelMetadataByQuery(requestParameters.entitlementAttributeBulkUpdateQueryRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessProfilesV2025Api - axios parameter creator - * @export - */ -export const AccessProfilesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2025} accessProfileV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile: async (accessProfileV2025: AccessProfileV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileV2025' is not null or undefined - assertParamExists('createAccessProfile', 'accessProfileV2025', accessProfileV2025) - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2025} accessProfileBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk: async (accessProfileBulkDeleteRequestV2025: AccessProfileBulkDeleteRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkDeleteRequestV2025' is not null or undefined - assertParamExists('deleteAccessProfilesInBulk', 'accessProfileBulkDeleteRequestV2025', accessProfileBulkDeleteRequestV2025) - const localVarPath = `/access-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfileEntitlements', 'id', id) - const localVarPath = `/access-profiles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAccessProfile', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAccessProfile', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk: async (accessProfileBulkUpdateRequestInnerV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkUpdateRequestInnerV2025' is not null or undefined - assertParamExists('updateAccessProfilesInBulk', 'accessProfileBulkUpdateRequestInnerV2025', accessProfileBulkUpdateRequestInnerV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-profiles/bulk-update-requestable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkUpdateRequestInnerV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessProfilesV2025Api - functional programming interface - * @export - */ -export const AccessProfilesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessProfilesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2025} accessProfileV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessProfile(accessProfileV2025: AccessProfileV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfile(accessProfileV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.createAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.deleteAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2025} accessProfileBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2025: AccessProfileBulkDeleteRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.deleteAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.getAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.getAccessProfileEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfiles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.listAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAccessProfile(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfile(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.patchAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2025Api.updateAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessProfilesV2025Api - factory interface - * @export - */ -export const AccessProfilesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessProfilesV2025ApiFp(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2025ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile(requestParameters: AccessProfilesV2025ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessProfile(requestParameters.accessProfileV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2025ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile(requestParameters: AccessProfilesV2025ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2025ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile(requestParameters: AccessProfilesV2025ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements(requestParameters: AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2025ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles(requestParameters: AccessProfilesV2025ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2025ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile(requestParameters: AccessProfilesV2025ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk(requestParameters: AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessProfile operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiCreateAccessProfileRequest - */ -export interface AccessProfilesV2025ApiCreateAccessProfileRequest { - /** - * - * @type {AccessProfileV2025} - * @memberof AccessProfilesV2025ApiCreateAccessProfile - */ - readonly accessProfileV2025: AccessProfileV2025 -} - -/** - * Request parameters for deleteAccessProfile operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiDeleteAccessProfileRequest - */ -export interface AccessProfilesV2025ApiDeleteAccessProfileRequest { - /** - * ID of the Access Profile to delete - * @type {string} - * @memberof AccessProfilesV2025ApiDeleteAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest { - /** - * - * @type {AccessProfileBulkDeleteRequestV2025} - * @memberof AccessProfilesV2025ApiDeleteAccessProfilesInBulk - */ - readonly accessProfileBulkDeleteRequestV2025: AccessProfileBulkDeleteRequestV2025 -} - -/** - * Request parameters for getAccessProfile operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiGetAccessProfileRequest - */ -export interface AccessProfilesV2025ApiGetAccessProfileRequest { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfilesV2025ApiGetAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for getAccessProfileEntitlements operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest - */ -export interface AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest { - /** - * ID of the access profile containing the entitlements. - * @type {string} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof AccessProfilesV2025ApiGetAccessProfileEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listAccessProfiles operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiListAccessProfilesRequest - */ -export interface AccessProfilesV2025ApiListAccessProfilesRequest { - /** - * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @type {string} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly forSubadmin?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly sorters?: string - - /** - * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly forSegmentIds?: string - - /** - * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @type {boolean} - * @memberof AccessProfilesV2025ApiListAccessProfiles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchAccessProfile operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiPatchAccessProfileRequest - */ -export interface AccessProfilesV2025ApiPatchAccessProfileRequest { - /** - * ID of the Access Profile to patch - * @type {string} - * @memberof AccessProfilesV2025ApiPatchAccessProfile - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AccessProfilesV2025ApiPatchAccessProfile - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateAccessProfilesInBulk operation in AccessProfilesV2025Api. - * @export - * @interface AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest { - /** - * - * @type {Array} - * @memberof AccessProfilesV2025ApiUpdateAccessProfilesInBulk - */ - readonly accessProfileBulkUpdateRequestInnerV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessProfilesV2025ApiUpdateAccessProfilesInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * AccessProfilesV2025Api - object-oriented interface - * @export - * @class AccessProfilesV2025Api - * @extends {BaseAPI} - */ -export class AccessProfilesV2025Api extends BaseAPI { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2025ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public createAccessProfile(requestParameters: AccessProfilesV2025ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).createAccessProfile(requestParameters.accessProfileV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2025ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public deleteAccessProfile(requestParameters: AccessProfilesV2025ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2025ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2025ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public getAccessProfile(requestParameters: AccessProfilesV2025ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public getAccessProfileEntitlements(requestParameters: AccessProfilesV2025ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2025ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public listAccessProfiles(requestParameters: AccessProfilesV2025ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2025ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public patchAccessProfile(requestParameters: AccessProfilesV2025ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2025Api - */ - public updateAccessProfilesInBulk(requestParameters: AccessProfilesV2025ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2025ApiFp(this.configuration).updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestApprovalsV2025Api - axios parameter creator - * @export - */ -export const AccessRequestApprovalsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2025} [commentDtoV2025] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest: async (approvalId: string, commentDtoV2025?: CommentDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('approveAccessRequest', 'approvalId', approvalId) - const localVarPath = `/access-request-approvals/{approvalId}/approve` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2025} forwardApprovalDtoV2025 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest: async (approvalId: string, forwardApprovalDtoV2025: ForwardApprovalDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('forwardAccessRequest', 'approvalId', approvalId) - // verify required parameter 'forwardApprovalDtoV2025' is not null or undefined - assertParamExists('forwardAccessRequest', 'forwardApprovalDtoV2025', forwardApprovalDtoV2025) - const localVarPath = `/access-request-approvals/{approvalId}/forward` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(forwardApprovalDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/approval-summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (fromDate !== undefined) { - localVarQueryParameter['from-date'] = fromDate; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers: async (accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestId' is not null or undefined - assertParamExists('listAccessRequestApprovers', 'accessRequestId', accessRequestId) - const localVarPath = `/access-request-approvals/{accessRequestId}/approvers` - .replace(`{${"accessRequestId"}}`, encodeURIComponent(String(accessRequestId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/pending`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2025} commentDtoV2025 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest: async (approvalId: string, commentDtoV2025: CommentDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('rejectAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDtoV2025' is not null or undefined - assertParamExists('rejectAccessRequest', 'commentDtoV2025', commentDtoV2025) - const localVarPath = `/access-request-approvals/{approvalId}/reject` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestApprovalsV2025Api - functional programming interface - * @export - */ -export const AccessRequestApprovalsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestApprovalsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2025} [commentDtoV2025] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveAccessRequest(approvalId: string, commentDtoV2025?: CommentDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequest(approvalId, commentDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.approveAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2025} forwardApprovalDtoV2025 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardAccessRequest(approvalId: string, forwardApprovalDtoV2025: ForwardApprovalDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequest(approvalId, forwardApprovalDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.forwardAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummary(ownerId, fromDate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.getAccessRequestApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestApprovers(accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestApprovers(accessRequestId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.listAccessRequestApprovers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.listCompletedApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.listPendingApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2025} commentDtoV2025 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectAccessRequest(approvalId: string, commentDtoV2025: CommentDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequest(approvalId, commentDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2025Api.rejectAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestApprovalsV2025Api - factory interface - * @export - */ -export const AccessRequestApprovalsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestApprovalsV2025ApiFp(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2025ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2025ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals(requestParameters: AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2025ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals(requestParameters: AccessRequestApprovalsV2025ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2025ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveAccessRequest operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiApproveAccessRequestRequest - */ -export interface AccessRequestApprovalsV2025ApiApproveAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiApproveAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2025} - * @memberof AccessRequestApprovalsV2025ApiApproveAccessRequest - */ - readonly commentDtoV2025?: CommentDtoV2025 -} - -/** - * Request parameters for forwardAccessRequest operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiForwardAccessRequestRequest - */ -export interface AccessRequestApprovalsV2025ApiForwardAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiForwardAccessRequest - */ - readonly approvalId: string - - /** - * Information about the forwarded approval. - * @type {ForwardApprovalDtoV2025} - * @memberof AccessRequestApprovalsV2025ApiForwardAccessRequest - */ - readonly forwardApprovalDtoV2025: ForwardApprovalDtoV2025 -} - -/** - * Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest - */ -export interface AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest { - /** - * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummary - */ - readonly ownerId?: string - - /** - * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummary - */ - readonly fromDate?: string -} - -/** - * Request parameters for listAccessRequestApprovers operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest - */ -export interface AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest { - /** - * Access Request ID. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListAccessRequestApprovers - */ - readonly accessRequestId: string - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListAccessRequestApprovers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListAccessRequestApprovers - */ - readonly offset?: number - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestApprovalsV2025ApiListAccessRequestApprovers - */ - readonly count?: boolean -} - -/** - * Request parameters for listCompletedApprovals operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest - */ -export interface AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest { - /** - * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListCompletedApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listPendingApprovals operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiListPendingApprovalsRequest - */ -export interface AccessRequestApprovalsV2025ApiListPendingApprovalsRequest { - /** - * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiListPendingApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for rejectAccessRequest operation in AccessRequestApprovalsV2025Api. - * @export - * @interface AccessRequestApprovalsV2025ApiRejectAccessRequestRequest - */ -export interface AccessRequestApprovalsV2025ApiRejectAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2025ApiRejectAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2025} - * @memberof AccessRequestApprovalsV2025ApiRejectAccessRequest - */ - readonly commentDtoV2025: CommentDtoV2025 -} - -/** - * AccessRequestApprovalsV2025Api - object-oriented interface - * @export - * @class AccessRequestApprovalsV2025Api - * @extends {BaseAPI} - */ -export class AccessRequestApprovalsV2025Api extends BaseAPI { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2025ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public approveAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2025ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public forwardAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2025ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2025ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public listCompletedApprovals(requestParameters: AccessRequestApprovalsV2025ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2025ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public listPendingApprovals(requestParameters: AccessRequestApprovalsV2025ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2025ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2025Api - */ - public rejectAccessRequest(requestParameters: AccessRequestApprovalsV2025ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2025ApiFp(this.configuration).rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestIdentityMetricsV2025Api - axios parameter creator - * @export - */ -export const AccessRequestIdentityMetricsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2025} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics: async (identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'identityId', identityId) - // verify required parameter 'requestedObjectId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'requestedObjectId', requestedObjectId) - // verify required parameter 'type' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'type', type) - const localVarPath = `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"requestedObjectId"}}`, encodeURIComponent(String(requestedObjectId))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2025Api - functional programming interface - * @export - */ -export const AccessRequestIdentityMetricsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestIdentityMetricsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2025} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestIdentityMetrics(identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestIdentityMetrics(identityId, requestedObjectId, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestIdentityMetricsV2025Api.getAccessRequestIdentityMetrics']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2025Api - factory interface - * @export - */ -export const AccessRequestIdentityMetricsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestIdentityMetricsV2025ApiFp(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccessRequestIdentityMetrics operation in AccessRequestIdentityMetricsV2025Api. - * @export - * @interface AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest - */ -export interface AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest { - /** - * Manager\'s identity ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetrics - */ - readonly identityId: string - - /** - * Requested access item\'s ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetrics - */ - readonly requestedObjectId: string - - /** - * Requested access item\'s type. - * @type {'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE'} - * @memberof AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetrics - */ - readonly type: GetAccessRequestIdentityMetricsTypeV2025 -} - -/** - * AccessRequestIdentityMetricsV2025Api - object-oriented interface - * @export - * @class AccessRequestIdentityMetricsV2025Api - * @extends {BaseAPI} - */ -export class AccessRequestIdentityMetricsV2025Api extends BaseAPI { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestIdentityMetricsV2025Api - */ - public getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2025ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestIdentityMetricsV2025ApiFp(this.configuration).getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetAccessRequestIdentityMetricsTypeV2025 = { - Entitlement: 'ENTITLEMENT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE' -} as const; -export type GetAccessRequestIdentityMetricsTypeV2025 = typeof GetAccessRequestIdentityMetricsTypeV2025[keyof typeof GetAccessRequestIdentityMetricsTypeV2025]; - - -/** - * AccessRequestsV2025Api - axios parameter creator - * @export - */ -export const AccessRequestsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2025} bulkApproveAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest: async (bulkApproveAccessRequestV2025: BulkApproveAccessRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveAccessRequestV2025' is not null or undefined - assertParamExists('approveBulkAccessRequest', 'bulkApproveAccessRequestV2025', bulkApproveAccessRequestV2025) - const localVarPath = `/access-request-approvals/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveAccessRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2025} cancelAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest: async (cancelAccessRequestV2025: CancelAccessRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cancelAccessRequestV2025' is not null or undefined - assertParamExists('cancelAccessRequest', 'cancelAccessRequestV2025', cancelAccessRequestV2025) - const localVarPath = `/access-requests/cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(cancelAccessRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2025} bulkCancelAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk: async (bulkCancelAccessRequestV2025: BulkCancelAccessRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkCancelAccessRequestV2025' is not null or undefined - assertParamExists('cancelAccessRequestInBulk', 'bulkCancelAccessRequestV2025', bulkCancelAccessRequestV2025) - const localVarPath = `/access-requests/bulk-cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkCancelAccessRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2025} closeAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest: async (closeAccessRequestV2025: CloseAccessRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'closeAccessRequestV2025' is not null or undefined - assertParamExists('closeAccessRequest', 'closeAccessRequestV2025', closeAccessRequestV2025) - const localVarPath = `/access-requests/close`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(closeAccessRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2025} accessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest: async (accessRequestV2025: AccessRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestV2025' is not null or undefined - assertParamExists('createAccessRequest', 'accessRequestV2025', accessRequestV2025) - const localVarPath = `/access-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity: async (identityId: string, entitlementId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'identityId', identityId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'entitlementId', entitlementId) - const localVarPath = `/revocable-objects` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus: async (xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('listAdministratorsAccessRequestStatus', 'xSailPointExperimental', xSailPointExperimental) - const localVarPath = `/access-request-administration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2025} accountsSelectionRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections: async (accountsSelectionRequestV2025: AccountsSelectionRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountsSelectionRequestV2025' is not null or undefined - assertParamExists('loadAccountSelections', 'accountsSelectionRequestV2025', accountsSelectionRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-requests/accounts-selection`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountsSelectionRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2025} accessRequestConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig: async (accessRequestConfigV2025: AccessRequestConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestConfigV2025' is not null or undefined - assertParamExists('setAccessRequestConfig', 'accessRequestConfigV2025', accessRequestConfigV2025) - const localVarPath = `/access-request-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestsV2025Api - functional programming interface - * @export - */ -export const AccessRequestsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2025} bulkApproveAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveBulkAccessRequest(bulkApproveAccessRequestV2025: BulkApproveAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkAccessRequest(bulkApproveAccessRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.approveBulkAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2025} cancelAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequest(cancelAccessRequestV2025: CancelAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequest(cancelAccessRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.cancelAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2025} bulkCancelAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequestInBulk(bulkCancelAccessRequestV2025: BulkCancelAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequestInBulk(bulkCancelAccessRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.cancelAccessRequestInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2025} closeAccessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async closeAccessRequest(closeAccessRequestV2025: CloseAccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.closeAccessRequest(closeAccessRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.closeAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2025} accessRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessRequest(accessRequestV2025: AccessRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequest(accessRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.createAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.getAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDetailsForIdentity(identityId: string, entitlementId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDetailsForIdentity(identityId, entitlementId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.getEntitlementDetailsForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatus(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.listAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAdministratorsAccessRequestStatus(xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAdministratorsAccessRequestStatus(xSailPointExperimental, requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.listAdministratorsAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2025} accountsSelectionRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async loadAccountSelections(accountsSelectionRequestV2025: AccountsSelectionRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.loadAccountSelections(accountsSelectionRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.loadAccountSelections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2025} accessRequestConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setAccessRequestConfig(accessRequestConfigV2025: AccessRequestConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfig(accessRequestConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2025Api.setAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestsV2025Api - factory interface - * @export - */ -export const AccessRequestsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestsV2025ApiFp(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2025ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest(requestParameters: AccessRequestsV2025ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2025ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest(requestParameters: AccessRequestsV2025ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2025ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk(requestParameters: AccessRequestsV2025ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2025ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest(requestParameters: AccessRequestsV2025ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.closeAccessRequest(requestParameters.closeAccessRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2025ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest(requestParameters: AccessRequestsV2025ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessRequest(requestParameters.accessRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2025ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus(requestParameters: AccessRequestsV2025ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2025ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections(requestParameters: AccessRequestsV2025ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.loadAccountSelections(requestParameters.accountsSelectionRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2025ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig(requestParameters: AccessRequestsV2025ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestConfig(requestParameters.accessRequestConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveBulkAccessRequest operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiApproveBulkAccessRequestRequest - */ -export interface AccessRequestsV2025ApiApproveBulkAccessRequestRequest { - /** - * - * @type {BulkApproveAccessRequestV2025} - * @memberof AccessRequestsV2025ApiApproveBulkAccessRequest - */ - readonly bulkApproveAccessRequestV2025: BulkApproveAccessRequestV2025 -} - -/** - * Request parameters for cancelAccessRequest operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiCancelAccessRequestRequest - */ -export interface AccessRequestsV2025ApiCancelAccessRequestRequest { - /** - * - * @type {CancelAccessRequestV2025} - * @memberof AccessRequestsV2025ApiCancelAccessRequest - */ - readonly cancelAccessRequestV2025: CancelAccessRequestV2025 -} - -/** - * Request parameters for cancelAccessRequestInBulk operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiCancelAccessRequestInBulkRequest - */ -export interface AccessRequestsV2025ApiCancelAccessRequestInBulkRequest { - /** - * - * @type {BulkCancelAccessRequestV2025} - * @memberof AccessRequestsV2025ApiCancelAccessRequestInBulk - */ - readonly bulkCancelAccessRequestV2025: BulkCancelAccessRequestV2025 -} - -/** - * Request parameters for closeAccessRequest operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiCloseAccessRequestRequest - */ -export interface AccessRequestsV2025ApiCloseAccessRequestRequest { - /** - * - * @type {CloseAccessRequestV2025} - * @memberof AccessRequestsV2025ApiCloseAccessRequest - */ - readonly closeAccessRequestV2025: CloseAccessRequestV2025 -} - -/** - * Request parameters for createAccessRequest operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiCreateAccessRequestRequest - */ -export interface AccessRequestsV2025ApiCreateAccessRequestRequest { - /** - * - * @type {AccessRequestV2025} - * @memberof AccessRequestsV2025ApiCreateAccessRequest - */ - readonly accessRequestV2025: AccessRequestV2025 -} - -/** - * Request parameters for getEntitlementDetailsForIdentity operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest - */ -export interface AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest { - /** - * The identity ID. - * @type {string} - * @memberof AccessRequestsV2025ApiGetEntitlementDetailsForIdentity - */ - readonly identityId: string - - /** - * The entitlement ID - * @type {string} - * @memberof AccessRequestsV2025ApiGetEntitlementDetailsForIdentity - */ - readonly entitlementId: string -} - -/** - * Request parameters for listAccessRequestStatus operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiListAccessRequestStatusRequest - */ -export interface AccessRequestsV2025ApiListAccessRequestStatusRequest { - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name** - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for listAdministratorsAccessRequestStatus operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest - */ -export interface AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly xSailPointExperimental: string - - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name, accessRequestId** - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2025ApiListAdministratorsAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for loadAccountSelections operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiLoadAccountSelectionsRequest - */ -export interface AccessRequestsV2025ApiLoadAccountSelectionsRequest { - /** - * - * @type {AccountsSelectionRequestV2025} - * @memberof AccessRequestsV2025ApiLoadAccountSelections - */ - readonly accountsSelectionRequestV2025: AccountsSelectionRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2025ApiLoadAccountSelections - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestConfig operation in AccessRequestsV2025Api. - * @export - * @interface AccessRequestsV2025ApiSetAccessRequestConfigRequest - */ -export interface AccessRequestsV2025ApiSetAccessRequestConfigRequest { - /** - * - * @type {AccessRequestConfigV2025} - * @memberof AccessRequestsV2025ApiSetAccessRequestConfig - */ - readonly accessRequestConfigV2025: AccessRequestConfigV2025 -} - -/** - * AccessRequestsV2025Api - object-oriented interface - * @export - * @class AccessRequestsV2025Api - * @extends {BaseAPI} - */ -export class AccessRequestsV2025Api extends BaseAPI { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2025ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public approveBulkAccessRequest(requestParameters: AccessRequestsV2025ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2025ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public cancelAccessRequest(requestParameters: AccessRequestsV2025ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2025ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public cancelAccessRequestInBulk(requestParameters: AccessRequestsV2025ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2025ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public closeAccessRequest(requestParameters: AccessRequestsV2025ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).closeAccessRequest(requestParameters.closeAccessRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2025ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public createAccessRequest(requestParameters: AccessRequestsV2025ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).createAccessRequest(requestParameters.accessRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).getAccessRequestConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2025ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2025ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public listAccessRequestStatus(requestParameters: AccessRequestsV2025ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2025ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2025ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public loadAccountSelections(requestParameters: AccessRequestsV2025ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).loadAccountSelections(requestParameters.accountsSelectionRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2025ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsV2025Api - */ - public setAccessRequestConfig(requestParameters: AccessRequestsV2025ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2025ApiFp(this.configuration).setAccessRequestConfig(requestParameters.accessRequestConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountActivitiesV2025Api - axios parameter creator - * @export - */ -export const AccountActivitiesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountActivity', 'id', id) - const localVarPath = `/account-activities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-activities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountActivitiesV2025Api - functional programming interface - * @export - */ -export const AccountActivitiesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountActivitiesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountActivity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2025Api.getAccountActivity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccountActivities(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivities(requestedFor, requestedBy, regardingIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2025Api.listAccountActivities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountActivitiesV2025Api - factory interface - * @export - */ -export const AccountActivitiesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountActivitiesV2025ApiFp(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2025ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity(requestParameters: AccountActivitiesV2025ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2025ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities(requestParameters: AccountActivitiesV2025ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountActivity operation in AccountActivitiesV2025Api. - * @export - * @interface AccountActivitiesV2025ApiGetAccountActivityRequest - */ -export interface AccountActivitiesV2025ApiGetAccountActivityRequest { - /** - * The account activity id - * @type {string} - * @memberof AccountActivitiesV2025ApiGetAccountActivity - */ - readonly id: string -} - -/** - * Request parameters for listAccountActivities operation in AccountActivitiesV2025Api. - * @export - * @interface AccountActivitiesV2025ApiListAccountActivitiesRequest - */ -export interface AccountActivitiesV2025ApiListAccountActivitiesRequest { - /** - * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly requestedFor?: string - - /** - * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly requestedBy?: string - - /** - * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly regardingIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @type {string} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - 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: **type, created, modified** - * @type {string} - * @memberof AccountActivitiesV2025ApiListAccountActivities - */ - readonly sorters?: string -} - -/** - * AccountActivitiesV2025Api - object-oriented interface - * @export - * @class AccountActivitiesV2025Api - * @extends {BaseAPI} - */ -export class AccountActivitiesV2025Api extends BaseAPI { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2025ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2025Api - */ - public getAccountActivity(requestParameters: AccountActivitiesV2025ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2025ApiFp(this.configuration).getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2025ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2025Api - */ - public listAccountActivities(requestParameters: AccountActivitiesV2025ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2025ApiFp(this.configuration).listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountAggregationsV2025Api - axios parameter creator - * @export - */ -export const AccountAggregationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountAggregationStatus', 'id', id) - const localVarPath = `/account-aggregations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountAggregationsV2025Api - functional programming interface - * @export - */ -export const AccountAggregationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountAggregationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountAggregationStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountAggregationStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountAggregationsV2025Api.getAccountAggregationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountAggregationsV2025Api - factory interface - * @export - */ -export const AccountAggregationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountAggregationsV2025ApiFp(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2025ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus(requestParameters: AccountAggregationsV2025ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountAggregationStatus operation in AccountAggregationsV2025Api. - * @export - * @interface AccountAggregationsV2025ApiGetAccountAggregationStatusRequest - */ -export interface AccountAggregationsV2025ApiGetAccountAggregationStatusRequest { - /** - * The account aggregation id - * @type {string} - * @memberof AccountAggregationsV2025ApiGetAccountAggregationStatus - */ - readonly id: string -} - -/** - * AccountAggregationsV2025Api - object-oriented interface - * @export - * @class AccountAggregationsV2025Api - * @extends {BaseAPI} - */ -export class AccountAggregationsV2025Api extends BaseAPI { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2025ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountAggregationsV2025Api - */ - public getAccountAggregationStatus(requestParameters: AccountAggregationsV2025ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountAggregationsV2025ApiFp(this.configuration).getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountUsagesV2025Api - axios parameter creator - * @export - */ -export const AccountUsagesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('getUsagesByAccountId', 'accountId', accountId) - const localVarPath = `/account-usages/{accountId}/summaries` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountUsagesV2025Api - functional programming interface - * @export - */ -export const AccountUsagesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountUsagesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountId(accountId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountUsagesV2025Api.getUsagesByAccountId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountUsagesV2025Api - factory interface - * @export - */ -export const AccountUsagesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountUsagesV2025ApiFp(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2025ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId(requestParameters: AccountUsagesV2025ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getUsagesByAccountId operation in AccountUsagesV2025Api. - * @export - * @interface AccountUsagesV2025ApiGetUsagesByAccountIdRequest - */ -export interface AccountUsagesV2025ApiGetUsagesByAccountIdRequest { - /** - * ID of IDN account - * @type {string} - * @memberof AccountUsagesV2025ApiGetUsagesByAccountId - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2025ApiGetUsagesByAccountId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2025ApiGetUsagesByAccountId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountUsagesV2025ApiGetUsagesByAccountId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof AccountUsagesV2025ApiGetUsagesByAccountId - */ - readonly sorters?: string -} - -/** - * AccountUsagesV2025Api - object-oriented interface - * @export - * @class AccountUsagesV2025Api - * @extends {BaseAPI} - */ -export class AccountUsagesV2025Api extends BaseAPI { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2025ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountUsagesV2025Api - */ - public getUsagesByAccountId(requestParameters: AccountUsagesV2025ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountUsagesV2025ApiFp(this.configuration).getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountsV2025Api - axios parameter creator - * @export - */ -export const AccountsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2025} accountAttributesCreateV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount: async (accountAttributesCreateV2025: AccountAttributesCreateV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountAttributesCreateV2025' is not null or undefined - assertParamExists('createAccount', 'accountAttributesCreateV2025', accountAttributesCreateV2025) - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesCreateV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountAsync', 'id', id) - const localVarPath = `/accounts/{id}/remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2025} accountToggleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount: async (id: string, accountToggleRequestV2025: AccountToggleRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2025' is not null or undefined - assertParamExists('disableAccount', 'accountToggleRequestV2025', accountToggleRequestV2025) - const localVarPath = `/accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2025} identitiesAccountsBulkRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities: async (identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2025' is not null or undefined - assertParamExists('disableAccountsForIdentities', 'identitiesAccountsBulkRequestV2025', identitiesAccountsBulkRequestV2025) - const localVarPath = `/identities-accounts/disable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2025} accountToggleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount: async (id: string, accountToggleRequestV2025: AccountToggleRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2025' is not null or undefined - assertParamExists('enableAccount', 'accountToggleRequestV2025', accountToggleRequestV2025) - const localVarPath = `/accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2025} identitiesAccountsBulkRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities: async (identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2025' is not null or undefined - assertParamExists('enableAccountsForIdentities', 'identitiesAccountsBulkRequestV2025', identitiesAccountsBulkRequestV2025) - const localVarPath = `/identities-accounts/enable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountEntitlements', 'id', id) - const localVarPath = `/accounts/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2025} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **recommendation.type**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts: async (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2025, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - 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, - }; - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2025} accountAttributesV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount: async (id: string, accountAttributesV2025: AccountAttributesV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putAccount', 'id', id) - // verify required parameter 'accountAttributesV2025' is not null or undefined - assertParamExists('putAccount', 'accountAttributesV2025', accountAttributesV2025) - const localVarPath = `/accounts/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReloadAccount', 'id', id) - const localVarPath = `/accounts/{id}/reload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2025} accountUnlockRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount: async (id: string, accountUnlockRequestV2025: AccountUnlockRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unlockAccount', 'id', id) - // verify required parameter 'accountUnlockRequestV2025' is not null or undefined - assertParamExists('unlockAccount', 'accountUnlockRequestV2025', accountUnlockRequestV2025) - const localVarPath = `/accounts/{id}/unlock` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountUnlockRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateAccount', 'requestBody', requestBody) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountsV2025Api - functional programming interface - * @export - */ -export const AccountsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2025} accountAttributesCreateV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccount(accountAttributesCreateV2025: AccountAttributesCreateV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccount(accountAttributesCreateV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.createAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.deleteAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.deleteAccountAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2025} accountToggleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccount(id: string, accountToggleRequestV2025: AccountToggleRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccount(id, accountToggleRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.disableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.disableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2025} identitiesAccountsBulkRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountsForIdentities(identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountsForIdentities(identitiesAccountsBulkRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.disableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2025} accountToggleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccount(id: string, accountToggleRequestV2025: AccountToggleRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccount(id, accountToggleRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.enableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.enableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2025} identitiesAccountsBulkRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountsForIdentities(identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountsForIdentities(identitiesAccountsBulkRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.enableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.getAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.getAccountEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2025} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **recommendation.type**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccounts(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2025, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(limit, offset, count, detailLevel, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.listAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2025} accountAttributesV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putAccount(id: string, accountAttributesV2025: AccountAttributesV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putAccount(id, accountAttributesV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.putAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReloadAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.submitReloadAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2025} accountUnlockRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unlockAccount(id: string, accountUnlockRequestV2025: AccountUnlockRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(id, accountUnlockRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.unlockAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2025Api.updateAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountsV2025Api - factory interface - * @export - */ -export const AccountsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountsV2025ApiFp(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2025ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount(requestParameters: AccountsV2025ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccount(requestParameters.accountAttributesCreateV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2025ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount(requestParameters: AccountsV2025ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2025ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync(requestParameters: AccountsV2025ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2025ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount(requestParameters: AccountsV2025ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2025ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity(requestParameters: AccountsV2025ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2025ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities(requestParameters: AccountsV2025ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2025ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount(requestParameters: AccountsV2025ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2025ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity(requestParameters: AccountsV2025ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2025ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities(requestParameters: AccountsV2025ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2025ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount(requestParameters: AccountsV2025ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2025ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements(requestParameters: AccountsV2025ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2025ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts(requestParameters: AccountsV2025ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2025ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount(requestParameters: AccountsV2025ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putAccount(requestParameters.id, requestParameters.accountAttributesV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2025ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount(requestParameters: AccountsV2025ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2025ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount(requestParameters: AccountsV2025ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2025ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount(requestParameters: AccountsV2025ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiCreateAccountRequest - */ -export interface AccountsV2025ApiCreateAccountRequest { - /** - * - * @type {AccountAttributesCreateV2025} - * @memberof AccountsV2025ApiCreateAccount - */ - readonly accountAttributesCreateV2025: AccountAttributesCreateV2025 -} - -/** - * Request parameters for deleteAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiDeleteAccountRequest - */ -export interface AccountsV2025ApiDeleteAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2025ApiDeleteAccount - */ - readonly id: string -} - -/** - * Request parameters for deleteAccountAsync operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiDeleteAccountAsyncRequest - */ -export interface AccountsV2025ApiDeleteAccountAsyncRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2025ApiDeleteAccountAsync - */ - readonly id: string -} - -/** - * Request parameters for disableAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiDisableAccountRequest - */ -export interface AccountsV2025ApiDisableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2025ApiDisableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2025} - * @memberof AccountsV2025ApiDisableAccount - */ - readonly accountToggleRequestV2025: AccountToggleRequestV2025 -} - -/** - * Request parameters for disableAccountForIdentity operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiDisableAccountForIdentityRequest - */ -export interface AccountsV2025ApiDisableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2025ApiDisableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for disableAccountsForIdentities operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiDisableAccountsForIdentitiesRequest - */ -export interface AccountsV2025ApiDisableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2025} - * @memberof AccountsV2025ApiDisableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025 -} - -/** - * Request parameters for enableAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiEnableAccountRequest - */ -export interface AccountsV2025ApiEnableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2025ApiEnableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2025} - * @memberof AccountsV2025ApiEnableAccount - */ - readonly accountToggleRequestV2025: AccountToggleRequestV2025 -} - -/** - * Request parameters for enableAccountForIdentity operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiEnableAccountForIdentityRequest - */ -export interface AccountsV2025ApiEnableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2025ApiEnableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for enableAccountsForIdentities operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiEnableAccountsForIdentitiesRequest - */ -export interface AccountsV2025ApiEnableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2025} - * @memberof AccountsV2025ApiEnableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2025: IdentitiesAccountsBulkRequestV2025 -} - -/** - * Request parameters for getAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiGetAccountRequest - */ -export interface AccountsV2025ApiGetAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2025ApiGetAccount - */ - readonly id: string -} - -/** - * Request parameters for getAccountEntitlements operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiGetAccountEntitlementsRequest - */ -export interface AccountsV2025ApiGetAccountEntitlementsRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2025ApiGetAccountEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2025ApiGetAccountEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2025ApiGetAccountEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2025ApiGetAccountEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccounts operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiListAccountsRequest - */ -export interface AccountsV2025ApiListAccountsRequest { - /** - * 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 AccountsV2025ApiListAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2025ApiListAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2025ApiListAccounts - */ - readonly count?: boolean - - /** - * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof AccountsV2025ApiListAccounts - */ - readonly detailLevel?: ListAccountsDetailLevelV2025 - - /** - * 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **recommendation.type**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @type {string} - * @memberof AccountsV2025ApiListAccounts - */ - 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @type {string} - * @memberof AccountsV2025ApiListAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for putAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiPutAccountRequest - */ -export interface AccountsV2025ApiPutAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2025ApiPutAccount - */ - readonly id: string - - /** - * - * @type {AccountAttributesV2025} - * @memberof AccountsV2025ApiPutAccount - */ - readonly accountAttributesV2025: AccountAttributesV2025 -} - -/** - * Request parameters for submitReloadAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiSubmitReloadAccountRequest - */ -export interface AccountsV2025ApiSubmitReloadAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2025ApiSubmitReloadAccount - */ - readonly id: string -} - -/** - * Request parameters for unlockAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiUnlockAccountRequest - */ -export interface AccountsV2025ApiUnlockAccountRequest { - /** - * The account ID. - * @type {string} - * @memberof AccountsV2025ApiUnlockAccount - */ - readonly id: string - - /** - * - * @type {AccountUnlockRequestV2025} - * @memberof AccountsV2025ApiUnlockAccount - */ - readonly accountUnlockRequestV2025: AccountUnlockRequestV2025 -} - -/** - * Request parameters for updateAccount operation in AccountsV2025Api. - * @export - * @interface AccountsV2025ApiUpdateAccountRequest - */ -export interface AccountsV2025ApiUpdateAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2025ApiUpdateAccount - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AccountsV2025ApiUpdateAccount - */ - readonly requestBody: Array -} - -/** - * AccountsV2025Api - object-oriented interface - * @export - * @class AccountsV2025Api - * @extends {BaseAPI} - */ -export class AccountsV2025Api extends BaseAPI { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2025ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public createAccount(requestParameters: AccountsV2025ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).createAccount(requestParameters.accountAttributesCreateV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2025ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public deleteAccount(requestParameters: AccountsV2025ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).deleteAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2025ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public deleteAccountAsync(requestParameters: AccountsV2025ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2025ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public disableAccount(requestParameters: AccountsV2025ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2025ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public disableAccountForIdentity(requestParameters: AccountsV2025ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2025ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public disableAccountsForIdentities(requestParameters: AccountsV2025ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2025ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public enableAccount(requestParameters: AccountsV2025ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2025ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public enableAccountForIdentity(requestParameters: AccountsV2025ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2025ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public enableAccountsForIdentities(requestParameters: AccountsV2025ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2025ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public getAccount(requestParameters: AccountsV2025ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).getAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2025ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public getAccountEntitlements(requestParameters: AccountsV2025ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2025ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public listAccounts(requestParameters: AccountsV2025ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2025ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public putAccount(requestParameters: AccountsV2025ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).putAccount(requestParameters.id, requestParameters.accountAttributesV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2025ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public submitReloadAccount(requestParameters: AccountsV2025ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2025ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public unlockAccount(requestParameters: AccountsV2025ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2025ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2025Api - */ - public updateAccount(requestParameters: AccountsV2025ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2025ApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListAccountsDetailLevelV2025 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type ListAccountsDetailLevelV2025 = typeof ListAccountsDetailLevelV2025[keyof typeof ListAccountsDetailLevelV2025]; - - -/** - * ApiUsageV2025Api - axios parameter creator - * @export - */ -export const ApiUsageV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTotalCount: async (xSailPointExperimental?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/api-usage/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listApiSummary: async (xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/api-usage/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApiUsageV2025Api - functional programming interface - * @export - */ -export const ApiUsageV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApiUsageV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTotalCount(xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTotalCount(xSailPointExperimental, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApiUsageV2025Api.getTotalCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listApiSummary(xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listApiSummary(xSailPointExperimental, filters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApiUsageV2025Api.listApiSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApiUsageV2025Api - factory interface - * @export - */ -export const ApiUsageV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApiUsageV2025ApiFp(configuration) - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {ApiUsageV2025ApiGetTotalCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTotalCount(requestParameters: ApiUsageV2025ApiGetTotalCountRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTotalCount(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {ApiUsageV2025ApiListApiSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listApiSummary(requestParameters: ApiUsageV2025ApiListApiSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listApiSummary(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTotalCount operation in ApiUsageV2025Api. - * @export - * @interface ApiUsageV2025ApiGetTotalCountRequest - */ -export interface ApiUsageV2025ApiGetTotalCountRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApiUsageV2025ApiGetTotalCount - */ - readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @type {string} - * @memberof ApiUsageV2025ApiGetTotalCount - */ - readonly filters?: string -} - -/** - * Request parameters for listApiSummary operation in ApiUsageV2025Api. - * @export - * @interface ApiUsageV2025ApiListApiSummaryRequest - */ -export interface ApiUsageV2025ApiListApiSummaryRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApiUsageV2025ApiListApiSummary - */ - readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @type {string} - * @memberof ApiUsageV2025ApiListApiSummary - */ - readonly filters?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof ApiUsageV2025ApiListApiSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof ApiUsageV2025ApiListApiSummary - */ - readonly offset?: number -} - -/** - * ApiUsageV2025Api - object-oriented interface - * @export - * @class ApiUsageV2025Api - * @extends {BaseAPI} - */ -export class ApiUsageV2025Api extends BaseAPI { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {ApiUsageV2025ApiGetTotalCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApiUsageV2025Api - */ - public getTotalCount(requestParameters: ApiUsageV2025ApiGetTotalCountRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApiUsageV2025ApiFp(this.configuration).getTotalCount(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {ApiUsageV2025ApiListApiSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApiUsageV2025Api - */ - public listApiSummary(requestParameters: ApiUsageV2025ApiListApiSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApiUsageV2025ApiFp(this.configuration).listApiSummary(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ApplicationDiscoveryV2025Api - axios parameter creator - * @export - */ -export const ApplicationDiscoveryV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2025, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/discovered-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (filter !== undefined) { - localVarQueryParameter['filter'] = filter; - } - - 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, - }; - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/manual-discover-applications-template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'file' is not null or undefined - assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file) - const localVarPath = `/manual-discover-applications`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryRequestV2025} applicationDiscoveryRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startApplicationDiscovery: async (applicationDiscoveryRequestV2025: ApplicationDiscoveryRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'applicationDiscoveryRequestV2025' is not null or undefined - assertParamExists('startApplicationDiscovery', 'applicationDiscoveryRequestV2025', applicationDiscoveryRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/discover-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(applicationDiscoveryRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApplicationDiscoveryV2025Api - functional programming interface - * @export - */ -export const ApplicationDiscoveryV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApplicationDiscoveryV2025ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplications(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2025, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, detail, filter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2025Api.getDiscoveredApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2025Api.getManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendManualDiscoverApplicationsCsvTemplate(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2025Api.sendManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryRequestV2025} applicationDiscoveryRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startApplicationDiscovery(applicationDiscoveryRequestV2025: ApplicationDiscoveryRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startApplicationDiscovery(applicationDiscoveryRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2025Api.startApplicationDiscovery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApplicationDiscoveryV2025Api - factory interface - * @export - */ -export const ApplicationDiscoveryV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApplicationDiscoveryV2025ApiFp(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startApplicationDiscovery(requestParameters: ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startApplicationDiscovery(requestParameters.applicationDiscoveryRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryV2025Api. - * @export - * @interface ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest - */ -export interface ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest { - /** - * 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 ApplicationDiscoveryV2025ApiGetDiscoveredApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApplicationDiscoveryV2025ApiGetDiscoveredApplications - */ - readonly offset?: number - - /** - * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof ApplicationDiscoveryV2025ApiGetDiscoveredApplications - */ - readonly detail?: GetDiscoveredApplicationsDetailV2025 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @type {string} - * @memberof ApplicationDiscoveryV2025ApiGetDiscoveredApplications - */ - readonly filter?: 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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @type {string} - * @memberof ApplicationDiscoveryV2025ApiGetDiscoveredApplications - */ - readonly sorters?: string -} - -/** - * Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryV2025Api. - * @export - * @interface ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest - */ -export interface ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplate - */ - readonly file: File -} - -/** - * Request parameters for startApplicationDiscovery operation in ApplicationDiscoveryV2025Api. - * @export - * @interface ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest - */ -export interface ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest { - /** - * - * @type {ApplicationDiscoveryRequestV2025} - * @memberof ApplicationDiscoveryV2025ApiStartApplicationDiscovery - */ - readonly applicationDiscoveryRequestV2025: ApplicationDiscoveryRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApplicationDiscoveryV2025ApiStartApplicationDiscovery - */ - readonly xSailPointExperimental?: string -} - -/** - * ApplicationDiscoveryV2025Api - object-oriented interface - * @export - * @class ApplicationDiscoveryV2025Api - * @extends {BaseAPI} - */ -export class ApplicationDiscoveryV2025Api extends BaseAPI { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2025Api - */ - public getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2025ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2025ApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2025Api - */ - public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2025ApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2025Api - */ - public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2025ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2025ApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2025Api - */ - public startApplicationDiscovery(requestParameters: ApplicationDiscoveryV2025ApiStartApplicationDiscoveryRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2025ApiFp(this.configuration).startApplicationDiscovery(requestParameters.applicationDiscoveryRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetDiscoveredApplicationsDetailV2025 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetDiscoveredApplicationsDetailV2025 = typeof GetDiscoveredApplicationsDetailV2025[keyof typeof GetDiscoveredApplicationsDetailV2025]; - - -/** - * ApprovalsV2025Api - axios parameter creator - * @export - */ -export const ApprovalsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. - * @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApproval: async (id: string, approvalApproveRequestV2025?: ApprovalApproveRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApproval', 'id', id) - const localVarPath = `/generic-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalApproveRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {BulkApproveRequestDTOV2025} bulkApproveRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalInBulk: async (bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveRequestDTOV2025' is not null or undefined - assertParamExists('approveApprovalInBulk', 'bulkApproveRequestDTOV2025', bulkApproveRequestDTOV2025) - const localVarPath = `/generic-approvals/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveRequestDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApproval: async (bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkCancelRequestDTOV2025' is not null or undefined - assertParamExists('cancelApproval', 'bulkCancelRequestDTOV2025', bulkCancelRequestDTOV2025) - const localVarPath = `/generic-approvals/bulk-cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkCancelRequestDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {DeleteApprovalConfigRequestScopeV2025} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApprovalConfigRequest: async (id: string, scope: DeleteApprovalConfigRequestScopeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteApprovalConfigRequest', 'id', id) - // verify required parameter 'scope' is not null or undefined - assertParamExists('deleteApprovalConfigRequest', 'scope', scope) - const localVarPath = `/generic-approvals/config/{id}/{scope}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApproval', 'id', id) - const localVarPath = `/generic-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. - * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. - * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. - * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals: async (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/generic-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (mine !== undefined) { - localVarQueryParameter['mine'] = mine; - } - - if (requesterId !== undefined) { - localVarQueryParameter['requesterId'] = requesterId; - } - - if (requesteeId !== undefined) { - localVarQueryParameter['requesteeId'] = requesteeId; - } - - if (approverId !== undefined) { - localVarQueryParameter['approverId'] = approverId; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (includeComments !== undefined) { - localVarQueryParameter['include-comments'] = includeComments; - } - - if (includeApprovers !== undefined) { - localVarQueryParameter['include-approvers'] = includeApprovers; - } - - if (includeReassignmentHistory !== undefined) { - localVarQueryParameter['include-reassignment-history'] = includeReassignmentHistory; - } - - if (includeBatchInfo !== undefined) { - localVarQueryParameter['include-batch-info'] = includeBatchInfo; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovalsConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApprovalsConfig', 'id', id) - const localVarPath = `/generic-approvals/config/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {BulkReassignRequestDTOV2025} bulkReassignRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - moveApproval: async (bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkReassignRequestDTOV2025' is not null or undefined - assertParamExists('moveApproval', 'bulkReassignRequestDTOV2025', bulkReassignRequestDTOV2025) - const localVarPath = `/generic-approvals/bulk-reassign`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkReassignRequestDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {PutApprovalsConfigScopeV2025} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {ApprovalConfigV2025} approvalConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApprovalsConfig: async (id: string, scope: PutApprovalsConfigScopeV2025, approvalConfigV2025: ApprovalConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putApprovalsConfig', 'id', id) - // verify required parameter 'scope' is not null or undefined - assertParamExists('putApprovalsConfig', 'scope', scope) - // verify required parameter 'approvalConfigV2025' is not null or undefined - assertParamExists('putApprovalsConfig', 'approvalConfigV2025', approvalConfigV2025) - const localVarPath = `/generic-approvals/config/{id}/{scope}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. - * @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApproval: async (id: string, approvalRejectRequestV2025?: ApprovalRejectRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApproval', 'id', id) - const localVarPath = `/generic-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalRejectRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {BulkRejectRequestDTOV2025} bulkRejectRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalInBulk: async (bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRejectRequestDTOV2025' is not null or undefined - assertParamExists('rejectApprovalInBulk', 'bulkRejectRequestDTOV2025', bulkRejectRequestDTOV2025) - const localVarPath = `/generic-approvals/bulk-reject`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRejectRequestDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsAttributes: async (id: string, approvalAttributesRequestV2025: ApprovalAttributesRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsAttributes', 'id', id) - // verify required parameter 'approvalAttributesRequestV2025' is not null or undefined - assertParamExists('updateApprovalsAttributes', 'approvalAttributesRequestV2025', approvalAttributesRequestV2025) - const localVarPath = `/generic-approvals/{id}/attributes` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalAttributesRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsComments: async (id: string, approvalCommentsRequestV2025: ApprovalCommentsRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsComments', 'id', id) - // verify required parameter 'approvalCommentsRequestV2025' is not null or undefined - assertParamExists('updateApprovalsComments', 'approvalCommentsRequestV2025', approvalCommentsRequestV2025) - const localVarPath = `/generic-approvals/{id}/comments` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalCommentsRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. - * @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsReassign: async (id: string, approvalReassignRequestV2025: ApprovalReassignRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsReassign', 'id', id) - // verify required parameter 'approvalReassignRequestV2025' is not null or undefined - assertParamExists('updateApprovalsReassign', 'approvalReassignRequestV2025', approvalReassignRequestV2025) - const localVarPath = `/generic-approvals/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalReassignRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApprovalsV2025Api - functional programming interface - * @export - */ -export const ApprovalsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApprovalsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. - * @param {ApprovalApproveRequestV2025} [approvalApproveRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApproval(id: string, approvalApproveRequestV2025?: ApprovalApproveRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApproval(id, approvalApproveRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.approveApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {BulkApproveRequestDTOV2025} bulkApproveRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalInBulk(bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalInBulk(bulkApproveRequestDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.approveApprovalInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {BulkCancelRequestDTOV2025} bulkCancelRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelApproval(bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApproval(bulkCancelRequestDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.cancelApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {DeleteApprovalConfigRequestScopeV2025} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteApprovalConfigRequest(id: string, scope: DeleteApprovalConfigRequestScopeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApprovalConfigRequest(id, scope, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.deleteApprovalConfigRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApproval(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.getApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. - * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. - * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. - * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeReassignmentHistory, includeBatchInfo, filters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.getApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApprovalsConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovalsConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.getApprovalsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {BulkReassignRequestDTOV2025} bulkReassignRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async moveApproval(bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.moveApproval(bulkReassignRequestDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.moveApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {PutApprovalsConfigScopeV2025} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {ApprovalConfigV2025} approvalConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putApprovalsConfig(id: string, scope: PutApprovalsConfigScopeV2025, approvalConfigV2025: ApprovalConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putApprovalsConfig(id, scope, approvalConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.putApprovalsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. - * @param {ApprovalRejectRequestV2025} [approvalRejectRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApproval(id: string, approvalRejectRequestV2025?: ApprovalRejectRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApproval(id, approvalRejectRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.rejectApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {BulkRejectRequestDTOV2025} bulkRejectRequestDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalInBulk(bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalInBulk(bulkRejectRequestDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.rejectApprovalInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @param {ApprovalAttributesRequestV2025} approvalAttributesRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsAttributes(id: string, approvalAttributesRequestV2025: ApprovalAttributesRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsAttributes(id, approvalAttributesRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.updateApprovalsAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @param {ApprovalCommentsRequestV2025} approvalCommentsRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsComments(id: string, approvalCommentsRequestV2025: ApprovalCommentsRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsComments(id, approvalCommentsRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.updateApprovalsComments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. - * @param {ApprovalReassignRequestV2025} approvalReassignRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsReassign(id: string, approvalReassignRequestV2025: ApprovalReassignRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsReassign(id, approvalReassignRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2025Api.updateApprovalsReassign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApprovalsV2025Api - factory interface - * @export - */ -export const ApprovalsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApprovalsV2025ApiFp(configuration) - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApproval(requestParameters: ApprovalsV2025ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApproval(requestParameters.id, requestParameters.approvalApproveRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {ApprovalsV2025ApiApproveApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalInBulk(requestParameters: ApprovalsV2025ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApproval(requestParameters: ApprovalsV2025ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelApproval(requestParameters.bulkCancelRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {ApprovalsV2025ApiDeleteApprovalConfigRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApprovalConfigRequest(requestParameters: ApprovalsV2025ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApproval(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals(requestParameters: ApprovalsV2025ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {ApprovalsV2025ApiGetApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovalsConfig(requestParameters: ApprovalsV2025ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApprovalsConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {ApprovalsV2025ApiMoveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - moveApproval(requestParameters: ApprovalsV2025ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.moveApproval(requestParameters.bulkReassignRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {ApprovalsV2025ApiPutApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApproval(requestParameters: ApprovalsV2025ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApproval(requestParameters.id, requestParameters.approvalRejectRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {ApprovalsV2025ApiRejectApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalInBulk(requestParameters: ApprovalsV2025ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsAttributes(requestParameters: ApprovalsV2025ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsComments(requestParameters: ApprovalsV2025ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsReassign(requestParameters: ApprovalsV2025ApiUpdateApprovalsReassignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsReassign(requestParameters.id, requestParameters.approvalReassignRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApproval operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiApproveApprovalRequest - */ -export interface ApprovalsV2025ApiApproveApprovalRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to approve. - * @type {string} - * @memberof ApprovalsV2025ApiApproveApproval - */ - readonly id: string - - /** - * - * @type {ApprovalApproveRequestV2025} - * @memberof ApprovalsV2025ApiApproveApproval - */ - readonly approvalApproveRequestV2025?: ApprovalApproveRequestV2025 -} - -/** - * Request parameters for approveApprovalInBulk operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiApproveApprovalInBulkRequest - */ -export interface ApprovalsV2025ApiApproveApprovalInBulkRequest { - /** - * - * @type {BulkApproveRequestDTOV2025} - * @memberof ApprovalsV2025ApiApproveApprovalInBulk - */ - readonly bulkApproveRequestDTOV2025: BulkApproveRequestDTOV2025 -} - -/** - * Request parameters for cancelApproval operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiCancelApprovalRequest - */ -export interface ApprovalsV2025ApiCancelApprovalRequest { - /** - * - * @type {BulkCancelRequestDTOV2025} - * @memberof ApprovalsV2025ApiCancelApproval - */ - readonly bulkCancelRequestDTOV2025: BulkCancelRequestDTOV2025 -} - -/** - * Request parameters for deleteApprovalConfigRequest operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiDeleteApprovalConfigRequestRequest - */ -export interface ApprovalsV2025ApiDeleteApprovalConfigRequestRequest { - /** - * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {string} - * @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest - */ - readonly id: string - - /** - * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} - * @memberof ApprovalsV2025ApiDeleteApprovalConfigRequest - */ - readonly scope: DeleteApprovalConfigRequestScopeV2025 -} - -/** - * Request parameters for getApproval operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiGetApprovalRequest - */ -export interface ApprovalsV2025ApiGetApprovalRequest { - /** - * ID of the approval that is to be returned - * @type {string} - * @memberof ApprovalsV2025ApiGetApproval - */ - readonly id: string -} - -/** - * Request parameters for getApprovals operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiGetApprovalsRequest - */ -export interface ApprovalsV2025ApiGetApprovalsRequest { - /** - * Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly mine?: boolean - - /** - * Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly requesterId?: string - - /** - * Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly requesteeId?: string - - /** - * Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly approverId?: string - - /** - * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly count?: boolean - - /** - * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly countOnly?: boolean - - /** - * If set to true in the query, the approval requests returned will include comments. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly includeComments?: boolean - - /** - * If set to true in the query, the approval requests returned will include approvers. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly includeApprovers?: boolean - - /** - * If set to true in the query, the approval requests returned will include reassignment history. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly includeReassignmentHistory?: boolean - - /** - * If set to true in the query, the approval requests returned will include batch information. - * @type {boolean} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly includeBatchInfo?: 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @type {string} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2025ApiGetApprovals - */ - readonly offset?: number -} - -/** - * Request parameters for getApprovalsConfig operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiGetApprovalsConfigRequest - */ -export interface ApprovalsV2025ApiGetApprovalsConfigRequest { - /** - * The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @type {string} - * @memberof ApprovalsV2025ApiGetApprovalsConfig - */ - readonly id: string -} - -/** - * Request parameters for moveApproval operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiMoveApprovalRequest - */ -export interface ApprovalsV2025ApiMoveApprovalRequest { - /** - * - * @type {BulkReassignRequestDTOV2025} - * @memberof ApprovalsV2025ApiMoveApproval - */ - readonly bulkReassignRequestDTOV2025: BulkReassignRequestDTOV2025 -} - -/** - * Request parameters for putApprovalsConfig operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiPutApprovalsConfigRequest - */ -export interface ApprovalsV2025ApiPutApprovalsConfigRequest { - /** - * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {string} - * @memberof ApprovalsV2025ApiPutApprovalsConfig - */ - readonly id: string - - /** - * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} - * @memberof ApprovalsV2025ApiPutApprovalsConfig - */ - readonly scope: PutApprovalsConfigScopeV2025 - - /** - * - * @type {ApprovalConfigV2025} - * @memberof ApprovalsV2025ApiPutApprovalsConfig - */ - readonly approvalConfigV2025: ApprovalConfigV2025 -} - -/** - * Request parameters for rejectApproval operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiRejectApprovalRequest - */ -export interface ApprovalsV2025ApiRejectApprovalRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to reject. - * @type {string} - * @memberof ApprovalsV2025ApiRejectApproval - */ - readonly id: string - - /** - * - * @type {ApprovalRejectRequestV2025} - * @memberof ApprovalsV2025ApiRejectApproval - */ - readonly approvalRejectRequestV2025?: ApprovalRejectRequestV2025 -} - -/** - * Request parameters for rejectApprovalInBulk operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiRejectApprovalInBulkRequest - */ -export interface ApprovalsV2025ApiRejectApprovalInBulkRequest { - /** - * - * @type {BulkRejectRequestDTOV2025} - * @memberof ApprovalsV2025ApiRejectApprovalInBulk - */ - readonly bulkRejectRequestDTOV2025: BulkRejectRequestDTOV2025 -} - -/** - * Request parameters for updateApprovalsAttributes operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiUpdateApprovalsAttributesRequest - */ -export interface ApprovalsV2025ApiUpdateApprovalsAttributesRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @type {string} - * @memberof ApprovalsV2025ApiUpdateApprovalsAttributes - */ - readonly id: string - - /** - * - * @type {ApprovalAttributesRequestV2025} - * @memberof ApprovalsV2025ApiUpdateApprovalsAttributes - */ - readonly approvalAttributesRequestV2025: ApprovalAttributesRequestV2025 -} - -/** - * Request parameters for updateApprovalsComments operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiUpdateApprovalsCommentsRequest - */ -export interface ApprovalsV2025ApiUpdateApprovalsCommentsRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @type {string} - * @memberof ApprovalsV2025ApiUpdateApprovalsComments - */ - readonly id: string - - /** - * - * @type {ApprovalCommentsRequestV2025} - * @memberof ApprovalsV2025ApiUpdateApprovalsComments - */ - readonly approvalCommentsRequestV2025: ApprovalCommentsRequestV2025 -} - -/** - * Request parameters for updateApprovalsReassign operation in ApprovalsV2025Api. - * @export - * @interface ApprovalsV2025ApiUpdateApprovalsReassignRequest - */ -export interface ApprovalsV2025ApiUpdateApprovalsReassignRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to reassign. - * @type {string} - * @memberof ApprovalsV2025ApiUpdateApprovalsReassign - */ - readonly id: string - - /** - * - * @type {ApprovalReassignRequestV2025} - * @memberof ApprovalsV2025ApiUpdateApprovalsReassign - */ - readonly approvalReassignRequestV2025: ApprovalReassignRequestV2025 -} - -/** - * ApprovalsV2025Api - object-oriented interface - * @export - * @class ApprovalsV2025Api - * @extends {BaseAPI} - */ -export class ApprovalsV2025Api extends BaseAPI { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {ApprovalsV2025ApiApproveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public approveApproval(requestParameters: ApprovalsV2025ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).approveApproval(requestParameters.id, requestParameters.approvalApproveRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {ApprovalsV2025ApiApproveApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public approveApprovalInBulk(requestParameters: ApprovalsV2025ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {ApprovalsV2025ApiCancelApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public cancelApproval(requestParameters: ApprovalsV2025ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).cancelApproval(requestParameters.bulkCancelRequestDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {ApprovalsV2025ApiDeleteApprovalConfigRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public deleteApprovalConfigRequest(requestParameters: ApprovalsV2025ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {ApprovalsV2025ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public getApproval(requestParameters: ApprovalsV2025ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).getApproval(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {ApprovalsV2025ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public getApprovals(requestParameters: ApprovalsV2025ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {ApprovalsV2025ApiGetApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public getApprovalsConfig(requestParameters: ApprovalsV2025ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).getApprovalsConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {ApprovalsV2025ApiMoveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public moveApproval(requestParameters: ApprovalsV2025ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).moveApproval(requestParameters.bulkReassignRequestDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {ApprovalsV2025ApiPutApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public putApprovalsConfig(requestParameters: ApprovalsV2025ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {ApprovalsV2025ApiRejectApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public rejectApproval(requestParameters: ApprovalsV2025ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).rejectApproval(requestParameters.id, requestParameters.approvalRejectRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {ApprovalsV2025ApiRejectApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public rejectApprovalInBulk(requestParameters: ApprovalsV2025ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {ApprovalsV2025ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public updateApprovalsAttributes(requestParameters: ApprovalsV2025ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {ApprovalsV2025ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public updateApprovalsComments(requestParameters: ApprovalsV2025ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {ApprovalsV2025ApiUpdateApprovalsReassignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2025Api - */ - public updateApprovalsReassign(requestParameters: ApprovalsV2025ApiUpdateApprovalsReassignRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2025ApiFp(this.configuration).updateApprovalsReassign(requestParameters.id, requestParameters.approvalReassignRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteApprovalConfigRequestScopeV2025 = { - DomainObject: 'DOMAIN_OBJECT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - ApprovalType: 'APPROVAL_TYPE', - Tenant: 'TENANT' -} as const; -export type DeleteApprovalConfigRequestScopeV2025 = typeof DeleteApprovalConfigRequestScopeV2025[keyof typeof DeleteApprovalConfigRequestScopeV2025]; -/** - * @export - */ -export const PutApprovalsConfigScopeV2025 = { - DomainObject: 'DOMAIN_OBJECT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - ApprovalType: 'APPROVAL_TYPE', - Tenant: 'TENANT' -} as const; -export type PutApprovalsConfigScopeV2025 = typeof PutApprovalsConfigScopeV2025[keyof typeof PutApprovalsConfigScopeV2025]; - - -/** - * AppsV2025Api - axios parameter creator - * @export - */ -export const AppsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2025} sourceAppCreateDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp: async (sourceAppCreateDtoV2025: SourceAppCreateDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceAppCreateDtoV2025' is not null or undefined - assertParamExists('createSourceApp', 'sourceAppCreateDtoV2025', sourceAppCreateDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppCreateDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk: async (id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles/bulk-remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp: async (id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAccessProfilesForSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps: async (filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listAllUserApps', 'filters', filters) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/assigned`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp: async (id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAvailableAccountsForUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{id}/available-accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps: async (limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2025?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2025?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2025} [sourceAppBulkUpdateRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk: async (xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2025?: SourceAppBulkUpdateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppBulkUpdateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AppsV2025Api - functional programming interface - * @export - */ -export const AppsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AppsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2025} sourceAppCreateDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceApp(sourceAppCreateDtoV2025: SourceAppCreateDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceApp(sourceAppCreateDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.createSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesFromSourceAppByBulk(id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesFromSourceAppByBulk(id, requestBody, limit, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.deleteAccessProfilesFromSourceAppByBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.deleteSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.getSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesForSourceApp(id, limit, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAccessProfilesForSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAllSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllUserApps(filters, limit, count, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAllUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignedSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAssignedSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAccountsForUserApp(id, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAvailableAccountsForUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableSourceApps(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listAvailableSourceApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnedUserApps(limit, count, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.listOwnedUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSourceApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2025?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSourceApp(id, xSailPointExperimental, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.patchSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchUserApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2025?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchUserApp(id, xSailPointExperimental, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.patchUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2025} [sourceAppBulkUpdateRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceAppsInBulk(xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2025?: SourceAppBulkUpdateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceAppsInBulk(xSailPointExperimental, sourceAppBulkUpdateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2025Api.updateSourceAppsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AppsV2025Api - factory interface - * @export - */ -export const AppsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AppsV2025ApiFp(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2025ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp(requestParameters: AppsV2025ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceApp(requestParameters.sourceAppCreateDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2025ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp(requestParameters: AppsV2025ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2025ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp(requestParameters: AppsV2025ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2025ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp(requestParameters: AppsV2025ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2025ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp(requestParameters: AppsV2025ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2025ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps(requestParameters: AppsV2025ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2025ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp(requestParameters: AppsV2025ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2025ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp(requestParameters: AppsV2025ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2025ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps(requestParameters: AppsV2025ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2025ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps(requestParameters: AppsV2025ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2025ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp(requestParameters: AppsV2025ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2025ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp(requestParameters: AppsV2025ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2025ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk(requestParameters: AppsV2025ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiCreateSourceAppRequest - */ -export interface AppsV2025ApiCreateSourceAppRequest { - /** - * - * @type {SourceAppCreateDtoV2025} - * @memberof AppsV2025ApiCreateSourceApp - */ - readonly sourceAppCreateDtoV2025: SourceAppCreateDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiCreateSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteAccessProfilesFromSourceAppByBulk operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest - */ -export interface AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly requestBody: Array - - /** - * 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 AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly limit?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiDeleteSourceAppRequest - */ -export interface AppsV2025ApiDeleteSourceAppRequest { - /** - * source app ID. - * @type {string} - * @memberof AppsV2025ApiDeleteSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiDeleteSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiGetSourceAppRequest - */ -export interface AppsV2025ApiGetSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2025ApiGetSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiGetSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAccessProfilesForSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAccessProfilesForSourceAppRequest - */ -export interface AppsV2025ApiListAccessProfilesForSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2025ApiListAccessProfilesForSourceApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2025ApiListAccessProfilesForSourceApp - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2025ApiListAccessProfilesForSourceApp - */ - readonly offset?: number - - /** - * 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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof AppsV2025ApiListAccessProfilesForSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAccessProfilesForSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAllSourceAppRequest - */ -export interface AppsV2025ApiListAllSourceAppRequest { - /** - * 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 AppsV2025ApiListAllSourceApp - */ - 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 AppsV2025ApiListAllSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2025ApiListAllSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2025ApiListAllSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @type {string} - * @memberof AppsV2025ApiListAllSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAllSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllUserApps operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAllUserAppsRequest - */ -export interface AppsV2025ApiListAllUserAppsRequest { - /** - * 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2025ApiListAllUserApps - */ - readonly filters: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2025ApiListAllUserApps - */ - 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 AppsV2025ApiListAllUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2025ApiListAllUserApps - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAllUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAssignedSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAssignedSourceAppRequest - */ -export interface AppsV2025ApiListAssignedSourceAppRequest { - /** - * 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 AppsV2025ApiListAssignedSourceApp - */ - 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 AppsV2025ApiListAssignedSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2025ApiListAssignedSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, accountSource.id** - * @type {string} - * @memberof AppsV2025ApiListAssignedSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2025ApiListAssignedSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAssignedSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableAccountsForUserApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAvailableAccountsForUserAppRequest - */ -export interface AppsV2025ApiListAvailableAccountsForUserAppRequest { - /** - * ID of the user app - * @type {string} - * @memberof AppsV2025ApiListAvailableAccountsForUserApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2025ApiListAvailableAccountsForUserApp - */ - 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 AppsV2025ApiListAvailableAccountsForUserApp - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAvailableAccountsForUserApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableSourceApps operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListAvailableSourceAppsRequest - */ -export interface AppsV2025ApiListAvailableSourceAppsRequest { - /** - * 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 AppsV2025ApiListAvailableSourceApps - */ - 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 AppsV2025ApiListAvailableSourceApps - */ - readonly count?: boolean - - /** - * 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 AppsV2025ApiListAvailableSourceApps - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2025ApiListAvailableSourceApps - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2025ApiListAvailableSourceApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListAvailableSourceApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOwnedUserApps operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiListOwnedUserAppsRequest - */ -export interface AppsV2025ApiListOwnedUserAppsRequest { - /** - * 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 AppsV2025ApiListOwnedUserApps - */ - 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 AppsV2025ApiListOwnedUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2025ApiListOwnedUserApps - */ - readonly offset?: number - - /** - * 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2025ApiListOwnedUserApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiListOwnedUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSourceApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiPatchSourceAppRequest - */ -export interface AppsV2025ApiPatchSourceAppRequest { - /** - * ID of the source app to patch - * @type {string} - * @memberof AppsV2025ApiPatchSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiPatchSourceApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2025ApiPatchSourceApp - */ - readonly jsonPatchOperationV2025?: Array -} - -/** - * Request parameters for patchUserApp operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiPatchUserAppRequest - */ -export interface AppsV2025ApiPatchUserAppRequest { - /** - * ID of the user app to patch - * @type {string} - * @memberof AppsV2025ApiPatchUserApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiPatchUserApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2025ApiPatchUserApp - */ - readonly jsonPatchOperationV2025?: Array -} - -/** - * Request parameters for updateSourceAppsInBulk operation in AppsV2025Api. - * @export - * @interface AppsV2025ApiUpdateSourceAppsInBulkRequest - */ -export interface AppsV2025ApiUpdateSourceAppsInBulkRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2025ApiUpdateSourceAppsInBulk - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {SourceAppBulkUpdateRequestV2025} - * @memberof AppsV2025ApiUpdateSourceAppsInBulk - */ - readonly sourceAppBulkUpdateRequestV2025?: SourceAppBulkUpdateRequestV2025 -} - -/** - * AppsV2025Api - object-oriented interface - * @export - * @class AppsV2025Api - * @extends {BaseAPI} - */ -export class AppsV2025Api extends BaseAPI { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2025ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public createSourceApp(requestParameters: AppsV2025ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).createSourceApp(requestParameters.sourceAppCreateDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2025ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2025ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public deleteSourceApp(requestParameters: AppsV2025ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2025ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public getSourceApp(requestParameters: AppsV2025ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2025ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAccessProfilesForSourceApp(requestParameters: AppsV2025ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2025ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAllSourceApp(requestParameters: AppsV2025ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2025ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAllUserApps(requestParameters: AppsV2025ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2025ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAssignedSourceApp(requestParameters: AppsV2025ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2025ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAvailableAccountsForUserApp(requestParameters: AppsV2025ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2025ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listAvailableSourceApps(requestParameters: AppsV2025ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2025ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public listOwnedUserApps(requestParameters: AppsV2025ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2025ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public patchSourceApp(requestParameters: AppsV2025ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2025ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public patchUserApp(requestParameters: AppsV2025ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2025ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2025Api - */ - public updateSourceAppsInBulk(requestParameters: AppsV2025ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2025ApiFp(this.configuration).updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthProfileV2025Api - axios parameter creator - * @export - */ -export const AuthProfileV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getProfileConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig: async (id: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchProfileConfig', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchProfileConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthProfileV2025Api - functional programming interface - * @export - */ -export const AuthProfileV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthProfileV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2025Api.getProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfigList(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigList(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2025Api.getProfileConfigList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchProfileConfig(id: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchProfileConfig(id, jsonPatchOperationV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2025Api.patchProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthProfileV2025Api - factory interface - * @export - */ -export const AuthProfileV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthProfileV2025ApiFp(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2025ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig(requestParameters: AuthProfileV2025ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2025ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList(requestParameters: AuthProfileV2025ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2025ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig(requestParameters: AuthProfileV2025ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getProfileConfig operation in AuthProfileV2025Api. - * @export - * @interface AuthProfileV2025ApiGetProfileConfigRequest - */ -export interface AuthProfileV2025ApiGetProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2025ApiGetProfileConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2025ApiGetProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getProfileConfigList operation in AuthProfileV2025Api. - * @export - * @interface AuthProfileV2025ApiGetProfileConfigListRequest - */ -export interface AuthProfileV2025ApiGetProfileConfigListRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2025ApiGetProfileConfigList - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchProfileConfig operation in AuthProfileV2025Api. - * @export - * @interface AuthProfileV2025ApiPatchProfileConfigRequest - */ -export interface AuthProfileV2025ApiPatchProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2025ApiPatchProfileConfig - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AuthProfileV2025ApiPatchProfileConfig - */ - readonly jsonPatchOperationV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2025ApiPatchProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * AuthProfileV2025Api - object-oriented interface - * @export - * @class AuthProfileV2025Api - * @extends {BaseAPI} - */ -export class AuthProfileV2025Api extends BaseAPI { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2025ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2025Api - */ - public getProfileConfig(requestParameters: AuthProfileV2025ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2025ApiFp(this.configuration).getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2025ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2025Api - */ - public getProfileConfigList(requestParameters: AuthProfileV2025ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2025ApiFp(this.configuration).getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2025ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2025Api - */ - public patchProfileConfig(requestParameters: AuthProfileV2025ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2025ApiFp(this.configuration).patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthUsersV2025Api - axios parameter creator - * @export - */ -export const AuthUsersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAuthUser', 'id', id) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2025 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAuthUser', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAuthUser', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthUsersV2025Api - functional programming interface - * @export - */ -export const AuthUsersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthUsersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthUser(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2025Api.getAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2025 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthUser(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthUser(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2025Api.patchAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthUsersV2025Api - factory interface - * @export - */ -export const AuthUsersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthUsersV2025ApiFp(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2025ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser(requestParameters: AuthUsersV2025ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthUser(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2025ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser(requestParameters: AuthUsersV2025ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAuthUser operation in AuthUsersV2025Api. - * @export - * @interface AuthUsersV2025ApiGetAuthUserRequest - */ -export interface AuthUsersV2025ApiGetAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2025ApiGetAuthUser - */ - readonly id: string -} - -/** - * Request parameters for patchAuthUser operation in AuthUsersV2025Api. - * @export - * @interface AuthUsersV2025ApiPatchAuthUserRequest - */ -export interface AuthUsersV2025ApiPatchAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2025ApiPatchAuthUser - */ - readonly id: string - - /** - * A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AuthUsersV2025ApiPatchAuthUser - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * AuthUsersV2025Api - object-oriented interface - * @export - * @class AuthUsersV2025Api - * @extends {BaseAPI} - */ -export class AuthUsersV2025Api extends BaseAPI { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2025ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2025Api - */ - public getAuthUser(requestParameters: AuthUsersV2025ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2025ApiFp(this.configuration).getAuthUser(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2025ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2025Api - */ - public patchAuthUser(requestParameters: AuthUsersV2025ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2025ApiFp(this.configuration).patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * BrandingV2025Api - axios parameter creator - * @export - */ -export const BrandingV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('createBrandingItem', 'name', name) - // verify required parameter 'productName' is not null or undefined - assertParamExists('createBrandingItem', 'productName', productName) - const localVarPath = `/brandings`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/brandings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('setBrandingItem', 'name', name) - // verify required parameter 'name2' is not null or undefined - assertParamExists('setBrandingItem', 'name2', name2) - // verify required parameter 'productName' is not null or undefined - assertParamExists('setBrandingItem', 'productName', productName) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name2 !== undefined) { - localVarFormParams.append('name', name2 as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * BrandingV2025Api - functional programming interface - * @export - */ -export const BrandingV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = BrandingV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createBrandingItem(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItem(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2025Api.createBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2025Api.deleteBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2025Api.getBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBrandingList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2025Api.getBrandingList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setBrandingItem(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItem(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2025Api.setBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * BrandingV2025Api - factory interface - * @export - */ -export const BrandingV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = BrandingV2025ApiFp(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2025ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem(requestParameters: BrandingV2025ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2025ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding(requestParameters: BrandingV2025ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2025ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding(requestParameters: BrandingV2025ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBrandingList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2025ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem(requestParameters: BrandingV2025ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createBrandingItem operation in BrandingV2025Api. - * @export - * @interface BrandingV2025ApiCreateBrandingItemRequest - */ -export interface BrandingV2025ApiCreateBrandingItemRequest { - /** - * name of branding item - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly name: string - - /** - * product name - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2025ApiCreateBrandingItem - */ - readonly fileStandard?: File -} - -/** - * Request parameters for deleteBranding operation in BrandingV2025Api. - * @export - * @interface BrandingV2025ApiDeleteBrandingRequest - */ -export interface BrandingV2025ApiDeleteBrandingRequest { - /** - * The name of the branding item to be deleted - * @type {string} - * @memberof BrandingV2025ApiDeleteBranding - */ - readonly name: string -} - -/** - * Request parameters for getBranding operation in BrandingV2025Api. - * @export - * @interface BrandingV2025ApiGetBrandingRequest - */ -export interface BrandingV2025ApiGetBrandingRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2025ApiGetBranding - */ - readonly name: string -} - -/** - * Request parameters for setBrandingItem operation in BrandingV2025Api. - * @export - * @interface BrandingV2025ApiSetBrandingItemRequest - */ -export interface BrandingV2025ApiSetBrandingItemRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly name: string - - /** - * name of branding item - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly name2: string - - /** - * product name - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2025ApiSetBrandingItem - */ - readonly fileStandard?: File -} - -/** - * BrandingV2025Api - object-oriented interface - * @export - * @class BrandingV2025Api - * @extends {BaseAPI} - */ -export class BrandingV2025Api extends BaseAPI { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2025ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2025Api - */ - public createBrandingItem(requestParameters: BrandingV2025ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2025ApiFp(this.configuration).createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2025ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2025Api - */ - public deleteBranding(requestParameters: BrandingV2025ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2025ApiFp(this.configuration).deleteBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2025ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2025Api - */ - public getBranding(requestParameters: BrandingV2025ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2025ApiFp(this.configuration).getBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2025Api - */ - public getBrandingList(axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2025ApiFp(this.configuration).getBrandingList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2025ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2025Api - */ - public setBrandingItem(requestParameters: BrandingV2025ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2025ApiFp(this.configuration).setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignFiltersV2025Api - axios parameter creator - * @export - */ -export const CertificationCampaignFiltersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2025} campaignFilterDetailsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter: async (campaignFilterDetailsV2025: CampaignFilterDetailsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignFilterDetailsV2025' is not null or undefined - assertParamExists('createCampaignFilter', 'campaignFilterDetailsV2025', campaignFilterDetailsV2025) - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteCampaignFilters', 'requestBody', requestBody) - const localVarPath = `/campaign-filters/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignFilterById', 'id', id) - const localVarPath = `/campaign-filters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (includeSystemFilters !== undefined) { - localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2025} campaignFilterDetailsV2025 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter: async (filterId: string, campaignFilterDetailsV2025: CampaignFilterDetailsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filterId' is not null or undefined - assertParamExists('updateCampaignFilter', 'filterId', filterId) - // verify required parameter 'campaignFilterDetailsV2025' is not null or undefined - assertParamExists('updateCampaignFilter', 'campaignFilterDetailsV2025', campaignFilterDetailsV2025) - const localVarPath = `/campaign-filters/{id}` - .replace(`{${"filterId"}}`, encodeURIComponent(String(filterId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignFiltersV2025Api - functional programming interface - * @export - */ -export const CertificationCampaignFiltersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignFiltersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2025} campaignFilterDetailsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignFilter(campaignFilterDetailsV2025: CampaignFilterDetailsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilter(campaignFilterDetailsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2025Api.createCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignFilters(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFilters(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2025Api.deleteCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignFilterById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2025Api.getCampaignFilterById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCampaignFilters(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFilters(limit, start, includeSystemFilters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2025Api.listCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2025} campaignFilterDetailsV2025 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaignFilter(filterId: string, campaignFilterDetailsV2025: CampaignFilterDetailsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilter(filterId, campaignFilterDetailsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2025Api.updateCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignFiltersV2025Api - factory interface - * @export - */ -export const CertificationCampaignFiltersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignFiltersV2025ApiFp(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter(requestParameters: CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignFilter(requestParameters.campaignFilterDetailsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters(requestParameters: CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCampaignFilter operation in CertificationCampaignFiltersV2025Api. - * @export - * @interface CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest { - /** - * - * @type {CampaignFilterDetailsV2025} - * @memberof CertificationCampaignFiltersV2025ApiCreateCampaignFilter - */ - readonly campaignFilterDetailsV2025: CampaignFilterDetailsV2025 -} - -/** - * Request parameters for deleteCampaignFilters operation in CertificationCampaignFiltersV2025Api. - * @export - * @interface CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest { - /** - * A json list of IDs of campaign filters to delete. - * @type {Array} - * @memberof CertificationCampaignFiltersV2025ApiDeleteCampaignFilters - */ - readonly requestBody: Array -} - -/** - * Request parameters for getCampaignFilterById operation in CertificationCampaignFiltersV2025Api. - * @export - * @interface CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest - */ -export interface CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest { - /** - * The ID of the campaign filter to be retrieved. - * @type {string} - * @memberof CertificationCampaignFiltersV2025ApiGetCampaignFilterById - */ - readonly id: string -} - -/** - * Request parameters for listCampaignFilters operation in CertificationCampaignFiltersV2025Api. - * @export - * @interface CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest { - /** - * 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 CertificationCampaignFiltersV2025ApiListCampaignFilters - */ - readonly limit?: number - - /** - * Start/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 CertificationCampaignFiltersV2025ApiListCampaignFilters - */ - readonly start?: number - - /** - * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @type {boolean} - * @memberof CertificationCampaignFiltersV2025ApiListCampaignFilters - */ - readonly includeSystemFilters?: boolean -} - -/** - * Request parameters for updateCampaignFilter operation in CertificationCampaignFiltersV2025Api. - * @export - * @interface CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest { - /** - * The ID of the campaign filter being modified. - * @type {string} - * @memberof CertificationCampaignFiltersV2025ApiUpdateCampaignFilter - */ - readonly filterId: string - - /** - * A campaign filter details with updated field values. - * @type {CampaignFilterDetailsV2025} - * @memberof CertificationCampaignFiltersV2025ApiUpdateCampaignFilter - */ - readonly campaignFilterDetailsV2025: CampaignFilterDetailsV2025 -} - -/** - * CertificationCampaignFiltersV2025Api - object-oriented interface - * @export - * @class CertificationCampaignFiltersV2025Api - * @extends {BaseAPI} - */ -export class CertificationCampaignFiltersV2025Api extends BaseAPI { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2025Api - */ - public createCampaignFilter(requestParameters: CertificationCampaignFiltersV2025ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2025ApiFp(this.configuration).createCampaignFilter(requestParameters.campaignFilterDetailsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2025Api - */ - public deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2025ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2025ApiFp(this.configuration).deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2025Api - */ - public getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2025ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2025ApiFp(this.configuration).getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2025Api - */ - public listCampaignFilters(requestParameters: CertificationCampaignFiltersV2025ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2025ApiFp(this.configuration).listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2025Api - */ - public updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2025ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2025ApiFp(this.configuration).updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignsV2025Api - axios parameter creator - * @export - */ -export const CertificationCampaignsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2025} [campaignCompleteOptionsV2025] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign: async (id: string, campaignCompleteOptionsV2025?: CampaignCompleteOptionsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignCompleteOptionsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2025} campaignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign: async (campaignV2025: CampaignV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignV2025' is not null or undefined - assertParamExists('createCampaign', 'campaignV2025', campaignV2025) - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2025} campaignTemplateV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate: async (campaignTemplateV2025: CampaignTemplateV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignTemplateV2025' is not null or undefined - assertParamExists('createCampaignTemplate', 'campaignTemplateV2025', campaignTemplateV2025) - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignTemplateV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2025} campaignsDeleteRequestV2025 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns: async (campaignsDeleteRequestV2025: CampaignsDeleteRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignsDeleteRequestV2025' is not null or undefined - assertParamExists('deleteCampaigns', 'campaignsDeleteRequestV2025', campaignsDeleteRequestV2025) - const localVarPath = `/campaigns/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignsDeleteRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns: async (detail?: GetActiveCampaignsDetailV2025, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign: async (id: string, detail?: GetCampaignDetailV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaign', 'id', id) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignReports', 'id', id) - const localVarPath = `/campaigns/{id}/reports` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns/reports-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2025} adminReviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move: async (id: string, adminReviewReassignV2025: AdminReviewReassignV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('move', 'id', id) - // verify required parameter 'adminReviewReassignV2025' is not null or undefined - assertParamExists('move', 'adminReviewReassignV2025', adminReviewReassignV2025) - const localVarPath = `/campaigns/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(adminReviewReassignV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2025 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchCampaignTemplate', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchCampaignTemplate', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2025} campaignReportsConfigV2025 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig: async (campaignReportsConfigV2025: CampaignReportsConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignReportsConfigV2025' is not null or undefined - assertParamExists('setCampaignReportsConfig', 'campaignReportsConfigV2025', campaignReportsConfigV2025) - const localVarPath = `/campaigns/reports-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignReportsConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2025} [scheduleV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule: async (id: string, scheduleV2025?: ScheduleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduleV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2025} [activateCampaignOptionsV2025] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign: async (id: string, activateCampaignOptionsV2025?: ActivateCampaignOptionsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/activate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(activateCampaignOptionsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignRemediationScan', 'id', id) - const localVarPath = `/campaigns/{id}/run-remediation-scan` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2025} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport: async (id: string, type: ReportTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignReport', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('startCampaignReport', 'type', type) - const localVarPath = `/campaigns/{id}/run-report/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startGenerateCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{id}/generate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2025 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateCampaign', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateCampaign', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignsV2025Api - functional programming interface - * @export - */ -export const CertificationCampaignsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignsV2025ApiAxiosParamCreator(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2025} [campaignCompleteOptionsV2025] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeCampaign(id: string, campaignCompleteOptionsV2025?: CampaignCompleteOptionsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaign(id, campaignCompleteOptionsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.completeCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2025} campaignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaign(campaignV2025: CampaignV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaign(campaignV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.createCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2025} campaignTemplateV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignTemplate(campaignTemplateV2025: CampaignTemplateV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplate(campaignTemplateV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.createCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.deleteCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.deleteCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2025} campaignsDeleteRequestV2025 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaigns(campaignsDeleteRequestV2025: CampaignsDeleteRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaigns(campaignsDeleteRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.deleteCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getActiveCampaigns(detail?: GetActiveCampaignsDetailV2025, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getActiveCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2025} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaign(id: string, detail?: GetCampaignDetailV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaign(id, detail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReports(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReports(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaignReports']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.getCampaignTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2025} adminReviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async move(id: string, adminReviewReassignV2025: AdminReviewReassignV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.move(id, adminReviewReassignV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.move']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2025 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchCampaignTemplate(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplate(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.patchCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2025} campaignReportsConfigV2025 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignReportsConfig(campaignReportsConfigV2025: CampaignReportsConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfig(campaignReportsConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.setCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2025} [scheduleV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignTemplateSchedule(id: string, scheduleV2025?: ScheduleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateSchedule(id, scheduleV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.setCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2025} [activateCampaignOptionsV2025] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaign(id: string, activateCampaignOptionsV2025?: ActivateCampaignOptionsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaign(id, activateCampaignOptionsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.startCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignRemediationScan(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScan(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.startCampaignRemediationScan']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2025} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignReport(id: string, type: ReportTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReport(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.startCampaignReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startGenerateCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.startGenerateCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2025 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaign(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaign(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2025Api.updateCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignsV2025Api - factory interface - * @export - */ -export const CertificationCampaignsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignsV2025ApiFp(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2025ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign(requestParameters: CertificationCampaignsV2025ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2025ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign(requestParameters: CertificationCampaignsV2025ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaign(requestParameters.campaignV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2025ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignTemplate(requestParameters.campaignTemplateV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2025ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaigns(requestParameters.campaignsDeleteRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2025ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns(requestParameters: CertificationCampaignsV2025ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2025ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign(requestParameters: CertificationCampaignsV2025ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2025ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports(requestParameters: CertificationCampaignsV2025ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2025ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2025ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2025ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move(requestParameters: CertificationCampaignsV2025ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.move(requestParameters.id, requestParameters.adminReviewReassignV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2025ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig(requestParameters: CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignReportsConfig(requestParameters.campaignReportsConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2025ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign(requestParameters: CertificationCampaignsV2025ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan(requestParameters: CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2025ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport(requestParameters: CertificationCampaignsV2025ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2025ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign(requestParameters: CertificationCampaignsV2025ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeCampaign operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiCompleteCampaignRequest - */ -export interface CertificationCampaignsV2025ApiCompleteCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2025ApiCompleteCampaign - */ - readonly id: string - - /** - * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @type {CampaignCompleteOptionsV2025} - * @memberof CertificationCampaignsV2025ApiCompleteCampaign - */ - readonly campaignCompleteOptionsV2025?: CampaignCompleteOptionsV2025 -} - -/** - * Request parameters for createCampaign operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiCreateCampaignRequest - */ -export interface CertificationCampaignsV2025ApiCreateCampaignRequest { - /** - * - * @type {CampaignV2025} - * @memberof CertificationCampaignsV2025ApiCreateCampaign - */ - readonly campaignV2025: CampaignV2025 -} - -/** - * Request parameters for createCampaignTemplate operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiCreateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2025ApiCreateCampaignTemplateRequest { - /** - * - * @type {CampaignTemplateV2025} - * @memberof CertificationCampaignsV2025ApiCreateCampaignTemplate - */ - readonly campaignTemplateV2025: CampaignTemplateV2025 -} - -/** - * Request parameters for deleteCampaignTemplate operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest - */ -export interface CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest { - /** - * ID of the campaign template being deleted. - * @type {string} - * @memberof CertificationCampaignsV2025ApiDeleteCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaignTemplateSchedule operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being deleted. - * @type {string} - * @memberof CertificationCampaignsV2025ApiDeleteCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaigns operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiDeleteCampaignsRequest - */ -export interface CertificationCampaignsV2025ApiDeleteCampaignsRequest { - /** - * IDs of the campaigns to delete. - * @type {CampaignsDeleteRequestV2025} - * @memberof CertificationCampaignsV2025ApiDeleteCampaigns - */ - readonly campaignsDeleteRequestV2025: CampaignsDeleteRequestV2025 -} - -/** - * Request parameters for getActiveCampaigns operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetActiveCampaignsRequest - */ -export interface CertificationCampaignsV2025ApiGetActiveCampaignsRequest { - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2025ApiGetActiveCampaigns - */ - readonly detail?: GetActiveCampaignsDetailV2025 - - /** - * 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 CertificationCampaignsV2025ApiGetActiveCampaigns - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2025ApiGetActiveCampaigns - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2025ApiGetActiveCampaigns - */ - 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, in* **name**: *eq, sw* **status**: *eq, in* - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetActiveCampaigns - */ - 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: **name, created** - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetActiveCampaigns - */ - readonly sorters?: string -} - -/** - * Request parameters for getCampaign operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetCampaignRequest - */ -export interface CertificationCampaignsV2025ApiGetCampaignRequest { - /** - * ID of the campaign to be retrieved. - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaign - */ - readonly id: string - - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2025ApiGetCampaign - */ - readonly detail?: GetCampaignDetailV2025 -} - -/** - * Request parameters for getCampaignReports operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetCampaignReportsRequest - */ -export interface CertificationCampaignsV2025ApiGetCampaignReportsRequest { - /** - * ID of the campaign whose reports are being fetched. - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaignReports - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplate operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetCampaignTemplateRequest - */ -export interface CertificationCampaignsV2025ApiGetCampaignTemplateRequest { - /** - * Requested campaign template\'s ID. - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplateSchedule operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being fetched. - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplates operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiGetCampaignTemplatesRequest - */ -export interface CertificationCampaignsV2025ApiGetCampaignTemplatesRequest { - /** - * 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 CertificationCampaignsV2025ApiGetCampaignTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplates - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplates - */ - readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof CertificationCampaignsV2025ApiGetCampaignTemplates - */ - readonly filters?: string -} - -/** - * Request parameters for move operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiMoveRequest - */ -export interface CertificationCampaignsV2025ApiMoveRequest { - /** - * The certification campaign ID - * @type {string} - * @memberof CertificationCampaignsV2025ApiMove - */ - readonly id: string - - /** - * - * @type {AdminReviewReassignV2025} - * @memberof CertificationCampaignsV2025ApiMove - */ - readonly adminReviewReassignV2025: AdminReviewReassignV2025 -} - -/** - * Request parameters for patchCampaignTemplate operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiPatchCampaignTemplateRequest - */ -export interface CertificationCampaignsV2025ApiPatchCampaignTemplateRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2025ApiPatchCampaignTemplate - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @type {Array} - * @memberof CertificationCampaignsV2025ApiPatchCampaignTemplate - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for setCampaignReportsConfig operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest - */ -export interface CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest { - /** - * Campaign report configuration. - * @type {CampaignReportsConfigV2025} - * @memberof CertificationCampaignsV2025ApiSetCampaignReportsConfig - */ - readonly campaignReportsConfigV2025: CampaignReportsConfigV2025 -} - -/** - * Request parameters for setCampaignTemplateSchedule operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template being scheduled. - * @type {string} - * @memberof CertificationCampaignsV2025ApiSetCampaignTemplateSchedule - */ - readonly id: string - - /** - * - * @type {ScheduleV2025} - * @memberof CertificationCampaignsV2025ApiSetCampaignTemplateSchedule - */ - readonly scheduleV2025?: ScheduleV2025 -} - -/** - * Request parameters for startCampaign operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiStartCampaignRequest - */ -export interface CertificationCampaignsV2025ApiStartCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2025ApiStartCampaign - */ - readonly id: string - - /** - * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @type {ActivateCampaignOptionsV2025} - * @memberof CertificationCampaignsV2025ApiStartCampaign - */ - readonly activateCampaignOptionsV2025?: ActivateCampaignOptionsV2025 -} - -/** - * Request parameters for startCampaignRemediationScan operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest - */ -export interface CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest { - /** - * ID of the campaign the remediation scan is being run for. - * @type {string} - * @memberof CertificationCampaignsV2025ApiStartCampaignRemediationScan - */ - readonly id: string -} - -/** - * Request parameters for startCampaignReport operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiStartCampaignReportRequest - */ -export interface CertificationCampaignsV2025ApiStartCampaignReportRequest { - /** - * ID of the campaign the report is being run for. - * @type {string} - * @memberof CertificationCampaignsV2025ApiStartCampaignReport - */ - readonly id: string - - /** - * Type of the report to run. - * @type {ReportTypeV2025} - * @memberof CertificationCampaignsV2025ApiStartCampaignReport - */ - readonly type: ReportTypeV2025 -} - -/** - * Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest { - /** - * ID of the campaign template to use for generation. - * @type {string} - * @memberof CertificationCampaignsV2025ApiStartGenerateCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for updateCampaign operation in CertificationCampaignsV2025Api. - * @export - * @interface CertificationCampaignsV2025ApiUpdateCampaignRequest - */ -export interface CertificationCampaignsV2025ApiUpdateCampaignRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2025ApiUpdateCampaign - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @type {Array} - * @memberof CertificationCampaignsV2025ApiUpdateCampaign - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * CertificationCampaignsV2025Api - object-oriented interface - * @export - * @class CertificationCampaignsV2025Api - * @extends {BaseAPI} - */ -export class CertificationCampaignsV2025Api extends BaseAPI { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2025ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public completeCampaign(requestParameters: CertificationCampaignsV2025ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2025ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public createCampaign(requestParameters: CertificationCampaignsV2025ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).createCampaign(requestParameters.campaignV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2025ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public createCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).createCampaignTemplate(requestParameters.campaignTemplateV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public deleteCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2025ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public deleteCampaigns(requestParameters: CertificationCampaignsV2025ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).deleteCampaigns(requestParameters.campaignsDeleteRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2025ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getActiveCampaigns(requestParameters: CertificationCampaignsV2025ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2025ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaign(requestParameters: CertificationCampaignsV2025ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2025ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaignReports(requestParameters: CertificationCampaignsV2025ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaignReportsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2025ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2025ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public getCampaignTemplates(requestParameters: CertificationCampaignsV2025ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2025ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public move(requestParameters: CertificationCampaignsV2025ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).move(requestParameters.id, requestParameters.adminReviewReassignV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2025ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public patchCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public setCampaignReportsConfig(requestParameters: CertificationCampaignsV2025ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).setCampaignReportsConfig(requestParameters.campaignReportsConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2025ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2025ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public startCampaign(requestParameters: CertificationCampaignsV2025ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public startCampaignRemediationScan(requestParameters: CertificationCampaignsV2025ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2025ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public startCampaignReport(requestParameters: CertificationCampaignsV2025ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2025ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2025ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2025Api - */ - public updateCampaign(requestParameters: CertificationCampaignsV2025ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2025ApiFp(this.configuration).updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetActiveCampaignsDetailV2025 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetActiveCampaignsDetailV2025 = typeof GetActiveCampaignsDetailV2025[keyof typeof GetActiveCampaignsDetailV2025]; -/** - * @export - */ -export const GetCampaignDetailV2025 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetCampaignDetailV2025 = typeof GetCampaignDetailV2025[keyof typeof GetCampaignDetailV2025]; - - -/** - * CertificationSummariesV2025Api - axios parameter creator - * @export - */ -export const CertificationSummariesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2025} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries: async (id: string, type: GetIdentityAccessSummariesTypeV2025, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'type', type) - const localVarPath = `/certifications/{id}/access-summaries/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityDecisionSummary', 'id', id) - const localVarPath = `/certifications/{id}/decision-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummaries', 'id', id) - const localVarPath = `/certifications/{id}/identity-summaries` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummary', 'id', id) - // verify required parameter 'identitySummaryId' is not null or undefined - assertParamExists('getIdentitySummary', 'identitySummaryId', identitySummaryId) - const localVarPath = `/certifications/{id}/identity-summaries/{identitySummaryId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationSummariesV2025Api - functional programming interface - * @export - */ -export const CertificationSummariesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationSummariesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2025} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAccessSummaries(id: string, type: GetIdentityAccessSummariesTypeV2025, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummaries(id, type, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2025Api.getIdentityAccessSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityDecisionSummary(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummary(id, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2025Api.getIdentityDecisionSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummaries(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaries(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2025Api.getIdentitySummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummary(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummary(id, identitySummaryId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2025Api.getIdentitySummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationSummariesV2025Api - factory interface - * @export - */ -export const CertificationSummariesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationSummariesV2025ApiFp(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries(requestParameters: CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary(requestParameters: CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2025ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries(requestParameters: CertificationSummariesV2025ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2025ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary(requestParameters: CertificationSummariesV2025ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getIdentityAccessSummaries operation in CertificationSummariesV2025Api. - * @export - * @interface CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest - */ -export interface CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - readonly id: string - - /** - * The type of access review item to retrieve summaries for - * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - readonly type: GetIdentityAccessSummariesTypeV2025 - - /** - * 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 CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - 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: **access.name** - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentityAccessSummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentityDecisionSummary operation in CertificationSummariesV2025Api. - * @export - * @interface CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest - */ -export interface CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentityDecisionSummary - */ - readonly id: 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: **identitySummary.id**: *eq, in* - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentityDecisionSummary - */ - readonly filters?: string -} - -/** - * Request parameters for getIdentitySummaries operation in CertificationSummariesV2025Api. - * @export - * @interface CertificationSummariesV2025ApiGetIdentitySummariesRequest - */ -export interface CertificationSummariesV2025ApiGetIdentitySummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - 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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - 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: **name** - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentitySummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentitySummary operation in CertificationSummariesV2025Api. - * @export - * @interface CertificationSummariesV2025ApiGetIdentitySummaryRequest - */ -export interface CertificationSummariesV2025ApiGetIdentitySummaryRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentitySummary - */ - readonly id: string - - /** - * The identity summary ID - * @type {string} - * @memberof CertificationSummariesV2025ApiGetIdentitySummary - */ - readonly identitySummaryId: string -} - -/** - * CertificationSummariesV2025Api - object-oriented interface - * @export - * @class CertificationSummariesV2025Api - * @extends {BaseAPI} - */ -export class CertificationSummariesV2025Api extends BaseAPI { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2025Api - */ - public getIdentityAccessSummaries(requestParameters: CertificationSummariesV2025ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2025ApiFp(this.configuration).getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2025Api - */ - public getIdentityDecisionSummary(requestParameters: CertificationSummariesV2025ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2025ApiFp(this.configuration).getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2025ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2025Api - */ - public getIdentitySummaries(requestParameters: CertificationSummariesV2025ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2025ApiFp(this.configuration).getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2025ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2025Api - */ - public getIdentitySummary(requestParameters: CertificationSummariesV2025ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2025ApiFp(this.configuration).getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetIdentityAccessSummariesTypeV2025 = { - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT' -} as const; -export type GetIdentityAccessSummariesTypeV2025 = typeof GetIdentityAccessSummariesTypeV2025[keyof typeof GetIdentityAccessSummariesTypeV2025]; - - -/** - * CertificationsV2025Api - axios parameter creator - * @export - */ -export const CertificationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCertificationTask', 'id', id) - const localVarPath = `/certification-tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertification', 'id', id) - const localVarPath = `/certifications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'certificationId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'certificationId', certificationId) - // verify required parameter 'itemId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'itemId', itemId) - const localVarPath = `/certifications/{certificationId}/access-review-items/{itemId}/permissions` - .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) - .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certification-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listCertificationReviewers', 'id', id) - const localVarPath = `/certifications/{id}/reviewers` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessReviewItems', 'id', id) - const localVarPath = `/certifications/{id}/access-review-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (entitlements !== undefined) { - localVarQueryParameter['entitlements'] = entitlements; - } - - if (accessProfiles !== undefined) { - localVarQueryParameter['access-profiles'] = accessProfiles; - } - - if (roles !== undefined) { - localVarQueryParameter['roles'] = roles; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certifications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2025 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision: async (id: string, reviewDecisionV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('makeIdentityDecision', 'id', id) - // verify required parameter 'reviewDecisionV2025' is not null or undefined - assertParamExists('makeIdentityDecision', 'reviewDecisionV2025', reviewDecisionV2025) - const localVarPath = `/certifications/{id}/decide` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewDecisionV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2025} reviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications: async (id: string, reviewReassignV2025: ReviewReassignV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'id', id) - // verify required parameter 'reviewReassignV2025' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'reviewReassignV2025', reviewReassignV2025) - const localVarPath = `/certifications/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('signOffIdentityCertification', 'id', id) - const localVarPath = `/certifications/{id}/sign-off` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2025} reviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync: async (id: string, reviewReassignV2025: ReviewReassignV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'id', id) - // verify required parameter 'reviewReassignV2025' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'reviewReassignV2025', reviewReassignV2025) - const localVarPath = `/certifications/{id}/reassign-async` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationsV2025Api - functional programming interface - * @export - */ -export const CertificationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCertificationTask(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.getCertificationTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.getIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissions(certificationId, itemId, filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.getIdentityCertificationItemPermissions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasks(reviewerIdentity, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.getPendingCertificationTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewers(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.listCertificationReviewers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessReviewItems(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItems(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.listIdentityAccessReviewItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityCertifications(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertifications(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.listIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2025 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async makeIdentityDecision(id: string, reviewDecisionV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecision(id, reviewDecisionV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.makeIdentityDecision']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2025} reviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async reassignIdentityCertifications(id: string, reviewReassignV2025: ReviewReassignV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertifications(id, reviewReassignV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.reassignIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async signOffIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.signOffIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2025} reviewReassignV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReassignCertsAsync(id: string, reviewReassignV2025: ReviewReassignV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsync(id, reviewReassignV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2025Api.submitReassignCertsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationsV2025Api - factory interface - * @export - */ -export const CertificationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationsV2025ApiFp(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2025ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask(requestParameters: CertificationsV2025ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2025ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification(requestParameters: CertificationsV2025ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions(requestParameters: CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2025ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks(requestParameters: CertificationsV2025ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2025ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers(requestParameters: CertificationsV2025ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2025ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems(requestParameters: CertificationsV2025ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2025ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications(requestParameters: CertificationsV2025ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2025ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision(requestParameters: CertificationsV2025ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2025ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications(requestParameters: CertificationsV2025ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2025ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification(requestParameters: CertificationsV2025ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2025ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync(requestParameters: CertificationsV2025ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getCertificationTask operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiGetCertificationTaskRequest - */ -export interface CertificationsV2025ApiGetCertificationTaskRequest { - /** - * The task ID - * @type {string} - * @memberof CertificationsV2025ApiGetCertificationTask - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertification operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiGetIdentityCertificationRequest - */ -export interface CertificationsV2025ApiGetIdentityCertificationRequest { - /** - * The certification id - * @type {string} - * @memberof CertificationsV2025ApiGetIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertificationItemPermissions operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest - */ -export interface CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly certificationId: string - - /** - * The certification item ID - * @type {string} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @type {string} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2025ApiGetIdentityCertificationItemPermissions - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingCertificationTasks operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiGetPendingCertificationTasksRequest - */ -export interface CertificationsV2025ApiGetPendingCertificationTasksRequest { - /** - * The ID of reviewer identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2025ApiGetPendingCertificationTasks - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiGetPendingCertificationTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiGetPendingCertificationTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2025ApiGetPendingCertificationTasks - */ - 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, in* **targetId**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof CertificationsV2025ApiGetPendingCertificationTasks - */ - readonly filters?: string -} - -/** - * Request parameters for listCertificationReviewers operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiListCertificationReviewersRequest - */ -export interface CertificationsV2025ApiListCertificationReviewersRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - 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, in* **name**: *eq, sw* **email**: *eq, sw* - * @type {string} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - 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: **name, email** - * @type {string} - * @memberof CertificationsV2025ApiListCertificationReviewers - */ - readonly sorters?: string -} - -/** - * Request parameters for listIdentityAccessReviewItems operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiListIdentityAccessReviewItemsRequest - */ -export interface CertificationsV2025ApiListIdentityAccessReviewItemsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - 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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly sorters?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly entitlements?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly accessProfiles?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2025ApiListIdentityAccessReviewItems - */ - readonly roles?: string -} - -/** - * Request parameters for listIdentityCertifications operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiListIdentityCertificationsRequest - */ -export interface CertificationsV2025ApiListIdentityCertificationsRequest { - /** - * Reviewer\'s identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - 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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @type {string} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - 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: **name, due, signed** - * @type {string} - * @memberof CertificationsV2025ApiListIdentityCertifications - */ - readonly sorters?: string -} - -/** - * Request parameters for makeIdentityDecision operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiMakeIdentityDecisionRequest - */ -export interface CertificationsV2025ApiMakeIdentityDecisionRequest { - /** - * The ID of the identity campaign certification on which to make decisions - * @type {string} - * @memberof CertificationsV2025ApiMakeIdentityDecision - */ - readonly id: string - - /** - * A non-empty array of decisions to be made. - * @type {Array} - * @memberof CertificationsV2025ApiMakeIdentityDecision - */ - readonly reviewDecisionV2025: Array -} - -/** - * Request parameters for reassignIdentityCertifications operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiReassignIdentityCertificationsRequest - */ -export interface CertificationsV2025ApiReassignIdentityCertificationsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2025ApiReassignIdentityCertifications - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2025} - * @memberof CertificationsV2025ApiReassignIdentityCertifications - */ - readonly reviewReassignV2025: ReviewReassignV2025 -} - -/** - * Request parameters for signOffIdentityCertification operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiSignOffIdentityCertificationRequest - */ -export interface CertificationsV2025ApiSignOffIdentityCertificationRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2025ApiSignOffIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for submitReassignCertsAsync operation in CertificationsV2025Api. - * @export - * @interface CertificationsV2025ApiSubmitReassignCertsAsyncRequest - */ -export interface CertificationsV2025ApiSubmitReassignCertsAsyncRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2025ApiSubmitReassignCertsAsync - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2025} - * @memberof CertificationsV2025ApiSubmitReassignCertsAsync - */ - readonly reviewReassignV2025: ReviewReassignV2025 -} - -/** - * CertificationsV2025Api - object-oriented interface - * @export - * @class CertificationsV2025Api - * @extends {BaseAPI} - */ -export class CertificationsV2025Api extends BaseAPI { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2025ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public getCertificationTask(requestParameters: CertificationsV2025ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2025ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public getIdentityCertification(requestParameters: CertificationsV2025ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public getIdentityCertificationItemPermissions(requestParameters: CertificationsV2025ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2025ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public getPendingCertificationTasks(requestParameters: CertificationsV2025ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2025ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public listCertificationReviewers(requestParameters: CertificationsV2025ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2025ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public listIdentityAccessReviewItems(requestParameters: CertificationsV2025ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2025ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public listIdentityCertifications(requestParameters: CertificationsV2025ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2025ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public makeIdentityDecision(requestParameters: CertificationsV2025ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2025ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public reassignIdentityCertifications(requestParameters: CertificationsV2025ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2025ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public signOffIdentityCertification(requestParameters: CertificationsV2025ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2025ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2025Api - */ - public submitReassignCertsAsync(requestParameters: CertificationsV2025ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2025ApiFp(this.configuration).submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ClassifySourceV2025Api - axios parameter creator - * @export - */ -export const ClassifySourceV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteClassifyMachineAccountFromSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteClassifyMachineAccountFromSource', 'id', id) - const localVarPath = `/sources/{sourceId}/classify` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClassifyMachineAccountFromSourceStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClassifyMachineAccountFromSourceStatus', 'id', id) - const localVarPath = `/sources/{sourceId}/classify` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccountFromSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('sendClassifyMachineAccountFromSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/classify` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ClassifySourceV2025Api - functional programming interface - * @export - */ -export const ClassifySourceV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ClassifySourceV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteClassifyMachineAccountFromSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteClassifyMachineAccountFromSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2025Api.deleteClassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClassifyMachineAccountFromSourceStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClassifyMachineAccountFromSourceStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2025Api.getClassifyMachineAccountFromSourceStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendClassifyMachineAccountFromSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccountFromSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2025Api.sendClassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ClassifySourceV2025Api - factory interface - * @export - */ -export const ClassifySourceV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ClassifySourceV2025ApiFp(configuration) - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteClassifyMachineAccountFromSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClassifyMachineAccountFromSourceStatus(requestParameters: ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClassifyMachineAccountFromSourceStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendClassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteClassifyMachineAccountFromSource operation in ClassifySourceV2025Api. - * @export - * @interface ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest - */ -export interface ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSource - */ - readonly id: string -} - -/** - * Request parameters for getClassifyMachineAccountFromSourceStatus operation in ClassifySourceV2025Api. - * @export - * @interface ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest - */ -export interface ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatus - */ - readonly id: string -} - -/** - * Request parameters for sendClassifyMachineAccountFromSource operation in ClassifySourceV2025Api. - * @export - * @interface ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest - */ -export interface ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2025ApiSendClassifyMachineAccountFromSource - */ - readonly sourceId: string -} - -/** - * ClassifySourceV2025Api - object-oriented interface - * @export - * @class ClassifySourceV2025Api - * @extends {BaseAPI} - */ -export class ClassifySourceV2025Api extends BaseAPI { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2025Api - */ - public deleteClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2025ApiDeleteClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2025ApiFp(this.configuration).deleteClassifyMachineAccountFromSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2025Api - */ - public getClassifyMachineAccountFromSourceStatus(requestParameters: ClassifySourceV2025ApiGetClassifyMachineAccountFromSourceStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2025ApiFp(this.configuration).getClassifyMachineAccountFromSourceStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2025Api - */ - public sendClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2025ApiSendClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2025ApiFp(this.configuration).sendClassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConfigurationHubV2025Api - axios parameter creator - * @export - */ -export const ConfigurationHubV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2025} deployRequestV2025 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy: async (deployRequestV2025: DeployRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deployRequestV2025' is not null or undefined - assertParamExists('createDeploy', 'deployRequestV2025', deployRequestV2025) - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deployRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2025} objectMappingRequestV2025 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping: async (sourceOrg: string, objectMappingRequestV2025: ObjectMappingRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingRequestV2025' is not null or undefined - assertParamExists('createObjectMapping', 'objectMappingRequestV2025', objectMappingRequestV2025) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2025} objectMappingBulkCreateRequestV2025 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings: async (sourceOrg: string, objectMappingBulkCreateRequestV2025: ObjectMappingBulkCreateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkCreateRequestV2025' is not null or undefined - assertParamExists('createObjectMappings', 'objectMappingBulkCreateRequestV2025', objectMappingBulkCreateRequestV2025) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkCreateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2025} scheduledActionPayloadV2025 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction: async (scheduledActionPayloadV2025: ScheduledActionPayloadV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionPayloadV2025' is not null or undefined - assertParamExists('createScheduledAction', 'scheduledActionPayloadV2025', scheduledActionPayloadV2025) - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledActionPayloadV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('createUploadedConfiguration', 'data', data) - // verify required parameter 'name' is not null or undefined - assertParamExists('createUploadedConfiguration', 'name', name) - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteBackup', 'id', id) - const localVarPath = `/configuration-hub/backups/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDraft', 'id', id) - const localVarPath = `/configuration-hub/drafts/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('deleteObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingId' is not null or undefined - assertParamExists('deleteObjectMapping', 'objectMappingId', objectMappingId) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) - .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction: async (scheduledActionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('deleteScheduledAction', 'scheduledActionId', scheduledActionId) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDeploy', 'id', id) - const localVarPath = `/configuration-hub/deploys/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('getObjectMappings', 'sourceOrg', sourceOrg) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/drafts`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2025} objectMappingBulkPatchRequestV2025 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings: async (sourceOrg: string, objectMappingBulkPatchRequestV2025: ObjectMappingBulkPatchRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('updateObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkPatchRequestV2025' is not null or undefined - assertParamExists('updateObjectMappings', 'objectMappingBulkPatchRequestV2025', objectMappingBulkPatchRequestV2025) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkPatchRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2025} jsonPatchV2025 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction: async (scheduledActionId: string, jsonPatchV2025: JsonPatchV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('updateScheduledAction', 'scheduledActionId', scheduledActionId) - // verify required parameter 'jsonPatchV2025' is not null or undefined - assertParamExists('updateScheduledAction', 'jsonPatchV2025', jsonPatchV2025) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConfigurationHubV2025Api - functional programming interface - * @export - */ -export const ConfigurationHubV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConfigurationHubV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2025} deployRequestV2025 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDeploy(deployRequestV2025: DeployRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDeploy(deployRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.createDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2025} objectMappingRequestV2025 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMapping(sourceOrg: string, objectMappingRequestV2025: ObjectMappingRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMapping(sourceOrg, objectMappingRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.createObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2025} objectMappingBulkCreateRequestV2025 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMappings(sourceOrg: string, objectMappingBulkCreateRequestV2025: ObjectMappingBulkCreateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappings(sourceOrg, objectMappingBulkCreateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.createObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2025} scheduledActionPayloadV2025 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledAction(scheduledActionPayloadV2025: ScheduledActionPayloadV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledAction(scheduledActionPayloadV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.createScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createUploadedConfiguration(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfiguration(data, name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.createUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBackup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBackup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.deleteBackup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDraft(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDraft(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.deleteDraft']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteObjectMapping(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMapping(sourceOrg, objectMappingId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.deleteObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledAction(scheduledActionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledAction(scheduledActionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.deleteScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.deleteUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDeploy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDeploy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.getDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getObjectMappings(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappings(sourceOrg, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.getObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.getUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listBackups(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listBackups(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.listBackups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDeploys(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDeploys(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.listDeploys']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDrafts(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDrafts(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.listDrafts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledActions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledActions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.listScheduledActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUploadedConfigurations(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurations(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.listUploadedConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2025} objectMappingBulkPatchRequestV2025 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateObjectMappings(sourceOrg: string, objectMappingBulkPatchRequestV2025: ObjectMappingBulkPatchRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappings(sourceOrg, objectMappingBulkPatchRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.updateObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2025} jsonPatchV2025 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledAction(scheduledActionId: string, jsonPatchV2025: JsonPatchV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledAction(scheduledActionId, jsonPatchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2025Api.updateScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConfigurationHubV2025Api - factory interface - * @export - */ -export const ConfigurationHubV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConfigurationHubV2025ApiFp(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2025ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy(requestParameters: ConfigurationHubV2025ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDeploy(requestParameters.deployRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2025ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping(requestParameters: ConfigurationHubV2025ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2025ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings(requestParameters: ConfigurationHubV2025ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2025ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction(requestParameters: ConfigurationHubV2025ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledAction(requestParameters.scheduledActionPayloadV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2025ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2025ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup(requestParameters: ConfigurationHubV2025ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBackup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2025ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft(requestParameters: ConfigurationHubV2025ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDraft(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2025ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping(requestParameters: ConfigurationHubV2025ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2025ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction(requestParameters: ConfigurationHubV2025ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2025ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy(requestParameters: ConfigurationHubV2025ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDeploy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2025ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings(requestParameters: ConfigurationHubV2025ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2025ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2025ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups(requestParameters: ConfigurationHubV2025ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listBackups(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listDeploys(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2025ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts(requestParameters: ConfigurationHubV2025ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDrafts(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledActions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2025ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations(requestParameters: ConfigurationHubV2025ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2025ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings(requestParameters: ConfigurationHubV2025ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2025ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction(requestParameters: ConfigurationHubV2025ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDeploy operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiCreateDeployRequest - */ -export interface ConfigurationHubV2025ApiCreateDeployRequest { - /** - * The deploy request body. - * @type {DeployRequestV2025} - * @memberof ConfigurationHubV2025ApiCreateDeploy - */ - readonly deployRequestV2025: DeployRequestV2025 -} - -/** - * Request parameters for createObjectMapping operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiCreateObjectMappingRequest - */ -export interface ConfigurationHubV2025ApiCreateObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2025ApiCreateObjectMapping - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingRequestV2025} - * @memberof ConfigurationHubV2025ApiCreateObjectMapping - */ - readonly objectMappingRequestV2025: ObjectMappingRequestV2025 -} - -/** - * Request parameters for createObjectMappings operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiCreateObjectMappingsRequest - */ -export interface ConfigurationHubV2025ApiCreateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2025ApiCreateObjectMappings - */ - readonly sourceOrg: string - - /** - * The bulk create object mapping request body. - * @type {ObjectMappingBulkCreateRequestV2025} - * @memberof ConfigurationHubV2025ApiCreateObjectMappings - */ - readonly objectMappingBulkCreateRequestV2025: ObjectMappingBulkCreateRequestV2025 -} - -/** - * Request parameters for createScheduledAction operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiCreateScheduledActionRequest - */ -export interface ConfigurationHubV2025ApiCreateScheduledActionRequest { - /** - * The scheduled action creation request body. - * @type {ScheduledActionPayloadV2025} - * @memberof ConfigurationHubV2025ApiCreateScheduledAction - */ - readonly scheduledActionPayloadV2025: ScheduledActionPayloadV2025 -} - -/** - * Request parameters for createUploadedConfiguration operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiCreateUploadedConfigurationRequest - */ -export interface ConfigurationHubV2025ApiCreateUploadedConfigurationRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ConfigurationHubV2025ApiCreateUploadedConfiguration - */ - readonly data: File - - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof ConfigurationHubV2025ApiCreateUploadedConfiguration - */ - readonly name: string -} - -/** - * Request parameters for deleteBackup operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiDeleteBackupRequest - */ -export interface ConfigurationHubV2025ApiDeleteBackupRequest { - /** - * The id of the backup to delete. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteBackup - */ - readonly id: string -} - -/** - * Request parameters for deleteDraft operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiDeleteDraftRequest - */ -export interface ConfigurationHubV2025ApiDeleteDraftRequest { - /** - * The id of the draft to delete. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteDraft - */ - readonly id: string -} - -/** - * Request parameters for deleteObjectMapping operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiDeleteObjectMappingRequest - */ -export interface ConfigurationHubV2025ApiDeleteObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteObjectMapping - */ - readonly sourceOrg: string - - /** - * The id of the object mapping to be deleted. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteObjectMapping - */ - readonly objectMappingId: string -} - -/** - * Request parameters for deleteScheduledAction operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiDeleteScheduledActionRequest - */ -export interface ConfigurationHubV2025ApiDeleteScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteScheduledAction - */ - readonly scheduledActionId: string -} - -/** - * Request parameters for deleteUploadedConfiguration operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest - */ -export interface ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2025ApiDeleteUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getDeploy operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiGetDeployRequest - */ -export interface ConfigurationHubV2025ApiGetDeployRequest { - /** - * The id of the deploy. - * @type {string} - * @memberof ConfigurationHubV2025ApiGetDeploy - */ - readonly id: string -} - -/** - * Request parameters for getObjectMappings operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiGetObjectMappingsRequest - */ -export interface ConfigurationHubV2025ApiGetObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2025ApiGetObjectMappings - */ - readonly sourceOrg: string -} - -/** - * Request parameters for getUploadedConfiguration operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiGetUploadedConfigurationRequest - */ -export interface ConfigurationHubV2025ApiGetUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2025ApiGetUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for listBackups operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiListBackupsRequest - */ -export interface ConfigurationHubV2025ApiListBackupsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2025ApiListBackups - */ - readonly filters?: string -} - -/** - * Request parameters for listDrafts operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiListDraftsRequest - */ -export interface ConfigurationHubV2025ApiListDraftsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @type {string} - * @memberof ConfigurationHubV2025ApiListDrafts - */ - readonly filters?: string -} - -/** - * Request parameters for listUploadedConfigurations operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiListUploadedConfigurationsRequest - */ -export interface ConfigurationHubV2025ApiListUploadedConfigurationsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2025ApiListUploadedConfigurations - */ - readonly filters?: string -} - -/** - * Request parameters for updateObjectMappings operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiUpdateObjectMappingsRequest - */ -export interface ConfigurationHubV2025ApiUpdateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2025ApiUpdateObjectMappings - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingBulkPatchRequestV2025} - * @memberof ConfigurationHubV2025ApiUpdateObjectMappings - */ - readonly objectMappingBulkPatchRequestV2025: ObjectMappingBulkPatchRequestV2025 -} - -/** - * Request parameters for updateScheduledAction operation in ConfigurationHubV2025Api. - * @export - * @interface ConfigurationHubV2025ApiUpdateScheduledActionRequest - */ -export interface ConfigurationHubV2025ApiUpdateScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2025ApiUpdateScheduledAction - */ - readonly scheduledActionId: string - - /** - * The JSON Patch document containing the changes to apply to the scheduled action. - * @type {JsonPatchV2025} - * @memberof ConfigurationHubV2025ApiUpdateScheduledAction - */ - readonly jsonPatchV2025: JsonPatchV2025 -} - -/** - * ConfigurationHubV2025Api - object-oriented interface - * @export - * @class ConfigurationHubV2025Api - * @extends {BaseAPI} - */ -export class ConfigurationHubV2025Api extends BaseAPI { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2025ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public createDeploy(requestParameters: ConfigurationHubV2025ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).createDeploy(requestParameters.deployRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2025ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public createObjectMapping(requestParameters: ConfigurationHubV2025ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2025ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public createObjectMappings(requestParameters: ConfigurationHubV2025ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2025ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public createScheduledAction(requestParameters: ConfigurationHubV2025ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).createScheduledAction(requestParameters.scheduledActionPayloadV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2025ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public createUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2025ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public deleteBackup(requestParameters: ConfigurationHubV2025ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).deleteBackup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2025ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public deleteDraft(requestParameters: ConfigurationHubV2025ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).deleteDraft(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2025ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public deleteObjectMapping(requestParameters: ConfigurationHubV2025ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2025ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public deleteScheduledAction(requestParameters: ConfigurationHubV2025ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public deleteUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2025ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public getDeploy(requestParameters: ConfigurationHubV2025ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).getDeploy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2025ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public getObjectMappings(requestParameters: ConfigurationHubV2025ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2025ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public getUploadedConfiguration(requestParameters: ConfigurationHubV2025ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2025ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public listBackups(requestParameters: ConfigurationHubV2025ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).listBackups(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public listDeploys(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).listDeploys(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2025ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public listDrafts(requestParameters: ConfigurationHubV2025ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).listDrafts(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public listScheduledActions(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).listScheduledActions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2025ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public listUploadedConfigurations(requestParameters: ConfigurationHubV2025ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2025ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public updateObjectMappings(requestParameters: ConfigurationHubV2025ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2025ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2025Api - */ - public updateScheduledAction(requestParameters: ConfigurationHubV2025ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2025ApiFp(this.configuration).updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorCustomizersV2025Api - axios parameter creator - * @export - */ -export const ConnectorCustomizersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2025} connectorCustomizerCreateRequestV2025 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer: async (connectorCustomizerCreateRequestV2025: ConnectorCustomizerCreateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorCustomizerCreateRequestV2025' is not null or undefined - assertParamExists('createConnectorCustomizer', 'connectorCustomizerCreateRequestV2025', connectorCustomizerCreateRequestV2025) - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerCreateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createConnectorCustomizerVersion', 'id', id) - const localVarPath = `/connector-customizers/{id}/versions` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2025} [connectorCustomizerUpdateRequestV2025] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer: async (id: string, connectorCustomizerUpdateRequestV2025?: ConnectorCustomizerUpdateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerUpdateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorCustomizersV2025Api - functional programming interface - * @export - */ -export const ConnectorCustomizersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorCustomizersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2025} connectorCustomizerCreateRequestV2025 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizer(connectorCustomizerCreateRequestV2025: ConnectorCustomizerCreateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizer(connectorCustomizerCreateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.createConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizerVersion(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizerVersion(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.createConnectorCustomizerVersion']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.deleteConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.getConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnectorCustomizers(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnectorCustomizers(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.listConnectorCustomizers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2025} [connectorCustomizerUpdateRequestV2025] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCustomizer(id: string, connectorCustomizerUpdateRequestV2025?: ConnectorCustomizerUpdateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCustomizer(id, connectorCustomizerUpdateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2025Api.putConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorCustomizersV2025Api - factory interface - * @export - */ -export const ConnectorCustomizersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorCustomizersV2025ApiFp(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2025ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers(requestParameters: ConnectorCustomizersV2025ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorCustomizer operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest { - /** - * Connector customizer to create. - * @type {ConnectorCustomizerCreateRequestV2025} - * @memberof ConnectorCustomizersV2025ApiCreateConnectorCustomizer - */ - readonly connectorCustomizerCreateRequestV2025: ConnectorCustomizerCreateRequestV2025 -} - -/** - * Request parameters for createConnectorCustomizerVersion operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest - */ -export interface ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest { - /** - * The id of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersion - */ - readonly id: string -} - -/** - * Request parameters for deleteConnectorCustomizer operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest { - /** - * ID of the connector customizer to delete. - * @type {string} - * @memberof ConnectorCustomizersV2025ApiDeleteConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for getConnectorCustomizer operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest { - /** - * ID of the connector customizer to get. - * @type {string} - * @memberof ConnectorCustomizersV2025ApiGetConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for listConnectorCustomizers operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiListConnectorCustomizersRequest - */ -export interface ConnectorCustomizersV2025ApiListConnectorCustomizersRequest { - /** - * 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 ConnectorCustomizersV2025ApiListConnectorCustomizers - */ - 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 ConnectorCustomizersV2025ApiListConnectorCustomizers - */ - readonly limit?: number -} - -/** - * Request parameters for putConnectorCustomizer operation in ConnectorCustomizersV2025Api. - * @export - * @interface ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest { - /** - * ID of the connector customizer to update. - * @type {string} - * @memberof ConnectorCustomizersV2025ApiPutConnectorCustomizer - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorCustomizerUpdateRequestV2025} - * @memberof ConnectorCustomizersV2025ApiPutConnectorCustomizer - */ - readonly connectorCustomizerUpdateRequestV2025?: ConnectorCustomizerUpdateRequestV2025 -} - -/** - * ConnectorCustomizersV2025Api - object-oriented interface - * @export - * @class ConnectorCustomizersV2025Api - * @extends {BaseAPI} - */ -export class ConnectorCustomizersV2025Api extends BaseAPI { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public createConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2025ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public getConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2025ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public listConnectorCustomizers(requestParameters: ConnectorCustomizersV2025ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2025Api - */ - public putConnectorCustomizer(requestParameters: ConnectorCustomizersV2025ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2025ApiFp(this.configuration).putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorRuleManagementV2025Api - axios parameter creator - * @export - */ -export const ConnectorRuleManagementV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2025} connectorRuleCreateRequestV2025 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule: async (connectorRuleCreateRequestV2025: ConnectorRuleCreateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorRuleCreateRequestV2025' is not null or undefined - assertParamExists('createConnectorRule', 'connectorRuleCreateRequestV2025', connectorRuleCreateRequestV2025) - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleCreateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2025} [connectorRuleUpdateRequestV2025] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule: async (id: string, connectorRuleUpdateRequestV2025?: ConnectorRuleUpdateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleUpdateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2025} sourceCodeV2025 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule: async (sourceCodeV2025: SourceCodeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceCodeV2025' is not null or undefined - assertParamExists('testConnectorRule', 'sourceCodeV2025', sourceCodeV2025) - const localVarPath = `/connector-rules/validate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceCodeV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorRuleManagementV2025Api - functional programming interface - * @export - */ -export const ConnectorRuleManagementV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorRuleManagementV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2025} connectorRuleCreateRequestV2025 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorRule(connectorRuleCreateRequestV2025: ConnectorRuleCreateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRule(connectorRuleCreateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.createConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.deleteConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.getConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRuleList(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleList(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.getConnectorRuleList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2025} [connectorRuleUpdateRequestV2025] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorRule(id: string, connectorRuleUpdateRequestV2025?: ConnectorRuleUpdateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorRule(id, connectorRuleUpdateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.putConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2025} sourceCodeV2025 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectorRule(sourceCodeV2025: SourceCodeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectorRule(sourceCodeV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2025Api.testConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorRuleManagementV2025Api - factory interface - * @export - */ -export const ConnectorRuleManagementV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorRuleManagementV2025ApiFp(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorRule(requestParameters.connectorRuleCreateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2025ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList(requestParameters: ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2025ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2025ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectorRule(requestParameters.sourceCodeV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorRule operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest { - /** - * Connector rule to create. - * @type {ConnectorRuleCreateRequestV2025} - * @memberof ConnectorRuleManagementV2025ApiCreateConnectorRule - */ - readonly connectorRuleCreateRequestV2025: ConnectorRuleCreateRequestV2025 -} - -/** - * Request parameters for deleteConnectorRule operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest { - /** - * ID of the connector rule to delete. - * @type {string} - * @memberof ConnectorRuleManagementV2025ApiDeleteConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRule operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiGetConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2025ApiGetConnectorRuleRequest { - /** - * ID of the connector rule to get. - * @type {string} - * @memberof ConnectorRuleManagementV2025ApiGetConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRuleList operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest - */ -export interface ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest { - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2025ApiGetConnectorRuleList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2025ApiGetConnectorRuleList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorRuleManagementV2025ApiGetConnectorRuleList - */ - readonly count?: boolean -} - -/** - * Request parameters for putConnectorRule operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiPutConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2025ApiPutConnectorRuleRequest { - /** - * ID of the connector rule to update. - * @type {string} - * @memberof ConnectorRuleManagementV2025ApiPutConnectorRule - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorRuleUpdateRequestV2025} - * @memberof ConnectorRuleManagementV2025ApiPutConnectorRule - */ - readonly connectorRuleUpdateRequestV2025?: ConnectorRuleUpdateRequestV2025 -} - -/** - * Request parameters for testConnectorRule operation in ConnectorRuleManagementV2025Api. - * @export - * @interface ConnectorRuleManagementV2025ApiTestConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2025ApiTestConnectorRuleRequest { - /** - * Code to validate. - * @type {SourceCodeV2025} - * @memberof ConnectorRuleManagementV2025ApiTestConnectorRule - */ - readonly sourceCodeV2025: SourceCodeV2025 -} - -/** - * ConnectorRuleManagementV2025Api - object-oriented interface - * @export - * @class ConnectorRuleManagementV2025Api - * @extends {BaseAPI} - */ -export class ConnectorRuleManagementV2025Api extends BaseAPI { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public createConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).createConnectorRule(requestParameters.connectorRuleCreateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public deleteConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2025ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public getConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public getConnectorRuleList(requestParameters: ConnectorRuleManagementV2025ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2025ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public putConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2025ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2025Api - */ - public testConnectorRule(requestParameters: ConnectorRuleManagementV2025ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2025ApiFp(this.configuration).testConnectorRule(requestParameters.sourceCodeV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorsV2025Api - axios parameter creator - * @export - */ -export const ConnectorsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2025} v3CreateConnectorDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector: async (v3CreateConnectorDtoV2025: V3CreateConnectorDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'v3CreateConnectorDtoV2025' is not null or undefined - assertParamExists('createCustomConnector', 'v3CreateConnectorDtoV2025', v3CreateConnectorDtoV2025) - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(v3CreateConnectorDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('deleteCustomConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector: async (scriptName: string, locale?: GetConnectorLocaleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorCorrelationConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceTemplate', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2025} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations: async (scriptName: string, locale: GetConnectorTranslationsLocaleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('getConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2025} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations: async (scriptName: string, locale: PutConnectorTranslationsLocaleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('putConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2025 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector: async (scriptName: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('updateConnector', 'scriptName', scriptName) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateConnector', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorsV2025Api - functional programming interface - * @export - */ -export const ConnectorsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2025} v3CreateConnectorDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomConnector(v3CreateConnectorDtoV2025: V3CreateConnectorDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomConnector(v3CreateConnectorDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.createCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomConnector(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomConnector(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.deleteCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnector(scriptName: string, locale?: GetConnectorLocaleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnector(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCorrelationConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCorrelationConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorList(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorList(filters, limit, offset, count, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnectorList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2025} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorTranslations(scriptName: string, locale: GetConnectorTranslationsLocaleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.getConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCorrelationConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCorrelationConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.putConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.putConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceTemplate(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceTemplate(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.putConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2025} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorTranslations(scriptName: string, locale: PutConnectorTranslationsLocaleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.putConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2025 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateConnector(scriptName: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnector(scriptName, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2025Api.updateConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorsV2025Api - factory interface - * @export - */ -export const ConnectorsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorsV2025ApiFp(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2025ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector(requestParameters: ConnectorsV2025ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomConnector(requestParameters.v3CreateConnectorDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2025ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector(requestParameters: ConnectorsV2025ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2025ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector(requestParameters: ConnectorsV2025ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2025ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig(requestParameters: ConnectorsV2025ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2025ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList(requestParameters: ConnectorsV2025ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2025ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig(requestParameters: ConnectorsV2025ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2025ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate(requestParameters: ConnectorsV2025ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2025ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations(requestParameters: ConnectorsV2025ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2025ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig(requestParameters: ConnectorsV2025ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2025ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig(requestParameters: ConnectorsV2025ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2025ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate(requestParameters: ConnectorsV2025ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2025ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations(requestParameters: ConnectorsV2025ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2025ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector(requestParameters: ConnectorsV2025ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomConnector operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiCreateCustomConnectorRequest - */ -export interface ConnectorsV2025ApiCreateCustomConnectorRequest { - /** - * - * @type {V3CreateConnectorDtoV2025} - * @memberof ConnectorsV2025ApiCreateCustomConnector - */ - readonly v3CreateConnectorDtoV2025: V3CreateConnectorDtoV2025 -} - -/** - * Request parameters for deleteCustomConnector operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiDeleteCustomConnectorRequest - */ -export interface ConnectorsV2025ApiDeleteCustomConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiDeleteCustomConnector - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnector operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorRequest - */ -export interface ConnectorsV2025ApiGetConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiGetConnector - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2025ApiGetConnector - */ - readonly locale?: GetConnectorLocaleV2025 -} - -/** - * Request parameters for getConnectorCorrelationConfig operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2025ApiGetConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiGetConnectorCorrelationConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorList operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorListRequest - */ -export interface ConnectorsV2025ApiGetConnectorListRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @type {string} - * @memberof ConnectorsV2025ApiGetConnectorList - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2025ApiGetConnectorList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2025ApiGetConnectorList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorsV2025ApiGetConnectorList - */ - readonly count?: boolean - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2025ApiGetConnectorList - */ - readonly locale?: GetConnectorListLocaleV2025 -} - -/** - * Request parameters for getConnectorSourceConfig operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorSourceConfigRequest - */ -export interface ConnectorsV2025ApiGetConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiGetConnectorSourceConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorSourceTemplate operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorSourceTemplateRequest - */ -export interface ConnectorsV2025ApiGetConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiGetConnectorSourceTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorTranslations operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiGetConnectorTranslationsRequest - */ -export interface ConnectorsV2025ApiGetConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiGetConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2025ApiGetConnectorTranslations - */ - readonly locale: GetConnectorTranslationsLocaleV2025 -} - -/** - * Request parameters for putConnectorCorrelationConfig operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiPutConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2025ApiPutConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiPutConnectorCorrelationConfig - */ - readonly scriptName: string - - /** - * connector correlation config xml file - * @type {File} - * @memberof ConnectorsV2025ApiPutConnectorCorrelationConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceConfig operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiPutConnectorSourceConfigRequest - */ -export interface ConnectorsV2025ApiPutConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiPutConnectorSourceConfig - */ - readonly scriptName: string - - /** - * connector source config xml file - * @type {File} - * @memberof ConnectorsV2025ApiPutConnectorSourceConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceTemplate operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiPutConnectorSourceTemplateRequest - */ -export interface ConnectorsV2025ApiPutConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiPutConnectorSourceTemplate - */ - readonly scriptName: string - - /** - * connector source template xml file - * @type {File} - * @memberof ConnectorsV2025ApiPutConnectorSourceTemplate - */ - readonly file: File -} - -/** - * Request parameters for putConnectorTranslations operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiPutConnectorTranslationsRequest - */ -export interface ConnectorsV2025ApiPutConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiPutConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2025ApiPutConnectorTranslations - */ - readonly locale: PutConnectorTranslationsLocaleV2025 -} - -/** - * Request parameters for updateConnector operation in ConnectorsV2025Api. - * @export - * @interface ConnectorsV2025ApiUpdateConnectorRequest - */ -export interface ConnectorsV2025ApiUpdateConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2025ApiUpdateConnector - */ - readonly scriptName: string - - /** - * A list of connector detail update operations - * @type {Array} - * @memberof ConnectorsV2025ApiUpdateConnector - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * ConnectorsV2025Api - object-oriented interface - * @export - * @class ConnectorsV2025Api - * @extends {BaseAPI} - */ -export class ConnectorsV2025Api extends BaseAPI { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2025ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public createCustomConnector(requestParameters: ConnectorsV2025ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).createCustomConnector(requestParameters.v3CreateConnectorDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2025ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public deleteCustomConnector(requestParameters: ConnectorsV2025ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2025ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnector(requestParameters: ConnectorsV2025ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2025ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnectorCorrelationConfig(requestParameters: ConnectorsV2025ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2025ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnectorList(requestParameters: ConnectorsV2025ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2025ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnectorSourceConfig(requestParameters: ConnectorsV2025ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2025ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnectorSourceTemplate(requestParameters: ConnectorsV2025ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2025ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public getConnectorTranslations(requestParameters: ConnectorsV2025ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2025ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public putConnectorCorrelationConfig(requestParameters: ConnectorsV2025ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2025ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public putConnectorSourceConfig(requestParameters: ConnectorsV2025ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2025ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public putConnectorSourceTemplate(requestParameters: ConnectorsV2025ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2025ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public putConnectorTranslations(requestParameters: ConnectorsV2025ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2025ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2025Api - */ - public updateConnector(requestParameters: ConnectorsV2025ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2025ApiFp(this.configuration).updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetConnectorLocaleV2025 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorLocaleV2025 = typeof GetConnectorLocaleV2025[keyof typeof GetConnectorLocaleV2025]; -/** - * @export - */ -export const GetConnectorListLocaleV2025 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorListLocaleV2025 = typeof GetConnectorListLocaleV2025[keyof typeof GetConnectorListLocaleV2025]; -/** - * @export - */ -export const GetConnectorTranslationsLocaleV2025 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorTranslationsLocaleV2025 = typeof GetConnectorTranslationsLocaleV2025[keyof typeof GetConnectorTranslationsLocaleV2025]; -/** - * @export - */ -export const PutConnectorTranslationsLocaleV2025 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type PutConnectorTranslationsLocaleV2025 = typeof PutConnectorTranslationsLocaleV2025[keyof typeof PutConnectorTranslationsLocaleV2025]; - - -/** - * CustomFormsV2025Api - axios parameter creator - * @export - */ -export const CustomFormsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2025} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition: async (body?: CreateFormDefinitionRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2025} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema: async (body?: FormDefinitionDynamicSchemaRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/forms-action-dynamic-schema`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest: async (formDefinitionID: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'formDefinitionID', formDefinitionID) - // verify required parameter 'file' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'file', file) - const localVarPath = `/form-definitions/{formDefinitionID}/upload` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2025} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance: async (body?: CreateFormInstanceRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('deleteFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3: async (formDefinitionID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFileFromS3', 'formDefinitionID', formDefinitionID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFileFromS3', 'fileID', fileID) - const localVarPath = `/form-definitions/{formDefinitionID}/file/{fileID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFormDefinitionByKey', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey: async (formInstanceID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceByKey', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile: async (formInstanceID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceFile', 'formInstanceID', formInstanceID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFormInstanceFile', 'fileID', fileID) - const localVarPath = `/form-instances/{formInstanceID}/file/{fileID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions: async (body?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition: async (formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('patchFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance: async (formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('patchFormInstance', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID: async (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formInstanceID', formInstanceID) - // verify required parameter 'formElementID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formElementID', formElementID) - const localVarPath = `/form-instances/{formInstanceID}/data-source/{formElementID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"formElementID"}}`, encodeURIComponent(String(formElementID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/predefined-select-options`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2025} [formElementPreviewRequestV2025] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource: async (formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2025?: FormElementPreviewRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('showPreviewDataSource', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}/data-source` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(formElementPreviewRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomFormsV2025Api - functional programming interface - * @export - */ -export const CustomFormsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomFormsV2025ApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2025} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinition(body?: CreateFormDefinitionRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinition(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.createFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2025} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionDynamicSchema(body?: FormDefinitionDynamicSchemaRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionDynamicSchema(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.createFormDefinitionDynamicSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionFileRequest(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionFileRequest(formDefinitionID, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.createFormDefinitionFileRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2025} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormInstance(body?: CreateFormInstanceRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormInstance(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.createFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteFormDefinition(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFormDefinition(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.deleteFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.exportFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFileFromS3(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFileFromS3(formDefinitionID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.getFileFromS3']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormDefinitionByKey(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormDefinitionByKey(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.getFormDefinitionByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceByKey(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceByKey(formInstanceID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.getFormInstanceByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceFile(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceFile(formInstanceID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.getFormInstanceFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importFormDefinitions(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importFormDefinitions(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.importFormDefinitions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormDefinition(formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormDefinition(formDefinitionID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.patchFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormInstance(formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormInstance(formInstanceID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.patchFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.searchFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormElementDataByElementID(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormElementDataByElementID(formInstanceID, formElementID, limit, filters, query, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.searchFormElementDataByElementID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPreDefinedSelectOptions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.searchPreDefinedSelectOptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2025} [formElementPreviewRequestV2025] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showPreviewDataSource(formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2025?: FormElementPreviewRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showPreviewDataSource(formDefinitionID, limit, filters, query, formElementPreviewRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2025Api.showPreviewDataSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomFormsV2025Api - factory interface - * @export - */ -export const CustomFormsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomFormsV2025ApiFp(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2025ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition(requestParameters: CustomFormsV2025ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest(requestParameters: CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2025ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance(requestParameters: CustomFormsV2025ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormInstance(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2025ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition(requestParameters: CustomFormsV2025ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2025ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant(requestParameters: CustomFormsV2025ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2025ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3(requestParameters: CustomFormsV2025ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2025ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey(requestParameters: CustomFormsV2025ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2025ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey(requestParameters: CustomFormsV2025ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2025ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile(requestParameters: CustomFormsV2025ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2025ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions(requestParameters: CustomFormsV2025ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2025ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition(requestParameters: CustomFormsV2025ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2025ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance(requestParameters: CustomFormsV2025ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant(requestParameters: CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2025ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID(requestParameters: CustomFormsV2025ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2025ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant(requestParameters: CustomFormsV2025ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchPreDefinedSelectOptions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2025ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource(requestParameters: CustomFormsV2025ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createFormDefinition operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiCreateFormDefinitionRequest - */ -export interface CustomFormsV2025ApiCreateFormDefinitionRequest { - /** - * Body is the request payload to create form definition request - * @type {CreateFormDefinitionRequestV2025} - * @memberof CustomFormsV2025ApiCreateFormDefinition - */ - readonly body?: CreateFormDefinitionRequestV2025 -} - -/** - * Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest - */ -export interface CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest { - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormDefinitionDynamicSchemaRequestV2025} - * @memberof CustomFormsV2025ApiCreateFormDefinitionDynamicSchema - */ - readonly body?: FormDefinitionDynamicSchemaRequestV2025 -} - -/** - * Request parameters for createFormDefinitionFileRequest operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest - */ -export interface CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest { - /** - * FormDefinitionID String specifying FormDefinitionID - * @type {string} - * @memberof CustomFormsV2025ApiCreateFormDefinitionFileRequest - */ - readonly formDefinitionID: string - - /** - * File specifying the multipart - * @type {File} - * @memberof CustomFormsV2025ApiCreateFormDefinitionFileRequest - */ - readonly file: File -} - -/** - * Request parameters for createFormInstance operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiCreateFormInstanceRequest - */ -export interface CustomFormsV2025ApiCreateFormInstanceRequest { - /** - * Body is the request payload to create a form instance - * @type {CreateFormInstanceRequestV2025} - * @memberof CustomFormsV2025ApiCreateFormInstance - */ - readonly body?: CreateFormInstanceRequestV2025 -} - -/** - * Request parameters for deleteFormDefinition operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiDeleteFormDefinitionRequest - */ -export interface CustomFormsV2025ApiDeleteFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2025ApiDeleteFormDefinition - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for exportFormDefinitionsByTenant operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiExportFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2025ApiExportFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2025ApiExportFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2025ApiExportFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2025ApiExportFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2025ApiExportFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for getFileFromS3 operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiGetFileFromS3Request - */ -export interface CustomFormsV2025ApiGetFileFromS3Request { - /** - * FormDefinitionID Form definition ID - * @type {string} - * @memberof CustomFormsV2025ApiGetFileFromS3 - */ - readonly formDefinitionID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2025ApiGetFileFromS3 - */ - readonly fileID: string -} - -/** - * Request parameters for getFormDefinitionByKey operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiGetFormDefinitionByKeyRequest - */ -export interface CustomFormsV2025ApiGetFormDefinitionByKeyRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2025ApiGetFormDefinitionByKey - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for getFormInstanceByKey operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiGetFormInstanceByKeyRequest - */ -export interface CustomFormsV2025ApiGetFormInstanceByKeyRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2025ApiGetFormInstanceByKey - */ - readonly formInstanceID: string -} - -/** - * Request parameters for getFormInstanceFile operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiGetFormInstanceFileRequest - */ -export interface CustomFormsV2025ApiGetFormInstanceFileRequest { - /** - * FormInstanceID Form instance ID - * @type {string} - * @memberof CustomFormsV2025ApiGetFormInstanceFile - */ - readonly formInstanceID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2025ApiGetFormInstanceFile - */ - readonly fileID: string -} - -/** - * Request parameters for importFormDefinitions operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiImportFormDefinitionsRequest - */ -export interface CustomFormsV2025ApiImportFormDefinitionsRequest { - /** - * Body is the request payload to import form definitions - * @type {Array} - * @memberof CustomFormsV2025ApiImportFormDefinitions - */ - readonly body?: Array -} - -/** - * Request parameters for patchFormDefinition operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiPatchFormDefinitionRequest - */ -export interface CustomFormsV2025ApiPatchFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2025ApiPatchFormDefinition - */ - readonly formDefinitionID: string - - /** - * Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2025ApiPatchFormDefinition - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for patchFormInstance operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiPatchFormInstanceRequest - */ -export interface CustomFormsV2025ApiPatchFormInstanceRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2025ApiPatchFormInstance - */ - readonly formInstanceID: string - - /** - * Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2025ApiPatchFormInstance - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for searchFormDefinitionsByTenant operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2025ApiSearchFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2025ApiSearchFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for searchFormElementDataByElementID operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiSearchFormElementDataByElementIDRequest - */ -export interface CustomFormsV2025ApiSearchFormElementDataByElementIDRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormElementDataByElementID - */ - readonly formInstanceID: string - - /** - * Form element ID - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormElementDataByElementID - */ - readonly formElementID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2025ApiSearchFormElementDataByElementID - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormElementDataByElementID - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormElementDataByElementID - */ - readonly query?: string -} - -/** - * Request parameters for searchFormInstancesByTenant operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest - */ -export interface CustomFormsV2025ApiSearchFormInstancesByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2025ApiSearchFormInstancesByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2025ApiSearchFormInstancesByTenant - */ - readonly limit?: number - - /** - * 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: **formDefinitionId**: *eq* - * @type {string} - * @memberof CustomFormsV2025ApiSearchFormInstancesByTenant - */ - readonly filters?: string -} - -/** - * Request parameters for showPreviewDataSource operation in CustomFormsV2025Api. - * @export - * @interface CustomFormsV2025ApiShowPreviewDataSourceRequest - */ -export interface CustomFormsV2025ApiShowPreviewDataSourceRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2025ApiShowPreviewDataSource - */ - readonly formDefinitionID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2025ApiShowPreviewDataSource - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2025ApiShowPreviewDataSource - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2025ApiShowPreviewDataSource - */ - readonly query?: string - - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormElementPreviewRequestV2025} - * @memberof CustomFormsV2025ApiShowPreviewDataSource - */ - readonly formElementPreviewRequestV2025?: FormElementPreviewRequestV2025 -} - -/** - * CustomFormsV2025Api - object-oriented interface - * @export - * @class CustomFormsV2025Api - * @extends {BaseAPI} - */ -export class CustomFormsV2025Api extends BaseAPI { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2025ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public createFormDefinition(requestParameters: CustomFormsV2025ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2025ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public createFormDefinitionFileRequest(requestParameters: CustomFormsV2025ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2025ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public createFormInstance(requestParameters: CustomFormsV2025ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).createFormInstance(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2025ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public deleteFormDefinition(requestParameters: CustomFormsV2025ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2025ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public exportFormDefinitionsByTenant(requestParameters: CustomFormsV2025ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2025ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public getFileFromS3(requestParameters: CustomFormsV2025ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2025ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public getFormDefinitionByKey(requestParameters: CustomFormsV2025ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2025ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public getFormInstanceByKey(requestParameters: CustomFormsV2025ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2025ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public getFormInstanceFile(requestParameters: CustomFormsV2025ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2025ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public importFormDefinitions(requestParameters: CustomFormsV2025ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2025ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public patchFormDefinition(requestParameters: CustomFormsV2025ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2025ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public patchFormInstance(requestParameters: CustomFormsV2025ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public searchFormDefinitionsByTenant(requestParameters: CustomFormsV2025ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2025ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public searchFormElementDataByElementID(requestParameters: CustomFormsV2025ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2025ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public searchFormInstancesByTenant(requestParameters: CustomFormsV2025ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).searchPreDefinedSelectOptions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2025ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2025Api - */ - public showPreviewDataSource(requestParameters: CustomFormsV2025ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2025ApiFp(this.configuration).showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CustomPasswordInstructionsV2025Api - axios parameter creator - * @export - */ -export const CustomPasswordInstructionsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2025} customPasswordInstructionV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions: async (customPasswordInstructionV2025: CustomPasswordInstructionV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'customPasswordInstructionV2025' is not null or undefined - assertParamExists('createCustomPasswordInstructions', 'customPasswordInstructionV2025', customPasswordInstructionV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(customPasswordInstructionV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2025} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions: async (pageId: DeleteCustomPasswordInstructionsPageIdV2025, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('deleteCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2025} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions: async (pageId: GetCustomPasswordInstructionsPageIdV2025, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('getCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomPasswordInstructionsV2025Api - functional programming interface - * @export - */ -export const CustomPasswordInstructionsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomPasswordInstructionsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2025} customPasswordInstructionV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPasswordInstructions(customPasswordInstructionV2025: CustomPasswordInstructionV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPasswordInstructions(customPasswordInstructionV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2025Api.createCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2025} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPasswordInstructions(pageId: DeleteCustomPasswordInstructionsPageIdV2025, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2025Api.deleteCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2025} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomPasswordInstructions(pageId: GetCustomPasswordInstructionsPageIdV2025, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2025Api.getCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomPasswordInstructionsV2025Api - factory interface - * @export - */ -export const CustomPasswordInstructionsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomPasswordInstructionsV2025ApiFp(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPasswordInstructions operation in CustomPasswordInstructionsV2025Api. - * @export - * @interface CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest { - /** - * - * @type {CustomPasswordInstructionV2025} - * @memberof CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructions - */ - readonly customPasswordInstructionV2025: CustomPasswordInstructionV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteCustomPasswordInstructions operation in CustomPasswordInstructionsV2025Api. - * @export - * @interface CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to delete. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructions - */ - readonly pageId: DeleteCustomPasswordInstructionsPageIdV2025 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCustomPasswordInstructions operation in CustomPasswordInstructionsV2025Api. - * @export - * @interface CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to query. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructions - */ - readonly pageId: GetCustomPasswordInstructionsPageIdV2025 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * CustomPasswordInstructionsV2025Api - object-oriented interface - * @export - * @class CustomPasswordInstructionsV2025Api - * @extends {BaseAPI} - */ -export class CustomPasswordInstructionsV2025Api extends BaseAPI { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2025Api - */ - public createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2025ApiFp(this.configuration).createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2025Api - */ - public deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2025ApiFp(this.configuration).deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2025Api - */ - public getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2025ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2025ApiFp(this.configuration).getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteCustomPasswordInstructionsPageIdV2025 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type DeleteCustomPasswordInstructionsPageIdV2025 = typeof DeleteCustomPasswordInstructionsPageIdV2025[keyof typeof DeleteCustomPasswordInstructionsPageIdV2025]; -/** - * @export - */ -export const GetCustomPasswordInstructionsPageIdV2025 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type GetCustomPasswordInstructionsPageIdV2025 = typeof GetCustomPasswordInstructionsPageIdV2025[keyof typeof GetCustomPasswordInstructionsPageIdV2025]; - - -/** - * CustomUserLevelsV2025Api - axios parameter creator - * @export - */ -export const CustomUserLevelsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomUserLevel: async (userLevelRequestV2025: UserLevelRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'userLevelRequestV2025' is not null or undefined - assertParamExists('createCustomUserLevel', 'userLevelRequestV2025', userLevelRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(userLevelRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **category**: *eq* - * @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, name, category** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllAuthorizationRightSets: async (xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/authorization-assignable-right-sets`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @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: **displayName** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevelIdentities: async (id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listUserLevelIdentities', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/user-levels/{id}/identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {ListUserLevelsDetailLevelV2025} [detailLevel] Specifies the level of detail for the user levels. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @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: **name, created, description, status, owner** - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevels: async (xSailPointExperimental?: string, detailLevel?: ListUserLevelsDetailLevelV2025, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {string} id The unique identifier of the user level to publish. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishCustomUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('publishCustomUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{id}/publish` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showUserLevelCounts: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('showUserLevelCounts', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/user-levels/get-identity-count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {string} id The unique identifier of the user level. - * @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateUserLevel: async (id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateUserLevel', 'id', id) - // verify required parameter 'jsonPatchV2025' is not null or undefined - assertParamExists('updateUserLevel', 'jsonPatchV2025', jsonPatchV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomUserLevelsV2025Api - functional programming interface - * @export - */ -export const CustomUserLevelsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomUserLevelsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {UserLevelRequestV2025} userLevelRequestV2025 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomUserLevel(userLevelRequestV2025: UserLevelRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomUserLevel(userLevelRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.createCustomUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.deleteUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.getUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **category**: *eq* - * @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, name, category** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllAuthorizationRightSets(xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllAuthorizationRightSets(xSailPointExperimental, filters, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.listAllAuthorizationRightSets']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @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: **displayName** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUserLevelIdentities(id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevelIdentities(id, xSailPointExperimental, count, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.listUserLevelIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {ListUserLevelsDetailLevelV2025} [detailLevel] Specifies the level of detail for the user levels. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @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: **name, created, description, status, owner** - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUserLevels(xSailPointExperimental?: string, detailLevel?: ListUserLevelsDetailLevelV2025, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevels(xSailPointExperimental, detailLevel, filters, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.listUserLevels']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {string} id The unique identifier of the user level to publish. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async publishCustomUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishCustomUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.publishCustomUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showUserLevelCounts(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showUserLevelCounts(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.showUserLevelCounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {string} id The unique identifier of the user level. - * @param {JsonPatchV2025} jsonPatchV2025 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateUserLevel(id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserLevel(id, jsonPatchV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2025Api.updateUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomUserLevelsV2025Api - factory interface - * @export - */ -export const CustomUserLevelsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomUserLevelsV2025ApiFp(configuration) - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {CustomUserLevelsV2025ApiCreateCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiCreateCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomUserLevel(requestParameters.userLevelRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {CustomUserLevelsV2025ApiDeleteUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUserLevel(requestParameters: CustomUserLevelsV2025ApiDeleteUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {CustomUserLevelsV2025ApiGetUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUserLevel(requestParameters: CustomUserLevelsV2025ApiGetUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllAuthorizationRightSets(requestParameters: CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllAuthorizationRightSets(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevelIdentities(requestParameters: CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUserLevelIdentities(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {CustomUserLevelsV2025ApiListUserLevelsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevels(requestParameters: CustomUserLevelsV2025ApiListUserLevelsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUserLevels(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {CustomUserLevelsV2025ApiPublishCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishCustomUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {CustomUserLevelsV2025ApiShowUserLevelCountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showUserLevelCounts(requestParameters: CustomUserLevelsV2025ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.showUserLevelCounts(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {CustomUserLevelsV2025ApiUpdateUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateUserLevel(requestParameters: CustomUserLevelsV2025ApiUpdateUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateUserLevel(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomUserLevel operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiCreateCustomUserLevelRequest - */ -export interface CustomUserLevelsV2025ApiCreateCustomUserLevelRequest { - /** - * Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @type {UserLevelRequestV2025} - * @memberof CustomUserLevelsV2025ApiCreateCustomUserLevel - */ - readonly userLevelRequestV2025: UserLevelRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiCreateCustomUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteUserLevel operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiDeleteUserLevelRequest - */ -export interface CustomUserLevelsV2025ApiDeleteUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2025ApiDeleteUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiDeleteUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getUserLevel operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiGetUserLevelRequest - */ -export interface CustomUserLevelsV2025ApiGetUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2025ApiGetUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiGetUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllAuthorizationRightSets operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest - */ -export interface CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiListAllAuthorizationRightSets - */ - readonly xSailPointExperimental?: 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: **category**: *eq* - * @type {string} - * @memberof CustomUserLevelsV2025ApiListAllAuthorizationRightSets - */ - 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, name, category** - * @type {string} - * @memberof CustomUserLevelsV2025ApiListAllAuthorizationRightSets - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListAllAuthorizationRightSets - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListAllAuthorizationRightSets - */ - readonly offset?: number -} - -/** - * Request parameters for listUserLevelIdentities operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest - */ -export interface CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly xSailPointExperimental?: string - - /** - * If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @type {boolean} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly count?: boolean - - /** - * 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: **displayName** - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListUserLevelIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for listUserLevels operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiListUserLevelsRequest - */ -export interface CustomUserLevelsV2025ApiListUserLevelsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - readonly xSailPointExperimental?: string - - /** - * Specifies the level of detail for the user levels. - * @type {'FULL' | 'SLIM'} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - readonly detailLevel?: ListUserLevelsDetailLevelV2025 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - 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: **name, created, description, status, owner** - * @type {string} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - readonly sorters?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2025ApiListUserLevels - */ - readonly offset?: number -} - -/** - * Request parameters for publishCustomUserLevel operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiPublishCustomUserLevelRequest - */ -export interface CustomUserLevelsV2025ApiPublishCustomUserLevelRequest { - /** - * The unique identifier of the user level to publish. - * @type {string} - * @memberof CustomUserLevelsV2025ApiPublishCustomUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiPublishCustomUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for showUserLevelCounts operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiShowUserLevelCountsRequest - */ -export interface CustomUserLevelsV2025ApiShowUserLevelCountsRequest { - /** - * List of user level ids. Max 50 identifiers can be passed in a single request. - * @type {Array} - * @memberof CustomUserLevelsV2025ApiShowUserLevelCounts - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiShowUserLevelCounts - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateUserLevel operation in CustomUserLevelsV2025Api. - * @export - * @interface CustomUserLevelsV2025ApiUpdateUserLevelRequest - */ -export interface CustomUserLevelsV2025ApiUpdateUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2025ApiUpdateUserLevel - */ - readonly id: string - - /** - * JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @type {JsonPatchV2025} - * @memberof CustomUserLevelsV2025ApiUpdateUserLevel - */ - readonly jsonPatchV2025: JsonPatchV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2025ApiUpdateUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * CustomUserLevelsV2025Api - object-oriented interface - * @export - * @class CustomUserLevelsV2025Api - * @extends {BaseAPI} - */ -export class CustomUserLevelsV2025Api extends BaseAPI { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {CustomUserLevelsV2025ApiCreateCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public createCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiCreateCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).createCustomUserLevel(requestParameters.userLevelRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {CustomUserLevelsV2025ApiDeleteUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public deleteUserLevel(requestParameters: CustomUserLevelsV2025ApiDeleteUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).deleteUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {CustomUserLevelsV2025ApiGetUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public getUserLevel(requestParameters: CustomUserLevelsV2025ApiGetUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).getUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public listAllAuthorizationRightSets(requestParameters: CustomUserLevelsV2025ApiListAllAuthorizationRightSetsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).listAllAuthorizationRightSets(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public listUserLevelIdentities(requestParameters: CustomUserLevelsV2025ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).listUserLevelIdentities(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {CustomUserLevelsV2025ApiListUserLevelsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public listUserLevels(requestParameters: CustomUserLevelsV2025ApiListUserLevelsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).listUserLevels(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {CustomUserLevelsV2025ApiPublishCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public publishCustomUserLevel(requestParameters: CustomUserLevelsV2025ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).publishCustomUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {CustomUserLevelsV2025ApiShowUserLevelCountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public showUserLevelCounts(requestParameters: CustomUserLevelsV2025ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).showUserLevelCounts(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {CustomUserLevelsV2025ApiUpdateUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2025Api - */ - public updateUserLevel(requestParameters: CustomUserLevelsV2025ApiUpdateUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2025ApiFp(this.configuration).updateUserLevel(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListUserLevelsDetailLevelV2025 = { - Full: 'FULL', - Slim: 'SLIM' -} as const; -export type ListUserLevelsDetailLevelV2025 = typeof ListUserLevelsDetailLevelV2025[keyof typeof ListUserLevelsDetailLevelV2025]; - - -/** - * DataAccessSecurityV2025Api - axios parameter creator - * @export - */ -export const DataAccessSecurityV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {number} id The unique identifier of the task to cancel. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelTask', 'id', id) - const localVarPath = `/das/tasks/cancel/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {BaseCreateApplicationRequestV2025} baseCreateApplicationRequestV2025 Request body containing the details required to create a new application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createApplication: async (baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'baseCreateApplicationRequestV2025' is not null or undefined - assertParamExists('createApplication', 'baseCreateApplicationRequestV2025', baseCreateApplicationRequestV2025) - const localVarPath = `/das/applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(baseCreateApplicationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Create a new schedule. - * @param {CreateScheduleRequestV2025} createScheduleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSchedule: async (createScheduleRequestV2025: CreateScheduleRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduleRequestV2025' is not null or undefined - assertParamExists('createSchedule', 'createScheduleRequestV2025', createScheduleRequestV2025) - const localVarPath = `/das/tasks/schedules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduleRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Assign owner to application resource. - * @param {AssignResourceOwnerRequestV2025} assignResourceOwnerRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersAssignPost: async (assignResourceOwnerRequestV2025: AssignResourceOwnerRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'assignResourceOwnerRequestV2025' is not null or undefined - assertParamExists('dasOwnersAssignPost', 'assignResourceOwnerRequestV2025', assignResourceOwnerRequestV2025) - const localVarPath = `/das/owners/assign`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(assignResourceOwnerRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List resources for owner. - * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersOwnerIdentityIdResourcesGet: async (ownerIdentityId: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ownerIdentityId' is not null or undefined - assertParamExists('dasOwnersOwnerIdentityIdResourcesGet', 'ownerIdentityId', ownerIdentityId) - const localVarPath = `/das/owners/{ownerIdentityId}/resources` - .replace(`{${"ownerIdentityId"}}`, encodeURIComponent(String(ownerIdentityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Re-elect resource owner. - * @param {ReelectRequestV2025} reelectRequestV2025 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersReelectPost: async (reelectRequestV2025: ReelectRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reelectRequestV2025' is not null or undefined - assertParamExists('dasOwnersReelectPost', 'reelectRequestV2025', reelectRequestV2025) - const localVarPath = `/das/owners/reelect`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reelectRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List owners for resource. - * @param {number} resourceId Unique identifier for the resource. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersResourcesResourceIdGet: async (resourceId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('dasOwnersResourcesResourceIdGet', 'resourceId', resourceId) - const localVarPath = `/das/owners/resources/{resourceId}` - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Reassign resource owner. - * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost: async (sourceIdentityId: string, destinationIdentityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceIdentityId' is not null or undefined - assertParamExists('dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'sourceIdentityId', sourceIdentityId) - // verify required parameter 'destinationIdentityId' is not null or undefined - assertParamExists('dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'destinationIdentityId', destinationIdentityId) - const localVarPath = `/das/owners/{sourceIdentityId}/reassign/{destinationIdentityId}` - .replace(`{${"sourceIdentityId"}}`, encodeURIComponent(String(sourceIdentityId))) - .replace(`{${"destinationIdentityId"}}`, encodeURIComponent(String(destinationIdentityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {number} id The unique identifier of the application to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApplication: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteApplication', 'id', id) - const localVarPath = `/das/applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {number} id The unique identifier of the schedule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSchedule: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSchedule', 'id', id) - const localVarPath = `/das/tasks/schedules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {number} id The unique identifier of the task to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTask', 'id', id) - const localVarPath = `/das/tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {number} id The unique identifier of the application to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplication: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApplication', 'id', id) - const localVarPath = `/das/applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplications: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Retrieve owners per application. - * @param {number} appId The unique identifier of the application for which to retrieve owners. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOwners: async (appId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'appId' is not null or undefined - assertParamExists('getOwners', 'appId', appId) - const localVarPath = `/das/owners/applications/{appId}` - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {number} id The unique identifier of the schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedule: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSchedule', 'id', id) - const localVarPath = `/das/tasks/schedules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedules: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/tasks/schedules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {number} id The unique identifier of the task to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTask', 'id', id) - const localVarPath = `/das/tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTasks: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {number} id The unique identifier of the application to update. - * @param {BaseCreateApplicationRequestV2025} baseCreateApplicationRequestV2025 Request body containing the updated details for the application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApplication: async (id: number, baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putApplication', 'id', id) - // verify required parameter 'baseCreateApplicationRequestV2025' is not null or undefined - assertParamExists('putApplication', 'baseCreateApplicationRequestV2025', baseCreateApplicationRequestV2025) - const localVarPath = `/das/applications/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(baseCreateApplicationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Update a schedule. - * @param {number} id The unique identifier of the schedule to update. - * @param {UpdateScheduleRequestV2025} updateScheduleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSchedule: async (id: number, updateScheduleRequestV2025: UpdateScheduleRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSchedule', 'id', id) - // verify required parameter 'updateScheduleRequestV2025' is not null or undefined - assertParamExists('putSchedule', 'updateScheduleRequestV2025', updateScheduleRequestV2025) - const localVarPath = `/das/tasks/schedules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateScheduleRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {number} id The unique identifier of the task to rerun. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTaskRerun: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startTaskRerun', 'id', id) - const localVarPath = `/das/tasks/rerun/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DataAccessSecurityV2025Api - functional programming interface - * @export - */ -export const DataAccessSecurityV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DataAccessSecurityV2025ApiAxiosParamCreator(configuration) - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {number} id The unique identifier of the task to cancel. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.cancelTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {BaseCreateApplicationRequestV2025} baseCreateApplicationRequestV2025 Request body containing the details required to create a new application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createApplication(baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createApplication(baseCreateApplicationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.createApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Create a new schedule. - * @param {CreateScheduleRequestV2025} createScheduleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSchedule(createScheduleRequestV2025: CreateScheduleRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSchedule(createScheduleRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.createSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Assign owner to application resource. - * @param {AssignResourceOwnerRequestV2025} assignResourceOwnerRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersAssignPost(assignResourceOwnerRequestV2025: AssignResourceOwnerRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersAssignPost(assignResourceOwnerRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.dasOwnersAssignPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List resources for owner. - * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersOwnerIdentityIdResourcesGet(ownerIdentityId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersOwnerIdentityIdResourcesGet(ownerIdentityId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.dasOwnersOwnerIdentityIdResourcesGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Re-elect resource owner. - * @param {ReelectRequestV2025} reelectRequestV2025 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersReelectPost(reelectRequestV2025: ReelectRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersReelectPost(reelectRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.dasOwnersReelectPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List owners for resource. - * @param {number} resourceId Unique identifier for the resource. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersResourcesResourceIdGet(resourceId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersResourcesResourceIdGet(resourceId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.dasOwnersResourcesResourceIdGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Reassign resource owner. - * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId: string, destinationIdentityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId, destinationIdentityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {number} id The unique identifier of the application to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteApplication(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApplication(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.deleteApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {number} id The unique identifier of the schedule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSchedule(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.deleteSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {number} id The unique identifier of the task to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.deleteTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {number} id The unique identifier of the application to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApplication(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApplication(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApplications(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApplications(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Retrieve owners per application. - * @param {number} appId The unique identifier of the application for which to retrieve owners. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOwners(appId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOwners(appId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getOwners']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {number} id The unique identifier of the schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSchedule(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSchedules(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSchedules(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getSchedules']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {number} id The unique identifier of the task to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTasks(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTasks(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.getTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {number} id The unique identifier of the application to update. - * @param {BaseCreateApplicationRequestV2025} baseCreateApplicationRequestV2025 Request body containing the updated details for the application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putApplication(id: number, baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putApplication(id, baseCreateApplicationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.putApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Update a schedule. - * @param {number} id The unique identifier of the schedule to update. - * @param {UpdateScheduleRequestV2025} updateScheduleRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSchedule(id: number, updateScheduleRequestV2025: UpdateScheduleRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSchedule(id, updateScheduleRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.putSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {number} id The unique identifier of the task to rerun. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTaskRerun(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTaskRerun(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2025Api.startTaskRerun']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DataAccessSecurityV2025Api - factory interface - * @export - */ -export const DataAccessSecurityV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DataAccessSecurityV2025ApiFp(configuration) - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {DataAccessSecurityV2025ApiCancelTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelTask(requestParameters: DataAccessSecurityV2025ApiCancelTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {DataAccessSecurityV2025ApiCreateApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createApplication(requestParameters: DataAccessSecurityV2025ApiCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createApplication(requestParameters.baseCreateApplicationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Create a new schedule. - * @param {DataAccessSecurityV2025ApiCreateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSchedule(requestParameters: DataAccessSecurityV2025ApiCreateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSchedule(requestParameters.createScheduleRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Assign owner to application resource. - * @param {DataAccessSecurityV2025ApiDasOwnersAssignPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersAssignPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersAssignPost(requestParameters.assignResourceOwnerRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List resources for owner. - * @param {DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.dasOwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Re-elect resource owner. - * @param {DataAccessSecurityV2025ApiDasOwnersReelectPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersReelectPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersReelectPost(requestParameters.reelectRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List owners for resource. - * @param {DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.dasOwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Reassign resource owner. - * @param {DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {DataAccessSecurityV2025ApiDeleteApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApplication(requestParameters: DataAccessSecurityV2025ApiDeleteApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteApplication(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {DataAccessSecurityV2025ApiDeleteScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSchedule(requestParameters: DataAccessSecurityV2025ApiDeleteScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {DataAccessSecurityV2025ApiDeleteTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTask(requestParameters: DataAccessSecurityV2025ApiDeleteTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {DataAccessSecurityV2025ApiGetApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplication(requestParameters: DataAccessSecurityV2025ApiGetApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApplication(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @param {DataAccessSecurityV2025ApiGetApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplications(requestParameters: DataAccessSecurityV2025ApiGetApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getApplications(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Retrieve owners per application. - * @param {DataAccessSecurityV2025ApiGetOwnersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOwners(requestParameters: DataAccessSecurityV2025ApiGetOwnersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getOwners(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {DataAccessSecurityV2025ApiGetScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedule(requestParameters: DataAccessSecurityV2025ApiGetScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @param {DataAccessSecurityV2025ApiGetSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedules(requestParameters: DataAccessSecurityV2025ApiGetSchedulesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSchedules(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {DataAccessSecurityV2025ApiGetTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTask(requestParameters: DataAccessSecurityV2025ApiGetTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @param {DataAccessSecurityV2025ApiGetTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTasks(requestParameters: DataAccessSecurityV2025ApiGetTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTasks(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {DataAccessSecurityV2025ApiPutApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApplication(requestParameters: DataAccessSecurityV2025ApiPutApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putApplication(requestParameters.id, requestParameters.baseCreateApplicationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Update a schedule. - * @param {DataAccessSecurityV2025ApiPutScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSchedule(requestParameters: DataAccessSecurityV2025ApiPutScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSchedule(requestParameters.id, requestParameters.updateScheduleRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {DataAccessSecurityV2025ApiStartTaskRerunRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTaskRerun(requestParameters: DataAccessSecurityV2025ApiStartTaskRerunRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startTaskRerun(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelTask operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiCancelTaskRequest - */ -export interface DataAccessSecurityV2025ApiCancelTaskRequest { - /** - * The unique identifier of the task to cancel. - * @type {number} - * @memberof DataAccessSecurityV2025ApiCancelTask - */ - readonly id: number -} - -/** - * Request parameters for createApplication operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiCreateApplicationRequest - */ -export interface DataAccessSecurityV2025ApiCreateApplicationRequest { - /** - * Request body containing the details required to create a new application. - * @type {BaseCreateApplicationRequestV2025} - * @memberof DataAccessSecurityV2025ApiCreateApplication - */ - readonly baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025 -} - -/** - * Request parameters for createSchedule operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiCreateScheduleRequest - */ -export interface DataAccessSecurityV2025ApiCreateScheduleRequest { - /** - * - * @type {CreateScheduleRequestV2025} - * @memberof DataAccessSecurityV2025ApiCreateSchedule - */ - readonly createScheduleRequestV2025: CreateScheduleRequestV2025 -} - -/** - * Request parameters for dasOwnersAssignPost operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDasOwnersAssignPostRequest - */ -export interface DataAccessSecurityV2025ApiDasOwnersAssignPostRequest { - /** - * - * @type {AssignResourceOwnerRequestV2025} - * @memberof DataAccessSecurityV2025ApiDasOwnersAssignPost - */ - readonly assignResourceOwnerRequestV2025: AssignResourceOwnerRequestV2025 -} - -/** - * Request parameters for dasOwnersOwnerIdentityIdResourcesGet operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest - */ -export interface DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest { - /** - * Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @type {string} - * @memberof DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly ownerIdentityId: string - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly offset?: number -} - -/** - * Request parameters for dasOwnersReelectPost operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDasOwnersReelectPostRequest - */ -export interface DataAccessSecurityV2025ApiDasOwnersReelectPostRequest { - /** - * The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @type {ReelectRequestV2025} - * @memberof DataAccessSecurityV2025ApiDasOwnersReelectPost - */ - readonly reelectRequestV2025: ReelectRequestV2025 -} - -/** - * Request parameters for dasOwnersResourcesResourceIdGet operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest - */ -export interface DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest { - /** - * Unique identifier for the resource. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGet - */ - readonly resourceId: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGet - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGet - */ - readonly offset?: number -} - -/** - * Request parameters for dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest - */ -export interface DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest { - /** - * Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @type {string} - * @memberof DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPost - */ - readonly sourceIdentityId: string - - /** - * Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @type {string} - * @memberof DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPost - */ - readonly destinationIdentityId: string -} - -/** - * Request parameters for deleteApplication operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDeleteApplicationRequest - */ -export interface DataAccessSecurityV2025ApiDeleteApplicationRequest { - /** - * The unique identifier of the application to delete. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDeleteApplication - */ - readonly id: number -} - -/** - * Request parameters for deleteSchedule operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDeleteScheduleRequest - */ -export interface DataAccessSecurityV2025ApiDeleteScheduleRequest { - /** - * The unique identifier of the schedule to delete. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDeleteSchedule - */ - readonly id: number -} - -/** - * Request parameters for deleteTask operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiDeleteTaskRequest - */ -export interface DataAccessSecurityV2025ApiDeleteTaskRequest { - /** - * The unique identifier of the task to delete. - * @type {number} - * @memberof DataAccessSecurityV2025ApiDeleteTask - */ - readonly id: number -} - -/** - * Request parameters for getApplication operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetApplicationRequest - */ -export interface DataAccessSecurityV2025ApiGetApplicationRequest { - /** - * The unique identifier of the application to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetApplication - */ - readonly id: number -} - -/** - * Request parameters for getApplications operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetApplicationsRequest - */ -export interface DataAccessSecurityV2025ApiGetApplicationsRequest { - /** - * 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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof DataAccessSecurityV2025ApiGetApplications - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetApplications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2025ApiGetApplications - */ - readonly count?: boolean -} - -/** - * Request parameters for getOwners operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetOwnersRequest - */ -export interface DataAccessSecurityV2025ApiGetOwnersRequest { - /** - * The unique identifier of the application for which to retrieve owners. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetOwners - */ - readonly appId: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetOwners - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetOwners - */ - readonly offset?: number -} - -/** - * Request parameters for getSchedule operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetScheduleRequest - */ -export interface DataAccessSecurityV2025ApiGetScheduleRequest { - /** - * The unique identifier of the schedule to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetSchedule - */ - readonly id: number -} - -/** - * Request parameters for getSchedules operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetSchedulesRequest - */ -export interface DataAccessSecurityV2025ApiGetSchedulesRequest { - /** - * 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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof DataAccessSecurityV2025ApiGetSchedules - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetSchedules - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetSchedules - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2025ApiGetSchedules - */ - readonly count?: boolean -} - -/** - * Request parameters for getTask operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetTaskRequest - */ -export interface DataAccessSecurityV2025ApiGetTaskRequest { - /** - * The unique identifier of the task to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetTask - */ - readonly id: number -} - -/** - * Request parameters for getTasks operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiGetTasksRequest - */ -export interface DataAccessSecurityV2025ApiGetTasksRequest { - /** - * 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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @type {string} - * @memberof DataAccessSecurityV2025ApiGetTasks - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2025ApiGetTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2025ApiGetTasks - */ - readonly count?: boolean -} - -/** - * Request parameters for putApplication operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiPutApplicationRequest - */ -export interface DataAccessSecurityV2025ApiPutApplicationRequest { - /** - * The unique identifier of the application to update. - * @type {number} - * @memberof DataAccessSecurityV2025ApiPutApplication - */ - readonly id: number - - /** - * Request body containing the updated details for the application. - * @type {BaseCreateApplicationRequestV2025} - * @memberof DataAccessSecurityV2025ApiPutApplication - */ - readonly baseCreateApplicationRequestV2025: BaseCreateApplicationRequestV2025 -} - -/** - * Request parameters for putSchedule operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiPutScheduleRequest - */ -export interface DataAccessSecurityV2025ApiPutScheduleRequest { - /** - * The unique identifier of the schedule to update. - * @type {number} - * @memberof DataAccessSecurityV2025ApiPutSchedule - */ - readonly id: number - - /** - * - * @type {UpdateScheduleRequestV2025} - * @memberof DataAccessSecurityV2025ApiPutSchedule - */ - readonly updateScheduleRequestV2025: UpdateScheduleRequestV2025 -} - -/** - * Request parameters for startTaskRerun operation in DataAccessSecurityV2025Api. - * @export - * @interface DataAccessSecurityV2025ApiStartTaskRerunRequest - */ -export interface DataAccessSecurityV2025ApiStartTaskRerunRequest { - /** - * The unique identifier of the task to rerun. - * @type {number} - * @memberof DataAccessSecurityV2025ApiStartTaskRerun - */ - readonly id: number -} - -/** - * DataAccessSecurityV2025Api - object-oriented interface - * @export - * @class DataAccessSecurityV2025Api - * @extends {BaseAPI} - */ -export class DataAccessSecurityV2025Api extends BaseAPI { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {DataAccessSecurityV2025ApiCancelTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public cancelTask(requestParameters: DataAccessSecurityV2025ApiCancelTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).cancelTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {DataAccessSecurityV2025ApiCreateApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public createApplication(requestParameters: DataAccessSecurityV2025ApiCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).createApplication(requestParameters.baseCreateApplicationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Create a new schedule. - * @param {DataAccessSecurityV2025ApiCreateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public createSchedule(requestParameters: DataAccessSecurityV2025ApiCreateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).createSchedule(requestParameters.createScheduleRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Assign owner to application resource. - * @param {DataAccessSecurityV2025ApiDasOwnersAssignPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public dasOwnersAssignPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).dasOwnersAssignPost(requestParameters.assignResourceOwnerRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List resources for owner. - * @param {DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public dasOwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV2025ApiDasOwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).dasOwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Re-elect resource owner. - * @param {DataAccessSecurityV2025ApiDasOwnersReelectPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public dasOwnersReelectPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).dasOwnersReelectPost(requestParameters.reelectRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List owners for resource. - * @param {DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public dasOwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV2025ApiDasOwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).dasOwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Reassign resource owner. - * @param {DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV2025ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {DataAccessSecurityV2025ApiDeleteApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public deleteApplication(requestParameters: DataAccessSecurityV2025ApiDeleteApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).deleteApplication(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {DataAccessSecurityV2025ApiDeleteScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public deleteSchedule(requestParameters: DataAccessSecurityV2025ApiDeleteScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).deleteSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {DataAccessSecurityV2025ApiDeleteTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public deleteTask(requestParameters: DataAccessSecurityV2025ApiDeleteTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).deleteTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {DataAccessSecurityV2025ApiGetApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getApplication(requestParameters: DataAccessSecurityV2025ApiGetApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getApplication(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @param {DataAccessSecurityV2025ApiGetApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getApplications(requestParameters: DataAccessSecurityV2025ApiGetApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getApplications(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Retrieve owners per application. - * @param {DataAccessSecurityV2025ApiGetOwnersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getOwners(requestParameters: DataAccessSecurityV2025ApiGetOwnersRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getOwners(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {DataAccessSecurityV2025ApiGetScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getSchedule(requestParameters: DataAccessSecurityV2025ApiGetScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @param {DataAccessSecurityV2025ApiGetSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getSchedules(requestParameters: DataAccessSecurityV2025ApiGetSchedulesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getSchedules(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {DataAccessSecurityV2025ApiGetTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getTask(requestParameters: DataAccessSecurityV2025ApiGetTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @param {DataAccessSecurityV2025ApiGetTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public getTasks(requestParameters: DataAccessSecurityV2025ApiGetTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).getTasks(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {DataAccessSecurityV2025ApiPutApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public putApplication(requestParameters: DataAccessSecurityV2025ApiPutApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).putApplication(requestParameters.id, requestParameters.baseCreateApplicationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Update a schedule. - * @param {DataAccessSecurityV2025ApiPutScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public putSchedule(requestParameters: DataAccessSecurityV2025ApiPutScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).putSchedule(requestParameters.id, requestParameters.updateScheduleRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {DataAccessSecurityV2025ApiStartTaskRerunRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2025Api - */ - public startTaskRerun(requestParameters: DataAccessSecurityV2025ApiStartTaskRerunRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2025ApiFp(this.configuration).startTaskRerun(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DataSegmentationV2025Api - axios parameter creator - * @export - */ -export const DataSegmentationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2025} dataSegmentV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment: async (dataSegmentV2025: DataSegmentV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'dataSegmentV2025' is not null or undefined - assertParamExists('createDataSegment', 'dataSegmentV2025', dataSegmentV2025) - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dataSegmentV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment: async (id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentIdentityMembership', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/membership/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentationEnabledForUser', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/user-enabled/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments: async (enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (enabled !== undefined) { - localVarQueryParameter['enabled'] = enabled; - } - - if (unique !== undefined) { - localVarQueryParameter['unique'] = unique; - } - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchDataSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment: async (requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('publishDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (publishAll !== undefined) { - localVarQueryParameter['publishAll'] = publishAll; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DataSegmentationV2025Api - functional programming interface - * @export - */ -export const DataSegmentationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DataSegmentationV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2025} dataSegmentV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDataSegment(dataSegmentV2025: DataSegmentV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDataSegment(dataSegmentV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.createDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDataSegment(id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDataSegment(id, published, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.deleteDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegment(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegment(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.getDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentIdentityMembership(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentIdentityMembership(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.getDataSegmentIdentityMembership']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentationEnabledForUser(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentationEnabledForUser(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.getDataSegmentationEnabledForUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDataSegments(enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDataSegments(enabled, unique, published, limit, offset, count, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.listDataSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDataSegment(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDataSegment(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.patchDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async publishDataSegment(requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishDataSegment(requestBody, publishAll, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2025Api.publishDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DataSegmentationV2025Api - factory interface - * @export - */ -export const DataSegmentationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DataSegmentationV2025ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2025ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment(requestParameters: DataSegmentationV2025ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDataSegment(requestParameters.dataSegmentV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2025ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment(requestParameters: DataSegmentationV2025ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2025ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment(requestParameters: DataSegmentationV2025ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2025ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments(requestParameters: DataSegmentationV2025ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2025ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment(requestParameters: DataSegmentationV2025ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2025ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment(requestParameters: DataSegmentationV2025ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDataSegment operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiCreateDataSegmentRequest - */ -export interface DataSegmentationV2025ApiCreateDataSegmentRequest { - /** - * - * @type {DataSegmentV2025} - * @memberof DataSegmentationV2025ApiCreateDataSegment - */ - readonly dataSegmentV2025: DataSegmentV2025 -} - -/** - * Request parameters for deleteDataSegment operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiDeleteDataSegmentRequest - */ -export interface DataSegmentationV2025ApiDeleteDataSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof DataSegmentationV2025ApiDeleteDataSegment - */ - readonly id: string - - /** - * This determines which version of the segment to delete - * @type {boolean} - * @memberof DataSegmentationV2025ApiDeleteDataSegment - */ - readonly published?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiDeleteDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegment operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiGetDataSegmentRequest - */ -export interface DataSegmentationV2025ApiGetDataSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegment - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentIdentityMembership operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest - */ -export interface DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest { - /** - * The identity ID to retrieve the segments they are in. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegmentIdentityMembership - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegmentIdentityMembership - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentationEnabledForUser operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest - */ -export interface DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest { - /** - * The identity ID to retrieve if segmentation is enabled for the identity. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegmentationEnabledForUser - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiGetDataSegmentationEnabledForUser - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listDataSegments operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiListDataSegmentsRequest - */ -export interface DataSegmentationV2025ApiListDataSegmentsRequest { - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly enabled?: boolean - - /** - * This returns only one record if set to true and that would be the published record if exists. - * @type {boolean} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly unique?: boolean - - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @type {boolean} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly published?: boolean - - /** - * 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 DataSegmentationV2025ApiListDataSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - 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, in, sw* **name**: *eq, in, sw* - * @type {string} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiListDataSegments - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchDataSegment operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiPatchDataSegmentRequest - */ -export interface DataSegmentationV2025ApiPatchDataSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof DataSegmentationV2025ApiPatchDataSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @type {Array} - * @memberof DataSegmentationV2025ApiPatchDataSegment - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiPatchDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for publishDataSegment operation in DataSegmentationV2025Api. - * @export - * @interface DataSegmentationV2025ApiPublishDataSegmentRequest - */ -export interface DataSegmentationV2025ApiPublishDataSegmentRequest { - /** - * A list of segment ids that you wish to publish - * @type {Array} - * @memberof DataSegmentationV2025ApiPublishDataSegment - */ - readonly requestBody: Array - - /** - * This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @type {boolean} - * @memberof DataSegmentationV2025ApiPublishDataSegment - */ - readonly publishAll?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2025ApiPublishDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * DataSegmentationV2025Api - object-oriented interface - * @export - * @class DataSegmentationV2025Api - * @extends {BaseAPI} - */ -export class DataSegmentationV2025Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2025ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public createDataSegment(requestParameters: DataSegmentationV2025ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).createDataSegment(requestParameters.dataSegmentV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2025ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public deleteDataSegment(requestParameters: DataSegmentationV2025ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2025ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public getDataSegment(requestParameters: DataSegmentationV2025ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2025ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2025ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2025ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public listDataSegments(requestParameters: DataSegmentationV2025ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2025ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public patchDataSegment(requestParameters: DataSegmentationV2025ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2025ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2025Api - */ - public publishDataSegment(requestParameters: DataSegmentationV2025ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2025ApiFp(this.configuration).publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DeclassifySourceV2025Api - axios parameter creator - * @export - */ -export const DeclassifySourceV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDeclassifyMachineAccountFromSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('sendDeclassifyMachineAccountFromSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/declassify` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DeclassifySourceV2025Api - functional programming interface - * @export - */ -export const DeclassifySourceV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DeclassifySourceV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendDeclassifyMachineAccountFromSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendDeclassifyMachineAccountFromSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DeclassifySourceV2025Api.sendDeclassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DeclassifySourceV2025Api - factory interface - * @export - */ -export const DeclassifySourceV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DeclassifySourceV2025ApiFp(configuration) - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDeclassifyMachineAccountFromSource(requestParameters: DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendDeclassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for sendDeclassifyMachineAccountFromSource operation in DeclassifySourceV2025Api. - * @export - * @interface DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest - */ -export interface DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSource - */ - readonly sourceId: string -} - -/** - * DeclassifySourceV2025Api - object-oriented interface - * @export - * @class DeclassifySourceV2025Api - * @extends {BaseAPI} - */ -export class DeclassifySourceV2025Api extends BaseAPI { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DeclassifySourceV2025Api - */ - public sendDeclassifyMachineAccountFromSource(requestParameters: DeclassifySourceV2025ApiSendDeclassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return DeclassifySourceV2025ApiFp(this.configuration).sendDeclassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DimensionsV2025Api - axios parameter creator - * @export - */ -export const DimensionsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2025} dimensionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension: async (roleId: string, dimensionV2025: DimensionV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('createDimension', 'roleId', roleId) - // verify required parameter 'dimensionV2025' is not null or undefined - assertParamExists('createDimension', 'dimensionV2025', dimensionV2025) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2025} dimensionBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions: async (roleId: string, dimensionBulkDeleteRequestV2025: DimensionBulkDeleteRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteBulkDimensions', 'roleId', roleId) - // verify required parameter 'dimensionBulkDeleteRequestV2025' is not null or undefined - assertParamExists('deleteBulkDimensions', 'dimensionBulkDeleteRequestV2025', dimensionBulkDeleteRequestV2025) - const localVarPath = `/roles/{roleId}/dimensions/bulk-delete` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionBulkDeleteRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('deleteDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/entitlements` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions: async (roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensions', 'roleId', roleId) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension: async (roleId: string, dimensionId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('patchDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('patchDimension', 'dimensionId', dimensionId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchDimension', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DimensionsV2025Api - functional programming interface - * @export - */ -export const DimensionsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DimensionsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2025} dimensionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDimension(roleId: string, dimensionV2025: DimensionV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDimension(roleId, dimensionV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.createDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2025} dimensionBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkDimensions(roleId: string, dimensionBulkDeleteRequestV2025: DimensionBulkDeleteRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkDimensions(roleId, dimensionBulkDeleteRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.deleteBulkDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.deleteDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.getDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimensionEntitlements(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimensionEntitlements(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.getDimensionEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensionAccessProfiles(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensionAccessProfiles(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.listDimensionAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensions(roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensions(roleId, forSubadmin, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.listDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDimension(roleId: string, dimensionId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDimension(roleId, dimensionId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2025Api.patchDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DimensionsV2025Api - factory interface - * @export - */ -export const DimensionsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DimensionsV2025ApiFp(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2025ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension(requestParameters: DimensionsV2025ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDimension(requestParameters.roleId, requestParameters.dimensionV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2025ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions(requestParameters: DimensionsV2025ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2025ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension(requestParameters: DimensionsV2025ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2025ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension(requestParameters: DimensionsV2025ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2025ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements(requestParameters: DimensionsV2025ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2025ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles(requestParameters: DimensionsV2025ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2025ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions(requestParameters: DimensionsV2025ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2025ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension(requestParameters: DimensionsV2025ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDimension operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiCreateDimensionRequest - */ -export interface DimensionsV2025ApiCreateDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiCreateDimension - */ - readonly roleId: string - - /** - * - * @type {DimensionV2025} - * @memberof DimensionsV2025ApiCreateDimension - */ - readonly dimensionV2025: DimensionV2025 -} - -/** - * Request parameters for deleteBulkDimensions operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiDeleteBulkDimensionsRequest - */ -export interface DimensionsV2025ApiDeleteBulkDimensionsRequest { - /** - * Parent Role Id of the dimensions. - * @type {string} - * @memberof DimensionsV2025ApiDeleteBulkDimensions - */ - readonly roleId: string - - /** - * - * @type {DimensionBulkDeleteRequestV2025} - * @memberof DimensionsV2025ApiDeleteBulkDimensions - */ - readonly dimensionBulkDeleteRequestV2025: DimensionBulkDeleteRequestV2025 -} - -/** - * Request parameters for deleteDimension operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiDeleteDimensionRequest - */ -export interface DimensionsV2025ApiDeleteDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiDeleteDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2025ApiDeleteDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimension operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiGetDimensionRequest - */ -export interface DimensionsV2025ApiGetDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiGetDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2025ApiGetDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimensionEntitlements operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiGetDimensionEntitlementsRequest - */ -export interface DimensionsV2025ApiGetDimensionEntitlementsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof DimensionsV2025ApiGetDimensionEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensionAccessProfiles operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiListDimensionAccessProfilesRequest - */ -export interface DimensionsV2025ApiListDimensionAccessProfilesRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2025ApiListDimensionAccessProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensions operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiListDimensionsRequest - */ -export interface DimensionsV2025ApiListDimensionsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiListDimensions - */ - readonly roleId: string - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof DimensionsV2025ApiListDimensions - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiListDimensions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2025ApiListDimensions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2025ApiListDimensions - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2025ApiListDimensions - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2025ApiListDimensions - */ - readonly sorters?: string -} - -/** - * Request parameters for patchDimension operation in DimensionsV2025Api. - * @export - * @interface DimensionsV2025ApiPatchDimensionRequest - */ -export interface DimensionsV2025ApiPatchDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2025ApiPatchDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2025ApiPatchDimension - */ - readonly dimensionId: string - - /** - * - * @type {Array} - * @memberof DimensionsV2025ApiPatchDimension - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * DimensionsV2025Api - object-oriented interface - * @export - * @class DimensionsV2025Api - * @extends {BaseAPI} - */ -export class DimensionsV2025Api extends BaseAPI { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2025ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public createDimension(requestParameters: DimensionsV2025ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).createDimension(requestParameters.roleId, requestParameters.dimensionV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2025ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public deleteBulkDimensions(requestParameters: DimensionsV2025ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2025ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public deleteDimension(requestParameters: DimensionsV2025ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2025ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public getDimension(requestParameters: DimensionsV2025ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2025ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public getDimensionEntitlements(requestParameters: DimensionsV2025ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2025ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public listDimensionAccessProfiles(requestParameters: DimensionsV2025ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2025ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public listDimensions(requestParameters: DimensionsV2025ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2025ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2025Api - */ - public patchDimension(requestParameters: DimensionsV2025ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2025ApiFp(this.configuration).patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * EntitlementsV2025Api - axios parameter creator - * @export - */ -export const EntitlementsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementRequestConfig', 'id', id) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource: async (id: string, csvFile?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsBySource', 'id', id) - const localVarPath = `/entitlements/aggregate/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (csvFile !== undefined) { - localVarFormParams.append('csvFile', csvFile as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementChildren', 'id', id) - const localVarPath = `/entitlements/{id}/children` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementParents', 'id', id) - const localVarPath = `/entitlements/{id}/parents` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements: async (accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accountId !== undefined) { - localVarQueryParameter['account-id'] = accountId; - } - - if (segmentedForIdentity !== undefined) { - localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement: async (id: string, jsonPatchOperationV2025?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2025} entitlementRequestConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig: async (id: string, entitlementRequestConfigV2025: EntitlementRequestConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'id', id) - // verify required parameter 'entitlementRequestConfigV2025' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'entitlementRequestConfigV2025', entitlementRequestConfigV2025) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementRequestConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('resetSourceEntitlements', 'id', id) - const localVarPath = `/entitlements/reset/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2025} entitlementBulkUpdateRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk: async (entitlementBulkUpdateRequestV2025: EntitlementBulkUpdateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementBulkUpdateRequestV2025' is not null or undefined - assertParamExists('updateEntitlementsInBulk', 'entitlementBulkUpdateRequestV2025', entitlementBulkUpdateRequestV2025) - const localVarPath = `/entitlements/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementBulkUpdateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * EntitlementsV2025Api - functional programming interface - * @export - */ -export const EntitlementsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = EntitlementsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataForEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.createAccessModelMetadataForEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessModelMetadataFromEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.deleteAccessModelMetadataFromEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlement(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.getEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementRequestConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementRequestConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.getEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async importEntitlementsBySource(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsBySource(id, csvFile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.importEntitlementsBySource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildren(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.listEntitlementChildren']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, name, created, modified, type, attribute, value, source.id** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParents(id, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.listEntitlementParents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [accountId] The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlements(accountId?: string, segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlements(accountId, segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.listEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlement(id: string, jsonPatchOperationV2025?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlement(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.patchEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2025} entitlementRequestConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putEntitlementRequestConfig(id: string, entitlementRequestConfigV2025: EntitlementRequestConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putEntitlementRequestConfig(id, entitlementRequestConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.putEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetSourceEntitlements(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetSourceEntitlements(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.resetSourceEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2025} entitlementBulkUpdateRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsInBulk(entitlementBulkUpdateRequestV2025: EntitlementBulkUpdateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulk(entitlementBulkUpdateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2025Api.updateEntitlementsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * EntitlementsV2025Api - factory interface - * @export - */ -export const EntitlementsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = EntitlementsV2025ApiFp(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2025ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement(requestParameters: EntitlementsV2025ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlement(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2025ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig(requestParameters: EntitlementsV2025ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2025ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource(requestParameters: EntitlementsV2025ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2025ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren(requestParameters: EntitlementsV2025ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2025ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents(requestParameters: EntitlementsV2025ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2025ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements(requestParameters: EntitlementsV2025ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2025ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement(requestParameters: EntitlementsV2025ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2025ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig(requestParameters: EntitlementsV2025ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2025ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements(requestParameters: EntitlementsV2025ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2025ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk(requestParameters: EntitlementsV2025ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataForEntitlement operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest - */ -export interface EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2025ApiCreateAccessModelMetadataForEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2025ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2025ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest - */ -export interface EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for getEntitlement operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiGetEntitlementRequest - */ -export interface EntitlementsV2025ApiGetEntitlementRequest { - /** - * The entitlement ID - * @type {string} - * @memberof EntitlementsV2025ApiGetEntitlement - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementRequestConfig operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiGetEntitlementRequestConfigRequest - */ -export interface EntitlementsV2025ApiGetEntitlementRequestConfigRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2025ApiGetEntitlementRequestConfig - */ - readonly id: string -} - -/** - * Request parameters for importEntitlementsBySource operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiImportEntitlementsBySourceRequest - */ -export interface EntitlementsV2025ApiImportEntitlementsBySourceRequest { - /** - * Source Id - * @type {string} - * @memberof EntitlementsV2025ApiImportEntitlementsBySource - */ - readonly id: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof EntitlementsV2025ApiImportEntitlementsBySource - */ - readonly csvFile?: File -} - -/** - * Request parameters for listEntitlementChildren operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiListEntitlementChildrenRequest - */ -export interface EntitlementsV2025ApiListEntitlementChildrenRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementChildren - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlementParents operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiListEntitlementParentsRequest - */ -export interface EntitlementsV2025ApiListEntitlementParentsRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id** - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlementParents - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlements operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiListEntitlementsRequest - */ -export interface EntitlementsV2025ApiListEntitlementsRequest { - /** - * The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly accountId?: string - - /** - * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity. - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly segmentedForIdentity?: string - - /** - * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @type {boolean} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly includeUnsegmented?: boolean - - /** - * 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 EntitlementsV2025ApiListEntitlements - */ - 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 EntitlementsV2025ApiListEntitlements - */ - 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 EntitlementsV2025ApiListEntitlements - */ - readonly count?: boolean - - /** - * 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof EntitlementsV2025ApiListEntitlements - */ - readonly filters?: string -} - -/** - * Request parameters for patchEntitlement operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiPatchEntitlementRequest - */ -export interface EntitlementsV2025ApiPatchEntitlementRequest { - /** - * ID of the entitlement to patch - * @type {string} - * @memberof EntitlementsV2025ApiPatchEntitlement - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof EntitlementsV2025ApiPatchEntitlement - */ - readonly jsonPatchOperationV2025?: Array -} - -/** - * Request parameters for putEntitlementRequestConfig operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiPutEntitlementRequestConfigRequest - */ -export interface EntitlementsV2025ApiPutEntitlementRequestConfigRequest { - /** - * Entitlement ID - * @type {string} - * @memberof EntitlementsV2025ApiPutEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {EntitlementRequestConfigV2025} - * @memberof EntitlementsV2025ApiPutEntitlementRequestConfig - */ - readonly entitlementRequestConfigV2025: EntitlementRequestConfigV2025 -} - -/** - * Request parameters for resetSourceEntitlements operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiResetSourceEntitlementsRequest - */ -export interface EntitlementsV2025ApiResetSourceEntitlementsRequest { - /** - * ID of source for the entitlement reset - * @type {string} - * @memberof EntitlementsV2025ApiResetSourceEntitlements - */ - readonly id: string -} - -/** - * Request parameters for updateEntitlementsInBulk operation in EntitlementsV2025Api. - * @export - * @interface EntitlementsV2025ApiUpdateEntitlementsInBulkRequest - */ -export interface EntitlementsV2025ApiUpdateEntitlementsInBulkRequest { - /** - * - * @type {EntitlementBulkUpdateRequestV2025} - * @memberof EntitlementsV2025ApiUpdateEntitlementsInBulk - */ - readonly entitlementBulkUpdateRequestV2025: EntitlementBulkUpdateRequestV2025 -} - -/** - * EntitlementsV2025Api - object-oriented interface - * @export - * @class EntitlementsV2025Api - * @extends {BaseAPI} - */ -export class EntitlementsV2025Api extends BaseAPI { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2025ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2025ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2025ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public getEntitlement(requestParameters: EntitlementsV2025ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).getEntitlement(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2025ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public getEntitlementRequestConfig(requestParameters: EntitlementsV2025ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2025ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public importEntitlementsBySource(requestParameters: EntitlementsV2025ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2025ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public listEntitlementChildren(requestParameters: EntitlementsV2025ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2025ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public listEntitlementParents(requestParameters: EntitlementsV2025ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2025ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public listEntitlements(requestParameters: EntitlementsV2025ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).listEntitlements(requestParameters.accountId, requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2025ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public patchEntitlement(requestParameters: EntitlementsV2025ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2025ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public putEntitlementRequestConfig(requestParameters: EntitlementsV2025ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2025ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public resetSourceEntitlements(requestParameters: EntitlementsV2025ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2025ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2025Api - */ - public updateEntitlementsInBulk(requestParameters: EntitlementsV2025ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2025ApiFp(this.configuration).updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GlobalTenantSecuritySettingsV2025Api - axios parameter creator - * @export - */ -export const GlobalTenantSecuritySettingsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2025} networkConfigurationV2025 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig: async (networkConfigurationV2025: NetworkConfigurationV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'networkConfigurationV2025' is not null or undefined - assertParamExists('createAuthOrgNetworkConfig', 'networkConfigurationV2025', networkConfigurationV2025) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(networkConfigurationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig: async (jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAuthOrgLockoutConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2025 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig: async (jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAuthOrgNetworkConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig: async (jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAuthOrgServiceProviderConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig: async (jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchAuthOrgSessionConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2025Api - functional programming interface - * @export - */ -export const GlobalTenantSecuritySettingsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GlobalTenantSecuritySettingsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2025} networkConfigurationV2025 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAuthOrgNetworkConfig(networkConfigurationV2025: NetworkConfigurationV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAuthOrgNetworkConfig(networkConfigurationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.createAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgLockoutConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.getAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgNetworkConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.getAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgServiceProviderConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.getAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgSessionConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.getAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgLockoutConfig(jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgLockoutConfig(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.patchAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2025 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgNetworkConfig(jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgNetworkConfig(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.patchAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgServiceProviderConfig(jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgServiceProviderConfig(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.patchAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2025 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgSessionConfig(jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgSessionConfig(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2025Api.patchAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2025Api - factory interface - * @export - */ -export const GlobalTenantSecuritySettingsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GlobalTenantSecuritySettingsV2025ApiFp(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgLockoutConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgNetworkConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgSessionConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2025Api. - * @export - * @interface GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest { - /** - * Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {NetworkConfigurationV2025} - * @memberof GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfig - */ - readonly networkConfigurationV2025: NetworkConfigurationV2025 -} - -/** - * Request parameters for patchAuthOrgLockoutConfig operation in GlobalTenantSecuritySettingsV2025Api. - * @export - * @interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest { - /** - * A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfig - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2025Api. - * @export - * @interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest { - /** - * A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfig - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for patchAuthOrgServiceProviderConfig operation in GlobalTenantSecuritySettingsV2025Api. - * @export - * @interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest { - /** - * A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfig - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for patchAuthOrgSessionConfig operation in GlobalTenantSecuritySettingsV2025Api. - * @export - * @interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest { - /** - * A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfig - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * GlobalTenantSecuritySettingsV2025Api - object-oriented interface - * @export - * @class GlobalTenantSecuritySettingsV2025Api - * @extends {BaseAPI} - */ -export class GlobalTenantSecuritySettingsV2025Api extends BaseAPI { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).getAuthOrgLockoutConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).getAuthOrgNetworkConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).getAuthOrgSessionConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2025Api - */ - public patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2025ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2025ApiFp(this.configuration).patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GovernanceGroupsV2025Api - axios parameter creator - * @export - */ -export const GovernanceGroupsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2025} workgroupDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup: async (workgroupDtoV2025: WorkgroupDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupDtoV2025' is not null or undefined - assertParamExists('createWorkgroup', 'workgroupDtoV2025', workgroupDtoV2025) - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2025 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2025' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'identityPreviewResponseIdentityV2025', identityPreviewResponseIdentityV2025) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-delete` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2025} workgroupBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk: async (workgroupBulkDeleteRequestV2025: WorkgroupBulkDeleteRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupBulkDeleteRequestV2025' is not null or undefined - assertParamExists('deleteWorkgroupsInBulk', 'workgroupBulkDeleteRequestV2025', workgroupBulkDeleteRequestV2025) - const localVarPath = `/workgroups/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupBulkDeleteRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listConnections', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/connections` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listWorkgroupMembers', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/members` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup: async (id: string, jsonPatchOperationV2025?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2025 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2025' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'identityPreviewResponseIdentityV2025', identityPreviewResponseIdentityV2025) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-add` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GovernanceGroupsV2025Api - functional programming interface - * @export - */ -export const GovernanceGroupsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GovernanceGroupsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2025} workgroupDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkgroup(workgroupDtoV2025: WorkgroupDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkgroup(workgroupDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.createWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.deleteWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2025 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.deleteWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2025} workgroupBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2025: WorkgroupBulkDeleteRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.deleteWorkgroupsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.getWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnections(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.listConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroupMembers(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupMembers(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.listWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroups(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroups(offset, limit, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.listWorkgroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkgroup(id: string, jsonPatchOperationV2025?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkgroup(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.patchWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2025 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2025Api.updateWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GovernanceGroupsV2025Api - factory interface - * @export - */ -export const GovernanceGroupsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GovernanceGroupsV2025ApiFp(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2025ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup(requestParameters: GovernanceGroupsV2025ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkgroup(requestParameters.workgroupDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2025ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup(requestParameters: GovernanceGroupsV2025ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2025ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections(requestParameters: GovernanceGroupsV2025ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2025ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2025ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups(requestParameters: GovernanceGroupsV2025ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2025ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup(requestParameters: GovernanceGroupsV2025ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createWorkgroup operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiCreateWorkgroupRequest - */ -export interface GovernanceGroupsV2025ApiCreateWorkgroupRequest { - /** - * - * @type {WorkgroupDtoV2025} - * @memberof GovernanceGroupsV2025ApiCreateWorkgroup - */ - readonly workgroupDtoV2025: WorkgroupDtoV2025 -} - -/** - * Request parameters for deleteWorkgroup operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiDeleteWorkgroupRequest - */ -export interface GovernanceGroupsV2025ApiDeleteWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2025ApiDeleteWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkgroupMembers operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2025ApiDeleteWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be removed from a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2025ApiDeleteWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2025: Array -} - -/** - * Request parameters for deleteWorkgroupsInBulk operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest - */ -export interface GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest { - /** - * - * @type {WorkgroupBulkDeleteRequestV2025} - * @memberof GovernanceGroupsV2025ApiDeleteWorkgroupsInBulk - */ - readonly workgroupBulkDeleteRequestV2025: WorkgroupBulkDeleteRequestV2025 -} - -/** - * Request parameters for getWorkgroup operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiGetWorkgroupRequest - */ -export interface GovernanceGroupsV2025ApiGetWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2025ApiGetWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for listConnections operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiListConnectionsRequest - */ -export interface GovernanceGroupsV2025ApiListConnectionsRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2025ApiListConnections - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2025ApiListConnections - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2025ApiListConnections - */ - 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 GovernanceGroupsV2025ApiListConnections - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2025ApiListConnections - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroupMembers operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiListWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2025ApiListWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2025ApiListWorkgroupMembers - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2025ApiListWorkgroupMembers - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2025ApiListWorkgroupMembers - */ - 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 GovernanceGroupsV2025ApiListWorkgroupMembers - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2025ApiListWorkgroupMembers - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroups operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiListWorkgroupsRequest - */ -export interface GovernanceGroupsV2025ApiListWorkgroupsRequest { - /** - * 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 GovernanceGroupsV2025ApiListWorkgroups - */ - 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 GovernanceGroupsV2025ApiListWorkgroups - */ - 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 GovernanceGroupsV2025ApiListWorkgroups - */ - 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @type {string} - * @memberof GovernanceGroupsV2025ApiListWorkgroups - */ - 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: **name, created, modified, id, description** - * @type {string} - * @memberof GovernanceGroupsV2025ApiListWorkgroups - */ - readonly sorters?: string -} - -/** - * Request parameters for patchWorkgroup operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiPatchWorkgroupRequest - */ -export interface GovernanceGroupsV2025ApiPatchWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2025ApiPatchWorkgroup - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof GovernanceGroupsV2025ApiPatchWorkgroup - */ - readonly jsonPatchOperationV2025?: Array -} - -/** - * Request parameters for updateWorkgroupMembers operation in GovernanceGroupsV2025Api. - * @export - * @interface GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2025ApiUpdateWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be added to a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2025ApiUpdateWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2025: Array -} - -/** - * GovernanceGroupsV2025Api - object-oriented interface - * @export - * @class GovernanceGroupsV2025Api - * @extends {BaseAPI} - */ -export class GovernanceGroupsV2025Api extends BaseAPI { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2025ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public createWorkgroup(requestParameters: GovernanceGroupsV2025ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).createWorkgroup(requestParameters.workgroupDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public deleteWorkgroup(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2025ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2025ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public getWorkgroup(requestParameters: GovernanceGroupsV2025ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2025ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public listConnections(requestParameters: GovernanceGroupsV2025ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2025ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public listWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2025ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public listWorkgroups(requestParameters: GovernanceGroupsV2025ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2025ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public patchWorkgroup(requestParameters: GovernanceGroupsV2025ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2025Api - */ - public updateWorkgroupMembers(requestParameters: GovernanceGroupsV2025ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2025ApiFp(this.configuration).updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIAccessRequestRecommendationsV2025Api - axios parameter creator - * @export - */ -export const IAIAccessRequestRecommendationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem: async (accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2025' is not null or undefined - assertParamExists('addAccessRequestRecommendationsIgnoredItem', 'accessRequestRecommendationActionItemDtoV2025', accessRequestRecommendationActionItemDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem: async (accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2025' is not null or undefined - assertParamExists('addAccessRequestRecommendationsRequestedItem', 'accessRequestRecommendationActionItemDtoV2025', accessRequestRecommendationActionItemDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem: async (accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2025' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItem', 'accessRequestRecommendationActionItemDtoV2025', accessRequestRecommendationActionItemDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2025 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems: async (accessRequestRecommendationActionItemDtoV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2025' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItems', 'accessRequestRecommendationActionItemDtoV2025', accessRequestRecommendationActionItemDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items/bulk-create`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations: async (identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2025} accessRequestRecommendationConfigDtoV2025 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig: async (accessRequestRecommendationConfigDtoV2025: AccessRequestRecommendationConfigDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationConfigDtoV2025' is not null or undefined - assertParamExists('setAccessRequestRecommendationsConfig', 'accessRequestRecommendationConfigDtoV2025', accessRequestRecommendationConfigDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationConfigDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2025Api - functional programming interface - * @export - */ -export const IAIAccessRequestRecommendationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIAccessRequestRecommendationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.addAccessRequestRecommendationsIgnoredItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.addAccessRequestRecommendationsRequestedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2025} accessRequestRecommendationActionItemDtoV2025 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.addAccessRequestRecommendationsViewedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2025 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.addAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendations(identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendations(identityId, limit, offset, count, includeTranslationMessages, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.getAccessRequestRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.getAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsIgnoredItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsIgnoredItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.getAccessRequestRecommendationsIgnoredItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsRequestedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsRequestedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.getAccessRequestRecommendationsRequestedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsViewedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsViewedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.getAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2025} accessRequestRecommendationConfigDtoV2025 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2025: AccessRequestRecommendationConfigDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2025Api.setAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2025Api - factory interface - * @export - */ -export const IAIAccessRequestRecommendationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIAccessRequestRecommendationsV2025ApiFp(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for addAccessRequestRecommendationsIgnoredItem operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest { - /** - * The recommended access item to ignore for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2025} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsRequestedItem operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest { - /** - * The recommended access item that was requested for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2025} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItem operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest { - /** - * The recommended access that was viewed for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2025} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItem - */ - readonly accessRequestRecommendationActionItemDtoV2025: AccessRequestRecommendationActionItemDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest { - /** - * The recommended access items that were viewed for an identity. - * @type {Array} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItems - */ - readonly accessRequestRecommendationActionItemDtoV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendations operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest { - /** - * Get access request recommendations for an identityId. *me* indicates the current user. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly identityId?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly count?: boolean - - /** - * If *true* it will populate a list of translation messages in the response. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly includeTranslationMessages?: 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsIgnoredItems operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsRequestedItems operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2025Api. - * @export - * @interface IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest { - /** - * The desired configurations for Access Request Recommender for the tenant. - * @type {AccessRequestRecommendationConfigDtoV2025} - * @memberof IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfig - */ - readonly accessRequestRecommendationConfigDtoV2025: AccessRequestRecommendationConfigDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIAccessRequestRecommendationsV2025Api - object-oriented interface - * @export - * @class IAIAccessRequestRecommendationsV2025Api - * @extends {BaseAPI} - */ -export class IAIAccessRequestRecommendationsV2025Api extends BaseAPI { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2025ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2025Api - */ - public setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2025ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2025ApiFp(this.configuration).setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAICommonAccessV2025Api - axios parameter creator - * @export - */ -export const IAICommonAccessV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2025} commonAccessItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess: async (commonAccessItemRequestV2025: CommonAccessItemRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessItemRequestV2025' is not null or undefined - assertParamExists('createCommonAccess', 'commonAccessItemRequestV2025', commonAccessItemRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessItemRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2025 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk: async (commonAccessIDStatusV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessIDStatusV2025' is not null or undefined - assertParamExists('updateCommonAccessStatusInBulk', 'commonAccessIDStatusV2025', commonAccessIDStatusV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access/update-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessIDStatusV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAICommonAccessV2025Api - functional programming interface - * @export - */ -export const IAICommonAccessV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAICommonAccessV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2025} commonAccessItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCommonAccess(commonAccessItemRequestV2025: CommonAccessItemRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCommonAccess(commonAccessItemRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2025Api.createCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCommonAccess(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCommonAccess(offset, limit, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2025Api.getCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2025 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCommonAccessStatusInBulk(commonAccessIDStatusV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommonAccessStatusInBulk(commonAccessIDStatusV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2025Api.updateCommonAccessStatusInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAICommonAccessV2025Api - factory interface - * @export - */ -export const IAICommonAccessV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAICommonAccessV2025ApiFp(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2025ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess(requestParameters: IAICommonAccessV2025ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCommonAccess(requestParameters.commonAccessItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2025ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess(requestParameters: IAICommonAccessV2025ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCommonAccess operation in IAICommonAccessV2025Api. - * @export - * @interface IAICommonAccessV2025ApiCreateCommonAccessRequest - */ -export interface IAICommonAccessV2025ApiCreateCommonAccessRequest { - /** - * - * @type {CommonAccessItemRequestV2025} - * @memberof IAICommonAccessV2025ApiCreateCommonAccess - */ - readonly commonAccessItemRequestV2025: CommonAccessItemRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2025ApiCreateCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCommonAccess operation in IAICommonAccessV2025Api. - * @export - * @interface IAICommonAccessV2025ApiGetCommonAccessRequest - */ -export interface IAICommonAccessV2025ApiGetCommonAccessRequest { - /** - * 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 IAICommonAccessV2025ApiGetCommonAccess - */ - 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 IAICommonAccessV2025ApiGetCommonAccess - */ - 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 IAICommonAccessV2025ApiGetCommonAccess - */ - 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @type {string} - * @memberof IAICommonAccessV2025ApiGetCommonAccess - */ - 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: **access.name, status** By default the common access items are sorted by name, ascending. - * @type {string} - * @memberof IAICommonAccessV2025ApiGetCommonAccess - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2025ApiGetCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateCommonAccessStatusInBulk operation in IAICommonAccessV2025Api. - * @export - * @interface IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest - */ -export interface IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest { - /** - * Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @type {Array} - * @memberof IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulk - */ - readonly commonAccessIDStatusV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * IAICommonAccessV2025Api - object-oriented interface - * @export - * @class IAICommonAccessV2025Api - * @extends {BaseAPI} - */ -export class IAICommonAccessV2025Api extends BaseAPI { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2025ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2025Api - */ - public createCommonAccess(requestParameters: IAICommonAccessV2025ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2025ApiFp(this.configuration).createCommonAccess(requestParameters.commonAccessItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2025ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2025Api - */ - public getCommonAccess(requestParameters: IAICommonAccessV2025ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2025ApiFp(this.configuration).getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2025Api - */ - public updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2025ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2025ApiFp(this.configuration).updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIOutliersV2025Api - axios parameter creator - * @export - */ -export const IAIOutliersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip: async (type?: ExportOutliersZipTypeV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2025, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2025, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots: async (type?: GetLatestIdentityOutlierSnapshotsTypeV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries/latest`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary: async (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierFeatureId' is not null or undefined - assertParamExists('getOutlierContributingFeatureSummary', 'outlierFeatureId', outlierFeatureId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-feature-summaries/{outlierFeatureId}` - .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('getPeerGroupOutliersContributingFeatures', 'outlierId', outlierId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/contributing-features` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('ignoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/ignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'outlierId', outlierId) - // verify required parameter 'contributingFeatureName' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'contributingFeatureName', contributingFeatureName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) - .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (accessType !== undefined) { - localVarQueryParameter['accessType'] = accessType; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('unIgnoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/unignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIOutliersV2025Api - functional programming interface - * @export - */ -export const IAIOutliersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIOutliersV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportOutliersZip(type?: ExportOutliersZipTypeV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZip(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.exportOutliersZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2025, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshots(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.getIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2025, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliers(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.getIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2025} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLatestIdentityOutlierSnapshots(type?: GetLatestIdentityOutlierSnapshotsTypeV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshots(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.getLatestIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummary(outlierFeatureId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.getOutlierContributingFeatureSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeatures(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.getPeerGroupOutliersContributingFeatures']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async ignoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.ignoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItems(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.listOutliersContributingFeatureAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unIgnoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2025Api.unIgnoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIOutliersV2025Api - factory interface - * @export - */ -export const IAIOutliersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIOutliersV2025ApiFp(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2025ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip(requestParameters: IAIOutliersV2025ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2025ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers(requestParameters: IAIOutliersV2025ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2025ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers(requestParameters: IAIOutliersV2025ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportOutliersZip operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiExportOutliersZipRequest - */ -export interface IAIOutliersV2025ApiExportOutliersZipRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2025ApiExportOutliersZip - */ - readonly type?: ExportOutliersZipTypeV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiExportOutliersZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutlierSnapshots operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest { - /** - * 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 IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - readonly offset?: number - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - readonly type?: GetIdentityOutlierSnapshotsTypeV2025 - - /** - * 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: **snapshotDate**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - 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: **snapshotDate** - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutliers operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiGetIdentityOutliersRequest - */ -export interface IAIOutliersV2025ApiGetIdentityOutliersRequest { - /** - * 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 IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly count?: boolean - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly type?: GetIdentityOutliersTypeV2025 - - /** - * 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - 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: **firstDetectionDate, attributes, score** - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiGetIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getLatestIdentityOutlierSnapshots operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshots - */ - readonly type?: GetLatestIdentityOutlierSnapshotsTypeV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getOutlierContributingFeatureSummary operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest - */ -export interface IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest { - /** - * Contributing feature id - * @type {string} - * @memberof IAIOutliersV2025ApiGetOutlierContributingFeatureSummary - */ - readonly outlierFeatureId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiGetOutlierContributingFeatureSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPeerGroupOutliersContributingFeatures operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest - */ -export interface IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly outlierId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly count?: boolean - - /** - * Whether or not to include translation messages object in returned response - * @type {string} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly includeTranslationMessages?: 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: **importance** - * @type {string} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeatures - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for ignoreIdentityOutliers operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2025ApiIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2025ApiIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOutliersContributingFeatureAccessItems operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest - */ -export interface IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly outlierId: string - - /** - * The name of contributing feature - * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025 - - /** - * 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 IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly count?: boolean - - /** - * The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @type {string} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly accessType?: 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: **displayName** - * @type {string} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiListOutliersContributingFeatureAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for unIgnoreIdentityOutliers operation in IAIOutliersV2025Api. - * @export - * @interface IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2025ApiUnIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2025ApiUnIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIOutliersV2025Api - object-oriented interface - * @export - * @class IAIOutliersV2025Api - * @extends {BaseAPI} - */ -export class IAIOutliersV2025Api extends BaseAPI { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2025ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public exportOutliersZip(requestParameters: IAIOutliersV2025ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2025ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2025ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public getIdentityOutliers(requestParameters: IAIOutliersV2025ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2025ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2025ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2025ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2025ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public ignoreIdentityOutliers(requestParameters: IAIOutliersV2025ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2025ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2025Api - */ - public unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2025ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2025ApiFp(this.configuration).unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ExportOutliersZipTypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type ExportOutliersZipTypeV2025 = typeof ExportOutliersZipTypeV2025[keyof typeof ExportOutliersZipTypeV2025]; -/** - * @export - */ -export const GetIdentityOutlierSnapshotsTypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutlierSnapshotsTypeV2025 = typeof GetIdentityOutlierSnapshotsTypeV2025[keyof typeof GetIdentityOutlierSnapshotsTypeV2025]; -/** - * @export - */ -export const GetIdentityOutliersTypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutliersTypeV2025 = typeof GetIdentityOutliersTypeV2025[keyof typeof GetIdentityOutliersTypeV2025]; -/** - * @export - */ -export const GetLatestIdentityOutlierSnapshotsTypeV2025 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetLatestIdentityOutlierSnapshotsTypeV2025 = typeof GetLatestIdentityOutlierSnapshotsTypeV2025[keyof typeof GetLatestIdentityOutlierSnapshotsTypeV2025]; -/** - * @export - */ -export const ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025 = { - RadicalEntitlementCount: 'radical_entitlement_count', - EntitlementCount: 'entitlement_count', - MaxJaccardSimilarity: 'max_jaccard_similarity', - MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', - SingleEntitlementBundleCount: 'single_entitlement_bundle_count', - PeerlessScore: 'peerless_score' -} as const; -export type ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025 = typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025[keyof typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2025]; - - -/** - * IAIPeerGroupStrategiesV2025Api - axios parameter creator - * @export - */ -export const IAIPeerGroupStrategiesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2025} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers: async (strategy: GetPeerGroupOutliersStrategyV2025, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'strategy' is not null or undefined - assertParamExists('getPeerGroupOutliers', 'strategy', strategy) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/peer-group-strategies/{strategy}/identity-outliers` - .replace(`{${"strategy"}}`, encodeURIComponent(String(strategy))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2025Api - functional programming interface - * @export - */ -export const IAIPeerGroupStrategiesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIPeerGroupStrategiesV2025ApiAxiosParamCreator(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2025} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPeerGroupOutliers(strategy: GetPeerGroupOutliersStrategyV2025, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliers(strategy, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIPeerGroupStrategiesV2025Api.getPeerGroupOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2025Api - factory interface - * @export - */ -export const IAIPeerGroupStrategiesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIPeerGroupStrategiesV2025ApiFp(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPeerGroupOutliers operation in IAIPeerGroupStrategiesV2025Api. - * @export - * @interface IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest - */ -export interface IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest { - /** - * The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @type {'entitlement'} - * @memberof IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliers - */ - readonly strategy: GetPeerGroupOutliersStrategyV2025 - - /** - * 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 IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliers - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIPeerGroupStrategiesV2025Api - object-oriented interface - * @export - * @class IAIPeerGroupStrategiesV2025Api - * @extends {BaseAPI} - */ -export class IAIPeerGroupStrategiesV2025Api extends BaseAPI { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof IAIPeerGroupStrategiesV2025Api - */ - public getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2025ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIPeerGroupStrategiesV2025ApiFp(this.configuration).getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetPeerGroupOutliersStrategyV2025 = { - Entitlement: 'entitlement' -} as const; -export type GetPeerGroupOutliersStrategyV2025 = typeof GetPeerGroupOutliersStrategyV2025[keyof typeof GetPeerGroupOutliersStrategyV2025]; - - -/** - * IAIRecommendationsV2025Api - axios parameter creator - * @export - */ -export const IAIRecommendationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2025} recommendationRequestDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations: async (recommendationRequestDtoV2025: RecommendationRequestDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationRequestDtoV2025' is not null or undefined - assertParamExists('getRecommendations', 'recommendationRequestDtoV2025', recommendationRequestDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/request`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationRequestDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2025} recommendationConfigDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig: async (recommendationConfigDtoV2025: RecommendationConfigDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationConfigDtoV2025' is not null or undefined - assertParamExists('updateRecommendationsConfig', 'recommendationConfigDtoV2025', recommendationConfigDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationConfigDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRecommendationsV2025Api - functional programming interface - * @export - */ -export const IAIRecommendationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRecommendationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2025} recommendationRequestDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendations(recommendationRequestDtoV2025: RecommendationRequestDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendations(recommendationRequestDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2025Api.getRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2025Api.getRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2025} recommendationConfigDtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRecommendationsConfig(recommendationConfigDtoV2025: RecommendationConfigDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRecommendationsConfig(recommendationConfigDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2025Api.updateRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRecommendationsV2025Api - factory interface - * @export - */ -export const IAIRecommendationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRecommendationsV2025ApiFp(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2025ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations(requestParameters: IAIRecommendationsV2025ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendations(requestParameters.recommendationRequestDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2025ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig(requestParameters: IAIRecommendationsV2025ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig(requestParameters: IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getRecommendations operation in IAIRecommendationsV2025Api. - * @export - * @interface IAIRecommendationsV2025ApiGetRecommendationsRequest - */ -export interface IAIRecommendationsV2025ApiGetRecommendationsRequest { - /** - * - * @type {RecommendationRequestDtoV2025} - * @memberof IAIRecommendationsV2025ApiGetRecommendations - */ - readonly recommendationRequestDtoV2025: RecommendationRequestDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2025ApiGetRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRecommendationsConfig operation in IAIRecommendationsV2025Api. - * @export - * @interface IAIRecommendationsV2025ApiGetRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2025ApiGetRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2025ApiGetRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateRecommendationsConfig operation in IAIRecommendationsV2025Api. - * @export - * @interface IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest { - /** - * - * @type {RecommendationConfigDtoV2025} - * @memberof IAIRecommendationsV2025ApiUpdateRecommendationsConfig - */ - readonly recommendationConfigDtoV2025: RecommendationConfigDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2025ApiUpdateRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRecommendationsV2025Api - object-oriented interface - * @export - * @class IAIRecommendationsV2025Api - * @extends {BaseAPI} - */ -export class IAIRecommendationsV2025Api extends BaseAPI { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2025ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2025Api - */ - public getRecommendations(requestParameters: IAIRecommendationsV2025ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2025ApiFp(this.configuration).getRecommendations(requestParameters.recommendationRequestDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2025ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2025Api - */ - public getRecommendationsConfig(requestParameters: IAIRecommendationsV2025ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2025ApiFp(this.configuration).getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2025Api - */ - public updateRecommendationsConfig(requestParameters: IAIRecommendationsV2025ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2025ApiFp(this.configuration).updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIRoleMiningV2025Api - axios parameter creator - * @export - */ -export const IAIRoleMiningV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2025} [roleMiningPotentialRoleProvisionRequestV2025] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest: async (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2025?: RoleMiningPotentialRoleProvisionRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (minEntitlementPopularity !== undefined) { - localVarQueryParameter['min-entitlement-popularity'] = minEntitlementPopularity; - } - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['include-common-access'] = includeCommonAccess; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleProvisionRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2025} roleMiningSessionDtoV2025 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions: async (roleMiningSessionDtoV2025: RoleMiningSessionDtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMiningSessionDtoV2025' is not null or undefined - assertParamExists('createRoleMiningSessions', 'roleMiningSessionDtoV2025', roleMiningSessionDtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningSessionDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2025} [roleMiningPotentialRoleExportRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2025?: RoleMiningPotentialRoleExportRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleExportRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries: async (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage: async (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'potentialRoleId', potentialRoleId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'sourceId', sourceId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries: async (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleSummaries', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole: async (potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSession', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSessionStatus', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/status` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions: async (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles: async (sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/saved`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2025' is not null or undefined - assertParamExists('patchPotentialRole', 'jsonPatchOperationRoleMiningV2025', jsonPatchOperationRoleMiningV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2025' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'jsonPatchOperationRoleMiningV2025', jsonPatchOperationRoleMiningV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2025 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession: async (sessionId: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchRoleMiningSession', 'sessionId', sessionId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchRoleMiningSession', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2025} roleMiningPotentialRoleEditEntitlementsV2025 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2025: RoleMiningPotentialRoleEditEntitlementsV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'roleMiningPotentialRoleEditEntitlementsV2025' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'roleMiningPotentialRoleEditEntitlementsV2025', roleMiningPotentialRoleEditEntitlementsV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleEditEntitlementsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRoleMiningV2025Api - functional programming interface - * @export - */ -export const IAIRoleMiningV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRoleMiningV2025ApiAxiosParamCreator(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2025} [roleMiningPotentialRoleProvisionRequestV2025] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPotentialRoleProvisionRequest(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2025?: RoleMiningPotentialRoleProvisionRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPotentialRoleProvisionRequest(sessionId, potentialRoleId, minEntitlementPopularity, includeCommonAccess, xSailPointExperimental, roleMiningPotentialRoleProvisionRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.createPotentialRoleProvisionRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2025} roleMiningSessionDtoV2025 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRoleMiningSessions(roleMiningSessionDtoV2025: RoleMiningSessionDtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMiningSessions(roleMiningSessionDtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.createRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleMiningPotentialRoleZip(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleMiningPotentialRoleZip(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.downloadRoleMiningPotentialRoleZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.exportRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2025} [roleMiningPotentialRoleExportRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleAsync(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2025?: RoleMiningPotentialRoleExportRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleAsync(sessionId, potentialRoleId, xSailPointExperimental, roleMiningPotentialRoleExportRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.exportRoleMiningPotentialRoleAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleStatus(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleStatus(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.exportRoleMiningPotentialRoleStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAllPotentialRoleSummaries(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPotentialRoleSummaries(sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getAllPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDistributionPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDistributionPotentialRole(sessionId, potentialRoleId, includeCommonAccess, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getEntitlementDistributionPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsPotentialRole(sessionId, potentialRoleId, includeCommonAccess, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getExcludedEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getExcludedEntitlementsPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getExcludedEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitiesPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getIdentitiesPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleApplications(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleApplications(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getPotentialRoleApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleEntitlements(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleEntitlements(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getPotentialRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSourceIdentityUsage(potentialRoleId, sourceId, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getPotentialRoleSourceIdentityUsage']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSummaries(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSummaries(sessionId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningPotentialRole(potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningPotentialRole(potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSession(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSession(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessionStatus(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionStatus(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getRoleMiningSessionStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessions(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessions(filters, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedPotentialRoles(sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.getSavedPotentialRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRole(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRole(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.patchPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleSession(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.patchPotentialRoleSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2025 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRoleMiningSession(sessionId: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningSession(sessionId, jsonPatchOperationV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.patchRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2025} roleMiningPotentialRoleEditEntitlementsV2025 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2025: RoleMiningPotentialRoleEditEntitlementsV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsPotentialRole(sessionId, potentialRoleId, roleMiningPotentialRoleEditEntitlementsV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2025Api.updateEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRoleMiningV2025Api - factory interface - * @export - */ -export const IAIRoleMiningV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRoleMiningV2025ApiFp(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions(requestParameters: IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }> { - return localVarFp.getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2025ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles(requestParameters: IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2025ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole(requestParameters: IAIRoleMiningV2025ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession(requestParameters: IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession(requestParameters: IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPotentialRoleProvisionRequest operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest - */ -export interface IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly potentialRoleId: string - - /** - * Minimum popularity required for an entitlement to be included in the provisioned role. - * @type {number} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly minEntitlementPopularity?: number - - /** - * Boolean determining whether common access entitlements will be included in the provisioned role. - * @type {boolean} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly xSailPointExperimental?: string - - /** - * Required information to create a new role - * @type {RoleMiningPotentialRoleProvisionRequestV2025} - * @memberof IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequest - */ - readonly roleMiningPotentialRoleProvisionRequestV2025?: RoleMiningPotentialRoleProvisionRequestV2025 -} - -/** - * Request parameters for createRoleMiningSessions operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest { - /** - * Role mining session parameters - * @type {RoleMiningSessionDtoV2025} - * @memberof IAIRoleMiningV2025ApiCreateRoleMiningSessions - */ - readonly roleMiningSessionDtoV2025: RoleMiningSessionDtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiCreateRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleMiningPotentialRoleZip operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest - */ -export interface IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZip - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZip - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZip - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRoleAsync operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest - */ -export interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsync - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsync - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsync - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {RoleMiningPotentialRoleExportRequestV2025} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsync - */ - readonly roleMiningPotentialRoleExportRequestV2025?: RoleMiningPotentialRoleExportRequestV2025 -} - -/** - * Request parameters for exportRoleMiningPotentialRoleStatus operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest - */ -export interface IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatus - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatus - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatus - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAllPotentialRoleSummaries operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest { - /** - * 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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetAllPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementDistributionPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementsPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getExcludedEntitlementsPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly potentialRoleId: 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: **popularity** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitiesPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly potentialRoleId: 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: **name** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetIdentitiesPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleApplications operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest - */ -export interface IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - readonly potentialRoleId: 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: **applicationName**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleApplications - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleEntitlements operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest - */ -export interface IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - readonly potentialRoleId: 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: **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSourceIdentityUsage operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest - */ -export interface IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - readonly potentialRoleId: string - - /** - * A source id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sourceId: string - - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsage - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSummaries operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - readonly sessionId: 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: **createdDate** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSession operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2025ApiGetRoleMiningSessionRequest { - /** - * The role mining session id to be retrieved. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSession - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessionStatus operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest - */ -export interface IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSessionStatus - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSessionStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessions operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest { - /** - * 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: **saved**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - 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: **createdBy, createdDate** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSavedPotentialRoles operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest - */ -export interface IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest { - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetSavedPotentialRoles - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2025ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2025ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2025ApiGetSavedPotentialRoles - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiGetSavedPotentialRoles - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiPatchPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiPatchPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRole - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRole - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRole - */ - readonly jsonPatchOperationRoleMiningV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRoleSession operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest - */ -export interface IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRoleSession - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRoleSession - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRoleSession - */ - readonly jsonPatchOperationRoleMiningV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchPotentialRoleSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchRoleMiningSession operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest { - /** - * The role mining session id to be patched - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchRoleMiningSession - */ - readonly sessionId: string - - /** - * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @type {Array} - * @memberof IAIRoleMiningV2025ApiPatchRoleMiningSession - */ - readonly jsonPatchOperationV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiPatchRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateEntitlementsPotentialRole operation in IAIRoleMiningV2025Api. - * @export - * @interface IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Role mining session parameters - * @type {RoleMiningPotentialRoleEditEntitlementsV2025} - * @memberof IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRole - */ - readonly roleMiningPotentialRoleEditEntitlementsV2025: RoleMiningPotentialRoleEditEntitlementsV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRoleMiningV2025Api - object-oriented interface - * @export - * @class IAIRoleMiningV2025Api - * @extends {BaseAPI} - */ -export class IAIRoleMiningV2025Api extends BaseAPI { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2025ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public createRoleMiningSessions(requestParameters: IAIRoleMiningV2025ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2025ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2025ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2025ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2025ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getPotentialRoleApplications(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2025ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getRoleMiningSession(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getRoleMiningSessions(requestParameters: IAIRoleMiningV2025ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public getSavedPotentialRoles(requestParameters: IAIRoleMiningV2025ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2025ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public patchPotentialRole(requestParameters: IAIRoleMiningV2025ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public patchPotentialRoleSession(requestParameters: IAIRoleMiningV2025ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public patchRoleMiningSession(requestParameters: IAIRoleMiningV2025ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2025Api - */ - public updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2025ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2025ApiFp(this.configuration).updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IconsV2025Api - axios parameter creator - * @export - */ -export const IconsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2025} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon: async (objectType: DeleteIconObjectTypeV2025, objectId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('deleteIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('deleteIcon', 'objectId', objectId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2025} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon: async (objectType: SetIconObjectTypeV2025, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('setIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('setIcon', 'objectId', objectId) - // verify required parameter 'image' is not null or undefined - assertParamExists('setIcon', 'image', image) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (image !== undefined) { - localVarFormParams.append('image', image as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IconsV2025Api - functional programming interface - * @export - */ -export const IconsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IconsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2025} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIcon(objectType: DeleteIconObjectTypeV2025, objectId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIcon(objectType, objectId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2025Api.deleteIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2025} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setIcon(objectType: SetIconObjectTypeV2025, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setIcon(objectType, objectId, image, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2025Api.setIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IconsV2025Api - factory interface - * @export - */ -export const IconsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IconsV2025ApiFp(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2025ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon(requestParameters: IconsV2025ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2025ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon(requestParameters: IconsV2025ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIcon operation in IconsV2025Api. - * @export - * @interface IconsV2025ApiDeleteIconRequest - */ -export interface IconsV2025ApiDeleteIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2025ApiDeleteIcon - */ - readonly objectType: DeleteIconObjectTypeV2025 - - /** - * Object id. - * @type {string} - * @memberof IconsV2025ApiDeleteIcon - */ - readonly objectId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2025ApiDeleteIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setIcon operation in IconsV2025Api. - * @export - * @interface IconsV2025ApiSetIconRequest - */ -export interface IconsV2025ApiSetIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2025ApiSetIcon - */ - readonly objectType: SetIconObjectTypeV2025 - - /** - * Object id. - * @type {string} - * @memberof IconsV2025ApiSetIcon - */ - readonly objectId: string - - /** - * file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @type {File} - * @memberof IconsV2025ApiSetIcon - */ - readonly image: File - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2025ApiSetIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * IconsV2025Api - object-oriented interface - * @export - * @class IconsV2025Api - * @extends {BaseAPI} - */ -export class IconsV2025Api extends BaseAPI { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2025ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2025Api - */ - public deleteIcon(requestParameters: IconsV2025ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2025ApiFp(this.configuration).deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2025ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2025Api - */ - public setIcon(requestParameters: IconsV2025ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2025ApiFp(this.configuration).setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteIconObjectTypeV2025 = { - Application: 'application' -} as const; -export type DeleteIconObjectTypeV2025 = typeof DeleteIconObjectTypeV2025[keyof typeof DeleteIconObjectTypeV2025]; -/** - * @export - */ -export const SetIconObjectTypeV2025 = { - Application: 'application' -} as const; -export type SetIconObjectTypeV2025 = typeof SetIconObjectTypeV2025[keyof typeof SetIconObjectTypeV2025]; - - -/** - * IdentitiesV2025Api - axios parameter creator - * @export - */ -export const IdentitiesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getIdentityOwnershipDetails', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/ownership` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignment', 'identityId', identityId) - // verify required parameter 'assignmentId' is not null or undefined - assertParamExists('getRoleAssignment', 'assignmentId', assignmentId) - const localVarPath = `/identities/{identityId}/role-assignments/{assignmentId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignments', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/role-assignments` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (roleId !== undefined) { - localVarQueryParameter['roleId'] = roleId; - } - - if (roleName !== undefined) { - localVarQueryParameter['roleName'] = roleName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementsByIdentity', 'id', id) - const localVarPath = `/entitlements/identities/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2025} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2025, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (defaultFilter !== undefined) { - localVarQueryParameter['defaultFilter'] = defaultFilter; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('resetIdentity', 'identityId', identityId) - const localVarPath = `/identities/{id}/reset` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2025} sendAccountVerificationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken: async (id: string, sendAccountVerificationRequestV2025: SendAccountVerificationRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'id', id) - // verify required parameter 'sendAccountVerificationRequestV2025' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'sendAccountVerificationRequestV2025', sendAccountVerificationRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{id}/verification/account/send` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendAccountVerificationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2025} inviteIdentitiesRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite: async (inviteIdentitiesRequestV2025: InviteIdentitiesRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'inviteIdentitiesRequestV2025' is not null or undefined - assertParamExists('startIdentitiesInvite', 'inviteIdentitiesRequestV2025', inviteIdentitiesRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/invite`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(inviteIdentitiesRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2025} processIdentitiesRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing: async (processIdentitiesRequestV2025: ProcessIdentitiesRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'processIdentitiesRequestV2025' is not null or undefined - assertParamExists('startIdentityProcessing', 'processIdentitiesRequestV2025', processIdentitiesRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/process`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(processIdentitiesRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('synchronizeAttributesForIdentity', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{identityId}/synchronize-attributes` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentitiesV2025Api - functional programming interface - * @export - */ -export const IdentitiesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentitiesV2025ApiAxiosParamCreator(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.deleteIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.getIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOwnershipDetails(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetails(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.getIdentityOwnershipDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignment(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignment(identityId, assignmentId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.getRoleAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignments(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignments(identityId, roleId, roleName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.getRoleAssignments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementsByIdentity(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByIdentity(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.listEntitlementsByIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2025} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentities(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2025, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentities(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.listIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetIdentity(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentity(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.resetIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2025} sendAccountVerificationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestV2025: SendAccountVerificationRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountToken(id, sendAccountVerificationRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.sendIdentityVerificationAccountToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2025} inviteIdentitiesRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentitiesInvite(inviteIdentitiesRequestV2025: InviteIdentitiesRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInvite(inviteIdentitiesRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.startIdentitiesInvite']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2025} processIdentitiesRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentityProcessing(processIdentitiesRequestV2025: ProcessIdentitiesRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessing(processIdentitiesRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.startIdentityProcessing']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async synchronizeAttributesForIdentity(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentity(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2025Api.synchronizeAttributesForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentitiesV2025Api - factory interface - * @export - */ -export const IdentitiesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentitiesV2025ApiFp(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2025ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity(requestParameters: IdentitiesV2025ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2025ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity(requestParameters: IdentitiesV2025ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails(requestParameters: IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Role assignment details - * @param {IdentitiesV2025ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment(requestParameters: IdentitiesV2025ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2025ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments(requestParameters: IdentitiesV2025ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2025ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity(requestParameters: IdentitiesV2025ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2025ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities(requestParameters: IdentitiesV2025ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2025ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity(requestParameters: IdentitiesV2025ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2025ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite(requestParameters: IdentitiesV2025ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2025ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing(requestParameters: IdentitiesV2025ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentityProcessing(requestParameters.processIdentitiesRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity(requestParameters: IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIdentity operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiDeleteIdentityRequest - */ -export interface IdentitiesV2025ApiDeleteIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2025ApiDeleteIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2025ApiDeleteIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentity operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiGetIdentityRequest - */ -export interface IdentitiesV2025ApiGetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2025ApiGetIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentityOwnershipDetails operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest - */ -export interface IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest { - /** - * Identity ID. - * @type {string} - * @memberof IdentitiesV2025ApiGetIdentityOwnershipDetails - */ - readonly identityId: string -} - -/** - * Request parameters for getRoleAssignment operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiGetRoleAssignmentRequest - */ -export interface IdentitiesV2025ApiGetRoleAssignmentRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2025ApiGetRoleAssignment - */ - readonly identityId: string - - /** - * Assignment Id - * @type {string} - * @memberof IdentitiesV2025ApiGetRoleAssignment - */ - readonly assignmentId: string -} - -/** - * Request parameters for getRoleAssignments operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiGetRoleAssignmentsRequest - */ -export interface IdentitiesV2025ApiGetRoleAssignmentsRequest { - /** - * Identity Id to get the role assignments for - * @type {string} - * @memberof IdentitiesV2025ApiGetRoleAssignments - */ - readonly identityId: string - - /** - * Role Id to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2025ApiGetRoleAssignments - */ - readonly roleId?: string - - /** - * Role name to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2025ApiGetRoleAssignments - */ - readonly roleName?: string -} - -/** - * Request parameters for listEntitlementsByIdentity operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiListEntitlementsByIdentityRequest - */ -export interface IdentitiesV2025ApiListEntitlementsByIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2025ApiListEntitlementsByIdentity - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2025ApiListEntitlementsByIdentity - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2025ApiListEntitlementsByIdentity - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentitiesV2025ApiListEntitlementsByIdentity - */ - readonly count?: boolean -} - -/** - * Request parameters for listIdentities operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiListIdentitiesRequest - */ -export interface IdentitiesV2025ApiListIdentitiesRequest { - /** - * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @type {string} - * @memberof IdentitiesV2025ApiListIdentities - */ - 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: **name, alias, cloudStatus** - * @type {string} - * @memberof IdentitiesV2025ApiListIdentities - */ - readonly sorters?: string - - /** - * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @type {'CORRELATED_ONLY' | 'NONE'} - * @memberof IdentitiesV2025ApiListIdentities - */ - readonly defaultFilter?: ListIdentitiesDefaultFilterV2025 - - /** - * 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 IdentitiesV2025ApiListIdentities - */ - readonly count?: boolean - - /** - * 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 IdentitiesV2025ApiListIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2025ApiListIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for resetIdentity operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiResetIdentityRequest - */ -export interface IdentitiesV2025ApiResetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2025ApiResetIdentity - */ - readonly identityId: string -} - -/** - * Request parameters for sendIdentityVerificationAccountToken operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest - */ -export interface IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest { - /** - * Identity ID - * @type {string} - * @memberof IdentitiesV2025ApiSendIdentityVerificationAccountToken - */ - readonly id: string - - /** - * - * @type {SendAccountVerificationRequestV2025} - * @memberof IdentitiesV2025ApiSendIdentityVerificationAccountToken - */ - readonly sendAccountVerificationRequestV2025: SendAccountVerificationRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2025ApiSendIdentityVerificationAccountToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentitiesInvite operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiStartIdentitiesInviteRequest - */ -export interface IdentitiesV2025ApiStartIdentitiesInviteRequest { - /** - * - * @type {InviteIdentitiesRequestV2025} - * @memberof IdentitiesV2025ApiStartIdentitiesInvite - */ - readonly inviteIdentitiesRequestV2025: InviteIdentitiesRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2025ApiStartIdentitiesInvite - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentityProcessing operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiStartIdentityProcessingRequest - */ -export interface IdentitiesV2025ApiStartIdentityProcessingRequest { - /** - * - * @type {ProcessIdentitiesRequestV2025} - * @memberof IdentitiesV2025ApiStartIdentityProcessing - */ - readonly processIdentitiesRequestV2025: ProcessIdentitiesRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2025ApiStartIdentityProcessing - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for synchronizeAttributesForIdentity operation in IdentitiesV2025Api. - * @export - * @interface IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest - */ -export interface IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest { - /** - * The Identity id - * @type {string} - * @memberof IdentitiesV2025ApiSynchronizeAttributesForIdentity - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2025ApiSynchronizeAttributesForIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentitiesV2025Api - object-oriented interface - * @export - * @class IdentitiesV2025Api - * @extends {BaseAPI} - */ -export class IdentitiesV2025Api extends BaseAPI { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2025ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public deleteIdentity(requestParameters: IdentitiesV2025ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).deleteIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2025ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public getIdentity(requestParameters: IdentitiesV2025ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).getIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public getIdentityOwnershipDetails(requestParameters: IdentitiesV2025ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Role assignment details - * @param {IdentitiesV2025ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public getRoleAssignment(requestParameters: IdentitiesV2025ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2025ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public getRoleAssignments(requestParameters: IdentitiesV2025ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2025ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public listEntitlementsByIdentity(requestParameters: IdentitiesV2025ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2025ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public listIdentities(requestParameters: IdentitiesV2025ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2025ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public resetIdentity(requestParameters: IdentitiesV2025ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2025ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2025ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public startIdentitiesInvite(requestParameters: IdentitiesV2025ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2025ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public startIdentityProcessing(requestParameters: IdentitiesV2025ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).startIdentityProcessing(requestParameters.processIdentitiesRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2025Api - */ - public synchronizeAttributesForIdentity(requestParameters: IdentitiesV2025ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2025ApiFp(this.configuration).synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListIdentitiesDefaultFilterV2025 = { - CorrelatedOnly: 'CORRELATED_ONLY', - None: 'NONE' -} as const; -export type ListIdentitiesDefaultFilterV2025 = typeof ListIdentitiesDefaultFilterV2025[keyof typeof ListIdentitiesDefaultFilterV2025]; - - -/** - * IdentityAttributesV2025Api - axios parameter creator - * @export - */ -export const IdentityAttributesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2025} identityAttributeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute: async (identityAttributeV2025: IdentityAttributeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeV2025' is not null or undefined - assertParamExists('createIdentityAttribute', 'identityAttributeV2025', identityAttributeV2025) - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2025} identityAttributeNamesV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk: async (identityAttributeNamesV2025: IdentityAttributeNamesV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeNamesV2025' is not null or undefined - assertParamExists('deleteIdentityAttributesInBulk', 'identityAttributeNamesV2025', identityAttributeNamesV2025) - const localVarPath = `/identity-attributes/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeNamesV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes: async (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeSystem !== undefined) { - localVarQueryParameter['includeSystem'] = includeSystem; - } - - if (includeSilent !== undefined) { - localVarQueryParameter['includeSilent'] = includeSilent; - } - - if (searchableOnly !== undefined) { - localVarQueryParameter['searchableOnly'] = searchableOnly; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2025} identityAttributeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute: async (name: string, identityAttributeV2025: IdentityAttributeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('putIdentityAttribute', 'name', name) - // verify required parameter 'identityAttributeV2025' is not null or undefined - assertParamExists('putIdentityAttribute', 'identityAttributeV2025', identityAttributeV2025) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityAttributesV2025Api - functional programming interface - * @export - */ -export const IdentityAttributesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityAttributesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2025} identityAttributeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityAttribute(identityAttributeV2025: IdentityAttributeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityAttribute(identityAttributeV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.createIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.deleteIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2025} identityAttributeNamesV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttributesInBulk(identityAttributeNamesV2025: IdentityAttributeNamesV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributesInBulk(identityAttributeNamesV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.deleteIdentityAttributesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.getIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAttributes(includeSystem, includeSilent, searchableOnly, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.listIdentityAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2025} identityAttributeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putIdentityAttribute(name: string, identityAttributeV2025: IdentityAttributeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityAttribute(name, identityAttributeV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2025Api.putIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityAttributesV2025Api - factory interface - * @export - */ -export const IdentityAttributesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityAttributesV2025ApiFp(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2025ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute(requestParameters: IdentityAttributesV2025ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityAttribute(requestParameters.identityAttributeV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2025ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute(requestParameters: IdentityAttributesV2025ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2025ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute(requestParameters: IdentityAttributesV2025ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2025ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes(requestParameters: IdentityAttributesV2025ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2025ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute(requestParameters: IdentityAttributesV2025ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityAttribute operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiCreateIdentityAttributeRequest - */ -export interface IdentityAttributesV2025ApiCreateIdentityAttributeRequest { - /** - * - * @type {IdentityAttributeV2025} - * @memberof IdentityAttributesV2025ApiCreateIdentityAttribute - */ - readonly identityAttributeV2025: IdentityAttributeV2025 -} - -/** - * Request parameters for deleteIdentityAttribute operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiDeleteIdentityAttributeRequest - */ -export interface IdentityAttributesV2025ApiDeleteIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2025ApiDeleteIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for deleteIdentityAttributesInBulk operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest - */ -export interface IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest { - /** - * - * @type {IdentityAttributeNamesV2025} - * @memberof IdentityAttributesV2025ApiDeleteIdentityAttributesInBulk - */ - readonly identityAttributeNamesV2025: IdentityAttributeNamesV2025 -} - -/** - * Request parameters for getIdentityAttribute operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiGetIdentityAttributeRequest - */ -export interface IdentityAttributesV2025ApiGetIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2025ApiGetIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for listIdentityAttributes operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiListIdentityAttributesRequest - */ -export interface IdentityAttributesV2025ApiListIdentityAttributesRequest { - /** - * Include \'system\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2025ApiListIdentityAttributes - */ - readonly includeSystem?: boolean - - /** - * Include \'silent\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2025ApiListIdentityAttributes - */ - readonly includeSilent?: boolean - - /** - * Include only \'searchable\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2025ApiListIdentityAttributes - */ - readonly searchableOnly?: boolean - - /** - * 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 IdentityAttributesV2025ApiListIdentityAttributes - */ - readonly count?: boolean -} - -/** - * Request parameters for putIdentityAttribute operation in IdentityAttributesV2025Api. - * @export - * @interface IdentityAttributesV2025ApiPutIdentityAttributeRequest - */ -export interface IdentityAttributesV2025ApiPutIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2025ApiPutIdentityAttribute - */ - readonly name: string - - /** - * - * @type {IdentityAttributeV2025} - * @memberof IdentityAttributesV2025ApiPutIdentityAttribute - */ - readonly identityAttributeV2025: IdentityAttributeV2025 -} - -/** - * IdentityAttributesV2025Api - object-oriented interface - * @export - * @class IdentityAttributesV2025Api - * @extends {BaseAPI} - */ -export class IdentityAttributesV2025Api extends BaseAPI { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2025ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public createIdentityAttribute(requestParameters: IdentityAttributesV2025ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).createIdentityAttribute(requestParameters.identityAttributeV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2025ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public deleteIdentityAttribute(requestParameters: IdentityAttributesV2025ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2025ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2025ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public getIdentityAttribute(requestParameters: IdentityAttributesV2025ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2025ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public listIdentityAttributes(requestParameters: IdentityAttributesV2025ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2025ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2025Api - */ - public putIdentityAttribute(requestParameters: IdentityAttributesV2025ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2025ApiFp(this.configuration).putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IdentityHistoryV2025Api - axios parameter creator - * @export - */ -export const IdentityHistoryV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2025} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2025, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'id', id) - // verify required parameter 'accessType' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'accessType', accessType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare/{access-type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accessAssociated !== undefined) { - localVarQueryParameter['access-associated'] = accessAssociated; - } - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentityEvents', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/events` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (from !== undefined) { - localVarQueryParameter['from'] = from; - } - - if (eventTypes) { - localVarQueryParameter['eventTypes'] = eventTypes.join(COLLECTION_FORMATS.csv); - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot: async (id: string, date: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshot', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('getIdentitySnapshot', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2025} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2025, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshotSummary', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshot-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (before !== undefined) { - localVarQueryParameter['before'] = before; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (timeZone !== undefined) { - localVarQueryParameter['time-zone'] = timeZone; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityStartDate', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/start-date` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (startsWithQuery !== undefined) { - localVarQueryParameter['starts-with-query'] = startsWithQuery; - } - - if (isDeleted !== undefined) { - localVarQueryParameter['is-deleted'] = isDeleted; - } - - if (isActive !== undefined) { - localVarQueryParameter['is-active'] = isActive; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2025} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems: async (id: string, type?: ListIdentityAccessItemsTypeV2025, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessItems', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/access-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems: async (id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}/access-items` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2025} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots: async (id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2025, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityHistoryV2025Api - functional programming interface - * @export - */ -export const IdentityHistoryV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityHistoryV2025ApiAxiosParamCreator(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshots(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshots(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.compareIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2025} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshotsAccessType(id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2025, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessType(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.compareIdentitySnapshotsAccessType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.getHistoricalIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentityEvents(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEvents(id, from, eventTypes, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.getHistoricalIdentityEvents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshot(id: string, date: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshot(id, date, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.getIdentitySnapshot']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2025} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshotSummary(id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2025, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummary(id, before, interval, timeZone, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.getIdentitySnapshotSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityStartDate(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDate(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.getIdentityStartDate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentities(startsWithQuery, isDeleted, isActive, limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.listHistoricalIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2025} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessItems(id: string, type?: ListIdentityAccessItemsTypeV2025, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, xSailPointExperimental, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.listIdentityAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshotAccessItems(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItems(id, date, type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.listIdentitySnapshotAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2025} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshots(id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2025, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshots(id, start, interval, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2025Api.listIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityHistoryV2025Api - factory interface - * @export - */ -export const IdentityHistoryV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityHistoryV2025ApiFp(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots(requestParameters: IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2025ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity(requestParameters: IdentityHistoryV2025ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2025ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot(requestParameters: IdentityHistoryV2025ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2025ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate(requestParameters: IdentityHistoryV2025ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2025ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities(requestParameters: IdentityHistoryV2025ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2025ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems(requestParameters: IdentityHistoryV2025ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2025ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots(requestParameters: IdentityHistoryV2025ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for compareIdentitySnapshots operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly id: string - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly snapshot2?: string - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for compareIdentitySnapshotsAccessType operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest - */ -export interface IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly id: string - - /** - * The specific type which needs to be compared - * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2025 - - /** - * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @type {boolean} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly accessAssociated?: boolean - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot2?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessType - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentity operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiGetHistoricalIdentityRequest - */ -export interface IdentityHistoryV2025ApiGetHistoricalIdentityRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentityEvents operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest - */ -export interface IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly id: string - - /** - * The optional instant until which access events are returned - * @type {string} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly from?: string - - /** - * An optional list of event types to return. If null or empty, all events are returned - * @type {Array} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly eventTypes?: Array - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiGetHistoricalIdentityEvents - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshot operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiGetIdentitySnapshotRequest - */ -export interface IdentityHistoryV2025ApiGetIdentitySnapshotRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshot - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshot - */ - readonly date: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshot - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshotSummary operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest - */ -export interface IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly id: string - - /** - * The date before which snapshot summary is required - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly before?: string - - /** - * The interval indicating day or month. Defaults to month if not specified - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly interval?: GetIdentitySnapshotSummaryIntervalV2025 - - /** - * The time zone. Defaults to UTC if not provided - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly timeZone?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentitySnapshotSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityStartDate operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiGetIdentityStartDateRequest - */ -export interface IdentityHistoryV2025ApiGetIdentityStartDateRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentityStartDate - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiGetIdentityStartDate - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listHistoricalIdentities operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiListHistoricalIdentitiesRequest - */ -export interface IdentityHistoryV2025ApiListHistoricalIdentitiesRequest { - /** - * This param is used for starts-with search for first, last and display name of the identity - * @type {string} - * @memberof IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly startsWithQuery?: string - - /** - * Indicates if we want to only list down deleted identities or not. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly isDeleted?: boolean - - /** - * Indicates if we want to only list active or inactive identities. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly isActive?: boolean - - /** - * 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 IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiListHistoricalIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentityAccessItems operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiListIdentityAccessItemsRequest - */ -export interface IdentityHistoryV2025ApiListIdentityAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentityAccessItems - */ - readonly id: string - - /** - * The type of access item for the identity. If not provided, it defaults to account - * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} - * @memberof IdentityHistoryV2025ApiListIdentityAccessItems - */ - readonly type?: ListIdentityAccessItemsTypeV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentityAccessItems - */ - readonly xSailPointExperimental?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiListIdentityAccessItems - */ - 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 IdentityHistoryV2025ApiListIdentityAccessItems - */ - readonly count?: boolean - - /** - * 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 IdentityHistoryV2025ApiListIdentityAccessItems - */ - readonly offset?: number -} - -/** - * Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest - */ -export interface IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshotAccessItems - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshotAccessItems - */ - readonly date: string - - /** - * The access item type - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshotAccessItems - */ - readonly type?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshotAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentitySnapshots operation in IdentityHistoryV2025Api. - * @export - * @interface IdentityHistoryV2025ApiListIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2025ApiListIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly id: string - - /** - * The specified start date - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly start?: string - - /** - * The interval indicating the range in day or month for the specified interval-name - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly interval?: ListIdentitySnapshotsIntervalV2025 - - /** - * 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 IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2025ApiListIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentityHistoryV2025Api - object-oriented interface - * @export - * @class IdentityHistoryV2025Api - * @extends {BaseAPI} - */ -export class IdentityHistoryV2025Api extends BaseAPI { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public compareIdentitySnapshots(requestParameters: IdentityHistoryV2025ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2025ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2025ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public getHistoricalIdentity(requestParameters: IdentityHistoryV2025ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2025ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2025ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public getIdentitySnapshot(requestParameters: IdentityHistoryV2025ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2025ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2025ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public getIdentityStartDate(requestParameters: IdentityHistoryV2025ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2025ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public listHistoricalIdentities(requestParameters: IdentityHistoryV2025ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2025ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public listIdentityAccessItems(requestParameters: IdentityHistoryV2025ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2025ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2025ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2025Api - */ - public listIdentitySnapshots(requestParameters: IdentityHistoryV2025ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2025ApiFp(this.configuration).listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const CompareIdentitySnapshotsAccessTypeAccessTypeV2025 = { - AccessProfile: 'accessProfile', - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role' -} as const; -export type CompareIdentitySnapshotsAccessTypeAccessTypeV2025 = typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2025[keyof typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2025]; -/** - * @export - */ -export const GetIdentitySnapshotSummaryIntervalV2025 = { - Day: 'day', - Month: 'month' -} as const; -export type GetIdentitySnapshotSummaryIntervalV2025 = typeof GetIdentitySnapshotSummaryIntervalV2025[keyof typeof GetIdentitySnapshotSummaryIntervalV2025]; -/** - * @export - */ -export const ListIdentityAccessItemsTypeV2025 = { - Account: 'account', - Entitlement: 'entitlement', - App: 'app', - AccessProfile: 'accessProfile', - Role: 'role' -} as const; -export type ListIdentityAccessItemsTypeV2025 = typeof ListIdentityAccessItemsTypeV2025[keyof typeof ListIdentityAccessItemsTypeV2025]; -/** - * @export - */ -export const ListIdentitySnapshotsIntervalV2025 = { - Day: 'day', - Month: 'month' -} as const; -export type ListIdentitySnapshotsIntervalV2025 = typeof ListIdentitySnapshotsIntervalV2025[keyof typeof ListIdentitySnapshotsIntervalV2025]; - - -/** - * IdentityProfilesV2025Api - axios parameter creator - * @export - */ -export const IdentityProfilesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2025} identityProfileV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile: async (identityProfileV2025: IdentityProfileV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileV2025' is not null or undefined - assertParamExists('createIdentityProfile', 'identityProfileV2025', identityProfileV2025) - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteIdentityProfiles', 'requestBody', requestBody) - const localVarPath = `/identity-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2025} identityPreviewRequestV2025 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview: async (identityPreviewRequestV2025: IdentityPreviewRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityPreviewRequestV2025' is not null or undefined - assertParamExists('generateIdentityPreview', 'identityPreviewRequestV2025', identityPreviewRequestV2025) - const localVarPath = `/identity-profiles/identity-preview`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2025 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles: async (identityProfileExportedObjectV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileExportedObjectV2025' is not null or undefined - assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectV2025', identityProfileExportedObjectV2025) - const localVarPath = `/identity-profiles/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('syncIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/process-identities` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2025 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile: async (identityProfileId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateIdentityProfile', 'identityProfileId', identityProfileId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateIdentityProfile', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityProfilesV2025Api - functional programming interface - * @export - */ -export const IdentityProfilesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityProfilesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2025} identityProfileV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityProfile(identityProfileV2025: IdentityProfileV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfile(identityProfileV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.createIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.deleteIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfiles(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfiles(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.deleteIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.exportIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2025} identityPreviewRequestV2025 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async generateIdentityPreview(identityPreviewRequestV2025: IdentityPreviewRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreview(identityPreviewRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.generateIdentityPreview']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.getDefaultIdentityAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.getIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2025 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importIdentityProfiles(identityProfileExportedObjectV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfiles(identityProfileExportedObjectV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.importIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.listIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.syncIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2025 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateIdentityProfile(identityProfileId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfile(identityProfileId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2025Api.updateIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityProfilesV2025Api - factory interface - * @export - */ -export const IdentityProfilesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityProfilesV2025ApiFp(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2025ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile(requestParameters: IdentityProfilesV2025ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityProfile(requestParameters.identityProfileV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2025ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile(requestParameters: IdentityProfilesV2025ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2025ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles(requestParameters: IdentityProfilesV2025ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2025ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles(requestParameters: IdentityProfilesV2025ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2025ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview(requestParameters: IdentityProfilesV2025ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.generateIdentityPreview(requestParameters.identityPreviewRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2025ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile(requestParameters: IdentityProfilesV2025ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2025ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles(requestParameters: IdentityProfilesV2025ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importIdentityProfiles(requestParameters.identityProfileExportedObjectV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2025ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles(requestParameters: IdentityProfilesV2025ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2025ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile(requestParameters: IdentityProfilesV2025ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2025ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile(requestParameters: IdentityProfilesV2025ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityProfile operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiCreateIdentityProfileRequest - */ -export interface IdentityProfilesV2025ApiCreateIdentityProfileRequest { - /** - * - * @type {IdentityProfileV2025} - * @memberof IdentityProfilesV2025ApiCreateIdentityProfile - */ - readonly identityProfileV2025: IdentityProfileV2025 -} - -/** - * Request parameters for deleteIdentityProfile operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiDeleteIdentityProfileRequest - */ -export interface IdentityProfilesV2025ApiDeleteIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2025ApiDeleteIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for deleteIdentityProfiles operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiDeleteIdentityProfilesRequest - */ -export interface IdentityProfilesV2025ApiDeleteIdentityProfilesRequest { - /** - * Identity Profile bulk delete request body. - * @type {Array} - * @memberof IdentityProfilesV2025ApiDeleteIdentityProfiles - */ - readonly requestBody: Array -} - -/** - * Request parameters for exportIdentityProfiles operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiExportIdentityProfilesRequest - */ -export interface IdentityProfilesV2025ApiExportIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2025ApiExportIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2025ApiExportIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2025ApiExportIdentityProfiles - */ - 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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2025ApiExportIdentityProfiles - */ - 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, name, priority** - * @type {string} - * @memberof IdentityProfilesV2025ApiExportIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for generateIdentityPreview operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiGenerateIdentityPreviewRequest - */ -export interface IdentityProfilesV2025ApiGenerateIdentityPreviewRequest { - /** - * Identity Preview request body. - * @type {IdentityPreviewRequestV2025} - * @memberof IdentityProfilesV2025ApiGenerateIdentityPreview - */ - readonly identityPreviewRequestV2025: IdentityPreviewRequestV2025 -} - -/** - * Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest - */ -export interface IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest { - /** - * The Identity Profile ID. - * @type {string} - * @memberof IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfig - */ - readonly identityProfileId: string -} - -/** - * Request parameters for getIdentityProfile operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiGetIdentityProfileRequest - */ -export interface IdentityProfilesV2025ApiGetIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2025ApiGetIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for importIdentityProfiles operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiImportIdentityProfilesRequest - */ -export interface IdentityProfilesV2025ApiImportIdentityProfilesRequest { - /** - * Previously exported Identity Profiles. - * @type {Array} - * @memberof IdentityProfilesV2025ApiImportIdentityProfiles - */ - readonly identityProfileExportedObjectV2025: Array -} - -/** - * Request parameters for listIdentityProfiles operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiListIdentityProfilesRequest - */ -export interface IdentityProfilesV2025ApiListIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2025ApiListIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2025ApiListIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2025ApiListIdentityProfiles - */ - 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2025ApiListIdentityProfiles - */ - 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, name, priority, created, modified, owner.id, owner.name** - * @type {string} - * @memberof IdentityProfilesV2025ApiListIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for syncIdentityProfile operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiSyncIdentityProfileRequest - */ -export interface IdentityProfilesV2025ApiSyncIdentityProfileRequest { - /** - * The Identity Profile ID to be processed - * @type {string} - * @memberof IdentityProfilesV2025ApiSyncIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for updateIdentityProfile operation in IdentityProfilesV2025Api. - * @export - * @interface IdentityProfilesV2025ApiUpdateIdentityProfileRequest - */ -export interface IdentityProfilesV2025ApiUpdateIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2025ApiUpdateIdentityProfile - */ - readonly identityProfileId: string - - /** - * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof IdentityProfilesV2025ApiUpdateIdentityProfile - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * IdentityProfilesV2025Api - object-oriented interface - * @export - * @class IdentityProfilesV2025Api - * @extends {BaseAPI} - */ -export class IdentityProfilesV2025Api extends BaseAPI { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2025ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public createIdentityProfile(requestParameters: IdentityProfilesV2025ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).createIdentityProfile(requestParameters.identityProfileV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2025ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public deleteIdentityProfile(requestParameters: IdentityProfilesV2025ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2025ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public deleteIdentityProfiles(requestParameters: IdentityProfilesV2025ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2025ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public exportIdentityProfiles(requestParameters: IdentityProfilesV2025ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2025ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public generateIdentityPreview(requestParameters: IdentityProfilesV2025ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).generateIdentityPreview(requestParameters.identityPreviewRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2025ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2025ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public getIdentityProfile(requestParameters: IdentityProfilesV2025ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2025ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public importIdentityProfiles(requestParameters: IdentityProfilesV2025ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).importIdentityProfiles(requestParameters.identityProfileExportedObjectV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2025ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public listIdentityProfiles(requestParameters: IdentityProfilesV2025ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2025ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public syncIdentityProfile(requestParameters: IdentityProfilesV2025ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2025ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2025Api - */ - public updateIdentityProfile(requestParameters: IdentityProfilesV2025ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2025ApiFp(this.configuration).updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LaunchersV2025Api - axios parameter creator - * @export - */ -export const LaunchersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2025} launcherRequestV2025 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher: async (launcherRequestV2025: LauncherRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherRequestV2025' is not null or undefined - assertParamExists('createLauncher', 'launcherRequestV2025', launcherRequestV2025) - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('deleteLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('getLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers: async (filters?: string, next?: string, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (next !== undefined) { - localVarQueryParameter['next'] = next; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2025} launcherRequestV2025 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher: async (launcherID: string, launcherRequestV2025: LauncherRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('putLauncher', 'launcherID', launcherID) - // verify required parameter 'launcherRequestV2025' is not null or undefined - assertParamExists('putLauncher', 'launcherRequestV2025', launcherRequestV2025) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('startLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}/launch` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LaunchersV2025Api - functional programming interface - * @export - */ -export const LaunchersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LaunchersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2025} launcherRequestV2025 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLauncher(launcherRequestV2025: LauncherRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLauncher(launcherRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.createLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.deleteLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.getLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLaunchers(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLaunchers(filters, next, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.getLaunchers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2025} launcherRequestV2025 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putLauncher(launcherID: string, launcherRequestV2025: LauncherRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putLauncher(launcherID, launcherRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.putLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2025Api.startLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LaunchersV2025Api - factory interface - * @export - */ -export const LaunchersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LaunchersV2025ApiFp(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2025ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher(requestParameters: LaunchersV2025ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLauncher(requestParameters.launcherRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2025ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher(requestParameters: LaunchersV2025ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2025ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher(requestParameters: LaunchersV2025ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2025ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers(requestParameters: LaunchersV2025ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2025ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher(requestParameters: LaunchersV2025ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2025ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher(requestParameters: LaunchersV2025ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLauncher operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiCreateLauncherRequest - */ -export interface LaunchersV2025ApiCreateLauncherRequest { - /** - * Payload to create a Launcher - * @type {LauncherRequestV2025} - * @memberof LaunchersV2025ApiCreateLauncher - */ - readonly launcherRequestV2025: LauncherRequestV2025 -} - -/** - * Request parameters for deleteLauncher operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiDeleteLauncherRequest - */ -export interface LaunchersV2025ApiDeleteLauncherRequest { - /** - * ID of the Launcher to be deleted - * @type {string} - * @memberof LaunchersV2025ApiDeleteLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLauncher operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiGetLauncherRequest - */ -export interface LaunchersV2025ApiGetLauncherRequest { - /** - * ID of the Launcher to be retrieved - * @type {string} - * @memberof LaunchersV2025ApiGetLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLaunchers operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiGetLaunchersRequest - */ -export interface LaunchersV2025ApiGetLaunchersRequest { - /** - * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @type {string} - * @memberof LaunchersV2025ApiGetLaunchers - */ - readonly filters?: string - - /** - * Pagination marker - * @type {string} - * @memberof LaunchersV2025ApiGetLaunchers - */ - readonly next?: string - - /** - * Number of Launchers to return - * @type {number} - * @memberof LaunchersV2025ApiGetLaunchers - */ - readonly limit?: number -} - -/** - * Request parameters for putLauncher operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiPutLauncherRequest - */ -export interface LaunchersV2025ApiPutLauncherRequest { - /** - * ID of the Launcher to be replaced - * @type {string} - * @memberof LaunchersV2025ApiPutLauncher - */ - readonly launcherID: string - - /** - * Payload to replace Launcher - * @type {LauncherRequestV2025} - * @memberof LaunchersV2025ApiPutLauncher - */ - readonly launcherRequestV2025: LauncherRequestV2025 -} - -/** - * Request parameters for startLauncher operation in LaunchersV2025Api. - * @export - * @interface LaunchersV2025ApiStartLauncherRequest - */ -export interface LaunchersV2025ApiStartLauncherRequest { - /** - * ID of the Launcher to be launched - * @type {string} - * @memberof LaunchersV2025ApiStartLauncher - */ - readonly launcherID: string -} - -/** - * LaunchersV2025Api - object-oriented interface - * @export - * @class LaunchersV2025Api - * @extends {BaseAPI} - */ -export class LaunchersV2025Api extends BaseAPI { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2025ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public createLauncher(requestParameters: LaunchersV2025ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).createLauncher(requestParameters.launcherRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2025ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public deleteLauncher(requestParameters: LaunchersV2025ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2025ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public getLauncher(requestParameters: LaunchersV2025ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2025ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public getLaunchers(requestParameters: LaunchersV2025ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2025ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public putLauncher(requestParameters: LaunchersV2025ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2025ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2025Api - */ - public startLauncher(requestParameters: LaunchersV2025ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2025ApiFp(this.configuration).startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LifecycleStatesV2025Api - axios parameter creator - * @export - */ -export const LifecycleStatesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2025} lifecycleStateV2025 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState: async (identityProfileId: string, lifecycleStateV2025: LifecycleStateV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('createLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateV2025' is not null or undefined - assertParamExists('createLifecycleState', 'lifecycleStateV2025', lifecycleStateV2025) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(lifecycleStateV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('deleteLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('getLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates: async (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleStates', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2025} setLifecycleStateRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState: async (identityId: string, setLifecycleStateRequestV2025: SetLifecycleStateRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('setLifecycleState', 'identityId', identityId) - // verify required parameter 'setLifecycleStateRequestV2025' is not null or undefined - assertParamExists('setLifecycleState', 'setLifecycleStateRequestV2025', setLifecycleStateRequestV2025) - const localVarPath = `/identities/{identity-id}/set-lifecycle-state` - .replace(`{${"identity-id"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(setLifecycleStateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2025 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('updateLifecycleStates', 'lifecycleStateId', lifecycleStateId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateLifecycleStates', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LifecycleStatesV2025Api - functional programming interface - * @export - */ -export const LifecycleStatesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LifecycleStatesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2025} lifecycleStateV2025 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLifecycleState(identityProfileId: string, lifecycleStateV2025: LifecycleStateV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLifecycleState(identityProfileId, lifecycleStateV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.createLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.deleteLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.getLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStates(identityProfileId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.getLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2025} setLifecycleStateRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setLifecycleState(identityId: string, setLifecycleStateRequestV2025: SetLifecycleStateRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setLifecycleState(identityId, setLifecycleStateRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.setLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2025 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateLifecycleStates(identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStates(identityProfileId, lifecycleStateId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2025Api.updateLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LifecycleStatesV2025Api - factory interface - * @export - */ -export const LifecycleStatesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LifecycleStatesV2025ApiFp(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2025ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState(requestParameters: LifecycleStatesV2025ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2025ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState(requestParameters: LifecycleStatesV2025ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2025ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState(requestParameters: LifecycleStatesV2025ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2025ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates(requestParameters: LifecycleStatesV2025ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2025ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState(requestParameters: LifecycleStatesV2025ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2025ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates(requestParameters: LifecycleStatesV2025ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLifecycleState operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiCreateLifecycleStateRequest - */ -export interface LifecycleStatesV2025ApiCreateLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiCreateLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state to be created. - * @type {LifecycleStateV2025} - * @memberof LifecycleStatesV2025ApiCreateLifecycleState - */ - readonly lifecycleStateV2025: LifecycleStateV2025 -} - -/** - * Request parameters for deleteLifecycleState operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiDeleteLifecycleStateRequest - */ -export interface LifecycleStatesV2025ApiDeleteLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiDeleteLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiDeleteLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleState operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiGetLifecycleStateRequest - */ -export interface LifecycleStatesV2025ApiGetLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiGetLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiGetLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleStates operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiGetLifecycleStatesRequest - */ -export interface LifecycleStatesV2025ApiGetLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiGetLifecycleStates - */ - readonly identityProfileId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2025ApiGetLifecycleStates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2025ApiGetLifecycleStates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof LifecycleStatesV2025ApiGetLifecycleStates - */ - readonly count?: boolean - - /** - * 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: **name, priority, created, modified** - * @type {string} - * @memberof LifecycleStatesV2025ApiGetLifecycleStates - */ - readonly sorters?: string -} - -/** - * Request parameters for setLifecycleState operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiSetLifecycleStateRequest - */ -export interface LifecycleStatesV2025ApiSetLifecycleStateRequest { - /** - * ID of the identity to update. - * @type {string} - * @memberof LifecycleStatesV2025ApiSetLifecycleState - */ - readonly identityId: string - - /** - * - * @type {SetLifecycleStateRequestV2025} - * @memberof LifecycleStatesV2025ApiSetLifecycleState - */ - readonly setLifecycleStateRequestV2025: SetLifecycleStateRequestV2025 -} - -/** - * Request parameters for updateLifecycleStates operation in LifecycleStatesV2025Api. - * @export - * @interface LifecycleStatesV2025ApiUpdateLifecycleStatesRequest - */ -export interface LifecycleStatesV2025ApiUpdateLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiUpdateLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2025ApiUpdateLifecycleStates - */ - readonly lifecycleStateId: string - - /** - * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @type {Array} - * @memberof LifecycleStatesV2025ApiUpdateLifecycleStates - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * LifecycleStatesV2025Api - object-oriented interface - * @export - * @class LifecycleStatesV2025Api - * @extends {BaseAPI} - */ -export class LifecycleStatesV2025Api extends BaseAPI { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2025ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public createLifecycleState(requestParameters: LifecycleStatesV2025ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2025ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public deleteLifecycleState(requestParameters: LifecycleStatesV2025ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2025ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public getLifecycleState(requestParameters: LifecycleStatesV2025ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2025ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public getLifecycleStates(requestParameters: LifecycleStatesV2025ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2025ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public setLifecycleState(requestParameters: LifecycleStatesV2025ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2025ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2025Api - */ - public updateLifecycleStates(requestParameters: LifecycleStatesV2025ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2025ApiFp(this.configuration).updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MFAConfigurationV2025Api - axios parameter creator - * @export - */ -export const MFAConfigurationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/duo-web/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/kba/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (allLanguages !== undefined) { - localVarQueryParameter['allLanguages'] = allLanguages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/okta-verify/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2025} mfaDuoConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig: async (mfaDuoConfigV2025: MfaDuoConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaDuoConfigV2025' is not null or undefined - assertParamExists('setMFADuoConfig', 'mfaDuoConfigV2025', mfaDuoConfigV2025) - const localVarPath = `/mfa/duo-web/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaDuoConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig: async (kbaAnswerRequestItemV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItemV2025' is not null or undefined - assertParamExists('setMFAKBAConfig', 'kbaAnswerRequestItemV2025', kbaAnswerRequestItemV2025) - const localVarPath = `/mfa/kba/config/answers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItemV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2025} mfaOktaConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig: async (mfaOktaConfigV2025: MfaOktaConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaOktaConfigV2025' is not null or undefined - assertParamExists('setMFAOktaConfig', 'mfaOktaConfigV2025', mfaOktaConfigV2025) - const localVarPath = `/mfa/okta-verify/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaOktaConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2025} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig: async (method: TestMFAConfigMethodV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('testMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/test` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAConfigurationV2025Api - functional programming interface - * @export - */ -export const MFAConfigurationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAConfigurationV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.getMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAKbaConfig(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfig(allLanguages, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.getMFAKbaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.getMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2025} mfaDuoConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFADuoConfig(mfaDuoConfigV2025: MfaDuoConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfig(mfaDuoConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.setMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAKBAConfig(kbaAnswerRequestItemV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfig(kbaAnswerRequestItemV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.setMFAKBAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2025} mfaOktaConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAOktaConfig(mfaOktaConfigV2025: MfaOktaConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfig(mfaOktaConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.setMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2025} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testMFAConfig(method: TestMFAConfigMethodV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2025Api.testMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAConfigurationV2025Api - factory interface - * @export - */ -export const MFAConfigurationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAConfigurationV2025ApiFp(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFADuoConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2025ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig(requestParameters: MFAConfigurationV2025ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFAOktaConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2025ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig(requestParameters: MFAConfigurationV2025ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFADuoConfig(requestParameters.mfaDuoConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2025ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig(requestParameters: MFAConfigurationV2025ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2025ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig(requestParameters: MFAConfigurationV2025ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFAOktaConfig(requestParameters.mfaOktaConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2025ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig(requestParameters: MFAConfigurationV2025ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getMFAKbaConfig operation in MFAConfigurationV2025Api. - * @export - * @interface MFAConfigurationV2025ApiGetMFAKbaConfigRequest - */ -export interface MFAConfigurationV2025ApiGetMFAKbaConfigRequest { - /** - * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @type {boolean} - * @memberof MFAConfigurationV2025ApiGetMFAKbaConfig - */ - readonly allLanguages?: boolean -} - -/** - * Request parameters for setMFADuoConfig operation in MFAConfigurationV2025Api. - * @export - * @interface MFAConfigurationV2025ApiSetMFADuoConfigRequest - */ -export interface MFAConfigurationV2025ApiSetMFADuoConfigRequest { - /** - * - * @type {MfaDuoConfigV2025} - * @memberof MFAConfigurationV2025ApiSetMFADuoConfig - */ - readonly mfaDuoConfigV2025: MfaDuoConfigV2025 -} - -/** - * Request parameters for setMFAKBAConfig operation in MFAConfigurationV2025Api. - * @export - * @interface MFAConfigurationV2025ApiSetMFAKBAConfigRequest - */ -export interface MFAConfigurationV2025ApiSetMFAKBAConfigRequest { - /** - * - * @type {Array} - * @memberof MFAConfigurationV2025ApiSetMFAKBAConfig - */ - readonly kbaAnswerRequestItemV2025: Array -} - -/** - * Request parameters for setMFAOktaConfig operation in MFAConfigurationV2025Api. - * @export - * @interface MFAConfigurationV2025ApiSetMFAOktaConfigRequest - */ -export interface MFAConfigurationV2025ApiSetMFAOktaConfigRequest { - /** - * - * @type {MfaOktaConfigV2025} - * @memberof MFAConfigurationV2025ApiSetMFAOktaConfig - */ - readonly mfaOktaConfigV2025: MfaOktaConfigV2025 -} - -/** - * Request parameters for testMFAConfig operation in MFAConfigurationV2025Api. - * @export - * @interface MFAConfigurationV2025ApiTestMFAConfigRequest - */ -export interface MFAConfigurationV2025ApiTestMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationV2025ApiTestMFAConfig - */ - readonly method: TestMFAConfigMethodV2025 -} - -/** - * MFAConfigurationV2025Api - object-oriented interface - * @export - * @class MFAConfigurationV2025Api - * @extends {BaseAPI} - */ -export class MFAConfigurationV2025Api extends BaseAPI { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).getMFADuoConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2025ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public getMFAKbaConfig(requestParameters: MFAConfigurationV2025ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).getMFAOktaConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2025ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public setMFADuoConfig(requestParameters: MFAConfigurationV2025ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).setMFADuoConfig(requestParameters.mfaDuoConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2025ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public setMFAKBAConfig(requestParameters: MFAConfigurationV2025ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2025ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public setMFAOktaConfig(requestParameters: MFAConfigurationV2025ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).setMFAOktaConfig(requestParameters.mfaOktaConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2025ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2025Api - */ - public testMFAConfig(requestParameters: MFAConfigurationV2025ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2025ApiFp(this.configuration).testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const TestMFAConfigMethodV2025 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type TestMFAConfigMethodV2025 = typeof TestMFAConfigMethodV2025[keyof typeof TestMFAConfigMethodV2025]; - - -/** - * MachineAccountClassifyV2025Api - axios parameter creator - * @export - */ -export const MachineAccountClassifyV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2025} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount: async (id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendClassifyMachineAccount', 'id', id) - const localVarPath = `/accounts/{id}/classify` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (classificationMode !== undefined) { - localVarQueryParameter['classificationMode'] = classificationMode; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountClassifyV2025Api - functional programming interface - * @export - */ -export const MachineAccountClassifyV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountClassifyV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2025} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendClassifyMachineAccount(id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccount(id, classificationMode, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountClassifyV2025Api.sendClassifyMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountClassifyV2025Api - factory interface - * @export - */ -export const MachineAccountClassifyV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountClassifyV2025ApiFp(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for sendClassifyMachineAccount operation in MachineAccountClassifyV2025Api. - * @export - * @interface MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest - */ -export interface MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof MachineAccountClassifyV2025ApiSendClassifyMachineAccount - */ - readonly id: string - - /** - * Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @type {'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman'} - * @memberof MachineAccountClassifyV2025ApiSendClassifyMachineAccount - */ - readonly classificationMode?: SendClassifyMachineAccountClassificationModeV2025 -} - -/** - * MachineAccountClassifyV2025Api - object-oriented interface - * @export - * @class MachineAccountClassifyV2025Api - * @extends {BaseAPI} - */ -export class MachineAccountClassifyV2025Api extends BaseAPI { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountClassifyV2025Api - */ - public sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2025ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountClassifyV2025ApiFp(this.configuration).sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SendClassifyMachineAccountClassificationModeV2025 = { - Default: 'default', - IgnoreManual: 'ignoreManual', - ForceMachine: 'forceMachine', - ForceHuman: 'forceHuman' -} as const; -export type SendClassifyMachineAccountClassificationModeV2025 = typeof SendClassifyMachineAccountClassificationModeV2025[keyof typeof SendClassifyMachineAccountClassificationModeV2025]; - - -/** - * MachineAccountMappingsV2025Api - axios parameter creator - * @export - */ -export const MachineAccountMappingsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2025} attributeMappingsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings: async (id: string, attributeMappingsV2025: AttributeMappingsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2025' is not null or undefined - assertParamExists('createMachineAccountMappings', 'attributeMappingsV2025', attributeMappingsV2025) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings: async (id: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s Machine Account Mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2025} attributeMappingsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings: async (id: string, attributeMappingsV2025: AttributeMappingsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2025' is not null or undefined - assertParamExists('setMachineAccountMappings', 'attributeMappingsV2025', attributeMappingsV2025) - const localVarPath = `/sources/{sourceId}/machine-mappings` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountMappingsV2025Api - functional programming interface - * @export - */ -export const MachineAccountMappingsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountMappingsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2025} attributeMappingsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineAccountMappings(id: string, attributeMappingsV2025: AttributeMappingsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountMappings(id, attributeMappingsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2025Api.createMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineAccountMappings(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountMappings(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2025Api.deleteMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccountMappings(id: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountMappings(id, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2025Api.listMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s Machine Account Mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2025} attributeMappingsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineAccountMappings(id: string, attributeMappingsV2025: AttributeMappingsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineAccountMappings(id, attributeMappingsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2025Api.setMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountMappingsV2025Api - factory interface - * @export - */ -export const MachineAccountMappingsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountMappingsV2025ApiFp(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s Machine Account Mappings - * @param {MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountMappings operation in MachineAccountMappingsV2025Api. - * @export - * @interface MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2025ApiCreateMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2025} - * @memberof MachineAccountMappingsV2025ApiCreateMachineAccountMappings - */ - readonly attributeMappingsV2025: AttributeMappingsV2025 -} - -/** - * Request parameters for deleteMachineAccountMappings operation in MachineAccountMappingsV2025Api. - * @export - * @interface MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest { - /** - * source ID. - * @type {string} - * @memberof MachineAccountMappingsV2025ApiDeleteMachineAccountMappings - */ - readonly id: string -} - -/** - * Request parameters for listMachineAccountMappings operation in MachineAccountMappingsV2025Api. - * @export - * @interface MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest { - /** - * Source ID - * @type {string} - * @memberof MachineAccountMappingsV2025ApiListMachineAccountMappings - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2025ApiListMachineAccountMappings - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2025ApiListMachineAccountMappings - */ - readonly offset?: number -} - -/** - * Request parameters for setMachineAccountMappings operation in MachineAccountMappingsV2025Api. - * @export - * @interface MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2025ApiSetMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2025} - * @memberof MachineAccountMappingsV2025ApiSetMachineAccountMappings - */ - readonly attributeMappingsV2025: AttributeMappingsV2025 -} - -/** - * MachineAccountMappingsV2025Api - object-oriented interface - * @export - * @class MachineAccountMappingsV2025Api - * @extends {BaseAPI} - */ -export class MachineAccountMappingsV2025Api extends BaseAPI { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2025Api - */ - public createMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2025ApiFp(this.configuration).createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2025Api - */ - public deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2025ApiFp(this.configuration).deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2025Api - */ - public listMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2025ApiFp(this.configuration).listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s Machine Account Mappings - * @param {MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2025Api - */ - public setMachineAccountMappings(requestParameters: MachineAccountMappingsV2025ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2025ApiFp(this.configuration).setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineAccountsV2025Api - axios parameter creator - * @export - */ -export const MachineAccountsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {string} sourceId The ID of the source. - * @param {CreateMachineAccountSubtypeRequestV2025} createMachineAccountSubtypeRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createMachineAccountSubtype: async (sourceId: string, createMachineAccountSubtypeRequestV2025: CreateMachineAccountSubtypeRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createMachineAccountSubtype', 'sourceId', sourceId) - // verify required parameter 'createMachineAccountSubtypeRequestV2025' is not null or undefined - assertParamExists('createMachineAccountSubtype', 'createMachineAccountSubtypeRequestV2025', createMachineAccountSubtypeRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createMachineAccountSubtypeRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteMachineAccountSubtype: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteMachineAccountSubtype', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('deleteMachineAccountSubtype', 'technicalName', technicalName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineAccount', 'id', id) - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {string} subtypeId The ID of the machine account subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeById: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('getMachineAccountSubtypeById', 'subtypeId', subtypeId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/subtypes/{subtypeId}` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeByTechnicalName: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getMachineAccountSubtypeByTechnicalName', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('getMachineAccountSubtypeByTechnicalName', 'technicalName', technicalName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {string} sourceId The ID of the source. - * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listMachineAccountSubtypes: async (sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listMachineAccountSubtypes', 'sourceId', sourceId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/machine-accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchMachineAccountSubtype: async (sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchMachineAccountSubtype', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('patchMachineAccountSubtype', 'technicalName', technicalName) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchMachineAccountSubtype', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineAccount', 'requestBody', requestBody) - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountsV2025Api - functional programming interface - * @export - */ -export const MachineAccountsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {string} sourceId The ID of the source. - * @param {CreateMachineAccountSubtypeRequestV2025} createMachineAccountSubtypeRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createMachineAccountSubtype(sourceId: string, createMachineAccountSubtypeRequestV2025: CreateMachineAccountSubtypeRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountSubtype(sourceId, createMachineAccountSubtypeRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.createMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteMachineAccountSubtype(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountSubtype(sourceId, technicalName, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.deleteMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.getMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {string} subtypeId The ID of the machine account subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getMachineAccountSubtypeById(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeById(subtypeId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.getMachineAccountSubtypeById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeByTechnicalName(sourceId, technicalName, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.getMachineAccountSubtypeByTechnicalName']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {string} sourceId The ID of the source. - * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listMachineAccountSubtypes(sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountSubtypes(sourceId, filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.listMachineAccountSubtypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccounts(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.listMachineAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchMachineAccountSubtype(sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchMachineAccountSubtype(sourceId, technicalName, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.patchMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2025Api.updateMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountsV2025Api - factory interface - * @export - */ -export const MachineAccountsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountsV2025ApiFp(configuration) - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineAccountSubtype(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountSubtype(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2025ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount(requestParameters: MachineAccountsV2025ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeById(requestParameters: MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {MachineAccountsV2025ApiListMachineAccountSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listMachineAccountSubtypes(requestParameters: MachineAccountsV2025ApiListMachineAccountSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccountSubtypes(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2025ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts(requestParameters: MachineAccountsV2025ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchMachineAccountSubtype(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2025ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount(requestParameters: MachineAccountsV2025ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountSubtype operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest - */ -export interface MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2025ApiCreateMachineAccountSubtype - */ - readonly sourceId: string - - /** - * - * @type {CreateMachineAccountSubtypeRequestV2025} - * @memberof MachineAccountsV2025ApiCreateMachineAccountSubtype - */ - readonly createMachineAccountSubtypeRequestV2025: CreateMachineAccountSubtypeRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiCreateMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineAccountSubtype operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest - */ -export interface MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2025ApiDeleteMachineAccountSubtype - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2025ApiDeleteMachineAccountSubtype - */ - readonly technicalName: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiDeleteMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccount operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiGetMachineAccountRequest - */ -export interface MachineAccountsV2025ApiGetMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccount - */ - readonly id: string -} - -/** - * Request parameters for getMachineAccountSubtypeById operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest - */ -export interface MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest { - /** - * The ID of the machine account subtype. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccountSubtypeById - */ - readonly subtypeId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccountSubtypeById - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccountSubtypeByTechnicalName operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest - */ -export interface MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly technicalName: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineAccountSubtypes operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiListMachineAccountSubtypesRequest - */ -export interface MachineAccountsV2025ApiListMachineAccountSubtypesRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly sourceId: 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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccountSubtypes - */ - 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: **displayName, technicalName** - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly count?: boolean - - /** - * 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 MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountsV2025ApiListMachineAccountSubtypes - */ - readonly offset?: number -} - -/** - * Request parameters for listMachineAccounts operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiListMachineAccountsRequest - */ -export interface MachineAccountsV2025ApiListMachineAccountsRequest { - /** - * 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 MachineAccountsV2025ApiListMachineAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountsV2025ApiListMachineAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof MachineAccountsV2025ApiListMachineAccounts - */ - 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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccounts - */ - 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @type {string} - * @memberof MachineAccountsV2025ApiListMachineAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for patchMachineAccountSubtype operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest - */ -export interface MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2025ApiPatchMachineAccountSubtype - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2025ApiPatchMachineAccountSubtype - */ - readonly technicalName: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineAccountsV2025ApiPatchMachineAccountSubtype - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2025ApiPatchMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineAccount operation in MachineAccountsV2025Api. - * @export - * @interface MachineAccountsV2025ApiUpdateMachineAccountRequest - */ -export interface MachineAccountsV2025ApiUpdateMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2025ApiUpdateMachineAccount - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @type {Array} - * @memberof MachineAccountsV2025ApiUpdateMachineAccount - */ - readonly requestBody: Array -} - -/** - * MachineAccountsV2025Api - object-oriented interface - * @export - * @class MachineAccountsV2025Api - * @extends {BaseAPI} - */ -export class MachineAccountsV2025Api extends BaseAPI { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public createMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiCreateMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).createMachineAccountSubtype(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public deleteMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).deleteMachineAccountSubtype(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2025ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public getMachineAccount(requestParameters: MachineAccountsV2025ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).getMachineAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public getMachineAccountSubtypeById(requestParameters: MachineAccountsV2025ApiGetMachineAccountSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).getMachineAccountSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public getMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2025ApiGetMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).getMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {MachineAccountsV2025ApiListMachineAccountSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public listMachineAccountSubtypes(requestParameters: MachineAccountsV2025ApiListMachineAccountSubtypesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).listMachineAccountSubtypes(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2025ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public listMachineAccounts(requestParameters: MachineAccountsV2025ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public patchMachineAccountSubtype(requestParameters: MachineAccountsV2025ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).patchMachineAccountSubtype(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2025ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2025Api - */ - public updateMachineAccount(requestParameters: MachineAccountsV2025ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2025ApiFp(this.configuration).updateMachineAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineClassificationConfigV2025Api - axios parameter creator - * @export - */ -export const MachineClassificationConfigV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2025} machineClassificationConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig: async (id: string, machineClassificationConfigV2025: MachineClassificationConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'id', id) - // verify required parameter 'machineClassificationConfigV2025' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'machineClassificationConfigV2025', machineClassificationConfigV2025) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineClassificationConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineClassificationConfigV2025Api - functional programming interface - * @export - */ -export const MachineClassificationConfigV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineClassificationConfigV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2025Api.deleteMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2025Api.getMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2025} machineClassificationConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineClassificationConfig(id: string, machineClassificationConfigV2025: MachineClassificationConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineClassificationConfig(id, machineClassificationConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2025Api.setMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineClassificationConfigV2025Api - factory interface - * @export - */ -export const MachineClassificationConfigV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineClassificationConfigV2025ApiFp(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteMachineClassificationConfig operation in MachineClassificationConfigV2025Api. - * @export - * @interface MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2025ApiDeleteMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for getMachineClassificationConfig operation in MachineClassificationConfigV2025Api. - * @export - * @interface MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest { - /** - * Source ID - * @type {string} - * @memberof MachineClassificationConfigV2025ApiGetMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for setMachineClassificationConfig operation in MachineClassificationConfigV2025Api. - * @export - * @interface MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2025ApiSetMachineClassificationConfig - */ - readonly id: string - - /** - * - * @type {MachineClassificationConfigV2025} - * @memberof MachineClassificationConfigV2025ApiSetMachineClassificationConfig - */ - readonly machineClassificationConfigV2025: MachineClassificationConfigV2025 -} - -/** - * MachineClassificationConfigV2025Api - object-oriented interface - * @export - * @class MachineClassificationConfigV2025Api - * @extends {BaseAPI} - */ -export class MachineClassificationConfigV2025Api extends BaseAPI { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2025Api - */ - public deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2025ApiFp(this.configuration).deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2025Api - */ - public getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2025ApiFp(this.configuration).getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2025Api - */ - public setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2025ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2025ApiFp(this.configuration).setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineIdentitiesV2025Api - axios parameter creator - * @export - */ -export const MachineIdentitiesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityRequestV2025} machineIdentityRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity: async (machineIdentityRequestV2025: MachineIdentityRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'machineIdentityRequestV2025' is not null or undefined - assertParamExists('createMachineIdentity', 'machineIdentityRequestV2025', machineIdentityRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @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: **machineIdentityName, entitlement.name, source.name** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentityUserEntitlements: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identity-user-entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {string} sourceId Source ID. - * @param {MachineIdentityAggregationRequestV2025} machineIdentityAggregationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startMachineIdentityAggregation: async (sourceId: string, machineIdentityAggregationRequestV2025: MachineIdentityAggregationRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('startMachineIdentityAggregation', 'sourceId', sourceId) - // verify required parameter 'machineIdentityAggregationRequestV2025' is not null or undefined - assertParamExists('startMachineIdentityAggregation', 'machineIdentityAggregationRequestV2025', machineIdentityAggregationRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/aggregate-agents` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityAggregationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineIdentity', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineIdentity', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineIdentitiesV2025Api - functional programming interface - * @export - */ -export const MachineIdentitiesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineIdentitiesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityRequestV2025} machineIdentityRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineIdentity(machineIdentityRequestV2025: MachineIdentityRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentity(machineIdentityRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.createMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.deleteMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.getMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineIdentities(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentities(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.listMachineIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @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: **machineIdentityName, entitlement.name, source.name** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineIdentityUserEntitlements(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentityUserEntitlements(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.listMachineIdentityUserEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {string} sourceId Source ID. - * @param {MachineIdentityAggregationRequestV2025} machineIdentityAggregationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startMachineIdentityAggregation(sourceId: string, machineIdentityAggregationRequestV2025: MachineIdentityAggregationRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startMachineIdentityAggregation(sourceId, machineIdentityAggregationRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.startMachineIdentityAggregation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineIdentity(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentity(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2025Api.updateMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineIdentitiesV2025Api - factory interface - * @export - */ -export const MachineIdentitiesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineIdentitiesV2025ApiFp(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2025ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity(requestParameters: MachineIdentitiesV2025ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineIdentity(requestParameters.machineIdentityRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2025ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity(requestParameters: MachineIdentitiesV2025ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2025ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity(requestParameters: MachineIdentitiesV2025ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2025ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities(requestParameters: MachineIdentitiesV2025ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @param {MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentityUserEntitlements(requestParameters: MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineIdentityUserEntitlements(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startMachineIdentityAggregation(requestParameters: MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startMachineIdentityAggregation(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2025ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity(requestParameters: MachineIdentitiesV2025ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineIdentity operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiCreateMachineIdentityRequest - */ -export interface MachineIdentitiesV2025ApiCreateMachineIdentityRequest { - /** - * - * @type {MachineIdentityRequestV2025} - * @memberof MachineIdentitiesV2025ApiCreateMachineIdentity - */ - readonly machineIdentityRequestV2025: MachineIdentityRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiCreateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineIdentity operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiDeleteMachineIdentityRequest - */ -export interface MachineIdentitiesV2025ApiDeleteMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2025ApiDeleteMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiDeleteMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineIdentity operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiGetMachineIdentityRequest - */ -export interface MachineIdentitiesV2025ApiGetMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2025ApiGetMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiGetMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineIdentities operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiListMachineIdentitiesRequest - */ -export interface MachineIdentitiesV2025ApiListMachineIdentitiesRequest { - /** - * 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentities - */ - 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: **businessApplication, name, owners.primaryIdentity.name, source.name, created, modified** - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentities - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentities - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineIdentitiesV2025ApiListMachineIdentities - */ - readonly count?: boolean - - /** - * 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 MachineIdentitiesV2025ApiListMachineIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineIdentitiesV2025ApiListMachineIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for listMachineIdentityUserEntitlements operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest - */ -export interface MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest { - /** - * 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - 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: **machineIdentityName, entitlement.name, source.name** - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - readonly count?: boolean - - /** - * 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 MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineIdentitiesV2025ApiListMachineIdentityUserEntitlements - */ - readonly offset?: number -} - -/** - * Request parameters for startMachineIdentityAggregation operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest - */ -export interface MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineIdentitiesV2025ApiStartMachineIdentityAggregation - */ - readonly sourceId: string - - /** - * - * @type {MachineIdentityAggregationRequestV2025} - * @memberof MachineIdentitiesV2025ApiStartMachineIdentityAggregation - */ - readonly machineIdentityAggregationRequestV2025: MachineIdentityAggregationRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiStartMachineIdentityAggregation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineIdentity operation in MachineIdentitiesV2025Api. - * @export - * @interface MachineIdentitiesV2025ApiUpdateMachineIdentityRequest - */ -export interface MachineIdentitiesV2025ApiUpdateMachineIdentityRequest { - /** - * Machine Identity ID. - * @type {string} - * @memberof MachineIdentitiesV2025ApiUpdateMachineIdentity - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineIdentitiesV2025ApiUpdateMachineIdentity - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2025ApiUpdateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * MachineIdentitiesV2025Api - object-oriented interface - * @export - * @class MachineIdentitiesV2025Api - * @extends {BaseAPI} - */ -export class MachineIdentitiesV2025Api extends BaseAPI { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2025ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public createMachineIdentity(requestParameters: MachineIdentitiesV2025ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).createMachineIdentity(requestParameters.machineIdentityRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2025ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public deleteMachineIdentity(requestParameters: MachineIdentitiesV2025ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2025ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public getMachineIdentity(requestParameters: MachineIdentitiesV2025ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2025ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public listMachineIdentities(requestParameters: MachineIdentitiesV2025ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @param {MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public listMachineIdentityUserEntitlements(requestParameters: MachineIdentitiesV2025ApiListMachineIdentityUserEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).listMachineIdentityUserEntitlements(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public startMachineIdentityAggregation(requestParameters: MachineIdentitiesV2025ApiStartMachineIdentityAggregationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).startMachineIdentityAggregation(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2025ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2025Api - */ - public updateMachineIdentity(requestParameters: MachineIdentitiesV2025ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2025ApiFp(this.configuration).updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClientsV2025Api - axios parameter creator - * @export - */ -export const ManagedClientsV2025ApiAxiosParamCreator = 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 {ManagedClientRequestV2025} managedClientRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient: async (managedClientRequestV2025: ManagedClientRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClientRequestV2025' is not null or undefined - assertParamExists('createManagedClient', 'managedClientRequestV2025', managedClientRequestV2025) - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClientRequestV2025, 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} - */ - deleteManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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} - */ - getManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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} - */ - getManagedClientHealthIndicators: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientHealthIndicators', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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 {ManagedClientTypeV2025} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus: async (id: string, type: ManagedClientTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientStatus', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getManagedClientStatus', 'type', type) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * 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} - */ - getManagedClients: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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} jsonPatchOperationV2025 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateManagedClient', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClientsV2025Api - functional programming interface - * @export - */ -export const ManagedClientsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClientsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientRequestV2025} managedClientRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClient(managedClientRequestV2025: ManagedClientRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClient(managedClientRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.createManagedClient']?.[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 deleteManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.deleteManagedClient']?.[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 getManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.getManagedClient']?.[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 getManagedClientHealthIndicators(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientHealthIndicators(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.getManagedClientHealthIndicators']?.[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 {ManagedClientTypeV2025} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClientStatus(id: string, type: ManagedClientTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatus(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.getManagedClientStatus']?.[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 getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClients(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.getManagedClients']?.[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} jsonPatchOperationV2025 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClient(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClient(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2025Api.updateManagedClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClientsV2025Api - factory interface - * @export - */ -export const ManagedClientsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClientsV2025ApiFp(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2025ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient(requestParameters: ManagedClientsV2025ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClient(requestParameters.managedClientRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2025ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClient(requestParameters: ManagedClientsV2025ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2025ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClient(requestParameters: ManagedClientsV2025ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClient(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 {ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientHealthIndicators(requestParameters: ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientHealthIndicators(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed client\'s status, using its ID. - * @summary Get managed client status - * @param {ManagedClientsV2025ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus(requestParameters: ManagedClientsV2025ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2025ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClients(requestParameters: ManagedClientsV2025ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClients(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed client. - * @summary Update managed client - * @param {ManagedClientsV2025ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient(requestParameters: ManagedClientsV2025ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClient operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiCreateManagedClientRequest - */ -export interface ManagedClientsV2025ApiCreateManagedClientRequest { - /** - * - * @type {ManagedClientRequestV2025} - * @memberof ManagedClientsV2025ApiCreateManagedClient - */ - readonly managedClientRequestV2025: ManagedClientRequestV2025 -} - -/** - * Request parameters for deleteManagedClient operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiDeleteManagedClientRequest - */ -export interface ManagedClientsV2025ApiDeleteManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2025ApiDeleteManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClient operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiGetManagedClientRequest - */ -export interface ManagedClientsV2025ApiGetManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2025ApiGetManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientHealthIndicators operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest - */ -export interface ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest { - /** - * Managed client ID to get health indicators for. - * @type {string} - * @memberof ManagedClientsV2025ApiGetManagedClientHealthIndicators - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientStatus operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiGetManagedClientStatusRequest - */ -export interface ManagedClientsV2025ApiGetManagedClientStatusRequest { - /** - * Managed client ID to get status for. - * @type {string} - * @memberof ManagedClientsV2025ApiGetManagedClientStatus - */ - readonly id: string - - /** - * Managed client type to get status for. - * @type {ManagedClientTypeV2025} - * @memberof ManagedClientsV2025ApiGetManagedClientStatus - */ - readonly type: ManagedClientTypeV2025 -} - -/** - * Request parameters for getManagedClients operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiGetManagedClientsRequest - */ -export interface ManagedClientsV2025ApiGetManagedClientsRequest { - /** - * 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 ManagedClientsV2025ApiGetManagedClients - */ - 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 ManagedClientsV2025ApiGetManagedClients - */ - 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 ManagedClientsV2025ApiGetManagedClients - */ - 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 ManagedClientsV2025ApiGetManagedClients - */ - readonly filters?: string -} - -/** - * Request parameters for updateManagedClient operation in ManagedClientsV2025Api. - * @export - * @interface ManagedClientsV2025ApiUpdateManagedClientRequest - */ -export interface ManagedClientsV2025ApiUpdateManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2025ApiUpdateManagedClient - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClientsV2025ApiUpdateManagedClient - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * ManagedClientsV2025Api - object-oriented interface - * @export - * @class ManagedClientsV2025Api - * @extends {BaseAPI} - */ -export class ManagedClientsV2025Api extends BaseAPI { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2025ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public createManagedClient(requestParameters: ManagedClientsV2025ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).createManagedClient(requestParameters.managedClientRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2025ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public deleteManagedClient(requestParameters: ManagedClientsV2025ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2025ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public getManagedClient(requestParameters: ManagedClientsV2025ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).getManagedClient(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 {ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public getManagedClientHealthIndicators(requestParameters: ManagedClientsV2025ApiGetManagedClientHealthIndicatorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).getManagedClientHealthIndicators(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 {ManagedClientsV2025ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public getManagedClientStatus(requestParameters: ManagedClientsV2025ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2025ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public getManagedClients(requestParameters: ManagedClientsV2025ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).getManagedClients(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 {ManagedClientsV2025ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2025Api - */ - public updateManagedClient(requestParameters: ManagedClientsV2025ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2025ApiFp(this.configuration).updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClusterTypesV2025Api - axios parameter creator - * @export - */ -export const ManagedClusterTypesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2025} managedClusterTypeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType: async (managedClusterTypeV2025: ManagedClusterTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterTypeV2025' is not null or undefined - assertParamExists('createManagedClusterType', 'managedClusterTypeV2025', managedClusterTypeV2025) - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterTypeV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Cluster Type. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes: async (type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (pod !== undefined) { - localVarQueryParameter['pod'] = pod; - } - - if (org !== undefined) { - localVarQueryParameter['org'] = org; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 Cluster Type. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2025} jsonPatchV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType: async (id: string, jsonPatchV2025: JsonPatchV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClusterType', 'id', id) - // verify required parameter 'jsonPatchV2025' is not null or undefined - assertParamExists('updateManagedClusterType', 'jsonPatchV2025', jsonPatchV2025) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClusterTypesV2025Api - functional programming interface - * @export - */ -export const ManagedClusterTypesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClusterTypesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2025} managedClusterTypeV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClusterType(managedClusterTypeV2025: ManagedClusterTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClusterType(managedClusterTypeV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2025Api.createManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2025Api.deleteManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2025Api.getManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterTypes(type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterTypes(type, pod, org, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2025Api.getManagedClusterTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2025} jsonPatchV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClusterType(id: string, jsonPatchV2025: JsonPatchV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClusterType(id, jsonPatchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2025Api.updateManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClusterTypesV2025Api - factory interface - * @export - */ -export const ManagedClusterTypesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClusterTypesV2025ApiFp(configuration) - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClusterType(requestParameters.managedClusterTypeV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes(requestParameters: ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClusterType operation in ManagedClusterTypesV2025Api. - * @export - * @interface ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest { - /** - * - * @type {ManagedClusterTypeV2025} - * @memberof ManagedClusterTypesV2025ApiCreateManagedClusterType - */ - readonly managedClusterTypeV2025: ManagedClusterTypeV2025 -} - -/** - * Request parameters for deleteManagedClusterType operation in ManagedClusterTypesV2025Api. - * @export - * @interface ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2025ApiDeleteManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterType operation in ManagedClusterTypesV2025Api. - * @export - * @interface ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2025ApiGetManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterTypes operation in ManagedClusterTypesV2025Api. - * @export - * @interface ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest - */ -export interface ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest { - /** - * Type descriptor - * @type {string} - * @memberof ManagedClusterTypesV2025ApiGetManagedClusterTypes - */ - readonly type?: string - - /** - * Pinned pod (or default) - * @type {string} - * @memberof ManagedClusterTypesV2025ApiGetManagedClusterTypes - */ - readonly pod?: string - - /** - * Pinned org (or default) - * @type {string} - * @memberof ManagedClusterTypesV2025ApiGetManagedClusterTypes - */ - readonly org?: string - - /** - * 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 ManagedClusterTypesV2025ApiGetManagedClusterTypes - */ - 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 ManagedClusterTypesV2025ApiGetManagedClusterTypes - */ - readonly limit?: number -} - -/** - * Request parameters for updateManagedClusterType operation in ManagedClusterTypesV2025Api. - * @export - * @interface ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2025ApiUpdateManagedClusterType - */ - readonly id: string - - /** - * The JSONPatch payload used to update the schema. - * @type {JsonPatchV2025} - * @memberof ManagedClusterTypesV2025ApiUpdateManagedClusterType - */ - readonly jsonPatchV2025: JsonPatchV2025 -} - -/** - * ManagedClusterTypesV2025Api - object-oriented interface - * @export - * @class ManagedClusterTypesV2025Api - * @extends {BaseAPI} - */ -export class ManagedClusterTypesV2025Api extends BaseAPI { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2025Api - */ - public createManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2025ApiFp(this.configuration).createManagedClusterType(requestParameters.managedClusterTypeV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2025Api - */ - public deleteManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2025ApiFp(this.configuration).deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2025Api - */ - public getManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2025ApiFp(this.configuration).getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2025Api - */ - public getManagedClusterTypes(requestParameters: ManagedClusterTypesV2025ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2025ApiFp(this.configuration).getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2025Api - */ - public updateManagedClusterType(requestParameters: ManagedClusterTypesV2025ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2025ApiFp(this.configuration).updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClustersV2025Api - axios parameter creator - * @export - */ -export const ManagedClustersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2025} managedClusterRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster: async (managedClusterRequestV2025: ManagedClusterRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterRequestV2025' is not null or undefined - assertParamExists('createManagedCluster', 'managedClusterRequestV2025', managedClusterRequestV2025) - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster: async (id: string, removeClients?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (removeClients !== undefined) { - localVarQueryParameter['removeClients'] = removeClients; - } - - - - 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 cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClientLogConfiguration', 'id', id) - const localVarPath = `/managed-clusters/{id}/log-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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 a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2025} putClientLogConfigurationRequestV2025 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration: async (id: string, putClientLogConfigurationRequestV2025: PutClientLogConfigurationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putClientLogConfiguration', 'id', id) - // verify required parameter 'putClientLogConfigurationRequestV2025' is not null or undefined - assertParamExists('putClientLogConfiguration', 'putClientLogConfigurationRequestV2025', putClientLogConfigurationRequestV2025) - const localVarPath = `/managed-clusters/{id}/log-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(putClientLogConfigurationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('update', 'id', id) - const localVarPath = `/managed-clusters/{id}/manualUpgrade` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2025 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedCluster', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateManagedCluster', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClustersV2025Api - functional programming interface - * @export - */ -export const ManagedClustersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClustersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2025} managedClusterRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedCluster(managedClusterRequestV2025: ManagedClusterRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedCluster(managedClusterRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.createManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedCluster(id: string, removeClients?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedCluster(id, removeClients, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.deleteManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClientLogConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.getClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedCluster(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedCluster(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.getManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusters(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusters(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.getManagedClusters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2025} putClientLogConfigurationRequestV2025 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putClientLogConfiguration(id: string, putClientLogConfigurationRequestV2025: PutClientLogConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfiguration(id, putClientLogConfigurationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.putClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async update(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.update(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.update']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2025 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedCluster(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedCluster(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2025Api.updateManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClustersV2025Api - factory interface - * @export - */ -export const ManagedClustersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClustersV2025ApiFp(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2025ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster(requestParameters: ManagedClustersV2025ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedCluster(requestParameters.managedClusterRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2025ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster(requestParameters: ManagedClustersV2025ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2025ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration(requestParameters: ManagedClustersV2025ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2025ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster(requestParameters: ManagedClustersV2025ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2025ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters(requestParameters: ManagedClustersV2025ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2025ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration(requestParameters: ManagedClustersV2025ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2025ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update(requestParameters: ManagedClustersV2025ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.update(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2025ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster(requestParameters: ManagedClustersV2025ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedCluster operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiCreateManagedClusterRequest - */ -export interface ManagedClustersV2025ApiCreateManagedClusterRequest { - /** - * - * @type {ManagedClusterRequestV2025} - * @memberof ManagedClustersV2025ApiCreateManagedCluster - */ - readonly managedClusterRequestV2025: ManagedClusterRequestV2025 -} - -/** - * Request parameters for deleteManagedCluster operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiDeleteManagedClusterRequest - */ -export interface ManagedClustersV2025ApiDeleteManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2025ApiDeleteManagedCluster - */ - readonly id: string - - /** - * Flag to determine the need to delete a cluster with clients. - * @type {boolean} - * @memberof ManagedClustersV2025ApiDeleteManagedCluster - */ - readonly removeClients?: boolean -} - -/** - * Request parameters for getClientLogConfiguration operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiGetClientLogConfigurationRequest - */ -export interface ManagedClustersV2025ApiGetClientLogConfigurationRequest { - /** - * ID of managed cluster to get log configuration for. - * @type {string} - * @memberof ManagedClustersV2025ApiGetClientLogConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getManagedCluster operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiGetManagedClusterRequest - */ -export interface ManagedClustersV2025ApiGetManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2025ApiGetManagedCluster - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusters operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiGetManagedClustersRequest - */ -export interface ManagedClustersV2025ApiGetManagedClustersRequest { - /** - * 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 ManagedClustersV2025ApiGetManagedClusters - */ - 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 ManagedClustersV2025ApiGetManagedClusters - */ - 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 ManagedClustersV2025ApiGetManagedClusters - */ - 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @type {string} - * @memberof ManagedClustersV2025ApiGetManagedClusters - */ - readonly filters?: string -} - -/** - * Request parameters for putClientLogConfiguration operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiPutClientLogConfigurationRequest - */ -export interface ManagedClustersV2025ApiPutClientLogConfigurationRequest { - /** - * ID of the managed cluster to update the log configuration for. - * @type {string} - * @memberof ManagedClustersV2025ApiPutClientLogConfiguration - */ - readonly id: string - - /** - * Client log configuration for the given managed cluster. - * @type {PutClientLogConfigurationRequestV2025} - * @memberof ManagedClustersV2025ApiPutClientLogConfiguration - */ - readonly putClientLogConfigurationRequestV2025: PutClientLogConfigurationRequestV2025 -} - -/** - * Request parameters for update operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiUpdateRequest - */ -export interface ManagedClustersV2025ApiUpdateRequest { - /** - * ID of managed cluster to trigger manual upgrade. - * @type {string} - * @memberof ManagedClustersV2025ApiUpdate - */ - readonly id: string -} - -/** - * Request parameters for updateManagedCluster operation in ManagedClustersV2025Api. - * @export - * @interface ManagedClustersV2025ApiUpdateManagedClusterRequest - */ -export interface ManagedClustersV2025ApiUpdateManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2025ApiUpdateManagedCluster - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClustersV2025ApiUpdateManagedCluster - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * ManagedClustersV2025Api - object-oriented interface - * @export - * @class ManagedClustersV2025Api - * @extends {BaseAPI} - */ -export class ManagedClustersV2025Api extends BaseAPI { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2025ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public createManagedCluster(requestParameters: ManagedClustersV2025ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).createManagedCluster(requestParameters.managedClusterRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2025ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public deleteManagedCluster(requestParameters: ManagedClustersV2025ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2025ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public getClientLogConfiguration(requestParameters: ManagedClustersV2025ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2025ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public getManagedCluster(requestParameters: ManagedClustersV2025ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2025ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public getManagedClusters(requestParameters: ManagedClustersV2025ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2025ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public putClientLogConfiguration(requestParameters: ManagedClustersV2025ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2025ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public update(requestParameters: ManagedClustersV2025ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).update(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2025ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2025Api - */ - public updateManagedCluster(requestParameters: ManagedClustersV2025ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2025ApiFp(this.configuration).updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MultiHostIntegrationV2025Api - axios parameter creator - * @export - */ -export const MultiHostIntegrationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2025} multiHostIntegrationsCreateV2025 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration: async (multiHostIntegrationsCreateV2025: MultiHostIntegrationsCreateV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostIntegrationsCreateV2025' is not null or undefined - assertParamExists('createMultiHostIntegration', 'multiHostIntegrationsCreateV2025', multiHostIntegrationsCreateV2025) - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2025 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost: async (multihostId: string, multiHostIntegrationsCreateSourcesV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multihostId', multihostId) - // verify required parameter 'multiHostIntegrationsCreateSourcesV2025' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multiHostIntegrationsCreateSourcesV2025', multiHostIntegrationsCreateSourcesV2025) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateSourcesV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('deleteMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {Array} requestBody The delete bulk sources within multi-host integration request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHostSources: async (multiHostId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('deleteMultiHostSources', 'multiHostId', multiHostId) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteMultiHostSources', 'requestBody', requestBody) - const localVarPath = `/multihosts/{multiHostId}/sources/bulk-delete` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups: async (multihostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getAcctAggregationGroups', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/acctAggregationGroups` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups: async (multiHostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getEntitlementAggregationGroups', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/entitlementAggregationGroups` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getMultiHostIntegrations', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getMultiHostSourceCreationErrors', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/sources/errors` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost: async (multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getSourcesWithinMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testConnectionMultiHostSources', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost: async (multihostId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'multihostId', multihostId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'sourceId', sourceId) - const localVarPath = `/multihosts/{multihostId}/sources/{sourceId}/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2025 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources: async (multihostId: string, updateMultiHostSourcesRequestInnerV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('updateMultiHostSources', 'multihostId', multihostId) - // verify required parameter 'updateMultiHostSourcesRequestInnerV2025' is not null or undefined - assertParamExists('updateMultiHostSources', 'updateMultiHostSourcesRequestInnerV2025', updateMultiHostSourcesRequestInnerV2025) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(updateMultiHostSourcesRequestInnerV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MultiHostIntegrationV2025Api - functional programming interface - * @export - */ -export const MultiHostIntegrationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MultiHostIntegrationV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2025} multiHostIntegrationsCreateV2025 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMultiHostIntegration(multiHostIntegrationsCreateV2025: MultiHostIntegrationsCreateV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMultiHostIntegration(multiHostIntegrationsCreateV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.createMultiHostIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2025 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourcesWithinMultiHost(multihostId: string, multiHostIntegrationsCreateSourcesV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourcesWithinMultiHost(multihostId, multiHostIntegrationsCreateSourcesV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.createSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHost(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHost(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.deleteMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {Array} requestBody The delete bulk sources within multi-host integration request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHostSources(multiHostId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHostSources(multiHostId, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.deleteMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAcctAggregationGroups(multihostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAcctAggregationGroups(multihostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getAcctAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementAggregationGroups(multiHostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementAggregationGroups(multiHostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getEntitlementAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrations(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrations(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getMultiHostIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrationsList(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsList(offset, limit, sorters, filters, count, forSubadmin, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getMultiHostIntegrationsList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostSourceCreationErrors(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostSourceCreationErrors(multiHostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getMultiHostSourceCreationErrors']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultihostIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getMultihostIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourcesWithinMultiHost(multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourcesWithinMultiHost(multihostId, offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.getSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectionMultiHostSources(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionMultiHostSources(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.testConnectionMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnectionMultihost(multihostId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionMultihost(multihostId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.testSourceConnectionMultihost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2025 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMultiHostSources(multihostId: string, updateMultiHostSourcesRequestInnerV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMultiHostSources(multihostId, updateMultiHostSourcesRequestInnerV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2025Api.updateMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MultiHostIntegrationV2025Api - factory interface - * @export - */ -export const MultiHostIntegrationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MultiHostIntegrationV2025ApiFp(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration(requestParameters: MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2025ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost(requestParameters: MultiHostIntegrationV2025ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHostSources(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultihostIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMultiHostIntegration operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest - */ -export interface MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest { - /** - * The specifics of the Multi-Host Integration to create - * @type {MultiHostIntegrationsCreateV2025} - * @memberof MultiHostIntegrationV2025ApiCreateMultiHostIntegration - */ - readonly multiHostIntegrationsCreateV2025: MultiHostIntegrationsCreateV2025 -} - -/** - * Request parameters for createSourcesWithinMultiHost operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * The specifics of the sources to create within Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHost - */ - readonly multiHostIntegrationsCreateSourcesV2025: Array -} - -/** - * Request parameters for deleteMultiHost operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiDeleteMultiHostRequest - */ -export interface MultiHostIntegrationV2025ApiDeleteMultiHostRequest { - /** - * ID of Multi-Host Integration to delete. - * @type {string} - * @memberof MultiHostIntegrationV2025ApiDeleteMultiHost - */ - readonly multihostId: string -} - -/** - * Request parameters for deleteMultiHostSources operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2025ApiDeleteMultiHostSources - */ - readonly multiHostId: string - - /** - * The delete bulk sources within multi-host integration request body - * @type {Array} - * @memberof MultiHostIntegrationV2025ApiDeleteMultiHostSources - */ - readonly requestBody: Array -} - -/** - * Request parameters for getAcctAggregationGroups operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetAcctAggregationGroups - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2025ApiGetAcctAggregationGroups - */ - 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 MultiHostIntegrationV2025ApiGetAcctAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getEntitlementAggregationGroups operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetEntitlementAggregationGroups - */ - readonly multiHostId: string - - /** - * 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 MultiHostIntegrationV2025ApiGetEntitlementAggregationGroups - */ - 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 MultiHostIntegrationV2025ApiGetEntitlementAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getMultiHostIntegrations operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest - */ -export interface MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetMultiHostIntegrations - */ - readonly multihostId: string -} - -/** - * Request parameters for getMultiHostIntegrationsList operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest - */ -export interface MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest { - /** - * 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 MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - 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 MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - readonly sorters?: 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: **type**: *in* **forSubAdminId**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - readonly count?: boolean - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetMultiHostIntegrationsList - */ - readonly forSubadmin?: string -} - -/** - * Request parameters for getMultiHostSourceCreationErrors operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest - */ -export interface MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrors - */ - readonly multiHostId: string -} - -/** - * Request parameters for getSourcesWithinMultiHost operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - 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 MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - readonly sorters?: 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: **id**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2025ApiGetSourcesWithinMultiHost - */ - readonly count?: boolean -} - -/** - * Request parameters for testConnectionMultiHostSources operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2025ApiTestConnectionMultiHostSources - */ - readonly multihostId: string -} - -/** - * Request parameters for testSourceConnectionMultihost operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest - */ -export interface MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2025ApiTestSourceConnectionMultihost - */ - readonly multihostId: string - - /** - * ID of the source within the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2025ApiTestSourceConnectionMultihost - */ - readonly sourceId: string -} - -/** - * Request parameters for updateMultiHostSources operation in MultiHostIntegrationV2025Api. - * @export - * @interface MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration to update. - * @type {string} - * @memberof MultiHostIntegrationV2025ApiUpdateMultiHostSources - */ - readonly multihostId: string - - /** - * This endpoint allows you to update a Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2025ApiUpdateMultiHostSources - */ - readonly updateMultiHostSourcesRequestInnerV2025: Array -} - -/** - * MultiHostIntegrationV2025Api - object-oriented interface - * @export - * @class MultiHostIntegrationV2025Api - * @extends {BaseAPI} - */ -export class MultiHostIntegrationV2025Api extends BaseAPI { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public createMultiHostIntegration(requestParameters: MultiHostIntegrationV2025ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2025ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2025ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public deleteMultiHost(requestParameters: MultiHostIntegrationV2025ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public deleteMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiDeleteMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).deleteMultiHostSources(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2025ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2025ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2025ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getMultihostIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2025ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2025ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2025Api - */ - public updateMultiHostSources(requestParameters: MultiHostIntegrationV2025ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2025ApiFp(this.configuration).updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NonEmployeeLifecycleManagementV2025Api - axios parameter creator - * @export - */ -export const NonEmployeeLifecycleManagementV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2025} nonEmployeeApprovalDecisionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest: async (id: string, nonEmployeeApprovalDecisionV2025: NonEmployeeApprovalDecisionV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeApprovalDecisionV2025' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'nonEmployeeApprovalDecisionV2025', nonEmployeeApprovalDecisionV2025) - const localVarPath = `/non-employee-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecisionV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord: async (nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2025' is not null or undefined - assertParamExists('createNonEmployeeRecord', 'nonEmployeeRequestBodyV2025', nonEmployeeRequestBodyV2025) - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest: async (nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2025' is not null or undefined - assertParamExists('createNonEmployeeRequest', 'nonEmployeeRequestBodyV2025', nonEmployeeRequestBodyV2025) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2025} nonEmployeeSourceRequestBodyV2025 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource: async (nonEmployeeSourceRequestBodyV2025: NonEmployeeSourceRequestBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeSourceRequestBodyV2025' is not null or undefined - assertParamExists('createNonEmployeeSource', 'nonEmployeeSourceRequestBodyV2025', nonEmployeeSourceRequestBodyV2025) - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2025} nonEmployeeSchemaAttributeBodyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes: async (sourceId: string, nonEmployeeSchemaAttributeBodyV2025: NonEmployeeSchemaAttributeBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - // verify required parameter 'nonEmployeeSchemaAttributeBodyV2025' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'nonEmployeeSchemaAttributeBodyV2025', nonEmployeeSchemaAttributeBodyV2025) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2025} deleteNonEmployeeRecordsInBulkRequestV2025 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk: async (deleteNonEmployeeRecordsInBulkRequestV2025: DeleteNonEmployeeRecordsInBulkRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteNonEmployeeRecordsInBulkRequestV2025' is not null or undefined - assertParamExists('deleteNonEmployeeRecordsInBulk', 'deleteNonEmployeeRecordsInBulkRequestV2025', deleteNonEmployeeRecordsInBulkRequestV2025) - const localVarPath = `/non-employee-records/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordsInBulkRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeRecords', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employees/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeSourceSchemaTemplate', 'id', id) - const localVarPath = `/non-employee-sources/{id}/schema-attributes-template/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeApproval', 'id', id) - const localVarPath = `/non-employee-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeDetail !== undefined) { - localVarQueryParameter['include-detail'] = includeDetail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeApprovalSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-approvals/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeBulkUploadStatus', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeRequestSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'id', id) - // verify required parameter 'data' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'data', data) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('listNonEmployeeRequests', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (nonEmployeeCount !== undefined) { - localVarQueryParameter['non-employee-count'] = nonEmployeeCount; - } - - 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, - }; - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2025 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2025 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2025 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource: async (sourceId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2025} nonEmployeeRejectApprovalDecisionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest: async (id: string, nonEmployeeRejectApprovalDecisionV2025: NonEmployeeRejectApprovalDecisionV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeRejectApprovalDecisionV2025' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'nonEmployeeRejectApprovalDecisionV2025', nonEmployeeRejectApprovalDecisionV2025) - const localVarPath = `/non-employee-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecisionV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord: async (id: string, nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'id', id) - // verify required parameter 'nonEmployeeRequestBodyV2025' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'nonEmployeeRequestBodyV2025', nonEmployeeRequestBodyV2025) - const localVarPath = `/non-employee-records/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2025Api - functional programming interface - * @export - */ -export const NonEmployeeLifecycleManagementV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NonEmployeeLifecycleManagementV2025ApiAxiosParamCreator(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2025} nonEmployeeApprovalDecisionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveNonEmployeeRequest(id: string, nonEmployeeApprovalDecisionV2025: NonEmployeeApprovalDecisionV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequest(id, nonEmployeeApprovalDecisionV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.approveNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRecord(nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecord(nonEmployeeRequestBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.createNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRequest(nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequest(nonEmployeeRequestBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.createNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2025} nonEmployeeSourceRequestBodyV2025 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSource(nonEmployeeSourceRequestBodyV2025: NonEmployeeSourceRequestBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSource(nonEmployeeSourceRequestBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.createNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2025} nonEmployeeSchemaAttributeBodyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSourceSchemaAttributes(sourceId: string, nonEmployeeSchemaAttributeBodyV2025: NonEmployeeSchemaAttributeBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributes(sourceId, nonEmployeeSchemaAttributeBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.createNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2025} deleteNonEmployeeRecordsInBulkRequestV2025 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2025: DeleteNonEmployeeRecordsInBulkRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.deleteNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeRecords(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecords(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.exportNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeSourceSchemaTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.exportNonEmployeeSourceSchemaTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApproval(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApproval(id, includeDetail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApprovalSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeBulkUploadStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeBulkUploadStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequestSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeRequestSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.getNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importNonEmployeeRecordsInBulk(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulk(id, data, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.importNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeApprovals(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovals(requestedFor, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.listNonEmployeeApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRecords(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecords(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.listNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRequests(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequests(requestedFor, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.listNonEmployeeRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeSources(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSources(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.listNonEmployeeSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2025 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeRecord(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecord(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.patchNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2025 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttribute(attributeId, sourceId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.patchNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2025 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSource(sourceId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSource(sourceId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.patchNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2025} nonEmployeeRejectApprovalDecisionV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectNonEmployeeRequest(id: string, nonEmployeeRejectApprovalDecisionV2025: NonEmployeeRejectApprovalDecisionV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequest(id, nonEmployeeRejectApprovalDecisionV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.rejectNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2025} nonEmployeeRequestBodyV2025 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateNonEmployeeRecord(id: string, nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecord(id, nonEmployeeRequestBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2025Api.updateNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2025Api - factory interface - * @export - */ -export const NonEmployeeLifecycleManagementV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NonEmployeeLifecycleManagementV2025ApiFp(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeApprovalDecisionV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequest - */ - readonly nonEmployeeApprovalDecisionV2025: NonEmployeeApprovalDecisionV2025 -} - -/** - * Request parameters for createNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest { - /** - * Non-Employee record creation request body. - * @type {NonEmployeeRequestBodyV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025 -} - -/** - * Request parameters for createNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest { - /** - * Non-Employee creation request body - * @type {NonEmployeeRequestBodyV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequest - */ - readonly nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025 -} - -/** - * Request parameters for createNonEmployeeSource operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest { - /** - * Non-Employee source creation request body. - * @type {NonEmployeeSourceRequestBodyV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSource - */ - readonly nonEmployeeSourceRequestBodyV2025: NonEmployeeSourceRequestBodyV2025 -} - -/** - * Request parameters for createNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * - * @type {NonEmployeeSchemaAttributeBodyV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly nonEmployeeSchemaAttributeBodyV2025: NonEmployeeSchemaAttributeBodyV2025 -} - -/** - * Request parameters for deleteNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest { - /** - * Non-Employee bulk delete request body. - * @type {DeleteNonEmployeeRecordsInBulkRequestV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulk - */ - readonly deleteNonEmployeeRecordsInBulkRequestV2025: DeleteNonEmployeeRecordsInBulkRequestV2025 -} - -/** - * Request parameters for deleteNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest { - /** - * Non-Employee request id in the UUID format - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSource operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for exportNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecords - */ - readonly id: string -} - -/** - * Request parameters for exportNonEmployeeSourceSchemaTemplate operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeApproval operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApproval - */ - readonly id: string - - /** - * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApproval - */ - readonly includeDetail?: boolean -} - -/** - * Request parameters for getNonEmployeeApprovalSummary operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest { - /** - * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeBulkUploadStatus operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest { - /** - * Source ID (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatus - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest { - /** - * Non-Employee request id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequestSummary operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest { - /** - * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSource operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for importNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulk - */ - readonly id: string - - /** - * - * @type {File} - * @memberof NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulk - */ - readonly data: File -} - -/** - * Request parameters for listNonEmployeeApprovals operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - readonly requestedFor?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - 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: **approvalStatus**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest { - /** - * 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 NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecords - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecords - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecords - */ - readonly count?: boolean - - /** - * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecords - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecords - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeRequests operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly requestedFor: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly count?: boolean - - /** - * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequests - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeSources operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest { - /** - * 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 NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly count?: boolean - - /** - * Identity the request was made for. Use \'me\' to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly requestedFor?: string - - /** - * Flag that determines whether the API will return a non-employee count associated with the source. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly nonEmployeeCount?: boolean - - /** - * 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: **name, created, sourceId** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSources - */ - readonly sorters?: string -} - -/** - * Request parameters for patchNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecord - */ - readonly id: string - - /** - * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecord - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for patchNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttribute - */ - readonly sourceId: string - - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttribute - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for patchNonEmployeeSource operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSource - */ - readonly sourceId: string - - /** - * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSource - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for rejectNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeRejectApprovalDecisionV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequest - */ - readonly nonEmployeeRejectApprovalDecisionV2025: NonEmployeeRejectApprovalDecisionV2025 -} - -/** - * Request parameters for updateNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2025Api. - * @export - * @interface NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecord - */ - readonly id: string - - /** - * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {NonEmployeeRequestBodyV2025} - * @memberof NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2025: NonEmployeeRequestBodyV2025 -} - -/** - * NonEmployeeLifecycleManagementV2025Api - object-oriented interface - * @export - * @class NonEmployeeLifecycleManagementV2025Api - * @extends {BaseAPI} - */ -export class NonEmployeeLifecycleManagementV2025Api extends BaseAPI { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2025ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2025ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2025ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2025ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2025ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2025ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2025Api - */ - public updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2025ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2025ApiFp(this.configuration).updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NotificationsV2025Api - axios parameter creator - * @export - */ -export const NotificationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2025} domainAddressV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim: async (domainAddressV2025: DomainAddressV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'domainAddressV2025' is not null or undefined - assertParamExists('createDomainDkim', 'domainAddressV2025', domainAddressV2025) - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(domainAddressV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2025} templateDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate: async (templateDtoV2025: TemplateDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateDtoV2025' is not null or undefined - assertParamExists('createNotificationTemplate', 'templateDtoV2025', templateDtoV2025) - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2025} emailStatusDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress: async (emailStatusDtoV2025: EmailStatusDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'emailStatusDtoV2025' is not null or undefined - assertParamExists('createVerifiedFromAddress', 'emailStatusDtoV2025', emailStatusDtoV2025) - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailStatusDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk: async (templateBulkDeleteDtoV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateBulkDeleteDtoV2025' is not null or undefined - assertParamExists('deleteNotificationTemplatesInBulk', 'templateBulkDeleteDtoV2025', templateBulkDeleteDtoV2025) - const localVarPath = `/notification-templates/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateBulkDeleteDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteVerifiedFromAddress', 'id', id) - const localVarPath = `/verified-from-addresses/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes: async (identity: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identity' is not null or undefined - assertParamExists('getMailFromAttributes', 'identity', identity) - const localVarPath = `/mail-from-attributes/{identity}` - .replace(`{${"identity"}}`, encodeURIComponent(String(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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-preferences/{key}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNotificationTemplate', 'id', id) - const localVarPath = `/notification-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-defaults`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2025} mailFromAttributesDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes: async (mailFromAttributesDtoV2025: MailFromAttributesDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mailFromAttributesDtoV2025' is not null or undefined - assertParamExists('putMailFromAttributes', 'mailFromAttributesDtoV2025', mailFromAttributesDtoV2025) - const localVarPath = `/mail-from-attributes`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mailFromAttributesDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2025} sendTestNotificationRequestDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification: async (sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTestNotificationRequestDtoV2025' is not null or undefined - assertParamExists('sendTestNotification', 'sendTestNotificationRequestDtoV2025', sendTestNotificationRequestDtoV2025) - const localVarPath = `/send-test-notification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTestNotificationRequestDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NotificationsV2025Api - functional programming interface - * @export - */ -export const NotificationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NotificationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2025} domainAddressV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDomainDkim(domainAddressV2025: DomainAddressV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkim(domainAddressV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.createDomainDkim']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2025} templateDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNotificationTemplate(templateDtoV2025: TemplateDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplate(templateDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.createNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2025} emailStatusDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createVerifiedFromAddress(emailStatusDtoV2025: EmailStatusDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddress(emailStatusDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.createVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.deleteNotificationTemplatesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddress(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.deleteVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributes(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.getDkimAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMailFromAttributes(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributes(identity, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.getMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationPreferences(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.getNotificationPreferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.getNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.getNotificationsTemplateContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddresses(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.listFromAddresses']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaults(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.listNotificationTemplateDefaults']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplates(limit, offset, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.listNotificationTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2025} mailFromAttributesDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putMailFromAttributes(mailFromAttributesDtoV2025: MailFromAttributesDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributes(mailFromAttributesDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.putMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2025} sendTestNotificationRequestDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTestNotification(sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotification(sendTestNotificationRequestDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2025Api.sendTestNotification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NotificationsV2025Api - factory interface - * @export - */ -export const NotificationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NotificationsV2025ApiFp(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2025ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim(requestParameters: NotificationsV2025ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDomainDkim(requestParameters.domainAddressV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2025ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate(requestParameters: NotificationsV2025ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNotificationTemplate(requestParameters.templateDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2025ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress(requestParameters: NotificationsV2025ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createVerifiedFromAddress(requestParameters.emailStatusDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2025ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress(requestParameters: NotificationsV2025ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2025ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes(requestParameters: NotificationsV2025ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2025ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes(requestParameters: NotificationsV2025ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationPreferences(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2025ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate(requestParameters: NotificationsV2025ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationsTemplateContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2025ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses(requestParameters: NotificationsV2025ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2025ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults(requestParameters: NotificationsV2025ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2025ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates(requestParameters: NotificationsV2025ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2025ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes(requestParameters: NotificationsV2025ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putMailFromAttributes(requestParameters.mailFromAttributesDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2025ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification(requestParameters: NotificationsV2025ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDomainDkim operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiCreateDomainDkimRequest - */ -export interface NotificationsV2025ApiCreateDomainDkimRequest { - /** - * - * @type {DomainAddressV2025} - * @memberof NotificationsV2025ApiCreateDomainDkim - */ - readonly domainAddressV2025: DomainAddressV2025 -} - -/** - * Request parameters for createNotificationTemplate operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiCreateNotificationTemplateRequest - */ -export interface NotificationsV2025ApiCreateNotificationTemplateRequest { - /** - * - * @type {TemplateDtoV2025} - * @memberof NotificationsV2025ApiCreateNotificationTemplate - */ - readonly templateDtoV2025: TemplateDtoV2025 -} - -/** - * Request parameters for createVerifiedFromAddress operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiCreateVerifiedFromAddressRequest - */ -export interface NotificationsV2025ApiCreateVerifiedFromAddressRequest { - /** - * - * @type {EmailStatusDtoV2025} - * @memberof NotificationsV2025ApiCreateVerifiedFromAddress - */ - readonly emailStatusDtoV2025: EmailStatusDtoV2025 -} - -/** - * Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest - */ -export interface NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest { - /** - * - * @type {Array} - * @memberof NotificationsV2025ApiDeleteNotificationTemplatesInBulk - */ - readonly templateBulkDeleteDtoV2025: Array -} - -/** - * Request parameters for deleteVerifiedFromAddress operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiDeleteVerifiedFromAddressRequest - */ -export interface NotificationsV2025ApiDeleteVerifiedFromAddressRequest { - /** - * Unique identifier of the verified sender address to delete. - * @type {string} - * @memberof NotificationsV2025ApiDeleteVerifiedFromAddress - */ - readonly id: string -} - -/** - * Request parameters for getDkimAttributes operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiGetDkimAttributesRequest - */ -export interface NotificationsV2025ApiGetDkimAttributesRequest { - /** - * 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 NotificationsV2025ApiGetDkimAttributes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2025ApiGetDkimAttributes - */ - readonly offset?: number -} - -/** - * Request parameters for getMailFromAttributes operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiGetMailFromAttributesRequest - */ -export interface NotificationsV2025ApiGetMailFromAttributesRequest { - /** - * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @type {string} - * @memberof NotificationsV2025ApiGetMailFromAttributes - */ - readonly identity: string -} - -/** - * Request parameters for getNotificationTemplate operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiGetNotificationTemplateRequest - */ -export interface NotificationsV2025ApiGetNotificationTemplateRequest { - /** - * Id of the Notification Template - * @type {string} - * @memberof NotificationsV2025ApiGetNotificationTemplate - */ - readonly id: string -} - -/** - * Request parameters for listFromAddresses operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiListFromAddressesRequest - */ -export interface NotificationsV2025ApiListFromAddressesRequest { - /** - * 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 NotificationsV2025ApiListFromAddresses - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2025ApiListFromAddresses - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NotificationsV2025ApiListFromAddresses - */ - 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: **email**: *eq, ge, le, gt, lt* - * @type {string} - * @memberof NotificationsV2025ApiListFromAddresses - */ - 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: **email** - * @type {string} - * @memberof NotificationsV2025ApiListFromAddresses - */ - readonly sorters?: string -} - -/** - * Request parameters for listNotificationTemplateDefaults operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiListNotificationTemplateDefaultsRequest - */ -export interface NotificationsV2025ApiListNotificationTemplateDefaultsRequest { - /** - * 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 NotificationsV2025ApiListNotificationTemplateDefaults - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2025ApiListNotificationTemplateDefaults - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2025ApiListNotificationTemplateDefaults - */ - readonly filters?: string -} - -/** - * Request parameters for listNotificationTemplates operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiListNotificationTemplatesRequest - */ -export interface NotificationsV2025ApiListNotificationTemplatesRequest { - /** - * 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 NotificationsV2025ApiListNotificationTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2025ApiListNotificationTemplates - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2025ApiListNotificationTemplates - */ - 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: **key, name, medium** - * @type {string} - * @memberof NotificationsV2025ApiListNotificationTemplates - */ - readonly sorters?: string -} - -/** - * Request parameters for putMailFromAttributes operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiPutMailFromAttributesRequest - */ -export interface NotificationsV2025ApiPutMailFromAttributesRequest { - /** - * - * @type {MailFromAttributesDtoV2025} - * @memberof NotificationsV2025ApiPutMailFromAttributes - */ - readonly mailFromAttributesDtoV2025: MailFromAttributesDtoV2025 -} - -/** - * Request parameters for sendTestNotification operation in NotificationsV2025Api. - * @export - * @interface NotificationsV2025ApiSendTestNotificationRequest - */ -export interface NotificationsV2025ApiSendTestNotificationRequest { - /** - * - * @type {SendTestNotificationRequestDtoV2025} - * @memberof NotificationsV2025ApiSendTestNotification - */ - readonly sendTestNotificationRequestDtoV2025: SendTestNotificationRequestDtoV2025 -} - -/** - * NotificationsV2025Api - object-oriented interface - * @export - * @class NotificationsV2025Api - * @extends {BaseAPI} - */ -export class NotificationsV2025Api extends BaseAPI { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2025ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public createDomainDkim(requestParameters: NotificationsV2025ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).createDomainDkim(requestParameters.domainAddressV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2025ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public createNotificationTemplate(requestParameters: NotificationsV2025ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).createNotificationTemplate(requestParameters.templateDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2025ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public createVerifiedFromAddress(requestParameters: NotificationsV2025ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).createVerifiedFromAddress(requestParameters.emailStatusDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2025ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2025ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public deleteVerifiedFromAddress(requestParameters: NotificationsV2025ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2025ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public getDkimAttributes(requestParameters: NotificationsV2025ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2025ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public getMailFromAttributes(requestParameters: NotificationsV2025ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).getNotificationPreferences(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2025ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public getNotificationTemplate(requestParameters: NotificationsV2025ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).getNotificationsTemplateContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2025ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public listFromAddresses(requestParameters: NotificationsV2025ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2025ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public listNotificationTemplateDefaults(requestParameters: NotificationsV2025ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2025ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public listNotificationTemplates(requestParameters: NotificationsV2025ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2025ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public putMailFromAttributes(requestParameters: NotificationsV2025ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).putMailFromAttributes(requestParameters.mailFromAttributesDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2025ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2025Api - */ - public sendTestNotification(requestParameters: NotificationsV2025ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2025ApiFp(this.configuration).sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OAuthClientsV2025Api - axios parameter creator - * @export - */ -export const OAuthClientsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2025} createOAuthClientRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient: async (createOAuthClientRequestV2025: CreateOAuthClientRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createOAuthClientRequestV2025' is not null or undefined - assertParamExists('createOauthClient', 'createOAuthClientRequestV2025', createOAuthClientRequestV2025) - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2025 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchOauthClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchOauthClient', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OAuthClientsV2025Api - functional programming interface - * @export - */ -export const OAuthClientsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OAuthClientsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2025} createOAuthClientRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createOauthClient(createOAuthClientRequestV2025: CreateOAuthClientRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClient(createOAuthClientRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2025Api.createOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2025Api.deleteOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2025Api.getOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOauthClients(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClients(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2025Api.listOauthClients']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2025 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOauthClient(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClient(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2025Api.patchOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OAuthClientsV2025Api - factory interface - * @export - */ -export const OAuthClientsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OAuthClientsV2025ApiFp(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2025ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient(requestParameters: OAuthClientsV2025ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createOauthClient(requestParameters.createOAuthClientRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2025ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient(requestParameters: OAuthClientsV2025ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2025ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient(requestParameters: OAuthClientsV2025ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2025ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients(requestParameters: OAuthClientsV2025ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2025ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient(requestParameters: OAuthClientsV2025ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createOauthClient operation in OAuthClientsV2025Api. - * @export - * @interface OAuthClientsV2025ApiCreateOauthClientRequest - */ -export interface OAuthClientsV2025ApiCreateOauthClientRequest { - /** - * - * @type {CreateOAuthClientRequestV2025} - * @memberof OAuthClientsV2025ApiCreateOauthClient - */ - readonly createOAuthClientRequestV2025: CreateOAuthClientRequestV2025 -} - -/** - * Request parameters for deleteOauthClient operation in OAuthClientsV2025Api. - * @export - * @interface OAuthClientsV2025ApiDeleteOauthClientRequest - */ -export interface OAuthClientsV2025ApiDeleteOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2025ApiDeleteOauthClient - */ - readonly id: string -} - -/** - * Request parameters for getOauthClient operation in OAuthClientsV2025Api. - * @export - * @interface OAuthClientsV2025ApiGetOauthClientRequest - */ -export interface OAuthClientsV2025ApiGetOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2025ApiGetOauthClient - */ - readonly id: string -} - -/** - * Request parameters for listOauthClients operation in OAuthClientsV2025Api. - * @export - * @interface OAuthClientsV2025ApiListOauthClientsRequest - */ -export interface OAuthClientsV2025ApiListOauthClientsRequest { - /** - * 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof OAuthClientsV2025ApiListOauthClients - */ - readonly filters?: string -} - -/** - * Request parameters for patchOauthClient operation in OAuthClientsV2025Api. - * @export - * @interface OAuthClientsV2025ApiPatchOauthClientRequest - */ -export interface OAuthClientsV2025ApiPatchOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2025ApiPatchOauthClient - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @type {Array} - * @memberof OAuthClientsV2025ApiPatchOauthClient - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * OAuthClientsV2025Api - object-oriented interface - * @export - * @class OAuthClientsV2025Api - * @extends {BaseAPI} - */ -export class OAuthClientsV2025Api extends BaseAPI { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2025ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2025Api - */ - public createOauthClient(requestParameters: OAuthClientsV2025ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2025ApiFp(this.configuration).createOauthClient(requestParameters.createOAuthClientRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2025ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2025Api - */ - public deleteOauthClient(requestParameters: OAuthClientsV2025ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2025ApiFp(this.configuration).deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2025ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2025Api - */ - public getOauthClient(requestParameters: OAuthClientsV2025ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2025ApiFp(this.configuration).getOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2025ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2025Api - */ - public listOauthClients(requestParameters: OAuthClientsV2025ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2025ApiFp(this.configuration).listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2025ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2025Api - */ - public patchOauthClient(requestParameters: OAuthClientsV2025ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2025ApiFp(this.configuration).patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OrgConfigV2025Api - axios parameter creator - * @export - */ -export const OrgConfigV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones: async (xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/org-config/valid-time-zones`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2025 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig: async (jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchOrgConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OrgConfigV2025Api - functional programming interface - * @export - */ -export const OrgConfigV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrgConfigV2025ApiAxiosParamCreator(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2025Api.getOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getValidTimeZones(xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZones(xSailPointExperimental, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2025Api.getValidTimeZones']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2025 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOrgConfig(jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfig(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2025Api.patchOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OrgConfigV2025Api - factory interface - * @export - */ -export const OrgConfigV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrgConfigV2025ApiFp(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2025ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones(requestParameters: OrgConfigV2025ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2025ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig(requestParameters: OrgConfigV2025ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOrgConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getValidTimeZones operation in OrgConfigV2025Api. - * @export - * @interface OrgConfigV2025ApiGetValidTimeZonesRequest - */ -export interface OrgConfigV2025ApiGetValidTimeZonesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof OrgConfigV2025ApiGetValidTimeZones - */ - readonly xSailPointExperimental?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2025ApiGetValidTimeZones - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2025ApiGetValidTimeZones - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof OrgConfigV2025ApiGetValidTimeZones - */ - readonly count?: boolean -} - -/** - * Request parameters for patchOrgConfig operation in OrgConfigV2025Api. - * @export - * @interface OrgConfigV2025ApiPatchOrgConfigRequest - */ -export interface OrgConfigV2025ApiPatchOrgConfigRequest { - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof OrgConfigV2025ApiPatchOrgConfig - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * OrgConfigV2025Api - object-oriented interface - * @export - * @class OrgConfigV2025Api - * @extends {BaseAPI} - */ -export class OrgConfigV2025Api extends BaseAPI { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2025Api - */ - public getOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2025ApiFp(this.configuration).getOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2025ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2025Api - */ - public getValidTimeZones(requestParameters: OrgConfigV2025ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2025ApiFp(this.configuration).getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2025ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2025Api - */ - public patchOrgConfig(requestParameters: OrgConfigV2025ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2025ApiFp(this.configuration).patchOrgConfig(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ParameterStorageV2025Api - axios parameter creator - * @export - */ -export const ParameterStorageV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageNewParameterV2025} [parameterStorageNewParameterV2025] The parameter to add to the store. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createParameter: async (parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/parameter-storage/parameters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(parameterStorageNewParameterV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {string} id The ID of the parameter to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteParameter: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {string} key Base64Url encoded NIST P-384 public key - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAttestationDocument: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAttestationDocument', 'key', key) - const localVarPath = `/parameter-storage/attestation`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (key !== undefined) { - localVarQueryParameter['key'] = key; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {string} id The ID of the parameter to be fetched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameter: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {string} id The ID of the parameter which you want to fetch the references for. - * @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, consumerId, parameterId, name, usageHint** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterReferences: async (id: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getParameterReferences', 'id', id) - const localVarPath = `/parameter-storage/parameters/{id}/references` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterStorageSpecification: async (acceptLanguage?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (acceptLanguage === undefined) { - acceptLanguage = 'en'; - } - - const localVarPath = `/parameter-storage/specification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (acceptLanguage != null) { - localVarHeaderParameter['Accept-Language'] = String(acceptLanguage); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchParameters: async (filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/parameter-storage/parameters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {string} id The ID of the parameter to be updated. - * @param {ParameterStorageUpdateParameterV2025} [parameterStorageUpdateParameterV2025] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateParameter: async (id: string, parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(parameterStorageUpdateParameterV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ParameterStorageV2025Api - functional programming interface - * @export - */ -export const ParameterStorageV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ParameterStorageV2025ApiAxiosParamCreator(configuration) - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageNewParameterV2025} [parameterStorageNewParameterV2025] The parameter to add to the store. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createParameter(parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createParameter(parameterStorageNewParameterV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.createParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {string} id The ID of the parameter to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteParameter(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.deleteParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {string} key Base64Url encoded NIST P-384 public key - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAttestationDocument(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAttestationDocument(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.getAttestationDocument']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {string} id The ID of the parameter to be fetched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameter(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.getParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {string} id The ID of the parameter which you want to fetch the references for. - * @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, consumerId, parameterId, name, usageHint** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameterReferences(id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterReferences(id, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.getParameterReferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameterStorageSpecification(acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterStorageSpecification(acceptLanguage, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.getParameterStorageSpecification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchParameters(filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchParameters(filters, sorters, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.searchParameters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {string} id The ID of the parameter to be updated. - * @param {ParameterStorageUpdateParameterV2025} [parameterStorageUpdateParameterV2025] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateParameter(id: string, parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateParameter(id, parameterStorageUpdateParameterV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2025Api.updateParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ParameterStorageV2025Api - factory interface - * @export - */ -export const ParameterStorageV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ParameterStorageV2025ApiFp(configuration) - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageV2025ApiCreateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createParameter(requestParameters: ParameterStorageV2025ApiCreateParameterRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createParameter(requestParameters.parameterStorageNewParameterV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {ParameterStorageV2025ApiDeleteParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteParameter(requestParameters: ParameterStorageV2025ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteParameter(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {ParameterStorageV2025ApiGetAttestationDocumentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAttestationDocument(requestParameters: ParameterStorageV2025ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAttestationDocument(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {ParameterStorageV2025ApiGetParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameter(requestParameters: ParameterStorageV2025ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getParameter(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {ParameterStorageV2025ApiGetParameterReferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterReferences(requestParameters: ParameterStorageV2025ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getParameterReferences(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {ParameterStorageV2025ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterStorageSpecification(requestParameters: ParameterStorageV2025ApiGetParameterStorageSpecificationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getParameterStorageSpecification(requestParameters.acceptLanguage, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @param {ParameterStorageV2025ApiSearchParametersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchParameters(requestParameters: ParameterStorageV2025ApiSearchParametersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchParameters(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {ParameterStorageV2025ApiUpdateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateParameter(requestParameters: ParameterStorageV2025ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateParameter(requestParameters.id, requestParameters.parameterStorageUpdateParameterV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createParameter operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiCreateParameterRequest - */ -export interface ParameterStorageV2025ApiCreateParameterRequest { - /** - * The parameter to add to the store. - * @type {ParameterStorageNewParameterV2025} - * @memberof ParameterStorageV2025ApiCreateParameter - */ - readonly parameterStorageNewParameterV2025?: ParameterStorageNewParameterV2025 -} - -/** - * Request parameters for deleteParameter operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiDeleteParameterRequest - */ -export interface ParameterStorageV2025ApiDeleteParameterRequest { - /** - * The ID of the parameter to be deleted. - * @type {string} - * @memberof ParameterStorageV2025ApiDeleteParameter - */ - readonly id: string -} - -/** - * Request parameters for getAttestationDocument operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiGetAttestationDocumentRequest - */ -export interface ParameterStorageV2025ApiGetAttestationDocumentRequest { - /** - * Base64Url encoded NIST P-384 public key - * @type {string} - * @memberof ParameterStorageV2025ApiGetAttestationDocument - */ - readonly key: string -} - -/** - * Request parameters for getParameter operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiGetParameterRequest - */ -export interface ParameterStorageV2025ApiGetParameterRequest { - /** - * The ID of the parameter to be fetched - * @type {string} - * @memberof ParameterStorageV2025ApiGetParameter - */ - readonly id: string -} - -/** - * Request parameters for getParameterReferences operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiGetParameterReferencesRequest - */ -export interface ParameterStorageV2025ApiGetParameterReferencesRequest { - /** - * The ID of the parameter which you want to fetch the references for. - * @type {string} - * @memberof ParameterStorageV2025ApiGetParameterReferences - */ - readonly id: 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, consumerId, parameterId, name, usageHint** - * @type {string} - * @memberof ParameterStorageV2025ApiGetParameterReferences - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ParameterStorageV2025ApiGetParameterReferences - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ParameterStorageV2025ApiGetParameterReferences - */ - readonly offset?: number -} - -/** - * Request parameters for getParameterStorageSpecification operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiGetParameterStorageSpecificationRequest - */ -export interface ParameterStorageV2025ApiGetParameterStorageSpecificationRequest { - /** - * The i18n internationalization code for the language that the spec is in. Defaults to english. - * @type {string} - * @memberof ParameterStorageV2025ApiGetParameterStorageSpecification - */ - readonly acceptLanguage?: string -} - -/** - * Request parameters for searchParameters operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiSearchParametersRequest - */ -export interface ParameterStorageV2025ApiSearchParametersRequest { - /** - * 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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @type {string} - * @memberof ParameterStorageV2025ApiSearchParameters - */ - 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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @type {string} - * @memberof ParameterStorageV2025ApiSearchParameters - */ - readonly sorters?: string - - /** - * 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 ParameterStorageV2025ApiSearchParameters - */ - 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 ParameterStorageV2025ApiSearchParameters - */ - readonly limit?: number -} - -/** - * Request parameters for updateParameter operation in ParameterStorageV2025Api. - * @export - * @interface ParameterStorageV2025ApiUpdateParameterRequest - */ -export interface ParameterStorageV2025ApiUpdateParameterRequest { - /** - * The ID of the parameter to be updated. - * @type {string} - * @memberof ParameterStorageV2025ApiUpdateParameter - */ - readonly id: string - - /** - * The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @type {ParameterStorageUpdateParameterV2025} - * @memberof ParameterStorageV2025ApiUpdateParameter - */ - readonly parameterStorageUpdateParameterV2025?: ParameterStorageUpdateParameterV2025 -} - -/** - * ParameterStorageV2025Api - object-oriented interface - * @export - * @class ParameterStorageV2025Api - * @extends {BaseAPI} - */ -export class ParameterStorageV2025Api extends BaseAPI { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageV2025ApiCreateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public createParameter(requestParameters: ParameterStorageV2025ApiCreateParameterRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).createParameter(requestParameters.parameterStorageNewParameterV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {ParameterStorageV2025ApiDeleteParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public deleteParameter(requestParameters: ParameterStorageV2025ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).deleteParameter(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {ParameterStorageV2025ApiGetAttestationDocumentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public getAttestationDocument(requestParameters: ParameterStorageV2025ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).getAttestationDocument(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {ParameterStorageV2025ApiGetParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public getParameter(requestParameters: ParameterStorageV2025ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).getParameter(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {ParameterStorageV2025ApiGetParameterReferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public getParameterReferences(requestParameters: ParameterStorageV2025ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).getParameterReferences(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {ParameterStorageV2025ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public getParameterStorageSpecification(requestParameters: ParameterStorageV2025ApiGetParameterStorageSpecificationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).getParameterStorageSpecification(requestParameters.acceptLanguage, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @param {ParameterStorageV2025ApiSearchParametersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public searchParameters(requestParameters: ParameterStorageV2025ApiSearchParametersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).searchParameters(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {ParameterStorageV2025ApiUpdateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2025Api - */ - public updateParameter(requestParameters: ParameterStorageV2025ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2025ApiFp(this.configuration).updateParameter(requestParameters.id, requestParameters.parameterStorageUpdateParameterV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordConfigurationV2025Api - axios parameter creator - * @export - */ -export const PasswordConfigurationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2025} passwordOrgConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig: async (passwordOrgConfigV2025: PasswordOrgConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2025' is not null or undefined - assertParamExists('createPasswordOrgConfig', 'passwordOrgConfigV2025', passwordOrgConfigV2025) - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2025} passwordOrgConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig: async (passwordOrgConfigV2025: PasswordOrgConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2025' is not null or undefined - assertParamExists('putPasswordOrgConfig', 'passwordOrgConfigV2025', passwordOrgConfigV2025) - const localVarPath = `/password-org-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordConfigurationV2025Api - functional programming interface - * @export - */ -export const PasswordConfigurationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordConfigurationV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2025} passwordOrgConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordOrgConfig(passwordOrgConfigV2025: PasswordOrgConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfig(passwordOrgConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2025Api.createPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2025Api.getPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2025} passwordOrgConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordOrgConfig(passwordOrgConfigV2025: PasswordOrgConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfig(passwordOrgConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2025Api.putPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordConfigurationV2025Api - factory interface - * @export - */ -export const PasswordConfigurationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordConfigurationV2025ApiFp(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig(requestParameters: PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordOrgConfig(requestParameters.passwordOrgConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig(requestParameters: PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordOrgConfig(requestParameters.passwordOrgConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordOrgConfig operation in PasswordConfigurationV2025Api. - * @export - * @interface PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2025} - * @memberof PasswordConfigurationV2025ApiCreatePasswordOrgConfig - */ - readonly passwordOrgConfigV2025: PasswordOrgConfigV2025 -} - -/** - * Request parameters for putPasswordOrgConfig operation in PasswordConfigurationV2025Api. - * @export - * @interface PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2025} - * @memberof PasswordConfigurationV2025ApiPutPasswordOrgConfig - */ - readonly passwordOrgConfigV2025: PasswordOrgConfigV2025 -} - -/** - * PasswordConfigurationV2025Api - object-oriented interface - * @export - * @class PasswordConfigurationV2025Api - * @extends {BaseAPI} - */ -export class PasswordConfigurationV2025Api extends BaseAPI { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2025Api - */ - public createPasswordOrgConfig(requestParameters: PasswordConfigurationV2025ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2025ApiFp(this.configuration).createPasswordOrgConfig(requestParameters.passwordOrgConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2025Api - */ - public getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2025ApiFp(this.configuration).getPasswordOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2025Api - */ - public putPasswordOrgConfig(requestParameters: PasswordConfigurationV2025ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2025ApiFp(this.configuration).putPasswordOrgConfig(requestParameters.passwordOrgConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordDictionaryV2025Api - axios parameter creator - * @export - */ -export const PasswordDictionaryV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordDictionaryV2025Api - functional programming interface - * @export - */ -export const PasswordDictionaryV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordDictionaryV2025ApiAxiosParamCreator(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2025Api.getPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordDictionary(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionary(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2025Api.putPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordDictionaryV2025Api - factory interface - * @export - */ -export const PasswordDictionaryV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordDictionaryV2025ApiFp(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordDictionary(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2025ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary(requestParameters: PasswordDictionaryV2025ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for putPasswordDictionary operation in PasswordDictionaryV2025Api. - * @export - * @interface PasswordDictionaryV2025ApiPutPasswordDictionaryRequest - */ -export interface PasswordDictionaryV2025ApiPutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PasswordDictionaryV2025ApiPutPasswordDictionary - */ - readonly file?: File -} - -/** - * PasswordDictionaryV2025Api - object-oriented interface - * @export - * @class PasswordDictionaryV2025Api - * @extends {BaseAPI} - */ -export class PasswordDictionaryV2025Api extends BaseAPI { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2025Api - */ - public getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2025ApiFp(this.configuration).getPasswordDictionary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2025ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2025Api - */ - public putPasswordDictionary(requestParameters: PasswordDictionaryV2025ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2025ApiFp(this.configuration).putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordManagementV2025Api - axios parameter creator - * @export - */ -export const PasswordManagementV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2025} passwordDigitTokenResetV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken: async (passwordDigitTokenResetV2025: PasswordDigitTokenResetV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordDigitTokenResetV2025' is not null or undefined - assertParamExists('createDigitToken', 'passwordDigitTokenResetV2025', passwordDigitTokenResetV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/generate-password-reset-token/digit`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordDigitTokenResetV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordChangeStatus', 'id', id) - const localVarPath = `/password-change-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2025} passwordInfoQueryDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo: async (passwordInfoQueryDTOV2025: PasswordInfoQueryDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordInfoQueryDTOV2025' is not null or undefined - assertParamExists('queryPasswordInfo', 'passwordInfoQueryDTOV2025', passwordInfoQueryDTOV2025) - const localVarPath = `/query-password-info`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordInfoQueryDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2025} passwordChangeRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword: async (passwordChangeRequestV2025: PasswordChangeRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordChangeRequestV2025' is not null or undefined - assertParamExists('setPassword', 'passwordChangeRequestV2025', passwordChangeRequestV2025) - const localVarPath = `/set-password`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordChangeRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordManagementV2025Api - functional programming interface - * @export - */ -export const PasswordManagementV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordManagementV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2025} passwordDigitTokenResetV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDigitToken(passwordDigitTokenResetV2025: PasswordDigitTokenResetV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDigitToken(passwordDigitTokenResetV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2025Api.createDigitToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordChangeStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordChangeStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2025Api.getPasswordChangeStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2025} passwordInfoQueryDTOV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async queryPasswordInfo(passwordInfoQueryDTOV2025: PasswordInfoQueryDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfo(passwordInfoQueryDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2025Api.queryPasswordInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2025} passwordChangeRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPassword(passwordChangeRequestV2025: PasswordChangeRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPassword(passwordChangeRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2025Api.setPassword']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordManagementV2025Api - factory interface - * @export - */ -export const PasswordManagementV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordManagementV2025ApiFp(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2025ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken(requestParameters: PasswordManagementV2025ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDigitToken(requestParameters.passwordDigitTokenResetV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2025ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus(requestParameters: PasswordManagementV2025ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2025ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo(requestParameters: PasswordManagementV2025ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2025ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword(requestParameters: PasswordManagementV2025ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPassword(requestParameters.passwordChangeRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDigitToken operation in PasswordManagementV2025Api. - * @export - * @interface PasswordManagementV2025ApiCreateDigitTokenRequest - */ -export interface PasswordManagementV2025ApiCreateDigitTokenRequest { - /** - * - * @type {PasswordDigitTokenResetV2025} - * @memberof PasswordManagementV2025ApiCreateDigitToken - */ - readonly passwordDigitTokenResetV2025: PasswordDigitTokenResetV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordManagementV2025ApiCreateDigitToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPasswordChangeStatus operation in PasswordManagementV2025Api. - * @export - * @interface PasswordManagementV2025ApiGetPasswordChangeStatusRequest - */ -export interface PasswordManagementV2025ApiGetPasswordChangeStatusRequest { - /** - * Password change request ID - * @type {string} - * @memberof PasswordManagementV2025ApiGetPasswordChangeStatus - */ - readonly id: string -} - -/** - * Request parameters for queryPasswordInfo operation in PasswordManagementV2025Api. - * @export - * @interface PasswordManagementV2025ApiQueryPasswordInfoRequest - */ -export interface PasswordManagementV2025ApiQueryPasswordInfoRequest { - /** - * - * @type {PasswordInfoQueryDTOV2025} - * @memberof PasswordManagementV2025ApiQueryPasswordInfo - */ - readonly passwordInfoQueryDTOV2025: PasswordInfoQueryDTOV2025 -} - -/** - * Request parameters for setPassword operation in PasswordManagementV2025Api. - * @export - * @interface PasswordManagementV2025ApiSetPasswordRequest - */ -export interface PasswordManagementV2025ApiSetPasswordRequest { - /** - * - * @type {PasswordChangeRequestV2025} - * @memberof PasswordManagementV2025ApiSetPassword - */ - readonly passwordChangeRequestV2025: PasswordChangeRequestV2025 -} - -/** - * PasswordManagementV2025Api - object-oriented interface - * @export - * @class PasswordManagementV2025Api - * @extends {BaseAPI} - */ -export class PasswordManagementV2025Api extends BaseAPI { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2025ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2025Api - */ - public createDigitToken(requestParameters: PasswordManagementV2025ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2025ApiFp(this.configuration).createDigitToken(requestParameters.passwordDigitTokenResetV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2025ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2025Api - */ - public getPasswordChangeStatus(requestParameters: PasswordManagementV2025ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2025ApiFp(this.configuration).getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2025ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2025Api - */ - public queryPasswordInfo(requestParameters: PasswordManagementV2025ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2025ApiFp(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2025ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2025Api - */ - public setPassword(requestParameters: PasswordManagementV2025ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2025ApiFp(this.configuration).setPassword(requestParameters.passwordChangeRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordPoliciesV2025Api - axios parameter creator - * @export - */ -export const PasswordPoliciesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2025} passwordPolicyV3DtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy: async (passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordPolicyV3DtoV2025' is not null or undefined - assertParamExists('createPasswordPolicy', 'passwordPolicyV3DtoV2025', passwordPolicyV3DtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordPolicy', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordPolicyById', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies: async (limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2025} passwordPolicyV3DtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy: async (id: string, passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setPasswordPolicy', 'id', id) - // verify required parameter 'passwordPolicyV3DtoV2025' is not null or undefined - assertParamExists('setPasswordPolicy', 'passwordPolicyV3DtoV2025', passwordPolicyV3DtoV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordPoliciesV2025Api - functional programming interface - * @export - */ -export const PasswordPoliciesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordPoliciesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2025} passwordPolicyV3DtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordPolicy(passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicy(passwordPolicyV3DtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2025Api.createPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordPolicy(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicy(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2025Api.deletePasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordPolicyById(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyById(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2025Api.getPasswordPolicyById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicies(limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicies(limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2025Api.listPasswordPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2025} passwordPolicyV3DtoV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPasswordPolicy(id: string, passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicy(id, passwordPolicyV3DtoV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2025Api.setPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordPoliciesV2025Api - factory interface - * @export - */ -export const PasswordPoliciesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordPoliciesV2025ApiFp(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2025ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy(requestParameters: PasswordPoliciesV2025ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2025ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy(requestParameters: PasswordPoliciesV2025ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordPolicy(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById(requestParameters: PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordPolicyById(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2025ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies(requestParameters: PasswordPoliciesV2025ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2025ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy(requestParameters: PasswordPoliciesV2025ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordPolicy operation in PasswordPoliciesV2025Api. - * @export - * @interface PasswordPoliciesV2025ApiCreatePasswordPolicyRequest - */ -export interface PasswordPoliciesV2025ApiCreatePasswordPolicyRequest { - /** - * - * @type {PasswordPolicyV3DtoV2025} - * @memberof PasswordPoliciesV2025ApiCreatePasswordPolicy - */ - readonly passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2025ApiCreatePasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deletePasswordPolicy operation in PasswordPoliciesV2025Api. - * @export - * @interface PasswordPoliciesV2025ApiDeletePasswordPolicyRequest - */ -export interface PasswordPoliciesV2025ApiDeletePasswordPolicyRequest { - /** - * The ID of password policy to delete. - * @type {string} - * @memberof PasswordPoliciesV2025ApiDeletePasswordPolicy - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2025ApiDeletePasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPasswordPolicyById operation in PasswordPoliciesV2025Api. - * @export - * @interface PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest - */ -export interface PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest { - /** - * The ID of password policy to retrieve. - * @type {string} - * @memberof PasswordPoliciesV2025ApiGetPasswordPolicyById - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2025ApiGetPasswordPolicyById - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listPasswordPolicies operation in PasswordPoliciesV2025Api. - * @export - * @interface PasswordPoliciesV2025ApiListPasswordPoliciesRequest - */ -export interface PasswordPoliciesV2025ApiListPasswordPoliciesRequest { - /** - * 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 PasswordPoliciesV2025ApiListPasswordPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordPoliciesV2025ApiListPasswordPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordPoliciesV2025ApiListPasswordPolicies - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2025ApiListPasswordPolicies - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setPasswordPolicy operation in PasswordPoliciesV2025Api. - * @export - * @interface PasswordPoliciesV2025ApiSetPasswordPolicyRequest - */ -export interface PasswordPoliciesV2025ApiSetPasswordPolicyRequest { - /** - * The ID of password policy to update. - * @type {string} - * @memberof PasswordPoliciesV2025ApiSetPasswordPolicy - */ - readonly id: string - - /** - * - * @type {PasswordPolicyV3DtoV2025} - * @memberof PasswordPoliciesV2025ApiSetPasswordPolicy - */ - readonly passwordPolicyV3DtoV2025: PasswordPolicyV3DtoV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2025ApiSetPasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * PasswordPoliciesV2025Api - object-oriented interface - * @export - * @class PasswordPoliciesV2025Api - * @extends {BaseAPI} - */ -export class PasswordPoliciesV2025Api extends BaseAPI { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2025ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2025Api - */ - public createPasswordPolicy(requestParameters: PasswordPoliciesV2025ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2025ApiFp(this.configuration).createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2025ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2025Api - */ - public deletePasswordPolicy(requestParameters: PasswordPoliciesV2025ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2025ApiFp(this.configuration).deletePasswordPolicy(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2025Api - */ - public getPasswordPolicyById(requestParameters: PasswordPoliciesV2025ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2025ApiFp(this.configuration).getPasswordPolicyById(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2025ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2025Api - */ - public listPasswordPolicies(requestParameters: PasswordPoliciesV2025ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2025ApiFp(this.configuration).listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2025ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2025Api - */ - public setPasswordPolicy(requestParameters: PasswordPoliciesV2025ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2025ApiFp(this.configuration).setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordSyncGroupsV2025Api - axios parameter creator - * @export - */ -export const PasswordSyncGroupsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2025} passwordSyncGroupV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup: async (passwordSyncGroupV2025: PasswordSyncGroupV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordSyncGroupV2025' is not null or undefined - assertParamExists('createPasswordSyncGroup', 'passwordSyncGroupV2025', passwordSyncGroupV2025) - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2025} passwordSyncGroupV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup: async (id: string, passwordSyncGroupV2025: PasswordSyncGroupV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'id', id) - // verify required parameter 'passwordSyncGroupV2025' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'passwordSyncGroupV2025', passwordSyncGroupV2025) - const localVarPath = `/password-sync-groups/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordSyncGroupsV2025Api - functional programming interface - * @export - */ -export const PasswordSyncGroupsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordSyncGroupsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2025} passwordSyncGroupV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordSyncGroup(passwordSyncGroupV2025: PasswordSyncGroupV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroup(passwordSyncGroupV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2025Api.createPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2025Api.deletePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2025Api.getPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroups(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2025Api.getPasswordSyncGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2025} passwordSyncGroupV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordSyncGroup(id: string, passwordSyncGroupV2025: PasswordSyncGroupV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroup(id, passwordSyncGroupV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2025Api.updatePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordSyncGroupsV2025Api - factory interface - * @export - */ -export const PasswordSyncGroupsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordSyncGroupsV2025ApiFp(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordSyncGroup(requestParameters.passwordSyncGroupV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsV2025Api. - * @export - * @interface PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest { - /** - * - * @type {PasswordSyncGroupV2025} - * @memberof PasswordSyncGroupsV2025ApiCreatePasswordSyncGroup - */ - readonly passwordSyncGroupV2025: PasswordSyncGroupV2025 -} - -/** - * Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsV2025Api. - * @export - * @interface PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest { - /** - * The ID of password sync group to delete. - * @type {string} - * @memberof PasswordSyncGroupsV2025ApiDeletePasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsV2025Api. - * @export - * @interface PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest { - /** - * The ID of password sync group to retrieve. - * @type {string} - * @memberof PasswordSyncGroupsV2025ApiGetPasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsV2025Api. - * @export - * @interface PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest - */ -export interface PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest { - /** - * 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 PasswordSyncGroupsV2025ApiGetPasswordSyncGroups - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordSyncGroupsV2025ApiGetPasswordSyncGroups - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordSyncGroupsV2025ApiGetPasswordSyncGroups - */ - readonly count?: boolean -} - -/** - * Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsV2025Api. - * @export - * @interface PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest { - /** - * The ID of password sync group to update. - * @type {string} - * @memberof PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroup - */ - readonly id: string - - /** - * - * @type {PasswordSyncGroupV2025} - * @memberof PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroup - */ - readonly passwordSyncGroupV2025: PasswordSyncGroupV2025 -} - -/** - * PasswordSyncGroupsV2025Api - object-oriented interface - * @export - * @class PasswordSyncGroupsV2025Api - * @extends {BaseAPI} - */ -export class PasswordSyncGroupsV2025Api extends BaseAPI { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2025Api - */ - public createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2025ApiFp(this.configuration).createPasswordSyncGroup(requestParameters.passwordSyncGroupV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2025Api - */ - public deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2025ApiFp(this.configuration).deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2025Api - */ - public getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2025ApiFp(this.configuration).getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2025Api - */ - public getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2025ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2025ApiFp(this.configuration).getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2025Api - */ - public updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2025ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2025ApiFp(this.configuration).updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PersonalAccessTokensV2025Api - axios parameter creator - * @export - */ -export const PersonalAccessTokensV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2025} createPersonalAccessTokenRequestV2025 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken: async (createPersonalAccessTokenRequestV2025: CreatePersonalAccessTokenRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPersonalAccessTokenRequestV2025' is not null or undefined - assertParamExists('createPersonalAccessToken', 'createPersonalAccessTokenRequestV2025', createPersonalAccessTokenRequestV2025) - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPersonalAccessTokenRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePersonalAccessToken', 'id', id) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2025 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PersonalAccessTokensV2025Api - functional programming interface - * @export - */ -export const PersonalAccessTokensV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PersonalAccessTokensV2025ApiAxiosParamCreator(configuration) - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2025} createPersonalAccessTokenRequestV2025 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPersonalAccessToken(createPersonalAccessTokenRequestV2025: CreatePersonalAccessTokenRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessToken(createPersonalAccessTokenRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2025Api.createPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePersonalAccessToken(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessToken(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2025Api.deletePersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokens(ownerId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2025Api.listPersonalAccessTokens']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2025 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPersonalAccessToken(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessToken(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2025Api.patchPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PersonalAccessTokensV2025Api - factory interface - * @export - */ -export const PersonalAccessTokensV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PersonalAccessTokensV2025ApiFp(configuration) - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPersonalAccessToken operation in PersonalAccessTokensV2025Api. - * @export - * @interface PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest { - /** - * Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @type {CreatePersonalAccessTokenRequestV2025} - * @memberof PersonalAccessTokensV2025ApiCreatePersonalAccessToken - */ - readonly createPersonalAccessTokenRequestV2025: CreatePersonalAccessTokenRequestV2025 -} - -/** - * Request parameters for deletePersonalAccessToken operation in PersonalAccessTokensV2025Api. - * @export - * @interface PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest { - /** - * The personal access token id - * @type {string} - * @memberof PersonalAccessTokensV2025ApiDeletePersonalAccessToken - */ - readonly id: string -} - -/** - * Request parameters for listPersonalAccessTokens operation in PersonalAccessTokensV2025Api. - * @export - * @interface PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest - */ -export interface PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest { - /** - * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @type {string} - * @memberof PersonalAccessTokensV2025ApiListPersonalAccessTokens - */ - readonly ownerId?: 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof PersonalAccessTokensV2025ApiListPersonalAccessTokens - */ - readonly filters?: string -} - -/** - * Request parameters for patchPersonalAccessToken operation in PersonalAccessTokensV2025Api. - * @export - * @interface PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest { - /** - * The Personal Access Token id - * @type {string} - * @memberof PersonalAccessTokensV2025ApiPatchPersonalAccessToken - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @type {Array} - * @memberof PersonalAccessTokensV2025ApiPatchPersonalAccessToken - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * PersonalAccessTokensV2025Api - object-oriented interface - * @export - * @class PersonalAccessTokensV2025Api - * @extends {BaseAPI} - */ -export class PersonalAccessTokensV2025Api extends BaseAPI { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2025Api - */ - public createPersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2025ApiFp(this.configuration).createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2025Api - */ - public deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2025ApiFp(this.configuration).deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2025Api - */ - public listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2025ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2025ApiFp(this.configuration).listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2025Api - */ - public patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2025ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2025ApiFp(this.configuration).patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PrivilegeCriteriaV2025Api - axios parameter creator - * @export - */ -export const PrivilegeCriteriaV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {CreatePrivilegeCriteriaRequestV2025} createPrivilegeCriteriaRequestV2025 Create custom privilege criteria request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPrivilegeCriteria: async (createPrivilegeCriteriaRequestV2025: CreatePrivilegeCriteriaRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPrivilegeCriteriaRequestV2025' is not null or undefined - assertParamExists('createCustomPrivilegeCriteria', 'createPrivilegeCriteriaRequestV2025', createPrivilegeCriteriaRequestV2025) - const localVarPath = `/criteria/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPrivilegeCriteriaRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {string} criteriaId The Id of the custom privilege criteria to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPrivilegeCriteria: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('deleteCustomPrivilegeCriteria', 'criteriaId', criteriaId) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteria: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('getPrivilegeCriteria', 'criteriaId', criteriaId) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteria: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listPrivilegeCriteria', 'filters', filters) - const localVarPath = `/criteria/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {PrivilegeCriteriaDTOV2025} privilegeCriteriaDTOV2025 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCustomPrivilegeCriteriaValue: async (criteriaId: string, privilegeCriteriaDTOV2025: PrivilegeCriteriaDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('putCustomPrivilegeCriteriaValue', 'criteriaId', criteriaId) - // verify required parameter 'privilegeCriteriaDTOV2025' is not null or undefined - assertParamExists('putCustomPrivilegeCriteriaValue', 'privilegeCriteriaDTOV2025', privilegeCriteriaDTOV2025) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(privilegeCriteriaDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PrivilegeCriteriaV2025Api - functional programming interface - * @export - */ -export const PrivilegeCriteriaV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PrivilegeCriteriaV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {CreatePrivilegeCriteriaRequestV2025} createPrivilegeCriteriaRequestV2025 Create custom privilege criteria request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPrivilegeCriteria(createPrivilegeCriteriaRequestV2025: CreatePrivilegeCriteriaRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPrivilegeCriteria(createPrivilegeCriteriaRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2025Api.createCustomPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {string} criteriaId The Id of the custom privilege criteria to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPrivilegeCriteria(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPrivilegeCriteria(criteriaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2025Api.deleteCustomPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPrivilegeCriteria(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteria(criteriaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2025Api.getPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPrivilegeCriteria(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteria(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2025Api.listPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {PrivilegeCriteriaDTOV2025} privilegeCriteriaDTOV2025 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCustomPrivilegeCriteriaValue(criteriaId: string, privilegeCriteriaDTOV2025: PrivilegeCriteriaDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCustomPrivilegeCriteriaValue(criteriaId, privilegeCriteriaDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2025Api.putCustomPrivilegeCriteriaValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PrivilegeCriteriaV2025Api - factory interface - * @export - */ -export const PrivilegeCriteriaV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PrivilegeCriteriaV2025ApiFp(configuration) - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPrivilegeCriteria(requestParameters.createPrivilegeCriteriaRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @param {PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPrivilegeCriteria(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCustomPrivilegeCriteriaValue(requestParameters: PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCustomPrivilegeCriteriaValue(requestParameters.criteriaId, requestParameters.privilegeCriteriaDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPrivilegeCriteria operation in PrivilegeCriteriaV2025Api. - * @export - * @interface PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest { - /** - * Create custom privilege criteria request body. - * @type {CreatePrivilegeCriteriaRequestV2025} - * @memberof PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteria - */ - readonly createPrivilegeCriteriaRequestV2025: CreatePrivilegeCriteriaRequestV2025 -} - -/** - * Request parameters for deleteCustomPrivilegeCriteria operation in PrivilegeCriteriaV2025Api. - * @export - * @interface PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest { - /** - * The Id of the custom privilege criteria to delete. - * @type {string} - * @memberof PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteria - */ - readonly criteriaId: string -} - -/** - * Request parameters for getPrivilegeCriteria operation in PrivilegeCriteriaV2025Api. - * @export - * @interface PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest { - /** - * The Id of the privilege criteria record to return. - * @type {string} - * @memberof PrivilegeCriteriaV2025ApiGetPrivilegeCriteria - */ - readonly criteriaId: string -} - -/** - * Request parameters for listPrivilegeCriteria operation in PrivilegeCriteriaV2025Api. - * @export - * @interface PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest { - /** - * 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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @type {string} - * @memberof PrivilegeCriteriaV2025ApiListPrivilegeCriteria - */ - readonly filters: string -} - -/** - * Request parameters for putCustomPrivilegeCriteriaValue operation in PrivilegeCriteriaV2025Api. - * @export - * @interface PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest - */ -export interface PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest { - /** - * The Id of the privilege criteria record to return. - * @type {string} - * @memberof PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValue - */ - readonly criteriaId: string - - /** - * The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @type {PrivilegeCriteriaDTOV2025} - * @memberof PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValue - */ - readonly privilegeCriteriaDTOV2025: PrivilegeCriteriaDTOV2025 -} - -/** - * PrivilegeCriteriaV2025Api - object-oriented interface - * @export - * @class PrivilegeCriteriaV2025Api - * @extends {BaseAPI} - */ -export class PrivilegeCriteriaV2025Api extends BaseAPI { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2025Api - */ - public createCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiCreateCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2025ApiFp(this.configuration).createCustomPrivilegeCriteria(requestParameters.createPrivilegeCriteriaRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2025Api - */ - public deleteCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiDeleteCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2025ApiFp(this.configuration).deleteCustomPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2025Api - */ - public getPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiGetPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2025ApiFp(this.configuration).getPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @param {PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2025Api - */ - public listPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2025ApiListPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2025ApiFp(this.configuration).listPrivilegeCriteria(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2025Api - */ - public putCustomPrivilegeCriteriaValue(requestParameters: PrivilegeCriteriaV2025ApiPutCustomPrivilegeCriteriaValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2025ApiFp(this.configuration).putCustomPrivilegeCriteriaValue(requestParameters.criteriaId, requestParameters.privilegeCriteriaDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PrivilegeCriteriaConfigurationV2025Api - axios parameter creator - * @export - */ -export const PrivilegeCriteriaConfigurationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteriaConfig: async (criteriaConfigId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaConfigId' is not null or undefined - assertParamExists('getPrivilegeCriteriaConfig', 'criteriaConfigId', criteriaConfigId) - const localVarPath = `/criteria-config/privilege/{criteriaConfigId}` - .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteriaConfig: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listPrivilegeCriteriaConfig', 'filters', filters) - const localVarPath = `/criteria-config/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. - * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPrivilegeCriteriaConfig: async (criteriaConfigId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaConfigId' is not null or undefined - assertParamExists('patchPrivilegeCriteriaConfig', 'criteriaConfigId', criteriaConfigId) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchPrivilegeCriteriaConfig', 'requestBody', requestBody) - const localVarPath = `/criteria-config/privilege/{criteriaConfigId}` - .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PrivilegeCriteriaConfigurationV2025Api - functional programming interface - * @export - */ -export const PrivilegeCriteriaConfigurationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PrivilegeCriteriaConfigurationV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPrivilegeCriteriaConfig(criteriaConfigId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteriaConfig(criteriaConfigId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2025Api.getPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPrivilegeCriteriaConfig(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteriaConfig(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2025Api.listPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. - * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPrivilegeCriteriaConfig(criteriaConfigId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPrivilegeCriteriaConfig(criteriaConfigId, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2025Api.patchPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PrivilegeCriteriaConfigurationV2025Api - factory interface - * @export - */ -export const PrivilegeCriteriaConfigurationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PrivilegeCriteriaConfigurationV2025ApiFp(configuration) - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPrivilegeCriteriaConfig(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2025Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest { - /** - * The Id of the privilege criteria configuration record to retrieve. - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfig - */ - readonly criteriaConfigId: string -} - -/** - * Request parameters for listPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2025Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest { - /** - * 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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfig - */ - readonly filters: string -} - -/** - * Request parameters for patchPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2025Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest { - /** - * The Id of the privilege criteria configuration to update. - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfig - */ - readonly criteriaConfigId: string - - /** - * A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfig - */ - readonly requestBody: Array -} - -/** - * PrivilegeCriteriaConfigurationV2025Api - object-oriented interface - * @export - * @class PrivilegeCriteriaConfigurationV2025Api - * @extends {BaseAPI} - */ -export class PrivilegeCriteriaConfigurationV2025Api extends BaseAPI { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2025Api - */ - public getPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiGetPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2025ApiFp(this.configuration).getPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2025Api - */ - public listPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiListPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2025ApiFp(this.configuration).listPrivilegeCriteriaConfig(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2025Api - */ - public patchPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2025ApiPatchPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2025ApiFp(this.configuration).patchPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesV2025Api - axios parameter creator - * @export - */ -export const PublicIdentitiesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities: async (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (addCoreFilters !== undefined) { - localVarQueryParameter['add-core-filters'] = addCoreFilters; - } - - 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, - }; - }, - } -}; - -/** - * PublicIdentitiesV2025Api - functional programming interface - * @export - */ -export const PublicIdentitiesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesV2025ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentities(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentities(limit, offset, count, filters, addCoreFilters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesV2025Api.getPublicIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesV2025Api - factory interface - * @export - */ -export const PublicIdentitiesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesV2025ApiFp(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2025ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities(requestParameters: PublicIdentitiesV2025ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPublicIdentities operation in PublicIdentitiesV2025Api. - * @export - * @interface PublicIdentitiesV2025ApiGetPublicIdentitiesRequest - */ -export interface PublicIdentitiesV2025ApiGetPublicIdentitiesRequest { - /** - * 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 PublicIdentitiesV2025ApiGetPublicIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PublicIdentitiesV2025ApiGetPublicIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PublicIdentitiesV2025ApiGetPublicIdentities - */ - 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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @type {string} - * @memberof PublicIdentitiesV2025ApiGetPublicIdentities - */ - readonly filters?: string - - /** - * If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @type {boolean} - * @memberof PublicIdentitiesV2025ApiGetPublicIdentities - */ - readonly addCoreFilters?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof PublicIdentitiesV2025ApiGetPublicIdentities - */ - readonly sorters?: string -} - -/** - * PublicIdentitiesV2025Api - object-oriented interface - * @export - * @class PublicIdentitiesV2025Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesV2025Api extends BaseAPI { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2025ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesV2025Api - */ - public getPublicIdentities(requestParameters: PublicIdentitiesV2025ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesV2025ApiFp(this.configuration).getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesConfigV2025Api - axios parameter creator - * @export - */ -export const PublicIdentitiesConfigV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2025} publicIdentityConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig: async (publicIdentityConfigV2025: PublicIdentityConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'publicIdentityConfigV2025' is not null or undefined - assertParamExists('updatePublicIdentityConfig', 'publicIdentityConfigV2025', publicIdentityConfigV2025) - const localVarPath = `/public-identities-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(publicIdentityConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PublicIdentitiesConfigV2025Api - functional programming interface - * @export - */ -export const PublicIdentitiesConfigV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesConfigV2025ApiAxiosParamCreator(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2025Api.getPublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2025} publicIdentityConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePublicIdentityConfig(publicIdentityConfigV2025: PublicIdentityConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfig(publicIdentityConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2025Api.updatePublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesConfigV2025Api - factory interface - * @export - */ -export const PublicIdentitiesConfigV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesConfigV2025ApiFp(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPublicIdentityConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updatePublicIdentityConfig operation in PublicIdentitiesConfigV2025Api. - * @export - * @interface PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest - */ -export interface PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest { - /** - * - * @type {PublicIdentityConfigV2025} - * @memberof PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfig - */ - readonly publicIdentityConfigV2025: PublicIdentityConfigV2025 -} - -/** - * PublicIdentitiesConfigV2025Api - object-oriented interface - * @export - * @class PublicIdentitiesConfigV2025Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesConfigV2025Api extends BaseAPI { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2025Api - */ - public getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2025ApiFp(this.configuration).getPublicIdentityConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2025Api - */ - public updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2025ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2025ApiFp(this.configuration).updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ReportsDataExtractionV2025Api - axios parameter creator - * @export - */ -export const ReportsDataExtractionV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelReport', 'id', id) - const localVarPath = `/reports/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2025} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport: async (taskResultId: string, fileFormat: GetReportFileFormatV2025, name?: string, auditable?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReport', 'taskResultId', taskResultId) - // verify required parameter 'fileFormat' is not null or undefined - assertParamExists('getReport', 'fileFormat', fileFormat) - const localVarPath = `/reports/{taskResultId}` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (fileFormat !== undefined) { - localVarQueryParameter['fileFormat'] = fileFormat; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (auditable !== undefined) { - localVarQueryParameter['auditable'] = auditable; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult: async (taskResultId: string, completed?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReportResult', 'taskResultId', taskResultId) - const localVarPath = `/reports/{taskResultId}/result` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (completed !== undefined) { - localVarQueryParameter['completed'] = completed; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2025} reportDetailsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport: async (reportDetailsV2025: ReportDetailsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportDetailsV2025' is not null or undefined - assertParamExists('startReport', 'reportDetailsV2025', reportDetailsV2025) - const localVarPath = `/reports/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reportDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ReportsDataExtractionV2025Api - functional programming interface - * @export - */ -export const ReportsDataExtractionV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ReportsDataExtractionV2025ApiAxiosParamCreator(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelReport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2025Api.cancelReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2025} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReport(taskResultId: string, fileFormat: GetReportFileFormatV2025, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(taskResultId, fileFormat, name, auditable, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2025Api.getReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReportResult(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReportResult(taskResultId, completed, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2025Api.getReportResult']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2025} reportDetailsV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startReport(reportDetailsV2025: ReportDetailsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startReport(reportDetailsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2025Api.startReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ReportsDataExtractionV2025Api - factory interface - * @export - */ -export const ReportsDataExtractionV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ReportsDataExtractionV2025ApiFp(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2025ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport(requestParameters: ReportsDataExtractionV2025ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelReport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2025ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport(requestParameters: ReportsDataExtractionV2025ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2025ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult(requestParameters: ReportsDataExtractionV2025ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2025ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport(requestParameters: ReportsDataExtractionV2025ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startReport(requestParameters.reportDetailsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelReport operation in ReportsDataExtractionV2025Api. - * @export - * @interface ReportsDataExtractionV2025ApiCancelReportRequest - */ -export interface ReportsDataExtractionV2025ApiCancelReportRequest { - /** - * ID of the running Report to cancel - * @type {string} - * @memberof ReportsDataExtractionV2025ApiCancelReport - */ - readonly id: string -} - -/** - * Request parameters for getReport operation in ReportsDataExtractionV2025Api. - * @export - * @interface ReportsDataExtractionV2025ApiGetReportRequest - */ -export interface ReportsDataExtractionV2025ApiGetReportRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2025ApiGetReport - */ - readonly taskResultId: string - - /** - * Output format of the requested report file - * @type {'csv' | 'pdf'} - * @memberof ReportsDataExtractionV2025ApiGetReport - */ - readonly fileFormat: GetReportFileFormatV2025 - - /** - * preferred Report file name, by default will be used report name from task result. - * @type {string} - * @memberof ReportsDataExtractionV2025ApiGetReport - */ - readonly name?: string - - /** - * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @type {boolean} - * @memberof ReportsDataExtractionV2025ApiGetReport - */ - readonly auditable?: boolean -} - -/** - * Request parameters for getReportResult operation in ReportsDataExtractionV2025Api. - * @export - * @interface ReportsDataExtractionV2025ApiGetReportResultRequest - */ -export interface ReportsDataExtractionV2025ApiGetReportResultRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2025ApiGetReportResult - */ - readonly taskResultId: string - - /** - * state of task result to apply ordering when results are fetching from the DB - * @type {boolean} - * @memberof ReportsDataExtractionV2025ApiGetReportResult - */ - readonly completed?: boolean -} - -/** - * Request parameters for startReport operation in ReportsDataExtractionV2025Api. - * @export - * @interface ReportsDataExtractionV2025ApiStartReportRequest - */ -export interface ReportsDataExtractionV2025ApiStartReportRequest { - /** - * - * @type {ReportDetailsV2025} - * @memberof ReportsDataExtractionV2025ApiStartReport - */ - readonly reportDetailsV2025: ReportDetailsV2025 -} - -/** - * ReportsDataExtractionV2025Api - object-oriented interface - * @export - * @class ReportsDataExtractionV2025Api - * @extends {BaseAPI} - */ -export class ReportsDataExtractionV2025Api extends BaseAPI { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2025ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2025Api - */ - public cancelReport(requestParameters: ReportsDataExtractionV2025ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2025ApiFp(this.configuration).cancelReport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2025ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2025Api - */ - public getReport(requestParameters: ReportsDataExtractionV2025ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2025ApiFp(this.configuration).getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2025ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2025Api - */ - public getReportResult(requestParameters: ReportsDataExtractionV2025ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2025ApiFp(this.configuration).getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2025ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2025Api - */ - public startReport(requestParameters: ReportsDataExtractionV2025ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2025ApiFp(this.configuration).startReport(requestParameters.reportDetailsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetReportFileFormatV2025 = { - Csv: 'csv', - Pdf: 'pdf' -} as const; -export type GetReportFileFormatV2025 = typeof GetReportFileFormatV2025[keyof typeof GetReportFileFormatV2025]; - - -/** - * RequestableObjectsV2025Api - axios parameter creator - * @export - */ -export const RequestableObjectsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/requestable-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (types) { - localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); - } - - if (term !== undefined) { - localVarQueryParameter['term'] = term; - } - - if (statuses) { - localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * RequestableObjectsV2025Api - functional programming interface - * @export - */ -export const RequestableObjectsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RequestableObjectsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRequestableObjects(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjects(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RequestableObjectsV2025Api.listRequestableObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RequestableObjectsV2025Api - factory interface - * @export - */ -export const RequestableObjectsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RequestableObjectsV2025ApiFp(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2025ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects(requestParameters: RequestableObjectsV2025ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listRequestableObjects operation in RequestableObjectsV2025Api. - * @export - * @interface RequestableObjectsV2025ApiListRequestableObjectsRequest - */ -export interface RequestableObjectsV2025ApiListRequestableObjectsRequest { - /** - * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @type {string} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly identityId?: string - - /** - * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly types?: Array - - /** - * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @type {string} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly term?: string - - /** - * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @type {Array} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly statuses?: Array - - /** - * 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 RequestableObjectsV2025ApiListRequestableObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - 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: **name** - * @type {string} - * @memberof RequestableObjectsV2025ApiListRequestableObjects - */ - readonly sorters?: string -} - -/** - * RequestableObjectsV2025Api - object-oriented interface - * @export - * @class RequestableObjectsV2025Api - * @extends {BaseAPI} - */ -export class RequestableObjectsV2025Api extends BaseAPI { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2025ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RequestableObjectsV2025Api - */ - public listRequestableObjects(requestParameters: RequestableObjectsV2025ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RequestableObjectsV2025ApiFp(this.configuration).listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListRequestableObjectsTypesV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type ListRequestableObjectsTypesV2025 = typeof ListRequestableObjectsTypesV2025[keyof typeof ListRequestableObjectsTypesV2025]; - - -/** - * RoleInsightsV2025Api - axios parameter creator - * @export - */ -export const RoleInsightsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('downloadRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/download` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'insightId', insightId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'entitlementId', entitlementId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (hasEntitlement !== undefined) { - localVarQueryParameter['hasEntitlement'] = hasEntitlement; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight: async (insightId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsight', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements: async (insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsCurrentEntitlements', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/current-entitlements` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleInsightsRequests', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RoleInsightsV2025Api - functional programming interface - * @export - */ -export const RoleInsightsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RoleInsightsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createRoleInsightRequests(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequests(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.createRoleInsightRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.downloadRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementChangesIdentities(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentities(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getEntitlementChangesIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsight(insightId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsight(insightId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsight']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsights(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsights(offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsights']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsCurrentEntitlements(insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlements(insightId, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsightsCurrentEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getRoleInsightsRequests(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequests(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsightsRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsSummary(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummary(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2025Api.getRoleInsightsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RoleInsightsV2025Api - factory interface - * @export - */ -export const RoleInsightsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RoleInsightsV2025ApiFp(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2025ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests(requestParameters: RoleInsightsV2025ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities(requestParameters: RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2025ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight(requestParameters: RoleInsightsV2025ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2025ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights(requestParameters: RoleInsightsV2025ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2025ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests(requestParameters: RoleInsightsV2025ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2025ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary(requestParameters: RoleInsightsV2025ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRoleInsightRequests operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiCreateRoleInsightRequestsRequest - */ -export interface RoleInsightsV2025ApiCreateRoleInsightRequestsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiCreateRoleInsightRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleInsightsEntitlementsChanges operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @type {string} - * @memberof RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementChangesIdentities operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest - */ -export interface RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly insightId: string - - /** - * The entitlement id - * @type {string} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly entitlementId: string - - /** - * Identity has this entitlement or not - * @type {boolean} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly hasEntitlement?: boolean - - /** - * 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 RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly count?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetEntitlementChangesIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsight operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsight - */ - readonly insightId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsight - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsights operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightsRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightsRequest { - /** - * 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 RoleInsightsV2025ApiGetRoleInsights - */ - 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 RoleInsightsV2025ApiGetRoleInsights - */ - 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 RoleInsightsV2025ApiGetRoleInsights - */ - readonly count?: boolean - - /** - * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsights - */ - readonly sorters?: 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsights - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsights - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsCurrentEntitlements operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlements - */ - readonly insightId: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlements - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsEntitlementsChanges operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess, name** - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsRequests operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightsRequestsRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightsRequestsRequest { - /** - * The role insights request id - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsRequests - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsSummary operation in RoleInsightsV2025Api. - * @export - * @interface RoleInsightsV2025ApiGetRoleInsightsSummaryRequest - */ -export interface RoleInsightsV2025ApiGetRoleInsightsSummaryRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2025ApiGetRoleInsightsSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * RoleInsightsV2025Api - object-oriented interface - * @export - * @class RoleInsightsV2025Api - * @extends {BaseAPI} - */ -export class RoleInsightsV2025Api extends BaseAPI { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2025ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public createRoleInsightRequests(requestParameters: RoleInsightsV2025ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2025ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getEntitlementChangesIdentities(requestParameters: RoleInsightsV2025ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2025ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsight(requestParameters: RoleInsightsV2025ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2025ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsights(requestParameters: RoleInsightsV2025ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2025ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2025ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2025ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsightsRequests(requestParameters: RoleInsightsV2025ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2025ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2025Api - */ - public getRoleInsightsSummary(requestParameters: RoleInsightsV2025ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2025ApiFp(this.configuration).getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolePropagationV2025Api - axios parameter creator - * @export - */ -export const RolePropagationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelRolePropagation: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/terminate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOngoingRolePropagation: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/is-running`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationStatus: async (rolePropagationId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'rolePropagationId' is not null or undefined - assertParamExists('getRolePropagationStatus', 'rolePropagationId', rolePropagationId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/{rolePropagationId}/status` - .replace(`{${"rolePropagationId"}}`, encodeURIComponent(String(rolePropagationId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationConfigInputV2025} rolePropagationConfigInputV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setRolePropagationConfig: async (rolePropagationConfigInputV2025: RolePropagationConfigInputV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'rolePropagationConfigInputV2025' is not null or undefined - assertParamExists('setRolePropagationConfig', 'rolePropagationConfigInputV2025', rolePropagationConfigInputV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(rolePropagationConfigInputV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startRolePropagation: async (skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (skipRoleRefresh !== undefined) { - localVarQueryParameter['skipRoleRefresh'] = skipRoleRefresh; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolePropagationV2025Api - functional programming interface - * @export - */ -export const RolePropagationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolePropagationV2025ApiAxiosParamCreator(configuration) - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelRolePropagation(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRolePropagation(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.cancelRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOngoingRolePropagation(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOngoingRolePropagation(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.getOngoingRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRolePropagationConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.getRolePropagationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRolePropagationStatus(rolePropagationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationStatus(rolePropagationId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.getRolePropagationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationConfigInputV2025} rolePropagationConfigInputV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setRolePropagationConfig(rolePropagationConfigInputV2025: RolePropagationConfigInputV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setRolePropagationConfig(rolePropagationConfigInputV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.setRolePropagationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startRolePropagation(skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startRolePropagation(skipRoleRefresh, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2025Api.startRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolePropagationV2025Api - factory interface - * @export - */ -export const RolePropagationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolePropagationV2025ApiFp(configuration) - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {RolePropagationV2025ApiCancelRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelRolePropagation(requestParameters: RolePropagationV2025ApiCancelRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {RolePropagationV2025ApiGetOngoingRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOngoingRolePropagation(requestParameters: RolePropagationV2025ApiGetOngoingRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOngoingRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {RolePropagationV2025ApiGetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationConfig(requestParameters: RolePropagationV2025ApiGetRolePropagationConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRolePropagationConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {RolePropagationV2025ApiGetRolePropagationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationStatus(requestParameters: RolePropagationV2025ApiGetRolePropagationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRolePropagationStatus(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationV2025ApiSetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setRolePropagationConfig(requestParameters: RolePropagationV2025ApiSetRolePropagationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setRolePropagationConfig(requestParameters.rolePropagationConfigInputV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {RolePropagationV2025ApiStartRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startRolePropagation(requestParameters: RolePropagationV2025ApiStartRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startRolePropagation(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelRolePropagation operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiCancelRolePropagationRequest - */ -export interface RolePropagationV2025ApiCancelRolePropagationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiCancelRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getOngoingRolePropagation operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiGetOngoingRolePropagationRequest - */ -export interface RolePropagationV2025ApiGetOngoingRolePropagationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiGetOngoingRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRolePropagationConfig operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiGetRolePropagationConfigRequest - */ -export interface RolePropagationV2025ApiGetRolePropagationConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiGetRolePropagationConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRolePropagationStatus operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiGetRolePropagationStatusRequest - */ -export interface RolePropagationV2025ApiGetRolePropagationStatusRequest { - /** - * The ID of the role propagation process to retrieve the status for. - * @type {string} - * @memberof RolePropagationV2025ApiGetRolePropagationStatus - */ - readonly rolePropagationId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiGetRolePropagationStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setRolePropagationConfig operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiSetRolePropagationConfigRequest - */ -export interface RolePropagationV2025ApiSetRolePropagationConfigRequest { - /** - * - * @type {RolePropagationConfigInputV2025} - * @memberof RolePropagationV2025ApiSetRolePropagationConfig - */ - readonly rolePropagationConfigInputV2025: RolePropagationConfigInputV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiSetRolePropagationConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startRolePropagation operation in RolePropagationV2025Api. - * @export - * @interface RolePropagationV2025ApiStartRolePropagationRequest - */ -export interface RolePropagationV2025ApiStartRolePropagationRequest { - /** - * When true, the role refresh is not performed. Keeping it false is recommended. - * @type {boolean} - * @memberof RolePropagationV2025ApiStartRolePropagation - */ - readonly skipRoleRefresh?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2025ApiStartRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * RolePropagationV2025Api - object-oriented interface - * @export - * @class RolePropagationV2025Api - * @extends {BaseAPI} - */ -export class RolePropagationV2025Api extends BaseAPI { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {RolePropagationV2025ApiCancelRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public cancelRolePropagation(requestParameters: RolePropagationV2025ApiCancelRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).cancelRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {RolePropagationV2025ApiGetOngoingRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public getOngoingRolePropagation(requestParameters: RolePropagationV2025ApiGetOngoingRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).getOngoingRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {RolePropagationV2025ApiGetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public getRolePropagationConfig(requestParameters: RolePropagationV2025ApiGetRolePropagationConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).getRolePropagationConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {RolePropagationV2025ApiGetRolePropagationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public getRolePropagationStatus(requestParameters: RolePropagationV2025ApiGetRolePropagationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).getRolePropagationStatus(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationV2025ApiSetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public setRolePropagationConfig(requestParameters: RolePropagationV2025ApiSetRolePropagationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).setRolePropagationConfig(requestParameters.rolePropagationConfigInputV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {RolePropagationV2025ApiStartRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2025Api - */ - public startRolePropagation(requestParameters: RolePropagationV2025ApiStartRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2025ApiFp(this.configuration).startRolePropagation(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolesV2025Api - axios parameter creator - * @export - */ -export const RolesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2025} roleV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole: async (roleV2025: RoleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleV2025' is not null or undefined - assertParamExists('createRole', 'roleV2025', roleV2025) - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2025} roleBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles: async (roleBulkDeleteRequestV2025: RoleBulkDeleteRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBulkDeleteRequestV2025' is not null or undefined - assertParamExists('deleteBulkRoles', 'roleBulkDeleteRequestV2025', roleBulkDeleteRequestV2025) - const localVarPath = `/roles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBulkDeleteRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/access-model-metadata/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getBulkUpdateStatusById', 'id', id) - const localVarPath = `/roles/access-model-metadata/bulk-update/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleAssignedIdentities', 'id', id) - const localVarPath = `/roles/{id}/assigned-identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleEntitlements', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/roles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchRole', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchRole', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2025} [roleListFilterDTOV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2025?: RoleListFilterDTOV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleListFilterDTOV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2025} roleMetadataBulkUpdateByFilterRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter: async (roleMetadataBulkUpdateByFilterRequestV2025: RoleMetadataBulkUpdateByFilterRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByFilterRequestV2025' is not null or undefined - assertParamExists('updateRolesMetadataByFilter', 'roleMetadataBulkUpdateByFilterRequestV2025', roleMetadataBulkUpdateByFilterRequestV2025) - const localVarPath = `/roles/access-model-metadata/bulk-update/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByFilterRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2025} roleMetadataBulkUpdateByIdRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds: async (roleMetadataBulkUpdateByIdRequestV2025: RoleMetadataBulkUpdateByIdRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByIdRequestV2025' is not null or undefined - assertParamExists('updateRolesMetadataByIds', 'roleMetadataBulkUpdateByIdRequestV2025', roleMetadataBulkUpdateByIdRequestV2025) - const localVarPath = `/roles/access-model-metadata/bulk-update/ids`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByIdRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2025} roleMetadataBulkUpdateByQueryRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery: async (roleMetadataBulkUpdateByQueryRequestV2025: RoleMetadataBulkUpdateByQueryRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByQueryRequestV2025' is not null or undefined - assertParamExists('updateRolesMetadataByQuery', 'roleMetadataBulkUpdateByQueryRequestV2025', roleMetadataBulkUpdateByQueryRequestV2025) - const localVarPath = `/roles/access-model-metadata/bulk-update/query`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByQueryRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolesV2025Api - functional programming interface - * @export - */ -export const RolesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2025} roleV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRole(roleV2025: RoleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRole(roleV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.createRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2025} roleBulkDeleteRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkRoles(roleBulkDeleteRequestV2025: RoleBulkDeleteRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRoles(roleBulkDeleteRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.deleteBulkRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMetadataFromRoleByKeyAndValue(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetadataFromRoleByKeyAndValue(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.deleteMetadataFromRoleByKeyAndValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.deleteRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.getBulkUpdateStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatusById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatusById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.getBulkUpdateStatusById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.getRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentities(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.getRoleAssignedIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleEntitlements(id, limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.getRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.listRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRole(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRole(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.patchRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2025} [roleListFilterDTOV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchRolesByFilter(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2025?: RoleListFilterDTOV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchRolesByFilter(forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, roleListFilterDTOV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.searchRolesByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAttributeKeyAndValueToRole(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAttributeKeyAndValueToRole(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.updateAttributeKeyAndValueToRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2025} roleMetadataBulkUpdateByFilterRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2025: RoleMetadataBulkUpdateByFilterRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.updateRolesMetadataByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2025} roleMetadataBulkUpdateByIdRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2025: RoleMetadataBulkUpdateByIdRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.updateRolesMetadataByIds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2025} roleMetadataBulkUpdateByQueryRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2025: RoleMetadataBulkUpdateByQueryRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2025Api.updateRolesMetadataByQuery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolesV2025Api - factory interface - * @export - */ -export const RolesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolesV2025ApiFp(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2025ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole(requestParameters: RolesV2025ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRole(requestParameters.roleV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2025ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles(requestParameters: RolesV2025ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2025ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole(requestParameters: RolesV2025ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBulkUpdateStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2025ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById(requestParameters: RolesV2025ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2025ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole(requestParameters: RolesV2025ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List identities assigned a role - * @param {RolesV2025ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities(requestParameters: RolesV2025ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2025ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements(requestParameters: RolesV2025ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2025ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles(requestParameters: RolesV2025ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2025ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole(requestParameters: RolesV2025ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2025ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter(requestParameters: RolesV2025ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole(requestParameters: RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2025ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter(requestParameters: RolesV2025ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2025ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds(requestParameters: RolesV2025ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2025ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery(requestParameters: RolesV2025ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRole operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiCreateRoleRequest - */ -export interface RolesV2025ApiCreateRoleRequest { - /** - * - * @type {RoleV2025} - * @memberof RolesV2025ApiCreateRole - */ - readonly roleV2025: RoleV2025 -} - -/** - * Request parameters for deleteBulkRoles operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiDeleteBulkRolesRequest - */ -export interface RolesV2025ApiDeleteBulkRolesRequest { - /** - * - * @type {RoleBulkDeleteRequestV2025} - * @memberof RolesV2025ApiDeleteBulkRoles - */ - readonly roleBulkDeleteRequestV2025: RoleBulkDeleteRequestV2025 -} - -/** - * Request parameters for deleteMetadataFromRoleByKeyAndValue operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest - */ -export interface RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest { - /** - * The role\'s id. - * @type {string} - * @memberof RolesV2025ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2025ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2025ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteRole operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiDeleteRoleRequest - */ -export interface RolesV2025ApiDeleteRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2025ApiDeleteRole - */ - readonly id: string -} - -/** - * Request parameters for getBulkUpdateStatusById operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiGetBulkUpdateStatusByIdRequest - */ -export interface RolesV2025ApiGetBulkUpdateStatusByIdRequest { - /** - * The Id of the bulk update task. - * @type {string} - * @memberof RolesV2025ApiGetBulkUpdateStatusById - */ - readonly id: string -} - -/** - * Request parameters for getRole operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiGetRoleRequest - */ -export interface RolesV2025ApiGetRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2025ApiGetRole - */ - readonly id: string -} - -/** - * Request parameters for getRoleAssignedIdentities operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiGetRoleAssignedIdentitiesRequest - */ -export interface RolesV2025ApiGetRoleAssignedIdentitiesRequest { - /** - * ID of the Role for which the assigned Identities are to be listed - * @type {string} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @type {string} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - 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, name, aliasName, email** - * @type {string} - * @memberof RolesV2025ApiGetRoleAssignedIdentities - */ - readonly sorters?: string -} - -/** - * Request parameters for getRoleEntitlements operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiGetRoleEntitlementsRequest - */ -export interface RolesV2025ApiGetRoleEntitlementsRequest { - /** - * Containing role\'s ID. - * @type {string} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - readonly id: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolesV2025ApiGetRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listRoles operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiListRolesRequest - */ -export interface RolesV2025ApiListRolesRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2025ApiListRoles - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiListRoles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiListRoles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2025ApiListRoles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @type {string} - * @memberof RolesV2025ApiListRoles - */ - 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: **name, created, modified** - * @type {string} - * @memberof RolesV2025ApiListRoles - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2025ApiListRoles - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2025ApiListRoles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchRole operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiPatchRoleRequest - */ -export interface RolesV2025ApiPatchRoleRequest { - /** - * ID of the Role to patch - * @type {string} - * @memberof RolesV2025ApiPatchRole - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof RolesV2025ApiPatchRole - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for searchRolesByFilter operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiSearchRolesByFilterRequest - */ -export interface RolesV2025ApiSearchRolesByFilterRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly forSubadmin?: string - - /** - * Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly includeUnsegmented?: boolean - - /** - * - * @type {RoleListFilterDTOV2025} - * @memberof RolesV2025ApiSearchRolesByFilter - */ - readonly roleListFilterDTOV2025?: RoleListFilterDTOV2025 -} - -/** - * Request parameters for updateAttributeKeyAndValueToRole operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest - */ -export interface RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest { - /** - * The Id of a role - * @type {string} - * @memberof RolesV2025ApiUpdateAttributeKeyAndValueToRole - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2025ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2025ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeValue: string -} - -/** - * Request parameters for updateRolesMetadataByFilter operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiUpdateRolesMetadataByFilterRequest - */ -export interface RolesV2025ApiUpdateRolesMetadataByFilterRequest { - /** - * - * @type {RoleMetadataBulkUpdateByFilterRequestV2025} - * @memberof RolesV2025ApiUpdateRolesMetadataByFilter - */ - readonly roleMetadataBulkUpdateByFilterRequestV2025: RoleMetadataBulkUpdateByFilterRequestV2025 -} - -/** - * Request parameters for updateRolesMetadataByIds operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiUpdateRolesMetadataByIdsRequest - */ -export interface RolesV2025ApiUpdateRolesMetadataByIdsRequest { - /** - * - * @type {RoleMetadataBulkUpdateByIdRequestV2025} - * @memberof RolesV2025ApiUpdateRolesMetadataByIds - */ - readonly roleMetadataBulkUpdateByIdRequestV2025: RoleMetadataBulkUpdateByIdRequestV2025 -} - -/** - * Request parameters for updateRolesMetadataByQuery operation in RolesV2025Api. - * @export - * @interface RolesV2025ApiUpdateRolesMetadataByQueryRequest - */ -export interface RolesV2025ApiUpdateRolesMetadataByQueryRequest { - /** - * - * @type {RoleMetadataBulkUpdateByQueryRequestV2025} - * @memberof RolesV2025ApiUpdateRolesMetadataByQuery - */ - readonly roleMetadataBulkUpdateByQueryRequestV2025: RoleMetadataBulkUpdateByQueryRequestV2025 -} - -/** - * RolesV2025Api - object-oriented interface - * @export - * @class RolesV2025Api - * @extends {BaseAPI} - */ -export class RolesV2025Api extends BaseAPI { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2025ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public createRole(requestParameters: RolesV2025ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).createRole(requestParameters.roleV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2025ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public deleteBulkRoles(requestParameters: RolesV2025ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2025ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2025ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public deleteRole(requestParameters: RolesV2025ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).deleteRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).getBulkUpdateStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2025ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public getBulkUpdateStatusById(requestParameters: RolesV2025ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2025ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public getRole(requestParameters: RolesV2025ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).getRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List identities assigned a role - * @param {RolesV2025ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public getRoleAssignedIdentities(requestParameters: RolesV2025ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2025ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public getRoleEntitlements(requestParameters: RolesV2025ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2025ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public listRoles(requestParameters: RolesV2025ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2025ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public patchRole(requestParameters: RolesV2025ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2025ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public searchRolesByFilter(requestParameters: RolesV2025ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public updateAttributeKeyAndValueToRole(requestParameters: RolesV2025ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2025ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public updateRolesMetadataByFilter(requestParameters: RolesV2025ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2025ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public updateRolesMetadataByIds(requestParameters: RolesV2025ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2025ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2025Api - */ - public updateRolesMetadataByQuery(requestParameters: RolesV2025ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2025ApiFp(this.configuration).updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SIMIntegrationsV2025Api - axios parameter creator - * @export - */ -export const SIMIntegrationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2025} simIntegrationDetailsV2025 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration: async (simIntegrationDetailsV2025: SimIntegrationDetailsV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'simIntegrationDetailsV2025' is not null or undefined - assertParamExists('createSIMIntegration', 'simIntegrationDetailsV2025', simIntegrationDetailsV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2025} jsonPatchV2025 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule: async (id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'id', id) - // verify required parameter 'jsonPatchV2025' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'jsonPatchV2025', jsonPatchV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{id}/beforeProvisioningRule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2025} jsonPatchV2025 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes: async (id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSIMAttributes', 'id', id) - // verify required parameter 'jsonPatchV2025' is not null or undefined - assertParamExists('patchSIMAttributes', 'jsonPatchV2025', jsonPatchV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2025} simIntegrationDetailsV2025 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration: async (id: string, simIntegrationDetailsV2025: SimIntegrationDetailsV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSIMIntegration', 'id', id) - // verify required parameter 'simIntegrationDetailsV2025' is not null or undefined - assertParamExists('putSIMIntegration', 'simIntegrationDetailsV2025', simIntegrationDetailsV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SIMIntegrationsV2025Api - functional programming interface - * @export - */ -export const SIMIntegrationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SIMIntegrationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2025} simIntegrationDetailsV2025 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSIMIntegration(simIntegrationDetailsV2025: SimIntegrationDetailsV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSIMIntegration(simIntegrationDetailsV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.createSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.deleteSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.getSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegrations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.getSIMIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2025} jsonPatchV2025 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchBeforeProvisioningRule(id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchBeforeProvisioningRule(id, jsonPatchV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.patchBeforeProvisioningRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2025} jsonPatchV2025 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSIMAttributes(id: string, jsonPatchV2025: JsonPatchV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSIMAttributes(id, jsonPatchV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.patchSIMAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2025} simIntegrationDetailsV2025 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSIMIntegration(id: string, simIntegrationDetailsV2025: SimIntegrationDetailsV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSIMIntegration(id, simIntegrationDetailsV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2025Api.putSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SIMIntegrationsV2025Api - factory interface - * @export - */ -export const SIMIntegrationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SIMIntegrationsV2025ApiFp(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2025ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration(requestParameters: SIMIntegrationsV2025ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSIMIntegration(requestParameters.simIntegrationDetailsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration(requestParameters: SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2025ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration(requestParameters: SIMIntegrationsV2025ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2025ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations(requestParameters: SIMIntegrationsV2025ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2025ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes(requestParameters: SIMIntegrationsV2025ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2025ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration(requestParameters: SIMIntegrationsV2025ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSIMIntegration operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiCreateSIMIntegrationRequest - */ -export interface SIMIntegrationsV2025ApiCreateSIMIntegrationRequest { - /** - * DTO containing the details of the SIM integration - * @type {SimIntegrationDetailsV2025} - * @memberof SIMIntegrationsV2025ApiCreateSIMIntegration - */ - readonly simIntegrationDetailsV2025: SimIntegrationDetailsV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiCreateSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSIMIntegration operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest - */ -export interface SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest { - /** - * The id of the integration to delete. - * @type {string} - * @memberof SIMIntegrationsV2025ApiDeleteSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiDeleteSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegration operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiGetSIMIntegrationRequest - */ -export interface SIMIntegrationsV2025ApiGetSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2025ApiGetSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiGetSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegrations operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiGetSIMIntegrationsRequest - */ -export interface SIMIntegrationsV2025ApiGetSIMIntegrationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiGetSIMIntegrations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchBeforeProvisioningRule operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest - */ -export interface SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2025ApiPatchBeforeProvisioningRule - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @type {JsonPatchV2025} - * @memberof SIMIntegrationsV2025ApiPatchBeforeProvisioningRule - */ - readonly jsonPatchV2025: JsonPatchV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiPatchBeforeProvisioningRule - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSIMAttributes operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiPatchSIMAttributesRequest - */ -export interface SIMIntegrationsV2025ApiPatchSIMAttributesRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2025ApiPatchSIMAttributes - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM - * @type {JsonPatchV2025} - * @memberof SIMIntegrationsV2025ApiPatchSIMAttributes - */ - readonly jsonPatchV2025: JsonPatchV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiPatchSIMAttributes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSIMIntegration operation in SIMIntegrationsV2025Api. - * @export - * @interface SIMIntegrationsV2025ApiPutSIMIntegrationRequest - */ -export interface SIMIntegrationsV2025ApiPutSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2025ApiPutSIMIntegration - */ - readonly id: string - - /** - * The full DTO of the integration containing the updated model - * @type {SimIntegrationDetailsV2025} - * @memberof SIMIntegrationsV2025ApiPutSIMIntegration - */ - readonly simIntegrationDetailsV2025: SimIntegrationDetailsV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2025ApiPutSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * SIMIntegrationsV2025Api - object-oriented interface - * @export - * @class SIMIntegrationsV2025Api - * @extends {BaseAPI} - */ -export class SIMIntegrationsV2025Api extends BaseAPI { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2025ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public createSIMIntegration(requestParameters: SIMIntegrationsV2025ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).createSIMIntegration(requestParameters.simIntegrationDetailsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public deleteSIMIntegration(requestParameters: SIMIntegrationsV2025ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2025ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public getSIMIntegration(requestParameters: SIMIntegrationsV2025ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2025ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public getSIMIntegrations(requestParameters: SIMIntegrationsV2025ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2025ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2025ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public patchSIMAttributes(requestParameters: SIMIntegrationsV2025ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2025ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2025Api - */ - public putSIMIntegration(requestParameters: SIMIntegrationsV2025ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2025ApiFp(this.configuration).putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODPoliciesV2025Api - axios parameter creator - * @export - */ -export const SODPoliciesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2025} sodPolicyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy: async (sodPolicyV2025: SodPolicyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sodPolicyV2025' is not null or undefined - assertParamExists('createSodPolicy', 'sodPolicyV2025', sodPolicyV2025) - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (logical !== undefined) { - localVarQueryParameter['logical'] = logical; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getCustomViolationReport', 'reportResultId', reportResultId) - // verify required parameter 'fileName' is not null or undefined - assertParamExists('getCustomViolationReport', 'fileName', fileName) - const localVarPath = `/sod-violation-report/{reportResultId}/download/{fileName}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) - .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getDefaultViolationReport', 'reportResultId', reportResultId) - const localVarPath = `/sod-violation-report/{reportResultId}/download` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getSodViolationReportRunStatus', 'reportResultId', reportResultId) - const localVarPath = `/sod-policies/sod-violation-report-status/{reportResultId}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodViolationReportStatus', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2025 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSodPolicy', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchSodPolicy', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2025} sodPolicyScheduleV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule: async (id: string, sodPolicyScheduleV2025: SodPolicyScheduleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putPolicySchedule', 'id', id) - // verify required parameter 'sodPolicyScheduleV2025' is not null or undefined - assertParamExists('putPolicySchedule', 'sodPolicyScheduleV2025', sodPolicyScheduleV2025) - const localVarPath = `/sod-policies/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyScheduleV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2025} sodPolicyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy: async (id: string, sodPolicyV2025: SodPolicyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSodPolicy', 'id', id) - // verify required parameter 'sodPolicyV2025' is not null or undefined - assertParamExists('putSodPolicy', 'sodPolicyV2025', sodPolicyV2025) - const localVarPath = `/sod-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startEvaluateSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/evaluate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2025} [multiPolicyRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg: async (multiPolicyRequestV2025?: MultiPolicyRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiPolicyRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report/run` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODPoliciesV2025Api - functional programming interface - * @export - */ -export const SODPoliciesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODPoliciesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2025} sodPolicyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSodPolicy(sodPolicyV2025: SodPolicyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.createSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicy(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicy(id, logical, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.deleteSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.deleteSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomViolationReport(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReport(reportResultId, fileName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getCustomViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultViolationReport(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReport(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getDefaultViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getSodAllReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportRunStatus(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatus(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getSodViolationReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.getSodViolationReportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.listSodPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2025 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSodPolicy(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.patchSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2025} sodPolicyScheduleV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPolicySchedule(id: string, sodPolicyScheduleV2025: SodPolicyScheduleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicySchedule(id, sodPolicyScheduleV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.putPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2025} sodPolicyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSodPolicy(id: string, sodPolicyV2025: SodPolicyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.putSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startEvaluateSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startEvaluateSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.startEvaluateSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2025} [multiPolicyRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodAllPoliciesForOrg(multiPolicyRequestV2025?: MultiPolicyRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrg(multiPolicyRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.startSodAllPoliciesForOrg']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2025Api.startSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODPoliciesV2025Api - factory interface - * @export - */ -export const SODPoliciesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODPoliciesV2025ApiFp(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2025ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy(requestParameters: SODPoliciesV2025ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSodPolicy(requestParameters.sodPolicyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2025ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy(requestParameters: SODPoliciesV2025ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule(requestParameters: SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2025ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport(requestParameters: SODPoliciesV2025ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2025ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport(requestParameters: SODPoliciesV2025ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodAllReportRunStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2025ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy(requestParameters: SODPoliciesV2025ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2025ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule(requestParameters: SODPoliciesV2025ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus(requestParameters: SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2025ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus(requestParameters: SODPoliciesV2025ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2025ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies(requestParameters: SODPoliciesV2025ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2025ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy(requestParameters: SODPoliciesV2025ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2025ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule(requestParameters: SODPoliciesV2025ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2025ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy(requestParameters: SODPoliciesV2025ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2025ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy(requestParameters: SODPoliciesV2025ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2025ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy(requestParameters: SODPoliciesV2025ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiCreateSodPolicyRequest - */ -export interface SODPoliciesV2025ApiCreateSodPolicyRequest { - /** - * - * @type {SodPolicyV2025} - * @memberof SODPoliciesV2025ApiCreateSodPolicy - */ - readonly sodPolicyV2025: SodPolicyV2025 -} - -/** - * Request parameters for deleteSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiDeleteSodPolicyRequest - */ -export interface SODPoliciesV2025ApiDeleteSodPolicyRequest { - /** - * The ID of the SOD Policy to delete. - * @type {string} - * @memberof SODPoliciesV2025ApiDeleteSodPolicy - */ - readonly id: string - - /** - * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @type {boolean} - * @memberof SODPoliciesV2025ApiDeleteSodPolicy - */ - readonly logical?: boolean -} - -/** - * Request parameters for deleteSodPolicySchedule operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest - */ -export interface SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest { - /** - * The ID of the SOD policy the schedule must be deleted for. - * @type {string} - * @memberof SODPoliciesV2025ApiDeleteSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getCustomViolationReport operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetCustomViolationReportRequest - */ -export interface SODPoliciesV2025ApiGetCustomViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2025ApiGetCustomViolationReport - */ - readonly reportResultId: string - - /** - * Custom Name for the file. - * @type {string} - * @memberof SODPoliciesV2025ApiGetCustomViolationReport - */ - readonly fileName: string -} - -/** - * Request parameters for getDefaultViolationReport operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetDefaultViolationReportRequest - */ -export interface SODPoliciesV2025ApiGetDefaultViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2025ApiGetDefaultViolationReport - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetSodPolicyRequest - */ -export interface SODPoliciesV2025ApiGetSodPolicyRequest { - /** - * The ID of the SOD Policy to retrieve. - * @type {string} - * @memberof SODPoliciesV2025ApiGetSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for getSodPolicySchedule operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetSodPolicyScheduleRequest - */ -export interface SODPoliciesV2025ApiGetSodPolicyScheduleRequest { - /** - * The ID of the SOD policy schedule to retrieve. - * @type {string} - * @memberof SODPoliciesV2025ApiGetSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getSodViolationReportRunStatus operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest - */ -export interface SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest { - /** - * The ID of the report reference to retrieve. - * @type {string} - * @memberof SODPoliciesV2025ApiGetSodViolationReportRunStatus - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodViolationReportStatus operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiGetSodViolationReportStatusRequest - */ -export interface SODPoliciesV2025ApiGetSodViolationReportStatusRequest { - /** - * The ID of the violation report to retrieve status for. - * @type {string} - * @memberof SODPoliciesV2025ApiGetSodViolationReportStatus - */ - readonly id: string -} - -/** - * Request parameters for listSodPolicies operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiListSodPoliciesRequest - */ -export interface SODPoliciesV2025ApiListSodPoliciesRequest { - /** - * 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 SODPoliciesV2025ApiListSodPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SODPoliciesV2025ApiListSodPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SODPoliciesV2025ApiListSodPolicies - */ - 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, in* **name**: *eq, in* **state**: *eq, in* - * @type {string} - * @memberof SODPoliciesV2025ApiListSodPolicies - */ - 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, name, created, modified, description** - * @type {string} - * @memberof SODPoliciesV2025ApiListSodPolicies - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiPatchSodPolicyRequest - */ -export interface SODPoliciesV2025ApiPatchSodPolicyRequest { - /** - * The ID of the SOD policy being modified. - * @type {string} - * @memberof SODPoliciesV2025ApiPatchSodPolicy - */ - readonly id: string - - /** - * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @type {Array} - * @memberof SODPoliciesV2025ApiPatchSodPolicy - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for putPolicySchedule operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiPutPolicyScheduleRequest - */ -export interface SODPoliciesV2025ApiPutPolicyScheduleRequest { - /** - * The ID of the SOD policy to update its schedule. - * @type {string} - * @memberof SODPoliciesV2025ApiPutPolicySchedule - */ - readonly id: string - - /** - * - * @type {SodPolicyScheduleV2025} - * @memberof SODPoliciesV2025ApiPutPolicySchedule - */ - readonly sodPolicyScheduleV2025: SodPolicyScheduleV2025 -} - -/** - * Request parameters for putSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiPutSodPolicyRequest - */ -export interface SODPoliciesV2025ApiPutSodPolicyRequest { - /** - * The ID of the SOD policy to update. - * @type {string} - * @memberof SODPoliciesV2025ApiPutSodPolicy - */ - readonly id: string - - /** - * - * @type {SodPolicyV2025} - * @memberof SODPoliciesV2025ApiPutSodPolicy - */ - readonly sodPolicyV2025: SodPolicyV2025 -} - -/** - * Request parameters for startEvaluateSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiStartEvaluateSodPolicyRequest - */ -export interface SODPoliciesV2025ApiStartEvaluateSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2025ApiStartEvaluateSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for startSodAllPoliciesForOrg operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest - */ -export interface SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest { - /** - * - * @type {MultiPolicyRequestV2025} - * @memberof SODPoliciesV2025ApiStartSodAllPoliciesForOrg - */ - readonly multiPolicyRequestV2025?: MultiPolicyRequestV2025 -} - -/** - * Request parameters for startSodPolicy operation in SODPoliciesV2025Api. - * @export - * @interface SODPoliciesV2025ApiStartSodPolicyRequest - */ -export interface SODPoliciesV2025ApiStartSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2025ApiStartSodPolicy - */ - readonly id: string -} - -/** - * SODPoliciesV2025Api - object-oriented interface - * @export - * @class SODPoliciesV2025Api - * @extends {BaseAPI} - */ -export class SODPoliciesV2025Api extends BaseAPI { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2025ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public createSodPolicy(requestParameters: SODPoliciesV2025ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2025ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public deleteSodPolicy(requestParameters: SODPoliciesV2025ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public deleteSodPolicySchedule(requestParameters: SODPoliciesV2025ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2025ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getCustomViolationReport(requestParameters: SODPoliciesV2025ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2025ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getDefaultViolationReport(requestParameters: SODPoliciesV2025ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getSodAllReportRunStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2025ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getSodPolicy(requestParameters: SODPoliciesV2025ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2025ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getSodPolicySchedule(requestParameters: SODPoliciesV2025ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getSodViolationReportRunStatus(requestParameters: SODPoliciesV2025ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2025ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public getSodViolationReportStatus(requestParameters: SODPoliciesV2025ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2025ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public listSodPolicies(requestParameters: SODPoliciesV2025ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2025ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public patchSodPolicy(requestParameters: SODPoliciesV2025ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2025ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public putPolicySchedule(requestParameters: SODPoliciesV2025ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2025ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public putSodPolicy(requestParameters: SODPoliciesV2025ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2025ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public startEvaluateSodPolicy(requestParameters: SODPoliciesV2025ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2025ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2025ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2025Api - */ - public startSodPolicy(requestParameters: SODPoliciesV2025ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2025ApiFp(this.configuration).startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODViolationsV2025Api - axios parameter creator - * @export - */ -export const SODViolationsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2025} identityWithNewAccessV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations: async (identityWithNewAccessV2025: IdentityWithNewAccessV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2025' is not null or undefined - assertParamExists('startPredictSodViolations', 'identityWithNewAccessV2025', identityWithNewAccessV2025) - const localVarPath = `/sod-violations/predict`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2025} identityWithNewAccessV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck: async (identityWithNewAccessV2025: IdentityWithNewAccessV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2025' is not null or undefined - assertParamExists('startViolationCheck', 'identityWithNewAccessV2025', identityWithNewAccessV2025) - const localVarPath = `/sod-violations/check`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODViolationsV2025Api - functional programming interface - * @export - */ -export const SODViolationsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODViolationsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2025} identityWithNewAccessV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startPredictSodViolations(identityWithNewAccessV2025: IdentityWithNewAccessV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolations(identityWithNewAccessV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2025Api.startPredictSodViolations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2025} identityWithNewAccessV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startViolationCheck(identityWithNewAccessV2025: IdentityWithNewAccessV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startViolationCheck(identityWithNewAccessV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2025Api.startViolationCheck']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODViolationsV2025Api - factory interface - * @export - */ -export const SODViolationsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODViolationsV2025ApiFp(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2025ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations(requestParameters: SODViolationsV2025ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startPredictSodViolations(requestParameters.identityWithNewAccessV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2025ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck(requestParameters: SODViolationsV2025ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startViolationCheck(requestParameters.identityWithNewAccessV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startPredictSodViolations operation in SODViolationsV2025Api. - * @export - * @interface SODViolationsV2025ApiStartPredictSodViolationsRequest - */ -export interface SODViolationsV2025ApiStartPredictSodViolationsRequest { - /** - * - * @type {IdentityWithNewAccessV2025} - * @memberof SODViolationsV2025ApiStartPredictSodViolations - */ - readonly identityWithNewAccessV2025: IdentityWithNewAccessV2025 -} - -/** - * Request parameters for startViolationCheck operation in SODViolationsV2025Api. - * @export - * @interface SODViolationsV2025ApiStartViolationCheckRequest - */ -export interface SODViolationsV2025ApiStartViolationCheckRequest { - /** - * - * @type {IdentityWithNewAccessV2025} - * @memberof SODViolationsV2025ApiStartViolationCheck - */ - readonly identityWithNewAccessV2025: IdentityWithNewAccessV2025 -} - -/** - * SODViolationsV2025Api - object-oriented interface - * @export - * @class SODViolationsV2025Api - * @extends {BaseAPI} - */ -export class SODViolationsV2025Api extends BaseAPI { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2025ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2025Api - */ - public startPredictSodViolations(requestParameters: SODViolationsV2025ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2025ApiFp(this.configuration).startPredictSodViolations(requestParameters.identityWithNewAccessV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2025ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2025Api - */ - public startViolationCheck(requestParameters: SODViolationsV2025ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2025ApiFp(this.configuration).startViolationCheck(requestParameters.identityWithNewAccessV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SPConfigV2025Api - axios parameter creator - * @export - */ -export const SPConfigV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2025} exportPayloadV2025 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig: async (exportPayloadV2025: ExportPayloadV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'exportPayloadV2025' is not null or undefined - assertParamExists('exportSpConfig', 'exportPayloadV2025', exportPayloadV2025) - const localVarPath = `/sp-config/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(exportPayloadV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExport', 'id', id) - const localVarPath = `/sp-config/export/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExportStatus', 'id', id) - const localVarPath = `/sp-config/export/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImport', 'id', id) - const localVarPath = `/sp-config/import/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImportStatus', 'id', id) - const localVarPath = `/sp-config/import/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2025} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig: async (data: File, preview?: boolean, _options?: ImportOptionsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('importSpConfig', 'data', data) - const localVarPath = `/sp-config/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (preview !== undefined) { - localVarQueryParameter['preview'] = preview; - } - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (_options !== undefined) { - localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sp-config/config-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SPConfigV2025Api - functional programming interface - * @export - */ -export const SPConfigV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SPConfigV2025ApiAxiosParamCreator(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2025} exportPayloadV2025 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportSpConfig(exportPayloadV2025: ExportPayloadV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfig(exportPayloadV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.exportSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.getSpConfigExport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.getSpConfigExportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.getSpConfigImport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.getSpConfigImportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2025} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSpConfig(data: File, preview?: boolean, _options?: ImportOptionsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfig(data, preview, _options, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.importSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjects(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2025Api.listSpConfigObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SPConfigV2025Api - factory interface - * @export - */ -export const SPConfigV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SPConfigV2025ApiFp(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2025ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig(requestParameters: SPConfigV2025ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportSpConfig(requestParameters.exportPayloadV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2025ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport(requestParameters: SPConfigV2025ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2025ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus(requestParameters: SPConfigV2025ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2025ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport(requestParameters: SPConfigV2025ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2025ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus(requestParameters: SPConfigV2025ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2025ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig(requestParameters: SPConfigV2025ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSpConfigObjects(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportSpConfig operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiExportSpConfigRequest - */ -export interface SPConfigV2025ApiExportSpConfigRequest { - /** - * Export options control what will be included in the export. - * @type {ExportPayloadV2025} - * @memberof SPConfigV2025ApiExportSpConfig - */ - readonly exportPayloadV2025: ExportPayloadV2025 -} - -/** - * Request parameters for getSpConfigExport operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiGetSpConfigExportRequest - */ -export interface SPConfigV2025ApiGetSpConfigExportRequest { - /** - * The ID of the export job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2025ApiGetSpConfigExport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigExportStatus operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiGetSpConfigExportStatusRequest - */ -export interface SPConfigV2025ApiGetSpConfigExportStatusRequest { - /** - * The ID of the export job whose status will be returned. - * @type {string} - * @memberof SPConfigV2025ApiGetSpConfigExportStatus - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImport operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiGetSpConfigImportRequest - */ -export interface SPConfigV2025ApiGetSpConfigImportRequest { - /** - * The ID of the import job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2025ApiGetSpConfigImport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImportStatus operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiGetSpConfigImportStatusRequest - */ -export interface SPConfigV2025ApiGetSpConfigImportStatusRequest { - /** - * The ID of the import job whose status will be returned. - * @type {string} - * @memberof SPConfigV2025ApiGetSpConfigImportStatus - */ - readonly id: string -} - -/** - * Request parameters for importSpConfig operation in SPConfigV2025Api. - * @export - * @interface SPConfigV2025ApiImportSpConfigRequest - */ -export interface SPConfigV2025ApiImportSpConfigRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof SPConfigV2025ApiImportSpConfig - */ - readonly data: File - - /** - * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @type {boolean} - * @memberof SPConfigV2025ApiImportSpConfig - */ - readonly preview?: boolean - - /** - * - * @type {ImportOptionsV2025} - * @memberof SPConfigV2025ApiImportSpConfig - */ - readonly _options?: ImportOptionsV2025 -} - -/** - * SPConfigV2025Api - object-oriented interface - * @export - * @class SPConfigV2025Api - * @extends {BaseAPI} - */ -export class SPConfigV2025Api extends BaseAPI { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2025ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public exportSpConfig(requestParameters: SPConfigV2025ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).exportSpConfig(requestParameters.exportPayloadV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2025ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public getSpConfigExport(requestParameters: SPConfigV2025ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2025ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public getSpConfigExportStatus(requestParameters: SPConfigV2025ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2025ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public getSpConfigImport(requestParameters: SPConfigV2025ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2025ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public getSpConfigImportStatus(requestParameters: SPConfigV2025ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2025ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public importSpConfig(requestParameters: SPConfigV2025ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2025Api - */ - public listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2025ApiFp(this.configuration).listSpConfigObjects(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SavedSearchV2025Api - axios parameter creator - * @export - */ -export const SavedSearchV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2025} createSavedSearchRequestV2025 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch: async (createSavedSearchRequestV2025: CreateSavedSearchRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createSavedSearchRequestV2025' is not null or undefined - assertParamExists('createSavedSearch', 'createSavedSearchRequestV2025', createSavedSearchRequestV2025) - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createSavedSearchRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2025} searchArgumentsV2025 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch: async (id: string, searchArgumentsV2025: SearchArgumentsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('executeSavedSearch', 'id', id) - // verify required parameter 'searchArgumentsV2025' is not null or undefined - assertParamExists('executeSavedSearch', 'searchArgumentsV2025', searchArgumentsV2025) - const localVarPath = `/saved-searches/{id}/execute` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchArgumentsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2025} savedSearchV2025 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch: async (id: string, savedSearchV2025: SavedSearchV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSavedSearch', 'id', id) - // verify required parameter 'savedSearchV2025' is not null or undefined - assertParamExists('putSavedSearch', 'savedSearchV2025', savedSearchV2025) - const localVarPath = `/saved-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(savedSearchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SavedSearchV2025Api - functional programming interface - * @export - */ -export const SavedSearchV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SavedSearchV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2025} createSavedSearchRequestV2025 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSavedSearch(createSavedSearchRequestV2025: CreateSavedSearchRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSavedSearch(createSavedSearchRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.createSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.deleteSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2025} searchArgumentsV2025 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async executeSavedSearch(id: string, searchArgumentsV2025: SearchArgumentsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.executeSavedSearch(id, searchArgumentsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.executeSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.getSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSavedSearches(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSavedSearches(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.listSavedSearches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2025} savedSearchV2025 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSavedSearch(id: string, savedSearchV2025: SavedSearchV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSavedSearch(id, savedSearchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2025Api.putSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SavedSearchV2025Api - factory interface - * @export - */ -export const SavedSearchV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SavedSearchV2025ApiFp(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2025ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch(requestParameters: SavedSearchV2025ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSavedSearch(requestParameters.createSavedSearchRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2025ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch(requestParameters: SavedSearchV2025ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2025ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch(requestParameters: SavedSearchV2025ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2025ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch(requestParameters: SavedSearchV2025ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2025ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches(requestParameters: SavedSearchV2025ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2025ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch(requestParameters: SavedSearchV2025ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSavedSearch(requestParameters.id, requestParameters.savedSearchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSavedSearch operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiCreateSavedSearchRequest - */ -export interface SavedSearchV2025ApiCreateSavedSearchRequest { - /** - * The saved search to persist. - * @type {CreateSavedSearchRequestV2025} - * @memberof SavedSearchV2025ApiCreateSavedSearch - */ - readonly createSavedSearchRequestV2025: CreateSavedSearchRequestV2025 -} - -/** - * Request parameters for deleteSavedSearch operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiDeleteSavedSearchRequest - */ -export interface SavedSearchV2025ApiDeleteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2025ApiDeleteSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for executeSavedSearch operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiExecuteSavedSearchRequest - */ -export interface SavedSearchV2025ApiExecuteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2025ApiExecuteSavedSearch - */ - readonly id: string - - /** - * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @type {SearchArgumentsV2025} - * @memberof SavedSearchV2025ApiExecuteSavedSearch - */ - readonly searchArgumentsV2025: SearchArgumentsV2025 -} - -/** - * Request parameters for getSavedSearch operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiGetSavedSearchRequest - */ -export interface SavedSearchV2025ApiGetSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2025ApiGetSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for listSavedSearches operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiListSavedSearchesRequest - */ -export interface SavedSearchV2025ApiListSavedSearchesRequest { - /** - * 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 SavedSearchV2025ApiListSavedSearches - */ - 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 SavedSearchV2025ApiListSavedSearches - */ - 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 SavedSearchV2025ApiListSavedSearches - */ - 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: **owner.id**: *eq* - * @type {string} - * @memberof SavedSearchV2025ApiListSavedSearches - */ - readonly filters?: string -} - -/** - * Request parameters for putSavedSearch operation in SavedSearchV2025Api. - * @export - * @interface SavedSearchV2025ApiPutSavedSearchRequest - */ -export interface SavedSearchV2025ApiPutSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2025ApiPutSavedSearch - */ - readonly id: string - - /** - * The saved search to persist. - * @type {SavedSearchV2025} - * @memberof SavedSearchV2025ApiPutSavedSearch - */ - readonly savedSearchV2025: SavedSearchV2025 -} - -/** - * SavedSearchV2025Api - object-oriented interface - * @export - * @class SavedSearchV2025Api - * @extends {BaseAPI} - */ -export class SavedSearchV2025Api extends BaseAPI { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2025ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public createSavedSearch(requestParameters: SavedSearchV2025ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).createSavedSearch(requestParameters.createSavedSearchRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2025ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public deleteSavedSearch(requestParameters: SavedSearchV2025ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2025ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public executeSavedSearch(requestParameters: SavedSearchV2025ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2025ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public getSavedSearch(requestParameters: SavedSearchV2025ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2025ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public listSavedSearches(requestParameters: SavedSearchV2025ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2025ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2025Api - */ - public putSavedSearch(requestParameters: SavedSearchV2025ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2025ApiFp(this.configuration).putSavedSearch(requestParameters.id, requestParameters.savedSearchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ScheduledSearchV2025Api - axios parameter creator - * @export - */ -export const ScheduledSearchV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2025} createScheduledSearchRequestV2025 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch: async (createScheduledSearchRequestV2025: CreateScheduledSearchRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduledSearchRequestV2025' is not null or undefined - assertParamExists('createScheduledSearch', 'createScheduledSearchRequestV2025', createScheduledSearchRequestV2025) - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduledSearchRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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, - }; - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2025} typedReferenceV2025 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch: async (id: string, typedReferenceV2025: TypedReferenceV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'id', id) - // verify required parameter 'typedReferenceV2025' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'typedReferenceV2025', typedReferenceV2025) - const localVarPath = `/scheduled-searches/{id}/unsubscribe` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(typedReferenceV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2025} scheduledSearchV2025 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch: async (id: string, scheduledSearchV2025: ScheduledSearchV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateScheduledSearch', 'id', id) - // verify required parameter 'scheduledSearchV2025' is not null or undefined - assertParamExists('updateScheduledSearch', 'scheduledSearchV2025', scheduledSearchV2025) - const localVarPath = `/scheduled-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledSearchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ScheduledSearchV2025Api - functional programming interface - * @export - */ -export const ScheduledSearchV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ScheduledSearchV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2025} createScheduledSearchRequestV2025 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledSearch(createScheduledSearchRequestV2025: CreateScheduledSearchRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledSearch(createScheduledSearchRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.createScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.deleteScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.getScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledSearch(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledSearch(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.listScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2025} typedReferenceV2025 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unsubscribeScheduledSearch(id: string, typedReferenceV2025: TypedReferenceV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribeScheduledSearch(id, typedReferenceV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.unsubscribeScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2025} scheduledSearchV2025 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledSearch(id: string, scheduledSearchV2025: ScheduledSearchV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledSearch(id, scheduledSearchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2025Api.updateScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ScheduledSearchV2025Api - factory interface - * @export - */ -export const ScheduledSearchV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ScheduledSearchV2025ApiFp(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2025ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch(requestParameters: ScheduledSearchV2025ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledSearch(requestParameters.createScheduledSearchRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2025ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch(requestParameters: ScheduledSearchV2025ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2025ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch(requestParameters: ScheduledSearchV2025ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2025ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch(requestParameters: ScheduledSearchV2025ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2025ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch(requestParameters: ScheduledSearchV2025ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiCreateScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiCreateScheduledSearchRequest { - /** - * The scheduled search to persist. - * @type {CreateScheduledSearchRequestV2025} - * @memberof ScheduledSearchV2025ApiCreateScheduledSearch - */ - readonly createScheduledSearchRequestV2025: CreateScheduledSearchRequestV2025 -} - -/** - * Request parameters for deleteScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiDeleteScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiDeleteScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2025ApiDeleteScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for getScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiGetScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiGetScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2025ApiGetScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for listScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiListScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiListScheduledSearchRequest { - /** - * 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 ScheduledSearchV2025ApiListScheduledSearch - */ - 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 ScheduledSearchV2025ApiListScheduledSearch - */ - 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 ScheduledSearchV2025ApiListScheduledSearch - */ - 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: **owner.id**: *eq* **savedSearchId**: *eq* - * @type {string} - * @memberof ScheduledSearchV2025ApiListScheduledSearch - */ - readonly filters?: string -} - -/** - * Request parameters for unsubscribeScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2025ApiUnsubscribeScheduledSearch - */ - readonly id: string - - /** - * The recipient to be removed from the scheduled search. - * @type {TypedReferenceV2025} - * @memberof ScheduledSearchV2025ApiUnsubscribeScheduledSearch - */ - readonly typedReferenceV2025: TypedReferenceV2025 -} - -/** - * Request parameters for updateScheduledSearch operation in ScheduledSearchV2025Api. - * @export - * @interface ScheduledSearchV2025ApiUpdateScheduledSearchRequest - */ -export interface ScheduledSearchV2025ApiUpdateScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2025ApiUpdateScheduledSearch - */ - readonly id: string - - /** - * The scheduled search to persist. - * @type {ScheduledSearchV2025} - * @memberof ScheduledSearchV2025ApiUpdateScheduledSearch - */ - readonly scheduledSearchV2025: ScheduledSearchV2025 -} - -/** - * ScheduledSearchV2025Api - object-oriented interface - * @export - * @class ScheduledSearchV2025Api - * @extends {BaseAPI} - */ -export class ScheduledSearchV2025Api extends BaseAPI { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2025ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public createScheduledSearch(requestParameters: ScheduledSearchV2025ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).createScheduledSearch(requestParameters.createScheduledSearchRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2025ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public deleteScheduledSearch(requestParameters: ScheduledSearchV2025ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2025ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public getScheduledSearch(requestParameters: ScheduledSearchV2025ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2025ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public listScheduledSearch(requestParameters: ScheduledSearchV2025ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2025ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2025ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2025Api - */ - public updateScheduledSearch(requestParameters: ScheduledSearchV2025ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2025ApiFp(this.configuration).updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SearchV2025Api - axios parameter creator - * @export - */ -export const SearchV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2025} searchV2025 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate: async (searchV2025: SearchV2025, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2025' is not null or undefined - assertParamExists('searchAggregate', 'searchV2025', searchV2025) - const localVarPath = `/search/aggregate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2025} searchV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount: async (searchV2025: SearchV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2025' is not null or undefined - assertParamExists('searchCount', 'searchV2025', searchV2025) - const localVarPath = `/search/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2025} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet: async (index: SearchGetIndexV2025, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'index' is not null or undefined - assertParamExists('searchGet', 'index', index) - // verify required parameter 'id' is not null or undefined - assertParamExists('searchGet', 'id', id) - const localVarPath = `/search/{index}/{id}` - .replace(`{${"index"}}`, encodeURIComponent(String(index))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2025} searchV2025 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost: async (searchV2025: SearchV2025, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2025' is not null or undefined - assertParamExists('searchPost', 'searchV2025', searchV2025) - const localVarPath = `/search`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchV2025Api - functional programming interface - * @export - */ -export const SearchV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchV2025ApiAxiosParamCreator(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2025} searchV2025 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchAggregate(searchV2025: SearchV2025, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchAggregate(searchV2025, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2025Api.searchAggregate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2025} searchV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchCount(searchV2025: SearchV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchCount(searchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2025Api.searchCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2025} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchGet(index: SearchGetIndexV2025, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchGet(index, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2025Api.searchGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2025} searchV2025 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPost(searchV2025: SearchV2025, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPost(searchV2025, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2025Api.searchPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchV2025Api - factory interface - * @export - */ -export const SearchV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchV2025ApiFp(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2025ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate(requestParameters: SearchV2025ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchAggregate(requestParameters.searchV2025, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2025ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount(requestParameters: SearchV2025ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchCount(requestParameters.searchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2025ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet(requestParameters: SearchV2025ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2025ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost(requestParameters: SearchV2025ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchPost(requestParameters.searchV2025, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for searchAggregate operation in SearchV2025Api. - * @export - * @interface SearchV2025ApiSearchAggregateRequest - */ -export interface SearchV2025ApiSearchAggregateRequest { - /** - * - * @type {SearchV2025} - * @memberof SearchV2025ApiSearchAggregate - */ - readonly searchV2025: SearchV2025 - - /** - * 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 SearchV2025ApiSearchAggregate - */ - 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 SearchV2025ApiSearchAggregate - */ - 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 SearchV2025ApiSearchAggregate - */ - readonly count?: boolean -} - -/** - * Request parameters for searchCount operation in SearchV2025Api. - * @export - * @interface SearchV2025ApiSearchCountRequest - */ -export interface SearchV2025ApiSearchCountRequest { - /** - * - * @type {SearchV2025} - * @memberof SearchV2025ApiSearchCount - */ - readonly searchV2025: SearchV2025 -} - -/** - * Request parameters for searchGet operation in SearchV2025Api. - * @export - * @interface SearchV2025ApiSearchGetRequest - */ -export interface SearchV2025ApiSearchGetRequest { - /** - * The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @type {'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'} - * @memberof SearchV2025ApiSearchGet - */ - readonly index: SearchGetIndexV2025 - - /** - * ID of the requested document. - * @type {string} - * @memberof SearchV2025ApiSearchGet - */ - readonly id: string -} - -/** - * Request parameters for searchPost operation in SearchV2025Api. - * @export - * @interface SearchV2025ApiSearchPostRequest - */ -export interface SearchV2025ApiSearchPostRequest { - /** - * - * @type {SearchV2025} - * @memberof SearchV2025ApiSearchPost - */ - readonly searchV2025: SearchV2025 - - /** - * 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 SearchV2025ApiSearchPost - */ - 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 SearchV2025ApiSearchPost - */ - 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 SearchV2025ApiSearchPost - */ - readonly count?: boolean -} - -/** - * SearchV2025Api - object-oriented interface - * @export - * @class SearchV2025Api - * @extends {BaseAPI} - */ -export class SearchV2025Api extends BaseAPI { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2025ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2025Api - */ - public searchAggregate(requestParameters: SearchV2025ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2025ApiFp(this.configuration).searchAggregate(requestParameters.searchV2025, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2025ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2025Api - */ - public searchCount(requestParameters: SearchV2025ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2025ApiFp(this.configuration).searchCount(requestParameters.searchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2025ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2025Api - */ - public searchGet(requestParameters: SearchV2025ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2025ApiFp(this.configuration).searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2025ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2025Api - */ - public searchPost(requestParameters: SearchV2025ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2025ApiFp(this.configuration).searchPost(requestParameters.searchV2025, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SearchGetIndexV2025 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles' -} as const; -export type SearchGetIndexV2025 = typeof SearchGetIndexV2025[keyof typeof SearchGetIndexV2025]; - - -/** - * SearchAttributeConfigurationV2025Api - axios parameter creator - * @export - */ -export const SearchAttributeConfigurationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2025} searchAttributeConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig: async (searchAttributeConfigV2025: SearchAttributeConfigV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchAttributeConfigV2025' is not null or undefined - assertParamExists('createSearchAttributeConfig', 'searchAttributeConfigV2025', searchAttributeConfigV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchAttributeConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig: async (limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getSingleSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig: async (name: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'name', name) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchAttributeConfigurationV2025Api - functional programming interface - * @export - */ -export const SearchAttributeConfigurationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchAttributeConfigurationV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2025} searchAttributeConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSearchAttributeConfig(searchAttributeConfigV2025: SearchAttributeConfigV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfig(searchAttributeConfigV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2025Api.createSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2025Api.deleteSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSearchAttributeConfig(limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2025Api.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSingleSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2025Api.getSingleSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSearchAttributeConfig(name: string, jsonPatchOperationV2025: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfig(name, jsonPatchOperationV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2025Api.patchSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchAttributeConfigurationV2025Api - factory interface - * @export - */ -export const SearchAttributeConfigurationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchAttributeConfigurationV2025ApiFp(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSearchAttributeConfig(requestParameters.searchAttributeConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationV2025Api. - * @export - * @interface SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest { - /** - * - * @type {SearchAttributeConfigV2025} - * @memberof SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfig - */ - readonly searchAttributeConfigV2025: SearchAttributeConfigV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationV2025Api. - * @export - * @interface SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to delete. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationV2025Api. - * @export - * @interface SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest { - /** - * 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 SearchAttributeConfigurationV2025ApiGetSearchAttributeConfig - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SearchAttributeConfigurationV2025ApiGetSearchAttributeConfig - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiGetSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationV2025Api. - * @export - * @interface SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to get. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationV2025Api. - * @export - * @interface SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest { - /** - * Name of the search attribute configuration to patch. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfig - */ - readonly name: string - - /** - * - * @type {Array} - * @memberof SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfig - */ - readonly jsonPatchOperationV2025: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * SearchAttributeConfigurationV2025Api - object-oriented interface - * @export - * @class SearchAttributeConfigurationV2025Api - * @extends {BaseAPI} - */ -export class SearchAttributeConfigurationV2025Api extends BaseAPI { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2025Api - */ - public createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2025ApiFp(this.configuration).createSearchAttributeConfig(requestParameters.searchAttributeConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2025Api - */ - public deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2025ApiFp(this.configuration).deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2025Api - */ - public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2025ApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2025Api - */ - public getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2025ApiFp(this.configuration).getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2025Api - */ - public patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2025ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2025ApiFp(this.configuration).patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SegmentsV2025Api - axios parameter creator - * @export - */ -export const SegmentsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2025} segmentV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment: async (segmentV2025: SegmentV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'segmentV2025' is not null or undefined - assertParamExists('createSegment', 'segmentV2025', segmentV2025) - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(segmentV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSegment', 'requestBody', requestBody) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SegmentsV2025Api - functional programming interface - * @export - */ -export const SegmentsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SegmentsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2025} segmentV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSegment(segmentV2025: SegmentV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSegment(segmentV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2025Api.createSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2025Api.deleteSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2025Api.getSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSegments(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2025Api.listSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSegment(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegment(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2025Api.patchSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SegmentsV2025Api - factory interface - * @export - */ -export const SegmentsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SegmentsV2025ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2025ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment(requestParameters: SegmentsV2025ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSegment(requestParameters.segmentV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2025ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment(requestParameters: SegmentsV2025ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2025ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment(requestParameters: SegmentsV2025ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2025ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments(requestParameters: SegmentsV2025ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2025ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment(requestParameters: SegmentsV2025ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSegment operation in SegmentsV2025Api. - * @export - * @interface SegmentsV2025ApiCreateSegmentRequest - */ -export interface SegmentsV2025ApiCreateSegmentRequest { - /** - * - * @type {SegmentV2025} - * @memberof SegmentsV2025ApiCreateSegment - */ - readonly segmentV2025: SegmentV2025 -} - -/** - * Request parameters for deleteSegment operation in SegmentsV2025Api. - * @export - * @interface SegmentsV2025ApiDeleteSegmentRequest - */ -export interface SegmentsV2025ApiDeleteSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof SegmentsV2025ApiDeleteSegment - */ - readonly id: string -} - -/** - * Request parameters for getSegment operation in SegmentsV2025Api. - * @export - * @interface SegmentsV2025ApiGetSegmentRequest - */ -export interface SegmentsV2025ApiGetSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof SegmentsV2025ApiGetSegment - */ - readonly id: string -} - -/** - * Request parameters for listSegments operation in SegmentsV2025Api. - * @export - * @interface SegmentsV2025ApiListSegmentsRequest - */ -export interface SegmentsV2025ApiListSegmentsRequest { - /** - * 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 SegmentsV2025ApiListSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SegmentsV2025ApiListSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SegmentsV2025ApiListSegments - */ - readonly count?: boolean -} - -/** - * Request parameters for patchSegment operation in SegmentsV2025Api. - * @export - * @interface SegmentsV2025ApiPatchSegmentRequest - */ -export interface SegmentsV2025ApiPatchSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof SegmentsV2025ApiPatchSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @type {Array} - * @memberof SegmentsV2025ApiPatchSegment - */ - readonly requestBody: Array -} - -/** - * SegmentsV2025Api - object-oriented interface - * @export - * @class SegmentsV2025Api - * @extends {BaseAPI} - */ -export class SegmentsV2025Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2025ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2025Api - */ - public createSegment(requestParameters: SegmentsV2025ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2025ApiFp(this.configuration).createSegment(requestParameters.segmentV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2025ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2025Api - */ - public deleteSegment(requestParameters: SegmentsV2025ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2025ApiFp(this.configuration).deleteSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2025ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2025Api - */ - public getSegment(requestParameters: SegmentsV2025ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2025ApiFp(this.configuration).getSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2025ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2025Api - */ - public listSegments(requestParameters: SegmentsV2025ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2025ApiFp(this.configuration).listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2025ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2025Api - */ - public patchSegment(requestParameters: SegmentsV2025ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2025ApiFp(this.configuration).patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ServiceDeskIntegrationV2025Api - axios parameter creator - * @export - */ -export const ServiceDeskIntegrationV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2025} serviceDeskIntegrationDtoV2025 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration: async (serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'serviceDeskIntegrationDtoV2025' is not null or undefined - assertParamExists('createServiceDeskIntegration', 'serviceDeskIntegrationDtoV2025', serviceDeskIntegrationDtoV2025) - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getServiceDeskIntegrationTemplate', 'scriptName', scriptName) - const localVarPath = `/service-desk-integrations/templates/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2025 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2025} serviceDeskIntegrationDtoV2025 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration: async (id: string, serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'id', id) - // verify required parameter 'serviceDeskIntegrationDtoV2025' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'serviceDeskIntegrationDtoV2025', serviceDeskIntegrationDtoV2025) - const localVarPath = `/service-desk-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2025} queuedCheckConfigDetailsV2025 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails: async (queuedCheckConfigDetailsV2025: QueuedCheckConfigDetailsV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'queuedCheckConfigDetailsV2025' is not null or undefined - assertParamExists('updateStatusCheckDetails', 'queuedCheckConfigDetailsV2025', queuedCheckConfigDetailsV2025) - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetailsV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ServiceDeskIntegrationV2025Api - functional programming interface - * @export - */ -export const ServiceDeskIntegrationV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ServiceDeskIntegrationV2025ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2025} serviceDeskIntegrationDtoV2025 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createServiceDeskIntegration(serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegration(serviceDeskIntegrationDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.createServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.deleteServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.getServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.getServiceDeskIntegrationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.getServiceDeskIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrations(offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.getServiceDeskIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetails(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.getStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2025 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchServiceDeskIntegration(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2025} serviceDeskIntegrationDtoV2025 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putServiceDeskIntegration(id: string, serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegration(id, serviceDeskIntegrationDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.putServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2025} queuedCheckConfigDetailsV2025 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStatusCheckDetails(queuedCheckConfigDetailsV2025: QueuedCheckConfigDetailsV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetails(queuedCheckConfigDetailsV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2025Api.updateStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ServiceDeskIntegrationV2025Api - factory interface - * @export - */ -export const ServiceDeskIntegrationV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ServiceDeskIntegrationV2025ApiFp(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusCheckDetails(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createServiceDeskIntegration operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest { - /** - * The specifics of a new integration to create - * @type {ServiceDeskIntegrationDtoV2025} - * @memberof ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025 -} - -/** - * Request parameters for deleteServiceDeskIntegration operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest { - /** - * ID of Service Desk integration to delete - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegration operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to get - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiGetServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegrationTemplate operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest - */ -export interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest { - /** - * The scriptName value of the Service Desk integration template to get - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getServiceDeskIntegrations operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest - */ -export interface ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest { - /** - * 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 ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrations - */ - 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 ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrations - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrations - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrations - */ - readonly filters?: string - - /** - * 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 ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrations - */ - readonly count?: boolean -} - -/** - * Request parameters for patchServiceDeskIntegration operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegration - */ - readonly id: string - - /** - * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @type {Array} - * @memberof ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegration - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2025ApiPutServiceDeskIntegration - */ - readonly id: string - - /** - * The specifics of the integration to update - * @type {ServiceDeskIntegrationDtoV2025} - * @memberof ServiceDeskIntegrationV2025ApiPutServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2025: ServiceDeskIntegrationDtoV2025 -} - -/** - * Request parameters for updateStatusCheckDetails operation in ServiceDeskIntegrationV2025Api. - * @export - * @interface ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest - */ -export interface ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest { - /** - * The modified time check configuration - * @type {QueuedCheckConfigDetailsV2025} - * @memberof ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetails - */ - readonly queuedCheckConfigDetailsV2025: QueuedCheckConfigDetailsV2025 -} - -/** - * ServiceDeskIntegrationV2025Api - object-oriented interface - * @export - * @class ServiceDeskIntegrationV2025Api - * @extends {BaseAPI} - */ -export class ServiceDeskIntegrationV2025Api extends BaseAPI { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2025ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).getStatusCheckDetails(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2025ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2025Api - */ - public updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2025ApiFp(this.configuration).updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SharedSignalsFrameworkSSFV2025Api - axios parameter creator - * @export - */ -export const SharedSignalsFrameworkSSFV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {CreateStreamRequestV2025} createStreamRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createStream: async (createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createStreamRequestV2025' is not null or undefined - assertParamExists('createStream', 'createStreamRequestV2025', createStreamRequestV2025) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createStreamRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteStream: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'streamId' is not null or undefined - assertParamExists('deleteStream', 'streamId', streamId) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJWKSData: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ssf/jwks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSSFConfiguration: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/.well-known/ssf-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStream: async (streamId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {string} streamId ID of the stream whose status to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStreamStatus: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'streamId' is not null or undefined - assertParamExists('getStreamStatus', 'streamId', streamId) - const localVarPath = `/ssf/streams/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {VerificationRequestV2025} verificationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendStreamVerification: async (verificationRequestV2025: VerificationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'verificationRequestV2025' is not null or undefined - assertParamExists('sendStreamVerification', 'verificationRequestV2025', verificationRequestV2025) - const localVarPath = `/ssf/streams/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(verificationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setStreamConfiguration: async (replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'replaceStreamConfigurationRequestV2025' is not null or undefined - assertParamExists('setStreamConfiguration', 'replaceStreamConfigurationRequestV2025', replaceStreamConfigurationRequestV2025) - const localVarPath = `/ssf/streams`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(replaceStreamConfigurationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamConfiguration: async (updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'updateStreamConfigurationRequestV2025' is not null or undefined - assertParamExists('updateStreamConfiguration', 'updateStreamConfigurationRequestV2025', updateStreamConfigurationRequestV2025) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateStreamConfigurationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamStatus: async (updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'updateStreamStatusRequestV2025' is not null or undefined - assertParamExists('updateStreamStatus', 'updateStreamStatusRequestV2025', updateStreamStatusRequestV2025) - const localVarPath = `/ssf/streams/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateStreamStatusRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SharedSignalsFrameworkSSFV2025Api - functional programming interface - * @export - */ -export const SharedSignalsFrameworkSSFV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SharedSignalsFrameworkSSFV2025ApiAxiosParamCreator(configuration) - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {CreateStreamRequestV2025} createStreamRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createStream(createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createStream(createStreamRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.createStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteStream(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStream(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.deleteStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getJWKSData(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getJWKSData(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getJWKSData']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSSFConfiguration(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getSSFConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStream(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStream(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {string} streamId ID of the stream whose status to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStreamStatus(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamStatus(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getStreamStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {VerificationRequestV2025} verificationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendStreamVerification(verificationRequestV2025: VerificationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendStreamVerification(verificationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.sendStreamVerification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setStreamConfiguration(replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setStreamConfiguration(replaceStreamConfigurationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.setStreamConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStreamConfiguration(updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamConfiguration(updateStreamConfigurationRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.updateStreamConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStreamStatus(updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamStatus(updateStreamStatusRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.updateStreamStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SharedSignalsFrameworkSSFV2025Api - factory interface - * @export - */ -export const SharedSignalsFrameworkSSFV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SharedSignalsFrameworkSSFV2025ApiFp(configuration) - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createStream(requestParameters.createStreamRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJWKSData(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getJWKSData(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSSFConfiguration(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendStreamVerification(requestParameters.verificationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStreamStatus(requestParameters.updateStreamStatusRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createStream operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest { - /** - * - * @type {CreateStreamRequestV2025} - * @memberof SharedSignalsFrameworkSSFV2025ApiCreateStream - */ - readonly createStreamRequestV2025: CreateStreamRequestV2025 -} - -/** - * Request parameters for deleteStream operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest { - /** - * ID of the stream to delete. Required; omitted or empty returns 400. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2025ApiDeleteStream - */ - readonly streamId: string -} - -/** - * Request parameters for getStream operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest { - /** - * If provided, returns that stream; otherwise returns list of all streams. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2025ApiGetStream - */ - readonly streamId?: string -} - -/** - * Request parameters for getStreamStatus operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest { - /** - * ID of the stream whose status to retrieve. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2025ApiGetStreamStatus - */ - readonly streamId: string -} - -/** - * Request parameters for sendStreamVerification operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest { - /** - * - * @type {VerificationRequestV2025} - * @memberof SharedSignalsFrameworkSSFV2025ApiSendStreamVerification - */ - readonly verificationRequestV2025: VerificationRequestV2025 -} - -/** - * Request parameters for setStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest { - /** - * - * @type {ReplaceStreamConfigurationRequestV2025} - * @memberof SharedSignalsFrameworkSSFV2025ApiSetStreamConfiguration - */ - readonly replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025 -} - -/** - * Request parameters for updateStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest { - /** - * - * @type {UpdateStreamConfigurationRequestV2025} - * @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfiguration - */ - readonly updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025 -} - -/** - * Request parameters for updateStreamStatus operation in SharedSignalsFrameworkSSFV2025Api. - * @export - * @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest - */ -export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest { - /** - * - * @type {UpdateStreamStatusRequestV2025} - * @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatus - */ - readonly updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025 -} - -/** - * SharedSignalsFrameworkSSFV2025Api - object-oriented interface - * @export - * @class SharedSignalsFrameworkSSFV2025Api - * @extends {BaseAPI} - */ -export class SharedSignalsFrameworkSSFV2025Api extends BaseAPI { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).createStream(requestParameters.createStreamRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public getJWKSData(axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getJWKSData(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getSSFConfiguration(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public getStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).sendStreamVerification(requestParameters.verificationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2025Api - */ - public updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).updateStreamStatus(requestParameters.updateStreamStatusRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourceUsagesV2025Api - axios parameter creator - * @export - */ -export const SourceUsagesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getStatusBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/status` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getUsagesBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/summaries` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * SourceUsagesV2025Api - functional programming interface - * @export - */ -export const SourceUsagesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourceUsagesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusBySourceId(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceId(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2025Api.getStatusBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceId(sourceId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2025Api.getUsagesBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourceUsagesV2025Api - factory interface - * @export - */ -export const SourceUsagesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourceUsagesV2025ApiFp(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2025ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId(requestParameters: SourceUsagesV2025ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2025ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId(requestParameters: SourceUsagesV2025ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getStatusBySourceId operation in SourceUsagesV2025Api. - * @export - * @interface SourceUsagesV2025ApiGetStatusBySourceIdRequest - */ -export interface SourceUsagesV2025ApiGetStatusBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2025ApiGetStatusBySourceId - */ - readonly sourceId: string -} - -/** - * Request parameters for getUsagesBySourceId operation in SourceUsagesV2025Api. - * @export - * @interface SourceUsagesV2025ApiGetUsagesBySourceIdRequest - */ -export interface SourceUsagesV2025ApiGetUsagesBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2025ApiGetUsagesBySourceId - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2025ApiGetUsagesBySourceId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2025ApiGetUsagesBySourceId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourceUsagesV2025ApiGetUsagesBySourceId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof SourceUsagesV2025ApiGetUsagesBySourceId - */ - readonly sorters?: string -} - -/** - * SourceUsagesV2025Api - object-oriented interface - * @export - * @class SourceUsagesV2025Api - * @extends {BaseAPI} - */ -export class SourceUsagesV2025Api extends BaseAPI { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2025ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2025Api - */ - public getStatusBySourceId(requestParameters: SourceUsagesV2025ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2025ApiFp(this.configuration).getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2025ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2025Api - */ - public getUsagesBySourceId(requestParameters: SourceUsagesV2025ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2025ApiFp(this.configuration).getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourcesV2025Api - axios parameter creator - * @export - */ -export const SourcesV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy: async (sourceId: string, provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2025' is not null or undefined - assertParamExists('createProvisioningPolicy', 'provisioningPolicyDtoV2025', provisioningPolicyDtoV2025) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2025} sourceV2025 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource: async (sourceV2025: SourceV2025, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceV2025' is not null or undefined - assertParamExists('createSource', 'sourceV2025', sourceV2025) - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (provisionAsCsv !== undefined) { - localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2025} schedule1V2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule: async (sourceId: string, schedule1V2025: Schedule1V2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'schedule1V2025' is not null or undefined - assertParamExists('createSourceSchedule', 'schedule1V2025', schedule1V2025) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schedule1V2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2025} schemaV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema: async (sourceId: string, schemaV2025: SchemaV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaV2025' is not null or undefined - assertParamExists('createSourceSchema', 'schemaV2025', schemaV2025) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountsAsync', 'id', id) - const localVarPath = `/sources/{id}/remove-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule: async (sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('deleteSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('deleteSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCorrelationConfig', 'id', id) - const localVarPath = `/sources/{id}/correlation-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema: async (id: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('getProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceAttrSyncConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig: async (id: string, locale?: GetSourceConfigLocaleV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceConfig', 'id', id) - const localVarPath = `/sources/{id}/connectors/source-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceConnections', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connections` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceEntitlementRequestConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceHealth', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/source-health` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule: async (sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('getSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedules', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('getSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2025} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas: async (sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2025, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchemas', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeTypes !== undefined) { - localVarQueryParameter['include-types'] = includeTypes; - } - - if (includeNames !== undefined) { - localVarQueryParameter['include-names'] = includeNames; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts: async (id: string, file?: File, disableOptimization?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - if (disableOptimization !== undefined) { - localVarFormParams.append('disableOptimization', disableOptimization as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importConnectorFile', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/upload-connector-file` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importEntitlements', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema: async (id: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importUncorrelatedAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-uncorrelated-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {string} sourceId The Source id - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicyHoldersOnSource: async (sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listPasswordPolicyHoldersOnSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/password-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listProvisioningPolicies', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (includeIDNSource !== undefined) { - localVarQueryParameter['includeIDNSource'] = includeIDNSource; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('pingCluster', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/ping-cluster` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2025} correlationConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig: async (id: string, correlationConfigV2025: CorrelationConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putCorrelationConfig', 'id', id) - // verify required parameter 'correlationConfigV2025' is not null or undefined - assertParamExists('putCorrelationConfig', 'correlationConfigV2025', correlationConfigV2025) - const localVarPath = `/sources/{id}/correlation-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(correlationConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2025} nativeChangeDetectionConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig: async (id: string, nativeChangeDetectionConfigV2025: NativeChangeDetectionConfigV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'id', id) - // verify required parameter 'nativeChangeDetectionConfigV2025' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'nativeChangeDetectionConfigV2025', nativeChangeDetectionConfigV2025) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nativeChangeDetectionConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2025, provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('putProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'provisioningPolicyDtoV2025' is not null or undefined - assertParamExists('putProvisioningPolicy', 'provisioningPolicyDtoV2025', provisioningPolicyDtoV2025) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2025} sourceV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource: async (id: string, sourceV2025: SourceV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSource', 'id', id) - // verify required parameter 'sourceV2025' is not null or undefined - assertParamExists('putSource', 'sourceV2025', sourceV2025) - const localVarPath = `/sources/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2025} attrSyncSourceConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig: async (id: string, attrSyncSourceConfigV2025: AttrSyncSourceConfigV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'id', id) - // verify required parameter 'attrSyncSourceConfigV2025' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'attrSyncSourceConfigV2025', attrSyncSourceConfigV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attrSyncSourceConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2025} schemaV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema: async (sourceId: string, schemaId: string, schemaV2025: SchemaV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('putSourceSchema', 'schemaId', schemaId) - // verify required parameter 'schemaV2025' is not null or undefined - assertParamExists('putSourceSchema', 'schemaV2025', schemaV2025) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2025} resourceObjectsRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects: async (sourceId: string, resourceObjectsRequestV2025: ResourceObjectsRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('searchResourceObjects', 'sourceId', sourceId) - // verify required parameter 'resourceObjectsRequestV2025' is not null or undefined - assertParamExists('searchResourceObjects', 'resourceObjectsRequestV2025', resourceObjectsRequestV2025) - const localVarPath = `/sources/{sourceId}/connector/peek-resource-objects` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(resourceObjectsRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('syncAttributesForSource', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/synchronize-attributes` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConfiguration', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/test-configuration` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnection', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/check-connection` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders: async (sourceId: string, passwordPolicyHoldersDtoInnerV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'sourceId', sourceId) - // verify required parameter 'passwordPolicyHoldersDtoInnerV2025' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'passwordPolicyHoldersDtoInnerV2025', passwordPolicyHoldersDtoInnerV2025) - const localVarPath = `/sources/{sourceId}/password-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyHoldersDtoInnerV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk: async (sourceId: string, provisioningPolicyDtoV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2025' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'provisioningPolicyDtoV2025', provisioningPolicyDtoV2025) - const localVarPath = `/sources/{sourceId}/provisioning-policies/bulk-update` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2025, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2025 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSource', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateSource', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2025} sourceEntitlementRequestConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig: async (id: string, sourceEntitlementRequestConfigV2025: SourceEntitlementRequestConfigV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'id', id) - // verify required parameter 'sourceEntitlementRequestConfigV2025' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'sourceEntitlementRequestConfigV2025', sourceEntitlementRequestConfigV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceEntitlementRequestConfigV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule: async (sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2025, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('updateSourceSchedule', 'scheduleType', scheduleType) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateSourceSchedule', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema: async (sourceId: string, schemaId: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('updateSourceSchema', 'schemaId', schemaId) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateSourceSchema', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SourcesV2025Api - functional programming interface - * @export - */ -export const SourcesV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourcesV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createProvisioningPolicy(sourceId: string, provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicy(sourceId, provisioningPolicyDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.createProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2025} sourceV2025 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSource(sourceV2025: SourceV2025, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSource(sourceV2025, provisionAsCsv, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.createSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2025} schedule1V2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchedule(sourceId: string, schedule1V2025: Schedule1V2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchedule(sourceId, schedule1V2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.createSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2025} schemaV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchema(sourceId: string, schemaV2025: SchemaV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchema(sourceId, schemaV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.createSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountsAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountsAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteAccountsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteProvisioningPolicy(sourceId: string, usageType: UsageTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchedule(sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.deleteSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountsSchema(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountsSchema(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCorrelationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCorrelationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsSchema(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsSchema(id, schemaName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProvisioningPolicy(sourceId: string, usageType: UsageTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceAttrSyncConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAttrSyncConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2025} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConfig(id: string, locale?: GetSourceConfigLocaleV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConfig(id, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceEntitlementRequestConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementRequestConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceHealth(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceHealth(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceHealth']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedule(sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedules(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedules(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceSchedules']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2025} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchemas(sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2025, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemas(sourceId, includeTypes, includeNames, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.getSourceSchemas']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccounts(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccounts(id, file, disableOptimization, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccountsSchema(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsSchema(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importConnectorFile(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importConnectorFile(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importConnectorFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlements(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlements(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlementsSchema(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsSchema(id, schemaName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importUncorrelatedAccounts(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importUncorrelatedAccounts(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.importUncorrelatedAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {string} sourceId The Source id - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicyHoldersOnSource(sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicyHoldersOnSource(sourceId, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.listPasswordPolicyHoldersOnSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listProvisioningPolicies(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPolicies(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.listProvisioningPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSources(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSources(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.listSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingCluster(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingCluster(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.pingCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2025} correlationConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCorrelationConfig(id: string, correlationConfigV2025: CorrelationConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCorrelationConfig(id, correlationConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2025} nativeChangeDetectionConfigV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putNativeChangeDetectionConfig(id: string, nativeChangeDetectionConfigV2025: NativeChangeDetectionConfigV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putNativeChangeDetectionConfig(id, nativeChangeDetectionConfigV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2025} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putProvisioningPolicy(sourceId: string, usageType: UsageTypeV2025, provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicy(sourceId, usageType, provisioningPolicyDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2025} sourceV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSource(id: string, sourceV2025: SourceV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSource(id, sourceV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2025} attrSyncSourceConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceAttrSyncConfig(id: string, attrSyncSourceConfigV2025: AttrSyncSourceConfigV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceAttrSyncConfig(id, attrSyncSourceConfigV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2025} schemaV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceSchema(sourceId: string, schemaId: string, schemaV2025: SchemaV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchema(sourceId, schemaId, schemaV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.putSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2025} resourceObjectsRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchResourceObjects(sourceId: string, resourceObjectsRequestV2025: ResourceObjectsRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchResourceObjects(sourceId, resourceObjectsRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.searchResourceObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncAttributesForSource(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncAttributesForSource(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.syncAttributesForSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConfiguration(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConfiguration(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.testSourceConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnection(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnection(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.testSourceConnection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordPolicyHolders(sourceId: string, passwordPolicyHoldersDtoInnerV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordPolicyHolders(sourceId, passwordPolicyHoldersDtoInnerV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updatePasswordPolicyHolders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDtoV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulk(sourceId, provisioningPolicyDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateProvisioningPoliciesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2025} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPolicy(sourceId: string, usageType: UsageTypeV2025, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicy(sourceId, usageType, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2025 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSource(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSource(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2025} sourceEntitlementRequestConfigV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceEntitlementRequestConfig(id: string, sourceEntitlementRequestConfigV2025: SourceEntitlementRequestConfigV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceEntitlementRequestConfig(id, sourceEntitlementRequestConfigV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2025} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchedule(sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2025, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchedule(sourceId, scheduleType, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchema(sourceId, schemaId, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2025Api.updateSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourcesV2025Api - factory interface - * @export - */ -export const SourcesV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourcesV2025ApiFp(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2025ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy(requestParameters: SourcesV2025ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2025ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource(requestParameters: SourcesV2025ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSource(requestParameters.sourceV2025, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2025ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule(requestParameters: SourcesV2025ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2025ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema(requestParameters: SourcesV2025ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2025ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync(requestParameters: SourcesV2025ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2025ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy(requestParameters: SourcesV2025ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2025ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource(requestParameters: SourcesV2025ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2025ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule(requestParameters: SourcesV2025ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schema by id - * @param {SourcesV2025ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema(requestParameters: SourcesV2025ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2025ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema(requestParameters: SourcesV2025ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2025ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig(requestParameters: SourcesV2025ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2025ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema(requestParameters: SourcesV2025ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2025ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2025ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy(requestParameters: SourcesV2025ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2025ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource(requestParameters: SourcesV2025ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2025ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig(requestParameters: SourcesV2025ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2025ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig(requestParameters: SourcesV2025ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2025ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections(requestParameters: SourcesV2025ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2025ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig(requestParameters: SourcesV2025ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2025ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth(requestParameters: SourcesV2025ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2025ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule(requestParameters: SourcesV2025ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2025ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules(requestParameters: SourcesV2025ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2025ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema(requestParameters: SourcesV2025ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2025ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas(requestParameters: SourcesV2025ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2025ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts(requestParameters: SourcesV2025ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2025ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema(requestParameters: SourcesV2025ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2025ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile(requestParameters: SourcesV2025ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2025ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements(requestParameters: SourcesV2025ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2025ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema(requestParameters: SourcesV2025ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2025ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts(requestParameters: SourcesV2025ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicyHoldersOnSource(requestParameters: SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicyHoldersOnSource(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2025ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies(requestParameters: SourcesV2025ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2025ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources(requestParameters: SourcesV2025ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2025ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster(requestParameters: SourcesV2025ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2025ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig(requestParameters: SourcesV2025ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2025ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2025ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy(requestParameters: SourcesV2025ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2025ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource(requestParameters: SourcesV2025ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSource(requestParameters.id, requestParameters.sourceV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2025ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig(requestParameters: SourcesV2025ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2025ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema(requestParameters: SourcesV2025ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2025ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects(requestParameters: SourcesV2025ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2025ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource(requestParameters: SourcesV2025ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2025ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration(requestParameters: SourcesV2025ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2025ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection(requestParameters: SourcesV2025ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2025ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders(requestParameters: SourcesV2025ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk(requestParameters: SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2025ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy(requestParameters: SourcesV2025ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2025ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource(requestParameters: SourcesV2025ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig(requestParameters: SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2025ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule(requestParameters: SourcesV2025ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2025ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema(requestParameters: SourcesV2025ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createProvisioningPolicy operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiCreateProvisioningPolicyRequest - */ -export interface SourcesV2025ApiCreateProvisioningPolicyRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiCreateProvisioningPolicy - */ - readonly sourceId: string - - /** - * - * @type {ProvisioningPolicyDtoV2025} - * @memberof SourcesV2025ApiCreateProvisioningPolicy - */ - readonly provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025 -} - -/** - * Request parameters for createSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiCreateSourceRequest - */ -export interface SourcesV2025ApiCreateSourceRequest { - /** - * - * @type {SourceV2025} - * @memberof SourcesV2025ApiCreateSource - */ - readonly sourceV2025: SourceV2025 - - /** - * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @type {boolean} - * @memberof SourcesV2025ApiCreateSource - */ - readonly provisionAsCsv?: boolean -} - -/** - * Request parameters for createSourceSchedule operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiCreateSourceScheduleRequest - */ -export interface SourcesV2025ApiCreateSourceScheduleRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiCreateSourceSchedule - */ - readonly sourceId: string - - /** - * - * @type {Schedule1V2025} - * @memberof SourcesV2025ApiCreateSourceSchedule - */ - readonly schedule1V2025: Schedule1V2025 -} - -/** - * Request parameters for createSourceSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiCreateSourceSchemaRequest - */ -export interface SourcesV2025ApiCreateSourceSchemaRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiCreateSourceSchema - */ - readonly sourceId: string - - /** - * - * @type {SchemaV2025} - * @memberof SourcesV2025ApiCreateSourceSchema - */ - readonly schemaV2025: SchemaV2025 -} - -/** - * Request parameters for deleteAccountsAsync operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteAccountsAsyncRequest - */ -export interface SourcesV2025ApiDeleteAccountsAsyncRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiDeleteAccountsAsync - */ - readonly id: string -} - -/** - * Request parameters for deleteNativeChangeDetectionConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest - */ -export interface SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiDeleteNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for deleteProvisioningPolicy operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteProvisioningPolicyRequest - */ -export interface SourcesV2025ApiDeleteProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2025ApiDeleteProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2025} - * @memberof SourcesV2025ApiDeleteProvisioningPolicy - */ - readonly usageType: UsageTypeV2025 -} - -/** - * Request parameters for deleteSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteSourceRequest - */ -export interface SourcesV2025ApiDeleteSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiDeleteSource - */ - readonly id: string -} - -/** - * Request parameters for deleteSourceSchedule operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteSourceScheduleRequest - */ -export interface SourcesV2025ApiDeleteSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiDeleteSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2025ApiDeleteSourceSchedule - */ - readonly scheduleType: DeleteSourceScheduleScheduleTypeV2025 -} - -/** - * Request parameters for deleteSourceSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiDeleteSourceSchemaRequest - */ -export interface SourcesV2025ApiDeleteSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiDeleteSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2025ApiDeleteSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getAccountsSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetAccountsSchemaRequest - */ -export interface SourcesV2025ApiGetAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiGetAccountsSchema - */ - readonly id: string -} - -/** - * Request parameters for getCorrelationConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetCorrelationConfigRequest - */ -export interface SourcesV2025ApiGetCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiGetCorrelationConfig - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementsSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetEntitlementsSchemaRequest - */ -export interface SourcesV2025ApiGetEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiGetEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2025ApiGetEntitlementsSchema - */ - readonly schemaName?: string -} - -/** - * Request parameters for getNativeChangeDetectionConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetNativeChangeDetectionConfigRequest - */ -export interface SourcesV2025ApiGetNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiGetNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for getProvisioningPolicy operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetProvisioningPolicyRequest - */ -export interface SourcesV2025ApiGetProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2025ApiGetProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2025} - * @memberof SourcesV2025ApiGetProvisioningPolicy - */ - readonly usageType: UsageTypeV2025 -} - -/** - * Request parameters for getSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceRequest - */ -export interface SourcesV2025ApiGetSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiGetSource - */ - readonly id: string -} - -/** - * Request parameters for getSourceAttrSyncConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceAttrSyncConfigRequest - */ -export interface SourcesV2025ApiGetSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiGetSourceAttrSyncConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2025ApiGetSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceConfigRequest - */ -export interface SourcesV2025ApiGetSourceConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiGetSourceConfig - */ - readonly id: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof SourcesV2025ApiGetSourceConfig - */ - readonly locale?: GetSourceConfigLocaleV2025 -} - -/** - * Request parameters for getSourceConnections operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceConnectionsRequest - */ -export interface SourcesV2025ApiGetSourceConnectionsRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiGetSourceConnections - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceEntitlementRequestConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2025ApiGetSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiGetSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2025ApiGetSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceHealth operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceHealthRequest - */ -export interface SourcesV2025ApiGetSourceHealthRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiGetSourceHealth - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchedule operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceScheduleRequest - */ -export interface SourcesV2025ApiGetSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2025ApiGetSourceSchedule - */ - readonly scheduleType: GetSourceScheduleScheduleTypeV2025 -} - -/** - * Request parameters for getSourceSchedules operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceSchedulesRequest - */ -export interface SourcesV2025ApiGetSourceSchedulesRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchedules - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceSchemaRequest - */ -export interface SourcesV2025ApiGetSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getSourceSchemas operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiGetSourceSchemasRequest - */ -export interface SourcesV2025ApiGetSourceSchemasRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchemas - */ - readonly sourceId: string - - /** - * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @type {'group' | 'user'} - * @memberof SourcesV2025ApiGetSourceSchemas - */ - readonly includeTypes?: GetSourceSchemasIncludeTypesV2025 - - /** - * A comma-separated list of schema names to filter result. - * @type {string} - * @memberof SourcesV2025ApiGetSourceSchemas - */ - readonly includeNames?: string -} - -/** - * Request parameters for importAccounts operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportAccountsRequest - */ -export interface SourcesV2025ApiImportAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2025ApiImportAccounts - */ - readonly id: string - - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof SourcesV2025ApiImportAccounts - */ - readonly file?: File - - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof SourcesV2025ApiImportAccounts - */ - readonly disableOptimization?: string -} - -/** - * Request parameters for importAccountsSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportAccountsSchemaRequest - */ -export interface SourcesV2025ApiImportAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiImportAccountsSchema - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2025ApiImportAccountsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importConnectorFile operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportConnectorFileRequest - */ -export interface SourcesV2025ApiImportConnectorFileRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiImportConnectorFile - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesV2025ApiImportConnectorFile - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlements operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportEntitlementsRequest - */ -export interface SourcesV2025ApiImportEntitlementsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2025ApiImportEntitlements - */ - readonly sourceId: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof SourcesV2025ApiImportEntitlements - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlementsSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportEntitlementsSchemaRequest - */ -export interface SourcesV2025ApiImportEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiImportEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2025ApiImportEntitlementsSchema - */ - readonly schemaName?: string - - /** - * - * @type {File} - * @memberof SourcesV2025ApiImportEntitlementsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importUncorrelatedAccounts operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiImportUncorrelatedAccountsRequest - */ -export interface SourcesV2025ApiImportUncorrelatedAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2025ApiImportUncorrelatedAccounts - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2025ApiImportUncorrelatedAccounts - */ - readonly file?: File -} - -/** - * Request parameters for listPasswordPolicyHoldersOnSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest - */ -export interface SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiListPasswordPolicyHoldersOnSource - */ - readonly sourceId: string - - /** - * 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 SourcesV2025ApiListPasswordPolicyHoldersOnSource - */ - 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 SourcesV2025ApiListPasswordPolicyHoldersOnSource - */ - 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 SourcesV2025ApiListPasswordPolicyHoldersOnSource - */ - readonly count?: boolean -} - -/** - * Request parameters for listProvisioningPolicies operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiListProvisioningPoliciesRequest - */ -export interface SourcesV2025ApiListProvisioningPoliciesRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiListProvisioningPolicies - */ - readonly sourceId: string -} - -/** - * Request parameters for listSources operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiListSourcesRequest - */ -export interface SourcesV2025ApiListSourcesRequest { - /** - * 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 SourcesV2025ApiListSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourcesV2025ApiListSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourcesV2025ApiListSources - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof SourcesV2025ApiListSources - */ - 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @type {string} - * @memberof SourcesV2025ApiListSources - */ - readonly sorters?: string - - /** - * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @type {string} - * @memberof SourcesV2025ApiListSources - */ - readonly forSubadmin?: string - - /** - * Include the IdentityNow source in the response. - * @type {boolean} - * @memberof SourcesV2025ApiListSources - */ - readonly includeIDNSource?: boolean -} - -/** - * Request parameters for pingCluster operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPingClusterRequest - */ -export interface SourcesV2025ApiPingClusterRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2025ApiPingCluster - */ - readonly sourceId: string -} - -/** - * Request parameters for putCorrelationConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutCorrelationConfigRequest - */ -export interface SourcesV2025ApiPutCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiPutCorrelationConfig - */ - readonly id: string - - /** - * - * @type {CorrelationConfigV2025} - * @memberof SourcesV2025ApiPutCorrelationConfig - */ - readonly correlationConfigV2025: CorrelationConfigV2025 -} - -/** - * Request parameters for putNativeChangeDetectionConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutNativeChangeDetectionConfigRequest - */ -export interface SourcesV2025ApiPutNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiPutNativeChangeDetectionConfig - */ - readonly id: string - - /** - * - * @type {NativeChangeDetectionConfigV2025} - * @memberof SourcesV2025ApiPutNativeChangeDetectionConfig - */ - readonly nativeChangeDetectionConfigV2025: NativeChangeDetectionConfigV2025 -} - -/** - * Request parameters for putProvisioningPolicy operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutProvisioningPolicyRequest - */ -export interface SourcesV2025ApiPutProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2025ApiPutProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2025} - * @memberof SourcesV2025ApiPutProvisioningPolicy - */ - readonly usageType: UsageTypeV2025 - - /** - * - * @type {ProvisioningPolicyDtoV2025} - * @memberof SourcesV2025ApiPutProvisioningPolicy - */ - readonly provisioningPolicyDtoV2025: ProvisioningPolicyDtoV2025 -} - -/** - * Request parameters for putSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutSourceRequest - */ -export interface SourcesV2025ApiPutSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiPutSource - */ - readonly id: string - - /** - * - * @type {SourceV2025} - * @memberof SourcesV2025ApiPutSource - */ - readonly sourceV2025: SourceV2025 -} - -/** - * Request parameters for putSourceAttrSyncConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutSourceAttrSyncConfigRequest - */ -export interface SourcesV2025ApiPutSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2025ApiPutSourceAttrSyncConfig - */ - readonly id: string - - /** - * - * @type {AttrSyncSourceConfigV2025} - * @memberof SourcesV2025ApiPutSourceAttrSyncConfig - */ - readonly attrSyncSourceConfigV2025: AttrSyncSourceConfigV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2025ApiPutSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSourceSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiPutSourceSchemaRequest - */ -export interface SourcesV2025ApiPutSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiPutSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2025ApiPutSourceSchema - */ - readonly schemaId: string - - /** - * - * @type {SchemaV2025} - * @memberof SourcesV2025ApiPutSourceSchema - */ - readonly schemaV2025: SchemaV2025 -} - -/** - * Request parameters for searchResourceObjects operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiSearchResourceObjectsRequest - */ -export interface SourcesV2025ApiSearchResourceObjectsRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2025ApiSearchResourceObjects - */ - readonly sourceId: string - - /** - * - * @type {ResourceObjectsRequestV2025} - * @memberof SourcesV2025ApiSearchResourceObjects - */ - readonly resourceObjectsRequestV2025: ResourceObjectsRequestV2025 -} - -/** - * Request parameters for syncAttributesForSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiSyncAttributesForSourceRequest - */ -export interface SourcesV2025ApiSyncAttributesForSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiSyncAttributesForSource - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2025ApiSyncAttributesForSource - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for testSourceConfiguration operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiTestSourceConfigurationRequest - */ -export interface SourcesV2025ApiTestSourceConfigurationRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2025ApiTestSourceConfiguration - */ - readonly sourceId: string -} - -/** - * Request parameters for testSourceConnection operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiTestSourceConnectionRequest - */ -export interface SourcesV2025ApiTestSourceConnectionRequest { - /** - * The ID of the Source. - * @type {string} - * @memberof SourcesV2025ApiTestSourceConnection - */ - readonly sourceId: string -} - -/** - * Request parameters for updatePasswordPolicyHolders operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdatePasswordPolicyHoldersRequest - */ -export interface SourcesV2025ApiUpdatePasswordPolicyHoldersRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiUpdatePasswordPolicyHolders - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2025ApiUpdatePasswordPolicyHolders - */ - readonly passwordPolicyHoldersDtoInnerV2025: Array -} - -/** - * Request parameters for updateProvisioningPoliciesInBulk operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest - */ -export interface SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiUpdateProvisioningPoliciesInBulk - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2025ApiUpdateProvisioningPoliciesInBulk - */ - readonly provisioningPolicyDtoV2025: Array -} - -/** - * Request parameters for updateProvisioningPolicy operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateProvisioningPolicyRequest - */ -export interface SourcesV2025ApiUpdateProvisioningPolicyRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiUpdateProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2025} - * @memberof SourcesV2025ApiUpdateProvisioningPolicy - */ - readonly usageType: UsageTypeV2025 - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2025ApiUpdateProvisioningPolicy - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateSource operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateSourceRequest - */ -export interface SourcesV2025ApiUpdateSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2025ApiUpdateSource - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @type {Array} - * @memberof SourcesV2025ApiUpdateSource - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateSourceEntitlementRequestConfig operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2025ApiUpdateSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {SourceEntitlementRequestConfigV2025} - * @memberof SourcesV2025ApiUpdateSourceEntitlementRequestConfig - */ - readonly sourceEntitlementRequestConfigV2025: SourceEntitlementRequestConfigV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2025ApiUpdateSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateSourceSchedule operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateSourceScheduleRequest - */ -export interface SourcesV2025ApiUpdateSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiUpdateSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2025ApiUpdateSourceSchedule - */ - readonly scheduleType: UpdateSourceScheduleScheduleTypeV2025 - - /** - * The JSONPatch payload used to update the schedule. - * @type {Array} - * @memberof SourcesV2025ApiUpdateSourceSchedule - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for updateSourceSchema operation in SourcesV2025Api. - * @export - * @interface SourcesV2025ApiUpdateSourceSchemaRequest - */ -export interface SourcesV2025ApiUpdateSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2025ApiUpdateSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2025ApiUpdateSourceSchema - */ - readonly schemaId: string - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2025ApiUpdateSourceSchema - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * SourcesV2025Api - object-oriented interface - * @export - * @class SourcesV2025Api - * @extends {BaseAPI} - */ -export class SourcesV2025Api extends BaseAPI { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2025ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public createProvisioningPolicy(requestParameters: SourcesV2025ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2025ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public createSource(requestParameters: SourcesV2025ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).createSource(requestParameters.sourceV2025, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2025ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public createSourceSchedule(requestParameters: SourcesV2025ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2025ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public createSourceSchema(requestParameters: SourcesV2025ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2025ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteAccountsAsync(requestParameters: SourcesV2025ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2025ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteProvisioningPolicy(requestParameters: SourcesV2025ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2025ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteSource(requestParameters: SourcesV2025ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2025ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteSourceSchedule(requestParameters: SourcesV2025ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schema by id - * @param {SourcesV2025ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public deleteSourceSchema(requestParameters: SourcesV2025ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2025ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getAccountsSchema(requestParameters: SourcesV2025ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2025ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getCorrelationConfig(requestParameters: SourcesV2025ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2025ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getEntitlementsSchema(requestParameters: SourcesV2025ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2025ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2025ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getProvisioningPolicy(requestParameters: SourcesV2025ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2025ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSource(requestParameters: SourcesV2025ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2025ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceAttrSyncConfig(requestParameters: SourcesV2025ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2025ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceConfig(requestParameters: SourcesV2025ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2025ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceConnections(requestParameters: SourcesV2025ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2025ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceEntitlementRequestConfig(requestParameters: SourcesV2025ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2025ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceHealth(requestParameters: SourcesV2025ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2025ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceSchedule(requestParameters: SourcesV2025ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2025ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceSchedules(requestParameters: SourcesV2025ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2025ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceSchema(requestParameters: SourcesV2025ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2025ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public getSourceSchemas(requestParameters: SourcesV2025ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2025ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importAccounts(requestParameters: SourcesV2025ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2025ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importAccountsSchema(requestParameters: SourcesV2025ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2025ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importConnectorFile(requestParameters: SourcesV2025ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2025ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importEntitlements(requestParameters: SourcesV2025ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2025ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importEntitlementsSchema(requestParameters: SourcesV2025ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2025ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public importUncorrelatedAccounts(requestParameters: SourcesV2025ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public listPasswordPolicyHoldersOnSource(requestParameters: SourcesV2025ApiListPasswordPolicyHoldersOnSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).listPasswordPolicyHoldersOnSource(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2025ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public listProvisioningPolicies(requestParameters: SourcesV2025ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2025ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public listSources(requestParameters: SourcesV2025ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2025ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public pingCluster(requestParameters: SourcesV2025ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2025ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putCorrelationConfig(requestParameters: SourcesV2025ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2025ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putNativeChangeDetectionConfig(requestParameters: SourcesV2025ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2025ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putProvisioningPolicy(requestParameters: SourcesV2025ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2025ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putSource(requestParameters: SourcesV2025ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putSource(requestParameters.id, requestParameters.sourceV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2025ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putSourceAttrSyncConfig(requestParameters: SourcesV2025ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2025ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public putSourceSchema(requestParameters: SourcesV2025ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2025ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public searchResourceObjects(requestParameters: SourcesV2025ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2025ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public syncAttributesForSource(requestParameters: SourcesV2025ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2025ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public testSourceConfiguration(requestParameters: SourcesV2025ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2025ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public testSourceConnection(requestParameters: SourcesV2025ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2025ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updatePasswordPolicyHolders(requestParameters: SourcesV2025ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateProvisioningPoliciesInBulk(requestParameters: SourcesV2025ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2025ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateProvisioningPolicy(requestParameters: SourcesV2025ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2025ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateSource(requestParameters: SourcesV2025ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateSourceEntitlementRequestConfig(requestParameters: SourcesV2025ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2025ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateSourceSchedule(requestParameters: SourcesV2025ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2025ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2025Api - */ - public updateSourceSchema(requestParameters: SourcesV2025ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2025ApiFp(this.configuration).updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteSourceScheduleScheduleTypeV2025 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type DeleteSourceScheduleScheduleTypeV2025 = typeof DeleteSourceScheduleScheduleTypeV2025[keyof typeof DeleteSourceScheduleScheduleTypeV2025]; -/** - * @export - */ -export const GetSourceConfigLocaleV2025 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetSourceConfigLocaleV2025 = typeof GetSourceConfigLocaleV2025[keyof typeof GetSourceConfigLocaleV2025]; -/** - * @export - */ -export const GetSourceScheduleScheduleTypeV2025 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type GetSourceScheduleScheduleTypeV2025 = typeof GetSourceScheduleScheduleTypeV2025[keyof typeof GetSourceScheduleScheduleTypeV2025]; -/** - * @export - */ -export const GetSourceSchemasIncludeTypesV2025 = { - Group: 'group', - User: 'user' -} as const; -export type GetSourceSchemasIncludeTypesV2025 = typeof GetSourceSchemasIncludeTypesV2025[keyof typeof GetSourceSchemasIncludeTypesV2025]; -/** - * @export - */ -export const UpdateSourceScheduleScheduleTypeV2025 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type UpdateSourceScheduleScheduleTypeV2025 = typeof UpdateSourceScheduleScheduleTypeV2025[keyof typeof UpdateSourceScheduleScheduleTypeV2025]; - - -/** - * SuggestedEntitlementDescriptionV2025Api - axios parameter creator - * @export - */ -export const SuggestedEntitlementDescriptionV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats: async (batchId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'batchId' is not null or undefined - assertParamExists('getSedBatchStats', 'batchId', batchId) - const localVarPath = `/suggested-entitlement-description-batches/{batchId}/stats` - .replace(`{${"batchId"}}`, encodeURIComponent(String(batchId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches: async (offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-descriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (requestedByAnyone !== undefined) { - localVarQueryParameter['requested-by-anyone'] = requestedByAnyone; - } - - if (showPendingStatusOnly !== undefined) { - localVarQueryParameter['show-pending-status-only'] = showPendingStatusOnly; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2025 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed: async (id: string, sedPatchV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSed', 'id', id) - // verify required parameter 'sedPatchV2025' is not null or undefined - assertParamExists('patchSed', 'sedPatchV2025', sedPatchV2025) - const localVarPath = `/suggested-entitlement-descriptions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedPatchV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2025 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval: async (sedApprovalV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedApprovalV2025' is not null or undefined - assertParamExists('submitSedApproval', 'sedApprovalV2025', sedApprovalV2025) - const localVarPath = `/suggested-entitlement-description-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedApprovalV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2025} sedAssignmentV2025 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment: async (sedAssignmentV2025: SedAssignmentV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedAssignmentV2025' is not null or undefined - assertParamExists('submitSedAssignment', 'sedAssignmentV2025', sedAssignmentV2025) - const localVarPath = `/suggested-entitlement-description-assignments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedAssignmentV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2025} [sedBatchRequestV2025] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest: async (sedBatchRequestV2025?: SedBatchRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedBatchRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2025Api - functional programming interface - * @export - */ -export const SuggestedEntitlementDescriptionV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SuggestedEntitlementDescriptionV2025ApiAxiosParamCreator(configuration) - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatchStats(batchId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchStats(batchId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.getSedBatchStats']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatches(offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatches(offset, limit, count, countOnly, status, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.getSedBatches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSeds(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSeds(limit, offset, count, filters, sorters, countOnly, requestedByAnyone, showPendingStatusOnly, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.listSeds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2025 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSed(id: string, sedPatchV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSed(id, sedPatchV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.patchSed']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2025 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedApproval(sedApprovalV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedApproval(sedApprovalV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.submitSedApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2025} sedAssignmentV2025 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedAssignment(sedAssignmentV2025: SedAssignmentV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedAssignment(sedAssignmentV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.submitSedAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2025} [sedBatchRequestV2025] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedBatchRequest(sedBatchRequestV2025?: SedBatchRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedBatchRequest(sedBatchRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2025Api.submitSedBatchRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2025Api - factory interface - * @export - */ -export const SuggestedEntitlementDescriptionV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SuggestedEntitlementDescriptionV2025ApiFp(configuration) - return { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2025ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds(requestParameters: SuggestedEntitlementDescriptionV2025ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2025ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed(requestParameters: SuggestedEntitlementDescriptionV2025ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSed(requestParameters.id, requestParameters.sedPatchV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.submitSedApproval(requestParameters.sedApprovalV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedAssignment(requestParameters.sedAssignmentV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedBatchRequest(requestParameters.sedBatchRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getSedBatchStats operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest { - /** - * Batch Id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatchStats - */ - readonly batchId: string -} - -/** - * Request parameters for getSedBatches operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatches - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatches - */ - 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatches - */ - readonly count?: boolean - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatches - */ - readonly countOnly?: boolean - - /** - * Batch Status - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2025ApiGetSedBatches - */ - readonly status?: string -} - -/** - * Request parameters for listSeds operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiListSedsRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiListSedsRequest { - /** - * 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 SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - 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: **displayName, sourceName, status** - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly sorters?: string - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly countOnly?: boolean - - /** - * By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly requestedByAnyone?: boolean - - /** - * Will limit records to items that are in \"suggested\" or \"approved\" status - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2025ApiListSeds - */ - readonly showPendingStatusOnly?: boolean -} - -/** - * Request parameters for patchSed operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiPatchSedRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiPatchSedRequest { - /** - * id is sed id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2025ApiPatchSed - */ - readonly id: string - - /** - * Sed Patch Request - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2025ApiPatchSed - */ - readonly sedPatchV2025: Array -} - -/** - * Request parameters for submitSedApproval operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest { - /** - * Sed Approval - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2025ApiSubmitSedApproval - */ - readonly sedApprovalV2025: Array -} - -/** - * Request parameters for submitSedAssignment operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest { - /** - * Sed Assignment Request - * @type {SedAssignmentV2025} - * @memberof SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignment - */ - readonly sedAssignmentV2025: SedAssignmentV2025 -} - -/** - * Request parameters for submitSedBatchRequest operation in SuggestedEntitlementDescriptionV2025Api. - * @export - * @interface SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest - */ -export interface SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest { - /** - * Sed Batch Request - * @type {SedBatchRequestV2025} - * @memberof SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequest - */ - readonly sedBatchRequestV2025?: SedBatchRequestV2025 -} - -/** - * SuggestedEntitlementDescriptionV2025Api - object-oriented interface - * @export - * @class SuggestedEntitlementDescriptionV2025Api - * @extends {BaseAPI} - */ -export class SuggestedEntitlementDescriptionV2025Api extends BaseAPI { - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2025ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2025ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2025ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public listSeds(requestParameters: SuggestedEntitlementDescriptionV2025ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2025ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public patchSed(requestParameters: SuggestedEntitlementDescriptionV2025ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).patchSed(requestParameters.id, requestParameters.sedPatchV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).submitSedApproval(requestParameters.sedApprovalV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).submitSedAssignment(requestParameters.sedAssignmentV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2025Api - */ - public submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2025ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2025ApiFp(this.configuration).submitSedBatchRequest(requestParameters.sedBatchRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaggedObjectsV2025Api - axios parameter creator - * @export - */ -export const TaggedObjectsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2025} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject: async (type: DeleteTaggedObjectTypeV2025, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('deleteTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2025} bulkRemoveTaggedObjectV2025 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject: async (bulkRemoveTaggedObjectV2025: BulkRemoveTaggedObjectV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRemoveTaggedObjectV2025' is not null or undefined - assertParamExists('deleteTagsToManyObject', 'bulkRemoveTaggedObjectV2025', bulkRemoveTaggedObjectV2025) - const localVarPath = `/tagged-objects/bulk-remove`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRemoveTaggedObjectV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2025} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject: async (type: GetTaggedObjectTypeV2025, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('getTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2025} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType: async (type: ListTaggedObjectsByTypeTypeV2025, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('listTaggedObjectsByType', 'type', type) - const localVarPath = `/tagged-objects/{type}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2025} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2025} taggedObjectV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject: async (type: PutTaggedObjectTypeV2025, id: string, taggedObjectV2025: TaggedObjectV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('putTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('putTaggedObject', 'id', id) - // verify required parameter 'taggedObjectV2025' is not null or undefined - assertParamExists('putTaggedObject', 'taggedObjectV2025', taggedObjectV2025) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2025} taggedObjectV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject: async (taggedObjectV2025: TaggedObjectV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taggedObjectV2025' is not null or undefined - assertParamExists('setTagToObject', 'taggedObjectV2025', taggedObjectV2025) - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2025} bulkAddTaggedObjectV2025 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects: async (bulkAddTaggedObjectV2025: BulkAddTaggedObjectV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkAddTaggedObjectV2025' is not null or undefined - assertParamExists('setTagsToManyObjects', 'bulkAddTaggedObjectV2025', bulkAddTaggedObjectV2025) - const localVarPath = `/tagged-objects/bulk-add`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkAddTaggedObjectV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaggedObjectsV2025Api - functional programming interface - * @export - */ -export const TaggedObjectsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaggedObjectsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2025} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTaggedObject(type: DeleteTaggedObjectTypeV2025, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.deleteTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2025} bulkRemoveTaggedObjectV2025 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagsToManyObject(bulkRemoveTaggedObjectV2025: BulkRemoveTaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObject(bulkRemoveTaggedObjectV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.deleteTagsToManyObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2025} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaggedObject(type: GetTaggedObjectTypeV2025, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.getTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjects(limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.listTaggedObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2025} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjectsByType(type: ListTaggedObjectsByTypeTypeV2025, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByType(type, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.listTaggedObjectsByType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2025} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2025} taggedObjectV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTaggedObject(type: PutTaggedObjectTypeV2025, id: string, taggedObjectV2025: TaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObject(type, id, taggedObjectV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.putTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2025} taggedObjectV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagToObject(taggedObjectV2025: TaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObject(taggedObjectV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.setTagToObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2025} bulkAddTaggedObjectV2025 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagsToManyObjects(bulkAddTaggedObjectV2025: BulkAddTaggedObjectV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjects(bulkAddTaggedObjectV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2025Api.setTagsToManyObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaggedObjectsV2025Api - factory interface - * @export - */ -export const TaggedObjectsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaggedObjectsV2025ApiFp(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2025ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject(requestParameters: TaggedObjectsV2025ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject(requestParameters: TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2025ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject(requestParameters: TaggedObjectsV2025ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2025ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects(requestParameters: TaggedObjectsV2025ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType(requestParameters: TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2025ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject(requestParameters: TaggedObjectsV2025ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2025ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject(requestParameters: TaggedObjectsV2025ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagToObject(requestParameters.taggedObjectV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2025ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects(requestParameters: TaggedObjectsV2025ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteTaggedObject operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiDeleteTaggedObjectRequest - */ -export interface TaggedObjectsV2025ApiDeleteTaggedObjectRequest { - /** - * The type of object to delete tags from. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2025ApiDeleteTaggedObject - */ - readonly type: DeleteTaggedObjectTypeV2025 - - /** - * The ID of the object to delete tags from. - * @type {string} - * @memberof TaggedObjectsV2025ApiDeleteTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for deleteTagsToManyObject operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest - */ -export interface TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkRemoveTaggedObjectV2025} - * @memberof TaggedObjectsV2025ApiDeleteTagsToManyObject - */ - readonly bulkRemoveTaggedObjectV2025: BulkRemoveTaggedObjectV2025 -} - -/** - * Request parameters for getTaggedObject operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiGetTaggedObjectRequest - */ -export interface TaggedObjectsV2025ApiGetTaggedObjectRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2025ApiGetTaggedObject - */ - readonly type: GetTaggedObjectTypeV2025 - - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TaggedObjectsV2025ApiGetTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for listTaggedObjects operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiListTaggedObjectsRequest - */ -export interface TaggedObjectsV2025ApiListTaggedObjectsRequest { - /** - * 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 TaggedObjectsV2025ApiListTaggedObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2025ApiListTaggedObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2025ApiListTaggedObjects - */ - 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @type {string} - * @memberof TaggedObjectsV2025ApiListTaggedObjects - */ - readonly filters?: string -} - -/** - * Request parameters for listTaggedObjectsByType operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest - */ -export interface TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2025ApiListTaggedObjectsByType - */ - readonly type: ListTaggedObjectsByTypeTypeV2025 - - /** - * 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 TaggedObjectsV2025ApiListTaggedObjectsByType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2025ApiListTaggedObjectsByType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2025ApiListTaggedObjectsByType - */ - 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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @type {string} - * @memberof TaggedObjectsV2025ApiListTaggedObjectsByType - */ - readonly filters?: string -} - -/** - * Request parameters for putTaggedObject operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiPutTaggedObjectRequest - */ -export interface TaggedObjectsV2025ApiPutTaggedObjectRequest { - /** - * The type of tagged object to update. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2025ApiPutTaggedObject - */ - readonly type: PutTaggedObjectTypeV2025 - - /** - * The ID of the object reference to update. - * @type {string} - * @memberof TaggedObjectsV2025ApiPutTaggedObject - */ - readonly id: string - - /** - * - * @type {TaggedObjectV2025} - * @memberof TaggedObjectsV2025ApiPutTaggedObject - */ - readonly taggedObjectV2025: TaggedObjectV2025 -} - -/** - * Request parameters for setTagToObject operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiSetTagToObjectRequest - */ -export interface TaggedObjectsV2025ApiSetTagToObjectRequest { - /** - * - * @type {TaggedObjectV2025} - * @memberof TaggedObjectsV2025ApiSetTagToObject - */ - readonly taggedObjectV2025: TaggedObjectV2025 -} - -/** - * Request parameters for setTagsToManyObjects operation in TaggedObjectsV2025Api. - * @export - * @interface TaggedObjectsV2025ApiSetTagsToManyObjectsRequest - */ -export interface TaggedObjectsV2025ApiSetTagsToManyObjectsRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkAddTaggedObjectV2025} - * @memberof TaggedObjectsV2025ApiSetTagsToManyObjects - */ - readonly bulkAddTaggedObjectV2025: BulkAddTaggedObjectV2025 -} - -/** - * TaggedObjectsV2025Api - object-oriented interface - * @export - * @class TaggedObjectsV2025Api - * @extends {BaseAPI} - */ -export class TaggedObjectsV2025Api extends BaseAPI { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2025ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public deleteTaggedObject(requestParameters: TaggedObjectsV2025ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public deleteTagsToManyObject(requestParameters: TaggedObjectsV2025ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2025ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public getTaggedObject(requestParameters: TaggedObjectsV2025ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2025ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public listTaggedObjects(requestParameters: TaggedObjectsV2025ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public listTaggedObjectsByType(requestParameters: TaggedObjectsV2025ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2025ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public putTaggedObject(requestParameters: TaggedObjectsV2025ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2025ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public setTagToObject(requestParameters: TaggedObjectsV2025ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).setTagToObject(requestParameters.taggedObjectV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2025ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2025Api - */ - public setTagsToManyObjects(requestParameters: TaggedObjectsV2025ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2025ApiFp(this.configuration).setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteTaggedObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type DeleteTaggedObjectTypeV2025 = typeof DeleteTaggedObjectTypeV2025[keyof typeof DeleteTaggedObjectTypeV2025]; -/** - * @export - */ -export const GetTaggedObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type GetTaggedObjectTypeV2025 = typeof GetTaggedObjectTypeV2025[keyof typeof GetTaggedObjectTypeV2025]; -/** - * @export - */ -export const ListTaggedObjectsByTypeTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type ListTaggedObjectsByTypeTypeV2025 = typeof ListTaggedObjectsByTypeTypeV2025[keyof typeof ListTaggedObjectsByTypeTypeV2025]; -/** - * @export - */ -export const PutTaggedObjectTypeV2025 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type PutTaggedObjectTypeV2025 = typeof PutTaggedObjectTypeV2025[keyof typeof PutTaggedObjectTypeV2025]; - - -/** - * TagsV2025Api - axios parameter creator - * @export - */ -export const TagsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2025} tagV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag: async (tagV2025: TagV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tagV2025' is not null or undefined - assertParamExists('createTag', 'tagV2025', tagV2025) - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tagV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * TagsV2025Api - functional programming interface - * @export - */ -export const TagsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TagsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2025} tagV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTag(tagV2025: TagV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTag(tagV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2025Api.createTag']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2025Api.deleteTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2025Api.getTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTags(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2025Api.listTags']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TagsV2025Api - factory interface - * @export - */ -export const TagsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TagsV2025ApiFp(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2025ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag(requestParameters: TagsV2025ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTag(requestParameters.tagV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2025ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById(requestParameters: TagsV2025ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2025ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById(requestParameters: TagsV2025ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2025ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags(requestParameters: TagsV2025ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTag operation in TagsV2025Api. - * @export - * @interface TagsV2025ApiCreateTagRequest - */ -export interface TagsV2025ApiCreateTagRequest { - /** - * - * @type {TagV2025} - * @memberof TagsV2025ApiCreateTag - */ - readonly tagV2025: TagV2025 -} - -/** - * Request parameters for deleteTagById operation in TagsV2025Api. - * @export - * @interface TagsV2025ApiDeleteTagByIdRequest - */ -export interface TagsV2025ApiDeleteTagByIdRequest { - /** - * The ID of the object reference to delete. - * @type {string} - * @memberof TagsV2025ApiDeleteTagById - */ - readonly id: string -} - -/** - * Request parameters for getTagById operation in TagsV2025Api. - * @export - * @interface TagsV2025ApiGetTagByIdRequest - */ -export interface TagsV2025ApiGetTagByIdRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TagsV2025ApiGetTagById - */ - readonly id: string -} - -/** - * Request parameters for listTags operation in TagsV2025Api. - * @export - * @interface TagsV2025ApiListTagsRequest - */ -export interface TagsV2025ApiListTagsRequest { - /** - * 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 TagsV2025ApiListTags - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TagsV2025ApiListTags - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TagsV2025ApiListTags - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof TagsV2025ApiListTags - */ - 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, name, created, modified** - * @type {string} - * @memberof TagsV2025ApiListTags - */ - readonly sorters?: string -} - -/** - * TagsV2025Api - object-oriented interface - * @export - * @class TagsV2025Api - * @extends {BaseAPI} - */ -export class TagsV2025Api extends BaseAPI { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2025ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2025Api - */ - public createTag(requestParameters: TagsV2025ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2025ApiFp(this.configuration).createTag(requestParameters.tagV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2025ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2025Api - */ - public deleteTagById(requestParameters: TagsV2025ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2025ApiFp(this.configuration).deleteTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2025ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2025Api - */ - public getTagById(requestParameters: TagsV2025ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2025ApiFp(this.configuration).getTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2025ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2025Api - */ - public listTags(requestParameters: TagsV2025ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2025ApiFp(this.configuration).listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaskManagementV2025Api - axios parameter creator - * @export - */ -export const TaskManagementV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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: 'HEAD', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks: async (offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status/pending-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaskStatus', 'id', id) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) endpoint or apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTaskStatus', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('updateTaskStatus', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaskManagementV2025Api - functional programming interface - * @export - */ -export const TaskManagementV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaskManagementV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTaskHeaders(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTaskHeaders(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2025Api.getPendingTaskHeaders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @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 {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPendingTasks(offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingTasks(offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2025Api.getPendingTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2025Api.getTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) endpoint or apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2025Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2025 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTaskStatus(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2025Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaskManagementV2025Api - factory interface - * @export - */ -export const TaskManagementV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaskManagementV2025ApiFp(configuration) - return { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementV2025ApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTaskHeaders(requestParameters: TaskManagementV2025ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementV2025ApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPendingTasks(requestParameters: TaskManagementV2025ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2025ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus(requestParameters: TaskManagementV2025ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) endpoint or apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {TaskManagementV2025ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList(requestParameters: TaskManagementV2025ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2025ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus(requestParameters: TaskManagementV2025ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPendingTaskHeaders operation in TaskManagementV2025Api. - * @export - * @interface TaskManagementV2025ApiGetPendingTaskHeadersRequest - */ -export interface TaskManagementV2025ApiGetPendingTaskHeadersRequest { - /** - * 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 TaskManagementV2025ApiGetPendingTaskHeaders - */ - 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 TaskManagementV2025ApiGetPendingTaskHeaders - */ - 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 TaskManagementV2025ApiGetPendingTaskHeaders - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingTasks operation in TaskManagementV2025Api. - * @export - * @interface TaskManagementV2025ApiGetPendingTasksRequest - */ -export interface TaskManagementV2025ApiGetPendingTasksRequest { - /** - * 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 TaskManagementV2025ApiGetPendingTasks - */ - 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 TaskManagementV2025ApiGetPendingTasks - */ - 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 TaskManagementV2025ApiGetPendingTasks - */ - readonly count?: boolean -} - -/** - * Request parameters for getTaskStatus operation in TaskManagementV2025Api. - * @export - * @interface TaskManagementV2025ApiGetTaskStatusRequest - */ -export interface TaskManagementV2025ApiGetTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2025ApiGetTaskStatus - */ - readonly id: string -} - -/** - * Request parameters for getTaskStatusList operation in TaskManagementV2025Api. - * @export - * @interface TaskManagementV2025ApiGetTaskStatusListRequest - */ -export interface TaskManagementV2025ApiGetTaskStatusListRequest { - /** - * 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 TaskManagementV2025ApiGetTaskStatusList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaskManagementV2025ApiGetTaskStatusList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaskManagementV2025ApiGetTaskStatusList - */ - 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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @type {string} - * @memberof TaskManagementV2025ApiGetTaskStatusList - */ - 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: **created** - * @type {string} - * @memberof TaskManagementV2025ApiGetTaskStatusList - */ - readonly sorters?: string -} - -/** - * Request parameters for updateTaskStatus operation in TaskManagementV2025Api. - * @export - * @interface TaskManagementV2025ApiUpdateTaskStatusRequest - */ -export interface TaskManagementV2025ApiUpdateTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2025ApiUpdateTaskStatus - */ - readonly id: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof TaskManagementV2025ApiUpdateTaskStatus - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * TaskManagementV2025Api - object-oriented interface - * @export - * @class TaskManagementV2025Api - * @extends {BaseAPI} - */ -export class TaskManagementV2025Api extends BaseAPI { - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field and count=true. Example: /v2026/task-status?count=true&filters=completionStatus isnull Responds with headers only for list of task statuses for pending tasks. - * @summary Retrieve pending task list headers - * @param {TaskManagementV2025ApiGetPendingTaskHeadersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementV2025Api - */ - public getPendingTaskHeaders(requestParameters: TaskManagementV2025ApiGetPendingTaskHeadersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2025ApiFp(this.configuration).getPendingTaskHeaders(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is being deprecated. Please use the [task-status-list](https://developer.sailpoint.com/docs/api/v2026/get-task-status-list) endpoint with isnull filtering on the completionStatus field to retrieve pending tasks. Example: /v2026/task-status?filters=completionStatus isnull Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Retrieve pending task status list - * @param {TaskManagementV2025ApiGetPendingTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof TaskManagementV2025Api - */ - public getPendingTasks(requestParameters: TaskManagementV2025ApiGetPendingTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2025ApiFp(this.configuration).getPendingTasks(requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2025ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2025Api - */ - public getTaskStatus(requestParameters: TaskManagementV2025ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2025ApiFp(this.configuration).getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) endpoint or apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {TaskManagementV2025ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2025Api - */ - public getTaskStatusList(requestParameters: TaskManagementV2025ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2025ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2025ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2025Api - */ - public updateTaskStatus(requestParameters: TaskManagementV2025ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2025ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantV2025Api - axios parameter creator - * @export - */ -export const TenantV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantV2025Api - functional programming interface - * @export - */ -export const TenantV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantV2025ApiAxiosParamCreator(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenant(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenant(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantV2025Api.getTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantV2025Api - factory interface - * @export - */ -export const TenantV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantV2025ApiFp(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenant(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * TenantV2025Api - object-oriented interface - * @export - * @class TenantV2025Api - * @extends {BaseAPI} - */ -export class TenantV2025Api extends BaseAPI { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantV2025Api - */ - public getTenant(axiosOptions?: RawAxiosRequestConfig) { - return TenantV2025ApiFp(this.configuration).getTenant(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantContextV2025Api - axios parameter creator - * @export - */ -export const TenantContextV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2025} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext: async (jsonPatchOperationV2025: JsonPatchOperationV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchTenantContext', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantContextV2025Api - functional programming interface - * @export - */ -export const TenantContextV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantContextV2025ApiAxiosParamCreator(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2025Api.getTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2025} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchTenantContext(jsonPatchOperationV2025: JsonPatchOperationV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchTenantContext(jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2025Api.patchTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantContextV2025Api - factory interface - * @export - */ -export const TenantContextV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantContextV2025ApiFp(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTenantContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2025ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext(requestParameters: TenantContextV2025ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchTenantContext(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for patchTenantContext operation in TenantContextV2025Api. - * @export - * @interface TenantContextV2025ApiPatchTenantContextRequest - */ -export interface TenantContextV2025ApiPatchTenantContextRequest { - /** - * - * @type {JsonPatchOperationV2025} - * @memberof TenantContextV2025ApiPatchTenantContext - */ - readonly jsonPatchOperationV2025: JsonPatchOperationV2025 -} - -/** - * TenantContextV2025Api - object-oriented interface - * @export - * @class TenantContextV2025Api - * @extends {BaseAPI} - */ -export class TenantContextV2025Api extends BaseAPI { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2025Api - */ - public getTenantContext(axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2025ApiFp(this.configuration).getTenantContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2025ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2025Api - */ - public patchTenantContext(requestParameters: TenantContextV2025ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2025ApiFp(this.configuration).patchTenantContext(requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TransformsV2025Api - axios parameter creator - * @export - */ -export const TransformsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2025} transformV2025 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform: async (transformV2025: TransformV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'transformV2025' is not null or undefined - assertParamExists('createTransform', 'transformV2025', transformV2025) - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - 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, - }; - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2025} [transformV2025] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform: async (id: string, transformV2025?: TransformV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTransform', 'id', id) - const localVarPath = `/transforms/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TransformsV2025Api - functional programming interface - * @export - */ -export const TransformsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TransformsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2025} transformV2025 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTransform(transformV2025: TransformV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTransform(transformV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2025Api.createTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2025Api.deleteTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2025Api.getTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTransforms(offset, limit, count, name, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2025Api.listTransforms']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2025} [transformV2025] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTransform(id: string, transformV2025?: TransformV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransform(id, transformV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2025Api.updateTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TransformsV2025Api - factory interface - * @export - */ -export const TransformsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TransformsV2025ApiFp(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2025ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform(requestParameters: TransformsV2025ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTransform(requestParameters.transformV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2025ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform(requestParameters: TransformsV2025ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2025ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform(requestParameters: TransformsV2025ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2025ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms(requestParameters: TransformsV2025ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2025ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform(requestParameters: TransformsV2025ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTransform(requestParameters.id, requestParameters.transformV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTransform operation in TransformsV2025Api. - * @export - * @interface TransformsV2025ApiCreateTransformRequest - */ -export interface TransformsV2025ApiCreateTransformRequest { - /** - * The transform to be created. - * @type {TransformV2025} - * @memberof TransformsV2025ApiCreateTransform - */ - readonly transformV2025: TransformV2025 -} - -/** - * Request parameters for deleteTransform operation in TransformsV2025Api. - * @export - * @interface TransformsV2025ApiDeleteTransformRequest - */ -export interface TransformsV2025ApiDeleteTransformRequest { - /** - * ID of the transform to delete - * @type {string} - * @memberof TransformsV2025ApiDeleteTransform - */ - readonly id: string -} - -/** - * Request parameters for getTransform operation in TransformsV2025Api. - * @export - * @interface TransformsV2025ApiGetTransformRequest - */ -export interface TransformsV2025ApiGetTransformRequest { - /** - * ID of the transform to retrieve - * @type {string} - * @memberof TransformsV2025ApiGetTransform - */ - readonly id: string -} - -/** - * Request parameters for listTransforms operation in TransformsV2025Api. - * @export - * @interface TransformsV2025ApiListTransformsRequest - */ -export interface TransformsV2025ApiListTransformsRequest { - /** - * 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 TransformsV2025ApiListTransforms - */ - 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 TransformsV2025ApiListTransforms - */ - 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 TransformsV2025ApiListTransforms - */ - readonly count?: boolean - - /** - * Name of the transform to retrieve from the list. - * @type {string} - * @memberof TransformsV2025ApiListTransforms - */ - readonly name?: 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: **internal**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof TransformsV2025ApiListTransforms - */ - readonly filters?: string -} - -/** - * Request parameters for updateTransform operation in TransformsV2025Api. - * @export - * @interface TransformsV2025ApiUpdateTransformRequest - */ -export interface TransformsV2025ApiUpdateTransformRequest { - /** - * ID of the transform to update - * @type {string} - * @memberof TransformsV2025ApiUpdateTransform - */ - readonly id: string - - /** - * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @type {TransformV2025} - * @memberof TransformsV2025ApiUpdateTransform - */ - readonly transformV2025?: TransformV2025 -} - -/** - * TransformsV2025Api - object-oriented interface - * @export - * @class TransformsV2025Api - * @extends {BaseAPI} - */ -export class TransformsV2025Api extends BaseAPI { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2025ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2025Api - */ - public createTransform(requestParameters: TransformsV2025ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2025ApiFp(this.configuration).createTransform(requestParameters.transformV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2025ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2025Api - */ - public deleteTransform(requestParameters: TransformsV2025ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2025ApiFp(this.configuration).deleteTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2025ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2025Api - */ - public getTransform(requestParameters: TransformsV2025ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2025ApiFp(this.configuration).getTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2025ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2025Api - */ - public listTransforms(requestParameters: TransformsV2025ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2025ApiFp(this.configuration).listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2025ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2025Api - */ - public updateTransform(requestParameters: TransformsV2025ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2025ApiFp(this.configuration).updateTransform(requestParameters.id, requestParameters.transformV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TriggersV2025Api - axios parameter creator - * @export - */ -export const TriggersV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2025} completeInvocationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation: async (id: string, completeInvocationV2025: CompleteInvocationV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeTriggerInvocation', 'id', id) - // verify required parameter 'completeInvocationV2025' is not null or undefined - assertParamExists('completeTriggerInvocation', 'completeInvocationV2025', completeInvocationV2025) - const localVarPath = `/trigger-invocations/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(completeInvocationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2025} subscriptionPostRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription: async (subscriptionPostRequestV2025: SubscriptionPostRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subscriptionPostRequestV2025' is not null or undefined - assertParamExists('createSubscription', 'subscriptionPostRequestV2025', subscriptionPostRequestV2025) - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPostRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSubscription', 'id', id) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-invocations/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription: async (id: string, subscriptionPatchRequestInnerV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSubscription', 'id', id) - // verify required parameter 'subscriptionPatchRequestInnerV2025' is not null or undefined - assertParamExists('patchSubscription', 'subscriptionPatchRequestInnerV2025', subscriptionPatchRequestInnerV2025) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(subscriptionPatchRequestInnerV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2025} testInvocationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation: async (testInvocationV2025: TestInvocationV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'testInvocationV2025' is not null or undefined - assertParamExists('startTestTriggerInvocation', 'testInvocationV2025', testInvocationV2025) - const localVarPath = `/trigger-invocations/test`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testInvocationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2025} validateFilterInputDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter: async (validateFilterInputDtoV2025: ValidateFilterInputDtoV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'validateFilterInputDtoV2025' is not null or undefined - assertParamExists('testSubscriptionFilter', 'validateFilterInputDtoV2025', validateFilterInputDtoV2025) - const localVarPath = `/trigger-subscriptions/validate-filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(validateFilterInputDtoV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2025} subscriptionPutRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription: async (id: string, subscriptionPutRequestV2025: SubscriptionPutRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSubscription', 'id', id) - // verify required parameter 'subscriptionPutRequestV2025' is not null or undefined - assertParamExists('updateSubscription', 'subscriptionPutRequestV2025', subscriptionPutRequestV2025) - const localVarPath = `/trigger-subscriptions/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPutRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TriggersV2025Api - functional programming interface - * @export - */ -export const TriggersV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TriggersV2025ApiAxiosParamCreator(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2025} completeInvocationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeTriggerInvocation(id: string, completeInvocationV2025: CompleteInvocationV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocation(id, completeInvocationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.completeTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2025} subscriptionPostRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSubscription(subscriptionPostRequestV2025: SubscriptionPostRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(subscriptionPostRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.createSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSubscription(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscription(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.deleteSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSubscriptions(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptions(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.listSubscriptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggerInvocationStatus(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatus(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.listTriggerInvocationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggers(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggers(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.listTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSubscription(id: string, subscriptionPatchRequestInnerV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscription(id, subscriptionPatchRequestInnerV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.patchSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2025} testInvocationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTestTriggerInvocation(testInvocationV2025: TestInvocationV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocation(testInvocationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.startTestTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2025} validateFilterInputDtoV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSubscriptionFilter(validateFilterInputDtoV2025: ValidateFilterInputDtoV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilter(validateFilterInputDtoV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.testSubscriptionFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2025} subscriptionPutRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSubscription(id: string, subscriptionPutRequestV2025: SubscriptionPutRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscription(id, subscriptionPutRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2025Api.updateSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TriggersV2025Api - factory interface - * @export - */ -export const TriggersV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TriggersV2025ApiFp(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2025ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation(requestParameters: TriggersV2025ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2025ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription(requestParameters: TriggersV2025ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSubscription(requestParameters.subscriptionPostRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2025ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription(requestParameters: TriggersV2025ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2025ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions(requestParameters: TriggersV2025ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2025ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus(requestParameters: TriggersV2025ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2025ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers(requestParameters: TriggersV2025ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2025ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription(requestParameters: TriggersV2025ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2025ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation(requestParameters: TriggersV2025ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.startTestTriggerInvocation(requestParameters.testInvocationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2025ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter(requestParameters: TriggersV2025ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSubscriptionFilter(requestParameters.validateFilterInputDtoV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2025ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription(requestParameters: TriggersV2025ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeTriggerInvocation operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiCompleteTriggerInvocationRequest - */ -export interface TriggersV2025ApiCompleteTriggerInvocationRequest { - /** - * The ID of the invocation to complete. - * @type {string} - * @memberof TriggersV2025ApiCompleteTriggerInvocation - */ - readonly id: string - - /** - * - * @type {CompleteInvocationV2025} - * @memberof TriggersV2025ApiCompleteTriggerInvocation - */ - readonly completeInvocationV2025: CompleteInvocationV2025 -} - -/** - * Request parameters for createSubscription operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiCreateSubscriptionRequest - */ -export interface TriggersV2025ApiCreateSubscriptionRequest { - /** - * - * @type {SubscriptionPostRequestV2025} - * @memberof TriggersV2025ApiCreateSubscription - */ - readonly subscriptionPostRequestV2025: SubscriptionPostRequestV2025 -} - -/** - * Request parameters for deleteSubscription operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiDeleteSubscriptionRequest - */ -export interface TriggersV2025ApiDeleteSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2025ApiDeleteSubscription - */ - readonly id: string -} - -/** - * Request parameters for listSubscriptions operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiListSubscriptionsRequest - */ -export interface TriggersV2025ApiListSubscriptionsRequest { - /** - * 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 TriggersV2025ApiListSubscriptions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2025ApiListSubscriptions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2025ApiListSubscriptions - */ - 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* **triggerId**: *eq* **type**: *eq, le* - * @type {string} - * @memberof TriggersV2025ApiListSubscriptions - */ - 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: **triggerId, triggerName** - * @type {string} - * @memberof TriggersV2025ApiListSubscriptions - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggerInvocationStatus operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiListTriggerInvocationStatusRequest - */ -export interface TriggersV2025ApiListTriggerInvocationStatusRequest { - /** - * 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 TriggersV2025ApiListTriggerInvocationStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2025ApiListTriggerInvocationStatus - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2025ApiListTriggerInvocationStatus - */ - 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: **triggerId**: *eq* **subscriptionId**: *eq* - * @type {string} - * @memberof TriggersV2025ApiListTriggerInvocationStatus - */ - 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: **triggerId, subscriptionName, created, completed** - * @type {string} - * @memberof TriggersV2025ApiListTriggerInvocationStatus - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggers operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiListTriggersRequest - */ -export interface TriggersV2025ApiListTriggersRequest { - /** - * 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 TriggersV2025ApiListTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2025ApiListTriggers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2025ApiListTriggers - */ - 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, ge, le* - * @type {string} - * @memberof TriggersV2025ApiListTriggers - */ - 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, name** - * @type {string} - * @memberof TriggersV2025ApiListTriggers - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSubscription operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiPatchSubscriptionRequest - */ -export interface TriggersV2025ApiPatchSubscriptionRequest { - /** - * ID of the Subscription to patch - * @type {string} - * @memberof TriggersV2025ApiPatchSubscription - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof TriggersV2025ApiPatchSubscription - */ - readonly subscriptionPatchRequestInnerV2025: Array -} - -/** - * Request parameters for startTestTriggerInvocation operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiStartTestTriggerInvocationRequest - */ -export interface TriggersV2025ApiStartTestTriggerInvocationRequest { - /** - * - * @type {TestInvocationV2025} - * @memberof TriggersV2025ApiStartTestTriggerInvocation - */ - readonly testInvocationV2025: TestInvocationV2025 -} - -/** - * Request parameters for testSubscriptionFilter operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiTestSubscriptionFilterRequest - */ -export interface TriggersV2025ApiTestSubscriptionFilterRequest { - /** - * - * @type {ValidateFilterInputDtoV2025} - * @memberof TriggersV2025ApiTestSubscriptionFilter - */ - readonly validateFilterInputDtoV2025: ValidateFilterInputDtoV2025 -} - -/** - * Request parameters for updateSubscription operation in TriggersV2025Api. - * @export - * @interface TriggersV2025ApiUpdateSubscriptionRequest - */ -export interface TriggersV2025ApiUpdateSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2025ApiUpdateSubscription - */ - readonly id: string - - /** - * - * @type {SubscriptionPutRequestV2025} - * @memberof TriggersV2025ApiUpdateSubscription - */ - readonly subscriptionPutRequestV2025: SubscriptionPutRequestV2025 -} - -/** - * TriggersV2025Api - object-oriented interface - * @export - * @class TriggersV2025Api - * @extends {BaseAPI} - */ -export class TriggersV2025Api extends BaseAPI { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2025ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public completeTriggerInvocation(requestParameters: TriggersV2025ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2025ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public createSubscription(requestParameters: TriggersV2025ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).createSubscription(requestParameters.subscriptionPostRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2025ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public deleteSubscription(requestParameters: TriggersV2025ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2025ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public listSubscriptions(requestParameters: TriggersV2025ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2025ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public listTriggerInvocationStatus(requestParameters: TriggersV2025ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2025ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public listTriggers(requestParameters: TriggersV2025ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2025ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public patchSubscription(requestParameters: TriggersV2025ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2025ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public startTestTriggerInvocation(requestParameters: TriggersV2025ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).startTestTriggerInvocation(requestParameters.testInvocationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2025ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public testSubscriptionFilter(requestParameters: TriggersV2025ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).testSubscriptionFilter(requestParameters.validateFilterInputDtoV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2025ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2025Api - */ - public updateSubscription(requestParameters: TriggersV2025ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2025ApiFp(this.configuration).updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * UIMetadataV2025Api - axios parameter creator - * @export - */ -export const UIMetadataV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2025} tenantUiMetadataItemUpdateRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata: async (tenantUiMetadataItemUpdateRequestV2025: TenantUiMetadataItemUpdateRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantUiMetadataItemUpdateRequestV2025' is not null or undefined - assertParamExists('setTenantUiMetadata', 'tenantUiMetadataItemUpdateRequestV2025', tenantUiMetadataItemUpdateRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantUiMetadataItemUpdateRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * UIMetadataV2025Api - functional programming interface - * @export - */ -export const UIMetadataV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UIMetadataV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantUiMetadata(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantUiMetadata(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2025Api.getTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2025} tenantUiMetadataItemUpdateRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2025: TenantUiMetadataItemUpdateRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2025Api.setTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * UIMetadataV2025Api - factory interface - * @export - */ -export const UIMetadataV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UIMetadataV2025ApiFp(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2025ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata(requestParameters: UIMetadataV2025ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2025ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata(requestParameters: UIMetadataV2025ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTenantUiMetadata operation in UIMetadataV2025Api. - * @export - * @interface UIMetadataV2025ApiGetTenantUiMetadataRequest - */ -export interface UIMetadataV2025ApiGetTenantUiMetadataRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2025ApiGetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setTenantUiMetadata operation in UIMetadataV2025Api. - * @export - * @interface UIMetadataV2025ApiSetTenantUiMetadataRequest - */ -export interface UIMetadataV2025ApiSetTenantUiMetadataRequest { - /** - * - * @type {TenantUiMetadataItemUpdateRequestV2025} - * @memberof UIMetadataV2025ApiSetTenantUiMetadata - */ - readonly tenantUiMetadataItemUpdateRequestV2025: TenantUiMetadataItemUpdateRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2025ApiSetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * UIMetadataV2025Api - object-oriented interface - * @export - * @class UIMetadataV2025Api - * @extends {BaseAPI} - */ -export class UIMetadataV2025Api extends BaseAPI { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2025ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2025Api - */ - public getTenantUiMetadata(requestParameters: UIMetadataV2025ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2025ApiFp(this.configuration).getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2025ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2025Api - */ - public setTenantUiMetadata(requestParameters: UIMetadataV2025ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2025ApiFp(this.configuration).setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkItemsV2025Api - axios parameter creator - * @export - */ -export const WorkItemsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('approveApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/approve/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeWorkItem', 'id', id) - const localVarPath = `/work-items/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2025} workItemForwardV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem: async (id: string, workItemForwardV2025: WorkItemForwardV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('forwardWorkItem', 'id', id) - // verify required parameter 'workItemForwardV2025' is not null or undefined - assertParamExists('forwardWorkItem', 'workItemForwardV2025', workItemForwardV2025) - const localVarPath = `/work-items/{id}/forward` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workItemForwardV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkItem', 'id', id) - const localVarPath = `/work-items/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('rejectApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/reject/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitAccountSelection', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('submitAccountSelection', 'requestBody', requestBody) - const localVarPath = `/work-items/{id}/submit-account-selection` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkItemsV2025Api - functional programming interface - * @export - */ -export const WorkItemsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkItemsV2025ApiAxiosParamCreator(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.approveApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.approveApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.completeWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2025} workItemForwardV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardWorkItem(id: string, workItemForwardV2025: WorkItemForwardV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardWorkItem(id, workItemForwardV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.forwardWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItems(ownerId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.getCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountCompletedWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.getCountCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.getCountWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItem(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.getWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItemsSummary(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummary(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.getWorkItemsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkItems(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItems(limit, offset, count, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.listWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.rejectApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.rejectApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitAccountSelection(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelection(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2025Api.submitAccountSelection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkItemsV2025Api - factory interface - * @export - */ -export const WorkItemsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkItemsV2025ApiFp(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2025ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem(requestParameters: WorkItemsV2025ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2025ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk(requestParameters: WorkItemsV2025ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2025ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem(requestParameters: WorkItemsV2025ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2025ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem(requestParameters: WorkItemsV2025ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2025ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems(requestParameters: WorkItemsV2025ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2025ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems(requestParameters: WorkItemsV2025ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2025ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems(requestParameters: WorkItemsV2025ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2025ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem(requestParameters: WorkItemsV2025ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItem(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2025ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary(requestParameters: WorkItemsV2025ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2025ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems(requestParameters: WorkItemsV2025ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2025ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem(requestParameters: WorkItemsV2025ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2025ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk(requestParameters: WorkItemsV2025ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2025ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection(requestParameters: WorkItemsV2025ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApprovalItem operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiApproveApprovalItemRequest - */ -export interface WorkItemsV2025ApiApproveApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiApproveApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2025ApiApproveApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for approveApprovalItemsInBulk operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiApproveApprovalItemsInBulkRequest - */ -export interface WorkItemsV2025ApiApproveApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiApproveApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for completeWorkItem operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiCompleteWorkItemRequest - */ -export interface WorkItemsV2025ApiCompleteWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiCompleteWorkItem - */ - readonly id: string - - /** - * Body is the request payload to create form definition request - * @type {string} - * @memberof WorkItemsV2025ApiCompleteWorkItem - */ - readonly body?: string | null -} - -/** - * Request parameters for forwardWorkItem operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiForwardWorkItemRequest - */ -export interface WorkItemsV2025ApiForwardWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiForwardWorkItem - */ - readonly id: string - - /** - * - * @type {WorkItemForwardV2025} - * @memberof WorkItemsV2025ApiForwardWorkItem - */ - readonly workItemForwardV2025: WorkItemForwardV2025 -} - -/** - * Request parameters for getCompletedWorkItems operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiGetCompletedWorkItemsRequest - */ -export interface WorkItemsV2025ApiGetCompletedWorkItemsRequest { - /** - * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @type {string} - * @memberof WorkItemsV2025ApiGetCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2025ApiGetCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2025ApiGetCompletedWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2025ApiGetCompletedWorkItems - */ - readonly count?: boolean -} - -/** - * Request parameters for getCountCompletedWorkItems operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiGetCountCompletedWorkItemsRequest - */ -export interface WorkItemsV2025ApiGetCountCompletedWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2025ApiGetCountCompletedWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getCountWorkItems operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiGetCountWorkItemsRequest - */ -export interface WorkItemsV2025ApiGetCountWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2025ApiGetCountWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItem operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiGetWorkItemRequest - */ -export interface WorkItemsV2025ApiGetWorkItemRequest { - /** - * ID of the work item. - * @type {string} - * @memberof WorkItemsV2025ApiGetWorkItem - */ - readonly id: string -} - -/** - * Request parameters for getWorkItemsSummary operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiGetWorkItemsSummaryRequest - */ -export interface WorkItemsV2025ApiGetWorkItemsSummaryRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2025ApiGetWorkItemsSummary - */ - readonly ownerId?: string -} - -/** - * Request parameters for listWorkItems operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiListWorkItemsRequest - */ -export interface WorkItemsV2025ApiListWorkItemsRequest { - /** - * 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 WorkItemsV2025ApiListWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2025ApiListWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2025ApiListWorkItems - */ - readonly count?: boolean - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2025ApiListWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for rejectApprovalItem operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiRejectApprovalItemRequest - */ -export interface WorkItemsV2025ApiRejectApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiRejectApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2025ApiRejectApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for rejectApprovalItemsInBulk operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiRejectApprovalItemsInBulkRequest - */ -export interface WorkItemsV2025ApiRejectApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiRejectApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for submitAccountSelection operation in WorkItemsV2025Api. - * @export - * @interface WorkItemsV2025ApiSubmitAccountSelectionRequest - */ -export interface WorkItemsV2025ApiSubmitAccountSelectionRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2025ApiSubmitAccountSelection - */ - readonly id: string - - /** - * Account Selection Data map, keyed on fieldName - * @type {{ [key: string]: any; }} - * @memberof WorkItemsV2025ApiSubmitAccountSelection - */ - readonly requestBody: { [key: string]: any; } -} - -/** - * WorkItemsV2025Api - object-oriented interface - * @export - * @class WorkItemsV2025Api - * @extends {BaseAPI} - */ -export class WorkItemsV2025Api extends BaseAPI { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2025ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public approveApprovalItem(requestParameters: WorkItemsV2025ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2025ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public approveApprovalItemsInBulk(requestParameters: WorkItemsV2025ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2025ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public completeWorkItem(requestParameters: WorkItemsV2025ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2025ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public forwardWorkItem(requestParameters: WorkItemsV2025ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2025ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public getCompletedWorkItems(requestParameters: WorkItemsV2025ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2025ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public getCountCompletedWorkItems(requestParameters: WorkItemsV2025ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2025ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public getCountWorkItems(requestParameters: WorkItemsV2025ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2025ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public getWorkItem(requestParameters: WorkItemsV2025ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).getWorkItem(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2025ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public getWorkItemsSummary(requestParameters: WorkItemsV2025ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2025ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public listWorkItems(requestParameters: WorkItemsV2025ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2025ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public rejectApprovalItem(requestParameters: WorkItemsV2025ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2025ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public rejectApprovalItemsInBulk(requestParameters: WorkItemsV2025ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2025ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2025Api - */ - public submitAccountSelection(requestParameters: WorkItemsV2025ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2025ApiFp(this.configuration).submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkReassignmentV2025Api - axios parameter creator - * @export - */ -export const WorkReassignmentV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2025} configurationItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration: async (configurationItemRequestV2025: ConfigurationItemRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configurationItemRequestV2025' is not null or undefined - assertParamExists('createReassignmentConfiguration', 'configurationItemRequestV2025', configurationItemRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2025} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2025} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2025, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/evaluate/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (exclusionFilters) { - localVarQueryParameter['exclusionFilters'] = exclusionFilters.join(COLLECTION_FORMATS.csv); - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getReassignmentConfiguration', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2025} configurationItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig: async (identityId: string, configurationItemRequestV2025: ConfigurationItemRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('putReassignmentConfig', 'identityId', identityId) - // verify required parameter 'configurationItemRequestV2025' is not null or undefined - assertParamExists('putReassignmentConfig', 'configurationItemRequestV2025', configurationItemRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2025} tenantConfigurationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration: async (tenantConfigurationRequestV2025: TenantConfigurationRequestV2025, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantConfigurationRequestV2025' is not null or undefined - assertParamExists('putTenantConfiguration', 'tenantConfigurationRequestV2025', tenantConfigurationRequestV2025) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantConfigurationRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkReassignmentV2025Api - functional programming interface - * @export - */ -export const WorkReassignmentV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkReassignmentV2025ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2025} configurationItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createReassignmentConfiguration(configurationItemRequestV2025: ConfigurationItemRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createReassignmentConfiguration(configurationItemRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.createReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2025} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReassignmentConfiguration(identityId, configType, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.deleteReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2025} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEvaluateReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2025, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluateReassignmentConfiguration(identityId, configType, exclusionFilters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.getEvaluateReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfigTypes(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigTypes(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.getReassignmentConfigTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfiguration(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfiguration(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.getReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantConfigConfiguration(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantConfigConfiguration(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.getTenantConfigConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listReassignmentConfigurations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReassignmentConfigurations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.listReassignmentConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2025} configurationItemRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putReassignmentConfig(identityId: string, configurationItemRequestV2025: ConfigurationItemRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putReassignmentConfig(identityId, configurationItemRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.putReassignmentConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2025} tenantConfigurationRequestV2025 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTenantConfiguration(tenantConfigurationRequestV2025: TenantConfigurationRequestV2025, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTenantConfiguration(tenantConfigurationRequestV2025, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2025Api.putTenantConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkReassignmentV2025Api - factory interface - * @export - */ -export const WorkReassignmentV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkReassignmentV2025ApiFp(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createReassignmentConfiguration(requestParameters.configurationItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes(requestParameters: WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2025ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration(requestParameters: WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2025ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations(requestParameters: WorkReassignmentV2025ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2025ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig(requestParameters: WorkReassignmentV2025ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2025ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration(requestParameters: WorkReassignmentV2025ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTenantConfiguration(requestParameters.tenantConfigurationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createReassignmentConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest { - /** - * - * @type {ConfigurationItemRequestV2025} - * @memberof WorkReassignmentV2025ApiCreateReassignmentConfiguration - */ - readonly configurationItemRequestV2025: ConfigurationItemRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiCreateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteReassignmentConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2025ApiDeleteReassignmentConfiguration - */ - readonly identityId: string - - /** - * - * @type {ConfigTypeEnumV2025} - * @memberof WorkReassignmentV2025ApiDeleteReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiDeleteReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEvaluateReassignmentConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2025ApiGetEvaluateReassignmentConfiguration - */ - readonly identityId: string - - /** - * Reassignment work type - * @type {ConfigTypeEnumV2025} - * @memberof WorkReassignmentV2025ApiGetEvaluateReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2025 - - /** - * Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @type {Array} - * @memberof WorkReassignmentV2025ApiGetEvaluateReassignmentConfiguration - */ - readonly exclusionFilters?: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiGetEvaluateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfigTypes operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest - */ -export interface WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiGetReassignmentConfigTypes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiGetReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2025ApiGetReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2025ApiGetReassignmentConfiguration - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiGetReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getTenantConfigConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest - */ -export interface WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiGetTenantConfigConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listReassignmentConfigurations operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiListReassignmentConfigurationsRequest - */ -export interface WorkReassignmentV2025ApiListReassignmentConfigurationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiListReassignmentConfigurations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putReassignmentConfig operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiPutReassignmentConfigRequest - */ -export interface WorkReassignmentV2025ApiPutReassignmentConfigRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2025ApiPutReassignmentConfig - */ - readonly identityId: string - - /** - * - * @type {ConfigurationItemRequestV2025} - * @memberof WorkReassignmentV2025ApiPutReassignmentConfig - */ - readonly configurationItemRequestV2025: ConfigurationItemRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiPutReassignmentConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putTenantConfiguration operation in WorkReassignmentV2025Api. - * @export - * @interface WorkReassignmentV2025ApiPutTenantConfigurationRequest - */ -export interface WorkReassignmentV2025ApiPutTenantConfigurationRequest { - /** - * - * @type {TenantConfigurationRequestV2025} - * @memberof WorkReassignmentV2025ApiPutTenantConfiguration - */ - readonly tenantConfigurationRequestV2025: TenantConfigurationRequestV2025 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2025ApiPutTenantConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * WorkReassignmentV2025Api - object-oriented interface - * @export - * @class WorkReassignmentV2025Api - * @extends {BaseAPI} - */ -export class WorkReassignmentV2025Api extends BaseAPI { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public createReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).createReassignmentConfiguration(requestParameters.configurationItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public getReassignmentConfigTypes(requestParameters: WorkReassignmentV2025ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2025ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public getReassignmentConfiguration(requestParameters: WorkReassignmentV2025ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public getTenantConfigConfiguration(requestParameters: WorkReassignmentV2025ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2025ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public listReassignmentConfigurations(requestParameters: WorkReassignmentV2025ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2025ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public putReassignmentConfig(requestParameters: WorkReassignmentV2025ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2025ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2025Api - */ - public putTenantConfiguration(requestParameters: WorkReassignmentV2025ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2025ApiFp(this.configuration).putTenantConfiguration(requestParameters.tenantConfigurationRequestV2025, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkflowsV2025Api - axios parameter creator - * @export - */ -export const WorkflowsV2025ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2025} [createExternalExecuteWorkflowRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow: async (id: string, createExternalExecuteWorkflowRequestV2025?: CreateExternalExecuteWorkflowRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createExternalExecuteWorkflowRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2025} createWorkflowRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow: async (createWorkflowRequestV2025: CreateWorkflowRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createWorkflowRequestV2025' is not null or undefined - assertParamExists('createWorkflow', 'createWorkflowRequestV2025', createWorkflowRequestV2025) - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createWorkflowRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createWorkflowExternalTrigger', 'id', id) - const localVarPath = `/workflows/{id}/external/oauth-clients` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistory', 'id', id) - const localVarPath = `/workflow-executions/{id}/history` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistoryV2: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistoryV2', 'id', id) - const localVarPath = `/workflow-executions/{id}/history-v2` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutions', 'id', id) - const localVarPath = `/workflows/{id}/executions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/operators`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow: async (id: string, jsonPatchOperationV2025: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkflow', 'id', id) - // verify required parameter 'jsonPatchOperationV2025' is not null or undefined - assertParamExists('patchWorkflow', 'jsonPatchOperationV2025', jsonPatchOperationV2025) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2025} workflowBodyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow: async (id: string, workflowBodyV2025: WorkflowBodyV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putWorkflow', 'id', id) - // verify required parameter 'workflowBodyV2025' is not null or undefined - assertParamExists('putWorkflow', 'workflowBodyV2025', workflowBodyV2025) - const localVarPath = `/workflows/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workflowBodyV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2025} [testExternalExecuteWorkflowRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow: async (id: string, testExternalExecuteWorkflowRequestV2025?: TestExternalExecuteWorkflowRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testExternalExecuteWorkflowRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2025} testWorkflowRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow: async (id: string, testWorkflowRequestV2025: TestWorkflowRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testWorkflow', 'id', id) - // verify required parameter 'testWorkflowRequestV2025' is not null or undefined - assertParamExists('testWorkflow', 'testWorkflowRequestV2025', testWorkflowRequestV2025) - const localVarPath = `/workflows/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testWorkflowRequestV2025, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkflowsV2025Api - functional programming interface - * @export - */ -export const WorkflowsV2025ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkflowsV2025ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.cancelWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2025} [createExternalExecuteWorkflowRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createExternalExecuteWorkflow(id: string, createExternalExecuteWorkflowRequestV2025?: CreateExternalExecuteWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createExternalExecuteWorkflow(id, createExternalExecuteWorkflowRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.createExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2025} createWorkflowRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflow(createWorkflowRequestV2025: CreateWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflow(createWorkflowRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.createWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowExternalTrigger(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.createWorkflowExternalTrigger']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.deleteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.getWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.getWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutionHistory(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistory(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.getWorkflowExecutionHistory']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutionHistoryV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistoryV2(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.getWorkflowExecutionHistoryV2']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutions(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.getWorkflowExecutions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompleteWorkflowLibrary(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibrary(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.listCompleteWorkflowLibrary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryActions(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActions(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.listWorkflowLibraryActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperators(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.listWorkflowLibraryOperators']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryTriggers(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggers(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.listWorkflowLibraryTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflows(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.listWorkflows']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkflow(id: string, jsonPatchOperationV2025: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflow(id, jsonPatchOperationV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.patchWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2025} workflowBodyV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putWorkflow(id: string, workflowBodyV2025: WorkflowBodyV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflow(id, workflowBodyV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.putWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2025} [testExternalExecuteWorkflowRequestV2025] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequestV2025?: TestExternalExecuteWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflow(id, testExternalExecuteWorkflowRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.testExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2025} testWorkflowRequestV2025 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testWorkflow(id: string, testWorkflowRequestV2025: TestWorkflowRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflow(id, testWorkflowRequestV2025, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2025Api.testWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkflowsV2025Api - factory interface - * @export - */ -export const WorkflowsV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkflowsV2025ApiFp(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2025ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution(requestParameters: WorkflowsV2025ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2025ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow(requestParameters: WorkflowsV2025ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflow(requestParameters.createWorkflowRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger(requestParameters: WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2025ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow(requestParameters: WorkflowsV2025ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2025ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow(requestParameters: WorkflowsV2025ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2025ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2025ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2025ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary(requestParameters: WorkflowsV2025ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2025ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions(requestParameters: WorkflowsV2025ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryOperators(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2025ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers(requestParameters: WorkflowsV2025ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflows(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2025ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow(requestParameters: WorkflowsV2025ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2025ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow(requestParameters: WorkflowsV2025ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putWorkflow(requestParameters.id, requestParameters.workflowBodyV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2025ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2025ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow(requestParameters: WorkflowsV2025ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2025, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelWorkflowExecution operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiCancelWorkflowExecutionRequest - */ -export interface WorkflowsV2025ApiCancelWorkflowExecutionRequest { - /** - * The workflow execution ID - * @type {string} - * @memberof WorkflowsV2025ApiCancelWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for createExternalExecuteWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2025ApiCreateExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {CreateExternalExecuteWorkflowRequestV2025} - * @memberof WorkflowsV2025ApiCreateExternalExecuteWorkflow - */ - readonly createExternalExecuteWorkflowRequestV2025?: CreateExternalExecuteWorkflowRequestV2025 -} - -/** - * Request parameters for createWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiCreateWorkflowRequest - */ -export interface WorkflowsV2025ApiCreateWorkflowRequest { - /** - * - * @type {CreateWorkflowRequestV2025} - * @memberof WorkflowsV2025ApiCreateWorkflow - */ - readonly createWorkflowRequestV2025: CreateWorkflowRequestV2025 -} - -/** - * Request parameters for createWorkflowExternalTrigger operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest - */ -export interface WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2025ApiCreateWorkflowExternalTrigger - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiDeleteWorkflowRequest - */ -export interface WorkflowsV2025ApiDeleteWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2025ApiDeleteWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiGetWorkflowRequest - */ -export interface WorkflowsV2025ApiGetWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecution operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiGetWorkflowExecutionRequest - */ -export interface WorkflowsV2025ApiGetWorkflowExecutionRequest { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistory operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest - */ -export interface WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflowExecutionHistory - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistoryV2 operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request - */ -export interface WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflowExecutionHistoryV2 - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutions operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiGetWorkflowExecutionsRequest - */ -export interface WorkflowsV2025ApiGetWorkflowExecutionsRequest { - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflowExecutions - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2025ApiGetWorkflowExecutions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2025ApiGetWorkflowExecutions - */ - readonly offset?: number - - /** - * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @type {string} - * @memberof WorkflowsV2025ApiGetWorkflowExecutions - */ - readonly filters?: string -} - -/** - * Request parameters for listCompleteWorkflowLibrary operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiListCompleteWorkflowLibraryRequest - */ -export interface WorkflowsV2025ApiListCompleteWorkflowLibraryRequest { - /** - * 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 WorkflowsV2025ApiListCompleteWorkflowLibrary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2025ApiListCompleteWorkflowLibrary - */ - readonly offset?: number -} - -/** - * Request parameters for listWorkflowLibraryActions operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiListWorkflowLibraryActionsRequest - */ -export interface WorkflowsV2025ApiListWorkflowLibraryActionsRequest { - /** - * 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 WorkflowsV2025ApiListWorkflowLibraryActions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2025ApiListWorkflowLibraryActions - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsV2025ApiListWorkflowLibraryActions - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflowLibraryTriggers operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiListWorkflowLibraryTriggersRequest - */ -export interface WorkflowsV2025ApiListWorkflowLibraryTriggersRequest { - /** - * 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 WorkflowsV2025ApiListWorkflowLibraryTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2025ApiListWorkflowLibraryTriggers - */ - readonly offset?: number - - /** - * 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* **type**: *eq* - * @type {string} - * @memberof WorkflowsV2025ApiListWorkflowLibraryTriggers - */ - readonly filters?: string -} - -/** - * Request parameters for patchWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiPatchWorkflowRequest - */ -export interface WorkflowsV2025ApiPatchWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2025ApiPatchWorkflow - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof WorkflowsV2025ApiPatchWorkflow - */ - readonly jsonPatchOperationV2025: Array -} - -/** - * Request parameters for putWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiPutWorkflowRequest - */ -export interface WorkflowsV2025ApiPutWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2025ApiPutWorkflow - */ - readonly id: string - - /** - * - * @type {WorkflowBodyV2025} - * @memberof WorkflowsV2025ApiPutWorkflow - */ - readonly workflowBodyV2025: WorkflowBodyV2025 -} - -/** - * Request parameters for testExternalExecuteWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiTestExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2025ApiTestExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2025ApiTestExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {TestExternalExecuteWorkflowRequestV2025} - * @memberof WorkflowsV2025ApiTestExternalExecuteWorkflow - */ - readonly testExternalExecuteWorkflowRequestV2025?: TestExternalExecuteWorkflowRequestV2025 -} - -/** - * Request parameters for testWorkflow operation in WorkflowsV2025Api. - * @export - * @interface WorkflowsV2025ApiTestWorkflowRequest - */ -export interface WorkflowsV2025ApiTestWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2025ApiTestWorkflow - */ - readonly id: string - - /** - * - * @type {TestWorkflowRequestV2025} - * @memberof WorkflowsV2025ApiTestWorkflow - */ - readonly testWorkflowRequestV2025: TestWorkflowRequestV2025 -} - -/** - * WorkflowsV2025Api - object-oriented interface - * @export - * @class WorkflowsV2025Api - * @extends {BaseAPI} - */ -export class WorkflowsV2025Api extends BaseAPI { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2025ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public cancelWorkflowExecution(requestParameters: WorkflowsV2025ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public createExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2025ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public createWorkflow(requestParameters: WorkflowsV2025ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).createWorkflow(requestParameters.createWorkflowRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public createWorkflowExternalTrigger(requestParameters: WorkflowsV2025ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2025ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public deleteWorkflow(requestParameters: WorkflowsV2025ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2025ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public getWorkflow(requestParameters: WorkflowsV2025ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).getWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2025ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public getWorkflowExecution(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public getWorkflowExecutionHistory(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2025ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public getWorkflowExecutions(requestParameters: WorkflowsV2025ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2025ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public listCompleteWorkflowLibrary(requestParameters: WorkflowsV2025ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2025ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public listWorkflowLibraryActions(requestParameters: WorkflowsV2025ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).listWorkflowLibraryOperators(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2025ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public listWorkflowLibraryTriggers(requestParameters: WorkflowsV2025ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public listWorkflows(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).listWorkflows(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2025ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public patchWorkflow(requestParameters: WorkflowsV2025ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2025ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public putWorkflow(requestParameters: WorkflowsV2025ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).putWorkflow(requestParameters.id, requestParameters.workflowBodyV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2025ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public testExternalExecuteWorkflow(requestParameters: WorkflowsV2025ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2025ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2025Api - */ - public testWorkflow(requestParameters: WorkflowsV2025ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2025ApiFp(this.configuration).testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - diff --git a/sdk-output/v2026/api.ts b/sdk-output/v2026/api.ts deleted file mode 100644 index 749b53cf..00000000 --- a/sdk-output/v2026/api.ts +++ /dev/null @@ -1,155722 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud v2026 API - * 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: v2026 - * - * - * 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'; - -/** - * This is used for access configuration for a lifecycle state - * @export - * @interface AccessActionConfigurationV2026 - */ -export interface AccessActionConfigurationV2026 { - /** - * If true, then all accesses are marked for removal. - * @type {boolean} - * @memberof AccessActionConfigurationV2026 - */ - 'removeAllAccessEnabled'?: boolean; -} -/** - * Owner\'s identity. - * @export - * @interface AccessAppsOwnerV2026 - */ -export interface AccessAppsOwnerV2026 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof AccessAppsOwnerV2026 - */ - 'type'?: AccessAppsOwnerV2026TypeV2026; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof AccessAppsOwnerV2026 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof AccessAppsOwnerV2026 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof AccessAppsOwnerV2026 - */ - 'email'?: string; -} - -export const AccessAppsOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessAppsOwnerV2026TypeV2026 = typeof AccessAppsOwnerV2026TypeV2026[keyof typeof AccessAppsOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface AccessAppsV2026 - */ -export interface AccessAppsV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessAppsV2026 - */ - 'id'?: string; - /** - * Name of application - * @type {string} - * @memberof AccessAppsV2026 - */ - 'name'?: string; - /** - * Description of application. - * @type {string} - * @memberof AccessAppsV2026 - */ - 'description'?: string; - /** - * - * @type {AccessAppsOwnerV2026} - * @memberof AccessAppsV2026 - */ - 'owner'?: AccessAppsOwnerV2026; -} -/** - * - * @export - * @interface AccessConstraintV2026 - */ -export interface AccessConstraintV2026 { - /** - * Type of Access - * @type {string} - * @memberof AccessConstraintV2026 - */ - 'type': AccessConstraintV2026TypeV2026; - /** - * Must be set only if operator is SELECTED. - * @type {Array} - * @memberof AccessConstraintV2026 - */ - 'ids'?: Array; - /** - * Used to determine whether the scope of the campaign should be reduced for selected ids or all. - * @type {string} - * @memberof AccessConstraintV2026 - */ - 'operator': AccessConstraintV2026OperatorV2026; -} - -export const AccessConstraintV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessConstraintV2026TypeV2026 = typeof AccessConstraintV2026TypeV2026[keyof typeof AccessConstraintV2026TypeV2026]; -export const AccessConstraintV2026OperatorV2026 = { - All: 'ALL', - Selected: 'SELECTED' -} as const; - -export type AccessConstraintV2026OperatorV2026 = typeof AccessConstraintV2026OperatorV2026[keyof typeof AccessConstraintV2026OperatorV2026]; - -/** - * - * @export - * @interface AccessCriteriaCriteriaListInnerV2026 - */ -export interface AccessCriteriaCriteriaListInnerV2026 { - /** - * Type of the propery to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2026 - */ - 'type'?: AccessCriteriaCriteriaListInnerV2026TypeV2026; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInnerV2026 - */ - 'name'?: string; -} - -export const AccessCriteriaCriteriaListInnerV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaCriteriaListInnerV2026TypeV2026 = typeof AccessCriteriaCriteriaListInnerV2026TypeV2026[keyof typeof AccessCriteriaCriteriaListInnerV2026TypeV2026]; - -/** - * - * @export - * @interface AccessCriteriaV2026 - */ -export interface AccessCriteriaV2026 { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteriaV2026 - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteriaV2026 - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessDurationV2026 - */ -export interface AccessDurationV2026 { - /** - * The numeric value representing the amount of time, which is defined in the **timeUnit**. - * @type {number} - * @memberof AccessDurationV2026 - */ - 'value'?: number; - /** - * The unit of time that corresponds to the **value**. It defines the scale of the time period. - * @type {string} - * @memberof AccessDurationV2026 - */ - 'timeUnit'?: AccessDurationV2026TimeUnitV2026; -} - -export const AccessDurationV2026TimeUnitV2026 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type AccessDurationV2026TimeUnitV2026 = typeof AccessDurationV2026TimeUnitV2026[keyof typeof AccessDurationV2026TimeUnitV2026]; - -/** - * - * @export - * @interface AccessItemAccessProfileResponseAppRefsInnerV2026 - */ -export interface AccessItemAccessProfileResponseAppRefsInnerV2026 { - /** - * the cloud app id associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2026 - */ - 'cloudAppId'?: string; - /** - * the cloud app name associated with the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseAppRefsInnerV2026 - */ - 'cloudAppName'?: string; -} -/** - * - * @export - * @interface AccessItemAccessProfileResponseV2026 - */ -export interface AccessItemAccessProfileResponseV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'id'?: string; - /** - * the access item type. accessProfile in this case - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'sourceName'?: string; - /** - * the number of entitlements the access profile will create - * @type {number} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'entitlementCount': number; - /** - * the description for the access profile - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'sourceId'?: string; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'startDate'?: string | null; - /** - * the date the access profile is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'removeDate'?: string | null; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'standalone': boolean | null; - /** - * indicates whether the access profile is revocable - * @type {boolean} - * @memberof AccessItemAccessProfileResponseV2026 - */ - 'revocable': boolean | null; -} -/** - * - * @export - * @interface AccessItemAccountResponseV2026 - */ -export interface AccessItemAccountResponseV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'id'?: string; - /** - * the access item type. account in this case - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'sourceName'?: string; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'nativeIdentity': string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAccountResponseV2026 - */ - 'sourceId'?: string; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAccountResponseV2026 - */ - 'entitlementCount'?: number; -} -/** - * - * @export - * @interface AccessItemAppResponseV2026 - */ -export interface AccessItemAppResponseV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAppResponseV2026 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAppResponseV2026 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAppResponseV2026 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAppResponseV2026 - */ - 'sourceName'?: string | null; - /** - * the app role id - * @type {string} - * @memberof AccessItemAppResponseV2026 - */ - 'appRoleId': string | null; -} -/** - * Identity who approved the access item request. - * @export - * @interface AccessItemApproverDtoV2026 - */ -export interface AccessItemApproverDtoV2026 { - /** - * DTO type of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2026 - */ - 'type'?: AccessItemApproverDtoV2026TypeV2026; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessItemApproverDtoV2026 - */ - 'name'?: string; -} - -export const AccessItemApproverDtoV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemApproverDtoV2026TypeV2026 = typeof AccessItemApproverDtoV2026TypeV2026[keyof typeof AccessItemApproverDtoV2026TypeV2026]; - -/** - * - * @export - * @interface AccessItemAssociatedAccessItemV2026 - */ -export interface AccessItemAssociatedAccessItemV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof AccessItemAssociatedAccessItemV2026 - */ - 'appRoleId': string | null; -} -/** - * - * @export - * @interface AccessItemAssociatedV2026 - */ -export interface AccessItemAssociatedV2026 { - /** - * the event type - * @type {string} - * @memberof AccessItemAssociatedV2026 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemAssociatedV2026 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof AccessItemAssociatedV2026 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2026} - * @memberof AccessItemAssociatedV2026 - */ - 'accessItem': AccessItemAssociatedAccessItemV2026; - /** - * - * @type {CorrelatedGovernanceEventV2026} - * @memberof AccessItemAssociatedV2026 - */ - 'governanceEvent': CorrelatedGovernanceEventV2026 | null; - /** - * the access item type - * @type {string} - * @memberof AccessItemAssociatedV2026 - */ - 'accessItemType'?: AccessItemAssociatedV2026AccessItemTypeV2026; -} - -export const AccessItemAssociatedV2026AccessItemTypeV2026 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemAssociatedV2026AccessItemTypeV2026 = typeof AccessItemAssociatedV2026AccessItemTypeV2026[keyof typeof AccessItemAssociatedV2026AccessItemTypeV2026]; - -/** - * - * @export - * @interface AccessItemDiffV2026 - */ -export interface AccessItemDiffV2026 { - /** - * the id of the access item - * @type {string} - * @memberof AccessItemDiffV2026 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccessItemDiffV2026 - */ - 'eventType'?: AccessItemDiffV2026EventTypeV2026; - /** - * the display name of the access item - * @type {string} - * @memberof AccessItemDiffV2026 - */ - 'displayName'?: string; - /** - * the source name of the access item - * @type {string} - * @memberof AccessItemDiffV2026 - */ - 'sourceName'?: string; -} - -export const AccessItemDiffV2026EventTypeV2026 = { - Add: 'ADD', - Remove: 'REMOVE' -} as const; - -export type AccessItemDiffV2026EventTypeV2026 = typeof AccessItemDiffV2026EventTypeV2026[keyof typeof AccessItemDiffV2026EventTypeV2026]; - -/** - * - * @export - * @interface AccessItemEntitlementResponseV2026 - */ -export interface AccessItemEntitlementResponseV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'accessType'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'displayName'?: string; - /** - * the name of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'sourceName'?: string; - /** - * the entitlement attribute - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'type': string; - /** - * the description for the entitlment - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'description'?: string | null; - /** - * the id of the source - * @type {string} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'sourceId'?: string; - /** - * indicates whether the entitlement is standalone - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof AccessItemEntitlementResponseV2026 - */ - 'cloudGoverned': boolean | null; -} -/** - * - * @export - * @interface AccessItemRefV2026 - */ -export interface AccessItemRefV2026 { - /** - * ID of the access item to retrieve the recommendation for. - * @type {string} - * @memberof AccessItemRefV2026 - */ - 'id'?: string; - /** - * Access item\'s type. - * @type {string} - * @memberof AccessItemRefV2026 - */ - 'type'?: AccessItemRefV2026TypeV2026; -} - -export const AccessItemRefV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessItemRefV2026TypeV2026 = typeof AccessItemRefV2026TypeV2026[keyof typeof AccessItemRefV2026TypeV2026]; - -/** - * - * @export - * @interface AccessItemRemovedV2026 - */ -export interface AccessItemRemovedV2026 { - /** - * - * @type {AccessItemAssociatedAccessItemV2026} - * @memberof AccessItemRemovedV2026 - */ - 'accessItem': AccessItemAssociatedAccessItemV2026; - /** - * the identity id - * @type {string} - * @memberof AccessItemRemovedV2026 - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessItemRemovedV2026 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessItemRemovedV2026 - */ - 'dateTime'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessItemRemovedV2026 - */ - 'accessItemType'?: AccessItemRemovedV2026AccessItemTypeV2026; - /** - * - * @type {CorrelatedGovernanceEventV2026} - * @memberof AccessItemRemovedV2026 - */ - 'governanceEvent'?: CorrelatedGovernanceEventV2026 | null; -} - -export const AccessItemRemovedV2026AccessItemTypeV2026 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type AccessItemRemovedV2026AccessItemTypeV2026 = typeof AccessItemRemovedV2026AccessItemTypeV2026[keyof typeof AccessItemRemovedV2026AccessItemTypeV2026]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForDtoV2026 - */ -export interface AccessItemRequestedForDtoV2026 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2026 - */ - 'type'?: AccessItemRequestedForDtoV2026TypeV2026; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForDtoV2026 - */ - 'name'?: string; -} - -export const AccessItemRequestedForDtoV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForDtoV2026TypeV2026 = typeof AccessItemRequestedForDtoV2026TypeV2026[keyof typeof AccessItemRequestedForDtoV2026TypeV2026]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedForV2026 - */ -export interface AccessItemRequestedForV2026 { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2026 - */ - 'type'?: AccessItemRequestedForV2026TypeV2026; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedForV2026 - */ - 'name'?: string; -} - -export const AccessItemRequestedForV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForV2026TypeV2026 = typeof AccessItemRequestedForV2026TypeV2026[keyof typeof AccessItemRequestedForV2026TypeV2026]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterDtoV2026 - */ -export interface AccessItemRequesterDtoV2026 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterDtoV2026 - */ - 'type'?: AccessItemRequesterDtoV2026TypeV2026; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterDtoV2026 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterDtoV2026 - */ - 'name'?: string; -} - -export const AccessItemRequesterDtoV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterDtoV2026TypeV2026 = typeof AccessItemRequesterDtoV2026TypeV2026[keyof typeof AccessItemRequesterDtoV2026TypeV2026]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequesterV2026 - */ -export interface AccessItemRequesterV2026 { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequesterV2026 - */ - 'type'?: AccessItemRequesterV2026TypeV2026; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequesterV2026 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequesterV2026 - */ - 'name'?: string; -} - -export const AccessItemRequesterV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterV2026TypeV2026 = typeof AccessItemRequesterV2026TypeV2026[keyof typeof AccessItemRequesterV2026TypeV2026]; - -/** - * Identity who reviewed the access item request. - * @export - * @interface AccessItemReviewedByV2026 - */ -export interface AccessItemReviewedByV2026 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2026 - */ - 'type'?: AccessItemReviewedByV2026TypeV2026; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedByV2026 - */ - 'name'?: string; -} - -export const AccessItemReviewedByV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemReviewedByV2026TypeV2026 = typeof AccessItemReviewedByV2026TypeV2026[keyof typeof AccessItemReviewedByV2026TypeV2026]; - -/** - * - * @export - * @interface AccessItemRoleResponseV2026 - */ -export interface AccessItemRoleResponseV2026 { - /** - * the access item id - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'id'?: string; - /** - * the access item type. role in this case - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'accessType'?: string; - /** - * the role display name - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'sourceName'?: string | null; - /** - * the description for the role - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'description'?: string; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof AccessItemRoleResponseV2026 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof AccessItemRoleResponseV2026 - */ - 'revocable': boolean; -} -/** - * - * @export - * @interface AccessModelMetadataBulkUpdateResponseV2026 - */ -export interface AccessModelMetadataBulkUpdateResponseV2026 { - /** - * ID of the task which is executing the bulk update. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2026 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2026 - */ - 'type'?: string; - /** - * The status of the bulk update request, only list unfinished request\'s status. - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2026 - */ - 'status'?: AccessModelMetadataBulkUpdateResponseV2026StatusV2026; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof AccessModelMetadataBulkUpdateResponseV2026 - */ - 'created'?: string; -} - -export const AccessModelMetadataBulkUpdateResponseV2026StatusV2026 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PreProcessCompleted: 'PRE_PROCESS_COMPLETED', - PostProcess: 'POST_PROCESS', - Completed: 'COMPLETED', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING', - ReProcessing: 'RE_PROCESSING', - PreProcessFailed: 'PRE_PROCESS_FAILED', - Failed: 'FAILED' -} as const; - -export type AccessModelMetadataBulkUpdateResponseV2026StatusV2026 = typeof AccessModelMetadataBulkUpdateResponseV2026StatusV2026[keyof typeof AccessModelMetadataBulkUpdateResponseV2026StatusV2026]; - -/** - * Metadata that describes an access item - * @export - * @interface AccessModelMetadataV2026 - */ -export interface AccessModelMetadataV2026 { - /** - * Unique identifier for the metadata type - * @type {string} - * @memberof AccessModelMetadataV2026 - */ - 'key'?: string; - /** - * Human readable name of the metadata type - * @type {string} - * @memberof AccessModelMetadataV2026 - */ - 'name'?: string; - /** - * Allows selecting multiple values - * @type {boolean} - * @memberof AccessModelMetadataV2026 - */ - 'multiselect'?: boolean; - /** - * The state of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2026 - */ - 'status'?: string; - /** - * The type of the metadata item - * @type {string} - * @memberof AccessModelMetadataV2026 - */ - 'type'?: string; - /** - * The types of objects - * @type {Array} - * @memberof AccessModelMetadataV2026 - */ - 'objectTypes'?: Array; - /** - * Describes the metadata item - * @type {string} - * @memberof AccessModelMetadataV2026 - */ - 'description'?: string; - /** - * The value to assign to the metadata item - * @type {Array} - * @memberof AccessModelMetadataV2026 - */ - 'values'?: Array; -} -/** - * An individual value to assign to the metadata item - * @export - * @interface AccessModelMetadataValuesInnerV2026 - */ -export interface AccessModelMetadataValuesInnerV2026 { - /** - * The value to assign to the metdata item - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2026 - */ - 'value'?: string; - /** - * Display name of the value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2026 - */ - 'name'?: string; - /** - * The status of the individual value - * @type {string} - * @memberof AccessModelMetadataValuesInnerV2026 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AccessProfileApprovalSchemeV2026 - */ -export interface AccessProfileApprovalSchemeV2026 { - /** - * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof AccessProfileApprovalSchemeV2026 - */ - 'approverType'?: AccessProfileApprovalSchemeV2026ApproverTypeV2026; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof AccessProfileApprovalSchemeV2026 - */ - 'approverId'?: string | null; -} - -export const AccessProfileApprovalSchemeV2026ApproverTypeV2026 = { - AppOwner: 'APP_OWNER', - Owner: 'OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type AccessProfileApprovalSchemeV2026ApproverTypeV2026 = typeof AccessProfileApprovalSchemeV2026ApproverTypeV2026[keyof typeof AccessProfileApprovalSchemeV2026ApproverTypeV2026]; - -/** - * - * @export - * @interface AccessProfileBulkDeleteRequestV2026 - */ -export interface AccessProfileBulkDeleteRequestV2026 { - /** - * List of IDs of Access Profiles to be deleted. - * @type {Array} - * @memberof AccessProfileBulkDeleteRequestV2026 - */ - 'accessProfileIds'?: Array; - /** - * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - * @type {boolean} - * @memberof AccessProfileBulkDeleteRequestV2026 - */ - 'bestEffortOnly'?: boolean; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteResponseV2026 - */ -export interface AccessProfileBulkDeleteResponseV2026 { - /** - * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. - * @type {string} - * @memberof AccessProfileBulkDeleteResponseV2026 - */ - 'taskId'?: string; - /** - * List of IDs of Access Profiles which are pending deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2026 - */ - 'pending'?: Array; - /** - * List of usages of Access Profiles targeted for deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponseV2026 - */ - 'inUse'?: Array; -} -/** - * Access Profile\'s basic details. - * @export - * @interface AccessProfileBulkUpdateRequestInnerV2026 - */ -export interface AccessProfileBulkUpdateRequestInnerV2026 { - /** - * Access Profile ID. - * @type {string} - * @memberof AccessProfileBulkUpdateRequestInnerV2026 - */ - 'id'?: string; - /** - * Access Profile is requestable or not. - * @type {boolean} - * @memberof AccessProfileBulkUpdateRequestInnerV2026 - */ - 'requestable'?: boolean; -} -/** - * How to select account when there are multiple accounts for the user - * @export - * @interface AccessProfileDetailsAccountSelectorV2026 - */ -export interface AccessProfileDetailsAccountSelectorV2026 { - /** - * - * @type {Array} - * @memberof AccessProfileDetailsAccountSelectorV2026 - */ - 'selectors'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileDetailsV2026 - */ -export interface AccessProfileDetailsV2026 { - /** - * The ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'description'?: string | null; - /** - * Date the Access Profile was created - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'modified'?: string; - /** - * Whether the Access Profile is enabled. - * @type {boolean} - * @memberof AccessProfileDetailsV2026 - */ - 'disabled'?: boolean; - /** - * Whether the Access Profile is requestable via access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2026 - */ - 'requestable'?: boolean; - /** - * Whether the Access Profile is protected. - * @type {boolean} - * @memberof AccessProfileDetailsV2026 - */ - 'protected'?: boolean; - /** - * The owner ID of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'ownerId'?: string; - /** - * The source ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2026 - */ - 'sourceId'?: number | null; - /** - * The source name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'sourceName'?: string; - /** - * The source app ID of the Access Profile - * @type {number} - * @memberof AccessProfileDetailsV2026 - */ - 'appId'?: number | null; - /** - * The source app name of the Access Profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'appName'?: string | null; - /** - * The id of the application - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'applicationId'?: string; - /** - * The type of the access profile - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'type'?: string; - /** - * List of IDs of entitlements - * @type {Array} - * @memberof AccessProfileDetailsV2026 - */ - 'entitlements'?: Array; - /** - * The number of entitlements in the access profile - * @type {number} - * @memberof AccessProfileDetailsV2026 - */ - 'entitlementCount'?: number; - /** - * List of IDs of segments, if any, to which this Access Profile is assigned. - * @type {Array} - * @memberof AccessProfileDetailsV2026 - */ - 'segments'?: Array; - /** - * Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'approvalSchemes'?: string; - /** - * Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> - * @type {string} - * @memberof AccessProfileDetailsV2026 - */ - 'revokeRequestApprovalSchemes'?: string; - /** - * Whether the access profile require request comment for access request. - * @type {boolean} - * @memberof AccessProfileDetailsV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * Whether denied comment is required when access request is denied. - * @type {boolean} - * @memberof AccessProfileDetailsV2026 - */ - 'deniedCommentsRequired'?: boolean; - /** - * - * @type {AccessProfileDetailsAccountSelectorV2026} - * @memberof AccessProfileDetailsV2026 - */ - 'accountSelector'?: AccessProfileDetailsAccountSelectorV2026; -} -/** - * Access profile\'s source. - * @export - * @interface AccessProfileDocumentAllOfSourceV2026 - */ -export interface AccessProfileDocumentAllOfSourceV2026 { - /** - * Source\'s ID. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2026 - */ - 'id'?: string; - /** - * Source\'s name. - * @type {string} - * @memberof AccessProfileDocumentAllOfSourceV2026 - */ - 'name'?: string; -} -/** - * More complete representation of an access profile. - * @export - * @interface AccessProfileDocumentV2026 - */ -export interface AccessProfileDocumentV2026 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentV2026 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2026} - * @memberof AccessProfileDocumentV2026 - */ - 'owner'?: BaseAccessOwnerV2026; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentV2026 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2026} - * @memberof AccessProfileDocumentV2026 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2026; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentV2026 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentV2026 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentV2026 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentV2026 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentV2026 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentV2026 - */ - 'apps'?: Array; -} -/** - * - * @export - * @interface AccessProfileDocumentsV2026 - */ -export interface AccessProfileDocumentsV2026 { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocumentsV2026 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocumentsV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocumentsV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2026} - * @memberof AccessProfileDocumentsV2026 - */ - 'owner'?: BaseAccessOwnerV2026; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSourceV2026} - * @memberof AccessProfileDocumentsV2026 - */ - 'source'?: AccessProfileDocumentAllOfSourceV2026; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocumentsV2026 - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocumentsV2026 - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocumentsV2026 - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocumentsV2026 - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocumentsV2026 - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocumentsV2026 - */ - 'apps'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof AccessProfileDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof AccessProfileDocumentsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof AccessProfileDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * EntitlementReference - * @export - * @interface AccessProfileEntitlementV2026 - */ -export interface AccessProfileEntitlementV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2026} - * @memberof AccessProfileEntitlementV2026 - */ - 'source'?: Reference1V2026; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2026 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlementV2026 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlementV2026 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface AccessProfileRefV2026 - */ -export interface AccessProfileRefV2026 { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfileRefV2026 - */ - 'id'?: string; - /** - * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof AccessProfileRefV2026 - */ - 'type'?: AccessProfileRefV2026TypeV2026; - /** - * Human-readable display name of the Access Profile. This field is ignored on input. - * @type {string} - * @memberof AccessProfileRefV2026 - */ - 'name'?: string; -} - -export const AccessProfileRefV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE' -} as const; - -export type AccessProfileRefV2026TypeV2026 = typeof AccessProfileRefV2026TypeV2026[keyof typeof AccessProfileRefV2026TypeV2026]; - -/** - * Role - * @export - * @interface AccessProfileRoleV2026 - */ -export interface AccessProfileRoleV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileRoleV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileRoleV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileRoleV2026 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileRoleV2026 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2026} - * @memberof AccessProfileRoleV2026 - */ - 'owner'?: DisplayReferenceV2026; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2026 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccessProfileRoleV2026 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileSourceRefV2026 - */ -export interface AccessProfileSourceRefV2026 { - /** - * ID of the source the access profile is associated with. - * @type {string} - * @memberof AccessProfileSourceRefV2026 - */ - 'id'?: string; - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccessProfileSourceRefV2026 - */ - 'type'?: AccessProfileSourceRefV2026TypeV2026; - /** - * Source name. - * @type {string} - * @memberof AccessProfileSourceRefV2026 - */ - 'name'?: string; -} - -export const AccessProfileSourceRefV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccessProfileSourceRefV2026TypeV2026 = typeof AccessProfileSourceRefV2026TypeV2026[keyof typeof AccessProfileSourceRefV2026TypeV2026]; - -/** - * This is a summary representation of an access profile. - * @export - * @interface AccessProfileSummaryV2026 - */ -export interface AccessProfileSummaryV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileSummaryV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileSummaryV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileSummaryV2026 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileSummaryV2026 - */ - 'type'?: string; - /** - * - * @type {Reference1V2026} - * @memberof AccessProfileSummaryV2026 - */ - 'source'?: Reference1V2026; - /** - * - * @type {DisplayReferenceV2026} - * @memberof AccessProfileSummaryV2026 - */ - 'owner'?: DisplayReferenceV2026; - /** - * - * @type {boolean} - * @memberof AccessProfileSummaryV2026 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileUpdateItemV2026 - */ -export interface AccessProfileUpdateItemV2026 { - /** - * Identifier of Access Profile in bulk update request. - * @type {string} - * @memberof AccessProfileUpdateItemV2026 - */ - 'id': string; - /** - * Access Profile requestable or not. - * @type {boolean} - * @memberof AccessProfileUpdateItemV2026 - */ - 'requestable': boolean; - /** - * The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. - * @type {string} - * @memberof AccessProfileUpdateItemV2026 - */ - 'status': string; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof AccessProfileUpdateItemV2026 - */ - 'description'?: string; -} -/** - * Role using the access profile. - * @export - * @interface AccessProfileUsageUsedByInnerV2026 - */ -export interface AccessProfileUsageUsedByInnerV2026 { - /** - * DTO type of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2026 - */ - 'type'?: AccessProfileUsageUsedByInnerV2026TypeV2026; - /** - * ID of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2026 - */ - 'id'?: string; - /** - * Display name of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInnerV2026 - */ - 'name'?: string; -} - -export const AccessProfileUsageUsedByInnerV2026TypeV2026 = { - Role: 'ROLE' -} as const; - -export type AccessProfileUsageUsedByInnerV2026TypeV2026 = typeof AccessProfileUsageUsedByInnerV2026TypeV2026[keyof typeof AccessProfileUsageUsedByInnerV2026TypeV2026]; - -/** - * - * @export - * @interface AccessProfileUsageV2026 - */ -export interface AccessProfileUsageV2026 { - /** - * ID of the Access Profile that is in use - * @type {string} - * @memberof AccessProfileUsageV2026 - */ - 'accessProfileId'?: string; - /** - * List of references to objects which are using the indicated Access Profile - * @type {Array} - * @memberof AccessProfileUsageV2026 - */ - 'usedBy'?: Array; -} -/** - * Access profile. - * @export - * @interface AccessProfileV2026 - */ -export interface AccessProfileV2026 { - /** - * Access profile ID. - * @type {string} - * @memberof AccessProfileV2026 - */ - 'id'?: string; - /** - * Access profile name. - * @type {string} - * @memberof AccessProfileV2026 - */ - 'name': string; - /** - * Access profile description. - * @type {string} - * @memberof AccessProfileV2026 - */ - 'description'?: string | null; - /** - * Date and time when the access profile was created. - * @type {string} - * @memberof AccessProfileV2026 - */ - 'created'?: string; - /** - * Date and time when the access profile was last modified. - * @type {string} - * @memberof AccessProfileV2026 - */ - 'modified'?: string; - /** - * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. - * @type {boolean} - * @memberof AccessProfileV2026 - */ - 'enabled'?: boolean; - /** - * - * @type {OwnerReferenceV2026} - * @memberof AccessProfileV2026 - */ - 'owner': OwnerReferenceV2026 | null; - /** - * - * @type {AccessProfileSourceRefV2026} - * @memberof AccessProfileV2026 - */ - 'source': AccessProfileSourceRefV2026; - /** - * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. - * @type {Array} - * @memberof AccessProfileV2026 - */ - 'entitlements'?: Array | null; - /** - * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. - * @type {boolean} - * @memberof AccessProfileV2026 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityV2026} - * @memberof AccessProfileV2026 - */ - 'accessRequestConfig'?: RequestabilityV2026 | null; - /** - * - * @type {RevocabilityV2026} - * @memberof AccessProfileV2026 - */ - 'revocationRequestConfig'?: RevocabilityV2026 | null; - /** - * List of segment IDs, if any, that the access profile is assigned to. - * @type {Array} - * @memberof AccessProfileV2026 - */ - 'segments'?: Array | null; - /** - * - * @type {AttributeDTOListV2026} - * @memberof AccessProfileV2026 - */ - 'accessModelMetadata'?: AttributeDTOListV2026; - /** - * - * @type {ProvisioningCriteriaLevel1V2026} - * @memberof AccessProfileV2026 - */ - 'provisioningCriteria'?: ProvisioningCriteriaLevel1V2026 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof AccessProfileV2026 - */ - 'additionalOwners'?: Array | null; -} -/** - * - * @export - * @interface AccessRecommendationMessageV2026 - */ -export interface AccessRecommendationMessageV2026 { - /** - * Information about why the access item was recommended. - * @type {string} - * @memberof AccessRecommendationMessageV2026 - */ - 'interpretation'?: string; -} -/** - * - * @export - * @interface AccessRequestAdminItemStatusV2026 - */ -export interface AccessRequestAdminItemStatusV2026 { - /** - * ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'type'?: AccessRequestAdminItemStatusV2026TypeV2026 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2026; - /** - * List of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'state'?: RequestedItemStatusRequestStateV2026; - /** - * Approval details for each item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'approvalDetails'?: Array; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'requester'?: AccessItemRequesterV2026; - /** - * - * @type {RequestedItemStatusRequestedForV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2026; - /** - * - * @type {RequestedItemStatusRequesterCommentV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2026; - /** - * - * @type {RequestedItemStatusSodViolationContextV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2026; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2026; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2026} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2026; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'cancelable'?: boolean; - /** - * True if re-auth is required. - * @type {boolean} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'reauthorizationRequired'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccessRequestAdminItemStatusV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - -export const AccessRequestAdminItemStatusV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestAdminItemStatusV2026TypeV2026 = typeof AccessRequestAdminItemStatusV2026TypeV2026[keyof typeof AccessRequestAdminItemStatusV2026TypeV2026]; - -/** - * - * @export - * @interface AccessRequestApproversListResponseV2026 - */ -export interface AccessRequestApproversListResponseV2026 { - /** - * Approver id. - * @type {string} - * @memberof AccessRequestApproversListResponseV2026 - */ - 'id'?: string; - /** - * Email of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2026 - */ - 'email'?: string; - /** - * Name of the approver. - * @type {string} - * @memberof AccessRequestApproversListResponseV2026 - */ - 'name'?: string; - /** - * Id of the approval item. - * @type {string} - * @memberof AccessRequestApproversListResponseV2026 - */ - 'approvalId'?: string; - /** - * Type of the object returned. In this case, the value for this field will always Identity. - * @type {string} - * @memberof AccessRequestApproversListResponseV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccessRequestConfigV2026 - */ -export interface AccessRequestConfigV2026 { - /** - * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. - * @type {boolean} - * @memberof AccessRequestConfigV2026 - */ - 'approvalsMustBeExternal'?: boolean; - /** - * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - * @type {boolean} - * @memberof AccessRequestConfigV2026 - */ - 'reauthorizationEnabled'?: boolean; - /** - * - * @type {RequestOnBehalfOfConfigV2026} - * @memberof AccessRequestConfigV2026 - */ - 'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfigV2026; - /** - * - * @type {EntitlementRequestConfigV2026} - * @memberof AccessRequestConfigV2026 - */ - 'entitlementRequestConfig'?: EntitlementRequestConfigV2026; - /** - * If this is true, requesters and requested-for users will be able to see the names of governance group members when a request is awaiting the group\'s approval. Up to the first 10 members of the group will be listed. - * @type {boolean} - * @memberof AccessRequestConfigV2026 - */ - 'govGroupVisibilityEnabled'?: boolean; -} -/** - * - * @export - * @interface AccessRequestContextV2026 - */ -export interface AccessRequestContextV2026 { - /** - * - * @type {Array} - * @memberof AccessRequestContextV2026 - */ - 'contextAttributes'?: Array; -} -/** - * - * @export - * @interface AccessRequestDynamicApprover1V2026 - */ -export interface AccessRequestDynamicApprover1V2026 { - /** - * The unique ID of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2026 - */ - 'id': string; - /** - * The name of the identity to add to the approver list for the access request. - * @type {string} - * @memberof AccessRequestDynamicApprover1V2026 - */ - 'name': string; - /** - * The type of object being referenced. - * @type {object} - * @memberof AccessRequestDynamicApprover1V2026 - */ - 'type': AccessRequestDynamicApprover1V2026TypeV2026; -} - -export const AccessRequestDynamicApprover1V2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AccessRequestDynamicApprover1V2026TypeV2026 = typeof AccessRequestDynamicApprover1V2026TypeV2026[keyof typeof AccessRequestDynamicApprover1V2026TypeV2026]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ -export interface AccessRequestDynamicApproverRequestedItemsInnerV2026 { - /** - * The unique ID of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'id': string; - /** - * Human friendly name of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'name': string; - /** - * Extended description of the access item. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'description'?: string | null; - /** - * The type of access item being requested. - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'type': AccessRequestDynamicApproverRequestedItemsInnerV2026TypeV2026; - /** - * Grant or revoke the access item - * @type {object} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'operation': AccessRequestDynamicApproverRequestedItemsInnerV2026OperationV2026; - /** - * A comment from the requestor on why the access is needed. - * @type {string} - * @memberof AccessRequestDynamicApproverRequestedItemsInnerV2026 - */ - 'comment'?: string | null; -} - -export const AccessRequestDynamicApproverRequestedItemsInnerV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2026TypeV2026 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2026TypeV2026[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2026TypeV2026]; -export const AccessRequestDynamicApproverRequestedItemsInnerV2026OperationV2026 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestDynamicApproverRequestedItemsInnerV2026OperationV2026 = typeof AccessRequestDynamicApproverRequestedItemsInnerV2026OperationV2026[keyof typeof AccessRequestDynamicApproverRequestedItemsInnerV2026OperationV2026]; - -/** - * - * @export - * @interface AccessRequestDynamicApproverV2026 - */ -export interface AccessRequestDynamicApproverV2026 { - /** - * The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. - * @type {string} - * @memberof AccessRequestDynamicApproverV2026 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2026 - */ - 'requestedFor': Array; - /** - * The access items that are being requested. - * @type {Array} - * @memberof AccessRequestDynamicApproverV2026 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2026} - * @memberof AccessRequestDynamicApproverV2026 - */ - 'requestedBy': AccessItemRequesterDtoV2026; -} -/** - * - * @export - * @interface AccessRequestItemResponseV2026 - */ -export interface AccessRequestItemResponseV2026 { - /** - * the access request item operation - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'operation'?: string; - /** - * the access item type - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'accessItemType'?: string; - /** - * the name of access request item - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'name'?: string; - /** - * the final decision for the access request - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'decision'?: AccessRequestItemResponseV2026DecisionV2026; - /** - * the description of access request item - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'description'?: string; - /** - * the source id - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'sourceId'?: string; - /** - * the source Name - * @type {string} - * @memberof AccessRequestItemResponseV2026 - */ - 'sourceName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestItemResponseV2026 - */ - 'approvalInfos'?: Array; -} - -export const AccessRequestItemResponseV2026DecisionV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type AccessRequestItemResponseV2026DecisionV2026 = typeof AccessRequestItemResponseV2026DecisionV2026[keyof typeof AccessRequestItemResponseV2026DecisionV2026]; - -/** - * - * @export - * @interface AccessRequestItemV2026 - */ -export interface AccessRequestItemV2026 { - /** - * The type of the item being requested. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'type': AccessRequestItemV2026TypeV2026; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestItemV2026 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'removeDate'?: string; - /** - * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'assignmentId'?: string | null; - /** - * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItemV2026 - */ - 'nativeIdentity'?: string | null; -} - -export const AccessRequestItemV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestItemV2026TypeV2026 = typeof AccessRequestItemV2026TypeV2026[keyof typeof AccessRequestItemV2026TypeV2026]; - -/** - * Provides additional details about this access request phase. - * @export - * @interface AccessRequestPhasesV2026 - */ -export interface AccessRequestPhasesV2026 { - /** - * The time that this phase started. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'started'?: string; - /** - * The time that this phase finished. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'finished'?: string | null; - /** - * The name of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'name'?: string; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'state'?: AccessRequestPhasesV2026StateV2026; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'result'?: AccessRequestPhasesV2026ResultV2026 | null; - /** - * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - * @type {string} - * @memberof AccessRequestPhasesV2026 - */ - 'phaseReference'?: string | null; -} - -export const AccessRequestPhasesV2026StateV2026 = { - Pending: 'PENDING', - Executing: 'EXECUTING', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - NotExecuted: 'NOT_EXECUTED' -} as const; - -export type AccessRequestPhasesV2026StateV2026 = typeof AccessRequestPhasesV2026StateV2026[keyof typeof AccessRequestPhasesV2026StateV2026]; -export const AccessRequestPhasesV2026ResultV2026 = { - Successful: 'SUCCESSFUL', - Failed: 'FAILED' -} as const; - -export type AccessRequestPhasesV2026ResultV2026 = typeof AccessRequestPhasesV2026ResultV2026[keyof typeof AccessRequestPhasesV2026ResultV2026]; - -/** - * The identity of the approver. - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026 { - /** - * The type of object that is referenced - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026TypeV2026; - /** - * ID of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026 - */ - 'id': string; - /** - * Human-readable display name of identity who approved the access item request. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026 - */ - 'name': string; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026TypeV2026 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026TypeV2026[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026TypeV2026]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 { - /** - * A comment left by the approver. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 - */ - 'approvalComment'?: string | null; - /** - * The final decision of the approver. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 - */ - 'approvalDecision': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026ApprovalDecisionV2026; - /** - * The name of the approver - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 - */ - 'approverName': string; - /** - * - * @type {AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026 - */ - 'approver': AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV2026; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026ApprovalDecisionV2026 = { - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026ApprovalDecisionV2026 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026ApprovalDecisionV2026[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerV2026ApprovalDecisionV2026]; - -/** - * - * @export - * @interface AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ -export interface AccessRequestPostApprovalRequestedItemsStatusInnerV2026 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'type': AccessRequestPostApprovalRequestedItemsStatusInnerV2026TypeV2026; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'operation': AccessRequestPostApprovalRequestedItemsStatusInnerV2026OperationV2026; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'comment'?: string | null; - /** - * Additional customer defined metadata about the access item. - * @type {{ [key: string]: any; }} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'clientMetadata'?: { [key: string]: any; } | null; - /** - * A list of one or more approvers for the access request. - * @type {Array} - * @memberof AccessRequestPostApprovalRequestedItemsStatusInnerV2026 - */ - 'approvalInfo': Array; -} - -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2026TypeV2026 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2026TypeV2026[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2026TypeV2026]; -export const AccessRequestPostApprovalRequestedItemsStatusInnerV2026OperationV2026 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPostApprovalRequestedItemsStatusInnerV2026OperationV2026 = typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2026OperationV2026[keyof typeof AccessRequestPostApprovalRequestedItemsStatusInnerV2026OperationV2026]; - -/** - * - * @export - * @interface AccessRequestPostApprovalV2026 - */ -export interface AccessRequestPostApprovalV2026 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPostApprovalV2026 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPostApprovalV2026 - */ - 'requestedFor': Array; - /** - * Details on the outcome of each access item. - * @type {Array} - * @memberof AccessRequestPostApprovalV2026 - */ - 'requestedItemsStatus': Array; - /** - * - * @type {AccessItemRequesterDtoV2026} - * @memberof AccessRequestPostApprovalV2026 - */ - 'requestedBy': AccessItemRequesterDtoV2026; -} -/** - * - * @export - * @interface AccessRequestPreApproval1V2026 - */ -export interface AccessRequestPreApproval1V2026 { - /** - * Whether or not to approve the access request. - * @type {boolean} - * @memberof AccessRequestPreApproval1V2026 - */ - 'approved': boolean; - /** - * A comment about the decision to approve or deny the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2026 - */ - 'comment': string; - /** - * The name of the entity that approved or denied the request. - * @type {string} - * @memberof AccessRequestPreApproval1V2026 - */ - 'approver': string; -} -/** - * - * @export - * @interface AccessRequestPreApprovalRequestedItemsInnerV2026 - */ -export interface AccessRequestPreApprovalRequestedItemsInnerV2026 { - /** - * The unique ID of the access item being requested. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'id': string; - /** - * The human friendly name of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'name': string; - /** - * Detailed description of the access item. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'description'?: string | null; - /** - * The type of access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'type': AccessRequestPreApprovalRequestedItemsInnerV2026TypeV2026; - /** - * The action to perform on the access item. - * @type {object} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'operation': AccessRequestPreApprovalRequestedItemsInnerV2026OperationV2026; - /** - * A comment from the identity requesting the access. - * @type {string} - * @memberof AccessRequestPreApprovalRequestedItemsInnerV2026 - */ - 'comment'?: string | null; -} - -export const AccessRequestPreApprovalRequestedItemsInnerV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2026TypeV2026 = typeof AccessRequestPreApprovalRequestedItemsInnerV2026TypeV2026[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2026TypeV2026]; -export const AccessRequestPreApprovalRequestedItemsInnerV2026OperationV2026 = { - Add: 'Add', - Remove: 'Remove' -} as const; - -export type AccessRequestPreApprovalRequestedItemsInnerV2026OperationV2026 = typeof AccessRequestPreApprovalRequestedItemsInnerV2026OperationV2026[keyof typeof AccessRequestPreApprovalRequestedItemsInnerV2026OperationV2026]; - -/** - * - * @export - * @interface AccessRequestPreApprovalV2026 - */ -export interface AccessRequestPreApprovalV2026 { - /** - * The unique ID of the access request. - * @type {string} - * @memberof AccessRequestPreApprovalV2026 - */ - 'accessRequestId': string; - /** - * Identities access was requested for. - * @type {Array} - * @memberof AccessRequestPreApprovalV2026 - */ - 'requestedFor': Array; - /** - * Details of the access items being requested. - * @type {Array} - * @memberof AccessRequestPreApprovalV2026 - */ - 'requestedItems': Array; - /** - * - * @type {AccessItemRequesterDtoV2026} - * @memberof AccessRequestPreApprovalV2026 - */ - 'requestedBy': AccessItemRequesterDtoV2026; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemDtoV2026 - */ -export interface AccessRequestRecommendationActionItemDtoV2026 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemDtoV2026 - */ - 'identityId': string; - /** - * - * @type {AccessRequestRecommendationItemV2026} - * @memberof AccessRequestRecommendationActionItemDtoV2026 - */ - 'access': AccessRequestRecommendationItemV2026; -} -/** - * - * @export - * @interface AccessRequestRecommendationActionItemResponseDtoV2026 - */ -export interface AccessRequestRecommendationActionItemResponseDtoV2026 { - /** - * The identity ID taking the action. - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2026 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemV2026} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2026 - */ - 'access'?: AccessRequestRecommendationItemV2026; - /** - * - * @type {string} - * @memberof AccessRequestRecommendationActionItemResponseDtoV2026 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface AccessRequestRecommendationConfigDtoV2026 - */ -export interface AccessRequestRecommendationConfigDtoV2026 { - /** - * The value that internal calculations need to exceed for recommendations to be made. - * @type {number} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'scoreThreshold': number; - /** - * Use to map an attribute name for determining identities\' start date. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'startDateAttribute'?: string; - /** - * Use to only give recommendations based on this attribute. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'restrictionAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are movers. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'moverAttribute'?: string; - /** - * Use to map an attribute name for determining whether identities are joiners. - * @type {string} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'joinerAttribute'?: string; - /** - * Use only the attribute named in restrictionAttribute to make recommendations. - * @type {boolean} - * @memberof AccessRequestRecommendationConfigDtoV2026 - */ - 'useRestrictionAttribute'?: boolean; -} -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailAccessV2026 - */ -export interface AccessRequestRecommendationItemDetailAccessV2026 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2026 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2026} - * @memberof AccessRequestRecommendationItemDetailAccessV2026 - */ - 'type'?: AccessRequestRecommendationItemTypeV2026; - /** - * Name of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2026 - */ - 'name'?: string; - /** - * Description of the access item - * @type {string} - * @memberof AccessRequestRecommendationItemDetailAccessV2026 - */ - 'description'?: string; -} - - -/** - * - * @export - * @interface AccessRequestRecommendationItemDetailV2026 - */ -export interface AccessRequestRecommendationItemDetailV2026 { - /** - * Identity ID for the recommendation - * @type {string} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'identityId'?: string; - /** - * - * @type {AccessRequestRecommendationItemDetailAccessV2026} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'access'?: AccessRequestRecommendationItemDetailAccessV2026; - /** - * Whether or not the identity has already chosen to ignore this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'ignored'?: boolean; - /** - * Whether or not the identity has already chosen to request this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'requested'?: boolean; - /** - * Whether or not the identity reportedly viewed this recommendation. - * @type {boolean} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'viewed'?: boolean; - /** - * - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'messages'?: Array; - /** - * The list of translation messages - * @type {Array} - * @memberof AccessRequestRecommendationItemDetailV2026 - */ - 'translationMessages'?: Array; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const AccessRequestRecommendationItemTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessRequestRecommendationItemTypeV2026 = typeof AccessRequestRecommendationItemTypeV2026[keyof typeof AccessRequestRecommendationItemTypeV2026]; - - -/** - * - * @export - * @interface AccessRequestRecommendationItemV2026 - */ -export interface AccessRequestRecommendationItemV2026 { - /** - * ID of access item being recommended. - * @type {string} - * @memberof AccessRequestRecommendationItemV2026 - */ - 'id'?: string; - /** - * - * @type {AccessRequestRecommendationItemTypeV2026} - * @memberof AccessRequestRecommendationItemV2026 - */ - 'type'?: AccessRequestRecommendationItemTypeV2026; -} - - -/** - * - * @export - * @interface AccessRequestResponse1V2026 - */ -export interface AccessRequestResponse1V2026 { - /** - * the requester Id - * @type {string} - * @memberof AccessRequestResponse1V2026 - */ - 'requesterId'?: string; - /** - * the requesterName - * @type {string} - * @memberof AccessRequestResponse1V2026 - */ - 'requesterName'?: string; - /** - * - * @type {Array} - * @memberof AccessRequestResponse1V2026 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface AccessRequestResponseV2026 - */ -export interface AccessRequestResponseV2026 { - /** - * A list of new access request tracking data mapped to the values requested. - * @type {Array} - * @memberof AccessRequestResponseV2026 - */ - 'newRequests'?: Array; - /** - * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - * @type {Array} - * @memberof AccessRequestResponseV2026 - */ - 'existingRequests'?: Array; -} -/** - * - * @export - * @interface AccessRequestTrackingV2026 - */ -export interface AccessRequestTrackingV2026 { - /** - * The identity id in which the access request is for. - * @type {string} - * @memberof AccessRequestTrackingV2026 - */ - 'requestedFor'?: string; - /** - * The details of the item requested. - * @type {Array} - * @memberof AccessRequestTrackingV2026 - */ - 'requestedItemsDetails'?: Array; - /** - * a hash representation of the access requested, useful for longer term tracking client side. - * @type {number} - * @memberof AccessRequestTrackingV2026 - */ - 'attributesHash'?: number; - /** - * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - * @type {Array} - * @memberof AccessRequestTrackingV2026 - */ - 'accessRequestIds'?: Array; -} -/** - * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. - * @export - * @enum {string} - */ - -export const AccessRequestTypeV2026 = { - GrantAccess: 'GRANT_ACCESS', - RevokeAccess: 'REVOKE_ACCESS', - ModifyAccess: 'MODIFY_ACCESS' -} as const; - -export type AccessRequestTypeV2026 = typeof AccessRequestTypeV2026[keyof typeof AccessRequestTypeV2026]; - - -/** - * - * @export - * @interface AccessRequestV2026 - */ -export interface AccessRequestV2026 { - /** - * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. - * @type {Array} - * @memberof AccessRequestV2026 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof AccessRequestV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * - * @type {Array} - * @memberof AccessRequestV2026 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestV2026 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests - * @type {Array} - * @memberof AccessRequestV2026 - */ - 'requestedForWithRequestedItems'?: Array | null; -} - - -/** - * - * @export - * @interface AccessRequestedV2026 - */ -export interface AccessRequestedV2026 { - /** - * - * @type {AccessRequestResponse1V2026} - * @memberof AccessRequestedV2026 - */ - 'accessRequest': AccessRequestResponse1V2026; - /** - * the identity id - * @type {string} - * @memberof AccessRequestedV2026 - */ - 'identityId'?: string; - /** - * the event type - * @type {string} - * @memberof AccessRequestedV2026 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof AccessRequestedV2026 - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface AccessReviewItemV2026 - */ -export interface AccessReviewItemV2026 { - /** - * - * @type {AccessSummaryV2026} - * @memberof AccessReviewItemV2026 - */ - 'accessSummary'?: AccessSummaryV2026; - /** - * - * @type {CertificationIdentitySummaryV2026} - * @memberof AccessReviewItemV2026 - */ - 'identitySummary'?: CertificationIdentitySummaryV2026; - /** - * The review item\'s id - * @type {string} - * @memberof AccessReviewItemV2026 - */ - 'id'?: string; - /** - * Whether the review item is complete - * @type {boolean} - * @memberof AccessReviewItemV2026 - */ - 'completed'?: boolean; - /** - * Indicates whether the review item is for new access to a source - * @type {boolean} - * @memberof AccessReviewItemV2026 - */ - 'newAccess'?: boolean; - /** - * - * @type {CertificationDecisionV2026} - * @memberof AccessReviewItemV2026 - */ - 'decision'?: CertificationDecisionV2026; - /** - * Comments for this review item - * @type {string} - * @memberof AccessReviewItemV2026 - */ - 'comments'?: string | null; -} - - -/** - * - * @export - * @interface AccessReviewReassignmentV2026 - */ -export interface AccessReviewReassignmentV2026 { - /** - * - * @type {Array} - * @memberof AccessReviewReassignmentV2026 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof AccessReviewReassignmentV2026 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof AccessReviewReassignmentV2026 - */ - 'reason': string; -} -/** - * - * @export - * @interface AccessSummaryAccessV2026 - */ -export interface AccessSummaryAccessV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof AccessSummaryAccessV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The ID of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2026 - */ - 'id'?: string; - /** - * The name of the item being certified - * @type {string} - * @memberof AccessSummaryAccessV2026 - */ - 'name'?: string; -} - - -/** - * An object holding the access that is being reviewed - * @export - * @interface AccessSummaryV2026 - */ -export interface AccessSummaryV2026 { - /** - * - * @type {AccessSummaryAccessV2026} - * @memberof AccessSummaryV2026 - */ - 'access'?: AccessSummaryAccessV2026; - /** - * - * @type {ReviewableEntitlementV2026} - * @memberof AccessSummaryV2026 - */ - 'entitlement'?: ReviewableEntitlementV2026 | null; - /** - * - * @type {ReviewableAccessProfileV2026} - * @memberof AccessSummaryV2026 - */ - 'accessProfile'?: ReviewableAccessProfileV2026; - /** - * - * @type {ReviewableRoleV2026} - * @memberof AccessSummaryV2026 - */ - 'role'?: ReviewableRoleV2026 | null; -} -/** - * Access type of API Client indicating online or offline use - * @export - * @enum {string} - */ - -export const AccessTypeV2026 = { - Online: 'ONLINE', - Offline: 'OFFLINE' -} as const; - -export type AccessTypeV2026 = typeof AccessTypeV2026[keyof typeof AccessTypeV2026]; - - -/** - * - * @export - * @interface AccessV2026 - */ -export interface AccessV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessV2026 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface AccountActionRequestDtoAccountDetailsV2026 - */ -export interface AccountActionRequestDtoAccountDetailsV2026 { - /** - * unique id of this object - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'accountId'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'nativeIdentity'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'uuid'?: string; - /** - * - * @type {string} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'displayName'?: string; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'locked'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'uncorrelated'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'systemAccount'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'authoritative'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'supportsPasswordChange'?: boolean; - /** - * - * @type {object} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'attributes'?: object; - /** - * - * @type {object} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'application'?: object; - /** - * - * @type {object} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'identity'?: object; - /** - * - * @type {object} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'schema'?: object; - /** - * - * @type {Array} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'pendingAccessRequestIds'?: Array; - /** - * - * @type {Array} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'features'?: Array; - /** - * - * @type {object} - * @memberof AccountActionRequestDtoAccountDetailsV2026 - */ - 'meta'?: object; -} - -export const AccountActionRequestDtoAccountDetailsV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING' -} as const; - -export type AccountActionRequestDtoAccountDetailsV2026FeaturesV2026 = typeof AccountActionRequestDtoAccountDetailsV2026FeaturesV2026[keyof typeof AccountActionRequestDtoAccountDetailsV2026FeaturesV2026]; - -/** - * - * @export - * @interface AccountActionRequestDtoCorrelatedIdentityV2026 - */ -export interface AccountActionRequestDtoCorrelatedIdentityV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof AccountActionRequestDtoCorrelatedIdentityV2026 - */ - 'type'?: DtoTypeV2026; - /** - * Identity id - * @type {string} - * @memberof AccountActionRequestDtoCorrelatedIdentityV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof AccountActionRequestDtoCorrelatedIdentityV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountActionRequestDtoRequesterV2026 - */ -export interface AccountActionRequestDtoRequesterV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof AccountActionRequestDtoRequesterV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountActionRequestDtoRequesterV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountActionRequestDtoRequesterV2026 - */ - 'name'?: string; -} - - -/** - * Represents a request to perform an action on an account, such as deletion or modification. - * @export - * @interface AccountActionRequestDtoV2026 - */ -export interface AccountActionRequestDtoV2026 { - /** - * Account requester ID. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'accountRequestId'?: string; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'requestType'?: string; - /** - * Creation date and time of account deletion request date. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'createdAt'?: string; - /** - * Account deletion request completion date and time. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'completedAt'?: string; - /** - * Overall status of deletion request. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'overallStatus'?: string; - /** - * - * @type {AccountActionRequestDtoRequesterV2026} - * @memberof AccountActionRequestDtoV2026 - */ - 'requester'?: AccountActionRequestDtoRequesterV2026; - /** - * Comments added by the requester while creating the account deletion request. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'requesterComments'?: string; - /** - * - * @type {AccountActionRequestDtoAccountDetailsV2026} - * @memberof AccountActionRequestDtoV2026 - */ - 'accountDetails'?: AccountActionRequestDtoAccountDetailsV2026; - /** - * - * @type {AccountActionRequestDtoCorrelatedIdentityV2026} - * @memberof AccountActionRequestDtoV2026 - */ - 'correlatedIdentity'?: AccountActionRequestDtoCorrelatedIdentityV2026; - /** - * - * @type {IdentityReferenceV2026} - * @memberof AccountActionRequestDtoV2026 - */ - 'managerReference'?: IdentityReferenceV2026 | null; - /** - * ID of the approval request associated with the account deletion action. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'approvalRequestId'?: string; - /** - * List of account request phases. - * @type {Array} - * @memberof AccountActionRequestDtoV2026 - */ - 'accountRequestPhases'?: Array; - /** - * List approval details - * @type {Array} - * @memberof AccountActionRequestDtoV2026 - */ - 'approvalDetails'?: Array; - /** - * Detailed error information. - * @type {string} - * @memberof AccountActionRequestDtoV2026 - */ - 'errorDetails'?: string | null; -} -/** - * Object for specifying Actions to be performed on a specified list of sources\' account. - * @export - * @interface AccountActionV2026 - */ -export interface AccountActionV2026 { - /** - * Describes if action will be enable, disable or delete. - * @type {string} - * @memberof AccountActionV2026 - */ - 'action'?: AccountActionV2026ActionV2026; - /** - * A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. - * @type {Set} - * @memberof AccountActionV2026 - */ - 'sourceIds'?: Set | null; - /** - * A list of source IDs to exclude from the action. Cannot be used together with sourceIds. - * @type {Set} - * @memberof AccountActionV2026 - */ - 'excludeSourceIds'?: Set | null; - /** - * If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. - * @type {boolean} - * @memberof AccountActionV2026 - */ - 'allSources'?: boolean; -} - -export const AccountActionV2026ActionV2026 = { - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE' -} as const; - -export type AccountActionV2026ActionV2026 = typeof AccountActionV2026ActionV2026[keyof typeof AccountActionV2026ActionV2026]; - -/** - * The state of an approval status - * @export - * @enum {string} - */ - -export const AccountActivityApprovalStatusV2026 = { - Finished: 'FINISHED', - Rejected: 'REJECTED', - Returned: 'RETURNED', - Expired: 'EXPIRED', - Pending: 'PENDING', - Canceled: 'CANCELED' -} as const; - -export type AccountActivityApprovalStatusV2026 = typeof AccountActivityApprovalStatusV2026[keyof typeof AccountActivityApprovalStatusV2026]; - - -/** - * AccountActivity - * @export - * @interface AccountActivityDocumentV2026 - */ -export interface AccountActivityDocumentV2026 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivityDocumentV2026 - */ - 'requester'?: ActivityIdentityV2026; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivityDocumentV2026 - */ - 'recipient'?: ActivityIdentityV2026; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentV2026 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentV2026 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityDocumentsV2026 - */ -export interface AccountActivityDocumentsV2026 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivityDocumentsV2026 - */ - 'requester'?: ActivityIdentityV2026; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivityDocumentsV2026 - */ - 'recipient'?: ActivityIdentityV2026; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocumentsV2026 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'sources'?: string; - /** - * Name of the pod. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof AccountActivityDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof AccountActivityDocumentsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof AccountActivityDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * Represents an operation in an account activity item - * @export - * @enum {string} - */ - -export const AccountActivityItemOperationV2026 = { - Add: 'ADD', - Create: 'CREATE', - Modify: 'MODIFY', - Delete: 'DELETE', - Disable: 'DISABLE', - Enable: 'ENABLE', - Unlock: 'UNLOCK', - Lock: 'LOCK', - Remove: 'REMOVE', - Set: 'SET' -} as const; - -export type AccountActivityItemOperationV2026 = typeof AccountActivityItemOperationV2026[keyof typeof AccountActivityItemOperationV2026]; - - -/** - * - * @export - * @interface AccountActivityItemV2026 - */ -export interface AccountActivityItemV2026 { - /** - * Item id - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'id'?: string; - /** - * Human-readable display name of item - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'name'?: string; - /** - * Date and time item was requested - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'requested'?: string; - /** - * - * @type {AccountActivityApprovalStatusV2026} - * @memberof AccountActivityItemV2026 - */ - 'approvalStatus'?: AccountActivityApprovalStatusV2026 | null; - /** - * - * @type {ProvisioningStateV2026} - * @memberof AccountActivityItemV2026 - */ - 'provisioningStatus'?: ProvisioningStateV2026; - /** - * - * @type {CommentV2026} - * @memberof AccountActivityItemV2026 - */ - 'requesterComment'?: CommentV2026 | null; - /** - * - * @type {IdentitySummaryV2026} - * @memberof AccountActivityItemV2026 - */ - 'reviewerIdentitySummary'?: IdentitySummaryV2026 | null; - /** - * - * @type {CommentV2026} - * @memberof AccountActivityItemV2026 - */ - 'reviewerComment'?: CommentV2026 | null; - /** - * - * @type {AccountActivityItemOperationV2026} - * @memberof AccountActivityItemV2026 - */ - 'operation'?: AccountActivityItemOperationV2026 | null; - /** - * Attribute to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'attribute'?: string | null; - /** - * Value of attribute - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'value'?: string | null; - /** - * Native identity in the target system to which the account activity applies - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'nativeIdentity'?: string | null; - /** - * Id of Source to which account activity applies - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'sourceId'?: string; - /** - * - * @type {AccountRequestInfoV2026} - * @memberof AccountActivityItemV2026 - */ - 'accountRequestInfo'?: AccountRequestInfoV2026 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof AccountActivityItemV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof AccountActivityItemV2026 - */ - 'removeDate'?: string | null; -} - - -/** - * AccountActivity - * @export - * @interface AccountActivitySearchedItemV2026 - */ -export interface AccountActivitySearchedItemV2026 { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'status'?: string; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivitySearchedItemV2026 - */ - 'requester'?: ActivityIdentityV2026; - /** - * - * @type {ActivityIdentityV2026} - * @memberof AccountActivitySearchedItemV2026 - */ - 'recipient'?: ActivityIdentityV2026; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivitySearchedItemV2026 - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivitySearchedItemV2026 - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityV2026 - */ -export interface AccountActivityV2026 { - /** - * Id of the account activity - * @type {string} - * @memberof AccountActivityV2026 - */ - 'id'?: string; - /** - * The name of the activity - * @type {string} - * @memberof AccountActivityV2026 - */ - 'name'?: string; - /** - * When the activity was first created - * @type {string} - * @memberof AccountActivityV2026 - */ - 'created'?: string; - /** - * When the activity was last modified - * @type {string} - * @memberof AccountActivityV2026 - */ - 'modified'?: string | null; - /** - * When the activity was completed - * @type {string} - * @memberof AccountActivityV2026 - */ - 'completed'?: string | null; - /** - * - * @type {CompletionStatusV2026} - * @memberof AccountActivityV2026 - */ - 'completionStatus'?: CompletionStatusV2026 | null; - /** - * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - * @type {string} - * @memberof AccountActivityV2026 - */ - 'type'?: string | null; - /** - * - * @type {IdentitySummaryV2026} - * @memberof AccountActivityV2026 - */ - 'requesterIdentitySummary'?: IdentitySummaryV2026 | null; - /** - * - * @type {IdentitySummaryV2026} - * @memberof AccountActivityV2026 - */ - 'targetIdentitySummary'?: IdentitySummaryV2026 | null; - /** - * A list of error messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2026 - */ - 'errors'?: Array | null; - /** - * A list of warning messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivityV2026 - */ - 'warnings'?: Array | null; - /** - * Individual actions performed as part of this account activity - * @type {Array} - * @memberof AccountActivityV2026 - */ - 'items'?: Array | null; - /** - * - * @type {ExecutionStatusV2026} - * @memberof AccountActivityV2026 - */ - 'executionStatus'?: ExecutionStatusV2026; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccountActivityV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - - -/** - * The source the accounts are being aggregated from. - * @export - * @interface AccountAggregationCompletedSourceV2026 - */ -export interface AccountAggregationCompletedSourceV2026 { - /** - * The DTO type of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2026 - */ - 'type': AccountAggregationCompletedSourceV2026TypeV2026; - /** - * The ID of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2026 - */ - 'id': string; - /** - * Display name of the source the accounts are being aggregated from. - * @type {string} - * @memberof AccountAggregationCompletedSourceV2026 - */ - 'name': string; -} - -export const AccountAggregationCompletedSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccountAggregationCompletedSourceV2026TypeV2026 = typeof AccountAggregationCompletedSourceV2026TypeV2026[keyof typeof AccountAggregationCompletedSourceV2026TypeV2026]; - -/** - * Overall statistics about the account aggregation. - * @export - * @interface AccountAggregationCompletedStatsV2026 - */ -export interface AccountAggregationCompletedStatsV2026 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2026 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2026 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2026 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountAggregationCompletedStatsV2026 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountAggregationCompletedStatsV2026 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountAggregationCompletedV2026 - */ -export interface AccountAggregationCompletedV2026 { - /** - * - * @type {AccountAggregationCompletedSourceV2026} - * @memberof AccountAggregationCompletedV2026 - */ - 'source': AccountAggregationCompletedSourceV2026; - /** - * The overall status of the aggregation. - * @type {object} - * @memberof AccountAggregationCompletedV2026 - */ - 'status': AccountAggregationCompletedV2026StatusV2026; - /** - * The date and time when the account aggregation started. - * @type {string} - * @memberof AccountAggregationCompletedV2026 - */ - 'started': string; - /** - * The date and time when the account aggregation finished. - * @type {string} - * @memberof AccountAggregationCompletedV2026 - */ - 'completed': string; - /** - * A list of errors that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2026 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the aggregation. - * @type {Array} - * @memberof AccountAggregationCompletedV2026 - */ - 'warnings': Array | null; - /** - * - * @type {AccountAggregationCompletedStatsV2026} - * @memberof AccountAggregationCompletedV2026 - */ - 'stats': AccountAggregationCompletedStatsV2026; -} - -export const AccountAggregationCompletedV2026StatusV2026 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountAggregationCompletedV2026StatusV2026 = typeof AccountAggregationCompletedV2026StatusV2026[keyof typeof AccountAggregationCompletedV2026StatusV2026]; - -/** - * - * @export - * @interface AccountAggregationStatusV2026 - */ -export interface AccountAggregationStatusV2026 { - /** - * When the aggregation started. - * @type {string} - * @memberof AccountAggregationStatusV2026 - */ - 'start'?: string | null; - /** - * STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. - * @type {string} - * @memberof AccountAggregationStatusV2026 - */ - 'status'?: AccountAggregationStatusV2026StatusV2026; - /** - * The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'totalAccounts'?: number; - /** - * The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'processedAccounts'?: number; - /** - * The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'totalAccountsMarkedForDeletion'?: number; - /** - * The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'deletedAccounts'?: number; - /** - * The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'totalIdentities'?: number; - /** - * The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* - * @type {number} - * @memberof AccountAggregationStatusV2026 - */ - 'processedIdentities'?: number; -} - -export const AccountAggregationStatusV2026StatusV2026 = { - Started: 'STARTED', - AccountsCollected: 'ACCOUNTS_COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Retried: 'RETRIED', - Terminated: 'TERMINATED', - NotFound: 'NOT_FOUND' -} as const; - -export type AccountAggregationStatusV2026StatusV2026 = typeof AccountAggregationStatusV2026StatusV2026[keyof typeof AccountAggregationStatusV2026StatusV2026]; - -/** - * The identity this account is correlated to - * @export - * @interface AccountAllOfIdentityV2026 - */ -export interface AccountAllOfIdentityV2026 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfIdentityV2026 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfIdentityV2026 - */ - 'type'?: AccountAllOfIdentityV2026TypeV2026; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfIdentityV2026 - */ - 'name'?: string; -} - -export const AccountAllOfIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfIdentityV2026TypeV2026 = typeof AccountAllOfIdentityV2026TypeV2026[keyof typeof AccountAllOfIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface AccountAllOfOwnerIdentityV2026 - */ -export interface AccountAllOfOwnerIdentityV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof AccountAllOfOwnerIdentityV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentityV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountAllOfRecommendationV2026 - */ -export interface AccountAllOfRecommendationV2026 { - /** - * Recommended type of account. - * @type {string} - * @memberof AccountAllOfRecommendationV2026 - */ - 'type': AccountAllOfRecommendationV2026TypeV2026; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof AccountAllOfRecommendationV2026 - */ - 'method': AccountAllOfRecommendationV2026MethodV2026; -} - -export const AccountAllOfRecommendationV2026TypeV2026 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type AccountAllOfRecommendationV2026TypeV2026 = typeof AccountAllOfRecommendationV2026TypeV2026[keyof typeof AccountAllOfRecommendationV2026TypeV2026]; -export const AccountAllOfRecommendationV2026MethodV2026 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type AccountAllOfRecommendationV2026MethodV2026 = typeof AccountAllOfRecommendationV2026MethodV2026[keyof typeof AccountAllOfRecommendationV2026MethodV2026]; - -/** - * The owner of the source this account belongs to. - * @export - * @interface AccountAllOfSourceOwnerV2026 - */ -export interface AccountAllOfSourceOwnerV2026 { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2026 - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfSourceOwnerV2026 - */ - 'type'?: AccountAllOfSourceOwnerV2026TypeV2026; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfSourceOwnerV2026 - */ - 'name'?: string; -} - -export const AccountAllOfSourceOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfSourceOwnerV2026TypeV2026 = typeof AccountAllOfSourceOwnerV2026TypeV2026[keyof typeof AccountAllOfSourceOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface AccountAttributeV2026 - */ -export interface AccountAttributeV2026 { - /** - * A reference to the source to search for the account - * @type {string} - * @memberof AccountAttributeV2026 - */ - 'sourceName': string; - /** - * The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - * @type {string} - * @memberof AccountAttributeV2026 - */ - 'attributeName': string; - /** - * The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - * @type {string} - * @memberof AccountAttributeV2026 - */ - 'accountSortAttribute'?: string; - /** - * The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - * @type {boolean} - * @memberof AccountAttributeV2026 - */ - 'accountSortDescending'?: boolean; - /** - * The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - * @type {boolean} - * @memberof AccountAttributeV2026 - */ - 'accountReturnFirstLink'?: boolean; - /** - * This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - * @type {string} - * @memberof AccountAttributeV2026 - */ - 'accountFilter'?: string; - /** - * This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. - * @type {string} - * @memberof AccountAttributeV2026 - */ - 'accountPropertyFilter'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof AccountAttributeV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof AccountAttributeV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Details of the account where the attributes changed. - * @export - * @interface AccountAttributesChangedAccountV2026 - */ -export interface AccountAttributesChangedAccountV2026 { - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof AccountAttributesChangedAccountV2026 - */ - 'id': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountAttributesChangedAccountV2026 - */ - 'uuid': string | null; - /** - * Name of the account. - * @type {string} - * @memberof AccountAttributesChangedAccountV2026 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountAttributesChangedAccountV2026 - */ - 'nativeIdentity': string; - /** - * The type of the account - * @type {object} - * @memberof AccountAttributesChangedAccountV2026 - */ - 'type': AccountAttributesChangedAccountV2026TypeV2026; -} - -export const AccountAttributesChangedAccountV2026TypeV2026 = { - Account: 'ACCOUNT' -} as const; - -export type AccountAttributesChangedAccountV2026TypeV2026 = typeof AccountAttributesChangedAccountV2026TypeV2026[keyof typeof AccountAttributesChangedAccountV2026TypeV2026]; - -/** - * @type AccountAttributesChangedChangesInnerNewValueV2026 - * The new value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerNewValueV2026 = Array | boolean | string; - -/** - * @type AccountAttributesChangedChangesInnerOldValueV2026 - * The previous value of the attribute. - * @export - */ -export type AccountAttributesChangedChangesInnerOldValueV2026 = Array | boolean | string; - -/** - * - * @export - * @interface AccountAttributesChangedChangesInnerV2026 - */ -export interface AccountAttributesChangedChangesInnerV2026 { - /** - * The name of the attribute. - * @type {string} - * @memberof AccountAttributesChangedChangesInnerV2026 - */ - 'attribute': string; - /** - * - * @type {AccountAttributesChangedChangesInnerOldValueV2026} - * @memberof AccountAttributesChangedChangesInnerV2026 - */ - 'oldValue': AccountAttributesChangedChangesInnerOldValueV2026 | null; - /** - * - * @type {AccountAttributesChangedChangesInnerNewValueV2026} - * @memberof AccountAttributesChangedChangesInnerV2026 - */ - 'newValue': AccountAttributesChangedChangesInnerNewValueV2026 | null; -} -/** - * The identity whose account attributes were updated. - * @export - * @interface AccountAttributesChangedIdentityV2026 - */ -export interface AccountAttributesChangedIdentityV2026 { - /** - * DTO type of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2026 - */ - 'type': AccountAttributesChangedIdentityV2026TypeV2026; - /** - * ID of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2026 - */ - 'id': string; - /** - * Display name of the identity whose account attributes were updated. - * @type {string} - * @memberof AccountAttributesChangedIdentityV2026 - */ - 'name': string; -} - -export const AccountAttributesChangedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAttributesChangedIdentityV2026TypeV2026 = typeof AccountAttributesChangedIdentityV2026TypeV2026[keyof typeof AccountAttributesChangedIdentityV2026TypeV2026]; - -/** - * The source that contains the account. - * @export - * @interface AccountAttributesChangedSourceV2026 - */ -export interface AccountAttributesChangedSourceV2026 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2026 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountAttributesChangedSourceV2026 - */ - 'type': AccountAttributesChangedSourceV2026TypeV2026; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAttributesChangedSourceV2026 - */ - 'name': string; -} - -export const AccountAttributesChangedSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccountAttributesChangedSourceV2026TypeV2026 = typeof AccountAttributesChangedSourceV2026TypeV2026[keyof typeof AccountAttributesChangedSourceV2026TypeV2026]; - -/** - * - * @export - * @interface AccountAttributesChangedV2026 - */ -export interface AccountAttributesChangedV2026 { - /** - * - * @type {AccountAttributesChangedIdentityV2026} - * @memberof AccountAttributesChangedV2026 - */ - 'identity': AccountAttributesChangedIdentityV2026; - /** - * - * @type {AccountAttributesChangedSourceV2026} - * @memberof AccountAttributesChangedV2026 - */ - 'source': AccountAttributesChangedSourceV2026; - /** - * - * @type {AccountAttributesChangedAccountV2026} - * @memberof AccountAttributesChangedV2026 - */ - 'account': AccountAttributesChangedAccountV2026; - /** - * A list of attributes that changed. - * @type {Array} - * @memberof AccountAttributesChangedV2026 - */ - 'changes': Array; -} -/** - * The schema attribute values for the account - * @export - * @interface AccountAttributesCreateAttributesV2026 - */ -export interface AccountAttributesCreateAttributesV2026 { - [key: string]: string | any; - - /** - * Target source to create an account - * @type {string} - * @memberof AccountAttributesCreateAttributesV2026 - */ - 'sourceId': string; -} -/** - * - * @export - * @interface AccountAttributesCreateV2026 - */ -export interface AccountAttributesCreateV2026 { - /** - * - * @type {AccountAttributesCreateAttributesV2026} - * @memberof AccountAttributesCreateV2026 - */ - 'attributes': AccountAttributesCreateAttributesV2026; -} -/** - * - * @export - * @interface AccountAttributesV2026 - */ -export interface AccountAttributesV2026 { - /** - * The schema attribute values for the account - * @type {{ [key: string]: any; }} - * @memberof AccountAttributesV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * The correlated account. - * @export - * @interface AccountCorrelatedAccountV2026 - */ -export interface AccountCorrelatedAccountV2026 { - /** - * The correlated account\'s DTO type. - * @type {string} - * @memberof AccountCorrelatedAccountV2026 - */ - 'type': AccountCorrelatedAccountV2026TypeV2026; - /** - * The correlated account\'s ID. - * @type {string} - * @memberof AccountCorrelatedAccountV2026 - */ - 'id': string; - /** - * The correlated account\'s display name. - * @type {string} - * @memberof AccountCorrelatedAccountV2026 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountCorrelatedAccountV2026 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountCorrelatedAccountV2026 - */ - 'uuid'?: string | null; -} - -export const AccountCorrelatedAccountV2026TypeV2026 = { - Account: 'ACCOUNT' -} as const; - -export type AccountCorrelatedAccountV2026TypeV2026 = typeof AccountCorrelatedAccountV2026TypeV2026[keyof typeof AccountCorrelatedAccountV2026TypeV2026]; - -/** - * Identity the account is correlated with. - * @export - * @interface AccountCorrelatedIdentityV2026 - */ -export interface AccountCorrelatedIdentityV2026 { - /** - * DTO type of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2026 - */ - 'type': AccountCorrelatedIdentityV2026TypeV2026; - /** - * ID of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2026 - */ - 'id': string; - /** - * Display name of the identity the account is correlated with. - * @type {string} - * @memberof AccountCorrelatedIdentityV2026 - */ - 'name': string; -} - -export const AccountCorrelatedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccountCorrelatedIdentityV2026TypeV2026 = typeof AccountCorrelatedIdentityV2026TypeV2026[keyof typeof AccountCorrelatedIdentityV2026TypeV2026]; - -/** - * The source the accounts are being correlated from. - * @export - * @interface AccountCorrelatedSourceV2026 - */ -export interface AccountCorrelatedSourceV2026 { - /** - * The DTO type of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2026 - */ - 'type': AccountCorrelatedSourceV2026TypeV2026; - /** - * The ID of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2026 - */ - 'id': string; - /** - * Display name of the source the accounts are being correlated from. - * @type {string} - * @memberof AccountCorrelatedSourceV2026 - */ - 'name': string; -} - -export const AccountCorrelatedSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccountCorrelatedSourceV2026TypeV2026 = typeof AccountCorrelatedSourceV2026TypeV2026[keyof typeof AccountCorrelatedSourceV2026TypeV2026]; - -/** - * - * @export - * @interface AccountCorrelatedV2026 - */ -export interface AccountCorrelatedV2026 { - /** - * - * @type {AccountCorrelatedIdentityV2026} - * @memberof AccountCorrelatedV2026 - */ - 'identity': AccountCorrelatedIdentityV2026; - /** - * - * @type {AccountCorrelatedSourceV2026} - * @memberof AccountCorrelatedV2026 - */ - 'source': AccountCorrelatedSourceV2026; - /** - * - * @type {AccountCorrelatedAccountV2026} - * @memberof AccountCorrelatedV2026 - */ - 'account': AccountCorrelatedAccountV2026; - /** - * The attributes associated with the account. Attributes are unique per source. - * @type {{ [key: string]: any; }} - * @memberof AccountCorrelatedV2026 - */ - 'attributes': { [key: string]: any; }; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountCorrelatedV2026 - */ - 'entitlementCount'?: number; -} -/** - * Details about the event. - * @export - * @interface AccountCreatedEventV2026 - */ -export interface AccountCreatedEventV2026 { - /** - * The type of event. - * @type {string} - * @memberof AccountCreatedEventV2026 - */ - 'type': AccountCreatedEventV2026TypeV2026; - /** - * The cause of the event. - * @type {string} - * @memberof AccountCreatedEventV2026 - */ - 'cause': AccountCreatedEventV2026CauseV2026; -} - -export const AccountCreatedEventV2026TypeV2026 = { - AccountCreatedV2: 'ACCOUNT_CREATED_V2' -} as const; - -export type AccountCreatedEventV2026TypeV2026 = typeof AccountCreatedEventV2026TypeV2026[keyof typeof AccountCreatedEventV2026TypeV2026]; -export const AccountCreatedEventV2026CauseV2026 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING' -} as const; - -export type AccountCreatedEventV2026CauseV2026 = typeof AccountCreatedEventV2026CauseV2026[keyof typeof AccountCreatedEventV2026CauseV2026]; - -/** - * - * @export - * @interface AccountCreatedV2026 - */ -export interface AccountCreatedV2026 { - /** - * - * @type {AccountCreatedEventV2026} - * @memberof AccountCreatedV2026 - */ - 'event': AccountCreatedEventV2026; - /** - * - * @type {AccountSourceReferenceV2026} - * @memberof AccountCreatedV2026 - */ - 'source': AccountSourceReferenceV2026; - /** - * - * @type {AccountV2V2026} - * @memberof AccountCreatedV2026 - */ - 'account': AccountV2V2026; - /** - * - * @type {IdentityReference1V2026} - * @memberof AccountCreatedV2026 - */ - 'identity': IdentityReference1V2026; -} -/** - * detailed information about account delete approval config - * @export - * @interface AccountDeleteConfigDtoV2026 - */ -export interface AccountDeleteConfigDtoV2026 { - /** - * Specifies if an account deletion request requires approval. - * @type {boolean} - * @memberof AccountDeleteConfigDtoV2026 - */ - 'approvalRequired'?: boolean; - /** - * - * @type {ApprovalConfigV2026} - * @memberof AccountDeleteConfigDtoV2026 - */ - 'approvalConfig'?: ApprovalConfigV2026; -} -/** - * Contains the required information for processing a user-initiated account deletion request, including the reason for deletion. - * @export - * @interface AccountDeleteRequestInputV2026 - */ -export interface AccountDeleteRequestInputV2026 { - /** - * Reason for deleting the account. - * @type {string} - * @memberof AccountDeleteRequestInputV2026 - */ - 'comments'?: string; -} -/** - * Details about the event. - * @export - * @interface AccountDeletedEventV2026 - */ -export interface AccountDeletedEventV2026 { - /** - * The type of event. - * @type {string} - * @memberof AccountDeletedEventV2026 - */ - 'type': AccountDeletedEventV2026TypeV2026; - /** - * The cause of the event. - * @type {string} - * @memberof AccountDeletedEventV2026 - */ - 'cause': AccountDeletedEventV2026CauseV2026; -} - -export const AccountDeletedEventV2026TypeV2026 = { - AccountDeletedV2: 'ACCOUNT_DELETED_V2' -} as const; - -export type AccountDeletedEventV2026TypeV2026 = typeof AccountDeletedEventV2026TypeV2026[keyof typeof AccountDeletedEventV2026TypeV2026]; -export const AccountDeletedEventV2026CauseV2026 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING' -} as const; - -export type AccountDeletedEventV2026CauseV2026 = typeof AccountDeletedEventV2026CauseV2026[keyof typeof AccountDeletedEventV2026CauseV2026]; - -/** - * - * @export - * @interface AccountDeletedV2026 - */ -export interface AccountDeletedV2026 { - /** - * - * @type {AccountDeletedEventV2026} - * @memberof AccountDeletedV2026 - */ - 'event': AccountDeletedEventV2026; - /** - * - * @type {AccountSourceReferenceV2026} - * @memberof AccountDeletedV2026 - */ - 'source': AccountSourceReferenceV2026; - /** - * - * @type {AccountV2V2026} - * @memberof AccountDeletedV2026 - */ - 'account': AccountV2V2026; - /** - * - * @type {IdentityReference1V2026} - * @memberof AccountDeletedV2026 - */ - 'identity': IdentityReference1V2026; -} -/** - * Account Details - * @export - * @interface AccountDetailsV2026 - */ -export interface AccountDetailsV2026 { - /** - * unique id of this object - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'accountId'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'description'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'nativeIdentity'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'uuid'?: string; - /** - * - * @type {string} - * @memberof AccountDetailsV2026 - */ - 'displayName'?: string; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'locked'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'uncorrelated'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'systemAccount'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'authoritative'?: boolean; - /** - * - * @type {boolean} - * @memberof AccountDetailsV2026 - */ - 'supportsPasswordChange'?: boolean; - /** - * - * @type {object} - * @memberof AccountDetailsV2026 - */ - 'attributes'?: object; - /** - * - * @type {object} - * @memberof AccountDetailsV2026 - */ - 'application'?: object; - /** - * - * @type {object} - * @memberof AccountDetailsV2026 - */ - 'identity'?: object; - /** - * - * @type {object} - * @memberof AccountDetailsV2026 - */ - 'schema'?: object; - /** - * - * @type {Array} - * @memberof AccountDetailsV2026 - */ - 'pendingAccessRequestIds'?: Array; - /** - * - * @type {Array} - * @memberof AccountDetailsV2026 - */ - 'features'?: Array; - /** - * - * @type {object} - * @memberof AccountDetailsV2026 - */ - 'meta'?: object; -} - -export const AccountDetailsV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING' -} as const; - -export type AccountDetailsV2026FeaturesV2026 = typeof AccountDetailsV2026FeaturesV2026[keyof typeof AccountDetailsV2026FeaturesV2026]; - -/** - * - * @export - * @interface AccountInfoDtoV2026 - */ -export interface AccountInfoDtoV2026 { - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountInfoDtoV2026 - */ - 'nativeIdentity'?: string; - /** - * Display name for this account - * @type {string} - * @memberof AccountInfoDtoV2026 - */ - 'displayName'?: string; - /** - * UUID associated with this account - * @type {string} - * @memberof AccountInfoDtoV2026 - */ - 'uuid'?: string; -} -/** - * - * @export - * @interface AccountInfoRefV2026 - */ -export interface AccountInfoRefV2026 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountInfoRefV2026 - */ - 'uuid'?: string; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountInfoRefV2026 - */ - 'nativeIdentity'?: string; - /** - * - * @type {DtoTypeV2026} - * @memberof AccountInfoRefV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The account id - * @type {string} - * @memberof AccountInfoRefV2026 - */ - 'id'?: string; - /** - * The account display name - * @type {string} - * @memberof AccountInfoRefV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountItemRefV2026 - */ -export interface AccountItemRefV2026 { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountItemRefV2026 - */ - 'accountUuid'?: string | null; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountItemRefV2026 - */ - 'nativeIdentity'?: string; -} -/** - * Asynchronous response containing a unique tracking ID for the account request - * @export - * @interface AccountRequestAsyncResultV2026 - */ -export interface AccountRequestAsyncResultV2026 { - /** - * Id of the account request - * @type {string} - * @memberof AccountRequestAsyncResultV2026 - */ - 'accountRequestId': string; -} -/** - * - * @export - * @interface AccountRequestDetailsDtoRequesterV2026 - */ -export interface AccountRequestDetailsDtoRequesterV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof AccountRequestDetailsDtoRequesterV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountRequestDetailsDtoRequesterV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountRequestDetailsDtoRequesterV2026 - */ - 'name'?: string; -} - - -/** - * Represents a request to create a machine account. - * @export - * @interface AccountRequestDetailsDtoV2026 - */ -export interface AccountRequestDetailsDtoV2026 { - /** - * Account request ID. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'accountRequestId'?: string; - /** - * Type of the account request. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'requestType'?: string; - /** - * Machine account creation request creation date and time. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'createdAt'?: string; - /** - * Machine account creation request completion date and time. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'completedAt'?: string | null; - /** - * Overall status of the creation request. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'overallStatus'?: string; - /** - * - * @type {AccountRequestDetailsDtoRequesterV2026} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'requester'?: AccountRequestDetailsDtoRequesterV2026; - /** - * List of account request phases. - * @type {Array} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'accountRequestPhases'?: Array; - /** - * Detailed error information. - * @type {string} - * @memberof AccountRequestDetailsDtoV2026 - */ - 'errorDetails'?: string | null; -} -/** - * If an account activity item is associated with an access request, captures details of that request. - * @export - * @interface AccountRequestInfoV2026 - */ -export interface AccountRequestInfoV2026 { - /** - * Id of requested object - * @type {string} - * @memberof AccountRequestInfoV2026 - */ - 'requestedObjectId'?: string; - /** - * Human-readable name of requested object - * @type {string} - * @memberof AccountRequestInfoV2026 - */ - 'requestedObjectName'?: string; - /** - * - * @type {RequestableObjectTypeV2026} - * @memberof AccountRequestInfoV2026 - */ - 'requestedObjectType'?: RequestableObjectTypeV2026; -} - - -/** - * The current phase state of the account request, indicating its progress or outcome in the approval workflow. - * @export - * @enum {string} - */ - -export const AccountRequestPhaseStateV2026 = { - Pending: 'PENDING', - Cancelled: 'CANCELLED', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Passed: 'PASSED', - Failed: 'FAILED', - NotStarted: 'NOT_STARTED' -} as const; - -export type AccountRequestPhaseStateV2026 = typeof AccountRequestPhaseStateV2026[keyof typeof AccountRequestPhaseStateV2026]; - - -/** - * Contains detailed information about each phase in the account request process, including its type, current state, and relevant timestamps. - * @export - * @interface AccountRequestPhaseV2026 - */ -export interface AccountRequestPhaseV2026 { - /** - * Enum of account request phase type - * @type {string} - * @memberof AccountRequestPhaseV2026 - */ - 'name'?: AccountRequestPhaseV2026NameV2026; - /** - * - * @type {AccountRequestPhaseStateV2026} - * @memberof AccountRequestPhaseV2026 - */ - 'state'?: AccountRequestPhaseStateV2026; - /** - * Start date of account request phase. - * @type {string} - * @memberof AccountRequestPhaseV2026 - */ - 'started'?: string; - /** - * Finish date of account request phase. - * @type {string} - * @memberof AccountRequestPhaseV2026 - */ - 'finished'?: string; -} - -export const AccountRequestPhaseV2026NameV2026 = { - ApprovalPhase: 'APPROVAL_PHASE', - ProvisioningPhase: 'PROVISIONING_PHASE' -} as const; - -export type AccountRequestPhaseV2026NameV2026 = typeof AccountRequestPhaseV2026NameV2026[keyof typeof AccountRequestPhaseV2026NameV2026]; - -/** - * - * @export - * @interface AccountRequestResultV2026 - */ -export interface AccountRequestResultV2026 { - /** - * Error message. - * @type {Array} - * @memberof AccountRequestResultV2026 - */ - 'errors'?: Array; - /** - * The status of the account request - * @type {string} - * @memberof AccountRequestResultV2026 - */ - 'status'?: string; - /** - * ID of associated ticket. - * @type {string} - * @memberof AccountRequestResultV2026 - */ - 'ticketId'?: string | null; -} -/** - * - * @export - * @interface AccountRequestV2026 - */ -export interface AccountRequestV2026 { - /** - * Unique ID of the account - * @type {string} - * @memberof AccountRequestV2026 - */ - 'accountId'?: string; - /** - * - * @type {Array} - * @memberof AccountRequestV2026 - */ - 'attributeRequests'?: Array; - /** - * The operation that was performed - * @type {string} - * @memberof AccountRequestV2026 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2026} - * @memberof AccountRequestV2026 - */ - 'provisioningTarget'?: AccountSourceV2026; - /** - * - * @type {AccountRequestResultV2026} - * @memberof AccountRequestV2026 - */ - 'result'?: AccountRequestResultV2026; - /** - * - * @type {AccountSourceV2026} - * @memberof AccountRequestV2026 - */ - 'source'?: AccountSourceV2026; -} -/** - * Details about the governance group of the source. - * @export - * @interface AccountSourceReferenceGovernanceGroupV2026 - */ -export interface AccountSourceReferenceGovernanceGroupV2026 { - /** - * ID of the governance group. - * @type {string} - * @memberof AccountSourceReferenceGovernanceGroupV2026 - */ - 'id': string; - /** - * Name of the governance group. - * @type {string} - * @memberof AccountSourceReferenceGovernanceGroupV2026 - */ - 'name': string; -} -/** - * Details about the owner of the source. - * @export - * @interface AccountSourceReferenceOwnerV2026 - */ -export interface AccountSourceReferenceOwnerV2026 { - /** - * ID of the source owner. - * @type {string} - * @memberof AccountSourceReferenceOwnerV2026 - */ - 'id': string; - /** - * Name of the source owner. - * @type {string} - * @memberof AccountSourceReferenceOwnerV2026 - */ - 'name': string; -} -/** - * Details about the account source. - * @export - * @interface AccountSourceReferenceV2026 - */ -export interface AccountSourceReferenceV2026 { - /** - * The unique ID of the source. - * @type {string} - * @memberof AccountSourceReferenceV2026 - */ - 'id': string; - /** - * The name of the source. - * @type {string} - * @memberof AccountSourceReferenceV2026 - */ - 'name': string; - /** - * The alias of the source. - * @type {string} - * @memberof AccountSourceReferenceV2026 - */ - 'alias': string; - /** - * - * @type {AccountSourceReferenceOwnerV2026} - * @memberof AccountSourceReferenceV2026 - */ - 'owner': AccountSourceReferenceOwnerV2026; - /** - * - * @type {AccountSourceReferenceGovernanceGroupV2026} - * @memberof AccountSourceReferenceV2026 - */ - 'governanceGroup': AccountSourceReferenceGovernanceGroupV2026; -} -/** - * - * @export - * @interface AccountSourceV2026 - */ -export interface AccountSourceV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccountSourceV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccountSourceV2026 - */ - 'name'?: string; - /** - * Type of source returned. - * @type {string} - * @memberof AccountSourceV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedAccountV2026 - */ -export interface AccountStatusChangedAccountV2026 { - /** - * the ID of the account in the database - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'id'?: string; - /** - * the native identifier of the account - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'nativeIdentity'?: string; - /** - * the display name of the account - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'displayName'?: string; - /** - * the ID of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'sourceId'?: string; - /** - * the name of the source for this account - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'sourceName'?: string; - /** - * the number of entitlements on this account - * @type {number} - * @memberof AccountStatusChangedAccountV2026 - */ - 'entitlementCount'?: number; - /** - * this value is always \"account\" - * @type {string} - * @memberof AccountStatusChangedAccountV2026 - */ - 'accessType'?: string; -} -/** - * - * @export - * @interface AccountStatusChangedStatusChangeV2026 - */ -export interface AccountStatusChangedStatusChangeV2026 { - /** - * the previous status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeV2026 - */ - 'previousStatus'?: AccountStatusChangedStatusChangeV2026PreviousStatusV2026; - /** - * the new status of the account - * @type {string} - * @memberof AccountStatusChangedStatusChangeV2026 - */ - 'newStatus'?: AccountStatusChangedStatusChangeV2026NewStatusV2026; -} - -export const AccountStatusChangedStatusChangeV2026PreviousStatusV2026 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeV2026PreviousStatusV2026 = typeof AccountStatusChangedStatusChangeV2026PreviousStatusV2026[keyof typeof AccountStatusChangedStatusChangeV2026PreviousStatusV2026]; -export const AccountStatusChangedStatusChangeV2026NewStatusV2026 = { - Enabled: 'enabled', - Disabled: 'disabled', - Locked: 'locked' -} as const; - -export type AccountStatusChangedStatusChangeV2026NewStatusV2026 = typeof AccountStatusChangedStatusChangeV2026NewStatusV2026[keyof typeof AccountStatusChangedStatusChangeV2026NewStatusV2026]; - -/** - * - * @export - * @interface AccountStatusChangedV2026 - */ -export interface AccountStatusChangedV2026 { - /** - * the event type - * @type {string} - * @memberof AccountStatusChangedV2026 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AccountStatusChangedV2026 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AccountStatusChangedV2026 - */ - 'dateTime'?: string; - /** - * - * @type {AccountStatusChangedAccountV2026} - * @memberof AccountStatusChangedV2026 - */ - 'account': AccountStatusChangedAccountV2026; - /** - * - * @type {AccountStatusChangedStatusChangeV2026} - * @memberof AccountStatusChangedV2026 - */ - 'statusChange': AccountStatusChangedStatusChangeV2026; -} -/** - * Request used for account enable/disable - * @export - * @interface AccountToggleRequestV2026 - */ -export interface AccountToggleRequestV2026 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountToggleRequestV2026 - */ - 'externalVerificationId'?: string; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. - * @type {boolean} - * @memberof AccountToggleRequestV2026 - */ - 'forceProvisioning'?: boolean; -} -/** - * Uncorrelated account. - * @export - * @interface AccountUncorrelatedAccountV2026 - */ -export interface AccountUncorrelatedAccountV2026 { - /** - * Uncorrelated account\'s DTO type. - * @type {object} - * @memberof AccountUncorrelatedAccountV2026 - */ - 'type': AccountUncorrelatedAccountV2026TypeV2026; - /** - * Uncorrelated account\'s ID. - * @type {string} - * @memberof AccountUncorrelatedAccountV2026 - */ - 'id': string; - /** - * Uncorrelated account\'s display name. - * @type {string} - * @memberof AccountUncorrelatedAccountV2026 - */ - 'name': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof AccountUncorrelatedAccountV2026 - */ - 'nativeIdentity': string; - /** - * The source\'s unique identifier for the account. UUID is generated by the source system. - * @type {string} - * @memberof AccountUncorrelatedAccountV2026 - */ - 'uuid'?: string | null; -} - -export const AccountUncorrelatedAccountV2026TypeV2026 = { - Account: 'ACCOUNT' -} as const; - -export type AccountUncorrelatedAccountV2026TypeV2026 = typeof AccountUncorrelatedAccountV2026TypeV2026[keyof typeof AccountUncorrelatedAccountV2026TypeV2026]; - -/** - * Identity the account is uncorrelated with. - * @export - * @interface AccountUncorrelatedIdentityV2026 - */ -export interface AccountUncorrelatedIdentityV2026 { - /** - * DTO type of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2026 - */ - 'type': AccountUncorrelatedIdentityV2026TypeV2026; - /** - * ID of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2026 - */ - 'id': string; - /** - * Display name of the identity the account is uncorrelated with. - * @type {string} - * @memberof AccountUncorrelatedIdentityV2026 - */ - 'name': string; -} - -export const AccountUncorrelatedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AccountUncorrelatedIdentityV2026TypeV2026 = typeof AccountUncorrelatedIdentityV2026TypeV2026[keyof typeof AccountUncorrelatedIdentityV2026TypeV2026]; - -/** - * The source the accounts are uncorrelated from. - * @export - * @interface AccountUncorrelatedSourceV2026 - */ -export interface AccountUncorrelatedSourceV2026 { - /** - * The DTO type of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2026 - */ - 'type': AccountUncorrelatedSourceV2026TypeV2026; - /** - * The ID of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2026 - */ - 'id': string; - /** - * Display name of the source the accounts are uncorrelated from. - * @type {string} - * @memberof AccountUncorrelatedSourceV2026 - */ - 'name': string; -} - -export const AccountUncorrelatedSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccountUncorrelatedSourceV2026TypeV2026 = typeof AccountUncorrelatedSourceV2026TypeV2026[keyof typeof AccountUncorrelatedSourceV2026TypeV2026]; - -/** - * - * @export - * @interface AccountUncorrelatedV2026 - */ -export interface AccountUncorrelatedV2026 { - /** - * - * @type {AccountUncorrelatedIdentityV2026} - * @memberof AccountUncorrelatedV2026 - */ - 'identity': AccountUncorrelatedIdentityV2026; - /** - * - * @type {AccountUncorrelatedSourceV2026} - * @memberof AccountUncorrelatedV2026 - */ - 'source': AccountUncorrelatedSourceV2026; - /** - * - * @type {AccountUncorrelatedAccountV2026} - * @memberof AccountUncorrelatedV2026 - */ - 'account': AccountUncorrelatedAccountV2026; - /** - * The number of entitlements associated with this account. - * @type {number} - * @memberof AccountUncorrelatedV2026 - */ - 'entitlementCount'?: number; -} -/** - * Request used for account unlock - * @export - * @interface AccountUnlockRequestV2026 - */ -export interface AccountUnlockRequestV2026 { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountUnlockRequestV2026 - */ - 'externalVerificationId'?: string; - /** - * If set, the IDN account is unlocked after the workflow completes. - * @type {boolean} - * @memberof AccountUnlockRequestV2026 - */ - 'unlockIDNAccount'?: boolean; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountUnlockRequestV2026 - */ - 'forceProvisioning'?: boolean; -} -/** - * The type of the entitlement. - * @export - * @interface AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026 - */ -export interface AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026 { - /** - * The unique identifier of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026 - */ - 'id'?: string; - /** - * The name of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026 - */ - 'name'?: string | null; - /** - * The type of the owner. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface AccountUpdatedEntitlementChangesInnerAddedInnerV2026 - */ -export interface AccountUpdatedEntitlementChangesInnerAddedInnerV2026 { - /** - * The unique identifier of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2026 - */ - 'id'?: string | null; - /** - * The name of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2026 - */ - 'name'?: string | null; - /** - * - * @type {AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2026 - */ - 'owner'?: AccountUpdatedEntitlementChangesInnerAddedInnerOwnerV2026; - /** - * The value of the entitlement. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerAddedInnerV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface AccountUpdatedEntitlementChangesInnerV2026 - */ -export interface AccountUpdatedEntitlementChangesInnerV2026 { - /** - * The name of the entitlement attribute that was changed. - * @type {string} - * @memberof AccountUpdatedEntitlementChangesInnerV2026 - */ - 'attributeName': string; - /** - * The entitlements that were added. - * @type {Array} - * @memberof AccountUpdatedEntitlementChangesInnerV2026 - */ - 'added': Array | null; - /** - * The entitlements that were removed. - * @type {Array} - * @memberof AccountUpdatedEntitlementChangesInnerV2026 - */ - 'removed': Array | null; -} -/** - * Details about the event. - * @export - * @interface AccountUpdatedEventV2026 - */ -export interface AccountUpdatedEventV2026 { - /** - * The type of event. - * @type {string} - * @memberof AccountUpdatedEventV2026 - */ - 'type': AccountUpdatedEventV2026TypeV2026; - /** - * The cause of the event. - * @type {string} - * @memberof AccountUpdatedEventV2026 - */ - 'cause': AccountUpdatedEventV2026CauseV2026; -} - -export const AccountUpdatedEventV2026TypeV2026 = { - AccountUpdatedV2: 'ACCOUNT_UPDATED_V2' -} as const; - -export type AccountUpdatedEventV2026TypeV2026 = typeof AccountUpdatedEventV2026TypeV2026[keyof typeof AccountUpdatedEventV2026TypeV2026]; -export const AccountUpdatedEventV2026CauseV2026 = { - Aggregation: 'AGGREGATION', - Provisioning: 'PROVISIONING', - PasswordChange: 'PASSWORD_CHANGE' -} as const; - -export type AccountUpdatedEventV2026CauseV2026 = typeof AccountUpdatedEventV2026CauseV2026[keyof typeof AccountUpdatedEventV2026CauseV2026]; - -/** - * @type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInnerV2026 - * @export - */ -export type AccountUpdatedMultiValueAttributeChangesInnerAddedValuesInnerV2026 = Array | boolean | number | string; - -/** - * - * @export - * @interface AccountUpdatedMultiValueAttributeChangesInnerV2026 - */ -export interface AccountUpdatedMultiValueAttributeChangesInnerV2026 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2026 - */ - 'name': string; - /** - * The values that were added to the attribute. - * @type {Array} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2026 - */ - 'addedValues': Array; - /** - * The values that were removed from the attribute. - * @type {Array} - * @memberof AccountUpdatedMultiValueAttributeChangesInnerV2026 - */ - 'removedValues': Array; -} -/** - * @type AccountUpdatedSingleValueAttributeChangesInnerNewValueV2026 - * The new value of the attribute after the change. - * @export - */ -export type AccountUpdatedSingleValueAttributeChangesInnerNewValueV2026 = Array | boolean | number | string; - -/** - * @type AccountUpdatedSingleValueAttributeChangesInnerOldValueV2026 - * The old value of the attribute before the change. - * @export - */ -export type AccountUpdatedSingleValueAttributeChangesInnerOldValueV2026 = Array | boolean | number | string; - -/** - * - * @export - * @interface AccountUpdatedSingleValueAttributeChangesInnerV2026 - */ -export interface AccountUpdatedSingleValueAttributeChangesInnerV2026 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'name': string; - /** - * - * @type {AccountUpdatedSingleValueAttributeChangesInnerOldValueV2026} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'oldValue': AccountUpdatedSingleValueAttributeChangesInnerOldValueV2026 | null; - /** - * - * @type {AccountUpdatedSingleValueAttributeChangesInnerNewValueV2026} - * @memberof AccountUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'newValue': AccountUpdatedSingleValueAttributeChangesInnerNewValueV2026 | null; -} -/** - * - * @export - * @interface AccountUpdatedV2026 - */ -export interface AccountUpdatedV2026 { - /** - * - * @type {AccountUpdatedEventV2026} - * @memberof AccountUpdatedV2026 - */ - 'event': AccountUpdatedEventV2026; - /** - * - * @type {AccountSourceReferenceV2026} - * @memberof AccountUpdatedV2026 - */ - 'source': AccountSourceReferenceV2026; - /** - * - * @type {AccountV2V2026} - * @memberof AccountUpdatedV2026 - */ - 'account': AccountV2V2026; - /** - * - * @type {IdentityReference1V2026} - * @memberof AccountUpdatedV2026 - */ - 'identity': IdentityReference1V2026; - /** - * The types of changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2026 - */ - 'accountChangeTypes': Array; - /** - * Details about the single-value attribute changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2026 - */ - 'singleValueAttributeChanges': Array | null; - /** - * Details about the multi-value attribute changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2026 - */ - 'multiValueAttributeChanges': Array | null; - /** - * Details about the entitlement changes that occurred to the account. - * @type {Array} - * @memberof AccountUpdatedV2026 - */ - 'entitlementChanges': Array | null; -} - -export const AccountUpdatedV2026AccountChangeTypesV2026 = { - AttributesChanged: 'ATTRIBUTES_CHANGED', - EntitlementsAdded: 'ENTITLEMENTS_ADDED', - EntitlementsRemoved: 'ENTITLEMENTS_REMOVED' -} as const; - -export type AccountUpdatedV2026AccountChangeTypesV2026 = typeof AccountUpdatedV2026AccountChangeTypesV2026[keyof typeof AccountUpdatedV2026AccountChangeTypesV2026]; - -/** - * - * @export - * @interface AccountUsageV2026 - */ -export interface AccountUsageV2026 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof AccountUsageV2026 - */ - 'date'?: string; - /** - * The number of days within the month that the account was active in a source. - * @type {number} - * @memberof AccountUsageV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface AccountV2026 - */ -export interface AccountV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof AccountV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof AccountV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof AccountV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof AccountV2026 - */ - 'modified'?: string; - /** - * The unique ID of the source this account belongs to - * @type {string} - * @memberof AccountV2026 - */ - 'sourceId': string; - /** - * The display name of the source this account belongs to - * @type {string} - * @memberof AccountV2026 - */ - 'sourceName': string | null; - /** - * The unique ID of the identity this account is correlated to - * @type {string} - * @memberof AccountV2026 - */ - 'identityId'?: string; - /** - * The lifecycle state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2026 - */ - 'cloudLifecycleState'?: string | null; - /** - * The identity state of the identity this account is correlated to - * @type {string} - * @memberof AccountV2026 - */ - 'identityState'?: string | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof AccountV2026 - */ - 'connectionType'?: string | null; - /** - * Indicates if the account is of machine type - * @type {boolean} - * @memberof AccountV2026 - */ - 'isMachine'?: boolean; - /** - * - * @type {AccountAllOfRecommendationV2026} - * @memberof AccountV2026 - */ - 'recommendation'?: AccountAllOfRecommendationV2026; - /** - * The account attributes that are aggregated - * @type {{ [key: string]: any; }} - * @memberof AccountV2026 - */ - 'attributes': { [key: string]: any; } | null; - /** - * Indicates if this account is from an authoritative source - * @type {boolean} - * @memberof AccountV2026 - */ - 'authoritative': boolean; - /** - * A description of the account - * @type {string} - * @memberof AccountV2026 - */ - 'description'?: string | null; - /** - * Indicates if the account is currently disabled - * @type {boolean} - * @memberof AccountV2026 - */ - 'disabled': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof AccountV2026 - */ - 'locked': boolean; - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof AccountV2026 - */ - 'nativeIdentity': string; - /** - * If true, this is a user account within IdentityNow. If false, this is an account from a source system. - * @type {boolean} - * @memberof AccountV2026 - */ - 'systemAccount': boolean; - /** - * Indicates if this account is not correlated to an identity - * @type {boolean} - * @memberof AccountV2026 - */ - 'uncorrelated': boolean; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof AccountV2026 - */ - 'uuid'?: string | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof AccountV2026 - */ - 'manuallyCorrelated': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof AccountV2026 - */ - 'hasEntitlements': boolean; - /** - * - * @type {AccountAllOfIdentityV2026} - * @memberof AccountV2026 - */ - 'identity'?: AccountAllOfIdentityV2026; - /** - * - * @type {AccountAllOfSourceOwnerV2026} - * @memberof AccountV2026 - */ - 'sourceOwner'?: AccountAllOfSourceOwnerV2026 | null; - /** - * A string list containing the owning source\'s features - * @type {string} - * @memberof AccountV2026 - */ - 'features'?: string | null; - /** - * The origin of the account either aggregated or provisioned - * @type {string} - * @memberof AccountV2026 - */ - 'origin'?: AccountV2026OriginV2026 | null; - /** - * - * @type {AccountAllOfOwnerIdentityV2026} - * @memberof AccountV2026 - */ - 'ownerIdentity'?: AccountAllOfOwnerIdentityV2026; -} - -export const AccountV2026OriginV2026 = { - Aggregated: 'AGGREGATED', - Provisioned: 'PROVISIONED' -} as const; - -export type AccountV2026OriginV2026 = typeof AccountV2026OriginV2026[keyof typeof AccountV2026OriginV2026]; - -/** - * Details about the account. - * @export - * @interface AccountV2V2026 - */ -export interface AccountV2V2026 { - /** - * The unique identifier of the account. - * @type {string} - * @memberof AccountV2V2026 - */ - 'id': string; - /** - * The name of the account. - * @type {string} - * @memberof AccountV2V2026 - */ - 'name': string; - /** - * The unique ID of the account generated by the source system. - * @type {string} - * @memberof AccountV2V2026 - */ - 'nativeIdentity': string; - /** - * The unique ID associated with this account. - * @type {string} - * @memberof AccountV2V2026 - */ - 'uuid': string | null; - /** - * Indicates if the account is correlated to an identity. - * @type {boolean} - * @memberof AccountV2V2026 - */ - 'correlated': boolean; - /** - * Indicates if the account is a machine account. - * @type {boolean} - * @memberof AccountV2V2026 - */ - 'isMachine': boolean; - /** - * The origin of the account. - * @type {string} - * @memberof AccountV2V2026 - */ - 'origin': string | null; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof AccountV2V2026 - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * Accounts async response containing details on started async process - * @export - * @interface AccountsAsyncResultV2026 - */ -export interface AccountsAsyncResultV2026 { - /** - * id of the task - * @type {string} - * @memberof AccountsAsyncResultV2026 - */ - 'id': string; -} -/** - * Reference to the source that has been aggregated. - * @export - * @interface AccountsCollectedForAggregationSourceV2026 - */ -export interface AccountsCollectedForAggregationSourceV2026 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2026 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2026 - */ - 'type': AccountsCollectedForAggregationSourceV2026TypeV2026; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountsCollectedForAggregationSourceV2026 - */ - 'name': string; -} - -export const AccountsCollectedForAggregationSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AccountsCollectedForAggregationSourceV2026TypeV2026 = typeof AccountsCollectedForAggregationSourceV2026TypeV2026[keyof typeof AccountsCollectedForAggregationSourceV2026TypeV2026]; - -/** - * Overall statistics about the account collection. - * @export - * @interface AccountsCollectedForAggregationStatsV2026 - */ -export interface AccountsCollectedForAggregationStatsV2026 { - /** - * The number of accounts which were scanned / iterated over. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2026 - */ - 'scanned': number; - /** - * The number of accounts which existed before, but had no changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2026 - */ - 'unchanged': number; - /** - * The number of accounts which existed before, but had changes. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2026 - */ - 'changed': number; - /** - * The number of accounts which are new - have not existed before. - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2026 - */ - 'added': number; - /** - * The number accounts which existed before, but no longer exist (thus getting removed). - * @type {number} - * @memberof AccountsCollectedForAggregationStatsV2026 - */ - 'removed': number; -} -/** - * - * @export - * @interface AccountsCollectedForAggregationV2026 - */ -export interface AccountsCollectedForAggregationV2026 { - /** - * - * @type {AccountsCollectedForAggregationSourceV2026} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'source': AccountsCollectedForAggregationSourceV2026; - /** - * The overall status of the collection. - * @type {object} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'status': AccountsCollectedForAggregationV2026StatusV2026; - /** - * The date and time when the account collection started. - * @type {string} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'started': string; - /** - * The date and time when the account collection finished. - * @type {string} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'completed': string; - /** - * A list of errors that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'errors': Array | null; - /** - * A list of warnings that occurred during the collection. - * @type {Array} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'warnings': Array | null; - /** - * - * @type {AccountsCollectedForAggregationStatsV2026} - * @memberof AccountsCollectedForAggregationV2026 - */ - 'stats': AccountsCollectedForAggregationStatsV2026; -} - -export const AccountsCollectedForAggregationV2026StatusV2026 = { - Success: 'Success', - Failed: 'Failed', - Terminated: 'Terminated' -} as const; - -export type AccountsCollectedForAggregationV2026StatusV2026 = typeof AccountsCollectedForAggregationV2026StatusV2026[keyof typeof AccountsCollectedForAggregationV2026StatusV2026]; - -/** - * Arguments for Account Export report (ACCOUNTS) - * @export - * @interface AccountsExportReportArgumentsV2026 - */ -export interface AccountsExportReportArgumentsV2026 { - /** - * Source ID. - * @type {string} - * @memberof AccountsExportReportArgumentsV2026 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof AccountsExportReportArgumentsV2026 - */ - 'sourceName': string; -} -/** - * - * @export - * @interface AccountsSelectionRequestV2026 - */ -export interface AccountsSelectionRequestV2026 { - /** - * A list of Identity IDs for whom the Access is requested. - * @type {Array} - * @memberof AccountsSelectionRequestV2026 - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof AccountsSelectionRequestV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * - * @type {Array} - * @memberof AccountsSelectionRequestV2026 - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccountsSelectionRequestV2026 - */ - 'clientMetadata'?: { [key: string]: string; }; -} - - -/** - * - * @export - * @interface AccountsSelectionResponseV2026 - */ -export interface AccountsSelectionResponseV2026 { - /** - * A list of available account selections per identity in the request, for all the requested items - * @type {Array} - * @memberof AccountsSelectionResponseV2026 - */ - 'identities'?: Array; -} -/** - * - * @export - * @interface ActivateCampaignOptionsV2026 - */ -export interface ActivateCampaignOptionsV2026 { - /** - * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - * @type {string} - * @memberof ActivateCampaignOptionsV2026 - */ - 'timeZone'?: string; -} -/** - * JIT activation workflow status. - * @export - * @enum {string} - */ - -export const ActivationWorkflowStatusV2026 = { - Creating: 'CREATING', - Activating: 'ACTIVATING', - Invalid: 'INVALID', - Error: 'ERROR', - Provisioned: 'PROVISIONED', - Deprovisioning: 'DEPROVISIONING', - Completed: 'COMPLETED', - Revoked: 'REVOKED' -} as const; - -export type ActivationWorkflowStatusV2026 = typeof ActivationWorkflowStatusV2026[keyof typeof ActivationWorkflowStatusV2026]; - - -/** - * - * @export - * @interface ActivityConfigurationSettingsV2026 - */ -export interface ActivityConfigurationSettingsV2026 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'clusterId'?: string | null; - /** - * The time period for retaining activity logs. - * @type {number} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'retentionTimePeriod'?: number; - /** - * The type of retention period (e.g., days, months, years). - * @type {string} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'retentionTimeType'?: string | null; - /** - * List of user identifiers to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'excludeUsers'?: Array | null; - /** - * List of folder paths to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'excludeFolders'?: Array | null; - /** - * List of file extensions to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'excludeFileExtensions'?: Array | null; - /** - * List of actions to exclude from activity tracking. - * @type {Array} - * @memberof ActivityConfigurationSettingsV2026 - */ - 'excludeActions'?: Array | null; -} -/** - * - * @export - * @interface ActivityIdentityV2026 - */ -export interface ActivityIdentityV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof ActivityIdentityV2026 - */ - 'name'?: string; - /** - * Type of object - * @type {string} - * @memberof ActivityIdentityV2026 - */ - 'type'?: string; -} -/** - * Insights into account activity - * @export - * @interface ActivityInsightsV2026 - */ -export interface ActivityInsightsV2026 { - /** - * UUID of the account - * @type {string} - * @memberof ActivityInsightsV2026 - */ - 'accountID'?: string; - /** - * The number of days of activity - * @type {number} - * @memberof ActivityInsightsV2026 - */ - 'usageDays'?: number; - /** - * Status indicating if the activity is complete or unknown - * @type {string} - * @memberof ActivityInsightsV2026 - */ - 'usageDaysState'?: ActivityInsightsV2026UsageDaysStateV2026; -} - -export const ActivityInsightsV2026UsageDaysStateV2026 = { - Complete: 'COMPLETE', - Unknown: 'UNKNOWN' -} as const; - -export type ActivityInsightsV2026UsageDaysStateV2026 = typeof ActivityInsightsV2026UsageDaysStateV2026[keyof typeof ActivityInsightsV2026UsageDaysStateV2026]; - -/** - * Reference to an additional owner (identity or governance group). - * @export - * @interface AdditionalOwnerRefV2026 - */ -export interface AdditionalOwnerRefV2026 { - /** - * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2026 - */ - 'type'?: AdditionalOwnerRefV2026TypeV2026; - /** - * ID of the identity or governance group. - * @type {string} - * @memberof AdditionalOwnerRefV2026 - */ - 'id'?: string; - /** - * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. - * @type {string} - * @memberof AdditionalOwnerRefV2026 - */ - 'name'?: string | null; -} - -export const AdditionalOwnerRefV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AdditionalOwnerRefV2026TypeV2026 = typeof AdditionalOwnerRefV2026TypeV2026[keyof typeof AdditionalOwnerRefV2026TypeV2026]; - -/** - * - * @export - * @interface AdminReviewReassignReassignToV2026 - */ -export interface AdminReviewReassignReassignToV2026 { - /** - * The identity ID to which the review is being assigned. - * @type {string} - * @memberof AdminReviewReassignReassignToV2026 - */ - 'id'?: string; - /** - * The type of the ID provided. - * @type {string} - * @memberof AdminReviewReassignReassignToV2026 - */ - 'type'?: AdminReviewReassignReassignToV2026TypeV2026; -} - -export const AdminReviewReassignReassignToV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type AdminReviewReassignReassignToV2026TypeV2026 = typeof AdminReviewReassignReassignToV2026TypeV2026[keyof typeof AdminReviewReassignReassignToV2026TypeV2026]; - -/** - * - * @export - * @interface AdminReviewReassignV2026 - */ -export interface AdminReviewReassignV2026 { - /** - * List of certification IDs to reassign - * @type {Array} - * @memberof AdminReviewReassignV2026 - */ - 'certificationIds'?: Array; - /** - * - * @type {AdminReviewReassignReassignToV2026} - * @memberof AdminReviewReassignV2026 - */ - 'reassignTo'?: AdminReviewReassignReassignToV2026; - /** - * Comment to explain why the certification was reassigned - * @type {string} - * @memberof AdminReviewReassignV2026 - */ - 'reason'?: string; -} -/** - * - * @export - * @interface AggregationResultV2026 - */ -export interface AggregationResultV2026 { - /** - * The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - * @type {object} - * @memberof AggregationResultV2026 - */ - 'aggregations'?: object; - /** - * The results of the aggregation search query. - * @type {Array} - * @memberof AggregationResultV2026 - */ - 'hits'?: Array; -} -/** - * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const AggregationTypeV2026 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT' -} as const; - -export type AggregationTypeV2026 = typeof AggregationTypeV2026[keyof typeof AggregationTypeV2026]; - - -/** - * - * @export - * @interface AggregationsV2026 - */ -export interface AggregationsV2026 { - /** - * - * @type {NestedAggregationV2026} - * @memberof AggregationsV2026 - */ - 'nested'?: NestedAggregationV2026; - /** - * - * @type {MetricAggregationV2026} - * @memberof AggregationsV2026 - */ - 'metric'?: MetricAggregationV2026; - /** - * - * @type {FilterAggregationV2026} - * @memberof AggregationsV2026 - */ - 'filter'?: FilterAggregationV2026; - /** - * - * @type {BucketAggregationV2026} - * @memberof AggregationsV2026 - */ - 'bucket'?: BucketAggregationV2026; -} -/** - * - * @export - * @interface AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026 - */ -export interface AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026 { - /** - * - * @type {Array} - * @memberof AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026 - */ - 'matchTerms'?: Array; - /** - * If it is AND operators for match terms - * @type {boolean} - * @memberof AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026 - */ - 'and'?: boolean; -} -/** - * - * @export - * @interface AppAccessProfileSelectorAccountMatchConfigV2026 - */ -export interface AppAccessProfileSelectorAccountMatchConfigV2026 { - /** - * - * @type {AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026} - * @memberof AppAccessProfileSelectorAccountMatchConfigV2026 - */ - 'matchExpression'?: AppAccessProfileSelectorAccountMatchConfigMatchExpressionV2026; -} -/** - * - * @export - * @interface AppAccessProfileSelectorV2026 - */ -export interface AppAccessProfileSelectorV2026 { - /** - * The application id - * @type {string} - * @memberof AppAccessProfileSelectorV2026 - */ - 'applicationId'?: string; - /** - * - * @type {AppAccessProfileSelectorAccountMatchConfigV2026} - * @memberof AppAccessProfileSelectorV2026 - */ - 'accountMatchConfig'?: AppAccessProfileSelectorAccountMatchConfigV2026; -} -/** - * - * @export - * @interface AppAccountDetailsSourceAccountV2026 - */ -export interface AppAccountDetailsSourceAccountV2026 { - /** - * The account ID - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2026 - */ - 'id'?: string; - /** - * The native identity of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2026 - */ - 'nativeIdentity'?: string; - /** - * The display name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2026 - */ - 'displayName'?: string; - /** - * The source ID of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2026 - */ - 'sourceId'?: string; - /** - * The source name of account - * @type {string} - * @memberof AppAccountDetailsSourceAccountV2026 - */ - 'sourceDisplayName'?: string; -} -/** - * - * @export - * @interface AppAccountDetailsV2026 - */ -export interface AppAccountDetailsV2026 { - /** - * The source app ID - * @type {string} - * @memberof AppAccountDetailsV2026 - */ - 'appId'?: string; - /** - * The source app display name - * @type {string} - * @memberof AppAccountDetailsV2026 - */ - 'appDisplayName'?: string; - /** - * - * @type {AppAccountDetailsSourceAccountV2026} - * @memberof AppAccountDetailsV2026 - */ - 'sourceAccount'?: AppAccountDetailsSourceAccountV2026; -} -/** - * - * @export - * @interface AppAllOfAccountV2026 - */ -export interface AppAllOfAccountV2026 { - /** - * The SailPoint generated unique ID - * @type {string} - * @memberof AppAllOfAccountV2026 - */ - 'id'?: string; - /** - * The account ID generated by the source - * @type {string} - * @memberof AppAllOfAccountV2026 - */ - 'accountId'?: string; -} -/** - * - * @export - * @interface AppV2026 - */ -export interface AppV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AppV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AppV2026 - */ - 'name'?: string; - /** - * - * @type {Reference1V2026} - * @memberof AppV2026 - */ - 'source'?: Reference1V2026; - /** - * - * @type {AppAllOfAccountV2026} - * @memberof AppV2026 - */ - 'account'?: AppAllOfAccountV2026; -} -/** - * - * @export - * @interface ApplicationCrawlerSettingsV2026 - */ -export interface ApplicationCrawlerSettingsV2026 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'clusterId'?: string | null; - /** - * - * @type {CrawlResourcesSizesOptionsV2026} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'calculateResourceSize'?: CrawlResourcesSizesOptionsV2026; - /** - * Indicates whether to crawl the snapshots folder. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'crawlSnapshotsFolder'?: boolean | null; - /** - * Indicates whether to crawl mailboxes. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'crawlMailboxes'?: boolean | null; - /** - * Indicates whether to crawl public folders. - * @type {boolean} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'crawlPublicFolders'?: boolean | null; - /** - * Regular expression pattern for paths to exclude from crawling. - * @type {string} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'excludedPathsByRegex'?: string | null; - /** - * List of top-level shares to crawl. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'crawlTopLevelShares'?: Array | null; - /** - * List of resource identifiers to exclude from crawling. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'excludedResources'?: Array | null; - /** - * List of resource identifiers to include in crawling. - * @type {Array} - * @memberof ApplicationCrawlerSettingsV2026 - */ - 'includeResources'?: Array | null; -} - - -/** - * - * @export - * @interface ApplicationDiscoveryRequestV2026 - */ -export interface ApplicationDiscoveryRequestV2026 { - /** - * List of dataset Ids to discover applications - * @type {Array} - * @memberof ApplicationDiscoveryRequestV2026 - */ - 'datasetIds': Array; -} -/** - * The target(source) of app discovery - * @export - * @interface ApplicationDiscoveryResponseTargetV2026 - */ -export interface ApplicationDiscoveryResponseTargetV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof ApplicationDiscoveryResponseTargetV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ApplicationDiscoveryResponseTargetV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ApplicationDiscoveryResponseTargetV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface ApplicationDiscoveryResponseV2026 - */ -export interface ApplicationDiscoveryResponseV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'id'?: string; - /** - * Type of task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'type'?: ApplicationDiscoveryResponseV2026TypeV2026; - /** - * Name of the task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'uniqueName'?: string; - /** - * Description of the app discovery aggregation - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'description'?: string; - /** - * Name of the parent of the task for app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'parentName'?: string | null; - /** - * Service to execute app discovery - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'launcher'?: string; - /** - * - * @type {ApplicationDiscoveryResponseTargetV2026} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'target'?: ApplicationDiscoveryResponseTargetV2026; - /** - * Creation date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'created'?: string; - /** - * Last modification date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'modified'?: string; - /** - * Launch date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'launched'?: string | null; - /** - * Completion date of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'completed'?: string | null; - /** - * - * @type {TaskDefinitionSummaryV2026} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2026; - /** - * Completion status of app discovery task - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'completionStatus'?: ApplicationDiscoveryResponseV2026CompletionStatusV2026 | null; - /** - * Messages associated with the app discovery task - * @type {Array} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'messages'?: Array; - /** - * Return values associated with the app discovery task - * @type {Array} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'returns'?: Array; - /** - * Attributes of the app discovery task - * @type {{ [key: string]: any; }} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Current progress of aggregation - * @type {string} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'progress'?: string | null; - /** - * Current percentage completion of app discovery task - * @type {number} - * @memberof ApplicationDiscoveryResponseV2026 - */ - 'percentComplete'?: number; -} - -export const ApplicationDiscoveryResponseV2026TypeV2026 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type ApplicationDiscoveryResponseV2026TypeV2026 = typeof ApplicationDiscoveryResponseV2026TypeV2026[keyof typeof ApplicationDiscoveryResponseV2026TypeV2026]; -export const ApplicationDiscoveryResponseV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type ApplicationDiscoveryResponseV2026CompletionStatusV2026 = typeof ApplicationDiscoveryResponseV2026CompletionStatusV2026[keyof typeof ApplicationDiscoveryResponseV2026CompletionStatusV2026]; - -/** - * - * @export - * @interface ApplicationItemV2026 - */ -export interface ApplicationItemV2026 { - /** - * The unique identifier of the application. - * @type {number} - * @memberof ApplicationItemV2026 - */ - 'id'?: number; - /** - * The display name of the application. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'name'?: string | null; - /** - * A brief description of the application and its purpose. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'description'?: string | null; - /** - * The type of the application. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'type'?: string | null; - /** - * A list of tags associated with the application. - * @type {Array} - * @memberof ApplicationItemV2026 - */ - 'tags'?: Array | null; - /** - * The status of the last connection test performed on the application. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'testConnectionStatus'?: string | null; - /** - * The timestamp of the last connection test performed on the application, in milliseconds since epoch. - * @type {number} - * @memberof ApplicationItemV2026 - */ - 'testConnectionDate'?: number | null; - /** - * The identifier of the cluster used for crawling resources. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'rcClusterId'?: string | null; - /** - * The identifier of the cluster used for data classification. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'dcClusterId'?: string | null; - /** - * The identifier of the cluster used for permission collection. - * @type {string} - * @memberof ApplicationItemV2026 - */ - 'pcClusterId'?: string | null; -} -/** - * Specifies the type of application. Possible values: 1 - Sharepoint 8 - WindowsFileServer 9 - ActiveDirectory 11 - EmcCelerraCifs 15 - NetappCifs 20 - EmcIsilon 21 - GoogleDrive 24 - Box 25 - Dropbox 27 - OneDriveForBusiness 28 - SharepointOnline 29 - ExchangeOnline 33 - Cifs 35 - AwsS3 37 - Snowflake - * @export - * @enum {number} - */ - -export const ApplicationTypeV2026 = { - NUMBER_1: 1, - NUMBER_8: 8, - NUMBER_9: 9, - NUMBER_11: 11, - NUMBER_15: 15, - NUMBER_20: 20, - NUMBER_21: 21, - NUMBER_24: 24, - NUMBER_25: 25, - NUMBER_27: 27, - NUMBER_28: 28, - NUMBER_29: 29, - NUMBER_33: 33, - NUMBER_35: 35, - NUMBER_37: 37 -} as const; - -export type ApplicationTypeV2026 = typeof ApplicationTypeV2026[keyof typeof ApplicationTypeV2026]; - - -/** - * - * @export - * @interface Approval1V2026 - */ -export interface Approval1V2026 { - /** - * - * @type {Array} - * @memberof Approval1V2026 - */ - 'comments'?: Array; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Approval1V2026 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityIdentityV2026} - * @memberof Approval1V2026 - */ - 'owner'?: ActivityIdentityV2026; - /** - * The result of the approval - * @type {string} - * @memberof Approval1V2026 - */ - 'result'?: string; - /** - * - * @type {AttributeRequestV2026} - * @memberof Approval1V2026 - */ - 'attributeRequest'?: AttributeRequestV2026; - /** - * - * @type {AccountSourceV2026} - * @memberof Approval1V2026 - */ - 'source'?: AccountSourceV2026; -} -/** - * Criteria for approval - * @export - * @interface ApprovalApprovalCriteriaApprovalV2026 - */ -export interface ApprovalApprovalCriteriaApprovalV2026 { - /** - * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to approve - * @type {string} - * @memberof ApprovalApprovalCriteriaApprovalV2026 - */ - 'calculationType'?: ApprovalApprovalCriteriaApprovalV2026CalculationTypeV2026; - /** - * The value that needs to be met for the approval criteria - * @type {number} - * @memberof ApprovalApprovalCriteriaApprovalV2026 - */ - 'value'?: number; -} - -export const ApprovalApprovalCriteriaApprovalV2026CalculationTypeV2026 = { - Count: 'COUNT', - Percent: 'PERCENT' -} as const; - -export type ApprovalApprovalCriteriaApprovalV2026CalculationTypeV2026 = typeof ApprovalApprovalCriteriaApprovalV2026CalculationTypeV2026[keyof typeof ApprovalApprovalCriteriaApprovalV2026CalculationTypeV2026]; - -/** - * Criteria for rejection - * @export - * @interface ApprovalApprovalCriteriaRejectionV2026 - */ -export interface ApprovalApprovalCriteriaRejectionV2026 { - /** - * This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to reject - * @type {string} - * @memberof ApprovalApprovalCriteriaRejectionV2026 - */ - 'calculationType'?: ApprovalApprovalCriteriaRejectionV2026CalculationTypeV2026; - /** - * The value that needs to be met for the rejection criteria - * @type {number} - * @memberof ApprovalApprovalCriteriaRejectionV2026 - */ - 'value'?: number; -} - -export const ApprovalApprovalCriteriaRejectionV2026CalculationTypeV2026 = { - Count: 'COUNT', - Percent: 'PERCENT' -} as const; - -export type ApprovalApprovalCriteriaRejectionV2026CalculationTypeV2026 = typeof ApprovalApprovalCriteriaRejectionV2026CalculationTypeV2026[keyof typeof ApprovalApprovalCriteriaRejectionV2026CalculationTypeV2026]; - -/** - * Criteria that needs to be met for an approval or rejection - * @export - * @interface ApprovalApprovalCriteriaV2026 - */ -export interface ApprovalApprovalCriteriaV2026 { - /** - * Type of approval criteria, such as SERIAL or PARALLEL - * @type {string} - * @memberof ApprovalApprovalCriteriaV2026 - */ - 'type'?: string; - /** - * - * @type {ApprovalApprovalCriteriaApprovalV2026} - * @memberof ApprovalApprovalCriteriaV2026 - */ - 'approval'?: ApprovalApprovalCriteriaApprovalV2026; - /** - * - * @type {ApprovalApprovalCriteriaRejectionV2026} - * @memberof ApprovalApprovalCriteriaV2026 - */ - 'rejection'?: ApprovalApprovalCriteriaRejectionV2026; -} -/** - * Approval Approve Request - * @export - * @interface ApprovalApproveRequestV2026 - */ -export interface ApprovalApproveRequestV2026 { - /** - * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. - * @type {{ [key: string]: string; }} - * @memberof ApprovalApproveRequestV2026 - */ - 'additionalAttributes'?: { [key: string]: string; }; - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalApproveRequestV2026 - */ - 'comment'?: string; -} -/** - * Approval Attributes Request - * @export - * @interface ApprovalAttributesRequestV2026 - */ -export interface ApprovalAttributesRequestV2026 { - /** - * Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. - * @type {{ [key: string]: string; }} - * @memberof ApprovalAttributesRequestV2026 - */ - 'additionalAttributes'?: { [key: string]: string; }; - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalAttributesRequestV2026 - */ - 'comment'?: string; - /** - * List of attribute keys to be removed. - * @type {Array} - * @memberof ApprovalAttributesRequestV2026 - */ - 'removeAttributeKeys'?: Array; -} -/** - * Batch properties if an approval is sent via batching. - * @export - * @interface ApprovalBatchV2026 - */ -export interface ApprovalBatchV2026 { - /** - * ID of the batch - * @type {string} - * @memberof ApprovalBatchV2026 - */ - 'batchId'?: string; - /** - * How many approvals are going to be in this batch. Defaults to 1 if not provided. - * @type {number} - * @memberof ApprovalBatchV2026 - */ - 'batchSize'?: number; -} -/** - * Request body for cancelling a single approval request. - * @export - * @interface ApprovalCancelRequestV2026 - */ -export interface ApprovalCancelRequestV2026 { - /** - * Optional comment associated with the cancel request. - * @type {string} - * @memberof ApprovalCancelRequestV2026 - */ - 'comment'?: string; -} -/** - * Comments Object - * @export - * @interface ApprovalComment1V2026 - */ -export interface ApprovalComment1V2026 { - /** - * - * @type {ApprovalIdentityV2026} - * @memberof ApprovalComment1V2026 - */ - 'author'?: ApprovalIdentityV2026; - /** - * Comment to be left on an approval - * @type {string} - * @memberof ApprovalComment1V2026 - */ - 'comment'?: string; - /** - * Date the comment was created - * @type {string} - * @memberof ApprovalComment1V2026 - */ - 'createdDate'?: string; - /** - * ID of the comment - * @type {string} - * @memberof ApprovalComment1V2026 - */ - 'commentId'?: string; -} -/** - * - * @export - * @interface ApprovalComment2V2026 - */ -export interface ApprovalComment2V2026 { - /** - * The comment text - * @type {string} - * @memberof ApprovalComment2V2026 - */ - 'comment'?: string; - /** - * The name of the commenter - * @type {string} - * @memberof ApprovalComment2V2026 - */ - 'commenter'?: string; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ApprovalComment2V2026 - */ - 'date'?: string | null; -} -/** - * - * @export - * @interface ApprovalCommentV2026 - */ -export interface ApprovalCommentV2026 { - /** - * Comment provided either by the approval requester or the approver. - * @type {string} - * @memberof ApprovalCommentV2026 - */ - 'comment': string; - /** - * The time when this comment was provided. - * @type {string} - * @memberof ApprovalCommentV2026 - */ - 'timestamp': string; - /** - * Name of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2026 - */ - 'user': string; - /** - * Id of the user that provided this comment. - * @type {string} - * @memberof ApprovalCommentV2026 - */ - 'id': string; - /** - * Status transition of the draft. - * @type {string} - * @memberof ApprovalCommentV2026 - */ - 'changedToStatus': ApprovalCommentV2026ChangedToStatusV2026; -} - -export const ApprovalCommentV2026ChangedToStatusV2026 = { - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type ApprovalCommentV2026ChangedToStatusV2026 = typeof ApprovalCommentV2026ChangedToStatusV2026[keyof typeof ApprovalCommentV2026ChangedToStatusV2026]; - -/** - * - * @export - * @interface ApprovalCommentsRequestV2026 - */ -export interface ApprovalCommentsRequestV2026 { - /** - * Comment associated with the request. - * @type {string} - * @memberof ApprovalCommentsRequestV2026 - */ - 'comment'?: string; -} -/** - * Timezone configuration for cron schedules. - * @export - * @interface ApprovalConfigCronTimezoneV2026 - */ -export interface ApprovalConfigCronTimezoneV2026 { - /** - * Timezone location for cron schedules. - * @type {string} - * @memberof ApprovalConfigCronTimezoneV2026 - */ - 'location'?: string; - /** - * Timezone offset for cron schedules. - * @type {string} - * @memberof ApprovalConfigCronTimezoneV2026 - */ - 'offset'?: string; -} -/** - * - * @export - * @interface ApprovalConfigEscalationConfigEscalationChainInnerV2026 - */ -export interface ApprovalConfigEscalationConfigEscalationChainInnerV2026 { - /** - * Starting at 1 defines the order in which the identities will get assigned - * @type {number} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2026 - */ - 'tier'?: number; - /** - * Optional Identity ID of the type of identity defined in the \'identityType\' field. - * @type {string} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2026 - */ - 'identityId'?: string; - /** - * Type of identityId in the escalation chain. - * @type {string} - * @memberof ApprovalConfigEscalationConfigEscalationChainInnerV2026 - */ - 'identityType'?: ApprovalConfigEscalationConfigEscalationChainInnerV2026IdentityTypeV2026; -} - -export const ApprovalConfigEscalationConfigEscalationChainInnerV2026IdentityTypeV2026 = { - Identity: 'IDENTITY', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER' -} as const; - -export type ApprovalConfigEscalationConfigEscalationChainInnerV2026IdentityTypeV2026 = typeof ApprovalConfigEscalationConfigEscalationChainInnerV2026IdentityTypeV2026[keyof typeof ApprovalConfigEscalationConfigEscalationChainInnerV2026IdentityTypeV2026]; - -/** - * Configuration for escalations. - * @export - * @interface ApprovalConfigEscalationConfigV2026 - */ -export interface ApprovalConfigEscalationConfigV2026 { - /** - * Indicates if escalations are enabled. - * @type {boolean} - * @memberof ApprovalConfigEscalationConfigV2026 - */ - 'enabled'?: boolean; - /** - * Number of days until the first escalation. - * @type {number} - * @memberof ApprovalConfigEscalationConfigV2026 - */ - 'daysUntilFirstEscalation'?: number; - /** - * Cron schedule for escalations. - * @type {string} - * @memberof ApprovalConfigEscalationConfigV2026 - */ - 'escalationCronSchedule'?: string; - /** - * Escalation chain configuration. - * @type {Array} - * @memberof ApprovalConfigEscalationConfigV2026 - */ - 'escalationChain'?: Array; -} -/** - * Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. - * @export - * @interface ApprovalConfigFallbackApproverV2026 - */ -export interface ApprovalConfigFallbackApproverV2026 { - /** - * Optional Identity ID of the type of identity defined in the \'type\' field. - * @type {string} - * @memberof ApprovalConfigFallbackApproverV2026 - */ - 'identityID'?: string; - /** - * Type of identityID for the fallback approver. - * @type {string} - * @memberof ApprovalConfigFallbackApproverV2026 - */ - 'type'?: ApprovalConfigFallbackApproverV2026TypeV2026; -} - -export const ApprovalConfigFallbackApproverV2026TypeV2026 = { - Identity: 'IDENTITY', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER' -} as const; - -export type ApprovalConfigFallbackApproverV2026TypeV2026 = typeof ApprovalConfigFallbackApproverV2026TypeV2026[keyof typeof ApprovalConfigFallbackApproverV2026TypeV2026]; - -/** - * Configuration for reminders. - * @export - * @interface ApprovalConfigReminderConfigV2026 - */ -export interface ApprovalConfigReminderConfigV2026 { - /** - * Indicates if reminders are enabled. - * @type {boolean} - * @memberof ApprovalConfigReminderConfigV2026 - */ - 'enabled'?: boolean; - /** - * Number of days until the first reminder. - * @type {number} - * @memberof ApprovalConfigReminderConfigV2026 - */ - 'daysUntilFirstReminder'?: number; - /** - * Cron schedule for reminders. - * @type {string} - * @memberof ApprovalConfigReminderConfigV2026 - */ - 'reminderCronSchedule'?: string; - /** - * Maximum number of reminders. Max is 20. - * @type {number} - * @memberof ApprovalConfigReminderConfigV2026 - */ - 'maxReminders'?: number; -} -/** - * - * @export - * @interface ApprovalConfigSerialChainInnerV2026 - */ -export interface ApprovalConfigSerialChainInnerV2026 { - /** - * Starting at 1 defines the order in which the identities will get assigned - * @type {number} - * @memberof ApprovalConfigSerialChainInnerV2026 - */ - 'tier'?: number; - /** - * Optional Identity ID of the type of identity defined in the \'identityType\' field. - * @type {string} - * @memberof ApprovalConfigSerialChainInnerV2026 - */ - 'identityId'?: string; - /** - * Type of identityId in the serial chain. - * @type {string} - * @memberof ApprovalConfigSerialChainInnerV2026 - */ - 'identityType'?: ApprovalConfigSerialChainInnerV2026IdentityTypeV2026; -} - -export const ApprovalConfigSerialChainInnerV2026IdentityTypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', - AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', - ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', - EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', - RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', - SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', - RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', - AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', - ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', - EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', - RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', - SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', - RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' -} as const; - -export type ApprovalConfigSerialChainInnerV2026IdentityTypeV2026 = typeof ApprovalConfigSerialChainInnerV2026IdentityTypeV2026[keyof typeof ApprovalConfigSerialChainInnerV2026IdentityTypeV2026]; - -/** - * TimeoutConfig contains configurations around when the approval request should expire. - * @export - * @interface ApprovalConfigTimeoutConfigV2026 - */ -export interface ApprovalConfigTimeoutConfigV2026 { - /** - * Indicates if timeout is enabled. - * @type {boolean} - * @memberof ApprovalConfigTimeoutConfigV2026 - */ - 'enabled'?: boolean; - /** - * Number of days until approval request times out. Max value is 90. - * @type {number} - * @memberof ApprovalConfigTimeoutConfigV2026 - */ - 'daysUntilTimeout'?: number; - /** - * Result of timeout. - * @type {string} - * @memberof ApprovalConfigTimeoutConfigV2026 - */ - 'timeoutResult'?: ApprovalConfigTimeoutConfigV2026TimeoutResultV2026; -} - -export const ApprovalConfigTimeoutConfigV2026TimeoutResultV2026 = { - Expired: 'EXPIRED', - Approved: 'APPROVED' -} as const; - -export type ApprovalConfigTimeoutConfigV2026TimeoutResultV2026 = typeof ApprovalConfigTimeoutConfigV2026TimeoutResultV2026[keyof typeof ApprovalConfigTimeoutConfigV2026TimeoutResultV2026]; - -/** - * Approval config Object - * @export - * @interface ApprovalConfigV2026 - */ -export interface ApprovalConfigV2026 { - /** - * - * @type {ApprovalConfigReminderConfigV2026} - * @memberof ApprovalConfigV2026 - */ - 'reminderConfig'?: ApprovalConfigReminderConfigV2026; - /** - * - * @type {ApprovalConfigEscalationConfigV2026} - * @memberof ApprovalConfigV2026 - */ - 'escalationConfig'?: ApprovalConfigEscalationConfigV2026; - /** - * - * @type {ApprovalConfigTimeoutConfigV2026} - * @memberof ApprovalConfigV2026 - */ - 'timeoutConfig'?: ApprovalConfigTimeoutConfigV2026; - /** - * - * @type {ApprovalConfigCronTimezoneV2026} - * @memberof ApprovalConfigV2026 - */ - 'cronTimezone'?: ApprovalConfigCronTimezoneV2026; - /** - * If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. - * @type {Array} - * @memberof ApprovalConfigV2026 - */ - 'serialChain'?: Array; - /** - * Determines whether a comment is required when approving or rejecting the approval request. - * @type {string} - * @memberof ApprovalConfigV2026 - */ - 'requiresComment'?: ApprovalConfigV2026RequiresCommentV2026; - /** - * - * @type {ApprovalConfigFallbackApproverV2026} - * @memberof ApprovalConfigV2026 - */ - 'fallbackApprover'?: ApprovalConfigFallbackApproverV2026; - /** - * Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. - * @type {string} - * @memberof ApprovalConfigV2026 - */ - 'machineIdentityManagerAssignment'?: ApprovalConfigV2026MachineIdentityManagerAssignmentV2026; - /** - * When true, all approvals will be created with the status \"PASSED\". - * @type {boolean} - * @memberof ApprovalConfigV2026 - */ - 'circumventApprovalProcess'?: boolean; - /** - * OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. - * @type {string} - * @memberof ApprovalConfigV2026 - */ - 'autoApprove'?: ApprovalConfigV2026AutoApproveV2026; -} - -export const ApprovalConfigV2026RequiresCommentV2026 = { - Approval: 'APPROVAL', - Rejection: 'REJECTION', - All: 'ALL', - Off: 'OFF' -} as const; - -export type ApprovalConfigV2026RequiresCommentV2026 = typeof ApprovalConfigV2026RequiresCommentV2026[keyof typeof ApprovalConfigV2026RequiresCommentV2026]; -export const ApprovalConfigV2026MachineIdentityManagerAssignmentV2026 = { - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - AccountOwner: 'ACCOUNT_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER' -} as const; - -export type ApprovalConfigV2026MachineIdentityManagerAssignmentV2026 = typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026[keyof typeof ApprovalConfigV2026MachineIdentityManagerAssignmentV2026]; -export const ApprovalConfigV2026AutoApproveV2026 = { - Off: 'OFF', - Direct: 'DIRECT', - Indirect: 'INDIRECT' -} as const; - -export type ApprovalConfigV2026AutoApproveV2026 = typeof ApprovalConfigV2026AutoApproveV2026[keyof typeof ApprovalConfigV2026AutoApproveV2026]; - -/** - * The description of what the approval is asking for - * @export - * @interface ApprovalDescriptionV2026 - */ -export interface ApprovalDescriptionV2026 { - /** - * The description of what the approval is asking for - * @type {string} - * @memberof ApprovalDescriptionV2026 - */ - 'value'?: string; - /** - * What locale the description of the approval is using - * @type {string} - * @memberof ApprovalDescriptionV2026 - */ - 'locale'?: string; -} -/** - * Contains comprehensive details about the approval process, including the approver\'s information, comments, decision date, serial order, and the current status of the approval request. - * @export - * @interface ApprovalDetailsV2026 - */ -export interface ApprovalDetailsV2026 { - /** - * - * @type {ApproverDtoV2026} - * @memberof ApprovalDetailsV2026 - */ - 'approver'?: ApproverDtoV2026; - /** - * Comments added by approver while rejecting or approving the account deletion request. - * @type {string} - * @memberof ApprovalDetailsV2026 - */ - 'approverComments'?: string; - /** - * Decision date of approval rejected or approved. - * @type {string} - * @memberof ApprovalDetailsV2026 - */ - 'decisionDate'?: string; - /** - * SerialOrder of approval details. - * @type {number} - * @memberof ApprovalDetailsV2026 - */ - 'serialOrder'?: number; - /** - * - * @type {AccountRequestPhaseStateV2026} - * @memberof ApprovalDetailsV2026 - */ - 'status'?: AccountRequestPhaseStateV2026; -} - - -/** - * - * @export - * @interface ApprovalForwardHistoryV2026 - */ -export interface ApprovalForwardHistoryV2026 { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2026 - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2026 - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistoryV2026 - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistoryV2026 - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistoryV2026 - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentTypeV2026} - * @memberof ApprovalForwardHistoryV2026 - */ - 'reassignmentType'?: ReassignmentTypeV2026; -} - - -/** - * - * @export - * @interface ApprovalIdentityMembersInnerV2026 - */ -export interface ApprovalIdentityMembersInnerV2026 { - /** - * Email of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2026 - */ - 'email'?: string; - /** - * ID of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2026 - */ - 'id'?: string; - /** - * Name of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2026 - */ - 'name'?: string; - /** - * Type of the member. - * @type {string} - * @memberof ApprovalIdentityMembersInnerV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface ApprovalIdentityOwnerOfInnerV2026 - */ -export interface ApprovalIdentityOwnerOfInnerV2026 { - /** - * ID of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2026 - */ - 'id'?: string; - /** - * Name of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2026 - */ - 'name'?: string; - /** - * Type of the object that is owned. - * @type {string} - * @memberof ApprovalIdentityOwnerOfInnerV2026 - */ - 'type'?: string; -} -/** - * Identity Record Object - * @export - * @interface ApprovalIdentityRecordV2026 - */ -export interface ApprovalIdentityRecordV2026 { - /** - * Identity ID. - * @type {string} - * @memberof ApprovalIdentityRecordV2026 - */ - 'identityID'?: string; - /** - * Type of identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2026 - */ - 'type'?: ApprovalIdentityRecordV2026TypeV2026; - /** - * Name of the identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2026 - */ - 'name'?: string; - /** - * List of references representing actions taken by the identity. - * @type {Array} - * @memberof ApprovalIdentityRecordV2026 - */ - 'actionedAs'?: Array; - /** - * List of references representing members of the identity. - * @type {Array} - * @memberof ApprovalIdentityRecordV2026 - */ - 'members'?: Array; - /** - * Date when the decision was made. - * @type {string} - * @memberof ApprovalIdentityRecordV2026 - */ - 'decisionDate'?: string; - /** - * Email associated with the identity. - * @type {string} - * @memberof ApprovalIdentityRecordV2026 - */ - 'email'?: string; -} - -export const ApprovalIdentityRecordV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalIdentityRecordV2026TypeV2026 = typeof ApprovalIdentityRecordV2026TypeV2026[keyof typeof ApprovalIdentityRecordV2026TypeV2026]; - -/** - * Approval Identity Object - * @export - * @interface ApprovalIdentityV2026 - */ -export interface ApprovalIdentityV2026 { - /** - * Email address. - * @type {string} - * @memberof ApprovalIdentityV2026 - */ - 'email'?: string; - /** - * Identity ID of the type of identity defined in the \'type\' field. - * @type {string} - * @memberof ApprovalIdentityV2026 - */ - 'identityID'?: string; - /** - * List of members of a governance group. Will be omitted if the identity is not a governance group. - * @type {Array} - * @memberof ApprovalIdentityV2026 - */ - 'members'?: Array; - /** - * Name of the identity. - * @type {string} - * @memberof ApprovalIdentityV2026 - */ - 'name'?: string; - /** - * List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. - * @type {Array} - * @memberof ApprovalIdentityV2026 - */ - 'ownerOf'?: Array; - /** - * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalIdentityV2026 - */ - 'serialOrder'?: number; - /** - * Type of identityID. - * @type {string} - * @memberof ApprovalIdentityV2026 - */ - 'type'?: ApprovalIdentityV2026TypeV2026; -} - -export const ApprovalIdentityV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - ManagerOf: 'MANAGER_OF', - AccountOwner: 'ACCOUNT_OWNER', - MachineAccountOwner: 'MACHINE_ACCOUNT_OWNER', - MachineIdentityOwner: 'MACHINE_IDENTITY_OWNER', - ManagerOfRequestedTargetOwner: 'MANAGER_OF_REQUESTED_TARGET_OWNER', - ManagerOfMachineIdentityOwner: 'MANAGER_OF_MACHINE_IDENTITY_OWNER', - ManagerOfAccountOwner: 'MANAGER_OF_ACCOUNT_OWNER', - ManagerOfMachineAccountOwner: 'MANAGER_OF_MACHINE_ACCOUNT_OWNER', - ManagerOfRequester: 'MANAGER_OF_REQUESTER', - ManagerOfRequesterOwner: 'MANAGER_OF_REQUESTER_OWNER', - ManagerOfOwner: 'MANAGER_OF_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - ApplicationOwner: 'APPLICATION_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - RoleOwner: 'ROLE_OWNER', - SourceOwner: 'SOURCE_OWNER', - RequestedTargetOwner: 'REQUESTED_TARGET_OWNER', - AccessProfilePrimaryOwner: 'ACCESS_PROFILE_PRIMARY_OWNER', - ApplicationPrimaryOwner: 'APPLICATION_PRIMARY_OWNER', - EntitlementPrimaryOwner: 'ENTITLEMENT_PRIMARY_OWNER', - RolePrimaryOwner: 'ROLE_PRIMARY_OWNER', - SourcePrimaryOwner: 'SOURCE_PRIMARY_OWNER', - RequestedTargetPrimaryOwner: 'REQUESTED_TARGET_PRIMARY_OWNER', - AccessProfileSecondaryOwnerGroup: 'ACCESS_PROFILE_SECONDARY_OWNER_GROUP', - ApplicationSecondaryOwnerGroup: 'APPLICATION_SECONDARY_OWNER_GROUP', - EntitlementSecondaryOwnerGroup: 'ENTITLEMENT_SECONDARY_OWNER_GROUP', - RoleSecondaryOwnerGroup: 'ROLE_SECONDARY_OWNER_GROUP', - SourceSecondaryOwnerGroup: 'SOURCE_SECONDARY_OWNER_GROUP', - RequestedTargetSecondaryOwnerGroup: 'REQUESTED_TARGET_SECONDARY_OWNER_GROUP', - AccessProfileAllOwnerGroup: 'ACCESS_PROFILE_ALL_OWNER_GROUP', - ApplicationAllOwnerGroup: 'APPLICATION_ALL_OWNER_GROUP', - EntitlementAllOwnerGroup: 'ENTITLEMENT_ALL_OWNER_GROUP', - RoleAllOwnerGroup: 'ROLE_ALL_OWNER_GROUP', - SourceAllOwnerGroup: 'SOURCE_ALL_OWNER_GROUP', - RequestedTargetAllOwnerGroup: 'REQUESTED_TARGET_ALL_OWNER_GROUP' -} as const; - -export type ApprovalIdentityV2026TypeV2026 = typeof ApprovalIdentityV2026TypeV2026[keyof typeof ApprovalIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface ApprovalInfoResponseV2026 - */ -export interface ApprovalInfoResponseV2026 { - /** - * the id of approver - * @type {string} - * @memberof ApprovalInfoResponseV2026 - */ - 'id'?: string; - /** - * the name of approver - * @type {string} - * @memberof ApprovalInfoResponseV2026 - */ - 'name'?: string; - /** - * the status of the approval request - * @type {string} - * @memberof ApprovalInfoResponseV2026 - */ - 'status'?: string; -} -/** - * - * @export - * @interface ApprovalItemDetailsV2026 - */ -export interface ApprovalItemDetailsV2026 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemDetailsV2026 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2026 & object} - * @memberof ApprovalItemDetailsV2026 - */ - 'state'?: WorkItemStateV2026 & object; -} -/** - * - * @export - * @interface ApprovalItemsV2026 - */ -export interface ApprovalItemsV2026 { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemsV2026 - */ - 'value'?: string | null; - /** - * - * @type {WorkItemStateV2026 & object} - * @memberof ApprovalItemsV2026 - */ - 'state'?: WorkItemStateV2026 & object; -} -/** - * Approval Name Object - * @export - * @interface ApprovalNameV2026 - */ -export interface ApprovalNameV2026 { - /** - * Name of the approval - * @type {string} - * @memberof ApprovalNameV2026 - */ - 'value'?: string; - /** - * What locale the name of the approval is using - * @type {string} - * @memberof ApprovalNameV2026 - */ - 'locale'?: string; -} -/** - * Request body for reassigning an approval request to another identity. This results in that identity being added as an authorized approver. - * @export - * @interface ApprovalReassignRequestV2026 - */ -export interface ApprovalReassignRequestV2026 { - /** - * Comment associated with the reassign request. - * @type {string} - * @memberof ApprovalReassignRequestV2026 - */ - 'comment'?: string; - /** - * Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user\'s identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. - * @type {string} - * @memberof ApprovalReassignRequestV2026 - */ - 'reassignFrom'?: string; - /** - * Identity to which the approval is being reassigned. - * @type {string} - * @memberof ApprovalReassignRequestV2026 - */ - 'reassignTo'?: string; -} -/** - * ReassignmentHistoryRecord holds a history record of reassignment and escalation actions for an approval request - * @export - * @interface ApprovalReassignmentHistoryV2026 - */ -export interface ApprovalReassignmentHistoryV2026 { - /** - * Unique identifier for the comment associated with the reassignment. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'commentID'?: string; - /** - * - * @type {ApprovalIdentityV2026} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'reassignedFrom'?: ApprovalIdentityV2026; - /** - * - * @type {ApprovalIdentityV2026} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'reassignedTo'?: ApprovalIdentityV2026; - /** - * - * @type {ApprovalIdentityV2026} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'reassigner'?: ApprovalIdentityV2026; - /** - * Date and time when the reassignment occurred. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'reassignmentDate'?: string; - /** - * Type of reassignment, such as escalation or manual reassignment. - * @type {string} - * @memberof ApprovalReassignmentHistoryV2026 - */ - 'reassignmentType'?: ApprovalReassignmentHistoryV2026ReassignmentTypeV2026; -} - -export const ApprovalReassignmentHistoryV2026ReassignmentTypeV2026 = { - Escalation: 'ESCALATION', - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutoReassignment: 'AUTO_REASSIGNMENT' -} as const; - -export type ApprovalReassignmentHistoryV2026ReassignmentTypeV2026 = typeof ApprovalReassignmentHistoryV2026ReassignmentTypeV2026[keyof typeof ApprovalReassignmentHistoryV2026ReassignmentTypeV2026]; - -/** - * Reference objects related to the approval - * @export - * @interface ApprovalReferenceV2026 - */ -export interface ApprovalReferenceV2026 { - /** - * Id of the reference object - * @type {string} - * @memberof ApprovalReferenceV2026 - */ - 'id'?: string; - /** - * What reference object does this ID correspond to - * @type {string} - * @memberof ApprovalReferenceV2026 - */ - 'type'?: string; - /** - * Name of the reference object - * @type {string} - * @memberof ApprovalReferenceV2026 - */ - 'name'?: string; - /** - * Email associated with the reference object - * @type {string} - * @memberof ApprovalReferenceV2026 - */ - 'email'?: string; - /** - * The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalReferenceV2026 - */ - 'serialOrder'?: number; -} -/** - * Request body for rejecting an approval request. - * @export - * @interface ApprovalRejectRequestV2026 - */ -export interface ApprovalRejectRequestV2026 { - /** - * Comment associated with the reject request. - * @type {string} - * @memberof ApprovalRejectRequestV2026 - */ - 'comment'?: string; -} -/** - * Represents a requested target in an approval process, including details such as ID, name, reauthentication requirements, and removal date. - * @export - * @interface ApprovalRequestedTargetV2026 - */ -export interface ApprovalRequestedTargetV2026 { - /** - * Signature required for forced authentication. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'forcedAuthSignature'?: string; - /** - * ID of the requested target. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'id'?: string; - /** - * Name of the requested target. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'name'?: string; - /** - * Indicates if reauthentication is required. - * @type {boolean} - * @memberof ApprovalRequestedTargetV2026 - */ - 'reauthRequired'?: boolean; - /** - * Date when the target will be removed. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'removalDate'?: string; - /** - * Type of the request. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'requestType'?: string; - /** - * Type of the target. - * @type {string} - * @memberof ApprovalRequestedTargetV2026 - */ - 'targetType'?: string; -} -/** - * - * @export - * @interface ApprovalSchemeForRoleV2026 - */ -export interface ApprovalSchemeForRoleV2026 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof ApprovalSchemeForRoleV2026 - */ - 'approverType'?: ApprovalSchemeForRoleV2026ApproverTypeV2026; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof ApprovalSchemeForRoleV2026 - */ - 'approverId'?: string | null; -} - -export const ApprovalSchemeForRoleV2026ApproverTypeV2026 = { - Owner: 'OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeForRoleV2026ApproverTypeV2026 = typeof ApprovalSchemeForRoleV2026ApproverTypeV2026[keyof typeof ApprovalSchemeForRoleV2026ApproverTypeV2026]; - -/** - * Describes the individual or group that is responsible for an approval step. - * @export - * @enum {string} - */ - -export const ApprovalSchemeV2026 = { - AppOwner: 'APP_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - RoleOwner: 'ROLE_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeV2026 = typeof ApprovalSchemeV2026[keyof typeof ApprovalSchemeV2026]; - - -/** - * - * @export - * @interface ApprovalStatusDtoCurrentOwnerV2026 - */ -export interface ApprovalStatusDtoCurrentOwnerV2026 { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2026 - */ - 'type'?: ApprovalStatusDtoCurrentOwnerV2026TypeV2026; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwnerV2026 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoCurrentOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoCurrentOwnerV2026TypeV2026 = typeof ApprovalStatusDtoCurrentOwnerV2026TypeV2026[keyof typeof ApprovalStatusDtoCurrentOwnerV2026TypeV2026]; - -/** - * Identity of orginal approval owner. - * @export - * @interface ApprovalStatusDtoOriginalOwnerV2026 - */ -export interface ApprovalStatusDtoOriginalOwnerV2026 { - /** - * DTO type of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2026 - */ - 'type'?: ApprovalStatusDtoOriginalOwnerV2026TypeV2026; - /** - * ID of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2026 - */ - 'id'?: string; - /** - * Display name of original approval owner. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwnerV2026 - */ - 'name'?: string; -} - -export const ApprovalStatusDtoOriginalOwnerV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoOriginalOwnerV2026TypeV2026 = typeof ApprovalStatusDtoOriginalOwnerV2026TypeV2026[keyof typeof ApprovalStatusDtoOriginalOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface ApprovalStatusDtoV2026 - */ -export interface ApprovalStatusDtoV2026 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDtoV2026 - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwnerV2026} - * @memberof ApprovalStatusDtoV2026 - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwnerV2026; - /** - * - * @type {ApprovalStatusDtoCurrentOwnerV2026} - * @memberof ApprovalStatusDtoV2026 - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwnerV2026; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDtoV2026 - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemStateV2026} - * @memberof ApprovalStatusDtoV2026 - */ - 'status'?: ManualWorkItemStateV2026; - /** - * - * @type {ApprovalSchemeV2026} - * @memberof ApprovalStatusDtoV2026 - */ - 'scheme'?: ApprovalSchemeV2026; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDtoV2026 - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDtoV2026 - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDtoV2026 - */ - 'removeDate'?: string | null; -} - - -/** - * Enum representing the non-employee request approval status - * @export - * @enum {string} - */ - -export const ApprovalStatusV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Pending: 'PENDING', - NotReady: 'NOT_READY', - Cancelled: 'CANCELLED' -} as const; - -export type ApprovalStatusV2026 = typeof ApprovalStatusV2026[keyof typeof ApprovalStatusV2026]; - - -/** - * - * @export - * @interface ApprovalSummaryV2026 - */ -export interface ApprovalSummaryV2026 { - /** - * The number of pending access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2026 - */ - 'pending'?: number; - /** - * The number of approved access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2026 - */ - 'approved'?: number; - /** - * The number of rejected access requests approvals. - * @type {number} - * @memberof ApprovalSummaryV2026 - */ - 'rejected'?: number; -} -/** - * Approval Object - * @export - * @interface ApprovalV2026 - */ -export interface ApprovalV2026 { - /** - * The Approval ID - * @type {string} - * @memberof ApprovalV2026 - */ - 'id'?: string; - /** - * The Tenant ID of the Approval - * @type {string} - * @memberof ApprovalV2026 - */ - 'tenantId'?: string; - /** - * The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL - * @type {string} - * @memberof ApprovalV2026 - */ - 'type'?: string; - /** - * Object representation of an approver of an approval - * @type {Array} - * @memberof ApprovalV2026 - */ - 'approvers'?: Array; - /** - * Date the approval was created - * @type {string} - * @memberof ApprovalV2026 - */ - 'createdDate'?: string; - /** - * Date the approval is due - * @type {string} - * @memberof ApprovalV2026 - */ - 'dueDate'?: string; - /** - * Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. - * @type {string} - * @memberof ApprovalV2026 - */ - 'escalationStep'?: string; - /** - * The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. - * @type {number} - * @memberof ApprovalV2026 - */ - 'serialStep'?: number; - /** - * Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. - * @type {boolean} - * @memberof ApprovalV2026 - */ - 'isEscalated'?: boolean; - /** - * The name of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2026 - */ - 'name'?: Array; - /** - * The name of the approval for a given locale - * @type {ApprovalBatchV2026} - * @memberof ApprovalV2026 - */ - 'batchRequest'?: ApprovalBatchV2026; - /** - * The configuration of the approval, such as the approval criteria and whether it is a parallel or serial approval - * @type {ApprovalConfigV2026} - * @memberof ApprovalV2026 - */ - 'approvalConfig'?: ApprovalConfigV2026; - /** - * The description of the approval for a given locale - * @type {Array} - * @memberof ApprovalV2026 - */ - 'description'?: Array; - /** - * Signifies what medium to use when sending notifications (currently only email is utilized) - * @type {string} - * @memberof ApprovalV2026 - */ - 'medium'?: ApprovalV2026MediumV2026; - /** - * The priority of the approval - * @type {string} - * @memberof ApprovalV2026 - */ - 'priority'?: ApprovalV2026PriorityV2026; - /** - * Object representation of the requester of the approval - * @type {ApprovalIdentityV2026} - * @memberof ApprovalV2026 - */ - 'requester'?: ApprovalIdentityV2026; - /** - * Object representation of the requestee of the approval - * @type {ApprovalIdentityV2026} - * @memberof ApprovalV2026 - */ - 'requestee'?: ApprovalIdentityV2026; - /** - * Object representation of a comment on the approval - * @type {Array} - * @memberof ApprovalV2026 - */ - 'comments'?: Array; - /** - * Array of approvers who have approved the approval - * @type {Array} - * @memberof ApprovalV2026 - */ - 'approvedBy'?: Array; - /** - * Array of approvers who have rejected the approval - * @type {Array} - * @memberof ApprovalV2026 - */ - 'rejectedBy'?: Array; - /** - * Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. - * @type {Array} - * @memberof ApprovalV2026 - */ - 'assignedTo'?: Array; - /** - * Date the approval was completed - * @type {string} - * @memberof ApprovalV2026 - */ - 'completedDate'?: string; - /** - * - * @type {ApprovalApprovalCriteriaV2026} - * @memberof ApprovalV2026 - */ - 'approvalCriteria'?: ApprovalApprovalCriteriaV2026; - /** - * Json string representing additional attributes known about the object to be approved. - * @type {string} - * @memberof ApprovalV2026 - */ - 'additionalAttributes'?: string; - /** - * Reference data related to the approval - * @type {Array} - * @memberof ApprovalV2026 - */ - 'referenceData'?: Array; - /** - * History of whom the approval request was assigned to - * @type {Array} - * @memberof ApprovalV2026 - */ - 'reassignmentHistory'?: Array; - /** - * Field that can include any static additional info that may be needed by the service that the approval request originated from - * @type {{ [key: string]: object; }} - * @memberof ApprovalV2026 - */ - 'staticAttributes'?: { [key: string]: object; }; - /** - * Date/time that the approval request was last updated - * @type {string} - * @memberof ApprovalV2026 - */ - 'modifiedDate'?: string; - /** - * RequestedTarget used to specify the actual object or target the approval request is for - * @type {Array} - * @memberof ApprovalV2026 - */ - 'requestedTarget'?: Array; -} - -export const ApprovalV2026MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type ApprovalV2026MediumV2026 = typeof ApprovalV2026MediumV2026[keyof typeof ApprovalV2026MediumV2026]; -export const ApprovalV2026PriorityV2026 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type ApprovalV2026PriorityV2026 = typeof ApprovalV2026PriorityV2026[keyof typeof ApprovalV2026PriorityV2026]; - -/** - * Contains detailed information about the approver, including their identity, contact details, type, and references to related identities such as owners, actioned identities, and members. - * @export - * @interface ApproverDtoV2026 - */ -export interface ApproverDtoV2026 { - /** - * Identity ID and it cannot be null. - * @type {string} - * @memberof ApproverDtoV2026 - */ - 'identityID'?: string; - /** - * Optional id - * @type {string} - * @memberof ApproverDtoV2026 - */ - 'id'?: string | null; - /** - * Identity display name - * @type {string} - * @memberof ApproverDtoV2026 - */ - 'name'?: string; - /** - * Email address of identity - * @type {string} - * @memberof ApproverDtoV2026 - */ - 'email'?: string; - /** - * Used to mention type of data transfer object in this case it is used to transfer IDENTITY data. - * @type {string} - * @memberof ApproverDtoV2026 - */ - 'type'?: string; - /** - * List of reference of identity type dto for account owner identities - * @type {Array} - * @memberof ApproverDtoV2026 - */ - 'ownerOf'?: Array | null; - /** - * List of reference of identity type dto who acted on behalf of other identities. - * @type {Array} - * @memberof ApproverDtoV2026 - */ - 'actionedAs'?: Array | null; - /** - * List of reference of identity type dto for member identities. - * @type {Array} - * @memberof ApproverDtoV2026 - */ - 'members'?: Array | null; -} -/** - * - * @export - * @interface ApproverReferenceV2026 - */ -export interface ApproverReferenceV2026 { - /** - * Id of supported DtoType like IDENTITY, MACHINE_IDENTITY etc. - * @type {string} - * @memberof ApproverReferenceV2026 - */ - 'id'?: string; - /** - * Type of Dto - * @type {string} - * @memberof ApproverReferenceV2026 - */ - 'type'?: string; - /** - * Display name of DtoType like IDENTITY, MACHINE_IDENTITY etc - * @type {string} - * @memberof ApproverReferenceV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface ArgumentV2026 - */ -export interface ArgumentV2026 { - /** - * the name of the argument - * @type {string} - * @memberof ArgumentV2026 - */ - 'name': string; - /** - * the description of the argument - * @type {string} - * @memberof ArgumentV2026 - */ - 'description'?: string | null; - /** - * the programmatic type of the argument - * @type {string} - * @memberof ArgumentV2026 - */ - 'type'?: string | null; -} -/** - * - * @export - * @interface ArrayInner1V2026 - */ -export interface ArrayInner1V2026 { -} -/** - * - * @export - * @interface ArrayInnerV2026 - */ -export interface ArrayInnerV2026 { -} -/** - * - * @export - * @interface AssignResourceOwnerRequestV2026 - */ -export interface AssignResourceOwnerRequestV2026 { - /** - * The unique identifier of the application containing the resource. - * @type {number} - * @memberof AssignResourceOwnerRequestV2026 - */ - 'appId'?: number; - /** - * The full path to the resource within the application (e.g., file path or object path). - * @type {string} - * @memberof AssignResourceOwnerRequestV2026 - */ - 'fullPath'?: string | null; - /** - * The unique identifier (UUID) of the identity to be assigned as the resource owner. - * @type {string} - * @memberof AssignResourceOwnerRequestV2026 - */ - 'identityId'?: string; -} -/** - * - * @export - * @interface AssignmentContextDtoV2026 - */ -export interface AssignmentContextDtoV2026 { - /** - * - * @type {AccessRequestContextV2026} - * @memberof AssignmentContextDtoV2026 - */ - 'requested'?: AccessRequestContextV2026; - /** - * - * @type {Array} - * @memberof AssignmentContextDtoV2026 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof AssignmentContextDtoV2026 - */ - 'computedDate'?: string; -} -/** - * Specification of source attribute sync mapping configuration for an identity attribute - * @export - * @interface AttrSyncSourceAttributeConfigV2026 - */ -export interface AttrSyncSourceAttributeConfigV2026 { - /** - * Name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2026 - */ - 'name': string; - /** - * Display name of the identity attribute - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2026 - */ - 'displayName': string; - /** - * Determines whether or not the attribute is enabled for synchronization - * @type {boolean} - * @memberof AttrSyncSourceAttributeConfigV2026 - */ - 'enabled': boolean; - /** - * Name of the source account attribute to which the identity attribute value will be synchronized if enabled - * @type {string} - * @memberof AttrSyncSourceAttributeConfigV2026 - */ - 'target': string; -} -/** - * Specification of attribute sync configuration for a source - * @export - * @interface AttrSyncSourceConfigV2026 - */ -export interface AttrSyncSourceConfigV2026 { - /** - * - * @type {AttrSyncSourceV2026} - * @memberof AttrSyncSourceConfigV2026 - */ - 'source': AttrSyncSourceV2026; - /** - * Attribute synchronization configuration for specific identity attributes in the context of a source - * @type {Array} - * @memberof AttrSyncSourceConfigV2026 - */ - 'attributes': Array; -} -/** - * Target source for attribute synchronization. - * @export - * @interface AttrSyncSourceV2026 - */ -export interface AttrSyncSourceV2026 { - /** - * DTO type of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2026 - */ - 'type'?: AttrSyncSourceV2026TypeV2026; - /** - * ID of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2026 - */ - 'id'?: string; - /** - * Human-readable name of target source for attribute synchronization. - * @type {string} - * @memberof AttrSyncSourceV2026 - */ - 'name'?: string | null; -} - -export const AttrSyncSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type AttrSyncSourceV2026TypeV2026 = typeof AttrSyncSourceV2026TypeV2026[keyof typeof AttrSyncSourceV2026TypeV2026]; - -/** - * - * @export - * @interface AttributeChangeV2026 - */ -export interface AttributeChangeV2026 { - /** - * the attribute name - * @type {string} - * @memberof AttributeChangeV2026 - */ - 'name'?: string; - /** - * the old value of attribute - * @type {string} - * @memberof AttributeChangeV2026 - */ - 'previousValue'?: string; - /** - * the new value of attribute - * @type {string} - * @memberof AttributeChangeV2026 - */ - 'newValue'?: string; -} -/** - * - * @export - * @interface AttributeDTOListV2026 - */ -export interface AttributeDTOListV2026 { - /** - * - * @type {Array} - * @memberof AttributeDTOListV2026 - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface AttributeDTOV2026 - */ -export interface AttributeDTOV2026 { - /** - * Technical name of the Attribute. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeDTOV2026 - */ - 'key'?: string; - /** - * The display name of the key. - * @type {string} - * @memberof AttributeDTOV2026 - */ - 'name'?: string; - /** - * Indicates whether the attribute can have multiple values. - * @type {boolean} - * @memberof AttributeDTOV2026 - */ - 'multiselect'?: boolean; - /** - * The status of the Attribute. - * @type {string} - * @memberof AttributeDTOV2026 - */ - 'status'?: string; - /** - * The type of the Attribute. This can be either \"custom\" or \"governance\". - * @type {string} - * @memberof AttributeDTOV2026 - */ - 'type'?: string; - /** - * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. - * @type {Array} - * @memberof AttributeDTOV2026 - */ - 'objectTypes'?: Array | null; - /** - * The description of the Attribute. - * @type {string} - * @memberof AttributeDTOV2026 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof AttributeDTOV2026 - */ - 'values'?: Array | null; -} -/** - * A reference to the schema on the source to the attribute values map to. - * @export - * @interface AttributeDefinitionSchemaV2026 - */ -export interface AttributeDefinitionSchemaV2026 { - /** - * The type of object being referenced - * @type {string} - * @memberof AttributeDefinitionSchemaV2026 - */ - 'type'?: AttributeDefinitionSchemaV2026TypeV2026; - /** - * The object ID this reference applies to. - * @type {string} - * @memberof AttributeDefinitionSchemaV2026 - */ - 'id'?: string; - /** - * The human-readable display name of the object. - * @type {string} - * @memberof AttributeDefinitionSchemaV2026 - */ - 'name'?: string; -} - -export const AttributeDefinitionSchemaV2026TypeV2026 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type AttributeDefinitionSchemaV2026TypeV2026 = typeof AttributeDefinitionSchemaV2026TypeV2026[keyof typeof AttributeDefinitionSchemaV2026TypeV2026]; - -/** - * The underlying type of the value which an AttributeDefinition represents. - * @export - * @enum {string} - */ - -export const AttributeDefinitionTypeV2026 = { - String: 'STRING', - Long: 'LONG', - Int: 'INT', - Boolean: 'BOOLEAN', - Date: 'DATE' -} as const; - -export type AttributeDefinitionTypeV2026 = typeof AttributeDefinitionTypeV2026[keyof typeof AttributeDefinitionTypeV2026]; - - -/** - * - * @export - * @interface AttributeDefinitionV2026 - */ -export interface AttributeDefinitionV2026 { - /** - * The name of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2026 - */ - 'name'?: string; - /** - * Attribute name in the native system. - * @type {string} - * @memberof AttributeDefinitionV2026 - */ - 'nativeName'?: string | null; - /** - * - * @type {AttributeDefinitionTypeV2026} - * @memberof AttributeDefinitionV2026 - */ - 'type'?: AttributeDefinitionTypeV2026; - /** - * - * @type {AttributeDefinitionSchemaV2026} - * @memberof AttributeDefinitionV2026 - */ - 'schema'?: AttributeDefinitionSchemaV2026 | null; - /** - * A human-readable description of the attribute. - * @type {string} - * @memberof AttributeDefinitionV2026 - */ - 'description'?: string; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof AttributeDefinitionV2026 - */ - 'isMulti'?: boolean; - /** - * Flag indicating whether or not the attribute is an entitlement. - * @type {boolean} - * @memberof AttributeDefinitionV2026 - */ - 'isEntitlement'?: boolean; - /** - * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - * @type {boolean} - * @memberof AttributeDefinitionV2026 - */ - 'isGroup'?: boolean; -} - - -/** - * Targeted Entity - * @export - * @interface AttributeMappingsAllOfTargetV2026 - */ -export interface AttributeMappingsAllOfTargetV2026 { - /** - * The type of target entity - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2026 - */ - 'type'?: AttributeMappingsAllOfTargetV2026TypeV2026; - /** - * Name of the targeted attribute - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2026 - */ - 'attributeName'?: string; - /** - * The ID of Source - * @type {string} - * @memberof AttributeMappingsAllOfTargetV2026 - */ - 'sourceId'?: string; -} - -export const AttributeMappingsAllOfTargetV2026TypeV2026 = { - Account: 'ACCOUNT', - Identity: 'IDENTITY', - OwnerAccount: 'OWNER_ACCOUNT', - OwnerIdentity: 'OWNER_IDENTITY' -} as const; - -export type AttributeMappingsAllOfTargetV2026TypeV2026 = typeof AttributeMappingsAllOfTargetV2026TypeV2026[keyof typeof AttributeMappingsAllOfTargetV2026TypeV2026]; - -/** - * Attibute Mapping Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026 { - /** - * The name of attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026 - */ - 'attributeName'?: string; - /** - * Name of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026 - */ - 'sourceName'?: string; - /** - * ID of the Source - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026 - */ - 'name'?: string; -} -/** - * Input Object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2026 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesInputV2026 { - /** - * The Type of Attribute - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2026 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesInputV2026 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributesV2026; -} -/** - * attributes object - * @export - * @interface AttributeMappingsAllOfTransformDefinitionAttributesV2026 - */ -export interface AttributeMappingsAllOfTransformDefinitionAttributesV2026 { - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesInputV2026} - * @memberof AttributeMappingsAllOfTransformDefinitionAttributesV2026 - */ - 'input'?: AttributeMappingsAllOfTransformDefinitionAttributesInputV2026; -} -/** - * - * @export - * @interface AttributeMappingsAllOfTransformDefinitionV2026 - */ -export interface AttributeMappingsAllOfTransformDefinitionV2026 { - /** - * The type of transform - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2026 - */ - 'type'?: string; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionAttributesV2026} - * @memberof AttributeMappingsAllOfTransformDefinitionV2026 - */ - 'attributes'?: AttributeMappingsAllOfTransformDefinitionAttributesV2026; - /** - * Transform Operation - * @type {string} - * @memberof AttributeMappingsAllOfTransformDefinitionV2026 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AttributeMappingsV2026 - */ -export interface AttributeMappingsV2026 { - /** - * - * @type {AttributeMappingsAllOfTargetV2026} - * @memberof AttributeMappingsV2026 - */ - 'target'?: AttributeMappingsAllOfTargetV2026; - /** - * - * @type {AttributeMappingsAllOfTransformDefinitionV2026} - * @memberof AttributeMappingsV2026 - */ - 'transformDefinition'?: AttributeMappingsAllOfTransformDefinitionV2026; -} -/** - * - * @export - * @interface AttributeRequestV2026 - */ -export interface AttributeRequestV2026 { - /** - * Attribute name. - * @type {string} - * @memberof AttributeRequestV2026 - */ - 'name'?: string; - /** - * Operation to perform on attribute. - * @type {string} - * @memberof AttributeRequestV2026 - */ - 'op'?: string; - /** - * - * @type {AttributeRequestValueV2026} - * @memberof AttributeRequestV2026 - */ - 'value'?: AttributeRequestValueV2026; -} -/** - * @type AttributeRequestValueV2026 - * Value of attribute. - * @export - */ -export type AttributeRequestValueV2026 = Array | string; - -/** - * - * @export - * @interface AttributeValueDTOV2026 - */ -export interface AttributeValueDTOV2026 { - /** - * Technical name of the Attribute value. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeValueDTOV2026 - */ - 'value'?: string; - /** - * The display name of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2026 - */ - 'name'?: string; - /** - * The status of the Attribute value. - * @type {string} - * @memberof AttributeValueDTOV2026 - */ - 'status'?: string; -} -/** - * - * @export - * @interface AttributesChangedV2026 - */ -export interface AttributesChangedV2026 { - /** - * - * @type {Array} - * @memberof AttributesChangedV2026 - */ - 'attributeChanges': Array; - /** - * the event type - * @type {string} - * @memberof AttributesChangedV2026 - */ - 'eventType'?: string; - /** - * the identity id - * @type {string} - * @memberof AttributesChangedV2026 - */ - 'identityId'?: string; - /** - * the date of event - * @type {string} - * @memberof AttributesChangedV2026 - */ - 'dateTime'?: string; -} -/** - * Audit details for the reassignment configuration of an identity - * @export - * @interface AuditDetailsV2026 - */ -export interface AuditDetailsV2026 { - /** - * Initial date and time when the record was created - * @type {string} - * @memberof AuditDetailsV2026 - */ - 'created'?: string; - /** - * - * @type {Identity1V2026} - * @memberof AuditDetailsV2026 - */ - 'createdBy'?: Identity1V2026; - /** - * Last modified date and time for the record - * @type {string} - * @memberof AuditDetailsV2026 - */ - 'modified'?: string; - /** - * - * @type {Identity1V2026} - * @memberof AuditDetailsV2026 - */ - 'modifiedBy'?: Identity1V2026; -} -/** - * - * @export - * @interface AuthProfileSummaryV2026 - */ -export interface AuthProfileSummaryV2026 { - /** - * Tenant name. - * @type {string} - * @memberof AuthProfileSummaryV2026 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthProfileSummaryV2026 - */ - 'id'?: string; -} -/** - * - * @export - * @interface AuthProfileV2026 - */ -export interface AuthProfileV2026 { - /** - * Authentication Profile name. - * @type {string} - * @memberof AuthProfileV2026 - */ - 'name'?: string; - /** - * Use it to block access from off network. - * @type {boolean} - * @memberof AuthProfileV2026 - */ - 'offNetwork'?: boolean; - /** - * Use it to block access from untrusted geoographies. - * @type {boolean} - * @memberof AuthProfileV2026 - */ - 'untrustedGeography'?: boolean; - /** - * Application ID. - * @type {string} - * @memberof AuthProfileV2026 - */ - 'applicationId'?: string | null; - /** - * Application name. - * @type {string} - * @memberof AuthProfileV2026 - */ - 'applicationName'?: string | null; - /** - * Type of the Authentication Profile. - * @type {string} - * @memberof AuthProfileV2026 - */ - 'type'?: AuthProfileV2026TypeV2026; - /** - * Use it to enable strong authentication. - * @type {boolean} - * @memberof AuthProfileV2026 - */ - 'strongAuthLogin'?: boolean; -} - -export const AuthProfileV2026TypeV2026 = { - Block: 'BLOCK', - Mfa: 'MFA', - NonPta: 'NON_PTA', - Pta: 'PTA' -} as const; - -export type AuthProfileV2026TypeV2026 = typeof AuthProfileV2026TypeV2026[keyof typeof AuthProfileV2026TypeV2026]; - -/** - * - * @export - * @interface AuthUserLevelsIdentityCountV2026 - */ -export interface AuthUserLevelsIdentityCountV2026 { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof AuthUserLevelsIdentityCountV2026 - */ - 'id'?: string; - /** - * Number of identities having this user level. - * @type {number} - * @memberof AuthUserLevelsIdentityCountV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface AuthUserSlimResponseV2026 - */ -export interface AuthUserSlimResponseV2026 { - /** - * Identity ID. - * @type {string} - * @memberof AuthUserSlimResponseV2026 - */ - 'id'?: string; - /** - * Identity unique identifier. - * @type {string} - * @memberof AuthUserSlimResponseV2026 - */ - 'uid'?: string; - /** - * Identity alias. - * @type {string} - * @memberof AuthUserSlimResponseV2026 - */ - 'alias'?: string; - /** - * Identity name in display format. - * @type {string} - * @memberof AuthUserSlimResponseV2026 - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface AuthUserV2026 - */ -export interface AuthUserV2026 { - /** - * Tenant name. - * @type {string} - * @memberof AuthUserV2026 - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthUserV2026 - */ - 'id'?: string; - /** - * Identity\'s unique identitifier. - * @type {string} - * @memberof AuthUserV2026 - */ - 'uid'?: string; - /** - * ID of the auth profile associated with the auth user. - * @type {string} - * @memberof AuthUserV2026 - */ - 'profile'?: string; - /** - * Auth user\'s employee number. - * @type {string} - * @memberof AuthUserV2026 - */ - 'identificationNumber'?: string | null; - /** - * Auth user\'s email. - * @type {string} - * @memberof AuthUserV2026 - */ - 'email'?: string | null; - /** - * Auth user\'s phone number. - * @type {string} - * @memberof AuthUserV2026 - */ - 'phone'?: string | null; - /** - * Auth user\'s work phone number. - * @type {string} - * @memberof AuthUserV2026 - */ - 'workPhone'?: string | null; - /** - * Auth user\'s personal email. - * @type {string} - * @memberof AuthUserV2026 - */ - 'personalEmail'?: string | null; - /** - * Auth user\'s first name. - * @type {string} - * @memberof AuthUserV2026 - */ - 'firstname'?: string | null; - /** - * Auth user\'s last name. - * @type {string} - * @memberof AuthUserV2026 - */ - 'lastname'?: string | null; - /** - * Auth user\'s name in displayed format. - * @type {string} - * @memberof AuthUserV2026 - */ - 'displayName'?: string; - /** - * Auth user\'s alias. - * @type {string} - * @memberof AuthUserV2026 - */ - 'alias'?: string; - /** - * Date of last password change. - * @type {string} - * @memberof AuthUserV2026 - */ - 'lastPasswordChangeDate'?: string | null; - /** - * Timestamp of the last login (long type value). - * @type {number} - * @memberof AuthUserV2026 - */ - 'lastLoginTimestamp'?: number; - /** - * Timestamp of the current login (long type value). - * @type {number} - * @memberof AuthUserV2026 - */ - 'currentLoginTimestamp'?: number; - /** - * The date and time when the user was last unlocked. - * @type {string} - * @memberof AuthUserV2026 - */ - 'lastUnlockTimestamp'?: string | null; - /** - * Array of the auth user\'s capabilities. - * @type {Array} - * @memberof AuthUserV2026 - */ - 'capabilities'?: Array | null; -} - -export const AuthUserV2026CapabilitiesV2026 = { - CertAdmin: 'CERT_ADMIN', - CloudGovAdmin: 'CLOUD_GOV_ADMIN', - CloudGovUser: 'CLOUD_GOV_USER', - Helpdesk: 'HELPDESK', - Internal: 'INTERNAL', - OrgAdmin: 'ORG_ADMIN', - PolicyAdmin: 'POLICY_ADMIN', - ReportAdmin: 'REPORT_ADMIN', - RoleAdmin: 'ROLE_ADMIN', - RoleSubadmin: 'ROLE_SUBADMIN', - SaasManagementAdmin: 'SAAS_MANAGEMENT_ADMIN', - SaasManagementReader: 'SAAS_MANAGEMENT_READER', - SourceAdmin: 'SOURCE_ADMIN', - SourceSubadmin: 'SOURCE_SUBADMIN', - DasUiAdministrator: 'das:ui-administrator', - DasUiComplianceManager: 'das:ui-compliance_manager', - DasUiAuditor: 'das:ui-auditor', - DasUiDataScope: 'das:ui-data-scope', - SpAicDashboardRead: 'sp:aic-dashboard-read', - SpAicDashboardWrite: 'sp:aic-dashboard-write', - SpUiConfigHubAdmin: 'sp:ui-config-hub-admin', - SpUiConfigHubBackupAdmin: 'sp:ui-config-hub-backup-admin', - SpUiConfigHubRead: 'sp:ui-config-hub-read' -} as const; - -export type AuthUserV2026CapabilitiesV2026 = typeof AuthUserV2026CapabilitiesV2026[keyof typeof AuthUserV2026CapabilitiesV2026]; - -/** - * Authorization scheme supported by the transmitter. - * @export - * @interface AuthorizationSchemeV2026 - */ -export interface AuthorizationSchemeV2026 { - /** - * URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`. - * @type {string} - * @memberof AuthorizationSchemeV2026 - */ - 'spec_urn'?: string; -} -/** - * Patch operation for Auto-Write Setting - * @export - * @interface AutoWriteSettingPatchV2026 - */ -export interface AutoWriteSettingPatchV2026 { - /** - * The operation to perform. Only \"replace\" is supported. - * @type {string} - * @memberof AutoWriteSettingPatchV2026 - */ - 'op': AutoWriteSettingPatchV2026OpV2026; - /** - * The field to update. Allowed values: /enabled, /includedSourceIds, /excludedSourceIds - * @type {string} - * @memberof AutoWriteSettingPatchV2026 - */ - 'path': string; - /** - * - * @type {AutoWriteSettingPatchValueV2026} - * @memberof AutoWriteSettingPatchV2026 - */ - 'value': AutoWriteSettingPatchValueV2026; -} - -export const AutoWriteSettingPatchV2026OpV2026 = { - Replace: 'replace' -} as const; - -export type AutoWriteSettingPatchV2026OpV2026 = typeof AutoWriteSettingPatchV2026OpV2026[keyof typeof AutoWriteSettingPatchV2026OpV2026]; - -/** - * @type AutoWriteSettingPatchValueV2026 - * The new value for the field - * @export - */ -export type AutoWriteSettingPatchValueV2026 = Array | boolean; - -/** - * Auto-Write Setting response with timestamps - * @export - * @interface AutoWriteSettingResponseV2026 - */ -export interface AutoWriteSettingResponseV2026 { - /** - * Whether auto-write is currently enabled for the tenant - * @type {boolean} - * @memberof AutoWriteSettingResponseV2026 - */ - 'enabled'?: boolean; - /** - * Source IDs in the allowlist. Empty array means not in allowlist mode. - * @type {Array} - * @memberof AutoWriteSettingResponseV2026 - */ - 'includedSourceIds'?: Array | null; - /** - * Source IDs to exclude from auto-write. Always applied. - * @type {Array} - * @memberof AutoWriteSettingResponseV2026 - */ - 'excludedSourceIds'?: Array | null; - /** - * When settings were first created - * @type {string} - * @memberof AutoWriteSettingResponseV2026 - */ - 'createdAt'?: string; - /** - * When settings were last modified - * @type {string} - * @memberof AutoWriteSettingResponseV2026 - */ - 'updatedAt'?: string; -} -/** - * Auto-Write Setting for SED - * @export - * @interface AutoWriteSettingV2026 - */ -export interface AutoWriteSettingV2026 { - /** - * Whether auto-write is currently enabled for the tenant - * @type {boolean} - * @memberof AutoWriteSettingV2026 - */ - 'enabled'?: boolean; - /** - * Source IDs in the allowlist. Empty array means not in allowlist mode. - * @type {Array} - * @memberof AutoWriteSettingV2026 - */ - 'includedSourceIds'?: Array | null; - /** - * Source IDs to exclude from auto-write. Always applied. - * @type {Array} - * @memberof AutoWriteSettingV2026 - */ - 'excludedSourceIds'?: Array | null; -} -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptions1V2026 - */ -export interface BackupOptions1V2026 { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptions1V2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNamesV2026; }} - * @memberof BackupOptions1V2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNamesV2026; }; -} - -export const BackupOptions1V2026IncludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptions1V2026IncludeTypesV2026 = typeof BackupOptions1V2026IncludeTypesV2026[keyof typeof BackupOptions1V2026IncludeTypesV2026]; - -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptionsV2026 - */ -export interface BackupOptionsV2026 { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptionsV2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNamesV2026; }} - * @memberof BackupOptionsV2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNamesV2026; }; -} - -export const BackupOptionsV2026IncludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptionsV2026IncludeTypesV2026 = typeof BackupOptionsV2026IncludeTypesV2026[keyof typeof BackupOptionsV2026IncludeTypesV2026]; - -/** - * - * @export - * @interface BackupResponse1V2026 - */ -export interface BackupResponse1V2026 { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'status'?: BackupResponse1V2026StatusV2026; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'type'?: BackupResponse1V2026TypeV2026; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponse1V2026 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponse1V2026 - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponse1V2026 - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'backupType'?: BackupResponse1V2026BackupTypeV2026; - /** - * - * @type {BackupOptions1V2026} - * @memberof BackupResponse1V2026 - */ - 'options'?: BackupOptions1V2026 | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'hydrationStatus'?: BackupResponse1V2026HydrationStatusV2026; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponse1V2026 - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponse1V2026 - */ - 'cloudStorageStatus'?: BackupResponse1V2026CloudStorageStatusV2026; -} - -export const BackupResponse1V2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponse1V2026StatusV2026 = typeof BackupResponse1V2026StatusV2026[keyof typeof BackupResponse1V2026StatusV2026]; -export const BackupResponse1V2026TypeV2026 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponse1V2026TypeV2026 = typeof BackupResponse1V2026TypeV2026[keyof typeof BackupResponse1V2026TypeV2026]; -export const BackupResponse1V2026BackupTypeV2026 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponse1V2026BackupTypeV2026 = typeof BackupResponse1V2026BackupTypeV2026[keyof typeof BackupResponse1V2026BackupTypeV2026]; -export const BackupResponse1V2026HydrationStatusV2026 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponse1V2026HydrationStatusV2026 = typeof BackupResponse1V2026HydrationStatusV2026[keyof typeof BackupResponse1V2026HydrationStatusV2026]; -export const BackupResponse1V2026CloudStorageStatusV2026 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponse1V2026CloudStorageStatusV2026 = typeof BackupResponse1V2026CloudStorageStatusV2026[keyof typeof BackupResponse1V2026CloudStorageStatusV2026]; - -/** - * - * @export - * @interface BackupResponseV2026 - */ -export interface BackupResponseV2026 { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'status'?: BackupResponseV2026StatusV2026; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'type'?: BackupResponseV2026TypeV2026; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponseV2026 - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponseV2026 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponseV2026 - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponseV2026 - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'backupType'?: BackupResponseV2026BackupTypeV2026; - /** - * - * @type {BackupOptionsV2026} - * @memberof BackupResponseV2026 - */ - 'options'?: BackupOptionsV2026 | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'hydrationStatus'?: BackupResponseV2026HydrationStatusV2026; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponseV2026 - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponseV2026 - */ - 'cloudStorageStatus'?: BackupResponseV2026CloudStorageStatusV2026; -} - -export const BackupResponseV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponseV2026StatusV2026 = typeof BackupResponseV2026StatusV2026[keyof typeof BackupResponseV2026StatusV2026]; -export const BackupResponseV2026TypeV2026 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponseV2026TypeV2026 = typeof BackupResponseV2026TypeV2026[keyof typeof BackupResponseV2026TypeV2026]; -export const BackupResponseV2026BackupTypeV2026 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponseV2026BackupTypeV2026 = typeof BackupResponseV2026BackupTypeV2026[keyof typeof BackupResponseV2026BackupTypeV2026]; -export const BackupResponseV2026HydrationStatusV2026 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponseV2026HydrationStatusV2026 = typeof BackupResponseV2026HydrationStatusV2026[keyof typeof BackupResponseV2026HydrationStatusV2026]; -export const BackupResponseV2026CloudStorageStatusV2026 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponseV2026CloudStorageStatusV2026 = typeof BackupResponseV2026CloudStorageStatusV2026[keyof typeof BackupResponseV2026CloudStorageStatusV2026]; - -/** - * - * @export - * @interface Base64DecodeV2026 - */ -export interface Base64DecodeV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64DecodeV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64DecodeV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Base64EncodeV2026 - */ -export interface Base64EncodeV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64EncodeV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64EncodeV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Owner\'s identity. - * @export - * @interface BaseAccessOwnerV2026 - */ -export interface BaseAccessOwnerV2026 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof BaseAccessOwnerV2026 - */ - 'type'?: BaseAccessOwnerV2026TypeV2026; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof BaseAccessOwnerV2026 - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof BaseAccessOwnerV2026 - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof BaseAccessOwnerV2026 - */ - 'email'?: string; -} - -export const BaseAccessOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type BaseAccessOwnerV2026TypeV2026 = typeof BaseAccessOwnerV2026TypeV2026[keyof typeof BaseAccessOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface BaseAccessProfileV2026 - */ -export interface BaseAccessProfileV2026 { - /** - * Access profile\'s unique ID. - * @type {string} - * @memberof BaseAccessProfileV2026 - */ - 'id'?: string; - /** - * Access profile\'s display name. - * @type {string} - * @memberof BaseAccessProfileV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseAccessV2026 - */ -export interface BaseAccessV2026 { - /** - * Access item\'s description. - * @type {string} - * @memberof BaseAccessV2026 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccessV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof BaseAccessV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof BaseAccessV2026 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof BaseAccessV2026 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof BaseAccessV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof BaseAccessV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2026} - * @memberof BaseAccessV2026 - */ - 'owner'?: BaseAccessOwnerV2026; -} -/** - * - * @export - * @interface BaseAccountV2026 - */ -export interface BaseAccountV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof BaseAccountV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseAccountV2026 - */ - 'name'?: string; - /** - * Account ID. - * @type {string} - * @memberof BaseAccountV2026 - */ - 'accountId'?: string; - /** - * - * @type {AccountSourceV2026} - * @memberof BaseAccountV2026 - */ - 'source'?: AccountSourceV2026; - /** - * Indicates whether the account is disabled. - * @type {boolean} - * @memberof BaseAccountV2026 - */ - 'disabled'?: boolean; - /** - * Indicates whether the account is locked. - * @type {boolean} - * @memberof BaseAccountV2026 - */ - 'locked'?: boolean; - /** - * Indicates whether the account is privileged. - * @type {boolean} - * @memberof BaseAccountV2026 - */ - 'privileged'?: boolean; - /** - * Indicates whether the account has been manually correlated to an identity. - * @type {boolean} - * @memberof BaseAccountV2026 - */ - 'manuallyCorrelated'?: boolean; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof BaseAccountV2026 - */ - 'passwordLastSet'?: string | null; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2026 - */ - 'entitlementAttributes'?: { [key: string]: any; } | null; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccountV2026 - */ - 'created'?: string | null; - /** - * Indicates whether the account supports password change. - * @type {boolean} - * @memberof BaseAccountV2026 - */ - 'supportsPasswordChange'?: boolean; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccountV2026 - */ - 'accountAttributes'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface BaseCommonDtoV2026 - */ -export interface BaseCommonDtoV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDtoV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDtoV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDtoV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDtoV2026 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseCreateApplicationRequestV2026 - */ -export interface BaseCreateApplicationRequestV2026 { - /** - * - * @type {ApplicationTypeV2026} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'applicationType': ApplicationTypeV2026; - /** - * The display name of the application. - * @type {string} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'name': string; - /** - * A brief description of the application and its purpose. - * @type {string} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'description'?: string | null; - /** - * A list of tags to categorize or identify the application. - * @type {Array} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'tags'?: Array | null; - /** - * The unique identifier for the identity collector associated with this application. - * @type {number} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'identityCollectorId'?: number | null; - /** - * The unique identifier for the AD identity collector. - * @type {number} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'adIdentityCollectorId'?: number | null; - /** - * The unique identifier for the NIS identity collector. - * @type {number} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'nisIdentityCollectorId'?: number | null; - /** - * - * @type {ApplicationCrawlerSettingsV2026} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'applicationCrawlerSettings'?: ApplicationCrawlerSettingsV2026; - /** - * - * @type {PermissionCollectorSettingsV2026} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'permissionCollectorSettings'?: PermissionCollectorSettingsV2026; - /** - * - * @type {DataClassificationSettingsV2026} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'dataClassificationSettings'?: DataClassificationSettingsV2026; - /** - * - * @type {ActivityConfigurationSettingsV2026} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'activityConfigurationSettings'?: ActivityConfigurationSettingsV2026; - /** - * If true, the application setup will be executed immediately after creation. - * @type {boolean} - * @memberof BaseCreateApplicationRequestV2026 - */ - 'executeNow'?: boolean; -} - - -/** - * - * @export - * @interface BaseDocumentV2026 - */ -export interface BaseDocumentV2026 { - /** - * ID of the referenced object. - * @type {string} - * @memberof BaseDocumentV2026 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseDocumentV2026 - */ - 'name': string; -} -/** - * - * @export - * @interface BaseEntitlementV2026 - */ -export interface BaseEntitlementV2026 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof BaseEntitlementV2026 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof BaseEntitlementV2026 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof BaseEntitlementV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseReferenceDtoV2026 - */ -export interface BaseReferenceDtoV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof BaseReferenceDtoV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDtoV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface BaseSegmentV2026 - */ -export interface BaseSegmentV2026 { - /** - * Segment\'s unique ID. - * @type {string} - * @memberof BaseSegmentV2026 - */ - 'id'?: string; - /** - * Segment\'s display name. - * @type {string} - * @memberof BaseSegmentV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseSettingsV2026 - */ -export interface BaseSettingsV2026 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof BaseSettingsV2026 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof BaseSettingsV2026 - */ - 'clusterId'?: string | null; -} -/** - * Config required if BASIC_AUTH is used. - * @export - * @interface BasicAuthConfigV2026 - */ -export interface BasicAuthConfigV2026 { - /** - * The username to authenticate. - * @type {string} - * @memberof BasicAuthConfigV2026 - */ - 'userName'?: string; - /** - * The password to authenticate. On response, this field is set to null as to not return secrets. - * @type {string} - * @memberof BasicAuthConfigV2026 - */ - 'password'?: string | null; -} -/** - * Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. - * @export - * @interface BearerTokenAuthConfigV2026 - */ -export interface BearerTokenAuthConfigV2026 { - /** - * Bearer token - * @type {string} - * @memberof BearerTokenAuthConfigV2026 - */ - 'bearerToken'?: string | null; -} -/** - * Before Provisioning Rule. - * @export - * @interface BeforeProvisioningRuleDtoV2026 - */ -export interface BeforeProvisioningRuleDtoV2026 { - /** - * Before Provisioning Rule DTO type. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2026 - */ - 'type'?: BeforeProvisioningRuleDtoV2026TypeV2026; - /** - * Before Provisioning Rule ID. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2026 - */ - 'id'?: string; - /** - * Rule display name. - * @type {string} - * @memberof BeforeProvisioningRuleDtoV2026 - */ - 'name'?: string; -} - -export const BeforeProvisioningRuleDtoV2026TypeV2026 = { - Rule: 'RULE' -} as const; - -export type BeforeProvisioningRuleDtoV2026TypeV2026 = typeof BeforeProvisioningRuleDtoV2026TypeV2026[keyof typeof BeforeProvisioningRuleDtoV2026TypeV2026]; - -/** - * - * @export - * @interface BoundV2026 - */ -export interface BoundV2026 { - /** - * The value of the range\'s endpoint. - * @type {string} - * @memberof BoundV2026 - */ - 'value': string; - /** - * Indicates if the endpoint is included in the range. - * @type {boolean} - * @memberof BoundV2026 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface BrandingItemCreateV2026 - */ -export interface BrandingItemCreateV2026 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'name': string; - /** - * product name - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'productName': string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'actionButtonColor'?: string; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'activeLinkColor'?: string; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'navigationColor'?: string; - /** - * email from address - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'emailFromAddress'?: string; - /** - * login information message - * @type {string} - * @memberof BrandingItemCreateV2026 - */ - 'loginInformationalMessage'?: string; - /** - * png file with logo - * @type {File} - * @memberof BrandingItemCreateV2026 - */ - 'fileStandard'?: File; -} -/** - * - * @export - * @interface BrandingItemV2026 - */ -export interface BrandingItemV2026 { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemV2026 - */ - 'name'?: string; - /** - * product name - * @type {string} - * @memberof BrandingItemV2026 - */ - 'productName'?: string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemV2026 - */ - 'actionButtonColor'?: string | null; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemV2026 - */ - 'activeLinkColor'?: string | null; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemV2026 - */ - 'navigationColor'?: string | null; - /** - * email from address - * @type {string} - * @memberof BrandingItemV2026 - */ - 'emailFromAddress'?: string | null; - /** - * url to standard logo - * @type {string} - * @memberof BrandingItemV2026 - */ - 'standardLogoURL'?: string | null; - /** - * login information message - * @type {string} - * @memberof BrandingItemV2026 - */ - 'loginInformationalMessage'?: string | null; -} -/** - * The bucket to group the results of the aggregation query by. - * @export - * @interface BucketAggregationV2026 - */ -export interface BucketAggregationV2026 { - /** - * The name of the bucket aggregate to be included in the result. - * @type {string} - * @memberof BucketAggregationV2026 - */ - 'name': string; - /** - * - * @type {BucketTypeV2026} - * @memberof BucketAggregationV2026 - */ - 'type'?: BucketTypeV2026; - /** - * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof BucketAggregationV2026 - */ - 'field': string; - /** - * Maximum number of buckets to include. - * @type {number} - * @memberof BucketAggregationV2026 - */ - 'size'?: number; - /** - * Minimum number of documents a bucket should have. - * @type {number} - * @memberof BucketAggregationV2026 - */ - 'minDocCount'?: number; -} - - -/** - * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const BucketTypeV2026 = { - Terms: 'TERMS' -} as const; - -export type BucketTypeV2026 = typeof BucketTypeV2026[keyof typeof BucketTypeV2026]; - - -/** - * - * @export - * @interface BulkAddTaggedObjectV2026 - */ -export interface BulkAddTaggedObjectV2026 { - /** - * - * @type {Array} - * @memberof BulkAddTaggedObjectV2026 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkAddTaggedObjectV2026 - */ - 'tags'?: Array; - /** - * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - * @type {string} - * @memberof BulkAddTaggedObjectV2026 - */ - 'operation'?: BulkAddTaggedObjectV2026OperationV2026; -} - -export const BulkAddTaggedObjectV2026OperationV2026 = { - Append: 'APPEND', - Merge: 'MERGE' -} as const; - -export type BulkAddTaggedObjectV2026OperationV2026 = typeof BulkAddTaggedObjectV2026OperationV2026[keyof typeof BulkAddTaggedObjectV2026OperationV2026]; - -/** - * Request body payload for bulk approve access request endpoint. - * @export - * @interface BulkApproveAccessRequestV2026 - */ -export interface BulkApproveAccessRequestV2026 { - /** - * List of approval ids to approve the pending requests - * @type {Array} - * @memberof BulkApproveAccessRequestV2026 - */ - 'approvalIds': Array; - /** - * Reason for approving the pending access request. - * @type {string} - * @memberof BulkApproveAccessRequestV2026 - */ - 'comment': string; -} -/** - * A single item in a bulk entitlement recommendation approval request. The recordType is optional; the backend resolves the type by ID lookup when omitted. Description applies to SED items only; privilegeLevel is required for privilege items. - * @export - * @interface BulkApproveEntitlementRecommendationItemV2026 - */ -export interface BulkApproveEntitlementRecommendationItemV2026 { - /** - * The unique identifier of the recommendation record to approve. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationItemV2026 - */ - 'id': string; - /** - * The type of the recommendation. When omitted, the backend resolves the type by looking up the ID. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationItemV2026 - */ - 'recordType'?: BulkApproveEntitlementRecommendationItemV2026RecordTypeV2026 | null; - /** - * The approved description text. Required for SED-type items; ignored for privilege items. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationItemV2026 - */ - 'description'?: string | null; - /** - * The approved privilege level. Required for privilege-type items; ignored for SED items. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationItemV2026 - */ - 'privilegeLevel'?: string | null; -} - -export const BulkApproveEntitlementRecommendationItemV2026RecordTypeV2026 = { - Sed: 'SED', - Privilege: 'privilege' -} as const; - -export type BulkApproveEntitlementRecommendationItemV2026RecordTypeV2026 = typeof BulkApproveEntitlementRecommendationItemV2026RecordTypeV2026[keyof typeof BulkApproveEntitlementRecommendationItemV2026RecordTypeV2026]; - -/** - * Request body for bulk-approving a set of entitlement recommendations. - * @export - * @interface BulkApproveEntitlementRecommendationRequestV2026 - */ -export interface BulkApproveEntitlementRecommendationRequestV2026 { - /** - * The list of recommendation items to approve. - * @type {Array} - * @memberof BulkApproveEntitlementRecommendationRequestV2026 - */ - 'items': Array; -} -/** - * The result for a single item in a bulk entitlement recommendation approval response. - * @export - * @interface BulkApproveEntitlementRecommendationResultV2026 - */ -export interface BulkApproveEntitlementRecommendationResultV2026 { - /** - * The unique identifier of the processed recommendation record. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationResultV2026 - */ - 'id'?: string; - /** - * The outcome of the approval for this item. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationResultV2026 - */ - 'status'?: BulkApproveEntitlementRecommendationResultV2026StatusV2026; - /** - * The reason for failure if status is FAILURE; null on success. - * @type {string} - * @memberof BulkApproveEntitlementRecommendationResultV2026 - */ - 'failedReason'?: string | null; -} - -export const BulkApproveEntitlementRecommendationResultV2026StatusV2026 = { - Success: 'SUCCESS', - Failure: 'FAILURE' -} as const; - -export type BulkApproveEntitlementRecommendationResultV2026StatusV2026 = typeof BulkApproveEntitlementRecommendationResultV2026StatusV2026[keyof typeof BulkApproveEntitlementRecommendationResultV2026StatusV2026]; - -/** - * BulkApproveRequestDTO is the input struct that represents the request body required to facilitate a bulk approval action for a set of generic approval requests. - * @export - * @interface BulkApproveRequestDTOV2026 - */ -export interface BulkApproveRequestDTOV2026 { - /** - * Array of Approval IDs to be bulk approved - * @type {Array} - * @memberof BulkApproveRequestDTOV2026 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk approval request - * @type {string} - * @memberof BulkApproveRequestDTOV2026 - */ - 'comment'?: string; - /** - * Additional attributes to include with the bulk approval request - * @type {{ [key: string]: object; }} - * @memberof BulkApproveRequestDTOV2026 - */ - 'additionalAttributes'?: { [key: string]: object; }; -} -/** - * Request body payload for bulk cancel access request endpoint. - * @export - * @interface BulkCancelAccessRequestV2026 - */ -export interface BulkCancelAccessRequestV2026 { - /** - * List of access requests ids to cancel the pending requests - * @type {Array} - * @memberof BulkCancelAccessRequestV2026 - */ - 'accessRequestIds': Array; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof BulkCancelAccessRequestV2026 - */ - 'comment': string; -} -/** - * BulkCancelRequestDTO is the input struct that represents the request body required to facilitate a bulk cancellation action for a set of generic approval requests. - * @export - * @interface BulkCancelRequestDTOV2026 - */ -export interface BulkCancelRequestDTOV2026 { - /** - * Array of Approval IDs to be bulk cancelled - * @type {Array} - * @memberof BulkCancelRequestDTOV2026 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk cancellation request - * @type {string} - * @memberof BulkCancelRequestDTOV2026 - */ - 'comment'?: string; -} -/** - * Bulk response object. - * @export - * @interface BulkIdentitiesAccountsResponseV2026 - */ -export interface BulkIdentitiesAccountsResponseV2026 { - /** - * Identifier of bulk request item. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2026 - */ - 'id'?: string; - /** - * Response status value. - * @type {number} - * @memberof BulkIdentitiesAccountsResponseV2026 - */ - 'statusCode'?: number; - /** - * Status containing additional context information about failures. - * @type {string} - * @memberof BulkIdentitiesAccountsResponseV2026 - */ - 'message'?: string; -} -/** - * BulkReassignRequestDTO is the input struct that represents the request body required to facilitate a bulk reassignment action for a set of generic approval requests. - * @export - * @interface BulkReassignRequestDTOV2026 - */ -export interface BulkReassignRequestDTOV2026 { - /** - * Array of Approval IDs to be bulk reassigned - * @type {Array} - * @memberof BulkReassignRequestDTOV2026 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk reassignment request - * @type {string} - * @memberof BulkReassignRequestDTOV2026 - */ - 'comment'?: string; - /** - * Identity ID from which the approval requests are being reassigned - * @type {string} - * @memberof BulkReassignRequestDTOV2026 - */ - 'reassignFrom'?: string; - /** - * ReassignTo signifies the Identity ID that the approval request is being reassigned to - * @type {string} - * @memberof BulkReassignRequestDTOV2026 - */ - 'reassignTo'?: string; -} -/** - * BulkRejectRequestDTO is the input struct that represents the request body required to facilitate a bulk reject action for a set of generic approval requests. - * @export - * @interface BulkRejectRequestDTOV2026 - */ -export interface BulkRejectRequestDTOV2026 { - /** - * Array of Approval IDs to be bulk rejected - * @type {Array} - * @memberof BulkRejectRequestDTOV2026 - */ - 'approvalIds'?: Array; - /** - * Optional comment to include with the bulk reject request - * @type {string} - * @memberof BulkRejectRequestDTOV2026 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface BulkRemoveTaggedObjectV2026 - */ -export interface BulkRemoveTaggedObjectV2026 { - /** - * - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2026 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkRemoveTaggedObjectV2026 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface BulkTaggedObjectResponseV2026 - */ -export interface BulkTaggedObjectResponseV2026 { - /** - * - * @type {Array} - * @memberof BulkTaggedObjectResponseV2026 - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkTaggedObjectResponseV2026 - */ - 'tags'?: Array; -} -/** - * Specifies the type of business service or resource. Possible values include: 0 - Folder 1 - Computer 2 - Container 3 - Domain 4 - Group / GPO 5 - OrganizationalUnit 6 - User 7 - Document 8 - List / WindowsFileServer / SharepointOnline 9 - ListItem 10 - Site 11 - Unknown / DropboxUser 12 - WSSFolder 13 - Web 14 - ExchangeFolder 15 - Mailbox 16 - PublicFolder 18 - UserSAMAccountName 24 - (reserved) 25 - GroupPolicyContainer 30 - File 801 - WindowsClusterServerName 908 - GoogleFolder 909 - GoogleUser 910 - DropboxFolder 912 - BoxFolder 913 - BoxUser 914 - BoxFile 950 - WSSFile 951 - HiddenList 952 - HiddenWSSFolder 953 - HiddenWSSFile 1000 - BuiltinDomain 1100 - DfsNamespace 1101 - DfsLink 1200 - SqlServerInstance 1201 - SqlServerDatabase 1202 - SqlServerSchema 1203 - SqlServerTable 1204 - SqlServerView 1205 - SqlServerStoredProcedure 1206 - SqlServerFunction 1207 - SqlServerAssemblie 1208 - SqlServerType 1209 - SqlServerDatabaseRole 1210 - SqlServerDatabaseUser 1211 - SqlServerApplicationRole 1212 - SqlServerLogin 1213 - SqlServerServerRole 1214 - SqlServerVirtualContainer 1215 - SqlServerSynonym 1216 - SqlServerExtendedStoredProcedure 1300 - AwsS3Root 1301 - AwsS3OU 1302 - AwsS3Account 1303 - AwsS3Bucket 1304 - AwsS3Folder 1305 - AwsS3File 1400 - SnowflakeDatabase 1401 - SnowflakeSchema 1402 - SnowflakeTable 1403 - SnowflakeView 1404 - SnowflakeFunction 1405 - SnowflakeProcedure 1406 - SnowflakeVirtualContainer 1407 - SnowflakeDatabaseApplication 1408 - SnowflakeDatabaseApplicationPackage 1409 - SnowflakeDatabasePersonal 1410 - SnowflakeDatabaseImported 1411 - SnowflakeViewMaterialized - * @export - * @enum {number} - */ - -export const BusinessServiceTypeV2026 = { - NUMBER_0: 0, - NUMBER_1: 1, - NUMBER_2: 2, - NUMBER_3: 3, - NUMBER_4: 4, - NUMBER_5: 5, - NUMBER_6: 6, - NUMBER_7: 7, - NUMBER_8: 8, - NUMBER_9: 9, - NUMBER_10: 10, - NUMBER_11: 11, - NUMBER_12: 12, - NUMBER_13: 13, - NUMBER_14: 14, - NUMBER_15: 15, - NUMBER_16: 16, - NUMBER_18: 18, - NUMBER_24: 24, - NUMBER_25: 25, - NUMBER_30: 30, - NUMBER_801: 801, - NUMBER_908: 908, - NUMBER_909: 909, - NUMBER_910: 910, - NUMBER_912: 912, - NUMBER_913: 913, - NUMBER_914: 914, - NUMBER_950: 950, - NUMBER_951: 951, - NUMBER_952: 952, - NUMBER_953: 953, - NUMBER_1000: 1000, - NUMBER_1100: 1100, - NUMBER_1101: 1101, - NUMBER_1200: 1200, - NUMBER_1201: 1201, - NUMBER_1202: 1202, - NUMBER_1203: 1203, - NUMBER_1204: 1204, - NUMBER_1205: 1205, - NUMBER_1206: 1206, - NUMBER_1207: 1207, - NUMBER_1208: 1208, - NUMBER_1209: 1209, - NUMBER_1210: 1210, - NUMBER_1211: 1211, - NUMBER_1212: 1212, - NUMBER_1213: 1213, - NUMBER_1214: 1214, - NUMBER_1215: 1215, - NUMBER_1216: 1216, - NUMBER_1300: 1300, - NUMBER_1301: 1301, - NUMBER_1302: 1302, - NUMBER_1303: 1303, - NUMBER_1304: 1304, - NUMBER_1305: 1305, - NUMBER_1400: 1400, - NUMBER_1401: 1401, - NUMBER_1402: 1402, - NUMBER_1403: 1403, - NUMBER_1404: 1404, - NUMBER_1405: 1405, - NUMBER_1406: 1406, - NUMBER_1407: 1407, - NUMBER_1408: 1408, - NUMBER_1409: 1409, - NUMBER_1410: 1410, - NUMBER_1411: 1411 -} as const; - -export type BusinessServiceTypeV2026 = typeof BusinessServiceTypeV2026[keyof typeof BusinessServiceTypeV2026]; - - -/** - * Details of the identity that owns the campaign. - * @export - * @interface CampaignActivatedCampaignCampaignOwnerV2026 - */ -export interface CampaignActivatedCampaignCampaignOwnerV2026 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2026 - */ - 'id': string; - /** - * The human friendly name of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2026 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignActivatedCampaignCampaignOwnerV2026 - */ - 'email': string; -} -/** - * Details about the certification campaign that was activated. - * @export - * @interface CampaignActivatedCampaignV2026 - */ -export interface CampaignActivatedCampaignV2026 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignActivatedCampaignV2026 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2026 - */ - 'type': CampaignActivatedCampaignV2026TypeV2026; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2026} - * @memberof CampaignActivatedCampaignV2026 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2026; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignActivatedCampaignV2026 - */ - 'status': CampaignActivatedCampaignV2026StatusV2026; -} - -export const CampaignActivatedCampaignV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignActivatedCampaignV2026TypeV2026 = typeof CampaignActivatedCampaignV2026TypeV2026[keyof typeof CampaignActivatedCampaignV2026TypeV2026]; -export const CampaignActivatedCampaignV2026StatusV2026 = { - Active: 'ACTIVE' -} as const; - -export type CampaignActivatedCampaignV2026StatusV2026 = typeof CampaignActivatedCampaignV2026StatusV2026[keyof typeof CampaignActivatedCampaignV2026StatusV2026]; - -/** - * - * @export - * @interface CampaignActivatedV2026 - */ -export interface CampaignActivatedV2026 { - /** - * - * @type {CampaignActivatedCampaignV2026} - * @memberof CampaignActivatedV2026 - */ - 'campaign': CampaignActivatedCampaignV2026; -} -/** - * - * @export - * @interface CampaignAlertV2026 - */ -export interface CampaignAlertV2026 { - /** - * Denotes the level of the message - * @type {string} - * @memberof CampaignAlertV2026 - */ - 'level'?: CampaignAlertV2026LevelV2026; - /** - * - * @type {Array} - * @memberof CampaignAlertV2026 - */ - 'localizations'?: Array; -} - -export const CampaignAlertV2026LevelV2026 = { - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO' -} as const; - -export type CampaignAlertV2026LevelV2026 = typeof CampaignAlertV2026LevelV2026[keyof typeof CampaignAlertV2026LevelV2026]; - -/** - * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - * @export - * @interface CampaignAllOfFilterV2026 - */ -export interface CampaignAllOfFilterV2026 { - /** - * The ID of whatever type of filter is being used. - * @type {string} - * @memberof CampaignAllOfFilterV2026 - */ - 'id'?: string; - /** - * Type of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2026 - */ - 'type'?: CampaignAllOfFilterV2026TypeV2026; - /** - * Name of the filter - * @type {string} - * @memberof CampaignAllOfFilterV2026 - */ - 'name'?: string; -} - -export const CampaignAllOfFilterV2026TypeV2026 = { - CampaignFilter: 'CAMPAIGN_FILTER' -} as const; - -export type CampaignAllOfFilterV2026TypeV2026 = typeof CampaignAllOfFilterV2026TypeV2026[keyof typeof CampaignAllOfFilterV2026TypeV2026]; - -/** - * Must be set only if the campaign type is MACHINE_ACCOUNT. - * @export - * @interface CampaignAllOfMachineAccountCampaignInfoV2026 - */ -export interface CampaignAllOfMachineAccountCampaignInfoV2026 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2026 - */ - 'sourceIds'?: Array; - /** - * The reviewer\'s type. - * @type {string} - * @memberof CampaignAllOfMachineAccountCampaignInfoV2026 - */ - 'reviewerType'?: CampaignAllOfMachineAccountCampaignInfoV2026ReviewerTypeV2026; -} - -export const CampaignAllOfMachineAccountCampaignInfoV2026ReviewerTypeV2026 = { - AccountOwner: 'ACCOUNT_OWNER' -} as const; - -export type CampaignAllOfMachineAccountCampaignInfoV2026ReviewerTypeV2026 = typeof CampaignAllOfMachineAccountCampaignInfoV2026ReviewerTypeV2026[keyof typeof CampaignAllOfMachineAccountCampaignInfoV2026ReviewerTypeV2026]; - -/** - * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026 { - /** - * Legal Remediator Type - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026 - */ - 'type': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026TypeV2026; - /** - * The ID of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026 - */ - 'id': string; - /** - * The name of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026TypeV2026 = typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026TypeV2026[keyof typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026TypeV2026]; - -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 - */ - 'type'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2026TypeV2026; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoReviewerV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoReviewerV2026TypeV2026 = typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2026TypeV2026[keyof typeof CampaignAllOfRoleCompositionCampaignInfoReviewerV2026TypeV2026]; - -/** - * Optional configuration options for role composition campaigns. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoV2026 - */ -export interface CampaignAllOfRoleCompositionCampaignInfoV2026 { - /** - * The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - * @deprecated - */ - 'reviewerId'?: string | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoReviewerV2026} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - */ - 'reviewer'?: CampaignAllOfRoleCompositionCampaignInfoReviewerV2026 | null; - /** - * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {Array} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - */ - 'roleIds'?: Array; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - */ - 'remediatorRef': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefV2026; - /** - * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - */ - 'query'?: string | null; - /** - * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoV2026 - */ - 'description'?: string | null; -} -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfSearchCampaignInfoReviewerV2026 - */ -export interface CampaignAllOfSearchCampaignInfoReviewerV2026 { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2026 - */ - 'type'?: CampaignAllOfSearchCampaignInfoReviewerV2026TypeV2026; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2026 - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewerV2026 - */ - 'name'?: string | null; -} - -export const CampaignAllOfSearchCampaignInfoReviewerV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfSearchCampaignInfoReviewerV2026TypeV2026 = typeof CampaignAllOfSearchCampaignInfoReviewerV2026TypeV2026[keyof typeof CampaignAllOfSearchCampaignInfoReviewerV2026TypeV2026]; - -/** - * Must be set only if the campaign type is SEARCH. - * @export - * @interface CampaignAllOfSearchCampaignInfoV2026 - */ -export interface CampaignAllOfSearchCampaignInfoV2026 { - /** - * The type of search campaign represented. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'type': CampaignAllOfSearchCampaignInfoV2026TypeV2026; - /** - * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'description'?: string; - /** - * - * @type {CampaignAllOfSearchCampaignInfoReviewerV2026} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'reviewer'?: CampaignAllOfSearchCampaignInfoReviewerV2026 | null; - /** - * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'query'?: string | null; - /** - * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'identityIds'?: Array | null; - /** - * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfoV2026 - */ - 'accessConstraints'?: Array; -} - -export const CampaignAllOfSearchCampaignInfoV2026TypeV2026 = { - Identity: 'IDENTITY', - Access: 'ACCESS' -} as const; - -export type CampaignAllOfSearchCampaignInfoV2026TypeV2026 = typeof CampaignAllOfSearchCampaignInfoV2026TypeV2026[keyof typeof CampaignAllOfSearchCampaignInfoV2026TypeV2026]; - -/** - * Must be set only if the campaign type is SOURCE_OWNER. - * @export - * @interface CampaignAllOfSourceOwnerCampaignInfoV2026 - */ -export interface CampaignAllOfSourceOwnerCampaignInfoV2026 { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfSourceOwnerCampaignInfoV2026 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface CampaignAllOfSourcesWithOrphanEntitlementsV2026 - */ -export interface CampaignAllOfSourcesWithOrphanEntitlementsV2026 { - /** - * Id of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2026 - */ - 'id'?: string; - /** - * Type - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2026 - */ - 'type'?: CampaignAllOfSourcesWithOrphanEntitlementsV2026TypeV2026; - /** - * Name of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlementsV2026 - */ - 'name'?: string; -} - -export const CampaignAllOfSourcesWithOrphanEntitlementsV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type CampaignAllOfSourcesWithOrphanEntitlementsV2026TypeV2026 = typeof CampaignAllOfSourcesWithOrphanEntitlementsV2026TypeV2026[keyof typeof CampaignAllOfSourcesWithOrphanEntitlementsV2026TypeV2026]; - -/** - * - * @export - * @interface CampaignCompleteOptionsV2026 - */ -export interface CampaignCompleteOptionsV2026 { - /** - * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - * @type {string} - * @memberof CampaignCompleteOptionsV2026 - */ - 'autoCompleteAction'?: CampaignCompleteOptionsV2026AutoCompleteActionV2026; -} - -export const CampaignCompleteOptionsV2026AutoCompleteActionV2026 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CampaignCompleteOptionsV2026AutoCompleteActionV2026 = typeof CampaignCompleteOptionsV2026AutoCompleteActionV2026[keyof typeof CampaignCompleteOptionsV2026AutoCompleteActionV2026]; - -/** - * Details about the certification campaign that ended. - * @export - * @interface CampaignEndedCampaignV2026 - */ -export interface CampaignEndedCampaignV2026 { - /** - * Unique ID for the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'id': string; - /** - * The human friendly name of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'modified'?: string | null; - /** - * The date and time the campaign is due. - * @type {string} - * @memberof CampaignEndedCampaignV2026 - */ - 'deadline': string; - /** - * The type of campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2026 - */ - 'type': CampaignEndedCampaignV2026TypeV2026; - /** - * - * @type {CampaignActivatedCampaignCampaignOwnerV2026} - * @memberof CampaignEndedCampaignV2026 - */ - 'campaignOwner': CampaignActivatedCampaignCampaignOwnerV2026; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignEndedCampaignV2026 - */ - 'status': CampaignEndedCampaignV2026StatusV2026; -} - -export const CampaignEndedCampaignV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignEndedCampaignV2026TypeV2026 = typeof CampaignEndedCampaignV2026TypeV2026[keyof typeof CampaignEndedCampaignV2026TypeV2026]; -export const CampaignEndedCampaignV2026StatusV2026 = { - Completed: 'COMPLETED' -} as const; - -export type CampaignEndedCampaignV2026StatusV2026 = typeof CampaignEndedCampaignV2026StatusV2026[keyof typeof CampaignEndedCampaignV2026StatusV2026]; - -/** - * - * @export - * @interface CampaignEndedV2026 - */ -export interface CampaignEndedV2026 { - /** - * - * @type {CampaignEndedCampaignV2026} - * @memberof CampaignEndedV2026 - */ - 'campaign': CampaignEndedCampaignV2026; -} -/** - * - * @export - * @interface CampaignFilterDetailsCriteriaListInnerV2026 - */ -export interface CampaignFilterDetailsCriteriaListInnerV2026 { - /** - * - * @type {CriteriaTypeV2026} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'type': CriteriaTypeV2026; - /** - * - * @type {OperationV2026} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'operation'?: OperationV2026 | null; - /** - * Specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'property': string | null; - /** - * Value for the specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'value': string | null; - /** - * If true, the filter will negate the result of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'negateResult'?: boolean; - /** - * If true, the filter will short circuit the evaluation of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'shortCircuit'?: boolean; - /** - * If true, the filter will record child matches for the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'recordChildMatches'?: boolean; - /** - * The unique ID of the criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'id'?: string | null; - /** - * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'suppressMatchedItems'?: boolean; - /** - * List of child criteria. - * @type {Array} - * @memberof CampaignFilterDetailsCriteriaListInnerV2026 - */ - 'children'?: Array; -} - - -/** - * Campaign Filter Details - * @export - * @interface CampaignFilterDetailsV2026 - */ -export interface CampaignFilterDetailsV2026 { - /** - * The unique ID of the campaign filter - * @type {string} - * @memberof CampaignFilterDetailsV2026 - */ - 'id': string; - /** - * Campaign filter name. - * @type {string} - * @memberof CampaignFilterDetailsV2026 - */ - 'name': string; - /** - * Campaign filter description. - * @type {string} - * @memberof CampaignFilterDetailsV2026 - */ - 'description'?: string; - /** - * Owner of the filter. This field automatically populates at creation time with the current user. - * @type {string} - * @memberof CampaignFilterDetailsV2026 - */ - 'owner': string | null; - /** - * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. - * @type {string} - * @memberof CampaignFilterDetailsV2026 - */ - 'mode': CampaignFilterDetailsV2026ModeV2026; - /** - * List of criteria. - * @type {Array} - * @memberof CampaignFilterDetailsV2026 - */ - 'criteriaList'?: Array; - /** - * If true, the filter is created by the system. If false, the filter is created by a user. - * @type {boolean} - * @memberof CampaignFilterDetailsV2026 - */ - 'isSystemFilter': boolean; -} - -export const CampaignFilterDetailsV2026ModeV2026 = { - Inclusion: 'INCLUSION', - Exclusion: 'EXCLUSION' -} as const; - -export type CampaignFilterDetailsV2026ModeV2026 = typeof CampaignFilterDetailsV2026ModeV2026[keyof typeof CampaignFilterDetailsV2026ModeV2026]; - -/** - * The identity that owns the campaign. - * @export - * @interface CampaignGeneratedCampaignCampaignOwnerV2026 - */ -export interface CampaignGeneratedCampaignCampaignOwnerV2026 { - /** - * The unique ID of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2026 - */ - 'id': string; - /** - * The display name of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2026 - */ - 'displayName': string; - /** - * The primary email address of the identity. - * @type {string} - * @memberof CampaignGeneratedCampaignCampaignOwnerV2026 - */ - 'email': string; -} -/** - * Details about the campaign that was generated. - * @export - * @interface CampaignGeneratedCampaignV2026 - */ -export interface CampaignGeneratedCampaignV2026 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'id': string; - /** - * Human friendly name of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'name': string; - /** - * Extended description of the campaign. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'description': string; - /** - * The date and time the campaign was created. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'created': string; - /** - * The date and time the campaign was last modified. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'modified'?: string | null; - /** - * The date and time when the campaign must be finished by. - * @type {string} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'deadline'?: string | null; - /** - * The type of campaign that was generated. - * @type {object} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'type': CampaignGeneratedCampaignV2026TypeV2026; - /** - * - * @type {CampaignGeneratedCampaignCampaignOwnerV2026} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'campaignOwner': CampaignGeneratedCampaignCampaignOwnerV2026; - /** - * The current status of the campaign. - * @type {object} - * @memberof CampaignGeneratedCampaignV2026 - */ - 'status': CampaignGeneratedCampaignV2026StatusV2026; -} - -export const CampaignGeneratedCampaignV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION' -} as const; - -export type CampaignGeneratedCampaignV2026TypeV2026 = typeof CampaignGeneratedCampaignV2026TypeV2026[keyof typeof CampaignGeneratedCampaignV2026TypeV2026]; -export const CampaignGeneratedCampaignV2026StatusV2026 = { - Staged: 'STAGED', - Activating: 'ACTIVATING', - Active: 'ACTIVE' -} as const; - -export type CampaignGeneratedCampaignV2026StatusV2026 = typeof CampaignGeneratedCampaignV2026StatusV2026[keyof typeof CampaignGeneratedCampaignV2026StatusV2026]; - -/** - * - * @export - * @interface CampaignGeneratedV2026 - */ -export interface CampaignGeneratedV2026 { - /** - * - * @type {CampaignGeneratedCampaignV2026} - * @memberof CampaignGeneratedV2026 - */ - 'campaign': CampaignGeneratedCampaignV2026; -} -/** - * - * @export - * @interface CampaignReferenceV2026 - */ -export interface CampaignReferenceV2026 { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'id': string; - /** - * The name of the campaign. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'name': string; - /** - * The type of object that is being referenced. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'type': CampaignReferenceV2026TypeV2026; - /** - * The type of the campaign. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'campaignType': CampaignReferenceV2026CampaignTypeV2026; - /** - * The description of the campaign set by the admin who created it. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'description': string | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'correlatedStatus': CampaignReferenceV2026CorrelatedStatusV2026; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignReferenceV2026 - */ - 'mandatoryCommentRequirement': CampaignReferenceV2026MandatoryCommentRequirementV2026; -} - -export const CampaignReferenceV2026TypeV2026 = { - Campaign: 'CAMPAIGN' -} as const; - -export type CampaignReferenceV2026TypeV2026 = typeof CampaignReferenceV2026TypeV2026[keyof typeof CampaignReferenceV2026TypeV2026]; -export const CampaignReferenceV2026CampaignTypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignReferenceV2026CampaignTypeV2026 = typeof CampaignReferenceV2026CampaignTypeV2026[keyof typeof CampaignReferenceV2026CampaignTypeV2026]; -export const CampaignReferenceV2026CorrelatedStatusV2026 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignReferenceV2026CorrelatedStatusV2026 = typeof CampaignReferenceV2026CorrelatedStatusV2026[keyof typeof CampaignReferenceV2026CorrelatedStatusV2026]; -export const CampaignReferenceV2026MandatoryCommentRequirementV2026 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignReferenceV2026MandatoryCommentRequirementV2026 = typeof CampaignReferenceV2026MandatoryCommentRequirementV2026[keyof typeof CampaignReferenceV2026MandatoryCommentRequirementV2026]; - -/** - * - * @export - * @interface CampaignReportV2026 - */ -export interface CampaignReportV2026 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof CampaignReportV2026 - */ - 'type'?: CampaignReportV2026TypeV2026; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof CampaignReportV2026 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof CampaignReportV2026 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof CampaignReportV2026 - */ - 'status'?: CampaignReportV2026StatusV2026; - /** - * - * @type {ReportTypeV2026} - * @memberof CampaignReportV2026 - */ - 'reportType': ReportTypeV2026; - /** - * The most recent date and time this report was run - * @type {string} - * @memberof CampaignReportV2026 - */ - 'lastRunAt'?: string; -} - -export const CampaignReportV2026TypeV2026 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type CampaignReportV2026TypeV2026 = typeof CampaignReportV2026TypeV2026[keyof typeof CampaignReportV2026TypeV2026]; -export const CampaignReportV2026StatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type CampaignReportV2026StatusV2026 = typeof CampaignReportV2026StatusV2026[keyof typeof CampaignReportV2026StatusV2026]; - -/** - * - * @export - * @interface CampaignReportsConfigV2026 - */ -export interface CampaignReportsConfigV2026 { - /** - * list of identity attribute columns - * @type {Array} - * @memberof CampaignReportsConfigV2026 - */ - 'identityAttributeColumns'?: Array | null; -} -/** - * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. - * @export - * @interface CampaignTemplateOwnerRefV2026 - */ -export interface CampaignTemplateOwnerRefV2026 { - /** - * Id of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2026 - */ - 'id'?: string; - /** - * Type of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2026 - */ - 'type'?: CampaignTemplateOwnerRefV2026TypeV2026; - /** - * Name of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2026 - */ - 'name'?: string; - /** - * Email of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRefV2026 - */ - 'email'?: string; -} - -export const CampaignTemplateOwnerRefV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignTemplateOwnerRefV2026TypeV2026 = typeof CampaignTemplateOwnerRefV2026TypeV2026[keyof typeof CampaignTemplateOwnerRefV2026TypeV2026]; - -/** - * Campaign Template - * @export - * @interface CampaignTemplateV2026 - */ -export interface CampaignTemplateV2026 { - /** - * Id of the campaign template - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'id'?: string; - /** - * This template\'s name. Has no bearing on generated campaigns\' names. - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'name': string; - /** - * This template\'s description. Has no bearing on generated campaigns\' descriptions. - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'description': string; - /** - * Creation date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'created': string; - /** - * Modification date of Campaign Template - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'modified': string | null; - /** - * Indicates if this campaign template has been scheduled. - * @type {boolean} - * @memberof CampaignTemplateV2026 - */ - 'scheduled'?: boolean; - /** - * - * @type {CampaignTemplateOwnerRefV2026} - * @memberof CampaignTemplateV2026 - */ - 'ownerRef'?: CampaignTemplateOwnerRefV2026; - /** - * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). - * @type {string} - * @memberof CampaignTemplateV2026 - */ - 'deadlineDuration'?: string | null; - /** - * - * @type {CampaignV2026} - * @memberof CampaignTemplateV2026 - */ - 'campaign': CampaignV2026; -} -/** - * - * @export - * @interface CampaignV2026 - */ -export interface CampaignV2026 { - /** - * Id of the campaign - * @type {string} - * @memberof CampaignV2026 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2026 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof CampaignV2026 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof CampaignV2026 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof CampaignV2026 - */ - 'type': CampaignV2026TypeV2026; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof CampaignV2026 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof CampaignV2026 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof CampaignV2026 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof CampaignV2026 - */ - 'status'?: CampaignV2026StatusV2026 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignV2026 - */ - 'correlatedStatus'?: CampaignV2026CorrelatedStatusV2026; - /** - * Created time of the campaign - * @type {string} - * @memberof CampaignV2026 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof CampaignV2026 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof CampaignV2026 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof CampaignV2026 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof CampaignV2026 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2026} - * @memberof CampaignV2026 - */ - 'filter'?: CampaignAllOfFilterV2026 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof CampaignV2026 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2026} - * @memberof CampaignV2026 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2026} - * @memberof CampaignV2026 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2026} - * @memberof CampaignV2026 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2026} - * @memberof CampaignV2026 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2026 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof CampaignV2026 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignV2026 - */ - 'mandatoryCommentRequirement'?: CampaignV2026MandatoryCommentRequirementV2026; -} - -export const CampaignV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignV2026TypeV2026 = typeof CampaignV2026TypeV2026[keyof typeof CampaignV2026TypeV2026]; -export const CampaignV2026StatusV2026 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type CampaignV2026StatusV2026 = typeof CampaignV2026StatusV2026[keyof typeof CampaignV2026StatusV2026]; -export const CampaignV2026CorrelatedStatusV2026 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignV2026CorrelatedStatusV2026 = typeof CampaignV2026CorrelatedStatusV2026[keyof typeof CampaignV2026CorrelatedStatusV2026]; -export const CampaignV2026MandatoryCommentRequirementV2026 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignV2026MandatoryCommentRequirementV2026 = typeof CampaignV2026MandatoryCommentRequirementV2026[keyof typeof CampaignV2026MandatoryCommentRequirementV2026]; - -/** - * - * @export - * @interface CampaignsDeleteRequestV2026 - */ -export interface CampaignsDeleteRequestV2026 { - /** - * The ids of the campaigns to delete - * @type {Array} - * @memberof CampaignsDeleteRequestV2026 - */ - 'ids'?: Array; -} -/** - * Request body payload for cancel access request endpoint. - * @export - * @interface CancelAccessRequestV2026 - */ -export interface CancelAccessRequestV2026 { - /** - * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - * @type {string} - * @memberof CancelAccessRequestV2026 - */ - 'accountActivityId': string; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof CancelAccessRequestV2026 - */ - 'comment': string; -} -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetailsV2026 - */ -export interface CancelledRequestDetailsV2026 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2026 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2026} - * @memberof CancelledRequestDetailsV2026 - */ - 'owner'?: OwnerDtoV2026; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetailsV2026 - */ - 'modified'?: string; -} -/** - * The decision to approve or revoke the review item - * @export - * @enum {string} - */ - -export const CertificationDecisionV2026 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CertificationDecisionV2026 = typeof CertificationDecisionV2026[keyof typeof CertificationDecisionV2026]; - - -/** - * - * @export - * @interface CertificationDtoV2026 - */ -export interface CertificationDtoV2026 { - /** - * - * @type {CampaignReferenceV2026} - * @memberof CertificationDtoV2026 - */ - 'campaignRef': CampaignReferenceV2026; - /** - * - * @type {CertificationPhaseV2026} - * @memberof CertificationDtoV2026 - */ - 'phase': CertificationPhaseV2026; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationDtoV2026 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationDtoV2026 - */ - 'signed': string; - /** - * - * @type {ReviewerV2026} - * @memberof CertificationDtoV2026 - */ - 'reviewer': ReviewerV2026; - /** - * - * @type {ReassignmentV2026} - * @memberof CertificationDtoV2026 - */ - 'reassignment'?: ReassignmentV2026 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationDtoV2026 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationDtoV2026 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationDtoV2026 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationDtoV2026 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationDtoV2026 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationDtoV2026 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationDtoV2026 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationIdentitySummaryV2026 - */ -export interface CertificationIdentitySummaryV2026 { - /** - * The ID of the identity summary - * @type {string} - * @memberof CertificationIdentitySummaryV2026 - */ - 'id'?: string; - /** - * Name of the linked identity - * @type {string} - * @memberof CertificationIdentitySummaryV2026 - */ - 'name'?: string; - /** - * The ID of the identity being certified - * @type {string} - * @memberof CertificationIdentitySummaryV2026 - */ - 'identityId'?: string; - /** - * Indicates whether the review items for the linked identity\'s certification have been completed - * @type {boolean} - * @memberof CertificationIdentitySummaryV2026 - */ - 'completed'?: boolean; -} -/** - * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - * @export - * @enum {string} - */ - -export const CertificationPhaseV2026 = { - Staged: 'STAGED', - Active: 'ACTIVE', - Signed: 'SIGNED' -} as const; - -export type CertificationPhaseV2026 = typeof CertificationPhaseV2026[keyof typeof CertificationPhaseV2026]; - - -/** - * - * @export - * @interface CertificationReferenceV2026 - */ -export interface CertificationReferenceV2026 { - /** - * The id of the certification. - * @type {string} - * @memberof CertificationReferenceV2026 - */ - 'id'?: string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationReferenceV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof CertificationReferenceV2026 - */ - 'type'?: CertificationReferenceV2026TypeV2026; - /** - * - * @type {ReviewerV2026} - * @memberof CertificationReferenceV2026 - */ - 'reviewer'?: ReviewerV2026; -} - -export const CertificationReferenceV2026TypeV2026 = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceV2026TypeV2026 = typeof CertificationReferenceV2026TypeV2026[keyof typeof CertificationReferenceV2026TypeV2026]; - -/** - * The certification campaign that was signed off on. - * @export - * @interface CertificationSignedOffCertificationV2026 - */ -export interface CertificationSignedOffCertificationV2026 { - /** - * Unique ID of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'id': string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'name': string; - /** - * The date and time the certification was created. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'created': string; - /** - * The date and time the certification was last modified. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignReferenceV2026} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'campaignRef': CampaignReferenceV2026; - /** - * - * @type {CertificationPhaseV2026} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'phase': CertificationPhaseV2026; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'due': string; - /** - * The date the reviewer signed off on the certification. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'signed': string; - /** - * - * @type {ReviewerV2026} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'reviewer': ReviewerV2026; - /** - * - * @type {ReassignmentV2026} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'reassignment'?: ReassignmentV2026 | null; - /** - * Indicates it the certification has any errors. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'hasErrors': boolean; - /** - * A message indicating what the error is. - * @type {string} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'errorMessage'?: string | null; - /** - * Indicates if all certification decisions have been made. - * @type {boolean} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'completed': boolean; - /** - * The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - * @type {number} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'decisionsMade': number; - /** - * The total number of approve/revoke/acknowledge decisions for the certification. - * @type {number} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'decisionsTotal': number; - /** - * The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'entitiesCompleted': number; - /** - * The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - * @type {number} - * @memberof CertificationSignedOffCertificationV2026 - */ - 'entitiesTotal': number; -} - - -/** - * - * @export - * @interface CertificationSignedOffV2026 - */ -export interface CertificationSignedOffV2026 { - /** - * - * @type {CertificationSignedOffCertificationV2026} - * @memberof CertificationSignedOffV2026 - */ - 'certification': CertificationSignedOffCertificationV2026; -} -/** - * - * @export - * @interface CertificationTaskV2026 - */ -export interface CertificationTaskV2026 { - /** - * The ID of the certification task. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'id'?: string; - /** - * The type of the certification task. More values may be added in the future. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'type'?: CertificationTaskV2026TypeV2026; - /** - * The type of item that is being operated on by this task whose ID is stored in the targetId field. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'targetType'?: CertificationTaskV2026TargetTypeV2026; - /** - * The ID of the item being operated on by this task. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'targetId'?: string; - /** - * The status of the task. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'status'?: CertificationTaskV2026StatusV2026; - /** - * List of error messages - * @type {Array} - * @memberof CertificationTaskV2026 - */ - 'errors'?: Array; - /** - * Reassignment trails that lead to self certification identity - * @type {Array} - * @memberof CertificationTaskV2026 - */ - 'reassignmentTrailDTOs'?: Array; - /** - * The date and time on which this task was created. - * @type {string} - * @memberof CertificationTaskV2026 - */ - 'created'?: string; -} - -export const CertificationTaskV2026TypeV2026 = { - Reassign: 'REASSIGN', - AdminReassign: 'ADMIN_REASSIGN', - CompleteCertification: 'COMPLETE_CERTIFICATION', - FinishCertification: 'FINISH_CERTIFICATION', - CompleteCampaign: 'COMPLETE_CAMPAIGN', - ActivateCampaign: 'ACTIVATE_CAMPAIGN', - CampaignCreate: 'CAMPAIGN_CREATE', - CampaignDelete: 'CAMPAIGN_DELETE' -} as const; - -export type CertificationTaskV2026TypeV2026 = typeof CertificationTaskV2026TypeV2026[keyof typeof CertificationTaskV2026TypeV2026]; -export const CertificationTaskV2026TargetTypeV2026 = { - Certification: 'CERTIFICATION', - Campaign: 'CAMPAIGN' -} as const; - -export type CertificationTaskV2026TargetTypeV2026 = typeof CertificationTaskV2026TargetTypeV2026[keyof typeof CertificationTaskV2026TargetTypeV2026]; -export const CertificationTaskV2026StatusV2026 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type CertificationTaskV2026StatusV2026 = typeof CertificationTaskV2026StatusV2026[keyof typeof CertificationTaskV2026StatusV2026]; - -/** - * - * @export - * @interface CertificationV2026 - */ -export interface CertificationV2026 { - /** - * id of the certification - * @type {string} - * @memberof CertificationV2026 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof CertificationV2026 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2026} - * @memberof CertificationV2026 - */ - 'campaign'?: CampaignReferenceV2026; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof CertificationV2026 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof CertificationV2026 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof CertificationV2026 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof CertificationV2026 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof CertificationV2026 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof CertificationV2026 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof CertificationV2026 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof CertificationV2026 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof CertificationV2026 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2026} - * @memberof CertificationV2026 - */ - 'reviewer'?: ReviewerV2026; - /** - * - * @type {ReassignmentV2026} - * @memberof CertificationV2026 - */ - 'reassignment'?: ReassignmentV2026 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof CertificationV2026 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof CertificationV2026 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2026} - * @memberof CertificationV2026 - */ - 'phase'?: CertificationPhaseV2026; -} - - -/** - * - * @export - * @interface CertifierResponseV2026 - */ -export interface CertifierResponseV2026 { - /** - * the id of the certifier - * @type {string} - * @memberof CertifierResponseV2026 - */ - 'id'?: string; - /** - * the name of the certifier - * @type {string} - * @memberof CertifierResponseV2026 - */ - 'displayName'?: string; -} -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationDurationMinutesV2026 - */ -export interface ClientLogConfigurationDurationMinutesV2026 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationDurationMinutesV2026 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationDurationMinutesV2026 - */ - 'durationMinutes'?: number; - /** - * - * @type {StandardLevelV2026} - * @memberof ClientLogConfigurationDurationMinutesV2026 - */ - 'rootLevel': StandardLevelV2026; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2026; }} - * @memberof ClientLogConfigurationDurationMinutesV2026 - */ - 'logLevels'?: { [key: string]: StandardLevelV2026; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationExpirationV2026 - */ -export interface ClientLogConfigurationExpirationV2026 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationExpirationV2026 - */ - 'clientId'?: string; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationExpirationV2026 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2026} - * @memberof ClientLogConfigurationExpirationV2026 - */ - 'rootLevel': StandardLevelV2026; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2026; }} - * @memberof ClientLogConfigurationExpirationV2026 - */ - 'logLevels'?: { [key: string]: StandardLevelV2026; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationV2026 - */ -export interface ClientLogConfigurationV2026 { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationV2026 - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationV2026 - */ - 'durationMinutes'?: number; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationV2026 - */ - 'expiration'?: string; - /** - * - * @type {StandardLevelV2026} - * @memberof ClientLogConfigurationV2026 - */ - 'rootLevel': StandardLevelV2026; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevelV2026; }} - * @memberof ClientLogConfigurationV2026 - */ - 'logLevels'?: { [key: string]: StandardLevelV2026; }; -} - - -/** - * Type of an API Client indicating public or confidentials use - * @export - * @enum {string} - */ - -export const ClientTypeV2026 = { - Confidential: 'CONFIDENTIAL', - Public: 'PUBLIC' -} as const; - -export type ClientTypeV2026 = typeof ClientTypeV2026[keyof typeof ClientTypeV2026]; - - -/** - * Request body payload for close access requests endpoint. - * @export - * @interface CloseAccessRequestV2026 - */ -export interface CloseAccessRequestV2026 { - /** - * Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. - * @type {Array} - * @memberof CloseAccessRequestV2026 - */ - 'accessRequestIds': Array; - /** - * Reason for closing the access request. Displayed under Warnings in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2026 - */ - 'message'?: string; - /** - * The request\'s provisioning status. Displayed as Stage in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2026 - */ - 'executionStatus'?: CloseAccessRequestV2026ExecutionStatusV2026; - /** - * The request\'s overall status. Displayed as Status in IdentityNow. - * @type {string} - * @memberof CloseAccessRequestV2026 - */ - 'completionStatus'?: CloseAccessRequestV2026CompletionStatusV2026; -} - -export const CloseAccessRequestV2026ExecutionStatusV2026 = { - Terminated: 'Terminated', - Completed: 'Completed' -} as const; - -export type CloseAccessRequestV2026ExecutionStatusV2026 = typeof CloseAccessRequestV2026ExecutionStatusV2026[keyof typeof CloseAccessRequestV2026ExecutionStatusV2026]; -export const CloseAccessRequestV2026CompletionStatusV2026 = { - Success: 'Success', - Incomplete: 'Incomplete', - Failure: 'Failure' -} as const; - -export type CloseAccessRequestV2026CompletionStatusV2026 = typeof CloseAccessRequestV2026CompletionStatusV2026[keyof typeof CloseAccessRequestV2026CompletionStatusV2026]; - -/** - * Configuration details for the \'ccg\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 { - /** - * Version of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ - 'version': string; - /** - * Path to the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ - 'path': string; - /** - * A brief description of the \'ccg\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ - 'restartNeeded': boolean; - /** - * A map of dependencies for the \'ccg\' process. - * @type {{ [key: string]: string; }} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026 - */ - 'dependencies': { [key: string]: string; }; -} -/** - * Configuration details for the \'charon\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 { - /** - * Version of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 - */ - 'version': string; - /** - * Path to the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 - */ - 'path': string; - /** - * A brief description of the \'charon\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'otel_agent\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 { - /** - * Version of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 - */ - 'version': string; - /** - * Path to the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 - */ - 'path': string; - /** - * A brief description of the \'otel_agent\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'relay\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 { - /** - * Version of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 - */ - 'version': string; - /** - * Path to the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 - */ - 'path': string; - /** - * A brief description of the \'relay\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026 - */ - 'restartNeeded': boolean; -} -/** - * Configuration details for the \'toolbox\' process. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 { - /** - * Version of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 - */ - 'version': string; - /** - * Path to the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 - */ - 'path': string; - /** - * A brief description of the \'toolbox\' process. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 - */ - 'description': string; - /** - * Indicates whether the process needs to be restarted. - * @type {boolean} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026 - */ - 'restartNeeded': boolean; -} -/** - * Configuration of the managed processes involved in the upgrade. - * @export - * @interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ -export interface ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 { - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ - 'charon'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCharonV2026; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ - 'ccg'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationCcgV2026; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ - 'otel_agent'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationOtelAgentV2026; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ - 'relay'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationRelayV2026; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026} - * @memberof ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026 - */ - 'toolbox'?: ClusterManualUpgradeJobsInnerManagedProcessConfigurationToolboxV2026; -} -/** - * - * @export - * @interface ClusterManualUpgradeJobsInnerV2026 - */ -export interface ClusterManualUpgradeJobsInnerV2026 { - /** - * Unique identifier for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'uuid': string; - /** - * Identifier for the cookbook used in the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'cookbook': string; - /** - * Current state of the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'state': string; - /** - * The type of upgrade job (e.g., VA_UPGRADE). - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'type': string; - /** - * Unique identifier of the target for the upgrade job. - * @type {string} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'targetId': string; - /** - * - * @type {ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026} - * @memberof ClusterManualUpgradeJobsInnerV2026 - */ - 'managedProcessConfiguration': ClusterManualUpgradeJobsInnerManagedProcessConfigurationV2026; -} -/** - * Manual Upgrade Job Response - * @export - * @interface ClusterManualUpgradeV2026 - */ -export interface ClusterManualUpgradeV2026 { - /** - * List of job objects for the upgrade request. - * @type {Array} - * @memberof ClusterManualUpgradeV2026 - */ - 'jobs'?: Array; -} -/** - * - * @export - * @interface ColumnV2026 - */ -export interface ColumnV2026 { - /** - * The name of the field. - * @type {string} - * @memberof ColumnV2026 - */ - 'field': string; - /** - * The value of the header. - * @type {string} - * @memberof ColumnV2026 - */ - 'header'?: string; -} -/** - * Author of the comment - * @export - * @interface CommentDtoAuthorV2026 - */ -export interface CommentDtoAuthorV2026 { - /** - * The type of object - * @type {string} - * @memberof CommentDtoAuthorV2026 - */ - 'type'?: CommentDtoAuthorV2026TypeV2026; - /** - * The unique ID of the object - * @type {string} - * @memberof CommentDtoAuthorV2026 - */ - 'id'?: string; - /** - * The display name of the object - * @type {string} - * @memberof CommentDtoAuthorV2026 - */ - 'name'?: string; -} - -export const CommentDtoAuthorV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type CommentDtoAuthorV2026TypeV2026 = typeof CommentDtoAuthorV2026TypeV2026[keyof typeof CommentDtoAuthorV2026TypeV2026]; - -/** - * - * @export - * @interface CommentDtoV2026 - */ -export interface CommentDtoV2026 { - /** - * Comment content. - * @type {string} - * @memberof CommentDtoV2026 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDtoV2026 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2026} - * @memberof CommentDtoV2026 - */ - 'author'?: CommentDtoAuthorV2026; -} -/** - * - * @export - * @interface CommentV2026 - */ -export interface CommentV2026 { - /** - * Id of the identity making the comment - * @type {string} - * @memberof CommentV2026 - */ - 'commenterId'?: string; - /** - * Human-readable display name of the identity making the comment - * @type {string} - * @memberof CommentV2026 - */ - 'commenterName'?: string; - /** - * Content of the comment - * @type {string} - * @memberof CommentV2026 - */ - 'body'?: string; - /** - * Date and time comment was made - * @type {string} - * @memberof CommentV2026 - */ - 'date'?: string; -} -/** - * - * @export - * @interface CommonAccessIDStatusV2026 - */ -export interface CommonAccessIDStatusV2026 { - /** - * List of confirmed common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2026 - */ - 'confirmedIds'?: Array; - /** - * List of denied common access ids. - * @type {Array} - * @memberof CommonAccessIDStatusV2026 - */ - 'deniedIds'?: Array; -} -/** - * - * @export - * @interface CommonAccessItemAccessV2026 - */ -export interface CommonAccessItemAccessV2026 { - /** - * Common access ID - * @type {string} - * @memberof CommonAccessItemAccessV2026 - */ - 'id'?: string; - /** - * - * @type {CommonAccessTypeV2026} - * @memberof CommonAccessItemAccessV2026 - */ - 'type'?: CommonAccessTypeV2026; - /** - * Common access name - * @type {string} - * @memberof CommonAccessItemAccessV2026 - */ - 'name'?: string; - /** - * Common access description - * @type {string} - * @memberof CommonAccessItemAccessV2026 - */ - 'description'?: string | null; - /** - * Common access owner name - * @type {string} - * @memberof CommonAccessItemAccessV2026 - */ - 'ownerName'?: string; - /** - * Common access owner ID - * @type {string} - * @memberof CommonAccessItemAccessV2026 - */ - 'ownerId'?: string; -} - - -/** - * - * @export - * @interface CommonAccessItemRequestV2026 - */ -export interface CommonAccessItemRequestV2026 { - /** - * - * @type {CommonAccessItemAccessV2026} - * @memberof CommonAccessItemRequestV2026 - */ - 'access'?: CommonAccessItemAccessV2026; - /** - * - * @type {CommonAccessItemStateV2026} - * @memberof CommonAccessItemRequestV2026 - */ - 'status'?: CommonAccessItemStateV2026; -} - - -/** - * - * @export - * @interface CommonAccessItemResponseV2026 - */ -export interface CommonAccessItemResponseV2026 { - /** - * Common Access Item ID - * @type {string} - * @memberof CommonAccessItemResponseV2026 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2026} - * @memberof CommonAccessItemResponseV2026 - */ - 'access'?: CommonAccessItemAccessV2026; - /** - * - * @type {CommonAccessItemStateV2026} - * @memberof CommonAccessItemResponseV2026 - */ - 'status'?: CommonAccessItemStateV2026; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2026 - */ - 'lastUpdated'?: string; - /** - * - * @type {boolean} - * @memberof CommonAccessItemResponseV2026 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2026 - */ - 'lastReviewed'?: string; - /** - * - * @type {string} - * @memberof CommonAccessItemResponseV2026 - */ - 'createdByUser'?: string; -} - - -/** - * State of common access item. - * @export - * @enum {string} - */ - -export const CommonAccessItemStateV2026 = { - Confirmed: 'CONFIRMED', - Denied: 'DENIED' -} as const; - -export type CommonAccessItemStateV2026 = typeof CommonAccessItemStateV2026[keyof typeof CommonAccessItemStateV2026]; - - -/** - * - * @export - * @interface CommonAccessResponseV2026 - */ -export interface CommonAccessResponseV2026 { - /** - * Unique ID of the common access item - * @type {string} - * @memberof CommonAccessResponseV2026 - */ - 'id'?: string; - /** - * - * @type {CommonAccessItemAccessV2026} - * @memberof CommonAccessResponseV2026 - */ - 'access'?: CommonAccessItemAccessV2026; - /** - * CONFIRMED or DENIED - * @type {string} - * @memberof CommonAccessResponseV2026 - */ - 'status'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2026 - */ - 'commonAccessType'?: string; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2026 - */ - 'lastUpdated'?: string; - /** - * true if user has confirmed or denied status - * @type {boolean} - * @memberof CommonAccessResponseV2026 - */ - 'reviewedByUser'?: boolean; - /** - * - * @type {string} - * @memberof CommonAccessResponseV2026 - */ - 'lastReviewed'?: string | null; - /** - * - * @type {boolean} - * @memberof CommonAccessResponseV2026 - */ - 'createdByUser'?: boolean; -} -/** - * The type of access item. - * @export - * @enum {string} - */ - -export const CommonAccessTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type CommonAccessTypeV2026 = typeof CommonAccessTypeV2026[keyof typeof CommonAccessTypeV2026]; - - -/** - * - * @export - * @interface CompleteInvocationInputV2026 - */ -export interface CompleteInvocationInputV2026 { - /** - * - * @type {LocalizedMessageV2026} - * @memberof CompleteInvocationInputV2026 - */ - 'localizedError'?: LocalizedMessageV2026 | null; - /** - * Trigger output that completed the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationInputV2026 - */ - 'output'?: object | null; -} -/** - * - * @export - * @interface CompleteInvocationV2026 - */ -export interface CompleteInvocationV2026 { - /** - * Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. - * @type {string} - * @memberof CompleteInvocationV2026 - */ - 'secret': string; - /** - * The error message to indicate a failed invocation or error if any. - * @type {string} - * @memberof CompleteInvocationV2026 - */ - 'error'?: string; - /** - * Trigger output to complete the invocation. Its schema is defined in the trigger definition. - * @type {object} - * @memberof CompleteInvocationV2026 - */ - 'output': object; -} -/** - * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. - * @export - * @interface CompletedApprovalPreApprovalTriggerResultV2026 - */ -export interface CompletedApprovalPreApprovalTriggerResultV2026 { - /** - * The comment from the trigger - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2026 - */ - 'comment'?: string; - /** - * - * @type {CompletedApprovalStateV2026} - * @memberof CompletedApprovalPreApprovalTriggerResultV2026 - */ - 'decision'?: CompletedApprovalStateV2026; - /** - * The name of the approver - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2026 - */ - 'reviewer'?: string; - /** - * The date and time the trigger decided on the request - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResultV2026 - */ - 'date'?: string; -} - - -/** - * - * @export - * @interface CompletedApprovalRequesterCommentV2026 - */ -export interface CompletedApprovalRequesterCommentV2026 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2026 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalRequesterCommentV2026 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2026} - * @memberof CompletedApprovalRequesterCommentV2026 - */ - 'author'?: CommentDtoAuthorV2026; -} -/** - * - * @export - * @interface CompletedApprovalReviewerCommentV2026 - */ -export interface CompletedApprovalReviewerCommentV2026 { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2026 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalReviewerCommentV2026 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2026} - * @memberof CompletedApprovalReviewerCommentV2026 - */ - 'author'?: CommentDtoAuthorV2026; -} -/** - * Enum represents completed approval object\'s state. - * @export - * @enum {string} - */ - -export const CompletedApprovalStateV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type CompletedApprovalStateV2026 = typeof CompletedApprovalStateV2026[keyof typeof CompletedApprovalStateV2026]; - - -/** - * - * @export - * @interface CompletedApprovalV2026 - */ -export interface CompletedApprovalV2026 { - /** - * The approval id. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof CompletedApprovalV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * - * @type {AccessItemRequesterV2026} - * @memberof CompletedApprovalV2026 - */ - 'requester'?: AccessItemRequesterV2026; - /** - * - * @type {RequestedItemStatusRequestedForV2026} - * @memberof CompletedApprovalV2026 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2026; - /** - * - * @type {AccessItemReviewedByV2026} - * @memberof CompletedApprovalV2026 - */ - 'reviewedBy'?: AccessItemReviewedByV2026; - /** - * - * @type {OwnerDtoV2026} - * @memberof CompletedApprovalV2026 - */ - 'owner'?: OwnerDtoV2026; - /** - * - * @type {RequestableObjectReferenceV2026} - * @memberof CompletedApprovalV2026 - */ - 'requestedObject'?: RequestableObjectReferenceV2026; - /** - * - * @type {CompletedApprovalRequesterCommentV2026} - * @memberof CompletedApprovalV2026 - */ - 'requesterComment'?: CompletedApprovalRequesterCommentV2026; - /** - * - * @type {CompletedApprovalReviewerCommentV2026} - * @memberof CompletedApprovalV2026 - */ - 'reviewerComment'?: CompletedApprovalReviewerCommentV2026; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof CompletedApprovalV2026 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof CompletedApprovalV2026 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof CompletedApprovalV2026 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {CompletedApprovalStateV2026} - * @memberof CompletedApprovalV2026 - */ - 'state'?: CompletedApprovalStateV2026; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'removeDate'?: string | null; - /** - * If true, then the request was to change the remove date or sunset date. - * @type {boolean} - * @memberof CompletedApprovalV2026 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'currentRemoveDate'?: string | null; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof CompletedApprovalV2026 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2026} - * @memberof CompletedApprovalV2026 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2026 | null; - /** - * - * @type {CompletedApprovalPreApprovalTriggerResultV2026} - * @memberof CompletedApprovalV2026 - */ - 'preApprovalTriggerResult'?: CompletedApprovalPreApprovalTriggerResultV2026 | null; - /** - * Arbitrary key-value pairs provided during the request. - * @type {{ [key: string]: string; }} - * @memberof CompletedApprovalV2026 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof CompletedApprovalV2026 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof CompletedApprovalV2026 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026} - * @memberof CompletedApprovalV2026 - */ - 'maxPermittedAccessDuration'?: EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 | null; -} - - -/** - * The status after completion. - * @export - * @enum {string} - */ - -export const CompletionStatusV2026 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Incomplete: 'INCOMPLETE', - Pending: 'PENDING' -} as const; - -export type CompletionStatusV2026 = typeof CompletionStatusV2026[keyof typeof CompletionStatusV2026]; - - -/** - * - * @export - * @interface ConcatenationV2026 - */ -export interface ConcatenationV2026 { - /** - * An array of items to join together - * @type {Array} - * @memberof ConcatenationV2026 - */ - 'values': Array; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConcatenationV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConcatenationV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Arbitrary map containing a configuration based on the EffectType. - * @export - * @interface ConditionEffectConfigV2026 - */ -export interface ConditionEffectConfigV2026 { - /** - * Effect type\'s label. - * @type {string} - * @memberof ConditionEffectConfigV2026 - */ - 'defaultValueLabel'?: string; - /** - * Element\'s identifier. - * @type {string} - * @memberof ConditionEffectConfigV2026 - */ - 'element'?: string; -} -/** - * Effect produced by a condition. - * @export - * @interface ConditionEffectV2026 - */ -export interface ConditionEffectV2026 { - /** - * Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. - * @type {string} - * @memberof ConditionEffectV2026 - */ - 'effectType'?: ConditionEffectV2026EffectTypeV2026; - /** - * - * @type {ConditionEffectConfigV2026} - * @memberof ConditionEffectV2026 - */ - 'config'?: ConditionEffectConfigV2026; -} - -export const ConditionEffectV2026EffectTypeV2026 = { - Hide: 'HIDE', - Show: 'SHOW', - Disable: 'DISABLE', - Enable: 'ENABLE', - Require: 'REQUIRE', - Optional: 'OPTIONAL', - SubmitMessage: 'SUBMIT_MESSAGE', - SubmitNotification: 'SUBMIT_NOTIFICATION', - SetDefaultValue: 'SET_DEFAULT_VALUE' -} as const; - -export type ConditionEffectV2026EffectTypeV2026 = typeof ConditionEffectV2026EffectTypeV2026[keyof typeof ConditionEffectV2026EffectTypeV2026]; - -/** - * - * @export - * @interface ConditionRuleV2026 - */ -export interface ConditionRuleV2026 { - /** - * Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement - * @type {string} - * @memberof ConditionRuleV2026 - */ - 'sourceType'?: ConditionRuleV2026SourceTypeV2026; - /** - * Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. - * @type {string} - * @memberof ConditionRuleV2026 - */ - 'source'?: string; - /** - * ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith - * @type {string} - * @memberof ConditionRuleV2026 - */ - 'operator'?: ConditionRuleV2026OperatorV2026; - /** - * ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean - * @type {string} - * @memberof ConditionRuleV2026 - */ - 'valueType'?: ConditionRuleV2026ValueTypeV2026; - /** - * Based on the ValueType. - * @type {string} - * @memberof ConditionRuleV2026 - */ - 'value'?: string; -} - -export const ConditionRuleV2026SourceTypeV2026 = { - Input: 'INPUT', - Element: 'ELEMENT' -} as const; - -export type ConditionRuleV2026SourceTypeV2026 = typeof ConditionRuleV2026SourceTypeV2026[keyof typeof ConditionRuleV2026SourceTypeV2026]; -export const ConditionRuleV2026OperatorV2026 = { - Eq: 'EQ', - Ne: 'NE', - Co: 'CO', - NotCo: 'NOT_CO', - In: 'IN', - NotIn: 'NOT_IN', - Em: 'EM', - NotEm: 'NOT_EM', - Sw: 'SW', - NotSw: 'NOT_SW', - Ew: 'EW', - NotEw: 'NOT_EW' -} as const; - -export type ConditionRuleV2026OperatorV2026 = typeof ConditionRuleV2026OperatorV2026[keyof typeof ConditionRuleV2026OperatorV2026]; -export const ConditionRuleV2026ValueTypeV2026 = { - String: 'STRING', - StringList: 'STRING_LIST', - Input: 'INPUT', - Element: 'ELEMENT', - List: 'LIST', - Boolean: 'BOOLEAN' -} as const; - -export type ConditionRuleV2026ValueTypeV2026 = typeof ConditionRuleV2026ValueTypeV2026[keyof typeof ConditionRuleV2026ValueTypeV2026]; - -/** - * - * @export - * @interface ConditionalV2026 - */ -export interface ConditionalV2026 { - /** - * A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison - * @type {string} - * @memberof ConditionalV2026 - */ - 'expression': string; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof ConditionalV2026 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof ConditionalV2026 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ConditionalV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ConditionalV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Config export and import format for individual object configurations. - * @export - * @interface ConfigObjectV2026 - */ -export interface ConfigObjectV2026 { - /** - * Current version of configuration object. - * @type {number} - * @memberof ConfigObjectV2026 - */ - 'version'?: number; - /** - * - * @type {SelfImportExportDtoV2026} - * @memberof ConfigObjectV2026 - */ - 'self'?: SelfImportExportDtoV2026; - /** - * Object details. Format dependant on the object type. - * @type {{ [key: string]: any; }} - * @memberof ConfigObjectV2026 - */ - 'object'?: { [key: string]: any; }; -} -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumCamelV2026 = { - AccessRequests: 'accessRequests', - Certifications: 'certifications', - ManualTasks: 'manualTasks' -} as const; - -export type ConfigTypeEnumCamelV2026 = typeof ConfigTypeEnumCamelV2026[keyof typeof ConfigTypeEnumCamelV2026]; - - -/** - * Enum list of valid work types that can be selected for a Reassignment Configuration - * @export - * @enum {string} - */ - -export const ConfigTypeEnumV2026 = { - AccessRequests: 'ACCESS_REQUESTS', - Certifications: 'CERTIFICATIONS', - ManualTasks: 'MANUAL_TASKS', - GenericApprovals: 'GENERIC_APPROVALS' -} as const; - -export type ConfigTypeEnumV2026 = typeof ConfigTypeEnumV2026[keyof typeof ConfigTypeEnumV2026]; - - -/** - * Type of Reassignment Configuration. - * @export - * @interface ConfigTypeV2026 - */ -export interface ConfigTypeV2026 { - /** - * - * @type {number} - * @memberof ConfigTypeV2026 - */ - 'priority'?: number; - /** - * - * @type {ConfigTypeEnumCamelV2026} - * @memberof ConfigTypeV2026 - */ - 'internalName'?: ConfigTypeEnumCamelV2026; - /** - * - * @type {ConfigTypeEnumV2026} - * @memberof ConfigTypeV2026 - */ - 'internalNameCamel'?: ConfigTypeEnumV2026; - /** - * Human readable display name of the type to be shown on UI - * @type {string} - * @memberof ConfigTypeV2026 - */ - 'displayName'?: string; - /** - * Description of the type of work to be reassigned, displayed by the UI. - * @type {string} - * @memberof ConfigTypeV2026 - */ - 'description'?: string; -} - - -/** - * The request body of Reassignment Configuration Details for a specific identity and config type - * @export - * @interface ConfigurationDetailsResponseV2026 - */ -export interface ConfigurationDetailsResponseV2026 { - /** - * - * @type {ConfigTypeEnumV2026} - * @memberof ConfigurationDetailsResponseV2026 - */ - 'configType'?: ConfigTypeEnumV2026; - /** - * - * @type {Identity1V2026} - * @memberof ConfigurationDetailsResponseV2026 - */ - 'targetIdentity'?: Identity1V2026; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationDetailsResponseV2026 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationDetailsResponseV2026 - */ - 'endDate'?: string; - /** - * - * @type {AuditDetailsV2026} - * @memberof ConfigurationDetailsResponseV2026 - */ - 'auditDetails'?: AuditDetailsV2026; -} - - -/** - * The request body for creation or update of a Reassignment Configuration for a single identity and work type - * @export - * @interface ConfigurationItemRequestV2026 - */ -export interface ConfigurationItemRequestV2026 { - /** - * The identity id to reassign an item from - * @type {string} - * @memberof ConfigurationItemRequestV2026 - */ - 'reassignedFromId'?: string; - /** - * The identity id to reassign an item to - * @type {string} - * @memberof ConfigurationItemRequestV2026 - */ - 'reassignedToId'?: string; - /** - * - * @type {ConfigTypeEnumV2026} - * @memberof ConfigurationItemRequestV2026 - */ - 'configType'?: ConfigTypeEnumV2026; - /** - * The date from which to start reassigning work items - * @type {string} - * @memberof ConfigurationItemRequestV2026 - */ - 'startDate'?: string; - /** - * The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. - * @type {string} - * @memberof ConfigurationItemRequestV2026 - */ - 'endDate'?: string | null; -} - - -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationItemResponseV2026 - */ -export interface ConfigurationItemResponseV2026 { - /** - * - * @type {Identity1V2026} - * @memberof ConfigurationItemResponseV2026 - */ - 'identity'?: Identity1V2026; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationItemResponseV2026 - */ - 'configDetails'?: Array; -} -/** - * The response body of a Reassignment Configuration for a single identity - * @export - * @interface ConfigurationResponseV2026 - */ -export interface ConfigurationResponseV2026 { - /** - * - * @type {Identity1V2026} - * @memberof ConfigurationResponseV2026 - */ - 'identity'?: Identity1V2026; - /** - * Details of how work should be reassigned for an Identity - * @type {Array} - * @memberof ConfigurationResponseV2026 - */ - 'configDetails'?: Array; -} -/** - * - * @export - * @interface ConflictingAccessCriteriaV2026 - */ -export interface ConflictingAccessCriteriaV2026 { - /** - * - * @type {AccessCriteriaV2026} - * @memberof ConflictingAccessCriteriaV2026 - */ - 'leftCriteria'?: AccessCriteriaV2026; - /** - * - * @type {AccessCriteriaV2026} - * @memberof ConflictingAccessCriteriaV2026 - */ - 'rightCriteria'?: AccessCriteriaV2026; -} -/** - * An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - * @export - * @enum {string} - */ - -export const ConnectedObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type ConnectedObjectTypeV2026 = typeof ConnectedObjectTypeV2026[keyof typeof ConnectedObjectTypeV2026]; - - -/** - * - * @export - * @interface ConnectedObjectV2026 - */ -export interface ConnectedObjectV2026 { - /** - * - * @type {ConnectedObjectTypeV2026 & object} - * @memberof ConnectedObjectV2026 - */ - 'type'?: ConnectedObjectTypeV2026 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ConnectedObjectV2026 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof ConnectedObjectV2026 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof ConnectedObjectV2026 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ConnectorCustomizerCreateRequestV2026 - */ -export interface ConnectorCustomizerCreateRequestV2026 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerCreateRequestV2026 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerResponse - * @export - * @interface ConnectorCustomizerCreateResponseV2026 - */ -export interface ConnectorCustomizerCreateResponseV2026 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2026 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2026 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2026 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerCreateResponseV2026 - */ - 'created'?: string; -} -/** - * ConnectorCustomizerUpdateRequest - * @export - * @interface ConnectorCustomizerUpdateRequestV2026 - */ -export interface ConnectorCustomizerUpdateRequestV2026 { - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizerUpdateRequestV2026 - */ - 'name'?: string; -} -/** - * ConnectorCustomizerUpdateResponse - * @export - * @interface ConnectorCustomizerUpdateResponseV2026 - */ -export interface ConnectorCustomizerUpdateResponseV2026 { - /** - * the ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'id'?: string; - /** - * name of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'name'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'created'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizerUpdateResponseV2026 - */ - 'imageID'?: string; -} -/** - * ConnectorCustomizerVersionCreateResponse - * @export - * @interface ConnectorCustomizerVersionCreateResponseV2026 - */ -export interface ConnectorCustomizerVersionCreateResponseV2026 { - /** - * ID of connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2026 - */ - 'customizerID'?: string; - /** - * ImageID of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2026 - */ - 'imageID'?: string; - /** - * Image version of the connector customizer. - * @type {number} - * @memberof ConnectorCustomizerVersionCreateResponseV2026 - */ - 'version'?: number; - /** - * Date-time when the connector customizer version was created. - * @type {string} - * @memberof ConnectorCustomizerVersionCreateResponseV2026 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorCustomizersResponseV2026 - */ -export interface ConnectorCustomizersResponseV2026 { - /** - * Connector customizer ID. - * @type {string} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'id'?: string; - /** - * Connector customizer name. - * @type {string} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'name'?: string; - /** - * Connector customizer image version. - * @type {number} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'imageVersion'?: number; - /** - * Connector customizer image id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'imageID'?: string; - /** - * Connector customizer tenant id. - * @type {string} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'tenantID'?: string; - /** - * Date-time when the connector customizer was created - * @type {string} - * @memberof ConnectorCustomizersResponseV2026 - */ - 'created'?: string; -} -/** - * - * @export - * @interface ConnectorDetailV2026 - */ -export interface ConnectorDetailV2026 { - /** - * The connector name - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'type'?: string; - /** - * The connector class name - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'className'?: string; - /** - * The connector script name - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'scriptName'?: string; - /** - * The connector application xml - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'applicationXml'?: string; - /** - * The connector correlation config xml - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'correlationConfigXml'?: string; - /** - * The connector source config xml - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'sourceConfigXml'?: string; - /** - * The connector source config - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'sourceConfig'?: string | null; - /** - * The connector source config origin - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'sourceConfigFrom'?: string | null; - /** - * storage path key for this connector - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 's3Location'?: string; - /** - * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. - * @type {Array} - * @memberof ConnectorDetailV2026 - */ - 'uploadedFiles'?: Array | null; - /** - * true if the source is file upload - * @type {boolean} - * @memberof ConnectorDetailV2026 - */ - 'fileUpload'?: boolean; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof ConnectorDetailV2026 - */ - 'directConnect'?: boolean; - /** - * A map containing translation attributes by loacale key - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2026 - */ - 'translationProperties'?: { [key: string]: any; }; - /** - * A map containing metadata pertinent to the UI to be used - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetailV2026 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof ConnectorDetailV2026 - */ - 'status'?: ConnectorDetailV2026StatusV2026; -} - -export const ConnectorDetailV2026StatusV2026 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type ConnectorDetailV2026StatusV2026 = typeof ConnectorDetailV2026StatusV2026[keyof typeof ConnectorDetailV2026StatusV2026]; - -/** - * The rule\'s function signature. Describes the rule\'s input arguments and output (if any) - * @export - * @interface ConnectorRuleCreateRequestSignatureV2026 - */ -export interface ConnectorRuleCreateRequestSignatureV2026 { - /** - * - * @type {Array} - * @memberof ConnectorRuleCreateRequestSignatureV2026 - */ - 'input': Array; - /** - * - * @type {ArgumentV2026} - * @memberof ConnectorRuleCreateRequestSignatureV2026 - */ - 'output'?: ArgumentV2026 | null; -} -/** - * ConnectorRuleCreateRequest - * @export - * @interface ConnectorRuleCreateRequestV2026 - */ -export interface ConnectorRuleCreateRequestV2026 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'type': ConnectorRuleCreateRequestV2026TypeV2026; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2026} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2026; - /** - * - * @type {SourceCodeV2026} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'sourceCode': SourceCodeV2026; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleCreateRequestV2026 - */ - 'attributes'?: object | null; -} - -export const ConnectorRuleCreateRequestV2026TypeV2026 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleCreateRequestV2026TypeV2026 = typeof ConnectorRuleCreateRequestV2026TypeV2026[keyof typeof ConnectorRuleCreateRequestV2026TypeV2026]; - -/** - * ConnectorRuleResponse - * @export - * @interface ConnectorRuleResponseV2026 - */ -export interface ConnectorRuleResponseV2026 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'type': ConnectorRuleResponseV2026TypeV2026; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2026} - * @memberof ConnectorRuleResponseV2026 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2026; - /** - * - * @type {SourceCodeV2026} - * @memberof ConnectorRuleResponseV2026 - */ - 'sourceCode': SourceCodeV2026; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleResponseV2026 - */ - 'attributes'?: object | null; - /** - * the ID of the rule - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'id': string; - /** - * an ISO 8601 UTC timestamp when this rule was created - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'created': string; - /** - * an ISO 8601 UTC timestamp when this rule was last modified - * @type {string} - * @memberof ConnectorRuleResponseV2026 - */ - 'modified'?: string | null; -} - -export const ConnectorRuleResponseV2026TypeV2026 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleResponseV2026TypeV2026 = typeof ConnectorRuleResponseV2026TypeV2026[keyof typeof ConnectorRuleResponseV2026TypeV2026]; - -/** - * ConnectorRuleUpdateRequest - * @export - * @interface ConnectorRuleUpdateRequestV2026 - */ -export interface ConnectorRuleUpdateRequestV2026 { - /** - * the name of the rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'name': string; - /** - * a description of the rule\'s purpose - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'description'?: string | null; - /** - * the type of rule - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'type': ConnectorRuleUpdateRequestV2026TypeV2026; - /** - * - * @type {ConnectorRuleCreateRequestSignatureV2026} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'signature'?: ConnectorRuleCreateRequestSignatureV2026; - /** - * - * @type {SourceCodeV2026} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'sourceCode': SourceCodeV2026; - /** - * a map of string to objects - * @type {object} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'attributes'?: object | null; - /** - * the ID of the rule to update - * @type {string} - * @memberof ConnectorRuleUpdateRequestV2026 - */ - 'id': string; -} - -export const ConnectorRuleUpdateRequestV2026TypeV2026 = { - BuildMap: 'BuildMap', - ConnectorAfterCreate: 'ConnectorAfterCreate', - ConnectorAfterDelete: 'ConnectorAfterDelete', - ConnectorAfterModify: 'ConnectorAfterModify', - ConnectorBeforeCreate: 'ConnectorBeforeCreate', - ConnectorBeforeDelete: 'ConnectorBeforeDelete', - ConnectorBeforeModify: 'ConnectorBeforeModify', - JdbcBuildMap: 'JDBCBuildMap', - JdbcOperationProvisioning: 'JDBCOperationProvisioning', - JdbcProvision: 'JDBCProvision', - PeopleSoftHrmsBuildMap: 'PeopleSoftHRMSBuildMap', - PeopleSoftHrmsOperationProvisioning: 'PeopleSoftHRMSOperationProvisioning', - PeopleSoftHrmsProvision: 'PeopleSoftHRMSProvision', - RacfPermissionCustomization: 'RACFPermissionCustomization', - ResourceObjectCustomization: 'ResourceObjectCustomization', - SapBuildMap: 'SAPBuildMap', - SapHrManagerRule: 'SapHrManagerRule', - SapHrOperationProvisioning: 'SapHrOperationProvisioning', - SapHrProvision: 'SapHrProvision', - SuccessFactorsOperationProvisioning: 'SuccessFactorsOperationProvisioning', - WebServiceAfterOperationRule: 'WebServiceAfterOperationRule', - WebServiceBeforeOperationRule: 'WebServiceBeforeOperationRule', - ResourceObjectCustomization2: 'ResourceObjectCustomization' -} as const; - -export type ConnectorRuleUpdateRequestV2026TypeV2026 = typeof ConnectorRuleUpdateRequestV2026TypeV2026[keyof typeof ConnectorRuleUpdateRequestV2026TypeV2026]; - -/** - * CodeErrorDetail - * @export - * @interface ConnectorRuleValidationResponseDetailsInnerV2026 - */ -export interface ConnectorRuleValidationResponseDetailsInnerV2026 { - /** - * The line number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2026 - */ - 'line': number; - /** - * the column number where the issue occurred - * @type {number} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2026 - */ - 'column': number; - /** - * a description of the issue in the code - * @type {string} - * @memberof ConnectorRuleValidationResponseDetailsInnerV2026 - */ - 'messsage'?: string; -} -/** - * ConnectorRuleValidationResponse - * @export - * @interface ConnectorRuleValidationResponseV2026 - */ -export interface ConnectorRuleValidationResponseV2026 { - /** - * - * @type {string} - * @memberof ConnectorRuleValidationResponseV2026 - */ - 'state': ConnectorRuleValidationResponseV2026StateV2026; - /** - * - * @type {Array} - * @memberof ConnectorRuleValidationResponseV2026 - */ - 'details': Array; -} - -export const ConnectorRuleValidationResponseV2026StateV2026 = { - Ok: 'OK', - Error: 'ERROR' -} as const; - -export type ConnectorRuleValidationResponseV2026StateV2026 = typeof ConnectorRuleValidationResponseV2026StateV2026[keyof typeof ConnectorRuleValidationResponseV2026StateV2026]; - -/** - * - * @export - * @interface ContextAttributeDtoV2026 - */ -export interface ContextAttributeDtoV2026 { - /** - * The name of the attribute - * @type {string} - * @memberof ContextAttributeDtoV2026 - */ - 'attribute'?: string; - /** - * - * @type {ContextAttributeDtoValueV2026} - * @memberof ContextAttributeDtoV2026 - */ - 'value'?: ContextAttributeDtoValueV2026; - /** - * True if the attribute was derived. - * @type {boolean} - * @memberof ContextAttributeDtoV2026 - */ - 'derived'?: boolean; -} -/** - * @type ContextAttributeDtoValueV2026 - * The value of the attribute. This can be either a string or a multi-valued string - * @export - */ -export type ContextAttributeDtoValueV2026 = Array | string; - -/** - * - * @export - * @interface CorrelatedGovernanceEventV2026 - */ -export interface CorrelatedGovernanceEventV2026 { - /** - * The name of the governance event, such as the certification name or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'name'?: string; - /** - * The date that the certification or access request was completed. - * @type {string} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'dateTime'?: string; - /** - * The type of governance event. - * @type {string} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'type'?: CorrelatedGovernanceEventV2026TypeV2026; - /** - * The ID of the instance that caused the event - either the certification ID or access request ID. - * @type {string} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'governanceId'?: string; - /** - * The owners of the governance event (the certifiers or approvers) - * @type {Array} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'owners'?: Array; - /** - * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners - * @type {Array} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2026} - * @memberof CorrelatedGovernanceEventV2026 - */ - 'decisionMaker'?: CertifierResponseV2026; -} - -export const CorrelatedGovernanceEventV2026TypeV2026 = { - Certification: 'certification', - AccessRequest: 'accessRequest' -} as const; - -export type CorrelatedGovernanceEventV2026TypeV2026 = typeof CorrelatedGovernanceEventV2026TypeV2026[keyof typeof CorrelatedGovernanceEventV2026TypeV2026]; - -/** - * The attribute assignment of the correlation configuration. - * @export - * @interface CorrelationConfigAttributeAssignmentsInnerV2026 - */ -export interface CorrelationConfigAttributeAssignmentsInnerV2026 { - /** - * The property of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'property'?: string; - /** - * The value of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'value'?: string; - /** - * The operation of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'operation'?: CorrelationConfigAttributeAssignmentsInnerV2026OperationV2026; - /** - * Whether or not the it\'s a complex attribute assignment. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'complex'?: boolean; - /** - * Whether or not the attribute assignment should ignore case. - * @type {boolean} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'ignoreCase'?: boolean; - /** - * The match mode of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'matchMode'?: CorrelationConfigAttributeAssignmentsInnerV2026MatchModeV2026; - /** - * The filter string of the attribute assignment. - * @type {string} - * @memberof CorrelationConfigAttributeAssignmentsInnerV2026 - */ - 'filterString'?: string; -} - -export const CorrelationConfigAttributeAssignmentsInnerV2026OperationV2026 = { - Eq: 'EQ' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2026OperationV2026 = typeof CorrelationConfigAttributeAssignmentsInnerV2026OperationV2026[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2026OperationV2026]; -export const CorrelationConfigAttributeAssignmentsInnerV2026MatchModeV2026 = { - Anywhere: 'ANYWHERE', - Start: 'START', - End: 'END' -} as const; - -export type CorrelationConfigAttributeAssignmentsInnerV2026MatchModeV2026 = typeof CorrelationConfigAttributeAssignmentsInnerV2026MatchModeV2026[keyof typeof CorrelationConfigAttributeAssignmentsInnerV2026MatchModeV2026]; - -/** - * Source configuration information that is used by correlation process. - * @export - * @interface CorrelationConfigV2026 - */ -export interface CorrelationConfigV2026 { - /** - * The ID of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2026 - */ - 'id'?: string | null; - /** - * The name of the correlation configuration. - * @type {string} - * @memberof CorrelationConfigV2026 - */ - 'name'?: string | null; - /** - * The list of attribute assignments of the correlation configuration. - * @type {Array} - * @memberof CorrelationConfigV2026 - */ - 'attributeAssignments'?: Array | null; -} -/** - * Specifies when resource sizes should be calculated during a crawl operation. - 0: Unspecified - No specific option set. - 1: Never - Resource sizes are never calculated. - 2: Always - Resource sizes are always calculated. - 3: Secondcrawl - Resource sizes are calculated only on a second crawl. - * @export - * @enum {number} - */ - -export const CrawlResourcesSizesOptionsV2026 = { - NUMBER_0: 0, - NUMBER_1: 1, - NUMBER_2: 2, - NUMBER_3: 3 -} as const; - -export type CrawlResourcesSizesOptionsV2026 = typeof CrawlResourcesSizesOptionsV2026[keyof typeof CrawlResourcesSizesOptionsV2026]; - - -/** - * - * @export - * @interface CreateDomainDkim405ResponseV2026 - */ -export interface CreateDomainDkim405ResponseV2026 { - /** - * A message describing the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2026 - */ - 'errorName'?: object; - /** - * Description of the error - * @type {object} - * @memberof CreateDomainDkim405ResponseV2026 - */ - 'errorMessage'?: object; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof CreateDomainDkim405ResponseV2026 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflow200ResponseV2026 - */ -export interface CreateExternalExecuteWorkflow200ResponseV2026 { - /** - * The workflow execution id - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2026 - */ - 'workflowExecutionId'?: string; - /** - * An error message if any errors occurred - * @type {string} - * @memberof CreateExternalExecuteWorkflow200ResponseV2026 - */ - 'message'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflowRequestV2026 - */ -export interface CreateExternalExecuteWorkflowRequestV2026 { - /** - * The input for the workflow - * @type {object} - * @memberof CreateExternalExecuteWorkflowRequestV2026 - */ - 'input'?: object; -} -/** - * - * @export - * @interface CreateFormDefinitionFileRequestRequestV2026 - */ -export interface CreateFormDefinitionFileRequestRequestV2026 { - /** - * File specifying the multipart - * @type {File} - * @memberof CreateFormDefinitionFileRequestRequestV2026 - */ - 'file': File; -} -/** - * - * @export - * @interface CreateFormDefinitionRequestV2026 - */ -export interface CreateFormDefinitionRequestV2026 { - /** - * Description is the form definition description - * @type {string} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'description'?: string; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'formConditions'?: Array; - /** - * FormElements is a list of nested form elements - * @type {Array} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'formElements'?: Array; - /** - * FormInput is a list of form inputs that are required when creating a form-instance object - * @type {Array} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'formInput'?: Array; - /** - * Name is the form definition name - * @type {string} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'name': string; - /** - * - * @type {FormOwnerV2026} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'owner': FormOwnerV2026; - /** - * UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used - * @type {Array} - * @memberof CreateFormDefinitionRequestV2026 - */ - 'usedBy'?: Array; -} -/** - * - * @export - * @interface CreateFormInstanceRequestV2026 - */ -export interface CreateFormInstanceRequestV2026 { - /** - * - * @type {FormInstanceCreatedByV2026} - * @memberof CreateFormInstanceRequestV2026 - */ - 'createdBy': FormInstanceCreatedByV2026; - /** - * Expire is required - * @type {string} - * @memberof CreateFormInstanceRequestV2026 - */ - 'expire': string; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof CreateFormInstanceRequestV2026 - */ - 'formDefinitionId': string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: any; }} - * @memberof CreateFormInstanceRequestV2026 - */ - 'formInput'?: { [key: string]: any; }; - /** - * Recipients is required - * @type {Array} - * @memberof CreateFormInstanceRequestV2026 - */ - 'recipients': Array; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof CreateFormInstanceRequestV2026 - */ - 'standAloneForm'?: boolean; - /** - * State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof CreateFormInstanceRequestV2026 - */ - 'state'?: CreateFormInstanceRequestV2026StateV2026; - /** - * TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html - * @type {number} - * @memberof CreateFormInstanceRequestV2026 - */ - 'ttl'?: number; -} - -export const CreateFormInstanceRequestV2026StateV2026 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type CreateFormInstanceRequestV2026StateV2026 = typeof CreateFormInstanceRequestV2026StateV2026[keyof typeof CreateFormInstanceRequestV2026StateV2026]; - -/** - * - * @export - * @interface CreateMachineAccountSubtypeRequestV2026 - */ -export interface CreateMachineAccountSubtypeRequestV2026 { - /** - * Technical name of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2026 - */ - 'technicalName': string; - /** - * Display name of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2026 - */ - 'displayName': string; - /** - * Description of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2026 - */ - 'description': string; - /** - * Type of the subtype. - * @type {string} - * @memberof CreateMachineAccountSubtypeRequestV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface CreateOAuthClientRequestV2026 - */ -export interface CreateOAuthClientRequestV2026 { - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientRequestV2026 - */ - 'businessName'?: string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2026 - */ - 'homepageUrl'?: string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2026 - */ - 'name': string | null; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientRequestV2026 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2026 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequestV2026 - */ - 'refreshTokenValiditySeconds'?: number; - /** - * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - * @type {Array} - * @memberof CreateOAuthClientRequestV2026 - */ - 'redirectUris'?: Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientRequestV2026 - */ - 'grantTypes': Array | null; - /** - * - * @type {AccessTypeV2026} - * @memberof CreateOAuthClientRequestV2026 - */ - 'accessType': AccessTypeV2026; - /** - * - * @type {ClientTypeV2026} - * @memberof CreateOAuthClientRequestV2026 - */ - 'type'?: ClientTypeV2026; - /** - * An indicator of whether the API Client can be used for requests internal within the product. - * @type {boolean} - * @memberof CreateOAuthClientRequestV2026 - */ - 'internal'?: boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientRequestV2026 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientRequestV2026 - */ - 'strongAuthSupported'?: boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientRequestV2026 - */ - 'claimsSupported'?: boolean; - /** - * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreateOAuthClientRequestV2026 - */ - 'scope'?: Array | null; -} - - -/** - * - * @export - * @interface CreateOAuthClientResponseV2026 - */ -export interface CreateOAuthClientResponseV2026 { - /** - * ID of the OAuth client - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'id': string; - /** - * Secret of the OAuth client (This field is only returned on the intial create call.) - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'secret': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'businessName': string; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'homepageUrl': string; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'description': string; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2026 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponseV2026 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof CreateOAuthClientResponseV2026 - */ - 'redirectUris': Array; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientResponseV2026 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2026} - * @memberof CreateOAuthClientResponseV2026 - */ - 'accessType': AccessTypeV2026; - /** - * - * @type {ClientTypeV2026} - * @memberof CreateOAuthClientResponseV2026 - */ - 'type': ClientTypeV2026; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof CreateOAuthClientResponseV2026 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientResponseV2026 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientResponseV2026 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientResponseV2026 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof CreateOAuthClientResponseV2026 - */ - 'modified': string; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof CreateOAuthClientResponseV2026 - */ - 'scope': Array | null; -} - - -/** - * Object for specifying the name of a personal access token to create - * @export - * @interface CreatePersonalAccessTokenRequestV2026 - */ -export interface CreatePersonalAccessTokenRequestV2026 { - /** - * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2026 - */ - 'name': string; - /** - * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreatePersonalAccessTokenRequestV2026 - */ - 'scope'?: Array | null; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenRequestV2026 - */ - 'accessTokenValiditySeconds'?: number | null; - /** - * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Valid Values (dependent on `userAwareTokenNeverExpires`):** * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (after the current date/time). There is no upper limit on how far in the future the expiration date can be set. `expirationDate` cannot be `null` in this case. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. - * @type {string} - * @memberof CreatePersonalAccessTokenRequestV2026 - */ - 'expirationDate'?: string | null; - /** - * Indicates that the user creating this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When set to `true`, this flag confirms that the user understands the security risks associated with non-expiring tokens. **Security Awareness:** Setting this field to `true` serves as an explicit acknowledgment that the user creating the token understands: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Required Validation:** If `expirationDate` is `null` or empty (not included in the request body), `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Behavior:** * When set to `true`: Indicates that the user acknowledges they are creating a token that will never expire. When `expirationDate` is `null` or empty, the token will never expire. * When set to `false` or not specified (and `expirationDate` is provided): The token will follow normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. - * @type {boolean} - * @memberof CreatePersonalAccessTokenRequestV2026 - */ - 'userAwareTokenNeverExpires'?: boolean | null; -} -/** - * - * @export - * @interface CreatePersonalAccessTokenResponseV2026 - */ -export interface CreatePersonalAccessTokenResponseV2026 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'id': string; - /** - * The secret of the personal access token (to be used as the password for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'secret': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'scope': Array | null; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'name': string; - /** - * - * @type {PatOwnerV2026} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'owner': PatOwnerV2026; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'created': string; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'accessTokenValiditySeconds': number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenResponseV2026 - */ - 'expirationDate': string; -} -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 - */ -export interface CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 { - /** - * The target type of the criteria item. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 - */ - 'targetType'?: CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026; - /** - * - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 - */ - 'operator'?: CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026OperatorV2026; - /** - * The values to evaluate the property against. - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 - */ - 'values'?: Array; - /** - * Whether to ignore case when evaluating the property against the values. - * @type {boolean} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026 - */ - 'ignoreCase'?: boolean; -} - -export const CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026 = { - Group: 'group' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026 = typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026]; -export const CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026OperatorV2026 = { - In: 'IN', - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026OperatorV2026 = typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026OperatorV2026[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerCriteriaItemsInnerV2026OperatorV2026]; - -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestGroupsInnerV2026 - */ -export interface CreatePrivilegeCriteriaRequestGroupsInnerV2026 { - /** - * The logical operator to apply between criteria items in the group. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerV2026 - */ - 'operator'?: CreatePrivilegeCriteriaRequestGroupsInnerV2026OperatorV2026; - /** - * - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestGroupsInnerV2026 - */ - 'criteriaItems'?: Array; -} - -export const CreatePrivilegeCriteriaRequestGroupsInnerV2026OperatorV2026 = { - And: 'AND', - Or: 'OR' -} as const; - -export type CreatePrivilegeCriteriaRequestGroupsInnerV2026OperatorV2026 = typeof CreatePrivilegeCriteriaRequestGroupsInnerV2026OperatorV2026[keyof typeof CreatePrivilegeCriteriaRequestGroupsInnerV2026OperatorV2026]; - -/** - * - * @export - * @interface CreatePrivilegeCriteriaRequestV2026 - */ -export interface CreatePrivilegeCriteriaRequestV2026 { - /** - * The Id of the source that the criteria is applied to. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2026 - */ - 'sourceId'?: string; - /** - * The type of criteria being created. Expects \"CUSTOM\". - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2026 - */ - 'type'?: CreatePrivilegeCriteriaRequestV2026TypeV2026; - /** - * The logical operator to apply between groups. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2026 - */ - 'operator'?: CreatePrivilegeCriteriaRequestV2026OperatorV2026; - /** - * - * @type {Array} - * @memberof CreatePrivilegeCriteriaRequestV2026 - */ - 'groups'?: Array; - /** - * The privilege level assigned by this criteria. - * @type {string} - * @memberof CreatePrivilegeCriteriaRequestV2026 - */ - 'privilegeLevel'?: CreatePrivilegeCriteriaRequestV2026PrivilegeLevelV2026; -} - -export const CreatePrivilegeCriteriaRequestV2026TypeV2026 = { - Custom: 'CUSTOM' -} as const; - -export type CreatePrivilegeCriteriaRequestV2026TypeV2026 = typeof CreatePrivilegeCriteriaRequestV2026TypeV2026[keyof typeof CreatePrivilegeCriteriaRequestV2026TypeV2026]; -export const CreatePrivilegeCriteriaRequestV2026OperatorV2026 = { - And: 'AND', - Or: 'OR' -} as const; - -export type CreatePrivilegeCriteriaRequestV2026OperatorV2026 = typeof CreatePrivilegeCriteriaRequestV2026OperatorV2026[keyof typeof CreatePrivilegeCriteriaRequestV2026OperatorV2026]; -export const CreatePrivilegeCriteriaRequestV2026PrivilegeLevelV2026 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type CreatePrivilegeCriteriaRequestV2026PrivilegeLevelV2026 = typeof CreatePrivilegeCriteriaRequestV2026PrivilegeLevelV2026[keyof typeof CreatePrivilegeCriteriaRequestV2026PrivilegeLevelV2026]; - -/** - * - * @export - * @interface CreateSavedSearchRequestV2026 - */ -export interface CreateSavedSearchRequestV2026 { - /** - * The name of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2026 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequestV2026 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2026 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequestV2026 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof CreateSavedSearchRequestV2026 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2026 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof CreateSavedSearchRequestV2026 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof CreateSavedSearchRequestV2026 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequestV2026 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof CreateSavedSearchRequestV2026 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2026} - * @memberof CreateSavedSearchRequestV2026 - */ - 'filters'?: SavedSearchDetailFiltersV2026 | null; -} -/** - * - * @export - * @interface CreateScheduleRequestV2026 - */ -export interface CreateScheduleRequestV2026 { - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof CreateScheduleRequestV2026 - */ - 'taskTypeName'?: string | null; - /** - * The scheduling type, such as \"Daily\", \"Weekly\" etc. - * @type {string} - * @memberof CreateScheduleRequestV2026 - */ - 'scheduleType'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof CreateScheduleRequestV2026 - */ - 'interval'?: number | null; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof CreateScheduleRequestV2026 - */ - 'scheduleTaskName'?: string | null; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof CreateScheduleRequestV2026 - */ - 'startTime'?: number; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof CreateScheduleRequestV2026 - */ - 'endTime'?: number; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof CreateScheduleRequestV2026 - */ - 'daysOfWeek'?: Array | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof CreateScheduleRequestV2026 - */ - 'active'?: boolean; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof CreateScheduleRequestV2026 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof CreateScheduleRequestV2026 - */ - 'applicationId'?: number | null; -} -/** - * - * @export - * @interface CreateScheduledSearchRequestV2026 - */ -export interface CreateScheduledSearchRequestV2026 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2026} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'schedule': Schedule2V2026; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof CreateScheduledSearchRequestV2026 - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface CreateSourceSubtypeRequestV2026 - */ -export interface CreateSourceSubtypeRequestV2026 { - /** - * ID of the source where subtype is created. - * @type {string} - * @memberof CreateSourceSubtypeRequestV2026 - */ - 'sourceId': string; - /** - * Technical name of the subtype. - * @type {string} - * @memberof CreateSourceSubtypeRequestV2026 - */ - 'technicalName': string; - /** - * Display name of the subtype. - * @type {string} - * @memberof CreateSourceSubtypeRequestV2026 - */ - 'displayName': string; - /** - * Description of the subtype. - * @type {string} - * @memberof CreateSourceSubtypeRequestV2026 - */ - 'description': string; - /** - * Type of the subtype. - * @type {string} - * @memberof CreateSourceSubtypeRequestV2026 - */ - 'type'?: string; -} -/** - * Full delivery configuration. method and endpoint_url are required. - * @export - * @interface CreateStreamDeliveryRequestV2026 - */ -export interface CreateStreamDeliveryRequestV2026 { - /** - * Delivery method (only push is supported). - * @type {string} - * @memberof CreateStreamDeliveryRequestV2026 - */ - 'method': string; - /** - * Receiver endpoint URL for push delivery. - * @type {string} - * @memberof CreateStreamDeliveryRequestV2026 - */ - 'endpoint_url': string; - /** - * Authorization header value for delivery requests. - * @type {string} - * @memberof CreateStreamDeliveryRequestV2026 - */ - 'authorization_header'?: string; -} -/** - * Request body for POST /ssf/streams (create stream). - * @export - * @interface CreateStreamRequestV2026 - */ -export interface CreateStreamRequestV2026 { - /** - * - * @type {CreateStreamDeliveryRequestV2026} - * @memberof CreateStreamRequestV2026 - */ - 'delivery': CreateStreamDeliveryRequestV2026; - /** - * Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof CreateStreamRequestV2026 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof CreateStreamRequestV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface CreateUploadedConfigurationRequestV2026 - */ -export interface CreateUploadedConfigurationRequestV2026 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof CreateUploadedConfigurationRequestV2026 - */ - 'data': File; - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof CreateUploadedConfigurationRequestV2026 - */ - 'name': string; -} -/** - * - * @export - * @interface CreateWorkflowRequestV2026 - */ -export interface CreateWorkflowRequestV2026 { - /** - * The name of the workflow - * @type {string} - * @memberof CreateWorkflowRequestV2026 - */ - 'name': string; - /** - * - * @type {WorkflowBodyOwnerV2026} - * @memberof CreateWorkflowRequestV2026 - */ - 'owner'?: WorkflowBodyOwnerV2026; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof CreateWorkflowRequestV2026 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2026} - * @memberof CreateWorkflowRequestV2026 - */ - 'definition'?: WorkflowDefinitionV2026; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof CreateWorkflowRequestV2026 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2026} - * @memberof CreateWorkflowRequestV2026 - */ - 'trigger'?: WorkflowTriggerV2026; -} -/** - * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. - * @export - * @enum {string} - */ - -export const CriteriaTypeV2026 = { - Composite: 'COMPOSITE', - Role: 'ROLE', - Identity: 'IDENTITY', - IdentityAttribute: 'IDENTITY_ATTRIBUTE', - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Source: 'SOURCE', - Account: 'ACCOUNT', - AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', - InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', - InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' -} as const; - -export type CriteriaTypeV2026 = typeof CriteriaTypeV2026[keyof typeof CriteriaTypeV2026]; - - -/** - * - * @export - * @interface CustomPasswordInstructionV2026 - */ -export interface CustomPasswordInstructionV2026 { - /** - * The page ID that represents the page for forget user name, reset password and unlock account flow. - * @type {string} - * @memberof CustomPasswordInstructionV2026 - */ - 'pageId'?: CustomPasswordInstructionV2026PageIdV2026; - /** - * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. - * @type {string} - * @memberof CustomPasswordInstructionV2026 - */ - 'pageContent'?: string; - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionV2026 - */ - 'locale'?: string; -} - -export const CustomPasswordInstructionV2026PageIdV2026 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; - -export type CustomPasswordInstructionV2026PageIdV2026 = typeof CustomPasswordInstructionV2026PageIdV2026[keyof typeof CustomPasswordInstructionV2026PageIdV2026]; - -/** - * - * @export - * @interface DataAccessCategoriesInnerV2026 - */ -export interface DataAccessCategoriesInnerV2026 { - /** - * Value of the category - * @type {string} - * @memberof DataAccessCategoriesInnerV2026 - */ - 'value'?: string; - /** - * Number of matched for each category - * @type {number} - * @memberof DataAccessCategoriesInnerV2026 - */ - 'matchCount'?: number; -} -/** - * - * @export - * @interface DataAccessImpactScoreV2026 - */ -export interface DataAccessImpactScoreV2026 { - /** - * Impact Score for this data - * @type {string} - * @memberof DataAccessImpactScoreV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface DataAccessPoliciesInnerV2026 - */ -export interface DataAccessPoliciesInnerV2026 { - /** - * Value of the policy - * @type {string} - * @memberof DataAccessPoliciesInnerV2026 - */ - 'value'?: string; -} -/** - * DAS data for the entitlement - * @export - * @interface DataAccessV2026 - */ -export interface DataAccessV2026 { - /** - * List of classification policies that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2026 - */ - 'policies'?: Array; - /** - * List of classification categories that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccessV2026 - */ - 'categories'?: Array; - /** - * - * @type {DataAccessImpactScoreV2026} - * @memberof DataAccessV2026 - */ - 'impactScore'?: DataAccessImpactScoreV2026; -} -/** - * - * @export - * @interface DataClassificationSettingsV2026 - */ -export interface DataClassificationSettingsV2026 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof DataClassificationSettingsV2026 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof DataClassificationSettingsV2026 - */ - 'clusterId'?: string | null; -} -/** - * - * @export - * @interface DataOwnerModelV2026 - */ -export interface DataOwnerModelV2026 { - /** - * The unique identifier (UUID) of the identity assigned as the owner of the resource. - * @type {string} - * @memberof DataOwnerModelV2026 - */ - 'identityId'?: string; - /** - * The unique identifier of the resource owned by the identity. - * @type {number} - * @memberof DataOwnerModelV2026 - */ - 'resourceId'?: number; - /** - * The full path to the resource within the system or application. - * @type {string} - * @memberof DataOwnerModelV2026 - */ - 'fullPath'?: string | null; -} -/** - * - * @export - * @interface DataSegmentV2026 - */ -export interface DataSegmentV2026 { - /** - * The segment\'s ID. - * @type {string} - * @memberof DataSegmentV2026 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof DataSegmentV2026 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof DataSegmentV2026 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof DataSegmentV2026 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof DataSegmentV2026 - */ - 'description'?: string; - /** - * List of Scopes that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2026 - */ - 'scopes'?: Array; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof DataSegmentV2026 - */ - 'memberSelection'?: Array; - /** - * - * @type {VisibilityCriteriaV2026} - * @memberof DataSegmentV2026 - */ - 'memberFilter'?: VisibilityCriteriaV2026; - /** - * - * @type {MembershipTypeV2026} - * @memberof DataSegmentV2026 - */ - 'membership'?: MembershipTypeV2026; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentV2026 - */ - 'enabled'?: boolean; - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published - * @type {boolean} - * @memberof DataSegmentV2026 - */ - 'published'?: boolean; -} - - -/** - * @type DateCompareFirstDateV2026 - * This is the first date to consider (The date that would be on the left hand side of the comparison operation). - * @export - */ -export type DateCompareFirstDateV2026 = AccountAttributeV2026 | DateFormatV2026; - -/** - * @type DateCompareSecondDateV2026 - * This is the second date to consider (The date that would be on the right hand side of the comparison operation). - * @export - */ -export type DateCompareSecondDateV2026 = AccountAttributeV2026 | DateFormatV2026; - -/** - * - * @export - * @interface DateCompareV2026 - */ -export interface DateCompareV2026 { - /** - * - * @type {DateCompareFirstDateV2026} - * @memberof DateCompareV2026 - */ - 'firstDate': DateCompareFirstDateV2026; - /** - * - * @type {DateCompareSecondDateV2026} - * @memberof DateCompareV2026 - */ - 'secondDate': DateCompareSecondDateV2026; - /** - * This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | - * @type {string} - * @memberof DateCompareV2026 - */ - 'operator': DateCompareV2026OperatorV2026; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof DateCompareV2026 - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof DateCompareV2026 - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateCompareV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateCompareV2026 - */ - 'input'?: { [key: string]: any; }; -} - -export const DateCompareV2026OperatorV2026 = { - Lt: 'LT', - Lte: 'LTE', - Gt: 'GT', - Gte: 'GTE' -} as const; - -export type DateCompareV2026OperatorV2026 = typeof DateCompareV2026OperatorV2026[keyof typeof DateCompareV2026OperatorV2026]; - -/** - * @type DateFormatInputFormatV2026 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatInputFormatV2026 = NamedConstructsV2026 | string; - -/** - * @type DateFormatOutputFormatV2026 - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatOutputFormatV2026 = NamedConstructsV2026 | string; - -/** - * - * @export - * @interface DateFormatV2026 - */ -export interface DateFormatV2026 { - /** - * - * @type {DateFormatInputFormatV2026} - * @memberof DateFormatV2026 - */ - 'inputFormat'?: DateFormatInputFormatV2026; - /** - * - * @type {DateFormatOutputFormatV2026} - * @memberof DateFormatV2026 - */ - 'outputFormat'?: DateFormatOutputFormatV2026; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateFormatV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateFormatV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DateMathV2026 - */ -export interface DateMathV2026 { - /** - * A string value of the date and time components to operation on, along with the math operations to execute. - * @type {string} - * @memberof DateMathV2026 - */ - 'expression': string; - /** - * A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - * @type {boolean} - * @memberof DateMathV2026 - */ - 'roundUp'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateMathV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateMathV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DecomposeDiacriticalMarksV2026 - */ -export interface DecomposeDiacriticalMarksV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DecomposeDiacriticalMarksV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DecomposeDiacriticalMarksV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DeleteNonEmployeeRecordsInBulkRequestV2026 - */ -export interface DeleteNonEmployeeRecordsInBulkRequestV2026 { - /** - * List of non-employee ids. - * @type {Array} - * @memberof DeleteNonEmployeeRecordsInBulkRequestV2026 - */ - 'ids': Array; -} -/** - * - * @export - * @interface DeleteSource202ResponseV2026 - */ -export interface DeleteSource202ResponseV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof DeleteSource202ResponseV2026 - */ - 'type'?: DeleteSource202ResponseV2026TypeV2026; - /** - * Task result ID. - * @type {string} - * @memberof DeleteSource202ResponseV2026 - */ - 'id'?: string; - /** - * Task result\'s human-readable display name (this should be null/empty). - * @type {string} - * @memberof DeleteSource202ResponseV2026 - */ - 'name'?: string; -} - -export const DeleteSource202ResponseV2026TypeV2026 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type DeleteSource202ResponseV2026TypeV2026 = typeof DeleteSource202ResponseV2026TypeV2026[keyof typeof DeleteSource202ResponseV2026TypeV2026]; - -/** - * Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated. - * @export - * @interface DeliveryRequestV2026 - */ -export interface DeliveryRequestV2026 { - /** - * Delivery method (optional for PATCH). - * @type {string} - * @memberof DeliveryRequestV2026 - */ - 'method'?: string; - /** - * Receiver endpoint URL (optional for PATCH). - * @type {string} - * @memberof DeliveryRequestV2026 - */ - 'endpoint_url'?: string; - /** - * Optional authorization header value. - * @type {string} - * @memberof DeliveryRequestV2026 - */ - 'authorization_header'?: string; -} -/** - * Delivery configuration returned in stream responses. - * @export - * @interface DeliveryResponseV2026 - */ -export interface DeliveryResponseV2026 { - /** - * Delivery method. - * @type {string} - * @memberof DeliveryResponseV2026 - */ - 'method'?: string; - /** - * Receiver endpoint URL. - * @type {string} - * @memberof DeliveryResponseV2026 - */ - 'endpoint_url'?: string; -} -/** - * - * @export - * @interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2026 - */ -export interface DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2026 { - /** - * DTO type - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2026 - */ - 'type'?: string; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInnerV2026 - */ - 'name'?: string; -} -/** - * The Account Source of the connected Application - * @export - * @interface DependantAppConnectionsAccountSourceV2026 - */ -export interface DependantAppConnectionsAccountSourceV2026 { - /** - * Use this Account Source for password management - * @type {boolean} - * @memberof DependantAppConnectionsAccountSourceV2026 - */ - 'useForPasswordManagement'?: boolean; - /** - * A list of Password Policies for this Account Source - * @type {Array} - * @memberof DependantAppConnectionsAccountSourceV2026 - */ - 'passwordPolicies'?: Array; -} -/** - * - * @export - * @interface DependantAppConnectionsV2026 - */ -export interface DependantAppConnectionsV2026 { - /** - * Id of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2026 - */ - 'cloudAppId'?: string; - /** - * Description of the connected Application - * @type {string} - * @memberof DependantAppConnectionsV2026 - */ - 'description'?: string; - /** - * Is the Application enabled - * @type {boolean} - * @memberof DependantAppConnectionsV2026 - */ - 'enabled'?: boolean; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2026 - */ - 'provisionRequestEnabled'?: boolean; - /** - * - * @type {DependantAppConnectionsAccountSourceV2026} - * @memberof DependantAppConnectionsV2026 - */ - 'accountSource'?: DependantAppConnectionsAccountSourceV2026; - /** - * The amount of launchers for connected Application (long type) - * @type {number} - * @memberof DependantAppConnectionsV2026 - */ - 'launcherCount'?: number; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2026 - */ - 'matchAllAccount'?: boolean; - /** - * The owner of the connected Application - * @type {Array} - * @memberof DependantAppConnectionsV2026 - */ - 'owner'?: Array; - /** - * Is App Center enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnectionsV2026 - */ - 'appCenterEnabled'?: boolean; -} -/** - * - * @export - * @interface DependantConnectionsMissingDtoV2026 - */ -export interface DependantConnectionsMissingDtoV2026 { - /** - * The type of dependency type that is missing in the SourceConnections - * @type {string} - * @memberof DependantConnectionsMissingDtoV2026 - */ - 'dependencyType'?: DependantConnectionsMissingDtoV2026DependencyTypeV2026; - /** - * The reason why this dependency is missing - * @type {string} - * @memberof DependantConnectionsMissingDtoV2026 - */ - 'reason'?: string; -} - -export const DependantConnectionsMissingDtoV2026DependencyTypeV2026 = { - IdentityProfiles: 'identityProfiles', - CredentialProfiles: 'credentialProfiles', - MappingProfiles: 'mappingProfiles', - SourceAttributes: 'sourceAttributes', - DependantCustomTransforms: 'dependantCustomTransforms', - DependantApps: 'dependantApps' -} as const; - -export type DependantConnectionsMissingDtoV2026DependencyTypeV2026 = typeof DependantConnectionsMissingDtoV2026DependencyTypeV2026[keyof typeof DependantConnectionsMissingDtoV2026DependencyTypeV2026]; - -/** - * - * @export - * @interface DeployRequestV2026 - */ -export interface DeployRequestV2026 { - /** - * The id of the draft to be used by this deploy. - * @type {string} - * @memberof DeployRequestV2026 - */ - 'draftId': string; -} -/** - * - * @export - * @interface DeployResponseV2026 - */ -export interface DeployResponseV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'status'?: DeployResponseV2026StatusV2026; - /** - * Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'type'?: DeployResponseV2026TypeV2026; - /** - * Message providing information about the outcome of the deploy process. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'message'?: string; - /** - * The name of the user that initiated the deploy process. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'requesterName'?: string; - /** - * Whether or not a results file was created and stored for this deploy. - * @type {boolean} - * @memberof DeployResponseV2026 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'completed'?: string; - /** - * The id of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'draftId'?: string; - /** - * The name of the draft that was used for this deploy. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'draftName'?: string; - /** - * Whether this deploy results file has been transferred to a customer storage location. - * @type {string} - * @memberof DeployResponseV2026 - */ - 'cloudStorageStatus'?: DeployResponseV2026CloudStorageStatusV2026; -} - -export const DeployResponseV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DeployResponseV2026StatusV2026 = typeof DeployResponseV2026StatusV2026[keyof typeof DeployResponseV2026StatusV2026]; -export const DeployResponseV2026TypeV2026 = { - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type DeployResponseV2026TypeV2026 = typeof DeployResponseV2026TypeV2026[keyof typeof DeployResponseV2026TypeV2026]; -export const DeployResponseV2026CloudStorageStatusV2026 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type DeployResponseV2026CloudStorageStatusV2026 = typeof DeployResponseV2026CloudStorageStatusV2026[keyof typeof DeployResponseV2026CloudStorageStatusV2026]; - -/** - * A dimension attribute - * @export - * @interface DimensionAttributeV2026 - */ -export interface DimensionAttributeV2026 { - /** - * Name of the attribute - * @type {string} - * @memberof DimensionAttributeV2026 - */ - 'name'?: string; - /** - * Display name of the attribute - * @type {string} - * @memberof DimensionAttributeV2026 - */ - 'displayName'?: string; - /** - * If an attribute is derived, its value comes from the identity. Otherwise, it can be provided with access request - * @type {boolean} - * @memberof DimensionAttributeV2026 - */ - 'derived'?: boolean; -} -/** - * - * @export - * @interface DimensionBulkDeleteRequestV2026 - */ -export interface DimensionBulkDeleteRequestV2026 { - /** - * List of IDs of Dimensions to be deleted. - * @type {Array} - * @memberof DimensionBulkDeleteRequestV2026 - */ - 'dimensionIds': Array; -} -/** - * Indicates whether the associated criteria represents an expression on identity attributes. - * @export - * @enum {string} - */ - -export const DimensionCriteriaKeyTypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type DimensionCriteriaKeyTypeV2026 = typeof DimensionCriteriaKeyTypeV2026[keyof typeof DimensionCriteriaKeyTypeV2026]; - - -/** - * Refers to a specific Identity attribute used in Dimension membership criteria. - * @export - * @interface DimensionCriteriaKeyV2026 - */ -export interface DimensionCriteriaKeyV2026 { - /** - * - * @type {DimensionCriteriaKeyTypeV2026} - * @memberof DimensionCriteriaKeyV2026 - */ - 'type': DimensionCriteriaKeyTypeV2026; - /** - * The name of the identity attribute to which the associated criteria applies. - * @type {string} - * @memberof DimensionCriteriaKeyV2026 - */ - 'property': string; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel1V2026 - */ -export interface DimensionCriteriaLevel1V2026 { - /** - * - * @type {DimensionCriteriaOperationV2026} - * @memberof DimensionCriteriaLevel1V2026 - */ - 'operation'?: DimensionCriteriaOperationV2026; - /** - * - * @type {DimensionCriteriaKeyV2026} - * @memberof DimensionCriteriaLevel1V2026 - */ - 'key'?: DimensionCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel1V2026 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel1V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface DimensionCriteriaLevel2V2026 - */ -export interface DimensionCriteriaLevel2V2026 { - /** - * - * @type {DimensionCriteriaOperationV2026} - * @memberof DimensionCriteriaLevel2V2026 - */ - 'operation'?: DimensionCriteriaOperationV2026; - /** - * - * @type {DimensionCriteriaKeyV2026} - * @memberof DimensionCriteriaLevel2V2026 - */ - 'key'?: DimensionCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel2V2026 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof DimensionCriteriaLevel2V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Dimension membership - * @export - * @interface DimensionCriteriaLevel3V2026 - */ -export interface DimensionCriteriaLevel3V2026 { - /** - * - * @type {DimensionCriteriaOperationV2026} - * @memberof DimensionCriteriaLevel3V2026 - */ - 'operation'?: DimensionCriteriaOperationV2026; - /** - * - * @type {DimensionCriteriaKeyV2026} - * @memberof DimensionCriteriaLevel3V2026 - */ - 'key'?: DimensionCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof DimensionCriteriaLevel3V2026 - */ - 'stringValue'?: string; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const DimensionCriteriaOperationV2026 = { - Equals: 'EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type DimensionCriteriaOperationV2026 = typeof DimensionCriteriaOperationV2026[keyof typeof DimensionCriteriaOperationV2026]; - - -/** - * This enum characterizes the type of a Dimension\'s membership selector. Only the STANDARD type supported: STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression - * @export - * @enum {string} - */ - -export const DimensionMembershipSelectorTypeV2026 = { - Standard: 'STANDARD' -} as const; - -export type DimensionMembershipSelectorTypeV2026 = typeof DimensionMembershipSelectorTypeV2026[keyof typeof DimensionMembershipSelectorTypeV2026]; - - -/** - * When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. - * @export - * @interface DimensionMembershipSelectorV2026 - */ -export interface DimensionMembershipSelectorV2026 { - /** - * - * @type {DimensionMembershipSelectorTypeV2026} - * @memberof DimensionMembershipSelectorV2026 - */ - 'type'?: DimensionMembershipSelectorTypeV2026; - /** - * - * @type {DimensionCriteriaLevel1V2026} - * @memberof DimensionMembershipSelectorV2026 - */ - 'criteria'?: DimensionCriteriaLevel1V2026 | null; -} - - -/** - * - * @export - * @interface DimensionRefV2026 - */ -export interface DimensionRefV2026 { - /** - * The type of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2026 - */ - 'type'?: DimensionRefV2026TypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DimensionRefV2026 - */ - 'name'?: string; -} - -export const DimensionRefV2026TypeV2026 = { - Dimension: 'DIMENSION' -} as const; - -export type DimensionRefV2026TypeV2026 = typeof DimensionRefV2026TypeV2026[keyof typeof DimensionRefV2026TypeV2026]; - -/** - * Contains a list of dimension attributes. Required only for Dynamic Roles - * @export - * @interface DimensionSchemaV2026 - */ -export interface DimensionSchemaV2026 { - /** - * - * @type {Array} - * @memberof DimensionSchemaV2026 - */ - 'dimensionAttributes'?: Array; -} -/** - * A Dimension - * @export - * @interface DimensionV2026 - */ -export interface DimensionV2026 { - /** - * The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof DimensionV2026 - */ - 'id'?: string; - /** - * The human-readable display name of the Dimension - * @type {string} - * @memberof DimensionV2026 - */ - 'name': string; - /** - * Date the Dimension was created - * @type {string} - * @memberof DimensionV2026 - */ - 'created'?: string; - /** - * Date the Dimension was last modified. - * @type {string} - * @memberof DimensionV2026 - */ - 'modified'?: string; - /** - * A human-readable description of the Dimension - * @type {string} - * @memberof DimensionV2026 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2026} - * @memberof DimensionV2026 - */ - 'owner': OwnerReferenceV2026 | null; - /** - * - * @type {Array} - * @memberof DimensionV2026 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof DimensionV2026 - */ - 'entitlements'?: Array; - /** - * - * @type {DimensionMembershipSelectorV2026} - * @memberof DimensionV2026 - */ - 'membership'?: DimensionMembershipSelectorV2026 | null; - /** - * The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. - * @type {string} - * @memberof DimensionV2026 - */ - 'parentId'?: string | null; -} -/** - * - * @export - * @interface DisplayReferenceV2026 - */ -export interface DisplayReferenceV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof DisplayReferenceV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof DisplayReferenceV2026 - */ - 'displayName'?: string; -} -/** - * DKIM attributes for a domain or identity - * @export - * @interface DkimAttributesV2026 - */ -export interface DkimAttributesV2026 { - /** - * UUID associated with domain to be verified - * @type {string} - * @memberof DkimAttributesV2026 - */ - 'id'?: string; - /** - * The identity or domain address - * @type {string} - * @memberof DkimAttributesV2026 - */ - 'address'?: string; - /** - * Whether or not DKIM has been enabled for this domain / identity - * @type {boolean} - * @memberof DkimAttributesV2026 - */ - 'dkimEnabled'?: boolean; - /** - * The tokens to be added to a DNS for verification - * @type {Array} - * @memberof DkimAttributesV2026 - */ - 'dkimTokens'?: Array; - /** - * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING - * @type {string} - * @memberof DkimAttributesV2026 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DkimAttributesV2026 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DocumentFieldsV2026 - */ -export interface DocumentFieldsV2026 { - /** - * Name of the pod. - * @type {string} - * @memberof DocumentFieldsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof DocumentFieldsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof DocumentFieldsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof DocumentFieldsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof DocumentFieldsV2026 - */ - '_version'?: string; -} - - -/** - * Enum representing the currently supported document types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const DocumentTypeV2026 = { - Accessprofile: 'accessprofile', - Accountactivity: 'accountactivity', - Entitlement: 'entitlement', - Event: 'event', - Identity: 'identity', - Role: 'role' -} as const; - -export type DocumentTypeV2026 = typeof DocumentTypeV2026[keyof typeof DocumentTypeV2026]; - - -/** - * - * @export - * @interface DomainAddressV2026 - */ -export interface DomainAddressV2026 { - /** - * A domain address - * @type {string} - * @memberof DomainAddressV2026 - */ - 'domain'?: string; -} -/** - * Domain status DTO containing everything required to verify via DKIM - * @export - * @interface DomainStatusDtoV2026 - */ -export interface DomainStatusDtoV2026 { - /** - * New UUID associated with domain to be verified - * @type {string} - * @memberof DomainStatusDtoV2026 - */ - 'id'?: string; - /** - * A domain address - * @type {string} - * @memberof DomainStatusDtoV2026 - */ - 'domain'?: string; - /** - * DKIM is enabled for this domain - * @type {boolean} - * @memberof DomainStatusDtoV2026 - */ - 'dkimEnabled'?: boolean; - /** - * DKIM tokens required for authentication - * @type {Array} - * @memberof DomainStatusDtoV2026 - */ - 'dkimTokens'?: Array; - /** - * Status of DKIM authentication - * @type {string} - * @memberof DomainStatusDtoV2026 - */ - 'dkimVerificationStatus'?: string; - /** - * The AWS SES region the domain is associated with - * @type {string} - * @memberof DomainStatusDtoV2026 - */ - 'region'?: string; -} -/** - * - * @export - * @interface DraftResponseV2026 - */ -export interface DraftResponseV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'jobId'?: string; - /** - * Status of the job. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'status'?: DraftResponseV2026StatusV2026; - /** - * Type of the job, will always be CREATE_DRAFT for this type of job. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'type'?: DraftResponseV2026TypeV2026; - /** - * Message providing information about the outcome of the draft process. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'message'?: string; - /** - * The name of user that that initiated the draft process. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'requesterName'?: string; - /** - * Whether or not a file was generated for this draft. - * @type {boolean} - * @memberof DraftResponseV2026 - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'completed'?: string; - /** - * Name of the draft. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'name'?: string; - /** - * Tenant owner of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'sourceTenant'?: string; - /** - * Id of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'sourceBackupId'?: string; - /** - * Name of the backup from which the draft was generated. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'sourceBackupName'?: string; - /** - * Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'mode'?: DraftResponseV2026ModeV2026; - /** - * Approval status of the draft used to determine whether or not the draft can be deployed. - * @type {string} - * @memberof DraftResponseV2026 - */ - 'approvalStatus'?: DraftResponseV2026ApprovalStatusV2026; - /** - * List of comments that have been exchanged between an approval requester and an approver. - * @type {Array} - * @memberof DraftResponseV2026 - */ - 'approvalComment'?: Array; -} - -export const DraftResponseV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type DraftResponseV2026StatusV2026 = typeof DraftResponseV2026StatusV2026[keyof typeof DraftResponseV2026StatusV2026]; -export const DraftResponseV2026TypeV2026 = { - CreateDraft: 'CREATE_DRAFT' -} as const; - -export type DraftResponseV2026TypeV2026 = typeof DraftResponseV2026TypeV2026[keyof typeof DraftResponseV2026TypeV2026]; -export const DraftResponseV2026ModeV2026 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type DraftResponseV2026ModeV2026 = typeof DraftResponseV2026ModeV2026[keyof typeof DraftResponseV2026ModeV2026]; -export const DraftResponseV2026ApprovalStatusV2026 = { - Default: 'DEFAULT', - PendingApproval: 'PENDING_APPROVAL', - Approved: 'APPROVED', - Denied: 'DENIED' -} as const; - -export type DraftResponseV2026ApprovalStatusV2026 = typeof DraftResponseV2026ApprovalStatusV2026[keyof typeof DraftResponseV2026ApprovalStatusV2026]; - -/** - * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - * @export - * @enum {string} - */ - -export const DtoTypeV2026 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', - AccessProfile: 'ACCESS_PROFILE', - AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', - Account: 'ACCOUNT', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - CampaignFilter: 'CAMPAIGN_FILTER', - Certification: 'CERTIFICATION', - Cluster: 'CLUSTER', - ConnectorSchema: 'CONNECTOR_SCHEMA', - Entitlement: 'ENTITLEMENT', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityProfile: 'IDENTITY_PROFILE', - IdentityRequest: 'IDENTITY_REQUEST', - MachineIdentity: 'MACHINE_IDENTITY', - LifecycleState: 'LIFECYCLE_STATE', - PasswordPolicy: 'PASSWORD_POLICY', - Role: 'ROLE', - Rule: 'RULE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - TagCategory: 'TAG_CATEGORY', - TaskResult: 'TASK_RESULT', - ReportResult: 'REPORT_RESULT', - SodViolation: 'SOD_VIOLATION', - AccountActivity: 'ACCOUNT_ACTIVITY', - Workgroup: 'WORKGROUP' -} as const; - -export type DtoTypeV2026 = typeof DtoTypeV2026[keyof typeof DtoTypeV2026]; - - -/** - * - * @export - * @interface E164phoneV2026 - */ -export interface E164phoneV2026 { - /** - * This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - * @type {string} - * @memberof E164phoneV2026 - */ - 'defaultRegion'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof E164phoneV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof E164phoneV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * This is used for representing email configuration for a lifecycle state - * @export - * @interface EmailNotificationOptionV2026 - */ -export interface EmailNotificationOptionV2026 { - /** - * If true, then the manager is notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2026 - */ - 'notifyManagers'?: boolean; - /** - * If true, then all the admins are notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2026 - */ - 'notifyAllAdmins'?: boolean; - /** - * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOptionV2026 - */ - 'notifySpecificUsers'?: boolean; - /** - * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. - * @type {Array} - * @memberof EmailNotificationOptionV2026 - */ - 'emailAddressList'?: Array; -} -/** - * - * @export - * @interface EmailStatusDtoV2026 - */ -export interface EmailStatusDtoV2026 { - /** - * Unique identifier for the verified sender address - * @type {string} - * @memberof EmailStatusDtoV2026 - */ - 'id'?: string | null; - /** - * The verified sender email address - * @type {string} - * @memberof EmailStatusDtoV2026 - */ - 'email'?: string; - /** - * Whether the sender address is verified by domain - * @type {boolean} - * @memberof EmailStatusDtoV2026 - */ - 'isVerifiedByDomain'?: boolean; - /** - * The verification status of the sender address - * @type {string} - * @memberof EmailStatusDtoV2026 - */ - 'verificationStatus'?: EmailStatusDtoV2026VerificationStatusV2026; - /** - * The AWS SES region the sender address is associated with - * @type {string} - * @memberof EmailStatusDtoV2026 - */ - 'region'?: string | null; -} - -export const EmailStatusDtoV2026VerificationStatusV2026 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Na: 'NA' -} as const; - -export type EmailStatusDtoV2026VerificationStatusV2026 = typeof EmailStatusDtoV2026VerificationStatusV2026[keyof typeof EmailStatusDtoV2026VerificationStatusV2026]; - -/** - * The maximum duration for which the access is permitted. - * @export - * @interface EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 - */ -export interface EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 { - /** - * The numeric value of the duration. - * @type {number} - * @memberof EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 - */ - 'value'?: number; - /** - * The time unit for the duration. - * @type {string} - * @memberof EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 - */ - 'timeUnit'?: EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026TimeUnitV2026; -} - -export const EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026TimeUnitV2026 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026TimeUnitV2026 = typeof EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026TimeUnitV2026[keyof typeof EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026TimeUnitV2026]; - -/** - * - * @export - * @interface EntitlementAccessRequestConfigV2026 - */ -export interface EntitlementAccessRequestConfigV2026 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'approvalSchemes'?: Array; - /** - * If the requester must provide a comment during access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'requestCommentRequired'?: boolean; - /** - * If the reviewer must provide a comment when denying the access request. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'denialCommentRequired'?: boolean; - /** - * Is Reauthorization Required - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'reauthorizationRequired'?: boolean; - /** - * If true, then remove date or sunset date is required in access request of the entitlement. - * @type {boolean} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026} - * @memberof EntitlementAccessRequestConfigV2026 - */ - 'maxPermittedAccessDuration'?: EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 | null; -} -/** - * - * @export - * @interface EntitlementApprovalSchemeV2026 - */ -export interface EntitlementApprovalSchemeV2026 { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. - * @type {string} - * @memberof EntitlementApprovalSchemeV2026 - */ - 'approverType'?: EntitlementApprovalSchemeV2026ApproverTypeV2026; - /** - * Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW - * @type {string} - * @memberof EntitlementApprovalSchemeV2026 - */ - 'approverId'?: string | null; -} - -export const EntitlementApprovalSchemeV2026ApproverTypeV2026 = { - EntitlementOwner: 'ENTITLEMENT_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW' -} as const; - -export type EntitlementApprovalSchemeV2026ApproverTypeV2026 = typeof EntitlementApprovalSchemeV2026ApproverTypeV2026[keyof typeof EntitlementApprovalSchemeV2026ApproverTypeV2026]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateFilterRequestV2026 - */ -export interface EntitlementAttributeBulkUpdateFilterRequestV2026 { - /** - * 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* - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2026 - */ - 'filters'?: string; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2026 - */ - 'operation'?: EntitlementAttributeBulkUpdateFilterRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2026 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateFilterRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateFilterRequestV2026 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateFilterRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateFilterRequestV2026OperationV2026 = typeof EntitlementAttributeBulkUpdateFilterRequestV2026OperationV2026[keyof typeof EntitlementAttributeBulkUpdateFilterRequestV2026OperationV2026]; -export const EntitlementAttributeBulkUpdateFilterRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateFilterRequestV2026ReplaceScopeV2026 = typeof EntitlementAttributeBulkUpdateFilterRequestV2026ReplaceScopeV2026[keyof typeof EntitlementAttributeBulkUpdateFilterRequestV2026ReplaceScopeV2026]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateIdsRequestV2026 - */ -export interface EntitlementAttributeBulkUpdateIdsRequestV2026 { - /** - * List of entitlement IDs to update. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2026 - */ - 'entitlements'?: Array; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2026 - */ - 'operation'?: EntitlementAttributeBulkUpdateIdsRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2026 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateIdsRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateIdsRequestV2026 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateIdsRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateIdsRequestV2026OperationV2026 = typeof EntitlementAttributeBulkUpdateIdsRequestV2026OperationV2026[keyof typeof EntitlementAttributeBulkUpdateIdsRequestV2026OperationV2026]; -export const EntitlementAttributeBulkUpdateIdsRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateIdsRequestV2026ReplaceScopeV2026 = typeof EntitlementAttributeBulkUpdateIdsRequestV2026ReplaceScopeV2026[keyof typeof EntitlementAttributeBulkUpdateIdsRequestV2026ReplaceScopeV2026]; - -/** - * - * @export - * @interface EntitlementAttributeBulkUpdateQueryRequestV2026 - */ -export interface EntitlementAttributeBulkUpdateQueryRequestV2026 { - /** - * - * @type {SearchV2026} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2026 - */ - 'query'?: SearchV2026; - /** - * Operation to perform on the attributes in the bulk update request. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2026 - */ - 'operation'?: EntitlementAttributeBulkUpdateQueryRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2026 - */ - 'replaceScope'?: EntitlementAttributeBulkUpdateQueryRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute and values. - * @type {Array} - * @memberof EntitlementAttributeBulkUpdateQueryRequestV2026 - */ - 'values'?: Array; -} - -export const EntitlementAttributeBulkUpdateQueryRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type EntitlementAttributeBulkUpdateQueryRequestV2026OperationV2026 = typeof EntitlementAttributeBulkUpdateQueryRequestV2026OperationV2026[keyof typeof EntitlementAttributeBulkUpdateQueryRequestV2026OperationV2026]; -export const EntitlementAttributeBulkUpdateQueryRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type EntitlementAttributeBulkUpdateQueryRequestV2026ReplaceScopeV2026 = typeof EntitlementAttributeBulkUpdateQueryRequestV2026ReplaceScopeV2026[keyof typeof EntitlementAttributeBulkUpdateQueryRequestV2026ReplaceScopeV2026]; - -/** - * Object for specifying the bulk update request - * @export - * @interface EntitlementBulkUpdateRequestV2026 - */ -export interface EntitlementBulkUpdateRequestV2026 { - /** - * List of entitlement ids to update - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2026 - */ - 'entitlementIds': Array; - /** - * - * @type {Array} - * @memberof EntitlementBulkUpdateRequestV2026 - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface EntitlementConnectionBulkUpdateItemV2026 - */ -export interface EntitlementConnectionBulkUpdateItemV2026 { - /** - * Connection ID to update. - * @type {string} - * @memberof EntitlementConnectionBulkUpdateItemV2026 - */ - 'connectionId': string; - /** - * Target connection type. - * @type {string} - * @memberof EntitlementConnectionBulkUpdateItemV2026 - */ - 'type': EntitlementConnectionBulkUpdateItemV2026TypeV2026; -} - -export const EntitlementConnectionBulkUpdateItemV2026TypeV2026 = { - Jit: 'JIT', - Standing: 'STANDING' -} as const; - -export type EntitlementConnectionBulkUpdateItemV2026TypeV2026 = typeof EntitlementConnectionBulkUpdateItemV2026TypeV2026[keyof typeof EntitlementConnectionBulkUpdateItemV2026TypeV2026]; - -/** - * - * @export - * @interface EntitlementConnectionBulkUpdateResultItemV2026 - */ -export interface EntitlementConnectionBulkUpdateResultItemV2026 { - /** - * Connection ID processed in this row. - * @type {string} - * @memberof EntitlementConnectionBulkUpdateResultItemV2026 - */ - 'connectionId'?: string; - /** - * Requested or resulting connection type for the row. - * @type {string} - * @memberof EntitlementConnectionBulkUpdateResultItemV2026 - */ - 'type'?: string; - /** - * Item-level result status code. - * @type {number} - * @memberof EntitlementConnectionBulkUpdateResultItemV2026 - */ - 'status'?: number; - /** - * Item-level result message. - * @type {string} - * @memberof EntitlementConnectionBulkUpdateResultItemV2026 - */ - 'description'?: string; -} -/** - * Privilege classification details for the entitlement. - * @export - * @interface EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026 - */ -export interface EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026 { - /** - * Effective privilege level. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026 - */ - 'effective'?: string; -} -/** - * Entitlement object embedded in entitlement connection search responses. - * @export - * @interface EntitlementConnectionSearchHitEntitlementV2026 - */ -export interface EntitlementConnectionSearchHitEntitlementV2026 { - /** - * Entitlement identifier. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'id'?: string; - /** - * Entitlement name. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'name'?: string; - /** - * Human-readable entitlement label. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'displayName'?: string; - /** - * Entitlement description. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'description'?: string; - /** - * Source attribute carrying entitlement values. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'attribute'?: string; - /** - * Source entitlement value. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'value'?: string; - /** - * Source schema object type for the entitlement. - * @type {string} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * - * @type {EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026} - * @memberof EntitlementConnectionSearchHitEntitlementV2026 - */ - 'privilegeLevel'?: EntitlementConnectionSearchHitEntitlementPrivilegeLevelV2026; -} -/** - * Entitlement connection record returned by search-backed list endpoints. - * @export - * @interface EntitlementConnectionSearchHitV2026 - */ -export interface EntitlementConnectionSearchHitV2026 { - /** - * Connection ID as represented in search results. - * @type {string} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'id'?: string; - /** - * Identity summary object from search index. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'identity'?: { [key: string]: any; }; - /** - * Machine identity summary object when available. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'machineIdentity'?: { [key: string]: any; }; - /** - * Account summary object. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'account'?: { [key: string]: any; }; - /** - * - * @type {EntitlementConnectionSearchHitEntitlementV2026} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'entitlement'?: EntitlementConnectionSearchHitEntitlementV2026; - /** - * Source summary object. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'source'?: { [key: string]: any; }; - /** - * Connection state object. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'state'?: { [key: string]: any; }; - /** - * JIT timestamps for lifecycle events. - * @type {{ [key: string]: any; }} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'jit'?: { [key: string]: any; }; - /** - * Indicates whether the connection is marked as standalone. - * @type {boolean} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'standalone'?: boolean; - /** - * Connection type classification. - * @type {string} - * @memberof EntitlementConnectionSearchHitV2026 - */ - 'type'?: EntitlementConnectionSearchHitV2026TypeV2026; -} - -export const EntitlementConnectionSearchHitV2026TypeV2026 = { - Jit: 'JIT', - Standing: 'STANDING', - Na: 'NA' -} as const; - -export type EntitlementConnectionSearchHitV2026TypeV2026 = typeof EntitlementConnectionSearchHitV2026TypeV2026[keyof typeof EntitlementConnectionSearchHitV2026TypeV2026]; - -/** - * Entitlement connection entity returned by patch APIs. - * @export - * @interface EntitlementConnectionV2026 - */ -export interface EntitlementConnectionV2026 { - /** - * Tenant identifier that owns the connection. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'tenantId'?: string; - /** - * Entitlement connection identifier. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'connectionId'?: string; - /** - * Identity identifier associated with the connection. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'identityId'?: string; - /** - * Machine identity identifier when the connection is machine-backed. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'machineIdentityId'?: string; - /** - * Account identifier for the connected source account. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'accountId'?: string; - /** - * Entitlement identifier on the source. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'entitlementId'?: string; - /** - * Source identifier that provides the account and entitlement. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'sourceId'?: string; - /** - * Indicates whether the connection is marked as standalone. - * @type {boolean} - * @memberof EntitlementConnectionV2026 - */ - 'standalone'?: boolean; - /** - * Entitlement attribute name on the source. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'attributeName'?: string; - /** - * Entitlement attribute value on the source. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'attributeValue'?: string; - /** - * Connection type classification. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'type'?: EntitlementConnectionV2026TypeV2026; - /** - * Current lifecycle state of the connection. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'state'?: string; - /** - * Time the connection state was last updated. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'stateChanged'?: string; - /** - * Identifier of the actor that last changed state. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'stateChangedBy'?: string; - /** - * Time JIT activation occurred. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'jitActivation'?: string; - /** - * Time provisioning completed for JIT activation. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'jitProvision'?: string; - /** - * Time JIT deactivation occurred. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'jitDeactivation'?: string; - /** - * Time deprovisioning completed after JIT deactivation. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'jitDeprovision'?: string; - /** - * Time when JIT access expires. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'jitExpiration'?: string; - /** - * Time after which the connection is eligible for deletion. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'deleteAfter'?: string; - /** - * Time when the connection was created. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'created'?: string; - /** - * Time when the connection was last modified. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'modified'?: string; - /** - * Display value for the actor associated with the latest change. - * @type {string} - * @memberof EntitlementConnectionV2026 - */ - 'actorName'?: string; -} - -export const EntitlementConnectionV2026TypeV2026 = { - Jit: 'JIT', - Standing: 'STANDING', - Na: 'NA' -} as const; - -export type EntitlementConnectionV2026TypeV2026 = typeof EntitlementConnectionV2026TypeV2026[keyof typeof EntitlementConnectionV2026TypeV2026]; - -/** - * Indicates whether the entitlement\'s display name and/or description have been manually updated. - * @export - * @interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 - */ -export interface EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 { - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 - */ - 'DESCRIPTION'?: boolean; - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 - */ - 'DISPLAY_NAME'?: boolean; -} -/** - * - * @export - * @interface EntitlementDocumentAllOfPermissionsV2026 - */ -export interface EntitlementDocumentAllOfPermissionsV2026 { - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof EntitlementDocumentAllOfPermissionsV2026 - */ - 'target'?: string; - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof EntitlementDocumentAllOfPermissionsV2026 - */ - 'rights'?: Array; -} -/** - * Entitlement\'s source. - * @export - * @interface EntitlementDocumentAllOfSourceV2026 - */ -export interface EntitlementDocumentAllOfSourceV2026 { - /** - * ID of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2026 - */ - 'id'?: string; - /** - * Display name of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2026 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof EntitlementDocumentAllOfSourceV2026 - */ - 'type'?: string; -} -/** - * Entitlement - * @export - * @interface EntitlementDocumentV2026 - */ -export interface EntitlementDocumentV2026 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2026} - * @memberof EntitlementDocumentV2026 - */ - 'source'?: EntitlementDocumentAllOfSourceV2026; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2026 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentV2026 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentV2026 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentV2026 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentV2026 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentV2026 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentV2026 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentV2026 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2026} - * @memberof EntitlementDocumentV2026 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentV2026 - */ - 'permissions'?: Array; -} -/** - * - * @export - * @interface EntitlementDocumentsV2026 - */ -export interface EntitlementDocumentsV2026 { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSourceV2026} - * @memberof EntitlementDocumentsV2026 - */ - 'source'?: EntitlementDocumentAllOfSourceV2026; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2026 - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocumentsV2026 - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocumentsV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocumentsV2026 - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocumentsV2026 - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocumentsV2026 - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocumentsV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocumentsV2026 - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocumentsV2026 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFieldsV2026} - * @memberof EntitlementDocumentsV2026 - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFieldsV2026 | null; - /** - * - * @type {Array} - * @memberof EntitlementDocumentsV2026 - */ - 'permissions'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof EntitlementDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof EntitlementDocumentsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof EntitlementDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface EntitlementPrivilegeLevelV2026 - */ -export interface EntitlementPrivilegeLevelV2026 { - /** - * Direct privilege level assigned to the entitlement - * @type {string} - * @memberof EntitlementPrivilegeLevelV2026 - */ - 'direct'?: EntitlementPrivilegeLevelV2026DirectV2026; - /** - * User or process that set the privilege level - * @type {string} - * @memberof EntitlementPrivilegeLevelV2026 - */ - 'setBy'?: string; - /** - * Method by which the privilege level was set - * @type {string} - * @memberof EntitlementPrivilegeLevelV2026 - */ - 'setByType'?: EntitlementPrivilegeLevelV2026SetByTypeV2026 | null; - /** - * Inherited privilege level on the entitlement, if any - * @type {string} - * @memberof EntitlementPrivilegeLevelV2026 - */ - 'inherited'?: EntitlementPrivilegeLevelV2026InheritedV2026 | null; - /** - * Effective privilege level assigned to the entitlement - * @type {string} - * @memberof EntitlementPrivilegeLevelV2026 - */ - 'effective'?: EntitlementPrivilegeLevelV2026EffectiveV2026; -} - -export const EntitlementPrivilegeLevelV2026DirectV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementPrivilegeLevelV2026DirectV2026 = typeof EntitlementPrivilegeLevelV2026DirectV2026[keyof typeof EntitlementPrivilegeLevelV2026DirectV2026]; -export const EntitlementPrivilegeLevelV2026SetByTypeV2026 = { - Override: 'OVERRIDE', - CustomCriteria: 'CUSTOM_CRITERIA', - ConnectorCriteria: 'CONNECTOR_CRITERIA', - SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA' -} as const; - -export type EntitlementPrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementPrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementPrivilegeLevelV2026SetByTypeV2026]; -export const EntitlementPrivilegeLevelV2026InheritedV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementPrivilegeLevelV2026InheritedV2026 = typeof EntitlementPrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementPrivilegeLevelV2026InheritedV2026]; -export const EntitlementPrivilegeLevelV2026EffectiveV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementPrivilegeLevelV2026EffectiveV2026 = typeof EntitlementPrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementPrivilegeLevelV2026EffectiveV2026]; - -/** - * Request body for assigning a set of entitlement recommendations to a reviewer. - * @export - * @interface EntitlementRecommendationAssignRequestV2026 - */ -export interface EntitlementRecommendationAssignRequestV2026 { - /** - * The list of recommendation record IDs to assign. - * @type {Array} - * @memberof EntitlementRecommendationAssignRequestV2026 - */ - 'items': Array; - /** - * - * @type {EntitlementRecommendationAssigneeV2026} - * @memberof EntitlementRecommendationAssignRequestV2026 - */ - 'assignee': EntitlementRecommendationAssigneeV2026; -} -/** - * Response body returned when entitlement recommendations are successfully queued for assignment. - * @export - * @interface EntitlementRecommendationAssignResultV2026 - */ -export interface EntitlementRecommendationAssignResultV2026 { - /** - * The unique identifier of the assignment batch created by this request. - * @type {string} - * @memberof EntitlementRecommendationAssignResultV2026 - */ - 'batchId'?: string; -} -/** - * Assign to the source owner or entitlement owner role. No value field is required. - * @export - * @interface EntitlementRecommendationAssigneeOneOf1V2026 - */ -export interface EntitlementRecommendationAssigneeOneOf1V2026 { - /** - * The type of assignee. - * @type {string} - * @memberof EntitlementRecommendationAssigneeOneOf1V2026 - */ - 'type': EntitlementRecommendationAssigneeOneOf1V2026TypeV2026; -} - -export const EntitlementRecommendationAssigneeOneOf1V2026TypeV2026 = { - SourceOwner: 'SOURCE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER' -} as const; - -export type EntitlementRecommendationAssigneeOneOf1V2026TypeV2026 = typeof EntitlementRecommendationAssigneeOneOf1V2026TypeV2026[keyof typeof EntitlementRecommendationAssigneeOneOf1V2026TypeV2026]; - -/** - * Assign to a specific identity or governance group. The value field is required and must be the ID of the identity or governance group. - * @export - * @interface EntitlementRecommendationAssigneeOneOfV2026 - */ -export interface EntitlementRecommendationAssigneeOneOfV2026 { - /** - * The type of assignee. - * @type {string} - * @memberof EntitlementRecommendationAssigneeOneOfV2026 - */ - 'type': EntitlementRecommendationAssigneeOneOfV2026TypeV2026; - /** - * The ID of the identity or governance group to assign to. - * @type {string} - * @memberof EntitlementRecommendationAssigneeOneOfV2026 - */ - 'value': string; -} - -export const EntitlementRecommendationAssigneeOneOfV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type EntitlementRecommendationAssigneeOneOfV2026TypeV2026 = typeof EntitlementRecommendationAssigneeOneOfV2026TypeV2026[keyof typeof EntitlementRecommendationAssigneeOneOfV2026TypeV2026]; - -/** - * @type EntitlementRecommendationAssigneeV2026 - * Describes the target assignee for entitlement recommendations. - * @export - */ -export type EntitlementRecommendationAssigneeV2026 = EntitlementRecommendationAssigneeOneOf1V2026 | EntitlementRecommendationAssigneeOneOfV2026; - -/** - * A unified entitlement recommendation record representing either a SED (Suggested Entitlement Description) or a privilege recommendation. - * @export - * @interface EntitlementRecommendationRecordV2026 - */ -export interface EntitlementRecommendationRecordV2026 { - /** - * The type of recommendation. \"SED\" indicates a suggested description recommendation; \"privilege\" indicates a privilege-level recommendation. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'recordType'?: EntitlementRecommendationRecordV2026RecordTypeV2026; - /** - * The unique identifier for this recommendation record. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'id'?: string; - /** - * The entitlement attribute name (e.g. \"groups\"). - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'attribute'?: string | null; - /** - * The human-readable display name of the entitlement. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'displayName'?: string | null; - /** - * The internal name of the entitlement. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'name'?: string | null; - /** - * The ID of the source that owns this entitlement. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'sourceId'?: string; - /** - * The display name of the source that owns this entitlement. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'sourceName'?: string; - /** - * The current review status of the recommendation. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'status'?: string; - /** - * The entitlement type (e.g. \"group\"). - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'type'?: string | null; - /** - * The entitlement value or identifier. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'value'?: string; - /** - * The current description of the entitlement, if one exists. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'description'?: string | null; - /** - * The AI-generated suggested description for the entitlement (SED records only). - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'suggestedDescription'?: string | null; - /** - * The current privilege level assigned to the entitlement. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'privilege'?: string | null; - /** - * The AI-suggested privilege level for the entitlement (privilege records only). - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'suggestedPrivilege'?: string | null; - /** - * The ID of the identity who approved this recommendation. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'approvedBy'?: string | null; - /** - * How the recommendation was approved (e.g. \"direct\"). - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'approvedType'?: string | null; - /** - * The timestamp when the recommendation was approved. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'approvedWhen'?: string | null; - /** - * The timestamp when the LLM batch that generated this recommendation was created. - * @type {string} - * @memberof EntitlementRecommendationRecordV2026 - */ - 'llmBatchCreatedAt'?: string | null; -} - -export const EntitlementRecommendationRecordV2026RecordTypeV2026 = { - Sed: 'SED', - Privilege: 'privilege' -} as const; - -export type EntitlementRecommendationRecordV2026RecordTypeV2026 = typeof EntitlementRecommendationRecordV2026RecordTypeV2026[keyof typeof EntitlementRecommendationRecordV2026RecordTypeV2026]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface EntitlementRefV2026 - */ -export interface EntitlementRefV2026 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof EntitlementRefV2026 - */ - 'type'?: EntitlementRefV2026TypeV2026; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof EntitlementRefV2026 - */ - 'id'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementRefV2026 - */ - 'name'?: string | null; -} - -export const EntitlementRefV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type EntitlementRefV2026TypeV2026 = typeof EntitlementRefV2026TypeV2026[keyof typeof EntitlementRefV2026TypeV2026]; - -/** - * - * @export - * @interface EntitlementRequestConfigV2026 - */ -export interface EntitlementRequestConfigV2026 { - /** - * - * @type {EntitlementAccessRequestConfigV2026} - * @memberof EntitlementRequestConfigV2026 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2026; - /** - * - * @type {EntitlementRevocationRequestConfigV2026} - * @memberof EntitlementRequestConfigV2026 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2026; -} -/** - * - * @export - * @interface EntitlementRevocationRequestConfigV2026 - */ -export interface EntitlementRevocationRequestConfigV2026 { - /** - * Ordered list of approval steps for the access request. Empty when no approval is required. - * @type {Array} - * @memberof EntitlementRevocationRequestConfigV2026 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface EntitlementSourceResetBaseReferenceDtoV2026 - */ -export interface EntitlementSourceResetBaseReferenceDtoV2026 { - /** - * The DTO type - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2026 - */ - 'type'?: string; - /** - * The task ID of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof EntitlementSourceResetBaseReferenceDtoV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface EntitlementSourceV2026 - */ -export interface EntitlementSourceV2026 { - /** - * The source ID - * @type {string} - * @memberof EntitlementSourceV2026 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementSourceV2026 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementSourceV2026 - */ - 'name'?: string; -} -/** - * EntitlementReference - * @export - * @interface EntitlementSummaryV2026 - */ -export interface EntitlementSummaryV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'description'?: string | null; - /** - * - * @type {Reference1V2026} - * @memberof EntitlementSummaryV2026 - */ - 'source'?: Reference1V2026; - /** - * Type of the access item. - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2026 - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummaryV2026 - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummaryV2026 - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface EntitlementV2026 - */ -export interface EntitlementV2026 { - /** - * The entitlement id - * @type {string} - * @memberof EntitlementV2026 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof EntitlementV2026 - */ - 'name'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof EntitlementV2026 - */ - 'attribute'?: string; - /** - * The value of the entitlement - * @type {string} - * @memberof EntitlementV2026 - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof EntitlementV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof EntitlementV2026 - */ - 'description'?: string | null; - /** - * True if the entitlement is privileged - * @type {boolean} - * @memberof EntitlementV2026 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof EntitlementV2026 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement is able to be directly requested - * @type {boolean} - * @memberof EntitlementV2026 - */ - 'requestable'?: boolean; - /** - * - * @type {EntitlementV2OwnerV2026} - * @memberof EntitlementV2026 - */ - 'owner'?: EntitlementV2OwnerV2026 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof EntitlementV2026 - */ - 'additionalOwners'?: Array | null; - /** - * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2026 - */ - 'manuallyUpdatedFields'?: { [key: string]: any; } | null; - /** - * - * @type {EntitlementV2AccessModelMetadataV2026} - * @memberof EntitlementV2026 - */ - 'accessModelMetadata'?: EntitlementV2AccessModelMetadataV2026; - /** - * Time when the entitlement was created - * @type {string} - * @memberof EntitlementV2026 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof EntitlementV2026 - */ - 'modified'?: string; - /** - * - * @type {EntitlementSourceV2026} - * @memberof EntitlementV2026 - */ - 'source'?: EntitlementSourceV2026; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof EntitlementV2026 - */ - 'segments'?: Array | null; - /** - * - * @type {Array} - * @memberof EntitlementV2026 - */ - 'directPermissions'?: Array; -} -/** - * Additional data to classify the entitlement - * @export - * @interface EntitlementV2AccessModelMetadataV2026 - */ -export interface EntitlementV2AccessModelMetadataV2026 { - /** - * - * @type {Array} - * @memberof EntitlementV2AccessModelMetadataV2026 - */ - 'attributes'?: Array; -} -/** - * The identity that owns the entitlement - * @export - * @interface EntitlementV2OwnerV2026 - */ -export interface EntitlementV2OwnerV2026 { - /** - * The identity ID - * @type {string} - * @memberof EntitlementV2OwnerV2026 - */ - 'id'?: string; - /** - * The type of object - * @type {string} - * @memberof EntitlementV2OwnerV2026 - */ - 'type'?: EntitlementV2OwnerV2026TypeV2026; - /** - * The display name of the identity - * @type {string} - * @memberof EntitlementV2OwnerV2026 - */ - 'name'?: string; -} - -export const EntitlementV2OwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type EntitlementV2OwnerV2026TypeV2026 = typeof EntitlementV2OwnerV2026TypeV2026[keyof typeof EntitlementV2OwnerV2026TypeV2026]; - -/** - * - * @export - * @interface EntitlementV2PrivilegeLevelV2026 - */ -export interface EntitlementV2PrivilegeLevelV2026 { - /** - * Direct privilege level assigned to the entitlement - * @type {string} - * @memberof EntitlementV2PrivilegeLevelV2026 - */ - 'direct'?: EntitlementV2PrivilegeLevelV2026DirectV2026; - /** - * User or process that set the privilege level - * @type {string} - * @memberof EntitlementV2PrivilegeLevelV2026 - */ - 'setBy'?: string; - /** - * Method by which the privilege level was set - * @type {string} - * @memberof EntitlementV2PrivilegeLevelV2026 - */ - 'setByType'?: EntitlementV2PrivilegeLevelV2026SetByTypeV2026 | null; - /** - * Inherited privilege level on the entitlement, if any - * @type {string} - * @memberof EntitlementV2PrivilegeLevelV2026 - */ - 'inherited'?: EntitlementV2PrivilegeLevelV2026InheritedV2026 | null; - /** - * Effective privilege level assigned to the entitlement - * @type {string} - * @memberof EntitlementV2PrivilegeLevelV2026 - */ - 'effective'?: EntitlementV2PrivilegeLevelV2026EffectiveV2026; -} - -export const EntitlementV2PrivilegeLevelV2026DirectV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementV2PrivilegeLevelV2026DirectV2026 = typeof EntitlementV2PrivilegeLevelV2026DirectV2026[keyof typeof EntitlementV2PrivilegeLevelV2026DirectV2026]; -export const EntitlementV2PrivilegeLevelV2026SetByTypeV2026 = { - Override: 'OVERRIDE', - CustomCriteria: 'CUSTOM_CRITERIA', - ConnectorCriteria: 'CONNECTOR_CRITERIA', - SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA' -} as const; - -export type EntitlementV2PrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementV2PrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementV2PrivilegeLevelV2026SetByTypeV2026]; -export const EntitlementV2PrivilegeLevelV2026InheritedV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementV2PrivilegeLevelV2026InheritedV2026 = typeof EntitlementV2PrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementV2PrivilegeLevelV2026InheritedV2026]; -export const EntitlementV2PrivilegeLevelV2026EffectiveV2026 = { - High: 'HIGH', - Low: 'LOW', - Medium: 'MEDIUM', - None: 'NONE' -} as const; - -export type EntitlementV2PrivilegeLevelV2026EffectiveV2026 = typeof EntitlementV2PrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementV2PrivilegeLevelV2026EffectiveV2026]; - -/** - * - * @export - * @interface EntitlementV2SourceV2026 - */ -export interface EntitlementV2SourceV2026 { - /** - * The source ID - * @type {string} - * @memberof EntitlementV2SourceV2026 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementV2SourceV2026 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementV2SourceV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface EntitlementV2V2026 - */ -export interface EntitlementV2V2026 { - /** - * The entitlement id - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'name'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'attribute'?: string; - /** - * The value of the entitlement - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'description'?: string | null; - /** - * - * @type {EntitlementV2PrivilegeLevelV2026} - * @memberof EntitlementV2V2026 - */ - 'privilegeLevel'?: EntitlementV2PrivilegeLevelV2026; - /** - * List of tags assigned to the entitlement - * @type {Array} - * @memberof EntitlementV2V2026 - */ - 'tags'?: Array | null; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof EntitlementV2V2026 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement is able to be directly requested - * @type {boolean} - * @memberof EntitlementV2V2026 - */ - 'requestable'?: boolean; - /** - * - * @type {EntitlementV2OwnerV2026} - * @memberof EntitlementV2V2026 - */ - 'owner'?: EntitlementV2OwnerV2026 | null; - /** - * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2V2026 - */ - 'manuallyUpdatedFields'?: { [key: string]: any; } | null; - /** - * - * @type {EntitlementV2AccessModelMetadataV2026} - * @memberof EntitlementV2V2026 - */ - 'accessModelMetadata'?: EntitlementV2AccessModelMetadataV2026; - /** - * Time when the entitlement was created - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof EntitlementV2V2026 - */ - 'modified'?: string; - /** - * - * @type {EntitlementV2SourceV2026} - * @memberof EntitlementV2V2026 - */ - 'source'?: EntitlementV2SourceV2026; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof EntitlementV2V2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof EntitlementV2V2026 - */ - 'segments'?: Array | null; - /** - * - * @type {Array} - * @memberof EntitlementV2V2026 - */ - 'directPermissions'?: Array; -} -/** - * - * @export - * @interface EntityCreatedByDTOV2026 - */ -export interface EntityCreatedByDTOV2026 { - /** - * ID of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2026 - */ - 'id'?: string; - /** - * The display name of the creator - * @type {string} - * @memberof EntityCreatedByDTOV2026 - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface ErrorMessageDtoV2026 - */ -export interface ErrorMessageDtoV2026 { - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof ErrorMessageDtoV2026 - */ - 'locale'?: string | null; - /** - * - * @type {LocaleOriginV2026} - * @memberof ErrorMessageDtoV2026 - */ - 'localeOrigin'?: LocaleOriginV2026 | null; - /** - * Actual text of the error message in the indicated locale. - * @type {string} - * @memberof ErrorMessageDtoV2026 - */ - 'text'?: string; -} - - -/** - * - * @export - * @interface ErrorMessageV2026 - */ -export interface ErrorMessageV2026 { - /** - * Locale is the current Locale - * @type {string} - * @memberof ErrorMessageV2026 - */ - 'locale'?: string; - /** - * LocaleOrigin holds possible values of how the locale was selected - * @type {string} - * @memberof ErrorMessageV2026 - */ - 'localeOrigin'?: string; - /** - * Text is the actual text of the error message - * @type {string} - * @memberof ErrorMessageV2026 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ErrorResponseDtoV2026 - */ -export interface ErrorResponseDtoV2026 { - /** - * Fine-grained error code providing more detail of the error. - * @type {string} - * @memberof ErrorResponseDtoV2026 - */ - 'detailCode'?: string; - /** - * Unique tracking id for the error. - * @type {string} - * @memberof ErrorResponseDtoV2026 - */ - 'trackingId'?: string; - /** - * Generic localized reason for error - * @type {Array} - * @memberof ErrorResponseDtoV2026 - */ - 'messages'?: Array; - /** - * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field - * @type {Array} - * @memberof ErrorResponseDtoV2026 - */ - 'causes'?: Array; -} -/** - * - * @export - * @interface ErrorV2026 - */ -export interface ErrorV2026 { - /** - * DetailCode is the text of the status code returned - * @type {string} - * @memberof ErrorV2026 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof ErrorV2026 - */ - 'messages'?: Array; - /** - * TrackingID is the request tracking unique identifier - * @type {string} - * @memberof ErrorV2026 - */ - 'trackingId'?: string; -} -/** - * The response body for Evaluate Reassignment Configuration - * @export - * @interface EvaluateResponseV2026 - */ -export interface EvaluateResponseV2026 { - /** - * The Identity ID which should be the recipient of any work items sent to a specific identity & work type - * @type {string} - * @memberof EvaluateResponseV2026 - */ - 'reassignToId'?: string; - /** - * List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration - * @type {Array} - * @memberof EvaluateResponseV2026 - */ - 'lookupTrail'?: Array; -} -/** - * - * @export - * @interface EventActorV2026 - */ -export interface EventActorV2026 { - /** - * Name of the actor that generated the event. - * @type {string} - * @memberof EventActorV2026 - */ - 'name'?: string; -} -/** - * Attributes related to an IdentityNow ETS event - * @export - * @interface EventAttributesV2026 - */ -export interface EventAttributesV2026 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof EventAttributesV2026 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof EventAttributesV2026 - */ - 'filter.$'?: string | null; - /** - * Description of the event trigger - * @type {string} - * @memberof EventAttributesV2026 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof EventAttributesV2026 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof EventAttributesV2026 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface EventBridgeConfigV2026 - */ -export interface EventBridgeConfigV2026 { - /** - * AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. - * @type {string} - * @memberof EventBridgeConfigV2026 - */ - 'awsAccount': string; - /** - * AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. - * @type {string} - * @memberof EventBridgeConfigV2026 - */ - 'awsRegion': string; -} -/** - * Event - * @export - * @interface EventDocumentV2026 - */ -export interface EventDocumentV2026 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'type'?: string; - /** - * - * @type {EventActorV2026} - * @memberof EventDocumentV2026 - */ - 'actor'?: EventActorV2026; - /** - * - * @type {EventTargetV2026} - * @memberof EventDocumentV2026 - */ - 'target'?: EventTargetV2026; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentV2026 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentV2026 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface EventDocumentsV2026 - */ -export interface EventDocumentsV2026 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'type'?: string; - /** - * - * @type {EventActorV2026} - * @memberof EventDocumentsV2026 - */ - 'actor'?: EventActorV2026; - /** - * - * @type {EventTargetV2026} - * @memberof EventDocumentsV2026 - */ - 'target'?: EventTargetV2026; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocumentsV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocumentsV2026 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'technicalName'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'pod'?: string; - /** - * - * @type {string} - * @memberof EventDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof EventDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {string} - * @memberof EventDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface EventTargetV2026 - */ -export interface EventTargetV2026 { - /** - * Name of the target, or recipient, of the event. - * @type {string} - * @memberof EventTargetV2026 - */ - 'name'?: string; -} -/** - * Event - * @export - * @interface EventV2026 - */ -export interface EventV2026 { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventV2026 - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventV2026 - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventV2026 - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventV2026 - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventV2026 - */ - 'type'?: string; - /** - * - * @type {EventActorV2026} - * @memberof EventV2026 - */ - 'actor'?: EventActorV2026; - /** - * - * @type {EventTargetV2026} - * @memberof EventV2026 - */ - 'target'?: EventTargetV2026; - /** - * The event\'s stack. - * @type {string} - * @memberof EventV2026 - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventV2026 - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventV2026 - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventV2026 - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventV2026 - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventV2026 - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventV2026 - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventV2026 - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface ExceptionAccessCriteriaV2026 - */ -export interface ExceptionAccessCriteriaV2026 { - /** - * - * @type {ExceptionCriteriaV2026} - * @memberof ExceptionAccessCriteriaV2026 - */ - 'leftCriteria'?: ExceptionCriteriaV2026; - /** - * - * @type {ExceptionCriteriaV2026} - * @memberof ExceptionAccessCriteriaV2026 - */ - 'rightCriteria'?: ExceptionCriteriaV2026; -} -/** - * Access reference with addition of boolean existing flag to indicate whether the access was extant - * @export - * @interface ExceptionCriteriaAccessV2026 - */ -export interface ExceptionCriteriaAccessV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof ExceptionCriteriaAccessV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccessV2026 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaAccessV2026 - */ - 'existing'?: boolean; -} - - -/** - * The types of objects supported for SOD violations - * @export - * @interface ExceptionCriteriaCriteriaListInnerV2026 - */ -export interface ExceptionCriteriaCriteriaListInnerV2026 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ExceptionCriteriaCriteriaListInnerV2026 - */ - 'type'?: ExceptionCriteriaCriteriaListInnerV2026TypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInnerV2026 - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaCriteriaListInnerV2026 - */ - 'existing'?: boolean; -} - -export const ExceptionCriteriaCriteriaListInnerV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ExceptionCriteriaCriteriaListInnerV2026TypeV2026 = typeof ExceptionCriteriaCriteriaListInnerV2026TypeV2026[keyof typeof ExceptionCriteriaCriteriaListInnerV2026TypeV2026]; - -/** - * - * @export - * @interface ExceptionCriteriaV2026 - */ -export interface ExceptionCriteriaV2026 { - /** - * List of exception criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof ExceptionCriteriaV2026 - */ - 'criteriaList'?: Array; -} -/** - * The current state of execution. - * @export - * @enum {string} - */ - -export const ExecutionStatusV2026 = { - Executing: 'EXECUTING', - Verifying: 'VERIFYING', - Terminated: 'TERMINATED', - Completed: 'COMPLETED' -} as const; - -export type ExecutionStatusV2026 = typeof ExecutionStatusV2026[keyof typeof ExecutionStatusV2026]; - - -/** - * - * @export - * @interface ExpansionItemV2026 - */ -export interface ExpansionItemV2026 { - /** - * The ID of the account - * @type {string} - * @memberof ExpansionItemV2026 - */ - 'accountId'?: string; - /** - * Cause of the expansion item. - * @type {string} - * @memberof ExpansionItemV2026 - */ - 'cause'?: string; - /** - * The name of the item - * @type {string} - * @memberof ExpansionItemV2026 - */ - 'name'?: string; - /** - * - * @type {AttributeRequestV2026} - * @memberof ExpansionItemV2026 - */ - 'attributeRequest'?: AttributeRequestV2026; - /** - * - * @type {AccountSourceV2026} - * @memberof ExpansionItemV2026 - */ - 'source'?: AccountSourceV2026; - /** - * ID of the expansion item - * @type {string} - * @memberof ExpansionItemV2026 - */ - 'id'?: string; - /** - * State of the expansion item - * @type {string} - * @memberof ExpansionItemV2026 - */ - 'state'?: string; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2026 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerSelfV2026 { - /** - * - * @type {FormDefinitionSelfImportExportDtoV2026} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerSelfV2026 - */ - 'object'?: FormDefinitionSelfImportExportDtoV2026; -} -/** - * - * @export - * @interface ExportFormDefinitionsByTenant200ResponseInnerV2026 - */ -export interface ExportFormDefinitionsByTenant200ResponseInnerV2026 { - /** - * - * @type {FormDefinitionResponseV2026} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2026 - */ - 'object'?: FormDefinitionResponseV2026; - /** - * - * @type {ExportFormDefinitionsByTenant200ResponseInnerSelfV2026} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2026 - */ - 'self'?: ExportFormDefinitionsByTenant200ResponseInnerSelfV2026; - /** - * - * @type {number} - * @memberof ExportFormDefinitionsByTenant200ResponseInnerV2026 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ExportOptions1V2026 - */ -export interface ExportOptions1V2026 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptions1V2026 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptions1V2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2026; }} - * @memberof ExportOptions1V2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2026; }; -} - -export const ExportOptions1V2026ExcludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2026ExcludeTypesV2026 = typeof ExportOptions1V2026ExcludeTypesV2026[keyof typeof ExportOptions1V2026ExcludeTypesV2026]; -export const ExportOptions1V2026IncludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptions1V2026IncludeTypesV2026 = typeof ExportOptions1V2026IncludeTypesV2026[keyof typeof ExportOptions1V2026IncludeTypesV2026]; - -/** - * - * @export - * @interface ExportOptionsV2026 - */ -export interface ExportOptionsV2026 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportOptionsV2026 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportOptionsV2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2026; }} - * @memberof ExportOptionsV2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2026; }; -} - -export const ExportOptionsV2026ExcludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2026ExcludeTypesV2026 = typeof ExportOptionsV2026ExcludeTypesV2026[keyof typeof ExportOptionsV2026ExcludeTypesV2026]; -export const ExportOptionsV2026IncludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportOptionsV2026IncludeTypesV2026 = typeof ExportOptionsV2026IncludeTypesV2026[keyof typeof ExportOptionsV2026IncludeTypesV2026]; - -/** - * - * @export - * @interface ExportPayloadV2026 - */ -export interface ExportPayloadV2026 { - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof ExportPayloadV2026 - */ - 'description'?: string; - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ExportPayloadV2026 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ExportPayloadV2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2026; }} - * @memberof ExportPayloadV2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2026; }; -} - -export const ExportPayloadV2026ExcludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2026ExcludeTypesV2026 = typeof ExportPayloadV2026ExcludeTypesV2026[keyof typeof ExportPayloadV2026ExcludeTypesV2026]; -export const ExportPayloadV2026IncludeTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ExportPayloadV2026IncludeTypesV2026 = typeof ExportPayloadV2026IncludeTypesV2026[keyof typeof ExportPayloadV2026IncludeTypesV2026]; - -/** - * - * @export - * @interface ExpressionChildrenInnerV2026 - */ -export interface ExpressionChildrenInnerV2026 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionChildrenInnerV2026 - */ - 'operator'?: ExpressionChildrenInnerV2026OperatorV2026; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionChildrenInnerV2026 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2026} - * @memberof ExpressionChildrenInnerV2026 - */ - 'value'?: ValueV2026 | null; - /** - * There cannot be anymore nested children. This will always be null. - * @type {string} - * @memberof ExpressionChildrenInnerV2026 - */ - 'children'?: string | null; -} - -export const ExpressionChildrenInnerV2026OperatorV2026 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionChildrenInnerV2026OperatorV2026 = typeof ExpressionChildrenInnerV2026OperatorV2026[keyof typeof ExpressionChildrenInnerV2026OperatorV2026]; - -/** - * - * @export - * @interface ExpressionV2026 - */ -export interface ExpressionV2026 { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionV2026 - */ - 'operator'?: ExpressionV2026OperatorV2026; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionV2026 - */ - 'attribute'?: string | null; - /** - * - * @type {ValueV2026} - * @memberof ExpressionV2026 - */ - 'value'?: ValueV2026 | null; - /** - * List of expressions - * @type {Array} - * @memberof ExpressionV2026 - */ - 'children'?: Array | null; -} - -export const ExpressionV2026OperatorV2026 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionV2026OperatorV2026 = typeof ExpressionV2026OperatorV2026[keyof typeof ExpressionV2026OperatorV2026]; - -/** - * Attributes related to an external trigger - * @export - * @interface ExternalAttributesV2026 - */ -export interface ExternalAttributesV2026 { - /** - * A unique name for the external trigger - * @type {string} - * @memberof ExternalAttributesV2026 - */ - 'name'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof ExternalAttributesV2026 - */ - 'description'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof ExternalAttributesV2026 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof ExternalAttributesV2026 - */ - 'url'?: string | null; -} -/** - * - * @export - * @interface FeatureValueDtoV2026 - */ -export interface FeatureValueDtoV2026 { - /** - * The type of feature - * @type {string} - * @memberof FeatureValueDtoV2026 - */ - 'feature'?: string; - /** - * The number of identities that have access to the feature - * @type {number} - * @memberof FeatureValueDtoV2026 - */ - 'numerator'?: number; - /** - * The number of identities with the corresponding feature - * @type {number} - * @memberof FeatureValueDtoV2026 - */ - 'denominator'?: number; -} -/** - * - * @export - * @interface FederationProtocolDetailsV2026 - */ -export interface FederationProtocolDetailsV2026 { - /** - * Federation protocol role - * @type {string} - * @memberof FederationProtocolDetailsV2026 - */ - 'role'?: FederationProtocolDetailsV2026RoleV2026; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof FederationProtocolDetailsV2026 - */ - 'entityId'?: string; -} - -export const FederationProtocolDetailsV2026RoleV2026 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type FederationProtocolDetailsV2026RoleV2026 = typeof FederationProtocolDetailsV2026RoleV2026[keyof typeof FederationProtocolDetailsV2026RoleV2026]; - -/** - * - * @export - * @interface FieldDetailsDtoV2026 - */ -export interface FieldDetailsDtoV2026 { - /** - * The name of the attribute. - * @type {string} - * @memberof FieldDetailsDtoV2026 - */ - 'name'?: string; - /** - * The transform to apply to the field - * @type {object} - * @memberof FieldDetailsDtoV2026 - */ - 'transform'?: object; - /** - * Attributes required for the transform - * @type {object} - * @memberof FieldDetailsDtoV2026 - */ - 'attributes'?: object; - /** - * Flag indicating whether or not the attribute is required. - * @type {boolean} - * @memberof FieldDetailsDtoV2026 - */ - 'isRequired'?: boolean; - /** - * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. - * @type {string} - * @memberof FieldDetailsDtoV2026 - */ - 'type'?: FieldDetailsDtoV2026TypeV2026; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof FieldDetailsDtoV2026 - */ - 'isMultiValued'?: boolean; -} - -export const FieldDetailsDtoV2026TypeV2026 = { - String: 'string', - Int: 'int', - Long: 'long', - Date: 'date', - Boolean: 'boolean', - Secret: 'secret' -} as const; - -export type FieldDetailsDtoV2026TypeV2026 = typeof FieldDetailsDtoV2026TypeV2026[keyof typeof FieldDetailsDtoV2026TypeV2026]; - -/** - * An additional filter to constrain the results of the search query. - * @export - * @interface FilterAggregationV2026 - */ -export interface FilterAggregationV2026 { - /** - * The name of the filter aggregate to be included in the result. - * @type {string} - * @memberof FilterAggregationV2026 - */ - 'name': string; - /** - * - * @type {SearchFilterTypeV2026} - * @memberof FilterAggregationV2026 - */ - 'type'?: SearchFilterTypeV2026; - /** - * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof FilterAggregationV2026 - */ - 'field': string; - /** - * The value to filter on. - * @type {string} - * @memberof FilterAggregationV2026 - */ - 'value': string; -} - - -/** - * Enum representing the currently supported filter types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const FilterTypeV2026 = { - Exists: 'EXISTS', - Range: 'RANGE', - Terms: 'TERMS' -} as const; - -export type FilterTypeV2026 = typeof FilterTypeV2026[keyof typeof FilterTypeV2026]; - - -/** - * - * @export - * @interface FilterV2026 - */ -export interface FilterV2026 { - /** - * - * @type {FilterTypeV2026} - * @memberof FilterV2026 - */ - 'type'?: FilterTypeV2026; - /** - * - * @type {RangeV2026} - * @memberof FilterV2026 - */ - 'range'?: RangeV2026; - /** - * The terms to be filtered. - * @type {Array} - * @memberof FilterV2026 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof FilterV2026 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface FirstValidV2026 - */ -export interface FirstValidV2026 { - /** - * An array of attributes to evaluate for existence. - * @type {Array} - * @memberof FirstValidV2026 - */ - 'values': Array; - /** - * a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - * @type {boolean} - * @memberof FirstValidV2026 - */ - 'ignoreErrors'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof FirstValidV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Represent a form conditional. - * @export - * @interface FormConditionV2026 - */ -export interface FormConditionV2026 { - /** - * ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr - * @type {string} - * @memberof FormConditionV2026 - */ - 'ruleOperator'?: FormConditionV2026RuleOperatorV2026; - /** - * List of rules. - * @type {Array} - * @memberof FormConditionV2026 - */ - 'rules'?: Array; - /** - * List of effects. - * @type {Array} - * @memberof FormConditionV2026 - */ - 'effects'?: Array; -} - -export const FormConditionV2026RuleOperatorV2026 = { - And: 'AND', - Or: 'OR' -} as const; - -export type FormConditionV2026RuleOperatorV2026 = typeof FormConditionV2026RuleOperatorV2026[keyof typeof FormConditionV2026RuleOperatorV2026]; - -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestAttributesV2026 - */ -export interface FormDefinitionDynamicSchemaRequestAttributesV2026 { - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestAttributesV2026 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaRequestV2026 - */ -export interface FormDefinitionDynamicSchemaRequestV2026 { - /** - * - * @type {FormDefinitionDynamicSchemaRequestAttributesV2026} - * @memberof FormDefinitionDynamicSchemaRequestV2026 - */ - 'attributes'?: FormDefinitionDynamicSchemaRequestAttributesV2026; - /** - * Description is the form definition dynamic schema description text - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2026 - */ - 'description'?: string; - /** - * ID is a unique identifier - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2026 - */ - 'id'?: string; - /** - * Type is the form definition dynamic schema type - * @type {string} - * @memberof FormDefinitionDynamicSchemaRequestV2026 - */ - 'type'?: string; - /** - * VersionNumber is the form definition dynamic schema version number - * @type {number} - * @memberof FormDefinitionDynamicSchemaRequestV2026 - */ - 'versionNumber'?: number; -} -/** - * - * @export - * @interface FormDefinitionDynamicSchemaResponseV2026 - */ -export interface FormDefinitionDynamicSchemaResponseV2026 { - /** - * OutputSchema holds a JSON schema generated dynamically - * @type {{ [key: string]: object; }} - * @memberof FormDefinitionDynamicSchemaResponseV2026 - */ - 'outputSchema'?: { [key: string]: object; }; -} -/** - * - * @export - * @interface FormDefinitionFileUploadResponseV2026 - */ -export interface FormDefinitionFileUploadResponseV2026 { - /** - * Created is the date the file was uploaded - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2026 - */ - 'created'?: string; - /** - * fileId is a unique ULID that serves as an identifier for the form definition file - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2026 - */ - 'fileId'?: string; - /** - * FormDefinitionID is a unique guid identifying this form definition - * @type {string} - * @memberof FormDefinitionFileUploadResponseV2026 - */ - 'formDefinitionId'?: string; -} -/** - * - * @export - * @interface FormDefinitionInputV2026 - */ -export interface FormDefinitionInputV2026 { - /** - * Unique identifier for the form input. - * @type {string} - * @memberof FormDefinitionInputV2026 - */ - 'id'?: string; - /** - * FormDefinitionInputType value. STRING FormDefinitionInputTypeString - * @type {string} - * @memberof FormDefinitionInputV2026 - */ - 'type'?: FormDefinitionInputV2026TypeV2026; - /** - * Name for the form input. - * @type {string} - * @memberof FormDefinitionInputV2026 - */ - 'label'?: string; - /** - * Form input\'s description. - * @type {string} - * @memberof FormDefinitionInputV2026 - */ - 'description'?: string; -} - -export const FormDefinitionInputV2026TypeV2026 = { - String: 'STRING', - Array: 'ARRAY' -} as const; - -export type FormDefinitionInputV2026TypeV2026 = typeof FormDefinitionInputV2026TypeV2026[keyof typeof FormDefinitionInputV2026TypeV2026]; - -/** - * - * @export - * @interface FormDefinitionResponseV2026 - */ -export interface FormDefinitionResponseV2026 { - /** - * Unique guid identifying the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2026 - */ - 'id'?: string; - /** - * Name of the form definition. - * @type {string} - * @memberof FormDefinitionResponseV2026 - */ - 'name'?: string; - /** - * Form definition\'s description. - * @type {string} - * @memberof FormDefinitionResponseV2026 - */ - 'description'?: string; - /** - * - * @type {FormOwnerV2026} - * @memberof FormDefinitionResponseV2026 - */ - 'owner'?: FormOwnerV2026; - /** - * List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. - * @type {Array} - * @memberof FormDefinitionResponseV2026 - */ - 'usedBy'?: Array; - /** - * List of form inputs required to create a form-instance object. - * @type {Array} - * @memberof FormDefinitionResponseV2026 - */ - 'formInput'?: Array; - /** - * List of nested form elements. - * @type {Array} - * @memberof FormDefinitionResponseV2026 - */ - 'formElements'?: Array; - /** - * Conditional logic that can dynamically modify the form as the recipient is interacting with it. - * @type {Array} - * @memberof FormDefinitionResponseV2026 - */ - 'formConditions'?: Array; - /** - * Created is the date the form definition was created - * @type {string} - * @memberof FormDefinitionResponseV2026 - */ - 'created'?: string; - /** - * Modified is the last date the form definition was modified - * @type {string} - * @memberof FormDefinitionResponseV2026 - */ - 'modified'?: string; -} -/** - * Self block for imported/exported object. - * @export - * @interface FormDefinitionSelfImportExportDtoV2026 - */ -export interface FormDefinitionSelfImportExportDtoV2026 { - /** - * Imported/exported object\'s DTO type. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2026 - */ - 'type'?: FormDefinitionSelfImportExportDtoV2026TypeV2026; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2026 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof FormDefinitionSelfImportExportDtoV2026 - */ - 'name'?: string; -} - -export const FormDefinitionSelfImportExportDtoV2026TypeV2026 = { - FormDefinition: 'FORM_DEFINITION' -} as const; - -export type FormDefinitionSelfImportExportDtoV2026TypeV2026 = typeof FormDefinitionSelfImportExportDtoV2026TypeV2026[keyof typeof FormDefinitionSelfImportExportDtoV2026TypeV2026]; - -/** - * - * @export - * @interface FormDetailsV2026 - */ -export interface FormDetailsV2026 { - /** - * ID of the form - * @type {string} - * @memberof FormDetailsV2026 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormDetailsV2026 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormDetailsV2026 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof FormDetailsV2026 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormDetailsV2026 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof FormDetailsV2026 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface FormElementDataSourceConfigOptionsV2026 - */ -export interface FormElementDataSourceConfigOptionsV2026 { - /** - * Label is the main label to display to the user when selecting this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2026 - */ - 'label'?: string; - /** - * SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2026 - */ - 'subLabel'?: string; - /** - * Value is the value to save as an entry when the user selects this option - * @type {string} - * @memberof FormElementDataSourceConfigOptionsV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface FormElementDynamicDataSourceConfigV2026 - */ -export interface FormElementDynamicDataSourceConfigV2026 { - /** - * AggregationBucketField is the aggregation bucket field name - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2026 - */ - 'aggregationBucketField'?: string; - /** - * Indices is a list of indices to use - * @type {Array} - * @memberof FormElementDynamicDataSourceConfigV2026 - */ - 'indices'?: Array; - /** - * ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2026 - */ - 'objectType'?: FormElementDynamicDataSourceConfigV2026ObjectTypeV2026; - /** - * Query is a text - * @type {string} - * @memberof FormElementDynamicDataSourceConfigV2026 - */ - 'query'?: string; -} - -export const FormElementDynamicDataSourceConfigV2026IndicesV2026 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Identities: 'identities', - Events: 'events', - Roles: 'roles', - Star: '*' -} as const; - -export type FormElementDynamicDataSourceConfigV2026IndicesV2026 = typeof FormElementDynamicDataSourceConfigV2026IndicesV2026[keyof typeof FormElementDynamicDataSourceConfigV2026IndicesV2026]; -export const FormElementDynamicDataSourceConfigV2026ObjectTypeV2026 = { - Identity: 'IDENTITY', - AccessProfile: 'ACCESS_PROFILE', - Sources: 'SOURCES', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type FormElementDynamicDataSourceConfigV2026ObjectTypeV2026 = typeof FormElementDynamicDataSourceConfigV2026ObjectTypeV2026[keyof typeof FormElementDynamicDataSourceConfigV2026ObjectTypeV2026]; - -/** - * - * @export - * @interface FormElementDynamicDataSourceV2026 - */ -export interface FormElementDynamicDataSourceV2026 { - /** - * - * @type {FormElementDynamicDataSourceConfigV2026} - * @memberof FormElementDynamicDataSourceV2026 - */ - 'config'?: FormElementDynamicDataSourceConfigV2026; - /** - * DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput - * @type {string} - * @memberof FormElementDynamicDataSourceV2026 - */ - 'dataSourceType'?: FormElementDynamicDataSourceV2026DataSourceTypeV2026; -} - -export const FormElementDynamicDataSourceV2026DataSourceTypeV2026 = { - Static: 'STATIC', - Internal: 'INTERNAL', - Search: 'SEARCH', - FormInput: 'FORM_INPUT' -} as const; - -export type FormElementDynamicDataSourceV2026DataSourceTypeV2026 = typeof FormElementDynamicDataSourceV2026DataSourceTypeV2026[keyof typeof FormElementDynamicDataSourceV2026DataSourceTypeV2026]; - -/** - * - * @export - * @interface FormElementPreviewRequestV2026 - */ -export interface FormElementPreviewRequestV2026 { - /** - * - * @type {FormElementDynamicDataSourceV2026} - * @memberof FormElementPreviewRequestV2026 - */ - 'dataSource'?: FormElementDynamicDataSourceV2026; -} -/** - * - * @export - * @interface FormElementV2026 - */ -export interface FormElementV2026 { - /** - * Form element identifier. - * @type {string} - * @memberof FormElementV2026 - */ - 'id'?: string; - /** - * FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription - * @type {string} - * @memberof FormElementV2026 - */ - 'elementType'?: FormElementV2026ElementTypeV2026; - /** - * Config object. - * @type {{ [key: string]: any; }} - * @memberof FormElementV2026 - */ - 'config'?: { [key: string]: any; }; - /** - * Technical key. - * @type {string} - * @memberof FormElementV2026 - */ - 'key'?: string; - /** - * - * @type {Array} - * @memberof FormElementV2026 - */ - 'validations'?: Array | null; -} - -export const FormElementV2026ElementTypeV2026 = { - Text: 'TEXT', - Toggle: 'TOGGLE', - Textarea: 'TEXTAREA', - Hidden: 'HIDDEN', - Phone: 'PHONE', - Email: 'EMAIL', - Select: 'SELECT', - Date: 'DATE', - Section: 'SECTION', - ColumnSet: 'COLUMN_SET', - Image: 'IMAGE', - Description: 'DESCRIPTION' -} as const; - -export type FormElementV2026ElementTypeV2026 = typeof FormElementV2026ElementTypeV2026[keyof typeof FormElementV2026ElementTypeV2026]; - -/** - * Set of FormElementValidation items. - * @export - * @interface FormElementValidationsSetV2026 - */ -export interface FormElementValidationsSetV2026 { - /** - * The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. - * @type {string} - * @memberof FormElementValidationsSetV2026 - */ - 'validationType'?: FormElementValidationsSetV2026ValidationTypeV2026; -} - -export const FormElementValidationsSetV2026ValidationTypeV2026 = { - Required: 'REQUIRED', - MinLength: 'MIN_LENGTH', - MaxLength: 'MAX_LENGTH', - Regex: 'REGEX', - Date: 'DATE', - MaxDate: 'MAX_DATE', - MinDate: 'MIN_DATE', - LessThanDate: 'LESS_THAN_DATE', - Phone: 'PHONE', - Email: 'EMAIL', - DataSource: 'DATA_SOURCE', - Textarea: 'TEXTAREA' -} as const; - -export type FormElementValidationsSetV2026ValidationTypeV2026 = typeof FormElementValidationsSetV2026ValidationTypeV2026[keyof typeof FormElementValidationsSetV2026ValidationTypeV2026]; - -/** - * - * @export - * @interface FormErrorV2026 - */ -export interface FormErrorV2026 { - /** - * Key is the technical key - * @type {string} - * @memberof FormErrorV2026 - */ - 'key'?: string; - /** - * Messages is a list of web.ErrorMessage items - * @type {Array} - * @memberof FormErrorV2026 - */ - 'messages'?: Array; - /** - * Value is the value associated with a Key - * @type {object} - * @memberof FormErrorV2026 - */ - 'value'?: object; -} -/** - * - * @export - * @interface FormInstanceCreatedByV2026 - */ -export interface FormInstanceCreatedByV2026 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceCreatedByV2026 - */ - 'id'?: string; - /** - * Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource - * @type {string} - * @memberof FormInstanceCreatedByV2026 - */ - 'type'?: FormInstanceCreatedByV2026TypeV2026; -} - -export const FormInstanceCreatedByV2026TypeV2026 = { - WorkflowExecution: 'WORKFLOW_EXECUTION', - Source: 'SOURCE' -} as const; - -export type FormInstanceCreatedByV2026TypeV2026 = typeof FormInstanceCreatedByV2026TypeV2026[keyof typeof FormInstanceCreatedByV2026TypeV2026]; - -/** - * - * @export - * @interface FormInstanceRecipientV2026 - */ -export interface FormInstanceRecipientV2026 { - /** - * ID is a unique identifier - * @type {string} - * @memberof FormInstanceRecipientV2026 - */ - 'id'?: string; - /** - * Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity - * @type {string} - * @memberof FormInstanceRecipientV2026 - */ - 'type'?: FormInstanceRecipientV2026TypeV2026; -} - -export const FormInstanceRecipientV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type FormInstanceRecipientV2026TypeV2026 = typeof FormInstanceRecipientV2026TypeV2026[keyof typeof FormInstanceRecipientV2026TypeV2026]; - -/** - * - * @export - * @interface FormInstanceResponseV2026 - */ -export interface FormInstanceResponseV2026 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'state'?: FormInstanceResponseV2026StateV2026; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof FormInstanceResponseV2026 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2026} - * @memberof FormInstanceResponseV2026 - */ - 'createdBy'?: FormInstanceCreatedByV2026; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof FormInstanceResponseV2026 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof FormInstanceResponseV2026 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof FormInstanceResponseV2026 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof FormInstanceResponseV2026 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof FormInstanceResponseV2026 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof FormInstanceResponseV2026 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof FormInstanceResponseV2026 - */ - 'recipients'?: Array; -} - -export const FormInstanceResponseV2026StateV2026 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type FormInstanceResponseV2026StateV2026 = typeof FormInstanceResponseV2026StateV2026[keyof typeof FormInstanceResponseV2026StateV2026]; - -/** - * - * @export - * @interface FormItemDetailsV2026 - */ -export interface FormItemDetailsV2026 { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemDetailsV2026 - */ - 'name'?: string | null; -} -/** - * - * @export - * @interface FormOwnerV2026 - */ -export interface FormOwnerV2026 { - /** - * FormOwnerType value. IDENTITY FormOwnerTypeIdentity - * @type {string} - * @memberof FormOwnerV2026 - */ - 'type'?: FormOwnerV2026TypeV2026; - /** - * Unique identifier of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2026 - */ - 'id'?: string; - /** - * Name of the form\'s owner. - * @type {string} - * @memberof FormOwnerV2026 - */ - 'name'?: string; -} - -export const FormOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type FormOwnerV2026TypeV2026 = typeof FormOwnerV2026TypeV2026[keyof typeof FormOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface FormUsedByV2026 - */ -export interface FormUsedByV2026 { - /** - * FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType - * @type {string} - * @memberof FormUsedByV2026 - */ - 'type'?: FormUsedByV2026TypeV2026; - /** - * Unique identifier of the system using the form. - * @type {string} - * @memberof FormUsedByV2026 - */ - 'id'?: string; - /** - * Name of the system using the form. - * @type {string} - * @memberof FormUsedByV2026 - */ - 'name'?: string; -} - -export const FormUsedByV2026TypeV2026 = { - Workflow: 'WORKFLOW', - Source: 'SOURCE', - MySailPoint: 'MySailPoint' -} as const; - -export type FormUsedByV2026TypeV2026 = typeof FormUsedByV2026TypeV2026[keyof typeof FormUsedByV2026TypeV2026]; - -/** - * - * @export - * @interface ForwardApprovalDtoV2026 - */ -export interface ForwardApprovalDtoV2026 { - /** - * The Id of the new owner - * @type {string} - * @memberof ForwardApprovalDtoV2026 - */ - 'newOwnerId': string; - /** - * The comment provided by the forwarder - * @type {string} - * @memberof ForwardApprovalDtoV2026 - */ - 'comment': string; -} -/** - * Discovered applications with their respective associated sources - * @export - * @interface FullDiscoveredApplicationsV2026 - */ -export interface FullDiscoveredApplicationsV2026 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'status'?: string; - /** - * List of associated sources related to this discovered application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'associatedSources'?: Array; - /** - * The operational status of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'operationalStatus'?: string; - /** - * The category of the discovery source. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'discoverySourceCategory'?: string; - /** - * The number of licenses associated with the application. - * @type {number} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'licenseCount'?: number; - /** - * Indicates whether the application is sanctioned. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'isSanctioned'?: boolean; - /** - * URL of the application\'s logo. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'logo'?: string; - /** - * The URL of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'appUrl'?: string; - /** - * List of groups associated with the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'groups'?: Array; - /** - * The count of users associated with the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'usersCount'?: string; - /** - * The owners of the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'applicationOwner'?: Array; - /** - * The IT owners of the application. - * @type {Array} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'itApplicationOwner'?: Array; - /** - * The business criticality level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'businessCriticality'?: string; - /** - * The data classification level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'dataClassification'?: string; - /** - * The business unit associated with the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'businessUnit'?: string; - /** - * The installation type of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'installType'?: string; - /** - * The environment in which the application operates. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'environment'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'riskLevel'?: FullDiscoveredApplicationsV2026RiskLevelV2026; - /** - * Indicates whether the application has privileged access. - * @type {boolean} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'isPrivileged'?: boolean; - /** - * The warranty expiration date of the application. - * @type {string} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'warrantyExpiration'?: string; - /** - * Additional attributes of the application useful for visibility of governance posture. - * @type {object} - * @memberof FullDiscoveredApplicationsV2026 - */ - 'attributes'?: object; -} - -export const FullDiscoveredApplicationsV2026RiskLevelV2026 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type FullDiscoveredApplicationsV2026RiskLevelV2026 = typeof FullDiscoveredApplicationsV2026RiskLevelV2026[keyof typeof FullDiscoveredApplicationsV2026RiskLevelV2026]; - -/** - * - * @export - * @interface GenerateRandomStringV2026 - */ -export interface GenerateRandomStringV2026 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GenerateRandomStringV2026 - */ - 'name': string; - /** - * The operation to perform `generateRandomString` - * @type {string} - * @memberof GenerateRandomStringV2026 - */ - 'operation': string; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers - * @type {boolean} - * @memberof GenerateRandomStringV2026 - */ - 'includeNumbers': boolean; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters - * @type {boolean} - * @memberof GenerateRandomStringV2026 - */ - 'includeSpecialChars': boolean; - /** - * This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - * @type {string} - * @memberof GenerateRandomStringV2026 - */ - 'length': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GenerateRandomStringV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetAccessRequestConfig401ResponseV2026 - */ -export interface GetAccessRequestConfig401ResponseV2026 { - /** - * A message describing the error - * @type {object} - * @memberof GetAccessRequestConfig401ResponseV2026 - */ - 'error'?: object; -} -/** - * - * @export - * @interface GetAccessRequestConfig429ResponseV2026 - */ -export interface GetAccessRequestConfig429ResponseV2026 { - /** - * A message describing the error - * @type {object} - * @memberof GetAccessRequestConfig429ResponseV2026 - */ - 'message'?: object; -} -/** - * - * @export - * @interface GetActiveCampaigns200ResponseInnerV2026 - */ -export interface GetActiveCampaigns200ResponseInnerV2026 { - /** - * Id of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'type': GetActiveCampaigns200ResponseInnerV2026TypeV2026; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'status'?: GetActiveCampaigns200ResponseInnerV2026StatusV2026 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'correlatedStatus'?: GetActiveCampaigns200ResponseInnerV2026CorrelatedStatusV2026; - /** - * Created time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2026} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'filter'?: CampaignAllOfFilterV2026 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2026} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2026} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2026} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2026} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2026 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInnerV2026 - */ - 'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerV2026MandatoryCommentRequirementV2026; -} - -export const GetActiveCampaigns200ResponseInnerV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2026TypeV2026 = typeof GetActiveCampaigns200ResponseInnerV2026TypeV2026[keyof typeof GetActiveCampaigns200ResponseInnerV2026TypeV2026]; -export const GetActiveCampaigns200ResponseInnerV2026StatusV2026 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2026StatusV2026 = typeof GetActiveCampaigns200ResponseInnerV2026StatusV2026[keyof typeof GetActiveCampaigns200ResponseInnerV2026StatusV2026]; -export const GetActiveCampaigns200ResponseInnerV2026CorrelatedStatusV2026 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2026CorrelatedStatusV2026 = typeof GetActiveCampaigns200ResponseInnerV2026CorrelatedStatusV2026[keyof typeof GetActiveCampaigns200ResponseInnerV2026CorrelatedStatusV2026]; -export const GetActiveCampaigns200ResponseInnerV2026MandatoryCommentRequirementV2026 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetActiveCampaigns200ResponseInnerV2026MandatoryCommentRequirementV2026 = typeof GetActiveCampaigns200ResponseInnerV2026MandatoryCommentRequirementV2026[keyof typeof GetActiveCampaigns200ResponseInnerV2026MandatoryCommentRequirementV2026]; - -/** - * - * @export - * @interface GetCampaign200ResponseV2026 - */ -export interface GetCampaign200ResponseV2026 { - /** - * Id of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'type': GetCampaign200ResponseV2026TypeV2026; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2026 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetCampaign200ResponseV2026 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetCampaign200ResponseV2026 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'status'?: GetCampaign200ResponseV2026StatusV2026 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'correlatedStatus'?: GetCampaign200ResponseV2026CorrelatedStatusV2026; - /** - * Created time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2026 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetCampaign200ResponseV2026 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetCampaign200ResponseV2026 - */ - 'alerts'?: Array | null; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'modified'?: string | null; - /** - * - * @type {CampaignAllOfFilterV2026} - * @memberof GetCampaign200ResponseV2026 - */ - 'filter'?: CampaignAllOfFilterV2026 | null; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetCampaign200ResponseV2026 - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfoV2026} - * @memberof GetCampaign200ResponseV2026 - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfSearchCampaignInfoV2026} - * @memberof GetCampaign200ResponseV2026 - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoV2026} - * @memberof GetCampaign200ResponseV2026 - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfoV2026 | null; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfoV2026} - * @memberof GetCampaign200ResponseV2026 - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfoV2026 | null; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetCampaign200ResponseV2026 - */ - 'sourcesWithOrphanEntitlements'?: Array | null; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetCampaign200ResponseV2026 - */ - 'mandatoryCommentRequirement'?: GetCampaign200ResponseV2026MandatoryCommentRequirementV2026; -} - -export const GetCampaign200ResponseV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetCampaign200ResponseV2026TypeV2026 = typeof GetCampaign200ResponseV2026TypeV2026[keyof typeof GetCampaign200ResponseV2026TypeV2026]; -export const GetCampaign200ResponseV2026StatusV2026 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetCampaign200ResponseV2026StatusV2026 = typeof GetCampaign200ResponseV2026StatusV2026[keyof typeof GetCampaign200ResponseV2026StatusV2026]; -export const GetCampaign200ResponseV2026CorrelatedStatusV2026 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetCampaign200ResponseV2026CorrelatedStatusV2026 = typeof GetCampaign200ResponseV2026CorrelatedStatusV2026[keyof typeof GetCampaign200ResponseV2026CorrelatedStatusV2026]; -export const GetCampaign200ResponseV2026MandatoryCommentRequirementV2026 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetCampaign200ResponseV2026MandatoryCommentRequirementV2026 = typeof GetCampaign200ResponseV2026MandatoryCommentRequirementV2026[keyof typeof GetCampaign200ResponseV2026MandatoryCommentRequirementV2026]; - -/** - * @type GetDiscoveredApplications200ResponseInnerV2026 - * @export - */ -export type GetDiscoveredApplications200ResponseInnerV2026 = FullDiscoveredApplicationsV2026 | SlimDiscoveredApplicationsV2026; - -/** - * - * @export - * @interface GetHistoricalIdentityEvents200ResponseInnerV2026 - */ -export interface GetHistoricalIdentityEvents200ResponseInnerV2026 { - /** - * the id of the certification item - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'signer'?: CertifierResponseV2026; - /** - * the event type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'dateTime'?: string; - /** - * the identity id - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemAssociatedAccessItemV2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'accessItem': AccessItemAssociatedAccessItemV2026; - /** - * - * @type {CorrelatedGovernanceEventV2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'governanceEvent': CorrelatedGovernanceEventV2026 | null; - /** - * the access item type - * @type {string} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'accessItemType'?: GetHistoricalIdentityEvents200ResponseInnerV2026AccessItemTypeV2026; - /** - * - * @type {Array} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'attributeChanges': Array; - /** - * - * @type {AccessRequestResponse1V2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'accessRequest': AccessRequestResponse1V2026; - /** - * - * @type {AccountStatusChangedAccountV2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'account': AccountStatusChangedAccountV2026; - /** - * - * @type {AccountStatusChangedStatusChangeV2026} - * @memberof GetHistoricalIdentityEvents200ResponseInnerV2026 - */ - 'statusChange': AccountStatusChangedStatusChangeV2026; -} - -export const GetHistoricalIdentityEvents200ResponseInnerV2026AccessItemTypeV2026 = { - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role', - AccessProfile: 'accessProfile' -} as const; - -export type GetHistoricalIdentityEvents200ResponseInnerV2026AccessItemTypeV2026 = typeof GetHistoricalIdentityEvents200ResponseInnerV2026AccessItemTypeV2026[keyof typeof GetHistoricalIdentityEvents200ResponseInnerV2026AccessItemTypeV2026]; - -/** - * - * @export - * @interface GetLaunchers200ResponseV2026 - */ -export interface GetLaunchers200ResponseV2026 { - /** - * Pagination marker - * @type {string} - * @memberof GetLaunchers200ResponseV2026 - */ - 'next'?: string; - /** - * - * @type {Array} - * @memberof GetLaunchers200ResponseV2026 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface GetOAuthClientResponseV2026 - */ -export interface GetOAuthClientResponseV2026 { - /** - * ID of the OAuth client - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'id': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'businessName': string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'homepageUrl': string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2026 - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponseV2026 - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof GetOAuthClientResponseV2026 - */ - 'redirectUris': Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof GetOAuthClientResponseV2026 - */ - 'grantTypes': Array; - /** - * - * @type {AccessTypeV2026} - * @memberof GetOAuthClientResponseV2026 - */ - 'accessType': AccessTypeV2026; - /** - * - * @type {ClientTypeV2026} - * @memberof GetOAuthClientResponseV2026 - */ - 'type': ClientTypeV2026; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof GetOAuthClientResponseV2026 - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof GetOAuthClientResponseV2026 - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof GetOAuthClientResponseV2026 - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof GetOAuthClientResponseV2026 - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'modified': string; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'secret'?: string | null; - /** - * - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'metadata'?: string | null; - /** - * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - * @type {string} - * @memberof GetOAuthClientResponseV2026 - */ - 'lastUsed'?: string | null; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof GetOAuthClientResponseV2026 - */ - 'scope': Array | null; -} - - -/** - * - * @export - * @interface GetPersonalAccessTokenResponseV2026 - */ -export interface GetPersonalAccessTokenResponseV2026 { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'id': string; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'name': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'scope': Array | null; - /** - * - * @type {PatOwnerV2026} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'owner': PatOwnerV2026; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'created': string; - /** - * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'lastUsed'?: string | null; - /** - * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'managed'?: boolean; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'accessTokenValiditySeconds'?: number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty, the token will never expire (and `userAwareTokenNeverExpires` will be `true`). When `expirationDate` is provided, this value must be a future date. There is no upper limit on how far in the future the expiration date can be set. - * @type {string} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'expirationDate'?: string | null; - /** - * Indicates that the user who created or updated this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When `true`, this flag confirms that the user understood the security risks associated with non-expiring tokens at the time of creation or update. **Security Awareness:** This field serves as a record that the user acknowledged: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Behavior:** * When `true`: Indicates that the user acknowledged they were creating a token that will never expire. When `expirationDate` is `null`, the token will never expire. * When `false`: The token follows normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponseV2026 - */ - 'userAwareTokenNeverExpires'?: boolean; -} -/** - * - * @export - * @interface GetReferenceIdentityAttributeV2026 - */ -export interface GetReferenceIdentityAttributeV2026 { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GetReferenceIdentityAttributeV2026 - */ - 'name': string; - /** - * The operation to perform `getReferenceIdentityAttribute` - * @type {string} - * @memberof GetReferenceIdentityAttributeV2026 - */ - 'operation': string; - /** - * This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user\'s manager and then get that manager\'s identity attribute. - * @type {string} - * @memberof GetReferenceIdentityAttributeV2026 - */ - 'uid': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GetReferenceIdentityAttributeV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetRoleAssignments200ResponseInnerV2026 - */ -export interface GetRoleAssignments200ResponseInnerV2026 { - /** - * Assignment Id - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'role'?: BaseReferenceDtoV2026; - /** - * Date that the assignment was added - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'removeDate'?: string | null; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2026} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2026; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2026} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2026; - /** - * - * @type {Array} - * @memberof GetRoleAssignments200ResponseInnerV2026 - */ - 'accountTargets'?: Array; -} -/** - * @type GetStream200ResponseV2026 - * @export - */ -export type GetStream200ResponseV2026 = Array | StreamConfigResponseV2026; - -/** - * - * @export - * @interface GetTenantContext200ResponseInnerV2026 - */ -export interface GetTenantContext200ResponseInnerV2026 { - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2026 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof GetTenantContext200ResponseInnerV2026 - */ - 'value'?: string; -} -/** - * OAuth2 Grant Type - * @export - * @enum {string} - */ - -export const GrantTypeV2026 = { - ClientCredentials: 'CLIENT_CREDENTIALS', - AuthorizationCode: 'AUTHORIZATION_CODE', - RefreshToken: 'REFRESH_TOKEN' -} as const; - -export type GrantTypeV2026 = typeof GrantTypeV2026[keyof typeof GrantTypeV2026]; - - -/** - * Individual error or warning event - * @export - * @interface HealthEventV2026 - */ -export interface HealthEventV2026 { - /** - * Description of the issue - * @type {string} - * @memberof HealthEventV2026 - */ - 'detailedMessage'?: string; - /** - * Unique identifier for the health event - * @type {string} - * @memberof HealthEventV2026 - */ - 'uuid'?: string; - /** - * Optional URL associated with the issue - * @type {string} - * @memberof HealthEventV2026 - */ - 'url'?: string | null; - /** - * Time when the event occurred - * @type {string} - * @memberof HealthEventV2026 - */ - 'timestamp'?: string; - /** - * Last time notification was sent for this issue - * @type {string} - * @memberof HealthEventV2026 - */ - 'lastNotifiedTimeStamp'?: string; - /** - * CPU usage percentage - * @type {number} - * @memberof HealthEventV2026 - */ - 'cpuUtilizationPercentage'?: number | null; - /** - * Free memory percentage - * @type {number} - * @memberof HealthEventV2026 - */ - 'freeSpacePercentage'?: number | null; -} -/** - * Health indicator category data with errors and warnings - * @export - * @interface HealthIndicatorCategoryV2026 - */ -export interface HealthIndicatorCategoryV2026 { - /** - * List of error events for this category - * @type {Array} - * @memberof HealthIndicatorCategoryV2026 - */ - 'errors'?: Array; - /** - * List of warning events for this category - * @type {Array} - * @memberof HealthIndicatorCategoryV2026 - */ - 'warnings'?: Array; -} -/** - * A HierarchicalRightSet - * @export - * @interface HierarchicalRightSetV2026 - */ -export interface HierarchicalRightSetV2026 { - /** - * The unique identifier of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2026 - */ - 'id'?: string; - /** - * The human-readable name of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2026 - */ - 'name'?: string; - /** - * A human-readable description of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2026 - */ - 'description'?: string | null; - /** - * The category of the RightSet. - * @type {string} - * @memberof HierarchicalRightSetV2026 - */ - 'category'?: string; - /** - * - * @type {NestedConfigV2026} - * @memberof HierarchicalRightSetV2026 - */ - 'nestedConfig'?: NestedConfigV2026; - /** - * List of child HierarchicalRightSets. - * @type {Array} - * @memberof HierarchicalRightSetV2026 - */ - 'children'?: Array; -} -/** - * Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. - * @export - * @enum {string} - */ - -export const HttpAuthenticationTypeV2026 = { - NoAuth: 'NO_AUTH', - BasicAuth: 'BASIC_AUTH', - BearerToken: 'BEARER_TOKEN' -} as const; - -export type HttpAuthenticationTypeV2026 = typeof HttpAuthenticationTypeV2026[keyof typeof HttpAuthenticationTypeV2026]; - - -/** - * - * @export - * @interface HttpConfigV2026 - */ -export interface HttpConfigV2026 { - /** - * URL of the external/custom integration. - * @type {string} - * @memberof HttpConfigV2026 - */ - 'url': string; - /** - * - * @type {HttpDispatchModeV2026} - * @memberof HttpConfigV2026 - */ - 'httpDispatchMode': HttpDispatchModeV2026; - /** - * - * @type {HttpAuthenticationTypeV2026} - * @memberof HttpConfigV2026 - */ - 'httpAuthenticationType'?: HttpAuthenticationTypeV2026; - /** - * - * @type {BasicAuthConfigV2026} - * @memberof HttpConfigV2026 - */ - 'basicAuthConfig'?: BasicAuthConfigV2026 | null; - /** - * - * @type {BearerTokenAuthConfigV2026} - * @memberof HttpConfigV2026 - */ - 'bearerTokenAuthConfig'?: BearerTokenAuthConfigV2026 | null; -} - - -/** - * HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. - * @export - * @enum {string} - */ - -export const HttpDispatchModeV2026 = { - Sync: 'SYNC', - Async: 'ASYNC', - Dynamic: 'DYNAMIC' -} as const; - -export type HttpDispatchModeV2026 = typeof HttpDispatchModeV2026[keyof typeof HttpDispatchModeV2026]; - - -/** - * - * @export - * @interface ISO3166V2026 - */ -export interface ISO3166V2026 { - /** - * An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., \"USA\") `numeric` - The numeric country code (e.g., \"840\") - * @type {string} - * @memberof ISO3166V2026 - */ - 'format'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ISO3166V2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ISO3166V2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentitiesAccountsBulkRequestV2026 - */ -export interface IdentitiesAccountsBulkRequestV2026 { - /** - * The ids of the identities for which enable/disable accounts. - * @type {Array} - * @memberof IdentitiesAccountsBulkRequestV2026 - */ - 'identityIds'?: Array; -} -/** - * Arguments for Identities Details report (IDENTITIES_DETAILS) - * @export - * @interface IdentitiesDetailsReportArgumentsV2026 - */ -export interface IdentitiesDetailsReportArgumentsV2026 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesDetailsReportArgumentsV2026 - */ - 'correlatedOnly': boolean; -} -/** - * Arguments for Identities report (IDENTITIES) - * @export - * @interface IdentitiesReportArgumentsV2026 - */ -export interface IdentitiesReportArgumentsV2026 { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesReportArgumentsV2026 - */ - 'correlatedOnly'?: boolean; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface Identity1V2026 - */ -export interface Identity1V2026 { - /** - * The ID of the object - * @type {string} - * @memberof Identity1V2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object - * @type {string} - * @memberof Identity1V2026 - */ - 'name'?: string; -} -/** - * @type IdentityAccessV2026 - * @export - */ -export type IdentityAccessV2026 = { type: 'ACCESS_PROFILE' } & AccessProfileSummaryV2026 | { type: 'ENTITLEMENT' } & AccessProfileEntitlementV2026 | { type: 'ROLE' } & AccessProfileRoleV2026; - -/** - * - * @export - * @interface IdentityAccountSelectionsV2026 - */ -export interface IdentityAccountSelectionsV2026 { - /** - * Available account selections for the identity, per requested item - * @type {Array} - * @memberof IdentityAccountSelectionsV2026 - */ - 'requestedItems'?: Array; - /** - * A boolean indicating whether any account selections will be required for the user to raise an access request - * @type {boolean} - * @memberof IdentityAccountSelectionsV2026 - */ - 'accountsSelectionRequired'?: boolean; - /** - * - * @type {DtoTypeV2026} - * @memberof IdentityAccountSelectionsV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The identity id for the user - * @type {string} - * @memberof IdentityAccountSelectionsV2026 - */ - 'id'?: string; - /** - * The name of the identity - * @type {string} - * @memberof IdentityAccountSelectionsV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityAssociationDetailsAssociationDetailsInnerV2026 - */ -export interface IdentityAssociationDetailsAssociationDetailsInnerV2026 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2026 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityAssociationDetailsAssociationDetailsInnerV2026 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityAssociationDetailsV2026 - */ -export interface IdentityAssociationDetailsV2026 { - /** - * any additional context information of the http call result - * @type {string} - * @memberof IdentityAssociationDetailsV2026 - */ - 'message'?: string; - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityAssociationDetailsV2026 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityAttribute1V2026 - */ -export interface IdentityAttribute1V2026 { - /** - * The system (camel-cased) name of the identity attribute to bring in - * @type {string} - * @memberof IdentityAttribute1V2026 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IdentityAttribute1V2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IdentityAttribute1V2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - * @export - * @interface IdentityAttributeConfigV2026 - */ -export interface IdentityAttributeConfigV2026 { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfigV2026 - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfigV2026 - */ - 'attributeTransforms'?: Array; -} -/** - * Identity attribute IDs. - * @export - * @interface IdentityAttributeNamesV2026 - */ -export interface IdentityAttributeNamesV2026 { - /** - * List of identity attributes\' technical names. - * @type {Array} - * @memberof IdentityAttributeNamesV2026 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface IdentityAttributePreviewV2026 - */ -export interface IdentityAttributePreviewV2026 { - /** - * Name of the attribute that is being previewed. - * @type {string} - * @memberof IdentityAttributePreviewV2026 - */ - 'name'?: string; - /** - * Value that was derived during the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2026 - */ - 'value'?: string; - /** - * The value of the attribute before the preview. - * @type {string} - * @memberof IdentityAttributePreviewV2026 - */ - 'previousValue'?: string; - /** - * List of error messages - * @type {Array} - * @memberof IdentityAttributePreviewV2026 - */ - 'errorMessages'?: Array; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransformV2026 - */ -export interface IdentityAttributeTransformV2026 { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransformV2026 - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinitionV2026} - * @memberof IdentityAttributeTransformV2026 - */ - 'transformDefinition'?: TransformDefinitionV2026; -} -/** - * - * @export - * @interface IdentityAttributeV2026 - */ -export interface IdentityAttributeV2026 { - /** - * Identity attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributeV2026 - */ - 'name': string; - /** - * Identity attribute\'s business-friendly name. - * @type {string} - * @memberof IdentityAttributeV2026 - */ - 'displayName'?: string; - /** - * Indicates whether the attribute is \'standard\' or \'default\'. - * @type {boolean} - * @memberof IdentityAttributeV2026 - */ - 'standard'?: boolean; - /** - * Identity attribute\'s type. - * @type {string} - * @memberof IdentityAttributeV2026 - */ - 'type'?: string | null; - /** - * Indicates whether the identity attribute is multi-valued. - * @type {boolean} - * @memberof IdentityAttributeV2026 - */ - 'multi'?: boolean; - /** - * Indicates whether the identity attribute is searchable. - * @type {boolean} - * @memberof IdentityAttributeV2026 - */ - 'searchable'?: boolean; - /** - * Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. - * @type {boolean} - * @memberof IdentityAttributeV2026 - */ - 'system'?: boolean; - /** - * Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. - * @type {Array} - * @memberof IdentityAttributeV2026 - */ - 'sources'?: Array; -} -/** - * @type IdentityAttributesChangedChangesInnerNewValueV2026 - * The value of the identity attribute after it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerNewValueV2026 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2026; }; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2026 - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueOneOfValueV2026 = boolean | number | string; - -/** - * @type IdentityAttributesChangedChangesInnerOldValueV2026 - * The value of the identity attribute before it changed. - * @export - */ -export type IdentityAttributesChangedChangesInnerOldValueV2026 = Array | boolean | string | { [key: string]: IdentityAttributesChangedChangesInnerOldValueOneOfValueV2026; }; - -/** - * - * @export - * @interface IdentityAttributesChangedChangesInnerV2026 - */ -export interface IdentityAttributesChangedChangesInnerV2026 { - /** - * The name of the identity attribute that changed. - * @type {string} - * @memberof IdentityAttributesChangedChangesInnerV2026 - */ - 'attribute': string; - /** - * - * @type {IdentityAttributesChangedChangesInnerOldValueV2026} - * @memberof IdentityAttributesChangedChangesInnerV2026 - */ - 'oldValue'?: IdentityAttributesChangedChangesInnerOldValueV2026 | null; - /** - * - * @type {IdentityAttributesChangedChangesInnerNewValueV2026} - * @memberof IdentityAttributesChangedChangesInnerV2026 - */ - 'newValue'?: IdentityAttributesChangedChangesInnerNewValueV2026; -} -/** - * Identity whose attributes changed. - * @export - * @interface IdentityAttributesChangedIdentityV2026 - */ -export interface IdentityAttributesChangedIdentityV2026 { - /** - * DTO type of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2026 - */ - 'type': IdentityAttributesChangedIdentityV2026TypeV2026; - /** - * ID of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2026 - */ - 'id': string; - /** - * Display name of identity whose attributes changed. - * @type {string} - * @memberof IdentityAttributesChangedIdentityV2026 - */ - 'name': string; -} - -export const IdentityAttributesChangedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityAttributesChangedIdentityV2026TypeV2026 = typeof IdentityAttributesChangedIdentityV2026TypeV2026[keyof typeof IdentityAttributesChangedIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface IdentityAttributesChangedV2026 - */ -export interface IdentityAttributesChangedV2026 { - /** - * - * @type {IdentityAttributesChangedIdentityV2026} - * @memberof IdentityAttributesChangedV2026 - */ - 'identity': IdentityAttributesChangedIdentityV2026; - /** - * A list of one or more identity attributes that changed on the identity. - * @type {Array} - * @memberof IdentityAttributesChangedV2026 - */ - 'changes': Array; -} -/** - * - * @export - * @interface IdentityCertDecisionSummaryV2026 - */ -export interface IdentityCertDecisionSummaryV2026 { - /** - * Number of entitlement decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'entitlementDecisionsMade'?: number; - /** - * Number of access profile decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accessProfileDecisionsMade'?: number; - /** - * Number of role decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'roleDecisionsMade'?: number; - /** - * Number of account decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accountDecisionsMade'?: number; - /** - * The total number of entitlement decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'entitlementDecisionsTotal'?: number; - /** - * The total number of access profile decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accessProfileDecisionsTotal'?: number; - /** - * The total number of role decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'roleDecisionsTotal'?: number; - /** - * The total number of account decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accountDecisionsTotal'?: number; - /** - * The number of entitlement decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'entitlementsApproved'?: number; - /** - * The number of entitlement decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'entitlementsRevoked'?: number; - /** - * The number of access profile decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accessProfilesApproved'?: number; - /** - * The number of access profile decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accessProfilesRevoked'?: number; - /** - * The number of role decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'rolesApproved'?: number; - /** - * The number of role decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'rolesRevoked'?: number; - /** - * The number of account decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accountsApproved'?: number; - /** - * The number of account decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummaryV2026 - */ - 'accountsRevoked'?: number; -} -/** - * - * @export - * @interface IdentityCertificationDtoV2026 - */ -export interface IdentityCertificationDtoV2026 { - /** - * id of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'name'?: string; - /** - * - * @type {CampaignReferenceV2026} - * @memberof IdentityCertificationDtoV2026 - */ - 'campaign'?: CampaignReferenceV2026; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof IdentityCertificationDtoV2026 - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof IdentityCertificationDtoV2026 - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof IdentityCertificationDtoV2026 - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof IdentityCertificationDtoV2026 - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof IdentityCertificationDtoV2026 - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'signed'?: string | null; - /** - * - * @type {ReviewerV2026} - * @memberof IdentityCertificationDtoV2026 - */ - 'reviewer'?: ReviewerV2026; - /** - * - * @type {ReassignmentV2026} - * @memberof IdentityCertificationDtoV2026 - */ - 'reassignment'?: ReassignmentV2026 | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof IdentityCertificationDtoV2026 - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof IdentityCertificationDtoV2026 - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhaseV2026} - * @memberof IdentityCertificationDtoV2026 - */ - 'phase'?: CertificationPhaseV2026; -} - - -/** - * - * @export - * @interface IdentityCertifiedV2026 - */ -export interface IdentityCertifiedV2026 { - /** - * the id of the certification item - * @type {string} - * @memberof IdentityCertifiedV2026 - */ - 'certificationId': string; - /** - * the certification item name - * @type {string} - * @memberof IdentityCertifiedV2026 - */ - 'certificationName': string; - /** - * the date ceritification was signed - * @type {string} - * @memberof IdentityCertifiedV2026 - */ - 'signedDate'?: string; - /** - * this field is deprecated and may go away - * @type {Array} - * @memberof IdentityCertifiedV2026 - */ - 'certifiers'?: Array; - /** - * The list of identities who review this certification - * @type {Array} - * @memberof IdentityCertifiedV2026 - */ - 'reviewers'?: Array; - /** - * - * @type {CertifierResponseV2026} - * @memberof IdentityCertifiedV2026 - */ - 'signer'?: CertifierResponseV2026; - /** - * the event type - * @type {string} - * @memberof IdentityCertifiedV2026 - */ - 'eventType'?: string; - /** - * the date of event - * @type {string} - * @memberof IdentityCertifiedV2026 - */ - 'dateTime'?: string; -} -/** - * - * @export - * @interface IdentityCompareResponseV2026 - */ -export interface IdentityCompareResponseV2026 { - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: object; }} - * @memberof IdentityCompareResponseV2026 - */ - 'accessItemDiff'?: { [key: string]: object; }; -} -/** - * Created identity. - * @export - * @interface IdentityCreatedIdentityV2026 - */ -export interface IdentityCreatedIdentityV2026 { - /** - * Created identity\'s DTO type. - * @type {string} - * @memberof IdentityCreatedIdentityV2026 - */ - 'type': IdentityCreatedIdentityV2026TypeV2026; - /** - * Created identity ID. - * @type {string} - * @memberof IdentityCreatedIdentityV2026 - */ - 'id': string; - /** - * Created identity\'s display name. - * @type {string} - * @memberof IdentityCreatedIdentityV2026 - */ - 'name': string; -} - -export const IdentityCreatedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityCreatedIdentityV2026TypeV2026 = typeof IdentityCreatedIdentityV2026TypeV2026[keyof typeof IdentityCreatedIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface IdentityCreatedV2026 - */ -export interface IdentityCreatedV2026 { - /** - * - * @type {IdentityCreatedIdentityV2026} - * @memberof IdentityCreatedV2026 - */ - 'identity': IdentityCreatedIdentityV2026; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityCreatedV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Deleted identity. - * @export - * @interface IdentityDeletedIdentityV2026 - */ -export interface IdentityDeletedIdentityV2026 { - /** - * Deleted identity\'s DTO type. - * @type {string} - * @memberof IdentityDeletedIdentityV2026 - */ - 'type': IdentityDeletedIdentityV2026TypeV2026; - /** - * Deleted identity ID. - * @type {string} - * @memberof IdentityDeletedIdentityV2026 - */ - 'id': string; - /** - * Deleted identity\'s display name. - * @type {string} - * @memberof IdentityDeletedIdentityV2026 - */ - 'name': string; -} - -export const IdentityDeletedIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityDeletedIdentityV2026TypeV2026 = typeof IdentityDeletedIdentityV2026TypeV2026[keyof typeof IdentityDeletedIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface IdentityDeletedV2026 - */ -export interface IdentityDeletedV2026 { - /** - * - * @type {IdentityDeletedIdentityV2026} - * @memberof IdentityDeletedV2026 - */ - 'identity': IdentityDeletedIdentityV2026; - /** - * The attributes assigned to the identity. Attributes are determined by the identity profile. - * @type {{ [key: string]: any; }} - * @memberof IdentityDeletedV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * Identity\'s identity profile. - * @export - * @interface IdentityDocumentAllOfIdentityProfileV2026 - */ -export interface IdentityDocumentAllOfIdentityProfileV2026 { - /** - * Identity profile\'s ID. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2026 - */ - 'id'?: string; - /** - * Identity profile\'s name. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfileV2026 - */ - 'name'?: string; -} -/** - * Identity\'s manager. - * @export - * @interface IdentityDocumentAllOfManagerV2026 - */ -export interface IdentityDocumentAllOfManagerV2026 { - /** - * ID of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2026 - */ - 'id'?: string; - /** - * Name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2026 - */ - 'name'?: string; - /** - * Display name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManagerV2026 - */ - 'displayName'?: string; -} -/** - * Identity\'s source. - * @export - * @interface IdentityDocumentAllOfSourceV2026 - */ -export interface IdentityDocumentAllOfSourceV2026 { - /** - * ID of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2026 - */ - 'id'?: string; - /** - * Display name of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSourceV2026 - */ - 'name'?: string; -} -/** - * Identity - * @export - * @interface IdentityDocumentV2026 - */ -export interface IdentityDocumentV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentV2026 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentV2026 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2026} - * @memberof IdentityDocumentV2026 - */ - 'manager'?: IdentityDocumentAllOfManagerV2026 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentV2026 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2026} - * @memberof IdentityDocumentV2026 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2026; - /** - * - * @type {IdentityDocumentAllOfSourceV2026} - * @memberof IdentityDocumentV2026 - */ - 'source'?: IdentityDocumentAllOfSourceV2026; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentV2026 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentV2026 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentV2026 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2026} - * @memberof IdentityDocumentV2026 - */ - 'processingDetails'?: ProcessingDetailsV2026; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentV2026 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentV2026 - */ - 'visibleSegmentCount'?: number; -} -/** - * - * @export - * @interface IdentityDocumentsV2026 - */ -export interface IdentityDocumentsV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocumentsV2026 - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocumentsV2026 - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManagerV2026} - * @memberof IdentityDocumentsV2026 - */ - 'manager'?: IdentityDocumentAllOfManagerV2026 | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocumentsV2026 - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfileV2026} - * @memberof IdentityDocumentsV2026 - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfileV2026; - /** - * - * @type {IdentityDocumentAllOfSourceV2026} - * @memberof IdentityDocumentsV2026 - */ - 'source'?: IdentityDocumentAllOfSourceV2026; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocumentsV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocumentsV2026 - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocumentsV2026 - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetailsV2026} - * @memberof IdentityDocumentsV2026 - */ - 'processingDetails'?: ProcessingDetailsV2026; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocumentsV2026 - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocumentsV2026 - */ - 'visibleSegmentCount'?: number; - /** - * Name of the pod. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof IdentityDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof IdentityDocumentsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof IdentityDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface IdentityEntitiesIdentityEntityV2026 - */ -export interface IdentityEntitiesIdentityEntityV2026 { - /** - * id of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2026 - */ - 'id'?: string; - /** - * name of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2026 - */ - 'name'?: string; - /** - * type of the resource to which the identity is associated - * @type {string} - * @memberof IdentityEntitiesIdentityEntityV2026 - */ - 'type'?: string; -} -/** - * - * @export - * @interface IdentityEntitiesV2026 - */ -export interface IdentityEntitiesV2026 { - /** - * - * @type {IdentityEntitiesIdentityEntityV2026} - * @memberof IdentityEntitiesV2026 - */ - 'identityEntity'?: IdentityEntitiesIdentityEntityV2026; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsAccountTargetV2026 - */ -export interface IdentityEntitlementDetailsAccountTargetV2026 { - /** - * The id of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'accountId'?: string; - /** - * The name of account - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'accountName'?: string; - /** - * The UUID representation of the account if available - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'accountUUID'?: string | null; - /** - * The id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'sourceId'?: string; - /** - * The name of Source - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'sourceName'?: string; - /** - * The removal date scheduled for the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'removeDate'?: string | null; - /** - * The assignmentId of the entitlement on the Identity - * @type {string} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'assignmentId'?: string | null; - /** - * If the entitlement can be revoked - * @type {boolean} - * @memberof IdentityEntitlementDetailsAccountTargetV2026 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsEntitlementDtoV2026 - */ -export interface IdentityEntitlementDetailsEntitlementDtoV2026 { - /** - * The entitlement id - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'name'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'modified'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'description'?: string | null; - /** - * The type of the object, will always be \"ENTITLEMENT\" - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'type'?: string; - /** - * The source ID - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'sourceId'?: string; - /** - * The source name - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'sourceName'?: string; - /** - * - * @type {OwnerDtoV2026} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'owner'?: OwnerDtoV2026; - /** - * The value of the entitlement - * @type {string} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'value'?: string; - /** - * a list of properties informing the viewer about the entitlement - * @type {Array} - * @memberof IdentityEntitlementDetailsEntitlementDtoV2026 - */ - 'flags'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementDetailsV2026 - */ -export interface IdentityEntitlementDetailsV2026 { - /** - * Id of Identity - * @type {string} - * @memberof IdentityEntitlementDetailsV2026 - */ - 'identityId'?: string; - /** - * - * @type {IdentityEntitlementDetailsEntitlementDtoV2026} - * @memberof IdentityEntitlementDetailsV2026 - */ - 'entitlement'?: IdentityEntitlementDetailsEntitlementDtoV2026; - /** - * Id of Source - * @type {string} - * @memberof IdentityEntitlementDetailsV2026 - */ - 'sourceId'?: string; - /** - * A list of account targets on the identity provisioned with the requested entitlement. - * @type {Array} - * @memberof IdentityEntitlementDetailsV2026 - */ - 'accountTargets'?: Array; -} -/** - * - * @export - * @interface IdentityEntitlementsV2026 - */ -export interface IdentityEntitlementsV2026 { - /** - * - * @type {TaggedObjectDtoV2026} - * @memberof IdentityEntitlementsV2026 - */ - 'objectRef'?: TaggedObjectDtoV2026; - /** - * Labels to be applied to object. - * @type {Array} - * @memberof IdentityEntitlementsV2026 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface IdentityExceptionReportReferenceV2026 - */ -export interface IdentityExceptionReportReferenceV2026 { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2026 - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReferenceV2026 - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityHistoryResponseV2026 - */ -export interface IdentityHistoryResponseV2026 { - /** - * the identity ID - * @type {string} - * @memberof IdentityHistoryResponseV2026 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityHistoryResponseV2026 - */ - 'displayName'?: string; - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentityHistoryResponseV2026 - */ - 'snapshot'?: string; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityHistoryResponseV2026 - */ - 'deletedDate'?: string; - /** - * A map containing the count of each access item - * @type {{ [key: string]: number; }} - * @memberof IdentityHistoryResponseV2026 - */ - 'accessItemCount'?: { [key: string]: number; }; - /** - * A map containing the identity attributes - * @type {{ [key: string]: any; }} - * @memberof IdentityHistoryResponseV2026 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface IdentityLifecycleStateV2026 - */ -export interface IdentityLifecycleStateV2026 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof IdentityLifecycleStateV2026 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof IdentityLifecycleStateV2026 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface IdentityListItemV2026 - */ -export interface IdentityListItemV2026 { - /** - * the identity ID - * @type {string} - * @memberof IdentityListItemV2026 - */ - 'id'?: string; - /** - * the display name of the identity - * @type {string} - * @memberof IdentityListItemV2026 - */ - 'displayName'?: string; - /** - * the first name of the identity - * @type {string} - * @memberof IdentityListItemV2026 - */ - 'firstName'?: string | null; - /** - * the last name of the identity - * @type {string} - * @memberof IdentityListItemV2026 - */ - 'lastName'?: string | null; - /** - * indicates if an identity is active or not - * @type {boolean} - * @memberof IdentityListItemV2026 - */ - 'active'?: boolean; - /** - * the date when the identity was deleted - * @type {string} - * @memberof IdentityListItemV2026 - */ - 'deletedDate'?: string | null; -} -/** - * Identity\'s manager - * @export - * @interface IdentityManagerRefV2026 - */ -export interface IdentityManagerRefV2026 { - /** - * DTO type of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2026 - */ - 'type'?: IdentityManagerRefV2026TypeV2026; - /** - * ID of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity\'s manager - * @type {string} - * @memberof IdentityManagerRefV2026 - */ - 'name'?: string; -} - -export const IdentityManagerRefV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityManagerRefV2026TypeV2026 = typeof IdentityManagerRefV2026TypeV2026[keyof typeof IdentityManagerRefV2026TypeV2026]; - -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2026 - */ -export interface IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2026 { - /** - * association type with the identity - * @type {string} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2026 - */ - 'associationType'?: string; - /** - * the specific resource this identity has ownership on - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsAssociationDetailsInnerV2026 - */ - 'entities'?: Array; -} -/** - * - * @export - * @interface IdentityOwnershipAssociationDetailsV2026 - */ -export interface IdentityOwnershipAssociationDetailsV2026 { - /** - * list of all the resource associations for the identity - * @type {Array} - * @memberof IdentityOwnershipAssociationDetailsV2026 - */ - 'associationDetails'?: Array; -} -/** - * - * @export - * @interface IdentityPreviewRequestV2026 - */ -export interface IdentityPreviewRequestV2026 { - /** - * The Identity id - * @type {string} - * @memberof IdentityPreviewRequestV2026 - */ - 'identityId'?: string; - /** - * - * @type {IdentityAttributeConfigV2026} - * @memberof IdentityPreviewRequestV2026 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2026; -} -/** - * Identity\'s basic details. - * @export - * @interface IdentityPreviewResponseIdentityV2026 - */ -export interface IdentityPreviewResponseIdentityV2026 { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2026 - */ - 'type'?: IdentityPreviewResponseIdentityV2026TypeV2026; - /** - * Identity ID. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2026 - */ - 'id'?: string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityPreviewResponseIdentityV2026 - */ - 'name'?: string; -} - -export const IdentityPreviewResponseIdentityV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityPreviewResponseIdentityV2026TypeV2026 = typeof IdentityPreviewResponseIdentityV2026TypeV2026[keyof typeof IdentityPreviewResponseIdentityV2026TypeV2026]; - -/** - * - * @export - * @interface IdentityPreviewResponseV2026 - */ -export interface IdentityPreviewResponseV2026 { - /** - * - * @type {IdentityPreviewResponseIdentityV2026} - * @memberof IdentityPreviewResponseV2026 - */ - 'identity'?: IdentityPreviewResponseIdentityV2026; - /** - * - * @type {Array} - * @memberof IdentityPreviewResponseV2026 - */ - 'previewAttributes'?: Array; -} -/** - * - * @export - * @interface IdentityProfileAllOfAuthoritativeSourceV2026 - */ -export interface IdentityProfileAllOfAuthoritativeSourceV2026 { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2026 - */ - 'type'?: IdentityProfileAllOfAuthoritativeSourceV2026TypeV2026; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2026 - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSourceV2026 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfAuthoritativeSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type IdentityProfileAllOfAuthoritativeSourceV2026TypeV2026 = typeof IdentityProfileAllOfAuthoritativeSourceV2026TypeV2026[keyof typeof IdentityProfileAllOfAuthoritativeSourceV2026TypeV2026]; - -/** - * Identity profile\'s owner. - * @export - * @interface IdentityProfileAllOfOwnerV2026 - */ -export interface IdentityProfileAllOfOwnerV2026 { - /** - * Owner\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2026 - */ - 'type'?: IdentityProfileAllOfOwnerV2026TypeV2026; - /** - * Owner\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2026 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof IdentityProfileAllOfOwnerV2026 - */ - 'name'?: string; -} - -export const IdentityProfileAllOfOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityProfileAllOfOwnerV2026TypeV2026 = typeof IdentityProfileAllOfOwnerV2026TypeV2026[keyof typeof IdentityProfileAllOfOwnerV2026TypeV2026]; - -/** - * Self block for exported object. - * @export - * @interface IdentityProfileExportedObjectSelfV2026 - */ -export interface IdentityProfileExportedObjectSelfV2026 { - /** - * Exported object\'s DTO type. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2026 - */ - 'type'?: IdentityProfileExportedObjectSelfV2026TypeV2026; - /** - * Exported object\'s ID. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2026 - */ - 'id'?: string; - /** - * Exported object\'s display name. - * @type {string} - * @memberof IdentityProfileExportedObjectSelfV2026 - */ - 'name'?: string; -} - -export const IdentityProfileExportedObjectSelfV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type IdentityProfileExportedObjectSelfV2026TypeV2026 = typeof IdentityProfileExportedObjectSelfV2026TypeV2026[keyof typeof IdentityProfileExportedObjectSelfV2026TypeV2026]; - -/** - * Identity profile exported object. - * @export - * @interface IdentityProfileExportedObjectV2026 - */ -export interface IdentityProfileExportedObjectV2026 { - /** - * Version or object from the target service. - * @type {number} - * @memberof IdentityProfileExportedObjectV2026 - */ - 'version'?: number; - /** - * - * @type {IdentityProfileExportedObjectSelfV2026} - * @memberof IdentityProfileExportedObjectV2026 - */ - 'self'?: IdentityProfileExportedObjectSelfV2026; - /** - * - * @type {IdentityProfileV2026} - * @memberof IdentityProfileExportedObjectV2026 - */ - 'object'?: IdentityProfileV2026; -} -/** - * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) - * @export - * @interface IdentityProfileIdentityErrorReportArgumentsV2026 - */ -export interface IdentityProfileIdentityErrorReportArgumentsV2026 { - /** - * Source ID. - * @type {string} - * @memberof IdentityProfileIdentityErrorReportArgumentsV2026 - */ - 'authoritativeSource': string; -} -/** - * - * @export - * @interface IdentityProfileV2026 - */ -export interface IdentityProfileV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfileV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfileV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfileV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfileV2026 - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfileV2026 - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwnerV2026} - * @memberof IdentityProfileV2026 - */ - 'owner'?: IdentityProfileAllOfOwnerV2026 | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfileV2026 - */ - 'priority'?: number; - /** - * - * @type {IdentityProfileAllOfAuthoritativeSourceV2026} - * @memberof IdentityProfileV2026 - */ - 'authoritativeSource': IdentityProfileAllOfAuthoritativeSourceV2026; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfileV2026 - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfileV2026 - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfigV2026} - * @memberof IdentityProfileV2026 - */ - 'identityAttributeConfig'?: IdentityAttributeConfigV2026; - /** - * - * @type {IdentityExceptionReportReferenceV2026} - * @memberof IdentityProfileV2026 - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReferenceV2026 | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfileV2026 - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * - * @export - * @interface IdentityProfilesConnectionsV2026 - */ -export interface IdentityProfilesConnectionsV2026 { - /** - * ID of the IdentityProfile this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the IdentityProfile to which this reference applies - * @type {string} - * @memberof IdentityProfilesConnectionsV2026 - */ - 'name'?: string; - /** - * The Number of Identities managed by this IdentityProfile - * @type {number} - * @memberof IdentityProfilesConnectionsV2026 - */ - 'identityCount'?: number; -} -/** - * Details about the identity correlated with the account. - * @export - * @interface IdentityReference1V2026 - */ -export interface IdentityReference1V2026 { - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof IdentityReference1V2026 - */ - 'id': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof IdentityReference1V2026 - */ - 'name': string; - /** - * The alias of the identity. - * @type {string} - * @memberof IdentityReference1V2026 - */ - 'alias': string; - /** - * The email of the identity. - * @type {string} - * @memberof IdentityReference1V2026 - */ - 'email': string; -} -/** - * The manager for the identity. - * @export - * @interface IdentityReferenceV2026 - */ -export interface IdentityReferenceV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof IdentityReferenceV2026 - */ - 'type'?: DtoTypeV2026; - /** - * Identity id - * @type {string} - * @memberof IdentityReferenceV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof IdentityReferenceV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithNameAndEmailV2026 - */ -export interface IdentityReferenceWithNameAndEmailV2026 { - /** - * The type can only be IDENTITY. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2026 - */ - 'type'?: string; - /** - * Identity ID. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2026 - */ - 'id'?: string; - /** - * Identity\'s human-readable display name. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2026 - */ - 'name'?: string; - /** - * Identity\'s email address. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmailV2026 - */ - 'email'?: string | null; -} -/** - * - * @export - * @interface IdentitySnapshotSummaryResponseV2026 - */ -export interface IdentitySnapshotSummaryResponseV2026 { - /** - * the date when the identity record was created - * @type {string} - * @memberof IdentitySnapshotSummaryResponseV2026 - */ - 'snapshot'?: string; -} -/** - * - * @export - * @interface IdentitySummaryV2026 - */ -export interface IdentitySummaryV2026 { - /** - * ID of this identity summary - * @type {string} - * @memberof IdentitySummaryV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity - * @type {string} - * @memberof IdentitySummaryV2026 - */ - 'name'?: string; - /** - * ID of the identity that this summary represents - * @type {string} - * @memberof IdentitySummaryV2026 - */ - 'identityId'?: string; - /** - * Indicates if all access items for this summary have been decided on - * @type {boolean} - * @memberof IdentitySummaryV2026 - */ - 'completed'?: boolean; -} -/** - * - * @export - * @interface IdentitySyncJobV2026 - */ -export interface IdentitySyncJobV2026 { - /** - * Job ID. - * @type {string} - * @memberof IdentitySyncJobV2026 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof IdentitySyncJobV2026 - */ - 'status': IdentitySyncJobV2026StatusV2026; - /** - * - * @type {IdentitySyncPayloadV2026} - * @memberof IdentitySyncJobV2026 - */ - 'payload': IdentitySyncPayloadV2026; -} - -export const IdentitySyncJobV2026StatusV2026 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type IdentitySyncJobV2026StatusV2026 = typeof IdentitySyncJobV2026StatusV2026[keyof typeof IdentitySyncJobV2026StatusV2026]; - -/** - * - * @export - * @interface IdentitySyncPayloadV2026 - */ -export interface IdentitySyncPayloadV2026 { - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2026 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof IdentitySyncPayloadV2026 - */ - 'dataJson': string; -} -/** - * - * @export - * @interface IdentityV2026 - */ -export interface IdentityV2026 { - /** - * System-generated unique ID of the identity - * @type {string} - * @memberof IdentityV2026 - */ - 'id'?: string; - /** - * The identity\'s name is equivalent to its Display Name attribute. - * @type {string} - * @memberof IdentityV2026 - */ - 'name': string; - /** - * Creation date of the identity - * @type {string} - * @memberof IdentityV2026 - */ - 'created'?: string; - /** - * Last modification date of the identity - * @type {string} - * @memberof IdentityV2026 - */ - 'modified'?: string; - /** - * The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. - * @type {string} - * @memberof IdentityV2026 - */ - 'alias'?: string; - /** - * The email address of the identity - * @type {string} - * @memberof IdentityV2026 - */ - 'emailAddress'?: string | null; - /** - * The processing state of the identity - * @type {string} - * @memberof IdentityV2026 - */ - 'processingState'?: IdentityV2026ProcessingStateV2026 | null; - /** - * The identity\'s status in the system - * @type {string} - * @memberof IdentityV2026 - */ - 'identityStatus'?: IdentityV2026IdentityStatusV2026; - /** - * - * @type {IdentityManagerRefV2026} - * @memberof IdentityV2026 - */ - 'managerRef'?: IdentityManagerRefV2026 | null; - /** - * Whether this identity is a manager of another identity - * @type {boolean} - * @memberof IdentityV2026 - */ - 'isManager'?: boolean; - /** - * The last time the identity was refreshed by the system - * @type {string} - * @memberof IdentityV2026 - */ - 'lastRefresh'?: string; - /** - * A map with the identity attributes for the identity - * @type {object} - * @memberof IdentityV2026 - */ - 'attributes'?: object; - /** - * - * @type {IdentityLifecycleStateV2026} - * @memberof IdentityV2026 - */ - 'lifecycleState'?: IdentityLifecycleStateV2026; -} - -export const IdentityV2026ProcessingStateV2026 = { - Error: 'ERROR', - Ok: 'OK' -} as const; - -export type IdentityV2026ProcessingStateV2026 = typeof IdentityV2026ProcessingStateV2026[keyof typeof IdentityV2026ProcessingStateV2026]; -export const IdentityV2026IdentityStatusV2026 = { - Unregistered: 'UNREGISTERED', - Registered: 'REGISTERED', - Pending: 'PENDING', - Warning: 'WARNING', - Disabled: 'DISABLED', - Active: 'ACTIVE', - Deactivated: 'DEACTIVATED', - Terminated: 'TERMINATED', - Error: 'ERROR', - Locked: 'LOCKED' -} as const; - -export type IdentityV2026IdentityStatusV2026 = typeof IdentityV2026IdentityStatusV2026[keyof typeof IdentityV2026IdentityStatusV2026]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface IdentityWithNewAccessAccessRefsInnerV2026 - */ -export interface IdentityWithNewAccessAccessRefsInnerV2026 { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2026 - */ - 'type'?: IdentityWithNewAccessAccessRefsInnerV2026TypeV2026; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInnerV2026 - */ - 'id'?: string; -} - -export const IdentityWithNewAccessAccessRefsInnerV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type IdentityWithNewAccessAccessRefsInnerV2026TypeV2026 = typeof IdentityWithNewAccessAccessRefsInnerV2026TypeV2026[keyof typeof IdentityWithNewAccessAccessRefsInnerV2026TypeV2026]; - -/** - * An identity with a set of access to be added - * @export - * @interface IdentityWithNewAccessV2026 - */ -export interface IdentityWithNewAccessV2026 { - /** - * Identity id to be checked. - * @type {string} - * @memberof IdentityWithNewAccessV2026 - */ - 'identityId': string; - /** - * The list of entitlements to consider for possible violations in a preventive check. - * @type {Array} - * @memberof IdentityWithNewAccessV2026 - */ - 'accessRefs': Array; -} -/** - * - * @export - * @interface IdpDetailsV2026 - */ -export interface IdpDetailsV2026 { - /** - * Federation protocol role - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'role'?: IdpDetailsV2026RoleV2026; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof IdpDetailsV2026 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2026} - * @memberof IdpDetailsV2026 - */ - 'jitConfiguration'?: JITConfigurationV2026; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof IdpDetailsV2026 - */ - 'certificateName'?: string; -} - -export const IdpDetailsV2026RoleV2026 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type IdpDetailsV2026RoleV2026 = typeof IdpDetailsV2026RoleV2026[keyof typeof IdpDetailsV2026RoleV2026]; - -/** - * - * @export - * @interface ImportAccountsRequestV2026 - */ -export interface ImportAccountsRequestV2026 { - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof ImportAccountsRequestV2026 - */ - 'file'?: File; - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof ImportAccountsRequestV2026 - */ - 'disableOptimization'?: string; -} -/** - * - * @export - * @interface ImportEntitlementsBySourceRequestV2026 - */ -export interface ImportEntitlementsBySourceRequestV2026 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsBySourceRequestV2026 - */ - 'csvFile'?: File; -} -/** - * - * @export - * @interface ImportEntitlementsRequestV2026 - */ -export interface ImportEntitlementsRequestV2026 { - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof ImportEntitlementsRequestV2026 - */ - 'file'?: File; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseErrorsInnerV2026 - */ -export interface ImportFormDefinitions202ResponseErrorsInnerV2026 { - /** - * - * @type {{ [key: string]: object; }} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2026 - */ - 'detail'?: { [key: string]: object; }; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2026 - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof ImportFormDefinitions202ResponseErrorsInnerV2026 - */ - 'text'?: string; -} -/** - * - * @export - * @interface ImportFormDefinitions202ResponseV2026 - */ -export interface ImportFormDefinitions202ResponseV2026 { - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2026 - */ - 'errors'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2026 - */ - 'importedObjects'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2026 - */ - 'infos'?: Array; - /** - * - * @type {Array} - * @memberof ImportFormDefinitions202ResponseV2026 - */ - 'warnings'?: Array; -} -/** - * - * @export - * @interface ImportFormDefinitionsRequestInnerV2026 - */ -export interface ImportFormDefinitionsRequestInnerV2026 { - /** - * - * @type {FormDefinitionResponseV2026} - * @memberof ImportFormDefinitionsRequestInnerV2026 - */ - 'object'?: FormDefinitionResponseV2026; - /** - * - * @type {string} - * @memberof ImportFormDefinitionsRequestInnerV2026 - */ - 'self'?: string; - /** - * - * @type {number} - * @memberof ImportFormDefinitionsRequestInnerV2026 - */ - 'version'?: number; -} -/** - * - * @export - * @interface ImportNonEmployeeRecordsInBulkRequestV2026 - */ -export interface ImportNonEmployeeRecordsInBulkRequestV2026 { - /** - * - * @type {File} - * @memberof ImportNonEmployeeRecordsInBulkRequestV2026 - */ - 'data': File; -} -/** - * Object created or updated by import. - * @export - * @interface ImportObjectV2026 - */ -export interface ImportObjectV2026 { - /** - * DTO type of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2026 - */ - 'type'?: ImportObjectV2026TypeV2026; - /** - * ID of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2026 - */ - 'id'?: string; - /** - * Display name of object created or updated by import. - * @type {string} - * @memberof ImportObjectV2026 - */ - 'name'?: string; -} - -export const ImportObjectV2026TypeV2026 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportObjectV2026TypeV2026 = typeof ImportObjectV2026TypeV2026[keyof typeof ImportObjectV2026TypeV2026]; - -/** - * - * @export - * @interface ImportOptionsV2026 - */ -export interface ImportOptionsV2026 { - /** - * Object type names to be excluded from an sp-config export command. - * @type {Array} - * @memberof ImportOptionsV2026 - */ - 'excludeTypes'?: Array; - /** - * Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. - * @type {Array} - * @memberof ImportOptionsV2026 - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field - * @type {{ [key: string]: ObjectExportImportOptionsV2026; }} - * @memberof ImportOptionsV2026 - */ - 'objectOptions'?: { [key: string]: ObjectExportImportOptionsV2026; }; - /** - * List of object types that can be used to resolve references on import. - * @type {Array} - * @memberof ImportOptionsV2026 - */ - 'defaultReferences'?: Array; - /** - * By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. - * @type {boolean} - * @memberof ImportOptionsV2026 - */ - 'excludeBackup'?: boolean; -} - -export const ImportOptionsV2026ExcludeTypesV2026 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2026ExcludeTypesV2026 = typeof ImportOptionsV2026ExcludeTypesV2026[keyof typeof ImportOptionsV2026ExcludeTypesV2026]; -export const ImportOptionsV2026IncludeTypesV2026 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2026IncludeTypesV2026 = typeof ImportOptionsV2026IncludeTypesV2026[keyof typeof ImportOptionsV2026IncludeTypesV2026]; -export const ImportOptionsV2026DefaultReferencesV2026 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportOptionsV2026DefaultReferencesV2026 = typeof ImportOptionsV2026DefaultReferencesV2026[keyof typeof ImportOptionsV2026DefaultReferencesV2026]; - -/** - * - * @export - * @interface ImportSpConfigRequestV2026 - */ -export interface ImportSpConfigRequestV2026 { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ImportSpConfigRequestV2026 - */ - 'data': File; - /** - * - * @type {ImportOptionsV2026} - * @memberof ImportSpConfigRequestV2026 - */ - 'options'?: ImportOptionsV2026; -} -/** - * - * @export - * @interface IndexOfV2026 - */ -export interface IndexOfV2026 { - /** - * A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - * @type {string} - * @memberof IndexOfV2026 - */ - 'substring': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IndexOfV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IndexOfV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Enum representing the currently supported indices. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const IndexV2026 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles', - Star: '*' -} as const; - -export type IndexV2026 = typeof IndexV2026[keyof typeof IndexV2026]; - - -/** - * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - * @export - * @interface InnerHitV2026 - */ -export interface InnerHitV2026 { - /** - * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof InnerHitV2026 - */ - 'query': string; - /** - * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. - * @type {string} - * @memberof InnerHitV2026 - */ - 'type': string; -} -/** - * - * @export - * @interface Int64StringKeyValuePairV2026 - */ -export interface Int64StringKeyValuePairV2026 { - /** - * The key for the tag or pair. - * @type {number} - * @memberof Int64StringKeyValuePairV2026 - */ - 'key'?: number; - /** - * The value for the tag or pair. - * @type {string} - * @memberof Int64StringKeyValuePairV2026 - */ - 'value'?: string | null; -} -/** - * - * @export - * @interface InviteIdentitiesRequestV2026 - */ -export interface InviteIdentitiesRequestV2026 { - /** - * The list of Identities IDs to invite - required when \'uninvited\' is false - * @type {Array} - * @memberof InviteIdentitiesRequestV2026 - */ - 'ids'?: Array | null; - /** - * indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. - * @type {boolean} - * @memberof InviteIdentitiesRequestV2026 - */ - 'uninvited'?: boolean; -} -/** - * Defines the Invocation type. **TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API. **REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow. - * @export - * @enum {string} - */ - -export const InvocationStatusTypeV2026 = { - Test: 'TEST', - RealTime: 'REAL_TIME' -} as const; - -export type InvocationStatusTypeV2026 = typeof InvocationStatusTypeV2026[keyof typeof InvocationStatusTypeV2026]; - - -/** - * - * @export - * @interface InvocationStatusV2026 - */ -export interface InvocationStatusV2026 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'id': string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'triggerId': string; - /** - * Subscription name - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'subscriptionName': string; - /** - * Subscription ID - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'subscriptionId': string; - /** - * - * @type {InvocationStatusTypeV2026} - * @memberof InvocationStatusV2026 - */ - 'type': InvocationStatusTypeV2026; - /** - * Invocation created timestamp. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'created': string; - /** - * Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. - * @type {string} - * @memberof InvocationStatusV2026 - */ - 'completed'?: string; - /** - * - * @type {StartInvocationInputV2026} - * @memberof InvocationStatusV2026 - */ - 'startInvocationInput': StartInvocationInputV2026; - /** - * - * @type {CompleteInvocationInputV2026} - * @memberof InvocationStatusV2026 - */ - 'completeInvocationInput'?: CompleteInvocationInputV2026; -} - - -/** - * - * @export - * @interface InvocationV2026 - */ -export interface InvocationV2026 { - /** - * Invocation ID - * @type {string} - * @memberof InvocationV2026 - */ - 'id'?: string; - /** - * Trigger ID - * @type {string} - * @memberof InvocationV2026 - */ - 'triggerId'?: string; - /** - * Unique invocation secret. - * @type {string} - * @memberof InvocationV2026 - */ - 'secret'?: string; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof InvocationV2026 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface JITActivationConfigResponseV2026 - */ -export interface JITActivationConfigResponseV2026 { - /** - * Unique identifier of this JIT activation configuration instance (persisted config id). - * @type {string} - * @memberof JITActivationConfigResponseV2026 - */ - 'id': string; - /** - * Entitlement IDs governed by JIT activation policy. May be a single-element array when only one entitlement is in scope. - * @type {Array} - * @memberof JITActivationConfigResponseV2026 - */ - 'entitlementIds'?: Array; - /** - * Maximum allowed JIT activation duration for a single grant, in minutes; null if unset. - * @type {number} - * @memberof JITActivationConfigResponseV2026 - */ - 'maxActivationPeriodMins'?: number | null; - /** - * Maximum allowed extension of an active JIT activation, in minutes; null if unset. - * @type {number} - * @memberof JITActivationConfigResponseV2026 - */ - 'maxActivationPeriodExtensionMins'?: number | null; - /** - * Default activation duration offered when a user requests JIT access, in minutes; null if unset. - * @type {number} - * @memberof JITActivationConfigResponseV2026 - */ - 'defaultMaxActivationPeriodMins'?: number | null; - /** - * Default extension duration offered for an active JIT activation, in minutes; null if unset. - * @type {number} - * @memberof JITActivationConfigResponseV2026 - */ - 'defaultMaxActivationPeriodExtensionMins'?: number | null; - /** - * Email addresses notified for JIT activation events (for example policy owners or a shared mailbox). - * @type {Array} - * @memberof JITActivationConfigResponseV2026 - */ - 'notificationRecipients'?: Array; - /** - * Name or key of the email template used for JIT activation notifications; null if unset. - * @type {string} - * @memberof JITActivationConfigResponseV2026 - */ - 'notificationTemplate'?: string | null; - /** - * Whether the policy applies to future entitlement assignments. - * @type {boolean} - * @memberof JITActivationConfigResponseV2026 - */ - 'applyToFutureAssignments': boolean; -} -/** - * - * @export - * @interface JITConfigurationV2026 - */ -export interface JITConfigurationV2026 { - /** - * The indicator for just-in-time provisioning enabled - * @type {boolean} - * @memberof JITConfigurationV2026 - */ - 'enabled'?: boolean; - /** - * the sourceId that mapped to just-in-time provisioning configuration - * @type {string} - * @memberof JITConfigurationV2026 - */ - 'sourceId'?: string; - /** - * A mapping of identity profile attribute names to SAML assertion attribute names - * @type {{ [key: string]: string; }} - * @memberof JITConfigurationV2026 - */ - 'sourceAttributeMappings'?: { [key: string]: string; }; -} -/** - * JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests. - * @export - * @interface JWKSV2026 - */ -export interface JWKSV2026 { - /** - * Array of JSON Web Keys. - * @type {Array} - * @memberof JWKSV2026 - */ - 'keys': Array; -} -/** - * A single JSON Web Key used for verifying signed delivery requests. - * @export - * @interface JWKV2026 - */ -export interface JWKV2026 { - /** - * Algorithm intended for use with the key (e.g. RS256). - * @type {string} - * @memberof JWKV2026 - */ - 'alg'?: string; - /** - * RSA public exponent (Base64url encoded). - * @type {string} - * @memberof JWKV2026 - */ - 'e'?: string; - /** - * Key ID - unique identifier for the key. - * @type {string} - * @memberof JWKV2026 - */ - 'kid'?: string; - /** - * Key type (e.g. RSA). - * @type {string} - * @memberof JWKV2026 - */ - 'kty'?: string; - /** - * RSA modulus (Base64url encoded). - * @type {string} - * @memberof JWKV2026 - */ - 'n'?: string; - /** - * Intended use of the key (e.g. sig for signature verification). - * @type {string} - * @memberof JWKV2026 - */ - 'use'?: string; -} -/** - * A single replace operation applied to JIT activation configuration. Only **replace** is supported. **path** must be one of the allowed JSON Pointer-style paths. - * @export - * @interface JitAccessOperationRequestV2026 - */ -export interface JitAccessOperationRequestV2026 { - /** - * Operation type. Defaults to `replace` if omitted. - * @type {string} - * @memberof JitAccessOperationRequestV2026 - */ - 'op'?: JitAccessOperationRequestV2026OpV2026; - /** - * Path to replace. Only the following JSON Pointer-style paths are supported. - * @type {string} - * @memberof JitAccessOperationRequestV2026 - */ - 'path': JitAccessOperationRequestV2026PathV2026; - /** - * - * @type {JitAccessOperationRequestValueV2026} - * @memberof JitAccessOperationRequestV2026 - */ - 'value': JitAccessOperationRequestValueV2026 | null; -} - -export const JitAccessOperationRequestV2026OpV2026 = { - Replace: 'replace' -} as const; - -export type JitAccessOperationRequestV2026OpV2026 = typeof JitAccessOperationRequestV2026OpV2026[keyof typeof JitAccessOperationRequestV2026OpV2026]; -export const JitAccessOperationRequestV2026PathV2026 = { - EntitlementIds: '/entitlementIds', - MaxActivationPeriodMins: '/maxActivationPeriodMins', - MaxActivationPeriodExtensionMins: '/maxActivationPeriodExtensionMins', - DefaultMaxActivationPeriodMins: '/defaultMaxActivationPeriodMins', - DefaultMaxActivationPeriodExtensionMins: '/defaultMaxActivationPeriodExtensionMins', - NotificationRecipients: '/notificationRecipients', - NotificationTemplate: '/notificationTemplate', - ApplyToFutureAssignments: '/applyToFutureAssignments' -} as const; - -export type JitAccessOperationRequestV2026PathV2026 = typeof JitAccessOperationRequestV2026PathV2026[keyof typeof JitAccessOperationRequestV2026PathV2026]; - -/** - * @type JitAccessOperationRequestValueV2026 - * New value. Type depends on **path**: arrays of strings for `/entitlementIds` and `/notificationRecipients`, integer for `*Mins` paths, string for `/notificationTemplate`, boolean for `/applyToFutureAssignments`. Use `null` when clearing nullable fields (for example `/notificationTemplate` or `*Mins` paths). - * @export - */ -export type JitAccessOperationRequestValueV2026 = Array | boolean | number | string; - -/** - * - * @export - * @interface JitActivationActivateRequestV2026 - */ -export interface JitActivationActivateRequestV2026 { - /** - * Entitlement connection identifier for the activation. - * @type {string} - * @memberof JitActivationActivateRequestV2026 - */ - 'connectionId': string; - /** - * Requested activation duration in minutes. - * @type {number} - * @memberof JitActivationActivateRequestV2026 - */ - 'activationPeriodMins': number; -} -/** - * - * @export - * @interface JitActivationActivateResponseV2026 - */ -export interface JitActivationActivateResponseV2026 { - /** - * Workflow or business identifier for this activation. - * @type {string} - * @memberof JitActivationActivateResponseV2026 - */ - 'id': string; - /** - * Persistent activation record identifier for this JIT activation. - * @type {string} - * @memberof JitActivationActivateResponseV2026 - */ - 'activationId': string; - /** - * Entitlement connection identifier for the activation. - * @type {string} - * @memberof JitActivationActivateResponseV2026 - */ - 'connectionId': string; - /** - * Activation duration in minutes for this workflow. - * @type {number} - * @memberof JitActivationActivateResponseV2026 - */ - 'activationPeriodMins': number; - /** - * - * @type {ActivationWorkflowStatusV2026} - * @memberof JitActivationActivateResponseV2026 - */ - 'status': ActivationWorkflowStatusV2026; - /** - * Time when the activation workflow was started (ISO-8601). - * @type {string} - * @memberof JitActivationActivateResponseV2026 - */ - 'startTime': string; -} - - -/** - * - * @export - * @interface JitActivationDeactivateRequestV2026 - */ -export interface JitActivationDeactivateRequestV2026 { - /** - * Entitlement connection identifier for the activation to deactivate. - * @type {string} - * @memberof JitActivationDeactivateRequestV2026 - */ - 'connectionId': string; -} -/** - * - * @export - * @interface JitActivationDeactivateResponseV2026 - */ -export interface JitActivationDeactivateResponseV2026 { - /** - * Workflow or business identifier for this activation. - * @type {string} - * @memberof JitActivationDeactivateResponseV2026 - */ - 'id': string; - /** - * Persistent activation record identifier for this JIT activation. - * @type {string} - * @memberof JitActivationDeactivateResponseV2026 - */ - 'activationId': string; - /** - * Entitlement connection identifier for the activation. - * @type {string} - * @memberof JitActivationDeactivateResponseV2026 - */ - 'connectionId': string; - /** - * - * @type {ActivationWorkflowStatusV2026} - * @memberof JitActivationDeactivateResponseV2026 - */ - 'status': ActivationWorkflowStatusV2026; - /** - * Time associated with this deactivation request (ISO-8601). - * @type {string} - * @memberof JitActivationDeactivateResponseV2026 - */ - 'startTime': string; -} - - -/** - * - * @export - * @interface JitActivationExtendRequestV2026 - */ -export interface JitActivationExtendRequestV2026 { - /** - * Entitlement connection identifier for the activation to extend. - * @type {string} - * @memberof JitActivationExtendRequestV2026 - */ - 'connectionId': string; - /** - * Number of minutes to extend the activation period. - * @type {number} - * @memberof JitActivationExtendRequestV2026 - */ - 'activationPeriodExtensionMins': number; -} -/** - * - * @export - * @interface JitActivationExtendResponseV2026 - */ -export interface JitActivationExtendResponseV2026 { - /** - * Workflow or business identifier for this activation. - * @type {string} - * @memberof JitActivationExtendResponseV2026 - */ - 'id': string; - /** - * Persistent activation record identifier for this JIT activation. - * @type {string} - * @memberof JitActivationExtendResponseV2026 - */ - 'activationId': string; - /** - * Entitlement connection identifier for the activation. - * @type {string} - * @memberof JitActivationExtendResponseV2026 - */ - 'connectionId': string; - /** - * Extension applied to the activation period, in minutes. - * @type {number} - * @memberof JitActivationExtendResponseV2026 - */ - 'activationPeriodExtensionMins': number; - /** - * - * @type {ActivationWorkflowStatusV2026} - * @memberof JitActivationExtendResponseV2026 - */ - 'status': ActivationWorkflowStatusV2026; - /** - * Time associated with this extend request (ISO-8601). - * @type {string} - * @memberof JitActivationExtendResponseV2026 - */ - 'startTime': string; -} - - -/** - * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationRoleMiningV2026 - */ -export interface JsonPatchOperationRoleMiningV2026 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2026 - */ - 'op': JsonPatchOperationRoleMiningV2026OpV2026; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationRoleMiningV2026 - */ - 'path': string; - /** - * - * @type {JsonPatchOperationRoleMiningValueV2026} - * @memberof JsonPatchOperationRoleMiningV2026 - */ - 'value'?: JsonPatchOperationRoleMiningValueV2026; -} - -export const JsonPatchOperationRoleMiningV2026OpV2026 = { - Remove: 'remove', - Replace: 'replace' -} as const; - -export type JsonPatchOperationRoleMiningV2026OpV2026 = typeof JsonPatchOperationRoleMiningV2026OpV2026[keyof typeof JsonPatchOperationRoleMiningV2026OpV2026]; - -/** - * @type JsonPatchOperationRoleMiningValueV2026 - * The value to be used for the operation, required for \"replace\" operations - * @export - */ -export type JsonPatchOperationRoleMiningValueV2026 = Array | boolean | number | object | string; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchOperationV2026 - */ -export interface JsonPatchOperationV2026 { - /** - * The operation to be performed - * @type {string} - * @memberof JsonPatchOperationV2026 - */ - 'op': JsonPatchOperationV2026OpV2026; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof JsonPatchOperationV2026 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2026} - * @memberof JsonPatchOperationV2026 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2026; -} - -export const JsonPatchOperationV2026OpV2026 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type JsonPatchOperationV2026OpV2026 = typeof JsonPatchOperationV2026OpV2026[keyof typeof JsonPatchOperationV2026OpV2026]; - -/** - * A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface JsonPatchV2026 - */ -export interface JsonPatchV2026 { - /** - * Operations to be applied - * @type {Array} - * @memberof JsonPatchV2026 - */ - 'operations'?: Array; -} -/** - * - * @export - * @interface KbaAnswerRequestItemV2026 - */ -export interface KbaAnswerRequestItemV2026 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerRequestItemV2026 - */ - 'id': string; - /** - * An answer for the KBA question - * @type {string} - * @memberof KbaAnswerRequestItemV2026 - */ - 'answer': string; -} -/** - * - * @export - * @interface KbaAnswerResponseItemV2026 - */ -export interface KbaAnswerResponseItemV2026 { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerResponseItemV2026 - */ - 'id': string; - /** - * Question description - * @type {string} - * @memberof KbaAnswerResponseItemV2026 - */ - 'question': string; - /** - * Denotes whether the KBA question has an answer configured for the current user - * @type {boolean} - * @memberof KbaAnswerResponseItemV2026 - */ - 'hasAnswer': boolean; -} -/** - * KBA Configuration - * @export - * @interface KbaQuestionV2026 - */ -export interface KbaQuestionV2026 { - /** - * KBA Question Id - * @type {string} - * @memberof KbaQuestionV2026 - */ - 'id': string; - /** - * KBA Question description - * @type {string} - * @memberof KbaQuestionV2026 - */ - 'text': string; - /** - * Denotes whether the KBA question has an answer configured for any user in the tenant - * @type {boolean} - * @memberof KbaQuestionV2026 - */ - 'hasAnswer': boolean; - /** - * Denotes the number of KBA configurations for this question - * @type {number} - * @memberof KbaQuestionV2026 - */ - 'numAnswers': number; -} -/** - * - * @export - * @interface LatestOutlierSummaryV2026 - */ -export interface LatestOutlierSummaryV2026 { - /** - * The type of outlier summary - * @type {string} - * @memberof LatestOutlierSummaryV2026 - */ - 'type'?: LatestOutlierSummaryV2026TypeV2026; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof LatestOutlierSummaryV2026 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2026 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof LatestOutlierSummaryV2026 - */ - 'totalIdentities'?: number; - /** - * Total number of ignored outliers - * @type {number} - * @memberof LatestOutlierSummaryV2026 - */ - 'totalIgnored'?: number; -} - -export const LatestOutlierSummaryV2026TypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type LatestOutlierSummaryV2026TypeV2026 = typeof LatestOutlierSummaryV2026TypeV2026[keyof typeof LatestOutlierSummaryV2026TypeV2026]; - -/** - * Owner of the Launcher - * @export - * @interface LauncherOwnerV2026 - */ -export interface LauncherOwnerV2026 { - /** - * Owner type - * @type {string} - * @memberof LauncherOwnerV2026 - */ - 'type': string; - /** - * Owner ID - * @type {string} - * @memberof LauncherOwnerV2026 - */ - 'id': string; -} -/** - * - * @export - * @interface LauncherReferenceV2026 - */ -export interface LauncherReferenceV2026 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2026 - */ - 'type'?: LauncherReferenceV2026TypeV2026; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherReferenceV2026 - */ - 'id'?: string; -} - -export const LauncherReferenceV2026TypeV2026 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherReferenceV2026TypeV2026 = typeof LauncherReferenceV2026TypeV2026[keyof typeof LauncherReferenceV2026TypeV2026]; - -/** - * - * @export - * @interface LauncherRequestReferenceV2026 - */ -export interface LauncherRequestReferenceV2026 { - /** - * Type of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2026 - */ - 'type': LauncherRequestReferenceV2026TypeV2026; - /** - * ID of Launcher reference - * @type {string} - * @memberof LauncherRequestReferenceV2026 - */ - 'id': string; -} - -export const LauncherRequestReferenceV2026TypeV2026 = { - Workflow: 'WORKFLOW' -} as const; - -export type LauncherRequestReferenceV2026TypeV2026 = typeof LauncherRequestReferenceV2026TypeV2026[keyof typeof LauncherRequestReferenceV2026TypeV2026]; - -/** - * - * @export - * @interface LauncherRequestV2026 - */ -export interface LauncherRequestV2026 { - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherRequestV2026 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherRequestV2026 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherRequestV2026 - */ - 'type': LauncherRequestV2026TypeV2026; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherRequestV2026 - */ - 'disabled': boolean; - /** - * - * @type {LauncherRequestReferenceV2026} - * @memberof LauncherRequestV2026 - */ - 'reference'?: LauncherRequestReferenceV2026; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherRequestV2026 - */ - 'config': string; -} - -export const LauncherRequestV2026TypeV2026 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherRequestV2026TypeV2026 = typeof LauncherRequestV2026TypeV2026[keyof typeof LauncherRequestV2026TypeV2026]; - -/** - * - * @export - * @interface LauncherV2026 - */ -export interface LauncherV2026 { - /** - * ID of the Launcher - * @type {string} - * @memberof LauncherV2026 - */ - 'id': string; - /** - * Date the Launcher was created - * @type {string} - * @memberof LauncherV2026 - */ - 'created': string; - /** - * Date the Launcher was last modified - * @type {string} - * @memberof LauncherV2026 - */ - 'modified': string; - /** - * - * @type {LauncherOwnerV2026} - * @memberof LauncherV2026 - */ - 'owner': LauncherOwnerV2026; - /** - * Name of the Launcher, limited to 255 characters - * @type {string} - * @memberof LauncherV2026 - */ - 'name': string; - /** - * Description of the Launcher, limited to 2000 characters - * @type {string} - * @memberof LauncherV2026 - */ - 'description': string; - /** - * Launcher type - * @type {string} - * @memberof LauncherV2026 - */ - 'type': LauncherV2026TypeV2026; - /** - * State of the Launcher - * @type {boolean} - * @memberof LauncherV2026 - */ - 'disabled': boolean; - /** - * - * @type {LauncherReferenceV2026} - * @memberof LauncherV2026 - */ - 'reference'?: LauncherReferenceV2026; - /** - * JSON configuration associated with this Launcher, restricted to a max size of 4KB - * @type {string} - * @memberof LauncherV2026 - */ - 'config': string; -} - -export const LauncherV2026TypeV2026 = { - InteractiveProcess: 'INTERACTIVE_PROCESS' -} as const; - -export type LauncherV2026TypeV2026 = typeof LauncherV2026TypeV2026[keyof typeof LauncherV2026TypeV2026]; - -/** - * - * @export - * @interface LeftPadV2026 - */ -export interface LeftPadV2026 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof LeftPadV2026 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof LeftPadV2026 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LeftPadV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LeftPadV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LicenseV2026 - */ -export interface LicenseV2026 { - /** - * Name of the license - * @type {string} - * @memberof LicenseV2026 - */ - 'licenseId'?: string; - /** - * Legacy name of the license - * @type {string} - * @memberof LicenseV2026 - */ - 'legacyFeatureName'?: string; -} -/** - * - * @export - * @interface LifecycleStateDtoV2026 - */ -export interface LifecycleStateDtoV2026 { - /** - * The name of the lifecycle state - * @type {string} - * @memberof LifecycleStateDtoV2026 - */ - 'stateName': string; - /** - * Whether the lifecycle state has been manually or automatically set - * @type {boolean} - * @memberof LifecycleStateDtoV2026 - */ - 'manuallyUpdated': boolean; -} -/** - * - * @export - * @interface LifecycleStateV2026 - */ -export interface LifecycleStateV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'modified'?: string; - /** - * Indicates whether the lifecycle state is enabled or disabled. - * @type {boolean} - * @memberof LifecycleStateV2026 - */ - 'enabled'?: boolean; - /** - * The lifecycle state\'s technical name. This is for internal use. - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'technicalName': string; - /** - * Lifecycle state\'s description. - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'description'?: string | null; - /** - * Number of identities that have the lifecycle state. - * @type {number} - * @memberof LifecycleStateV2026 - */ - 'identityCount'?: number; - /** - * - * @type {EmailNotificationOptionV2026} - * @memberof LifecycleStateV2026 - */ - 'emailNotificationOption'?: EmailNotificationOptionV2026; - /** - * - * @type {Array} - * @memberof LifecycleStateV2026 - */ - 'accountActions'?: Array; - /** - * List of unique access-profile IDs that are associated with the lifecycle state. - * @type {Set} - * @memberof LifecycleStateV2026 - */ - 'accessProfileIds'?: Set; - /** - * The lifecycle state\'s associated identity state. This field is generally \'null\'. - * @type {string} - * @memberof LifecycleStateV2026 - */ - 'identityState'?: LifecycleStateV2026IdentityStateV2026 | null; - /** - * - * @type {AccessActionConfigurationV2026} - * @memberof LifecycleStateV2026 - */ - 'accessActionConfiguration'?: AccessActionConfigurationV2026; - /** - * Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10. - * @type {number} - * @memberof LifecycleStateV2026 - */ - 'priority'?: number | null; -} - -export const LifecycleStateV2026IdentityStateV2026 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type LifecycleStateV2026IdentityStateV2026 = typeof LifecycleStateV2026IdentityStateV2026[keyof typeof LifecycleStateV2026IdentityStateV2026]; - -/** - * Deleted lifecycle state. - * @export - * @interface LifecyclestateDeletedV2026 - */ -export interface LifecyclestateDeletedV2026 { - /** - * Deleted lifecycle state\'s DTO type. - * @type {string} - * @memberof LifecyclestateDeletedV2026 - */ - 'type'?: LifecyclestateDeletedV2026TypeV2026; - /** - * Deleted lifecycle state ID. - * @type {string} - * @memberof LifecyclestateDeletedV2026 - */ - 'id'?: string; - /** - * Deleted lifecycle state\'s display name. - * @type {string} - * @memberof LifecyclestateDeletedV2026 - */ - 'name'?: string; -} - -export const LifecyclestateDeletedV2026TypeV2026 = { - LifecycleState: 'LIFECYCLE_STATE', - TaskResult: 'TASK_RESULT' -} as const; - -export type LifecyclestateDeletedV2026TypeV2026 = typeof LifecyclestateDeletedV2026TypeV2026[keyof typeof LifecyclestateDeletedV2026TypeV2026]; - -/** - * - * @export - * @interface ListCampaignFilters200ResponseV2026 - */ -export interface ListCampaignFilters200ResponseV2026 { - /** - * List of campaign filters. - * @type {Array} - * @memberof ListCampaignFilters200ResponseV2026 - */ - 'items'?: Array; - /** - * Number of filters returned. - * @type {number} - * @memberof ListCampaignFilters200ResponseV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ -export interface ListCompleteWorkflowLibrary200ResponseInnerV2026 { - /** - * Operator ID. - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'description'?: string; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2026} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2026; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'isDynamicSchema'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'outputSchema'?: object; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInnerV2026 - */ - 'inputExample'?: object | null; -} -/** - * - * @export - * @interface ListDeploys200ResponseV2026 - */ -export interface ListDeploys200ResponseV2026 { - /** - * list of deployments - * @type {Array} - * @memberof ListDeploys200ResponseV2026 - */ - 'items'?: Array; -} -/** - * - * @export - * @interface ListEntitlementConnections412ResponseV2026 - */ -export interface ListEntitlementConnections412ResponseV2026 { - /** - * A message describing the error - * @type {object} - * @memberof ListEntitlementConnections412ResponseV2026 - */ - 'message'?: object; -} -/** - * - * @export - * @interface ListFormDefinitionsByTenantResponseV2026 - */ -export interface ListFormDefinitionsByTenantResponseV2026 { - /** - * Count number of results. - * @type {number} - * @memberof ListFormDefinitionsByTenantResponseV2026 - */ - 'count'?: number; - /** - * List of FormDefinitionResponse items. - * @type {Array} - * @memberof ListFormDefinitionsByTenantResponseV2026 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface ListFormElementDataByElementIDResponseV2026 - */ -export interface ListFormElementDataByElementIDResponseV2026 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof ListFormElementDataByElementIDResponseV2026 - */ - 'results'?: Array; -} -/** - * List of FormInstanceResponse items - * @export - * @interface ListFormInstancesByTenantResponseV2026 - */ -export interface ListFormInstancesByTenantResponseV2026 { - /** - * Unique guid identifying this form instance - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'id'?: string; - /** - * Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'expire'?: string; - /** - * State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'state'?: ListFormInstancesByTenantResponseV2026StateV2026; - /** - * StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form - * @type {boolean} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'standAloneForm'?: boolean; - /** - * StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'standAloneFormUrl'?: string; - /** - * - * @type {FormInstanceCreatedByV2026} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'createdBy'?: FormInstanceCreatedByV2026; - /** - * FormDefinitionID is the id of the form definition that created this form - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formDefinitionId'?: string; - /** - * FormInput is an object of form input labels to value - * @type {{ [key: string]: object; }} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formInput'?: { [key: string]: object; } | null; - /** - * FormElements is the configuration of the form, this would be a repeat of the fields from the form-config - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formElements'?: Array; - /** - * FormData is the data provided by the form on submit. The data is in a key -> value map - * @type {{ [key: string]: any; }} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formData'?: { [key: string]: any; } | null; - /** - * FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formErrors'?: Array; - /** - * FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'formConditions'?: Array; - /** - * Created is the date the form instance was assigned - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'created'?: string; - /** - * Modified is the last date the form instance was modified - * @type {string} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'modified'?: string; - /** - * Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it - * @type {Array} - * @memberof ListFormInstancesByTenantResponseV2026 - */ - 'recipients'?: Array; -} - -export const ListFormInstancesByTenantResponseV2026StateV2026 = { - Assigned: 'ASSIGNED', - InProgress: 'IN_PROGRESS', - Submitted: 'SUBMITTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED' -} as const; - -export type ListFormInstancesByTenantResponseV2026StateV2026 = typeof ListFormInstancesByTenantResponseV2026StateV2026[keyof typeof ListFormInstancesByTenantResponseV2026StateV2026]; - -/** - * - * @export - * @interface ListIdentityAccessItems200ResponseInnerV2026 - */ -export interface ListIdentityAccessItems200ResponseInnerV2026 { - /** - * the access item id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'id'?: string; - /** - * the access item type. entitlement in this case - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'accessType'?: string; - /** - * the access item display name - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'displayName'?: string; - /** - * the associated source name if it exists - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'sourceName'?: string | null; - /** - * the entitlement attribute - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'attribute': string; - /** - * the associated value - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'value': string; - /** - * the type of entitlement - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'type': string; - /** - * the description for the role - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'description'?: string; - /** - * the id of the source - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'sourceId'?: string; - /** - * indicates whether the access profile is standalone - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'standalone': boolean | null; - /** - * indicates whether the entitlement is privileged - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'privileged': boolean | null; - /** - * indicates whether the entitlement is cloud governed - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'cloudGoverned': boolean | null; - /** - * the number of entitlements the account will create - * @type {number} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'entitlementCount': number; - /** - * the list of app ids associated with the access profile - * @type {Array} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'appRefs': Array; - /** - * the date the access profile will be assigned to the specified identity, in case requested with a future start date - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'startDate'?: string | null; - /** - * the date the role is no longer assigned to the specified identity - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'removeDate'?: string; - /** - * indicates whether the role is revocable - * @type {boolean} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'revocable': boolean; - /** - * the native identifier used to uniquely identify an acccount - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'nativeIdentity': string; - /** - * the app role id - * @type {string} - * @memberof ListIdentityAccessItems200ResponseInnerV2026 - */ - 'appRoleId': string | null; -} -/** - * @type ListIdentitySnapshotAccessItems200ResponseInnerV2026 - * @export - */ -export type ListIdentitySnapshotAccessItems200ResponseInnerV2026 = AccessItemAccessProfileResponseV2026 | AccessItemAccountResponseV2026 | AccessItemAppResponseV2026 | AccessItemEntitlementResponseV2026 | AccessItemRoleResponseV2026; - -/** - * - * @export - * @interface ListPredefinedSelectOptionsResponseV2026 - */ -export interface ListPredefinedSelectOptionsResponseV2026 { - /** - * Results holds a list of PreDefinedSelectOption items - * @type {Array} - * @memberof ListPredefinedSelectOptionsResponseV2026 - */ - 'results'?: Array; -} -/** - * Identity of workgroup member. - * @export - * @interface ListWorkgroupMembers200ResponseInnerV2026 - */ -export interface ListWorkgroupMembers200ResponseInnerV2026 { - /** - * Workgroup member identity DTO type. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2026 - */ - 'type'?: ListWorkgroupMembers200ResponseInnerV2026TypeV2026; - /** - * Workgroup member identity ID. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2026 - */ - 'id'?: string; - /** - * Workgroup member identity display name. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2026 - */ - 'name'?: string; - /** - * Workgroup member identity email. - * @type {string} - * @memberof ListWorkgroupMembers200ResponseInnerV2026 - */ - 'email'?: string; -} - -export const ListWorkgroupMembers200ResponseInnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ListWorkgroupMembers200ResponseInnerV2026TypeV2026 = typeof ListWorkgroupMembers200ResponseInnerV2026TypeV2026[keyof typeof ListWorkgroupMembers200ResponseInnerV2026TypeV2026]; - -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadAccountsTaskTaskAttributesV2026 - */ -export interface LoadAccountsTaskTaskAttributesV2026 { - [key: string]: object | any; - - /** - * The id of the source - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2026 - */ - 'appId'?: string; - /** - * The indicator if the aggregation process was enabled/disabled for the aggregation job - * @type {string} - * @memberof LoadAccountsTaskTaskAttributesV2026 - */ - 'optimizedAggregation'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskMessagesInnerV2026 - */ -export interface LoadAccountsTaskTaskMessagesInnerV2026 { - /** - * Type of the message. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2026 - */ - 'type'?: LoadAccountsTaskTaskMessagesInnerV2026TypeV2026; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2026 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadAccountsTaskTaskMessagesInnerV2026 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2026 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadAccountsTaskTaskMessagesInnerV2026 - */ - 'localizedText'?: string; -} - -export const LoadAccountsTaskTaskMessagesInnerV2026TypeV2026 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadAccountsTaskTaskMessagesInnerV2026TypeV2026 = typeof LoadAccountsTaskTaskMessagesInnerV2026TypeV2026[keyof typeof LoadAccountsTaskTaskMessagesInnerV2026TypeV2026]; - -/** - * - * @export - * @interface LoadAccountsTaskTaskReturnsInnerV2026 - */ -export interface LoadAccountsTaskTaskReturnsInnerV2026 { - /** - * The display label of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2026 - */ - 'displayLabel'?: string; - /** - * The attribute name of the return value - * @type {string} - * @memberof LoadAccountsTaskTaskReturnsInnerV2026 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadAccountsTaskTaskV2026 - */ -export interface LoadAccountsTaskTaskV2026 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'type'?: string; - /** - * The name of the aggregation process - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'completionStatus'?: LoadAccountsTaskTaskV2026CompletionStatusV2026 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'progress'?: string | null; - /** - * - * @type {LoadAccountsTaskTaskAttributesV2026} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'attributes'?: LoadAccountsTaskTaskAttributesV2026; - /** - * Return values from the task - * @type {Array} - * @memberof LoadAccountsTaskTaskV2026 - */ - 'returns'?: Array; -} - -export const LoadAccountsTaskTaskV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadAccountsTaskTaskV2026CompletionStatusV2026 = typeof LoadAccountsTaskTaskV2026CompletionStatusV2026[keyof typeof LoadAccountsTaskTaskV2026CompletionStatusV2026]; - -/** - * - * @export - * @interface LoadAccountsTaskV2026 - */ -export interface LoadAccountsTaskV2026 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadAccountsTaskV2026 - */ - 'success'?: boolean; - /** - * - * @type {LoadAccountsTaskTaskV2026} - * @memberof LoadAccountsTaskV2026 - */ - 'task'?: LoadAccountsTaskTaskV2026; -} -/** - * - * @export - * @interface LoadEntitlementTaskReturnsInnerV2026 - */ -export interface LoadEntitlementTaskReturnsInnerV2026 { - /** - * The display label for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2026 - */ - 'displayLabel'?: string; - /** - * The attribute name for the return value - * @type {string} - * @memberof LoadEntitlementTaskReturnsInnerV2026 - */ - 'attributeName'?: string; -} -/** - * - * @export - * @interface LoadEntitlementTaskV2026 - */ -export interface LoadEntitlementTaskV2026 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'type'?: string; - /** - * The name of the task - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'uniqueName'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'launcher'?: string; - /** - * The creation date of the task - * @type {string} - * @memberof LoadEntitlementTaskV2026 - */ - 'created'?: string; - /** - * Return values from the task - * @type {Array} - * @memberof LoadEntitlementTaskV2026 - */ - 'returns'?: Array; -} -/** - * Extra attributes map(dictionary) for the task. - * @export - * @interface LoadUncorrelatedAccountsTaskTaskAttributesV2026 - */ -export interface LoadUncorrelatedAccountsTaskTaskAttributesV2026 { - /** - * The id of qpoc job - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2026 - */ - 'qpocJobId'?: string; - /** - * the task start delay value - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskAttributesV2026 - */ - 'taskStartDelay'?: object; -} -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ -export interface LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 { - /** - * Type of the message. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ - 'type'?: LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026TypeV2026; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026 - */ - 'localizedText'?: string; -} - -export const LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026TypeV2026 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026TypeV2026 = typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026TypeV2026[keyof typeof LoadUncorrelatedAccountsTaskTaskMessagesInnerV2026TypeV2026]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskTaskV2026 - */ -export interface LoadUncorrelatedAccountsTaskTaskV2026 { - /** - * System-generated unique ID of the task this taskStatus represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'id'?: string; - /** - * Type of task this task represents - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'type'?: string; - /** - * The name of uncorrelated accounts process - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'name'?: string; - /** - * The description of the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'description'?: string; - /** - * The user who initiated the task - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'launcher'?: string; - /** - * The Task creation date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'created'?: string; - /** - * The task start date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'launched'?: string | null; - /** - * The task completion date - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'completed'?: string | null; - /** - * Task completion status. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'completionStatus'?: LoadUncorrelatedAccountsTaskTaskV2026CompletionStatusV2026 | null; - /** - * Name of the parent task if exists. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'parentName'?: string | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'messages'?: Array; - /** - * Current task state. - * @type {string} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'progress'?: string | null; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskAttributesV2026} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'attributes'?: LoadUncorrelatedAccountsTaskTaskAttributesV2026; - /** - * Return values from the task - * @type {object} - * @memberof LoadUncorrelatedAccountsTaskTaskV2026 - */ - 'returns'?: object; -} - -export const LoadUncorrelatedAccountsTaskTaskV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type LoadUncorrelatedAccountsTaskTaskV2026CompletionStatusV2026 = typeof LoadUncorrelatedAccountsTaskTaskV2026CompletionStatusV2026[keyof typeof LoadUncorrelatedAccountsTaskTaskV2026CompletionStatusV2026]; - -/** - * - * @export - * @interface LoadUncorrelatedAccountsTaskV2026 - */ -export interface LoadUncorrelatedAccountsTaskV2026 { - /** - * The status of the result - * @type {boolean} - * @memberof LoadUncorrelatedAccountsTaskV2026 - */ - 'success'?: boolean; - /** - * - * @type {LoadUncorrelatedAccountsTaskTaskV2026} - * @memberof LoadUncorrelatedAccountsTaskV2026 - */ - 'task'?: LoadUncorrelatedAccountsTaskTaskV2026; -} -/** - * 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 LocaleOriginV2026 = { - Default: 'DEFAULT', - Request: 'REQUEST' -} as const; - -export type LocaleOriginV2026 = typeof LocaleOriginV2026[keyof typeof LocaleOriginV2026]; - - -/** - * Localized error message to indicate a failed invocation or error if any. - * @export - * @interface LocalizedMessageV2026 - */ -export interface LocalizedMessageV2026 { - /** - * Message locale - * @type {string} - * @memberof LocalizedMessageV2026 - */ - 'locale': string; - /** - * Message text - * @type {string} - * @memberof LocalizedMessageV2026 - */ - 'message': string; -} -/** - * - * @export - * @interface LockoutConfigurationV2026 - */ -export interface LockoutConfigurationV2026 { - /** - * The maximum attempts allowed before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2026 - */ - 'maximumAttempts'?: number; - /** - * The total time in minutes a user will be locked out. - * @type {number} - * @memberof LockoutConfigurationV2026 - */ - 'lockoutDuration'?: number; - /** - * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. - * @type {number} - * @memberof LockoutConfigurationV2026 - */ - 'lockoutWindow'?: number; -} -/** - * The definition of an Identity according to the Reassignment Configuration service - * @export - * @interface LookupStepV2026 - */ -export interface LookupStepV2026 { - /** - * The ID of the Identity who work is reassigned to - * @type {string} - * @memberof LookupStepV2026 - */ - 'reassignedToId'?: string; - /** - * The ID of the Identity who work is reassigned from - * @type {string} - * @memberof LookupStepV2026 - */ - 'reassignedFromId'?: string; - /** - * - * @type {ReassignmentTypeEnumV2026} - * @memberof LookupStepV2026 - */ - 'reassignmentType'?: ReassignmentTypeEnumV2026; -} - - -/** - * - * @export - * @interface LookupV2026 - */ -export interface LookupV2026 { - /** - * This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform. - * @type {{ [key: string]: any; }} - * @memberof LookupV2026 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LookupV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LookupV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LowerV2026 - */ -export interface LowerV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LowerV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LowerV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MachineAccountCreateAccessDtoSubtypesInnerV2026 - */ -export interface MachineAccountCreateAccessDtoSubtypesInnerV2026 { - /** - * Subtype ID. - * @type {string} - * @memberof MachineAccountCreateAccessDtoSubtypesInnerV2026 - */ - 'subtypeId'?: string; - /** - * Entitlement ID. - * @type {string} - * @memberof MachineAccountCreateAccessDtoSubtypesInnerV2026 - */ - 'entitlementId'?: string; - /** - * Subtype display name. - * @type {string} - * @memberof MachineAccountCreateAccessDtoSubtypesInnerV2026 - */ - 'subtypeDisplayName'?: string; - /** - * Subtype technical name. - * @type {string} - * @memberof MachineAccountCreateAccessDtoSubtypesInnerV2026 - */ - 'subtypeTechnicalName'?: string; -} -/** - * A summary endpoint which returns list of sources and subtypes for which user has an entitlement to request machine accounts. - * @export - * @interface MachineAccountCreateAccessDtoV2026 - */ -export interface MachineAccountCreateAccessDtoV2026 { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountCreateAccessDtoV2026 - */ - 'sourceId'?: string; - /** - * Source name. - * @type {string} - * @memberof MachineAccountCreateAccessDtoV2026 - */ - 'sourceName'?: string; - /** - * List of subtypes for which the user has an entitlement to request machine accounts. - * @type {Array} - * @memberof MachineAccountCreateAccessDtoV2026 - */ - 'subtypes'?: Array; -} -/** - * Contains the required information for processing a user-initiated machine account creation request. - * @export - * @interface MachineAccountCreateRequestInputV2026 - */ -export interface MachineAccountCreateRequestInputV2026 { - /** - * Subtype ID for which machine account create is enabled and user have the entitlement to create the machine account. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'subtypeId': string; - /** - * Form ID selected by user for the machine account create request. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'formId'?: string; - /** - * Owner Identity ID. This identity will be assigned as an owner of the created machine account. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'ownerIdentityId': string; - /** - * Machine identity to correlate with the created machine account. If not provided, a new machine identity will be created. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'machineIdentityId'?: string | null; - /** - * Environment type to use for the machine account. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'environment'?: string; - /** - * Description for the machine account. - * @type {string} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'description'?: string; - /** - * Fields of the form linked to the subtype in approval settings. - * @type {object} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'userInput'?: object; - /** - * List of entitlement IDs to provision for created machine account. - * @type {Array} - * @memberof MachineAccountCreateRequestInputV2026 - */ - 'entitlementIds'?: Array; -} -/** - * Configuration options for machine account creation, including whether creation is enabled, if approval is required, associated form and entitlement IDs, and detailed approval settings such as approvers and allowed comment types. - * @export - * @interface MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ -export interface MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 { - /** - * Specifies if the creation of machine accounts is allowed for this subtype. - * @type {boolean} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'accountCreateEnabled'?: boolean; - /** - * Specifies if approval is required for machine account creation requests for this subtype. - * @type {boolean} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'approvalRequired'?: boolean; - /** - * Id of the form linked to subtype. - * @type {string} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'formId'?: string; - /** - * Id of the system created entitlement entitlement upon enabling account creation for this subtype. - * @type {string} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'entitlementId'?: string; - /** - * This is required before enabling the account creation to true. Default value will be null. - * @type {string} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'passwordSetting'?: MachineAccountSubtypeConfigDtoMachineAccountCreateV2026PasswordSettingV2026; - /** - * Name of the account attribute from the source\'s schema or new custom attribute to use when password settings is enabled. - * @type {string} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'passwordAttribute'?: string; - /** - * - * @type {MachineSubtypeApprovalConfigV2026} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026 - */ - 'approvalConfig'?: MachineSubtypeApprovalConfigV2026; -} - -export const MachineAccountSubtypeConfigDtoMachineAccountCreateV2026PasswordSettingV2026 = { - DoNotSetPassword: 'DO_NOT_SET_PASSWORD', - SetToExistingAttribute: 'SET_TO_EXISTING_ATTRIBUTE', - SetToNewAttribute: 'SET_TO_NEW_ATTRIBUTE' -} as const; - -export type MachineAccountSubtypeConfigDtoMachineAccountCreateV2026PasswordSettingV2026 = typeof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026PasswordSettingV2026[keyof typeof MachineAccountSubtypeConfigDtoMachineAccountCreateV2026PasswordSettingV2026]; - -/** - * Configuration options for machine account deletion, including whether approval is required, the list of authorized approvers, and the types of comments permitted during the approval workflow. - * @export - * @interface MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026 - */ -export interface MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026 { - /** - * Indicates whether approval is required for an account deletion request. - * @type {boolean} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026 - */ - 'approvalRequired'?: boolean; - /** - * - * @type {MachineSubtypeApprovalConfigV2026} - * @memberof MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026 - */ - 'approvalConfig'?: MachineSubtypeApprovalConfigV2026; -} -/** - * Contains comprehensive configuration details for machine account subtype approval, including creation and deletion approval requirements, approver lists, form and entitlement references, and approval status options. - * @export - * @interface MachineAccountSubtypeConfigDtoV2026 - */ -export interface MachineAccountSubtypeConfigDtoV2026 { - /** - * Unique identifier representing the specific subtype of the machine account, used to distinguish between different machine account categories. - * @type {string} - * @memberof MachineAccountSubtypeConfigDtoV2026 - */ - 'subtypeId'?: string; - /** - * - * @type {MachineAccountSubtypeConfigDtoMachineAccountCreateV2026} - * @memberof MachineAccountSubtypeConfigDtoV2026 - */ - 'machineAccountCreate'?: MachineAccountSubtypeConfigDtoMachineAccountCreateV2026; - /** - * - * @type {MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026} - * @memberof MachineAccountSubtypeConfigDtoV2026 - */ - 'machineAccountDelete'?: MachineAccountSubtypeConfigDtoMachineAccountDeleteV2026; -} -/** - * - * @export - * @interface MachineAccountV2026 - */ -export interface MachineAccountV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineAccountV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineAccountV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineAccountV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineAccountV2026 - */ - 'modified'?: string; - /** - * A description of the machine account - * @type {string} - * @memberof MachineAccountV2026 - */ - 'description'?: string | null; - /** - * The unique ID of the machine account generated by the source system - * @type {string} - * @memberof MachineAccountV2026 - */ - 'nativeIdentity': string; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof MachineAccountV2026 - */ - 'uuid'?: string | null; - /** - * Classification Method - * @type {string} - * @memberof MachineAccountV2026 - */ - 'classificationMethod': MachineAccountV2026ClassificationMethodV2026; - /** - * The machine identity this account is associated with - * @type {object} - * @memberof MachineAccountV2026 - */ - 'machineIdentity'?: object; - /** - * The identity who owns this account. - * @type {object} - * @memberof MachineAccountV2026 - */ - 'ownerIdentity'?: object | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof MachineAccountV2026 - */ - 'accessType'?: string; - /** - * The sub-type - * @type {string} - * @memberof MachineAccountV2026 - */ - 'subtype'?: string | null; - /** - * Environment - * @type {string} - * @memberof MachineAccountV2026 - */ - 'environment'?: string | null; - /** - * Custom attributes specific to the machine account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2026 - */ - 'attributes'?: { [key: string]: any; } | null; - /** - * The connector attributes for the account - * @type {{ [key: string]: any; }} - * @memberof MachineAccountV2026 - */ - 'connectorAttributes': { [key: string]: any; } | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof MachineAccountV2026 - */ - 'manuallyCorrelated'?: boolean; - /** - * Indicates if the account has been manually edited - * @type {boolean} - * @memberof MachineAccountV2026 - */ - 'manuallyEdited': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof MachineAccountV2026 - */ - 'locked': boolean; - /** - * Indicates if the account is enabled - * @type {boolean} - * @memberof MachineAccountV2026 - */ - 'enabled': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof MachineAccountV2026 - */ - 'hasEntitlements': boolean; - /** - * The source this machine account belongs to. - * @type {object} - * @memberof MachineAccountV2026 - */ - 'source': object; -} - -export const MachineAccountV2026ClassificationMethodV2026 = { - Source: 'SOURCE', - Criteria: 'CRITERIA', - Discovery: 'DISCOVERY', - Manual: 'MANUAL' -} as const; - -export type MachineAccountV2026ClassificationMethodV2026 = typeof MachineAccountV2026ClassificationMethodV2026[keyof typeof MachineAccountV2026ClassificationMethodV2026]; - -/** - * - * @export - * @interface MachineClassificationConfigV2026 - */ -export interface MachineClassificationConfigV2026 { - /** - * Indicates whether Classification is enabled for a Source - * @type {boolean} - * @memberof MachineClassificationConfigV2026 - */ - 'enabled'?: boolean; - /** - * Classification Method - * @type {string} - * @memberof MachineClassificationConfigV2026 - */ - 'classificationMethod'?: MachineClassificationConfigV2026ClassificationMethodV2026; - /** - * - * @type {MachineClassificationCriteriaLevel1V2026} - * @memberof MachineClassificationConfigV2026 - */ - 'criteria'?: MachineClassificationCriteriaLevel1V2026; - /** - * Date the config was created - * @type {string} - * @memberof MachineClassificationConfigV2026 - */ - 'created'?: string; - /** - * Date the config was last updated - * @type {string} - * @memberof MachineClassificationConfigV2026 - */ - 'modified'?: string | null; -} - -export const MachineClassificationConfigV2026ClassificationMethodV2026 = { - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type MachineClassificationConfigV2026ClassificationMethodV2026 = typeof MachineClassificationConfigV2026ClassificationMethodV2026[keyof typeof MachineClassificationConfigV2026ClassificationMethodV2026]; - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel1V2026 - */ -export interface MachineClassificationCriteriaLevel1V2026 { - /** - * - * @type {MachineClassificationCriteriaOperationV2026} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'operation'?: MachineClassificationCriteriaOperationV2026; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel1V2026 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel2V2026 - */ -export interface MachineClassificationCriteriaLevel2V2026 { - /** - * - * @type {MachineClassificationCriteriaOperationV2026} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'operation'?: MachineClassificationCriteriaOperationV2026; - /** - * Indicates whether case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel2V2026 - */ - 'children'?: Array | null; -} - - -/** - * - * @export - * @interface MachineClassificationCriteriaLevel3V2026 - */ -export interface MachineClassificationCriteriaLevel3V2026 { - /** - * - * @type {MachineClassificationCriteriaOperationV2026} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'operation'?: MachineClassificationCriteriaOperationV2026; - /** - * Indicates whether or not case matters when evaluating the criteria - * @type {boolean} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'caseSensitive'?: boolean; - /** - * The data type of the attribute being evaluated - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'dataType'?: string | null; - /** - * The attribute to evaluate in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'attribute'?: string | null; - /** - * The value to compare against the attribute in the classification criteria - * @type {string} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'value'?: string | null; - /** - * An array of child classification criteria objects - * @type {Array} - * @memberof MachineClassificationCriteriaLevel3V2026 - */ - 'children'?: Array | null; -} - - -/** - * An operation to perform on the classification criteria - * @export - * @enum {string} - */ - -export const MachineClassificationCriteriaOperationV2026 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - Contains: 'CONTAINS', - And: 'AND', - Or: 'OR' -} as const; - -export type MachineClassificationCriteriaOperationV2026 = typeof MachineClassificationCriteriaOperationV2026[keyof typeof MachineClassificationCriteriaOperationV2026]; - - -/** - * - * @export - * @interface MachineIdentityAggregationRequestV2026 - */ -export interface MachineIdentityAggregationRequestV2026 { - /** - * List of dataset Ids to aggregate machine identities - * @type {Array} - * @memberof MachineIdentityAggregationRequestV2026 - */ - 'datasetIds': Array; - /** - * Flag to disable optimization for the aggregation. Defaults to false when not provided. When set to true, it disables aggregation optimizations and may increase processing time. - * @type {boolean} - * @memberof MachineIdentityAggregationRequestV2026 - */ - 'disableOptimization'?: boolean; -} -/** - * The target(source) of the aggregation - * @export - * @interface MachineIdentityAggregationResponseTargetV2026 - */ -export interface MachineIdentityAggregationResponseTargetV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof MachineIdentityAggregationResponseTargetV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityAggregationResponseTargetV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityAggregationResponseTargetV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface MachineIdentityAggregationResponseV2026 - */ -export interface MachineIdentityAggregationResponseV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'id'?: string; - /** - * Type of task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'type'?: MachineIdentityAggregationResponseV2026TypeV2026; - /** - * Name of the task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'uniqueName'?: string; - /** - * Description of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'description'?: string; - /** - * Name of the parent of the task for aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'parentName'?: string | null; - /** - * Service to execute the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'launcher'?: string; - /** - * - * @type {MachineIdentityAggregationResponseTargetV2026} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'target'?: MachineIdentityAggregationResponseTargetV2026; - /** - * Creation date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'created'?: string; - /** - * Last modification date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'modified'?: string; - /** - * Launch date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'launched'?: string | null; - /** - * Completion date of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'completed'?: string | null; - /** - * - * @type {TaskDefinitionSummaryV2026} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2026; - /** - * Completion status of the aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'completionStatus'?: MachineIdentityAggregationResponseV2026CompletionStatusV2026 | null; - /** - * Messages associated with the aggregation - * @type {Array} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'messages'?: Array; - /** - * Return values associated with the aggregation - * @type {Array} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'returns'?: Array; - /** - * Attributes of the aggregation - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Current progress of aggregation - * @type {string} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'progress'?: string | null; - /** - * Current percentage completion of aggregation - * @type {number} - * @memberof MachineIdentityAggregationResponseV2026 - */ - 'percentComplete'?: number; -} - -export const MachineIdentityAggregationResponseV2026TypeV2026 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type MachineIdentityAggregationResponseV2026TypeV2026 = typeof MachineIdentityAggregationResponseV2026TypeV2026[keyof typeof MachineIdentityAggregationResponseV2026TypeV2026]; -export const MachineIdentityAggregationResponseV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type MachineIdentityAggregationResponseV2026CompletionStatusV2026 = typeof MachineIdentityAggregationResponseV2026CompletionStatusV2026[keyof typeof MachineIdentityAggregationResponseV2026CompletionStatusV2026]; - -/** - * Details of the created machine identity. - * @export - * @interface MachineIdentityCreatedMachineIdentityV2026 - */ -export interface MachineIdentityCreatedMachineIdentityV2026 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'subtype': MachineIdentityCreatedMachineIdentityV2026SubtypeV2026; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2026} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'source'?: MachineIdentitySourceReferenceV2026; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityCreatedMachineIdentityV2026 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityCreatedMachineIdentityV2026SubtypeV2026 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityCreatedMachineIdentityV2026SubtypeV2026 = typeof MachineIdentityCreatedMachineIdentityV2026SubtypeV2026[keyof typeof MachineIdentityCreatedMachineIdentityV2026SubtypeV2026]; - -/** - * - * @export - * @interface MachineIdentityCreatedV2026 - */ -export interface MachineIdentityCreatedV2026 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityCreatedV2026 - */ - 'eventType': MachineIdentityCreatedV2026EventTypeV2026; - /** - * - * @type {MachineIdentityCreatedMachineIdentityV2026} - * @memberof MachineIdentityCreatedV2026 - */ - 'machineIdentity': MachineIdentityCreatedMachineIdentityV2026; -} - -export const MachineIdentityCreatedV2026EventTypeV2026 = { - MachineIdentityCreated: 'MACHINE_IDENTITY_CREATED' -} as const; - -export type MachineIdentityCreatedV2026EventTypeV2026 = typeof MachineIdentityCreatedV2026EventTypeV2026[keyof typeof MachineIdentityCreatedV2026EventTypeV2026]; - -/** - * Details of the deleted machine identity. - * @export - * @interface MachineIdentityDeletedMachineIdentityV2026 - */ -export interface MachineIdentityDeletedMachineIdentityV2026 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'subtype': MachineIdentityDeletedMachineIdentityV2026SubtypeV2026; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2026} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'source'?: MachineIdentitySourceReferenceV2026; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityDeletedMachineIdentityV2026 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityDeletedMachineIdentityV2026SubtypeV2026 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityDeletedMachineIdentityV2026SubtypeV2026 = typeof MachineIdentityDeletedMachineIdentityV2026SubtypeV2026[keyof typeof MachineIdentityDeletedMachineIdentityV2026SubtypeV2026]; - -/** - * - * @export - * @interface MachineIdentityDeletedV2026 - */ -export interface MachineIdentityDeletedV2026 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityDeletedV2026 - */ - 'eventType': MachineIdentityDeletedV2026EventTypeV2026; - /** - * - * @type {MachineIdentityDeletedMachineIdentityV2026} - * @memberof MachineIdentityDeletedV2026 - */ - 'machineIdentity': MachineIdentityDeletedMachineIdentityV2026; -} - -export const MachineIdentityDeletedV2026EventTypeV2026 = { - MachineIdentityDeleted: 'MACHINE_IDENTITY_DELETED' -} as const; - -export type MachineIdentityDeletedV2026EventTypeV2026 = typeof MachineIdentityDeletedV2026EventTypeV2026[keyof typeof MachineIdentityDeletedV2026EventTypeV2026]; - -/** - * The owner configuration associated to the machine identity - * @export - * @interface MachineIdentityDtoOwnersV2026 - */ -export interface MachineIdentityDtoOwnersV2026 { - /** - * Defines the identity which is selected as the primary owner - * @type {object} - * @memberof MachineIdentityDtoOwnersV2026 - */ - 'primaryIdentity': object; - /** - * Defines the identities which are selected as secondary owners - * @type {Array} - * @memberof MachineIdentityDtoOwnersV2026 - */ - 'secondaryIdentities': Array; -} -/** - * Reference to an owner of the machine identity. - * @export - * @interface MachineIdentityOwnerReferenceV2026 - */ -export interface MachineIdentityOwnerReferenceV2026 { - [key: string]: any; - - /** - * Owner\'s type. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2026 - */ - 'type': string; - /** - * Owner ID. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2026 - */ - 'id': string; - /** - * Owner\'s display name. - * @type {string} - * @memberof MachineIdentityOwnerReferenceV2026 - */ - 'name': string; - /** - * Indicates if this owner is the primary owner. - * @type {boolean} - * @memberof MachineIdentityOwnerReferenceV2026 - */ - 'isPrimary'?: boolean; -} -/** - * - * @export - * @interface MachineIdentityRequestUserEntitlementsV2026 - */ -export interface MachineIdentityRequestUserEntitlementsV2026 { - /** - * The ID of the entitlement - * @type {string} - * @memberof MachineIdentityRequestUserEntitlementsV2026 - */ - 'entitlementId': string; - /** - * The source ID of the entitlement - * @type {string} - * @memberof MachineIdentityRequestUserEntitlementsV2026 - */ - 'sourceId': string; -} -/** - * - * @export - * @interface MachineIdentityRequestV2026 - */ -export interface MachineIdentityRequestV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'modified'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'nativeIdentity': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityRequestV2026 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2026} - * @memberof MachineIdentityRequestV2026 - */ - 'owners'?: MachineIdentityDtoOwnersV2026; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityRequestV2026 - */ - 'uuid'?: string; - /** - * The user entitlements associated to the machine identity - * @type {Array} - * @memberof MachineIdentityRequestV2026 - */ - 'userEntitlements'?: Array; -} -/** - * - * @export - * @interface MachineIdentityResponseUserEntitlementsV2026 - */ -export interface MachineIdentityResponseUserEntitlementsV2026 { - /** - * The source ID of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2026 - */ - 'sourceId'?: string; - /** - * The ID of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2026 - */ - 'entitlementId'?: string; - /** - * The display name of the entitlement - * @type {string} - * @memberof MachineIdentityResponseUserEntitlementsV2026 - */ - 'displayName'?: string; - /** - * The source of the entitlement - * @type {object} - * @memberof MachineIdentityResponseUserEntitlementsV2026 - */ - 'source'?: object; -} -/** - * - * @export - * @interface MachineIdentityResponseV2026 - */ -export interface MachineIdentityResponseV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'modified'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'nativeIdentity': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityResponseV2026 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2026} - * @memberof MachineIdentityResponseV2026 - */ - 'owners'?: MachineIdentityDtoOwnersV2026; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'uuid'?: string; - /** - * Indicates if the machine identity has been manually edited - * @type {boolean} - * @memberof MachineIdentityResponseV2026 - */ - 'manuallyEdited'?: boolean; - /** - * Indicates if the machine identity has been manually created - * @type {boolean} - * @memberof MachineIdentityResponseV2026 - */ - 'manuallyCreated'?: boolean; - /** - * The source of the machine identity - * @type {object} - * @memberof MachineIdentityResponseV2026 - */ - 'source'?: object; - /** - * The dataset id associated to the source in which the identity was retrieved from - * @type {string} - * @memberof MachineIdentityResponseV2026 - */ - 'datasetId'?: string; - /** - * The user entitlements associated to the machine identity - * @type {Array} - * @memberof MachineIdentityResponseV2026 - */ - 'userEntitlements'?: Array; -} -/** - * Reference to a source of entity. - * @export - * @interface MachineIdentitySourceReferenceV2026 - */ -export interface MachineIdentitySourceReferenceV2026 { - [key: string]: any; - - /** - * Source Type. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2026 - */ - 'type': string; - /** - * Unique identifier. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2026 - */ - 'id': string; - /** - * Display name. - * @type {string} - * @memberof MachineIdentitySourceReferenceV2026 - */ - 'name': string; -} -/** - * Details of the updated machine identity. - * @export - * @interface MachineIdentityUpdatedMachineIdentityV2026 - */ -export interface MachineIdentityUpdatedMachineIdentityV2026 { - /** - * Unique identifier for the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'id': string; - /** - * Name of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'name'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'created': string; - /** - * Last modified timestamp. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'modified': string; - /** - * Associated business application. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'businessApplication'?: string; - /** - * Description of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'description'?: string; - /** - * The attributes assigned to the identity. - * @type {{ [key: string]: any; }} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Subtype of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'subtype': MachineIdentityUpdatedMachineIdentityV2026SubtypeV2026; - /** - * List of owners. - * @type {Array} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'owners'?: Array; - /** - * Source identifier. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'sourceId'?: string; - /** - * UUID of the machine identity. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'uuid'?: string; - /** - * Native identity value. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'nativeIdentity'?: string; - /** - * Indicates if manually edited. - * @type {boolean} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'manuallyEdited': boolean; - /** - * Indicates if manually created. - * @type {boolean} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'manuallyCreated'?: boolean; - /** - * Dataset identifier. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'datasetId'?: string; - /** - * - * @type {MachineIdentitySourceReferenceV2026} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'source'?: MachineIdentitySourceReferenceV2026; - /** - * List of user entitlements. - * @type {Array} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'userEntitlements'?: Array; - /** - * Existence status on source. - * @type {string} - * @memberof MachineIdentityUpdatedMachineIdentityV2026 - */ - 'existsOnSource'?: string; -} - -export const MachineIdentityUpdatedMachineIdentityV2026SubtypeV2026 = { - AiAgent: 'AI Agent', - Application: 'Application' -} as const; - -export type MachineIdentityUpdatedMachineIdentityV2026SubtypeV2026 = typeof MachineIdentityUpdatedMachineIdentityV2026SubtypeV2026[keyof typeof MachineIdentityUpdatedMachineIdentityV2026SubtypeV2026]; - -/** - * Changes to owners. - * @export - * @interface MachineIdentityUpdatedOwnerChangesV2026 - */ -export interface MachineIdentityUpdatedOwnerChangesV2026 { - /** - * Name of the attribute that changed. - * @type {string} - * @memberof MachineIdentityUpdatedOwnerChangesV2026 - */ - 'attributeName'?: string; - /** - * Owners that were added. - * @type {Array} - * @memberof MachineIdentityUpdatedOwnerChangesV2026 - */ - 'added'?: Array; - /** - * Owners that were removed. - * @type {Array} - * @memberof MachineIdentityUpdatedOwnerChangesV2026 - */ - 'removed'?: Array; -} -/** - * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2026 - * The new value of the attribute after the change. - * @export - */ -export type MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2026 = Array | boolean | number | string; - -/** - * @type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2026 - * The old value of the attribute before the change. - * @export - */ -export type MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2026 = Array | boolean | number | string; - -/** - * - * @export - * @interface MachineIdentityUpdatedSingleValueAttributeChangesInnerV2026 - */ -export interface MachineIdentityUpdatedSingleValueAttributeChangesInnerV2026 { - /** - * The name of the attribute that was changed. - * @type {string} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'name': string; - /** - * - * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2026} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'oldValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerOldValueV2026 | null; - /** - * - * @type {MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2026} - * @memberof MachineIdentityUpdatedSingleValueAttributeChangesInnerV2026 - */ - 'newValue': MachineIdentityUpdatedSingleValueAttributeChangesInnerNewValueV2026 | null; -} -/** - * Changes to user entitlements. - * @export - * @interface MachineIdentityUpdatedUserEntitlementChangesV2026 - */ -export interface MachineIdentityUpdatedUserEntitlementChangesV2026 { - /** - * Name of the attribute that changed. - * @type {string} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2026 - */ - 'attributeName'?: string; - /** - * User entitlements that were added. - * @type {Array} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2026 - */ - 'added'?: Array; - /** - * User entitlements that were removed. - * @type {Array} - * @memberof MachineIdentityUpdatedUserEntitlementChangesV2026 - */ - 'removed'?: Array; -} -/** - * - * @export - * @interface MachineIdentityUpdatedV2026 - */ -export interface MachineIdentityUpdatedV2026 { - /** - * Type of the event. - * @type {string} - * @memberof MachineIdentityUpdatedV2026 - */ - 'eventType': MachineIdentityUpdatedV2026EventTypeV2026; - /** - * - * @type {MachineIdentityUpdatedMachineIdentityV2026} - * @memberof MachineIdentityUpdatedV2026 - */ - 'machineIdentity': MachineIdentityUpdatedMachineIdentityV2026; - /** - * Types of changes that occurred to the machine identity. - * @type {Array} - * @memberof MachineIdentityUpdatedV2026 - */ - 'machineIdentityChangeTypes': Array; - /** - * - * @type {MachineIdentityUpdatedUserEntitlementChangesV2026} - * @memberof MachineIdentityUpdatedV2026 - */ - 'userEntitlementChanges': MachineIdentityUpdatedUserEntitlementChangesV2026; - /** - * - * @type {MachineIdentityUpdatedOwnerChangesV2026} - * @memberof MachineIdentityUpdatedV2026 - */ - 'ownerChanges': MachineIdentityUpdatedOwnerChangesV2026; - /** - * Details about the single-value attribute changes that occurred. - * @type {Array} - * @memberof MachineIdentityUpdatedV2026 - */ - 'singleValueAttributeChanges': Array | null; -} - -export const MachineIdentityUpdatedV2026EventTypeV2026 = { - MachineIdentityUpdated: 'MACHINE_IDENTITY_UPDATED' -} as const; - -export type MachineIdentityUpdatedV2026EventTypeV2026 = typeof MachineIdentityUpdatedV2026EventTypeV2026[keyof typeof MachineIdentityUpdatedV2026EventTypeV2026]; -export const MachineIdentityUpdatedV2026MachineIdentityChangeTypesV2026 = { - AttributesChanged: 'ATTRIBUTES_CHANGED', - UserEntitlementsAdded: 'USER_ENTITLEMENTS_ADDED', - UserEntitlementsRemoved: 'USER_ENTITLEMENTS_REMOVED', - OwnersAdded: 'OWNERS_ADDED', - OwnersRemoved: 'OWNERS_REMOVED' -} as const; - -export type MachineIdentityUpdatedV2026MachineIdentityChangeTypesV2026 = typeof MachineIdentityUpdatedV2026MachineIdentityChangeTypesV2026[keyof typeof MachineIdentityUpdatedV2026MachineIdentityChangeTypesV2026]; - -/** - * The user entitlement - * @export - * @interface MachineIdentityUserEntitlementResponseEntitlementV2026 - */ -export interface MachineIdentityUserEntitlementResponseEntitlementV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseEntitlementV2026 - */ - 'name'?: string; -} - - -/** - * The source of the user entitlement - * @export - * @interface MachineIdentityUserEntitlementResponseSourceV2026 - */ -export interface MachineIdentityUserEntitlementResponseSourceV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof MachineIdentityUserEntitlementResponseSourceV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseSourceV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseSourceV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface MachineIdentityUserEntitlementResponseV2026 - */ -export interface MachineIdentityUserEntitlementResponseV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2026 - */ - 'id'?: string; - /** - * System-generated unique ID of the Machine Identity - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2026 - */ - 'machineIdentityId'?: string; - /** - * - * @type {MachineIdentityUserEntitlementResponseSourceV2026} - * @memberof MachineIdentityUserEntitlementResponseV2026 - */ - 'source'?: MachineIdentityUserEntitlementResponseSourceV2026; - /** - * - * @type {MachineIdentityUserEntitlementResponseEntitlementV2026} - * @memberof MachineIdentityUserEntitlementResponseV2026 - */ - 'entitlement'?: MachineIdentityUserEntitlementResponseEntitlementV2026; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityUserEntitlementResponseV2026 - */ - 'created'?: string; -} -/** - * Reference to a user entitlement. - * @export - * @interface MachineIdentityUserEntitlementsV2026 - */ -export interface MachineIdentityUserEntitlementsV2026 { - [key: string]: any; - - /** - * Entitlement identifier. - * @type {string} - * @memberof MachineIdentityUserEntitlementsV2026 - */ - 'entitlementId': string; - /** - * Display name of the entitlement. - * @type {string} - * @memberof MachineIdentityUserEntitlementsV2026 - */ - 'displayName': string; - /** - * - * @type {MachineIdentitySourceReferenceV2026} - * @memberof MachineIdentityUserEntitlementsV2026 - */ - 'source': MachineIdentitySourceReferenceV2026; -} -/** - * - * @export - * @interface MachineIdentityV2026 - */ -export interface MachineIdentityV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'modified'?: string; - /** - * The native identity associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'nativeIdentity': string; - /** - * Description of machine identity - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'description'?: string; - /** - * A map of custom machine identity attributes - * @type {object} - * @memberof MachineIdentityV2026 - */ - 'attributes'?: object; - /** - * The subtype value associated to the machine identity - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'subtype': string; - /** - * - * @type {MachineIdentityDtoOwnersV2026} - * @memberof MachineIdentityV2026 - */ - 'owners'?: MachineIdentityDtoOwnersV2026; - /** - * The source id associated to the machine identity - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'sourceId'?: string; - /** - * The UUID associated to the machine identity directly aggregated from a source - * @type {string} - * @memberof MachineIdentityV2026 - */ - 'uuid'?: string; -} -/** - * - * @export - * @interface MachineSubtypeApprovalConfigV2026 - */ -export interface MachineSubtypeApprovalConfigV2026 { - /** - * Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:[workgroupId] (Governance group). Approval request will be assigned based on the order of the approvers passed. Multiple workgroups(governance groups) can be selected as an approver. >**Note:** accountOwner approver type is only for machine account delete approval settings. - * @type {string} - * @memberof MachineSubtypeApprovalConfigV2026 - */ - 'approvers'?: string; - /** - * Comment configurations for the approval request. Following are the options for comments: ALL, OFF, APPROVAL, REJECT. - * @type {string} - * @memberof MachineSubtypeApprovalConfigV2026 - */ - 'comments'?: string; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesDtoV2026 - */ -export interface MailFromAttributesDtoV2026 { - /** - * The identity or domain address - * @type {string} - * @memberof MailFromAttributesDtoV2026 - */ - 'identity'?: string; - /** - * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. - * @type {string} - * @memberof MailFromAttributesDtoV2026 - */ - 'mailFromDomain'?: string; -} -/** - * MAIL FROM attributes for a domain / identity - * @export - * @interface MailFromAttributesV2026 - */ -export interface MailFromAttributesV2026 { - /** - * The email identity - * @type {string} - * @memberof MailFromAttributesV2026 - */ - 'identity'?: string; - /** - * The name of a domain that an email identity uses as a custom MAIL FROM domain - * @type {string} - * @memberof MailFromAttributesV2026 - */ - 'mailFromDomain'?: string; - /** - * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you - * @type {string} - * @memberof MailFromAttributesV2026 - */ - 'mxRecord'?: string; - /** - * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain - * @type {string} - * @memberof MailFromAttributesV2026 - */ - 'txtRecord'?: string; - /** - * The current status of the MAIL FROM verification - * @type {string} - * @memberof MailFromAttributesV2026 - */ - 'mailFromDomainStatus'?: MailFromAttributesV2026MailFromDomainStatusV2026; -} - -export const MailFromAttributesV2026MailFromDomainStatusV2026 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MailFromAttributesV2026MailFromDomainStatusV2026 = typeof MailFromAttributesV2026MailFromDomainStatusV2026[keyof typeof MailFromAttributesV2026MailFromDomainStatusV2026]; - -/** - * Health indicators grouped by category - * @export - * @interface ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026 - */ -export interface ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026 { - /** - * - * @type {HealthIndicatorCategoryV2026} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026 - */ - 'container'?: HealthIndicatorCategoryV2026; - /** - * - * @type {HealthIndicatorCategoryV2026} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026 - */ - 'memory'?: HealthIndicatorCategoryV2026; - /** - * - * @type {HealthIndicatorCategoryV2026} - * @memberof ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026 - */ - 'cpu'?: HealthIndicatorCategoryV2026; -} -/** - * Health indicator details from the Managed Client - * @export - * @interface ManagedClientHealthIndicatorsBodyV2026 - */ -export interface ManagedClientHealthIndicatorsBodyV2026 { - /** - * Health indicator alert key - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'alertKey'?: string | null; - /** - * Unique identifier for the health report - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'id': string; - /** - * Cluster ID the health report belongs to - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'clusterId': string; - /** - * API user ID sending the health data - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'apiUser': string; - /** - * ETag value for CCG version control - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'ccg_etag'?: string | null; - /** - * PIN value for CCG validation - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'ccg_pin'?: string | null; - /** - * ETag for cookbook version - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'cookbook_etag'?: string | null; - /** - * Hostname of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'hostname': string; - /** - * Internal IP address of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'internal_ip'?: string; - /** - * Epoch timestamp (in millis) when last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'lastSeen'?: string; - /** - * Seconds since last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'sinceSeen'?: string; - /** - * Milliseconds since last seen - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'sinceSeenMillis'?: string; - /** - * Indicates if this is a local development instance - * @type {boolean} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'localDev'?: boolean; - /** - * Stacktrace associated with any error, if available - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'stacktrace'?: string | null; - /** - * Optional state value from the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'state'?: string | null; - /** - * Status of the client at the time of report - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'status': ManagedClientHealthIndicatorsBodyV2026StatusV2026; - /** - * Optional UUID from the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'uuid'?: string | null; - /** - * Product type (e.g., idn) - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'product': string; - /** - * VA version installed on the client - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'va_version'?: string | null; - /** - * Version of the platform on which VA is running - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'platform_version': string; - /** - * Operating system version - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'os_version': string; - /** - * Operating system type - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'os_type': string; - /** - * Virtualization platform used - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'hypervisor': string; - /** - * Consolidated health indicator status - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'consolidatedHealthIndicatorsStatus': ManagedClientHealthIndicatorsBodyV2026ConsolidatedHealthIndicatorsStatusV2026; - /** - * The last CCG version for which notification was sent - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'lastNotifiedCcgVersion'?: string; - /** - * Information about deployed processes - * @type {string} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'deployed_processes'?: string | null; - /** - * - * @type {ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026} - * @memberof ManagedClientHealthIndicatorsBodyV2026 - */ - 'health_indicators': ManagedClientHealthIndicatorsBodyHealthIndicatorsV2026; -} - -export const ManagedClientHealthIndicatorsBodyV2026StatusV2026 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientHealthIndicatorsBodyV2026StatusV2026 = typeof ManagedClientHealthIndicatorsBodyV2026StatusV2026[keyof typeof ManagedClientHealthIndicatorsBodyV2026StatusV2026]; -export const ManagedClientHealthIndicatorsBodyV2026ConsolidatedHealthIndicatorsStatusV2026 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClientHealthIndicatorsBodyV2026ConsolidatedHealthIndicatorsStatusV2026 = typeof ManagedClientHealthIndicatorsBodyV2026ConsolidatedHealthIndicatorsStatusV2026[keyof typeof ManagedClientHealthIndicatorsBodyV2026ConsolidatedHealthIndicatorsStatusV2026]; - -/** - * Health Indicators for a Managed Client - * @export - * @interface ManagedClientHealthIndicatorsV2026 - */ -export interface ManagedClientHealthIndicatorsV2026 { - /** - * - * @type {ManagedClientHealthIndicatorsBodyV2026} - * @memberof ManagedClientHealthIndicatorsV2026 - */ - 'body': ManagedClientHealthIndicatorsBodyV2026; - /** - * Top-level status of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2026 - */ - 'status': ManagedClientHealthIndicatorsV2026StatusV2026; - /** - * Type of the Managed Client - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2026 - */ - 'type': ManagedClientHealthIndicatorsV2026TypeV2026; - /** - * Timestamp when this report was generated - * @type {string} - * @memberof ManagedClientHealthIndicatorsV2026 - */ - 'timestamp': string; -} - -export const ManagedClientHealthIndicatorsV2026StatusV2026 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientHealthIndicatorsV2026StatusV2026 = typeof ManagedClientHealthIndicatorsV2026StatusV2026[keyof typeof ManagedClientHealthIndicatorsV2026StatusV2026]; -export const ManagedClientHealthIndicatorsV2026TypeV2026 = { - Va: 'VA', - Ccg: 'CCG' -} as const; - -export type ManagedClientHealthIndicatorsV2026TypeV2026 = typeof ManagedClientHealthIndicatorsV2026TypeV2026[keyof typeof ManagedClientHealthIndicatorsV2026TypeV2026]; - -/** - * Managed Client Request - * @export - * @interface ManagedClientRequestV2026 - */ -export interface ManagedClientRequestV2026 { - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientRequestV2026 - */ - 'clusterId': string; - /** - * description for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2026 - */ - 'description'?: string | null; - /** - * name for the ManagedClient to create - * @type {string} - * @memberof ManagedClientRequestV2026 - */ - 'name'?: string | null; - /** - * Type of the ManagedClient (VA, CCG) to create - * @type {string} - * @memberof ManagedClientRequestV2026 - */ - 'type'?: string | null; -} -/** - * Status of a Managed Client - * @export - * @enum {string} - */ - -export const ManagedClientStatusCodeV2026 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientStatusCodeV2026 = typeof ManagedClientStatusCodeV2026[keyof typeof ManagedClientStatusCodeV2026]; - - -/** - * Managed Client Status - * @export - * @interface ManagedClientStatusV2026 - */ -export interface ManagedClientStatusV2026 { - /** - * ManagedClientStatus body information - * @type {object} - * @memberof ManagedClientStatusV2026 - */ - 'body': object; - /** - * - * @type {ManagedClientStatusCodeV2026} - * @memberof ManagedClientStatusV2026 - */ - 'status': ManagedClientStatusCodeV2026; - /** - * - * @type {ManagedClientTypeV2026} - * @memberof ManagedClientStatusV2026 - */ - 'type': ManagedClientTypeV2026 | null; - /** - * timestamp on the Client Status update - * @type {string} - * @memberof ManagedClientStatusV2026 - */ - 'timestamp': string; -} - - -/** - * Managed Client type - * @export - * @enum {string} - */ - -export const ManagedClientTypeV2026 = { - Ccg: 'CCG', - Va: 'VA', - Internal: 'INTERNAL', - IiqHarvester: 'IIQ_HARVESTER' -} as const; - -export type ManagedClientTypeV2026 = typeof ManagedClientTypeV2026[keyof typeof ManagedClientTypeV2026]; - - -/** - * Managed Client - * @export - * @interface ManagedClientV2026 - */ -export interface ManagedClientV2026 { - /** - * ManagedClient ID - * @type {string} - * @memberof ManagedClientV2026 - */ - 'id'?: string | null; - /** - * ManagedClient alert key - * @type {string} - * @memberof ManagedClientV2026 - */ - 'alertKey'?: string | null; - /** - * - * @type {string} - * @memberof ManagedClientV2026 - */ - 'apiGatewayBaseUrl'?: string | null; - /** - * - * @type {string} - * @memberof ManagedClientV2026 - */ - 'cookbook'?: string | null; - /** - * Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - * @type {number} - * @memberof ManagedClientV2026 - */ - 'ccId'?: number | null; - /** - * The client ID used in API management - * @type {string} - * @memberof ManagedClientV2026 - */ - 'clientId': string; - /** - * Cluster ID that the ManagedClient is linked to - * @type {string} - * @memberof ManagedClientV2026 - */ - 'clusterId': string; - /** - * ManagedClient description - * @type {string} - * @memberof ManagedClientV2026 - */ - 'description': string; - /** - * The public IP address of the ManagedClient - * @type {string} - * @memberof ManagedClientV2026 - */ - 'ipAddress'?: string | null; - /** - * When the ManagedClient was last seen by the server - * @type {string} - * @memberof ManagedClientV2026 - */ - 'lastSeen'?: string | null; - /** - * ManagedClient name - * @type {string} - * @memberof ManagedClientV2026 - */ - 'name'?: string | null; - /** - * Milliseconds since the ManagedClient has polled the server - * @type {string} - * @memberof ManagedClientV2026 - */ - 'sinceLastSeen'?: string | null; - /** - * Status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2026 - */ - 'status'?: ManagedClientV2026StatusV2026 | null; - /** - * Type of the ManagedClient (VA, CCG) - * @type {string} - * @memberof ManagedClientV2026 - */ - 'type': string; - /** - * Cluster Type of the ManagedClient - * @type {string} - * @memberof ManagedClientV2026 - */ - 'clusterType'?: ManagedClientV2026ClusterTypeV2026 | null; - /** - * ManagedClient VA download URL - * @type {string} - * @memberof ManagedClientV2026 - */ - 'vaDownloadUrl'?: string | null; - /** - * Version that the ManagedClient\'s VA is running - * @type {string} - * @memberof ManagedClientV2026 - */ - 'vaVersion'?: string | null; - /** - * Client\'s apiKey - * @type {string} - * @memberof ManagedClientV2026 - */ - 'secret'?: string | null; - /** - * The date/time this ManagedClient was created - * @type {string} - * @memberof ManagedClientV2026 - */ - 'createdAt'?: string | null; - /** - * The date/time this ManagedClient was last updated - * @type {string} - * @memberof ManagedClientV2026 - */ - 'updatedAt'?: string | null; - /** - * The provisioning status of the ManagedClient - * @type {string} - * @memberof ManagedClientV2026 - */ - 'provisionStatus'?: ManagedClientV2026ProvisionStatusV2026 | null; -} - -export const ManagedClientV2026StatusV2026 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientV2026StatusV2026 = typeof ManagedClientV2026StatusV2026[keyof typeof ManagedClientV2026StatusV2026]; -export const ManagedClientV2026ClusterTypeV2026 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc' -} as const; - -export type ManagedClientV2026ClusterTypeV2026 = typeof ManagedClientV2026ClusterTypeV2026[keyof typeof ManagedClientV2026ClusterTypeV2026]; -export const ManagedClientV2026ProvisionStatusV2026 = { - Provisioned: 'PROVISIONED', - Draft: 'DRAFT' -} as const; - -export type ManagedClientV2026ProvisionStatusV2026 = typeof ManagedClientV2026ProvisionStatusV2026[keyof typeof ManagedClientV2026ProvisionStatusV2026]; - -/** - * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - * @export - * @interface ManagedClusterAttributesV2026 - */ -export interface ManagedClusterAttributesV2026 { - /** - * - * @type {ManagedClusterQueueV2026} - * @memberof ManagedClusterAttributesV2026 - */ - 'queue'?: ManagedClusterQueueV2026; - /** - * ManagedCluster keystore for spConnectCluster type - * @type {string} - * @memberof ManagedClusterAttributesV2026 - */ - 'keystore'?: string | null; -} -/** - * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. - * @export - * @interface ManagedClusterEncryptionConfigV2026 - */ -export interface ManagedClusterEncryptionConfigV2026 { - /** - * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. - * @type {string} - * @memberof ManagedClusterEncryptionConfigV2026 - */ - 'format'?: ManagedClusterEncryptionConfigV2026FormatV2026; -} - -export const ManagedClusterEncryptionConfigV2026FormatV2026 = { - V2: 'V2', - V3: 'V3' -} as const; - -export type ManagedClusterEncryptionConfigV2026FormatV2026 = typeof ManagedClusterEncryptionConfigV2026FormatV2026[keyof typeof ManagedClusterEncryptionConfigV2026FormatV2026]; - -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterKeyPairV2026 - */ -export interface ManagedClusterKeyPairV2026 { - /** - * ManagedCluster publicKey - * @type {string} - * @memberof ManagedClusterKeyPairV2026 - */ - 'publicKey'?: string | null; - /** - * ManagedCluster publicKeyThumbprint - * @type {string} - * @memberof ManagedClusterKeyPairV2026 - */ - 'publicKeyThumbprint'?: string | null; - /** - * ManagedCluster publicKeyCertificate - * @type {string} - * @memberof ManagedClusterKeyPairV2026 - */ - 'publicKeyCertificate'?: string | null; -} -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterQueueV2026 - */ -export interface ManagedClusterQueueV2026 { - /** - * ManagedCluster queue name - * @type {string} - * @memberof ManagedClusterQueueV2026 - */ - 'name'?: string; - /** - * ManagedCluster queue aws region - * @type {string} - * @memberof ManagedClusterQueueV2026 - */ - 'region'?: string; -} -/** - * Managed Cluster Redis Configuration - * @export - * @interface ManagedClusterRedisV2026 - */ -export interface ManagedClusterRedisV2026 { - /** - * ManagedCluster redisHost - * @type {string} - * @memberof ManagedClusterRedisV2026 - */ - 'redisHost'?: string; - /** - * ManagedCluster redisPort - * @type {number} - * @memberof ManagedClusterRedisV2026 - */ - 'redisPort'?: number; -} -/** - * Request to create Managed Cluster - * @export - * @interface ManagedClusterRequestV2026 - */ -export interface ManagedClusterRequestV2026 { - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterRequestV2026 - */ - 'name': string; - /** - * - * @type {ManagedClusterTypesV2026} - * @memberof ManagedClusterRequestV2026 - */ - 'type'?: ManagedClusterTypesV2026; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string; }} - * @memberof ManagedClusterRequestV2026 - */ - 'configuration'?: { [key: string]: string; }; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterRequestV2026 - */ - 'description'?: string | null; -} - - -/** - * Managed Cluster Type for Cluster upgrade configuration information - * @export - * @interface ManagedClusterTypeV2026 - */ -export interface ManagedClusterTypeV2026 { - /** - * ManagedClusterType ID - * @type {string} - * @memberof ManagedClusterTypeV2026 - */ - 'id'?: string; - /** - * ManagedClusterType type name - * @type {string} - * @memberof ManagedClusterTypeV2026 - */ - 'type': string; - /** - * ManagedClusterType pod - * @type {string} - * @memberof ManagedClusterTypeV2026 - */ - 'pod': string; - /** - * ManagedClusterType org - * @type {string} - * @memberof ManagedClusterTypeV2026 - */ - 'org': string; - /** - * List of processes for the cluster type - * @type {Array} - * @memberof ManagedClusterTypeV2026 - */ - 'managedProcessIds'?: Array; -} -/** - * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products - * @export - * @enum {string} - */ - -export const ManagedClusterTypesV2026 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc', - Pag: 'pag', - DasAm: 'das-am', - Standard: 'standard' -} as const; - -export type ManagedClusterTypesV2026 = typeof ManagedClusterTypesV2026[keyof typeof ManagedClusterTypesV2026]; - - -/** - * The preference for applying updates for the cluster - * @export - * @interface ManagedClusterUpdatePreferencesV2026 - */ -export interface ManagedClusterUpdatePreferencesV2026 { - /** - * The processGroups for updatePreferences - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2026 - */ - 'processGroups'?: string | null; - /** - * The current updateState for the cluster - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2026 - */ - 'updateState'?: ManagedClusterUpdatePreferencesV2026UpdateStateV2026 | null; - /** - * The mail id to which new releases will be notified - * @type {string} - * @memberof ManagedClusterUpdatePreferencesV2026 - */ - 'notificationEmail'?: string | null; -} - -export const ManagedClusterUpdatePreferencesV2026UpdateStateV2026 = { - Auto: 'AUTO', - Disabled: 'DISABLED' -} as const; - -export type ManagedClusterUpdatePreferencesV2026UpdateStateV2026 = typeof ManagedClusterUpdatePreferencesV2026UpdateStateV2026[keyof typeof ManagedClusterUpdatePreferencesV2026UpdateStateV2026]; - -/** - * Managed Cluster - * @export - * @interface ManagedClusterV2026 - */ -export interface ManagedClusterV2026 { - /** - * ManagedCluster ID - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'id': string; - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'name'?: string; - /** - * ManagedCluster pod - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'pod'?: string; - /** - * ManagedCluster org - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'org'?: string; - /** - * - * @type {ManagedClusterTypesV2026} - * @memberof ManagedClusterV2026 - */ - 'type'?: ManagedClusterTypesV2026; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string | null; }} - * @memberof ManagedClusterV2026 - */ - 'configuration'?: { [key: string]: string | null; }; - /** - * - * @type {ManagedClusterKeyPairV2026} - * @memberof ManagedClusterV2026 - */ - 'keyPair'?: ManagedClusterKeyPairV2026; - /** - * - * @type {ManagedClusterAttributesV2026} - * @memberof ManagedClusterV2026 - */ - 'attributes'?: ManagedClusterAttributesV2026; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'description'?: string; - /** - * - * @type {ManagedClusterRedisV2026} - * @memberof ManagedClusterV2026 - */ - 'redis'?: ManagedClusterRedisV2026; - /** - * - * @type {ManagedClientTypeV2026} - * @memberof ManagedClusterV2026 - */ - 'clientType': ManagedClientTypeV2026 | null; - /** - * CCG version used by the ManagedCluster - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'ccgVersion': string; - /** - * boolean flag indicating whether or not the cluster configuration is pinned - * @type {boolean} - * @memberof ManagedClusterV2026 - */ - 'pinnedConfig'?: boolean; - /** - * - * @type {ClientLogConfigurationV2026} - * @memberof ManagedClusterV2026 - */ - 'logConfiguration'?: ClientLogConfigurationV2026 | null; - /** - * Whether or not the cluster is operational or not - * @type {boolean} - * @memberof ManagedClusterV2026 - */ - 'operational'?: boolean; - /** - * Cluster status - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'status'?: ManagedClusterV2026StatusV2026; - /** - * Public key certificate - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'publicKeyCertificate'?: string | null; - /** - * Public key thumbprint - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'publicKeyThumbprint'?: string | null; - /** - * Public key - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'publicKey'?: string | null; - /** - * - * @type {ManagedClusterEncryptionConfigV2026} - * @memberof ManagedClusterV2026 - */ - 'encryptionConfiguration'?: ManagedClusterEncryptionConfigV2026; - /** - * Key describing any immediate cluster alerts - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'alertKey'?: string; - /** - * List of clients in a cluster - * @type {Array} - * @memberof ManagedClusterV2026 - */ - 'clientIds'?: Array; - /** - * Number of services bound to a cluster - * @type {number} - * @memberof ManagedClusterV2026 - */ - 'serviceCount'?: number; - /** - * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'ccId'?: string; - /** - * The date/time this cluster was created - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'createdAt'?: string | null; - /** - * The date/time this cluster was last updated - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'updatedAt'?: string | null; - /** - * The date/time this cluster was notified for the last release - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'lastReleaseNotifiedAt'?: string | null; - /** - * - * @type {ManagedClusterUpdatePreferencesV2026} - * @memberof ManagedClusterV2026 - */ - 'updatePreferences'?: ManagedClusterUpdatePreferencesV2026; - /** - * The current installed release on the Managed cluster - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'currentInstalledReleaseVersion'?: string | null; - /** - * New available updates for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'updatePackage'?: string | null; - /** - * The time at which out of date notification was sent for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'isOutOfDateNotifiedAt'?: string | null; - /** - * The consolidated Health Status for the Managed cluster - * @type {string} - * @memberof ManagedClusterV2026 - */ - 'consolidatedHealthIndicatorsStatus'?: ManagedClusterV2026ConsolidatedHealthIndicatorsStatusV2026 | null; -} - -export const ManagedClusterV2026StatusV2026 = { - Configuring: 'CONFIGURING', - Failed: 'FAILED', - NoClients: 'NO_CLIENTS', - Normal: 'NORMAL', - Warning: 'WARNING' -} as const; - -export type ManagedClusterV2026StatusV2026 = typeof ManagedClusterV2026StatusV2026[keyof typeof ManagedClusterV2026StatusV2026]; -export const ManagedClusterV2026ConsolidatedHealthIndicatorsStatusV2026 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClusterV2026ConsolidatedHealthIndicatorsStatusV2026 = typeof ManagedClusterV2026ConsolidatedHealthIndicatorsStatusV2026[keyof typeof ManagedClusterV2026ConsolidatedHealthIndicatorsStatusV2026]; - -/** - * - * @export - * @interface ManagerCorrelationMappingV2026 - */ -export interface ManagerCorrelationMappingV2026 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof ManagerCorrelationMappingV2026 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof ManagerCorrelationMappingV2026 - */ - 'identityAttributeName'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsTemplateV2026 - */ -export interface ManualDiscoverApplicationsTemplateV2026 { - /** - * Name of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2026 - */ - 'application_name'?: string; - /** - * Description of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplateV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsV2026 - */ -export interface ManualDiscoverApplicationsV2026 { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ManualDiscoverApplicationsV2026 - */ - 'file': File; -} -/** - * Identity of current work item owner. - * @export - * @interface ManualWorkItemDetailsCurrentOwnerV2026 - */ -export interface ManualWorkItemDetailsCurrentOwnerV2026 { - /** - * DTO type of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2026 - */ - 'type'?: ManualWorkItemDetailsCurrentOwnerV2026TypeV2026; - /** - * ID of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2026 - */ - 'id'?: string; - /** - * Display name of current work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwnerV2026 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsCurrentOwnerV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsCurrentOwnerV2026TypeV2026 = typeof ManualWorkItemDetailsCurrentOwnerV2026TypeV2026[keyof typeof ManualWorkItemDetailsCurrentOwnerV2026TypeV2026]; - -/** - * Identity of original work item owner, if the work item has been forwarded. - * @export - * @interface ManualWorkItemDetailsOriginalOwnerV2026 - */ -export interface ManualWorkItemDetailsOriginalOwnerV2026 { - /** - * DTO type of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2026 - */ - 'type'?: ManualWorkItemDetailsOriginalOwnerV2026TypeV2026; - /** - * ID of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2026 - */ - 'id'?: string; - /** - * Display name of original work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwnerV2026 - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsOriginalOwnerV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsOriginalOwnerV2026TypeV2026 = typeof ManualWorkItemDetailsOriginalOwnerV2026TypeV2026[keyof typeof ManualWorkItemDetailsOriginalOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface ManualWorkItemDetailsV2026 - */ -export interface ManualWorkItemDetailsV2026 { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetailsV2026 - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwnerV2026} - * @memberof ManualWorkItemDetailsV2026 - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwnerV2026 | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwnerV2026} - * @memberof ManualWorkItemDetailsV2026 - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwnerV2026 | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetailsV2026 - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemStateV2026} - * @memberof ManualWorkItemDetailsV2026 - */ - 'status'?: ManualWorkItemStateV2026; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetailsV2026 - */ - 'forwardHistory'?: Array | null; -} - - -/** - * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. - * @export - * @enum {string} - */ - -export const ManualWorkItemStateV2026 = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Expired: 'EXPIRED', - Cancelled: 'CANCELLED', - Archived: 'ARCHIVED' -} as const; - -export type ManualWorkItemStateV2026 = typeof ManualWorkItemStateV2026[keyof typeof ManualWorkItemStateV2026]; - - -/** - * - * @export - * @interface MatchTermV2026 - */ -export interface MatchTermV2026 { - /** - * The attribute name - * @type {string} - * @memberof MatchTermV2026 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof MatchTermV2026 - */ - 'value'?: string; - /** - * The operator between name and value - * @type {string} - * @memberof MatchTermV2026 - */ - 'op'?: string; - /** - * If it is a container or a real match term - * @type {boolean} - * @memberof MatchTermV2026 - */ - 'container'?: boolean; - /** - * If it is AND logical operator for the children match terms - * @type {boolean} - * @memberof MatchTermV2026 - */ - 'and'?: boolean; - /** - * The children under this match term - * @type {Array<{ [key: string]: any; }>} - * @memberof MatchTermV2026 - */ - 'children'?: Array<{ [key: string]: any; }> | null; -} -/** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @export - * @enum {string} - */ - -export const MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type MediumV2026 = typeof MediumV2026[keyof typeof MediumV2026]; - - -/** - * An enumeration of the types of membership choices - * @export - * @enum {string} - */ - -export const MembershipTypeV2026 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION' -} as const; - -export type MembershipTypeV2026 = typeof MembershipTypeV2026[keyof typeof MembershipTypeV2026]; - - -/** - * The calculation done on the results of the query - * @export - * @interface MetricAggregationV2026 - */ -export interface MetricAggregationV2026 { - /** - * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - * @type {string} - * @memberof MetricAggregationV2026 - */ - 'name': string; - /** - * - * @type {MetricTypeV2026} - * @memberof MetricAggregationV2026 - */ - 'type'?: MetricTypeV2026; - /** - * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof MetricAggregationV2026 - */ - 'field': string; -} - - -/** - * - * @export - * @interface MetricResponseV2026 - */ -export interface MetricResponseV2026 { - /** - * the name of metric - * @type {string} - * @memberof MetricResponseV2026 - */ - 'name'?: string; - /** - * the value associated to the metric - * @type {number} - * @memberof MetricResponseV2026 - */ - 'value'?: number; -} -/** - * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const MetricTypeV2026 = { - Count: 'COUNT', - UniqueCount: 'UNIQUE_COUNT', - Avg: 'AVG', - Sum: 'SUM', - Median: 'MEDIAN', - Min: 'MIN', - Max: 'MAX' -} as const; - -export type MetricTypeV2026 = typeof MetricTypeV2026[keyof typeof MetricTypeV2026]; - - -/** - * Response model for configuration test of a given MFA method - * @export - * @interface MfaConfigTestResponseV2026 - */ -export interface MfaConfigTestResponseV2026 { - /** - * The configuration test result. - * @type {string} - * @memberof MfaConfigTestResponseV2026 - */ - 'state'?: MfaConfigTestResponseV2026StateV2026; - /** - * The error message to indicate the failure of configuration test. - * @type {string} - * @memberof MfaConfigTestResponseV2026 - */ - 'error'?: string; -} - -export const MfaConfigTestResponseV2026StateV2026 = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MfaConfigTestResponseV2026StateV2026 = typeof MfaConfigTestResponseV2026StateV2026[keyof typeof MfaConfigTestResponseV2026StateV2026]; - -/** - * - * @export - * @interface MfaDuoConfigV2026 - */ -export interface MfaDuoConfigV2026 { - /** - * Mfa method name - * @type {string} - * @memberof MfaDuoConfigV2026 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaDuoConfigV2026 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2026 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2026 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaDuoConfigV2026 - */ - 'identityAttribute'?: string | null; - /** - * A map with additional config properties for the given MFA method - duo-web. - * @type {{ [key: string]: any; }} - * @memberof MfaDuoConfigV2026 - */ - 'configProperties'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface MfaOktaConfigV2026 - */ -export interface MfaOktaConfigV2026 { - /** - * Mfa method name - * @type {string} - * @memberof MfaOktaConfigV2026 - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaOktaConfigV2026 - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2026 - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2026 - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaOktaConfigV2026 - */ - 'identityAttribute'?: string | null; -} -/** - * Request body listing machine identity or machine account IDs for a bulk operation. - * @export - * @interface MisBulkRequestV2026 - */ -export interface MisBulkRequestV2026 { - /** - * Machine identity or machine account IDs to include in the bulk operation. - * @type {Array} - * @memberof MisBulkRequestV2026 - */ - 'ids': Array; -} -/** - * Per-ID result for a machine identity or machine account bulk operation. - * @export - * @interface MisBulkResponseV2026 - */ -export interface MisBulkResponseV2026 { - /** - * Machine identity or machine account ID from the request. - * @type {string} - * @memberof MisBulkResponseV2026 - */ - 'id': string; - /** - * HTTP status code for this ID. For example, 200 indicates success, 404 indicates the resource was not found or is not accessible to the caller, and 409 indicates a conflict such as a duplicate ID in the batch. - * @type {number} - * @memberof MisBulkResponseV2026 - */ - 'status': number; - /** - * Human-readable detail for this result. - * @type {string} - * @memberof MisBulkResponseV2026 - */ - 'message'?: string; -} -/** - * Request body for applying the same JSON Patch document to multiple machine identities or machine accounts. - * @export - * @interface MisBulkUpdateRequestV2026 - */ -export interface MisBulkUpdateRequestV2026 { - /** - * Machine identity or machine account IDs to update. - * @type {Array} - * @memberof MisBulkUpdateRequestV2026 - */ - 'ids': Array; - /** - * JSON Patch operations to apply to each ID in the request (RFC 6902). - * @type {Array} - * @memberof MisBulkUpdateRequestV2026 - */ - 'jsonPatch': Array; -} -/** - * This represents a Multi-Host Integration template type. - * @export - * @interface MultiHostIntegrationTemplateTypeV2026 - */ -export interface MultiHostIntegrationTemplateTypeV2026 { - /** - * This is the name of the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2026 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2026 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof MultiHostIntegrationTemplateTypeV2026 - */ - 'scriptName': string; -} -/** - * Reference to accounts file for the source. - * @export - * @interface MultiHostIntegrationsAccountsFileV2026 - */ -export interface MultiHostIntegrationsAccountsFileV2026 { - /** - * Name of the accounts file. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2026 - */ - 'name'?: string; - /** - * The accounts file key. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2026 - */ - 'key'?: string; - /** - * Date-time when the file was uploaded - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2026 - */ - 'uploadTime'?: string; - /** - * Date-time when the accounts file expired. - * @type {string} - * @memberof MultiHostIntegrationsAccountsFileV2026 - */ - 'expiry'?: string; - /** - * If this is true, it indicates that the accounts file has expired. - * @type {boolean} - * @memberof MultiHostIntegrationsAccountsFileV2026 - */ - 'expired'?: boolean; -} -/** - * - * @export - * @interface MultiHostIntegrationsAggScheduleUpdateV2026 - */ -export interface MultiHostIntegrationsAggScheduleUpdateV2026 { - /** - * Multi-Host Integration ID. The ID must be unique - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'multihostId': string; - /** - * Multi-Host Integration aggregation group ID - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'aggregation_grp_id': string; - /** - * Multi-Host Integration name - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'aggregation_grp_name': string; - /** - * Cron expression to schedule aggregation - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'aggregation_cron_schedule': string; - /** - * Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. - * @type {boolean} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'enableSchedule': boolean; - /** - * Source IDs of the Multi-Host Integration - * @type {Array} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'source_id_list': Array; - /** - * Created date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'created'?: string; - /** - * Modified date of Multi-Host Integration aggregation schedule - * @type {string} - * @memberof MultiHostIntegrationsAggScheduleUpdateV2026 - */ - 'modified'?: string; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface MultiHostIntegrationsBeforeProvisioningRuleV2026 - */ -export interface MultiHostIntegrationsBeforeProvisioningRuleV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2026 - */ - 'type'?: MultiHostIntegrationsBeforeProvisioningRuleV2026TypeV2026; - /** - * Rule ID. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2026 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsBeforeProvisioningRuleV2026 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsBeforeProvisioningRuleV2026TypeV2026 = { - Rule: 'RULE' -} as const; - -export type MultiHostIntegrationsBeforeProvisioningRuleV2026TypeV2026 = typeof MultiHostIntegrationsBeforeProvisioningRuleV2026TypeV2026[keyof typeof MultiHostIntegrationsBeforeProvisioningRuleV2026TypeV2026]; - -/** - * - * @export - * @interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2026 - */ -export interface MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2026 { - /** - * File name of the connector JAR - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2026 - */ - 'connectorFileNameUploadedDate'?: string; -} -/** - * Attributes of Multi-Host Integration - * @export - * @interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 - */ -export interface MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 { - /** - * Password. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 - */ - 'password'?: string; - /** - * Connector file. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 - */ - 'connector_files'?: string; - /** - * Authentication type. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 - */ - 'authType'?: string; - /** - * Username. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026 - */ - 'user'?: string; -} -/** - * Connector specific configuration. This configuration will differ for Multi-Host Integration type. - * @export - * @interface MultiHostIntegrationsConnectorAttributesV2026 - */ -export interface MultiHostIntegrationsConnectorAttributesV2026 { - [key: string]: string | any; - - /** - * Maximum sources allowed count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'maxAllowedSources'?: number; - /** - * Last upload sources count of a Multi-Host Integration - * @type {number} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'lastSourceUploadCount'?: number; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2026} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'connectorFileUploadHistory'?: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistoryV2026; - /** - * Multi-Host integration status. - * @type {string} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'multihost_status'?: MultiHostIntegrationsConnectorAttributesV2026MultihostStatusV2026; - /** - * Show account schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'showAccountSchema'?: boolean; - /** - * Show entitlement schema - * @type {boolean} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'showEntitlementSchema'?: boolean; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026} - * @memberof MultiHostIntegrationsConnectorAttributesV2026 - */ - 'multiHostAttributes'?: MultiHostIntegrationsConnectorAttributesMultiHostAttributesV2026; -} - -export const MultiHostIntegrationsConnectorAttributesV2026MultihostStatusV2026 = { - Ready: 'ready', - Processing: 'processing', - FileUploadInProgress: 'fileUploadInProgress', - SourceCreationInProgress: 'sourceCreationInProgress', - AggregationGroupingInProgress: 'aggregationGroupingInProgress', - AggregationScheduleInProgress: 'aggregationScheduleInProgress', - DeleteInProgress: 'deleteInProgress', - DeleteFailed: 'deleteFailed' -} as const; - -export type MultiHostIntegrationsConnectorAttributesV2026MultihostStatusV2026 = typeof MultiHostIntegrationsConnectorAttributesV2026MultihostStatusV2026[keyof typeof MultiHostIntegrationsConnectorAttributesV2026MultihostStatusV2026]; - -/** - * This represents sources to be created of same type. - * @export - * @interface MultiHostIntegrationsCreateSourcesV2026 - */ -export interface MultiHostIntegrationsCreateSourcesV2026 { - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2026 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateSourcesV2026 - */ - 'description'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateSourcesV2026 - */ - 'connectorAttributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface MultiHostIntegrationsCreateV2026 - */ -export interface MultiHostIntegrationsCreateV2026 { - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2026} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'owner': MultiHostIntegrationsOwnerV2026; - /** - * - * @type {SourceClusterV2026} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'cluster'?: SourceClusterV2026 | null; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'connector': string; - /** - * Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. - * @type {{ [key: string]: any; }} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * - * @type {SourceManagementWorkgroupV2026} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2026 | null; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsCreateV2026 - */ - 'modified'?: string; -} -/** - * Reference to identity object who owns the source. - * @export - * @interface MultiHostIntegrationsOwnerV2026 - */ -export interface MultiHostIntegrationsOwnerV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2026 - */ - 'type'?: MultiHostIntegrationsOwnerV2026TypeV2026; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2026 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof MultiHostIntegrationsOwnerV2026 - */ - 'name'?: string; -} - -export const MultiHostIntegrationsOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type MultiHostIntegrationsOwnerV2026TypeV2026 = typeof MultiHostIntegrationsOwnerV2026TypeV2026[keyof typeof MultiHostIntegrationsOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface MultiHostIntegrationsV2026 - */ -export interface MultiHostIntegrationsV2026 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'id': string; - /** - * Multi-Host Integration\'s human-readable name. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'name': string; - /** - * Multi-Host Integration\'s human-readable description. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'description': string; - /** - * - * @type {MultiHostIntegrationsOwnerV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'owner': MultiHostIntegrationsOwnerV2026; - /** - * - * @type {SourceClusterV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'cluster'?: SourceClusterV2026 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2026 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2026 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2026; - /** - * - * @type {SourceManagerCorrelationRuleV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2026 | null; - /** - * - * @type {MultiHostIntegrationsBeforeProvisioningRuleV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'beforeProvisioningRule'?: MultiHostIntegrationsBeforeProvisioningRuleV2026 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2026 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostIntegrationsV2026 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostIntegrationsV2026 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectorClass'?: string; - /** - * - * @type {MultiHostIntegrationsConnectorAttributesV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectorAttributes'?: MultiHostIntegrationsConnectorAttributesV2026; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostIntegrationsV2026 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostIntegrationsV2026 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2026 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostIntegrationsV2026 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'status'?: MultiHostIntegrationsV2026StatusV2026; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectionType'?: MultiHostIntegrationsV2026ConnectionTypeV2026; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostIntegrationsV2026 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostIntegrationsV2026 - */ - 'category'?: string | null; - /** - * - * @type {MultiHostIntegrationsAccountsFileV2026} - * @memberof MultiHostIntegrationsV2026 - */ - 'accountsFile'?: MultiHostIntegrationsAccountsFileV2026 | null; -} - -export const MultiHostIntegrationsV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostIntegrationsV2026FeaturesV2026 = typeof MultiHostIntegrationsV2026FeaturesV2026[keyof typeof MultiHostIntegrationsV2026FeaturesV2026]; -export const MultiHostIntegrationsV2026StatusV2026 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostIntegrationsV2026StatusV2026 = typeof MultiHostIntegrationsV2026StatusV2026[keyof typeof MultiHostIntegrationsV2026StatusV2026]; -export const MultiHostIntegrationsV2026ConnectionTypeV2026 = { - Direct: 'direct', - File: 'file' -} as const; - -export type MultiHostIntegrationsV2026ConnectionTypeV2026 = typeof MultiHostIntegrationsV2026ConnectionTypeV2026[keyof typeof MultiHostIntegrationsV2026ConnectionTypeV2026]; - -/** - * - * @export - * @interface MultiHostSourcesV2026 - */ -export interface MultiHostSourcesV2026 { - /** - * Source ID. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'id': string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'description'?: string; - /** - * - * @type {MultiHostIntegrationsOwnerV2026} - * @memberof MultiHostSourcesV2026 - */ - 'owner': MultiHostIntegrationsOwnerV2026; - /** - * - * @type {SourceClusterV2026} - * @memberof MultiHostSourcesV2026 - */ - 'cluster'?: SourceClusterV2026 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2026} - * @memberof MultiHostSourcesV2026 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2026 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2026} - * @memberof MultiHostSourcesV2026 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2026 | null; - /** - * - * @type {ManagerCorrelationMappingV2026} - * @memberof MultiHostSourcesV2026 - */ - 'managerCorrelationMapping'?: ManagerCorrelationMappingV2026; - /** - * - * @type {SourceManagerCorrelationRuleV2026} - * @memberof MultiHostSourcesV2026 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2026 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2026} - * @memberof MultiHostSourcesV2026 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2026 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof MultiHostSourcesV2026 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof MultiHostSourcesV2026 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof MultiHostSourcesV2026 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {{ [key: string]: any; }} - * @memberof MultiHostSourcesV2026 - */ - 'connectorAttributes'?: { [key: string]: any; }; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof MultiHostSourcesV2026 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof MultiHostSourcesV2026 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2026} - * @memberof MultiHostSourcesV2026 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2026 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof MultiHostSourcesV2026 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'status'?: MultiHostSourcesV2026StatusV2026; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connectorName': string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof MultiHostSourcesV2026 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof MultiHostSourcesV2026 - */ - 'category'?: string | null; -} - -export const MultiHostSourcesV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type MultiHostSourcesV2026FeaturesV2026 = typeof MultiHostSourcesV2026FeaturesV2026[keyof typeof MultiHostSourcesV2026FeaturesV2026]; -export const MultiHostSourcesV2026StatusV2026 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type MultiHostSourcesV2026StatusV2026 = typeof MultiHostSourcesV2026StatusV2026[keyof typeof MultiHostSourcesV2026StatusV2026]; - -/** - * - * @export - * @interface MultiPolicyRequestV2026 - */ -export interface MultiPolicyRequestV2026 { - /** - * Multi-policy report will be run for this list of ids - * @type {Array} - * @memberof MultiPolicyRequestV2026 - */ - 'filteredPolicyList'?: Array; -} -/** - * - * @export - * @interface NameNormalizerV2026 - */ -export interface NameNormalizerV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof NameNormalizerV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof NameNormalizerV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * | Construct | Date Time Pattern | Description | | --------- | ----------------- | ----------- | | ISO8601 | `yyyy-MM-dd\'T\'HH:mm:ss.SSSX` | The ISO8601 standard. | | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - * @export - * @enum {string} - */ - -export const NamedConstructsV2026 = { - Iso8601: 'ISO8601', - Ldap: 'LDAP', - PeopleSoft: 'PEOPLE_SOFT', - EpochTimeJava: 'EPOCH_TIME_JAVA', - EpochTimeWin32: 'EPOCH_TIME_WIN32' -} as const; - -export type NamedConstructsV2026 = typeof NamedConstructsV2026[keyof typeof NamedConstructsV2026]; - - -/** - * Source configuration information for Native Change Detection that is read and used by account aggregation process. - * @export - * @interface NativeChangeDetectionConfigV2026 - */ -export interface NativeChangeDetectionConfigV2026 { - /** - * A flag indicating if Native Change Detection is enabled for a source. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'enabled'?: boolean; - /** - * Operation types for which Native Change Detection is enabled for a source. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'operations'?: Array; - /** - * A flag indicating that all entitlements participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'allEntitlements'?: boolean; - /** - * A flag indicating that all non-entitlement account attributes participate in Native Change Detection. - * @type {boolean} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'allNonEntitlementAttributes'?: boolean; - /** - * If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'selectedEntitlements'?: Array; - /** - * If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. - * @type {Array} - * @memberof NativeChangeDetectionConfigV2026 - */ - 'selectedNonEntitlementAttributes'?: Array; -} - -export const NativeChangeDetectionConfigV2026OperationsV2026 = { - AccountUpdated: 'ACCOUNT_UPDATED', - AccountCreated: 'ACCOUNT_CREATED', - AccountDeleted: 'ACCOUNT_DELETED' -} as const; - -export type NativeChangeDetectionConfigV2026OperationsV2026 = typeof NativeChangeDetectionConfigV2026OperationsV2026[keyof typeof NativeChangeDetectionConfigV2026OperationsV2026]; - -/** - * The nested aggregation object. - * @export - * @interface NestedAggregationV2026 - */ -export interface NestedAggregationV2026 { - /** - * The name of the nested aggregate to be included in the result. - * @type {string} - * @memberof NestedAggregationV2026 - */ - 'name': string; - /** - * The type of the nested object. - * @type {string} - * @memberof NestedAggregationV2026 - */ - 'type': string; -} -/** - * A NestedConfig - * @export - * @interface NestedConfigV2026 - */ -export interface NestedConfigV2026 { - /** - * The unique identifier of the ancestor RightSet. - * @type {string} - * @memberof NestedConfigV2026 - */ - 'ancestorId'?: string; - /** - * The depth level of the configuration. - * @type {number} - * @memberof NestedConfigV2026 - */ - 'depth'?: number; - /** - * The unique identifier of the parent RightSet. - * @type {string} - * @memberof NestedConfigV2026 - */ - 'parentId'?: string | null; - /** - * List of unique identifiers for child configurations. - * @type {Array} - * @memberof NestedConfigV2026 - */ - 'childrenIds'?: Array; -} -/** - * - * @export - * @interface NetworkConfigurationV2026 - */ -export interface NetworkConfigurationV2026 { - /** - * The collection of ip ranges. - * @type {Array} - * @memberof NetworkConfigurationV2026 - */ - 'range'?: Array | null; - /** - * The collection of country codes. - * @type {Array} - * @memberof NetworkConfigurationV2026 - */ - 'geolocation'?: Array | null; - /** - * Denotes whether the provided lists are whitelisted or blacklisted for geo location. - * @type {boolean} - * @memberof NetworkConfigurationV2026 - */ - 'whitelisted'?: boolean; -} -/** - * - * @export - * @interface NonEmployeeApprovalDecisionV2026 - */ -export interface NonEmployeeApprovalDecisionV2026 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeApprovalDecisionV2026 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface NonEmployeeApprovalItemBaseV2026 - */ -export interface NonEmployeeApprovalItemBaseV2026 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2026} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2026; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2026} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'approvalStatus'?: ApprovalStatusV2026; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBaseV2026 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemDetailV2026 - */ -export interface NonEmployeeApprovalItemDetailV2026 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2026} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2026; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2026} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'approvalStatus'?: ApprovalStatusV2026; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestWithoutApprovalItemV2026} - * @memberof NonEmployeeApprovalItemDetailV2026 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItemV2026; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemV2026 - */ -export interface NonEmployeeApprovalItemV2026 { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2026} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'approver'?: NonEmployeeIdentityReferenceWithIdV2026; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatusV2026} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'approvalStatus'?: ApprovalStatusV2026; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestLiteV2026} - * @memberof NonEmployeeApprovalItemV2026 - */ - 'nonEmployeeRequest'?: NonEmployeeRequestLiteV2026; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalSummaryV2026 - */ -export interface NonEmployeeApprovalSummaryV2026 { - /** - * The number of approved non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2026 - */ - 'approved'?: number; - /** - * The number of pending non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2026 - */ - 'pending'?: number; - /** - * The number of rejected non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummaryV2026 - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface NonEmployeeBulkUploadJobV2026 - */ -export interface NonEmployeeBulkUploadJobV2026 { - /** - * The bulk upload job\'s ID. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2026 - */ - 'id'?: string; - /** - * The ID of the source to bulk-upload non-employees to. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2026 - */ - 'sourceId'?: string; - /** - * The date-time the job was submitted. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2026 - */ - 'created'?: string; - /** - * The date-time that the job was last updated. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2026 - */ - 'modified'?: string; - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. - * @type {string} - * @memberof NonEmployeeBulkUploadJobV2026 - */ - 'status'?: NonEmployeeBulkUploadJobV2026StatusV2026; -} - -export const NonEmployeeBulkUploadJobV2026StatusV2026 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadJobV2026StatusV2026 = typeof NonEmployeeBulkUploadJobV2026StatusV2026[keyof typeof NonEmployeeBulkUploadJobV2026StatusV2026]; - -/** - * - * @export - * @interface NonEmployeeBulkUploadStatusV2026 - */ -export interface NonEmployeeBulkUploadStatusV2026 { - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. - * @type {string} - * @memberof NonEmployeeBulkUploadStatusV2026 - */ - 'status'?: NonEmployeeBulkUploadStatusV2026StatusV2026; -} - -export const NonEmployeeBulkUploadStatusV2026StatusV2026 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadStatusV2026StatusV2026 = typeof NonEmployeeBulkUploadStatusV2026StatusV2026[keyof typeof NonEmployeeBulkUploadStatusV2026StatusV2026]; - -/** - * Identifies if the identity is a normal identity or a governance group - * @export - * @enum {string} - */ - -export const NonEmployeeIdentityDtoTypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeIdentityDtoTypeV2026 = typeof NonEmployeeIdentityDtoTypeV2026[keyof typeof NonEmployeeIdentityDtoTypeV2026]; - - -/** - * - * @export - * @interface NonEmployeeIdentityReferenceWithIdV2026 - */ -export interface NonEmployeeIdentityReferenceWithIdV2026 { - /** - * - * @type {NonEmployeeIdentityDtoTypeV2026} - * @memberof NonEmployeeIdentityReferenceWithIdV2026 - */ - 'type'?: NonEmployeeIdentityDtoTypeV2026; - /** - * Identity id - * @type {string} - * @memberof NonEmployeeIdentityReferenceWithIdV2026 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeIdnUserRequestV2026 - */ -export interface NonEmployeeIdnUserRequestV2026 { - /** - * Identity id. - * @type {string} - * @memberof NonEmployeeIdnUserRequestV2026 - */ - 'id': string; -} -/** - * - * @export - * @interface NonEmployeeRecordV2026 - */ -export interface NonEmployeeRecordV2026 { - /** - * Non-Employee record id. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'id'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'manager'?: string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'sourceId'?: string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRecordV2026 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRecordV2026 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeRejectApprovalDecisionV2026 - */ -export interface NonEmployeeRejectApprovalDecisionV2026 { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeRejectApprovalDecisionV2026 - */ - 'comment': string; -} -/** - * - * @export - * @interface NonEmployeeRequestBodyV2026 - */ -export interface NonEmployeeRequestBodyV2026 { - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'accountName': string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'firstName': string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'lastName': string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'email': string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'phone': string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'manager': string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'sourceId': string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'startDate': string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBodyV2026 - */ - 'endDate': string; -} -/** - * - * @export - * @interface NonEmployeeRequestLiteV2026 - */ -export interface NonEmployeeRequestLiteV2026 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestLiteV2026 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2026} - * @memberof NonEmployeeRequestLiteV2026 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2026; -} -/** - * - * @export - * @interface NonEmployeeRequestSummaryV2026 - */ -export interface NonEmployeeRequestSummaryV2026 { - /** - * The number of approved non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2026 - */ - 'approved'?: number; - /** - * The number of rejected non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2026 - */ - 'rejected'?: number; - /** - * The number of pending non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2026 - */ - 'pending'?: number; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummaryV2026 - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NonEmployeeRequestV2026 - */ -export interface NonEmployeeRequestV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'description'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteV2026} - * @memberof NonEmployeeRequestV2026 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteV2026; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestV2026 - */ - 'data'?: { [key: string]: string; }; - /** - * List of approval item for the request - * @type {Array} - * @memberof NonEmployeeRequestV2026 - */ - 'approvalItems'?: Array; - /** - * - * @type {ApprovalStatusV2026} - * @memberof NonEmployeeRequestV2026 - */ - 'approvalStatus'?: ApprovalStatusV2026; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestV2026 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeRequestWithoutApprovalItemV2026 - */ -export interface NonEmployeeRequestWithoutApprovalItemV2026 { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithIdV2026} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'requester'?: NonEmployeeIdentityReferenceWithIdV2026; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteWithSchemaAttributesV2026} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributesV2026; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'data'?: { [key: string]: string; }; - /** - * - * @type {ApprovalStatusV2026} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'approvalStatus'?: ApprovalStatusV2026; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItemV2026 - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBodyV2026 - */ -export interface NonEmployeeSchemaAttributeBodyV2026 { - /** - * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'type': string; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBodyV2026 - */ - 'required'?: boolean; -} -/** - * Enum representing the type of data a schema attribute accepts. - * @export - * @enum {string} - */ - -export const NonEmployeeSchemaAttributeTypeV2026 = { - Text: 'TEXT', - Date: 'DATE', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeSchemaAttributeTypeV2026 = typeof NonEmployeeSchemaAttributeTypeV2026[keyof typeof NonEmployeeSchemaAttributeTypeV2026]; - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeV2026 - */ -export interface NonEmployeeSchemaAttributeV2026 { - /** - * Schema Attribute Id - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'id'?: string; - /** - * True if this schema attribute is mandatory on all non-employees sources. - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'system'?: boolean; - /** - * When the schema attribute was last modified. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'modified'?: string; - /** - * When the schema attribute was created. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'created'?: string; - /** - * - * @type {NonEmployeeSchemaAttributeTypeV2026} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'type': NonEmployeeSchemaAttributeTypeV2026; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeV2026 - */ - 'required'?: boolean; -} - - -/** - * - * @export - * @interface NonEmployeeSourceLiteV2026 - */ -export interface NonEmployeeSourceLiteV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ -export interface NonEmployeeSourceLiteWithSchemaAttributesV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ - 'description'?: string; - /** - * List of schema attributes associated with this non-employee source. - * @type {Array} - * @memberof NonEmployeeSourceLiteWithSchemaAttributesV2026 - */ - 'schemaAttributes'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceRequestBodyV2026 - */ -export interface NonEmployeeSourceRequestBodyV2026 { - /** - * Name of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'name': string; - /** - * Description of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'description': string; - /** - * - * @type {NonEmployeeIdnUserRequestV2026} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'owner': NonEmployeeIdnUserRequestV2026; - /** - * The ID for the management workgroup that contains source sub-admins - * @type {string} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'managementWorkgroup'?: string; - /** - * List of approvers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'approvers'?: Array; - /** - * List of account managers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBodyV2026 - */ - 'accountManagers'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceV2026 - */ -export interface NonEmployeeSourceV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceV2026 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceV2026 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceV2026 - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithCloudExternalIdV2026 - */ -export interface NonEmployeeSourceWithCloudExternalIdV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'created'?: string; - /** - * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalIdV2026 - */ - 'cloudExternalId'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithNECountV2026 - */ -export interface NonEmployeeSourceWithNECountV2026 { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'created'?: string; - /** - * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. - * @type {number} - * @memberof NonEmployeeSourceWithNECountV2026 - */ - 'nonEmployeeCount'?: number | null; -} -/** - * - * @export - * @interface NotificationTemplateContextV2026 - */ -export interface NotificationTemplateContextV2026 { - /** - * A JSON object that stores the context. - * @type {{ [key: string]: any; }} - * @memberof NotificationTemplateContextV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * When the global context was created - * @type {string} - * @memberof NotificationTemplateContextV2026 - */ - 'created'?: string; - /** - * When the global context was last modified - * @type {string} - * @memberof NotificationTemplateContextV2026 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface ObjectExportImportNamesV2026 - */ -export interface ObjectExportImportNamesV2026 { - /** - * Object names to be included in a backup. - * @type {Array} - * @memberof ObjectExportImportNamesV2026 - */ - 'includedNames'?: Array; -} -/** - * - * @export - * @interface ObjectExportImportOptionsV2026 - */ -export interface ObjectExportImportOptionsV2026 { - /** - * Object ids to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2026 - */ - 'includedIds'?: Array; - /** - * Object names to be included in an import or export. - * @type {Array} - * @memberof ObjectExportImportOptionsV2026 - */ - 'includedNames'?: Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResult1V2026 - */ -export interface ObjectImportResult1V2026 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2026 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2026 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult1V2026 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResult1V2026 - */ - 'importedObjects': Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResultV2026 - */ -export interface ObjectImportResultV2026 { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2026 - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2026 - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResultV2026 - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResultV2026 - */ - 'importedObjects': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateRequestV2026 - */ -export interface ObjectMappingBulkCreateRequestV2026 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateRequestV2026 - */ - 'newObjectsMappings': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateResponseV2026 - */ -export interface ObjectMappingBulkCreateResponseV2026 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateResponseV2026 - */ - 'addedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchRequestV2026 - */ -export interface ObjectMappingBulkPatchRequestV2026 { - /** - * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. - * @type {{ [key: string]: Array; }} - * @memberof ObjectMappingBulkPatchRequestV2026 - */ - 'patches': { [key: string]: Array; }; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchResponseV2026 - */ -export interface ObjectMappingBulkPatchResponseV2026 { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkPatchResponseV2026 - */ - 'patchedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingRequestV2026 - */ -export interface ObjectMappingRequestV2026 { - /** - * Type of the object the mapping value applies to, must be one from enum - * @type {string} - * @memberof ObjectMappingRequestV2026 - */ - 'objectType': ObjectMappingRequestV2026ObjectTypeV2026; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingRequestV2026 - */ - 'jsonPath': string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2026 - */ - 'sourceValue': string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequestV2026 - */ - 'targetValue': string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingRequestV2026 - */ - 'enabled'?: boolean; -} - -export const ObjectMappingRequestV2026ObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingRequestV2026ObjectTypeV2026 = typeof ObjectMappingRequestV2026ObjectTypeV2026[keyof typeof ObjectMappingRequestV2026ObjectTypeV2026]; - -/** - * - * @export - * @interface ObjectMappingResponseV2026 - */ -export interface ObjectMappingResponseV2026 { - /** - * Id of the object mapping - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'objectMappingId'?: string; - /** - * Type of the object the mapping value applies to - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'objectType'?: ObjectMappingResponseV2026ObjectTypeV2026; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'jsonPath'?: string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'sourceValue'?: string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'targetValue'?: string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingResponseV2026 - */ - 'enabled'?: boolean; - /** - * Object mapping creation timestamp - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'created'?: string; - /** - * Object mapping latest update timestamp - * @type {string} - * @memberof ObjectMappingResponseV2026 - */ - 'modified'?: string; -} - -export const ObjectMappingResponseV2026ObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingResponseV2026ObjectTypeV2026 = typeof ObjectMappingResponseV2026ObjectTypeV2026[keyof typeof ObjectMappingResponseV2026ObjectTypeV2026]; - -/** - * Operation on a specific criteria - * @export - * @enum {string} - */ - -export const OperationV2026 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - And: 'AND', - Or: 'OR' -} as const; - -export type OperationV2026 = typeof OperationV2026[keyof typeof OperationV2026]; - - -/** - * DTO class for OrgConfig data accessible by customer external org admin (\"ORG_ADMIN\") users - * @export - * @interface OrgConfigV2026 - */ -export interface OrgConfigV2026 { - /** - * The name of the org. - * @type {string} - * @memberof OrgConfigV2026 - */ - 'orgName'?: string; - /** - * The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones - * @type {string} - * @memberof OrgConfigV2026 - */ - 'timeZone'?: string; - /** - * Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. - * @type {boolean} - * @memberof OrgConfigV2026 - */ - 'lcsChangeHonorsSourceEnableFeature'?: boolean; - /** - * ARM Customer ID - * @type {string} - * @memberof OrgConfigV2026 - */ - 'armCustomerId'?: string | null; - /** - * A list of IDN::sourceId to ARM::systemId mappings. - * @type {string} - * @memberof OrgConfigV2026 - */ - 'armSapSystemIdMappings'?: string | null; - /** - * ARM authentication string - * @type {string} - * @memberof OrgConfigV2026 - */ - 'armAuth'?: string | null; - /** - * ARM database name - * @type {string} - * @memberof OrgConfigV2026 - */ - 'armDb'?: string | null; - /** - * ARM SSO URL - * @type {string} - * @memberof OrgConfigV2026 - */ - 'armSsoUrl'?: string | null; - /** - * Flag to determine whether IAI Certification Recommendations are enabled for the current org - * @type {boolean} - * @memberof OrgConfigV2026 - */ - 'iaiEnableCertificationRecommendations'?: boolean; - /** - * - * @type {Array} - * @memberof OrgConfigV2026 - */ - 'sodReportConfigs'?: Array; -} -/** - * - * @export - * @interface OriginalRequestV2026 - */ -export interface OriginalRequestV2026 { - /** - * Account ID. - * @type {string} - * @memberof OriginalRequestV2026 - */ - 'accountId'?: string; - /** - * - * @type {ResultV2026} - * @memberof OriginalRequestV2026 - */ - 'result'?: ResultV2026; - /** - * Attribute changes requested for account. - * @type {Array} - * @memberof OriginalRequestV2026 - */ - 'attributeRequests'?: Array; - /** - * Operation used. - * @type {string} - * @memberof OriginalRequestV2026 - */ - 'op'?: string; - /** - * - * @type {AccountSourceV2026} - * @memberof OriginalRequestV2026 - */ - 'source'?: AccountSourceV2026; -} -/** - * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) - * @export - * @interface OrphanIdentitiesReportArgumentsV2026 - */ -export interface OrphanIdentitiesReportArgumentsV2026 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof OrphanIdentitiesReportArgumentsV2026 - */ - 'selectedFormats'?: Array; -} - -export const OrphanIdentitiesReportArgumentsV2026SelectedFormatsV2026 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type OrphanIdentitiesReportArgumentsV2026SelectedFormatsV2026 = typeof OrphanIdentitiesReportArgumentsV2026SelectedFormatsV2026[keyof typeof OrphanIdentitiesReportArgumentsV2026SelectedFormatsV2026]; - -/** - * - * @export - * @interface OutlierContributingFeatureV2026 - */ -export interface OutlierContributingFeatureV2026 { - /** - * Contributing feature id - * @type {string} - * @memberof OutlierContributingFeatureV2026 - */ - 'id'?: string; - /** - * The name of the feature - * @type {string} - * @memberof OutlierContributingFeatureV2026 - */ - 'name'?: string; - /** - * - * @type {OutlierValueTypeV2026} - * @memberof OutlierContributingFeatureV2026 - */ - 'valueType'?: OutlierValueTypeV2026; - /** - * The feature value - * @type {number} - * @memberof OutlierContributingFeatureV2026 - */ - 'value'?: number; - /** - * The importance of the feature. This can also be a negative value - * @type {number} - * @memberof OutlierContributingFeatureV2026 - */ - 'importance'?: number; - /** - * The (translated if header is passed) displayName for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2026 - */ - 'displayName'?: string; - /** - * The (translated if header is passed) description for the feature - * @type {string} - * @memberof OutlierContributingFeatureV2026 - */ - 'description'?: string; - /** - * - * @type {OutlierFeatureTranslationV2026} - * @memberof OutlierContributingFeatureV2026 - */ - 'translationMessages'?: OutlierFeatureTranslationV2026 | null; -} -/** - * - * @export - * @interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2026 - */ -export interface OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2026 { - /** - * display name - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2026 - */ - 'displayName'?: string; - /** - * value - * @type {string} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2026 - */ - 'value'?: string; - /** - * - * @type {OutlierValueTypeV2026} - * @memberof OutlierFeatureSummaryOutlierFeatureDisplayValuesInnerV2026 - */ - 'valueType'?: OutlierValueTypeV2026; -} -/** - * - * @export - * @interface OutlierFeatureSummaryV2026 - */ -export interface OutlierFeatureSummaryV2026 { - /** - * Contributing feature name - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'contributingFeatureName'?: string; - /** - * Identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'identityOutlierDisplayName'?: string; - /** - * - * @type {Array} - * @memberof OutlierFeatureSummaryV2026 - */ - 'outlierFeatureDisplayValues'?: Array; - /** - * Definition of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'featureDefinition'?: string; - /** - * Detailed explanation of the feature - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'featureExplanation'?: string; - /** - * outlier\'s peer identity display name - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'peerDisplayName'?: string | null; - /** - * outlier\'s peer identity id - * @type {string} - * @memberof OutlierFeatureSummaryV2026 - */ - 'peerIdentityId'?: string | null; - /** - * Access Item reference - * @type {object} - * @memberof OutlierFeatureSummaryV2026 - */ - 'accessItemReference'?: object; -} -/** - * - * @export - * @interface OutlierFeatureTranslationV2026 - */ -export interface OutlierFeatureTranslationV2026 { - /** - * - * @type {TranslationMessageV2026} - * @memberof OutlierFeatureTranslationV2026 - */ - 'displayName'?: TranslationMessageV2026; - /** - * - * @type {TranslationMessageV2026} - * @memberof OutlierFeatureTranslationV2026 - */ - 'description'?: TranslationMessageV2026; -} -/** - * - * @export - * @interface OutlierSummaryV2026 - */ -export interface OutlierSummaryV2026 { - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierSummaryV2026 - */ - 'type'?: OutlierSummaryV2026TypeV2026; - /** - * The date the bulk outlier detection ran/snapshot was created - * @type {string} - * @memberof OutlierSummaryV2026 - */ - 'snapshotDate'?: string; - /** - * Total number of outliers for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2026 - */ - 'totalOutliers'?: number; - /** - * Total number of identities for the customer making the request - * @type {number} - * @memberof OutlierSummaryV2026 - */ - 'totalIdentities'?: number; - /** - * - * @type {number} - * @memberof OutlierSummaryV2026 - */ - 'totalIgnored'?: number; -} - -export const OutlierSummaryV2026TypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierSummaryV2026TypeV2026 = typeof OutlierSummaryV2026TypeV2026[keyof typeof OutlierSummaryV2026TypeV2026]; - -/** - * - * @export - * @interface OutlierV2026 - */ -export interface OutlierV2026 { - /** - * The identity\'s unique identifier for the outlier record - * @type {string} - * @memberof OutlierV2026 - */ - 'id'?: string; - /** - * The ID of the identity that is detected as an outlier - * @type {string} - * @memberof OutlierV2026 - */ - 'identityId'?: string; - /** - * The type of outlier summary - * @type {string} - * @memberof OutlierV2026 - */ - 'type'?: OutlierV2026TypeV2026; - /** - * The first date the outlier was detected - * @type {string} - * @memberof OutlierV2026 - */ - 'firstDetectionDate'?: string; - /** - * The most recent date the outlier was detected - * @type {string} - * @memberof OutlierV2026 - */ - 'latestDetectionDate'?: string; - /** - * Flag whether or not the outlier has been ignored - * @type {boolean} - * @memberof OutlierV2026 - */ - 'ignored'?: boolean; - /** - * Object containing mapped identity attributes - * @type {object} - * @memberof OutlierV2026 - */ - 'attributes'?: object; - /** - * The outlier score determined by the detection engine ranging from 0..1 - * @type {number} - * @memberof OutlierV2026 - */ - 'score'?: number; - /** - * Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored - * @type {string} - * @memberof OutlierV2026 - */ - 'unignoreType'?: OutlierV2026UnignoreTypeV2026 | null; - /** - * shows date when last time has been unignored outlier - * @type {string} - * @memberof OutlierV2026 - */ - 'unignoreDate'?: string | null; - /** - * shows date when last time has been ignored outlier - * @type {string} - * @memberof OutlierV2026 - */ - 'ignoreDate'?: string | null; -} - -export const OutlierV2026TypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; - -export type OutlierV2026TypeV2026 = typeof OutlierV2026TypeV2026[keyof typeof OutlierV2026TypeV2026]; -export const OutlierV2026UnignoreTypeV2026 = { - Manual: 'MANUAL', - Automatic: 'AUTOMATIC' -} as const; - -export type OutlierV2026UnignoreTypeV2026 = typeof OutlierV2026UnignoreTypeV2026[keyof typeof OutlierV2026UnignoreTypeV2026]; - -/** - * The data type of the value field - * @export - * @interface OutlierValueTypeV2026 - */ -export interface OutlierValueTypeV2026 { - /** - * The data type of the value field - * @type {string} - * @memberof OutlierValueTypeV2026 - */ - 'name'?: OutlierValueTypeV2026NameV2026; - /** - * The position of the value type - * @type {number} - * @memberof OutlierValueTypeV2026 - */ - 'ordinal'?: number; -} - -export const OutlierValueTypeV2026NameV2026 = { - Integer: 'INTEGER', - Float: 'FLOAT' -} as const; - -export type OutlierValueTypeV2026NameV2026 = typeof OutlierValueTypeV2026NameV2026[keyof typeof OutlierValueTypeV2026NameV2026]; - -/** - * - * @export - * @interface OutliersContributingFeatureAccessItemsV2026 - */ -export interface OutliersContributingFeatureAccessItemsV2026 { - /** - * The ID of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'id'?: string; - /** - * the display name of the access item - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'displayName'?: string; - /** - * Description of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'description'?: string | null; - /** - * The type of the access item. - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'accessType'?: OutliersContributingFeatureAccessItemsV2026AccessTypeV2026; - /** - * the associated source name if it exists - * @type {string} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'sourceName'?: string; - /** - * rarest access - * @type {boolean} - * @memberof OutliersContributingFeatureAccessItemsV2026 - */ - 'extremelyRare'?: boolean; -} - -export const OutliersContributingFeatureAccessItemsV2026AccessTypeV2026 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type OutliersContributingFeatureAccessItemsV2026AccessTypeV2026 = typeof OutliersContributingFeatureAccessItemsV2026AccessTypeV2026[keyof typeof OutliersContributingFeatureAccessItemsV2026AccessTypeV2026]; - -/** - * Owner\'s identity. - * @export - * @interface OwnerDtoV2026 - */ -export interface OwnerDtoV2026 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof OwnerDtoV2026 - */ - 'type'?: OwnerDtoV2026TypeV2026; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerDtoV2026 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof OwnerDtoV2026 - */ - 'name'?: string; -} - -export const OwnerDtoV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerDtoV2026TypeV2026 = typeof OwnerDtoV2026TypeV2026[keyof typeof OwnerDtoV2026TypeV2026]; - -/** - * The owner of this object. - * @export - * @interface OwnerReferenceSegmentsV2026 - */ -export interface OwnerReferenceSegmentsV2026 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2026 - */ - 'type'?: OwnerReferenceSegmentsV2026TypeV2026; - /** - * Identity id - * @type {string} - * @memberof OwnerReferenceSegmentsV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegmentsV2026 - */ - 'name'?: string; -} - -export const OwnerReferenceSegmentsV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceSegmentsV2026TypeV2026 = typeof OwnerReferenceSegmentsV2026TypeV2026[keyof typeof OwnerReferenceSegmentsV2026TypeV2026]; - -/** - * Owner of the object. - * @export - * @interface OwnerReferenceV2026 - */ -export interface OwnerReferenceV2026 { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2026 - */ - 'type'?: OwnerReferenceV2026TypeV2026; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerReferenceV2026 - */ - 'id'?: string; - /** - * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceV2026 - */ - 'name'?: string; -} - -export const OwnerReferenceV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceV2026TypeV2026 = typeof OwnerReferenceV2026TypeV2026[keyof typeof OwnerReferenceV2026TypeV2026]; - -/** - * - * @export - * @interface OwnsV2026 - */ -export interface OwnsV2026 { - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'sources'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'entitlements'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'accessProfiles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'roles'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'apps'?: Array; - /** - * - * @type {Array} - * @memberof OwnsV2026 - */ - 'governanceGroups'?: Array; - /** - * - * @type {boolean} - * @memberof OwnsV2026 - */ - 'fallbackApprover'?: boolean; -} -/** - * The attestation document. This is Base64Url encoded binary data containing the attestation document. This has a cert with a public key that needs to be used to encrypt the private fields of the parameter on creation or update. - * @export - * @interface ParameterStorageAttestationDocumentV2026 - */ -export interface ParameterStorageAttestationDocumentV2026 { - /** - * The Base64Url encoded attestation document. - * @type {string} - * @memberof ParameterStorageAttestationDocumentV2026 - */ - 'attestationDocument'?: string; -} -/** - * RFC 6902 JSON Patch operation - * @export - * @interface ParameterStorageJsonPatchV2026 - */ -export interface ParameterStorageJsonPatchV2026 { - /** - * The operation to perform (add, remove, replace, move, copy, test) - * @type {string} - * @memberof ParameterStorageJsonPatchV2026 - */ - 'op': ParameterStorageJsonPatchV2026OpV2026; - /** - * A JSON-Pointer describing the target location - * @type {string} - * @memberof ParameterStorageJsonPatchV2026 - */ - 'path': string; - /** - * The value to be used within the operations. Required for add/replace/test. - * @type {object} - * @memberof ParameterStorageJsonPatchV2026 - */ - 'value'?: object; - /** - * A JSON-Pointer describing the source location for move/copy. - * @type {string} - * @memberof ParameterStorageJsonPatchV2026 - */ - 'from'?: string; -} - -export const ParameterStorageJsonPatchV2026OpV2026 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type ParameterStorageJsonPatchV2026OpV2026 = typeof ParameterStorageJsonPatchV2026OpV2026[keyof typeof ParameterStorageJsonPatchV2026OpV2026]; - -/** - * A parameter to add to parameter storage. The public and private fields must match the type specification. - * @export - * @interface ParameterStorageNewParameterV2026 - */ -export interface ParameterStorageNewParameterV2026 { - /** - * The UUID of the parameter owner. - * @type {string} - * @memberof ParameterStorageNewParameterV2026 - */ - 'ownerId': string; - /** - * The human-readable name for the parameter. - * @type {string} - * @memberof ParameterStorageNewParameterV2026 - */ - 'name': string; - /** - * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. - * @type {string} - * @memberof ParameterStorageNewParameterV2026 - */ - 'type': string; - /** - * The content must be a JSON object containing the public fields that can be stored with this parameter. - * @type {object} - * @memberof ParameterStorageNewParameterV2026 - */ - 'publicFields'?: object; - /** - * Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter. - * @type {string} - * @memberof ParameterStorageNewParameterV2026 - */ - 'privateFields'?: string; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageNewParameterV2026 - */ - 'description'?: string; -} -/** - * A parameter that has been retrieved from the store. - * @export - * @interface ParameterStorageParameterV2026 - */ -export interface ParameterStorageParameterV2026 { - /** - * The ID of the reference - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'id': string; - /** - * The ID of the user who owns the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'ownerId': string; - /** - * The type of the parameter. This cannot be changed after being set. Please see the types document for more information. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'type'?: string; - /** - * The human-readable name of the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'name': string; - /** - * The name of the primary field in the public fields. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'primaryField'?: string; - /** - * The public fields stored for this parameter. See the types document for information about what can be stored. - * @type {object} - * @memberof ParameterStorageParameterV2026 - */ - 'publicFields': object; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'description'?: string; - /** - * ISO8606 format datetime of the last time any field of the parameter was changed. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'lastModifiedAt'?: string; - /** - * The ID of the user who last modified the parameter. Empty when identity is not known. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'lastModifiedBy'?: string; - /** - * ISO8606 format datetime of the time the secret fields were changed on the parameter. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'privateFieldsLastModifiedAt'?: string; - /** - * The ID of the user who last modified the private fields. Empty when identity is not known. - * @type {string} - * @memberof ParameterStorageParameterV2026 - */ - 'privateFieldsLastModifiedBy'?: string; -} -/** - * Reference information returned in response to a request. - * @export - * @interface ParameterStorageReferenceV2026 - */ -export interface ParameterStorageReferenceV2026 { - /** - * The ID of the reference - * @type {string} - * @memberof ParameterStorageReferenceV2026 - */ - 'id': string; - /** - * The ID of the consumer holding the reference - * @type {string} - * @memberof ParameterStorageReferenceV2026 - */ - 'consumerId': string; - /** - * The ID of the parameter that the reference is pointing to. - * @type {string} - * @memberof ParameterStorageReferenceV2026 - */ - 'parameterId': string; - /** - * The human-readable name of the reference - * @type {string} - * @memberof ParameterStorageReferenceV2026 - */ - 'name': string; - /** - * The hint string used to validate the reference - * @type {string} - * @memberof ParameterStorageReferenceV2026 - */ - 'usageHint'?: string; -} -/** - * An existing parameter that needs to be updated. The type cannot be changed once the parameter is created. - * @export - * @interface ParameterStorageUpdateParameterV2026 - */ -export interface ParameterStorageUpdateParameterV2026 { - /** - * The UUID of the parameter owner. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2026 - */ - 'ownerId'?: string; - /** - * The human-readable name for the parameter. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2026 - */ - 'name'?: string; - /** - * The public fields that can be stored with this parameter. - * @type {object} - * @memberof ParameterStorageUpdateParameterV2026 - */ - 'publicFields'?: object; - /** - * The private fields that can be stored with this parameter. - * @type {string} - * @memberof ParameterStorageUpdateParameterV2026 - */ - 'privateFields'?: string; - /** - * Describe the parameter - * @type {string} - * @memberof ParameterStorageUpdateParameterV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface PasswordChangeRequestV2026 - */ -export interface PasswordChangeRequestV2026 { - /** - * The identity ID that requested the password change - * @type {string} - * @memberof PasswordChangeRequestV2026 - */ - 'identityId'?: string; - /** - * The RSA encrypted password - * @type {string} - * @memberof PasswordChangeRequestV2026 - */ - 'encryptedPassword'?: string; - /** - * The encryption key ID - * @type {string} - * @memberof PasswordChangeRequestV2026 - */ - 'publicKeyId'?: string; - /** - * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordChangeRequestV2026 - */ - 'accountId'?: string; - /** - * The ID of the source for which identity is requesting the password change - * @type {string} - * @memberof PasswordChangeRequestV2026 - */ - 'sourceId'?: string; -} -/** - * - * @export - * @interface PasswordChangeResponseV2026 - */ -export interface PasswordChangeResponseV2026 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordChangeResponseV2026 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordChangeResponseV2026 - */ - 'state'?: PasswordChangeResponseV2026StateV2026; -} - -export const PasswordChangeResponseV2026StateV2026 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordChangeResponseV2026StateV2026 = typeof PasswordChangeResponseV2026StateV2026[keyof typeof PasswordChangeResponseV2026StateV2026]; - -/** - * - * @export - * @interface PasswordDigitTokenResetV2026 - */ -export interface PasswordDigitTokenResetV2026 { - /** - * The uid of the user requested for digit token - * @type {string} - * @memberof PasswordDigitTokenResetV2026 - */ - 'userId': string; - /** - * The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. - * @type {number} - * @memberof PasswordDigitTokenResetV2026 - */ - 'length'?: number; - /** - * The time to live for the digit token in minutes. The default value is 5 minutes. - * @type {number} - * @memberof PasswordDigitTokenResetV2026 - */ - 'durationMinutes'?: number; -} -/** - * - * @export - * @interface PasswordDigitTokenV2026 - */ -export interface PasswordDigitTokenV2026 { - /** - * The digit token for password management - * @type {string} - * @memberof PasswordDigitTokenV2026 - */ - 'digitToken'?: string; - /** - * The reference ID of the digit token generation request - * @type {string} - * @memberof PasswordDigitTokenV2026 - */ - 'requestId'?: string; -} -/** - * - * @export - * @interface PasswordInfoAccountV2026 - */ -export interface PasswordInfoAccountV2026 { - /** - * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordInfoAccountV2026 - */ - 'accountId'?: string; - /** - * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - * @type {string} - * @memberof PasswordInfoAccountV2026 - */ - 'accountName'?: string; -} -/** - * - * @export - * @interface PasswordInfoQueryDTOV2026 - */ -export interface PasswordInfoQueryDTOV2026 { - /** - * The login name of the user - * @type {string} - * @memberof PasswordInfoQueryDTOV2026 - */ - 'userName'?: string; - /** - * The display name of the source - * @type {string} - * @memberof PasswordInfoQueryDTOV2026 - */ - 'sourceName'?: string; -} -/** - * - * @export - * @interface PasswordInfoV2026 - */ -export interface PasswordInfoV2026 { - /** - * Identity ID - * @type {string} - * @memberof PasswordInfoV2026 - */ - 'identityId'?: string; - /** - * source ID - * @type {string} - * @memberof PasswordInfoV2026 - */ - 'sourceId'?: string; - /** - * public key ID - * @type {string} - * @memberof PasswordInfoV2026 - */ - 'publicKeyId'?: string; - /** - * User\'s public key with Base64 encoding - * @type {string} - * @memberof PasswordInfoV2026 - */ - 'publicKey'?: string; - /** - * Account info related to queried identity and source - * @type {Array} - * @memberof PasswordInfoV2026 - */ - 'accounts'?: Array; - /** - * Password constraints - * @type {Array} - * @memberof PasswordInfoV2026 - */ - 'policies'?: Array; -} -/** - * - * @export - * @interface PasswordOrgConfigV2026 - */ -export interface PasswordOrgConfigV2026 { - /** - * Indicator whether custom password instructions feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2026 - */ - 'customInstructionsEnabled'?: boolean; - /** - * Indicator whether \"digit token\" feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfigV2026 - */ - 'digitTokenEnabled'?: boolean; - /** - * The duration of \"digit token\" in minutes. The default value is 5. - * @type {number} - * @memberof PasswordOrgConfigV2026 - */ - 'digitTokenDurationMinutes'?: number; - /** - * The length of \"digit token\". The default value is 6. - * @type {number} - * @memberof PasswordOrgConfigV2026 - */ - 'digitTokenLength'?: number; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2026 - */ -export interface PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2026 { - /** - * Attribute\'s name - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2026 - */ - 'name'?: string; - /** - * Attribute\'s value - * @type {string} - * @memberof PasswordPolicyHoldersDtoAttributesIdentityAttrInnerV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoAttributesV2026 - */ -export interface PasswordPolicyHoldersDtoAttributesV2026 { - /** - * Attributes of PasswordPolicyHoldersDto - * @type {Array} - * @memberof PasswordPolicyHoldersDtoAttributesV2026 - */ - 'identityAttr'?: Array; -} -/** - * - * @export - * @interface PasswordPolicyHoldersDtoInnerV2026 - */ -export interface PasswordPolicyHoldersDtoInnerV2026 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2026 - */ - 'policyId'?: string; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyHoldersDtoInnerV2026 - */ - 'policyName'?: string; - /** - * - * @type {PasswordPolicyHoldersDtoAttributesV2026} - * @memberof PasswordPolicyHoldersDtoInnerV2026 - */ - 'selectors'?: PasswordPolicyHoldersDtoAttributesV2026; -} -/** - * - * @export - * @interface PasswordPolicyV3DtoV2026 - */ -export interface PasswordPolicyV3DtoV2026 { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'id'?: string; - /** - * Description for current password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'description'?: string | null; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'name'?: string; - /** - * Date the Password Policy was created. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'dateCreated'?: number; - /** - * Date the Password Policy was updated. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'lastUpdated'?: number | null; - /** - * The number of days before expiration remaninder. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'firstExpirationReminder'?: number; - /** - * The minimun length of account Id. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'accountIdMinWordLength'?: number; - /** - * The minimun length of account name. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'accountNameMinWordLength'?: number; - /** - * Maximum alpha. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minAlpha'?: number; - /** - * MinCharacterTypes. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minCharacterTypes'?: number; - /** - * Maximum length of the password. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'maxLength'?: number; - /** - * Minimum length of the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minLength'?: number; - /** - * Maximum repetition of the same character in the password. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'maxRepeatedChars'?: number; - /** - * Minimum amount of lower case character in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minLower'?: number; - /** - * Minimum amount of numeric characters in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minNumeric'?: number; - /** - * Minimum amount of special symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minSpecial'?: number; - /** - * Minimum amount of upper case symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'minUpper'?: number; - /** - * Number of days before current password expires. By default is equals to 90. - * @type {number} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'passwordExpiration'?: number; - /** - * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'defaultPolicy'?: boolean; - /** - * Defines whether this policy is enabled to expire or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'enablePasswdExpiration'?: boolean; - /** - * Defines whether this policy require strong Auth or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'requireStrongAuthn'?: boolean; - /** - * Defines whether this policy require strong Auth of network or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'requireStrongAuthOffNetwork'?: boolean; - /** - * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'requireStrongAuthUntrustedGeographies'?: boolean; - /** - * Defines whether this policy uses account attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'useAccountAttributes'?: boolean; - /** - * Defines whether this policy uses dictionary or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'useDictionary'?: boolean; - /** - * Defines whether this policy uses identity attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'useIdentityAttributes'?: boolean; - /** - * Defines whether this policy validate against account id or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'validateAgainstAccountId'?: boolean; - /** - * Defines whether this policy validate against account name or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'validateAgainstAccountName'?: boolean; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'created'?: string | null; - /** - * - * @type {string} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'modified'?: string | null; - /** - * List of sources IDs managed by this password policy. - * @type {Array} - * @memberof PasswordPolicyV3DtoV2026 - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface PasswordStatusV2026 - */ -export interface PasswordStatusV2026 { - /** - * The password change request ID - * @type {string} - * @memberof PasswordStatusV2026 - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordStatusV2026 - */ - 'state'?: PasswordStatusV2026StateV2026; - /** - * The errors during the password change request - * @type {Array} - * @memberof PasswordStatusV2026 - */ - 'errors'?: Array; - /** - * List of source IDs in the password change request - * @type {Array} - * @memberof PasswordStatusV2026 - */ - 'sourceIds'?: Array; -} - -export const PasswordStatusV2026StateV2026 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordStatusV2026StateV2026 = typeof PasswordStatusV2026StateV2026[keyof typeof PasswordStatusV2026StateV2026]; - -/** - * - * @export - * @interface PasswordSyncGroupV2026 - */ -export interface PasswordSyncGroupV2026 { - /** - * ID of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2026 - */ - 'id'?: string; - /** - * Name of the sync group - * @type {string} - * @memberof PasswordSyncGroupV2026 - */ - 'name'?: string; - /** - * ID of the password policy - * @type {string} - * @memberof PasswordSyncGroupV2026 - */ - 'passwordPolicyId'?: string; - /** - * List of password managed sources IDs - * @type {Array} - * @memberof PasswordSyncGroupV2026 - */ - 'sourceIds'?: Array; - /** - * The date and time this sync group was created - * @type {string} - * @memberof PasswordSyncGroupV2026 - */ - 'created'?: string | null; - /** - * The date and time this sync group was last modified - * @type {string} - * @memberof PasswordSyncGroupV2026 - */ - 'modified'?: string | null; -} -/** - * Personal access token owner\'s identity. - * @export - * @interface PatOwnerV2026 - */ -export interface PatOwnerV2026 { - /** - * Personal access token owner\'s DTO type. - * @type {string} - * @memberof PatOwnerV2026 - */ - 'type'?: PatOwnerV2026TypeV2026; - /** - * Personal access token owner\'s identity ID. - * @type {string} - * @memberof PatOwnerV2026 - */ - 'id'?: string; - /** - * Personal access token owner\'s human-readable display name. - * @type {string} - * @memberof PatOwnerV2026 - */ - 'name'?: string; -} - -export const PatOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type PatOwnerV2026TypeV2026 = typeof PatOwnerV2026TypeV2026[keyof typeof PatOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface PeerGroupMemberV2026 - */ -export interface PeerGroupMemberV2026 { - /** - * A unique identifier for the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2026 - */ - 'id'?: string; - /** - * The type of the peer group member. - * @type {string} - * @memberof PeerGroupMemberV2026 - */ - 'type'?: string; - /** - * The ID of the peer group. - * @type {string} - * @memberof PeerGroupMemberV2026 - */ - 'peer_group_id'?: string; - /** - * Arbitrary key-value pairs, belonging to the peer group member. - * @type {{ [key: string]: object; }} - * @memberof PeerGroupMemberV2026 - */ - 'attributes'?: { [key: string]: object; }; -} -/** - * Enum represents action that is being processed on an approval. - * @export - * @enum {string} - */ - -export const PendingApprovalActionV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Forwarded: 'FORWARDED' -} as const; - -export type PendingApprovalActionV2026 = typeof PendingApprovalActionV2026[keyof typeof PendingApprovalActionV2026]; - - -/** - * Access item owner\'s identity. - * @export - * @interface PendingApprovalOwnerV2026 - */ -export interface PendingApprovalOwnerV2026 { - /** - * Access item owner\'s DTO type. - * @type {string} - * @memberof PendingApprovalOwnerV2026 - */ - 'type'?: PendingApprovalOwnerV2026TypeV2026; - /** - * Access item owner\'s identity ID. - * @type {string} - * @memberof PendingApprovalOwnerV2026 - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof PendingApprovalOwnerV2026 - */ - 'name'?: string; -} - -export const PendingApprovalOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type PendingApprovalOwnerV2026TypeV2026 = typeof PendingApprovalOwnerV2026TypeV2026[keyof typeof PendingApprovalOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface PendingApprovalV2026 - */ -export interface PendingApprovalV2026 { - /** - * The approval id. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'id'?: string; - /** - * This is the access request id. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'accessRequestId'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof PendingApprovalV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * - * @type {AccessItemRequesterV2026} - * @memberof PendingApprovalV2026 - */ - 'requester'?: AccessItemRequesterV2026; - /** - * - * @type {AccessItemRequestedForV2026} - * @memberof PendingApprovalV2026 - */ - 'requestedFor'?: AccessItemRequestedForV2026; - /** - * - * @type {PendingApprovalOwnerV2026} - * @memberof PendingApprovalV2026 - */ - 'owner'?: PendingApprovalOwnerV2026; - /** - * - * @type {RequestableObjectReferenceV2026} - * @memberof PendingApprovalV2026 - */ - 'requestedObject'?: RequestableObjectReferenceV2026; - /** - * - * @type {CommentDtoV2026} - * @memberof PendingApprovalV2026 - */ - 'requesterComment'?: CommentDtoV2026; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof PendingApprovalV2026 - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof PendingApprovalV2026 - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof PendingApprovalV2026 - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {PendingApprovalActionV2026} - * @memberof PendingApprovalV2026 - */ - 'actionInProcess'?: PendingApprovalActionV2026; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'removeDate'?: string; - /** - * If true, then the request is to change the remove date or sunset date. - * @type {boolean} - * @memberof PendingApprovalV2026 - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'currentRemoveDate'?: string; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof PendingApprovalV2026 - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompletedV2026} - * @memberof PendingApprovalV2026 - */ - 'sodViolationContext'?: SodViolationContextCheckCompletedV2026 | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof PendingApprovalV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof PendingApprovalV2026 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof PendingApprovalV2026 - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026} - * @memberof PendingApprovalV2026 - */ - 'maxPermittedAccessDuration'?: EntitlementAccessRequestConfigMaxPermittedAccessDurationV2026 | null; -} - - -/** - * - * @export - * @interface PermissionCollectorSettingsV2026 - */ -export interface PermissionCollectorSettingsV2026 { - /** - * Indicates whether the feature or configuration is enabled. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2026 - */ - 'isEnabled'?: boolean; - /** - * The identifier of the cluster associated with this configuration, if applicable. - * @type {string} - * @memberof PermissionCollectorSettingsV2026 - */ - 'clusterId'?: string | null; - /** - * Indicates whether unique permissions should be analyzed for resources. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2026 - */ - 'analyzeUniquePermissions'?: boolean | null; - /** - * Indicates whether effective permissions should be calculated. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2026 - */ - 'calculateEffectivePermissions'?: boolean | null; - /** - * Indicates whether riskiest permissions should be calculated. - * @type {boolean} - * @memberof PermissionCollectorSettingsV2026 - */ - 'calculateRiskiestPermissions'?: boolean | null; - /** - * Source for effective permissions calculation. - * @type {string} - * @memberof PermissionCollectorSettingsV2026 - */ - 'effectivePermissionsSource'?: string | null; -} -/** - * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - * @export - * @interface PermissionDtoV2026 - */ -export interface PermissionDtoV2026 { - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof PermissionDtoV2026 - */ - 'rights'?: Array; - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof PermissionDtoV2026 - */ - 'target'?: string; -} -/** - * Provides additional details about the pre-approval trigger for this request. - * @export - * @interface PreApprovalTriggerDetailsV2026 - */ -export interface PreApprovalTriggerDetailsV2026 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2026 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetailsV2026 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof PreApprovalTriggerDetailsV2026 - */ - 'decision'?: PreApprovalTriggerDetailsV2026DecisionV2026; -} - -export const PreApprovalTriggerDetailsV2026DecisionV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type PreApprovalTriggerDetailsV2026DecisionV2026 = typeof PreApprovalTriggerDetailsV2026DecisionV2026[keyof typeof PreApprovalTriggerDetailsV2026DecisionV2026]; - -/** - * Maps an Identity\'s attribute key to a list of preferred notification mediums. - * @export - * @interface PreferencesDtoV2026 - */ -export interface PreferencesDtoV2026 { - /** - * The template notification key. - * @type {string} - * @memberof PreferencesDtoV2026 - */ - 'key'?: string; - /** - * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - * @type {Array} - * @memberof PreferencesDtoV2026 - */ - 'mediums'?: Array; - /** - * Modified date of preference - * @type {string} - * @memberof PreferencesDtoV2026 - */ - 'modified'?: string; -} -/** - * PreviewDataSourceResponse is the response sent by `/form-definitions/{formDefinitionID}/data-source` endpoint - * @export - * @interface PreviewDataSourceResponseV2026 - */ -export interface PreviewDataSourceResponseV2026 { - /** - * Results holds a list of FormElementDataSourceConfigOptions items - * @type {Array} - * @memberof PreviewDataSourceResponseV2026 - */ - 'results'?: Array; -} -/** - * - * @export - * @interface PrivilegeCriteriaConfigDTOV2026 - */ -export interface PrivilegeCriteriaConfigDTOV2026 { - /** - * The Id of the task which is executing the bulk update. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2026 - */ - 'id'?: string; - /** - * The Id of the source that the criteria configuration is applied to. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2026 - */ - 'sourceId'?: string; - /** - * The configuration settings for privilege criteria evaluation. - * @type {object} - * @memberof PrivilegeCriteriaConfigDTOV2026 - */ - 'config'?: object; - /** - * The date and time when the privilege criteria configuration was created. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2026 - */ - 'created'?: string; - /** - * The date and time when the privilege criteria configuration was last modified. - * @type {string} - * @memberof PrivilegeCriteriaConfigDTOV2026 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ -export interface PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 { - /** - * The target type for the criteria item. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ - 'targetType'?: PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026; - /** - * The operator to apply to the property and values. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ - 'operator'?: PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026OperatorV2026; - /** - * - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ - 'property'?: string; - /** - * The values to evaluate the property against. - * @type {Array} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ - 'values'?: Array; - /** - * Whether to ignore case when evaluating the property against the values. - * @type {boolean} - * @memberof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026 - */ - 'ignoreCase'?: boolean; -} - -export const PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026 = { - Group: 'group' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026 = typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026[keyof typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026TargetTypeV2026]; -export const PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026OperatorV2026 = { - In: 'IN', - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026OperatorV2026 = typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026OperatorV2026[keyof typeof PrivilegeCriteriaDTOGroupsInnerCriteriaItemsInnerV2026OperatorV2026]; - -/** - * - * @export - * @interface PrivilegeCriteriaDTOGroupsInnerV2026 - */ -export interface PrivilegeCriteriaDTOGroupsInnerV2026 { - /** - * The logical operator to apply between criteria items in the group. - * @type {string} - * @memberof PrivilegeCriteriaDTOGroupsInnerV2026 - */ - 'operator'?: PrivilegeCriteriaDTOGroupsInnerV2026OperatorV2026; - /** - * - * @type {Array} - * @memberof PrivilegeCriteriaDTOGroupsInnerV2026 - */ - 'criteriaItems'?: Array; -} - -export const PrivilegeCriteriaDTOGroupsInnerV2026OperatorV2026 = { - And: 'AND', - Or: 'OR' -} as const; - -export type PrivilegeCriteriaDTOGroupsInnerV2026OperatorV2026 = typeof PrivilegeCriteriaDTOGroupsInnerV2026OperatorV2026[keyof typeof PrivilegeCriteriaDTOGroupsInnerV2026OperatorV2026]; - -/** - * - * @export - * @interface PrivilegeCriteriaDTOV2026 - */ -export interface PrivilegeCriteriaDTOV2026 { - /** - * The Id of the criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'id'?: string; - /** - * The Id of the source that the criteria is applied to. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'sourceId'?: string; - /** - * The type of criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'type'?: PrivilegeCriteriaDTOV2026TypeV2026; - /** - * The logical operator to apply between groups. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'operator'?: PrivilegeCriteriaDTOV2026OperatorV2026; - /** - * - * @type {Array} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'groups'?: Array; - /** - * The privilege level assigned by this criteria. - * @type {string} - * @memberof PrivilegeCriteriaDTOV2026 - */ - 'privilegeLevel'?: PrivilegeCriteriaDTOV2026PrivilegeLevelV2026; -} - -export const PrivilegeCriteriaDTOV2026TypeV2026 = { - Custom: 'CUSTOM', - Connector: 'CONNECTOR', - SingleLevel: 'SINGLE_LEVEL' -} as const; - -export type PrivilegeCriteriaDTOV2026TypeV2026 = typeof PrivilegeCriteriaDTOV2026TypeV2026[keyof typeof PrivilegeCriteriaDTOV2026TypeV2026]; -export const PrivilegeCriteriaDTOV2026OperatorV2026 = { - And: 'AND', - Or: 'OR' -} as const; - -export type PrivilegeCriteriaDTOV2026OperatorV2026 = typeof PrivilegeCriteriaDTOV2026OperatorV2026[keyof typeof PrivilegeCriteriaDTOV2026OperatorV2026]; -export const PrivilegeCriteriaDTOV2026PrivilegeLevelV2026 = { - High: 'HIGH', - Medium: 'MEDIUM', - Low: 'LOW' -} as const; - -export type PrivilegeCriteriaDTOV2026PrivilegeLevelV2026 = typeof PrivilegeCriteriaDTOV2026PrivilegeLevelV2026[keyof typeof PrivilegeCriteriaDTOV2026PrivilegeLevelV2026]; - -/** - * A group of entitlement instances that share the same entitlement name and connector type, aggregated for privileged-access review. - * @export - * @interface PrivilegedRecommendationGroupV2026 - */ -export interface PrivilegedRecommendationGroupV2026 { - /** - * The name of the entitlement shared across all instances in this group. - * @type {string} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'entitlementName'?: string; - /** - * The connector type associated with all instances in this group. - * @type {string} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'connectorType'?: string; - /** - * A decimal string representing the confidence score of the privilege recommendation (0.0-1.0). - * @type {string} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'recommendationScore'?: string; - /** - * The number of organizations in which this entitlement appears as privileged. - * @type {number} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'orgCount'?: number; - /** - * The total number of individual entitlement instances in this group. - * @type {number} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'instanceCount'?: number; - /** - * The individual entitlement instances belonging to this group. - * @type {Array} - * @memberof PrivilegedRecommendationGroupV2026 - */ - 'instances'?: Array; -} -/** - * An individual entitlement instance within a privileged recommendation group. - * @export - * @interface PrivilegedRecommendationInstanceV2026 - */ -export interface PrivilegedRecommendationInstanceV2026 { - /** - * The unique identifier for this entitlement instance. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'id'?: string; - /** - * The entitlement attribute name. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'attribute'?: string; - /** - * The ID of the source that owns this entitlement. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'sourceId'?: string; - /** - * The display name of the source. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'sourceName'?: string; - /** - * The entitlement type. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'type'?: string; - /** - * The entitlement value or distinguished name. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'value'?: string; - /** - * The current review status of this instance. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'status'?: string; - /** - * The currently assigned privilege level, if any. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'privilegeLevel'?: string | null; - /** - * The current description of the entitlement, if one exists. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'description'?: string | null; - /** - * The timestamp when this instance was recommended. - * @type {string} - * @memberof PrivilegedRecommendationInstanceV2026 - */ - 'recommendedAt'?: string; -} -/** - * - * @export - * @interface ProcessIdentitiesRequestV2026 - */ -export interface ProcessIdentitiesRequestV2026 { - /** - * List of up to 250 identity IDs to process. - * @type {Array} - * @memberof ProcessIdentitiesRequestV2026 - */ - 'identityIds'?: Array; -} -/** - * - * @export - * @interface ProcessingDetailsV2026 - */ -export interface ProcessingDetailsV2026 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ProcessingDetailsV2026 - */ - 'date'?: string | null; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2026 - */ - 'stage'?: string; - /** - * - * @type {number} - * @memberof ProcessingDetailsV2026 - */ - 'retryCount'?: number; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2026 - */ - 'stackTrace'?: string; - /** - * - * @type {string} - * @memberof ProcessingDetailsV2026 - */ - 'message'?: string; -} -/** - * - * @export - * @interface ProductV2026 - */ -export interface ProductV2026 { - /** - * Name of the Product - * @type {string} - * @memberof ProductV2026 - */ - 'productName'?: string; - /** - * URL of the Product - * @type {string} - * @memberof ProductV2026 - */ - 'url'?: string; - /** - * An identifier for a specific product-tenant combination - * @type {string} - * @memberof ProductV2026 - */ - 'productTenantId'?: string; - /** - * Product region - * @type {string} - * @memberof ProductV2026 - */ - 'productRegion'?: string; - /** - * Right needed for the Product - * @type {string} - * @memberof ProductV2026 - */ - 'productRight'?: string; - /** - * API URL of the Product - * @type {string} - * @memberof ProductV2026 - */ - 'apiUrl'?: string | null; - /** - * - * @type {Array} - * @memberof ProductV2026 - */ - 'licenses'?: Array; - /** - * Additional attributes for a product - * @type {{ [key: string]: any; }} - * @memberof ProductV2026 - */ - 'attributes'?: { [key: string]: any; }; - /** - * Zone - * @type {string} - * @memberof ProductV2026 - */ - 'zone'?: string; - /** - * Status of the product - * @type {string} - * @memberof ProductV2026 - */ - 'status'?: string; - /** - * Status datetime - * @type {string} - * @memberof ProductV2026 - */ - 'statusDateTime'?: string; - /** - * If there\'s a tenant provisioning failure then reason will have the description of error - * @type {string} - * @memberof ProductV2026 - */ - 'reason'?: string; - /** - * Product could have additional notes added during tenant provisioning. - * @type {string} - * @memberof ProductV2026 - */ - 'notes'?: string; - /** - * Date when the product was created - * @type {string} - * @memberof ProductV2026 - */ - 'dateCreated'?: string | null; - /** - * Date when the product was last updated - * @type {string} - * @memberof ProductV2026 - */ - 'lastUpdated'?: string | null; - /** - * Type of org - * @type {string} - * @memberof ProductV2026 - */ - 'orgType'?: ProductV2026OrgTypeV2026 | null; -} - -export const ProductV2026OrgTypeV2026 = { - Development: 'development', - Staging: 'staging', - Production: 'production', - Test: 'test', - Partner: 'partner', - Training: 'training', - Demonstration: 'demonstration', - Sandbox: 'sandbox' -} as const; - -export type ProductV2026OrgTypeV2026 = typeof ProductV2026OrgTypeV2026[keyof typeof ProductV2026OrgTypeV2026]; - -/** - * A prompt security insight event. - * @export - * @interface PromptInsightV2026 - */ -export interface PromptInsightV2026 { - /** - * Event time in UTC. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'timestamp'?: string; - /** - * User identifier or display name. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'user'?: string; - /** - * The AI agent that processed the prompt. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'agent'?: string; - /** - * The policy decision applied to the prompt. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'policyDecision'?: PromptInsightV2026PolicyDecisionV2026; - /** - * The category of the prompt security finding. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'category'?: PromptInsightV2026CategoryV2026; - /** - * The severity of the prompt security finding. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'severity'?: PromptInsightV2026SeverityV2026; - /** - * Human-readable or structured reason for the policy decision. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'reason'?: string; - /** - * The rule that matched the prompt. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'rule'?: string; - /** - * The policy that matched the prompt. - * @type {string} - * @memberof PromptInsightV2026 - */ - 'policy'?: string; -} - -export const PromptInsightV2026PolicyDecisionV2026 = { - Allowed: 'ALLOWED', - Redacted: 'REDACTED' -} as const; - -export type PromptInsightV2026PolicyDecisionV2026 = typeof PromptInsightV2026PolicyDecisionV2026[keyof typeof PromptInsightV2026PolicyDecisionV2026]; -export const PromptInsightV2026CategoryV2026 = { - Anomalies: 'ANOMALIES', - DataUploads: 'DATA_UPLOADS', - McpToolCalls: 'MCP_TOOL_CALLS' -} as const; - -export type PromptInsightV2026CategoryV2026 = typeof PromptInsightV2026CategoryV2026[keyof typeof PromptInsightV2026CategoryV2026]; -export const PromptInsightV2026SeverityV2026 = { - Low: 'LOW', - Medium: 'MEDIUM', - High: 'HIGH', - Critical: 'CRITICAL' -} as const; - -export type PromptInsightV2026SeverityV2026 = typeof PromptInsightV2026SeverityV2026[keyof typeof PromptInsightV2026SeverityV2026]; - -/** - * Aggregate prompt insights metrics for the requested time window. - * @export - * @interface PromptInsightsMetricsV2026 - */ -export interface PromptInsightsMetricsV2026 { - /** - * Count of prompts scanned in the interval. - * @type {number} - * @memberof PromptInsightsMetricsV2026 - */ - 'promptsScanned'?: number; - /** - * Count of prompts redacted in the interval. - * @type {number} - * @memberof PromptInsightsMetricsV2026 - */ - 'promptsRedacted'?: number; -} -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026 - */ -export interface ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026 { - /** - * The name of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026 - */ - 'attributeName': string; - /** - * The value of the attribute being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026 - */ - 'attributeValue'?: string | null; - /** - * The operation to handle the attribute. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026 - */ - 'operation': ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026OperationV2026; -} - -export const ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026OperationV2026 = { - Add: 'Add', - Set: 'Set', - Remove: 'Remove' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026OperationV2026 = typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026OperationV2026[keyof typeof ProvisioningCompletedAccountRequestsInnerAttributeRequestsInnerV2026OperationV2026]; - -/** - * Reference to the source being provisioned against. - * @export - * @interface ProvisioningCompletedAccountRequestsInnerSourceV2026 - */ -export interface ProvisioningCompletedAccountRequestsInnerSourceV2026 { - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2026 - */ - 'id': string; - /** - * The type of object that is referenced - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2026 - */ - 'type': ProvisioningCompletedAccountRequestsInnerSourceV2026TypeV2026; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerSourceV2026 - */ - 'name': string; -} - -export const ProvisioningCompletedAccountRequestsInnerSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerSourceV2026TypeV2026 = typeof ProvisioningCompletedAccountRequestsInnerSourceV2026TypeV2026[keyof typeof ProvisioningCompletedAccountRequestsInnerSourceV2026TypeV2026]; - -/** - * - * @export - * @interface ProvisioningCompletedAccountRequestsInnerV2026 - */ -export interface ProvisioningCompletedAccountRequestsInnerV2026 { - /** - * - * @type {ProvisioningCompletedAccountRequestsInnerSourceV2026} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'source': ProvisioningCompletedAccountRequestsInnerSourceV2026; - /** - * The unique idenfier of the account being provisioned. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'accountId'?: string; - /** - * The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'accountOperation': string; - /** - * The overall result of the provisioning transaction; this could be success, pending, failed, etc. - * @type {object} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'provisioningResult': ProvisioningCompletedAccountRequestsInnerV2026ProvisioningResultV2026; - /** - * The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'provisioningTarget': string; - /** - * A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). - * @type {string} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'ticketId'?: string | null; - /** - * A list of attributes as part of the provisioning transaction. - * @type {Array} - * @memberof ProvisioningCompletedAccountRequestsInnerV2026 - */ - 'attributeRequests'?: Array | null; -} - -export const ProvisioningCompletedAccountRequestsInnerV2026ProvisioningResultV2026 = { - Success: 'SUCCESS', - Pending: 'PENDING', - Failed: 'FAILED' -} as const; - -export type ProvisioningCompletedAccountRequestsInnerV2026ProvisioningResultV2026 = typeof ProvisioningCompletedAccountRequestsInnerV2026ProvisioningResultV2026[keyof typeof ProvisioningCompletedAccountRequestsInnerV2026ProvisioningResultV2026]; - -/** - * Provisioning recpient. - * @export - * @interface ProvisioningCompletedRecipientV2026 - */ -export interface ProvisioningCompletedRecipientV2026 { - /** - * Provisioning recipient DTO type. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2026 - */ - 'type': ProvisioningCompletedRecipientV2026TypeV2026; - /** - * Provisioning recipient\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2026 - */ - 'id': string; - /** - * Provisioning recipient\'s display name. - * @type {string} - * @memberof ProvisioningCompletedRecipientV2026 - */ - 'name': string; -} - -export const ProvisioningCompletedRecipientV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRecipientV2026TypeV2026 = typeof ProvisioningCompletedRecipientV2026TypeV2026[keyof typeof ProvisioningCompletedRecipientV2026TypeV2026]; - -/** - * Provisioning requester\'s identity. - * @export - * @interface ProvisioningCompletedRequesterV2026 - */ -export interface ProvisioningCompletedRequesterV2026 { - /** - * Provisioning requester\'s DTO type. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2026 - */ - 'type': ProvisioningCompletedRequesterV2026TypeV2026; - /** - * Provisioning requester\'s identity ID. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2026 - */ - 'id': string; - /** - * Provisioning owner\'s human-readable display name. - * @type {string} - * @memberof ProvisioningCompletedRequesterV2026 - */ - 'name': string; -} - -export const ProvisioningCompletedRequesterV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ProvisioningCompletedRequesterV2026TypeV2026 = typeof ProvisioningCompletedRequesterV2026TypeV2026[keyof typeof ProvisioningCompletedRequesterV2026TypeV2026]; - -/** - * - * @export - * @interface ProvisioningCompletedV2026 - */ -export interface ProvisioningCompletedV2026 { - /** - * The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. - * @type {string} - * @memberof ProvisioningCompletedV2026 - */ - 'trackingNumber': string; - /** - * One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. - * @type {string} - * @memberof ProvisioningCompletedV2026 - */ - 'sources': string; - /** - * Origin of where the provisioning request came from. - * @type {string} - * @memberof ProvisioningCompletedV2026 - */ - 'action'?: string | null; - /** - * A list of any accumulated error messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2026 - */ - 'errors'?: Array | null; - /** - * A list of any accumulated warning messages that occurred during provisioning. - * @type {Array} - * @memberof ProvisioningCompletedV2026 - */ - 'warnings'?: Array | null; - /** - * - * @type {ProvisioningCompletedRecipientV2026} - * @memberof ProvisioningCompletedV2026 - */ - 'recipient': ProvisioningCompletedRecipientV2026; - /** - * - * @type {ProvisioningCompletedRequesterV2026} - * @memberof ProvisioningCompletedV2026 - */ - 'requester'?: ProvisioningCompletedRequesterV2026 | null; - /** - * A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. - * @type {Array} - * @memberof ProvisioningCompletedV2026 - */ - 'accountRequests': Array; -} -/** - * This is a reference to a plan initializer script. - * @export - * @interface ProvisioningConfigPlanInitializerScriptV2026 - */ -export interface ProvisioningConfigPlanInitializerScriptV2026 { - /** - * This is a Rule that allows provisioning instruction changes. - * @type {string} - * @memberof ProvisioningConfigPlanInitializerScriptV2026 - */ - 'source'?: string; -} -/** - * Specification of a Service Desk integration provisioning configuration. - * @export - * @interface ProvisioningConfigV2026 - */ -export interface ProvisioningConfigV2026 { - /** - * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - * @type {boolean} - * @memberof ProvisioningConfigV2026 - */ - 'universalManager'?: boolean; - /** - * References to sources for the Service Desk integration template. May only be specified if universalManager is false. - * @type {Array} - * @memberof ProvisioningConfigV2026 - */ - 'managedResourceRefs'?: Array; - /** - * - * @type {ProvisioningConfigPlanInitializerScriptV2026} - * @memberof ProvisioningConfigV2026 - */ - 'planInitializerScript'?: ProvisioningConfigPlanInitializerScriptV2026 | null; - /** - * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - * @type {boolean} - * @memberof ProvisioningConfigV2026 - */ - 'noProvisioningRequests'?: boolean; - /** - * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - * @type {number} - * @memberof ProvisioningConfigV2026 - */ - 'provisioningRequestExpiration'?: number; -} -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel1V2026 - */ -export interface ProvisioningCriteriaLevel1V2026 { - /** - * - * @type {ProvisioningCriteriaOperationV2026} - * @memberof ProvisioningCriteriaLevel1V2026 - */ - 'operation'?: ProvisioningCriteriaOperationV2026; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2026 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel1V2026 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel1V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel2V2026 - */ -export interface ProvisioningCriteriaLevel2V2026 { - /** - * - * @type {ProvisioningCriteriaOperationV2026} - * @memberof ProvisioningCriteriaLevel2V2026 - */ - 'operation'?: ProvisioningCriteriaOperationV2026; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2026 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel2V2026 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel2V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel3V2026 - */ -export interface ProvisioningCriteriaLevel3V2026 { - /** - * - * @type {ProvisioningCriteriaOperationV2026} - * @memberof ProvisioningCriteriaLevel3V2026 - */ - 'operation'?: ProvisioningCriteriaOperationV2026; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2026 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2026 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {string} - * @memberof ProvisioningCriteriaLevel3V2026 - */ - 'children'?: string | null; -} - - -/** - * Supported operations on `ProvisioningCriteria`. - * @export - * @enum {string} - */ - -export const ProvisioningCriteriaOperationV2026 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - Has: 'HAS', - And: 'AND', - Or: 'OR' -} as const; - -export type ProvisioningCriteriaOperationV2026 = typeof ProvisioningCriteriaOperationV2026[keyof typeof ProvisioningCriteriaOperationV2026]; - - -/** - * Provides additional details about provisioning for this request. - * @export - * @interface ProvisioningDetailsV2026 - */ -export interface ProvisioningDetailsV2026 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof ProvisioningDetailsV2026 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * - * @export - * @interface ProvisioningPolicyDtoV2026 - */ -export interface ProvisioningPolicyDtoV2026 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyDtoV2026 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyDtoV2026 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2026} - * @memberof ProvisioningPolicyDtoV2026 - */ - 'usageType'?: UsageTypeV2026; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyDtoV2026 - */ - 'fields'?: Array; -} - - -/** - * - * @export - * @interface ProvisioningPolicyV2026 - */ -export interface ProvisioningPolicyV2026 { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyV2026 - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyV2026 - */ - 'description'?: string; - /** - * - * @type {UsageTypeV2026} - * @memberof ProvisioningPolicyV2026 - */ - 'usageType'?: UsageTypeV2026; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyV2026 - */ - 'fields'?: Array; -} - - -/** - * Provisioning state of an account activity item - * @export - * @enum {string} - */ - -export const ProvisioningStateV2026 = { - Pending: 'PENDING', - Finished: 'FINISHED', - Unverifiable: 'UNVERIFIABLE', - Commited: 'COMMITED', - Failed: 'FAILED', - Retry: 'RETRY' -} as const; - -export type ProvisioningStateV2026 = typeof ProvisioningStateV2026[keyof typeof ProvisioningStateV2026]; - - -/** - * Used to map an attribute key for an Identity to its display name. - * @export - * @interface PublicIdentityAttributeConfigV2026 - */ -export interface PublicIdentityAttributeConfigV2026 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributeConfigV2026 - */ - 'key'?: string; - /** - * The attribute display name - * @type {string} - * @memberof PublicIdentityAttributeConfigV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface PublicIdentityAttributesInnerV2026 - */ -export interface PublicIdentityAttributesInnerV2026 { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributesInnerV2026 - */ - 'key'?: string; - /** - * Human-readable display name of the attribute - * @type {string} - * @memberof PublicIdentityAttributesInnerV2026 - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof PublicIdentityAttributesInnerV2026 - */ - 'value'?: string | null; -} -/** - * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - * @export - * @interface PublicIdentityConfigV2026 - */ -export interface PublicIdentityConfigV2026 { - /** - * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - * @type {Array} - * @memberof PublicIdentityConfigV2026 - */ - 'attributes'?: Array; - /** - * When this configuration was last modified. - * @type {string} - * @memberof PublicIdentityConfigV2026 - */ - 'modified'?: string | null; - /** - * - * @type {IdentityReferenceV2026} - * @memberof PublicIdentityConfigV2026 - */ - 'modifiedBy'?: IdentityReferenceV2026 | null; -} -/** - * Details about a public identity - * @export - * @interface PublicIdentityV2026 - */ -export interface PublicIdentityV2026 { - /** - * Identity id - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'name'?: string; - /** - * Alternate unique identifier for the identity. - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'alias'?: string; - /** - * Email address of identity. - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'email'?: string | null; - /** - * The lifecycle status for the identity - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'status'?: string | null; - /** - * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. - * @type {string} - * @memberof PublicIdentityV2026 - */ - 'identityState'?: PublicIdentityV2026IdentityStateV2026 | null; - /** - * - * @type {IdentityReferenceV2026} - * @memberof PublicIdentityV2026 - */ - 'manager'?: IdentityReferenceV2026 | null; - /** - * The public identity attributes of the identity - * @type {Array} - * @memberof PublicIdentityV2026 - */ - 'attributes'?: Array; -} - -export const PublicIdentityV2026IdentityStateV2026 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type PublicIdentityV2026IdentityStateV2026 = typeof PublicIdentityV2026IdentityStateV2026[keyof typeof PublicIdentityV2026IdentityStateV2026]; - -/** - * @type PutClientLogConfigurationRequestV2026 - * @export - */ -export type PutClientLogConfigurationRequestV2026 = ClientLogConfigurationDurationMinutesV2026 | ClientLogConfigurationExpirationV2026; - -/** - * - * @export - * @interface PutConnectorCorrelationConfigRequestV2026 - */ -export interface PutConnectorCorrelationConfigRequestV2026 { - /** - * connector correlation config xml file - * @type {File} - * @memberof PutConnectorCorrelationConfigRequestV2026 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceConfigRequestV2026 - */ -export interface PutConnectorSourceConfigRequestV2026 { - /** - * connector source config xml file - * @type {File} - * @memberof PutConnectorSourceConfigRequestV2026 - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceTemplateRequestV2026 - */ -export interface PutConnectorSourceTemplateRequestV2026 { - /** - * connector source template xml file - * @type {File} - * @memberof PutConnectorSourceTemplateRequestV2026 - */ - 'file': File; -} -/** - * - * @export - * @interface PutPasswordDictionaryRequestV2026 - */ -export interface PutPasswordDictionaryRequestV2026 { - /** - * - * @type {File} - * @memberof PutPasswordDictionaryRequestV2026 - */ - 'file'?: File; -} -/** - * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - * @export - * @interface QueryResultFilterV2026 - */ -export interface QueryResultFilterV2026 { - /** - * The list of field names to include in the result documents. - * @type {Array} - * @memberof QueryResultFilterV2026 - */ - 'includes'?: Array; - /** - * The list of field names to exclude from the result documents. - * @type {Array} - * @memberof QueryResultFilterV2026 - */ - 'excludes'?: Array; -} -/** - * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const QueryTypeV2026 = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT', - Text: 'TEXT', - Typeahead: 'TYPEAHEAD' -} as const; - -export type QueryTypeV2026 = typeof QueryTypeV2026[keyof typeof QueryTypeV2026]; - - -/** - * Query parameters used to construct an Elasticsearch query object. - * @export - * @interface QueryV2026 - */ -export interface QueryV2026 { - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof QueryV2026 - */ - 'query'?: string; - /** - * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. - * @type {string} - * @memberof QueryV2026 - */ - 'fields'?: string; - /** - * The time zone to be applied to any range query related to dates. - * @type {string} - * @memberof QueryV2026 - */ - 'timeZone'?: string; - /** - * - * @type {InnerHitV2026} - * @memberof QueryV2026 - */ - 'innerHit'?: InnerHitV2026; -} -/** - * Configuration of maximum number of days and interval for checking Service Desk integration queue status. - * @export - * @interface QueuedCheckConfigDetailsV2026 - */ -export interface QueuedCheckConfigDetailsV2026 { - /** - * Interval in minutes between status checks - * @type {string} - * @memberof QueuedCheckConfigDetailsV2026 - */ - 'provisioningStatusCheckIntervalMinutes': string; - /** - * Maximum number of days to check - * @type {string} - * @memberof QueuedCheckConfigDetailsV2026 - */ - 'provisioningMaxStatusCheckDays': string; -} -/** - * - * @export - * @interface RandomAlphaNumericV2026 - */ -export interface RandomAlphaNumericV2026 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomAlphaNumericV2026 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomAlphaNumericV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomAlphaNumericV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RandomNumericV2026 - */ -export interface RandomNumericV2026 { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomNumericV2026 - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomNumericV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomNumericV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The range of values to be filtered. - * @export - * @interface RangeV2026 - */ -export interface RangeV2026 { - /** - * - * @type {BoundV2026} - * @memberof RangeV2026 - */ - 'lower'?: BoundV2026; - /** - * - * @type {BoundV2026} - * @memberof RangeV2026 - */ - 'upper'?: BoundV2026; -} -/** - * - * @export - * @interface ReassignReferenceV2026 - */ -export interface ReassignReferenceV2026 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2026 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignReferenceV2026 - */ - 'type': ReassignReferenceV2026TypeV2026; -} - -export const ReassignReferenceV2026TypeV2026 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignReferenceV2026TypeV2026 = typeof ReassignReferenceV2026TypeV2026[keyof typeof ReassignReferenceV2026TypeV2026]; - -/** - * - * @export - * @interface ReassignmentReferenceV2026 - */ -export interface ReassignmentReferenceV2026 { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2026 - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReferenceV2026 - */ - 'type': ReassignmentReferenceV2026TypeV2026; -} - -export const ReassignmentReferenceV2026TypeV2026 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignmentReferenceV2026TypeV2026 = typeof ReassignmentReferenceV2026TypeV2026[keyof typeof ReassignmentReferenceV2026TypeV2026]; - -/** - * - * @export - * @interface ReassignmentTrailDTOV2026 - */ -export interface ReassignmentTrailDTOV2026 { - /** - * The ID of previous owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2026 - */ - 'previousOwner'?: string; - /** - * The ID of new owner identity. - * @type {string} - * @memberof ReassignmentTrailDTOV2026 - */ - 'newOwner'?: string; - /** - * The type of reassignment. - * @type {string} - * @memberof ReassignmentTrailDTOV2026 - */ - 'reassignmentType'?: string; -} -/** - * Enum list containing types of Reassignment that can be found in the evaluate response. - * @export - * @enum {string} - */ - -export const ReassignmentTypeEnumV2026 = { - ManualReassignment: 'MANUAL_REASSIGNMENT,', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT,', - AutoEscalation: 'AUTO_ESCALATION,', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeEnumV2026 = typeof ReassignmentTypeEnumV2026[keyof typeof ReassignmentTypeEnumV2026]; - - -/** - * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - * @export - * @enum {string} - */ - -export const ReassignmentTypeV2026 = { - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', - AutoEscalation: 'AUTO_ESCALATION', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentTypeV2026 = typeof ReassignmentTypeV2026[keyof typeof ReassignmentTypeV2026]; - - -/** - * - * @export - * @interface ReassignmentV2026 - */ -export interface ReassignmentV2026 { - /** - * - * @type {CertificationReferenceV2026} - * @memberof ReassignmentV2026 - */ - 'from'?: CertificationReferenceV2026; - /** - * The comment entered when the Certification was reassigned - * @type {string} - * @memberof ReassignmentV2026 - */ - 'comment'?: string; -} -/** - * - * @export - * @interface RecommendationConfigDtoV2026 - */ -export interface RecommendationConfigDtoV2026 { - /** - * List of identity attributes to use for calculating certification recommendations - * @type {Array} - * @memberof RecommendationConfigDtoV2026 - */ - 'recommenderFeatures'?: Array; - /** - * The percent value that the recommendation calculation must surpass to produce a YES recommendation - * @type {number} - * @memberof RecommendationConfigDtoV2026 - */ - 'peerGroupPercentageThreshold'?: number; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2026 - */ - 'runAutoSelectOnce'?: boolean; - /** - * If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run - * @type {boolean} - * @memberof RecommendationConfigDtoV2026 - */ - 'onlyTuneThreshold'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestDtoV2026 - */ -export interface RecommendationRequestDtoV2026 { - /** - * - * @type {Array} - * @memberof RecommendationRequestDtoV2026 - */ - 'requests'?: Array; - /** - * Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. - * @type {boolean} - * @memberof RecommendationRequestDtoV2026 - */ - 'excludeInterpretations'?: boolean; - /** - * When set to true, the calling system uses the translated messages for the specified language - * @type {boolean} - * @memberof RecommendationRequestDtoV2026 - */ - 'includeTranslationMessages'?: boolean; - /** - * Returns the recommender calculations if set to true - * @type {boolean} - * @memberof RecommendationRequestDtoV2026 - */ - 'includeDebugInformation'?: boolean; - /** - * When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. - * @type {boolean} - * @memberof RecommendationRequestDtoV2026 - */ - 'prescribeMode'?: boolean; -} -/** - * - * @export - * @interface RecommendationRequestV2026 - */ -export interface RecommendationRequestV2026 { - /** - * The identity ID - * @type {string} - * @memberof RecommendationRequestV2026 - */ - 'identityId'?: string; - /** - * - * @type {AccessItemRefV2026} - * @memberof RecommendationRequestV2026 - */ - 'item'?: AccessItemRefV2026; -} -/** - * - * @export - * @interface RecommendationResponseDtoV2026 - */ -export interface RecommendationResponseDtoV2026 { - /** - * - * @type {Array} - * @memberof RecommendationResponseDtoV2026 - */ - 'response'?: Array; -} -/** - * - * @export - * @interface RecommendationResponseV2026 - */ -export interface RecommendationResponseV2026 { - /** - * - * @type {RecommendationRequestV2026} - * @memberof RecommendationResponseV2026 - */ - 'request'?: RecommendationRequestV2026; - /** - * The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system - * @type {string} - * @memberof RecommendationResponseV2026 - */ - 'recommendation'?: RecommendationResponseV2026RecommendationV2026; - /** - * The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. - * @type {Array} - * @memberof RecommendationResponseV2026 - */ - 'interpretations'?: Array; - /** - * The list of translation messages, if they have been requested. - * @type {Array} - * @memberof RecommendationResponseV2026 - */ - 'translationMessages'?: Array; - /** - * - * @type {RecommenderCalculationsV2026} - * @memberof RecommendationResponseV2026 - */ - 'recommenderCalculations'?: RecommenderCalculationsV2026; -} - -export const RecommendationResponseV2026RecommendationV2026 = { - True: 'true', - False: 'false', - Maybe: 'MAYBE', - NotFound: 'NOT_FOUND' -} as const; - -export type RecommendationResponseV2026RecommendationV2026 = typeof RecommendationResponseV2026RecommendationV2026[keyof typeof RecommendationResponseV2026RecommendationV2026]; - -/** - * - * @export - * @interface RecommendationV2026 - */ -export interface RecommendationV2026 { - /** - * Recommended type of account. - * @type {string} - * @memberof RecommendationV2026 - */ - 'type': RecommendationV2026TypeV2026; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof RecommendationV2026 - */ - 'method': RecommendationV2026MethodV2026; -} - -export const RecommendationV2026TypeV2026 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type RecommendationV2026TypeV2026 = typeof RecommendationV2026TypeV2026[keyof typeof RecommendationV2026TypeV2026]; -export const RecommendationV2026MethodV2026 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type RecommendationV2026MethodV2026 = typeof RecommendationV2026MethodV2026[keyof typeof RecommendationV2026MethodV2026]; - -/** - * - * @export - * @interface RecommenderCalculationsIdentityAttributesValueV2026 - */ -export interface RecommenderCalculationsIdentityAttributesValueV2026 { - /** - * - * @type {string} - * @memberof RecommenderCalculationsIdentityAttributesValueV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RecommenderCalculationsV2026 - */ -export interface RecommenderCalculationsV2026 { - /** - * The ID of the identity - * @type {string} - * @memberof RecommenderCalculationsV2026 - */ - 'identityId'?: string; - /** - * The entitlement ID - * @type {string} - * @memberof RecommenderCalculationsV2026 - */ - 'entitlementId'?: string; - /** - * The actual recommendation - * @type {string} - * @memberof RecommenderCalculationsV2026 - */ - 'recommendation'?: string; - /** - * The overall weighted score - * @type {number} - * @memberof RecommenderCalculationsV2026 - */ - 'overallWeightedScore'?: number; - /** - * The weighted score of each individual feature - * @type {{ [key: string]: number; }} - * @memberof RecommenderCalculationsV2026 - */ - 'featureWeightedScores'?: { [key: string]: number; }; - /** - * The configured value against which the overallWeightedScore is compared - * @type {number} - * @memberof RecommenderCalculationsV2026 - */ - 'threshold'?: number; - /** - * The values for your configured features - * @type {{ [key: string]: RecommenderCalculationsIdentityAttributesValueV2026; }} - * @memberof RecommenderCalculationsV2026 - */ - 'identityAttributes'?: { [key: string]: RecommenderCalculationsIdentityAttributesValueV2026; }; - /** - * - * @type {FeatureValueDtoV2026} - * @memberof RecommenderCalculationsV2026 - */ - 'featureValues'?: FeatureValueDtoV2026; -} -/** - * - * @export - * @interface ReelectRequestV2026 - */ -export interface ReelectRequestV2026 { - /** - * The UUID of the identity proposed to be re-elected as the resource owner. - * @type {string} - * @memberof ReelectRequestV2026 - */ - 'ownerId'?: string; - /** - * The name of the campaign or election process for re-electing the owner. - * @type {string} - * @memberof ReelectRequestV2026 - */ - 'campaignName'?: string | null; - /** - * A list of UUIDs representing the identities of reviewers participating in the re-election process. - * @type {Array} - * @memberof ReelectRequestV2026 - */ - 'reviewers'?: Array | null; -} -/** - * - * @export - * @interface RefV2026 - */ -export interface RefV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof RefV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RefV2026 - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface Reference1V2026 - */ -export interface Reference1V2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof Reference1V2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof Reference1V2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface ReferenceV2026 - */ -export interface ReferenceV2026 { - /** - * This ID specifies the name of the pre-existing transform which you want to use within your current transform - * @type {string} - * @memberof ReferenceV2026 - */ - 'id': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReferenceV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReferenceV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RemediationItemDetailsV2026 - */ -export interface RemediationItemDetailsV2026 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemDetailsV2026 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface RemediationItemsV2026 - */ -export interface RemediationItemsV2026 { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemsV2026 - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface ReplaceAllV2026 - */ -export interface ReplaceAllV2026 { - /** - * An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2026 - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceAllV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAllV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReplaceStreamConfigurationRequestDeliveryV2026 - */ -export interface ReplaceStreamConfigurationRequestDeliveryV2026 { - /** - * Delivery method (only push is supported). - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2026 - */ - 'method': string; - /** - * Receiver endpoint URL for push delivery. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2026 - */ - 'endpoint_url': string; - /** - * Authorization header value for delivery requests. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestDeliveryV2026 - */ - 'authorization_header'?: string; -} -/** - * Request body for PUT /ssf/streams (full replace). - * @export - * @interface ReplaceStreamConfigurationRequestV2026 - */ -export interface ReplaceStreamConfigurationRequestV2026 { - /** - * ID of the stream to replace. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestV2026 - */ - 'stream_id': string; - /** - * - * @type {ReplaceStreamConfigurationRequestDeliveryV2026} - * @memberof ReplaceStreamConfigurationRequestV2026 - */ - 'delivery': ReplaceStreamConfigurationRequestDeliveryV2026; - /** - * Event types the receiver wants. Use CAEP event-type URIs. - * @type {Array} - * @memberof ReplaceStreamConfigurationRequestV2026 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof ReplaceStreamConfigurationRequestV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface ReplaceV2026 - */ -export interface ReplaceV2026 { - /** - * This can be a string or a regex pattern in which you want to replace. - * @type {string} - * @memberof ReplaceV2026 - */ - 'regex': string; - /** - * This is the replacement string that should be substituded wherever the string or pattern is found. - * @type {string} - * @memberof ReplaceV2026 - */ - 'replacement': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReportConfigDTOV2026 - */ -export interface ReportConfigDTOV2026 { - /** - * Name of column in report - * @type {string} - * @memberof ReportConfigDTOV2026 - */ - 'columnName'?: string; - /** - * If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. - * @type {boolean} - * @memberof ReportConfigDTOV2026 - */ - 'required'?: boolean; - /** - * If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. - * @type {boolean} - * @memberof ReportConfigDTOV2026 - */ - 'included'?: boolean; - /** - * Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. - * @type {number} - * @memberof ReportConfigDTOV2026 - */ - 'order'?: number; -} -/** - * The string-object map(dictionary) with the arguments needed for report processing. - * @export - * @interface ReportDetailsArgumentsV2026 - */ -export interface ReportDetailsArgumentsV2026 { - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2026 - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof ReportDetailsArgumentsV2026 - */ - 'sourceName': string; - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof ReportDetailsArgumentsV2026 - */ - 'correlatedOnly': boolean; - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArgumentsV2026 - */ - 'authoritativeSource': string; - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportDetailsArgumentsV2026 - */ - 'selectedFormats'?: Array; - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof ReportDetailsArgumentsV2026 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof ReportDetailsArgumentsV2026 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof ReportDetailsArgumentsV2026 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof ReportDetailsArgumentsV2026 - */ - 'sort'?: Array; -} - -export const ReportDetailsArgumentsV2026SelectedFormatsV2026 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportDetailsArgumentsV2026SelectedFormatsV2026 = typeof ReportDetailsArgumentsV2026SelectedFormatsV2026[keyof typeof ReportDetailsArgumentsV2026SelectedFormatsV2026]; - -/** - * Details about report to be processed. - * @export - * @interface ReportDetailsV2026 - */ -export interface ReportDetailsV2026 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportDetailsV2026 - */ - 'reportType'?: ReportDetailsV2026ReportTypeV2026; - /** - * - * @type {ReportDetailsArgumentsV2026} - * @memberof ReportDetailsV2026 - */ - 'arguments'?: ReportDetailsArgumentsV2026; -} - -export const ReportDetailsV2026ReportTypeV2026 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportDetailsV2026ReportTypeV2026 = typeof ReportDetailsV2026ReportTypeV2026[keyof typeof ReportDetailsV2026ReportTypeV2026]; - -/** - * - * @export - * @interface ReportResultReferenceV2026 - */ -export interface ReportResultReferenceV2026 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof ReportResultReferenceV2026 - */ - 'type'?: ReportResultReferenceV2026TypeV2026; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof ReportResultReferenceV2026 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof ReportResultReferenceV2026 - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof ReportResultReferenceV2026 - */ - 'status'?: ReportResultReferenceV2026StatusV2026; -} - -export const ReportResultReferenceV2026TypeV2026 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type ReportResultReferenceV2026TypeV2026 = typeof ReportResultReferenceV2026TypeV2026[keyof typeof ReportResultReferenceV2026TypeV2026]; -export const ReportResultReferenceV2026StatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type ReportResultReferenceV2026StatusV2026 = typeof ReportResultReferenceV2026StatusV2026[keyof typeof ReportResultReferenceV2026StatusV2026]; - -/** - * Details about report result or current state. - * @export - * @interface ReportResultsV2026 - */ -export interface ReportResultsV2026 { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportResultsV2026 - */ - 'reportType'?: ReportResultsV2026ReportTypeV2026; - /** - * Name of the task definition which is started to process requesting report. Usually the same as report name - * @type {string} - * @memberof ReportResultsV2026 - */ - 'taskDefName'?: string; - /** - * Unique task definition identifier. - * @type {string} - * @memberof ReportResultsV2026 - */ - 'id'?: string; - /** - * Report processing start date - * @type {string} - * @memberof ReportResultsV2026 - */ - 'created'?: string; - /** - * Report current state or result status. - * @type {string} - * @memberof ReportResultsV2026 - */ - 'status'?: ReportResultsV2026StatusV2026; - /** - * Report processing time in ms. - * @type {number} - * @memberof ReportResultsV2026 - */ - 'duration'?: number; - /** - * Report size in rows. - * @type {number} - * @memberof ReportResultsV2026 - */ - 'rows'?: number; - /** - * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportResultsV2026 - */ - 'availableFormats'?: Array; -} - -export const ReportResultsV2026ReportTypeV2026 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportResultsV2026ReportTypeV2026 = typeof ReportResultsV2026ReportTypeV2026[keyof typeof ReportResultsV2026ReportTypeV2026]; -export const ReportResultsV2026StatusV2026 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Warning: 'WARNING', - Terminated: 'TERMINATED' -} as const; - -export type ReportResultsV2026StatusV2026 = typeof ReportResultsV2026StatusV2026[keyof typeof ReportResultsV2026StatusV2026]; -export const ReportResultsV2026AvailableFormatsV2026 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportResultsV2026AvailableFormatsV2026 = typeof ReportResultsV2026AvailableFormatsV2026[keyof typeof ReportResultsV2026AvailableFormatsV2026]; - -/** - * type of a Report - * @export - * @enum {string} - */ - -export const ReportTypeV2026 = { - CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', - CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', - CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', - CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' -} as const; - -export type ReportTypeV2026 = typeof ReportTypeV2026[keyof typeof ReportTypeV2026]; - - -/** - * - * @export - * @interface RequestOnBehalfOfConfigV2026 - */ -export interface RequestOnBehalfOfConfigV2026 { - /** - * If this is true, anyone can request access for anyone. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2026 - */ - 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; - /** - * If this is true, a manager can request access for his or her direct reports. - * @type {boolean} - * @memberof RequestOnBehalfOfConfigV2026 - */ - 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; -} -/** - * - * @export - * @interface RequestabilityForRoleV2026 - */ -export interface RequestabilityForRoleV2026 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2026 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RequestabilityForRoleV2026 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityForRoleV2026 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityForRoleV2026 - */ - 'requireEndDate'?: boolean; - /** - * - * @type {AccessDurationV2026} - * @memberof RequestabilityForRoleV2026 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2026 | null; - /** - * List describing the steps in approving the request - * @type {Array} - * @memberof RequestabilityForRoleV2026 - */ - 'approvalSchemes'?: Array; - /** - * - * @type {DimensionSchemaV2026} - * @memberof RequestabilityForRoleV2026 - */ - 'dimensionSchema'?: DimensionSchemaV2026; - /** - * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. - * @type {string} - * @memberof RequestabilityForRoleV2026 - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface RequestabilityV2026 - */ -export interface RequestabilityV2026 { - /** - * Indicates whether the requester of the containing object must provide comments justifying the request. - * @type {boolean} - * @memberof RequestabilityV2026 - */ - 'commentsRequired'?: boolean | null; - /** - * Indicates whether an approver must provide comments when denying the request. - * @type {boolean} - * @memberof RequestabilityV2026 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityV2026 - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityV2026 - */ - 'requireEndDate'?: boolean | null; - /** - * - * @type {AccessDurationV2026} - * @memberof RequestabilityV2026 - */ - 'maxPermittedAccessDuration'?: AccessDurationV2026 | null; - /** - * List describing the steps involved in approving the request. - * @type {Array} - * @memberof RequestabilityV2026 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RequestableObjectReferenceV2026 - */ -export interface RequestableObjectReferenceV2026 { - /** - * Id of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2026 - */ - 'id'?: string; - /** - * Name of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2026 - */ - 'name'?: string; - /** - * Description of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2026 - */ - 'description'?: string; - /** - * Type of the object. - * @type {string} - * @memberof RequestableObjectReferenceV2026 - */ - 'type'?: RequestableObjectReferenceV2026TypeV2026; -} - -export const RequestableObjectReferenceV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectReferenceV2026TypeV2026 = typeof RequestableObjectReferenceV2026TypeV2026[keyof typeof RequestableObjectReferenceV2026TypeV2026]; - -/** - * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - * @export - * @enum {string} - */ - -export const RequestableObjectRequestStatusV2026 = { - Available: 'AVAILABLE', - Pending: 'PENDING', - Assigned: 'ASSIGNED' -} as const; - -export type RequestableObjectRequestStatusV2026 = typeof RequestableObjectRequestStatusV2026[keyof typeof RequestableObjectRequestStatusV2026]; - - -/** - * Currently supported requestable object types. - * @export - * @enum {string} - */ - -export const RequestableObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectTypeV2026 = typeof RequestableObjectTypeV2026[keyof typeof RequestableObjectTypeV2026]; - - -/** - * - * @export - * @interface RequestableObjectV2026 - */ -export interface RequestableObjectV2026 { - /** - * Id of the requestable object itself - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the requestable object - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'name'?: string; - /** - * The time when the requestable object was created - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'created'?: string; - /** - * The time when the requestable object was last modified - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'modified'?: string | null; - /** - * Description of the requestable object. - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'description'?: string | null; - /** - * - * @type {RequestableObjectTypeV2026} - * @memberof RequestableObjectV2026 - */ - 'type'?: RequestableObjectTypeV2026; - /** - * - * @type {RequestableObjectRequestStatusV2026 & object} - * @memberof RequestableObjectV2026 - */ - 'requestStatus'?: RequestableObjectRequestStatusV2026 & object; - /** - * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - * @type {string} - * @memberof RequestableObjectV2026 - */ - 'identityRequestId'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2026} - * @memberof RequestableObjectV2026 - */ - 'ownerRef'?: IdentityReferenceWithNameAndEmailV2026 | null; - /** - * Whether the requester must provide comments when requesting the object. - * @type {boolean} - * @memberof RequestableObjectV2026 - */ - 'requestCommentsRequired'?: boolean; -} - - -/** - * - * @export - * @interface RequestedAccountRefV2026 - */ -export interface RequestedAccountRefV2026 { - /** - * Display name of the account for the user - * @type {string} - * @memberof RequestedAccountRefV2026 - */ - 'name'?: string; - /** - * - * @type {DtoTypeV2026} - * @memberof RequestedAccountRefV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The uuid for the account - * @type {string} - * @memberof RequestedAccountRefV2026 - */ - 'accountUuid'?: string | null; - /** - * The native identity for the account - * @type {string} - * @memberof RequestedAccountRefV2026 - */ - 'accountId'?: string | null; - /** - * Display name of the source for the account - * @type {string} - * @memberof RequestedAccountRefV2026 - */ - 'sourceName'?: string; -} - - -/** - * - * @export - * @interface RequestedForDtoRefV2026 - */ -export interface RequestedForDtoRefV2026 { - /** - * The identity id for which the access is requested - * @type {string} - * @memberof RequestedForDtoRefV2026 - */ - 'identityId': string; - /** - * the details for the access items that are requested for the identity - * @type {Array} - * @memberof RequestedForDtoRefV2026 - */ - 'requestedItems': Array; -} -/** - * - * @export - * @interface RequestedItemAccountSelectionsV2026 - */ -export interface RequestedItemAccountSelectionsV2026 { - /** - * The description for this requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'description'?: string; - /** - * This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. - * @type {boolean} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'accountsSelectionBlocked'?: boolean; - /** - * If account selections are not allowed for an item, this field will denote the reason. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'accountsSelectionBlockedReason'?: string | null; - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'type'?: RequestedItemAccountSelectionsV2026TypeV2026; - /** - * The id of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'id'?: string; - /** - * The name of the requested item - * @type {string} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'name'?: string; - /** - * The details for the sources and accounts for the requested item and identity combination - * @type {Array} - * @memberof RequestedItemAccountSelectionsV2026 - */ - 'sources'?: Array; -} - -export const RequestedItemAccountSelectionsV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemAccountSelectionsV2026TypeV2026 = typeof RequestedItemAccountSelectionsV2026TypeV2026[keyof typeof RequestedItemAccountSelectionsV2026TypeV2026]; - -/** - * - * @export - * @interface RequestedItemDetailsV2026 - */ -export interface RequestedItemDetailsV2026 { - /** - * The type of access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2026 - */ - 'type'?: RequestedItemDetailsV2026TypeV2026; - /** - * The id of the access item requested. - * @type {string} - * @memberof RequestedItemDetailsV2026 - */ - 'id'?: string; -} - -export const RequestedItemDetailsV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - Role: 'ROLE' -} as const; - -export type RequestedItemDetailsV2026TypeV2026 = typeof RequestedItemDetailsV2026TypeV2026[keyof typeof RequestedItemDetailsV2026TypeV2026]; - -/** - * - * @export - * @interface RequestedItemDtoRefV2026 - */ -export interface RequestedItemDtoRefV2026 { - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2026 - */ - 'type': RequestedItemDtoRefV2026TypeV2026; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof RequestedItemDtoRefV2026 - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof RequestedItemDtoRefV2026 - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof RequestedItemDtoRefV2026 - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof RequestedItemDtoRefV2026 - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof RequestedItemDtoRefV2026 - */ - 'removeDate'?: string; - /** - * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account - * @type {Array} - * @memberof RequestedItemDtoRefV2026 - */ - 'accountSelection'?: Array | null; -} - -export const RequestedItemDtoRefV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemDtoRefV2026TypeV2026 = typeof RequestedItemDtoRefV2026TypeV2026[keyof typeof RequestedItemDtoRefV2026TypeV2026]; - -/** - * - * @export - * @interface RequestedItemStatusCancelledRequestDetailsV2026 - */ -export interface RequestedItemStatusCancelledRequestDetailsV2026 { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2026 - */ - 'comment'?: string; - /** - * - * @type {OwnerDtoV2026} - * @memberof RequestedItemStatusCancelledRequestDetailsV2026 - */ - 'owner'?: OwnerDtoV2026; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetailsV2026 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface RequestedItemStatusPreApprovalTriggerDetailsV2026 - */ -export interface RequestedItemStatusPreApprovalTriggerDetailsV2026 { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2026 - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2026 - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetailsV2026 - */ - 'decision'?: RequestedItemStatusPreApprovalTriggerDetailsV2026DecisionV2026; -} - -export const RequestedItemStatusPreApprovalTriggerDetailsV2026DecisionV2026 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type RequestedItemStatusPreApprovalTriggerDetailsV2026DecisionV2026 = typeof RequestedItemStatusPreApprovalTriggerDetailsV2026DecisionV2026[keyof typeof RequestedItemStatusPreApprovalTriggerDetailsV2026DecisionV2026]; - -/** - * - * @export - * @interface RequestedItemStatusProvisioningDetailsV2026 - */ -export interface RequestedItemStatusProvisioningDetailsV2026 { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof RequestedItemStatusProvisioningDetailsV2026 - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. - * @export - * @enum {string} - */ - -export const RequestedItemStatusRequestStateV2026 = { - Executing: 'EXECUTING', - RequestCompleted: 'REQUEST_COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED', - ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', - Rejected: 'REJECTED', - ProvisioningFailed: 'PROVISIONING_FAILED', - NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusRequestStateV2026 = typeof RequestedItemStatusRequestStateV2026[keyof typeof RequestedItemStatusRequestStateV2026]; - - -/** - * Identity access was requested for. - * @export - * @interface RequestedItemStatusRequestedForV2026 - */ -export interface RequestedItemStatusRequestedForV2026 { - /** - * Type of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2026 - */ - 'type'?: RequestedItemStatusRequestedForV2026TypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedForV2026 - */ - 'name'?: string; -} - -export const RequestedItemStatusRequestedForV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type RequestedItemStatusRequestedForV2026TypeV2026 = typeof RequestedItemStatusRequestedForV2026TypeV2026[keyof typeof RequestedItemStatusRequestedForV2026TypeV2026]; - -/** - * - * @export - * @interface RequestedItemStatusRequesterCommentV2026 - */ -export interface RequestedItemStatusRequesterCommentV2026 { - /** - * Comment content. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2026 - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof RequestedItemStatusRequesterCommentV2026 - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthorV2026} - * @memberof RequestedItemStatusRequesterCommentV2026 - */ - 'author'?: CommentDtoAuthorV2026; -} -/** - * - * @export - * @interface RequestedItemStatusSodViolationContextV2026 - */ -export interface RequestedItemStatusSodViolationContextV2026 { - /** - * The status of SOD violation check - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2026 - */ - 'state'?: RequestedItemStatusSodViolationContextV2026StateV2026 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof RequestedItemStatusSodViolationContextV2026 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2026} - * @memberof RequestedItemStatusSodViolationContextV2026 - */ - 'violationCheckResult'?: SodViolationCheckResultV2026; -} - -export const RequestedItemStatusSodViolationContextV2026StateV2026 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusSodViolationContextV2026StateV2026 = typeof RequestedItemStatusSodViolationContextV2026StateV2026[keyof typeof RequestedItemStatusSodViolationContextV2026StateV2026]; - -/** - * - * @export - * @interface RequestedItemStatusV2026 - */ -export interface RequestedItemStatusV2026 { - /** - * The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'id'?: string | null; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'type'?: RequestedItemStatusV2026TypeV2026 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetailsV2026} - * @memberof RequestedItemStatusV2026 - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetailsV2026; - /** - * List of list of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof RequestedItemStatusV2026 - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestStateV2026} - * @memberof RequestedItemStatusV2026 - */ - 'state'?: RequestedItemStatusRequestStateV2026; - /** - * Approval details for each item. - * @type {Array} - * @memberof RequestedItemStatusV2026 - */ - 'approvalDetails'?: Array; - /** - * List of approval IDs associated with the request. - * @type {Array} - * @memberof RequestedItemStatusV2026 - */ - 'approvalIds'?: Array | null; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof RequestedItemStatusV2026 - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestTypeV2026} - * @memberof RequestedItemStatusV2026 - */ - 'requestType'?: AccessRequestTypeV2026 | null; - /** - * When the request was last modified. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'created'?: string; - /** - * - * @type {AccessItemRequesterV2026} - * @memberof RequestedItemStatusV2026 - */ - 'requester'?: AccessItemRequesterV2026; - /** - * - * @type {RequestedItemStatusRequestedForV2026} - * @memberof RequestedItemStatusV2026 - */ - 'requestedFor'?: RequestedItemStatusRequestedForV2026; - /** - * - * @type {RequestedItemStatusRequesterCommentV2026} - * @memberof RequestedItemStatusV2026 - */ - 'requesterComment'?: RequestedItemStatusRequesterCommentV2026; - /** - * - * @type {RequestedItemStatusSodViolationContextV2026} - * @memberof RequestedItemStatusV2026 - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContextV2026; - /** - * - * @type {RequestedItemStatusProvisioningDetailsV2026} - * @memberof RequestedItemStatusV2026 - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetailsV2026; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetailsV2026} - * @memberof RequestedItemStatusV2026 - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetailsV2026; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof RequestedItemStatusV2026 - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof RequestedItemStatusV2026 - */ - 'cancelable'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof RequestedItemStatusV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof RequestedItemStatusV2026 - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof RequestedItemStatusV2026 - */ - 'privilegeLevel'?: string | null; -} - -export const RequestedItemStatusV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemStatusV2026TypeV2026 = typeof RequestedItemStatusV2026TypeV2026[keyof typeof RequestedItemStatusV2026TypeV2026]; - -/** - * - * @export - * @interface ResourceModelV2026 - */ -export interface ResourceModelV2026 { - /** - * The unique identifier for the resource. - * @type {number} - * @memberof ResourceModelV2026 - */ - 'id'?: number; - /** - * The display name or label for the resource. - * @type {string} - * @memberof ResourceModelV2026 - */ - 'name'?: string | null; - /** - * The full path to the resource within the system or application. - * @type {string} - * @memberof ResourceModelV2026 - */ - 'fullPath'?: string | null; - /** - * The unique identifier of the application to which this resource belongs. - * @type {number} - * @memberof ResourceModelV2026 - */ - 'applicationId'?: number; - /** - * - * @type {BusinessServiceTypeV2026} - * @memberof ResourceModelV2026 - */ - 'type'?: BusinessServiceTypeV2026; - /** - * A list of UUIDs representing the owners of the resource. - * @type {Array} - * @memberof ResourceModelV2026 - */ - 'owners'?: Array | null; -} - - -/** - * Representation of the object which is returned from source connectors. - * @export - * @interface ResourceObjectV2026 - */ -export interface ResourceObjectV2026 { - /** - * Identifier of the specific instance where this object resides. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'instance'?: string; - /** - * Native identity of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'identity'?: string; - /** - * Universal unique identifier of the object in the Source. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'uuid'?: string; - /** - * Native identity that the object has previously. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'previousIdentity'?: string; - /** - * Display name for this object. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof ResourceObjectV2026 - */ - 'objectType'?: string; - /** - * A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - * @type {boolean} - * @memberof ResourceObjectV2026 - */ - 'incomplete'?: boolean; - /** - * A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - * @type {boolean} - * @memberof ResourceObjectV2026 - */ - 'incremental'?: boolean; - /** - * A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - * @type {boolean} - * @memberof ResourceObjectV2026 - */ - 'delete'?: boolean; - /** - * A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - * @type {boolean} - * @memberof ResourceObjectV2026 - */ - 'remove'?: boolean; - /** - * A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". - * @type {Array} - * @memberof ResourceObjectV2026 - */ - 'missing'?: Array; - /** - * Attributes of this ResourceObject. - * @type {object} - * @memberof ResourceObjectV2026 - */ - 'attributes'?: object; - /** - * In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - * @type {boolean} - * @memberof ResourceObjectV2026 - */ - 'finalUpdate'?: boolean; -} -/** - * Request model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsRequestV2026 - */ -export interface ResourceObjectsRequestV2026 { - /** - * The type of resource objects to iterate over. - * @type {string} - * @memberof ResourceObjectsRequestV2026 - */ - 'objectType'?: string; - /** - * The maximum number of resource objects to iterate over and return. - * @type {number} - * @memberof ResourceObjectsRequestV2026 - */ - 'maxCount'?: number; -} -/** - * Response model for peek resource objects from source connectors. - * @export - * @interface ResourceObjectsResponseV2026 - */ -export interface ResourceObjectsResponseV2026 { - /** - * ID of the source - * @type {string} - * @memberof ResourceObjectsResponseV2026 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof ResourceObjectsResponseV2026 - */ - 'name'?: string; - /** - * The number of objects that were fetched by the connector. - * @type {number} - * @memberof ResourceObjectsResponseV2026 - */ - 'objectCount'?: number; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof ResourceObjectsResponseV2026 - */ - 'elapsedMillis'?: number; - /** - * Fetched objects from the source connector. - * @type {Array} - * @memberof ResourceObjectsResponseV2026 - */ - 'resourceObjects'?: Array; -} -/** - * - * @export - * @interface ResultV2026 - */ -export interface ResultV2026 { - /** - * Request result status - * @type {string} - * @memberof ResultV2026 - */ - 'status'?: string; -} -/** - * - * @export - * @interface ReviewDecisionV2026 - */ -export interface ReviewDecisionV2026 { - /** - * The id of the review decision - * @type {string} - * @memberof ReviewDecisionV2026 - */ - 'id': string; - /** - * - * @type {CertificationDecisionV2026} - * @memberof ReviewDecisionV2026 - */ - 'decision': CertificationDecisionV2026; - /** - * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. - * @type {string} - * @memberof ReviewDecisionV2026 - */ - 'proposedEndDate'?: string; - /** - * Indicates whether decision should be marked as part of a larger bulk decision - * @type {boolean} - * @memberof ReviewDecisionV2026 - */ - 'bulk': boolean; - /** - * - * @type {ReviewRecommendationV2026} - * @memberof ReviewDecisionV2026 - */ - 'recommendation'?: ReviewRecommendationV2026; - /** - * Comments recorded when the decision was made - * @type {string} - * @memberof ReviewDecisionV2026 - */ - 'comments'?: string; -} - - -/** - * - * @export - * @interface ReviewReassignV2026 - */ -export interface ReviewReassignV2026 { - /** - * - * @type {Array} - * @memberof ReviewReassignV2026 - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof ReviewReassignV2026 - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof ReviewReassignV2026 - */ - 'reason': string; -} -/** - * - * @export - * @interface ReviewRecommendationV2026 - */ -export interface ReviewRecommendationV2026 { - /** - * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - * @type {string} - * @memberof ReviewRecommendationV2026 - */ - 'recommendation'?: string | null; - /** - * A list of reasons for the recommendation. - * @type {Array} - * @memberof ReviewRecommendationV2026 - */ - 'reasons'?: Array; - /** - * The time at which the recommendation was recorded. - * @type {string} - * @memberof ReviewRecommendationV2026 - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface ReviewableAccessProfileV2026 - */ -export interface ReviewableAccessProfileV2026 { - /** - * The id of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableAccessProfileV2026 - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableAccessProfileV2026 - */ - 'cloudGoverned'?: boolean; - /** - * The date at which a user\'s access expires - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'endDate'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2026} - * @memberof ReviewableAccessProfileV2026 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2026 | null; - /** - * A list of entitlements associated with this Access Profile - * @type {Array} - * @memberof ReviewableAccessProfileV2026 - */ - 'entitlements'?: Array; - /** - * Date the Access Profile was created. - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof ReviewableAccessProfileV2026 - */ - 'modified'?: string; -} -/** - * Information about the machine account owner - * @export - * @interface ReviewableEntitlementAccountOwnerV2026 - */ -export interface ReviewableEntitlementAccountOwnerV2026 { - /** - * The id associated with the machine account owner - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2026 - */ - 'id'?: string | null; - /** - * An enumeration of the types of Owner supported within the IdentityNow infrastructure. - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2026 - */ - 'type'?: ReviewableEntitlementAccountOwnerV2026TypeV2026; - /** - * The machine account owner\'s display name - * @type {string} - * @memberof ReviewableEntitlementAccountOwnerV2026 - */ - 'displayName'?: string | null; -} - -export const ReviewableEntitlementAccountOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ReviewableEntitlementAccountOwnerV2026TypeV2026 = typeof ReviewableEntitlementAccountOwnerV2026TypeV2026[keyof typeof ReviewableEntitlementAccountOwnerV2026TypeV2026]; - -/** - * Information about the status of the entitlement - * @export - * @interface ReviewableEntitlementAccountV2026 - */ -export interface ReviewableEntitlementAccountV2026 { - /** - * The native identity for this account - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'nativeIdentity'?: string; - /** - * Indicates whether this account is currently disabled - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'disabled'?: boolean; - /** - * Indicates whether this account is currently locked - * @type {boolean} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'locked'?: boolean; - /** - * - * @type {DtoTypeV2026} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The id associated with the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'id'?: string | null; - /** - * The account name - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'name'?: string | null; - /** - * When the account was created - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'created'?: string | null; - /** - * When the account was last modified - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'modified'?: string | null; - /** - * - * @type {ActivityInsightsV2026} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'activityInsights'?: ActivityInsightsV2026; - /** - * Information about the account - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'description'?: string | null; - /** - * The id associated with the machine Account Governance Group - * @type {string} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'governanceGroupId'?: string | null; - /** - * - * @type {ReviewableEntitlementAccountOwnerV2026} - * @memberof ReviewableEntitlementAccountV2026 - */ - 'owner'?: ReviewableEntitlementAccountOwnerV2026 | null; -} - - -/** - * - * @export - * @interface ReviewableEntitlementV2026 - */ -export interface ReviewableEntitlementV2026 { - /** - * The id for the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'id'?: string; - /** - * The name of the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'name'?: string; - /** - * Information about the entitlement - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'description'?: string | null; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2026} - * @memberof ReviewableEntitlementV2026 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2026 | null; - /** - * The name of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'attributeName'?: string; - /** - * The value of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'attributeValue'?: string; - /** - * The schema object type on the source used to represent the entitlement and its attributes - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * The name of the source for which this entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'sourceName'?: string; - /** - * The type of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'sourceType'?: string; - /** - * The ID of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlementV2026 - */ - 'sourceId'?: string; - /** - * Indicates if the entitlement has permissions - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'hasPermissions'?: boolean; - /** - * Indicates if the entitlement is a representation of an account permission - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'isPermission'?: boolean; - /** - * Indicates whether the entitlement can be revoked - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'revocable'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement has DAS data - * @type {boolean} - * @memberof ReviewableEntitlementV2026 - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {DataAccessV2026} - * @memberof ReviewableEntitlementV2026 - */ - 'dataAccess'?: DataAccessV2026 | null; - /** - * - * @type {ReviewableEntitlementAccountV2026} - * @memberof ReviewableEntitlementV2026 - */ - 'account'?: ReviewableEntitlementAccountV2026 | null; -} -/** - * - * @export - * @interface ReviewableRoleV2026 - */ -export interface ReviewableRoleV2026 { - /** - * The id for the Role - * @type {string} - * @memberof ReviewableRoleV2026 - */ - 'id'?: string; - /** - * The name of the Role - * @type {string} - * @memberof ReviewableRoleV2026 - */ - 'name'?: string; - /** - * Information about the Role - * @type {string} - * @memberof ReviewableRoleV2026 - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableRoleV2026 - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmailV2026} - * @memberof ReviewableRoleV2026 - */ - 'owner'?: IdentityReferenceWithNameAndEmailV2026 | null; - /** - * Indicates whether the Role can be revoked or requested - * @type {boolean} - * @memberof ReviewableRoleV2026 - */ - 'revocable'?: boolean; - /** - * The date when a user\'s access expires. - * @type {string} - * @memberof ReviewableRoleV2026 - */ - 'endDate'?: string; - /** - * The list of Access Profiles associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2026 - */ - 'accessProfiles'?: Array; - /** - * The list of entitlements associated with this Role - * @type {Array} - * @memberof ReviewableRoleV2026 - */ - 'entitlements'?: Array; -} -/** - * - * @export - * @interface ReviewerV2026 - */ -export interface ReviewerV2026 { - /** - * The id of the reviewer. - * @type {string} - * @memberof ReviewerV2026 - */ - 'id'?: string; - /** - * The name of the reviewer. - * @type {string} - * @memberof ReviewerV2026 - */ - 'name'?: string; - /** - * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. - * @type {string} - * @memberof ReviewerV2026 - */ - 'email'?: string | null; - /** - * The type of the reviewing identity. - * @type {string} - * @memberof ReviewerV2026 - */ - 'type'?: ReviewerV2026TypeV2026; - /** - * The created date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2026 - */ - 'created'?: string | null; - /** - * The modified date of the reviewing identity. - * @type {string} - * @memberof ReviewerV2026 - */ - 'modified'?: string | null; -} - -export const ReviewerV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ReviewerV2026TypeV2026 = typeof ReviewerV2026TypeV2026[keyof typeof ReviewerV2026TypeV2026]; - -/** - * - * @export - * @interface RevocabilityForRoleV2026 - */ -export interface RevocabilityForRoleV2026 { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2026 - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RevocabilityForRoleV2026 - */ - 'denialCommentsRequired'?: boolean | null; - /** - * List describing the steps in approving the revocation request - * @type {Array} - * @memberof RevocabilityForRoleV2026 - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface RevocabilityV2026 - */ -export interface RevocabilityV2026 { - /** - * List describing the steps involved in approving the revocation request. - * @type {Array} - * @memberof RevocabilityV2026 - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RightPadV2026 - */ -export interface RightPadV2026 { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof RightPadV2026 - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof RightPadV2026 - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RightPadV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RightPadV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * A RightSetDTO represents a collection of rights that assigned to capability or scope, enabling them to possess specific rights to access corresponding APIs. - * @export - * @interface RightSetDTOV2026 - */ -export interface RightSetDTOV2026 { - /** - * The unique identifier of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'id'?: string; - /** - * The human-readable name of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'name'?: string; - /** - * A human-readable description of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'description'?: string; - /** - * The category of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'category'?: string; - /** - * Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. - * @type {Array} - * @memberof RightSetDTOV2026 - */ - 'rights'?: Array; - /** - * List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. - * @type {Array} - * @memberof RightSetDTOV2026 - */ - 'rightSetIds'?: Array; - /** - * List of unique identifiers for UI-assignable child RightSets, used to build UI components. - * @type {Array} - * @memberof RightSetDTOV2026 - */ - 'uiAssignableChildRightSetIds'?: Array; - /** - * Indicates whether the RightSet is UI-assignable. - * @type {boolean} - * @memberof RightSetDTOV2026 - */ - 'uiAssignable'?: boolean; - /** - * The translated name of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'translatedName'?: string; - /** - * The translated description of the RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'translatedDescription'?: string | null; - /** - * The unique identifier of the parent RightSet for UI Assignable RightSet. - * @type {string} - * @memberof RightSetDTOV2026 - */ - 'parentId'?: string | null; -} -/** - * The identity that performed the assignment. This could be blank or system - * @export - * @interface RoleAssignmentDtoAssignerV2026 - */ -export interface RoleAssignmentDtoAssignerV2026 { - /** - * Object type - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2026 - */ - 'type'?: RoleAssignmentDtoAssignerV2026TypeV2026; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RoleAssignmentDtoAssignerV2026 - */ - 'name'?: string | null; -} - -export const RoleAssignmentDtoAssignerV2026TypeV2026 = { - Identity: 'IDENTITY', - Unknown: 'UNKNOWN' -} as const; - -export type RoleAssignmentDtoAssignerV2026TypeV2026 = typeof RoleAssignmentDtoAssignerV2026TypeV2026[keyof typeof RoleAssignmentDtoAssignerV2026TypeV2026]; - -/** - * - * @export - * @interface RoleAssignmentDtoAssignmentContextV2026 - */ -export interface RoleAssignmentDtoAssignmentContextV2026 { - /** - * - * @type {AccessRequestContextV2026} - * @memberof RoleAssignmentDtoAssignmentContextV2026 - */ - 'requested'?: AccessRequestContextV2026; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoAssignmentContextV2026 - */ - 'matched'?: Array; - /** - * Date that the assignment will was evaluated - * @type {string} - * @memberof RoleAssignmentDtoAssignmentContextV2026 - */ - 'computedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentDtoV2026 - */ -export interface RoleAssignmentDtoV2026 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof RoleAssignmentDtoV2026 - */ - 'role'?: BaseReferenceDtoV2026; - /** - * Comments added by the user when the assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'comments'?: string | null; - /** - * Source describing how this assignment was made - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'assignmentSource'?: string; - /** - * - * @type {RoleAssignmentDtoAssignerV2026} - * @memberof RoleAssignmentDtoV2026 - */ - 'assigner'?: RoleAssignmentDtoAssignerV2026; - /** - * Dimensions assigned related to this role - * @type {Array} - * @memberof RoleAssignmentDtoV2026 - */ - 'assignedDimensions'?: Array; - /** - * - * @type {RoleAssignmentDtoAssignmentContextV2026} - * @memberof RoleAssignmentDtoV2026 - */ - 'assignmentContext'?: RoleAssignmentDtoAssignmentContextV2026; - /** - * - * @type {Array} - * @memberof RoleAssignmentDtoV2026 - */ - 'accountTargets'?: Array; - /** - * Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'removeDate'?: string | null; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentDtoV2026 - */ - 'addedDate'?: string; -} -/** - * - * @export - * @interface RoleAssignmentRefV2026 - */ -export interface RoleAssignmentRefV2026 { - /** - * Assignment Id - * @type {string} - * @memberof RoleAssignmentRefV2026 - */ - 'id'?: string; - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof RoleAssignmentRefV2026 - */ - 'role'?: BaseReferenceDtoV2026; - /** - * Date that the assignment was added - * @type {string} - * @memberof RoleAssignmentRefV2026 - */ - 'addedDate'?: string; - /** - * Date when assignment will be active, if requested with a future date. If null, assignment is active immediately - * @type {string} - * @memberof RoleAssignmentRefV2026 - */ - 'startDate'?: string | null; - /** - * Date that the assignment will be removed - * @type {string} - * @memberof RoleAssignmentRefV2026 - */ - 'removeDate'?: string | null; -} -/** - * Type which indicates how a particular Identity obtained a particular Role - * @export - * @enum {string} - */ - -export const RoleAssignmentSourceTypeV2026 = { - AccessRequest: 'ACCESS_REQUEST', - RoleMembership: 'ROLE_MEMBERSHIP' -} as const; - -export type RoleAssignmentSourceTypeV2026 = typeof RoleAssignmentSourceTypeV2026[keyof typeof RoleAssignmentSourceTypeV2026]; - - -/** - * - * @export - * @interface RoleBulkDeleteRequestV2026 - */ -export interface RoleBulkDeleteRequestV2026 { - /** - * List of IDs of Roles to be deleted. - * @type {Array} - * @memberof RoleBulkDeleteRequestV2026 - */ - 'roleIds': Array; -} -/** - * - * @export - * @interface RoleBulkUpdateResponseV2026 - */ -export interface RoleBulkUpdateResponseV2026 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleBulkUpdateResponseV2026 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleBulkUpdateResponseV2026 - */ - 'type'?: string; - /** - * The status of the bulk update request, could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleBulkUpdateResponseV2026 - */ - 'status'?: RoleBulkUpdateResponseV2026StatusV2026; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleBulkUpdateResponseV2026 - */ - 'created'?: string; -} - -export const RoleBulkUpdateResponseV2026StatusV2026 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PreProcessCompleted: 'PRE_PROCESS_COMPLETED', - PostProcess: 'POST_PROCESS', - Completed: 'COMPLETED', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleBulkUpdateResponseV2026StatusV2026 = typeof RoleBulkUpdateResponseV2026StatusV2026[keyof typeof RoleBulkUpdateResponseV2026StatusV2026]; - -/** - * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - * @export - * @enum {string} - */ - -export const RoleCriteriaKeyTypeV2026 = { - Identity: 'IDENTITY', - Account: 'ACCOUNT', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RoleCriteriaKeyTypeV2026 = typeof RoleCriteriaKeyTypeV2026[keyof typeof RoleCriteriaKeyTypeV2026]; - - -/** - * Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - * @export - * @interface RoleCriteriaKeyV2026 - */ -export interface RoleCriteriaKeyV2026 { - /** - * - * @type {RoleCriteriaKeyTypeV2026} - * @memberof RoleCriteriaKeyV2026 - */ - 'type': RoleCriteriaKeyTypeV2026; - /** - * The name of the attribute or entitlement to which the associated criteria applies. - * @type {string} - * @memberof RoleCriteriaKeyV2026 - */ - 'property': string; - /** - * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - * @type {string} - * @memberof RoleCriteriaKeyV2026 - */ - 'sourceId'?: string | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel1V2026 - */ -export interface RoleCriteriaLevel1V2026 { - /** - * - * @type {RoleCriteriaOperationV2026} - * @memberof RoleCriteriaLevel1V2026 - */ - 'operation'?: RoleCriteriaOperationV2026; - /** - * - * @type {RoleCriteriaKeyV2026} - * @memberof RoleCriteriaLevel1V2026 - */ - 'key'?: RoleCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel1V2026 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel1V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel2V2026 - */ -export interface RoleCriteriaLevel2V2026 { - /** - * - * @type {RoleCriteriaOperationV2026} - * @memberof RoleCriteriaLevel2V2026 - */ - 'operation'?: RoleCriteriaOperationV2026; - /** - * - * @type {RoleCriteriaKeyV2026} - * @memberof RoleCriteriaLevel2V2026 - */ - 'key'?: RoleCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel2V2026 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel2V2026 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel3V2026 - */ -export interface RoleCriteriaLevel3V2026 { - /** - * - * @type {RoleCriteriaOperationV2026} - * @memberof RoleCriteriaLevel3V2026 - */ - 'operation'?: RoleCriteriaOperationV2026; - /** - * - * @type {RoleCriteriaKeyV2026} - * @memberof RoleCriteriaLevel3V2026 - */ - 'key'?: RoleCriteriaKeyV2026 | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel3V2026 - */ - 'stringValue'?: string | null; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const RoleCriteriaOperationV2026 = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - GreaterThan: 'GREATER_THAN', - LessThan: 'LESS_THAN', - GreaterThanEquals: 'GREATER_THAN_EQUALS', - LessThanEquals: 'LESS_THAN_EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type RoleCriteriaOperationV2026 = typeof RoleCriteriaOperationV2026[keyof typeof RoleCriteriaOperationV2026]; - - -/** - * - * @export - * @interface RoleDocumentAllOfDimensionSchemaAttributesV2026 - */ -export interface RoleDocumentAllOfDimensionSchemaAttributesV2026 { - /** - * - * @type {boolean} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2026 - */ - 'derived'?: boolean; - /** - * Displayname of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2026 - */ - 'displayName'?: string; - /** - * Name of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributesV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfDimensionsV2026 - */ -export interface RoleDocumentAllOfDimensionsV2026 { - /** - * Unique ID of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2026 - */ - 'id'?: string; - /** - * Name of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2026 - */ - 'name'?: string; - /** - * Description of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensionsV2026 - */ - 'description'?: string | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2026 - */ - 'entitlements'?: Array | null; - /** - * Access profiles included in the dimension. - * @type {Array} - * @memberof RoleDocumentAllOfDimensionsV2026 - */ - 'accessProfiles'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlements1V2026 - */ -export interface RoleDocumentAllOfEntitlements1V2026 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1V2026 - */ - 'hash'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlementsV2026 - */ -export interface RoleDocumentAllOfEntitlementsV2026 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlementsV2026 - */ - 'hash'?: string; -} -/** - * Role - * @export - * @interface RoleDocumentV2026 - */ -export interface RoleDocumentV2026 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentV2026 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2026} - * @memberof RoleDocumentV2026 - */ - 'owner'?: BaseAccessOwnerV2026; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentV2026 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentV2026 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentV2026 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentV2026 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentV2026 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentV2026 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentV2026 - */ - 'dimensions'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentsV2026 - */ -export interface RoleDocumentsV2026 { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocumentsV2026 - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocumentsV2026 - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocumentsV2026 - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwnerV2026} - * @memberof RoleDocumentsV2026 - */ - 'owner'?: BaseAccessOwnerV2026; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocumentsV2026 - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocumentsV2026 - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocumentsV2026 - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocumentsV2026 - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocumentsV2026 - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocumentsV2026 - */ - 'dimensions'?: Array | null; - /** - * Name of the pod. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - 'org'?: string; - /** - * - * @type {DocumentTypeV2026} - * @memberof RoleDocumentsV2026 - */ - '_type'?: DocumentTypeV2026; - /** - * - * @type {DocumentTypeV2026} - * @memberof RoleDocumentsV2026 - */ - 'type'?: DocumentTypeV2026; - /** - * Version number. - * @type {string} - * @memberof RoleDocumentsV2026 - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface RoleGetAllBulkUpdateResponseV2026 - */ -export interface RoleGetAllBulkUpdateResponseV2026 { - /** - * ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2026 - */ - 'id'?: string; - /** - * Type of the bulk update object. - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2026 - */ - 'type'?: string; - /** - * The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2026 - */ - 'status'?: RoleGetAllBulkUpdateResponseV2026StatusV2026; - /** - * Time when the bulk update request was created - * @type {string} - * @memberof RoleGetAllBulkUpdateResponseV2026 - */ - 'created'?: string; -} - -export const RoleGetAllBulkUpdateResponseV2026StatusV2026 = { - Created: 'CREATED', - PreProcess: 'PRE_PROCESS', - PostProcess: 'POST_PROCESS', - ChunkPending: 'CHUNK_PENDING', - ChunkProcessing: 'CHUNK_PROCESSING' -} as const; - -export type RoleGetAllBulkUpdateResponseV2026StatusV2026 = typeof RoleGetAllBulkUpdateResponseV2026StatusV2026[keyof typeof RoleGetAllBulkUpdateResponseV2026StatusV2026]; - -/** - * A subset of the fields of an Identity which is a member of a Role. - * @export - * @interface RoleIdentityV2026 - */ -export interface RoleIdentityV2026 { - /** - * The ID of the Identity - * @type {string} - * @memberof RoleIdentityV2026 - */ - 'id'?: string; - /** - * The alias / username of the Identity - * @type {string} - * @memberof RoleIdentityV2026 - */ - 'aliasName'?: string; - /** - * The human-readable display name of the Identity - * @type {string} - * @memberof RoleIdentityV2026 - */ - 'name'?: string; - /** - * Email address of the Identity - * @type {string} - * @memberof RoleIdentityV2026 - */ - 'email'?: string; - /** - * - * @type {RoleAssignmentSourceTypeV2026} - * @memberof RoleIdentityV2026 - */ - 'roleAssignmentSource'?: RoleAssignmentSourceTypeV2026; -} - - -/** - * - * @export - * @interface RoleInsightV2026 - */ -export interface RoleInsightV2026 { - /** - * Insight id - * @type {string} - * @memberof RoleInsightV2026 - */ - 'id'?: string; - /** - * Total number of updates for this role - * @type {number} - * @memberof RoleInsightV2026 - */ - 'numberOfUpdates'?: number; - /** - * The date-time insights were last created for this role. - * @type {string} - * @memberof RoleInsightV2026 - */ - 'createdDate'?: string; - /** - * The date-time insights were last modified for this role. - * @type {string} - * @memberof RoleInsightV2026 - */ - 'modifiedDate'?: string | null; - /** - * - * @type {RoleInsightsRoleV2026} - * @memberof RoleInsightV2026 - */ - 'role'?: RoleInsightsRoleV2026; - /** - * - * @type {RoleInsightsInsightV2026} - * @memberof RoleInsightV2026 - */ - 'insight'?: RoleInsightsInsightV2026; -} -/** - * - * @export - * @interface RoleInsightsEntitlementChangesV2026 - */ -export interface RoleInsightsEntitlementChangesV2026 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'description'?: string | null; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'value'?: string; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'source'?: string; - /** - * - * @type {RoleInsightsInsightV2026} - * @memberof RoleInsightsEntitlementChangesV2026 - */ - 'insight'?: RoleInsightsInsightV2026; -} -/** - * - * @export - * @interface RoleInsightsEntitlementV2026 - */ -export interface RoleInsightsEntitlementV2026 { - /** - * Name of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'name'?: string; - /** - * Id of the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'id'?: string; - /** - * Description for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'description'?: string | null; - /** - * Source or the application for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'source'?: string; - /** - * Attribute for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'attribute'?: string; - /** - * Attribute value for the entitlement - * @type {string} - * @memberof RoleInsightsEntitlementV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface RoleInsightsIdentitiesV2026 - */ -export interface RoleInsightsIdentitiesV2026 { - /** - * Id for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2026 - */ - 'id'?: string; - /** - * Name for identity - * @type {string} - * @memberof RoleInsightsIdentitiesV2026 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string; }} - * @memberof RoleInsightsIdentitiesV2026 - */ - 'attributes'?: { [key: string]: string; }; -} -/** - * - * @export - * @interface RoleInsightsInsightV2026 - */ -export interface RoleInsightsInsightV2026 { - /** - * The number of identities in this role with the entitlement. - * @type {string} - * @memberof RoleInsightsInsightV2026 - */ - 'type'?: string; - /** - * The number of identities in this role with the entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2026 - */ - 'identitiesWithAccess'?: number; - /** - * The number of identities in this role that do not have the specified entitlement. - * @type {number} - * @memberof RoleInsightsInsightV2026 - */ - 'identitiesImpacted'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsInsightV2026 - */ - 'totalNumberOfIdentities'?: number; - /** - * - * @type {string} - * @memberof RoleInsightsInsightV2026 - */ - 'impactedIdentityNames'?: string | null; -} -/** - * - * @export - * @interface RoleInsightsResponseV2026 - */ -export interface RoleInsightsResponseV2026 { - /** - * Request Id for a role insight generation request - * @type {string} - * @memberof RoleInsightsResponseV2026 - */ - 'id'?: string; - /** - * The date-time role insights request was created. - * @type {string} - * @memberof RoleInsightsResponseV2026 - */ - 'createdDate'?: string; - /** - * The date-time role insights request was completed. - * @type {string} - * @memberof RoleInsightsResponseV2026 - */ - 'lastGenerated'?: string; - /** - * Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. - * @type {number} - * @memberof RoleInsightsResponseV2026 - */ - 'numberOfUpdates'?: number; - /** - * The role IDs that are in this request. - * @type {Array} - * @memberof RoleInsightsResponseV2026 - */ - 'roleIds'?: Array; - /** - * Request status - * @type {string} - * @memberof RoleInsightsResponseV2026 - */ - 'status'?: RoleInsightsResponseV2026StatusV2026; -} - -export const RoleInsightsResponseV2026StatusV2026 = { - Created: 'CREATED', - InProgress: 'IN PROGRESS', - Completed: 'COMPLETED', - Failed: 'FAILED' -} as const; - -export type RoleInsightsResponseV2026StatusV2026 = typeof RoleInsightsResponseV2026StatusV2026[keyof typeof RoleInsightsResponseV2026StatusV2026]; - -/** - * - * @export - * @interface RoleInsightsRoleV2026 - */ -export interface RoleInsightsRoleV2026 { - /** - * Role name - * @type {string} - * @memberof RoleInsightsRoleV2026 - */ - 'name'?: string; - /** - * Role id - * @type {string} - * @memberof RoleInsightsRoleV2026 - */ - 'id'?: string; - /** - * Role description - * @type {string} - * @memberof RoleInsightsRoleV2026 - */ - 'description'?: string; - /** - * Role owner name - * @type {string} - * @memberof RoleInsightsRoleV2026 - */ - 'ownerName'?: string; - /** - * Role owner id - * @type {string} - * @memberof RoleInsightsRoleV2026 - */ - 'ownerId'?: string; -} -/** - * - * @export - * @interface RoleInsightsSummaryV2026 - */ -export interface RoleInsightsSummaryV2026 { - /** - * Total number of roles with updates - * @type {number} - * @memberof RoleInsightsSummaryV2026 - */ - 'numberOfUpdates'?: number; - /** - * The date-time role insights were last found. - * @type {string} - * @memberof RoleInsightsSummaryV2026 - */ - 'lastGenerated'?: string; - /** - * The number of entitlements included in roles (vs free radicals). - * @type {number} - * @memberof RoleInsightsSummaryV2026 - */ - 'entitlementsIncludedInRoles'?: number; - /** - * The total number of entitlements. - * @type {number} - * @memberof RoleInsightsSummaryV2026 - */ - 'totalNumberOfEntitlements'?: number; - /** - * The number of identities in roles vs. identities with just entitlements and not in roles. - * @type {number} - * @memberof RoleInsightsSummaryV2026 - */ - 'identitiesWithAccessViaRoles'?: number; - /** - * The total number of identities. - * @type {number} - * @memberof RoleInsightsSummaryV2026 - */ - 'totalNumberOfIdentities'?: number; -} -/** - * - * @export - * @interface RoleListFilterDTOAmmKeyValuesInnerV2026 - */ -export interface RoleListFilterDTOAmmKeyValuesInnerV2026 { - /** - * attribute key of a metadata. - * @type {string} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2026 - */ - 'attribute'?: string; - /** - * A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. - * @type {Array} - * @memberof RoleListFilterDTOAmmKeyValuesInnerV2026 - */ - 'values'?: Array; -} -/** - * AMMFilterValues - * @export - * @interface RoleListFilterDTOV2026 - */ -export interface RoleListFilterDTOV2026 { - /** - * 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* - * @type {string} - * @memberof RoleListFilterDTOV2026 - */ - 'filters'?: string | null; - /** - * - * @type {Array} - * @memberof RoleListFilterDTOV2026 - */ - 'ammKeyValues'?: Array | null; -} -/** - * - * @export - * @interface RoleMatchDtoV2026 - */ -export interface RoleMatchDtoV2026 { - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof RoleMatchDtoV2026 - */ - 'roleRef'?: BaseReferenceDtoV2026; - /** - * - * @type {Array} - * @memberof RoleMatchDtoV2026 - */ - 'matchedAttributes'?: Array; -} -/** - * A reference to an Identity in an IDENTITY_LIST role membership criteria. - * @export - * @interface RoleMembershipIdentityV2026 - */ -export interface RoleMembershipIdentityV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof RoleMembershipIdentityV2026 - */ - 'type'?: DtoTypeV2026; - /** - * Identity id - * @type {string} - * @memberof RoleMembershipIdentityV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the Identity. - * @type {string} - * @memberof RoleMembershipIdentityV2026 - */ - 'name'?: string | null; - /** - * User name of the Identity - * @type {string} - * @memberof RoleMembershipIdentityV2026 - */ - 'aliasName'?: string | null; -} - - -/** - * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - * @export - * @enum {string} - */ - -export const RoleMembershipSelectorTypeV2026 = { - Standard: 'STANDARD', - IdentityList: 'IDENTITY_LIST' -} as const; - -export type RoleMembershipSelectorTypeV2026 = typeof RoleMembershipSelectorTypeV2026[keyof typeof RoleMembershipSelectorTypeV2026]; - - -/** - * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - * @export - * @interface RoleMembershipSelectorV2026 - */ -export interface RoleMembershipSelectorV2026 { - /** - * - * @type {RoleMembershipSelectorTypeV2026} - * @memberof RoleMembershipSelectorV2026 - */ - 'type'?: RoleMembershipSelectorTypeV2026; - /** - * - * @type {RoleCriteriaLevel1V2026} - * @memberof RoleMembershipSelectorV2026 - */ - 'criteria'?: RoleCriteriaLevel1V2026 | null; - /** - * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - * @type {Array} - * @memberof RoleMembershipSelectorV2026 - */ - 'identities'?: Array | null; -} - - -/** - * This API initialize a a Bulk update by filter request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestV2026 - */ -export interface RoleMetadataBulkUpdateByFilterRequestV2026 { - /** - * Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2026 - */ - 'filters': string; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2026 - */ - 'operation': RoleMetadataBulkUpdateByFilterRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2026 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByFilterRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestV2026 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByFilterRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2026OperationV2026 = typeof RoleMetadataBulkUpdateByFilterRequestV2026OperationV2026[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2026OperationV2026]; -export const RoleMetadataBulkUpdateByFilterRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByFilterRequestV2026ReplaceScopeV2026 = typeof RoleMetadataBulkUpdateByFilterRequestV2026ReplaceScopeV2026[keyof typeof RoleMetadataBulkUpdateByFilterRequestV2026ReplaceScopeV2026]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2026 - */ -export interface RoleMetadataBulkUpdateByFilterRequestValuesInnerV2026 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2026 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByFilterRequestValuesInnerV2026 - */ - 'values': Array | null; -} -/** - * This API initialize a Bulk update by Id request of Role metadata. The maximum role count in a single update request is 3000. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. - * @export - * @interface RoleMetadataBulkUpdateByIdRequestV2026 - */ -export interface RoleMetadataBulkUpdateByIdRequestV2026 { - /** - * Roles\' Id to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2026 - */ - 'roles': Array; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2026 - */ - 'operation': RoleMetadataBulkUpdateByIdRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestV2026 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByIdRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestV2026 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByIdRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2026OperationV2026 = typeof RoleMetadataBulkUpdateByIdRequestV2026OperationV2026[keyof typeof RoleMetadataBulkUpdateByIdRequestV2026OperationV2026]; -export const RoleMetadataBulkUpdateByIdRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByIdRequestV2026ReplaceScopeV2026 = typeof RoleMetadataBulkUpdateByIdRequestV2026ReplaceScopeV2026[keyof typeof RoleMetadataBulkUpdateByIdRequestV2026ReplaceScopeV2026]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2026 - */ -export interface RoleMetadataBulkUpdateByIdRequestValuesInnerV2026 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2026 - */ - 'attribute': string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByIdRequestValuesInnerV2026 - */ - 'values': Array | null; -} -/** - * Bulk update by query request of Role metadata. The maximum meta data values that one single role assigned can not exceed 25. Custom metadata need suit licensed. For more information about the query could refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post) - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestV2026 - */ -export interface RoleMetadataBulkUpdateByQueryRequestV2026 { - /** - * query the identities to be updated - * @type {object} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2026 - */ - 'query': object; - /** - * The operation to be performed - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2026 - */ - 'operation': RoleMetadataBulkUpdateByQueryRequestV2026OperationV2026; - /** - * The choice of update scope. - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2026 - */ - 'replaceScope'?: RoleMetadataBulkUpdateByQueryRequestV2026ReplaceScopeV2026; - /** - * The metadata to be updated, including attribute key and value. - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestV2026 - */ - 'values': Array; -} - -export const RoleMetadataBulkUpdateByQueryRequestV2026OperationV2026 = { - Add: 'ADD', - Remove: 'REMOVE', - Replace: 'REPLACE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2026OperationV2026 = typeof RoleMetadataBulkUpdateByQueryRequestV2026OperationV2026[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2026OperationV2026]; -export const RoleMetadataBulkUpdateByQueryRequestV2026ReplaceScopeV2026 = { - All: 'ALL', - Attribute: 'ATTRIBUTE' -} as const; - -export type RoleMetadataBulkUpdateByQueryRequestV2026ReplaceScopeV2026 = typeof RoleMetadataBulkUpdateByQueryRequestV2026ReplaceScopeV2026[keyof typeof RoleMetadataBulkUpdateByQueryRequestV2026ReplaceScopeV2026]; - -/** - * - * @export - * @interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2026 - */ -export interface RoleMetadataBulkUpdateByQueryRequestValuesInnerV2026 { - /** - * the key of metadata attribute - * @type {string} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2026 - */ - 'attributeKey'?: string; - /** - * the values of attribute to be updated - * @type {Array} - * @memberof RoleMetadataBulkUpdateByQueryRequestValuesInnerV2026 - */ - 'attributeValue'?: Array; -} -/** - * - * @export - * @interface RoleMiningEntitlementRefV2026 - */ -export interface RoleMiningEntitlementRefV2026 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2026 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2026 - */ - 'name'?: string; - /** - * Description forthe entitlement - * @type {string} - * @memberof RoleMiningEntitlementRefV2026 - */ - 'description'?: string | null; - /** - * The entitlement attribute - * @type {string} - * @memberof RoleMiningEntitlementRefV2026 - */ - 'attribute'?: string; -} -/** - * - * @export - * @interface RoleMiningEntitlementV2026 - */ -export interface RoleMiningEntitlementV2026 { - /** - * - * @type {RoleMiningEntitlementRefV2026} - * @memberof RoleMiningEntitlementV2026 - */ - 'entitlementRef'?: RoleMiningEntitlementRefV2026; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2026 - */ - 'name'?: string; - /** - * Application name of the entitlement - * @type {string} - * @memberof RoleMiningEntitlementV2026 - */ - 'applicationName'?: string; - /** - * The number of identities with this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2026 - */ - 'identityCount'?: number; - /** - * The % popularity of this entitlement in a role. - * @type {number} - * @memberof RoleMiningEntitlementV2026 - */ - 'popularity'?: number; - /** - * The % popularity of this entitlement in the org. - * @type {number} - * @memberof RoleMiningEntitlementV2026 - */ - 'popularityInOrg'?: number; - /** - * The ID of the source/application. - * @type {string} - * @memberof RoleMiningEntitlementV2026 - */ - 'sourceId'?: string; - /** - * The status of activity data for the source. Value is complete or notComplete. - * @type {string} - * @memberof RoleMiningEntitlementV2026 - */ - 'activitySourceState'?: string | null; - /** - * The percentage of identities in the potential role that have usage of the source/application of this entitlement. - * @type {number} - * @memberof RoleMiningEntitlementV2026 - */ - 'sourceUsagePercent'?: number | null; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionDistributionInnerV2026 - */ -export interface RoleMiningIdentityDistributionDistributionInnerV2026 { - /** - * The attribute value that identities are grouped by - * @type {string} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2026 - */ - 'attributeValue'?: string | null; - /** - * The number of identities that have this attribute value - * @type {number} - * @memberof RoleMiningIdentityDistributionDistributionInnerV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface RoleMiningIdentityDistributionV2026 - */ -export interface RoleMiningIdentityDistributionV2026 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningIdentityDistributionV2026 - */ - 'attributeName'?: string; - /** - * - * @type {Array} - * @memberof RoleMiningIdentityDistributionV2026 - */ - 'distribution'?: Array; -} -/** - * - * @export - * @interface RoleMiningIdentityV2026 - */ -export interface RoleMiningIdentityV2026 { - /** - * Id of the identity - * @type {string} - * @memberof RoleMiningIdentityV2026 - */ - 'id'?: string; - /** - * Name of the identity - * @type {string} - * @memberof RoleMiningIdentityV2026 - */ - 'name'?: string; - /** - * - * @type {{ [key: string]: string | null; }} - * @memberof RoleMiningIdentityV2026 - */ - 'attributes'?: { [key: string]: string | null; }; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleApplicationV2026 - */ -export interface RoleMiningPotentialRoleApplicationV2026 { - /** - * Id of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2026 - */ - 'id'?: string; - /** - * Name of the application - * @type {string} - * @memberof RoleMiningPotentialRoleApplicationV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEditEntitlementsV2026 - */ -export interface RoleMiningPotentialRoleEditEntitlementsV2026 { - /** - * The list of entitlement ids to be edited - * @type {Array} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2026 - */ - 'ids'?: Array; - /** - * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. - * @type {boolean} - * @memberof RoleMiningPotentialRoleEditEntitlementsV2026 - */ - 'exclude'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleEntitlementsV2026 - */ -export interface RoleMiningPotentialRoleEntitlementsV2026 { - /** - * Id of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2026 - */ - 'id'?: string; - /** - * Name of the entitlement - * @type {string} - * @memberof RoleMiningPotentialRoleEntitlementsV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportRequestV2026 - */ -export interface RoleMiningPotentialRoleExportRequestV2026 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportRequestV2026 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportRequestV2026 - */ - 'includeCommonAccess'?: boolean; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleExportResponseV2026 - */ -export interface RoleMiningPotentialRoleExportResponseV2026 { - /** - * The minimum popularity among identities in the role which an entitlement must have to be included in the report - * @type {number} - * @memberof RoleMiningPotentialRoleExportResponseV2026 - */ - 'minEntitlementPopularity'?: number; - /** - * If false, do not include entitlements that are highly popular among the entire orginization - * @type {boolean} - * @memberof RoleMiningPotentialRoleExportResponseV2026 - */ - 'includeCommonAccess'?: boolean; - /** - * ID used to reference this export - * @type {string} - * @memberof RoleMiningPotentialRoleExportResponseV2026 - */ - 'exportId'?: string; - /** - * - * @type {RoleMiningPotentialRoleExportStateV2026} - * @memberof RoleMiningPotentialRoleExportResponseV2026 - */ - 'status'?: RoleMiningPotentialRoleExportStateV2026; -} - - -/** - * - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleExportStateV2026 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RoleMiningPotentialRoleExportStateV2026 = typeof RoleMiningPotentialRoleExportStateV2026[keyof typeof RoleMiningPotentialRoleExportStateV2026]; - - -/** - * The potential role reference - * @export - * @interface RoleMiningPotentialRolePotentialRoleRefV2026 - */ -export interface RoleMiningPotentialRolePotentialRoleRefV2026 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2026 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRolePotentialRoleRefV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleProvisionRequestV2026 - */ -export interface RoleMiningPotentialRoleProvisionRequestV2026 { - /** - * Name of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2026 - */ - 'roleName'?: string; - /** - * Short description of the new role being created - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2026 - */ - 'roleDescription'?: string; - /** - * ID of the identity that will own this role - * @type {string} - * @memberof RoleMiningPotentialRoleProvisionRequestV2026 - */ - 'ownerId'?: string; - /** - * When true, create access requests for the identities associated with the potential role - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2026 - */ - 'includeIdentities'?: boolean; - /** - * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements - * @type {boolean} - * @memberof RoleMiningPotentialRoleProvisionRequestV2026 - */ - 'directlyAssignedEntitlements'?: boolean; -} -/** - * Provision state - * @export - * @enum {string} - */ - -export const RoleMiningPotentialRoleProvisionStateV2026 = { - Potential: 'POTENTIAL', - Pending: 'PENDING', - Complete: 'COMPLETE', - Failed: 'FAILED' -} as const; - -export type RoleMiningPotentialRoleProvisionStateV2026 = typeof RoleMiningPotentialRoleProvisionStateV2026[keyof typeof RoleMiningPotentialRoleProvisionStateV2026]; - - -/** - * - * @export - * @interface RoleMiningPotentialRoleRefV2026 - */ -export interface RoleMiningPotentialRoleRefV2026 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2026 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleRefV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleMiningPotentialRoleSourceUsageV2026 - */ -export interface RoleMiningPotentialRoleSourceUsageV2026 { - /** - * The identity ID - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2026 - */ - 'id'?: string; - /** - * Display name for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2026 - */ - 'displayName'?: string; - /** - * Email address for the identity - * @type {string} - * @memberof RoleMiningPotentialRoleSourceUsageV2026 - */ - 'email'?: string; - /** - * The number of days there has been usage of the source by the identity. - * @type {number} - * @memberof RoleMiningPotentialRoleSourceUsageV2026 - */ - 'usageCount'?: number; -} -/** - * @type RoleMiningPotentialRoleSummaryCreatedByV2026 - * The potential role created by details - * @export - */ -export type RoleMiningPotentialRoleSummaryCreatedByV2026 = EntityCreatedByDTOV2026 | string; - -/** - * - * @export - * @interface RoleMiningPotentialRoleSummaryV2026 - */ -export interface RoleMiningPotentialRoleSummaryV2026 { - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'id'?: string; - /** - * Name of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRoleRefV2026} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'potentialRoleRef'?: RoleMiningPotentialRoleRefV2026; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'identityCount'?: number; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'entitlementCount'?: number; - /** - * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'identityGroupStatus'?: string; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2026} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2026; - /** - * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'roleId'?: string | null; - /** - * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'density'?: number; - /** - * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'freshness'?: number; - /** - * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. - * @type {number} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'quality'?: number; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; - /** - * - * @type {RoleMiningPotentialRoleSummaryCreatedByV2026} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'createdBy'?: RoleMiningPotentialRoleSummaryCreatedByV2026; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'createdDate'?: string; - /** - * The potential role\'s saved status - * @type {boolean} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'saved'?: boolean; - /** - * Description of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'description'?: string | null; - /** - * - * @type {RoleMiningSessionParametersDtoV2026} - * @memberof RoleMiningPotentialRoleSummaryV2026 - */ - 'session'?: RoleMiningSessionParametersDtoV2026; -} - - -/** - * - * @export - * @interface RoleMiningPotentialRoleV2026 - */ -export interface RoleMiningPotentialRoleV2026 { - /** - * - * @type {RoleMiningSessionResponseCreatedByV2026} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2026; - /** - * The density of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'density'?: number; - /** - * The description of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'description'?: string | null; - /** - * The number of entitlements in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'entitlementCount'?: number; - /** - * The list of entitlement ids to be excluded. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'excludedEntitlements'?: Array | null; - /** - * The freshness of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'freshness'?: number; - /** - * The number of identities in a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'identityCount'?: number; - /** - * Identity attribute distribution. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'identityDistribution'?: Array | null; - /** - * The list of ids in a potential role. - * @type {Array} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'identityIds'?: Array; - /** - * The status for this identity group which can be OBTAINED or COMPRESSED - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'identityGroupStatus'?: string | null; - /** - * Name of the potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'name'?: string; - /** - * - * @type {RoleMiningPotentialRolePotentialRoleRefV2026} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRefV2026 | null; - /** - * - * @type {RoleMiningPotentialRoleProvisionStateV2026 & object} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'provisionState'?: RoleMiningPotentialRoleProvisionStateV2026 & object; - /** - * The quality of a potential role. - * @type {number} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'quality'?: number; - /** - * The roleId of a potential role. - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'roleId'?: string | null; - /** - * The potential role\'s saved status. - * @type {boolean} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionParametersDtoV2026} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'session'?: RoleMiningSessionParametersDtoV2026; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; - /** - * Id of the potential role - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'id'?: string; - /** - * The date-time when this potential role was created. - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'createdDate'?: string; - /** - * The date-time when this potential role was modified. - * @type {string} - * @memberof RoleMiningPotentialRoleV2026 - */ - 'modifiedDate'?: string; -} - - -/** - * Role type - * @export - * @enum {string} - */ - -export const RoleMiningRoleTypeV2026 = { - Specialized: 'SPECIALIZED', - Common: 'COMMON' -} as const; - -export type RoleMiningRoleTypeV2026 = typeof RoleMiningRoleTypeV2026[keyof typeof RoleMiningRoleTypeV2026]; - - -/** - * - * @export - * @interface RoleMiningSessionDraftRoleDtoV2026 - */ -export interface RoleMiningSessionDraftRoleDtoV2026 { - /** - * Name of the draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'name'?: string; - /** - * Draft role description - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'description'?: string; - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'identityIds'?: Array; - /** - * The list of entitlement ids for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'entitlementIds'?: Array; - /** - * The list of excluded entitlement ids. - * @type {Array} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'excludedEntitlements'?: Array; - /** - * Last modified date - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'modified'?: string; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; - /** - * Id of the potential draft role - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'id'?: string; - /** - * The date-time when this potential draft role was created. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'createdDate'?: string; - /** - * The date-time when this potential draft role was modified. - * @type {string} - * @memberof RoleMiningSessionDraftRoleDtoV2026 - */ - 'modifiedDate'?: string; -} - - -/** - * - * @export - * @interface RoleMiningSessionDtoV2026 - */ -export interface RoleMiningSessionDtoV2026 { - /** - * - * @type {RoleMiningSessionScopeV2026} - * @memberof RoleMiningSessionDtoV2026 - */ - 'scope'?: RoleMiningSessionScopeV2026; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'pruneThreshold'?: number | null; - /** - * The calculated prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * Number of potential roles - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'potentialRoleCount'?: number; - /** - * Number of potential roles ready - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningSessionDtoV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionDtoV2026 - */ - 'emailRecipientId'?: string | null; - /** - * Number of identities in the population which meet the search criteria or identity list provided - * @type {number} - * @memberof RoleMiningSessionDtoV2026 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionDtoV2026 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionDtoV2026 - */ - 'name'?: string | null; -} - - -/** - * - * @export - * @interface RoleMiningSessionParametersDtoV2026 - */ -export interface RoleMiningSessionParametersDtoV2026 { - /** - * The ID of the role mining session - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'id'?: string; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'name'?: string | null; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The prune threshold to be used or null to calculate prescribedPruneThreshold - * @type {number} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'pruneThreshold'?: number | null; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'saved'?: boolean; - /** - * - * @type {RoleMiningSessionScopeV2026} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'scope'?: RoleMiningSessionScopeV2026; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; - /** - * - * @type {RoleMiningSessionStateV2026} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'state'?: RoleMiningSessionStateV2026; - /** - * - * @type {RoleMiningSessionScopingMethodV2026} - * @memberof RoleMiningSessionParametersDtoV2026 - */ - 'scopingMethod'?: RoleMiningSessionScopingMethodV2026; -} - - -/** - * @type RoleMiningSessionResponseCreatedByV2026 - * The session created by details - * @export - */ -export type RoleMiningSessionResponseCreatedByV2026 = EntityCreatedByDTOV2026 | string; - -/** - * - * @export - * @interface RoleMiningSessionResponseV2026 - */ -export interface RoleMiningSessionResponseV2026 { - /** - * - * @type {RoleMiningSessionScopeV2026} - * @memberof RoleMiningSessionResponseV2026 - */ - 'scope'?: RoleMiningSessionScopeV2026; - /** - * Minimum number of identities in a potential role - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'minNumIdentitiesInPotentialRole'?: number | null; - /** - * The scoping method of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'scopingMethod'?: string | null; - /** - * The computed (or prescribed) prune threshold for this session - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'prescribedPruneThreshold'?: number | null; - /** - * The prune threshold to be used for this role mining session - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'pruneThreshold'?: number | null; - /** - * The number of potential roles - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'potentialRoleCount'?: number; - /** - * The number of potential roles which have completed processing - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'potentialRolesReadyCount'?: number; - /** - * - * @type {RoleMiningSessionStatusV2026} - * @memberof RoleMiningSessionResponseV2026 - */ - 'status'?: RoleMiningSessionStatusV2026; - /** - * The id of the user who will receive an email about the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'emailRecipientId'?: string | null; - /** - * - * @type {RoleMiningSessionResponseCreatedByV2026} - * @memberof RoleMiningSessionResponseV2026 - */ - 'createdBy'?: RoleMiningSessionResponseCreatedByV2026; - /** - * The number of identities - * @type {number} - * @memberof RoleMiningSessionResponseV2026 - */ - 'identityCount'?: number; - /** - * The session\'s saved status - * @type {boolean} - * @memberof RoleMiningSessionResponseV2026 - */ - 'saved'?: boolean; - /** - * The session\'s saved name - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'name'?: string | null; - /** - * The data file path of the role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'dataFilePath'?: string | null; - /** - * Session Id for this role mining session - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'id'?: string; - /** - * The date-time when this role mining session was created. - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'createdDate'?: string; - /** - * The date-time when this role mining session was completed. - * @type {string} - * @memberof RoleMiningSessionResponseV2026 - */ - 'modifiedDate'?: string; - /** - * - * @type {RoleMiningRoleTypeV2026} - * @memberof RoleMiningSessionResponseV2026 - */ - 'type'?: RoleMiningRoleTypeV2026; -} - - -/** - * - * @export - * @interface RoleMiningSessionScopeV2026 - */ -export interface RoleMiningSessionScopeV2026 { - /** - * The list of identities for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2026 - */ - 'identityIds'?: Array; - /** - * The \"search\" criteria that produces the list of identities for this role mining session. - * @type {string} - * @memberof RoleMiningSessionScopeV2026 - */ - 'criteria'?: string | null; - /** - * The filter criteria for this role mining session. - * @type {Array} - * @memberof RoleMiningSessionScopeV2026 - */ - 'attributeFilterCriteria'?: Array | null; -} -/** - * The scoping method used in the current role mining session. - * @export - * @enum {string} - */ - -export const RoleMiningSessionScopingMethodV2026 = { - Manual: 'MANUAL', - AutoRm: 'AUTO_RM' -} as const; - -export type RoleMiningSessionScopingMethodV2026 = typeof RoleMiningSessionScopingMethodV2026[keyof typeof RoleMiningSessionScopingMethodV2026]; - - -/** - * Role mining session status - * @export - * @enum {string} - */ - -export const RoleMiningSessionStateV2026 = { - Created: 'CREATED', - Updated: 'UPDATED', - IdentitiesObtained: 'IDENTITIES_OBTAINED', - PruneThresholdObtained: 'PRUNE_THRESHOLD_OBTAINED', - PotentialRolesProcessing: 'POTENTIAL_ROLES_PROCESSING', - PotentialRolesCreated: 'POTENTIAL_ROLES_CREATED' -} as const; - -export type RoleMiningSessionStateV2026 = typeof RoleMiningSessionStateV2026[keyof typeof RoleMiningSessionStateV2026]; - - -/** - * - * @export - * @interface RoleMiningSessionStatusV2026 - */ -export interface RoleMiningSessionStatusV2026 { - /** - * - * @type {RoleMiningSessionStateV2026} - * @memberof RoleMiningSessionStatusV2026 - */ - 'state'?: RoleMiningSessionStateV2026; -} - - -/** - * Role Change Propagation Config Input - * @export - * @interface RolePropagationConfigInputV2026 - */ -export interface RolePropagationConfigInputV2026 { - /** - * Indicates if the Role Change Propagation process should be enabled for the tenant - * @type {boolean} - * @memberof RolePropagationConfigInputV2026 - */ - 'enabled'?: boolean; -} -/** - * Role Change Propagation Config Response - * @export - * @interface RolePropagationConfigResponseV2026 - */ -export interface RolePropagationConfigResponseV2026 { - /** - * Indicates if the Role Change Propagation process is enabled for the tenant - * @type {boolean} - * @memberof RolePropagationConfigResponseV2026 - */ - 'enabled'?: boolean; - /** - * The time when Role Change Propagation Process was last enabled on the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2026 - */ - 'enabledDate'?: string; - /** - * The time when Role Change Propagation Configuration was first created for the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2026 - */ - 'createdDate'?: string; - /** - * The time when Role Change Propagation Config was updated on the tenant - * @type {string} - * @memberof RolePropagationConfigResponseV2026 - */ - 'modifiedDate'?: string; -} -/** - * Details of the ongoing role propagation process - * @export - * @interface RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ -export interface RolePropagationOngoingResponseRolePropagationDetailsV2026 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'id'?: string; - /** - * Status of the Role Propagation process. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'status'?: RolePropagationOngoingResponseRolePropagationDetailsV2026StatusV2026; - /** - * Current execution stage of the Role Propagation process. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'executionStage'?: RolePropagationOngoingResponseRolePropagationDetailsV2026ExecutionStageV2026; - /** - * Time when the Role Propagation process was launched. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'launched'?: string; - /** - * - * @type {RolePropagationStatusResponseLaunchedByV2026} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'launchedBy'?: RolePropagationStatusResponseLaunchedByV2026; - /** - * - * @type {RolePropagationStatusResponseTerminatedByV2026} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV2026; - /** - * Time when the Role Propagation process was completed. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'completed'?: string; - /** - * Reason for failure if the Role Propagation process failed. - * @type {string} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'failureReason'?: string; - /** - * Indicates if the role refresh was skipped during the Role Propagation process. - * @type {boolean} - * @memberof RolePropagationOngoingResponseRolePropagationDetailsV2026 - */ - 'skipRoleRefresh'?: boolean; -} - -export const RolePropagationOngoingResponseRolePropagationDetailsV2026StatusV2026 = { - Running: 'RUNNING', - Completed: 'COMPLETED' -} as const; - -export type RolePropagationOngoingResponseRolePropagationDetailsV2026StatusV2026 = typeof RolePropagationOngoingResponseRolePropagationDetailsV2026StatusV2026[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV2026StatusV2026]; -export const RolePropagationOngoingResponseRolePropagationDetailsV2026ExecutionStageV2026 = { - Pending: 'PENDING', - DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', - LaunchProvisioning: 'LAUNCH_PROVISIONING', - Succeeded: 'SUCCEEDED', - Failed: 'FAILED', - Terminated: 'TERMINATED' -} as const; - -export type RolePropagationOngoingResponseRolePropagationDetailsV2026ExecutionStageV2026 = typeof RolePropagationOngoingResponseRolePropagationDetailsV2026ExecutionStageV2026[keyof typeof RolePropagationOngoingResponseRolePropagationDetailsV2026ExecutionStageV2026]; - -/** - * Running Role Propagation Response - * @export - * @interface RolePropagationOngoingResponseV2026 - */ -export interface RolePropagationOngoingResponseV2026 { - /** - * Indicates if the role propagation process is currently running on the tenant - * @type {boolean} - * @memberof RolePropagationOngoingResponseV2026 - */ - 'isRunning'?: boolean; - /** - * - * @type {RolePropagationOngoingResponseRolePropagationDetailsV2026} - * @memberof RolePropagationOngoingResponseV2026 - */ - 'rolePropagationDetails'?: RolePropagationOngoingResponseRolePropagationDetailsV2026; -} -/** - * Role Propagation Response - * @export - * @interface RolePropagationResponseV2026 - */ -export interface RolePropagationResponseV2026 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationResponseV2026 - */ - 'rolePropagationId'?: string; -} -/** - * Identity who launched the Role Propagation process. - * @export - * @interface RolePropagationStatusResponseLaunchedByV2026 - */ -export interface RolePropagationStatusResponseLaunchedByV2026 { - /** - * DTO type of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2026 - */ - 'type'?: RolePropagationStatusResponseLaunchedByV2026TypeV2026; - /** - * ID of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2026 - */ - 'id'?: string; - /** - * Name of the identity who launched the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseLaunchedByV2026 - */ - 'name'?: string; -} - -export const RolePropagationStatusResponseLaunchedByV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type RolePropagationStatusResponseLaunchedByV2026TypeV2026 = typeof RolePropagationStatusResponseLaunchedByV2026TypeV2026[keyof typeof RolePropagationStatusResponseLaunchedByV2026TypeV2026]; - -/** - * Identity who terminated the Role Propagation process. - * @export - * @interface RolePropagationStatusResponseTerminatedByV2026 - */ -export interface RolePropagationStatusResponseTerminatedByV2026 { - /** - * DTO type of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2026 - */ - 'type'?: RolePropagationStatusResponseTerminatedByV2026TypeV2026; - /** - * ID of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2026 - */ - 'id'?: string; - /** - * Name of the Identity who terminated the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseTerminatedByV2026 - */ - 'name'?: string; -} - -export const RolePropagationStatusResponseTerminatedByV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type RolePropagationStatusResponseTerminatedByV2026TypeV2026 = typeof RolePropagationStatusResponseTerminatedByV2026TypeV2026[keyof typeof RolePropagationStatusResponseTerminatedByV2026TypeV2026]; - -/** - * Role Propagation Status Response - * @export - * @interface RolePropagationStatusResponseV2026 - */ -export interface RolePropagationStatusResponseV2026 { - /** - * Id of the Role Propagation process triggered. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'id'?: string; - /** - * Status of the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'status'?: RolePropagationStatusResponseV2026StatusV2026; - /** - * Current execution stage of the Role Propagation process. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'executionStage'?: RolePropagationStatusResponseV2026ExecutionStageV2026; - /** - * Time when the Role Propagation process was launched. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'launched'?: string; - /** - * - * @type {RolePropagationStatusResponseLaunchedByV2026} - * @memberof RolePropagationStatusResponseV2026 - */ - 'launchedBy'?: RolePropagationStatusResponseLaunchedByV2026; - /** - * - * @type {RolePropagationStatusResponseTerminatedByV2026} - * @memberof RolePropagationStatusResponseV2026 - */ - 'terminatedBy'?: RolePropagationStatusResponseTerminatedByV2026; - /** - * Time when the Role Propagation process was completed. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'completed'?: string; - /** - * Reason for failure if the Role Propagation process failed. - * @type {string} - * @memberof RolePropagationStatusResponseV2026 - */ - 'failureReason'?: string; - /** - * Indicates if the role refresh was skipped during the Role Propagation process. - * @type {boolean} - * @memberof RolePropagationStatusResponseV2026 - */ - 'skipRoleRefresh'?: boolean; -} - -export const RolePropagationStatusResponseV2026StatusV2026 = { - Running: 'RUNNING', - Completed: 'COMPLETED' -} as const; - -export type RolePropagationStatusResponseV2026StatusV2026 = typeof RolePropagationStatusResponseV2026StatusV2026[keyof typeof RolePropagationStatusResponseV2026StatusV2026]; -export const RolePropagationStatusResponseV2026ExecutionStageV2026 = { - Pending: 'PENDING', - DataAggregationRunning: 'DATA_AGGREGATION_RUNNING', - LaunchProvisioning: 'LAUNCH_PROVISIONING', - Succeeded: 'SUCCEEDED', - Failed: 'FAILED', - Terminated: 'TERMINATED' -} as const; - -export type RolePropagationStatusResponseV2026ExecutionStageV2026 = typeof RolePropagationStatusResponseV2026ExecutionStageV2026[keyof typeof RolePropagationStatusResponseV2026ExecutionStageV2026]; - -/** - * Role - * @export - * @interface RoleSummaryV2026 - */ -export interface RoleSummaryV2026 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof RoleSummaryV2026 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof RoleSummaryV2026 - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof RoleSummaryV2026 - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof RoleSummaryV2026 - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof RoleSummaryV2026 - */ - 'type'?: string; - /** - * - * @type {DisplayReferenceV2026} - * @memberof RoleSummaryV2026 - */ - 'owner'?: DisplayReferenceV2026; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2026 - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof RoleSummaryV2026 - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface RoleTargetDtoV2026 - */ -export interface RoleTargetDtoV2026 { - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof RoleTargetDtoV2026 - */ - 'source'?: BaseReferenceDtoV2026; - /** - * - * @type {AccountInfoDtoV2026} - * @memberof RoleTargetDtoV2026 - */ - 'accountInfo'?: AccountInfoDtoV2026; - /** - * - * @type {BaseReferenceDtoV2026} - * @memberof RoleTargetDtoV2026 - */ - 'role'?: BaseReferenceDtoV2026; -} -/** - * A Role - * @export - * @interface RoleV2026 - */ -export interface RoleV2026 { - /** - * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof RoleV2026 - */ - 'id'?: string; - /** - * The human-readable display name of the Role - * @type {string} - * @memberof RoleV2026 - */ - 'name': string; - /** - * Date the Role was created - * @type {string} - * @memberof RoleV2026 - */ - 'created'?: string; - /** - * Date the Role was last modified. - * @type {string} - * @memberof RoleV2026 - */ - 'modified'?: string; - /** - * A human-readable description of the Role - * @type {string} - * @memberof RoleV2026 - */ - 'description'?: string | null; - /** - * - * @type {OwnerReferenceV2026} - * @memberof RoleV2026 - */ - 'owner': OwnerReferenceV2026 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof RoleV2026 - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2026 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleV2026 - */ - 'entitlements'?: Array; - /** - * - * @type {RoleMembershipSelectorV2026} - * @memberof RoleV2026 - */ - 'membership'?: RoleMembershipSelectorV2026 | null; - /** - * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - * @type {{ [key: string]: any; }} - * @memberof RoleV2026 - */ - 'legacyMembershipInfo'?: { [key: string]: any; } | null; - /** - * Whether the Role is enabled or not. - * @type {boolean} - * @memberof RoleV2026 - */ - 'enabled'?: boolean; - /** - * Whether the Role can be the target of access requests. - * @type {boolean} - * @memberof RoleV2026 - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityForRoleV2026} - * @memberof RoleV2026 - */ - 'accessRequestConfig'?: RequestabilityForRoleV2026; - /** - * - * @type {RevocabilityForRoleV2026} - * @memberof RoleV2026 - */ - 'revocationRequestConfig'?: RevocabilityForRoleV2026; - /** - * List of IDs of segments, if any, to which this Role is assigned. - * @type {Array} - * @memberof RoleV2026 - */ - 'segments'?: Array | null; - /** - * Whether the Role is dimensional. - * @type {boolean} - * @memberof RoleV2026 - */ - 'dimensional'?: boolean | null; - /** - * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - * @type {Array} - * @memberof RoleV2026 - */ - 'dimensionRefs'?: Array | null; - /** - * - * @type {AttributeDTOListV2026} - * @memberof RoleV2026 - */ - 'accessModelMetadata'?: AttributeDTOListV2026; - /** - * The privilege level of the role, if applicable. - * @type {string} - * @memberof RoleV2026 - */ - 'privilegeLevel'?: string | null; -} -/** - * @type RuleV2026 - * @export - */ -export type RuleV2026 = GenerateRandomStringV2026 | GetReferenceIdentityAttributeV2026 | TransformRuleV2026; - -/** - * A table of accounts that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsAccountV2026 - */ -export interface SavedSearchCompleteSearchResultsAccountV2026 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2026 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsAccountV2026 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsAccountV2026 - */ - 'preview': Array>; -} -/** - * A table of entitlements that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsEntitlementV2026 - */ -export interface SavedSearchCompleteSearchResultsEntitlementV2026 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2026 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2026 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsEntitlementV2026 - */ - 'preview': Array>; -} -/** - * A table of identities that match the search criteria. - * @export - * @interface SavedSearchCompleteSearchResultsIdentityV2026 - */ -export interface SavedSearchCompleteSearchResultsIdentityV2026 { - /** - * The number of rows in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2026 - */ - 'count': string; - /** - * The type of object represented in the table. - * @type {string} - * @memberof SavedSearchCompleteSearchResultsIdentityV2026 - */ - 'noun': string; - /** - * A sample of the data in the table. - * @type {Array>} - * @memberof SavedSearchCompleteSearchResultsIdentityV2026 - */ - 'preview': Array>; -} -/** - * A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. - * @export - * @interface SavedSearchCompleteSearchResultsV2026 - */ -export interface SavedSearchCompleteSearchResultsV2026 { - /** - * - * @type {SavedSearchCompleteSearchResultsAccountV2026} - * @memberof SavedSearchCompleteSearchResultsV2026 - */ - 'Account'?: SavedSearchCompleteSearchResultsAccountV2026 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsEntitlementV2026} - * @memberof SavedSearchCompleteSearchResultsV2026 - */ - 'Entitlement'?: SavedSearchCompleteSearchResultsEntitlementV2026 | null; - /** - * - * @type {SavedSearchCompleteSearchResultsIdentityV2026} - * @memberof SavedSearchCompleteSearchResultsV2026 - */ - 'Identity'?: SavedSearchCompleteSearchResultsIdentityV2026 | null; -} -/** - * - * @export - * @interface SavedSearchCompleteV2026 - */ -export interface SavedSearchCompleteV2026 { - /** - * A name for the report file. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'fileName': string; - /** - * The email address of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'ownerEmail': string; - /** - * The name of the identity that owns the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'ownerName': string; - /** - * The search query that was used to generate the report. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'query': string; - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'searchName': string; - /** - * - * @type {SavedSearchCompleteSearchResultsV2026} - * @memberof SavedSearchCompleteV2026 - */ - 'searchResults': SavedSearchCompleteSearchResultsV2026; - /** - * The Amazon S3 URL to download the report from. - * @type {string} - * @memberof SavedSearchCompleteV2026 - */ - 'signedS3Url': string; -} -/** - * - * @export - * @interface SavedSearchDetailFiltersV2026 - */ -export interface SavedSearchDetailFiltersV2026 { - /** - * - * @type {FilterTypeV2026} - * @memberof SavedSearchDetailFiltersV2026 - */ - 'type'?: FilterTypeV2026; - /** - * - * @type {RangeV2026} - * @memberof SavedSearchDetailFiltersV2026 - */ - 'range'?: RangeV2026; - /** - * The terms to be filtered. - * @type {Array} - * @memberof SavedSearchDetailFiltersV2026 - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof SavedSearchDetailFiltersV2026 - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface SavedSearchDetailV2026 - */ -export interface SavedSearchDetailV2026 { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2026 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetailV2026 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchDetailV2026 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2026 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchDetailV2026 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchDetailV2026 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetailV2026 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchDetailV2026 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2026} - * @memberof SavedSearchDetailV2026 - */ - 'filters'?: SavedSearchDetailFiltersV2026 | null; -} -/** - * - * @export - * @interface SavedSearchNameV2026 - */ -export interface SavedSearchNameV2026 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchNameV2026 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchNameV2026 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface SavedSearchV2026 - */ -export interface SavedSearchV2026 { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchV2026 - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchV2026 - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2026 - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchV2026 - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchV2026 - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2026 - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchV2026 - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchV2026 - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchV2026 - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchV2026 - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFiltersV2026} - * @memberof SavedSearchV2026 - */ - 'filters'?: SavedSearchDetailFiltersV2026 | null; - /** - * The saved search ID. - * @type {string} - * @memberof SavedSearchV2026 - */ - 'id'?: string; - /** - * - * @type {TypedReferenceV2026} - * @memberof SavedSearchV2026 - */ - 'owner'?: TypedReferenceV2026; - /** - * The ID of the identity that owns this saved search. - * @type {string} - * @memberof SavedSearchV2026 - */ - 'ownerId'?: string; - /** - * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - * @type {boolean} - * @memberof SavedSearchV2026 - */ - 'public'?: boolean; -} -/** - * - * @export - * @interface Schedule1V2026 - */ -export interface Schedule1V2026 { - /** - * The type of the Schedule. - * @type {string} - * @memberof Schedule1V2026 - */ - 'type': Schedule1V2026TypeV2026; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof Schedule1V2026 - */ - 'cronExpression': string; -} - -export const Schedule1V2026TypeV2026 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type Schedule1V2026TypeV2026 = typeof Schedule1V2026TypeV2026[keyof typeof Schedule1V2026TypeV2026]; - -/** - * - * @export - * @interface Schedule2DaysV2026 - */ -export interface Schedule2DaysV2026 { - /** - * - * @type {SelectorTypeV2026} - * @memberof Schedule2DaysV2026 - */ - 'type': SelectorTypeV2026; - /** - * The selected values. - * @type {Array} - * @memberof Schedule2DaysV2026 - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule2DaysV2026 - */ - 'interval'?: number | null; -} - - -/** - * - * @export - * @interface Schedule2HoursV2026 - */ -export interface Schedule2HoursV2026 { - /** - * - * @type {SelectorTypeV2026} - * @memberof Schedule2HoursV2026 - */ - 'type': SelectorTypeV2026; - /** - * The selected values. - * @type {Array} - * @memberof Schedule2HoursV2026 - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule2HoursV2026 - */ - 'interval'?: number | null; -} - - -/** - * - * @export - * @interface Schedule2MonthsV2026 - */ -export interface Schedule2MonthsV2026 { - /** - * - * @type {SelectorTypeV2026} - * @memberof Schedule2MonthsV2026 - */ - 'type': SelectorTypeV2026; - /** - * The selected values. - * @type {Array} - * @memberof Schedule2MonthsV2026 - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule2MonthsV2026 - */ - 'interval'?: number | null; -} - - -/** - * The schedule information. - * @export - * @interface Schedule2V2026 - */ -export interface Schedule2V2026 { - /** - * - * @type {ScheduleTypeV2026} - * @memberof Schedule2V2026 - */ - 'type': ScheduleTypeV2026; - /** - * - * @type {Schedule2MonthsV2026} - * @memberof Schedule2V2026 - */ - 'months'?: Schedule2MonthsV2026; - /** - * - * @type {Schedule2DaysV2026} - * @memberof Schedule2V2026 - */ - 'days'?: Schedule2DaysV2026; - /** - * - * @type {Schedule2HoursV2026} - * @memberof Schedule2V2026 - */ - 'hours': Schedule2HoursV2026; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Schedule2V2026 - */ - 'expiration'?: string | null; - /** - * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. - * @type {string} - * @memberof Schedule2V2026 - */ - 'timeZoneId'?: string | null; -} - - -/** - * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" - * @export - * @interface ScheduleDaysV2026 - */ -export interface ScheduleDaysV2026 { - /** - * Enum type to specify days value - * @type {string} - * @memberof ScheduleDaysV2026 - */ - 'type': ScheduleDaysV2026TypeV2026; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleDaysV2026 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleDaysV2026 - */ - 'interval'?: number | null; -} - -export const ScheduleDaysV2026TypeV2026 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleDaysV2026TypeV2026 = typeof ScheduleDaysV2026TypeV2026[keyof typeof ScheduleDaysV2026TypeV2026]; - -/** - * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" - * @export - * @interface ScheduleHoursV2026 - */ -export interface ScheduleHoursV2026 { - /** - * Enum type to specify hours value - * @type {string} - * @memberof ScheduleHoursV2026 - */ - 'type': ScheduleHoursV2026TypeV2026; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleHoursV2026 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleHoursV2026 - */ - 'interval'?: number | null; -} - -export const ScheduleHoursV2026TypeV2026 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleHoursV2026TypeV2026 = typeof ScheduleHoursV2026TypeV2026[keyof typeof ScheduleHoursV2026TypeV2026]; - -/** - * - * @export - * @interface ScheduleInfoV2026 - */ -export interface ScheduleInfoV2026 { - /** - * The unique identifier for the scheduled task. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'scheduleTaskId'?: number; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2026 - */ - 'scheduleTaskName'?: string | null; - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2026 - */ - 'taskTypeName'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'interval'?: number; - /** - * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. - * @type {string} - * @memberof ScheduleInfoV2026 - */ - 'scheduleType'?: string | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof ScheduleInfoV2026 - */ - 'active'?: boolean; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'startTime'?: number | null; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'endTime'?: number | null; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof ScheduleInfoV2026 - */ - 'daysOfWeek'?: Array | null; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The name of the scheduled task that must complete before this task runs. - * @type {string} - * @memberof ScheduleInfoV2026 - */ - 'runAfterScheduleTaskName'?: string | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'applicationId'?: number | null; - /** - * The display name of the user who created the scheduled task. - * @type {string} - * @memberof ScheduleInfoV2026 - */ - 'createdByDisplayName'?: string | null; - /** - * The next scheduled run time for the task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'nextRun'?: number | null; - /** - * The last run time of the task, represented as epoch seconds. - * @type {number} - * @memberof ScheduleInfoV2026 - */ - 'lastRun'?: number | null; -} -/** - * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 - * @export - * @interface ScheduleMonthsV2026 - */ -export interface ScheduleMonthsV2026 { - /** - * Enum type to specify months value - * @type {string} - * @memberof ScheduleMonthsV2026 - */ - 'type': ScheduleMonthsV2026TypeV2026; - /** - * Values of the months based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleMonthsV2026 - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleMonthsV2026 - */ - 'interval'?: number; -} - -export const ScheduleMonthsV2026TypeV2026 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleMonthsV2026TypeV2026 = typeof ScheduleMonthsV2026TypeV2026[keyof typeof ScheduleMonthsV2026TypeV2026]; - -/** - * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const ScheduleTypeV2026 = { - Daily: 'DAILY', - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Calendar: 'CALENDAR', - Annually: 'ANNUALLY' -} as const; - -export type ScheduleTypeV2026 = typeof ScheduleTypeV2026[keyof typeof ScheduleTypeV2026]; - - -/** - * - * @export - * @interface ScheduleV2026 - */ -export interface ScheduleV2026 { - /** - * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. - * @type {string} - * @memberof ScheduleV2026 - */ - 'type': ScheduleV2026TypeV2026; - /** - * - * @type {ScheduleMonthsV2026} - * @memberof ScheduleV2026 - */ - 'months'?: ScheduleMonthsV2026 | null; - /** - * - * @type {ScheduleDaysV2026} - * @memberof ScheduleV2026 - */ - 'days'?: ScheduleDaysV2026; - /** - * - * @type {ScheduleHoursV2026} - * @memberof ScheduleV2026 - */ - 'hours': ScheduleHoursV2026; - /** - * Specifies the time after which this schedule will no longer occur. - * @type {string} - * @memberof ScheduleV2026 - */ - 'expiration'?: string | null; - /** - * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. - * @type {string} - * @memberof ScheduleV2026 - */ - 'timeZoneId'?: string; -} - -export const ScheduleV2026TypeV2026 = { - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Annually: 'ANNUALLY', - Calendar: 'CALENDAR' -} as const; - -export type ScheduleV2026TypeV2026 = typeof ScheduleV2026TypeV2026[keyof typeof ScheduleV2026TypeV2026]; - -/** - * Options for BACKUP type jobs. Required for BACKUP jobs. - * @export - * @interface ScheduledActionPayloadContentBackupOptionsV2026 - */ -export interface ScheduledActionPayloadContentBackupOptionsV2026 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionPayloadContentBackupOptionsV2026 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026; }} - * @memberof ScheduledActionPayloadContentBackupOptionsV2026 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026; }; -} -/** - * - * @export - * @interface ScheduledActionPayloadContentV2026 - */ -export interface ScheduledActionPayloadContentV2026 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionPayloadContentV2026 - */ - 'name': string; - /** - * - * @type {ScheduledActionPayloadContentBackupOptionsV2026} - * @memberof ScheduledActionPayloadContentV2026 - */ - 'backupOptions'?: ScheduledActionPayloadContentBackupOptionsV2026; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2026 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2026 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. - * @type {string} - * @memberof ScheduledActionPayloadContentV2026 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionPayloadV2026 - */ -export interface ScheduledActionPayloadV2026 { - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionPayloadV2026 - */ - 'jobType': ScheduledActionPayloadV2026JobTypeV2026; - /** - * The time when this scheduled action should start. Optional. - * @type {string} - * @memberof ScheduledActionPayloadV2026 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. Optional for repeated events. - * @type {string} - * @memberof ScheduledActionPayloadV2026 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. Optional, will default to current time zone. - * @type {string} - * @memberof ScheduledActionPayloadV2026 - */ - 'timeZoneId'?: string; - /** - * - * @type {ScheduledActionPayloadContentV2026} - * @memberof ScheduledActionPayloadV2026 - */ - 'content': ScheduledActionPayloadContentV2026; -} - -export const ScheduledActionPayloadV2026JobTypeV2026 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionPayloadV2026JobTypeV2026 = typeof ScheduledActionPayloadV2026JobTypeV2026[keyof typeof ScheduledActionPayloadV2026JobTypeV2026]; - -/** - * - * @export - * @interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026 - */ -export interface ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026 { - /** - * Set of names to be included. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026 - */ - 'includedNames'?: Array; -} -/** - * Options for BACKUP type jobs. Optional, applicable for BACKUP jobs only. - * @export - * @interface ScheduledActionResponseContentBackupOptionsV2026 - */ -export interface ScheduledActionResponseContentBackupOptionsV2026 { - /** - * Object types that are to be included in the backup. - * @type {Array} - * @memberof ScheduledActionResponseContentBackupOptionsV2026 - */ - 'includeTypes'?: Array; - /** - * Map of objectType string to the options to be passed to the target service for that objectType. - * @type {{ [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026; }} - * @memberof ScheduledActionResponseContentBackupOptionsV2026 - */ - 'objectOptions'?: { [key: string]: ScheduledActionResponseContentBackupOptionsObjectOptionsValueV2026; }; -} -/** - * Content details for the scheduled action. - * @export - * @interface ScheduledActionResponseContentV2026 - */ -export interface ScheduledActionResponseContentV2026 { - /** - * Name of the scheduled action (maximum 50 characters). - * @type {string} - * @memberof ScheduledActionResponseContentV2026 - */ - 'name'?: string; - /** - * - * @type {ScheduledActionResponseContentBackupOptionsV2026} - * @memberof ScheduledActionResponseContentV2026 - */ - 'backupOptions'?: ScheduledActionResponseContentBackupOptionsV2026; - /** - * ID of the source backup. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2026 - */ - 'sourceBackupId'?: string; - /** - * Source tenant identifier. Required for CREATE_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2026 - */ - 'sourceTenant'?: string; - /** - * ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. - * @type {string} - * @memberof ScheduledActionResponseContentV2026 - */ - 'draftId'?: string; -} -/** - * - * @export - * @interface ScheduledActionResponseV2026 - */ -export interface ScheduledActionResponseV2026 { - /** - * Unique identifier for this scheduled action. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'id'?: string; - /** - * The time when this scheduled action was created. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'created'?: string; - /** - * Type of the scheduled job. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'jobType'?: ScheduledActionResponseV2026JobTypeV2026; - /** - * - * @type {ScheduledActionResponseContentV2026} - * @memberof ScheduledActionResponseV2026 - */ - 'content'?: ScheduledActionResponseContentV2026; - /** - * The time when this scheduled action should start. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'startTime'?: string; - /** - * Cron expression defining the schedule for this action. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'cronString'?: string; - /** - * Time zone ID for interpreting the cron expression. - * @type {string} - * @memberof ScheduledActionResponseV2026 - */ - 'timeZoneId'?: string; -} - -export const ScheduledActionResponseV2026JobTypeV2026 = { - Backup: 'BACKUP', - CreateDraft: 'CREATE_DRAFT', - ConfigDeployDraft: 'CONFIG_DEPLOY_DRAFT' -} as const; - -export type ScheduledActionResponseV2026JobTypeV2026 = typeof ScheduledActionResponseV2026JobTypeV2026[keyof typeof ScheduledActionResponseV2026JobTypeV2026]; - -/** - * Attributes related to a scheduled trigger - * @export - * @interface ScheduledAttributesV2026 - */ -export interface ScheduledAttributesV2026 { - /** - * Frequency of execution - * @type {string} - * @memberof ScheduledAttributesV2026 - */ - 'frequency': ScheduledAttributesV2026FrequencyV2026 | null; - /** - * Time zone identifier - * @type {string} - * @memberof ScheduledAttributesV2026 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof ScheduledAttributesV2026 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof ScheduledAttributesV2026 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2026 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributesV2026 - */ - 'yearlyTimes'?: Array | null; -} - -export const ScheduledAttributesV2026FrequencyV2026 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type ScheduledAttributesV2026FrequencyV2026 = typeof ScheduledAttributesV2026FrequencyV2026[keyof typeof ScheduledAttributesV2026FrequencyV2026]; - -/** - * The owner of the scheduled search - * @export - * @interface ScheduledSearchAllOfOwnerV2026 - */ -export interface ScheduledSearchAllOfOwnerV2026 { - /** - * The type of object being referenced - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2026 - */ - 'type': ScheduledSearchAllOfOwnerV2026TypeV2026; - /** - * The ID of the referenced object - * @type {string} - * @memberof ScheduledSearchAllOfOwnerV2026 - */ - 'id': string; -} - -export const ScheduledSearchAllOfOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type ScheduledSearchAllOfOwnerV2026TypeV2026 = typeof ScheduledSearchAllOfOwnerV2026TypeV2026[keyof typeof ScheduledSearchAllOfOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface ScheduledSearchNameV2026 - */ -export interface ScheduledSearchNameV2026 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2026 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchNameV2026 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface ScheduledSearchV2026 - */ -export interface ScheduledSearchV2026 { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2026} - * @memberof ScheduledSearchV2026 - */ - 'schedule': Schedule2V2026; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof ScheduledSearchV2026 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof ScheduledSearchV2026 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof ScheduledSearchV2026 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof ScheduledSearchV2026 - */ - 'displayQueryDetails'?: boolean; - /** - * The scheduled search ID. - * @type {string} - * @memberof ScheduledSearchV2026 - */ - 'id': string; - /** - * - * @type {ScheduledSearchAllOfOwnerV2026} - * @memberof ScheduledSearchV2026 - */ - 'owner': ScheduledSearchAllOfOwnerV2026; - /** - * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. - * @type {string} - * @memberof ScheduledSearchV2026 - * @deprecated - */ - 'ownerId': string; -} -/** - * - * @export - * @interface SchemaV2026 - */ -export interface SchemaV2026 { - /** - * The id of the Schema. - * @type {string} - * @memberof SchemaV2026 - */ - 'id'?: string; - /** - * The name of the Schema. - * @type {string} - * @memberof SchemaV2026 - */ - 'name'?: string; - /** - * The name of the object type on the native system that the schema represents. - * @type {string} - * @memberof SchemaV2026 - */ - 'nativeObjectType'?: string; - /** - * The name of the attribute used to calculate the unique identifier for an object in the schema. - * @type {string} - * @memberof SchemaV2026 - */ - 'identityAttribute'?: string; - /** - * The name of the attribute used to calculate the display value for an object in the schema. - * @type {string} - * @memberof SchemaV2026 - */ - 'displayAttribute'?: string; - /** - * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - * @type {string} - * @memberof SchemaV2026 - */ - 'hierarchyAttribute'?: string | null; - /** - * Flag indicating whether or not the include permissions with the object data when aggregating the schema. - * @type {boolean} - * @memberof SchemaV2026 - */ - 'includePermissions'?: boolean; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SchemaV2026 - */ - 'features'?: Array; - /** - * Holds any extra configuration data that the schema may require. - * @type {object} - * @memberof SchemaV2026 - */ - 'configuration'?: object; - /** - * The attribute definitions which form the schema. - * @type {Array} - * @memberof SchemaV2026 - */ - 'attributes'?: Array; - /** - * The date the Schema was created. - * @type {string} - * @memberof SchemaV2026 - */ - 'created'?: string; - /** - * The date the Schema was last modified. - * @type {string} - * @memberof SchemaV2026 - */ - 'modified'?: string | null; -} - -export const SchemaV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SchemaV2026FeaturesV2026 = typeof SchemaV2026FeaturesV2026[keyof typeof SchemaV2026FeaturesV2026]; - -/** - * An enumeration of the types of scope choices - * @export - * @enum {string} - */ - -export const ScopeTypeV2026 = { - Entitlement: 'ENTITLEMENT', - Certification: 'CERTIFICATION', - Identity: 'IDENTITY', - Entitlementrequest: 'ENTITLEMENTREQUEST' -} as const; - -export type ScopeTypeV2026 = typeof ScopeTypeV2026[keyof typeof ScopeTypeV2026]; - - -/** - * This defines what access the segment is giving - * @export - * @interface ScopeV2026 - */ -export interface ScopeV2026 { - /** - * - * @type {ScopeTypeV2026} - * @memberof ScopeV2026 - */ - 'scope'?: ScopeTypeV2026; - /** - * - * @type {ScopeVisibilityTypeV2026} - * @memberof ScopeV2026 - */ - 'visibility'?: ScopeVisibilityTypeV2026; - /** - * - * @type {VisibilityCriteriaV2026} - * @memberof ScopeV2026 - */ - 'scopeFilter'?: VisibilityCriteriaV2026; - /** - * List of Identities that are assigned to the segment - * @type {Array} - * @memberof ScopeV2026 - */ - 'scopeSelection'?: Array; -} - - -/** - * An enumeration of the types of scope visibility choices - * @export - * @enum {string} - */ - -export const ScopeVisibilityTypeV2026 = { - All: 'ALL', - Filter: 'FILTER', - Selection: 'SELECTION', - Unsegmented: 'UNSEGMENTED' -} as const; - -export type ScopeVisibilityTypeV2026 = typeof ScopeVisibilityTypeV2026[keyof typeof ScopeVisibilityTypeV2026]; - - -/** - * - * @export - * @interface SearchAggregationSpecificationV2026 - */ -export interface SearchAggregationSpecificationV2026 { - /** - * - * @type {NestedAggregationV2026} - * @memberof SearchAggregationSpecificationV2026 - */ - 'nested'?: NestedAggregationV2026; - /** - * - * @type {MetricAggregationV2026} - * @memberof SearchAggregationSpecificationV2026 - */ - 'metric'?: MetricAggregationV2026; - /** - * - * @type {FilterAggregationV2026} - * @memberof SearchAggregationSpecificationV2026 - */ - 'filter'?: FilterAggregationV2026; - /** - * - * @type {BucketAggregationV2026} - * @memberof SearchAggregationSpecificationV2026 - */ - 'bucket'?: BucketAggregationV2026; - /** - * - * @type {SubSearchAggregationSpecificationV2026} - * @memberof SearchAggregationSpecificationV2026 - */ - 'subAggregation'?: SubSearchAggregationSpecificationV2026; -} -/** - * - * @export - * @interface SearchArgumentsV2026 - */ -export interface SearchArgumentsV2026 { - /** - * The ID of the scheduled search that triggered the saved search execution. - * @type {string} - * @memberof SearchArgumentsV2026 - */ - 'scheduleId'?: string; - /** - * The owner of the scheduled search being tested. - * @type {TypedReferenceV2026} - * @memberof SearchArgumentsV2026 - */ - 'owner'?: TypedReferenceV2026; - /** - * The email recipients of the scheduled search being tested. - * @type {Array} - * @memberof SearchArgumentsV2026 - */ - 'recipients'?: Array; -} -/** - * - * @export - * @interface SearchAttributeConfigV2026 - */ -export interface SearchAttributeConfigV2026 { - /** - * Name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2026 - */ - 'name'?: string; - /** - * The display name of the new attribute - * @type {string} - * @memberof SearchAttributeConfigV2026 - */ - 'displayName'?: string; - /** - * Map of application id and their associated attribute. - * @type {object} - * @memberof SearchAttributeConfigV2026 - */ - 'applicationAttributes'?: object; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeLowerV2026 - */ -export interface SearchCriteriaFiltersValueRangeLowerV2026 { - /** - * The lower bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeLowerV2026 - */ - 'value'?: string; - /** - * Whether the lower bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeLowerV2026 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeUpperV2026 - */ -export interface SearchCriteriaFiltersValueRangeUpperV2026 { - /** - * The upper bound value. - * @type {string} - * @memberof SearchCriteriaFiltersValueRangeUpperV2026 - */ - 'value'?: string; - /** - * Whether the upper bound is inclusive. - * @type {boolean} - * @memberof SearchCriteriaFiltersValueRangeUpperV2026 - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueRangeV2026 - */ -export interface SearchCriteriaFiltersValueRangeV2026 { - /** - * - * @type {SearchCriteriaFiltersValueRangeLowerV2026} - * @memberof SearchCriteriaFiltersValueRangeV2026 - */ - 'lower'?: SearchCriteriaFiltersValueRangeLowerV2026; - /** - * - * @type {SearchCriteriaFiltersValueRangeUpperV2026} - * @memberof SearchCriteriaFiltersValueRangeV2026 - */ - 'upper'?: SearchCriteriaFiltersValueRangeUpperV2026; -} -/** - * - * @export - * @interface SearchCriteriaFiltersValueV2026 - */ -export interface SearchCriteriaFiltersValueV2026 { - /** - * The type of filter, e.g., \"TERMS\" or \"RANGE\". - * @type {string} - * @memberof SearchCriteriaFiltersValueV2026 - */ - 'type'?: string; - /** - * Terms to filter by (for \"TERMS\" type). - * @type {Array} - * @memberof SearchCriteriaFiltersValueV2026 - */ - 'terms'?: Array; - /** - * - * @type {SearchCriteriaFiltersValueRangeV2026} - * @memberof SearchCriteriaFiltersValueV2026 - */ - 'range'?: SearchCriteriaFiltersValueRangeV2026; -} -/** - * - * @export - * @interface SearchCriteriaQueryV2026 - */ -export interface SearchCriteriaQueryV2026 { - /** - * A structured query for advanced search. - * @type {string} - * @memberof SearchCriteriaQueryV2026 - */ - 'query'?: string; -} -/** - * - * @export - * @interface SearchCriteriaTextQueryV2026 - */ -export interface SearchCriteriaTextQueryV2026 { - /** - * Terms to search for. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2026 - */ - 'terms'?: Array; - /** - * Fields to search within. - * @type {Array} - * @memberof SearchCriteriaTextQueryV2026 - */ - 'fields'?: Array; - /** - * Whether to match any of the terms. - * @type {boolean} - * @memberof SearchCriteriaTextQueryV2026 - */ - 'matchAny'?: boolean; -} -/** - * Represents the search criteria for querying entitlements. - * @export - * @interface SearchCriteriaV2026 - */ -export interface SearchCriteriaV2026 { - /** - * A list of indices to search within. Must contain exactly one item, typically \"entitlements\". - * @type {Array} - * @memberof SearchCriteriaV2026 - */ - 'indices': Array; - /** - * A map of filters applied to the search. Keys are filter names, and values are filter definitions. - * @type {{ [key: string]: SearchCriteriaFiltersValueV2026; }} - * @memberof SearchCriteriaV2026 - */ - 'filters'?: { [key: string]: SearchCriteriaFiltersValueV2026; }; - /** - * - * @type {SearchCriteriaQueryV2026} - * @memberof SearchCriteriaV2026 - */ - 'query'?: SearchCriteriaQueryV2026; - /** - * Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. - * @type {string} - * @memberof SearchCriteriaV2026 - */ - 'queryType'?: string; - /** - * - * @type {SearchCriteriaTextQueryV2026} - * @memberof SearchCriteriaV2026 - */ - 'textQuery'?: SearchCriteriaTextQueryV2026; - /** - * Whether to include nested objects in the search results. - * @type {boolean} - * @memberof SearchCriteriaV2026 - */ - 'includeNested'?: boolean; - /** - * Specifies the sorting order for the results. - * @type {Array} - * @memberof SearchCriteriaV2026 - */ - 'sort'?: Array; - /** - * Used for pagination to fetch results after a specific point. - * @type {Array} - * @memberof SearchCriteriaV2026 - */ - 'searchAfter'?: Array; -} -/** - * @type SearchDocumentV2026 - * @export - */ -export type SearchDocumentV2026 = AccessProfileDocumentV2026 | AccountActivityDocumentV2026 | EntitlementDocumentV2026 | EventDocumentV2026 | IdentityDocumentV2026 | RoleDocumentV2026; - -/** - * @type SearchDocumentsV2026 - * @export - */ -export type SearchDocumentsV2026 = AccessProfileDocumentsV2026 | AccountActivityDocumentsV2026 | EntitlementDocumentsV2026 | EventDocumentsV2026 | IdentityDocumentsV2026 | RoleDocumentsV2026; - -/** - * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. - * @export - * @interface SearchExportReportArgumentsV2026 - */ -export interface SearchExportReportArgumentsV2026 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchExportReportArgumentsV2026 - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof SearchExportReportArgumentsV2026 - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof SearchExportReportArgumentsV2026 - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchExportReportArgumentsV2026 - */ - 'sort'?: Array; -} -/** - * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SearchFilterTypeV2026 = { - Term: 'TERM' -} as const; - -export type SearchFilterTypeV2026 = typeof SearchFilterTypeV2026[keyof typeof SearchFilterTypeV2026]; - - -/** - * - * @export - * @interface SearchFormDefinitionsByTenant400ResponseV2026 - */ -export interface SearchFormDefinitionsByTenant400ResponseV2026 { - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2026 - */ - 'detailCode'?: string; - /** - * - * @type {Array} - * @memberof SearchFormDefinitionsByTenant400ResponseV2026 - */ - 'messages'?: Array; - /** - * - * @type {number} - * @memberof SearchFormDefinitionsByTenant400ResponseV2026 - */ - 'statusCode'?: number; - /** - * - * @type {string} - * @memberof SearchFormDefinitionsByTenant400ResponseV2026 - */ - 'trackingId'?: string; -} -/** - * - * @export - * @interface SearchScheduleRecipientsInnerV2026 - */ -export interface SearchScheduleRecipientsInnerV2026 { - /** - * The type of object being referenced - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2026 - */ - 'type': SearchScheduleRecipientsInnerV2026TypeV2026; - /** - * The ID of the referenced object - * @type {string} - * @memberof SearchScheduleRecipientsInnerV2026 - */ - 'id': string; -} - -export const SearchScheduleRecipientsInnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SearchScheduleRecipientsInnerV2026TypeV2026 = typeof SearchScheduleRecipientsInnerV2026TypeV2026[keyof typeof SearchScheduleRecipientsInnerV2026TypeV2026]; - -/** - * - * @export - * @interface SearchScheduleV2026 - */ -export interface SearchScheduleV2026 { - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof SearchScheduleV2026 - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof SearchScheduleV2026 - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof SearchScheduleV2026 - */ - 'modified'?: string | null; - /** - * - * @type {Schedule2V2026} - * @memberof SearchScheduleV2026 - */ - 'schedule': Schedule2V2026; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof SearchScheduleV2026 - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof SearchScheduleV2026 - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof SearchScheduleV2026 - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof SearchScheduleV2026 - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface SearchV2026 - */ -export interface SearchV2026 { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchV2026 - */ - 'indices'?: Array; - /** - * - * @type {QueryTypeV2026} - * @memberof SearchV2026 - */ - 'queryType'?: QueryTypeV2026; - /** - * - * @type {string} - * @memberof SearchV2026 - */ - 'queryVersion'?: string; - /** - * - * @type {QueryV2026} - * @memberof SearchV2026 - */ - 'query'?: QueryV2026; - /** - * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - * @type {object} - * @memberof SearchV2026 - */ - 'queryDsl'?: object; - /** - * - * @type {TextQueryV2026} - * @memberof SearchV2026 - */ - 'textQuery'?: TextQueryV2026; - /** - * - * @type {TypeAheadQueryV2026} - * @memberof SearchV2026 - */ - 'typeAheadQuery'?: TypeAheadQueryV2026; - /** - * Indicates whether nested objects from returned search results should be included. - * @type {boolean} - * @memberof SearchV2026 - */ - 'includeNested'?: boolean; - /** - * - * @type {QueryResultFilterV2026} - * @memberof SearchV2026 - */ - 'queryResultFilter'?: QueryResultFilterV2026; - /** - * - * @type {AggregationTypeV2026} - * @memberof SearchV2026 - */ - 'aggregationType'?: AggregationTypeV2026; - /** - * - * @type {string} - * @memberof SearchV2026 - */ - 'aggregationsVersion'?: string; - /** - * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - * @type {object} - * @memberof SearchV2026 - */ - 'aggregationsDsl'?: object; - /** - * - * @type {SearchAggregationSpecificationV2026} - * @memberof SearchV2026 - */ - 'aggregations'?: SearchAggregationSpecificationV2026; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchV2026 - */ - 'sort'?: Array; - /** - * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] - * @type {Array} - * @memberof SearchV2026 - */ - 'searchAfter'?: Array; - /** - * The filters to be applied for each filtered field name. - * @type {{ [key: string]: FilterV2026; }} - * @memberof SearchV2026 - */ - 'filters'?: { [key: string]: FilterV2026; }; -} - - -/** - * - * @export - * @interface SectionDetailsV2026 - */ -export interface SectionDetailsV2026 { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionDetailsV2026 - */ - 'name'?: string | null; - /** - * Label of the section - * @type {string} - * @memberof SectionDetailsV2026 - */ - 'label'?: string | null; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionDetailsV2026 - */ - 'formItems'?: Array; -} -/** - * SED Approval Status - * @export - * @interface SedApprovalStatusV2026 - */ -export interface SedApprovalStatusV2026 { - /** - * failed reason will be display if status is failed - * @type {string} - * @memberof SedApprovalStatusV2026 - */ - 'failedReason'?: string; - /** - * Sed id - * @type {string} - * @memberof SedApprovalStatusV2026 - */ - 'id'?: string; - /** - * SUCCESS | FAILED - * @type {string} - * @memberof SedApprovalStatusV2026 - */ - 'status'?: string; -} -/** - * Sed Approval Request Body - * @export - * @interface SedApprovalV2026 - */ -export interface SedApprovalV2026 { - /** - * List of SED id\'s - * @type {Array} - * @memberof SedApprovalV2026 - */ - 'items'?: Array; -} -/** - * Sed Assignee - * @export - * @interface SedAssigneeV2026 - */ -export interface SedAssigneeV2026 { - /** - * Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE - * @type {string} - * @memberof SedAssigneeV2026 - */ - 'type': SedAssigneeV2026TypeV2026; - /** - * Identity or Group identifier Empty when using source/entitlement owner personas - * @type {string} - * @memberof SedAssigneeV2026 - */ - 'value'?: string; -} - -export const SedAssigneeV2026TypeV2026 = { - Identity: 'IDENTITY', - Group: 'GROUP', - SourceOwner: 'SOURCE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER' -} as const; - -export type SedAssigneeV2026TypeV2026 = typeof SedAssigneeV2026TypeV2026[keyof typeof SedAssigneeV2026TypeV2026]; - -/** - * Sed Assignment Response - * @export - * @interface SedAssignmentResponseV2026 - */ -export interface SedAssignmentResponseV2026 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedAssignmentResponseV2026 - */ - 'batchId'?: string; -} -/** - * Sed Assignment - * @export - * @interface SedAssignmentV2026 - */ -export interface SedAssignmentV2026 { - /** - * - * @type {SedAssigneeV2026} - * @memberof SedAssignmentV2026 - */ - 'assignee'?: SedAssigneeV2026; - /** - * List of SED id\'s - * @type {Array} - * @memberof SedAssignmentV2026 - */ - 'items'?: Array; -} -/** - * Sed Batch Record - * @export - * @interface SedBatchRecordV2026 - */ -export interface SedBatchRecordV2026 { - /** - * The tenant ID associated with the batch. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'tenantId'?: string; - /** - * The unique ID of the batch. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'batchId'?: string; - /** - * The name of the batch. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'name'?: string | null; - /** - * The current state of the batch (e.g., submitted, materialized, completed). - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'processedState'?: string | null; - /** - * The ID of the user who requested the batch. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'requestedBy'?: string; - /** - * The number of items materialized in the batch. - * @type {number} - * @memberof SedBatchRecordV2026 - */ - 'materializedCount'?: number; - /** - * The number of items processed in the batch. - * @type {number} - * @memberof SedBatchRecordV2026 - */ - 'processedCount'?: number; - /** - * The timestamp when the batch was created. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'createdAt'?: string; - /** - * The timestamp when the batch was last updated. - * @type {string} - * @memberof SedBatchRecordV2026 - */ - 'updatedAt'?: string | null; -} -/** - * Sed Batch Request - * @export - * @interface SedBatchRequestV2026 - */ -export interface SedBatchRequestV2026 { - /** - * list of entitlement ids - * @type {Array} - * @memberof SedBatchRequestV2026 - */ - 'entitlements'?: Array | null; - /** - * list of sed ids - * @type {Array} - * @memberof SedBatchRequestV2026 - */ - 'seds'?: Array | null; - /** - * Search criteria for the batch request. - * @type {{ [key: string]: SearchCriteriaV2026; }} - * @memberof SedBatchRequestV2026 - */ - 'searchCriteria'?: { [key: string]: SearchCriteriaV2026; } | null; -} -/** - * Sed Batch Response - * @export - * @interface SedBatchResponseV2026 - */ -export interface SedBatchResponseV2026 { - /** - * BatchId that groups all the ids together - * @type {string} - * @memberof SedBatchResponseV2026 - */ - 'batchId'?: string; -} -/** - * Sed Batch Stats - * @export - * @interface SedBatchStatsV2026 - */ -export interface SedBatchStatsV2026 { - /** - * batch complete - * @type {boolean} - * @memberof SedBatchStatsV2026 - */ - 'batchComplete'?: boolean; - /** - * batch Id - * @type {string} - * @memberof SedBatchStatsV2026 - */ - 'batchId'?: string; - /** - * discovered count - * @type {number} - * @memberof SedBatchStatsV2026 - */ - 'discoveredCount'?: number; - /** - * discovery complete - * @type {boolean} - * @memberof SedBatchStatsV2026 - */ - 'discoveryComplete'?: boolean; - /** - * processed count - * @type {number} - * @memberof SedBatchStatsV2026 - */ - 'processedCount'?: number; -} -/** - * Patch for Suggested Entitlement Description - * @export - * @interface SedPatchV2026 - */ -export interface SedPatchV2026 { - /** - * desired operation - * @type {string} - * @memberof SedPatchV2026 - */ - 'op'?: string; - /** - * field to be patched - * @type {string} - * @memberof SedPatchV2026 - */ - 'path'?: string; - /** - * value to replace with - * @type {object} - * @memberof SedPatchV2026 - */ - 'value'?: object; -} -/** - * Suggested Entitlement Description - * @export - * @interface SedV2026 - */ -export interface SedV2026 { - /** - * name of the entitlement - * @type {string} - * @memberof SedV2026 - */ - 'Name'?: string; - /** - * entitlement approved by - * @type {string} - * @memberof SedV2026 - */ - 'approved_by'?: string; - /** - * entitlement approved type - * @type {string} - * @memberof SedV2026 - */ - 'approved_type'?: string; - /** - * entitlement approved then - * @type {string} - * @memberof SedV2026 - */ - 'approved_when'?: string; - /** - * entitlement attribute - * @type {string} - * @memberof SedV2026 - */ - 'attribute'?: string; - /** - * description of entitlement - * @type {string} - * @memberof SedV2026 - */ - 'description'?: string; - /** - * entitlement display name - * @type {string} - * @memberof SedV2026 - */ - 'displayName'?: string; - /** - * sed id - * @type {string} - * @memberof SedV2026 - */ - 'id'?: string; - /** - * entitlement source id - * @type {string} - * @memberof SedV2026 - */ - 'sourceId'?: string; - /** - * entitlement source name - * @type {string} - * @memberof SedV2026 - */ - 'sourceName'?: string; - /** - * entitlement status - * @type {string} - * @memberof SedV2026 - */ - 'status'?: string; - /** - * llm suggested entitlement description - * @type {string} - * @memberof SedV2026 - */ - 'suggestedDescription'?: string; - /** - * entitlement type - * @type {string} - * @memberof SedV2026 - */ - 'type'?: string; - /** - * entitlement value - * @type {string} - * @memberof SedV2026 - */ - 'value'?: string; -} -/** - * - * @export - * @interface SegmentV2026 - */ -export interface SegmentV2026 { - /** - * The segment\'s ID. - * @type {string} - * @memberof SegmentV2026 - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof SegmentV2026 - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof SegmentV2026 - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof SegmentV2026 - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof SegmentV2026 - */ - 'description'?: string; - /** - * - * @type {OwnerReferenceSegmentsV2026} - * @memberof SegmentV2026 - */ - 'owner'?: OwnerReferenceSegmentsV2026 | null; - /** - * - * @type {SegmentVisibilityCriteriaV2026} - * @memberof SegmentV2026 - */ - 'visibilityCriteria'?: SegmentVisibilityCriteriaV2026; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof SegmentV2026 - */ - 'active'?: boolean; -} -/** - * - * @export - * @interface SegmentVisibilityCriteriaV2026 - */ -export interface SegmentVisibilityCriteriaV2026 { - /** - * - * @type {ExpressionV2026} - * @memberof SegmentVisibilityCriteriaV2026 - */ - 'expression'?: ExpressionV2026; -} -/** - * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SelectorTypeV2026 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type SelectorTypeV2026 = typeof SelectorTypeV2026[keyof typeof SelectorTypeV2026]; - - -/** - * - * @export - * @interface SelectorV2026 - */ -export interface SelectorV2026 { - /** - * - * @type {SelectorTypeV2026} - * @memberof SelectorV2026 - */ - 'type': SelectorTypeV2026; - /** - * The selected values. - * @type {Array} - * @memberof SelectorV2026 - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof SelectorV2026 - */ - 'interval'?: number | null; -} - - -/** - * Self block for imported/exported object. - * @export - * @interface SelfImportExportDtoV2026 - */ -export interface SelfImportExportDtoV2026 { - /** - * Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. - * @type {string} - * @memberof SelfImportExportDtoV2026 - */ - 'type'?: SelfImportExportDtoV2026TypeV2026; - /** - * Imported/exported object\'s ID. - * @type {string} - * @memberof SelfImportExportDtoV2026 - */ - 'id'?: string; - /** - * Imported/exported object\'s display name. - * @type {string} - * @memberof SelfImportExportDtoV2026 - */ - 'name'?: string; -} - -export const SelfImportExportDtoV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - ConnectorRule: 'CONNECTOR_RULE', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type SelfImportExportDtoV2026TypeV2026 = typeof SelfImportExportDtoV2026TypeV2026[keyof typeof SelfImportExportDtoV2026TypeV2026]; - -/** - * - * @export - * @interface SendAccountVerificationRequestV2026 - */ -export interface SendAccountVerificationRequestV2026 { - /** - * The source name where identity account password should be reset - * @type {string} - * @memberof SendAccountVerificationRequestV2026 - */ - 'sourceName'?: string | null; - /** - * The method to send notification - * @type {string} - * @memberof SendAccountVerificationRequestV2026 - */ - 'via': SendAccountVerificationRequestV2026ViaV2026; -} - -export const SendAccountVerificationRequestV2026ViaV2026 = { - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL', - LinkWork: 'LINK_WORK', - LinkPersonal: 'LINK_PERSONAL' -} as const; - -export type SendAccountVerificationRequestV2026ViaV2026 = typeof SendAccountVerificationRequestV2026ViaV2026[keyof typeof SendAccountVerificationRequestV2026ViaV2026]; - -/** - * - * @export - * @interface SendClassifyMachineAccount200ResponseV2026 - */ -export interface SendClassifyMachineAccount200ResponseV2026 { - /** - * Indicates if account is classified as machine - * @type {boolean} - * @memberof SendClassifyMachineAccount200ResponseV2026 - */ - 'isMachine'?: boolean; -} -/** - * - * @export - * @interface SendClassifyMachineAccountFromSource200ResponseV2026 - */ -export interface SendClassifyMachineAccountFromSource200ResponseV2026 { - /** - * Returns the number of all the accounts from source submitted for processing. - * @type {number} - * @memberof SendClassifyMachineAccountFromSource200ResponseV2026 - */ - 'Accounts submitted for processing'?: number; -} -/** - * - * @export - * @interface SendTestNotificationRequestDtoV2026 - */ -export interface SendTestNotificationRequestDtoV2026 { - /** - * The template notification key. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'key'?: string; - /** - * The notification medium. Has to be one of the following enum values. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'medium'?: SendTestNotificationRequestDtoV2026MediumV2026; - /** - * The locale for the message text. - * @type {string} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'locale'?: string; - /** - * A Json object that denotes the context specific to the template. - * @type {object} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'context'?: object; - /** - * A list of override recipient email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'recipientEmailList'?: Array; - /** - * A list of CC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'carbonCopy'?: Array; - /** - * A list of BCC email addresses for the test notification. - * @type {Array} - * @memberof SendTestNotificationRequestDtoV2026 - */ - 'blindCarbonCopy'?: Array; -} - -export const SendTestNotificationRequestDtoV2026MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type SendTestNotificationRequestDtoV2026MediumV2026 = typeof SendTestNotificationRequestDtoV2026MediumV2026[keyof typeof SendTestNotificationRequestDtoV2026MediumV2026]; - -/** - * - * @export - * @interface ServiceDeskIntegrationDtoV2026 - */ -export interface ServiceDeskIntegrationDtoV2026 { - /** - * Unique identifier for the Service Desk integration - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'id'?: string; - /** - * Service Desk integration\'s name. The name must be unique. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'name': string; - /** - * The date and time the Service Desk integration was created - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'created'?: string; - /** - * The date and time the Service Desk integration was last modified - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'modified'?: string; - /** - * Service Desk integration\'s description. - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'description': string; - /** - * Service Desk integration types: - ServiceNowSDIM - ServiceNow - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'type': string; - /** - * - * @type {OwnerDtoV2026} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'ownerRef'?: OwnerDtoV2026; - /** - * - * @type {SourceClusterDtoV2026} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'clusterRef'?: SourceClusterDtoV2026; - /** - * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - * @type {string} - * @memberof ServiceDeskIntegrationDtoV2026 - * @deprecated - */ - 'cluster'?: string | null; - /** - * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - * @type {Array} - * @memberof ServiceDeskIntegrationDtoV2026 - * @deprecated - */ - 'managedSources'?: Array; - /** - * - * @type {ProvisioningConfigV2026} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'provisioningConfig'?: ProvisioningConfigV2026; - /** - * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {BeforeProvisioningRuleDtoV2026} - * @memberof ServiceDeskIntegrationDtoV2026 - */ - 'beforeProvisioningRule'?: BeforeProvisioningRuleDtoV2026; -} -/** - * - * @export - * @interface ServiceDeskIntegrationTemplateDtoV2026 - */ -export interface ServiceDeskIntegrationTemplateDtoV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'modified'?: string; - /** - * The \'type\' property specifies the type of the Service Desk integration template. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'type': string; - /** - * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {ProvisioningConfigV2026} - * @memberof ServiceDeskIntegrationTemplateDtoV2026 - */ - 'provisioningConfig': ProvisioningConfigV2026; -} -/** - * This represents a Service Desk Integration template type. - * @export - * @interface ServiceDeskIntegrationTemplateTypeV2026 - */ -export interface ServiceDeskIntegrationTemplateTypeV2026 { - /** - * This is the name of the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2026 - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2026 - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateTypeV2026 - */ - 'scriptName': string; -} -/** - * Source for Service Desk integration template. - * @export - * @interface ServiceDeskSourceV2026 - */ -export interface ServiceDeskSourceV2026 { - /** - * DTO type of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2026 - */ - 'type'?: ServiceDeskSourceV2026TypeV2026; - /** - * ID of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2026 - */ - 'id'?: string; - /** - * Human-readable name of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSourceV2026 - */ - 'name'?: string; -} - -export const ServiceDeskSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type ServiceDeskSourceV2026TypeV2026 = typeof ServiceDeskSourceV2026TypeV2026[keyof typeof ServiceDeskSourceV2026TypeV2026]; - -/** - * - * @export - * @interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ -export interface ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 { - /** - * Federation protocol role - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerV2026RoleV2026; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'nameId'?: string; - /** - * - * @type {JITConfigurationV2026} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'jitConfiguration'?: JITConfigurationV2026; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'certificateName'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026 - */ - 'legacyAcsUrl'?: string; -} - -export const ServiceProviderConfigurationFederationProtocolDetailsInnerV2026RoleV2026 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type ServiceProviderConfigurationFederationProtocolDetailsInnerV2026RoleV2026 = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026RoleV2026[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerV2026RoleV2026]; - -/** - * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider - * @export - * @interface ServiceProviderConfigurationV2026 - */ -export interface ServiceProviderConfigurationV2026 { - /** - * This determines whether or not the SAML authentication flow is enabled for an org - * @type {boolean} - * @memberof ServiceProviderConfigurationV2026 - */ - 'enabled'?: boolean; - /** - * This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2026 - */ - 'bypassIdp'?: boolean; - /** - * This indicates whether or not the SAML configuration is valid. - * @type {boolean} - * @memberof ServiceProviderConfigurationV2026 - */ - 'samlConfigurationValid'?: boolean; - /** - * A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). - * @type {Array} - * @memberof ServiceProviderConfigurationV2026 - */ - 'federationProtocolDetails'?: Array; -} -/** - * - * @export - * @interface SessionConfigurationV2026 - */ -export interface SessionConfigurationV2026 { - /** - * The maximum time in minutes a session can be idle. - * @type {number} - * @memberof SessionConfigurationV2026 - */ - 'maxIdleTime'?: number; - /** - * Denotes if \'remember me\' is enabled. - * @type {boolean} - * @memberof SessionConfigurationV2026 - */ - 'rememberMe'?: boolean; - /** - * The maximum allowable session time in minutes. - * @type {number} - * @memberof SessionConfigurationV2026 - */ - 'maxSessionTime'?: number; -} -/** - * - * @export - * @interface SetIcon200ResponseV2026 - */ -export interface SetIcon200ResponseV2026 { - /** - * url to file with icon - * @type {string} - * @memberof SetIcon200ResponseV2026 - */ - 'icon'?: string; -} -/** - * - * @export - * @interface SetIconRequestV2026 - */ -export interface SetIconRequestV2026 { - /** - * file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] - * @type {File} - * @memberof SetIconRequestV2026 - */ - 'image': File; -} -/** - * - * @export - * @interface SetLifecycleState200ResponseV2026 - */ -export interface SetLifecycleState200ResponseV2026 { - /** - * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - * @type {string} - * @memberof SetLifecycleState200ResponseV2026 - */ - 'accountActivityId'?: string; -} -/** - * - * @export - * @interface SetLifecycleStateRequestV2026 - */ -export interface SetLifecycleStateRequestV2026 { - /** - * ID of the lifecycle state to set. - * @type {string} - * @memberof SetLifecycleStateRequestV2026 - */ - 'lifecycleStateId'?: string; -} -/** - * Before provisioning rule of integration - * @export - * @interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026 - */ -export interface SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026 - */ - 'type'?: DtoTypeV2026; - /** - * ID of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the rule - * @type {string} - * @memberof SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SimIntegrationDetailsV2026 - */ -export interface SimIntegrationDetailsV2026 { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'modified'?: string; - /** - * The description of the integration - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'description'?: string; - /** - * The integration type - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'type'?: string; - /** - * The attributes map containing the credentials used to configure the integration. - * @type {object} - * @memberof SimIntegrationDetailsV2026 - */ - 'attributes'?: object | null; - /** - * The list of sources (managed resources) - * @type {Array} - * @memberof SimIntegrationDetailsV2026 - */ - 'sources'?: Array; - /** - * The cluster/proxy - * @type {string} - * @memberof SimIntegrationDetailsV2026 - */ - 'cluster'?: string; - /** - * Custom mapping between the integration result and the provisioning result - * @type {object} - * @memberof SimIntegrationDetailsV2026 - */ - 'statusMap'?: object; - /** - * Request data to customize desc and body of the created ticket - * @type {object} - * @memberof SimIntegrationDetailsV2026 - */ - 'request'?: object; - /** - * - * @type {SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026} - * @memberof SimIntegrationDetailsV2026 - */ - 'beforeProvisioningRule'?: SimIntegrationDetailsAllOfBeforeProvisioningRuleV2026; -} -/** - * - * @export - * @interface SlimCampaignV2026 - */ -export interface SlimCampaignV2026 { - /** - * Id of the campaign - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'id'?: string | null; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'deadline'?: string | null; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'type': SlimCampaignV2026TypeV2026; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof SlimCampaignV2026 - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof SlimCampaignV2026 - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof SlimCampaignV2026 - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'status'?: SlimCampaignV2026StatusV2026 | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'correlatedStatus'?: SlimCampaignV2026CorrelatedStatusV2026; - /** - * Created time of the campaign - * @type {string} - * @memberof SlimCampaignV2026 - */ - 'created'?: string | null; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2026 - */ - 'totalCertifications'?: number | null; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof SlimCampaignV2026 - */ - 'completedCertifications'?: number | null; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof SlimCampaignV2026 - */ - 'alerts'?: Array | null; -} - -export const SlimCampaignV2026TypeV2026 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type SlimCampaignV2026TypeV2026 = typeof SlimCampaignV2026TypeV2026[keyof typeof SlimCampaignV2026TypeV2026]; -export const SlimCampaignV2026StatusV2026 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type SlimCampaignV2026StatusV2026 = typeof SlimCampaignV2026StatusV2026[keyof typeof SlimCampaignV2026StatusV2026]; -export const SlimCampaignV2026CorrelatedStatusV2026 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type SlimCampaignV2026CorrelatedStatusV2026 = typeof SlimCampaignV2026CorrelatedStatusV2026[keyof typeof SlimCampaignV2026CorrelatedStatusV2026]; - -/** - * Discovered applications - * @export - * @interface SlimDiscoveredApplicationsV2026 - */ -export interface SlimDiscoveredApplicationsV2026 { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'status'?: string; - /** - * The operational status of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'operationalStatus'?: string; - /** - * The category of the discovery source. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'discoverySourceCategory'?: string; - /** - * The number of licenses associated with the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'licenseCount'?: number; - /** - * Indicates whether the application is sanctioned. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'isSanctioned'?: boolean; - /** - * URL of the application\'s logo. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'logo'?: string; - /** - * The URL of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'appUrl'?: string; - /** - * List of groups associated with the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'groups'?: Array; - /** - * The count of users associated with the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'usersCount'?: string; - /** - * The owners of the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'applicationOwner'?: Array; - /** - * The IT owners of the application. - * @type {Array} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'itApplicationOwner'?: Array; - /** - * The business criticality level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'businessCriticality'?: string; - /** - * The data classification level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'dataClassification'?: string; - /** - * The business unit associated with the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'businessUnit'?: string; - /** - * The installation type of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'installType'?: string; - /** - * The environment in which the application operates. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'environment'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'riskLevel'?: SlimDiscoveredApplicationsV2026RiskLevelV2026; - /** - * Indicates whether the application has privileged access. - * @type {boolean} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'isPrivileged'?: boolean; - /** - * The warranty expiration date of the application. - * @type {string} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'warrantyExpiration'?: string; - /** - * Additional attributes of the application useful for visibility of governance posture. - * @type {object} - * @memberof SlimDiscoveredApplicationsV2026 - */ - 'attributes'?: object; -} - -export const SlimDiscoveredApplicationsV2026RiskLevelV2026 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type SlimDiscoveredApplicationsV2026RiskLevelV2026 = typeof SlimDiscoveredApplicationsV2026RiskLevelV2026[keyof typeof SlimDiscoveredApplicationsV2026RiskLevelV2026]; - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteriaV2026 - */ -export interface SodExemptCriteriaV2026 { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteriaV2026 - */ - 'existing'?: boolean; - /** - * - * @type {DtoTypeV2026} - * @memberof SodExemptCriteriaV2026 - */ - 'type'?: DtoTypeV2026; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteriaV2026 - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteriaV2026 - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SodPolicyConflictingAccessCriteriaV2026 - */ -export interface SodPolicyConflictingAccessCriteriaV2026 { - /** - * - * @type {AccessCriteriaV2026} - * @memberof SodPolicyConflictingAccessCriteriaV2026 - */ - 'leftCriteria'?: AccessCriteriaV2026; - /** - * - * @type {AccessCriteriaV2026} - * @memberof SodPolicyConflictingAccessCriteriaV2026 - */ - 'rightCriteria'?: AccessCriteriaV2026; -} -/** - * SOD policy. - * @export - * @interface SodPolicyDto1V2026 - */ -export interface SodPolicyDto1V2026 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto1V2026 - */ - 'type'?: SodPolicyDto1V2026TypeV2026; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto1V2026 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto1V2026 - */ - 'name'?: string; -} - -export const SodPolicyDto1V2026TypeV2026 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDto1V2026TypeV2026 = typeof SodPolicyDto1V2026TypeV2026[keyof typeof SodPolicyDto1V2026TypeV2026]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDtoV2026 - */ -export interface SodPolicyDtoV2026 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDtoV2026 - */ - 'type'?: SodPolicyDtoV2026TypeV2026; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDtoV2026 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDtoV2026 - */ - 'name'?: string; -} - -export const SodPolicyDtoV2026TypeV2026 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDtoV2026TypeV2026 = typeof SodPolicyDtoV2026TypeV2026[keyof typeof SodPolicyDtoV2026TypeV2026]; - -/** - * The owner of the SOD policy. - * @export - * @interface SodPolicyOwnerRefV2026 - */ -export interface SodPolicyOwnerRefV2026 { - /** - * Owner type. - * @type {string} - * @memberof SodPolicyOwnerRefV2026 - */ - 'type'?: SodPolicyOwnerRefV2026TypeV2026; - /** - * Owner\'s ID. - * @type {string} - * @memberof SodPolicyOwnerRefV2026 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof SodPolicyOwnerRefV2026 - */ - 'name'?: string; -} - -export const SodPolicyOwnerRefV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SodPolicyOwnerRefV2026TypeV2026 = typeof SodPolicyOwnerRefV2026TypeV2026[keyof typeof SodPolicyOwnerRefV2026TypeV2026]; - -/** - * - * @export - * @interface SodPolicyScheduleV2026 - */ -export interface SodPolicyScheduleV2026 { - /** - * SOD Policy schedule name - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'name'?: string; - /** - * The time when this SOD policy schedule is created. - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'created'?: string; - /** - * The time when this SOD policy schedule is modified. - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'modified'?: string; - /** - * SOD Policy schedule description - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'description'?: string; - /** - * - * @type {Schedule2V2026} - * @memberof SodPolicyScheduleV2026 - */ - 'schedule'?: Schedule2V2026; - /** - * - * @type {Array} - * @memberof SodPolicyScheduleV2026 - */ - 'recipients'?: Array; - /** - * Indicates if empty results need to be emailed - * @type {boolean} - * @memberof SodPolicyScheduleV2026 - */ - 'emailEmptyResults'?: boolean; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyScheduleV2026 - */ - 'modifierId'?: string; -} -/** - * - * @export - * @interface SodPolicyV2026 - */ -export interface SodPolicyV2026 { - /** - * Policy id - * @type {string} - * @memberof SodPolicyV2026 - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicyV2026 - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyV2026 - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyV2026 - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicyV2026 - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRefV2026} - * @memberof SodPolicyV2026 - */ - 'ownerRef'?: SodPolicyOwnerRefV2026; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicyV2026 - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicyV2026 - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicyV2026 - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicyV2026 - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicyV2026 - */ - 'state'?: SodPolicyV2026StateV2026; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicyV2026 - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyV2026 - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyV2026 - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfigV2026} - * @memberof SodPolicyV2026 - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfigV2026; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicyV2026 - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicyV2026 - */ - 'type'?: SodPolicyV2026TypeV2026; - /** - * - * @type {SodPolicyConflictingAccessCriteriaV2026} - * @memberof SodPolicyV2026 - */ - 'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteriaV2026; -} - -export const SodPolicyV2026StateV2026 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyV2026StateV2026 = typeof SodPolicyV2026StateV2026[keyof typeof SodPolicyV2026StateV2026]; -export const SodPolicyV2026TypeV2026 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyV2026TypeV2026 = typeof SodPolicyV2026TypeV2026[keyof typeof SodPolicyV2026TypeV2026]; - -/** - * SOD policy recipient. - * @export - * @interface SodRecipientV2026 - */ -export interface SodRecipientV2026 { - /** - * SOD policy recipient DTO type. - * @type {string} - * @memberof SodRecipientV2026 - */ - 'type'?: SodRecipientV2026TypeV2026; - /** - * SOD policy recipient\'s identity ID. - * @type {string} - * @memberof SodRecipientV2026 - */ - 'id'?: string; - /** - * SOD policy recipient\'s display name. - * @type {string} - * @memberof SodRecipientV2026 - */ - 'name'?: string; -} - -export const SodRecipientV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SodRecipientV2026TypeV2026 = typeof SodRecipientV2026TypeV2026[keyof typeof SodRecipientV2026TypeV2026]; - -/** - * SOD policy violation report result. - * @export - * @interface SodReportResultDtoV2026 - */ -export interface SodReportResultDtoV2026 { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof SodReportResultDtoV2026 - */ - 'type'?: SodReportResultDtoV2026TypeV2026; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof SodReportResultDtoV2026 - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof SodReportResultDtoV2026 - */ - 'name'?: string; -} - -export const SodReportResultDtoV2026TypeV2026 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type SodReportResultDtoV2026TypeV2026 = typeof SodReportResultDtoV2026TypeV2026[keyof typeof SodReportResultDtoV2026TypeV2026]; - -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResultV2026 - */ -export interface SodViolationCheckResultV2026 { - /** - * - * @type {ErrorMessageDtoV2026} - * @memberof SodViolationCheckResultV2026 - */ - 'message'?: ErrorMessageDtoV2026; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResultV2026 - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResultV2026 - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResultV2026 - */ - 'violatedPolicies'?: Array | null; -} -/** - * An object referencing an SOD violation check - * @export - * @interface SodViolationCheckV2026 - */ -export interface SodViolationCheckV2026 { - /** - * The id of the original request - * @type {string} - * @memberof SodViolationCheckV2026 - */ - 'requestId': string; - /** - * The date-time when this request was created. - * @type {string} - * @memberof SodViolationCheckV2026 - */ - 'created'?: string; -} -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompletedV2026 - */ -export interface SodViolationContextCheckCompletedV2026 { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompletedV2026 - */ - 'state'?: SodViolationContextCheckCompletedV2026StateV2026 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompletedV2026 - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResultV2026} - * @memberof SodViolationContextCheckCompletedV2026 - */ - 'violationCheckResult'?: SodViolationCheckResultV2026; -} - -export const SodViolationContextCheckCompletedV2026StateV2026 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompletedV2026StateV2026 = typeof SodViolationContextCheckCompletedV2026StateV2026[keyof typeof SodViolationContextCheckCompletedV2026StateV2026]; - -/** - * - * @export - * @interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026 - */ -export interface SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026 { - /** - * - * @type {Array} - * @memberof SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026 - */ - 'criteriaList'?: Array; -} -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContextConflictingAccessCriteriaV2026 - */ -export interface SodViolationContextConflictingAccessCriteriaV2026 { - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026} - * @memberof SodViolationContextConflictingAccessCriteriaV2026 - */ - 'leftCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026} - * @memberof SodViolationContextConflictingAccessCriteriaV2026 - */ - 'rightCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteriaV2026; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContextV2026 - */ -export interface SodViolationContextV2026 { - /** - * - * @type {SodPolicyDto1V2026} - * @memberof SodViolationContextV2026 - */ - 'policy'?: SodPolicyDto1V2026; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaV2026} - * @memberof SodViolationContextV2026 - */ - 'conflictingAccessCriteria'?: SodViolationContextConflictingAccessCriteriaV2026; -} -/** - * - * @export - * @interface Source1V2026 - */ -export interface Source1V2026 { - /** - * Attribute mapping type. - * @type {string} - * @memberof Source1V2026 - */ - 'type'?: string; - /** - * Attribute mapping properties. - * @type {object} - * @memberof Source1V2026 - */ - 'properties'?: object; -} -/** - * Reference to account correlation config object. - * @export - * @interface SourceAccountCorrelationConfigV2026 - */ -export interface SourceAccountCorrelationConfigV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2026 - */ - 'type'?: SourceAccountCorrelationConfigV2026TypeV2026; - /** - * Account correlation config ID. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2026 - */ - 'id'?: string; - /** - * Account correlation config\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationConfigV2026 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationConfigV2026TypeV2026 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' -} as const; - -export type SourceAccountCorrelationConfigV2026TypeV2026 = typeof SourceAccountCorrelationConfigV2026TypeV2026[keyof typeof SourceAccountCorrelationConfigV2026TypeV2026]; - -/** - * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. - * @export - * @interface SourceAccountCorrelationRuleV2026 - */ -export interface SourceAccountCorrelationRuleV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2026 - */ - 'type'?: SourceAccountCorrelationRuleV2026TypeV2026; - /** - * Rule ID. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2026 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationRuleV2026 - */ - 'name'?: string; -} - -export const SourceAccountCorrelationRuleV2026TypeV2026 = { - Rule: 'RULE' -} as const; - -export type SourceAccountCorrelationRuleV2026TypeV2026 = typeof SourceAccountCorrelationRuleV2026TypeV2026[keyof typeof SourceAccountCorrelationRuleV2026TypeV2026]; - -/** - * - * @export - * @interface SourceAccountCreatedV2026 - */ -export interface SourceAccountCreatedV2026 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountCreatedV2026 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountCreatedV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountDeletedV2026 - */ -export interface SourceAccountDeletedV2026 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountDeletedV2026 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountDeletedV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAccountSelectionsV2026 - */ -export interface SourceAccountSelectionsV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof SourceAccountSelectionsV2026 - */ - 'type'?: DtoTypeV2026; - /** - * The source id - * @type {string} - * @memberof SourceAccountSelectionsV2026 - */ - 'id'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAccountSelectionsV2026 - */ - 'name'?: string; - /** - * The accounts information for a particular source in the requested item - * @type {Array} - * @memberof SourceAccountSelectionsV2026 - */ - 'accounts'?: Array; -} - - -/** - * - * @export - * @interface SourceAccountUpdatedV2026 - */ -export interface SourceAccountUpdatedV2026 { - /** - * Source unique identifier for the identity. UUID is generated by the source system. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'uuid'?: string; - /** - * SailPoint generated unique identifier. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'id': string; - /** - * Unique ID of the account on the source. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'nativeIdentifier': string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'sourceId': string; - /** - * The name of the source. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'sourceName': string; - /** - * The ID of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'identityId': string; - /** - * The name of the identity that is correlated with this account. - * @type {string} - * @memberof SourceAccountUpdatedV2026 - */ - 'identityName': string; - /** - * The attributes of the account. The contents of attributes depends on the account schema for the source. - * @type {{ [key: string]: any; }} - * @memberof SourceAccountUpdatedV2026 - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface SourceAppAccountSourceV2026 - */ -export interface SourceAppAccountSourceV2026 { - /** - * The source ID - * @type {string} - * @memberof SourceAppAccountSourceV2026 - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppAccountSourceV2026 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppAccountSourceV2026 - */ - 'name'?: string; - /** - * If the source is used for password management - * @type {boolean} - * @memberof SourceAppAccountSourceV2026 - */ - 'useForPasswordManagement'?: boolean; - /** - * The password policies for the source - * @type {Array} - * @memberof SourceAppAccountSourceV2026 - */ - 'passwordPolicies'?: Array | null; -} -/** - * - * @export - * @interface SourceAppBulkUpdateRequestV2026 - */ -export interface SourceAppBulkUpdateRequestV2026 { - /** - * List of source app ids to update - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2026 - */ - 'appIds': Array; - /** - * The JSONPatch payload used to update the source app. - * @type {Array} - * @memberof SourceAppBulkUpdateRequestV2026 - */ - 'jsonPatch': Array; -} -/** - * - * @export - * @interface SourceAppCreateDtoAccountSourceV2026 - */ -export interface SourceAppCreateDtoAccountSourceV2026 { - /** - * The source ID - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2026 - */ - 'id': string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2026 - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof SourceAppCreateDtoAccountSourceV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface SourceAppCreateDtoV2026 - */ -export interface SourceAppCreateDtoV2026 { - /** - * The source app name - * @type {string} - * @memberof SourceAppCreateDtoV2026 - */ - 'name': string; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppCreateDtoV2026 - */ - 'description': string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppCreateDtoV2026 - */ - 'matchAllAccounts'?: boolean; - /** - * - * @type {SourceAppCreateDtoAccountSourceV2026} - * @memberof SourceAppCreateDtoV2026 - */ - 'accountSource': SourceAppCreateDtoAccountSourceV2026; -} -/** - * - * @export - * @interface SourceAppPatchDtoV2026 - */ -export interface SourceAppPatchDtoV2026 { - /** - * The source app id - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppPatchDtoV2026 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppPatchDtoV2026 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppPatchDtoV2026 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppPatchDtoV2026 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppPatchDtoV2026 - */ - 'appCenterEnabled'?: boolean; - /** - * List of IDs of access profiles - * @type {Array} - * @memberof SourceAppPatchDtoV2026 - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {SourceAppAccountSourceV2026} - * @memberof SourceAppPatchDtoV2026 - */ - 'accountSource'?: SourceAppAccountSourceV2026 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2026} - * @memberof SourceAppPatchDtoV2026 - */ - 'owner'?: BaseReferenceDtoV2026 | null; -} -/** - * - * @export - * @interface SourceAppV2026 - */ -export interface SourceAppV2026 { - /** - * The source app id - * @type {string} - * @memberof SourceAppV2026 - */ - 'id'?: string; - /** - * The deprecated source app id - * @type {string} - * @memberof SourceAppV2026 - */ - 'cloudAppId'?: string; - /** - * The source app name - * @type {string} - * @memberof SourceAppV2026 - */ - 'name'?: string; - /** - * Time when the source app was created - * @type {string} - * @memberof SourceAppV2026 - */ - 'created'?: string; - /** - * Time when the source app was last modified - * @type {string} - * @memberof SourceAppV2026 - */ - 'modified'?: string; - /** - * True if the source app is enabled - * @type {boolean} - * @memberof SourceAppV2026 - */ - 'enabled'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof SourceAppV2026 - */ - 'provisionRequestEnabled'?: boolean; - /** - * The description of the source app - * @type {string} - * @memberof SourceAppV2026 - */ - 'description'?: string; - /** - * True if the source app match all accounts - * @type {boolean} - * @memberof SourceAppV2026 - */ - 'matchAllAccounts'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof SourceAppV2026 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {SourceAppAccountSourceV2026} - * @memberof SourceAppV2026 - */ - 'accountSource'?: SourceAppAccountSourceV2026 | null; - /** - * The owner of source app - * @type {BaseReferenceDtoV2026} - * @memberof SourceAppV2026 - */ - 'owner'?: BaseReferenceDtoV2026 | null; -} -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface SourceBeforeProvisioningRuleV2026 - */ -export interface SourceBeforeProvisioningRuleV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2026 - */ - 'type'?: SourceBeforeProvisioningRuleV2026TypeV2026; - /** - * Rule ID. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2026 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceBeforeProvisioningRuleV2026 - */ - 'name'?: string; -} - -export const SourceBeforeProvisioningRuleV2026TypeV2026 = { - Rule: 'RULE' -} as const; - -export type SourceBeforeProvisioningRuleV2026TypeV2026 = typeof SourceBeforeProvisioningRuleV2026TypeV2026[keyof typeof SourceBeforeProvisioningRuleV2026TypeV2026]; - -/** - * A map containing numbers relevant to the source classification process - * @export - * @interface SourceClassificationStatusAllOfCountsV2026 - */ -export interface SourceClassificationStatusAllOfCountsV2026 { - /** - * total number of source accounts - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2026 - */ - 'EXPECTED': number; - /** - * number of accounts that have been sent for processing (should be the same as expected when all accounts are collected) - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2026 - */ - 'RECEIVED': number; - /** - * number of accounts that have been classified - * @type {number} - * @memberof SourceClassificationStatusAllOfCountsV2026 - */ - 'COMPLETED': number; -} -/** - * - * @export - * @interface SourceClassificationStatusV2026 - */ -export interface SourceClassificationStatusV2026 { - /** - * Status of Classification Process - * @type {string} - * @memberof SourceClassificationStatusV2026 - */ - 'status'?: SourceClassificationStatusV2026StatusV2026; - /** - * Time when the process was started - * @type {string} - * @memberof SourceClassificationStatusV2026 - */ - 'started'?: string; - /** - * Time when the process status was last updated - * @type {string} - * @memberof SourceClassificationStatusV2026 - */ - 'updated'?: string | null; - /** - * - * @type {SourceClassificationStatusAllOfCountsV2026} - * @memberof SourceClassificationStatusV2026 - */ - 'counts'?: SourceClassificationStatusAllOfCountsV2026; -} - -export const SourceClassificationStatusV2026StatusV2026 = { - Started: 'STARTED', - Collected: 'COLLECTED', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED' -} as const; - -export type SourceClassificationStatusV2026StatusV2026 = typeof SourceClassificationStatusV2026StatusV2026[keyof typeof SourceClassificationStatusV2026StatusV2026]; - -/** - * Source cluster. - * @export - * @interface SourceClusterDtoV2026 - */ -export interface SourceClusterDtoV2026 { - /** - * Source cluster DTO type. - * @type {string} - * @memberof SourceClusterDtoV2026 - */ - 'type'?: SourceClusterDtoV2026TypeV2026; - /** - * Source cluster ID. - * @type {string} - * @memberof SourceClusterDtoV2026 - */ - 'id'?: string; - /** - * Source cluster display name. - * @type {string} - * @memberof SourceClusterDtoV2026 - */ - 'name'?: string; -} - -export const SourceClusterDtoV2026TypeV2026 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterDtoV2026TypeV2026 = typeof SourceClusterDtoV2026TypeV2026[keyof typeof SourceClusterDtoV2026TypeV2026]; - -/** - * Reference to the source\'s associated cluster. - * @export - * @interface SourceClusterV2026 - */ -export interface SourceClusterV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceClusterV2026 - */ - 'type': SourceClusterV2026TypeV2026; - /** - * Cluster ID. - * @type {string} - * @memberof SourceClusterV2026 - */ - 'id': string; - /** - * Cluster\'s human-readable display name. - * @type {string} - * @memberof SourceClusterV2026 - */ - 'name': string; -} - -export const SourceClusterV2026TypeV2026 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterV2026TypeV2026 = typeof SourceClusterV2026TypeV2026[keyof typeof SourceClusterV2026TypeV2026]; - -/** - * SourceCode - * @export - * @interface SourceCodeV2026 - */ -export interface SourceCodeV2026 { - /** - * the version of the code - * @type {string} - * @memberof SourceCodeV2026 - */ - 'version': string; - /** - * The code - * @type {string} - * @memberof SourceCodeV2026 - */ - 'script': string; -} -/** - * - * @export - * @interface SourceConnectionsDtoV2026 - */ -export interface SourceConnectionsDtoV2026 { - /** - * The IdentityProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'identityProfiles'?: Array; - /** - * Name of the CredentialProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'credentialProfiles'?: Array; - /** - * The attributes attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'sourceAttributes'?: Array; - /** - * The profiles attached to this source - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'mappingProfiles'?: Array; - /** - * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'dependentCustomTransforms'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'dependentApps'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDtoV2026 - */ - 'missingDependents'?: Array; -} -/** - * Identity who created the source. - * @export - * @interface SourceCreatedActorV2026 - */ -export interface SourceCreatedActorV2026 { - /** - * DTO type of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2026 - */ - 'type': SourceCreatedActorV2026TypeV2026; - /** - * ID of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2026 - */ - 'id': string; - /** - * Display name of identity who created the source. - * @type {string} - * @memberof SourceCreatedActorV2026 - */ - 'name': string; -} - -export const SourceCreatedActorV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SourceCreatedActorV2026TypeV2026 = typeof SourceCreatedActorV2026TypeV2026[keyof typeof SourceCreatedActorV2026TypeV2026]; - -/** - * - * @export - * @interface SourceCreatedV2026 - */ -export interface SourceCreatedV2026 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceCreatedV2026 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceCreatedV2026 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceCreatedV2026 - */ - 'type': string; - /** - * The date and time the source was created. - * @type {string} - * @memberof SourceCreatedV2026 - */ - 'created': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceCreatedV2026 - */ - 'connector': string; - /** - * - * @type {SourceCreatedActorV2026} - * @memberof SourceCreatedV2026 - */ - 'actor': SourceCreatedActorV2026; -} -/** - * - * @export - * @interface SourceCreationErrorsV2026 - */ -export interface SourceCreationErrorsV2026 { - /** - * Multi-Host Integration ID. - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'multihostId'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'source_name'?: string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'source_error'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'modified'?: string; - /** - * operation category (e.g. DELETE). - * @type {string} - * @memberof SourceCreationErrorsV2026 - */ - 'operation'?: string | null; -} -/** - * Resource definition for a source. The resource is reconstructed from source schema data (resourceId/resourceType in schema config and schema objectType as name). - * @export - * @interface SourceDatasetResourceV2026 - */ -export interface SourceDatasetResourceV2026 { - /** - * Resource identifier from source schema config. - * @type {string} - * @memberof SourceDatasetResourceV2026 - */ - 'id'?: string; - /** - * Display name of the resource. - * @type {string} - * @memberof SourceDatasetResourceV2026 - */ - 'name'?: string; - /** - * Feature identifiers supported by this resource. - * @type {Array} - * @memberof SourceDatasetResourceV2026 - */ - 'features'?: Array; - /** - * Resource type from source schema config. - * @type {string} - * @memberof SourceDatasetResourceV2026 - */ - 'type'?: string; - /** - * - * @type {SchemaV2026} - * @memberof SourceDatasetResourceV2026 - */ - 'schema'?: SchemaV2026; -} -/** - * - * @export - * @interface SourceDatasetResourcesInnerV2026 - */ -export interface SourceDatasetResourcesInnerV2026 { - /** - * Resource identifier. - * @type {string} - * @memberof SourceDatasetResourcesInnerV2026 - */ - 'id'?: string; - /** - * Display name of the resource. - * @type {string} - * @memberof SourceDatasetResourcesInnerV2026 - */ - 'name'?: string; -} -/** - * Dataset instance for a source. Fields are read from source-persisted dataset rows in Diana (name/description reflect the source\'s stored snapshot); aggregationEnabled is stored per source instance. - * @export - * @interface SourceDatasetV2026 - */ -export interface SourceDatasetV2026 { - /** - * Dataset identifier. - * @type {string} - * @memberof SourceDatasetV2026 - */ - 'id'?: string; - /** - * Display name of the dataset. - * @type {string} - * @memberof SourceDatasetV2026 - */ - 'name'?: string; - /** - * Description of the dataset. - * @type {string} - * @memberof SourceDatasetV2026 - */ - 'description'?: string; - /** - * Whether aggregation is enabled for this dataset on the source. - * @type {boolean} - * @memberof SourceDatasetV2026 - */ - 'aggregationEnabled'?: boolean; - /** - * Simplified resource references associated with this dataset. - * @type {Array} - * @memberof SourceDatasetV2026 - */ - 'resources'?: Array; -} -/** - * Identity who deleted the source. - * @export - * @interface SourceDeletedActorV2026 - */ -export interface SourceDeletedActorV2026 { - /** - * DTO type of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2026 - */ - 'type': SourceDeletedActorV2026TypeV2026; - /** - * ID of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2026 - */ - 'id': string; - /** - * Display name of identity who deleted the source. - * @type {string} - * @memberof SourceDeletedActorV2026 - */ - 'name': string; -} - -export const SourceDeletedActorV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SourceDeletedActorV2026TypeV2026 = typeof SourceDeletedActorV2026TypeV2026[keyof typeof SourceDeletedActorV2026TypeV2026]; - -/** - * - * @export - * @interface SourceDeletedV2026 - */ -export interface SourceDeletedV2026 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceDeletedV2026 - */ - 'id': string; - /** - * Human friendly name of the source. - * @type {string} - * @memberof SourceDeletedV2026 - */ - 'name': string; - /** - * The connection type. - * @type {string} - * @memberof SourceDeletedV2026 - */ - 'type': string; - /** - * The date and time the source was deleted. - * @type {string} - * @memberof SourceDeletedV2026 - */ - 'deleted': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceDeletedV2026 - */ - 'connector': string; - /** - * - * @type {SourceDeletedActorV2026} - * @memberof SourceDeletedV2026 - */ - 'actor': SourceDeletedActorV2026; -} -/** - * Entitlement Request Configuration - * @export - * @interface SourceEntitlementRequestConfigV2026 - */ -export interface SourceEntitlementRequestConfigV2026 { - /** - * - * @type {EntitlementAccessRequestConfigV2026} - * @memberof SourceEntitlementRequestConfigV2026 - */ - 'accessRequestConfig'?: EntitlementAccessRequestConfigV2026; - /** - * - * @type {EntitlementRevocationRequestConfigV2026} - * @memberof SourceEntitlementRequestConfigV2026 - */ - 'revocationRequestConfig'?: EntitlementRevocationRequestConfigV2026; -} -/** - * Dto for source health data - * @export - * @interface SourceHealthDtoV2026 - */ -export interface SourceHealthDtoV2026 { - /** - * the id of the Source - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'id'?: string; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'type'?: string; - /** - * the name of the source - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'name'?: string; - /** - * source\'s org - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'org'?: string; - /** - * Is the source authoritative - * @type {boolean} - * @memberof SourceHealthDtoV2026 - */ - 'isAuthoritative'?: boolean; - /** - * Is the source in a cluster - * @type {boolean} - * @memberof SourceHealthDtoV2026 - */ - 'isCluster'?: boolean; - /** - * source\'s hostname - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'hostname'?: string; - /** - * source\'s pod - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'pod'?: string; - /** - * The version of the iqService - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'iqServiceVersion'?: string | null; - /** - * connection test result - * @type {string} - * @memberof SourceHealthDtoV2026 - */ - 'status'?: SourceHealthDtoV2026StatusV2026; -} - -export const SourceHealthDtoV2026StatusV2026 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type SourceHealthDtoV2026StatusV2026 = typeof SourceHealthDtoV2026StatusV2026[keyof typeof SourceHealthDtoV2026StatusV2026]; - -/** - * - * @export - * @interface SourceItemRefV2026 - */ -export interface SourceItemRefV2026 { - /** - * The id for the source on which account selections are made - * @type {string} - * @memberof SourceItemRefV2026 - */ - 'sourceId'?: string | null; - /** - * A list of account selections on the source. Currently, only one selection per source is supported. - * @type {Array} - * @memberof SourceItemRefV2026 - */ - 'accounts'?: Array | null; -} -/** - * Reference to management workgroup for the source. - * @export - * @interface SourceManagementWorkgroupV2026 - */ -export interface SourceManagementWorkgroupV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagementWorkgroupV2026 - */ - 'type'?: SourceManagementWorkgroupV2026TypeV2026; - /** - * Management workgroup ID. - * @type {string} - * @memberof SourceManagementWorkgroupV2026 - */ - 'id'?: string; - /** - * Management workgroup\'s human-readable display name. - * @type {string} - * @memberof SourceManagementWorkgroupV2026 - */ - 'name'?: string; -} - -export const SourceManagementWorkgroupV2026TypeV2026 = { - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SourceManagementWorkgroupV2026TypeV2026 = typeof SourceManagementWorkgroupV2026TypeV2026[keyof typeof SourceManagementWorkgroupV2026TypeV2026]; - -/** - * - * @export - * @interface SourceManagerCorrelationMappingV2026 - */ -export interface SourceManagerCorrelationMappingV2026 { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2026 - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof SourceManagerCorrelationMappingV2026 - */ - 'identityAttributeName'?: string; -} -/** - * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. - * @export - * @interface SourceManagerCorrelationRuleV2026 - */ -export interface SourceManagerCorrelationRuleV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2026 - */ - 'type'?: SourceManagerCorrelationRuleV2026TypeV2026; - /** - * Rule ID. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2026 - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceManagerCorrelationRuleV2026 - */ - 'name'?: string; -} - -export const SourceManagerCorrelationRuleV2026TypeV2026 = { - Rule: 'RULE' -} as const; - -export type SourceManagerCorrelationRuleV2026TypeV2026 = typeof SourceManagerCorrelationRuleV2026TypeV2026[keyof typeof SourceManagerCorrelationRuleV2026TypeV2026]; - -/** - * Reference to identity object who owns the source. - * @export - * @interface SourceOwnerV2026 - */ -export interface SourceOwnerV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceOwnerV2026 - */ - 'type'?: SourceOwnerV2026TypeV2026; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof SourceOwnerV2026 - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof SourceOwnerV2026 - */ - 'name'?: string; -} - -export const SourceOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SourceOwnerV2026TypeV2026 = typeof SourceOwnerV2026TypeV2026[keyof typeof SourceOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface SourcePasswordPoliciesInnerV2026 - */ -export interface SourcePasswordPoliciesInnerV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2026 - */ - 'type'?: SourcePasswordPoliciesInnerV2026TypeV2026; - /** - * Policy ID. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2026 - */ - 'id'?: string; - /** - * Policy\'s human-readable display name. - * @type {string} - * @memberof SourcePasswordPoliciesInnerV2026 - */ - 'name'?: string; -} - -export const SourcePasswordPoliciesInnerV2026TypeV2026 = { - PasswordPolicy: 'PASSWORD_POLICY' -} as const; - -export type SourcePasswordPoliciesInnerV2026TypeV2026 = typeof SourcePasswordPoliciesInnerV2026TypeV2026[keyof typeof SourcePasswordPoliciesInnerV2026TypeV2026]; - -/** - * - * @export - * @interface SourceScheduleV2026 - */ -export interface SourceScheduleV2026 { - /** - * The type of the Schedule. - * @type {string} - * @memberof SourceScheduleV2026 - */ - 'type': SourceScheduleV2026TypeV2026; - /** - * The cron expression of the schedule. - * @type {string} - * @memberof SourceScheduleV2026 - */ - 'cronExpression': string; -} - -export const SourceScheduleV2026TypeV2026 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; - -export type SourceScheduleV2026TypeV2026 = typeof SourceScheduleV2026TypeV2026[keyof typeof SourceScheduleV2026TypeV2026]; - -/** - * - * @export - * @interface SourceSchemasInnerV2026 - */ -export interface SourceSchemasInnerV2026 { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceSchemasInnerV2026 - */ - 'type'?: SourceSchemasInnerV2026TypeV2026; - /** - * Schema ID. - * @type {string} - * @memberof SourceSchemasInnerV2026 - */ - 'id'?: string; - /** - * Schema\'s human-readable display name. - * @type {string} - * @memberof SourceSchemasInnerV2026 - */ - 'name'?: string; -} - -export const SourceSchemasInnerV2026TypeV2026 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type SourceSchemasInnerV2026TypeV2026 = typeof SourceSchemasInnerV2026TypeV2026[keyof typeof SourceSchemasInnerV2026TypeV2026]; - -/** - * - * @export - * @interface SourceSubtypeV2026 - */ -export interface SourceSubtypeV2026 { - /** - * Unique identifier for the subtype. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'id'?: string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'sourceId'?: string; - /** - * Technical name of the subtype. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'technicalName': string; - /** - * Display name of the subtype. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'displayName': string; - /** - * Description of the subtype. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'description': string; - /** - * Creation timestamp. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'created'?: string; - /** - * Last modified timestamp. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'modified'?: string; - /** - * Type of the subtype. Either MACHINE OR null. - * @type {string} - * @memberof SourceSubtypeV2026 - */ - 'type'?: string; -} -/** - * Source reference of the subtype. - * @export - * @interface SourceSubtypeWithSourceSourceV2026 - */ -export interface SourceSubtypeWithSourceSourceV2026 { - /** - * Type of the reference object. - * @type {string} - * @memberof SourceSubtypeWithSourceSourceV2026 - */ - 'type'?: SourceSubtypeWithSourceSourceV2026TypeV2026; - /** - * Unique identifier for the source. - * @type {string} - * @memberof SourceSubtypeWithSourceSourceV2026 - */ - 'id'?: string; - /** - * Name of the source. - * @type {string} - * @memberof SourceSubtypeWithSourceSourceV2026 - */ - 'name'?: string; -} - -export const SourceSubtypeWithSourceSourceV2026TypeV2026 = { - Source: 'SOURCE' -} as const; - -export type SourceSubtypeWithSourceSourceV2026TypeV2026 = typeof SourceSubtypeWithSourceSourceV2026TypeV2026[keyof typeof SourceSubtypeWithSourceSourceV2026TypeV2026]; - -/** - * - * @export - * @interface SourceSubtypeWithSourceV2026 - */ -export interface SourceSubtypeWithSourceV2026 { - /** - * Unique identifier for the subtype. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'id'?: string; - /** - * The ID of the source. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'sourceId'?: string; - /** - * Technical name of the subtype. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'technicalName'?: string; - /** - * Display name of the subtype. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'displayName'?: string; - /** - * Description of the subtype. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'description'?: string; - /** - * Creation timestamp. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'created'?: string; - /** - * Last modified timestamp. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'modified'?: string; - /** - * Type of the subtype. Either MACHINE OR null. - * @type {string} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'type'?: string; - /** - * - * @type {SourceSubtypeWithSourceSourceV2026} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'source'?: SourceSubtypeWithSourceSourceV2026; - /** - * Indicates if the subtype is managed by the system. - * @type {boolean} - * @memberof SourceSubtypeWithSourceV2026 - */ - 'systemManaged'?: boolean; -} -/** - * - * @export - * @interface SourceSyncJobV2026 - */ -export interface SourceSyncJobV2026 { - /** - * Job ID. - * @type {string} - * @memberof SourceSyncJobV2026 - */ - 'id': string; - /** - * The job status. - * @type {string} - * @memberof SourceSyncJobV2026 - */ - 'status': SourceSyncJobV2026StatusV2026; - /** - * - * @type {SourceSyncPayloadV2026} - * @memberof SourceSyncJobV2026 - */ - 'payload': SourceSyncPayloadV2026; -} - -export const SourceSyncJobV2026StatusV2026 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SourceSyncJobV2026StatusV2026 = typeof SourceSyncJobV2026StatusV2026[keyof typeof SourceSyncJobV2026StatusV2026]; - -/** - * - * @export - * @interface SourceSyncPayloadV2026 - */ -export interface SourceSyncPayloadV2026 { - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2026 - */ - 'type': string; - /** - * Payload type. - * @type {string} - * @memberof SourceSyncPayloadV2026 - */ - 'dataJson': string; -} -/** - * Identity who updated the source. - * @export - * @interface SourceUpdatedActorV2026 - */ -export interface SourceUpdatedActorV2026 { - /** - * DTO type of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2026 - */ - 'type': SourceUpdatedActorV2026TypeV2026; - /** - * ID of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2026 - */ - 'id'?: string; - /** - * Display name of identity who updated the source. - * @type {string} - * @memberof SourceUpdatedActorV2026 - */ - 'name': string; -} - -export const SourceUpdatedActorV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type SourceUpdatedActorV2026TypeV2026 = typeof SourceUpdatedActorV2026TypeV2026[keyof typeof SourceUpdatedActorV2026TypeV2026]; - -/** - * - * @export - * @interface SourceUpdatedV2026 - */ -export interface SourceUpdatedV2026 { - /** - * The unique ID of the source. - * @type {string} - * @memberof SourceUpdatedV2026 - */ - 'id': string; - /** - * The user friendly name of the source. - * @type {string} - * @memberof SourceUpdatedV2026 - */ - 'name': string; - /** - * The connection type of the source. - * @type {string} - * @memberof SourceUpdatedV2026 - */ - 'type': string; - /** - * The date and time the source was modified. - * @type {string} - * @memberof SourceUpdatedV2026 - */ - 'modified': string; - /** - * The connector type used to connect to the source. - * @type {string} - * @memberof SourceUpdatedV2026 - */ - 'connector': string; - /** - * - * @type {SourceUpdatedActorV2026} - * @memberof SourceUpdatedV2026 - */ - 'actor': SourceUpdatedActorV2026; -} -/** - * - * @export - * @interface SourceUsageStatusV2026 - */ -export interface SourceUsageStatusV2026 { - /** - * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. - * @type {string} - * @memberof SourceUsageStatusV2026 - */ - 'status'?: SourceUsageStatusV2026StatusV2026; -} - -export const SourceUsageStatusV2026StatusV2026 = { - Complete: 'COMPLETE', - Incomplete: 'INCOMPLETE' -} as const; - -export type SourceUsageStatusV2026StatusV2026 = typeof SourceUsageStatusV2026StatusV2026[keyof typeof SourceUsageStatusV2026StatusV2026]; - -/** - * - * @export - * @interface SourceUsageV2026 - */ -export interface SourceUsageV2026 { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof SourceUsageV2026 - */ - 'date'?: string; - /** - * The average number of days that accounts were active within this source, for the month. - * @type {number} - * @memberof SourceUsageV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface SourceV2026 - */ -export interface SourceV2026 { - /** - * Source ID. - * @type {string} - * @memberof SourceV2026 - */ - 'id'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof SourceV2026 - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof SourceV2026 - */ - 'description'?: string; - /** - * - * @type {SourceOwnerV2026} - * @memberof SourceV2026 - */ - 'owner': SourceOwnerV2026 | null; - /** - * - * @type {SourceClusterV2026} - * @memberof SourceV2026 - */ - 'cluster'?: SourceClusterV2026 | null; - /** - * - * @type {SourceAccountCorrelationConfigV2026} - * @memberof SourceV2026 - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfigV2026 | null; - /** - * - * @type {SourceAccountCorrelationRuleV2026} - * @memberof SourceV2026 - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRuleV2026 | null; - /** - * - * @type {SourceManagerCorrelationMappingV2026} - * @memberof SourceV2026 - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMappingV2026; - /** - * - * @type {SourceManagerCorrelationRuleV2026} - * @memberof SourceV2026 - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRuleV2026 | null; - /** - * - * @type {SourceBeforeProvisioningRuleV2026} - * @memberof SourceV2026 - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRuleV2026 | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof SourceV2026 - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof SourceV2026 - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof SourceV2026 - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceV2026 - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof SourceV2026 - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof SourceV2026 - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {object} - * @memberof SourceV2026 - */ - 'connectorAttributes'?: object; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof SourceV2026 - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof SourceV2026 - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroupV2026} - * @memberof SourceV2026 - */ - 'managementWorkgroup'?: SourceManagementWorkgroupV2026 | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof SourceV2026 - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof SourceV2026 - */ - 'status'?: SourceV2026StatusV2026; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof SourceV2026 - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof SourceV2026 - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof SourceV2026 - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof SourceV2026 - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof SourceV2026 - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof SourceV2026 - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof SourceV2026 - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof SourceV2026 - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof SourceV2026 - */ - 'category'?: string | null; -} - -export const SourceV2026FeaturesV2026 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SourceV2026FeaturesV2026 = typeof SourceV2026FeaturesV2026[keyof typeof SourceV2026FeaturesV2026]; -export const SourceV2026StatusV2026 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceV2026StatusV2026 = typeof SourceV2026StatusV2026[keyof typeof SourceV2026StatusV2026]; - -/** - * - * @export - * @interface SpConfigExportJobStatusV2026 - */ -export interface SpConfigExportJobStatusV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'status': SpConfigExportJobStatusV2026StatusV2026; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'type': SpConfigExportJobStatusV2026TypeV2026; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'description'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigExportJobStatusV2026 - */ - 'completed'?: string; -} - -export const SpConfigExportJobStatusV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobStatusV2026StatusV2026 = typeof SpConfigExportJobStatusV2026StatusV2026[keyof typeof SpConfigExportJobStatusV2026StatusV2026]; -export const SpConfigExportJobStatusV2026TypeV2026 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobStatusV2026TypeV2026 = typeof SpConfigExportJobStatusV2026TypeV2026[keyof typeof SpConfigExportJobStatusV2026TypeV2026]; - -/** - * - * @export - * @interface SpConfigExportJobV2026 - */ -export interface SpConfigExportJobV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'status': SpConfigExportJobV2026StatusV2026; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'type': SpConfigExportJobV2026TypeV2026; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'modified': string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportJobV2026 - */ - 'description'?: string; -} - -export const SpConfigExportJobV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigExportJobV2026StatusV2026 = typeof SpConfigExportJobV2026StatusV2026[keyof typeof SpConfigExportJobV2026StatusV2026]; -export const SpConfigExportJobV2026TypeV2026 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigExportJobV2026TypeV2026 = typeof SpConfigExportJobV2026TypeV2026[keyof typeof SpConfigExportJobV2026TypeV2026]; - -/** - * Response model for config export download response. - * @export - * @interface SpConfigExportResultsV2026 - */ -export interface SpConfigExportResultsV2026 { - /** - * Current version of the export results object. - * @type {number} - * @memberof SpConfigExportResultsV2026 - */ - 'version'?: number; - /** - * Time the export was completed. - * @type {string} - * @memberof SpConfigExportResultsV2026 - */ - 'timestamp'?: string; - /** - * Name of the tenant where this export originated. - * @type {string} - * @memberof SpConfigExportResultsV2026 - */ - 'tenant'?: string; - /** - * Optional user defined description/name for export job. - * @type {string} - * @memberof SpConfigExportResultsV2026 - */ - 'description'?: string; - /** - * - * @type {ExportOptions1V2026} - * @memberof SpConfigExportResultsV2026 - */ - 'options'?: ExportOptions1V2026; - /** - * - * @type {Array} - * @memberof SpConfigExportResultsV2026 - */ - 'objects'?: Array; -} -/** - * - * @export - * @interface SpConfigImportJobStatusV2026 - */ -export interface SpConfigImportJobStatusV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'status': SpConfigImportJobStatusV2026StatusV2026; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'type': SpConfigImportJobStatusV2026TypeV2026; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'modified': string; - /** - * This message contains additional information about the overall status of the job. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'message'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof SpConfigImportJobStatusV2026 - */ - 'completed'?: string; -} - -export const SpConfigImportJobStatusV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigImportJobStatusV2026StatusV2026 = typeof SpConfigImportJobStatusV2026StatusV2026[keyof typeof SpConfigImportJobStatusV2026StatusV2026]; -export const SpConfigImportJobStatusV2026TypeV2026 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigImportJobStatusV2026TypeV2026 = typeof SpConfigImportJobStatusV2026TypeV2026[keyof typeof SpConfigImportJobStatusV2026TypeV2026]; - -/** - * Response Body for Config Import command. - * @export - * @interface SpConfigImportResultsV2026 - */ -export interface SpConfigImportResultsV2026 { - /** - * The results of an object configuration import job. - * @type {{ [key: string]: ObjectImportResult1V2026; }} - * @memberof SpConfigImportResultsV2026 - */ - 'results': { [key: string]: ObjectImportResult1V2026; }; - /** - * If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. - * @type {string} - * @memberof SpConfigImportResultsV2026 - */ - 'exportJobId'?: string; -} -/** - * - * @export - * @interface SpConfigJobV2026 - */ -export interface SpConfigJobV2026 { - /** - * Unique id assigned to this job. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'jobId': string; - /** - * Status of the job. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'status': SpConfigJobV2026StatusV2026; - /** - * Type of the job, either export or import. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'type': SpConfigJobV2026TypeV2026; - /** - * The time until which the artifacts will be available for download. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'expiration'?: string; - /** - * The time the job was started. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'created': string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof SpConfigJobV2026 - */ - 'modified': string; -} - -export const SpConfigJobV2026StatusV2026 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type SpConfigJobV2026StatusV2026 = typeof SpConfigJobV2026StatusV2026[keyof typeof SpConfigJobV2026StatusV2026]; -export const SpConfigJobV2026TypeV2026 = { - Export: 'EXPORT', - Import: 'IMPORT' -} as const; - -export type SpConfigJobV2026TypeV2026 = typeof SpConfigJobV2026TypeV2026[keyof typeof SpConfigJobV2026TypeV2026]; - -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessage1V2026 - */ -export interface SpConfigMessage1V2026 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessage1V2026 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessage1V2026 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: object; }} - * @memberof SpConfigMessage1V2026 - */ - 'details': { [key: string]: object; }; -} -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessageV2026 - */ -export interface SpConfigMessageV2026 { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessageV2026 - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessageV2026 - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: any; }} - * @memberof SpConfigMessageV2026 - */ - 'details': { [key: string]: any; }; -} -/** - * Response model for object configuration. - * @export - * @interface SpConfigObjectV2026 - */ -export interface SpConfigObjectV2026 { - /** - * Object type the configuration is for. - * @type {string} - * @memberof SpConfigObjectV2026 - */ - 'objectType'?: string; - /** - * List of JSON paths within an exported object of this type, representing references that must be resolved. - * @type {Array} - * @memberof SpConfigObjectV2026 - */ - 'referenceExtractors'?: Array | null; - /** - * Indicates whether this type of object will be JWS signed and cannot be modified before import. - * @type {boolean} - * @memberof SpConfigObjectV2026 - */ - 'signatureRequired'?: boolean; - /** - * Indicates whether this object type must be always be resolved by ID. - * @type {boolean} - * @memberof SpConfigObjectV2026 - */ - 'alwaysResolveById'?: boolean; - /** - * Indicates whether this is a legacy object. - * @type {boolean} - * @memberof SpConfigObjectV2026 - */ - 'legacyObject'?: boolean; - /** - * Indicates whether there is only one object of this type. - * @type {boolean} - * @memberof SpConfigObjectV2026 - */ - 'onePerTenant'?: boolean; - /** - * Indicates whether the object can be exported or is just a reference object. - * @type {boolean} - * @memberof SpConfigObjectV2026 - */ - 'exportable'?: boolean; - /** - * - * @type {SpConfigRulesV2026} - * @memberof SpConfigObjectV2026 - */ - 'rules'?: SpConfigRulesV2026; -} -/** - * Format of Config Hub object rules. - * @export - * @interface SpConfigRuleV2026 - */ -export interface SpConfigRuleV2026 { - /** - * JSONPath expression denoting the path within the object where a value substitution should be applied. - * @type {string} - * @memberof SpConfigRuleV2026 - */ - 'path'?: string; - /** - * - * @type {SpConfigRuleValueV2026} - * @memberof SpConfigRuleV2026 - */ - 'value'?: SpConfigRuleValueV2026 | null; - /** - * Draft modes the rule will apply to. - * @type {Array} - * @memberof SpConfigRuleV2026 - */ - 'modes'?: Array; -} - -export const SpConfigRuleV2026ModesV2026 = { - Restore: 'RESTORE', - Promote: 'PROMOTE', - Upload: 'UPLOAD' -} as const; - -export type SpConfigRuleV2026ModesV2026 = typeof SpConfigRuleV2026ModesV2026[keyof typeof SpConfigRuleV2026ModesV2026]; - -/** - * Value to be assigned at the jsonPath location within the object. - * @export - * @interface SpConfigRuleValueV2026 - */ -export interface SpConfigRuleValueV2026 { -} -/** - * Rules to be applied to the config object during the draft process. - * @export - * @interface SpConfigRulesV2026 - */ -export interface SpConfigRulesV2026 { - /** - * - * @type {Array} - * @memberof SpConfigRulesV2026 - */ - 'takeFromTargetRules'?: Array; - /** - * - * @type {Array} - * @memberof SpConfigRulesV2026 - */ - 'defaultRules'?: Array; - /** - * Indicates whether the object can be edited. - * @type {boolean} - * @memberof SpConfigRulesV2026 - */ - 'editable'?: boolean; -} -/** - * - * @export - * @interface SpDetailsV2026 - */ -export interface SpDetailsV2026 { - /** - * Federation protocol role - * @type {string} - * @memberof SpDetailsV2026 - */ - 'role'?: SpDetailsV2026RoleV2026; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof SpDetailsV2026 - */ - 'entityId'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2026 - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2026 - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetailsV2026 - */ - 'legacyAcsUrl'?: string; -} - -export const SpDetailsV2026RoleV2026 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type SpDetailsV2026RoleV2026 = typeof SpDetailsV2026RoleV2026[keyof typeof SpDetailsV2026RoleV2026]; - -/** - * - * @export - * @interface SplitV2026 - */ -export interface SplitV2026 { - /** - * This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - * @type {string} - * @memberof SplitV2026 - */ - 'delimiter': string; - /** - * An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - * @type {string} - * @memberof SplitV2026 - */ - 'index': string; - /** - * A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return \"IndexOutOfBoundsException\" `false` - The transform should return null If not provided, the transform will default to false and return a null - * @type {boolean} - * @memberof SplitV2026 - */ - 'throws'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SplitV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SplitV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Standard Log4j log level - * @export - * @enum {string} - */ - -export const StandardLevelV2026 = { - False: 'false', - Fatal: 'FATAL', - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO', - Debug: 'DEBUG', - Trace: 'TRACE' -} as const; - -export type StandardLevelV2026 = typeof StandardLevelV2026[keyof typeof StandardLevelV2026]; - - -/** - * - * @export - * @interface StartApplicationDiscovery403ResponseOneOfV2026 - */ -export interface StartApplicationDiscovery403ResponseOneOfV2026 { - /** - * Error message when quota is exceeded - * @type {string} - * @memberof StartApplicationDiscovery403ResponseOneOfV2026 - */ - 'error': string; -} -/** - * @type StartApplicationDiscovery403ResponseV2026 - * @export - */ -export type StartApplicationDiscovery403ResponseV2026 = ErrorResponseDtoV2026 | StartApplicationDiscovery403ResponseOneOfV2026; - -/** - * - * @export - * @interface StartInvocationInputV2026 - */ -export interface StartInvocationInputV2026 { - /** - * Trigger ID - * @type {string} - * @memberof StartInvocationInputV2026 - */ - 'triggerId'?: string; - /** - * Trigger input payload. Its schema is defined in the trigger definition. - * @type {object} - * @memberof StartInvocationInputV2026 - */ - 'input'?: object; - /** - * JSON map of invocation metadata - * @type {object} - * @memberof StartInvocationInputV2026 - */ - 'contentJson'?: object; -} -/** - * - * @export - * @interface StartLauncher200ResponseV2026 - */ -export interface StartLauncher200ResponseV2026 { - /** - * ID of the Interactive Process that was launched - * @type {string} - * @memberof StartLauncher200ResponseV2026 - */ - 'interactiveProcessId': string; -} -/** - * - * @export - * @interface StaticV2026 - */ -export interface StaticV2026 { - /** - * This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - * @type {string} - * @memberof StaticV2026 - */ - 'values': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof StaticV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Response model for connection check, configuration test and ping of source connectors. - * @export - * @interface StatusResponseV2026 - */ -export interface StatusResponseV2026 { - /** - * ID of the source - * @type {string} - * @memberof StatusResponseV2026 - */ - 'id'?: string; - /** - * Name of the source - * @type {string} - * @memberof StatusResponseV2026 - */ - 'name'?: string; - /** - * The status of the health check. - * @type {string} - * @memberof StatusResponseV2026 - */ - 'status'?: StatusResponseV2026StatusV2026; - /** - * The number of milliseconds spent on the entire request. - * @type {number} - * @memberof StatusResponseV2026 - */ - 'elapsedMillis'?: number; - /** - * The document contains the results of the health check. The schema of this document depends on the type of source used. - * @type {object} - * @memberof StatusResponseV2026 - */ - 'details'?: object; -} - -export const StatusResponseV2026StatusV2026 = { - Success: 'SUCCESS', - Failure: 'FAILURE' -} as const; - -export type StatusResponseV2026StatusV2026 = typeof StatusResponseV2026StatusV2026[keyof typeof StatusResponseV2026StatusV2026]; - -/** - * Full stream configuration returned by create/get/update/replace. - * @export - * @interface StreamConfigResponseV2026 - */ -export interface StreamConfigResponseV2026 { - /** - * Unique stream identifier. - * @type {string} - * @memberof StreamConfigResponseV2026 - */ - 'stream_id'?: string; - /** - * Issuer (transmitter) URL. - * @type {string} - * @memberof StreamConfigResponseV2026 - */ - 'iss'?: string; - /** - * Audience for the stream. - * @type {string} - * @memberof StreamConfigResponseV2026 - */ - 'aud'?: string; - /** - * - * @type {DeliveryResponseV2026} - * @memberof StreamConfigResponseV2026 - */ - 'delivery'?: DeliveryResponseV2026; - /** - * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). - * @type {Array} - * @memberof StreamConfigResponseV2026 - */ - 'events_supported'?: Array; - /** - * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof StreamConfigResponseV2026 - */ - 'events_requested'?: Array; - /** - * Event types currently being delivered (intersection of supported and requested). - * @type {Array} - * @memberof StreamConfigResponseV2026 - */ - 'events_delivered'?: Array; - /** - * Optional stream description. - * @type {string} - * @memberof StreamConfigResponseV2026 - */ - 'description'?: string; - /** - * Inactivity timeout in seconds (optional). - * @type {number} - * @memberof StreamConfigResponseV2026 - */ - 'inactivity_timeout'?: number; - /** - * Minimum verification interval in seconds (optional). - * @type {number} - * @memberof StreamConfigResponseV2026 - */ - 'min_verification_interval'?: number; -} -/** - * Stream status returned by GET/POST /ssf/streams/status. - * @export - * @interface StreamStatusResponseV2026 - */ -export interface StreamStatusResponseV2026 { - /** - * Stream identifier. - * @type {string} - * @memberof StreamStatusResponseV2026 - */ - 'stream_id'?: string; - /** - * Operational status of the stream (enabled, paused, or disabled). - * @type {string} - * @memberof StreamStatusResponseV2026 - */ - 'status'?: StreamStatusResponseV2026StatusV2026; - /** - * Optional reason for the current status (e.g. set when status is updated). - * @type {string} - * @memberof StreamStatusResponseV2026 - */ - 'reason'?: string; -} - -export const StreamStatusResponseV2026StatusV2026 = { - Enabled: 'enabled', - Paused: 'paused', - Disabled: 'disabled' -} as const; - -export type StreamStatusResponseV2026StatusV2026 = typeof StreamStatusResponseV2026StatusV2026[keyof typeof StreamStatusResponseV2026StatusV2026]; - -/** - * - * @export - * @interface SubSearchAggregationSpecificationV2026 - */ -export interface SubSearchAggregationSpecificationV2026 { - /** - * - * @type {NestedAggregationV2026} - * @memberof SubSearchAggregationSpecificationV2026 - */ - 'nested'?: NestedAggregationV2026; - /** - * - * @type {MetricAggregationV2026} - * @memberof SubSearchAggregationSpecificationV2026 - */ - 'metric'?: MetricAggregationV2026; - /** - * - * @type {FilterAggregationV2026} - * @memberof SubSearchAggregationSpecificationV2026 - */ - 'filter'?: FilterAggregationV2026; - /** - * - * @type {BucketAggregationV2026} - * @memberof SubSearchAggregationSpecificationV2026 - */ - 'bucket'?: BucketAggregationV2026; - /** - * - * @type {AggregationsV2026} - * @memberof SubSearchAggregationSpecificationV2026 - */ - 'subAggregation'?: AggregationsV2026; -} -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface SubscriptionPatchRequestInnerV2026 - */ -export interface SubscriptionPatchRequestInnerV2026 { - /** - * The operation to be performed - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2026 - */ - 'op': SubscriptionPatchRequestInnerV2026OpV2026; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof SubscriptionPatchRequestInnerV2026 - */ - 'path': string; - /** - * - * @type {SubscriptionPatchRequestInnerValueV2026} - * @memberof SubscriptionPatchRequestInnerV2026 - */ - 'value'?: SubscriptionPatchRequestInnerValueV2026; -} - -export const SubscriptionPatchRequestInnerV2026OpV2026 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy' -} as const; - -export type SubscriptionPatchRequestInnerV2026OpV2026 = typeof SubscriptionPatchRequestInnerV2026OpV2026[keyof typeof SubscriptionPatchRequestInnerV2026OpV2026]; - -/** - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - * @interface SubscriptionPatchRequestInnerValueV2026 - */ -export interface SubscriptionPatchRequestInnerValueV2026 { -} -/** - * - * @export - * @interface SubscriptionPostRequestV2026 - */ -export interface SubscriptionPostRequestV2026 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPostRequestV2026 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPostRequestV2026 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionPostRequestV2026 - */ - 'triggerId': string; - /** - * - * @type {SubscriptionTypeV2026} - * @memberof SubscriptionPostRequestV2026 - */ - 'type': SubscriptionTypeV2026; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPostRequestV2026 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2026} - * @memberof SubscriptionPostRequestV2026 - */ - 'httpConfig'?: HttpConfigV2026; - /** - * - * @type {EventBridgeConfigV2026} - * @memberof SubscriptionPostRequestV2026 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2026; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPostRequestV2026 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPostRequestV2026 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubscriptionPutRequestV2026 - */ -export interface SubscriptionPutRequestV2026 { - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionPutRequestV2026 - */ - 'name'?: string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionPutRequestV2026 - */ - 'description'?: string; - /** - * - * @type {SubscriptionTypeV2026} - * @memberof SubscriptionPutRequestV2026 - */ - 'type'?: SubscriptionTypeV2026; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionPutRequestV2026 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2026} - * @memberof SubscriptionPutRequestV2026 - */ - 'httpConfig'?: HttpConfigV2026; - /** - * - * @type {EventBridgeConfigV2026} - * @memberof SubscriptionPutRequestV2026 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2026; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionPutRequestV2026 - */ - 'enabled'?: boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionPutRequestV2026 - */ - 'filter'?: string; -} - - -/** - * Subscription type. **NOTE** If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required. - * @export - * @enum {string} - */ - -export const SubscriptionTypeV2026 = { - Http: 'HTTP', - Eventbridge: 'EVENTBRIDGE', - Inline: 'INLINE', - Script: 'SCRIPT', - Workflow: 'WORKFLOW' -} as const; - -export type SubscriptionTypeV2026 = typeof SubscriptionTypeV2026[keyof typeof SubscriptionTypeV2026]; - - -/** - * - * @export - * @interface SubscriptionV2026 - */ -export interface SubscriptionV2026 { - /** - * Subscription ID. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'id': string; - /** - * Subscription name. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'name': string; - /** - * Subscription description. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'description'?: string; - /** - * ID of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'triggerId': string; - /** - * Trigger name of trigger subscribed to. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'triggerName': string; - /** - * - * @type {SubscriptionTypeV2026} - * @memberof SubscriptionV2026 - */ - 'type': SubscriptionTypeV2026; - /** - * Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'responseDeadline'?: string; - /** - * - * @type {HttpConfigV2026} - * @memberof SubscriptionV2026 - */ - 'httpConfig'?: HttpConfigV2026; - /** - * - * @type {EventBridgeConfigV2026} - * @memberof SubscriptionV2026 - */ - 'eventBridgeConfig'?: EventBridgeConfigV2026; - /** - * Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. - * @type {boolean} - * @memberof SubscriptionV2026 - */ - 'enabled': boolean; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof SubscriptionV2026 - */ - 'filter'?: string; -} - - -/** - * - * @export - * @interface SubstringV2026 - */ -export interface SubstringV2026 { - /** - * The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data - * @type {number} - * @memberof SubstringV2026 - */ - 'begin': number; - /** - * This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. - * @type {number} - * @memberof SubstringV2026 - */ - 'beginOffset'?: number; - /** - * The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - * @type {number} - * @memberof SubstringV2026 - */ - 'end'?: number; - /** - * This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. - * @type {number} - * @memberof SubstringV2026 - */ - 'endOffset'?: number; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof SubstringV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof SubstringV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface SummaryResponseV2026 - */ -export interface SummaryResponseV2026 { - /** - * The endpoint of a SailPoint API - * @type {string} - * @memberof SummaryResponseV2026 - */ - 'RequestedUri'?: string; - /** - * Number of calls made to a specific SailPoint API - * @type {number} - * @memberof SummaryResponseV2026 - */ - 'NumberOfCalls'?: number; -} -/** - * - * @export - * @interface Tag1V2026 - */ -export interface Tag1V2026 { - /** - * The unique identifier for the tag. - * @type {number} - * @memberof Tag1V2026 - */ - 'id'?: number; - /** - * The display name or label for the tag. - * @type {string} - * @memberof Tag1V2026 - */ - 'name'?: string | null; -} -/** - * Tagged object\'s category. - * @export - * @interface TagTagCategoryRefsInnerV2026 - */ -export interface TagTagCategoryRefsInnerV2026 { - /** - * DTO type of the tagged object\'s category. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2026 - */ - 'type'?: TagTagCategoryRefsInnerV2026TypeV2026; - /** - * Tagged object\'s ID. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2026 - */ - 'id'?: string; - /** - * Tagged object\'s display name. - * @type {string} - * @memberof TagTagCategoryRefsInnerV2026 - */ - 'name'?: string; -} - -export const TagTagCategoryRefsInnerV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TagTagCategoryRefsInnerV2026TypeV2026 = typeof TagTagCategoryRefsInnerV2026TypeV2026[keyof typeof TagTagCategoryRefsInnerV2026TypeV2026]; - -/** - * - * @export - * @interface TagV2026 - */ -export interface TagV2026 { - /** - * Tag id - * @type {string} - * @memberof TagV2026 - */ - 'id': string; - /** - * Name of the tag. - * @type {string} - * @memberof TagV2026 - */ - 'name': string; - /** - * Date the tag was created. - * @type {string} - * @memberof TagV2026 - */ - 'created': string; - /** - * Date the tag was last modified. - * @type {string} - * @memberof TagV2026 - */ - 'modified': string; - /** - * - * @type {Array} - * @memberof TagV2026 - */ - 'tagCategoryRefs': Array; -} -/** - * - * @export - * @interface TaggedObjectDtoV2026 - */ -export interface TaggedObjectDtoV2026 { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectDtoV2026 - */ - 'type'?: TaggedObjectDtoV2026TypeV2026; - /** - * ID of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2026 - */ - 'id'?: string; - /** - * Human-readable display name of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDtoV2026 - */ - 'name'?: string | null; -} - -export const TaggedObjectDtoV2026TypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectDtoV2026TypeV2026 = typeof TaggedObjectDtoV2026TypeV2026[keyof typeof TaggedObjectDtoV2026TypeV2026]; - -/** - * Tagged object. - * @export - * @interface TaggedObjectV2026 - */ -export interface TaggedObjectV2026 { - /** - * - * @type {TaggedObjectDtoV2026} - * @memberof TaggedObjectV2026 - */ - 'objectRef'?: TaggedObjectDtoV2026; - /** - * Labels to be applied to an Object - * @type {Array} - * @memberof TaggedObjectV2026 - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface TargetV2026 - */ -export interface TargetV2026 { - /** - * Target ID - * @type {string} - * @memberof TargetV2026 - */ - 'id'?: string; - /** - * Target type - * @type {string} - * @memberof TargetV2026 - */ - 'type'?: TargetV2026TypeV2026 | null; - /** - * Target name - * @type {string} - * @memberof TargetV2026 - */ - 'name'?: string; -} - -export const TargetV2026TypeV2026 = { - Application: 'APPLICATION', - Identity: 'IDENTITY' -} as const; - -export type TargetV2026TypeV2026 = typeof TargetV2026TypeV2026[keyof typeof TargetV2026TypeV2026]; - -/** - * Definition of a type of task, used to invoke tasks - * @export - * @interface TaskDefinitionSummaryV2026 - */ -export interface TaskDefinitionSummaryV2026 { - /** - * System-generated unique ID of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2026 - */ - 'id': string; - /** - * Name of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2026 - */ - 'uniqueName': string; - /** - * Description of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2026 - */ - 'description': string | null; - /** - * Name of the parent of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2026 - */ - 'parentName': string; - /** - * Executor of the TaskDefinition - * @type {string} - * @memberof TaskDefinitionSummaryV2026 - */ - 'executor': string | null; - /** - * Formal parameters of the TaskDefinition, without values - * @type {{ [key: string]: any; }} - * @memberof TaskDefinitionSummaryV2026 - */ - 'arguments': { [key: string]: any; }; -} -/** - * - * @export - * @interface TaskInfoV2026 - */ -export interface TaskInfoV2026 { - /** - * The unique identifier for the task. - * @type {number} - * @memberof TaskInfoV2026 - */ - 'taskId'?: number | null; - /** - * The type or category of the task. - * @type {string} - * @memberof TaskInfoV2026 - */ - 'taskTypeName'?: string | null; - /** - * The start time of the task, represented as epoch seconds. - * @type {number} - * @memberof TaskInfoV2026 - */ - 'startTime'?: number | null; - /** - * The end time of the task, represented as epoch seconds. - * @type {number} - * @memberof TaskInfoV2026 - */ - 'endTime'?: number | null; - /** - * The display name of the task. - * @type {string} - * @memberof TaskInfoV2026 - */ - 'taskName'?: string | null; - /** - * The display name of the user who created the task. - * @type {string} - * @memberof TaskInfoV2026 - */ - 'createdByDisplayName'?: string | null; - /** - * The progress of the task, typically represented as a percentage (0-100). - * @type {number} - * @memberof TaskInfoV2026 - */ - 'progress'?: number; - /** - * The current status of the task (e.g., \"Running\", \"Completed\", \"Failed\"). - * @type {string} - * @memberof TaskInfoV2026 - */ - 'status'?: string | null; - /** - * Additional details or information about the task. - * @type {string} - * @memberof TaskInfoV2026 - */ - 'details'?: string | null; - /** - * The unique identifier of the associated scheduled task, if applicable. - * @type {number} - * @memberof TaskInfoV2026 - */ - 'scheduleTaskId'?: number | null; -} -/** - * - * @export - * @interface TaskResultDetailsMessagesInnerV2026 - */ -export interface TaskResultDetailsMessagesInnerV2026 { - /** - * Type of the message. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2026 - */ - 'type'?: TaskResultDetailsMessagesInnerV2026TypeV2026; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2026 - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInnerV2026 - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2026 - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof TaskResultDetailsMessagesInnerV2026 - */ - 'localizedText'?: string; -} - -export const TaskResultDetailsMessagesInnerV2026TypeV2026 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskResultDetailsMessagesInnerV2026TypeV2026 = typeof TaskResultDetailsMessagesInnerV2026TypeV2026[keyof typeof TaskResultDetailsMessagesInnerV2026TypeV2026]; - -/** - * - * @export - * @interface TaskResultDetailsReturnsInnerV2026 - */ -export interface TaskResultDetailsReturnsInnerV2026 { - /** - * Attribute description. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2026 - */ - 'displayLabel'?: string; - /** - * System or database attribute name. - * @type {string} - * @memberof TaskResultDetailsReturnsInnerV2026 - */ - 'attributeName'?: string; -} -/** - * Details about job or task type, state and lifecycle. - * @export - * @interface TaskResultDetailsV2026 - */ -export interface TaskResultDetailsV2026 { - /** - * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'type'?: TaskResultDetailsV2026TypeV2026; - /** - * Unique task definition identifier. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'id'?: string; - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'reportType'?: TaskResultDetailsV2026ReportTypeV2026; - /** - * Description of the report purpose and/or contents. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'description'?: string; - /** - * Name of the parent task/report if exists. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'parentName'?: string | null; - /** - * Name of the report processing initiator. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'launcher'?: string; - /** - * Report creation date - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'created'?: string; - /** - * Report start date - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'launched'?: string | null; - /** - * Report completion date - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'completed'?: string | null; - /** - * Report completion status. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'completionStatus'?: TaskResultDetailsV2026CompletionStatusV2026 | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof TaskResultDetailsV2026 - */ - 'messages'?: Array; - /** - * Task definition results, if necessary. - * @type {Array} - * @memberof TaskResultDetailsV2026 - */ - 'returns'?: Array; - /** - * Extra attributes map(dictionary) needed for the report. - * @type {object} - * @memberof TaskResultDetailsV2026 - */ - 'attributes'?: object; - /** - * Current report state. - * @type {string} - * @memberof TaskResultDetailsV2026 - */ - 'progress'?: string | null; -} - -export const TaskResultDetailsV2026TypeV2026 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - Mentos: 'MENTOS', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskResultDetailsV2026TypeV2026 = typeof TaskResultDetailsV2026TypeV2026[keyof typeof TaskResultDetailsV2026TypeV2026]; -export const TaskResultDetailsV2026ReportTypeV2026 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type TaskResultDetailsV2026ReportTypeV2026 = typeof TaskResultDetailsV2026ReportTypeV2026[keyof typeof TaskResultDetailsV2026ReportTypeV2026]; -export const TaskResultDetailsV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type TaskResultDetailsV2026CompletionStatusV2026 = typeof TaskResultDetailsV2026CompletionStatusV2026[keyof typeof TaskResultDetailsV2026CompletionStatusV2026]; - -/** - * Task result. - * @export - * @interface TaskResultDtoV2026 - */ -export interface TaskResultDtoV2026 { - /** - * Task result DTO type. - * @type {string} - * @memberof TaskResultDtoV2026 - */ - 'type'?: TaskResultDtoV2026TypeV2026; - /** - * Task result ID. - * @type {string} - * @memberof TaskResultDtoV2026 - */ - 'id'?: string; - /** - * Task result display name. - * @type {string} - * @memberof TaskResultDtoV2026 - */ - 'name'?: string | null; -} - -export const TaskResultDtoV2026TypeV2026 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type TaskResultDtoV2026TypeV2026 = typeof TaskResultDtoV2026TypeV2026[keyof typeof TaskResultDtoV2026TypeV2026]; - -/** - * - * @export - * @interface TaskResultResponseV2026 - */ -export interface TaskResultResponseV2026 { - /** - * the type of response reference - * @type {string} - * @memberof TaskResultResponseV2026 - */ - 'type'?: string; - /** - * the task ID - * @type {string} - * @memberof TaskResultResponseV2026 - */ - 'id'?: string; - /** - * the task name (not used in this endpoint, always null) - * @type {string} - * @memberof TaskResultResponseV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface TaskResultSimplifiedV2026 - */ -export interface TaskResultSimplifiedV2026 { - /** - * Task identifier - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'id'?: string; - /** - * Task name - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'name'?: string; - /** - * Task description - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'description'?: string; - /** - * User or process who launched the task - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'launcher'?: string; - /** - * Date time of completion - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'completed'?: string; - /** - * Date time when the task was launched - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'launched'?: string; - /** - * Task result status - * @type {string} - * @memberof TaskResultSimplifiedV2026 - */ - 'completionStatus'?: TaskResultSimplifiedV2026CompletionStatusV2026; -} - -export const TaskResultSimplifiedV2026CompletionStatusV2026 = { - Success: 'Success', - Warning: 'Warning', - Error: 'Error', - Terminated: 'Terminated', - TempError: 'TempError' -} as const; - -export type TaskResultSimplifiedV2026CompletionStatusV2026 = typeof TaskResultSimplifiedV2026CompletionStatusV2026[keyof typeof TaskResultSimplifiedV2026CompletionStatusV2026]; - -/** - * Task return details - * @export - * @interface TaskReturnDetailsV2026 - */ -export interface TaskReturnDetailsV2026 { - /** - * Display name of the TaskReturnDetails - * @type {string} - * @memberof TaskReturnDetailsV2026 - */ - 'name': string; - /** - * Attribute the TaskReturnDetails is for - * @type {string} - * @memberof TaskReturnDetailsV2026 - */ - 'attributeName': string; -} -/** - * - * @export - * @interface TaskStatusMessageParametersInnerV2026 - */ -export interface TaskStatusMessageParametersInnerV2026 { -} -/** - * TaskStatus Message - * @export - * @interface TaskStatusMessageV2026 - */ -export interface TaskStatusMessageV2026 { - /** - * Type of the message - * @type {string} - * @memberof TaskStatusMessageV2026 - */ - 'type': TaskStatusMessageV2026TypeV2026; - /** - * - * @type {LocalizedMessageV2026} - * @memberof TaskStatusMessageV2026 - */ - 'localizedText': LocalizedMessageV2026 | null; - /** - * Key of the message - * @type {string} - * @memberof TaskStatusMessageV2026 - */ - 'key': string; - /** - * Message parameters for internationalization - * @type {Array} - * @memberof TaskStatusMessageV2026 - */ - 'parameters': Array | null; -} - -export const TaskStatusMessageV2026TypeV2026 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskStatusMessageV2026TypeV2026 = typeof TaskStatusMessageV2026TypeV2026[keyof typeof TaskStatusMessageV2026TypeV2026]; - -/** - * Details and current status of a specific task - * @export - * @interface TaskStatusV2026 - */ -export interface TaskStatusV2026 { - /** - * System-generated unique ID of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'id': string; - /** - * Type of task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'type': TaskStatusV2026TypeV2026; - /** - * Name of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'uniqueName': string; - /** - * Description of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'description': string; - /** - * Name of the parent of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'parentName': string | null; - /** - * Service to execute the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'launcher': string; - /** - * - * @type {TargetV2026} - * @memberof TaskStatusV2026 - */ - 'target'?: TargetV2026 | null; - /** - * Creation date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'created': string; - /** - * Last modification date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'modified': string | null; - /** - * Launch date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'launched': string | null; - /** - * Completion date of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'completed': string | null; - /** - * Completion status of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'completionStatus': TaskStatusV2026CompletionStatusV2026 | null; - /** - * Messages associated with the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2026 - */ - 'messages': Array; - /** - * Return values from the task this TaskStatus represents - * @type {Array} - * @memberof TaskStatusV2026 - */ - 'returns': Array; - /** - * Attributes of the task this TaskStatus represents - * @type {{ [key: string]: any; }} - * @memberof TaskStatusV2026 - */ - 'attributes': { [key: string]: any; }; - /** - * Current progress of the task this TaskStatus represents - * @type {string} - * @memberof TaskStatusV2026 - */ - 'progress': string | null; - /** - * Current percentage completion of the task this TaskStatus represents - * @type {number} - * @memberof TaskStatusV2026 - */ - 'percentComplete': number; - /** - * - * @type {TaskDefinitionSummaryV2026} - * @memberof TaskStatusV2026 - */ - 'taskDefinitionSummary'?: TaskDefinitionSummaryV2026; -} - -export const TaskStatusV2026TypeV2026 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskStatusV2026TypeV2026 = typeof TaskStatusV2026TypeV2026[keyof typeof TaskStatusV2026TypeV2026]; -export const TaskStatusV2026CompletionStatusV2026 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - Temperror: 'TEMPERROR' -} as const; - -export type TaskStatusV2026CompletionStatusV2026 = typeof TaskStatusV2026CompletionStatusV2026[keyof typeof TaskStatusV2026CompletionStatusV2026]; - -/** - * - * @export - * @interface TemplateBulkDeleteDtoV2026 - */ -export interface TemplateBulkDeleteDtoV2026 { - /** - * The template key to delete - * @type {string} - * @memberof TemplateBulkDeleteDtoV2026 - */ - 'key': string; - /** - * The notification medium (EMAIL, SLACK, or TEAMS) - * @type {string} - * @memberof TemplateBulkDeleteDtoV2026 - */ - 'medium'?: TemplateBulkDeleteDtoV2026MediumV2026; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateBulkDeleteDtoV2026 - */ - 'locale'?: string; -} - -export const TemplateBulkDeleteDtoV2026MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateBulkDeleteDtoV2026MediumV2026 = typeof TemplateBulkDeleteDtoV2026MediumV2026[keyof typeof TemplateBulkDeleteDtoV2026MediumV2026]; - -/** - * - * @export - * @interface TemplateDtoDefaultV2026 - */ -export interface TemplateDtoDefaultV2026 { - /** - * The key of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'key'?: string; - /** - * The name of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'medium'?: TemplateDtoDefaultV2026MediumV2026; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'locale'?: string; - /** - * The subject of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'subject'?: string | null; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2026 - * @deprecated - */ - 'header'?: string | null; - /** - * The body of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoDefaultV2026 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'from'?: string | null; - /** - * The \"Reply To\" field of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'replyTo'?: string | null; - /** - * The description of the default template - * @type {string} - * @memberof TemplateDtoDefaultV2026 - */ - 'description'?: string | null; - /** - * - * @type {TemplateSlackV2026} - * @memberof TemplateDtoDefaultV2026 - */ - 'slackTemplate'?: TemplateSlackV2026 | null; - /** - * - * @type {TemplateTeamsV2026} - * @memberof TemplateDtoDefaultV2026 - */ - 'teamsTemplate'?: TemplateTeamsV2026 | null; -} - -export const TemplateDtoDefaultV2026MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoDefaultV2026MediumV2026 = typeof TemplateDtoDefaultV2026MediumV2026[keyof typeof TemplateDtoDefaultV2026MediumV2026]; - -/** - * - * @export - * @interface TemplateDtoSlackTemplateV2026 - */ -export interface TemplateDtoSlackTemplateV2026 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2026} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2026 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2026} - * @memberof TemplateDtoSlackTemplateV2026 - */ - 'customFields'?: TemplateSlackCustomFieldsV2026 | null; -} -/** - * - * @export - * @interface TemplateDtoTeamsTemplateV2026 - */ -export interface TemplateDtoTeamsTemplateV2026 { - /** - * The template key - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2026} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2026 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2026} - * @memberof TemplateDtoTeamsTemplateV2026 - */ - 'customFields'?: TemplateSlackCustomFieldsV2026 | null; -} -/** - * - * @export - * @interface TemplateDtoV2026 - */ -export interface TemplateDtoV2026 { - /** - * The key of the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'key': string; - /** - * The name of the Task Manager Subscription - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'name'?: string; - /** - * The message medium. More mediums may be added in the future. - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'medium': TemplateDtoV2026MediumV2026; - /** - * The locale for the message text, a BCP 47 language tag. - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'locale': string; - /** - * The subject line in the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'subject'?: string; - /** - * The header value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2026 - * @deprecated - */ - 'header'?: string | null; - /** - * The body in the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'body'?: string; - /** - * The footer value is now located within the body field. If included with non-null values, will result in a 400. - * @type {string} - * @memberof TemplateDtoV2026 - * @deprecated - */ - 'footer'?: string | null; - /** - * The \"From:\" address in the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'from'?: string; - /** - * The \"Reply To\" line in the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'replyTo'?: string; - /** - * The description in the template - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'description'?: string; - /** - * This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'id'?: string; - /** - * The time when this template is created. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'created'?: string; - /** - * The time when this template was last modified. This is auto-generated. - * @type {string} - * @memberof TemplateDtoV2026 - */ - 'modified'?: string; - /** - * - * @type {TemplateDtoSlackTemplateV2026} - * @memberof TemplateDtoV2026 - */ - 'slackTemplate'?: TemplateDtoSlackTemplateV2026; - /** - * - * @type {TemplateDtoTeamsTemplateV2026} - * @memberof TemplateDtoV2026 - */ - 'teamsTemplate'?: TemplateDtoTeamsTemplateV2026; -} - -export const TemplateDtoV2026MediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateDtoV2026MediumV2026 = typeof TemplateDtoV2026MediumV2026[keyof typeof TemplateDtoV2026MediumV2026]; - -/** - * The notification delivery medium. - * @export - * @enum {string} - */ - -export const TemplateMediumDtoV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; - -export type TemplateMediumDtoV2026 = typeof TemplateMediumDtoV2026[keyof typeof TemplateMediumDtoV2026]; - - -/** - * - * @export - * @interface TemplateSlackAutoApprovalDataV2026 - */ -export interface TemplateSlackAutoApprovalDataV2026 { - /** - * Whether the request was auto-approved - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2026 - */ - 'isAutoApproved'?: string | null; - /** - * The item ID - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2026 - */ - 'itemId'?: string | null; - /** - * The item type - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2026 - */ - 'itemType'?: string | null; - /** - * JSON message for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2026 - */ - 'autoApprovalMessageJSON'?: string | null; - /** - * Title for auto-approval - * @type {string} - * @memberof TemplateSlackAutoApprovalDataV2026 - */ - 'autoApprovalTitle'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackCustomFieldsV2026 - */ -export interface TemplateSlackCustomFieldsV2026 { - /** - * The type of request - * @type {string} - * @memberof TemplateSlackCustomFieldsV2026 - */ - 'requestType'?: string | null; - /** - * Whether the request contains a deny action - * @type {string} - * @memberof TemplateSlackCustomFieldsV2026 - */ - 'containsDeny'?: string | null; - /** - * The campaign ID - * @type {string} - * @memberof TemplateSlackCustomFieldsV2026 - */ - 'campaignId'?: string | null; - /** - * The campaign status - * @type {string} - * @memberof TemplateSlackCustomFieldsV2026 - */ - 'campaignStatus'?: string | null; -} -/** - * - * @export - * @interface TemplateSlackV2026 - */ -export interface TemplateSlackV2026 { - /** - * The template key - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'key'?: string | null; - /** - * The main text content of the Slack message - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'text'?: string; - /** - * JSON string of Slack Block Kit blocks for rich formatting - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'blocks'?: string | null; - /** - * JSON string of Slack attachments - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'attachments'?: string; - /** - * The type of notification - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'notificationType'?: string | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateSlackV2026 - */ - 'requestedById'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateSlackV2026 - */ - 'isSubscription'?: boolean | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2026} - * @memberof TemplateSlackV2026 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2026 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2026} - * @memberof TemplateSlackV2026 - */ - 'customFields'?: TemplateSlackCustomFieldsV2026 | null; -} -/** - * - * @export - * @interface TemplateTeamsV2026 - */ -export interface TemplateTeamsV2026 { - /** - * The template key - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'key'?: string | null; - /** - * The title of the Teams message - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'title'?: string | null; - /** - * The main text content of the Teams message - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'text'?: string; - /** - * JSON string of the Teams adaptive card - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'messageJSON'?: string | null; - /** - * Whether this is a subscription notification - * @type {boolean} - * @memberof TemplateTeamsV2026 - */ - 'isSubscription'?: boolean | null; - /** - * The approval request ID - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'approvalId'?: string | null; - /** - * The request ID - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'requestId'?: string | null; - /** - * The ID of the user who made the request - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'requestedById'?: string | null; - /** - * The type of notification - * @type {string} - * @memberof TemplateTeamsV2026 - */ - 'notificationType'?: string | null; - /** - * - * @type {TemplateSlackAutoApprovalDataV2026} - * @memberof TemplateTeamsV2026 - */ - 'autoApprovalData'?: TemplateSlackAutoApprovalDataV2026 | null; - /** - * - * @type {TemplateSlackCustomFieldsV2026} - * @memberof TemplateTeamsV2026 - */ - 'customFields'?: TemplateSlackCustomFieldsV2026 | null; -} -/** - * A variable available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). Template variables provide self-documenting metadata about what variables are available when customizing notification templates. - * @export - * @interface TemplateVariableV2026 - */ -export interface TemplateVariableV2026 { - /** - * The variable name as used when rendering context in templates. - * @type {string} - * @memberof TemplateVariableV2026 - */ - 'key'?: string; - /** - * The data type for this variable. Use JSON Schema-like names for values (string, boolean, number, object, array) or \"function\" for template utility/helper functions (e.g. __dateTool.format(), __esc.html()). - * @type {string} - * @memberof TemplateVariableV2026 - */ - 'type'?: TemplateVariableV2026TypeV2026; - /** - * Human-readable description explaining what this variable represents. - * @type {string} - * @memberof TemplateVariableV2026 - */ - 'description'?: string | null; - /** - * Example value demonstrating the format and usage. For type \"function\", often a Velocity-style call (e.g. $__esc.html($value)). Can be a string, number, boolean, object, array, or null when no example is defined. - * @type {object} - * @memberof TemplateVariableV2026 - */ - 'example'?: object | null; -} - -export const TemplateVariableV2026TypeV2026 = { - String: 'string', - Boolean: 'boolean', - Number: 'number', - Object: 'object', - Array: 'array', - Function: 'function' -} as const; - -export type TemplateVariableV2026TypeV2026 = typeof TemplateVariableV2026TypeV2026[keyof typeof TemplateVariableV2026TypeV2026]; - -/** - * Variables available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). - * @export - * @interface TemplateVariablesDtoV2026 - */ -export interface TemplateVariablesDtoV2026 { - /** - * The notification template key. - * @type {string} - * @memberof TemplateVariablesDtoV2026 - */ - 'key'?: string; - /** - * - * @type {TemplateMediumDtoV2026} - * @memberof TemplateVariablesDtoV2026 - */ - 'medium'?: TemplateMediumDtoV2026; - /** - * Global variables available to all templates for this tenant (e.g. __global.*, __recipient, __util.*, __dateTool.*, __esc.*). Includes both data variables and function-type helpers. - * @type {Array} - * @memberof TemplateVariablesDtoV2026 - */ - 'globalVariables'?: Array | null; - /** - * Template-specific variables for the given key and medium (e.g. approverPath, requester, attributes). - * @type {Array} - * @memberof TemplateVariablesDtoV2026 - */ - 'templateVariables'?: Array | null; -} - - -/** - * Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) - * @export - * @interface TenantConfigurationDetailsV2026 - */ -export interface TenantConfigurationDetailsV2026 { - /** - * Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. - * @type {boolean} - * @memberof TenantConfigurationDetailsV2026 - */ - 'disabled'?: boolean | null; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationRequestV2026 - */ -export interface TenantConfigurationRequestV2026 { - /** - * - * @type {TenantConfigurationDetailsV2026} - * @memberof TenantConfigurationRequestV2026 - */ - 'configDetails'?: TenantConfigurationDetailsV2026; -} -/** - * Tenant-wide Reassignment Configuration settings - * @export - * @interface TenantConfigurationResponseV2026 - */ -export interface TenantConfigurationResponseV2026 { - /** - * - * @type {AuditDetailsV2026} - * @memberof TenantConfigurationResponseV2026 - */ - 'auditDetails'?: AuditDetailsV2026; - /** - * - * @type {TenantConfigurationDetailsV2026} - * @memberof TenantConfigurationResponseV2026 - */ - 'configDetails'?: TenantConfigurationDetailsV2026; -} -/** - * - * @export - * @interface TenantUiMetadataItemResponseV2026 - */ -export interface TenantUiMetadataItemResponseV2026 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemResponseV2026 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2026 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemResponseV2026 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantUiMetadataItemUpdateRequestV2026 - */ -export interface TenantUiMetadataItemUpdateRequestV2026 { - /** - * Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2026 - */ - 'iframeWhiteList'?: string | null; - /** - * Descriptor for the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2026 - */ - 'usernameLabel'?: string | null; - /** - * Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". - * @type {string} - * @memberof TenantUiMetadataItemUpdateRequestV2026 - */ - 'usernameEmptyText'?: string | null; -} -/** - * - * @export - * @interface TenantV2026 - */ -export interface TenantV2026 { - /** - * The unique identifier for the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'id'?: string; - /** - * Abbreviated name of the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'name'?: string; - /** - * Human-readable name of the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'fullName'?: string; - /** - * Deployment pod for the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'pod'?: string; - /** - * Deployment region for the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'region'?: string; - /** - * Description of the Tenant - * @type {string} - * @memberof TenantV2026 - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof TenantV2026 - */ - 'products'?: Array; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflow200ResponseV2026 - */ -export interface TestExternalExecuteWorkflow200ResponseV2026 { - /** - * The input that was received - * @type {object} - * @memberof TestExternalExecuteWorkflow200ResponseV2026 - */ - 'payload'?: object; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflowRequestV2026 - */ -export interface TestExternalExecuteWorkflowRequestV2026 { - /** - * The test input for the workflow - * @type {object} - * @memberof TestExternalExecuteWorkflowRequestV2026 - */ - 'input'?: object; -} -/** - * - * @export - * @interface TestInvocationV2026 - */ -export interface TestInvocationV2026 { - /** - * Trigger ID - * @type {string} - * @memberof TestInvocationV2026 - */ - 'triggerId': string; - /** - * Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. - * @type {object} - * @memberof TestInvocationV2026 - */ - 'input'?: object; - /** - * JSON map of invocation metadata. - * @type {object} - * @memberof TestInvocationV2026 - */ - 'contentJson': object; - /** - * Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. - * @type {Array} - * @memberof TestInvocationV2026 - */ - 'subscriptionIds'?: Array; -} -/** - * - * @export - * @interface TestSourceConnectionMultihost200ResponseV2026 - */ -export interface TestSourceConnectionMultihost200ResponseV2026 { - /** - * Source\'s test connection status. - * @type {boolean} - * @memberof TestSourceConnectionMultihost200ResponseV2026 - */ - 'success'?: boolean; - /** - * Source\'s test connection message. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2026 - */ - 'message'?: string; - /** - * Source\'s test connection timing. - * @type {number} - * @memberof TestSourceConnectionMultihost200ResponseV2026 - */ - 'timing'?: number; - /** - * Source\'s human-readable result type. - * @type {object} - * @memberof TestSourceConnectionMultihost200ResponseV2026 - */ - 'resultType'?: TestSourceConnectionMultihost200ResponseV2026ResultTypeV2026; - /** - * Source\'s human-readable test connection details. - * @type {string} - * @memberof TestSourceConnectionMultihost200ResponseV2026 - */ - 'testConnectionDetails'?: string; -} - -export const TestSourceConnectionMultihost200ResponseV2026ResultTypeV2026 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS', - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT' -} as const; - -export type TestSourceConnectionMultihost200ResponseV2026ResultTypeV2026 = typeof TestSourceConnectionMultihost200ResponseV2026ResultTypeV2026[keyof typeof TestSourceConnectionMultihost200ResponseV2026ResultTypeV2026]; - -/** - * - * @export - * @interface TestWorkflow200ResponseV2026 - */ -export interface TestWorkflow200ResponseV2026 { - /** - * The workflow execution id - * @type {string} - * @memberof TestWorkflow200ResponseV2026 - */ - 'workflowExecutionId'?: string; -} -/** - * - * @export - * @interface TestWorkflowRequestV2026 - */ -export interface TestWorkflowRequestV2026 { - /** - * The test input for the workflow. - * @type {object} - * @memberof TestWorkflowRequestV2026 - */ - 'input': object; -} -/** - * Query parameters used to construct an Elasticsearch text query object. - * @export - * @interface TextQueryV2026 - */ -export interface TextQueryV2026 { - /** - * Words or characters that specify a particular thing to be searched for. - * @type {Array} - * @memberof TextQueryV2026 - */ - 'terms': Array; - /** - * The fields to be searched. - * @type {Array} - * @memberof TextQueryV2026 - */ - 'fields': Array; - /** - * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - * @type {boolean} - * @memberof TextQueryV2026 - */ - 'matchAny'?: boolean; - /** - * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - * @type {boolean} - * @memberof TextQueryV2026 - */ - 'contains'?: boolean; -} -/** - * @type TransformAttributesV2026 - * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - * @export - */ -export type TransformAttributesV2026 = AccountAttributeV2026 | Base64DecodeV2026 | Base64EncodeV2026 | ConcatenationV2026 | ConditionalV2026 | DateCompareV2026 | DateFormatV2026 | DateMathV2026 | DecomposeDiacriticalMarksV2026 | E164phoneV2026 | FirstValidV2026 | ISO3166V2026 | IdentityAttribute1V2026 | IndexOfV2026 | LeftPadV2026 | LookupV2026 | LowerV2026 | NameNormalizerV2026 | RandomAlphaNumericV2026 | RandomNumericV2026 | ReferenceV2026 | ReplaceAllV2026 | ReplaceV2026 | RightPadV2026 | RuleV2026 | SplitV2026 | StaticV2026 | SubstringV2026 | TrimV2026 | UUIDGeneratorV2026 | UpperV2026; - -/** - * - * @export - * @interface TransformDefinitionV2026 - */ -export interface TransformDefinitionV2026 { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinitionV2026 - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinitionV2026 - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TransformReadV2026 - */ -export interface TransformReadV2026 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformReadV2026 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformReadV2026 - */ - 'type': TransformReadV2026TypeV2026; - /** - * - * @type {TransformAttributesV2026} - * @memberof TransformReadV2026 - */ - 'attributes': TransformAttributesV2026 | null; - /** - * Unique ID of this transform - * @type {string} - * @memberof TransformReadV2026 - */ - 'id': string; - /** - * Indicates whether this is an internal SailPoint-created transform or a customer-created transform - * @type {boolean} - * @memberof TransformReadV2026 - */ - 'internal': boolean; -} - -export const TransformReadV2026TypeV2026 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformReadV2026TypeV2026 = typeof TransformReadV2026TypeV2026[keyof typeof TransformReadV2026TypeV2026]; - -/** - * - * @export - * @interface TransformRuleV2026 - */ -export interface TransformRuleV2026 { - /** - * This is the name of the Transform rule that needs to be invoked by the transform - * @type {string} - * @memberof TransformRuleV2026 - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TransformRuleV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * The representation of an internally- or customer-defined transform. - * @export - * @interface TransformV2026 - */ -export interface TransformV2026 { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformV2026 - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformV2026 - */ - 'type': TransformV2026TypeV2026; - /** - * - * @type {TransformAttributesV2026} - * @memberof TransformV2026 - */ - 'attributes': TransformAttributesV2026 | null; -} - -export const TransformV2026TypeV2026 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformV2026TypeV2026 = typeof TransformV2026TypeV2026[keyof typeof TransformV2026TypeV2026]; - -/** - * - * @export - * @interface TranslationMessageV2026 - */ -export interface TranslationMessageV2026 { - /** - * The key of the translation message - * @type {string} - * @memberof TranslationMessageV2026 - */ - 'key'?: string; - /** - * The values corresponding to the translation messages - * @type {Array} - * @memberof TranslationMessageV2026 - */ - 'values'?: Array; -} -/** - * SSF transmitter discovery metadata per the SSF specification. - * @export - * @interface TransmitterMetadataV2026 - */ -export interface TransmitterMetadataV2026 { - /** - * Version of the SSF specification supported. - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'spec_version'?: string; - /** - * Base URL of the transmitter (issuer). - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'issuer'?: string; - /** - * URL of the transmitter\'s JSON Web Key Set. - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'jwks_uri'?: string; - /** - * Supported delivery methods (e.g. push URN). - * @type {Array} - * @memberof TransmitterMetadataV2026 - */ - 'delivery_methods_supported'?: Array; - /** - * Endpoint for stream configuration (create, read, update, replace, delete). - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'configuration_endpoint'?: string; - /** - * Endpoint for reading and updating stream status. - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'status_endpoint'?: string; - /** - * Endpoint for receiver verification. - * @type {string} - * @memberof TransmitterMetadataV2026 - */ - 'verification_endpoint'?: string; - /** - * Supported authorization schemes (e.g. OAuth2, Bearer). - * @type {Array} - * @memberof TransmitterMetadataV2026 - */ - 'authorization_schemes'?: Array; -} -/** - * @type TriggerExampleInputV2026 - * An example of the JSON payload that will be sent by the trigger to the subscribed service. - * @export - */ -export type TriggerExampleInputV2026 = AccessRequestDynamicApproverV2026 | AccessRequestPostApprovalV2026 | AccessRequestPreApprovalV2026 | AccountAggregationCompletedV2026 | AccountAttributesChangedV2026 | AccountCorrelatedV2026 | AccountCreatedV2026 | AccountDeletedV2026 | AccountUncorrelatedV2026 | AccountUpdatedV2026 | AccountsCollectedForAggregationV2026 | CampaignActivatedV2026 | CampaignEndedV2026 | CampaignGeneratedV2026 | CertificationSignedOffV2026 | IdentityAttributesChangedV2026 | IdentityCreatedV2026 | IdentityDeletedV2026 | MachineIdentityCreatedV2026 | MachineIdentityDeletedV2026 | MachineIdentityUpdatedV2026 | ProvisioningCompletedV2026 | SavedSearchCompleteV2026 | SourceAccountCreatedV2026 | SourceAccountDeletedV2026 | SourceAccountUpdatedV2026 | SourceCreatedV2026 | SourceDeletedV2026 | SourceUpdatedV2026 | VAClusterStatusChangeEventV2026; - -/** - * @type TriggerExampleOutputV2026 - * An example of the JSON payload that will be sent by the subscribed service to the trigger in response to an event. - * @export - */ -export type TriggerExampleOutputV2026 = AccessRequestDynamicApprover1V2026 | AccessRequestPreApproval1V2026; - -/** - * The type of trigger. - * @export - * @enum {string} - */ - -export const TriggerTypeV2026 = { - RequestResponse: 'REQUEST_RESPONSE', - FireAndForget: 'FIRE_AND_FORGET' -} as const; - -export type TriggerTypeV2026 = typeof TriggerTypeV2026[keyof typeof TriggerTypeV2026]; - - -/** - * - * @export - * @interface TriggerV2026 - */ -export interface TriggerV2026 { - /** - * Unique identifier of the trigger. - * @type {string} - * @memberof TriggerV2026 - */ - 'id': string; - /** - * Trigger Name. - * @type {string} - * @memberof TriggerV2026 - */ - 'name': string; - /** - * - * @type {TriggerTypeV2026} - * @memberof TriggerV2026 - */ - 'type': TriggerTypeV2026; - /** - * Trigger Description. - * @type {string} - * @memberof TriggerV2026 - */ - 'description'?: string; - /** - * The JSON schema of the payload that will be sent by the trigger to the subscribed service. - * @type {string} - * @memberof TriggerV2026 - */ - 'inputSchema': string; - /** - * - * @type {TriggerExampleInputV2026} - * @memberof TriggerV2026 - */ - 'exampleInput': TriggerExampleInputV2026; - /** - * The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. - * @type {string} - * @memberof TriggerV2026 - */ - 'outputSchema'?: string | null; - /** - * - * @type {TriggerExampleOutputV2026} - * @memberof TriggerV2026 - */ - 'exampleOutput'?: TriggerExampleOutputV2026 | null; -} - - -/** - * - * @export - * @interface TrimV2026 - */ -export interface TrimV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TrimV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof TrimV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" - * @export - * @interface TypeAheadQueryV2026 - */ -export interface TypeAheadQueryV2026 { - /** - * The type ahead query string used to construct a phrase prefix match query. - * @type {string} - * @memberof TypeAheadQueryV2026 - */ - 'query': string; - /** - * The field on which to perform the type ahead search. - * @type {string} - * @memberof TypeAheadQueryV2026 - */ - 'field': string; - /** - * The nested type. - * @type {string} - * @memberof TypeAheadQueryV2026 - */ - 'nestedType'?: string; - /** - * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. - * @type {number} - * @memberof TypeAheadQueryV2026 - */ - 'maxExpansions'?: number; - /** - * The max amount of records the search will return. - * @type {number} - * @memberof TypeAheadQueryV2026 - */ - 'size'?: number; - /** - * The sort order of the returned records. - * @type {string} - * @memberof TypeAheadQueryV2026 - */ - 'sort'?: string; - /** - * The flag that defines the sort type, by count or value. - * @type {boolean} - * @memberof TypeAheadQueryV2026 - */ - 'sortByValue'?: boolean; -} -/** - * A typed reference to the object. - * @export - * @interface TypedReferenceV2026 - */ -export interface TypedReferenceV2026 { - /** - * - * @type {DtoTypeV2026} - * @memberof TypedReferenceV2026 - */ - 'type': DtoTypeV2026; - /** - * The id of the object. - * @type {string} - * @memberof TypedReferenceV2026 - */ - 'id': string; -} - - -/** - * - * @export - * @interface UUIDGeneratorV2026 - */ -export interface UUIDGeneratorV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UUIDGeneratorV2026 - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) - * @export - * @interface UncorrelatedAccountsReportArgumentsV2026 - */ -export interface UncorrelatedAccountsReportArgumentsV2026 { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof UncorrelatedAccountsReportArgumentsV2026 - */ - 'selectedFormats'?: Array; -} - -export const UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026 = typeof UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026[keyof typeof UncorrelatedAccountsReportArgumentsV2026SelectedFormatsV2026]; - -/** - * - * @export - * @interface UpdateDetailV2026 - */ -export interface UpdateDetailV2026 { - /** - * The detailed message for an update. Typically the relevent error message when status is error. - * @type {string} - * @memberof UpdateDetailV2026 - */ - 'message'?: string; - /** - * The connector script name - * @type {string} - * @memberof UpdateDetailV2026 - */ - 'scriptName'?: string; - /** - * The list of updated files supported by the connector - * @type {Array} - * @memberof UpdateDetailV2026 - */ - 'updatedFiles'?: Array | null; - /** - * The connector update status - * @type {string} - * @memberof UpdateDetailV2026 - */ - 'status'?: UpdateDetailV2026StatusV2026; -} - -export const UpdateDetailV2026StatusV2026 = { - Error: 'ERROR', - Updated: 'UPDATED', - Unchanged: 'UNCHANGED', - Skipped: 'SKIPPED' -} as const; - -export type UpdateDetailV2026StatusV2026 = typeof UpdateDetailV2026StatusV2026[keyof typeof UpdateDetailV2026StatusV2026]; - -/** - * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - * @export - * @interface UpdateMultiHostSourcesRequestInnerV2026 - */ -export interface UpdateMultiHostSourcesRequestInnerV2026 { - /** - * The operation to be performed - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2026 - */ - 'op': UpdateMultiHostSourcesRequestInnerV2026OpV2026; - /** - * A string JSON Pointer representing the target path to an element to be affected by the operation - * @type {string} - * @memberof UpdateMultiHostSourcesRequestInnerV2026 - */ - 'path': string; - /** - * - * @type {UpdateMultiHostSourcesRequestInnerValueV2026} - * @memberof UpdateMultiHostSourcesRequestInnerV2026 - */ - 'value'?: UpdateMultiHostSourcesRequestInnerValueV2026; -} - -export const UpdateMultiHostSourcesRequestInnerV2026OpV2026 = { - Add: 'add', - Replace: 'replace' -} as const; - -export type UpdateMultiHostSourcesRequestInnerV2026OpV2026 = typeof UpdateMultiHostSourcesRequestInnerV2026OpV2026[keyof typeof UpdateMultiHostSourcesRequestInnerV2026OpV2026]; - -/** - * @type UpdateMultiHostSourcesRequestInnerValueV2026 - * The value to be used for the operation, required for \"add\" and \"replace\" operations - * @export - */ -export type UpdateMultiHostSourcesRequestInnerValueV2026 = Array | boolean | number | object | string; - -/** - * - * @export - * @interface UpdateScheduleRequestV2026 - */ -export interface UpdateScheduleRequestV2026 { - /** - * The type or category of the scheduled task. - * @type {string} - * @memberof UpdateScheduleRequestV2026 - */ - 'taskTypeName'?: string | null; - /** - * The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. - * @type {string} - * @memberof UpdateScheduleRequestV2026 - */ - 'scheduleType'?: string | null; - /** - * The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. - * @type {number} - * @memberof UpdateScheduleRequestV2026 - */ - 'interval'?: number | null; - /** - * The display name of the scheduled task. - * @type {string} - * @memberof UpdateScheduleRequestV2026 - */ - 'scheduleTaskName'?: string | null; - /** - * The start time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof UpdateScheduleRequestV2026 - */ - 'startTime'?: number; - /** - * The end time for the scheduled task, represented as epoch seconds. - * @type {number} - * @memberof UpdateScheduleRequestV2026 - */ - 'endTime'?: number; - /** - * A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). - * @type {Array} - * @memberof UpdateScheduleRequestV2026 - */ - 'daysOfWeek'?: Array | null; - /** - * Indicates whether the scheduled task is currently active. - * @type {boolean} - * @memberof UpdateScheduleRequestV2026 - */ - 'active'?: boolean; - /** - * The ID of another scheduled task that triggers this scheduled task upon its completion. - * @type {number} - * @memberof UpdateScheduleRequestV2026 - */ - 'runAfterScheduleTaskId'?: number | null; - /** - * The unique identifier of the application associated with the scheduled task. - * @type {number} - * @memberof UpdateScheduleRequestV2026 - */ - 'applicationId'?: number | null; -} -/** - * Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt. - * @export - * @interface UpdateStreamConfigResponseV2026 - */ -export interface UpdateStreamConfigResponseV2026 { - /** - * Unique stream identifier. - * @type {string} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'stream_id'?: string; - /** - * Issuer (transmitter) URL. - * @type {string} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'iss'?: string; - /** - * Audience for the stream. - * @type {string} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'aud'?: string; - /** - * - * @type {DeliveryResponseV2026} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'delivery'?: DeliveryResponseV2026; - /** - * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'events_supported'?: Array; - /** - * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'events_requested'?: Array; - /** - * Event types currently being delivered (intersection of supported and requested). - * @type {Array} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'events_delivered'?: Array; - /** - * Optional stream description. - * @type {string} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'description'?: string; - /** - * Inactivity timeout in seconds (optional). - * @type {number} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'inactivity_timeout'?: number; - /** - * Minimum verification interval in seconds (optional). - * @type {number} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'min_verification_interval'?: number; - /** - * Timestamp of the last configuration update. - * @type {string} - * @memberof UpdateStreamConfigResponseV2026 - */ - 'updatedAt'?: string; -} -/** - * Request body for PATCH /ssf/streams (partial update). - * @export - * @interface UpdateStreamConfigurationRequestV2026 - */ -export interface UpdateStreamConfigurationRequestV2026 { - /** - * ID of the stream to update. - * @type {string} - * @memberof UpdateStreamConfigurationRequestV2026 - */ - 'stream_id': string; - /** - * - * @type {DeliveryRequestV2026} - * @memberof UpdateStreamConfigurationRequestV2026 - */ - 'delivery'?: DeliveryRequestV2026; - /** - * Event types the receiver wants. Use CAEP event-type URIs. - * @type {Array} - * @memberof UpdateStreamConfigurationRequestV2026 - */ - 'events_requested'?: Array; - /** - * Optional human-readable description of the stream. - * @type {string} - * @memberof UpdateStreamConfigurationRequestV2026 - */ - 'description'?: string; -} -/** - * Request body for POST /ssf/streams/status. - * @export - * @interface UpdateStreamStatusRequestV2026 - */ -export interface UpdateStreamStatusRequestV2026 { - /** - * ID of the stream whose status to update. - * @type {string} - * @memberof UpdateStreamStatusRequestV2026 - */ - 'stream_id': string; - /** - * Desired stream status. - * @type {string} - * @memberof UpdateStreamStatusRequestV2026 - */ - 'status': UpdateStreamStatusRequestV2026StatusV2026; - /** - * Optional reason for the status change. - * @type {string} - * @memberof UpdateStreamStatusRequestV2026 - */ - 'reason'?: string; -} - -export const UpdateStreamStatusRequestV2026StatusV2026 = { - Enabled: 'enabled', - Paused: 'paused', - Disabled: 'disabled' -} as const; - -export type UpdateStreamStatusRequestV2026StatusV2026 = typeof UpdateStreamStatusRequestV2026StatusV2026[keyof typeof UpdateStreamStatusRequestV2026StatusV2026]; - -/** - * - * @export - * @interface UpperV2026 - */ -export interface UpperV2026 { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UpperV2026 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof UpperV2026 - */ - 'input'?: { [key: string]: any; }; -} -/** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @export - * @enum {string} - */ - -export const UsageTypeV2026 = { - Create: 'CREATE', - Update: 'UPDATE', - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE', - Assign: 'ASSIGN', - Unassign: 'UNASSIGN', - CreateGroup: 'CREATE_GROUP', - UpdateGroup: 'UPDATE_GROUP', - DeleteGroup: 'DELETE_GROUP', - Register: 'REGISTER', - CreateIdentity: 'CREATE_IDENTITY', - UpdateIdentity: 'UPDATE_IDENTITY', - EditGroup: 'EDIT_GROUP', - Unlock: 'UNLOCK', - ChangePassword: 'CHANGE_PASSWORD' -} as const; - -export type UsageTypeV2026 = typeof UsageTypeV2026[keyof typeof UsageTypeV2026]; - - -/** - * - * @export - * @interface UserAppAccountV2026 - */ -export interface UserAppAccountV2026 { - /** - * the account ID - * @type {string} - * @memberof UserAppAccountV2026 - */ - 'id'?: string; - /** - * It will always be \"ACCOUNT\" - * @type {string} - * @memberof UserAppAccountV2026 - */ - 'type'?: string; - /** - * the account name - * @type {string} - * @memberof UserAppAccountV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppOwnerV2026 - */ -export interface UserAppOwnerV2026 { - /** - * The identity ID - * @type {string} - * @memberof UserAppOwnerV2026 - */ - 'id'?: string; - /** - * It will always be \"IDENTITY\" - * @type {string} - * @memberof UserAppOwnerV2026 - */ - 'type'?: string; - /** - * The identity name - * @type {string} - * @memberof UserAppOwnerV2026 - */ - 'name'?: string; - /** - * The identity alias - * @type {string} - * @memberof UserAppOwnerV2026 - */ - 'alias'?: string; -} -/** - * - * @export - * @interface UserAppSourceAppV2026 - */ -export interface UserAppSourceAppV2026 { - /** - * the source app ID - * @type {string} - * @memberof UserAppSourceAppV2026 - */ - 'id'?: string; - /** - * It will always be \"APPLICATION\" - * @type {string} - * @memberof UserAppSourceAppV2026 - */ - 'type'?: string; - /** - * the source app name - * @type {string} - * @memberof UserAppSourceAppV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppSourceV2026 - */ -export interface UserAppSourceV2026 { - /** - * the source ID - * @type {string} - * @memberof UserAppSourceV2026 - */ - 'id'?: string; - /** - * It will always be \"SOURCE\" - * @type {string} - * @memberof UserAppSourceV2026 - */ - 'type'?: string; - /** - * the source name - * @type {string} - * @memberof UserAppSourceV2026 - */ - 'name'?: string; -} -/** - * - * @export - * @interface UserAppV2026 - */ -export interface UserAppV2026 { - /** - * The user app id - * @type {string} - * @memberof UserAppV2026 - */ - 'id'?: string; - /** - * Time when the user app was created - * @type {string} - * @memberof UserAppV2026 - */ - 'created'?: string; - /** - * Time when the user app was last modified - * @type {string} - * @memberof UserAppV2026 - */ - 'modified'?: string; - /** - * True if the owner has multiple accounts for the source - * @type {boolean} - * @memberof UserAppV2026 - */ - 'hasMultipleAccounts'?: boolean; - /** - * True if the source has password feature - * @type {boolean} - * @memberof UserAppV2026 - */ - 'useForPasswordManagement'?: boolean; - /** - * True if the app allows access request - * @type {boolean} - * @memberof UserAppV2026 - */ - 'provisionRequestEnabled'?: boolean; - /** - * True if the app is visible in the request center - * @type {boolean} - * @memberof UserAppV2026 - */ - 'appCenterEnabled'?: boolean; - /** - * - * @type {UserAppSourceAppV2026} - * @memberof UserAppV2026 - */ - 'sourceApp'?: UserAppSourceAppV2026; - /** - * - * @type {UserAppSourceV2026} - * @memberof UserAppV2026 - */ - 'source'?: UserAppSourceV2026; - /** - * - * @type {UserAppAccountV2026} - * @memberof UserAppV2026 - */ - 'account'?: UserAppAccountV2026; - /** - * - * @type {UserAppOwnerV2026} - * @memberof UserAppV2026 - */ - 'owner'?: UserAppOwnerV2026; -} -/** - * It represents a summary of a user level publish operation, including its metadata and status. - * @export - * @interface UserLevelPublishSummaryV2026 - */ -export interface UserLevelPublishSummaryV2026 { - /** - * The unique identifier of the UserLevel. - * @type {string} - * @memberof UserLevelPublishSummaryV2026 - */ - 'userLevelId'?: string; - /** - * Indicates whether the API call triggered a publish operation. - * @type {boolean} - * @memberof UserLevelPublishSummaryV2026 - */ - 'publish'?: boolean; - /** - * The status of the UserLevel publish operation. - * @type {string} - * @memberof UserLevelPublishSummaryV2026 - */ - 'status'?: string; - /** - * The last modification timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelPublishSummaryV2026 - */ - 'modified'?: string; -} -/** - * Payload containing details for creating a custom user level. - * @export - * @interface UserLevelRequestV2026 - */ -export interface UserLevelRequestV2026 { - /** - * The name of the user level. - * @type {string} - * @memberof UserLevelRequestV2026 - */ - 'name': string; - /** - * A brief description of the user level. - * @type {string} - * @memberof UserLevelRequestV2026 - */ - 'description': string; - /** - * - * @type {PublicIdentityV2026} - * @memberof UserLevelRequestV2026 - */ - 'owner': PublicIdentityV2026; - /** - * A list of rights associated with the user level. - * @type {Array} - * @memberof UserLevelRequestV2026 - */ - 'rightSets'?: Array; -} -/** - * It represents a summary of a user level, including its metadata, attributes, and associated properties. - * @export - * @interface UserLevelSummaryDTOV2026 - */ -export interface UserLevelSummaryDTOV2026 { - /** - * The unique identifier of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'id'?: string; - /** - * The human-readable name of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'name'?: string; - /** - * A human-readable description of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'description'?: string | null; - /** - * The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'legacyGroup'?: string | null; - /** - * List of RightSets associated with the UserLevel. - * @type {Array} - * @memberof UserLevelSummaryDTOV2026 - */ - 'rightSets'?: Array; - /** - * Indicates whether the UserLevel is custom. - * @type {boolean} - * @memberof UserLevelSummaryDTOV2026 - */ - 'custom'?: boolean; - /** - * Indicates whether the UserLevel is admin-assignable. - * @type {boolean} - * @memberof UserLevelSummaryDTOV2026 - */ - 'adminAssignable'?: boolean; - /** - * The translated name of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'translatedName'?: string | null; - /** - * The translated grant message for the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'translatedGrant'?: string | null; - /** - * The translated remove message for the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'translatedRemove'?: string | null; - /** - * - * @type {PublicIdentityV2026} - * @memberof UserLevelSummaryDTOV2026 - */ - 'owner'?: PublicIdentityV2026; - /** - * The status of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'status'?: UserLevelSummaryDTOV2026StatusV2026; - /** - * The creation timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'created'?: string; - /** - * The last modification timestamp of the UserLevel. - * @type {string} - * @memberof UserLevelSummaryDTOV2026 - */ - 'modified'?: string; - /** - * The count of associated identities for the UserLevel. - * @type {number} - * @memberof UserLevelSummaryDTOV2026 - */ - 'associatedIdentitiesCount'?: number | null; -} - -export const UserLevelSummaryDTOV2026StatusV2026 = { - Active: 'ACTIVE', - Draft: 'DRAFT' -} as const; - -export type UserLevelSummaryDTOV2026StatusV2026 = typeof UserLevelSummaryDTOV2026StatusV2026[keyof typeof UserLevelSummaryDTOV2026StatusV2026]; - -/** - * - * @export - * @interface V3ConnectorDtoV2026 - */ -export interface V3ConnectorDtoV2026 { - /** - * The connector name - * @type {string} - * @memberof V3ConnectorDtoV2026 - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof V3ConnectorDtoV2026 - */ - 'type'?: string; - /** - * The connector script name - * @type {string} - * @memberof V3ConnectorDtoV2026 - */ - 'scriptName'?: string; - /** - * The connector class name. - * @type {string} - * @memberof V3ConnectorDtoV2026 - */ - 'className'?: string | null; - /** - * The list of features supported by the connector - * @type {Array} - * @memberof V3ConnectorDtoV2026 - */ - 'features'?: Array | null; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3ConnectorDtoV2026 - */ - 'directConnect'?: boolean; - /** - * A map containing metadata pertinent to the connector - * @type {{ [key: string]: any; }} - * @memberof V3ConnectorDtoV2026 - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof V3ConnectorDtoV2026 - */ - 'status'?: V3ConnectorDtoV2026StatusV2026; -} - -export const V3ConnectorDtoV2026StatusV2026 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3ConnectorDtoV2026StatusV2026 = typeof V3ConnectorDtoV2026StatusV2026[keyof typeof V3ConnectorDtoV2026StatusV2026]; - -/** - * - * @export - * @interface V3CreateConnectorDtoV2026 - */ -export interface V3CreateConnectorDtoV2026 { - /** - * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - * @type {string} - * @memberof V3CreateConnectorDtoV2026 - */ - 'name': string; - /** - * The connector type. If not specified will be defaulted to \'custom \'+name - * @type {string} - * @memberof V3CreateConnectorDtoV2026 - */ - 'type'?: string; - /** - * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - * @type {string} - * @memberof V3CreateConnectorDtoV2026 - */ - 'className': string; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3CreateConnectorDtoV2026 - */ - 'directConnect'?: boolean; - /** - * The connector status - * @type {string} - * @memberof V3CreateConnectorDtoV2026 - */ - 'status'?: V3CreateConnectorDtoV2026StatusV2026; -} - -export const V3CreateConnectorDtoV2026StatusV2026 = { - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3CreateConnectorDtoV2026StatusV2026 = typeof V3CreateConnectorDtoV2026StatusV2026[keyof typeof V3CreateConnectorDtoV2026StatusV2026]; - -/** - * Details about the `CLUSTER` or `SOURCE` that initiated this event. - * @export - * @interface VAClusterStatusChangeEventApplicationV2026 - */ -export interface VAClusterStatusChangeEventApplicationV2026 { - /** - * The GUID of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2026 - */ - 'id': string; - /** - * The name of the application - * @type {string} - * @memberof VAClusterStatusChangeEventApplicationV2026 - */ - 'name': string; - /** - * Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. - * @type {{ [key: string]: any; }} - * @memberof VAClusterStatusChangeEventApplicationV2026 - */ - 'attributes': { [key: string]: any; } | null; -} -/** - * The results of the most recent health check. - * @export - * @interface VAClusterStatusChangeEventHealthCheckResultV2026 - */ -export interface VAClusterStatusChangeEventHealthCheckResultV2026 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2026 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2026 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventHealthCheckResultV2026 - */ - 'status': VAClusterStatusChangeEventHealthCheckResultV2026StatusV2026; -} - -export const VAClusterStatusChangeEventHealthCheckResultV2026StatusV2026 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventHealthCheckResultV2026StatusV2026 = typeof VAClusterStatusChangeEventHealthCheckResultV2026StatusV2026[keyof typeof VAClusterStatusChangeEventHealthCheckResultV2026StatusV2026]; - -/** - * The results of the last health check. - * @export - * @interface VAClusterStatusChangeEventPreviousHealthCheckResultV2026 - */ -export interface VAClusterStatusChangeEventPreviousHealthCheckResultV2026 { - /** - * Detailed message of the result of the health check. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2026 - */ - 'message': string; - /** - * The type of the health check result. - * @type {string} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2026 - */ - 'resultType': string; - /** - * The status of the health check. - * @type {object} - * @memberof VAClusterStatusChangeEventPreviousHealthCheckResultV2026 - */ - 'status': VAClusterStatusChangeEventPreviousHealthCheckResultV2026StatusV2026; -} - -export const VAClusterStatusChangeEventPreviousHealthCheckResultV2026StatusV2026 = { - Succeeded: 'Succeeded', - Failed: 'Failed' -} as const; - -export type VAClusterStatusChangeEventPreviousHealthCheckResultV2026StatusV2026 = typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2026StatusV2026[keyof typeof VAClusterStatusChangeEventPreviousHealthCheckResultV2026StatusV2026]; - -/** - * - * @export - * @interface VAClusterStatusChangeEventV2026 - */ -export interface VAClusterStatusChangeEventV2026 { - /** - * The date and time the status change occurred. - * @type {string} - * @memberof VAClusterStatusChangeEventV2026 - */ - 'created': string; - /** - * The type of the object that initiated this event. - * @type {object} - * @memberof VAClusterStatusChangeEventV2026 - */ - 'type': VAClusterStatusChangeEventV2026TypeV2026; - /** - * - * @type {VAClusterStatusChangeEventApplicationV2026} - * @memberof VAClusterStatusChangeEventV2026 - */ - 'application': VAClusterStatusChangeEventApplicationV2026; - /** - * - * @type {VAClusterStatusChangeEventHealthCheckResultV2026} - * @memberof VAClusterStatusChangeEventV2026 - */ - 'healthCheckResult': VAClusterStatusChangeEventHealthCheckResultV2026; - /** - * - * @type {VAClusterStatusChangeEventPreviousHealthCheckResultV2026} - * @memberof VAClusterStatusChangeEventV2026 - */ - 'previousHealthCheckResult': VAClusterStatusChangeEventPreviousHealthCheckResultV2026; -} - -export const VAClusterStatusChangeEventV2026TypeV2026 = { - Source: 'SOURCE', - Cluster: 'CLUSTER' -} as const; - -export type VAClusterStatusChangeEventV2026TypeV2026 = typeof VAClusterStatusChangeEventV2026TypeV2026[keyof typeof VAClusterStatusChangeEventV2026TypeV2026]; - -/** - * - * @export - * @interface ValidateFilterInputDtoV2026 - */ -export interface ValidateFilterInputDtoV2026 { - /** - * Mock input to evaluate filter expression against. - * @type {object} - * @memberof ValidateFilterInputDtoV2026 - */ - 'input': object; - /** - * JSONPath filter to conditionally invoke trigger when expression evaluates to true. - * @type {string} - * @memberof ValidateFilterInputDtoV2026 - */ - 'filter': string; -} -/** - * - * @export - * @interface ValidateFilterOutputDtoV2026 - */ -export interface ValidateFilterOutputDtoV2026 { - /** - * When this field is true, the filter expression is valid against the input. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2026 - */ - 'isValid'?: boolean; - /** - * When this field is true, the filter expression is using a valid JSON path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2026 - */ - 'isValidJSONPath'?: boolean; - /** - * When this field is true, the filter expression is using an existing path. - * @type {boolean} - * @memberof ValidateFilterOutputDtoV2026 - */ - 'isPathExist'?: boolean; -} -/** - * - * @export - * @interface ValueV2026 - */ -export interface ValueV2026 { - /** - * The type of attribute value - * @type {string} - * @memberof ValueV2026 - */ - 'type'?: string; - /** - * The attribute value - * @type {string} - * @memberof ValueV2026 - */ - 'value'?: string; -} -/** - * Request body for POST /ssf/streams/verify (receiver verification). - * @export - * @interface VerificationRequestV2026 - */ -export interface VerificationRequestV2026 { - /** - * Stream ID for verification. - * @type {string} - * @memberof VerificationRequestV2026 - */ - 'stream_id': string; - /** - * Optional state value for verification challenge. - * @type {string} - * @memberof VerificationRequestV2026 - */ - 'state'?: string; -} -/** - * The types of objects supported for SOD violations - * @export - * @interface ViolationContextPolicyV2026 - */ -export interface ViolationContextPolicyV2026 { - /** - * The type of object that is referenced - * @type {object} - * @memberof ViolationContextPolicyV2026 - */ - 'type'?: ViolationContextPolicyV2026TypeV2026; - /** - * SOD policy ID. - * @type {string} - * @memberof ViolationContextPolicyV2026 - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof ViolationContextPolicyV2026 - */ - 'name'?: string; -} - -export const ViolationContextPolicyV2026TypeV2026 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ViolationContextPolicyV2026TypeV2026 = typeof ViolationContextPolicyV2026TypeV2026[keyof typeof ViolationContextPolicyV2026TypeV2026]; - -/** - * - * @export - * @interface ViolationContextV2026 - */ -export interface ViolationContextV2026 { - /** - * - * @type {ViolationContextPolicyV2026} - * @memberof ViolationContextV2026 - */ - 'policy'?: ViolationContextPolicyV2026; - /** - * - * @type {ExceptionAccessCriteriaV2026} - * @memberof ViolationContextV2026 - */ - 'conflictingAccessCriteria'?: ExceptionAccessCriteriaV2026; -} -/** - * The owner of the violation assignment config. - * @export - * @interface ViolationOwnerAssignmentConfigOwnerRefV2026 - */ -export interface ViolationOwnerAssignmentConfigOwnerRefV2026 { - /** - * Owner type. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2026 - */ - 'type'?: ViolationOwnerAssignmentConfigOwnerRefV2026TypeV2026 | null; - /** - * Owner\'s ID. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2026 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRefV2026 - */ - 'name'?: string; -} - -export const ViolationOwnerAssignmentConfigOwnerRefV2026TypeV2026 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - Manager: 'MANAGER' -} as const; - -export type ViolationOwnerAssignmentConfigOwnerRefV2026TypeV2026 = typeof ViolationOwnerAssignmentConfigOwnerRefV2026TypeV2026[keyof typeof ViolationOwnerAssignmentConfigOwnerRefV2026TypeV2026]; - -/** - * - * @export - * @interface ViolationOwnerAssignmentConfigV2026 - */ -export interface ViolationOwnerAssignmentConfigV2026 { - /** - * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity - * @type {string} - * @memberof ViolationOwnerAssignmentConfigV2026 - */ - 'assignmentRule'?: ViolationOwnerAssignmentConfigV2026AssignmentRuleV2026 | null; - /** - * - * @type {ViolationOwnerAssignmentConfigOwnerRefV2026} - * @memberof ViolationOwnerAssignmentConfigV2026 - */ - 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRefV2026 | null; -} - -export const ViolationOwnerAssignmentConfigV2026AssignmentRuleV2026 = { - Manager: 'MANAGER', - Static: 'STATIC' -} as const; - -export type ViolationOwnerAssignmentConfigV2026AssignmentRuleV2026 = typeof ViolationOwnerAssignmentConfigV2026AssignmentRuleV2026[keyof typeof ViolationOwnerAssignmentConfigV2026AssignmentRuleV2026]; - -/** - * An object containing a listing of the SOD violation reasons detected by this check. - * @export - * @interface ViolationPredictionV2026 - */ -export interface ViolationPredictionV2026 { - /** - * List of Violation Contexts - * @type {Array} - * @memberof ViolationPredictionV2026 - */ - 'violationContexts'?: Array; -} -/** - * - * @export - * @interface VisibilityCriteriaV2026 - */ -export interface VisibilityCriteriaV2026 { - /** - * - * @type {ExpressionV2026} - * @memberof VisibilityCriteriaV2026 - */ - 'expression'?: ExpressionV2026; -} -/** - * - * @export - * @interface WorkItemForwardV2026 - */ -export interface WorkItemForwardV2026 { - /** - * The ID of the identity to forward this work item to. - * @type {string} - * @memberof WorkItemForwardV2026 - */ - 'targetOwnerId': string; - /** - * Comments to send to the target owner - * @type {string} - * @memberof WorkItemForwardV2026 - */ - 'comment': string; - /** - * If true, send a notification to the target owner. - * @type {boolean} - * @memberof WorkItemForwardV2026 - */ - 'sendNotifications'?: boolean; -} -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateManualWorkItemsV2026 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateManualWorkItemsV2026 = typeof WorkItemStateManualWorkItemsV2026[keyof typeof WorkItemStateManualWorkItemsV2026]; - - -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateV2026 = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateV2026 = typeof WorkItemStateV2026[keyof typeof WorkItemStateV2026]; - - -/** - * The type of the work item - * @export - * @enum {string} - */ - -export const WorkItemTypeManualWorkItemsV2026 = { - Generic: 'Generic', - Certification: 'Certification', - Remediation: 'Remediation', - Delegation: 'Delegation', - Approval: 'Approval', - ViolationReview: 'ViolationReview', - Form: 'Form', - PolicyVioloation: 'PolicyVioloation', - Challenge: 'Challenge', - ImpactAnalysis: 'ImpactAnalysis', - Signoff: 'Signoff', - Event: 'Event', - ManualAction: 'ManualAction', - Test: 'Test' -} as const; - -export type WorkItemTypeManualWorkItemsV2026 = typeof WorkItemTypeManualWorkItemsV2026[keyof typeof WorkItemTypeManualWorkItemsV2026]; - - -/** - * - * @export - * @interface WorkItemsCountV2026 - */ -export interface WorkItemsCountV2026 { - /** - * The count of work items - * @type {number} - * @memberof WorkItemsCountV2026 - */ - 'count'?: number; -} -/** - * - * @export - * @interface WorkItemsFormV2026 - */ -export interface WorkItemsFormV2026 { - /** - * ID of the form - * @type {string} - * @memberof WorkItemsFormV2026 - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof WorkItemsFormV2026 - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof WorkItemsFormV2026 - */ - 'title'?: string | null; - /** - * The form subtitle. - * @type {string} - * @memberof WorkItemsFormV2026 - */ - 'subtitle'?: string | null; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof WorkItemsFormV2026 - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof WorkItemsFormV2026 - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface WorkItemsSummaryV2026 - */ -export interface WorkItemsSummaryV2026 { - /** - * The count of open work items - * @type {number} - * @memberof WorkItemsSummaryV2026 - */ - 'open'?: number; - /** - * The count of completed work items - * @type {number} - * @memberof WorkItemsSummaryV2026 - */ - 'completed'?: number; - /** - * The count of total work items - * @type {number} - * @memberof WorkItemsSummaryV2026 - */ - 'total'?: number; -} -/** - * - * @export - * @interface WorkItemsV2026 - */ -export interface WorkItemsV2026 { - /** - * ID of the work item - * @type {string} - * @memberof WorkItemsV2026 - */ - 'id'?: string; - /** - * ID of the requester - * @type {string} - * @memberof WorkItemsV2026 - */ - 'requesterId'?: string | null; - /** - * The displayname of the requester - * @type {string} - * @memberof WorkItemsV2026 - */ - 'requesterDisplayName'?: string | null; - /** - * The ID of the owner - * @type {string} - * @memberof WorkItemsV2026 - */ - 'ownerId'?: string | null; - /** - * The name of the owner - * @type {string} - * @memberof WorkItemsV2026 - */ - 'ownerName'?: string; - /** - * Time when the work item was created - * @type {string} - * @memberof WorkItemsV2026 - */ - 'created'?: string; - /** - * Time when the work item was last updated - * @type {string} - * @memberof WorkItemsV2026 - */ - 'modified'?: string | null; - /** - * The description of the work item - * @type {string} - * @memberof WorkItemsV2026 - */ - 'description'?: string; - /** - * - * @type {WorkItemStateManualWorkItemsV2026} - * @memberof WorkItemsV2026 - */ - 'state'?: WorkItemStateManualWorkItemsV2026; - /** - * - * @type {WorkItemTypeManualWorkItemsV2026} - * @memberof WorkItemsV2026 - */ - 'type'?: WorkItemTypeManualWorkItemsV2026; - /** - * A list of remediation items - * @type {Array} - * @memberof WorkItemsV2026 - */ - 'remediationItems'?: Array | null; - /** - * A list of items that need to be approved - * @type {Array} - * @memberof WorkItemsV2026 - */ - 'approvalItems'?: Array | null; - /** - * The work item name - * @type {string} - * @memberof WorkItemsV2026 - */ - 'name'?: string | null; - /** - * The time at which the work item completed - * @type {string} - * @memberof WorkItemsV2026 - */ - 'completed'?: string | null; - /** - * The number of items in the work item - * @type {number} - * @memberof WorkItemsV2026 - */ - 'numItems'?: number | null; - /** - * - * @type {WorkItemsFormV2026} - * @memberof WorkItemsV2026 - */ - 'form'?: WorkItemsFormV2026; - /** - * An array of errors that ocurred during the work item - * @type {Array} - * @memberof WorkItemsV2026 - */ - 'errors'?: Array; -} - - -/** - * Workflow creator\'s identity. - * @export - * @interface WorkflowAllOfCreatorV2026 - */ -export interface WorkflowAllOfCreatorV2026 { - /** - * Workflow creator\'s DTO type. - * @type {string} - * @memberof WorkflowAllOfCreatorV2026 - */ - 'type'?: WorkflowAllOfCreatorV2026TypeV2026; - /** - * Workflow creator\'s identity ID. - * @type {string} - * @memberof WorkflowAllOfCreatorV2026 - */ - 'id'?: string; - /** - * Workflow creator\'s display name. - * @type {string} - * @memberof WorkflowAllOfCreatorV2026 - */ - 'name'?: string; -} - -export const WorkflowAllOfCreatorV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowAllOfCreatorV2026TypeV2026 = typeof WorkflowAllOfCreatorV2026TypeV2026[keyof typeof WorkflowAllOfCreatorV2026TypeV2026]; - -/** - * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - * @export - * @interface WorkflowBodyOwnerV2026 - */ -export interface WorkflowBodyOwnerV2026 { - /** - * The type of object that is referenced - * @type {string} - * @memberof WorkflowBodyOwnerV2026 - */ - 'type'?: WorkflowBodyOwnerV2026TypeV2026; - /** - * The unique ID of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2026 - */ - 'id'?: string; - /** - * The name of the object - * @type {string} - * @memberof WorkflowBodyOwnerV2026 - */ - 'name'?: string; -} - -export const WorkflowBodyOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowBodyOwnerV2026TypeV2026 = typeof WorkflowBodyOwnerV2026TypeV2026[keyof typeof WorkflowBodyOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowBodyV2026 - */ -export interface WorkflowBodyV2026 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBodyV2026 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2026} - * @memberof WorkflowBodyV2026 - */ - 'owner'?: WorkflowBodyOwnerV2026; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBodyV2026 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2026} - * @memberof WorkflowBodyV2026 - */ - 'definition'?: WorkflowDefinitionV2026; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBodyV2026 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2026} - * @memberof WorkflowBodyV2026 - */ - 'trigger'?: WorkflowTriggerV2026; -} -/** - * The map of steps that the workflow will execute. - * @export - * @interface WorkflowDefinitionV2026 - */ -export interface WorkflowDefinitionV2026 { - /** - * The name of the starting step. - * @type {string} - * @memberof WorkflowDefinitionV2026 - */ - 'start'?: string; - /** - * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - * @type {{ [key: string]: any; }} - * @memberof WorkflowDefinitionV2026 - */ - 'steps'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface WorkflowExecutionEventV2026 - */ -export interface WorkflowExecutionEventV2026 { - /** - * The type of event - * @type {string} - * @memberof WorkflowExecutionEventV2026 - */ - 'type'?: WorkflowExecutionEventV2026TypeV2026; - /** - * The date-time when the event occurred - * @type {string} - * @memberof WorkflowExecutionEventV2026 - */ - 'timestamp'?: string; - /** - * Additional attributes associated with the event - * @type {object} - * @memberof WorkflowExecutionEventV2026 - */ - 'attributes'?: object; -} - -export const WorkflowExecutionEventV2026TypeV2026 = { - WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', - WorkflowExecutionStarted: 'WorkflowExecutionStarted', - WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', - WorkflowExecutionFailed: 'WorkflowExecutionFailed', - WorkflowTaskScheduled: 'WorkflowTaskScheduled', - WorkflowTaskStarted: 'WorkflowTaskStarted', - WorkflowTaskCompleted: 'WorkflowTaskCompleted', - WorkflowTaskFailed: 'WorkflowTaskFailed', - ActivityTaskScheduled: 'ActivityTaskScheduled', - ActivityTaskStarted: 'ActivityTaskStarted', - ActivityTaskCompleted: 'ActivityTaskCompleted', - ActivityTaskFailed: 'ActivityTaskFailed', - StartChildWorkflowExecutionInitiated: 'StartChildWorkflowExecutionInitiated', - ChildWorkflowExecutionStarted: 'ChildWorkflowExecutionStarted', - ChildWorkflowExecutionCompleted: 'ChildWorkflowExecutionCompleted', - ChildWorkflowExecutionFailed: 'ChildWorkflowExecutionFailed' -} as const; - -export type WorkflowExecutionEventV2026TypeV2026 = typeof WorkflowExecutionEventV2026TypeV2026[keyof typeof WorkflowExecutionEventV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowExecutionHistoryV2026 - */ -export interface WorkflowExecutionHistoryV2026 { - /** - * The workflow definition for the workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2026 - */ - 'definition'?: object; - /** - * List of workflow execution events for the given workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2026 - */ - 'history'?: object; - /** - * The trigger that initiated the workflow execution - * @type {object} - * @memberof WorkflowExecutionHistoryV2026 - */ - 'trigger'?: object; -} -/** - * - * @export - * @interface WorkflowExecutionV2026 - */ -export interface WorkflowExecutionV2026 { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'id'?: string; - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'workflowId'?: string; - /** - * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'requestId'?: string; - /** - * Date/time when the workflow started. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'startTime'?: string; - /** - * Date/time when the workflow ended. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'closeTime'?: string; - /** - * Workflow execution status. - * @type {string} - * @memberof WorkflowExecutionV2026 - */ - 'status'?: WorkflowExecutionV2026StatusV2026; -} - -export const WorkflowExecutionV2026StatusV2026 = { - Completed: 'Completed', - Failed: 'Failed', - Canceled: 'Canceled', - Running: 'Running', - Queued: 'Queued' -} as const; - -export type WorkflowExecutionV2026StatusV2026 = typeof WorkflowExecutionV2026StatusV2026[keyof typeof WorkflowExecutionV2026StatusV2026]; - -/** - * @type WorkflowLibraryActionExampleOutputV2026 - * @export - */ -export type WorkflowLibraryActionExampleOutputV2026 = Array | object; - -/** - * - * @export - * @interface WorkflowLibraryActionV2026 - */ -export interface WorkflowLibraryActionV2026 { - /** - * Action ID. This is a static namespaced ID for the action - * @type {string} - * @memberof WorkflowLibraryActionV2026 - */ - 'id'?: string; - /** - * Action Name - * @type {string} - * @memberof WorkflowLibraryActionV2026 - */ - 'name'?: string; - /** - * Action type - * @type {string} - * @memberof WorkflowLibraryActionV2026 - */ - 'type'?: string; - /** - * Action Description - * @type {string} - * @memberof WorkflowLibraryActionV2026 - */ - 'description'?: string; - /** - * One or more inputs that the action accepts - * @type {Array} - * @memberof WorkflowLibraryActionV2026 - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutputV2026} - * @memberof WorkflowLibraryActionV2026 - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutputV2026; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2026 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryActionV2026 - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof WorkflowLibraryActionV2026 - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryActionV2026 - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryActionV2026 - */ - 'isDynamicSchema'?: boolean; - /** - * Defines the output schema, if any, that this action produces. - * @type {object} - * @memberof WorkflowLibraryActionV2026 - */ - 'outputSchema'?: object; -} -/** - * - * @export - * @interface WorkflowLibraryFormFieldsV2026 - */ -export interface WorkflowLibraryFormFieldsV2026 { - /** - * Description of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'description'?: string; - /** - * Describes the form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'helpText'?: string; - /** - * A human readable name for this form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'label'?: string; - /** - * The name of the input attribute - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'name'?: string; - /** - * Denotes if this field is a required attribute - * @type {boolean} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'required'?: boolean; - /** - * The type of the form field - * @type {string} - * @memberof WorkflowLibraryFormFieldsV2026 - */ - 'type'?: WorkflowLibraryFormFieldsV2026TypeV2026 | null; -} - -export const WorkflowLibraryFormFieldsV2026TypeV2026 = { - Text: 'text', - Textarea: 'textarea', - Boolean: 'boolean', - Email: 'email', - Url: 'url', - Number: 'number', - Json: 'json', - Checkbox: 'checkbox', - Jsonpath: 'jsonpath', - Select: 'select', - MultiType: 'multiType', - Duration: 'duration', - Toggle: 'toggle', - FormPicker: 'formPicker', - IdentityPicker: 'identityPicker', - GovernanceGroupPicker: 'governanceGroupPicker', - String: 'string', - Object: 'object', - Array: 'array', - Secret: 'secret', - KeyValuePairs: 'keyValuePairs', - EmailPicker: 'emailPicker', - AdvancedToggle: 'advancedToggle', - VariableCreator: 'variableCreator', - HtmlEditor: 'htmlEditor' -} as const; - -export type WorkflowLibraryFormFieldsV2026TypeV2026 = typeof WorkflowLibraryFormFieldsV2026TypeV2026[keyof typeof WorkflowLibraryFormFieldsV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowLibraryOperatorV2026 - */ -export interface WorkflowLibraryOperatorV2026 { - /** - * Operator ID. - * @type {string} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'isDynamicSchema'?: boolean; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'isSimulationEnabled'?: boolean; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof WorkflowLibraryOperatorV2026 - */ - 'formFields'?: Array | null; -} -/** - * - * @export - * @interface WorkflowLibraryTriggerV2026 - */ -export interface WorkflowLibraryTriggerV2026 { - /** - * Trigger ID. This is a static namespaced ID for the trigger. - * @type {string} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'id'?: string; - /** - * Trigger type - * @type {string} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'type'?: WorkflowLibraryTriggerV2026TypeV2026; - /** - * Whether the trigger is deprecated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'deprecated'?: boolean; - /** - * Date the trigger was deprecated, if applicable. - * @type {string} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'deprecatedBy'?: string; - /** - * Whether the trigger can be simulated. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'isSimulationEnabled'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'outputSchema'?: object; - /** - * Trigger Name - * @type {string} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'name'?: string; - /** - * Trigger Description - * @type {string} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'isDynamicSchema'?: boolean; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'inputExample'?: object | null; - /** - * One or more inputs that the trigger accepts - * @type {Array} - * @memberof WorkflowLibraryTriggerV2026 - */ - 'formFields'?: Array | null; -} - -export const WorkflowLibraryTriggerV2026TypeV2026 = { - Event: 'EVENT', - Scheduled: 'SCHEDULED', - External: 'EXTERNAL', - AccessRequestTrigger: 'AccessRequestTrigger' -} as const; - -export type WorkflowLibraryTriggerV2026TypeV2026 = typeof WorkflowLibraryTriggerV2026TypeV2026[keyof typeof WorkflowLibraryTriggerV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowModifiedByV2026 - */ -export interface WorkflowModifiedByV2026 { - /** - * - * @type {string} - * @memberof WorkflowModifiedByV2026 - */ - 'type'?: WorkflowModifiedByV2026TypeV2026; - /** - * Identity ID - * @type {string} - * @memberof WorkflowModifiedByV2026 - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof WorkflowModifiedByV2026 - */ - 'name'?: string; -} - -export const WorkflowModifiedByV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowModifiedByV2026TypeV2026 = typeof WorkflowModifiedByV2026TypeV2026[keyof typeof WorkflowModifiedByV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowOAuthClientV2026 - */ -export interface WorkflowOAuthClientV2026 { - /** - * OAuth client ID for the trigger. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowOAuthClientV2026 - */ - 'id'?: string; - /** - * OAuthClient secret. - * @type {string} - * @memberof WorkflowOAuthClientV2026 - */ - 'secret'?: string; - /** - * URL for the external trigger to invoke - * @type {string} - * @memberof WorkflowOAuthClientV2026 - */ - 'url'?: string; -} -/** - * Workflow Trigger Attributes. - * @export - * @interface WorkflowTriggerAttributesV2026 - */ -export interface WorkflowTriggerAttributesV2026 { - /** - * The unique ID of the trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'filter.$'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'formDefinitionId'?: string | null; - /** - * A unique name for the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'name'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'url'?: string | null; - /** - * Frequency of execution - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'frequency': WorkflowTriggerAttributesV2026FrequencyV2026 | null; - /** - * Time zone identifier - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributesV2026 - */ - 'yearlyTimes'?: Array | null; -} - -export const WorkflowTriggerAttributesV2026FrequencyV2026 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type WorkflowTriggerAttributesV2026FrequencyV2026 = typeof WorkflowTriggerAttributesV2026FrequencyV2026[keyof typeof WorkflowTriggerAttributesV2026FrequencyV2026]; - -/** - * The trigger that starts the workflow - * @export - * @interface WorkflowTriggerV2026 - */ -export interface WorkflowTriggerV2026 { - /** - * The trigger type - * @type {string} - * @memberof WorkflowTriggerV2026 - */ - 'type': WorkflowTriggerV2026TypeV2026; - /** - * The trigger display name - * @type {string} - * @memberof WorkflowTriggerV2026 - */ - 'displayName'?: string | null; - /** - * - * @type {WorkflowTriggerAttributesV2026} - * @memberof WorkflowTriggerV2026 - */ - 'attributes': WorkflowTriggerAttributesV2026 | null; -} - -export const WorkflowTriggerV2026TypeV2026 = { - Event: 'EVENT', - External: 'EXTERNAL', - Scheduled: 'SCHEDULED', - Empty: '' -} as const; - -export type WorkflowTriggerV2026TypeV2026 = typeof WorkflowTriggerV2026TypeV2026[keyof typeof WorkflowTriggerV2026TypeV2026]; - -/** - * - * @export - * @interface WorkflowV2026 - */ -export interface WorkflowV2026 { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowV2026 - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwnerV2026} - * @memberof WorkflowV2026 - */ - 'owner'?: WorkflowBodyOwnerV2026; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowV2026 - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinitionV2026} - * @memberof WorkflowV2026 - */ - 'definition'?: WorkflowDefinitionV2026; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowV2026 - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTriggerV2026} - * @memberof WorkflowV2026 - */ - 'trigger'?: WorkflowTriggerV2026; - /** - * Workflow ID. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowV2026 - */ - 'id'?: string; - /** - * The number of times this workflow has been executed. - * @type {number} - * @memberof WorkflowV2026 - */ - 'executionCount'?: number; - /** - * The number of times this workflow has failed during execution. - * @type {number} - * @memberof WorkflowV2026 - */ - 'failureCount'?: number; - /** - * The date and time the workflow was created. - * @type {string} - * @memberof WorkflowV2026 - */ - 'created'?: string; - /** - * The date and time the workflow was modified. - * @type {string} - * @memberof WorkflowV2026 - */ - 'modified'?: string; - /** - * - * @type {WorkflowModifiedByV2026} - * @memberof WorkflowV2026 - */ - 'modifiedBy'?: WorkflowModifiedByV2026; - /** - * - * @type {WorkflowAllOfCreatorV2026} - * @memberof WorkflowV2026 - */ - 'creator'?: WorkflowAllOfCreatorV2026; -} -/** - * - * @export - * @interface WorkgroupBulkDeleteRequestV2026 - */ -export interface WorkgroupBulkDeleteRequestV2026 { - /** - * List of IDs of Governance Groups to be deleted. - * @type {Array} - * @memberof WorkgroupBulkDeleteRequestV2026 - */ - 'ids'?: Array; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoObjectV2026 - */ -export interface WorkgroupConnectionDtoObjectV2026 { - /** - * - * @type {ConnectedObjectTypeV2026 & object} - * @memberof WorkgroupConnectionDtoObjectV2026 - */ - 'type'?: ConnectedObjectTypeV2026 & object; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2026 - */ - 'id'?: string; - /** - * Human-readable name of Connected object - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2026 - */ - 'name'?: string; - /** - * Description of the Connected object. - * @type {string} - * @memberof WorkgroupConnectionDtoObjectV2026 - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface WorkgroupConnectionDtoV2026 - */ -export interface WorkgroupConnectionDtoV2026 { - /** - * - * @type {WorkgroupConnectionDtoObjectV2026} - * @memberof WorkgroupConnectionDtoV2026 - */ - 'object'?: WorkgroupConnectionDtoObjectV2026; - /** - * Connection Type. - * @type {string} - * @memberof WorkgroupConnectionDtoV2026 - */ - 'connectionType'?: WorkgroupConnectionDtoV2026ConnectionTypeV2026; -} - -export const WorkgroupConnectionDtoV2026ConnectionTypeV2026 = { - AccessRequestReviewer: 'AccessRequestReviewer', - Owner: 'Owner', - ManagementWorkgroup: 'ManagementWorkgroup' -} as const; - -export type WorkgroupConnectionDtoV2026ConnectionTypeV2026 = typeof WorkgroupConnectionDtoV2026ConnectionTypeV2026[keyof typeof WorkgroupConnectionDtoV2026ConnectionTypeV2026]; - -/** - * - * @export - * @interface WorkgroupDeleteItemV2026 - */ -export interface WorkgroupDeleteItemV2026 { - /** - * Id of the Governance Group. - * @type {string} - * @memberof WorkgroupDeleteItemV2026 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. - * @type {number} - * @memberof WorkgroupDeleteItemV2026 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupDeleteItemV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupDtoOwnerV2026 - */ -export interface WorkgroupDtoOwnerV2026 { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof WorkgroupDtoOwnerV2026 - */ - 'type'?: WorkgroupDtoOwnerV2026TypeV2026; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof WorkgroupDtoOwnerV2026 - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof WorkgroupDtoOwnerV2026 - */ - 'name'?: string; - /** - * The display name of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2026 - */ - 'displayName'?: string; - /** - * The primary email address of the identity - * @type {string} - * @memberof WorkgroupDtoOwnerV2026 - */ - 'emailAddress'?: string; -} - -export const WorkgroupDtoOwnerV2026TypeV2026 = { - Identity: 'IDENTITY' -} as const; - -export type WorkgroupDtoOwnerV2026TypeV2026 = typeof WorkgroupDtoOwnerV2026TypeV2026[keyof typeof WorkgroupDtoOwnerV2026TypeV2026]; - -/** - * - * @export - * @interface WorkgroupDtoV2026 - */ -export interface WorkgroupDtoV2026 { - /** - * - * @type {WorkgroupDtoOwnerV2026} - * @memberof WorkgroupDtoV2026 - */ - 'owner'?: WorkgroupDtoOwnerV2026; - /** - * Governance group ID. - * @type {string} - * @memberof WorkgroupDtoV2026 - */ - 'id'?: string; - /** - * Governance group name. - * @type {string} - * @memberof WorkgroupDtoV2026 - */ - 'name'?: string; - /** - * Governance group description. - * @type {string} - * @memberof WorkgroupDtoV2026 - */ - 'description'?: string; - /** - * Number of members in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2026 - */ - 'memberCount'?: number; - /** - * Number of connections in the governance group. - * @type {number} - * @memberof WorkgroupDtoV2026 - */ - 'connectionCount'?: number; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2026 - */ - 'created'?: string; - /** - * - * @type {string} - * @memberof WorkgroupDtoV2026 - */ - 'modified'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberAddItemV2026 - */ -export interface WorkgroupMemberAddItemV2026 { - /** - * Identifier of identity in bulk member add request. - * @type {string} - * @memberof WorkgroupMemberAddItemV2026 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberAddItemV2026 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberAddItemV2026 - */ - 'description'?: string; -} -/** - * - * @export - * @interface WorkgroupMemberDeleteItemV2026 - */ -export interface WorkgroupMemberDeleteItemV2026 { - /** - * Identifier of identity in bulk member add /remove request. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2026 - */ - 'id': string; - /** - * The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. - * @type {number} - * @memberof WorkgroupMemberDeleteItemV2026 - */ - 'status': number; - /** - * Human readable status description and containing additional context information about success or failures etc. - * @type {string} - * @memberof WorkgroupMemberDeleteItemV2026 - */ - 'description'?: string; -} - -/** - * AccessModelMetadataV2026Api - axios parameter creator - * @export - */ -export const AccessModelMetadataV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2026} attributeDTOV2026 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute: async (attributeDTOV2026: AttributeDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeDTOV2026' is not null or undefined - assertParamExists('createAccessModelMetadataAttribute', 'attributeDTOV2026', attributeDTOV2026) - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2026} attributeValueDTOV2026 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue: async (key: string, attributeValueDTOV2026: AttributeValueDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'attributeValueDTOV2026' is not null or undefined - assertParamExists('createAccessModelMetadataAttributeValue', 'attributeValueDTOV2026', attributeValueDTOV2026) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeValueDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttribute', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('getAccessModelMetadataAttributeValue', 'value', value) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-model-metadata/attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('listAccessModelMetadataAttributeValue', 'key', key) - const localVarPath = `/access-model-metadata/attributes/{key}/values` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2026 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute: async (key: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'key', key) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateAccessModelMetadataAttribute', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/access-model-metadata/attributes/{key}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2026 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue: async (key: string, value: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'key', key) - // verify required parameter 'value' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'value', value) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateAccessModelMetadataAttributeValue', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/access-model-metadata/attributes/{key}/values/{value}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"value"}}`, encodeURIComponent(String(value))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {EntitlementAttributeBulkUpdateFilterRequestV2026} entitlementAttributeBulkUpdateFilterRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByFilter: async (entitlementAttributeBulkUpdateFilterRequestV2026: EntitlementAttributeBulkUpdateFilterRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateFilterRequestV2026' is not null or undefined - assertParamExists('updateAccessModelMetadataByFilter', 'entitlementAttributeBulkUpdateFilterRequestV2026', entitlementAttributeBulkUpdateFilterRequestV2026) - const localVarPath = `/access-model-metadata/bulk-update/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateFilterRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {EntitlementAttributeBulkUpdateIdsRequestV2026} entitlementAttributeBulkUpdateIdsRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByIds: async (entitlementAttributeBulkUpdateIdsRequestV2026: EntitlementAttributeBulkUpdateIdsRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateIdsRequestV2026' is not null or undefined - assertParamExists('updateAccessModelMetadataByIds', 'entitlementAttributeBulkUpdateIdsRequestV2026', entitlementAttributeBulkUpdateIdsRequestV2026) - const localVarPath = `/access-model-metadata/bulk-update/ids`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateIdsRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {EntitlementAttributeBulkUpdateQueryRequestV2026} entitlementAttributeBulkUpdateQueryRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByQuery: async (entitlementAttributeBulkUpdateQueryRequestV2026: EntitlementAttributeBulkUpdateQueryRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementAttributeBulkUpdateQueryRequestV2026' is not null or undefined - assertParamExists('updateAccessModelMetadataByQuery', 'entitlementAttributeBulkUpdateQueryRequestV2026', entitlementAttributeBulkUpdateQueryRequestV2026) - const localVarPath = `/access-model-metadata/bulk-update/query`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementAttributeBulkUpdateQueryRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessModelMetadataV2026Api - functional programming interface - * @export - */ -export const AccessModelMetadataV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessModelMetadataV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AttributeDTOV2026} attributeDTOV2026 Attribute to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttribute(attributeDTOV2026: AttributeDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttribute(attributeDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.createAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {AttributeValueDTOV2026} attributeValueDTOV2026 Attribute value to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataAttributeValue(key: string, attributeValueDTOV2026: AttributeValueDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValue(key, attributeValueDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.createAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttribute(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttribute(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.getAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessModelMetadataAttributeValue(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValue(key, value, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.getAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @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: **name, key** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttribute(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttribute(filters, sorters, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.listAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {string} key Technical name of the Attribute. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessModelMetadataAttributeValue(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValue(key, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.listAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {string} key Technical name of the Attribute. - * @param {Array} jsonPatchOperationV2026 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttribute(key: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttribute(key, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.updateAccessModelMetadataAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {string} key Technical name of the Attribute. - * @param {string} value Technical name of the Attribute value. - * @param {Array} jsonPatchOperationV2026 JSON Patch array to apply - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessModelMetadataAttributeValue(key: string, value: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValue(key, value, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.updateAccessModelMetadataAttributeValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {EntitlementAttributeBulkUpdateFilterRequestV2026} entitlementAttributeBulkUpdateFilterRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByFilter(entitlementAttributeBulkUpdateFilterRequestV2026: EntitlementAttributeBulkUpdateFilterRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByFilter(entitlementAttributeBulkUpdateFilterRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.updateAccessModelMetadataByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {EntitlementAttributeBulkUpdateIdsRequestV2026} entitlementAttributeBulkUpdateIdsRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByIds(entitlementAttributeBulkUpdateIdsRequestV2026: EntitlementAttributeBulkUpdateIdsRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByIds(entitlementAttributeBulkUpdateIdsRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.updateAccessModelMetadataByIds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {EntitlementAttributeBulkUpdateQueryRequestV2026} entitlementAttributeBulkUpdateQueryRequestV2026 Attribute metadata bulk update request body. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateAccessModelMetadataByQuery(entitlementAttributeBulkUpdateQueryRequestV2026: EntitlementAttributeBulkUpdateQueryRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByQuery(entitlementAttributeBulkUpdateQueryRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataV2026Api.updateAccessModelMetadataByQuery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessModelMetadataV2026Api - factory interface - * @export - */ -export const AccessModelMetadataV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessModelMetadataV2026ApiFp(configuration) - return { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttribute(requestParameters.attributeDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByFilter(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByFilter(requestParameters.entitlementAttributeBulkUpdateFilterRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByIds(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByIds(requestParameters.entitlementAttributeBulkUpdateIdsRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateAccessModelMetadataByQuery(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccessModelMetadataByQuery(requestParameters.entitlementAttributeBulkUpdateQueryRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataAttribute operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest { - /** - * Attribute to create - * @type {AttributeDTOV2026} - * @memberof AccessModelMetadataV2026ApiCreateAccessModelMetadataAttribute - */ - readonly attributeDTOV2026: AttributeDTOV2026 -} - -/** - * Request parameters for createAccessModelMetadataAttributeValue operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Attribute value to create - * @type {AttributeValueDTOV2026} - * @memberof AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValue - */ - readonly attributeValueDTOV2026: AttributeValueDTOV2026 -} - -/** - * Request parameters for getAccessModelMetadataAttribute operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiGetAccessModelMetadataAttribute - */ - readonly key: string -} - -/** - * Request parameters for getAccessModelMetadataAttributeValue operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValue - */ - readonly value: string -} - -/** - * Request parameters for listAccessModelMetadataAttribute operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest { - /** - * 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: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof AccessModelMetadataV2026ApiListAccessModelMetadataAttribute - */ - 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: **name, key** - * @type {string} - * @memberof AccessModelMetadataV2026ApiListAccessModelMetadataAttribute - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2026ApiListAccessModelMetadataAttribute - */ - 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 AccessModelMetadataV2026ApiListAccessModelMetadataAttribute - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccessModelMetadataAttributeValue operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValue - */ - 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 AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValue - */ - readonly count?: boolean -} - -/** - * Request parameters for updateAccessModelMetadataAttribute operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest - */ -export interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttribute - */ - readonly key: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttribute - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateAccessModelMetadataAttributeValue operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest - */ -export interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest { - /** - * Technical name of the Attribute. - * @type {string} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValue - */ - readonly key: string - - /** - * Technical name of the Attribute value. - * @type {string} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValue - */ - readonly value: string - - /** - * JSON Patch array to apply - * @type {Array} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValue - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateAccessModelMetadataByFilter operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest - */ -export interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateFilterRequestV2026} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilter - */ - readonly entitlementAttributeBulkUpdateFilterRequestV2026: EntitlementAttributeBulkUpdateFilterRequestV2026 -} - -/** - * Request parameters for updateAccessModelMetadataByIds operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest - */ -export interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateIdsRequestV2026} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIds - */ - readonly entitlementAttributeBulkUpdateIdsRequestV2026: EntitlementAttributeBulkUpdateIdsRequestV2026 -} - -/** - * Request parameters for updateAccessModelMetadataByQuery operation in AccessModelMetadataV2026Api. - * @export - * @interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest - */ -export interface AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest { - /** - * Attribute metadata bulk update request body. - * @type {EntitlementAttributeBulkUpdateQueryRequestV2026} - * @memberof AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQuery - */ - readonly entitlementAttributeBulkUpdateQueryRequestV2026: EntitlementAttributeBulkUpdateQueryRequestV2026 -} - -/** - * AccessModelMetadataV2026Api - object-oriented interface - * @export - * @class AccessModelMetadataV2026Api - * @extends {BaseAPI} - */ -export class AccessModelMetadataV2026Api extends BaseAPI { - /** - * Create a new Access Model Metadata Attribute. - * @summary Create access model metadata attribute - * @param {AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public createAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).createAccessModelMetadataAttribute(requestParameters.attributeDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new value for an existing Access Model Metadata Attribute. - * @summary Create access model metadata value - * @param {AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public createAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiCreateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).createAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.attributeValueDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute - * @summary Get access model metadata attribute - * @param {AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public getAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).getAccessModelMetadataAttribute(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get single Access Model Metadata Attribute Value - * @summary Get access model metadata value - * @param {AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public getAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiGetAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).getAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attributes - * @summary List access model metadata attributes - * @param {AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public listAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiListAccessModelMetadataAttributeRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).listAccessModelMetadataAttribute(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Access Model Metadata Attribute Values - * @summary List access model metadata values - * @param {AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public listAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiListAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).listAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** - * @summary Update access model metadata attribute - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public updateAccessModelMetadataAttribute(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).updateAccessModelMetadataAttribute(requestParameters.key, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** - * @summary Update access model metadata value - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public updateAccessModelMetadataAttributeValue(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataAttributeValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).updateAccessModelMetadataAttributeValue(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using a filter - * @summary Metadata Attribute update by filter - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public updateAccessModelMetadataByFilter(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).updateAccessModelMetadataByFilter(requestParameters.entitlementAttributeBulkUpdateFilterRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using ids. - * @summary Metadata Attribute update by ids - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public updateAccessModelMetadataByIds(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).updateAccessModelMetadataByIds(requestParameters.entitlementAttributeBulkUpdateIdsRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk update Access Model Metadata Attribute Values using a query - * @summary Metadata Attribute update by query - * @param {AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessModelMetadataV2026Api - */ - public updateAccessModelMetadataByQuery(requestParameters: AccessModelMetadataV2026ApiUpdateAccessModelMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessModelMetadataV2026ApiFp(this.configuration).updateAccessModelMetadataByQuery(requestParameters.entitlementAttributeBulkUpdateQueryRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessProfilesV2026Api - axios parameter creator - * @export - */ -export const AccessProfilesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2026} accessProfileV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile: async (accessProfileV2026: AccessProfileV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileV2026' is not null or undefined - assertParamExists('createAccessProfile', 'accessProfileV2026', accessProfileV2026) - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2026} accessProfileBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk: async (accessProfileBulkDeleteRequestV2026: AccessProfileBulkDeleteRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkDeleteRequestV2026' is not null or undefined - assertParamExists('deleteAccessProfilesInBulk', 'accessProfileBulkDeleteRequestV2026', accessProfileBulkDeleteRequestV2026) - const localVarPath = `/access-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfileEntitlements', 'id', id) - const localVarPath = `/access-profiles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAccessProfile', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAccessProfile', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk: async (accessProfileBulkUpdateRequestInnerV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkUpdateRequestInnerV2026' is not null or undefined - assertParamExists('updateAccessProfilesInBulk', 'accessProfileBulkUpdateRequestInnerV2026', accessProfileBulkUpdateRequestInnerV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-profiles/bulk-update-requestable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkUpdateRequestInnerV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessProfilesV2026Api - functional programming interface - * @export - */ -export const AccessProfilesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessProfilesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfileV2026} accessProfileV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessProfile(accessProfileV2026: AccessProfileV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfile(accessProfileV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.createAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.deleteAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequestV2026} accessProfileBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2026: AccessProfileBulkDeleteRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulk(accessProfileBulkDeleteRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.deleteAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.getAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.getAccessProfileEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfiles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.listAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAccessProfile(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfile(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.patchAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {Array} accessProfileBulkUpdateRequestInnerV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessProfilesInBulk(accessProfileBulkUpdateRequestInnerV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesV2026Api.updateAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessProfilesV2026Api - factory interface - * @export - */ -export const AccessProfilesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessProfilesV2026ApiFp(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2026ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile(requestParameters: AccessProfilesV2026ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessProfile(requestParameters.accessProfileV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2026ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile(requestParameters: AccessProfilesV2026ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2026ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile(requestParameters: AccessProfilesV2026ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements(requestParameters: AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2026ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles(requestParameters: AccessProfilesV2026ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2026ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile(requestParameters: AccessProfilesV2026ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccessProfilesInBulk(requestParameters: AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessProfile operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiCreateAccessProfileRequest - */ -export interface AccessProfilesV2026ApiCreateAccessProfileRequest { - /** - * - * @type {AccessProfileV2026} - * @memberof AccessProfilesV2026ApiCreateAccessProfile - */ - readonly accessProfileV2026: AccessProfileV2026 -} - -/** - * Request parameters for deleteAccessProfile operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiDeleteAccessProfileRequest - */ -export interface AccessProfilesV2026ApiDeleteAccessProfileRequest { - /** - * ID of the Access Profile to delete - * @type {string} - * @memberof AccessProfilesV2026ApiDeleteAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest { - /** - * - * @type {AccessProfileBulkDeleteRequestV2026} - * @memberof AccessProfilesV2026ApiDeleteAccessProfilesInBulk - */ - readonly accessProfileBulkDeleteRequestV2026: AccessProfileBulkDeleteRequestV2026 -} - -/** - * Request parameters for getAccessProfile operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiGetAccessProfileRequest - */ -export interface AccessProfilesV2026ApiGetAccessProfileRequest { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfilesV2026ApiGetAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for getAccessProfileEntitlements operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest - */ -export interface AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest { - /** - * ID of the access profile containing the entitlements. - * @type {string} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof AccessProfilesV2026ApiGetAccessProfileEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listAccessProfiles operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiListAccessProfilesRequest - */ -export interface AccessProfilesV2026ApiListAccessProfilesRequest { - /** - * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @type {string} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly forSubadmin?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly sorters?: string - - /** - * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly forSegmentIds?: string - - /** - * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @type {boolean} - * @memberof AccessProfilesV2026ApiListAccessProfiles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchAccessProfile operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiPatchAccessProfileRequest - */ -export interface AccessProfilesV2026ApiPatchAccessProfileRequest { - /** - * ID of the Access Profile to patch - * @type {string} - * @memberof AccessProfilesV2026ApiPatchAccessProfile - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AccessProfilesV2026ApiPatchAccessProfile - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateAccessProfilesInBulk operation in AccessProfilesV2026Api. - * @export - * @interface AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest - */ -export interface AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest { - /** - * - * @type {Array} - * @memberof AccessProfilesV2026ApiUpdateAccessProfilesInBulk - */ - readonly accessProfileBulkUpdateRequestInnerV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessProfilesV2026ApiUpdateAccessProfilesInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * AccessProfilesV2026Api - object-oriented interface - * @export - * @class AccessProfilesV2026Api - * @extends {BaseAPI} - */ -export class AccessProfilesV2026Api extends BaseAPI { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesV2026ApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public createAccessProfile(requestParameters: AccessProfilesV2026ApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).createAccessProfile(requestParameters.accessProfileV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesV2026ApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public deleteAccessProfile(requestParameters: AccessProfilesV2026ApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public deleteAccessProfilesInBulk(requestParameters: AccessProfilesV2026ApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesV2026ApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public getAccessProfile(requestParameters: AccessProfilesV2026ApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public getAccessProfileEntitlements(requestParameters: AccessProfilesV2026ApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesV2026ApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public listAccessProfiles(requestParameters: AccessProfilesV2026ApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesV2026ApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public patchAccessProfile(requestParameters: AccessProfilesV2026ApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. - * @summary Update access profile(s) requestable field. - * @param {AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesV2026Api - */ - public updateAccessProfilesInBulk(requestParameters: AccessProfilesV2026ApiUpdateAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesV2026ApiFp(this.configuration).updateAccessProfilesInBulk(requestParameters.accessProfileBulkUpdateRequestInnerV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestApprovalsV2026Api - axios parameter creator - * @export - */ -export const AccessRequestApprovalsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2026} [commentDtoV2026] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest: async (approvalId: string, commentDtoV2026?: CommentDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('approveAccessRequest', 'approvalId', approvalId) - const localVarPath = `/access-request-approvals/{approvalId}/approve` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2026} forwardApprovalDtoV2026 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest: async (approvalId: string, forwardApprovalDtoV2026: ForwardApprovalDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('forwardAccessRequest', 'approvalId', approvalId) - // verify required parameter 'forwardApprovalDtoV2026' is not null or undefined - assertParamExists('forwardAccessRequest', 'forwardApprovalDtoV2026', forwardApprovalDtoV2026) - const localVarPath = `/access-request-approvals/{approvalId}/forward` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(forwardApprovalDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/approval-summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (fromDate !== undefined) { - localVarQueryParameter['from-date'] = fromDate; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers: async (accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestId' is not null or undefined - assertParamExists('listAccessRequestApprovers', 'accessRequestId', accessRequestId) - const localVarPath = `/access-request-approvals/{accessRequestId}/approvers` - .replace(`{${"accessRequestId"}}`, encodeURIComponent(String(accessRequestId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/pending`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2026} commentDtoV2026 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest: async (approvalId: string, commentDtoV2026: CommentDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('rejectAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDtoV2026' is not null or undefined - assertParamExists('rejectAccessRequest', 'commentDtoV2026', commentDtoV2026) - const localVarPath = `/access-request-approvals/{approvalId}/reject` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestApprovalsV2026Api - functional programming interface - * @export - */ -export const AccessRequestApprovalsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestApprovalsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2026} [commentDtoV2026] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveAccessRequest(approvalId: string, commentDtoV2026?: CommentDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequest(approvalId, commentDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.approveAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDtoV2026} forwardApprovalDtoV2026 Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardAccessRequest(approvalId: string, forwardApprovalDtoV2026: ForwardApprovalDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequest(approvalId, forwardApprovalDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.forwardAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummary(ownerId, fromDate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.getAccessRequestApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {string} accessRequestId Access Request ID. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestApprovers(accessRequestId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestApprovers(accessRequestId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.listAccessRequestApprovers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.listCompletedApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.listPendingApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDtoV2026} commentDtoV2026 Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectAccessRequest(approvalId: string, commentDtoV2026: CommentDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequest(approvalId, commentDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsV2026Api.rejectAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestApprovalsV2026Api - factory interface - * @export - */ -export const AccessRequestApprovalsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestApprovalsV2026ApiFp(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2026ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2026ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals(requestParameters: AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2026ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals(requestParameters: AccessRequestApprovalsV2026ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2026ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveAccessRequest operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiApproveAccessRequestRequest - */ -export interface AccessRequestApprovalsV2026ApiApproveAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiApproveAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2026} - * @memberof AccessRequestApprovalsV2026ApiApproveAccessRequest - */ - readonly commentDtoV2026?: CommentDtoV2026 -} - -/** - * Request parameters for forwardAccessRequest operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiForwardAccessRequestRequest - */ -export interface AccessRequestApprovalsV2026ApiForwardAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiForwardAccessRequest - */ - readonly approvalId: string - - /** - * Information about the forwarded approval. - * @type {ForwardApprovalDtoV2026} - * @memberof AccessRequestApprovalsV2026ApiForwardAccessRequest - */ - readonly forwardApprovalDtoV2026: ForwardApprovalDtoV2026 -} - -/** - * Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest - */ -export interface AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest { - /** - * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummary - */ - readonly ownerId?: string - - /** - * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummary - */ - readonly fromDate?: string -} - -/** - * Request parameters for listAccessRequestApprovers operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest - */ -export interface AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest { - /** - * Access Request ID. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListAccessRequestApprovers - */ - readonly accessRequestId: string - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListAccessRequestApprovers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListAccessRequestApprovers - */ - readonly offset?: number - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestApprovalsV2026ApiListAccessRequestApprovers - */ - readonly count?: boolean -} - -/** - * Request parameters for listCompletedApprovals operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest - */ -export interface AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest { - /** - * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListCompletedApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listPendingApprovals operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiListPendingApprovalsRequest - */ -export interface AccessRequestApprovalsV2026ApiListPendingApprovalsRequest { - /** - * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiListPendingApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for rejectAccessRequest operation in AccessRequestApprovalsV2026Api. - * @export - * @interface AccessRequestApprovalsV2026ApiRejectAccessRequestRequest - */ -export interface AccessRequestApprovalsV2026ApiRejectAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsV2026ApiRejectAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDtoV2026} - * @memberof AccessRequestApprovalsV2026ApiRejectAccessRequest - */ - readonly commentDtoV2026: CommentDtoV2026 -} - -/** - * AccessRequestApprovalsV2026Api - object-oriented interface - * @export - * @class AccessRequestApprovalsV2026Api - * @extends {BaseAPI} - */ -export class AccessRequestApprovalsV2026Api extends BaseAPI { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsV2026ApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public approveAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).approveAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsV2026ApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public forwardAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsV2026ApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the list of approvers for the given access request id. - * @summary Access request approvers - * @param {AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public listAccessRequestApprovers(requestParameters: AccessRequestApprovalsV2026ApiListAccessRequestApproversRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).listAccessRequestApprovers(requestParameters.accessRequestId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public listCompletedApprovals(requestParameters: AccessRequestApprovalsV2026ApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsV2026ApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public listPendingApprovals(requestParameters: AccessRequestApprovalsV2026ApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsV2026ApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsV2026Api - */ - public rejectAccessRequest(requestParameters: AccessRequestApprovalsV2026ApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsV2026ApiFp(this.configuration).rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestIdentityMetricsV2026Api - axios parameter creator - * @export - */ -export const AccessRequestIdentityMetricsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2026} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics: async (identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'identityId', identityId) - // verify required parameter 'requestedObjectId' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'requestedObjectId', requestedObjectId) - // verify required parameter 'type' is not null or undefined - assertParamExists('getAccessRequestIdentityMetrics', 'type', type) - const localVarPath = `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"requestedObjectId"}}`, encodeURIComponent(String(requestedObjectId))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2026Api - functional programming interface - * @export - */ -export const AccessRequestIdentityMetricsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestIdentityMetricsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {string} identityId Manager\'s identity ID. - * @param {string} requestedObjectId Requested access item\'s ID. - * @param {GetAccessRequestIdentityMetricsTypeV2026} type Requested access item\'s type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestIdentityMetrics(identityId: string, requestedObjectId: string, type: GetAccessRequestIdentityMetricsTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestIdentityMetrics(identityId, requestedObjectId, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestIdentityMetricsV2026Api.getAccessRequestIdentityMetrics']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestIdentityMetricsV2026Api - factory interface - * @export - */ -export const AccessRequestIdentityMetricsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestIdentityMetricsV2026ApiFp(configuration) - return { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccessRequestIdentityMetrics operation in AccessRequestIdentityMetricsV2026Api. - * @export - * @interface AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest - */ -export interface AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest { - /** - * Manager\'s identity ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetrics - */ - readonly identityId: string - - /** - * Requested access item\'s ID. - * @type {string} - * @memberof AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetrics - */ - readonly requestedObjectId: string - - /** - * Requested access item\'s type. - * @type {'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE'} - * @memberof AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetrics - */ - readonly type: GetAccessRequestIdentityMetricsTypeV2026 -} - -/** - * AccessRequestIdentityMetricsV2026Api - object-oriented interface - * @export - * @class AccessRequestIdentityMetricsV2026Api - * @extends {BaseAPI} - */ -export class AccessRequestIdentityMetricsV2026Api extends BaseAPI { - /** - * Use this API to return information access metrics. - * @summary Return access request identity metrics - * @param {AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestIdentityMetricsV2026Api - */ - public getAccessRequestIdentityMetrics(requestParameters: AccessRequestIdentityMetricsV2026ApiGetAccessRequestIdentityMetricsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestIdentityMetricsV2026ApiFp(this.configuration).getAccessRequestIdentityMetrics(requestParameters.identityId, requestParameters.requestedObjectId, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetAccessRequestIdentityMetricsTypeV2026 = { - Entitlement: 'ENTITLEMENT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE' -} as const; -export type GetAccessRequestIdentityMetricsTypeV2026 = typeof GetAccessRequestIdentityMetricsTypeV2026[keyof typeof GetAccessRequestIdentityMetricsTypeV2026]; - - -/** - * AccessRequestsV2026Api - axios parameter creator - * @export - */ -export const AccessRequestsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2026} bulkApproveAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest: async (bulkApproveAccessRequestV2026: BulkApproveAccessRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveAccessRequestV2026' is not null or undefined - assertParamExists('approveBulkAccessRequest', 'bulkApproveAccessRequestV2026', bulkApproveAccessRequestV2026) - const localVarPath = `/access-request-approvals/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveAccessRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2026} cancelAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest: async (cancelAccessRequestV2026: CancelAccessRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cancelAccessRequestV2026' is not null or undefined - assertParamExists('cancelAccessRequest', 'cancelAccessRequestV2026', cancelAccessRequestV2026) - const localVarPath = `/access-requests/cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(cancelAccessRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2026} bulkCancelAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk: async (bulkCancelAccessRequestV2026: BulkCancelAccessRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkCancelAccessRequestV2026' is not null or undefined - assertParamExists('cancelAccessRequestInBulk', 'bulkCancelAccessRequestV2026', bulkCancelAccessRequestV2026) - const localVarPath = `/access-requests/bulk-cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkCancelAccessRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2026} closeAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest: async (closeAccessRequestV2026: CloseAccessRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'closeAccessRequestV2026' is not null or undefined - assertParamExists('closeAccessRequest', 'closeAccessRequestV2026', closeAccessRequestV2026) - const localVarPath = `/access-requests/close`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(closeAccessRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2026} accessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest: async (accessRequestV2026: AccessRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestV2026' is not null or undefined - assertParamExists('createAccessRequest', 'accessRequestV2026', accessRequestV2026) - const localVarPath = `/access-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity: async (identityId: string, entitlementId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'identityId', identityId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementDetailsForIdentity', 'entitlementId', entitlementId) - const localVarPath = `/revocable-objects` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus: async (xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('listAdministratorsAccessRequestStatus', 'xSailPointExperimental', xSailPointExperimental) - const localVarPath = `/access-request-administration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2026} accountsSelectionRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections: async (accountsSelectionRequestV2026: AccountsSelectionRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountsSelectionRequestV2026' is not null or undefined - assertParamExists('loadAccountSelections', 'accountsSelectionRequestV2026', accountsSelectionRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/access-requests/accounts-selection`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountsSelectionRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2026} accessRequestConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestConfig: async (accessRequestConfigV2026: AccessRequestConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestConfigV2026' is not null or undefined - assertParamExists('setAccessRequestConfig', 'accessRequestConfigV2026', accessRequestConfigV2026) - const localVarPath = `/access-request-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestsV2026Api - functional programming interface - * @export - */ -export const AccessRequestsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {BulkApproveAccessRequestV2026} bulkApproveAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveBulkAccessRequest(bulkApproveAccessRequestV2026: BulkApproveAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkAccessRequest(bulkApproveAccessRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.approveBulkAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequestV2026} cancelAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequest(cancelAccessRequestV2026: CancelAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequest(cancelAccessRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.cancelAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {BulkCancelAccessRequestV2026} bulkCancelAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequestInBulk(bulkCancelAccessRequestV2026: BulkCancelAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequestInBulk(bulkCancelAccessRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.cancelAccessRequestInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {CloseAccessRequestV2026} closeAccessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async closeAccessRequest(closeAccessRequestV2026: CloseAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.closeAccessRequest(closeAccessRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.closeAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestV2026} accessRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessRequest(accessRequestV2026: AccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequest(accessRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.createAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.getAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {string} identityId The identity ID. - * @param {string} entitlementId The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDetailsForIdentity(identityId: string, entitlementId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDetailsForIdentity(identityId, entitlementId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.getEntitlementDetailsForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatus(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.listAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @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: **created, modified, accountActivityItemId, name, accessRequestId** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAdministratorsAccessRequestStatus(xSailPointExperimental: string, requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAdministratorsAccessRequestStatus(xSailPointExperimental, requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.listAdministratorsAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccountsSelectionRequestV2026} accountsSelectionRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async loadAccountSelections(accountsSelectionRequestV2026: AccountsSelectionRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.loadAccountSelections(accountsSelectionRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.loadAccountSelections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfigV2026} accessRequestConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setAccessRequestConfig(accessRequestConfigV2026: AccessRequestConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfig(accessRequestConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsV2026Api.setAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestsV2026Api - factory interface - * @export - */ -export const AccessRequestsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestsV2026ApiFp(configuration) - return { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2026ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkAccessRequest(requestParameters: AccessRequestsV2026ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2026ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest(requestParameters: AccessRequestsV2026ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2026ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequestInBulk(requestParameters: AccessRequestsV2026ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2026ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - closeAccessRequest(requestParameters: AccessRequestsV2026ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.closeAccessRequest(requestParameters.closeAccessRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2026ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest(requestParameters: AccessRequestsV2026ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessRequest(requestParameters.accessRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2026ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus(requestParameters: AccessRequestsV2026ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2026ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadAccountSelections(requestParameters: AccessRequestsV2026ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.loadAccountSelections(requestParameters.accountsSelectionRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2026ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestConfig(requestParameters: AccessRequestsV2026ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestConfig(requestParameters.accessRequestConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveBulkAccessRequest operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiApproveBulkAccessRequestRequest - */ -export interface AccessRequestsV2026ApiApproveBulkAccessRequestRequest { - /** - * - * @type {BulkApproveAccessRequestV2026} - * @memberof AccessRequestsV2026ApiApproveBulkAccessRequest - */ - readonly bulkApproveAccessRequestV2026: BulkApproveAccessRequestV2026 -} - -/** - * Request parameters for cancelAccessRequest operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiCancelAccessRequestRequest - */ -export interface AccessRequestsV2026ApiCancelAccessRequestRequest { - /** - * - * @type {CancelAccessRequestV2026} - * @memberof AccessRequestsV2026ApiCancelAccessRequest - */ - readonly cancelAccessRequestV2026: CancelAccessRequestV2026 -} - -/** - * Request parameters for cancelAccessRequestInBulk operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiCancelAccessRequestInBulkRequest - */ -export interface AccessRequestsV2026ApiCancelAccessRequestInBulkRequest { - /** - * - * @type {BulkCancelAccessRequestV2026} - * @memberof AccessRequestsV2026ApiCancelAccessRequestInBulk - */ - readonly bulkCancelAccessRequestV2026: BulkCancelAccessRequestV2026 -} - -/** - * Request parameters for closeAccessRequest operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiCloseAccessRequestRequest - */ -export interface AccessRequestsV2026ApiCloseAccessRequestRequest { - /** - * - * @type {CloseAccessRequestV2026} - * @memberof AccessRequestsV2026ApiCloseAccessRequest - */ - readonly closeAccessRequestV2026: CloseAccessRequestV2026 -} - -/** - * Request parameters for createAccessRequest operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiCreateAccessRequestRequest - */ -export interface AccessRequestsV2026ApiCreateAccessRequestRequest { - /** - * - * @type {AccessRequestV2026} - * @memberof AccessRequestsV2026ApiCreateAccessRequest - */ - readonly accessRequestV2026: AccessRequestV2026 -} - -/** - * Request parameters for getEntitlementDetailsForIdentity operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest - */ -export interface AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest { - /** - * The identity ID. - * @type {string} - * @memberof AccessRequestsV2026ApiGetEntitlementDetailsForIdentity - */ - readonly identityId: string - - /** - * The entitlement ID - * @type {string} - * @memberof AccessRequestsV2026ApiGetEntitlementDetailsForIdentity - */ - readonly entitlementId: string -} - -/** - * Request parameters for listAccessRequestStatus operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiListAccessRequestStatusRequest - */ -export interface AccessRequestsV2026ApiListAccessRequestStatusRequest { - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name** - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for listAdministratorsAccessRequestStatus operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest - */ -export interface AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly xSailPointExperimental: string - - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name, accessRequestId** - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for loadAccountSelections operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiLoadAccountSelectionsRequest - */ -export interface AccessRequestsV2026ApiLoadAccountSelectionsRequest { - /** - * - * @type {AccountsSelectionRequestV2026} - * @memberof AccessRequestsV2026ApiLoadAccountSelections - */ - readonly accountsSelectionRequestV2026: AccountsSelectionRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AccessRequestsV2026ApiLoadAccountSelections - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestConfig operation in AccessRequestsV2026Api. - * @export - * @interface AccessRequestsV2026ApiSetAccessRequestConfigRequest - */ -export interface AccessRequestsV2026ApiSetAccessRequestConfigRequest { - /** - * - * @type {AccessRequestConfigV2026} - * @memberof AccessRequestsV2026ApiSetAccessRequestConfig - */ - readonly accessRequestConfigV2026: AccessRequestConfigV2026 -} - -/** - * AccessRequestsV2026Api - object-oriented interface - * @export - * @class AccessRequestsV2026Api - * @extends {BaseAPI} - */ -export class AccessRequestsV2026Api extends BaseAPI { - /** - * This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can approve the access requests in bulk. - * @summary Bulk approve access request - * @param {AccessRequestsV2026ApiApproveBulkAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public approveBulkAccessRequest(requestParameters: AccessRequestsV2026ApiApproveBulkAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).approveBulkAccessRequest(requestParameters.bulkApproveAccessRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsV2026ApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public cancelAccessRequest(requestParameters: AccessRequestsV2026ApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights \"idn:access-request-administration:write\" can cancel the access requests in bulk. - * @summary Bulk cancel access request - * @param {AccessRequestsV2026ApiCancelAccessRequestInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public cancelAccessRequestInBulk(requestParameters: AccessRequestsV2026ApiCancelAccessRequestInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).cancelAccessRequestInBulk(requestParameters.bulkCancelAccessRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request\'s lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND \"Access Request\". Use the Column Chooser to select \'Tracking Number\', and use the \'Download\' button to export a CSV containing the tracking numbers. To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). Input the IDs from either source. To track the status of endpoint requests, navigate to Search and use this query: name:\"Close Identity Requests\". Search will include \"Close Identity Requests Started\" audits when requests are initiated and \"Close Identity Requests Completed\" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - * @summary Close access request - * @param {AccessRequestsV2026ApiCloseAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public closeAccessRequest(requestParameters: AccessRequestsV2026ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).closeAccessRequest(requestParameters.closeAccessRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsV2026ApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public createAccessRequest(requestParameters: AccessRequestsV2026ApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).createAccessRequest(requestParameters.accessRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).getAccessRequestConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. - * @summary Identity entitlement details - * @param {AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public getEntitlementDetailsForIdentity(requestParameters: AccessRequestsV2026ApiGetEntitlementDetailsForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).getEntitlementDetailsForIdentity(requestParameters.identityId, requestParameters.entitlementId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsV2026ApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public listAccessRequestStatus(requestParameters: AccessRequestsV2026ApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses - * @summary Access request status for administrators - * @param {AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public listAdministratorsAccessRequestStatus(requestParameters: AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).listAdministratorsAccessRequestStatus(requestParameters.xSailPointExperimental, requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch account information for an identity against the items in an access request. Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. - * @summary Get accounts selections for identity - * @param {AccessRequestsV2026ApiLoadAccountSelectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public loadAccountSelections(requestParameters: AccessRequestsV2026ApiLoadAccountSelectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).loadAccountSelections(requestParameters.accountsSelectionRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsV2026ApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsV2026Api - */ - public setAccessRequestConfig(requestParameters: AccessRequestsV2026ApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsV2026ApiFp(this.configuration).setAccessRequestConfig(requestParameters.accessRequestConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountActivitiesV2026Api - axios parameter creator - * @export - */ -export const AccountActivitiesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountActivity', 'id', id) - const localVarPath = `/account-activities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-activities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountActivitiesV2026Api - functional programming interface - * @export - */ -export const AccountActivitiesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountActivitiesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountActivity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2026Api.getAccountActivity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccountActivities(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivities(requestedFor, requestedBy, regardingIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesV2026Api.listAccountActivities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountActivitiesV2026Api - factory interface - * @export - */ -export const AccountActivitiesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountActivitiesV2026ApiFp(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2026ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity(requestParameters: AccountActivitiesV2026ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2026ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities(requestParameters: AccountActivitiesV2026ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountActivity operation in AccountActivitiesV2026Api. - * @export - * @interface AccountActivitiesV2026ApiGetAccountActivityRequest - */ -export interface AccountActivitiesV2026ApiGetAccountActivityRequest { - /** - * The account activity id - * @type {string} - * @memberof AccountActivitiesV2026ApiGetAccountActivity - */ - readonly id: string -} - -/** - * Request parameters for listAccountActivities operation in AccountActivitiesV2026Api. - * @export - * @interface AccountActivitiesV2026ApiListAccountActivitiesRequest - */ -export interface AccountActivitiesV2026ApiListAccountActivitiesRequest { - /** - * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly requestedFor?: string - - /** - * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly requestedBy?: string - - /** - * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly regardingIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @type {string} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - 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: **type, created, modified** - * @type {string} - * @memberof AccountActivitiesV2026ApiListAccountActivities - */ - readonly sorters?: string -} - -/** - * AccountActivitiesV2026Api - object-oriented interface - * @export - * @class AccountActivitiesV2026Api - * @extends {BaseAPI} - */ -export class AccountActivitiesV2026Api extends BaseAPI { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesV2026ApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2026Api - */ - public getAccountActivity(requestParameters: AccountActivitiesV2026ApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2026ApiFp(this.configuration).getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesV2026ApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesV2026Api - */ - public listAccountActivities(requestParameters: AccountActivitiesV2026ApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesV2026ApiFp(this.configuration).listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountAggregationsV2026Api - axios parameter creator - * @export - */ -export const AccountAggregationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountAggregationStatus', 'id', id) - const localVarPath = `/account-aggregations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountAggregationsV2026Api - functional programming interface - * @export - */ -export const AccountAggregationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountAggregationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {string} id The account aggregation id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountAggregationStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountAggregationStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountAggregationsV2026Api.getAccountAggregationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountAggregationsV2026Api - factory interface - * @export - */ -export const AccountAggregationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountAggregationsV2026ApiFp(configuration) - return { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2026ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountAggregationStatus(requestParameters: AccountAggregationsV2026ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountAggregationStatus operation in AccountAggregationsV2026Api. - * @export - * @interface AccountAggregationsV2026ApiGetAccountAggregationStatusRequest - */ -export interface AccountAggregationsV2026ApiGetAccountAggregationStatusRequest { - /** - * The account aggregation id - * @type {string} - * @memberof AccountAggregationsV2026ApiGetAccountAggregationStatus - */ - readonly id: string -} - -/** - * AccountAggregationsV2026Api - object-oriented interface - * @export - * @class AccountAggregationsV2026Api - * @extends {BaseAPI} - */ -export class AccountAggregationsV2026Api extends BaseAPI { - /** - * This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. - * @summary In-progress account aggregation status - * @param {AccountAggregationsV2026ApiGetAccountAggregationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountAggregationsV2026Api - */ - public getAccountAggregationStatus(requestParameters: AccountAggregationsV2026ApiGetAccountAggregationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountAggregationsV2026ApiFp(this.configuration).getAccountAggregationStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountDeletionRequestsV2026Api - axios parameter creator - * @export - */ -export const AccountDeletionRequestsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** - * @summary Delete account - * @param {string} accountId Account ID. - * @param {AccountDeleteRequestInputV2026} [accountDeleteRequestInputV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountRequest: async (accountId: string, accountDeleteRequestInputV2026?: AccountDeleteRequestInputV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('deleteAccountRequest', 'accountId', accountId) - const localVarPath = `/account-requests/account/{accountId}/delete` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountDeleteRequestInputV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. - * @summary List of Account Deletion Requests - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [mine] Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountDeletionRequests: async (limit?: number, offset?: number, count?: boolean, mine?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-requests/deletion`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (mine !== undefined) { - localVarQueryParameter['mine'] = mine; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountDeletionRequestsV2026Api - functional programming interface - * @export - */ -export const AccountDeletionRequestsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountDeletionRequestsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** - * @summary Delete account - * @param {string} accountId Account ID. - * @param {AccountDeleteRequestInputV2026} [accountDeleteRequestInputV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountRequest(accountId: string, accountDeleteRequestInputV2026?: AccountDeleteRequestInputV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountRequest(accountId, accountDeleteRequestInputV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountDeletionRequestsV2026Api.deleteAccountRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. - * @summary List of Account Deletion Requests - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [mine] Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountDeletionRequests(limit?: number, offset?: number, count?: boolean, mine?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountDeletionRequests(limit, offset, count, mine, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountDeletionRequestsV2026Api.getAccountDeletionRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountDeletionRequestsV2026Api - factory interface - * @export - */ -export const AccountDeletionRequestsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountDeletionRequestsV2026ApiFp(configuration) - return { - /** - * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** - * @summary Delete account - * @param {AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountRequest(requestParameters: AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountRequest(requestParameters.accountId, requestParameters.accountDeleteRequestInputV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. - * @summary List of Account Deletion Requests - * @param {AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountDeletionRequests(requestParameters: AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountDeletionRequests(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.mine, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteAccountRequest operation in AccountDeletionRequestsV2026Api. - * @export - * @interface AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest - */ -export interface AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountDeletionRequestsV2026ApiDeleteAccountRequest - */ - readonly accountId: string - - /** - * - * @type {AccountDeleteRequestInputV2026} - * @memberof AccountDeletionRequestsV2026ApiDeleteAccountRequest - */ - readonly accountDeleteRequestInputV2026?: AccountDeleteRequestInputV2026 -} - -/** - * Request parameters for getAccountDeletionRequests operation in AccountDeletionRequestsV2026Api. - * @export - * @interface AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest - */ -export interface AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest { - /** - * 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 AccountDeletionRequestsV2026ApiGetAccountDeletionRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountDeletionRequestsV2026ApiGetAccountDeletionRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountDeletionRequestsV2026ApiGetAccountDeletionRequests - */ - readonly count?: boolean - - /** - * Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. - * @type {boolean} - * @memberof AccountDeletionRequestsV2026ApiGetAccountDeletionRequests - */ - readonly mine?: boolean -} - -/** - * AccountDeletionRequestsV2026Api - object-oriented interface - * @export - * @class AccountDeletionRequestsV2026Api - * @extends {BaseAPI} - */ -export class AccountDeletionRequestsV2026Api extends BaseAPI { - /** - * Initiates an account deletion request for the specified account. This method validates the input data, processes the deletion request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only delete accounts from sources of the \"Connected\" type. which supports account deletion** - * @summary Delete account - * @param {AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountDeletionRequestsV2026Api - */ - public deleteAccountRequest(requestParameters: AccountDeletionRequestsV2026ApiDeleteAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountDeletionRequestsV2026ApiFp(this.configuration).deleteAccountRequest(requestParameters.accountId, requestParameters.accountDeleteRequestInputV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the \"mine\" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If \"mine\" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. - * @summary List of Account Deletion Requests - * @param {AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountDeletionRequestsV2026Api - */ - public getAccountDeletionRequests(requestParameters: AccountDeletionRequestsV2026ApiGetAccountDeletionRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountDeletionRequestsV2026ApiFp(this.configuration).getAccountDeletionRequests(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.mine, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountUsagesV2026Api - axios parameter creator - * @export - */ -export const AccountUsagesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('getUsagesByAccountId', 'accountId', accountId) - const localVarPath = `/account-usages/{accountId}/summaries` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountUsagesV2026Api - functional programming interface - * @export - */ -export const AccountUsagesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountUsagesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountId(accountId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountUsagesV2026Api.getUsagesByAccountId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountUsagesV2026Api - factory interface - * @export - */ -export const AccountUsagesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountUsagesV2026ApiFp(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2026ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId(requestParameters: AccountUsagesV2026ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getUsagesByAccountId operation in AccountUsagesV2026Api. - * @export - * @interface AccountUsagesV2026ApiGetUsagesByAccountIdRequest - */ -export interface AccountUsagesV2026ApiGetUsagesByAccountIdRequest { - /** - * ID of IDN account - * @type {string} - * @memberof AccountUsagesV2026ApiGetUsagesByAccountId - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2026ApiGetUsagesByAccountId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesV2026ApiGetUsagesByAccountId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountUsagesV2026ApiGetUsagesByAccountId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof AccountUsagesV2026ApiGetUsagesByAccountId - */ - readonly sorters?: string -} - -/** - * AccountUsagesV2026Api - object-oriented interface - * @export - * @class AccountUsagesV2026Api - * @extends {BaseAPI} - */ -export class AccountUsagesV2026Api extends BaseAPI { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesV2026ApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountUsagesV2026Api - */ - public getUsagesByAccountId(requestParameters: AccountUsagesV2026ApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountUsagesV2026ApiFp(this.configuration).getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountsV2026Api - axios parameter creator - * @export - */ -export const AccountsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2026} accountAttributesCreateV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount: async (accountAttributesCreateV2026: AccountAttributesCreateV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountAttributesCreateV2026' is not null or undefined - assertParamExists('createAccount', 'accountAttributesCreateV2026', accountAttributesCreateV2026) - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesCreateV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountAsync', 'id', id) - const localVarPath = `/accounts/{id}/remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2026} accountToggleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount: async (id: string, accountToggleRequestV2026: AccountToggleRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2026' is not null or undefined - assertParamExists('disableAccount', 'accountToggleRequestV2026', accountToggleRequestV2026) - const localVarPath = `/accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2026} identitiesAccountsBulkRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities: async (identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2026' is not null or undefined - assertParamExists('disableAccountsForIdentities', 'identitiesAccountsBulkRequestV2026', identitiesAccountsBulkRequestV2026) - const localVarPath = `/identities-accounts/disable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2026} accountToggleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount: async (id: string, accountToggleRequestV2026: AccountToggleRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccount', 'id', id) - // verify required parameter 'accountToggleRequestV2026' is not null or undefined - assertParamExists('enableAccount', 'accountToggleRequestV2026', accountToggleRequestV2026) - const localVarPath = `/accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccountForIdentity', 'id', id) - const localVarPath = `/identities-accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2026} identitiesAccountsBulkRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities: async (identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identitiesAccountsBulkRequestV2026' is not null or undefined - assertParamExists('enableAccountsForIdentities', 'identitiesAccountsBulkRequestV2026', identitiesAccountsBulkRequestV2026) - const localVarPath = `/identities-accounts/enable`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identitiesAccountsBulkRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountEntitlements', 'id', id) - const localVarPath = `/accounts/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2026} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts: async (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2026, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - 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, - }; - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2026} accountAttributesV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount: async (id: string, accountAttributesV2026: AccountAttributesV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putAccount', 'id', id) - // verify required parameter 'accountAttributesV2026' is not null or undefined - assertParamExists('putAccount', 'accountAttributesV2026', accountAttributesV2026) - const localVarPath = `/accounts/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReloadAccount', 'id', id) - const localVarPath = `/accounts/{id}/reload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2026} accountUnlockRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount: async (id: string, accountUnlockRequestV2026: AccountUnlockRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unlockAccount', 'id', id) - // verify required parameter 'accountUnlockRequestV2026' is not null or undefined - assertParamExists('unlockAccount', 'accountUnlockRequestV2026', accountUnlockRequestV2026) - const localVarPath = `/accounts/{id}/unlock` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountUnlockRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateAccount', 'requestBody', requestBody) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountsV2026Api - functional programming interface - * @export - */ -export const AccountsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreateV2026} accountAttributesCreateV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccount(accountAttributesCreateV2026: AccountAttributesCreateV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccount(accountAttributesCreateV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.createAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.deleteAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.deleteAccountAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequestV2026} accountToggleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccount(id: string, accountToggleRequestV2026: AccountToggleRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccount(id, accountToggleRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.disableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.disableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2026} identitiesAccountsBulkRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccountsForIdentities(identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccountsForIdentities(identitiesAccountsBulkRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.disableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequestV2026} accountToggleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccount(id: string, accountToggleRequestV2026: AccountToggleRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccount(id, accountToggleRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.enableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {string} id The identity id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountForIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountForIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.enableAccountForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {IdentitiesAccountsBulkRequestV2026} identitiesAccountsBulkRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccountsForIdentities(identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccountsForIdentities(identitiesAccountsBulkRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.enableAccountsForIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.getAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.getAccountEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV2026} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccounts(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV2026, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(limit, offset, count, detailLevel, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.listAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributesV2026} accountAttributesV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putAccount(id: string, accountAttributesV2026: AccountAttributesV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putAccount(id, accountAttributesV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.putAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReloadAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.submitReloadAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequestV2026} accountUnlockRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unlockAccount(id: string, accountUnlockRequestV2026: AccountUnlockRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(id, accountUnlockRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.unlockAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsV2026Api.updateAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountsV2026Api - factory interface - * @export - */ -export const AccountsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountsV2026ApiFp(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2026ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount(requestParameters: AccountsV2026ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccount(requestParameters.accountAttributesCreateV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2026ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount(requestParameters: AccountsV2026ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2026ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountAsync(requestParameters: AccountsV2026ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2026ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount(requestParameters: AccountsV2026ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2026ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountForIdentity(requestParameters: AccountsV2026ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2026ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccountsForIdentities(requestParameters: AccountsV2026ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2026ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount(requestParameters: AccountsV2026ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2026ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountForIdentity(requestParameters: AccountsV2026ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2026ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccountsForIdentities(requestParameters: AccountsV2026ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2026ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount(requestParameters: AccountsV2026ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements(requestParameters: AccountsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2026ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts(requestParameters: AccountsV2026ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2026ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount(requestParameters: AccountsV2026ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putAccount(requestParameters.id, requestParameters.accountAttributesV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2026ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount(requestParameters: AccountsV2026ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2026ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount(requestParameters: AccountsV2026ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2026ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount(requestParameters: AccountsV2026ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiCreateAccountRequest - */ -export interface AccountsV2026ApiCreateAccountRequest { - /** - * - * @type {AccountAttributesCreateV2026} - * @memberof AccountsV2026ApiCreateAccount - */ - readonly accountAttributesCreateV2026: AccountAttributesCreateV2026 -} - -/** - * Request parameters for deleteAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiDeleteAccountRequest - */ -export interface AccountsV2026ApiDeleteAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2026ApiDeleteAccount - */ - readonly id: string -} - -/** - * Request parameters for deleteAccountAsync operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiDeleteAccountAsyncRequest - */ -export interface AccountsV2026ApiDeleteAccountAsyncRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2026ApiDeleteAccountAsync - */ - readonly id: string -} - -/** - * Request parameters for disableAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiDisableAccountRequest - */ -export interface AccountsV2026ApiDisableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2026ApiDisableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2026} - * @memberof AccountsV2026ApiDisableAccount - */ - readonly accountToggleRequestV2026: AccountToggleRequestV2026 -} - -/** - * Request parameters for disableAccountForIdentity operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiDisableAccountForIdentityRequest - */ -export interface AccountsV2026ApiDisableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2026ApiDisableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for disableAccountsForIdentities operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiDisableAccountsForIdentitiesRequest - */ -export interface AccountsV2026ApiDisableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2026} - * @memberof AccountsV2026ApiDisableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026 -} - -/** - * Request parameters for enableAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiEnableAccountRequest - */ -export interface AccountsV2026ApiEnableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2026ApiEnableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequestV2026} - * @memberof AccountsV2026ApiEnableAccount - */ - readonly accountToggleRequestV2026: AccountToggleRequestV2026 -} - -/** - * Request parameters for enableAccountForIdentity operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiEnableAccountForIdentityRequest - */ -export interface AccountsV2026ApiEnableAccountForIdentityRequest { - /** - * The identity id. - * @type {string} - * @memberof AccountsV2026ApiEnableAccountForIdentity - */ - readonly id: string -} - -/** - * Request parameters for enableAccountsForIdentities operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiEnableAccountsForIdentitiesRequest - */ -export interface AccountsV2026ApiEnableAccountsForIdentitiesRequest { - /** - * - * @type {IdentitiesAccountsBulkRequestV2026} - * @memberof AccountsV2026ApiEnableAccountsForIdentities - */ - readonly identitiesAccountsBulkRequestV2026: IdentitiesAccountsBulkRequestV2026 -} - -/** - * Request parameters for getAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiGetAccountRequest - */ -export interface AccountsV2026ApiGetAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2026ApiGetAccount - */ - readonly id: string -} - -/** - * Request parameters for getAccountEntitlements operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiGetAccountEntitlementsRequest - */ -export interface AccountsV2026ApiGetAccountEntitlementsRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2026ApiGetAccountEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2026ApiGetAccountEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2026ApiGetAccountEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2026ApiGetAccountEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccounts operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiListAccountsRequest - */ -export interface AccountsV2026ApiListAccountsRequest { - /** - * 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 AccountsV2026ApiListAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsV2026ApiListAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsV2026ApiListAccounts - */ - readonly count?: boolean - - /** - * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof AccountsV2026ApiListAccounts - */ - readonly detailLevel?: ListAccountsDetailLevelV2026 - - /** - * 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @type {string} - * @memberof AccountsV2026ApiListAccounts - */ - 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @type {string} - * @memberof AccountsV2026ApiListAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for putAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiPutAccountRequest - */ -export interface AccountsV2026ApiPutAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2026ApiPutAccount - */ - readonly id: string - - /** - * - * @type {AccountAttributesV2026} - * @memberof AccountsV2026ApiPutAccount - */ - readonly accountAttributesV2026: AccountAttributesV2026 -} - -/** - * Request parameters for submitReloadAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiSubmitReloadAccountRequest - */ -export interface AccountsV2026ApiSubmitReloadAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsV2026ApiSubmitReloadAccount - */ - readonly id: string -} - -/** - * Request parameters for unlockAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiUnlockAccountRequest - */ -export interface AccountsV2026ApiUnlockAccountRequest { - /** - * The account ID. - * @type {string} - * @memberof AccountsV2026ApiUnlockAccount - */ - readonly id: string - - /** - * - * @type {AccountUnlockRequestV2026} - * @memberof AccountsV2026ApiUnlockAccount - */ - readonly accountUnlockRequestV2026: AccountUnlockRequestV2026 -} - -/** - * Request parameters for updateAccount operation in AccountsV2026Api. - * @export - * @interface AccountsV2026ApiUpdateAccountRequest - */ -export interface AccountsV2026ApiUpdateAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsV2026ApiUpdateAccount - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AccountsV2026ApiUpdateAccount - */ - readonly requestBody: Array -} - -/** - * AccountsV2026Api - object-oriented interface - * @export - * @class AccountsV2026Api - * @extends {BaseAPI} - */ -export class AccountsV2026Api extends BaseAPI { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsV2026ApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public createAccount(requestParameters: AccountsV2026ApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).createAccount(requestParameters.accountAttributesCreateV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsV2026ApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public deleteAccount(requestParameters: AccountsV2026ApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).deleteAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove account - * @param {AccountsV2026ApiDeleteAccountAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public deleteAccountAsync(requestParameters: AccountsV2026ApiDeleteAccountAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).deleteAccountAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsV2026ApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public disableAccount(requestParameters: AccountsV2026ApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).disableAccount(requestParameters.id, requestParameters.accountToggleRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable IDN account for a single identity. - * @summary Disable idn account for identity - * @param {AccountsV2026ApiDisableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public disableAccountForIdentity(requestParameters: AccountsV2026ApiDisableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).disableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to disable IDN account for each identity provided in the request body. - * @summary Disable idn accounts for identities - * @param {AccountsV2026ApiDisableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public disableAccountsForIdentities(requestParameters: AccountsV2026ApiDisableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).disableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsV2026ApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public enableAccount(requestParameters: AccountsV2026ApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).enableAccount(requestParameters.id, requestParameters.accountToggleRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable IDN account for a single identity. - * @summary Enable idn account for identity - * @param {AccountsV2026ApiEnableAccountForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public enableAccountForIdentity(requestParameters: AccountsV2026ApiEnableAccountForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).enableAccountForIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits tasks to enable IDN account for each identity provided in the request body. - * @summary Enable idn accounts for identities - * @param {AccountsV2026ApiEnableAccountsForIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public enableAccountsForIdentities(requestParameters: AccountsV2026ApiEnableAccountsForIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).enableAccountsForIdentities(requestParameters.identitiesAccountsBulkRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsV2026ApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public getAccount(requestParameters: AccountsV2026ApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).getAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public getAccountEntitlements(requestParameters: AccountsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List accounts. - * @summary Accounts list - * @param {AccountsV2026ApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public listAccounts(requestParameters: AccountsV2026ApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsV2026ApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public putAccount(requestParameters: AccountsV2026ApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).putAccount(requestParameters.id, requestParameters.accountAttributesV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsV2026ApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public submitReloadAccount(requestParameters: AccountsV2026ApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsV2026ApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public unlockAccount(requestParameters: AccountsV2026ApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).unlockAccount(requestParameters.id, requestParameters.accountUnlockRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsV2026ApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsV2026Api - */ - public updateAccount(requestParameters: AccountsV2026ApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsV2026ApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListAccountsDetailLevelV2026 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type ListAccountsDetailLevelV2026 = typeof ListAccountsDetailLevelV2026[keyof typeof ListAccountsDetailLevelV2026]; - - -/** - * ApiUsageV2026Api - axios parameter creator - * @export - */ -export const ApiUsageV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTotalCount: async (xSailPointExperimental?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/api-usage/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listApiSummary: async (xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/api-usage/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApiUsageV2026Api - functional programming interface - * @export - */ -export const ApiUsageV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApiUsageV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTotalCount(xSailPointExperimental?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTotalCount(xSailPointExperimental, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApiUsageV2026Api.getTotalCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listApiSummary(xSailPointExperimental?: string, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listApiSummary(xSailPointExperimental, filters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApiUsageV2026Api.listApiSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApiUsageV2026Api - factory interface - * @export - */ -export const ApiUsageV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApiUsageV2026ApiFp(configuration) - return { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {ApiUsageV2026ApiGetTotalCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTotalCount(requestParameters: ApiUsageV2026ApiGetTotalCountRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTotalCount(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {ApiUsageV2026ApiListApiSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listApiSummary(requestParameters: ApiUsageV2026ApiListApiSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listApiSummary(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTotalCount operation in ApiUsageV2026Api. - * @export - * @interface ApiUsageV2026ApiGetTotalCountRequest - */ -export interface ApiUsageV2026ApiGetTotalCountRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApiUsageV2026ApiGetTotalCount - */ - readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @type {string} - * @memberof ApiUsageV2026ApiGetTotalCount - */ - readonly filters?: string -} - -/** - * Request parameters for listApiSummary operation in ApiUsageV2026Api. - * @export - * @interface ApiUsageV2026ApiListApiSummaryRequest - */ -export interface ApiUsageV2026ApiListApiSummaryRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApiUsageV2026ApiListApiSummary - */ - readonly xSailPointExperimental?: 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: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* - * @type {string} - * @memberof ApiUsageV2026ApiListApiSummary - */ - readonly filters?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof ApiUsageV2026ApiListApiSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof ApiUsageV2026ApiListApiSummary - */ - readonly offset?: number -} - -/** - * ApiUsageV2026Api - object-oriented interface - * @export - * @class ApiUsageV2026Api - * @extends {BaseAPI} - */ -export class ApiUsageV2026Api extends BaseAPI { - /** - * This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Total number of API requests - * @param {ApiUsageV2026ApiGetTotalCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApiUsageV2026Api - */ - public getTotalCount(requestParameters: ApiUsageV2026ApiGetTotalCountRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApiUsageV2026ApiFp(this.configuration).getTotalCount(requestParameters.xSailPointExperimental, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. - * @summary Get Api Summary - * @param {ApiUsageV2026ApiListApiSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApiUsageV2026Api - */ - public listApiSummary(requestParameters: ApiUsageV2026ApiListApiSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApiUsageV2026ApiFp(this.configuration).listApiSummary(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ApplicationDiscoveryV2026Api - axios parameter creator - * @export - */ -export const ApplicationDiscoveryV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2026, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/discovered-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (filter !== undefined) { - localVarQueryParameter['filter'] = filter; - } - - 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, - }; - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/manual-discover-applications-template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'file' is not null or undefined - assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file) - const localVarPath = `/manual-discover-applications`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryRequestV2026} applicationDiscoveryRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startApplicationDiscovery: async (applicationDiscoveryRequestV2026: ApplicationDiscoveryRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'applicationDiscoveryRequestV2026' is not null or undefined - assertParamExists('startApplicationDiscovery', 'applicationDiscoveryRequestV2026', applicationDiscoveryRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/discover-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(applicationDiscoveryRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApplicationDiscoveryV2026Api - functional programming interface - * @export - */ -export const ApplicationDiscoveryV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApplicationDiscoveryV2026ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplications(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV2026, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, detail, filter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2026Api.getDiscoveredApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2026Api.getManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendManualDiscoverApplicationsCsvTemplate(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2026Api.sendManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryRequestV2026} applicationDiscoveryRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startApplicationDiscovery(applicationDiscoveryRequestV2026: ApplicationDiscoveryRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startApplicationDiscovery(applicationDiscoveryRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryV2026Api.startApplicationDiscovery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApplicationDiscoveryV2026Api - factory interface - * @export - */ -export const ApplicationDiscoveryV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApplicationDiscoveryV2026ApiFp(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startApplicationDiscovery(requestParameters: ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startApplicationDiscovery(requestParameters.applicationDiscoveryRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryV2026Api. - * @export - * @interface ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest - */ -export interface ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest { - /** - * 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 ApplicationDiscoveryV2026ApiGetDiscoveredApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApplicationDiscoveryV2026ApiGetDiscoveredApplications - */ - readonly offset?: number - - /** - * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof ApplicationDiscoveryV2026ApiGetDiscoveredApplications - */ - readonly detail?: GetDiscoveredApplicationsDetailV2026 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* - * @type {string} - * @memberof ApplicationDiscoveryV2026ApiGetDiscoveredApplications - */ - readonly filter?: 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: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** - * @type {string} - * @memberof ApplicationDiscoveryV2026ApiGetDiscoveredApplications - */ - readonly sorters?: string -} - -/** - * Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryV2026Api. - * @export - * @interface ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest - */ -export interface ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplate - */ - readonly file: File -} - -/** - * Request parameters for startApplicationDiscovery operation in ApplicationDiscoveryV2026Api. - * @export - * @interface ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest - */ -export interface ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest { - /** - * - * @type {ApplicationDiscoveryRequestV2026} - * @memberof ApplicationDiscoveryV2026ApiStartApplicationDiscovery - */ - readonly applicationDiscoveryRequestV2026: ApplicationDiscoveryRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof ApplicationDiscoveryV2026ApiStartApplicationDiscovery - */ - readonly xSailPointExperimental?: string -} - -/** - * ApplicationDiscoveryV2026Api - object-oriented interface - * @export - * @class ApplicationDiscoveryV2026Api - * @extends {BaseAPI} - */ -export class ApplicationDiscoveryV2026Api extends BaseAPI { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2026Api - */ - public getDiscoveredApplications(requestParameters: ApplicationDiscoveryV2026ApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2026ApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2026Api - */ - public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2026ApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2026Api - */ - public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryV2026ApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2026ApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to discover applications. - * @summary Start Application Discovery - * @param {ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryV2026Api - */ - public startApplicationDiscovery(requestParameters: ApplicationDiscoveryV2026ApiStartApplicationDiscoveryRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryV2026ApiFp(this.configuration).startApplicationDiscovery(requestParameters.applicationDiscoveryRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetDiscoveredApplicationsDetailV2026 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetDiscoveredApplicationsDetailV2026 = typeof GetDiscoveredApplicationsDetailV2026[keyof typeof GetDiscoveredApplicationsDetailV2026]; - - -/** - * ApprovalsV2026Api - axios parameter creator - * @export - */ -export const ApprovalsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. - * @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApproval: async (id: string, approvalApproveRequestV2026?: ApprovalApproveRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApproval', 'id', id) - const localVarPath = `/generic-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalApproveRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {BulkApproveRequestDTOV2026} bulkApproveRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalInBulk: async (bulkApproveRequestDTOV2026: BulkApproveRequestDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveRequestDTOV2026' is not null or undefined - assertParamExists('approveApprovalInBulk', 'bulkApproveRequestDTOV2026', bulkApproveRequestDTOV2026) - const localVarPath = `/generic-approvals/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveRequestDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApproval: async (bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkCancelRequestDTOV2026' is not null or undefined - assertParamExists('cancelApproval', 'bulkCancelRequestDTOV2026', bulkCancelRequestDTOV2026) - const localVarPath = `/generic-approvals/bulk-cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkCancelRequestDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel - * @summary Post Approval Cancel - * @param {string} id ID of the approval request to cancel. - * @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApprovalById: async (id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelApprovalById', 'id', id) - const localVarPath = `/generic-approvals/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalCancelRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApprovalConfigRequest: async (id: string, scope: DeleteApprovalConfigRequestScopeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteApprovalConfigRequest', 'id', id) - // verify required parameter 'scope' is not null or undefined - assertParamExists('deleteApprovalConfigRequest', 'scope', scope) - const localVarPath = `/generic-approvals/config/{id}/{scope}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApproval', 'id', id) - const localVarPath = `/generic-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. - * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. - * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. - * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals: async (mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/generic-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (mine !== undefined) { - localVarQueryParameter['mine'] = mine; - } - - if (requesterId !== undefined) { - localVarQueryParameter['requesterId'] = requesterId; - } - - if (requesteeId !== undefined) { - localVarQueryParameter['requesteeId'] = requesteeId; - } - - if (approverId !== undefined) { - localVarQueryParameter['approverId'] = approverId; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (includeComments !== undefined) { - localVarQueryParameter['include-comments'] = includeComments; - } - - if (includeApprovers !== undefined) { - localVarQueryParameter['include-approvers'] = includeApprovers; - } - - if (includeReassignmentHistory !== undefined) { - localVarQueryParameter['include-reassignment-history'] = includeReassignmentHistory; - } - - if (includeBatchInfo !== undefined) { - localVarQueryParameter['include-batch-info'] = includeBatchInfo; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovalsConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApprovalsConfig', 'id', id) - const localVarPath = `/generic-approvals/config/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {BulkReassignRequestDTOV2026} bulkReassignRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - moveApproval: async (bulkReassignRequestDTOV2026: BulkReassignRequestDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkReassignRequestDTOV2026' is not null or undefined - assertParamExists('moveApproval', 'bulkReassignRequestDTOV2026', bulkReassignRequestDTOV2026) - const localVarPath = `/generic-approvals/bulk-reassign`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkReassignRequestDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {ApprovalConfigV2026} approvalConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApprovalsConfig: async (id: string, scope: PutApprovalsConfigScopeV2026, approvalConfigV2026: ApprovalConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putApprovalsConfig', 'id', id) - // verify required parameter 'scope' is not null or undefined - assertParamExists('putApprovalsConfig', 'scope', scope) - // verify required parameter 'approvalConfigV2026' is not null or undefined - assertParamExists('putApprovalsConfig', 'approvalConfigV2026', approvalConfigV2026) - const localVarPath = `/generic-approvals/config/{id}/{scope}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"scope"}}`, encodeURIComponent(String(scope))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. - * @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApproval: async (id: string, approvalRejectRequestV2026?: ApprovalRejectRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApproval', 'id', id) - const localVarPath = `/generic-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalRejectRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {BulkRejectRequestDTOV2026} bulkRejectRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalInBulk: async (bulkRejectRequestDTOV2026: BulkRejectRequestDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRejectRequestDTOV2026' is not null or undefined - assertParamExists('rejectApprovalInBulk', 'bulkRejectRequestDTOV2026', bulkRejectRequestDTOV2026) - const localVarPath = `/generic-approvals/bulk-reject`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRejectRequestDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsAttributes: async (id: string, approvalAttributesRequestV2026: ApprovalAttributesRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsAttributes', 'id', id) - // verify required parameter 'approvalAttributesRequestV2026' is not null or undefined - assertParamExists('updateApprovalsAttributes', 'approvalAttributesRequestV2026', approvalAttributesRequestV2026) - const localVarPath = `/generic-approvals/{id}/attributes` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalAttributesRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsComments: async (id: string, approvalCommentsRequestV2026: ApprovalCommentsRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsComments', 'id', id) - // verify required parameter 'approvalCommentsRequestV2026' is not null or undefined - assertParamExists('updateApprovalsComments', 'approvalCommentsRequestV2026', approvalCommentsRequestV2026) - const localVarPath = `/generic-approvals/{id}/comments` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalCommentsRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. - * @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsReassign: async (id: string, approvalReassignRequestV2026: ApprovalReassignRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateApprovalsReassign', 'id', id) - // verify required parameter 'approvalReassignRequestV2026' is not null or undefined - assertParamExists('updateApprovalsReassign', 'approvalReassignRequestV2026', approvalReassignRequestV2026) - const localVarPath = `/generic-approvals/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(approvalReassignRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApprovalsV2026Api - functional programming interface - * @export - */ -export const ApprovalsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApprovalsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to approve. - * @param {ApprovalApproveRequestV2026} [approvalApproveRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApproval(id: string, approvalApproveRequestV2026?: ApprovalApproveRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApproval(id, approvalApproveRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.approveApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {BulkApproveRequestDTOV2026} bulkApproveRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalInBulk(bulkApproveRequestDTOV2026: BulkApproveRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalInBulk(bulkApproveRequestDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.approveApprovalInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {BulkCancelRequestDTOV2026} bulkCancelRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelApproval(bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApproval(bulkCancelRequestDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.cancelApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel - * @summary Post Approval Cancel - * @param {string} id ID of the approval request to cancel. - * @param {ApprovalCancelRequestV2026} [approvalCancelRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelApprovalById(id: string, approvalCancelRequestV2026?: ApprovalCancelRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelApprovalById(id, approvalCancelRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.cancelApprovalById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {DeleteApprovalConfigRequestScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteApprovalConfigRequest(id: string, scope: DeleteApprovalConfigRequestScopeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApprovalConfigRequest(id, scope, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.deleteApprovalConfigRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {string} id ID of the approval that is to be returned - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApproval(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApproval(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.getApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {boolean} [mine] Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @param {string} [requesterId] Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [requesteeId] Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {string} [approverId] Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @param {boolean} [count] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @param {boolean} [countOnly] Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @param {boolean} [includeComments] If set to true in the query, the approval requests returned will include comments. - * @param {boolean} [includeApprovers] If set to true in the query, the approval requests returned will include approvers. - * @param {boolean} [includeReassignmentHistory] If set to true in the query, the approval requests returned will include reassignment history. - * @param {boolean} [includeBatchInfo] If set to true in the query, the approval requests returned will include batch 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApprovals(mine?: boolean, requesterId?: string, requesteeId?: string, approverId?: string, count?: boolean, countOnly?: boolean, includeComments?: boolean, includeApprovers?: boolean, includeReassignmentHistory?: boolean, includeBatchInfo?: boolean, filters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovals(mine, requesterId, requesteeId, approverId, count, countOnly, includeComments, includeApprovers, includeReassignmentHistory, includeBatchInfo, filters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.getApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {string} id The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApprovalsConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApprovalsConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.getApprovalsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {BulkReassignRequestDTOV2026} bulkReassignRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async moveApproval(bulkReassignRequestDTOV2026: BulkReassignRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.moveApproval(bulkReassignRequestDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.moveApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {string} id The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {PutApprovalsConfigScopeV2026} scope The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @param {ApprovalConfigV2026} approvalConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putApprovalsConfig(id: string, scope: PutApprovalsConfigScopeV2026, approvalConfigV2026: ApprovalConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putApprovalsConfig(id, scope, approvalConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.putApprovalsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reject. - * @param {ApprovalRejectRequestV2026} [approvalRejectRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApproval(id: string, approvalRejectRequestV2026?: ApprovalRejectRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApproval(id, approvalRejectRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.rejectApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {BulkRejectRequestDTOV2026} bulkRejectRequestDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalInBulk(bulkRejectRequestDTOV2026: BulkRejectRequestDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalInBulk(bulkRejectRequestDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.rejectApprovalInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @param {ApprovalAttributesRequestV2026} approvalAttributesRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsAttributes(id: string, approvalAttributesRequestV2026: ApprovalAttributesRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsAttributes(id, approvalAttributesRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.updateApprovalsAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @param {ApprovalCommentsRequestV2026} approvalCommentsRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsComments(id: string, approvalCommentsRequestV2026: ApprovalCommentsRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsComments(id, approvalCommentsRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.updateApprovalsComments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {string} id Approval ID that correlates to an existing approval request that a user wants to reassign. - * @param {ApprovalReassignRequestV2026} approvalReassignRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateApprovalsReassign(id: string, approvalReassignRequestV2026: ApprovalReassignRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateApprovalsReassign(id, approvalReassignRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApprovalsV2026Api.updateApprovalsReassign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApprovalsV2026Api - factory interface - * @export - */ -export const ApprovalsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApprovalsV2026ApiFp(configuration) - return { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApproval(requestParameters: ApprovalsV2026ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApproval(requestParameters.id, requestParameters.approvalApproveRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {ApprovalsV2026ApiApproveApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalInBulk(requestParameters: ApprovalsV2026ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApproval(requestParameters: ApprovalsV2026ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelApproval(requestParameters.bulkCancelRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel - * @summary Post Approval Cancel - * @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelApprovalById(requestParameters.id, requestParameters.approvalCancelRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {ApprovalsV2026ApiDeleteApprovalConfigRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApprovalConfigRequest(requestParameters: ApprovalsV2026ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApproval(requestParameters: ApprovalsV2026ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApproval(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovals(requestParameters: ApprovalsV2026ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {ApprovalsV2026ApiGetApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApprovalsConfig(requestParameters: ApprovalsV2026ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApprovalsConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {ApprovalsV2026ApiMoveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - moveApproval(requestParameters: ApprovalsV2026ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.moveApproval(requestParameters.bulkReassignRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {ApprovalsV2026ApiPutApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApprovalsConfig(requestParameters: ApprovalsV2026ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApproval(requestParameters: ApprovalsV2026ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApproval(requestParameters.id, requestParameters.approvalRejectRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {ApprovalsV2026ApiRejectApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalInBulk(requestParameters: ApprovalsV2026ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsAttributes(requestParameters: ApprovalsV2026ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsComments(requestParameters: ApprovalsV2026ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateApprovalsReassign(requestParameters: ApprovalsV2026ApiUpdateApprovalsReassignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateApprovalsReassign(requestParameters.id, requestParameters.approvalReassignRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApproval operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiApproveApprovalRequest - */ -export interface ApprovalsV2026ApiApproveApprovalRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to approve. - * @type {string} - * @memberof ApprovalsV2026ApiApproveApproval - */ - readonly id: string - - /** - * - * @type {ApprovalApproveRequestV2026} - * @memberof ApprovalsV2026ApiApproveApproval - */ - readonly approvalApproveRequestV2026?: ApprovalApproveRequestV2026 -} - -/** - * Request parameters for approveApprovalInBulk operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiApproveApprovalInBulkRequest - */ -export interface ApprovalsV2026ApiApproveApprovalInBulkRequest { - /** - * - * @type {BulkApproveRequestDTOV2026} - * @memberof ApprovalsV2026ApiApproveApprovalInBulk - */ - readonly bulkApproveRequestDTOV2026: BulkApproveRequestDTOV2026 -} - -/** - * Request parameters for cancelApproval operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiCancelApprovalRequest - */ -export interface ApprovalsV2026ApiCancelApprovalRequest { - /** - * - * @type {BulkCancelRequestDTOV2026} - * @memberof ApprovalsV2026ApiCancelApproval - */ - readonly bulkCancelRequestDTOV2026: BulkCancelRequestDTOV2026 -} - -/** - * Request parameters for cancelApprovalById operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiCancelApprovalByIdRequest - */ -export interface ApprovalsV2026ApiCancelApprovalByIdRequest { - /** - * ID of the approval request to cancel. - * @type {string} - * @memberof ApprovalsV2026ApiCancelApprovalById - */ - readonly id: string - - /** - * - * @type {ApprovalCancelRequestV2026} - * @memberof ApprovalsV2026ApiCancelApprovalById - */ - readonly approvalCancelRequestV2026?: ApprovalCancelRequestV2026 -} - -/** - * Request parameters for deleteApprovalConfigRequest operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiDeleteApprovalConfigRequestRequest - */ -export interface ApprovalsV2026ApiDeleteApprovalConfigRequestRequest { - /** - * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {string} - * @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest - */ - readonly id: string - - /** - * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} - * @memberof ApprovalsV2026ApiDeleteApprovalConfigRequest - */ - readonly scope: DeleteApprovalConfigRequestScopeV2026 -} - -/** - * Request parameters for getApproval operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiGetApprovalRequest - */ -export interface ApprovalsV2026ApiGetApprovalRequest { - /** - * ID of the approval that is to be returned - * @type {string} - * @memberof ApprovalsV2026ApiGetApproval - */ - readonly id: string -} - -/** - * Request parameters for getApprovals operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiGetApprovalsRequest - */ -export interface ApprovalsV2026ApiGetApprovalsRequest { - /** - * Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly mine?: boolean - - /** - * Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly requesterId?: string - - /** - * Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly requesteeId?: string - - /** - * Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. - * @type {string} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly approverId?: string - - /** - * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly count?: boolean - - /** - * Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly countOnly?: boolean - - /** - * If set to true in the query, the approval requests returned will include comments. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly includeComments?: boolean - - /** - * If set to true in the query, the approval requests returned will include approvers. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly includeApprovers?: boolean - - /** - * If set to true in the query, the approval requests returned will include reassignment history. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly includeReassignmentHistory?: boolean - - /** - * If set to true in the query, the approval requests returned will include batch information. - * @type {boolean} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly includeBatchInfo?: 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: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* - * @type {string} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApprovalsV2026ApiGetApprovals - */ - readonly offset?: number -} - -/** - * Request parameters for getApprovalsConfig operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiGetApprovalsConfigRequest - */ -export interface ApprovalsV2026ApiGetApprovalsConfigRequest { - /** - * The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] - * @type {string} - * @memberof ApprovalsV2026ApiGetApprovalsConfig - */ - readonly id: string -} - -/** - * Request parameters for moveApproval operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiMoveApprovalRequest - */ -export interface ApprovalsV2026ApiMoveApprovalRequest { - /** - * - * @type {BulkReassignRequestDTOV2026} - * @memberof ApprovalsV2026ApiMoveApproval - */ - readonly bulkReassignRequestDTOV2026: BulkReassignRequestDTOV2026 -} - -/** - * Request parameters for putApprovalsConfig operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiPutApprovalsConfigRequest - */ -export interface ApprovalsV2026ApiPutApprovalsConfigRequest { - /** - * The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {string} - * @memberof ApprovalsV2026ApiPutApprovalsConfig - */ - readonly id: string - - /** - * The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT - * @type {'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'} - * @memberof ApprovalsV2026ApiPutApprovalsConfig - */ - readonly scope: PutApprovalsConfigScopeV2026 - - /** - * - * @type {ApprovalConfigV2026} - * @memberof ApprovalsV2026ApiPutApprovalsConfig - */ - readonly approvalConfigV2026: ApprovalConfigV2026 -} - -/** - * Request parameters for rejectApproval operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiRejectApprovalRequest - */ -export interface ApprovalsV2026ApiRejectApprovalRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to reject. - * @type {string} - * @memberof ApprovalsV2026ApiRejectApproval - */ - readonly id: string - - /** - * - * @type {ApprovalRejectRequestV2026} - * @memberof ApprovalsV2026ApiRejectApproval - */ - readonly approvalRejectRequestV2026?: ApprovalRejectRequestV2026 -} - -/** - * Request parameters for rejectApprovalInBulk operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiRejectApprovalInBulkRequest - */ -export interface ApprovalsV2026ApiRejectApprovalInBulkRequest { - /** - * - * @type {BulkRejectRequestDTOV2026} - * @memberof ApprovalsV2026ApiRejectApprovalInBulk - */ - readonly bulkRejectRequestDTOV2026: BulkRejectRequestDTOV2026 -} - -/** - * Request parameters for updateApprovalsAttributes operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiUpdateApprovalsAttributesRequest - */ -export interface ApprovalsV2026ApiUpdateApprovalsAttributesRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to change the attributes of. - * @type {string} - * @memberof ApprovalsV2026ApiUpdateApprovalsAttributes - */ - readonly id: string - - /** - * - * @type {ApprovalAttributesRequestV2026} - * @memberof ApprovalsV2026ApiUpdateApprovalsAttributes - */ - readonly approvalAttributesRequestV2026: ApprovalAttributesRequestV2026 -} - -/** - * Request parameters for updateApprovalsComments operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiUpdateApprovalsCommentsRequest - */ -export interface ApprovalsV2026ApiUpdateApprovalsCommentsRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to add a comment to. - * @type {string} - * @memberof ApprovalsV2026ApiUpdateApprovalsComments - */ - readonly id: string - - /** - * - * @type {ApprovalCommentsRequestV2026} - * @memberof ApprovalsV2026ApiUpdateApprovalsComments - */ - readonly approvalCommentsRequestV2026: ApprovalCommentsRequestV2026 -} - -/** - * Request parameters for updateApprovalsReassign operation in ApprovalsV2026Api. - * @export - * @interface ApprovalsV2026ApiUpdateApprovalsReassignRequest - */ -export interface ApprovalsV2026ApiUpdateApprovalsReassignRequest { - /** - * Approval ID that correlates to an existing approval request that a user wants to reassign. - * @type {string} - * @memberof ApprovalsV2026ApiUpdateApprovalsReassign - */ - readonly id: string - - /** - * - * @type {ApprovalReassignRequestV2026} - * @memberof ApprovalsV2026ApiUpdateApprovalsReassign - */ - readonly approvalReassignRequestV2026: ApprovalReassignRequestV2026 -} - -/** - * ApprovalsV2026Api - object-oriented interface - * @export - * @class ApprovalsV2026Api - * @extends {BaseAPI} - */ -export class ApprovalsV2026Api extends BaseAPI { - /** - * Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. - * @summary Post Approvals Approve - * @param {ApprovalsV2026ApiApproveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public approveApproval(requestParameters: ApprovalsV2026ApiApproveApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).approveApproval(requestParameters.id, requestParameters.approvalApproveRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk Approves specified approval requests on behalf of the caller - * @summary Post Bulk Approve Approvals - * @param {ApprovalsV2026ApiApproveApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public approveApprovalInBulk(requestParameters: ApprovalsV2026ApiApproveApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).approveApprovalInBulk(requestParameters.bulkApproveRequestDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk cancels specified approval requests on behalf of the caller. Note: To bulk cancel access request approvals, please use the following: /access-requests/bulk-cancel - * @summary Post Bulk Cancel Approvals - * @param {ApprovalsV2026ApiCancelApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public cancelApproval(requestParameters: ApprovalsV2026ApiCancelApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).cancelApproval(requestParameters.bulkCancelRequestDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Cancels a specified approval requests on behalf of the caller. Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: /access-requests/cancel - * @summary Post Approval Cancel - * @param {ApprovalsV2026ApiCancelApprovalByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public cancelApprovalById(requestParameters: ApprovalsV2026ApiCancelApprovalByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).cancelApprovalById(requestParameters.id, requestParameters.approvalCancelRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an approval configuration. Configurations at the APPROVAL_REQUEST scope cannot be deleted. - * @summary Delete Approval Configuration - * @param {ApprovalsV2026ApiDeleteApprovalConfigRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public deleteApprovalConfigRequest(requestParameters: ApprovalsV2026ApiDeleteApprovalConfigRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).deleteApprovalConfigRequest(requestParameters.id, requestParameters.scope, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches an approval request by it\'s approval ID. For lookups by access request ID please use the following: /generic-approvals?filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\" - * @summary Get an approval - * @param {ApprovalsV2026ApiGetApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public getApproval(requestParameters: ApprovalsV2026ApiGetApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).getApproval(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of approvals. One of the following query parameters should be present: \'mine\', \'approverId\', \'requesterId\', \'requesteeId\'. The absence of all query parameters for non admins will default to mine=true (which is the equivalent of \'approverId=[your_identity_id]\') while admins will default to mine=false (which will show all approvals in the org). For lookups by access request ID please use the following: \'/generic-approvals?mine=false&filters=referenceType+eq+\"accessRequestId\"+and+referenceId+eq+\"12345678901234567890123456789012\"\' - * @summary Get approvals - * @param {ApprovalsV2026ApiGetApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public getApprovals(requestParameters: ApprovalsV2026ApiGetApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).getApprovals(requestParameters.mine, requestParameters.requesterId, requestParameters.requesteeId, requestParameters.approverId, requestParameters.count, requestParameters.countOnly, requestParameters.includeComments, requestParameters.includeApprovers, requestParameters.includeReassignmentHistory, requestParameters.includeBatchInfo, requestParameters.filters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a singular approval configuration that matches the given ID - * @summary Get Approval Config - * @param {ApprovalsV2026ApiGetApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public getApprovalsConfig(requestParameters: ApprovalsV2026ApiGetApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).getApprovalsConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk reassigns specified approval requests on behalf of the caller - * @summary Post Bulk Reassign Approvals - * @param {ApprovalsV2026ApiMoveApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public moveApproval(requestParameters: ApprovalsV2026ApiMoveApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).moveApproval(requestParameters.bulkReassignRequestDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Upserts a singular approval configuration that matches the given configID and configScope. For example to update the approval configurations for all Access Request Approvals please use: \'/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE\' - * @summary Put Approval Config - * @param {ApprovalsV2026ApiPutApprovalsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public putApprovalsConfig(requestParameters: ApprovalsV2026ApiPutApprovalsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).putApprovalsConfig(requestParameters.id, requestParameters.scope, requestParameters.approvalConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. - * @summary Post Approvals Reject - * @param {ApprovalsV2026ApiRejectApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public rejectApproval(requestParameters: ApprovalsV2026ApiRejectApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).rejectApproval(requestParameters.id, requestParameters.approvalRejectRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Bulk reject specified approval requests on behalf of the caller - * @summary Post Bulk Reject Approvals - * @param {ApprovalsV2026ApiRejectApprovalInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public rejectApprovalInBulk(requestParameters: ApprovalsV2026ApiRejectApprovalInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).rejectApprovalInBulk(requestParameters.bulkRejectRequestDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Attributes - * @param {ApprovalsV2026ApiUpdateApprovalsAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public updateApprovalsAttributes(requestParameters: ApprovalsV2026ApiUpdateApprovalsAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).updateApprovalsAttributes(requestParameters.id, requestParameters.approvalAttributesRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Adds comments to a specified approval request. This endpoint does not support access request IDs. - * @summary Post Approvals Comments - * @param {ApprovalsV2026ApiUpdateApprovalsCommentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public updateApprovalsComments(requestParameters: ApprovalsV2026ApiUpdateApprovalsCommentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).updateApprovalsComments(requestParameters.id, requestParameters.approvalCommentsRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. - * @summary Post Approvals Reassign - * @param {ApprovalsV2026ApiUpdateApprovalsReassignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApprovalsV2026Api - */ - public updateApprovalsReassign(requestParameters: ApprovalsV2026ApiUpdateApprovalsReassignRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApprovalsV2026ApiFp(this.configuration).updateApprovalsReassign(requestParameters.id, requestParameters.approvalReassignRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteApprovalConfigRequestScopeV2026 = { - DomainObject: 'DOMAIN_OBJECT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - ApprovalType: 'APPROVAL_TYPE', - Tenant: 'TENANT' -} as const; -export type DeleteApprovalConfigRequestScopeV2026 = typeof DeleteApprovalConfigRequestScopeV2026[keyof typeof DeleteApprovalConfigRequestScopeV2026]; -/** - * @export - */ -export const PutApprovalsConfigScopeV2026 = { - DomainObject: 'DOMAIN_OBJECT', - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - ApprovalType: 'APPROVAL_TYPE', - Tenant: 'TENANT' -} as const; -export type PutApprovalsConfigScopeV2026 = typeof PutApprovalsConfigScopeV2026[keyof typeof PutApprovalsConfigScopeV2026]; - - -/** - * AppsV2026Api - axios parameter creator - * @export - */ -export const AppsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2026} sourceAppCreateDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp: async (sourceAppCreateDtoV2026: SourceAppCreateDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceAppCreateDtoV2026' is not null or undefined - assertParamExists('createSourceApp', 'sourceAppCreateDtoV2026', sourceAppCreateDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppCreateDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk: async (id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteAccessProfilesFromSourceAppByBulk', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles/bulk-remove` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp: async (id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAccessProfilesForSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{id}/access-profiles` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps: async (filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listAllUserApps', 'filters', filters) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/all`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/assigned`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp: async (id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listAvailableAccountsForUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{id}/available-accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps: async (limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps: async (limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2026?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSourceApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp: async (id: string, xSailPointExperimental?: string, jsonPatchOperationV2026?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchUserApp', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/user-apps/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2026} [sourceAppBulkUpdateRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk: async (xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2026?: SourceAppBulkUpdateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-apps/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceAppBulkUpdateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AppsV2026Api - functional programming interface - * @export - */ -export const AppsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AppsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {SourceAppCreateDtoV2026} sourceAppCreateDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceApp(sourceAppCreateDtoV2026: SourceAppCreateDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceApp(sourceAppCreateDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.createSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {string} id ID of the source app - * @param {Array} requestBody - * @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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesFromSourceAppByBulk(id: string, requestBody: Array, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesFromSourceAppByBulk(id, requestBody, limit, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.deleteAccessProfilesFromSourceAppByBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {string} id source app ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.deleteSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {string} id ID of the source app - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceApp(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceApp(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.getSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {string} id ID of the source app - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfilesForSourceApp(id: string, limit?: number, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfilesForSourceApp(id, limit, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAccessProfilesForSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAllSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @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 {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 {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllUserApps(filters: string, limit?: number, count?: boolean, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllUserApps(filters, limit, count, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAllUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @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 {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 {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, name, created, modified, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAssignedSourceApp(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignedSourceApp(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAssignedSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {string} id ID of the user app - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableAccountsForUserApp(id: string, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableAccountsForUserApp(id, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAvailableAccountsForUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @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 {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 {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, name, created, modified, owner.id, accountSource.id** - * @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, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAvailableSourceApps(limit?: number, count?: boolean, offset?: number, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableSourceApps(limit, count, offset, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listAvailableSourceApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @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 {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 {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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOwnedUserApps(limit?: number, count?: boolean, offset?: number, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnedUserApps(limit, count, offset, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.listOwnedUserApps']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {string} id ID of the source app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSourceApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2026?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSourceApp(id, xSailPointExperimental, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.patchSourceApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {string} id ID of the user app to patch - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchUserApp(id: string, xSailPointExperimental?: string, jsonPatchOperationV2026?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchUserApp(id, xSailPointExperimental, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.patchUserApp']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {SourceAppBulkUpdateRequestV2026} [sourceAppBulkUpdateRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceAppsInBulk(xSailPointExperimental?: string, sourceAppBulkUpdateRequestV2026?: SourceAppBulkUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceAppsInBulk(xSailPointExperimental, sourceAppBulkUpdateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AppsV2026Api.updateSourceAppsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AppsV2026Api - factory interface - * @export - */ -export const AppsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AppsV2026ApiFp(configuration) - return { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2026ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceApp(requestParameters: AppsV2026ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceApp(requestParameters.sourceAppCreateDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2026ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceApp(requestParameters: AppsV2026ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2026ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceApp(requestParameters: AppsV2026ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2026ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfilesForSourceApp(requestParameters: AppsV2026ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2026ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllSourceApp(requestParameters: AppsV2026ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2026ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllUserApps(requestParameters: AppsV2026ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2026ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAssignedSourceApp(requestParameters: AppsV2026ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2026ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableAccountsForUserApp(requestParameters: AppsV2026ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2026ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAvailableSourceApps(requestParameters: AppsV2026ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2026ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOwnedUserApps(requestParameters: AppsV2026ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2026ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSourceApp(requestParameters: AppsV2026ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2026ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchUserApp(requestParameters: AppsV2026ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2026ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceAppsInBulk(requestParameters: AppsV2026ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiCreateSourceAppRequest - */ -export interface AppsV2026ApiCreateSourceAppRequest { - /** - * - * @type {SourceAppCreateDtoV2026} - * @memberof AppsV2026ApiCreateSourceApp - */ - readonly sourceAppCreateDtoV2026: SourceAppCreateDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiCreateSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteAccessProfilesFromSourceAppByBulk operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest - */ -export interface AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly requestBody: Array - - /** - * 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 AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly limit?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiDeleteSourceAppRequest - */ -export interface AppsV2026ApiDeleteSourceAppRequest { - /** - * source app ID. - * @type {string} - * @memberof AppsV2026ApiDeleteSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiDeleteSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiGetSourceAppRequest - */ -export interface AppsV2026ApiGetSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2026ApiGetSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiGetSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAccessProfilesForSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAccessProfilesForSourceAppRequest - */ -export interface AppsV2026ApiListAccessProfilesForSourceAppRequest { - /** - * ID of the source app - * @type {string} - * @memberof AppsV2026ApiListAccessProfilesForSourceApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2026ApiListAccessProfilesForSourceApp - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2026ApiListAccessProfilesForSourceApp - */ - readonly offset?: number - - /** - * 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, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - * @type {string} - * @memberof AppsV2026ApiListAccessProfilesForSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAccessProfilesForSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAllSourceAppRequest - */ -export interface AppsV2026ApiListAllSourceAppRequest { - /** - * 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 AppsV2026ApiListAllSourceApp - */ - 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 AppsV2026ApiListAllSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2026ApiListAllSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2026ApiListAllSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* - * @type {string} - * @memberof AppsV2026ApiListAllSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAllSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllUserApps operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAllUserAppsRequest - */ -export interface AppsV2026ApiListAllUserAppsRequest { - /** - * 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2026ApiListAllUserApps - */ - readonly filters: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2026ApiListAllUserApps - */ - 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 AppsV2026ApiListAllUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2026ApiListAllUserApps - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAllUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAssignedSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAssignedSourceAppRequest - */ -export interface AppsV2026ApiListAssignedSourceAppRequest { - /** - * 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 AppsV2026ApiListAssignedSourceApp - */ - 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 AppsV2026ApiListAssignedSourceApp - */ - readonly count?: boolean - - /** - * 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 AppsV2026ApiListAssignedSourceApp - */ - readonly offset?: number - - /** - * 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, name, created, modified, accountSource.id** - * @type {string} - * @memberof AppsV2026ApiListAssignedSourceApp - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2026ApiListAssignedSourceApp - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAssignedSourceApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableAccountsForUserApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAvailableAccountsForUserAppRequest - */ -export interface AppsV2026ApiListAvailableAccountsForUserAppRequest { - /** - * ID of the user app - * @type {string} - * @memberof AppsV2026ApiListAvailableAccountsForUserApp - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AppsV2026ApiListAvailableAccountsForUserApp - */ - 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 AppsV2026ApiListAvailableAccountsForUserApp - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAvailableAccountsForUserApp - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAvailableSourceApps operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListAvailableSourceAppsRequest - */ -export interface AppsV2026ApiListAvailableSourceAppsRequest { - /** - * 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 AppsV2026ApiListAvailableSourceApps - */ - 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 AppsV2026ApiListAvailableSourceApps - */ - readonly count?: boolean - - /** - * 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 AppsV2026ApiListAvailableSourceApps - */ - readonly offset?: number - - /** - * 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, name, created, modified, owner.id, accountSource.id** - * @type {string} - * @memberof AppsV2026ApiListAvailableSourceApps - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - * @type {string} - * @memberof AppsV2026ApiListAvailableSourceApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListAvailableSourceApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOwnedUserApps operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiListOwnedUserAppsRequest - */ -export interface AppsV2026ApiListOwnedUserAppsRequest { - /** - * 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 AppsV2026ApiListOwnedUserApps - */ - 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 AppsV2026ApiListOwnedUserApps - */ - readonly count?: boolean - - /** - * 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 AppsV2026ApiListOwnedUserApps - */ - readonly offset?: number - - /** - * 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* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - * @type {string} - * @memberof AppsV2026ApiListOwnedUserApps - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiListOwnedUserApps - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSourceApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiPatchSourceAppRequest - */ -export interface AppsV2026ApiPatchSourceAppRequest { - /** - * ID of the source app to patch - * @type {string} - * @memberof AppsV2026ApiPatchSourceApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiPatchSourceApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2026ApiPatchSourceApp - */ - readonly jsonPatchOperationV2026?: Array -} - -/** - * Request parameters for patchUserApp operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiPatchUserAppRequest - */ -export interface AppsV2026ApiPatchUserAppRequest { - /** - * ID of the user app to patch - * @type {string} - * @memberof AppsV2026ApiPatchUserApp - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiPatchUserApp - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {Array} - * @memberof AppsV2026ApiPatchUserApp - */ - readonly jsonPatchOperationV2026?: Array -} - -/** - * Request parameters for updateSourceAppsInBulk operation in AppsV2026Api. - * @export - * @interface AppsV2026ApiUpdateSourceAppsInBulkRequest - */ -export interface AppsV2026ApiUpdateSourceAppsInBulkRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AppsV2026ApiUpdateSourceAppsInBulk - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {SourceAppBulkUpdateRequestV2026} - * @memberof AppsV2026ApiUpdateSourceAppsInBulk - */ - readonly sourceAppBulkUpdateRequestV2026?: SourceAppBulkUpdateRequestV2026 -} - -/** - * AppsV2026Api - object-oriented interface - * @export - * @class AppsV2026Api - * @extends {BaseAPI} - */ -export class AppsV2026Api extends BaseAPI { - /** - * This endpoint creates a source app using the given source app payload - * @summary Create source app - * @param {AppsV2026ApiCreateSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public createSourceApp(requestParameters: AppsV2026ApiCreateSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).createSourceApp(requestParameters.sourceAppCreateDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the final list of access profiles for the specified source app after removing - * @summary Bulk remove access profiles from the specified source app - * @param {AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public deleteAccessProfilesFromSourceAppByBulk(requestParameters: AppsV2026ApiDeleteAccessProfilesFromSourceAppByBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).deleteAccessProfilesFromSourceAppByBulk(requestParameters.id, requestParameters.requestBody, requestParameters.limit, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source app - * @summary Delete source app by id - * @param {AppsV2026ApiDeleteSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public deleteSourceApp(requestParameters: AppsV2026ApiDeleteSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).deleteSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a source app by its ID. - * @summary Get source app by id - * @param {AppsV2026ApiGetSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public getSourceApp(requestParameters: AppsV2026ApiGetSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).getSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of access profiles for the specified source app - * @summary List access profiles for the specified source app - * @param {AppsV2026ApiListAccessProfilesForSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAccessProfilesForSourceApp(requestParameters: AppsV2026ApiListAccessProfilesForSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAccessProfilesForSourceApp(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all source apps for the org. - * @summary List all source apps - * @param {AppsV2026ApiListAllSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAllSourceApp(requestParameters: AppsV2026ApiListAllSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAllSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. - * @summary List all user apps - * @param {AppsV2026ApiListAllUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAllUserApps(requestParameters: AppsV2026ApiListAllUserAppsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAllUserApps(requestParameters.filters, requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps assigned for logged in user. - * @summary List assigned source apps - * @param {AppsV2026ApiListAssignedSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAssignedSourceApp(requestParameters: AppsV2026ApiListAssignedSourceAppRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAssignedSourceApp(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - * @summary List available accounts for user app - * @param {AppsV2026ApiListAvailableAccountsForUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAvailableAccountsForUserApp(requestParameters: AppsV2026ApiListAvailableAccountsForUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAvailableAccountsForUserApp(requestParameters.id, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of source apps available for access request. - * @summary List available source apps - * @param {AppsV2026ApiListAvailableSourceAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listAvailableSourceApps(requestParameters: AppsV2026ApiListAvailableSourceAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listAvailableSourceApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of user apps assigned to logged in user - * @summary List owned user apps - * @param {AppsV2026ApiListOwnedUserAppsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public listOwnedUserApps(requestParameters: AppsV2026ApiListOwnedUserAppsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).listOwnedUserApps(requestParameters.limit, requestParameters.count, requestParameters.offset, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Patch source app by id - * @param {AppsV2026ApiPatchSourceAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public patchSourceApp(requestParameters: AppsV2026ApiPatchSourceAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).patchSourceApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** - * @summary Patch user app by id - * @param {AppsV2026ApiPatchUserAppRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public patchUserApp(requestParameters: AppsV2026ApiPatchUserAppRequest, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).patchUserApp(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. Name, description and owner can\'t be empty or null. - * @summary Bulk update source apps - * @param {AppsV2026ApiUpdateSourceAppsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AppsV2026Api - */ - public updateSourceAppsInBulk(requestParameters: AppsV2026ApiUpdateSourceAppsInBulkRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AppsV2026ApiFp(this.configuration).updateSourceAppsInBulk(requestParameters.xSailPointExperimental, requestParameters.sourceAppBulkUpdateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthProfileV2026Api - axios parameter creator - * @export - */ -export const AuthProfileV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getProfileConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig: async (id: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchProfileConfig', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchProfileConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/auth-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthProfileV2026Api - functional programming interface - * @export - */ -export const AuthProfileV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthProfileV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2026Api.getProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProfileConfigList(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileConfigList(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2026Api.getProfileConfigList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {string} id ID of the Auth Profile to patch. - * @param {Array} jsonPatchOperationV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchProfileConfig(id: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchProfileConfig(id, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthProfileV2026Api.patchProfileConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthProfileV2026Api - factory interface - * @export - */ -export const AuthProfileV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthProfileV2026ApiFp(configuration) - return { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2026ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfig(requestParameters: AuthProfileV2026ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2026ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProfileConfigList(requestParameters: AuthProfileV2026ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2026ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchProfileConfig(requestParameters: AuthProfileV2026ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getProfileConfig operation in AuthProfileV2026Api. - * @export - * @interface AuthProfileV2026ApiGetProfileConfigRequest - */ -export interface AuthProfileV2026ApiGetProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2026ApiGetProfileConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2026ApiGetProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getProfileConfigList operation in AuthProfileV2026Api. - * @export - * @interface AuthProfileV2026ApiGetProfileConfigListRequest - */ -export interface AuthProfileV2026ApiGetProfileConfigListRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2026ApiGetProfileConfigList - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchProfileConfig operation in AuthProfileV2026Api. - * @export - * @interface AuthProfileV2026ApiPatchProfileConfigRequest - */ -export interface AuthProfileV2026ApiPatchProfileConfigRequest { - /** - * ID of the Auth Profile to patch. - * @type {string} - * @memberof AuthProfileV2026ApiPatchProfileConfig - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AuthProfileV2026ApiPatchProfileConfig - */ - readonly jsonPatchOperationV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof AuthProfileV2026ApiPatchProfileConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * AuthProfileV2026Api - object-oriented interface - * @export - * @class AuthProfileV2026Api - * @extends {BaseAPI} - */ -export class AuthProfileV2026Api extends BaseAPI { - /** - * This API returns auth profile information. - * @summary Get auth profile - * @param {AuthProfileV2026ApiGetProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2026Api - */ - public getProfileConfig(requestParameters: AuthProfileV2026ApiGetProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2026ApiFp(this.configuration).getProfileConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of auth profiles. - * @summary Get list of auth profiles - * @param {AuthProfileV2026ApiGetProfileConfigListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2026Api - */ - public getProfileConfigList(requestParameters: AuthProfileV2026ApiGetProfileConfigListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2026ApiFp(this.configuration).getProfileConfigList(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - * @summary Patch a specified auth profile - * @param {AuthProfileV2026ApiPatchProfileConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthProfileV2026Api - */ - public patchProfileConfig(requestParameters: AuthProfileV2026ApiPatchProfileConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthProfileV2026ApiFp(this.configuration).patchProfileConfig(requestParameters.id, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AuthUsersV2026Api - axios parameter creator - * @export - */ -export const AuthUsersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAuthUser', 'id', id) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2026 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAuthUser', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAuthUser', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AuthUsersV2026Api - functional programming interface - * @export - */ -export const AuthUsersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthUsersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthUser(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2026Api.getAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperationV2026 A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthUser(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthUser(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersV2026Api.patchAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthUsersV2026Api - factory interface - * @export - */ -export const AuthUsersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthUsersV2026ApiFp(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2026ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser(requestParameters: AuthUsersV2026ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthUser(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2026ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser(requestParameters: AuthUsersV2026ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAuthUser operation in AuthUsersV2026Api. - * @export - * @interface AuthUsersV2026ApiGetAuthUserRequest - */ -export interface AuthUsersV2026ApiGetAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2026ApiGetAuthUser - */ - readonly id: string -} - -/** - * Request parameters for patchAuthUser operation in AuthUsersV2026Api. - * @export - * @interface AuthUsersV2026ApiPatchAuthUserRequest - */ -export interface AuthUsersV2026ApiPatchAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersV2026ApiPatchAuthUser - */ - readonly id: string - - /** - * A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AuthUsersV2026ApiPatchAuthUser - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * AuthUsersV2026Api - object-oriented interface - * @export - * @class AuthUsersV2026Api - * @extends {BaseAPI} - */ -export class AuthUsersV2026Api extends BaseAPI { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersV2026ApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2026Api - */ - public getAuthUser(requestParameters: AuthUsersV2026ApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2026ApiFp(this.configuration).getAuthUser(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersV2026ApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersV2026Api - */ - public patchAuthUser(requestParameters: AuthUsersV2026ApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersV2026ApiFp(this.configuration).patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * BrandingV2026Api - axios parameter creator - * @export - */ -export const BrandingV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('createBrandingItem', 'name', name) - // verify required parameter 'productName' is not null or undefined - assertParamExists('createBrandingItem', 'productName', productName) - const localVarPath = `/brandings`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/brandings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('setBrandingItem', 'name', name) - // verify required parameter 'name2' is not null or undefined - assertParamExists('setBrandingItem', 'name2', name2) - // verify required parameter 'productName' is not null or undefined - assertParamExists('setBrandingItem', 'productName', productName) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name2 !== undefined) { - localVarFormParams.append('name', name2 as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * BrandingV2026Api - functional programming interface - * @export - */ -export const BrandingV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = BrandingV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createBrandingItem(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItem(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2026Api.createBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2026Api.deleteBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2026Api.getBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBrandingList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2026Api.getBrandingList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setBrandingItem(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItem(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingV2026Api.setBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * BrandingV2026Api - factory interface - * @export - */ -export const BrandingV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = BrandingV2026ApiFp(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2026ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem(requestParameters: BrandingV2026ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2026ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding(requestParameters: BrandingV2026ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2026ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding(requestParameters: BrandingV2026ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBrandingList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2026ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem(requestParameters: BrandingV2026ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createBrandingItem operation in BrandingV2026Api. - * @export - * @interface BrandingV2026ApiCreateBrandingItemRequest - */ -export interface BrandingV2026ApiCreateBrandingItemRequest { - /** - * name of branding item - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly name: string - - /** - * product name - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2026ApiCreateBrandingItem - */ - readonly fileStandard?: File -} - -/** - * Request parameters for deleteBranding operation in BrandingV2026Api. - * @export - * @interface BrandingV2026ApiDeleteBrandingRequest - */ -export interface BrandingV2026ApiDeleteBrandingRequest { - /** - * The name of the branding item to be deleted - * @type {string} - * @memberof BrandingV2026ApiDeleteBranding - */ - readonly name: string -} - -/** - * Request parameters for getBranding operation in BrandingV2026Api. - * @export - * @interface BrandingV2026ApiGetBrandingRequest - */ -export interface BrandingV2026ApiGetBrandingRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2026ApiGetBranding - */ - readonly name: string -} - -/** - * Request parameters for setBrandingItem operation in BrandingV2026Api. - * @export - * @interface BrandingV2026ApiSetBrandingItemRequest - */ -export interface BrandingV2026ApiSetBrandingItemRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly name: string - - /** - * name of branding item - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly name2: string - - /** - * product name - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingV2026ApiSetBrandingItem - */ - readonly fileStandard?: File -} - -/** - * BrandingV2026Api - object-oriented interface - * @export - * @class BrandingV2026Api - * @extends {BaseAPI} - */ -export class BrandingV2026Api extends BaseAPI { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingV2026ApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2026Api - */ - public createBrandingItem(requestParameters: BrandingV2026ApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2026ApiFp(this.configuration).createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingV2026ApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2026Api - */ - public deleteBranding(requestParameters: BrandingV2026ApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2026ApiFp(this.configuration).deleteBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingV2026ApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2026Api - */ - public getBranding(requestParameters: BrandingV2026ApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2026ApiFp(this.configuration).getBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2026Api - */ - public getBrandingList(axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2026ApiFp(this.configuration).getBrandingList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingV2026ApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingV2026Api - */ - public setBrandingItem(requestParameters: BrandingV2026ApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingV2026ApiFp(this.configuration).setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignFiltersV2026Api - axios parameter creator - * @export - */ -export const CertificationCampaignFiltersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2026} campaignFilterDetailsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter: async (campaignFilterDetailsV2026: CampaignFilterDetailsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignFilterDetailsV2026' is not null or undefined - assertParamExists('createCampaignFilter', 'campaignFilterDetailsV2026', campaignFilterDetailsV2026) - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteCampaignFilters', 'requestBody', requestBody) - const localVarPath = `/campaign-filters/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignFilterById', 'id', id) - const localVarPath = `/campaign-filters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (includeSystemFilters !== undefined) { - localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2026} campaignFilterDetailsV2026 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter: async (filterId: string, campaignFilterDetailsV2026: CampaignFilterDetailsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filterId' is not null or undefined - assertParamExists('updateCampaignFilter', 'filterId', filterId) - // verify required parameter 'campaignFilterDetailsV2026' is not null or undefined - assertParamExists('updateCampaignFilter', 'campaignFilterDetailsV2026', campaignFilterDetailsV2026) - const localVarPath = `/campaign-filters/{id}` - .replace(`{${"filterId"}}`, encodeURIComponent(String(filterId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignFiltersV2026Api - functional programming interface - * @export - */ -export const CertificationCampaignFiltersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignFiltersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetailsV2026} campaignFilterDetailsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignFilter(campaignFilterDetailsV2026: CampaignFilterDetailsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilter(campaignFilterDetailsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2026Api.createCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignFilters(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFilters(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2026Api.deleteCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignFilterById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2026Api.getCampaignFilterById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCampaignFilters(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFilters(limit, start, includeSystemFilters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2026Api.listCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetailsV2026} campaignFilterDetailsV2026 A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaignFilter(filterId: string, campaignFilterDetailsV2026: CampaignFilterDetailsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilter(filterId, campaignFilterDetailsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersV2026Api.updateCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignFiltersV2026Api - factory interface - * @export - */ -export const CertificationCampaignFiltersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignFiltersV2026ApiFp(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter(requestParameters: CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignFilter(requestParameters.campaignFilterDetailsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters(requestParameters: CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCampaignFilter operation in CertificationCampaignFiltersV2026Api. - * @export - * @interface CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest { - /** - * - * @type {CampaignFilterDetailsV2026} - * @memberof CertificationCampaignFiltersV2026ApiCreateCampaignFilter - */ - readonly campaignFilterDetailsV2026: CampaignFilterDetailsV2026 -} - -/** - * Request parameters for deleteCampaignFilters operation in CertificationCampaignFiltersV2026Api. - * @export - * @interface CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest { - /** - * A json list of IDs of campaign filters to delete. - * @type {Array} - * @memberof CertificationCampaignFiltersV2026ApiDeleteCampaignFilters - */ - readonly requestBody: Array -} - -/** - * Request parameters for getCampaignFilterById operation in CertificationCampaignFiltersV2026Api. - * @export - * @interface CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest - */ -export interface CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest { - /** - * The ID of the campaign filter to be retrieved. - * @type {string} - * @memberof CertificationCampaignFiltersV2026ApiGetCampaignFilterById - */ - readonly id: string -} - -/** - * Request parameters for listCampaignFilters operation in CertificationCampaignFiltersV2026Api. - * @export - * @interface CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest { - /** - * 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 CertificationCampaignFiltersV2026ApiListCampaignFilters - */ - readonly limit?: number - - /** - * Start/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 CertificationCampaignFiltersV2026ApiListCampaignFilters - */ - readonly start?: number - - /** - * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @type {boolean} - * @memberof CertificationCampaignFiltersV2026ApiListCampaignFilters - */ - readonly includeSystemFilters?: boolean -} - -/** - * Request parameters for updateCampaignFilter operation in CertificationCampaignFiltersV2026Api. - * @export - * @interface CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest { - /** - * The ID of the campaign filter being modified. - * @type {string} - * @memberof CertificationCampaignFiltersV2026ApiUpdateCampaignFilter - */ - readonly filterId: string - - /** - * A campaign filter details with updated field values. - * @type {CampaignFilterDetailsV2026} - * @memberof CertificationCampaignFiltersV2026ApiUpdateCampaignFilter - */ - readonly campaignFilterDetailsV2026: CampaignFilterDetailsV2026 -} - -/** - * CertificationCampaignFiltersV2026Api - object-oriented interface - * @export - * @class CertificationCampaignFiltersV2026Api - * @extends {BaseAPI} - */ -export class CertificationCampaignFiltersV2026Api extends BaseAPI { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2026Api - */ - public createCampaignFilter(requestParameters: CertificationCampaignFiltersV2026ApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2026ApiFp(this.configuration).createCampaignFilter(requestParameters.campaignFilterDetailsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2026Api - */ - public deleteCampaignFilters(requestParameters: CertificationCampaignFiltersV2026ApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2026ApiFp(this.configuration).deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2026Api - */ - public getCampaignFilterById(requestParameters: CertificationCampaignFiltersV2026ApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2026ApiFp(this.configuration).getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2026Api - */ - public listCampaignFilters(requestParameters: CertificationCampaignFiltersV2026ApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2026ApiFp(this.configuration).listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersV2026Api - */ - public updateCampaignFilter(requestParameters: CertificationCampaignFiltersV2026ApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersV2026ApiFp(this.configuration).updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetailsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignsV2026Api - axios parameter creator - * @export - */ -export const CertificationCampaignsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2026} [campaignCompleteOptionsV2026] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign: async (id: string, campaignCompleteOptionsV2026?: CampaignCompleteOptionsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignCompleteOptionsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2026} campaignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign: async (campaignV2026: CampaignV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignV2026' is not null or undefined - assertParamExists('createCampaign', 'campaignV2026', campaignV2026) - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2026} campaignTemplateV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate: async (campaignTemplateV2026: CampaignTemplateV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignTemplateV2026' is not null or undefined - assertParamExists('createCampaignTemplate', 'campaignTemplateV2026', campaignTemplateV2026) - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignTemplateV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2026} campaignsDeleteRequestV2026 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns: async (campaignsDeleteRequestV2026: CampaignsDeleteRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignsDeleteRequestV2026' is not null or undefined - assertParamExists('deleteCampaigns', 'campaignsDeleteRequestV2026', campaignsDeleteRequestV2026) - const localVarPath = `/campaigns/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignsDeleteRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns: async (detail?: GetActiveCampaignsDetailV2026, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign: async (id: string, detail?: GetCampaignDetailV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaign', 'id', id) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignReports', 'id', id) - const localVarPath = `/campaigns/{id}/reports` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns/reports-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2026} adminReviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move: async (id: string, adminReviewReassignV2026: AdminReviewReassignV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('move', 'id', id) - // verify required parameter 'adminReviewReassignV2026' is not null or undefined - assertParamExists('move', 'adminReviewReassignV2026', adminReviewReassignV2026) - const localVarPath = `/campaigns/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(adminReviewReassignV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2026 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchCampaignTemplate', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchCampaignTemplate', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2026} campaignReportsConfigV2026 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig: async (campaignReportsConfigV2026: CampaignReportsConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignReportsConfigV2026' is not null or undefined - assertParamExists('setCampaignReportsConfig', 'campaignReportsConfigV2026', campaignReportsConfigV2026) - const localVarPath = `/campaigns/reports-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignReportsConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2026} [scheduleV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule: async (id: string, scheduleV2026?: ScheduleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduleV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2026} [activateCampaignOptionsV2026] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign: async (id: string, activateCampaignOptionsV2026?: ActivateCampaignOptionsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/activate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(activateCampaignOptionsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignRemediationScan', 'id', id) - const localVarPath = `/campaigns/{id}/run-remediation-scan` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2026} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport: async (id: string, type: ReportTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignReport', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('startCampaignReport', 'type', type) - const localVarPath = `/campaigns/{id}/run-report/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startGenerateCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{id}/generate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2026 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateCampaign', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateCampaign', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignsV2026Api - functional programming interface - * @export - */ -export const CertificationCampaignsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignsV2026ApiAxiosParamCreator(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptionsV2026} [campaignCompleteOptionsV2026] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeCampaign(id: string, campaignCompleteOptionsV2026?: CampaignCompleteOptionsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaign(id, campaignCompleteOptionsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.completeCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CampaignV2026} campaignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaign(campaignV2026: CampaignV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaign(campaignV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.createCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplateV2026} campaignTemplateV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignTemplate(campaignTemplateV2026: CampaignTemplateV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplate(campaignTemplateV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.createCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.deleteCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.deleteCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequestV2026} campaignsDeleteRequestV2026 IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaigns(campaignsDeleteRequestV2026: CampaignsDeleteRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaigns(campaignsDeleteRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.deleteCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getActiveCampaigns(detail?: GetActiveCampaignsDetailV2026, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getActiveCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV2026} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaign(id: string, detail?: GetCampaignDetailV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaign(id, detail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReports(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReports(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaignReports']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.getCampaignTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassignV2026} adminReviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async move(id: string, adminReviewReassignV2026: AdminReviewReassignV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.move(id, adminReviewReassignV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.move']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2026 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchCampaignTemplate(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplate(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.patchCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfigV2026} campaignReportsConfigV2026 Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignReportsConfig(campaignReportsConfigV2026: CampaignReportsConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfig(campaignReportsConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.setCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {ScheduleV2026} [scheduleV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignTemplateSchedule(id: string, scheduleV2026?: ScheduleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateSchedule(id, scheduleV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.setCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptionsV2026} [activateCampaignOptionsV2026] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaign(id: string, activateCampaignOptionsV2026?: ActivateCampaignOptionsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaign(id, activateCampaignOptionsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.startCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignRemediationScan(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScan(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.startCampaignRemediationScan']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportTypeV2026} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignReport(id: string, type: ReportTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReport(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.startCampaignReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startGenerateCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.startGenerateCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperationV2026 A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaign(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaign(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsV2026Api.updateCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignsV2026Api - factory interface - * @export - */ -export const CertificationCampaignsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignsV2026ApiFp(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2026ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign(requestParameters: CertificationCampaignsV2026ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2026ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign(requestParameters: CertificationCampaignsV2026ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaign(requestParameters.campaignV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2026ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignTemplate(requestParameters.campaignTemplateV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2026ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaigns(requestParameters.campaignsDeleteRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2026ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns(requestParameters: CertificationCampaignsV2026ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2026ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign(requestParameters: CertificationCampaignsV2026ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2026ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports(requestParameters: CertificationCampaignsV2026ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2026ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2026ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2026ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move(requestParameters: CertificationCampaignsV2026ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.move(requestParameters.id, requestParameters.adminReviewReassignV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2026ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig(requestParameters: CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignReportsConfig(requestParameters.campaignReportsConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2026ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign(requestParameters: CertificationCampaignsV2026ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan(requestParameters: CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2026ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport(requestParameters: CertificationCampaignsV2026ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2026ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign(requestParameters: CertificationCampaignsV2026ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeCampaign operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiCompleteCampaignRequest - */ -export interface CertificationCampaignsV2026ApiCompleteCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2026ApiCompleteCampaign - */ - readonly id: string - - /** - * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @type {CampaignCompleteOptionsV2026} - * @memberof CertificationCampaignsV2026ApiCompleteCampaign - */ - readonly campaignCompleteOptionsV2026?: CampaignCompleteOptionsV2026 -} - -/** - * Request parameters for createCampaign operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiCreateCampaignRequest - */ -export interface CertificationCampaignsV2026ApiCreateCampaignRequest { - /** - * - * @type {CampaignV2026} - * @memberof CertificationCampaignsV2026ApiCreateCampaign - */ - readonly campaignV2026: CampaignV2026 -} - -/** - * Request parameters for createCampaignTemplate operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiCreateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2026ApiCreateCampaignTemplateRequest { - /** - * - * @type {CampaignTemplateV2026} - * @memberof CertificationCampaignsV2026ApiCreateCampaignTemplate - */ - readonly campaignTemplateV2026: CampaignTemplateV2026 -} - -/** - * Request parameters for deleteCampaignTemplate operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest - */ -export interface CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest { - /** - * ID of the campaign template being deleted. - * @type {string} - * @memberof CertificationCampaignsV2026ApiDeleteCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaignTemplateSchedule operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being deleted. - * @type {string} - * @memberof CertificationCampaignsV2026ApiDeleteCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaigns operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiDeleteCampaignsRequest - */ -export interface CertificationCampaignsV2026ApiDeleteCampaignsRequest { - /** - * IDs of the campaigns to delete. - * @type {CampaignsDeleteRequestV2026} - * @memberof CertificationCampaignsV2026ApiDeleteCampaigns - */ - readonly campaignsDeleteRequestV2026: CampaignsDeleteRequestV2026 -} - -/** - * Request parameters for getActiveCampaigns operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetActiveCampaignsRequest - */ -export interface CertificationCampaignsV2026ApiGetActiveCampaignsRequest { - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2026ApiGetActiveCampaigns - */ - readonly detail?: GetActiveCampaignsDetailV2026 - - /** - * 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 CertificationCampaignsV2026ApiGetActiveCampaigns - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2026ApiGetActiveCampaigns - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2026ApiGetActiveCampaigns - */ - 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, in* **name**: *eq, sw* **status**: *eq, in* - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetActiveCampaigns - */ - 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: **name, created** - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetActiveCampaigns - */ - readonly sorters?: string -} - -/** - * Request parameters for getCampaign operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetCampaignRequest - */ -export interface CertificationCampaignsV2026ApiGetCampaignRequest { - /** - * ID of the campaign to be retrieved. - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaign - */ - readonly id: string - - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsV2026ApiGetCampaign - */ - readonly detail?: GetCampaignDetailV2026 -} - -/** - * Request parameters for getCampaignReports operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetCampaignReportsRequest - */ -export interface CertificationCampaignsV2026ApiGetCampaignReportsRequest { - /** - * ID of the campaign whose reports are being fetched. - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaignReports - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplate operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetCampaignTemplateRequest - */ -export interface CertificationCampaignsV2026ApiGetCampaignTemplateRequest { - /** - * Requested campaign template\'s ID. - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplateSchedule operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being fetched. - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplates operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiGetCampaignTemplatesRequest - */ -export interface CertificationCampaignsV2026ApiGetCampaignTemplatesRequest { - /** - * 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 CertificationCampaignsV2026ApiGetCampaignTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplates - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplates - */ - readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof CertificationCampaignsV2026ApiGetCampaignTemplates - */ - readonly filters?: string -} - -/** - * Request parameters for move operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiMoveRequest - */ -export interface CertificationCampaignsV2026ApiMoveRequest { - /** - * The certification campaign ID - * @type {string} - * @memberof CertificationCampaignsV2026ApiMove - */ - readonly id: string - - /** - * - * @type {AdminReviewReassignV2026} - * @memberof CertificationCampaignsV2026ApiMove - */ - readonly adminReviewReassignV2026: AdminReviewReassignV2026 -} - -/** - * Request parameters for patchCampaignTemplate operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiPatchCampaignTemplateRequest - */ -export interface CertificationCampaignsV2026ApiPatchCampaignTemplateRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2026ApiPatchCampaignTemplate - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @type {Array} - * @memberof CertificationCampaignsV2026ApiPatchCampaignTemplate - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for setCampaignReportsConfig operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest - */ -export interface CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest { - /** - * Campaign report configuration. - * @type {CampaignReportsConfigV2026} - * @memberof CertificationCampaignsV2026ApiSetCampaignReportsConfig - */ - readonly campaignReportsConfigV2026: CampaignReportsConfigV2026 -} - -/** - * Request parameters for setCampaignTemplateSchedule operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template being scheduled. - * @type {string} - * @memberof CertificationCampaignsV2026ApiSetCampaignTemplateSchedule - */ - readonly id: string - - /** - * - * @type {ScheduleV2026} - * @memberof CertificationCampaignsV2026ApiSetCampaignTemplateSchedule - */ - readonly scheduleV2026?: ScheduleV2026 -} - -/** - * Request parameters for startCampaign operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiStartCampaignRequest - */ -export interface CertificationCampaignsV2026ApiStartCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsV2026ApiStartCampaign - */ - readonly id: string - - /** - * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @type {ActivateCampaignOptionsV2026} - * @memberof CertificationCampaignsV2026ApiStartCampaign - */ - readonly activateCampaignOptionsV2026?: ActivateCampaignOptionsV2026 -} - -/** - * Request parameters for startCampaignRemediationScan operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest - */ -export interface CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest { - /** - * ID of the campaign the remediation scan is being run for. - * @type {string} - * @memberof CertificationCampaignsV2026ApiStartCampaignRemediationScan - */ - readonly id: string -} - -/** - * Request parameters for startCampaignReport operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiStartCampaignReportRequest - */ -export interface CertificationCampaignsV2026ApiStartCampaignReportRequest { - /** - * ID of the campaign the report is being run for. - * @type {string} - * @memberof CertificationCampaignsV2026ApiStartCampaignReport - */ - readonly id: string - - /** - * Type of the report to run. - * @type {ReportTypeV2026} - * @memberof CertificationCampaignsV2026ApiStartCampaignReport - */ - readonly type: ReportTypeV2026 -} - -/** - * Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest - */ -export interface CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest { - /** - * ID of the campaign template to use for generation. - * @type {string} - * @memberof CertificationCampaignsV2026ApiStartGenerateCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for updateCampaign operation in CertificationCampaignsV2026Api. - * @export - * @interface CertificationCampaignsV2026ApiUpdateCampaignRequest - */ -export interface CertificationCampaignsV2026ApiUpdateCampaignRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsV2026ApiUpdateCampaign - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @type {Array} - * @memberof CertificationCampaignsV2026ApiUpdateCampaign - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * CertificationCampaignsV2026Api - object-oriented interface - * @export - * @class CertificationCampaignsV2026Api - * @extends {BaseAPI} - */ -export class CertificationCampaignsV2026Api extends BaseAPI { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsV2026ApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public completeCampaign(requestParameters: CertificationCampaignsV2026ApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptionsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsV2026ApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public createCampaign(requestParameters: CertificationCampaignsV2026ApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).createCampaign(requestParameters.campaignV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsV2026ApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public createCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).createCampaignTemplate(requestParameters.campaignTemplateV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public deleteCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsV2026ApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public deleteCampaigns(requestParameters: CertificationCampaignsV2026ApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).deleteCampaigns(requestParameters.campaignsDeleteRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsV2026ApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getActiveCampaigns(requestParameters: CertificationCampaignsV2026ApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsV2026ApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaign(requestParameters: CertificationCampaignsV2026ApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsV2026ApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaignReports(requestParameters: CertificationCampaignsV2026ApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaignReportsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsV2026ApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsV2026ApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public getCampaignTemplates(requestParameters: CertificationCampaignsV2026ApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsV2026ApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public move(requestParameters: CertificationCampaignsV2026ApiMoveRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).move(requestParameters.id, requestParameters.adminReviewReassignV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsV2026ApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public patchCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public setCampaignReportsConfig(requestParameters: CertificationCampaignsV2026ApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).setCampaignReportsConfig(requestParameters.campaignReportsConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public setCampaignTemplateSchedule(requestParameters: CertificationCampaignsV2026ApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).setCampaignTemplateSchedule(requestParameters.id, requestParameters.scheduleV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsV2026ApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public startCampaign(requestParameters: CertificationCampaignsV2026ApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).startCampaign(requestParameters.id, requestParameters.activateCampaignOptionsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public startCampaignRemediationScan(requestParameters: CertificationCampaignsV2026ApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsV2026ApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public startCampaignReport(requestParameters: CertificationCampaignsV2026ApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public startGenerateCampaignTemplate(requestParameters: CertificationCampaignsV2026ApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsV2026ApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsV2026Api - */ - public updateCampaign(requestParameters: CertificationCampaignsV2026ApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsV2026ApiFp(this.configuration).updateCampaign(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetActiveCampaignsDetailV2026 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetActiveCampaignsDetailV2026 = typeof GetActiveCampaignsDetailV2026[keyof typeof GetActiveCampaignsDetailV2026]; -/** - * @export - */ -export const GetCampaignDetailV2026 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetCampaignDetailV2026 = typeof GetCampaignDetailV2026[keyof typeof GetCampaignDetailV2026]; - - -/** - * CertificationSummariesV2026Api - axios parameter creator - * @export - */ -export const CertificationSummariesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2026} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries: async (id: string, type: GetIdentityAccessSummariesTypeV2026, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'type', type) - const localVarPath = `/certifications/{id}/access-summaries/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityDecisionSummary', 'id', id) - const localVarPath = `/certifications/{id}/decision-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummaries', 'id', id) - const localVarPath = `/certifications/{id}/identity-summaries` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummary', 'id', id) - // verify required parameter 'identitySummaryId' is not null or undefined - assertParamExists('getIdentitySummary', 'identitySummaryId', identitySummaryId) - const localVarPath = `/certifications/{id}/identity-summaries/{identitySummaryId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationSummariesV2026Api - functional programming interface - * @export - */ -export const CertificationSummariesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationSummariesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV2026} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAccessSummaries(id: string, type: GetIdentityAccessSummariesTypeV2026, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummaries(id, type, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2026Api.getIdentityAccessSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityDecisionSummary(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummary(id, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2026Api.getIdentityDecisionSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummaries(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaries(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2026Api.getIdentitySummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummary(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummary(id, identitySummaryId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesV2026Api.getIdentitySummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationSummariesV2026Api - factory interface - * @export - */ -export const CertificationSummariesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationSummariesV2026ApiFp(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries(requestParameters: CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary(requestParameters: CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2026ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries(requestParameters: CertificationSummariesV2026ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2026ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary(requestParameters: CertificationSummariesV2026ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getIdentityAccessSummaries operation in CertificationSummariesV2026Api. - * @export - * @interface CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest - */ -export interface CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - readonly id: string - - /** - * The type of access review item to retrieve summaries for - * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - readonly type: GetIdentityAccessSummariesTypeV2026 - - /** - * 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 CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - 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: **access.name** - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentityAccessSummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentityDecisionSummary operation in CertificationSummariesV2026Api. - * @export - * @interface CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest - */ -export interface CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentityDecisionSummary - */ - readonly id: 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: **identitySummary.id**: *eq, in* - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentityDecisionSummary - */ - readonly filters?: string -} - -/** - * Request parameters for getIdentitySummaries operation in CertificationSummariesV2026Api. - * @export - * @interface CertificationSummariesV2026ApiGetIdentitySummariesRequest - */ -export interface CertificationSummariesV2026ApiGetIdentitySummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - 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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - 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: **name** - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentitySummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentitySummary operation in CertificationSummariesV2026Api. - * @export - * @interface CertificationSummariesV2026ApiGetIdentitySummaryRequest - */ -export interface CertificationSummariesV2026ApiGetIdentitySummaryRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentitySummary - */ - readonly id: string - - /** - * The identity summary ID - * @type {string} - * @memberof CertificationSummariesV2026ApiGetIdentitySummary - */ - readonly identitySummaryId: string -} - -/** - * CertificationSummariesV2026Api - object-oriented interface - * @export - * @class CertificationSummariesV2026Api - * @extends {BaseAPI} - */ -export class CertificationSummariesV2026Api extends BaseAPI { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2026Api - */ - public getIdentityAccessSummaries(requestParameters: CertificationSummariesV2026ApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2026ApiFp(this.configuration).getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2026Api - */ - public getIdentityDecisionSummary(requestParameters: CertificationSummariesV2026ApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2026ApiFp(this.configuration).getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesV2026ApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2026Api - */ - public getIdentitySummaries(requestParameters: CertificationSummariesV2026ApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2026ApiFp(this.configuration).getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesV2026ApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesV2026Api - */ - public getIdentitySummary(requestParameters: CertificationSummariesV2026ApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesV2026ApiFp(this.configuration).getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetIdentityAccessSummariesTypeV2026 = { - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT' -} as const; -export type GetIdentityAccessSummariesTypeV2026 = typeof GetIdentityAccessSummariesTypeV2026[keyof typeof GetIdentityAccessSummariesTypeV2026]; - - -/** - * CertificationsV2026Api - axios parameter creator - * @export - */ -export const CertificationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCertificationTask', 'id', id) - const localVarPath = `/certification-tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertification', 'id', id) - const localVarPath = `/certifications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'certificationId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'certificationId', certificationId) - // verify required parameter 'itemId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'itemId', itemId) - const localVarPath = `/certifications/{certificationId}/access-review-items/{itemId}/permissions` - .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) - .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certification-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listCertificationReviewers', 'id', id) - const localVarPath = `/certifications/{id}/reviewers` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessReviewItems', 'id', id) - const localVarPath = `/certifications/{id}/access-review-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (entitlements !== undefined) { - localVarQueryParameter['entitlements'] = entitlements; - } - - if (accessProfiles !== undefined) { - localVarQueryParameter['access-profiles'] = accessProfiles; - } - - if (roles !== undefined) { - localVarQueryParameter['roles'] = roles; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certifications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2026 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision: async (id: string, reviewDecisionV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('makeIdentityDecision', 'id', id) - // verify required parameter 'reviewDecisionV2026' is not null or undefined - assertParamExists('makeIdentityDecision', 'reviewDecisionV2026', reviewDecisionV2026) - const localVarPath = `/certifications/{id}/decide` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewDecisionV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2026} reviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications: async (id: string, reviewReassignV2026: ReviewReassignV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'id', id) - // verify required parameter 'reviewReassignV2026' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'reviewReassignV2026', reviewReassignV2026) - const localVarPath = `/certifications/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('signOffIdentityCertification', 'id', id) - const localVarPath = `/certifications/{id}/sign-off` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2026} reviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync: async (id: string, reviewReassignV2026: ReviewReassignV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'id', id) - // verify required parameter 'reviewReassignV2026' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'reviewReassignV2026', reviewReassignV2026) - const localVarPath = `/certifications/{id}/reassign-async` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassignV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationsV2026Api - functional programming interface - * @export - */ -export const CertificationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCertificationTask(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.getCertificationTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.getIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissions(certificationId, itemId, filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.getIdentityCertificationItemPermissions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasks(reviewerIdentity, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.getPendingCertificationTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewers(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.listCertificationReviewers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessReviewItems(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItems(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.listIdentityAccessReviewItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityCertifications(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertifications(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.listIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecisionV2026 A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async makeIdentityDecision(id: string, reviewDecisionV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecision(id, reviewDecisionV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.makeIdentityDecision']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2026} reviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async reassignIdentityCertifications(id: string, reviewReassignV2026: ReviewReassignV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertifications(id, reviewReassignV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.reassignIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async signOffIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.signOffIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassignV2026} reviewReassignV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReassignCertsAsync(id: string, reviewReassignV2026: ReviewReassignV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsync(id, reviewReassignV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsV2026Api.submitReassignCertsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationsV2026Api - factory interface - * @export - */ -export const CertificationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationsV2026ApiFp(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2026ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask(requestParameters: CertificationsV2026ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2026ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification(requestParameters: CertificationsV2026ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions(requestParameters: CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2026ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks(requestParameters: CertificationsV2026ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2026ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers(requestParameters: CertificationsV2026ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2026ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems(requestParameters: CertificationsV2026ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2026ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications(requestParameters: CertificationsV2026ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2026ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision(requestParameters: CertificationsV2026ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2026ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications(requestParameters: CertificationsV2026ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2026ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification(requestParameters: CertificationsV2026ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2026ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync(requestParameters: CertificationsV2026ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getCertificationTask operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiGetCertificationTaskRequest - */ -export interface CertificationsV2026ApiGetCertificationTaskRequest { - /** - * The task ID - * @type {string} - * @memberof CertificationsV2026ApiGetCertificationTask - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertification operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiGetIdentityCertificationRequest - */ -export interface CertificationsV2026ApiGetIdentityCertificationRequest { - /** - * The certification id - * @type {string} - * @memberof CertificationsV2026ApiGetIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertificationItemPermissions operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest - */ -export interface CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly certificationId: string - - /** - * The certification item ID - * @type {string} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @type {string} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2026ApiGetIdentityCertificationItemPermissions - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingCertificationTasks operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiGetPendingCertificationTasksRequest - */ -export interface CertificationsV2026ApiGetPendingCertificationTasksRequest { - /** - * The ID of reviewer identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2026ApiGetPendingCertificationTasks - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiGetPendingCertificationTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiGetPendingCertificationTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2026ApiGetPendingCertificationTasks - */ - 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, in* **targetId**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof CertificationsV2026ApiGetPendingCertificationTasks - */ - readonly filters?: string -} - -/** - * Request parameters for listCertificationReviewers operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiListCertificationReviewersRequest - */ -export interface CertificationsV2026ApiListCertificationReviewersRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - 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, in* **name**: *eq, sw* **email**: *eq, sw* - * @type {string} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - 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: **name, email** - * @type {string} - * @memberof CertificationsV2026ApiListCertificationReviewers - */ - readonly sorters?: string -} - -/** - * Request parameters for listIdentityAccessReviewItems operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiListIdentityAccessReviewItemsRequest - */ -export interface CertificationsV2026ApiListIdentityAccessReviewItemsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - 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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly sorters?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly entitlements?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly accessProfiles?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsV2026ApiListIdentityAccessReviewItems - */ - readonly roles?: string -} - -/** - * Request parameters for listIdentityCertifications operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiListIdentityCertificationsRequest - */ -export interface CertificationsV2026ApiListIdentityCertificationsRequest { - /** - * Reviewer\'s identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - 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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @type {string} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - 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: **name, due, signed** - * @type {string} - * @memberof CertificationsV2026ApiListIdentityCertifications - */ - readonly sorters?: string -} - -/** - * Request parameters for makeIdentityDecision operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiMakeIdentityDecisionRequest - */ -export interface CertificationsV2026ApiMakeIdentityDecisionRequest { - /** - * The ID of the identity campaign certification on which to make decisions - * @type {string} - * @memberof CertificationsV2026ApiMakeIdentityDecision - */ - readonly id: string - - /** - * A non-empty array of decisions to be made. - * @type {Array} - * @memberof CertificationsV2026ApiMakeIdentityDecision - */ - readonly reviewDecisionV2026: Array -} - -/** - * Request parameters for reassignIdentityCertifications operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiReassignIdentityCertificationsRequest - */ -export interface CertificationsV2026ApiReassignIdentityCertificationsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2026ApiReassignIdentityCertifications - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2026} - * @memberof CertificationsV2026ApiReassignIdentityCertifications - */ - readonly reviewReassignV2026: ReviewReassignV2026 -} - -/** - * Request parameters for signOffIdentityCertification operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiSignOffIdentityCertificationRequest - */ -export interface CertificationsV2026ApiSignOffIdentityCertificationRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2026ApiSignOffIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for submitReassignCertsAsync operation in CertificationsV2026Api. - * @export - * @interface CertificationsV2026ApiSubmitReassignCertsAsyncRequest - */ -export interface CertificationsV2026ApiSubmitReassignCertsAsyncRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsV2026ApiSubmitReassignCertsAsync - */ - readonly id: string - - /** - * - * @type {ReviewReassignV2026} - * @memberof CertificationsV2026ApiSubmitReassignCertsAsync - */ - readonly reviewReassignV2026: ReviewReassignV2026 -} - -/** - * CertificationsV2026Api - object-oriented interface - * @export - * @class CertificationsV2026Api - * @extends {BaseAPI} - */ -export class CertificationsV2026Api extends BaseAPI { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsV2026ApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public getCertificationTask(requestParameters: CertificationsV2026ApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. - * @summary Identity certification by id - * @param {CertificationsV2026ApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public getIdentityCertification(requestParameters: CertificationsV2026ApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public getIdentityCertificationItemPermissions(requestParameters: CertificationsV2026ApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsV2026ApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public getPendingCertificationTasks(requestParameters: CertificationsV2026ApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsV2026ApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public listCertificationReviewers(requestParameters: CertificationsV2026ApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsV2026ApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public listIdentityAccessReviewItems(requestParameters: CertificationsV2026ApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. - * @summary List identity campaign certifications - * @param {CertificationsV2026ApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public listIdentityCertifications(requestParameters: CertificationsV2026ApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsV2026ApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public makeIdentityDecision(requestParameters: CertificationsV2026ApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).makeIdentityDecision(requestParameters.id, requestParameters.reviewDecisionV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsV2026ApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public reassignIdentityCertifications(requestParameters: CertificationsV2026ApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassignV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsV2026ApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public signOffIdentityCertification(requestParameters: CertificationsV2026ApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsV2026ApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsV2026Api - */ - public submitReassignCertsAsync(requestParameters: CertificationsV2026ApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsV2026ApiFp(this.configuration).submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassignV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ClassifySourceV2026Api - axios parameter creator - * @export - */ -export const ClassifySourceV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteClassifyMachineAccountFromSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteClassifyMachineAccountFromSource', 'id', id) - const localVarPath = `/sources/{sourceId}/classify` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClassifyMachineAccountFromSourceStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClassifyMachineAccountFromSourceStatus', 'id', id) - const localVarPath = `/sources/{sourceId}/classify` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccountFromSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('sendClassifyMachineAccountFromSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/classify` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ClassifySourceV2026Api - functional programming interface - * @export - */ -export const ClassifySourceV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ClassifySourceV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteClassifyMachineAccountFromSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteClassifyMachineAccountFromSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2026Api.deleteClassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClassifyMachineAccountFromSourceStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClassifyMachineAccountFromSourceStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2026Api.getClassifyMachineAccountFromSourceStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendClassifyMachineAccountFromSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccountFromSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ClassifySourceV2026Api.sendClassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ClassifySourceV2026Api - factory interface - * @export - */ -export const ClassifySourceV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ClassifySourceV2026ApiFp(configuration) - return { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteClassifyMachineAccountFromSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClassifyMachineAccountFromSourceStatus(requestParameters: ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClassifyMachineAccountFromSourceStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendClassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteClassifyMachineAccountFromSource operation in ClassifySourceV2026Api. - * @export - * @interface ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest - */ -export interface ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSource - */ - readonly id: string -} - -/** - * Request parameters for getClassifyMachineAccountFromSourceStatus operation in ClassifySourceV2026Api. - * @export - * @interface ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest - */ -export interface ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatus - */ - readonly id: string -} - -/** - * Request parameters for sendClassifyMachineAccountFromSource operation in ClassifySourceV2026Api. - * @export - * @interface ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest - */ -export interface ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof ClassifySourceV2026ApiSendClassifyMachineAccountFromSource - */ - readonly sourceId: string -} - -/** - * ClassifySourceV2026Api - object-oriented interface - * @export - * @class ClassifySourceV2026Api - * @extends {BaseAPI} - */ -export class ClassifySourceV2026Api extends BaseAPI { - /** - * Use this API to cancel account classification process on a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Cancel classify source\'s accounts process - * @param {ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2026Api - */ - public deleteClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2026ApiDeleteClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2026ApiFp(this.configuration).deleteClassifyMachineAccountFromSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the status of Machine Account Classification process for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Source accounts classification status - * @param {ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2026Api - */ - public getClassifyMachineAccountFromSourceStatus(requestParameters: ClassifySourceV2026ApiGetClassifyMachineAccountFromSourceStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2026ApiFp(this.configuration).getClassifyMachineAccountFromSourceStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to classify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify source\'s all accounts - * @param {ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ClassifySourceV2026Api - */ - public sendClassifyMachineAccountFromSource(requestParameters: ClassifySourceV2026ApiSendClassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return ClassifySourceV2026ApiFp(this.configuration).sendClassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConfigurationHubV2026Api - axios parameter creator - * @export - */ -export const ConfigurationHubV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2026} deployRequestV2026 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy: async (deployRequestV2026: DeployRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deployRequestV2026' is not null or undefined - assertParamExists('createDeploy', 'deployRequestV2026', deployRequestV2026) - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deployRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2026} objectMappingRequestV2026 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping: async (sourceOrg: string, objectMappingRequestV2026: ObjectMappingRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingRequestV2026' is not null or undefined - assertParamExists('createObjectMapping', 'objectMappingRequestV2026', objectMappingRequestV2026) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2026} objectMappingBulkCreateRequestV2026 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings: async (sourceOrg: string, objectMappingBulkCreateRequestV2026: ObjectMappingBulkCreateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkCreateRequestV2026' is not null or undefined - assertParamExists('createObjectMappings', 'objectMappingBulkCreateRequestV2026', objectMappingBulkCreateRequestV2026) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkCreateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2026} scheduledActionPayloadV2026 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction: async (scheduledActionPayloadV2026: ScheduledActionPayloadV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionPayloadV2026' is not null or undefined - assertParamExists('createScheduledAction', 'scheduledActionPayloadV2026', scheduledActionPayloadV2026) - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledActionPayloadV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('createUploadedConfiguration', 'data', data) - // verify required parameter 'name' is not null or undefined - assertParamExists('createUploadedConfiguration', 'name', name) - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteBackup', 'id', id) - const localVarPath = `/configuration-hub/backups/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDraft', 'id', id) - const localVarPath = `/configuration-hub/drafts/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('deleteObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingId' is not null or undefined - assertParamExists('deleteObjectMapping', 'objectMappingId', objectMappingId) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) - .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction: async (scheduledActionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('deleteScheduledAction', 'scheduledActionId', scheduledActionId) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDeploy', 'id', id) - const localVarPath = `/configuration-hub/deploys/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('getObjectMappings', 'sourceOrg', sourceOrg) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/deploys`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/drafts`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/scheduled-actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2026} objectMappingBulkPatchRequestV2026 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings: async (sourceOrg: string, objectMappingBulkPatchRequestV2026: ObjectMappingBulkPatchRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('updateObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkPatchRequestV2026' is not null or undefined - assertParamExists('updateObjectMappings', 'objectMappingBulkPatchRequestV2026', objectMappingBulkPatchRequestV2026) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkPatchRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2026} jsonPatchV2026 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction: async (scheduledActionId: string, jsonPatchV2026: JsonPatchV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scheduledActionId' is not null or undefined - assertParamExists('updateScheduledAction', 'scheduledActionId', scheduledActionId) - // verify required parameter 'jsonPatchV2026' is not null or undefined - assertParamExists('updateScheduledAction', 'jsonPatchV2026', jsonPatchV2026) - const localVarPath = `/configuration-hub/scheduled-actions/{id}` - .replace(`{${"scheduledActionId"}}`, encodeURIComponent(String(scheduledActionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConfigurationHubV2026Api - functional programming interface - * @export - */ -export const ConfigurationHubV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConfigurationHubV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {DeployRequestV2026} deployRequestV2026 The deploy request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDeploy(deployRequestV2026: DeployRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDeploy(deployRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.createDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequestV2026} objectMappingRequestV2026 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMapping(sourceOrg: string, objectMappingRequestV2026: ObjectMappingRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMapping(sourceOrg, objectMappingRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.createObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequestV2026} objectMappingBulkCreateRequestV2026 The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMappings(sourceOrg: string, objectMappingBulkCreateRequestV2026: ObjectMappingBulkCreateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappings(sourceOrg, objectMappingBulkCreateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.createObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ScheduledActionPayloadV2026} scheduledActionPayloadV2026 The scheduled action creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledAction(scheduledActionPayloadV2026: ScheduledActionPayloadV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledAction(scheduledActionPayloadV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.createScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createUploadedConfiguration(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfiguration(data, name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.createUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {string} id The id of the backup to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBackup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBackup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.deleteBackup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {string} id The id of the draft to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDraft(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDraft(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.deleteDraft']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteObjectMapping(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMapping(sourceOrg, objectMappingId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.deleteObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledAction(scheduledActionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledAction(scheduledActionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.deleteScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.deleteUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {string} id The id of the deploy. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDeploy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDeploy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.getDeploy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getObjectMappings(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappings(sourceOrg, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.getObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.getUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listBackups(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listBackups(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.listBackups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDeploys(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDeploys(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.listDeploys']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDrafts(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDrafts(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.listDrafts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledActions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledActions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.listScheduledActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUploadedConfigurations(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurations(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.listUploadedConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequestV2026} objectMappingBulkPatchRequestV2026 The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateObjectMappings(sourceOrg: string, objectMappingBulkPatchRequestV2026: ObjectMappingBulkPatchRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappings(sourceOrg, objectMappingBulkPatchRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.updateObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {string} scheduledActionId The ID of the scheduled action. - * @param {JsonPatchV2026} jsonPatchV2026 The JSON Patch document containing the changes to apply to the scheduled action. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledAction(scheduledActionId: string, jsonPatchV2026: JsonPatchV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledAction(scheduledActionId, jsonPatchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubV2026Api.updateScheduledAction']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConfigurationHubV2026Api - factory interface - * @export - */ -export const ConfigurationHubV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConfigurationHubV2026ApiFp(configuration) - return { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2026ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDeploy(requestParameters: ConfigurationHubV2026ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDeploy(requestParameters.deployRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2026ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping(requestParameters: ConfigurationHubV2026ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2026ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings(requestParameters: ConfigurationHubV2026ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2026ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledAction(requestParameters: ConfigurationHubV2026ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledAction(requestParameters.scheduledActionPayloadV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2026ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2026ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBackup(requestParameters: ConfigurationHubV2026ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBackup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2026ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDraft(requestParameters: ConfigurationHubV2026ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDraft(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2026ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping(requestParameters: ConfigurationHubV2026ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2026ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledAction(requestParameters: ConfigurationHubV2026ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2026ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDeploy(requestParameters: ConfigurationHubV2026ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDeploy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2026ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings(requestParameters: ConfigurationHubV2026ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2026ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2026ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listBackups(requestParameters: ConfigurationHubV2026ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listBackups(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDeploys(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listDeploys(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2026ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDrafts(requestParameters: ConfigurationHubV2026ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDrafts(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledActions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledActions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2026ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations(requestParameters: ConfigurationHubV2026ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2026ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings(requestParameters: ConfigurationHubV2026ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2026ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledAction(requestParameters: ConfigurationHubV2026ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDeploy operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiCreateDeployRequest - */ -export interface ConfigurationHubV2026ApiCreateDeployRequest { - /** - * The deploy request body. - * @type {DeployRequestV2026} - * @memberof ConfigurationHubV2026ApiCreateDeploy - */ - readonly deployRequestV2026: DeployRequestV2026 -} - -/** - * Request parameters for createObjectMapping operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiCreateObjectMappingRequest - */ -export interface ConfigurationHubV2026ApiCreateObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2026ApiCreateObjectMapping - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingRequestV2026} - * @memberof ConfigurationHubV2026ApiCreateObjectMapping - */ - readonly objectMappingRequestV2026: ObjectMappingRequestV2026 -} - -/** - * Request parameters for createObjectMappings operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiCreateObjectMappingsRequest - */ -export interface ConfigurationHubV2026ApiCreateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2026ApiCreateObjectMappings - */ - readonly sourceOrg: string - - /** - * The bulk create object mapping request body. - * @type {ObjectMappingBulkCreateRequestV2026} - * @memberof ConfigurationHubV2026ApiCreateObjectMappings - */ - readonly objectMappingBulkCreateRequestV2026: ObjectMappingBulkCreateRequestV2026 -} - -/** - * Request parameters for createScheduledAction operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiCreateScheduledActionRequest - */ -export interface ConfigurationHubV2026ApiCreateScheduledActionRequest { - /** - * The scheduled action creation request body. - * @type {ScheduledActionPayloadV2026} - * @memberof ConfigurationHubV2026ApiCreateScheduledAction - */ - readonly scheduledActionPayloadV2026: ScheduledActionPayloadV2026 -} - -/** - * Request parameters for createUploadedConfiguration operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiCreateUploadedConfigurationRequest - */ -export interface ConfigurationHubV2026ApiCreateUploadedConfigurationRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ConfigurationHubV2026ApiCreateUploadedConfiguration - */ - readonly data: File - - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof ConfigurationHubV2026ApiCreateUploadedConfiguration - */ - readonly name: string -} - -/** - * Request parameters for deleteBackup operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiDeleteBackupRequest - */ -export interface ConfigurationHubV2026ApiDeleteBackupRequest { - /** - * The id of the backup to delete. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteBackup - */ - readonly id: string -} - -/** - * Request parameters for deleteDraft operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiDeleteDraftRequest - */ -export interface ConfigurationHubV2026ApiDeleteDraftRequest { - /** - * The id of the draft to delete. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteDraft - */ - readonly id: string -} - -/** - * Request parameters for deleteObjectMapping operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiDeleteObjectMappingRequest - */ -export interface ConfigurationHubV2026ApiDeleteObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteObjectMapping - */ - readonly sourceOrg: string - - /** - * The id of the object mapping to be deleted. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteObjectMapping - */ - readonly objectMappingId: string -} - -/** - * Request parameters for deleteScheduledAction operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiDeleteScheduledActionRequest - */ -export interface ConfigurationHubV2026ApiDeleteScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteScheduledAction - */ - readonly scheduledActionId: string -} - -/** - * Request parameters for deleteUploadedConfiguration operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest - */ -export interface ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2026ApiDeleteUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getDeploy operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiGetDeployRequest - */ -export interface ConfigurationHubV2026ApiGetDeployRequest { - /** - * The id of the deploy. - * @type {string} - * @memberof ConfigurationHubV2026ApiGetDeploy - */ - readonly id: string -} - -/** - * Request parameters for getObjectMappings operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiGetObjectMappingsRequest - */ -export interface ConfigurationHubV2026ApiGetObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2026ApiGetObjectMappings - */ - readonly sourceOrg: string -} - -/** - * Request parameters for getUploadedConfiguration operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiGetUploadedConfigurationRequest - */ -export interface ConfigurationHubV2026ApiGetUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubV2026ApiGetUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for listBackups operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiListBackupsRequest - */ -export interface ConfigurationHubV2026ApiListBackupsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2026ApiListBackups - */ - readonly filters?: string -} - -/** - * Request parameters for listDrafts operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiListDraftsRequest - */ -export interface ConfigurationHubV2026ApiListDraftsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* - * @type {string} - * @memberof ConfigurationHubV2026ApiListDrafts - */ - readonly filters?: string -} - -/** - * Request parameters for listUploadedConfigurations operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiListUploadedConfigurationsRequest - */ -export interface ConfigurationHubV2026ApiListUploadedConfigurationsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubV2026ApiListUploadedConfigurations - */ - readonly filters?: string -} - -/** - * Request parameters for updateObjectMappings operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiUpdateObjectMappingsRequest - */ -export interface ConfigurationHubV2026ApiUpdateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubV2026ApiUpdateObjectMappings - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingBulkPatchRequestV2026} - * @memberof ConfigurationHubV2026ApiUpdateObjectMappings - */ - readonly objectMappingBulkPatchRequestV2026: ObjectMappingBulkPatchRequestV2026 -} - -/** - * Request parameters for updateScheduledAction operation in ConfigurationHubV2026Api. - * @export - * @interface ConfigurationHubV2026ApiUpdateScheduledActionRequest - */ -export interface ConfigurationHubV2026ApiUpdateScheduledActionRequest { - /** - * The ID of the scheduled action. - * @type {string} - * @memberof ConfigurationHubV2026ApiUpdateScheduledAction - */ - readonly scheduledActionId: string - - /** - * The JSON Patch document containing the changes to apply to the scheduled action. - * @type {JsonPatchV2026} - * @memberof ConfigurationHubV2026ApiUpdateScheduledAction - */ - readonly jsonPatchV2026: JsonPatchV2026 -} - -/** - * ConfigurationHubV2026Api - object-oriented interface - * @export - * @class ConfigurationHubV2026Api - * @extends {BaseAPI} - */ -export class ConfigurationHubV2026Api extends BaseAPI { - /** - * This API performs a deploy based on an existing daft. - * @summary Create a deploy - * @param {ConfigurationHubV2026ApiCreateDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public createDeploy(requestParameters: ConfigurationHubV2026ApiCreateDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).createDeploy(requestParameters.deployRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubV2026ApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public createObjectMapping(requestParameters: ConfigurationHubV2026ApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubV2026ApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public createObjectMappings(requestParameters: ConfigurationHubV2026ApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new scheduled action for the current tenant. - * @summary Create scheduled action - * @param {ConfigurationHubV2026ApiCreateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public createScheduledAction(requestParameters: ConfigurationHubV2026ApiCreateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).createScheduledAction(requestParameters.scheduledActionPayloadV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubV2026ApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public createUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing backup for the current tenant. On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. - * @summary Delete a backup - * @param {ConfigurationHubV2026ApiDeleteBackupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public deleteBackup(requestParameters: ConfigurationHubV2026ApiDeleteBackupRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).deleteBackup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing draft for the current tenant. On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. - * @summary Delete a draft - * @param {ConfigurationHubV2026ApiDeleteDraftRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public deleteDraft(requestParameters: ConfigurationHubV2026ApiDeleteDraftRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).deleteDraft(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubV2026ApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public deleteObjectMapping(requestParameters: ConfigurationHubV2026ApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing scheduled action. - * @summary Delete scheduled action - * @param {ConfigurationHubV2026ApiDeleteScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public deleteScheduledAction(requestParameters: ConfigurationHubV2026ApiDeleteScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).deleteScheduledAction(requestParameters.scheduledActionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public deleteUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing deploy for the current tenant. - * @summary Get a deploy - * @param {ConfigurationHubV2026ApiGetDeployRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public getDeploy(requestParameters: ConfigurationHubV2026ApiGetDeployRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).getDeploy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubV2026ApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public getObjectMappings(requestParameters: ConfigurationHubV2026ApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubV2026ApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public getUploadedConfiguration(requestParameters: ConfigurationHubV2026ApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing backups for the current tenant. - * @summary List backups - * @param {ConfigurationHubV2026ApiListBackupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public listBackups(requestParameters: ConfigurationHubV2026ApiListBackupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).listBackups(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of deploys for the current tenant. - * @summary List deploys - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public listDeploys(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).listDeploys(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing drafts for the current tenant. - * @summary List drafts - * @param {ConfigurationHubV2026ApiListDraftsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public listDrafts(requestParameters: ConfigurationHubV2026ApiListDraftsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).listDrafts(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing scheduled actions for the current tenant. - * @summary List scheduled actions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public listScheduledActions(axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).listScheduledActions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubV2026ApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public listUploadedConfigurations(requestParameters: ConfigurationHubV2026ApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubV2026ApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public updateObjectMappings(requestParameters: ConfigurationHubV2026ApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing scheduled action using JSON Patch format. - * @summary Update scheduled action - * @param {ConfigurationHubV2026ApiUpdateScheduledActionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubV2026Api - */ - public updateScheduledAction(requestParameters: ConfigurationHubV2026ApiUpdateScheduledActionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubV2026ApiFp(this.configuration).updateScheduledAction(requestParameters.scheduledActionId, requestParameters.jsonPatchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorCustomizersV2026Api - axios parameter creator - * @export - */ -export const ConnectorCustomizersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2026} connectorCustomizerCreateRequestV2026 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer: async (connectorCustomizerCreateRequestV2026: ConnectorCustomizerCreateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorCustomizerCreateRequestV2026' is not null or undefined - assertParamExists('createConnectorCustomizer', 'connectorCustomizerCreateRequestV2026', connectorCustomizerCreateRequestV2026) - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerCreateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createConnectorCustomizerVersion', 'id', id) - const localVarPath = `/connector-customizers/{id}/versions` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-customizers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2026} [connectorCustomizerUpdateRequestV2026] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer: async (id: string, connectorCustomizerUpdateRequestV2026?: ConnectorCustomizerUpdateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorCustomizer', 'id', id) - const localVarPath = `/connector-customizers/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorCustomizerUpdateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorCustomizersV2026Api - functional programming interface - * @export - */ -export const ConnectorCustomizersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorCustomizersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizerCreateRequestV2026} connectorCustomizerCreateRequestV2026 Connector customizer to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizer(connectorCustomizerCreateRequestV2026: ConnectorCustomizerCreateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizer(connectorCustomizerCreateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.createConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {string} id The id of the connector customizer. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorCustomizerVersion(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorCustomizerVersion(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.createConnectorCustomizerVersion']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {string} id ID of the connector customizer to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.deleteConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {string} id ID of the connector customizer to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCustomizer(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCustomizer(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.getConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnectorCustomizers(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnectorCustomizers(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.listConnectorCustomizers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {string} id ID of the connector customizer to update. - * @param {ConnectorCustomizerUpdateRequestV2026} [connectorCustomizerUpdateRequestV2026] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCustomizer(id: string, connectorCustomizerUpdateRequestV2026?: ConnectorCustomizerUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCustomizer(id, connectorCustomizerUpdateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorCustomizersV2026Api.putConnectorCustomizer']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorCustomizersV2026Api - factory interface - * @export - */ -export const ConnectorCustomizersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorCustomizersV2026ApiFp(configuration) - return { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2026ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnectorCustomizers(requestParameters: ConnectorCustomizersV2026ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorCustomizer operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest { - /** - * Connector customizer to create. - * @type {ConnectorCustomizerCreateRequestV2026} - * @memberof ConnectorCustomizersV2026ApiCreateConnectorCustomizer - */ - readonly connectorCustomizerCreateRequestV2026: ConnectorCustomizerCreateRequestV2026 -} - -/** - * Request parameters for createConnectorCustomizerVersion operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest - */ -export interface ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest { - /** - * The id of the connector customizer. - * @type {string} - * @memberof ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersion - */ - readonly id: string -} - -/** - * Request parameters for deleteConnectorCustomizer operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest { - /** - * ID of the connector customizer to delete. - * @type {string} - * @memberof ConnectorCustomizersV2026ApiDeleteConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for getConnectorCustomizer operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest { - /** - * ID of the connector customizer to get. - * @type {string} - * @memberof ConnectorCustomizersV2026ApiGetConnectorCustomizer - */ - readonly id: string -} - -/** - * Request parameters for listConnectorCustomizers operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiListConnectorCustomizersRequest - */ -export interface ConnectorCustomizersV2026ApiListConnectorCustomizersRequest { - /** - * 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 ConnectorCustomizersV2026ApiListConnectorCustomizers - */ - 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 ConnectorCustomizersV2026ApiListConnectorCustomizers - */ - readonly limit?: number -} - -/** - * Request parameters for putConnectorCustomizer operation in ConnectorCustomizersV2026Api. - * @export - * @interface ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest - */ -export interface ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest { - /** - * ID of the connector customizer to update. - * @type {string} - * @memberof ConnectorCustomizersV2026ApiPutConnectorCustomizer - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorCustomizerUpdateRequestV2026} - * @memberof ConnectorCustomizersV2026ApiPutConnectorCustomizer - */ - readonly connectorCustomizerUpdateRequestV2026?: ConnectorCustomizerUpdateRequestV2026 -} - -/** - * ConnectorCustomizersV2026Api - object-oriented interface - * @export - * @class ConnectorCustomizersV2026Api - * @extends {BaseAPI} - */ -export class ConnectorCustomizersV2026Api extends BaseAPI { - /** - * Create a connector customizer. - * @summary Create connector customizer - * @param {ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public createConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiCreateConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).createConnectorCustomizer(requestParameters.connectorCustomizerCreateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Creates a new version for the customizer. - * @summary Creates a connector customizer version - * @param {ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public createConnectorCustomizerVersion(requestParameters: ConnectorCustomizersV2026ApiCreateConnectorCustomizerVersionRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).createConnectorCustomizerVersion(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector customizer for the given ID. - * @summary Delete connector customizer - * @param {ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public deleteConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiDeleteConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).deleteConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets connector customizer by ID. - * @summary Get connector customizer - * @param {ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public getConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiGetConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).getConnectorCustomizer(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all connector customizers. - * @summary List all connector customizers - * @param {ConnectorCustomizersV2026ApiListConnectorCustomizersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public listConnectorCustomizers(requestParameters: ConnectorCustomizersV2026ApiListConnectorCustomizersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).listConnectorCustomizers(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. - * @summary Update connector customizer - * @param {ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorCustomizersV2026Api - */ - public putConnectorCustomizer(requestParameters: ConnectorCustomizersV2026ApiPutConnectorCustomizerRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorCustomizersV2026ApiFp(this.configuration).putConnectorCustomizer(requestParameters.id, requestParameters.connectorCustomizerUpdateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorRuleManagementV2026Api - axios parameter creator - * @export - */ -export const ConnectorRuleManagementV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2026} connectorRuleCreateRequestV2026 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule: async (connectorRuleCreateRequestV2026: ConnectorRuleCreateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectorRuleCreateRequestV2026' is not null or undefined - assertParamExists('createConnectorRule', 'connectorRuleCreateRequestV2026', connectorRuleCreateRequestV2026) - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleCreateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connector-rules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - 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 connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2026} [connectorRuleUpdateRequestV2026] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule: async (id: string, connectorRuleUpdateRequestV2026?: ConnectorRuleUpdateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putConnectorRule', 'id', id) - const localVarPath = `/connector-rules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(connectorRuleUpdateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2026} sourceCodeV2026 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule: async (sourceCodeV2026: SourceCodeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceCodeV2026' is not null or undefined - assertParamExists('testConnectorRule', 'sourceCodeV2026', sourceCodeV2026) - const localVarPath = `/connector-rules/validate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceCodeV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorRuleManagementV2026Api - functional programming interface - * @export - */ -export const ConnectorRuleManagementV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorRuleManagementV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleCreateRequestV2026} connectorRuleCreateRequestV2026 Connector rule to create. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createConnectorRule(connectorRuleCreateRequestV2026: ConnectorRuleCreateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createConnectorRule(connectorRuleCreateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.createConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {string} id ID of the connector rule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.deleteConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {string} id ID of the connector rule to get. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.getConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorRuleList(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorRuleList(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.getConnectorRuleList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {string} id ID of the connector rule to update. - * @param {ConnectorRuleUpdateRequestV2026} [connectorRuleUpdateRequestV2026] Connector rule with updated data. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorRule(id: string, connectorRuleUpdateRequestV2026?: ConnectorRuleUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorRule(id, connectorRuleUpdateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.putConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {SourceCodeV2026} sourceCodeV2026 Code to validate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectorRule(sourceCodeV2026: SourceCodeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectorRule(sourceCodeV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorRuleManagementV2026Api.testConnectorRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorRuleManagementV2026Api - factory interface - * @export - */ -export const ConnectorRuleManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorRuleManagementV2026ApiFp(configuration) - return { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createConnectorRule(requestParameters.connectorRuleCreateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2026ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorRuleList(requestParameters: ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2026ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2026ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectorRule(requestParameters.sourceCodeV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createConnectorRule operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest { - /** - * Connector rule to create. - * @type {ConnectorRuleCreateRequestV2026} - * @memberof ConnectorRuleManagementV2026ApiCreateConnectorRule - */ - readonly connectorRuleCreateRequestV2026: ConnectorRuleCreateRequestV2026 -} - -/** - * Request parameters for deleteConnectorRule operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest { - /** - * ID of the connector rule to delete. - * @type {string} - * @memberof ConnectorRuleManagementV2026ApiDeleteConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRule operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiGetConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2026ApiGetConnectorRuleRequest { - /** - * ID of the connector rule to get. - * @type {string} - * @memberof ConnectorRuleManagementV2026ApiGetConnectorRule - */ - readonly id: string -} - -/** - * Request parameters for getConnectorRuleList operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest - */ -export interface ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest { - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2026ApiGetConnectorRuleList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorRuleManagementV2026ApiGetConnectorRuleList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorRuleManagementV2026ApiGetConnectorRuleList - */ - readonly count?: boolean -} - -/** - * Request parameters for putConnectorRule operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiPutConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2026ApiPutConnectorRuleRequest { - /** - * ID of the connector rule to update. - * @type {string} - * @memberof ConnectorRuleManagementV2026ApiPutConnectorRule - */ - readonly id: string - - /** - * Connector rule with updated data. - * @type {ConnectorRuleUpdateRequestV2026} - * @memberof ConnectorRuleManagementV2026ApiPutConnectorRule - */ - readonly connectorRuleUpdateRequestV2026?: ConnectorRuleUpdateRequestV2026 -} - -/** - * Request parameters for testConnectorRule operation in ConnectorRuleManagementV2026Api. - * @export - * @interface ConnectorRuleManagementV2026ApiTestConnectorRuleRequest - */ -export interface ConnectorRuleManagementV2026ApiTestConnectorRuleRequest { - /** - * Code to validate. - * @type {SourceCodeV2026} - * @memberof ConnectorRuleManagementV2026ApiTestConnectorRule - */ - readonly sourceCodeV2026: SourceCodeV2026 -} - -/** - * ConnectorRuleManagementV2026Api - object-oriented interface - * @export - * @class ConnectorRuleManagementV2026Api - * @extends {BaseAPI} - */ -export class ConnectorRuleManagementV2026Api extends BaseAPI { - /** - * Create a connector rule from the available types. - * @summary Create connector rule - * @param {ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public createConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiCreateConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).createConnectorRule(requestParameters.connectorRuleCreateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the connector rule for the given ID. - * @summary Delete connector rule - * @param {ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public deleteConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiDeleteConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).deleteConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a connector rule by ID. - * @summary Get connector rule - * @param {ConnectorRuleManagementV2026ApiGetConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public getConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiGetConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).getConnectorRule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List existing connector rules. - * @summary List connector rules - * @param {ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public getConnectorRuleList(requestParameters: ConnectorRuleManagementV2026ApiGetConnectorRuleListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).getConnectorRuleList(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` - * @summary Update connector rule - * @param {ConnectorRuleManagementV2026ApiPutConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public putConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiPutConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).putConnectorRule(requestParameters.id, requestParameters.connectorRuleUpdateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Detect issues within the connector rule\'s code to fix and list them. - * @summary Validate connector rule - * @param {ConnectorRuleManagementV2026ApiTestConnectorRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorRuleManagementV2026Api - */ - public testConnectorRule(requestParameters: ConnectorRuleManagementV2026ApiTestConnectorRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorRuleManagementV2026ApiFp(this.configuration).testConnectorRule(requestParameters.sourceCodeV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorsV2026Api - axios parameter creator - * @export - */ -export const ConnectorsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2026} v3CreateConnectorDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector: async (v3CreateConnectorDtoV2026: V3CreateConnectorDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'v3CreateConnectorDtoV2026' is not null or undefined - assertParamExists('createCustomConnector', 'v3CreateConnectorDtoV2026', v3CreateConnectorDtoV2026) - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(v3CreateConnectorDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('deleteCustomConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector: async (scriptName: string, locale?: GetConnectorLocaleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorCorrelationConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceTemplate', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2026} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations: async (scriptName: string, locale: GetConnectorTranslationsLocaleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('getConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorCorrelationConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/correlation-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2026} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations: async (scriptName: string, locale: PutConnectorTranslationsLocaleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('putConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2026 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector: async (scriptName: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('updateConnector', 'scriptName', scriptName) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateConnector', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConnectorsV2026Api - functional programming interface - * @export - */ -export const ConnectorsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDtoV2026} v3CreateConnectorDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomConnector(v3CreateConnectorDtoV2026: V3CreateConnectorDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomConnector(v3CreateConnectorDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.createCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomConnector(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomConnector(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.deleteCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnector(scriptName: string, locale?: GetConnectorLocaleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnector(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorCorrelationConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorCorrelationConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorList(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorList(filters, limit, offset, count, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnectorList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV2026} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorTranslations(scriptName: string, locale: GetConnectorTranslationsLocaleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.getConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {File} file connector correlation config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorCorrelationConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorCorrelationConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.putConnectorCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.putConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceTemplate(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceTemplate(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.putConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV2026} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorTranslations(scriptName: string, locale: PutConnectorTranslationsLocaleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.putConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperationV2026 A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateConnector(scriptName: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnector(scriptName, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsV2026Api.updateConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorsV2026Api - factory interface - * @export - */ -export const ConnectorsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorsV2026ApiFp(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2026ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector(requestParameters: ConnectorsV2026ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomConnector(requestParameters.v3CreateConnectorDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2026ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector(requestParameters: ConnectorsV2026ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2026ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector(requestParameters: ConnectorsV2026ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2026ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorCorrelationConfig(requestParameters: ConnectorsV2026ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2026ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList(requestParameters: ConnectorsV2026ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2026ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig(requestParameters: ConnectorsV2026ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2026ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate(requestParameters: ConnectorsV2026ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2026ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations(requestParameters: ConnectorsV2026ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2026ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorCorrelationConfig(requestParameters: ConnectorsV2026ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2026ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig(requestParameters: ConnectorsV2026ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2026ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate(requestParameters: ConnectorsV2026ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2026ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations(requestParameters: ConnectorsV2026ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2026ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector(requestParameters: ConnectorsV2026ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomConnector operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiCreateCustomConnectorRequest - */ -export interface ConnectorsV2026ApiCreateCustomConnectorRequest { - /** - * - * @type {V3CreateConnectorDtoV2026} - * @memberof ConnectorsV2026ApiCreateCustomConnector - */ - readonly v3CreateConnectorDtoV2026: V3CreateConnectorDtoV2026 -} - -/** - * Request parameters for deleteCustomConnector operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiDeleteCustomConnectorRequest - */ -export interface ConnectorsV2026ApiDeleteCustomConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiDeleteCustomConnector - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnector operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorRequest - */ -export interface ConnectorsV2026ApiGetConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiGetConnector - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2026ApiGetConnector - */ - readonly locale?: GetConnectorLocaleV2026 -} - -/** - * Request parameters for getConnectorCorrelationConfig operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2026ApiGetConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiGetConnectorCorrelationConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorList operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorListRequest - */ -export interface ConnectorsV2026ApiGetConnectorListRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @type {string} - * @memberof ConnectorsV2026ApiGetConnectorList - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2026ApiGetConnectorList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsV2026ApiGetConnectorList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorsV2026ApiGetConnectorList - */ - readonly count?: boolean - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2026ApiGetConnectorList - */ - readonly locale?: GetConnectorListLocaleV2026 -} - -/** - * Request parameters for getConnectorSourceConfig operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorSourceConfigRequest - */ -export interface ConnectorsV2026ApiGetConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiGetConnectorSourceConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorSourceTemplate operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorSourceTemplateRequest - */ -export interface ConnectorsV2026ApiGetConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiGetConnectorSourceTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorTranslations operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiGetConnectorTranslationsRequest - */ -export interface ConnectorsV2026ApiGetConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiGetConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2026ApiGetConnectorTranslations - */ - readonly locale: GetConnectorTranslationsLocaleV2026 -} - -/** - * Request parameters for putConnectorCorrelationConfig operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiPutConnectorCorrelationConfigRequest - */ -export interface ConnectorsV2026ApiPutConnectorCorrelationConfigRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiPutConnectorCorrelationConfig - */ - readonly scriptName: string - - /** - * connector correlation config xml file - * @type {File} - * @memberof ConnectorsV2026ApiPutConnectorCorrelationConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceConfig operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiPutConnectorSourceConfigRequest - */ -export interface ConnectorsV2026ApiPutConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiPutConnectorSourceConfig - */ - readonly scriptName: string - - /** - * connector source config xml file - * @type {File} - * @memberof ConnectorsV2026ApiPutConnectorSourceConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceTemplate operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiPutConnectorSourceTemplateRequest - */ -export interface ConnectorsV2026ApiPutConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiPutConnectorSourceTemplate - */ - readonly scriptName: string - - /** - * connector source template xml file - * @type {File} - * @memberof ConnectorsV2026ApiPutConnectorSourceTemplate - */ - readonly file: File -} - -/** - * Request parameters for putConnectorTranslations operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiPutConnectorTranslationsRequest - */ -export interface ConnectorsV2026ApiPutConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiPutConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsV2026ApiPutConnectorTranslations - */ - readonly locale: PutConnectorTranslationsLocaleV2026 -} - -/** - * Request parameters for updateConnector operation in ConnectorsV2026Api. - * @export - * @interface ConnectorsV2026ApiUpdateConnectorRequest - */ -export interface ConnectorsV2026ApiUpdateConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsV2026ApiUpdateConnector - */ - readonly scriptName: string - - /** - * A list of connector detail update operations - * @type {Array} - * @memberof ConnectorsV2026ApiUpdateConnector - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * ConnectorsV2026Api - object-oriented interface - * @export - * @class ConnectorsV2026Api - * @extends {BaseAPI} - */ -export class ConnectorsV2026Api extends BaseAPI { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsV2026ApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public createCustomConnector(requestParameters: ConnectorsV2026ApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).createCustomConnector(requestParameters.v3CreateConnectorDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsV2026ApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public deleteCustomConnector(requestParameters: ConnectorsV2026ApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsV2026ApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnector(requestParameters: ConnectorsV2026ApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s correlation config using its script name. - * @summary Get connector correlation configuration - * @param {ConnectorsV2026ApiGetConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnectorCorrelationConfig(requestParameters: ConnectorsV2026ApiGetConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnectorCorrelationConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsV2026ApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnectorList(requestParameters: ConnectorsV2026ApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsV2026ApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnectorSourceConfig(requestParameters: ConnectorsV2026ApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsV2026ApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnectorSourceTemplate(requestParameters: ConnectorsV2026ApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsV2026ApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public getConnectorTranslations(requestParameters: ConnectorsV2026ApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s correlation config using its script name. - * @summary Update connector correlation configuration - * @param {ConnectorsV2026ApiPutConnectorCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public putConnectorCorrelationConfig(requestParameters: ConnectorsV2026ApiPutConnectorCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).putConnectorCorrelationConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsV2026ApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public putConnectorSourceConfig(requestParameters: ConnectorsV2026ApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsV2026ApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public putConnectorSourceTemplate(requestParameters: ConnectorsV2026ApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsV2026ApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public putConnectorTranslations(requestParameters: ConnectorsV2026ApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsV2026ApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsV2026Api - */ - public updateConnector(requestParameters: ConnectorsV2026ApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsV2026ApiFp(this.configuration).updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetConnectorLocaleV2026 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorLocaleV2026 = typeof GetConnectorLocaleV2026[keyof typeof GetConnectorLocaleV2026]; -/** - * @export - */ -export const GetConnectorListLocaleV2026 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorListLocaleV2026 = typeof GetConnectorListLocaleV2026[keyof typeof GetConnectorListLocaleV2026]; -/** - * @export - */ -export const GetConnectorTranslationsLocaleV2026 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorTranslationsLocaleV2026 = typeof GetConnectorTranslationsLocaleV2026[keyof typeof GetConnectorTranslationsLocaleV2026]; -/** - * @export - */ -export const PutConnectorTranslationsLocaleV2026 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type PutConnectorTranslationsLocaleV2026 = typeof PutConnectorTranslationsLocaleV2026[keyof typeof PutConnectorTranslationsLocaleV2026]; - - -/** - * CustomFormsV2026Api - axios parameter creator - * @export - */ -export const CustomFormsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2026} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition: async (body?: CreateFormDefinitionRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2026} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema: async (body?: FormDefinitionDynamicSchemaRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/forms-action-dynamic-schema`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest: async (formDefinitionID: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'formDefinitionID', formDefinitionID) - // verify required parameter 'file' is not null or undefined - assertParamExists('createFormDefinitionFileRequest', 'file', file) - const localVarPath = `/form-definitions/{formDefinitionID}/upload` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2026} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance: async (body?: CreateFormInstanceRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('deleteFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3: async (formDefinitionID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFileFromS3', 'formDefinitionID', formDefinitionID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFileFromS3', 'fileID', fileID) - const localVarPath = `/form-definitions/{formDefinitionID}/file/{fileID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey: async (formDefinitionID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('getFormDefinitionByKey', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey: async (formInstanceID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceByKey', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile: async (formInstanceID: string, fileID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('getFormInstanceFile', 'formInstanceID', formInstanceID) - // verify required parameter 'fileID' is not null or undefined - assertParamExists('getFormInstanceFile', 'fileID', fileID) - const localVarPath = `/form-instances/{formInstanceID}/file/{fileID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions: async (body?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition: async (formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('patchFormDefinition', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance: async (formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('patchFormInstance', 'formInstanceID', formInstanceID) - const localVarPath = `/form-instances/{formInstanceID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant: async (offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID: async (formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formInstanceID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formInstanceID', formInstanceID) - // verify required parameter 'formElementID' is not null or undefined - assertParamExists('searchFormElementDataByElementID', 'formElementID', formElementID) - const localVarPath = `/form-instances/{formInstanceID}/data-source/{formElementID}` - .replace(`{${"formInstanceID"}}`, encodeURIComponent(String(formInstanceID))) - .replace(`{${"formElementID"}}`, encodeURIComponent(String(formElementID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant: async (offset?: number, limit?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-instances`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/form-definitions/predefined-select-options`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2026} [formElementPreviewRequestV2026] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource: async (formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2026?: FormElementPreviewRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'formDefinitionID' is not null or undefined - assertParamExists('showPreviewDataSource', 'formDefinitionID', formDefinitionID) - const localVarPath = `/form-definitions/{formDefinitionID}/data-source` - .replace(`{${"formDefinitionID"}}`, encodeURIComponent(String(formDefinitionID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (query !== undefined) { - localVarQueryParameter['query'] = query; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(formElementPreviewRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomFormsV2026Api - functional programming interface - * @export - */ -export const CustomFormsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomFormsV2026ApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CreateFormDefinitionRequestV2026} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinition(body?: CreateFormDefinitionRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinition(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.createFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {FormDefinitionDynamicSchemaRequestV2026} [body] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionDynamicSchema(body?: FormDefinitionDynamicSchemaRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionDynamicSchema(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.createFormDefinitionDynamicSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {string} formDefinitionID FormDefinitionID String specifying FormDefinitionID - * @param {File} file File specifying the multipart - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormDefinitionFileRequest(formDefinitionID: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormDefinitionFileRequest(formDefinitionID, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.createFormDefinitionFileRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Creates a form instance. - * @param {CreateFormInstanceRequestV2026} [body] Body is the request payload to create a form instance - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createFormInstance(body?: CreateFormInstanceRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createFormInstance(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.createFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteFormDefinition(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFormDefinition(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.deleteFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.exportFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download definition file by fileid. - * @param {string} formDefinitionID FormDefinitionID Form definition ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFileFromS3(formDefinitionID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFileFromS3(formDefinitionID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.getFileFromS3']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormDefinitionByKey(formDefinitionID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormDefinitionByKey(formDefinitionID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.getFormDefinitionByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {string} formInstanceID Form instance ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceByKey(formInstanceID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceByKey(formInstanceID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.getFormInstanceByKey']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Download instance file by fileid. - * @param {string} formInstanceID FormInstanceID Form instance ID - * @param {string} fileID FileID String specifying the hashed name of the uploaded file we are retrieving. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getFormInstanceFile(formInstanceID: string, fileID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFormInstanceFile(formInstanceID, fileID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.getFormInstanceFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Import form definitions from export. - * @param {Array} [body] Body is the request payload to import form definitions - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importFormDefinitions(body?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importFormDefinitions(body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.importFormDefinitions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {string} formDefinitionID Form definition ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormDefinition(formDefinitionID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormDefinition(formDefinitionID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.patchFormDefinition']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {string} formInstanceID Form instance ID - * @param {Array<{ [key: string]: object; }>} [body] Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchFormInstance(formInstanceID: string, body?: Array<{ [key: string]: object; }>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchFormInstance(formInstanceID, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.patchFormInstance']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @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: **name, description, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormDefinitionsByTenant(offset?: number, limit?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormDefinitionsByTenant(offset, limit, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.searchFormDefinitionsByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {string} formInstanceID Form instance ID - * @param {string} formElementID Form element ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormElementDataByElementID(formInstanceID: string, formElementID: string, limit?: number, filters?: string, query?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormElementDataByElementID(formInstanceID, formElementID, limit, filters, query, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.searchFormElementDataByElementID']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **formDefinitionId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchFormInstancesByTenant(offset?: number, limit?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchFormInstancesByTenant(offset, limit, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.searchFormInstancesByTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPreDefinedSelectOptions(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.searchPreDefinedSelectOptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Preview form definition data source. - * @param {string} formDefinitionID Form definition ID - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @param {string} [query] String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @param {FormElementPreviewRequestV2026} [formElementPreviewRequestV2026] Body is the request payload to create a form definition dynamic schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showPreviewDataSource(formDefinitionID: string, limit?: number, filters?: string, query?: string, formElementPreviewRequestV2026?: FormElementPreviewRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showPreviewDataSource(formDefinitionID, limit, filters, query, formElementPreviewRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomFormsV2026Api.showPreviewDataSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomFormsV2026Api - factory interface - * @export - */ -export const CustomFormsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomFormsV2026ApiFp(configuration) - return { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2026ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinition(requestParameters: CustomFormsV2026ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormDefinitionFileRequest(requestParameters: CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2026ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createFormInstance(requestParameters: CustomFormsV2026ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createFormInstance(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2026ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteFormDefinition(requestParameters: CustomFormsV2026ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2026ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportFormDefinitionsByTenant(requestParameters: CustomFormsV2026ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2026ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFileFromS3(requestParameters: CustomFormsV2026ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2026ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormDefinitionByKey(requestParameters: CustomFormsV2026ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2026ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceByKey(requestParameters: CustomFormsV2026ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2026ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getFormInstanceFile(requestParameters: CustomFormsV2026ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2026ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importFormDefinitions(requestParameters: CustomFormsV2026ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2026ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormDefinition(requestParameters: CustomFormsV2026ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2026ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchFormInstance(requestParameters: CustomFormsV2026ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormDefinitionsByTenant(requestParameters: CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2026ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormElementDataByElementID(requestParameters: CustomFormsV2026ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2026ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchFormInstancesByTenant(requestParameters: CustomFormsV2026ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchPreDefinedSelectOptions(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2026ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showPreviewDataSource(requestParameters: CustomFormsV2026ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createFormDefinition operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiCreateFormDefinitionRequest - */ -export interface CustomFormsV2026ApiCreateFormDefinitionRequest { - /** - * Body is the request payload to create form definition request - * @type {CreateFormDefinitionRequestV2026} - * @memberof CustomFormsV2026ApiCreateFormDefinition - */ - readonly body?: CreateFormDefinitionRequestV2026 -} - -/** - * Request parameters for createFormDefinitionDynamicSchema operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest - */ -export interface CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest { - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormDefinitionDynamicSchemaRequestV2026} - * @memberof CustomFormsV2026ApiCreateFormDefinitionDynamicSchema - */ - readonly body?: FormDefinitionDynamicSchemaRequestV2026 -} - -/** - * Request parameters for createFormDefinitionFileRequest operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest - */ -export interface CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest { - /** - * FormDefinitionID String specifying FormDefinitionID - * @type {string} - * @memberof CustomFormsV2026ApiCreateFormDefinitionFileRequest - */ - readonly formDefinitionID: string - - /** - * File specifying the multipart - * @type {File} - * @memberof CustomFormsV2026ApiCreateFormDefinitionFileRequest - */ - readonly file: File -} - -/** - * Request parameters for createFormInstance operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiCreateFormInstanceRequest - */ -export interface CustomFormsV2026ApiCreateFormInstanceRequest { - /** - * Body is the request payload to create a form instance - * @type {CreateFormInstanceRequestV2026} - * @memberof CustomFormsV2026ApiCreateFormInstance - */ - readonly body?: CreateFormInstanceRequestV2026 -} - -/** - * Request parameters for deleteFormDefinition operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiDeleteFormDefinitionRequest - */ -export interface CustomFormsV2026ApiDeleteFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2026ApiDeleteFormDefinition - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for exportFormDefinitionsByTenant operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiExportFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2026ApiExportFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2026ApiExportFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2026ApiExportFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2026ApiExportFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2026ApiExportFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for getFileFromS3 operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiGetFileFromS3Request - */ -export interface CustomFormsV2026ApiGetFileFromS3Request { - /** - * FormDefinitionID Form definition ID - * @type {string} - * @memberof CustomFormsV2026ApiGetFileFromS3 - */ - readonly formDefinitionID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2026ApiGetFileFromS3 - */ - readonly fileID: string -} - -/** - * Request parameters for getFormDefinitionByKey operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiGetFormDefinitionByKeyRequest - */ -export interface CustomFormsV2026ApiGetFormDefinitionByKeyRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2026ApiGetFormDefinitionByKey - */ - readonly formDefinitionID: string -} - -/** - * Request parameters for getFormInstanceByKey operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiGetFormInstanceByKeyRequest - */ -export interface CustomFormsV2026ApiGetFormInstanceByKeyRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2026ApiGetFormInstanceByKey - */ - readonly formInstanceID: string -} - -/** - * Request parameters for getFormInstanceFile operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiGetFormInstanceFileRequest - */ -export interface CustomFormsV2026ApiGetFormInstanceFileRequest { - /** - * FormInstanceID Form instance ID - * @type {string} - * @memberof CustomFormsV2026ApiGetFormInstanceFile - */ - readonly formInstanceID: string - - /** - * FileID String specifying the hashed name of the uploaded file we are retrieving. - * @type {string} - * @memberof CustomFormsV2026ApiGetFormInstanceFile - */ - readonly fileID: string -} - -/** - * Request parameters for importFormDefinitions operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiImportFormDefinitionsRequest - */ -export interface CustomFormsV2026ApiImportFormDefinitionsRequest { - /** - * Body is the request payload to import form definitions - * @type {Array} - * @memberof CustomFormsV2026ApiImportFormDefinitions - */ - readonly body?: Array -} - -/** - * Request parameters for patchFormDefinition operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiPatchFormDefinitionRequest - */ -export interface CustomFormsV2026ApiPatchFormDefinitionRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2026ApiPatchFormDefinition - */ - readonly formDefinitionID: string - - /** - * Body is the request payload to patch a form definition, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2026ApiPatchFormDefinition - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for patchFormInstance operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiPatchFormInstanceRequest - */ -export interface CustomFormsV2026ApiPatchFormInstanceRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2026ApiPatchFormInstance - */ - readonly formInstanceID: string - - /** - * Body is the request payload to patch a form instance, check: https://jsonpatch.com - * @type {Array<{ [key: string]: object; }>} - * @memberof CustomFormsV2026ApiPatchFormInstance - */ - readonly body?: Array<{ [key: string]: object; }> -} - -/** - * Request parameters for searchFormDefinitionsByTenant operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest - */ -export interface CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2026ApiSearchFormDefinitionsByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2026ApiSearchFormDefinitionsByTenant - */ - readonly limit?: number - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormDefinitionsByTenant - */ - 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: **name, description, created, modified** - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormDefinitionsByTenant - */ - readonly sorters?: string -} - -/** - * Request parameters for searchFormElementDataByElementID operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiSearchFormElementDataByElementIDRequest - */ -export interface CustomFormsV2026ApiSearchFormElementDataByElementIDRequest { - /** - * Form instance ID - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormElementDataByElementID - */ - readonly formInstanceID: string - - /** - * Form element ID - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormElementDataByElementID - */ - readonly formElementID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2026ApiSearchFormElementDataByElementID - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormElementDataByElementID - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormElementDataByElementID - */ - readonly query?: string -} - -/** - * Request parameters for searchFormInstancesByTenant operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest - */ -export interface CustomFormsV2026ApiSearchFormInstancesByTenantRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof CustomFormsV2026ApiSearchFormInstancesByTenant - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2026ApiSearchFormInstancesByTenant - */ - readonly limit?: number - - /** - * 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: **formDefinitionId**: *eq* - * @type {string} - * @memberof CustomFormsV2026ApiSearchFormInstancesByTenant - */ - readonly filters?: string -} - -/** - * Request parameters for showPreviewDataSource operation in CustomFormsV2026Api. - * @export - * @interface CustomFormsV2026ApiShowPreviewDataSourceRequest - */ -export interface CustomFormsV2026ApiShowPreviewDataSourceRequest { - /** - * Form definition ID - * @type {string} - * @memberof CustomFormsV2026ApiShowPreviewDataSource - */ - readonly formDefinitionID: string - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof CustomFormsV2026ApiShowPreviewDataSource - */ - readonly limit?: number - - /** - * 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` - * @type {string} - * @memberof CustomFormsV2026ApiShowPreviewDataSource - */ - readonly filters?: string - - /** - * String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. - * @type {string} - * @memberof CustomFormsV2026ApiShowPreviewDataSource - */ - readonly query?: string - - /** - * Body is the request payload to create a form definition dynamic schema - * @type {FormElementPreviewRequestV2026} - * @memberof CustomFormsV2026ApiShowPreviewDataSource - */ - readonly formElementPreviewRequestV2026?: FormElementPreviewRequestV2026 -} - -/** - * CustomFormsV2026Api - object-oriented interface - * @export - * @class CustomFormsV2026Api - * @extends {BaseAPI} - */ -export class CustomFormsV2026Api extends BaseAPI { - /** - * - * @summary Creates a form definition. - * @param {CustomFormsV2026ApiCreateFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public createFormDefinition(requestParameters: CustomFormsV2026ApiCreateFormDefinitionRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).createFormDefinition(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Generate json schema dynamically. - * @param {CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public createFormDefinitionDynamicSchema(requestParameters: CustomFormsV2026ApiCreateFormDefinitionDynamicSchemaRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).createFormDefinitionDynamicSchema(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Upload new form definition file. - * @param {CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public createFormDefinitionFileRequest(requestParameters: CustomFormsV2026ApiCreateFormDefinitionFileRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).createFormDefinitionFileRequest(requestParameters.formDefinitionID, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Creates a form instance. - * @param {CustomFormsV2026ApiCreateFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public createFormInstance(requestParameters: CustomFormsV2026ApiCreateFormInstanceRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).createFormInstance(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Deletes a form definition. - * @param {CustomFormsV2026ApiDeleteFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public deleteFormDefinition(requestParameters: CustomFormsV2026ApiDeleteFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).deleteFormDefinition(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List form definitions by tenant. - * @param {CustomFormsV2026ApiExportFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public exportFormDefinitionsByTenant(requestParameters: CustomFormsV2026ApiExportFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).exportFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download definition file by fileid. - * @param {CustomFormsV2026ApiGetFileFromS3Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public getFileFromS3(requestParameters: CustomFormsV2026ApiGetFileFromS3Request, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).getFileFromS3(requestParameters.formDefinitionID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Return a form definition. - * @param {CustomFormsV2026ApiGetFormDefinitionByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public getFormDefinitionByKey(requestParameters: CustomFormsV2026ApiGetFormDefinitionByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).getFormDefinitionByKey(requestParameters.formDefinitionID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Returns a form instance. - * @param {CustomFormsV2026ApiGetFormInstanceByKeyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public getFormInstanceByKey(requestParameters: CustomFormsV2026ApiGetFormInstanceByKeyRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).getFormInstanceByKey(requestParameters.formInstanceID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Download instance file by fileid. - * @param {CustomFormsV2026ApiGetFormInstanceFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public getFormInstanceFile(requestParameters: CustomFormsV2026ApiGetFormInstanceFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).getFormInstanceFile(requestParameters.formInstanceID, requestParameters.fileID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Import form definitions from export. - * @param {CustomFormsV2026ApiImportFormDefinitionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public importFormDefinitions(requestParameters: CustomFormsV2026ApiImportFormDefinitionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).importFormDefinitions(requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formDefinitionID}` should match a form definition ID. - * @summary Patch a form definition. - * @param {CustomFormsV2026ApiPatchFormDefinitionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public patchFormDefinition(requestParameters: CustomFormsV2026ApiPatchFormDefinitionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).patchFormDefinition(requestParameters.formDefinitionID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. - * @summary Patch a form instance. - * @param {CustomFormsV2026ApiPatchFormInstanceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public patchFormInstance(requestParameters: CustomFormsV2026ApiPatchFormInstanceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).patchFormInstance(requestParameters.formInstanceID, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary Export form definitions by tenant. - * @param {CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public searchFormDefinitionsByTenant(requestParameters: CustomFormsV2026ApiSearchFormDefinitionsByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).searchFormDefinitionsByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. - * @summary Retrieves dynamic data by element. - * @param {CustomFormsV2026ApiSearchFormElementDataByElementIDRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public searchFormElementDataByElementID(requestParameters: CustomFormsV2026ApiSearchFormElementDataByElementIDRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).searchFormElementDataByElementID(requestParameters.formInstanceID, requestParameters.formElementID, requestParameters.limit, requestParameters.filters, requestParameters.query, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of form instances for the tenant. Optionally filter by form definition ID. - * @summary List form instances by tenant. - * @param {CustomFormsV2026ApiSearchFormInstancesByTenantRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public searchFormInstancesByTenant(requestParameters: CustomFormsV2026ApiSearchFormInstancesByTenantRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).searchFormInstancesByTenant(requestParameters.offset, requestParameters.limit, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * No parameters required. - * @summary List predefined select options. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public searchPreDefinedSelectOptions(axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).searchPreDefinedSelectOptions(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Preview form definition data source. - * @param {CustomFormsV2026ApiShowPreviewDataSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomFormsV2026Api - */ - public showPreviewDataSource(requestParameters: CustomFormsV2026ApiShowPreviewDataSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomFormsV2026ApiFp(this.configuration).showPreviewDataSource(requestParameters.formDefinitionID, requestParameters.limit, requestParameters.filters, requestParameters.query, requestParameters.formElementPreviewRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CustomPasswordInstructionsV2026Api - axios parameter creator - * @export - */ -export const CustomPasswordInstructionsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2026} customPasswordInstructionV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions: async (customPasswordInstructionV2026: CustomPasswordInstructionV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'customPasswordInstructionV2026' is not null or undefined - assertParamExists('createCustomPasswordInstructions', 'customPasswordInstructionV2026', customPasswordInstructionV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(customPasswordInstructionV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2026} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions: async (pageId: DeleteCustomPasswordInstructionsPageIdV2026, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('deleteCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2026} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions: async (pageId: GetCustomPasswordInstructionsPageIdV2026, locale?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'pageId' is not null or undefined - assertParamExists('getCustomPasswordInstructions', 'pageId', pageId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/custom-password-instructions/{pageId}` - .replace(`{${"pageId"}}`, encodeURIComponent(String(pageId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomPasswordInstructionsV2026Api - functional programming interface - * @export - */ -export const CustomPasswordInstructionsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomPasswordInstructionsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionV2026} customPasswordInstructionV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPasswordInstructions(customPasswordInstructionV2026: CustomPasswordInstructionV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPasswordInstructions(customPasswordInstructionV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2026Api.createCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {DeleteCustomPasswordInstructionsPageIdV2026} pageId The page ID of custom password instructions to delete. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPasswordInstructions(pageId: DeleteCustomPasswordInstructionsPageIdV2026, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2026Api.deleteCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {GetCustomPasswordInstructionsPageIdV2026} pageId The page ID of custom password instructions to query. - * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomPasswordInstructions(pageId: GetCustomPasswordInstructionsPageIdV2026, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomPasswordInstructions(pageId, locale, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomPasswordInstructionsV2026Api.getCustomPasswordInstructions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomPasswordInstructionsV2026Api - factory interface - * @export - */ -export const CustomPasswordInstructionsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomPasswordInstructionsV2026ApiFp(configuration) - return { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPasswordInstructions operation in CustomPasswordInstructionsV2026Api. - * @export - * @interface CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest { - /** - * - * @type {CustomPasswordInstructionV2026} - * @memberof CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructions - */ - readonly customPasswordInstructionV2026: CustomPasswordInstructionV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteCustomPasswordInstructions operation in CustomPasswordInstructionsV2026Api. - * @export - * @interface CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to delete. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructions - */ - readonly pageId: DeleteCustomPasswordInstructionsPageIdV2026 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCustomPasswordInstructions operation in CustomPasswordInstructionsV2026Api. - * @export - * @interface CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest - */ -export interface CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest { - /** - * The page ID of custom password instructions to query. - * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'} - * @memberof CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructions - */ - readonly pageId: GetCustomPasswordInstructionsPageIdV2026 - - /** - * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". - * @type {string} - * @memberof CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructions - */ - readonly locale?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructions - */ - readonly xSailPointExperimental?: string -} - -/** - * CustomPasswordInstructionsV2026Api - object-oriented interface - * @export - * @class CustomPasswordInstructionsV2026Api - * @extends {BaseAPI} - */ -export class CustomPasswordInstructionsV2026Api extends BaseAPI { - /** - * This API creates the custom password instructions for the specified page ID. - * @summary Create custom password instructions - * @param {CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2026Api - */ - public createCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiCreateCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2026ApiFp(this.configuration).createCustomPasswordInstructions(requestParameters.customPasswordInstructionV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API delete the custom password instructions for the specified page ID. - * @summary Delete custom password instructions by page id - * @param {CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2026Api - */ - public deleteCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiDeleteCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2026ApiFp(this.configuration).deleteCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the custom password instructions for the specified page ID. - * @summary Get custom password instructions by page id - * @param {CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomPasswordInstructionsV2026Api - */ - public getCustomPasswordInstructions(requestParameters: CustomPasswordInstructionsV2026ApiGetCustomPasswordInstructionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomPasswordInstructionsV2026ApiFp(this.configuration).getCustomPasswordInstructions(requestParameters.pageId, requestParameters.locale, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteCustomPasswordInstructionsPageIdV2026 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type DeleteCustomPasswordInstructionsPageIdV2026 = typeof DeleteCustomPasswordInstructionsPageIdV2026[keyof typeof DeleteCustomPasswordInstructionsPageIdV2026]; -/** - * @export - */ -export const GetCustomPasswordInstructionsPageIdV2026 = { - ChangePasswordEnterPassword: 'change-password:enter-password', - ChangePasswordFinish: 'change-password:finish', - FlowSelectionSelect: 'flow-selection:select', - ForgetUsernameUserEmail: 'forget-username:user-email', - MfaEnterCode: 'mfa:enter-code', - MfaEnterKba: 'mfa:enter-kba', - MfaSelect: 'mfa:select', - ResetPasswordEnterPassword: 'reset-password:enter-password', - ResetPasswordEnterUsername: 'reset-password:enter-username', - ResetPasswordFinish: 'reset-password:finish', - UnlockAccountEnterUsername: 'unlock-account:enter-username', - UnlockAccountFinish: 'unlock-account:finish' -} as const; -export type GetCustomPasswordInstructionsPageIdV2026 = typeof GetCustomPasswordInstructionsPageIdV2026[keyof typeof GetCustomPasswordInstructionsPageIdV2026]; - - -/** - * CustomUserLevelsV2026Api - axios parameter creator - * @export - */ -export const CustomUserLevelsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {UserLevelRequestV2026} userLevelRequestV2026 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomUserLevel: async (userLevelRequestV2026: UserLevelRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'userLevelRequestV2026' is not null or undefined - assertParamExists('createCustomUserLevel', 'userLevelRequestV2026', userLevelRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(userLevelRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **category**: *eq* - * @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, name, category** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllAuthorizationRightSets: async (xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/authorization-assignable-right-sets`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @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: **displayName** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevelIdentities: async (id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listUserLevelIdentities', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/user-levels/{id}/identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {ListUserLevelsDetailLevelV2026} [detailLevel] Specifies the level of detail for the user levels. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @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: **name, created, description, status, owner** - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevels: async (xSailPointExperimental?: string, detailLevel?: ListUserLevelsDetailLevelV2026, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {string} id The unique identifier of the user level to publish. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishCustomUserLevel: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('publishCustomUserLevel', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{id}/publish` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showUserLevelCounts: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('showUserLevelCounts', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/user-levels/get-identity-count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {string} id The unique identifier of the user level. - * @param {JsonPatchV2026} jsonPatchV2026 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateUserLevel: async (id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateUserLevel', 'id', id) - // verify required parameter 'jsonPatchV2026' is not null or undefined - assertParamExists('updateUserLevel', 'jsonPatchV2026', jsonPatchV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/authorization/custom-user-levels/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CustomUserLevelsV2026Api - functional programming interface - * @export - */ -export const CustomUserLevelsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CustomUserLevelsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {UserLevelRequestV2026} userLevelRequestV2026 Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomUserLevel(userLevelRequestV2026: UserLevelRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomUserLevel(userLevelRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.createCustomUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.deleteUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.getUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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: **category**: *eq* - * @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, name, category** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAllAuthorizationRightSets(xSailPointExperimental?: string, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllAuthorizationRightSets(xSailPointExperimental, filters, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.listAllAuthorizationRightSets']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {string} id The unique identifier of the user level. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {boolean} [count] If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @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: **displayName** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUserLevelIdentities(id: string, xSailPointExperimental?: string, count?: boolean, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevelIdentities(id, xSailPointExperimental, count, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.listUserLevelIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {ListUserLevelsDetailLevelV2026} [detailLevel] Specifies the level of detail for the user levels. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @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: **name, created, description, status, owner** - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUserLevels(xSailPointExperimental?: string, detailLevel?: ListUserLevelsDetailLevelV2026, filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUserLevels(xSailPointExperimental, detailLevel, filters, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.listUserLevels']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {string} id The unique identifier of the user level to publish. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async publishCustomUserLevel(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishCustomUserLevel(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.publishCustomUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {Array} requestBody List of user level ids. Max 50 identifiers can be passed in a single request. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showUserLevelCounts(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showUserLevelCounts(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.showUserLevelCounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {string} id The unique identifier of the user level. - * @param {JsonPatchV2026} jsonPatchV2026 JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateUserLevel(id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserLevel(id, jsonPatchV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CustomUserLevelsV2026Api.updateUserLevel']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CustomUserLevelsV2026Api - factory interface - * @export - */ -export const CustomUserLevelsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CustomUserLevelsV2026ApiFp(configuration) - return { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {CustomUserLevelsV2026ApiCreateCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomUserLevel(requestParameters: CustomUserLevelsV2026ApiCreateCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomUserLevel(requestParameters.userLevelRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {CustomUserLevelsV2026ApiDeleteUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUserLevel(requestParameters: CustomUserLevelsV2026ApiDeleteUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {CustomUserLevelsV2026ApiGetUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUserLevel(requestParameters: CustomUserLevelsV2026ApiGetUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAllAuthorizationRightSets(requestParameters: CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAllAuthorizationRightSets(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevelIdentities(requestParameters: CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUserLevelIdentities(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {CustomUserLevelsV2026ApiListUserLevelsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUserLevels(requestParameters: CustomUserLevelsV2026ApiListUserLevelsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUserLevels(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {CustomUserLevelsV2026ApiPublishCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishCustomUserLevel(requestParameters: CustomUserLevelsV2026ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishCustomUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {CustomUserLevelsV2026ApiShowUserLevelCountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showUserLevelCounts(requestParameters: CustomUserLevelsV2026ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.showUserLevelCounts(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {CustomUserLevelsV2026ApiUpdateUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateUserLevel(requestParameters: CustomUserLevelsV2026ApiUpdateUserLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateUserLevel(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomUserLevel operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiCreateCustomUserLevelRequest - */ -export interface CustomUserLevelsV2026ApiCreateCustomUserLevelRequest { - /** - * Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @type {UserLevelRequestV2026} - * @memberof CustomUserLevelsV2026ApiCreateCustomUserLevel - */ - readonly userLevelRequestV2026: UserLevelRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiCreateCustomUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteUserLevel operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiDeleteUserLevelRequest - */ -export interface CustomUserLevelsV2026ApiDeleteUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2026ApiDeleteUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiDeleteUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getUserLevel operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiGetUserLevelRequest - */ -export interface CustomUserLevelsV2026ApiGetUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2026ApiGetUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiGetUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listAllAuthorizationRightSets operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest - */ -export interface CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiListAllAuthorizationRightSets - */ - readonly xSailPointExperimental?: 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: **category**: *eq* - * @type {string} - * @memberof CustomUserLevelsV2026ApiListAllAuthorizationRightSets - */ - 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, name, category** - * @type {string} - * @memberof CustomUserLevelsV2026ApiListAllAuthorizationRightSets - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListAllAuthorizationRightSets - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListAllAuthorizationRightSets - */ - readonly offset?: number -} - -/** - * Request parameters for listUserLevelIdentities operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest - */ -export interface CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly xSailPointExperimental?: string - - /** - * If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. - * @type {boolean} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly count?: boolean - - /** - * 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: **displayName** - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListUserLevelIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for listUserLevels operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiListUserLevelsRequest - */ -export interface CustomUserLevelsV2026ApiListUserLevelsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - readonly xSailPointExperimental?: string - - /** - * Specifies the level of detail for the user levels. - * @type {'FULL' | 'SLIM'} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - readonly detailLevel?: ListUserLevelsDetailLevelV2026 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - 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: **name, created, description, status, owner** - * @type {string} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - readonly sorters?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CustomUserLevelsV2026ApiListUserLevels - */ - readonly offset?: number -} - -/** - * Request parameters for publishCustomUserLevel operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiPublishCustomUserLevelRequest - */ -export interface CustomUserLevelsV2026ApiPublishCustomUserLevelRequest { - /** - * The unique identifier of the user level to publish. - * @type {string} - * @memberof CustomUserLevelsV2026ApiPublishCustomUserLevel - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiPublishCustomUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for showUserLevelCounts operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiShowUserLevelCountsRequest - */ -export interface CustomUserLevelsV2026ApiShowUserLevelCountsRequest { - /** - * List of user level ids. Max 50 identifiers can be passed in a single request. - * @type {Array} - * @memberof CustomUserLevelsV2026ApiShowUserLevelCounts - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiShowUserLevelCounts - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateUserLevel operation in CustomUserLevelsV2026Api. - * @export - * @interface CustomUserLevelsV2026ApiUpdateUserLevelRequest - */ -export interface CustomUserLevelsV2026ApiUpdateUserLevelRequest { - /** - * The unique identifier of the user level. - * @type {string} - * @memberof CustomUserLevelsV2026ApiUpdateUserLevel - */ - readonly id: string - - /** - * JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. - * @type {JsonPatchV2026} - * @memberof CustomUserLevelsV2026ApiUpdateUserLevel - */ - readonly jsonPatchV2026: JsonPatchV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof CustomUserLevelsV2026ApiUpdateUserLevel - */ - readonly xSailPointExperimental?: string -} - -/** - * CustomUserLevelsV2026Api - object-oriented interface - * @export - * @class CustomUserLevelsV2026Api - * @extends {BaseAPI} - */ -export class CustomUserLevelsV2026Api extends BaseAPI { - /** - * Creates a new custom user level for the tenant. - * @summary Create a custom user level - * @param {CustomUserLevelsV2026ApiCreateCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public createCustomUserLevel(requestParameters: CustomUserLevelsV2026ApiCreateCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).createCustomUserLevel(requestParameters.userLevelRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a specific user level by its ID. - * @summary Delete a user level - * @param {CustomUserLevelsV2026ApiDeleteUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public deleteUserLevel(requestParameters: CustomUserLevelsV2026ApiDeleteUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).deleteUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches the details of a specific user level by its ID. - * @summary Retrieve a user level - * @param {CustomUserLevelsV2026ApiGetUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public getUserLevel(requestParameters: CustomUserLevelsV2026ApiGetUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).getUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a list of authorization assignable right sets for the tenant. - * @summary List all uiAssignable right sets - * @param {CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public listAllAuthorizationRightSets(requestParameters: CustomUserLevelsV2026ApiListAllAuthorizationRightSetsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).listAllAuthorizationRightSets(requestParameters.xSailPointExperimental, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of identities associated with a user level. - * @summary List user level identities - * @param {CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public listUserLevelIdentities(requestParameters: CustomUserLevelsV2026ApiListUserLevelIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).listUserLevelIdentities(requestParameters.id, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a list of user levels for the tenant. - * @summary List user levels - * @param {CustomUserLevelsV2026ApiListUserLevelsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public listUserLevels(requestParameters: CustomUserLevelsV2026ApiListUserLevelsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).listUserLevels(requestParameters.xSailPointExperimental, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Publishes a custom user level for the tenant, making it active and available. - * @summary Publish a custom user level - * @param {CustomUserLevelsV2026ApiPublishCustomUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public publishCustomUserLevel(requestParameters: CustomUserLevelsV2026ApiPublishCustomUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).publishCustomUserLevel(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of user levels along with the number of identities associated to it. - * @summary Count user levels identities - * @param {CustomUserLevelsV2026ApiShowUserLevelCountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public showUserLevelCounts(requestParameters: CustomUserLevelsV2026ApiShowUserLevelCountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).showUserLevelCounts(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the details of a specific user level using JSON Patch. - * @summary Update a user level - * @param {CustomUserLevelsV2026ApiUpdateUserLevelRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CustomUserLevelsV2026Api - */ - public updateUserLevel(requestParameters: CustomUserLevelsV2026ApiUpdateUserLevelRequest, axiosOptions?: RawAxiosRequestConfig) { - return CustomUserLevelsV2026ApiFp(this.configuration).updateUserLevel(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListUserLevelsDetailLevelV2026 = { - Full: 'FULL', - Slim: 'SLIM' -} as const; -export type ListUserLevelsDetailLevelV2026 = typeof ListUserLevelsDetailLevelV2026[keyof typeof ListUserLevelsDetailLevelV2026]; - - -/** - * DataAccessSecurityV2026Api - axios parameter creator - * @export - */ -export const DataAccessSecurityV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {number} id The unique identifier of the task to cancel. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelTask', 'id', id) - const localVarPath = `/das/tasks/cancel/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {BaseCreateApplicationRequestV2026} baseCreateApplicationRequestV2026 Request body containing the details required to create a new application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createApplication: async (baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'baseCreateApplicationRequestV2026' is not null or undefined - assertParamExists('createApplication', 'baseCreateApplicationRequestV2026', baseCreateApplicationRequestV2026) - const localVarPath = `/das/applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(baseCreateApplicationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Create a new schedule. - * @param {CreateScheduleRequestV2026} createScheduleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSchedule: async (createScheduleRequestV2026: CreateScheduleRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduleRequestV2026' is not null or undefined - assertParamExists('createSchedule', 'createScheduleRequestV2026', createScheduleRequestV2026) - const localVarPath = `/das/tasks/schedules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduleRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Assign owner to application resource. - * @param {AssignResourceOwnerRequestV2026} assignResourceOwnerRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersAssignPost: async (assignResourceOwnerRequestV2026: AssignResourceOwnerRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'assignResourceOwnerRequestV2026' is not null or undefined - assertParamExists('dasOwnersAssignPost', 'assignResourceOwnerRequestV2026', assignResourceOwnerRequestV2026) - const localVarPath = `/das/owners/assign`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(assignResourceOwnerRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List resources for owner. - * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersOwnerIdentityIdResourcesGet: async (ownerIdentityId: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ownerIdentityId' is not null or undefined - assertParamExists('dasOwnersOwnerIdentityIdResourcesGet', 'ownerIdentityId', ownerIdentityId) - const localVarPath = `/das/owners/{ownerIdentityId}/resources` - .replace(`{${"ownerIdentityId"}}`, encodeURIComponent(String(ownerIdentityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Re-elect resource owner. - * @param {ReelectRequestV2026} reelectRequestV2026 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersReelectPost: async (reelectRequestV2026: ReelectRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reelectRequestV2026' is not null or undefined - assertParamExists('dasOwnersReelectPost', 'reelectRequestV2026', reelectRequestV2026) - const localVarPath = `/das/owners/reelect`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reelectRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List owners for resource. - * @param {number} resourceId Unique identifier for the resource. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersResourcesResourceIdGet: async (resourceId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('dasOwnersResourcesResourceIdGet', 'resourceId', resourceId) - const localVarPath = `/das/owners/resources/{resourceId}` - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Reassign resource owner. - * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost: async (sourceIdentityId: string, destinationIdentityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceIdentityId' is not null or undefined - assertParamExists('dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'sourceIdentityId', sourceIdentityId) - // verify required parameter 'destinationIdentityId' is not null or undefined - assertParamExists('dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost', 'destinationIdentityId', destinationIdentityId) - const localVarPath = `/das/owners/{sourceIdentityId}/reassign/{destinationIdentityId}` - .replace(`{${"sourceIdentityId"}}`, encodeURIComponent(String(sourceIdentityId))) - .replace(`{${"destinationIdentityId"}}`, encodeURIComponent(String(destinationIdentityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {number} id The unique identifier of the application to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApplication: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteApplication', 'id', id) - const localVarPath = `/das/applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {number} id The unique identifier of the schedule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSchedule: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSchedule', 'id', id) - const localVarPath = `/das/tasks/schedules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {number} id The unique identifier of the task to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTask', 'id', id) - const localVarPath = `/das/tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {number} id The unique identifier of the application to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplication: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getApplication', 'id', id) - const localVarPath = `/das/applications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplications: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Retrieve owners per application. - * @param {number} appId The unique identifier of the application for which to retrieve owners. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOwners: async (appId: number, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'appId' is not null or undefined - assertParamExists('getOwners', 'appId', appId) - const localVarPath = `/das/owners/applications/{appId}` - .replace(`{${"appId"}}`, encodeURIComponent(String(appId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {number} id The unique identifier of the schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedule: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSchedule', 'id', id) - const localVarPath = `/das/tasks/schedules/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedules: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/tasks/schedules`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {number} id The unique identifier of the task to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTask: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTask', 'id', id) - const localVarPath = `/das/tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTasks: async (filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/das/tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {number} id The unique identifier of the application to update. - * @param {BaseCreateApplicationRequestV2026} baseCreateApplicationRequestV2026 Request body containing the updated details for the application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApplication: async (id: number, baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putApplication', 'id', id) - // verify required parameter 'baseCreateApplicationRequestV2026' is not null or undefined - assertParamExists('putApplication', 'baseCreateApplicationRequestV2026', baseCreateApplicationRequestV2026) - const localVarPath = `/das/applications/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(baseCreateApplicationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Update a schedule. - * @param {number} id The unique identifier of the schedule to update. - * @param {UpdateScheduleRequestV2026} updateScheduleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSchedule: async (id: number, updateScheduleRequestV2026: UpdateScheduleRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSchedule', 'id', id) - // verify required parameter 'updateScheduleRequestV2026' is not null or undefined - assertParamExists('putSchedule', 'updateScheduleRequestV2026', updateScheduleRequestV2026) - const localVarPath = `/das/tasks/schedules/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateScheduleRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {number} id The unique identifier of the task to rerun. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTaskRerun: async (id: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startTaskRerun', 'id', id) - const localVarPath = `/das/tasks/rerun/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DataAccessSecurityV2026Api - functional programming interface - * @export - */ -export const DataAccessSecurityV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DataAccessSecurityV2026ApiAxiosParamCreator(configuration) - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {number} id The unique identifier of the task to cancel. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.cancelTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {BaseCreateApplicationRequestV2026} baseCreateApplicationRequestV2026 Request body containing the details required to create a new application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createApplication(baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createApplication(baseCreateApplicationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.createApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Create a new schedule. - * @param {CreateScheduleRequestV2026} createScheduleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSchedule(createScheduleRequestV2026: CreateScheduleRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSchedule(createScheduleRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.createSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Assign owner to application resource. - * @param {AssignResourceOwnerRequestV2026} assignResourceOwnerRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersAssignPost(assignResourceOwnerRequestV2026: AssignResourceOwnerRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersAssignPost(assignResourceOwnerRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.dasOwnersAssignPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List resources for owner. - * @param {string} ownerIdentityId Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersOwnerIdentityIdResourcesGet(ownerIdentityId: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersOwnerIdentityIdResourcesGet(ownerIdentityId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.dasOwnersOwnerIdentityIdResourcesGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Re-elect resource owner. - * @param {ReelectRequestV2026} reelectRequestV2026 The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersReelectPost(reelectRequestV2026: ReelectRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersReelectPost(reelectRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.dasOwnersReelectPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List owners for resource. - * @param {number} resourceId Unique identifier for the resource. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersResourcesResourceIdGet(resourceId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersResourcesResourceIdGet(resourceId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.dasOwnersResourcesResourceIdGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Reassign resource owner. - * @param {string} sourceIdentityId Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @param {string} destinationIdentityId Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId: string, destinationIdentityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId, destinationIdentityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {number} id The unique identifier of the application to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteApplication(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteApplication(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.deleteApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {number} id The unique identifier of the schedule to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSchedule(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.deleteSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {number} id The unique identifier of the task to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.deleteTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {number} id The unique identifier of the application to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApplication(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApplication(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getApplications(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApplications(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Retrieve owners per application. - * @param {number} appId The unique identifier of the application for which to retrieve owners. - * @param {number} [limit] Not applicable for this endpoint. Do not use. - * @param {number} [offset] Not applicable for this endpoint. Do not use. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOwners(appId: number, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOwners(appId, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getOwners']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {number} id The unique identifier of the schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSchedule(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSchedules(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSchedules(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getSchedules']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {number} id The unique identifier of the task to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTask(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTasks(filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTasks(filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.getTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {number} id The unique identifier of the application to update. - * @param {BaseCreateApplicationRequestV2026} baseCreateApplicationRequestV2026 Request body containing the updated details for the application. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putApplication(id: number, baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putApplication(id, baseCreateApplicationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.putApplication']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Update a schedule. - * @param {number} id The unique identifier of the schedule to update. - * @param {UpdateScheduleRequestV2026} updateScheduleRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSchedule(id: number, updateScheduleRequestV2026: UpdateScheduleRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSchedule(id, updateScheduleRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.putSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {number} id The unique identifier of the task to rerun. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTaskRerun(id: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTaskRerun(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataAccessSecurityV2026Api.startTaskRerun']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DataAccessSecurityV2026Api - factory interface - * @export - */ -export const DataAccessSecurityV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DataAccessSecurityV2026ApiFp(configuration) - return { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {DataAccessSecurityV2026ApiCancelTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelTask(requestParameters: DataAccessSecurityV2026ApiCancelTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {DataAccessSecurityV2026ApiCreateApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createApplication(requestParameters: DataAccessSecurityV2026ApiCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createApplication(requestParameters.baseCreateApplicationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Create a new schedule. - * @param {DataAccessSecurityV2026ApiCreateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSchedule(requestParameters: DataAccessSecurityV2026ApiCreateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSchedule(requestParameters.createScheduleRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Assign owner to application resource. - * @param {DataAccessSecurityV2026ApiDasOwnersAssignPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersAssignPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersAssignPost(requestParameters.assignResourceOwnerRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List resources for owner. - * @param {DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.dasOwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Re-elect resource owner. - * @param {DataAccessSecurityV2026ApiDasOwnersReelectPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersReelectPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersReelectPost(requestParameters.reelectRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List owners for resource. - * @param {DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.dasOwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Reassign resource owner. - * @param {DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {DataAccessSecurityV2026ApiDeleteApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteApplication(requestParameters: DataAccessSecurityV2026ApiDeleteApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteApplication(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {DataAccessSecurityV2026ApiDeleteScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSchedule(requestParameters: DataAccessSecurityV2026ApiDeleteScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {DataAccessSecurityV2026ApiDeleteTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTask(requestParameters: DataAccessSecurityV2026ApiDeleteTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {DataAccessSecurityV2026ApiGetApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplication(requestParameters: DataAccessSecurityV2026ApiGetApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getApplication(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @param {DataAccessSecurityV2026ApiGetApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getApplications(requestParameters: DataAccessSecurityV2026ApiGetApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getApplications(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Retrieve owners per application. - * @param {DataAccessSecurityV2026ApiGetOwnersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOwners(requestParameters: DataAccessSecurityV2026ApiGetOwnersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getOwners(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {DataAccessSecurityV2026ApiGetScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedule(requestParameters: DataAccessSecurityV2026ApiGetScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @param {DataAccessSecurityV2026ApiGetSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSchedules(requestParameters: DataAccessSecurityV2026ApiGetSchedulesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSchedules(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {DataAccessSecurityV2026ApiGetTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTask(requestParameters: DataAccessSecurityV2026ApiGetTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @param {DataAccessSecurityV2026ApiGetTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTasks(requestParameters: DataAccessSecurityV2026ApiGetTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTasks(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {DataAccessSecurityV2026ApiPutApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putApplication(requestParameters: DataAccessSecurityV2026ApiPutApplicationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putApplication(requestParameters.id, requestParameters.baseCreateApplicationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Update a schedule. - * @param {DataAccessSecurityV2026ApiPutScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSchedule(requestParameters: DataAccessSecurityV2026ApiPutScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSchedule(requestParameters.id, requestParameters.updateScheduleRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {DataAccessSecurityV2026ApiStartTaskRerunRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTaskRerun(requestParameters: DataAccessSecurityV2026ApiStartTaskRerunRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startTaskRerun(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelTask operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiCancelTaskRequest - */ -export interface DataAccessSecurityV2026ApiCancelTaskRequest { - /** - * The unique identifier of the task to cancel. - * @type {number} - * @memberof DataAccessSecurityV2026ApiCancelTask - */ - readonly id: number -} - -/** - * Request parameters for createApplication operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiCreateApplicationRequest - */ -export interface DataAccessSecurityV2026ApiCreateApplicationRequest { - /** - * Request body containing the details required to create a new application. - * @type {BaseCreateApplicationRequestV2026} - * @memberof DataAccessSecurityV2026ApiCreateApplication - */ - readonly baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026 -} - -/** - * Request parameters for createSchedule operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiCreateScheduleRequest - */ -export interface DataAccessSecurityV2026ApiCreateScheduleRequest { - /** - * - * @type {CreateScheduleRequestV2026} - * @memberof DataAccessSecurityV2026ApiCreateSchedule - */ - readonly createScheduleRequestV2026: CreateScheduleRequestV2026 -} - -/** - * Request parameters for dasOwnersAssignPost operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDasOwnersAssignPostRequest - */ -export interface DataAccessSecurityV2026ApiDasOwnersAssignPostRequest { - /** - * - * @type {AssignResourceOwnerRequestV2026} - * @memberof DataAccessSecurityV2026ApiDasOwnersAssignPost - */ - readonly assignResourceOwnerRequestV2026: AssignResourceOwnerRequestV2026 -} - -/** - * Request parameters for dasOwnersOwnerIdentityIdResourcesGet operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest - */ -export interface DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest { - /** - * Unique identifier for the owner. This should be a UUID representing the owner\'s identity. - * @type {string} - * @memberof DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly ownerIdentityId: string - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGet - */ - readonly offset?: number -} - -/** - * Request parameters for dasOwnersReelectPost operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDasOwnersReelectPostRequest - */ -export interface DataAccessSecurityV2026ApiDasOwnersReelectPostRequest { - /** - * The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. - * @type {ReelectRequestV2026} - * @memberof DataAccessSecurityV2026ApiDasOwnersReelectPost - */ - readonly reelectRequestV2026: ReelectRequestV2026 -} - -/** - * Request parameters for dasOwnersResourcesResourceIdGet operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest - */ -export interface DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest { - /** - * Unique identifier for the resource. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGet - */ - readonly resourceId: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGet - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGet - */ - readonly offset?: number -} - -/** - * Request parameters for dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest - */ -export interface DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest { - /** - * Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. - * @type {string} - * @memberof DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPost - */ - readonly sourceIdentityId: string - - /** - * Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. - * @type {string} - * @memberof DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPost - */ - readonly destinationIdentityId: string -} - -/** - * Request parameters for deleteApplication operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDeleteApplicationRequest - */ -export interface DataAccessSecurityV2026ApiDeleteApplicationRequest { - /** - * The unique identifier of the application to delete. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDeleteApplication - */ - readonly id: number -} - -/** - * Request parameters for deleteSchedule operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDeleteScheduleRequest - */ -export interface DataAccessSecurityV2026ApiDeleteScheduleRequest { - /** - * The unique identifier of the schedule to delete. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDeleteSchedule - */ - readonly id: number -} - -/** - * Request parameters for deleteTask operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiDeleteTaskRequest - */ -export interface DataAccessSecurityV2026ApiDeleteTaskRequest { - /** - * The unique identifier of the task to delete. - * @type {number} - * @memberof DataAccessSecurityV2026ApiDeleteTask - */ - readonly id: number -} - -/** - * Request parameters for getApplication operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetApplicationRequest - */ -export interface DataAccessSecurityV2026ApiGetApplicationRequest { - /** - * The unique identifier of the application to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetApplication - */ - readonly id: number -} - -/** - * Request parameters for getApplications operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetApplicationsRequest - */ -export interface DataAccessSecurityV2026ApiGetApplicationsRequest { - /** - * 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: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof DataAccessSecurityV2026ApiGetApplications - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetApplications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2026ApiGetApplications - */ - readonly count?: boolean -} - -/** - * Request parameters for getOwners operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetOwnersRequest - */ -export interface DataAccessSecurityV2026ApiGetOwnersRequest { - /** - * The unique identifier of the application for which to retrieve owners. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetOwners - */ - readonly appId: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetOwners - */ - readonly limit?: number - - /** - * Not applicable for this endpoint. Do not use. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetOwners - */ - readonly offset?: number -} - -/** - * Request parameters for getSchedule operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetScheduleRequest - */ -export interface DataAccessSecurityV2026ApiGetScheduleRequest { - /** - * The unique identifier of the schedule to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetSchedule - */ - readonly id: number -} - -/** - * Request parameters for getSchedules operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetSchedulesRequest - */ -export interface DataAccessSecurityV2026ApiGetSchedulesRequest { - /** - * 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: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* - * @type {string} - * @memberof DataAccessSecurityV2026ApiGetSchedules - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetSchedules - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetSchedules - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2026ApiGetSchedules - */ - readonly count?: boolean -} - -/** - * Request parameters for getTask operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetTaskRequest - */ -export interface DataAccessSecurityV2026ApiGetTaskRequest { - /** - * The unique identifier of the task to retrieve. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetTask - */ - readonly id: number -} - -/** - * Request parameters for getTasks operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiGetTasksRequest - */ -export interface DataAccessSecurityV2026ApiGetTasksRequest { - /** - * 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: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 - * @type {string} - * @memberof DataAccessSecurityV2026ApiGetTasks - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataAccessSecurityV2026ApiGetTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataAccessSecurityV2026ApiGetTasks - */ - readonly count?: boolean -} - -/** - * Request parameters for putApplication operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiPutApplicationRequest - */ -export interface DataAccessSecurityV2026ApiPutApplicationRequest { - /** - * The unique identifier of the application to update. - * @type {number} - * @memberof DataAccessSecurityV2026ApiPutApplication - */ - readonly id: number - - /** - * Request body containing the updated details for the application. - * @type {BaseCreateApplicationRequestV2026} - * @memberof DataAccessSecurityV2026ApiPutApplication - */ - readonly baseCreateApplicationRequestV2026: BaseCreateApplicationRequestV2026 -} - -/** - * Request parameters for putSchedule operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiPutScheduleRequest - */ -export interface DataAccessSecurityV2026ApiPutScheduleRequest { - /** - * The unique identifier of the schedule to update. - * @type {number} - * @memberof DataAccessSecurityV2026ApiPutSchedule - */ - readonly id: number - - /** - * - * @type {UpdateScheduleRequestV2026} - * @memberof DataAccessSecurityV2026ApiPutSchedule - */ - readonly updateScheduleRequestV2026: UpdateScheduleRequestV2026 -} - -/** - * Request parameters for startTaskRerun operation in DataAccessSecurityV2026Api. - * @export - * @interface DataAccessSecurityV2026ApiStartTaskRerunRequest - */ -export interface DataAccessSecurityV2026ApiStartTaskRerunRequest { - /** - * The unique identifier of the task to rerun. - * @type {number} - * @memberof DataAccessSecurityV2026ApiStartTaskRerun - */ - readonly id: number -} - -/** - * DataAccessSecurityV2026Api - object-oriented interface - * @export - * @class DataAccessSecurityV2026Api - * @extends {BaseAPI} - */ -export class DataAccessSecurityV2026Api extends BaseAPI { - /** - * This end-point sends a request to cancel a task in Data Access Security. - * @summary Cancel a DAS task. - * @param {DataAccessSecurityV2026ApiCancelTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public cancelTask(requestParameters: DataAccessSecurityV2026ApiCancelTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).cancelTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint creates a new application in Data Access Security with the specified configuration. - * @summary Create application - * @param {DataAccessSecurityV2026ApiCreateApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public createApplication(requestParameters: DataAccessSecurityV2026ApiCreateApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).createApplication(requestParameters.baseCreateApplicationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Create a new schedule. - * @param {DataAccessSecurityV2026ApiCreateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public createSchedule(requestParameters: DataAccessSecurityV2026ApiCreateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).createSchedule(requestParameters.createScheduleRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Assign owner to application resource. - * @param {DataAccessSecurityV2026ApiDasOwnersAssignPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public dasOwnersAssignPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersAssignPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).dasOwnersAssignPost(requestParameters.assignResourceOwnerRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List resources for owner. - * @param {DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public dasOwnersOwnerIdentityIdResourcesGet(requestParameters: DataAccessSecurityV2026ApiDasOwnersOwnerIdentityIdResourcesGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).dasOwnersOwnerIdentityIdResourcesGet(requestParameters.ownerIdentityId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Re-elect resource owner. - * @param {DataAccessSecurityV2026ApiDasOwnersReelectPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public dasOwnersReelectPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersReelectPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).dasOwnersReelectPost(requestParameters.reelectRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List owners for resource. - * @param {DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public dasOwnersResourcesResourceIdGet(requestParameters: DataAccessSecurityV2026ApiDasOwnersResourcesResourceIdGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).dasOwnersResourcesResourceIdGet(requestParameters.resourceId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Reassign resource owner. - * @param {DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters: DataAccessSecurityV2026ApiDasOwnersSourceIdentityIdReassignDestinationIdentityIdPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).dasOwnersSourceIdentityIdReassignDestinationIdentityIdPost(requestParameters.sourceIdentityId, requestParameters.destinationIdentityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint deletes an application from Data Access Security by its unique identifier. - * @summary Delete an application by identifier. - * @param {DataAccessSecurityV2026ApiDeleteApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public deleteApplication(requestParameters: DataAccessSecurityV2026ApiDeleteApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).deleteApplication(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to delete a schedule in Data Access Security. - * @summary Delete a DAS schedule. - * @param {DataAccessSecurityV2026ApiDeleteScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public deleteSchedule(requestParameters: DataAccessSecurityV2026ApiDeleteScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).deleteSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to delete a task in Data Access Security. - * @summary Delete a DAS task. - * @param {DataAccessSecurityV2026ApiDeleteTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public deleteTask(requestParameters: DataAccessSecurityV2026ApiDeleteTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).deleteTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. - * @summary Retrieve application details by identifier. - * @param {DataAccessSecurityV2026ApiGetApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getApplication(requestParameters: DataAccessSecurityV2026ApiGetApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getApplication(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint lists all the applications in Data Access Security with optional filtering. - * @summary Search applications in DAS. - * @param {DataAccessSecurityV2026ApiGetApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getApplications(requestParameters: DataAccessSecurityV2026ApiGetApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getApplications(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Retrieve owners per application. - * @param {DataAccessSecurityV2026ApiGetOwnersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getOwners(requestParameters: DataAccessSecurityV2026ApiGetOwnersRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getOwners(requestParameters.appId, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point gets a schedule in Data Access Security. - * @summary Get a DAS schedule. - * @param {DataAccessSecurityV2026ApiGetScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getSchedule(requestParameters: DataAccessSecurityV2026ApiGetScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the schedules in Data Access Security. - * @summary List all schedules. - * @param {DataAccessSecurityV2026ApiGetSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getSchedules(requestParameters: DataAccessSecurityV2026ApiGetSchedulesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getSchedules(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point gets a task in Data Access Security. - * @summary Get a DAS task. - * @param {DataAccessSecurityV2026ApiGetTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getTask(requestParameters: DataAccessSecurityV2026ApiGetTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the tasks in Data Access Security. - * @summary Lists all DAS tasks. - * @param {DataAccessSecurityV2026ApiGetTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public getTasks(requestParameters: DataAccessSecurityV2026ApiGetTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).getTasks(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint updates an existing application in Data Access Security with the specified configuration. - * @summary Update application by identifier. - * @param {DataAccessSecurityV2026ApiPutApplicationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public putApplication(requestParameters: DataAccessSecurityV2026ApiPutApplicationRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).putApplication(requestParameters.id, requestParameters.baseCreateApplicationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Update a schedule. - * @param {DataAccessSecurityV2026ApiPutScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public putSchedule(requestParameters: DataAccessSecurityV2026ApiPutScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).putSchedule(requestParameters.id, requestParameters.updateScheduleRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point sends a request to re-run a task in Data Access Security. - * @summary Rerun a DAS task. - * @param {DataAccessSecurityV2026ApiStartTaskRerunRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataAccessSecurityV2026Api - */ - public startTaskRerun(requestParameters: DataAccessSecurityV2026ApiStartTaskRerunRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataAccessSecurityV2026ApiFp(this.configuration).startTaskRerun(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DataSegmentationV2026Api - axios parameter creator - * @export - */ -export const DataSegmentationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2026} dataSegmentV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment: async (dataSegmentV2026: DataSegmentV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'dataSegmentV2026' is not null or undefined - assertParamExists('createDataSegment', 'dataSegmentV2026', dataSegmentV2026) - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dataSegmentV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment: async (id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getDataSegment', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentIdentityMembership', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/membership/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getDataSegmentationEnabledForUser', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/user-enabled/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments: async (enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (enabled !== undefined) { - localVarQueryParameter['enabled'] = enabled; - } - - if (unique !== undefined) { - localVarQueryParameter['unique'] = unique; - } - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchDataSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment: async (requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('publishDataSegment', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/data-segments/{segmentId}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (publishAll !== undefined) { - localVarQueryParameter['publishAll'] = publishAll; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DataSegmentationV2026Api - functional programming interface - * @export - */ -export const DataSegmentationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DataSegmentationV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentV2026} dataSegmentV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDataSegment(dataSegmentV2026: DataSegmentV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDataSegment(dataSegmentV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.createDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {boolean} [published] This determines which version of the segment to delete - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDataSegment(id: string, published?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDataSegment(id, published, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.deleteDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegment(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegment(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.getDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {string} identityId The identity ID to retrieve the segments they are in. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentIdentityMembership(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentIdentityMembership(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.getDataSegmentIdentityMembership']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {string} identityId The identity ID to retrieve if segmentation is enabled for the identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDataSegmentationEnabledForUser(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDataSegmentationEnabledForUser(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.getDataSegmentationEnabledForUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {boolean} [enabled] This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @param {boolean} [unique] This returns only one record if set to true and that would be the published record if exists. - * @param {boolean} [published] This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, sw* **name**: *eq, in, sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDataSegments(enabled?: boolean, unique?: boolean, published?: boolean, limit?: number, offset?: number, count?: boolean, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDataSegments(enabled, unique, published, limit, offset, count, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.listDataSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDataSegment(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDataSegment(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.patchDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {Array} requestBody A list of segment ids that you wish to publish - * @param {boolean} [publishAll] This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async publishDataSegment(requestBody: Array, publishAll?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishDataSegment(requestBody, publishAll, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DataSegmentationV2026Api.publishDataSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DataSegmentationV2026Api - factory interface - * @export - */ -export const DataSegmentationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DataSegmentationV2026ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2026ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDataSegment(requestParameters: DataSegmentationV2026ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDataSegment(requestParameters.dataSegmentV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2026ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDataSegment(requestParameters: DataSegmentationV2026ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2026ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegment(requestParameters: DataSegmentationV2026ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2026ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDataSegments(requestParameters: DataSegmentationV2026ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2026ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDataSegment(requestParameters: DataSegmentationV2026ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2026ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - publishDataSegment(requestParameters: DataSegmentationV2026ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDataSegment operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiCreateDataSegmentRequest - */ -export interface DataSegmentationV2026ApiCreateDataSegmentRequest { - /** - * - * @type {DataSegmentV2026} - * @memberof DataSegmentationV2026ApiCreateDataSegment - */ - readonly dataSegmentV2026: DataSegmentV2026 -} - -/** - * Request parameters for deleteDataSegment operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiDeleteDataSegmentRequest - */ -export interface DataSegmentationV2026ApiDeleteDataSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof DataSegmentationV2026ApiDeleteDataSegment - */ - readonly id: string - - /** - * This determines which version of the segment to delete - * @type {boolean} - * @memberof DataSegmentationV2026ApiDeleteDataSegment - */ - readonly published?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiDeleteDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegment operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiGetDataSegmentRequest - */ -export interface DataSegmentationV2026ApiGetDataSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegment - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentIdentityMembership operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest - */ -export interface DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest { - /** - * The identity ID to retrieve the segments they are in. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegmentIdentityMembership - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegmentIdentityMembership - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getDataSegmentationEnabledForUser operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest - */ -export interface DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest { - /** - * The identity ID to retrieve if segmentation is enabled for the identity. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegmentationEnabledForUser - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiGetDataSegmentationEnabledForUser - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listDataSegments operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiListDataSegmentsRequest - */ -export interface DataSegmentationV2026ApiListDataSegmentsRequest { - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly enabled?: boolean - - /** - * This returns only one record if set to true and that would be the published record if exists. - * @type {boolean} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly unique?: boolean - - /** - * This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published - * @type {boolean} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly published?: boolean - - /** - * 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 DataSegmentationV2026ApiListDataSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - 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, in, sw* **name**: *eq, in, sw* - * @type {string} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiListDataSegments - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchDataSegment operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiPatchDataSegmentRequest - */ -export interface DataSegmentationV2026ApiPatchDataSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof DataSegmentationV2026ApiPatchDataSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled - * @type {Array} - * @memberof DataSegmentationV2026ApiPatchDataSegment - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiPatchDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for publishDataSegment operation in DataSegmentationV2026Api. - * @export - * @interface DataSegmentationV2026ApiPublishDataSegmentRequest - */ -export interface DataSegmentationV2026ApiPublishDataSegmentRequest { - /** - * A list of segment ids that you wish to publish - * @type {Array} - * @memberof DataSegmentationV2026ApiPublishDataSegment - */ - readonly requestBody: Array - - /** - * This flag decides whether you want to publish all unpublished or a list of specific segment ids - * @type {boolean} - * @memberof DataSegmentationV2026ApiPublishDataSegment - */ - readonly publishAll?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof DataSegmentationV2026ApiPublishDataSegment - */ - readonly xSailPointExperimental?: string -} - -/** - * DataSegmentationV2026Api - object-oriented interface - * @export - * @class DataSegmentationV2026Api - * @extends {BaseAPI} - */ -export class DataSegmentationV2026Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {DataSegmentationV2026ApiCreateDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public createDataSegment(requestParameters: DataSegmentationV2026ApiCreateDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).createDataSegment(requestParameters.dataSegmentV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. - * @summary Delete segment by id - * @param {DataSegmentationV2026ApiDeleteDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public deleteDataSegment(requestParameters: DataSegmentationV2026ApiDeleteDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).deleteDataSegment(requestParameters.id, requestParameters.published, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {DataSegmentationV2026ApiGetDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public getDataSegment(requestParameters: DataSegmentationV2026ApiGetDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).getDataSegment(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment membership specified by the given identity ID. - * @summary Get segmentmembership by identity id - * @param {DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public getDataSegmentIdentityMembership(requestParameters: DataSegmentationV2026ApiGetDataSegmentIdentityMembershipRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).getDataSegmentIdentityMembership(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns whether or not segmentation is enabled for the identity. - * @summary Is segmentation enabled by identity - * @param {DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public getDataSegmentationEnabledForUser(requestParameters: DataSegmentationV2026ApiGetDataSegmentationEnabledForUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).getDataSegmentationEnabledForUser(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segments - * @param {DataSegmentationV2026ApiListDataSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public listDataSegments(requestParameters: DataSegmentationV2026ApiListDataSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).listDataSegments(requestParameters.enabled, requestParameters.unique, requestParameters.published, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update segment - * @param {DataSegmentationV2026ApiPatchDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public patchDataSegment(requestParameters: DataSegmentationV2026ApiPatchDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).patchDataSegment(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will publish the segment so that it starts applying the segmentation to the desired users if enabled - * @summary Publish segment by id - * @param {DataSegmentationV2026ApiPublishDataSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DataSegmentationV2026Api - */ - public publishDataSegment(requestParameters: DataSegmentationV2026ApiPublishDataSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return DataSegmentationV2026ApiFp(this.configuration).publishDataSegment(requestParameters.requestBody, requestParameters.publishAll, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DeclassifySourceV2026Api - axios parameter creator - * @export - */ -export const DeclassifySourceV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDeclassifyMachineAccountFromSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('sendDeclassifyMachineAccountFromSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/declassify` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DeclassifySourceV2026Api - functional programming interface - * @export - */ -export const DeclassifySourceV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DeclassifySourceV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendDeclassifyMachineAccountFromSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendDeclassifyMachineAccountFromSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DeclassifySourceV2026Api.sendDeclassifyMachineAccountFromSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DeclassifySourceV2026Api - factory interface - * @export - */ -export const DeclassifySourceV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DeclassifySourceV2026ApiFp(configuration) - return { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDeclassifyMachineAccountFromSource(requestParameters: DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendDeclassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for sendDeclassifyMachineAccountFromSource operation in DeclassifySourceV2026Api. - * @export - * @interface DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest - */ -export interface DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSource - */ - readonly sourceId: string -} - -/** - * DeclassifySourceV2026Api - object-oriented interface - * @export - * @class DeclassifySourceV2026Api - * @extends {BaseAPI} - */ -export class DeclassifySourceV2026Api extends BaseAPI { - /** - * Use this API to declassify all the accounts from a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Declassify source\'s all accounts - * @param {DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DeclassifySourceV2026Api - */ - public sendDeclassifyMachineAccountFromSource(requestParameters: DeclassifySourceV2026ApiSendDeclassifyMachineAccountFromSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return DeclassifySourceV2026ApiFp(this.configuration).sendDeclassifyMachineAccountFromSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * DimensionsV2026Api - axios parameter creator - * @export - */ -export const DimensionsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2026} dimensionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension: async (roleId: string, dimensionV2026: DimensionV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('createDimension', 'roleId', roleId) - // verify required parameter 'dimensionV2026' is not null or undefined - assertParamExists('createDimension', 'dimensionV2026', dimensionV2026) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2026} dimensionBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions: async (roleId: string, dimensionBulkDeleteRequestV2026: DimensionBulkDeleteRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteBulkDimensions', 'roleId', roleId) - // verify required parameter 'dimensionBulkDeleteRequestV2026' is not null or undefined - assertParamExists('deleteBulkDimensions', 'dimensionBulkDeleteRequestV2026', dimensionBulkDeleteRequestV2026) - const localVarPath = `/roles/{roleId}/dimensions/bulk-delete` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(dimensionBulkDeleteRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('deleteDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('deleteDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension: async (roleId: string, dimensionId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimension', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('getDimensionEntitlements', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/entitlements` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles: async (roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('listDimensionAccessProfiles', 'dimensionId', dimensionId) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions: async (roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('listDimensions', 'roleId', roleId) - const localVarPath = `/roles/{roleId}/dimensions` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension: async (roleId: string, dimensionId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleId' is not null or undefined - assertParamExists('patchDimension', 'roleId', roleId) - // verify required parameter 'dimensionId' is not null or undefined - assertParamExists('patchDimension', 'dimensionId', dimensionId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchDimension', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/roles/{roleId}/dimensions/{dimensionId}` - .replace(`{${"roleId"}}`, encodeURIComponent(String(roleId))) - .replace(`{${"dimensionId"}}`, encodeURIComponent(String(dimensionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * DimensionsV2026Api - functional programming interface - * @export - */ -export const DimensionsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DimensionsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {DimensionV2026} dimensionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDimension(roleId: string, dimensionV2026: DimensionV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDimension(roleId, dimensionV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.createDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {string} roleId Parent Role Id of the dimensions. - * @param {DimensionBulkDeleteRequestV2026} dimensionBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkDimensions(roleId: string, dimensionBulkDeleteRequestV2026: DimensionBulkDeleteRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkDimensions(roleId, dimensionBulkDeleteRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.deleteBulkDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.deleteDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimension(roleId: string, dimensionId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimension(roleId, dimensionId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.getDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDimensionEntitlements(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDimensionEntitlements(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.getDimensionEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensionAccessProfiles(roleId: string, dimensionId: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensionAccessProfiles(roleId, dimensionId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.listDimensionAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listDimensions(roleId: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listDimensions(roleId, forSubadmin, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.listDimensions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {string} roleId Parent Role Id of the dimension. - * @param {string} dimensionId Id of the Dimension - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchDimension(roleId: string, dimensionId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchDimension(roleId, dimensionId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DimensionsV2026Api.patchDimension']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * DimensionsV2026Api - factory interface - * @export - */ -export const DimensionsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DimensionsV2026ApiFp(configuration) - return { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2026ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDimension(requestParameters: DimensionsV2026ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDimension(requestParameters.roleId, requestParameters.dimensionV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2026ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkDimensions(requestParameters: DimensionsV2026ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2026ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteDimension(requestParameters: DimensionsV2026ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2026ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimension(requestParameters: DimensionsV2026ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2026ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDimensionEntitlements(requestParameters: DimensionsV2026ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2026ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensionAccessProfiles(requestParameters: DimensionsV2026ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2026ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listDimensions(requestParameters: DimensionsV2026ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2026ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchDimension(requestParameters: DimensionsV2026ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDimension operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiCreateDimensionRequest - */ -export interface DimensionsV2026ApiCreateDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiCreateDimension - */ - readonly roleId: string - - /** - * - * @type {DimensionV2026} - * @memberof DimensionsV2026ApiCreateDimension - */ - readonly dimensionV2026: DimensionV2026 -} - -/** - * Request parameters for deleteBulkDimensions operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiDeleteBulkDimensionsRequest - */ -export interface DimensionsV2026ApiDeleteBulkDimensionsRequest { - /** - * Parent Role Id of the dimensions. - * @type {string} - * @memberof DimensionsV2026ApiDeleteBulkDimensions - */ - readonly roleId: string - - /** - * - * @type {DimensionBulkDeleteRequestV2026} - * @memberof DimensionsV2026ApiDeleteBulkDimensions - */ - readonly dimensionBulkDeleteRequestV2026: DimensionBulkDeleteRequestV2026 -} - -/** - * Request parameters for deleteDimension operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiDeleteDimensionRequest - */ -export interface DimensionsV2026ApiDeleteDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiDeleteDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2026ApiDeleteDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimension operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiGetDimensionRequest - */ -export interface DimensionsV2026ApiGetDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiGetDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2026ApiGetDimension - */ - readonly dimensionId: string -} - -/** - * Request parameters for getDimensionEntitlements operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiGetDimensionEntitlementsRequest - */ -export interface DimensionsV2026ApiGetDimensionEntitlementsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof DimensionsV2026ApiGetDimensionEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensionAccessProfiles operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiListDimensionAccessProfilesRequest - */ -export interface DimensionsV2026ApiListDimensionAccessProfilesRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - readonly dimensionId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2026ApiListDimensionAccessProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for listDimensions operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiListDimensionsRequest - */ -export interface DimensionsV2026ApiListDimensionsRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiListDimensions - */ - readonly roleId: string - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof DimensionsV2026ApiListDimensions - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiListDimensions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof DimensionsV2026ApiListDimensions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof DimensionsV2026ApiListDimensions - */ - 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, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - * @type {string} - * @memberof DimensionsV2026ApiListDimensions - */ - 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: **name, created, modified** - * @type {string} - * @memberof DimensionsV2026ApiListDimensions - */ - readonly sorters?: string -} - -/** - * Request parameters for patchDimension operation in DimensionsV2026Api. - * @export - * @interface DimensionsV2026ApiPatchDimensionRequest - */ -export interface DimensionsV2026ApiPatchDimensionRequest { - /** - * Parent Role Id of the dimension. - * @type {string} - * @memberof DimensionsV2026ApiPatchDimension - */ - readonly roleId: string - - /** - * Id of the Dimension - * @type {string} - * @memberof DimensionsV2026ApiPatchDimension - */ - readonly dimensionId: string - - /** - * - * @type {Array} - * @memberof DimensionsV2026ApiPatchDimension - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * DimensionsV2026Api - object-oriented interface - * @export - * @class DimensionsV2026Api - * @extends {BaseAPI} - */ -export class DimensionsV2026Api extends BaseAPI { - /** - * This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. - * @summary Create a dimension - * @param {DimensionsV2026ApiCreateDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public createDimension(requestParameters: DimensionsV2026ApiCreateDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).createDimension(requestParameters.roleId, requestParameters.dimensionV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete dimension(s) - * @param {DimensionsV2026ApiDeleteBulkDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public deleteBulkDimensions(requestParameters: DimensionsV2026ApiDeleteBulkDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).deleteBulkDimensions(requestParameters.roleId, requestParameters.dimensionBulkDeleteRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a dimension - * @param {DimensionsV2026ApiDeleteDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public deleteDimension(requestParameters: DimensionsV2026ApiDeleteDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).deleteDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a dimension under role. - * @param {DimensionsV2026ApiGetDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public getDimension(requestParameters: DimensionsV2026ApiGetDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).getDimension(requestParameters.roleId, requestParameters.dimensionId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimension\'s entitlements - * @param {DimensionsV2026ApiGetDimensionEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public getDimensionEntitlements(requestParameters: DimensionsV2026ApiGetDimensionEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).getDimensionEntitlements(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary List dimension\'s access profiles - * @param {DimensionsV2026ApiListDimensionAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public listDimensionAccessProfiles(requestParameters: DimensionsV2026ApiListDimensionAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).listDimensionAccessProfiles(requestParameters.roleId, requestParameters.dimensionId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List dimensions - * @param {DimensionsV2026ApiListDimensionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public listDimensions(requestParameters: DimensionsV2026ApiListDimensionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).listDimensions(requestParameters.roleId, requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified dimension - * @param {DimensionsV2026ApiPatchDimensionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof DimensionsV2026Api - */ - public patchDimension(requestParameters: DimensionsV2026ApiPatchDimensionRequest, axiosOptions?: RawAxiosRequestConfig) { - return DimensionsV2026ApiFp(this.configuration).patchDimension(requestParameters.roleId, requestParameters.dimensionId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * EntitlementConnectionsV2026Api - axios parameter creator - * @export - */ -export const EntitlementConnectionsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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} - */ - listEntitlementConnections: async (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlement-connections`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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 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} - */ - listEntitlementConnectionsForCurrentIdentity: async (offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlement-connections/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementConnectionById: async (connectionId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'connectionId' is not null or undefined - assertParamExists('patchEntitlementConnectionById', 'connectionId', connectionId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchEntitlementConnectionById', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/entitlement-connections/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, 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} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementConnectionByQuery: async (entitlementId: string, identityId: string, accountId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('patchEntitlementConnectionByQuery', 'entitlementId', entitlementId) - // verify required parameter 'identityId' is not null or undefined - assertParamExists('patchEntitlementConnectionByQuery', 'identityId', identityId) - // verify required parameter 'accountId' is not null or undefined - assertParamExists('patchEntitlementConnectionByQuery', 'accountId', accountId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchEntitlementConnectionByQuery', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/entitlement-connections`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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(jsonPatchOperationV2026, 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} entitlementConnectionBulkUpdateItemV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementConnectionsBulk: async (entitlementConnectionBulkUpdateItemV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementConnectionBulkUpdateItemV2026' is not null or undefined - assertParamExists('updateEntitlementConnectionsBulk', 'entitlementConnectionBulkUpdateItemV2026', entitlementConnectionBulkUpdateItemV2026) - const localVarPath = `/entitlement-connections`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementConnectionBulkUpdateItemV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * EntitlementConnectionsV2026Api - functional programming interface - * @export - */ -export const EntitlementConnectionsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = EntitlementConnectionsV2026ApiAxiosParamCreator(configuration) - return { - /** - * 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 listEntitlementConnections(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementConnections(offset, limit, count, searchAfter, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV2026Api.listEntitlementConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * 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 listEntitlementConnectionsForCurrentIdentity(offset?: number, limit?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementConnectionsForCurrentIdentity(offset, limit, count, searchAfter, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV2026Api.listEntitlementConnectionsForCurrentIdentity']?.[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} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlementConnectionById(connectionId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionById(connectionId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV2026Api.patchEntitlementConnectionById']?.[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} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlementConnectionByQuery(entitlementId: string, identityId: string, accountId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementConnectionByQuery(entitlementId, identityId, accountId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV2026Api.patchEntitlementConnectionByQuery']?.[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} entitlementConnectionBulkUpdateItemV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementConnectionsBulk(entitlementConnectionBulkUpdateItemV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementConnectionsBulk(entitlementConnectionBulkUpdateItemV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementConnectionsV2026Api.updateEntitlementConnectionsBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * EntitlementConnectionsV2026Api - factory interface - * @export - */ -export const EntitlementConnectionsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = EntitlementConnectionsV2026ApiFp(configuration) - return { - /** - * 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 {EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementConnections(requestParameters: EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementConnections(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * 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 {EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementConnectionsForCurrentIdentity(requestParameters: EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementConnectionsForCurrentIdentity(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 {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementConnectionById(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlementConnectionById(requestParameters.connectionId, requestParameters.jsonPatchOperationV2026, 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 {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementConnectionByQuery(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlementConnectionByQuery(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonPatchOperationV2026, 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 {EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementConnectionsBulk(requestParameters: EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateEntitlementConnectionsBulk(requestParameters.entitlementConnectionBulkUpdateItemV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listEntitlementConnections operation in EntitlementConnectionsV2026Api. - * @export - * @interface EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest - */ -export interface EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest { - /** - * 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnections - */ - readonly sorters?: string -} - -/** - * Request parameters for listEntitlementConnectionsForCurrentIdentity operation in EntitlementConnectionsV2026Api. - * @export - * @interface EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest - */ -export interface EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest { - /** - * 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - 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 EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentity - */ - readonly sorters?: string -} - -/** - * Request parameters for patchEntitlementConnectionById operation in EntitlementConnectionsV2026Api. - * @export - * @interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest - */ -export interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest { - /** - * Connection ID (UUID with or without hyphens). - * @type {string} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionById - */ - readonly connectionId: string - - /** - * - * @type {Array} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionById - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchEntitlementConnectionByQuery operation in EntitlementConnectionsV2026Api. - * @export - * @interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest - */ -export interface EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest { - /** - * Entitlement ID (UUID with or without hyphens). - * @type {string} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery - */ - readonly entitlementId: string - - /** - * Identity ID (UUID with or without hyphens). - * @type {string} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery - */ - readonly identityId: string - - /** - * Account ID (UUID with or without hyphens). - * @type {string} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery - */ - readonly accountId: string - - /** - * - * @type {Array} - * @memberof EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQuery - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateEntitlementConnectionsBulk operation in EntitlementConnectionsV2026Api. - * @export - * @interface EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest - */ -export interface EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest { - /** - * - * @type {Array} - * @memberof EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulk - */ - readonly entitlementConnectionBulkUpdateItemV2026: Array -} - -/** - * EntitlementConnectionsV2026Api - object-oriented interface - * @export - * @class EntitlementConnectionsV2026Api - * @extends {BaseAPI} - */ -export class EntitlementConnectionsV2026Api extends BaseAPI { - /** - * 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 {EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementConnectionsV2026Api - */ - public listEntitlementConnections(requestParameters: EntitlementConnectionsV2026ApiListEntitlementConnectionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementConnectionsV2026ApiFp(this.configuration).listEntitlementConnections(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * 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 {EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementConnectionsV2026Api - */ - public listEntitlementConnectionsForCurrentIdentity(requestParameters: EntitlementConnectionsV2026ApiListEntitlementConnectionsForCurrentIdentityRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementConnectionsV2026ApiFp(this.configuration).listEntitlementConnectionsForCurrentIdentity(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 {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementConnectionsV2026Api - */ - public patchEntitlementConnectionById(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementConnectionsV2026ApiFp(this.configuration).patchEntitlementConnectionById(requestParameters.connectionId, requestParameters.jsonPatchOperationV2026, 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 {EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementConnectionsV2026Api - */ - public patchEntitlementConnectionByQuery(requestParameters: EntitlementConnectionsV2026ApiPatchEntitlementConnectionByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementConnectionsV2026ApiFp(this.configuration).patchEntitlementConnectionByQuery(requestParameters.entitlementId, requestParameters.identityId, requestParameters.accountId, requestParameters.jsonPatchOperationV2026, 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 {EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementConnectionsV2026Api - */ - public updateEntitlementConnectionsBulk(requestParameters: EntitlementConnectionsV2026ApiUpdateEntitlementConnectionsBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementConnectionsV2026ApiFp(this.configuration).updateEntitlementConnectionsBulk(requestParameters.entitlementConnectionBulkUpdateItemV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * EntitlementsV2026Api - axios parameter creator - * @export - */ -export const EntitlementsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('createAccessModelMetadataForEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteAccessModelMetadataFromEntitlement', 'attributeValue', attributeValue) - const localVarPath = `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementRequestConfig', 'id', id) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource: async (id: string, csvFile?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsBySource', 'id', id) - const localVarPath = `/entitlements/aggregate/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (csvFile !== undefined) { - localVarFormParams.append('csvFile', csvFile as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren: async (id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementChildren', 'id', id) - const localVarPath = `/entitlements/{id}/children` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (searchAfter !== undefined) { - localVarQueryParameter['searchAfter'] = searchAfter; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents: async (id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementParents', 'id', id) - const localVarPath = `/entitlements/{id}/parents` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (searchAfter !== undefined) { - localVarQueryParameter['searchAfter'] = searchAfter; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of entitlements. Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements: async (segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (segmentedForIdentity !== undefined) { - localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - 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 (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. - * @summary Get entitlements for an account - * @param {string} accountId The account ID to get entitlements for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByAccount: async (accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('listEntitlementsByAccount', 'accountId', accountId) - const localVarPath = `/entitlements/account/{accountId}/entitlements` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (searchAfter !== undefined) { - localVarQueryParameter['searchAfter'] = searchAfter; - } - - 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, - }; - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement: async (id: string, jsonPatchOperationV2026?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchEntitlement', 'id', id) - const localVarPath = `/entitlements/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2026} entitlementRequestConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig: async (id: string, entitlementRequestConfigV2026: EntitlementRequestConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'id', id) - // verify required parameter 'entitlementRequestConfigV2026' is not null or undefined - assertParamExists('putEntitlementRequestConfig', 'entitlementRequestConfigV2026', entitlementRequestConfigV2026) - const localVarPath = `/entitlements/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementRequestConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('resetSourceEntitlements', 'id', id) - const localVarPath = `/entitlements/reset/sources/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk: async (entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementBulkUpdateRequestV2026' is not null or undefined - assertParamExists('updateEntitlementsInBulk', 'entitlementBulkUpdateRequestV2026', entitlementBulkUpdateRequestV2026) - const localVarPath = `/entitlements/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementBulkUpdateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * EntitlementsV2026Api - functional programming interface - * @export - */ -export const EntitlementsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = EntitlementsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessModelMetadataForEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataForEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.createAccessModelMetadataForEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {string} id The entitlement id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessModelMetadataFromEntitlement(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessModelMetadataFromEntitlement(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.deleteAccessModelMetadataFromEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {string} id The entitlement ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlement(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.getEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {string} id Entitlement Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementRequestConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementRequestConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.getEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {string} id Source Id - * @param {File} [csvFile] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async importEntitlementsBySource(id: string, csvFile?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsBySource(id, csvFile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.importEntitlementsBySource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildren(id, limit, offset, count, searchAfter, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlementChildren']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {string} id Entitlement Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParents(id, limit, offset, count, searchAfter, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlementParents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of entitlements. Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. - * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlements(segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, searchAfter?: string, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlements(segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, searchAfter, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. - * @summary Get entitlements for an account - * @param {string} accountId The account ID to get entitlements for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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} [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, name, created, modified, type, attribute, value, source.id, requestable** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementsByAccount(accountId: string, limit?: number, offset?: number, count?: boolean, searchAfter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByAccount(accountId, limit, offset, count, searchAfter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlementsByAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {string} id ID of the entitlement to patch - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlement(id: string, jsonPatchOperationV2026?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlement(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.patchEntitlement']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {string} id Entitlement ID - * @param {EntitlementRequestConfigV2026} entitlementRequestConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putEntitlementRequestConfig(id: string, entitlementRequestConfigV2026: EntitlementRequestConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putEntitlementRequestConfig(id, entitlementRequestConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.putEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {string} id ID of source for the entitlement reset - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetSourceEntitlements(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetSourceEntitlements(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.resetSourceEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsInBulk(entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulk(entitlementBulkUpdateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.updateEntitlementsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * EntitlementsV2026Api - factory interface - * @export - */ -export const EntitlementsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = EntitlementsV2026ApiFp(configuration) - return { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlement(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2026ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementRequestConfig(requestParameters: EntitlementsV2026ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2026ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - importEntitlementsBySource(requestParameters: EntitlementsV2026ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of entitlements. Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlements(requestParameters: EntitlementsV2026ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlements(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. - * @summary Get entitlements for an account - * @param {EntitlementsV2026ApiListEntitlementsByAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementsByAccount(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2026ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putEntitlementRequestConfig(requestParameters: EntitlementsV2026ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2026ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetSourceEntitlements(requestParameters: EntitlementsV2026ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessModelMetadataForEntitlement operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest - */ -export interface EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2026ApiCreateAccessModelMetadataForEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2026ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2026ApiCreateAccessModelMetadataForEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteAccessModelMetadataFromEntitlement operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest - */ -export interface EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest { - /** - * The entitlement id. - * @type {string} - * @memberof EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlement - */ - readonly attributeValue: string -} - -/** - * Request parameters for getEntitlement operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiGetEntitlementRequest - */ -export interface EntitlementsV2026ApiGetEntitlementRequest { - /** - * The entitlement ID - * @type {string} - * @memberof EntitlementsV2026ApiGetEntitlement - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementRequestConfig operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiGetEntitlementRequestConfigRequest - */ -export interface EntitlementsV2026ApiGetEntitlementRequestConfigRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2026ApiGetEntitlementRequestConfig - */ - readonly id: string -} - -/** - * Request parameters for importEntitlementsBySource operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiImportEntitlementsBySourceRequest - */ -export interface EntitlementsV2026ApiImportEntitlementsBySourceRequest { - /** - * Source Id - * @type {string} - * @memberof EntitlementsV2026ApiImportEntitlementsBySource - */ - readonly id: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof EntitlementsV2026ApiImportEntitlementsBySource - */ - readonly csvFile?: File -} - -/** - * Request parameters for listEntitlementChildren operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiListEntitlementChildrenRequest - */ -export interface EntitlementsV2026ApiListEntitlementChildrenRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - 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 EntitlementsV2026ApiListEntitlementChildren - */ - readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementChildren - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlementParents operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiListEntitlementParentsRequest - */ -export interface EntitlementsV2026ApiListEntitlementParentsRequest { - /** - * Entitlement Id - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - 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 EntitlementsV2026ApiListEntitlementParents - */ - readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementParents - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlements operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiListEntitlementsRequest - */ -export interface EntitlementsV2026ApiListEntitlementsRequest { - /** - * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlements - */ - readonly segmentedForIdentity?: string - - /** - * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlements - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - * @type {boolean} - * @memberof EntitlementsV2026ApiListEntitlements - */ - readonly includeUnsegmented?: boolean - - /** - * 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 EntitlementsV2026ApiListEntitlements - */ - 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 EntitlementsV2026ApiListEntitlements - */ - 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 EntitlementsV2026ApiListEntitlements - */ - 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 EntitlementsV2026ApiListEntitlements - */ - readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlements - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlements - */ - readonly filters?: string -} - -/** - * Request parameters for listEntitlementsByAccount operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiListEntitlementsByAccountRequest - */ -export interface EntitlementsV2026ApiListEntitlementsByAccountRequest { - /** - * The account ID to get entitlements for - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementsByAccount - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementsByAccount - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof EntitlementsV2026ApiListEntitlementsByAccount - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof EntitlementsV2026ApiListEntitlementsByAccount - */ - 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 EntitlementsV2026ApiListEntitlementsByAccount - */ - readonly searchAfter?: 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, name, created, modified, type, attribute, value, source.id, requestable** - * @type {string} - * @memberof EntitlementsV2026ApiListEntitlementsByAccount - */ - readonly sorters?: string -} - -/** - * Request parameters for patchEntitlement operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiPatchEntitlementRequest - */ -export interface EntitlementsV2026ApiPatchEntitlementRequest { - /** - * ID of the entitlement to patch - * @type {string} - * @memberof EntitlementsV2026ApiPatchEntitlement - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof EntitlementsV2026ApiPatchEntitlement - */ - readonly jsonPatchOperationV2026?: Array -} - -/** - * Request parameters for putEntitlementRequestConfig operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiPutEntitlementRequestConfigRequest - */ -export interface EntitlementsV2026ApiPutEntitlementRequestConfigRequest { - /** - * Entitlement ID - * @type {string} - * @memberof EntitlementsV2026ApiPutEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {EntitlementRequestConfigV2026} - * @memberof EntitlementsV2026ApiPutEntitlementRequestConfig - */ - readonly entitlementRequestConfigV2026: EntitlementRequestConfigV2026 -} - -/** - * Request parameters for resetSourceEntitlements operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiResetSourceEntitlementsRequest - */ -export interface EntitlementsV2026ApiResetSourceEntitlementsRequest { - /** - * ID of source for the entitlement reset - * @type {string} - * @memberof EntitlementsV2026ApiResetSourceEntitlements - */ - readonly id: string -} - -/** - * Request parameters for updateEntitlementsInBulk operation in EntitlementsV2026Api. - * @export - * @interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest - */ -export interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest { - /** - * - * @type {EntitlementBulkUpdateRequestV2026} - * @memberof EntitlementsV2026ApiUpdateEntitlementsInBulk - */ - readonly entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026 -} - -/** - * EntitlementsV2026Api - object-oriented interface - * @export - * @class EntitlementsV2026Api - * @extends {BaseAPI} - */ -export class EntitlementsV2026Api extends BaseAPI { - /** - * Add single Access Model Metadata to an entitlement. - * @summary Add metadata to an entitlement. - * @param {EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public createAccessModelMetadataForEntitlement(requestParameters: EntitlementsV2026ApiCreateAccessModelMetadataForEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).createAccessModelMetadataForEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove single Access Model Metadata from an entitlement. - * @summary Remove metadata from an entitlement. - * @param {EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public deleteAccessModelMetadataFromEntitlement(requestParameters: EntitlementsV2026ApiDeleteAccessModelMetadataFromEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).deleteAccessModelMetadataFromEntitlement(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an entitlement by its ID. - * @summary Get an entitlement - * @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).getEntitlement(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the entitlement request config for a specified entitlement. - * @summary Get entitlement request config - * @param {EntitlementsV2026ApiGetEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public getEntitlementRequestConfig(requestParameters: EntitlementsV2026ApiGetEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).getEntitlementRequestConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Aggregate entitlements - * @param {EntitlementsV2026ApiImportEntitlementsBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public importEntitlementsBySource(requestParameters: EntitlementsV2026ApiImportEntitlementsBySourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).importEntitlementsBySource(requestParameters.id, requestParameters.csvFile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all child entitlements of a given entitlement. - * @summary List of entitlements children - * @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all parent entitlements of a given entitlement. - * @summary List of entitlements parents - * @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of entitlements. Any authenticated token can call this API. - * @summary Gets a list of entitlements. - * @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public listEntitlements(requestParameters: EntitlementsV2026ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).listEntitlements(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. - * @summary Get entitlements for an account - * @param {EntitlementsV2026ApiListEntitlementsByAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public listEntitlementsByAccount(requestParameters: EntitlementsV2026ApiListEntitlementsByAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).listEntitlementsByAccount(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.searchAfter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - * @summary Patch an entitlement - * @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the entitlement request config for a specified entitlement. - * @summary Replace entitlement request config - * @param {EntitlementsV2026ApiPutEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public putEntitlementRequestConfig(requestParameters: EntitlementsV2026ApiPutEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).putEntitlementRequestConfig(requestParameters.id, requestParameters.entitlementRequestConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. - * @summary Reset source entitlements - * @param {EntitlementsV2026ApiResetSourceEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public resetSourceEntitlements(requestParameters: EntitlementsV2026ApiResetSourceEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).resetSourceEntitlements(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API. - * @summary Bulk update an entitlement list - * @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof EntitlementsV2026Api - */ - public updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return EntitlementsV2026ApiFp(this.configuration).updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GlobalTenantSecuritySettingsV2026Api - axios parameter creator - * @export - */ -export const GlobalTenantSecuritySettingsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2026} networkConfigurationV2026 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig: async (networkConfigurationV2026: NetworkConfigurationV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'networkConfigurationV2026' is not null or undefined - assertParamExists('createAuthOrgNetworkConfig', 'networkConfigurationV2026', networkConfigurationV2026) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(networkConfigurationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig: async (jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAuthOrgLockoutConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2026 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig: async (jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAuthOrgNetworkConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig: async (jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAuthOrgServiceProviderConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig: async (jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchAuthOrgSessionConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2026Api - functional programming interface - * @export - */ -export const GlobalTenantSecuritySettingsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GlobalTenantSecuritySettingsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfigurationV2026} networkConfigurationV2026 Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAuthOrgNetworkConfig(networkConfigurationV2026: NetworkConfigurationV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAuthOrgNetworkConfig(networkConfigurationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.createAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgLockoutConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.getAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgNetworkConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.getAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgServiceProviderConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.getAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgSessionConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.getAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgLockoutConfig(jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgLockoutConfig(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.patchAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperationV2026 A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgNetworkConfig(jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgNetworkConfig(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.patchAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgServiceProviderConfig(jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgServiceProviderConfig(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.patchAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperationV2026 A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgSessionConfig(jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgSessionConfig(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsV2026Api.patchAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GlobalTenantSecuritySettingsV2026Api - factory interface - * @export - */ -export const GlobalTenantSecuritySettingsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GlobalTenantSecuritySettingsV2026ApiFp(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgLockoutConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgNetworkConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgSessionConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2026Api. - * @export - * @interface GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest { - /** - * Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {NetworkConfigurationV2026} - * @memberof GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfig - */ - readonly networkConfigurationV2026: NetworkConfigurationV2026 -} - -/** - * Request parameters for patchAuthOrgLockoutConfig operation in GlobalTenantSecuritySettingsV2026Api. - * @export - * @interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest { - /** - * A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsV2026Api. - * @export - * @interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest { - /** - * A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchAuthOrgServiceProviderConfig operation in GlobalTenantSecuritySettingsV2026Api. - * @export - * @interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest { - /** - * A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchAuthOrgSessionConfig operation in GlobalTenantSecuritySettingsV2026Api. - * @export - * @interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest - */ -export interface GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest { - /** - * A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * GlobalTenantSecuritySettingsV2026Api - object-oriented interface - * @export - * @class GlobalTenantSecuritySettingsV2026Api - * @extends {BaseAPI} - */ -export class GlobalTenantSecuritySettingsV2026Api extends BaseAPI { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).createAuthOrgNetworkConfig(requestParameters.networkConfigurationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).getAuthOrgLockoutConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).getAuthOrgNetworkConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).getAuthOrgSessionConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsV2026Api - */ - public patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsV2026ApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsV2026ApiFp(this.configuration).patchAuthOrgSessionConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * GovernanceGroupsV2026Api - axios parameter creator - * @export - */ -export const GovernanceGroupsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2026} workgroupDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup: async (workgroupDtoV2026: WorkgroupDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupDtoV2026' is not null or undefined - assertParamExists('createWorkgroup', 'workgroupDtoV2026', workgroupDtoV2026) - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2026 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2026' is not null or undefined - assertParamExists('deleteWorkgroupMembers', 'identityPreviewResponseIdentityV2026', identityPreviewResponseIdentityV2026) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-delete` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2026} workgroupBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk: async (workgroupBulkDeleteRequestV2026: WorkgroupBulkDeleteRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupBulkDeleteRequestV2026' is not null or undefined - assertParamExists('deleteWorkgroupsInBulk', 'workgroupBulkDeleteRequestV2026', workgroupBulkDeleteRequestV2026) - const localVarPath = `/workgroups/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workgroupBulkDeleteRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listConnections', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/connections` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers: async (workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('listWorkgroupMembers', 'workgroupId', workgroupId) - const localVarPath = `/workgroups/{workgroupId}/members` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workgroups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup: async (id: string, jsonPatchOperationV2026?: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkgroup', 'id', id) - const localVarPath = `/workgroups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2026 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers: async (workgroupId: string, identityPreviewResponseIdentityV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'workgroupId' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'workgroupId', workgroupId) - // verify required parameter 'identityPreviewResponseIdentityV2026' is not null or undefined - assertParamExists('updateWorkgroupMembers', 'identityPreviewResponseIdentityV2026', identityPreviewResponseIdentityV2026) - const localVarPath = `/workgroups/{workgroupId}/members/bulk-add` - .replace(`{${"workgroupId"}}`, encodeURIComponent(String(workgroupId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewResponseIdentityV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * GovernanceGroupsV2026Api - functional programming interface - * @export - */ -export const GovernanceGroupsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GovernanceGroupsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {WorkgroupDtoV2026} workgroupDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkgroup(workgroupDtoV2026: WorkgroupDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkgroup(workgroupDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.createWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.deleteWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2026 List of identities to be removed from a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.deleteWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {WorkgroupBulkDeleteRequestV2026} workgroupBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2026: WorkgroupBulkDeleteRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkgroupsInBulk(workgroupBulkDeleteRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.deleteWorkgroupsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {string} id ID of the Governance Group - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkgroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkgroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.getWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listConnections(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.listConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {string} workgroupId ID of the Governance Group. - * @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] Note that for this API the maximum value for limit is 50. 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} [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: **name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroupMembers(workgroupId: string, offset?: number, limit?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroupMembers(workgroupId, offset, limit, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.listWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @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: **name, created, modified, id, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkgroups(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkgroups(offset, limit, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.listWorkgroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {string} id ID of the Governance Group - * @param {Array} [jsonPatchOperationV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkgroup(id: string, jsonPatchOperationV2026?: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkgroup(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.patchWorkgroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {string} workgroupId ID of the Governance Group. - * @param {Array} identityPreviewResponseIdentityV2026 List of identities to be added to a Governance Group members list. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateWorkgroupMembers(workgroupId: string, identityPreviewResponseIdentityV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkgroupMembers(workgroupId, identityPreviewResponseIdentityV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GovernanceGroupsV2026Api.updateWorkgroupMembers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GovernanceGroupsV2026Api - factory interface - * @export - */ -export const GovernanceGroupsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GovernanceGroupsV2026ApiFp(configuration) - return { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2026ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkgroup(requestParameters: GovernanceGroupsV2026ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkgroup(requestParameters.workgroupDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroup(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2026ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkgroup(requestParameters: GovernanceGroupsV2026ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2026ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listConnections(requestParameters: GovernanceGroupsV2026ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2026ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2026ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkgroups(requestParameters: GovernanceGroupsV2026ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2026ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkgroup(requestParameters: GovernanceGroupsV2026ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createWorkgroup operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiCreateWorkgroupRequest - */ -export interface GovernanceGroupsV2026ApiCreateWorkgroupRequest { - /** - * - * @type {WorkgroupDtoV2026} - * @memberof GovernanceGroupsV2026ApiCreateWorkgroup - */ - readonly workgroupDtoV2026: WorkgroupDtoV2026 -} - -/** - * Request parameters for deleteWorkgroup operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiDeleteWorkgroupRequest - */ -export interface GovernanceGroupsV2026ApiDeleteWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2026ApiDeleteWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkgroupMembers operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2026ApiDeleteWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be removed from a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2026ApiDeleteWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2026: Array -} - -/** - * Request parameters for deleteWorkgroupsInBulk operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest - */ -export interface GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest { - /** - * - * @type {WorkgroupBulkDeleteRequestV2026} - * @memberof GovernanceGroupsV2026ApiDeleteWorkgroupsInBulk - */ - readonly workgroupBulkDeleteRequestV2026: WorkgroupBulkDeleteRequestV2026 -} - -/** - * Request parameters for getWorkgroup operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiGetWorkgroupRequest - */ -export interface GovernanceGroupsV2026ApiGetWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2026ApiGetWorkgroup - */ - readonly id: string -} - -/** - * Request parameters for listConnections operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiListConnectionsRequest - */ -export interface GovernanceGroupsV2026ApiListConnectionsRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2026ApiListConnections - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2026ApiListConnections - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2026ApiListConnections - */ - 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 GovernanceGroupsV2026ApiListConnections - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2026ApiListConnections - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroupMembers operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiListWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2026ApiListWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2026ApiListWorkgroupMembers - */ - readonly workgroupId: string - - /** - * 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 GovernanceGroupsV2026ApiListWorkgroupMembers - */ - readonly offset?: number - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof GovernanceGroupsV2026ApiListWorkgroupMembers - */ - 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 GovernanceGroupsV2026ApiListWorkgroupMembers - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof GovernanceGroupsV2026ApiListWorkgroupMembers - */ - readonly sorters?: string -} - -/** - * Request parameters for listWorkgroups operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiListWorkgroupsRequest - */ -export interface GovernanceGroupsV2026ApiListWorkgroupsRequest { - /** - * 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 GovernanceGroupsV2026ApiListWorkgroups - */ - 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 GovernanceGroupsV2026ApiListWorkgroups - */ - 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 GovernanceGroupsV2026ApiListWorkgroups - */ - 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, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - * @type {string} - * @memberof GovernanceGroupsV2026ApiListWorkgroups - */ - 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: **name, created, modified, id, description** - * @type {string} - * @memberof GovernanceGroupsV2026ApiListWorkgroups - */ - readonly sorters?: string -} - -/** - * Request parameters for patchWorkgroup operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiPatchWorkgroupRequest - */ -export interface GovernanceGroupsV2026ApiPatchWorkgroupRequest { - /** - * ID of the Governance Group - * @type {string} - * @memberof GovernanceGroupsV2026ApiPatchWorkgroup - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof GovernanceGroupsV2026ApiPatchWorkgroup - */ - readonly jsonPatchOperationV2026?: Array -} - -/** - * Request parameters for updateWorkgroupMembers operation in GovernanceGroupsV2026Api. - * @export - * @interface GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest - */ -export interface GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest { - /** - * ID of the Governance Group. - * @type {string} - * @memberof GovernanceGroupsV2026ApiUpdateWorkgroupMembers - */ - readonly workgroupId: string - - /** - * List of identities to be added to a Governance Group members list. - * @type {Array} - * @memberof GovernanceGroupsV2026ApiUpdateWorkgroupMembers - */ - readonly identityPreviewResponseIdentityV2026: Array -} - -/** - * GovernanceGroupsV2026Api - object-oriented interface - * @export - * @class GovernanceGroupsV2026Api - * @extends {BaseAPI} - */ -export class GovernanceGroupsV2026Api extends BaseAPI { - /** - * This API creates a new Governance Group. - * @summary Create a new governance group. - * @param {GovernanceGroupsV2026ApiCreateWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public createWorkgroup(requestParameters: GovernanceGroupsV2026ApiCreateWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).createWorkgroup(requestParameters.workgroupDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Governance Group by its ID. - * @summary Delete a governance group - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public deleteWorkgroup(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).deleteWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** - * @summary Remove members from governance group - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public deleteWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).deleteWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk deletion of one or more Governance Groups. > If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. > If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. > If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. > If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - * @summary Delete governance group(s) - * @param {GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public deleteWorkgroupsInBulk(requestParameters: GovernanceGroupsV2026ApiDeleteWorkgroupsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).deleteWorkgroupsInBulk(requestParameters.workgroupBulkDeleteRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Governance Groups by its ID. - * @summary Get governance group by id - * @param {GovernanceGroupsV2026ApiGetWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public getWorkgroup(requestParameters: GovernanceGroupsV2026ApiGetWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).getWorkgroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of connections associated with a Governance Group. - * @summary List connections for governance group - * @param {GovernanceGroupsV2026ApiListConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public listConnections(requestParameters: GovernanceGroupsV2026ApiListConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).listConnections(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of members associated with a Governance Group. - * @summary List governance group members - * @param {GovernanceGroupsV2026ApiListWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public listWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiListWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).listWorkgroupMembers(requestParameters.workgroupId, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns list of Governance Groups - * @summary List governance groups - * @param {GovernanceGroupsV2026ApiListWorkgroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public listWorkgroups(requestParameters: GovernanceGroupsV2026ApiListWorkgroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).listWorkgroups(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner - * @summary Patch a governance group - * @param {GovernanceGroupsV2026ApiPatchWorkgroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public patchWorkgroup(requestParameters: GovernanceGroupsV2026ApiPatchWorkgroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).patchWorkgroup(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** - * @summary Add members to governance group - * @param {GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GovernanceGroupsV2026Api - */ - public updateWorkgroupMembers(requestParameters: GovernanceGroupsV2026ApiUpdateWorkgroupMembersRequest, axiosOptions?: RawAxiosRequestConfig) { - return GovernanceGroupsV2026ApiFp(this.configuration).updateWorkgroupMembers(requestParameters.workgroupId, requestParameters.identityPreviewResponseIdentityV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIAccessRequestRecommendationsV2026Api - axios parameter creator - * @export - */ -export const IAIAccessRequestRecommendationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem: async (accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2026' is not null or undefined - assertParamExists('addAccessRequestRecommendationsIgnoredItem', 'accessRequestRecommendationActionItemDtoV2026', accessRequestRecommendationActionItemDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem: async (accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2026' is not null or undefined - assertParamExists('addAccessRequestRecommendationsRequestedItem', 'accessRequestRecommendationActionItemDtoV2026', accessRequestRecommendationActionItemDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem: async (accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2026' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItem', 'accessRequestRecommendationActionItemDtoV2026', accessRequestRecommendationActionItemDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2026 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems: async (accessRequestRecommendationActionItemDtoV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationActionItemDtoV2026' is not null or undefined - assertParamExists('addAccessRequestRecommendationsViewedItems', 'accessRequestRecommendationActionItemDtoV2026', accessRequestRecommendationActionItemDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items/bulk-create`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationActionItemDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations: async (identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/ignored-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/requested-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/viewed-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2026} accessRequestRecommendationConfigDtoV2026 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig: async (accessRequestRecommendationConfigDtoV2026: AccessRequestRecommendationConfigDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestRecommendationConfigDtoV2026' is not null or undefined - assertParamExists('setAccessRequestRecommendationsConfig', 'accessRequestRecommendationConfigDtoV2026', accessRequestRecommendationConfigDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ai-access-request-recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestRecommendationConfigDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2026Api - functional programming interface - * @export - */ -export const IAIAccessRequestRecommendationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIAccessRequestRecommendationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access item to ignore for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsIgnoredItem(accessRequestRecommendationActionItemDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.addAccessRequestRecommendationsIgnoredItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access item that was requested for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsRequestedItem(accessRequestRecommendationActionItemDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.addAccessRequestRecommendationsRequestedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {AccessRequestRecommendationActionItemDtoV2026} accessRequestRecommendationActionItemDtoV2026 The recommended access that was viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItem(accessRequestRecommendationActionItemDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.addAccessRequestRecommendationsViewedItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {Array} accessRequestRecommendationActionItemDtoV2026 The recommended access items that were viewed for an identity. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAccessRequestRecommendationsViewedItems(accessRequestRecommendationActionItemDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.addAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {string} [identityId] Get access request recommendations for an identityId. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeTranslationMessages] If *true* it will populate a list of translation messages in the response. - * @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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendations(identityId?: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendations(identityId, limit, offset, count, includeTranslationMessages, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.getAccessRequestRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.getAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsIgnoredItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsIgnoredItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.getAccessRequestRecommendationsIgnoredItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsRequestedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsRequestedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.getAccessRequestRecommendationsRequestedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @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: **access.id, access.type, identityId, timestamp** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestRecommendationsViewedItems(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestRecommendationsViewedItems(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.getAccessRequestRecommendationsViewedItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {AccessRequestRecommendationConfigDtoV2026} accessRequestRecommendationConfigDtoV2026 The desired configurations for Access Request Recommender for the tenant. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2026: AccessRequestRecommendationConfigDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestRecommendationsConfig(accessRequestRecommendationConfigDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIAccessRequestRecommendationsV2026Api.setAccessRequestRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIAccessRequestRecommendationsV2026Api - factory interface - * @export - */ -export const IAIAccessRequestRecommendationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIAccessRequestRecommendationsV2026ApiFp(configuration) - return { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for addAccessRequestRecommendationsIgnoredItem operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest { - /** - * The recommended access item to ignore for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2026} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsRequestedItem operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest { - /** - * The recommended access item that was requested for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2026} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItem operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest { - /** - * The recommended access that was viewed for an identity. - * @type {AccessRequestRecommendationActionItemDtoV2026} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItem - */ - readonly accessRequestRecommendationActionItemDtoV2026: AccessRequestRecommendationActionItemDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItem - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for addAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest { - /** - * The recommended access items that were viewed for an identity. - * @type {Array} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItems - */ - readonly accessRequestRecommendationActionItemDtoV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendations operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest { - /** - * Get access request recommendations for an identityId. *me* indicates the current user. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly identityId?: string - - /** - * Max number of results to return. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly count?: boolean - - /** - * If *true* it will populate a list of translation messages in the response. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly includeTranslationMessages?: 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsIgnoredItems operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsRequestedItems operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAccessRequestRecommendationsViewedItems operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest { - /** - * 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 IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - 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: **access.id, access.type, identityId, timestamp** - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setAccessRequestRecommendationsConfig operation in IAIAccessRequestRecommendationsV2026Api. - * @export - * @interface IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest - */ -export interface IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest { - /** - * The desired configurations for Access Request Recommender for the tenant. - * @type {AccessRequestRecommendationConfigDtoV2026} - * @memberof IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfig - */ - readonly accessRequestRecommendationConfigDtoV2026: AccessRequestRecommendationConfigDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIAccessRequestRecommendationsV2026Api - object-oriented interface - * @export - * @class IAIAccessRequestRecommendationsV2026Api - * @extends {BaseAPI} - */ -export class IAIAccessRequestRecommendationsV2026Api extends BaseAPI { - /** - * This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - * @summary Ignore access request recommendation - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public addAccessRequestRecommendationsIgnoredItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsIgnoredItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).addAccessRequestRecommendationsIgnoredItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - * @summary Accept access request recommendation - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public addAccessRequestRecommendationsRequestedItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsRequestedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).addAccessRequestRecommendationsRequestedItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public addAccessRequestRecommendationsViewedItem(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).addAccessRequestRecommendationsViewedItem(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - * @summary Bulk mark viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public addAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiAddAccessRequestRecommendationsViewedItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).addAccessRequestRecommendationsViewedItems(requestParameters.accessRequestRecommendationActionItemDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - * @summary Identity access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public getAccessRequestRecommendations(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).getAccessRequestRecommendations(requestParameters.identityId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configurations for Access Request Recommender for the tenant. - * @summary Get access request recommendations config - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public getAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).getAccessRequestRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of ignored access request recommendations. - * @summary List ignored access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public getAccessRequestRecommendationsIgnoredItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsIgnoredItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).getAccessRequestRecommendationsIgnoredItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of requested access request recommendations. - * @summary List accepted access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public getAccessRequestRecommendationsRequestedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsRequestedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).getAccessRequestRecommendationsRequestedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the list of viewed access request recommendations. - * @summary List viewed access request recommendations - * @param {IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public getAccessRequestRecommendationsViewedItems(requestParameters: IAIAccessRequestRecommendationsV2026ApiGetAccessRequestRecommendationsViewedItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).getAccessRequestRecommendationsViewedItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the configurations for Access Request Recommender for the tenant. - * @summary Update access request recommendations config - * @param {IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIAccessRequestRecommendationsV2026Api - */ - public setAccessRequestRecommendationsConfig(requestParameters: IAIAccessRequestRecommendationsV2026ApiSetAccessRequestRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIAccessRequestRecommendationsV2026ApiFp(this.configuration).setAccessRequestRecommendationsConfig(requestParameters.accessRequestRecommendationConfigDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAICommonAccessV2026Api - axios parameter creator - * @export - */ -export const IAICommonAccessV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2026} commonAccessItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess: async (commonAccessItemRequestV2026: CommonAccessItemRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessItemRequestV2026' is not null or undefined - assertParamExists('createCommonAccess', 'commonAccessItemRequestV2026', commonAccessItemRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessItemRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess: async (offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2026 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk: async (commonAccessIDStatusV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'commonAccessIDStatusV2026' is not null or undefined - assertParamExists('updateCommonAccessStatusInBulk', 'commonAccessIDStatusV2026', commonAccessIDStatusV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/common-access/update-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commonAccessIDStatusV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAICommonAccessV2026Api - functional programming interface - * @export - */ -export const IAICommonAccessV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAICommonAccessV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {CommonAccessItemRequestV2026} commonAccessItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCommonAccess(commonAccessItemRequestV2026: CommonAccessItemRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCommonAccess(commonAccessItemRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2026Api.createCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @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: **access.name, status** By default the common access items are sorted by name, ascending. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCommonAccess(offset?: number, limit?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCommonAccess(offset, limit, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2026Api.getCommonAccess']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {Array} commonAccessIDStatusV2026 Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCommonAccessStatusInBulk(commonAccessIDStatusV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommonAccessStatusInBulk(commonAccessIDStatusV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAICommonAccessV2026Api.updateCommonAccessStatusInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAICommonAccessV2026Api - factory interface - * @export - */ -export const IAICommonAccessV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAICommonAccessV2026ApiFp(configuration) - return { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2026ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCommonAccess(requestParameters: IAICommonAccessV2026ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCommonAccess(requestParameters.commonAccessItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2026ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCommonAccess(requestParameters: IAICommonAccessV2026ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCommonAccess operation in IAICommonAccessV2026Api. - * @export - * @interface IAICommonAccessV2026ApiCreateCommonAccessRequest - */ -export interface IAICommonAccessV2026ApiCreateCommonAccessRequest { - /** - * - * @type {CommonAccessItemRequestV2026} - * @memberof IAICommonAccessV2026ApiCreateCommonAccess - */ - readonly commonAccessItemRequestV2026: CommonAccessItemRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2026ApiCreateCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCommonAccess operation in IAICommonAccessV2026Api. - * @export - * @interface IAICommonAccessV2026ApiGetCommonAccessRequest - */ -export interface IAICommonAccessV2026ApiGetCommonAccessRequest { - /** - * 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 IAICommonAccessV2026ApiGetCommonAccess - */ - 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 IAICommonAccessV2026ApiGetCommonAccess - */ - 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 IAICommonAccessV2026ApiGetCommonAccess - */ - 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - * @type {string} - * @memberof IAICommonAccessV2026ApiGetCommonAccess - */ - 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: **access.name, status** By default the common access items are sorted by name, ascending. - * @type {string} - * @memberof IAICommonAccessV2026ApiGetCommonAccess - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2026ApiGetCommonAccess - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateCommonAccessStatusInBulk operation in IAICommonAccessV2026Api. - * @export - * @interface IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest - */ -export interface IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest { - /** - * Confirm or deny in bulk the common access ids that are (or aren\'t) common access - * @type {Array} - * @memberof IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulk - */ - readonly commonAccessIDStatusV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulk - */ - readonly xSailPointExperimental?: string -} - -/** - * IAICommonAccessV2026Api - object-oriented interface - * @export - * @class IAICommonAccessV2026Api - * @extends {BaseAPI} - */ -export class IAICommonAccessV2026Api extends BaseAPI { - /** - * This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - * @summary Create common access items - * @param {IAICommonAccessV2026ApiCreateCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2026Api - */ - public createCommonAccess(requestParameters: IAICommonAccessV2026ApiCreateCommonAccessRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2026ApiFp(this.configuration).createCommonAccess(requestParameters.commonAccessItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - * @summary Get a paginated list of common access - * @param {IAICommonAccessV2026ApiGetCommonAccessRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2026Api - */ - public getCommonAccess(requestParameters: IAICommonAccessV2026ApiGetCommonAccessRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2026ApiFp(this.configuration).getCommonAccess(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - * @summary Bulk update common access status - * @param {IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAICommonAccessV2026Api - */ - public updateCommonAccessStatusInBulk(requestParameters: IAICommonAccessV2026ApiUpdateCommonAccessStatusInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAICommonAccessV2026ApiFp(this.configuration).updateCommonAccessStatusInBulk(requestParameters.commonAccessIDStatusV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIOutliersV2026Api - axios parameter creator - * @export - */ -export const IAIOutliersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip: async (type?: ExportOutliersZipTypeV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots: async (limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2026, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers: async (limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2026, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots: async (type?: GetLatestIdentityOutlierSnapshotsTypeV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-summaries/latest`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary: async (outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierFeatureId' is not null or undefined - assertParamExists('getOutlierContributingFeatureSummary', 'outlierFeatureId', outlierFeatureId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outlier-feature-summaries/{outlierFeatureId}` - .replace(`{${"outlierFeatureId"}}`, encodeURIComponent(String(outlierFeatureId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures: async (outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('getPeerGroupOutliersContributingFeatures', 'outlierId', outlierId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/contributing-features` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (includeTranslationMessages !== undefined) { - localVarQueryParameter['include-translation-messages'] = includeTranslationMessages; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('ignoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/ignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems: async (outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'outlierId' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'outlierId', outlierId) - // verify required parameter 'contributingFeatureName' is not null or undefined - assertParamExists('listOutliersContributingFeatureAccessItems', 'contributingFeatureName', contributingFeatureName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` - .replace(`{${"outlierId"}}`, encodeURIComponent(String(outlierId))) - .replace(`{${"contributingFeatureName"}}`, encodeURIComponent(String(contributingFeatureName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (accessType !== undefined) { - localVarQueryParameter['accessType'] = accessType; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers: async (requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('unIgnoreIdentityOutliers', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/outliers/unignore`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIOutliersV2026Api - functional programming interface - * @export - */ -export const IAIOutliersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIOutliersV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {ExportOutliersZipTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportOutliersZip(type?: ExportOutliersZipTypeV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportOutliersZip(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.exportOutliersZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutlierSnapshotsTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @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: **snapshotDate**: *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: **snapshotDate** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutlierSnapshots(limit?: number, offset?: number, type?: GetIdentityOutlierSnapshotsTypeV2026, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutlierSnapshots(limit, offset, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.getIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetIdentityOutliersTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *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: **firstDetectionDate, attributes, score** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOutliers(limit?: number, offset?: number, count?: boolean, type?: GetIdentityOutliersTypeV2026, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOutliers(limit, offset, count, type, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.getIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {GetLatestIdentityOutlierSnapshotsTypeV2026} [type] Type of the identity outliers snapshot to filter on - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLatestIdentityOutlierSnapshots(type?: GetLatestIdentityOutlierSnapshotsTypeV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestIdentityOutlierSnapshots(type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.getLatestIdentityOutlierSnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {string} outlierFeatureId Contributing feature id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOutlierContributingFeatureSummary(outlierFeatureId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOutlierContributingFeatureSummary(outlierFeatureId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.getOutlierContributingFeatureSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {string} outlierId The outlier id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [includeTranslationMessages] Whether or not to include translation messages object in returned response - * @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: **importance** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPeerGroupOutliersContributingFeatures(outlierId: string, limit?: number, offset?: number, count?: boolean, includeTranslationMessages?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliersContributingFeatures(outlierId, limit, offset, count, includeTranslationMessages, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.getPeerGroupOutliersContributingFeatures']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async ignoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.ignoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.ignoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {string} outlierId The outlier id - * @param {ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026} contributingFeatureName The name of contributing feature - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [accessType] The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @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: **displayName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOutliersContributingFeatureAccessItems(outlierId: string, contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026, limit?: number, offset?: number, count?: boolean, accessType?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOutliersContributingFeatureAccessItems(outlierId, contributingFeatureName, limit, offset, count, accessType, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.listOutliersContributingFeatureAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {Array} requestBody - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unIgnoreIdentityOutliers(requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unIgnoreIdentityOutliers(requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIOutliersV2026Api.unIgnoreIdentityOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIOutliersV2026Api - factory interface - * @export - */ -export const IAIOutliersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIOutliersV2026ApiFp(configuration) - return { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2026ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportOutliersZip(requestParameters: IAIOutliersV2026ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2026ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOutliers(requestParameters: IAIOutliersV2026ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2026ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - ignoreIdentityOutliers(requestParameters: IAIOutliersV2026ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportOutliersZip operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiExportOutliersZipRequest - */ -export interface IAIOutliersV2026ApiExportOutliersZipRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2026ApiExportOutliersZip - */ - readonly type?: ExportOutliersZipTypeV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiExportOutliersZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutlierSnapshots operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest { - /** - * 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 IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - readonly offset?: number - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - readonly type?: GetIdentityOutlierSnapshotsTypeV2026 - - /** - * 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: **snapshotDate**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - 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: **snapshotDate** - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityOutliers operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiGetIdentityOutliersRequest - */ -export interface IAIOutliersV2026ApiGetIdentityOutliersRequest { - /** - * 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 IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly count?: boolean - - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly type?: GetIdentityOutliersTypeV2026 - - /** - * 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - 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: **firstDetectionDate, attributes, score** - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiGetIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getLatestIdentityOutlierSnapshots operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest - */ -export interface IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest { - /** - * Type of the identity outliers snapshot to filter on - * @type {'LOW_SIMILARITY' | 'STRUCTURAL'} - * @memberof IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshots - */ - readonly type?: GetLatestIdentityOutlierSnapshotsTypeV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getOutlierContributingFeatureSummary operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest - */ -export interface IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest { - /** - * Contributing feature id - * @type {string} - * @memberof IAIOutliersV2026ApiGetOutlierContributingFeatureSummary - */ - readonly outlierFeatureId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiGetOutlierContributingFeatureSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPeerGroupOutliersContributingFeatures operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest - */ -export interface IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly outlierId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly count?: boolean - - /** - * Whether or not to include translation messages object in returned response - * @type {string} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly includeTranslationMessages?: 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: **importance** - * @type {string} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeatures - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for ignoreIdentityOutliers operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2026ApiIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2026ApiIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listOutliersContributingFeatureAccessItems operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest - */ -export interface IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest { - /** - * The outlier id - * @type {string} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly outlierId: string - - /** - * The name of contributing feature - * @type {'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly contributingFeatureName: ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026 - - /** - * 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 IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly count?: boolean - - /** - * The type of access item for the identity outlier contributing feature. If not provided, it returns all. - * @type {string} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly accessType?: 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: **displayName** - * @type {string} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiListOutliersContributingFeatureAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for unIgnoreIdentityOutliers operation in IAIOutliersV2026Api. - * @export - * @interface IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest - */ -export interface IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest { - /** - * - * @type {Array} - * @memberof IAIOutliersV2026ApiUnIgnoreIdentityOutliers - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIOutliersV2026ApiUnIgnoreIdentityOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIOutliersV2026Api - object-oriented interface - * @export - * @class IAIOutliersV2026Api - * @extends {BaseAPI} - */ -export class IAIOutliersV2026Api extends BaseAPI { - /** - * This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - * @summary Iai identity outliers export - * @param {IAIOutliersV2026ApiExportOutliersZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public exportOutliersZip(requestParameters: IAIOutliersV2026ApiExportOutliersZipRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).exportOutliersZip(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers summary - * @param {IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public getIdentityOutlierSnapshots(requestParameters: IAIOutliersV2026ApiGetIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).getIdentityOutlierSnapshots(requestParameters.limit, requestParameters.offset, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - * @summary Iai get identity outliers - * @param {IAIOutliersV2026ApiGetIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public getIdentityOutliers(requestParameters: IAIOutliersV2026ApiGetIdentityOutliersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).getIdentityOutliers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.type, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - * @summary Iai identity outliers latest summary - * @param {IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public getLatestIdentityOutlierSnapshots(requestParameters: IAIOutliersV2026ApiGetLatestIdentityOutlierSnapshotsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).getLatestIdentityOutlierSnapshots(requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - * @summary Get identity outlier contibuting feature summary - * @param {IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public getOutlierContributingFeatureSummary(requestParameters: IAIOutliersV2026ApiGetOutlierContributingFeatureSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).getOutlierContributingFeatureSummary(requestParameters.outlierFeatureId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - * @summary Get identity outlier\'s contibuting features - * @param {IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public getPeerGroupOutliersContributingFeatures(requestParameters: IAIOutliersV2026ApiGetPeerGroupOutliersContributingFeaturesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).getPeerGroupOutliersContributingFeatures(requestParameters.outlierId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.includeTranslationMessages, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be ignored. - * @summary Iai identity outliers ignore - * @param {IAIOutliersV2026ApiIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public ignoreIdentityOutliers(requestParameters: IAIOutliersV2026ApiIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).ignoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - * @summary Gets a list of access items associated with each identity outlier contributing feature - * @param {IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public listOutliersContributingFeatureAccessItems(requestParameters: IAIOutliersV2026ApiListOutliersContributingFeatureAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).listOutliersContributingFeatureAccessItems(requestParameters.outlierId, requestParameters.contributingFeatureName, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.accessType, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - * @summary Iai identity outliers unignore - * @param {IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIOutliersV2026Api - */ - public unIgnoreIdentityOutliers(requestParameters: IAIOutliersV2026ApiUnIgnoreIdentityOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIOutliersV2026ApiFp(this.configuration).unIgnoreIdentityOutliers(requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ExportOutliersZipTypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type ExportOutliersZipTypeV2026 = typeof ExportOutliersZipTypeV2026[keyof typeof ExportOutliersZipTypeV2026]; -/** - * @export - */ -export const GetIdentityOutlierSnapshotsTypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutlierSnapshotsTypeV2026 = typeof GetIdentityOutlierSnapshotsTypeV2026[keyof typeof GetIdentityOutlierSnapshotsTypeV2026]; -/** - * @export - */ -export const GetIdentityOutliersTypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetIdentityOutliersTypeV2026 = typeof GetIdentityOutliersTypeV2026[keyof typeof GetIdentityOutliersTypeV2026]; -/** - * @export - */ -export const GetLatestIdentityOutlierSnapshotsTypeV2026 = { - LowSimilarity: 'LOW_SIMILARITY', - Structural: 'STRUCTURAL' -} as const; -export type GetLatestIdentityOutlierSnapshotsTypeV2026 = typeof GetLatestIdentityOutlierSnapshotsTypeV2026[keyof typeof GetLatestIdentityOutlierSnapshotsTypeV2026]; -/** - * @export - */ -export const ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026 = { - RadicalEntitlementCount: 'radical_entitlement_count', - EntitlementCount: 'entitlement_count', - MaxJaccardSimilarity: 'max_jaccard_similarity', - MeanMaxBundleConcurrency: 'mean_max_bundle_concurrency', - SingleEntitlementBundleCount: 'single_entitlement_bundle_count', - PeerlessScore: 'peerless_score' -} as const; -export type ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026 = typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026[keyof typeof ListOutliersContributingFeatureAccessItemsContributingFeatureNameV2026]; - - -/** - * IAIPeerGroupStrategiesV2026Api - axios parameter creator - * @export - */ -export const IAIPeerGroupStrategiesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2026} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers: async (strategy: GetPeerGroupOutliersStrategyV2026, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'strategy' is not null or undefined - assertParamExists('getPeerGroupOutliers', 'strategy', strategy) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/peer-group-strategies/{strategy}/identity-outliers` - .replace(`{${"strategy"}}`, encodeURIComponent(String(strategy))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2026Api - functional programming interface - * @export - */ -export const IAIPeerGroupStrategiesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIPeerGroupStrategiesV2026ApiAxiosParamCreator(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {GetPeerGroupOutliersStrategyV2026} strategy The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getPeerGroupOutliers(strategy: GetPeerGroupOutliersStrategyV2026, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPeerGroupOutliers(strategy, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIPeerGroupStrategiesV2026Api.getPeerGroupOutliers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIPeerGroupStrategiesV2026Api - factory interface - * @export - */ -export const IAIPeerGroupStrategiesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIPeerGroupStrategiesV2026ApiFp(configuration) - return { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPeerGroupOutliers operation in IAIPeerGroupStrategiesV2026Api. - * @export - * @interface IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest - */ -export interface IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest { - /** - * The strategy used to create peer groups. Currently, \'entitlement\' is supported. - * @type {'entitlement'} - * @memberof IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliers - */ - readonly strategy: GetPeerGroupOutliersStrategyV2026 - - /** - * 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 IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliers - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliers - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIPeerGroupStrategiesV2026Api - object-oriented interface - * @export - * @class IAIPeerGroupStrategiesV2026Api - * @extends {BaseAPI} - */ -export class IAIPeerGroupStrategiesV2026Api extends BaseAPI { - /** - * -- Deprecated : See \'IAI Outliers\' This API will be used by Identity Governance systems to identify identities that are not included in an organization\'s peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - * @summary Identity outliers list - * @param {IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof IAIPeerGroupStrategiesV2026Api - */ - public getPeerGroupOutliers(requestParameters: IAIPeerGroupStrategiesV2026ApiGetPeerGroupOutliersRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIPeerGroupStrategiesV2026ApiFp(this.configuration).getPeerGroupOutliers(requestParameters.strategy, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetPeerGroupOutliersStrategyV2026 = { - Entitlement: 'entitlement' -} as const; -export type GetPeerGroupOutliersStrategyV2026 = typeof GetPeerGroupOutliersStrategyV2026[keyof typeof GetPeerGroupOutliersStrategyV2026]; - - -/** - * IAIRecommendationsV2026Api - axios parameter creator - * @export - */ -export const IAIRecommendationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2026} recommendationRequestDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations: async (recommendationRequestDtoV2026: RecommendationRequestDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationRequestDtoV2026' is not null or undefined - assertParamExists('getRecommendations', 'recommendationRequestDtoV2026', recommendationRequestDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/request`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationRequestDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2026} recommendationConfigDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig: async (recommendationConfigDtoV2026: RecommendationConfigDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'recommendationConfigDtoV2026' is not null or undefined - assertParamExists('updateRecommendationsConfig', 'recommendationConfigDtoV2026', recommendationConfigDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/recommendations/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(recommendationConfigDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRecommendationsV2026Api - functional programming interface - * @export - */ -export const IAIRecommendationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRecommendationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {RecommendationRequestDtoV2026} recommendationRequestDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendations(recommendationRequestDtoV2026: RecommendationRequestDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendations(recommendationRequestDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2026Api.getRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRecommendationsConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRecommendationsConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2026Api.getRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {RecommendationConfigDtoV2026} recommendationConfigDtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRecommendationsConfig(recommendationConfigDtoV2026: RecommendationConfigDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRecommendationsConfig(recommendationConfigDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRecommendationsV2026Api.updateRecommendationsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRecommendationsV2026Api - factory interface - * @export - */ -export const IAIRecommendationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRecommendationsV2026ApiFp(configuration) - return { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2026ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendations(requestParameters: IAIRecommendationsV2026ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendations(requestParameters.recommendationRequestDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2026ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRecommendationsConfig(requestParameters: IAIRecommendationsV2026ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRecommendationsConfig(requestParameters: IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getRecommendations operation in IAIRecommendationsV2026Api. - * @export - * @interface IAIRecommendationsV2026ApiGetRecommendationsRequest - */ -export interface IAIRecommendationsV2026ApiGetRecommendationsRequest { - /** - * - * @type {RecommendationRequestDtoV2026} - * @memberof IAIRecommendationsV2026ApiGetRecommendations - */ - readonly recommendationRequestDtoV2026: RecommendationRequestDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2026ApiGetRecommendations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRecommendationsConfig operation in IAIRecommendationsV2026Api. - * @export - * @interface IAIRecommendationsV2026ApiGetRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2026ApiGetRecommendationsConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2026ApiGetRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateRecommendationsConfig operation in IAIRecommendationsV2026Api. - * @export - * @interface IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest - */ -export interface IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest { - /** - * - * @type {RecommendationConfigDtoV2026} - * @memberof IAIRecommendationsV2026ApiUpdateRecommendationsConfig - */ - readonly recommendationConfigDtoV2026: RecommendationConfigDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRecommendationsV2026ApiUpdateRecommendationsConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRecommendationsV2026Api - object-oriented interface - * @export - * @class IAIRecommendationsV2026Api - * @extends {BaseAPI} - */ -export class IAIRecommendationsV2026Api extends BaseAPI { - /** - * The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - * @summary Returns recommendation based on object - * @param {IAIRecommendationsV2026ApiGetRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2026Api - */ - public getRecommendations(requestParameters: IAIRecommendationsV2026ApiGetRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2026ApiFp(this.configuration).getRecommendations(requestParameters.recommendationRequestDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves configuration attributes used by certification recommendations. - * @summary Get certification recommendation config values - * @param {IAIRecommendationsV2026ApiGetRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2026Api - */ - public getRecommendationsConfig(requestParameters: IAIRecommendationsV2026ApiGetRecommendationsConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2026ApiFp(this.configuration).getRecommendationsConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates configuration attributes used by certification recommendations. - * @summary Update certification recommendation config values - * @param {IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRecommendationsV2026Api - */ - public updateRecommendationsConfig(requestParameters: IAIRecommendationsV2026ApiUpdateRecommendationsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRecommendationsV2026ApiFp(this.configuration).updateRecommendationsConfig(requestParameters.recommendationConfigDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IAIRoleMiningV2026Api - axios parameter creator - * @export - */ -export const IAIRoleMiningV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2026} [roleMiningPotentialRoleProvisionRequestV2026] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest: async (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2026?: RoleMiningPotentialRoleProvisionRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('createPotentialRoleProvisionRequest', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (minEntitlementPopularity !== undefined) { - localVarQueryParameter['min-entitlement-popularity'] = minEntitlementPopularity; - } - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['include-common-access'] = includeCommonAccess; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleProvisionRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2026} roleMiningSessionDtoV2026 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions: async (roleMiningSessionDtoV2026: RoleMiningSessionDtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMiningSessionDtoV2026' is not null or undefined - assertParamExists('createRoleMiningSessions', 'roleMiningSessionDtoV2026', roleMiningSessionDtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningSessionDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('downloadRoleMiningPotentialRoleZip', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2026} [roleMiningPotentialRoleExportRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2026?: RoleMiningPotentialRoleExportRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleAsync', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleExportRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus: async (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'potentialRoleId', potentialRoleId) - // verify required parameter 'exportId' is not null or undefined - assertParamExists('exportRoleMiningPotentialRoleStatus', 'exportId', exportId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries: async (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementDistributionPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeCommonAccess !== undefined) { - localVarQueryParameter['includeCommonAccess'] = includeCommonAccess; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getExcludedEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole: async (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getIdentitiesPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole: async (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleApplications', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements: async (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleEntitlements', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage: async (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'potentialRoleId', potentialRoleId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getPotentialRoleSourceIdentityUsage', 'sourceId', sourceId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries: async (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getPotentialRoleSummaries', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole: async (potentialRoleId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('getRoleMiningPotentialRole', 'potentialRoleId', potentialRoleId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSession', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus: async (sessionId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('getRoleMiningSessionStatus', 'sessionId', sessionId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/status` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions: async (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles: async (sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/saved`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2026' is not null or undefined - assertParamExists('patchPotentialRole', 'jsonPatchOperationRoleMiningV2026', jsonPatchOperationRoleMiningV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-potential-roles/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession: async (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'potentialRoleId', potentialRoleId) - // verify required parameter 'jsonPatchOperationRoleMiningV2026' is not null or undefined - assertParamExists('patchPotentialRoleSession', 'jsonPatchOperationRoleMiningV2026', jsonPatchOperationRoleMiningV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationRoleMiningV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2026 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession: async (sessionId: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('patchRoleMiningSession', 'sessionId', sessionId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchRoleMiningSession', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2026} roleMiningPotentialRoleEditEntitlementsV2026 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole: async (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2026: RoleMiningPotentialRoleEditEntitlementsV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sessionId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'sessionId', sessionId) - // verify required parameter 'potentialRoleId' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'potentialRoleId', potentialRoleId) - // verify required parameter 'roleMiningPotentialRoleEditEntitlementsV2026' is not null or undefined - assertParamExists('updateEntitlementsPotentialRole', 'roleMiningPotentialRoleEditEntitlementsV2026', roleMiningPotentialRoleEditEntitlementsV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` - .replace(`{${"sessionId"}}`, encodeURIComponent(String(sessionId))) - .replace(`{${"potentialRoleId"}}`, encodeURIComponent(String(potentialRoleId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMiningPotentialRoleEditEntitlementsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IAIRoleMiningV2026Api - functional programming interface - * @export - */ -export const IAIRoleMiningV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IAIRoleMiningV2026ApiAxiosParamCreator(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleProvisionRequestV2026} [roleMiningPotentialRoleProvisionRequestV2026] Required information to create a new role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPotentialRoleProvisionRequest(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequestV2026?: RoleMiningPotentialRoleProvisionRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPotentialRoleProvisionRequest(sessionId, potentialRoleId, minEntitlementPopularity, includeCommonAccess, xSailPointExperimental, roleMiningPotentialRoleProvisionRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.createPotentialRoleProvisionRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {RoleMiningSessionDtoV2026} roleMiningSessionDtoV2026 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRoleMiningSessions(roleMiningSessionDtoV2026: RoleMiningSessionDtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleMiningSessions(roleMiningSessionDtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.createRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleMiningPotentialRoleZip(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleMiningPotentialRoleZip(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.downloadRoleMiningPotentialRoleZip']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.exportRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {RoleMiningPotentialRoleExportRequestV2026} [roleMiningPotentialRoleExportRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleAsync(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequestV2026?: RoleMiningPotentialRoleExportRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleAsync(sessionId, potentialRoleId, xSailPointExperimental, roleMiningPotentialRoleExportRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.exportRoleMiningPotentialRoleAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} exportId The id of a previously run export job for this potential role - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportRoleMiningPotentialRoleStatus(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportRoleMiningPotentialRoleStatus(sessionId, potentialRoleId, exportId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.exportRoleMiningPotentialRoleStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAllPotentialRoleSummaries(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllPotentialRoleSummaries(sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getAllPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementDistributionPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementDistributionPotentialRole(sessionId, potentialRoleId, includeCommonAccess, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getEntitlementDistributionPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not - * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsPotentialRole(sessionId, potentialRoleId, includeCommonAccess, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **popularity** - * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getExcludedEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getExcludedEntitlementsPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getExcludedEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitiesPotentialRole(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitiesPotentialRole(sessionId, potentialRoleId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getIdentitiesPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRole(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRole(sessionId, potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **applicationName**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleApplications(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleApplications(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getPotentialRoleApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @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: **entitlementRef.name**: *sw* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleEntitlements(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleEntitlements(sessionId, potentialRoleId, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getPotentialRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {string} potentialRoleId A potential role id - * @param {string} sourceId A source id - * @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 is supported for the following fields: **displayName, email, usageCount** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSourceIdentityUsage(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSourceIdentityUsage(potentialRoleId, sourceId, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getPotentialRoleSourceIdentityUsage']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {string} sessionId The role mining session id - * @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: **createdDate** - * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPotentialRoleSummaries(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPotentialRoleSummaries(sessionId, sorters, filters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getPotentialRoleSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {string} potentialRoleId A potential role id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningPotentialRole(potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningPotentialRole(potentialRoleId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getRoleMiningPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {string} sessionId The role mining session id to be retrieved. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSession(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSession(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {string} sessionId The role mining session id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessionStatus(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessionStatus(sessionId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getRoleMiningSessionStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @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: **saved**: *eq* **name**: *eq, sw* - * @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: **createdBy, createdDate** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleMiningSessions(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleMiningSessions(filters, sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getRoleMiningSessions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @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 is supported for the following fields: **modified** - * @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} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedPotentialRoles(sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedPotentialRoles(sorters, offset, limit, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.getSavedPotentialRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRole(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRole(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.patchPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId The potential role summary id - * @param {Array} jsonPatchOperationRoleMiningV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPotentialRoleSession(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMiningV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPotentialRoleSession(sessionId, potentialRoleId, jsonPatchOperationRoleMiningV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.patchPotentialRoleSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {string} sessionId The role mining session id to be patched - * @param {Array} jsonPatchOperationV2026 Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRoleMiningSession(sessionId: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRoleMiningSession(sessionId, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.patchRoleMiningSession']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {string} sessionId The role mining session id - * @param {string} potentialRoleId A potential role id in a role mining session - * @param {RoleMiningPotentialRoleEditEntitlementsV2026} roleMiningPotentialRoleEditEntitlementsV2026 Role mining session parameters - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateEntitlementsPotentialRole(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlementsV2026: RoleMiningPotentialRoleEditEntitlementsV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsPotentialRole(sessionId, potentialRoleId, roleMiningPotentialRoleEditEntitlementsV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IAIRoleMiningV2026Api.updateEntitlementsPotentialRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IAIRoleMiningV2026Api - factory interface - * @export - */ -export const IAIRoleMiningV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IAIRoleMiningV2026ApiFp(configuration) - return { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRoleMiningSessions(requestParameters: IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }> { - return localVarFp.getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2026ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleApplications(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSession(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleMiningSessions(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedPotentialRoles(requestParameters: IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2026ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRole(requestParameters: IAIRoleMiningV2026ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPotentialRoleSession(requestParameters: IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRoleMiningSession(requestParameters: IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPotentialRoleProvisionRequest operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest - */ -export interface IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly potentialRoleId: string - - /** - * Minimum popularity required for an entitlement to be included in the provisioned role. - * @type {number} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly minEntitlementPopularity?: number - - /** - * Boolean determining whether common access entitlements will be included in the provisioned role. - * @type {boolean} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly xSailPointExperimental?: string - - /** - * Required information to create a new role - * @type {RoleMiningPotentialRoleProvisionRequestV2026} - * @memberof IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequest - */ - readonly roleMiningPotentialRoleProvisionRequestV2026?: RoleMiningPotentialRoleProvisionRequestV2026 -} - -/** - * Request parameters for createRoleMiningSessions operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest { - /** - * Role mining session parameters - * @type {RoleMiningSessionDtoV2026} - * @memberof IAIRoleMiningV2026ApiCreateRoleMiningSessions - */ - readonly roleMiningSessionDtoV2026: RoleMiningSessionDtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiCreateRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleMiningPotentialRoleZip operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest - */ -export interface IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZip - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZip - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZip - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZip - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for exportRoleMiningPotentialRoleAsync operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest - */ -export interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsync - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsync - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsync - */ - readonly xSailPointExperimental?: string - - /** - * - * @type {RoleMiningPotentialRoleExportRequestV2026} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsync - */ - readonly roleMiningPotentialRoleExportRequestV2026?: RoleMiningPotentialRoleExportRequestV2026 -} - -/** - * Request parameters for exportRoleMiningPotentialRoleStatus operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest - */ -export interface IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatus - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatus - */ - readonly potentialRoleId: string - - /** - * The id of a previously run export job for this potential role - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatus - */ - readonly exportId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getAllPotentialRoleSummaries operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest { - /** - * 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: **createdDate, identityCount, entitlementCount, freshness, quality** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - 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 IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetAllPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementDistributionPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementsPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Boolean determining whether common access entitlements will be included or not - * @type {boolean} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly includeCommonAccess?: boolean - - /** - * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getExcludedEntitlementsPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly potentialRoleId: 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: **popularity** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly sorters?: 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: **applicationName**: *sw* **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitiesPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly potentialRoleId: 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: **name** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - 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 IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetIdentitiesPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleApplications operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest - */ -export interface IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - readonly potentialRoleId: 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: **applicationName**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleApplications - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleEntitlements operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest - */ -export interface IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - readonly potentialRoleId: 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: **entitlementRef.name**: *sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSourceIdentityUsage operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest - */ -export interface IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - readonly potentialRoleId: string - - /** - * A source id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sourceId: string - - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsage - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPotentialRoleSummaries operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest - */ -export interface IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - readonly sessionId: 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: **createdDate** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - readonly sorters?: 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - readonly filters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - 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 IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetPotentialRoleSummaries - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest { - /** - * A potential role id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningPotentialRole - */ - readonly potentialRoleId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSession operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2026ApiGetRoleMiningSessionRequest { - /** - * The role mining session id to be retrieved. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSession - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessionStatus operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest - */ -export interface IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSessionStatus - */ - readonly sessionId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSessionStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleMiningSessions operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest - */ -export interface IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest { - /** - * 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: **saved**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - 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: **createdBy, createdDate** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - 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 IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetRoleMiningSessions - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSavedPotentialRoles operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest - */ -export interface IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest { - /** - * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetSavedPotentialRoles - */ - readonly sorters?: string - - /** - * 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 IAIRoleMiningV2026ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2026ApiGetSavedPotentialRoles - */ - 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 IAIRoleMiningV2026ApiGetSavedPotentialRoles - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiGetSavedPotentialRoles - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiPatchPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiPatchPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRole - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRole - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRole - */ - readonly jsonPatchOperationRoleMiningV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchPotentialRoleSession operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest - */ -export interface IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRoleSession - */ - readonly sessionId: string - - /** - * The potential role summary id - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRoleSession - */ - readonly potentialRoleId: string - - /** - * - * @type {Array} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRoleSession - */ - readonly jsonPatchOperationRoleMiningV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchPotentialRoleSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchRoleMiningSession operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest - */ -export interface IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest { - /** - * The role mining session id to be patched - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchRoleMiningSession - */ - readonly sessionId: string - - /** - * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - * @type {Array} - * @memberof IAIRoleMiningV2026ApiPatchRoleMiningSession - */ - readonly jsonPatchOperationV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiPatchRoleMiningSession - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateEntitlementsPotentialRole operation in IAIRoleMiningV2026Api. - * @export - * @interface IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest - */ -export interface IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest { - /** - * The role mining session id - * @type {string} - * @memberof IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRole - */ - readonly sessionId: string - - /** - * A potential role id in a role mining session - * @type {string} - * @memberof IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRole - */ - readonly potentialRoleId: string - - /** - * Role mining session parameters - * @type {RoleMiningPotentialRoleEditEntitlementsV2026} - * @memberof IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRole - */ - readonly roleMiningPotentialRoleEditEntitlementsV2026: RoleMiningPotentialRoleEditEntitlementsV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRole - */ - readonly xSailPointExperimental?: string -} - -/** - * IAIRoleMiningV2026Api - object-oriented interface - * @export - * @class IAIRoleMiningV2026Api - * @extends {BaseAPI} - */ -export class IAIRoleMiningV2026Api extends BaseAPI { - /** - * This method starts a job to provision a potential role - * @summary Create request to provision a potential role into an actual role. - * @param {IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public createPotentialRoleProvisionRequest(requestParameters: IAIRoleMiningV2026ApiCreatePotentialRoleProvisionRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).createPotentialRoleProvisionRequest(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.minEntitlementPopularity, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleProvisionRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This submits a create role mining session request to the role mining application. - * @summary Create a role mining session - * @param {IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public createRoleMiningSessions(requestParameters: IAIRoleMiningV2026ApiCreateRoleMiningSessionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).createRoleMiningSessions(requestParameters.roleMiningSessionDtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads a completed export of information for a potential role in a role mining session. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public downloadRoleMiningPotentialRoleZip(requestParameters: IAIRoleMiningV2026ApiDownloadRoleMiningPotentialRoleZipRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).downloadRoleMiningPotentialRoleZip(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - * @summary Export (download) details for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public exportRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).exportRoleMiningPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public exportRoleMiningPotentialRoleAsync(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).exportRoleMiningPotentialRoleAsync(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, requestParameters.roleMiningPotentialRoleExportRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves information about the current status of a potential role export. - * @summary Retrieve status of a potential role export job - * @param {IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public exportRoleMiningPotentialRoleStatus(requestParameters: IAIRoleMiningV2026ApiExportRoleMiningPotentialRoleStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).exportRoleMiningPotentialRoleStatus(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.exportId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all potential role summaries that match the query parameters - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getAllPotentialRoleSummaries(requestParameters: IAIRoleMiningV2026ApiGetAllPotentialRoleSummariesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getAllPotentialRoleSummaries(requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlement popularity distribution for a potential role in a role mining session. - * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getEntitlementDistributionPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetEntitlementDistributionPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getEntitlementDistributionPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns entitlements for a potential role in a role mining session. - * @summary Retrieves entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.includeCommonAccess, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns excluded entitlements for a potential role in a role mining session. - * @summary Retrieves excluded entitlements for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getExcludedEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetExcludedEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getExcludedEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns identities for a potential role in a role mining session. - * @summary Retrieves identities for a potential role in a role mining session - * @param {IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getIdentitiesPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetIdentitiesPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getIdentitiesPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role for a role mining session. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2026ApiGetPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the applications of a potential role for a role mining session. - * @summary Retrieves the applications of a potential role for a role mining session - * @param {IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getPotentialRoleApplications(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleApplicationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getPotentialRoleApplications(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the entitlements of a potential role for a role mining session. - * @summary Retrieves the entitlements of a potential role for a role mining session - * @param {IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getPotentialRoleEntitlements(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getPotentialRoleEntitlements(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - * @summary Retrieves potential role source usage - * @param {IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getPotentialRoleSourceIdentityUsage(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleSourceIdentityUsageRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getPotentialRoleSourceIdentityUsage(requestParameters.potentialRoleId, requestParameters.sourceId, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns the potential role summaries for a role mining session. - * @summary Retrieves all potential role summaries - * @param {IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getPotentialRoleSummaries(requestParameters: IAIRoleMiningV2026ApiGetPotentialRoleSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getPotentialRoleSummaries(requestParameters.sessionId, requestParameters.sorters, requestParameters.filters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a specific potential role. - * @summary Retrieves a specific potential role - * @param {IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getRoleMiningPotentialRole(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getRoleMiningPotentialRole(requestParameters.potentialRoleId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method retrieves a role mining session. - * @summary Get a role mining session - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getRoleMiningSession(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getRoleMiningSession(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns a role mining session status for a customer. - * @summary Get role mining session status state - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getRoleMiningSessionStatus(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getRoleMiningSessionStatus(requestParameters.sessionId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns all role mining sessions that match the query parameters - * @summary Retrieves all role mining sessions - * @param {IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getRoleMiningSessions(requestParameters: IAIRoleMiningV2026ApiGetRoleMiningSessionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getRoleMiningSessions(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns all saved potential roles (draft roles). - * @summary Retrieves all saved potential roles - * @param {IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public getSavedPotentialRoles(requestParameters: IAIRoleMiningV2026ApiGetSavedPotentialRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).getSavedPotentialRoles(requestParameters.sorters, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role - * @param {IAIRoleMiningV2026ApiPatchPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public patchPotentialRole(requestParameters: IAIRoleMiningV2026ApiPatchPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).patchPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** - * @summary Update a potential role session - * @param {IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public patchPotentialRoleSession(requestParameters: IAIRoleMiningV2026ApiPatchPotentialRoleSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).patchPotentialRoleSession(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.jsonPatchOperationRoleMiningV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - * @summary Patch a role mining session - * @param {IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public patchRoleMiningSession(requestParameters: IAIRoleMiningV2026ApiPatchRoleMiningSessionRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).patchRoleMiningSession(requestParameters.sessionId, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint adds or removes entitlements from an exclusion list for a potential role. - * @summary Edit entitlements for a potential role to exclude some entitlements - * @param {IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IAIRoleMiningV2026Api - */ - public updateEntitlementsPotentialRole(requestParameters: IAIRoleMiningV2026ApiUpdateEntitlementsPotentialRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return IAIRoleMiningV2026ApiFp(this.configuration).updateEntitlementsPotentialRole(requestParameters.sessionId, requestParameters.potentialRoleId, requestParameters.roleMiningPotentialRoleEditEntitlementsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IconsV2026Api - axios parameter creator - * @export - */ -export const IconsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2026} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon: async (objectType: DeleteIconObjectTypeV2026, objectId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('deleteIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('deleteIcon', 'objectId', objectId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2026} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon: async (objectType: SetIconObjectTypeV2026, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'objectType' is not null or undefined - assertParamExists('setIcon', 'objectType', objectType) - // verify required parameter 'objectId' is not null or undefined - assertParamExists('setIcon', 'objectId', objectId) - // verify required parameter 'image' is not null or undefined - assertParamExists('setIcon', 'image', image) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/icons/{objectType}/{objectId}` - .replace(`{${"objectType"}}`, encodeURIComponent(String(objectType))) - .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (image !== undefined) { - localVarFormParams.append('image', image as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IconsV2026Api - functional programming interface - * @export - */ -export const IconsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IconsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {DeleteIconObjectTypeV2026} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIcon(objectType: DeleteIconObjectTypeV2026, objectId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIcon(objectType, objectId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2026Api.deleteIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {SetIconObjectTypeV2026} objectType Object type. Available options [\'application\'] - * @param {string} objectId Object id. - * @param {File} image file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setIcon(objectType: SetIconObjectTypeV2026, objectId: string, image: File, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setIcon(objectType, objectId, image, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IconsV2026Api.setIcon']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IconsV2026Api - factory interface - * @export - */ -export const IconsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IconsV2026ApiFp(configuration) - return { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2026ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIcon(requestParameters: IconsV2026ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2026ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setIcon(requestParameters: IconsV2026ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIcon operation in IconsV2026Api. - * @export - * @interface IconsV2026ApiDeleteIconRequest - */ -export interface IconsV2026ApiDeleteIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2026ApiDeleteIcon - */ - readonly objectType: DeleteIconObjectTypeV2026 - - /** - * Object id. - * @type {string} - * @memberof IconsV2026ApiDeleteIcon - */ - readonly objectId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2026ApiDeleteIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setIcon operation in IconsV2026Api. - * @export - * @interface IconsV2026ApiSetIconRequest - */ -export interface IconsV2026ApiSetIconRequest { - /** - * Object type. Available options [\'application\'] - * @type {'application'} - * @memberof IconsV2026ApiSetIcon - */ - readonly objectType: SetIconObjectTypeV2026 - - /** - * Object id. - * @type {string} - * @memberof IconsV2026ApiSetIcon - */ - readonly objectId: string - - /** - * file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] - * @type {File} - * @memberof IconsV2026ApiSetIcon - */ - readonly image: File - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IconsV2026ApiSetIcon - */ - readonly xSailPointExperimental?: string -} - -/** - * IconsV2026Api - object-oriented interface - * @export - * @class IconsV2026Api - * @extends {BaseAPI} - */ -export class IconsV2026Api extends BaseAPI { - /** - * This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Delete an icon - * @param {IconsV2026ApiDeleteIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2026Api - */ - public deleteIcon(requestParameters: IconsV2026ApiDeleteIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2026ApiFp(this.configuration).deleteIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - * @summary Update an icon - * @param {IconsV2026ApiSetIconRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IconsV2026Api - */ - public setIcon(requestParameters: IconsV2026ApiSetIconRequest, axiosOptions?: RawAxiosRequestConfig) { - return IconsV2026ApiFp(this.configuration).setIcon(requestParameters.objectType, requestParameters.objectId, requestParameters.image, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteIconObjectTypeV2026 = { - Application: 'application' -} as const; -export type DeleteIconObjectTypeV2026 = typeof DeleteIconObjectTypeV2026[keyof typeof DeleteIconObjectTypeV2026]; -/** - * @export - */ -export const SetIconObjectTypeV2026 = { - Application: 'application' -} as const; -export type SetIconObjectTypeV2026 = typeof SetIconObjectTypeV2026[keyof typeof SetIconObjectTypeV2026]; - - -/** - * IdentitiesV2026Api - axios parameter creator - * @export - */ -export const IdentitiesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentity', 'id', id) - const localVarPath = `/identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getIdentityOwnershipDetails', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/ownership` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment: async (identityId: string, assignmentId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignment', 'identityId', identityId) - // verify required parameter 'assignmentId' is not null or undefined - assertParamExists('getRoleAssignment', 'assignmentId', assignmentId) - const localVarPath = `/identities/{identityId}/role-assignments/{assignmentId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"assignmentId"}}`, encodeURIComponent(String(assignmentId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments: async (identityId: string, roleId?: string, roleName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getRoleAssignments', 'identityId', identityId) - const localVarPath = `/identities/{identityId}/role-assignments` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (roleId !== undefined) { - localVarQueryParameter['roleId'] = roleId; - } - - if (roleName !== undefined) { - localVarQueryParameter['roleName'] = roleName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listEntitlementsByIdentity', 'id', id) - const localVarPath = `/entitlements/identities/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2026} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities: async (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2026, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (defaultFilter !== undefined) { - localVarQueryParameter['defaultFilter'] = defaultFilter; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity: async (identityId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('resetIdentity', 'identityId', identityId) - const localVarPath = `/identities/{id}/reset` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2026} sendAccountVerificationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken: async (id: string, sendAccountVerificationRequestV2026: SendAccountVerificationRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'id', id) - // verify required parameter 'sendAccountVerificationRequestV2026' is not null or undefined - assertParamExists('sendIdentityVerificationAccountToken', 'sendAccountVerificationRequestV2026', sendAccountVerificationRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{id}/verification/account/send` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendAccountVerificationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2026} inviteIdentitiesRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite: async (inviteIdentitiesRequestV2026: InviteIdentitiesRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'inviteIdentitiesRequestV2026' is not null or undefined - assertParamExists('startIdentitiesInvite', 'inviteIdentitiesRequestV2026', inviteIdentitiesRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/invite`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(inviteIdentitiesRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2026} processIdentitiesRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing: async (processIdentitiesRequestV2026: ProcessIdentitiesRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'processIdentitiesRequestV2026' is not null or undefined - assertParamExists('startIdentityProcessing', 'processIdentitiesRequestV2026', processIdentitiesRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/process`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(processIdentitiesRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('synchronizeAttributesForIdentity', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/identities/{identityId}/synchronize-attributes` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentitiesV2026Api - functional programming interface - * @export - */ -export const IdentitiesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentitiesV2026ApiAxiosParamCreator(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {string} id Identity Id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.deleteIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {string} id Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.getIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {string} identityId Identity ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityOwnershipDetails(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityOwnershipDetails(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.getIdentityOwnershipDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Role assignment details - * @param {string} identityId Identity Id - * @param {string} assignmentId Assignment Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignment(identityId: string, assignmentId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignment(identityId, assignmentId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.getRoleAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {string} identityId Identity Id to get the role assignments for - * @param {string} [roleId] Role Id to filter the role assignments with - * @param {string} [roleName] Role name to filter the role assignments with - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignments(identityId: string, roleId?: string, roleName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignments(identityId, roleId, roleName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.getRoleAssignments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {string} id Identity Id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listEntitlementsByIdentity(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementsByIdentity(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.listEntitlementsByIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @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: **name, alias, cloudStatus** - * @param {ListIdentitiesDefaultFilterV2026} [defaultFilter] Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentities(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesDefaultFilterV2026, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentities(filters, sorters, defaultFilter, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.listIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {string} identityId Identity Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async resetIdentity(identityId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetIdentity(identityId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.resetIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {string} id Identity ID - * @param {SendAccountVerificationRequestV2026} sendAccountVerificationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendIdentityVerificationAccountToken(id: string, sendAccountVerificationRequestV2026: SendAccountVerificationRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendIdentityVerificationAccountToken(id, sendAccountVerificationRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.sendIdentityVerificationAccountToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {InviteIdentitiesRequestV2026} inviteIdentitiesRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentitiesInvite(inviteIdentitiesRequestV2026: InviteIdentitiesRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentitiesInvite(inviteIdentitiesRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.startIdentitiesInvite']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {ProcessIdentitiesRequestV2026} processIdentitiesRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startIdentityProcessing(processIdentitiesRequestV2026: ProcessIdentitiesRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startIdentityProcessing(processIdentitiesRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.startIdentityProcessing']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {string} identityId The Identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async synchronizeAttributesForIdentity(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.synchronizeAttributesForIdentity(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentitiesV2026Api.synchronizeAttributesForIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentitiesV2026Api - factory interface - * @export - */ -export const IdentitiesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentitiesV2026ApiFp(configuration) - return { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2026ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentity(requestParameters: IdentitiesV2026ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2026ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentity(requestParameters: IdentitiesV2026ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityOwnershipDetails(requestParameters: IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Role assignment details - * @param {IdentitiesV2026ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignment(requestParameters: IdentitiesV2026ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2026ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignments(requestParameters: IdentitiesV2026ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2026ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listEntitlementsByIdentity(requestParameters: IdentitiesV2026ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2026ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentities(requestParameters: IdentitiesV2026ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2026ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - resetIdentity(requestParameters: IdentitiesV2026ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2026ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentitiesInvite(requestParameters: IdentitiesV2026ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2026ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startIdentityProcessing(requestParameters: IdentitiesV2026ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startIdentityProcessing(requestParameters.processIdentitiesRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - synchronizeAttributesForIdentity(requestParameters: IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteIdentity operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiDeleteIdentityRequest - */ -export interface IdentitiesV2026ApiDeleteIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2026ApiDeleteIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2026ApiDeleteIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentity operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiGetIdentityRequest - */ -export interface IdentitiesV2026ApiGetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2026ApiGetIdentity - */ - readonly id: string -} - -/** - * Request parameters for getIdentityOwnershipDetails operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest - */ -export interface IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest { - /** - * Identity ID. - * @type {string} - * @memberof IdentitiesV2026ApiGetIdentityOwnershipDetails - */ - readonly identityId: string -} - -/** - * Request parameters for getRoleAssignment operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiGetRoleAssignmentRequest - */ -export interface IdentitiesV2026ApiGetRoleAssignmentRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2026ApiGetRoleAssignment - */ - readonly identityId: string - - /** - * Assignment Id - * @type {string} - * @memberof IdentitiesV2026ApiGetRoleAssignment - */ - readonly assignmentId: string -} - -/** - * Request parameters for getRoleAssignments operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiGetRoleAssignmentsRequest - */ -export interface IdentitiesV2026ApiGetRoleAssignmentsRequest { - /** - * Identity Id to get the role assignments for - * @type {string} - * @memberof IdentitiesV2026ApiGetRoleAssignments - */ - readonly identityId: string - - /** - * Role Id to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2026ApiGetRoleAssignments - */ - readonly roleId?: string - - /** - * Role name to filter the role assignments with - * @type {string} - * @memberof IdentitiesV2026ApiGetRoleAssignments - */ - readonly roleName?: string -} - -/** - * Request parameters for listEntitlementsByIdentity operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiListEntitlementsByIdentityRequest - */ -export interface IdentitiesV2026ApiListEntitlementsByIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2026ApiListEntitlementsByIdentity - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2026ApiListEntitlementsByIdentity - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2026ApiListEntitlementsByIdentity - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentitiesV2026ApiListEntitlementsByIdentity - */ - readonly count?: boolean -} - -/** - * Request parameters for listIdentities operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiListIdentitiesRequest - */ -export interface IdentitiesV2026ApiListIdentitiesRequest { - /** - * 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, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - * @type {string} - * @memberof IdentitiesV2026ApiListIdentities - */ - 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: **name, alias, cloudStatus** - * @type {string} - * @memberof IdentitiesV2026ApiListIdentities - */ - readonly sorters?: string - - /** - * Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - * @type {'CORRELATED_ONLY' | 'NONE'} - * @memberof IdentitiesV2026ApiListIdentities - */ - readonly defaultFilter?: ListIdentitiesDefaultFilterV2026 - - /** - * 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 IdentitiesV2026ApiListIdentities - */ - readonly count?: boolean - - /** - * 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 IdentitiesV2026ApiListIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentitiesV2026ApiListIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for resetIdentity operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiResetIdentityRequest - */ -export interface IdentitiesV2026ApiResetIdentityRequest { - /** - * Identity Id - * @type {string} - * @memberof IdentitiesV2026ApiResetIdentity - */ - readonly identityId: string -} - -/** - * Request parameters for sendIdentityVerificationAccountToken operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest - */ -export interface IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest { - /** - * Identity ID - * @type {string} - * @memberof IdentitiesV2026ApiSendIdentityVerificationAccountToken - */ - readonly id: string - - /** - * - * @type {SendAccountVerificationRequestV2026} - * @memberof IdentitiesV2026ApiSendIdentityVerificationAccountToken - */ - readonly sendAccountVerificationRequestV2026: SendAccountVerificationRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2026ApiSendIdentityVerificationAccountToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentitiesInvite operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiStartIdentitiesInviteRequest - */ -export interface IdentitiesV2026ApiStartIdentitiesInviteRequest { - /** - * - * @type {InviteIdentitiesRequestV2026} - * @memberof IdentitiesV2026ApiStartIdentitiesInvite - */ - readonly inviteIdentitiesRequestV2026: InviteIdentitiesRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2026ApiStartIdentitiesInvite - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startIdentityProcessing operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiStartIdentityProcessingRequest - */ -export interface IdentitiesV2026ApiStartIdentityProcessingRequest { - /** - * - * @type {ProcessIdentitiesRequestV2026} - * @memberof IdentitiesV2026ApiStartIdentityProcessing - */ - readonly processIdentitiesRequestV2026: ProcessIdentitiesRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2026ApiStartIdentityProcessing - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for synchronizeAttributesForIdentity operation in IdentitiesV2026Api. - * @export - * @interface IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest - */ -export interface IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest { - /** - * The Identity id - * @type {string} - * @memberof IdentitiesV2026ApiSynchronizeAttributesForIdentity - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentitiesV2026ApiSynchronizeAttributesForIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentitiesV2026Api - object-oriented interface - * @export - * @class IdentitiesV2026Api - * @extends {BaseAPI} - */ -export class IdentitiesV2026Api extends BaseAPI { - /** - * The API returns successful response if the requested identity was deleted. - * @summary Delete identity - * @param {IdentitiesV2026ApiDeleteIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public deleteIdentity(requestParameters: IdentitiesV2026ApiDeleteIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).deleteIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity using the Identity ID. - * @summary Identity details - * @param {IdentitiesV2026ApiGetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public getIdentity(requestParameters: IdentitiesV2026ApiGetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).getIdentity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return an identity\'s owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity\'s owned objects. - * @summary Get ownership details - * @param {IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public getIdentityOwnershipDetails(requestParameters: IdentitiesV2026ApiGetIdentityOwnershipDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).getIdentityOwnershipDetails(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Role assignment details - * @param {IdentitiesV2026ApiGetRoleAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public getRoleAssignment(requestParameters: IdentitiesV2026ApiGetRoleAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).getRoleAssignment(requestParameters.identityId, requestParameters.assignmentId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - * @summary List role assignments - * @param {IdentitiesV2026ApiGetRoleAssignmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public getRoleAssignments(requestParameters: IdentitiesV2026ApiGetRoleAssignmentsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).getRoleAssignments(requestParameters.identityId, requestParameters.roleId, requestParameters.roleName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. - * @summary List of entitlements by identity. - * @param {IdentitiesV2026ApiListEntitlementsByIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public listEntitlementsByIdentity(requestParameters: IdentitiesV2026ApiListEntitlementsByIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).listEntitlementsByIdentity(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of identities. - * @summary List identities - * @param {IdentitiesV2026ApiListIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public listIdentities(requestParameters: IdentitiesV2026ApiListIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).listIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.defaultFilter, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - * @summary Reset an identity - * @param {IdentitiesV2026ApiResetIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public resetIdentity(requestParameters: IdentitiesV2026ApiResetIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).resetIdentity(requestParameters.identityId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - * @summary Send password reset email - * @param {IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public sendIdentityVerificationAccountToken(requestParameters: IdentitiesV2026ApiSendIdentityVerificationAccountTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).sendIdentityVerificationAccountToken(requestParameters.id, requestParameters.sendAccountVerificationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - * @summary Invite identities to register - * @param {IdentitiesV2026ApiStartIdentitiesInviteRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public startIdentitiesInvite(requestParameters: IdentitiesV2026ApiStartIdentitiesInviteRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).startIdentitiesInvite(requestParameters.inviteIdentitiesRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This endpoint will perform the following tasks: 1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it\'s expected to change). 2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. 3. Enforce provisioning for any assigned accesses that haven\'t been fulfilled (e.g. failure due to source health). 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. - * @summary Process a list of identityids - * @param {IdentitiesV2026ApiStartIdentityProcessingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public startIdentityProcessing(requestParameters: IdentitiesV2026ApiStartIdentityProcessingRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).startIdentityProcessing(requestParameters.processIdentitiesRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. - * @summary Attribute synchronization for single identity. - * @param {IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentitiesV2026Api - */ - public synchronizeAttributesForIdentity(requestParameters: IdentitiesV2026ApiSynchronizeAttributesForIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentitiesV2026ApiFp(this.configuration).synchronizeAttributesForIdentity(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListIdentitiesDefaultFilterV2026 = { - CorrelatedOnly: 'CORRELATED_ONLY', - None: 'NONE' -} as const; -export type ListIdentitiesDefaultFilterV2026 = typeof ListIdentitiesDefaultFilterV2026[keyof typeof ListIdentitiesDefaultFilterV2026]; - - -/** - * IdentityAttributesV2026Api - axios parameter creator - * @export - */ -export const IdentityAttributesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2026} identityAttributeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute: async (identityAttributeV2026: IdentityAttributeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeV2026' is not null or undefined - assertParamExists('createIdentityAttribute', 'identityAttributeV2026', identityAttributeV2026) - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2026} identityAttributeNamesV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk: async (identityAttributeNamesV2026: IdentityAttributeNamesV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityAttributeNamesV2026' is not null or undefined - assertParamExists('deleteIdentityAttributesInBulk', 'identityAttributeNamesV2026', identityAttributeNamesV2026) - const localVarPath = `/identity-attributes/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeNamesV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getIdentityAttribute', 'name', name) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes: async (includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-attributes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (includeSystem !== undefined) { - localVarQueryParameter['includeSystem'] = includeSystem; - } - - if (includeSilent !== undefined) { - localVarQueryParameter['includeSilent'] = includeSilent; - } - - if (searchableOnly !== undefined) { - localVarQueryParameter['searchableOnly'] = searchableOnly; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2026} identityAttributeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute: async (name: string, identityAttributeV2026: IdentityAttributeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('putIdentityAttribute', 'name', name) - // verify required parameter 'identityAttributeV2026' is not null or undefined - assertParamExists('putIdentityAttribute', 'identityAttributeV2026', identityAttributeV2026) - const localVarPath = `/identity-attributes/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityAttributeV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityAttributesV2026Api - functional programming interface - * @export - */ -export const IdentityAttributesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityAttributesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributeV2026} identityAttributeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityAttribute(identityAttributeV2026: IdentityAttributeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityAttribute(identityAttributeV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.createIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.deleteIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributeNamesV2026} identityAttributeNamesV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityAttributesInBulk(identityAttributeNamesV2026: IdentityAttributeNamesV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityAttributesInBulk(identityAttributeNamesV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.deleteIdentityAttributesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {string} name The attribute\'s technical name. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAttribute(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAttribute(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.getIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {boolean} [includeSystem] Include \'system\' attributes in the response. - * @param {boolean} [includeSilent] Include \'silent\' attributes in the response. - * @param {boolean} [searchableOnly] Include only \'searchable\' attributes in the response. - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAttributes(includeSystem?: boolean, includeSilent?: boolean, searchableOnly?: boolean, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAttributes(includeSystem, includeSilent, searchableOnly, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.listIdentityAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {string} name The attribute\'s technical name. - * @param {IdentityAttributeV2026} identityAttributeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putIdentityAttribute(name: string, identityAttributeV2026: IdentityAttributeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putIdentityAttribute(name, identityAttributeV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityAttributesV2026Api.putIdentityAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityAttributesV2026Api - factory interface - * @export - */ -export const IdentityAttributesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityAttributesV2026ApiFp(configuration) - return { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2026ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityAttribute(requestParameters: IdentityAttributesV2026ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityAttribute(requestParameters.identityAttributeV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2026ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttribute(requestParameters: IdentityAttributesV2026ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2026ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAttribute(requestParameters: IdentityAttributesV2026ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2026ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAttributes(requestParameters: IdentityAttributesV2026ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2026ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putIdentityAttribute(requestParameters: IdentityAttributesV2026ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityAttribute operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiCreateIdentityAttributeRequest - */ -export interface IdentityAttributesV2026ApiCreateIdentityAttributeRequest { - /** - * - * @type {IdentityAttributeV2026} - * @memberof IdentityAttributesV2026ApiCreateIdentityAttribute - */ - readonly identityAttributeV2026: IdentityAttributeV2026 -} - -/** - * Request parameters for deleteIdentityAttribute operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiDeleteIdentityAttributeRequest - */ -export interface IdentityAttributesV2026ApiDeleteIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2026ApiDeleteIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for deleteIdentityAttributesInBulk operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest - */ -export interface IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest { - /** - * - * @type {IdentityAttributeNamesV2026} - * @memberof IdentityAttributesV2026ApiDeleteIdentityAttributesInBulk - */ - readonly identityAttributeNamesV2026: IdentityAttributeNamesV2026 -} - -/** - * Request parameters for getIdentityAttribute operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiGetIdentityAttributeRequest - */ -export interface IdentityAttributesV2026ApiGetIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2026ApiGetIdentityAttribute - */ - readonly name: string -} - -/** - * Request parameters for listIdentityAttributes operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiListIdentityAttributesRequest - */ -export interface IdentityAttributesV2026ApiListIdentityAttributesRequest { - /** - * Include \'system\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2026ApiListIdentityAttributes - */ - readonly includeSystem?: boolean - - /** - * Include \'silent\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2026ApiListIdentityAttributes - */ - readonly includeSilent?: boolean - - /** - * Include only \'searchable\' attributes in the response. - * @type {boolean} - * @memberof IdentityAttributesV2026ApiListIdentityAttributes - */ - readonly searchableOnly?: boolean - - /** - * 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 IdentityAttributesV2026ApiListIdentityAttributes - */ - readonly count?: boolean -} - -/** - * Request parameters for putIdentityAttribute operation in IdentityAttributesV2026Api. - * @export - * @interface IdentityAttributesV2026ApiPutIdentityAttributeRequest - */ -export interface IdentityAttributesV2026ApiPutIdentityAttributeRequest { - /** - * The attribute\'s technical name. - * @type {string} - * @memberof IdentityAttributesV2026ApiPutIdentityAttribute - */ - readonly name: string - - /** - * - * @type {IdentityAttributeV2026} - * @memberof IdentityAttributesV2026ApiPutIdentityAttribute - */ - readonly identityAttributeV2026: IdentityAttributeV2026 -} - -/** - * IdentityAttributesV2026Api - object-oriented interface - * @export - * @class IdentityAttributesV2026Api - * @extends {BaseAPI} - */ -export class IdentityAttributesV2026Api extends BaseAPI { - /** - * Use this API to create a new identity attribute. - * @summary Create identity attribute - * @param {IdentityAttributesV2026ApiCreateIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public createIdentityAttribute(requestParameters: IdentityAttributesV2026ApiCreateIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).createIdentityAttribute(requestParameters.identityAttributeV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. - * @summary Delete identity attribute - * @param {IdentityAttributesV2026ApiDeleteIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public deleteIdentityAttribute(requestParameters: IdentityAttributesV2026ApiDeleteIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).deleteIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to \'false\' before you can delete an identity attribute. - * @summary Bulk delete identity attributes - * @param {IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public deleteIdentityAttributesInBulk(requestParameters: IdentityAttributesV2026ApiDeleteIdentityAttributesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).deleteIdentityAttributesInBulk(requestParameters.identityAttributeNamesV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets an identity attribute for a given technical name. - * @summary Get identity attribute - * @param {IdentityAttributesV2026ApiGetIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public getIdentityAttribute(requestParameters: IdentityAttributesV2026ApiGetIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).getIdentityAttribute(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a collection of identity attributes. - * @summary List identity attributes - * @param {IdentityAttributesV2026ApiListIdentityAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public listIdentityAttributes(requestParameters: IdentityAttributesV2026ApiListIdentityAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).listIdentityAttributes(requestParameters.includeSystem, requestParameters.includeSilent, requestParameters.searchableOnly, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. - * @summary Update identity attribute - * @param {IdentityAttributesV2026ApiPutIdentityAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityAttributesV2026Api - */ - public putIdentityAttribute(requestParameters: IdentityAttributesV2026ApiPutIdentityAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityAttributesV2026ApiFp(this.configuration).putIdentityAttribute(requestParameters.name, requestParameters.identityAttributeV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IdentityHistoryV2026Api - axios parameter creator - * @export - */ -export const IdentityHistoryV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2026} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2026, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'id', id) - // verify required parameter 'accessType' is not null or undefined - assertParamExists('compareIdentitySnapshotsAccessType', 'accessType', accessType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/compare/{access-type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (accessAssociated !== undefined) { - localVarQueryParameter['access-associated'] = accessAssociated; - } - - if (snapshot1 !== undefined) { - localVarQueryParameter['snapshot1'] = snapshot1; - } - - if (snapshot2 !== undefined) { - localVarQueryParameter['snapshot2'] = snapshot2; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getHistoricalIdentityEvents', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/events` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (from !== undefined) { - localVarQueryParameter['from'] = from; - } - - if (eventTypes) { - localVarQueryParameter['eventTypes'] = eventTypes.join(COLLECTION_FORMATS.csv); - } - - if (accessItemTypes) { - localVarQueryParameter['accessItemTypes'] = accessItemTypes.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot: async (id: string, date: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshot', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('getIdentitySnapshot', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2026} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2026, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySnapshotSummary', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshot-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (before !== undefined) { - localVarQueryParameter['before'] = before; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (timeZone !== undefined) { - localVarQueryParameter['time-zone'] = timeZone; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityStartDate', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/start-date` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (startsWithQuery !== undefined) { - localVarQueryParameter['starts-with-query'] = startsWithQuery; - } - - if (isDeleted !== undefined) { - localVarQueryParameter['is-deleted'] = isDeleted; - } - - if (isActive !== undefined) { - localVarQueryParameter['is-active'] = isActive; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2026} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems: async (id: string, type?: ListIdentityAccessItemsTypeV2026, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessItems', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/access-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems: async (id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'id', id) - // verify required parameter 'date' is not null or undefined - assertParamExists('listIdentitySnapshotAccessItems', 'date', date) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots/{date}/access-items` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2026} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots: async (id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2026, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentitySnapshots', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/historical-identities/{id}/snapshots` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityHistoryV2026Api - functional programming interface - * @export - */ -export const IdentityHistoryV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityHistoryV2026ApiAxiosParamCreator(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshots(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshots(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.compareIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {string} id The identity id - * @param {CompareIdentitySnapshotsAccessTypeAccessTypeV2026} accessType The specific type which needs to be compared - * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @param {string} [snapshot1] The snapshot 1 of identity - * @param {string} [snapshot2] The snapshot 2 of identity - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async compareIdentitySnapshotsAccessType(id: string, accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2026, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessType(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.compareIdentitySnapshotsAccessType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.getHistoricalIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {string} id The identity id - * @param {string} [from] The optional instant until which access events are returned - * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned - * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getHistoricalIdentityEvents(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEvents(id, from, eventTypes, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.getHistoricalIdentityEvents']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshot(id: string, date: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshot(id, date, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.getIdentitySnapshot']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {string} id The identity id - * @param {string} [before] The date before which snapshot summary is required - * @param {GetIdentitySnapshotSummaryIntervalV2026} [interval] The interval indicating day or month. Defaults to month if not specified - * @param {string} [timeZone] The time zone. Defaults to UTC if not provided - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySnapshotSummary(id: string, before?: string, interval?: GetIdentitySnapshotSummaryIntervalV2026, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummary(id, before, interval, timeZone, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.getIdentitySnapshotSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {string} id The identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityStartDate(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDate(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.getIdentityStartDate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity - * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. - * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listHistoricalIdentities(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentities(startsWithQuery, isDeleted, isActive, limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.listHistoricalIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {string} id The identity id - * @param {ListIdentityAccessItemsTypeV2026} [type] The type of access item for the identity. If not provided, it defaults to account - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessItems(id: string, type?: ListIdentityAccessItemsTypeV2026, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItems(id, type, xSailPointExperimental, limit, count, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.listIdentityAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {string} id The identity id - * @param {string} date The specified date - * @param {string} [type] The access item type - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshotAccessItems(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItems(id, date, type, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.listIdentitySnapshotAccessItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {string} id The identity id - * @param {string} [start] The specified start date - * @param {ListIdentitySnapshotsIntervalV2026} [interval] The interval indicating the range in day or month for the specified interval-name - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentitySnapshots(id: string, start?: string, interval?: ListIdentitySnapshotsIntervalV2026, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshots(id, start, interval, limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityHistoryV2026Api.listIdentitySnapshots']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityHistoryV2026Api - factory interface - * @export - */ -export const IdentityHistoryV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityHistoryV2026ApiFp(configuration) - return { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshots(requestParameters: IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2026ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentity(requestParameters: IdentityHistoryV2026ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2026ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshot(requestParameters: IdentityHistoryV2026ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2026ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityStartDate(requestParameters: IdentityHistoryV2026ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2026ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listHistoricalIdentities(requestParameters: IdentityHistoryV2026ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2026ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessItems(requestParameters: IdentityHistoryV2026ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2026ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentitySnapshots(requestParameters: IdentityHistoryV2026ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for compareIdentitySnapshots operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly id: string - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly snapshot2?: string - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for compareIdentitySnapshotsAccessType operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest - */ -export interface IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly id: string - - /** - * The specific type which needs to be compared - * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly accessType: CompareIdentitySnapshotsAccessTypeAccessTypeV2026 - - /** - * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - * @type {boolean} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly accessAssociated?: boolean - - /** - * The snapshot 1 of identity - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot1?: string - - /** - * The snapshot 2 of identity - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly snapshot2?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessType - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentity operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiGetHistoricalIdentityRequest - */ -export interface IdentityHistoryV2026ApiGetHistoricalIdentityRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getHistoricalIdentityEvents operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest - */ -export interface IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly id: string - - /** - * The optional instant until which access events are returned - * @type {string} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly from?: string - - /** - * An optional list of event types to return. If null or empty, all events are returned - * @type {Array} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly eventTypes?: Array - - /** - * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - * @type {Array} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly accessItemTypes?: Array - - /** - * 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 IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiGetHistoricalIdentityEvents - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshot operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiGetIdentitySnapshotRequest - */ -export interface IdentityHistoryV2026ApiGetIdentitySnapshotRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshot - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshot - */ - readonly date: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshot - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentitySnapshotSummary operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest - */ -export interface IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly id: string - - /** - * The date before which snapshot summary is required - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly before?: string - - /** - * The interval indicating day or month. Defaults to month if not specified - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly interval?: GetIdentitySnapshotSummaryIntervalV2026 - - /** - * The time zone. Defaults to UTC if not provided - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly timeZone?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentitySnapshotSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getIdentityStartDate operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiGetIdentityStartDateRequest - */ -export interface IdentityHistoryV2026ApiGetIdentityStartDateRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentityStartDate - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiGetIdentityStartDate - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listHistoricalIdentities operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiListHistoricalIdentitiesRequest - */ -export interface IdentityHistoryV2026ApiListHistoricalIdentitiesRequest { - /** - * This param is used for starts-with search for first, last and display name of the identity - * @type {string} - * @memberof IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly startsWithQuery?: string - - /** - * Indicates if we want to only list down deleted identities or not. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly isDeleted?: boolean - - /** - * Indicates if we want to only list active or inactive identities. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly isActive?: boolean - - /** - * 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 IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiListHistoricalIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentityAccessItems operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiListIdentityAccessItemsRequest - */ -export interface IdentityHistoryV2026ApiListIdentityAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentityAccessItems - */ - readonly id: string - - /** - * The type of access item for the identity. If not provided, it defaults to account - * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} - * @memberof IdentityHistoryV2026ApiListIdentityAccessItems - */ - readonly type?: ListIdentityAccessItemsTypeV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentityAccessItems - */ - readonly xSailPointExperimental?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiListIdentityAccessItems - */ - 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 IdentityHistoryV2026ApiListIdentityAccessItems - */ - readonly count?: boolean - - /** - * 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 IdentityHistoryV2026ApiListIdentityAccessItems - */ - readonly offset?: number -} - -/** - * Request parameters for listIdentitySnapshotAccessItems operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest - */ -export interface IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshotAccessItems - */ - readonly id: string - - /** - * The specified date - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshotAccessItems - */ - readonly date: string - - /** - * The access item type - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshotAccessItems - */ - readonly type?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshotAccessItems - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listIdentitySnapshots operation in IdentityHistoryV2026Api. - * @export - * @interface IdentityHistoryV2026ApiListIdentitySnapshotsRequest - */ -export interface IdentityHistoryV2026ApiListIdentitySnapshotsRequest { - /** - * The identity id - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly id: string - - /** - * The specified start date - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly start?: string - - /** - * The interval indicating the range in day or month for the specified interval-name - * @type {'day' | 'month'} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly interval?: ListIdentitySnapshotsIntervalV2026 - - /** - * 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 IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof IdentityHistoryV2026ApiListIdentitySnapshots - */ - readonly xSailPointExperimental?: string -} - -/** - * IdentityHistoryV2026Api - object-oriented interface - * @export - * @class IdentityHistoryV2026Api - * @extends {BaseAPI} - */ -export class IdentityHistoryV2026Api extends BaseAPI { - /** - * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots - * @param {IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public compareIdentitySnapshots(requestParameters: IdentityHistoryV2026ApiCompareIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).compareIdentitySnapshots(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots - * @param {IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public compareIdentitySnapshotsAccessType(requestParameters: IdentityHistoryV2026ApiCompareIdentitySnapshotsAccessTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).compareIdentitySnapshotsAccessType(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Get latest snapshot of identity - * @param {IdentityHistoryV2026ApiGetHistoricalIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public getHistoricalIdentity(requestParameters: IdentityHistoryV2026ApiGetHistoricalIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).getHistoricalIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary List identity event history - * @param {IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public getHistoricalIdentityEvents(requestParameters: IdentityHistoryV2026ApiGetHistoricalIdentityEventsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).getHistoricalIdentityEvents(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets an identity snapshot at a given date - * @param {IdentityHistoryV2026ApiGetIdentitySnapshotRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public getIdentitySnapshot(requestParameters: IdentityHistoryV2026ApiGetIdentitySnapshotRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).getIdentitySnapshot(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the summary for the event count for a specific identity - * @param {IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public getIdentitySnapshotSummary(requestParameters: IdentityHistoryV2026ApiGetIdentitySnapshotSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).getIdentitySnapshotSummary(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the start date of the identity - * @param {IdentityHistoryV2026ApiGetIdentityStartDateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public getIdentityStartDate(requestParameters: IdentityHistoryV2026ApiGetIdentityStartDateRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).getIdentityStartDate(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the identities - * @param {IdentityHistoryV2026ApiListHistoricalIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public listHistoricalIdentities(requestParameters: IdentityHistoryV2026ApiListHistoricalIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).listHistoricalIdentities(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves a list of access item for the identity filtered by the access item type - * @summary List access items by identity - * @param {IdentityHistoryV2026ApiListIdentityAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public listIdentityAccessItems(requestParameters: IdentityHistoryV2026ApiListIdentityAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).listIdentityAccessItems(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' - * @summary Gets the list of identity access items at a given date filterd by item type - * @param {IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public listIdentitySnapshotAccessItems(requestParameters: IdentityHistoryV2026ApiListIdentitySnapshotAccessItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).listIdentitySnapshotAccessItems(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' - * @summary Lists all the snapshots for the identity - * @param {IdentityHistoryV2026ApiListIdentitySnapshotsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityHistoryV2026Api - */ - public listIdentitySnapshots(requestParameters: IdentityHistoryV2026ApiListIdentitySnapshotsRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityHistoryV2026ApiFp(this.configuration).listIdentitySnapshots(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const CompareIdentitySnapshotsAccessTypeAccessTypeV2026 = { - AccessProfile: 'accessProfile', - Account: 'account', - App: 'app', - Entitlement: 'entitlement', - Role: 'role' -} as const; -export type CompareIdentitySnapshotsAccessTypeAccessTypeV2026 = typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2026[keyof typeof CompareIdentitySnapshotsAccessTypeAccessTypeV2026]; -/** - * @export - */ -export const GetIdentitySnapshotSummaryIntervalV2026 = { - Day: 'day', - Month: 'month' -} as const; -export type GetIdentitySnapshotSummaryIntervalV2026 = typeof GetIdentitySnapshotSummaryIntervalV2026[keyof typeof GetIdentitySnapshotSummaryIntervalV2026]; -/** - * @export - */ -export const ListIdentityAccessItemsTypeV2026 = { - Account: 'account', - Entitlement: 'entitlement', - App: 'app', - AccessProfile: 'accessProfile', - Role: 'role' -} as const; -export type ListIdentityAccessItemsTypeV2026 = typeof ListIdentityAccessItemsTypeV2026[keyof typeof ListIdentityAccessItemsTypeV2026]; -/** - * @export - */ -export const ListIdentitySnapshotsIntervalV2026 = { - Day: 'day', - Month: 'month' -} as const; -export type ListIdentitySnapshotsIntervalV2026 = typeof ListIdentitySnapshotsIntervalV2026[keyof typeof ListIdentitySnapshotsIntervalV2026]; - - -/** - * IdentityProfilesV2026Api - axios parameter creator - * @export - */ -export const IdentityProfilesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2026} identityProfileV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile: async (identityProfileV2026: IdentityProfileV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileV2026' is not null or undefined - assertParamExists('createIdentityProfile', 'identityProfileV2026', identityProfileV2026) - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteIdentityProfiles', 'requestBody', requestBody) - const localVarPath = `/identity-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2026} identityPreviewRequestV2026 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview: async (identityPreviewRequestV2026: IdentityPreviewRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityPreviewRequestV2026' is not null or undefined - assertParamExists('generateIdentityPreview', 'identityPreviewRequestV2026', identityPreviewRequestV2026) - const localVarPath = `/identity-profiles/identity-preview`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2026 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles: async (identityProfileExportedObjectV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileExportedObjectV2026' is not null or undefined - assertParamExists('importIdentityProfiles', 'identityProfileExportedObjectV2026', identityProfileExportedObjectV2026) - const localVarPath = `/identity-profiles/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObjectV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('syncIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/process-identities` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2026 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile: async (identityProfileId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateIdentityProfile', 'identityProfileId', identityProfileId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateIdentityProfile', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * IdentityProfilesV2026Api - functional programming interface - * @export - */ -export const IdentityProfilesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityProfilesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfileV2026} identityProfileV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityProfile(identityProfileV2026: IdentityProfileV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfile(identityProfileV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.createIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.deleteIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfiles(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfiles(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.deleteIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.exportIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequestV2026} identityPreviewRequestV2026 Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async generateIdentityPreview(identityPreviewRequestV2026: IdentityPreviewRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.generateIdentityPreview(identityPreviewRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.generateIdentityPreview']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.getDefaultIdentityAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.getIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObjectV2026 Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importIdentityProfiles(identityProfileExportedObjectV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfiles(identityProfileExportedObjectV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.importIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.listIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.syncIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperationV2026 List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateIdentityProfile(identityProfileId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfile(identityProfileId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesV2026Api.updateIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityProfilesV2026Api - factory interface - * @export - */ -export const IdentityProfilesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityProfilesV2026ApiFp(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2026ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile(requestParameters: IdentityProfilesV2026ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityProfile(requestParameters.identityProfileV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2026ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile(requestParameters: IdentityProfilesV2026ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2026ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles(requestParameters: IdentityProfilesV2026ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2026ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles(requestParameters: IdentityProfilesV2026ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2026ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - generateIdentityPreview(requestParameters: IdentityProfilesV2026ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.generateIdentityPreview(requestParameters.identityPreviewRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2026ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile(requestParameters: IdentityProfilesV2026ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2026ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles(requestParameters: IdentityProfilesV2026ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importIdentityProfiles(requestParameters.identityProfileExportedObjectV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2026ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles(requestParameters: IdentityProfilesV2026ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2026ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile(requestParameters: IdentityProfilesV2026ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2026ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile(requestParameters: IdentityProfilesV2026ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityProfile operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiCreateIdentityProfileRequest - */ -export interface IdentityProfilesV2026ApiCreateIdentityProfileRequest { - /** - * - * @type {IdentityProfileV2026} - * @memberof IdentityProfilesV2026ApiCreateIdentityProfile - */ - readonly identityProfileV2026: IdentityProfileV2026 -} - -/** - * Request parameters for deleteIdentityProfile operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiDeleteIdentityProfileRequest - */ -export interface IdentityProfilesV2026ApiDeleteIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2026ApiDeleteIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for deleteIdentityProfiles operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiDeleteIdentityProfilesRequest - */ -export interface IdentityProfilesV2026ApiDeleteIdentityProfilesRequest { - /** - * Identity Profile bulk delete request body. - * @type {Array} - * @memberof IdentityProfilesV2026ApiDeleteIdentityProfiles - */ - readonly requestBody: Array -} - -/** - * Request parameters for exportIdentityProfiles operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiExportIdentityProfilesRequest - */ -export interface IdentityProfilesV2026ApiExportIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2026ApiExportIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2026ApiExportIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2026ApiExportIdentityProfiles - */ - 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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2026ApiExportIdentityProfiles - */ - 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, name, priority** - * @type {string} - * @memberof IdentityProfilesV2026ApiExportIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for generateIdentityPreview operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiGenerateIdentityPreviewRequest - */ -export interface IdentityProfilesV2026ApiGenerateIdentityPreviewRequest { - /** - * Identity Preview request body. - * @type {IdentityPreviewRequestV2026} - * @memberof IdentityProfilesV2026ApiGenerateIdentityPreview - */ - readonly identityPreviewRequestV2026: IdentityPreviewRequestV2026 -} - -/** - * Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest - */ -export interface IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest { - /** - * The Identity Profile ID. - * @type {string} - * @memberof IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfig - */ - readonly identityProfileId: string -} - -/** - * Request parameters for getIdentityProfile operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiGetIdentityProfileRequest - */ -export interface IdentityProfilesV2026ApiGetIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2026ApiGetIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for importIdentityProfiles operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiImportIdentityProfilesRequest - */ -export interface IdentityProfilesV2026ApiImportIdentityProfilesRequest { - /** - * Previously exported Identity Profiles. - * @type {Array} - * @memberof IdentityProfilesV2026ApiImportIdentityProfiles - */ - readonly identityProfileExportedObjectV2026: Array -} - -/** - * Request parameters for listIdentityProfiles operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiListIdentityProfilesRequest - */ -export interface IdentityProfilesV2026ApiListIdentityProfilesRequest { - /** - * 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 IdentityProfilesV2026ApiListIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesV2026ApiListIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesV2026ApiListIdentityProfiles - */ - 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesV2026ApiListIdentityProfiles - */ - 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, name, priority, created, modified, owner.id, owner.name** - * @type {string} - * @memberof IdentityProfilesV2026ApiListIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for syncIdentityProfile operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiSyncIdentityProfileRequest - */ -export interface IdentityProfilesV2026ApiSyncIdentityProfileRequest { - /** - * The Identity Profile ID to be processed - * @type {string} - * @memberof IdentityProfilesV2026ApiSyncIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for updateIdentityProfile operation in IdentityProfilesV2026Api. - * @export - * @interface IdentityProfilesV2026ApiUpdateIdentityProfileRequest - */ -export interface IdentityProfilesV2026ApiUpdateIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesV2026ApiUpdateIdentityProfile - */ - readonly identityProfileId: string - - /** - * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof IdentityProfilesV2026ApiUpdateIdentityProfile - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * IdentityProfilesV2026Api - object-oriented interface - * @export - * @class IdentityProfilesV2026Api - * @extends {BaseAPI} - */ -export class IdentityProfilesV2026Api extends BaseAPI { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesV2026ApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public createIdentityProfile(requestParameters: IdentityProfilesV2026ApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).createIdentityProfile(requestParameters.identityProfileV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesV2026ApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public deleteIdentityProfile(requestParameters: IdentityProfilesV2026ApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesV2026ApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public deleteIdentityProfiles(requestParameters: IdentityProfilesV2026ApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesV2026ApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public exportIdentityProfiles(requestParameters: IdentityProfilesV2026ApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy\'\'s attribute config is applied. - * @summary Generate identity profile preview - * @param {IdentityProfilesV2026ApiGenerateIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public generateIdentityPreview(requestParameters: IdentityProfilesV2026ApiGenerateIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).generateIdentityPreview(requestParameters.identityPreviewRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesV2026ApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesV2026ApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public getIdentityProfile(requestParameters: IdentityProfilesV2026ApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesV2026ApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public importIdentityProfiles(requestParameters: IdentityProfilesV2026ApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).importIdentityProfiles(requestParameters.identityProfileExportedObjectV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesV2026ApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public listIdentityProfiles(requestParameters: IdentityProfilesV2026ApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesV2026ApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public syncIdentityProfile(requestParameters: IdentityProfilesV2026ApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesV2026ApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesV2026Api - */ - public updateIdentityProfile(requestParameters: IdentityProfilesV2026ApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesV2026ApiFp(this.configuration).updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * JITAccessV2026Api - axios parameter creator - * @export - */ -export const JITAccessV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). - * @summary Get JIT activation policy configuration - * @param {GetJitActivationConfigConfigTypeV2026} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJitActivationConfig: async (configType: GetJitActivationConfigConfigTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configType' is not null or undefined - assertParamExists('getJitActivationConfig', 'configType', configType) - const localVarPath = `/jit-activation-config/{configType}` - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). - * @summary Update JIT activation policy configuration - * @param {PatchJitActivationConfigConfigTypeV2026} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. - * @param {Array} jitAccessOperationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchJitActivationConfig: async (configType: PatchJitActivationConfigConfigTypeV2026, jitAccessOperationRequestV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configType' is not null or undefined - assertParamExists('patchJitActivationConfig', 'configType', configType) - // verify required parameter 'jitAccessOperationRequestV2026' is not null or undefined - assertParamExists('patchJitActivationConfig', 'jitAccessOperationRequestV2026', jitAccessOperationRequestV2026) - const localVarPath = `/jit-activation-config/{configType}` - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jitAccessOperationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * JITAccessV2026Api - functional programming interface - * @export - */ -export const JITAccessV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = JITAccessV2026ApiAxiosParamCreator(configuration) - return { - /** - * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). - * @summary Get JIT activation policy configuration - * @param {GetJitActivationConfigConfigTypeV2026} configType Configuration kind to read. Only **policy** (JIT activation policy) is supported today. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getJitActivationConfig(configType: GetJitActivationConfigConfigTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getJitActivationConfig(configType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['JITAccessV2026Api.getJitActivationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). - * @summary Update JIT activation policy configuration - * @param {PatchJitActivationConfigConfigTypeV2026} configType Configuration kind to update. Only **policy** (JIT activation policy) is supported today. - * @param {Array} jitAccessOperationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchJitActivationConfig(configType: PatchJitActivationConfigConfigTypeV2026, jitAccessOperationRequestV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchJitActivationConfig(configType, jitAccessOperationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['JITAccessV2026Api.patchJitActivationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * JITAccessV2026Api - factory interface - * @export - */ -export const JITAccessV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = JITAccessV2026ApiFp(configuration) - return { - /** - * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). - * @summary Get JIT activation policy configuration - * @param {JITAccessV2026ApiGetJitActivationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJitActivationConfig(requestParameters: JITAccessV2026ApiGetJitActivationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getJitActivationConfig(requestParameters.configType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). - * @summary Update JIT activation policy configuration - * @param {JITAccessV2026ApiPatchJitActivationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchJitActivationConfig(requestParameters: JITAccessV2026ApiPatchJitActivationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchJitActivationConfig(requestParameters.configType, requestParameters.jitAccessOperationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getJitActivationConfig operation in JITAccessV2026Api. - * @export - * @interface JITAccessV2026ApiGetJitActivationConfigRequest - */ -export interface JITAccessV2026ApiGetJitActivationConfigRequest { - /** - * Configuration kind to read. Only **policy** (JIT activation policy) is supported today. - * @type {'policy'} - * @memberof JITAccessV2026ApiGetJitActivationConfig - */ - readonly configType: GetJitActivationConfigConfigTypeV2026 -} - -/** - * Request parameters for patchJitActivationConfig operation in JITAccessV2026Api. - * @export - * @interface JITAccessV2026ApiPatchJitActivationConfigRequest - */ -export interface JITAccessV2026ApiPatchJitActivationConfigRequest { - /** - * Configuration kind to update. Only **policy** (JIT activation policy) is supported today. - * @type {'policy'} - * @memberof JITAccessV2026ApiPatchJitActivationConfig - */ - readonly configType: PatchJitActivationConfigConfigTypeV2026 - - /** - * - * @type {Array} - * @memberof JITAccessV2026ApiPatchJitActivationConfig - */ - readonly jitAccessOperationRequestV2026: Array -} - -/** - * JITAccessV2026Api - object-oriented interface - * @export - * @class JITAccessV2026Api - * @extends {BaseAPI} - */ -export class JITAccessV2026Api extends BaseAPI { - /** - * Returns the tenant\'s current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. **User level:** POLICY_ADMIN (policy administrator). - * @summary Get JIT activation policy configuration - * @param {JITAccessV2026ApiGetJitActivationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof JITAccessV2026Api - */ - public getJitActivationConfig(requestParameters: JITAccessV2026ApiGetJitActivationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return JITAccessV2026ApiFp(this.configuration).getJitActivationConfig(requestParameters.configType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the tenant\'s JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. **User level:** POLICY_ADMIN (policy administrator). - * @summary Update JIT activation policy configuration - * @param {JITAccessV2026ApiPatchJitActivationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof JITAccessV2026Api - */ - public patchJitActivationConfig(requestParameters: JITAccessV2026ApiPatchJitActivationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return JITAccessV2026ApiFp(this.configuration).patchJitActivationConfig(requestParameters.configType, requestParameters.jitAccessOperationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetJitActivationConfigConfigTypeV2026 = { - Policy: 'policy' -} as const; -export type GetJitActivationConfigConfigTypeV2026 = typeof GetJitActivationConfigConfigTypeV2026[keyof typeof GetJitActivationConfigConfigTypeV2026]; -/** - * @export - */ -export const PatchJitActivationConfigConfigTypeV2026 = { - Policy: 'policy' -} as const; -export type PatchJitActivationConfigConfigTypeV2026 = typeof PatchJitActivationConfigConfigTypeV2026[keyof typeof PatchJitActivationConfigConfigTypeV2026]; - - -/** - * JITActivationsV2026Api - axios parameter creator - * @export - */ -export const JITActivationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. - * @summary Start JIT activation workflow - * @param {JitActivationActivateRequestV2026} jitActivationActivateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startActivateWorkflow: async (jitActivationActivateRequestV2026: JitActivationActivateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jitActivationActivateRequestV2026' is not null or undefined - assertParamExists('startActivateWorkflow', 'jitActivationActivateRequestV2026', jitActivationActivateRequestV2026) - const localVarPath = `/jit-activations/activate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jitActivationActivateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Deactivate JIT activation workflow - * @param {JitActivationDeactivateRequestV2026} jitActivationDeactivateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startDeactivateWorkflow: async (jitActivationDeactivateRequestV2026: JitActivationDeactivateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jitActivationDeactivateRequestV2026' is not null or undefined - assertParamExists('startDeactivateWorkflow', 'jitActivationDeactivateRequestV2026', jitActivationDeactivateRequestV2026) - const localVarPath = `/jit-activations/deactivate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jitActivationDeactivateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Extend JIT activation workflow - * @param {JitActivationExtendRequestV2026} jitActivationExtendRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startExtendWorkflow: async (jitActivationExtendRequestV2026: JitActivationExtendRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jitActivationExtendRequestV2026' is not null or undefined - assertParamExists('startExtendWorkflow', 'jitActivationExtendRequestV2026', jitActivationExtendRequestV2026) - const localVarPath = `/jit-activations/extend`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jitActivationExtendRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * JITActivationsV2026Api - functional programming interface - * @export - */ -export const JITActivationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = JITActivationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. - * @summary Start JIT activation workflow - * @param {JitActivationActivateRequestV2026} jitActivationActivateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startActivateWorkflow(jitActivationActivateRequestV2026: JitActivationActivateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startActivateWorkflow(jitActivationActivateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['JITActivationsV2026Api.startActivateWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Deactivate JIT activation workflow - * @param {JitActivationDeactivateRequestV2026} jitActivationDeactivateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startDeactivateWorkflow(jitActivationDeactivateRequestV2026: JitActivationDeactivateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startDeactivateWorkflow(jitActivationDeactivateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['JITActivationsV2026Api.startDeactivateWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Extend JIT activation workflow - * @param {JitActivationExtendRequestV2026} jitActivationExtendRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startExtendWorkflow(jitActivationExtendRequestV2026: JitActivationExtendRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startExtendWorkflow(jitActivationExtendRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['JITActivationsV2026Api.startExtendWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * JITActivationsV2026Api - factory interface - * @export - */ -export const JITActivationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = JITActivationsV2026ApiFp(configuration) - return { - /** - * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. - * @summary Start JIT activation workflow - * @param {JITActivationsV2026ApiStartActivateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startActivateWorkflow(requestParameters: JITActivationsV2026ApiStartActivateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startActivateWorkflow(requestParameters.jitActivationActivateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Deactivate JIT activation workflow - * @param {JITActivationsV2026ApiStartDeactivateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startDeactivateWorkflow(requestParameters: JITActivationsV2026ApiStartDeactivateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startDeactivateWorkflow(requestParameters.jitActivationDeactivateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Extend JIT activation workflow - * @param {JITActivationsV2026ApiStartExtendWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startExtendWorkflow(requestParameters: JITActivationsV2026ApiStartExtendWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startExtendWorkflow(requestParameters.jitActivationExtendRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startActivateWorkflow operation in JITActivationsV2026Api. - * @export - * @interface JITActivationsV2026ApiStartActivateWorkflowRequest - */ -export interface JITActivationsV2026ApiStartActivateWorkflowRequest { - /** - * - * @type {JitActivationActivateRequestV2026} - * @memberof JITActivationsV2026ApiStartActivateWorkflow - */ - readonly jitActivationActivateRequestV2026: JitActivationActivateRequestV2026 -} - -/** - * Request parameters for startDeactivateWorkflow operation in JITActivationsV2026Api. - * @export - * @interface JITActivationsV2026ApiStartDeactivateWorkflowRequest - */ -export interface JITActivationsV2026ApiStartDeactivateWorkflowRequest { - /** - * - * @type {JitActivationDeactivateRequestV2026} - * @memberof JITActivationsV2026ApiStartDeactivateWorkflow - */ - readonly jitActivationDeactivateRequestV2026: JitActivationDeactivateRequestV2026 -} - -/** - * Request parameters for startExtendWorkflow operation in JITActivationsV2026Api. - * @export - * @interface JITActivationsV2026ApiStartExtendWorkflowRequest - */ -export interface JITActivationsV2026ApiStartExtendWorkflowRequest { - /** - * - * @type {JitActivationExtendRequestV2026} - * @memberof JITActivationsV2026ApiStartExtendWorkflow - */ - readonly jitActivationExtendRequestV2026: JitActivationExtendRequestV2026 -} - -/** - * JITActivationsV2026Api - object-oriented interface - * @export - * @class JITActivationsV2026Api - * @extends {BaseAPI} - */ -export class JITActivationsV2026Api extends BaseAPI { - /** - * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation. The response is returned with HTTP 202 Accepted while the workflow initializes. - * @summary Start JIT activation workflow - * @param {JITActivationsV2026ApiStartActivateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof JITActivationsV2026Api - */ - public startActivateWorkflow(requestParameters: JITActivationsV2026ApiStartActivateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return JITActivationsV2026ApiFp(this.configuration).startActivateWorkflow(requestParameters.jitActivationActivateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Deactivate JIT activation workflow - * @param {JITActivationsV2026ApiStartDeactivateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof JITActivationsV2026Api - */ - public startDeactivateWorkflow(requestParameters: JITActivationsV2026ApiStartDeactivateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return JITActivationsV2026ApiFp(this.configuration).startDeactivateWorkflow(requestParameters.jitActivationDeactivateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes. This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases. The response is returned with HTTP 202 Accepted after the signal is sent. - * @summary Extend JIT activation workflow - * @param {JITActivationsV2026ApiStartExtendWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof JITActivationsV2026Api - */ - public startExtendWorkflow(requestParameters: JITActivationsV2026ApiStartExtendWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return JITActivationsV2026ApiFp(this.configuration).startExtendWorkflow(requestParameters.jitActivationExtendRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LaunchersV2026Api - axios parameter creator - * @export - */ -export const LaunchersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2026} launcherRequestV2026 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher: async (launcherRequestV2026: LauncherRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherRequestV2026' is not null or undefined - assertParamExists('createLauncher', 'launcherRequestV2026', launcherRequestV2026) - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('deleteLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('getLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers: async (filters?: string, next?: string, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/launchers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (next !== undefined) { - localVarQueryParameter['next'] = next; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2026} launcherRequestV2026 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher: async (launcherID: string, launcherRequestV2026: LauncherRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('putLauncher', 'launcherID', launcherID) - // verify required parameter 'launcherRequestV2026' is not null or undefined - assertParamExists('putLauncher', 'launcherRequestV2026', launcherRequestV2026) - const localVarPath = `/launchers/{launcherID}` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(launcherRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher: async (launcherID: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'launcherID' is not null or undefined - assertParamExists('startLauncher', 'launcherID', launcherID) - const localVarPath = `/launchers/{launcherID}/launch` - .replace(`{${"launcherID"}}`, encodeURIComponent(String(launcherID))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LaunchersV2026Api - functional programming interface - * @export - */ -export const LaunchersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LaunchersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LauncherRequestV2026} launcherRequestV2026 Payload to create a Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLauncher(launcherRequestV2026: LauncherRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLauncher(launcherRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.createLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {string} launcherID ID of the Launcher to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.deleteLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {string} launcherID ID of the Launcher to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.getLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @param {string} [next] Pagination marker - * @param {number} [limit] Number of Launchers to return - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLaunchers(filters?: string, next?: string, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLaunchers(filters, next, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.getLaunchers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {string} launcherID ID of the Launcher to be replaced - * @param {LauncherRequestV2026} launcherRequestV2026 Payload to replace Launcher - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putLauncher(launcherID: string, launcherRequestV2026: LauncherRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putLauncher(launcherID, launcherRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.putLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {string} launcherID ID of the Launcher to be launched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startLauncher(launcherID: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startLauncher(launcherID, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LaunchersV2026Api.startLauncher']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LaunchersV2026Api - factory interface - * @export - */ -export const LaunchersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LaunchersV2026ApiFp(configuration) - return { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2026ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLauncher(requestParameters: LaunchersV2026ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLauncher(requestParameters.launcherRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2026ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLauncher(requestParameters: LaunchersV2026ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2026ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLauncher(requestParameters: LaunchersV2026ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2026ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLaunchers(requestParameters: LaunchersV2026ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2026ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putLauncher(requestParameters: LaunchersV2026ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2026ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startLauncher(requestParameters: LaunchersV2026ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLauncher operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiCreateLauncherRequest - */ -export interface LaunchersV2026ApiCreateLauncherRequest { - /** - * Payload to create a Launcher - * @type {LauncherRequestV2026} - * @memberof LaunchersV2026ApiCreateLauncher - */ - readonly launcherRequestV2026: LauncherRequestV2026 -} - -/** - * Request parameters for deleteLauncher operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiDeleteLauncherRequest - */ -export interface LaunchersV2026ApiDeleteLauncherRequest { - /** - * ID of the Launcher to be deleted - * @type {string} - * @memberof LaunchersV2026ApiDeleteLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLauncher operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiGetLauncherRequest - */ -export interface LaunchersV2026ApiGetLauncherRequest { - /** - * ID of the Launcher to be retrieved - * @type {string} - * @memberof LaunchersV2026ApiGetLauncher - */ - readonly launcherID: string -} - -/** - * Request parameters for getLaunchers operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiGetLaunchersRequest - */ -export interface LaunchersV2026ApiGetLaunchersRequest { - /** - * 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: **description**: *sw* **disabled**: *eq* **name**: *sw* - * @type {string} - * @memberof LaunchersV2026ApiGetLaunchers - */ - readonly filters?: string - - /** - * Pagination marker - * @type {string} - * @memberof LaunchersV2026ApiGetLaunchers - */ - readonly next?: string - - /** - * Number of Launchers to return - * @type {number} - * @memberof LaunchersV2026ApiGetLaunchers - */ - readonly limit?: number -} - -/** - * Request parameters for putLauncher operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiPutLauncherRequest - */ -export interface LaunchersV2026ApiPutLauncherRequest { - /** - * ID of the Launcher to be replaced - * @type {string} - * @memberof LaunchersV2026ApiPutLauncher - */ - readonly launcherID: string - - /** - * Payload to replace Launcher - * @type {LauncherRequestV2026} - * @memberof LaunchersV2026ApiPutLauncher - */ - readonly launcherRequestV2026: LauncherRequestV2026 -} - -/** - * Request parameters for startLauncher operation in LaunchersV2026Api. - * @export - * @interface LaunchersV2026ApiStartLauncherRequest - */ -export interface LaunchersV2026ApiStartLauncherRequest { - /** - * ID of the Launcher to be launched - * @type {string} - * @memberof LaunchersV2026ApiStartLauncher - */ - readonly launcherID: string -} - -/** - * LaunchersV2026Api - object-oriented interface - * @export - * @class LaunchersV2026Api - * @extends {BaseAPI} - */ -export class LaunchersV2026Api extends BaseAPI { - /** - * Create a Launcher with given information - * @summary Create launcher - * @param {LaunchersV2026ApiCreateLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public createLauncher(requestParameters: LaunchersV2026ApiCreateLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).createLauncher(requestParameters.launcherRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete the given Launcher ID - * @summary Delete launcher - * @param {LaunchersV2026ApiDeleteLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public deleteLauncher(requestParameters: LaunchersV2026ApiDeleteLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).deleteLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get details for the given Launcher ID - * @summary Get launcher by id - * @param {LaunchersV2026ApiGetLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public getLauncher(requestParameters: LaunchersV2026ApiGetLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).getLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Return a list of Launchers for the authenticated tenant - * @summary List all launchers for tenant - * @param {LaunchersV2026ApiGetLaunchersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public getLaunchers(requestParameters: LaunchersV2026ApiGetLaunchersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).getLaunchers(requestParameters.filters, requestParameters.next, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replace the given Launcher ID with given payload - * @summary Replace launcher - * @param {LaunchersV2026ApiPutLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public putLauncher(requestParameters: LaunchersV2026ApiPutLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).putLauncher(requestParameters.launcherID, requestParameters.launcherRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Launch the given Launcher ID - * @summary Launch a launcher - * @param {LaunchersV2026ApiStartLauncherRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LaunchersV2026Api - */ - public startLauncher(requestParameters: LaunchersV2026ApiStartLauncherRequest, axiosOptions?: RawAxiosRequestConfig) { - return LaunchersV2026ApiFp(this.configuration).startLauncher(requestParameters.launcherID, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LifecycleStatesV2026Api - axios parameter creator - * @export - */ -export const LifecycleStatesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2026} lifecycleStateV2026 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState: async (identityProfileId: string, lifecycleStateV2026: LifecycleStateV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('createLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateV2026' is not null or undefined - assertParamExists('createLifecycleState', 'lifecycleStateV2026', lifecycleStateV2026) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(lifecycleStateV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('deleteLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('getLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates: async (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleStates', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2026} setLifecycleStateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState: async (identityId: string, setLifecycleStateRequestV2026: SetLifecycleStateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('setLifecycleState', 'identityId', identityId) - // verify required parameter 'setLifecycleStateRequestV2026' is not null or undefined - assertParamExists('setLifecycleState', 'setLifecycleStateRequestV2026', setLifecycleStateRequestV2026) - const localVarPath = `/identities/{identity-id}/set-lifecycle-state` - .replace(`{${"identity-id"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(setLifecycleStateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2026 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('updateLifecycleStates', 'lifecycleStateId', lifecycleStateId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateLifecycleStates', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * LifecycleStatesV2026Api - functional programming interface - * @export - */ -export const LifecycleStatesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LifecycleStatesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleStateV2026} lifecycleStateV2026 Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLifecycleState(identityProfileId: string, lifecycleStateV2026: LifecycleStateV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLifecycleState(identityProfileId, lifecycleStateV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.createLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.deleteLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.getLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStates(identityProfileId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.getLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequestV2026} setLifecycleStateRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setLifecycleState(identityId: string, setLifecycleStateRequestV2026: SetLifecycleStateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setLifecycleState(identityId, setLifecycleStateRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.setLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperationV2026 A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateLifecycleStates(identityProfileId: string, lifecycleStateId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStates(identityProfileId, lifecycleStateId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesV2026Api.updateLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LifecycleStatesV2026Api - factory interface - * @export - */ -export const LifecycleStatesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LifecycleStatesV2026ApiFp(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2026ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState(requestParameters: LifecycleStatesV2026ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2026ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState(requestParameters: LifecycleStatesV2026ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2026ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState(requestParameters: LifecycleStatesV2026ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2026ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates(requestParameters: LifecycleStatesV2026ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2026ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState(requestParameters: LifecycleStatesV2026ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2026ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates(requestParameters: LifecycleStatesV2026ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLifecycleState operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiCreateLifecycleStateRequest - */ -export interface LifecycleStatesV2026ApiCreateLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiCreateLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state to be created. - * @type {LifecycleStateV2026} - * @memberof LifecycleStatesV2026ApiCreateLifecycleState - */ - readonly lifecycleStateV2026: LifecycleStateV2026 -} - -/** - * Request parameters for deleteLifecycleState operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiDeleteLifecycleStateRequest - */ -export interface LifecycleStatesV2026ApiDeleteLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiDeleteLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiDeleteLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleState operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiGetLifecycleStateRequest - */ -export interface LifecycleStatesV2026ApiGetLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiGetLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiGetLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleStates operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiGetLifecycleStatesRequest - */ -export interface LifecycleStatesV2026ApiGetLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiGetLifecycleStates - */ - readonly identityProfileId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2026ApiGetLifecycleStates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesV2026ApiGetLifecycleStates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof LifecycleStatesV2026ApiGetLifecycleStates - */ - readonly count?: boolean - - /** - * 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: **name, priority, created, modified** - * @type {string} - * @memberof LifecycleStatesV2026ApiGetLifecycleStates - */ - readonly sorters?: string -} - -/** - * Request parameters for setLifecycleState operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiSetLifecycleStateRequest - */ -export interface LifecycleStatesV2026ApiSetLifecycleStateRequest { - /** - * ID of the identity to update. - * @type {string} - * @memberof LifecycleStatesV2026ApiSetLifecycleState - */ - readonly identityId: string - - /** - * - * @type {SetLifecycleStateRequestV2026} - * @memberof LifecycleStatesV2026ApiSetLifecycleState - */ - readonly setLifecycleStateRequestV2026: SetLifecycleStateRequestV2026 -} - -/** - * Request parameters for updateLifecycleStates operation in LifecycleStatesV2026Api. - * @export - * @interface LifecycleStatesV2026ApiUpdateLifecycleStatesRequest - */ -export interface LifecycleStatesV2026ApiUpdateLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiUpdateLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesV2026ApiUpdateLifecycleStates - */ - readonly lifecycleStateId: string - - /** - * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority - * @type {Array} - * @memberof LifecycleStatesV2026ApiUpdateLifecycleStates - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * LifecycleStatesV2026Api - object-oriented interface - * @export - * @class LifecycleStatesV2026Api - * @extends {BaseAPI} - */ -export class LifecycleStatesV2026Api extends BaseAPI { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesV2026ApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public createLifecycleState(requestParameters: LifecycleStatesV2026ApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesV2026ApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public deleteLifecycleState(requestParameters: LifecycleStatesV2026ApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesV2026ApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public getLifecycleState(requestParameters: LifecycleStatesV2026ApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesV2026ApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public getLifecycleStates(requestParameters: LifecycleStatesV2026ApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesV2026ApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public setLifecycleState(requestParameters: LifecycleStatesV2026ApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesV2026ApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesV2026Api - */ - public updateLifecycleStates(requestParameters: LifecycleStatesV2026ApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesV2026ApiFp(this.configuration).updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MFAConfigurationV2026Api - axios parameter creator - * @export - */ -export const MFAConfigurationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/duo-web/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/kba/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (allLanguages !== undefined) { - localVarQueryParameter['allLanguages'] = allLanguages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/okta-verify/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2026} mfaDuoConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig: async (mfaDuoConfigV2026: MfaDuoConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaDuoConfigV2026' is not null or undefined - assertParamExists('setMFADuoConfig', 'mfaDuoConfigV2026', mfaDuoConfigV2026) - const localVarPath = `/mfa/duo-web/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaDuoConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig: async (kbaAnswerRequestItemV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItemV2026' is not null or undefined - assertParamExists('setMFAKBAConfig', 'kbaAnswerRequestItemV2026', kbaAnswerRequestItemV2026) - const localVarPath = `/mfa/kba/config/answers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItemV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2026} mfaOktaConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig: async (mfaOktaConfigV2026: MfaOktaConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaOktaConfigV2026' is not null or undefined - assertParamExists('setMFAOktaConfig', 'mfaOktaConfigV2026', mfaOktaConfigV2026) - const localVarPath = `/mfa/okta-verify/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaOktaConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2026} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig: async (method: TestMFAConfigMethodV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('testMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/test` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAConfigurationV2026Api - functional programming interface - * @export - */ -export const MFAConfigurationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAConfigurationV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.getMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAKbaConfig(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfig(allLanguages, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.getMFAKbaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.getMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfigV2026} mfaDuoConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFADuoConfig(mfaDuoConfigV2026: MfaDuoConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfig(mfaDuoConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.setMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItemV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAKBAConfig(kbaAnswerRequestItemV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfig(kbaAnswerRequestItemV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.setMFAKBAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfigV2026} mfaOktaConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAOktaConfig(mfaOktaConfigV2026: MfaOktaConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfig(mfaOktaConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.setMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV2026} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testMFAConfig(method: TestMFAConfigMethodV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationV2026Api.testMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAConfigurationV2026Api - factory interface - * @export - */ -export const MFAConfigurationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAConfigurationV2026ApiFp(configuration) - return { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFADuoConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2026ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig(requestParameters: MFAConfigurationV2026ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFAOktaConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2026ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig(requestParameters: MFAConfigurationV2026ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFADuoConfig(requestParameters.mfaDuoConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2026ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig(requestParameters: MFAConfigurationV2026ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2026ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig(requestParameters: MFAConfigurationV2026ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFAOktaConfig(requestParameters.mfaOktaConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2026ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig(requestParameters: MFAConfigurationV2026ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getMFAKbaConfig operation in MFAConfigurationV2026Api. - * @export - * @interface MFAConfigurationV2026ApiGetMFAKbaConfigRequest - */ -export interface MFAConfigurationV2026ApiGetMFAKbaConfigRequest { - /** - * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @type {boolean} - * @memberof MFAConfigurationV2026ApiGetMFAKbaConfig - */ - readonly allLanguages?: boolean -} - -/** - * Request parameters for setMFADuoConfig operation in MFAConfigurationV2026Api. - * @export - * @interface MFAConfigurationV2026ApiSetMFADuoConfigRequest - */ -export interface MFAConfigurationV2026ApiSetMFADuoConfigRequest { - /** - * - * @type {MfaDuoConfigV2026} - * @memberof MFAConfigurationV2026ApiSetMFADuoConfig - */ - readonly mfaDuoConfigV2026: MfaDuoConfigV2026 -} - -/** - * Request parameters for setMFAKBAConfig operation in MFAConfigurationV2026Api. - * @export - * @interface MFAConfigurationV2026ApiSetMFAKBAConfigRequest - */ -export interface MFAConfigurationV2026ApiSetMFAKBAConfigRequest { - /** - * - * @type {Array} - * @memberof MFAConfigurationV2026ApiSetMFAKBAConfig - */ - readonly kbaAnswerRequestItemV2026: Array -} - -/** - * Request parameters for setMFAOktaConfig operation in MFAConfigurationV2026Api. - * @export - * @interface MFAConfigurationV2026ApiSetMFAOktaConfigRequest - */ -export interface MFAConfigurationV2026ApiSetMFAOktaConfigRequest { - /** - * - * @type {MfaOktaConfigV2026} - * @memberof MFAConfigurationV2026ApiSetMFAOktaConfig - */ - readonly mfaOktaConfigV2026: MfaOktaConfigV2026 -} - -/** - * Request parameters for testMFAConfig operation in MFAConfigurationV2026Api. - * @export - * @interface MFAConfigurationV2026ApiTestMFAConfigRequest - */ -export interface MFAConfigurationV2026ApiTestMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationV2026ApiTestMFAConfig - */ - readonly method: TestMFAConfigMethodV2026 -} - -/** - * MFAConfigurationV2026Api - object-oriented interface - * @export - * @class MFAConfigurationV2026Api - * @extends {BaseAPI} - */ -export class MFAConfigurationV2026Api extends BaseAPI { - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).getMFADuoConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationV2026ApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public getMFAKbaConfig(requestParameters: MFAConfigurationV2026ApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).getMFAOktaConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationV2026ApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public setMFADuoConfig(requestParameters: MFAConfigurationV2026ApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).setMFADuoConfig(requestParameters.mfaDuoConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationV2026ApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public setMFAKBAConfig(requestParameters: MFAConfigurationV2026ApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).setMFAKBAConfig(requestParameters.kbaAnswerRequestItemV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationV2026ApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public setMFAOktaConfig(requestParameters: MFAConfigurationV2026ApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).setMFAOktaConfig(requestParameters.mfaOktaConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationV2026ApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationV2026Api - */ - public testMFAConfig(requestParameters: MFAConfigurationV2026ApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationV2026ApiFp(this.configuration).testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const TestMFAConfigMethodV2026 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type TestMFAConfigMethodV2026 = typeof TestMFAConfigMethodV2026[keyof typeof TestMFAConfigMethodV2026]; - - -/** - * MachineAccountClassifyV2026Api - axios parameter creator - * @export - */ -export const MachineAccountClassifyV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2026} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount: async (id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendClassifyMachineAccount', 'id', id) - const localVarPath = `/accounts/{id}/classify` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (classificationMode !== undefined) { - localVarQueryParameter['classificationMode'] = classificationMode; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountClassifyV2026Api - functional programming interface - * @export - */ -export const MachineAccountClassifyV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountClassifyV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {string} id Account ID. - * @param {SendClassifyMachineAccountClassificationModeV2026} [classificationMode] Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendClassifyMachineAccount(id: string, classificationMode?: SendClassifyMachineAccountClassificationModeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendClassifyMachineAccount(id, classificationMode, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountClassifyV2026Api.sendClassifyMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountClassifyV2026Api - factory interface - * @export - */ -export const MachineAccountClassifyV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountClassifyV2026ApiFp(configuration) - return { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for sendClassifyMachineAccount operation in MachineAccountClassifyV2026Api. - * @export - * @interface MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest - */ -export interface MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof MachineAccountClassifyV2026ApiSendClassifyMachineAccount - */ - readonly id: string - - /** - * Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. - * @type {'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman'} - * @memberof MachineAccountClassifyV2026ApiSendClassifyMachineAccount - */ - readonly classificationMode?: SendClassifyMachineAccountClassificationModeV2026 -} - -/** - * MachineAccountClassifyV2026Api - object-oriented interface - * @export - * @class MachineAccountClassifyV2026Api - * @extends {BaseAPI} - */ -export class MachineAccountClassifyV2026Api extends BaseAPI { - /** - * Use this API to classify a single machine account. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Classify single machine account - * @param {MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountClassifyV2026Api - */ - public sendClassifyMachineAccount(requestParameters: MachineAccountClassifyV2026ApiSendClassifyMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountClassifyV2026ApiFp(this.configuration).sendClassifyMachineAccount(requestParameters.id, requestParameters.classificationMode, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SendClassifyMachineAccountClassificationModeV2026 = { - Default: 'default', - IgnoreManual: 'ignoreManual', - ForceMachine: 'forceMachine', - ForceHuman: 'forceHuman' -} as const; -export type SendClassifyMachineAccountClassificationModeV2026 = typeof SendClassifyMachineAccountClassificationModeV2026[keyof typeof SendClassifyMachineAccountClassificationModeV2026]; - - -/** - * MachineAccountCreationRequestV2026Api - axios parameter creator - * @export - */ -export const MachineAccountCreationRequestV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** - * @summary Submit Machine Account Creation Request - * @param {MachineAccountCreateRequestInputV2026} machineAccountCreateRequestInputV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountRequest: async (machineAccountCreateRequestInputV2026: MachineAccountCreateRequestInputV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'machineAccountCreateRequestInputV2026' is not null or undefined - assertParamExists('createMachineAccountRequest', 'machineAccountCreateRequestInputV2026', machineAccountCreateRequestInputV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/account-requests/machine-account-create`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineAccountCreateRequestInputV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. - * @summary Get Machine Account Creation Request - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} accountRequestId Account Request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCreateMachineAccountRequest: async (xSailPointExperimental: string, accountRequestId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('getCreateMachineAccountRequest', 'xSailPointExperimental', xSailPointExperimental) - // verify required parameter 'accountRequestId' is not null or undefined - assertParamExists('getCreateMachineAccountRequest', 'accountRequestId', accountRequestId) - const localVarPath = `/account-requests/machine-account-create/{accountRequestId}` - .replace(`{${"accountRequestId"}}`, encodeURIComponent(String(accountRequestId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. - * @summary Machine Account Create Access - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountCreateAccessInfo: async (xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('getMachineAccountCreateAccessInfo', 'xSailPointExperimental', xSailPointExperimental) - const localVarPath = `/source-subtypes/machine-account-create-access`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountCreationRequestV2026Api - functional programming interface - * @export - */ -export const MachineAccountCreationRequestV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountCreationRequestV2026ApiAxiosParamCreator(configuration) - return { - /** - * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** - * @summary Submit Machine Account Creation Request - * @param {MachineAccountCreateRequestInputV2026} machineAccountCreateRequestInputV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineAccountRequest(machineAccountCreateRequestInputV2026: MachineAccountCreateRequestInputV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountRequest(machineAccountCreateRequestInputV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV2026Api.createMachineAccountRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. - * @summary Get Machine Account Creation Request - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} accountRequestId Account Request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCreateMachineAccountRequest(xSailPointExperimental: string, accountRequestId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCreateMachineAccountRequest(xSailPointExperimental, accountRequestId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV2026Api.getCreateMachineAccountRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. - * @summary Machine Account Create Access - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccountCreateAccessInfo(xSailPointExperimental: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountCreateAccessInfo(xSailPointExperimental, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountCreationRequestV2026Api.getMachineAccountCreateAccessInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountCreationRequestV2026Api - factory interface - * @export - */ -export const MachineAccountCreationRequestV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountCreationRequestV2026ApiFp(configuration) - return { - /** - * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** - * @summary Submit Machine Account Creation Request - * @param {MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountRequest(requestParameters: MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineAccountRequest(requestParameters.machineAccountCreateRequestInputV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. - * @summary Get Machine Account Creation Request - * @param {MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCreateMachineAccountRequest(requestParameters: MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCreateMachineAccountRequest(requestParameters.xSailPointExperimental, requestParameters.accountRequestId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. - * @summary Machine Account Create Access - * @param {MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountCreateAccessInfo(requestParameters: MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMachineAccountCreateAccessInfo(requestParameters.xSailPointExperimental, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountRequest operation in MachineAccountCreationRequestV2026Api. - * @export - * @interface MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest - */ -export interface MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest { - /** - * - * @type {MachineAccountCreateRequestInputV2026} - * @memberof MachineAccountCreationRequestV2026ApiCreateMachineAccountRequest - */ - readonly machineAccountCreateRequestInputV2026: MachineAccountCreateRequestInputV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountCreationRequestV2026ApiCreateMachineAccountRequest - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getCreateMachineAccountRequest operation in MachineAccountCreationRequestV2026Api. - * @export - * @interface MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest - */ -export interface MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequest - */ - readonly xSailPointExperimental: string - - /** - * Account Request ID - * @type {string} - * @memberof MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequest - */ - readonly accountRequestId: string -} - -/** - * Request parameters for getMachineAccountCreateAccessInfo operation in MachineAccountCreationRequestV2026Api. - * @export - * @interface MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest - */ -export interface MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfo - */ - readonly xSailPointExperimental: string - - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfo - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfo - */ - readonly limit?: number -} - -/** - * MachineAccountCreationRequestV2026Api - object-oriented interface - * @export - * @class MachineAccountCreationRequestV2026Api - * @extends {BaseAPI} - */ -export class MachineAccountCreationRequestV2026Api extends BaseAPI { - /** - * Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID. >**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** - * @summary Submit Machine Account Creation Request - * @param {MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountCreationRequestV2026Api - */ - public createMachineAccountRequest(requestParameters: MachineAccountCreationRequestV2026ApiCreateMachineAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountCreationRequestV2026ApiFp(this.configuration).createMachineAccountRequest(requestParameters.machineAccountCreateRequestInputV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. - * @summary Get Machine Account Creation Request - * @param {MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountCreationRequestV2026Api - */ - public getCreateMachineAccountRequest(requestParameters: MachineAccountCreationRequestV2026ApiGetCreateMachineAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountCreationRequestV2026ApiFp(this.configuration).getCreateMachineAccountRequest(requestParameters.xSailPointExperimental, requestParameters.accountRequestId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. - * @summary Machine Account Create Access - * @param {MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountCreationRequestV2026Api - */ - public getMachineAccountCreateAccessInfo(requestParameters: MachineAccountCreationRequestV2026ApiGetMachineAccountCreateAccessInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountCreationRequestV2026ApiFp(this.configuration).getMachineAccountCreateAccessInfo(requestParameters.xSailPointExperimental, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineAccountMappingsV2026Api - axios parameter creator - * @export - */ -export const MachineAccountMappingsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2026} attributeMappingsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings: async (id: string, attributeMappingsV2026: AttributeMappingsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2026' is not null or undefined - assertParamExists('createMachineAccountMappings', 'attributeMappingsV2026', attributeMappingsV2026) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings: async (id: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listMachineAccountMappings', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-account-mappings` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2026} attributeMappingsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings: async (id: string, attributeMappingsV2026: AttributeMappingsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineAccountMappings', 'id', id) - // verify required parameter 'attributeMappingsV2026' is not null or undefined - assertParamExists('setMachineAccountMappings', 'attributeMappingsV2026', attributeMappingsV2026) - const localVarPath = `/sources/{sourceId}/machine-mappings` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attributeMappingsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountMappingsV2026Api - functional programming interface - * @export - */ -export const MachineAccountMappingsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountMappingsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2026} attributeMappingsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineAccountMappings(id: string, attributeMappingsV2026: AttributeMappingsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountMappings(id, attributeMappingsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2026Api.createMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {string} id source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineAccountMappings(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountMappings(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2026Api.deleteMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {string} id Source ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccountMappings(id: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountMappings(id, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2026Api.listMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {string} id Source ID. - * @param {AttributeMappingsV2026} attributeMappingsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineAccountMappings(id: string, attributeMappingsV2026: AttributeMappingsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineAccountMappings(id, attributeMappingsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountMappingsV2026Api.setMachineAccountMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountMappingsV2026Api - factory interface - * @export - */ -export const MachineAccountMappingsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountMappingsV2026ApiFp(configuration) - return { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountMappings operation in MachineAccountMappingsV2026Api. - * @export - * @interface MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2026ApiCreateMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2026} - * @memberof MachineAccountMappingsV2026ApiCreateMachineAccountMappings - */ - readonly attributeMappingsV2026: AttributeMappingsV2026 -} - -/** - * Request parameters for deleteMachineAccountMappings operation in MachineAccountMappingsV2026Api. - * @export - * @interface MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest { - /** - * source ID. - * @type {string} - * @memberof MachineAccountMappingsV2026ApiDeleteMachineAccountMappings - */ - readonly id: string -} - -/** - * Request parameters for listMachineAccountMappings operation in MachineAccountMappingsV2026Api. - * @export - * @interface MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest { - /** - * Source ID - * @type {string} - * @memberof MachineAccountMappingsV2026ApiListMachineAccountMappings - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2026ApiListMachineAccountMappings - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountMappingsV2026ApiListMachineAccountMappings - */ - readonly offset?: number -} - -/** - * Request parameters for setMachineAccountMappings operation in MachineAccountMappingsV2026Api. - * @export - * @interface MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest - */ -export interface MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineAccountMappingsV2026ApiSetMachineAccountMappings - */ - readonly id: string - - /** - * - * @type {AttributeMappingsV2026} - * @memberof MachineAccountMappingsV2026ApiSetMachineAccountMappings - */ - readonly attributeMappingsV2026: AttributeMappingsV2026 -} - -/** - * MachineAccountMappingsV2026Api - object-oriented interface - * @export - * @class MachineAccountMappingsV2026Api - * @extends {BaseAPI} - */ -export class MachineAccountMappingsV2026Api extends BaseAPI { - /** - * Creates Machine Account Mappings for both identities and accounts for a source. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create machine account mappings - * @param {MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2026Api - */ - public createMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiCreateMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2026ApiFp(this.configuration).createMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to remove machine account attribute mappings for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s machine account mappings - * @param {MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2026Api - */ - public deleteMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiDeleteMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2026ApiFp(this.configuration).deleteMachineAccountMappings(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves Machine account mappings for a specified source using Source ID. - * @summary Machine account mapping for source - * @param {MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2026Api - */ - public listMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiListMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2026ApiFp(this.configuration).listMachineAccountMappings(requestParameters.id, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s machine account mappings - * @param {MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountMappingsV2026Api - */ - public setMachineAccountMappings(requestParameters: MachineAccountMappingsV2026ApiSetMachineAccountMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountMappingsV2026ApiFp(this.configuration).setMachineAccountMappings(requestParameters.id, requestParameters.attributeMappingsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineAccountSubtypesV2026Api - axios parameter creator - * @export - */ -export const MachineAccountSubtypesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new machine account subtype. - * @summary Create subtype - * @param {CreateSourceSubtypeRequestV2026} createSourceSubtypeRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSubtype: async (createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createSourceSubtypeRequestV2026' is not null or undefined - assertParamExists('createSourceSubtype', 'createSourceSubtypeRequestV2026', createSourceSubtypeRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-subtypes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createSourceSubtypeRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. - * @summary Delete subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountSubtype: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('deleteMachineAccountSubtype', 'subtypeId', subtypeId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-subtypes/{subtypeId}` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. - * @summary Machine Subtype Approval Config - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} subtypeId machine subtype id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountSubtypeApprovalConfig: async (xSailPointExperimental: string, subtypeId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('getMachineAccountSubtypeApprovalConfig', 'xSailPointExperimental', xSailPointExperimental) - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('getMachineAccountSubtypeApprovalConfig', 'subtypeId', subtypeId) - const localVarPath = `/source-subtypes/{subtypeId}/machine-config` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a machine account subtype by subtype ID. - * @summary Get subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSubtypeById: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('getSourceSubtypeById', 'subtypeId', subtypeId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-subtypes/{subtypeId}` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get all machine account subtypes. - * @summary Retrieve all subtypes - * @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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSourceSubtypes: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-subtypes`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint retrieves the subtypes for given subtypeIds. - * @summary Bulk Retrieve of Source Subtypes - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadBulkSourceSubtypes: async (xSailPointExperimental: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('loadBulkSourceSubtypes', 'xSailPointExperimental', xSailPointExperimental) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('loadBulkSourceSubtypes', 'requestBody', requestBody) - const localVarPath = `/source-subtypes/bulk-retrieve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. - * @summary Patch subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchMachineAccountSubtype: async (subtypeId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('patchMachineAccountSubtype', 'subtypeId', subtypeId) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchMachineAccountSubtype', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/source-subtypes/{subtypeId}` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. - * @summary Machine Subtype Approval Config - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} subtypeId machine account subtype ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccountSubtypeApprovalConfig: async (xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - // verify required parameter 'xSailPointExperimental' is not null or undefined - assertParamExists('updateMachineAccountSubtypeApprovalConfig', 'xSailPointExperimental', xSailPointExperimental) - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('updateMachineAccountSubtypeApprovalConfig', 'subtypeId', subtypeId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateMachineAccountSubtypeApprovalConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/source-subtypes/{subtypeId}/machine-config` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountSubtypesV2026Api - functional programming interface - * @export - */ -export const MachineAccountSubtypesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountSubtypesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new machine account subtype. - * @summary Create subtype - * @param {CreateSourceSubtypeRequestV2026} createSourceSubtypeRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSubtype(createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSubtype(createSourceSubtypeRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.createSourceSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. - * @summary Delete subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineAccountSubtype(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountSubtype(subtypeId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.deleteMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. - * @summary Machine Subtype Approval Config - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} subtypeId machine subtype id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeApprovalConfig(xSailPointExperimental, subtypeId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.getMachineAccountSubtypeApprovalConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a machine account subtype by subtype ID. - * @summary Get subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSubtypeById(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSubtypeById(subtypeId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.getSourceSubtypeById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get all machine account subtypes. - * @summary Retrieve all subtypes - * @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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSourceSubtypes(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSourceSubtypes(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.listSourceSubtypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint retrieves the subtypes for given subtypeIds. - * @summary Bulk Retrieve of Source Subtypes - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {Array} requestBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async loadBulkSourceSubtypes(xSailPointExperimental: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.loadBulkSourceSubtypes(xSailPointExperimental, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.loadBulkSourceSubtypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. - * @summary Patch subtype by ID - * @param {string} subtypeId The ID of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchMachineAccountSubtype(subtypeId: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchMachineAccountSubtype(subtypeId, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.patchMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. - * @summary Machine Subtype Approval Config - * @param {string} xSailPointExperimental Use this header to enable this experimental API. - * @param {string} subtypeId machine account subtype ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccountSubtypeApprovalConfig(xSailPointExperimental, subtypeId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountSubtypesV2026Api.updateMachineAccountSubtypeApprovalConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountSubtypesV2026Api - factory interface - * @export - */ -export const MachineAccountSubtypesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountSubtypesV2026ApiFp(configuration) - return { - /** - * Create a new machine account subtype. - * @summary Create subtype - * @param {MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSubtype(requestParameters: MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSubtype(requestParameters.createSourceSubtypeRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. - * @summary Delete subtype by ID - * @param {MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountSubtype(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. - * @summary Machine Subtype Approval Config - * @param {MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountSubtypeApprovalConfig(requestParameters.xSailPointExperimental, requestParameters.subtypeId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a machine account subtype by subtype ID. - * @summary Get subtype by ID - * @param {MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSubtypeById(requestParameters: MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get all machine account subtypes. - * @summary Retrieve all subtypes - * @param {MachineAccountSubtypesV2026ApiListSourceSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiListSourceSubtypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSourceSubtypes(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint retrieves the subtypes for given subtypeIds. - * @summary Bulk Retrieve of Source Subtypes - * @param {MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - loadBulkSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.loadBulkSourceSubtypes(requestParameters.xSailPointExperimental, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. - * @summary Patch subtype by ID - * @param {MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchMachineAccountSubtype(requestParameters.subtypeId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. - * @summary Machine Subtype Approval Config - * @param {MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineAccountSubtypeApprovalConfig(requestParameters.xSailPointExperimental, requestParameters.subtypeId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSourceSubtype operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest - */ -export interface MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest { - /** - * - * @type {CreateSourceSubtypeRequestV2026} - * @memberof MachineAccountSubtypesV2026ApiCreateSourceSubtype - */ - readonly createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiCreateSourceSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineAccountSubtype operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest - */ -export interface MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest { - /** - * The ID of the subtype. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtype - */ - readonly subtypeId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccountSubtypeApprovalConfig operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest - */ -export interface MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfig - */ - readonly xSailPointExperimental: string - - /** - * machine subtype id. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfig - */ - readonly subtypeId: string -} - -/** - * Request parameters for getSourceSubtypeById operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest - */ -export interface MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest { - /** - * The ID of the subtype. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiGetSourceSubtypeById - */ - readonly subtypeId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiGetSourceSubtypeById - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listSourceSubtypes operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiListSourceSubtypesRequest - */ -export interface MachineAccountSubtypesV2026ApiListSourceSubtypesRequest { - /** - * 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, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - 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: **displayName, technicalName** - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - readonly count?: boolean - - /** - * 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 MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes - */ - readonly offset?: number -} - -/** - * Request parameters for loadBulkSourceSubtypes operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest - */ -export interface MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypes - */ - readonly xSailPointExperimental: string - - /** - * - * @type {Array} - * @memberof MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypes - */ - readonly requestBody: Array -} - -/** - * Request parameters for patchMachineAccountSubtype operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest - */ -export interface MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest { - /** - * The ID of the subtype. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiPatchMachineAccountSubtype - */ - readonly subtypeId: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineAccountSubtypesV2026ApiPatchMachineAccountSubtype - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiPatchMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineAccountSubtypeApprovalConfig operation in MachineAccountSubtypesV2026Api. - * @export - * @interface MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest - */ -export interface MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig - */ - readonly xSailPointExperimental: string - - /** - * machine account subtype ID. - * @type {string} - * @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig - */ - readonly subtypeId: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * MachineAccountSubtypesV2026Api - object-oriented interface - * @export - * @class MachineAccountSubtypesV2026Api - * @extends {BaseAPI} - */ -export class MachineAccountSubtypesV2026Api extends BaseAPI { - /** - * Create a new machine account subtype. - * @summary Create subtype - * @param {MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public createSourceSubtype(requestParameters: MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).createSourceSubtype(requestParameters.createSourceSubtypeRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted. - * @summary Delete subtype by ID - * @param {MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public deleteMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).deleteMachineAccountSubtype(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. - * @summary Machine Subtype Approval Config - * @param {MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).getMachineAccountSubtypeApprovalConfig(requestParameters.xSailPointExperimental, requestParameters.subtypeId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a machine account subtype by subtype ID. - * @summary Get subtype by ID - * @param {MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public getSourceSubtypeById(requestParameters: MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).getSourceSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get all machine account subtypes. - * @summary Retrieve all subtypes - * @param {MachineAccountSubtypesV2026ApiListSourceSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public listSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiListSourceSubtypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).listSourceSubtypes(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint retrieves the subtypes for given subtypeIds. - * @summary Bulk Retrieve of Source Subtypes - * @param {MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public loadBulkSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).loadBulkSourceSubtypes(requestParameters.xSailPointExperimental, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`. - * @summary Patch subtype by ID - * @param {MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public patchMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).patchMachineAccountSubtype(requestParameters.subtypeId, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. - * @summary Machine Subtype Approval Config - * @param {MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountSubtypesV2026Api - */ - public updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountSubtypesV2026ApiFp(this.configuration).updateMachineAccountSubtypeApprovalConfig(requestParameters.xSailPointExperimental, requestParameters.subtypeId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineAccountsV2026Api - axios parameter creator - * @export - */ -export const MachineAccountsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {string} sourceId The ID of the source. - * @param {CreateMachineAccountSubtypeRequestV2026} createMachineAccountSubtypeRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createMachineAccountSubtype: async (sourceId: string, createMachineAccountSubtypeRequestV2026: CreateMachineAccountSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createMachineAccountSubtype', 'sourceId', sourceId) - // verify required parameter 'createMachineAccountSubtypeRequestV2026' is not null or undefined - assertParamExists('createMachineAccountSubtype', 'createMachineAccountSubtypeRequestV2026', createMachineAccountSubtypeRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createMachineAccountSubtypeRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteMachineAccountSubtypeByTechnicalName: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteMachineAccountSubtypeByTechnicalName', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('deleteMachineAccountSubtypeByTechnicalName', 'technicalName', technicalName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineAccount', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {string} subtypeId The ID of the machine account subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeById: async (subtypeId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subtypeId' is not null or undefined - assertParamExists('getMachineAccountSubtypeById', 'subtypeId', subtypeId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/subtypes/{subtypeId}` - .replace(`{${"subtypeId"}}`, encodeURIComponent(String(subtypeId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeByTechnicalName: async (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getMachineAccountSubtypeByTechnicalName', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('getMachineAccountSubtypeByTechnicalName', 'technicalName', technicalName) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {string} sourceId The ID of the source. - * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listMachineAccountSubtypes: async (sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listMachineAccountSubtypes', 'sourceId', sourceId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchMachineAccountSubtypeByTechnicalName: async (sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchMachineAccountSubtypeByTechnicalName', 'sourceId', sourceId) - // verify required parameter 'technicalName' is not null or undefined - assertParamExists('patchMachineAccountSubtypeByTechnicalName', 'technicalName', technicalName) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchMachineAccountSubtypeByTechnicalName', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/subtypes/{technicalName}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"technicalName"}}`, encodeURIComponent(String(technicalName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineAccount', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineAccountsV2026Api - functional programming interface - * @export - */ -export const MachineAccountsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineAccountsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {string} sourceId The ID of the source. - * @param {CreateMachineAccountSubtypeRequestV2026} createMachineAccountSubtypeRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createMachineAccountSubtype(sourceId: string, createMachineAccountSubtypeRequestV2026: CreateMachineAccountSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineAccountSubtype(sourceId, createMachineAccountSubtypeRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.createMachineAccountSubtype']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async deleteMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineAccountSubtypeByTechnicalName(sourceId, technicalName, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.deleteMachineAccountSubtypeByTechnicalName']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {string} id Machine Account ID. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccount(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccount(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.getMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {string} subtypeId The ID of the machine account subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getMachineAccountSubtypeById(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeById(subtypeId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.getMachineAccountSubtypeById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountSubtypeByTechnicalName(sourceId, technicalName, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.getMachineAccountSubtypeByTechnicalName']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {string} sourceId The ID of the source. - * @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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @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: **displayName, technicalName** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async listMachineAccountSubtypes(sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccountSubtypes(sourceId, filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.listMachineAccountSubtypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineAccounts(limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.listMachineAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {string} sourceId The ID of the source. - * @param {string} technicalName The technical name of the subtype. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async patchMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchMachineAccountSubtypeByTechnicalName(sourceId, technicalName, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.patchMachineAccountSubtypeByTechnicalName']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {string} id Machine Account ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineAccount(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccount(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineAccountsV2026Api.updateMachineAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineAccountsV2026Api - factory interface - * @export - */ -export const MachineAccountsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineAccountsV2026ApiFp(configuration) - return { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createMachineAccountSubtype(requestParameters: MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineAccountSubtype(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - deleteMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2026ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccount(requestParameters: MachineAccountsV2026ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccount(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeById(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {MachineAccountsV2026ApiListMachineAccountSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - listMachineAccountSubtypes(requestParameters: MachineAccountsV2026ApiListMachineAccountSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccountSubtypes(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2026ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineAccounts(requestParameters: MachineAccountsV2026ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - patchMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2026ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccount(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineAccount(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineAccountSubtype operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest - */ -export interface MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2026ApiCreateMachineAccountSubtype - */ - readonly sourceId: string - - /** - * - * @type {CreateMachineAccountSubtypeRequestV2026} - * @memberof MachineAccountsV2026ApiCreateMachineAccountSubtype - */ - readonly createMachineAccountSubtypeRequestV2026: CreateMachineAccountSubtypeRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiCreateMachineAccountSubtype - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineAccountSubtypeByTechnicalName operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest - */ -export interface MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalName - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalName - */ - readonly technicalName: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalName - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccount operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiGetMachineAccountRequest - */ -export interface MachineAccountsV2026ApiGetMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccount - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccount - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccountSubtypeById operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest - */ -export interface MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest { - /** - * The ID of the machine account subtype. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeById - */ - readonly subtypeId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeById - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineAccountSubtypeByTechnicalName operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest - */ -export interface MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly technicalName: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalName - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineAccountSubtypes operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiListMachineAccountSubtypesRequest - */ -export interface MachineAccountsV2026ApiListMachineAccountSubtypesRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly sourceId: 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: **displayName**: *eq, sw* **technicalName**: *eq, sw* - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccountSubtypes - */ - 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: **displayName, technicalName** - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly count?: boolean - - /** - * 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 MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountsV2026ApiListMachineAccountSubtypes - */ - readonly offset?: number -} - -/** - * Request parameters for listMachineAccounts operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiListMachineAccountsRequest - */ -export interface MachineAccountsV2026ApiListMachineAccountsRequest { - /** - * 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 MachineAccountsV2026ApiListMachineAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineAccountsV2026ApiListMachineAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof MachineAccountsV2026ApiListMachineAccounts - */ - 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, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccounts - */ - 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, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccounts - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiListMachineAccounts - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchMachineAccountSubtypeByTechnicalName operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest - */ -export interface MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest { - /** - * The ID of the source. - * @type {string} - * @memberof MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalName - */ - readonly sourceId: string - - /** - * The technical name of the subtype. - * @type {string} - * @memberof MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalName - */ - readonly technicalName: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalName - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalName - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineAccount operation in MachineAccountsV2026Api. - * @export - * @interface MachineAccountsV2026ApiUpdateMachineAccountRequest - */ -export interface MachineAccountsV2026ApiUpdateMachineAccountRequest { - /** - * Machine Account ID. - * @type {string} - * @memberof MachineAccountsV2026ApiUpdateMachineAccount - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - * @type {Array} - * @memberof MachineAccountsV2026ApiUpdateMachineAccount - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineAccountsV2026ApiUpdateMachineAccount - */ - readonly xSailPointExperimental?: string -} - -/** - * MachineAccountsV2026Api - object-oriented interface - * @export - * @class MachineAccountsV2026Api - * @extends {BaseAPI} - */ -export class MachineAccountsV2026Api extends BaseAPI { - /** - * Create a new machine account subtype for a source. - * @summary Create subtype - * @param {MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public createMachineAccountSubtype(requestParameters: MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).createMachineAccountSubtype(requestParameters.sourceId, requestParameters.createMachineAccountSubtypeRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a machine account subtype by source ID and technical name. - * @summary Delete subtype - * @param {MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public deleteMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).deleteMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single machine account by its ID. - * @summary Get machine account details - * @param {MachineAccountsV2026ApiGetMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public getMachineAccount(requestParameters: MachineAccountsV2026ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).getMachineAccount(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a machine account subtype by its unique ID. - * @summary Retrieve subtype by subtype id - * @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public getMachineAccountSubtypeById(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).getMachineAccountSubtypeById(requestParameters.subtypeId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a machine account subtype by source ID and technical name. - * @summary Retrieve subtype by source and technicalName - * @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public getMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).getMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get all machine account subtypes for a given source. - * @summary Retrieve all subtypes by source - * @param {MachineAccountsV2026ApiListMachineAccountSubtypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public listMachineAccountSubtypes(requestParameters: MachineAccountsV2026ApiListMachineAccountSubtypesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).listMachineAccountSubtypes(requestParameters.sourceId, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns a list of machine accounts. - * @summary List machine accounts - * @param {MachineAccountsV2026ApiListMachineAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public listMachineAccounts(requestParameters: MachineAccountsV2026ApiListMachineAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).listMachineAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`. - * @summary Patch subtype - * @param {MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public patchMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).patchMachineAccountSubtypeByTechnicalName(requestParameters.sourceId, requestParameters.technicalName, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine accounts details. - * @summary Update machine account details - * @param {MachineAccountsV2026ApiUpdateMachineAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineAccountsV2026Api - */ - public updateMachineAccount(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineAccountsV2026ApiFp(this.configuration).updateMachineAccount(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineClassificationConfigV2026Api - axios parameter creator - * @export - */ -export const MachineClassificationConfigV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineClassificationConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2026} machineClassificationConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig: async (id: string, machineClassificationConfigV2026: MachineClassificationConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'id', id) - // verify required parameter 'machineClassificationConfigV2026' is not null or undefined - assertParamExists('setMachineClassificationConfig', 'machineClassificationConfigV2026', machineClassificationConfigV2026) - const localVarPath = `/sources/{sourceId}/machine-classification-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineClassificationConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineClassificationConfigV2026Api - functional programming interface - * @export - */ -export const MachineClassificationConfigV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineClassificationConfigV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2026Api.deleteMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {string} id Source ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineClassificationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineClassificationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2026Api.getMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {string} id Source ID. - * @param {MachineClassificationConfigV2026} machineClassificationConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMachineClassificationConfig(id: string, machineClassificationConfigV2026: MachineClassificationConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMachineClassificationConfig(id, machineClassificationConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineClassificationConfigV2026Api.setMachineClassificationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineClassificationConfigV2026Api - factory interface - * @export - */ -export const MachineClassificationConfigV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineClassificationConfigV2026ApiFp(configuration) - return { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteMachineClassificationConfig operation in MachineClassificationConfigV2026Api. - * @export - * @interface MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2026ApiDeleteMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for getMachineClassificationConfig operation in MachineClassificationConfigV2026Api. - * @export - * @interface MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest { - /** - * Source ID - * @type {string} - * @memberof MachineClassificationConfigV2026ApiGetMachineClassificationConfig - */ - readonly id: string -} - -/** - * Request parameters for setMachineClassificationConfig operation in MachineClassificationConfigV2026Api. - * @export - * @interface MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest - */ -export interface MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineClassificationConfigV2026ApiSetMachineClassificationConfig - */ - readonly id: string - - /** - * - * @type {MachineClassificationConfigV2026} - * @memberof MachineClassificationConfigV2026ApiSetMachineClassificationConfig - */ - readonly machineClassificationConfigV2026: MachineClassificationConfigV2026 -} - -/** - * MachineClassificationConfigV2026Api - object-oriented interface - * @export - * @class MachineClassificationConfigV2026Api - * @extends {BaseAPI} - */ -export class MachineClassificationConfigV2026Api extends BaseAPI { - /** - * Use this API to remove Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete source\'s classification config - * @param {MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2026Api - */ - public deleteMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiDeleteMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2026ApiFp(this.configuration).deleteMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Machine Classification Config for a Source using Source ID. - * @summary Machine classification config for source - * @param {MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2026Api - */ - public getMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiGetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2026ApiFp(this.configuration).getMachineClassificationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Update source\'s classification config - * @param {MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineClassificationConfigV2026Api - */ - public setMachineClassificationConfig(requestParameters: MachineClassificationConfigV2026ApiSetMachineClassificationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineClassificationConfigV2026ApiFp(this.configuration).setMachineClassificationConfig(requestParameters.id, requestParameters.machineClassificationConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MachineIdentitiesV2026Api - axios parameter creator - * @export - */ -export const MachineIdentitiesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityRequestV2026} machineIdentityRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity: async (machineIdentityRequestV2026: MachineIdentityRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'machineIdentityRequestV2026' is not null or undefined - assertParamExists('createMachineIdentity', 'machineIdentityRequestV2026', machineIdentityRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getMachineIdentity', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @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: **machineIdentityName, entitlement.name, source.name** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentityUserEntitlements: async (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identity-user-entitlements`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {string} sourceId Source ID. - * @param {MachineIdentityAggregationRequestV2026} machineIdentityAggregationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startMachineIdentityAggregation: async (sourceId: string, machineIdentityAggregationRequestV2026: MachineIdentityAggregationRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('startMachineIdentityAggregation', 'sourceId', sourceId) - // verify required parameter 'machineIdentityAggregationRequestV2026' is not null or undefined - assertParamExists('startMachineIdentityAggregation', 'machineIdentityAggregationRequestV2026', machineIdentityAggregationRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{sourceId}/aggregate-agents` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(machineIdentityAggregationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity: async (id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateMachineIdentity', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateMachineIdentity', 'requestBody', requestBody) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/machine-identities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MachineIdentitiesV2026Api - functional programming interface - * @export - */ -export const MachineIdentitiesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MachineIdentitiesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentityRequestV2026} machineIdentityRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMachineIdentity(machineIdentityRequestV2026: MachineIdentityRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMachineIdentity(machineIdentityRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.createMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.deleteMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {string} id Machine Identity ID - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineIdentity(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineIdentity(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.getMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineIdentities(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentities(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.listMachineIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @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: **machineIdentityName, entitlement.name, source.name** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @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 {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listMachineIdentityUserEntitlements(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listMachineIdentityUserEntitlements(filters, sorters, xSailPointExperimental, count, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.listMachineIdentityUserEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {string} sourceId Source ID. - * @param {MachineIdentityAggregationRequestV2026} machineIdentityAggregationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startMachineIdentityAggregation(sourceId: string, machineIdentityAggregationRequestV2026: MachineIdentityAggregationRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startMachineIdentityAggregation(sourceId, machineIdentityAggregationRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.startMachineIdentityAggregation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {string} id Machine Identity ID. - * @param {Array} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineIdentity(id: string, requestBody: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineIdentity(id, requestBody, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MachineIdentitiesV2026Api.updateMachineIdentity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MachineIdentitiesV2026Api - factory interface - * @export - */ -export const MachineIdentitiesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MachineIdentitiesV2026ApiFp(configuration) - return { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2026ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMachineIdentity(requestParameters: MachineIdentitiesV2026ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMachineIdentity(requestParameters.machineIdentityRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2026ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMachineIdentity(requestParameters: MachineIdentitiesV2026ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2026ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineIdentity(requestParameters: MachineIdentitiesV2026ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2026ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentities(requestParameters: MachineIdentitiesV2026ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @param {MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listMachineIdentityUserEntitlements(requestParameters: MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listMachineIdentityUserEntitlements(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startMachineIdentityAggregation(requestParameters: MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startMachineIdentityAggregation(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2026ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineIdentity(requestParameters: MachineIdentitiesV2026ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMachineIdentity operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiCreateMachineIdentityRequest - */ -export interface MachineIdentitiesV2026ApiCreateMachineIdentityRequest { - /** - * - * @type {MachineIdentityRequestV2026} - * @memberof MachineIdentitiesV2026ApiCreateMachineIdentity - */ - readonly machineIdentityRequestV2026: MachineIdentityRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiCreateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteMachineIdentity operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiDeleteMachineIdentityRequest - */ -export interface MachineIdentitiesV2026ApiDeleteMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2026ApiDeleteMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiDeleteMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getMachineIdentity operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiGetMachineIdentityRequest - */ -export interface MachineIdentitiesV2026ApiGetMachineIdentityRequest { - /** - * Machine Identity ID - * @type {string} - * @memberof MachineIdentitiesV2026ApiGetMachineIdentity - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiGetMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listMachineIdentities operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiListMachineIdentitiesRequest - */ -export interface MachineIdentitiesV2026ApiListMachineIdentitiesRequest { - /** - * 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, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentities - */ - 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: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentities - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentities - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineIdentitiesV2026ApiListMachineIdentities - */ - readonly count?: boolean - - /** - * 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 MachineIdentitiesV2026ApiListMachineIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineIdentitiesV2026ApiListMachineIdentities - */ - readonly offset?: number -} - -/** - * Request parameters for listMachineIdentityUserEntitlements operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest - */ -export interface MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest { - /** - * 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: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - 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: **machineIdentityName, entitlement.name, source.name** - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - readonly xSailPointExperimental?: string - - /** - * 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 MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - readonly count?: boolean - - /** - * 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 MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof MachineIdentitiesV2026ApiListMachineIdentityUserEntitlements - */ - readonly offset?: number -} - -/** - * Request parameters for startMachineIdentityAggregation operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest - */ -export interface MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest { - /** - * Source ID. - * @type {string} - * @memberof MachineIdentitiesV2026ApiStartMachineIdentityAggregation - */ - readonly sourceId: string - - /** - * - * @type {MachineIdentityAggregationRequestV2026} - * @memberof MachineIdentitiesV2026ApiStartMachineIdentityAggregation - */ - readonly machineIdentityAggregationRequestV2026: MachineIdentityAggregationRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiStartMachineIdentityAggregation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateMachineIdentity operation in MachineIdentitiesV2026Api. - * @export - * @interface MachineIdentitiesV2026ApiUpdateMachineIdentityRequest - */ -export interface MachineIdentitiesV2026ApiUpdateMachineIdentityRequest { - /** - * Machine Identity ID. - * @type {string} - * @memberof MachineIdentitiesV2026ApiUpdateMachineIdentity - */ - readonly id: string - - /** - * A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof MachineIdentitiesV2026ApiUpdateMachineIdentity - */ - readonly requestBody: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof MachineIdentitiesV2026ApiUpdateMachineIdentity - */ - readonly xSailPointExperimental?: string -} - -/** - * MachineIdentitiesV2026Api - object-oriented interface - * @export - * @class MachineIdentitiesV2026Api - * @extends {BaseAPI} - */ -export class MachineIdentitiesV2026Api extends BaseAPI { - /** - * Use this API to create a machine identity. The maximum supported length for the description field is 2000 characters. - * @summary Create machine identity - * @param {MachineIdentitiesV2026ApiCreateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public createMachineIdentity(requestParameters: MachineIdentitiesV2026ApiCreateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).createMachineIdentity(requestParameters.machineIdentityRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API returns successful response if the requested machine identity was deleted. - * @summary Delete machine identity - * @param {MachineIdentitiesV2026ApiDeleteMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public deleteMachineIdentity(requestParameters: MachineIdentitiesV2026ApiDeleteMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).deleteMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single machine identity using the Machine Identity ID. - * @summary Get machine identity details - * @param {MachineIdentitiesV2026ApiGetMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public getMachineIdentity(requestParameters: MachineIdentitiesV2026ApiGetMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).getMachineIdentity(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of machine identities. - * @summary List machine identities - * @param {MachineIdentitiesV2026ApiListMachineIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public listMachineIdentities(requestParameters: MachineIdentitiesV2026ApiListMachineIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).listMachineIdentities(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of user entitlements associated with machine identities. - * @summary List machine identity\'s user entitlements - * @param {MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public listMachineIdentityUserEntitlements(requestParameters: MachineIdentitiesV2026ApiListMachineIdentityUserEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).listMachineIdentityUserEntitlements(requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, requestParameters.count, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts a machine identity (AI Agents) aggregation on the specified source. - * @summary Start machine identity aggregation - * @param {MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public startMachineIdentityAggregation(requestParameters: MachineIdentitiesV2026ApiStartMachineIdentityAggregationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).startMachineIdentityAggregation(requestParameters.sourceId, requestParameters.machineIdentityAggregationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update machine identity details. - * @summary Update machine identity details - * @param {MachineIdentitiesV2026ApiUpdateMachineIdentityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MachineIdentitiesV2026Api - */ - public updateMachineIdentity(requestParameters: MachineIdentitiesV2026ApiUpdateMachineIdentityRequest, axiosOptions?: RawAxiosRequestConfig) { - return MachineIdentitiesV2026ApiFp(this.configuration).updateMachineIdentity(requestParameters.id, requestParameters.requestBody, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClientsV2026Api - axios parameter creator - * @export - */ -export const ManagedClientsV2026ApiAxiosParamCreator = 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 {ManagedClientRequestV2026} managedClientRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient: async (managedClientRequestV2026: ManagedClientRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClientRequestV2026' is not null or undefined - assertParamExists('createManagedClient', 'managedClientRequestV2026', managedClientRequestV2026) - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClientRequestV2026, 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} - */ - deleteManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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} - */ - getManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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} - */ - getManagedClientHealthIndicators: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientHealthIndicators', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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 {ManagedClientTypeV2026} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus: async (id: string, type: ManagedClientTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientStatus', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getManagedClientStatus', 'type', type) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * 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} - */ - getManagedClients: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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} jsonPatchOperationV2026 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateManagedClient', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClientsV2026Api - functional programming interface - * @export - */ -export const ManagedClientsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClientsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientRequestV2026} managedClientRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClient(managedClientRequestV2026: ManagedClientRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClient(managedClientRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.createManagedClient']?.[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 deleteManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.deleteManagedClient']?.[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 getManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.getManagedClient']?.[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 getManagedClientHealthIndicators(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientHealthIndicators(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.getManagedClientHealthIndicators']?.[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 {ManagedClientTypeV2026} type Managed client type to get status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClientStatus(id: string, type: ManagedClientTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatus(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.getManagedClientStatus']?.[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 getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClients(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.getManagedClients']?.[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} jsonPatchOperationV2026 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClient(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClient(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsV2026Api.updateManagedClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClientsV2026Api - factory interface - * @export - */ -export const ManagedClientsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClientsV2026ApiFp(configuration) - return { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2026ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient(requestParameters: ManagedClientsV2026ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClient(requestParameters.managedClientRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2026ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClient(requestParameters: ManagedClientsV2026ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2026ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClient(requestParameters: ManagedClientsV2026ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClient(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 {ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientHealthIndicators(requestParameters: ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientHealthIndicators(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed client\'s status, using its ID. - * @summary Get managed client status - * @param {ManagedClientsV2026ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus(requestParameters: ManagedClientsV2026ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2026ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClients(requestParameters: ManagedClientsV2026ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClients(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed client. - * @summary Update managed client - * @param {ManagedClientsV2026ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient(requestParameters: ManagedClientsV2026ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClient operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiCreateManagedClientRequest - */ -export interface ManagedClientsV2026ApiCreateManagedClientRequest { - /** - * - * @type {ManagedClientRequestV2026} - * @memberof ManagedClientsV2026ApiCreateManagedClient - */ - readonly managedClientRequestV2026: ManagedClientRequestV2026 -} - -/** - * Request parameters for deleteManagedClient operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiDeleteManagedClientRequest - */ -export interface ManagedClientsV2026ApiDeleteManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2026ApiDeleteManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClient operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiGetManagedClientRequest - */ -export interface ManagedClientsV2026ApiGetManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2026ApiGetManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientHealthIndicators operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest - */ -export interface ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest { - /** - * Managed client ID to get health indicators for. - * @type {string} - * @memberof ManagedClientsV2026ApiGetManagedClientHealthIndicators - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientStatus operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiGetManagedClientStatusRequest - */ -export interface ManagedClientsV2026ApiGetManagedClientStatusRequest { - /** - * Managed client ID to get status for. - * @type {string} - * @memberof ManagedClientsV2026ApiGetManagedClientStatus - */ - readonly id: string - - /** - * Managed client type to get status for. - * @type {ManagedClientTypeV2026} - * @memberof ManagedClientsV2026ApiGetManagedClientStatus - */ - readonly type: ManagedClientTypeV2026 -} - -/** - * Request parameters for getManagedClients operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiGetManagedClientsRequest - */ -export interface ManagedClientsV2026ApiGetManagedClientsRequest { - /** - * 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 ManagedClientsV2026ApiGetManagedClients - */ - 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 ManagedClientsV2026ApiGetManagedClients - */ - 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 ManagedClientsV2026ApiGetManagedClients - */ - 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 ManagedClientsV2026ApiGetManagedClients - */ - readonly filters?: string -} - -/** - * Request parameters for updateManagedClient operation in ManagedClientsV2026Api. - * @export - * @interface ManagedClientsV2026ApiUpdateManagedClientRequest - */ -export interface ManagedClientsV2026ApiUpdateManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsV2026ApiUpdateManagedClient - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClientsV2026ApiUpdateManagedClient - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * ManagedClientsV2026Api - object-oriented interface - * @export - * @class ManagedClientsV2026Api - * @extends {BaseAPI} - */ -export class ManagedClientsV2026Api extends BaseAPI { - /** - * Create a new managed client. The API returns a result that includes the managed client ID. - * @summary Create managed client - * @param {ManagedClientsV2026ApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public createManagedClient(requestParameters: ManagedClientsV2026ApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).createManagedClient(requestParameters.managedClientRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsV2026ApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public deleteManagedClient(requestParameters: ManagedClientsV2026ApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsV2026ApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public getManagedClient(requestParameters: ManagedClientsV2026ApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).getManagedClient(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 {ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public getManagedClientHealthIndicators(requestParameters: ManagedClientsV2026ApiGetManagedClientHealthIndicatorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).getManagedClientHealthIndicators(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 {ManagedClientsV2026ApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public getManagedClientStatus(requestParameters: ManagedClientsV2026ApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsV2026ApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public getManagedClients(requestParameters: ManagedClientsV2026ApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).getManagedClients(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 {ManagedClientsV2026ApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsV2026Api - */ - public updateManagedClient(requestParameters: ManagedClientsV2026ApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsV2026ApiFp(this.configuration).updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClusterTypesV2026Api - axios parameter creator - * @export - */ -export const ManagedClusterTypesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2026} managedClusterTypeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType: async (managedClusterTypeV2026: ManagedClusterTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterTypeV2026' is not null or undefined - assertParamExists('createManagedClusterType', 'managedClusterTypeV2026', managedClusterTypeV2026) - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterTypeV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Cluster Type. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClusterType', 'id', id) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes: async (type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-cluster-types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (pod !== undefined) { - localVarQueryParameter['pod'] = pod; - } - - if (org !== undefined) { - localVarQueryParameter['org'] = org; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - 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 Cluster Type. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2026} jsonPatchV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType: async (id: string, jsonPatchV2026: JsonPatchV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClusterType', 'id', id) - // verify required parameter 'jsonPatchV2026' is not null or undefined - assertParamExists('updateManagedClusterType', 'jsonPatchV2026', jsonPatchV2026) - const localVarPath = `/managed-cluster-types/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClusterTypesV2026Api - functional programming interface - * @export - */ -export const ManagedClusterTypesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClusterTypesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypeV2026} managedClusterTypeV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedClusterType(managedClusterTypeV2026: ManagedClusterTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClusterType(managedClusterTypeV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2026Api.createManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2026Api.deleteManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterType(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterType(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2026Api.getManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {string} [type] Type descriptor - * @param {string} [pod] Pinned pod (or default) - * @param {string} [org] Pinned org (or default) - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusterTypes(type?: string, pod?: string, org?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusterTypes(type, pod, org, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2026Api.getManagedClusterTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {string} id The Managed Cluster Type ID - * @param {JsonPatchV2026} jsonPatchV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedClusterType(id: string, jsonPatchV2026: JsonPatchV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClusterType(id, jsonPatchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClusterTypesV2026Api.updateManagedClusterType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClusterTypesV2026Api - factory interface - * @export - */ -export const ManagedClusterTypesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClusterTypesV2026ApiFp(configuration) - return { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClusterType(requestParameters.managedClusterTypeV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusterTypes(requestParameters: ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClusterType operation in ManagedClusterTypesV2026Api. - * @export - * @interface ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest { - /** - * - * @type {ManagedClusterTypeV2026} - * @memberof ManagedClusterTypesV2026ApiCreateManagedClusterType - */ - readonly managedClusterTypeV2026: ManagedClusterTypeV2026 -} - -/** - * Request parameters for deleteManagedClusterType operation in ManagedClusterTypesV2026Api. - * @export - * @interface ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2026ApiDeleteManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterType operation in ManagedClusterTypesV2026Api. - * @export - * @interface ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2026ApiGetManagedClusterType - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusterTypes operation in ManagedClusterTypesV2026Api. - * @export - * @interface ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest - */ -export interface ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest { - /** - * Type descriptor - * @type {string} - * @memberof ManagedClusterTypesV2026ApiGetManagedClusterTypes - */ - readonly type?: string - - /** - * Pinned pod (or default) - * @type {string} - * @memberof ManagedClusterTypesV2026ApiGetManagedClusterTypes - */ - readonly pod?: string - - /** - * Pinned org (or default) - * @type {string} - * @memberof ManagedClusterTypesV2026ApiGetManagedClusterTypes - */ - readonly org?: string - - /** - * 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 ManagedClusterTypesV2026ApiGetManagedClusterTypes - */ - 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 ManagedClusterTypesV2026ApiGetManagedClusterTypes - */ - readonly limit?: number -} - -/** - * Request parameters for updateManagedClusterType operation in ManagedClusterTypesV2026Api. - * @export - * @interface ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest - */ -export interface ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest { - /** - * The Managed Cluster Type ID - * @type {string} - * @memberof ManagedClusterTypesV2026ApiUpdateManagedClusterType - */ - readonly id: string - - /** - * The JSONPatch payload used to update the schema. - * @type {JsonPatchV2026} - * @memberof ManagedClusterTypesV2026ApiUpdateManagedClusterType - */ - readonly jsonPatchV2026: JsonPatchV2026 -} - -/** - * ManagedClusterTypesV2026Api - object-oriented interface - * @export - * @class ManagedClusterTypesV2026Api - * @extends {BaseAPI} - */ -export class ManagedClusterTypesV2026Api extends BaseAPI { - /** - * Create a new Managed Cluster Type. The API returns a result that includes the Managed Cluster Type ID - * @summary Create new managed cluster type - * @param {ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2026Api - */ - public createManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiCreateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2026ApiFp(this.configuration).createManagedClusterType(requestParameters.managedClusterTypeV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Managed Cluster Type. - * @summary Delete a managed cluster type - * @param {ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2026Api - */ - public deleteManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiDeleteManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2026ApiFp(this.configuration).deleteManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a Managed Cluster Type. - * @summary Get a managed cluster type - * @param {ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2026Api - */ - public getManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiGetManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2026ApiFp(this.configuration).getManagedClusterType(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Managed Cluster Types. - * @summary List managed cluster types - * @param {ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2026Api - */ - public getManagedClusterTypes(requestParameters: ManagedClusterTypesV2026ApiGetManagedClusterTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2026ApiFp(this.configuration).getManagedClusterTypes(requestParameters.type, requestParameters.pod, requestParameters.org, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Managed Cluster Type. - * @summary Update a managed cluster type - * @param {ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClusterTypesV2026Api - */ - public updateManagedClusterType(requestParameters: ManagedClusterTypesV2026ApiUpdateManagedClusterTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClusterTypesV2026ApiFp(this.configuration).updateManagedClusterType(requestParameters.id, requestParameters.jsonPatchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClustersV2026Api - axios parameter creator - * @export - */ -export const ManagedClustersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2026} managedClusterRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster: async (managedClusterRequestV2026: ManagedClusterRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterRequestV2026' is not null or undefined - assertParamExists('createManagedCluster', 'managedClusterRequestV2026', managedClusterRequestV2026) - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster: async (id: string, removeClients?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (removeClients !== undefined) { - localVarQueryParameter['removeClients'] = removeClients; - } - - - - 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 cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClientLogConfiguration', 'id', id) - const localVarPath = `/managed-clusters/{id}/log-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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 a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2026} putClientLogConfigurationRequestV2026 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration: async (id: string, putClientLogConfigurationRequestV2026: PutClientLogConfigurationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putClientLogConfiguration', 'id', id) - // verify required parameter 'putClientLogConfigurationRequestV2026' is not null or undefined - assertParamExists('putClientLogConfiguration', 'putClientLogConfigurationRequestV2026', putClientLogConfigurationRequestV2026) - const localVarPath = `/managed-clusters/{id}/log-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(putClientLogConfigurationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('update', 'id', id) - const localVarPath = `/managed-clusters/{id}/manualUpgrade` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2026 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedCluster', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateManagedCluster', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ManagedClustersV2026Api - functional programming interface - * @export - */ -export const ManagedClustersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClustersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequestV2026} managedClusterRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedCluster(managedClusterRequestV2026: ManagedClusterRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedCluster(managedClusterRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.createManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedCluster(id: string, removeClients?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedCluster(id, removeClients, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.deleteManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClientLogConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.getClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedCluster(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedCluster(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.getManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusters(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusters(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.getManagedClusters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequestV2026} putClientLogConfigurationRequestV2026 Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putClientLogConfiguration(id: string, putClientLogConfigurationRequestV2026: PutClientLogConfigurationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfiguration(id, putClientLogConfigurationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.putClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {string} id ID of managed cluster to trigger manual upgrade. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async update(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.update(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.update']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperationV2026 JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedCluster(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedCluster(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersV2026Api.updateManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClustersV2026Api - factory interface - * @export - */ -export const ManagedClustersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClustersV2026ApiFp(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2026ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster(requestParameters: ManagedClustersV2026ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedCluster(requestParameters.managedClusterRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2026ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster(requestParameters: ManagedClustersV2026ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2026ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration(requestParameters: ManagedClustersV2026ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2026ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster(requestParameters: ManagedClustersV2026ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2026ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters(requestParameters: ManagedClustersV2026ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2026ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration(requestParameters: ManagedClustersV2026ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2026ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - update(requestParameters: ManagedClustersV2026ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.update(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2026ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster(requestParameters: ManagedClustersV2026ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedCluster operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiCreateManagedClusterRequest - */ -export interface ManagedClustersV2026ApiCreateManagedClusterRequest { - /** - * - * @type {ManagedClusterRequestV2026} - * @memberof ManagedClustersV2026ApiCreateManagedCluster - */ - readonly managedClusterRequestV2026: ManagedClusterRequestV2026 -} - -/** - * Request parameters for deleteManagedCluster operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiDeleteManagedClusterRequest - */ -export interface ManagedClustersV2026ApiDeleteManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2026ApiDeleteManagedCluster - */ - readonly id: string - - /** - * Flag to determine the need to delete a cluster with clients. - * @type {boolean} - * @memberof ManagedClustersV2026ApiDeleteManagedCluster - */ - readonly removeClients?: boolean -} - -/** - * Request parameters for getClientLogConfiguration operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiGetClientLogConfigurationRequest - */ -export interface ManagedClustersV2026ApiGetClientLogConfigurationRequest { - /** - * ID of managed cluster to get log configuration for. - * @type {string} - * @memberof ManagedClustersV2026ApiGetClientLogConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getManagedCluster operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiGetManagedClusterRequest - */ -export interface ManagedClustersV2026ApiGetManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2026ApiGetManagedCluster - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusters operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiGetManagedClustersRequest - */ -export interface ManagedClustersV2026ApiGetManagedClustersRequest { - /** - * 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 ManagedClustersV2026ApiGetManagedClusters - */ - 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 ManagedClustersV2026ApiGetManagedClusters - */ - 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 ManagedClustersV2026ApiGetManagedClusters - */ - 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @type {string} - * @memberof ManagedClustersV2026ApiGetManagedClusters - */ - readonly filters?: string -} - -/** - * Request parameters for putClientLogConfiguration operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiPutClientLogConfigurationRequest - */ -export interface ManagedClustersV2026ApiPutClientLogConfigurationRequest { - /** - * ID of the managed cluster to update the log configuration for. - * @type {string} - * @memberof ManagedClustersV2026ApiPutClientLogConfiguration - */ - readonly id: string - - /** - * Client log configuration for the given managed cluster. - * @type {PutClientLogConfigurationRequestV2026} - * @memberof ManagedClustersV2026ApiPutClientLogConfiguration - */ - readonly putClientLogConfigurationRequestV2026: PutClientLogConfigurationRequestV2026 -} - -/** - * Request parameters for update operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiUpdateRequest - */ -export interface ManagedClustersV2026ApiUpdateRequest { - /** - * ID of managed cluster to trigger manual upgrade. - * @type {string} - * @memberof ManagedClustersV2026ApiUpdate - */ - readonly id: string -} - -/** - * Request parameters for updateManagedCluster operation in ManagedClustersV2026Api. - * @export - * @interface ManagedClustersV2026ApiUpdateManagedClusterRequest - */ -export interface ManagedClustersV2026ApiUpdateManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersV2026ApiUpdateManagedCluster - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClustersV2026ApiUpdateManagedCluster - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * ManagedClustersV2026Api - object-oriented interface - * @export - * @class ManagedClustersV2026Api - * @extends {BaseAPI} - */ -export class ManagedClustersV2026Api extends BaseAPI { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersV2026ApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public createManagedCluster(requestParameters: ManagedClustersV2026ApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).createManagedCluster(requestParameters.managedClusterRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersV2026ApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public deleteManagedCluster(requestParameters: ManagedClustersV2026ApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersV2026ApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public getClientLogConfiguration(requestParameters: ManagedClustersV2026ApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersV2026ApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public getManagedCluster(requestParameters: ManagedClustersV2026ApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersV2026ApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public getManagedClusters(requestParameters: ManagedClustersV2026ApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersV2026ApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public putClientLogConfiguration(requestParameters: ManagedClustersV2026ApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Trigger Manual Upgrade for Managed Cluster. AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. - * @summary Trigger manual upgrade for managed cluster - * @param {ManagedClustersV2026ApiUpdateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public update(requestParameters: ManagedClustersV2026ApiUpdateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).update(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersV2026ApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersV2026Api - */ - public updateManagedCluster(requestParameters: ManagedClustersV2026ApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersV2026ApiFp(this.configuration).updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MultiHostIntegrationV2026Api - axios parameter creator - * @export - */ -export const MultiHostIntegrationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2026} multiHostIntegrationsCreateV2026 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration: async (multiHostIntegrationsCreateV2026: MultiHostIntegrationsCreateV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostIntegrationsCreateV2026' is not null or undefined - assertParamExists('createMultiHostIntegration', 'multiHostIntegrationsCreateV2026', multiHostIntegrationsCreateV2026) - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2026 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost: async (multihostId: string, multiHostIntegrationsCreateSourcesV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multihostId', multihostId) - // verify required parameter 'multiHostIntegrationsCreateSourcesV2026' is not null or undefined - assertParamExists('createSourcesWithinMultiHost', 'multiHostIntegrationsCreateSourcesV2026', multiHostIntegrationsCreateSourcesV2026) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiHostIntegrationsCreateSourcesV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('deleteMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {Array} requestBody The delete bulk sources within multi-host integration request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHostSources: async (multiHostId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('deleteMultiHostSources', 'multiHostId', multiHostId) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteMultiHostSources', 'requestBody', requestBody) - const localVarPath = `/multihosts/{multiHostId}/sources/bulk-delete` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups: async (multihostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getAcctAggregationGroups', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/acctAggregationGroups` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups: async (multiHostId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getEntitlementAggregationGroups', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/entitlementAggregationGroups` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getMultiHostIntegrations', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors: async (multiHostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multiHostId' is not null or undefined - assertParamExists('getMultiHostSourceCreationErrors', 'multiHostId', multiHostId) - const localVarPath = `/multihosts/{multiHostId}/sources/errors` - .replace(`{${"multiHostId"}}`, encodeURIComponent(String(multiHostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/multihosts/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost: async (multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('getSourcesWithinMultiHost', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources: async (multihostId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testConnectionMultiHostSources', 'multihostId', multihostId) - const localVarPath = `/multihosts/{multihostId}/sources/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost: async (multihostId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'multihostId', multihostId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnectionMultihost', 'sourceId', sourceId) - const localVarPath = `/multihosts/{multihostId}/sources/{sourceId}/testConnection` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2026 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources: async (multihostId: string, updateMultiHostSourcesRequestInnerV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'multihostId' is not null or undefined - assertParamExists('updateMultiHostSources', 'multihostId', multihostId) - // verify required parameter 'updateMultiHostSourcesRequestInnerV2026' is not null or undefined - assertParamExists('updateMultiHostSources', 'updateMultiHostSourcesRequestInnerV2026', updateMultiHostSourcesRequestInnerV2026) - const localVarPath = `/multihosts/{multihostId}` - .replace(`{${"multihostId"}}`, encodeURIComponent(String(multihostId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(updateMultiHostSourcesRequestInnerV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MultiHostIntegrationV2026Api - functional programming interface - * @export - */ -export const MultiHostIntegrationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MultiHostIntegrationV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationsCreateV2026} multiHostIntegrationsCreateV2026 The specifics of the Multi-Host Integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createMultiHostIntegration(multiHostIntegrationsCreateV2026: MultiHostIntegrationsCreateV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMultiHostIntegration(multiHostIntegrationsCreateV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.createMultiHostIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {Array} multiHostIntegrationsCreateSourcesV2026 The specifics of the sources to create within Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourcesWithinMultiHost(multihostId: string, multiHostIntegrationsCreateSourcesV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourcesWithinMultiHost(multihostId, multiHostIntegrationsCreateSourcesV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.createSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {string} multihostId ID of Multi-Host Integration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHost(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHost(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.deleteMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {Array} requestBody The delete bulk sources within multi-host integration request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMultiHostSources(multiHostId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMultiHostSources(multiHostId, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.deleteMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAcctAggregationGroups(multihostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAcctAggregationGroups(multihostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getAcctAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {string} multiHostId ID of the Multi-Host Integration to update - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementAggregationGroups(multiHostId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementAggregationGroups(multiHostId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getEntitlementAggregationGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {string} multihostId ID of the Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrations(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrations(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getMultiHostIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @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 {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: **name** - * @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: **type**: *in* **forSubAdminId**: *in* - * @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} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostIntegrationsList(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, forSubadmin?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostIntegrationsList(offset, limit, sorters, filters, count, forSubadmin, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getMultiHostIntegrationsList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {string} multiHostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultiHostSourceCreationErrors(multiHostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultiHostSourceCreationErrors(multiHostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getMultiHostSourceCreationErrors']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMultihostIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getMultihostIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update - * @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 {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: **name** - * @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**: *in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourcesWithinMultiHost(multihostId: string, offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourcesWithinMultiHost(multihostId, offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.getSourcesWithinMultiHost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testConnectionMultiHostSources(multihostId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testConnectionMultiHostSources(multihostId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.testConnectionMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {string} multihostId ID of the Multi-Host Integration - * @param {string} sourceId ID of the source within the Multi-Host Integration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnectionMultihost(multihostId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnectionMultihost(multihostId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.testSourceConnectionMultihost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {string} multihostId ID of the Multi-Host Integration to update. - * @param {Array} updateMultiHostSourcesRequestInnerV2026 This endpoint allows you to update a Multi-Host Integration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMultiHostSources(multihostId: string, updateMultiHostSourcesRequestInnerV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMultiHostSources(multihostId, updateMultiHostSourcesRequestInnerV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MultiHostIntegrationV2026Api.updateMultiHostSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MultiHostIntegrationV2026Api - factory interface - * @export - */ -export const MultiHostIntegrationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MultiHostIntegrationV2026ApiFp(configuration) - return { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createMultiHostIntegration(requestParameters: MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2026ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHost(requestParameters: MultiHostIntegrationV2026ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMultiHostSources(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMultihostIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createMultiHostIntegration operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest - */ -export interface MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest { - /** - * The specifics of the Multi-Host Integration to create - * @type {MultiHostIntegrationsCreateV2026} - * @memberof MultiHostIntegrationV2026ApiCreateMultiHostIntegration - */ - readonly multiHostIntegrationsCreateV2026: MultiHostIntegrationsCreateV2026 -} - -/** - * Request parameters for createSourcesWithinMultiHost operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * The specifics of the sources to create within Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHost - */ - readonly multiHostIntegrationsCreateSourcesV2026: Array -} - -/** - * Request parameters for deleteMultiHost operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiDeleteMultiHostRequest - */ -export interface MultiHostIntegrationV2026ApiDeleteMultiHostRequest { - /** - * ID of Multi-Host Integration to delete. - * @type {string} - * @memberof MultiHostIntegrationV2026ApiDeleteMultiHost - */ - readonly multihostId: string -} - -/** - * Request parameters for deleteMultiHostSources operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2026ApiDeleteMultiHostSources - */ - readonly multiHostId: string - - /** - * The delete bulk sources within multi-host integration request body - * @type {Array} - * @memberof MultiHostIntegrationV2026ApiDeleteMultiHostSources - */ - readonly requestBody: Array -} - -/** - * Request parameters for getAcctAggregationGroups operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetAcctAggregationGroups - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2026ApiGetAcctAggregationGroups - */ - 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 MultiHostIntegrationV2026ApiGetAcctAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getEntitlementAggregationGroups operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest - */ -export interface MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetEntitlementAggregationGroups - */ - readonly multiHostId: string - - /** - * 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 MultiHostIntegrationV2026ApiGetEntitlementAggregationGroups - */ - 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 MultiHostIntegrationV2026ApiGetEntitlementAggregationGroups - */ - readonly limit?: number -} - -/** - * Request parameters for getMultiHostIntegrations operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest - */ -export interface MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest { - /** - * ID of the Multi-Host Integration. - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetMultiHostIntegrations - */ - readonly multihostId: string -} - -/** - * Request parameters for getMultiHostIntegrationsList operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest - */ -export interface MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest { - /** - * 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 MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - 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 MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - readonly sorters?: 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: **type**: *in* **forSubAdminId**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - readonly count?: boolean - - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetMultiHostIntegrationsList - */ - readonly forSubadmin?: string -} - -/** - * Request parameters for getMultiHostSourceCreationErrors operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest - */ -export interface MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrors - */ - readonly multiHostId: string -} - -/** - * Request parameters for getSourcesWithinMultiHost operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest - */ -export interface MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest { - /** - * ID of the Multi-Host Integration to update - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - readonly multihostId: string - - /** - * 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 MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - 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 MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - readonly sorters?: 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: **id**: *in* - * @type {string} - * @memberof MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - readonly filters?: string - - /** - * 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 MultiHostIntegrationV2026ApiGetSourcesWithinMultiHost - */ - readonly count?: boolean -} - -/** - * Request parameters for testConnectionMultiHostSources operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2026ApiTestConnectionMultiHostSources - */ - readonly multihostId: string -} - -/** - * Request parameters for testSourceConnectionMultihost operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest - */ -export interface MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest { - /** - * ID of the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2026ApiTestSourceConnectionMultihost - */ - readonly multihostId: string - - /** - * ID of the source within the Multi-Host Integration - * @type {string} - * @memberof MultiHostIntegrationV2026ApiTestSourceConnectionMultihost - */ - readonly sourceId: string -} - -/** - * Request parameters for updateMultiHostSources operation in MultiHostIntegrationV2026Api. - * @export - * @interface MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest - */ -export interface MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest { - /** - * ID of the Multi-Host Integration to update. - * @type {string} - * @memberof MultiHostIntegrationV2026ApiUpdateMultiHostSources - */ - readonly multihostId: string - - /** - * This endpoint allows you to update a Multi-Host Integration. - * @type {Array} - * @memberof MultiHostIntegrationV2026ApiUpdateMultiHostSources - */ - readonly updateMultiHostSourcesRequestInnerV2026: Array -} - -/** - * MultiHostIntegrationV2026Api - object-oriented interface - * @export - * @class MultiHostIntegrationV2026Api - * @extends {BaseAPI} - */ -export class MultiHostIntegrationV2026Api extends BaseAPI { - /** - * This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create multi-host integration - * @param {MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public createMultiHostIntegration(requestParameters: MultiHostIntegrationV2026ApiCreateMultiHostIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).createMultiHostIntegration(requestParameters.multiHostIntegrationsCreateV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Create sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public createSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2026ApiCreateSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).createSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.multiHostIntegrationsCreateSourcesV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - * @summary Delete multi-host integration - * @param {MultiHostIntegrationV2026ApiDeleteMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public deleteMultiHost(requestParameters: MultiHostIntegrationV2026ApiDeleteMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).deleteMultiHost(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete - * @summary Delete sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public deleteMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiDeleteMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).deleteMultiHostSources(requestParameters.multiHostId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List account-aggregation-groups by multi-host id - * @param {MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getAcctAggregationGroups(requestParameters: MultiHostIntegrationV2026ApiGetAcctAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getAcctAggregationGroups(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List entitlement-aggregation-groups by integration id - * @param {MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getEntitlementAggregationGroups(requestParameters: MultiHostIntegrationV2026ApiGetEntitlementAggregationGroupsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getEntitlementAggregationGroups(requestParameters.multiHostId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - * @summary Get multi-host integration by id - * @param {MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getMultiHostIntegrations(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostIntegrationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getMultiHostIntegrations(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List all existing multi-host integrations - * @param {MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getMultiHostIntegrationsList(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostIntegrationsListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getMultiHostIntegrationsList(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, requestParameters.forSubadmin, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host source creation errors - * @param {MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getMultiHostSourceCreationErrors(requestParameters: MultiHostIntegrationV2026ApiGetMultiHostSourceCreationErrorsRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getMultiHostSourceCreationErrors(requestParameters.multiHostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List multi-host integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getMultihostIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getMultihostIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary List sources within multi-host integration - * @param {MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public getSourcesWithinMultiHost(requestParameters: MultiHostIntegrationV2026ApiGetSourcesWithinMultiHostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).getSourcesWithinMultiHost(requestParameters.multihostId, requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the Multi-Host Integration\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration - * @param {MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public testConnectionMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiTestConnectionMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).testConnectionMultiHostSources(requestParameters.multihostId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'s configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Test configuration for multi-host integration\'s single source - * @param {MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public testSourceConnectionMultihost(requestParameters: MultiHostIntegrationV2026ApiTestSourceConnectionMultihostRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).testSourceConnectionMultihost(requestParameters.multihostId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - * @summary Update multi-host integration - * @param {MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MultiHostIntegrationV2026Api - */ - public updateMultiHostSources(requestParameters: MultiHostIntegrationV2026ApiUpdateMultiHostSourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return MultiHostIntegrationV2026ApiFp(this.configuration).updateMultiHostSources(requestParameters.multihostId, requestParameters.updateMultiHostSourcesRequestInnerV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NonEmployeeLifecycleManagementV2026Api - axios parameter creator - * @export - */ -export const NonEmployeeLifecycleManagementV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2026} nonEmployeeApprovalDecisionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest: async (id: string, nonEmployeeApprovalDecisionV2026: NonEmployeeApprovalDecisionV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeApprovalDecisionV2026' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'nonEmployeeApprovalDecisionV2026', nonEmployeeApprovalDecisionV2026) - const localVarPath = `/non-employee-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecisionV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord: async (nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2026' is not null or undefined - assertParamExists('createNonEmployeeRecord', 'nonEmployeeRequestBodyV2026', nonEmployeeRequestBodyV2026) - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest: async (nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBodyV2026' is not null or undefined - assertParamExists('createNonEmployeeRequest', 'nonEmployeeRequestBodyV2026', nonEmployeeRequestBodyV2026) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2026} nonEmployeeSourceRequestBodyV2026 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource: async (nonEmployeeSourceRequestBodyV2026: NonEmployeeSourceRequestBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeSourceRequestBodyV2026' is not null or undefined - assertParamExists('createNonEmployeeSource', 'nonEmployeeSourceRequestBodyV2026', nonEmployeeSourceRequestBodyV2026) - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2026} nonEmployeeSchemaAttributeBodyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes: async (sourceId: string, nonEmployeeSchemaAttributeBodyV2026: NonEmployeeSchemaAttributeBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - // verify required parameter 'nonEmployeeSchemaAttributeBodyV2026' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'nonEmployeeSchemaAttributeBodyV2026', nonEmployeeSchemaAttributeBodyV2026) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2026} deleteNonEmployeeRecordsInBulkRequestV2026 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk: async (deleteNonEmployeeRecordsInBulkRequestV2026: DeleteNonEmployeeRecordsInBulkRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteNonEmployeeRecordsInBulkRequestV2026' is not null or undefined - assertParamExists('deleteNonEmployeeRecordsInBulk', 'deleteNonEmployeeRecordsInBulkRequestV2026', deleteNonEmployeeRecordsInBulkRequestV2026) - const localVarPath = `/non-employee-records/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordsInBulkRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeRecords', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employees/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeSourceSchemaTemplate', 'id', id) - const localVarPath = `/non-employee-sources/{id}/schema-attributes-template/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeApproval', 'id', id) - const localVarPath = `/non-employee-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeDetail !== undefined) { - localVarQueryParameter['include-detail'] = includeDetail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeApprovalSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-approvals/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeBulkUploadStatus', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeRequestSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'id', id) - // verify required parameter 'data' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'data', data) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('listNonEmployeeRequests', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (nonEmployeeCount !== undefined) { - localVarQueryParameter['non-employee-count'] = nonEmployeeCount; - } - - 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, - }; - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2026 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2026 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2026 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource: async (sourceId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2026} nonEmployeeRejectApprovalDecisionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest: async (id: string, nonEmployeeRejectApprovalDecisionV2026: NonEmployeeRejectApprovalDecisionV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeRejectApprovalDecisionV2026' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'nonEmployeeRejectApprovalDecisionV2026', nonEmployeeRejectApprovalDecisionV2026) - const localVarPath = `/non-employee-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecisionV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord: async (id: string, nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'id', id) - // verify required parameter 'nonEmployeeRequestBodyV2026' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'nonEmployeeRequestBodyV2026', nonEmployeeRequestBodyV2026) - const localVarPath = `/non-employee-records/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2026Api - functional programming interface - * @export - */ -export const NonEmployeeLifecycleManagementV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NonEmployeeLifecycleManagementV2026ApiAxiosParamCreator(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecisionV2026} nonEmployeeApprovalDecisionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveNonEmployeeRequest(id: string, nonEmployeeApprovalDecisionV2026: NonEmployeeApprovalDecisionV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequest(id, nonEmployeeApprovalDecisionV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.approveNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRecord(nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecord(nonEmployeeRequestBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.createNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRequest(nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequest(nonEmployeeRequestBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.createNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBodyV2026} nonEmployeeSourceRequestBodyV2026 Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSource(nonEmployeeSourceRequestBodyV2026: NonEmployeeSourceRequestBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSource(nonEmployeeSourceRequestBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.createNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBodyV2026} nonEmployeeSchemaAttributeBodyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSourceSchemaAttributes(sourceId: string, nonEmployeeSchemaAttributeBodyV2026: NonEmployeeSchemaAttributeBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributes(sourceId, nonEmployeeSchemaAttributeBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.createNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequestV2026} deleteNonEmployeeRecordsInBulkRequestV2026 Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2026: DeleteNonEmployeeRecordsInBulkRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.deleteNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeRecords(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecords(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.exportNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeSourceSchemaTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.exportNonEmployeeSourceSchemaTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApproval(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApproval(id, includeDetail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApprovalSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeBulkUploadStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeBulkUploadStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequestSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeRequestSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.getNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importNonEmployeeRecordsInBulk(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulk(id, data, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.importNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeApprovals(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovals(requestedFor, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.listNonEmployeeApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRecords(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecords(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.listNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRequests(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequests(requestedFor, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.listNonEmployeeRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeSources(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSources(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.listNonEmployeeSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperationV2026 A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeRecord(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecord(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.patchNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperationV2026 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttribute(attributeId, sourceId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.patchNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperationV2026 A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSource(sourceId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSource(sourceId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.patchNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecisionV2026} nonEmployeeRejectApprovalDecisionV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectNonEmployeeRequest(id: string, nonEmployeeRejectApprovalDecisionV2026: NonEmployeeRejectApprovalDecisionV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequest(id, nonEmployeeRejectApprovalDecisionV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.rejectNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBodyV2026} nonEmployeeRequestBodyV2026 Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateNonEmployeeRecord(id: string, nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecord(id, nonEmployeeRequestBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementV2026Api.updateNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NonEmployeeLifecycleManagementV2026Api - factory interface - * @export - */ -export const NonEmployeeLifecycleManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NonEmployeeLifecycleManagementV2026ApiFp(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeApprovalDecisionV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequest - */ - readonly nonEmployeeApprovalDecisionV2026: NonEmployeeApprovalDecisionV2026 -} - -/** - * Request parameters for createNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest { - /** - * Non-Employee record creation request body. - * @type {NonEmployeeRequestBodyV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026 -} - -/** - * Request parameters for createNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest { - /** - * Non-Employee creation request body - * @type {NonEmployeeRequestBodyV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequest - */ - readonly nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026 -} - -/** - * Request parameters for createNonEmployeeSource operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest { - /** - * Non-Employee source creation request body. - * @type {NonEmployeeSourceRequestBodyV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSource - */ - readonly nonEmployeeSourceRequestBodyV2026: NonEmployeeSourceRequestBodyV2026 -} - -/** - * Request parameters for createNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * - * @type {NonEmployeeSchemaAttributeBodyV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly nonEmployeeSchemaAttributeBodyV2026: NonEmployeeSchemaAttributeBodyV2026 -} - -/** - * Request parameters for deleteNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest { - /** - * Non-Employee bulk delete request body. - * @type {DeleteNonEmployeeRecordsInBulkRequestV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulk - */ - readonly deleteNonEmployeeRecordsInBulkRequestV2026: DeleteNonEmployeeRecordsInBulkRequestV2026 -} - -/** - * Request parameters for deleteNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest { - /** - * Non-Employee request id in the UUID format - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSource operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for exportNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecords - */ - readonly id: string -} - -/** - * Request parameters for exportNonEmployeeSourceSchemaTemplate operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeApproval operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApproval - */ - readonly id: string - - /** - * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApproval - */ - readonly includeDetail?: boolean -} - -/** - * Request parameters for getNonEmployeeApprovalSummary operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest { - /** - * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeBulkUploadStatus operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest { - /** - * Source ID (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatus - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest { - /** - * Non-Employee request id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequestSummary operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest { - /** - * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSource operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for importNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulk - */ - readonly id: string - - /** - * - * @type {File} - * @memberof NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulk - */ - readonly data: File -} - -/** - * Request parameters for listNonEmployeeApprovals operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - readonly requestedFor?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - 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: **approvalStatus**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listNonEmployeeRecords operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest { - /** - * 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 NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecords - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecords - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecords - */ - readonly count?: boolean - - /** - * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecords - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecords - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeRequests operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly requestedFor: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly count?: boolean - - /** - * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequests - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeSources operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest { - /** - * 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 NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly count?: boolean - - /** - * Identity the request was made for. Use \'me\' to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly requestedFor?: string - - /** - * Flag that determines whether the API will return a non-employee count associated with the source. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly nonEmployeeCount?: boolean - - /** - * 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: **name, created, sourceId** - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSources - */ - readonly sorters?: string -} - -/** - * Request parameters for patchNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecord - */ - readonly id: string - - /** - * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecord - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttribute - */ - readonly sourceId: string - - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttribute - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchNonEmployeeSource operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSource - */ - readonly sourceId: string - - /** - * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSource - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for rejectNonEmployeeRequest operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeRejectApprovalDecisionV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequest - */ - readonly nonEmployeeRejectApprovalDecisionV2026: NonEmployeeRejectApprovalDecisionV2026 -} - -/** - * Request parameters for updateNonEmployeeRecord operation in NonEmployeeLifecycleManagementV2026Api. - * @export - * @interface NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecord - */ - readonly id: string - - /** - * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {NonEmployeeRequestBodyV2026} - * @memberof NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecord - */ - readonly nonEmployeeRequestBodyV2026: NonEmployeeRequestBodyV2026 -} - -/** - * NonEmployeeLifecycleManagementV2026Api - object-oriented interface - * @export - * @class NonEmployeeLifecycleManagementV2026Api - * @extends {BaseAPI} - */ -export class NonEmployeeLifecycleManagementV2026Api extends BaseAPI { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecisionV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).createNonEmployeeRecord(requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).createNonEmployeeRequest(requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementV2026ApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementV2026ApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementV2026ApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementV2026ApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementV2026ApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementV2026ApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecisionV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementV2026Api - */ - public updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementV2026ApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementV2026ApiFp(this.configuration).updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NotificationsV2026Api - axios parameter creator - * @export - */ -export const NotificationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2026} domainAddressV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim: async (domainAddressV2026: DomainAddressV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'domainAddressV2026' is not null or undefined - assertParamExists('createDomainDkim', 'domainAddressV2026', domainAddressV2026) - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(domainAddressV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2026} templateDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate: async (templateDtoV2026: TemplateDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateDtoV2026' is not null or undefined - assertParamExists('createNotificationTemplate', 'templateDtoV2026', templateDtoV2026) - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2026} emailStatusDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress: async (emailStatusDtoV2026: EmailStatusDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'emailStatusDtoV2026' is not null or undefined - assertParamExists('createVerifiedFromAddress', 'emailStatusDtoV2026', emailStatusDtoV2026) - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailStatusDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk: async (templateBulkDeleteDtoV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'templateBulkDeleteDtoV2026' is not null or undefined - assertParamExists('deleteNotificationTemplatesInBulk', 'templateBulkDeleteDtoV2026', templateBulkDeleteDtoV2026) - const localVarPath = `/notification-templates/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(templateBulkDeleteDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteVerifiedFromAddress', 'id', id) - const localVarPath = `/verified-from-addresses/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-domains`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes: async (identity: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identity' is not null or undefined - assertParamExists('getMailFromAttributes', 'identity', identity) - const localVarPath = `/mail-from-attributes/{identity}` - .replace(`{${"identity"}}`, encodeURIComponent(String(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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-preferences/{key}`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNotificationTemplate', 'id', id) - const localVarPath = `/notification-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). - * @summary Get notification template variables - * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. - * @param {GetNotificationTemplateVariablesMediumV2026} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. - * @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: **key, type, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplateVariables: async (key: string, medium: GetNotificationTemplateVariablesMediumV2026, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getNotificationTemplateVariables', 'key', key) - // verify required parameter 'medium' is not null or undefined - assertParamExists('getNotificationTemplateVariables', 'medium', medium) - const localVarPath = `/notification-template-variables/{key}/{medium}` - .replace(`{${"key"}}`, encodeURIComponent(String(key))) - .replace(`{${"medium"}}`, encodeURIComponent(String(medium))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/verified-from-addresses`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-template-defaults`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/notification-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2026} mailFromAttributesDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes: async (mailFromAttributesDtoV2026: MailFromAttributesDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mailFromAttributesDtoV2026' is not null or undefined - assertParamExists('putMailFromAttributes', 'mailFromAttributesDtoV2026', mailFromAttributesDtoV2026) - const localVarPath = `/mail-from-attributes`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mailFromAttributesDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2026} sendTestNotificationRequestDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification: async (sendTestNotificationRequestDtoV2026: SendTestNotificationRequestDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTestNotificationRequestDtoV2026' is not null or undefined - assertParamExists('sendTestNotification', 'sendTestNotificationRequestDtoV2026', sendTestNotificationRequestDtoV2026) - const localVarPath = `/send-test-notification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTestNotificationRequestDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NotificationsV2026Api - functional programming interface - * @export - */ -export const NotificationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NotificationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {DomainAddressV2026} domainAddressV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDomainDkim(domainAddressV2026: DomainAddressV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkim(domainAddressV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.createDomainDkim']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {TemplateDtoV2026} templateDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNotificationTemplate(templateDtoV2026: TemplateDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplate(templateDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.createNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {EmailStatusDtoV2026} emailStatusDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createVerifiedFromAddress(emailStatusDtoV2026: EmailStatusDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddress(emailStatusDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.createVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {Array} templateBulkDeleteDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulk(templateBulkDeleteDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.deleteNotificationTemplatesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {string} id Unique identifier of the verified sender address to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteVerifiedFromAddress(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddress(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.deleteVerifiedFromAddress']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDkimAttributes(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributes(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getDkimAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMailFromAttributes(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributes(identity, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationPreferences(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getNotificationPreferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {string} id Id of the Notification Template - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getNotificationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). - * @summary Get notification template variables - * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. - * @param {GetNotificationTemplateVariablesMediumV2026} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. - * @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: **key, type, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationTemplateVariables(key: string, medium: GetNotificationTemplateVariablesMediumV2026, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplateVariables(key, medium, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getNotificationTemplateVariables']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.getNotificationsTemplateContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **email**: *eq, ge, le, gt, lt* - * @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: **email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listFromAddresses(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddresses(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.listFromAddresses']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplateDefaults(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaults(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.listNotificationTemplateDefaults']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @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: **key, name, medium** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNotificationTemplates(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplates(limit, offset, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.listNotificationTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {MailFromAttributesDtoV2026} mailFromAttributesDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putMailFromAttributes(mailFromAttributesDtoV2026: MailFromAttributesDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributes(mailFromAttributesDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.putMailFromAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {SendTestNotificationRequestDtoV2026} sendTestNotificationRequestDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTestNotification(sendTestNotificationRequestDtoV2026: SendTestNotificationRequestDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotification(sendTestNotificationRequestDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NotificationsV2026Api.sendTestNotification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NotificationsV2026Api - factory interface - * @export - */ -export const NotificationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NotificationsV2026ApiFp(configuration) - return { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2026ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDomainDkim(requestParameters: NotificationsV2026ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDomainDkim(requestParameters.domainAddressV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2026ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNotificationTemplate(requestParameters: NotificationsV2026ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNotificationTemplate(requestParameters.templateDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2026ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createVerifiedFromAddress(requestParameters: NotificationsV2026ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createVerifiedFromAddress(requestParameters.emailStatusDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2026ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteVerifiedFromAddress(requestParameters: NotificationsV2026ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2026ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDkimAttributes(requestParameters: NotificationsV2026ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2026ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMailFromAttributes(requestParameters: NotificationsV2026ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationPreferences(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2026ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplate(requestParameters: NotificationsV2026ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). - * @summary Get notification template variables - * @param {NotificationsV2026ApiGetNotificationTemplateVariablesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationTemplateVariables(requestParameters: NotificationsV2026ApiGetNotificationTemplateVariablesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationTemplateVariables(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNotificationsTemplateContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2026ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listFromAddresses(requestParameters: NotificationsV2026ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2026ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplateDefaults(requestParameters: NotificationsV2026ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2026ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNotificationTemplates(requestParameters: NotificationsV2026ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2026ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putMailFromAttributes(requestParameters: NotificationsV2026ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putMailFromAttributes(requestParameters.mailFromAttributesDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2026ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTestNotification(requestParameters: NotificationsV2026ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDomainDkim operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiCreateDomainDkimRequest - */ -export interface NotificationsV2026ApiCreateDomainDkimRequest { - /** - * - * @type {DomainAddressV2026} - * @memberof NotificationsV2026ApiCreateDomainDkim - */ - readonly domainAddressV2026: DomainAddressV2026 -} - -/** - * Request parameters for createNotificationTemplate operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiCreateNotificationTemplateRequest - */ -export interface NotificationsV2026ApiCreateNotificationTemplateRequest { - /** - * - * @type {TemplateDtoV2026} - * @memberof NotificationsV2026ApiCreateNotificationTemplate - */ - readonly templateDtoV2026: TemplateDtoV2026 -} - -/** - * Request parameters for createVerifiedFromAddress operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiCreateVerifiedFromAddressRequest - */ -export interface NotificationsV2026ApiCreateVerifiedFromAddressRequest { - /** - * - * @type {EmailStatusDtoV2026} - * @memberof NotificationsV2026ApiCreateVerifiedFromAddress - */ - readonly emailStatusDtoV2026: EmailStatusDtoV2026 -} - -/** - * Request parameters for deleteNotificationTemplatesInBulk operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest - */ -export interface NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest { - /** - * - * @type {Array} - * @memberof NotificationsV2026ApiDeleteNotificationTemplatesInBulk - */ - readonly templateBulkDeleteDtoV2026: Array -} - -/** - * Request parameters for deleteVerifiedFromAddress operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiDeleteVerifiedFromAddressRequest - */ -export interface NotificationsV2026ApiDeleteVerifiedFromAddressRequest { - /** - * Unique identifier of the verified sender address to delete. - * @type {string} - * @memberof NotificationsV2026ApiDeleteVerifiedFromAddress - */ - readonly id: string -} - -/** - * Request parameters for getDkimAttributes operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiGetDkimAttributesRequest - */ -export interface NotificationsV2026ApiGetDkimAttributesRequest { - /** - * 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 NotificationsV2026ApiGetDkimAttributes - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2026ApiGetDkimAttributes - */ - readonly offset?: number -} - -/** - * Request parameters for getMailFromAttributes operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiGetMailFromAttributesRequest - */ -export interface NotificationsV2026ApiGetMailFromAttributesRequest { - /** - * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - * @type {string} - * @memberof NotificationsV2026ApiGetMailFromAttributes - */ - readonly identity: string -} - -/** - * Request parameters for getNotificationTemplate operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiGetNotificationTemplateRequest - */ -export interface NotificationsV2026ApiGetNotificationTemplateRequest { - /** - * Id of the Notification Template - * @type {string} - * @memberof NotificationsV2026ApiGetNotificationTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNotificationTemplateVariables operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiGetNotificationTemplateVariablesRequest - */ -export interface NotificationsV2026ApiGetNotificationTemplateVariablesRequest { - /** - * The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. - * @type {string} - * @memberof NotificationsV2026ApiGetNotificationTemplateVariables - */ - readonly key: string - - /** - * The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. - * @type {'EMAIL' | 'SLACK' | 'TEAMS'} - * @memberof NotificationsV2026ApiGetNotificationTemplateVariables - */ - readonly medium: GetNotificationTemplateVariablesMediumV2026 - - /** - * 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: **key, type, description** - * @type {string} - * @memberof NotificationsV2026ApiGetNotificationTemplateVariables - */ - readonly sorters?: string -} - -/** - * Request parameters for listFromAddresses operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiListFromAddressesRequest - */ -export interface NotificationsV2026ApiListFromAddressesRequest { - /** - * 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 NotificationsV2026ApiListFromAddresses - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2026ApiListFromAddresses - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NotificationsV2026ApiListFromAddresses - */ - 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: **email**: *eq, ge, le, gt, lt* - * @type {string} - * @memberof NotificationsV2026ApiListFromAddresses - */ - 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: **email** - * @type {string} - * @memberof NotificationsV2026ApiListFromAddresses - */ - readonly sorters?: string -} - -/** - * Request parameters for listNotificationTemplateDefaults operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiListNotificationTemplateDefaultsRequest - */ -export interface NotificationsV2026ApiListNotificationTemplateDefaultsRequest { - /** - * 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 NotificationsV2026ApiListNotificationTemplateDefaults - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2026ApiListNotificationTemplateDefaults - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2026ApiListNotificationTemplateDefaults - */ - readonly filters?: string -} - -/** - * Request parameters for listNotificationTemplates operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiListNotificationTemplatesRequest - */ -export interface NotificationsV2026ApiListNotificationTemplatesRequest { - /** - * 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 NotificationsV2026ApiListNotificationTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NotificationsV2026ApiListNotificationTemplates - */ - readonly offset?: number - - /** - * 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - * @type {string} - * @memberof NotificationsV2026ApiListNotificationTemplates - */ - 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: **key, name, medium** - * @type {string} - * @memberof NotificationsV2026ApiListNotificationTemplates - */ - readonly sorters?: string -} - -/** - * Request parameters for putMailFromAttributes operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiPutMailFromAttributesRequest - */ -export interface NotificationsV2026ApiPutMailFromAttributesRequest { - /** - * - * @type {MailFromAttributesDtoV2026} - * @memberof NotificationsV2026ApiPutMailFromAttributes - */ - readonly mailFromAttributesDtoV2026: MailFromAttributesDtoV2026 -} - -/** - * Request parameters for sendTestNotification operation in NotificationsV2026Api. - * @export - * @interface NotificationsV2026ApiSendTestNotificationRequest - */ -export interface NotificationsV2026ApiSendTestNotificationRequest { - /** - * - * @type {SendTestNotificationRequestDtoV2026} - * @memberof NotificationsV2026ApiSendTestNotification - */ - readonly sendTestNotificationRequestDtoV2026: SendTestNotificationRequestDtoV2026 -} - -/** - * NotificationsV2026Api - object-oriented interface - * @export - * @class NotificationsV2026Api - * @extends {BaseAPI} - */ -export class NotificationsV2026Api extends BaseAPI { - /** - * Create a domain to be verified via DKIM (DomainKeys Identified Mail) - * @summary Verify domain address via dkim - * @param {NotificationsV2026ApiCreateDomainDkimRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public createDomainDkim(requestParameters: NotificationsV2026ApiCreateDomainDkimRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).createDomainDkim(requestParameters.domainAddressV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - * @summary Create notification template - * @param {NotificationsV2026ApiCreateNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public createNotificationTemplate(requestParameters: NotificationsV2026ApiCreateNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).createNotificationTemplate(requestParameters.templateDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new sender email address and initiate verification process. - * @summary Create verified from address - * @param {NotificationsV2026ApiCreateVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public createVerifiedFromAddress(requestParameters: NotificationsV2026ApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).createVerifiedFromAddress(requestParameters.emailStatusDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lets you bulk delete templates that you previously created for your site. - * @summary Bulk delete notification templates - * @param {NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public deleteNotificationTemplatesInBulk(requestParameters: NotificationsV2026ApiDeleteNotificationTemplatesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).deleteNotificationTemplatesInBulk(requestParameters.templateBulkDeleteDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a verified sender email address - * @summary Delete verified from address - * @param {NotificationsV2026ApiDeleteVerifiedFromAddressRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public deleteVerifiedFromAddress(requestParameters: NotificationsV2026ApiDeleteVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).deleteVerifiedFromAddress(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. - * @summary Get dkim attributes - * @param {NotificationsV2026ApiGetDkimAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getDkimAttributes(requestParameters: NotificationsV2026ApiGetDkimAttributesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getDkimAttributes(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve MAIL FROM attributes for a given AWS SES identity. - * @summary Get mail from attributes - * @param {NotificationsV2026ApiGetMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getMailFromAttributes(requestParameters: NotificationsV2026ApiGetMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getMailFromAttributes(requestParameters.identity, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of notification preferences for tenant. - * @summary List notification preferences for tenant. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getNotificationPreferences(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getNotificationPreferences(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a template that you have modified for your site by Id. - * @summary Get notification template by id - * @param {NotificationsV2026ApiGetNotificationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getNotificationTemplate(requestParameters: NotificationsV2026ApiGetNotificationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getNotificationTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). - * @summary Get notification template variables - * @param {NotificationsV2026ApiGetNotificationTemplateVariablesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getNotificationTemplateVariables(requestParameters: NotificationsV2026ApiGetNotificationTemplateVariablesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getNotificationTemplateVariables(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). - * @summary Get notification template context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public getNotificationsTemplateContext(axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).getNotificationsTemplateContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a list of sender email addresses and their verification statuses - * @summary List from addresses - * @param {NotificationsV2026ApiListFromAddressesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public listFromAddresses(requestParameters: NotificationsV2026ApiListFromAddressesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).listFromAddresses(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the default templates used for notifications, such as emails from IdentityNow. - * @summary List notification template defaults - * @param {NotificationsV2026ApiListNotificationTemplateDefaultsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public listNotificationTemplateDefaults(requestParameters: NotificationsV2026ApiListNotificationTemplateDefaultsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).listNotificationTemplateDefaults(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the templates that you have modified for your site. - * @summary List notification templates - * @param {NotificationsV2026ApiListNotificationTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public listNotificationTemplates(requestParameters: NotificationsV2026ApiListNotificationTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).listNotificationTemplates(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS - * @summary Change mail from domain - * @param {NotificationsV2026ApiPutMailFromAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public putMailFromAttributes(requestParameters: NotificationsV2026ApiPutMailFromAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).putMailFromAttributes(requestParameters.mailFromAttributesDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Send a Test Notification - * @summary Send test notification - * @param {NotificationsV2026ApiSendTestNotificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NotificationsV2026Api - */ - public sendTestNotification(requestParameters: NotificationsV2026ApiSendTestNotificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return NotificationsV2026ApiFp(this.configuration).sendTestNotification(requestParameters.sendTestNotificationRequestDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetNotificationTemplateVariablesMediumV2026 = { - Email: 'EMAIL', - Slack: 'SLACK', - Teams: 'TEAMS' -} as const; -export type GetNotificationTemplateVariablesMediumV2026 = typeof GetNotificationTemplateVariablesMediumV2026[keyof typeof GetNotificationTemplateVariablesMediumV2026]; - - -/** - * OAuthClientsV2026Api - axios parameter creator - * @export - */ -export const OAuthClientsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2026} createOAuthClientRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient: async (createOAuthClientRequestV2026: CreateOAuthClientRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createOAuthClientRequestV2026' is not null or undefined - assertParamExists('createOauthClient', 'createOAuthClientRequestV2026', createOAuthClientRequestV2026) - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2026 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchOauthClient', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchOauthClient', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OAuthClientsV2026Api - functional programming interface - * @export - */ -export const OAuthClientsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OAuthClientsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequestV2026} createOAuthClientRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createOauthClient(createOAuthClientRequestV2026: CreateOAuthClientRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClient(createOAuthClientRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2026Api.createOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2026Api.deleteOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2026Api.getOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOauthClients(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClients(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2026Api.listOauthClients']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperationV2026 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOauthClient(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClient(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsV2026Api.patchOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OAuthClientsV2026Api - factory interface - * @export - */ -export const OAuthClientsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OAuthClientsV2026ApiFp(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2026ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient(requestParameters: OAuthClientsV2026ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createOauthClient(requestParameters.createOAuthClientRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2026ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient(requestParameters: OAuthClientsV2026ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2026ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient(requestParameters: OAuthClientsV2026ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2026ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients(requestParameters: OAuthClientsV2026ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2026ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient(requestParameters: OAuthClientsV2026ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createOauthClient operation in OAuthClientsV2026Api. - * @export - * @interface OAuthClientsV2026ApiCreateOauthClientRequest - */ -export interface OAuthClientsV2026ApiCreateOauthClientRequest { - /** - * - * @type {CreateOAuthClientRequestV2026} - * @memberof OAuthClientsV2026ApiCreateOauthClient - */ - readonly createOAuthClientRequestV2026: CreateOAuthClientRequestV2026 -} - -/** - * Request parameters for deleteOauthClient operation in OAuthClientsV2026Api. - * @export - * @interface OAuthClientsV2026ApiDeleteOauthClientRequest - */ -export interface OAuthClientsV2026ApiDeleteOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2026ApiDeleteOauthClient - */ - readonly id: string -} - -/** - * Request parameters for getOauthClient operation in OAuthClientsV2026Api. - * @export - * @interface OAuthClientsV2026ApiGetOauthClientRequest - */ -export interface OAuthClientsV2026ApiGetOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2026ApiGetOauthClient - */ - readonly id: string -} - -/** - * Request parameters for listOauthClients operation in OAuthClientsV2026Api. - * @export - * @interface OAuthClientsV2026ApiListOauthClientsRequest - */ -export interface OAuthClientsV2026ApiListOauthClientsRequest { - /** - * 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof OAuthClientsV2026ApiListOauthClients - */ - readonly filters?: string -} - -/** - * Request parameters for patchOauthClient operation in OAuthClientsV2026Api. - * @export - * @interface OAuthClientsV2026ApiPatchOauthClientRequest - */ -export interface OAuthClientsV2026ApiPatchOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsV2026ApiPatchOauthClient - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @type {Array} - * @memberof OAuthClientsV2026ApiPatchOauthClient - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * OAuthClientsV2026Api - object-oriented interface - * @export - * @class OAuthClientsV2026Api - * @extends {BaseAPI} - */ -export class OAuthClientsV2026Api extends BaseAPI { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsV2026ApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2026Api - */ - public createOauthClient(requestParameters: OAuthClientsV2026ApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2026ApiFp(this.configuration).createOauthClient(requestParameters.createOAuthClientRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsV2026ApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2026Api - */ - public deleteOauthClient(requestParameters: OAuthClientsV2026ApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2026ApiFp(this.configuration).deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsV2026ApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2026Api - */ - public getOauthClient(requestParameters: OAuthClientsV2026ApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2026ApiFp(this.configuration).getOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsV2026ApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2026Api - */ - public listOauthClients(requestParameters: OAuthClientsV2026ApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2026ApiFp(this.configuration).listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsV2026ApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsV2026Api - */ - public patchOauthClient(requestParameters: OAuthClientsV2026ApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsV2026ApiFp(this.configuration).patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OrgConfigV2026Api - axios parameter creator - * @export - */ -export const OrgConfigV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones: async (xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/org-config/valid-time-zones`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2026 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig: async (jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchOrgConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * OrgConfigV2026Api - functional programming interface - * @export - */ -export const OrgConfigV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrgConfigV2026ApiAxiosParamCreator(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2026Api.getOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getValidTimeZones(xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getValidTimeZones(xSailPointExperimental, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2026Api.getValidTimeZones']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {Array} jsonPatchOperationV2026 A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOrgConfig(jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOrgConfig(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OrgConfigV2026Api.patchOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OrgConfigV2026Api - factory interface - * @export - */ -export const OrgConfigV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrgConfigV2026ApiFp(configuration) - return { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2026ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getValidTimeZones(requestParameters: OrgConfigV2026ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2026ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOrgConfig(requestParameters: OrgConfigV2026ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOrgConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getValidTimeZones operation in OrgConfigV2026Api. - * @export - * @interface OrgConfigV2026ApiGetValidTimeZonesRequest - */ -export interface OrgConfigV2026ApiGetValidTimeZonesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof OrgConfigV2026ApiGetValidTimeZones - */ - readonly xSailPointExperimental?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2026ApiGetValidTimeZones - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof OrgConfigV2026ApiGetValidTimeZones - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof OrgConfigV2026ApiGetValidTimeZones - */ - readonly count?: boolean -} - -/** - * Request parameters for patchOrgConfig operation in OrgConfigV2026Api. - * @export - * @interface OrgConfigV2026ApiPatchOrgConfigRequest - */ -export interface OrgConfigV2026ApiPatchOrgConfigRequest { - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof OrgConfigV2026ApiPatchOrgConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * OrgConfigV2026Api - object-oriented interface - * @export - * @class OrgConfigV2026Api - * @extends {BaseAPI} - */ -export class OrgConfigV2026Api extends BaseAPI { - /** - * Get the current organization\'s configuration settings, only external accessible properties. - * @summary Get org config settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2026Api - */ - public getOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2026ApiFp(this.configuration).getOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the valid time zones that can be set in organization configurations. - * @summary Get valid time zones - * @param {OrgConfigV2026ApiGetValidTimeZonesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2026Api - */ - public getValidTimeZones(requestParameters: OrgConfigV2026ApiGetValidTimeZonesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2026ApiFp(this.configuration).getValidTimeZones(requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch the current organization\'s configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization\'s time zone. - * @summary Patch org config - * @param {OrgConfigV2026ApiPatchOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OrgConfigV2026Api - */ - public patchOrgConfig(requestParameters: OrgConfigV2026ApiPatchOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return OrgConfigV2026ApiFp(this.configuration).patchOrgConfig(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ParameterStorageV2026Api - axios parameter creator - * @export - */ -export const ParameterStorageV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageNewParameterV2026} [parameterStorageNewParameterV2026] The parameter to add to the store. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createParameter: async (parameterStorageNewParameterV2026?: ParameterStorageNewParameterV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/parameter-storage/parameters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(parameterStorageNewParameterV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {string} id The ID of the parameter to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteParameter: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {string} key Base64Url encoded NIST P-384 public key - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAttestationDocument: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'key' is not null or undefined - assertParamExists('getAttestationDocument', 'key', key) - const localVarPath = `/parameter-storage/attestation`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (key !== undefined) { - localVarQueryParameter['key'] = key; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {string} id The ID of the parameter to be fetched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameter: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {string} id The ID of the parameter which you want to fetch the references for. - * @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, consumerId, parameterId, name, usageHint** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterReferences: async (id: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getParameterReferences', 'id', id) - const localVarPath = `/parameter-storage/parameters/{id}/references` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterStorageSpecification: async (acceptLanguage?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (acceptLanguage === undefined) { - acceptLanguage = 'en'; - } - - const localVarPath = `/parameter-storage/specification`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (acceptLanguage != null) { - localVarHeaderParameter['Accept-Language'] = String(acceptLanguage); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchParameters: async (filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/parameter-storage/parameters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {string} id The ID of the parameter to be updated. - * @param {ParameterStorageUpdateParameterV2026} [parameterStorageUpdateParameterV2026] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateParameter: async (id: string, parameterStorageUpdateParameterV2026?: ParameterStorageUpdateParameterV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateParameter', 'id', id) - const localVarPath = `/parameter-storage/parameters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(parameterStorageUpdateParameterV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ParameterStorageV2026Api - functional programming interface - * @export - */ -export const ParameterStorageV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ParameterStorageV2026ApiAxiosParamCreator(configuration) - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageNewParameterV2026} [parameterStorageNewParameterV2026] The parameter to add to the store. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createParameter(parameterStorageNewParameterV2026?: ParameterStorageNewParameterV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createParameter(parameterStorageNewParameterV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.createParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {string} id The ID of the parameter to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteParameter(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.deleteParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {string} key Base64Url encoded NIST P-384 public key - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAttestationDocument(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAttestationDocument(key, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.getAttestationDocument']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {string} id The ID of the parameter to be fetched - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameter(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameter(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.getParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {string} id The ID of the parameter which you want to fetch the references for. - * @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, consumerId, parameterId, name, usageHint** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameterReferences(id: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterReferences(id, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.getParameterReferences']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {string} [acceptLanguage] The i18n internationalization code for the language that the spec is in. Defaults to english. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getParameterStorageSpecification(acceptLanguage?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getParameterStorageSpecification(acceptLanguage, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.getParameterStorageSpecification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchParameters(filters?: string, sorters?: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchParameters(filters, sorters, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.searchParameters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {string} id The ID of the parameter to be updated. - * @param {ParameterStorageUpdateParameterV2026} [parameterStorageUpdateParameterV2026] The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateParameter(id: string, parameterStorageUpdateParameterV2026?: ParameterStorageUpdateParameterV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateParameter(id, parameterStorageUpdateParameterV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ParameterStorageV2026Api.updateParameter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ParameterStorageV2026Api - factory interface - * @export - */ -export const ParameterStorageV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ParameterStorageV2026ApiFp(configuration) - return { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageV2026ApiCreateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createParameter(requestParameters: ParameterStorageV2026ApiCreateParameterRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createParameter(requestParameters.parameterStorageNewParameterV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {ParameterStorageV2026ApiDeleteParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteParameter(requestParameters: ParameterStorageV2026ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteParameter(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {ParameterStorageV2026ApiGetAttestationDocumentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAttestationDocument(requestParameters: ParameterStorageV2026ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAttestationDocument(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {ParameterStorageV2026ApiGetParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameter(requestParameters: ParameterStorageV2026ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getParameter(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {ParameterStorageV2026ApiGetParameterReferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterReferences(requestParameters: ParameterStorageV2026ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getParameterReferences(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {ParameterStorageV2026ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getParameterStorageSpecification(requestParameters: ParameterStorageV2026ApiGetParameterStorageSpecificationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getParameterStorageSpecification(requestParameters.acceptLanguage, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @param {ParameterStorageV2026ApiSearchParametersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchParameters(requestParameters: ParameterStorageV2026ApiSearchParametersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchParameters(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {ParameterStorageV2026ApiUpdateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateParameter(requestParameters: ParameterStorageV2026ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateParameter(requestParameters.id, requestParameters.parameterStorageUpdateParameterV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createParameter operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiCreateParameterRequest - */ -export interface ParameterStorageV2026ApiCreateParameterRequest { - /** - * The parameter to add to the store. - * @type {ParameterStorageNewParameterV2026} - * @memberof ParameterStorageV2026ApiCreateParameter - */ - readonly parameterStorageNewParameterV2026?: ParameterStorageNewParameterV2026 -} - -/** - * Request parameters for deleteParameter operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiDeleteParameterRequest - */ -export interface ParameterStorageV2026ApiDeleteParameterRequest { - /** - * The ID of the parameter to be deleted. - * @type {string} - * @memberof ParameterStorageV2026ApiDeleteParameter - */ - readonly id: string -} - -/** - * Request parameters for getAttestationDocument operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiGetAttestationDocumentRequest - */ -export interface ParameterStorageV2026ApiGetAttestationDocumentRequest { - /** - * Base64Url encoded NIST P-384 public key - * @type {string} - * @memberof ParameterStorageV2026ApiGetAttestationDocument - */ - readonly key: string -} - -/** - * Request parameters for getParameter operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiGetParameterRequest - */ -export interface ParameterStorageV2026ApiGetParameterRequest { - /** - * The ID of the parameter to be fetched - * @type {string} - * @memberof ParameterStorageV2026ApiGetParameter - */ - readonly id: string -} - -/** - * Request parameters for getParameterReferences operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiGetParameterReferencesRequest - */ -export interface ParameterStorageV2026ApiGetParameterReferencesRequest { - /** - * The ID of the parameter which you want to fetch the references for. - * @type {string} - * @memberof ParameterStorageV2026ApiGetParameterReferences - */ - readonly id: 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, consumerId, parameterId, name, usageHint** - * @type {string} - * @memberof ParameterStorageV2026ApiGetParameterReferences - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ParameterStorageV2026ApiGetParameterReferences - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ParameterStorageV2026ApiGetParameterReferences - */ - readonly offset?: number -} - -/** - * Request parameters for getParameterStorageSpecification operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiGetParameterStorageSpecificationRequest - */ -export interface ParameterStorageV2026ApiGetParameterStorageSpecificationRequest { - /** - * The i18n internationalization code for the language that the spec is in. Defaults to english. - * @type {string} - * @memberof ParameterStorageV2026ApiGetParameterStorageSpecification - */ - readonly acceptLanguage?: string -} - -/** - * Request parameters for searchParameters operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiSearchParametersRequest - */ -export interface ParameterStorageV2026ApiSearchParametersRequest { - /** - * 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, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* - * @type {string} - * @memberof ParameterStorageV2026ApiSearchParameters - */ - 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, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** - * @type {string} - * @memberof ParameterStorageV2026ApiSearchParameters - */ - readonly sorters?: string - - /** - * 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 ParameterStorageV2026ApiSearchParameters - */ - 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 ParameterStorageV2026ApiSearchParameters - */ - readonly limit?: number -} - -/** - * Request parameters for updateParameter operation in ParameterStorageV2026Api. - * @export - * @interface ParameterStorageV2026ApiUpdateParameterRequest - */ -export interface ParameterStorageV2026ApiUpdateParameterRequest { - /** - * The ID of the parameter to be updated. - * @type {string} - * @memberof ParameterStorageV2026ApiUpdateParameter - */ - readonly id: string - - /** - * The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. - * @type {ParameterStorageUpdateParameterV2026} - * @memberof ParameterStorageV2026ApiUpdateParameter - */ - readonly parameterStorageUpdateParameterV2026?: ParameterStorageUpdateParameterV2026 -} - -/** - * ParameterStorageV2026Api - object-oriented interface - * @export - * @class ParameterStorageV2026Api - * @extends {BaseAPI} - */ -export class ParameterStorageV2026Api extends BaseAPI { - /** - * Add a new parameter. - * @summary Add a new parameter. - * @param {ParameterStorageV2026ApiCreateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public createParameter(requestParameters: ParameterStorageV2026ApiCreateParameterRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).createParameter(requestParameters.parameterStorageNewParameterV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a parameter. Will only delete parameters without existing references. - * @summary Delete a parameter. - * @param {ParameterStorageV2026ApiDeleteParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public deleteParameter(requestParameters: ParameterStorageV2026ApiDeleteParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).deleteParameter(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. - * @summary Get an attestation document. - * @param {ParameterStorageV2026ApiGetAttestationDocumentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public getAttestationDocument(requestParameters: ParameterStorageV2026ApiGetAttestationDocumentRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).getAttestationDocument(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a parameter by ID. This will only return the public fields for the parameter. - * @summary Get a specific parameter. - * @param {ParameterStorageV2026ApiGetParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public getParameter(requestParameters: ParameterStorageV2026ApiGetParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).getParameter(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the references for a given parameter. - * @summary Get parameter references. - * @param {ParameterStorageV2026ApiGetParameterReferencesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public getParameterReferences(requestParameters: ParameterStorageV2026ApiGetParameterReferencesRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).getParameterReferences(requestParameters.id, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the specifications for all parameter types. All parameters must conform to this specification document. - * @summary Get specifications for parameter types. - * @param {ParameterStorageV2026ApiGetParameterStorageSpecificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public getParameterStorageSpecification(requestParameters: ParameterStorageV2026ApiGetParameterStorageSpecificationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).getParameterStorageSpecification(requestParameters.acceptLanguage, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Query a stored parameter. - * @summary Query stored parameters. - * @param {ParameterStorageV2026ApiSearchParametersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public searchParameters(requestParameters: ParameterStorageV2026ApiSearchParametersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).searchParameters(requestParameters.filters, requestParameters.sorters, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a parameter. You cannot change a parameter\'s type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. - * @summary Update a parameter. - * @param {ParameterStorageV2026ApiUpdateParameterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ParameterStorageV2026Api - */ - public updateParameter(requestParameters: ParameterStorageV2026ApiUpdateParameterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ParameterStorageV2026ApiFp(this.configuration).updateParameter(requestParameters.id, requestParameters.parameterStorageUpdateParameterV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordConfigurationV2026Api - axios parameter creator - * @export - */ -export const PasswordConfigurationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2026} passwordOrgConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig: async (passwordOrgConfigV2026: PasswordOrgConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2026' is not null or undefined - assertParamExists('createPasswordOrgConfig', 'passwordOrgConfigV2026', passwordOrgConfigV2026) - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2026} passwordOrgConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig: async (passwordOrgConfigV2026: PasswordOrgConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfigV2026' is not null or undefined - assertParamExists('putPasswordOrgConfig', 'passwordOrgConfigV2026', passwordOrgConfigV2026) - const localVarPath = `/password-org-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordConfigurationV2026Api - functional programming interface - * @export - */ -export const PasswordConfigurationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordConfigurationV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfigV2026} passwordOrgConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordOrgConfig(passwordOrgConfigV2026: PasswordOrgConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfig(passwordOrgConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2026Api.createPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2026Api.getPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfigV2026} passwordOrgConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordOrgConfig(passwordOrgConfigV2026: PasswordOrgConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfig(passwordOrgConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationV2026Api.putPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordConfigurationV2026Api - factory interface - * @export - */ -export const PasswordConfigurationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordConfigurationV2026ApiFp(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig(requestParameters: PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordOrgConfig(requestParameters.passwordOrgConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig(requestParameters: PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordOrgConfig(requestParameters.passwordOrgConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordOrgConfig operation in PasswordConfigurationV2026Api. - * @export - * @interface PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2026} - * @memberof PasswordConfigurationV2026ApiCreatePasswordOrgConfig - */ - readonly passwordOrgConfigV2026: PasswordOrgConfigV2026 -} - -/** - * Request parameters for putPasswordOrgConfig operation in PasswordConfigurationV2026Api. - * @export - * @interface PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest - */ -export interface PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfigV2026} - * @memberof PasswordConfigurationV2026ApiPutPasswordOrgConfig - */ - readonly passwordOrgConfigV2026: PasswordOrgConfigV2026 -} - -/** - * PasswordConfigurationV2026Api - object-oriented interface - * @export - * @class PasswordConfigurationV2026Api - * @extends {BaseAPI} - */ -export class PasswordConfigurationV2026Api extends BaseAPI { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2026Api - */ - public createPasswordOrgConfig(requestParameters: PasswordConfigurationV2026ApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2026ApiFp(this.configuration).createPasswordOrgConfig(requestParameters.passwordOrgConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2026Api - */ - public getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2026ApiFp(this.configuration).getPasswordOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationV2026Api - */ - public putPasswordOrgConfig(requestParameters: PasswordConfigurationV2026ApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationV2026ApiFp(this.configuration).putPasswordOrgConfig(requestParameters.passwordOrgConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordDictionaryV2026Api - axios parameter creator - * @export - */ -export const PasswordDictionaryV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordDictionaryV2026Api - functional programming interface - * @export - */ -export const PasswordDictionaryV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordDictionaryV2026ApiAxiosParamCreator(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2026Api.getPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordDictionary(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionary(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryV2026Api.putPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordDictionaryV2026Api - factory interface - * @export - */ -export const PasswordDictionaryV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordDictionaryV2026ApiFp(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordDictionary(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2026ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary(requestParameters: PasswordDictionaryV2026ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for putPasswordDictionary operation in PasswordDictionaryV2026Api. - * @export - * @interface PasswordDictionaryV2026ApiPutPasswordDictionaryRequest - */ -export interface PasswordDictionaryV2026ApiPutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PasswordDictionaryV2026ApiPutPasswordDictionary - */ - readonly file?: File -} - -/** - * PasswordDictionaryV2026Api - object-oriented interface - * @export - * @class PasswordDictionaryV2026Api - * @extends {BaseAPI} - */ -export class PasswordDictionaryV2026Api extends BaseAPI { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2026Api - */ - public getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2026ApiFp(this.configuration).getPasswordDictionary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryV2026ApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryV2026Api - */ - public putPasswordDictionary(requestParameters: PasswordDictionaryV2026ApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryV2026ApiFp(this.configuration).putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordManagementV2026Api - axios parameter creator - * @export - */ -export const PasswordManagementV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2026} passwordDigitTokenResetV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken: async (passwordDigitTokenResetV2026: PasswordDigitTokenResetV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordDigitTokenResetV2026' is not null or undefined - assertParamExists('createDigitToken', 'passwordDigitTokenResetV2026', passwordDigitTokenResetV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/generate-password-reset-token/digit`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordDigitTokenResetV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordChangeStatus', 'id', id) - const localVarPath = `/password-change-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2026} passwordInfoQueryDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo: async (passwordInfoQueryDTOV2026: PasswordInfoQueryDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordInfoQueryDTOV2026' is not null or undefined - assertParamExists('queryPasswordInfo', 'passwordInfoQueryDTOV2026', passwordInfoQueryDTOV2026) - const localVarPath = `/query-password-info`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordInfoQueryDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2026} passwordChangeRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword: async (passwordChangeRequestV2026: PasswordChangeRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordChangeRequestV2026' is not null or undefined - assertParamExists('setPassword', 'passwordChangeRequestV2026', passwordChangeRequestV2026) - const localVarPath = `/set-password`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordChangeRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordManagementV2026Api - functional programming interface - * @export - */ -export const PasswordManagementV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordManagementV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordDigitTokenResetV2026} passwordDigitTokenResetV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createDigitToken(passwordDigitTokenResetV2026: PasswordDigitTokenResetV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createDigitToken(passwordDigitTokenResetV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2026Api.createDigitToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordChangeStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordChangeStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2026Api.getPasswordChangeStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTOV2026} passwordInfoQueryDTOV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async queryPasswordInfo(passwordInfoQueryDTOV2026: PasswordInfoQueryDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfo(passwordInfoQueryDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2026Api.queryPasswordInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequestV2026} passwordChangeRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPassword(passwordChangeRequestV2026: PasswordChangeRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPassword(passwordChangeRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementV2026Api.setPassword']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordManagementV2026Api - factory interface - * @export - */ -export const PasswordManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordManagementV2026ApiFp(configuration) - return { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2026ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createDigitToken(requestParameters: PasswordManagementV2026ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createDigitToken(requestParameters.passwordDigitTokenResetV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2026ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus(requestParameters: PasswordManagementV2026ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2026ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo(requestParameters: PasswordManagementV2026ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2026ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword(requestParameters: PasswordManagementV2026ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPassword(requestParameters.passwordChangeRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createDigitToken operation in PasswordManagementV2026Api. - * @export - * @interface PasswordManagementV2026ApiCreateDigitTokenRequest - */ -export interface PasswordManagementV2026ApiCreateDigitTokenRequest { - /** - * - * @type {PasswordDigitTokenResetV2026} - * @memberof PasswordManagementV2026ApiCreateDigitToken - */ - readonly passwordDigitTokenResetV2026: PasswordDigitTokenResetV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordManagementV2026ApiCreateDigitToken - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPasswordChangeStatus operation in PasswordManagementV2026Api. - * @export - * @interface PasswordManagementV2026ApiGetPasswordChangeStatusRequest - */ -export interface PasswordManagementV2026ApiGetPasswordChangeStatusRequest { - /** - * Password change request ID - * @type {string} - * @memberof PasswordManagementV2026ApiGetPasswordChangeStatus - */ - readonly id: string -} - -/** - * Request parameters for queryPasswordInfo operation in PasswordManagementV2026Api. - * @export - * @interface PasswordManagementV2026ApiQueryPasswordInfoRequest - */ -export interface PasswordManagementV2026ApiQueryPasswordInfoRequest { - /** - * - * @type {PasswordInfoQueryDTOV2026} - * @memberof PasswordManagementV2026ApiQueryPasswordInfo - */ - readonly passwordInfoQueryDTOV2026: PasswordInfoQueryDTOV2026 -} - -/** - * Request parameters for setPassword operation in PasswordManagementV2026Api. - * @export - * @interface PasswordManagementV2026ApiSetPasswordRequest - */ -export interface PasswordManagementV2026ApiSetPasswordRequest { - /** - * - * @type {PasswordChangeRequestV2026} - * @memberof PasswordManagementV2026ApiSetPassword - */ - readonly passwordChangeRequestV2026: PasswordChangeRequestV2026 -} - -/** - * PasswordManagementV2026Api - object-oriented interface - * @export - * @class PasswordManagementV2026Api - * @extends {BaseAPI} - */ -export class PasswordManagementV2026Api extends BaseAPI { - /** - * This API is used to generate a digit token for password management. Requires authorization scope of \"idn:password-digit-token:create\". - * @summary Generate a digit token - * @param {PasswordManagementV2026ApiCreateDigitTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2026Api - */ - public createDigitToken(requestParameters: PasswordManagementV2026ApiCreateDigitTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2026ApiFp(this.configuration).createDigitToken(requestParameters.passwordDigitTokenResetV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementV2026ApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2026Api - */ - public getPasswordChangeStatus(requestParameters: PasswordManagementV2026ApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2026ApiFp(this.configuration).getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementV2026ApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2026Api - */ - public queryPasswordInfo(requestParameters: PasswordManagementV2026ApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2026ApiFp(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementV2026ApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementV2026Api - */ - public setPassword(requestParameters: PasswordManagementV2026ApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementV2026ApiFp(this.configuration).setPassword(requestParameters.passwordChangeRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordPoliciesV2026Api - axios parameter creator - * @export - */ -export const PasswordPoliciesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2026} passwordPolicyV3DtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy: async (passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordPolicyV3DtoV2026' is not null or undefined - assertParamExists('createPasswordPolicy', 'passwordPolicyV3DtoV2026', passwordPolicyV3DtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordPolicy', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordPolicyById', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies: async (limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2026} passwordPolicyV3DtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy: async (id: string, passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setPasswordPolicy', 'id', id) - // verify required parameter 'passwordPolicyV3DtoV2026' is not null or undefined - assertParamExists('setPasswordPolicy', 'passwordPolicyV3DtoV2026', passwordPolicyV3DtoV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/password-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3DtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordPoliciesV2026Api - functional programming interface - * @export - */ -export const PasswordPoliciesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordPoliciesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3DtoV2026} passwordPolicyV3DtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordPolicy(passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicy(passwordPolicyV3DtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2026Api.createPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordPolicy(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicy(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2026Api.deletePasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordPolicyById(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyById(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2026Api.getPasswordPolicyById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicies(limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicies(limit, offset, count, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2026Api.listPasswordPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3DtoV2026} passwordPolicyV3DtoV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPasswordPolicy(id: string, passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicy(id, passwordPolicyV3DtoV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesV2026Api.setPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordPoliciesV2026Api - factory interface - * @export - */ -export const PasswordPoliciesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordPoliciesV2026ApiFp(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2026ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy(requestParameters: PasswordPoliciesV2026ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2026ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy(requestParameters: PasswordPoliciesV2026ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordPolicy(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById(requestParameters: PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordPolicyById(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2026ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies(requestParameters: PasswordPoliciesV2026ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2026ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy(requestParameters: PasswordPoliciesV2026ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordPolicy operation in PasswordPoliciesV2026Api. - * @export - * @interface PasswordPoliciesV2026ApiCreatePasswordPolicyRequest - */ -export interface PasswordPoliciesV2026ApiCreatePasswordPolicyRequest { - /** - * - * @type {PasswordPolicyV3DtoV2026} - * @memberof PasswordPoliciesV2026ApiCreatePasswordPolicy - */ - readonly passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2026ApiCreatePasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deletePasswordPolicy operation in PasswordPoliciesV2026Api. - * @export - * @interface PasswordPoliciesV2026ApiDeletePasswordPolicyRequest - */ -export interface PasswordPoliciesV2026ApiDeletePasswordPolicyRequest { - /** - * The ID of password policy to delete. - * @type {string} - * @memberof PasswordPoliciesV2026ApiDeletePasswordPolicy - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2026ApiDeletePasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getPasswordPolicyById operation in PasswordPoliciesV2026Api. - * @export - * @interface PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest - */ -export interface PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest { - /** - * The ID of password policy to retrieve. - * @type {string} - * @memberof PasswordPoliciesV2026ApiGetPasswordPolicyById - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2026ApiGetPasswordPolicyById - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listPasswordPolicies operation in PasswordPoliciesV2026Api. - * @export - * @interface PasswordPoliciesV2026ApiListPasswordPoliciesRequest - */ -export interface PasswordPoliciesV2026ApiListPasswordPoliciesRequest { - /** - * 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 PasswordPoliciesV2026ApiListPasswordPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordPoliciesV2026ApiListPasswordPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordPoliciesV2026ApiListPasswordPolicies - */ - readonly count?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2026ApiListPasswordPolicies - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setPasswordPolicy operation in PasswordPoliciesV2026Api. - * @export - * @interface PasswordPoliciesV2026ApiSetPasswordPolicyRequest - */ -export interface PasswordPoliciesV2026ApiSetPasswordPolicyRequest { - /** - * The ID of password policy to update. - * @type {string} - * @memberof PasswordPoliciesV2026ApiSetPasswordPolicy - */ - readonly id: string - - /** - * - * @type {PasswordPolicyV3DtoV2026} - * @memberof PasswordPoliciesV2026ApiSetPasswordPolicy - */ - readonly passwordPolicyV3DtoV2026: PasswordPolicyV3DtoV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof PasswordPoliciesV2026ApiSetPasswordPolicy - */ - readonly xSailPointExperimental?: string -} - -/** - * PasswordPoliciesV2026Api - object-oriented interface - * @export - * @class PasswordPoliciesV2026Api - * @extends {BaseAPI} - */ -export class PasswordPoliciesV2026Api extends BaseAPI { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesV2026ApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2026Api - */ - public createPasswordPolicy(requestParameters: PasswordPoliciesV2026ApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2026ApiFp(this.configuration).createPasswordPolicy(requestParameters.passwordPolicyV3DtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesV2026ApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2026Api - */ - public deletePasswordPolicy(requestParameters: PasswordPoliciesV2026ApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2026ApiFp(this.configuration).deletePasswordPolicy(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2026Api - */ - public getPasswordPolicyById(requestParameters: PasswordPoliciesV2026ApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2026ApiFp(this.configuration).getPasswordPolicyById(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesV2026ApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2026Api - */ - public listPasswordPolicies(requestParameters: PasswordPoliciesV2026ApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2026ApiFp(this.configuration).listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesV2026ApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesV2026Api - */ - public setPasswordPolicy(requestParameters: PasswordPoliciesV2026ApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesV2026ApiFp(this.configuration).setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3DtoV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordSyncGroupsV2026Api - axios parameter creator - * @export - */ -export const PasswordSyncGroupsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2026} passwordSyncGroupV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup: async (passwordSyncGroupV2026: PasswordSyncGroupV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordSyncGroupV2026' is not null or undefined - assertParamExists('createPasswordSyncGroup', 'passwordSyncGroupV2026', passwordSyncGroupV2026) - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2026} passwordSyncGroupV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup: async (id: string, passwordSyncGroupV2026: PasswordSyncGroupV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'id', id) - // verify required parameter 'passwordSyncGroupV2026' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'passwordSyncGroupV2026', passwordSyncGroupV2026) - const localVarPath = `/password-sync-groups/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroupV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordSyncGroupsV2026Api - functional programming interface - * @export - */ -export const PasswordSyncGroupsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordSyncGroupsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupV2026} passwordSyncGroupV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordSyncGroup(passwordSyncGroupV2026: PasswordSyncGroupV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroup(passwordSyncGroupV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2026Api.createPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2026Api.deletePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2026Api.getPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroups(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2026Api.getPasswordSyncGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroupV2026} passwordSyncGroupV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordSyncGroup(id: string, passwordSyncGroupV2026: PasswordSyncGroupV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroup(id, passwordSyncGroupV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsV2026Api.updatePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordSyncGroupsV2026Api - factory interface - * @export - */ -export const PasswordSyncGroupsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordSyncGroupsV2026ApiFp(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordSyncGroup(requestParameters.passwordSyncGroupV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsV2026Api. - * @export - * @interface PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest { - /** - * - * @type {PasswordSyncGroupV2026} - * @memberof PasswordSyncGroupsV2026ApiCreatePasswordSyncGroup - */ - readonly passwordSyncGroupV2026: PasswordSyncGroupV2026 -} - -/** - * Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsV2026Api. - * @export - * @interface PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest { - /** - * The ID of password sync group to delete. - * @type {string} - * @memberof PasswordSyncGroupsV2026ApiDeletePasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsV2026Api. - * @export - * @interface PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest { - /** - * The ID of password sync group to retrieve. - * @type {string} - * @memberof PasswordSyncGroupsV2026ApiGetPasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsV2026Api. - * @export - * @interface PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest - */ -export interface PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest { - /** - * 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 PasswordSyncGroupsV2026ApiGetPasswordSyncGroups - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordSyncGroupsV2026ApiGetPasswordSyncGroups - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordSyncGroupsV2026ApiGetPasswordSyncGroups - */ - readonly count?: boolean -} - -/** - * Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsV2026Api. - * @export - * @interface PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest { - /** - * The ID of password sync group to update. - * @type {string} - * @memberof PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroup - */ - readonly id: string - - /** - * - * @type {PasswordSyncGroupV2026} - * @memberof PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroup - */ - readonly passwordSyncGroupV2026: PasswordSyncGroupV2026 -} - -/** - * PasswordSyncGroupsV2026Api - object-oriented interface - * @export - * @class PasswordSyncGroupsV2026Api - * @extends {BaseAPI} - */ -export class PasswordSyncGroupsV2026Api extends BaseAPI { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2026Api - */ - public createPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2026ApiFp(this.configuration).createPasswordSyncGroup(requestParameters.passwordSyncGroupV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2026Api - */ - public deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2026ApiFp(this.configuration).deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2026Api - */ - public getPasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2026ApiFp(this.configuration).getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2026Api - */ - public getPasswordSyncGroups(requestParameters: PasswordSyncGroupsV2026ApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2026ApiFp(this.configuration).getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsV2026Api - */ - public updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsV2026ApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsV2026ApiFp(this.configuration).updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroupV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PersonalAccessTokensV2026Api - axios parameter creator - * @export - */ -export const PersonalAccessTokensV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2026} createPersonalAccessTokenRequestV2026 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken: async (createPersonalAccessTokenRequestV2026: CreatePersonalAccessTokenRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPersonalAccessTokenRequestV2026' is not null or undefined - assertParamExists('createPersonalAccessToken', 'createPersonalAccessTokenRequestV2026', createPersonalAccessTokenRequestV2026) - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPersonalAccessTokenRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePersonalAccessToken', 'id', id) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2026 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PersonalAccessTokensV2026Api - functional programming interface - * @export - */ -export const PersonalAccessTokensV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PersonalAccessTokensV2026ApiAxiosParamCreator(configuration) - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequestV2026} createPersonalAccessTokenRequestV2026 Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPersonalAccessToken(createPersonalAccessTokenRequestV2026: CreatePersonalAccessTokenRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessToken(createPersonalAccessTokenRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2026Api.createPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePersonalAccessToken(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessToken(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2026Api.deletePersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokens(ownerId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2026Api.listPersonalAccessTokens']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperationV2026 A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPersonalAccessToken(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessToken(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensV2026Api.patchPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PersonalAccessTokensV2026Api - factory interface - * @export - */ -export const PersonalAccessTokensV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PersonalAccessTokensV2026ApiFp(configuration) - return { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPersonalAccessToken operation in PersonalAccessTokensV2026Api. - * @export - * @interface PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest { - /** - * Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @type {CreatePersonalAccessTokenRequestV2026} - * @memberof PersonalAccessTokensV2026ApiCreatePersonalAccessToken - */ - readonly createPersonalAccessTokenRequestV2026: CreatePersonalAccessTokenRequestV2026 -} - -/** - * Request parameters for deletePersonalAccessToken operation in PersonalAccessTokensV2026Api. - * @export - * @interface PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest { - /** - * The personal access token id - * @type {string} - * @memberof PersonalAccessTokensV2026ApiDeletePersonalAccessToken - */ - readonly id: string -} - -/** - * Request parameters for listPersonalAccessTokens operation in PersonalAccessTokensV2026Api. - * @export - * @interface PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest - */ -export interface PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest { - /** - * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @type {string} - * @memberof PersonalAccessTokensV2026ApiListPersonalAccessTokens - */ - readonly ownerId?: 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof PersonalAccessTokensV2026ApiListPersonalAccessTokens - */ - readonly filters?: string -} - -/** - * Request parameters for patchPersonalAccessToken operation in PersonalAccessTokensV2026Api. - * @export - * @interface PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest - */ -export interface PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest { - /** - * The Personal Access Token id - * @type {string} - * @memberof PersonalAccessTokensV2026ApiPatchPersonalAccessToken - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. - * @type {Array} - * @memberof PersonalAccessTokensV2026ApiPatchPersonalAccessToken - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * PersonalAccessTokensV2026Api - object-oriented interface - * @export - * @class PersonalAccessTokensV2026Api - * @extends {BaseAPI} - */ -export class PersonalAccessTokensV2026Api extends BaseAPI { - /** - * This creates a personal access token. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Create personal access token - * @param {PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2026Api - */ - public createPersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2026ApiFp(this.configuration).createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2026Api - */ - public deletePersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2026ApiFp(this.configuration).deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2026Api - */ - public listPersonalAccessTokens(requestParameters: PersonalAccessTokensV2026ApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2026ApiFp(this.configuration).listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. **expirationDate and userAwareTokenNeverExpires Relationship:** **Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. **Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: * **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. **Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. **Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. **Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. - * @summary Patch personal access token - * @param {PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensV2026Api - */ - public patchPersonalAccessToken(requestParameters: PersonalAccessTokensV2026ApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensV2026ApiFp(this.configuration).patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PrivilegeCriteriaV2026Api - axios parameter creator - * @export - */ -export const PrivilegeCriteriaV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {CreatePrivilegeCriteriaRequestV2026} createPrivilegeCriteriaRequestV2026 Create custom privilege criteria request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPrivilegeCriteria: async (createPrivilegeCriteriaRequestV2026: CreatePrivilegeCriteriaRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPrivilegeCriteriaRequestV2026' is not null or undefined - assertParamExists('createCustomPrivilegeCriteria', 'createPrivilegeCriteriaRequestV2026', createPrivilegeCriteriaRequestV2026) - const localVarPath = `/criteria/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPrivilegeCriteriaRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {string} criteriaId The Id of the custom privilege criteria to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPrivilegeCriteria: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('deleteCustomPrivilegeCriteria', 'criteriaId', criteriaId) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteria: async (criteriaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('getPrivilegeCriteria', 'criteriaId', criteriaId) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteria: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listPrivilegeCriteria', 'filters', filters) - const localVarPath = `/criteria/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {PrivilegeCriteriaDTOV2026} privilegeCriteriaDTOV2026 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCustomPrivilegeCriteriaValue: async (criteriaId: string, privilegeCriteriaDTOV2026: PrivilegeCriteriaDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaId' is not null or undefined - assertParamExists('putCustomPrivilegeCriteriaValue', 'criteriaId', criteriaId) - // verify required parameter 'privilegeCriteriaDTOV2026' is not null or undefined - assertParamExists('putCustomPrivilegeCriteriaValue', 'privilegeCriteriaDTOV2026', privilegeCriteriaDTOV2026) - const localVarPath = `/criteria/privilege/{criteriaId}` - .replace(`{${"criteriaId"}}`, encodeURIComponent(String(criteriaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(privilegeCriteriaDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PrivilegeCriteriaV2026Api - functional programming interface - * @export - */ -export const PrivilegeCriteriaV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PrivilegeCriteriaV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {CreatePrivilegeCriteriaRequestV2026} createPrivilegeCriteriaRequestV2026 Create custom privilege criteria request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomPrivilegeCriteria(createPrivilegeCriteriaRequestV2026: CreatePrivilegeCriteriaRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomPrivilegeCriteria(createPrivilegeCriteriaRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2026Api.createCustomPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {string} criteriaId The Id of the custom privilege criteria to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomPrivilegeCriteria(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomPrivilegeCriteria(criteriaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2026Api.deleteCustomPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPrivilegeCriteria(criteriaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteria(criteriaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2026Api.getPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPrivilegeCriteria(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteria(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2026Api.listPrivilegeCriteria']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {string} criteriaId The Id of the privilege criteria record to return. - * @param {PrivilegeCriteriaDTOV2026} privilegeCriteriaDTOV2026 The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCustomPrivilegeCriteriaValue(criteriaId: string, privilegeCriteriaDTOV2026: PrivilegeCriteriaDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCustomPrivilegeCriteriaValue(criteriaId, privilegeCriteriaDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaV2026Api.putCustomPrivilegeCriteriaValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PrivilegeCriteriaV2026Api - factory interface - * @export - */ -export const PrivilegeCriteriaV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PrivilegeCriteriaV2026ApiFp(configuration) - return { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomPrivilegeCriteria(requestParameters.createPrivilegeCriteriaRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @param {PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPrivilegeCriteria(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCustomPrivilegeCriteriaValue(requestParameters: PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCustomPrivilegeCriteriaValue(requestParameters.criteriaId, requestParameters.privilegeCriteriaDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomPrivilegeCriteria operation in PrivilegeCriteriaV2026Api. - * @export - * @interface PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest { - /** - * Create custom privilege criteria request body. - * @type {CreatePrivilegeCriteriaRequestV2026} - * @memberof PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteria - */ - readonly createPrivilegeCriteriaRequestV2026: CreatePrivilegeCriteriaRequestV2026 -} - -/** - * Request parameters for deleteCustomPrivilegeCriteria operation in PrivilegeCriteriaV2026Api. - * @export - * @interface PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest { - /** - * The Id of the custom privilege criteria to delete. - * @type {string} - * @memberof PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteria - */ - readonly criteriaId: string -} - -/** - * Request parameters for getPrivilegeCriteria operation in PrivilegeCriteriaV2026Api. - * @export - * @interface PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest { - /** - * The Id of the privilege criteria record to return. - * @type {string} - * @memberof PrivilegeCriteriaV2026ApiGetPrivilegeCriteria - */ - readonly criteriaId: string -} - -/** - * Request parameters for listPrivilegeCriteria operation in PrivilegeCriteriaV2026Api. - * @export - * @interface PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest - */ -export interface PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest { - /** - * 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: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @type {string} - * @memberof PrivilegeCriteriaV2026ApiListPrivilegeCriteria - */ - readonly filters: string -} - -/** - * Request parameters for putCustomPrivilegeCriteriaValue operation in PrivilegeCriteriaV2026Api. - * @export - * @interface PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest - */ -export interface PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest { - /** - * The Id of the privilege criteria record to return. - * @type {string} - * @memberof PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValue - */ - readonly criteriaId: string - - /** - * The new version of the custom privilege criteria. This overwrites the existing privilege criteria. - * @type {PrivilegeCriteriaDTOV2026} - * @memberof PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValue - */ - readonly privilegeCriteriaDTOV2026: PrivilegeCriteriaDTOV2026 -} - -/** - * PrivilegeCriteriaV2026Api - object-oriented interface - * @export - * @class PrivilegeCriteriaV2026Api - * @extends {BaseAPI} - */ -export class PrivilegeCriteriaV2026Api extends BaseAPI { - /** - * Use this API to create a custom privilege criteria - * @summary Create custom privilege criteria - * @param {PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2026Api - */ - public createCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiCreateCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2026ApiFp(this.configuration).createCustomPrivilegeCriteria(requestParameters.createPrivilegeCriteriaRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific custom privilege criteria. - * @summary Delete privilege criteria - * @param {PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2026Api - */ - public deleteCustomPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiDeleteCustomPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2026ApiFp(this.configuration).deleteCustomPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a specific privilege criteria. - * @summary Get privilege criteria - * @param {PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2026Api - */ - public getPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiGetPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2026ApiFp(this.configuration).getPrivilegeCriteria(requestParameters.criteriaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all privilege criteria matching a filter - * @summary List privilege criteria - * @param {PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2026Api - */ - public listPrivilegeCriteria(requestParameters: PrivilegeCriteriaV2026ApiListPrivilegeCriteriaRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2026ApiFp(this.configuration).listPrivilegeCriteria(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a specific custom privilege criteria by overwriting the information with new information. - * @summary Update privilege criteria - * @param {PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaV2026Api - */ - public putCustomPrivilegeCriteriaValue(requestParameters: PrivilegeCriteriaV2026ApiPutCustomPrivilegeCriteriaValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaV2026ApiFp(this.configuration).putCustomPrivilegeCriteriaValue(requestParameters.criteriaId, requestParameters.privilegeCriteriaDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PrivilegeCriteriaConfigurationV2026Api - axios parameter creator - * @export - */ -export const PrivilegeCriteriaConfigurationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteriaConfig: async (criteriaConfigId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaConfigId' is not null or undefined - assertParamExists('getPrivilegeCriteriaConfig', 'criteriaConfigId', criteriaConfigId) - const localVarPath = `/criteria-config/privilege/{criteriaConfigId}` - .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteriaConfig: async (filters: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filters' is not null or undefined - assertParamExists('listPrivilegeCriteriaConfig', 'filters', filters) - const localVarPath = `/criteria-config/privilege`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. - * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPrivilegeCriteriaConfig: async (criteriaConfigId: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'criteriaConfigId' is not null or undefined - assertParamExists('patchPrivilegeCriteriaConfig', 'criteriaConfigId', criteriaConfigId) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchPrivilegeCriteriaConfig', 'requestBody', requestBody) - const localVarPath = `/criteria-config/privilege/{criteriaConfigId}` - .replace(`{${"criteriaConfigId"}}`, encodeURIComponent(String(criteriaConfigId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PrivilegeCriteriaConfigurationV2026Api - functional programming interface - * @export - */ -export const PrivilegeCriteriaConfigurationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PrivilegeCriteriaConfigurationV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {string} criteriaConfigId The Id of the privilege criteria configuration record to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPrivilegeCriteriaConfig(criteriaConfigId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPrivilegeCriteriaConfig(criteriaConfigId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2026Api.getPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPrivilegeCriteriaConfig(filters: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegeCriteriaConfig(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2026Api.listPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {string} criteriaConfigId The Id of the privilege criteria configuration to update. - * @param {Array} requestBody A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPrivilegeCriteriaConfig(criteriaConfigId: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPrivilegeCriteriaConfig(criteriaConfigId, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PrivilegeCriteriaConfigurationV2026Api.patchPrivilegeCriteriaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PrivilegeCriteriaConfigurationV2026Api - factory interface - * @export - */ -export const PrivilegeCriteriaConfigurationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PrivilegeCriteriaConfigurationV2026ApiFp(configuration) - return { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPrivilegeCriteriaConfig(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2026Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest { - /** - * The Id of the privilege criteria configuration record to retrieve. - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfig - */ - readonly criteriaConfigId: string -} - -/** - * Request parameters for listPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2026Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest { - /** - * 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: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfig - */ - readonly filters: string -} - -/** - * Request parameters for patchPrivilegeCriteriaConfig operation in PrivilegeCriteriaConfigurationV2026Api. - * @export - * @interface PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest - */ -export interface PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest { - /** - * The Id of the privilege criteria configuration to update. - * @type {string} - * @memberof PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfig - */ - readonly criteriaConfigId: string - - /** - * A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfig - */ - readonly requestBody: Array -} - -/** - * PrivilegeCriteriaConfigurationV2026Api - object-oriented interface - * @export - * @class PrivilegeCriteriaConfigurationV2026Api - * @extends {BaseAPI} - */ -export class PrivilegeCriteriaConfigurationV2026Api extends BaseAPI { - /** - * Use this API to get the privilege criteria configuration by Id. - * @summary Get privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2026Api - */ - public getPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiGetPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2026ApiFp(this.configuration).getPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the privilege criteria configuration. - * @summary List privilege criteria config - * @param {PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2026Api - */ - public listPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiListPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2026ApiFp(this.configuration).listPrivilegeCriteriaConfig(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update the privilege criteria configuration. - * @summary Update privilege criteria configuration - * @param {PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PrivilegeCriteriaConfigurationV2026Api - */ - public patchPrivilegeCriteriaConfig(requestParameters: PrivilegeCriteriaConfigurationV2026ApiPatchPrivilegeCriteriaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PrivilegeCriteriaConfigurationV2026ApiFp(this.configuration).patchPrivilegeCriteriaConfig(requestParameters.criteriaConfigId, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PromptInsightsV2026Api - axios parameter creator - * @export - */ -export const PromptInsightsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns aggregate prompt insights metrics for the requested time window. - * @summary Get prompt insights metrics - * @param {GetPromptInsightsMetricsIntervalV2026} interval Relative lookback window for metrics aggregation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPromptInsightsMetrics: async (interval: GetPromptInsightsMetricsIntervalV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'interval' is not null or undefined - assertParamExists('getPromptInsightsMetrics', 'interval', interval) - const localVarPath = `/prompt-insights/metrics`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). - * @summary List prompt insights - * @param {ListPromptInsightsIntervalV2026} interval Relative lookback window for prompt insights. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPromptInsights: async (interval: ListPromptInsightsIntervalV2026, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'interval' is not null or undefined - assertParamExists('listPromptInsights', 'interval', interval) - const localVarPath = `/prompt-insights`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (interval !== undefined) { - localVarQueryParameter['interval'] = interval; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - } -}; - -/** - * PromptInsightsV2026Api - functional programming interface - * @export - */ -export const PromptInsightsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PromptInsightsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Returns aggregate prompt insights metrics for the requested time window. - * @summary Get prompt insights metrics - * @param {GetPromptInsightsMetricsIntervalV2026} interval Relative lookback window for metrics aggregation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPromptInsightsMetrics(interval: GetPromptInsightsMetricsIntervalV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPromptInsightsMetrics(interval, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PromptInsightsV2026Api.getPromptInsightsMetrics']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). - * @summary List prompt insights - * @param {ListPromptInsightsIntervalV2026} interval Relative lookback window for prompt insights. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPromptInsights(interval: ListPromptInsightsIntervalV2026, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPromptInsights(interval, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PromptInsightsV2026Api.listPromptInsights']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PromptInsightsV2026Api - factory interface - * @export - */ -export const PromptInsightsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PromptInsightsV2026ApiFp(configuration) - return { - /** - * Returns aggregate prompt insights metrics for the requested time window. - * @summary Get prompt insights metrics - * @param {PromptInsightsV2026ApiGetPromptInsightsMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPromptInsightsMetrics(requestParameters: PromptInsightsV2026ApiGetPromptInsightsMetricsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPromptInsightsMetrics(requestParameters.interval, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). - * @summary List prompt insights - * @param {PromptInsightsV2026ApiListPromptInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPromptInsights(requestParameters: PromptInsightsV2026ApiListPromptInsightsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPromptInsights(requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPromptInsightsMetrics operation in PromptInsightsV2026Api. - * @export - * @interface PromptInsightsV2026ApiGetPromptInsightsMetricsRequest - */ -export interface PromptInsightsV2026ApiGetPromptInsightsMetricsRequest { - /** - * Relative lookback window for metrics aggregation. - * @type {'-1h' | '-1d' | '-7d' | '-30d'} - * @memberof PromptInsightsV2026ApiGetPromptInsightsMetrics - */ - readonly interval: GetPromptInsightsMetricsIntervalV2026 -} - -/** - * Request parameters for listPromptInsights operation in PromptInsightsV2026Api. - * @export - * @interface PromptInsightsV2026ApiListPromptInsightsRequest - */ -export interface PromptInsightsV2026ApiListPromptInsightsRequest { - /** - * Relative lookback window for prompt insights. - * @type {'-1h' | '-1d' | '-7d' | '-30d'} - * @memberof PromptInsightsV2026ApiListPromptInsights - */ - readonly interval: ListPromptInsightsIntervalV2026 - - /** - * 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 PromptInsightsV2026ApiListPromptInsights - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PromptInsightsV2026ApiListPromptInsights - */ - readonly offset?: number - - /** - * 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: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* - * @type {string} - * @memberof PromptInsightsV2026ApiListPromptInsights - */ - readonly filters?: string -} - -/** - * PromptInsightsV2026Api - object-oriented interface - * @export - * @class PromptInsightsV2026Api - * @extends {BaseAPI} - */ -export class PromptInsightsV2026Api extends BaseAPI { - /** - * Returns aggregate prompt insights metrics for the requested time window. - * @summary Get prompt insights metrics - * @param {PromptInsightsV2026ApiGetPromptInsightsMetricsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PromptInsightsV2026Api - */ - public getPromptInsightsMetrics(requestParameters: PromptInsightsV2026ApiGetPromptInsightsMetricsRequest, axiosOptions?: RawAxiosRequestConfig) { - return PromptInsightsV2026ApiFp(this.configuration).getPromptInsightsMetrics(requestParameters.interval, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). - * @summary List prompt insights - * @param {PromptInsightsV2026ApiListPromptInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PromptInsightsV2026Api - */ - public listPromptInsights(requestParameters: PromptInsightsV2026ApiListPromptInsightsRequest, axiosOptions?: RawAxiosRequestConfig) { - return PromptInsightsV2026ApiFp(this.configuration).listPromptInsights(requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetPromptInsightsMetricsIntervalV2026 = { - _1h: '-1h', - _1d: '-1d', - _7d: '-7d', - _30d: '-30d' -} as const; -export type GetPromptInsightsMetricsIntervalV2026 = typeof GetPromptInsightsMetricsIntervalV2026[keyof typeof GetPromptInsightsMetricsIntervalV2026]; -/** - * @export - */ -export const ListPromptInsightsIntervalV2026 = { - _1h: '-1h', - _1d: '-1d', - _7d: '-7d', - _30d: '-30d' -} as const; -export type ListPromptInsightsIntervalV2026 = typeof ListPromptInsightsIntervalV2026[keyof typeof ListPromptInsightsIntervalV2026]; - - -/** - * PublicIdentitiesV2026Api - axios parameter creator - * @export - */ -export const PublicIdentitiesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities: async (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (addCoreFilters !== undefined) { - localVarQueryParameter['add-core-filters'] = addCoreFilters; - } - - 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, - }; - }, - } -}; - -/** - * PublicIdentitiesV2026Api - functional programming interface - * @export - */ -export const PublicIdentitiesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesV2026ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentities(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentities(limit, offset, count, filters, addCoreFilters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesV2026Api.getPublicIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesV2026Api - factory interface - * @export - */ -export const PublicIdentitiesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesV2026ApiFp(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2026ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities(requestParameters: PublicIdentitiesV2026ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPublicIdentities operation in PublicIdentitiesV2026Api. - * @export - * @interface PublicIdentitiesV2026ApiGetPublicIdentitiesRequest - */ -export interface PublicIdentitiesV2026ApiGetPublicIdentitiesRequest { - /** - * 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 PublicIdentitiesV2026ApiGetPublicIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PublicIdentitiesV2026ApiGetPublicIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PublicIdentitiesV2026ApiGetPublicIdentities - */ - 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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @type {string} - * @memberof PublicIdentitiesV2026ApiGetPublicIdentities - */ - readonly filters?: string - - /** - * If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @type {boolean} - * @memberof PublicIdentitiesV2026ApiGetPublicIdentities - */ - readonly addCoreFilters?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof PublicIdentitiesV2026ApiGetPublicIdentities - */ - readonly sorters?: string -} - -/** - * PublicIdentitiesV2026Api - object-oriented interface - * @export - * @class PublicIdentitiesV2026Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesV2026Api extends BaseAPI { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesV2026ApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesV2026Api - */ - public getPublicIdentities(requestParameters: PublicIdentitiesV2026ApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesV2026ApiFp(this.configuration).getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesConfigV2026Api - axios parameter creator - * @export - */ -export const PublicIdentitiesConfigV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2026} publicIdentityConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig: async (publicIdentityConfigV2026: PublicIdentityConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'publicIdentityConfigV2026' is not null or undefined - assertParamExists('updatePublicIdentityConfig', 'publicIdentityConfigV2026', publicIdentityConfigV2026) - const localVarPath = `/public-identities-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(publicIdentityConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PublicIdentitiesConfigV2026Api - functional programming interface - * @export - */ -export const PublicIdentitiesConfigV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesConfigV2026ApiAxiosParamCreator(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2026Api.getPublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfigV2026} publicIdentityConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePublicIdentityConfig(publicIdentityConfigV2026: PublicIdentityConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfig(publicIdentityConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigV2026Api.updatePublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesConfigV2026Api - factory interface - * @export - */ -export const PublicIdentitiesConfigV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesConfigV2026ApiFp(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPublicIdentityConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updatePublicIdentityConfig operation in PublicIdentitiesConfigV2026Api. - * @export - * @interface PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest - */ -export interface PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest { - /** - * - * @type {PublicIdentityConfigV2026} - * @memberof PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfig - */ - readonly publicIdentityConfigV2026: PublicIdentityConfigV2026 -} - -/** - * PublicIdentitiesConfigV2026Api - object-oriented interface - * @export - * @class PublicIdentitiesConfigV2026Api - * @extends {BaseAPI} - */ -export class PublicIdentitiesConfigV2026Api extends BaseAPI { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2026Api - */ - public getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2026ApiFp(this.configuration).getPublicIdentityConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigV2026Api - */ - public updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigV2026ApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigV2026ApiFp(this.configuration).updatePublicIdentityConfig(requestParameters.publicIdentityConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ReportsDataExtractionV2026Api - axios parameter creator - * @export - */ -export const ReportsDataExtractionV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelReport', 'id', id) - const localVarPath = `/reports/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2026} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport: async (taskResultId: string, fileFormat: GetReportFileFormatV2026, name?: string, auditable?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReport', 'taskResultId', taskResultId) - // verify required parameter 'fileFormat' is not null or undefined - assertParamExists('getReport', 'fileFormat', fileFormat) - const localVarPath = `/reports/{taskResultId}` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (fileFormat !== undefined) { - localVarQueryParameter['fileFormat'] = fileFormat; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (auditable !== undefined) { - localVarQueryParameter['auditable'] = auditable; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult: async (taskResultId: string, completed?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReportResult', 'taskResultId', taskResultId) - const localVarPath = `/reports/{taskResultId}/result` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (completed !== undefined) { - localVarQueryParameter['completed'] = completed; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2026} reportDetailsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport: async (reportDetailsV2026: ReportDetailsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportDetailsV2026' is not null or undefined - assertParamExists('startReport', 'reportDetailsV2026', reportDetailsV2026) - const localVarPath = `/reports/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reportDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ReportsDataExtractionV2026Api - functional programming interface - * @export - */ -export const ReportsDataExtractionV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ReportsDataExtractionV2026ApiAxiosParamCreator(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelReport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2026Api.cancelReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV2026} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReport(taskResultId: string, fileFormat: GetReportFileFormatV2026, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(taskResultId, fileFormat, name, auditable, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2026Api.getReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReportResult(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReportResult(taskResultId, completed, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2026Api.getReportResult']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetailsV2026} reportDetailsV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startReport(reportDetailsV2026: ReportDetailsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startReport(reportDetailsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionV2026Api.startReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ReportsDataExtractionV2026Api - factory interface - * @export - */ -export const ReportsDataExtractionV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ReportsDataExtractionV2026ApiFp(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2026ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport(requestParameters: ReportsDataExtractionV2026ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelReport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2026ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport(requestParameters: ReportsDataExtractionV2026ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2026ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult(requestParameters: ReportsDataExtractionV2026ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2026ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport(requestParameters: ReportsDataExtractionV2026ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startReport(requestParameters.reportDetailsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelReport operation in ReportsDataExtractionV2026Api. - * @export - * @interface ReportsDataExtractionV2026ApiCancelReportRequest - */ -export interface ReportsDataExtractionV2026ApiCancelReportRequest { - /** - * ID of the running Report to cancel - * @type {string} - * @memberof ReportsDataExtractionV2026ApiCancelReport - */ - readonly id: string -} - -/** - * Request parameters for getReport operation in ReportsDataExtractionV2026Api. - * @export - * @interface ReportsDataExtractionV2026ApiGetReportRequest - */ -export interface ReportsDataExtractionV2026ApiGetReportRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2026ApiGetReport - */ - readonly taskResultId: string - - /** - * Output format of the requested report file - * @type {'csv' | 'pdf'} - * @memberof ReportsDataExtractionV2026ApiGetReport - */ - readonly fileFormat: GetReportFileFormatV2026 - - /** - * preferred Report file name, by default will be used report name from task result. - * @type {string} - * @memberof ReportsDataExtractionV2026ApiGetReport - */ - readonly name?: string - - /** - * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @type {boolean} - * @memberof ReportsDataExtractionV2026ApiGetReport - */ - readonly auditable?: boolean -} - -/** - * Request parameters for getReportResult operation in ReportsDataExtractionV2026Api. - * @export - * @interface ReportsDataExtractionV2026ApiGetReportResultRequest - */ -export interface ReportsDataExtractionV2026ApiGetReportResultRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionV2026ApiGetReportResult - */ - readonly taskResultId: string - - /** - * state of task result to apply ordering when results are fetching from the DB - * @type {boolean} - * @memberof ReportsDataExtractionV2026ApiGetReportResult - */ - readonly completed?: boolean -} - -/** - * Request parameters for startReport operation in ReportsDataExtractionV2026Api. - * @export - * @interface ReportsDataExtractionV2026ApiStartReportRequest - */ -export interface ReportsDataExtractionV2026ApiStartReportRequest { - /** - * - * @type {ReportDetailsV2026} - * @memberof ReportsDataExtractionV2026ApiStartReport - */ - readonly reportDetailsV2026: ReportDetailsV2026 -} - -/** - * ReportsDataExtractionV2026Api - object-oriented interface - * @export - * @class ReportsDataExtractionV2026Api - * @extends {BaseAPI} - */ -export class ReportsDataExtractionV2026Api extends BaseAPI { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionV2026ApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2026Api - */ - public cancelReport(requestParameters: ReportsDataExtractionV2026ApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2026ApiFp(this.configuration).cancelReport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionV2026ApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2026Api - */ - public getReport(requestParameters: ReportsDataExtractionV2026ApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2026ApiFp(this.configuration).getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionV2026ApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2026Api - */ - public getReportResult(requestParameters: ReportsDataExtractionV2026ApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2026ApiFp(this.configuration).getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionV2026ApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionV2026Api - */ - public startReport(requestParameters: ReportsDataExtractionV2026ApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionV2026ApiFp(this.configuration).startReport(requestParameters.reportDetailsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetReportFileFormatV2026 = { - Csv: 'csv', - Pdf: 'pdf' -} as const; -export type GetReportFileFormatV2026 = typeof GetReportFileFormatV2026[keyof typeof GetReportFileFormatV2026]; - - -/** - * RequestableObjectsV2026Api - axios parameter creator - * @export - */ -export const RequestableObjectsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/requestable-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (types) { - localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); - } - - if (term !== undefined) { - localVarQueryParameter['term'] = term; - } - - if (statuses) { - localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * RequestableObjectsV2026Api - functional programming interface - * @export - */ -export const RequestableObjectsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RequestableObjectsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRequestableObjects(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjects(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RequestableObjectsV2026Api.listRequestableObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RequestableObjectsV2026Api - factory interface - * @export - */ -export const RequestableObjectsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RequestableObjectsV2026ApiFp(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2026ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects(requestParameters: RequestableObjectsV2026ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listRequestableObjects operation in RequestableObjectsV2026Api. - * @export - * @interface RequestableObjectsV2026ApiListRequestableObjectsRequest - */ -export interface RequestableObjectsV2026ApiListRequestableObjectsRequest { - /** - * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @type {string} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly identityId?: string - - /** - * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly types?: Array - - /** - * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @type {string} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly term?: string - - /** - * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @type {Array} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly statuses?: Array - - /** - * 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 RequestableObjectsV2026ApiListRequestableObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - 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: **name** - * @type {string} - * @memberof RequestableObjectsV2026ApiListRequestableObjects - */ - readonly sorters?: string -} - -/** - * RequestableObjectsV2026Api - object-oriented interface - * @export - * @class RequestableObjectsV2026Api - * @extends {BaseAPI} - */ -export class RequestableObjectsV2026Api extends BaseAPI { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsV2026ApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RequestableObjectsV2026Api - */ - public listRequestableObjects(requestParameters: RequestableObjectsV2026ApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RequestableObjectsV2026ApiFp(this.configuration).listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListRequestableObjectsTypesV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type ListRequestableObjectsTypesV2026 = typeof ListRequestableObjectsTypesV2026[keyof typeof ListRequestableObjectsTypesV2026]; - - -/** - * RoleInsightsV2026Api - axios parameter creator - * @export - */ -export const RoleInsightsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('downloadRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/download` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities: async (insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'insightId', insightId) - // verify required parameter 'entitlementId' is not null or undefined - assertParamExists('getEntitlementChangesIdentities', 'entitlementId', entitlementId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))) - .replace(`{${"entitlementId"}}`, encodeURIComponent(String(entitlementId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (hasEntitlement !== undefined) { - localVarQueryParameter['hasEntitlement'] = hasEntitlement; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight: async (insightId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsight', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights: async (offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements: async (insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsCurrentEntitlements', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/current-entitlements` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges: async (insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'insightId' is not null or undefined - assertParamExists('getRoleInsightsEntitlementsChanges', 'insightId', insightId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/{insightId}/entitlement-changes` - .replace(`{${"insightId"}}`, encodeURIComponent(String(insightId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleInsightsRequests', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-insights/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RoleInsightsV2026Api - functional programming interface - * @export - */ -export const RoleInsightsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RoleInsightsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async createRoleInsightRequests(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleInsightRequests(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.createRoleInsightRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async downloadRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.downloadRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {string} insightId The role insight id - * @param {string} entitlementId The entitlement id - * @param {boolean} [hasEntitlement] Identity has this entitlement or not - * @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} [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: **name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementChangesIdentities(insightId: string, entitlementId: string, hasEntitlement?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementChangesIdentities(insightId, entitlementId, hasEntitlement, offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getEntitlementChangesIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {string} insightId The role insight id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsight(insightId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsight(insightId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsight']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @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} [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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsights(offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsights(offset, limit, count, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsights']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {string} insightId The role insight id - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsCurrentEntitlements(insightId: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsCurrentEntitlements(insightId, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsightsCurrentEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {string} insightId The role insight id - * @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: **identitiesWithAccess, name** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsEntitlementsChanges(insightId: string, sorters?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsEntitlementsChanges(insightId, sorters, filters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsightsEntitlementsChanges']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {string} id The role insights request id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getRoleInsightsRequests(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsRequests(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsightsRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleInsightsSummary(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleInsightsSummary(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RoleInsightsV2026Api.getRoleInsightsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RoleInsightsV2026Api - factory interface - * @export - */ -export const RoleInsightsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RoleInsightsV2026ApiFp(configuration) - return { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2026ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - createRoleInsightRequests(requestParameters: RoleInsightsV2026ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementChangesIdentities(requestParameters: RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2026ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsight(requestParameters: RoleInsightsV2026ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2026ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsights(requestParameters: RoleInsightsV2026ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2026ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getRoleInsightsRequests(requestParameters: RoleInsightsV2026ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2026ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleInsightsSummary(requestParameters: RoleInsightsV2026ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRoleInsightRequests operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiCreateRoleInsightRequestsRequest - */ -export interface RoleInsightsV2026ApiCreateRoleInsightRequestsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiCreateRoleInsightRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for downloadRoleInsightsEntitlementsChanges operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - * @type {string} - * @memberof RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEntitlementChangesIdentities operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest - */ -export interface RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly insightId: string - - /** - * The entitlement id - * @type {string} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly entitlementId: string - - /** - * Identity has this entitlement or not - * @type {boolean} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly hasEntitlement?: boolean - - /** - * 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 RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - 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 RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly count?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly sorters?: 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: **name**: *sw* - * @type {string} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetEntitlementChangesIdentities - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsight operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsight - */ - readonly insightId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsight - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsights operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightsRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightsRequest { - /** - * 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 RoleInsightsV2026ApiGetRoleInsights - */ - 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 RoleInsightsV2026ApiGetRoleInsights - */ - 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 RoleInsightsV2026ApiGetRoleInsights - */ - readonly count?: boolean - - /** - * 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: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsights - */ - readonly sorters?: 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsights - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsights - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsCurrentEntitlements operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlements - */ - readonly insightId: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlements - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsEntitlementsChanges operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest { - /** - * The role insight id - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsEntitlementsChanges - */ - readonly insightId: 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: **identitiesWithAccess, name** - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsEntitlementsChanges - */ - readonly sorters?: 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: **name**: *sw* **description**: *sw* - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsEntitlementsChanges - */ - readonly filters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsEntitlementsChanges - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsRequests operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightsRequestsRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightsRequestsRequest { - /** - * The role insights request id - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsRequests - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsRequests - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRoleInsightsSummary operation in RoleInsightsV2026Api. - * @export - * @interface RoleInsightsV2026ApiGetRoleInsightsSummaryRequest - */ -export interface RoleInsightsV2026ApiGetRoleInsightsSummaryRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RoleInsightsV2026ApiGetRoleInsightsSummary - */ - readonly xSailPointExperimental?: string -} - -/** - * RoleInsightsV2026Api - object-oriented interface - * @export - * @class RoleInsightsV2026Api - * @extends {BaseAPI} - */ -export class RoleInsightsV2026Api extends BaseAPI { - /** - * Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - * @summary Generate insights for roles - * @param {RoleInsightsV2026ApiCreateRoleInsightRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public createRoleInsightRequests(requestParameters: RoleInsightsV2026ApiCreateRoleInsightRequestsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).createRoleInsightRequests(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the entitlement insights for a role. - * @summary Download entitlement insights for a role - * @param {RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public downloadRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2026ApiDownloadRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).downloadRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - * @summary Get identities for a suggested entitlement (for a role) - * @param {RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getEntitlementChangesIdentities(requestParameters: RoleInsightsV2026ApiGetEntitlementChangesIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getEntitlementChangesIdentities(requestParameters.insightId, requestParameters.entitlementId, requestParameters.hasEntitlement, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets role insights information for a role. - * @summary Get a single role insight - * @param {RoleInsightsV2026ApiGetRoleInsightRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsight(requestParameters: RoleInsightsV2026ApiGetRoleInsightRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsight(requestParameters.insightId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns detailed role insights for each role. - * @summary Get role insights - * @param {RoleInsightsV2026ApiGetRoleInsightsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsights(requestParameters: RoleInsightsV2026ApiGetRoleInsightsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsights(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the entitlements for a role. The term \"current\" is to distinguish from the entitlement(s) an insight might recommend adding. - * @summary Get current entitlement for a role - * @param {RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsightsCurrentEntitlements(requestParameters: RoleInsightsV2026ApiGetRoleInsightsCurrentEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsightsCurrentEntitlements(requestParameters.insightId, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns entitlement insights for a role. - * @summary Get entitlement insights for a role - * @param {RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsightsEntitlementsChanges(requestParameters: RoleInsightsV2026ApiGetRoleInsightsEntitlementsChangesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsightsEntitlementsChanges(requestParameters.insightId, requestParameters.sorters, requestParameters.filters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns details of a prior role insights request. - * @summary Returns metadata from prior request. - * @param {RoleInsightsV2026ApiGetRoleInsightsRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsightsRequests(requestParameters: RoleInsightsV2026ApiGetRoleInsightsRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsightsRequests(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This method returns high level summary information for role insights for a customer. - * @summary Get role insights summary information - * @param {RoleInsightsV2026ApiGetRoleInsightsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RoleInsightsV2026Api - */ - public getRoleInsightsSummary(requestParameters: RoleInsightsV2026ApiGetRoleInsightsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RoleInsightsV2026ApiFp(this.configuration).getRoleInsightsSummary(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolePropagationV2026Api - axios parameter creator - * @export - */ -export const RolePropagationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelRolePropagation: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/terminate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOngoingRolePropagation: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/is-running`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationConfig: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationStatus: async (rolePropagationId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'rolePropagationId' is not null or undefined - assertParamExists('getRolePropagationStatus', 'rolePropagationId', rolePropagationId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation/{rolePropagationId}/status` - .replace(`{${"rolePropagationId"}}`, encodeURIComponent(String(rolePropagationId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationConfigInputV2026} rolePropagationConfigInputV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setRolePropagationConfig: async (rolePropagationConfigInputV2026: RolePropagationConfigInputV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'rolePropagationConfigInputV2026' is not null or undefined - assertParamExists('setRolePropagationConfig', 'rolePropagationConfigInputV2026', rolePropagationConfigInputV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(rolePropagationConfigInputV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startRolePropagation: async (skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/role-propagation`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (skipRoleRefresh !== undefined) { - localVarQueryParameter['skipRoleRefresh'] = skipRoleRefresh; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolePropagationV2026Api - functional programming interface - * @export - */ -export const RolePropagationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolePropagationV2026ApiAxiosParamCreator(configuration) - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelRolePropagation(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRolePropagation(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.cancelRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOngoingRolePropagation(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOngoingRolePropagation(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.getOngoingRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRolePropagationConfig(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationConfig(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.getRolePropagationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {string} rolePropagationId The ID of the role propagation process to retrieve the status for. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRolePropagationStatus(rolePropagationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePropagationStatus(rolePropagationId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.getRolePropagationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationConfigInputV2026} rolePropagationConfigInputV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setRolePropagationConfig(rolePropagationConfigInputV2026: RolePropagationConfigInputV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setRolePropagationConfig(rolePropagationConfigInputV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.setRolePropagationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {boolean} [skipRoleRefresh] When true, the role refresh is not performed. Keeping it false is recommended. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startRolePropagation(skipRoleRefresh?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startRolePropagation(skipRoleRefresh, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolePropagationV2026Api.startRolePropagation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolePropagationV2026Api - factory interface - * @export - */ -export const RolePropagationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolePropagationV2026ApiFp(configuration) - return { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {RolePropagationV2026ApiCancelRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelRolePropagation(requestParameters: RolePropagationV2026ApiCancelRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {RolePropagationV2026ApiGetOngoingRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOngoingRolePropagation(requestParameters: RolePropagationV2026ApiGetOngoingRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOngoingRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {RolePropagationV2026ApiGetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationConfig(requestParameters: RolePropagationV2026ApiGetRolePropagationConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRolePropagationConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {RolePropagationV2026ApiGetRolePropagationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRolePropagationStatus(requestParameters: RolePropagationV2026ApiGetRolePropagationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRolePropagationStatus(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationV2026ApiSetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setRolePropagationConfig(requestParameters: RolePropagationV2026ApiSetRolePropagationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setRolePropagationConfig(requestParameters.rolePropagationConfigInputV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {RolePropagationV2026ApiStartRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startRolePropagation(requestParameters: RolePropagationV2026ApiStartRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startRolePropagation(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelRolePropagation operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiCancelRolePropagationRequest - */ -export interface RolePropagationV2026ApiCancelRolePropagationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiCancelRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getOngoingRolePropagation operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiGetOngoingRolePropagationRequest - */ -export interface RolePropagationV2026ApiGetOngoingRolePropagationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiGetOngoingRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRolePropagationConfig operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiGetRolePropagationConfigRequest - */ -export interface RolePropagationV2026ApiGetRolePropagationConfigRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiGetRolePropagationConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getRolePropagationStatus operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiGetRolePropagationStatusRequest - */ -export interface RolePropagationV2026ApiGetRolePropagationStatusRequest { - /** - * The ID of the role propagation process to retrieve the status for. - * @type {string} - * @memberof RolePropagationV2026ApiGetRolePropagationStatus - */ - readonly rolePropagationId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiGetRolePropagationStatus - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setRolePropagationConfig operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiSetRolePropagationConfigRequest - */ -export interface RolePropagationV2026ApiSetRolePropagationConfigRequest { - /** - * - * @type {RolePropagationConfigInputV2026} - * @memberof RolePropagationV2026ApiSetRolePropagationConfig - */ - readonly rolePropagationConfigInputV2026: RolePropagationConfigInputV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiSetRolePropagationConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for startRolePropagation operation in RolePropagationV2026Api. - * @export - * @interface RolePropagationV2026ApiStartRolePropagationRequest - */ -export interface RolePropagationV2026ApiStartRolePropagationRequest { - /** - * When true, the role refresh is not performed. Keeping it false is recommended. - * @type {boolean} - * @memberof RolePropagationV2026ApiStartRolePropagation - */ - readonly skipRoleRefresh?: boolean - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolePropagationV2026ApiStartRolePropagation - */ - readonly xSailPointExperimental?: string -} - -/** - * RolePropagationV2026Api - object-oriented interface - * @export - * @class RolePropagationV2026Api - * @extends {BaseAPI} - */ -export class RolePropagationV2026Api extends BaseAPI { - /** - * This endpoint terminates the ongoing role change propagation process for a tenant. - * @summary Terminate Role Propagation process - * @param {RolePropagationV2026ApiCancelRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public cancelRolePropagation(requestParameters: RolePropagationV2026ApiCancelRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).cancelRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get ongoing Role Propagation process - * @param {RolePropagationV2026ApiGetOngoingRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public getOngoingRolePropagation(requestParameters: RolePropagationV2026ApiGetOngoingRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).getOngoingRolePropagation(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches the Role Change Propagation Configuration for the tenant - * @summary Get Role Change Propagation Configuration - * @param {RolePropagationV2026ApiGetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public getRolePropagationConfig(requestParameters: RolePropagationV2026ApiGetRolePropagationConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).getRolePropagationConfig(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. - * @summary Get status of Role-Propagation process - * @param {RolePropagationV2026ApiGetRolePropagationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public getRolePropagationStatus(requestParameters: RolePropagationV2026ApiGetRolePropagationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).getRolePropagationStatus(requestParameters.rolePropagationId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint enables or disables the Role Change Propagation Process for the tenant - * @summary Update Role Change Propagation Configuration - * @param {RolePropagationV2026ApiSetRolePropagationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public setRolePropagationConfig(requestParameters: RolePropagationV2026ApiSetRolePropagationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).setRolePropagationConfig(requestParameters.rolePropagationConfigInputV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant - * @summary Initiate Role Propagation process - * @param {RolePropagationV2026ApiStartRolePropagationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolePropagationV2026Api - */ - public startRolePropagation(requestParameters: RolePropagationV2026ApiStartRolePropagationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolePropagationV2026ApiFp(this.configuration).startRolePropagation(requestParameters.skipRoleRefresh, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * RolesV2026Api - axios parameter creator - * @export - */ -export const RolesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2026} roleV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole: async (roleV2026: RoleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleV2026' is not null or undefined - assertParamExists('createRole', 'roleV2026', roleV2026) - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2026} roleBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles: async (roleBulkDeleteRequestV2026: RoleBulkDeleteRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBulkDeleteRequestV2026' is not null or undefined - assertParamExists('deleteBulkRoles', 'roleBulkDeleteRequestV2026', roleBulkDeleteRequestV2026) - const localVarPath = `/roles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBulkDeleteRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('deleteMetadataFromRoleByKeyAndValue', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/access-model-metadata/bulk-update`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getBulkUpdateStatusById', 'id', id) - const localVarPath = `/roles/access-model-metadata/bulk-update/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleAssignedIdentities', 'id', id) - const localVarPath = `/roles/{id}/assigned-identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleEntitlements', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/roles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchRole', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchRole', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2026} [roleListFilterDTOV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2026?: RoleListFilterDTOV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleListFilterDTOV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole: async (id: string, attributeKey: string, attributeValue: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'id', id) - // verify required parameter 'attributeKey' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeKey', attributeKey) - // verify required parameter 'attributeValue' is not null or undefined - assertParamExists('updateAttributeKeyAndValueToRole', 'attributeValue', attributeValue) - const localVarPath = `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"attributeKey"}}`, encodeURIComponent(String(attributeKey))) - .replace(`{${"attributeValue"}}`, encodeURIComponent(String(attributeValue))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2026} roleMetadataBulkUpdateByFilterRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter: async (roleMetadataBulkUpdateByFilterRequestV2026: RoleMetadataBulkUpdateByFilterRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByFilterRequestV2026' is not null or undefined - assertParamExists('updateRolesMetadataByFilter', 'roleMetadataBulkUpdateByFilterRequestV2026', roleMetadataBulkUpdateByFilterRequestV2026) - const localVarPath = `/roles/access-model-metadata/bulk-update/filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByFilterRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2026} roleMetadataBulkUpdateByIdRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds: async (roleMetadataBulkUpdateByIdRequestV2026: RoleMetadataBulkUpdateByIdRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByIdRequestV2026' is not null or undefined - assertParamExists('updateRolesMetadataByIds', 'roleMetadataBulkUpdateByIdRequestV2026', roleMetadataBulkUpdateByIdRequestV2026) - const localVarPath = `/roles/access-model-metadata/bulk-update/ids`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByIdRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2026} roleMetadataBulkUpdateByQueryRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery: async (roleMetadataBulkUpdateByQueryRequestV2026: RoleMetadataBulkUpdateByQueryRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleMetadataBulkUpdateByQueryRequestV2026' is not null or undefined - assertParamExists('updateRolesMetadataByQuery', 'roleMetadataBulkUpdateByQueryRequestV2026', roleMetadataBulkUpdateByQueryRequestV2026) - const localVarPath = `/roles/access-model-metadata/bulk-update/query`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleMetadataBulkUpdateByQueryRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * RolesV2026Api - functional programming interface - * @export - */ -export const RolesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RoleV2026} roleV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRole(roleV2026: RoleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRole(roleV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.createRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequestV2026} roleBulkDeleteRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkRoles(roleBulkDeleteRequestV2026: RoleBulkDeleteRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRoles(roleBulkDeleteRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.deleteBulkRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {string} id The role\'s id. - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMetadataFromRoleByKeyAndValue(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetadataFromRoleByKeyAndValue(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.deleteMetadataFromRoleByKeyAndValue']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.deleteRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.getBulkUpdateStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {string} id The Id of the bulk update task. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBulkUpdateStatusById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBulkUpdateStatusById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.getBulkUpdateStatusById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {string} id ID of the Role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.getRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentities(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.getRoleAssignedIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {string} id Containing role\'s ID. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @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: **name, attribute, value, created, modified** - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleEntitlements(id, limit, offset, count, filters, sorters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.getRoleEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.listRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {string} id ID of the Role to patch - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRole(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRole(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.patchRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {RoleListFilterDTOV2026} [roleListFilterDTOV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchRolesByFilter(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, roleListFilterDTOV2026?: RoleListFilterDTOV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchRolesByFilter(forSubadmin, limit, offset, count, sorters, forSegmentIds, includeUnsegmented, roleListFilterDTOV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.searchRolesByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {string} id The Id of a role - * @param {string} attributeKey Technical name of the Attribute. - * @param {string} attributeValue Technical name of the Attribute Value. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAttributeKeyAndValueToRole(id: string, attributeKey: string, attributeValue: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAttributeKeyAndValueToRole(id, attributeKey, attributeValue, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.updateAttributeKeyAndValueToRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RoleMetadataBulkUpdateByFilterRequestV2026} roleMetadataBulkUpdateByFilterRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2026: RoleMetadataBulkUpdateByFilterRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByFilter(roleMetadataBulkUpdateByFilterRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.updateRolesMetadataByFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RoleMetadataBulkUpdateByIdRequestV2026} roleMetadataBulkUpdateByIdRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2026: RoleMetadataBulkUpdateByIdRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByIds(roleMetadataBulkUpdateByIdRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.updateRolesMetadataByIds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RoleMetadataBulkUpdateByQueryRequestV2026} roleMetadataBulkUpdateByQueryRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2026: RoleMetadataBulkUpdateByQueryRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateRolesMetadataByQuery(roleMetadataBulkUpdateByQueryRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesV2026Api.updateRolesMetadataByQuery']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolesV2026Api - factory interface - * @export - */ -export const RolesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolesV2026ApiFp(configuration) - return { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2026ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole(requestParameters: RolesV2026ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRole(requestParameters.roleV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2026ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles(requestParameters: RolesV2026ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2026ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole(requestParameters: RolesV2026ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBulkUpdateStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2026ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBulkUpdateStatusById(requestParameters: RolesV2026ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2026ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole(requestParameters: RolesV2026ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List identities assigned a role - * @param {RolesV2026ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities(requestParameters: RolesV2026ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2026ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleEntitlements(requestParameters: RolesV2026ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2026ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles(requestParameters: RolesV2026ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2026ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole(requestParameters: RolesV2026ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2026ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchRolesByFilter(requestParameters: RolesV2026ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAttributeKeyAndValueToRole(requestParameters: RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2026ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByFilter(requestParameters: RolesV2026ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2026ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByIds(requestParameters: RolesV2026ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2026ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateRolesMetadataByQuery(requestParameters: RolesV2026ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRole operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiCreateRoleRequest - */ -export interface RolesV2026ApiCreateRoleRequest { - /** - * - * @type {RoleV2026} - * @memberof RolesV2026ApiCreateRole - */ - readonly roleV2026: RoleV2026 -} - -/** - * Request parameters for deleteBulkRoles operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiDeleteBulkRolesRequest - */ -export interface RolesV2026ApiDeleteBulkRolesRequest { - /** - * - * @type {RoleBulkDeleteRequestV2026} - * @memberof RolesV2026ApiDeleteBulkRoles - */ - readonly roleBulkDeleteRequestV2026: RoleBulkDeleteRequestV2026 -} - -/** - * Request parameters for deleteMetadataFromRoleByKeyAndValue operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest - */ -export interface RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest { - /** - * The role\'s id. - * @type {string} - * @memberof RolesV2026ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2026ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2026ApiDeleteMetadataFromRoleByKeyAndValue - */ - readonly attributeValue: string -} - -/** - * Request parameters for deleteRole operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiDeleteRoleRequest - */ -export interface RolesV2026ApiDeleteRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2026ApiDeleteRole - */ - readonly id: string -} - -/** - * Request parameters for getBulkUpdateStatusById operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiGetBulkUpdateStatusByIdRequest - */ -export interface RolesV2026ApiGetBulkUpdateStatusByIdRequest { - /** - * The Id of the bulk update task. - * @type {string} - * @memberof RolesV2026ApiGetBulkUpdateStatusById - */ - readonly id: string -} - -/** - * Request parameters for getRole operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiGetRoleRequest - */ -export interface RolesV2026ApiGetRoleRequest { - /** - * ID of the Role - * @type {string} - * @memberof RolesV2026ApiGetRole - */ - readonly id: string -} - -/** - * Request parameters for getRoleAssignedIdentities operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiGetRoleAssignedIdentitiesRequest - */ -export interface RolesV2026ApiGetRoleAssignedIdentitiesRequest { - /** - * ID of the Role for which the assigned Identities are to be listed - * @type {string} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @type {string} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - 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, name, aliasName, email** - * @type {string} - * @memberof RolesV2026ApiGetRoleAssignedIdentities - */ - readonly sorters?: string -} - -/** - * Request parameters for getRoleEntitlements operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiGetRoleEntitlementsRequest - */ -export interface RolesV2026ApiGetRoleEntitlementsRequest { - /** - * Containing role\'s ID. - * @type {string} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - readonly id: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - * @type {string} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - readonly sorters?: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof RolesV2026ApiGetRoleEntitlements - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listRoles operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiListRolesRequest - */ -export interface RolesV2026ApiListRolesRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2026ApiListRoles - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiListRoles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiListRoles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2026ApiListRoles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @type {string} - * @memberof RolesV2026ApiListRoles - */ - 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: **name, created, modified** - * @type {string} - * @memberof RolesV2026ApiListRoles - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2026ApiListRoles - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2026ApiListRoles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchRole operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiPatchRoleRequest - */ -export interface RolesV2026ApiPatchRoleRequest { - /** - * ID of the Role to patch - * @type {string} - * @memberof RolesV2026ApiPatchRole - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof RolesV2026ApiPatchRole - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for searchRolesByFilter operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiSearchRolesByFilterRequest - */ -export interface RolesV2026ApiSearchRolesByFilterRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly forSubadmin?: string - - /** - * Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly includeUnsegmented?: boolean - - /** - * - * @type {RoleListFilterDTOV2026} - * @memberof RolesV2026ApiSearchRolesByFilter - */ - readonly roleListFilterDTOV2026?: RoleListFilterDTOV2026 -} - -/** - * Request parameters for updateAttributeKeyAndValueToRole operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest - */ -export interface RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest { - /** - * The Id of a role - * @type {string} - * @memberof RolesV2026ApiUpdateAttributeKeyAndValueToRole - */ - readonly id: string - - /** - * Technical name of the Attribute. - * @type {string} - * @memberof RolesV2026ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeKey: string - - /** - * Technical name of the Attribute Value. - * @type {string} - * @memberof RolesV2026ApiUpdateAttributeKeyAndValueToRole - */ - readonly attributeValue: string -} - -/** - * Request parameters for updateRolesMetadataByFilter operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiUpdateRolesMetadataByFilterRequest - */ -export interface RolesV2026ApiUpdateRolesMetadataByFilterRequest { - /** - * - * @type {RoleMetadataBulkUpdateByFilterRequestV2026} - * @memberof RolesV2026ApiUpdateRolesMetadataByFilter - */ - readonly roleMetadataBulkUpdateByFilterRequestV2026: RoleMetadataBulkUpdateByFilterRequestV2026 -} - -/** - * Request parameters for updateRolesMetadataByIds operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiUpdateRolesMetadataByIdsRequest - */ -export interface RolesV2026ApiUpdateRolesMetadataByIdsRequest { - /** - * - * @type {RoleMetadataBulkUpdateByIdRequestV2026} - * @memberof RolesV2026ApiUpdateRolesMetadataByIds - */ - readonly roleMetadataBulkUpdateByIdRequestV2026: RoleMetadataBulkUpdateByIdRequestV2026 -} - -/** - * Request parameters for updateRolesMetadataByQuery operation in RolesV2026Api. - * @export - * @interface RolesV2026ApiUpdateRolesMetadataByQueryRequest - */ -export interface RolesV2026ApiUpdateRolesMetadataByQueryRequest { - /** - * - * @type {RoleMetadataBulkUpdateByQueryRequestV2026} - * @memberof RolesV2026ApiUpdateRolesMetadataByQuery - */ - readonly roleMetadataBulkUpdateByQueryRequestV2026: RoleMetadataBulkUpdateByQueryRequestV2026 -} - -/** - * RolesV2026Api - object-oriented interface - * @export - * @class RolesV2026Api - * @extends {BaseAPI} - */ -export class RolesV2026Api extends BaseAPI { - /** - * This API creates a role. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesV2026ApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public createRole(requestParameters: RolesV2026ApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).createRole(requestParameters.roleV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesV2026ApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public deleteBulkRoles(requestParameters: RolesV2026ApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Remove a metadata from role. - * @param {RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public deleteMetadataFromRoleByKeyAndValue(requestParameters: RolesV2026ApiDeleteMetadataFromRoleByKeyAndValueRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).deleteMetadataFromRoleByKeyAndValue(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Delete a role - * @param {RolesV2026ApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public deleteRole(requestParameters: RolesV2026ApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).deleteRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all unfinished bulk update process status of the tenant. - * @summary Get bulk-update statuses - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public getBulkUpdateStatus(axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).getBulkUpdateStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initial a request for one bulk update\'s status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. - * @summary Get bulk-update status by id - * @param {RolesV2026ApiGetBulkUpdateStatusByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public getBulkUpdateStatusById(requestParameters: RolesV2026ApiGetBulkUpdateStatusByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).getBulkUpdateStatusById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - * @summary Get a role - * @param {RolesV2026ApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public getRole(requestParameters: RolesV2026ApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).getRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List identities assigned a role - * @param {RolesV2026ApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public getRoleAssignedIdentities(requestParameters: RolesV2026ApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of entitlements associated with a specified role. - * @summary List role\'s entitlements - * @param {RolesV2026ApiGetRoleEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public getRoleEntitlements(requestParameters: RolesV2026ApiGetRoleEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).getRoleEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - * @summary List roles - * @param {RolesV2026ApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public listRoles(requestParameters: RolesV2026ApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch a specified role - * @param {RolesV2026ApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public patchRole(requestParameters: RolesV2026ApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).patchRole(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. - * @summary Filter roles by metadata - * @param {RolesV2026ApiSearchRolesByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public searchRolesByFilter(requestParameters: RolesV2026ApiSearchRolesByFilterRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).searchRolesByFilter(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.roleListFilterDTOV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. - * @summary Add a metadata to role. - * @param {RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public updateAttributeKeyAndValueToRole(requestParameters: RolesV2026ApiUpdateAttributeKeyAndValueToRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).updateAttributeKeyAndValueToRole(requestParameters.id, requestParameters.attributeKey, requestParameters.attributeValue, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by filters - * @param {RolesV2026ApiUpdateRolesMetadataByFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public updateRolesMetadataByFilter(requestParameters: RolesV2026ApiUpdateRolesMetadataByFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).updateRolesMetadataByFilter(requestParameters.roleMetadataBulkUpdateByFilterRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by id - * @param {RolesV2026ApiUpdateRolesMetadataByIdsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public updateRolesMetadataByIds(requestParameters: RolesV2026ApiUpdateRolesMetadataByIdsRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).updateRolesMetadataByIds(requestParameters.roleMetadataBulkUpdateByIdRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. - * @summary Bulk-update roles\' metadata by query - * @param {RolesV2026ApiUpdateRolesMetadataByQueryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesV2026Api - */ - public updateRolesMetadataByQuery(requestParameters: RolesV2026ApiUpdateRolesMetadataByQueryRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesV2026ApiFp(this.configuration).updateRolesMetadataByQuery(requestParameters.roleMetadataBulkUpdateByQueryRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SIMIntegrationsV2026Api - axios parameter creator - * @export - */ -export const SIMIntegrationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2026} simIntegrationDetailsV2026 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration: async (simIntegrationDetailsV2026: SimIntegrationDetailsV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'simIntegrationDetailsV2026' is not null or undefined - assertParamExists('createSIMIntegration', 'simIntegrationDetailsV2026', simIntegrationDetailsV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSIMIntegration', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2026} jsonPatchV2026 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule: async (id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'id', id) - // verify required parameter 'jsonPatchV2026' is not null or undefined - assertParamExists('patchBeforeProvisioningRule', 'jsonPatchV2026', jsonPatchV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{id}/beforeProvisioningRule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2026} jsonPatchV2026 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes: async (id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSIMAttributes', 'id', id) - // verify required parameter 'jsonPatchV2026' is not null or undefined - assertParamExists('patchSIMAttributes', 'jsonPatchV2026', jsonPatchV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2026} simIntegrationDetailsV2026 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration: async (id: string, simIntegrationDetailsV2026: SimIntegrationDetailsV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSIMIntegration', 'id', id) - // verify required parameter 'simIntegrationDetailsV2026' is not null or undefined - assertParamExists('putSIMIntegration', 'simIntegrationDetailsV2026', simIntegrationDetailsV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sim-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(simIntegrationDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SIMIntegrationsV2026Api - functional programming interface - * @export - */ -export const SIMIntegrationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SIMIntegrationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SimIntegrationDetailsV2026} simIntegrationDetailsV2026 DTO containing the details of the SIM integration - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSIMIntegration(simIntegrationDetailsV2026: SimIntegrationDetailsV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSIMIntegration(simIntegrationDetailsV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.createSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {string} id The id of the integration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.deleteSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {string} id The id of the integration. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegration(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegration(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.getSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSIMIntegrations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSIMIntegrations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.getSIMIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2026} jsonPatchV2026 The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchBeforeProvisioningRule(id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchBeforeProvisioningRule(id, jsonPatchV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.patchBeforeProvisioningRule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {string} id SIM integration id - * @param {JsonPatchV2026} jsonPatchV2026 The JsonPatch object that describes the changes of SIM - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSIMAttributes(id: string, jsonPatchV2026: JsonPatchV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSIMAttributes(id, jsonPatchV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.patchSIMAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {string} id The id of the integration. - * @param {SimIntegrationDetailsV2026} simIntegrationDetailsV2026 The full DTO of the integration containing the updated model - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSIMIntegration(id: string, simIntegrationDetailsV2026: SimIntegrationDetailsV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSIMIntegration(id, simIntegrationDetailsV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SIMIntegrationsV2026Api.putSIMIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SIMIntegrationsV2026Api - factory interface - * @export - */ -export const SIMIntegrationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SIMIntegrationsV2026ApiFp(configuration) - return { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2026ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSIMIntegration(requestParameters: SIMIntegrationsV2026ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSIMIntegration(requestParameters.simIntegrationDetailsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSIMIntegration(requestParameters: SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2026ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegration(requestParameters: SIMIntegrationsV2026ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2026ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSIMIntegrations(requestParameters: SIMIntegrationsV2026ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2026ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSIMAttributes(requestParameters: SIMIntegrationsV2026ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2026ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSIMIntegration(requestParameters: SIMIntegrationsV2026ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSIMIntegration operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiCreateSIMIntegrationRequest - */ -export interface SIMIntegrationsV2026ApiCreateSIMIntegrationRequest { - /** - * DTO containing the details of the SIM integration - * @type {SimIntegrationDetailsV2026} - * @memberof SIMIntegrationsV2026ApiCreateSIMIntegration - */ - readonly simIntegrationDetailsV2026: SimIntegrationDetailsV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiCreateSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSIMIntegration operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest - */ -export interface SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest { - /** - * The id of the integration to delete. - * @type {string} - * @memberof SIMIntegrationsV2026ApiDeleteSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiDeleteSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegration operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiGetSIMIntegrationRequest - */ -export interface SIMIntegrationsV2026ApiGetSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2026ApiGetSIMIntegration - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiGetSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSIMIntegrations operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiGetSIMIntegrationsRequest - */ -export interface SIMIntegrationsV2026ApiGetSIMIntegrationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiGetSIMIntegrations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchBeforeProvisioningRule operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest - */ -export interface SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2026ApiPatchBeforeProvisioningRule - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - * @type {JsonPatchV2026} - * @memberof SIMIntegrationsV2026ApiPatchBeforeProvisioningRule - */ - readonly jsonPatchV2026: JsonPatchV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiPatchBeforeProvisioningRule - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSIMAttributes operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiPatchSIMAttributesRequest - */ -export interface SIMIntegrationsV2026ApiPatchSIMAttributesRequest { - /** - * SIM integration id - * @type {string} - * @memberof SIMIntegrationsV2026ApiPatchSIMAttributes - */ - readonly id: string - - /** - * The JsonPatch object that describes the changes of SIM - * @type {JsonPatchV2026} - * @memberof SIMIntegrationsV2026ApiPatchSIMAttributes - */ - readonly jsonPatchV2026: JsonPatchV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiPatchSIMAttributes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSIMIntegration operation in SIMIntegrationsV2026Api. - * @export - * @interface SIMIntegrationsV2026ApiPutSIMIntegrationRequest - */ -export interface SIMIntegrationsV2026ApiPutSIMIntegrationRequest { - /** - * The id of the integration. - * @type {string} - * @memberof SIMIntegrationsV2026ApiPutSIMIntegration - */ - readonly id: string - - /** - * The full DTO of the integration containing the updated model - * @type {SimIntegrationDetailsV2026} - * @memberof SIMIntegrationsV2026ApiPutSIMIntegration - */ - readonly simIntegrationDetailsV2026: SimIntegrationDetailsV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SIMIntegrationsV2026ApiPutSIMIntegration - */ - readonly xSailPointExperimental?: string -} - -/** - * SIMIntegrationsV2026Api - object-oriented interface - * @export - * @class SIMIntegrationsV2026Api - * @extends {BaseAPI} - */ -export class SIMIntegrationsV2026Api extends BaseAPI { - /** - * Create a new SIM Integrations. - * @summary Create new sim integration - * @param {SIMIntegrationsV2026ApiCreateSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public createSIMIntegration(requestParameters: SIMIntegrationsV2026ApiCreateSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).createSIMIntegration(requestParameters.simIntegrationDetailsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Delete a sim integration - * @param {SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public deleteSIMIntegration(requestParameters: SIMIntegrationsV2026ApiDeleteSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).deleteSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the details of a SIM integration. - * @summary Get a sim integration details. - * @param {SIMIntegrationsV2026ApiGetSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public getSIMIntegration(requestParameters: SIMIntegrationsV2026ApiGetSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).getSIMIntegration(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List the existing SIM integrations. - * @summary List the existing sim integrations. - * @param {SIMIntegrationsV2026ApiGetSIMIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public getSIMIntegrations(requestParameters: SIMIntegrationsV2026ApiGetSIMIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).getSIMIntegrations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. - * @summary Patch a sim beforeprovisioningrule attribute. - * @param {SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public patchBeforeProvisioningRule(requestParameters: SIMIntegrationsV2026ApiPatchBeforeProvisioningRuleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).patchBeforeProvisioningRule(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch a SIM attribute given a JsonPatch object. - * @summary Patch a sim attribute. - * @param {SIMIntegrationsV2026ApiPatchSIMAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public patchSIMAttributes(requestParameters: SIMIntegrationsV2026ApiPatchSIMAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).patchSIMAttributes(requestParameters.id, requestParameters.jsonPatchV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing SIM integration. - * @summary Update an existing sim integration - * @param {SIMIntegrationsV2026ApiPutSIMIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SIMIntegrationsV2026Api - */ - public putSIMIntegration(requestParameters: SIMIntegrationsV2026ApiPutSIMIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SIMIntegrationsV2026ApiFp(this.configuration).putSIMIntegration(requestParameters.id, requestParameters.simIntegrationDetailsV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODPoliciesV2026Api - axios parameter creator - * @export - */ -export const SODPoliciesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2026} sodPolicyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy: async (sodPolicyV2026: SodPolicyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sodPolicyV2026' is not null or undefined - assertParamExists('createSodPolicy', 'sodPolicyV2026', sodPolicyV2026) - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (logical !== undefined) { - localVarQueryParameter['logical'] = logical; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getCustomViolationReport', 'reportResultId', reportResultId) - // verify required parameter 'fileName' is not null or undefined - assertParamExists('getCustomViolationReport', 'fileName', fileName) - const localVarPath = `/sod-violation-report/{reportResultId}/download/{fileName}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) - .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getDefaultViolationReport', 'reportResultId', reportResultId) - const localVarPath = `/sod-violation-report/{reportResultId}/download` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getSodViolationReportRunStatus', 'reportResultId', reportResultId) - const localVarPath = `/sod-policies/sod-violation-report-status/{reportResultId}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodViolationReportStatus', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2026 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSodPolicy', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchSodPolicy', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2026} sodPolicyScheduleV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule: async (id: string, sodPolicyScheduleV2026: SodPolicyScheduleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putPolicySchedule', 'id', id) - // verify required parameter 'sodPolicyScheduleV2026' is not null or undefined - assertParamExists('putPolicySchedule', 'sodPolicyScheduleV2026', sodPolicyScheduleV2026) - const localVarPath = `/sod-policies/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyScheduleV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2026} sodPolicyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy: async (id: string, sodPolicyV2026: SodPolicyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSodPolicy', 'id', id) - // verify required parameter 'sodPolicyV2026' is not null or undefined - assertParamExists('putSodPolicy', 'sodPolicyV2026', sodPolicyV2026) - const localVarPath = `/sod-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startEvaluateSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/evaluate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2026} [multiPolicyRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg: async (multiPolicyRequestV2026?: MultiPolicyRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiPolicyRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report/run` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODPoliciesV2026Api - functional programming interface - * @export - */ -export const SODPoliciesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODPoliciesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyV2026} sodPolicyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSodPolicy(sodPolicyV2026: SodPolicyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.createSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicy(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicy(id, logical, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.deleteSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.deleteSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomViolationReport(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReport(reportResultId, fileName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getCustomViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultViolationReport(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReport(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getDefaultViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getSodAllReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportRunStatus(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatus(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getSodViolationReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.getSodViolationReportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.listSodPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperationV2026 A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSodPolicy(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.patchSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicyScheduleV2026} sodPolicyScheduleV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPolicySchedule(id: string, sodPolicyScheduleV2026: SodPolicyScheduleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicySchedule(id, sodPolicyScheduleV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.putPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyV2026} sodPolicyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSodPolicy(id: string, sodPolicyV2026: SodPolicyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.putSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startEvaluateSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startEvaluateSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.startEvaluateSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequestV2026} [multiPolicyRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodAllPoliciesForOrg(multiPolicyRequestV2026?: MultiPolicyRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrg(multiPolicyRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.startSodAllPoliciesForOrg']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesV2026Api.startSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODPoliciesV2026Api - factory interface - * @export - */ -export const SODPoliciesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODPoliciesV2026ApiFp(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2026ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy(requestParameters: SODPoliciesV2026ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSodPolicy(requestParameters.sodPolicyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2026ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy(requestParameters: SODPoliciesV2026ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule(requestParameters: SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2026ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport(requestParameters: SODPoliciesV2026ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2026ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport(requestParameters: SODPoliciesV2026ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodAllReportRunStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2026ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy(requestParameters: SODPoliciesV2026ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2026ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule(requestParameters: SODPoliciesV2026ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus(requestParameters: SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2026ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus(requestParameters: SODPoliciesV2026ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2026ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies(requestParameters: SODPoliciesV2026ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2026ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy(requestParameters: SODPoliciesV2026ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2026ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule(requestParameters: SODPoliciesV2026ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2026ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy(requestParameters: SODPoliciesV2026ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2026ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy(requestParameters: SODPoliciesV2026ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2026ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy(requestParameters: SODPoliciesV2026ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiCreateSodPolicyRequest - */ -export interface SODPoliciesV2026ApiCreateSodPolicyRequest { - /** - * - * @type {SodPolicyV2026} - * @memberof SODPoliciesV2026ApiCreateSodPolicy - */ - readonly sodPolicyV2026: SodPolicyV2026 -} - -/** - * Request parameters for deleteSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiDeleteSodPolicyRequest - */ -export interface SODPoliciesV2026ApiDeleteSodPolicyRequest { - /** - * The ID of the SOD Policy to delete. - * @type {string} - * @memberof SODPoliciesV2026ApiDeleteSodPolicy - */ - readonly id: string - - /** - * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @type {boolean} - * @memberof SODPoliciesV2026ApiDeleteSodPolicy - */ - readonly logical?: boolean -} - -/** - * Request parameters for deleteSodPolicySchedule operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest - */ -export interface SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest { - /** - * The ID of the SOD policy the schedule must be deleted for. - * @type {string} - * @memberof SODPoliciesV2026ApiDeleteSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getCustomViolationReport operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetCustomViolationReportRequest - */ -export interface SODPoliciesV2026ApiGetCustomViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2026ApiGetCustomViolationReport - */ - readonly reportResultId: string - - /** - * Custom Name for the file. - * @type {string} - * @memberof SODPoliciesV2026ApiGetCustomViolationReport - */ - readonly fileName: string -} - -/** - * Request parameters for getDefaultViolationReport operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetDefaultViolationReportRequest - */ -export interface SODPoliciesV2026ApiGetDefaultViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesV2026ApiGetDefaultViolationReport - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetSodPolicyRequest - */ -export interface SODPoliciesV2026ApiGetSodPolicyRequest { - /** - * The ID of the SOD Policy to retrieve. - * @type {string} - * @memberof SODPoliciesV2026ApiGetSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for getSodPolicySchedule operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetSodPolicyScheduleRequest - */ -export interface SODPoliciesV2026ApiGetSodPolicyScheduleRequest { - /** - * The ID of the SOD policy schedule to retrieve. - * @type {string} - * @memberof SODPoliciesV2026ApiGetSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getSodViolationReportRunStatus operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest - */ -export interface SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest { - /** - * The ID of the report reference to retrieve. - * @type {string} - * @memberof SODPoliciesV2026ApiGetSodViolationReportRunStatus - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodViolationReportStatus operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiGetSodViolationReportStatusRequest - */ -export interface SODPoliciesV2026ApiGetSodViolationReportStatusRequest { - /** - * The ID of the violation report to retrieve status for. - * @type {string} - * @memberof SODPoliciesV2026ApiGetSodViolationReportStatus - */ - readonly id: string -} - -/** - * Request parameters for listSodPolicies operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiListSodPoliciesRequest - */ -export interface SODPoliciesV2026ApiListSodPoliciesRequest { - /** - * 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 SODPoliciesV2026ApiListSodPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SODPoliciesV2026ApiListSodPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SODPoliciesV2026ApiListSodPolicies - */ - 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, in* **name**: *eq, in* **state**: *eq, in* - * @type {string} - * @memberof SODPoliciesV2026ApiListSodPolicies - */ - 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, name, created, modified, description** - * @type {string} - * @memberof SODPoliciesV2026ApiListSodPolicies - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiPatchSodPolicyRequest - */ -export interface SODPoliciesV2026ApiPatchSodPolicyRequest { - /** - * The ID of the SOD policy being modified. - * @type {string} - * @memberof SODPoliciesV2026ApiPatchSodPolicy - */ - readonly id: string - - /** - * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @type {Array} - * @memberof SODPoliciesV2026ApiPatchSodPolicy - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for putPolicySchedule operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiPutPolicyScheduleRequest - */ -export interface SODPoliciesV2026ApiPutPolicyScheduleRequest { - /** - * The ID of the SOD policy to update its schedule. - * @type {string} - * @memberof SODPoliciesV2026ApiPutPolicySchedule - */ - readonly id: string - - /** - * - * @type {SodPolicyScheduleV2026} - * @memberof SODPoliciesV2026ApiPutPolicySchedule - */ - readonly sodPolicyScheduleV2026: SodPolicyScheduleV2026 -} - -/** - * Request parameters for putSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiPutSodPolicyRequest - */ -export interface SODPoliciesV2026ApiPutSodPolicyRequest { - /** - * The ID of the SOD policy to update. - * @type {string} - * @memberof SODPoliciesV2026ApiPutSodPolicy - */ - readonly id: string - - /** - * - * @type {SodPolicyV2026} - * @memberof SODPoliciesV2026ApiPutSodPolicy - */ - readonly sodPolicyV2026: SodPolicyV2026 -} - -/** - * Request parameters for startEvaluateSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiStartEvaluateSodPolicyRequest - */ -export interface SODPoliciesV2026ApiStartEvaluateSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2026ApiStartEvaluateSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for startSodAllPoliciesForOrg operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest - */ -export interface SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest { - /** - * - * @type {MultiPolicyRequestV2026} - * @memberof SODPoliciesV2026ApiStartSodAllPoliciesForOrg - */ - readonly multiPolicyRequestV2026?: MultiPolicyRequestV2026 -} - -/** - * Request parameters for startSodPolicy operation in SODPoliciesV2026Api. - * @export - * @interface SODPoliciesV2026ApiStartSodPolicyRequest - */ -export interface SODPoliciesV2026ApiStartSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesV2026ApiStartSodPolicy - */ - readonly id: string -} - -/** - * SODPoliciesV2026Api - object-oriented interface - * @export - * @class SODPoliciesV2026Api - * @extends {BaseAPI} - */ -export class SODPoliciesV2026Api extends BaseAPI { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesV2026ApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public createSodPolicy(requestParameters: SODPoliciesV2026ApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesV2026ApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public deleteSodPolicy(requestParameters: SODPoliciesV2026ApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public deleteSodPolicySchedule(requestParameters: SODPoliciesV2026ApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesV2026ApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getCustomViolationReport(requestParameters: SODPoliciesV2026ApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesV2026ApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getDefaultViolationReport(requestParameters: SODPoliciesV2026ApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getSodAllReportRunStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesV2026ApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getSodPolicy(requestParameters: SODPoliciesV2026ApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesV2026ApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getSodPolicySchedule(requestParameters: SODPoliciesV2026ApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getSodViolationReportRunStatus(requestParameters: SODPoliciesV2026ApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesV2026ApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public getSodViolationReportStatus(requestParameters: SODPoliciesV2026ApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesV2026ApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public listSodPolicies(requestParameters: SODPoliciesV2026ApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesV2026ApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public patchSodPolicy(requestParameters: SODPoliciesV2026ApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesV2026ApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public putPolicySchedule(requestParameters: SODPoliciesV2026ApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).putPolicySchedule(requestParameters.id, requestParameters.sodPolicyScheduleV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesV2026ApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public putSodPolicy(requestParameters: SODPoliciesV2026ApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesV2026ApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public startEvaluateSodPolicy(requestParameters: SODPoliciesV2026ApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public startSodAllPoliciesForOrg(requestParameters: SODPoliciesV2026ApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).startSodAllPoliciesForOrg(requestParameters.multiPolicyRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesV2026ApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesV2026Api - */ - public startSodPolicy(requestParameters: SODPoliciesV2026ApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesV2026ApiFp(this.configuration).startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODViolationsV2026Api - axios parameter creator - * @export - */ -export const SODViolationsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2026} identityWithNewAccessV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations: async (identityWithNewAccessV2026: IdentityWithNewAccessV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2026' is not null or undefined - assertParamExists('startPredictSodViolations', 'identityWithNewAccessV2026', identityWithNewAccessV2026) - const localVarPath = `/sod-violations/predict`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2026} identityWithNewAccessV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck: async (identityWithNewAccessV2026: IdentityWithNewAccessV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccessV2026' is not null or undefined - assertParamExists('startViolationCheck', 'identityWithNewAccessV2026', identityWithNewAccessV2026) - const localVarPath = `/sod-violations/check`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccessV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODViolationsV2026Api - functional programming interface - * @export - */ -export const SODViolationsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODViolationsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccessV2026} identityWithNewAccessV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startPredictSodViolations(identityWithNewAccessV2026: IdentityWithNewAccessV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolations(identityWithNewAccessV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2026Api.startPredictSodViolations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccessV2026} identityWithNewAccessV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startViolationCheck(identityWithNewAccessV2026: IdentityWithNewAccessV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startViolationCheck(identityWithNewAccessV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsV2026Api.startViolationCheck']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODViolationsV2026Api - factory interface - * @export - */ -export const SODViolationsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODViolationsV2026ApiFp(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2026ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations(requestParameters: SODViolationsV2026ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startPredictSodViolations(requestParameters.identityWithNewAccessV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2026ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck(requestParameters: SODViolationsV2026ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startViolationCheck(requestParameters.identityWithNewAccessV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startPredictSodViolations operation in SODViolationsV2026Api. - * @export - * @interface SODViolationsV2026ApiStartPredictSodViolationsRequest - */ -export interface SODViolationsV2026ApiStartPredictSodViolationsRequest { - /** - * - * @type {IdentityWithNewAccessV2026} - * @memberof SODViolationsV2026ApiStartPredictSodViolations - */ - readonly identityWithNewAccessV2026: IdentityWithNewAccessV2026 -} - -/** - * Request parameters for startViolationCheck operation in SODViolationsV2026Api. - * @export - * @interface SODViolationsV2026ApiStartViolationCheckRequest - */ -export interface SODViolationsV2026ApiStartViolationCheckRequest { - /** - * - * @type {IdentityWithNewAccessV2026} - * @memberof SODViolationsV2026ApiStartViolationCheck - */ - readonly identityWithNewAccessV2026: IdentityWithNewAccessV2026 -} - -/** - * SODViolationsV2026Api - object-oriented interface - * @export - * @class SODViolationsV2026Api - * @extends {BaseAPI} - */ -export class SODViolationsV2026Api extends BaseAPI { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsV2026ApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2026Api - */ - public startPredictSodViolations(requestParameters: SODViolationsV2026ApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2026ApiFp(this.configuration).startPredictSodViolations(requestParameters.identityWithNewAccessV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsV2026ApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsV2026Api - */ - public startViolationCheck(requestParameters: SODViolationsV2026ApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsV2026ApiFp(this.configuration).startViolationCheck(requestParameters.identityWithNewAccessV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SPConfigV2026Api - axios parameter creator - * @export - */ -export const SPConfigV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2026} exportPayloadV2026 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig: async (exportPayloadV2026: ExportPayloadV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'exportPayloadV2026' is not null or undefined - assertParamExists('exportSpConfig', 'exportPayloadV2026', exportPayloadV2026) - const localVarPath = `/sp-config/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(exportPayloadV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExport', 'id', id) - const localVarPath = `/sp-config/export/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigExportStatus', 'id', id) - const localVarPath = `/sp-config/export/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImport', 'id', id) - const localVarPath = `/sp-config/import/{id}/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSpConfigImportStatus', 'id', id) - const localVarPath = `/sp-config/import/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2026} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig: async (data: File, preview?: boolean, _options?: ImportOptionsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('importSpConfig', 'data', data) - const localVarPath = `/sp-config/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (preview !== undefined) { - localVarQueryParameter['preview'] = preview; - } - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (_options !== undefined) { - localVarFormParams.append('options', new Blob([JSON.stringify(_options)], { type: "application/json", })); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sp-config/config-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SPConfigV2026Api - functional programming interface - * @export - */ -export const SPConfigV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SPConfigV2026ApiAxiosParamCreator(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {ExportPayloadV2026} exportPayloadV2026 Export options control what will be included in the export. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportSpConfig(exportPayloadV2026: ExportPayloadV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportSpConfig(exportPayloadV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.exportSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {string} id The ID of the export job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.getSpConfigExport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {string} id The ID of the export job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigExportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigExportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.getSpConfigExportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {string} id The ID of the import job whose results will be downloaded. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.getSpConfigImport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {string} id The ID of the import job whose status will be returned. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSpConfigImportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpConfigImportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.getSpConfigImportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {File} data JSON file containing the objects to be imported. - * @param {boolean} [preview] This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @param {ImportOptionsV2026} [_options] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importSpConfig(data: File, preview?: boolean, _options?: ImportOptionsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importSpConfig(data, preview, _options, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.importSpConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSpConfigObjects(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SPConfigV2026Api.listSpConfigObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SPConfigV2026Api - factory interface - * @export - */ -export const SPConfigV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SPConfigV2026ApiFp(configuration) - return { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2026ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportSpConfig(requestParameters: SPConfigV2026ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportSpConfig(requestParameters.exportPayloadV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2026ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExport(requestParameters: SPConfigV2026ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2026ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigExportStatus(requestParameters: SPConfigV2026ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2026ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImport(requestParameters: SPConfigV2026ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2026ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSpConfigImportStatus(requestParameters: SPConfigV2026ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2026ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importSpConfig(requestParameters: SPConfigV2026ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSpConfigObjects(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for exportSpConfig operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiExportSpConfigRequest - */ -export interface SPConfigV2026ApiExportSpConfigRequest { - /** - * Export options control what will be included in the export. - * @type {ExportPayloadV2026} - * @memberof SPConfigV2026ApiExportSpConfig - */ - readonly exportPayloadV2026: ExportPayloadV2026 -} - -/** - * Request parameters for getSpConfigExport operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiGetSpConfigExportRequest - */ -export interface SPConfigV2026ApiGetSpConfigExportRequest { - /** - * The ID of the export job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2026ApiGetSpConfigExport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigExportStatus operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiGetSpConfigExportStatusRequest - */ -export interface SPConfigV2026ApiGetSpConfigExportStatusRequest { - /** - * The ID of the export job whose status will be returned. - * @type {string} - * @memberof SPConfigV2026ApiGetSpConfigExportStatus - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImport operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiGetSpConfigImportRequest - */ -export interface SPConfigV2026ApiGetSpConfigImportRequest { - /** - * The ID of the import job whose results will be downloaded. - * @type {string} - * @memberof SPConfigV2026ApiGetSpConfigImport - */ - readonly id: string -} - -/** - * Request parameters for getSpConfigImportStatus operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiGetSpConfigImportStatusRequest - */ -export interface SPConfigV2026ApiGetSpConfigImportStatusRequest { - /** - * The ID of the import job whose status will be returned. - * @type {string} - * @memberof SPConfigV2026ApiGetSpConfigImportStatus - */ - readonly id: string -} - -/** - * Request parameters for importSpConfig operation in SPConfigV2026Api. - * @export - * @interface SPConfigV2026ApiImportSpConfigRequest - */ -export interface SPConfigV2026ApiImportSpConfigRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof SPConfigV2026ApiImportSpConfig - */ - readonly data: File - - /** - * This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - * @type {boolean} - * @memberof SPConfigV2026ApiImportSpConfig - */ - readonly preview?: boolean - - /** - * - * @type {ImportOptionsV2026} - * @memberof SPConfigV2026ApiImportSpConfig - */ - readonly _options?: ImportOptionsV2026 -} - -/** - * SPConfigV2026Api - object-oriented interface - * @export - * @class SPConfigV2026Api - * @extends {BaseAPI} - */ -export class SPConfigV2026Api extends BaseAPI { - /** - * This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects export job - * @param {SPConfigV2026ApiExportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public exportSpConfig(requestParameters: SPConfigV2026ApiExportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).exportSpConfig(requestParameters.exportPayloadV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Download export job result. - * @param {SPConfigV2026ApiGetSpConfigExportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public getSpConfigExport(requestParameters: SPConfigV2026ApiGetSpConfigExportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).getSpConfigExport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage - * @summary Get export job status - * @param {SPConfigV2026ApiGetSpConfigExportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public getSpConfigExportStatus(requestParameters: SPConfigV2026ApiGetSpConfigExportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).getSpConfigExportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage - * @summary Download import job result - * @param {SPConfigV2026ApiGetSpConfigImportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public getSpConfigImport(requestParameters: SPConfigV2026ApiGetSpConfigImportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).getSpConfigImport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * \'This gets the status of the import job identified by the `id` parameter. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).\' - * @summary Get import job status - * @param {SPConfigV2026ApiGetSpConfigImportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public getSpConfigImportStatus(requestParameters: SPConfigV2026ApiGetSpConfigImportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).getSpConfigImportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the \"exportJobId\". This can be downloaded using the `/sp-config/export/{exportJobId}/download` endpoint. You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). - * @summary Initiates configuration objects import job - * @param {SPConfigV2026ApiImportSpConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public importSpConfig(requestParameters: SPConfigV2026ApiImportSpConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).importSpConfig(requestParameters.data, requestParameters.preview, requestParameters._options, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of object configurations that the tenant export/import service knows. - * @summary List config objects - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SPConfigV2026Api - */ - public listSpConfigObjects(axiosOptions?: RawAxiosRequestConfig) { - return SPConfigV2026ApiFp(this.configuration).listSpConfigObjects(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SavedSearchV2026Api - axios parameter creator - * @export - */ -export const SavedSearchV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2026} createSavedSearchRequestV2026 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch: async (createSavedSearchRequestV2026: CreateSavedSearchRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createSavedSearchRequestV2026' is not null or undefined - assertParamExists('createSavedSearch', 'createSavedSearchRequestV2026', createSavedSearchRequestV2026) - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createSavedSearchRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2026} searchArgumentsV2026 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch: async (id: string, searchArgumentsV2026: SearchArgumentsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('executeSavedSearch', 'id', id) - // verify required parameter 'searchArgumentsV2026' is not null or undefined - assertParamExists('executeSavedSearch', 'searchArgumentsV2026', searchArgumentsV2026) - const localVarPath = `/saved-searches/{id}/execute` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchArgumentsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2026} savedSearchV2026 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch: async (id: string, savedSearchV2026: SavedSearchV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSavedSearch', 'id', id) - // verify required parameter 'savedSearchV2026' is not null or undefined - assertParamExists('putSavedSearch', 'savedSearchV2026', savedSearchV2026) - const localVarPath = `/saved-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(savedSearchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SavedSearchV2026Api - functional programming interface - * @export - */ -export const SavedSearchV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SavedSearchV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequestV2026} createSavedSearchRequestV2026 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSavedSearch(createSavedSearchRequestV2026: CreateSavedSearchRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSavedSearch(createSavedSearchRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.createSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.deleteSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArgumentsV2026} searchArgumentsV2026 When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async executeSavedSearch(id: string, searchArgumentsV2026: SearchArgumentsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.executeSavedSearch(id, searchArgumentsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.executeSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.getSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSavedSearches(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSavedSearches(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.listSavedSearches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearchV2026} savedSearchV2026 The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSavedSearch(id: string, savedSearchV2026: SavedSearchV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSavedSearch(id, savedSearchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchV2026Api.putSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SavedSearchV2026Api - factory interface - * @export - */ -export const SavedSearchV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SavedSearchV2026ApiFp(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2026ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch(requestParameters: SavedSearchV2026ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSavedSearch(requestParameters.createSavedSearchRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2026ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch(requestParameters: SavedSearchV2026ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2026ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch(requestParameters: SavedSearchV2026ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2026ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch(requestParameters: SavedSearchV2026ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2026ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches(requestParameters: SavedSearchV2026ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2026ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch(requestParameters: SavedSearchV2026ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSavedSearch(requestParameters.id, requestParameters.savedSearchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSavedSearch operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiCreateSavedSearchRequest - */ -export interface SavedSearchV2026ApiCreateSavedSearchRequest { - /** - * The saved search to persist. - * @type {CreateSavedSearchRequestV2026} - * @memberof SavedSearchV2026ApiCreateSavedSearch - */ - readonly createSavedSearchRequestV2026: CreateSavedSearchRequestV2026 -} - -/** - * Request parameters for deleteSavedSearch operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiDeleteSavedSearchRequest - */ -export interface SavedSearchV2026ApiDeleteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2026ApiDeleteSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for executeSavedSearch operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiExecuteSavedSearchRequest - */ -export interface SavedSearchV2026ApiExecuteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2026ApiExecuteSavedSearch - */ - readonly id: string - - /** - * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @type {SearchArgumentsV2026} - * @memberof SavedSearchV2026ApiExecuteSavedSearch - */ - readonly searchArgumentsV2026: SearchArgumentsV2026 -} - -/** - * Request parameters for getSavedSearch operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiGetSavedSearchRequest - */ -export interface SavedSearchV2026ApiGetSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2026ApiGetSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for listSavedSearches operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiListSavedSearchesRequest - */ -export interface SavedSearchV2026ApiListSavedSearchesRequest { - /** - * 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 SavedSearchV2026ApiListSavedSearches - */ - 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 SavedSearchV2026ApiListSavedSearches - */ - 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 SavedSearchV2026ApiListSavedSearches - */ - 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: **owner.id**: *eq* - * @type {string} - * @memberof SavedSearchV2026ApiListSavedSearches - */ - readonly filters?: string -} - -/** - * Request parameters for putSavedSearch operation in SavedSearchV2026Api. - * @export - * @interface SavedSearchV2026ApiPutSavedSearchRequest - */ -export interface SavedSearchV2026ApiPutSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchV2026ApiPutSavedSearch - */ - readonly id: string - - /** - * The saved search to persist. - * @type {SavedSearchV2026} - * @memberof SavedSearchV2026ApiPutSavedSearch - */ - readonly savedSearchV2026: SavedSearchV2026 -} - -/** - * SavedSearchV2026Api - object-oriented interface - * @export - * @class SavedSearchV2026Api - * @extends {BaseAPI} - */ -export class SavedSearchV2026Api extends BaseAPI { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchV2026ApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public createSavedSearch(requestParameters: SavedSearchV2026ApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).createSavedSearch(requestParameters.createSavedSearchRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchV2026ApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public deleteSavedSearch(requestParameters: SavedSearchV2026ApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchV2026ApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public executeSavedSearch(requestParameters: SavedSearchV2026ApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).executeSavedSearch(requestParameters.id, requestParameters.searchArgumentsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchV2026ApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public getSavedSearch(requestParameters: SavedSearchV2026ApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchV2026ApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public listSavedSearches(requestParameters: SavedSearchV2026ApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchV2026ApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchV2026Api - */ - public putSavedSearch(requestParameters: SavedSearchV2026ApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchV2026ApiFp(this.configuration).putSavedSearch(requestParameters.id, requestParameters.savedSearchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ScheduledSearchV2026Api - axios parameter creator - * @export - */ -export const ScheduledSearchV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2026} createScheduledSearchRequestV2026 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch: async (createScheduledSearchRequestV2026: CreateScheduledSearchRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduledSearchRequestV2026' is not null or undefined - assertParamExists('createScheduledSearch', 'createScheduledSearchRequestV2026', createScheduledSearchRequestV2026) - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduledSearchRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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, - }; - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2026} typedReferenceV2026 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch: async (id: string, typedReferenceV2026: TypedReferenceV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'id', id) - // verify required parameter 'typedReferenceV2026' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'typedReferenceV2026', typedReferenceV2026) - const localVarPath = `/scheduled-searches/{id}/unsubscribe` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(typedReferenceV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2026} scheduledSearchV2026 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch: async (id: string, scheduledSearchV2026: ScheduledSearchV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateScheduledSearch', 'id', id) - // verify required parameter 'scheduledSearchV2026' is not null or undefined - assertParamExists('updateScheduledSearch', 'scheduledSearchV2026', scheduledSearchV2026) - const localVarPath = `/scheduled-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledSearchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ScheduledSearchV2026Api - functional programming interface - * @export - */ -export const ScheduledSearchV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ScheduledSearchV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequestV2026} createScheduledSearchRequestV2026 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledSearch(createScheduledSearchRequestV2026: CreateScheduledSearchRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledSearch(createScheduledSearchRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.createScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.deleteScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.getScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledSearch(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledSearch(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.listScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReferenceV2026} typedReferenceV2026 The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unsubscribeScheduledSearch(id: string, typedReferenceV2026: TypedReferenceV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribeScheduledSearch(id, typedReferenceV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.unsubscribeScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearchV2026} scheduledSearchV2026 The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledSearch(id: string, scheduledSearchV2026: ScheduledSearchV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledSearch(id, scheduledSearchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchV2026Api.updateScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ScheduledSearchV2026Api - factory interface - * @export - */ -export const ScheduledSearchV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ScheduledSearchV2026ApiFp(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2026ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch(requestParameters: ScheduledSearchV2026ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledSearch(requestParameters.createScheduledSearchRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2026ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch(requestParameters: ScheduledSearchV2026ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2026ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch(requestParameters: ScheduledSearchV2026ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2026ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch(requestParameters: ScheduledSearchV2026ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2026ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch(requestParameters: ScheduledSearchV2026ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiCreateScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiCreateScheduledSearchRequest { - /** - * The scheduled search to persist. - * @type {CreateScheduledSearchRequestV2026} - * @memberof ScheduledSearchV2026ApiCreateScheduledSearch - */ - readonly createScheduledSearchRequestV2026: CreateScheduledSearchRequestV2026 -} - -/** - * Request parameters for deleteScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiDeleteScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiDeleteScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2026ApiDeleteScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for getScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiGetScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiGetScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2026ApiGetScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for listScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiListScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiListScheduledSearchRequest { - /** - * 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 ScheduledSearchV2026ApiListScheduledSearch - */ - 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 ScheduledSearchV2026ApiListScheduledSearch - */ - 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 ScheduledSearchV2026ApiListScheduledSearch - */ - 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: **owner.id**: *eq* **savedSearchId**: *eq* - * @type {string} - * @memberof ScheduledSearchV2026ApiListScheduledSearch - */ - readonly filters?: string -} - -/** - * Request parameters for unsubscribeScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2026ApiUnsubscribeScheduledSearch - */ - readonly id: string - - /** - * The recipient to be removed from the scheduled search. - * @type {TypedReferenceV2026} - * @memberof ScheduledSearchV2026ApiUnsubscribeScheduledSearch - */ - readonly typedReferenceV2026: TypedReferenceV2026 -} - -/** - * Request parameters for updateScheduledSearch operation in ScheduledSearchV2026Api. - * @export - * @interface ScheduledSearchV2026ApiUpdateScheduledSearchRequest - */ -export interface ScheduledSearchV2026ApiUpdateScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchV2026ApiUpdateScheduledSearch - */ - readonly id: string - - /** - * The scheduled search to persist. - * @type {ScheduledSearchV2026} - * @memberof ScheduledSearchV2026ApiUpdateScheduledSearch - */ - readonly scheduledSearchV2026: ScheduledSearchV2026 -} - -/** - * ScheduledSearchV2026Api - object-oriented interface - * @export - * @class ScheduledSearchV2026Api - * @extends {BaseAPI} - */ -export class ScheduledSearchV2026Api extends BaseAPI { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchV2026ApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public createScheduledSearch(requestParameters: ScheduledSearchV2026ApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).createScheduledSearch(requestParameters.createScheduledSearchRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchV2026ApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public deleteScheduledSearch(requestParameters: ScheduledSearchV2026ApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchV2026ApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public getScheduledSearch(requestParameters: ScheduledSearchV2026ApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchV2026ApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public listScheduledSearch(requestParameters: ScheduledSearchV2026ApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public unsubscribeScheduledSearch(requestParameters: ScheduledSearchV2026ApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReferenceV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchV2026ApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchV2026Api - */ - public updateScheduledSearch(requestParameters: ScheduledSearchV2026ApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchV2026ApiFp(this.configuration).updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SearchV2026Api - axios parameter creator - * @export - */ -export const SearchV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2026} searchV2026 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate: async (searchV2026: SearchV2026, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2026' is not null or undefined - assertParamExists('searchAggregate', 'searchV2026', searchV2026) - const localVarPath = `/search/aggregate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2026} searchV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount: async (searchV2026: SearchV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2026' is not null or undefined - assertParamExists('searchCount', 'searchV2026', searchV2026) - const localVarPath = `/search/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2026} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet: async (index: SearchGetIndexV2026, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'index' is not null or undefined - assertParamExists('searchGet', 'index', index) - // verify required parameter 'id' is not null or undefined - assertParamExists('searchGet', 'id', id) - const localVarPath = `/search/{index}/{id}` - .replace(`{${"index"}}`, encodeURIComponent(String(index))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2026} searchV2026 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost: async (searchV2026: SearchV2026, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchV2026' is not null or undefined - assertParamExists('searchPost', 'searchV2026', searchV2026) - const localVarPath = `/search`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchV2026Api - functional programming interface - * @export - */ -export const SearchV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchV2026ApiAxiosParamCreator(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2026} searchV2026 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchAggregate(searchV2026: SearchV2026, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchAggregate(searchV2026, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2026Api.searchAggregate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2026} searchV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchCount(searchV2026: SearchV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchCount(searchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2026Api.searchCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV2026} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchGet(index: SearchGetIndexV2026, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchGet(index, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2026Api.searchGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2026} searchV2026 - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPost(searchV2026: SearchV2026, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPost(searchV2026, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchV2026Api.searchPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchV2026Api - factory interface - * @export - */ -export const SearchV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchV2026ApiFp(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2026ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate(requestParameters: SearchV2026ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchAggregate(requestParameters.searchV2026, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2026ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount(requestParameters: SearchV2026ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchCount(requestParameters.searchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2026ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet(requestParameters: SearchV2026ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2026ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost(requestParameters: SearchV2026ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchPost(requestParameters.searchV2026, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for searchAggregate operation in SearchV2026Api. - * @export - * @interface SearchV2026ApiSearchAggregateRequest - */ -export interface SearchV2026ApiSearchAggregateRequest { - /** - * - * @type {SearchV2026} - * @memberof SearchV2026ApiSearchAggregate - */ - readonly searchV2026: SearchV2026 - - /** - * 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 SearchV2026ApiSearchAggregate - */ - 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 SearchV2026ApiSearchAggregate - */ - 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 SearchV2026ApiSearchAggregate - */ - readonly count?: boolean -} - -/** - * Request parameters for searchCount operation in SearchV2026Api. - * @export - * @interface SearchV2026ApiSearchCountRequest - */ -export interface SearchV2026ApiSearchCountRequest { - /** - * - * @type {SearchV2026} - * @memberof SearchV2026ApiSearchCount - */ - readonly searchV2026: SearchV2026 -} - -/** - * Request parameters for searchGet operation in SearchV2026Api. - * @export - * @interface SearchV2026ApiSearchGetRequest - */ -export interface SearchV2026ApiSearchGetRequest { - /** - * The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @type {'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'} - * @memberof SearchV2026ApiSearchGet - */ - readonly index: SearchGetIndexV2026 - - /** - * ID of the requested document. - * @type {string} - * @memberof SearchV2026ApiSearchGet - */ - readonly id: string -} - -/** - * Request parameters for searchPost operation in SearchV2026Api. - * @export - * @interface SearchV2026ApiSearchPostRequest - */ -export interface SearchV2026ApiSearchPostRequest { - /** - * - * @type {SearchV2026} - * @memberof SearchV2026ApiSearchPost - */ - readonly searchV2026: SearchV2026 - - /** - * 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 SearchV2026ApiSearchPost - */ - 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 SearchV2026ApiSearchPost - */ - 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 SearchV2026ApiSearchPost - */ - readonly count?: boolean -} - -/** - * SearchV2026Api - object-oriented interface - * @export - * @class SearchV2026Api - * @extends {BaseAPI} - */ -export class SearchV2026Api extends BaseAPI { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchV2026ApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2026Api - */ - public searchAggregate(requestParameters: SearchV2026ApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2026ApiFp(this.configuration).searchAggregate(requestParameters.searchV2026, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchV2026ApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2026Api - */ - public searchCount(requestParameters: SearchV2026ApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2026ApiFp(this.configuration).searchCount(requestParameters.searchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchV2026ApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2026Api - */ - public searchGet(requestParameters: SearchV2026ApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2026ApiFp(this.configuration).searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchV2026ApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchV2026Api - */ - public searchPost(requestParameters: SearchV2026ApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchV2026ApiFp(this.configuration).searchPost(requestParameters.searchV2026, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SearchGetIndexV2026 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles' -} as const; -export type SearchGetIndexV2026 = typeof SearchGetIndexV2026[keyof typeof SearchGetIndexV2026]; - - -/** - * SearchAttributeConfigurationV2026Api - axios parameter creator - * @export - */ -export const SearchAttributeConfigurationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2026} searchAttributeConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig: async (searchAttributeConfigV2026: SearchAttributeConfigV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchAttributeConfigV2026' is not null or undefined - assertParamExists('createSearchAttributeConfig', 'searchAttributeConfigV2026', searchAttributeConfigV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchAttributeConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig: async (limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig: async (name: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getSingleSearchAttributeConfig', 'name', name) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig: async (name: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'name', name) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchAttributeConfigurationV2026Api - functional programming interface - * @export - */ -export const SearchAttributeConfigurationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchAttributeConfigurationV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigV2026} searchAttributeConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSearchAttributeConfig(searchAttributeConfigV2026: SearchAttributeConfigV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfig(searchAttributeConfigV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2026Api.createSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2026Api.deleteSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSearchAttributeConfig(limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2026Api.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to get. - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSingleSearchAttributeConfig(name: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfig(name, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2026Api.getSingleSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperationV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSearchAttributeConfig(name: string, jsonPatchOperationV2026: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfig(name, jsonPatchOperationV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationV2026Api.patchSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchAttributeConfigurationV2026Api - factory interface - * @export - */ -export const SearchAttributeConfigurationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchAttributeConfigurationV2026ApiFp(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSearchAttributeConfig(requestParameters.searchAttributeConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationV2026Api. - * @export - * @interface SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest { - /** - * - * @type {SearchAttributeConfigV2026} - * @memberof SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfig - */ - readonly searchAttributeConfigV2026: SearchAttributeConfigV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationV2026Api. - * @export - * @interface SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to delete. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationV2026Api. - * @export - * @interface SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest { - /** - * 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 SearchAttributeConfigurationV2026ApiGetSearchAttributeConfig - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SearchAttributeConfigurationV2026ApiGetSearchAttributeConfig - */ - readonly offset?: number - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiGetSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationV2026Api. - * @export - * @interface SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to get. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfig - */ - readonly name: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationV2026Api. - * @export - * @interface SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest { - /** - * Name of the search attribute configuration to patch. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfig - */ - readonly name: string - - /** - * - * @type {Array} - * @memberof SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfig - */ - readonly jsonPatchOperationV2026: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * SearchAttributeConfigurationV2026Api - object-oriented interface - * @export - * @class SearchAttributeConfigurationV2026Api - * @extends {BaseAPI} - */ -export class SearchAttributeConfigurationV2026Api extends BaseAPI { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2026Api - */ - public createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2026ApiFp(this.configuration).createSearchAttributeConfig(requestParameters.searchAttributeConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2026Api - */ - public deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2026ApiFp(this.configuration).deleteSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2026Api - */ - public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2026ApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2026Api - */ - public getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2026ApiFp(this.configuration).getSingleSearchAttributeConfig(requestParameters.name, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationV2026Api - */ - public patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationV2026ApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationV2026ApiFp(this.configuration).patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperationV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SegmentsV2026Api - axios parameter creator - * @export - */ -export const SegmentsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2026} segmentV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment: async (segmentV2026: SegmentV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'segmentV2026' is not null or undefined - assertParamExists('createSegment', 'segmentV2026', segmentV2026) - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(segmentV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSegment', 'requestBody', requestBody) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SegmentsV2026Api - functional programming interface - * @export - */ -export const SegmentsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SegmentsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentV2026} segmentV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSegment(segmentV2026: SegmentV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSegment(segmentV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2026Api.createSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2026Api.deleteSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2026Api.getSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSegments(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2026Api.listSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSegment(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegment(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsV2026Api.patchSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SegmentsV2026Api - factory interface - * @export - */ -export const SegmentsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SegmentsV2026ApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2026ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment(requestParameters: SegmentsV2026ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSegment(requestParameters.segmentV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2026ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment(requestParameters: SegmentsV2026ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2026ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment(requestParameters: SegmentsV2026ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2026ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments(requestParameters: SegmentsV2026ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2026ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment(requestParameters: SegmentsV2026ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSegment operation in SegmentsV2026Api. - * @export - * @interface SegmentsV2026ApiCreateSegmentRequest - */ -export interface SegmentsV2026ApiCreateSegmentRequest { - /** - * - * @type {SegmentV2026} - * @memberof SegmentsV2026ApiCreateSegment - */ - readonly segmentV2026: SegmentV2026 -} - -/** - * Request parameters for deleteSegment operation in SegmentsV2026Api. - * @export - * @interface SegmentsV2026ApiDeleteSegmentRequest - */ -export interface SegmentsV2026ApiDeleteSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof SegmentsV2026ApiDeleteSegment - */ - readonly id: string -} - -/** - * Request parameters for getSegment operation in SegmentsV2026Api. - * @export - * @interface SegmentsV2026ApiGetSegmentRequest - */ -export interface SegmentsV2026ApiGetSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof SegmentsV2026ApiGetSegment - */ - readonly id: string -} - -/** - * Request parameters for listSegments operation in SegmentsV2026Api. - * @export - * @interface SegmentsV2026ApiListSegmentsRequest - */ -export interface SegmentsV2026ApiListSegmentsRequest { - /** - * 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 SegmentsV2026ApiListSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SegmentsV2026ApiListSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SegmentsV2026ApiListSegments - */ - readonly count?: boolean -} - -/** - * Request parameters for patchSegment operation in SegmentsV2026Api. - * @export - * @interface SegmentsV2026ApiPatchSegmentRequest - */ -export interface SegmentsV2026ApiPatchSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof SegmentsV2026ApiPatchSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @type {Array} - * @memberof SegmentsV2026ApiPatchSegment - */ - readonly requestBody: Array -} - -/** - * SegmentsV2026Api - object-oriented interface - * @export - * @class SegmentsV2026Api - * @extends {BaseAPI} - */ -export class SegmentsV2026Api extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsV2026ApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2026Api - */ - public createSegment(requestParameters: SegmentsV2026ApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2026ApiFp(this.configuration).createSegment(requestParameters.segmentV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsV2026ApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2026Api - */ - public deleteSegment(requestParameters: SegmentsV2026ApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2026ApiFp(this.configuration).deleteSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsV2026ApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2026Api - */ - public getSegment(requestParameters: SegmentsV2026ApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2026ApiFp(this.configuration).getSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsV2026ApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2026Api - */ - public listSegments(requestParameters: SegmentsV2026ApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2026ApiFp(this.configuration).listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsV2026ApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsV2026Api - */ - public patchSegment(requestParameters: SegmentsV2026ApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsV2026ApiFp(this.configuration).patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ServiceDeskIntegrationV2026Api - axios parameter creator - * @export - */ -export const ServiceDeskIntegrationV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2026} serviceDeskIntegrationDtoV2026 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration: async (serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'serviceDeskIntegrationDtoV2026' is not null or undefined - assertParamExists('createServiceDeskIntegration', 'serviceDeskIntegrationDtoV2026', serviceDeskIntegrationDtoV2026) - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getServiceDeskIntegrationTemplate', 'scriptName', scriptName) - const localVarPath = `/service-desk-integrations/templates/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2026 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2026} serviceDeskIntegrationDtoV2026 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration: async (id: string, serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'id', id) - // verify required parameter 'serviceDeskIntegrationDtoV2026' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'serviceDeskIntegrationDtoV2026', serviceDeskIntegrationDtoV2026) - const localVarPath = `/service-desk-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2026} queuedCheckConfigDetailsV2026 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails: async (queuedCheckConfigDetailsV2026: QueuedCheckConfigDetailsV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'queuedCheckConfigDetailsV2026' is not null or undefined - assertParamExists('updateStatusCheckDetails', 'queuedCheckConfigDetailsV2026', queuedCheckConfigDetailsV2026) - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetailsV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ServiceDeskIntegrationV2026Api - functional programming interface - * @export - */ -export const ServiceDeskIntegrationV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ServiceDeskIntegrationV2026ApiAxiosParamCreator(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDtoV2026} serviceDeskIntegrationDtoV2026 The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createServiceDeskIntegration(serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegration(serviceDeskIntegrationDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.createServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.deleteServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.getServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.getServiceDeskIntegrationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.getServiceDeskIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrations(offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.getServiceDeskIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetails(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.getStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperationV2026 A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchServiceDeskIntegration(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDtoV2026} serviceDeskIntegrationDtoV2026 The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putServiceDeskIntegration(id: string, serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegration(id, serviceDeskIntegrationDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.putServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetailsV2026} queuedCheckConfigDetailsV2026 The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStatusCheckDetails(queuedCheckConfigDetailsV2026: QueuedCheckConfigDetailsV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetails(queuedCheckConfigDetailsV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationV2026Api.updateStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ServiceDeskIntegrationV2026Api - factory interface - * @export - */ -export const ServiceDeskIntegrationV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ServiceDeskIntegrationV2026ApiFp(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusCheckDetails(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createServiceDeskIntegration operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest { - /** - * The specifics of a new integration to create - * @type {ServiceDeskIntegrationDtoV2026} - * @memberof ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026 -} - -/** - * Request parameters for deleteServiceDeskIntegration operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest { - /** - * ID of Service Desk integration to delete - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegration operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to get - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiGetServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegrationTemplate operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest - */ -export interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest { - /** - * The scriptName value of the Service Desk integration template to get - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getServiceDeskIntegrations operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest - */ -export interface ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest { - /** - * 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 ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrations - */ - 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 ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrations - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrations - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrations - */ - readonly filters?: string - - /** - * 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 ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrations - */ - readonly count?: boolean -} - -/** - * Request parameters for patchServiceDeskIntegration operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegration - */ - readonly id: string - - /** - * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @type {Array} - * @memberof ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegration - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationV2026ApiPutServiceDeskIntegration - */ - readonly id: string - - /** - * The specifics of the integration to update - * @type {ServiceDeskIntegrationDtoV2026} - * @memberof ServiceDeskIntegrationV2026ApiPutServiceDeskIntegration - */ - readonly serviceDeskIntegrationDtoV2026: ServiceDeskIntegrationDtoV2026 -} - -/** - * Request parameters for updateStatusCheckDetails operation in ServiceDeskIntegrationV2026Api. - * @export - * @interface ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest - */ -export interface ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest { - /** - * The modified time check configuration - * @type {QueuedCheckConfigDetailsV2026} - * @memberof ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetails - */ - readonly queuedCheckConfigDetailsV2026: QueuedCheckConfigDetailsV2026 -} - -/** - * ServiceDeskIntegrationV2026Api - object-oriented interface - * @export - * @class ServiceDeskIntegrationV2026Api - * @extends {BaseAPI} - */ -export class ServiceDeskIntegrationV2026Api extends BaseAPI { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationV2026ApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).getStatusCheckDetails(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationV2026ApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationV2026Api - */ - public updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2026ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationV2026ApiFp(this.configuration).updateStatusCheckDetails(requestParameters.queuedCheckConfigDetailsV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SharedSignalsFrameworkSSFV2026Api - axios parameter creator - * @export - */ -export const SharedSignalsFrameworkSSFV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {CreateStreamRequestV2026} createStreamRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createStream: async (createStreamRequestV2026: CreateStreamRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createStreamRequestV2026' is not null or undefined - assertParamExists('createStream', 'createStreamRequestV2026', createStreamRequestV2026) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createStreamRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteStream: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'streamId' is not null or undefined - assertParamExists('deleteStream', 'streamId', streamId) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJWKSData: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ssf/jwks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSSFConfiguration: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/.well-known/ssf-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStream: async (streamId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {string} streamId ID of the stream whose status to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStreamStatus: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'streamId' is not null or undefined - assertParamExists('getStreamStatus', 'streamId', streamId) - const localVarPath = `/ssf/streams/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (streamId !== undefined) { - localVarQueryParameter['stream_id'] = streamId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {VerificationRequestV2026} verificationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendStreamVerification: async (verificationRequestV2026: VerificationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'verificationRequestV2026' is not null or undefined - assertParamExists('sendStreamVerification', 'verificationRequestV2026', verificationRequestV2026) - const localVarPath = `/ssf/streams/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(verificationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {ReplaceStreamConfigurationRequestV2026} replaceStreamConfigurationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setStreamConfiguration: async (replaceStreamConfigurationRequestV2026: ReplaceStreamConfigurationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'replaceStreamConfigurationRequestV2026' is not null or undefined - assertParamExists('setStreamConfiguration', 'replaceStreamConfigurationRequestV2026', replaceStreamConfigurationRequestV2026) - const localVarPath = `/ssf/streams`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(replaceStreamConfigurationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {UpdateStreamConfigurationRequestV2026} updateStreamConfigurationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamConfiguration: async (updateStreamConfigurationRequestV2026: UpdateStreamConfigurationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'updateStreamConfigurationRequestV2026' is not null or undefined - assertParamExists('updateStreamConfiguration', 'updateStreamConfigurationRequestV2026', updateStreamConfigurationRequestV2026) - const localVarPath = `/ssf/streams`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateStreamConfigurationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {UpdateStreamStatusRequestV2026} updateStreamStatusRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamStatus: async (updateStreamStatusRequestV2026: UpdateStreamStatusRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'updateStreamStatusRequestV2026' is not null or undefined - assertParamExists('updateStreamStatus', 'updateStreamStatusRequestV2026', updateStreamStatusRequestV2026) - const localVarPath = `/ssf/streams/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateStreamStatusRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SharedSignalsFrameworkSSFV2026Api - functional programming interface - * @export - */ -export const SharedSignalsFrameworkSSFV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SharedSignalsFrameworkSSFV2026ApiAxiosParamCreator(configuration) - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {CreateStreamRequestV2026} createStreamRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createStream(createStreamRequestV2026: CreateStreamRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createStream(createStreamRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.createStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteStream(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStream(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.deleteStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getJWKSData(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getJWKSData(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.getJWKSData']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSSFConfiguration(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.getSSFConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStream(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStream(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.getStream']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {string} streamId ID of the stream whose status to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStreamStatus(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamStatus(streamId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.getStreamStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {VerificationRequestV2026} verificationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendStreamVerification(verificationRequestV2026: VerificationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendStreamVerification(verificationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.sendStreamVerification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {ReplaceStreamConfigurationRequestV2026} replaceStreamConfigurationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setStreamConfiguration(replaceStreamConfigurationRequestV2026: ReplaceStreamConfigurationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setStreamConfiguration(replaceStreamConfigurationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.setStreamConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {UpdateStreamConfigurationRequestV2026} updateStreamConfigurationRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStreamConfiguration(updateStreamConfigurationRequestV2026: UpdateStreamConfigurationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamConfiguration(updateStreamConfigurationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.updateStreamConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {UpdateStreamStatusRequestV2026} updateStreamStatusRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStreamStatus(updateStreamStatusRequestV2026: UpdateStreamStatusRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamStatus(updateStreamStatusRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2026Api.updateStreamStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SharedSignalsFrameworkSSFV2026Api - factory interface - * @export - */ -export const SharedSignalsFrameworkSSFV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SharedSignalsFrameworkSSFV2026ApiFp(configuration) - return { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createStream(requestParameters.createStreamRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getJWKSData(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getJWKSData(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSSFConfiguration(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {SharedSignalsFrameworkSSFV2026ApiGetStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendStreamVerification(requestParameters.verificationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStreamStatus(requestParameters.updateStreamStatusRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createStream operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest { - /** - * - * @type {CreateStreamRequestV2026} - * @memberof SharedSignalsFrameworkSSFV2026ApiCreateStream - */ - readonly createStreamRequestV2026: CreateStreamRequestV2026 -} - -/** - * Request parameters for deleteStream operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest { - /** - * ID of the stream to delete. Required; omitted or empty returns 400. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2026ApiDeleteStream - */ - readonly streamId: string -} - -/** - * Request parameters for getStream operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiGetStreamRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiGetStreamRequest { - /** - * If provided, returns that stream; otherwise returns list of all streams. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2026ApiGetStream - */ - readonly streamId?: string -} - -/** - * Request parameters for getStreamStatus operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest { - /** - * ID of the stream whose status to retrieve. - * @type {string} - * @memberof SharedSignalsFrameworkSSFV2026ApiGetStreamStatus - */ - readonly streamId: string -} - -/** - * Request parameters for sendStreamVerification operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest { - /** - * - * @type {VerificationRequestV2026} - * @memberof SharedSignalsFrameworkSSFV2026ApiSendStreamVerification - */ - readonly verificationRequestV2026: VerificationRequestV2026 -} - -/** - * Request parameters for setStreamConfiguration operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest { - /** - * - * @type {ReplaceStreamConfigurationRequestV2026} - * @memberof SharedSignalsFrameworkSSFV2026ApiSetStreamConfiguration - */ - readonly replaceStreamConfigurationRequestV2026: ReplaceStreamConfigurationRequestV2026 -} - -/** - * Request parameters for updateStreamConfiguration operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest { - /** - * - * @type {UpdateStreamConfigurationRequestV2026} - * @memberof SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfiguration - */ - readonly updateStreamConfigurationRequestV2026: UpdateStreamConfigurationRequestV2026 -} - -/** - * Request parameters for updateStreamStatus operation in SharedSignalsFrameworkSSFV2026Api. - * @export - * @interface SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest - */ -export interface SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest { - /** - * - * @type {UpdateStreamStatusRequestV2026} - * @memberof SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatus - */ - readonly updateStreamStatusRequestV2026: UpdateStreamStatusRequestV2026 -} - -/** - * SharedSignalsFrameworkSSFV2026Api - object-oriented interface - * @export - * @class SharedSignalsFrameworkSSFV2026Api - * @extends {BaseAPI} - */ -export class SharedSignalsFrameworkSSFV2026Api extends BaseAPI { - /** - * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org. - * @summary Create stream - * @param {SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public createStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).createStream(requestParameters.createStreamRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. - * @summary Delete stream - * @param {SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public deleteStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests. - * @summary Get JWKS - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public getJWKSData(axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).getJWKSData(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the SSF transmitter discovery metadata (well-known configuration). - * @summary Get SSF configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).getSSFConfiguration(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience. - * @summary Get stream(s) - * @param {SharedSignalsFrameworkSSFV2026ApiGetStreamRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public getStream(requestParameters: SharedSignalsFrameworkSSFV2026ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).getStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required. - * @summary Get stream status - * @param {SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2026ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Verifies an SSF stream by publishing a verification event requested by a security events provider. - * @summary Verify stream - * @param {SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2026ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).sendStreamVerification(requestParameters.verificationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. - * @summary Replace stream configuration - * @param {SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2026ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. - * @summary Update stream configuration - * @param {SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2026ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. - * @summary Update stream status - * @param {SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SharedSignalsFrameworkSSFV2026Api - */ - public updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2026ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SharedSignalsFrameworkSSFV2026ApiFp(this.configuration).updateStreamStatus(requestParameters.updateStreamStatusRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourceUsagesV2026Api - axios parameter creator - * @export - */ -export const SourceUsagesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getStatusBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/status` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getUsagesBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/summaries` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * SourceUsagesV2026Api - functional programming interface - * @export - */ -export const SourceUsagesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourceUsagesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusBySourceId(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceId(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2026Api.getStatusBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceId(sourceId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesV2026Api.getUsagesBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourceUsagesV2026Api - factory interface - * @export - */ -export const SourceUsagesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourceUsagesV2026ApiFp(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2026ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId(requestParameters: SourceUsagesV2026ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2026ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId(requestParameters: SourceUsagesV2026ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getStatusBySourceId operation in SourceUsagesV2026Api. - * @export - * @interface SourceUsagesV2026ApiGetStatusBySourceIdRequest - */ -export interface SourceUsagesV2026ApiGetStatusBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2026ApiGetStatusBySourceId - */ - readonly sourceId: string -} - -/** - * Request parameters for getUsagesBySourceId operation in SourceUsagesV2026Api. - * @export - * @interface SourceUsagesV2026ApiGetUsagesBySourceIdRequest - */ -export interface SourceUsagesV2026ApiGetUsagesBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesV2026ApiGetUsagesBySourceId - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2026ApiGetUsagesBySourceId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesV2026ApiGetUsagesBySourceId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourceUsagesV2026ApiGetUsagesBySourceId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof SourceUsagesV2026ApiGetUsagesBySourceId - */ - readonly sorters?: string -} - -/** - * SourceUsagesV2026Api - object-oriented interface - * @export - * @class SourceUsagesV2026Api - * @extends {BaseAPI} - */ -export class SourceUsagesV2026Api extends BaseAPI { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesV2026ApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2026Api - */ - public getStatusBySourceId(requestParameters: SourceUsagesV2026ApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2026ApiFp(this.configuration).getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesV2026ApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesV2026Api - */ - public getUsagesBySourceId(requestParameters: SourceUsagesV2026ApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesV2026ApiFp(this.configuration).getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourcesV2026Api - axios parameter creator - * @export - */ -export const SourcesV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2026} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy: async (sourceId: string, provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2026' is not null or undefined - assertParamExists('createProvisioningPolicy', 'provisioningPolicyDtoV2026', provisioningPolicyDtoV2026) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2026} sourceV2026 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource: async (sourceV2026: SourceV2026, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceV2026' is not null or undefined - assertParamExists('createSource', 'sourceV2026', sourceV2026) - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (provisionAsCsv !== undefined) { - localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2026} schedule1V2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule: async (sourceId: string, schedule1V2026: Schedule1V2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'schedule1V2026' is not null or undefined - assertParamExists('createSourceSchedule', 'schedule1V2026', schedule1V2026) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schedule1V2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2026} schemaV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema: async (sourceId: string, schemaV2026: SchemaV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaV2026' is not null or undefined - assertParamExists('createSourceSchema', 'schemaV2026', schemaV2026) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccountsAsync', 'id', id) - const localVarPath = `/sources/{id}/remove-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule: async (sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('deleteSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('deleteSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. - * @summary Human Account Deletion Approval Config - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountDeleteApprovalConfig: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getAccountDeleteApprovalConfig', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/approval-config/account-delete` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCorrelationConfig', 'id', id) - const localVarPath = `/sources/{id}/correlation-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema: async (id: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. - * @summary Machine Account Deletion Approval Config - * @param {string} sourceId source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountDeletionApprovalConfigBySource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getMachineAccountDeletionApprovalConfigBySource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/approval-config/machine-account-delete` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNativeChangeDetectionConfig', 'id', id) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('getProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceAttrSyncConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig: async (id: string, locale?: GetSourceConfigLocaleV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceConfig', 'id', id) - const localVarPath = `/sources/{id}/connectors/source-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceConnections', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connections` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a dataset by id for the specified source in Identity Security Cloud (ISC). - * @summary Get source dataset by id - * @param {string} sourceId Source ID. - * @param {string} datasetId Dataset ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceDataset: async (sourceId: string, datasetId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceDataset', 'sourceId', sourceId) - // verify required parameter 'datasetId' is not null or undefined - assertParamExists('getSourceDataset', 'datasetId', datasetId) - const localVarPath = `/sources/{sourceId}/datasets/{datasetId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"datasetId"}}`, encodeURIComponent(String(datasetId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list datasets for the specified source in Identity Security Cloud (ISC). - * @summary List datasets on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceDatasets: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceDatasets', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/datasets` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSourceEntitlementRequestConfig', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceHealth', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/source-health` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a resource by id on the specified source in Identity Security Cloud (ISC). The response includes the full CIS schema for the resource. - * @summary Get source resource by id - * @param {string} sourceId Source ID. - * @param {string} resourceId Resource ID (CIS schema object type for the source). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceResource: async (sourceId: string, resourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceResource', 'sourceId', sourceId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('getSourceResource', 'resourceId', resourceId) - const localVarPath = `/sources/{sourceId}/resources/{resourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list resources defined on the specified source in Identity Security Cloud (ISC). - * @summary List resources for a source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceResources: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceResources', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/resources` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule: async (sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('getSourceSchedule', 'scheduleType', scheduleType) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchedules', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schedules` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('getSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2026} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas: async (sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2026, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchemas', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeTypes !== undefined) { - localVarQueryParameter['include-types'] = includeTypes; - } - - if (includeNames !== undefined) { - localVarQueryParameter['include-names'] = includeNames; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts: async (id: string, file?: File, disableOptimization?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - if (disableOptimization !== undefined) { - localVarFormParams.append('disableOptimization', disableOptimization as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importConnectorFile', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/upload-connector-file` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importEntitlements', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/load-entitlements` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema: async (id: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importUncorrelatedAccounts', 'id', id) - const localVarPath = `/sources/{id}/load-uncorrelated-accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {string} sourceId The Source id - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicyHoldersOnSource: async (sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listPasswordPolicyHoldersOnSource', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/password-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies: async (sourceId: string, offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listProvisioningPolicies', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (includeIDNSource !== undefined) { - localVarQueryParameter['includeIDNSource'] = includeIDNSource; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('pingCluster', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/ping-cluster` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2026} correlationConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig: async (id: string, correlationConfigV2026: CorrelationConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putCorrelationConfig', 'id', id) - // verify required parameter 'correlationConfigV2026' is not null or undefined - assertParamExists('putCorrelationConfig', 'correlationConfigV2026', correlationConfigV2026) - const localVarPath = `/sources/{id}/correlation-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(correlationConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2026} nativeChangeDetectionConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig: async (id: string, nativeChangeDetectionConfigV2026: NativeChangeDetectionConfigV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'id', id) - // verify required parameter 'nativeChangeDetectionConfigV2026' is not null or undefined - assertParamExists('putNativeChangeDetectionConfig', 'nativeChangeDetectionConfigV2026', nativeChangeDetectionConfigV2026) - const localVarPath = `/sources/{sourceId}/native-change-detection-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nativeChangeDetectionConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2026} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2026, provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('putProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'provisioningPolicyDtoV2026' is not null or undefined - assertParamExists('putProvisioningPolicy', 'provisioningPolicyDtoV2026', provisioningPolicyDtoV2026) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2026} sourceV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource: async (id: string, sourceV2026: SourceV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSource', 'id', id) - // verify required parameter 'sourceV2026' is not null or undefined - assertParamExists('putSource', 'sourceV2026', sourceV2026) - const localVarPath = `/sources/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2026} attrSyncSourceConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig: async (id: string, attrSyncSourceConfigV2026: AttrSyncSourceConfigV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'id', id) - // verify required parameter 'attrSyncSourceConfigV2026' is not null or undefined - assertParamExists('putSourceAttrSyncConfig', 'attrSyncSourceConfigV2026', attrSyncSourceConfigV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/attribute-sync-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(attrSyncSourceConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2026} schemaV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema: async (sourceId: string, schemaId: string, schemaV2026: SchemaV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('putSourceSchema', 'schemaId', schemaId) - // verify required parameter 'schemaV2026' is not null or undefined - assertParamExists('putSourceSchema', 'schemaV2026', schemaV2026) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schemaV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2026} resourceObjectsRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects: async (sourceId: string, resourceObjectsRequestV2026: ResourceObjectsRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('searchResourceObjects', 'sourceId', sourceId) - // verify required parameter 'resourceObjectsRequestV2026' is not null or undefined - assertParamExists('searchResourceObjects', 'resourceObjectsRequestV2026', resourceObjectsRequestV2026) - const localVarPath = `/sources/{sourceId}/connector/peek-resource-objects` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(resourceObjectsRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('syncAttributesForSource', 'id', id) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/synchronize-attributes` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConfiguration', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/test-configuration` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('testSourceConnection', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connector/check-connection` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. - * @summary Human Account Deletion Approval Config - * @param {string} sourceId Human account source ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccountDeletionApprovalConfig: async (sourceId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateAccountDeletionApprovalConfig', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateAccountDeletionApprovalConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{sourceId}/approval-config/account-delete` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. - * @summary Machine Account Deletion Approval Config - * @param {string} sourceId machine account source ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccountDeletionApprovalConfig: async (sourceId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateMachineAccountDeletionApprovalConfig', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateMachineAccountDeletionApprovalConfig', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{sourceId}/approval-config/machine-account-delete` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders: async (sourceId: string, passwordPolicyHoldersDtoInnerV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'sourceId', sourceId) - // verify required parameter 'passwordPolicyHoldersDtoInnerV2026' is not null or undefined - assertParamExists('updatePasswordPolicyHolders', 'passwordPolicyHoldersDtoInnerV2026', passwordPolicyHoldersDtoInnerV2026) - const localVarPath = `/sources/{sourceId}/password-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyHoldersDtoInnerV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk: async (sourceId: string, provisioningPolicyDtoV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDtoV2026' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'provisioningPolicyDtoV2026', provisioningPolicyDtoV2026) - const localVarPath = `/sources/{sourceId}/provisioning-policies/bulk-update` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy: async (sourceId: string, usageType: UsageTypeV2026, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2026 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSource', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateSource', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2026} sourceEntitlementRequestConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig: async (id: string, sourceEntitlementRequestConfigV2026: SourceEntitlementRequestConfigV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'id', id) - // verify required parameter 'sourceEntitlementRequestConfigV2026' is not null or undefined - assertParamExists('updateSourceEntitlementRequestConfig', 'sourceEntitlementRequestConfigV2026', sourceEntitlementRequestConfigV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/sources/{id}/entitlement-request-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sourceEntitlementRequestConfigV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule: async (sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2026, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchedule', 'sourceId', sourceId) - // verify required parameter 'scheduleType' is not null or undefined - assertParamExists('updateSourceSchedule', 'scheduleType', scheduleType) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateSourceSchedule', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{sourceId}/schedules/{scheduleType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"scheduleType"}}`, encodeURIComponent(String(scheduleType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema: async (sourceId: string, schemaId: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('updateSourceSchema', 'schemaId', schemaId) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateSourceSchema', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SourcesV2026Api - functional programming interface - * @export - */ -export const SourcesV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourcesV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDtoV2026} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createProvisioningPolicy(sourceId: string, provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicy(sourceId, provisioningPolicyDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.createProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourceV2026} sourceV2026 - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSource(sourceV2026: SourceV2026, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSource(sourceV2026, provisionAsCsv, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.createSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {string} sourceId Source ID. - * @param {Schedule1V2026} schedule1V2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchedule(sourceId: string, schedule1V2026: Schedule1V2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchedule(sourceId, schedule1V2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.createSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {SchemaV2026} schemaV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchema(sourceId: string, schemaV2026: SchemaV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchema(sourceId, schemaV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.createSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccountsAsync(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccountsAsync(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteAccountsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteProvisioningPolicy(sourceId: string, usageType: UsageTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schedule by type. - * @param {string} sourceId The Source id. - * @param {DeleteSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchedule(sourceId: string, scheduleType: DeleteSourceScheduleScheduleTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.deleteSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. - * @summary Human Account Deletion Approval Config - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountDeleteApprovalConfig(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountDeleteApprovalConfig(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getAccountDeleteApprovalConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountsSchema(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountsSchema(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCorrelationConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCorrelationConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsSchema(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsSchema(id, schemaName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. - * @summary Machine Account Deletion Approval Config - * @param {string} sourceId source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMachineAccountDeletionApprovalConfigBySource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMachineAccountDeletionApprovalConfigBySource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getMachineAccountDeletionApprovalConfigBySource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {string} id The source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNativeChangeDetectionConfig(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNativeChangeDetectionConfig(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProvisioningPolicy(sourceId: string, usageType: UsageTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {string} id The source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceAttrSyncConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceAttrSyncConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {string} id The Source id - * @param {GetSourceConfigLocaleV2026} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConfig(id: string, locale?: GetSourceConfigLocaleV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConfig(id, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a dataset by id for the specified source in Identity Security Cloud (ISC). - * @summary Get source dataset by id - * @param {string} sourceId Source ID. - * @param {string} datasetId Dataset ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceDataset(sourceId: string, datasetId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceDataset(sourceId, datasetId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceDataset']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list datasets for the specified source in Identity Security Cloud (ISC). - * @summary List datasets on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceDatasets(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceDatasets(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceDatasets']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceEntitlementRequestConfig(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceEntitlementRequestConfig(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceHealth(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceHealth(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceHealth']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a resource by id on the specified source in Identity Security Cloud (ISC). The response includes the full CIS schema for the resource. - * @summary Get source resource by id - * @param {string} sourceId Source ID. - * @param {string} resourceId Resource ID (CIS schema object type for the source). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceResource(sourceId: string, resourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceResource(sourceId, resourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceResource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list resources defined on the specified source in Identity Security Cloud (ISC). - * @summary List resources for a source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceResources(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceResources(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceResources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {string} sourceId The Source id. - * @param {GetSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedule(sourceId: string, scheduleType: GetSourceScheduleScheduleTypeV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedule(sourceId, scheduleType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchedules(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchedules(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceSchedules']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV2026} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchemas(sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV2026, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemas(sourceId, includeTypes, includeNames, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.getSourceSchemas']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {string} id Source Id - * @param {File} [file] The CSV file containing the source accounts to aggregate. - * @param {string} [disableOptimization] Use this flag to reprocess every account whether or not the data has changed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccounts(id: string, file?: File, disableOptimization?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccounts(id, file, disableOptimization, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccountsSchema(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsSchema(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importConnectorFile(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importConnectorFile(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importConnectorFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {string} sourceId Source Id - * @param {File} [file] The CSV file containing the source entitlements to aggregate. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlements(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlements(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlementsSchema(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsSchema(id, schemaName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {string} id Source Id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importUncorrelatedAccounts(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importUncorrelatedAccounts(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.importUncorrelatedAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {string} sourceId The Source id - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicyHoldersOnSource(sourceId: string, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicyHoldersOnSource(sourceId, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.listPasswordPolicyHoldersOnSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listProvisioningPolicies(sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPolicies(sourceId, offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.listProvisioningPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSources(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSources(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.listSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingCluster(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingCluster(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.pingCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {string} id The source id - * @param {CorrelationConfigV2026} correlationConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putCorrelationConfig(id: string, correlationConfigV2026: CorrelationConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putCorrelationConfig(id, correlationConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putCorrelationConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {string} id The source id - * @param {NativeChangeDetectionConfigV2026} nativeChangeDetectionConfigV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putNativeChangeDetectionConfig(id: string, nativeChangeDetectionConfigV2026: NativeChangeDetectionConfigV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putNativeChangeDetectionConfig(id, nativeChangeDetectionConfigV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putNativeChangeDetectionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDtoV2026} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putProvisioningPolicy(sourceId: string, usageType: UsageTypeV2026, provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicy(sourceId, usageType, provisioningPolicyDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {SourceV2026} sourceV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSource(id: string, sourceV2026: SourceV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSource(id, sourceV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {string} id The source id - * @param {AttrSyncSourceConfigV2026} attrSyncSourceConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceAttrSyncConfig(id: string, attrSyncSourceConfigV2026: AttrSyncSourceConfigV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceAttrSyncConfig(id, attrSyncSourceConfigV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putSourceAttrSyncConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {SchemaV2026} schemaV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceSchema(sourceId: string, schemaId: string, schemaV2026: SchemaV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchema(sourceId, schemaId, schemaV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.putSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {string} sourceId The ID of the Source - * @param {ResourceObjectsRequestV2026} resourceObjectsRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchResourceObjects(sourceId: string, resourceObjectsRequestV2026: ResourceObjectsRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchResourceObjects(sourceId, resourceObjectsRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.searchResourceObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {string} id The Source id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncAttributesForSource(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncAttributesForSource(id, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.syncAttributesForSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {string} sourceId The ID of the Source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConfiguration(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConfiguration(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.testSourceConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {string} sourceId The ID of the Source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSourceConnection(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSourceConnection(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.testSourceConnection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. - * @summary Human Account Deletion Approval Config - * @param {string} sourceId Human account source ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccountDeletionApprovalConfig(sourceId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccountDeletionApprovalConfig(sourceId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateAccountDeletionApprovalConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. - * @summary Machine Account Deletion Approval Config - * @param {string} sourceId machine account source ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateMachineAccountDeletionApprovalConfig(sourceId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMachineAccountDeletionApprovalConfig(sourceId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateMachineAccountDeletionApprovalConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {string} sourceId The Source id - * @param {Array} passwordPolicyHoldersDtoInnerV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordPolicyHolders(sourceId: string, passwordPolicyHoldersDtoInnerV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordPolicyHolders(sourceId, passwordPolicyHoldersDtoInnerV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updatePasswordPolicyHolders']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDtoV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulk(sourceId, provisioningPolicyDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateProvisioningPoliciesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageTypeV2026} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPolicy(sourceId: string, usageType: UsageTypeV2026, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicy(sourceId, usageType, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperationV2026 A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSource(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSource(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {string} id The Source id - * @param {SourceEntitlementRequestConfigV2026} sourceEntitlementRequestConfigV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceEntitlementRequestConfig(id: string, sourceEntitlementRequestConfigV2026: SourceEntitlementRequestConfigV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceEntitlementRequestConfig(id, sourceEntitlementRequestConfigV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateSourceEntitlementRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {string} sourceId The Source id. - * @param {UpdateSourceScheduleScheduleTypeV2026} scheduleType The Schedule type. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schedule. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchedule(sourceId: string, scheduleType: UpdateSourceScheduleScheduleTypeV2026, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchedule(sourceId, scheduleType, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateSourceSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchema(sourceId, schemaId, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesV2026Api.updateSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourcesV2026Api - factory interface - * @export - */ -export const SourcesV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourcesV2026ApiFp(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2026ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy(requestParameters: SourcesV2026ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2026ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource(requestParameters: SourcesV2026ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSource(requestParameters.sourceV2026, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2026ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchedule(requestParameters: SourcesV2026ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2026ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema(requestParameters: SourcesV2026ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2026ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccountsAsync(requestParameters: SourcesV2026ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2026ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy(requestParameters: SourcesV2026ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2026ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource(requestParameters: SourcesV2026ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2026ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchedule(requestParameters: SourcesV2026ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schema by id - * @param {SourcesV2026ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema(requestParameters: SourcesV2026ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. - * @summary Human Account Deletion Approval Config - * @param {SourcesV2026ApiGetAccountDeleteApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountDeleteApprovalConfig(requestParameters: SourcesV2026ApiGetAccountDeleteApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountDeleteApprovalConfig(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2026ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema(requestParameters: SourcesV2026ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2026ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCorrelationConfig(requestParameters: SourcesV2026ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2026ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema(requestParameters: SourcesV2026ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. - * @summary Machine Account Deletion Approval Config - * @param {SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMachineAccountDeletionApprovalConfigBySource(requestParameters: SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMachineAccountDeletionApprovalConfigBySource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2026ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2026ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy(requestParameters: SourcesV2026ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2026ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource(requestParameters: SourcesV2026ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2026ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceAttrSyncConfig(requestParameters: SourcesV2026ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2026ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConfig(requestParameters: SourcesV2026ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2026ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections(requestParameters: SourcesV2026ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a dataset by id for the specified source in Identity Security Cloud (ISC). - * @summary Get source dataset by id - * @param {SourcesV2026ApiGetSourceDatasetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceDataset(requestParameters: SourcesV2026ApiGetSourceDatasetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceDataset(requestParameters.sourceId, requestParameters.datasetId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list datasets for the specified source in Identity Security Cloud (ISC). - * @summary List datasets on source - * @param {SourcesV2026ApiGetSourceDatasetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceDatasets(requestParameters: SourcesV2026ApiGetSourceDatasetsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceDatasets(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2026ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceEntitlementRequestConfig(requestParameters: SourcesV2026ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2026ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth(requestParameters: SourcesV2026ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a resource by id on the specified source in Identity Security Cloud (ISC). The response includes the full CIS schema for the resource. - * @summary Get source resource by id - * @param {SourcesV2026ApiGetSourceResourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceResource(requestParameters: SourcesV2026ApiGetSourceResourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceResource(requestParameters.sourceId, requestParameters.resourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list resources defined on the specified source in Identity Security Cloud (ISC). - * @summary List resources for a source - * @param {SourcesV2026ApiGetSourceResourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceResources(requestParameters: SourcesV2026ApiGetSourceResourcesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceResources(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2026ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedule(requestParameters: SourcesV2026ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2026ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchedules(requestParameters: SourcesV2026ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2026ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema(requestParameters: SourcesV2026ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2026ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas(requestParameters: SourcesV2026ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2026ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccounts(requestParameters: SourcesV2026ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2026ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema(requestParameters: SourcesV2026ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2026ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile(requestParameters: SourcesV2026ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2026ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlements(requestParameters: SourcesV2026ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2026ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema(requestParameters: SourcesV2026ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2026ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importUncorrelatedAccounts(requestParameters: SourcesV2026ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicyHoldersOnSource(requestParameters: SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicyHoldersOnSource(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2026ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies(requestParameters: SourcesV2026ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listProvisioningPolicies(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2026ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources(requestParameters: SourcesV2026ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2026ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingCluster(requestParameters: SourcesV2026ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2026ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putCorrelationConfig(requestParameters: SourcesV2026ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2026ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2026ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy(requestParameters: SourcesV2026ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2026ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource(requestParameters: SourcesV2026ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSource(requestParameters.id, requestParameters.sourceV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2026ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceAttrSyncConfig(requestParameters: SourcesV2026ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2026ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema(requestParameters: SourcesV2026ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2026ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchResourceObjects(requestParameters: SourcesV2026ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2026ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncAttributesForSource(requestParameters: SourcesV2026ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2026ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConfiguration(requestParameters: SourcesV2026ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2026ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSourceConnection(requestParameters: SourcesV2026ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. - * @summary Human Account Deletion Approval Config - * @param {SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccountDeletionApprovalConfig(requestParameters: SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccountDeletionApprovalConfig(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. - * @summary Machine Account Deletion Approval Config - * @param {SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateMachineAccountDeletionApprovalConfig(requestParameters: SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateMachineAccountDeletionApprovalConfig(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2026ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordPolicyHolders(requestParameters: SourcesV2026ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk(requestParameters: SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2026ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy(requestParameters: SourcesV2026ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2026ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource(requestParameters: SourcesV2026ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceEntitlementRequestConfig(requestParameters: SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2026ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchedule(requestParameters: SourcesV2026ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2026ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema(requestParameters: SourcesV2026ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createProvisioningPolicy operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiCreateProvisioningPolicyRequest - */ -export interface SourcesV2026ApiCreateProvisioningPolicyRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiCreateProvisioningPolicy - */ - readonly sourceId: string - - /** - * - * @type {ProvisioningPolicyDtoV2026} - * @memberof SourcesV2026ApiCreateProvisioningPolicy - */ - readonly provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026 -} - -/** - * Request parameters for createSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiCreateSourceRequest - */ -export interface SourcesV2026ApiCreateSourceRequest { - /** - * - * @type {SourceV2026} - * @memberof SourcesV2026ApiCreateSource - */ - readonly sourceV2026: SourceV2026 - - /** - * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @type {boolean} - * @memberof SourcesV2026ApiCreateSource - */ - readonly provisionAsCsv?: boolean -} - -/** - * Request parameters for createSourceSchedule operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiCreateSourceScheduleRequest - */ -export interface SourcesV2026ApiCreateSourceScheduleRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiCreateSourceSchedule - */ - readonly sourceId: string - - /** - * - * @type {Schedule1V2026} - * @memberof SourcesV2026ApiCreateSourceSchedule - */ - readonly schedule1V2026: Schedule1V2026 -} - -/** - * Request parameters for createSourceSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiCreateSourceSchemaRequest - */ -export interface SourcesV2026ApiCreateSourceSchemaRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiCreateSourceSchema - */ - readonly sourceId: string - - /** - * - * @type {SchemaV2026} - * @memberof SourcesV2026ApiCreateSourceSchema - */ - readonly schemaV2026: SchemaV2026 -} - -/** - * Request parameters for deleteAccountsAsync operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteAccountsAsyncRequest - */ -export interface SourcesV2026ApiDeleteAccountsAsyncRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiDeleteAccountsAsync - */ - readonly id: string -} - -/** - * Request parameters for deleteNativeChangeDetectionConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest - */ -export interface SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiDeleteNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for deleteProvisioningPolicy operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteProvisioningPolicyRequest - */ -export interface SourcesV2026ApiDeleteProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2026ApiDeleteProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2026} - * @memberof SourcesV2026ApiDeleteProvisioningPolicy - */ - readonly usageType: UsageTypeV2026 -} - -/** - * Request parameters for deleteSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteSourceRequest - */ -export interface SourcesV2026ApiDeleteSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiDeleteSource - */ - readonly id: string -} - -/** - * Request parameters for deleteSourceSchedule operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteSourceScheduleRequest - */ -export interface SourcesV2026ApiDeleteSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiDeleteSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2026ApiDeleteSourceSchedule - */ - readonly scheduleType: DeleteSourceScheduleScheduleTypeV2026 -} - -/** - * Request parameters for deleteSourceSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiDeleteSourceSchemaRequest - */ -export interface SourcesV2026ApiDeleteSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiDeleteSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2026ApiDeleteSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getAccountDeleteApprovalConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetAccountDeleteApprovalConfigRequest - */ -export interface SourcesV2026ApiGetAccountDeleteApprovalConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiGetAccountDeleteApprovalConfig - */ - readonly sourceId: string -} - -/** - * Request parameters for getAccountsSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetAccountsSchemaRequest - */ -export interface SourcesV2026ApiGetAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiGetAccountsSchema - */ - readonly id: string -} - -/** - * Request parameters for getCorrelationConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetCorrelationConfigRequest - */ -export interface SourcesV2026ApiGetCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiGetCorrelationConfig - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementsSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetEntitlementsSchemaRequest - */ -export interface SourcesV2026ApiGetEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiGetEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2026ApiGetEntitlementsSchema - */ - readonly schemaName?: string -} - -/** - * Request parameters for getMachineAccountDeletionApprovalConfigBySource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest - */ -export interface SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest { - /** - * source id. - * @type {string} - * @memberof SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNativeChangeDetectionConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetNativeChangeDetectionConfigRequest - */ -export interface SourcesV2026ApiGetNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiGetNativeChangeDetectionConfig - */ - readonly id: string -} - -/** - * Request parameters for getProvisioningPolicy operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetProvisioningPolicyRequest - */ -export interface SourcesV2026ApiGetProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2026} - * @memberof SourcesV2026ApiGetProvisioningPolicy - */ - readonly usageType: UsageTypeV2026 -} - -/** - * Request parameters for getSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceRequest - */ -export interface SourcesV2026ApiGetSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSource - */ - readonly id: string -} - -/** - * Request parameters for getSourceAttrSyncConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceAttrSyncConfigRequest - */ -export interface SourcesV2026ApiGetSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiGetSourceAttrSyncConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2026ApiGetSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceConfigRequest - */ -export interface SourcesV2026ApiGetSourceConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiGetSourceConfig - */ - readonly id: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof SourcesV2026ApiGetSourceConfig - */ - readonly locale?: GetSourceConfigLocaleV2026 -} - -/** - * Request parameters for getSourceConnections operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceConnectionsRequest - */ -export interface SourcesV2026ApiGetSourceConnectionsRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceConnections - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceDataset operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceDatasetRequest - */ -export interface SourcesV2026ApiGetSourceDatasetRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceDataset - */ - readonly sourceId: string - - /** - * Dataset ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceDataset - */ - readonly datasetId: string -} - -/** - * Request parameters for getSourceDatasets operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceDatasetsRequest - */ -export interface SourcesV2026ApiGetSourceDatasetsRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceDatasets - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceEntitlementRequestConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2026ApiGetSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiGetSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2026ApiGetSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getSourceHealth operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceHealthRequest - */ -export interface SourcesV2026ApiGetSourceHealthRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiGetSourceHealth - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceResource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceResourceRequest - */ -export interface SourcesV2026ApiGetSourceResourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceResource - */ - readonly sourceId: string - - /** - * Resource ID (CIS schema object type for the source). - * @type {string} - * @memberof SourcesV2026ApiGetSourceResource - */ - readonly resourceId: string -} - -/** - * Request parameters for getSourceResources operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceResourcesRequest - */ -export interface SourcesV2026ApiGetSourceResourcesRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceResources - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchedule operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceScheduleRequest - */ -export interface SourcesV2026ApiGetSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2026ApiGetSourceSchedule - */ - readonly scheduleType: GetSourceScheduleScheduleTypeV2026 -} - -/** - * Request parameters for getSourceSchedules operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceSchedulesRequest - */ -export interface SourcesV2026ApiGetSourceSchedulesRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchedules - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceSchemaRequest - */ -export interface SourcesV2026ApiGetSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getSourceSchemas operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiGetSourceSchemasRequest - */ -export interface SourcesV2026ApiGetSourceSchemasRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchemas - */ - readonly sourceId: string - - /** - * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @type {'group' | 'user'} - * @memberof SourcesV2026ApiGetSourceSchemas - */ - readonly includeTypes?: GetSourceSchemasIncludeTypesV2026 - - /** - * A comma-separated list of schema names to filter result. - * @type {string} - * @memberof SourcesV2026ApiGetSourceSchemas - */ - readonly includeNames?: string -} - -/** - * Request parameters for importAccounts operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportAccountsRequest - */ -export interface SourcesV2026ApiImportAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2026ApiImportAccounts - */ - readonly id: string - - /** - * The CSV file containing the source accounts to aggregate. - * @type {File} - * @memberof SourcesV2026ApiImportAccounts - */ - readonly file?: File - - /** - * Use this flag to reprocess every account whether or not the data has changed. - * @type {string} - * @memberof SourcesV2026ApiImportAccounts - */ - readonly disableOptimization?: string -} - -/** - * Request parameters for importAccountsSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportAccountsSchemaRequest - */ -export interface SourcesV2026ApiImportAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiImportAccountsSchema - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2026ApiImportAccountsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importConnectorFile operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportConnectorFileRequest - */ -export interface SourcesV2026ApiImportConnectorFileRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiImportConnectorFile - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesV2026ApiImportConnectorFile - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlements operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportEntitlementsRequest - */ -export interface SourcesV2026ApiImportEntitlementsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2026ApiImportEntitlements - */ - readonly sourceId: string - - /** - * The CSV file containing the source entitlements to aggregate. - * @type {File} - * @memberof SourcesV2026ApiImportEntitlements - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlementsSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportEntitlementsSchemaRequest - */ -export interface SourcesV2026ApiImportEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiImportEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesV2026ApiImportEntitlementsSchema - */ - readonly schemaName?: string - - /** - * - * @type {File} - * @memberof SourcesV2026ApiImportEntitlementsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importUncorrelatedAccounts operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiImportUncorrelatedAccountsRequest - */ -export interface SourcesV2026ApiImportUncorrelatedAccountsRequest { - /** - * Source Id - * @type {string} - * @memberof SourcesV2026ApiImportUncorrelatedAccounts - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesV2026ApiImportUncorrelatedAccounts - */ - readonly file?: File -} - -/** - * Request parameters for listPasswordPolicyHoldersOnSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest - */ -export interface SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiListPasswordPolicyHoldersOnSource - */ - readonly sourceId: string - - /** - * 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 SourcesV2026ApiListPasswordPolicyHoldersOnSource - */ - 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 SourcesV2026ApiListPasswordPolicyHoldersOnSource - */ - 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 SourcesV2026ApiListPasswordPolicyHoldersOnSource - */ - readonly count?: boolean -} - -/** - * Request parameters for listProvisioningPolicies operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiListProvisioningPoliciesRequest - */ -export interface SourcesV2026ApiListProvisioningPoliciesRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiListProvisioningPolicies - */ - readonly sourceId: string - - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof SourcesV2026ApiListProvisioningPolicies - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SourcesV2026ApiListProvisioningPolicies - */ - readonly limit?: number -} - -/** - * Request parameters for listSources operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiListSourcesRequest - */ -export interface SourcesV2026ApiListSourcesRequest { - /** - * 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 SourcesV2026ApiListSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourcesV2026ApiListSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourcesV2026ApiListSources - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof SourcesV2026ApiListSources - */ - 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @type {string} - * @memberof SourcesV2026ApiListSources - */ - readonly sorters?: string - - /** - * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @type {string} - * @memberof SourcesV2026ApiListSources - */ - readonly forSubadmin?: string - - /** - * Include the IdentityNow source in the response. - * @type {boolean} - * @memberof SourcesV2026ApiListSources - */ - readonly includeIDNSource?: boolean -} - -/** - * Request parameters for pingCluster operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPingClusterRequest - */ -export interface SourcesV2026ApiPingClusterRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2026ApiPingCluster - */ - readonly sourceId: string -} - -/** - * Request parameters for putCorrelationConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutCorrelationConfigRequest - */ -export interface SourcesV2026ApiPutCorrelationConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiPutCorrelationConfig - */ - readonly id: string - - /** - * - * @type {CorrelationConfigV2026} - * @memberof SourcesV2026ApiPutCorrelationConfig - */ - readonly correlationConfigV2026: CorrelationConfigV2026 -} - -/** - * Request parameters for putNativeChangeDetectionConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutNativeChangeDetectionConfigRequest - */ -export interface SourcesV2026ApiPutNativeChangeDetectionConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiPutNativeChangeDetectionConfig - */ - readonly id: string - - /** - * - * @type {NativeChangeDetectionConfigV2026} - * @memberof SourcesV2026ApiPutNativeChangeDetectionConfig - */ - readonly nativeChangeDetectionConfigV2026: NativeChangeDetectionConfigV2026 -} - -/** - * Request parameters for putProvisioningPolicy operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutProvisioningPolicyRequest - */ -export interface SourcesV2026ApiPutProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesV2026ApiPutProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2026} - * @memberof SourcesV2026ApiPutProvisioningPolicy - */ - readonly usageType: UsageTypeV2026 - - /** - * - * @type {ProvisioningPolicyDtoV2026} - * @memberof SourcesV2026ApiPutProvisioningPolicy - */ - readonly provisioningPolicyDtoV2026: ProvisioningPolicyDtoV2026 -} - -/** - * Request parameters for putSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutSourceRequest - */ -export interface SourcesV2026ApiPutSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiPutSource - */ - readonly id: string - - /** - * - * @type {SourceV2026} - * @memberof SourcesV2026ApiPutSource - */ - readonly sourceV2026: SourceV2026 -} - -/** - * Request parameters for putSourceAttrSyncConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutSourceAttrSyncConfigRequest - */ -export interface SourcesV2026ApiPutSourceAttrSyncConfigRequest { - /** - * The source id - * @type {string} - * @memberof SourcesV2026ApiPutSourceAttrSyncConfig - */ - readonly id: string - - /** - * - * @type {AttrSyncSourceConfigV2026} - * @memberof SourcesV2026ApiPutSourceAttrSyncConfig - */ - readonly attrSyncSourceConfigV2026: AttrSyncSourceConfigV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2026ApiPutSourceAttrSyncConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putSourceSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiPutSourceSchemaRequest - */ -export interface SourcesV2026ApiPutSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiPutSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2026ApiPutSourceSchema - */ - readonly schemaId: string - - /** - * - * @type {SchemaV2026} - * @memberof SourcesV2026ApiPutSourceSchema - */ - readonly schemaV2026: SchemaV2026 -} - -/** - * Request parameters for searchResourceObjects operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiSearchResourceObjectsRequest - */ -export interface SourcesV2026ApiSearchResourceObjectsRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2026ApiSearchResourceObjects - */ - readonly sourceId: string - - /** - * - * @type {ResourceObjectsRequestV2026} - * @memberof SourcesV2026ApiSearchResourceObjects - */ - readonly resourceObjectsRequestV2026: ResourceObjectsRequestV2026 -} - -/** - * Request parameters for syncAttributesForSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiSyncAttributesForSourceRequest - */ -export interface SourcesV2026ApiSyncAttributesForSourceRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiSyncAttributesForSource - */ - readonly id: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2026ApiSyncAttributesForSource - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for testSourceConfiguration operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiTestSourceConfigurationRequest - */ -export interface SourcesV2026ApiTestSourceConfigurationRequest { - /** - * The ID of the Source - * @type {string} - * @memberof SourcesV2026ApiTestSourceConfiguration - */ - readonly sourceId: string -} - -/** - * Request parameters for testSourceConnection operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiTestSourceConnectionRequest - */ -export interface SourcesV2026ApiTestSourceConnectionRequest { - /** - * The ID of the Source. - * @type {string} - * @memberof SourcesV2026ApiTestSourceConnection - */ - readonly sourceId: string -} - -/** - * Request parameters for updateAccountDeletionApprovalConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest - */ -export interface SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest { - /** - * Human account source ID. - * @type {string} - * @memberof SourcesV2026ApiUpdateAccountDeletionApprovalConfig - */ - readonly sourceId: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof SourcesV2026ApiUpdateAccountDeletionApprovalConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateMachineAccountDeletionApprovalConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest - */ -export interface SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest { - /** - * machine account source ID. - * @type {string} - * @memberof SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfig - */ - readonly sourceId: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfig - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updatePasswordPolicyHolders operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdatePasswordPolicyHoldersRequest - */ -export interface SourcesV2026ApiUpdatePasswordPolicyHoldersRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiUpdatePasswordPolicyHolders - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2026ApiUpdatePasswordPolicyHolders - */ - readonly passwordPolicyHoldersDtoInnerV2026: Array -} - -/** - * Request parameters for updateProvisioningPoliciesInBulk operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest - */ -export interface SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiUpdateProvisioningPoliciesInBulk - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesV2026ApiUpdateProvisioningPoliciesInBulk - */ - readonly provisioningPolicyDtoV2026: Array -} - -/** - * Request parameters for updateProvisioningPolicy operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateProvisioningPolicyRequest - */ -export interface SourcesV2026ApiUpdateProvisioningPolicyRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiUpdateProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageTypeV2026} - * @memberof SourcesV2026ApiUpdateProvisioningPolicy - */ - readonly usageType: UsageTypeV2026 - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2026ApiUpdateProvisioningPolicy - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateSource operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateSourceRequest - */ -export interface SourcesV2026ApiUpdateSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesV2026ApiUpdateSource - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @type {Array} - * @memberof SourcesV2026ApiUpdateSource - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateSourceEntitlementRequestConfig operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest - */ -export interface SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesV2026ApiUpdateSourceEntitlementRequestConfig - */ - readonly id: string - - /** - * - * @type {SourceEntitlementRequestConfigV2026} - * @memberof SourcesV2026ApiUpdateSourceEntitlementRequestConfig - */ - readonly sourceEntitlementRequestConfigV2026: SourceEntitlementRequestConfigV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof SourcesV2026ApiUpdateSourceEntitlementRequestConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for updateSourceSchedule operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateSourceScheduleRequest - */ -export interface SourcesV2026ApiUpdateSourceScheduleRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiUpdateSourceSchedule - */ - readonly sourceId: string - - /** - * The Schedule type. - * @type {'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'} - * @memberof SourcesV2026ApiUpdateSourceSchedule - */ - readonly scheduleType: UpdateSourceScheduleScheduleTypeV2026 - - /** - * The JSONPatch payload used to update the schedule. - * @type {Array} - * @memberof SourcesV2026ApiUpdateSourceSchedule - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for updateSourceSchema operation in SourcesV2026Api. - * @export - * @interface SourcesV2026ApiUpdateSourceSchemaRequest - */ -export interface SourcesV2026ApiUpdateSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesV2026ApiUpdateSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesV2026ApiUpdateSourceSchema - */ - readonly schemaId: string - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesV2026ApiUpdateSourceSchema - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * SourcesV2026Api - object-oriented interface - * @export - * @class SourcesV2026Api - * @extends {BaseAPI} - */ -export class SourcesV2026Api extends BaseAPI { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesV2026ApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public createProvisioningPolicy(requestParameters: SourcesV2026ApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesV2026ApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public createSource(requestParameters: SourcesV2026ApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).createSource(requestParameters.sourceV2026, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). - * @summary Create schedule on source - * @param {SourcesV2026ApiCreateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public createSourceSchedule(requestParameters: SourcesV2026ApiCreateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).createSourceSchedule(requestParameters.sourceId, requestParameters.schedule1V2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesV2026ApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public createSourceSchema(requestParameters: SourcesV2026ApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).createSourceSchema(requestParameters.sourceId, requestParameters.schemaV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: * Removing accounts that no longer exist on the source. * Removing accounts that won\'t be aggregated following updates to the source configuration. * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - * @summary Remove all accounts in source - * @param {SourcesV2026ApiDeleteAccountsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteAccountsAsync(requestParameters: SourcesV2026ApiDeleteAccountsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteAccountsAsync(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the native change detection configuration for the source specified by the given ID. - * @summary Delete native change detection configuration - * @param {SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiDeleteNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesV2026ApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteProvisioningPolicy(requestParameters: SourcesV2026ApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesV2026ApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteSource(requestParameters: SourcesV2026ApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schedule by type. - * @param {SourcesV2026ApiDeleteSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteSourceSchedule(requestParameters: SourcesV2026ApiDeleteSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schema by id - * @param {SourcesV2026ApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public deleteSourceSchema(requestParameters: SourcesV2026ApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. - * @summary Human Account Deletion Approval Config - * @param {SourcesV2026ApiGetAccountDeleteApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getAccountDeleteApprovalConfig(requestParameters: SourcesV2026ApiGetAccountDeleteApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getAccountDeleteApprovalConfig(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesV2026ApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getAccountsSchema(requestParameters: SourcesV2026ApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing correlation configuration for a source specified by the given ID. - * @summary Get source correlation configuration - * @param {SourcesV2026ApiGetCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getCorrelationConfig(requestParameters: SourcesV2026ApiGetCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getCorrelationConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesV2026ApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getEntitlementsSchema(requestParameters: SourcesV2026ApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. - * @summary Machine Account Deletion Approval Config - * @param {SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getMachineAccountDeletionApprovalConfigBySource(requestParameters: SourcesV2026ApiGetMachineAccountDeletionApprovalConfigBySourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getMachineAccountDeletionApprovalConfigBySource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing native change detection configuration for a source specified by the given ID. - * @summary Native change detection configuration - * @param {SourcesV2026ApiGetNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiGetNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getNativeChangeDetectionConfig(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesV2026ApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getProvisioningPolicy(requestParameters: SourcesV2026ApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesV2026ApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSource(requestParameters: SourcesV2026ApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. - * @summary Attribute sync config - * @param {SourcesV2026ApiGetSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceAttrSyncConfig(requestParameters: SourcesV2026ApiGetSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceAttrSyncConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - * @summary Gets source config with language-translations - * @param {SourcesV2026ApiGetSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceConfig(requestParameters: SourcesV2026ApiGetSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceConfig(requestParameters.id, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesV2026ApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceConnections(requestParameters: SourcesV2026ApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a dataset by id for the specified source in Identity Security Cloud (ISC). - * @summary Get source dataset by id - * @param {SourcesV2026ApiGetSourceDatasetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceDataset(requestParameters: SourcesV2026ApiGetSourceDatasetRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceDataset(requestParameters.sourceId, requestParameters.datasetId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list datasets for the specified source in Identity Security Cloud (ISC). - * @summary List datasets on source - * @param {SourcesV2026ApiGetSourceDatasetsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceDatasets(requestParameters: SourcesV2026ApiGetSourceDatasetsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceDatasets(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Get source entitlement request configuration - * @param {SourcesV2026ApiGetSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceEntitlementRequestConfig(requestParameters: SourcesV2026ApiGetSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceEntitlementRequestConfig(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesV2026ApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceHealth(requestParameters: SourcesV2026ApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a resource by id on the specified source in Identity Security Cloud (ISC). The response includes the full CIS schema for the resource. - * @summary Get source resource by id - * @param {SourcesV2026ApiGetSourceResourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceResource(requestParameters: SourcesV2026ApiGetSourceResourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceResource(requestParameters.sourceId, requestParameters.resourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list resources defined on the specified source in Identity Security Cloud (ISC). - * @summary List resources for a source - * @param {SourcesV2026ApiGetSourceResourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceResources(requestParameters: SourcesV2026ApiGetSourceResourcesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceResources(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the source schedule by type in Identity Security Cloud (ISC). - * @summary Get source schedule by type - * @param {SourcesV2026ApiGetSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceSchedule(requestParameters: SourcesV2026ApiGetSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). :::info This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. **Days of the week are represented as 1-7 (Sunday-Saturday).** ::: - * @summary List schedules on source - * @param {SourcesV2026ApiGetSourceSchedulesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceSchedules(requestParameters: SourcesV2026ApiGetSourceSchedulesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceSchedules(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesV2026ApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceSchema(requestParameters: SourcesV2026ApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesV2026ApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public getSourceSchemas(requestParameters: SourcesV2026ApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - * @summary Account aggregation - * @param {SourcesV2026ApiImportAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importAccounts(requestParameters: SourcesV2026ApiImportAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importAccounts(requestParameters.id, requestParameters.file, requestParameters.disableOptimization, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesV2026ApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importAccountsSchema(requestParameters: SourcesV2026ApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesV2026ApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importConnectorFile(requestParameters: SourcesV2026ApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Entitlement aggregation - * @param {SourcesV2026ApiImportEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importEntitlements(requestParameters: SourcesV2026ApiImportEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importEntitlements(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesV2026ApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importEntitlementsSchema(requestParameters: SourcesV2026ApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - * @summary Process uncorrelated accounts - * @param {SourcesV2026ApiImportUncorrelatedAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public importUncorrelatedAccounts(requestParameters: SourcesV2026ApiImportUncorrelatedAccountsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).importUncorrelatedAccounts(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API can be used to get Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Get Password Policy for source - * @param {SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public listPasswordPolicyHoldersOnSource(requestParameters: SourcesV2026ApiListPasswordPolicyHoldersOnSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).listPasswordPolicyHoldersOnSource(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesV2026ApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public listProvisioningPolicies(requestParameters: SourcesV2026ApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).listProvisioningPolicies(requestParameters.sourceId, requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesV2026ApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public listSources(requestParameters: SourcesV2026ApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - * @summary Ping cluster for source connector - * @param {SourcesV2026ApiPingClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public pingCluster(requestParameters: SourcesV2026ApiPingClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).pingCluster(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update source correlation configuration - * @param {SourcesV2026ApiPutCorrelationConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putCorrelationConfig(requestParameters: SourcesV2026ApiPutCorrelationConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putCorrelationConfig(requestParameters.id, requestParameters.correlationConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - * @summary Update native change detection configuration - * @param {SourcesV2026ApiPutNativeChangeDetectionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putNativeChangeDetectionConfig(requestParameters: SourcesV2026ApiPutNativeChangeDetectionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putNativeChangeDetectionConfig(requestParameters.id, requestParameters.nativeChangeDetectionConfigV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesV2026ApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putProvisioningPolicy(requestParameters: SourcesV2026ApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesV2026ApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putSource(requestParameters: SourcesV2026ApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putSource(requestParameters.id, requestParameters.sourceV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the \"enabled\" field of the values in the \"attributes\" array is mutable. Attempting to change other attributes or add new values to the \"attributes\" array will result in an error. - * @summary Update attribute sync config - * @param {SourcesV2026ApiPutSourceAttrSyncConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putSourceAttrSyncConfig(requestParameters: SourcesV2026ApiPutSourceAttrSyncConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putSourceAttrSyncConfig(requestParameters.id, requestParameters.attrSyncSourceConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesV2026ApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public putSourceSchema(requestParameters: SourcesV2026ApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schemaV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves a sample of data returned from account and group aggregation requests. - * @summary Peek source connector\'s resource objects - * @param {SourcesV2026ApiSearchResourceObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public searchResourceObjects(requestParameters: SourcesV2026ApiSearchResourceObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).searchResourceObjects(requestParameters.sourceId, requestParameters.resourceObjectsRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point performs attribute synchronization for a selected source. - * @summary Synchronize single source attributes. - * @param {SourcesV2026ApiSyncAttributesForSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public syncAttributesForSource(requestParameters: SourcesV2026ApiSyncAttributesForSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).syncAttributesForSource(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint performs a more detailed validation of the source\'\'s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - * @summary Test configuration for source connector - * @param {SourcesV2026ApiTestSourceConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public testSourceConfiguration(requestParameters: SourcesV2026ApiTestSourceConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).testSourceConfiguration(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - * @summary Check connection for source connector. - * @param {SourcesV2026ApiTestSourceConnectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public testSourceConnection(requestParameters: SourcesV2026ApiTestSourceConnectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).testSourceConnection(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. - * @summary Human Account Deletion Approval Config - * @param {SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateAccountDeletionApprovalConfig(requestParameters: SourcesV2026ApiUpdateAccountDeletionApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateAccountDeletionApprovalConfig(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update the machine account deletion approval configuration for a specific source. The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. - * @summary Machine Account Deletion Approval Config - * @param {SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateMachineAccountDeletionApprovalConfig(requestParameters: SourcesV2026ApiUpdateMachineAccountDeletionApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateMachineAccountDeletionApprovalConfig(requestParameters.sourceId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. - * @summary Update password policy - * @param {SourcesV2026ApiUpdatePasswordPolicyHoldersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updatePasswordPolicyHolders(requestParameters: SourcesV2026ApiUpdatePasswordPolicyHoldersRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updatePasswordPolicyHolders(requestParameters.sourceId, requestParameters.passwordPolicyHoldersDtoInnerV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateProvisioningPoliciesInBulk(requestParameters: SourcesV2026ApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesV2026ApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateProvisioningPolicy(requestParameters: SourcesV2026ApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesV2026ApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateSource(requestParameters: SourcesV2026ApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateSource(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. - * @summary Update source entitlement request configuration - * @param {SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateSourceEntitlementRequestConfig(requestParameters: SourcesV2026ApiUpdateSourceEntitlementRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateSourceEntitlementRequestConfig(requestParameters.id, requestParameters.sourceEntitlementRequestConfigV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schedule using a JSONPatch payload. The following schedule fields are immutable and cannot be updated: - type - * @summary Update source schedule (partial) - * @param {SourcesV2026ApiUpdateSourceScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateSourceSchedule(requestParameters: SourcesV2026ApiUpdateSourceScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateSourceSchedule(requestParameters.sourceId, requestParameters.scheduleType, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesV2026ApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesV2026Api - */ - public updateSourceSchema(requestParameters: SourcesV2026ApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesV2026ApiFp(this.configuration).updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteSourceScheduleScheduleTypeV2026 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type DeleteSourceScheduleScheduleTypeV2026 = typeof DeleteSourceScheduleScheduleTypeV2026[keyof typeof DeleteSourceScheduleScheduleTypeV2026]; -/** - * @export - */ -export const GetSourceConfigLocaleV2026 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetSourceConfigLocaleV2026 = typeof GetSourceConfigLocaleV2026[keyof typeof GetSourceConfigLocaleV2026]; -/** - * @export - */ -export const GetSourceScheduleScheduleTypeV2026 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type GetSourceScheduleScheduleTypeV2026 = typeof GetSourceScheduleScheduleTypeV2026[keyof typeof GetSourceScheduleScheduleTypeV2026]; -/** - * @export - */ -export const GetSourceSchemasIncludeTypesV2026 = { - Group: 'group', - User: 'user' -} as const; -export type GetSourceSchemasIncludeTypesV2026 = typeof GetSourceSchemasIncludeTypesV2026[keyof typeof GetSourceSchemasIncludeTypesV2026]; -/** - * @export - */ -export const UpdateSourceScheduleScheduleTypeV2026 = { - AccountAggregation: 'ACCOUNT_AGGREGATION', - GroupAggregation: 'GROUP_AGGREGATION' -} as const; -export type UpdateSourceScheduleScheduleTypeV2026 = typeof UpdateSourceScheduleScheduleTypeV2026[keyof typeof UpdateSourceScheduleScheduleTypeV2026]; - - -/** - * SuggestedEntitlementDescriptionV2026Api - axios parameter creator - * @export - */ -export const SuggestedEntitlementDescriptionV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. - * @summary Bulk approve entitlement recommendations - * @param {BulkApproveEntitlementRecommendationRequestV2026} bulkApproveEntitlementRecommendationRequestV2026 The list of recommendation items to approve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkEntitlementRecommendations: async (bulkApproveEntitlementRecommendationRequestV2026: BulkApproveEntitlementRecommendationRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkApproveEntitlementRecommendationRequestV2026' is not null or undefined - assertParamExists('approveBulkEntitlementRecommendations', 'bulkApproveEntitlementRecommendationRequestV2026', bulkApproveEntitlementRecommendationRequestV2026) - const localVarPath = `/entitlement-recommendations/bulk-approve`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkApproveEntitlementRecommendationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. - * @summary Create auto-write settings for SED - * @param {AutoWriteSettingV2026} autoWriteSettingV2026 Auto-write settings to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAutoWriteSettings: async (autoWriteSettingV2026: AutoWriteSettingV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'autoWriteSettingV2026' is not null or undefined - assertParamExists('createAutoWriteSettings', 'autoWriteSettingV2026', autoWriteSettingV2026) - const localVarPath = `/suggested-entitlement-descriptions/auto-write-settings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(autoWriteSettingV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. - * @summary Get auto-write settings for SED - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAutoWriteSettings: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-descriptions/auto-write-settings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats: async (batchId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'batchId' is not null or undefined - assertParamExists('getSedBatchStats', 'batchId', batchId) - const localVarPath = `/suggested-entitlement-description-batches/{batchId}/stats` - .replace(`{${"batchId"}}`, encodeURIComponent(String(batchId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches: async (offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. - * @summary List pending entitlement recommendation approvals - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingEntitlementRecommendationApprovals: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/entitlement-recommendations/pending-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. - * @summary List privileged entitlement recommendations - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegedEntitlementRecommendations: async (offset?: number, limit?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/privileged-recommendations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-descriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (countOnly !== undefined) { - localVarQueryParameter['count-only'] = countOnly; - } - - if (requestedByAnyone !== undefined) { - localVarQueryParameter['requested-by-anyone'] = requestedByAnyone; - } - - if (showPendingStatusOnly !== undefined) { - localVarQueryParameter['show-pending-status-only'] = showPendingStatusOnly; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. - * @summary Update an entitlement recommendation - * @param {string} id The unique identifier of the entitlement recommendation to update. - * @param {Array} jsonPatchOperationV2026 The patch operations to apply to the entitlement recommendation record. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementRecommendation: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchEntitlementRecommendation', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchEntitlementRecommendation', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/entitlement-recommendations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2026 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed: async (id: string, sedPatchV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSed', 'id', id) - // verify required parameter 'sedPatchV2026' is not null or undefined - assertParamExists('patchSed', 'sedPatchV2026', sedPatchV2026) - const localVarPath = `/suggested-entitlement-descriptions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. - * @summary Assign entitlement recommendations for review - * @param {EntitlementRecommendationAssignRequestV2026} entitlementRecommendationAssignRequestV2026 The recommendation IDs and the target assignee. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitEntitlementRecommendationsAssignment: async (entitlementRecommendationAssignRequestV2026: EntitlementRecommendationAssignRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'entitlementRecommendationAssignRequestV2026' is not null or undefined - assertParamExists('submitEntitlementRecommendationsAssignment', 'entitlementRecommendationAssignRequestV2026', entitlementRecommendationAssignRequestV2026) - const localVarPath = `/entitlement-recommendations/assign`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(entitlementRecommendationAssignRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2026 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval: async (sedApprovalV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedApprovalV2026' is not null or undefined - assertParamExists('submitSedApproval', 'sedApprovalV2026', sedApprovalV2026) - const localVarPath = `/suggested-entitlement-description-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedApprovalV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2026} sedAssignmentV2026 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment: async (sedAssignmentV2026: SedAssignmentV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sedAssignmentV2026' is not null or undefined - assertParamExists('submitSedAssignment', 'sedAssignmentV2026', sedAssignmentV2026) - const localVarPath = `/suggested-entitlement-description-assignments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedAssignmentV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2026} [sedBatchRequestV2026] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest: async (sedBatchRequestV2026?: SedBatchRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/suggested-entitlement-description-batches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(sedBatchRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. - * @summary Update auto-write settings for SED - * @param {Array} autoWriteSettingPatchV2026 Patch operations for auto-write settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAutoWriteSettings: async (autoWriteSettingPatchV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'autoWriteSettingPatchV2026' is not null or undefined - assertParamExists('updateAutoWriteSettings', 'autoWriteSettingPatchV2026', autoWriteSettingPatchV2026) - const localVarPath = `/suggested-entitlement-descriptions/auto-write-settings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(autoWriteSettingPatchV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2026Api - functional programming interface - * @export - */ -export const SuggestedEntitlementDescriptionV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SuggestedEntitlementDescriptionV2026ApiAxiosParamCreator(configuration) - return { - /** - * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. - * @summary Bulk approve entitlement recommendations - * @param {BulkApproveEntitlementRecommendationRequestV2026} bulkApproveEntitlementRecommendationRequestV2026 The list of recommendation items to approve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveBulkEntitlementRecommendations(bulkApproveEntitlementRecommendationRequestV2026: BulkApproveEntitlementRecommendationRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveBulkEntitlementRecommendations(bulkApproveEntitlementRecommendationRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.approveBulkEntitlementRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. - * @summary Create auto-write settings for SED - * @param {AutoWriteSettingV2026} autoWriteSettingV2026 Auto-write settings to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAutoWriteSettings(autoWriteSettingV2026: AutoWriteSettingV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAutoWriteSettings(autoWriteSettingV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.createAutoWriteSettings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. - * @summary Get auto-write settings for SED - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAutoWriteSettings(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAutoWriteSettings(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.getAutoWriteSettings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {string} batchId Batch Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatchStats(batchId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatchStats(batchId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.getSedBatchStats']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {number} [offset] Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @param {number} [limit] Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {string} [status] Batch Status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSedBatches(offset?: number, limit?: number, count?: boolean, countOnly?: boolean, status?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSedBatches(offset, limit, count, countOnly, status, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.getSedBatches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. - * @summary List pending entitlement recommendation approvals - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingEntitlementRecommendationApprovals(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingEntitlementRecommendationApprovals(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.listPendingEntitlementRecommendationApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. - * @summary List privileged entitlement recommendations - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPrivilegedEntitlementRecommendations(offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPrivilegedEntitlementRecommendations(offset, limit, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.listPrivilegedEntitlementRecommendations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @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: **displayName, sourceName, status** - * @param {boolean} [countOnly] 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @param {boolean} [requestedByAnyone] By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @param {boolean} [showPendingStatusOnly] Will limit records to items that are in \"suggested\" or \"approved\" status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSeds(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, countOnly?: boolean, requestedByAnyone?: boolean, showPendingStatusOnly?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSeds(limit, offset, count, filters, sorters, countOnly, requestedByAnyone, showPendingStatusOnly, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.listSeds']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. - * @summary Update an entitlement recommendation - * @param {string} id The unique identifier of the entitlement recommendation to update. - * @param {Array} jsonPatchOperationV2026 The patch operations to apply to the entitlement recommendation record. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchEntitlementRecommendation(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlementRecommendation(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.patchEntitlementRecommendation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {string} id id is sed id - * @param {Array} sedPatchV2026 Sed Patch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSed(id: string, sedPatchV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSed(id, sedPatchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.patchSed']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. - * @summary Assign entitlement recommendations for review - * @param {EntitlementRecommendationAssignRequestV2026} entitlementRecommendationAssignRequestV2026 The recommendation IDs and the target assignee. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitEntitlementRecommendationsAssignment(entitlementRecommendationAssignRequestV2026: EntitlementRecommendationAssignRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitEntitlementRecommendationsAssignment(entitlementRecommendationAssignRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.submitEntitlementRecommendationsAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {Array} sedApprovalV2026 Sed Approval - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedApproval(sedApprovalV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedApproval(sedApprovalV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.submitSedApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SedAssignmentV2026} sedAssignmentV2026 Sed Assignment Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedAssignment(sedAssignmentV2026: SedAssignmentV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedAssignment(sedAssignmentV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.submitSedAssignment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SedBatchRequestV2026} [sedBatchRequestV2026] Sed Batch Request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitSedBatchRequest(sedBatchRequestV2026?: SedBatchRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitSedBatchRequest(sedBatchRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.submitSedBatchRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. - * @summary Update auto-write settings for SED - * @param {Array} autoWriteSettingPatchV2026 Patch operations for auto-write settings - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAutoWriteSettings(autoWriteSettingPatchV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAutoWriteSettings(autoWriteSettingPatchV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SuggestedEntitlementDescriptionV2026Api.updateAutoWriteSettings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SuggestedEntitlementDescriptionV2026Api - factory interface - * @export - */ -export const SuggestedEntitlementDescriptionV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SuggestedEntitlementDescriptionV2026ApiFp(configuration) - return { - /** - * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. - * @summary Bulk approve entitlement recommendations - * @param {SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveBulkEntitlementRecommendations(requestParameters: SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.approveBulkEntitlementRecommendations(requestParameters.bulkApproveEntitlementRecommendationRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. - * @summary Create auto-write settings for SED - * @param {SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAutoWriteSettings(requestParameters: SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAutoWriteSettings(requestParameters.autoWriteSettingV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. - * @summary Get auto-write settings for SED - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAutoWriteSettings(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAutoWriteSettings(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. - * @summary List pending entitlement recommendation approvals - * @param {SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingEntitlementRecommendationApprovals(requestParameters: SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingEntitlementRecommendationApprovals(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. - * @summary List privileged entitlement recommendations - * @param {SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPrivilegedEntitlementRecommendations(requestParameters: SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPrivilegedEntitlementRecommendations(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2026ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSeds(requestParameters: SuggestedEntitlementDescriptionV2026ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. - * @summary Update an entitlement recommendation - * @param {SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchEntitlementRecommendation(requestParameters: SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchEntitlementRecommendation(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2026ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSed(requestParameters: SuggestedEntitlementDescriptionV2026ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSed(requestParameters.id, requestParameters.sedPatchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. - * @summary Assign entitlement recommendations for review - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitEntitlementRecommendationsAssignment(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitEntitlementRecommendationsAssignment(requestParameters.entitlementRecommendationAssignRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.submitSedApproval(requestParameters.sedApprovalV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedAssignment(requestParameters.sedAssignmentV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitSedBatchRequest(requestParameters.sedBatchRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. - * @summary Update auto-write settings for SED - * @param {SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAutoWriteSettings(requestParameters: SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAutoWriteSettings(requestParameters.autoWriteSettingPatchV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveBulkEntitlementRecommendations operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest { - /** - * The list of recommendation items to approve. - * @type {BulkApproveEntitlementRecommendationRequestV2026} - * @memberof SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendations - */ - readonly bulkApproveEntitlementRecommendationRequestV2026: BulkApproveEntitlementRecommendationRequestV2026 -} - -/** - * Request parameters for createAutoWriteSettings operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest { - /** - * Auto-write settings to create - * @type {AutoWriteSettingV2026} - * @memberof SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettings - */ - readonly autoWriteSettingV2026: AutoWriteSettingV2026 -} - -/** - * Request parameters for getSedBatchStats operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest { - /** - * Batch Id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatchStats - */ - readonly batchId: string -} - -/** - * Request parameters for getSedBatches operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest { - /** - * Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatches - */ - readonly offset?: number - - /** - * Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatches - */ - 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatches - */ - readonly count?: boolean - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatches - */ - readonly countOnly?: boolean - - /** - * Batch Status - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiGetSedBatches - */ - readonly status?: string -} - -/** - * Request parameters for listPendingEntitlementRecommendationApprovals operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest { - /** - * 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 SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovals - */ - 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 SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovals - */ - readonly limit?: number -} - -/** - * Request parameters for listPrivilegedEntitlementRecommendations operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest { - /** - * 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 SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendations - */ - 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 SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendations - */ - readonly limit?: number -} - -/** - * Request parameters for listSeds operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiListSedsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiListSedsRequest { - /** - * 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 SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - 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: **displayName, sourceName, status** - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly sorters?: string - - /** - * 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly countOnly?: boolean - - /** - * By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly requestedByAnyone?: boolean - - /** - * Will limit records to items that are in \"suggested\" or \"approved\" status - * @type {boolean} - * @memberof SuggestedEntitlementDescriptionV2026ApiListSeds - */ - readonly showPendingStatusOnly?: boolean -} - -/** - * Request parameters for patchEntitlementRecommendation operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest { - /** - * The unique identifier of the entitlement recommendation to update. - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendation - */ - readonly id: string - - /** - * The patch operations to apply to the entitlement recommendation record. - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendation - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for patchSed operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiPatchSedRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiPatchSedRequest { - /** - * id is sed id - * @type {string} - * @memberof SuggestedEntitlementDescriptionV2026ApiPatchSed - */ - readonly id: string - - /** - * Sed Patch Request - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2026ApiPatchSed - */ - readonly sedPatchV2026: Array -} - -/** - * Request parameters for submitEntitlementRecommendationsAssignment operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest { - /** - * The recommendation IDs and the target assignee. - * @type {EntitlementRecommendationAssignRequestV2026} - * @memberof SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignment - */ - readonly entitlementRecommendationAssignRequestV2026: EntitlementRecommendationAssignRequestV2026 -} - -/** - * Request parameters for submitSedApproval operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest { - /** - * Sed Approval - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2026ApiSubmitSedApproval - */ - readonly sedApprovalV2026: Array -} - -/** - * Request parameters for submitSedAssignment operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest { - /** - * Sed Assignment Request - * @type {SedAssignmentV2026} - * @memberof SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignment - */ - readonly sedAssignmentV2026: SedAssignmentV2026 -} - -/** - * Request parameters for submitSedBatchRequest operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest { - /** - * Sed Batch Request - * @type {SedBatchRequestV2026} - * @memberof SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequest - */ - readonly sedBatchRequestV2026?: SedBatchRequestV2026 -} - -/** - * Request parameters for updateAutoWriteSettings operation in SuggestedEntitlementDescriptionV2026Api. - * @export - * @interface SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest - */ -export interface SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest { - /** - * Patch operations for auto-write settings - * @type {Array} - * @memberof SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettings - */ - readonly autoWriteSettingPatchV2026: Array -} - -/** - * SuggestedEntitlementDescriptionV2026Api - object-oriented interface - * @export - * @class SuggestedEntitlementDescriptionV2026Api - * @extends {BaseAPI} - */ -export class SuggestedEntitlementDescriptionV2026Api extends BaseAPI { - /** - * Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. - * @summary Bulk approve entitlement recommendations - * @param {SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public approveBulkEntitlementRecommendations(requestParameters: SuggestedEntitlementDescriptionV2026ApiApproveBulkEntitlementRecommendationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).approveBulkEntitlementRecommendations(requestParameters.bulkApproveEntitlementRecommendationRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. - * @summary Create auto-write settings for SED - * @param {SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public createAutoWriteSettings(requestParameters: SuggestedEntitlementDescriptionV2026ApiCreateAutoWriteSettingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).createAutoWriteSettings(requestParameters.autoWriteSettingV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. - * @summary Get auto-write settings for SED - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public getAutoWriteSettings(axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).getAutoWriteSettings(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * \'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.\' - * @summary Submit sed batch stats request - * @param {SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public getSedBatchStats(requestParameters: SuggestedEntitlementDescriptionV2026ApiGetSedBatchStatsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).getSedBatchStats(requestParameters.batchId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List Sed Batches. API responses with Sed Batch Records - * @summary List Sed Batch Record - * @param {SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public getSedBatches(requestParameters: SuggestedEntitlementDescriptionV2026ApiGetSedBatchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).getSedBatches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.countOnly, requestParameters.status, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. - * @summary List pending entitlement recommendation approvals - * @param {SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public listPendingEntitlementRecommendationApprovals(requestParameters: SuggestedEntitlementDescriptionV2026ApiListPendingEntitlementRecommendationApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).listPendingEntitlementRecommendationApprovals(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. - * @summary List privileged entitlement recommendations - * @param {SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public listPrivilegedEntitlementRecommendations(requestParameters: SuggestedEntitlementDescriptionV2026ApiListPrivilegedEntitlementRecommendationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).listPrivilegedEntitlementRecommendations(requestParameters.offset, requestParameters.limit, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List of Suggested Entitlement Descriptions (SED) SED field descriptions: **batchId**: the ID of the batch of entitlements that are submitted for description generation **displayName**: the display name of the entitlement that we are generating a description for **sourceName**: the name of the source associated with the entitlement that we are generating the description for **sourceId**: the ID of the source associated with the entitlement that we are generating the description for **status**: the status of the suggested entitlement description, valid status options: \"requested\", \"suggested\", \"not_suggested\", \"failed\", \"assigned\", \"approved\", \"denied\" **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - * @summary List suggested entitlement descriptions - * @param {SuggestedEntitlementDescriptionV2026ApiListSedsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public listSeds(requestParameters: SuggestedEntitlementDescriptionV2026ApiListSedsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).listSeds(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.countOnly, requestParameters.requestedByAnyone, requestParameters.showPendingStatusOnly, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. - * @summary Update an entitlement recommendation - * @param {SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public patchEntitlementRecommendation(requestParameters: SuggestedEntitlementDescriptionV2026ApiPatchEntitlementRecommendationRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).patchEntitlementRecommendation(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Patch Suggested Entitlement Description - * @summary Patch suggested entitlement description - * @param {SuggestedEntitlementDescriptionV2026ApiPatchSedRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public patchSed(requestParameters: SuggestedEntitlementDescriptionV2026ApiPatchSedRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).patchSed(requestParameters.id, requestParameters.sedPatchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. - * @summary Assign entitlement recommendations for review - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public submitEntitlementRecommendationsAssignment(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitEntitlementRecommendationsAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).submitEntitlementRecommendationsAssignment(requestParameters.entitlementRecommendationAssignRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status - * @summary Submit bulk approval request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public submitSedApproval(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).submitSedApproval(requestParameters.sedApprovalV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - * @summary Submit sed assignment request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public submitSedAssignment(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedAssignmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).submitSedAssignment(requestParameters.sedAssignmentV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together - * @summary Submit sed batch request - * @param {SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public submitSedBatchRequest(requestParameters: SuggestedEntitlementDescriptionV2026ApiSubmitSedBatchRequestRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).submitSedBatchRequest(requestParameters.sedBatchRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update the auto-write settings for a tenant using JSON Patch operations. Only the \"replace\" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. - * @summary Update auto-write settings for SED - * @param {SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SuggestedEntitlementDescriptionV2026Api - */ - public updateAutoWriteSettings(requestParameters: SuggestedEntitlementDescriptionV2026ApiUpdateAutoWriteSettingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SuggestedEntitlementDescriptionV2026ApiFp(this.configuration).updateAutoWriteSettings(requestParameters.autoWriteSettingPatchV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaggedObjectsV2026Api - axios parameter creator - * @export - */ -export const TaggedObjectsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2026} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject: async (type: DeleteTaggedObjectTypeV2026, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('deleteTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2026} bulkRemoveTaggedObjectV2026 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject: async (bulkRemoveTaggedObjectV2026: BulkRemoveTaggedObjectV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRemoveTaggedObjectV2026' is not null or undefined - assertParamExists('deleteTagsToManyObject', 'bulkRemoveTaggedObjectV2026', bulkRemoveTaggedObjectV2026) - const localVarPath = `/tagged-objects/bulk-remove`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRemoveTaggedObjectV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2026} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject: async (type: GetTaggedObjectTypeV2026, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('getTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2026} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType: async (type: ListTaggedObjectsByTypeTypeV2026, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('listTaggedObjectsByType', 'type', type) - const localVarPath = `/tagged-objects/{type}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2026} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2026} taggedObjectV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject: async (type: PutTaggedObjectTypeV2026, id: string, taggedObjectV2026: TaggedObjectV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('putTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('putTaggedObject', 'id', id) - // verify required parameter 'taggedObjectV2026' is not null or undefined - assertParamExists('putTaggedObject', 'taggedObjectV2026', taggedObjectV2026) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2026} taggedObjectV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject: async (taggedObjectV2026: TaggedObjectV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taggedObjectV2026' is not null or undefined - assertParamExists('setTagToObject', 'taggedObjectV2026', taggedObjectV2026) - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObjectV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2026} bulkAddTaggedObjectV2026 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects: async (bulkAddTaggedObjectV2026: BulkAddTaggedObjectV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkAddTaggedObjectV2026' is not null or undefined - assertParamExists('setTagsToManyObjects', 'bulkAddTaggedObjectV2026', bulkAddTaggedObjectV2026) - const localVarPath = `/tagged-objects/bulk-add`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkAddTaggedObjectV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaggedObjectsV2026Api - functional programming interface - * @export - */ -export const TaggedObjectsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaggedObjectsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV2026} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTaggedObject(type: DeleteTaggedObjectTypeV2026, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.deleteTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObjectV2026} bulkRemoveTaggedObjectV2026 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagsToManyObject(bulkRemoveTaggedObjectV2026: BulkRemoveTaggedObjectV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObject(bulkRemoveTaggedObjectV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.deleteTagsToManyObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV2026} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaggedObject(type: GetTaggedObjectTypeV2026, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.getTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjects(limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.listTaggedObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV2026} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjectsByType(type: ListTaggedObjectsByTypeTypeV2026, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByType(type, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.listTaggedObjectsByType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV2026} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObjectV2026} taggedObjectV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTaggedObject(type: PutTaggedObjectTypeV2026, id: string, taggedObjectV2026: TaggedObjectV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObject(type, id, taggedObjectV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.putTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectV2026} taggedObjectV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagToObject(taggedObjectV2026: TaggedObjectV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObject(taggedObjectV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.setTagToObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObjectV2026} bulkAddTaggedObjectV2026 Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagsToManyObjects(bulkAddTaggedObjectV2026: BulkAddTaggedObjectV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjects(bulkAddTaggedObjectV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsV2026Api.setTagsToManyObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaggedObjectsV2026Api - factory interface - * @export - */ -export const TaggedObjectsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaggedObjectsV2026ApiFp(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2026ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject(requestParameters: TaggedObjectsV2026ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject(requestParameters: TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2026ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject(requestParameters: TaggedObjectsV2026ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2026ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects(requestParameters: TaggedObjectsV2026ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType(requestParameters: TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2026ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject(requestParameters: TaggedObjectsV2026ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2026ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject(requestParameters: TaggedObjectsV2026ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagToObject(requestParameters.taggedObjectV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2026ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects(requestParameters: TaggedObjectsV2026ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteTaggedObject operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiDeleteTaggedObjectRequest - */ -export interface TaggedObjectsV2026ApiDeleteTaggedObjectRequest { - /** - * The type of object to delete tags from. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2026ApiDeleteTaggedObject - */ - readonly type: DeleteTaggedObjectTypeV2026 - - /** - * The ID of the object to delete tags from. - * @type {string} - * @memberof TaggedObjectsV2026ApiDeleteTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for deleteTagsToManyObject operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest - */ -export interface TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkRemoveTaggedObjectV2026} - * @memberof TaggedObjectsV2026ApiDeleteTagsToManyObject - */ - readonly bulkRemoveTaggedObjectV2026: BulkRemoveTaggedObjectV2026 -} - -/** - * Request parameters for getTaggedObject operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiGetTaggedObjectRequest - */ -export interface TaggedObjectsV2026ApiGetTaggedObjectRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2026ApiGetTaggedObject - */ - readonly type: GetTaggedObjectTypeV2026 - - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TaggedObjectsV2026ApiGetTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for listTaggedObjects operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiListTaggedObjectsRequest - */ -export interface TaggedObjectsV2026ApiListTaggedObjectsRequest { - /** - * 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 TaggedObjectsV2026ApiListTaggedObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2026ApiListTaggedObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2026ApiListTaggedObjects - */ - 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @type {string} - * @memberof TaggedObjectsV2026ApiListTaggedObjects - */ - readonly filters?: string -} - -/** - * Request parameters for listTaggedObjectsByType operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest - */ -export interface TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2026ApiListTaggedObjectsByType - */ - readonly type: ListTaggedObjectsByTypeTypeV2026 - - /** - * 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 TaggedObjectsV2026ApiListTaggedObjectsByType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsV2026ApiListTaggedObjectsByType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsV2026ApiListTaggedObjectsByType - */ - 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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @type {string} - * @memberof TaggedObjectsV2026ApiListTaggedObjectsByType - */ - readonly filters?: string -} - -/** - * Request parameters for putTaggedObject operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiPutTaggedObjectRequest - */ -export interface TaggedObjectsV2026ApiPutTaggedObjectRequest { - /** - * The type of tagged object to update. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsV2026ApiPutTaggedObject - */ - readonly type: PutTaggedObjectTypeV2026 - - /** - * The ID of the object reference to update. - * @type {string} - * @memberof TaggedObjectsV2026ApiPutTaggedObject - */ - readonly id: string - - /** - * - * @type {TaggedObjectV2026} - * @memberof TaggedObjectsV2026ApiPutTaggedObject - */ - readonly taggedObjectV2026: TaggedObjectV2026 -} - -/** - * Request parameters for setTagToObject operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiSetTagToObjectRequest - */ -export interface TaggedObjectsV2026ApiSetTagToObjectRequest { - /** - * - * @type {TaggedObjectV2026} - * @memberof TaggedObjectsV2026ApiSetTagToObject - */ - readonly taggedObjectV2026: TaggedObjectV2026 -} - -/** - * Request parameters for setTagsToManyObjects operation in TaggedObjectsV2026Api. - * @export - * @interface TaggedObjectsV2026ApiSetTagsToManyObjectsRequest - */ -export interface TaggedObjectsV2026ApiSetTagsToManyObjectsRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkAddTaggedObjectV2026} - * @memberof TaggedObjectsV2026ApiSetTagsToManyObjects - */ - readonly bulkAddTaggedObjectV2026: BulkAddTaggedObjectV2026 -} - -/** - * TaggedObjectsV2026Api - object-oriented interface - * @export - * @class TaggedObjectsV2026Api - * @extends {BaseAPI} - */ -export class TaggedObjectsV2026Api extends BaseAPI { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsV2026ApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public deleteTaggedObject(requestParameters: TaggedObjectsV2026ApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public deleteTagsToManyObject(requestParameters: TaggedObjectsV2026ApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObjectV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsV2026ApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public getTaggedObject(requestParameters: TaggedObjectsV2026ApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsV2026ApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public listTaggedObjects(requestParameters: TaggedObjectsV2026ApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public listTaggedObjectsByType(requestParameters: TaggedObjectsV2026ApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsV2026ApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public putTaggedObject(requestParameters: TaggedObjectsV2026ApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObjectV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsV2026ApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public setTagToObject(requestParameters: TaggedObjectsV2026ApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).setTagToObject(requestParameters.taggedObjectV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsV2026ApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsV2026Api - */ - public setTagsToManyObjects(requestParameters: TaggedObjectsV2026ApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsV2026ApiFp(this.configuration).setTagsToManyObjects(requestParameters.bulkAddTaggedObjectV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteTaggedObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type DeleteTaggedObjectTypeV2026 = typeof DeleteTaggedObjectTypeV2026[keyof typeof DeleteTaggedObjectTypeV2026]; -/** - * @export - */ -export const GetTaggedObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type GetTaggedObjectTypeV2026 = typeof GetTaggedObjectTypeV2026[keyof typeof GetTaggedObjectTypeV2026]; -/** - * @export - */ -export const ListTaggedObjectsByTypeTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type ListTaggedObjectsByTypeTypeV2026 = typeof ListTaggedObjectsByTypeTypeV2026[keyof typeof ListTaggedObjectsByTypeTypeV2026]; -/** - * @export - */ -export const PutTaggedObjectTypeV2026 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type PutTaggedObjectTypeV2026 = typeof PutTaggedObjectTypeV2026[keyof typeof PutTaggedObjectTypeV2026]; - - -/** - * TagsV2026Api - axios parameter creator - * @export - */ -export const TagsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2026} tagV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag: async (tagV2026: TagV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tagV2026' is not null or undefined - assertParamExists('createTag', 'tagV2026', tagV2026) - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tagV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTagById', 'id', id) - const localVarPath = `/tags/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tags`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * TagsV2026Api - functional programming interface - * @export - */ -export const TagsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TagsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagV2026} tagV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTag(tagV2026: TagV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTag(tagV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2026Api.createTag']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {string} id The ID of the object reference to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2026Api.deleteTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTagById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTagById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2026Api.getTagById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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, name, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTags(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTags(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TagsV2026Api.listTags']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TagsV2026Api - factory interface - * @export - */ -export const TagsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TagsV2026ApiFp(configuration) - return { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2026ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTag(requestParameters: TagsV2026ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTag(requestParameters.tagV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2026ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagById(requestParameters: TagsV2026ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2026ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTagById(requestParameters: TagsV2026ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTagById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2026ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTags(requestParameters: TagsV2026ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTag operation in TagsV2026Api. - * @export - * @interface TagsV2026ApiCreateTagRequest - */ -export interface TagsV2026ApiCreateTagRequest { - /** - * - * @type {TagV2026} - * @memberof TagsV2026ApiCreateTag - */ - readonly tagV2026: TagV2026 -} - -/** - * Request parameters for deleteTagById operation in TagsV2026Api. - * @export - * @interface TagsV2026ApiDeleteTagByIdRequest - */ -export interface TagsV2026ApiDeleteTagByIdRequest { - /** - * The ID of the object reference to delete. - * @type {string} - * @memberof TagsV2026ApiDeleteTagById - */ - readonly id: string -} - -/** - * Request parameters for getTagById operation in TagsV2026Api. - * @export - * @interface TagsV2026ApiGetTagByIdRequest - */ -export interface TagsV2026ApiGetTagByIdRequest { - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TagsV2026ApiGetTagById - */ - readonly id: string -} - -/** - * Request parameters for listTags operation in TagsV2026Api. - * @export - * @interface TagsV2026ApiListTagsRequest - */ -export interface TagsV2026ApiListTagsRequest { - /** - * 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 TagsV2026ApiListTags - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TagsV2026ApiListTags - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TagsV2026ApiListTags - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof TagsV2026ApiListTags - */ - 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, name, created, modified** - * @type {string} - * @memberof TagsV2026ApiListTags - */ - readonly sorters?: string -} - -/** - * TagsV2026Api - object-oriented interface - * @export - * @class TagsV2026Api - * @extends {BaseAPI} - */ -export class TagsV2026Api extends BaseAPI { - /** - * This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Create tag - * @param {TagsV2026ApiCreateTagRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2026Api - */ - public createTag(requestParameters: TagsV2026ApiCreateTagRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2026ApiFp(this.configuration).createTag(requestParameters.tagV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Delete tag - * @param {TagsV2026ApiDeleteTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2026Api - */ - public deleteTagById(requestParameters: TagsV2026ApiDeleteTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2026ApiFp(this.configuration).deleteTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary Get tag by id - * @param {TagsV2026ApiGetTagByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2026Api - */ - public getTagById(requestParameters: TagsV2026ApiGetTagByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2026ApiFp(this.configuration).getTagById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - * @summary List tags - * @param {TagsV2026ApiListTagsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TagsV2026Api - */ - public listTags(requestParameters: TagsV2026ApiListTagsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TagsV2026ApiFp(this.configuration).listTags(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TaskManagementV2026Api - axios parameter creator - * @export - */ -export const TaskManagementV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaskStatus', 'id', id) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/task-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTaskStatus', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('updateTaskStatus', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/task-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaskManagementV2026Api - functional programming interface - * @export - */ -export const TaskManagementV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaskManagementV2026ApiAxiosParamCreator(configuration) - return { - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {string} id Task ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @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: **created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusList(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStatusList(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.getTaskStatusList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {string} id Task ID. - * @param {Array} jsonPatchOperationV2026 The JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTaskStatus(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskStatus(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaskManagementV2026Api.updateTaskStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaskManagementV2026Api - factory interface - * @export - */ -export const TaskManagementV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaskManagementV2026ApiFp(configuration) - return { - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTaskStatus operation in TaskManagementV2026Api. - * @export - * @interface TaskManagementV2026ApiGetTaskStatusRequest - */ -export interface TaskManagementV2026ApiGetTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2026ApiGetTaskStatus - */ - readonly id: string -} - -/** - * Request parameters for getTaskStatusList operation in TaskManagementV2026Api. - * @export - * @interface TaskManagementV2026ApiGetTaskStatusListRequest - */ -export interface TaskManagementV2026ApiGetTaskStatusListRequest { - /** - * 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 TaskManagementV2026ApiGetTaskStatusList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaskManagementV2026ApiGetTaskStatusList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaskManagementV2026ApiGetTaskStatusList - */ - 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, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION - * @type {string} - * @memberof TaskManagementV2026ApiGetTaskStatusList - */ - 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: **created** - * @type {string} - * @memberof TaskManagementV2026ApiGetTaskStatusList - */ - readonly sorters?: string -} - -/** - * Request parameters for updateTaskStatus operation in TaskManagementV2026Api. - * @export - * @interface TaskManagementV2026ApiUpdateTaskStatusRequest - */ -export interface TaskManagementV2026ApiUpdateTaskStatusRequest { - /** - * Task ID. - * @type {string} - * @memberof TaskManagementV2026ApiUpdateTaskStatus - */ - readonly id: string - - /** - * The JSONPatch payload used to update the object. - * @type {Array} - * @memberof TaskManagementV2026ApiUpdateTaskStatus - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * TaskManagementV2026Api - object-oriented interface - * @export - * @class TaskManagementV2026Api - * @extends {BaseAPI} - */ -export class TaskManagementV2026Api extends BaseAPI { - /** - * Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - * @summary Get task status by id - * @param {TaskManagementV2026ApiGetTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2026Api - */ - public getTaskStatus(requestParameters: TaskManagementV2026ApiGetTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2026ApiFp(this.configuration).getTaskStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. - * @summary Retrieve task status list - * @param {TaskManagementV2026ApiGetTaskStatusListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2026Api - */ - public getTaskStatusList(requestParameters: TaskManagementV2026ApiGetTaskStatusListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2026ApiFp(this.configuration).getTaskStatusList(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - * @summary Update task status by id - * @param {TaskManagementV2026ApiUpdateTaskStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaskManagementV2026Api - */ - public updateTaskStatus(requestParameters: TaskManagementV2026ApiUpdateTaskStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaskManagementV2026ApiFp(this.configuration).updateTaskStatus(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantV2026Api - axios parameter creator - * @export - */ -export const TenantV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantV2026Api - functional programming interface - * @export - */ -export const TenantV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantV2026ApiAxiosParamCreator(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenant(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenant(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantV2026Api.getTenant']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantV2026Api - factory interface - * @export - */ -export const TenantV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantV2026ApiFp(configuration) - return { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenant(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenant(axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * TenantV2026Api - object-oriented interface - * @export - * @class TenantV2026Api - * @extends {BaseAPI} - */ -export class TenantV2026Api extends BaseAPI { - /** - * This rest endpoint can be used to retrieve tenant details. - * @summary Get tenant information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantV2026Api - */ - public getTenant(axiosOptions?: RawAxiosRequestConfig) { - return TenantV2026ApiFp(this.configuration).getTenant(axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TenantContextV2026Api - axios parameter creator - * @export - */ -export const TenantContextV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2026} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext: async (jsonPatchOperationV2026: JsonPatchOperationV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchTenantContext', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/tenant-context`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TenantContextV2026Api - functional programming interface - * @export - */ -export const TenantContextV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TenantContextV2026ApiAxiosParamCreator(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantContext(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantContext(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2026Api.getTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {JsonPatchOperationV2026} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchTenantContext(jsonPatchOperationV2026: JsonPatchOperationV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchTenantContext(jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TenantContextV2026Api.patchTenantContext']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TenantContextV2026Api - factory interface - * @export - */ -export const TenantContextV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TenantContextV2026ApiFp(configuration) - return { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantContext(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getTenantContext(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2026ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchTenantContext(requestParameters: TenantContextV2026ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchTenantContext(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for patchTenantContext operation in TenantContextV2026Api. - * @export - * @interface TenantContextV2026ApiPatchTenantContextRequest - */ -export interface TenantContextV2026ApiPatchTenantContextRequest { - /** - * - * @type {JsonPatchOperationV2026} - * @memberof TenantContextV2026ApiPatchTenantContext - */ - readonly jsonPatchOperationV2026: JsonPatchOperationV2026 -} - -/** - * TenantContextV2026Api - object-oriented interface - * @export - * @class TenantContextV2026Api - * @extends {BaseAPI} - */ -export class TenantContextV2026Api extends BaseAPI { - /** - * Returns all key-value pairs representing the current state of the tenant\'s context. Each tenant is limited to a maximum of 100 key-value pairs. - * @summary Retrieve tenant context - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2026Api - */ - public getTenantContext(axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2026ApiFp(this.configuration).getTenantContext(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. This endpoint is specifically designed to modify the `/Key/_*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. Note that each tenant is limited to a maximum of 100 key-value pairs. - * @summary Update tenant context - * @param {TenantContextV2026ApiPatchTenantContextRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TenantContextV2026Api - */ - public patchTenantContext(requestParameters: TenantContextV2026ApiPatchTenantContextRequest, axiosOptions?: RawAxiosRequestConfig) { - return TenantContextV2026ApiFp(this.configuration).patchTenantContext(requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TransformsV2026Api - axios parameter creator - * @export - */ -export const TransformsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2026} transformV2026 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform: async (transformV2026: TransformV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'transformV2026' is not null or undefined - assertParamExists('createTransform', 'transformV2026', transformV2026) - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - 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, - }; - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2026} [transformV2026] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform: async (id: string, transformV2026?: TransformV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTransform', 'id', id) - const localVarPath = `/transforms/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transformV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TransformsV2026Api - functional programming interface - * @export - */ -export const TransformsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TransformsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformV2026} transformV2026 The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTransform(transformV2026: TransformV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTransform(transformV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2026Api.createTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2026Api.deleteTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2026Api.getTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTransforms(offset, limit, count, name, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2026Api.listTransforms']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {TransformV2026} [transformV2026] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTransform(id: string, transformV2026?: TransformV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransform(id, transformV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsV2026Api.updateTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TransformsV2026Api - factory interface - * @export - */ -export const TransformsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TransformsV2026ApiFp(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2026ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform(requestParameters: TransformsV2026ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTransform(requestParameters.transformV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2026ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform(requestParameters: TransformsV2026ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2026ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform(requestParameters: TransformsV2026ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2026ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms(requestParameters: TransformsV2026ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2026ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform(requestParameters: TransformsV2026ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTransform(requestParameters.id, requestParameters.transformV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTransform operation in TransformsV2026Api. - * @export - * @interface TransformsV2026ApiCreateTransformRequest - */ -export interface TransformsV2026ApiCreateTransformRequest { - /** - * The transform to be created. - * @type {TransformV2026} - * @memberof TransformsV2026ApiCreateTransform - */ - readonly transformV2026: TransformV2026 -} - -/** - * Request parameters for deleteTransform operation in TransformsV2026Api. - * @export - * @interface TransformsV2026ApiDeleteTransformRequest - */ -export interface TransformsV2026ApiDeleteTransformRequest { - /** - * ID of the transform to delete - * @type {string} - * @memberof TransformsV2026ApiDeleteTransform - */ - readonly id: string -} - -/** - * Request parameters for getTransform operation in TransformsV2026Api. - * @export - * @interface TransformsV2026ApiGetTransformRequest - */ -export interface TransformsV2026ApiGetTransformRequest { - /** - * ID of the transform to retrieve - * @type {string} - * @memberof TransformsV2026ApiGetTransform - */ - readonly id: string -} - -/** - * Request parameters for listTransforms operation in TransformsV2026Api. - * @export - * @interface TransformsV2026ApiListTransformsRequest - */ -export interface TransformsV2026ApiListTransformsRequest { - /** - * 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 TransformsV2026ApiListTransforms - */ - 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 TransformsV2026ApiListTransforms - */ - 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 TransformsV2026ApiListTransforms - */ - readonly count?: boolean - - /** - * Name of the transform to retrieve from the list. - * @type {string} - * @memberof TransformsV2026ApiListTransforms - */ - readonly name?: 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: **internal**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof TransformsV2026ApiListTransforms - */ - readonly filters?: string -} - -/** - * Request parameters for updateTransform operation in TransformsV2026Api. - * @export - * @interface TransformsV2026ApiUpdateTransformRequest - */ -export interface TransformsV2026ApiUpdateTransformRequest { - /** - * ID of the transform to update - * @type {string} - * @memberof TransformsV2026ApiUpdateTransform - */ - readonly id: string - - /** - * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @type {TransformV2026} - * @memberof TransformsV2026ApiUpdateTransform - */ - readonly transformV2026?: TransformV2026 -} - -/** - * TransformsV2026Api - object-oriented interface - * @export - * @class TransformsV2026Api - * @extends {BaseAPI} - */ -export class TransformsV2026Api extends BaseAPI { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsV2026ApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2026Api - */ - public createTransform(requestParameters: TransformsV2026ApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2026ApiFp(this.configuration).createTransform(requestParameters.transformV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsV2026ApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2026Api - */ - public deleteTransform(requestParameters: TransformsV2026ApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2026ApiFp(this.configuration).deleteTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsV2026ApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2026Api - */ - public getTransform(requestParameters: TransformsV2026ApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2026ApiFp(this.configuration).getTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsV2026ApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2026Api - */ - public listTransforms(requestParameters: TransformsV2026ApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2026ApiFp(this.configuration).listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsV2026ApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsV2026Api - */ - public updateTransform(requestParameters: TransformsV2026ApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsV2026ApiFp(this.configuration).updateTransform(requestParameters.id, requestParameters.transformV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TriggersV2026Api - axios parameter creator - * @export - */ -export const TriggersV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2026} completeInvocationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation: async (id: string, completeInvocationV2026: CompleteInvocationV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeTriggerInvocation', 'id', id) - // verify required parameter 'completeInvocationV2026' is not null or undefined - assertParamExists('completeTriggerInvocation', 'completeInvocationV2026', completeInvocationV2026) - const localVarPath = `/trigger-invocations/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(completeInvocationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2026} subscriptionPostRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription: async (subscriptionPostRequestV2026: SubscriptionPostRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'subscriptionPostRequestV2026' is not null or undefined - assertParamExists('createSubscription', 'subscriptionPostRequestV2026', subscriptionPostRequestV2026) - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPostRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSubscription', 'id', id) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-subscriptions`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/trigger-invocations/status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription: async (id: string, subscriptionPatchRequestInnerV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSubscription', 'id', id) - // verify required parameter 'subscriptionPatchRequestInnerV2026' is not null or undefined - assertParamExists('patchSubscription', 'subscriptionPatchRequestInnerV2026', subscriptionPatchRequestInnerV2026) - const localVarPath = `/trigger-subscriptions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(subscriptionPatchRequestInnerV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2026} testInvocationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation: async (testInvocationV2026: TestInvocationV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'testInvocationV2026' is not null or undefined - assertParamExists('startTestTriggerInvocation', 'testInvocationV2026', testInvocationV2026) - const localVarPath = `/trigger-invocations/test`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testInvocationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2026} validateFilterInputDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter: async (validateFilterInputDtoV2026: ValidateFilterInputDtoV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'validateFilterInputDtoV2026' is not null or undefined - assertParamExists('testSubscriptionFilter', 'validateFilterInputDtoV2026', validateFilterInputDtoV2026) - const localVarPath = `/trigger-subscriptions/validate-filter`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(validateFilterInputDtoV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2026} subscriptionPutRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription: async (id: string, subscriptionPutRequestV2026: SubscriptionPutRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSubscription', 'id', id) - // verify required parameter 'subscriptionPutRequestV2026' is not null or undefined - assertParamExists('updateSubscription', 'subscriptionPutRequestV2026', subscriptionPutRequestV2026) - const localVarPath = `/trigger-subscriptions/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(subscriptionPutRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TriggersV2026Api - functional programming interface - * @export - */ -export const TriggersV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TriggersV2026ApiAxiosParamCreator(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {string} id The ID of the invocation to complete. - * @param {CompleteInvocationV2026} completeInvocationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeTriggerInvocation(id: string, completeInvocationV2026: CompleteInvocationV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeTriggerInvocation(id, completeInvocationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.completeTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {SubscriptionPostRequestV2026} subscriptionPostRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSubscription(subscriptionPostRequestV2026: SubscriptionPostRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(subscriptionPostRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.createSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {string} id Subscription ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSubscription(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscription(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.deleteSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **triggerId**: *eq* **type**: *eq, 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: **triggerId, triggerName** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSubscriptions(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSubscriptions(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.listSubscriptions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **triggerId**: *eq* **subscriptionId**: *eq* - * @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: **triggerId, subscriptionName, created, completed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggerInvocationStatus(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggerInvocationStatus(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.listTriggerInvocationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, 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, name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTriggers(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTriggers(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.listTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {string} id ID of the Subscription to patch - * @param {Array} subscriptionPatchRequestInnerV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSubscription(id: string, subscriptionPatchRequestInnerV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSubscription(id, subscriptionPatchRequestInnerV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.patchSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TestInvocationV2026} testInvocationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startTestTriggerInvocation(testInvocationV2026: TestInvocationV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startTestTriggerInvocation(testInvocationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.startTestTriggerInvocation']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {ValidateFilterInputDtoV2026} validateFilterInputDtoV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testSubscriptionFilter(validateFilterInputDtoV2026: ValidateFilterInputDtoV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testSubscriptionFilter(validateFilterInputDtoV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.testSubscriptionFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {string} id Subscription ID - * @param {SubscriptionPutRequestV2026} subscriptionPutRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSubscription(id: string, subscriptionPutRequestV2026: SubscriptionPutRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSubscription(id, subscriptionPutRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TriggersV2026Api.updateSubscription']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TriggersV2026Api - factory interface - * @export - */ -export const TriggersV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TriggersV2026ApiFp(configuration) - return { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2026ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeTriggerInvocation(requestParameters: TriggersV2026ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2026ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSubscription(requestParameters: TriggersV2026ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSubscription(requestParameters.subscriptionPostRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2026ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSubscription(requestParameters: TriggersV2026ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2026ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSubscriptions(requestParameters: TriggersV2026ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2026ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggerInvocationStatus(requestParameters: TriggersV2026ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2026ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTriggers(requestParameters: TriggersV2026ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2026ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSubscription(requestParameters: TriggersV2026ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2026ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startTestTriggerInvocation(requestParameters: TriggersV2026ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.startTestTriggerInvocation(requestParameters.testInvocationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2026ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testSubscriptionFilter(requestParameters: TriggersV2026ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testSubscriptionFilter(requestParameters.validateFilterInputDtoV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2026ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSubscription(requestParameters: TriggersV2026ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeTriggerInvocation operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiCompleteTriggerInvocationRequest - */ -export interface TriggersV2026ApiCompleteTriggerInvocationRequest { - /** - * The ID of the invocation to complete. - * @type {string} - * @memberof TriggersV2026ApiCompleteTriggerInvocation - */ - readonly id: string - - /** - * - * @type {CompleteInvocationV2026} - * @memberof TriggersV2026ApiCompleteTriggerInvocation - */ - readonly completeInvocationV2026: CompleteInvocationV2026 -} - -/** - * Request parameters for createSubscription operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiCreateSubscriptionRequest - */ -export interface TriggersV2026ApiCreateSubscriptionRequest { - /** - * - * @type {SubscriptionPostRequestV2026} - * @memberof TriggersV2026ApiCreateSubscription - */ - readonly subscriptionPostRequestV2026: SubscriptionPostRequestV2026 -} - -/** - * Request parameters for deleteSubscription operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiDeleteSubscriptionRequest - */ -export interface TriggersV2026ApiDeleteSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2026ApiDeleteSubscription - */ - readonly id: string -} - -/** - * Request parameters for listSubscriptions operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiListSubscriptionsRequest - */ -export interface TriggersV2026ApiListSubscriptionsRequest { - /** - * 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 TriggersV2026ApiListSubscriptions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2026ApiListSubscriptions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2026ApiListSubscriptions - */ - 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* **triggerId**: *eq* **type**: *eq, le* - * @type {string} - * @memberof TriggersV2026ApiListSubscriptions - */ - 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: **triggerId, triggerName** - * @type {string} - * @memberof TriggersV2026ApiListSubscriptions - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggerInvocationStatus operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiListTriggerInvocationStatusRequest - */ -export interface TriggersV2026ApiListTriggerInvocationStatusRequest { - /** - * 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 TriggersV2026ApiListTriggerInvocationStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2026ApiListTriggerInvocationStatus - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2026ApiListTriggerInvocationStatus - */ - 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: **triggerId**: *eq* **subscriptionId**: *eq* - * @type {string} - * @memberof TriggersV2026ApiListTriggerInvocationStatus - */ - 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: **triggerId, subscriptionName, created, completed** - * @type {string} - * @memberof TriggersV2026ApiListTriggerInvocationStatus - */ - readonly sorters?: string -} - -/** - * Request parameters for listTriggers operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiListTriggersRequest - */ -export interface TriggersV2026ApiListTriggersRequest { - /** - * 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 TriggersV2026ApiListTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TriggersV2026ApiListTriggers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TriggersV2026ApiListTriggers - */ - 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, ge, le* - * @type {string} - * @memberof TriggersV2026ApiListTriggers - */ - 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, name** - * @type {string} - * @memberof TriggersV2026ApiListTriggers - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSubscription operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiPatchSubscriptionRequest - */ -export interface TriggersV2026ApiPatchSubscriptionRequest { - /** - * ID of the Subscription to patch - * @type {string} - * @memberof TriggersV2026ApiPatchSubscription - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof TriggersV2026ApiPatchSubscription - */ - readonly subscriptionPatchRequestInnerV2026: Array -} - -/** - * Request parameters for startTestTriggerInvocation operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiStartTestTriggerInvocationRequest - */ -export interface TriggersV2026ApiStartTestTriggerInvocationRequest { - /** - * - * @type {TestInvocationV2026} - * @memberof TriggersV2026ApiStartTestTriggerInvocation - */ - readonly testInvocationV2026: TestInvocationV2026 -} - -/** - * Request parameters for testSubscriptionFilter operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiTestSubscriptionFilterRequest - */ -export interface TriggersV2026ApiTestSubscriptionFilterRequest { - /** - * - * @type {ValidateFilterInputDtoV2026} - * @memberof TriggersV2026ApiTestSubscriptionFilter - */ - readonly validateFilterInputDtoV2026: ValidateFilterInputDtoV2026 -} - -/** - * Request parameters for updateSubscription operation in TriggersV2026Api. - * @export - * @interface TriggersV2026ApiUpdateSubscriptionRequest - */ -export interface TriggersV2026ApiUpdateSubscriptionRequest { - /** - * Subscription ID - * @type {string} - * @memberof TriggersV2026ApiUpdateSubscription - */ - readonly id: string - - /** - * - * @type {SubscriptionPutRequestV2026} - * @memberof TriggersV2026ApiUpdateSubscription - */ - readonly subscriptionPutRequestV2026: SubscriptionPutRequestV2026 -} - -/** - * TriggersV2026Api - object-oriented interface - * @export - * @class TriggersV2026Api - * @extends {BaseAPI} - */ -export class TriggersV2026Api extends BaseAPI { - /** - * Completes an invocation to a REQUEST_RESPONSE type trigger. - * @summary Complete trigger invocation - * @param {TriggersV2026ApiCompleteTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public completeTriggerInvocation(requestParameters: TriggersV2026ApiCompleteTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).completeTriggerInvocation(requestParameters.id, requestParameters.completeInvocationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig - * @summary Create a subscription - * @param {TriggersV2026ApiCreateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public createSubscription(requestParameters: TriggersV2026ApiCreateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).createSubscription(requestParameters.subscriptionPostRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes an existing subscription to a trigger. - * @summary Delete a subscription - * @param {TriggersV2026ApiDeleteSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public deleteSubscription(requestParameters: TriggersV2026ApiDeleteSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).deleteSubscription(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all trigger subscriptions. - * @summary List subscriptions - * @param {TriggersV2026ApiListSubscriptionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public listSubscriptions(requestParameters: TriggersV2026ApiListSubscriptionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).listSubscriptions(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - * @summary List latest invocation statuses - * @param {TriggersV2026ApiListTriggerInvocationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public listTriggerInvocationStatus(requestParameters: TriggersV2026ApiListTriggerInvocationStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).listTriggerInvocationStatus(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of triggers that are available in the tenant. - * @summary List triggers - * @param {TriggersV2026ApiListTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public listTriggers(requestParameters: TriggersV2026ApiListTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).listTriggers(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - * @summary Patch a subscription - * @param {TriggersV2026ApiPatchSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public patchSubscription(requestParameters: TriggersV2026ApiPatchSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).patchSubscription(requestParameters.id, requestParameters.subscriptionPatchRequestInnerV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - * @summary Start a test invocation - * @param {TriggersV2026ApiStartTestTriggerInvocationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public startTestTriggerInvocation(requestParameters: TriggersV2026ApiStartTestTriggerInvocationRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).startTestTriggerInvocation(requestParameters.testInvocationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: - * @summary Validate a subscription filter - * @param {TriggersV2026ApiTestSubscriptionFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public testSubscriptionFilter(requestParameters: TriggersV2026ApiTestSubscriptionFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).testSubscriptionFilter(requestParameters.validateFilterInputDtoV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: * id * triggerId Attempts to modify these fields result in 400. - * @summary Update a subscription - * @param {TriggersV2026ApiUpdateSubscriptionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TriggersV2026Api - */ - public updateSubscription(requestParameters: TriggersV2026ApiUpdateSubscriptionRequest, axiosOptions?: RawAxiosRequestConfig) { - return TriggersV2026ApiFp(this.configuration).updateSubscription(requestParameters.id, requestParameters.subscriptionPutRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * UIMetadataV2026Api - axios parameter creator - * @export - */ -export const UIMetadataV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2026} tenantUiMetadataItemUpdateRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata: async (tenantUiMetadataItemUpdateRequestV2026: TenantUiMetadataItemUpdateRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantUiMetadataItemUpdateRequestV2026' is not null or undefined - assertParamExists('setTenantUiMetadata', 'tenantUiMetadataItemUpdateRequestV2026', tenantUiMetadataItemUpdateRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/ui-metadata/tenant`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantUiMetadataItemUpdateRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * UIMetadataV2026Api - functional programming interface - * @export - */ -export const UIMetadataV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UIMetadataV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantUiMetadata(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantUiMetadata(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2026Api.getTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {TenantUiMetadataItemUpdateRequestV2026} tenantUiMetadataItemUpdateRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2026: TenantUiMetadataItemUpdateRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTenantUiMetadata(tenantUiMetadataItemUpdateRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['UIMetadataV2026Api.setTenantUiMetadata']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * UIMetadataV2026Api - factory interface - * @export - */ -export const UIMetadataV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UIMetadataV2026ApiFp(configuration) - return { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2026ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantUiMetadata(requestParameters: UIMetadataV2026ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2026ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTenantUiMetadata(requestParameters: UIMetadataV2026ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getTenantUiMetadata operation in UIMetadataV2026Api. - * @export - * @interface UIMetadataV2026ApiGetTenantUiMetadataRequest - */ -export interface UIMetadataV2026ApiGetTenantUiMetadataRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2026ApiGetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for setTenantUiMetadata operation in UIMetadataV2026Api. - * @export - * @interface UIMetadataV2026ApiSetTenantUiMetadataRequest - */ -export interface UIMetadataV2026ApiSetTenantUiMetadataRequest { - /** - * - * @type {TenantUiMetadataItemUpdateRequestV2026} - * @memberof UIMetadataV2026ApiSetTenantUiMetadata - */ - readonly tenantUiMetadataItemUpdateRequestV2026: TenantUiMetadataItemUpdateRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof UIMetadataV2026ApiSetTenantUiMetadata - */ - readonly xSailPointExperimental?: string -} - -/** - * UIMetadataV2026Api - object-oriented interface - * @export - * @class UIMetadataV2026Api - * @extends {BaseAPI} - */ -export class UIMetadataV2026Api extends BaseAPI { - /** - * This API endpoint retrieves UI metadata configured for your tenant. - * @summary Get a tenant ui metadata - * @param {UIMetadataV2026ApiGetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2026Api - */ - public getTenantUiMetadata(requestParameters: UIMetadataV2026ApiGetTenantUiMetadataRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2026ApiFp(this.configuration).getTenantUiMetadata(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. - * @summary Update tenant ui metadata - * @param {UIMetadataV2026ApiSetTenantUiMetadataRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof UIMetadataV2026Api - */ - public setTenantUiMetadata(requestParameters: UIMetadataV2026ApiSetTenantUiMetadataRequest, axiosOptions?: RawAxiosRequestConfig) { - return UIMetadataV2026ApiFp(this.configuration).setTenantUiMetadata(requestParameters.tenantUiMetadataItemUpdateRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkItemsV2026Api - axios parameter creator - * @export - */ -export const WorkItemsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('approveApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/approve/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeWorkItem', 'id', id) - const localVarPath = `/work-items/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2026} workItemForwardV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem: async (id: string, workItemForwardV2026: WorkItemForwardV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('forwardWorkItem', 'id', id) - // verify required parameter 'workItemForwardV2026' is not null or undefined - assertParamExists('forwardWorkItem', 'workItemForwardV2026', workItemForwardV2026) - const localVarPath = `/work-items/{id}/forward` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workItemForwardV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkItem', 'id', id) - const localVarPath = `/work-items/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('rejectApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/reject/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitAccountSelection', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('submitAccountSelection', 'requestBody', requestBody) - const localVarPath = `/work-items/{id}/submit-account-selection` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkItemsV2026Api - functional programming interface - * @export - */ -export const WorkItemsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkItemsV2026ApiAxiosParamCreator(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.approveApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.approveApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.completeWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForwardV2026} workItemForwardV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardWorkItem(id: string, workItemForwardV2026: WorkItemForwardV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardWorkItem(id, workItemForwardV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.forwardWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItems(ownerId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.getCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountCompletedWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.getCountCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.getCountWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItem(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.getWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItemsSummary(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummary(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.getWorkItemsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkItems(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItems(limit, offset, count, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.listWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.rejectApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.rejectApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitAccountSelection(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelection(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsV2026Api.submitAccountSelection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkItemsV2026Api - factory interface - * @export - */ -export const WorkItemsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkItemsV2026ApiFp(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2026ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem(requestParameters: WorkItemsV2026ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2026ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk(requestParameters: WorkItemsV2026ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2026ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem(requestParameters: WorkItemsV2026ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2026ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardWorkItem(requestParameters: WorkItemsV2026ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2026ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems(requestParameters: WorkItemsV2026ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2026ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems(requestParameters: WorkItemsV2026ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2026ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems(requestParameters: WorkItemsV2026ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2026ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem(requestParameters: WorkItemsV2026ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItem(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2026ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary(requestParameters: WorkItemsV2026ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2026ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems(requestParameters: WorkItemsV2026ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2026ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem(requestParameters: WorkItemsV2026ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2026ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk(requestParameters: WorkItemsV2026ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2026ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection(requestParameters: WorkItemsV2026ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApprovalItem operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiApproveApprovalItemRequest - */ -export interface WorkItemsV2026ApiApproveApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiApproveApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2026ApiApproveApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for approveApprovalItemsInBulk operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiApproveApprovalItemsInBulkRequest - */ -export interface WorkItemsV2026ApiApproveApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiApproveApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for completeWorkItem operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiCompleteWorkItemRequest - */ -export interface WorkItemsV2026ApiCompleteWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiCompleteWorkItem - */ - readonly id: string - - /** - * Body is the request payload to create form definition request - * @type {string} - * @memberof WorkItemsV2026ApiCompleteWorkItem - */ - readonly body?: string | null -} - -/** - * Request parameters for forwardWorkItem operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiForwardWorkItemRequest - */ -export interface WorkItemsV2026ApiForwardWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiForwardWorkItem - */ - readonly id: string - - /** - * - * @type {WorkItemForwardV2026} - * @memberof WorkItemsV2026ApiForwardWorkItem - */ - readonly workItemForwardV2026: WorkItemForwardV2026 -} - -/** - * Request parameters for getCompletedWorkItems operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiGetCompletedWorkItemsRequest - */ -export interface WorkItemsV2026ApiGetCompletedWorkItemsRequest { - /** - * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @type {string} - * @memberof WorkItemsV2026ApiGetCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2026ApiGetCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2026ApiGetCompletedWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2026ApiGetCompletedWorkItems - */ - readonly count?: boolean -} - -/** - * Request parameters for getCountCompletedWorkItems operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiGetCountCompletedWorkItemsRequest - */ -export interface WorkItemsV2026ApiGetCountCompletedWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2026ApiGetCountCompletedWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getCountWorkItems operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiGetCountWorkItemsRequest - */ -export interface WorkItemsV2026ApiGetCountWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2026ApiGetCountWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItem operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiGetWorkItemRequest - */ -export interface WorkItemsV2026ApiGetWorkItemRequest { - /** - * ID of the work item. - * @type {string} - * @memberof WorkItemsV2026ApiGetWorkItem - */ - readonly id: string -} - -/** - * Request parameters for getWorkItemsSummary operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiGetWorkItemsSummaryRequest - */ -export interface WorkItemsV2026ApiGetWorkItemsSummaryRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2026ApiGetWorkItemsSummary - */ - readonly ownerId?: string -} - -/** - * Request parameters for listWorkItems operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiListWorkItemsRequest - */ -export interface WorkItemsV2026ApiListWorkItemsRequest { - /** - * 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 WorkItemsV2026ApiListWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsV2026ApiListWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsV2026ApiListWorkItems - */ - readonly count?: boolean - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsV2026ApiListWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for rejectApprovalItem operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiRejectApprovalItemRequest - */ -export interface WorkItemsV2026ApiRejectApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiRejectApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsV2026ApiRejectApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for rejectApprovalItemsInBulk operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiRejectApprovalItemsInBulkRequest - */ -export interface WorkItemsV2026ApiRejectApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiRejectApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for submitAccountSelection operation in WorkItemsV2026Api. - * @export - * @interface WorkItemsV2026ApiSubmitAccountSelectionRequest - */ -export interface WorkItemsV2026ApiSubmitAccountSelectionRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsV2026ApiSubmitAccountSelection - */ - readonly id: string - - /** - * Account Selection Data map, keyed on fieldName - * @type {{ [key: string]: any; }} - * @memberof WorkItemsV2026ApiSubmitAccountSelection - */ - readonly requestBody: { [key: string]: any; } -} - -/** - * WorkItemsV2026Api - object-oriented interface - * @export - * @class WorkItemsV2026Api - * @extends {BaseAPI} - */ -export class WorkItemsV2026Api extends BaseAPI { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsV2026ApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public approveApprovalItem(requestParameters: WorkItemsV2026ApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsV2026ApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public approveApprovalItemsInBulk(requestParameters: WorkItemsV2026ApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsV2026ApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public completeWorkItem(requestParameters: WorkItemsV2026ApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - * @summary Forward a work item - * @param {WorkItemsV2026ApiForwardWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public forwardWorkItem(requestParameters: WorkItemsV2026ApiForwardWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).forwardWorkItem(requestParameters.id, requestParameters.workItemForwardV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsV2026ApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public getCompletedWorkItems(requestParameters: WorkItemsV2026ApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsV2026ApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public getCountCompletedWorkItems(requestParameters: WorkItemsV2026ApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsV2026ApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public getCountWorkItems(requestParameters: WorkItemsV2026ApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsV2026ApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public getWorkItem(requestParameters: WorkItemsV2026ApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).getWorkItem(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsV2026ApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public getWorkItemsSummary(requestParameters: WorkItemsV2026ApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsV2026ApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public listWorkItems(requestParameters: WorkItemsV2026ApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsV2026ApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public rejectApprovalItem(requestParameters: WorkItemsV2026ApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsV2026ApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public rejectApprovalItemsInBulk(requestParameters: WorkItemsV2026ApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsV2026ApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsV2026Api - */ - public submitAccountSelection(requestParameters: WorkItemsV2026ApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsV2026ApiFp(this.configuration).submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkReassignmentV2026Api - axios parameter creator - * @export - */ -export const WorkReassignmentV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2026} configurationItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration: async (configurationItemRequestV2026: ConfigurationItemRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'configurationItemRequestV2026' is not null or undefined - assertParamExists('createReassignmentConfiguration', 'configurationItemRequestV2026', configurationItemRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2026} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('deleteReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2026} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration: async (identityId: string, configType: ConfigTypeEnumV2026, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'identityId', identityId) - // verify required parameter 'configType' is not null or undefined - assertParamExists('getEvaluateReassignmentConfiguration', 'configType', configType) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}/evaluate/{configType}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) - .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (exclusionFilters) { - localVarQueryParameter['exclusionFilters'] = exclusionFilters.join(COLLECTION_FORMATS.csv); - } - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('getReassignmentConfiguration', 'identityId', identityId) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2026} configurationItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig: async (identityId: string, configurationItemRequestV2026: ConfigurationItemRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('putReassignmentConfig', 'identityId', identityId) - // verify required parameter 'configurationItemRequestV2026' is not null or undefined - assertParamExists('putReassignmentConfig', 'configurationItemRequestV2026', configurationItemRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/{identityId}` - .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(configurationItemRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2026} tenantConfigurationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration: async (tenantConfigurationRequestV2026: TenantConfigurationRequestV2026, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tenantConfigurationRequestV2026' is not null or undefined - assertParamExists('putTenantConfiguration', 'tenantConfigurationRequestV2026', tenantConfigurationRequestV2026) - if (xSailPointExperimental === undefined) { - xSailPointExperimental = 'true'; - } - - const localVarPath = `/reassignment-configurations/tenant-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - if (xSailPointExperimental != null) { - localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); - } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tenantConfigurationRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkReassignmentV2026Api - functional programming interface - * @export - */ -export const WorkReassignmentV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkReassignmentV2026ApiAxiosParamCreator(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {ConfigurationItemRequestV2026} configurationItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createReassignmentConfiguration(configurationItemRequestV2026: ConfigurationItemRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createReassignmentConfiguration(configurationItemRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.createReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2026} configType - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReassignmentConfiguration(identityId, configType, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.deleteReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigTypeEnumV2026} configType Reassignment work type - * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEvaluateReassignmentConfiguration(identityId: string, configType: ConfigTypeEnumV2026, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluateReassignmentConfiguration(identityId, configType, exclusionFilters, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.getEvaluateReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfigTypes(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigTypes(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.getReassignmentConfigTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {string} identityId unique identity id - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReassignmentConfiguration(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfiguration(identityId, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.getReassignmentConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTenantConfigConfiguration(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantConfigConfiguration(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.getTenantConfigConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listReassignmentConfigurations(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReassignmentConfigurations(xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.listReassignmentConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {string} identityId unique identity id - * @param {ConfigurationItemRequestV2026} configurationItemRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putReassignmentConfig(identityId: string, configurationItemRequestV2026: ConfigurationItemRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putReassignmentConfig(identityId, configurationItemRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.putReassignmentConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {TenantConfigurationRequestV2026} tenantConfigurationRequestV2026 - * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTenantConfiguration(tenantConfigurationRequestV2026: TenantConfigurationRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTenantConfiguration(tenantConfigurationRequestV2026, xSailPointExperimental, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV2026Api.putTenantConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkReassignmentV2026Api - factory interface - * @export - */ -export const WorkReassignmentV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkReassignmentV2026ApiFp(configuration) - return { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createReassignmentConfiguration(requestParameters.configurationItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfigTypes(requestParameters: WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2026ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTenantConfigConfiguration(requestParameters: WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2026ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listReassignmentConfigurations(requestParameters: WorkReassignmentV2026ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2026ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putReassignmentConfig(requestParameters: WorkReassignmentV2026ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2026ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTenantConfiguration(requestParameters: WorkReassignmentV2026ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTenantConfiguration(requestParameters.tenantConfigurationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createReassignmentConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest { - /** - * - * @type {ConfigurationItemRequestV2026} - * @memberof WorkReassignmentV2026ApiCreateReassignmentConfiguration - */ - readonly configurationItemRequestV2026: ConfigurationItemRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiCreateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for deleteReassignmentConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2026ApiDeleteReassignmentConfiguration - */ - readonly identityId: string - - /** - * - * @type {ConfigTypeEnumV2026} - * @memberof WorkReassignmentV2026ApiDeleteReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiDeleteReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getEvaluateReassignmentConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2026ApiGetEvaluateReassignmentConfiguration - */ - readonly identityId: string - - /** - * Reassignment work type - * @type {ConfigTypeEnumV2026} - * @memberof WorkReassignmentV2026ApiGetEvaluateReassignmentConfiguration - */ - readonly configType: ConfigTypeEnumV2026 - - /** - * Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - * @type {Array} - * @memberof WorkReassignmentV2026ApiGetEvaluateReassignmentConfiguration - */ - readonly exclusionFilters?: Array - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiGetEvaluateReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfigTypes operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest - */ -export interface WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiGetReassignmentConfigTypes - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getReassignmentConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiGetReassignmentConfigurationRequest - */ -export interface WorkReassignmentV2026ApiGetReassignmentConfigurationRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2026ApiGetReassignmentConfiguration - */ - readonly identityId: string - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiGetReassignmentConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for getTenantConfigConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest - */ -export interface WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiGetTenantConfigConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for listReassignmentConfigurations operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiListReassignmentConfigurationsRequest - */ -export interface WorkReassignmentV2026ApiListReassignmentConfigurationsRequest { - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiListReassignmentConfigurations - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putReassignmentConfig operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiPutReassignmentConfigRequest - */ -export interface WorkReassignmentV2026ApiPutReassignmentConfigRequest { - /** - * unique identity id - * @type {string} - * @memberof WorkReassignmentV2026ApiPutReassignmentConfig - */ - readonly identityId: string - - /** - * - * @type {ConfigurationItemRequestV2026} - * @memberof WorkReassignmentV2026ApiPutReassignmentConfig - */ - readonly configurationItemRequestV2026: ConfigurationItemRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiPutReassignmentConfig - */ - readonly xSailPointExperimental?: string -} - -/** - * Request parameters for putTenantConfiguration operation in WorkReassignmentV2026Api. - * @export - * @interface WorkReassignmentV2026ApiPutTenantConfigurationRequest - */ -export interface WorkReassignmentV2026ApiPutTenantConfigurationRequest { - /** - * - * @type {TenantConfigurationRequestV2026} - * @memberof WorkReassignmentV2026ApiPutTenantConfiguration - */ - readonly tenantConfigurationRequestV2026: TenantConfigurationRequestV2026 - - /** - * Use this header to enable this experimental API. - * @type {string} - * @memberof WorkReassignmentV2026ApiPutTenantConfiguration - */ - readonly xSailPointExperimental?: string -} - -/** - * WorkReassignmentV2026Api - object-oriented interface - * @export - * @class WorkReassignmentV2026Api - * @extends {BaseAPI} - */ -export class WorkReassignmentV2026Api extends BaseAPI { - /** - * Creates a new Reassignment Configuration for the specified identity. - * @summary Create a reassignment configuration - * @param {WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public createReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiCreateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).createReassignmentConfiguration(requestParameters.configurationItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes a single reassignment configuration for the specified identity - * @summary Delete reassignment configuration - * @param {WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public deleteReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiDeleteReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).deleteReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - * @summary Evaluate reassignment configuration - * @param {WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public getEvaluateReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiGetEvaluateReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).getEvaluateReassignmentConfiguration(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a collection of types which are available in the Reassignment Configuration UI. - * @summary List reassignment config types - * @param {WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public getReassignmentConfigTypes(requestParameters: WorkReassignmentV2026ApiGetReassignmentConfigTypesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).getReassignmentConfigTypes(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the Reassignment Configuration for an identity. - * @summary Get reassignment configuration - * @param {WorkReassignmentV2026ApiGetReassignmentConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public getReassignmentConfiguration(requestParameters: WorkReassignmentV2026ApiGetReassignmentConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).getReassignmentConfiguration(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets the global Reassignment Configuration settings for the requestor\'s tenant. - * @summary Get tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public getTenantConfigConfiguration(requestParameters: WorkReassignmentV2026ApiGetTenantConfigConfigurationRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).getTenantConfigConfiguration(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets all Reassignment configuration for the current org. - * @summary List reassignment configurations - * @param {WorkReassignmentV2026ApiListReassignmentConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public listReassignmentConfigurations(requestParameters: WorkReassignmentV2026ApiListReassignmentConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).listReassignmentConfigurations(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Reassignment configuration for an identity with the newly provided configuration. - * @summary Update reassignment configuration - * @param {WorkReassignmentV2026ApiPutReassignmentConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public putReassignmentConfig(requestParameters: WorkReassignmentV2026ApiPutReassignmentConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).putReassignmentConfig(requestParameters.identityId, requestParameters.configurationItemRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - * @summary Update tenant-wide reassignment configuration settings - * @param {WorkReassignmentV2026ApiPutTenantConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkReassignmentV2026Api - */ - public putTenantConfiguration(requestParameters: WorkReassignmentV2026ApiPutTenantConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkReassignmentV2026ApiFp(this.configuration).putTenantConfiguration(requestParameters.tenantConfigurationRequestV2026, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkflowsV2026Api - axios parameter creator - * @export - */ -export const WorkflowsV2026ApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2026} [createExternalExecuteWorkflowRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow: async (id: string, createExternalExecuteWorkflowRequestV2026?: CreateExternalExecuteWorkflowRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createExternalExecuteWorkflowRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2026} createWorkflowRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow: async (createWorkflowRequestV2026: CreateWorkflowRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createWorkflowRequestV2026' is not null or undefined - assertParamExists('createWorkflow', 'createWorkflowRequestV2026', createWorkflowRequestV2026) - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createWorkflowRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createWorkflowExternalTrigger', 'id', id) - const localVarPath = `/workflows/{id}/external/oauth-clients` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistory', 'id', id) - const localVarPath = `/workflow-executions/{id}/history` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistoryV2: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistoryV2', 'id', id) - const localVarPath = `/workflow-executions/{id}/history-v2` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutions', 'id', id) - const localVarPath = `/workflows/{id}/executions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/operators`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow: async (id: string, jsonPatchOperationV2026: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkflow', 'id', id) - // verify required parameter 'jsonPatchOperationV2026' is not null or undefined - assertParamExists('patchWorkflow', 'jsonPatchOperationV2026', jsonPatchOperationV2026) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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(jsonPatchOperationV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2026} workflowBodyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow: async (id: string, workflowBodyV2026: WorkflowBodyV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putWorkflow', 'id', id) - // verify required parameter 'workflowBodyV2026' is not null or undefined - assertParamExists('putWorkflow', 'workflowBodyV2026', workflowBodyV2026) - const localVarPath = `/workflows/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workflowBodyV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2026} [testExternalExecuteWorkflowRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow: async (id: string, testExternalExecuteWorkflowRequestV2026?: TestExternalExecuteWorkflowRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testExternalExecuteWorkflowRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2026} testWorkflowRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow: async (id: string, testWorkflowRequestV2026: TestWorkflowRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testWorkflow', 'id', id) - // verify required parameter 'testWorkflowRequestV2026' is not null or undefined - assertParamExists('testWorkflow', 'testWorkflowRequestV2026', testWorkflowRequestV2026) - const localVarPath = `/workflows/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testWorkflowRequestV2026, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkflowsV2026Api - functional programming interface - * @export - */ -export const WorkflowsV2026ApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkflowsV2026ApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.cancelWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequestV2026} [createExternalExecuteWorkflowRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createExternalExecuteWorkflow(id: string, createExternalExecuteWorkflowRequestV2026?: CreateExternalExecuteWorkflowRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createExternalExecuteWorkflow(id, createExternalExecuteWorkflowRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.createExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequestV2026} createWorkflowRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflow(createWorkflowRequestV2026: CreateWorkflowRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflow(createWorkflowRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.createWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowExternalTrigger(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.createWorkflowExternalTrigger']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.deleteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.getWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.getWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutionHistory(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistory(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.getWorkflowExecutionHistory']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutionHistoryV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistoryV2(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.getWorkflowExecutionHistoryV2']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutions(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.getWorkflowExecutions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompleteWorkflowLibrary(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibrary(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.listCompleteWorkflowLibrary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryActions(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActions(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.listWorkflowLibraryActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperators(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.listWorkflowLibraryOperators']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryTriggers(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggers(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.listWorkflowLibraryTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflows(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflows(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.listWorkflows']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperationV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkflow(id: string, jsonPatchOperationV2026: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflow(id, jsonPatchOperationV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.patchWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBodyV2026} workflowBodyV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putWorkflow(id: string, workflowBodyV2026: WorkflowBodyV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflow(id, workflowBodyV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.putWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequestV2026} [testExternalExecuteWorkflowRequestV2026] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequestV2026?: TestExternalExecuteWorkflowRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflow(id, testExternalExecuteWorkflowRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.testExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequestV2026} testWorkflowRequestV2026 - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testWorkflow(id: string, testWorkflowRequestV2026: TestWorkflowRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflow(id, testWorkflowRequestV2026, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsV2026Api.testWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkflowsV2026Api - factory interface - * @export - */ -export const WorkflowsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkflowsV2026ApiFp(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2026ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution(requestParameters: WorkflowsV2026ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow(requestParameters: WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2026ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow(requestParameters: WorkflowsV2026ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflow(requestParameters.createWorkflowRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger(requestParameters: WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2026ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow(requestParameters: WorkflowsV2026ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2026ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow(requestParameters: WorkflowsV2026ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2026ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistory(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2026ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2026ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary(requestParameters: WorkflowsV2026ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2026ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions(requestParameters: WorkflowsV2026ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryOperators(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2026ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers(requestParameters: WorkflowsV2026ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflows(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2026ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow(requestParameters: WorkflowsV2026ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2026ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow(requestParameters: WorkflowsV2026ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putWorkflow(requestParameters.id, requestParameters.workflowBodyV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2026ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow(requestParameters: WorkflowsV2026ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2026ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow(requestParameters: WorkflowsV2026ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2026, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelWorkflowExecution operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiCancelWorkflowExecutionRequest - */ -export interface WorkflowsV2026ApiCancelWorkflowExecutionRequest { - /** - * The workflow execution ID - * @type {string} - * @memberof WorkflowsV2026ApiCancelWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for createExternalExecuteWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2026ApiCreateExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {CreateExternalExecuteWorkflowRequestV2026} - * @memberof WorkflowsV2026ApiCreateExternalExecuteWorkflow - */ - readonly createExternalExecuteWorkflowRequestV2026?: CreateExternalExecuteWorkflowRequestV2026 -} - -/** - * Request parameters for createWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiCreateWorkflowRequest - */ -export interface WorkflowsV2026ApiCreateWorkflowRequest { - /** - * - * @type {CreateWorkflowRequestV2026} - * @memberof WorkflowsV2026ApiCreateWorkflow - */ - readonly createWorkflowRequestV2026: CreateWorkflowRequestV2026 -} - -/** - * Request parameters for createWorkflowExternalTrigger operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest - */ -export interface WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2026ApiCreateWorkflowExternalTrigger - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiDeleteWorkflowRequest - */ -export interface WorkflowsV2026ApiDeleteWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2026ApiDeleteWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiGetWorkflowRequest - */ -export interface WorkflowsV2026ApiGetWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecution operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiGetWorkflowExecutionRequest - */ -export interface WorkflowsV2026ApiGetWorkflowExecutionRequest { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistory operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest - */ -export interface WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflowExecutionHistory - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistoryV2 operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request - */ -export interface WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflowExecutionHistoryV2 - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutions operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiGetWorkflowExecutionsRequest - */ -export interface WorkflowsV2026ApiGetWorkflowExecutionsRequest { - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflowExecutions - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2026ApiGetWorkflowExecutions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2026ApiGetWorkflowExecutions - */ - readonly offset?: number - - /** - * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @type {string} - * @memberof WorkflowsV2026ApiGetWorkflowExecutions - */ - readonly filters?: string -} - -/** - * Request parameters for listCompleteWorkflowLibrary operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiListCompleteWorkflowLibraryRequest - */ -export interface WorkflowsV2026ApiListCompleteWorkflowLibraryRequest { - /** - * 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 WorkflowsV2026ApiListCompleteWorkflowLibrary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2026ApiListCompleteWorkflowLibrary - */ - readonly offset?: number -} - -/** - * Request parameters for listWorkflowLibraryActions operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiListWorkflowLibraryActionsRequest - */ -export interface WorkflowsV2026ApiListWorkflowLibraryActionsRequest { - /** - * 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 WorkflowsV2026ApiListWorkflowLibraryActions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2026ApiListWorkflowLibraryActions - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsV2026ApiListWorkflowLibraryActions - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflowLibraryTriggers operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiListWorkflowLibraryTriggersRequest - */ -export interface WorkflowsV2026ApiListWorkflowLibraryTriggersRequest { - /** - * 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 WorkflowsV2026ApiListWorkflowLibraryTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsV2026ApiListWorkflowLibraryTriggers - */ - readonly offset?: number - - /** - * 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* **type**: *eq* - * @type {string} - * @memberof WorkflowsV2026ApiListWorkflowLibraryTriggers - */ - readonly filters?: string -} - -/** - * Request parameters for patchWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiPatchWorkflowRequest - */ -export interface WorkflowsV2026ApiPatchWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2026ApiPatchWorkflow - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof WorkflowsV2026ApiPatchWorkflow - */ - readonly jsonPatchOperationV2026: Array -} - -/** - * Request parameters for putWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiPutWorkflowRequest - */ -export interface WorkflowsV2026ApiPutWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsV2026ApiPutWorkflow - */ - readonly id: string - - /** - * - * @type {WorkflowBodyV2026} - * @memberof WorkflowsV2026ApiPutWorkflow - */ - readonly workflowBodyV2026: WorkflowBodyV2026 -} - -/** - * Request parameters for testExternalExecuteWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiTestExternalExecuteWorkflowRequest - */ -export interface WorkflowsV2026ApiTestExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2026ApiTestExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {TestExternalExecuteWorkflowRequestV2026} - * @memberof WorkflowsV2026ApiTestExternalExecuteWorkflow - */ - readonly testExternalExecuteWorkflowRequestV2026?: TestExternalExecuteWorkflowRequestV2026 -} - -/** - * Request parameters for testWorkflow operation in WorkflowsV2026Api. - * @export - * @interface WorkflowsV2026ApiTestWorkflowRequest - */ -export interface WorkflowsV2026ApiTestWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsV2026ApiTestWorkflow - */ - readonly id: string - - /** - * - * @type {TestWorkflowRequestV2026} - * @memberof WorkflowsV2026ApiTestWorkflow - */ - readonly testWorkflowRequestV2026: TestWorkflowRequestV2026 -} - -/** - * WorkflowsV2026Api - object-oriented interface - * @export - * @class WorkflowsV2026Api - * @extends {BaseAPI} - */ -export class WorkflowsV2026Api extends BaseAPI { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsV2026ApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public cancelWorkflowExecution(requestParameters: WorkflowsV2026ApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public createExternalExecuteWorkflow(requestParameters: WorkflowsV2026ApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsV2026ApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public createWorkflow(requestParameters: WorkflowsV2026ApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).createWorkflow(requestParameters.createWorkflowRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public createWorkflowExternalTrigger(requestParameters: WorkflowsV2026ApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsV2026ApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public deleteWorkflow(requestParameters: WorkflowsV2026ApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsV2026ApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public getWorkflow(requestParameters: WorkflowsV2026ApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).getWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsV2026ApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public getWorkflowExecution(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public getWorkflowExecutionHistory(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - * @summary Get updated workflow execution history - * @param {WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsV2026ApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public getWorkflowExecutions(requestParameters: WorkflowsV2026ApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsV2026ApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public listCompleteWorkflowLibrary(requestParameters: WorkflowsV2026ApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsV2026ApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public listWorkflowLibraryActions(requestParameters: WorkflowsV2026ApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).listWorkflowLibraryOperators(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsV2026ApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public listWorkflowLibraryTriggers(requestParameters: WorkflowsV2026ApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public listWorkflows(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).listWorkflows(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsV2026ApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public patchWorkflow(requestParameters: WorkflowsV2026ApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsV2026ApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public putWorkflow(requestParameters: WorkflowsV2026ApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).putWorkflow(requestParameters.id, requestParameters.workflowBodyV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsV2026ApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public testExternalExecuteWorkflow(requestParameters: WorkflowsV2026ApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - * @summary Test workflow by id - * @param {WorkflowsV2026ApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsV2026Api - */ - public testWorkflow(requestParameters: WorkflowsV2026ApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsV2026ApiFp(this.configuration).testWorkflow(requestParameters.id, requestParameters.testWorkflowRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - diff --git a/sdk-output/v3/README.md b/sdk-output/v3/README.md deleted file mode 100644 index 51f7499b..00000000 --- a/sdk-output/v3/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-sdk@1.8.69 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-sdk@1.8.69 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/v3/api.ts b/sdk-output/v3/api.ts deleted file mode 100644 index 2cd8f7a8..00000000 --- a/sdk-output/v3/api.ts +++ /dev/null @@ -1,66003 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Identity Security Cloud V3 API - * 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: 3.0.0 - * - * - * 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 Access - */ -export interface Access { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof Access - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof Access - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof Access - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof Access - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface AccessApps - */ -export interface AccessApps { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessApps - */ - 'id'?: string; - /** - * Name of application - * @type {string} - * @memberof AccessApps - */ - 'name'?: string; - /** - * Description of application. - * @type {string} - * @memberof AccessApps - */ - 'description'?: string; - /** - * - * @type {AccessAppsOwner} - * @memberof AccessApps - */ - 'owner'?: AccessAppsOwner; -} -/** - * Owner\'s identity. - * @export - * @interface AccessAppsOwner - */ -export interface AccessAppsOwner { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof AccessAppsOwner - */ - 'type'?: AccessAppsOwnerTypeV3; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof AccessAppsOwner - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof AccessAppsOwner - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof AccessAppsOwner - */ - 'email'?: string; -} - -export const AccessAppsOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccessAppsOwnerTypeV3 = typeof AccessAppsOwnerTypeV3[keyof typeof AccessAppsOwnerTypeV3]; - -/** - * - * @export - * @interface AccessConstraint - */ -export interface AccessConstraint { - /** - * Type of Access - * @type {string} - * @memberof AccessConstraint - */ - 'type': AccessConstraintTypeV3; - /** - * Must be set only if operator is SELECTED. - * @type {Array} - * @memberof AccessConstraint - */ - 'ids'?: Array; - /** - * Used to determine whether the scope of the campaign should be reduced for selected ids or all. - * @type {string} - * @memberof AccessConstraint - */ - 'operator': AccessConstraintOperatorV3; -} - -export const AccessConstraintTypeV3 = { - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; - -export type AccessConstraintTypeV3 = typeof AccessConstraintTypeV3[keyof typeof AccessConstraintTypeV3]; -export const AccessConstraintOperatorV3 = { - All: 'ALL', - Selected: 'SELECTED' -} as const; - -export type AccessConstraintOperatorV3 = typeof AccessConstraintOperatorV3[keyof typeof AccessConstraintOperatorV3]; - -/** - * - * @export - * @interface AccessCriteria - */ -export interface AccessCriteria { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteria - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteria - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessCriteriaCriteriaListInner - */ -export interface AccessCriteriaCriteriaListInner { - /** - * Type of the property to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInner - */ - 'type'?: AccessCriteriaCriteriaListInnerTypeV3; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInner - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaCriteriaListInner - */ - 'name'?: string; -} - -export const AccessCriteriaCriteriaListInnerTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaCriteriaListInnerTypeV3 = typeof AccessCriteriaCriteriaListInnerTypeV3[keyof typeof AccessCriteriaCriteriaListInnerTypeV3]; - -/** - * - * @export - * @interface AccessCriteriaRequest - */ -export interface AccessCriteriaRequest { - /** - * Business name for the access construct list - * @type {string} - * @memberof AccessCriteriaRequest - */ - 'name'?: string; - /** - * List of criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof AccessCriteriaRequest - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface AccessCriteriaRequestCriteriaListInner - */ -export interface AccessCriteriaRequestCriteriaListInner { - /** - * Type of the property to which this reference applies to - * @type {string} - * @memberof AccessCriteriaRequestCriteriaListInner - */ - 'type'?: AccessCriteriaRequestCriteriaListInnerTypeV3; - /** - * ID of the object to which this reference applies to - * @type {string} - * @memberof AccessCriteriaRequestCriteriaListInner - */ - 'id'?: string; -} - -export const AccessCriteriaRequestCriteriaListInnerTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessCriteriaRequestCriteriaListInnerTypeV3 = typeof AccessCriteriaRequestCriteriaListInnerTypeV3[keyof typeof AccessCriteriaRequestCriteriaListInnerTypeV3]; - -/** - * - * @export - * @interface AccessDuration - */ -export interface AccessDuration { - /** - * The numeric value representing the amount of time, which is defined in the **timeUnit**. - * @type {number} - * @memberof AccessDuration - */ - 'value'?: number; - /** - * The unit of time that corresponds to the **value**. It defines the scale of the time period. - * @type {string} - * @memberof AccessDuration - */ - 'timeUnit'?: AccessDurationTimeUnitV3; -} - -export const AccessDurationTimeUnitV3 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type AccessDurationTimeUnitV3 = typeof AccessDurationTimeUnitV3[keyof typeof AccessDurationTimeUnitV3]; - -/** - * Identity the access item is requested for. - * @export - * @interface AccessItemRequestedFor - */ -export interface AccessItemRequestedFor { - /** - * DTO type of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedFor - */ - 'type'?: AccessItemRequestedForTypeV3; - /** - * ID of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedFor - */ - 'id'?: string; - /** - * Human-readable display name of identity the access item is requested for. - * @type {string} - * @memberof AccessItemRequestedFor - */ - 'name'?: string; -} - -export const AccessItemRequestedForTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequestedForTypeV3 = typeof AccessItemRequestedForTypeV3[keyof typeof AccessItemRequestedForTypeV3]; - -/** - * Access item requester\'s identity. - * @export - * @interface AccessItemRequester - */ -export interface AccessItemRequester { - /** - * Access item requester\'s DTO type. - * @type {string} - * @memberof AccessItemRequester - */ - 'type'?: AccessItemRequesterTypeV3; - /** - * Access item requester\'s identity ID. - * @type {string} - * @memberof AccessItemRequester - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof AccessItemRequester - */ - 'name'?: string; -} - -export const AccessItemRequesterTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemRequesterTypeV3 = typeof AccessItemRequesterTypeV3[keyof typeof AccessItemRequesterTypeV3]; - -/** - * Identity who reviewed the access item request. - * @export - * @interface AccessItemReviewedBy - */ -export interface AccessItemReviewedBy { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedBy - */ - 'type'?: AccessItemReviewedByTypeV3; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedBy - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof AccessItemReviewedBy - */ - 'name'?: string; -} - -export const AccessItemReviewedByTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccessItemReviewedByTypeV3 = typeof AccessItemReviewedByTypeV3[keyof typeof AccessItemReviewedByTypeV3]; - -/** - * Metadata that describes an access item - * @export - * @interface AccessModelMetadata - */ -export interface AccessModelMetadata { - /** - * Unique identifier for the metadata type - * @type {string} - * @memberof AccessModelMetadata - */ - 'key'?: string; - /** - * Human readable name of the metadata type - * @type {string} - * @memberof AccessModelMetadata - */ - 'name'?: string; - /** - * Allows selecting multiple values - * @type {boolean} - * @memberof AccessModelMetadata - */ - 'multiselect'?: boolean; - /** - * The state of the metadata item - * @type {string} - * @memberof AccessModelMetadata - */ - 'status'?: string; - /** - * The type of the metadata item - * @type {string} - * @memberof AccessModelMetadata - */ - 'type'?: string; - /** - * The types of objects - * @type {Array} - * @memberof AccessModelMetadata - */ - 'objectTypes'?: Array; - /** - * Describes the metadata item - * @type {string} - * @memberof AccessModelMetadata - */ - 'description'?: string; - /** - * The value to assign to the metadata item - * @type {Array} - * @memberof AccessModelMetadata - */ - 'values'?: Array; -} -/** - * An individual value to assign to the metadata item - * @export - * @interface AccessModelMetadataValuesInner - */ -export interface AccessModelMetadataValuesInner { - /** - * The value to assign to the metdata item - * @type {string} - * @memberof AccessModelMetadataValuesInner - */ - 'value'?: string; - /** - * Display name of the value - * @type {string} - * @memberof AccessModelMetadataValuesInner - */ - 'name'?: string; - /** - * The status of the individual value - * @type {string} - * @memberof AccessModelMetadataValuesInner - */ - 'status'?: string; -} -/** - * Access profile. - * @export - * @interface AccessProfile - */ -export interface AccessProfile { - /** - * Access profile ID. - * @type {string} - * @memberof AccessProfile - */ - 'id'?: string; - /** - * Access profile name. - * @type {string} - * @memberof AccessProfile - */ - 'name': string; - /** - * Access profile description. - * @type {string} - * @memberof AccessProfile - */ - 'description'?: string | null; - /** - * Date and time when the access profile was created. - * @type {string} - * @memberof AccessProfile - */ - 'created'?: string; - /** - * Date and time when the access profile was last modified. - * @type {string} - * @memberof AccessProfile - */ - 'modified'?: string; - /** - * Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. - * @type {boolean} - * @memberof AccessProfile - */ - 'enabled'?: boolean; - /** - * - * @type {OwnerReference} - * @memberof AccessProfile - */ - 'owner': OwnerReference; - /** - * - * @type {AccessProfileSourceRef} - * @memberof AccessProfile - */ - 'source': AccessProfileSourceRef; - /** - * List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. - * @type {Array} - * @memberof AccessProfile - */ - 'entitlements'?: Array | null; - /** - * Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. - * @type {boolean} - * @memberof AccessProfile - */ - 'requestable'?: boolean; - /** - * - * @type {Requestability} - * @memberof AccessProfile - */ - 'accessRequestConfig'?: Requestability | null; - /** - * - * @type {Revocability} - * @memberof AccessProfile - */ - 'revocationRequestConfig'?: Revocability | null; - /** - * List of segment IDs, if any, that the access profile is assigned to. - * @type {Array} - * @memberof AccessProfile - */ - 'segments'?: Array | null; - /** - * - * @type {AttributeDTOList} - * @memberof AccessProfile - */ - 'accessModelMetadata'?: AttributeDTOList; - /** - * - * @type {ProvisioningCriteriaLevel1} - * @memberof AccessProfile - */ - 'provisioningCriteria'?: ProvisioningCriteriaLevel1 | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof AccessProfile - */ - 'additionalOwners'?: Array | null; -} -/** - * - * @export - * @interface AccessProfileApprovalScheme - */ -export interface AccessProfileApprovalScheme { - /** - * Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof AccessProfileApprovalScheme - */ - 'approverType'?: AccessProfileApprovalSchemeApproverTypeV3; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof AccessProfileApprovalScheme - */ - 'approverId'?: string | null; -} - -export const AccessProfileApprovalSchemeApproverTypeV3 = { - AppOwner: 'APP_OWNER', - Owner: 'OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type AccessProfileApprovalSchemeApproverTypeV3 = typeof AccessProfileApprovalSchemeApproverTypeV3[keyof typeof AccessProfileApprovalSchemeApproverTypeV3]; - -/** - * - * @export - * @interface AccessProfileBulkDeleteRequest - */ -export interface AccessProfileBulkDeleteRequest { - /** - * List of IDs of Access Profiles to be deleted. - * @type {Array} - * @memberof AccessProfileBulkDeleteRequest - */ - 'accessProfileIds'?: Array; - /** - * If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. - * @type {boolean} - * @memberof AccessProfileBulkDeleteRequest - */ - 'bestEffortOnly'?: boolean; -} -/** - * - * @export - * @interface AccessProfileBulkDeleteResponse - */ -export interface AccessProfileBulkDeleteResponse { - /** - * ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. - * @type {string} - * @memberof AccessProfileBulkDeleteResponse - */ - 'taskId'?: string; - /** - * List of IDs of Access Profiles which are pending deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponse - */ - 'pending'?: Array; - /** - * List of usages of Access Profiles targeted for deletion. - * @type {Array} - * @memberof AccessProfileBulkDeleteResponse - */ - 'inUse'?: Array; -} -/** - * More complete representation of an access profile. - * @export - * @interface AccessProfileDocument - */ -export interface AccessProfileDocument { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocument - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocument - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocument - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocument - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocument - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocument - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocument - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwner} - * @memberof AccessProfileDocument - */ - 'owner'?: BaseAccessOwner; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocument - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocument - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSource} - * @memberof AccessProfileDocument - */ - 'source'?: AccessProfileDocumentAllOfSource; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocument - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocument - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocument - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocument - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocument - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocument - */ - 'apps'?: Array; -} -/** - * Access profile\'s source. - * @export - * @interface AccessProfileDocumentAllOfSource - */ -export interface AccessProfileDocumentAllOfSource { - /** - * Source\'s ID. - * @type {string} - * @memberof AccessProfileDocumentAllOfSource - */ - 'id'?: string; - /** - * Source\'s name. - * @type {string} - * @memberof AccessProfileDocumentAllOfSource - */ - 'name'?: string; -} -/** - * - * @export - * @interface AccessProfileDocuments - */ -export interface AccessProfileDocuments { - /** - * Access item\'s description. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof AccessProfileDocuments - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof AccessProfileDocuments - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof AccessProfileDocuments - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwner} - * @memberof AccessProfileDocuments - */ - 'owner'?: BaseAccessOwner; - /** - * Access profile\'s ID. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'id': string; - /** - * Access profile\'s name. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'name': string; - /** - * - * @type {AccessProfileDocumentAllOfSource} - * @memberof AccessProfileDocuments - */ - 'source'?: AccessProfileDocumentAllOfSource; - /** - * Entitlements the access profile has access to. - * @type {Array} - * @memberof AccessProfileDocuments - */ - 'entitlements'?: Array; - /** - * Number of entitlements. - * @type {number} - * @memberof AccessProfileDocuments - */ - 'entitlementCount'?: number; - /** - * Segments with the access profile. - * @type {Array} - * @memberof AccessProfileDocuments - */ - 'segments'?: Array; - /** - * Number of segments with the access profile. - * @type {number} - * @memberof AccessProfileDocuments - */ - 'segmentCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof AccessProfileDocuments - */ - 'tags'?: Array; - /** - * Applications with the access profile - * @type {Array} - * @memberof AccessProfileDocuments - */ - 'apps'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccessProfileDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof AccessProfileDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof AccessProfileDocuments - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof AccessProfileDocuments - */ - '_version'?: string; -} - - -/** - * EntitlementReference - * @export - * @interface AccessProfileEntitlement - */ -export interface AccessProfileEntitlement { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'description'?: string | null; - /** - * - * @type {Reference1} - * @memberof AccessProfileEntitlement - */ - 'source'?: Reference1; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlement - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof AccessProfileEntitlement - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof AccessProfileEntitlement - */ - 'standalone'?: boolean; -} -/** - * - * @export - * @interface AccessProfileRef - */ -export interface AccessProfileRef { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfileRef - */ - 'id'?: string; - /** - * Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof AccessProfileRef - */ - 'type'?: AccessProfileRefTypeV3; - /** - * Human-readable display name of the Access Profile. This field is ignored on input. - * @type {string} - * @memberof AccessProfileRef - */ - 'name'?: string; -} - -export const AccessProfileRefTypeV3 = { - AccessProfile: 'ACCESS_PROFILE' -} as const; - -export type AccessProfileRefTypeV3 = typeof AccessProfileRefTypeV3[keyof typeof AccessProfileRefTypeV3]; - -/** - * Role - * @export - * @interface AccessProfileRole - */ -export interface AccessProfileRole { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileRole - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileRole - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileRole - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileRole - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileRole - */ - 'type'?: string; - /** - * - * @type {DisplayReference} - * @memberof AccessProfileRole - */ - 'owner'?: DisplayReference; - /** - * - * @type {boolean} - * @memberof AccessProfileRole - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof AccessProfileRole - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileSourceRef - */ -export interface AccessProfileSourceRef { - /** - * ID of the source the access profile is associated with. - * @type {string} - * @memberof AccessProfileSourceRef - */ - 'id'?: string; - /** - * Source\'s DTO type. - * @type {string} - * @memberof AccessProfileSourceRef - */ - 'type'?: AccessProfileSourceRefTypeV3; - /** - * Source name. - * @type {string} - * @memberof AccessProfileSourceRef - */ - 'name'?: string; -} - -export const AccessProfileSourceRefTypeV3 = { - Source: 'SOURCE' -} as const; - -export type AccessProfileSourceRefTypeV3 = typeof AccessProfileSourceRefTypeV3[keyof typeof AccessProfileSourceRefTypeV3]; - -/** - * This is a summary representation of an access profile. - * @export - * @interface AccessProfileSummary - */ -export interface AccessProfileSummary { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccessProfileSummary - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccessProfileSummary - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof AccessProfileSummary - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof AccessProfileSummary - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof AccessProfileSummary - */ - 'type'?: string; - /** - * - * @type {Reference1} - * @memberof AccessProfileSummary - */ - 'source'?: Reference1; - /** - * - * @type {DisplayReference} - * @memberof AccessProfileSummary - */ - 'owner'?: DisplayReference; - /** - * - * @type {boolean} - * @memberof AccessProfileSummary - */ - 'revocable'?: boolean; -} -/** - * - * @export - * @interface AccessProfileUsage - */ -export interface AccessProfileUsage { - /** - * ID of the Access Profile that is in use - * @type {string} - * @memberof AccessProfileUsage - */ - 'accessProfileId'?: string; - /** - * List of references to objects which are using the indicated Access Profile - * @type {Array} - * @memberof AccessProfileUsage - */ - 'usedBy'?: Array; -} -/** - * Role using the access profile. - * @export - * @interface AccessProfileUsageUsedByInner - */ -export interface AccessProfileUsageUsedByInner { - /** - * DTO type of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInner - */ - 'type'?: AccessProfileUsageUsedByInnerTypeV3; - /** - * ID of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInner - */ - 'id'?: string; - /** - * Display name of role using the access profile. - * @type {string} - * @memberof AccessProfileUsageUsedByInner - */ - 'name'?: string; -} - -export const AccessProfileUsageUsedByInnerTypeV3 = { - Role: 'ROLE' -} as const; - -export type AccessProfileUsageUsedByInnerTypeV3 = typeof AccessProfileUsageUsedByInnerTypeV3[keyof typeof AccessProfileUsageUsedByInnerTypeV3]; - -/** - * - * @export - * @interface AccessRequest - */ -export interface AccessRequest { - /** - * A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. - * @type {Array} - * @memberof AccessRequest - */ - 'requestedFor': Array; - /** - * - * @type {AccessRequestType} - * @memberof AccessRequest - */ - 'requestType'?: AccessRequestType | null; - /** - * - * @type {Array} - * @memberof AccessRequest - */ - 'requestedItems': Array; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - * @type {{ [key: string]: string; }} - * @memberof AccessRequest - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests - * @type {Array} - * @memberof AccessRequest - */ - 'requestedForWithRequestedItems'?: Array | null; -} - - -/** - * - * @export - * @interface AccessRequestConfig - */ -export interface AccessRequestConfig { - /** - * If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. - * @type {boolean} - * @memberof AccessRequestConfig - */ - 'approvalsMustBeExternal'?: boolean; - /** - * If this is true and the requester and reviewer are the same, the request is automatically approved. - * @type {boolean} - * @memberof AccessRequestConfig - */ - 'autoApprovalEnabled'?: boolean; - /** - * If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. - * @type {boolean} - * @memberof AccessRequestConfig - */ - 'reauthorizationEnabled'?: boolean; - /** - * - * @type {RequestOnBehalfOfConfig} - * @memberof AccessRequestConfig - */ - 'requestOnBehalfOfConfig'?: RequestOnBehalfOfConfig; - /** - * - * @type {ApprovalReminderAndEscalationConfig} - * @memberof AccessRequestConfig - */ - 'approvalReminderAndEscalationConfig'?: ApprovalReminderAndEscalationConfig; - /** - * - * @type {EntitlementRequestConfig} - * @memberof AccessRequestConfig - */ - 'entitlementRequestConfig'?: EntitlementRequestConfig; -} -/** - * - * @export - * @interface AccessRequestItem - */ -export interface AccessRequestItem { - /** - * The type of the item being requested. - * @type {string} - * @memberof AccessRequestItem - */ - 'type': AccessRequestItemTypeV3; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof AccessRequestItem - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof AccessRequestItem - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof AccessRequestItem - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof AccessRequestItem - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof AccessRequestItem - */ - 'removeDate'?: string; - /** - * The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItem - */ - 'assignmentId'?: string | null; - /** - * The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. - * @type {string} - * @memberof AccessRequestItem - */ - 'nativeIdentity'?: string | null; -} - -export const AccessRequestItemTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type AccessRequestItemTypeV3 = typeof AccessRequestItemTypeV3[keyof typeof AccessRequestItemTypeV3]; - -/** - * Provides additional details about this access request phase. - * @export - * @interface AccessRequestPhases - */ -export interface AccessRequestPhases { - /** - * The time that this phase started. - * @type {string} - * @memberof AccessRequestPhases - */ - 'started'?: string; - /** - * The time that this phase finished. - * @type {string} - * @memberof AccessRequestPhases - */ - 'finished'?: string | null; - /** - * The name of this phase. - * @type {string} - * @memberof AccessRequestPhases - */ - 'name'?: string; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhases - */ - 'state'?: AccessRequestPhasesStateV3; - /** - * The state of this phase. - * @type {string} - * @memberof AccessRequestPhases - */ - 'result'?: AccessRequestPhasesResultV3 | null; - /** - * A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. - * @type {string} - * @memberof AccessRequestPhases - */ - 'phaseReference'?: string | null; -} - -export const AccessRequestPhasesStateV3 = { - Pending: 'PENDING', - Executing: 'EXECUTING', - Completed: 'COMPLETED', - Cancelled: 'CANCELLED', - NotExecuted: 'NOT_EXECUTED' -} as const; - -export type AccessRequestPhasesStateV3 = typeof AccessRequestPhasesStateV3[keyof typeof AccessRequestPhasesStateV3]; -export const AccessRequestPhasesResultV3 = { - Successful: 'SUCCESSFUL', - Failed: 'FAILED' -} as const; - -export type AccessRequestPhasesResultV3 = typeof AccessRequestPhasesResultV3[keyof typeof AccessRequestPhasesResultV3]; - -/** - * - * @export - * @interface AccessRequestResponse - */ -export interface AccessRequestResponse { - /** - * A list of new access request tracking data mapped to the values requested. - * @type {Array} - * @memberof AccessRequestResponse - */ - 'newRequests'?: Array; - /** - * A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. - * @type {Array} - * @memberof AccessRequestResponse - */ - 'existingRequests'?: Array; -} -/** - * - * @export - * @interface AccessRequestTracking - */ -export interface AccessRequestTracking { - /** - * The identity id in which the access request is for. - * @type {string} - * @memberof AccessRequestTracking - */ - 'requestedFor'?: string; - /** - * The details of the item requested. - * @type {Array} - * @memberof AccessRequestTracking - */ - 'requestedItemsDetails'?: Array; - /** - * a hash representation of the access requested, useful for longer term tracking client side. - * @type {number} - * @memberof AccessRequestTracking - */ - 'attributesHash'?: number; - /** - * a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. - * @type {Array} - * @memberof AccessRequestTracking - */ - 'accessRequestIds'?: Array; -} -/** - * Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. MODIFY_ACCESS type is used for updating access expiration dates or other access modifications. - * @export - * @enum {string} - */ - -export const AccessRequestType = { - GrantAccess: 'GRANT_ACCESS', - RevokeAccess: 'REVOKE_ACCESS', - ModifyAccess: 'MODIFY_ACCESS' -} as const; - -export type AccessRequestType = typeof AccessRequestType[keyof typeof AccessRequestType]; - - -/** - * - * @export - * @interface AccessReviewItem - */ -export interface AccessReviewItem { - /** - * - * @type {AccessSummary} - * @memberof AccessReviewItem - */ - 'accessSummary'?: AccessSummary; - /** - * - * @type {CertificationIdentitySummary} - * @memberof AccessReviewItem - */ - 'identitySummary'?: CertificationIdentitySummary; - /** - * The review item\'s id - * @type {string} - * @memberof AccessReviewItem - */ - 'id'?: string; - /** - * Whether the review item is complete - * @type {boolean} - * @memberof AccessReviewItem - */ - 'completed'?: boolean; - /** - * Indicates whether the review item is for new access to a source - * @type {boolean} - * @memberof AccessReviewItem - */ - 'newAccess'?: boolean; - /** - * - * @type {CertificationDecision} - * @memberof AccessReviewItem - */ - 'decision'?: CertificationDecision; - /** - * Comments for this review item - * @type {string} - * @memberof AccessReviewItem - */ - 'comments'?: string | null; -} - - -/** - * - * @export - * @interface AccessReviewReassignment - */ -export interface AccessReviewReassignment { - /** - * - * @type {Array} - * @memberof AccessReviewReassignment - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof AccessReviewReassignment - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof AccessReviewReassignment - */ - 'reason': string; -} -/** - * An object holding the access that is being reviewed - * @export - * @interface AccessSummary - */ -export interface AccessSummary { - /** - * - * @type {AccessSummaryAccess} - * @memberof AccessSummary - */ - 'access'?: AccessSummaryAccess; - /** - * - * @type {ReviewableEntitlement} - * @memberof AccessSummary - */ - 'entitlement'?: ReviewableEntitlement | null; - /** - * - * @type {ReviewableAccessProfile} - * @memberof AccessSummary - */ - 'accessProfile'?: ReviewableAccessProfile; - /** - * - * @type {ReviewableRole} - * @memberof AccessSummary - */ - 'role'?: ReviewableRole | null; -} -/** - * - * @export - * @interface AccessSummaryAccess - */ -export interface AccessSummaryAccess { - /** - * - * @type {DtoType} - * @memberof AccessSummaryAccess - */ - 'type'?: DtoType; - /** - * The ID of the item being certified - * @type {string} - * @memberof AccessSummaryAccess - */ - 'id'?: string; - /** - * The name of the item being certified - * @type {string} - * @memberof AccessSummaryAccess - */ - 'name'?: string; -} - - -/** - * Access type of API Client indicating online or offline use - * @export - * @enum {string} - */ - -export const AccessType = { - Online: 'ONLINE', - Offline: 'OFFLINE' -} as const; - -export type AccessType = typeof AccessType[keyof typeof AccessType]; - - -/** - * - * @export - * @interface Account - */ -export interface Account { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof Account - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof Account - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof Account - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof Account - */ - 'modified'?: string; - /** - * The unique ID of the source this account belongs to - * @type {string} - * @memberof Account - */ - 'sourceId': string; - /** - * The display name of the source this account belongs to - * @type {string} - * @memberof Account - */ - 'sourceName': string | null; - /** - * The unique ID of the identity this account is correlated to - * @type {string} - * @memberof Account - */ - 'identityId'?: string; - /** - * The lifecycle state of the identity this account is correlated to - * @type {string} - * @memberof Account - */ - 'cloudLifecycleState'?: string | null; - /** - * The identity state of the identity this account is correlated to - * @type {string} - * @memberof Account - */ - 'identityState'?: string | null; - /** - * The connection type of the source this account is from - * @type {string} - * @memberof Account - */ - 'connectionType'?: string | null; - /** - * Indicates if the account is of machine type - * @type {boolean} - * @memberof Account - */ - 'isMachine'?: boolean; - /** - * - * @type {AccountAllOfRecommendation} - * @memberof Account - */ - 'recommendation'?: AccountAllOfRecommendation; - /** - * The account attributes that are aggregated - * @type {{ [key: string]: any; }} - * @memberof Account - */ - 'attributes': { [key: string]: any; } | null; - /** - * Indicates if this account is from an authoritative source - * @type {boolean} - * @memberof Account - */ - 'authoritative': boolean; - /** - * A description of the account - * @type {string} - * @memberof Account - */ - 'description'?: string | null; - /** - * Indicates if the account is currently disabled - * @type {boolean} - * @memberof Account - */ - 'disabled': boolean; - /** - * Indicates if the account is currently locked - * @type {boolean} - * @memberof Account - */ - 'locked': boolean; - /** - * The unique ID of the account generated by the source system - * @type {string} - * @memberof Account - */ - 'nativeIdentity': string; - /** - * If true, this is a user account within IdentityNow. If false, this is an account from a source system. - * @type {boolean} - * @memberof Account - */ - 'systemAccount': boolean; - /** - * Indicates if this account is not correlated to an identity - * @type {boolean} - * @memberof Account - */ - 'uncorrelated': boolean; - /** - * The unique ID of the account as determined by the account schema - * @type {string} - * @memberof Account - */ - 'uuid'?: string | null; - /** - * Indicates if the account has been manually correlated to an identity - * @type {boolean} - * @memberof Account - */ - 'manuallyCorrelated': boolean; - /** - * Indicates if the account has entitlements - * @type {boolean} - * @memberof Account - */ - 'hasEntitlements': boolean; - /** - * - * @type {AccountAllOfIdentity} - * @memberof Account - */ - 'identity'?: AccountAllOfIdentity; - /** - * - * @type {AccountAllOfSourceOwner} - * @memberof Account - */ - 'sourceOwner'?: AccountAllOfSourceOwner | null; - /** - * A string list containing the owning source\'s features - * @type {string} - * @memberof Account - */ - 'features'?: string | null; - /** - * The origin of the account either aggregated or provisioned - * @type {string} - * @memberof Account - */ - 'origin'?: AccountOriginV3 | null; - /** - * - * @type {AccountAllOfOwnerIdentity} - * @memberof Account - */ - 'ownerIdentity'?: AccountAllOfOwnerIdentity; -} - -export const AccountOriginV3 = { - Aggregated: 'AGGREGATED', - Provisioned: 'PROVISIONED' -} as const; - -export type AccountOriginV3 = typeof AccountOriginV3[keyof typeof AccountOriginV3]; - -/** - * Object for specifying Actions to be performed on a specified list of sources\' account. - * @export - * @interface AccountAction - */ -export interface AccountAction { - /** - * Describes if action will be enable, disable or delete. - * @type {string} - * @memberof AccountAction - */ - 'action'?: AccountActionActionV3; - /** - * List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. - * @type {Set} - * @memberof AccountAction - */ - 'sourceIds'?: Set; -} - -export const AccountActionActionV3 = { - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE' -} as const; - -export type AccountActionActionV3 = typeof AccountActionActionV3[keyof typeof AccountActionActionV3]; - -/** - * - * @export - * @interface AccountActivity - */ -export interface AccountActivity { - /** - * Id of the account activity - * @type {string} - * @memberof AccountActivity - */ - 'id'?: string; - /** - * The name of the activity - * @type {string} - * @memberof AccountActivity - */ - 'name'?: string; - /** - * When the activity was first created - * @type {string} - * @memberof AccountActivity - */ - 'created'?: string; - /** - * When the activity was last modified - * @type {string} - * @memberof AccountActivity - */ - 'modified'?: string | null; - /** - * When the activity was completed - * @type {string} - * @memberof AccountActivity - */ - 'completed'?: string | null; - /** - * - * @type {CompletionStatus} - * @memberof AccountActivity - */ - 'completionStatus'?: CompletionStatus | null; - /** - * The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). - * @type {string} - * @memberof AccountActivity - */ - 'type'?: string | null; - /** - * - * @type {IdentitySummary} - * @memberof AccountActivity - */ - 'requesterIdentitySummary'?: IdentitySummary | null; - /** - * - * @type {IdentitySummary} - * @memberof AccountActivity - */ - 'targetIdentitySummary'?: IdentitySummary | null; - /** - * A list of error messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivity - */ - 'errors'?: Array | null; - /** - * A list of warning messages, if any, that were encountered. - * @type {Array} - * @memberof AccountActivity - */ - 'warnings'?: Array | null; - /** - * Individual actions performed as part of this account activity - * @type {Array} - * @memberof AccountActivity - */ - 'items'?: Array | null; - /** - * - * @type {ExecutionStatus} - * @memberof AccountActivity - */ - 'executionStatus'?: ExecutionStatus; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof AccountActivity - */ - 'clientMetadata'?: { [key: string]: string; } | null; -} - - -/** - * The state of an approval status - * @export - * @enum {string} - */ - -export const AccountActivityApprovalStatus = { - Finished: 'FINISHED', - Rejected: 'REJECTED', - Returned: 'RETURNED', - Expired: 'EXPIRED', - Pending: 'PENDING', - Canceled: 'CANCELED' -} as const; - -export type AccountActivityApprovalStatus = typeof AccountActivityApprovalStatus[keyof typeof AccountActivityApprovalStatus]; - - -/** - * AccountActivity - * @export - * @interface AccountActivityDocument - */ -export interface AccountActivityDocument { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocument - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocument - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocument - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocument - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocument - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocument - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocument - */ - 'status'?: string; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivityDocument - */ - 'requester'?: ActivityIdentity; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivityDocument - */ - 'recipient'?: ActivityIdentity; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocument - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocument - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocument - */ - 'sources'?: string; -} -/** - * - * @export - * @interface AccountActivityDocuments - */ -export interface AccountActivityDocuments { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'status'?: string; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivityDocuments - */ - 'requester'?: ActivityIdentity; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivityDocuments - */ - 'recipient'?: ActivityIdentity; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivityDocuments - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'sources'?: string; - /** - * Name of the pod. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof AccountActivityDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof AccountActivityDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof AccountActivityDocuments - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof AccountActivityDocuments - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface AccountActivityItem - */ -export interface AccountActivityItem { - /** - * Item id - * @type {string} - * @memberof AccountActivityItem - */ - 'id'?: string; - /** - * Human-readable display name of item - * @type {string} - * @memberof AccountActivityItem - */ - 'name'?: string; - /** - * Date and time item was requested - * @type {string} - * @memberof AccountActivityItem - */ - 'requested'?: string; - /** - * - * @type {AccountActivityApprovalStatus} - * @memberof AccountActivityItem - */ - 'approvalStatus'?: AccountActivityApprovalStatus | null; - /** - * - * @type {ProvisioningState} - * @memberof AccountActivityItem - */ - 'provisioningStatus'?: ProvisioningState; - /** - * - * @type {Comment} - * @memberof AccountActivityItem - */ - 'requesterComment'?: Comment | null; - /** - * - * @type {IdentitySummary} - * @memberof AccountActivityItem - */ - 'reviewerIdentitySummary'?: IdentitySummary | null; - /** - * - * @type {Comment} - * @memberof AccountActivityItem - */ - 'reviewerComment'?: Comment | null; - /** - * - * @type {AccountActivityItemOperation} - * @memberof AccountActivityItem - */ - 'operation'?: AccountActivityItemOperation | null; - /** - * Attribute to which account activity applies - * @type {string} - * @memberof AccountActivityItem - */ - 'attribute'?: string | null; - /** - * Value of attribute - * @type {string} - * @memberof AccountActivityItem - */ - 'value'?: string | null; - /** - * Native identity in the target system to which the account activity applies - * @type {string} - * @memberof AccountActivityItem - */ - 'nativeIdentity'?: string | null; - /** - * Id of Source to which account activity applies - * @type {string} - * @memberof AccountActivityItem - */ - 'sourceId'?: string; - /** - * - * @type {AccountRequestInfo} - * @memberof AccountActivityItem - */ - 'accountRequestInfo'?: AccountRequestInfo | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof AccountActivityItem - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof AccountActivityItem - */ - 'removeDate'?: string | null; -} - - -/** - * Represents an operation in an account activity item - * @export - * @enum {string} - */ - -export const AccountActivityItemOperation = { - Add: 'ADD', - Create: 'CREATE', - Modify: 'MODIFY', - Delete: 'DELETE', - Disable: 'DISABLE', - Enable: 'ENABLE', - Unlock: 'UNLOCK', - Lock: 'LOCK', - Remove: 'REMOVE', - Set: 'SET' -} as const; - -export type AccountActivityItemOperation = typeof AccountActivityItemOperation[keyof typeof AccountActivityItemOperation]; - - -/** - * AccountActivity - * @export - * @interface AccountActivitySearchedItem - */ -export interface AccountActivitySearchedItem { - /** - * ID of account activity. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'id'?: string; - /** - * Type of action performed in the activity. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'action'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'synced'?: string; - /** - * Activity\'s current stage. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'stage'?: string; - /** - * Activity\'s current status. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'status'?: string; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivitySearchedItem - */ - 'requester'?: ActivityIdentity; - /** - * - * @type {ActivityIdentity} - * @memberof AccountActivitySearchedItem - */ - 'recipient'?: ActivityIdentity; - /** - * Account activity\'s tracking number. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'trackingNumber'?: string; - /** - * Errors provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'errors'?: Array | null; - /** - * Warnings provided by the source while completing account actions. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'warnings'?: Array | null; - /** - * Approvals performed on an item during activity. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'approvals'?: Array; - /** - * Original actions that triggered all individual source actions related to the account action. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'originalRequests'?: Array; - /** - * Controls that translated the attribute requests into actual provisioning actions on the source. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'expansionItems'?: Array; - /** - * Account data for each individual source action triggered by the original requests. - * @type {Array} - * @memberof AccountActivitySearchedItem - */ - 'accountRequests'?: Array; - /** - * Sources involved in the account activity. - * @type {string} - * @memberof AccountActivitySearchedItem - */ - 'sources'?: string; -} -/** - * The identity this account is correlated to - * @export - * @interface AccountAllOfIdentity - */ -export interface AccountAllOfIdentity { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfIdentity - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfIdentity - */ - 'type'?: AccountAllOfIdentityTypeV3; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfIdentity - */ - 'name'?: string; -} - -export const AccountAllOfIdentityTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfIdentityTypeV3 = typeof AccountAllOfIdentityTypeV3[keyof typeof AccountAllOfIdentityTypeV3]; - -/** - * - * @export - * @interface AccountAllOfOwnerIdentity - */ -export interface AccountAllOfOwnerIdentity { - /** - * - * @type {DtoType} - * @memberof AccountAllOfOwnerIdentity - */ - 'type'?: DtoType; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentity - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof AccountAllOfOwnerIdentity - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface AccountAllOfRecommendation - */ -export interface AccountAllOfRecommendation { - /** - * Recommended type of account. - * @type {string} - * @memberof AccountAllOfRecommendation - */ - 'type': AccountAllOfRecommendationTypeV3; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof AccountAllOfRecommendation - */ - 'method': AccountAllOfRecommendationMethodV3; -} - -export const AccountAllOfRecommendationTypeV3 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type AccountAllOfRecommendationTypeV3 = typeof AccountAllOfRecommendationTypeV3[keyof typeof AccountAllOfRecommendationTypeV3]; -export const AccountAllOfRecommendationMethodV3 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type AccountAllOfRecommendationMethodV3 = typeof AccountAllOfRecommendationMethodV3[keyof typeof AccountAllOfRecommendationMethodV3]; - -/** - * The owner of the source this account belongs to. - * @export - * @interface AccountAllOfSourceOwner - */ -export interface AccountAllOfSourceOwner { - /** - * The ID of the identity - * @type {string} - * @memberof AccountAllOfSourceOwner - */ - 'id'?: string; - /** - * The type of object being referenced - * @type {string} - * @memberof AccountAllOfSourceOwner - */ - 'type'?: AccountAllOfSourceOwnerTypeV3; - /** - * display name of identity - * @type {string} - * @memberof AccountAllOfSourceOwner - */ - 'name'?: string; -} - -export const AccountAllOfSourceOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AccountAllOfSourceOwnerTypeV3 = typeof AccountAllOfSourceOwnerTypeV3[keyof typeof AccountAllOfSourceOwnerTypeV3]; - -/** - * - * @export - * @interface AccountAttribute - */ -export interface AccountAttribute { - /** - * A reference to the source to search for the account - * @type {string} - * @memberof AccountAttribute - */ - 'sourceName': string; - /** - * The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. - * @type {string} - * @memberof AccountAttribute - */ - 'attributeName': string; - /** - * The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries - * @type {string} - * @memberof AccountAttribute - */ - 'accountSortAttribute'?: string; - /** - * The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) - * @type {boolean} - * @memberof AccountAttribute - */ - 'accountSortDescending'?: boolean; - /** - * The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false - * @type {boolean} - * @memberof AccountAttribute - */ - 'accountReturnFirstLink'?: boolean; - /** - * This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements - * @type {string} - * @memberof AccountAttribute - */ - 'accountFilter'?: string; - /** - * This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. - * @type {string} - * @memberof AccountAttribute - */ - 'accountPropertyFilter'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof AccountAttribute - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof AccountAttribute - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface AccountAttributes - */ -export interface AccountAttributes { - /** - * The schema attribute values for the account - * @type {{ [key: string]: any; }} - * @memberof AccountAttributes - */ - 'attributes': { [key: string]: any; }; -} -/** - * - * @export - * @interface AccountAttributesCreate - */ -export interface AccountAttributesCreate { - /** - * - * @type {AccountAttributesCreateAttributes} - * @memberof AccountAttributesCreate - */ - 'attributes': AccountAttributesCreateAttributes; -} -/** - * The schema attribute values for the account - * @export - * @interface AccountAttributesCreateAttributes - */ -export interface AccountAttributesCreateAttributes { - [key: string]: string | any; - - /** - * Target source to create an account - * @type {string} - * @memberof AccountAttributesCreateAttributes - */ - 'sourceId': string; -} -/** - * - * @export - * @interface AccountItemRef - */ -export interface AccountItemRef { - /** - * The uuid for the account, available under the \'objectguid\' attribute - * @type {string} - * @memberof AccountItemRef - */ - 'accountUuid'?: string | null; - /** - * The \'distinguishedName\' attribute for the account - * @type {string} - * @memberof AccountItemRef - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface AccountRequest - */ -export interface AccountRequest { - /** - * Unique ID of the account - * @type {string} - * @memberof AccountRequest - */ - 'accountId'?: string; - /** - * - * @type {Array} - * @memberof AccountRequest - */ - 'attributeRequests'?: Array; - /** - * The operation that was performed - * @type {string} - * @memberof AccountRequest - */ - 'op'?: string; - /** - * - * @type {AccountSource} - * @memberof AccountRequest - */ - 'provisioningTarget'?: AccountSource; - /** - * - * @type {AccountRequestResult} - * @memberof AccountRequest - */ - 'result'?: AccountRequestResult; - /** - * - * @type {AccountSource} - * @memberof AccountRequest - */ - 'source'?: AccountSource; -} -/** - * If an account activity item is associated with an access request, captures details of that request. - * @export - * @interface AccountRequestInfo - */ -export interface AccountRequestInfo { - /** - * Id of requested object - * @type {string} - * @memberof AccountRequestInfo - */ - 'requestedObjectId'?: string; - /** - * Human-readable name of requested object - * @type {string} - * @memberof AccountRequestInfo - */ - 'requestedObjectName'?: string; - /** - * - * @type {RequestableObjectType} - * @memberof AccountRequestInfo - */ - 'requestedObjectType'?: RequestableObjectType; -} - - -/** - * - * @export - * @interface AccountRequestResult - */ -export interface AccountRequestResult { - /** - * Error message. - * @type {Array} - * @memberof AccountRequestResult - */ - 'errors'?: Array; - /** - * The status of the account request - * @type {string} - * @memberof AccountRequestResult - */ - 'status'?: string; - /** - * ID of associated ticket. - * @type {string} - * @memberof AccountRequestResult - */ - 'ticketId'?: string | null; -} -/** - * - * @export - * @interface AccountSource - */ -export interface AccountSource { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof AccountSource - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof AccountSource - */ - 'name'?: string; - /** - * Type of source returned. - * @type {string} - * @memberof AccountSource - */ - 'type'?: string; -} -/** - * Request used for account enable/disable - * @export - * @interface AccountToggleRequest - */ -export interface AccountToggleRequest { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountToggleRequest - */ - 'externalVerificationId'?: string; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. - * @type {boolean} - * @memberof AccountToggleRequest - */ - 'forceProvisioning'?: boolean; -} -/** - * Request used for account unlock - * @export - * @interface AccountUnlockRequest - */ -export interface AccountUnlockRequest { - /** - * If set, an external process validates that the user wants to proceed with this request. - * @type {string} - * @memberof AccountUnlockRequest - */ - 'externalVerificationId'?: string; - /** - * If set, the IDN account is unlocked after the workflow completes. - * @type {boolean} - * @memberof AccountUnlockRequest - */ - 'unlockIDNAccount'?: boolean; - /** - * If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. - * @type {boolean} - * @memberof AccountUnlockRequest - */ - 'forceProvisioning'?: boolean; -} -/** - * - * @export - * @interface AccountUsage - */ -export interface AccountUsage { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof AccountUsage - */ - 'date'?: string; - /** - * The number of days within the month that the account was active in a source. - * @type {number} - * @memberof AccountUsage - */ - 'count'?: number; -} -/** - * Accounts async response containing details on started async process - * @export - * @interface AccountsAsyncResult - */ -export interface AccountsAsyncResult { - /** - * id of the task - * @type {string} - * @memberof AccountsAsyncResult - */ - 'id': string; -} -/** - * Arguments for Account Export report (ACCOUNTS) - * @export - * @interface AccountsExportReportArguments - */ -export interface AccountsExportReportArguments { - /** - * Source ID. - * @type {string} - * @memberof AccountsExportReportArguments - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof AccountsExportReportArguments - */ - 'sourceName': string; -} -/** - * - * @export - * @interface ActivateCampaignOptions - */ -export interface ActivateCampaignOptions { - /** - * The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. - * @type {string} - * @memberof ActivateCampaignOptions - */ - 'timeZone'?: string; -} -/** - * - * @export - * @interface ActivityIdentity - */ -export interface ActivityIdentity { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof ActivityIdentity - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof ActivityIdentity - */ - 'name'?: string; - /** - * Type of object - * @type {string} - * @memberof ActivityIdentity - */ - 'type'?: string; -} -/** - * Insights into account activity - * @export - * @interface ActivityInsights - */ -export interface ActivityInsights { - /** - * UUID of the account - * @type {string} - * @memberof ActivityInsights - */ - 'accountID'?: string; - /** - * The number of days of activity - * @type {number} - * @memberof ActivityInsights - */ - 'usageDays'?: number; - /** - * Status indicating if the activity is complete or unknown - * @type {string} - * @memberof ActivityInsights - */ - 'usageDaysState'?: ActivityInsightsUsageDaysStateV3; -} - -export const ActivityInsightsUsageDaysStateV3 = { - Complete: 'COMPLETE', - Unknown: 'UNKNOWN' -} as const; - -export type ActivityInsightsUsageDaysStateV3 = typeof ActivityInsightsUsageDaysStateV3[keyof typeof ActivityInsightsUsageDaysStateV3]; - -/** - * Reference to an additional owner (identity or governance group). - * @export - * @interface AdditionalOwnerRef - */ -export interface AdditionalOwnerRef { - /** - * Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. - * @type {string} - * @memberof AdditionalOwnerRef - */ - 'type'?: AdditionalOwnerRefTypeV3; - /** - * ID of the identity or governance group. - * @type {string} - * @memberof AdditionalOwnerRef - */ - 'id'?: string; - /** - * Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. - * @type {string} - * @memberof AdditionalOwnerRef - */ - 'name'?: string | null; -} - -export const AdditionalOwnerRefTypeV3 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type AdditionalOwnerRefTypeV3 = typeof AdditionalOwnerRefTypeV3[keyof typeof AdditionalOwnerRefTypeV3]; - -/** - * - * @export - * @interface AdminReviewReassign - */ -export interface AdminReviewReassign { - /** - * List of certification IDs to reassign - * @type {Array} - * @memberof AdminReviewReassign - */ - 'certificationIds'?: Array; - /** - * - * @type {AdminReviewReassignReassignTo} - * @memberof AdminReviewReassign - */ - 'reassignTo'?: AdminReviewReassignReassignTo; - /** - * Comment to explain why the certification was reassigned - * @type {string} - * @memberof AdminReviewReassign - */ - 'reason'?: string; -} -/** - * - * @export - * @interface AdminReviewReassignReassignTo - */ -export interface AdminReviewReassignReassignTo { - /** - * The identity ID to which the review is being assigned. - * @type {string} - * @memberof AdminReviewReassignReassignTo - */ - 'id'?: string; - /** - * The type of the ID provided. - * @type {string} - * @memberof AdminReviewReassignReassignTo - */ - 'type'?: AdminReviewReassignReassignToTypeV3; -} - -export const AdminReviewReassignReassignToTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type AdminReviewReassignReassignToTypeV3 = typeof AdminReviewReassignReassignToTypeV3[keyof typeof AdminReviewReassignReassignToTypeV3]; - -/** - * - * @export - * @interface AggregationResult - */ -export interface AggregationResult { - /** - * The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - * @type {object} - * @memberof AggregationResult - */ - 'aggregations'?: object; - /** - * The results of the aggregation search query. - * @type {Array} - * @memberof AggregationResult - */ - 'hits'?: Array; -} -/** - * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const AggregationType = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT' -} as const; - -export type AggregationType = typeof AggregationType[keyof typeof AggregationType]; - - -/** - * - * @export - * @interface Aggregations - */ -export interface Aggregations { - /** - * - * @type {NestedAggregation} - * @memberof Aggregations - */ - 'nested'?: NestedAggregation; - /** - * - * @type {MetricAggregation} - * @memberof Aggregations - */ - 'metric'?: MetricAggregation; - /** - * - * @type {FilterAggregation} - * @memberof Aggregations - */ - 'filter'?: FilterAggregation; - /** - * - * @type {BucketAggregation} - * @memberof Aggregations - */ - 'bucket'?: BucketAggregation; -} -/** - * - * @export - * @interface App - */ -export interface App { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof App - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof App - */ - 'name'?: string; - /** - * - * @type {Reference1} - * @memberof App - */ - 'source'?: Reference1; - /** - * - * @type {AppAllOfAccount} - * @memberof App - */ - 'account'?: AppAllOfAccount; -} -/** - * - * @export - * @interface AppAllOfAccount - */ -export interface AppAllOfAccount { - /** - * The SailPoint generated unique ID - * @type {string} - * @memberof AppAllOfAccount - */ - 'id'?: string; - /** - * The account ID generated by the source - * @type {string} - * @memberof AppAllOfAccount - */ - 'accountId'?: string; -} -/** - * - * @export - * @interface Approval - */ -export interface Approval { - /** - * - * @type {Array} - * @memberof Approval - */ - 'comments'?: Array; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Approval - */ - 'modified'?: string | null; - /** - * - * @type {ActivityIdentity} - * @memberof Approval - */ - 'owner'?: ActivityIdentity; - /** - * The result of the approval - * @type {string} - * @memberof Approval - */ - 'result'?: string; - /** - * - * @type {AttributeRequest} - * @memberof Approval - */ - 'attributeRequest'?: AttributeRequest; - /** - * - * @type {AccountSource} - * @memberof Approval - */ - 'source'?: AccountSource; -} -/** - * - * @export - * @interface ApprovalComment - */ -export interface ApprovalComment { - /** - * The comment text - * @type {string} - * @memberof ApprovalComment - */ - 'comment'?: string; - /** - * The name of the commenter - * @type {string} - * @memberof ApprovalComment - */ - 'commenter'?: string; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ApprovalComment - */ - 'date'?: string | null; -} -/** - * - * @export - * @interface ApprovalForwardHistory - */ -export interface ApprovalForwardHistory { - /** - * Display name of approver from whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory - */ - 'oldApproverName'?: string; - /** - * Display name of approver to whom the approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory - */ - 'newApproverName'?: string; - /** - * Comment made while forwarding. - * @type {string} - * @memberof ApprovalForwardHistory - */ - 'comment'?: string | null; - /** - * Time at which approval was forwarded. - * @type {string} - * @memberof ApprovalForwardHistory - */ - 'modified'?: string; - /** - * Display name of forwarder who forwarded the approval. - * @type {string} - * @memberof ApprovalForwardHistory - */ - 'forwarderName'?: string | null; - /** - * - * @type {ReassignmentType} - * @memberof ApprovalForwardHistory - */ - 'reassignmentType'?: ReassignmentType; -} - - -/** - * - * @export - * @interface ApprovalItemDetails - */ -export interface ApprovalItemDetails { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItemDetails - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItemDetails - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItemDetails - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItemDetails - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItemDetails - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItemDetails - */ - 'value'?: string | null; - /** - * - * @type {WorkItemState & object} - * @memberof ApprovalItemDetails - */ - 'state'?: WorkItemState & object; -} -/** - * - * @export - * @interface ApprovalItems - */ -export interface ApprovalItems { - /** - * The approval item\'s ID - * @type {string} - * @memberof ApprovalItems - */ - 'id'?: string; - /** - * The account referenced by the approval item - * @type {string} - * @memberof ApprovalItems - */ - 'account'?: string | null; - /** - * The name of the application/source - * @type {string} - * @memberof ApprovalItems - */ - 'application'?: string; - /** - * The attribute\'s name - * @type {string} - * @memberof ApprovalItems - */ - 'name'?: string | null; - /** - * The attribute\'s operation - * @type {string} - * @memberof ApprovalItems - */ - 'operation'?: string; - /** - * The attribute\'s value - * @type {string} - * @memberof ApprovalItems - */ - 'value'?: string | null; - /** - * - * @type {WorkItemState & object} - * @memberof ApprovalItems - */ - 'state'?: WorkItemState & object; -} -/** - * - * @export - * @interface ApprovalReminderAndEscalationConfig - */ -export interface ApprovalReminderAndEscalationConfig { - /** - * Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfig - */ - 'daysUntilEscalation'?: number | null; - /** - * Number of days to wait between reminder notifications. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfig - */ - 'daysBetweenReminders'?: number | null; - /** - * Maximum number of reminder notification to send to the reviewer before approval escalation. - * @type {number} - * @memberof ApprovalReminderAndEscalationConfig - */ - 'maxReminders'?: number | null; - /** - * - * @type {IdentityReferenceWithNameAndEmail} - * @memberof ApprovalReminderAndEscalationConfig - */ - 'fallbackApproverRef'?: IdentityReferenceWithNameAndEmail | null; -} -/** - * Describes the individual or group that is responsible for an approval step. - * @export - * @enum {string} - */ - -export const ApprovalScheme = { - AppOwner: 'APP_OWNER', - SourceOwner: 'SOURCE_OWNER', - Manager: 'MANAGER', - RoleOwner: 'ROLE_OWNER', - AccessProfileOwner: 'ACCESS_PROFILE_OWNER', - EntitlementOwner: 'ENTITLEMENT_OWNER', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ApprovalScheme = typeof ApprovalScheme[keyof typeof ApprovalScheme]; - - -/** - * - * @export - * @interface ApprovalSchemeForRole - */ -export interface ApprovalSchemeForRole { - /** - * Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field - * @type {string} - * @memberof ApprovalSchemeForRole - */ - 'approverType'?: ApprovalSchemeForRoleApproverTypeV3; - /** - * Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. - * @type {string} - * @memberof ApprovalSchemeForRole - */ - 'approverId'?: string | null; -} - -export const ApprovalSchemeForRoleApproverTypeV3 = { - Owner: 'OWNER', - Manager: 'MANAGER', - GovernanceGroup: 'GOVERNANCE_GROUP', - Workflow: 'WORKFLOW', - AllOwners: 'ALL_OWNERS', - AdditionalOwner: 'ADDITIONAL_OWNER', - AdditionalGovernanceGroup: 'ADDITIONAL_GOVERNANCE_GROUP' -} as const; - -export type ApprovalSchemeForRoleApproverTypeV3 = typeof ApprovalSchemeForRoleApproverTypeV3[keyof typeof ApprovalSchemeForRoleApproverTypeV3]; - -/** - * Enum representing the non-employee request approval status - * @export - * @enum {string} - */ - -export const ApprovalStatus = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Pending: 'PENDING', - NotReady: 'NOT_READY', - Cancelled: 'CANCELLED' -} as const; - -export type ApprovalStatus = typeof ApprovalStatus[keyof typeof ApprovalStatus]; - - -/** - * - * @export - * @interface ApprovalStatusDto - */ -export interface ApprovalStatusDto { - /** - * Unique identifier for the approval. - * @type {string} - * @memberof ApprovalStatusDto - */ - 'approvalId'?: string | null; - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ApprovalStatusDto - */ - 'forwarded'?: boolean; - /** - * - * @type {ApprovalStatusDtoOriginalOwner} - * @memberof ApprovalStatusDto - */ - 'originalOwner'?: ApprovalStatusDtoOriginalOwner; - /** - * - * @type {ApprovalStatusDtoCurrentOwner} - * @memberof ApprovalStatusDto - */ - 'currentOwner'?: ApprovalStatusDtoCurrentOwner; - /** - * Time at which item was modified. - * @type {string} - * @memberof ApprovalStatusDto - */ - 'modified'?: string | null; - /** - * - * @type {ManualWorkItemState} - * @memberof ApprovalStatusDto - */ - 'status'?: ManualWorkItemState; - /** - * - * @type {ApprovalScheme} - * @memberof ApprovalStatusDto - */ - 'scheme'?: ApprovalScheme; - /** - * If the request failed, includes any error messages that were generated. - * @type {Array} - * @memberof ApprovalStatusDto - */ - 'errorMessages'?: Array | null; - /** - * Comment, if any, provided by the approver. - * @type {string} - * @memberof ApprovalStatusDto - */ - 'comment'?: string | null; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof ApprovalStatusDto - */ - 'removeDate'?: string | null; -} - - -/** - * - * @export - * @interface ApprovalStatusDtoCurrentOwner - */ -export interface ApprovalStatusDtoCurrentOwner { - /** - * DTO type of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwner - */ - 'type'?: ApprovalStatusDtoCurrentOwnerTypeV3; - /** - * ID of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwner - */ - 'id'?: string; - /** - * Human-readable display name of identity who reviewed the access item request. - * @type {string} - * @memberof ApprovalStatusDtoCurrentOwner - */ - 'name'?: string; -} - -export const ApprovalStatusDtoCurrentOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoCurrentOwnerTypeV3 = typeof ApprovalStatusDtoCurrentOwnerTypeV3[keyof typeof ApprovalStatusDtoCurrentOwnerTypeV3]; - -/** - * Identity of orginal approval owner. - * @export - * @interface ApprovalStatusDtoOriginalOwner - */ -export interface ApprovalStatusDtoOriginalOwner { - /** - * DTO type of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwner - */ - 'type'?: ApprovalStatusDtoOriginalOwnerTypeV3; - /** - * ID of original approval owner\'s identity. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwner - */ - 'id'?: string; - /** - * Display name of original approval owner. - * @type {string} - * @memberof ApprovalStatusDtoOriginalOwner - */ - 'name'?: string; -} - -export const ApprovalStatusDtoOriginalOwnerTypeV3 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ApprovalStatusDtoOriginalOwnerTypeV3 = typeof ApprovalStatusDtoOriginalOwnerTypeV3[keyof typeof ApprovalStatusDtoOriginalOwnerTypeV3]; - -/** - * - * @export - * @interface ApprovalSummary - */ -export interface ApprovalSummary { - /** - * The number of pending access requests approvals. - * @type {number} - * @memberof ApprovalSummary - */ - 'pending'?: number; - /** - * The number of approved access requests approvals. - * @type {number} - * @memberof ApprovalSummary - */ - 'approved'?: number; - /** - * The number of rejected access requests approvals. - * @type {number} - * @memberof ApprovalSummary - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface ArrayInner - */ -export interface ArrayInner { -} -/** - * - * @export - * @interface AttributeDTO - */ -export interface AttributeDTO { - /** - * Technical name of the Attribute. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeDTO - */ - 'key'?: string; - /** - * The display name of the key. - * @type {string} - * @memberof AttributeDTO - */ - 'name'?: string; - /** - * Indicates whether the attribute can have multiple values. - * @type {boolean} - * @memberof AttributeDTO - */ - 'multiselect'?: boolean; - /** - * The status of the Attribute. - * @type {string} - * @memberof AttributeDTO - */ - 'status'?: string; - /** - * The type of the Attribute. This can be either \"custom\" or \"governance\". - * @type {string} - * @memberof AttributeDTO - */ - 'type'?: string; - /** - * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. - * @type {Array} - * @memberof AttributeDTO - */ - 'objectTypes'?: Array | null; - /** - * The description of the Attribute. - * @type {string} - * @memberof AttributeDTO - */ - 'description'?: string; - /** - * - * @type {Array} - * @memberof AttributeDTO - */ - 'values'?: Array | null; -} -/** - * - * @export - * @interface AttributeDTOList - */ -export interface AttributeDTOList { - /** - * - * @type {Array} - * @memberof AttributeDTOList - */ - 'attributes'?: Array | null; -} -/** - * - * @export - * @interface AttributeDefinition - */ -export interface AttributeDefinition { - /** - * The name of the attribute. - * @type {string} - * @memberof AttributeDefinition - */ - 'name'?: string; - /** - * Attribute name in the native system. - * @type {string} - * @memberof AttributeDefinition - */ - 'nativeName'?: string | null; - /** - * - * @type {AttributeDefinitionType} - * @memberof AttributeDefinition - */ - 'type'?: AttributeDefinitionType; - /** - * - * @type {AttributeDefinitionSchema} - * @memberof AttributeDefinition - */ - 'schema'?: AttributeDefinitionSchema; - /** - * A human-readable description of the attribute. - * @type {string} - * @memberof AttributeDefinition - */ - 'description'?: string; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof AttributeDefinition - */ - 'isMulti'?: boolean; - /** - * Flag indicating whether or not the attribute is an entitlement. - * @type {boolean} - * @memberof AttributeDefinition - */ - 'isEntitlement'?: boolean; - /** - * Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. - * @type {boolean} - * @memberof AttributeDefinition - */ - 'isGroup'?: boolean; -} - - -/** - * A reference to the schema on the source to the attribute values map to. - * @export - * @interface AttributeDefinitionSchema - */ -export interface AttributeDefinitionSchema { - /** - * The type of object being referenced - * @type {string} - * @memberof AttributeDefinitionSchema - */ - 'type'?: AttributeDefinitionSchemaTypeV3; - /** - * The object ID this reference applies to. - * @type {string} - * @memberof AttributeDefinitionSchema - */ - 'id'?: string; - /** - * The human-readable display name of the object. - * @type {string} - * @memberof AttributeDefinitionSchema - */ - 'name'?: string; -} - -export const AttributeDefinitionSchemaTypeV3 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type AttributeDefinitionSchemaTypeV3 = typeof AttributeDefinitionSchemaTypeV3[keyof typeof AttributeDefinitionSchemaTypeV3]; - -/** - * The underlying type of the value which an AttributeDefinition represents. - * @export - * @enum {string} - */ - -export const AttributeDefinitionType = { - String: 'STRING', - Long: 'LONG', - Int: 'INT', - Boolean: 'BOOLEAN', - Date: 'DATE' -} as const; - -export type AttributeDefinitionType = typeof AttributeDefinitionType[keyof typeof AttributeDefinitionType]; - - -/** - * - * @export - * @interface AttributeRequest - */ -export interface AttributeRequest { - /** - * Attribute name. - * @type {string} - * @memberof AttributeRequest - */ - 'name'?: string; - /** - * Operation to perform on attribute. - * @type {string} - * @memberof AttributeRequest - */ - 'op'?: string; - /** - * - * @type {AttributeRequestValue} - * @memberof AttributeRequest - */ - 'value'?: AttributeRequestValue; -} -/** - * @type AttributeRequestValue - * Value of attribute. - * @export - */ -export type AttributeRequestValue = Array | string; - -/** - * - * @export - * @interface AttributeValueDTO - */ -export interface AttributeValueDTO { - /** - * Technical name of the Attribute value. This is unique and cannot be changed after creation. - * @type {string} - * @memberof AttributeValueDTO - */ - 'value'?: string; - /** - * The display name of the Attribute value. - * @type {string} - * @memberof AttributeValueDTO - */ - 'name'?: string; - /** - * The status of the Attribute value. - * @type {string} - * @memberof AttributeValueDTO - */ - 'status'?: string; -} -/** - * - * @export - * @interface AuthUser - */ -export interface AuthUser { - /** - * Tenant name. - * @type {string} - * @memberof AuthUser - */ - 'tenant'?: string; - /** - * Identity ID. - * @type {string} - * @memberof AuthUser - */ - 'id'?: string; - /** - * Identity\'s unique identitifier. - * @type {string} - * @memberof AuthUser - */ - 'uid'?: string; - /** - * ID of the auth profile associated with the auth user. - * @type {string} - * @memberof AuthUser - */ - 'profile'?: string; - /** - * Auth user\'s employee number. - * @type {string} - * @memberof AuthUser - */ - 'identificationNumber'?: string | null; - /** - * Auth user\'s email. - * @type {string} - * @memberof AuthUser - */ - 'email'?: string | null; - /** - * Auth user\'s phone number. - * @type {string} - * @memberof AuthUser - */ - 'phone'?: string | null; - /** - * Auth user\'s work phone number. - * @type {string} - * @memberof AuthUser - */ - 'workPhone'?: string | null; - /** - * Auth user\'s personal email. - * @type {string} - * @memberof AuthUser - */ - 'personalEmail'?: string | null; - /** - * Auth user\'s first name. - * @type {string} - * @memberof AuthUser - */ - 'firstname'?: string | null; - /** - * Auth user\'s last name. - * @type {string} - * @memberof AuthUser - */ - 'lastname'?: string | null; - /** - * Auth user\'s name in displayed format. - * @type {string} - * @memberof AuthUser - */ - 'displayName'?: string; - /** - * Auth user\'s alias. - * @type {string} - * @memberof AuthUser - */ - 'alias'?: string; - /** - * Date of last password change. - * @type {string} - * @memberof AuthUser - */ - 'lastPasswordChangeDate'?: string | null; - /** - * Timestamp of the last login (long type value). - * @type {number} - * @memberof AuthUser - */ - 'lastLoginTimestamp'?: number; - /** - * Timestamp of the current login (long type value). - * @type {number} - * @memberof AuthUser - */ - 'currentLoginTimestamp'?: number; - /** - * The date and time when the user was last unlocked. - * @type {string} - * @memberof AuthUser - */ - 'lastUnlockTimestamp'?: string | null; - /** - * Array of the auth user\'s capabilities. - * @type {Array} - * @memberof AuthUser - */ - 'capabilities'?: Array | null; -} - -export const AuthUserCapabilitiesV3 = { - CertAdmin: 'CERT_ADMIN', - CloudGovAdmin: 'CLOUD_GOV_ADMIN', - CloudGovUser: 'CLOUD_GOV_USER', - Helpdesk: 'HELPDESK', - OrgAdmin: 'ORG_ADMIN', - ReportAdmin: 'REPORT_ADMIN', - RoleAdmin: 'ROLE_ADMIN', - RoleSubadmin: 'ROLE_SUBADMIN', - SaasManagementAdmin: 'SAAS_MANAGEMENT_ADMIN', - SaasManagementReader: 'SAAS_MANAGEMENT_READER', - SourceAdmin: 'SOURCE_ADMIN', - SourceSubadmin: 'SOURCE_SUBADMIN', - DasUiAdministrator: 'das:ui-administrator', - DasUiComplianceManager: 'das:ui-compliance_manager', - DasUiAuditor: 'das:ui-auditor', - DasUiDataScope: 'das:ui-data-scope', - SpAicDashboardRead: 'sp:aic-dashboard-read', - SpAicDashboardWrite: 'sp:aic-dashboard-write', - SpUiConfigHubAdmin: 'sp:ui-config-hub-admin', - SpUiConfigHubBackupAdmin: 'sp:ui-config-hub-backup-admin', - SpUiConfigHubRead: 'sp:ui-config-hub-read' -} as const; - -export type AuthUserCapabilitiesV3 = typeof AuthUserCapabilitiesV3[keyof typeof AuthUserCapabilitiesV3]; - -/** - * Backup options control what will be included in the backup. - * @export - * @interface BackupOptions - */ -export interface BackupOptions { - /** - * Object type names to be included in a Configuration Hub backup command. - * @type {Array} - * @memberof BackupOptions - */ - 'includeTypes'?: Array; - /** - * Additional options targeting specific objects related to each item in the includeTypes field. - * @type {{ [key: string]: ObjectExportImportNames; }} - * @memberof BackupOptions - */ - 'objectOptions'?: { [key: string]: ObjectExportImportNames; }; -} - -export const BackupOptionsIncludeTypesV3 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type BackupOptionsIncludeTypesV3 = typeof BackupOptionsIncludeTypesV3[keyof typeof BackupOptionsIncludeTypesV3]; - -/** - * - * @export - * @interface BackupResponse - */ -export interface BackupResponse { - /** - * Unique id assigned to this backup. - * @type {string} - * @memberof BackupResponse - */ - 'jobId'?: string; - /** - * Status of the backup. - * @type {string} - * @memberof BackupResponse - */ - 'status'?: BackupResponseStatusV3; - /** - * Type of the job, will always be BACKUP for this type of job. - * @type {string} - * @memberof BackupResponse - */ - 'type'?: BackupResponseTypeV3; - /** - * The name of the tenant performing the upload - * @type {string} - * @memberof BackupResponse - */ - 'tenant'?: string; - /** - * The name of the requester. - * @type {string} - * @memberof BackupResponse - */ - 'requesterName'?: string; - /** - * Whether or not a file was created and stored for this backup. - * @type {boolean} - * @memberof BackupResponse - */ - 'fileExists'?: boolean; - /** - * The time the job was started. - * @type {string} - * @memberof BackupResponse - */ - 'created'?: string; - /** - * The time of the last update to the job. - * @type {string} - * @memberof BackupResponse - */ - 'modified'?: string; - /** - * The time the job was completed. - * @type {string} - * @memberof BackupResponse - */ - 'completed'?: string; - /** - * The name assigned to the upload file in the request body. - * @type {string} - * @memberof BackupResponse - */ - 'name'?: string; - /** - * Whether this backup can be deleted by a regular user. - * @type {boolean} - * @memberof BackupResponse - */ - 'userCanDelete'?: boolean; - /** - * Whether this backup contains all supported object types or only some of them. - * @type {boolean} - * @memberof BackupResponse - */ - 'isPartial'?: boolean; - /** - * Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. - * @type {string} - * @memberof BackupResponse - */ - 'backupType'?: BackupResponseBackupTypeV3; - /** - * - * @type {BackupOptions} - * @memberof BackupResponse - */ - 'options'?: BackupOptions | null; - /** - * Whether the object details of this backup are ready. - * @type {string} - * @memberof BackupResponse - */ - 'hydrationStatus'?: BackupResponseHydrationStatusV3; - /** - * Number of objects contained in this backup. - * @type {number} - * @memberof BackupResponse - */ - 'totalObjectCount'?: number; - /** - * Whether this backup has been transferred to a customer storage location. - * @type {string} - * @memberof BackupResponse - */ - 'cloudStorageStatus'?: BackupResponseCloudStorageStatusV3; -} - -export const BackupResponseStatusV3 = { - NotStarted: 'NOT_STARTED', - InProgress: 'IN_PROGRESS', - Complete: 'COMPLETE', - Cancelled: 'CANCELLED', - Failed: 'FAILED' -} as const; - -export type BackupResponseStatusV3 = typeof BackupResponseStatusV3[keyof typeof BackupResponseStatusV3]; -export const BackupResponseTypeV3 = { - Backup: 'BACKUP' -} as const; - -export type BackupResponseTypeV3 = typeof BackupResponseTypeV3[keyof typeof BackupResponseTypeV3]; -export const BackupResponseBackupTypeV3 = { - Uploaded: 'UPLOADED', - Automated: 'AUTOMATED', - Manual: 'MANUAL' -} as const; - -export type BackupResponseBackupTypeV3 = typeof BackupResponseBackupTypeV3[keyof typeof BackupResponseBackupTypeV3]; -export const BackupResponseHydrationStatusV3 = { - Hydrated: 'HYDRATED', - NotHydrated: 'NOT_HYDRATED' -} as const; - -export type BackupResponseHydrationStatusV3 = typeof BackupResponseHydrationStatusV3[keyof typeof BackupResponseHydrationStatusV3]; -export const BackupResponseCloudStorageStatusV3 = { - Synced: 'SYNCED', - NotSynced: 'NOT_SYNCED', - SyncFailed: 'SYNC_FAILED' -} as const; - -export type BackupResponseCloudStorageStatusV3 = typeof BackupResponseCloudStorageStatusV3[keyof typeof BackupResponseCloudStorageStatusV3]; - -/** - * - * @export - * @interface Base64Decode - */ -export interface Base64Decode { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64Decode - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64Decode - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Base64Encode - */ -export interface Base64Encode { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Base64Encode - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Base64Encode - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface BaseAccess - */ -export interface BaseAccess { - /** - * Access item\'s description. - * @type {string} - * @memberof BaseAccess - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccess - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof BaseAccess - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof BaseAccess - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof BaseAccess - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof BaseAccess - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof BaseAccess - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwner} - * @memberof BaseAccess - */ - 'owner'?: BaseAccessOwner; -} -/** - * Owner\'s identity. - * @export - * @interface BaseAccessOwner - */ -export interface BaseAccessOwner { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof BaseAccessOwner - */ - 'type'?: BaseAccessOwnerTypeV3; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof BaseAccessOwner - */ - 'id'?: string; - /** - * Owner\'s display name. - * @type {string} - * @memberof BaseAccessOwner - */ - 'name'?: string; - /** - * Owner\'s email. - * @type {string} - * @memberof BaseAccessOwner - */ - 'email'?: string; -} - -export const BaseAccessOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type BaseAccessOwnerTypeV3 = typeof BaseAccessOwnerTypeV3[keyof typeof BaseAccessOwnerTypeV3]; - -/** - * - * @export - * @interface BaseAccessProfile - */ -export interface BaseAccessProfile { - /** - * Access profile\'s unique ID. - * @type {string} - * @memberof BaseAccessProfile - */ - 'id'?: string; - /** - * Access profile\'s display name. - * @type {string} - * @memberof BaseAccessProfile - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseAccount - */ -export interface BaseAccount { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof BaseAccount - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseAccount - */ - 'name'?: string; - /** - * Account ID. - * @type {string} - * @memberof BaseAccount - */ - 'accountId'?: string; - /** - * - * @type {AccountSource} - * @memberof BaseAccount - */ - 'source'?: AccountSource; - /** - * Indicates whether the account is disabled. - * @type {boolean} - * @memberof BaseAccount - */ - 'disabled'?: boolean; - /** - * Indicates whether the account is locked. - * @type {boolean} - * @memberof BaseAccount - */ - 'locked'?: boolean; - /** - * Indicates whether the account is privileged. - * @type {boolean} - * @memberof BaseAccount - */ - 'privileged'?: boolean; - /** - * Indicates whether the account has been manually correlated to an identity. - * @type {boolean} - * @memberof BaseAccount - */ - 'manuallyCorrelated'?: boolean; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof BaseAccount - */ - 'passwordLastSet'?: string | null; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccount - */ - 'entitlementAttributes'?: { [key: string]: any; } | null; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof BaseAccount - */ - 'created'?: string | null; - /** - * Indicates whether the account supports password change. - * @type {boolean} - * @memberof BaseAccount - */ - 'supportsPasswordChange'?: boolean; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof BaseAccount - */ - 'accountAttributes'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface BaseCommonDto - */ -export interface BaseCommonDto { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof BaseCommonDto - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof BaseCommonDto - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof BaseCommonDto - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof BaseCommonDto - */ - 'modified'?: string; -} -/** - * - * @export - * @interface BaseDocument - */ -export interface BaseDocument { - /** - * ID of the referenced object. - * @type {string} - * @memberof BaseDocument - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof BaseDocument - */ - 'name': string; -} -/** - * - * @export - * @interface BaseEntitlement - */ -export interface BaseEntitlement { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof BaseEntitlement - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof BaseEntitlement - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof BaseEntitlement - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof BaseEntitlement - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof BaseEntitlement - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof BaseEntitlement - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof BaseEntitlement - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof BaseEntitlement - */ - 'name'?: string; -} -/** - * - * @export - * @interface BaseReferenceDto - */ -export interface BaseReferenceDto { - /** - * - * @type {DtoType} - * @memberof BaseReferenceDto - */ - 'type'?: DtoType; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDto - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof BaseReferenceDto - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface BaseSegment - */ -export interface BaseSegment { - /** - * Segment\'s unique ID. - * @type {string} - * @memberof BaseSegment - */ - 'id'?: string; - /** - * Segment\'s display name. - * @type {string} - * @memberof BaseSegment - */ - 'name'?: string; -} -/** - * Before Provisioning Rule. - * @export - * @interface BeforeProvisioningRuleDto - */ -export interface BeforeProvisioningRuleDto { - /** - * Before Provisioning Rule DTO type. - * @type {string} - * @memberof BeforeProvisioningRuleDto - */ - 'type'?: BeforeProvisioningRuleDtoTypeV3; - /** - * Before Provisioning Rule ID. - * @type {string} - * @memberof BeforeProvisioningRuleDto - */ - 'id'?: string; - /** - * Rule display name. - * @type {string} - * @memberof BeforeProvisioningRuleDto - */ - 'name'?: string; -} - -export const BeforeProvisioningRuleDtoTypeV3 = { - Rule: 'RULE' -} as const; - -export type BeforeProvisioningRuleDtoTypeV3 = typeof BeforeProvisioningRuleDtoTypeV3[keyof typeof BeforeProvisioningRuleDtoTypeV3]; - -/** - * - * @export - * @interface Bound - */ -export interface Bound { - /** - * The value of the range\'s endpoint. - * @type {string} - * @memberof Bound - */ - 'value': string; - /** - * Indicates if the endpoint is included in the range. - * @type {boolean} - * @memberof Bound - */ - 'inclusive'?: boolean; -} -/** - * - * @export - * @interface BrandingItem - */ -export interface BrandingItem { - /** - * name of branding item - * @type {string} - * @memberof BrandingItem - */ - 'name'?: string; - /** - * product name - * @type {string} - * @memberof BrandingItem - */ - 'productName'?: string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItem - */ - 'actionButtonColor'?: string | null; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItem - */ - 'activeLinkColor'?: string | null; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItem - */ - 'navigationColor'?: string | null; - /** - * email from address - * @type {string} - * @memberof BrandingItem - */ - 'emailFromAddress'?: string | null; - /** - * url to standard logo - * @type {string} - * @memberof BrandingItem - */ - 'standardLogoURL'?: string | null; - /** - * login information message - * @type {string} - * @memberof BrandingItem - */ - 'loginInformationalMessage'?: string | null; -} -/** - * - * @export - * @interface BrandingItemCreate - */ -export interface BrandingItemCreate { - /** - * name of branding item - * @type {string} - * @memberof BrandingItemCreate - */ - 'name': string; - /** - * product name - * @type {string} - * @memberof BrandingItemCreate - */ - 'productName': string | null; - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingItemCreate - */ - 'actionButtonColor'?: string; - /** - * hex value of color for link - * @type {string} - * @memberof BrandingItemCreate - */ - 'activeLinkColor'?: string; - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingItemCreate - */ - 'navigationColor'?: string; - /** - * email from address - * @type {string} - * @memberof BrandingItemCreate - */ - 'emailFromAddress'?: string; - /** - * login information message - * @type {string} - * @memberof BrandingItemCreate - */ - 'loginInformationalMessage'?: string; - /** - * png file with logo - * @type {File} - * @memberof BrandingItemCreate - */ - 'fileStandard'?: File; -} -/** - * The bucket to group the results of the aggregation query by. - * @export - * @interface BucketAggregation - */ -export interface BucketAggregation { - /** - * The name of the bucket aggregate to be included in the result. - * @type {string} - * @memberof BucketAggregation - */ - 'name': string; - /** - * - * @type {BucketType} - * @memberof BucketAggregation - */ - 'type'?: BucketType; - /** - * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof BucketAggregation - */ - 'field': string; - /** - * Maximum number of buckets to include. - * @type {number} - * @memberof BucketAggregation - */ - 'size'?: number; - /** - * Minimum number of documents a bucket should have. - * @type {number} - * @memberof BucketAggregation - */ - 'minDocCount'?: number; -} - - -/** - * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const BucketType = { - Terms: 'TERMS' -} as const; - -export type BucketType = typeof BucketType[keyof typeof BucketType]; - - -/** - * - * @export - * @interface BulkAddTaggedObject - */ -export interface BulkAddTaggedObject { - /** - * - * @type {Array} - * @memberof BulkAddTaggedObject - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkAddTaggedObject - */ - 'tags'?: Array; - /** - * If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. - * @type {string} - * @memberof BulkAddTaggedObject - */ - 'operation'?: BulkAddTaggedObjectOperationV3; -} - -export const BulkAddTaggedObjectOperationV3 = { - Append: 'APPEND', - Merge: 'MERGE' -} as const; - -export type BulkAddTaggedObjectOperationV3 = typeof BulkAddTaggedObjectOperationV3[keyof typeof BulkAddTaggedObjectOperationV3]; - -/** - * - * @export - * @interface BulkRemoveTaggedObject - */ -export interface BulkRemoveTaggedObject { - /** - * - * @type {Array} - * @memberof BulkRemoveTaggedObject - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkRemoveTaggedObject - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface BulkTaggedObjectResponse - */ -export interface BulkTaggedObjectResponse { - /** - * - * @type {Array} - * @memberof BulkTaggedObjectResponse - */ - 'objectRefs'?: Array; - /** - * Label to be applied to an Object - * @type {Array} - * @memberof BulkTaggedObjectResponse - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface Campaign - */ -export interface Campaign { - /** - * Id of the campaign - * @type {string} - * @memberof Campaign - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof Campaign - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof Campaign - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof Campaign - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof Campaign - */ - 'type': CampaignTypeV3; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof Campaign - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof Campaign - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof Campaign - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof Campaign - */ - 'status'?: CampaignStatusV3; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof Campaign - */ - 'correlatedStatus'?: CampaignCorrelatedStatusV3; - /** - * Created time of the campaign - * @type {string} - * @memberof Campaign - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof Campaign - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof Campaign - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof Campaign - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof Campaign - */ - 'modified'?: string; - /** - * - * @type {CampaignAllOfFilter} - * @memberof Campaign - */ - 'filter'?: CampaignAllOfFilter; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof Campaign - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfo} - * @memberof Campaign - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfo; - /** - * - * @type {CampaignAllOfSearchCampaignInfo} - * @memberof Campaign - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfo; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfo} - * @memberof Campaign - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfo; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfo} - * @memberof Campaign - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfo; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof Campaign - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof Campaign - */ - 'mandatoryCommentRequirement'?: CampaignMandatoryCommentRequirementV3; -} - -export const CampaignTypeV3 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignTypeV3 = typeof CampaignTypeV3[keyof typeof CampaignTypeV3]; -export const CampaignStatusV3 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type CampaignStatusV3 = typeof CampaignStatusV3[keyof typeof CampaignStatusV3]; -export const CampaignCorrelatedStatusV3 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignCorrelatedStatusV3 = typeof CampaignCorrelatedStatusV3[keyof typeof CampaignCorrelatedStatusV3]; -export const CampaignMandatoryCommentRequirementV3 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignMandatoryCommentRequirementV3 = typeof CampaignMandatoryCommentRequirementV3[keyof typeof CampaignMandatoryCommentRequirementV3]; - -/** - * - * @export - * @interface CampaignAlert - */ -export interface CampaignAlert { - /** - * Denotes the level of the message - * @type {string} - * @memberof CampaignAlert - */ - 'level'?: CampaignAlertLevelV3; - /** - * - * @type {Array} - * @memberof CampaignAlert - */ - 'localizations'?: Array; -} - -export const CampaignAlertLevelV3 = { - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO' -} as const; - -export type CampaignAlertLevelV3 = typeof CampaignAlertLevelV3[keyof typeof CampaignAlertLevelV3]; - -/** - * Determines which items will be included in this campaign. The default campaign filter is used if this field is left blank. - * @export - * @interface CampaignAllOfFilter - */ -export interface CampaignAllOfFilter { - /** - * The ID of whatever type of filter is being used. - * @type {string} - * @memberof CampaignAllOfFilter - */ - 'id'?: string; - /** - * Type of the filter - * @type {string} - * @memberof CampaignAllOfFilter - */ - 'type'?: CampaignAllOfFilterTypeV3; - /** - * Name of the filter - * @type {string} - * @memberof CampaignAllOfFilter - */ - 'name'?: string; -} - -export const CampaignAllOfFilterTypeV3 = { - CampaignFilter: 'CAMPAIGN_FILTER' -} as const; - -export type CampaignAllOfFilterTypeV3 = typeof CampaignAllOfFilterTypeV3[keyof typeof CampaignAllOfFilterTypeV3]; - -/** - * Must be set only if the campaign type is MACHINE_ACCOUNT. - * @export - * @interface CampaignAllOfMachineAccountCampaignInfo - */ -export interface CampaignAllOfMachineAccountCampaignInfo { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfMachineAccountCampaignInfo - */ - 'sourceIds'?: Array; - /** - * The reviewer\'s type. - * @type {string} - * @memberof CampaignAllOfMachineAccountCampaignInfo - */ - 'reviewerType'?: CampaignAllOfMachineAccountCampaignInfoReviewerTypeV3; -} - -export const CampaignAllOfMachineAccountCampaignInfoReviewerTypeV3 = { - AccountOwner: 'ACCOUNT_OWNER' -} as const; - -export type CampaignAllOfMachineAccountCampaignInfoReviewerTypeV3 = typeof CampaignAllOfMachineAccountCampaignInfoReviewerTypeV3[keyof typeof CampaignAllOfMachineAccountCampaignInfoReviewerTypeV3]; - -/** - * Optional configuration options for role composition campaigns. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfo - */ -export interface CampaignAllOfRoleCompositionCampaignInfo { - /** - * - * @type {CampaignAllOfSearchCampaignInfoReviewer} - * @memberof CampaignAllOfRoleCompositionCampaignInfo - */ - 'reviewer'?: CampaignAllOfSearchCampaignInfoReviewer; - /** - * Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {Array} - * @memberof CampaignAllOfRoleCompositionCampaignInfo - */ - 'roleIds'?: Array; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfoRemediatorRef} - * @memberof CampaignAllOfRoleCompositionCampaignInfo - */ - 'remediatorRef': CampaignAllOfRoleCompositionCampaignInfoRemediatorRef; - /** - * Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfo - */ - 'query'?: string; - /** - * Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfo - */ - 'description'?: string; -} -/** - * This determines who remediation tasks will be assigned to. Remediation tasks are created for each revoke decision on items in the campaign. The only legal remediator type is \'IDENTITY\', and the chosen identity must be a Role Admin or Org Admin. - * @export - * @interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRef - */ -export interface CampaignAllOfRoleCompositionCampaignInfoRemediatorRef { - /** - * Legal Remediator Type - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRef - */ - 'type': CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeV3; - /** - * The ID of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRef - */ - 'id': string; - /** - * The name of the remediator. - * @type {string} - * @memberof CampaignAllOfRoleCompositionCampaignInfoRemediatorRef - */ - 'name'?: string; -} - -export const CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeV3 = typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeV3[keyof typeof CampaignAllOfRoleCompositionCampaignInfoRemediatorRefTypeV3]; - -/** - * Must be set only if the campaign type is SEARCH. - * @export - * @interface CampaignAllOfSearchCampaignInfo - */ -export interface CampaignAllOfSearchCampaignInfo { - /** - * The type of search campaign represented. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'type': CampaignAllOfSearchCampaignInfoTypeV3; - /** - * Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'description'?: string; - /** - * - * @type {CampaignAllOfSearchCampaignInfoReviewer} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'reviewer'?: CampaignAllOfSearchCampaignInfoReviewer; - /** - * The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'query'?: string; - /** - * A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'identityIds'?: Array; - /** - * Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. - * @type {Array} - * @memberof CampaignAllOfSearchCampaignInfo - */ - 'accessConstraints'?: Array; -} - -export const CampaignAllOfSearchCampaignInfoTypeV3 = { - Identity: 'IDENTITY', - Access: 'ACCESS' -} as const; - -export type CampaignAllOfSearchCampaignInfoTypeV3 = typeof CampaignAllOfSearchCampaignInfoTypeV3[keyof typeof CampaignAllOfSearchCampaignInfoTypeV3]; - -/** - * If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. - * @export - * @interface CampaignAllOfSearchCampaignInfoReviewer - */ -export interface CampaignAllOfSearchCampaignInfoReviewer { - /** - * The reviewer\'s DTO type. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewer - */ - 'type'?: CampaignAllOfSearchCampaignInfoReviewerTypeV3; - /** - * The reviewer\'s ID. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewer - */ - 'id'?: string; - /** - * The reviewer\'s name. - * @type {string} - * @memberof CampaignAllOfSearchCampaignInfoReviewer - */ - 'name'?: string; -} - -export const CampaignAllOfSearchCampaignInfoReviewerTypeV3 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type CampaignAllOfSearchCampaignInfoReviewerTypeV3 = typeof CampaignAllOfSearchCampaignInfoReviewerTypeV3[keyof typeof CampaignAllOfSearchCampaignInfoReviewerTypeV3]; - -/** - * Must be set only if the campaign type is SOURCE_OWNER. - * @export - * @interface CampaignAllOfSourceOwnerCampaignInfo - */ -export interface CampaignAllOfSourceOwnerCampaignInfo { - /** - * The list of sources to be included in the campaign. - * @type {Array} - * @memberof CampaignAllOfSourceOwnerCampaignInfo - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface CampaignAllOfSourcesWithOrphanEntitlements - */ -export interface CampaignAllOfSourcesWithOrphanEntitlements { - /** - * Id of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlements - */ - 'id'?: string; - /** - * Type - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlements - */ - 'type'?: CampaignAllOfSourcesWithOrphanEntitlementsTypeV3; - /** - * Name of the source - * @type {string} - * @memberof CampaignAllOfSourcesWithOrphanEntitlements - */ - 'name'?: string; -} - -export const CampaignAllOfSourcesWithOrphanEntitlementsTypeV3 = { - Source: 'SOURCE' -} as const; - -export type CampaignAllOfSourcesWithOrphanEntitlementsTypeV3 = typeof CampaignAllOfSourcesWithOrphanEntitlementsTypeV3[keyof typeof CampaignAllOfSourcesWithOrphanEntitlementsTypeV3]; - -/** - * - * @export - * @interface CampaignCompleteOptions - */ -export interface CampaignCompleteOptions { - /** - * Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. - * @type {string} - * @memberof CampaignCompleteOptions - */ - 'autoCompleteAction'?: CampaignCompleteOptionsAutoCompleteActionV3; -} - -export const CampaignCompleteOptionsAutoCompleteActionV3 = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CampaignCompleteOptionsAutoCompleteActionV3 = typeof CampaignCompleteOptionsAutoCompleteActionV3[keyof typeof CampaignCompleteOptionsAutoCompleteActionV3]; - -/** - * Campaign Filter Details - * @export - * @interface CampaignFilterDetails - */ -export interface CampaignFilterDetails { - /** - * The unique ID of the campaign filter - * @type {string} - * @memberof CampaignFilterDetails - */ - 'id': string; - /** - * Campaign filter name. - * @type {string} - * @memberof CampaignFilterDetails - */ - 'name': string; - /** - * Campaign filter description. - * @type {string} - * @memberof CampaignFilterDetails - */ - 'description'?: string; - /** - * Owner of the filter. This field automatically populates at creation time with the current user. - * @type {string} - * @memberof CampaignFilterDetails - */ - 'owner': string | null; - /** - * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. - * @type {string} - * @memberof CampaignFilterDetails - */ - 'mode': CampaignFilterDetailsModeV3; - /** - * List of criteria. - * @type {Array} - * @memberof CampaignFilterDetails - */ - 'criteriaList'?: Array; - /** - * If true, the filter is created by the system. If false, the filter is created by a user. - * @type {boolean} - * @memberof CampaignFilterDetails - */ - 'isSystemFilter': boolean; -} - -export const CampaignFilterDetailsModeV3 = { - Inclusion: 'INCLUSION', - Exclusion: 'EXCLUSION' -} as const; - -export type CampaignFilterDetailsModeV3 = typeof CampaignFilterDetailsModeV3[keyof typeof CampaignFilterDetailsModeV3]; - -/** - * - * @export - * @interface CampaignFilterDetailsCriteriaListInner - */ -export interface CampaignFilterDetailsCriteriaListInner { - /** - * - * @type {CriteriaType} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'type': CriteriaType; - /** - * - * @type {Operation} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'operation'?: Operation | null; - /** - * Specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'property': string | null; - /** - * Value for the specified key from the type of criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'value': string | null; - /** - * If true, the filter will negate the result of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'negateResult'?: boolean; - /** - * If true, the filter will short circuit the evaluation of the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'shortCircuit'?: boolean; - /** - * If true, the filter will record child matches for the criteria. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'recordChildMatches'?: boolean; - /** - * The unique ID of the criteria. - * @type {string} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'id'?: string | null; - /** - * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. - * @type {boolean} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'suppressMatchedItems'?: boolean; - /** - * List of child criteria. - * @type {Array} - * @memberof CampaignFilterDetailsCriteriaListInner - */ - 'children'?: Array; -} - - -/** - * - * @export - * @interface CampaignReference - */ -export interface CampaignReference { - /** - * The unique ID of the campaign. - * @type {string} - * @memberof CampaignReference - */ - 'id': string; - /** - * The name of the campaign. - * @type {string} - * @memberof CampaignReference - */ - 'name': string; - /** - * The type of object that is being referenced. - * @type {string} - * @memberof CampaignReference - */ - 'type': CampaignReferenceTypeV3; - /** - * The type of the campaign. - * @type {string} - * @memberof CampaignReference - */ - 'campaignType': CampaignReferenceCampaignTypeV3; - /** - * The description of the campaign set by the admin who created it. - * @type {string} - * @memberof CampaignReference - */ - 'description': string | null; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof CampaignReference - */ - 'correlatedStatus': CampaignReferenceCorrelatedStatusV3; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof CampaignReference - */ - 'mandatoryCommentRequirement': CampaignReferenceMandatoryCommentRequirementV3; -} - -export const CampaignReferenceTypeV3 = { - Campaign: 'CAMPAIGN' -} as const; - -export type CampaignReferenceTypeV3 = typeof CampaignReferenceTypeV3[keyof typeof CampaignReferenceTypeV3]; -export const CampaignReferenceCampaignTypeV3 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type CampaignReferenceCampaignTypeV3 = typeof CampaignReferenceCampaignTypeV3[keyof typeof CampaignReferenceCampaignTypeV3]; -export const CampaignReferenceCorrelatedStatusV3 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type CampaignReferenceCorrelatedStatusV3 = typeof CampaignReferenceCorrelatedStatusV3[keyof typeof CampaignReferenceCorrelatedStatusV3]; -export const CampaignReferenceMandatoryCommentRequirementV3 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type CampaignReferenceMandatoryCommentRequirementV3 = typeof CampaignReferenceMandatoryCommentRequirementV3[keyof typeof CampaignReferenceMandatoryCommentRequirementV3]; - -/** - * - * @export - * @interface CampaignReport - */ -export interface CampaignReport { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof CampaignReport - */ - 'type'?: CampaignReportTypeV3; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof CampaignReport - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof CampaignReport - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof CampaignReport - */ - 'status'?: CampaignReportStatusV3; - /** - * - * @type {ReportType} - * @memberof CampaignReport - */ - 'reportType': ReportType; - /** - * The most recent date and time this report was run - * @type {string} - * @memberof CampaignReport - */ - 'lastRunAt'?: string; -} - -export const CampaignReportTypeV3 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type CampaignReportTypeV3 = typeof CampaignReportTypeV3[keyof typeof CampaignReportTypeV3]; -export const CampaignReportStatusV3 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type CampaignReportStatusV3 = typeof CampaignReportStatusV3[keyof typeof CampaignReportStatusV3]; - -/** - * - * @export - * @interface CampaignReportsConfig - */ -export interface CampaignReportsConfig { - /** - * list of identity attribute columns - * @type {Array} - * @memberof CampaignReportsConfig - */ - 'identityAttributeColumns'?: Array | null; -} -/** - * Campaign Template - * @export - * @interface CampaignTemplate - */ -export interface CampaignTemplate { - /** - * Id of the campaign template - * @type {string} - * @memberof CampaignTemplate - */ - 'id'?: string; - /** - * This template\'s name. Has no bearing on generated campaigns\' names. - * @type {string} - * @memberof CampaignTemplate - */ - 'name': string; - /** - * This template\'s description. Has no bearing on generated campaigns\' descriptions. - * @type {string} - * @memberof CampaignTemplate - */ - 'description': string; - /** - * Creation date of Campaign Template - * @type {string} - * @memberof CampaignTemplate - */ - 'created': string; - /** - * Modification date of Campaign Template - * @type {string} - * @memberof CampaignTemplate - */ - 'modified': string | null; - /** - * Indicates if this campaign template has been scheduled. - * @type {boolean} - * @memberof CampaignTemplate - */ - 'scheduled'?: boolean; - /** - * - * @type {CampaignTemplateOwnerRef} - * @memberof CampaignTemplate - */ - 'ownerRef'?: CampaignTemplateOwnerRef; - /** - * The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). - * @type {string} - * @memberof CampaignTemplate - */ - 'deadlineDuration'?: string; - /** - * - * @type {Campaign} - * @memberof CampaignTemplate - */ - 'campaign': Campaign; -} -/** - * The owner of this template, and the owner of campaigns generated from this template via a schedule. This field is automatically populated at creation time with the current user. - * @export - * @interface CampaignTemplateOwnerRef - */ -export interface CampaignTemplateOwnerRef { - /** - * Id of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRef - */ - 'id'?: string; - /** - * Type of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRef - */ - 'type'?: CampaignTemplateOwnerRefTypeV3; - /** - * Name of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRef - */ - 'name'?: string; - /** - * Email of the owner - * @type {string} - * @memberof CampaignTemplateOwnerRef - */ - 'email'?: string; -} - -export const CampaignTemplateOwnerRefTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type CampaignTemplateOwnerRefTypeV3 = typeof CampaignTemplateOwnerRefTypeV3[keyof typeof CampaignTemplateOwnerRefTypeV3]; - -/** - * - * @export - * @interface CampaignsDeleteRequest - */ -export interface CampaignsDeleteRequest { - /** - * The ids of the campaigns to delete - * @type {Array} - * @memberof CampaignsDeleteRequest - */ - 'ids'?: Array; -} -/** - * Request body payload for cancel access request endpoint. - * @export - * @interface CancelAccessRequest - */ -export interface CancelAccessRequest { - /** - * This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. - * @type {string} - * @memberof CancelAccessRequest - */ - 'accountActivityId': string; - /** - * Reason for cancelling the pending access request. - * @type {string} - * @memberof CancelAccessRequest - */ - 'comment': string; -} -/** - * Provides additional details for a request that has been cancelled. - * @export - * @interface CancelledRequestDetails - */ -export interface CancelledRequestDetails { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetails - */ - 'comment'?: string; - /** - * - * @type {OwnerDto} - * @memberof CancelledRequestDetails - */ - 'owner'?: OwnerDto; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof CancelledRequestDetails - */ - 'modified'?: string; -} -/** - * - * @export - * @interface Certification - */ -export interface Certification { - /** - * id of the certification - * @type {string} - * @memberof Certification - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof Certification - */ - 'name'?: string; - /** - * - * @type {CampaignReference} - * @memberof Certification - */ - 'campaign'?: CampaignReference; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof Certification - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof Certification - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof Certification - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof Certification - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof Certification - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof Certification - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof Certification - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof Certification - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof Certification - */ - 'signed'?: string | null; - /** - * - * @type {Reviewer} - * @memberof Certification - */ - 'reviewer'?: Reviewer; - /** - * - * @type {Reassignment} - * @memberof Certification - */ - 'reassignment'?: Reassignment | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof Certification - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof Certification - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhase} - * @memberof Certification - */ - 'phase'?: CertificationPhase; -} - - -/** - * The decision to approve or revoke the review item - * @export - * @enum {string} - */ - -export const CertificationDecision = { - Approve: 'APPROVE', - Revoke: 'REVOKE' -} as const; - -export type CertificationDecision = typeof CertificationDecision[keyof typeof CertificationDecision]; - - -/** - * - * @export - * @interface CertificationIdentitySummary - */ -export interface CertificationIdentitySummary { - /** - * The ID of the identity summary - * @type {string} - * @memberof CertificationIdentitySummary - */ - 'id'?: string; - /** - * Name of the linked identity - * @type {string} - * @memberof CertificationIdentitySummary - */ - 'name'?: string; - /** - * The ID of the identity being certified - * @type {string} - * @memberof CertificationIdentitySummary - */ - 'identityId'?: string; - /** - * Indicates whether the review items for the linked identity\'s certification have been completed - * @type {boolean} - * @memberof CertificationIdentitySummary - */ - 'completed'?: boolean; -} -/** - * The current phase of the campaign. * `STAGED`: The campaign is waiting to be activated. * `ACTIVE`: The campaign is active. * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - * @export - * @enum {string} - */ - -export const CertificationPhase = { - Staged: 'STAGED', - Active: 'ACTIVE', - Signed: 'SIGNED' -} as const; - -export type CertificationPhase = typeof CertificationPhase[keyof typeof CertificationPhase]; - - -/** - * - * @export - * @interface CertificationReference - */ -export interface CertificationReference { - /** - * The id of the certification. - * @type {string} - * @memberof CertificationReference - */ - 'id'?: string; - /** - * The name of the certification. - * @type {string} - * @memberof CertificationReference - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof CertificationReference - */ - 'type'?: CertificationReferenceTypeV3; - /** - * - * @type {Reviewer} - * @memberof CertificationReference - */ - 'reviewer'?: Reviewer; -} - -export const CertificationReferenceTypeV3 = { - Certification: 'CERTIFICATION' -} as const; - -export type CertificationReferenceTypeV3 = typeof CertificationReferenceTypeV3[keyof typeof CertificationReferenceTypeV3]; - -/** - * - * @export - * @interface CertificationTask - */ -export interface CertificationTask { - /** - * The ID of the certification task. - * @type {string} - * @memberof CertificationTask - */ - 'id'?: string; - /** - * The type of the certification task. More values may be added in the future. - * @type {string} - * @memberof CertificationTask - */ - 'type'?: CertificationTaskTypeV3; - /** - * The type of item that is being operated on by this task whose ID is stored in the targetId field. - * @type {string} - * @memberof CertificationTask - */ - 'targetType'?: CertificationTaskTargetTypeV3; - /** - * The ID of the item being operated on by this task. - * @type {string} - * @memberof CertificationTask - */ - 'targetId'?: string; - /** - * The status of the task. - * @type {string} - * @memberof CertificationTask - */ - 'status'?: CertificationTaskStatusV3; - /** - * - * @type {Array} - * @memberof CertificationTask - */ - 'errors'?: Array; - /** - * Reassignment trails that lead to self certification identity - * @type {Array} - * @memberof CertificationTask - */ - 'reassignmentTrailDTOs'?: Array; - /** - * The date and time on which this task was created. - * @type {string} - * @memberof CertificationTask - */ - 'created'?: string; -} - -export const CertificationTaskTypeV3 = { - Reassign: 'REASSIGN', - AdminReassign: 'ADMIN_REASSIGN', - CompleteCertification: 'COMPLETE_CERTIFICATION', - FinishCertification: 'FINISH_CERTIFICATION', - CompleteCampaign: 'COMPLETE_CAMPAIGN', - ActivateCampaign: 'ACTIVATE_CAMPAIGN', - CampaignCreate: 'CAMPAIGN_CREATE', - CampaignDelete: 'CAMPAIGN_DELETE' -} as const; - -export type CertificationTaskTypeV3 = typeof CertificationTaskTypeV3[keyof typeof CertificationTaskTypeV3]; -export const CertificationTaskTargetTypeV3 = { - Certification: 'CERTIFICATION', - Campaign: 'CAMPAIGN' -} as const; - -export type CertificationTaskTargetTypeV3 = typeof CertificationTaskTargetTypeV3[keyof typeof CertificationTaskTargetTypeV3]; -export const CertificationTaskStatusV3 = { - Queued: 'QUEUED', - InProgress: 'IN_PROGRESS', - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type CertificationTaskStatusV3 = typeof CertificationTaskStatusV3[keyof typeof CertificationTaskStatusV3]; - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfiguration - */ -export interface ClientLogConfiguration { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfiguration - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfiguration - */ - 'durationMinutes'?: number; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfiguration - */ - 'expiration'?: string; - /** - * - * @type {StandardLevel} - * @memberof ClientLogConfiguration - */ - 'rootLevel': StandardLevel; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevel; }} - * @memberof ClientLogConfiguration - */ - 'logLevels'?: { [key: string]: StandardLevel; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationDurationMinutes - */ -export interface ClientLogConfigurationDurationMinutes { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationDurationMinutes - */ - 'clientId'?: string; - /** - * Duration in minutes for log configuration to remain in effect before resetting to defaults. - * @type {number} - * @memberof ClientLogConfigurationDurationMinutes - */ - 'durationMinutes'?: number; - /** - * - * @type {StandardLevel} - * @memberof ClientLogConfigurationDurationMinutes - */ - 'rootLevel': StandardLevel; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevel; }} - * @memberof ClientLogConfigurationDurationMinutes - */ - 'logLevels'?: { [key: string]: StandardLevel; }; -} - - -/** - * Client Runtime Logging Configuration - * @export - * @interface ClientLogConfigurationExpiration - */ -export interface ClientLogConfigurationExpiration { - /** - * Log configuration\'s client ID - * @type {string} - * @memberof ClientLogConfigurationExpiration - */ - 'clientId'?: string; - /** - * Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - * @type {string} - * @memberof ClientLogConfigurationExpiration - */ - 'expiration'?: string; - /** - * - * @type {StandardLevel} - * @memberof ClientLogConfigurationExpiration - */ - 'rootLevel': StandardLevel; - /** - * Mapping of identifiers to Standard Log Level values - * @type {{ [key: string]: StandardLevel; }} - * @memberof ClientLogConfigurationExpiration - */ - 'logLevels'?: { [key: string]: StandardLevel; }; -} - - -/** - * Type of an API Client indicating public or confidentials use - * @export - * @enum {string} - */ - -export const ClientType = { - Confidential: 'CONFIDENTIAL', - Public: 'PUBLIC' -} as const; - -export type ClientType = typeof ClientType[keyof typeof ClientType]; - - -/** - * - * @export - * @interface Column - */ -export interface Column { - /** - * The name of the field. - * @type {string} - * @memberof Column - */ - 'field': string; - /** - * The value of the header. - * @type {string} - * @memberof Column - */ - 'header'?: string; -} -/** - * - * @export - * @interface Comment - */ -export interface Comment { - /** - * Id of the identity making the comment - * @type {string} - * @memberof Comment - */ - 'commenterId'?: string; - /** - * Human-readable display name of the identity making the comment - * @type {string} - * @memberof Comment - */ - 'commenterName'?: string; - /** - * Content of the comment - * @type {string} - * @memberof Comment - */ - 'body'?: string; - /** - * Date and time comment was made - * @type {string} - * @memberof Comment - */ - 'date'?: string; -} -/** - * - * @export - * @interface CommentDto - */ -export interface CommentDto { - /** - * Comment content. - * @type {string} - * @memberof CommentDto - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CommentDto - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthor} - * @memberof CommentDto - */ - 'author'?: CommentDtoAuthor; -} -/** - * Author of the comment - * @export - * @interface CommentDtoAuthor - */ -export interface CommentDtoAuthor { - /** - * The type of object - * @type {string} - * @memberof CommentDtoAuthor - */ - 'type'?: CommentDtoAuthorTypeV3; - /** - * The unique ID of the object - * @type {string} - * @memberof CommentDtoAuthor - */ - 'id'?: string; - /** - * The display name of the object - * @type {string} - * @memberof CommentDtoAuthor - */ - 'name'?: string; -} - -export const CommentDtoAuthorTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type CommentDtoAuthorTypeV3 = typeof CommentDtoAuthorTypeV3[keyof typeof CommentDtoAuthorTypeV3]; - -/** - * - * @export - * @interface CompletedApproval - */ -export interface CompletedApproval { - /** - * The approval id. - * @type {string} - * @memberof CompletedApproval - */ - 'id'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof CompletedApproval - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof CompletedApproval - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof CompletedApproval - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof CompletedApproval - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestType} - * @memberof CompletedApproval - */ - 'requestType'?: AccessRequestType | null; - /** - * - * @type {AccessItemRequester} - * @memberof CompletedApproval - */ - 'requester'?: AccessItemRequester; - /** - * - * @type {RequestedItemStatusRequestedFor} - * @memberof CompletedApproval - */ - 'requestedFor'?: RequestedItemStatusRequestedFor; - /** - * - * @type {AccessItemReviewedBy} - * @memberof CompletedApproval - */ - 'reviewedBy'?: AccessItemReviewedBy; - /** - * - * @type {OwnerDto} - * @memberof CompletedApproval - */ - 'owner'?: OwnerDto; - /** - * - * @type {RequestableObjectReference} - * @memberof CompletedApproval - */ - 'requestedObject'?: RequestableObjectReference; - /** - * - * @type {CompletedApprovalRequesterComment} - * @memberof CompletedApproval - */ - 'requesterComment'?: CompletedApprovalRequesterComment; - /** - * - * @type {CompletedApprovalReviewerComment} - * @memberof CompletedApproval - */ - 'reviewerComment'?: CompletedApprovalReviewerComment; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof CompletedApproval - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof CompletedApproval - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof CompletedApproval - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {CompletedApprovalState} - * @memberof CompletedApproval - */ - 'state'?: CompletedApprovalState; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof CompletedApproval - */ - 'removeDate'?: string | null; - /** - * If true, then the request was to change the remove date or sunset date. - * @type {boolean} - * @memberof CompletedApproval - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApproval - */ - 'currentRemoveDate'?: string | null; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof CompletedApproval - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof CompletedApproval - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof CompletedApproval - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompleted} - * @memberof CompletedApproval - */ - 'sodViolationContext'?: SodViolationContextCheckCompleted | null; - /** - * - * @type {CompletedApprovalPreApprovalTriggerResult} - * @memberof CompletedApproval - */ - 'preApprovalTriggerResult'?: CompletedApprovalPreApprovalTriggerResult | null; - /** - * Arbitrary key-value pairs provided during the request. - * @type {{ [key: string]: string; }} - * @memberof CompletedApproval - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof CompletedApproval - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof CompletedApproval - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDuration} - * @memberof CompletedApproval - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDuration | null; -} - - -/** - * If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request. - * @export - * @interface CompletedApprovalPreApprovalTriggerResult - */ -export interface CompletedApprovalPreApprovalTriggerResult { - /** - * The comment from the trigger - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResult - */ - 'comment'?: string; - /** - * - * @type {CompletedApprovalState} - * @memberof CompletedApprovalPreApprovalTriggerResult - */ - 'decision'?: CompletedApprovalState; - /** - * The name of the approver - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResult - */ - 'reviewer'?: string; - /** - * The date and time the trigger decided on the request - * @type {string} - * @memberof CompletedApprovalPreApprovalTriggerResult - */ - 'date'?: string; -} - - -/** - * - * @export - * @interface CompletedApprovalRequesterComment - */ -export interface CompletedApprovalRequesterComment { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalRequesterComment - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalRequesterComment - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthor} - * @memberof CompletedApprovalRequesterComment - */ - 'author'?: CommentDtoAuthor; -} -/** - * - * @export - * @interface CompletedApprovalReviewerComment - */ -export interface CompletedApprovalReviewerComment { - /** - * Comment content. - * @type {string} - * @memberof CompletedApprovalReviewerComment - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof CompletedApprovalReviewerComment - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthor} - * @memberof CompletedApprovalReviewerComment - */ - 'author'?: CommentDtoAuthor; -} -/** - * Enum represents completed approval object\'s state. - * @export - * @enum {string} - */ - -export const CompletedApprovalState = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type CompletedApprovalState = typeof CompletedApprovalState[keyof typeof CompletedApprovalState]; - - -/** - * The status after completion. - * @export - * @enum {string} - */ - -export const CompletionStatus = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Incomplete: 'INCOMPLETE', - Pending: 'PENDING' -} as const; - -export type CompletionStatus = typeof CompletionStatus[keyof typeof CompletionStatus]; - - -/** - * - * @export - * @interface Concatenation - */ -export interface Concatenation { - /** - * An array of items to join together - * @type {Array} - * @memberof Concatenation - */ - 'values': Array; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Concatenation - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Concatenation - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Conditional - */ -export interface Conditional { - /** - * A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison - * @type {string} - * @memberof Conditional - */ - 'expression': string; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof Conditional - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof Conditional - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Conditional - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Conditional - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ConflictingAccessCriteria - */ -export interface ConflictingAccessCriteria { - /** - * - * @type {AccessCriteria} - * @memberof ConflictingAccessCriteria - */ - 'leftCriteria'?: AccessCriteria; - /** - * - * @type {AccessCriteria} - * @memberof ConflictingAccessCriteria - */ - 'rightCriteria'?: AccessCriteria; -} -/** - * - * @export - * @interface ConflictingAccessCriteriaRequest - */ -export interface ConflictingAccessCriteriaRequest { - /** - * - * @type {AccessCriteriaRequest} - * @memberof ConflictingAccessCriteriaRequest - */ - 'leftCriteria'?: AccessCriteriaRequest; - /** - * - * @type {AccessCriteriaRequest} - * @memberof ConflictingAccessCriteriaRequest - */ - 'rightCriteria'?: AccessCriteriaRequest; -} -/** - * - * @export - * @interface ConnectorDetail - */ -export interface ConnectorDetail { - /** - * The connector name - * @type {string} - * @memberof ConnectorDetail - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof ConnectorDetail - */ - 'type'?: string; - /** - * The connector class name - * @type {string} - * @memberof ConnectorDetail - */ - 'className'?: string; - /** - * The connector script name - * @type {string} - * @memberof ConnectorDetail - */ - 'scriptName'?: string; - /** - * The connector application xml - * @type {string} - * @memberof ConnectorDetail - */ - 'applicationXml'?: string; - /** - * The connector correlation config xml - * @type {string} - * @memberof ConnectorDetail - */ - 'correlationConfigXml'?: string; - /** - * The connector source config xml - * @type {string} - * @memberof ConnectorDetail - */ - 'sourceConfigXml'?: string; - /** - * The connector source config - * @type {string} - * @memberof ConnectorDetail - */ - 'sourceConfig'?: string; - /** - * The connector source config origin - * @type {string} - * @memberof ConnectorDetail - */ - 'sourceConfigFrom'?: string; - /** - * storage path key for this connector - * @type {string} - * @memberof ConnectorDetail - */ - 's3Location'?: string; - /** - * The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. - * @type {Array} - * @memberof ConnectorDetail - */ - 'uploadedFiles'?: Array | null; - /** - * true if the source is file upload - * @type {boolean} - * @memberof ConnectorDetail - */ - 'fileUpload'?: boolean; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof ConnectorDetail - */ - 'directConnect'?: boolean; - /** - * A map containing translation attributes by loacale key - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetail - */ - 'translationProperties'?: { [key: string]: any; }; - /** - * A map containing metadata pertinent to the UI to be used - * @type {{ [key: string]: any; }} - * @memberof ConnectorDetail - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof ConnectorDetail - */ - 'status'?: ConnectorDetailStatusV3; -} - -export const ConnectorDetailStatusV3 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type ConnectorDetailStatusV3 = typeof ConnectorDetailStatusV3[keyof typeof ConnectorDetailStatusV3]; - -/** - * - * @export - * @interface CreateExternalExecuteWorkflow200Response - */ -export interface CreateExternalExecuteWorkflow200Response { - /** - * The workflow execution id - * @type {string} - * @memberof CreateExternalExecuteWorkflow200Response - */ - 'workflowExecutionId'?: string; - /** - * An error message if any errors occurred - * @type {string} - * @memberof CreateExternalExecuteWorkflow200Response - */ - 'message'?: string; -} -/** - * - * @export - * @interface CreateExternalExecuteWorkflowRequest - */ -export interface CreateExternalExecuteWorkflowRequest { - /** - * The input for the workflow - * @type {object} - * @memberof CreateExternalExecuteWorkflowRequest - */ - 'input'?: object; -} -/** - * - * @export - * @interface CreateOAuthClientRequest - */ -export interface CreateOAuthClientRequest { - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientRequest - */ - 'businessName'?: string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientRequest - */ - 'homepageUrl'?: string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientRequest - */ - 'name': string | null; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientRequest - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequest - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientRequest - */ - 'refreshTokenValiditySeconds'?: number; - /** - * A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - * @type {Array} - * @memberof CreateOAuthClientRequest - */ - 'redirectUris'?: Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientRequest - */ - 'grantTypes': Array | null; - /** - * - * @type {AccessType} - * @memberof CreateOAuthClientRequest - */ - 'accessType': AccessType; - /** - * - * @type {ClientType} - * @memberof CreateOAuthClientRequest - */ - 'type'?: ClientType; - /** - * An indicator of whether the API Client can be used for requests internal within the product. - * @type {boolean} - * @memberof CreateOAuthClientRequest - */ - 'internal'?: boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientRequest - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientRequest - */ - 'strongAuthSupported'?: boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientRequest - */ - 'claimsSupported'?: boolean; - /** - * Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreateOAuthClientRequest - */ - 'scope'?: Array | null; -} - - -/** - * - * @export - * @interface CreateOAuthClientResponse - */ -export interface CreateOAuthClientResponse { - /** - * ID of the OAuth client - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'id': string; - /** - * Secret of the OAuth client (This field is only returned on the intial create call.) - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'secret': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'businessName': string; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'homepageUrl': string; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'description': string; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponse - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof CreateOAuthClientResponse - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof CreateOAuthClientResponse - */ - 'redirectUris': Array; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof CreateOAuthClientResponse - */ - 'grantTypes': Array; - /** - * - * @type {AccessType} - * @memberof CreateOAuthClientResponse - */ - 'accessType': AccessType; - /** - * - * @type {ClientType} - * @memberof CreateOAuthClientResponse - */ - 'type': ClientType; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof CreateOAuthClientResponse - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof CreateOAuthClientResponse - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof CreateOAuthClientResponse - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof CreateOAuthClientResponse - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof CreateOAuthClientResponse - */ - 'modified': string; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof CreateOAuthClientResponse - */ - 'scope': Array | null; -} - - -/** - * Object for specifying the name of a personal access token to create - * @export - * @interface CreatePersonalAccessTokenRequest - */ -export interface CreatePersonalAccessTokenRequest { - /** - * The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - * @type {string} - * @memberof CreatePersonalAccessTokenRequest - */ - 'name': string; - /** - * Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. - * @type {Array} - * @memberof CreatePersonalAccessTokenRequest - */ - 'scope'?: Array | null; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenRequest - */ - 'accessTokenValiditySeconds'?: number | null; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenRequest - */ - 'expirationDate'?: string | null; -} -/** - * - * @export - * @interface CreatePersonalAccessTokenResponse - */ -export interface CreatePersonalAccessTokenResponse { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponse - */ - 'id': string; - /** - * The secret of the personal access token (to be used as the password for Basic Auth). - * @type {string} - * @memberof CreatePersonalAccessTokenResponse - */ - 'secret': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof CreatePersonalAccessTokenResponse - */ - 'scope': Array | null; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof CreatePersonalAccessTokenResponse - */ - 'name': string; - /** - * - * @type {PatOwner} - * @memberof CreatePersonalAccessTokenResponse - */ - 'owner': PatOwner; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof CreatePersonalAccessTokenResponse - */ - 'created': string; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof CreatePersonalAccessTokenResponse - */ - 'accessTokenValiditySeconds': number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof CreatePersonalAccessTokenResponse - */ - 'expirationDate': string; -} -/** - * - * @export - * @interface CreateSavedSearchRequest - */ -export interface CreateSavedSearchRequest { - /** - * The name of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequest - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof CreateSavedSearchRequest - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequest - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof CreateSavedSearchRequest - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof CreateSavedSearchRequest - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequest - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof CreateSavedSearchRequest - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof CreateSavedSearchRequest - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof CreateSavedSearchRequest - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof CreateSavedSearchRequest - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFilters} - * @memberof CreateSavedSearchRequest - */ - 'filters'?: SavedSearchDetailFilters | null; -} -/** - * - * @export - * @interface CreateScheduledSearchRequest - */ -export interface CreateScheduledSearchRequest { - /** - * The name of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequest - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof CreateScheduledSearchRequest - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof CreateScheduledSearchRequest - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof CreateScheduledSearchRequest - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof CreateScheduledSearchRequest - */ - 'modified'?: string | null; - /** - * - * @type {Schedule1} - * @memberof CreateScheduledSearchRequest - */ - 'schedule': Schedule1; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof CreateScheduledSearchRequest - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof CreateScheduledSearchRequest - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof CreateScheduledSearchRequest - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof CreateScheduledSearchRequest - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface CreateUploadedConfigurationRequest - */ -export interface CreateUploadedConfigurationRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof CreateUploadedConfigurationRequest - */ - 'data': File; - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof CreateUploadedConfigurationRequest - */ - 'name': string; -} -/** - * - * @export - * @interface CreateWorkflowRequest - */ -export interface CreateWorkflowRequest { - /** - * The name of the workflow - * @type {string} - * @memberof CreateWorkflowRequest - */ - 'name': string; - /** - * - * @type {WorkflowBodyOwner} - * @memberof CreateWorkflowRequest - */ - 'owner'?: WorkflowBodyOwner; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof CreateWorkflowRequest - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinition} - * @memberof CreateWorkflowRequest - */ - 'definition'?: WorkflowDefinition; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof CreateWorkflowRequest - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTrigger} - * @memberof CreateWorkflowRequest - */ - 'trigger'?: WorkflowTrigger; -} -/** - * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. - * @export - * @enum {string} - */ - -export const CriteriaType = { - Composite: 'COMPOSITE', - Role: 'ROLE', - Identity: 'IDENTITY', - IdentityAttribute: 'IDENTITY_ATTRIBUTE', - Entitlement: 'ENTITLEMENT', - AccessProfile: 'ACCESS_PROFILE', - Source: 'SOURCE', - Account: 'ACCOUNT', - AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', - InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', - InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' -} as const; - -export type CriteriaType = typeof CriteriaType[keyof typeof CriteriaType]; - - -/** - * DAS data for the entitlement - * @export - * @interface DataAccess - */ -export interface DataAccess { - /** - * List of classification policies that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccess - */ - 'policies'?: Array; - /** - * List of classification categories that apply to resources the entitlement \\ groups has access to - * @type {Array} - * @memberof DataAccess - */ - 'categories'?: Array; - /** - * - * @type {DataAccessImpactScore} - * @memberof DataAccess - */ - 'impactScore'?: DataAccessImpactScore; -} -/** - * - * @export - * @interface DataAccessCategoriesInner - */ -export interface DataAccessCategoriesInner { - /** - * Value of the category - * @type {string} - * @memberof DataAccessCategoriesInner - */ - 'value'?: string; - /** - * Number of matched for each category - * @type {number} - * @memberof DataAccessCategoriesInner - */ - 'matchCount'?: number; -} -/** - * - * @export - * @interface DataAccessImpactScore - */ -export interface DataAccessImpactScore { - /** - * Impact Score for this data - * @type {string} - * @memberof DataAccessImpactScore - */ - 'value'?: string; -} -/** - * - * @export - * @interface DataAccessPoliciesInner - */ -export interface DataAccessPoliciesInner { - /** - * Value of the policy - * @type {string} - * @memberof DataAccessPoliciesInner - */ - 'value'?: string; -} -/** - * - * @export - * @interface DateCompare - */ -export interface DateCompare { - /** - * - * @type {DateCompareFirstDate} - * @memberof DateCompare - */ - 'firstDate': DateCompareFirstDate; - /** - * - * @type {DateCompareSecondDate} - * @memberof DateCompare - */ - 'secondDate': DateCompareSecondDate; - /** - * This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | - * @type {string} - * @memberof DateCompare - */ - 'operator': DateCompareOperatorV3; - /** - * The output of the transform if the expression evalutes to true - * @type {string} - * @memberof DateCompare - */ - 'positiveCondition': string; - /** - * The output of the transform if the expression evalutes to false - * @type {string} - * @memberof DateCompare - */ - 'negativeCondition': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateCompare - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateCompare - */ - 'input'?: { [key: string]: any; }; -} - -export const DateCompareOperatorV3 = { - Lt: 'LT', - Lte: 'LTE', - Gt: 'GT', - Gte: 'GTE' -} as const; - -export type DateCompareOperatorV3 = typeof DateCompareOperatorV3[keyof typeof DateCompareOperatorV3]; - -/** - * @type DateCompareFirstDate - * This is the first date to consider (The date that would be on the left hand side of the comparison operation). - * @export - */ -export type DateCompareFirstDate = AccountAttribute | DateFormat; - -/** - * @type DateCompareSecondDate - * This is the second date to consider (The date that would be on the right hand side of the comparison operation). - * @export - */ -export type DateCompareSecondDate = AccountAttribute | DateFormat; - -/** - * - * @export - * @interface DateFormat - */ -export interface DateFormat { - /** - * - * @type {DateFormatInputFormat} - * @memberof DateFormat - */ - 'inputFormat'?: DateFormatInputFormat; - /** - * - * @type {DateFormatOutputFormat} - * @memberof DateFormat - */ - 'outputFormat'?: DateFormatOutputFormat; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateFormat - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateFormat - */ - 'input'?: { [key: string]: any; }; -} -/** - * @type DateFormatInputFormat - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatInputFormat = NamedConstructs | string; - -/** - * @type DateFormatOutputFormat - * A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into. *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* - * @export - */ -export type DateFormatOutputFormat = NamedConstructs | string; - -/** - * - * @export - * @interface DateMath - */ -export interface DateMath { - /** - * A string value of the date and time components to operation on, along with the math operations to execute. - * @type {string} - * @memberof DateMath - */ - 'expression': string; - /** - * A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) - * @type {boolean} - * @memberof DateMath - */ - 'roundUp'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DateMath - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DateMath - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DecomposeDiacriticalMarks - */ -export interface DecomposeDiacriticalMarks { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof DecomposeDiacriticalMarks - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof DecomposeDiacriticalMarks - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface DeleteNonEmployeeRecordsInBulkRequest - */ -export interface DeleteNonEmployeeRecordsInBulkRequest { - /** - * List of non-employee ids. - * @type {Array} - * @memberof DeleteNonEmployeeRecordsInBulkRequest - */ - 'ids': Array; -} -/** - * - * @export - * @interface DeleteSource202Response - */ -export interface DeleteSource202Response { - /** - * Type of object being referenced. - * @type {string} - * @memberof DeleteSource202Response - */ - 'type'?: DeleteSource202ResponseTypeV3; - /** - * Task result ID. - * @type {string} - * @memberof DeleteSource202Response - */ - 'id'?: string; - /** - * Task result\'s human-readable display name (this should be null/empty). - * @type {string} - * @memberof DeleteSource202Response - */ - 'name'?: string; -} - -export const DeleteSource202ResponseTypeV3 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type DeleteSource202ResponseTypeV3 = typeof DeleteSource202ResponseTypeV3[keyof typeof DeleteSource202ResponseTypeV3]; - -/** - * - * @export - * @interface DependantAppConnections - */ -export interface DependantAppConnections { - /** - * Id of the connected Application - * @type {string} - * @memberof DependantAppConnections - */ - 'cloudAppId'?: string; - /** - * Description of the connected Application - * @type {string} - * @memberof DependantAppConnections - */ - 'description'?: string; - /** - * Is the Application enabled - * @type {boolean} - * @memberof DependantAppConnections - */ - 'enabled'?: boolean; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnections - */ - 'provisionRequestEnabled'?: boolean; - /** - * - * @type {DependantAppConnectionsAccountSource} - * @memberof DependantAppConnections - */ - 'accountSource'?: DependantAppConnectionsAccountSource; - /** - * The amount of launchers for connected Application (long type) - * @type {number} - * @memberof DependantAppConnections - */ - 'launcherCount'?: number; - /** - * Is Provisioning enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnections - */ - 'matchAllAccount'?: boolean; - /** - * The owner of the connected Application - * @type {Array} - * @memberof DependantAppConnections - */ - 'owner'?: Array; - /** - * Is App Center enabled for connected Application - * @type {boolean} - * @memberof DependantAppConnections - */ - 'appCenterEnabled'?: boolean; -} -/** - * The Account Source of the connected Application - * @export - * @interface DependantAppConnectionsAccountSource - */ -export interface DependantAppConnectionsAccountSource { - /** - * Use this Account Source for password management - * @type {boolean} - * @memberof DependantAppConnectionsAccountSource - */ - 'useForPasswordManagement'?: boolean; - /** - * A list of Password Policies for this Account Source - * @type {Array} - * @memberof DependantAppConnectionsAccountSource - */ - 'passwordPolicies'?: Array; -} -/** - * - * @export - * @interface DependantAppConnectionsAccountSourcePasswordPoliciesInner - */ -export interface DependantAppConnectionsAccountSourcePasswordPoliciesInner { - /** - * DTO type - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner - */ - 'type'?: string; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DependantAppConnectionsAccountSourcePasswordPoliciesInner - */ - 'name'?: string; -} -/** - * - * @export - * @interface DependantConnectionsMissingDto - */ -export interface DependantConnectionsMissingDto { - /** - * The type of dependency type that is missing in the SourceConnections - * @type {string} - * @memberof DependantConnectionsMissingDto - */ - 'dependencyType'?: DependantConnectionsMissingDtoDependencyTypeV3; - /** - * The reason why this dependency is missing - * @type {string} - * @memberof DependantConnectionsMissingDto - */ - 'reason'?: string; -} - -export const DependantConnectionsMissingDtoDependencyTypeV3 = { - IdentityProfiles: 'identityProfiles', - CredentialProfiles: 'credentialProfiles', - MappingProfiles: 'mappingProfiles', - SourceAttributes: 'sourceAttributes', - DependantCustomTransforms: 'dependantCustomTransforms', - DependantApps: 'dependantApps' -} as const; - -export type DependantConnectionsMissingDtoDependencyTypeV3 = typeof DependantConnectionsMissingDtoDependencyTypeV3[keyof typeof DependantConnectionsMissingDtoDependencyTypeV3]; - -/** - * - * @export - * @interface DimensionRef - */ -export interface DimensionRef { - /** - * The type of the object to which this reference applies - * @type {string} - * @memberof DimensionRef - */ - 'type'?: DimensionRefTypeV3; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof DimensionRef - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof DimensionRef - */ - 'name'?: string; -} - -export const DimensionRefTypeV3 = { - Dimension: 'DIMENSION' -} as const; - -export type DimensionRefTypeV3 = typeof DimensionRefTypeV3[keyof typeof DimensionRefTypeV3]; - -/** - * - * @export - * @interface DisplayReference - */ -export interface DisplayReference { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof DisplayReference - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof DisplayReference - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof DisplayReference - */ - 'displayName'?: string; -} -/** - * - * @export - * @interface DocumentFields - */ -export interface DocumentFields { - /** - * Name of the pod. - * @type {string} - * @memberof DocumentFields - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof DocumentFields - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof DocumentFields - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof DocumentFields - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof DocumentFields - */ - '_version'?: string; -} - - -/** - * Enum representing the currently supported document types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const DocumentType = { - Accessprofile: 'accessprofile', - Accountactivity: 'accountactivity', - Entitlement: 'entitlement', - Event: 'event', - Identity: 'identity', - Role: 'role' -} as const; - -export type DocumentType = typeof DocumentType[keyof typeof DocumentType]; - - -/** - * An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - * @export - * @enum {string} - */ - -export const DtoType = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG', - AccessProfile: 'ACCESS_PROFILE', - AccessRequestApproval: 'ACCESS_REQUEST_APPROVAL', - Account: 'ACCOUNT', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - CampaignFilter: 'CAMPAIGN_FILTER', - Certification: 'CERTIFICATION', - Cluster: 'CLUSTER', - ConnectorSchema: 'CONNECTOR_SCHEMA', - Entitlement: 'ENTITLEMENT', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityProfile: 'IDENTITY_PROFILE', - IdentityRequest: 'IDENTITY_REQUEST', - MachineIdentity: 'MACHINE_IDENTITY', - LifecycleState: 'LIFECYCLE_STATE', - PasswordPolicy: 'PASSWORD_POLICY', - Role: 'ROLE', - Rule: 'RULE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - TagCategory: 'TAG_CATEGORY', - TaskResult: 'TASK_RESULT', - ReportResult: 'REPORT_RESULT', - SodViolation: 'SOD_VIOLATION', - AccountActivity: 'ACCOUNT_ACTIVITY', - Workgroup: 'WORKGROUP' -} as const; - -export type DtoType = typeof DtoType[keyof typeof DtoType]; - - -/** - * - * @export - * @interface DuoVerificationRequest - */ -export interface DuoVerificationRequest { - /** - * User id for Verification request. - * @type {string} - * @memberof DuoVerificationRequest - */ - 'userId': string; - /** - * User id for Verification request. - * @type {string} - * @memberof DuoVerificationRequest - */ - 'signedResponse': string; -} -/** - * - * @export - * @interface E164phone - */ -export interface E164phone { - /** - * This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - * @type {string} - * @memberof E164phone - */ - 'defaultRegion'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof E164phone - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof E164phone - */ - 'input'?: { [key: string]: any; }; -} -/** - * This is used for representing email configuration for a lifecycle state - * @export - * @interface EmailNotificationOption - */ -export interface EmailNotificationOption { - /** - * If true, then the manager is notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOption - */ - 'notifyManagers'?: boolean; - /** - * If true, then all the admins are notified of the lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOption - */ - 'notifyAllAdmins'?: boolean; - /** - * If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. - * @type {boolean} - * @memberof EmailNotificationOption - */ - 'notifySpecificUsers'?: boolean; - /** - * List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. - * @type {Array} - * @memberof EmailNotificationOption - */ - 'emailAddressList'?: Array; -} -/** - * - * @export - * @interface Entitlement - */ -export interface Entitlement { - /** - * The entitlement id - * @type {string} - * @memberof Entitlement - */ - 'id'?: string; - /** - * The entitlement name - * @type {string} - * @memberof Entitlement - */ - 'name'?: string; - /** - * The entitlement attribute name - * @type {string} - * @memberof Entitlement - */ - 'attribute'?: string; - /** - * The value of the entitlement - * @type {string} - * @memberof Entitlement - */ - 'value'?: string; - /** - * The object type of the entitlement from the source schema - * @type {string} - * @memberof Entitlement - */ - 'sourceSchemaObjectType'?: string; - /** - * The description of the entitlement - * @type {string} - * @memberof Entitlement - */ - 'description'?: string | null; - /** - * True if the entitlement is privileged - * @type {boolean} - * @memberof Entitlement - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof Entitlement - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement is able to be directly requested - * @type {boolean} - * @memberof Entitlement - */ - 'requestable'?: boolean; - /** - * - * @type {EntitlementOwner} - * @memberof Entitlement - */ - 'owner'?: EntitlementOwner | null; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof Entitlement - */ - 'additionalOwners'?: Array | null; - /** - * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. - * @type {{ [key: string]: any; }} - * @memberof Entitlement - */ - 'manuallyUpdatedFields'?: { [key: string]: any; } | null; - /** - * - * @type {EntitlementAccessModelMetadata} - * @memberof Entitlement - */ - 'accessModelMetadata'?: EntitlementAccessModelMetadata; - /** - * Time when the entitlement was created - * @type {string} - * @memberof Entitlement - */ - 'created'?: string; - /** - * Time when the entitlement was last modified - * @type {string} - * @memberof Entitlement - */ - 'modified'?: string; - /** - * - * @type {EntitlementSource} - * @memberof Entitlement - */ - 'source'?: EntitlementSource; - /** - * A map of free-form key-value pairs from the source system - * @type {{ [key: string]: any; }} - * @memberof Entitlement - */ - 'attributes'?: { [key: string]: any; }; - /** - * List of IDs of segments, if any, to which this Entitlement is assigned. - * @type {Array} - * @memberof Entitlement - */ - 'segments'?: Array | null; - /** - * - * @type {Array} - * @memberof Entitlement - */ - 'directPermissions'?: Array; -} -/** - * Additional data to classify the entitlement - * @export - * @interface EntitlementAccessModelMetadata - */ -export interface EntitlementAccessModelMetadata { - /** - * - * @type {Array} - * @memberof EntitlementAccessModelMetadata - */ - 'attributes'?: Array; -} -/** - * Entitlement - * @export - * @interface EntitlementDocument - */ -export interface EntitlementDocument { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocument - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocument - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocument - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocument - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocument - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSource} - * @memberof EntitlementDocument - */ - 'source'?: EntitlementDocumentAllOfSource; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocument - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocument - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocument - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocument - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocument - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocument - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocument - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocument - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocument - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocument - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocument - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocument - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocument - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocument - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocument - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFields} - * @memberof EntitlementDocument - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFields | null; - /** - * - * @type {Array} - * @memberof EntitlementDocument - */ - 'permissions'?: Array; -} -/** - * Indicates whether the entitlement\'s display name and/or description have been manually updated. - * @export - * @interface EntitlementDocumentAllOfManuallyUpdatedFields - */ -export interface EntitlementDocumentAllOfManuallyUpdatedFields { - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFields - */ - 'DESCRIPTION'?: boolean; - /** - * - * @type {boolean} - * @memberof EntitlementDocumentAllOfManuallyUpdatedFields - */ - 'DISPLAY_NAME'?: boolean; -} -/** - * - * @export - * @interface EntitlementDocumentAllOfPermissions - */ -export interface EntitlementDocumentAllOfPermissions { - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof EntitlementDocumentAllOfPermissions - */ - 'target'?: string; - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof EntitlementDocumentAllOfPermissions - */ - 'rights'?: Array; -} -/** - * Entitlement\'s source. - * @export - * @interface EntitlementDocumentAllOfSource - */ -export interface EntitlementDocumentAllOfSource { - /** - * ID of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSource - */ - 'id'?: string; - /** - * Display name of entitlement\'s source. - * @type {string} - * @memberof EntitlementDocumentAllOfSource - */ - 'name'?: string; - /** - * Type of object. - * @type {string} - * @memberof EntitlementDocumentAllOfSource - */ - 'type'?: string; -} -/** - * - * @export - * @interface EntitlementDocuments - */ -export interface EntitlementDocuments { - /** - * ID of the referenced object. - * @type {string} - * @memberof EntitlementDocuments - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementDocuments - */ - 'name': string; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof EntitlementDocuments - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EntitlementDocuments - */ - 'synced'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementDocuments - */ - 'displayName'?: string; - /** - * - * @type {EntitlementDocumentAllOfSource} - * @memberof EntitlementDocuments - */ - 'source'?: EntitlementDocumentAllOfSource; - /** - * Segments with the entitlement. - * @type {Array} - * @memberof EntitlementDocuments - */ - 'segments'?: Array; - /** - * Number of segments with the role. - * @type {number} - * @memberof EntitlementDocuments - */ - 'segmentCount'?: number; - /** - * Indicates whether the entitlement is requestable. - * @type {boolean} - * @memberof EntitlementDocuments - */ - 'requestable'?: boolean; - /** - * Indicates whether the entitlement is cloud governed. - * @type {boolean} - * @memberof EntitlementDocuments - */ - 'cloudGoverned'?: boolean; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EntitlementDocuments - */ - 'created'?: string | null; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof EntitlementDocuments - */ - 'privileged'?: boolean; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof EntitlementDocuments - */ - 'tags'?: Array; - /** - * Attribute information for the entitlement. - * @type {string} - * @memberof EntitlementDocuments - */ - 'attribute'?: string; - /** - * Value of the entitlement. - * @type {string} - * @memberof EntitlementDocuments - */ - 'value'?: string; - /** - * Source schema object type of the entitlement. - * @type {string} - * @memberof EntitlementDocuments - */ - 'sourceSchemaObjectType'?: string; - /** - * Schema type of the entitlement. - * @type {string} - * @memberof EntitlementDocuments - */ - 'schema'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof EntitlementDocuments - */ - 'hash'?: string; - /** - * Attributes of the entitlement. - * @type {{ [key: string]: any; }} - * @memberof EntitlementDocuments - */ - 'attributes'?: { [key: string]: any; }; - /** - * Truncated attributes of the entitlement. - * @type {Array} - * @memberof EntitlementDocuments - */ - 'truncatedAttributes'?: Array; - /** - * Indicates whether the entitlement contains data access. - * @type {boolean} - * @memberof EntitlementDocuments - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {EntitlementDocumentAllOfManuallyUpdatedFields} - * @memberof EntitlementDocuments - */ - 'manuallyUpdatedFields'?: EntitlementDocumentAllOfManuallyUpdatedFields | null; - /** - * - * @type {Array} - * @memberof EntitlementDocuments - */ - 'permissions'?: Array; - /** - * Name of the pod. - * @type {string} - * @memberof EntitlementDocuments - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof EntitlementDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof EntitlementDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof EntitlementDocuments - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof EntitlementDocuments - */ - '_version'?: string; -} - - -/** - * The identity that owns the entitlement - * @export - * @interface EntitlementOwner - */ -export interface EntitlementOwner { - /** - * The identity ID - * @type {string} - * @memberof EntitlementOwner - */ - 'id'?: string; - /** - * The type of object - * @type {string} - * @memberof EntitlementOwner - */ - 'type'?: EntitlementOwnerTypeV3; - /** - * The display name of the identity - * @type {string} - * @memberof EntitlementOwner - */ - 'name'?: string; -} - -export const EntitlementOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type EntitlementOwnerTypeV3 = typeof EntitlementOwnerTypeV3[keyof typeof EntitlementOwnerTypeV3]; - -/** - * Entitlement including a specific set of access. - * @export - * @interface EntitlementRef - */ -export interface EntitlementRef { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof EntitlementRef - */ - 'type'?: EntitlementRefTypeV3; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof EntitlementRef - */ - 'id'?: string; - /** - * Entitlement\'s display name. - * @type {string} - * @memberof EntitlementRef - */ - 'name'?: string | null; -} - -export const EntitlementRefTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type EntitlementRefTypeV3 = typeof EntitlementRefTypeV3[keyof typeof EntitlementRefTypeV3]; - -/** - * - * @export - * @interface EntitlementRequestConfig - */ -export interface EntitlementRequestConfig { - /** - * If this is true, entitlement requests are allowed. - * @type {boolean} - * @memberof EntitlementRequestConfig - */ - 'allowEntitlementRequest'?: boolean; - /** - * If this is true, comments are required to submit entitlement requests. - * @type {boolean} - * @memberof EntitlementRequestConfig - */ - 'requestCommentsRequired'?: boolean; - /** - * If this is true, comments are required to reject entitlement requests. - * @type {boolean} - * @memberof EntitlementRequestConfig - */ - 'deniedCommentsRequired'?: boolean; - /** - * Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). - * @type {string} - * @memberof EntitlementRequestConfig - */ - 'grantRequestApprovalSchemes'?: string | null; -} -/** - * - * @export - * @interface EntitlementSource - */ -export interface EntitlementSource { - /** - * The source ID - * @type {string} - * @memberof EntitlementSource - */ - 'id'?: string; - /** - * The source type, will always be \"SOURCE\" - * @type {string} - * @memberof EntitlementSource - */ - 'type'?: string; - /** - * The source name - * @type {string} - * @memberof EntitlementSource - */ - 'name'?: string; -} -/** - * EntitlementReference - * @export - * @interface EntitlementSummary - */ -export interface EntitlementSummary { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof EntitlementSummary - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof EntitlementSummary - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummary - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof EntitlementSummary - */ - 'description'?: string | null; - /** - * - * @type {Reference1} - * @memberof EntitlementSummary - */ - 'source'?: Reference1; - /** - * Type of the access item. - * @type {string} - * @memberof EntitlementSummary - */ - 'type'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummary - */ - 'privileged'?: boolean; - /** - * - * @type {string} - * @memberof EntitlementSummary - */ - 'attribute'?: string; - /** - * - * @type {string} - * @memberof EntitlementSummary - */ - 'value'?: string; - /** - * - * @type {boolean} - * @memberof EntitlementSummary - */ - 'standalone'?: boolean; -} -/** - * - * @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; -} -/** - * Event - * @export - * @interface Event - */ -export interface Event { - /** - * ID of the entitlement. - * @type {string} - * @memberof Event - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof Event - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof Event - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof Event - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof Event - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof Event - */ - 'type'?: string; - /** - * - * @type {EventActor} - * @memberof Event - */ - 'actor'?: EventActor; - /** - * - * @type {EventTarget} - * @memberof Event - */ - 'target'?: EventTarget; - /** - * The event\'s stack. - * @type {string} - * @memberof Event - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof Event - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof Event - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof Event - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof Event - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof Event - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof Event - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof Event - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof Event - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface EventActor - */ -export interface EventActor { - /** - * Name of the actor that generated the event. - * @type {string} - * @memberof EventActor - */ - 'name'?: string; -} -/** - * Attributes related to an IdentityNow ETS event - * @export - * @interface EventAttributes - */ -export interface EventAttributes { - /** - * The unique ID of the trigger - * @type {string} - * @memberof EventAttributes - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof EventAttributes - */ - 'filter.$'?: string | null; - /** - * Description of the event trigger - * @type {string} - * @memberof EventAttributes - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof EventAttributes - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof EventAttributes - */ - 'formDefinitionId'?: string | null; -} -/** - * Event - * @export - * @interface EventDocument - */ -export interface EventDocument { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocument - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocument - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocument - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocument - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocument - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocument - */ - 'type'?: string; - /** - * - * @type {EventActor} - * @memberof EventDocument - */ - 'actor'?: EventActor; - /** - * - * @type {EventTarget} - * @memberof EventDocument - */ - 'target'?: EventTarget; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocument - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocument - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocument - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocument - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocument - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocument - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocument - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocument - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocument - */ - 'technicalName'?: string; -} -/** - * - * @export - * @interface EventDocuments - */ -export interface EventDocuments { - /** - * ID of the entitlement. - * @type {string} - * @memberof EventDocuments - */ - 'id'?: string; - /** - * Name of the entitlement. - * @type {string} - * @memberof EventDocuments - */ - 'name'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof EventDocuments - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof EventDocuments - */ - 'synced'?: string; - /** - * Name of the event as it\'s displayed in audit reports. - * @type {string} - * @memberof EventDocuments - */ - 'action'?: string; - /** - * Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. - * @type {string} - * @memberof EventDocuments - */ - 'type'?: string; - /** - * - * @type {EventActor} - * @memberof EventDocuments - */ - 'actor'?: EventActor; - /** - * - * @type {EventTarget} - * @memberof EventDocuments - */ - 'target'?: EventTarget; - /** - * The event\'s stack. - * @type {string} - * @memberof EventDocuments - */ - 'stack'?: string; - /** - * ID of the group of events. - * @type {string} - * @memberof EventDocuments - */ - 'trackingNumber'?: string; - /** - * Target system\'s IP address. - * @type {string} - * @memberof EventDocuments - */ - 'ipAddress'?: string; - /** - * ID of event\'s details. - * @type {string} - * @memberof EventDocuments - */ - 'details'?: string; - /** - * Attributes involved in the event. - * @type {{ [key: string]: any; }} - * @memberof EventDocuments - */ - 'attributes'?: { [key: string]: any; }; - /** - * Objects the event is happening to. - * @type {Array} - * @memberof EventDocuments - */ - 'objects'?: Array; - /** - * Operation, or action, performed during the event. - * @type {string} - * @memberof EventDocuments - */ - 'operation'?: string; - /** - * Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. - * @type {string} - * @memberof EventDocuments - */ - 'status'?: string; - /** - * Event\'s normalized name. This normalized name always follows the pattern of \'objects_operation_status\'. - * @type {string} - * @memberof EventDocuments - */ - 'technicalName'?: string; - /** - * - * @type {string} - * @memberof EventDocuments - */ - 'pod'?: string; - /** - * - * @type {string} - * @memberof EventDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof EventDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {string} - * @memberof EventDocuments - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface EventTarget - */ -export interface EventTarget { - /** - * Name of the target, or recipient, of the event. - * @type {string} - * @memberof EventTarget - */ - 'name'?: string; -} -/** - * - * @export - * @interface ExceptionAccessCriteria - */ -export interface ExceptionAccessCriteria { - /** - * - * @type {ExceptionCriteria} - * @memberof ExceptionAccessCriteria - */ - 'leftCriteria'?: ExceptionCriteria; - /** - * - * @type {ExceptionCriteria} - * @memberof ExceptionAccessCriteria - */ - 'rightCriteria'?: ExceptionCriteria; -} -/** - * - * @export - * @interface ExceptionCriteria - */ -export interface ExceptionCriteria { - /** - * List of exception criteria. There is a min of 1 and max of 50 items in the list. - * @type {Array} - * @memberof ExceptionCriteria - */ - 'criteriaList'?: Array; -} -/** - * Access reference with addition of boolean existing flag to indicate whether the access was extant - * @export - * @interface ExceptionCriteriaAccess - */ -export interface ExceptionCriteriaAccess { - /** - * - * @type {DtoType} - * @memberof ExceptionCriteriaAccess - */ - 'type'?: DtoType; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccess - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaAccess - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaAccess - */ - 'existing'?: boolean; -} - - -/** - * The types of objects supported for SOD violations - * @export - * @interface ExceptionCriteriaCriteriaListInner - */ -export interface ExceptionCriteriaCriteriaListInner { - /** - * The type of object that is referenced - * @type {object} - * @memberof ExceptionCriteriaCriteriaListInner - */ - 'type'?: ExceptionCriteriaCriteriaListInnerTypeV3; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInner - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof ExceptionCriteriaCriteriaListInner - */ - 'name'?: string; - /** - * Whether the subject identity already had that access or not - * @type {boolean} - * @memberof ExceptionCriteriaCriteriaListInner - */ - 'existing'?: boolean; -} - -export const ExceptionCriteriaCriteriaListInnerTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ExceptionCriteriaCriteriaListInnerTypeV3 = typeof ExceptionCriteriaCriteriaListInnerTypeV3[keyof typeof ExceptionCriteriaCriteriaListInnerTypeV3]; - -/** - * The current state of execution. - * @export - * @enum {string} - */ - -export const ExecutionStatus = { - Executing: 'EXECUTING', - Verifying: 'VERIFYING', - Terminated: 'TERMINATED', - Completed: 'COMPLETED' -} as const; - -export type ExecutionStatus = typeof ExecutionStatus[keyof typeof ExecutionStatus]; - - -/** - * - * @export - * @interface ExpansionItem - */ -export interface ExpansionItem { - /** - * The ID of the account - * @type {string} - * @memberof ExpansionItem - */ - 'accountId'?: string; - /** - * Cause of the expansion item. - * @type {string} - * @memberof ExpansionItem - */ - 'cause'?: string; - /** - * The name of the item - * @type {string} - * @memberof ExpansionItem - */ - 'name'?: string; - /** - * - * @type {AttributeRequest} - * @memberof ExpansionItem - */ - 'attributeRequest'?: AttributeRequest; - /** - * - * @type {AccountSource} - * @memberof ExpansionItem - */ - 'source'?: AccountSource; - /** - * ID of the expansion item - * @type {string} - * @memberof ExpansionItem - */ - 'id'?: string; - /** - * State of the expansion item - * @type {string} - * @memberof ExpansionItem - */ - 'state'?: string; -} -/** - * - * @export - * @interface Expression - */ -export interface Expression { - /** - * Operator for the expression - * @type {string} - * @memberof Expression - */ - 'operator'?: ExpressionOperatorV3; - /** - * Name for the attribute - * @type {string} - * @memberof Expression - */ - 'attribute'?: string | null; - /** - * - * @type {Value} - * @memberof Expression - */ - 'value'?: Value | null; - /** - * List of expressions - * @type {Array} - * @memberof Expression - */ - 'children'?: Array | null; -} - -export const ExpressionOperatorV3 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionOperatorV3 = typeof ExpressionOperatorV3[keyof typeof ExpressionOperatorV3]; - -/** - * - * @export - * @interface ExpressionChildrenInner - */ -export interface ExpressionChildrenInner { - /** - * Operator for the expression - * @type {string} - * @memberof ExpressionChildrenInner - */ - 'operator'?: ExpressionChildrenInnerOperatorV3; - /** - * Name for the attribute - * @type {string} - * @memberof ExpressionChildrenInner - */ - 'attribute'?: string | null; - /** - * - * @type {Value} - * @memberof ExpressionChildrenInner - */ - 'value'?: Value | null; - /** - * There cannot be anymore nested children. This will always be null. - * @type {string} - * @memberof ExpressionChildrenInner - */ - 'children'?: string | null; -} - -export const ExpressionChildrenInnerOperatorV3 = { - And: 'AND', - Equals: 'EQUALS' -} as const; - -export type ExpressionChildrenInnerOperatorV3 = typeof ExpressionChildrenInnerOperatorV3[keyof typeof ExpressionChildrenInnerOperatorV3]; - -/** - * Attributes related to an external trigger - * @export - * @interface ExternalAttributes - */ -export interface ExternalAttributes { - /** - * A unique name for the external trigger - * @type {string} - * @memberof ExternalAttributes - */ - 'name'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof ExternalAttributes - */ - 'description'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof ExternalAttributes - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof ExternalAttributes - */ - 'url'?: string | null; -} -/** - * - * @export - * @interface FederationProtocolDetails - */ -export interface FederationProtocolDetails { - /** - * Federation protocol role - * @type {string} - * @memberof FederationProtocolDetails - */ - 'role'?: FederationProtocolDetailsRoleV3; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof FederationProtocolDetails - */ - 'entityId'?: string; -} - -export const FederationProtocolDetailsRoleV3 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type FederationProtocolDetailsRoleV3 = typeof FederationProtocolDetailsRoleV3[keyof typeof FederationProtocolDetailsRoleV3]; - -/** - * - * @export - * @interface FieldDetailsDto - */ -export interface FieldDetailsDto { - /** - * The name of the attribute. - * @type {string} - * @memberof FieldDetailsDto - */ - 'name'?: string; - /** - * The transform to apply to the field - * @type {object} - * @memberof FieldDetailsDto - */ - 'transform'?: object; - /** - * Attributes required for the transform - * @type {object} - * @memberof FieldDetailsDto - */ - 'attributes'?: object; - /** - * Flag indicating whether or not the attribute is required. - * @type {boolean} - * @memberof FieldDetailsDto - */ - 'isRequired'?: boolean; - /** - * The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. - * @type {string} - * @memberof FieldDetailsDto - */ - 'type'?: FieldDetailsDtoTypeV3; - /** - * Flag indicating whether or not the attribute is multi-valued. - * @type {boolean} - * @memberof FieldDetailsDto - */ - 'isMultiValued'?: boolean; -} - -export const FieldDetailsDtoTypeV3 = { - String: 'string', - Int: 'int', - Long: 'long', - Date: 'date', - Boolean: 'boolean', - Secret: 'secret' -} as const; - -export type FieldDetailsDtoTypeV3 = typeof FieldDetailsDtoTypeV3[keyof typeof FieldDetailsDtoTypeV3]; - -/** - * - * @export - * @interface Filter - */ -export interface Filter { - /** - * - * @type {FilterType} - * @memberof Filter - */ - 'type'?: FilterType; - /** - * - * @type {Range} - * @memberof Filter - */ - 'range'?: Range; - /** - * The terms to be filtered. - * @type {Array} - * @memberof Filter - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof Filter - */ - 'exclude'?: boolean; -} - - -/** - * An additional filter to constrain the results of the search query. - * @export - * @interface FilterAggregation - */ -export interface FilterAggregation { - /** - * The name of the filter aggregate to be included in the result. - * @type {string} - * @memberof FilterAggregation - */ - 'name': string; - /** - * - * @type {SearchFilterType} - * @memberof FilterAggregation - */ - 'type'?: SearchFilterType; - /** - * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof FilterAggregation - */ - 'field': string; - /** - * The value to filter on. - * @type {string} - * @memberof FilterAggregation - */ - 'value': string; -} - - -/** - * Enum representing the currently supported filter types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const FilterType = { - Exists: 'EXISTS', - Range: 'RANGE', - Terms: 'TERMS' -} as const; - -export type FilterType = typeof FilterType[keyof typeof FilterType]; - - -/** - * - * @export - * @interface FirstValid - */ -export interface FirstValid { - /** - * An array of attributes to evaluate for existence. - * @type {Array} - * @memberof FirstValid - */ - 'values': Array; - /** - * a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. - * @type {boolean} - * @memberof FirstValid - */ - 'ignoreErrors'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof FirstValid - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface FormDetails - */ -export interface FormDetails { - /** - * ID of the form - * @type {string} - * @memberof FormDetails - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof FormDetails - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof FormDetails - */ - 'title'?: string; - /** - * The form subtitle. - * @type {string} - * @memberof FormDetails - */ - 'subtitle'?: string; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof FormDetails - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof FormDetails - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface FormItemDetails - */ -export interface FormItemDetails { - /** - * Name of the FormItem - * @type {string} - * @memberof FormItemDetails - */ - 'name'?: string; -} -/** - * - * @export - * @interface ForwardApprovalDto - */ -export interface ForwardApprovalDto { - /** - * The Id of the new owner - * @type {string} - * @memberof ForwardApprovalDto - */ - 'newOwnerId': string; - /** - * The comment provided by the forwarder - * @type {string} - * @memberof ForwardApprovalDto - */ - 'comment': string; -} -/** - * Discovered applications with their respective associated sources - * @export - * @interface FullDiscoveredApplications - */ -export interface FullDiscoveredApplications { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof FullDiscoveredApplications - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'status'?: string; - /** - * List of associated sources related to this discovered application. - * @type {Array} - * @memberof FullDiscoveredApplications - */ - 'associatedSources'?: Array; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof FullDiscoveredApplications - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof FullDiscoveredApplications - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof FullDiscoveredApplications - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof FullDiscoveredApplications - */ - 'riskLevel'?: FullDiscoveredApplicationsRiskLevelV3; -} - -export const FullDiscoveredApplicationsRiskLevelV3 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type FullDiscoveredApplicationsRiskLevelV3 = typeof FullDiscoveredApplicationsRiskLevelV3[keyof typeof FullDiscoveredApplicationsRiskLevelV3]; - -/** - * - * @export - * @interface GenerateRandomString - */ -export interface GenerateRandomString { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GenerateRandomString - */ - 'name': string; - /** - * The operation to perform `generateRandomString` - * @type {string} - * @memberof GenerateRandomString - */ - 'operation': string; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include numbers - * @type {boolean} - * @memberof GenerateRandomString - */ - 'includeNumbers': boolean; - /** - * This must be either \"true\" or \"false\" to indicate whether the generator logic should include special characters - * @type {boolean} - * @memberof GenerateRandomString - */ - 'includeSpecialChars': boolean; - /** - * This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters - * @type {string} - * @memberof GenerateRandomString - */ - 'length': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GenerateRandomString - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface GetActiveCampaigns200ResponseInner - */ -export interface GetActiveCampaigns200ResponseInner { - /** - * Id of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'type': GetActiveCampaigns200ResponseInnerTypeV3; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'status'?: GetActiveCampaigns200ResponseInnerStatusV3; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'correlatedStatus'?: GetActiveCampaigns200ResponseInnerCorrelatedStatusV3; - /** - * Created time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'modified'?: string; - /** - * - * @type {CampaignAllOfFilter} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'filter'?: CampaignAllOfFilter; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfo} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfo; - /** - * - * @type {CampaignAllOfSearchCampaignInfo} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfo; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfo} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfo; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfo} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfo; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetActiveCampaigns200ResponseInner - */ - 'mandatoryCommentRequirement'?: GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3; -} - -export const GetActiveCampaigns200ResponseInnerTypeV3 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetActiveCampaigns200ResponseInnerTypeV3 = typeof GetActiveCampaigns200ResponseInnerTypeV3[keyof typeof GetActiveCampaigns200ResponseInnerTypeV3]; -export const GetActiveCampaigns200ResponseInnerStatusV3 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetActiveCampaigns200ResponseInnerStatusV3 = typeof GetActiveCampaigns200ResponseInnerStatusV3[keyof typeof GetActiveCampaigns200ResponseInnerStatusV3]; -export const GetActiveCampaigns200ResponseInnerCorrelatedStatusV3 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetActiveCampaigns200ResponseInnerCorrelatedStatusV3 = typeof GetActiveCampaigns200ResponseInnerCorrelatedStatusV3[keyof typeof GetActiveCampaigns200ResponseInnerCorrelatedStatusV3]; -export const GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3 = typeof GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3[keyof typeof GetActiveCampaigns200ResponseInnerMandatoryCommentRequirementV3]; - -/** - * - * @export - * @interface GetCampaign200Response - */ -export interface GetCampaign200Response { - /** - * Id of the campaign - * @type {string} - * @memberof GetCampaign200Response - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200Response - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof GetCampaign200Response - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof GetCampaign200Response - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof GetCampaign200Response - */ - 'type': GetCampaign200ResponseTypeV3; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof GetCampaign200Response - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof GetCampaign200Response - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof GetCampaign200Response - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof GetCampaign200Response - */ - 'status'?: GetCampaign200ResponseStatusV3; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof GetCampaign200Response - */ - 'correlatedStatus'?: GetCampaign200ResponseCorrelatedStatusV3; - /** - * Created time of the campaign - * @type {string} - * @memberof GetCampaign200Response - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof GetCampaign200Response - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof GetCampaign200Response - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof GetCampaign200Response - */ - 'alerts'?: Array; - /** - * Modified time of the campaign - * @type {string} - * @memberof GetCampaign200Response - */ - 'modified'?: string; - /** - * - * @type {CampaignAllOfFilter} - * @memberof GetCampaign200Response - */ - 'filter'?: CampaignAllOfFilter; - /** - * Determines if comments on sunset date changes are required. - * @type {boolean} - * @memberof GetCampaign200Response - */ - 'sunsetCommentsRequired'?: boolean; - /** - * - * @type {CampaignAllOfSourceOwnerCampaignInfo} - * @memberof GetCampaign200Response - */ - 'sourceOwnerCampaignInfo'?: CampaignAllOfSourceOwnerCampaignInfo; - /** - * - * @type {CampaignAllOfSearchCampaignInfo} - * @memberof GetCampaign200Response - */ - 'searchCampaignInfo'?: CampaignAllOfSearchCampaignInfo; - /** - * - * @type {CampaignAllOfRoleCompositionCampaignInfo} - * @memberof GetCampaign200Response - */ - 'roleCompositionCampaignInfo'?: CampaignAllOfRoleCompositionCampaignInfo; - /** - * - * @type {CampaignAllOfMachineAccountCampaignInfo} - * @memberof GetCampaign200Response - */ - 'machineAccountCampaignInfo'?: CampaignAllOfMachineAccountCampaignInfo; - /** - * A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). - * @type {Array} - * @memberof GetCampaign200Response - */ - 'sourcesWithOrphanEntitlements'?: Array; - /** - * Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - * @type {string} - * @memberof GetCampaign200Response - */ - 'mandatoryCommentRequirement'?: GetCampaign200ResponseMandatoryCommentRequirementV3; -} - -export const GetCampaign200ResponseTypeV3 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type GetCampaign200ResponseTypeV3 = typeof GetCampaign200ResponseTypeV3[keyof typeof GetCampaign200ResponseTypeV3]; -export const GetCampaign200ResponseStatusV3 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type GetCampaign200ResponseStatusV3 = typeof GetCampaign200ResponseStatusV3[keyof typeof GetCampaign200ResponseStatusV3]; -export const GetCampaign200ResponseCorrelatedStatusV3 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type GetCampaign200ResponseCorrelatedStatusV3 = typeof GetCampaign200ResponseCorrelatedStatusV3[keyof typeof GetCampaign200ResponseCorrelatedStatusV3]; -export const GetCampaign200ResponseMandatoryCommentRequirementV3 = { - AllDecisions: 'ALL_DECISIONS', - RevokeOnlyDecisions: 'REVOKE_ONLY_DECISIONS', - NoDecisions: 'NO_DECISIONS' -} as const; - -export type GetCampaign200ResponseMandatoryCommentRequirementV3 = typeof GetCampaign200ResponseMandatoryCommentRequirementV3[keyof typeof GetCampaign200ResponseMandatoryCommentRequirementV3]; - -/** - * @type GetDiscoveredApplications200ResponseInner - * @export - */ -export type GetDiscoveredApplications200ResponseInner = FullDiscoveredApplications | SlimDiscoveredApplications; - -/** - * - * @export - * @interface GetOAuthClientResponse - */ -export interface GetOAuthClientResponse { - /** - * ID of the OAuth client - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'id': string; - /** - * The name of the business the API Client should belong to - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'businessName': string | null; - /** - * The homepage URL associated with the owner of the API Client - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'homepageUrl': string | null; - /** - * A human-readable name for the API Client - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'name': string; - /** - * A description of the API Client - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'description': string | null; - /** - * The number of seconds an access token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponse - */ - 'accessTokenValiditySeconds': number; - /** - * The number of seconds a refresh token generated for this API Client is valid for - * @type {number} - * @memberof GetOAuthClientResponse - */ - 'refreshTokenValiditySeconds': number; - /** - * A list of the approved redirect URIs used with the authorization_code flow - * @type {Array} - * @memberof GetOAuthClientResponse - */ - 'redirectUris': Array | null; - /** - * A list of OAuth 2.0 grant types this API Client can be used with - * @type {Array} - * @memberof GetOAuthClientResponse - */ - 'grantTypes': Array; - /** - * - * @type {AccessType} - * @memberof GetOAuthClientResponse - */ - 'accessType': AccessType; - /** - * - * @type {ClientType} - * @memberof GetOAuthClientResponse - */ - 'type': ClientType; - /** - * An indicator of whether the API Client can be used for requests internal to IDN - * @type {boolean} - * @memberof GetOAuthClientResponse - */ - 'internal': boolean; - /** - * An indicator of whether the API Client is enabled for use - * @type {boolean} - * @memberof GetOAuthClientResponse - */ - 'enabled': boolean; - /** - * An indicator of whether the API Client supports strong authentication - * @type {boolean} - * @memberof GetOAuthClientResponse - */ - 'strongAuthSupported': boolean; - /** - * An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - * @type {boolean} - * @memberof GetOAuthClientResponse - */ - 'claimsSupported': boolean; - /** - * The date and time, down to the millisecond, when the API Client was created - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'created': string; - /** - * The date and time, down to the millisecond, when the API Client was last updated - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'modified': string; - /** - * - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'secret'?: string | null; - /** - * - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'metadata'?: string | null; - /** - * The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - * @type {string} - * @memberof GetOAuthClientResponse - */ - 'lastUsed'?: string | null; - /** - * Scopes of the API Client. - * @type {Array} - * @memberof GetOAuthClientResponse - */ - 'scope': Array | null; -} - - -/** - * - * @export - * @interface GetPersonalAccessTokenResponse - */ -export interface GetPersonalAccessTokenResponse { - /** - * The ID of the personal access token (to be used as the username for Basic Auth). - * @type {string} - * @memberof GetPersonalAccessTokenResponse - */ - 'id': string; - /** - * The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - * @type {string} - * @memberof GetPersonalAccessTokenResponse - */ - 'name': string; - /** - * Scopes of the personal access token. - * @type {Array} - * @memberof GetPersonalAccessTokenResponse - */ - 'scope': Array | null; - /** - * - * @type {PatOwner} - * @memberof GetPersonalAccessTokenResponse - */ - 'owner': PatOwner; - /** - * The date and time, down to the millisecond, when this personal access token was created. - * @type {string} - * @memberof GetPersonalAccessTokenResponse - */ - 'created': string; - /** - * The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - * @type {string} - * @memberof GetPersonalAccessTokenResponse - */ - 'lastUsed'?: string | null; - /** - * If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - * @type {boolean} - * @memberof GetPersonalAccessTokenResponse - */ - 'managed'?: boolean; - /** - * Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - * @type {number} - * @memberof GetPersonalAccessTokenResponse - */ - 'accessTokenValiditySeconds'?: number; - /** - * Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. - * @type {string} - * @memberof GetPersonalAccessTokenResponse - */ - 'expirationDate'?: string; -} -/** - * - * @export - * @interface GetReferenceIdentityAttribute - */ -export interface GetReferenceIdentityAttribute { - /** - * This must always be set to \"Cloud Services Deployment Utility\" - * @type {string} - * @memberof GetReferenceIdentityAttribute - */ - 'name': string; - /** - * The operation to perform `getReferenceIdentityAttribute` - * @type {string} - * @memberof GetReferenceIdentityAttribute - */ - 'operation': string; - /** - * This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user\'s manager and then get that manager\'s identity attribute. - * @type {string} - * @memberof GetReferenceIdentityAttribute - */ - 'uid': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof GetReferenceIdentityAttribute - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * OAuth2 Grant Type - * @export - * @enum {string} - */ - -export const GrantType = { - ClientCredentials: 'CLIENT_CREDENTIALS', - AuthorizationCode: 'AUTHORIZATION_CODE', - RefreshToken: 'REFRESH_TOKEN' -} as const; - -export type GrantType = typeof GrantType[keyof typeof GrantType]; - - -/** - * - * @export - * @interface ISO3166 - */ -export interface ISO3166 { - /** - * An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., \"US\"); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., \"USA\") `numeric` - The numeric country code (e.g., \"840\") - * @type {string} - * @memberof ISO3166 - */ - 'format'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ISO3166 - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ISO3166 - */ - 'input'?: { [key: string]: any; }; -} -/** - * Arguments for Identities Details report (IDENTITIES_DETAILS) - * @export - * @interface IdentitiesDetailsReportArguments - */ -export interface IdentitiesDetailsReportArguments { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesDetailsReportArguments - */ - 'correlatedOnly': boolean; -} -/** - * Arguments for Identities report (IDENTITIES) - * @export - * @interface IdentitiesReportArguments - */ -export interface IdentitiesReportArguments { - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof IdentitiesReportArguments - */ - 'correlatedOnly'?: boolean; -} -/** - * @type IdentityAccess - * @export - */ -export type IdentityAccess = { type: 'ACCESS_PROFILE' } & AccessProfileSummary | { type: 'ENTITLEMENT' } & AccessProfileEntitlement | { type: 'ROLE' } & AccessProfileRole; - -/** - * - * @export - * @interface IdentityAttribute - */ -export interface IdentityAttribute { - /** - * The system (camel-cased) name of the identity attribute to bring in - * @type {string} - * @memberof IdentityAttribute - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IdentityAttribute - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IdentityAttribute - */ - 'input'?: { [key: string]: any; }; -} -/** - * Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. - * @export - * @interface IdentityAttributeConfig - */ -export interface IdentityAttributeConfig { - /** - * Backend will only promote values if the profile/mapping is enabled. - * @type {boolean} - * @memberof IdentityAttributeConfig - */ - 'enabled'?: boolean; - /** - * - * @type {Array} - * @memberof IdentityAttributeConfig - */ - 'attributeTransforms'?: Array; -} -/** - * - * @export - * @interface IdentityAttributePreview - */ -export interface IdentityAttributePreview { - /** - * Name of the attribute that is being previewed. - * @type {string} - * @memberof IdentityAttributePreview - */ - 'name'?: string; - /** - * Value that was derived during the preview. - * @type {string} - * @memberof IdentityAttributePreview - */ - 'value'?: string; - /** - * The value of the attribute before the preview. - * @type {string} - * @memberof IdentityAttributePreview - */ - 'previousValue'?: string; - /** - * - * @type {Array} - * @memberof IdentityAttributePreview - */ - 'errorMessages'?: Array; -} -/** - * Transform definition for an identity attribute. - * @export - * @interface IdentityAttributeTransform - */ -export interface IdentityAttributeTransform { - /** - * Identity attribute\'s name. - * @type {string} - * @memberof IdentityAttributeTransform - */ - 'identityAttributeName'?: string; - /** - * - * @type {TransformDefinition} - * @memberof IdentityAttributeTransform - */ - 'transformDefinition'?: TransformDefinition; -} -/** - * - * @export - * @interface IdentityCertDecisionSummary - */ -export interface IdentityCertDecisionSummary { - /** - * Number of entitlement decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'entitlementDecisionsMade'?: number; - /** - * Number of access profile decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accessProfileDecisionsMade'?: number; - /** - * Number of role decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'roleDecisionsMade'?: number; - /** - * Number of account decisions that have been made - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accountDecisionsMade'?: number; - /** - * The total number of entitlement decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'entitlementDecisionsTotal'?: number; - /** - * The total number of access profile decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accessProfileDecisionsTotal'?: number; - /** - * The total number of role decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'roleDecisionsTotal'?: number; - /** - * The total number of account decisions on the certification, both complete and incomplete - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accountDecisionsTotal'?: number; - /** - * The number of entitlement decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'entitlementsApproved'?: number; - /** - * The number of entitlement decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'entitlementsRevoked'?: number; - /** - * The number of access profile decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accessProfilesApproved'?: number; - /** - * The number of access profile decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accessProfilesRevoked'?: number; - /** - * The number of role decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'rolesApproved'?: number; - /** - * The number of role decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'rolesRevoked'?: number; - /** - * The number of account decisions that have been made which were approved - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accountsApproved'?: number; - /** - * The number of account decisions that have been made which were revoked - * @type {number} - * @memberof IdentityCertDecisionSummary - */ - 'accountsRevoked'?: number; -} -/** - * - * @export - * @interface IdentityCertificationDto - */ -export interface IdentityCertificationDto { - /** - * id of the certification - * @type {string} - * @memberof IdentityCertificationDto - */ - 'id'?: string; - /** - * name of the certification - * @type {string} - * @memberof IdentityCertificationDto - */ - 'name'?: string; - /** - * - * @type {CampaignReference} - * @memberof IdentityCertificationDto - */ - 'campaign'?: CampaignReference; - /** - * Have all decisions been made? - * @type {boolean} - * @memberof IdentityCertificationDto - */ - 'completed'?: boolean; - /** - * The number of identities for whom all decisions have been made and are complete. - * @type {number} - * @memberof IdentityCertificationDto - */ - 'identitiesCompleted'?: number; - /** - * The total number of identities in the Certification, both complete and incomplete. - * @type {number} - * @memberof IdentityCertificationDto - */ - 'identitiesTotal'?: number; - /** - * created date - * @type {string} - * @memberof IdentityCertificationDto - */ - 'created'?: string; - /** - * modified date - * @type {string} - * @memberof IdentityCertificationDto - */ - 'modified'?: string; - /** - * The number of approve/revoke/acknowledge decisions that have been made. - * @type {number} - * @memberof IdentityCertificationDto - */ - 'decisionsMade'?: number; - /** - * The total number of approve/revoke/acknowledge decisions. - * @type {number} - * @memberof IdentityCertificationDto - */ - 'decisionsTotal'?: number; - /** - * The due date of the certification. - * @type {string} - * @memberof IdentityCertificationDto - */ - 'due'?: string | null; - /** - * The date the reviewer signed off on the Certification. - * @type {string} - * @memberof IdentityCertificationDto - */ - 'signed'?: string | null; - /** - * - * @type {Reviewer} - * @memberof IdentityCertificationDto - */ - 'reviewer'?: Reviewer; - /** - * - * @type {Reassignment} - * @memberof IdentityCertificationDto - */ - 'reassignment'?: Reassignment | null; - /** - * Identifies if the certification has an error - * @type {boolean} - * @memberof IdentityCertificationDto - */ - 'hasErrors'?: boolean; - /** - * Description of the certification error - * @type {string} - * @memberof IdentityCertificationDto - */ - 'errorMessage'?: string | null; - /** - * - * @type {CertificationPhase} - * @memberof IdentityCertificationDto - */ - 'phase'?: CertificationPhase; -} - - -/** - * Identity - * @export - * @interface IdentityDocument - */ -export interface IdentityDocument { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocument - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocument - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocument - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocument - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocument - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocument - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocument - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocument - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocument - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocument - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocument - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocument - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocument - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocument - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManager} - * @memberof IdentityDocument - */ - 'manager'?: IdentityDocumentAllOfManager | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocument - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfile} - * @memberof IdentityDocument - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfile; - /** - * - * @type {IdentityDocumentAllOfSource} - * @memberof IdentityDocument - */ - 'source'?: IdentityDocumentAllOfSource; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocument - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocument - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocument - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocument - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetails} - * @memberof IdentityDocument - */ - 'processingDetails'?: ProcessingDetails; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocument - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocument - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocument - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocument - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocument - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocument - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocument - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocument - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocument - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocument - */ - 'visibleSegmentCount'?: number; -} -/** - * Identity\'s identity profile. - * @export - * @interface IdentityDocumentAllOfIdentityProfile - */ -export interface IdentityDocumentAllOfIdentityProfile { - /** - * Identity profile\'s ID. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfile - */ - 'id'?: string; - /** - * Identity profile\'s name. - * @type {string} - * @memberof IdentityDocumentAllOfIdentityProfile - */ - 'name'?: string; -} -/** - * Identity\'s manager. - * @export - * @interface IdentityDocumentAllOfManager - */ -export interface IdentityDocumentAllOfManager { - /** - * ID of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManager - */ - 'id'?: string; - /** - * Name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManager - */ - 'name'?: string; - /** - * Display name of identity\'s manager. - * @type {string} - * @memberof IdentityDocumentAllOfManager - */ - 'displayName'?: string; -} -/** - * Identity\'s source. - * @export - * @interface IdentityDocumentAllOfSource - */ -export interface IdentityDocumentAllOfSource { - /** - * ID of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSource - */ - 'id'?: string; - /** - * Display name of identity\'s source. - * @type {string} - * @memberof IdentityDocumentAllOfSource - */ - 'name'?: string; -} -/** - * - * @export - * @interface IdentityDocuments - */ -export interface IdentityDocuments { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof IdentityDocuments - */ - 'id': string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof IdentityDocuments - */ - 'name': string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityDocuments - */ - 'displayName'?: string; - /** - * Identity\'s first name. - * @type {string} - * @memberof IdentityDocuments - */ - 'firstName'?: string; - /** - * Identity\'s last name. - * @type {string} - * @memberof IdentityDocuments - */ - 'lastName'?: string; - /** - * Identity\'s primary email address. - * @type {string} - * @memberof IdentityDocuments - */ - 'email'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof IdentityDocuments - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof IdentityDocuments - */ - 'modified'?: string | null; - /** - * Identity\'s phone number. - * @type {string} - * @memberof IdentityDocuments - */ - 'phone'?: string; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof IdentityDocuments - */ - 'synced'?: string; - /** - * Indicates whether the identity is inactive. - * @type {boolean} - * @memberof IdentityDocuments - */ - 'inactive'?: boolean; - /** - * Indicates whether the identity is protected. - * @type {boolean} - * @memberof IdentityDocuments - */ - 'protected'?: boolean; - /** - * Identity\'s status in SailPoint. - * @type {string} - * @memberof IdentityDocuments - */ - 'status'?: string; - /** - * Identity\'s employee number. - * @type {string} - * @memberof IdentityDocuments - */ - 'employeeNumber'?: string; - /** - * - * @type {IdentityDocumentAllOfManager} - * @memberof IdentityDocuments - */ - 'manager'?: IdentityDocumentAllOfManager | null; - /** - * Indicates whether the identity is a manager of other identities. - * @type {boolean} - * @memberof IdentityDocuments - */ - 'isManager'?: boolean; - /** - * - * @type {IdentityDocumentAllOfIdentityProfile} - * @memberof IdentityDocuments - */ - 'identityProfile'?: IdentityDocumentAllOfIdentityProfile; - /** - * - * @type {IdentityDocumentAllOfSource} - * @memberof IdentityDocuments - */ - 'source'?: IdentityDocumentAllOfSource; - /** - * Map or dictionary of key/value pairs. - * @type {{ [key: string]: any; }} - * @memberof IdentityDocuments - */ - 'attributes'?: { [key: string]: any; }; - /** - * Indicates whether the identity is disabled. - * @type {boolean} - * @memberof IdentityDocuments - */ - 'disabled'?: boolean; - /** - * Indicates whether the identity is locked. - * @type {boolean} - * @memberof IdentityDocuments - */ - 'locked'?: boolean; - /** - * Identity\'s processing state. - * @type {string} - * @memberof IdentityDocuments - */ - 'processingState'?: string | null; - /** - * - * @type {ProcessingDetails} - * @memberof IdentityDocuments - */ - 'processingDetails'?: ProcessingDetails; - /** - * List of accounts associated with the identity. - * @type {Array} - * @memberof IdentityDocuments - */ - 'accounts'?: Array; - /** - * Number of accounts associated with the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'accountCount'?: number; - /** - * List of applications the identity has access to. - * @type {Array} - * @memberof IdentityDocuments - */ - 'apps'?: Array; - /** - * Number of applications the identity has access to. - * @type {number} - * @memberof IdentityDocuments - */ - 'appCount'?: number; - /** - * List of access items assigned to the identity. - * @type {Array} - * @memberof IdentityDocuments - */ - 'access'?: Array; - /** - * Number of access items assigned to the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'accessCount'?: number; - /** - * Number of entitlements assigned to the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'entitlementCount'?: number; - /** - * Number of roles assigned to the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'roleCount'?: number; - /** - * Number of access profiles assigned to the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'accessProfileCount'?: number; - /** - * Access items the identity owns. - * @type {Array} - * @memberof IdentityDocuments - */ - 'owns'?: Array; - /** - * Number of access items the identity owns. - * @type {number} - * @memberof IdentityDocuments - */ - 'ownsCount'?: number; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof IdentityDocuments - */ - 'tags'?: Array; - /** - * Number of tags on the identity. - * @type {number} - * @memberof IdentityDocuments - */ - 'tagsCount'?: number; - /** - * List of segments that the identity is in. - * @type {Array} - * @memberof IdentityDocuments - */ - 'visibleSegments'?: Array | null; - /** - * Number of segments the identity is in. - * @type {number} - * @memberof IdentityDocuments - */ - 'visibleSegmentCount'?: number; - /** - * Name of the pod. - * @type {string} - * @memberof IdentityDocuments - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof IdentityDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof IdentityDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof IdentityDocuments - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof IdentityDocuments - */ - '_version'?: string; -} - - -/** - * - * @export - * @interface IdentityExceptionReportReference - */ -export interface IdentityExceptionReportReference { - /** - * Task result ID. - * @type {string} - * @memberof IdentityExceptionReportReference - */ - 'taskResultId'?: string; - /** - * Report name. - * @type {string} - * @memberof IdentityExceptionReportReference - */ - 'reportName'?: string; -} -/** - * - * @export - * @interface IdentityPreviewRequest - */ -export interface IdentityPreviewRequest { - /** - * The Identity id - * @type {string} - * @memberof IdentityPreviewRequest - */ - 'identityId'?: string; - /** - * - * @type {IdentityAttributeConfig} - * @memberof IdentityPreviewRequest - */ - 'identityAttributeConfig'?: IdentityAttributeConfig; -} -/** - * - * @export - * @interface IdentityPreviewResponse - */ -export interface IdentityPreviewResponse { - /** - * - * @type {IdentityPreviewResponseIdentity} - * @memberof IdentityPreviewResponse - */ - 'identity'?: IdentityPreviewResponseIdentity; - /** - * - * @type {Array} - * @memberof IdentityPreviewResponse - */ - 'previewAttributes'?: Array; -} -/** - * Identity\'s basic details. - * @export - * @interface IdentityPreviewResponseIdentity - */ -export interface IdentityPreviewResponseIdentity { - /** - * Identity\'s DTO type. - * @type {string} - * @memberof IdentityPreviewResponseIdentity - */ - 'type'?: IdentityPreviewResponseIdentityTypeV3; - /** - * Identity ID. - * @type {string} - * @memberof IdentityPreviewResponseIdentity - */ - 'id'?: string; - /** - * Identity\'s display name. - * @type {string} - * @memberof IdentityPreviewResponseIdentity - */ - 'name'?: string; -} - -export const IdentityPreviewResponseIdentityTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityPreviewResponseIdentityTypeV3 = typeof IdentityPreviewResponseIdentityTypeV3[keyof typeof IdentityPreviewResponseIdentityTypeV3]; - -/** - * - * @export - * @interface IdentityProfile - */ -export interface IdentityProfile { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof IdentityProfile - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof IdentityProfile - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof IdentityProfile - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof IdentityProfile - */ - 'modified'?: string; - /** - * Identity profile\'s description. - * @type {string} - * @memberof IdentityProfile - */ - 'description'?: string | null; - /** - * - * @type {IdentityProfileAllOfOwner} - * @memberof IdentityProfile - */ - 'owner'?: IdentityProfileAllOfOwner | null; - /** - * Identity profile\'s priority. - * @type {number} - * @memberof IdentityProfile - */ - 'priority'?: number; - /** - * - * @type {IdentityProfileAllOfAuthoritativeSource} - * @memberof IdentityProfile - */ - 'authoritativeSource': IdentityProfileAllOfAuthoritativeSource; - /** - * Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - * @type {boolean} - * @memberof IdentityProfile - */ - 'identityRefreshRequired'?: boolean; - /** - * Number of identities belonging to the identity profile. - * @type {number} - * @memberof IdentityProfile - */ - 'identityCount'?: number; - /** - * - * @type {IdentityAttributeConfig} - * @memberof IdentityProfile - */ - 'identityAttributeConfig'?: IdentityAttributeConfig; - /** - * - * @type {IdentityExceptionReportReference} - * @memberof IdentityProfile - */ - 'identityExceptionReportReference'?: IdentityExceptionReportReference | null; - /** - * Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - * @type {boolean} - * @memberof IdentityProfile - */ - 'hasTimeBasedAttr'?: boolean; -} -/** - * - * @export - * @interface IdentityProfileAllOfAuthoritativeSource - */ -export interface IdentityProfileAllOfAuthoritativeSource { - /** - * Authoritative source\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSource - */ - 'type'?: IdentityProfileAllOfAuthoritativeSourceTypeV3; - /** - * Authoritative source\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSource - */ - 'id'?: string; - /** - * Authoritative source\'s name. - * @type {string} - * @memberof IdentityProfileAllOfAuthoritativeSource - */ - 'name'?: string; -} - -export const IdentityProfileAllOfAuthoritativeSourceTypeV3 = { - Source: 'SOURCE' -} as const; - -export type IdentityProfileAllOfAuthoritativeSourceTypeV3 = typeof IdentityProfileAllOfAuthoritativeSourceTypeV3[keyof typeof IdentityProfileAllOfAuthoritativeSourceTypeV3]; - -/** - * Identity profile\'s owner. - * @export - * @interface IdentityProfileAllOfOwner - */ -export interface IdentityProfileAllOfOwner { - /** - * Owner\'s object type. - * @type {string} - * @memberof IdentityProfileAllOfOwner - */ - 'type'?: IdentityProfileAllOfOwnerTypeV3; - /** - * Owner\'s ID. - * @type {string} - * @memberof IdentityProfileAllOfOwner - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof IdentityProfileAllOfOwner - */ - 'name'?: string; -} - -export const IdentityProfileAllOfOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type IdentityProfileAllOfOwnerTypeV3 = typeof IdentityProfileAllOfOwnerTypeV3[keyof typeof IdentityProfileAllOfOwnerTypeV3]; - -/** - * Identity profile exported object. - * @export - * @interface IdentityProfileExportedObject - */ -export interface IdentityProfileExportedObject { - /** - * Version or object from the target service. - * @type {number} - * @memberof IdentityProfileExportedObject - */ - 'version'?: number; - /** - * - * @type {IdentityProfileExportedObjectSelf} - * @memberof IdentityProfileExportedObject - */ - 'self'?: IdentityProfileExportedObjectSelf; - /** - * - * @type {IdentityProfile} - * @memberof IdentityProfileExportedObject - */ - 'object'?: IdentityProfile; -} -/** - * Self block for exported object. - * @export - * @interface IdentityProfileExportedObjectSelf - */ -export interface IdentityProfileExportedObjectSelf { - /** - * Exported object\'s DTO type. - * @type {string} - * @memberof IdentityProfileExportedObjectSelf - */ - 'type'?: IdentityProfileExportedObjectSelfTypeV3; - /** - * Exported object\'s ID. - * @type {string} - * @memberof IdentityProfileExportedObjectSelf - */ - 'id'?: string; - /** - * Exported object\'s display name. - * @type {string} - * @memberof IdentityProfileExportedObjectSelf - */ - 'name'?: string; -} - -export const IdentityProfileExportedObjectSelfTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type IdentityProfileExportedObjectSelfTypeV3 = typeof IdentityProfileExportedObjectSelfTypeV3[keyof typeof IdentityProfileExportedObjectSelfTypeV3]; - -/** - * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) - * @export - * @interface IdentityProfileIdentityErrorReportArguments - */ -export interface IdentityProfileIdentityErrorReportArguments { - /** - * Source ID. - * @type {string} - * @memberof IdentityProfileIdentityErrorReportArguments - */ - 'authoritativeSource': string; -} -/** - * - * @export - * @interface IdentityProfilesConnections - */ -export interface IdentityProfilesConnections { - /** - * ID of the IdentityProfile this reference applies - * @type {string} - * @memberof IdentityProfilesConnections - */ - 'id'?: string; - /** - * Human-readable display name of the IdentityProfile to which this reference applies - * @type {string} - * @memberof IdentityProfilesConnections - */ - 'name'?: string; - /** - * The Number of Identities managed by this IdentityProfile - * @type {number} - * @memberof IdentityProfilesConnections - */ - 'identityCount'?: number; -} -/** - * The manager for the identity. - * @export - * @interface IdentityReference - */ -export interface IdentityReference { - /** - * - * @type {DtoType} - * @memberof IdentityReference - */ - 'type'?: DtoType; - /** - * Identity id - * @type {string} - * @memberof IdentityReference - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof IdentityReference - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface IdentityReferenceWithNameAndEmail - */ -export interface IdentityReferenceWithNameAndEmail { - /** - * The type can only be IDENTITY. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmail - */ - 'type'?: string; - /** - * Identity ID. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmail - */ - 'id'?: string; - /** - * Identity\'s human-readable display name. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmail - */ - 'name'?: string; - /** - * Identity\'s email address. This is read-only. - * @type {string} - * @memberof IdentityReferenceWithNameAndEmail - */ - 'email'?: string; -} -/** - * - * @export - * @interface IdentitySummary - */ -export interface IdentitySummary { - /** - * ID of this identity summary - * @type {string} - * @memberof IdentitySummary - */ - 'id'?: string; - /** - * Human-readable display name of identity - * @type {string} - * @memberof IdentitySummary - */ - 'name'?: string; - /** - * ID of the identity that this summary represents - * @type {string} - * @memberof IdentitySummary - */ - 'identityId'?: string; - /** - * Indicates if all access items for this summary have been decided on - * @type {boolean} - * @memberof IdentitySummary - */ - 'completed'?: boolean; -} -/** - * An identity with a set of access to be added - * @export - * @interface IdentityWithNewAccess - */ -export interface IdentityWithNewAccess { - /** - * Identity id to be checked. - * @type {string} - * @memberof IdentityWithNewAccess - */ - 'identityId': string; - /** - * The list of entitlements to consider for possible violations in a preventive check. - * @type {Array} - * @memberof IdentityWithNewAccess - */ - 'accessRefs': Array; -} -/** - * Entitlement including a specific set of access. - * @export - * @interface IdentityWithNewAccessAccessRefsInner - */ -export interface IdentityWithNewAccessAccessRefsInner { - /** - * Entitlement\'s DTO type. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInner - */ - 'type'?: IdentityWithNewAccessAccessRefsInnerTypeV3; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof IdentityWithNewAccessAccessRefsInner - */ - 'id'?: string; -} - -export const IdentityWithNewAccessAccessRefsInnerTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type IdentityWithNewAccessAccessRefsInnerTypeV3 = typeof IdentityWithNewAccessAccessRefsInnerTypeV3[keyof typeof IdentityWithNewAccessAccessRefsInnerTypeV3]; - -/** - * - * @export - * @interface IdpDetails - */ -export interface IdpDetails { - /** - * Federation protocol role - * @type {string} - * @memberof IdpDetails - */ - 'role'?: IdpDetailsRoleV3; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof IdpDetails - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof IdpDetails - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'nameId'?: string; - /** - * - * @type {JITConfiguration} - * @memberof IdpDetails - */ - 'jitConfiguration'?: JITConfiguration; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof IdpDetails - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof IdpDetails - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof IdpDetails - */ - 'certificateName'?: string; -} - -export const IdpDetailsRoleV3 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type IdpDetailsRoleV3 = typeof IdpDetailsRoleV3[keyof typeof IdpDetailsRoleV3]; - -/** - * - * @export - * @interface ImportNonEmployeeRecordsInBulkRequest - */ -export interface ImportNonEmployeeRecordsInBulkRequest { - /** - * - * @type {File} - * @memberof ImportNonEmployeeRecordsInBulkRequest - */ - 'data': File; -} -/** - * Object created or updated by import. - * @export - * @interface ImportObject - */ -export interface ImportObject { - /** - * DTO type of object created or updated by import. - * @type {string} - * @memberof ImportObject - */ - 'type'?: ImportObjectTypeV3; - /** - * ID of object created or updated by import. - * @type {string} - * @memberof ImportObject - */ - 'id'?: string; - /** - * Display name of object created or updated by import. - * @type {string} - * @memberof ImportObject - */ - 'name'?: string; -} - -export const ImportObjectTypeV3 = { - ConnectorRule: 'CONNECTOR_RULE', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - Rule: 'RULE', - Source: 'SOURCE', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION' -} as const; - -export type ImportObjectTypeV3 = typeof ImportObjectTypeV3[keyof typeof ImportObjectTypeV3]; - -/** - * Enum representing the currently supported indices. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const Index = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles', - Star: '*' -} as const; - -export type Index = typeof Index[keyof typeof Index]; - - -/** - * - * @export - * @interface IndexOf - */ -export interface IndexOf { - /** - * A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. - * @type {string} - * @memberof IndexOf - */ - 'substring': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof IndexOf - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof IndexOf - */ - 'input'?: { [key: string]: any; }; -} -/** - * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - * @export - * @interface InnerHit - */ -export interface InnerHit { - /** - * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof InnerHit - */ - 'query': string; - /** - * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. - * @type {string} - * @memberof InnerHit - */ - 'type': string; -} -/** - * - * @export - * @interface JITConfiguration - */ -export interface JITConfiguration { - /** - * The indicator for just-in-time provisioning enabled - * @type {boolean} - * @memberof JITConfiguration - */ - 'enabled'?: boolean; - /** - * the sourceId that mapped to just-in-time provisioning configuration - * @type {string} - * @memberof JITConfiguration - */ - 'sourceId'?: string; - /** - * A mapping of identity profile attribute names to SAML assertion attribute names - * @type {{ [key: string]: string; }} - * @memberof JITConfiguration - */ - 'sourceAttributeMappings'?: { [key: string]: string; }; -} -/** - * 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': JsonPatchOperationOpV3; - /** - * 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 JsonPatchOperationOpV3 = { - Add: 'add', - Remove: 'remove', - Replace: 'replace', - Move: 'move', - Copy: 'copy', - Test: 'test' -} as const; - -export type JsonPatchOperationOpV3 = typeof JsonPatchOperationOpV3[keyof typeof JsonPatchOperationOpV3]; - -/** - * @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 KbaAnswerRequestItem - */ -export interface KbaAnswerRequestItem { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerRequestItem - */ - 'id': string; - /** - * An answer for the KBA question - * @type {string} - * @memberof KbaAnswerRequestItem - */ - 'answer': string; -} -/** - * - * @export - * @interface KbaAnswerResponseItem - */ -export interface KbaAnswerResponseItem { - /** - * Question Id - * @type {string} - * @memberof KbaAnswerResponseItem - */ - 'id': string; - /** - * Question description - * @type {string} - * @memberof KbaAnswerResponseItem - */ - 'question': string; - /** - * Denotes whether the KBA question has an answer configured for the current user - * @type {boolean} - * @memberof KbaAnswerResponseItem - */ - 'hasAnswer': boolean; -} -/** - * - * @export - * @interface KbaAuthResponse - */ -export interface KbaAuthResponse { - /** - * - * @type {Array} - * @memberof KbaAuthResponse - */ - 'kbaAuthResponseItems'?: Array; - /** - * MFA Authentication status - * @type {string} - * @memberof KbaAuthResponse - */ - 'status'?: KbaAuthResponseStatusV3; -} - -export const KbaAuthResponseStatusV3 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type KbaAuthResponseStatusV3 = typeof KbaAuthResponseStatusV3[keyof typeof KbaAuthResponseStatusV3]; - -/** - * - * @export - * @interface KbaAuthResponseItem - */ -export interface KbaAuthResponseItem { - /** - * The KBA question id - * @type {string} - * @memberof KbaAuthResponseItem - */ - 'questionId'?: string | null; - /** - * Return true if verified - * @type {boolean} - * @memberof KbaAuthResponseItem - */ - 'isVerified'?: boolean | null; -} -/** - * KBA Configuration - * @export - * @interface KbaQuestion - */ -export interface KbaQuestion { - /** - * KBA Question Id - * @type {string} - * @memberof KbaQuestion - */ - 'id': string; - /** - * KBA Question description - * @type {string} - * @memberof KbaQuestion - */ - 'text': string; - /** - * Denotes whether the KBA question has an answer configured for any user in the tenant - * @type {boolean} - * @memberof KbaQuestion - */ - 'hasAnswer': boolean; - /** - * Denotes the number of KBA configurations for this question - * @type {number} - * @memberof KbaQuestion - */ - 'numAnswers': number; -} -/** - * - * @export - * @interface LeftPad - */ -export interface LeftPad { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof LeftPad - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof LeftPad - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof LeftPad - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof LeftPad - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface LifecycleState - */ -export interface LifecycleState { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof LifecycleState - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof LifecycleState - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof LifecycleState - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof LifecycleState - */ - 'modified'?: string; - /** - * Indicates whether the lifecycle state is enabled or disabled. - * @type {boolean} - * @memberof LifecycleState - */ - 'enabled'?: boolean; - /** - * The lifecycle state\'s technical name. This is for internal use. - * @type {string} - * @memberof LifecycleState - */ - 'technicalName': string; - /** - * Lifecycle state\'s description. - * @type {string} - * @memberof LifecycleState - */ - 'description'?: string; - /** - * Number of identities that have the lifecycle state. - * @type {number} - * @memberof LifecycleState - */ - 'identityCount'?: number; - /** - * - * @type {EmailNotificationOption} - * @memberof LifecycleState - */ - 'emailNotificationOption'?: EmailNotificationOption; - /** - * - * @type {Array} - * @memberof LifecycleState - */ - 'accountActions'?: Array; - /** - * List of unique access-profile IDs that are associated with the lifecycle state. - * @type {Set} - * @memberof LifecycleState - */ - 'accessProfileIds'?: Set; - /** - * The lifecycle state\'s associated identity state. This field is generally \'null\'. - * @type {string} - * @memberof LifecycleState - */ - 'identityState'?: string | null; -} -/** - * Deleted lifecycle state. - * @export - * @interface LifecyclestateDeleted - */ -export interface LifecyclestateDeleted { - /** - * Deleted lifecycle state\'s DTO type. - * @type {string} - * @memberof LifecyclestateDeleted - */ - 'type'?: LifecyclestateDeletedTypeV3; - /** - * Deleted lifecycle state ID. - * @type {string} - * @memberof LifecyclestateDeleted - */ - 'id'?: string; - /** - * Deleted lifecycle state\'s display name. - * @type {string} - * @memberof LifecyclestateDeleted - */ - 'name'?: string; -} - -export const LifecyclestateDeletedTypeV3 = { - LifecycleState: 'LIFECYCLE_STATE', - TaskResult: 'TASK_RESULT' -} as const; - -export type LifecyclestateDeletedTypeV3 = typeof LifecyclestateDeletedTypeV3[keyof typeof LifecyclestateDeletedTypeV3]; - -/** - * - * @export - * @interface ListAccessProfiles401Response - */ -export interface ListAccessProfiles401Response { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles401Response - */ - 'error'?: object; -} -/** - * - * @export - * @interface ListAccessProfiles429Response - */ -export interface ListAccessProfiles429Response { - /** - * A message describing the error - * @type {object} - * @memberof ListAccessProfiles429Response - */ - 'message'?: object; -} -/** - * - * @export - * @interface ListCampaignFilters200Response - */ -export interface ListCampaignFilters200Response { - /** - * List of campaign filters. - * @type {Array} - * @memberof ListCampaignFilters200Response - */ - 'items'?: Array; - /** - * Number of filters returned. - * @type {number} - * @memberof ListCampaignFilters200Response - */ - 'count'?: number; -} -/** - * - * @export - * @interface ListCompleteWorkflowLibrary200ResponseInner - */ -export interface ListCompleteWorkflowLibrary200ResponseInner { - /** - * Operator ID. - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'description'?: string; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutput} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutput; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'isDynamicSchema'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'outputSchema'?: object; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof ListCompleteWorkflowLibrary200ResponseInner - */ - 'inputExample'?: object | null; -} -/** - * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const LocaleOrigin = { - Default: 'DEFAULT', - Request: 'REQUEST' -} as const; - -export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; - - -/** - * - * @export - * @interface LockoutConfiguration - */ -export interface LockoutConfiguration { - /** - * The maximum attempts allowed before lockout occurs. - * @type {number} - * @memberof LockoutConfiguration - */ - 'maximumAttempts'?: number; - /** - * The total time in minutes a user will be locked out. - * @type {number} - * @memberof LockoutConfiguration - */ - 'lockoutDuration'?: number; - /** - * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. - * @type {number} - * @memberof LockoutConfiguration - */ - 'lockoutWindow'?: number; -} -/** - * - * @export - * @interface Lookup - */ -export interface Lookup { - /** - * This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return \"Unknown Region\" for the attribute that is mapped to this transform. - * @type {{ [key: string]: any; }} - * @memberof Lookup - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Lookup - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Lookup - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Lower - */ -export interface Lower { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Lower - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Lower - */ - 'input'?: { [key: string]: any; }; -} -/** - * 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'?: ManagedClientStatusV3 | null; - /** - * Type of the ManagedClient (VA, CCG) - * @type {string} - * @memberof ManagedClient - */ - 'type': string; - /** - * Cluster Type of the ManagedClient - * @type {string} - * @memberof ManagedClient - */ - 'clusterType'?: ManagedClientClusterTypeV3 | 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'?: ManagedClientProvisionStatusV3 | null; -} - -export const ManagedClientStatusV3 = { - Normal: 'NORMAL', - Undefined: 'UNDEFINED', - NotConfigured: 'NOT_CONFIGURED', - Configuring: 'CONFIGURING', - Warning: 'WARNING', - Error: 'ERROR', - Failed: 'FAILED' -} as const; - -export type ManagedClientStatusV3 = typeof ManagedClientStatusV3[keyof typeof ManagedClientStatusV3]; -export const ManagedClientClusterTypeV3 = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc' -} as const; - -export type ManagedClientClusterTypeV3 = typeof ManagedClientClusterTypeV3[keyof typeof ManagedClientClusterTypeV3]; -export const ManagedClientProvisionStatusV3 = { - Provisioned: 'PROVISIONED', - Draft: 'DRAFT' -} as const; - -export type ManagedClientProvisionStatusV3 = typeof ManagedClientProvisionStatusV3[keyof typeof ManagedClientProvisionStatusV3]; - -/** - * 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]; - - -/** - * Managed Cluster - * @export - * @interface ManagedCluster - */ -export interface ManagedCluster { - /** - * ManagedCluster ID - * @type {string} - * @memberof ManagedCluster - */ - 'id': string; - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedCluster - */ - 'name'?: string; - /** - * ManagedCluster pod - * @type {string} - * @memberof ManagedCluster - */ - 'pod'?: string; - /** - * ManagedCluster org - * @type {string} - * @memberof ManagedCluster - */ - 'org'?: string; - /** - * - * @type {ManagedClusterTypes} - * @memberof ManagedCluster - */ - 'type'?: ManagedClusterTypes; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string | null; }} - * @memberof ManagedCluster - */ - 'configuration'?: { [key: string]: string | null; }; - /** - * - * @type {ManagedClusterKeyPair} - * @memberof ManagedCluster - */ - 'keyPair'?: ManagedClusterKeyPair; - /** - * - * @type {ManagedClusterAttributes} - * @memberof ManagedCluster - */ - 'attributes'?: ManagedClusterAttributes; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedCluster - */ - 'description'?: string; - /** - * - * @type {ManagedClusterRedis} - * @memberof ManagedCluster - */ - 'redis'?: ManagedClusterRedis; - /** - * - * @type {ManagedClientType} - * @memberof ManagedCluster - */ - 'clientType': ManagedClientType | null; - /** - * CCG version used by the ManagedCluster - * @type {string} - * @memberof ManagedCluster - */ - 'ccgVersion': string; - /** - * boolean flag indicating whether or not the cluster configuration is pinned - * @type {boolean} - * @memberof ManagedCluster - */ - 'pinnedConfig'?: boolean; - /** - * - * @type {ClientLogConfiguration} - * @memberof ManagedCluster - */ - 'logConfiguration'?: ClientLogConfiguration | null; - /** - * Whether or not the cluster is operational or not - * @type {boolean} - * @memberof ManagedCluster - */ - 'operational'?: boolean; - /** - * Cluster status - * @type {string} - * @memberof ManagedCluster - */ - 'status'?: ManagedClusterStatusV3; - /** - * Public key certificate - * @type {string} - * @memberof ManagedCluster - */ - 'publicKeyCertificate'?: string | null; - /** - * Public key thumbprint - * @type {string} - * @memberof ManagedCluster - */ - 'publicKeyThumbprint'?: string | null; - /** - * Public key - * @type {string} - * @memberof ManagedCluster - */ - 'publicKey'?: string | null; - /** - * - * @type {ManagedClusterEncryptionConfig} - * @memberof ManagedCluster - */ - 'encryptionConfiguration'?: ManagedClusterEncryptionConfig; - /** - * Key describing any immediate cluster alerts - * @type {string} - * @memberof ManagedCluster - */ - 'alertKey'?: string; - /** - * List of clients in a cluster - * @type {Array} - * @memberof ManagedCluster - */ - 'clientIds'?: Array; - /** - * Number of services bound to a cluster - * @type {number} - * @memberof ManagedCluster - */ - 'serviceCount'?: number; - /** - * CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - * @type {string} - * @memberof ManagedCluster - */ - 'ccId'?: string; - /** - * The date/time this cluster was created - * @type {string} - * @memberof ManagedCluster - */ - 'createdAt'?: string | null; - /** - * The date/time this cluster was last updated - * @type {string} - * @memberof ManagedCluster - */ - 'updatedAt'?: string | null; - /** - * The date/time this cluster was notified for the last release - * @type {string} - * @memberof ManagedCluster - */ - 'lastReleaseNotifiedAt'?: string | null; - /** - * - * @type {ManagedClusterUpdatePreferences} - * @memberof ManagedCluster - */ - 'updatePreferences'?: ManagedClusterUpdatePreferences; - /** - * The current installed release on the Managed cluster - * @type {string} - * @memberof ManagedCluster - */ - 'currentInstalledReleaseVersion'?: string | null; - /** - * New available updates for the Managed cluster - * @type {string} - * @memberof ManagedCluster - */ - 'updatePackage'?: string | null; - /** - * The time at which out of date notification was sent for the Managed cluster - * @type {string} - * @memberof ManagedCluster - */ - 'isOutOfDateNotifiedAt'?: string | null; - /** - * The consolidated Health Status for the Managed cluster - * @type {string} - * @memberof ManagedCluster - */ - 'consolidatedHealthIndicatorsStatus'?: ManagedClusterConsolidatedHealthIndicatorsStatusV3 | null; -} - -export const ManagedClusterStatusV3 = { - Configuring: 'CONFIGURING', - Failed: 'FAILED', - NoClients: 'NO_CLIENTS', - Normal: 'NORMAL', - Warning: 'WARNING' -} as const; - -export type ManagedClusterStatusV3 = typeof ManagedClusterStatusV3[keyof typeof ManagedClusterStatusV3]; -export const ManagedClusterConsolidatedHealthIndicatorsStatusV3 = { - Normal: 'NORMAL', - Warning: 'WARNING', - Error: 'ERROR' -} as const; - -export type ManagedClusterConsolidatedHealthIndicatorsStatusV3 = typeof ManagedClusterConsolidatedHealthIndicatorsStatusV3[keyof typeof ManagedClusterConsolidatedHealthIndicatorsStatusV3]; - -/** - * Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - * @export - * @interface ManagedClusterAttributes - */ -export interface ManagedClusterAttributes { - /** - * - * @type {ManagedClusterQueue} - * @memberof ManagedClusterAttributes - */ - 'queue'?: ManagedClusterQueue; - /** - * ManagedCluster keystore for spConnectCluster type - * @type {string} - * @memberof ManagedClusterAttributes - */ - 'keystore'?: string | null; -} -/** - * Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. - * @export - * @interface ManagedClusterEncryptionConfig - */ -export interface ManagedClusterEncryptionConfig { - /** - * Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. - * @type {string} - * @memberof ManagedClusterEncryptionConfig - */ - 'format'?: ManagedClusterEncryptionConfigFormatV3; -} - -export const ManagedClusterEncryptionConfigFormatV3 = { - V2: 'V2', - V3: 'V3' -} as const; - -export type ManagedClusterEncryptionConfigFormatV3 = typeof ManagedClusterEncryptionConfigFormatV3[keyof typeof ManagedClusterEncryptionConfigFormatV3]; - -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterKeyPair - */ -export interface ManagedClusterKeyPair { - /** - * ManagedCluster publicKey - * @type {string} - * @memberof ManagedClusterKeyPair - */ - 'publicKey'?: string | null; - /** - * ManagedCluster publicKeyThumbprint - * @type {string} - * @memberof ManagedClusterKeyPair - */ - 'publicKeyThumbprint'?: string | null; - /** - * ManagedCluster publicKeyCertificate - * @type {string} - * @memberof ManagedClusterKeyPair - */ - 'publicKeyCertificate'?: string | null; -} -/** - * Managed Cluster key pair for Cluster - * @export - * @interface ManagedClusterQueue - */ -export interface ManagedClusterQueue { - /** - * ManagedCluster queue name - * @type {string} - * @memberof ManagedClusterQueue - */ - 'name'?: string; - /** - * ManagedCluster queue aws region - * @type {string} - * @memberof ManagedClusterQueue - */ - 'region'?: string; -} -/** - * Managed Cluster Redis Configuration - * @export - * @interface ManagedClusterRedis - */ -export interface ManagedClusterRedis { - /** - * ManagedCluster redisHost - * @type {string} - * @memberof ManagedClusterRedis - */ - 'redisHost'?: string; - /** - * ManagedCluster redisPort - * @type {number} - * @memberof ManagedClusterRedis - */ - 'redisPort'?: number; -} -/** - * Request to create Managed Cluster - * @export - * @interface ManagedClusterRequest - */ -export interface ManagedClusterRequest { - /** - * ManagedCluster name - * @type {string} - * @memberof ManagedClusterRequest - */ - 'name': string; - /** - * - * @type {ManagedClusterTypes} - * @memberof ManagedClusterRequest - */ - 'type'?: ManagedClusterTypes; - /** - * ManagedProcess configuration map - * @type {{ [key: string]: string; }} - * @memberof ManagedClusterRequest - */ - 'configuration'?: { [key: string]: string; }; - /** - * ManagedCluster description - * @type {string} - * @memberof ManagedClusterRequest - */ - 'description'?: string | null; -} - - -/** - * The Type of Cluster: * `idn` - IDN VA type * `iai` - IAI harvester VA * `spConnectCluster` - Saas 2.0 connector cluster (this should be one per org) * `sqsCluster` - This should be unused * `das-rc` - Data Access Security Resources Collector * `das-pc` - Data Access Security Permissions Collector * `das-dc` - Data Access Security Data Classification Collector * `pag` - Privilege Action Gateway VA * `das-am` - Data Access Security Activity Monitor * `standard` - Standard Cluster type for running multiple products - * @export - * @enum {string} - */ - -export const ManagedClusterTypes = { - Idn: 'idn', - Iai: 'iai', - SpConnectCluster: 'spConnectCluster', - SqsCluster: 'sqsCluster', - DasRc: 'das-rc', - DasPc: 'das-pc', - DasDc: 'das-dc', - Pag: 'pag', - DasAm: 'das-am', - Standard: 'standard' -} as const; - -export type ManagedClusterTypes = typeof ManagedClusterTypes[keyof typeof ManagedClusterTypes]; - - -/** - * The preference for applying updates for the cluster - * @export - * @interface ManagedClusterUpdatePreferences - */ -export interface ManagedClusterUpdatePreferences { - /** - * The processGroups for updatePreferences - * @type {string} - * @memberof ManagedClusterUpdatePreferences - */ - 'processGroups'?: string | null; - /** - * The current updateState for the cluster - * @type {string} - * @memberof ManagedClusterUpdatePreferences - */ - 'updateState'?: ManagedClusterUpdatePreferencesUpdateStateV3 | null; - /** - * The mail id to which new releases will be notified - * @type {string} - * @memberof ManagedClusterUpdatePreferences - */ - 'notificationEmail'?: string | null; -} - -export const ManagedClusterUpdatePreferencesUpdateStateV3 = { - Auto: 'AUTO', - Disabled: 'DISABLED' -} as const; - -export type ManagedClusterUpdatePreferencesUpdateStateV3 = typeof ManagedClusterUpdatePreferencesUpdateStateV3[keyof typeof ManagedClusterUpdatePreferencesUpdateStateV3]; - -/** - * - * @export - * @interface ManagerCorrelationMapping - */ -export interface ManagerCorrelationMapping { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof ManagerCorrelationMapping - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof ManagerCorrelationMapping - */ - 'identityAttributeName'?: string; -} -/** - * - * @export - * @interface ManualDiscoverApplications - */ -export interface ManualDiscoverApplications { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ManualDiscoverApplications - */ - 'file': File; -} -/** - * - * @export - * @interface ManualDiscoverApplicationsTemplate - */ -export interface ManualDiscoverApplicationsTemplate { - /** - * Name of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplate - */ - 'application_name'?: string; - /** - * Description of the application. - * @type {string} - * @memberof ManualDiscoverApplicationsTemplate - */ - 'description'?: string; -} -/** - * - * @export - * @interface ManualWorkItemDetails - */ -export interface ManualWorkItemDetails { - /** - * True if the request for this item was forwarded from one owner to another. - * @type {boolean} - * @memberof ManualWorkItemDetails - */ - 'forwarded'?: boolean; - /** - * - * @type {ManualWorkItemDetailsOriginalOwner} - * @memberof ManualWorkItemDetails - */ - 'originalOwner'?: ManualWorkItemDetailsOriginalOwner | null; - /** - * - * @type {ManualWorkItemDetailsCurrentOwner} - * @memberof ManualWorkItemDetails - */ - 'currentOwner'?: ManualWorkItemDetailsCurrentOwner | null; - /** - * Time at which item was modified. - * @type {string} - * @memberof ManualWorkItemDetails - */ - 'modified'?: string; - /** - * - * @type {ManualWorkItemState} - * @memberof ManualWorkItemDetails - */ - 'status'?: ManualWorkItemState; - /** - * The history of approval forward action. - * @type {Array} - * @memberof ManualWorkItemDetails - */ - 'forwardHistory'?: Array | null; -} - - -/** - * Identity of current work item owner. - * @export - * @interface ManualWorkItemDetailsCurrentOwner - */ -export interface ManualWorkItemDetailsCurrentOwner { - /** - * DTO type of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwner - */ - 'type'?: ManualWorkItemDetailsCurrentOwnerTypeV3; - /** - * ID of current work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwner - */ - 'id'?: string; - /** - * Display name of current work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsCurrentOwner - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsCurrentOwnerTypeV3 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsCurrentOwnerTypeV3 = typeof ManualWorkItemDetailsCurrentOwnerTypeV3[keyof typeof ManualWorkItemDetailsCurrentOwnerTypeV3]; - -/** - * Identity of original work item owner, if the work item has been forwarded. - * @export - * @interface ManualWorkItemDetailsOriginalOwner - */ -export interface ManualWorkItemDetailsOriginalOwner { - /** - * DTO type of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwner - */ - 'type'?: ManualWorkItemDetailsOriginalOwnerTypeV3; - /** - * ID of original work item owner\'s identity. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwner - */ - 'id'?: string; - /** - * Display name of original work item owner. - * @type {string} - * @memberof ManualWorkItemDetailsOriginalOwner - */ - 'name'?: string; -} - -export const ManualWorkItemDetailsOriginalOwnerTypeV3 = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type ManualWorkItemDetailsOriginalOwnerTypeV3 = typeof ManualWorkItemDetailsOriginalOwnerTypeV3[keyof typeof ManualWorkItemDetailsOriginalOwnerTypeV3]; - -/** - * Indicates the state of the request processing for this item: * PENDING: The request for this item is awaiting processing. * APPROVED: The request for this item has been approved. * REJECTED: The request for this item was rejected. * EXPIRED: The request for this item expired with no action taken. * CANCELLED: The request for this item was cancelled with no user action. * ARCHIVED: The request for this item has been archived after completion. - * @export - * @enum {string} - */ - -export const ManualWorkItemState = { - Pending: 'PENDING', - Approved: 'APPROVED', - Rejected: 'REJECTED', - Expired: 'EXPIRED', - Cancelled: 'CANCELLED', - Archived: 'ARCHIVED' -} as const; - -export type ManualWorkItemState = typeof ManualWorkItemState[keyof typeof ManualWorkItemState]; - - -/** - * The calculation done on the results of the query - * @export - * @interface MetricAggregation - */ -export interface MetricAggregation { - /** - * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - * @type {string} - * @memberof MetricAggregation - */ - 'name': string; - /** - * - * @type {MetricType} - * @memberof MetricAggregation - */ - 'type'?: MetricType; - /** - * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. - * @type {string} - * @memberof MetricAggregation - */ - 'field': string; -} - - -/** - * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const MetricType = { - Count: 'COUNT', - UniqueCount: 'UNIQUE_COUNT', - Avg: 'AVG', - Sum: 'SUM', - Median: 'MEDIAN', - Min: 'MIN', - Max: 'MAX' -} as const; - -export type MetricType = typeof MetricType[keyof typeof MetricType]; - - -/** - * Response model for configuration test of a given MFA method - * @export - * @interface MfaConfigTestResponse - */ -export interface MfaConfigTestResponse { - /** - * The configuration test result. - * @type {string} - * @memberof MfaConfigTestResponse - */ - 'state'?: MfaConfigTestResponseStateV3; - /** - * The error message to indicate the failure of configuration test. - * @type {string} - * @memberof MfaConfigTestResponse - */ - 'error'?: string; -} - -export const MfaConfigTestResponseStateV3 = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type MfaConfigTestResponseStateV3 = typeof MfaConfigTestResponseStateV3[keyof typeof MfaConfigTestResponseStateV3]; - -/** - * - * @export - * @interface MfaDuoConfig - */ -export interface MfaDuoConfig { - /** - * Mfa method name - * @type {string} - * @memberof MfaDuoConfig - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaDuoConfig - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaDuoConfig - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaDuoConfig - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaDuoConfig - */ - 'identityAttribute'?: string | null; - /** - * A map with additional config properties for the given MFA method - duo-web. - * @type {{ [key: string]: any; }} - * @memberof MfaDuoConfig - */ - 'configProperties'?: { [key: string]: any; } | null; -} -/** - * - * @export - * @interface MfaOktaConfig - */ -export interface MfaOktaConfig { - /** - * Mfa method name - * @type {string} - * @memberof MfaOktaConfig - */ - 'mfaMethod'?: string | null; - /** - * If MFA method is enabled. - * @type {boolean} - * @memberof MfaOktaConfig - */ - 'enabled'?: boolean; - /** - * The server host name or IP address of the MFA provider. - * @type {string} - * @memberof MfaOktaConfig - */ - 'host'?: string | null; - /** - * The secret key for authenticating requests to the MFA provider. - * @type {string} - * @memberof MfaOktaConfig - */ - 'accessKey'?: string | null; - /** - * Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - * @type {string} - * @memberof MfaOktaConfig - */ - 'identityAttribute'?: string | null; -} -/** - * - * @export - * @interface MultiPolicyRequest - */ -export interface MultiPolicyRequest { - /** - * Multi-policy report will be run for this list of ids - * @type {Array} - * @memberof MultiPolicyRequest - */ - 'filteredPolicyList'?: Array; -} -/** - * - * @export - * @interface NameNormalizer - */ -export interface NameNormalizer { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof NameNormalizer - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof NameNormalizer - */ - 'input'?: { [key: string]: any; }; -} -/** - * | Construct | Date Time Pattern | Description | | --------- | ----------------- | ----------- | | ISO8601 | `yyyy-MM-dd\'T\'HH:mm:ss.SSSX` | The ISO8601 standard. | | LDAP | `yyyyMMddHHmmss.Z` | The LDAP standard. | | PEOPLE_SOFT | `MM/dd/yyyy` | The date format People Soft uses. | | EPOCH_TIME_JAVA | # ms from midnight, January 1st, 1970 | The incoming date value as elapsed time in milliseconds from midnight, January 1st, 1970. | | EPOCH_TIME_WIN32| # intervals of 100ns from midnight, January 1st, 1601 | The incoming date value as elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601. | - * @export - * @enum {string} - */ - -export const NamedConstructs = { - Iso8601: 'ISO8601', - Ldap: 'LDAP', - PeopleSoft: 'PEOPLE_SOFT', - EpochTimeJava: 'EPOCH_TIME_JAVA', - EpochTimeWin32: 'EPOCH_TIME_WIN32' -} as const; - -export type NamedConstructs = typeof NamedConstructs[keyof typeof NamedConstructs]; - - -/** - * The nested aggregation object. - * @export - * @interface NestedAggregation - */ -export interface NestedAggregation { - /** - * The name of the nested aggregate to be included in the result. - * @type {string} - * @memberof NestedAggregation - */ - 'name': string; - /** - * The type of the nested object. - * @type {string} - * @memberof NestedAggregation - */ - 'type': string; -} -/** - * - * @export - * @interface NetworkConfiguration - */ -export interface NetworkConfiguration { - /** - * The collection of ip ranges. - * @type {Array} - * @memberof NetworkConfiguration - */ - 'range'?: Array | null; - /** - * The collection of country codes. - * @type {Array} - * @memberof NetworkConfiguration - */ - 'geolocation'?: Array | null; - /** - * Denotes whether the provided lists are whitelisted or blacklisted for geo location. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'whitelisted'?: boolean; -} -/** - * - * @export - * @interface NonEmployeeApprovalDecision - */ -export interface NonEmployeeApprovalDecision { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeApprovalDecision - */ - 'comment'?: string; -} -/** - * - * @export - * @interface NonEmployeeApprovalItem - */ -export interface NonEmployeeApprovalItem { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItem - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithId} - * @memberof NonEmployeeApprovalItem - */ - 'approver'?: NonEmployeeIdentityReferenceWithId; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItem - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatus} - * @memberof NonEmployeeApprovalItem - */ - 'approvalStatus'?: ApprovalStatus; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItem - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItem - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItem - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItem - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestLite} - * @memberof NonEmployeeApprovalItem - */ - 'nonEmployeeRequest'?: NonEmployeeRequestLite; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemBase - */ -export interface NonEmployeeApprovalItemBase { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemBase - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithId} - * @memberof NonEmployeeApprovalItemBase - */ - 'approver'?: NonEmployeeIdentityReferenceWithId; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemBase - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatus} - * @memberof NonEmployeeApprovalItemBase - */ - 'approvalStatus'?: ApprovalStatus; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemBase - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemBase - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemBase - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemBase - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalItemDetail - */ -export interface NonEmployeeApprovalItemDetail { - /** - * Non-Employee approval item id - * @type {string} - * @memberof NonEmployeeApprovalItemDetail - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithId} - * @memberof NonEmployeeApprovalItemDetail - */ - 'approver'?: NonEmployeeIdentityReferenceWithId; - /** - * Requested identity account name - * @type {string} - * @memberof NonEmployeeApprovalItemDetail - */ - 'accountName'?: string; - /** - * - * @type {ApprovalStatus} - * @memberof NonEmployeeApprovalItemDetail - */ - 'approvalStatus'?: ApprovalStatus; - /** - * Approval order - * @type {number} - * @memberof NonEmployeeApprovalItemDetail - */ - 'approvalOrder'?: number; - /** - * comment of approver - * @type {string} - * @memberof NonEmployeeApprovalItemDetail - */ - 'comment'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeApprovalItemDetail - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeApprovalItemDetail - */ - 'created'?: string; - /** - * - * @type {NonEmployeeRequestWithoutApprovalItem} - * @memberof NonEmployeeApprovalItemDetail - */ - 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItem; -} - - -/** - * - * @export - * @interface NonEmployeeApprovalSummary - */ -export interface NonEmployeeApprovalSummary { - /** - * The number of approved non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummary - */ - 'approved'?: number; - /** - * The number of pending non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummary - */ - 'pending'?: number; - /** - * The number of rejected non-employee approval requests. - * @type {number} - * @memberof NonEmployeeApprovalSummary - */ - 'rejected'?: number; -} -/** - * - * @export - * @interface NonEmployeeBulkUploadJob - */ -export interface NonEmployeeBulkUploadJob { - /** - * The bulk upload job\'s ID. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJob - */ - 'id'?: string; - /** - * The ID of the source to bulk-upload non-employees to. (UUID) - * @type {string} - * @memberof NonEmployeeBulkUploadJob - */ - 'sourceId'?: string; - /** - * The date-time the job was submitted. - * @type {string} - * @memberof NonEmployeeBulkUploadJob - */ - 'created'?: string; - /** - * The date-time that the job was last updated. - * @type {string} - * @memberof NonEmployeeBulkUploadJob - */ - 'modified'?: string; - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. - * @type {string} - * @memberof NonEmployeeBulkUploadJob - */ - 'status'?: NonEmployeeBulkUploadJobStatusV3; -} - -export const NonEmployeeBulkUploadJobStatusV3 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadJobStatusV3 = typeof NonEmployeeBulkUploadJobStatusV3[keyof typeof NonEmployeeBulkUploadJobStatusV3]; - -/** - * - * @export - * @interface NonEmployeeBulkUploadStatus - */ -export interface NonEmployeeBulkUploadStatus { - /** - * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. - * @type {string} - * @memberof NonEmployeeBulkUploadStatus - */ - 'status'?: NonEmployeeBulkUploadStatusStatusV3; -} - -export const NonEmployeeBulkUploadStatusStatusV3 = { - Pending: 'PENDING', - InProgress: 'IN_PROGRESS', - Completed: 'COMPLETED', - Error: 'ERROR' -} as const; - -export type NonEmployeeBulkUploadStatusStatusV3 = typeof NonEmployeeBulkUploadStatusStatusV3[keyof typeof NonEmployeeBulkUploadStatusStatusV3]; - -/** - * Identifies if the identity is a normal identity or a governance group - * @export - * @enum {string} - */ - -export const NonEmployeeIdentityDtoType = { - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeIdentityDtoType = typeof NonEmployeeIdentityDtoType[keyof typeof NonEmployeeIdentityDtoType]; - - -/** - * - * @export - * @interface NonEmployeeIdentityReferenceWithId - */ -export interface NonEmployeeIdentityReferenceWithId { - /** - * - * @type {NonEmployeeIdentityDtoType} - * @memberof NonEmployeeIdentityReferenceWithId - */ - 'type'?: NonEmployeeIdentityDtoType; - /** - * Identity id - * @type {string} - * @memberof NonEmployeeIdentityReferenceWithId - */ - 'id'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeIdnUserRequest - */ -export interface NonEmployeeIdnUserRequest { - /** - * Identity id. - * @type {string} - * @memberof NonEmployeeIdnUserRequest - */ - 'id': string; -} -/** - * - * @export - * @interface NonEmployeeRecord - */ -export interface NonEmployeeRecord { - /** - * Non-Employee record id. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'id'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'manager'?: string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'sourceId'?: string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRecord - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRecord - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeRejectApprovalDecision - */ -export interface NonEmployeeRejectApprovalDecision { - /** - * Comment on the approval item. - * @type {string} - * @memberof NonEmployeeRejectApprovalDecision - */ - 'comment': string; -} -/** - * - * @export - * @interface NonEmployeeRequest - */ -export interface NonEmployeeRequest { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'description'?: string; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLite} - * @memberof NonEmployeeRequest - */ - 'nonEmployeeSource'?: NonEmployeeSourceLite; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequest - */ - 'data'?: { [key: string]: string; }; - /** - * List of approval item for the request - * @type {Array} - * @memberof NonEmployeeRequest - */ - 'approvalItems'?: Array; - /** - * - * @type {ApprovalStatus} - * @memberof NonEmployeeRequest - */ - 'approvalStatus'?: ApprovalStatus; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequest - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequest - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeRequestBody - */ -export interface NonEmployeeRequestBody { - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'accountName': string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'firstName': string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'lastName': string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'email': string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'phone': string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'manager': string; - /** - * Non-Employee\'s source id. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'sourceId': string; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestBody - */ - 'data'?: { [key: string]: string; }; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'startDate': string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestBody - */ - 'endDate': string; -} -/** - * - * @export - * @interface NonEmployeeRequestLite - */ -export interface NonEmployeeRequestLite { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestLite - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithId} - * @memberof NonEmployeeRequestLite - */ - 'requester'?: NonEmployeeIdentityReferenceWithId; -} -/** - * - * @export - * @interface NonEmployeeRequestSummary - */ -export interface NonEmployeeRequestSummary { - /** - * The number of approved non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummary - */ - 'approved'?: number; - /** - * The number of rejected non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummary - */ - 'rejected'?: number; - /** - * The number of pending non-employee requests on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummary - */ - 'pending'?: number; - /** - * The number of non-employee records on all sources that *requested-for* user manages. - * @type {number} - * @memberof NonEmployeeRequestSummary - */ - 'nonEmployeeCount'?: number; -} -/** - * - * @export - * @interface NonEmployeeRequestWithoutApprovalItem - */ -export interface NonEmployeeRequestWithoutApprovalItem { - /** - * Non-Employee request id. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'id'?: string; - /** - * - * @type {NonEmployeeIdentityReferenceWithId} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'requester'?: NonEmployeeIdentityReferenceWithId; - /** - * Requested identity account name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'accountName'?: string; - /** - * Non-Employee\'s first name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'firstName'?: string; - /** - * Non-Employee\'s last name. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'lastName'?: string; - /** - * Non-Employee\'s email. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'email'?: string; - /** - * Non-Employee\'s phone. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'phone'?: string; - /** - * The account ID of a valid identity to serve as this non-employee\'s manager. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'manager'?: string; - /** - * - * @type {NonEmployeeSourceLiteWithSchemaAttributes} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributes; - /** - * Additional attributes for a non-employee. Up to 10 custom attributes can be added. - * @type {{ [key: string]: string; }} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'data'?: { [key: string]: string; }; - /** - * - * @type {ApprovalStatus} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'approvalStatus'?: ApprovalStatus; - /** - * Comment of requester - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'comment'?: string; - /** - * When the request was completely approved. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'completionDate'?: string; - /** - * Non-Employee employment start date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'startDate'?: string; - /** - * Non-Employee employment end date. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'endDate'?: string; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeRequestWithoutApprovalItem - */ - 'created'?: string; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttribute - */ -export interface NonEmployeeSchemaAttribute { - /** - * Schema Attribute Id - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'id'?: string; - /** - * True if this schema attribute is mandatory on all non-employees sources. - * @type {boolean} - * @memberof NonEmployeeSchemaAttribute - */ - 'system'?: boolean; - /** - * When the schema attribute was last modified. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'modified'?: string; - /** - * When the schema attribute was created. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'created'?: string; - /** - * - * @type {NonEmployeeSchemaAttributeType} - * @memberof NonEmployeeSchemaAttribute - */ - 'type': NonEmployeeSchemaAttributeType; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttribute - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttribute - */ - 'required'?: boolean; -} - - -/** - * - * @export - * @interface NonEmployeeSchemaAttributeBody - */ -export interface NonEmployeeSchemaAttributeBody { - /** - * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'type': string; - /** - * Label displayed on the UI for this schema attribute. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'label': string; - /** - * The technical name of the attribute. Must be unique per source. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'technicalName': string; - /** - * help text displayed by UI. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'helpText'?: string; - /** - * Hint text that fills UI box. - * @type {string} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'placeholder'?: string; - /** - * If true, the schema attribute is required for all non-employees in the source - * @type {boolean} - * @memberof NonEmployeeSchemaAttributeBody - */ - 'required'?: boolean; -} -/** - * Enum representing the type of data a schema attribute accepts. - * @export - * @enum {string} - */ - -export const NonEmployeeSchemaAttributeType = { - Text: 'TEXT', - Date: 'DATE', - Identity: 'IDENTITY' -} as const; - -export type NonEmployeeSchemaAttributeType = typeof NonEmployeeSchemaAttributeType[keyof typeof NonEmployeeSchemaAttributeType]; - - -/** - * - * @export - * @interface NonEmployeeSource - */ -export interface NonEmployeeSource { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSource - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSource - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSource - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSource - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSource - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSource - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSource - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSource - */ - 'created'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLite - */ -export interface NonEmployeeSourceLite { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLite - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLite - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLite - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLite - */ - 'description'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceLiteWithSchemaAttributes - */ -export interface NonEmployeeSourceLiteWithSchemaAttributes { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributes - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributes - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributes - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceLiteWithSchemaAttributes - */ - 'description'?: string; - /** - * List of schema attributes associated with this non-employee source. - * @type {Array} - * @memberof NonEmployeeSourceLiteWithSchemaAttributes - */ - 'schemaAttributes'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceRequestBody - */ -export interface NonEmployeeSourceRequestBody { - /** - * Name of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBody - */ - 'name': string; - /** - * Description of non-employee source. - * @type {string} - * @memberof NonEmployeeSourceRequestBody - */ - 'description': string; - /** - * - * @type {NonEmployeeIdnUserRequest} - * @memberof NonEmployeeSourceRequestBody - */ - 'owner': NonEmployeeIdnUserRequest; - /** - * The ID for the management workgroup that contains source sub-admins - * @type {string} - * @memberof NonEmployeeSourceRequestBody - */ - 'managementWorkgroup'?: string; - /** - * List of approvers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBody - */ - 'approvers'?: Array; - /** - * List of account managers. - * @type {Array} - * @memberof NonEmployeeSourceRequestBody - */ - 'accountManagers'?: Array; -} -/** - * - * @export - * @interface NonEmployeeSourceWithCloudExternalId - */ -export interface NonEmployeeSourceWithCloudExternalId { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'created'?: string; - /** - * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - * @type {string} - * @memberof NonEmployeeSourceWithCloudExternalId - */ - 'cloudExternalId'?: string; -} -/** - * - * @export - * @interface NonEmployeeSourceWithNECount - */ -export interface NonEmployeeSourceWithNECount { - /** - * Non-Employee source id. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'id'?: string; - /** - * Source Id associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'sourceId'?: string; - /** - * Source name associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'name'?: string; - /** - * Source description associated with this non-employee source. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'description'?: string; - /** - * List of approvers - * @type {Array} - * @memberof NonEmployeeSourceWithNECount - */ - 'approvers'?: Array; - /** - * List of account managers - * @type {Array} - * @memberof NonEmployeeSourceWithNECount - */ - 'accountManagers'?: Array; - /** - * When the request was last modified. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'modified'?: string; - /** - * When the request was created. - * @type {string} - * @memberof NonEmployeeSourceWithNECount - */ - 'created'?: string; - /** - * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. - * @type {number} - * @memberof NonEmployeeSourceWithNECount - */ - 'nonEmployeeCount'?: number | null; -} -/** - * - * @export - * @interface ObjectExportImportNames - */ -export interface ObjectExportImportNames { - /** - * Object names to be included in a backup. - * @type {Array} - * @memberof ObjectExportImportNames - */ - 'includedNames'?: Array; -} -/** - * Response model for import of a single object. - * @export - * @interface ObjectImportResult - */ -export interface ObjectImportResult { - /** - * Informational messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult - */ - 'infos': Array; - /** - * Warning messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult - */ - 'warnings': Array; - /** - * Error messages returned from the target service on import. - * @type {Array} - * @memberof ObjectImportResult - */ - 'errors': Array; - /** - * References to objects that were created or updated by the import. - * @type {Array} - * @memberof ObjectImportResult - */ - 'importedObjects': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateRequest - */ -export interface ObjectMappingBulkCreateRequest { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateRequest - */ - 'newObjectsMappings': Array; -} -/** - * - * @export - * @interface ObjectMappingBulkCreateResponse - */ -export interface ObjectMappingBulkCreateResponse { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkCreateResponse - */ - 'addedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchRequest - */ -export interface ObjectMappingBulkPatchRequest { - /** - * Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. - * @type {{ [key: string]: Array; }} - * @memberof ObjectMappingBulkPatchRequest - */ - 'patches': { [key: string]: Array; }; -} -/** - * - * @export - * @interface ObjectMappingBulkPatchResponse - */ -export interface ObjectMappingBulkPatchResponse { - /** - * - * @type {Array} - * @memberof ObjectMappingBulkPatchResponse - */ - 'patchedObjects'?: Array; -} -/** - * - * @export - * @interface ObjectMappingRequest - */ -export interface ObjectMappingRequest { - /** - * Type of the object the mapping value applies to, must be one from enum - * @type {string} - * @memberof ObjectMappingRequest - */ - 'objectType': ObjectMappingRequestObjectTypeV3; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingRequest - */ - 'jsonPath': string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequest - */ - 'sourceValue': string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingRequest - */ - 'targetValue': string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingRequest - */ - 'enabled'?: boolean; -} - -export const ObjectMappingRequestObjectTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingRequestObjectTypeV3 = typeof ObjectMappingRequestObjectTypeV3[keyof typeof ObjectMappingRequestObjectTypeV3]; - -/** - * - * @export - * @interface ObjectMappingResponse - */ -export interface ObjectMappingResponse { - /** - * Id of the object mapping - * @type {string} - * @memberof ObjectMappingResponse - */ - 'objectMappingId'?: string; - /** - * Type of the object the mapping value applies to - * @type {string} - * @memberof ObjectMappingResponse - */ - 'objectType'?: ObjectMappingResponseObjectTypeV3; - /** - * JSONPath expression denoting the path within the object where the mapping value should be applied - * @type {string} - * @memberof ObjectMappingResponse - */ - 'jsonPath'?: string; - /** - * Original value at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponse - */ - 'sourceValue'?: string; - /** - * Value to be assigned at the jsonPath location within the object - * @type {string} - * @memberof ObjectMappingResponse - */ - 'targetValue'?: string; - /** - * Whether or not this object mapping is enabled - * @type {boolean} - * @memberof ObjectMappingResponse - */ - 'enabled'?: boolean; - /** - * Object mapping creation timestamp - * @type {string} - * @memberof ObjectMappingResponse - */ - 'created'?: string; - /** - * Object mapping latest update timestamp - * @type {string} - * @memberof ObjectMappingResponse - */ - 'modified'?: string; -} - -export const ObjectMappingResponseObjectTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - AccessRequestConfig: 'ACCESS_REQUEST_CONFIG', - AttrSyncSourceConfig: 'ATTR_SYNC_SOURCE_CONFIG', - AuthOrg: 'AUTH_ORG', - CampaignFilter: 'CAMPAIGN_FILTER', - Entitlement: 'ENTITLEMENT', - FormDefinition: 'FORM_DEFINITION', - GovernanceGroup: 'GOVERNANCE_GROUP', - Identity: 'IDENTITY', - IdentityObjectConfig: 'IDENTITY_OBJECT_CONFIG', - IdentityProfile: 'IDENTITY_PROFILE', - LifecycleState: 'LIFECYCLE_STATE', - NotificationTemplate: 'NOTIFICATION_TEMPLATE', - PasswordPolicy: 'PASSWORD_POLICY', - PasswordSyncGroup: 'PASSWORD_SYNC_GROUP', - PublicIdentitiesConfig: 'PUBLIC_IDENTITIES_CONFIG', - Role: 'ROLE', - Rule: 'RULE', - Segment: 'SEGMENT', - ServiceDeskIntegration: 'SERVICE_DESK_INTEGRATION', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE', - Tag: 'TAG', - Transform: 'TRANSFORM', - TriggerSubscription: 'TRIGGER_SUBSCRIPTION', - Workflow: 'WORKFLOW' -} as const; - -export type ObjectMappingResponseObjectTypeV3 = typeof ObjectMappingResponseObjectTypeV3[keyof typeof ObjectMappingResponseObjectTypeV3]; - -/** - * - * @export - * @interface OktaVerificationRequest - */ -export interface OktaVerificationRequest { - /** - * User identifier for Verification request. The value of the user\'s attribute. - * @type {string} - * @memberof OktaVerificationRequest - */ - 'userId': string; -} -/** - * Operation on a specific criteria - * @export - * @enum {string} - */ - -export const Operation = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - And: 'AND', - Or: 'OR' -} as const; - -export type Operation = typeof Operation[keyof typeof Operation]; - - -/** - * - * @export - * @interface OriginalRequest - */ -export interface OriginalRequest { - /** - * Account ID. - * @type {string} - * @memberof OriginalRequest - */ - 'accountId'?: string; - /** - * - * @type {Result} - * @memberof OriginalRequest - */ - 'result'?: Result; - /** - * Attribute changes requested for account. - * @type {Array} - * @memberof OriginalRequest - */ - 'attributeRequests'?: Array; - /** - * Operation used. - * @type {string} - * @memberof OriginalRequest - */ - 'op'?: string; - /** - * - * @type {AccountSource} - * @memberof OriginalRequest - */ - 'source'?: AccountSource; -} -/** - * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) - * @export - * @interface OrphanIdentitiesReportArguments - */ -export interface OrphanIdentitiesReportArguments { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof OrphanIdentitiesReportArguments - */ - 'selectedFormats'?: Array; -} - -export const OrphanIdentitiesReportArgumentsSelectedFormatsV3 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type OrphanIdentitiesReportArgumentsSelectedFormatsV3 = typeof OrphanIdentitiesReportArgumentsSelectedFormatsV3[keyof typeof OrphanIdentitiesReportArgumentsSelectedFormatsV3]; - -/** - * Owner\'s identity. - * @export - * @interface OwnerDto - */ -export interface OwnerDto { - /** - * Owner\'s DTO type. - * @type {string} - * @memberof OwnerDto - */ - 'type'?: OwnerDtoTypeV3; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerDto - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof OwnerDto - */ - 'name'?: string; -} - -export const OwnerDtoTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerDtoTypeV3 = typeof OwnerDtoTypeV3[keyof typeof OwnerDtoTypeV3]; - -/** - * Owner of the object. - * @export - * @interface OwnerReference - */ -export interface OwnerReference { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReference - */ - 'type'?: OwnerReferenceTypeV3; - /** - * Owner\'s identity ID. - * @type {string} - * @memberof OwnerReference - */ - 'id'?: string; - /** - * Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReference - */ - 'name'?: string; -} - -export const OwnerReferenceTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceTypeV3 = typeof OwnerReferenceTypeV3[keyof typeof OwnerReferenceTypeV3]; - -/** - * The owner of this object. - * @export - * @interface OwnerReferenceSegments - */ -export interface OwnerReferenceSegments { - /** - * Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegments - */ - 'type'?: OwnerReferenceSegmentsTypeV3; - /** - * Identity id - * @type {string} - * @memberof OwnerReferenceSegments - */ - 'id'?: string; - /** - * Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof OwnerReferenceSegments - */ - 'name'?: string; -} - -export const OwnerReferenceSegmentsTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type OwnerReferenceSegmentsTypeV3 = typeof OwnerReferenceSegmentsTypeV3[keyof typeof OwnerReferenceSegmentsTypeV3]; - -/** - * - * @export - * @interface Owns - */ -export interface Owns { - /** - * - * @type {Array} - * @memberof Owns - */ - 'sources'?: Array; - /** - * - * @type {Array} - * @memberof Owns - */ - 'entitlements'?: Array; - /** - * - * @type {Array} - * @memberof Owns - */ - 'accessProfiles'?: Array; - /** - * - * @type {Array} - * @memberof Owns - */ - 'roles'?: Array; - /** - * - * @type {Array} - * @memberof Owns - */ - 'apps'?: Array; - /** - * - * @type {Array} - * @memberof Owns - */ - 'governanceGroups'?: Array; - /** - * - * @type {boolean} - * @memberof Owns - */ - 'fallbackApprover'?: boolean; -} -/** - * - * @export - * @interface PasswordChangeRequest - */ -export interface PasswordChangeRequest { - /** - * The identity ID that requested the password change - * @type {string} - * @memberof PasswordChangeRequest - */ - 'identityId'?: string; - /** - * The RSA encrypted password - * @type {string} - * @memberof PasswordChangeRequest - */ - 'encryptedPassword'?: string; - /** - * The encryption key ID - * @type {string} - * @memberof PasswordChangeRequest - */ - 'publicKeyId'?: string; - /** - * Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordChangeRequest - */ - 'accountId'?: string; - /** - * The ID of the source for which identity is requesting the password change - * @type {string} - * @memberof PasswordChangeRequest - */ - 'sourceId'?: string; -} -/** - * - * @export - * @interface PasswordChangeResponse - */ -export interface PasswordChangeResponse { - /** - * The password change request ID - * @type {string} - * @memberof PasswordChangeResponse - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordChangeResponse - */ - 'state'?: PasswordChangeResponseStateV3; -} - -export const PasswordChangeResponseStateV3 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordChangeResponseStateV3 = typeof PasswordChangeResponseStateV3[keyof typeof PasswordChangeResponseStateV3]; - -/** - * - * @export - * @interface PasswordInfo - */ -export interface PasswordInfo { - /** - * Identity ID - * @type {string} - * @memberof PasswordInfo - */ - 'identityId'?: string; - /** - * source ID - * @type {string} - * @memberof PasswordInfo - */ - 'sourceId'?: string; - /** - * public key ID - * @type {string} - * @memberof PasswordInfo - */ - 'publicKeyId'?: string; - /** - * User\'s public key with Base64 encoding - * @type {string} - * @memberof PasswordInfo - */ - 'publicKey'?: string; - /** - * Account info related to queried identity and source - * @type {Array} - * @memberof PasswordInfo - */ - 'accounts'?: Array; - /** - * Password constraints - * @type {Array} - * @memberof PasswordInfo - */ - 'policies'?: Array; -} -/** - * - * @export - * @interface PasswordInfoAccount - */ -export interface PasswordInfoAccount { - /** - * Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 - * @type {string} - * @memberof PasswordInfoAccount - */ - 'accountId'?: string; - /** - * Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 - * @type {string} - * @memberof PasswordInfoAccount - */ - 'accountName'?: string; -} -/** - * - * @export - * @interface PasswordInfoQueryDTO - */ -export interface PasswordInfoQueryDTO { - /** - * The login name of the user - * @type {string} - * @memberof PasswordInfoQueryDTO - */ - 'userName'?: string; - /** - * The display name of the source - * @type {string} - * @memberof PasswordInfoQueryDTO - */ - 'sourceName'?: string; -} -/** - * - * @export - * @interface PasswordOrgConfig - */ -export interface PasswordOrgConfig { - /** - * Indicator whether custom password instructions feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfig - */ - 'customInstructionsEnabled'?: boolean; - /** - * Indicator whether \"digit token\" feature is enabled. The default value is false. - * @type {boolean} - * @memberof PasswordOrgConfig - */ - 'digitTokenEnabled'?: boolean; - /** - * The duration of \"digit token\" in minutes. The default value is 5. - * @type {number} - * @memberof PasswordOrgConfig - */ - 'digitTokenDurationMinutes'?: number; - /** - * The length of \"digit token\". The default value is 6. - * @type {number} - * @memberof PasswordOrgConfig - */ - 'digitTokenLength'?: number; -} -/** - * - * @export - * @interface PasswordPolicyV3Dto - */ -export interface PasswordPolicyV3Dto { - /** - * The password policy Id. - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'id'?: string; - /** - * Description for current password policy. - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'description'?: string | null; - /** - * The name of the password policy. - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'name'?: string; - /** - * Date the Password Policy was created. - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'dateCreated'?: string; - /** - * Date the Password Policy was updated. - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'lastUpdated'?: string | null; - /** - * The number of days before expiration remaninder. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'firstExpirationReminder'?: number; - /** - * The minimun length of account Id. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'accountIdMinWordLength'?: number; - /** - * The minimun length of account name. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'accountNameMinWordLength'?: number; - /** - * Maximum alpha. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minAlpha'?: number; - /** - * MinCharacterTypes. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minCharacterTypes'?: number; - /** - * Maximum length of the password. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'maxLength'?: number; - /** - * Minimum length of the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minLength'?: number; - /** - * Maximum repetition of the same character in the password. By default is equals to -1. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'maxRepeatedChars'?: number; - /** - * Minimum amount of lower case character in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minLower'?: number; - /** - * Minimum amount of numeric characters in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minNumeric'?: number; - /** - * Minimum amount of special symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minSpecial'?: number; - /** - * Minimum amount of upper case symbols in the password. By default is equals to 0. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'minUpper'?: number; - /** - * Number of days before current password expires. By default is equals to 90. - * @type {number} - * @memberof PasswordPolicyV3Dto - */ - 'passwordExpiration'?: number; - /** - * Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'defaultPolicy'?: boolean; - /** - * Defines whether this policy is enabled to expire or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'enablePasswdExpiration'?: boolean; - /** - * Defines whether this policy require strong Auth or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'requireStrongAuthn'?: boolean; - /** - * Defines whether this policy require strong Auth of network or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'requireStrongAuthOffNetwork'?: boolean; - /** - * Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'requireStrongAuthUntrustedGeographies'?: boolean; - /** - * Defines whether this policy uses account attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'useAccountAttributes'?: boolean; - /** - * Defines whether this policy uses dictionary or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'useDictionary'?: boolean; - /** - * Defines whether this policy uses identity attributes or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'useIdentityAttributes'?: boolean; - /** - * Defines whether this policy validate against account id or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'validateAgainstAccountId'?: boolean; - /** - * Defines whether this policy validate against account name or not. This field is false by default. - * @type {boolean} - * @memberof PasswordPolicyV3Dto - */ - 'validateAgainstAccountName'?: boolean; - /** - * - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'created'?: string | null; - /** - * - * @type {string} - * @memberof PasswordPolicyV3Dto - */ - 'modified'?: string | null; - /** - * List of sources IDs managed by this password policy. - * @type {Array} - * @memberof PasswordPolicyV3Dto - */ - 'sourceIds'?: Array; -} -/** - * - * @export - * @interface PasswordStatus - */ -export interface PasswordStatus { - /** - * The password change request ID - * @type {string} - * @memberof PasswordStatus - */ - 'requestId'?: string | null; - /** - * Password change state - * @type {string} - * @memberof PasswordStatus - */ - 'state'?: PasswordStatusStateV3; - /** - * The errors during the password change request - * @type {Array} - * @memberof PasswordStatus - */ - 'errors'?: Array; - /** - * List of source IDs in the password change request - * @type {Array} - * @memberof PasswordStatus - */ - 'sourceIds'?: Array; -} - -export const PasswordStatusStateV3 = { - InProgress: 'IN_PROGRESS', - Finished: 'FINISHED', - Failed: 'FAILED' -} as const; - -export type PasswordStatusStateV3 = typeof PasswordStatusStateV3[keyof typeof PasswordStatusStateV3]; - -/** - * - * @export - * @interface PasswordSyncGroup - */ -export interface PasswordSyncGroup { - /** - * ID of the sync group - * @type {string} - * @memberof PasswordSyncGroup - */ - 'id'?: string; - /** - * Name of the sync group - * @type {string} - * @memberof PasswordSyncGroup - */ - 'name'?: string; - /** - * ID of the password policy - * @type {string} - * @memberof PasswordSyncGroup - */ - 'passwordPolicyId'?: string; - /** - * List of password managed sources IDs - * @type {Array} - * @memberof PasswordSyncGroup - */ - 'sourceIds'?: Array; - /** - * The date and time this sync group was created - * @type {string} - * @memberof PasswordSyncGroup - */ - 'created'?: string | null; - /** - * The date and time this sync group was last modified - * @type {string} - * @memberof PasswordSyncGroup - */ - 'modified'?: string | null; -} -/** - * Personal access token owner\'s identity. - * @export - * @interface PatOwner - */ -export interface PatOwner { - /** - * Personal access token owner\'s DTO type. - * @type {string} - * @memberof PatOwner - */ - 'type'?: PatOwnerTypeV3; - /** - * Personal access token owner\'s identity ID. - * @type {string} - * @memberof PatOwner - */ - 'id'?: string; - /** - * Personal access token owner\'s human-readable display name. - * @type {string} - * @memberof PatOwner - */ - 'name'?: string; -} - -export const PatOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type PatOwnerTypeV3 = typeof PatOwnerTypeV3[keyof typeof PatOwnerTypeV3]; - -/** - * - * @export - * @interface PendingApproval - */ -export interface PendingApproval { - /** - * The approval id. - * @type {string} - * @memberof PendingApproval - */ - 'id'?: string; - /** - * This is the access request id. - * @type {string} - * @memberof PendingApproval - */ - 'accessRequestId'?: string; - /** - * The name of the approval. - * @type {string} - * @memberof PendingApproval - */ - 'name'?: string; - /** - * When the approval was created. - * @type {string} - * @memberof PendingApproval - */ - 'created'?: string; - /** - * When the approval was modified last time. - * @type {string} - * @memberof PendingApproval - */ - 'modified'?: string; - /** - * When the access-request was created. - * @type {string} - * @memberof PendingApproval - */ - 'requestCreated'?: string; - /** - * - * @type {AccessRequestType} - * @memberof PendingApproval - */ - 'requestType'?: AccessRequestType | null; - /** - * - * @type {AccessItemRequester} - * @memberof PendingApproval - */ - 'requester'?: AccessItemRequester; - /** - * - * @type {AccessItemRequestedFor} - * @memberof PendingApproval - */ - 'requestedFor'?: AccessItemRequestedFor; - /** - * - * @type {PendingApprovalOwner} - * @memberof PendingApproval - */ - 'owner'?: PendingApprovalOwner; - /** - * - * @type {RequestableObjectReference} - * @memberof PendingApproval - */ - 'requestedObject'?: RequestableObjectReference; - /** - * - * @type {CommentDto} - * @memberof PendingApproval - */ - 'requesterComment'?: CommentDto; - /** - * The history of the previous reviewers comments. - * @type {Array} - * @memberof PendingApproval - */ - 'previousReviewersComments'?: Array; - /** - * The history of approval forward action. - * @type {Array} - * @memberof PendingApproval - */ - 'forwardHistory'?: Array; - /** - * When true the rejector has to provide comments when rejecting - * @type {boolean} - * @memberof PendingApproval - */ - 'commentRequiredWhenRejected'?: boolean; - /** - * - * @type {PendingApprovalAction} - * @memberof PendingApproval - */ - 'actionInProcess'?: PendingApprovalAction; - /** - * The date the role or access profile or entitlement is no longer assigned to the specified identity. - * @type {string} - * @memberof PendingApproval - */ - 'removeDate'?: string; - /** - * If true, then the request is to change the remove date or sunset date. - * @type {boolean} - * @memberof PendingApproval - */ - 'removeDateUpdateRequested'?: boolean; - /** - * The remove date or sunset date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApproval - */ - 'currentRemoveDate'?: string; - /** - * The date the role or access profile or entitlement is/will assigned to the specified identity. - * @type {string} - * @memberof PendingApproval - */ - 'startDate'?: string; - /** - * If true, then the request is to change the start date or sunrise date. - * @type {boolean} - * @memberof PendingApproval - */ - 'startUpdateRequested'?: boolean; - /** - * The start date or sunrise date that was assigned at the time of the request. - * @type {string} - * @memberof PendingApproval - */ - 'currentStartDate'?: string; - /** - * - * @type {SodViolationContextCheckCompleted} - * @memberof PendingApproval - */ - 'sodViolationContext'?: SodViolationContextCheckCompleted | null; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request item - * @type {{ [key: string]: string; }} - * @memberof PendingApproval - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof PendingApproval - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof PendingApproval - */ - 'privilegeLevel'?: string | null; - /** - * - * @type {PendingApprovalMaxPermittedAccessDuration} - * @memberof PendingApproval - */ - 'maxPermittedAccessDuration'?: PendingApprovalMaxPermittedAccessDuration | null; -} - - -/** - * Enum represents action that is being processed on an approval. - * @export - * @enum {string} - */ - -export const PendingApprovalAction = { - Approved: 'APPROVED', - Rejected: 'REJECTED', - Forwarded: 'FORWARDED' -} as const; - -export type PendingApprovalAction = typeof PendingApprovalAction[keyof typeof PendingApprovalAction]; - - -/** - * The maximum duration for which the access is permitted. - * @export - * @interface PendingApprovalMaxPermittedAccessDuration - */ -export interface PendingApprovalMaxPermittedAccessDuration { - /** - * The numeric value of the duration. - * @type {number} - * @memberof PendingApprovalMaxPermittedAccessDuration - */ - 'value'?: number; - /** - * The time unit for the duration. - * @type {string} - * @memberof PendingApprovalMaxPermittedAccessDuration - */ - 'timeUnit'?: PendingApprovalMaxPermittedAccessDurationTimeUnitV3; -} - -export const PendingApprovalMaxPermittedAccessDurationTimeUnitV3 = { - Hours: 'HOURS', - Days: 'DAYS', - Weeks: 'WEEKS', - Months: 'MONTHS' -} as const; - -export type PendingApprovalMaxPermittedAccessDurationTimeUnitV3 = typeof PendingApprovalMaxPermittedAccessDurationTimeUnitV3[keyof typeof PendingApprovalMaxPermittedAccessDurationTimeUnitV3]; - -/** - * Access item owner\'s identity. - * @export - * @interface PendingApprovalOwner - */ -export interface PendingApprovalOwner { - /** - * Access item owner\'s DTO type. - * @type {string} - * @memberof PendingApprovalOwner - */ - 'type'?: PendingApprovalOwnerTypeV3; - /** - * Access item owner\'s identity ID. - * @type {string} - * @memberof PendingApprovalOwner - */ - 'id'?: string; - /** - * Access item owner\'s human-readable display name. - * @type {string} - * @memberof PendingApprovalOwner - */ - 'name'?: string; -} - -export const PendingApprovalOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type PendingApprovalOwnerTypeV3 = typeof PendingApprovalOwnerTypeV3[keyof typeof PendingApprovalOwnerTypeV3]; - -/** - * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers. - * @export - * @interface PermissionDto - */ -export interface PermissionDto { - /** - * All the rights (e.g. actions) that this permission allows on the target - * @type {Array} - * @memberof PermissionDto - */ - 'rights'?: Array; - /** - * The target the permission would grants rights on. - * @type {string} - * @memberof PermissionDto - */ - 'target'?: string; -} -/** - * Provides additional details about the pre-approval trigger for this request. - * @export - * @interface PreApprovalTriggerDetails - */ -export interface PreApprovalTriggerDetails { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetails - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof PreApprovalTriggerDetails - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof PreApprovalTriggerDetails - */ - 'decision'?: PreApprovalTriggerDetailsDecisionV3; -} - -export const PreApprovalTriggerDetailsDecisionV3 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type PreApprovalTriggerDetailsDecisionV3 = typeof PreApprovalTriggerDetailsDecisionV3[keyof typeof PreApprovalTriggerDetailsDecisionV3]; - -/** - * - * @export - * @interface ProcessingDetails - */ -export interface ProcessingDetails { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof ProcessingDetails - */ - 'date'?: string | null; - /** - * - * @type {string} - * @memberof ProcessingDetails - */ - 'stage'?: string; - /** - * - * @type {number} - * @memberof ProcessingDetails - */ - 'retryCount'?: number; - /** - * - * @type {string} - * @memberof ProcessingDetails - */ - 'stackTrace'?: string; - /** - * - * @type {string} - * @memberof ProcessingDetails - */ - 'message'?: string; -} -/** - * Specification of a Service Desk integration provisioning configuration. - * @export - * @interface ProvisioningConfig - */ -export interface ProvisioningConfig { - /** - * Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. - * @type {boolean} - * @memberof ProvisioningConfig - */ - 'universalManager'?: boolean; - /** - * References to sources for the Service Desk integration template. May only be specified if universalManager is false. - * @type {Array} - * @memberof ProvisioningConfig - */ - 'managedResourceRefs'?: Array; - /** - * - * @type {ProvisioningConfigPlanInitializerScript} - * @memberof ProvisioningConfig - */ - 'planInitializerScript'?: ProvisioningConfigPlanInitializerScript | null; - /** - * Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. - * @type {boolean} - * @memberof ProvisioningConfig - */ - 'noProvisioningRequests'?: boolean; - /** - * When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. - * @type {number} - * @memberof ProvisioningConfig - */ - 'provisioningRequestExpiration'?: number; -} -/** - * This is a reference to a plan initializer script. - * @export - * @interface ProvisioningConfigPlanInitializerScript - */ -export interface ProvisioningConfigPlanInitializerScript { - /** - * This is a Rule that allows provisioning instruction changes. - * @type {string} - * @memberof ProvisioningConfigPlanInitializerScript - */ - 'source'?: string; -} -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel1 - */ -export interface ProvisioningCriteriaLevel1 { - /** - * - * @type {ProvisioningCriteriaOperation} - * @memberof ProvisioningCriteriaLevel1 - */ - 'operation'?: ProvisioningCriteriaOperation; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel1 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel1 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel1 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel2 - */ -export interface ProvisioningCriteriaLevel2 { - /** - * - * @type {ProvisioningCriteriaOperation} - * @memberof ProvisioningCriteriaLevel2 - */ - 'operation'?: ProvisioningCriteriaOperation; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel2 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel2 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {Array} - * @memberof ProvisioningCriteriaLevel2 - */ - 'children'?: Array | null; -} - - -/** - * Defines matching criteria for an account to be provisioned with a specific access profile. - * @export - * @interface ProvisioningCriteriaLevel3 - */ -export interface ProvisioningCriteriaLevel3 { - /** - * - * @type {ProvisioningCriteriaOperation} - * @memberof ProvisioningCriteriaLevel3 - */ - 'operation'?: ProvisioningCriteriaOperation; - /** - * Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. - * @type {string} - * @memberof ProvisioningCriteriaLevel3 - */ - 'attribute'?: string | null; - /** - * String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. - * @type {string} - * @memberof ProvisioningCriteriaLevel3 - */ - 'value'?: string | null; - /** - * Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. - * @type {string} - * @memberof ProvisioningCriteriaLevel3 - */ - 'children'?: string | null; -} - - -/** - * Supported operations on `ProvisioningCriteria`. - * @export - * @enum {string} - */ - -export const ProvisioningCriteriaOperation = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - Has: 'HAS', - And: 'AND', - Or: 'OR' -} as const; - -export type ProvisioningCriteriaOperation = typeof ProvisioningCriteriaOperation[keyof typeof ProvisioningCriteriaOperation]; - - -/** - * Provides additional details about provisioning for this request. - * @export - * @interface ProvisioningDetails - */ -export interface ProvisioningDetails { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof ProvisioningDetails - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * - * @export - * @interface ProvisioningPolicy - */ -export interface ProvisioningPolicy { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicy - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicy - */ - 'description'?: string; - /** - * - * @type {UsageType} - * @memberof ProvisioningPolicy - */ - 'usageType'?: UsageType; - /** - * - * @type {Array} - * @memberof ProvisioningPolicy - */ - 'fields'?: Array; -} - - -/** - * - * @export - * @interface ProvisioningPolicyDto - */ -export interface ProvisioningPolicyDto { - /** - * the provisioning policy name - * @type {string} - * @memberof ProvisioningPolicyDto - */ - 'name': string | null; - /** - * the description of the provisioning policy - * @type {string} - * @memberof ProvisioningPolicyDto - */ - 'description'?: string; - /** - * - * @type {UsageType} - * @memberof ProvisioningPolicyDto - */ - 'usageType'?: UsageType; - /** - * - * @type {Array} - * @memberof ProvisioningPolicyDto - */ - 'fields'?: Array; -} - - -/** - * Provisioning state of an account activity item - * @export - * @enum {string} - */ - -export const ProvisioningState = { - Pending: 'PENDING', - Finished: 'FINISHED', - Unverifiable: 'UNVERIFIABLE', - Commited: 'COMMITED', - Failed: 'FAILED', - Retry: 'RETRY' -} as const; - -export type ProvisioningState = typeof ProvisioningState[keyof typeof ProvisioningState]; - - -/** - * Details about a public identity - * @export - * @interface PublicIdentity - */ -export interface PublicIdentity { - /** - * Identity id - * @type {string} - * @memberof PublicIdentity - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof PublicIdentity - */ - 'name'?: string; - /** - * Alternate unique identifier for the identity. - * @type {string} - * @memberof PublicIdentity - */ - 'alias'?: string; - /** - * Email address of identity. - * @type {string} - * @memberof PublicIdentity - */ - 'email'?: string | null; - /** - * The lifecycle status for the identity - * @type {string} - * @memberof PublicIdentity - */ - 'status'?: string | null; - /** - * The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. - * @type {string} - * @memberof PublicIdentity - */ - 'identityState'?: PublicIdentityIdentityStateV3 | null; - /** - * - * @type {IdentityReference} - * @memberof PublicIdentity - */ - 'manager'?: IdentityReference | null; - /** - * The public identity attributes of the identity - * @type {Array} - * @memberof PublicIdentity - */ - 'attributes'?: Array; -} - -export const PublicIdentityIdentityStateV3 = { - Active: 'ACTIVE', - InactiveShortTerm: 'INACTIVE_SHORT_TERM', - InactiveLongTerm: 'INACTIVE_LONG_TERM' -} as const; - -export type PublicIdentityIdentityStateV3 = typeof PublicIdentityIdentityStateV3[keyof typeof PublicIdentityIdentityStateV3]; - -/** - * Used to map an attribute key for an Identity to its display name. - * @export - * @interface PublicIdentityAttributeConfig - */ -export interface PublicIdentityAttributeConfig { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributeConfig - */ - 'key'?: string; - /** - * The attribute display name - * @type {string} - * @memberof PublicIdentityAttributeConfig - */ - 'name'?: string; -} -/** - * - * @export - * @interface PublicIdentityAttributesInner - */ -export interface PublicIdentityAttributesInner { - /** - * The attribute key - * @type {string} - * @memberof PublicIdentityAttributesInner - */ - 'key'?: string; - /** - * Human-readable display name of the attribute - * @type {string} - * @memberof PublicIdentityAttributesInner - */ - 'name'?: string; - /** - * The attribute value - * @type {string} - * @memberof PublicIdentityAttributesInner - */ - 'value'?: string | null; -} -/** - * Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - * @export - * @interface PublicIdentityConfig - */ -export interface PublicIdentityConfig { - /** - * Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - * @type {Array} - * @memberof PublicIdentityConfig - */ - 'attributes'?: Array; - /** - * When this configuration was last modified. - * @type {string} - * @memberof PublicIdentityConfig - */ - 'modified'?: string | null; - /** - * - * @type {IdentityReference} - * @memberof PublicIdentityConfig - */ - 'modifiedBy'?: IdentityReference | null; -} -/** - * @type PutClientLogConfigurationRequest - * @export - */ -export type PutClientLogConfigurationRequest = ClientLogConfigurationDurationMinutes | ClientLogConfigurationExpiration; - -/** - * - * @export - * @interface PutConnectorSourceConfigRequest - */ -export interface PutConnectorSourceConfigRequest { - /** - * connector source config xml file - * @type {File} - * @memberof PutConnectorSourceConfigRequest - */ - 'file': File; -} -/** - * - * @export - * @interface PutConnectorSourceTemplateRequest - */ -export interface PutConnectorSourceTemplateRequest { - /** - * connector source template xml file - * @type {File} - * @memberof PutConnectorSourceTemplateRequest - */ - 'file': File; -} -/** - * - * @export - * @interface PutPasswordDictionaryRequest - */ -export interface PutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PutPasswordDictionaryRequest - */ - 'file'?: File; -} -/** - * Query parameters used to construct an Elasticsearch query object. - * @export - * @interface Query - */ -export interface Query { - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof Query - */ - 'query'?: string; - /** - * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. - * @type {string} - * @memberof Query - */ - 'fields'?: string; - /** - * The time zone to be applied to any range query related to dates. - * @type {string} - * @memberof Query - */ - 'timeZone'?: string; - /** - * - * @type {InnerHit} - * @memberof Query - */ - 'innerHit'?: InnerHit; -} -/** - * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - * @export - * @interface QueryResultFilter - */ -export interface QueryResultFilter { - /** - * The list of field names to include in the result documents. - * @type {Array} - * @memberof QueryResultFilter - */ - 'includes'?: Array; - /** - * The list of field names to exclude from the result documents. - * @type {Array} - * @memberof QueryResultFilter - */ - 'excludes'?: Array; -} -/** - * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const QueryType = { - Dsl: 'DSL', - Sailpoint: 'SAILPOINT', - Text: 'TEXT', - Typeahead: 'TYPEAHEAD' -} as const; - -export type QueryType = typeof QueryType[keyof typeof QueryType]; - - -/** - * Configuration of maximum number of days and interval for checking Service Desk integration queue status. - * @export - * @interface QueuedCheckConfigDetails - */ -export interface QueuedCheckConfigDetails { - /** - * Interval in minutes between status checks - * @type {string} - * @memberof QueuedCheckConfigDetails - */ - 'provisioningStatusCheckIntervalMinutes': string; - /** - * Maximum number of days to check - * @type {string} - * @memberof QueuedCheckConfigDetails - */ - 'provisioningMaxStatusCheckDays': string; -} -/** - * - * @export - * @interface RandomAlphaNumeric - */ -export interface RandomAlphaNumeric { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomAlphaNumeric - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomAlphaNumeric - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomAlphaNumeric - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface RandomNumeric - */ -export interface RandomNumeric { - /** - * This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters - * @type {string} - * @memberof RandomNumeric - */ - 'length'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RandomNumeric - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RandomNumeric - */ - 'input'?: { [key: string]: any; }; -} -/** - * The range of values to be filtered. - * @export - * @interface Range - */ -export interface Range { - /** - * - * @type {Bound} - * @memberof Range - */ - 'lower'?: Bound; - /** - * - * @type {Bound} - * @memberof Range - */ - 'upper'?: Bound; -} -/** - * - * @export - * @interface ReassignReference - */ -export interface ReassignReference { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignReference - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignReference - */ - 'type': ReassignReferenceTypeV3; -} - -export const ReassignReferenceTypeV3 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignReferenceTypeV3 = typeof ReassignReferenceTypeV3[keyof typeof ReassignReferenceTypeV3]; - -/** - * - * @export - * @interface Reassignment - */ -export interface Reassignment { - /** - * - * @type {CertificationReference} - * @memberof Reassignment - */ - 'from'?: CertificationReference; - /** - * The comment entered when the Certification was reassigned - * @type {string} - * @memberof Reassignment - */ - 'comment'?: string; -} -/** - * - * @export - * @interface ReassignmentReference - */ -export interface ReassignmentReference { - /** - * The ID of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReference - */ - 'id': string; - /** - * The type of item or identity being reassigned. - * @type {string} - * @memberof ReassignmentReference - */ - 'type': ReassignmentReferenceTypeV3; -} - -export const ReassignmentReferenceTypeV3 = { - TargetSummary: 'TARGET_SUMMARY', - Item: 'ITEM', - IdentitySummary: 'IDENTITY_SUMMARY' -} as const; - -export type ReassignmentReferenceTypeV3 = typeof ReassignmentReferenceTypeV3[keyof typeof ReassignmentReferenceTypeV3]; - -/** - * - * @export - * @interface ReassignmentTrailDTO - */ -export interface ReassignmentTrailDTO { - /** - * The ID of previous owner identity. - * @type {string} - * @memberof ReassignmentTrailDTO - */ - 'previousOwner'?: string; - /** - * The ID of new owner identity. - * @type {string} - * @memberof ReassignmentTrailDTO - */ - 'newOwner'?: string; - /** - * The type of reassignment. - * @type {string} - * @memberof ReassignmentTrailDTO - */ - 'reassignmentType'?: string; -} -/** - * The approval reassignment type. * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task\'s owner, from their queue to someone else\'s. * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to that approver\'s reassignment configuration. The approver\'s reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver\'s queue, according to the request\'s escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). - * @export - * @enum {string} - */ - -export const ReassignmentType = { - ManualReassignment: 'MANUAL_REASSIGNMENT', - AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT', - AutoEscalation: 'AUTO_ESCALATION', - SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' -} as const; - -export type ReassignmentType = typeof ReassignmentType[keyof typeof ReassignmentType]; - - -/** - * - * @export - * @interface Recommendation - */ -export interface Recommendation { - /** - * Recommended type of account. - * @type {string} - * @memberof Recommendation - */ - 'type': RecommendationTypeV3; - /** - * Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. - * @type {string} - * @memberof Recommendation - */ - 'method': RecommendationMethodV3; -} - -export const RecommendationTypeV3 = { - Human: 'HUMAN', - Machine: 'MACHINE' -} as const; - -export type RecommendationTypeV3 = typeof RecommendationTypeV3[keyof typeof RecommendationTypeV3]; -export const RecommendationMethodV3 = { - Discovery: 'DISCOVERY', - Source: 'SOURCE', - Criteria: 'CRITERIA' -} as const; - -export type RecommendationMethodV3 = typeof RecommendationMethodV3[keyof typeof RecommendationMethodV3]; - -/** - * - * @export - * @interface Reference - */ -export interface Reference { - /** - * This ID specifies the name of the pre-existing transform which you want to use within your current transform - * @type {string} - * @memberof Reference - */ - 'id': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Reference - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Reference - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface Reference1 - */ -export interface Reference1 { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof Reference1 - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof Reference1 - */ - 'name'?: string; -} -/** - * - * @export - * @interface RemediationItemDetails - */ -export interface RemediationItemDetails { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItemDetails - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItemDetails - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItemDetails - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItemDetails - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItemDetails - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItemDetails - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItemDetails - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItemDetails - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItemDetails - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface RemediationItems - */ -export interface RemediationItems { - /** - * The ID of the certification - * @type {string} - * @memberof RemediationItems - */ - 'id'?: string; - /** - * The ID of the certification target - * @type {string} - * @memberof RemediationItems - */ - 'targetId'?: string; - /** - * The name of the certification target - * @type {string} - * @memberof RemediationItems - */ - 'targetName'?: string; - /** - * The display name of the certification target - * @type {string} - * @memberof RemediationItems - */ - 'targetDisplayName'?: string; - /** - * The name of the application/source - * @type {string} - * @memberof RemediationItems - */ - 'applicationName'?: string; - /** - * The name of the attribute being certified - * @type {string} - * @memberof RemediationItems - */ - 'attributeName'?: string; - /** - * The operation of the certification on the attribute - * @type {string} - * @memberof RemediationItems - */ - 'attributeOperation'?: string; - /** - * The value of the attribute being certified - * @type {string} - * @memberof RemediationItems - */ - 'attributeValue'?: string; - /** - * The native identity of the target - * @type {string} - * @memberof RemediationItems - */ - 'nativeIdentity'?: string; -} -/** - * - * @export - * @interface Replace - */ -export interface Replace { - /** - * This can be a string or a regex pattern in which you want to replace. - * @type {string} - * @memberof Replace - */ - 'regex': string; - /** - * This is the replacement string that should be substituded wherever the string or pattern is found. - * @type {string} - * @memberof Replace - */ - 'replacement': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Replace - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Replace - */ - 'input'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface ReplaceAll - */ -export interface ReplaceAll { - /** - * An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAll - */ - 'table': { [key: string]: any; }; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof ReplaceAll - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof ReplaceAll - */ - 'input'?: { [key: string]: any; }; -} -/** - * Details about report to be processed. - * @export - * @interface ReportDetails - */ -export interface ReportDetails { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportDetails - */ - 'reportType'?: ReportDetailsReportTypeV3; - /** - * - * @type {ReportDetailsArguments} - * @memberof ReportDetails - */ - 'arguments'?: ReportDetailsArguments; -} - -export const ReportDetailsReportTypeV3 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportDetailsReportTypeV3 = typeof ReportDetailsReportTypeV3[keyof typeof ReportDetailsReportTypeV3]; - -/** - * The string-object map(dictionary) with the arguments needed for report processing. - * @export - * @interface ReportDetailsArguments - */ -export interface ReportDetailsArguments { - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArguments - */ - 'application': string; - /** - * Source name. - * @type {string} - * @memberof ReportDetailsArguments - */ - 'sourceName': string; - /** - * Flag to specify if only correlated identities are included in report. - * @type {boolean} - * @memberof ReportDetailsArguments - */ - 'correlatedOnly': boolean; - /** - * Source ID. - * @type {string} - * @memberof ReportDetailsArguments - */ - 'authoritativeSource': string; - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportDetailsArguments - */ - 'selectedFormats'?: Array; - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof ReportDetailsArguments - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof ReportDetailsArguments - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof ReportDetailsArguments - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof ReportDetailsArguments - */ - 'sort'?: Array; -} - -export const ReportDetailsArgumentsSelectedFormatsV3 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportDetailsArgumentsSelectedFormatsV3 = typeof ReportDetailsArgumentsSelectedFormatsV3[keyof typeof ReportDetailsArgumentsSelectedFormatsV3]; - -/** - * - * @export - * @interface ReportResultReference - */ -export interface ReportResultReference { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof ReportResultReference - */ - 'type'?: ReportResultReferenceTypeV3; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof ReportResultReference - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof ReportResultReference - */ - 'name'?: string; - /** - * Status of a SOD policy violation report. - * @type {string} - * @memberof ReportResultReference - */ - 'status'?: ReportResultReferenceStatusV3; -} - -export const ReportResultReferenceTypeV3 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type ReportResultReferenceTypeV3 = typeof ReportResultReferenceTypeV3[keyof typeof ReportResultReferenceTypeV3]; -export const ReportResultReferenceStatusV3 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR', - Pending: 'PENDING' -} as const; - -export type ReportResultReferenceStatusV3 = typeof ReportResultReferenceStatusV3[keyof typeof ReportResultReferenceStatusV3]; - -/** - * Details about report result or current state. - * @export - * @interface ReportResults - */ -export interface ReportResults { - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof ReportResults - */ - 'reportType'?: ReportResultsReportTypeV3; - /** - * Name of the task definition which is started to process requesting report. Usually the same as report name - * @type {string} - * @memberof ReportResults - */ - 'taskDefName'?: string; - /** - * Unique task definition identifier. - * @type {string} - * @memberof ReportResults - */ - 'id'?: string; - /** - * Report processing start date - * @type {string} - * @memberof ReportResults - */ - 'created'?: string; - /** - * Report current state or result status. - * @type {string} - * @memberof ReportResults - */ - 'status'?: ReportResultsStatusV3; - /** - * Report processing time in ms. - * @type {number} - * @memberof ReportResults - */ - 'duration'?: number; - /** - * Report size in rows. - * @type {number} - * @memberof ReportResults - */ - 'rows'?: number; - /** - * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof ReportResults - */ - 'availableFormats'?: Array; -} - -export const ReportResultsReportTypeV3 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type ReportResultsReportTypeV3 = typeof ReportResultsReportTypeV3[keyof typeof ReportResultsReportTypeV3]; -export const ReportResultsStatusV3 = { - Success: 'SUCCESS', - Failure: 'FAILURE', - Warning: 'WARNING', - Terminated: 'TERMINATED' -} as const; - -export type ReportResultsStatusV3 = typeof ReportResultsStatusV3[keyof typeof ReportResultsStatusV3]; -export const ReportResultsAvailableFormatsV3 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type ReportResultsAvailableFormatsV3 = typeof ReportResultsAvailableFormatsV3[keyof typeof ReportResultsAvailableFormatsV3]; - -/** - * type of a Report - * @export - * @enum {string} - */ - -export const ReportType = { - CampaignCompositionReport: 'CAMPAIGN_COMPOSITION_REPORT', - CampaignRemediationStatusReport: 'CAMPAIGN_REMEDIATION_STATUS_REPORT', - CampaignStatusReport: 'CAMPAIGN_STATUS_REPORT', - CertificationSignoffReport: 'CERTIFICATION_SIGNOFF_REPORT' -} as const; - -export type ReportType = typeof ReportType[keyof typeof ReportType]; - - -/** - * - * @export - * @interface RequestOnBehalfOfConfig - */ -export interface RequestOnBehalfOfConfig { - /** - * If this is true, anyone can request access for anyone. - * @type {boolean} - * @memberof RequestOnBehalfOfConfig - */ - 'allowRequestOnBehalfOfAnyoneByAnyone'?: boolean; - /** - * If this is true, a manager can request access for his or her direct reports. - * @type {boolean} - * @memberof RequestOnBehalfOfConfig - */ - 'allowRequestOnBehalfOfEmployeeByManager'?: boolean; -} -/** - * - * @export - * @interface Requestability - */ -export interface Requestability { - /** - * Indicates whether the requester of the containing object must provide comments justifying the request. - * @type {boolean} - * @memberof Requestability - */ - 'commentsRequired'?: boolean | null; - /** - * Indicates whether an approver must provide comments when denying the request. - * @type {boolean} - * @memberof Requestability - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof Requestability - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof Requestability - */ - 'requireEndDate'?: boolean | null; - /** - * - * @type {AccessDuration} - * @memberof Requestability - */ - 'maxPermittedAccessDuration'?: AccessDuration | null; - /** - * List describing the steps involved in approving the request. - * @type {Array} - * @memberof Requestability - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RequestabilityForRole - */ -export interface RequestabilityForRole { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RequestabilityForRole - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RequestabilityForRole - */ - 'denialCommentsRequired'?: boolean | null; - /** - * Indicates whether reauthorization is required for the request. - * @type {boolean} - * @memberof RequestabilityForRole - */ - 'reauthorizationRequired'?: boolean | null; - /** - * Indicates whether the requester of the containing object must provide access end date. - * @type {boolean} - * @memberof RequestabilityForRole - */ - 'requireEndDate'?: boolean; - /** - * - * @type {AccessDuration} - * @memberof RequestabilityForRole - */ - 'maxPermittedAccessDuration'?: AccessDuration | null; - /** - * List describing the steps in approving the request - * @type {Array} - * @memberof RequestabilityForRole - */ - 'approvalSchemes'?: Array; - /** - * The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. - * @type {string} - * @memberof RequestabilityForRole - */ - 'formDefinitionId'?: string | null; -} -/** - * - * @export - * @interface RequestableObject - */ -export interface RequestableObject { - /** - * Id of the requestable object itself - * @type {string} - * @memberof RequestableObject - */ - 'id'?: string; - /** - * Human-readable display name of the requestable object - * @type {string} - * @memberof RequestableObject - */ - 'name'?: string; - /** - * The time when the requestable object was created - * @type {string} - * @memberof RequestableObject - */ - 'created'?: string; - /** - * The time when the requestable object was last modified - * @type {string} - * @memberof RequestableObject - */ - 'modified'?: string | null; - /** - * Description of the requestable object. - * @type {string} - * @memberof RequestableObject - */ - 'description'?: string | null; - /** - * - * @type {RequestableObjectType} - * @memberof RequestableObject - */ - 'type'?: RequestableObjectType; - /** - * - * @type {RequestableObjectRequestStatus & object} - * @memberof RequestableObject - */ - 'requestStatus'?: RequestableObjectRequestStatus & object; - /** - * If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - * @type {string} - * @memberof RequestableObject - */ - 'identityRequestId'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmail} - * @memberof RequestableObject - */ - 'ownerRef'?: IdentityReferenceWithNameAndEmail | null; - /** - * Whether the requester must provide comments when requesting the object. - * @type {boolean} - * @memberof RequestableObject - */ - 'requestCommentsRequired'?: boolean; -} - - -/** - * - * @export - * @interface RequestableObjectReference - */ -export interface RequestableObjectReference { - /** - * Id of the object. - * @type {string} - * @memberof RequestableObjectReference - */ - 'id'?: string; - /** - * Name of the object. - * @type {string} - * @memberof RequestableObjectReference - */ - 'name'?: string; - /** - * Description of the object. - * @type {string} - * @memberof RequestableObjectReference - */ - 'description'?: string; - /** - * Type of the object. - * @type {string} - * @memberof RequestableObjectReference - */ - 'type'?: RequestableObjectReferenceTypeV3; -} - -export const RequestableObjectReferenceTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectReferenceTypeV3 = typeof RequestableObjectReferenceTypeV3[keyof typeof RequestableObjectReferenceTypeV3]; - -/** - * Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results. - * @export - * @enum {string} - */ - -export const RequestableObjectRequestStatus = { - Available: 'AVAILABLE', - Pending: 'PENDING', - Assigned: 'ASSIGNED' -} as const; - -export type RequestableObjectRequestStatus = typeof RequestableObjectRequestStatus[keyof typeof RequestableObjectRequestStatus]; - - -/** - * Currently supported requestable object types. - * @export - * @enum {string} - */ - -export const RequestableObjectType = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestableObjectType = typeof RequestableObjectType[keyof typeof RequestableObjectType]; - - -/** - * - * @export - * @interface RequestedAccountRef - */ -export interface RequestedAccountRef { - /** - * Display name of the account for the user - * @type {string} - * @memberof RequestedAccountRef - */ - 'name'?: string; - /** - * - * @type {DtoType} - * @memberof RequestedAccountRef - */ - 'type'?: DtoType; - /** - * The uuid for the account - * @type {string} - * @memberof RequestedAccountRef - */ - 'accountUuid'?: string | null; - /** - * The native identity for the account - * @type {string} - * @memberof RequestedAccountRef - */ - 'accountId'?: string | null; - /** - * Display name of the source for the account - * @type {string} - * @memberof RequestedAccountRef - */ - 'sourceName'?: string; -} - - -/** - * - * @export - * @interface RequestedForDtoRef - */ -export interface RequestedForDtoRef { - /** - * The identity id for which the access is requested - * @type {string} - * @memberof RequestedForDtoRef - */ - 'identityId': string; - /** - * the details for the access items that are requested for the identity - * @type {Array} - * @memberof RequestedForDtoRef - */ - 'requestedItems': Array; -} -/** - * - * @export - * @interface RequestedItemDetails - */ -export interface RequestedItemDetails { - /** - * The type of access item requested. - * @type {string} - * @memberof RequestedItemDetails - */ - 'type'?: RequestedItemDetailsTypeV3; - /** - * The id of the access item requested. - * @type {string} - * @memberof RequestedItemDetails - */ - 'id'?: string; -} - -export const RequestedItemDetailsTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT', - Role: 'ROLE' -} as const; - -export type RequestedItemDetailsTypeV3 = typeof RequestedItemDetailsTypeV3[keyof typeof RequestedItemDetailsTypeV3]; - -/** - * - * @export - * @interface RequestedItemDtoRef - */ -export interface RequestedItemDtoRef { - /** - * The type of the item being requested. - * @type {string} - * @memberof RequestedItemDtoRef - */ - 'type': RequestedItemDtoRefTypeV3; - /** - * ID of Role, Access Profile or Entitlement being requested. - * @type {string} - * @memberof RequestedItemDtoRef - */ - 'id': string; - /** - * Comment provided by requester. * Comment is required when the request is of type Revoke Access. - * @type {string} - * @memberof RequestedItemDtoRef - */ - 'comment'?: string; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. - * @type {{ [key: string]: string; }} - * @memberof RequestedItemDtoRef - */ - 'clientMetadata'?: { [key: string]: string; }; - /** - * The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. - * @type {string} - * @memberof RequestedItemDtoRef - */ - 'startDate'?: string; - /** - * The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. - * @type {string} - * @memberof RequestedItemDtoRef - */ - 'removeDate'?: string; - /** - * The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account - * @type {Array} - * @memberof RequestedItemDtoRef - */ - 'accountSelection'?: Array | null; -} - -export const RequestedItemDtoRefTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemDtoRefTypeV3 = typeof RequestedItemDtoRefTypeV3[keyof typeof RequestedItemDtoRefTypeV3]; - -/** - * - * @export - * @interface RequestedItemStatus - */ -export interface RequestedItemStatus { - /** - * The ID of the access request. - * @type {string} - * @memberof RequestedItemStatus - */ - 'id'?: string; - /** - * Human-readable display name of the item being requested. - * @type {string} - * @memberof RequestedItemStatus - */ - 'name'?: string | null; - /** - * Type of requested object. - * @type {string} - * @memberof RequestedItemStatus - */ - 'type'?: RequestedItemStatusTypeV3 | null; - /** - * - * @type {RequestedItemStatusCancelledRequestDetails} - * @memberof RequestedItemStatus - */ - 'cancelledRequestDetails'?: RequestedItemStatusCancelledRequestDetails; - /** - * List of list of localized error messages, if any, encountered during the approval/provisioning process. - * @type {Array>} - * @memberof RequestedItemStatus - */ - 'errorMessages'?: Array> | null; - /** - * - * @type {RequestedItemStatusRequestState} - * @memberof RequestedItemStatus - */ - 'state'?: RequestedItemStatusRequestState; - /** - * Approval details for each item. - * @type {Array} - * @memberof RequestedItemStatus - */ - 'approvalDetails'?: Array; - /** - * List of approval IDs associated with the request. - * @type {Array} - * @memberof RequestedItemStatus - */ - 'approvalIds'?: Array | null; - /** - * Manual work items created for provisioning the item. - * @type {Array} - * @memberof RequestedItemStatus - */ - 'manualWorkItemDetails'?: Array | null; - /** - * Id of associated account activity item. - * @type {string} - * @memberof RequestedItemStatus - */ - 'accountActivityItemId'?: string; - /** - * - * @type {AccessRequestType} - * @memberof RequestedItemStatus - */ - 'requestType'?: AccessRequestType | null; - /** - * When the request was last modified. - * @type {string} - * @memberof RequestedItemStatus - */ - 'modified'?: string | null; - /** - * When the request was created. - * @type {string} - * @memberof RequestedItemStatus - */ - 'created'?: string; - /** - * - * @type {AccessItemRequester} - * @memberof RequestedItemStatus - */ - 'requester'?: AccessItemRequester; - /** - * - * @type {RequestedItemStatusRequestedFor} - * @memberof RequestedItemStatus - */ - 'requestedFor'?: RequestedItemStatusRequestedFor; - /** - * - * @type {RequestedItemStatusRequesterComment} - * @memberof RequestedItemStatus - */ - 'requesterComment'?: RequestedItemStatusRequesterComment; - /** - * - * @type {RequestedItemStatusSodViolationContext} - * @memberof RequestedItemStatus - */ - 'sodViolationContext'?: RequestedItemStatusSodViolationContext; - /** - * - * @type {RequestedItemStatusProvisioningDetails} - * @memberof RequestedItemStatus - */ - 'provisioningDetails'?: RequestedItemStatusProvisioningDetails; - /** - * - * @type {RequestedItemStatusPreApprovalTriggerDetails} - * @memberof RequestedItemStatus - */ - 'preApprovalTriggerDetails'?: RequestedItemStatusPreApprovalTriggerDetails; - /** - * A list of Phases that the Access Request has gone through in order, to help determine the status of the request. - * @type {Array} - * @memberof RequestedItemStatus - */ - 'accessRequestPhases'?: Array | null; - /** - * Description associated to the requested object. - * @type {string} - * @memberof RequestedItemStatus - */ - 'description'?: string | null; - /** - * When the role access is scheduled for provisioning. - * @type {string} - * @memberof RequestedItemStatus - */ - 'startDate'?: string | null; - /** - * When the role access is scheduled for removal. - * @type {string} - * @memberof RequestedItemStatus - */ - 'removeDate'?: string | null; - /** - * True if the request can be canceled. - * @type {boolean} - * @memberof RequestedItemStatus - */ - 'cancelable'?: boolean; - /** - * This is the account activity id. - * @type {string} - * @memberof RequestedItemStatus - */ - 'accessRequestId'?: string; - /** - * Arbitrary key-value pairs, if any were included in the corresponding access request - * @type {{ [key: string]: string; }} - * @memberof RequestedItemStatus - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. - * @type {Array} - * @memberof RequestedItemStatus - */ - 'requestedAccounts'?: Array | null; - /** - * The privilege level of the requested access item, if applicable. - * @type {string} - * @memberof RequestedItemStatus - */ - 'privilegeLevel'?: string | null; -} - -export const RequestedItemStatusTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RequestedItemStatusTypeV3 = typeof RequestedItemStatusTypeV3[keyof typeof RequestedItemStatusTypeV3]; - -/** - * - * @export - * @interface RequestedItemStatusCancelledRequestDetails - */ -export interface RequestedItemStatusCancelledRequestDetails { - /** - * Comment made by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetails - */ - 'comment'?: string; - /** - * - * @type {OwnerDto} - * @memberof RequestedItemStatusCancelledRequestDetails - */ - 'owner'?: OwnerDto; - /** - * Date comment was added by the owner when cancelling the associated request. - * @type {string} - * @memberof RequestedItemStatusCancelledRequestDetails - */ - 'modified'?: string; -} -/** - * - * @export - * @interface RequestedItemStatusPreApprovalTriggerDetails - */ -export interface RequestedItemStatusPreApprovalTriggerDetails { - /** - * Comment left for the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetails - */ - 'comment'?: string; - /** - * The reviewer of the pre-approval decision - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetails - */ - 'reviewer'?: string; - /** - * The decision of the pre-approval trigger - * @type {string} - * @memberof RequestedItemStatusPreApprovalTriggerDetails - */ - 'decision'?: RequestedItemStatusPreApprovalTriggerDetailsDecisionV3; -} - -export const RequestedItemStatusPreApprovalTriggerDetailsDecisionV3 = { - Approved: 'APPROVED', - Rejected: 'REJECTED' -} as const; - -export type RequestedItemStatusPreApprovalTriggerDetailsDecisionV3 = typeof RequestedItemStatusPreApprovalTriggerDetailsDecisionV3[keyof typeof RequestedItemStatusPreApprovalTriggerDetailsDecisionV3]; - -/** - * - * @export - * @interface RequestedItemStatusProvisioningDetails - */ -export interface RequestedItemStatusProvisioningDetails { - /** - * Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. - * @type {string} - * @memberof RequestedItemStatusProvisioningDetails - */ - 'orderedSubPhaseReferences'?: string; -} -/** - * Indicates the state of an access request: * EXECUTING: The request is executing, which indicates the system is doing some processing. * REQUEST_COMPLETED: Indicates the request has been completed. * CANCELLED: The request was cancelled with no user input. * TERMINATED: The request has been terminated before it was able to complete. * PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified. * REJECTED: The request was rejected. * PROVISIONING_FAILED: The request has failed to complete. * NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes. * ERROR: An error occurred during request processing. - * @export - * @enum {string} - */ - -export const RequestedItemStatusRequestState = { - Executing: 'EXECUTING', - RequestCompleted: 'REQUEST_COMPLETED', - Cancelled: 'CANCELLED', - Terminated: 'TERMINATED', - ProvisioningVerificationPending: 'PROVISIONING_VERIFICATION_PENDING', - Rejected: 'REJECTED', - ProvisioningFailed: 'PROVISIONING_FAILED', - NotAllItemsProvisioned: 'NOT_ALL_ITEMS_PROVISIONED', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusRequestState = typeof RequestedItemStatusRequestState[keyof typeof RequestedItemStatusRequestState]; - - -/** - * Identity access was requested for. - * @export - * @interface RequestedItemStatusRequestedFor - */ -export interface RequestedItemStatusRequestedFor { - /** - * Type of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedFor - */ - 'type'?: RequestedItemStatusRequestedForTypeV3; - /** - * ID of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedFor - */ - 'id'?: string; - /** - * Human-readable display name of the object to which this reference applies - * @type {string} - * @memberof RequestedItemStatusRequestedFor - */ - 'name'?: string; -} - -export const RequestedItemStatusRequestedForTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type RequestedItemStatusRequestedForTypeV3 = typeof RequestedItemStatusRequestedForTypeV3[keyof typeof RequestedItemStatusRequestedForTypeV3]; - -/** - * - * @export - * @interface RequestedItemStatusRequesterComment - */ -export interface RequestedItemStatusRequesterComment { - /** - * Comment content. - * @type {string} - * @memberof RequestedItemStatusRequesterComment - */ - 'comment'?: string | null; - /** - * Date and time comment was created. - * @type {string} - * @memberof RequestedItemStatusRequesterComment - */ - 'created'?: string; - /** - * - * @type {CommentDtoAuthor} - * @memberof RequestedItemStatusRequesterComment - */ - 'author'?: CommentDtoAuthor; -} -/** - * - * @export - * @interface RequestedItemStatusSodViolationContext - */ -export interface RequestedItemStatusSodViolationContext { - /** - * The status of SOD violation check - * @type {string} - * @memberof RequestedItemStatusSodViolationContext - */ - 'state'?: RequestedItemStatusSodViolationContextStateV3 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof RequestedItemStatusSodViolationContext - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResult} - * @memberof RequestedItemStatusSodViolationContext - */ - 'violationCheckResult'?: SodViolationCheckResult; -} - -export const RequestedItemStatusSodViolationContextStateV3 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type RequestedItemStatusSodViolationContextStateV3 = typeof RequestedItemStatusSodViolationContextStateV3[keyof typeof RequestedItemStatusSodViolationContextStateV3]; - -/** - * - * @export - * @interface Result - */ -export interface Result { - /** - * Request result status - * @type {string} - * @memberof Result - */ - 'status'?: string; -} -/** - * - * @export - * @interface ReviewDecision - */ -export interface ReviewDecision { - /** - * The id of the review decision - * @type {string} - * @memberof ReviewDecision - */ - 'id': string; - /** - * - * @type {CertificationDecision} - * @memberof ReviewDecision - */ - 'decision': CertificationDecision; - /** - * The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. - * @type {string} - * @memberof ReviewDecision - */ - 'proposedEndDate'?: string; - /** - * Indicates whether decision should be marked as part of a larger bulk decision - * @type {boolean} - * @memberof ReviewDecision - */ - 'bulk': boolean; - /** - * - * @type {ReviewRecommendation} - * @memberof ReviewDecision - */ - 'recommendation'?: ReviewRecommendation; - /** - * Comments recorded when the decision was made - * @type {string} - * @memberof ReviewDecision - */ - 'comments'?: string; -} - - -/** - * - * @export - * @interface ReviewReassign - */ -export interface ReviewReassign { - /** - * - * @type {Array} - * @memberof ReviewReassign - */ - 'reassign': Array; - /** - * The ID of the identity to which the certification is reassigned - * @type {string} - * @memberof ReviewReassign - */ - 'reassignTo': string; - /** - * The reason comment for why the reassign was made - * @type {string} - * @memberof ReviewReassign - */ - 'reason': string; -} -/** - * - * @export - * @interface ReviewRecommendation - */ -export interface ReviewRecommendation { - /** - * The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. - * @type {string} - * @memberof ReviewRecommendation - */ - 'recommendation'?: string | null; - /** - * A list of reasons for the recommendation. - * @type {Array} - * @memberof ReviewRecommendation - */ - 'reasons'?: Array; - /** - * The time at which the recommendation was recorded. - * @type {string} - * @memberof ReviewRecommendation - */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface ReviewableAccessProfile - */ -export interface ReviewableAccessProfile { - /** - * The id of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'id'?: string; - /** - * Name of the Access Profile - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'name'?: string; - /** - * Information about the Access Profile - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableAccessProfile - */ - 'privileged'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableAccessProfile - */ - 'cloudGoverned'?: boolean; - /** - * The date at which a user\'s access expires - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'endDate'?: string | null; - /** - * - * @type {IdentityReferenceWithNameAndEmail} - * @memberof ReviewableAccessProfile - */ - 'owner'?: IdentityReferenceWithNameAndEmail | null; - /** - * A list of entitlements associated with this Access Profile - * @type {Array} - * @memberof ReviewableAccessProfile - */ - 'entitlements'?: Array; - /** - * Date the Access Profile was created. - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'created'?: string; - /** - * Date the Access Profile was last modified. - * @type {string} - * @memberof ReviewableAccessProfile - */ - 'modified'?: string; -} -/** - * - * @export - * @interface ReviewableEntitlement - */ -export interface ReviewableEntitlement { - /** - * The id for the entitlement - * @type {string} - * @memberof ReviewableEntitlement - */ - 'id'?: string; - /** - * The name of the entitlement - * @type {string} - * @memberof ReviewableEntitlement - */ - 'name'?: string; - /** - * Information about the entitlement - * @type {string} - * @memberof ReviewableEntitlement - */ - 'description'?: string | null; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmail} - * @memberof ReviewableEntitlement - */ - 'owner'?: IdentityReferenceWithNameAndEmail | null; - /** - * The name of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlement - */ - 'attributeName'?: string; - /** - * The value of the attribute on the source - * @type {string} - * @memberof ReviewableEntitlement - */ - 'attributeValue'?: string; - /** - * The schema object type on the source used to represent the entitlement and its attributes - * @type {string} - * @memberof ReviewableEntitlement - */ - 'sourceSchemaObjectType'?: string; - /** - * The name of the source for which this entitlement belongs - * @type {string} - * @memberof ReviewableEntitlement - */ - 'sourceName'?: string; - /** - * The type of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlement - */ - 'sourceType'?: string; - /** - * The ID of the source for which the entitlement belongs - * @type {string} - * @memberof ReviewableEntitlement - */ - 'sourceId'?: string; - /** - * Indicates if the entitlement has permissions - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'hasPermissions'?: boolean; - /** - * Indicates if the entitlement is a representation of an account permission - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'isPermission'?: boolean; - /** - * Indicates whether the entitlement can be revoked - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'revocable'?: boolean; - /** - * True if the entitlement is cloud governed - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'cloudGoverned'?: boolean; - /** - * True if the entitlement has DAS data - * @type {boolean} - * @memberof ReviewableEntitlement - */ - 'containsDataAccess'?: boolean; - /** - * - * @type {DataAccess} - * @memberof ReviewableEntitlement - */ - 'dataAccess'?: DataAccess | null; - /** - * - * @type {ReviewableEntitlementAccount} - * @memberof ReviewableEntitlement - */ - 'account'?: ReviewableEntitlementAccount | null; -} -/** - * Information about the status of the entitlement - * @export - * @interface ReviewableEntitlementAccount - */ -export interface ReviewableEntitlementAccount { - /** - * The native identity for this account - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'nativeIdentity'?: string; - /** - * Indicates whether this account is currently disabled - * @type {boolean} - * @memberof ReviewableEntitlementAccount - */ - 'disabled'?: boolean; - /** - * Indicates whether this account is currently locked - * @type {boolean} - * @memberof ReviewableEntitlementAccount - */ - 'locked'?: boolean; - /** - * - * @type {DtoType} - * @memberof ReviewableEntitlementAccount - */ - 'type'?: DtoType; - /** - * The id associated with the account - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'id'?: string | null; - /** - * The account name - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'name'?: string | null; - /** - * When the account was created - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'created'?: string | null; - /** - * When the account was last modified - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'modified'?: string | null; - /** - * - * @type {ActivityInsights} - * @memberof ReviewableEntitlementAccount - */ - 'activityInsights'?: ActivityInsights; - /** - * Information about the account - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'description'?: string | null; - /** - * The id associated with the machine Account Governance Group - * @type {string} - * @memberof ReviewableEntitlementAccount - */ - 'governanceGroupId'?: string | null; - /** - * - * @type {ReviewableEntitlementAccountOwner} - * @memberof ReviewableEntitlementAccount - */ - 'owner'?: ReviewableEntitlementAccountOwner | null; -} - - -/** - * Information about the machine account owner - * @export - * @interface ReviewableEntitlementAccountOwner - */ -export interface ReviewableEntitlementAccountOwner { - /** - * The id associated with the machine account owner - * @type {string} - * @memberof ReviewableEntitlementAccountOwner - */ - 'id'?: string | null; - /** - * An enumeration of the types of Owner supported within the IdentityNow infrastructure. - * @type {string} - * @memberof ReviewableEntitlementAccountOwner - */ - 'type'?: ReviewableEntitlementAccountOwnerTypeV3; - /** - * The machine account owner\'s display name - * @type {string} - * @memberof ReviewableEntitlementAccountOwner - */ - 'displayName'?: string | null; -} - -export const ReviewableEntitlementAccountOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type ReviewableEntitlementAccountOwnerTypeV3 = typeof ReviewableEntitlementAccountOwnerTypeV3[keyof typeof ReviewableEntitlementAccountOwnerTypeV3]; - -/** - * - * @export - * @interface ReviewableRole - */ -export interface ReviewableRole { - /** - * The id for the Role - * @type {string} - * @memberof ReviewableRole - */ - 'id'?: string; - /** - * The name of the Role - * @type {string} - * @memberof ReviewableRole - */ - 'name'?: string; - /** - * Information about the Role - * @type {string} - * @memberof ReviewableRole - */ - 'description'?: string; - /** - * Indicates if the entitlement is a privileged entitlement - * @type {boolean} - * @memberof ReviewableRole - */ - 'privileged'?: boolean; - /** - * - * @type {IdentityReferenceWithNameAndEmail} - * @memberof ReviewableRole - */ - 'owner'?: IdentityReferenceWithNameAndEmail | null; - /** - * Indicates whether the Role can be revoked or requested - * @type {boolean} - * @memberof ReviewableRole - */ - 'revocable'?: boolean; - /** - * The date when a user\'s access expires. - * @type {string} - * @memberof ReviewableRole - */ - 'endDate'?: string; - /** - * The list of Access Profiles associated with this Role - * @type {Array} - * @memberof ReviewableRole - */ - 'accessProfiles'?: Array; - /** - * The list of entitlements associated with this Role - * @type {Array} - * @memberof ReviewableRole - */ - 'entitlements'?: Array; -} -/** - * - * @export - * @interface Reviewer - */ -export interface Reviewer { - /** - * The id of the reviewer. - * @type {string} - * @memberof Reviewer - */ - 'id'?: string; - /** - * The name of the reviewer. - * @type {string} - * @memberof Reviewer - */ - 'name'?: string; - /** - * The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. - * @type {string} - * @memberof Reviewer - */ - 'email'?: string | null; - /** - * The type of the reviewing identity. - * @type {string} - * @memberof Reviewer - */ - 'type'?: ReviewerTypeV3; - /** - * The created date of the reviewing identity. - * @type {string} - * @memberof Reviewer - */ - 'created'?: string | null; - /** - * The modified date of the reviewing identity. - * @type {string} - * @memberof Reviewer - */ - 'modified'?: string | null; -} - -export const ReviewerTypeV3 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type ReviewerTypeV3 = typeof ReviewerTypeV3[keyof typeof ReviewerTypeV3]; - -/** - * - * @export - * @interface Revocability - */ -export interface Revocability { - /** - * List describing the steps involved in approving the revocation request. - * @type {Array} - * @memberof Revocability - */ - 'approvalSchemes'?: Array | null; -} -/** - * - * @export - * @interface RevocabilityForRole - */ -export interface RevocabilityForRole { - /** - * Whether the requester of the containing object must provide comments justifying the request - * @type {boolean} - * @memberof RevocabilityForRole - */ - 'commentsRequired'?: boolean | null; - /** - * Whether an approver must provide comments when denying the request - * @type {boolean} - * @memberof RevocabilityForRole - */ - 'denialCommentsRequired'?: boolean | null; - /** - * List describing the steps in approving the revocation request - * @type {Array} - * @memberof RevocabilityForRole - */ - 'approvalSchemes'?: Array; -} -/** - * - * @export - * @interface RightPad - */ -export interface RightPad { - /** - * An integer value for the desired length of the final output string - * @type {string} - * @memberof RightPad - */ - 'length': string; - /** - * A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space (\" \") character for padding - * @type {string} - * @memberof RightPad - */ - 'padding'?: string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof RightPad - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof RightPad - */ - 'input'?: { [key: string]: any; }; -} -/** - * A Role - * @export - * @interface Role - */ -export interface Role { - /** - * The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - * @type {string} - * @memberof Role - */ - 'id'?: string; - /** - * The human-readable display name of the Role - * @type {string} - * @memberof Role - */ - 'name': string; - /** - * Date the Role was created - * @type {string} - * @memberof Role - */ - 'created'?: string; - /** - * Date the Role was last modified. - * @type {string} - * @memberof Role - */ - 'modified'?: string; - /** - * A human-readable description of the Role - * @type {string} - * @memberof Role - */ - 'description'?: string | null; - /** - * - * @type {OwnerReference} - * @memberof Role - */ - 'owner': OwnerReference; - /** - * List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). - * @type {Array} - * @memberof Role - */ - 'additionalOwners'?: Array | null; - /** - * - * @type {Array} - * @memberof Role - */ - 'accessProfiles'?: Array | null; - /** - * - * @type {Array} - * @memberof Role - */ - 'entitlements'?: Array; - /** - * - * @type {RoleMembershipSelector} - * @memberof Role - */ - 'membership'?: RoleMembershipSelector | null; - /** - * This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - * @type {{ [key: string]: any; }} - * @memberof Role - */ - 'legacyMembershipInfo'?: { [key: string]: any; } | null; - /** - * Whether the Role is enabled or not. - * @type {boolean} - * @memberof Role - */ - 'enabled'?: boolean; - /** - * Whether the Role can be the target of access requests. - * @type {boolean} - * @memberof Role - */ - 'requestable'?: boolean; - /** - * - * @type {RequestabilityForRole} - * @memberof Role - */ - 'accessRequestConfig'?: RequestabilityForRole; - /** - * - * @type {RevocabilityForRole} - * @memberof Role - */ - 'revocationRequestConfig'?: RevocabilityForRole; - /** - * List of IDs of segments, if any, to which this Role is assigned. - * @type {Array} - * @memberof Role - */ - 'segments'?: Array | null; - /** - * Whether the Role is dimensional. - * @type {boolean} - * @memberof Role - */ - 'dimensional'?: boolean | null; - /** - * List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - * @type {Array} - * @memberof Role - */ - 'dimensionRefs'?: Array | null; - /** - * - * @type {AttributeDTOList} - * @memberof Role - */ - 'accessModelMetadata'?: AttributeDTOList; - /** - * The privilege level of the role, if applicable. - * @type {string} - * @memberof Role - */ - 'privilegeLevel'?: string | null; -} -/** - * Type which indicates how a particular Identity obtained a particular Role - * @export - * @enum {string} - */ - -export const RoleAssignmentSourceType = { - AccessRequest: 'ACCESS_REQUEST', - RoleMembership: 'ROLE_MEMBERSHIP' -} as const; - -export type RoleAssignmentSourceType = typeof RoleAssignmentSourceType[keyof typeof RoleAssignmentSourceType]; - - -/** - * - * @export - * @interface RoleBulkDeleteRequest - */ -export interface RoleBulkDeleteRequest { - /** - * List of IDs of Roles to be deleted. - * @type {Array} - * @memberof RoleBulkDeleteRequest - */ - 'roleIds': Array; -} -/** - * Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - * @export - * @interface RoleCriteriaKey - */ -export interface RoleCriteriaKey { - /** - * - * @type {RoleCriteriaKeyType} - * @memberof RoleCriteriaKey - */ - 'type': RoleCriteriaKeyType; - /** - * The name of the attribute or entitlement to which the associated criteria applies. - * @type {string} - * @memberof RoleCriteriaKey - */ - 'property': string; - /** - * ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - * @type {string} - * @memberof RoleCriteriaKey - */ - 'sourceId'?: string | null; -} - - -/** - * Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - * @export - * @enum {string} - */ - -export const RoleCriteriaKeyType = { - Identity: 'IDENTITY', - Account: 'ACCOUNT', - Entitlement: 'ENTITLEMENT' -} as const; - -export type RoleCriteriaKeyType = typeof RoleCriteriaKeyType[keyof typeof RoleCriteriaKeyType]; - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel1 - */ -export interface RoleCriteriaLevel1 { - /** - * - * @type {RoleCriteriaOperation} - * @memberof RoleCriteriaLevel1 - */ - 'operation'?: RoleCriteriaOperation; - /** - * - * @type {RoleCriteriaKey} - * @memberof RoleCriteriaLevel1 - */ - 'key'?: RoleCriteriaKey | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel1 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel1 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel2 - */ -export interface RoleCriteriaLevel2 { - /** - * - * @type {RoleCriteriaOperation} - * @memberof RoleCriteriaLevel2 - */ - 'operation'?: RoleCriteriaOperation; - /** - * - * @type {RoleCriteriaKey} - * @memberof RoleCriteriaLevel2 - */ - 'key'?: RoleCriteriaKey | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel2 - */ - 'stringValue'?: string | null; - /** - * Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - * @type {Array} - * @memberof RoleCriteriaLevel2 - */ - 'children'?: Array | null; -} - - -/** - * Defines STANDARD type Role membership - * @export - * @interface RoleCriteriaLevel3 - */ -export interface RoleCriteriaLevel3 { - /** - * - * @type {RoleCriteriaOperation} - * @memberof RoleCriteriaLevel3 - */ - 'operation'?: RoleCriteriaOperation; - /** - * - * @type {RoleCriteriaKey} - * @memberof RoleCriteriaLevel3 - */ - 'key'?: RoleCriteriaKey | null; - /** - * String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - * @type {string} - * @memberof RoleCriteriaLevel3 - */ - 'stringValue'?: string | null; -} - - -/** - * An operation - * @export - * @enum {string} - */ - -export const RoleCriteriaOperation = { - Equals: 'EQUALS', - NotEquals: 'NOT_EQUALS', - Contains: 'CONTAINS', - DoesNotContain: 'DOES_NOT_CONTAIN', - StartsWith: 'STARTS_WITH', - EndsWith: 'ENDS_WITH', - GreaterThan: 'GREATER_THAN', - LessThan: 'LESS_THAN', - GreaterThanEquals: 'GREATER_THAN_EQUALS', - LessThanEquals: 'LESS_THAN_EQUALS', - And: 'AND', - Or: 'OR' -} as const; - -export type RoleCriteriaOperation = typeof RoleCriteriaOperation[keyof typeof RoleCriteriaOperation]; - - -/** - * Role - * @export - * @interface RoleDocument - */ -export interface RoleDocument { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocument - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocument - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocument - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocument - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocument - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocument - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocument - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwner} - * @memberof RoleDocument - */ - 'owner'?: BaseAccessOwner; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocument - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocument - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocument - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocument - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocument - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocument - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocument - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocument - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocument - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocument - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocument - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocument - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocument - */ - 'dimensions'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentAllOfDimensionSchemaAttributes - */ -export interface RoleDocumentAllOfDimensionSchemaAttributes { - /** - * - * @type {boolean} - * @memberof RoleDocumentAllOfDimensionSchemaAttributes - */ - 'derived'?: boolean; - /** - * Displayname of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributes - */ - 'displayName'?: string; - /** - * Name of the dimension attribute. - * @type {string} - * @memberof RoleDocumentAllOfDimensionSchemaAttributes - */ - 'name'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfDimensions - */ -export interface RoleDocumentAllOfDimensions { - /** - * Unique ID of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensions - */ - 'id'?: string; - /** - * Name of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensions - */ - 'name'?: string; - /** - * Description of the dimension. - * @type {string} - * @memberof RoleDocumentAllOfDimensions - */ - 'description'?: string | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocumentAllOfDimensions - */ - 'entitlements'?: Array | null; - /** - * Access profiles included in the dimension. - * @type {Array} - * @memberof RoleDocumentAllOfDimensions - */ - 'accessProfiles'?: Array | null; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlements - */ -export interface RoleDocumentAllOfEntitlements { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements - */ - 'hash'?: string; -} -/** - * - * @export - * @interface RoleDocumentAllOfEntitlements1 - */ -export interface RoleDocumentAllOfEntitlements1 { - /** - * Indicates whether the entitlement has permissions. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'hasPermissions'?: boolean; - /** - * Entitlement\'s description. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'description'?: string | null; - /** - * Entitlement attribute\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'attribute'?: string; - /** - * Entitlement\'s value. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'value'?: string; - /** - * Entitlement\'s schema. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'schema'?: string; - /** - * Indicates whether the entitlement is privileged. - * @type {boolean} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'privileged'?: boolean; - /** - * Entitlement\'s ID. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'id'?: string; - /** - * Entitlement\'s name. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'name'?: string; - /** - * Schema objectType. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'sourceSchemaObjectType'?: string; - /** - * Read-only calculated hash value of an entitlement. - * @type {string} - * @memberof RoleDocumentAllOfEntitlements1 - */ - 'hash'?: string; -} -/** - * - * @export - * @interface RoleDocuments - */ -export interface RoleDocuments { - /** - * Access item\'s description. - * @type {string} - * @memberof RoleDocuments - */ - 'description'?: string; - /** - * ISO-8601 date-time referring to the time when the object was created. - * @type {string} - * @memberof RoleDocuments - */ - 'created'?: string | null; - /** - * ISO-8601 date-time referring to the time when the object was last modified. - * @type {string} - * @memberof RoleDocuments - */ - 'modified'?: string | null; - /** - * ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. - * @type {string} - * @memberof RoleDocuments - */ - 'synced'?: string | null; - /** - * Indicates whether the access item is currently enabled. - * @type {boolean} - * @memberof RoleDocuments - */ - 'enabled'?: boolean; - /** - * Indicates whether the access item can be requested. - * @type {boolean} - * @memberof RoleDocuments - */ - 'requestable'?: boolean; - /** - * Indicates whether comments are required for requests to access the item. - * @type {boolean} - * @memberof RoleDocuments - */ - 'requestCommentsRequired'?: boolean; - /** - * - * @type {BaseAccessOwner} - * @memberof RoleDocuments - */ - 'owner'?: BaseAccessOwner; - /** - * ID of the role. - * @type {string} - * @memberof RoleDocuments - */ - 'id': string; - /** - * Name of the role. - * @type {string} - * @memberof RoleDocuments - */ - 'name': string; - /** - * Access profiles included with the role. - * @type {Array} - * @memberof RoleDocuments - */ - 'accessProfiles'?: Array | null; - /** - * Number of access profiles included with the role. - * @type {number} - * @memberof RoleDocuments - */ - 'accessProfileCount'?: number | null; - /** - * Tags that have been applied to the object. - * @type {Array} - * @memberof RoleDocuments - */ - 'tags'?: Array; - /** - * Segments with the role. - * @type {Array} - * @memberof RoleDocuments - */ - 'segments'?: Array | null; - /** - * Number of segments with the role. - * @type {number} - * @memberof RoleDocuments - */ - 'segmentCount'?: number | null; - /** - * Entitlements included with the role. - * @type {Array} - * @memberof RoleDocuments - */ - 'entitlements'?: Array | null; - /** - * Number of entitlements included with the role. - * @type {number} - * @memberof RoleDocuments - */ - 'entitlementCount'?: number | null; - /** - * - * @type {boolean} - * @memberof RoleDocuments - */ - 'dimensional'?: boolean; - /** - * Number of dimension attributes included with the role. - * @type {number} - * @memberof RoleDocuments - */ - 'dimensionSchemaAttributeCount'?: number | null; - /** - * Dimension attributes included with the role. - * @type {Array} - * @memberof RoleDocuments - */ - 'dimensionSchemaAttributes'?: Array | null; - /** - * - * @type {Array} - * @memberof RoleDocuments - */ - 'dimensions'?: Array | null; - /** - * Name of the pod. - * @type {string} - * @memberof RoleDocuments - */ - 'pod'?: string; - /** - * Name of the tenant. - * @type {string} - * @memberof RoleDocuments - */ - 'org'?: string; - /** - * - * @type {DocumentType} - * @memberof RoleDocuments - */ - '_type'?: DocumentType; - /** - * - * @type {DocumentType} - * @memberof RoleDocuments - */ - 'type'?: DocumentType; - /** - * Version number. - * @type {string} - * @memberof RoleDocuments - */ - '_version'?: string; -} - - -/** - * A subset of the fields of an Identity which is a member of a Role. - * @export - * @interface RoleIdentity - */ -export interface RoleIdentity { - /** - * The ID of the Identity - * @type {string} - * @memberof RoleIdentity - */ - 'id'?: string; - /** - * The alias / username of the Identity - * @type {string} - * @memberof RoleIdentity - */ - 'aliasName'?: string; - /** - * The human-readable display name of the Identity - * @type {string} - * @memberof RoleIdentity - */ - 'name'?: string; - /** - * Email address of the Identity - * @type {string} - * @memberof RoleIdentity - */ - 'email'?: string; - /** - * - * @type {RoleAssignmentSourceType} - * @memberof RoleIdentity - */ - 'roleAssignmentSource'?: RoleAssignmentSourceType; -} - - -/** - * A reference to an Identity in an IDENTITY_LIST role membership criteria. - * @export - * @interface RoleMembershipIdentity - */ -export interface RoleMembershipIdentity { - /** - * - * @type {DtoType} - * @memberof RoleMembershipIdentity - */ - 'type'?: DtoType; - /** - * Identity id - * @type {string} - * @memberof RoleMembershipIdentity - */ - 'id'?: string; - /** - * Human-readable display name of the Identity. - * @type {string} - * @memberof RoleMembershipIdentity - */ - 'name'?: string | null; - /** - * User name of the Identity - * @type {string} - * @memberof RoleMembershipIdentity - */ - 'aliasName'?: string | null; -} - - -/** - * When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - * @export - * @interface RoleMembershipSelector - */ -export interface RoleMembershipSelector { - /** - * - * @type {RoleMembershipSelectorType} - * @memberof RoleMembershipSelector - */ - 'type'?: RoleMembershipSelectorType; - /** - * - * @type {RoleCriteriaLevel1} - * @memberof RoleMembershipSelector - */ - 'criteria'?: RoleCriteriaLevel1 | null; - /** - * Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - * @type {Array} - * @memberof RoleMembershipSelector - */ - 'identities'?: Array | null; -} - - -/** - * This enum characterizes the type of a Role\'s membership selector. Only the following two are fully supported: STANDARD: Indicates that Role membership is defined in terms of a criteria expression IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - * @export - * @enum {string} - */ - -export const RoleMembershipSelectorType = { - Standard: 'STANDARD', - IdentityList: 'IDENTITY_LIST' -} as const; - -export type RoleMembershipSelectorType = typeof RoleMembershipSelectorType[keyof typeof RoleMembershipSelectorType]; - - -/** - * Role - * @export - * @interface RoleSummary - */ -export interface RoleSummary { - /** - * The unique ID of the referenced object. - * @type {string} - * @memberof RoleSummary - */ - 'id'?: string; - /** - * The human readable name of the referenced object. - * @type {string} - * @memberof RoleSummary - */ - 'name'?: string; - /** - * - * @type {string} - * @memberof RoleSummary - */ - 'displayName'?: string; - /** - * Description of access item. - * @type {string} - * @memberof RoleSummary - */ - 'description'?: string | null; - /** - * Type of the access item. - * @type {string} - * @memberof RoleSummary - */ - 'type'?: string; - /** - * - * @type {DisplayReference} - * @memberof RoleSummary - */ - 'owner'?: DisplayReference; - /** - * - * @type {boolean} - * @memberof RoleSummary - */ - 'disabled'?: boolean; - /** - * - * @type {boolean} - * @memberof RoleSummary - */ - 'revocable'?: boolean; -} -/** - * @type Rule - * @export - */ -export type Rule = GenerateRandomString | GetReferenceIdentityAttribute | TransformRule; - -/** - * - * @export - * @interface SavedSearch - */ -export interface SavedSearch { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearch - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearch - */ - 'description'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearch - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearch - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearch - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearch - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearch - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearch - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearch - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearch - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFilters} - * @memberof SavedSearch - */ - 'filters'?: SavedSearchDetailFilters | null; - /** - * The saved search ID. - * @type {string} - * @memberof SavedSearch - */ - 'id'?: string; - /** - * - * @type {TypedReference} - * @memberof SavedSearch - */ - 'owner'?: TypedReference; - /** - * The ID of the identity that owns this saved search. - * @type {string} - * @memberof SavedSearch - */ - 'ownerId'?: string; - /** - * Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - * @type {boolean} - * @memberof SavedSearch - */ - 'public'?: boolean; -} -/** - * - * @export - * @interface SavedSearchDetail - */ -export interface SavedSearchDetail { - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetail - */ - 'created'?: string | null; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof SavedSearchDetail - */ - 'modified'?: string | null; - /** - * The names of the Elasticsearch indices in which to search. - * @type {Array} - * @memberof SavedSearchDetail - */ - 'indices': Array; - /** - * The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetail - */ - 'columns'?: { [key: string]: Array; }; - /** - * The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. - * @type {string} - * @memberof SavedSearchDetail - */ - 'query': string; - /** - * The fields to be searched against in a multi-field query. - * @type {Array} - * @memberof SavedSearchDetail - */ - 'fields'?: Array | null; - /** - * Sort by index. This takes precedence over the `sort` property. - * @type {{ [key: string]: Array; }} - * @memberof SavedSearchDetail - */ - 'orderBy'?: { [key: string]: Array; } | null; - /** - * The fields to be used to sort the search results. - * @type {Array} - * @memberof SavedSearchDetail - */ - 'sort'?: Array | null; - /** - * - * @type {SavedSearchDetailFilters} - * @memberof SavedSearchDetail - */ - 'filters'?: SavedSearchDetailFilters | null; -} -/** - * - * @export - * @interface SavedSearchDetailFilters - */ -export interface SavedSearchDetailFilters { - /** - * - * @type {FilterType} - * @memberof SavedSearchDetailFilters - */ - 'type'?: FilterType; - /** - * - * @type {Range} - * @memberof SavedSearchDetailFilters - */ - 'range'?: Range; - /** - * The terms to be filtered. - * @type {Array} - * @memberof SavedSearchDetailFilters - */ - 'terms'?: Array; - /** - * Indicates if the filter excludes results. - * @type {boolean} - * @memberof SavedSearchDetailFilters - */ - 'exclude'?: boolean; -} - - -/** - * - * @export - * @interface SavedSearchName - */ -export interface SavedSearchName { - /** - * The name of the saved search. - * @type {string} - * @memberof SavedSearchName - */ - 'name'?: string; - /** - * The description of the saved search. - * @type {string} - * @memberof SavedSearchName - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface Schedule - */ -export interface Schedule { - /** - * Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. - * @type {string} - * @memberof Schedule - */ - 'type': ScheduleTypeV3; - /** - * - * @type {ScheduleMonths} - * @memberof Schedule - */ - 'months'?: ScheduleMonths | null; - /** - * - * @type {ScheduleDays} - * @memberof Schedule - */ - 'days'?: ScheduleDays; - /** - * - * @type {ScheduleHours} - * @memberof Schedule - */ - 'hours': ScheduleHours; - /** - * Specifies the time after which this schedule will no longer occur. - * @type {string} - * @memberof Schedule - */ - 'expiration'?: string | null; - /** - * The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. - * @type {string} - * @memberof Schedule - */ - 'timeZoneId'?: string; -} - -export const ScheduleTypeV3 = { - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Annually: 'ANNUALLY', - Calendar: 'CALENDAR' -} as const; - -export type ScheduleTypeV3 = typeof ScheduleTypeV3[keyof typeof ScheduleTypeV3]; - -/** - * The schedule information. - * @export - * @interface Schedule1 - */ -export interface Schedule1 { - /** - * - * @type {ScheduleType} - * @memberof Schedule1 - */ - 'type': ScheduleType; - /** - * - * @type {Schedule1Months} - * @memberof Schedule1 - */ - 'months'?: Schedule1Months; - /** - * - * @type {Schedule1Days} - * @memberof Schedule1 - */ - 'days'?: Schedule1Days; - /** - * - * @type {Schedule1Hours} - * @memberof Schedule1 - */ - 'hours': Schedule1Hours; - /** - * A date-time in ISO-8601 format - * @type {string} - * @memberof Schedule1 - */ - 'expiration'?: string | null; - /** - * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. - * @type {string} - * @memberof Schedule1 - */ - 'timeZoneId'?: string | null; -} - - -/** - * - * @export - * @interface Schedule1Days - */ -export interface Schedule1Days { - /** - * - * @type {SelectorType} - * @memberof Schedule1Days - */ - 'type': SelectorType; - /** - * The selected values. - * @type {Array} - * @memberof Schedule1Days - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule1Days - */ - 'interval'?: number | null; -} - - -/** - * - * @export - * @interface Schedule1Hours - */ -export interface Schedule1Hours { - /** - * - * @type {SelectorType} - * @memberof Schedule1Hours - */ - 'type': SelectorType; - /** - * The selected values. - * @type {Array} - * @memberof Schedule1Hours - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule1Hours - */ - 'interval'?: number | null; -} - - -/** - * - * @export - * @interface Schedule1Months - */ -export interface Schedule1Months { - /** - * - * @type {SelectorType} - * @memberof Schedule1Months - */ - 'type': SelectorType; - /** - * The selected values. - * @type {Array} - * @memberof Schedule1Months - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Schedule1Months - */ - 'interval'?: number | null; -} - - -/** - * Specifies which day(s) a schedule is active for. This is required for all schedule types. The \"values\" field holds different data depending on the type of schedule: * WEEKLY: days of the week (1-7) * MONTHLY: days of the month (1-31, L, L-1...) * ANNUALLY: if the \"months\" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year (\"--12-31\") * CALENDAR: ISO-8601 dates (\"2020-12-31\") Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided with ISO-8601 dates without year. Examples: On Sundays: * type LIST * values \"1\" The second to last day of the month: * type LIST * values \"L-1\" From the 20th to the last day of the month: * type RANGE * values \"20\", \"L\" Every March 2nd: * type LIST * values \"--03-02\" On March 2nd, 2021: * type: LIST * values \"2021-03-02\" - * @export - * @interface ScheduleDays - */ -export interface ScheduleDays { - /** - * Enum type to specify days value - * @type {string} - * @memberof ScheduleDays - */ - 'type': ScheduleDaysTypeV3; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleDays - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleDays - */ - 'interval'?: number | null; -} - -export const ScheduleDaysTypeV3 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleDaysTypeV3 = typeof ScheduleDaysTypeV3[keyof typeof ScheduleDaysTypeV3]; - -/** - * Specifies which hour(s) a schedule is active for. Examples: Every three hours starting from 8AM, inclusive: * type LIST * values \"8\" * interval 3 During business hours: * type RANGE * values \"9\", \"5\" At 5AM, noon, and 5PM: * type LIST * values \"5\", \"12\", \"17\" - * @export - * @interface ScheduleHours - */ -export interface ScheduleHours { - /** - * Enum type to specify hours value - * @type {string} - * @memberof ScheduleHours - */ - 'type': ScheduleHoursTypeV3; - /** - * Values of the days based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleHours - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleHours - */ - 'interval'?: number | null; -} - -export const ScheduleHoursTypeV3 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleHoursTypeV3 = typeof ScheduleHoursTypeV3[keyof typeof ScheduleHoursTypeV3]; - -/** - * Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples: On February and March: * type LIST * values \"2\", \"3\" Every 3 months, starting in January (quarterly): * type LIST * values \"1\" * interval 3 Every two months between July and December: * type RANGE * values \"7\", \"12\" * interval 2 - * @export - * @interface ScheduleMonths - */ -export interface ScheduleMonths { - /** - * Enum type to specify months value - * @type {string} - * @memberof ScheduleMonths - */ - 'type': ScheduleMonthsTypeV3; - /** - * Values of the months based on the enum type mentioned above - * @type {Array} - * @memberof ScheduleMonths - */ - 'values': Array; - /** - * Interval between the cert generations - * @type {number} - * @memberof ScheduleMonths - */ - 'interval'?: number; -} - -export const ScheduleMonthsTypeV3 = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type ScheduleMonthsTypeV3 = typeof ScheduleMonthsTypeV3[keyof typeof ScheduleMonthsTypeV3]; - -/** - * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const ScheduleType = { - Daily: 'DAILY', - Weekly: 'WEEKLY', - Monthly: 'MONTHLY', - Calendar: 'CALENDAR', - Annually: 'ANNUALLY' -} as const; - -export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType]; - - -/** - * Attributes related to a scheduled trigger - * @export - * @interface ScheduledAttributes - */ -export interface ScheduledAttributes { - /** - * Frequency of execution - * @type {string} - * @memberof ScheduledAttributes - */ - 'frequency': ScheduledAttributesFrequencyV3 | null; - /** - * Time zone identifier - * @type {string} - * @memberof ScheduledAttributes - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof ScheduledAttributes - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof ScheduledAttributes - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributes - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof ScheduledAttributes - */ - 'yearlyTimes'?: Array | null; -} - -export const ScheduledAttributesFrequencyV3 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type ScheduledAttributesFrequencyV3 = typeof ScheduledAttributesFrequencyV3[keyof typeof ScheduledAttributesFrequencyV3]; - -/** - * - * @export - * @interface ScheduledSearch - */ -export interface ScheduledSearch { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearch - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearch - */ - 'description'?: string | null; - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof ScheduledSearch - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof ScheduledSearch - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof ScheduledSearch - */ - 'modified'?: string | null; - /** - * - * @type {Schedule1} - * @memberof ScheduledSearch - */ - 'schedule': Schedule1; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof ScheduledSearch - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof ScheduledSearch - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof ScheduledSearch - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof ScheduledSearch - */ - 'displayQueryDetails'?: boolean; - /** - * The scheduled search ID. - * @type {string} - * @memberof ScheduledSearch - */ - 'id': string; - /** - * - * @type {ScheduledSearchAllOfOwner} - * @memberof ScheduledSearch - */ - 'owner': ScheduledSearchAllOfOwner; - /** - * The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. - * @type {string} - * @memberof ScheduledSearch - * @deprecated - */ - 'ownerId': string; -} -/** - * The owner of the scheduled search - * @export - * @interface ScheduledSearchAllOfOwner - */ -export interface ScheduledSearchAllOfOwner { - /** - * The type of object being referenced - * @type {string} - * @memberof ScheduledSearchAllOfOwner - */ - 'type': ScheduledSearchAllOfOwnerTypeV3; - /** - * The ID of the referenced object - * @type {string} - * @memberof ScheduledSearchAllOfOwner - */ - 'id': string; -} - -export const ScheduledSearchAllOfOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type ScheduledSearchAllOfOwnerTypeV3 = typeof ScheduledSearchAllOfOwnerTypeV3[keyof typeof ScheduledSearchAllOfOwnerTypeV3]; - -/** - * - * @export - * @interface ScheduledSearchName - */ -export interface ScheduledSearchName { - /** - * The name of the scheduled search. - * @type {string} - * @memberof ScheduledSearchName - */ - 'name'?: string | null; - /** - * The description of the scheduled search. - * @type {string} - * @memberof ScheduledSearchName - */ - 'description'?: string | null; -} -/** - * - * @export - * @interface Schema - */ -export interface Schema { - /** - * The id of the Schema. - * @type {string} - * @memberof Schema - */ - 'id'?: string; - /** - * The name of the Schema. - * @type {string} - * @memberof Schema - */ - 'name'?: string; - /** - * The name of the object type on the native system that the schema represents. - * @type {string} - * @memberof Schema - */ - 'nativeObjectType'?: string; - /** - * The name of the attribute used to calculate the unique identifier for an object in the schema. - * @type {string} - * @memberof Schema - */ - 'identityAttribute'?: string; - /** - * The name of the attribute used to calculate the display value for an object in the schema. - * @type {string} - * @memberof Schema - */ - 'displayAttribute'?: string; - /** - * The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. - * @type {string} - * @memberof Schema - */ - 'hierarchyAttribute'?: string; - /** - * Flag indicating whether or not the include permissions with the object data when aggregating the schema. - * @type {boolean} - * @memberof Schema - */ - 'includePermissions'?: boolean; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof Schema - */ - 'features'?: Array; - /** - * Holds any extra configuration data that the schema may require. - * @type {object} - * @memberof Schema - */ - 'configuration'?: object; - /** - * The attribute definitions which form the schema. - * @type {Array} - * @memberof Schema - */ - 'attributes'?: Array; - /** - * The date the Schema was created. - * @type {string} - * @memberof Schema - */ - 'created'?: string; - /** - * The date the Schema was last modified. - * @type {string} - * @memberof Schema - */ - 'modified'?: string; -} - -export const SchemaFeaturesV3 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SchemaFeaturesV3 = typeof SchemaFeaturesV3[keyof typeof SchemaFeaturesV3]; - -/** - * - * @export - * @interface Search - */ -export interface Search { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof Search - */ - 'indices'?: Array; - /** - * - * @type {QueryType} - * @memberof Search - */ - 'queryType'?: QueryType; - /** - * - * @type {string} - * @memberof Search - */ - 'queryVersion'?: string; - /** - * - * @type {Query} - * @memberof Search - */ - 'query'?: Query; - /** - * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - * @type {object} - * @memberof Search - */ - 'queryDsl'?: object; - /** - * - * @type {TextQuery} - * @memberof Search - */ - 'textQuery'?: TextQuery; - /** - * - * @type {TypeAheadQuery} - * @memberof Search - */ - 'typeAheadQuery'?: TypeAheadQuery; - /** - * Indicates whether nested objects from returned search results should be included. - * @type {boolean} - * @memberof Search - */ - 'includeNested'?: boolean; - /** - * - * @type {QueryResultFilter} - * @memberof Search - */ - 'queryResultFilter'?: QueryResultFilter; - /** - * - * @type {AggregationType} - * @memberof Search - */ - 'aggregationType'?: AggregationType; - /** - * - * @type {string} - * @memberof Search - */ - 'aggregationsVersion'?: string; - /** - * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - * @type {object} - * @memberof Search - */ - 'aggregationsDsl'?: object; - /** - * - * @type {SearchAggregationSpecification} - * @memberof Search - */ - 'aggregations'?: SearchAggregationSpecification; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof Search - */ - 'sort'?: Array; - /** - * 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. 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, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] - * @type {Array} - * @memberof Search - */ - 'searchAfter'?: Array; - /** - * The filters to be applied for each filtered field name. - * @type {{ [key: string]: Filter; }} - * @memberof Search - */ - 'filters'?: { [key: string]: Filter; }; -} - - -/** - * - * @export - * @interface SearchAggregationSpecification - */ -export interface SearchAggregationSpecification { - /** - * - * @type {NestedAggregation} - * @memberof SearchAggregationSpecification - */ - 'nested'?: NestedAggregation; - /** - * - * @type {MetricAggregation} - * @memberof SearchAggregationSpecification - */ - 'metric'?: MetricAggregation; - /** - * - * @type {FilterAggregation} - * @memberof SearchAggregationSpecification - */ - 'filter'?: FilterAggregation; - /** - * - * @type {BucketAggregation} - * @memberof SearchAggregationSpecification - */ - 'bucket'?: BucketAggregation; - /** - * - * @type {SubSearchAggregationSpecification} - * @memberof SearchAggregationSpecification - */ - 'subAggregation'?: SubSearchAggregationSpecification; -} -/** - * - * @export - * @interface SearchArguments - */ -export interface SearchArguments { - /** - * The ID of the scheduled search that triggered the saved search execution. - * @type {string} - * @memberof SearchArguments - */ - 'scheduleId'?: string; - /** - * The owner of the scheduled search being tested. - * @type {TypedReference} - * @memberof SearchArguments - */ - 'owner'?: TypedReference; - /** - * The email recipients of the scheduled search being tested. - * @type {Array} - * @memberof SearchArguments - */ - 'recipients'?: Array; -} -/** - * - * @export - * @interface SearchAttributeConfig - */ -export interface SearchAttributeConfig { - /** - * Name of the new attribute - * @type {string} - * @memberof SearchAttributeConfig - */ - 'name'?: string; - /** - * The display name of the new attribute - * @type {string} - * @memberof SearchAttributeConfig - */ - 'displayName'?: string; - /** - * Map of application id and their associated attribute. - * @type {object} - * @memberof SearchAttributeConfig - */ - 'applicationAttributes'?: object; -} -/** - * @type SearchDocument - * @export - */ -export type SearchDocument = AccessProfileDocument | AccountActivityDocument | EntitlementDocument | EventDocument | IdentityDocument | RoleDocument; - -/** - * @type SearchDocuments - * @export - */ -export type SearchDocuments = AccessProfileDocuments | AccountActivityDocuments | EntitlementDocuments | EventDocuments | IdentityDocuments | RoleDocuments; - -/** - * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. - * @export - * @interface SearchExportReportArguments - */ -export interface SearchExportReportArguments { - /** - * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - * @type {Array} - * @memberof SearchExportReportArguments - */ - 'indices'?: Array; - /** - * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - * @type {string} - * @memberof SearchExportReportArguments - */ - 'query': string; - /** - * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. - * @type {string} - * @memberof SearchExportReportArguments - */ - 'columns'?: string; - /** - * The fields to be used to sort the search results. Use + or - to specify the sort direction. - * @type {Array} - * @memberof SearchExportReportArguments - */ - 'sort'?: Array; -} -/** - * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SearchFilterType = { - Term: 'TERM' -} as const; - -export type SearchFilterType = typeof SearchFilterType[keyof typeof SearchFilterType]; - - -/** - * - * @export - * @interface SearchSchedule - */ -export interface SearchSchedule { - /** - * The ID of the saved search that will be executed. - * @type {string} - * @memberof SearchSchedule - */ - 'savedSearchId': string; - /** - * The date the scheduled search was initially created. - * @type {string} - * @memberof SearchSchedule - */ - 'created'?: string | null; - /** - * The last date the scheduled search was modified. - * @type {string} - * @memberof SearchSchedule - */ - 'modified'?: string | null; - /** - * - * @type {Schedule1} - * @memberof SearchSchedule - */ - 'schedule': Schedule1; - /** - * A list of identities that should receive the scheduled search report via email. - * @type {Array} - * @memberof SearchSchedule - */ - 'recipients': Array; - /** - * Indicates if the scheduled search is enabled. - * @type {boolean} - * @memberof SearchSchedule - */ - 'enabled'?: boolean; - /** - * Indicates if email generation should occur when search returns no results. - * @type {boolean} - * @memberof SearchSchedule - */ - 'emailEmptyResults'?: boolean; - /** - * Indicates if the generated email should include the query and search results preview (which could include PII). - * @type {boolean} - * @memberof SearchSchedule - */ - 'displayQueryDetails'?: boolean; -} -/** - * - * @export - * @interface SearchScheduleRecipientsInner - */ -export interface SearchScheduleRecipientsInner { - /** - * The type of object being referenced - * @type {string} - * @memberof SearchScheduleRecipientsInner - */ - 'type': SearchScheduleRecipientsInnerTypeV3; - /** - * The ID of the referenced object - * @type {string} - * @memberof SearchScheduleRecipientsInner - */ - 'id': string; -} - -export const SearchScheduleRecipientsInnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type SearchScheduleRecipientsInnerTypeV3 = typeof SearchScheduleRecipientsInnerTypeV3[keyof typeof SearchScheduleRecipientsInnerTypeV3]; - -/** - * - * @export - * @interface SectionDetails - */ -export interface SectionDetails { - /** - * Name of the FormItem - * @type {string} - * @memberof SectionDetails - */ - 'name'?: string; - /** - * Label of the section - * @type {string} - * @memberof SectionDetails - */ - 'label'?: string; - /** - * List of FormItems. FormItems can be SectionDetails and/or FieldDetails - * @type {Array} - * @memberof SectionDetails - */ - 'formItems'?: Array; -} -/** - * - * @export - * @interface Segment - */ -export interface Segment { - /** - * The segment\'s ID. - * @type {string} - * @memberof Segment - */ - 'id'?: string; - /** - * The segment\'s business name. - * @type {string} - * @memberof Segment - */ - 'name'?: string; - /** - * The time when the segment is created. - * @type {string} - * @memberof Segment - */ - 'created'?: string; - /** - * The time when the segment is modified. - * @type {string} - * @memberof Segment - */ - 'modified'?: string; - /** - * The segment\'s optional description. - * @type {string} - * @memberof Segment - */ - 'description'?: string; - /** - * - * @type {OwnerReferenceSegments} - * @memberof Segment - */ - 'owner'?: OwnerReferenceSegments | null; - /** - * - * @type {SegmentVisibilityCriteria} - * @memberof Segment - */ - 'visibilityCriteria'?: SegmentVisibilityCriteria; - /** - * This boolean indicates whether the segment is currently active. Inactive segments have no effect. - * @type {boolean} - * @memberof Segment - */ - 'active'?: boolean; -} -/** - * - * @export - * @interface SegmentVisibilityCriteria - */ -export interface SegmentVisibilityCriteria { - /** - * - * @type {Expression} - * @memberof SegmentVisibilityCriteria - */ - 'expression'?: Expression; -} -/** - * - * @export - * @interface Selector - */ -export interface Selector { - /** - * - * @type {SelectorType} - * @memberof Selector - */ - 'type': SelectorType; - /** - * The selected values. - * @type {Array} - * @memberof Selector - */ - 'values': Array; - /** - * The selected interval for RANGE selectors. - * @type {number} - * @memberof Selector - */ - 'interval'?: number | null; -} - - -/** - * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. - * @export - * @enum {string} - */ - -export const SelectorType = { - List: 'LIST', - Range: 'RANGE' -} as const; - -export type SelectorType = typeof SelectorType[keyof typeof SelectorType]; - - -/** - * - * @export - * @interface SendTokenRequest - */ -export interface SendTokenRequest { - /** - * User alias from table spt_identity field named \'name\' - * @type {string} - * @memberof SendTokenRequest - */ - 'userAlias': string; - /** - * Token delivery type - * @type {string} - * @memberof SendTokenRequest - */ - 'deliveryType': SendTokenRequestDeliveryTypeV3; -} - -export const SendTokenRequestDeliveryTypeV3 = { - SmsPersonal: 'SMS_PERSONAL', - VoicePersonal: 'VOICE_PERSONAL', - SmsWork: 'SMS_WORK', - VoiceWork: 'VOICE_WORK', - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL' -} as const; - -export type SendTokenRequestDeliveryTypeV3 = typeof SendTokenRequestDeliveryTypeV3[keyof typeof SendTokenRequestDeliveryTypeV3]; - -/** - * - * @export - * @interface SendTokenResponse - */ -export interface SendTokenResponse { - /** - * The token request ID - * @type {string} - * @memberof SendTokenResponse - */ - 'requestId'?: string | null; - /** - * Status of sending token - * @type {string} - * @memberof SendTokenResponse - */ - 'status'?: SendTokenResponseStatusV3; - /** - * Error messages from token send request - * @type {string} - * @memberof SendTokenResponse - */ - 'errorMessage'?: string | null; -} - -export const SendTokenResponseStatusV3 = { - Success: 'SUCCESS', - Failed: 'FAILED' -} as const; - -export type SendTokenResponseStatusV3 = typeof SendTokenResponseStatusV3[keyof typeof SendTokenResponseStatusV3]; - -/** - * - * @export - * @interface ServiceDeskIntegrationDto - */ -export interface ServiceDeskIntegrationDto { - /** - * Unique identifier for the Service Desk integration - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'id'?: string; - /** - * Service Desk integration\'s name. The name must be unique. - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'name': string; - /** - * The date and time the Service Desk integration was created - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'created'?: string; - /** - * The date and time the Service Desk integration was last modified - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'modified'?: string; - /** - * Service Desk integration\'s description. - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'description': string; - /** - * Service Desk integration types: - ServiceNowSDIM - ServiceNow - * @type {string} - * @memberof ServiceDeskIntegrationDto - */ - 'type': string; - /** - * - * @type {OwnerDto} - * @memberof ServiceDeskIntegrationDto - */ - 'ownerRef'?: OwnerDto; - /** - * - * @type {SourceClusterDto} - * @memberof ServiceDeskIntegrationDto - */ - 'clusterRef'?: SourceClusterDto; - /** - * Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - * @type {string} - * @memberof ServiceDeskIntegrationDto - * @deprecated - */ - 'cluster'?: string | null; - /** - * Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - * @type {Array} - * @memberof ServiceDeskIntegrationDto - * @deprecated - */ - 'managedSources'?: Array; - /** - * - * @type {ProvisioningConfig} - * @memberof ServiceDeskIntegrationDto - */ - 'provisioningConfig'?: ProvisioningConfig; - /** - * Service Desk integration\'s attributes. Validation constraints enforced by the implementation. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationDto - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {BeforeProvisioningRuleDto} - * @memberof ServiceDeskIntegrationDto - */ - 'beforeProvisioningRule'?: BeforeProvisioningRuleDto; -} -/** - * - * @export - * @interface ServiceDeskIntegrationTemplateDto - */ -export interface ServiceDeskIntegrationTemplateDto { - /** - * System-generated unique ID of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'id'?: string; - /** - * Name of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'name': string | null; - /** - * Creation date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'created'?: string; - /** - * Last modification date of the Object - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'modified'?: string; - /** - * The \'type\' property specifies the type of the Service Desk integration template. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'type': string; - /** - * The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. - * @type {{ [key: string]: any; }} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'attributes': { [key: string]: any; }; - /** - * - * @type {ProvisioningConfig} - * @memberof ServiceDeskIntegrationTemplateDto - */ - 'provisioningConfig': ProvisioningConfig; -} -/** - * This represents a Service Desk Integration template type. - * @export - * @interface ServiceDeskIntegrationTemplateType - */ -export interface ServiceDeskIntegrationTemplateType { - /** - * This is the name of the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateType - */ - 'name'?: string; - /** - * This is the type value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateType - */ - 'type': string; - /** - * This is the scriptName attribute value for the type. - * @type {string} - * @memberof ServiceDeskIntegrationTemplateType - */ - 'scriptName': string; -} -/** - * Source for Service Desk integration template. - * @export - * @interface ServiceDeskSource - */ -export interface ServiceDeskSource { - /** - * DTO type of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSource - */ - 'type'?: ServiceDeskSourceTypeV3; - /** - * ID of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSource - */ - 'id'?: string; - /** - * Human-readable name of source for service desk integration template. - * @type {string} - * @memberof ServiceDeskSource - */ - 'name'?: string; -} - -export const ServiceDeskSourceTypeV3 = { - Source: 'SOURCE' -} as const; - -export type ServiceDeskSourceTypeV3 = typeof ServiceDeskSourceTypeV3[keyof typeof ServiceDeskSourceTypeV3]; - -/** - * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider - * @export - * @interface ServiceProviderConfiguration - */ -export interface ServiceProviderConfiguration { - /** - * This determines whether or not the SAML authentication flow is enabled for an org - * @type {boolean} - * @memberof ServiceProviderConfiguration - */ - 'enabled'?: boolean; - /** - * This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. - * @type {boolean} - * @memberof ServiceProviderConfiguration - */ - 'bypassIdp'?: boolean; - /** - * This indicates whether or not the SAML configuration is valid. - * @type {boolean} - * @memberof ServiceProviderConfiguration - */ - 'samlConfigurationValid'?: boolean; - /** - * A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). - * @type {Array} - * @memberof ServiceProviderConfiguration - */ - 'federationProtocolDetails'?: Array; -} -/** - * - * @export - * @interface ServiceProviderConfigurationFederationProtocolDetailsInner - */ -export interface ServiceProviderConfigurationFederationProtocolDetailsInner { - /** - * Federation protocol role - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'entityId'?: string; - /** - * Defines the binding used for the SAML flow. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'binding'?: string; - /** - * Specifies the SAML authentication method to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'authnContext'?: string; - /** - * The IDP logout URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'logoutUrl'?: string; - /** - * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. - * @type {boolean} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'includeAuthnContext'?: boolean; - /** - * The name id format to use. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'nameId'?: string; - /** - * - * @type {JITConfiguration} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'jitConfiguration'?: JITConfiguration; - /** - * The Base64-encoded certificate used by the IDP. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'cert'?: string; - /** - * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'loginUrlPost'?: string; - /** - * The IDP Redirect URL. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'loginUrlRedirect'?: string; - /** - * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'mappingAttribute': string; - /** - * The expiration date extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'certificateExpirationDate'?: string; - /** - * The name extracted from the certificate. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'certificateName'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner - */ - 'legacyAcsUrl'?: string; -} - -export const ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3 = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleV3]; - -/** - * - * @export - * @interface SessionConfiguration - */ -export interface SessionConfiguration { - /** - * The maximum time in minutes a session can be idle. - * @type {number} - * @memberof SessionConfiguration - */ - 'maxIdleTime'?: number; - /** - * Denotes if \'remember me\' is enabled. - * @type {boolean} - * @memberof SessionConfiguration - */ - 'rememberMe'?: boolean; - /** - * The maximum allowable session time in minutes. - * @type {number} - * @memberof SessionConfiguration - */ - 'maxSessionTime'?: number; -} -/** - * - * @export - * @interface SetLifecycleState200Response - */ -export interface SetLifecycleState200Response { - /** - * ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - * @type {string} - * @memberof SetLifecycleState200Response - */ - 'accountActivityId'?: string; -} -/** - * - * @export - * @interface SetLifecycleStateRequest - */ -export interface SetLifecycleStateRequest { - /** - * ID of the lifecycle state to set. - * @type {string} - * @memberof SetLifecycleStateRequest - */ - 'lifecycleStateId'?: string; -} -/** - * - * @export - * @interface SlimCampaign - */ -export interface SlimCampaign { - /** - * Id of the campaign - * @type {string} - * @memberof SlimCampaign - */ - 'id'?: string; - /** - * The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaign - */ - 'name': string; - /** - * The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. - * @type {string} - * @memberof SlimCampaign - */ - 'description': string | null; - /** - * The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. - * @type {string} - * @memberof SlimCampaign - */ - 'deadline'?: string; - /** - * The type of campaign. Could be extended in the future. - * @type {string} - * @memberof SlimCampaign - */ - 'type': SlimCampaignTypeV3; - /** - * Enables email notification for this campaign - * @type {boolean} - * @memberof SlimCampaign - */ - 'emailNotificationEnabled'?: boolean; - /** - * Allows auto revoke for this campaign - * @type {boolean} - * @memberof SlimCampaign - */ - 'autoRevokeAllowed'?: boolean; - /** - * Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. - * @type {boolean} - * @memberof SlimCampaign - */ - 'recommendationsEnabled'?: boolean; - /** - * The campaign\'s current status. - * @type {string} - * @memberof SlimCampaign - */ - 'status'?: SlimCampaignStatusV3; - /** - * The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - * @type {string} - * @memberof SlimCampaign - */ - 'correlatedStatus'?: SlimCampaignCorrelatedStatusV3; - /** - * Created time of the campaign - * @type {string} - * @memberof SlimCampaign - */ - 'created'?: string; - /** - * The total number of certifications in this campaign. - * @type {number} - * @memberof SlimCampaign - */ - 'totalCertifications'?: number; - /** - * The number of completed certifications in this campaign. - * @type {number} - * @memberof SlimCampaign - */ - 'completedCertifications'?: number; - /** - * A list of errors and warnings that have accumulated. - * @type {Array} - * @memberof SlimCampaign - */ - 'alerts'?: Array; -} - -export const SlimCampaignTypeV3 = { - Manager: 'MANAGER', - SourceOwner: 'SOURCE_OWNER', - Search: 'SEARCH', - RoleComposition: 'ROLE_COMPOSITION', - MachineAccount: 'MACHINE_ACCOUNT' -} as const; - -export type SlimCampaignTypeV3 = typeof SlimCampaignTypeV3[keyof typeof SlimCampaignTypeV3]; -export const SlimCampaignStatusV3 = { - Pending: 'PENDING', - Staged: 'STAGED', - Canceling: 'CANCELING', - Activating: 'ACTIVATING', - Active: 'ACTIVE', - Completing: 'COMPLETING', - Completed: 'COMPLETED', - Error: 'ERROR', - Archived: 'ARCHIVED' -} as const; - -export type SlimCampaignStatusV3 = typeof SlimCampaignStatusV3[keyof typeof SlimCampaignStatusV3]; -export const SlimCampaignCorrelatedStatusV3 = { - Correlated: 'CORRELATED', - Uncorrelated: 'UNCORRELATED' -} as const; - -export type SlimCampaignCorrelatedStatusV3 = typeof SlimCampaignCorrelatedStatusV3[keyof typeof SlimCampaignCorrelatedStatusV3]; - -/** - * Discovered applications - * @export - * @interface SlimDiscoveredApplications - */ -export interface SlimDiscoveredApplications { - /** - * Unique identifier for the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'id'?: string; - /** - * Name of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'name'?: string; - /** - * Source from which the application was discovered. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'discoverySource'?: string; - /** - * The vendor associated with the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'discoveredVendor'?: string; - /** - * A brief description of the discovered application. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'description'?: string; - /** - * List of recommended connectors for the application. - * @type {Array} - * @memberof SlimDiscoveredApplications - */ - 'recommendedConnectors'?: Array; - /** - * The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'discoveredAt'?: string; - /** - * The timestamp when the application was first discovered, in ISO 8601 format. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'createdAt'?: string; - /** - * The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'status'?: string; - /** - * The risk score of the application ranging from 0-100, 100 being highest risk. - * @type {number} - * @memberof SlimDiscoveredApplications - */ - 'riskScore'?: number; - /** - * Indicates whether the application is used for business purposes. - * @type {boolean} - * @memberof SlimDiscoveredApplications - */ - 'isBusiness'?: boolean; - /** - * The total number of sign-in accounts for the application. - * @type {number} - * @memberof SlimDiscoveredApplications - */ - 'totalSigninsCount'?: number; - /** - * The risk level of the application. - * @type {string} - * @memberof SlimDiscoveredApplications - */ - 'riskLevel'?: SlimDiscoveredApplicationsRiskLevelV3; -} - -export const SlimDiscoveredApplicationsRiskLevelV3 = { - High: 'High', - Medium: 'Medium', - Low: 'Low' -} as const; - -export type SlimDiscoveredApplicationsRiskLevelV3 = typeof SlimDiscoveredApplicationsRiskLevelV3[keyof typeof SlimDiscoveredApplicationsRiskLevelV3]; - -/** - * Details of the Entitlement criteria - * @export - * @interface SodExemptCriteria - */ -export interface SodExemptCriteria { - /** - * If the entitlement already belonged to the user or not. - * @type {boolean} - * @memberof SodExemptCriteria - */ - 'existing'?: boolean; - /** - * - * @type {DtoType} - * @memberof SodExemptCriteria - */ - 'type'?: DtoType; - /** - * Entitlement ID - * @type {string} - * @memberof SodExemptCriteria - */ - 'id'?: string; - /** - * Entitlement name - * @type {string} - * @memberof SodExemptCriteria - */ - 'name'?: string; -} - - -/** - * - * @export - * @interface SodPolicy - */ -export interface SodPolicy { - /** - * Policy id - * @type {string} - * @memberof SodPolicy - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicy - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicy - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicy - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicy - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRef} - * @memberof SodPolicy - */ - 'ownerRef'?: SodPolicyOwnerRef; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicy - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicy - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicy - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicy - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicy - */ - 'state'?: SodPolicyStateV3; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicy - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicy - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicy - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfig} - * @memberof SodPolicy - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicy - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicy - */ - 'type'?: SodPolicyTypeV3; -} - -export const SodPolicyStateV3 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyStateV3 = typeof SodPolicyStateV3[keyof typeof SodPolicyStateV3]; -export const SodPolicyTypeV3 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyTypeV3 = typeof SodPolicyTypeV3[keyof typeof SodPolicyTypeV3]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDto - */ -export interface SodPolicyDto { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto - */ - 'type'?: SodPolicyDtoTypeV3; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto - */ - 'name'?: string; -} - -export const SodPolicyDtoTypeV3 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDtoTypeV3 = typeof SodPolicyDtoTypeV3[keyof typeof SodPolicyDtoTypeV3]; - -/** - * SOD policy. - * @export - * @interface SodPolicyDto1 - */ -export interface SodPolicyDto1 { - /** - * SOD policy DTO type. - * @type {string} - * @memberof SodPolicyDto1 - */ - 'type'?: SodPolicyDto1TypeV3; - /** - * SOD policy ID. - * @type {string} - * @memberof SodPolicyDto1 - */ - 'id'?: string; - /** - * SOD policy display name. - * @type {string} - * @memberof SodPolicyDto1 - */ - 'name'?: string; -} - -export const SodPolicyDto1TypeV3 = { - SodPolicy: 'SOD_POLICY' -} as const; - -export type SodPolicyDto1TypeV3 = typeof SodPolicyDto1TypeV3[keyof typeof SodPolicyDto1TypeV3]; - -/** - * The owner of the SOD policy. - * @export - * @interface SodPolicyOwnerRef - */ -export interface SodPolicyOwnerRef { - /** - * Owner type. - * @type {string} - * @memberof SodPolicyOwnerRef - */ - 'type'?: SodPolicyOwnerRefTypeV3; - /** - * Owner\'s ID. - * @type {string} - * @memberof SodPolicyOwnerRef - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof SodPolicyOwnerRef - */ - 'name'?: string; -} - -export const SodPolicyOwnerRefTypeV3 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SodPolicyOwnerRefTypeV3 = typeof SodPolicyOwnerRefTypeV3[keyof typeof SodPolicyOwnerRefTypeV3]; - -/** - * - * @export - * @interface SodPolicyRead - */ -export interface SodPolicyRead { - /** - * Policy id - * @type {string} - * @memberof SodPolicyRead - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicyRead - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyRead - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyRead - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicyRead - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRef} - * @memberof SodPolicyRead - */ - 'ownerRef'?: SodPolicyOwnerRef; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicyRead - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicyRead - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicyRead - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicyRead - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicyRead - */ - 'state'?: SodPolicyReadStateV3; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicyRead - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyRead - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyRead - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfig} - * @memberof SodPolicyRead - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicyRead - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicyRead - */ - 'type'?: SodPolicyReadTypeV3; - /** - * - * @type {SodPolicyReadAllOfConflictingAccessCriteria} - * @memberof SodPolicyRead - */ - 'conflictingAccessCriteria'?: SodPolicyReadAllOfConflictingAccessCriteria; -} - -export const SodPolicyReadStateV3 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyReadStateV3 = typeof SodPolicyReadStateV3[keyof typeof SodPolicyReadStateV3]; -export const SodPolicyReadTypeV3 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyReadTypeV3 = typeof SodPolicyReadTypeV3[keyof typeof SodPolicyReadTypeV3]; - -/** - * - * @export - * @interface SodPolicyReadAllOfConflictingAccessCriteria - */ -export interface SodPolicyReadAllOfConflictingAccessCriteria { - /** - * - * @type {AccessCriteria} - * @memberof SodPolicyReadAllOfConflictingAccessCriteria - */ - 'leftCriteria'?: AccessCriteria; - /** - * - * @type {AccessCriteria} - * @memberof SodPolicyReadAllOfConflictingAccessCriteria - */ - 'rightCriteria'?: AccessCriteria; -} -/** - * - * @export - * @interface SodPolicyRequest - */ -export interface SodPolicyRequest { - /** - * Policy id - * @type {string} - * @memberof SodPolicyRequest - */ - 'id'?: string; - /** - * Policy Business Name - * @type {string} - * @memberof SodPolicyRequest - */ - 'name'?: string; - /** - * The time when this SOD policy is created. - * @type {string} - * @memberof SodPolicyRequest - */ - 'created'?: string; - /** - * The time when this SOD policy is modified. - * @type {string} - * @memberof SodPolicyRequest - */ - 'modified'?: string; - /** - * Optional description of the SOD policy - * @type {string} - * @memberof SodPolicyRequest - */ - 'description'?: string | null; - /** - * - * @type {SodPolicyOwnerRef} - * @memberof SodPolicyRequest - */ - 'ownerRef'?: SodPolicyOwnerRef; - /** - * Optional External Policy Reference - * @type {string} - * @memberof SodPolicyRequest - */ - 'externalPolicyReference'?: string | null; - /** - * Search query of the SOD policy - * @type {string} - * @memberof SodPolicyRequest - */ - 'policyQuery'?: string; - /** - * Optional compensating controls(Mitigating Controls) - * @type {string} - * @memberof SodPolicyRequest - */ - 'compensatingControls'?: string | null; - /** - * Optional correction advice - * @type {string} - * @memberof SodPolicyRequest - */ - 'correctionAdvice'?: string | null; - /** - * whether the policy is enforced or not - * @type {string} - * @memberof SodPolicyRequest - */ - 'state'?: SodPolicyRequestStateV3; - /** - * tags for this policy object - * @type {Array} - * @memberof SodPolicyRequest - */ - 'tags'?: Array; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicyRequest - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicyRequest - */ - 'modifierId'?: string | null; - /** - * - * @type {ViolationOwnerAssignmentConfig} - * @memberof SodPolicyRequest - */ - 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig; - /** - * defines whether a policy has been scheduled or not - * @type {boolean} - * @memberof SodPolicyRequest - */ - 'scheduled'?: boolean; - /** - * whether a policy is query based or conflicting access based - * @type {string} - * @memberof SodPolicyRequest - */ - 'type'?: SodPolicyRequestTypeV3; - /** - * - * @type {SodPolicyRequestAllOfConflictingAccessCriteria} - * @memberof SodPolicyRequest - */ - 'conflictingAccessCriteria'?: SodPolicyRequestAllOfConflictingAccessCriteria; -} - -export const SodPolicyRequestStateV3 = { - Enforced: 'ENFORCED', - NotEnforced: 'NOT_ENFORCED' -} as const; - -export type SodPolicyRequestStateV3 = typeof SodPolicyRequestStateV3[keyof typeof SodPolicyRequestStateV3]; -export const SodPolicyRequestTypeV3 = { - General: 'GENERAL', - ConflictingAccessBased: 'CONFLICTING_ACCESS_BASED' -} as const; - -export type SodPolicyRequestTypeV3 = typeof SodPolicyRequestTypeV3[keyof typeof SodPolicyRequestTypeV3]; - -/** - * - * @export - * @interface SodPolicyRequestAllOfConflictingAccessCriteria - */ -export interface SodPolicyRequestAllOfConflictingAccessCriteria { - /** - * - * @type {AccessCriteriaRequest} - * @memberof SodPolicyRequestAllOfConflictingAccessCriteria - */ - 'leftCriteria'?: AccessCriteriaRequest; - /** - * - * @type {AccessCriteriaRequest} - * @memberof SodPolicyRequestAllOfConflictingAccessCriteria - */ - 'rightCriteria'?: AccessCriteriaRequest; -} -/** - * - * @export - * @interface SodPolicySchedule - */ -export interface SodPolicySchedule { - /** - * SOD Policy schedule name - * @type {string} - * @memberof SodPolicySchedule - */ - 'name'?: string; - /** - * The time when this SOD policy schedule is created. - * @type {string} - * @memberof SodPolicySchedule - */ - 'created'?: string; - /** - * The time when this SOD policy schedule is modified. - * @type {string} - * @memberof SodPolicySchedule - */ - 'modified'?: string; - /** - * SOD Policy schedule description - * @type {string} - * @memberof SodPolicySchedule - */ - 'description'?: string; - /** - * - * @type {Schedule1} - * @memberof SodPolicySchedule - */ - 'schedule'?: Schedule1; - /** - * - * @type {Array} - * @memberof SodPolicySchedule - */ - 'recipients'?: Array; - /** - * Indicates if empty results need to be emailed - * @type {boolean} - * @memberof SodPolicySchedule - */ - 'emailEmptyResults'?: boolean; - /** - * Policy\'s creator ID - * @type {string} - * @memberof SodPolicySchedule - */ - 'creatorId'?: string; - /** - * Policy\'s modifier ID - * @type {string} - * @memberof SodPolicySchedule - */ - 'modifierId'?: string; -} -/** - * SOD policy recipient. - * @export - * @interface SodRecipient - */ -export interface SodRecipient { - /** - * SOD policy recipient DTO type. - * @type {string} - * @memberof SodRecipient - */ - 'type'?: SodRecipientTypeV3; - /** - * SOD policy recipient\'s identity ID. - * @type {string} - * @memberof SodRecipient - */ - 'id'?: string; - /** - * SOD policy recipient\'s display name. - * @type {string} - * @memberof SodRecipient - */ - 'name'?: string; -} - -export const SodRecipientTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type SodRecipientTypeV3 = typeof SodRecipientTypeV3[keyof typeof SodRecipientTypeV3]; - -/** - * SOD policy violation report result. - * @export - * @interface SodReportResultDto - */ -export interface SodReportResultDto { - /** - * SOD policy violation report result DTO type. - * @type {string} - * @memberof SodReportResultDto - */ - 'type'?: SodReportResultDtoTypeV3; - /** - * SOD policy violation report result ID. - * @type {string} - * @memberof SodReportResultDto - */ - 'id'?: string; - /** - * Human-readable name of the SOD policy violation report result. - * @type {string} - * @memberof SodReportResultDto - */ - 'name'?: string; -} - -export const SodReportResultDtoTypeV3 = { - ReportResult: 'REPORT_RESULT' -} as const; - -export type SodReportResultDtoTypeV3 = typeof SodReportResultDtoTypeV3[keyof typeof SodReportResultDtoTypeV3]; - -/** - * An object referencing an SOD violation check - * @export - * @interface SodViolationCheck - */ -export interface SodViolationCheck { - /** - * The id of the original request - * @type {string} - * @memberof SodViolationCheck - */ - 'requestId': string; - /** - * The date-time when this request was created. - * @type {string} - * @memberof SodViolationCheck - */ - 'created'?: string; -} -/** - * The inner object representing the completed SOD Violation check - * @export - * @interface SodViolationCheckResult - */ -export interface SodViolationCheckResult { - /** - * - * @type {ErrorMessageDto} - * @memberof SodViolationCheckResult - */ - 'message'?: ErrorMessageDto; - /** - * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. - * @type {{ [key: string]: string; }} - * @memberof SodViolationCheckResult - */ - 'clientMetadata'?: { [key: string]: string; } | null; - /** - * - * @type {Array} - * @memberof SodViolationCheckResult - */ - 'violationContexts'?: Array | null; - /** - * A list of the SOD policies that were violated. - * @type {Array} - * @memberof SodViolationCheckResult - */ - 'violatedPolicies'?: Array | null; -} -/** - * The contextual information of the violated criteria - * @export - * @interface SodViolationContext - */ -export interface SodViolationContext { - /** - * - * @type {SodPolicyDto1} - * @memberof SodViolationContext - */ - 'policy'?: SodPolicyDto1; - /** - * - * @type {SodViolationContextConflictingAccessCriteria} - * @memberof SodViolationContext - */ - 'conflictingAccessCriteria'?: SodViolationContextConflictingAccessCriteria; -} -/** - * An object referencing a completed SOD violation check - * @export - * @interface SodViolationContextCheckCompleted - */ -export interface SodViolationContextCheckCompleted { - /** - * The status of SOD violation check - * @type {string} - * @memberof SodViolationContextCheckCompleted - */ - 'state'?: SodViolationContextCheckCompletedStateV3 | null; - /** - * The id of the Violation check event - * @type {string} - * @memberof SodViolationContextCheckCompleted - */ - 'uuid'?: string | null; - /** - * - * @type {SodViolationCheckResult} - * @memberof SodViolationContextCheckCompleted - */ - 'violationCheckResult'?: SodViolationCheckResult; -} - -export const SodViolationContextCheckCompletedStateV3 = { - Success: 'SUCCESS', - Error: 'ERROR' -} as const; - -export type SodViolationContextCheckCompletedStateV3 = typeof SodViolationContextCheckCompletedStateV3[keyof typeof SodViolationContextCheckCompletedStateV3]; - -/** - * The object which contains the left and right hand side of the entitlements that got violated according to the policy. - * @export - * @interface SodViolationContextConflictingAccessCriteria - */ -export interface SodViolationContextConflictingAccessCriteria { - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteria} - * @memberof SodViolationContextConflictingAccessCriteria - */ - 'leftCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteria; - /** - * - * @type {SodViolationContextConflictingAccessCriteriaLeftCriteria} - * @memberof SodViolationContextConflictingAccessCriteria - */ - 'rightCriteria'?: SodViolationContextConflictingAccessCriteriaLeftCriteria; -} -/** - * - * @export - * @interface SodViolationContextConflictingAccessCriteriaLeftCriteria - */ -export interface SodViolationContextConflictingAccessCriteriaLeftCriteria { - /** - * - * @type {Array} - * @memberof SodViolationContextConflictingAccessCriteriaLeftCriteria - */ - 'criteriaList'?: Array; -} -/** - * - * @export - * @interface Source - */ -export interface Source { - /** - * Source ID. - * @type {string} - * @memberof Source - */ - 'id'?: string; - /** - * Source\'s human-readable name. - * @type {string} - * @memberof Source - */ - 'name': string; - /** - * Source\'s human-readable description. - * @type {string} - * @memberof Source - */ - 'description'?: string; - /** - * - * @type {SourceOwner} - * @memberof Source - */ - 'owner': SourceOwner | null; - /** - * - * @type {SourceCluster} - * @memberof Source - */ - 'cluster'?: SourceCluster | null; - /** - * - * @type {SourceAccountCorrelationConfig} - * @memberof Source - */ - 'accountCorrelationConfig'?: SourceAccountCorrelationConfig | null; - /** - * - * @type {SourceAccountCorrelationRule} - * @memberof Source - */ - 'accountCorrelationRule'?: SourceAccountCorrelationRule | null; - /** - * - * @type {SourceManagerCorrelationMapping} - * @memberof Source - */ - 'managerCorrelationMapping'?: SourceManagerCorrelationMapping; - /** - * - * @type {SourceManagerCorrelationRule} - * @memberof Source - */ - 'managerCorrelationRule'?: SourceManagerCorrelationRule | null; - /** - * - * @type {SourceBeforeProvisioningRule} - * @memberof Source - */ - 'beforeProvisioningRule'?: SourceBeforeProvisioningRule | null; - /** - * List of references to schema objects. - * @type {Array} - * @memberof Source - */ - 'schemas'?: Array; - /** - * List of references to the associated PasswordPolicy objects. - * @type {Array} - * @memberof Source - */ - 'passwordPolicies'?: Array | null; - /** - * Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM - * @type {Array} - * @memberof Source - */ - 'features'?: Array; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof Source - */ - 'type'?: string; - /** - * Connector script name. - * @type {string} - * @memberof Source - */ - 'connector': string; - /** - * Fully qualified name of the Java class that implements the connector interface. - * @type {string} - * @memberof Source - */ - 'connectorClass'?: string; - /** - * Connector specific configuration. This configuration will differ from type to type. - * @type {object} - * @memberof Source - */ - 'connectorAttributes'?: object; - /** - * Number from 0 to 100 that specifies when to skip the delete phase. - * @type {number} - * @memberof Source - */ - 'deleteThreshold'?: number; - /** - * When this is true, it indicates that the source is referenced by an identity profile. - * @type {boolean} - * @memberof Source - */ - 'authoritative'?: boolean; - /** - * - * @type {SourceManagementWorkgroup} - * @memberof Source - */ - 'managementWorkgroup'?: SourceManagementWorkgroup | null; - /** - * When this is true, it indicates that the source is healthy. - * @type {boolean} - * @memberof Source - */ - 'healthy'?: boolean; - /** - * Status identifier that gives specific information about why a source is or isn\'t healthy. - * @type {string} - * @memberof Source - */ - 'status'?: SourceStatusV3; - /** - * Timestamp that shows when a source health check was last performed. - * @type {string} - * @memberof Source - */ - 'since'?: string; - /** - * Connector ID - * @type {string} - * @memberof Source - */ - 'connectorId'?: string; - /** - * Name of the connector that was chosen during source creation. - * @type {string} - * @memberof Source - */ - 'connectorName'?: string; - /** - * Type of connection (direct or file). - * @type {string} - * @memberof Source - */ - 'connectionType'?: string; - /** - * Connector implementation ID. - * @type {string} - * @memberof Source - */ - 'connectorImplementationId'?: string; - /** - * Date-time when the source was created - * @type {string} - * @memberof Source - */ - 'created'?: string; - /** - * Date-time when the source was last modified. - * @type {string} - * @memberof Source - */ - 'modified'?: string; - /** - * If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. - * @type {boolean} - * @memberof Source - */ - 'credentialProviderEnabled'?: boolean; - /** - * Source category (e.g. null, CredentialProvider). - * @type {string} - * @memberof Source - */ - 'category'?: string | null; -} - -export const SourceFeaturesV3 = { - Authenticate: 'AUTHENTICATE', - Composite: 'COMPOSITE', - DirectPermissions: 'DIRECT_PERMISSIONS', - DiscoverSchema: 'DISCOVER_SCHEMA', - Enable: 'ENABLE', - ManagerLookup: 'MANAGER_LOOKUP', - NoRandomAccess: 'NO_RANDOM_ACCESS', - Proxy: 'PROXY', - Search: 'SEARCH', - Template: 'TEMPLATE', - Unlock: 'UNLOCK', - UnstructuredTargets: 'UNSTRUCTURED_TARGETS', - SharepointTarget: 'SHAREPOINT_TARGET', - Provisioning: 'PROVISIONING', - GroupProvisioning: 'GROUP_PROVISIONING', - SyncProvisioning: 'SYNC_PROVISIONING', - Password: 'PASSWORD', - CurrentPassword: 'CURRENT_PASSWORD', - AccountOnlyRequest: 'ACCOUNT_ONLY_REQUEST', - AdditionalAccountRequest: 'ADDITIONAL_ACCOUNT_REQUEST', - NoAggregation: 'NO_AGGREGATION', - GroupsHaveMembers: 'GROUPS_HAVE_MEMBERS', - NoPermissionsProvisioning: 'NO_PERMISSIONS_PROVISIONING', - NoGroupPermissionsProvisioning: 'NO_GROUP_PERMISSIONS_PROVISIONING', - NoUnstructuredTargetsProvisioning: 'NO_UNSTRUCTURED_TARGETS_PROVISIONING', - NoDirectPermissionsProvisioning: 'NO_DIRECT_PERMISSIONS_PROVISIONING', - PreferUuid: 'PREFER_UUID', - ArmSecurityExtract: 'ARM_SECURITY_EXTRACT', - ArmUtilizationExtract: 'ARM_UTILIZATION_EXTRACT', - ArmChangelogExtract: 'ARM_CHANGELOG_EXTRACT', - UsesUuid: 'USES_UUID', - ApplicationDiscovery: 'APPLICATION_DISCOVERY', - Delete: 'DELETE' -} as const; - -export type SourceFeaturesV3 = typeof SourceFeaturesV3[keyof typeof SourceFeaturesV3]; -export const SourceStatusV3 = { - SourceStateErrorAccountFileImport: 'SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT', - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceStatusV3 = typeof SourceStatusV3[keyof typeof SourceStatusV3]; - -/** - * Reference to account correlation config object. - * @export - * @interface SourceAccountCorrelationConfig - */ -export interface SourceAccountCorrelationConfig { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationConfig - */ - 'type'?: SourceAccountCorrelationConfigTypeV3; - /** - * Account correlation config ID. - * @type {string} - * @memberof SourceAccountCorrelationConfig - */ - 'id'?: string; - /** - * Account correlation config\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationConfig - */ - 'name'?: string; -} - -export const SourceAccountCorrelationConfigTypeV3 = { - AccountCorrelationConfig: 'ACCOUNT_CORRELATION_CONFIG' -} as const; - -export type SourceAccountCorrelationConfigTypeV3 = typeof SourceAccountCorrelationConfigTypeV3[keyof typeof SourceAccountCorrelationConfigTypeV3]; - -/** - * Reference to a rule that can do COMPLEX correlation. Only use this rule when you can\'t use accountCorrelationConfig. - * @export - * @interface SourceAccountCorrelationRule - */ -export interface SourceAccountCorrelationRule { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceAccountCorrelationRule - */ - 'type'?: SourceAccountCorrelationRuleTypeV3; - /** - * Rule ID. - * @type {string} - * @memberof SourceAccountCorrelationRule - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceAccountCorrelationRule - */ - 'name'?: string; -} - -export const SourceAccountCorrelationRuleTypeV3 = { - Rule: 'RULE' -} as const; - -export type SourceAccountCorrelationRuleTypeV3 = typeof SourceAccountCorrelationRuleTypeV3[keyof typeof SourceAccountCorrelationRuleTypeV3]; - -/** - * Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector. - * @export - * @interface SourceBeforeProvisioningRule - */ -export interface SourceBeforeProvisioningRule { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceBeforeProvisioningRule - */ - 'type'?: SourceBeforeProvisioningRuleTypeV3; - /** - * Rule ID. - * @type {string} - * @memberof SourceBeforeProvisioningRule - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceBeforeProvisioningRule - */ - 'name'?: string; -} - -export const SourceBeforeProvisioningRuleTypeV3 = { - Rule: 'RULE' -} as const; - -export type SourceBeforeProvisioningRuleTypeV3 = typeof SourceBeforeProvisioningRuleTypeV3[keyof typeof SourceBeforeProvisioningRuleTypeV3]; - -/** - * Reference to the source\'s associated cluster. - * @export - * @interface SourceCluster - */ -export interface SourceCluster { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceCluster - */ - 'type': SourceClusterTypeV3; - /** - * Cluster ID. - * @type {string} - * @memberof SourceCluster - */ - 'id': string; - /** - * Cluster\'s human-readable display name. - * @type {string} - * @memberof SourceCluster - */ - 'name': string; -} - -export const SourceClusterTypeV3 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterTypeV3 = typeof SourceClusterTypeV3[keyof typeof SourceClusterTypeV3]; - -/** - * Source cluster. - * @export - * @interface SourceClusterDto - */ -export interface SourceClusterDto { - /** - * Source cluster DTO type. - * @type {string} - * @memberof SourceClusterDto - */ - 'type'?: SourceClusterDtoTypeV3; - /** - * Source cluster ID. - * @type {string} - * @memberof SourceClusterDto - */ - 'id'?: string; - /** - * Source cluster display name. - * @type {string} - * @memberof SourceClusterDto - */ - 'name'?: string; -} - -export const SourceClusterDtoTypeV3 = { - Cluster: 'CLUSTER' -} as const; - -export type SourceClusterDtoTypeV3 = typeof SourceClusterDtoTypeV3[keyof typeof SourceClusterDtoTypeV3]; - -/** - * - * @export - * @interface SourceConnectionsDto - */ -export interface SourceConnectionsDto { - /** - * The IdentityProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'identityProfiles'?: Array; - /** - * Name of the CredentialProfile attached to this source - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'credentialProfiles'?: Array; - /** - * The attributes attached to this source - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'sourceAttributes'?: Array; - /** - * The profiles attached to this source - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'mappingProfiles'?: Array; - /** - * A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'dependentCustomTransforms'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'dependentApps'?: Array; - /** - * - * @type {Array} - * @memberof SourceConnectionsDto - */ - 'missingDependents'?: Array; -} -/** - * Dto for source health data - * @export - * @interface SourceHealthDto - */ -export interface SourceHealthDto { - /** - * the id of the Source - * @type {string} - * @memberof SourceHealthDto - */ - 'id'?: string; - /** - * Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. - * @type {string} - * @memberof SourceHealthDto - */ - 'type'?: string; - /** - * the name of the source - * @type {string} - * @memberof SourceHealthDto - */ - 'name'?: string; - /** - * source\'s org - * @type {string} - * @memberof SourceHealthDto - */ - 'org'?: string; - /** - * Is the source authoritative - * @type {boolean} - * @memberof SourceHealthDto - */ - 'isAuthoritative'?: boolean; - /** - * Is the source in a cluster - * @type {boolean} - * @memberof SourceHealthDto - */ - 'isCluster'?: boolean; - /** - * source\'s hostname - * @type {string} - * @memberof SourceHealthDto - */ - 'hostname'?: string; - /** - * source\'s pod - * @type {string} - * @memberof SourceHealthDto - */ - 'pod'?: string; - /** - * The version of the iqService - * @type {string} - * @memberof SourceHealthDto - */ - 'iqServiceVersion'?: string; - /** - * connection test result - * @type {string} - * @memberof SourceHealthDto - */ - 'status'?: SourceHealthDtoStatusV3; -} - -export const SourceHealthDtoStatusV3 = { - SourceStateErrorCluster: 'SOURCE_STATE_ERROR_CLUSTER', - SourceStateErrorSource: 'SOURCE_STATE_ERROR_SOURCE', - SourceStateErrorVa: 'SOURCE_STATE_ERROR_VA', - SourceStateFailureCluster: 'SOURCE_STATE_FAILURE_CLUSTER', - SourceStateFailureSource: 'SOURCE_STATE_FAILURE_SOURCE', - SourceStateHealthy: 'SOURCE_STATE_HEALTHY', - SourceStateUncheckedCluster: 'SOURCE_STATE_UNCHECKED_CLUSTER', - SourceStateUncheckedClusterNoSources: 'SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES', - SourceStateUncheckedSource: 'SOURCE_STATE_UNCHECKED_SOURCE', - SourceStateUncheckedSourceNoAccounts: 'SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS' -} as const; - -export type SourceHealthDtoStatusV3 = typeof SourceHealthDtoStatusV3[keyof typeof SourceHealthDtoStatusV3]; - -/** - * - * @export - * @interface SourceItemRef - */ -export interface SourceItemRef { - /** - * The id for the source on which account selections are made - * @type {string} - * @memberof SourceItemRef - */ - 'sourceId'?: string | null; - /** - * A list of account selections on the source. Currently, only one selection per source is supported. - * @type {Array} - * @memberof SourceItemRef - */ - 'accounts'?: Array | null; -} -/** - * Reference to management workgroup for the source. - * @export - * @interface SourceManagementWorkgroup - */ -export interface SourceManagementWorkgroup { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagementWorkgroup - */ - 'type'?: SourceManagementWorkgroupTypeV3; - /** - * Management workgroup ID. - * @type {string} - * @memberof SourceManagementWorkgroup - */ - 'id'?: string; - /** - * Management workgroup\'s human-readable display name. - * @type {string} - * @memberof SourceManagementWorkgroup - */ - 'name'?: string; -} - -export const SourceManagementWorkgroupTypeV3 = { - GovernanceGroup: 'GOVERNANCE_GROUP' -} as const; - -export type SourceManagementWorkgroupTypeV3 = typeof SourceManagementWorkgroupTypeV3[keyof typeof SourceManagementWorkgroupTypeV3]; - -/** - * - * @export - * @interface SourceManagerCorrelationMapping - */ -export interface SourceManagerCorrelationMapping { - /** - * Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. - * @type {string} - * @memberof SourceManagerCorrelationMapping - */ - 'accountAttributeName'?: string; - /** - * Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. - * @type {string} - * @memberof SourceManagerCorrelationMapping - */ - 'identityAttributeName'?: string; -} -/** - * Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn\'t sufficient. - * @export - * @interface SourceManagerCorrelationRule - */ -export interface SourceManagerCorrelationRule { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceManagerCorrelationRule - */ - 'type'?: SourceManagerCorrelationRuleTypeV3; - /** - * Rule ID. - * @type {string} - * @memberof SourceManagerCorrelationRule - */ - 'id'?: string; - /** - * Rule\'s human-readable display name. - * @type {string} - * @memberof SourceManagerCorrelationRule - */ - 'name'?: string; -} - -export const SourceManagerCorrelationRuleTypeV3 = { - Rule: 'RULE' -} as const; - -export type SourceManagerCorrelationRuleTypeV3 = typeof SourceManagerCorrelationRuleTypeV3[keyof typeof SourceManagerCorrelationRuleTypeV3]; - -/** - * Reference to identity object who owns the source. - * @export - * @interface SourceOwner - */ -export interface SourceOwner { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceOwner - */ - 'type'?: SourceOwnerTypeV3; - /** - * Owner identity\'s ID. - * @type {string} - * @memberof SourceOwner - */ - 'id'?: string; - /** - * Owner identity\'s human-readable display name. - * @type {string} - * @memberof SourceOwner - */ - 'name'?: string; -} - -export const SourceOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type SourceOwnerTypeV3 = typeof SourceOwnerTypeV3[keyof typeof SourceOwnerTypeV3]; - -/** - * - * @export - * @interface SourcePasswordPoliciesInner - */ -export interface SourcePasswordPoliciesInner { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourcePasswordPoliciesInner - */ - 'type'?: SourcePasswordPoliciesInnerTypeV3; - /** - * Policy ID. - * @type {string} - * @memberof SourcePasswordPoliciesInner - */ - 'id'?: string; - /** - * Policy\'s human-readable display name. - * @type {string} - * @memberof SourcePasswordPoliciesInner - */ - 'name'?: string; -} - -export const SourcePasswordPoliciesInnerTypeV3 = { - PasswordPolicy: 'PASSWORD_POLICY' -} as const; - -export type SourcePasswordPoliciesInnerTypeV3 = typeof SourcePasswordPoliciesInnerTypeV3[keyof typeof SourcePasswordPoliciesInnerTypeV3]; - -/** - * - * @export - * @interface SourceSchemasInner - */ -export interface SourceSchemasInner { - /** - * Type of object being referenced. - * @type {string} - * @memberof SourceSchemasInner - */ - 'type'?: SourceSchemasInnerTypeV3; - /** - * Schema ID. - * @type {string} - * @memberof SourceSchemasInner - */ - 'id'?: string; - /** - * Schema\'s human-readable display name. - * @type {string} - * @memberof SourceSchemasInner - */ - 'name'?: string; -} - -export const SourceSchemasInnerTypeV3 = { - ConnectorSchema: 'CONNECTOR_SCHEMA' -} as const; - -export type SourceSchemasInnerTypeV3 = typeof SourceSchemasInnerTypeV3[keyof typeof SourceSchemasInnerTypeV3]; - -/** - * - * @export - * @interface SourceUsage - */ -export interface SourceUsage { - /** - * The first day of the month for which activity is aggregated. - * @type {string} - * @memberof SourceUsage - */ - 'date'?: string; - /** - * The average number of days that accounts were active within this source, for the month. - * @type {number} - * @memberof SourceUsage - */ - 'count'?: number; -} -/** - * - * @export - * @interface SourceUsageStatus - */ -export interface SourceUsageStatus { - /** - * Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. - * @type {string} - * @memberof SourceUsageStatus - */ - 'status'?: SourceUsageStatusStatusV3; -} - -export const SourceUsageStatusStatusV3 = { - Complete: 'COMPLETE', - Incomplete: 'INCOMPLETE' -} as const; - -export type SourceUsageStatusStatusV3 = typeof SourceUsageStatusStatusV3[keyof typeof SourceUsageStatusStatusV3]; - -/** - * Message model for Config Import/Export. - * @export - * @interface SpConfigMessage - */ -export interface SpConfigMessage { - /** - * Message key. - * @type {string} - * @memberof SpConfigMessage - */ - 'key': string; - /** - * Message text. - * @type {string} - * @memberof SpConfigMessage - */ - 'text': string; - /** - * Message details if any, in key:value pairs. - * @type {{ [key: string]: any; }} - * @memberof SpConfigMessage - */ - 'details': { [key: string]: any; }; -} -/** - * - * @export - * @interface SpDetails - */ -export interface SpDetails { - /** - * Federation protocol role - * @type {string} - * @memberof SpDetails - */ - 'role'?: SpDetailsRoleV3; - /** - * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). - * @type {string} - * @memberof SpDetails - */ - 'entityId'?: string; - /** - * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. - * @type {string} - * @memberof SpDetails - */ - 'alias'?: string; - /** - * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetails - */ - 'callbackUrl': string; - /** - * The legacy ACS URL used for SAML authentication. Used with SP configurations. - * @type {string} - * @memberof SpDetails - */ - 'legacyAcsUrl'?: string; -} - -export const SpDetailsRoleV3 = { - SamlIdp: 'SAML_IDP', - SamlSp: 'SAML_SP' -} as const; - -export type SpDetailsRoleV3 = typeof SpDetailsRoleV3[keyof typeof SpDetailsRoleV3]; - -/** - * - * @export - * @interface Split - */ -export interface Split { - /** - * This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data - * @type {string} - * @memberof Split - */ - 'delimiter': string; - /** - * An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - * @type {string} - * @memberof Split - */ - 'index': string; - /** - * A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return \"IndexOutOfBoundsException\" `false` - The transform should return null If not provided, the transform will default to false and return a null - * @type {boolean} - * @memberof Split - */ - 'throws'?: boolean; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Split - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Split - */ - 'input'?: { [key: string]: any; }; -} -/** - * Standard Log4j log level - * @export - * @enum {string} - */ - -export const StandardLevel = { - False: 'false', - Fatal: 'FATAL', - Error: 'ERROR', - Warn: 'WARN', - Info: 'INFO', - Debug: 'DEBUG', - Trace: 'TRACE' -} as const; - -export type StandardLevel = typeof StandardLevel[keyof typeof StandardLevel]; - - -/** - * - * @export - * @interface Static - */ -export interface Static { - /** - * This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. - * @type {string} - * @memberof Static - */ - 'values': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Static - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface SubSearchAggregationSpecification - */ -export interface SubSearchAggregationSpecification { - /** - * - * @type {NestedAggregation} - * @memberof SubSearchAggregationSpecification - */ - 'nested'?: NestedAggregation; - /** - * - * @type {MetricAggregation} - * @memberof SubSearchAggregationSpecification - */ - 'metric'?: MetricAggregation; - /** - * - * @type {FilterAggregation} - * @memberof SubSearchAggregationSpecification - */ - 'filter'?: FilterAggregation; - /** - * - * @type {BucketAggregation} - * @memberof SubSearchAggregationSpecification - */ - 'bucket'?: BucketAggregation; - /** - * - * @type {Aggregations} - * @memberof SubSearchAggregationSpecification - */ - 'subAggregation'?: Aggregations; -} -/** - * - * @export - * @interface Substring - */ -export interface Substring { - /** - * The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data - * @type {number} - * @memberof Substring - */ - 'begin': number; - /** - * This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. - * @type {number} - * @memberof Substring - */ - 'beginOffset'?: number; - /** - * The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. - * @type {number} - * @memberof Substring - */ - 'end'?: number; - /** - * This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. - * @type {number} - * @memberof Substring - */ - 'endOffset'?: number; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Substring - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Substring - */ - 'input'?: { [key: string]: any; }; -} -/** - * Tagged object. - * @export - * @interface TaggedObject - */ -export interface TaggedObject { - /** - * - * @type {TaggedObjectDto} - * @memberof TaggedObject - */ - 'objectRef'?: TaggedObjectDto; - /** - * Labels to be applied to an Object - * @type {Array} - * @memberof TaggedObject - */ - 'tags'?: Array; -} -/** - * - * @export - * @interface TaggedObjectDto - */ -export interface TaggedObjectDto { - /** - * DTO type - * @type {string} - * @memberof TaggedObjectDto - */ - 'type'?: TaggedObjectDtoTypeV3; - /** - * ID of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDto - */ - 'id'?: string; - /** - * Human-readable display name of the object this reference applies to - * @type {string} - * @memberof TaggedObjectDto - */ - 'name'?: string | null; -} - -export const TaggedObjectDtoTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; - -export type TaggedObjectDtoTypeV3 = typeof TaggedObjectDtoTypeV3[keyof typeof TaggedObjectDtoTypeV3]; - -/** - * Details about job or task type, state and lifecycle. - * @export - * @interface TaskResultDetails - */ -export interface TaskResultDetails { - /** - * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. - * @type {string} - * @memberof TaskResultDetails - */ - 'type'?: TaskResultDetailsTypeV3; - /** - * Unique task definition identifier. - * @type {string} - * @memberof TaskResultDetails - */ - 'id'?: string; - /** - * Use this property to define what report should be processed in the RDE service. - * @type {string} - * @memberof TaskResultDetails - */ - 'reportType'?: TaskResultDetailsReportTypeV3; - /** - * Description of the report purpose and/or contents. - * @type {string} - * @memberof TaskResultDetails - */ - 'description'?: string; - /** - * Name of the parent task/report if exists. - * @type {string} - * @memberof TaskResultDetails - */ - 'parentName'?: string | null; - /** - * Name of the report processing initiator. - * @type {string} - * @memberof TaskResultDetails - */ - 'launcher'?: string; - /** - * Report creation date - * @type {string} - * @memberof TaskResultDetails - */ - 'created'?: string; - /** - * Report start date - * @type {string} - * @memberof TaskResultDetails - */ - 'launched'?: string | null; - /** - * Report completion date - * @type {string} - * @memberof TaskResultDetails - */ - 'completed'?: string | null; - /** - * Report completion status. - * @type {string} - * @memberof TaskResultDetails - */ - 'completionStatus'?: TaskResultDetailsCompletionStatusV3 | null; - /** - * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. - * @type {Array} - * @memberof TaskResultDetails - */ - 'messages'?: Array; - /** - * Task definition results, if necessary. - * @type {Array} - * @memberof TaskResultDetails - */ - 'returns'?: Array; - /** - * Extra attributes map(dictionary) needed for the report. - * @type {object} - * @memberof TaskResultDetails - */ - 'attributes'?: object; - /** - * Current report state. - * @type {string} - * @memberof TaskResultDetails - */ - 'progress'?: string | null; -} - -export const TaskResultDetailsTypeV3 = { - Quartz: 'QUARTZ', - Qpoc: 'QPOC', - Mentos: 'MENTOS', - QueuedTask: 'QUEUED_TASK' -} as const; - -export type TaskResultDetailsTypeV3 = typeof TaskResultDetailsTypeV3[keyof typeof TaskResultDetailsTypeV3]; -export const TaskResultDetailsReportTypeV3 = { - Accounts: 'ACCOUNTS', - IdentitiesDetails: 'IDENTITIES_DETAILS', - Identities: 'IDENTITIES', - IdentityProfileIdentityError: 'IDENTITY_PROFILE_IDENTITY_ERROR', - OrphanIdentities: 'ORPHAN_IDENTITIES', - SearchExport: 'SEARCH_EXPORT', - UncorrelatedAccounts: 'UNCORRELATED_ACCOUNTS' -} as const; - -export type TaskResultDetailsReportTypeV3 = typeof TaskResultDetailsReportTypeV3[keyof typeof TaskResultDetailsReportTypeV3]; -export const TaskResultDetailsCompletionStatusV3 = { - Success: 'SUCCESS', - Warning: 'WARNING', - Error: 'ERROR', - Terminated: 'TERMINATED', - TempError: 'TEMP_ERROR' -} as const; - -export type TaskResultDetailsCompletionStatusV3 = typeof TaskResultDetailsCompletionStatusV3[keyof typeof TaskResultDetailsCompletionStatusV3]; - -/** - * - * @export - * @interface TaskResultDetailsMessagesInner - */ -export interface TaskResultDetailsMessagesInner { - /** - * Type of the message. - * @type {string} - * @memberof TaskResultDetailsMessagesInner - */ - 'type'?: TaskResultDetailsMessagesInnerTypeV3; - /** - * Flag whether message is an error. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInner - */ - 'error'?: boolean; - /** - * Flag whether message is a warning. - * @type {boolean} - * @memberof TaskResultDetailsMessagesInner - */ - 'warning'?: boolean; - /** - * Message string identifier. - * @type {string} - * @memberof TaskResultDetailsMessagesInner - */ - 'key'?: string; - /** - * Message context with the locale based language. - * @type {string} - * @memberof TaskResultDetailsMessagesInner - */ - 'localizedText'?: string; -} - -export const TaskResultDetailsMessagesInnerTypeV3 = { - Info: 'INFO', - Warn: 'WARN', - Error: 'ERROR' -} as const; - -export type TaskResultDetailsMessagesInnerTypeV3 = typeof TaskResultDetailsMessagesInnerTypeV3[keyof typeof TaskResultDetailsMessagesInnerTypeV3]; - -/** - * - * @export - * @interface TaskResultDetailsReturnsInner - */ -export interface TaskResultDetailsReturnsInner { - /** - * Attribute description. - * @type {string} - * @memberof TaskResultDetailsReturnsInner - */ - 'displayLabel'?: string; - /** - * System or database attribute name. - * @type {string} - * @memberof TaskResultDetailsReturnsInner - */ - 'attributeName'?: string; -} -/** - * Task result. - * @export - * @interface TaskResultDto - */ -export interface TaskResultDto { - /** - * Task result DTO type. - * @type {string} - * @memberof TaskResultDto - */ - 'type'?: TaskResultDtoTypeV3; - /** - * Task result ID. - * @type {string} - * @memberof TaskResultDto - */ - 'id'?: string; - /** - * Task result display name. - * @type {string} - * @memberof TaskResultDto - */ - 'name'?: string | null; -} - -export const TaskResultDtoTypeV3 = { - TaskResult: 'TASK_RESULT' -} as const; - -export type TaskResultDtoTypeV3 = typeof TaskResultDtoTypeV3[keyof typeof TaskResultDtoTypeV3]; - -/** - * - * @export - * @interface TaskResultSimplified - */ -export interface TaskResultSimplified { - /** - * Task identifier - * @type {string} - * @memberof TaskResultSimplified - */ - 'id'?: string; - /** - * Task name - * @type {string} - * @memberof TaskResultSimplified - */ - 'name'?: string; - /** - * Task description - * @type {string} - * @memberof TaskResultSimplified - */ - 'description'?: string; - /** - * User or process who launched the task - * @type {string} - * @memberof TaskResultSimplified - */ - 'launcher'?: string; - /** - * Date time of completion - * @type {string} - * @memberof TaskResultSimplified - */ - 'completed'?: string; - /** - * Date time when the task was launched - * @type {string} - * @memberof TaskResultSimplified - */ - 'launched'?: string; - /** - * Task result status - * @type {string} - * @memberof TaskResultSimplified - */ - 'completionStatus'?: TaskResultSimplifiedCompletionStatusV3; -} - -export const TaskResultSimplifiedCompletionStatusV3 = { - Success: 'Success', - Warning: 'Warning', - Error: 'Error', - Terminated: 'Terminated', - TempError: 'TempError' -} as const; - -export type TaskResultSimplifiedCompletionStatusV3 = typeof TaskResultSimplifiedCompletionStatusV3[keyof typeof TaskResultSimplifiedCompletionStatusV3]; - -/** - * - * @export - * @interface TestExternalExecuteWorkflow200Response - */ -export interface TestExternalExecuteWorkflow200Response { - /** - * The input that was received - * @type {object} - * @memberof TestExternalExecuteWorkflow200Response - */ - 'payload'?: object; -} -/** - * - * @export - * @interface TestExternalExecuteWorkflowRequest - */ -export interface TestExternalExecuteWorkflowRequest { - /** - * The test input for the workflow - * @type {object} - * @memberof TestExternalExecuteWorkflowRequest - */ - 'input'?: object; -} -/** - * - * @export - * @interface TestWorkflow200Response - */ -export interface TestWorkflow200Response { - /** - * The workflow execution id - * @type {string} - * @memberof TestWorkflow200Response - */ - 'workflowExecutionId'?: string; -} -/** - * - * @export - * @interface TestWorkflowRequest - */ -export interface TestWorkflowRequest { - /** - * The test input for the workflow. - * @type {object} - * @memberof TestWorkflowRequest - */ - 'input': object; -} -/** - * Query parameters used to construct an Elasticsearch text query object. - * @export - * @interface TextQuery - */ -export interface TextQuery { - /** - * Words or characters that specify a particular thing to be searched for. - * @type {Array} - * @memberof TextQuery - */ - 'terms': Array; - /** - * The fields to be searched. - * @type {Array} - * @memberof TextQuery - */ - 'fields': Array; - /** - * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - * @type {boolean} - * @memberof TextQuery - */ - 'matchAny'?: boolean; - /** - * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - * @type {boolean} - * @memberof TextQuery - */ - 'contains'?: boolean; -} -/** - * - * @export - * @interface TokenAuthRequest - */ -export interface TokenAuthRequest { - /** - * Token value - * @type {string} - * @memberof TokenAuthRequest - */ - 'token': string; - /** - * User alias from table spt_identity field named \'name\' - * @type {string} - * @memberof TokenAuthRequest - */ - 'userAlias': string; - /** - * Token delivery type - * @type {string} - * @memberof TokenAuthRequest - */ - 'deliveryType': TokenAuthRequestDeliveryTypeV3; -} - -export const TokenAuthRequestDeliveryTypeV3 = { - SmsPersonal: 'SMS_PERSONAL', - VoicePersonal: 'VOICE_PERSONAL', - SmsWork: 'SMS_WORK', - VoiceWork: 'VOICE_WORK', - EmailWork: 'EMAIL_WORK', - EmailPersonal: 'EMAIL_PERSONAL' -} as const; - -export type TokenAuthRequestDeliveryTypeV3 = typeof TokenAuthRequestDeliveryTypeV3[keyof typeof TokenAuthRequestDeliveryTypeV3]; - -/** - * - * @export - * @interface TokenAuthResponse - */ -export interface TokenAuthResponse { - /** - * MFA Authentication status - * @type {string} - * @memberof TokenAuthResponse - */ - 'status'?: TokenAuthResponseStatusV3; -} - -export const TokenAuthResponseStatusV3 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type TokenAuthResponseStatusV3 = typeof TokenAuthResponseStatusV3[keyof typeof TokenAuthResponseStatusV3]; - -/** - * The representation of an internally- or customer-defined transform. - * @export - * @interface Transform - */ -export interface Transform { - /** - * Unique name of this transform - * @type {string} - * @memberof Transform - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof Transform - */ - 'type': TransformTypeV3; - /** - * - * @type {TransformAttributes} - * @memberof Transform - */ - 'attributes': TransformAttributes | null; -} - -export const TransformTypeV3 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformTypeV3 = typeof TransformTypeV3[keyof typeof TransformTypeV3]; - -/** - * @type TransformAttributes - * Meta-data about the transform. Values in this list are specific to the type of transform to be executed. - * @export - */ -export type TransformAttributes = AccountAttribute | Base64Decode | Base64Encode | Concatenation | Conditional | DateCompare | DateFormat | DateMath | DecomposeDiacriticalMarks | E164phone | FirstValid | ISO3166 | IdentityAttribute | IndexOf | LeftPad | Lookup | Lower | NameNormalizer | RandomAlphaNumeric | RandomNumeric | Reference | Replace | ReplaceAll | RightPad | Rule | Split | Static | Substring | Trim | UUIDGenerator | Upper; - -/** - * - * @export - * @interface TransformDefinition - */ -export interface TransformDefinition { - /** - * Transform definition type. - * @type {string} - * @memberof TransformDefinition - */ - 'type'?: string; - /** - * Arbitrary key-value pairs to store any metadata for the object - * @type {{ [key: string]: any; }} - * @memberof TransformDefinition - */ - 'attributes'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface TransformRead - */ -export interface TransformRead { - /** - * Unique name of this transform - * @type {string} - * @memberof TransformRead - */ - 'name': string; - /** - * The type of transform operation - * @type {string} - * @memberof TransformRead - */ - 'type': TransformReadTypeV3; - /** - * - * @type {TransformAttributes} - * @memberof TransformRead - */ - 'attributes': TransformAttributes | null; - /** - * Unique ID of this transform - * @type {string} - * @memberof TransformRead - */ - 'id': string; - /** - * Indicates whether this is an internal SailPoint-created transform or a customer-created transform - * @type {boolean} - * @memberof TransformRead - */ - 'internal': boolean; -} - -export const TransformReadTypeV3 = { - AccountAttribute: 'accountAttribute', - Base64Decode: 'base64Decode', - Base64Encode: 'base64Encode', - Concat: 'concat', - Conditional: 'conditional', - DateCompare: 'dateCompare', - DateFormat: 'dateFormat', - DateMath: 'dateMath', - DecomposeDiacriticalMarks: 'decomposeDiacriticalMarks', - E164phone: 'e164phone', - FirstValid: 'firstValid', - Rule: 'rule', - IdentityAttribute: 'identityAttribute', - IndexOf: 'indexOf', - Iso3166: 'iso3166', - LastIndexOf: 'lastIndexOf', - LeftPad: 'leftPad', - Lookup: 'lookup', - Lower: 'lower', - NormalizeNames: 'normalizeNames', - RandomAlphaNumeric: 'randomAlphaNumeric', - RandomNumeric: 'randomNumeric', - Reference: 'reference', - ReplaceAll: 'replaceAll', - Replace: 'replace', - RightPad: 'rightPad', - Split: 'split', - Static: 'static', - Substring: 'substring', - Trim: 'trim', - Upper: 'upper', - UsernameGenerator: 'usernameGenerator', - Uuid: 'uuid', - DisplayName: 'displayName', - Rfc5646: 'rfc5646' -} as const; - -export type TransformReadTypeV3 = typeof TransformReadTypeV3[keyof typeof TransformReadTypeV3]; - -/** - * - * @export - * @interface TransformRule - */ -export interface TransformRule { - /** - * This is the name of the Transform rule that needs to be invoked by the transform - * @type {string} - * @memberof TransformRule - */ - 'name': string; - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof TransformRule - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * - * @export - * @interface Trim - */ -export interface Trim { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Trim - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Trim - */ - 'input'?: { [key: string]: any; }; -} -/** - * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" - * @export - * @interface TypeAheadQuery - */ -export interface TypeAheadQuery { - /** - * The type ahead query string used to construct a phrase prefix match query. - * @type {string} - * @memberof TypeAheadQuery - */ - 'query': string; - /** - * The field on which to perform the type ahead search. - * @type {string} - * @memberof TypeAheadQuery - */ - 'field': string; - /** - * The nested type. - * @type {string} - * @memberof TypeAheadQuery - */ - 'nestedType'?: string; - /** - * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. - * @type {number} - * @memberof TypeAheadQuery - */ - 'maxExpansions'?: number; - /** - * The max amount of records the search will return. - * @type {number} - * @memberof TypeAheadQuery - */ - 'size'?: number; - /** - * The sort order of the returned records. - * @type {string} - * @memberof TypeAheadQuery - */ - 'sort'?: string; - /** - * The flag that defines the sort type, by count or value. - * @type {boolean} - * @memberof TypeAheadQuery - */ - 'sortByValue'?: boolean; -} -/** - * A typed reference to the object. - * @export - * @interface TypedReference - */ -export interface TypedReference { - /** - * - * @type {DtoType} - * @memberof TypedReference - */ - 'type': DtoType; - /** - * The id of the object. - * @type {string} - * @memberof TypedReference - */ - 'id': string; -} - - -/** - * - * @export - * @interface UUIDGenerator - */ -export interface UUIDGenerator { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof UUIDGenerator - */ - 'requiresPeriodicRefresh'?: boolean; -} -/** - * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) - * @export - * @interface UncorrelatedAccountsReportArguments - */ -export interface UncorrelatedAccountsReportArguments { - /** - * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. - * @type {Array} - * @memberof UncorrelatedAccountsReportArguments - */ - 'selectedFormats'?: Array; -} - -export const UncorrelatedAccountsReportArgumentsSelectedFormatsV3 = { - Csv: 'CSV', - Pdf: 'PDF' -} as const; - -export type UncorrelatedAccountsReportArgumentsSelectedFormatsV3 = typeof UncorrelatedAccountsReportArgumentsSelectedFormatsV3[keyof typeof UncorrelatedAccountsReportArgumentsSelectedFormatsV3]; - -/** - * - * @export - * @interface UpdateDetail - */ -export interface UpdateDetail { - /** - * The detailed message for an update. Typically the relevent error message when status is error. - * @type {string} - * @memberof UpdateDetail - */ - 'message'?: string; - /** - * The connector script name - * @type {string} - * @memberof UpdateDetail - */ - 'scriptName'?: string; - /** - * The list of updated files supported by the connector - * @type {Array} - * @memberof UpdateDetail - */ - 'updatedFiles'?: Array | null; - /** - * The connector update status - * @type {string} - * @memberof UpdateDetail - */ - 'status'?: UpdateDetailStatusV3; -} - -export const UpdateDetailStatusV3 = { - Error: 'ERROR', - Updated: 'UPDATED', - Unchanged: 'UNCHANGED', - Skipped: 'SKIPPED' -} as const; - -export type UpdateDetailStatusV3 = typeof UpdateDetailStatusV3[keyof typeof UpdateDetailStatusV3]; - -/** - * - * @export - * @interface Upper - */ -export interface Upper { - /** - * A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process - * @type {boolean} - * @memberof Upper - */ - 'requiresPeriodicRefresh'?: boolean; - /** - * This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. - * @type {{ [key: string]: any; }} - * @memberof Upper - */ - 'input'?: { [key: string]: any; }; -} -/** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @export - * @enum {string} - */ - -export const UsageType = { - Create: 'CREATE', - Update: 'UPDATE', - Enable: 'ENABLE', - Disable: 'DISABLE', - Delete: 'DELETE', - Assign: 'ASSIGN', - Unassign: 'UNASSIGN', - CreateGroup: 'CREATE_GROUP', - UpdateGroup: 'UPDATE_GROUP', - DeleteGroup: 'DELETE_GROUP', - Register: 'REGISTER', - CreateIdentity: 'CREATE_IDENTITY', - UpdateIdentity: 'UPDATE_IDENTITY', - EditGroup: 'EDIT_GROUP', - Unlock: 'UNLOCK', - ChangePassword: 'CHANGE_PASSWORD' -} as const; - -export type UsageType = typeof UsageType[keyof typeof UsageType]; - - -/** - * - * @export - * @interface V3ConnectorDto - */ -export interface V3ConnectorDto { - /** - * The connector name - * @type {string} - * @memberof V3ConnectorDto - */ - 'name'?: string; - /** - * The connector type - * @type {string} - * @memberof V3ConnectorDto - */ - 'type'?: string; - /** - * The connector script name - * @type {string} - * @memberof V3ConnectorDto - */ - 'scriptName'?: string; - /** - * The connector class name. - * @type {string} - * @memberof V3ConnectorDto - */ - 'className'?: string | null; - /** - * The list of features supported by the connector - * @type {Array} - * @memberof V3ConnectorDto - */ - 'features'?: Array | null; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3ConnectorDto - */ - 'directConnect'?: boolean; - /** - * A map containing metadata pertinent to the connector - * @type {{ [key: string]: any; }} - * @memberof V3ConnectorDto - */ - 'connectorMetadata'?: { [key: string]: any; }; - /** - * The connector status - * @type {string} - * @memberof V3ConnectorDto - */ - 'status'?: V3ConnectorDtoStatusV3; -} - -export const V3ConnectorDtoStatusV3 = { - Deprecated: 'DEPRECATED', - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3ConnectorDtoStatusV3 = typeof V3ConnectorDtoStatusV3[keyof typeof V3ConnectorDtoStatusV3]; - -/** - * - * @export - * @interface V3CreateConnectorDto - */ -export interface V3CreateConnectorDto { - /** - * The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - * @type {string} - * @memberof V3CreateConnectorDto - */ - 'name': string; - /** - * The connector type. If not specified will be defaulted to \'custom \'+name - * @type {string} - * @memberof V3CreateConnectorDto - */ - 'type'?: string; - /** - * The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - * @type {string} - * @memberof V3CreateConnectorDto - */ - 'className': string; - /** - * true if the source is a direct connect source - * @type {boolean} - * @memberof V3CreateConnectorDto - */ - 'directConnect'?: boolean; - /** - * The connector status - * @type {string} - * @memberof V3CreateConnectorDto - */ - 'status'?: V3CreateConnectorDtoStatusV3; -} - -export const V3CreateConnectorDtoStatusV3 = { - Development: 'DEVELOPMENT', - Demo: 'DEMO', - Released: 'RELEASED' -} as const; - -export type V3CreateConnectorDtoStatusV3 = typeof V3CreateConnectorDtoStatusV3[keyof typeof V3CreateConnectorDtoStatusV3]; - -/** - * - * @export - * @interface Value - */ -export interface Value { - /** - * The type of attribute value - * @type {string} - * @memberof Value - */ - 'type'?: string; - /** - * The attribute value - * @type {string} - * @memberof Value - */ - 'value'?: string; -} -/** - * - * @export - * @interface VerificationPollRequest - */ -export interface VerificationPollRequest { - /** - * Verification request Id - * @type {string} - * @memberof VerificationPollRequest - */ - 'requestId': string; -} -/** - * - * @export - * @interface VerificationResponse - */ -export interface VerificationResponse { - /** - * The verificationPollRequest request ID - * @type {string} - * @memberof VerificationResponse - */ - 'requestId'?: string | null; - /** - * MFA Authentication status - * @type {string} - * @memberof VerificationResponse - */ - 'status'?: VerificationResponseStatusV3; - /** - * Error messages from MFA verification request - * @type {string} - * @memberof VerificationResponse - */ - 'error'?: string | null; -} - -export const VerificationResponseStatusV3 = { - Pending: 'PENDING', - Success: 'SUCCESS', - Failed: 'FAILED', - Lockout: 'LOCKOUT', - NotEnoughData: 'NOT_ENOUGH_DATA' -} as const; - -export type VerificationResponseStatusV3 = typeof VerificationResponseStatusV3[keyof typeof VerificationResponseStatusV3]; - -/** - * - * @export - * @interface ViolationContext - */ -export interface ViolationContext { - /** - * - * @type {ViolationContextPolicy} - * @memberof ViolationContext - */ - 'policy'?: ViolationContextPolicy; - /** - * - * @type {ExceptionAccessCriteria} - * @memberof ViolationContext - */ - 'conflictingAccessCriteria'?: ExceptionAccessCriteria; -} -/** - * The types of objects supported for SOD violations - * @export - * @interface ViolationContextPolicy - */ -export interface ViolationContextPolicy { - /** - * The type of object that is referenced - * @type {object} - * @memberof ViolationContextPolicy - */ - 'type'?: ViolationContextPolicyTypeV3; - /** - * SOD policy ID. - * @type {string} - * @memberof ViolationContextPolicy - */ - 'id'?: string; - /** - * - * @type {string} - * @memberof ViolationContextPolicy - */ - 'name'?: string; -} - -export const ViolationContextPolicyTypeV3 = { - Entitlement: 'ENTITLEMENT' -} as const; - -export type ViolationContextPolicyTypeV3 = typeof ViolationContextPolicyTypeV3[keyof typeof ViolationContextPolicyTypeV3]; - -/** - * - * @export - * @interface ViolationOwnerAssignmentConfig - */ -export interface ViolationOwnerAssignmentConfig { - /** - * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity - * @type {string} - * @memberof ViolationOwnerAssignmentConfig - */ - 'assignmentRule'?: ViolationOwnerAssignmentConfigAssignmentRuleV3 | null; - /** - * - * @type {ViolationOwnerAssignmentConfigOwnerRef} - * @memberof ViolationOwnerAssignmentConfig - */ - 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRef | null; -} - -export const ViolationOwnerAssignmentConfigAssignmentRuleV3 = { - Manager: 'MANAGER', - Static: 'STATIC' -} as const; - -export type ViolationOwnerAssignmentConfigAssignmentRuleV3 = typeof ViolationOwnerAssignmentConfigAssignmentRuleV3[keyof typeof ViolationOwnerAssignmentConfigAssignmentRuleV3]; - -/** - * The owner of the violation assignment config. - * @export - * @interface ViolationOwnerAssignmentConfigOwnerRef - */ -export interface ViolationOwnerAssignmentConfigOwnerRef { - /** - * Owner type. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRef - */ - 'type'?: ViolationOwnerAssignmentConfigOwnerRefTypeV3 | null; - /** - * Owner\'s ID. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRef - */ - 'id'?: string; - /** - * Owner\'s name. - * @type {string} - * @memberof ViolationOwnerAssignmentConfigOwnerRef - */ - 'name'?: string; -} - -export const ViolationOwnerAssignmentConfigOwnerRefTypeV3 = { - Identity: 'IDENTITY', - GovernanceGroup: 'GOVERNANCE_GROUP', - Manager: 'MANAGER' -} as const; - -export type ViolationOwnerAssignmentConfigOwnerRefTypeV3 = typeof ViolationOwnerAssignmentConfigOwnerRefTypeV3[keyof typeof ViolationOwnerAssignmentConfigOwnerRefTypeV3]; - -/** - * An object containing a listing of the SOD violation reasons detected by this check. - * @export - * @interface ViolationPrediction - */ -export interface ViolationPrediction { - /** - * List of Violation Contexts - * @type {Array} - * @memberof ViolationPrediction - */ - 'violationContexts'?: Array; -} -/** - * - * @export - * @interface VisibilityCriteria - */ -export interface VisibilityCriteria { - /** - * - * @type {Expression} - * @memberof VisibilityCriteria - */ - 'expression'?: Expression; -} -/** - * - * @export - * @interface WorkItemForward - */ -export interface WorkItemForward { - /** - * The ID of the identity to forward this work item to. - * @type {string} - * @memberof WorkItemForward - */ - 'targetOwnerId': string; - /** - * Comments to send to the target owner - * @type {string} - * @memberof WorkItemForward - */ - 'comment': string; - /** - * If true, send a notification to the target owner. - * @type {boolean} - * @memberof WorkItemForward - */ - 'sendNotifications'?: boolean; -} -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemState = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemState = typeof WorkItemState[keyof typeof WorkItemState]; - - -/** - * The state of a work item - * @export - * @enum {string} - */ - -export const WorkItemStateManualWorkItems = { - Finished: 'Finished', - Rejected: 'Rejected', - Returned: 'Returned', - Expired: 'Expired', - Pending: 'Pending', - Canceled: 'Canceled' -} as const; - -export type WorkItemStateManualWorkItems = typeof WorkItemStateManualWorkItems[keyof typeof WorkItemStateManualWorkItems]; - - -/** - * The type of the work item - * @export - * @enum {string} - */ - -export const WorkItemTypeManualWorkItems = { - Generic: 'Generic', - Certification: 'Certification', - Remediation: 'Remediation', - Delegation: 'Delegation', - Approval: 'Approval', - ViolationReview: 'ViolationReview', - Form: 'Form', - PolicyVioloation: 'PolicyVioloation', - Challenge: 'Challenge', - ImpactAnalysis: 'ImpactAnalysis', - Signoff: 'Signoff', - Event: 'Event', - ManualAction: 'ManualAction', - Test: 'Test' -} as const; - -export type WorkItemTypeManualWorkItems = typeof WorkItemTypeManualWorkItems[keyof typeof WorkItemTypeManualWorkItems]; - - -/** - * - * @export - * @interface WorkItems - */ -export interface WorkItems { - /** - * ID of the work item - * @type {string} - * @memberof WorkItems - */ - 'id'?: string; - /** - * ID of the requester - * @type {string} - * @memberof WorkItems - */ - 'requesterId'?: string | null; - /** - * The displayname of the requester - * @type {string} - * @memberof WorkItems - */ - 'requesterDisplayName'?: string | null; - /** - * The ID of the owner - * @type {string} - * @memberof WorkItems - */ - 'ownerId'?: string | null; - /** - * The name of the owner - * @type {string} - * @memberof WorkItems - */ - 'ownerName'?: string; - /** - * Time when the work item was created - * @type {string} - * @memberof WorkItems - */ - 'created'?: string; - /** - * Time when the work item was last updated - * @type {string} - * @memberof WorkItems - */ - 'modified'?: string | null; - /** - * The description of the work item - * @type {string} - * @memberof WorkItems - */ - 'description'?: string; - /** - * - * @type {WorkItemStateManualWorkItems} - * @memberof WorkItems - */ - 'state'?: WorkItemStateManualWorkItems; - /** - * - * @type {WorkItemTypeManualWorkItems} - * @memberof WorkItems - */ - 'type'?: WorkItemTypeManualWorkItems; - /** - * A list of remediation items - * @type {Array} - * @memberof WorkItems - */ - 'remediationItems'?: Array | null; - /** - * A list of items that need to be approved - * @type {Array} - * @memberof WorkItems - */ - 'approvalItems'?: Array | null; - /** - * The work item name - * @type {string} - * @memberof WorkItems - */ - 'name'?: string | null; - /** - * The time at which the work item completed - * @type {string} - * @memberof WorkItems - */ - 'completed'?: string | null; - /** - * The number of items in the work item - * @type {number} - * @memberof WorkItems - */ - 'numItems'?: number | null; - /** - * - * @type {WorkItemsForm} - * @memberof WorkItems - */ - 'form'?: WorkItemsForm; - /** - * An array of errors that ocurred during the work item - * @type {Array} - * @memberof WorkItems - */ - 'errors'?: Array; -} - - -/** - * - * @export - * @interface WorkItemsCount - */ -export interface WorkItemsCount { - /** - * The count of work items - * @type {number} - * @memberof WorkItemsCount - */ - 'count'?: number; -} -/** - * - * @export - * @interface WorkItemsForm - */ -export interface WorkItemsForm { - /** - * ID of the form - * @type {string} - * @memberof WorkItemsForm - */ - 'id'?: string | null; - /** - * Name of the form - * @type {string} - * @memberof WorkItemsForm - */ - 'name'?: string | null; - /** - * The form title - * @type {string} - * @memberof WorkItemsForm - */ - 'title'?: string; - /** - * The form subtitle. - * @type {string} - * @memberof WorkItemsForm - */ - 'subtitle'?: string; - /** - * The name of the user that should be shown this form - * @type {string} - * @memberof WorkItemsForm - */ - 'targetUser'?: string; - /** - * Sections of the form - * @type {Array} - * @memberof WorkItemsForm - */ - 'sections'?: Array; -} -/** - * - * @export - * @interface WorkItemsSummary - */ -export interface WorkItemsSummary { - /** - * The count of open work items - * @type {number} - * @memberof WorkItemsSummary - */ - 'open'?: number; - /** - * The count of completed work items - * @type {number} - * @memberof WorkItemsSummary - */ - 'completed'?: number; - /** - * The count of total work items - * @type {number} - * @memberof WorkItemsSummary - */ - 'total'?: number; -} -/** - * - * @export - * @interface Workflow - */ -export interface Workflow { - /** - * The name of the workflow - * @type {string} - * @memberof Workflow - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwner} - * @memberof Workflow - */ - 'owner'?: WorkflowBodyOwner; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof Workflow - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinition} - * @memberof Workflow - */ - 'definition'?: WorkflowDefinition; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof Workflow - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTrigger} - * @memberof Workflow - */ - 'trigger'?: WorkflowTrigger; - /** - * Workflow ID. This is a UUID generated upon creation. - * @type {string} - * @memberof Workflow - */ - 'id'?: string; - /** - * The number of times this workflow has been executed. - * @type {number} - * @memberof Workflow - */ - 'executionCount'?: number; - /** - * The number of times this workflow has failed during execution. - * @type {number} - * @memberof Workflow - */ - 'failureCount'?: number; - /** - * The date and time the workflow was created. - * @type {string} - * @memberof Workflow - */ - 'created'?: string; - /** - * The date and time the workflow was modified. - * @type {string} - * @memberof Workflow - */ - 'modified'?: string; - /** - * - * @type {WorkflowModifiedBy} - * @memberof Workflow - */ - 'modifiedBy'?: WorkflowModifiedBy; - /** - * - * @type {WorkflowAllOfCreator} - * @memberof Workflow - */ - 'creator'?: WorkflowAllOfCreator; -} -/** - * Workflow creator\'s identity. - * @export - * @interface WorkflowAllOfCreator - */ -export interface WorkflowAllOfCreator { - /** - * Workflow creator\'s DTO type. - * @type {string} - * @memberof WorkflowAllOfCreator - */ - 'type'?: WorkflowAllOfCreatorTypeV3; - /** - * Workflow creator\'s identity ID. - * @type {string} - * @memberof WorkflowAllOfCreator - */ - 'id'?: string; - /** - * Workflow creator\'s display name. - * @type {string} - * @memberof WorkflowAllOfCreator - */ - 'name'?: string; -} - -export const WorkflowAllOfCreatorTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowAllOfCreatorTypeV3 = typeof WorkflowAllOfCreatorTypeV3[keyof typeof WorkflowAllOfCreatorTypeV3]; - -/** - * - * @export - * @interface WorkflowBody - */ -export interface WorkflowBody { - /** - * The name of the workflow - * @type {string} - * @memberof WorkflowBody - */ - 'name'?: string; - /** - * - * @type {WorkflowBodyOwner} - * @memberof WorkflowBody - */ - 'owner'?: WorkflowBodyOwner; - /** - * Description of what the workflow accomplishes - * @type {string} - * @memberof WorkflowBody - */ - 'description'?: string; - /** - * - * @type {WorkflowDefinition} - * @memberof WorkflowBody - */ - 'definition'?: WorkflowDefinition; - /** - * Enable or disable the workflow. Workflows cannot be created in an enabled state. - * @type {boolean} - * @memberof WorkflowBody - */ - 'enabled'?: boolean; - /** - * - * @type {WorkflowTrigger} - * @memberof WorkflowBody - */ - 'trigger'?: WorkflowTrigger; -} -/** - * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. - * @export - * @interface WorkflowBodyOwner - */ -export interface WorkflowBodyOwner { - /** - * The type of object that is referenced - * @type {string} - * @memberof WorkflowBodyOwner - */ - 'type'?: WorkflowBodyOwnerTypeV3; - /** - * The unique ID of the object - * @type {string} - * @memberof WorkflowBodyOwner - */ - 'id'?: string; - /** - * The name of the object - * @type {string} - * @memberof WorkflowBodyOwner - */ - 'name'?: string; -} - -export const WorkflowBodyOwnerTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowBodyOwnerTypeV3 = typeof WorkflowBodyOwnerTypeV3[keyof typeof WorkflowBodyOwnerTypeV3]; - -/** - * The map of steps that the workflow will execute. - * @export - * @interface WorkflowDefinition - */ -export interface WorkflowDefinition { - /** - * The name of the starting step. - * @type {string} - * @memberof WorkflowDefinition - */ - 'start'?: string; - /** - * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. - * @type {{ [key: string]: any; }} - * @memberof WorkflowDefinition - */ - 'steps'?: { [key: string]: any; }; -} -/** - * - * @export - * @interface WorkflowExecution - */ -export interface WorkflowExecution { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowExecution - */ - 'id'?: string; - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowExecution - */ - 'workflowId'?: string; - /** - * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. - * @type {string} - * @memberof WorkflowExecution - */ - 'requestId'?: string; - /** - * Date/time when the workflow started. - * @type {string} - * @memberof WorkflowExecution - */ - 'startTime'?: string; - /** - * Date/time when the workflow ended. - * @type {string} - * @memberof WorkflowExecution - */ - 'closeTime'?: string; - /** - * Workflow execution status. - * @type {string} - * @memberof WorkflowExecution - */ - 'status'?: WorkflowExecutionStatusV3; -} - -export const WorkflowExecutionStatusV3 = { - Completed: 'Completed', - Failed: 'Failed', - Canceled: 'Canceled', - Queued: 'Queued', - Running: 'Running' -} as const; - -export type WorkflowExecutionStatusV3 = typeof WorkflowExecutionStatusV3[keyof typeof WorkflowExecutionStatusV3]; - -/** - * - * @export - * @interface WorkflowExecutionEvent - */ -export interface WorkflowExecutionEvent { - /** - * The type of event - * @type {string} - * @memberof WorkflowExecutionEvent - */ - 'type'?: WorkflowExecutionEventTypeV3; - /** - * The date-time when the event occurred - * @type {string} - * @memberof WorkflowExecutionEvent - */ - 'timestamp'?: string; - /** - * Additional attributes associated with the event - * @type {object} - * @memberof WorkflowExecutionEvent - */ - 'attributes'?: object; -} - -export const WorkflowExecutionEventTypeV3 = { - WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', - WorkflowExecutionStarted: 'WorkflowExecutionStarted', - WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', - WorkflowExecutionFailed: 'WorkflowExecutionFailed', - WorkflowTaskScheduled: 'WorkflowTaskScheduled', - WorkflowTaskStarted: 'WorkflowTaskStarted', - WorkflowTaskCompleted: 'WorkflowTaskCompleted', - WorkflowTaskFailed: 'WorkflowTaskFailed', - ActivityTaskScheduled: 'ActivityTaskScheduled', - ActivityTaskStarted: 'ActivityTaskStarted', - ActivityTaskCompleted: 'ActivityTaskCompleted', - ActivityTaskFailed: 'ActivityTaskFailed', - StartChildWorkflowExecutionInitiated: 'StartChildWorkflowExecutionInitiated', - ChildWorkflowExecutionStarted: 'ChildWorkflowExecutionStarted', - ChildWorkflowExecutionCompleted: 'ChildWorkflowExecutionCompleted', - ChildWorkflowExecutionFailed: 'ChildWorkflowExecutionFailed' -} as const; - -export type WorkflowExecutionEventTypeV3 = typeof WorkflowExecutionEventTypeV3[keyof typeof WorkflowExecutionEventTypeV3]; - -/** - * - * @export - * @interface WorkflowLibraryAction - */ -export interface WorkflowLibraryAction { - /** - * Action ID. This is a static namespaced ID for the action - * @type {string} - * @memberof WorkflowLibraryAction - */ - 'id'?: string; - /** - * Action Name - * @type {string} - * @memberof WorkflowLibraryAction - */ - 'name'?: string; - /** - * Action type - * @type {string} - * @memberof WorkflowLibraryAction - */ - 'type'?: string; - /** - * Action Description - * @type {string} - * @memberof WorkflowLibraryAction - */ - 'description'?: string; - /** - * One or more inputs that the action accepts - * @type {Array} - * @memberof WorkflowLibraryAction - */ - 'formFields'?: Array | null; - /** - * - * @type {WorkflowLibraryActionExampleOutput} - * @memberof WorkflowLibraryAction - */ - 'exampleOutput'?: WorkflowLibraryActionExampleOutput; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryAction - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryAction - */ - 'deprecatedBy'?: string; - /** - * Version number - * @type {number} - * @memberof WorkflowLibraryAction - */ - 'versionNumber'?: number; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryAction - */ - 'isSimulationEnabled'?: boolean; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryAction - */ - 'isDynamicSchema'?: boolean; - /** - * Defines the output schema, if any, that this action produces. - * @type {object} - * @memberof WorkflowLibraryAction - */ - 'outputSchema'?: object; -} -/** - * @type WorkflowLibraryActionExampleOutput - * @export - */ -export type WorkflowLibraryActionExampleOutput = Array | object; - -/** - * - * @export - * @interface WorkflowLibraryFormFields - */ -export interface WorkflowLibraryFormFields { - /** - * Description of the form field - * @type {string} - * @memberof WorkflowLibraryFormFields - */ - 'description'?: string; - /** - * Describes the form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFields - */ - 'helpText'?: string; - /** - * A human readable name for this form field in the UI - * @type {string} - * @memberof WorkflowLibraryFormFields - */ - 'label'?: string; - /** - * The name of the input attribute - * @type {string} - * @memberof WorkflowLibraryFormFields - */ - 'name'?: string; - /** - * Denotes if this field is a required attribute - * @type {boolean} - * @memberof WorkflowLibraryFormFields - */ - 'required'?: boolean; - /** - * The type of the form field - * @type {string} - * @memberof WorkflowLibraryFormFields - */ - 'type'?: WorkflowLibraryFormFieldsTypeV3 | null; -} - -export const WorkflowLibraryFormFieldsTypeV3 = { - Text: 'text', - Textarea: 'textarea', - Boolean: 'boolean', - Email: 'email', - Url: 'url', - Number: 'number', - Json: 'json', - Checkbox: 'checkbox', - Jsonpath: 'jsonpath', - Select: 'select', - MultiType: 'multiType', - Duration: 'duration', - Toggle: 'toggle', - FormPicker: 'formPicker', - IdentityPicker: 'identityPicker', - GovernanceGroupPicker: 'governanceGroupPicker', - String: 'string', - Object: 'object', - Array: 'array', - Secret: 'secret', - KeyValuePairs: 'keyValuePairs', - EmailPicker: 'emailPicker', - AdvancedToggle: 'advancedToggle', - VariableCreator: 'variableCreator', - HtmlEditor: 'htmlEditor' -} as const; - -export type WorkflowLibraryFormFieldsTypeV3 = typeof WorkflowLibraryFormFieldsTypeV3[keyof typeof WorkflowLibraryFormFieldsTypeV3]; - -/** - * - * @export - * @interface WorkflowLibraryOperator - */ -export interface WorkflowLibraryOperator { - /** - * Operator ID. - * @type {string} - * @memberof WorkflowLibraryOperator - */ - 'id'?: string; - /** - * Operator friendly name - * @type {string} - * @memberof WorkflowLibraryOperator - */ - 'name'?: string; - /** - * Operator type - * @type {string} - * @memberof WorkflowLibraryOperator - */ - 'type'?: string; - /** - * Description of the operator - * @type {string} - * @memberof WorkflowLibraryOperator - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryOperator - */ - 'isDynamicSchema'?: boolean; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperator - */ - 'deprecated'?: boolean; - /** - * - * @type {string} - * @memberof WorkflowLibraryOperator - */ - 'deprecatedBy'?: string; - /** - * - * @type {boolean} - * @memberof WorkflowLibraryOperator - */ - 'isSimulationEnabled'?: boolean; - /** - * One or more inputs that the operator accepts - * @type {Array} - * @memberof WorkflowLibraryOperator - */ - 'formFields'?: Array | null; -} -/** - * - * @export - * @interface WorkflowLibraryTrigger - */ -export interface WorkflowLibraryTrigger { - /** - * Trigger ID. This is a static namespaced ID for the trigger. - * @type {string} - * @memberof WorkflowLibraryTrigger - */ - 'id'?: string; - /** - * Trigger type - * @type {string} - * @memberof WorkflowLibraryTrigger - */ - 'type'?: WorkflowLibraryTriggerTypeV3; - /** - * Whether the trigger is deprecated. - * @type {boolean} - * @memberof WorkflowLibraryTrigger - */ - 'deprecated'?: boolean; - /** - * Date the trigger was deprecated, if applicable. - * @type {string} - * @memberof WorkflowLibraryTrigger - */ - 'deprecatedBy'?: string; - /** - * Whether the trigger can be simulated. - * @type {boolean} - * @memberof WorkflowLibraryTrigger - */ - 'isSimulationEnabled'?: boolean; - /** - * Example output schema - * @type {object} - * @memberof WorkflowLibraryTrigger - */ - 'outputSchema'?: object; - /** - * Trigger Name - * @type {string} - * @memberof WorkflowLibraryTrigger - */ - 'name'?: string; - /** - * Trigger Description - * @type {string} - * @memberof WorkflowLibraryTrigger - */ - 'description'?: string; - /** - * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. - * @type {boolean} - * @memberof WorkflowLibraryTrigger - */ - 'isDynamicSchema'?: boolean; - /** - * Example trigger payload if applicable - * @type {object} - * @memberof WorkflowLibraryTrigger - */ - 'inputExample'?: object | null; - /** - * One or more inputs that the trigger accepts - * @type {Array} - * @memberof WorkflowLibraryTrigger - */ - 'formFields'?: Array | null; -} - -export const WorkflowLibraryTriggerTypeV3 = { - Event: 'EVENT', - Scheduled: 'SCHEDULED', - External: 'EXTERNAL', - AccessRequestTrigger: 'AccessRequestTrigger' -} as const; - -export type WorkflowLibraryTriggerTypeV3 = typeof WorkflowLibraryTriggerTypeV3[keyof typeof WorkflowLibraryTriggerTypeV3]; - -/** - * - * @export - * @interface WorkflowModifiedBy - */ -export interface WorkflowModifiedBy { - /** - * - * @type {string} - * @memberof WorkflowModifiedBy - */ - 'type'?: WorkflowModifiedByTypeV3; - /** - * Identity ID - * @type {string} - * @memberof WorkflowModifiedBy - */ - 'id'?: string; - /** - * Human-readable display name of identity. - * @type {string} - * @memberof WorkflowModifiedBy - */ - 'name'?: string; -} - -export const WorkflowModifiedByTypeV3 = { - Identity: 'IDENTITY' -} as const; - -export type WorkflowModifiedByTypeV3 = typeof WorkflowModifiedByTypeV3[keyof typeof WorkflowModifiedByTypeV3]; - -/** - * - * @export - * @interface WorkflowOAuthClient - */ -export interface WorkflowOAuthClient { - /** - * OAuth client ID for the trigger. This is a UUID generated upon creation. - * @type {string} - * @memberof WorkflowOAuthClient - */ - 'id'?: string; - /** - * OAuthClient secret. - * @type {string} - * @memberof WorkflowOAuthClient - */ - 'secret'?: string; - /** - * URL for the external trigger to invoke - * @type {string} - * @memberof WorkflowOAuthClient - */ - 'url'?: string; -} -/** - * The trigger that starts the workflow - * @export - * @interface WorkflowTrigger - */ -export interface WorkflowTrigger { - /** - * The trigger type - * @type {string} - * @memberof WorkflowTrigger - */ - 'type': WorkflowTriggerTypeV3; - /** - * - * @type {string} - * @memberof WorkflowTrigger - */ - 'displayName'?: string | null; - /** - * - * @type {WorkflowTriggerAttributes} - * @memberof WorkflowTrigger - */ - 'attributes': WorkflowTriggerAttributes | null; -} - -export const WorkflowTriggerTypeV3 = { - Event: 'EVENT', - External: 'EXTERNAL', - Scheduled: 'SCHEDULED', - Empty: '' -} as const; - -export type WorkflowTriggerTypeV3 = typeof WorkflowTriggerTypeV3[keyof typeof WorkflowTriggerTypeV3]; - -/** - * Workflow Trigger Attributes. - * @export - * @interface WorkflowTriggerAttributes - */ -export interface WorkflowTriggerAttributes { - /** - * The unique ID of the trigger - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'id': string | null; - /** - * JSON path expression that will limit which events the trigger will fire on - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'filter.$'?: string | null; - /** - * Additional context about the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'description'?: string | null; - /** - * The attribute to filter on - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'attributeToFilter'?: string | null; - /** - * Form definition\'s unique identifier. - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'formDefinitionId'?: string | null; - /** - * A unique name for the external trigger - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'name'?: string | null; - /** - * OAuth Client ID to authenticate with this trigger - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'clientId'?: string | null; - /** - * URL to invoke this workflow - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'url'?: string | null; - /** - * Frequency of execution - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'frequency': WorkflowTriggerAttributesFrequencyV3 | null; - /** - * Time zone identifier - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'timeZone'?: string | null; - /** - * A valid CRON expression - * @type {string} - * @memberof WorkflowTriggerAttributes - */ - 'cronString'?: string | null; - /** - * Scheduled days of the week for execution - * @type {Array} - * @memberof WorkflowTriggerAttributes - */ - 'weeklyDays'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributes - */ - 'weeklyTimes'?: Array | null; - /** - * Scheduled execution times - * @type {Array} - * @memberof WorkflowTriggerAttributes - */ - 'yearlyTimes'?: Array | null; -} - -export const WorkflowTriggerAttributesFrequencyV3 = { - Daily: 'daily', - Weekly: 'weekly', - Monthly: 'monthly', - Yearly: 'yearly', - CronSchedule: 'cronSchedule' -} as const; - -export type WorkflowTriggerAttributesFrequencyV3 = typeof WorkflowTriggerAttributesFrequencyV3[keyof typeof WorkflowTriggerAttributesFrequencyV3]; - - -/** - * AccessProfilesApi - axios parameter creator - * @export - */ -export const AccessProfilesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfile} accessProfile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile: async (accessProfile: AccessProfile, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfile' is not null or undefined - assertParamExists('createAccessProfile', 'accessProfile', accessProfile) - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfile, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk: async (accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessProfileBulkDeleteRequest' is not null or undefined - assertParamExists('deleteAccessProfilesInBulk', 'accessProfileBulkDeleteRequest', accessProfileBulkDeleteRequest) - const localVarPath = `/access-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessProfileBulkDeleteRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfile', 'id', id) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccessProfileEntitlements', 'id', id) - const localVarPath = `/access-profiles/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAccessProfile', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAccessProfile', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/access-profiles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * AccessProfilesApi - functional programming interface - * @export - */ -export const AccessProfilesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessProfilesApiAxiosParamCreator(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfile} accessProfile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessProfile(accessProfile: AccessProfile, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessProfile(accessProfile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.createAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {string} id ID of the Access Profile to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.deleteAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccessProfilesInBulk(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccessProfilesInBulk(accessProfileBulkDeleteRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.deleteAccessProfilesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {string} id ID of the Access Profile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfile(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.getAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {string} id ID of the access profile containing the entitlements. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, attribute, value, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessProfileEntitlements(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.getAccessProfileEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {string} [forSubadmin] Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @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: **name, created, modified** - * @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessProfiles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.listAccessProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {string} id ID of the Access Profile to patch - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAccessProfile(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAccessProfile(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessProfilesApi.patchAccessProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessProfilesApi - factory interface - * @export - */ -export const AccessProfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessProfilesApiFp(configuration) - return { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessProfile(requestParameters: AccessProfilesApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessProfile(requestParameters.accessProfile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfile(requestParameters: AccessProfilesApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccessProfilesInBulk(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfile(requestParameters: AccessProfilesApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessProfiles(requestParameters: AccessProfilesApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAccessProfile(requestParameters: AccessProfilesApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccessProfile operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiCreateAccessProfileRequest - */ -export interface AccessProfilesApiCreateAccessProfileRequest { - /** - * - * @type {AccessProfile} - * @memberof AccessProfilesApiCreateAccessProfile - */ - readonly accessProfile: AccessProfile -} - -/** - * Request parameters for deleteAccessProfile operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiDeleteAccessProfileRequest - */ -export interface AccessProfilesApiDeleteAccessProfileRequest { - /** - * ID of the Access Profile to delete - * @type {string} - * @memberof AccessProfilesApiDeleteAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for deleteAccessProfilesInBulk operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiDeleteAccessProfilesInBulkRequest - */ -export interface AccessProfilesApiDeleteAccessProfilesInBulkRequest { - /** - * - * @type {AccessProfileBulkDeleteRequest} - * @memberof AccessProfilesApiDeleteAccessProfilesInBulk - */ - readonly accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest -} - -/** - * Request parameters for getAccessProfile operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiGetAccessProfileRequest - */ -export interface AccessProfilesApiGetAccessProfileRequest { - /** - * ID of the Access Profile - * @type {string} - * @memberof AccessProfilesApiGetAccessProfile - */ - readonly id: string -} - -/** - * Request parameters for getAccessProfileEntitlements operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiGetAccessProfileEntitlementsRequest - */ -export interface AccessProfilesApiGetAccessProfileEntitlementsRequest { - /** - * ID of the access profile containing the entitlements. - * @type {string} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - 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, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - 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: **name, attribute, value, created, modified** - * @type {string} - * @memberof AccessProfilesApiGetAccessProfileEntitlements - */ - readonly sorters?: string -} - -/** - * Request parameters for listAccessProfiles operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiListAccessProfilesRequest - */ -export interface AccessProfilesApiListAccessProfilesRequest { - /** - * Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. - * @type {string} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly forSubadmin?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessProfilesApiListAccessProfiles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. - * @type {string} - * @memberof AccessProfilesApiListAccessProfiles - */ - 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: **name, created, modified** - * @type {string} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly sorters?: string - - /** - * Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly forSegmentIds?: string - - /** - * Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. - * @type {boolean} - * @memberof AccessProfilesApiListAccessProfiles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchAccessProfile operation in AccessProfilesApi. - * @export - * @interface AccessProfilesApiPatchAccessProfileRequest - */ -export interface AccessProfilesApiPatchAccessProfileRequest { - /** - * ID of the Access Profile to patch - * @type {string} - * @memberof AccessProfilesApiPatchAccessProfile - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof AccessProfilesApiPatchAccessProfile - */ - readonly jsonPatchOperation: Array -} - -/** - * AccessProfilesApi - object-oriented interface - * @export - * @class AccessProfilesApi - * @extends {BaseAPI} - */ -export class AccessProfilesApi extends BaseAPI { - /** - * Create an access profile. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. - * @summary Create access profile - * @param {AccessProfilesApiCreateAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public createAccessProfile(requestParameters: AccessProfilesApiCreateAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).createAccessProfile(requestParameters.accessProfile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. - * @summary Delete the specified access profile - * @param {AccessProfilesApiDeleteAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public deleteAccessProfile(requestParameters: AccessProfilesApiDeleteAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).deleteAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer. - * @summary Delete access profile(s) - * @param {AccessProfilesApiDeleteAccessProfilesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public deleteAccessProfilesInBulk(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).deleteAccessProfilesInBulk(requestParameters.accessProfileBulkDeleteRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns an Access Profile by its ID. - * @summary Get an access profile - * @param {AccessProfilesApiGetAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public getAccessProfile(requestParameters: AccessProfilesApiGetAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).getAccessProfile(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of an access profile\'s entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profile\'s entitlements - * @param {AccessProfilesApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).getAccessProfileEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank. - * @summary List access profiles - * @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public listAccessProfiles(requestParameters: AccessProfilesApiListAccessProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).listAccessProfiles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. - * @summary Patch a specified access profile - * @param {AccessProfilesApiPatchAccessProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessProfilesApi - */ - public patchAccessProfile(requestParameters: AccessProfilesApiPatchAccessProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessProfilesApiFp(this.configuration).patchAccessProfile(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestApprovalsApi - axios parameter creator - * @export - */ -export const AccessRequestApprovalsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDto} [commentDto] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest: async (approvalId: string, commentDto?: CommentDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('approveAccessRequest', 'approvalId', approvalId) - const localVarPath = `/access-request-approvals/{approvalId}/approve` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest: async (approvalId: string, forwardApprovalDto: ForwardApprovalDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('forwardAccessRequest', 'approvalId', approvalId) - // verify required parameter 'forwardApprovalDto' is not null or undefined - assertParamExists('forwardAccessRequest', 'forwardApprovalDto', forwardApprovalDto) - const localVarPath = `/access-request-approvals/{approvalId}/forward` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(forwardApprovalDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary: async (ownerId?: string, fromDate?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/approval-summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (fromDate !== undefined) { - localVarQueryParameter['from-date'] = fromDate; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-approvals/pending`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDto} commentDto Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest: async (approvalId: string, commentDto: CommentDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'approvalId' is not null or undefined - assertParamExists('rejectAccessRequest', 'approvalId', approvalId) - // verify required parameter 'commentDto' is not null or undefined - assertParamExists('rejectAccessRequest', 'commentDto', commentDto) - const localVarPath = `/access-request-approvals/{approvalId}/reject` - .replace(`{${"approvalId"}}`, encodeURIComponent(String(approvalId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(commentDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestApprovalsApi - functional programming interface - * @export - */ -export const AccessRequestApprovalsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestApprovalsApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDto} [commentDto] Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveAccessRequest(approvalId: string, commentDto?: CommentDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveAccessRequest(approvalId, commentDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.approveAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {string} approvalId Approval ID. - * @param {ForwardApprovalDto} forwardApprovalDto Information about the forwarded approval. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async forwardAccessRequest(approvalId: string, forwardApprovalDto: ForwardApprovalDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.forwardAccessRequest(approvalId, forwardApprovalDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.forwardAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {string} [ownerId] The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {string} [fromDate] This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccessRequestApprovalSummary(ownerId?: string, fromDate?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestApprovalSummary(ownerId, fromDate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.getAccessRequestApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {string} [ownerId] If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompletedApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompletedApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.listCompletedApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {string} [ownerId] If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPendingApprovals(ownerId?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPendingApprovals(ownerId, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.listPendingApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {string} approvalId Approval ID. - * @param {CommentDto} commentDto Reviewer\'s comment. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectAccessRequest(approvalId: string, commentDto: CommentDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectAccessRequest(approvalId, commentDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestApprovalsApi.rejectAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestApprovalsApi - factory interface - * @export - */ -export const AccessRequestApprovalsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestApprovalsApiFp(configuration) - return { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveAccessRequest(requestParameters: AccessRequestApprovalsApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveAccessRequest(requestParameters.approvalId, requestParameters.commentDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - forwardAccessRequest(requestParameters: AccessRequestApprovalsApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompletedApprovals(requestParameters: AccessRequestApprovalsApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPendingApprovals(requestParameters: AccessRequestApprovalsApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectAccessRequest(requestParameters: AccessRequestApprovalsApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDto, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveAccessRequest operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiApproveAccessRequestRequest - */ -export interface AccessRequestApprovalsApiApproveAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsApiApproveAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDto} - * @memberof AccessRequestApprovalsApiApproveAccessRequest - */ - readonly commentDto?: CommentDto -} - -/** - * Request parameters for forwardAccessRequest operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiForwardAccessRequestRequest - */ -export interface AccessRequestApprovalsApiForwardAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsApiForwardAccessRequest - */ - readonly approvalId: string - - /** - * Information about the forwarded approval. - * @type {ForwardApprovalDto} - * @memberof AccessRequestApprovalsApiForwardAccessRequest - */ - readonly forwardApprovalDto: ForwardApprovalDto -} - -/** - * Request parameters for getAccessRequestApprovalSummary operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest - */ -export interface AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest { - /** - * The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsApiGetAccessRequestApprovalSummary - */ - readonly ownerId?: string - - /** - * This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - * @type {string} - * @memberof AccessRequestApprovalsApiGetAccessRequestApprovalSummary - */ - readonly fromDate?: string -} - -/** - * Request parameters for listCompletedApprovals operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiListCompletedApprovalsRequest - */ -export interface AccessRequestApprovalsApiListCompletedApprovalsRequest { - /** - * If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - * @type {string} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsApiListCompletedApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listPendingApprovals operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiListPendingApprovalsRequest - */ -export interface AccessRequestApprovalsApiListPendingApprovalsRequest { - /** - * If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - * @type {string} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - 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, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* - * @type {string} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof AccessRequestApprovalsApiListPendingApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for rejectAccessRequest operation in AccessRequestApprovalsApi. - * @export - * @interface AccessRequestApprovalsApiRejectAccessRequestRequest - */ -export interface AccessRequestApprovalsApiRejectAccessRequestRequest { - /** - * Approval ID. - * @type {string} - * @memberof AccessRequestApprovalsApiRejectAccessRequest - */ - readonly approvalId: string - - /** - * Reviewer\'s comment. - * @type {CommentDto} - * @memberof AccessRequestApprovalsApiRejectAccessRequest - */ - readonly commentDto: CommentDto -} - -/** - * AccessRequestApprovalsApi - object-oriented interface - * @export - * @class AccessRequestApprovalsApi - * @extends {BaseAPI} - */ -export class AccessRequestApprovalsApi extends BaseAPI { - /** - * Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Approve access request approval - * @param {AccessRequestApprovalsApiApproveAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public approveAccessRequest(requestParameters: AccessRequestApprovalsApiApproveAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).approveAccessRequest(requestParameters.approvalId, requestParameters.commentDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - * @summary Forward access request approval - * @param {AccessRequestApprovalsApiForwardAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public forwardAccessRequest(requestParameters: AccessRequestApprovalsApiForwardAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).forwardAccessRequest(requestParameters.approvalId, requestParameters.forwardApprovalDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the number of pending, approved and rejected access requests approvals. See the \"owner-id\" query parameter for authorization information. info. - * @summary Get access requests approvals number - * @param {AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public getAccessRequestApprovalSummary(requestParameters: AccessRequestApprovalsApiGetAccessRequestApprovalSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).getAccessRequestApprovalSummary(requestParameters.ownerId, requestParameters.fromDate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - * @summary Completed access request approvals list - * @param {AccessRequestApprovalsApiListCompletedApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public listCompletedApprovals(requestParameters: AccessRequestApprovalsApiListCompletedApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).listCompletedApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns a list of pending approvals. See \"owner-id\" query parameter below for authorization info. - * @summary Pending access request approvals list - * @param {AccessRequestApprovalsApiListPendingApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public listPendingApprovals(requestParameters: AccessRequestApprovalsApiListPendingApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).listPendingApprovals(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - * @summary Reject access request approval - * @param {AccessRequestApprovalsApiRejectAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestApprovalsApi - */ - public rejectAccessRequest(requestParameters: AccessRequestApprovalsApiRejectAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestApprovalsApiFp(this.configuration).rejectAccessRequest(requestParameters.approvalId, requestParameters.commentDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccessRequestsApi - axios parameter creator - * @export - */ -export const AccessRequestsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequest} cancelAccessRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest: async (cancelAccessRequest: CancelAccessRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cancelAccessRequest' is not null or undefined - assertParamExists('cancelAccessRequest', 'cancelAccessRequest', cancelAccessRequest) - const localVarPath = `/access-requests/cancel`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(cancelAccessRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequest} accessRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest: async (accessRequest: AccessRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequest' is not null or undefined - assertParamExists('createAccessRequest', 'accessRequest', accessRequest) - const localVarPath = `/access-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/access-request-status`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (assignedTo !== undefined) { - localVarQueryParameter['assigned-to'] = assignedTo; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (requestState !== undefined) { - localVarQueryParameter['request-state'] = requestState; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfig} accessRequestConfig - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig: async (accessRequestConfig: AccessRequestConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accessRequestConfig' is not null or undefined - assertParamExists('setAccessRequestConfig', 'accessRequestConfig', accessRequestConfig) - const localVarPath = `/access-request-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accessRequestConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccessRequestsApi - functional programming interface - * @export - */ -export const AccessRequestsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccessRequestsApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {CancelAccessRequest} cancelAccessRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelAccessRequest(cancelAccessRequest: CancelAccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAccessRequest(cancelAccessRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.cancelAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequest} accessRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccessRequest(accessRequest: AccessRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessRequest(accessRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.createAccessRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessRequestConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.getAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {string} [requestedFor] Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {string} [assignedTo] Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @param {number} [limit] Max number of results to return. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @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: **created, modified, accountActivityItemId, name** - * @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccessRequestStatus(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, assignedTo?: string, count?: boolean, limit?: number, offset?: number, filters?: string, sorters?: string, requestState?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessRequestStatus(requestedFor, requestedBy, regardingIdentity, assignedTo, count, limit, offset, filters, sorters, requestState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.listAccessRequestStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestConfig} accessRequestConfig - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async setAccessRequestConfig(accessRequestConfig: AccessRequestConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setAccessRequestConfig(accessRequestConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.setAccessRequestConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccessRequestsApi - factory interface - * @export - */ -export const AccessRequestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccessRequestsApiFp(configuration) - return { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccessRequest(requestParameters: AccessRequestsApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccessRequest(requestParameters.accessRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccessRequestConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccessRequestStatus(requestParameters: AccessRequestsApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - setAccessRequestConfig(requestParameters: AccessRequestsApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setAccessRequestConfig(requestParameters.accessRequestConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelAccessRequest operation in AccessRequestsApi. - * @export - * @interface AccessRequestsApiCancelAccessRequestRequest - */ -export interface AccessRequestsApiCancelAccessRequestRequest { - /** - * - * @type {CancelAccessRequest} - * @memberof AccessRequestsApiCancelAccessRequest - */ - readonly cancelAccessRequest: CancelAccessRequest -} - -/** - * Request parameters for createAccessRequest operation in AccessRequestsApi. - * @export - * @interface AccessRequestsApiCreateAccessRequestRequest - */ -export interface AccessRequestsApiCreateAccessRequestRequest { - /** - * - * @type {AccessRequest} - * @memberof AccessRequestsApiCreateAccessRequest - */ - readonly accessRequest: AccessRequest -} - -/** - * Request parameters for listAccessRequestStatus operation in AccessRequestsApi. - * @export - * @interface AccessRequestsApiListAccessRequestStatusRequest - */ -export interface AccessRequestsApiListAccessRequestStatusRequest { - /** - * Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly requestedFor?: string - - /** - * Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly requestedBy?: string - - /** - * Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly regardingIdentity?: string - - /** - * Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly assignedTo?: string - - /** - * If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - * @type {boolean} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly count?: boolean - - /** - * Max number of results to return. - * @type {number} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - * @type {number} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly offset?: number - - /** - * 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: **accessRequestId**: *eq, ge, gt, le, lt, ne, in, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - 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: **created, modified, accountActivityItemId, name** - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly sorters?: string - - /** - * Filter the results by the state of the request. The only valid value is *EXECUTING*. - * @type {string} - * @memberof AccessRequestsApiListAccessRequestStatus - */ - readonly requestState?: string -} - -/** - * Request parameters for setAccessRequestConfig operation in AccessRequestsApi. - * @export - * @interface AccessRequestsApiSetAccessRequestConfigRequest - */ -export interface AccessRequestsApiSetAccessRequestConfigRequest { - /** - * - * @type {AccessRequestConfig} - * @memberof AccessRequestsApiSetAccessRequestConfig - */ - readonly accessRequestConfig: AccessRequestConfig -} - -/** - * AccessRequestsApi - object-oriented interface - * @export - * @class AccessRequestsApi - * @extends {BaseAPI} - */ -export class AccessRequestsApi extends BaseAPI { - /** - * This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - * @summary Cancel access request - * @param {AccessRequestsApiCancelAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsApi - */ - public cancelAccessRequest(requestParameters: AccessRequestsApiCancelAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsApiFp(this.configuration).cancelAccessRequest(requestParameters.cancelAccessRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests. - * @summary Submit access request - * @param {AccessRequestsApiCreateAccessRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsApi - */ - public createAccessRequest(requestParameters: AccessRequestsApiCreateAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsApiFp(this.configuration).createAccessRequest(requestParameters.accessRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint returns the current access-request configuration. - * @summary Get access request configuration - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsApi - */ - public getAccessRequestConfig(axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsApiFp(this.configuration).getAccessRequestConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - * @summary Access request status - * @param {AccessRequestsApiListAccessRequestStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccessRequestsApi - */ - public listAccessRequestStatus(requestParameters: AccessRequestsApiListAccessRequestStatusRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsApiFp(this.configuration).listAccessRequestStatus(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.assignedTo, requestParameters.count, requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, requestParameters.requestState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint replaces the current access-request configuration. - * @summary Update access request configuration - * @param {AccessRequestsApiSetAccessRequestConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof AccessRequestsApi - */ - public setAccessRequestConfig(requestParameters: AccessRequestsApiSetAccessRequestConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccessRequestsApiFp(this.configuration).setAccessRequestConfig(requestParameters.accessRequestConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountActivitiesApi - axios parameter creator - * @export - */ -export const AccountActivitiesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountActivity', 'id', id) - const localVarPath = `/account-activities/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities: async (requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/account-activities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (requestedBy !== undefined) { - localVarQueryParameter['requested-by'] = requestedBy; - } - - if (regardingIdentity !== undefined) { - localVarQueryParameter['regarding-identity'] = regardingIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountActivitiesApi - functional programming interface - * @export - */ -export const AccountActivitiesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountActivitiesApiAxiosParamCreator(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {string} id The account activity id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountActivity(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountActivity(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesApi.getAccountActivity']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {string} [requestedFor] The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [requestedBy] The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @param {string} [regardingIdentity] The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @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: **type, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccountActivities(requestedFor?: string, requestedBy?: string, regardingIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccountActivities(requestedFor, requestedBy, regardingIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountActivitiesApi.listAccountActivities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountActivitiesApi - factory interface - * @export - */ -export const AccountActivitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountActivitiesApiFp(configuration) - return { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountActivity(requestParameters: AccountActivitiesApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccountActivities(requestParameters: AccountActivitiesApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAccountActivity operation in AccountActivitiesApi. - * @export - * @interface AccountActivitiesApiGetAccountActivityRequest - */ -export interface AccountActivitiesApiGetAccountActivityRequest { - /** - * The account activity id - * @type {string} - * @memberof AccountActivitiesApiGetAccountActivity - */ - readonly id: string -} - -/** - * Request parameters for listAccountActivities operation in AccountActivitiesApi. - * @export - * @interface AccountActivitiesApiListAccountActivitiesRequest - */ -export interface AccountActivitiesApiListAccountActivitiesRequest { - /** - * The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly requestedFor?: string - - /** - * The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - * @type {string} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly requestedBy?: string - - /** - * The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - * @type {string} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly regardingIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountActivitiesApiListAccountActivities - */ - 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - * @type {string} - * @memberof AccountActivitiesApiListAccountActivities - */ - 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: **type, created, modified** - * @type {string} - * @memberof AccountActivitiesApiListAccountActivities - */ - readonly sorters?: string -} - -/** - * AccountActivitiesApi - object-oriented interface - * @export - * @class AccountActivitiesApi - * @extends {BaseAPI} - */ -export class AccountActivitiesApi extends BaseAPI { - /** - * This gets a single account activity by its id. - * @summary Get an account activity - * @param {AccountActivitiesApiGetAccountActivityRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesApi - */ - public getAccountActivity(requestParameters: AccountActivitiesApiGetAccountActivityRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesApiFp(this.configuration).getAccountActivity(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of account activities that satisfy the given query parameters. - * @summary List account activities - * @param {AccountActivitiesApiListAccountActivitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountActivitiesApi - */ - public listAccountActivities(requestParameters: AccountActivitiesApiListAccountActivitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountActivitiesApiFp(this.configuration).listAccountActivities(requestParameters.requestedFor, requestParameters.requestedBy, requestParameters.regardingIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountUsagesApi - axios parameter creator - * @export - */ -export const AccountUsagesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId: async (accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountId' is not null or undefined - assertParamExists('getUsagesByAccountId', 'accountId', accountId) - const localVarPath = `/account-usages/{accountId}/summaries` - .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * AccountUsagesApi - functional programming interface - * @export - */ -export const AccountUsagesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountUsagesApiAxiosParamCreator(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {string} accountId ID of IDN account - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesByAccountId(accountId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesByAccountId(accountId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountUsagesApi.getUsagesByAccountId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountUsagesApi - factory interface - * @export - */ -export const AccountUsagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountUsagesApiFp(configuration) - return { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesByAccountId(requestParameters: AccountUsagesApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getUsagesByAccountId operation in AccountUsagesApi. - * @export - * @interface AccountUsagesApiGetUsagesByAccountIdRequest - */ -export interface AccountUsagesApiGetUsagesByAccountIdRequest { - /** - * ID of IDN account - * @type {string} - * @memberof AccountUsagesApiGetUsagesByAccountId - */ - readonly accountId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesApiGetUsagesByAccountId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountUsagesApiGetUsagesByAccountId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountUsagesApiGetUsagesByAccountId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof AccountUsagesApiGetUsagesByAccountId - */ - readonly sorters?: string -} - -/** - * AccountUsagesApi - object-oriented interface - * @export - * @class AccountUsagesApi - * @extends {BaseAPI} - */ -export class AccountUsagesApi extends BaseAPI { - /** - * This API returns a summary of account usage insights for past 12 months. - * @summary Returns account usage insights - * @param {AccountUsagesApiGetUsagesByAccountIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountUsagesApi - */ - public getUsagesByAccountId(requestParameters: AccountUsagesApiGetUsagesByAccountIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountUsagesApiFp(this.configuration).getUsagesByAccountId(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * AccountsApi - axios parameter creator - * @export - */ -export const AccountsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreate} accountAttributesCreate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount: async (accountAttributesCreate: AccountAttributesCreate, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'accountAttributesCreate' is not null or undefined - assertParamExists('createAccount', 'accountAttributesCreate', accountAttributesCreate) - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributesCreate, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequest} accountToggleRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount: async (id: string, accountToggleRequest: AccountToggleRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('disableAccount', 'id', id) - // verify required parameter 'accountToggleRequest' is not null or undefined - assertParamExists('disableAccount', 'accountToggleRequest', accountToggleRequest) - const localVarPath = `/accounts/{id}/disable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequest} accountToggleRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount: async (id: string, accountToggleRequest: AccountToggleRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('enableAccount', 'id', id) - // verify required parameter 'accountToggleRequest' is not null or undefined - assertParamExists('enableAccount', 'accountToggleRequest', accountToggleRequest) - const localVarPath = `/accounts/{id}/enable` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountToggleRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccount', 'id', id) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements: async (id: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountEntitlements', 'id', id) - const localVarPath = `/accounts/{id}/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV3} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts: async (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV3, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (detailLevel !== undefined) { - localVarQueryParameter['detailLevel'] = detailLevel; - } - - 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, - }; - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributes} accountAttributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount: async (id: string, accountAttributes: AccountAttributes, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putAccount', 'id', id) - // verify required parameter 'accountAttributes' is not null or undefined - assertParamExists('putAccount', 'accountAttributes', accountAttributes) - const localVarPath = `/accounts/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountAttributes, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReloadAccount', 'id', id) - const localVarPath = `/accounts/{id}/reload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequest} accountUnlockRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount: async (id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unlockAccount', 'id', id) - // verify required parameter 'accountUnlockRequest' is not null or undefined - assertParamExists('unlockAccount', 'accountUnlockRequest', accountUnlockRequest) - const localVarPath = `/accounts/{id}/unlock` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(accountUnlockRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateAccount', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('updateAccount', 'requestBody', requestBody) - const localVarPath = `/accounts/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * AccountsApi - functional programming interface - * @export - */ -export const AccountsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AccountsApiAxiosParamCreator(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountAttributesCreate} accountAttributesCreate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAccount(accountAttributesCreate: AccountAttributesCreate, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAccount(accountAttributesCreate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.createAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.deleteAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {string} id The account id - * @param {AccountToggleRequest} accountToggleRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async disableAccount(id: string, accountToggleRequest: AccountToggleRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.disableAccount(id, accountToggleRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.disableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {string} id The account id - * @param {AccountToggleRequest} accountToggleRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async enableAccount(id: string, accountToggleRequest: AccountToggleRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.enableAccount(id, accountToggleRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.enableAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {string} id Account ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.getAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {string} id The account id - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountEntitlements(id: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(id, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.getAccountEntitlements']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List accounts. - * @summary Accounts list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {ListAccountsDetailLevelV3} [detailLevel] This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listAccounts(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsDetailLevelV3, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAccounts(limit, offset, count, detailLevel, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.listAccounts']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {string} id Account ID. - * @param {AccountAttributes} accountAttributes - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putAccount(id: string, accountAttributes: AccountAttributes, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putAccount(id, accountAttributes, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.putAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {string} id The account id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReloadAccount(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReloadAccount(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.submitReloadAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {string} id The account ID. - * @param {AccountUnlockRequest} accountUnlockRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unlockAccount(id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unlockAccount(id, accountUnlockRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.unlockAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {string} id Account ID. - * @param {Array} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateAccount(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccount(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AccountsApi.updateAccount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AccountsApi - factory interface - * @export - */ -export const AccountsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AccountsApiFp(configuration) - return { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAccount(requestParameters: AccountsApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAccount(requestParameters.accountAttributesCreate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - disableAccount(requestParameters: AccountsApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.disableAccount(requestParameters.id, requestParameters.accountToggleRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - enableAccount(requestParameters: AccountsApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.enableAccount(requestParameters.id, requestParameters.accountToggleRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccount(requestParameters: AccountsApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List accounts. - * @summary Accounts list - * @param {AccountsApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listAccounts(requestParameters: AccountsApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putAccount(requestParameters: AccountsApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putAccount(requestParameters.id, requestParameters.accountAttributes, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReloadAccount(requestParameters: AccountsApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unlockAccount(requestParameters: AccountsApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unlockAccount(requestParameters.id, requestParameters.accountUnlockRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateAccount(requestParameters: AccountsApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAccount operation in AccountsApi. - * @export - * @interface AccountsApiCreateAccountRequest - */ -export interface AccountsApiCreateAccountRequest { - /** - * - * @type {AccountAttributesCreate} - * @memberof AccountsApiCreateAccount - */ - readonly accountAttributesCreate: AccountAttributesCreate -} - -/** - * Request parameters for deleteAccount operation in AccountsApi. - * @export - * @interface AccountsApiDeleteAccountRequest - */ -export interface AccountsApiDeleteAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsApiDeleteAccount - */ - readonly id: string -} - -/** - * Request parameters for disableAccount operation in AccountsApi. - * @export - * @interface AccountsApiDisableAccountRequest - */ -export interface AccountsApiDisableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsApiDisableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequest} - * @memberof AccountsApiDisableAccount - */ - readonly accountToggleRequest: AccountToggleRequest -} - -/** - * Request parameters for enableAccount operation in AccountsApi. - * @export - * @interface AccountsApiEnableAccountRequest - */ -export interface AccountsApiEnableAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsApiEnableAccount - */ - readonly id: string - - /** - * - * @type {AccountToggleRequest} - * @memberof AccountsApiEnableAccount - */ - readonly accountToggleRequest: AccountToggleRequest -} - -/** - * Request parameters for getAccount operation in AccountsApi. - * @export - * @interface AccountsApiGetAccountRequest - */ -export interface AccountsApiGetAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsApiGetAccount - */ - readonly id: string -} - -/** - * Request parameters for getAccountEntitlements operation in AccountsApi. - * @export - * @interface AccountsApiGetAccountEntitlementsRequest - */ -export interface AccountsApiGetAccountEntitlementsRequest { - /** - * The account id - * @type {string} - * @memberof AccountsApiGetAccountEntitlements - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsApiGetAccountEntitlements - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsApiGetAccountEntitlements - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsApiGetAccountEntitlements - */ - readonly count?: boolean -} - -/** - * Request parameters for listAccounts operation in AccountsApi. - * @export - * @interface AccountsApiListAccountsRequest - */ -export interface AccountsApiListAccountsRequest { - /** - * 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 AccountsApiListAccounts - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof AccountsApiListAccounts - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof AccountsApiListAccounts - */ - readonly count?: boolean - - /** - * This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof AccountsApiListAccounts - */ - readonly detailLevel?: ListAccountsDetailLevelV3 - - /** - * 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, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - * @type {string} - * @memberof AccountsApiListAccounts - */ - 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, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - * @type {string} - * @memberof AccountsApiListAccounts - */ - readonly sorters?: string -} - -/** - * Request parameters for putAccount operation in AccountsApi. - * @export - * @interface AccountsApiPutAccountRequest - */ -export interface AccountsApiPutAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsApiPutAccount - */ - readonly id: string - - /** - * - * @type {AccountAttributes} - * @memberof AccountsApiPutAccount - */ - readonly accountAttributes: AccountAttributes -} - -/** - * Request parameters for submitReloadAccount operation in AccountsApi. - * @export - * @interface AccountsApiSubmitReloadAccountRequest - */ -export interface AccountsApiSubmitReloadAccountRequest { - /** - * The account id - * @type {string} - * @memberof AccountsApiSubmitReloadAccount - */ - readonly id: string -} - -/** - * Request parameters for unlockAccount operation in AccountsApi. - * @export - * @interface AccountsApiUnlockAccountRequest - */ -export interface AccountsApiUnlockAccountRequest { - /** - * The account ID. - * @type {string} - * @memberof AccountsApiUnlockAccount - */ - readonly id: string - - /** - * - * @type {AccountUnlockRequest} - * @memberof AccountsApiUnlockAccount - */ - readonly accountUnlockRequest: AccountUnlockRequest -} - -/** - * Request parameters for updateAccount operation in AccountsApi. - * @export - * @interface AccountsApiUpdateAccountRequest - */ -export interface AccountsApiUpdateAccountRequest { - /** - * Account ID. - * @type {string} - * @memberof AccountsApiUpdateAccount - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AccountsApiUpdateAccount - */ - readonly requestBody: Array -} - -/** - * AccountsApi - object-oriented interface - * @export - * @class AccountsApi - * @extends {BaseAPI} - */ -export class AccountsApi extends BaseAPI { - /** - * Submit an account creation task - the API then returns the task ID. You must include the `sourceId` where the account will be created in the `attributes` object. This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn\'t actually provision the account on the target source, which means that if the account doesn\'t also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - * @summary Create account - * @param {AccountsApiCreateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public createAccount(requestParameters: AccountsApiCreateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).createAccount(requestParameters.accountAttributesCreate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account\'s returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the \"DelimitedFile\" type.** - * @summary Delete account - * @param {AccountsApiDeleteAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public deleteAccount(requestParameters: AccountsApiDeleteAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).deleteAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to disable the account and returns the task ID. - * @summary Disable account - * @param {AccountsApiDisableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public disableAccount(requestParameters: AccountsApiDisableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).disableAccount(requestParameters.id, requestParameters.accountToggleRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to enable account and returns the task ID. - * @summary Enable account - * @param {AccountsApiEnableAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public enableAccount(requestParameters: AccountsApiEnableAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).enableAccount(requestParameters.id, requestParameters.accountToggleRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to return the details for a single account by its ID. - * @summary Account details - * @param {AccountsApiGetAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public getAccount(requestParameters: AccountsApiGetAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).getAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns entitlements of the account. - * @summary Account entitlements - * @param {AccountsApiGetAccountEntitlementsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public getAccountEntitlements(requestParameters: AccountsApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).getAccountEntitlements(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List accounts. - * @summary Accounts list - * @param {AccountsApiListAccountsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public listAccounts(requestParameters: AccountsApiListAccountsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).listAccounts(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.detailLevel, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - * @summary Update account - * @param {AccountsApiPutAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public putAccount(requestParameters: AccountsApiPutAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).putAccount(requestParameters.id, requestParameters.accountAttributes, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. - * @summary Reload account - * @param {AccountsApiSubmitReloadAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public submitReloadAccount(requestParameters: AccountsApiSubmitReloadAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).submitReloadAccount(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. - * @summary Unlock account - * @param {AccountsApiUnlockAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public unlockAccount(requestParameters: AccountsApiUnlockAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).unlockAccount(requestParameters.id, requestParameters.accountUnlockRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update account details. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts. - * @summary Update account - * @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AccountsApi - */ - public updateAccount(requestParameters: AccountsApiUpdateAccountRequest, axiosOptions?: RawAxiosRequestConfig) { - return AccountsApiFp(this.configuration).updateAccount(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListAccountsDetailLevelV3 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type ListAccountsDetailLevelV3 = typeof ListAccountsDetailLevelV3[keyof typeof ListAccountsDetailLevelV3]; - - -/** - * ApplicationDiscoveryApi - axios parameter creator - * @export - */ -export const ApplicationDiscoveryApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications: async (limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV3, filter?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/discovered-applications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (filter !== undefined) { - localVarQueryParameter['filter'] = filter; - } - - 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, - }; - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/manual-discover-applications-template`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate: async (file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'file' is not null or undefined - assertParamExists('sendManualDiscoverApplicationsCsvTemplate', 'file', file) - const localVarPath = `/manual-discover-applications`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ApplicationDiscoveryApi - functional programming interface - * @export - */ -export const ApplicationDiscoveryApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ApplicationDiscoveryApiAxiosParamCreator(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetDiscoveredApplicationsDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @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: **name, description, discoveredAt, discoverySource** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDiscoveredApplications(limit?: number, offset?: number, detail?: GetDiscoveredApplicationsDetailV3, filter?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDiscoveredApplications(limit, offset, detail, filter, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryApi.getDiscoveredApplications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManualDiscoverApplicationsCsvTemplate(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryApi.getManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {File} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendManualDiscoverApplicationsCsvTemplate(file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendManualDiscoverApplicationsCsvTemplate(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ApplicationDiscoveryApi.sendManualDiscoverApplicationsCsvTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ApplicationDiscoveryApi - factory interface - * @export - */ -export const ApplicationDiscoveryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ApplicationDiscoveryApiFp(configuration) - return { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDiscoveredApplications(requestParameters: ApplicationDiscoveryApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryApi. - * @export - * @interface ApplicationDiscoveryApiGetDiscoveredApplicationsRequest - */ -export interface ApplicationDiscoveryApiGetDiscoveredApplicationsRequest { - /** - * 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 ApplicationDiscoveryApiGetDiscoveredApplications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ApplicationDiscoveryApiGetDiscoveredApplications - */ - readonly offset?: number - - /** - * Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof ApplicationDiscoveryApiGetDiscoveredApplications - */ - readonly detail?: GetDiscoveredApplicationsDetailV3 - - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - * @type {string} - * @memberof ApplicationDiscoveryApiGetDiscoveredApplications - */ - readonly filter?: 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: **name, description, discoveredAt, discoverySource** - * @type {string} - * @memberof ApplicationDiscoveryApiGetDiscoveredApplications - */ - readonly sorters?: string -} - -/** - * Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryApi. - * @export - * @interface ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest - */ -export interface ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest { - /** - * The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - * @type {File} - * @memberof ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplate - */ - readonly file: File -} - -/** - * ApplicationDiscoveryApi - object-oriented interface - * @export - * @class ApplicationDiscoveryApi - * @extends {BaseAPI} - */ -export class ApplicationDiscoveryApi extends BaseAPI { - /** - * Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - * @summary Get discovered applications for tenant - * @param {ApplicationDiscoveryApiGetDiscoveredApplicationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryApi - */ - public getDiscoveredApplications(requestParameters: ApplicationDiscoveryApiGetDiscoveredApplicationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryApiFp(this.configuration).getDiscoveredApplications(requestParameters.limit, requestParameters.offset, requestParameters.detail, requestParameters.filter, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - * @summary Download csv template for discovery - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryApi - */ - public getManualDiscoverApplicationsCsvTemplate(axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryApiFp(this.configuration).getManualDiscoverApplicationsCsvTemplate(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Uploading a CSV file with application data for manual correlation to specific ISC connectors. If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - * @summary Upload csv to discover applications - * @param {ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ApplicationDiscoveryApi - */ - public sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ApplicationDiscoveryApiFp(this.configuration).sendManualDiscoverApplicationsCsvTemplate(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetDiscoveredApplicationsDetailV3 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetDiscoveredApplicationsDetailV3 = typeof GetDiscoveredApplicationsDetailV3[keyof typeof GetDiscoveredApplicationsDetailV3]; - - -/** - * AuthUsersApi - axios parameter creator - * @export - */ -export const AuthUsersApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAuthUser', 'id', id) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperation A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchAuthUser', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAuthUser', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/auth-users/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * AuthUsersApi - functional programming interface - * @export - */ -export const AuthUsersApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AuthUsersApiAxiosParamCreator(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {string} id Identity ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthUser(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersApi.getAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {string} id Identity ID - * @param {Array} jsonPatchOperation A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthUser(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthUser(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['AuthUsersApi.patchAuthUser']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * AuthUsersApi - factory interface - * @export - */ -export const AuthUsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AuthUsersApiFp(configuration) - return { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthUser(requestParameters: AuthUsersApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthUser(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthUser(requestParameters: AuthUsersApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getAuthUser operation in AuthUsersApi. - * @export - * @interface AuthUsersApiGetAuthUserRequest - */ -export interface AuthUsersApiGetAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersApiGetAuthUser - */ - readonly id: string -} - -/** - * Request parameters for patchAuthUser operation in AuthUsersApi. - * @export - * @interface AuthUsersApiPatchAuthUserRequest - */ -export interface AuthUsersApiPatchAuthUserRequest { - /** - * Identity ID - * @type {string} - * @memberof AuthUsersApiPatchAuthUser - */ - readonly id: string - - /** - * A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof AuthUsersApiPatchAuthUser - */ - readonly jsonPatchOperation: Array -} - -/** - * AuthUsersApi - object-oriented interface - * @export - * @class AuthUsersApi - * @extends {BaseAPI} - */ -export class AuthUsersApi extends BaseAPI { - /** - * Return the specified user\'s authentication system details. - * @summary Auth user details - * @param {AuthUsersApiGetAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersApi - */ - public getAuthUser(requestParameters: AuthUsersApiGetAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersApiFp(this.configuration).getAuthUser(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: * `capabilities` A \'400.1.1 Illegal update attempt\' detail code indicates that you attempted to PATCH a field that is not allowed. - * @summary Auth user update - * @param {AuthUsersApiPatchAuthUserRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof AuthUsersApi - */ - public patchAuthUser(requestParameters: AuthUsersApiPatchAuthUserRequest, axiosOptions?: RawAxiosRequestConfig) { - return AuthUsersApiFp(this.configuration).patchAuthUser(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * BrandingApi - axios parameter creator - * @export - */ -export const BrandingApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('createBrandingItem', 'name', name) - // verify required parameter 'productName' is not null or undefined - assertParamExists('createBrandingItem', 'productName', productName) - const localVarPath = `/brandings`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getBranding', 'name', name) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/brandings`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('setBrandingItem', 'name', name) - // verify required parameter 'name2' is not null or undefined - assertParamExists('setBrandingItem', 'name2', name2) - // verify required parameter 'productName' is not null or undefined - assertParamExists('setBrandingItem', 'productName', productName) - const localVarPath = `/brandings/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (name2 !== undefined) { - localVarFormParams.append('name', name2 as any); - } - - if (productName !== undefined) { - localVarFormParams.append('productName', productName as any); - } - - if (actionButtonColor !== undefined) { - localVarFormParams.append('actionButtonColor', actionButtonColor as any); - } - - if (activeLinkColor !== undefined) { - localVarFormParams.append('activeLinkColor', activeLinkColor as any); - } - - if (navigationColor !== undefined) { - localVarFormParams.append('navigationColor', navigationColor as any); - } - - if (emailFromAddress !== undefined) { - localVarFormParams.append('emailFromAddress', emailFromAddress as any); - } - - if (loginInformationalMessage !== undefined) { - localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); - } - - if (fileStandard !== undefined) { - localVarFormParams.append('fileStandard', fileStandard as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * BrandingApi - functional programming interface - * @export - */ -export const BrandingApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = BrandingApiAxiosParamCreator(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {string} name name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createBrandingItem(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItem(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingApi.createBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {string} name The name of the branding item to be deleted - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingApi.deleteBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBranding(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBranding(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingApi.getBranding']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getBrandingList(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingList(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingApi.getBrandingList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {string} name The name of the branding item to be retrieved - * @param {string} name2 name of branding item - * @param {string | null} productName product name - * @param {string} [actionButtonColor] hex value of color for action button - * @param {string} [activeLinkColor] hex value of color for link - * @param {string} [navigationColor] hex value of color for navigation bar - * @param {string} [emailFromAddress] email from address - * @param {string} [loginInformationalMessage] login information message - * @param {File} [fileStandard] png file with logo - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setBrandingItem(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItem(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['BrandingApi.setBrandingItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * BrandingApi - factory interface - * @export - */ -export const BrandingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = BrandingApiFp(configuration) - return { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createBrandingItem(requestParameters: BrandingApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBranding(requestParameters: BrandingApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBranding(requestParameters: BrandingApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getBranding(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getBrandingList(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getBrandingList(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setBrandingItem(requestParameters: BrandingApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createBrandingItem operation in BrandingApi. - * @export - * @interface BrandingApiCreateBrandingItemRequest - */ -export interface BrandingApiCreateBrandingItemRequest { - /** - * name of branding item - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly name: string - - /** - * product name - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingApiCreateBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingApiCreateBrandingItem - */ - readonly fileStandard?: File -} - -/** - * Request parameters for deleteBranding operation in BrandingApi. - * @export - * @interface BrandingApiDeleteBrandingRequest - */ -export interface BrandingApiDeleteBrandingRequest { - /** - * The name of the branding item to be deleted - * @type {string} - * @memberof BrandingApiDeleteBranding - */ - readonly name: string -} - -/** - * Request parameters for getBranding operation in BrandingApi. - * @export - * @interface BrandingApiGetBrandingRequest - */ -export interface BrandingApiGetBrandingRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingApiGetBranding - */ - readonly name: string -} - -/** - * Request parameters for setBrandingItem operation in BrandingApi. - * @export - * @interface BrandingApiSetBrandingItemRequest - */ -export interface BrandingApiSetBrandingItemRequest { - /** - * The name of the branding item to be retrieved - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly name: string - - /** - * name of branding item - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly name2: string - - /** - * product name - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly productName: string | null - - /** - * hex value of color for action button - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly actionButtonColor?: string - - /** - * hex value of color for link - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly activeLinkColor?: string - - /** - * hex value of color for navigation bar - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly navigationColor?: string - - /** - * email from address - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly emailFromAddress?: string - - /** - * login information message - * @type {string} - * @memberof BrandingApiSetBrandingItem - */ - readonly loginInformationalMessage?: string - - /** - * png file with logo - * @type {File} - * @memberof BrandingApiSetBrandingItem - */ - readonly fileStandard?: File -} - -/** - * BrandingApi - object-oriented interface - * @export - * @class BrandingApi - * @extends {BaseAPI} - */ -export class BrandingApi extends BaseAPI { - /** - * This API endpoint creates a branding item. - * @summary Create a branding item - * @param {BrandingApiCreateBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingApi - */ - public createBrandingItem(requestParameters: BrandingApiCreateBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingApiFp(this.configuration).createBrandingItem(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint delete information for an existing branding item by name. - * @summary Delete a branding item - * @param {BrandingApiDeleteBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingApi - */ - public deleteBranding(requestParameters: BrandingApiDeleteBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingApiFp(this.configuration).deleteBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint retrieves information for an existing branding item by name. - * @summary Get a branding item - * @param {BrandingApiGetBrandingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingApi - */ - public getBranding(requestParameters: BrandingApiGetBrandingRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingApiFp(this.configuration).getBranding(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns a list of branding items. - * @summary List of branding items - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingApi - */ - public getBrandingList(axiosOptions?: RawAxiosRequestConfig) { - return BrandingApiFp(this.configuration).getBrandingList(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint updates information for an existing branding item. - * @summary Update a branding item - * @param {BrandingApiSetBrandingItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof BrandingApi - */ - public setBrandingItem(requestParameters: BrandingApiSetBrandingItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return BrandingApiFp(this.configuration).setBrandingItem(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignFiltersApi - axios parameter creator - * @export - */ -export const CertificationCampaignFiltersApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetails} campaignFilterDetails - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter: async (campaignFilterDetails: CampaignFilterDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignFilterDetails' is not null or undefined - assertParamExists('createCampaignFilter', 'campaignFilterDetails', campaignFilterDetails) - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetails, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteCampaignFilters', 'requestBody', requestBody) - const localVarPath = `/campaign-filters/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignFilterById', 'id', id) - const localVarPath = `/campaign-filters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-filters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (includeSystemFilters !== undefined) { - localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetails} campaignFilterDetails A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter: async (filterId: string, campaignFilterDetails: CampaignFilterDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'filterId' is not null or undefined - assertParamExists('updateCampaignFilter', 'filterId', filterId) - // verify required parameter 'campaignFilterDetails' is not null or undefined - assertParamExists('updateCampaignFilter', 'campaignFilterDetails', campaignFilterDetails) - const localVarPath = `/campaign-filters/{id}` - .replace(`{${"filterId"}}`, encodeURIComponent(String(filterId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetails, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationCampaignFiltersApi - functional programming interface - * @export - */ -export const CertificationCampaignFiltersApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignFiltersApiAxiosParamCreator(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CampaignFilterDetails} campaignFilterDetails - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignFilter(campaignFilterDetails: CampaignFilterDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilter(campaignFilterDetails, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.createCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {Array} requestBody A json list of IDs of campaign filters to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignFilters(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFilters(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.deleteCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {string} id The ID of the campaign filter to be retrieved. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignFilterById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.getCampaignFilterById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCampaignFilters(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFilters(limit, start, includeSystemFilters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.listCampaignFilters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {string} filterId The ID of the campaign filter being modified. - * @param {CampaignFilterDetails} campaignFilterDetails A campaign filter details with updated field values. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaignFilter(filterId: string, campaignFilterDetails: CampaignFilterDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilter(filterId, campaignFilterDetails, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.updateCampaignFilter']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignFiltersApi - factory interface - * @export - */ -export const CertificationCampaignFiltersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignFiltersApiFp(configuration) - return { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignFilter(requestParameters: CertificationCampaignFiltersApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignFilter(requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignFilters(requestParameters: CertificationCampaignFiltersApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignFilterById(requestParameters: CertificationCampaignFiltersApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCampaignFilters(requestParameters: CertificationCampaignFiltersApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaignFilter(requestParameters: CertificationCampaignFiltersApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCampaignFilter operation in CertificationCampaignFiltersApi. - * @export - * @interface CertificationCampaignFiltersApiCreateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersApiCreateCampaignFilterRequest { - /** - * - * @type {CampaignFilterDetails} - * @memberof CertificationCampaignFiltersApiCreateCampaignFilter - */ - readonly campaignFilterDetails: CampaignFilterDetails -} - -/** - * Request parameters for deleteCampaignFilters operation in CertificationCampaignFiltersApi. - * @export - * @interface CertificationCampaignFiltersApiDeleteCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersApiDeleteCampaignFiltersRequest { - /** - * A json list of IDs of campaign filters to delete. - * @type {Array} - * @memberof CertificationCampaignFiltersApiDeleteCampaignFilters - */ - readonly requestBody: Array -} - -/** - * Request parameters for getCampaignFilterById operation in CertificationCampaignFiltersApi. - * @export - * @interface CertificationCampaignFiltersApiGetCampaignFilterByIdRequest - */ -export interface CertificationCampaignFiltersApiGetCampaignFilterByIdRequest { - /** - * The ID of the campaign filter to be retrieved. - * @type {string} - * @memberof CertificationCampaignFiltersApiGetCampaignFilterById - */ - readonly id: string -} - -/** - * Request parameters for listCampaignFilters operation in CertificationCampaignFiltersApi. - * @export - * @interface CertificationCampaignFiltersApiListCampaignFiltersRequest - */ -export interface CertificationCampaignFiltersApiListCampaignFiltersRequest { - /** - * 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 CertificationCampaignFiltersApiListCampaignFilters - */ - readonly limit?: number - - /** - * Start/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 CertificationCampaignFiltersApiListCampaignFilters - */ - readonly start?: number - - /** - * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. - * @type {boolean} - * @memberof CertificationCampaignFiltersApiListCampaignFilters - */ - readonly includeSystemFilters?: boolean -} - -/** - * Request parameters for updateCampaignFilter operation in CertificationCampaignFiltersApi. - * @export - * @interface CertificationCampaignFiltersApiUpdateCampaignFilterRequest - */ -export interface CertificationCampaignFiltersApiUpdateCampaignFilterRequest { - /** - * The ID of the campaign filter being modified. - * @type {string} - * @memberof CertificationCampaignFiltersApiUpdateCampaignFilter - */ - readonly filterId: string - - /** - * A campaign filter details with updated field values. - * @type {CampaignFilterDetails} - * @memberof CertificationCampaignFiltersApiUpdateCampaignFilter - */ - readonly campaignFilterDetails: CampaignFilterDetails -} - -/** - * CertificationCampaignFiltersApi - object-oriented interface - * @export - * @class CertificationCampaignFiltersApi - * @extends {BaseAPI} - */ -export class CertificationCampaignFiltersApi extends BaseAPI { - /** - * Use this API to create a campaign filter based on filter details and criteria. - * @summary Create campaign filter - * @param {CertificationCampaignFiltersApiCreateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersApi - */ - public createCampaignFilter(requestParameters: CertificationCampaignFiltersApiCreateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersApiFp(this.configuration).createCampaignFilter(requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. - * @summary Deletes campaign filters - * @param {CertificationCampaignFiltersApiDeleteCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersApi - */ - public deleteCampaignFilters(requestParameters: CertificationCampaignFiltersApiDeleteCampaignFiltersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersApiFp(this.configuration).deleteCampaignFilters(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieves information for an existing campaign filter using the filter\'s ID. - * @summary Get campaign filter by id - * @param {CertificationCampaignFiltersApiGetCampaignFilterByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersApi - */ - public getCampaignFilterById(requestParameters: CertificationCampaignFiltersApiGetCampaignFilterByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersApiFp(this.configuration).getCampaignFilterById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. - * @summary List campaign filters - * @param {CertificationCampaignFiltersApiListCampaignFiltersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersApi - */ - public listCampaignFilters(requestParameters: CertificationCampaignFiltersApiListCampaignFiltersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersApiFp(this.configuration).listCampaignFilters(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing campaign filter using the filter\'s ID. - * @summary Updates a campaign filter - * @param {CertificationCampaignFiltersApiUpdateCampaignFilterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignFiltersApi - */ - public updateCampaignFilter(requestParameters: CertificationCampaignFiltersApiUpdateCampaignFilterRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignFiltersApiFp(this.configuration).updateCampaignFilter(requestParameters.filterId, requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * CertificationCampaignsApi - axios parameter creator - * @export - */ -export const CertificationCampaignsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign: async (id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/complete` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignCompleteOptions, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {Campaign} campaign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign: async (campaign: Campaign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaign' is not null or undefined - assertParamExists('createCampaign', 'campaign', campaign) - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaign, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplate} campaignTemplate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate: async (campaignTemplate: CampaignTemplate, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignTemplate' is not null or undefined - assertParamExists('createCampaignTemplate', 'campaignTemplate', campaignTemplate) - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignTemplate, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns: async (campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignsDeleteRequest' is not null or undefined - assertParamExists('deleteCampaigns', 'campaignsDeleteRequest', campaignsDeleteRequest) - const localVarPath = `/campaigns/delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignsDeleteRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns: async (detail?: GetActiveCampaignsDetailV3, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign: async (id: string, detail?: GetCampaignDetailV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaign', 'id', id) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (detail !== undefined) { - localVarQueryParameter['detail'] = detail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignReports', 'id', id) - const localVarPath = `/campaigns/{id}/reports` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaigns/reports-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/campaign-templates`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassign} adminReviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move: async (id: string, adminReviewReassign: AdminReviewReassign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('move', 'id', id) - // verify required parameter 'adminReviewReassign' is not null or undefined - assertParamExists('move', 'adminReviewReassign', adminReviewReassign) - const localVarPath = `/campaigns/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(adminReviewReassign, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchCampaignTemplate', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchCampaignTemplate', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/campaign-templates/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig: async (campaignReportsConfig: CampaignReportsConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'campaignReportsConfig' is not null or undefined - assertParamExists('setCampaignReportsConfig', 'campaignReportsConfig', campaignReportsConfig) - const localVarPath = `/campaigns/reports-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(campaignReportsConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {Schedule} [schedule] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule: async (id: string, schedule?: Schedule, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setCampaignTemplateSchedule', 'id', id) - const localVarPath = `/campaign-templates/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schedule, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign: async (id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaign', 'id', id) - const localVarPath = `/campaigns/{id}/activate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(activateCampaignOptions, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignRemediationScan', 'id', id) - const localVarPath = `/campaigns/{id}/run-remediation-scan` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportType} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport: async (id: string, type: ReportType, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startCampaignReport', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('startCampaignReport', 'type', type) - const localVarPath = `/campaigns/{id}/run-report/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startGenerateCampaignTemplate', 'id', id) - const localVarPath = `/campaign-templates/{id}/generate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateCampaign', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateCampaign', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/campaigns/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * CertificationCampaignsApi - functional programming interface - * @export - */ -export const CertificationCampaignsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationCampaignsApiAxiosParamCreator(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {string} id Campaign ID. - * @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeCampaign(id, campaignCompleteOptions, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.completeCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {Campaign} campaign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaign(campaign: Campaign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaign(campaign, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.createCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CampaignTemplate} campaignTemplate - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignTemplate(campaignTemplate, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.createCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {string} id ID of the campaign template being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.deleteCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.deleteCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaigns(campaignsDeleteRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.deleteCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {GetActiveCampaignsDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **status**: *eq, in* - * @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: **name, created** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getActiveCampaigns(detail?: GetActiveCampaignsDetailV3, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getActiveCampaigns(detail, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getActiveCampaigns']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {string} id ID of the campaign to be retrieved. - * @param {GetCampaignDetailV3} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaign(id: string, detail?: GetCampaignDetailV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaign(id, detail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {string} id ID of the campaign whose reports are being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReports(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReports(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaignReports']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignReportsConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {string} id Requested campaign template\'s ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {string} id ID of the campaign template whose schedule is being fetched. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplateSchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplateSchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, created, modified** - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignTemplates(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.getCampaignTemplates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {string} id The certification campaign ID - * @param {AdminReviewReassign} adminReviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.move(id, adminReviewReassign, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.move']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchCampaignTemplate(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchCampaignTemplate(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.patchCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignReportsConfig(campaignReportsConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.setCampaignReportsConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {string} id ID of the campaign template being scheduled. - * @param {Schedule} [schedule] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setCampaignTemplateSchedule(id: string, schedule?: Schedule, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setCampaignTemplateSchedule(id, schedule, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.setCampaignTemplateSchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {string} id Campaign ID. - * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaign(id, activateCampaignOptions, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.startCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {string} id ID of the campaign the remediation scan is being run for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignRemediationScan(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignRemediationScan(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.startCampaignRemediationScan']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {string} id ID of the campaign the report is being run for. - * @param {ReportType} type Type of the report to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startCampaignReport(id: string, type: ReportType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startCampaignReport(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.startCampaignReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {string} id ID of the campaign template to use for generation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startGenerateCampaignTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startGenerateCampaignTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.startGenerateCampaignTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {string} id ID of the campaign template being modified. - * @param {Array} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateCampaign(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaign(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationCampaignsApi.updateCampaign']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationCampaignsApi - factory interface - * @export - */ -export const CertificationCampaignsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationCampaignsApiFp(configuration) - return { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeCampaign(requestParameters: CertificationCampaignsApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptions, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaign(requestParameters.campaign, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCampaignTemplate(requestParameters: CertificationCampaignsApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCampaignTemplate(requestParameters.campaignTemplate, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplate(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCampaigns(requestParameters: CertificationCampaignsApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCampaigns(requestParameters.campaignsDeleteRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getActiveCampaigns(requestParameters: CertificationCampaignsApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReports(requestParameters: CertificationCampaignsApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignReportsConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplate(requestParameters: CertificationCampaignsApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCampaignTemplates(requestParameters: CertificationCampaignsApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.move(requestParameters.id, requestParameters.adminReviewReassign, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchCampaignTemplate(requestParameters: CertificationCampaignsApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignReportsConfig(requestParameters: CertificationCampaignsApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignReportsConfig(requestParameters.campaignReportsConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setCampaignTemplateSchedule(requestParameters.id, requestParameters.schedule, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaign(requestParameters: CertificationCampaignsApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaign(requestParameters.id, requestParameters.activateCampaignOptions, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignRemediationScan(requestParameters: CertificationCampaignsApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startGenerateCampaignTemplate(requestParameters: CertificationCampaignsApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateCampaign(requestParameters: CertificationCampaignsApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateCampaign(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for completeCampaign operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiCompleteCampaignRequest - */ -export interface CertificationCampaignsApiCompleteCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsApiCompleteCampaign - */ - readonly id: string - - /** - * Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - * @type {CampaignCompleteOptions} - * @memberof CertificationCampaignsApiCompleteCampaign - */ - readonly campaignCompleteOptions?: CampaignCompleteOptions -} - -/** - * Request parameters for createCampaign operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiCreateCampaignRequest - */ -export interface CertificationCampaignsApiCreateCampaignRequest { - /** - * - * @type {Campaign} - * @memberof CertificationCampaignsApiCreateCampaign - */ - readonly campaign: Campaign -} - -/** - * Request parameters for createCampaignTemplate operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiCreateCampaignTemplateRequest - */ -export interface CertificationCampaignsApiCreateCampaignTemplateRequest { - /** - * - * @type {CampaignTemplate} - * @memberof CertificationCampaignsApiCreateCampaignTemplate - */ - readonly campaignTemplate: CampaignTemplate -} - -/** - * Request parameters for deleteCampaignTemplate operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiDeleteCampaignTemplateRequest - */ -export interface CertificationCampaignsApiDeleteCampaignTemplateRequest { - /** - * ID of the campaign template being deleted. - * @type {string} - * @memberof CertificationCampaignsApiDeleteCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaignTemplateSchedule operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being deleted. - * @type {string} - * @memberof CertificationCampaignsApiDeleteCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for deleteCampaigns operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiDeleteCampaignsRequest - */ -export interface CertificationCampaignsApiDeleteCampaignsRequest { - /** - * IDs of the campaigns to delete. - * @type {CampaignsDeleteRequest} - * @memberof CertificationCampaignsApiDeleteCampaigns - */ - readonly campaignsDeleteRequest: CampaignsDeleteRequest -} - -/** - * Request parameters for getActiveCampaigns operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetActiveCampaignsRequest - */ -export interface CertificationCampaignsApiGetActiveCampaignsRequest { - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsApiGetActiveCampaigns - */ - readonly detail?: GetActiveCampaignsDetailV3 - - /** - * 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 CertificationCampaignsApiGetActiveCampaigns - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsApiGetActiveCampaigns - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsApiGetActiveCampaigns - */ - 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, in* **name**: *eq, sw* **status**: *eq, in* - * @type {string} - * @memberof CertificationCampaignsApiGetActiveCampaigns - */ - 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: **name, created** - * @type {string} - * @memberof CertificationCampaignsApiGetActiveCampaigns - */ - readonly sorters?: string -} - -/** - * Request parameters for getCampaign operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetCampaignRequest - */ -export interface CertificationCampaignsApiGetCampaignRequest { - /** - * ID of the campaign to be retrieved. - * @type {string} - * @memberof CertificationCampaignsApiGetCampaign - */ - readonly id: string - - /** - * Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - * @type {'SLIM' | 'FULL'} - * @memberof CertificationCampaignsApiGetCampaign - */ - readonly detail?: GetCampaignDetailV3 -} - -/** - * Request parameters for getCampaignReports operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetCampaignReportsRequest - */ -export interface CertificationCampaignsApiGetCampaignReportsRequest { - /** - * ID of the campaign whose reports are being fetched. - * @type {string} - * @memberof CertificationCampaignsApiGetCampaignReports - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplate operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetCampaignTemplateRequest - */ -export interface CertificationCampaignsApiGetCampaignTemplateRequest { - /** - * Requested campaign template\'s ID. - * @type {string} - * @memberof CertificationCampaignsApiGetCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplateSchedule operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsApiGetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template whose schedule is being fetched. - * @type {string} - * @memberof CertificationCampaignsApiGetCampaignTemplateSchedule - */ - readonly id: string -} - -/** - * Request parameters for getCampaignTemplates operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiGetCampaignTemplatesRequest - */ -export interface CertificationCampaignsApiGetCampaignTemplatesRequest { - /** - * 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 CertificationCampaignsApiGetCampaignTemplates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationCampaignsApiGetCampaignTemplates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationCampaignsApiGetCampaignTemplates - */ - readonly count?: boolean - - /** - * 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: **name, created, modified** - * @type {string} - * @memberof CertificationCampaignsApiGetCampaignTemplates - */ - readonly sorters?: 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof CertificationCampaignsApiGetCampaignTemplates - */ - readonly filters?: string -} - -/** - * Request parameters for move operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiMoveRequest - */ -export interface CertificationCampaignsApiMoveRequest { - /** - * The certification campaign ID - * @type {string} - * @memberof CertificationCampaignsApiMove - */ - readonly id: string - - /** - * - * @type {AdminReviewReassign} - * @memberof CertificationCampaignsApiMove - */ - readonly adminReviewReassign: AdminReviewReassign -} - -/** - * Request parameters for patchCampaignTemplate operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiPatchCampaignTemplateRequest - */ -export interface CertificationCampaignsApiPatchCampaignTemplateRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsApiPatchCampaignTemplate - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - * @type {Array} - * @memberof CertificationCampaignsApiPatchCampaignTemplate - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for setCampaignReportsConfig operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiSetCampaignReportsConfigRequest - */ -export interface CertificationCampaignsApiSetCampaignReportsConfigRequest { - /** - * Campaign report configuration. - * @type {CampaignReportsConfig} - * @memberof CertificationCampaignsApiSetCampaignReportsConfig - */ - readonly campaignReportsConfig: CampaignReportsConfig -} - -/** - * Request parameters for setCampaignTemplateSchedule operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiSetCampaignTemplateScheduleRequest - */ -export interface CertificationCampaignsApiSetCampaignTemplateScheduleRequest { - /** - * ID of the campaign template being scheduled. - * @type {string} - * @memberof CertificationCampaignsApiSetCampaignTemplateSchedule - */ - readonly id: string - - /** - * - * @type {Schedule} - * @memberof CertificationCampaignsApiSetCampaignTemplateSchedule - */ - readonly schedule?: Schedule -} - -/** - * Request parameters for startCampaign operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiStartCampaignRequest - */ -export interface CertificationCampaignsApiStartCampaignRequest { - /** - * Campaign ID. - * @type {string} - * @memberof CertificationCampaignsApiStartCampaign - */ - readonly id: string - - /** - * Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - * @type {ActivateCampaignOptions} - * @memberof CertificationCampaignsApiStartCampaign - */ - readonly activateCampaignOptions?: ActivateCampaignOptions -} - -/** - * Request parameters for startCampaignRemediationScan operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiStartCampaignRemediationScanRequest - */ -export interface CertificationCampaignsApiStartCampaignRemediationScanRequest { - /** - * ID of the campaign the remediation scan is being run for. - * @type {string} - * @memberof CertificationCampaignsApiStartCampaignRemediationScan - */ - readonly id: string -} - -/** - * Request parameters for startCampaignReport operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiStartCampaignReportRequest - */ -export interface CertificationCampaignsApiStartCampaignReportRequest { - /** - * ID of the campaign the report is being run for. - * @type {string} - * @memberof CertificationCampaignsApiStartCampaignReport - */ - readonly id: string - - /** - * Type of the report to run. - * @type {ReportType} - * @memberof CertificationCampaignsApiStartCampaignReport - */ - readonly type: ReportType -} - -/** - * Request parameters for startGenerateCampaignTemplate operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiStartGenerateCampaignTemplateRequest - */ -export interface CertificationCampaignsApiStartGenerateCampaignTemplateRequest { - /** - * ID of the campaign template to use for generation. - * @type {string} - * @memberof CertificationCampaignsApiStartGenerateCampaignTemplate - */ - readonly id: string -} - -/** - * Request parameters for updateCampaign operation in CertificationCampaignsApi. - * @export - * @interface CertificationCampaignsApiUpdateCampaignRequest - */ -export interface CertificationCampaignsApiUpdateCampaignRequest { - /** - * ID of the campaign template being modified. - * @type {string} - * @memberof CertificationCampaignsApiUpdateCampaign - */ - readonly id: string - - /** - * A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - * @type {Array} - * @memberof CertificationCampaignsApiUpdateCampaign - */ - readonly jsonPatchOperation: Array -} - -/** - * CertificationCampaignsApi - object-oriented interface - * @export - * @class CertificationCampaignsApi - * @extends {BaseAPI} - */ -export class CertificationCampaignsApi extends BaseAPI { - /** - * :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. - * @summary Complete a campaign - * @param {CertificationCampaignsApiCompleteCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public completeCampaign(requestParameters: CertificationCampaignsApiCompleteCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).completeCampaign(requestParameters.id, requestParameters.campaignCompleteOptions, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign with the information provided in the request body. - * @summary Create a campaign - * @param {CertificationCampaignsApiCreateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).createCampaign(requestParameters.campaign, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a certification campaign template based on campaign. - * @summary Create a campaign template - * @param {CertificationCampaignsApiCreateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public createCampaignTemplate(requestParameters: CertificationCampaignsApiCreateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).createCampaignTemplate(requestParameters.campaignTemplate, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a certification campaign template by ID. - * @summary Delete a campaign template - * @param {CertificationCampaignsApiDeleteCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public deleteCampaignTemplate(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).deleteCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Delete campaign template schedule - * @param {CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).deleteCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. - * @summary Delete campaigns - * @param {CertificationCampaignsApiDeleteCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public deleteCampaigns(requestParameters: CertificationCampaignsApiDeleteCampaignsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).deleteCampaigns(requestParameters.campaignsDeleteRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. - * @summary List campaigns - * @param {CertificationCampaignsApiGetActiveCampaignsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getActiveCampaigns(requestParameters: CertificationCampaignsApiGetActiveCampaignsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getActiveCampaigns(requestParameters.detail, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get information for an existing certification campaign by the campaign\'s ID. - * @summary Get campaign - * @param {CertificationCampaignsApiGetCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaign(requestParameters.id, requestParameters.detail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch all reports for a certification campaign by campaign ID. - * @summary Get campaign reports - * @param {CertificationCampaignsApiGetCampaignReportsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaignReports(requestParameters: CertificationCampaignsApiGetCampaignReportsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaignReports(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. - * @summary Get campaign reports configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaignReportsConfig(axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaignReportsConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to fetch a certification campaign template by ID. - * @summary Get a campaign template - * @param {CertificationCampaignsApiGetCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaignTemplate(requestParameters: CertificationCampaignsApiGetCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. - * @summary Get campaign template schedule - * @param {CertificationCampaignsApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiGetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaignTemplateSchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. - * @summary List campaign templates - * @param {CertificationCampaignsApiGetCampaignTemplatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public getCampaignTemplates(requestParameters: CertificationCampaignsApiGetCampaignTemplatesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).getCampaignTemplates(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns the specified certifications from one identity to another. - * @summary Reassign certifications - * @param {CertificationCampaignsApiMoveRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).move(requestParameters.id, requestParameters.adminReviewReassign, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign template - * @param {CertificationCampaignsApiPatchCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public patchCampaignTemplate(requestParameters: CertificationCampaignsApiPatchCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).patchCampaignTemplate(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to overwrite the configuration for campaign reports. - * @summary Set campaign reports configuration - * @param {CertificationCampaignsApiSetCampaignReportsConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public setCampaignReportsConfig(requestParameters: CertificationCampaignsApiSetCampaignReportsConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).setCampaignReportsConfig(requestParameters.campaignReportsConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. - * @summary Set campaign template schedule - * @param {CertificationCampaignsApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public setCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiSetCampaignTemplateScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).setCampaignTemplateSchedule(requestParameters.id, requestParameters.schedule, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. - * @summary Activate a campaign - * @param {CertificationCampaignsApiStartCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public startCampaign(requestParameters: CertificationCampaignsApiStartCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).startCampaign(requestParameters.id, requestParameters.activateCampaignOptions, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a remediation scan task for a certification campaign. - * @summary Run campaign remediation scan - * @param {CertificationCampaignsApiStartCampaignRemediationScanRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public startCampaignRemediationScan(requestParameters: CertificationCampaignsApiStartCampaignRemediationScanRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).startCampaignRemediationScan(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report for a certification campaign. - * @summary Run campaign report - * @param {CertificationCampaignsApiStartCampaignReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).startCampaignReport(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - * @summary Generate a campaign from template - * @param {CertificationCampaignsApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public startGenerateCampaignTemplate(requestParameters: CertificationCampaignsApiStartGenerateCampaignTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).startGenerateCampaignTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update a campaign - * @param {CertificationCampaignsApiUpdateCampaignRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationCampaignsApi - */ - public updateCampaign(requestParameters: CertificationCampaignsApiUpdateCampaignRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationCampaignsApiFp(this.configuration).updateCampaign(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetActiveCampaignsDetailV3 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetActiveCampaignsDetailV3 = typeof GetActiveCampaignsDetailV3[keyof typeof GetActiveCampaignsDetailV3]; -/** - * @export - */ -export const GetCampaignDetailV3 = { - Slim: 'SLIM', - Full: 'FULL' -} as const; -export type GetCampaignDetailV3 = typeof GetCampaignDetailV3[keyof typeof GetCampaignDetailV3]; - - -/** - * CertificationSummariesApi - axios parameter creator - * @export - */ -export const CertificationSummariesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV3} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries: async (id: string, type: GetIdentityAccessSummariesTypeV3, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getIdentityAccessSummaries', 'type', type) - const localVarPath = `/certifications/{id}/access-summaries/{type}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary: async (id: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityDecisionSummary', 'id', id) - const localVarPath = `/certifications/{id}/decision-summary` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummaries', 'id', id) - const localVarPath = `/certifications/{id}/identity-summaries` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary: async (id: string, identitySummaryId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentitySummary', 'id', id) - // verify required parameter 'identitySummaryId' is not null or undefined - assertParamExists('getIdentitySummary', 'identitySummaryId', identitySummaryId) - const localVarPath = `/certifications/{id}/identity-summaries/{identitySummaryId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"identitySummaryId"}}`, encodeURIComponent(String(identitySummaryId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationSummariesApi - functional programming interface - * @export - */ -export const CertificationSummariesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationSummariesApiAxiosParamCreator(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {string} id The identity campaign certification ID - * @param {GetIdentityAccessSummariesTypeV3} type The type of access review item to retrieve summaries for - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **access.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityAccessSummaries(id: string, type: GetIdentityAccessSummariesTypeV3, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityAccessSummaries(id, type, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentityAccessSummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {string} id The certification ID - * @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: **identitySummary.id**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityDecisionSummary(id: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityDecisionSummary(id, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentityDecisionSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummaries(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummaries(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentitySummaries']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {string} id The identity campaign certification ID - * @param {string} identitySummaryId The identity summary ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentitySummary(id: string, identitySummaryId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySummary(id, identitySummaryId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationSummariesApi.getIdentitySummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationSummariesApi - factory interface - * @export - */ -export const CertificationSummariesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationSummariesApiFp(configuration) - return { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityAccessSummaries(requestParameters: CertificationSummariesApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityDecisionSummary(requestParameters: CertificationSummariesApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummaries(requestParameters: CertificationSummariesApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentitySummary(requestParameters: CertificationSummariesApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getIdentityAccessSummaries operation in CertificationSummariesApi. - * @export - * @interface CertificationSummariesApiGetIdentityAccessSummariesRequest - */ -export interface CertificationSummariesApiGetIdentityAccessSummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - readonly id: string - - /** - * The type of access review item to retrieve summaries for - * @type {'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - readonly type: GetIdentityAccessSummariesTypeV3 - - /** - * 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 CertificationSummariesApiGetIdentityAccessSummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - 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: **access.name** - * @type {string} - * @memberof CertificationSummariesApiGetIdentityAccessSummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentityDecisionSummary operation in CertificationSummariesApi. - * @export - * @interface CertificationSummariesApiGetIdentityDecisionSummaryRequest - */ -export interface CertificationSummariesApiGetIdentityDecisionSummaryRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationSummariesApiGetIdentityDecisionSummary - */ - readonly id: 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: **identitySummary.id**: *eq, in* - * @type {string} - * @memberof CertificationSummariesApiGetIdentityDecisionSummary - */ - readonly filters?: string -} - -/** - * Request parameters for getIdentitySummaries operation in CertificationSummariesApi. - * @export - * @interface CertificationSummariesApiGetIdentitySummariesRequest - */ -export interface CertificationSummariesApiGetIdentitySummariesRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - 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, in* **completed**: *eq, ne* **name**: *eq, sw* - * @type {string} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - 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: **name** - * @type {string} - * @memberof CertificationSummariesApiGetIdentitySummaries - */ - readonly sorters?: string -} - -/** - * Request parameters for getIdentitySummary operation in CertificationSummariesApi. - * @export - * @interface CertificationSummariesApiGetIdentitySummaryRequest - */ -export interface CertificationSummariesApiGetIdentitySummaryRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationSummariesApiGetIdentitySummary - */ - readonly id: string - - /** - * The identity summary ID - * @type {string} - * @memberof CertificationSummariesApiGetIdentitySummary - */ - readonly identitySummaryId: string -} - -/** - * CertificationSummariesApi - object-oriented interface - * @export - * @class CertificationSummariesApi - * @extends {BaseAPI} - */ -export class CertificationSummariesApi extends BaseAPI { - /** - * This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. - * @summary Access summaries - * @param {CertificationSummariesApiGetIdentityAccessSummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesApi - */ - public getIdentityAccessSummaries(requestParameters: CertificationSummariesApiGetIdentityAccessSummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesApiFp(this.configuration).getIdentityAccessSummaries(requestParameters.id, requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. - * @summary Summary of certification decisions - * @param {CertificationSummariesApiGetIdentityDecisionSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesApi - */ - public getIdentityDecisionSummary(requestParameters: CertificationSummariesApiGetIdentityDecisionSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesApiFp(this.configuration).getIdentityDecisionSummary(requestParameters.id, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. - * @summary Identity summaries for campaign certification - * @param {CertificationSummariesApiGetIdentitySummariesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesApi - */ - public getIdentitySummaries(requestParameters: CertificationSummariesApiGetIdentitySummariesRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesApiFp(this.configuration).getIdentitySummaries(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. - * @summary Summary for identity - * @param {CertificationSummariesApiGetIdentitySummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationSummariesApi - */ - public getIdentitySummary(requestParameters: CertificationSummariesApiGetIdentitySummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationSummariesApiFp(this.configuration).getIdentitySummary(requestParameters.id, requestParameters.identitySummaryId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetIdentityAccessSummariesTypeV3 = { - Role: 'ROLE', - AccessProfile: 'ACCESS_PROFILE', - Entitlement: 'ENTITLEMENT' -} as const; -export type GetIdentityAccessSummariesTypeV3 = typeof GetIdentityAccessSummariesTypeV3[keyof typeof GetIdentityAccessSummariesTypeV3]; - - -/** - * CertificationsApi - axios parameter creator - * @export - */ -export const CertificationsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getCertificationTask', 'id', id) - const localVarPath = `/certification-tasks/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getIdentityCertification', 'id', id) - const localVarPath = `/certifications/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions: async (certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'certificationId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'certificationId', certificationId) - // verify required parameter 'itemId' is not null or undefined - assertParamExists('getIdentityCertificationItemPermissions', 'itemId', itemId) - const localVarPath = `/certifications/{certificationId}/access-review-items/{itemId}/permissions` - .replace(`{${"certificationId"}}`, encodeURIComponent(String(certificationId))) - .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certification-tasks`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listCertificationReviewers', 'id', id) - const localVarPath = `/certifications/{id}/reviewers` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('listIdentityAccessReviewItems', 'id', id) - const localVarPath = `/certifications/{id}/access-review-items` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (entitlements !== undefined) { - localVarQueryParameter['entitlements'] = entitlements; - } - - if (accessProfiles !== undefined) { - localVarQueryParameter['access-profiles'] = accessProfiles; - } - - if (roles !== undefined) { - localVarQueryParameter['roles'] = roles; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications: async (reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/certifications`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (reviewerIdentity !== undefined) { - localVarQueryParameter['reviewer-identity'] = reviewerIdentity; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecision A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision: async (id: string, reviewDecision: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('makeIdentityDecision', 'id', id) - // verify required parameter 'reviewDecision' is not null or undefined - assertParamExists('makeIdentityDecision', 'reviewDecision', reviewDecision) - const localVarPath = `/certifications/{id}/decide` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewDecision, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassign} reviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications: async (id: string, reviewReassign: ReviewReassign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'id', id) - // verify required parameter 'reviewReassign' is not null or undefined - assertParamExists('reassignIdentityCertifications', 'reviewReassign', reviewReassign) - const localVarPath = `/certifications/{id}/reassign` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassign, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('signOffIdentityCertification', 'id', id) - const localVarPath = `/certifications/{id}/sign-off` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassign} reviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync: async (id: string, reviewReassign: ReviewReassign, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'id', id) - // verify required parameter 'reviewReassign' is not null or undefined - assertParamExists('submitReassignCertsAsync', 'reviewReassign', reviewReassign) - const localVarPath = `/certifications/{id}/reassign-async` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reviewReassign, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * CertificationsApi - functional programming interface - * @export - */ -export const CertificationsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CertificationsApiAxiosParamCreator(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {string} id The task ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCertificationTask(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCertificationTask(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getCertificationTask']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Identity certification by id - * @param {string} id The certification id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {string} certificationId The certification ID - * @param {string} itemId The certification item ID - * @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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityCertificationItemPermissions(certificationId: string, itemId: string, filters?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityCertificationItemPermissions(certificationId, itemId, filters, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getIdentityCertificationItemPermissions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {string} [reviewerIdentity] The ID of reviewer identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **targetId**: *eq, in* **type**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPendingCertificationTasks(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPendingCertificationTasks(reviewerIdentity, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.getPendingCertificationTasks']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {string} id The certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **email**: *eq, sw* - * @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: **name, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCertificationReviewers(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCertificationReviewers(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listCertificationReviewers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {string} id The identity campaign certification ID - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @param {string} [entitlements] Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @param {string} [accessProfiles] Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @param {string} [roles] Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityAccessReviewItems(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, entitlements?: string, accessProfiles?: string, roles?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessReviewItems(id, limit, offset, count, filters, sorters, entitlements, accessProfiles, roles, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listIdentityAccessReviewItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary List identity campaign certifications - * @param {string} [reviewerIdentity] Reviewer\'s identity. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @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: **name, due, signed** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityCertifications(reviewerIdentity?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityCertifications(reviewerIdentity, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.listIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {string} id The ID of the identity campaign certification on which to make decisions - * @param {Array} reviewDecision A non-empty array of decisions to be made. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async makeIdentityDecision(id: string, reviewDecision: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.makeIdentityDecision(id, reviewDecision, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.makeIdentityDecision']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {string} id The identity campaign certification ID - * @param {ReviewReassign} reviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async reassignIdentityCertifications(id: string, reviewReassign: ReviewReassign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reassignIdentityCertifications(id, reviewReassign, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.reassignIdentityCertifications']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {string} id The identity campaign certification ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async signOffIdentityCertification(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.signOffIdentityCertification(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.signOffIdentityCertification']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {string} id The identity campaign certification ID - * @param {ReviewReassign} reviewReassign - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitReassignCertsAsync(id: string, reviewReassign: ReviewReassign, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitReassignCertsAsync(id, reviewReassign, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['CertificationsApi.submitReassignCertsAsync']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * CertificationsApi - factory interface - * @export - */ -export const CertificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CertificationsApiFp(configuration) - return { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCertificationTask(requestParameters: CertificationsApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Identity certification by id - * @param {CertificationsApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertification(requestParameters: CertificationsApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityCertificationItemPermissions(requestParameters: CertificationsApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPendingCertificationTasks(requestParameters: CertificationsApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCertificationReviewers(requestParameters: CertificationsApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityAccessReviewItems(requestParameters: CertificationsApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary List identity campaign certifications - * @param {CertificationsApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityCertifications(requestParameters: CertificationsApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - makeIdentityDecision(requestParameters: CertificationsApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.makeIdentityDecision(requestParameters.id, requestParameters.reviewDecision, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - reassignIdentityCertifications(requestParameters: CertificationsApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - signOffIdentityCertification(requestParameters: CertificationsApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitReassignCertsAsync(requestParameters: CertificationsApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getCertificationTask operation in CertificationsApi. - * @export - * @interface CertificationsApiGetCertificationTaskRequest - */ -export interface CertificationsApiGetCertificationTaskRequest { - /** - * The task ID - * @type {string} - * @memberof CertificationsApiGetCertificationTask - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertification operation in CertificationsApi. - * @export - * @interface CertificationsApiGetIdentityCertificationRequest - */ -export interface CertificationsApiGetIdentityCertificationRequest { - /** - * The certification id - * @type {string} - * @memberof CertificationsApiGetIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for getIdentityCertificationItemPermissions operation in CertificationsApi. - * @export - * @interface CertificationsApiGetIdentityCertificationItemPermissionsRequest - */ -export interface CertificationsApiGetIdentityCertificationItemPermissionsRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly certificationId: string - - /** - * The certification item ID - * @type {string} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly itemId: 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 - * @type {string} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsApiGetIdentityCertificationItemPermissions - */ - readonly count?: boolean -} - -/** - * Request parameters for getPendingCertificationTasks operation in CertificationsApi. - * @export - * @interface CertificationsApiGetPendingCertificationTasksRequest - */ -export interface CertificationsApiGetPendingCertificationTasksRequest { - /** - * The ID of reviewer identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsApiGetPendingCertificationTasks - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiGetPendingCertificationTasks - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiGetPendingCertificationTasks - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsApiGetPendingCertificationTasks - */ - 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, in* **targetId**: *eq, in* **type**: *eq, in* - * @type {string} - * @memberof CertificationsApiGetPendingCertificationTasks - */ - readonly filters?: string -} - -/** - * Request parameters for listCertificationReviewers operation in CertificationsApi. - * @export - * @interface CertificationsApiListCertificationReviewersRequest - */ -export interface CertificationsApiListCertificationReviewersRequest { - /** - * The certification ID - * @type {string} - * @memberof CertificationsApiListCertificationReviewers - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListCertificationReviewers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListCertificationReviewers - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsApiListCertificationReviewers - */ - 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, in* **name**: *eq, sw* **email**: *eq, sw* - * @type {string} - * @memberof CertificationsApiListCertificationReviewers - */ - 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: **name, email** - * @type {string} - * @memberof CertificationsApiListCertificationReviewers - */ - readonly sorters?: string -} - -/** - * Request parameters for listIdentityAccessReviewItems operation in CertificationsApi. - * @export - * @interface CertificationsApiListIdentityAccessReviewItemsRequest - */ -export interface CertificationsApiListIdentityAccessReviewItemsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - 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, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - 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: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly sorters?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly entitlements?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly accessProfiles?: string - - /** - * Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. - * @type {string} - * @memberof CertificationsApiListIdentityAccessReviewItems - */ - readonly roles?: string -} - -/** - * Request parameters for listIdentityCertifications operation in CertificationsApi. - * @export - * @interface CertificationsApiListIdentityCertificationsRequest - */ -export interface CertificationsApiListIdentityCertificationsRequest { - /** - * Reviewer\'s identity. *me* indicates the current user. - * @type {string} - * @memberof CertificationsApiListIdentityCertifications - */ - readonly reviewerIdentity?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListIdentityCertifications - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof CertificationsApiListIdentityCertifications - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof CertificationsApiListIdentityCertifications - */ - 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, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* - * @type {string} - * @memberof CertificationsApiListIdentityCertifications - */ - 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: **name, due, signed** - * @type {string} - * @memberof CertificationsApiListIdentityCertifications - */ - readonly sorters?: string -} - -/** - * Request parameters for makeIdentityDecision operation in CertificationsApi. - * @export - * @interface CertificationsApiMakeIdentityDecisionRequest - */ -export interface CertificationsApiMakeIdentityDecisionRequest { - /** - * The ID of the identity campaign certification on which to make decisions - * @type {string} - * @memberof CertificationsApiMakeIdentityDecision - */ - readonly id: string - - /** - * A non-empty array of decisions to be made. - * @type {Array} - * @memberof CertificationsApiMakeIdentityDecision - */ - readonly reviewDecision: Array -} - -/** - * Request parameters for reassignIdentityCertifications operation in CertificationsApi. - * @export - * @interface CertificationsApiReassignIdentityCertificationsRequest - */ -export interface CertificationsApiReassignIdentityCertificationsRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsApiReassignIdentityCertifications - */ - readonly id: string - - /** - * - * @type {ReviewReassign} - * @memberof CertificationsApiReassignIdentityCertifications - */ - readonly reviewReassign: ReviewReassign -} - -/** - * Request parameters for signOffIdentityCertification operation in CertificationsApi. - * @export - * @interface CertificationsApiSignOffIdentityCertificationRequest - */ -export interface CertificationsApiSignOffIdentityCertificationRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsApiSignOffIdentityCertification - */ - readonly id: string -} - -/** - * Request parameters for submitReassignCertsAsync operation in CertificationsApi. - * @export - * @interface CertificationsApiSubmitReassignCertsAsyncRequest - */ -export interface CertificationsApiSubmitReassignCertsAsyncRequest { - /** - * The identity campaign certification ID - * @type {string} - * @memberof CertificationsApiSubmitReassignCertsAsync - */ - readonly id: string - - /** - * - * @type {ReviewReassign} - * @memberof CertificationsApiSubmitReassignCertsAsync - */ - readonly reviewReassign: ReviewReassign -} - -/** - * CertificationsApi - object-oriented interface - * @export - * @class CertificationsApi - * @extends {BaseAPI} - */ -export class CertificationsApi extends BaseAPI { - /** - * This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. - * @summary Certification task by id - * @param {CertificationsApiGetCertificationTaskRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public getCertificationTask(requestParameters: CertificationsApiGetCertificationTaskRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).getCertificationTask(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Identity certification by id - * @param {CertificationsApiGetIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public getIdentityCertification(requestParameters: CertificationsApiGetIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).getIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the permissions associated with an entitlement certification item based on the certification item\'s ID. Reviewers for this certification can also call this API. - * @summary Permissions for entitlement certification item - * @param {CertificationsApiGetIdentityCertificationItemPermissionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public getIdentityCertificationItemPermissions(requestParameters: CertificationsApiGetIdentityCertificationItemPermissionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).getIdentityCertificationItemPermissions(requestParameters.certificationId, requestParameters.itemId, requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. - * @summary List of pending certification tasks - * @param {CertificationsApiGetPendingCertificationTasksRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public getPendingCertificationTasks(requestParameters: CertificationsApiGetPendingCertificationTasksRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).getPendingCertificationTasks(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. - * @summary List of reviewers for certification - * @param {CertificationsApiListCertificationReviewersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public listCertificationReviewers(requestParameters: CertificationsApiListCertificationReviewersRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).listCertificationReviewers(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary List of access review items - * @param {CertificationsApiListIdentityAccessReviewItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public listIdentityAccessReviewItems(requestParameters: CertificationsApiListIdentityAccessReviewItemsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).listIdentityAccessReviewItems(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.entitlements, requestParameters.accessProfiles, requestParameters.roles, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. - * @summary List identity campaign certifications - * @param {CertificationsApiListIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public listIdentityCertifications(requestParameters: CertificationsApiListIdentityCertificationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).listIdentityCertifications(requestParameters.reviewerIdentity, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Decide on a certification item - * @param {CertificationsApiMakeIdentityDecisionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public makeIdentityDecision(requestParameters: CertificationsApiMakeIdentityDecisionRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).makeIdentityDecision(requestParameters.id, requestParameters.reviewDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Reassign identities or items - * @param {CertificationsApiReassignIdentityCertificationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public reassignIdentityCertifications(requestParameters: CertificationsApiReassignIdentityCertificationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).reassignIdentityCertifications(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. - * @summary Finalize identity certification decisions - * @param {CertificationsApiSignOffIdentityCertificationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public signOffIdentityCertification(requestParameters: CertificationsApiSignOffIdentityCertificationRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).signOffIdentityCertification(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. Reviewers for this certification can also call this API. - * @summary Reassign certifications asynchronously - * @param {CertificationsApiSubmitReassignCertsAsyncRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof CertificationsApi - */ - public submitReassignCertsAsync(requestParameters: CertificationsApiSubmitReassignCertsAsyncRequest, axiosOptions?: RawAxiosRequestConfig) { - return CertificationsApiFp(this.configuration).submitReassignCertsAsync(requestParameters.id, requestParameters.reviewReassign, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConfigurationHubApi - axios parameter creator - * @export - */ -export const ConfigurationHubApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequest} objectMappingRequest The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping: async (sourceOrg: string, objectMappingRequest: ObjectMappingRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingRequest' is not null or undefined - assertParamExists('createObjectMapping', 'objectMappingRequest', objectMappingRequest) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequest} objectMappingBulkCreateRequest The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings: async (sourceOrg: string, objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('createObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkCreateRequest' is not null or undefined - assertParamExists('createObjectMappings', 'objectMappingBulkCreateRequest', objectMappingBulkCreateRequest) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkCreateRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration: async (data: File, name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'data' is not null or undefined - assertParamExists('createUploadedConfiguration', 'data', data) - // verify required parameter 'name' is not null or undefined - assertParamExists('createUploadedConfiguration', 'name', name) - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - if (name !== undefined) { - localVarFormParams.append('name', name as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping: async (sourceOrg: string, objectMappingId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('deleteObjectMapping', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingId' is not null or undefined - assertParamExists('deleteObjectMapping', 'objectMappingId', objectMappingId) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))) - .replace(`{${"objectMappingId"}}`, encodeURIComponent(String(objectMappingId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings: async (sourceOrg: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('getObjectMappings', 'sourceOrg', sourceOrg) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getUploadedConfiguration', 'id', id) - const localVarPath = `/configuration-hub/backups/uploads/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/configuration-hub/backups/uploads`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequest} objectMappingBulkPatchRequest The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings: async (sourceOrg: string, objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceOrg' is not null or undefined - assertParamExists('updateObjectMappings', 'sourceOrg', sourceOrg) - // verify required parameter 'objectMappingBulkPatchRequest' is not null or undefined - assertParamExists('updateObjectMappings', 'objectMappingBulkPatchRequest', objectMappingBulkPatchRequest) - const localVarPath = `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` - .replace(`{${"sourceOrg"}}`, encodeURIComponent(String(sourceOrg))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(objectMappingBulkPatchRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ConfigurationHubApi - functional programming interface - * @export - */ -export const ConfigurationHubApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConfigurationHubApiAxiosParamCreator(configuration) - return { - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingRequest} objectMappingRequest The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMapping(sourceOrg: string, objectMappingRequest: ObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMapping(sourceOrg, objectMappingRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkCreateRequest} objectMappingBulkCreateRequest The bulk create object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createObjectMappings(sourceOrg: string, objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectMappings(sourceOrg, objectMappingBulkCreateRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {File} data JSON file containing the objects to be imported. - * @param {string} name Name that will be assigned to the uploaded configuration file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createUploadedConfiguration(data: File, name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createUploadedConfiguration(data, name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.createUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {string} sourceOrg The name of the source org. - * @param {string} objectMappingId The id of the object mapping to be deleted. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteObjectMapping(sourceOrg: string, objectMappingId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectMapping(sourceOrg, objectMappingId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteObjectMapping']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.deleteUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {string} sourceOrg The name of the source org. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getObjectMappings(sourceOrg: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMappings(sourceOrg, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.getObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {string} id The id of the uploaded configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUploadedConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUploadedConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.getUploadedConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listUploadedConfigurations(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listUploadedConfigurations(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.listUploadedConfigurations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {string} sourceOrg The name of the source org. - * @param {ObjectMappingBulkPatchRequest} objectMappingBulkPatchRequest The object mapping request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateObjectMappings(sourceOrg: string, objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateObjectMappings(sourceOrg, objectMappingBulkPatchRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConfigurationHubApi.updateObjectMappings']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConfigurationHubApi - factory interface - * @export - */ -export const ConfigurationHubApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConfigurationHubApiFp(configuration) - return { - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMapping(requestParameters: ConfigurationHubApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createObjectMappings(requestParameters: ConfigurationHubApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createUploadedConfiguration(requestParameters: ConfigurationHubApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteObjectMapping(requestParameters: ConfigurationHubApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteUploadedConfiguration(requestParameters: ConfigurationHubApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getObjectMappings(requestParameters: ConfigurationHubApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUploadedConfiguration(requestParameters: ConfigurationHubApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listUploadedConfigurations(requestParameters: ConfigurationHubApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateObjectMappings(requestParameters: ConfigurationHubApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createObjectMapping operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiCreateObjectMappingRequest - */ -export interface ConfigurationHubApiCreateObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubApiCreateObjectMapping - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingRequest} - * @memberof ConfigurationHubApiCreateObjectMapping - */ - readonly objectMappingRequest: ObjectMappingRequest -} - -/** - * Request parameters for createObjectMappings operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiCreateObjectMappingsRequest - */ -export interface ConfigurationHubApiCreateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubApiCreateObjectMappings - */ - readonly sourceOrg: string - - /** - * The bulk create object mapping request body. - * @type {ObjectMappingBulkCreateRequest} - * @memberof ConfigurationHubApiCreateObjectMappings - */ - readonly objectMappingBulkCreateRequest: ObjectMappingBulkCreateRequest -} - -/** - * Request parameters for createUploadedConfiguration operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiCreateUploadedConfigurationRequest - */ -export interface ConfigurationHubApiCreateUploadedConfigurationRequest { - /** - * JSON file containing the objects to be imported. - * @type {File} - * @memberof ConfigurationHubApiCreateUploadedConfiguration - */ - readonly data: File - - /** - * Name that will be assigned to the uploaded configuration file. - * @type {string} - * @memberof ConfigurationHubApiCreateUploadedConfiguration - */ - readonly name: string -} - -/** - * Request parameters for deleteObjectMapping operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiDeleteObjectMappingRequest - */ -export interface ConfigurationHubApiDeleteObjectMappingRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubApiDeleteObjectMapping - */ - readonly sourceOrg: string - - /** - * The id of the object mapping to be deleted. - * @type {string} - * @memberof ConfigurationHubApiDeleteObjectMapping - */ - readonly objectMappingId: string -} - -/** - * Request parameters for deleteUploadedConfiguration operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiDeleteUploadedConfigurationRequest - */ -export interface ConfigurationHubApiDeleteUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubApiDeleteUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getObjectMappings operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiGetObjectMappingsRequest - */ -export interface ConfigurationHubApiGetObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubApiGetObjectMappings - */ - readonly sourceOrg: string -} - -/** - * Request parameters for getUploadedConfiguration operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiGetUploadedConfigurationRequest - */ -export interface ConfigurationHubApiGetUploadedConfigurationRequest { - /** - * The id of the uploaded configuration. - * @type {string} - * @memberof ConfigurationHubApiGetUploadedConfiguration - */ - readonly id: string -} - -/** - * Request parameters for listUploadedConfigurations operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiListUploadedConfigurationsRequest - */ -export interface ConfigurationHubApiListUploadedConfigurationsRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* - * @type {string} - * @memberof ConfigurationHubApiListUploadedConfigurations - */ - readonly filters?: string -} - -/** - * Request parameters for updateObjectMappings operation in ConfigurationHubApi. - * @export - * @interface ConfigurationHubApiUpdateObjectMappingsRequest - */ -export interface ConfigurationHubApiUpdateObjectMappingsRequest { - /** - * The name of the source org. - * @type {string} - * @memberof ConfigurationHubApiUpdateObjectMappings - */ - readonly sourceOrg: string - - /** - * The object mapping request body. - * @type {ObjectMappingBulkPatchRequest} - * @memberof ConfigurationHubApiUpdateObjectMappings - */ - readonly objectMappingBulkPatchRequest: ObjectMappingBulkPatchRequest -} - -/** - * ConfigurationHubApi - object-oriented interface - * @export - * @class ConfigurationHubApi - * @extends {BaseAPI} - */ -export class ConfigurationHubApi extends BaseAPI { - /** - * This creates an object mapping between current org and source org. Source org should be \"default\" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Creates an object mapping - * @param {ConfigurationHubApiCreateObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public createObjectMapping(requestParameters: ConfigurationHubApiCreateObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).createObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a set of object mappings (Max 25) between current org and source org. Source org should be \"default\" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk creates object mappings - * @param {ConfigurationHubApiCreateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public createObjectMappings(requestParameters: ConfigurationHubApiCreateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).createObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkCreateRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a JSON configuration file into a tenant. Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. - * @summary Upload a configuration - * @param {ConfigurationHubApiCreateUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public createUploadedConfiguration(requestParameters: ConfigurationHubApiCreateUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).createUploadedConfiguration(requestParameters.data, requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an existing object mapping. Source org should be \"default\" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Deletes an object mapping - * @param {ConfigurationHubApiDeleteObjectMappingRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public deleteObjectMapping(requestParameters: ConfigurationHubApiDeleteObjectMappingRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).deleteObjectMapping(requestParameters.sourceOrg, requestParameters.objectMappingId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes an uploaded configuration based on Id. On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. - * @summary Delete an uploaded configuration - * @param {ConfigurationHubApiDeleteUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public deleteUploadedConfiguration(requestParameters: ConfigurationHubApiDeleteUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).deleteUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of existing object mappings between current org and source org. Source org should be \"default\" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read - * @summary Gets list of object mappings - * @param {ConfigurationHubApiGetObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public getObjectMappings(requestParameters: ConfigurationHubApiGetObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).getObjectMappings(requestParameters.sourceOrg, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets an existing uploaded configuration for the current tenant. - * @summary Get an uploaded configuration - * @param {ConfigurationHubApiGetUploadedConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public getUploadedConfiguration(requestParameters: ConfigurationHubApiGetUploadedConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).getUploadedConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a list of existing uploaded configurations for the current tenant. - * @summary List uploaded configurations - * @param {ConfigurationHubApiListUploadedConfigurationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public listUploadedConfigurations(requestParameters: ConfigurationHubApiListUploadedConfigurationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).listUploadedConfigurations(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be \"default\" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage - * @summary Bulk updates object mappings - * @param {ConfigurationHubApiUpdateObjectMappingsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConfigurationHubApi - */ - public updateObjectMappings(requestParameters: ConfigurationHubApiUpdateObjectMappingsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConfigurationHubApiFp(this.configuration).updateObjectMappings(requestParameters.sourceOrg, requestParameters.objectMappingBulkPatchRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ConnectorsApi - axios parameter creator - * @export - */ -export const ConnectorsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDto} v3CreateConnectorDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector: async (v3CreateConnectorDto: V3CreateConnectorDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'v3CreateConnectorDto' is not null or undefined - assertParamExists('createCustomConnector', 'v3CreateConnectorDto', v3CreateConnectorDto) - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(v3CreateConnectorDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('deleteCustomConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV3} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector: async (scriptName: string, locale?: GetConnectorLocaleV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnector', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV3} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList: async (filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/connectors`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (locale !== undefined) { - localVarQueryParameter['locale'] = locale; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceConfig', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorSourceTemplate', 'scriptName', scriptName) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV3} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations: async (scriptName: string, locale: GetConnectorTranslationsLocaleV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('getConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceConfig', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-config` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate: async (scriptName: string, file: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'scriptName', scriptName) - // verify required parameter 'file' is not null or undefined - assertParamExists('putConnectorSourceTemplate', 'file', file) - const localVarPath = `/connectors/{scriptName}/source-template` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV3} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations: async (scriptName: string, locale: PutConnectorTranslationsLocaleV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('putConnectorTranslations', 'scriptName', scriptName) - // verify required parameter 'locale' is not null or undefined - assertParamExists('putConnectorTranslations', 'locale', locale) - const localVarPath = `/connectors/{scriptName}/translations/{locale}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))) - .replace(`{${"locale"}}`, encodeURIComponent(String(locale))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperation A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector: async (scriptName: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('updateConnector', 'scriptName', scriptName) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateConnector', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/connectors/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * ConnectorsApi - functional programming interface - * @export - */ -export const ConnectorsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ConnectorsApiAxiosParamCreator(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {V3CreateConnectorDto} v3CreateConnectorDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createCustomConnector(v3CreateConnectorDto: V3CreateConnectorDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomConnector(v3CreateConnectorDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.createCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteCustomConnector(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCustomConnector(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.deleteCustomConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {GetConnectorLocaleV3} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnector(scriptName: string, locale?: GetConnectorLocaleV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnector(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.getConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {GetConnectorListLocaleV3} [locale] The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorList(filters?: string, limit?: number, offset?: number, count?: boolean, locale?: GetConnectorListLocaleV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorList(filters, limit, offset, count, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.getConnectorList']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceConfig(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceConfig(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.getConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorSourceTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorSourceTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.getConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {GetConnectorTranslationsLocaleV3} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getConnectorTranslations(scriptName: string, locale: GetConnectorTranslationsLocaleV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.getConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source config xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceConfig(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceConfig(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.putConnectorSourceConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {File} file connector source template xml file - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorSourceTemplate(scriptName: string, file: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorSourceTemplate(scriptName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.putConnectorSourceTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {string} scriptName The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @param {PutConnectorTranslationsLocaleV3} locale The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putConnectorTranslations(scriptName: string, locale: PutConnectorTranslationsLocaleV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putConnectorTranslations(scriptName, locale, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.putConnectorTranslations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {string} scriptName The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @param {Array} jsonPatchOperation A list of connector detail update operations - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateConnector(scriptName: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateConnector(scriptName, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ConnectorsApi.updateConnector']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ConnectorsApi - factory interface - * @export - */ -export const ConnectorsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ConnectorsApiFp(configuration) - return { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createCustomConnector(requestParameters: ConnectorsApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createCustomConnector(requestParameters.v3CreateConnectorDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteCustomConnector(requestParameters: ConnectorsApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnector(requestParameters: ConnectorsApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorList(requestParameters: ConnectorsApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceConfig(requestParameters: ConnectorsApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorSourceTemplate(requestParameters: ConnectorsApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getConnectorTranslations(requestParameters: ConnectorsApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceConfig(requestParameters: ConnectorsApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorSourceTemplate(requestParameters: ConnectorsApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putConnectorTranslations(requestParameters: ConnectorsApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateConnector(requestParameters: ConnectorsApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createCustomConnector operation in ConnectorsApi. - * @export - * @interface ConnectorsApiCreateCustomConnectorRequest - */ -export interface ConnectorsApiCreateCustomConnectorRequest { - /** - * - * @type {V3CreateConnectorDto} - * @memberof ConnectorsApiCreateCustomConnector - */ - readonly v3CreateConnectorDto: V3CreateConnectorDto -} - -/** - * Request parameters for deleteCustomConnector operation in ConnectorsApi. - * @export - * @interface ConnectorsApiDeleteCustomConnectorRequest - */ -export interface ConnectorsApiDeleteCustomConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiDeleteCustomConnector - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnector operation in ConnectorsApi. - * @export - * @interface ConnectorsApiGetConnectorRequest - */ -export interface ConnectorsApiGetConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiGetConnector - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsApiGetConnector - */ - readonly locale?: GetConnectorLocaleV3 -} - -/** - * Request parameters for getConnectorList operation in ConnectorsApi. - * @export - * @interface ConnectorsApiGetConnectorListRequest - */ -export interface ConnectorsApiGetConnectorListRequest { - /** - * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* - * @type {string} - * @memberof ConnectorsApiGetConnectorList - */ - readonly filters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsApiGetConnectorList - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof ConnectorsApiGetConnectorList - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof ConnectorsApiGetConnectorList - */ - readonly count?: boolean - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsApiGetConnectorList - */ - readonly locale?: GetConnectorListLocaleV3 -} - -/** - * Request parameters for getConnectorSourceConfig operation in ConnectorsApi. - * @export - * @interface ConnectorsApiGetConnectorSourceConfigRequest - */ -export interface ConnectorsApiGetConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiGetConnectorSourceConfig - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorSourceTemplate operation in ConnectorsApi. - * @export - * @interface ConnectorsApiGetConnectorSourceTemplateRequest - */ -export interface ConnectorsApiGetConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiGetConnectorSourceTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getConnectorTranslations operation in ConnectorsApi. - * @export - * @interface ConnectorsApiGetConnectorTranslationsRequest - */ -export interface ConnectorsApiGetConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiGetConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsApiGetConnectorTranslations - */ - readonly locale: GetConnectorTranslationsLocaleV3 -} - -/** - * Request parameters for putConnectorSourceConfig operation in ConnectorsApi. - * @export - * @interface ConnectorsApiPutConnectorSourceConfigRequest - */ -export interface ConnectorsApiPutConnectorSourceConfigRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiPutConnectorSourceConfig - */ - readonly scriptName: string - - /** - * connector source config xml file - * @type {File} - * @memberof ConnectorsApiPutConnectorSourceConfig - */ - readonly file: File -} - -/** - * Request parameters for putConnectorSourceTemplate operation in ConnectorsApi. - * @export - * @interface ConnectorsApiPutConnectorSourceTemplateRequest - */ -export interface ConnectorsApiPutConnectorSourceTemplateRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiPutConnectorSourceTemplate - */ - readonly scriptName: string - - /** - * connector source template xml file - * @type {File} - * @memberof ConnectorsApiPutConnectorSourceTemplate - */ - readonly file: File -} - -/** - * Request parameters for putConnectorTranslations operation in ConnectorsApi. - * @export - * @interface ConnectorsApiPutConnectorTranslationsRequest - */ -export interface ConnectorsApiPutConnectorTranslationsRequest { - /** - * The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiPutConnectorTranslations - */ - readonly scriptName: string - - /** - * The locale to apply to the config. If no viable locale is given, it will default to \"en\" - * @type {'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'} - * @memberof ConnectorsApiPutConnectorTranslations - */ - readonly locale: PutConnectorTranslationsLocaleV3 -} - -/** - * Request parameters for updateConnector operation in ConnectorsApi. - * @export - * @interface ConnectorsApiUpdateConnectorRequest - */ -export interface ConnectorsApiUpdateConnectorRequest { - /** - * The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - * @type {string} - * @memberof ConnectorsApiUpdateConnector - */ - readonly scriptName: string - - /** - * A list of connector detail update operations - * @type {Array} - * @memberof ConnectorsApiUpdateConnector - */ - readonly jsonPatchOperation: Array -} - -/** - * ConnectorsApi - object-oriented interface - * @export - * @class ConnectorsApi - * @extends {BaseAPI} - */ -export class ConnectorsApi extends BaseAPI { - /** - * Create custom connector. - * @summary Create custom connector - * @param {ConnectorsApiCreateCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public createCustomConnector(requestParameters: ConnectorsApiCreateCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).createCustomConnector(requestParameters.v3CreateConnectorDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a custom connector that using its script name. - * @summary Delete connector by script name - * @param {ConnectorsApiDeleteCustomConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public deleteCustomConnector(requestParameters: ConnectorsApiDeleteCustomConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).deleteCustomConnector(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector that using its script name. - * @summary Get connector by script name - * @param {ConnectorsApiGetConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public getConnector(requestParameters: ConnectorsApiGetConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).getConnector(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches list of connectors that have \'RELEASED\' status using filtering and pagination. - * @summary Get connector list - * @param {ConnectorsApiGetConnectorListRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public getConnectorList(requestParameters: ConnectorsApiGetConnectorListRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).getConnectorList(requestParameters.filters, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source config using its script name. - * @summary Get connector source configuration - * @param {ConnectorsApiGetConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public getConnectorSourceConfig(requestParameters: ConnectorsApiGetConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).getConnectorSourceConfig(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s source template using its script name. - * @summary Get connector source template - * @param {ConnectorsApiGetConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public getConnectorSourceTemplate(requestParameters: ConnectorsApiGetConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).getConnectorSourceTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a connector\'s translations using its script name. - * @summary Get connector translations - * @param {ConnectorsApiGetConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public getConnectorTranslations(requestParameters: ConnectorsApiGetConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).getConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source config using its script name. - * @summary Update connector source configuration - * @param {ConnectorsApiPutConnectorSourceConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public putConnectorSourceConfig(requestParameters: ConnectorsApiPutConnectorSourceConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).putConnectorSourceConfig(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s source template using its script name. - * @summary Update connector source template - * @param {ConnectorsApiPutConnectorSourceTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public putConnectorSourceTemplate(requestParameters: ConnectorsApiPutConnectorSourceTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).putConnectorSourceTemplate(requestParameters.scriptName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a connector\'s translations using its script name. - * @summary Update connector translations - * @param {ConnectorsApiPutConnectorTranslationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public putConnectorTranslations(requestParameters: ConnectorsApiPutConnectorTranslationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).putConnectorTranslations(requestParameters.scriptName, requestParameters.locale, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml - * @summary Update connector by script name - * @param {ConnectorsApiUpdateConnectorRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ConnectorsApi - */ - public updateConnector(requestParameters: ConnectorsApiUpdateConnectorRequest, axiosOptions?: RawAxiosRequestConfig) { - return ConnectorsApiFp(this.configuration).updateConnector(requestParameters.scriptName, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetConnectorLocaleV3 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorLocaleV3 = typeof GetConnectorLocaleV3[keyof typeof GetConnectorLocaleV3]; -/** - * @export - */ -export const GetConnectorListLocaleV3 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorListLocaleV3 = typeof GetConnectorListLocaleV3[keyof typeof GetConnectorListLocaleV3]; -/** - * @export - */ -export const GetConnectorTranslationsLocaleV3 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type GetConnectorTranslationsLocaleV3 = typeof GetConnectorTranslationsLocaleV3[keyof typeof GetConnectorTranslationsLocaleV3]; -/** - * @export - */ -export const PutConnectorTranslationsLocaleV3 = { - De: 'de', - False: 'false', - Fi: 'fi', - Sv: 'sv', - Ru: 'ru', - Pt: 'pt', - Ko: 'ko', - ZhTw: 'zh-TW', - En: 'en', - It: 'it', - Fr: 'fr', - ZhCn: 'zh-CN', - Hu: 'hu', - Es: 'es', - Cs: 'cs', - Ja: 'ja', - Pl: 'pl', - Da: 'da', - Nl: 'nl' -} as const; -export type PutConnectorTranslationsLocaleV3 = typeof PutConnectorTranslationsLocaleV3[keyof typeof PutConnectorTranslationsLocaleV3]; - - -/** - * GlobalTenantSecuritySettingsApi - axios parameter creator - * @export - */ -export const GlobalTenantSecuritySettingsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfiguration} networkConfiguration Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig: async (networkConfiguration: NetworkConfiguration, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'networkConfiguration' is not null or undefined - assertParamExists('createAuthOrgNetworkConfig', 'networkConfiguration', networkConfiguration) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(networkConfiguration, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperation A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig: async (jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAuthOrgLockoutConfig', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/auth-org/lockout-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperation A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig: async (jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAuthOrgNetworkConfig', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/auth-org/network-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperation A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig: async (jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAuthOrgServiceProviderConfig', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/auth-org/service-provider-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperation A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig: async (jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchAuthOrgSessionConfig', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/auth-org/session-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * GlobalTenantSecuritySettingsApi - functional programming interface - * @export - */ -export const GlobalTenantSecuritySettingsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = GlobalTenantSecuritySettingsApiAxiosParamCreator(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {NetworkConfiguration} networkConfiguration Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createAuthOrgNetworkConfig(networkConfiguration: NetworkConfiguration, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createAuthOrgNetworkConfig(networkConfiguration, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.createAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgLockoutConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.getAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgNetworkConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.getAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgServiceProviderConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.getAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthOrgSessionConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.getAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {Array} jsonPatchOperation A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgLockoutConfig(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgLockoutConfig(jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.patchAuthOrgLockoutConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {Array} jsonPatchOperation A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgNetworkConfig(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgNetworkConfig(jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.patchAuthOrgNetworkConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {Array} jsonPatchOperation A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgServiceProviderConfig(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgServiceProviderConfig(jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.patchAuthOrgServiceProviderConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {Array} jsonPatchOperation A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchAuthOrgSessionConfig(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchAuthOrgSessionConfig(jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['GlobalTenantSecuritySettingsApi.patchAuthOrgSessionConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * GlobalTenantSecuritySettingsApi - factory interface - * @export - */ -export const GlobalTenantSecuritySettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = GlobalTenantSecuritySettingsApiFp(configuration) - return { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createAuthOrgNetworkConfig(requestParameters.networkConfiguration, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgLockoutConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgNetworkConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAuthOrgSessionConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchAuthOrgSessionConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi. - * @export - * @interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest { - /** - * Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {NetworkConfiguration} - * @memberof GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfig - */ - readonly networkConfiguration: NetworkConfiguration -} - -/** - * Request parameters for patchAuthOrgLockoutConfig operation in GlobalTenantSecuritySettingsApi. - * @export - * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest - */ -export interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest { - /** - * A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfig - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi. - * @export - * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest - */ -export interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest { - /** - * A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. - * @type {Array} - * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfig - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for patchAuthOrgServiceProviderConfig operation in GlobalTenantSecuritySettingsApi. - * @export - * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest - */ -export interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest { - /** - * A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) - * @type {Array} - * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfig - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for patchAuthOrgSessionConfig operation in GlobalTenantSecuritySettingsApi. - * @export - * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest - */ -export interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest { - /** - * A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` - * @type {Array} - * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfig - */ - readonly jsonPatchOperation: Array -} - -/** - * GlobalTenantSecuritySettingsApi - object-oriented interface - * @export - * @class GlobalTenantSecuritySettingsApi - * @extends {BaseAPI} - */ -export class GlobalTenantSecuritySettingsApi extends BaseAPI { - /** - * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' - * @summary Create security network configuration. - * @param {GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).createAuthOrgNetworkConfig(requestParameters.networkConfiguration, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s lockout auth configuration. - * @summary Get auth org lockout configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public getAuthOrgLockoutConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).getAuthOrgLockoutConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s network auth configuration. - * @summary Get security network configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public getAuthOrgNetworkConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).getAuthOrgNetworkConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s service provider auth configuration. - * @summary Get service provider configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public getAuthOrgServiceProviderConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).getAuthOrgServiceProviderConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the details of an org\'s session auth configuration. - * @summary Get auth org session configuration. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public getAuthOrgSessionConfig(axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).getAuthOrgSessionConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing lockout configuration for an org using PATCH - * @summary Update auth org lockout configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).patchAuthOrgLockoutConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' - * @summary Update security network configuration. - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).patchAuthOrgNetworkConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing service provider configuration for an org using PATCH. - * @summary Update service provider configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).patchAuthOrgServiceProviderConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates an existing session configuration for an org using PATCH. - * @summary Update auth org session configuration - * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof GlobalTenantSecuritySettingsApi - */ - public patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return GlobalTenantSecuritySettingsApiFp(this.configuration).patchAuthOrgSessionConfig(requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * IdentityProfilesApi - axios parameter creator - * @export - */ -export const IdentityProfilesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfile} identityProfile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile: async (identityProfile: IdentityProfile, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfile' is not null or undefined - assertParamExists('createIdentityProfile', 'identityProfile', identityProfile) - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfile, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('deleteIdentityProfiles', 'requestBody', requestBody) - const localVarPath = `/identity-profiles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles/export`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getDefaultIdentityAttributeConfig', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObject Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles: async (identityProfileExportedObject: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileExportedObject' is not null or undefined - assertParamExists('importIdentityProfiles', 'identityProfileExportedObject', identityProfileExportedObject) - const localVarPath = `/identity-profiles/import`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityProfileExportedObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/identity-profiles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showIdentityPreview: async (identityPreviewRequest: IdentityPreviewRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityPreviewRequest' is not null or undefined - assertParamExists('showIdentityPreview', 'identityPreviewRequest', identityPreviewRequest) - const localVarPath = `/identity-profiles/identity-preview`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityPreviewRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile: async (identityProfileId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('syncIdentityProfile', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/process-identities` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperation List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile: async (identityProfileId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateIdentityProfile', 'identityProfileId', identityProfileId) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateIdentityProfile', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/identity-profiles/{identity-profile-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * IdentityProfilesApi - functional programming interface - * @export - */ -export const IdentityProfilesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = IdentityProfilesApiAxiosParamCreator(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfile} identityProfile - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createIdentityProfile(identityProfile: IdentityProfile, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createIdentityProfile(identityProfile, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.createIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.deleteIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {Array} requestBody Identity Profile bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteIdentityProfiles(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteIdentityProfiles(requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.deleteIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @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, name, priority** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.exportIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {string} identityProfileId The Identity Profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultIdentityAttributeConfig(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.getDefaultIdentityAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.getIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {Array} identityProfileExportedObject Previously exported Identity Profiles. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importIdentityProfiles(identityProfileExportedObject: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importIdentityProfiles(identityProfileExportedObject, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.importIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @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, name, priority, created, modified, owner.id, owner.name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityProfiles(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.listIdentityProfiles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. - * @summary Generate identity profile preview - * @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async showIdentityPreview(identityPreviewRequest: IdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.showIdentityPreview(identityPreviewRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.showIdentityPreview']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {string} identityProfileId The Identity Profile ID to be processed - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async syncIdentityProfile(identityProfileId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.syncIdentityProfile(identityProfileId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.syncIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {string} identityProfileId Identity profile ID. - * @param {Array} jsonPatchOperation List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateIdentityProfile(identityProfileId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateIdentityProfile(identityProfileId, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['IdentityProfilesApi.updateIdentityProfile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * IdentityProfilesApi - factory interface - * @export - */ -export const IdentityProfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = IdentityProfilesApiFp(configuration) - return { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createIdentityProfile(requestParameters: IdentityProfilesApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createIdentityProfile(requestParameters.identityProfile, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfile(requestParameters: IdentityProfilesApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteIdentityProfiles(requestParameters: IdentityProfilesApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportIdentityProfiles(requestParameters: IdentityProfilesApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getIdentityProfile(requestParameters: IdentityProfilesApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importIdentityProfiles(requestParameters: IdentityProfilesApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importIdentityProfiles(requestParameters.identityProfileExportedObject, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listIdentityProfiles(requestParameters: IdentityProfilesApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. - * @summary Generate identity profile preview - * @param {IdentityProfilesApiShowIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - showIdentityPreview(requestParameters: IdentityProfilesApiShowIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.showIdentityPreview(requestParameters.identityPreviewRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - syncIdentityProfile(requestParameters: IdentityProfilesApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateIdentityProfile(requestParameters: IdentityProfilesApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createIdentityProfile operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiCreateIdentityProfileRequest - */ -export interface IdentityProfilesApiCreateIdentityProfileRequest { - /** - * - * @type {IdentityProfile} - * @memberof IdentityProfilesApiCreateIdentityProfile - */ - readonly identityProfile: IdentityProfile -} - -/** - * Request parameters for deleteIdentityProfile operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiDeleteIdentityProfileRequest - */ -export interface IdentityProfilesApiDeleteIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesApiDeleteIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for deleteIdentityProfiles operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiDeleteIdentityProfilesRequest - */ -export interface IdentityProfilesApiDeleteIdentityProfilesRequest { - /** - * Identity Profile bulk delete request body. - * @type {Array} - * @memberof IdentityProfilesApiDeleteIdentityProfiles - */ - readonly requestBody: Array -} - -/** - * Request parameters for exportIdentityProfiles operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiExportIdentityProfilesRequest - */ -export interface IdentityProfilesApiExportIdentityProfilesRequest { - /** - * 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 IdentityProfilesApiExportIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesApiExportIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesApiExportIdentityProfiles - */ - 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, ne* **name**: *eq, ne* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesApiExportIdentityProfiles - */ - 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, name, priority** - * @type {string} - * @memberof IdentityProfilesApiExportIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for getDefaultIdentityAttributeConfig operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest - */ -export interface IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest { - /** - * The Identity Profile ID. - * @type {string} - * @memberof IdentityProfilesApiGetDefaultIdentityAttributeConfig - */ - readonly identityProfileId: string -} - -/** - * Request parameters for getIdentityProfile operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiGetIdentityProfileRequest - */ -export interface IdentityProfilesApiGetIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesApiGetIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for importIdentityProfiles operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiImportIdentityProfilesRequest - */ -export interface IdentityProfilesApiImportIdentityProfilesRequest { - /** - * Previously exported Identity Profiles. - * @type {Array} - * @memberof IdentityProfilesApiImportIdentityProfiles - */ - readonly identityProfileExportedObject: Array -} - -/** - * Request parameters for listIdentityProfiles operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiListIdentityProfilesRequest - */ -export interface IdentityProfilesApiListIdentityProfilesRequest { - /** - * 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 IdentityProfilesApiListIdentityProfiles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof IdentityProfilesApiListIdentityProfiles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof IdentityProfilesApiListIdentityProfiles - */ - 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* - * @type {string} - * @memberof IdentityProfilesApiListIdentityProfiles - */ - 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, name, priority, created, modified, owner.id, owner.name** - * @type {string} - * @memberof IdentityProfilesApiListIdentityProfiles - */ - readonly sorters?: string -} - -/** - * Request parameters for showIdentityPreview operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiShowIdentityPreviewRequest - */ -export interface IdentityProfilesApiShowIdentityPreviewRequest { - /** - * Identity Preview request body. - * @type {IdentityPreviewRequest} - * @memberof IdentityProfilesApiShowIdentityPreview - */ - readonly identityPreviewRequest: IdentityPreviewRequest -} - -/** - * Request parameters for syncIdentityProfile operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiSyncIdentityProfileRequest - */ -export interface IdentityProfilesApiSyncIdentityProfileRequest { - /** - * The Identity Profile ID to be processed - * @type {string} - * @memberof IdentityProfilesApiSyncIdentityProfile - */ - readonly identityProfileId: string -} - -/** - * Request parameters for updateIdentityProfile operation in IdentityProfilesApi. - * @export - * @interface IdentityProfilesApiUpdateIdentityProfileRequest - */ -export interface IdentityProfilesApiUpdateIdentityProfileRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof IdentityProfilesApiUpdateIdentityProfile - */ - readonly identityProfileId: string - - /** - * List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof IdentityProfilesApiUpdateIdentityProfile - */ - readonly jsonPatchOperation: Array -} - -/** - * IdentityProfilesApi - object-oriented interface - * @export - * @class IdentityProfilesApi - * @extends {BaseAPI} - */ -export class IdentityProfilesApi extends BaseAPI { - /** - * Creates an identity profile. - * @summary Create identity profile - * @param {IdentityProfilesApiCreateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public createIdentityProfile(requestParameters: IdentityProfilesApiCreateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).createIdentityProfile(requestParameters.identityProfile, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - * @summary Delete identity profile - * @param {IdentityProfilesApiDeleteIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public deleteIdentityProfile(requestParameters: IdentityProfilesApiDeleteIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).deleteIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes multiple Identity Profiles via a list of supplied IDs. On success, this endpoint will return a reference to the bulk delete task result. The following rights are required to access this endpoint: idn:identity-profile:delete - * @summary Delete identity profiles - * @param {IdentityProfilesApiDeleteIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public deleteIdentityProfiles(requestParameters: IdentityProfilesApiDeleteIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).deleteIdentityProfiles(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This exports existing identity profiles in the format specified by the sp-config service. - * @summary Export identity profiles - * @param {IdentityProfilesApiExportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public exportIdentityProfiles(requestParameters: IdentityProfilesApiExportIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).exportIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This returns the default identity attribute config. - * @summary Get default identity attribute config - * @param {IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).getDefaultIdentityAttributeConfig(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single identity profile by ID. - * @summary Get identity profile - * @param {IdentityProfilesApiGetIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public getIdentityProfile(requestParameters: IdentityProfilesApiGetIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).getIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This imports previously exported identity profiles. - * @summary Import identity profiles - * @param {IdentityProfilesApiImportIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public importIdentityProfiles(requestParameters: IdentityProfilesApiImportIdentityProfilesRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).importIdentityProfiles(requestParameters.identityProfileExportedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of identity profiles, based on the specified query parameters. - * @summary List identity profiles - * @param {IdentityProfilesApiListIdentityProfilesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public listIdentityProfiles(requestParameters: IdentityProfilesApiListIdentityProfilesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).listIdentityProfiles(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. - * @summary Generate identity profile preview - * @param {IdentityProfilesApiShowIdentityPreviewRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public showIdentityPreview(requestParameters: IdentityProfilesApiShowIdentityPreviewRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).showIdentityPreview(requestParameters.identityPreviewRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. - * @summary Process identities under profile - * @param {IdentityProfilesApiSyncIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public syncIdentityProfile(requestParameters: IdentityProfilesApiSyncIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).syncIdentityProfile(requestParameters.identityProfileId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a specified identity profile with this PATCH request. You cannot update these fields: * id * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - * @summary Update identity profile - * @param {IdentityProfilesApiUpdateIdentityProfileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof IdentityProfilesApi - */ - public updateIdentityProfile(requestParameters: IdentityProfilesApiUpdateIdentityProfileRequest, axiosOptions?: RawAxiosRequestConfig) { - return IdentityProfilesApiFp(this.configuration).updateIdentityProfile(requestParameters.identityProfileId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * LifecycleStatesApi - axios parameter creator - * @export - */ -export const LifecycleStatesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleState} lifecycleState Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState: async (identityProfileId: string, lifecycleState: LifecycleState, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('createLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleState' is not null or undefined - assertParamExists('createLifecycleState', 'lifecycleState', lifecycleState) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(lifecycleState, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('deleteLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('deleteLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState: async (identityProfileId: string, lifecycleStateId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleState', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('getLifecycleState', 'lifecycleStateId', lifecycleStateId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates: async (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('getLifecycleStates', 'identityProfileId', identityProfileId) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequest} setLifecycleStateRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState: async (identityId: string, setLifecycleStateRequest: SetLifecycleStateRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityId' is not null or undefined - assertParamExists('setLifecycleState', 'identityId', identityId) - // verify required parameter 'setLifecycleStateRequest' is not null or undefined - assertParamExists('setLifecycleState', 'setLifecycleStateRequest', setLifecycleStateRequest) - const localVarPath = `/identities/{identity-id}/set-lifecycle-state` - .replace(`{${"identity-id"}}`, encodeURIComponent(String(identityId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(setLifecycleStateRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperation A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates: async (identityProfileId: string, lifecycleStateId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityProfileId' is not null or undefined - assertParamExists('updateLifecycleStates', 'identityProfileId', identityProfileId) - // verify required parameter 'lifecycleStateId' is not null or undefined - assertParamExists('updateLifecycleStates', 'lifecycleStateId', lifecycleStateId) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateLifecycleStates', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` - .replace(`{${"identity-profile-id"}}`, encodeURIComponent(String(identityProfileId))) - .replace(`{${"lifecycle-state-id"}}`, encodeURIComponent(String(lifecycleStateId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * LifecycleStatesApi - functional programming interface - * @export - */ -export const LifecycleStatesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LifecycleStatesApiAxiosParamCreator(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {LifecycleState} lifecycleState Lifecycle state to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createLifecycleState(identityProfileId: string, lifecycleState: LifecycleState, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createLifecycleState(identityProfileId, lifecycleState, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.createLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.deleteLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleState(identityProfileId: string, lifecycleStateId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleState(identityProfileId, lifecycleStateId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.getLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {string} identityProfileId Identity profile ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **name, priority, created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLifecycleStates(identityProfileId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.getLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {string} identityId ID of the identity to update. - * @param {SetLifecycleStateRequest} setLifecycleStateRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setLifecycleState(identityId: string, setLifecycleStateRequest: SetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setLifecycleState(identityId, setLifecycleStateRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.setLifecycleState']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {string} identityProfileId Identity profile ID. - * @param {string} lifecycleStateId Lifecycle state ID. - * @param {Array} jsonPatchOperation A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateLifecycleStates(identityProfileId: string, lifecycleStateId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateLifecycleStates(identityProfileId, lifecycleStateId, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['LifecycleStatesApi.updateLifecycleStates']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * LifecycleStatesApi - factory interface - * @export - */ -export const LifecycleStatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LifecycleStatesApiFp(configuration) - return { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createLifecycleState(requestParameters: LifecycleStatesApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleState, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteLifecycleState(requestParameters: LifecycleStatesApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleState(requestParameters: LifecycleStatesApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getLifecycleStates(requestParameters: LifecycleStatesApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setLifecycleState(requestParameters: LifecycleStatesApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateLifecycleStates(requestParameters: LifecycleStatesApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createLifecycleState operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiCreateLifecycleStateRequest - */ -export interface LifecycleStatesApiCreateLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesApiCreateLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state to be created. - * @type {LifecycleState} - * @memberof LifecycleStatesApiCreateLifecycleState - */ - readonly lifecycleState: LifecycleState -} - -/** - * Request parameters for deleteLifecycleState operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiDeleteLifecycleStateRequest - */ -export interface LifecycleStatesApiDeleteLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesApiDeleteLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesApiDeleteLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleState operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiGetLifecycleStateRequest - */ -export interface LifecycleStatesApiGetLifecycleStateRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesApiGetLifecycleState - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesApiGetLifecycleState - */ - readonly lifecycleStateId: string -} - -/** - * Request parameters for getLifecycleStates operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiGetLifecycleStatesRequest - */ -export interface LifecycleStatesApiGetLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesApiGetLifecycleStates - */ - readonly identityProfileId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesApiGetLifecycleStates - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof LifecycleStatesApiGetLifecycleStates - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof LifecycleStatesApiGetLifecycleStates - */ - readonly count?: boolean - - /** - * 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: **name, priority, created, modified** - * @type {string} - * @memberof LifecycleStatesApiGetLifecycleStates - */ - readonly sorters?: string -} - -/** - * Request parameters for setLifecycleState operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiSetLifecycleStateRequest - */ -export interface LifecycleStatesApiSetLifecycleStateRequest { - /** - * ID of the identity to update. - * @type {string} - * @memberof LifecycleStatesApiSetLifecycleState - */ - readonly identityId: string - - /** - * - * @type {SetLifecycleStateRequest} - * @memberof LifecycleStatesApiSetLifecycleState - */ - readonly setLifecycleStateRequest: SetLifecycleStateRequest -} - -/** - * Request parameters for updateLifecycleStates operation in LifecycleStatesApi. - * @export - * @interface LifecycleStatesApiUpdateLifecycleStatesRequest - */ -export interface LifecycleStatesApiUpdateLifecycleStatesRequest { - /** - * Identity profile ID. - * @type {string} - * @memberof LifecycleStatesApiUpdateLifecycleStates - */ - readonly identityProfileId: string - - /** - * Lifecycle state ID. - * @type {string} - * @memberof LifecycleStatesApiUpdateLifecycleStates - */ - readonly lifecycleStateId: string - - /** - * A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - * @type {Array} - * @memberof LifecycleStatesApiUpdateLifecycleStates - */ - readonly jsonPatchOperation: Array -} - -/** - * LifecycleStatesApi - object-oriented interface - * @export - * @class LifecycleStatesApi - * @extends {BaseAPI} - */ -export class LifecycleStatesApi extends BaseAPI { - /** - * Use this endpoint to create a lifecycle state. - * @summary Create lifecycle state - * @param {LifecycleStatesApiCreateLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public createLifecycleState(requestParameters: LifecycleStatesApiCreateLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).createLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleState, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to delete the lifecycle state by its ID. - * @summary Delete lifecycle state - * @param {LifecycleStatesApiDeleteLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public deleteLifecycleState(requestParameters: LifecycleStatesApiDeleteLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).deleteLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - * @summary Get lifecycle state - * @param {LifecycleStatesApiGetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public getLifecycleState(requestParameters: LifecycleStatesApiGetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).getLifecycleState(requestParameters.identityProfileId, requestParameters.lifecycleStateId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to list all lifecycle states by their associated identity profiles. - * @summary Lists lifecyclestates - * @param {LifecycleStatesApiGetLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public getLifecycleStates(requestParameters: LifecycleStatesApiGetLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).getLifecycleStates(requestParameters.identityProfileId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. - * @summary Set lifecycle state - * @param {LifecycleStatesApiSetLifecycleStateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public setLifecycleState(requestParameters: LifecycleStatesApiSetLifecycleStateRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).setLifecycleState(requestParameters.identityId, requestParameters.setLifecycleStateRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @summary Update lifecycle state - * @param {LifecycleStatesApiUpdateLifecycleStatesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof LifecycleStatesApi - */ - public updateLifecycleStates(requestParameters: LifecycleStatesApiUpdateLifecycleStatesRequest, axiosOptions?: RawAxiosRequestConfig) { - return LifecycleStatesApiFp(this.configuration).updateLifecycleStates(requestParameters.identityProfileId, requestParameters.lifecycleStateId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * MFAConfigurationApi - axios parameter creator - * @export - */ -export const MFAConfigurationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {DeleteMFAConfigMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMFAConfig: async (method: DeleteMFAConfigMethodV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('deleteMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/delete` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/duo-web/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig: async (allLanguages?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/kba/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (allLanguages !== undefined) { - localVarQueryParameter['allLanguages'] = allLanguages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/mfa/okta-verify/config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfig} mfaDuoConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig: async (mfaDuoConfig: MfaDuoConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaDuoConfig' is not null or undefined - assertParamExists('setMFADuoConfig', 'mfaDuoConfig', mfaDuoConfig) - const localVarPath = `/mfa/duo-web/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaDuoConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItem - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig: async (kbaAnswerRequestItem: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItem' is not null or undefined - assertParamExists('setMFAKBAConfig', 'kbaAnswerRequestItem', kbaAnswerRequestItem) - const localVarPath = `/mfa/kba/config/answers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItem, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfig} mfaOktaConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig: async (mfaOktaConfig: MfaOktaConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'mfaOktaConfig' is not null or undefined - assertParamExists('setMFAOktaConfig', 'mfaOktaConfig', mfaOktaConfig) - const localVarPath = `/mfa/okta-verify/config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mfaOktaConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig: async (method: TestMFAConfigMethodV3, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('testMFAConfig', 'method', method) - const localVarPath = `/mfa/{method}/test` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAConfigurationApi - functional programming interface - * @export - */ -export const MFAConfigurationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAConfigurationApiAxiosParamCreator(configuration) - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {DeleteMFAConfigMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteMFAConfig(method: DeleteMFAConfigMethodV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.deleteMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFADuoConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.getMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {boolean} [allLanguages] Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAKbaConfig(allLanguages?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAKbaConfig(allLanguages, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.getMFAKbaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMFAOktaConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.getMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MfaDuoConfig} mfaDuoConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFADuoConfig(mfaDuoConfig: MfaDuoConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFADuoConfig(mfaDuoConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.setMFADuoConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {Array} kbaAnswerRequestItem - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAKBAConfig(kbaAnswerRequestItem: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAKBAConfig(kbaAnswerRequestItem, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.setMFAKBAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MfaOktaConfig} mfaOktaConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setMFAOktaConfig(mfaOktaConfig: MfaOktaConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setMFAOktaConfig(mfaOktaConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.setMFAOktaConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {TestMFAConfigMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testMFAConfig(method: TestMFAConfigMethodV3, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testMFAConfig(method, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAConfigurationApi.testMFAConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAConfigurationApi - factory interface - * @export - */ -export const MFAConfigurationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAConfigurationApiFp(configuration) - return { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {MFAConfigurationApiDeleteMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteMFAConfig(requestParameters: MFAConfigurationApiDeleteMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFADuoConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAKbaConfig(requestParameters: MFAConfigurationApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getMFAOktaConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFADuoConfig(requestParameters: MFAConfigurationApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFADuoConfig(requestParameters.mfaDuoConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAKBAConfig(requestParameters: MFAConfigurationApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setMFAKBAConfig(requestParameters.kbaAnswerRequestItem, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setMFAOktaConfig(requestParameters: MFAConfigurationApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setMFAOktaConfig(requestParameters.mfaOktaConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testMFAConfig(requestParameters: MFAConfigurationApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteMFAConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiDeleteMFAConfigRequest - */ -export interface MFAConfigurationApiDeleteMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationApiDeleteMFAConfig - */ - readonly method: DeleteMFAConfigMethodV3 -} - -/** - * Request parameters for getMFAKbaConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiGetMFAKbaConfigRequest - */ -export interface MFAConfigurationApiGetMFAKbaConfigRequest { - /** - * Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - * @type {boolean} - * @memberof MFAConfigurationApiGetMFAKbaConfig - */ - readonly allLanguages?: boolean -} - -/** - * Request parameters for setMFADuoConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiSetMFADuoConfigRequest - */ -export interface MFAConfigurationApiSetMFADuoConfigRequest { - /** - * - * @type {MfaDuoConfig} - * @memberof MFAConfigurationApiSetMFADuoConfig - */ - readonly mfaDuoConfig: MfaDuoConfig -} - -/** - * Request parameters for setMFAKBAConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiSetMFAKBAConfigRequest - */ -export interface MFAConfigurationApiSetMFAKBAConfigRequest { - /** - * - * @type {Array} - * @memberof MFAConfigurationApiSetMFAKBAConfig - */ - readonly kbaAnswerRequestItem: Array -} - -/** - * Request parameters for setMFAOktaConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiSetMFAOktaConfigRequest - */ -export interface MFAConfigurationApiSetMFAOktaConfigRequest { - /** - * - * @type {MfaOktaConfig} - * @memberof MFAConfigurationApiSetMFAOktaConfig - */ - readonly mfaOktaConfig: MfaOktaConfig -} - -/** - * Request parameters for testMFAConfig operation in MFAConfigurationApi. - * @export - * @interface MFAConfigurationApiTestMFAConfigRequest - */ -export interface MFAConfigurationApiTestMFAConfigRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. - * @type {'okta-verify' | 'duo-web'} - * @memberof MFAConfigurationApiTestMFAConfig - */ - readonly method: TestMFAConfigMethodV3 -} - -/** - * MFAConfigurationApi - object-oriented interface - * @export - * @class MFAConfigurationApi - * @extends {BaseAPI} - */ -export class MFAConfigurationApi extends BaseAPI { - /** - * This API removes the configuration for the specified MFA method. - * @summary Delete mfa method configuration - * @param {MFAConfigurationApiDeleteMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public deleteMFAConfig(requestParameters: MFAConfigurationApiDeleteMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).deleteMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Duo MFA method. - * @summary Configuration of duo mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public getMFADuoConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).getMFADuoConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the KBA configuration for MFA. - * @summary Configuration of kba mfa method - * @param {MFAConfigurationApiGetMFAKbaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public getMFAKbaConfig(requestParameters: MFAConfigurationApiGetMFAKbaConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).getMFAKbaConfig(requestParameters.allLanguages, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the configuration of an Okta MFA method. - * @summary Configuration of okta mfa method - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public getMFAOktaConfig(axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).getMFAOktaConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Duo MFA method. - * @summary Set duo mfa configuration - * @param {MFAConfigurationApiSetMFADuoConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public setMFADuoConfig(requestParameters: MFAConfigurationApiSetMFADuoConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).setMFADuoConfig(requestParameters.mfaDuoConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - * @summary Set mfa kba configuration - * @param {MFAConfigurationApiSetMFAKBAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public setMFAKBAConfig(requestParameters: MFAConfigurationApiSetMFAKBAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).setMFAKBAConfig(requestParameters.kbaAnswerRequestItem, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API sets the configuration of an Okta MFA method. - * @summary Set okta mfa configuration - * @param {MFAConfigurationApiSetMFAOktaConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public setMFAOktaConfig(requestParameters: MFAConfigurationApiSetMFAOktaConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).setMFAOktaConfig(requestParameters.mfaOktaConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - * @summary Mfa method\'s test configuration - * @param {MFAConfigurationApiTestMFAConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAConfigurationApi - */ - public testMFAConfig(requestParameters: MFAConfigurationApiTestMFAConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAConfigurationApiFp(this.configuration).testMFAConfig(requestParameters.method, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteMFAConfigMethodV3 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type DeleteMFAConfigMethodV3 = typeof DeleteMFAConfigMethodV3[keyof typeof DeleteMFAConfigMethodV3]; -/** - * @export - */ -export const TestMFAConfigMethodV3 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web' -} as const; -export type TestMFAConfigMethodV3 = typeof TestMFAConfigMethodV3[keyof typeof TestMFAConfigMethodV3]; - - -/** - * MFAControllerApi - axios parameter creator - * @export - */ -export const MFAControllerApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {SendTokenRequest} sendTokenRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSendToken: async (sendTokenRequest: SendTokenRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sendTokenRequest' is not null or undefined - assertParamExists('createSendToken', 'sendTokenRequest', sendTokenRequest) - const localVarPath = `/mfa/token/send`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sendTokenRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {PingVerificationStatusMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @param {VerificationPollRequest} verificationPollRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingVerificationStatus: async (method: PingVerificationStatusMethodV3, verificationPollRequest: VerificationPollRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'method' is not null or undefined - assertParamExists('pingVerificationStatus', 'method', method) - // verify required parameter 'verificationPollRequest' is not null or undefined - assertParamExists('pingVerificationStatus', 'verificationPollRequest', verificationPollRequest) - const localVarPath = `/mfa/{method}/poll` - .replace(`{${"method"}}`, encodeURIComponent(String(method))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(verificationPollRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {DuoVerificationRequest} duoVerificationRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDuoVerifyRequest: async (duoVerificationRequest: DuoVerificationRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'duoVerificationRequest' is not null or undefined - assertParamExists('sendDuoVerifyRequest', 'duoVerificationRequest', duoVerificationRequest) - const localVarPath = `/mfa/duo-web/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(duoVerificationRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {Array} kbaAnswerRequestItem - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendKbaAnswers: async (kbaAnswerRequestItem: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'kbaAnswerRequestItem' is not null or undefined - assertParamExists('sendKbaAnswers', 'kbaAnswerRequestItem', kbaAnswerRequestItem) - const localVarPath = `/mfa/kba/authenticate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(kbaAnswerRequestItem, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {OktaVerificationRequest} oktaVerificationRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendOktaVerifyRequest: async (oktaVerificationRequest: OktaVerificationRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'oktaVerificationRequest' is not null or undefined - assertParamExists('sendOktaVerifyRequest', 'oktaVerificationRequest', oktaVerificationRequest) - const localVarPath = `/mfa/okta-verify/verify`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(oktaVerificationRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {TokenAuthRequest} tokenAuthRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTokenAuthRequest: async (tokenAuthRequest: TokenAuthRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'tokenAuthRequest' is not null or undefined - assertParamExists('sendTokenAuthRequest', 'tokenAuthRequest', tokenAuthRequest) - const localVarPath = `/mfa/token/authenticate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tokenAuthRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * MFAControllerApi - functional programming interface - * @export - */ -export const MFAControllerApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MFAControllerApiAxiosParamCreator(configuration) - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {SendTokenRequest} sendTokenRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSendToken(sendTokenRequest: SendTokenRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSendToken(sendTokenRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.createSendToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {PingVerificationStatusMethodV3} method The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @param {VerificationPollRequest} verificationPollRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async pingVerificationStatus(method: PingVerificationStatusMethodV3, verificationPollRequest: VerificationPollRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.pingVerificationStatus(method, verificationPollRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.pingVerificationStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {DuoVerificationRequest} duoVerificationRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendDuoVerifyRequest(duoVerificationRequest: DuoVerificationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendDuoVerifyRequest(duoVerificationRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.sendDuoVerifyRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {Array} kbaAnswerRequestItem - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendKbaAnswers(kbaAnswerRequestItem: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendKbaAnswers(kbaAnswerRequestItem, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.sendKbaAnswers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {OktaVerificationRequest} oktaVerificationRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendOktaVerifyRequest(oktaVerificationRequest: OktaVerificationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendOktaVerifyRequest(oktaVerificationRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.sendOktaVerifyRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {TokenAuthRequest} tokenAuthRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendTokenAuthRequest(tokenAuthRequest: TokenAuthRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendTokenAuthRequest(tokenAuthRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['MFAControllerApi.sendTokenAuthRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * MFAControllerApi - factory interface - * @export - */ -export const MFAControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MFAControllerApiFp(configuration) - return { - /** - * This API send token request. - * @summary Create and send user token - * @param {MFAControllerApiCreateSendTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSendToken(requestParameters: MFAControllerApiCreateSendTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSendToken(requestParameters.sendTokenRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {MFAControllerApiPingVerificationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - pingVerificationStatus(requestParameters: MFAControllerApiPingVerificationStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.pingVerificationStatus(requestParameters.method, requestParameters.verificationPollRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {MFAControllerApiSendDuoVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendDuoVerifyRequest(requestParameters: MFAControllerApiSendDuoVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendDuoVerifyRequest(requestParameters.duoVerificationRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {MFAControllerApiSendKbaAnswersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendKbaAnswers(requestParameters: MFAControllerApiSendKbaAnswersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendKbaAnswers(requestParameters.kbaAnswerRequestItem, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {MFAControllerApiSendOktaVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendOktaVerifyRequest(requestParameters: MFAControllerApiSendOktaVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendOktaVerifyRequest(requestParameters.oktaVerificationRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {MFAControllerApiSendTokenAuthRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendTokenAuthRequest(requestParameters: MFAControllerApiSendTokenAuthRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendTokenAuthRequest(requestParameters.tokenAuthRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSendToken operation in MFAControllerApi. - * @export - * @interface MFAControllerApiCreateSendTokenRequest - */ -export interface MFAControllerApiCreateSendTokenRequest { - /** - * - * @type {SendTokenRequest} - * @memberof MFAControllerApiCreateSendToken - */ - readonly sendTokenRequest: SendTokenRequest -} - -/** - * Request parameters for pingVerificationStatus operation in MFAControllerApi. - * @export - * @interface MFAControllerApiPingVerificationStatusRequest - */ -export interface MFAControllerApiPingVerificationStatusRequest { - /** - * The name of the MFA method. The currently supported method names are \'okta-verify\', \'duo-web\', \'kba\',\'token\', \'rsa\' - * @type {'okta-verify' | 'duo-web' | 'kba' | 'token' | 'rsa'} - * @memberof MFAControllerApiPingVerificationStatus - */ - readonly method: PingVerificationStatusMethodV3 - - /** - * - * @type {VerificationPollRequest} - * @memberof MFAControllerApiPingVerificationStatus - */ - readonly verificationPollRequest: VerificationPollRequest -} - -/** - * Request parameters for sendDuoVerifyRequest operation in MFAControllerApi. - * @export - * @interface MFAControllerApiSendDuoVerifyRequestRequest - */ -export interface MFAControllerApiSendDuoVerifyRequestRequest { - /** - * - * @type {DuoVerificationRequest} - * @memberof MFAControllerApiSendDuoVerifyRequest - */ - readonly duoVerificationRequest: DuoVerificationRequest -} - -/** - * Request parameters for sendKbaAnswers operation in MFAControllerApi. - * @export - * @interface MFAControllerApiSendKbaAnswersRequest - */ -export interface MFAControllerApiSendKbaAnswersRequest { - /** - * - * @type {Array} - * @memberof MFAControllerApiSendKbaAnswers - */ - readonly kbaAnswerRequestItem: Array -} - -/** - * Request parameters for sendOktaVerifyRequest operation in MFAControllerApi. - * @export - * @interface MFAControllerApiSendOktaVerifyRequestRequest - */ -export interface MFAControllerApiSendOktaVerifyRequestRequest { - /** - * - * @type {OktaVerificationRequest} - * @memberof MFAControllerApiSendOktaVerifyRequest - */ - readonly oktaVerificationRequest: OktaVerificationRequest -} - -/** - * Request parameters for sendTokenAuthRequest operation in MFAControllerApi. - * @export - * @interface MFAControllerApiSendTokenAuthRequestRequest - */ -export interface MFAControllerApiSendTokenAuthRequestRequest { - /** - * - * @type {TokenAuthRequest} - * @memberof MFAControllerApiSendTokenAuthRequest - */ - readonly tokenAuthRequest: TokenAuthRequest -} - -/** - * MFAControllerApi - object-oriented interface - * @export - * @class MFAControllerApi - * @extends {BaseAPI} - */ -export class MFAControllerApi extends BaseAPI { - /** - * This API send token request. - * @summary Create and send user token - * @param {MFAControllerApiCreateSendTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public createSendToken(requestParameters: MFAControllerApiCreateSendTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).createSendToken(requestParameters.sendTokenRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API poll the VerificationPollRequest for the specified MFA method. - * @summary Polling mfa method by verificationpollrequest - * @param {MFAControllerApiPingVerificationStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public pingVerificationStatus(requestParameters: MFAControllerApiPingVerificationStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).pingVerificationStatus(requestParameters.method, requestParameters.verificationPollRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticates the user via Duo-Web MFA method. - * @summary Verifying authentication via duo method - * @param {MFAControllerApiSendDuoVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public sendDuoVerifyRequest(requestParameters: MFAControllerApiSendDuoVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).sendDuoVerifyRequest(requestParameters.duoVerificationRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticate user in KBA MFA method. - * @summary Authenticate kba provided mfa method - * @param {MFAControllerApiSendKbaAnswersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public sendKbaAnswers(requestParameters: MFAControllerApiSendKbaAnswersRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).sendKbaAnswers(requestParameters.kbaAnswerRequestItem, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticates the user via Okta-Verify MFA method. Request requires a header called \'slpt-forwarding\', and it must contain a remote IP Address of caller. - * @summary Verifying authentication via okta method - * @param {MFAControllerApiSendOktaVerifyRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public sendOktaVerifyRequest(requestParameters: MFAControllerApiSendOktaVerifyRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).sendOktaVerifyRequest(requestParameters.oktaVerificationRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API Authenticate user in Token MFA method. - * @summary Authenticate token provided mfa method - * @param {MFAControllerApiSendTokenAuthRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof MFAControllerApi - */ - public sendTokenAuthRequest(requestParameters: MFAControllerApiSendTokenAuthRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return MFAControllerApiFp(this.configuration).sendTokenAuthRequest(requestParameters.tokenAuthRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const PingVerificationStatusMethodV3 = { - OktaVerify: 'okta-verify', - DuoWeb: 'duo-web', - Kba: 'kba', - Token: 'token', - Rsa: 'rsa' -} as const; -export type PingVerificationStatusMethodV3 = typeof PingVerificationStatusMethodV3[keyof typeof PingVerificationStatusMethodV3]; - - -/** - * 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} - */ - createManagedClient: async (managedClientRequest: ManagedClientRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClientRequest' is not null or undefined - assertParamExists('createManagedClient', 'managedClientRequest', managedClientRequest) - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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} - */ - deleteManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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} - */ - getManagedClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClient', 'id', id) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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} - */ - getManagedClientStatus: async (id: string, type: ManagedClientType, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedClientStatus', 'id', id) - // verify required parameter 'type' is not null or undefined - assertParamExists('getManagedClientStatus', 'type', type) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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, - }; - }, - /** - * 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} - */ - getManagedClients: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - 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} - */ - updateManagedClient: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedClient', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateManagedClient', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/managed-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 createManagedClient(managedClientRequest: ManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedClient(managedClientRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.createManagedClient']?.[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 deleteManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.deleteManagedClient']?.[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 getManagedClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClient']?.[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 getManagedClientStatus(id: string, type: ManagedClientType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClientStatus(id, type, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClientStatus']?.[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 getManagedClients(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClients(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.getManagedClients']?.[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 updateManagedClient(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedClient(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClientsApi.updateManagedClient']?.[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 {ManagedClientsApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedClient(requestParameters: ManagedClientsApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedClient(requestParameters.managedClientRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedClient(requestParameters: ManagedClientsApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClient(requestParameters: ManagedClientsApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed client\'s status, using its ID. - * @summary Get managed client status - * @param {ManagedClientsApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClientStatus(requestParameters: ManagedClientsApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClients(requestParameters: ManagedClientsApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClients(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed client. - * @summary Update managed client - * @param {ManagedClientsApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedClient(requestParameters: ManagedClientsApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedClient operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiCreateManagedClientRequest - */ -export interface ManagedClientsApiCreateManagedClientRequest { - /** - * - * @type {ManagedClientRequest} - * @memberof ManagedClientsApiCreateManagedClient - */ - readonly managedClientRequest: ManagedClientRequest -} - -/** - * Request parameters for deleteManagedClient operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiDeleteManagedClientRequest - */ -export interface ManagedClientsApiDeleteManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsApiDeleteManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClient operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiGetManagedClientRequest - */ -export interface ManagedClientsApiGetManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsApiGetManagedClient - */ - readonly id: string -} - -/** - * Request parameters for getManagedClientStatus operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiGetManagedClientStatusRequest - */ -export interface ManagedClientsApiGetManagedClientStatusRequest { - /** - * Managed client ID to get status for. - * @type {string} - * @memberof ManagedClientsApiGetManagedClientStatus - */ - readonly id: string - - /** - * Managed client type to get status for. - * @type {ManagedClientType} - * @memberof ManagedClientsApiGetManagedClientStatus - */ - readonly type: ManagedClientType -} - -/** - * Request parameters for getManagedClients operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiGetManagedClientsRequest - */ -export interface ManagedClientsApiGetManagedClientsRequest { - /** - * 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 ManagedClientsApiGetManagedClients - */ - 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 ManagedClientsApiGetManagedClients - */ - 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 ManagedClientsApiGetManagedClients - */ - 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 ManagedClientsApiGetManagedClients - */ - readonly filters?: string -} - -/** - * Request parameters for updateManagedClient operation in ManagedClientsApi. - * @export - * @interface ManagedClientsApiUpdateManagedClientRequest - */ -export interface ManagedClientsApiUpdateManagedClientRequest { - /** - * Managed client ID. - * @type {string} - * @memberof ManagedClientsApiUpdateManagedClient - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClientsApiUpdateManagedClient - */ - 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 {ManagedClientsApiCreateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public createManagedClient(requestParameters: ManagedClientsApiCreateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).createManagedClient(requestParameters.managedClientRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed client. - * @summary Delete managed client - * @param {ManagedClientsApiDeleteManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public deleteManagedClient(requestParameters: ManagedClientsApiDeleteManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).deleteManagedClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get managed client by ID. - * @summary Get managed client - * @param {ManagedClientsApiGetManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public getManagedClient(requestParameters: ManagedClientsApiGetManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).getManagedClient(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 {ManagedClientsApiGetManagedClientStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public getManagedClientStatus(requestParameters: ManagedClientsApiGetManagedClientStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).getManagedClientStatus(requestParameters.id, requestParameters.type, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List managed clients. - * @summary Get managed clients - * @param {ManagedClientsApiGetManagedClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public getManagedClients(requestParameters: ManagedClientsApiGetManagedClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).getManagedClients(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 {ManagedClientsApiUpdateManagedClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClientsApi - */ - public updateManagedClient(requestParameters: ManagedClientsApiUpdateManagedClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClientsApiFp(this.configuration).updateManagedClient(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ManagedClustersApi - axios parameter creator - * @export - */ -export const ManagedClustersApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequest} managedClusterRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster: async (managedClusterRequest: ManagedClusterRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'managedClusterRequest' is not null or undefined - assertParamExists('createManagedCluster', 'managedClusterRequest', managedClusterRequest) - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(managedClusterRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster: async (id: string, removeClients?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (removeClients !== undefined) { - localVarQueryParameter['removeClients'] = removeClients; - } - - - - 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 cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getClientLogConfiguration', 'id', id) - const localVarPath = `/managed-clusters/{id}/log-config` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getManagedCluster', 'id', id) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/managed-clusters`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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 a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequest} putClientLogConfigurationRequest Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration: async (id: string, putClientLogConfigurationRequest: PutClientLogConfigurationRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putClientLogConfiguration', 'id', id) - // verify required parameter 'putClientLogConfigurationRequest' is not null or undefined - assertParamExists('putClientLogConfiguration', 'putClientLogConfigurationRequest', putClientLogConfigurationRequest) - const localVarPath = `/managed-clusters/{id}/log-config` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(putClientLogConfigurationRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperation JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateManagedCluster', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateManagedCluster', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/managed-clusters/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * ManagedClustersApi - functional programming interface - * @export - */ -export const ManagedClustersApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ManagedClustersApiAxiosParamCreator(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClusterRequest} managedClusterRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createManagedCluster(managedClusterRequest: ManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createManagedCluster(managedClusterRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.createManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {string} id Managed cluster ID. - * @param {boolean} [removeClients] Flag to determine the need to delete a cluster with clients. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteManagedCluster(id: string, removeClients?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteManagedCluster(id, removeClients, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.deleteManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {string} id ID of managed cluster to get log configuration for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getClientLogConfiguration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getClientLogConfiguration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.getClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {string} id Managed cluster ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedCluster(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedCluster(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.getManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getManagedClusters(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getManagedClusters(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.getManagedClusters']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {string} id ID of the managed cluster to update the log configuration for. - * @param {PutClientLogConfigurationRequest} putClientLogConfigurationRequest Client log configuration for the given managed cluster. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putClientLogConfiguration(id: string, putClientLogConfigurationRequest: PutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putClientLogConfiguration(id, putClientLogConfigurationRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.putClientLogConfiguration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {string} id Managed cluster ID. - * @param {Array} jsonPatchOperation JSONPatch payload used to update the object. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateManagedCluster(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateManagedCluster(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ManagedClustersApi.updateManagedCluster']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ManagedClustersApi - factory interface - * @export - */ -export const ManagedClustersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ManagedClustersApiFp(configuration) - return { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createManagedCluster(requestParameters: ManagedClustersApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createManagedCluster(requestParameters.managedClusterRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteManagedCluster(requestParameters: ManagedClustersApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getClientLogConfiguration(requestParameters: ManagedClustersApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedCluster(requestParameters: ManagedClustersApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getManagedClusters(requestParameters: ManagedClustersApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putClientLogConfiguration(requestParameters: ManagedClustersApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateManagedCluster(requestParameters: ManagedClustersApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createManagedCluster operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiCreateManagedClusterRequest - */ -export interface ManagedClustersApiCreateManagedClusterRequest { - /** - * - * @type {ManagedClusterRequest} - * @memberof ManagedClustersApiCreateManagedCluster - */ - readonly managedClusterRequest: ManagedClusterRequest -} - -/** - * Request parameters for deleteManagedCluster operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiDeleteManagedClusterRequest - */ -export interface ManagedClustersApiDeleteManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersApiDeleteManagedCluster - */ - readonly id: string - - /** - * Flag to determine the need to delete a cluster with clients. - * @type {boolean} - * @memberof ManagedClustersApiDeleteManagedCluster - */ - readonly removeClients?: boolean -} - -/** - * Request parameters for getClientLogConfiguration operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiGetClientLogConfigurationRequest - */ -export interface ManagedClustersApiGetClientLogConfigurationRequest { - /** - * ID of managed cluster to get log configuration for. - * @type {string} - * @memberof ManagedClustersApiGetClientLogConfiguration - */ - readonly id: string -} - -/** - * Request parameters for getManagedCluster operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiGetManagedClusterRequest - */ -export interface ManagedClustersApiGetManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersApiGetManagedCluster - */ - readonly id: string -} - -/** - * Request parameters for getManagedClusters operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiGetManagedClustersRequest - */ -export interface ManagedClustersApiGetManagedClustersRequest { - /** - * 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 ManagedClustersApiGetManagedClusters - */ - 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 ManagedClustersApiGetManagedClusters - */ - 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 ManagedClustersApiGetManagedClusters - */ - 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: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* - * @type {string} - * @memberof ManagedClustersApiGetManagedClusters - */ - readonly filters?: string -} - -/** - * Request parameters for putClientLogConfiguration operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiPutClientLogConfigurationRequest - */ -export interface ManagedClustersApiPutClientLogConfigurationRequest { - /** - * ID of the managed cluster to update the log configuration for. - * @type {string} - * @memberof ManagedClustersApiPutClientLogConfiguration - */ - readonly id: string - - /** - * Client log configuration for the given managed cluster. - * @type {PutClientLogConfigurationRequest} - * @memberof ManagedClustersApiPutClientLogConfiguration - */ - readonly putClientLogConfigurationRequest: PutClientLogConfigurationRequest -} - -/** - * Request parameters for updateManagedCluster operation in ManagedClustersApi. - * @export - * @interface ManagedClustersApiUpdateManagedClusterRequest - */ -export interface ManagedClustersApiUpdateManagedClusterRequest { - /** - * Managed cluster ID. - * @type {string} - * @memberof ManagedClustersApiUpdateManagedCluster - */ - readonly id: string - - /** - * JSONPatch payload used to update the object. - * @type {Array} - * @memberof ManagedClustersApiUpdateManagedCluster - */ - readonly jsonPatchOperation: Array -} - -/** - * ManagedClustersApi - object-oriented interface - * @export - * @class ManagedClustersApi - * @extends {BaseAPI} - */ -export class ManagedClustersApi extends BaseAPI { - /** - * Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. - * @summary Create create managed cluster - * @param {ManagedClustersApiCreateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public createManagedCluster(requestParameters: ManagedClustersApiCreateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).createManagedCluster(requestParameters.managedClusterRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing managed cluster. - * @summary Delete managed cluster - * @param {ManagedClustersApiDeleteManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public deleteManagedCluster(requestParameters: ManagedClustersApiDeleteManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).deleteManagedCluster(requestParameters.id, requestParameters.removeClients, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster\'s log configuration. - * @summary Get managed cluster log configuration - * @param {ManagedClustersApiGetClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public getClientLogConfiguration(requestParameters: ManagedClustersApiGetClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).getClientLogConfiguration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a managed cluster by ID. - * @summary Get managed cluster - * @param {ManagedClustersApiGetManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public getManagedCluster(requestParameters: ManagedClustersApiGetManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).getManagedCluster(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List current organization\'s managed clusters, based on request context. - * @summary Get managed clusters - * @param {ManagedClustersApiGetManagedClustersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public getManagedClusters(requestParameters: ManagedClustersApiGetManagedClustersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).getManagedClusters(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update a managed cluster\'s log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - * @summary Update managed cluster log configuration - * @param {ManagedClustersApiPutClientLogConfigurationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public putClientLogConfiguration(requestParameters: ManagedClustersApiPutClientLogConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).putClientLogConfiguration(requestParameters.id, requestParameters.putClientLogConfigurationRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing managed cluster. - * @summary Update managed cluster - * @param {ManagedClustersApiUpdateManagedClusterRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ManagedClustersApi - */ - public updateManagedCluster(requestParameters: ManagedClustersApiUpdateManagedClusterRequest, axiosOptions?: RawAxiosRequestConfig) { - return ManagedClustersApiFp(this.configuration).updateManagedCluster(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * NonEmployeeLifecycleManagementApi - axios parameter creator - * @export - */ -export const NonEmployeeLifecycleManagementApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecision} nonEmployeeApprovalDecision - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest: async (id: string, nonEmployeeApprovalDecision: NonEmployeeApprovalDecision, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeApprovalDecision' is not null or undefined - assertParamExists('approveNonEmployeeRequest', 'nonEmployeeApprovalDecision', nonEmployeeApprovalDecision) - const localVarPath = `/non-employee-approvals/{id}/approve` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecision, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord: async (nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBody' is not null or undefined - assertParamExists('createNonEmployeeRecord', 'nonEmployeeRequestBody', nonEmployeeRequestBody) - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest: async (nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeRequestBody' is not null or undefined - assertParamExists('createNonEmployeeRequest', 'nonEmployeeRequestBody', nonEmployeeRequestBody) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBody} nonEmployeeSourceRequestBody Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource: async (nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'nonEmployeeSourceRequestBody' is not null or undefined - assertParamExists('createNonEmployeeSource', 'nonEmployeeSourceRequestBody', nonEmployeeSourceRequestBody) - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBody} nonEmployeeSchemaAttributeBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes: async (sourceId: string, nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - // verify required parameter 'nonEmployeeSchemaAttributeBody' is not null or undefined - assertParamExists('createNonEmployeeSourceSchemaAttributes', 'nonEmployeeSchemaAttributeBody', nonEmployeeSchemaAttributeBody) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequest} deleteNonEmployeeRecordsInBulkRequest Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk: async (deleteNonEmployeeRecordsInBulkRequest: DeleteNonEmployeeRecordsInBulkRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'deleteNonEmployeeRecordsInBulkRequest' is not null or undefined - assertParamExists('deleteNonEmployeeRecordsInBulk', 'deleteNonEmployeeRecordsInBulkRequest', deleteNonEmployeeRecordsInBulkRequest) - const localVarPath = `/non-employee-records/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordsInBulkRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeRecords', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employees/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('exportNonEmployeeSourceSchemaTemplate', 'id', id) - const localVarPath = `/non-employee-sources/{id}/schema-attributes-template/download` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeApproval', 'id', id) - const localVarPath = `/non-employee-approvals/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeDetail !== undefined) { - localVarQueryParameter['include-detail'] = includeDetail; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeApprovalSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-approvals/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeBulkUploadStatus', 'id', id) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload/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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRecord', 'id', id) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getNonEmployeeRequest', 'id', id) - const localVarPath = `/non-employee-requests/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('getNonEmployeeRequestSummary', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests/summary/{requested-for}` - .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSchemaAttribute', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSource', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getNonEmployeeSourceSchemaAttributes', 'sourceId', sourceId) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'id', id) - // verify required parameter 'data' is not null or undefined - assertParamExists('importNonEmployeeRecordsInBulk', 'data', data) - const localVarPath = `/non-employee-sources/{id}/non-employee-bulk-upload` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - if (data !== undefined) { - localVarFormParams.append('data', data as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-approvals`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-records`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'requestedFor' is not null or undefined - assertParamExists('listNonEmployeeRequests', 'requestedFor', requestedFor) - const localVarPath = `/non-employee-requests`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - 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, - }; - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/non-employee-sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (requestedFor !== undefined) { - localVarQueryParameter['requested-for'] = requestedFor; - } - - if (nonEmployeeCount !== undefined) { - localVarQueryParameter['non-employee-count'] = nonEmployeeCount; - } - - 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, - }; - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperation A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchNonEmployeeRecord', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/non-employee-records/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute: async (attributeId: string, sourceId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'attributeId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'attributeId', attributeId) - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchNonEmployeeSchemaAttribute', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` - .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperation A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource: async (sourceId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'sourceId', sourceId) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchNonEmployeeSource', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/non-employee-sources/{sourceId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecision} nonEmployeeRejectApprovalDecision - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest: async (id: string, nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'id', id) - // verify required parameter 'nonEmployeeRejectApprovalDecision' is not null or undefined - assertParamExists('rejectNonEmployeeRequest', 'nonEmployeeRejectApprovalDecision', nonEmployeeRejectApprovalDecision) - const localVarPath = `/non-employee-approvals/{id}/reject` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecision, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord: async (id: string, nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'id', id) - // verify required parameter 'nonEmployeeRequestBody' is not null or undefined - assertParamExists('updateNonEmployeeRecord', 'nonEmployeeRequestBody', nonEmployeeRequestBody) - const localVarPath = `/non-employee-records/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * NonEmployeeLifecycleManagementApi - functional programming interface - * @export - */ -export const NonEmployeeLifecycleManagementApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NonEmployeeLifecycleManagementApiAxiosParamCreator(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeApprovalDecision} nonEmployeeApprovalDecision - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveNonEmployeeRequest(id: string, nonEmployeeApprovalDecision: NonEmployeeApprovalDecision, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequest(id, nonEmployeeApprovalDecision, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.approveNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee record creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRecord(nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecord(nonEmployeeRequestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee creation request body - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeRequest(nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequest(nonEmployeeRequestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeSourceRequestBody} nonEmployeeSourceRequestBody Non-Employee source creation request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSource(nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSource(nonEmployeeSourceRequestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {string} sourceId The Source id - * @param {NonEmployeeSchemaAttributeBody} nonEmployeeSchemaAttributeBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createNonEmployeeSourceSchemaAttributes(sourceId: string, nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributes(sourceId, nonEmployeeSchemaAttributeBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {DeleteNonEmployeeRecordsInBulkRequest} deleteNonEmployeeRecordsInBulkRequest Non-Employee bulk delete request body. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequest: DeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulk(deleteNonEmployeeRecordsInBulkRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {string} id Non-Employee request id in the UUID format - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeRecords(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecords(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.exportNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {string} id Source Id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async exportNonEmployeeSourceSchemaTemplate(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplate(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.exportNonEmployeeSourceSchemaTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {string} id Non-Employee approval item id (UUID) - * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApproval(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApproval(id, includeDetail, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeApproval']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeApprovalSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeApprovalSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {string} id Source ID (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeBulkUploadStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeBulkUploadStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {string} id Non-Employee record id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecord(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {string} id Non-Employee request id (UUID) - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequest(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequest(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeRequestSummary(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummary(requestedFor, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRequestSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttribute(attributeId, sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {string} sourceId Source Id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSource(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSource(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getNonEmployeeSourceSchemaAttributes(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributes(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSourceSchemaAttributes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {string} id Source Id (UUID) - * @param {File} data - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importNonEmployeeRecordsInBulk(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulk(id, data, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.importNonEmployeeRecordsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **approvalStatus**: *eq* - * @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: **created, modified** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeApprovals(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovals(requestedFor, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeApprovals']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRecords(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecords(limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeRecords']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @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: **sourceId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeRequests(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequests(requestedFor, limit, offset, count, sorters, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeRequests']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. - * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. - * @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: **name, created, sourceId** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listNonEmployeeSources(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSources(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {Array} jsonPatchOperation A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeRecord(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecord(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {string} attributeId The Schema Attribute Id (UUID) - * @param {string} sourceId The Source id - * @param {Array} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSchemaAttribute(attributeId: string, sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttribute(attributeId, sourceId, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeSchemaAttribute']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {string} sourceId Source Id - * @param {Array} jsonPatchOperation A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchNonEmployeeSource(sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSource(sourceId, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {string} id Non-Employee approval item id (UUID) - * @param {NonEmployeeRejectApprovalDecision} nonEmployeeRejectApprovalDecision - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectNonEmployeeRequest(id: string, nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequest(id, nonEmployeeRejectApprovalDecision, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.rejectNonEmployeeRequest']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {string} id Non-employee record id (UUID) - * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateNonEmployeeRecord(id: string, nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecord(id, nonEmployeeRequestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.updateNonEmployeeRecord']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * NonEmployeeLifecycleManagementApi - factory interface - * @export - */ -export const NonEmployeeLifecycleManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NonEmployeeLifecycleManagementApiFp(configuration) - return { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecision, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRecord(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeRequest(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecision, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveNonEmployeeRequest operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiApproveNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeApprovalDecision} - * @memberof NonEmployeeLifecycleManagementApiApproveNonEmployeeRequest - */ - readonly nonEmployeeApprovalDecision: NonEmployeeApprovalDecision -} - -/** - * Request parameters for createNonEmployeeRecord operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest { - /** - * Non-Employee record creation request body. - * @type {NonEmployeeRequestBody} - * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeRecord - */ - readonly nonEmployeeRequestBody: NonEmployeeRequestBody -} - -/** - * Request parameters for createNonEmployeeRequest operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest { - /** - * Non-Employee creation request body - * @type {NonEmployeeRequestBody} - * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeRequest - */ - readonly nonEmployeeRequestBody: NonEmployeeRequestBody -} - -/** - * Request parameters for createNonEmployeeSource operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest { - /** - * Non-Employee source creation request body. - * @type {NonEmployeeSourceRequestBody} - * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSource - */ - readonly nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody -} - -/** - * Request parameters for createNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string - - /** - * - * @type {NonEmployeeSchemaAttributeBody} - * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributes - */ - readonly nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody -} - -/** - * Request parameters for deleteNonEmployeeRecord operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest { - /** - * Non-Employee bulk delete request body. - * @type {DeleteNonEmployeeRecordsInBulkRequest} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulk - */ - readonly deleteNonEmployeeRecordsInBulkRequest: DeleteNonEmployeeRecordsInBulkRequest -} - -/** - * Request parameters for deleteNonEmployeeRequest operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest { - /** - * Non-Employee request id in the UUID format - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for deleteNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSource operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for deleteNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for exportNonEmployeeRecords operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiExportNonEmployeeRecords - */ - readonly id: string -} - -/** - * Request parameters for exportNonEmployeeSourceSchemaTemplate operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest - */ -export interface NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplate - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeApproval operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApproval - */ - readonly id: string - - /** - * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApproval - */ - readonly includeDetail?: boolean -} - -/** - * Request parameters for getNonEmployeeApprovalSummary operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest { - /** - * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeBulkUploadStatus operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest { - /** - * Source ID (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatus - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRecord operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest { - /** - * Non-Employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRecord - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequest operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest { - /** - * Non-Employee request id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRequest - */ - readonly id: string -} - -/** - * Request parameters for getNonEmployeeRequestSummary operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest { - /** - * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummary - */ - readonly requestedFor: string -} - -/** - * Request parameters for getNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttribute - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSource operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSource - */ - readonly sourceId: string -} - -/** - * Request parameters for getNonEmployeeSourceSchemaAttributes operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest - */ -export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest { - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributes - */ - readonly sourceId: string -} - -/** - * Request parameters for importNonEmployeeRecordsInBulk operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest - */ -export interface NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest { - /** - * Source Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulk - */ - readonly id: string - - /** - * - * @type {File} - * @memberof NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulk - */ - readonly data: File -} - -/** - * Request parameters for listNonEmployeeApprovals operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest - */ -export interface NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - readonly requestedFor?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - 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: **approvalStatus**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - 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: **created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovals - */ - readonly sorters?: string -} - -/** - * Request parameters for listNonEmployeeRecords operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest - */ -export interface NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest { - /** - * 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 NonEmployeeLifecycleManagementApiListNonEmployeeRecords - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecords - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecords - */ - readonly count?: boolean - - /** - * 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, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecords - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecords - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeRequests operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest - */ -export interface NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest { - /** - * The identity for whom the request was made. *me* indicates the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly requestedFor: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly count?: boolean - - /** - * 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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly sorters?: 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: **sourceId**: *eq* - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequests - */ - readonly filters?: string -} - -/** - * Request parameters for listNonEmployeeSources operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest - */ -export interface NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest { - /** - * 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 NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly count?: boolean - - /** - * Identity the request was made for. Use \'me\' to indicate the current user. - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly requestedFor?: string - - /** - * Flag that determines whether the API will return a non-employee count associated with the source. - * @type {boolean} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly nonEmployeeCount?: boolean - - /** - * 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: **name, created, sourceId** - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSources - */ - readonly sorters?: string -} - -/** - * Request parameters for patchNonEmployeeRecord operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeRecord - */ - readonly id: string - - /** - * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeRecord - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for patchNonEmployeeSchemaAttribute operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest - */ -export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest { - /** - * The Schema Attribute Id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttribute - */ - readonly attributeId: string - - /** - * The Source id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttribute - */ - readonly sourceId: string - - /** - * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttribute - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for patchNonEmployeeSource operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest - */ -export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest { - /** - * Source Id - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSource - */ - readonly sourceId: string - - /** - * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - * @type {Array} - * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSource - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for rejectNonEmployeeRequest operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest - */ -export interface NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest { - /** - * Non-Employee approval item id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiRejectNonEmployeeRequest - */ - readonly id: string - - /** - * - * @type {NonEmployeeRejectApprovalDecision} - * @memberof NonEmployeeLifecycleManagementApiRejectNonEmployeeRequest - */ - readonly nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision -} - -/** - * Request parameters for updateNonEmployeeRecord operation in NonEmployeeLifecycleManagementApi. - * @export - * @interface NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest - */ -export interface NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest { - /** - * Non-employee record id (UUID) - * @type {string} - * @memberof NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecord - */ - readonly id: string - - /** - * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - * @type {NonEmployeeRequestBody} - * @memberof NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecord - */ - readonly nonEmployeeRequestBody: NonEmployeeRequestBody -} - -/** - * NonEmployeeLifecycleManagementApi - object-oriented interface - * @export - * @class NonEmployeeLifecycleManagementApi - * @extends {BaseAPI} - */ -export class NonEmployeeLifecycleManagementApi extends BaseAPI { - /** - * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - * @summary Approve a non-employee request - * @param {NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public approveNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).approveNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeApprovalDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee record. Requires role context of `idn:nesr:create` - * @summary Create non-employee record - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public createNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeRecord(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - * @summary Create non-employee request - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public createNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeRequest(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a non-employee source. - * @summary Create non-employee source - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public createNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeSource(requestParameters.nonEmployeeSourceRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` - * @summary Create a new schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public createNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee record - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - * @summary Delete multiple non-employee records - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRecordsInBulk(requestParameters.deleteNonEmployeeRecordsInBulkRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` - * @summary Delete non-employee request - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - * @summary Delete non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - * @summary Delete all custom schema attributes for non-employee source - * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public deleteNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - * @summary Exports non-employee records to csv - * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public exportNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).exportNonEmployeeRecords(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - * @summary Exports source schema template - * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public exportNonEmployeeSourceSchemaTemplate(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplate(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. - * @summary Get a non-employee approval item detail - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeApproval(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeApproval(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - * @summary Get summary of non-employee approval requests - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeApprovalSummary(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeApprovalSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` - * @summary Obtain the status of bulk upload on the source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeBulkUploadStatus(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeBulkUploadStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee record. Requires role context of `idn:nesr:read` - * @summary Get a non-employee record - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRecord(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. - * @summary Get a non-employee request - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRequest(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - * @summary Get summary of non-employee requests - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeRequestSummary(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRequestSummary(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary Get schema attribute non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. - * @summary Get a non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSource(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - * @summary List schema attributes non-employee source - * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public getNonEmployeeSourceSchemaAttributes(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSourceSchemaAttributes(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - * @summary Imports, or updates, non-employee records - * @param {NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public importNonEmployeeRecordsInBulk(requestParameters: NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).importNonEmployeeRecordsInBulk(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. - * @summary Get list of non-employee approval requests - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public listNonEmployeeApprovals(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeApprovals(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - * @summary List non-employee records - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public listNonEmployeeRecords(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRecordsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeRecords(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - * @summary List non-employee requests - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public listNonEmployeeRequests(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRequestsRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeRequests(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - * @summary List non-employee sources - * @param {NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public listNonEmployeeSources(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Patch non-employee record - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public patchNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeRecord(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` - * @summary Patch a schema attribute for non-employee source - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public patchNonEmployeeSchemaAttribute(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeSchemaAttribute(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. - * @summary Patch a non-employee source - * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public patchNonEmployeeSource(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeSource(requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - * @summary Reject a non-employee request - * @param {NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public rejectNonEmployeeRequest(requestParameters: NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).rejectNonEmployeeRequest(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. - * @summary Update non-employee record - * @param {NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof NonEmployeeLifecycleManagementApi - */ - public updateNonEmployeeRecord(requestParameters: NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordRequest, axiosOptions?: RawAxiosRequestConfig) { - return NonEmployeeLifecycleManagementApiFp(this.configuration).updateNonEmployeeRecord(requestParameters.id, requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * OAuthClientsApi - axios parameter creator - * @export - */ -export const OAuthClientsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequest} createOAuthClientRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient: async (createOAuthClientRequest: CreateOAuthClientRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createOAuthClientRequest' is not null or undefined - assertParamExists('createOauthClient', 'createOAuthClientRequest', createOAuthClientRequest) - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createOAuthClientRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getOauthClient', 'id', id) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients: async (filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/oauth-clients`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchOauthClient', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchOauthClient', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/oauth-clients/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * OAuthClientsApi - functional programming interface - * @export - */ -export const OAuthClientsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OAuthClientsApiAxiosParamCreator(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {CreateOAuthClientRequest} createOAuthClientRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createOauthClient(createOAuthClientRequest: CreateOAuthClientRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOauthClient(createOAuthClientRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.createOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.deleteOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {string} id The OAuth client id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getOauthClient(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOauthClient(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.getOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listOauthClients(filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listOauthClients(filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.listOauthClients']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {string} id The OAuth client id - * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchOauthClient(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchOauthClient(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.patchOauthClient']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * OAuthClientsApi - factory interface - * @export - */ -export const OAuthClientsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OAuthClientsApiFp(configuration) - return { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createOauthClient(requestParameters: OAuthClientsApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createOauthClient(requestParameters.createOAuthClientRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteOauthClient(requestParameters: OAuthClientsApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getOauthClient(requestParameters: OAuthClientsApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getOauthClient(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listOauthClients(requestParameters: OAuthClientsApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchOauthClient(requestParameters: OAuthClientsApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createOauthClient operation in OAuthClientsApi. - * @export - * @interface OAuthClientsApiCreateOauthClientRequest - */ -export interface OAuthClientsApiCreateOauthClientRequest { - /** - * - * @type {CreateOAuthClientRequest} - * @memberof OAuthClientsApiCreateOauthClient - */ - readonly createOAuthClientRequest: CreateOAuthClientRequest -} - -/** - * Request parameters for deleteOauthClient operation in OAuthClientsApi. - * @export - * @interface OAuthClientsApiDeleteOauthClientRequest - */ -export interface OAuthClientsApiDeleteOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsApiDeleteOauthClient - */ - readonly id: string -} - -/** - * Request parameters for getOauthClient operation in OAuthClientsApi. - * @export - * @interface OAuthClientsApiGetOauthClientRequest - */ -export interface OAuthClientsApiGetOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsApiGetOauthClient - */ - readonly id: string -} - -/** - * Request parameters for listOauthClients operation in OAuthClientsApi. - * @export - * @interface OAuthClientsApiListOauthClientsRequest - */ -export interface OAuthClientsApiListOauthClientsRequest { - /** - * 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof OAuthClientsApiListOauthClients - */ - readonly filters?: string -} - -/** - * Request parameters for patchOauthClient operation in OAuthClientsApi. - * @export - * @interface OAuthClientsApiPatchOauthClientRequest - */ -export interface OAuthClientsApiPatchOauthClientRequest { - /** - * The OAuth client id - * @type {string} - * @memberof OAuthClientsApiPatchOauthClient - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - * @type {Array} - * @memberof OAuthClientsApiPatchOauthClient - */ - readonly jsonPatchOperation: Array -} - -/** - * OAuthClientsApi - object-oriented interface - * @export - * @class OAuthClientsApi - * @extends {BaseAPI} - */ -export class OAuthClientsApi extends BaseAPI { - /** - * This creates an OAuth client. - * @summary Create oauth client - * @param {OAuthClientsApiCreateOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsApi - */ - public createOauthClient(requestParameters: OAuthClientsApiCreateOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsApiFp(this.configuration).createOauthClient(requestParameters.createOAuthClientRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes an OAuth client. - * @summary Delete oauth client - * @param {OAuthClientsApiDeleteOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsApi - */ - public deleteOauthClient(requestParameters: OAuthClientsApiDeleteOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsApiFp(this.configuration).deleteOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets details of an OAuth client. - * @summary Get oauth client - * @param {OAuthClientsApiGetOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsApi - */ - public getOauthClient(requestParameters: OAuthClientsApiGetOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsApiFp(this.configuration).getOauthClient(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a list of OAuth clients. - * @summary List oauth clients - * @param {OAuthClientsApiListOauthClientsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsApi - */ - public listOauthClients(requestParameters: OAuthClientsApiListOauthClientsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsApiFp(this.configuration).listOauthClients(requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of an OAuth client. - * @summary Patch oauth client - * @param {OAuthClientsApiPatchOauthClientRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof OAuthClientsApi - */ - public patchOauthClient(requestParameters: OAuthClientsApiPatchOauthClientRequest, axiosOptions?: RawAxiosRequestConfig) { - return OAuthClientsApiFp(this.configuration).patchOauthClient(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordConfigurationApi - axios parameter creator - * @export - */ -export const PasswordConfigurationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfig} passwordOrgConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig: async (passwordOrgConfig: PasswordOrgConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfig' is not null or undefined - assertParamExists('createPasswordOrgConfig', 'passwordOrgConfig', passwordOrgConfig) - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-org-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfig} passwordOrgConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig: async (passwordOrgConfig: PasswordOrgConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordOrgConfig' is not null or undefined - assertParamExists('putPasswordOrgConfig', 'passwordOrgConfig', passwordOrgConfig) - const localVarPath = `/password-org-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordOrgConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordConfigurationApi - functional programming interface - * @export - */ -export const PasswordConfigurationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordConfigurationApiAxiosParamCreator(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordOrgConfig} passwordOrgConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordOrgConfig(passwordOrgConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationApi.createPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordOrgConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationApi.getPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordOrgConfig} passwordOrgConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordOrgConfig(passwordOrgConfig: PasswordOrgConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordOrgConfig(passwordOrgConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordConfigurationApi.putPasswordOrgConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordConfigurationApi - factory interface - * @export - */ -export const PasswordConfigurationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordConfigurationApiFp(configuration) - return { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordOrgConfig(requestParameters: PasswordConfigurationApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordOrgConfig(requestParameters.passwordOrgConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordOrgConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordOrgConfig(requestParameters: PasswordConfigurationApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordOrgConfig(requestParameters.passwordOrgConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordOrgConfig operation in PasswordConfigurationApi. - * @export - * @interface PasswordConfigurationApiCreatePasswordOrgConfigRequest - */ -export interface PasswordConfigurationApiCreatePasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfig} - * @memberof PasswordConfigurationApiCreatePasswordOrgConfig - */ - readonly passwordOrgConfig: PasswordOrgConfig -} - -/** - * Request parameters for putPasswordOrgConfig operation in PasswordConfigurationApi. - * @export - * @interface PasswordConfigurationApiPutPasswordOrgConfigRequest - */ -export interface PasswordConfigurationApiPutPasswordOrgConfigRequest { - /** - * - * @type {PasswordOrgConfig} - * @memberof PasswordConfigurationApiPutPasswordOrgConfig - */ - readonly passwordOrgConfig: PasswordOrgConfig -} - -/** - * PasswordConfigurationApi - object-oriented interface - * @export - * @class PasswordConfigurationApi - * @extends {BaseAPI} - */ -export class PasswordConfigurationApi extends BaseAPI { - /** - * This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to \"true\". Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Create password org config - * @param {PasswordConfigurationApiCreatePasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationApi - */ - public createPasswordOrgConfig(requestParameters: PasswordConfigurationApiCreatePasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationApiFp(this.configuration).createPasswordOrgConfig(requestParameters.passwordOrgConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:read\' - * @summary Get password org config - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationApi - */ - public getPasswordOrgConfig(axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationApiFp(this.configuration).getPasswordOrgConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to \"true\" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of \'idn:password-org-config:write\' - * @summary Update password org config - * @param {PasswordConfigurationApiPutPasswordOrgConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordConfigurationApi - */ - public putPasswordOrgConfig(requestParameters: PasswordConfigurationApiPutPasswordOrgConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordConfigurationApiFp(this.configuration).putPasswordOrgConfig(requestParameters.passwordOrgConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordDictionaryApi - axios parameter creator - * @export - */ -export const PasswordDictionaryApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary: async (file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-dictionary`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordDictionaryApi - functional programming interface - * @export - */ -export const PasswordDictionaryApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordDictionaryApiAxiosParamCreator(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordDictionary(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryApi.getPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPasswordDictionary(file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPasswordDictionary(file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordDictionaryApi.putPasswordDictionary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordDictionaryApi - factory interface - * @export - */ -export const PasswordDictionaryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordDictionaryApiFp(configuration) - return { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordDictionary(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPasswordDictionary(requestParameters: PasswordDictionaryApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for putPasswordDictionary operation in PasswordDictionaryApi. - * @export - * @interface PasswordDictionaryApiPutPasswordDictionaryRequest - */ -export interface PasswordDictionaryApiPutPasswordDictionaryRequest { - /** - * - * @type {File} - * @memberof PasswordDictionaryApiPutPasswordDictionary - */ - readonly file?: File -} - -/** - * PasswordDictionaryApi - object-oriented interface - * @export - * @class PasswordDictionaryApi - * @extends {BaseAPI} - */ -export class PasswordDictionaryApi extends BaseAPI { - /** - * This gets password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Get password dictionary - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryApi - */ - public getPasswordDictionary(axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryApiFp(this.configuration).getPasswordDictionary(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates password dictionary for the organization. The password dictionary file can contain lines that are: 1. comment lines - the first character is \'#\', can be 128 Unicode codepoints in length, and are ignored during processing 2. empty lines 3. locale line - the first line that starts with \"locale=\" is considered to be locale line, the rest are treated as normal content lines 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; maximum length of the line is 128 Unicode codepoints Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). Password dict file must contain UTF-8 characters only. # Sample password text file ``` # Password dictionary small test file locale=en_US # Password dictionary prohibited words qwerty abcd aaaaa password qazxsws ``` - * @summary Update password dictionary - * @param {PasswordDictionaryApiPutPasswordDictionaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordDictionaryApi - */ - public putPasswordDictionary(requestParameters: PasswordDictionaryApiPutPasswordDictionaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordDictionaryApiFp(this.configuration).putPasswordDictionary(requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordManagementApi - axios parameter creator - * @export - */ -export const PasswordManagementApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordChangeStatus', 'id', id) - const localVarPath = `/password-change-status/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTO} passwordInfoQueryDTO - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo: async (passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordInfoQueryDTO' is not null or undefined - assertParamExists('queryPasswordInfo', 'passwordInfoQueryDTO', passwordInfoQueryDTO) - const localVarPath = `/query-password-info`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordInfoQueryDTO, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequest} passwordChangeRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword: async (passwordChangeRequest: PasswordChangeRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordChangeRequest' is not null or undefined - assertParamExists('setPassword', 'passwordChangeRequest', passwordChangeRequest) - const localVarPath = `/set-password`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordChangeRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordManagementApi - functional programming interface - * @export - */ -export const PasswordManagementApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordManagementApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {string} id Password change request ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordChangeStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordChangeStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementApi.getPasswordChangeStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordInfoQueryDTO} passwordInfoQueryDTO - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async queryPasswordInfo(passwordInfoQueryDTO: PasswordInfoQueryDTO, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryPasswordInfo(passwordInfoQueryDTO, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementApi.queryPasswordInfo']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordChangeRequest} passwordChangeRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPassword(passwordChangeRequest: PasswordChangeRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPassword(passwordChangeRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordManagementApi.setPassword']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordManagementApi - factory interface - * @export - */ -export const PasswordManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordManagementApiFp(configuration) - return { - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordChangeStatus(requestParameters: PasswordManagementApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.queryPasswordInfo(requestParameters.passwordInfoQueryDTO, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPassword(requestParameters: PasswordManagementApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPassword(requestParameters.passwordChangeRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPasswordChangeStatus operation in PasswordManagementApi. - * @export - * @interface PasswordManagementApiGetPasswordChangeStatusRequest - */ -export interface PasswordManagementApiGetPasswordChangeStatusRequest { - /** - * Password change request ID - * @type {string} - * @memberof PasswordManagementApiGetPasswordChangeStatus - */ - readonly id: string -} - -/** - * Request parameters for queryPasswordInfo operation in PasswordManagementApi. - * @export - * @interface PasswordManagementApiQueryPasswordInfoRequest - */ -export interface PasswordManagementApiQueryPasswordInfoRequest { - /** - * - * @type {PasswordInfoQueryDTO} - * @memberof PasswordManagementApiQueryPasswordInfo - */ - readonly passwordInfoQueryDTO: PasswordInfoQueryDTO -} - -/** - * Request parameters for setPassword operation in PasswordManagementApi. - * @export - * @interface PasswordManagementApiSetPasswordRequest - */ -export interface PasswordManagementApiSetPasswordRequest { - /** - * - * @type {PasswordChangeRequest} - * @memberof PasswordManagementApiSetPassword - */ - readonly passwordChangeRequest: PasswordChangeRequest -} - -/** - * PasswordManagementApi - object-oriented interface - * @export - * @class PasswordManagementApi - * @extends {BaseAPI} - */ -export class PasswordManagementApi extends BaseAPI { - /** - * This API returns the status of a password change request. - * @summary Get password change request status - * @param {PasswordManagementApiGetPasswordChangeStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementApi - */ - public getPasswordChangeStatus(requestParameters: PasswordManagementApiGetPasswordChangeStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementApiFp(this.configuration).getPasswordChangeStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to query password related information. - * @summary Query password info - * @param {PasswordManagementApiQueryPasswordInfoRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementApi - */ - public queryPasswordInfo(requestParameters: PasswordManagementApiQueryPasswordInfoRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementApiFp(this.configuration).queryPasswordInfo(requestParameters.passwordInfoQueryDTO, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API is used to set a password for an identity. An identity can change their own password (as well as any of their accounts\' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or [\"authorization_code\" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). >**Note: If you want to set an identity\'s source account password, you must enable `PASSWORD` as one of the source\'s features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: ```bash echo -n \"myPassword\" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 ``` In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - * @summary Set identity\'s password - * @param {PasswordManagementApiSetPasswordRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordManagementApi - */ - public setPassword(requestParameters: PasswordManagementApiSetPasswordRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordManagementApiFp(this.configuration).setPassword(requestParameters.passwordChangeRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordPoliciesApi - axios parameter creator - * @export - */ -export const PasswordPoliciesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy: async (passwordPolicyV3Dto: PasswordPolicyV3Dto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordPolicyV3Dto' is not null or undefined - assertParamExists('createPasswordPolicy', 'passwordPolicyV3Dto', passwordPolicyV3Dto) - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3Dto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordPolicy', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordPolicyById', 'id', id) - const localVarPath = `/password-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy: async (id: string, passwordPolicyV3Dto: PasswordPolicyV3Dto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('setPasswordPolicy', 'id', id) - // verify required parameter 'passwordPolicyV3Dto' is not null or undefined - assertParamExists('setPasswordPolicy', 'passwordPolicyV3Dto', passwordPolicyV3Dto) - const localVarPath = `/password-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordPolicyV3Dto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordPoliciesApi - functional programming interface - * @export - */ -export const PasswordPoliciesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordPoliciesApiAxiosParamCreator(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordPolicy(passwordPolicyV3Dto: PasswordPolicyV3Dto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordPolicy(passwordPolicyV3Dto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.createPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {string} id The ID of password policy to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.deletePasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {string} id The ID of password policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordPolicyById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordPolicyById(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.getPasswordPolicyById']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPasswordPolicies(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPasswordPolicies(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.listPasswordPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {string} id The ID of password policy to update. - * @param {PasswordPolicyV3Dto} passwordPolicyV3Dto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setPasswordPolicy(id: string, passwordPolicyV3Dto: PasswordPolicyV3Dto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setPasswordPolicy(id, passwordPolicyV3Dto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordPoliciesApi.setPasswordPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordPoliciesApi - factory interface - * @export - */ -export const PasswordPoliciesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordPoliciesApiFp(configuration) - return { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordPolicy(requestParameters: PasswordPoliciesApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordPolicy(requestParameters.passwordPolicyV3Dto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordPolicy(requestParameters: PasswordPoliciesApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordPolicyById(requestParameters: PasswordPoliciesApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPasswordPolicies(requestParameters: PasswordPoliciesApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setPasswordPolicy(requestParameters: PasswordPoliciesApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3Dto, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordPolicy operation in PasswordPoliciesApi. - * @export - * @interface PasswordPoliciesApiCreatePasswordPolicyRequest - */ -export interface PasswordPoliciesApiCreatePasswordPolicyRequest { - /** - * - * @type {PasswordPolicyV3Dto} - * @memberof PasswordPoliciesApiCreatePasswordPolicy - */ - readonly passwordPolicyV3Dto: PasswordPolicyV3Dto -} - -/** - * Request parameters for deletePasswordPolicy operation in PasswordPoliciesApi. - * @export - * @interface PasswordPoliciesApiDeletePasswordPolicyRequest - */ -export interface PasswordPoliciesApiDeletePasswordPolicyRequest { - /** - * The ID of password policy to delete. - * @type {string} - * @memberof PasswordPoliciesApiDeletePasswordPolicy - */ - readonly id: string -} - -/** - * Request parameters for getPasswordPolicyById operation in PasswordPoliciesApi. - * @export - * @interface PasswordPoliciesApiGetPasswordPolicyByIdRequest - */ -export interface PasswordPoliciesApiGetPasswordPolicyByIdRequest { - /** - * The ID of password policy to retrieve. - * @type {string} - * @memberof PasswordPoliciesApiGetPasswordPolicyById - */ - readonly id: string -} - -/** - * Request parameters for listPasswordPolicies operation in PasswordPoliciesApi. - * @export - * @interface PasswordPoliciesApiListPasswordPoliciesRequest - */ -export interface PasswordPoliciesApiListPasswordPoliciesRequest { - /** - * 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 PasswordPoliciesApiListPasswordPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordPoliciesApiListPasswordPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordPoliciesApiListPasswordPolicies - */ - readonly count?: boolean -} - -/** - * Request parameters for setPasswordPolicy operation in PasswordPoliciesApi. - * @export - * @interface PasswordPoliciesApiSetPasswordPolicyRequest - */ -export interface PasswordPoliciesApiSetPasswordPolicyRequest { - /** - * The ID of password policy to update. - * @type {string} - * @memberof PasswordPoliciesApiSetPasswordPolicy - */ - readonly id: string - - /** - * - * @type {PasswordPolicyV3Dto} - * @memberof PasswordPoliciesApiSetPasswordPolicy - */ - readonly passwordPolicyV3Dto: PasswordPolicyV3Dto -} - -/** - * PasswordPoliciesApi - object-oriented interface - * @export - * @class PasswordPoliciesApi - * @extends {BaseAPI} - */ -export class PasswordPoliciesApi extends BaseAPI { - /** - * This API creates the specified password policy. - * @summary Create password policy - * @param {PasswordPoliciesApiCreatePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesApi - */ - public createPasswordPolicy(requestParameters: PasswordPoliciesApiCreatePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesApiFp(this.configuration).createPasswordPolicy(requestParameters.passwordPolicyV3Dto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password policy. - * @summary Delete password policy by id - * @param {PasswordPoliciesApiDeletePasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesApi - */ - public deletePasswordPolicy(requestParameters: PasswordPoliciesApiDeletePasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesApiFp(this.configuration).deletePasswordPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the password policy for the specified ID. - * @summary Get password policy by id - * @param {PasswordPoliciesApiGetPasswordPolicyByIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesApi - */ - public getPasswordPolicyById(requestParameters: PasswordPoliciesApiGetPasswordPolicyByIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesApiFp(this.configuration).getPasswordPolicyById(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all Password Policies. Requires role of ORG_ADMIN - * @summary List password policies - * @param {PasswordPoliciesApiListPasswordPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesApi - */ - public listPasswordPolicies(requestParameters: PasswordPoliciesApiListPasswordPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesApiFp(this.configuration).listPasswordPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password policy. - * @summary Update password policy by id - * @param {PasswordPoliciesApiSetPasswordPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordPoliciesApi - */ - public setPasswordPolicy(requestParameters: PasswordPoliciesApiSetPasswordPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordPoliciesApiFp(this.configuration).setPasswordPolicy(requestParameters.id, requestParameters.passwordPolicyV3Dto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PasswordSyncGroupsApi - axios parameter creator - * @export - */ -export const PasswordSyncGroupsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroup} passwordSyncGroup - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup: async (passwordSyncGroup: PasswordSyncGroup, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'passwordSyncGroup' is not null or undefined - assertParamExists('createPasswordSyncGroup', 'passwordSyncGroup', passwordSyncGroup) - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroup, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getPasswordSyncGroup', 'id', id) - const localVarPath = `/password-sync-groups/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/password-sync-groups`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroup} passwordSyncGroup - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup: async (id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'id', id) - // verify required parameter 'passwordSyncGroup' is not null or undefined - assertParamExists('updatePasswordSyncGroup', 'passwordSyncGroup', passwordSyncGroup) - const localVarPath = `/password-sync-groups/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(passwordSyncGroup, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PasswordSyncGroupsApi - functional programming interface - * @export - */ -export const PasswordSyncGroupsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PasswordSyncGroupsApiAxiosParamCreator(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroup} passwordSyncGroup - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPasswordSyncGroup(passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPasswordSyncGroup(passwordSyncGroup, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsApi.createPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {string} id The ID of password sync group to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsApi.deletePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {string} id The ID of password sync group to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroup(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroup(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsApi.getPasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPasswordSyncGroups(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPasswordSyncGroups(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsApi.getPasswordSyncGroups']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {string} id The ID of password sync group to update. - * @param {PasswordSyncGroup} passwordSyncGroup - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePasswordSyncGroup(id: string, passwordSyncGroup: PasswordSyncGroup, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasswordSyncGroup(id, passwordSyncGroup, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PasswordSyncGroupsApi.updatePasswordSyncGroup']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PasswordSyncGroupsApi - factory interface - * @export - */ -export const PasswordSyncGroupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PasswordSyncGroupsApiFp(configuration) - return { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPasswordSyncGroup(requestParameters.passwordSyncGroup, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPasswordSyncGroups(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroup, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPasswordSyncGroup operation in PasswordSyncGroupsApi. - * @export - * @interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsApiCreatePasswordSyncGroupRequest { - /** - * - * @type {PasswordSyncGroup} - * @memberof PasswordSyncGroupsApiCreatePasswordSyncGroup - */ - readonly passwordSyncGroup: PasswordSyncGroup -} - -/** - * Request parameters for deletePasswordSyncGroup operation in PasswordSyncGroupsApi. - * @export - * @interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsApiDeletePasswordSyncGroupRequest { - /** - * The ID of password sync group to delete. - * @type {string} - * @memberof PasswordSyncGroupsApiDeletePasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroup operation in PasswordSyncGroupsApi. - * @export - * @interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsApiGetPasswordSyncGroupRequest { - /** - * The ID of password sync group to retrieve. - * @type {string} - * @memberof PasswordSyncGroupsApiGetPasswordSyncGroup - */ - readonly id: string -} - -/** - * Request parameters for getPasswordSyncGroups operation in PasswordSyncGroupsApi. - * @export - * @interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest - */ -export interface PasswordSyncGroupsApiGetPasswordSyncGroupsRequest { - /** - * 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 PasswordSyncGroupsApiGetPasswordSyncGroups - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PasswordSyncGroupsApiGetPasswordSyncGroups - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PasswordSyncGroupsApiGetPasswordSyncGroups - */ - readonly count?: boolean -} - -/** - * Request parameters for updatePasswordSyncGroup operation in PasswordSyncGroupsApi. - * @export - * @interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest - */ -export interface PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest { - /** - * The ID of password sync group to update. - * @type {string} - * @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup - */ - readonly id: string - - /** - * - * @type {PasswordSyncGroup} - * @memberof PasswordSyncGroupsApiUpdatePasswordSyncGroup - */ - readonly passwordSyncGroup: PasswordSyncGroup -} - -/** - * PasswordSyncGroupsApi - object-oriented interface - * @export - * @class PasswordSyncGroupsApi - * @extends {BaseAPI} - */ -export class PasswordSyncGroupsApi extends BaseAPI { - /** - * This API creates a password sync group based on the specifications provided. - * @summary Create password sync group - * @param {PasswordSyncGroupsApiCreatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsApi - */ - public createPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiCreatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsApiFp(this.configuration).createPasswordSyncGroup(requestParameters.passwordSyncGroup, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the specified password sync group. - * @summary Delete password sync group by id - * @param {PasswordSyncGroupsApiDeletePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsApi - */ - public deletePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiDeletePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsApiFp(this.configuration).deletePasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the sync group for the specified ID. - * @summary Get password sync group by id - * @param {PasswordSyncGroupsApiGetPasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsApi - */ - public getPasswordSyncGroup(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsApiFp(this.configuration).getPasswordSyncGroup(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of password sync groups. - * @summary Get password sync group list - * @param {PasswordSyncGroupsApiGetPasswordSyncGroupsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsApi - */ - public getPasswordSyncGroups(requestParameters: PasswordSyncGroupsApiGetPasswordSyncGroupsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsApiFp(this.configuration).getPasswordSyncGroups(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API updates the specified password sync group. - * @summary Update password sync group by id - * @param {PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PasswordSyncGroupsApi - */ - public updatePasswordSyncGroup(requestParameters: PasswordSyncGroupsApiUpdatePasswordSyncGroupRequest, axiosOptions?: RawAxiosRequestConfig) { - return PasswordSyncGroupsApiFp(this.configuration).updatePasswordSyncGroup(requestParameters.id, requestParameters.passwordSyncGroup, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PersonalAccessTokensApi - axios parameter creator - * @export - */ -export const PersonalAccessTokensApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequest} createPersonalAccessTokenRequest Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken: async (createPersonalAccessTokenRequest: CreatePersonalAccessTokenRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createPersonalAccessTokenRequest' is not null or undefined - assertParamExists('createPersonalAccessToken', 'createPersonalAccessTokenRequest', createPersonalAccessTokenRequest) - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createPersonalAccessTokenRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deletePersonalAccessToken', 'id', id) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens: async (ownerId?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/personal-access-tokens`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['owner-id'] = ownerId; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchPersonalAccessToken', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/personal-access-tokens/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * PersonalAccessTokensApi - functional programming interface - * @export - */ -export const PersonalAccessTokensApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PersonalAccessTokensApiAxiosParamCreator(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {CreatePersonalAccessTokenRequest} createPersonalAccessTokenRequest Name and scope of personal access token. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createPersonalAccessToken(createPersonalAccessTokenRequest: CreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPersonalAccessToken(createPersonalAccessTokenRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensApi.createPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {string} id The personal access token id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deletePersonalAccessToken(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deletePersonalAccessToken(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensApi.deletePersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {string} [ownerId] The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @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: **lastUsed**: *le, isnull* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listPersonalAccessTokens(ownerId, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensApi.listPersonalAccessTokens']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {string} id The Personal Access Token id - * @param {Array} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchPersonalAccessToken(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchPersonalAccessToken(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PersonalAccessTokensApi.patchPersonalAccessToken']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PersonalAccessTokensApi - factory interface - * @export - */ -export const PersonalAccessTokensApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PersonalAccessTokensApiFp(configuration) - return { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createPersonalAccessToken(requestParameters: PersonalAccessTokensApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deletePersonalAccessToken(requestParameters: PersonalAccessTokensApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listPersonalAccessTokens(requestParameters: PersonalAccessTokensApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {PersonalAccessTokensApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchPersonalAccessToken(requestParameters: PersonalAccessTokensApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createPersonalAccessToken operation in PersonalAccessTokensApi. - * @export - * @interface PersonalAccessTokensApiCreatePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensApiCreatePersonalAccessTokenRequest { - /** - * Name and scope of personal access token. - * @type {CreatePersonalAccessTokenRequest} - * @memberof PersonalAccessTokensApiCreatePersonalAccessToken - */ - readonly createPersonalAccessTokenRequest: CreatePersonalAccessTokenRequest -} - -/** - * Request parameters for deletePersonalAccessToken operation in PersonalAccessTokensApi. - * @export - * @interface PersonalAccessTokensApiDeletePersonalAccessTokenRequest - */ -export interface PersonalAccessTokensApiDeletePersonalAccessTokenRequest { - /** - * The personal access token id - * @type {string} - * @memberof PersonalAccessTokensApiDeletePersonalAccessToken - */ - readonly id: string -} - -/** - * Request parameters for listPersonalAccessTokens operation in PersonalAccessTokensApi. - * @export - * @interface PersonalAccessTokensApiListPersonalAccessTokensRequest - */ -export interface PersonalAccessTokensApiListPersonalAccessTokensRequest { - /** - * The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' - * @type {string} - * @memberof PersonalAccessTokensApiListPersonalAccessTokens - */ - readonly ownerId?: 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: **lastUsed**: *le, isnull* - * @type {string} - * @memberof PersonalAccessTokensApiListPersonalAccessTokens - */ - readonly filters?: string -} - -/** - * Request parameters for patchPersonalAccessToken operation in PersonalAccessTokensApi. - * @export - * @interface PersonalAccessTokensApiPatchPersonalAccessTokenRequest - */ -export interface PersonalAccessTokensApiPatchPersonalAccessTokenRequest { - /** - * The Personal Access Token id - * @type {string} - * @memberof PersonalAccessTokensApiPatchPersonalAccessToken - */ - readonly id: string - - /** - * A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - * @type {Array} - * @memberof PersonalAccessTokensApiPatchPersonalAccessToken - */ - readonly jsonPatchOperation: Array -} - -/** - * PersonalAccessTokensApi - object-oriented interface - * @export - * @class PersonalAccessTokensApi - * @extends {BaseAPI} - */ -export class PersonalAccessTokensApi extends BaseAPI { - /** - * This creates a personal access token. - * @summary Create personal access token - * @param {PersonalAccessTokensApiCreatePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensApi - */ - public createPersonalAccessToken(requestParameters: PersonalAccessTokensApiCreatePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensApiFp(this.configuration).createPersonalAccessToken(requestParameters.createPersonalAccessTokenRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a personal access token. - * @summary Delete personal access token - * @param {PersonalAccessTokensApiDeletePersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensApi - */ - public deletePersonalAccessToken(requestParameters: PersonalAccessTokensApiDeletePersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensApiFp(this.configuration).deletePersonalAccessToken(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the \'idn:all-personal-access-tokens:read\' right. - * @summary List personal access tokens - * @param {PersonalAccessTokensApiListPersonalAccessTokensRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensApi - */ - public listPersonalAccessTokens(requestParameters: PersonalAccessTokensApiListPersonalAccessTokensRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensApiFp(this.configuration).listPersonalAccessTokens(requestParameters.ownerId, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - * @summary Patch personal access token - * @param {PersonalAccessTokensApiPatchPersonalAccessTokenRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PersonalAccessTokensApi - */ - public patchPersonalAccessToken(requestParameters: PersonalAccessTokensApiPatchPersonalAccessTokenRequest, axiosOptions?: RawAxiosRequestConfig) { - return PersonalAccessTokensApiFp(this.configuration).patchPersonalAccessToken(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesApi - axios parameter creator - * @export - */ -export const PublicIdentitiesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities: async (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:default"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (addCoreFilters !== undefined) { - localVarQueryParameter['add-core-filters'] = addCoreFilters; - } - - 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, - }; - }, - } -}; - -/** - * PublicIdentitiesApi - functional programming interface - * @export - */ -export const PublicIdentitiesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesApiAxiosParamCreator(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @param {boolean} [addCoreFilters] If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentities(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentities(limit, offset, count, filters, addCoreFilters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesApi.getPublicIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesApi - factory interface - * @export - */ -export const PublicIdentitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesApiFp(configuration) - return { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentities(requestParameters: PublicIdentitiesApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getPublicIdentities operation in PublicIdentitiesApi. - * @export - * @interface PublicIdentitiesApiGetPublicIdentitiesRequest - */ -export interface PublicIdentitiesApiGetPublicIdentitiesRequest { - /** - * 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 PublicIdentitiesApiGetPublicIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof PublicIdentitiesApiGetPublicIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof PublicIdentitiesApiGetPublicIdentities - */ - 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, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* - * @type {string} - * @memberof PublicIdentitiesApiGetPublicIdentities - */ - readonly filters?: string - - /** - * If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. - * @type {boolean} - * @memberof PublicIdentitiesApiGetPublicIdentities - */ - readonly addCoreFilters?: boolean - - /** - * 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: **name** - * @type {string} - * @memberof PublicIdentitiesApiGetPublicIdentities - */ - readonly sorters?: string -} - -/** - * PublicIdentitiesApi - object-oriented interface - * @export - * @class PublicIdentitiesApi - * @extends {BaseAPI} - */ -export class PublicIdentitiesApi extends BaseAPI { - /** - * Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - * @summary Get list of public identities - * @param {PublicIdentitiesApiGetPublicIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesApi - */ - public getPublicIdentities(requestParameters: PublicIdentitiesApiGetPublicIdentitiesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesApiFp(this.configuration).getPublicIdentities(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.addCoreFilters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * PublicIdentitiesConfigApi - axios parameter creator - * @export - */ -export const PublicIdentitiesConfigApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/public-identities-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfig} publicIdentityConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig: async (publicIdentityConfig: PublicIdentityConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'publicIdentityConfig' is not null or undefined - assertParamExists('updatePublicIdentityConfig', 'publicIdentityConfig', publicIdentityConfig) - const localVarPath = `/public-identities-config`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(publicIdentityConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * PublicIdentitiesConfigApi - functional programming interface - * @export - */ -export const PublicIdentitiesConfigApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PublicIdentitiesConfigApiAxiosParamCreator(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicIdentityConfig(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigApi.getPublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentityConfig} publicIdentityConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updatePublicIdentityConfig(publicIdentityConfig: PublicIdentityConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updatePublicIdentityConfig(publicIdentityConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['PublicIdentitiesConfigApi.updatePublicIdentityConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * PublicIdentitiesConfigApi - factory interface - * @export - */ -export const PublicIdentitiesConfigApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PublicIdentitiesConfigApiFp(configuration) - return { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getPublicIdentityConfig(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updatePublicIdentityConfig(requestParameters.publicIdentityConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for updatePublicIdentityConfig operation in PublicIdentitiesConfigApi. - * @export - * @interface PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest - */ -export interface PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest { - /** - * - * @type {PublicIdentityConfig} - * @memberof PublicIdentitiesConfigApiUpdatePublicIdentityConfig - */ - readonly publicIdentityConfig: PublicIdentityConfig -} - -/** - * PublicIdentitiesConfigApi - object-oriented interface - * @export - * @class PublicIdentitiesConfigApi - * @extends {BaseAPI} - */ -export class PublicIdentitiesConfigApi extends BaseAPI { - /** - * Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Get the public identities configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigApi - */ - public getPublicIdentityConfig(axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigApiFp(this.configuration).getPublicIdentityConfig(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - * @summary Update the public identities configuration - * @param {PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof PublicIdentitiesConfigApi - */ - public updatePublicIdentityConfig(requestParameters: PublicIdentitiesConfigApiUpdatePublicIdentityConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return PublicIdentitiesConfigApiFp(this.configuration).updatePublicIdentityConfig(requestParameters.publicIdentityConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ReportsDataExtractionApi - axios parameter creator - * @export - */ -export const ReportsDataExtractionApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelReport', 'id', id) - const localVarPath = `/reports/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV3} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport: async (taskResultId: string, fileFormat: GetReportFileFormatV3, name?: string, auditable?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReport', 'taskResultId', taskResultId) - // verify required parameter 'fileFormat' is not null or undefined - assertParamExists('getReport', 'fileFormat', fileFormat) - const localVarPath = `/reports/{taskResultId}` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (fileFormat !== undefined) { - localVarQueryParameter['fileFormat'] = fileFormat; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (auditable !== undefined) { - localVarQueryParameter['auditable'] = auditable; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult: async (taskResultId: string, completed?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taskResultId' is not null or undefined - assertParamExists('getReportResult', 'taskResultId', taskResultId) - const localVarPath = `/reports/{taskResultId}/result` - .replace(`{${"taskResultId"}}`, encodeURIComponent(String(taskResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (completed !== undefined) { - localVarQueryParameter['completed'] = completed; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetails} reportDetails - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport: async (reportDetails: ReportDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportDetails' is not null or undefined - assertParamExists('startReport', 'reportDetails', reportDetails) - const localVarPath = `/reports/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(reportDetails, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ReportsDataExtractionApi - functional programming interface - * @export - */ -export const ReportsDataExtractionApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ReportsDataExtractionApiAxiosParamCreator(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {string} id ID of the running Report to cancel - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelReport(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelReport(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionApi.cancelReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {GetReportFileFormatV3} fileFormat Output format of the requested report file - * @param {string} [name] preferred Report file name, by default will be used report name from task result. - * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReport(taskResultId: string, fileFormat: GetReportFileFormatV3, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(taskResultId, fileFormat, name, auditable, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionApi.getReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {string} taskResultId Unique identifier of the task result which handled report - * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getReportResult(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getReportResult(taskResultId, completed, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionApi.getReportResult']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportDetails} reportDetails - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startReport(reportDetails: ReportDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startReport(reportDetails, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ReportsDataExtractionApi.startReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ReportsDataExtractionApi - factory interface - * @export - */ -export const ReportsDataExtractionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ReportsDataExtractionApiFp(configuration) - return { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelReport(requestParameters: ReportsDataExtractionApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelReport(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReport(requestParameters: ReportsDataExtractionApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getReportResult(requestParameters: ReportsDataExtractionApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startReport(requestParameters: ReportsDataExtractionApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startReport(requestParameters.reportDetails, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelReport operation in ReportsDataExtractionApi. - * @export - * @interface ReportsDataExtractionApiCancelReportRequest - */ -export interface ReportsDataExtractionApiCancelReportRequest { - /** - * ID of the running Report to cancel - * @type {string} - * @memberof ReportsDataExtractionApiCancelReport - */ - readonly id: string -} - -/** - * Request parameters for getReport operation in ReportsDataExtractionApi. - * @export - * @interface ReportsDataExtractionApiGetReportRequest - */ -export interface ReportsDataExtractionApiGetReportRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionApiGetReport - */ - readonly taskResultId: string - - /** - * Output format of the requested report file - * @type {'csv' | 'pdf'} - * @memberof ReportsDataExtractionApiGetReport - */ - readonly fileFormat: GetReportFileFormatV3 - - /** - * preferred Report file name, by default will be used report name from task result. - * @type {string} - * @memberof ReportsDataExtractionApiGetReport - */ - readonly name?: string - - /** - * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. - * @type {boolean} - * @memberof ReportsDataExtractionApiGetReport - */ - readonly auditable?: boolean -} - -/** - * Request parameters for getReportResult operation in ReportsDataExtractionApi. - * @export - * @interface ReportsDataExtractionApiGetReportResultRequest - */ -export interface ReportsDataExtractionApiGetReportResultRequest { - /** - * Unique identifier of the task result which handled report - * @type {string} - * @memberof ReportsDataExtractionApiGetReportResult - */ - readonly taskResultId: string - - /** - * state of task result to apply ordering when results are fetching from the DB - * @type {boolean} - * @memberof ReportsDataExtractionApiGetReportResult - */ - readonly completed?: boolean -} - -/** - * Request parameters for startReport operation in ReportsDataExtractionApi. - * @export - * @interface ReportsDataExtractionApiStartReportRequest - */ -export interface ReportsDataExtractionApiStartReportRequest { - /** - * - * @type {ReportDetails} - * @memberof ReportsDataExtractionApiStartReport - */ - readonly reportDetails: ReportDetails -} - -/** - * ReportsDataExtractionApi - object-oriented interface - * @export - * @class ReportsDataExtractionApi - * @extends {BaseAPI} - */ -export class ReportsDataExtractionApi extends BaseAPI { - /** - * Cancels a running report. - * @summary Cancel report - * @param {ReportsDataExtractionApiCancelReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionApi - */ - public cancelReport(requestParameters: ReportsDataExtractionApiCancelReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionApiFp(this.configuration).cancelReport(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a report in file format. - * @summary Get report file - * @param {ReportsDataExtractionApiGetReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionApi - */ - public getReport(requestParameters: ReportsDataExtractionApiGetReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionApiFp(this.configuration).getReport(requestParameters.taskResultId, requestParameters.fileFormat, requestParameters.name, requestParameters.auditable, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. - * @summary Get report result - * @param {ReportsDataExtractionApiGetReportResultRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionApi - */ - public getReportResult(requestParameters: ReportsDataExtractionApiGetReportResultRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionApiFp(this.configuration).getReportResult(requestParameters.taskResultId, requestParameters.completed, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. - * @summary Run report - * @param {ReportsDataExtractionApiStartReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ReportsDataExtractionApi - */ - public startReport(requestParameters: ReportsDataExtractionApiStartReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return ReportsDataExtractionApiFp(this.configuration).startReport(requestParameters.reportDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetReportFileFormatV3 = { - Csv: 'csv', - Pdf: 'pdf' -} as const; -export type GetReportFileFormatV3 = typeof GetReportFileFormatV3[keyof typeof GetReportFileFormatV3]; - - -/** - * RequestableObjectsApi - axios parameter creator - * @export - */ -export const RequestableObjectsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects: async (identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/requestable-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (identityId !== undefined) { - localVarQueryParameter['identity-id'] = identityId; - } - - if (types) { - localVarQueryParameter['types'] = types.join(COLLECTION_FORMATS.csv); - } - - if (term !== undefined) { - localVarQueryParameter['term'] = term; - } - - if (statuses) { - localVarQueryParameter['statuses'] = statuses.join(COLLECTION_FORMATS.csv); - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * RequestableObjectsApi - functional programming interface - * @export - */ -export const RequestableObjectsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RequestableObjectsApiAxiosParamCreator(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {string} [identityId] If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @param {Array} [types] Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @param {string} [term] Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @param {Array} [statuses] Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in, sw* - * @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: **name** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRequestableObjects(identityId?: string, types?: Array, term?: string, statuses?: Array, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRequestableObjects(identityId, types, term, statuses, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RequestableObjectsApi.listRequestableObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RequestableObjectsApi - factory interface - * @export - */ -export const RequestableObjectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RequestableObjectsApiFp(configuration) - return { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRequestableObjects(requestParameters: RequestableObjectsApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for listRequestableObjects operation in RequestableObjectsApi. - * @export - * @interface RequestableObjectsApiListRequestableObjectsRequest - */ -export interface RequestableObjectsApiListRequestableObjectsRequest { - /** - * If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - * @type {string} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly identityId?: string - - /** - * Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. - * @type {Array<'ACCESS_PROFILE' | 'ROLE'>} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly types?: Array - - /** - * Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. - * @type {string} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly term?: string - - /** - * Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. - * @type {Array} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly statuses?: Array - - /** - * 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 RequestableObjectsApiListRequestableObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RequestableObjectsApiListRequestableObjects - */ - 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, in* **name**: *eq, in, sw* - * @type {string} - * @memberof RequestableObjectsApiListRequestableObjects - */ - 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: **name** - * @type {string} - * @memberof RequestableObjectsApiListRequestableObjects - */ - readonly sorters?: string -} - -/** - * RequestableObjectsApi - object-oriented interface - * @export - * @class RequestableObjectsApi - * @extends {BaseAPI} - */ -export class RequestableObjectsApi extends BaseAPI { - /** - * Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. Any authenticated token can call this endpoint to see their requestable access items. - * @summary Requestable objects list - * @param {RequestableObjectsApiListRequestableObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RequestableObjectsApi - */ - public listRequestableObjects(requestParameters: RequestableObjectsApiListRequestableObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RequestableObjectsApiFp(this.configuration).listRequestableObjects(requestParameters.identityId, requestParameters.types, requestParameters.term, requestParameters.statuses, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ListRequestableObjectsTypesV3 = { - AccessProfile: 'ACCESS_PROFILE', - Role: 'ROLE' -} as const; -export type ListRequestableObjectsTypesV3 = typeof ListRequestableObjectsTypesV3[keyof typeof ListRequestableObjectsTypesV3]; - - -/** - * RolesApi - axios parameter creator - * @export - */ -export const RolesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {Role} role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole: async (role: Role, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'role' is not null or undefined - assertParamExists('createRole', 'role', role) - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(role, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequest} roleBulkDeleteRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles: async (roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'roleBulkDeleteRequest' is not null or undefined - assertParamExists('deleteBulkRoles', 'roleBulkDeleteRequest', roleBulkDeleteRequest) - const localVarPath = `/roles/bulk-delete`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(roleBulkDeleteRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role - * @param {string} id Role ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. - * @summary Get role - * @param {string} id Role ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRole', 'id', id) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities: async (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRoleAssignedIdentities', 'id', id) - const localVarPath = `/roles/{id}/assigned-identities` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * This API returns a list of Roles. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles: async (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/roles`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSegmentIds !== undefined) { - localVarQueryParameter['for-segment-ids'] = forSegmentIds; - } - - if (includeUnsegmented !== undefined) { - localVarQueryParameter['include-unsegmented'] = includeUnsegmented; - } - - - - 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 role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch role - * @param {string} id Role ID to patch - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchRole', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchRole', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/roles/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * RolesApi - functional programming interface - * @export - */ -export const RolesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = RolesApiAxiosParamCreator(configuration) - return { - /** - * This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {Role} role - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createRole(role: Role, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createRole(role, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.createRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RoleBulkDeleteRequest} roleBulkDeleteRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteBulkRoles(roleBulkDeleteRequest: RoleBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBulkRoles(roleBulkDeleteRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.deleteBulkRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role - * @param {string} id Role ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.deleteRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. - * @summary Get role - * @param {string} id Role ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRole(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.getRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary List identities assigned a role - * @param {string} id ID of the Role for which the assigned Identities are to be listed - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @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, name, aliasName, email** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getRoleAssignedIdentities(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRoleAssignedIdentities(id, limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.getRoleAssignedIdentities']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of Roles. - * @summary List roles - * @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @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: **name, created, modified** - * @param {string} [forSegmentIds] If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(forSubadmin, limit, offset, count, filters, sorters, forSegmentIds, includeUnsegmented, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.listRoles']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch role - * @param {string} id Role ID to patch - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchRole(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchRole(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['RolesApi.patchRole']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * RolesApi - factory interface - * @export - */ -export const RolesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = RolesApiFp(configuration) - return { - /** - * This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createRole(requestParameters: RolesApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createRole(requestParameters.role, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteBulkRoles(requestParameters: RolesApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBulkRoles(requestParameters.roleBulkDeleteRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role - * @param {RolesApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteRole(requestParameters: RolesApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. - * @summary Get role - * @param {RolesApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRole(requestParameters: RolesApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getRole(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List identities assigned a role - * @param {RolesApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getRoleAssignedIdentities(requestParameters: RolesApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of Roles. - * @summary List roles - * @param {RolesApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listRoles(requestParameters: RolesApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch role - * @param {RolesApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchRole(requestParameters: RolesApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchRole(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createRole operation in RolesApi. - * @export - * @interface RolesApiCreateRoleRequest - */ -export interface RolesApiCreateRoleRequest { - /** - * - * @type {Role} - * @memberof RolesApiCreateRole - */ - readonly role: Role -} - -/** - * Request parameters for deleteBulkRoles operation in RolesApi. - * @export - * @interface RolesApiDeleteBulkRolesRequest - */ -export interface RolesApiDeleteBulkRolesRequest { - /** - * - * @type {RoleBulkDeleteRequest} - * @memberof RolesApiDeleteBulkRoles - */ - readonly roleBulkDeleteRequest: RoleBulkDeleteRequest -} - -/** - * Request parameters for deleteRole operation in RolesApi. - * @export - * @interface RolesApiDeleteRoleRequest - */ -export interface RolesApiDeleteRoleRequest { - /** - * Role ID. - * @type {string} - * @memberof RolesApiDeleteRole - */ - readonly id: string -} - -/** - * Request parameters for getRole operation in RolesApi. - * @export - * @interface RolesApiGetRoleRequest - */ -export interface RolesApiGetRoleRequest { - /** - * Role ID. - * @type {string} - * @memberof RolesApiGetRole - */ - readonly id: string -} - -/** - * Request parameters for getRoleAssignedIdentities operation in RolesApi. - * @export - * @interface RolesApiGetRoleAssignedIdentitiesRequest - */ -export interface RolesApiGetRoleAssignedIdentitiesRequest { - /** - * ID of the Role for which the assigned Identities are to be listed - * @type {string} - * @memberof RolesApiGetRoleAssignedIdentities - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesApiGetRoleAssignedIdentities - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesApiGetRoleAssignedIdentities - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesApiGetRoleAssignedIdentities - */ - 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, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - * @type {string} - * @memberof RolesApiGetRoleAssignedIdentities - */ - 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, name, aliasName, email** - * @type {string} - * @memberof RolesApiGetRoleAssignedIdentities - */ - readonly sorters?: string -} - -/** - * Request parameters for listRoles operation in RolesApi. - * @export - * @interface RolesApiListRolesRequest - */ -export interface RolesApiListRolesRequest { - /** - * If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - * @type {string} - * @memberof RolesApiListRoles - */ - readonly forSubadmin?: string - - /** - * Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesApiListRoles - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof RolesApiListRoles - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof RolesApiListRoles - */ - 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, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* - * @type {string} - * @memberof RolesApiListRoles - */ - 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: **name, created, modified** - * @type {string} - * @memberof RolesApiListRoles - */ - readonly sorters?: string - - /** - * If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - * @type {string} - * @memberof RolesApiListRoles - */ - readonly forSegmentIds?: string - - /** - * Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - * @type {boolean} - * @memberof RolesApiListRoles - */ - readonly includeUnsegmented?: boolean -} - -/** - * Request parameters for patchRole operation in RolesApi. - * @export - * @interface RolesApiPatchRoleRequest - */ -export interface RolesApiPatchRoleRequest { - /** - * Role ID to patch - * @type {string} - * @memberof RolesApiPatchRole - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof RolesApiPatchRole - */ - readonly jsonPatchOperation: Array -} - -/** - * RolesApi - object-oriented interface - * @export - * @class RolesApi - * @extends {BaseAPI} - */ -export class RolesApi extends BaseAPI { - /** - * This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - * @summary Create a role - * @param {RolesApiCreateRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public createRole(requestParameters: RolesApiCreateRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).createRole(requestParameters.role, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role(s) - * @param {RolesApiDeleteBulkRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public deleteBulkRoles(requestParameters: RolesApiDeleteBulkRolesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).deleteBulkRoles(requestParameters.roleBulkDeleteRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. - * @summary Delete role - * @param {RolesApiDeleteRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public deleteRole(requestParameters: RolesApiDeleteRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).deleteRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a role by ID. A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. - * @summary Get role - * @param {RolesApiGetRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public getRole(requestParameters: RolesApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).getRole(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List identities assigned a role - * @param {RolesApiGetRoleAssignedIdentitiesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public getRoleAssignedIdentities(requestParameters: RolesApiGetRoleAssignedIdentitiesRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).getRoleAssignedIdentities(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of Roles. - * @summary List roles - * @param {RolesApiListRolesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public listRoles(requestParameters: RolesApiListRolesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).listRoles(requestParameters.forSubadmin, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time. - * @summary Patch role - * @param {RolesApiPatchRoleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof RolesApi - */ - public patchRole(requestParameters: RolesApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig) { - return RolesApiFp(this.configuration).patchRole(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODPoliciesApi - axios parameter creator - * @export - */ -export const SODPoliciesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyRequest} sodPolicyRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy: async (sodPolicyRequest: SodPolicyRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sodPolicyRequest' is not null or undefined - assertParamExists('createSodPolicy', 'sodPolicyRequest', sodPolicyRequest) - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy: async (id: string, logical?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (logical !== undefined) { - localVarQueryParameter['logical'] = logical; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport: async (reportResultId: string, fileName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getCustomViolationReport', 'reportResultId', reportResultId) - // verify required parameter 'fileName' is not null or undefined - assertParamExists('getCustomViolationReport', 'fileName', fileName) - const localVarPath = `/sod-violation-report/{reportResultId}/download/{fileName}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))) - .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getDefaultViolationReport', 'reportResultId', reportResultId) - const localVarPath = `/sod-violation-report/{reportResultId}/download` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodPolicySchedule', 'id', id) - const localVarPath = `/sod-policies/{id}/schedule` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus: async (reportResultId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'reportResultId' is not null or undefined - assertParamExists('getSodViolationReportRunStatus', 'reportResultId', reportResultId) - const localVarPath = `/sod-policies/sod-violation-report-status/{reportResultId}` - .replace(`{${"reportResultId"}}`, encodeURIComponent(String(reportResultId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSodViolationReportStatus', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-policies`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperation A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSodPolicy', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchSodPolicy', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/sod-policies/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicySchedule} sodPolicySchedule - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule: async (id: string, sodPolicySchedule: SodPolicySchedule, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putPolicySchedule', 'id', id) - // verify required parameter 'sodPolicySchedule' is not null or undefined - assertParamExists('putPolicySchedule', 'sodPolicySchedule', sodPolicySchedule) - const localVarPath = `/sod-policies/{id}/schedule` - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicySchedule, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyRead} sodPolicyRead - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy: async (id: string, sodPolicyRead: SodPolicyRead, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSodPolicy', 'id', id) - // verify required parameter 'sodPolicyRead' is not null or undefined - assertParamExists('putSodPolicy', 'sodPolicyRead', sodPolicyRead) - const localVarPath = `/sod-policies/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sodPolicyRead, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startEvaluateSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/evaluate` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequest} [multiPolicyRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg: async (multiPolicyRequest?: MultiPolicyRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sod-violation-report/run`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(multiPolicyRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('startSodPolicy', 'id', id) - const localVarPath = `/sod-policies/{id}/violation-report/run` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODPoliciesApi - functional programming interface - * @export - */ -export const SODPoliciesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODPoliciesApiAxiosParamCreator(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SodPolicyRequest} sodPolicyRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSodPolicy(sodPolicyRequest: SodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSodPolicy(sodPolicyRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.createSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {string} id The ID of the SOD Policy to delete. - * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicy(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicy(id, logical, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.deleteSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {string} id The ID of the SOD policy the schedule must be deleted for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.deleteSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {string} fileName Custom Name for the file. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCustomViolationReport(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomViolationReport(reportResultId, fileName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getCustomViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {string} reportResultId The ID of the report reference to download. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getDefaultViolationReport(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDefaultViolationReport(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getDefaultViolationReport']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodAllReportRunStatus(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodAllReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {string} id The ID of the SOD Policy to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {string} id The ID of the SOD policy schedule to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodPolicySchedule(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodPolicySchedule(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {string} reportResultId The ID of the report reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportRunStatus(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportRunStatus(reportResultId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodViolationReportRunStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {string} id The ID of the violation report to retrieve status for. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSodViolationReportStatus(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSodViolationReportStatus(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.getSodViolationReportStatus']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in* **name**: *eq, in* **state**: *eq, in* - * @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, name, created, modified, description** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSodPolicies(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSodPolicies(limit, offset, count, filters, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.listSodPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {string} id The ID of the SOD policy being modified. - * @param {Array} jsonPatchOperation A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSodPolicy(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSodPolicy(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.patchSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {string} id The ID of the SOD policy to update its schedule. - * @param {SodPolicySchedule} sodPolicySchedule - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putPolicySchedule(id: string, sodPolicySchedule: SodPolicySchedule, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putPolicySchedule(id, sodPolicySchedule, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.putPolicySchedule']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {string} id The ID of the SOD policy to update. - * @param {SodPolicyRead} sodPolicyRead - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSodPolicy(id: string, sodPolicyRead: SodPolicyRead, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSodPolicy(id, sodPolicyRead, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.putSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startEvaluateSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startEvaluateSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.startEvaluateSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {MultiPolicyRequest} [multiPolicyRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodAllPoliciesForOrg(multiPolicyRequest?: MultiPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodAllPoliciesForOrg(multiPolicyRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.startSodAllPoliciesForOrg']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {string} id The SOD policy ID to run. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startSodPolicy(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startSodPolicy(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODPoliciesApi.startSodPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODPoliciesApi - factory interface - * @export - */ -export const SODPoliciesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODPoliciesApiFp(configuration) - return { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicy(requestParameters: SODPoliciesApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSodPolicySchedule(requestParameters: SODPoliciesApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCustomViolationReport(requestParameters: SODPoliciesApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getDefaultViolationReport(requestParameters: SODPoliciesApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodAllReportRunStatus(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodPolicySchedule(requestParameters: SODPoliciesApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportRunStatus(requestParameters: SODPoliciesApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSodViolationReportStatus(requestParameters: SODPoliciesApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putPolicySchedule(requestParameters: SODPoliciesApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putPolicySchedule(requestParameters.id, requestParameters.sodPolicySchedule, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startEvaluateSodPolicy(requestParameters: SODPoliciesApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodAllPoliciesForOrg(requestParameters: SODPoliciesApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodAllPoliciesForOrg(requestParameters.multiPolicyRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startSodPolicy(requestParameters: SODPoliciesApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiCreateSodPolicyRequest - */ -export interface SODPoliciesApiCreateSodPolicyRequest { - /** - * - * @type {SodPolicyRequest} - * @memberof SODPoliciesApiCreateSodPolicy - */ - readonly sodPolicyRequest: SodPolicyRequest -} - -/** - * Request parameters for deleteSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiDeleteSodPolicyRequest - */ -export interface SODPoliciesApiDeleteSodPolicyRequest { - /** - * The ID of the SOD Policy to delete. - * @type {string} - * @memberof SODPoliciesApiDeleteSodPolicy - */ - readonly id: string - - /** - * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. - * @type {boolean} - * @memberof SODPoliciesApiDeleteSodPolicy - */ - readonly logical?: boolean -} - -/** - * Request parameters for deleteSodPolicySchedule operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiDeleteSodPolicyScheduleRequest - */ -export interface SODPoliciesApiDeleteSodPolicyScheduleRequest { - /** - * The ID of the SOD policy the schedule must be deleted for. - * @type {string} - * @memberof SODPoliciesApiDeleteSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getCustomViolationReport operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetCustomViolationReportRequest - */ -export interface SODPoliciesApiGetCustomViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesApiGetCustomViolationReport - */ - readonly reportResultId: string - - /** - * Custom Name for the file. - * @type {string} - * @memberof SODPoliciesApiGetCustomViolationReport - */ - readonly fileName: string -} - -/** - * Request parameters for getDefaultViolationReport operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetDefaultViolationReportRequest - */ -export interface SODPoliciesApiGetDefaultViolationReportRequest { - /** - * The ID of the report reference to download. - * @type {string} - * @memberof SODPoliciesApiGetDefaultViolationReport - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetSodPolicyRequest - */ -export interface SODPoliciesApiGetSodPolicyRequest { - /** - * The ID of the SOD Policy to retrieve. - * @type {string} - * @memberof SODPoliciesApiGetSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for getSodPolicySchedule operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetSodPolicyScheduleRequest - */ -export interface SODPoliciesApiGetSodPolicyScheduleRequest { - /** - * The ID of the SOD policy schedule to retrieve. - * @type {string} - * @memberof SODPoliciesApiGetSodPolicySchedule - */ - readonly id: string -} - -/** - * Request parameters for getSodViolationReportRunStatus operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetSodViolationReportRunStatusRequest - */ -export interface SODPoliciesApiGetSodViolationReportRunStatusRequest { - /** - * The ID of the report reference to retrieve. - * @type {string} - * @memberof SODPoliciesApiGetSodViolationReportRunStatus - */ - readonly reportResultId: string -} - -/** - * Request parameters for getSodViolationReportStatus operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiGetSodViolationReportStatusRequest - */ -export interface SODPoliciesApiGetSodViolationReportStatusRequest { - /** - * The ID of the violation report to retrieve status for. - * @type {string} - * @memberof SODPoliciesApiGetSodViolationReportStatus - */ - readonly id: string -} - -/** - * Request parameters for listSodPolicies operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiListSodPoliciesRequest - */ -export interface SODPoliciesApiListSodPoliciesRequest { - /** - * 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 SODPoliciesApiListSodPolicies - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SODPoliciesApiListSodPolicies - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SODPoliciesApiListSodPolicies - */ - 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, in* **name**: *eq, in* **state**: *eq, in* - * @type {string} - * @memberof SODPoliciesApiListSodPolicies - */ - 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, name, created, modified, description** - * @type {string} - * @memberof SODPoliciesApiListSodPolicies - */ - readonly sorters?: string -} - -/** - * Request parameters for patchSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiPatchSodPolicyRequest - */ -export interface SODPoliciesApiPatchSodPolicyRequest { - /** - * The ID of the SOD policy being modified. - * @type {string} - * @memberof SODPoliciesApiPatchSodPolicy - */ - readonly id: string - - /** - * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - * @type {Array} - * @memberof SODPoliciesApiPatchSodPolicy - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for putPolicySchedule operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiPutPolicyScheduleRequest - */ -export interface SODPoliciesApiPutPolicyScheduleRequest { - /** - * The ID of the SOD policy to update its schedule. - * @type {string} - * @memberof SODPoliciesApiPutPolicySchedule - */ - readonly id: string - - /** - * - * @type {SodPolicySchedule} - * @memberof SODPoliciesApiPutPolicySchedule - */ - readonly sodPolicySchedule: SodPolicySchedule -} - -/** - * Request parameters for putSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiPutSodPolicyRequest - */ -export interface SODPoliciesApiPutSodPolicyRequest { - /** - * The ID of the SOD policy to update. - * @type {string} - * @memberof SODPoliciesApiPutSodPolicy - */ - readonly id: string - - /** - * - * @type {SodPolicyRead} - * @memberof SODPoliciesApiPutSodPolicy - */ - readonly sodPolicyRead: SodPolicyRead -} - -/** - * Request parameters for startEvaluateSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiStartEvaluateSodPolicyRequest - */ -export interface SODPoliciesApiStartEvaluateSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesApiStartEvaluateSodPolicy - */ - readonly id: string -} - -/** - * Request parameters for startSodAllPoliciesForOrg operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiStartSodAllPoliciesForOrgRequest - */ -export interface SODPoliciesApiStartSodAllPoliciesForOrgRequest { - /** - * - * @type {MultiPolicyRequest} - * @memberof SODPoliciesApiStartSodAllPoliciesForOrg - */ - readonly multiPolicyRequest?: MultiPolicyRequest -} - -/** - * Request parameters for startSodPolicy operation in SODPoliciesApi. - * @export - * @interface SODPoliciesApiStartSodPolicyRequest - */ -export interface SODPoliciesApiStartSodPolicyRequest { - /** - * The SOD policy ID to run. - * @type {string} - * @memberof SODPoliciesApiStartSodPolicy - */ - readonly id: string -} - -/** - * SODPoliciesApi - object-oriented interface - * @export - * @class SODPoliciesApi - * @extends {BaseAPI} - */ -export class SODPoliciesApi extends BaseAPI { - /** - * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. - * @summary Create sod policy - * @param {SODPoliciesApiCreateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public createSodPolicy(requestParameters: SODPoliciesApiCreateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).createSodPolicy(requestParameters.sodPolicyRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Delete sod policy by id - * @param {SODPoliciesApiDeleteSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public deleteSodPolicy(requestParameters: SODPoliciesApiDeleteSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).deleteSodPolicy(requestParameters.id, requestParameters.logical, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This deletes schedule for a specified SOD policy by ID. - * @summary Delete sod policy schedule - * @param {SODPoliciesApiDeleteSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public deleteSodPolicySchedule(requestParameters: SODPoliciesApiDeleteSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).deleteSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a specified named violation report for a given report reference. - * @summary Download custom violation report - * @param {SODPoliciesApiGetCustomViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getCustomViolationReport(requestParameters: SODPoliciesApiGetCustomViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getCustomViolationReport(requestParameters.reportResultId, requestParameters.fileName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This allows to download a violation report for a given report reference. - * @summary Download violation report - * @param {SODPoliciesApiGetDefaultViolationReportRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getDefaultViolationReport(requestParameters: SODPoliciesApiGetDefaultViolationReportRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getDefaultViolationReport(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets the status for a violation report for all policy run. - * @summary Get multi-report run task status - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getSodAllReportRunStatus(axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getSodAllReportRunStatus(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets specified SOD policy. Requires role of ORG_ADMIN. - * @summary Get sod policy by id - * @param {SODPoliciesApiGetSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getSodPolicy(requestParameters: SODPoliciesApiGetSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint gets a specified SOD policy\'s schedule. - * @summary Get sod policy schedule - * @param {SODPoliciesApiGetSodPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getSodPolicySchedule(requestParameters: SODPoliciesApiGetSodPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getSodPolicySchedule(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get violation report run status - * @param {SODPoliciesApiGetSodViolationReportRunStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getSodViolationReportRunStatus(requestParameters: SODPoliciesApiGetSodViolationReportRunStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getSodViolationReportRunStatus(requestParameters.reportResultId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the status for a violation report run task that has already been invoked. - * @summary Get sod violation report status - * @param {SODPoliciesApiGetSodViolationReportStatusRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public getSodViolationReportStatus(requestParameters: SODPoliciesApiGetSodViolationReportStatusRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).getSodViolationReportStatus(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets list of all SOD policies. Requires role of ORG_ADMIN - * @summary List sod policies - * @param {SODPoliciesApiListSodPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public listSodPolicies(requestParameters: SODPoliciesApiListSodPoliciesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).listSodPolicies(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - * @summary Patch sod policy by id - * @param {SODPoliciesApiPatchSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public patchSodPolicy(requestParameters: SODPoliciesApiPatchSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).patchSodPolicy(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates schedule for a specified SOD policy. - * @summary Update sod policy schedule - * @param {SODPoliciesApiPutPolicyScheduleRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public putPolicySchedule(requestParameters: SODPoliciesApiPutPolicyScheduleRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).putPolicySchedule(requestParameters.id, requestParameters.sodPolicySchedule, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a specified SOD policy. Requires role of ORG_ADMIN. - * @summary Update sod policy by id - * @param {SODPoliciesApiPutSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public putSodPolicy(requestParameters: SODPoliciesApiPutSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).putSodPolicy(requestParameters.id, requestParameters.sodPolicyRead, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. - * @summary Evaluate one policy by id - * @param {SODPoliciesApiStartEvaluateSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public startEvaluateSodPolicy(requestParameters: SODPoliciesApiStartEvaluateSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).startEvaluateSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. - * @summary Runs all policies for org - * @param {SODPoliciesApiStartSodAllPoliciesForOrgRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public startSodAllPoliciesForOrg(requestParameters: SODPoliciesApiStartSodAllPoliciesForOrgRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).startSodAllPoliciesForOrg(requestParameters.multiPolicyRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. - * @summary Runs sod policy violation report - * @param {SODPoliciesApiStartSodPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODPoliciesApi - */ - public startSodPolicy(requestParameters: SODPoliciesApiStartSodPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODPoliciesApiFp(this.configuration).startSodPolicy(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SODViolationsApi - axios parameter creator - * @export - */ -export const SODViolationsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccess} identityWithNewAccess - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations: async (identityWithNewAccess: IdentityWithNewAccess, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccess' is not null or undefined - assertParamExists('startPredictSodViolations', 'identityWithNewAccess', identityWithNewAccess) - const localVarPath = `/sod-violations/predict`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccess, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccess} identityWithNewAccess - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck: async (identityWithNewAccess: IdentityWithNewAccess, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identityWithNewAccess' is not null or undefined - assertParamExists('startViolationCheck', 'identityWithNewAccess', identityWithNewAccess) - const localVarPath = `/sod-violations/check`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(identityWithNewAccess, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SODViolationsApi - functional programming interface - * @export - */ -export const SODViolationsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SODViolationsApiAxiosParamCreator(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {IdentityWithNewAccess} identityWithNewAccess - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startPredictSodViolations(identityWithNewAccess: IdentityWithNewAccess, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startPredictSodViolations(identityWithNewAccess, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsApi.startPredictSodViolations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {IdentityWithNewAccess} identityWithNewAccess - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async startViolationCheck(identityWithNewAccess: IdentityWithNewAccess, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.startViolationCheck(identityWithNewAccess, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SODViolationsApi.startViolationCheck']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SODViolationsApi - factory interface - * @export - */ -export const SODViolationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SODViolationsApiFp(configuration) - return { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startPredictSodViolations(requestParameters: SODViolationsApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startPredictSodViolations(requestParameters.identityWithNewAccess, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - startViolationCheck(requestParameters: SODViolationsApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.startViolationCheck(requestParameters.identityWithNewAccess, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for startPredictSodViolations operation in SODViolationsApi. - * @export - * @interface SODViolationsApiStartPredictSodViolationsRequest - */ -export interface SODViolationsApiStartPredictSodViolationsRequest { - /** - * - * @type {IdentityWithNewAccess} - * @memberof SODViolationsApiStartPredictSodViolations - */ - readonly identityWithNewAccess: IdentityWithNewAccess -} - -/** - * Request parameters for startViolationCheck operation in SODViolationsApi. - * @export - * @interface SODViolationsApiStartViolationCheckRequest - */ -export interface SODViolationsApiStartViolationCheckRequest { - /** - * - * @type {IdentityWithNewAccess} - * @memberof SODViolationsApiStartViolationCheck - */ - readonly identityWithNewAccess: IdentityWithNewAccess -} - -/** - * SODViolationsApi - object-oriented interface - * @export - * @class SODViolationsApi - * @extends {BaseAPI} - */ -export class SODViolationsApi extends BaseAPI { - /** - * This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - * @summary Predict sod violations for identity. - * @param {SODViolationsApiStartPredictSodViolationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsApi - */ - public startPredictSodViolations(requestParameters: SODViolationsApiStartPredictSodViolationsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsApiFp(this.configuration).startPredictSodViolations(requestParameters.identityWithNewAccess, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API initiates a SOD policy verification asynchronously. - * @summary Check sod violations - * @param {SODViolationsApiStartViolationCheckRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SODViolationsApi - */ - public startViolationCheck(requestParameters: SODViolationsApiStartViolationCheckRequest, axiosOptions?: RawAxiosRequestConfig) { - return SODViolationsApiFp(this.configuration).startViolationCheck(requestParameters.identityWithNewAccess, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SavedSearchApi - axios parameter creator - * @export - */ -export const SavedSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequest} createSavedSearchRequest The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch: async (createSavedSearchRequest: CreateSavedSearchRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createSavedSearchRequest' is not null or undefined - assertParamExists('createSavedSearch', 'createSavedSearchRequest', createSavedSearchRequest) - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createSavedSearchRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArguments} searchArguments When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch: async (id: string, searchArguments: SearchArguments, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('executeSavedSearch', 'id', id) - // verify required parameter 'searchArguments' is not null or undefined - assertParamExists('executeSavedSearch', 'searchArguments', searchArguments) - const localVarPath = `/saved-searches/{id}/execute` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchArguments, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSavedSearch', 'id', id) - const localVarPath = `/saved-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/saved-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearch} savedSearch The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch: async (id: string, savedSearch: SavedSearch, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSavedSearch', 'id', id) - // verify required parameter 'savedSearch' is not null or undefined - assertParamExists('putSavedSearch', 'savedSearch', savedSearch) - const localVarPath = `/saved-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(savedSearch, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SavedSearchApi - functional programming interface - * @export - */ -export const SavedSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SavedSearchApiAxiosParamCreator(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {CreateSavedSearchRequest} createSavedSearchRequest The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSavedSearch(createSavedSearchRequest: CreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSavedSearch(createSavedSearchRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.createSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.deleteSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {string} id ID of the requested document. - * @param {SearchArguments} searchArguments When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async executeSavedSearch(id: string, searchArguments: SearchArguments, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.executeSavedSearch(id, searchArguments, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.executeSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSavedSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSavedSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.getSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @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: **owner.id**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSavedSearches(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSavedSearches(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.listSavedSearches']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {string} id ID of the requested document. - * @param {SavedSearch} savedSearch The saved search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSavedSearch(id: string, savedSearch: SavedSearch, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSavedSearch(id, savedSearch, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SavedSearchApi.putSavedSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SavedSearchApi - factory interface - * @export - */ -export const SavedSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SavedSearchApiFp(configuration) - return { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSavedSearch(requestParameters: SavedSearchApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSavedSearch(requestParameters.createSavedSearchRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSavedSearch(requestParameters: SavedSearchApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - executeSavedSearch(requestParameters: SavedSearchApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.executeSavedSearch(requestParameters.id, requestParameters.searchArguments, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSavedSearch(requestParameters: SavedSearchApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSavedSearches(requestParameters: SavedSearchApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSavedSearch(requestParameters: SavedSearchApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSavedSearch(requestParameters.id, requestParameters.savedSearch, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSavedSearch operation in SavedSearchApi. - * @export - * @interface SavedSearchApiCreateSavedSearchRequest - */ -export interface SavedSearchApiCreateSavedSearchRequest { - /** - * The saved search to persist. - * @type {CreateSavedSearchRequest} - * @memberof SavedSearchApiCreateSavedSearch - */ - readonly createSavedSearchRequest: CreateSavedSearchRequest -} - -/** - * Request parameters for deleteSavedSearch operation in SavedSearchApi. - * @export - * @interface SavedSearchApiDeleteSavedSearchRequest - */ -export interface SavedSearchApiDeleteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchApiDeleteSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for executeSavedSearch operation in SavedSearchApi. - * @export - * @interface SavedSearchApiExecuteSavedSearchRequest - */ -export interface SavedSearchApiExecuteSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchApiExecuteSavedSearch - */ - readonly id: string - - /** - * When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - * @type {SearchArguments} - * @memberof SavedSearchApiExecuteSavedSearch - */ - readonly searchArguments: SearchArguments -} - -/** - * Request parameters for getSavedSearch operation in SavedSearchApi. - * @export - * @interface SavedSearchApiGetSavedSearchRequest - */ -export interface SavedSearchApiGetSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchApiGetSavedSearch - */ - readonly id: string -} - -/** - * Request parameters for listSavedSearches operation in SavedSearchApi. - * @export - * @interface SavedSearchApiListSavedSearchesRequest - */ -export interface SavedSearchApiListSavedSearchesRequest { - /** - * 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 SavedSearchApiListSavedSearches - */ - 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 SavedSearchApiListSavedSearches - */ - 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 SavedSearchApiListSavedSearches - */ - 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: **owner.id**: *eq* - * @type {string} - * @memberof SavedSearchApiListSavedSearches - */ - readonly filters?: string -} - -/** - * Request parameters for putSavedSearch operation in SavedSearchApi. - * @export - * @interface SavedSearchApiPutSavedSearchRequest - */ -export interface SavedSearchApiPutSavedSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof SavedSearchApiPutSavedSearch - */ - readonly id: string - - /** - * The saved search to persist. - * @type {SavedSearch} - * @memberof SavedSearchApiPutSavedSearch - */ - readonly savedSearch: SavedSearch -} - -/** - * SavedSearchApi - object-oriented interface - * @export - * @class SavedSearchApi - * @extends {BaseAPI} - */ -export class SavedSearchApi extends BaseAPI { - /** - * Creates a new saved search. - * @summary Create a saved search - * @param {SavedSearchApiCreateSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public createSavedSearch(requestParameters: SavedSearchApiCreateSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).createSavedSearch(requestParameters.createSavedSearchRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified saved search. - * @summary Delete document by id - * @param {SavedSearchApiDeleteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public deleteSavedSearch(requestParameters: SavedSearchApiDeleteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).deleteSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Executes the specified saved search. - * @summary Execute a saved search by id - * @param {SavedSearchApiExecuteSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public executeSavedSearch(requestParameters: SavedSearchApiExecuteSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).executeSavedSearch(requestParameters.id, requestParameters.searchArguments, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified saved search. - * @summary Return saved search by id - * @param {SavedSearchApiGetSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public getSavedSearch(requestParameters: SavedSearchApiGetSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).getSavedSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of saved searches. - * @summary A list of saved searches - * @param {SavedSearchApiListSavedSearchesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public listSavedSearches(requestParameters: SavedSearchApiListSavedSearchesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).listSavedSearches(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** - * @summary Updates an existing saved search - * @param {SavedSearchApiPutSavedSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SavedSearchApi - */ - public putSavedSearch(requestParameters: SavedSearchApiPutSavedSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return SavedSearchApiFp(this.configuration).putSavedSearch(requestParameters.id, requestParameters.savedSearch, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ScheduledSearchApi - axios parameter creator - * @export - */ -export const ScheduledSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequest} createScheduledSearchRequest The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch: async (createScheduledSearchRequest: CreateScheduledSearchRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createScheduledSearchRequest' is not null or undefined - assertParamExists('createScheduledSearch', 'createScheduledSearchRequest', createScheduledSearchRequest) - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createScheduledSearchRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getScheduledSearch', 'id', id) - const localVarPath = `/scheduled-searches/{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, - }; - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch: async (offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/scheduled-searches`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - 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, - }; - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReference} typedReference The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch: async (id: string, typedReference: TypedReference, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'id', id) - // verify required parameter 'typedReference' is not null or undefined - assertParamExists('unsubscribeScheduledSearch', 'typedReference', typedReference) - const localVarPath = `/scheduled-searches/{id}/unsubscribe` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(typedReference, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearch} scheduledSearch The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch: async (id: string, scheduledSearch: ScheduledSearch, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateScheduledSearch', 'id', id) - // verify required parameter 'scheduledSearch' is not null or undefined - assertParamExists('updateScheduledSearch', 'scheduledSearch', scheduledSearch) - const localVarPath = `/scheduled-searches/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(scheduledSearch, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ScheduledSearchApi - functional programming interface - * @export - */ -export const ScheduledSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ScheduledSearchApiAxiosParamCreator(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {CreateScheduledSearchRequest} createScheduledSearchRequest The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createScheduledSearch(createScheduledSearchRequest: CreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createScheduledSearch(createScheduledSearchRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.createScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.deleteScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getScheduledSearch(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getScheduledSearch(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.getScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @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: **owner.id**: *eq* **savedSearchId**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listScheduledSearch(offset?: number, limit?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledSearch(offset, limit, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.listScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {string} id ID of the requested document. - * @param {TypedReference} typedReference The recipient to be removed from the scheduled search. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async unsubscribeScheduledSearch(id: string, typedReference: TypedReference, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unsubscribeScheduledSearch(id, typedReference, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.unsubscribeScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {string} id ID of the requested document. - * @param {ScheduledSearch} scheduledSearch The scheduled search to persist. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateScheduledSearch(id: string, scheduledSearch: ScheduledSearch, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateScheduledSearch(id, scheduledSearch, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ScheduledSearchApi.updateScheduledSearch']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ScheduledSearchApi - factory interface - * @export - */ -export const ScheduledSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ScheduledSearchApiFp(configuration) - return { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createScheduledSearch(requestParameters: ScheduledSearchApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createScheduledSearch(requestParameters.createScheduledSearchRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteScheduledSearch(requestParameters: ScheduledSearchApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getScheduledSearch(requestParameters: ScheduledSearchApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listScheduledSearch(requestParameters: ScheduledSearchApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - unsubscribeScheduledSearch(requestParameters: ScheduledSearchApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReference, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateScheduledSearch(requestParameters: ScheduledSearchApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearch, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiCreateScheduledSearchRequest - */ -export interface ScheduledSearchApiCreateScheduledSearchRequest { - /** - * The scheduled search to persist. - * @type {CreateScheduledSearchRequest} - * @memberof ScheduledSearchApiCreateScheduledSearch - */ - readonly createScheduledSearchRequest: CreateScheduledSearchRequest -} - -/** - * Request parameters for deleteScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiDeleteScheduledSearchRequest - */ -export interface ScheduledSearchApiDeleteScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchApiDeleteScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for getScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiGetScheduledSearchRequest - */ -export interface ScheduledSearchApiGetScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchApiGetScheduledSearch - */ - readonly id: string -} - -/** - * Request parameters for listScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiListScheduledSearchRequest - */ -export interface ScheduledSearchApiListScheduledSearchRequest { - /** - * 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 ScheduledSearchApiListScheduledSearch - */ - 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 ScheduledSearchApiListScheduledSearch - */ - 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 ScheduledSearchApiListScheduledSearch - */ - 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: **owner.id**: *eq* **savedSearchId**: *eq* - * @type {string} - * @memberof ScheduledSearchApiListScheduledSearch - */ - readonly filters?: string -} - -/** - * Request parameters for unsubscribeScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiUnsubscribeScheduledSearchRequest - */ -export interface ScheduledSearchApiUnsubscribeScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchApiUnsubscribeScheduledSearch - */ - readonly id: string - - /** - * The recipient to be removed from the scheduled search. - * @type {TypedReference} - * @memberof ScheduledSearchApiUnsubscribeScheduledSearch - */ - readonly typedReference: TypedReference -} - -/** - * Request parameters for updateScheduledSearch operation in ScheduledSearchApi. - * @export - * @interface ScheduledSearchApiUpdateScheduledSearchRequest - */ -export interface ScheduledSearchApiUpdateScheduledSearchRequest { - /** - * ID of the requested document. - * @type {string} - * @memberof ScheduledSearchApiUpdateScheduledSearch - */ - readonly id: string - - /** - * The scheduled search to persist. - * @type {ScheduledSearch} - * @memberof ScheduledSearchApiUpdateScheduledSearch - */ - readonly scheduledSearch: ScheduledSearch -} - -/** - * ScheduledSearchApi - object-oriented interface - * @export - * @class ScheduledSearchApi - * @extends {BaseAPI} - */ -export class ScheduledSearchApi extends BaseAPI { - /** - * Creates a new scheduled search. - * @summary Create a new scheduled search - * @param {ScheduledSearchApiCreateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public createScheduledSearch(requestParameters: ScheduledSearchApiCreateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).createScheduledSearch(requestParameters.createScheduledSearchRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the specified scheduled search. - * @summary Delete a scheduled search - * @param {ScheduledSearchApiDeleteScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public deleteScheduledSearch(requestParameters: ScheduledSearchApiDeleteScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).deleteScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns the specified scheduled search. - * @summary Get a scheduled search - * @param {ScheduledSearchApiGetScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public getScheduledSearch(requestParameters: ScheduledSearchApiGetScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).getScheduledSearch(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Returns a list of scheduled searches. - * @summary List scheduled searches - * @param {ScheduledSearchApiListScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public listScheduledSearch(requestParameters: ScheduledSearchApiListScheduledSearchRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).listScheduledSearch(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Unsubscribes a recipient from the specified scheduled search. - * @summary Unsubscribe a recipient from scheduled search - * @param {ScheduledSearchApiUnsubscribeScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public unsubscribeScheduledSearch(requestParameters: ScheduledSearchApiUnsubscribeScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).unsubscribeScheduledSearch(requestParameters.id, requestParameters.typedReference, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Updates an existing scheduled search. - * @summary Update an existing scheduled search - * @param {ScheduledSearchApiUpdateScheduledSearchRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ScheduledSearchApi - */ - public updateScheduledSearch(requestParameters: ScheduledSearchApiUpdateScheduledSearchRequest, axiosOptions?: RawAxiosRequestConfig) { - return ScheduledSearchApiFp(this.configuration).updateScheduledSearch(requestParameters.id, requestParameters.scheduledSearch, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SearchApi - axios parameter creator - * @export - */ -export const SearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {Search} search - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate: async (search: Search, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'search' is not null or undefined - assertParamExists('searchAggregate', 'search', search) - const localVarPath = `/search/aggregate`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(search, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {Search} search - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount: async (search: Search, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'search' is not null or undefined - assertParamExists('searchCount', 'search', search) - const localVarPath = `/search/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(search, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV3} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet: async (index: SearchGetIndexV3, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'index' is not null or undefined - assertParamExists('searchGet', 'index', index) - // verify required parameter 'id' is not null or undefined - assertParamExists('searchGet', 'id', id) - const localVarPath = `/search/{index}/{id}` - .replace(`{${"index"}}`, encodeURIComponent(String(index))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {Search} search - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost: async (search: Search, offset?: number, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'search' is not null or undefined - assertParamExists('searchPost', 'search', search) - const localVarPath = `/search`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(search, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchApi - functional programming interface - * @export - */ -export const SearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {Search} search - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchAggregate(search: Search, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchAggregate(search, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchApi.searchAggregate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {Search} search - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchCount(search: Search, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchCount(search, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchApi.searchCount']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchGetIndexV3} index The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @param {string} id ID of the requested document. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchGet(index: SearchGetIndexV3, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchGet(index, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchApi.searchGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {Search} search - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async searchPost(search: Search, offset?: number, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchPost(search, offset, limit, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchApi.searchPost']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchApi - factory interface - * @export - */ -export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchApiFp(configuration) - return { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchAggregate(requestParameters: SearchApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchAggregate(requestParameters.search, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchCount(requestParameters: SearchApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchCount(requestParameters.search, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchGet(requestParameters: SearchApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - searchPost(requestParameters: SearchApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.searchPost(requestParameters.search, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for searchAggregate operation in SearchApi. - * @export - * @interface SearchApiSearchAggregateRequest - */ -export interface SearchApiSearchAggregateRequest { - /** - * - * @type {Search} - * @memberof SearchApiSearchAggregate - */ - readonly search: Search - - /** - * 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 SearchApiSearchAggregate - */ - 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 SearchApiSearchAggregate - */ - 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 SearchApiSearchAggregate - */ - readonly count?: boolean -} - -/** - * Request parameters for searchCount operation in SearchApi. - * @export - * @interface SearchApiSearchCountRequest - */ -export interface SearchApiSearchCountRequest { - /** - * - * @type {Search} - * @memberof SearchApiSearchCount - */ - readonly search: Search -} - -/** - * Request parameters for searchGet operation in SearchApi. - * @export - * @interface SearchApiSearchGetRequest - */ -export interface SearchApiSearchGetRequest { - /** - * The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - * @type {'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'} - * @memberof SearchApiSearchGet - */ - readonly index: SearchGetIndexV3 - - /** - * ID of the requested document. - * @type {string} - * @memberof SearchApiSearchGet - */ - readonly id: string -} - -/** - * Request parameters for searchPost operation in SearchApi. - * @export - * @interface SearchApiSearchPostRequest - */ -export interface SearchApiSearchPostRequest { - /** - * - * @type {Search} - * @memberof SearchApiSearchPost - */ - readonly search: Search - - /** - * 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 SearchApiSearchPost - */ - 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 SearchApiSearchPost - */ - 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 SearchApiSearchPost - */ - readonly count?: boolean -} - -/** - * SearchApi - object-oriented interface - * @export - * @class SearchApi - * @extends {BaseAPI} - */ -export class SearchApi extends BaseAPI { - /** - * Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. - * @summary Perform a search query aggregation - * @param {SearchApiSearchAggregateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchApi - */ - public searchAggregate(requestParameters: SearchApiSearchAggregateRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchApiFp(this.configuration).searchAggregate(requestParameters.search, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Performs a search with a provided query and returns the count of results in the X-Total-Count header. - * @summary Count documents satisfying a query - * @param {SearchApiSearchCountRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchApi - */ - public searchCount(requestParameters: SearchApiSearchCountRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchApiFp(this.configuration).searchCount(requestParameters.search, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches a single document from the specified index, using the specified document ID. - * @summary Get a document by id - * @param {SearchApiSearchGetRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchApi - */ - public searchGet(requestParameters: SearchApiSearchGetRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchApiFp(this.configuration).searchGet(requestParameters.index, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). - * @summary Perform search - * @param {SearchApiSearchPostRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchApi - */ - public searchPost(requestParameters: SearchApiSearchPostRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchApiFp(this.configuration).searchPost(requestParameters.search, requestParameters.offset, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const SearchGetIndexV3 = { - Accessprofiles: 'accessprofiles', - Accountactivities: 'accountactivities', - Entitlements: 'entitlements', - Events: 'events', - Identities: 'identities', - Roles: 'roles' -} as const; -export type SearchGetIndexV3 = typeof SearchGetIndexV3[keyof typeof SearchGetIndexV3]; - - -/** - * SearchAttributeConfigurationApi - axios parameter creator - * @export - */ -export const SearchAttributeConfigurationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfig} searchAttributeConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig: async (searchAttributeConfig: SearchAttributeConfig, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'searchAttributeConfig' is not null or undefined - assertParamExists('createSearchAttributeConfig', 'searchAttributeConfig', searchAttributeConfig) - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(searchAttributeConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteSearchAttributeConfig', 'name', name) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/accounts/search-attribute-config`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('getSingleSearchAttributeConfig', 'name', name) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig: async (name: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'name' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'name', name) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchSearchAttributeConfig', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/accounts/search-attribute-config/{name}` - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * SearchAttributeConfigurationApi - functional programming interface - * @export - */ -export const SearchAttributeConfigurationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchAttributeConfigurationApiAxiosParamCreator(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfig} searchAttributeConfig - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSearchAttributeConfig(searchAttributeConfig: SearchAttributeConfig, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchAttributeConfig(searchAttributeConfig, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.createSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {string} name Name of the extended search attribute configuration to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchAttributeConfig(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.deleteSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSearchAttributeConfig(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchAttributeConfig(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.getSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {string} name Name of the extended search attribute configuration to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSingleSearchAttributeConfig(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleSearchAttributeConfig(name, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.getSingleSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {string} name Name of the search attribute configuration to patch. - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSearchAttributeConfig(name: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSearchAttributeConfig(name, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SearchAttributeConfigurationApi.patchSearchAttributeConfig']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SearchAttributeConfigurationApi - factory interface - * @export - */ -export const SearchAttributeConfigurationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchAttributeConfigurationApiFp(configuration) - return { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSearchAttributeConfig(requestParameters.searchAttributeConfig, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSingleSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationApi. - * @export - * @interface SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest { - /** - * - * @type {SearchAttributeConfig} - * @memberof SearchAttributeConfigurationApiCreateSearchAttributeConfig - */ - readonly searchAttributeConfig: SearchAttributeConfig -} - -/** - * Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationApi. - * @export - * @interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to delete. - * @type {string} - * @memberof SearchAttributeConfigurationApiDeleteSearchAttributeConfig - */ - readonly name: string -} - -/** - * Request parameters for getSearchAttributeConfig operation in SearchAttributeConfigurationApi. - * @export - * @interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationApiGetSearchAttributeConfigRequest { - /** - * 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 SearchAttributeConfigurationApiGetSearchAttributeConfig - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SearchAttributeConfigurationApiGetSearchAttributeConfig - */ - readonly offset?: number -} - -/** - * Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi. - * @export - * @interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest { - /** - * Name of the extended search attribute configuration to retrieve. - * @type {string} - * @memberof SearchAttributeConfigurationApiGetSingleSearchAttributeConfig - */ - readonly name: string -} - -/** - * Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationApi. - * @export - * @interface SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest - */ -export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest { - /** - * Name of the search attribute configuration to patch. - * @type {string} - * @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfig - */ - readonly name: string - - /** - * - * @type {Array} - * @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfig - */ - readonly jsonPatchOperation: Array -} - -/** - * SearchAttributeConfigurationApi - object-oriented interface - * @export - * @class SearchAttributeConfigurationApi - * @extends {BaseAPI} - */ -export class SearchAttributeConfigurationApi extends BaseAPI { - /** - * Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes\' `applicationAttributes`.** - * @summary Create extended search attributes - * @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationApi - */ - public createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationApiFp(this.configuration).createSearchAttributeConfig(requestParameters.searchAttributeConfig, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an extended attribute configuration by name. - * @summary Delete extended search attribute - * @param {SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationApi - */ - public deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationApiFp(this.configuration).deleteSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). - * @summary List extended search attributes - * @param {SearchAttributeConfigurationApiGetSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationApi - */ - public getSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSearchAttributeConfigRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationApiFp(this.configuration).getSearchAttributeConfig(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an extended attribute configuration by name. - * @summary Get extended search attribute - * @param {SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationApi - */ - public getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationApiFp(this.configuration).getSingleSearchAttributeConfig(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes - * @summary Update extended search attribute - * @param {SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SearchAttributeConfigurationApi - */ - public patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest, axiosOptions?: RawAxiosRequestConfig) { - return SearchAttributeConfigurationApiFp(this.configuration).patchSearchAttributeConfig(requestParameters.name, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SegmentsApi - axios parameter creator - * @export - */ -export const SegmentsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {Segment} segment - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment: async (segment: Segment, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'segment' is not null or undefined - assertParamExists('createSegment', 'segment', segment) - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(segment, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSegment', 'id', id) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments: async (limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/segments`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment: async (id: string, requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchSegment', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('patchSegment', 'requestBody', requestBody) - const localVarPath = `/segments/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * SegmentsApi - functional programming interface - * @export - */ -export const SegmentsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SegmentsApiAxiosParamCreator(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {Segment} segment - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSegment(segment: Segment, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSegment(segment, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsApi.createSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {string} id The segment ID to delete. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsApi.deleteSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {string} id The segment ID to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSegment(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSegment(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsApi.getSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSegments(limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSegments(limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsApi.listSegments']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {string} id The segment ID to modify. - * @param {Array} requestBody A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchSegment(id: string, requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchSegment(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SegmentsApi.patchSegment']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SegmentsApi - factory interface - * @export - */ -export const SegmentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SegmentsApiFp(configuration) - return { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSegment(requestParameters: SegmentsApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSegment(requestParameters.segment, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSegment(requestParameters: SegmentsApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSegment(requestParameters: SegmentsApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSegment(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSegments(requestParameters: SegmentsApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchSegment(requestParameters: SegmentsApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createSegment operation in SegmentsApi. - * @export - * @interface SegmentsApiCreateSegmentRequest - */ -export interface SegmentsApiCreateSegmentRequest { - /** - * - * @type {Segment} - * @memberof SegmentsApiCreateSegment - */ - readonly segment: Segment -} - -/** - * Request parameters for deleteSegment operation in SegmentsApi. - * @export - * @interface SegmentsApiDeleteSegmentRequest - */ -export interface SegmentsApiDeleteSegmentRequest { - /** - * The segment ID to delete. - * @type {string} - * @memberof SegmentsApiDeleteSegment - */ - readonly id: string -} - -/** - * Request parameters for getSegment operation in SegmentsApi. - * @export - * @interface SegmentsApiGetSegmentRequest - */ -export interface SegmentsApiGetSegmentRequest { - /** - * The segment ID to retrieve. - * @type {string} - * @memberof SegmentsApiGetSegment - */ - readonly id: string -} - -/** - * Request parameters for listSegments operation in SegmentsApi. - * @export - * @interface SegmentsApiListSegmentsRequest - */ -export interface SegmentsApiListSegmentsRequest { - /** - * 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 SegmentsApiListSegments - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SegmentsApiListSegments - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SegmentsApiListSegments - */ - readonly count?: boolean -} - -/** - * Request parameters for patchSegment operation in SegmentsApi. - * @export - * @interface SegmentsApiPatchSegmentRequest - */ -export interface SegmentsApiPatchSegmentRequest { - /** - * The segment ID to modify. - * @type {string} - * @memberof SegmentsApiPatchSegment - */ - readonly id: string - - /** - * A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - * @type {Array} - * @memberof SegmentsApiPatchSegment - */ - readonly requestBody: Array -} - -/** - * SegmentsApi - object-oriented interface - * @export - * @class SegmentsApi - * @extends {BaseAPI} - */ -export class SegmentsApi extends BaseAPI { - /** - * This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. - * @summary Create segment - * @param {SegmentsApiCreateSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsApi - */ - public createSegment(requestParameters: SegmentsApiCreateSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsApiFp(this.configuration).createSegment(requestParameters.segment, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. - * @summary Delete segment by id - * @param {SegmentsApiDeleteSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsApi - */ - public deleteSegment(requestParameters: SegmentsApiDeleteSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsApiFp(this.configuration).deleteSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the segment specified by the given ID. - * @summary Get segment by id - * @param {SegmentsApiGetSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsApi - */ - public getSegment(requestParameters: SegmentsApiGetSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsApiFp(this.configuration).getSegment(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all segments. - * @summary List segments - * @param {SegmentsApiListSegmentsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsApi - */ - public listSegments(requestParameters: SegmentsApiListSegmentsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsApiFp(this.configuration).listSegments(requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. - * @summary Update segment - * @param {SegmentsApiPatchSegmentRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SegmentsApi - */ - public patchSegment(requestParameters: SegmentsApiPatchSegmentRequest, axiosOptions?: RawAxiosRequestConfig) { - return SegmentsApiFp(this.configuration).patchSegment(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * ServiceDeskIntegrationApi - axios parameter creator - * @export - */ -export const ServiceDeskIntegrationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration: async (serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'serviceDeskIntegrationDto' is not null or undefined - assertParamExists('createServiceDeskIntegration', 'serviceDeskIntegrationDto', serviceDeskIntegrationDto) - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getServiceDeskIntegration', 'id', id) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate: async (scriptName: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'scriptName' is not null or undefined - assertParamExists('getServiceDeskIntegrationTemplate', 'scriptName', scriptName) - const localVarPath = `/service-desk-integrations/templates/{scriptName}` - .replace(`{${"scriptName"}}`, encodeURIComponent(String(scriptName))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/types`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations: async (offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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 Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchServiceDeskIntegration', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/service-desk-integrations/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration: async (id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'id', id) - // verify required parameter 'serviceDeskIntegrationDto' is not null or undefined - assertParamExists('putServiceDeskIntegration', 'serviceDeskIntegrationDto', serviceDeskIntegrationDto) - const localVarPath = `/service-desk-integrations/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(serviceDeskIntegrationDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetails} queuedCheckConfigDetails The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails: async (queuedCheckConfigDetails: QueuedCheckConfigDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'queuedCheckConfigDetails' is not null or undefined - assertParamExists('updateStatusCheckDetails', 'queuedCheckConfigDetails', queuedCheckConfigDetails) - const localVarPath = `/service-desk-integrations/status-check-configuration`; - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queuedCheckConfigDetails, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * ServiceDeskIntegrationApi - functional programming interface - * @export - */ -export const ServiceDeskIntegrationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ServiceDeskIntegrationApiAxiosParamCreator(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of a new integration to create - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createServiceDeskIntegration(serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createServiceDeskIntegration(serviceDeskIntegrationDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.createServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {string} id ID of Service Desk integration to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.deleteServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {string} id ID of the Service Desk integration to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegration(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegration(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {string} scriptName The scriptName value of the Service Desk integration template to get - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTemplate(scriptName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTemplate(scriptName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationTemplate']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrationTypes(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrationTypes']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @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 {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: **name** - * @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, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @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 {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getServiceDeskIntegrations(offset?: number, limit?: number, sorters?: string, filters?: string, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getServiceDeskIntegrations(offset, limit, sorters, filters, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getServiceDeskIntegrations']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusCheckDetails(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.getStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {Array} jsonPatchOperation A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchServiceDeskIntegration(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchServiceDeskIntegration(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.patchServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {string} id ID of the Service Desk integration to update - * @param {ServiceDeskIntegrationDto} serviceDeskIntegrationDto The specifics of the integration to update - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putServiceDeskIntegration(id: string, serviceDeskIntegrationDto: ServiceDeskIntegrationDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putServiceDeskIntegration(id, serviceDeskIntegrationDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.putServiceDeskIntegration']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {QueuedCheckConfigDetails} queuedCheckConfigDetails The modified time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateStatusCheckDetails(queuedCheckConfigDetails: QueuedCheckConfigDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateStatusCheckDetails(queuedCheckConfigDetails, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['ServiceDeskIntegrationApi.updateStatusCheckDetails']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * ServiceDeskIntegrationApi - factory interface - * @export - */ -export const ServiceDeskIntegrationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ServiceDeskIntegrationApiFp(configuration) - return { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusCheckDetails(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateStatusCheckDetails(requestParameters.queuedCheckConfigDetails, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createServiceDeskIntegration operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest { - /** - * The specifics of a new integration to create - * @type {ServiceDeskIntegrationDto} - * @memberof ServiceDeskIntegrationApiCreateServiceDeskIntegration - */ - readonly serviceDeskIntegrationDto: ServiceDeskIntegrationDto -} - -/** - * Request parameters for deleteServiceDeskIntegration operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest { - /** - * ID of Service Desk integration to delete - * @type {string} - * @memberof ServiceDeskIntegrationApiDeleteServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegration operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to get - * @type {string} - * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegration - */ - readonly id: string -} - -/** - * Request parameters for getServiceDeskIntegrationTemplate operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest - */ -export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest { - /** - * The scriptName value of the Service Desk integration template to get - * @type {string} - * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplate - */ - readonly scriptName: string -} - -/** - * Request parameters for getServiceDeskIntegrations operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest - */ -export interface ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest { - /** - * 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 ServiceDeskIntegrationApiGetServiceDeskIntegrations - */ - 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 ServiceDeskIntegrationApiGetServiceDeskIntegrations - */ - readonly limit?: number - - /** - * 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: **name** - * @type {string} - * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrations - */ - readonly sorters?: 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - * @type {string} - * @memberof ServiceDeskIntegrationApiGetServiceDeskIntegrations - */ - readonly filters?: string - - /** - * 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 ServiceDeskIntegrationApiGetServiceDeskIntegrations - */ - readonly count?: boolean -} - -/** - * Request parameters for patchServiceDeskIntegration operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegration - */ - readonly id: string - - /** - * A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - * @type {Array} - * @memberof ServiceDeskIntegrationApiPatchServiceDeskIntegration - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for putServiceDeskIntegration operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest - */ -export interface ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest { - /** - * ID of the Service Desk integration to update - * @type {string} - * @memberof ServiceDeskIntegrationApiPutServiceDeskIntegration - */ - readonly id: string - - /** - * The specifics of the integration to update - * @type {ServiceDeskIntegrationDto} - * @memberof ServiceDeskIntegrationApiPutServiceDeskIntegration - */ - readonly serviceDeskIntegrationDto: ServiceDeskIntegrationDto -} - -/** - * Request parameters for updateStatusCheckDetails operation in ServiceDeskIntegrationApi. - * @export - * @interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest - */ -export interface ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest { - /** - * The modified time check configuration - * @type {QueuedCheckConfigDetails} - * @memberof ServiceDeskIntegrationApiUpdateStatusCheckDetails - */ - readonly queuedCheckConfigDetails: QueuedCheckConfigDetails -} - -/** - * ServiceDeskIntegrationApi - object-oriented interface - * @export - * @class ServiceDeskIntegrationApi - * @extends {BaseAPI} - */ -export class ServiceDeskIntegrationApi extends BaseAPI { - /** - * Create a new Service Desk integration. - * @summary Create new service desk integration - * @param {ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public createServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiCreateServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).createServiceDeskIntegration(requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete an existing Service Desk integration by ID. - * @summary Delete a service desk integration - * @param {ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public deleteServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiDeleteServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).deleteServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get an existing Service Desk integration by ID. - * @summary Get a service desk integration - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public getServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegration(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns an existing Service Desk integration template by scriptName. - * @summary Service desk integration template by scriptname - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public getServiceDeskIntegrationTemplate(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationTemplateRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationTemplate(requestParameters.scriptName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API endpoint returns the current list of supported Service Desk integration types. - * @summary List service desk integration types - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public getServiceDeskIntegrationTypes(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrationTypes(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of Service Desk integration objects. - * @summary List existing service desk integrations - * @param {ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public getServiceDeskIntegrations(requestParameters: ServiceDeskIntegrationApiGetServiceDeskIntegrationsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).getServiceDeskIntegrations(requestParameters.offset, requestParameters.limit, requestParameters.sorters, requestParameters.filters, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the time check configuration of queued SDIM tickets. - * @summary Get the time check configuration - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public getStatusCheckDetails(axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).getStatusCheckDetails(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID with a PATCH request. - * @summary Patch a service desk integration - * @param {ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public patchServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPatchServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).patchServiceDeskIntegration(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update an existing Service Desk integration by ID. - * @summary Update a service desk integration - * @param {ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public putServiceDeskIntegration(requestParameters: ServiceDeskIntegrationApiPutServiceDeskIntegrationRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).putServiceDeskIntegration(requestParameters.id, requestParameters.serviceDeskIntegrationDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update the time check configuration of queued SDIM tickets. - * @summary Update the time check configuration - * @param {ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof ServiceDeskIntegrationApi - */ - public updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig) { - return ServiceDeskIntegrationApiFp(this.configuration).updateStatusCheckDetails(requestParameters.queuedCheckConfigDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourceUsagesApi - axios parameter creator - * @export - */ -export const SourceUsagesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getStatusBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/status` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId: async (sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getUsagesBySourceId', 'sourceId', sourceId) - const localVarPath = `/source-usages/{sourceId}/summaries` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - 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, - }; - }, - } -}; - -/** - * SourceUsagesApi - functional programming interface - * @export - */ -export const SourceUsagesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourceUsagesApiAxiosParamCreator(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {string} sourceId ID of IDN source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getStatusBySourceId(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStatusBySourceId(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesApi.getStatusBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {string} sourceId ID of IDN source - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **date** - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getUsagesBySourceId(sourceId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsagesBySourceId(sourceId, limit, offset, count, sorters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourceUsagesApi.getUsagesBySourceId']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourceUsagesApi - factory interface - * @export - */ -export const SourceUsagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourceUsagesApiFp(configuration) - return { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getStatusBySourceId(requestParameters: SourceUsagesApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getUsagesBySourceId(requestParameters: SourceUsagesApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for getStatusBySourceId operation in SourceUsagesApi. - * @export - * @interface SourceUsagesApiGetStatusBySourceIdRequest - */ -export interface SourceUsagesApiGetStatusBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesApiGetStatusBySourceId - */ - readonly sourceId: string -} - -/** - * Request parameters for getUsagesBySourceId operation in SourceUsagesApi. - * @export - * @interface SourceUsagesApiGetUsagesBySourceIdRequest - */ -export interface SourceUsagesApiGetUsagesBySourceIdRequest { - /** - * ID of IDN source - * @type {string} - * @memberof SourceUsagesApiGetUsagesBySourceId - */ - readonly sourceId: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesApiGetUsagesBySourceId - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourceUsagesApiGetUsagesBySourceId - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourceUsagesApiGetUsagesBySourceId - */ - readonly count?: boolean - - /** - * 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: **date** - * @type {string} - * @memberof SourceUsagesApiGetUsagesBySourceId - */ - readonly sorters?: string -} - -/** - * SourceUsagesApi - object-oriented interface - * @export - * @class SourceUsagesApi - * @extends {BaseAPI} - */ -export class SourceUsagesApi extends BaseAPI { - /** - * This API returns the status of the source usage insights setup by IDN source ID. - * @summary Finds status of source usage - * @param {SourceUsagesApiGetStatusBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesApi - */ - public getStatusBySourceId(requestParameters: SourceUsagesApiGetStatusBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesApiFp(this.configuration).getStatusBySourceId(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a summary of source usage insights for past 12 months. - * @summary Returns source usage insights - * @param {SourceUsagesApiGetUsagesBySourceIdRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourceUsagesApi - */ - public getUsagesBySourceId(requestParameters: SourceUsagesApiGetUsagesBySourceIdRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourceUsagesApiFp(this.configuration).getUsagesBySourceId(requestParameters.sourceId, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * SourcesApi - axios parameter creator - * @export - */ -export const SourcesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDto} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy: async (sourceId: string, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDto' is not null or undefined - assertParamExists('createProvisioningPolicy', 'provisioningPolicyDto', provisioningPolicyDto) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {Source} source - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource: async (source: Source, provisionAsCsv?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'source' is not null or undefined - assertParamExists('createSource', 'source', source) - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (provisionAsCsv !== undefined) { - localVarQueryParameter['provisionAsCsv'] = provisionAsCsv; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(source, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {Schema} schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema: async (sourceId: string, schema: Schema, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('createSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schema' is not null or undefined - assertParamExists('createSourceSchema', 'schema', schema) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schema, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy: async (sourceId: string, usageType: UsageType, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('deleteProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('deleteSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('deleteSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema: async (id: string, schemaName?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy: async (sourceId: string, usageType: UsageType, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('getProvisioningPolicy', 'usageType', usageType) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getSource', 'id', id) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceConnections', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/connections` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceHealth', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/source-health` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema: async (sourceId: string, schemaId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('getSourceSchema', 'schemaId', schemaId) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV3} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas: async (sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV3, includeNames?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('getSourceSchemas', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/schemas` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (includeTypes !== undefined) { - localVarQueryParameter['include-types'] = includeTypes; - } - - if (includeNames !== undefined) { - localVarQueryParameter['include-names'] = includeNames; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema: async (id: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importAccountsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/accounts` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile: async (sourceId: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('importConnectorFile', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/upload-connector-file` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema: async (id: string, schemaName?: string, file?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('importEntitlementsSchema', 'id', id) - const localVarPath = `/sources/{id}/schemas/entitlements` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (schemaName !== undefined) { - localVarQueryParameter['schemaName'] = schemaName; - } - - - if (file !== undefined) { - localVarFormParams.append('file', file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('listProvisioningPolicies', 'sourceId', sourceId) - const localVarPath = `/sources/{sourceId}/provisioning-policies` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/sources`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (forSubadmin !== undefined) { - localVarQueryParameter['for-subadmin'] = forSubadmin; - } - - if (includeIDNSource !== undefined) { - localVarQueryParameter['includeIDNSource'] = includeIDNSource; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDto} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy: async (sourceId: string, usageType: UsageType, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('putProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'provisioningPolicyDto' is not null or undefined - assertParamExists('putProvisioningPolicy', 'provisioningPolicyDto', provisioningPolicyDto) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {Source} source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource: async (id: string, source: Source, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putSource', 'id', id) - // verify required parameter 'source' is not null or undefined - assertParamExists('putSource', 'source', source) - const localVarPath = `/sources/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(source, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Schema} schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema: async (sourceId: string, schemaId: string, schema: Schema, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('putSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('putSourceSchema', 'schemaId', schemaId) - // verify required parameter 'schema' is not null or undefined - assertParamExists('putSourceSchema', 'schema', schema) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(schema, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk: async (sourceId: string, provisioningPolicyDto: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'sourceId', sourceId) - // verify required parameter 'provisioningPolicyDto' is not null or undefined - assertParamExists('updateProvisioningPoliciesInBulk', 'provisioningPolicyDto', provisioningPolicyDto) - const localVarPath = `/sources/{sourceId}/provisioning-policies/bulk-update` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(provisioningPolicyDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy: async (sourceId: string, usageType: UsageType, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'sourceId', sourceId) - // verify required parameter 'usageType' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'usageType', usageType) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateProvisioningPolicy', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/sources/{sourceId}/provisioning-policies/{usageType}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"usageType"}}`, encodeURIComponent(String(usageType))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperation A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateSource', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateSource', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/sources/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - 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, - }; - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema: async (sourceId: string, schemaId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'sourceId' is not null or undefined - assertParamExists('updateSourceSchema', 'sourceId', sourceId) - // verify required parameter 'schemaId' is not null or undefined - assertParamExists('updateSourceSchema', 'schemaId', schemaId) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('updateSourceSchema', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/sources/{sourceId}/schemas/{schemaId}` - .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))) - .replace(`{${"schemaId"}}`, encodeURIComponent(String(schemaId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - } -}; - -/** - * SourcesApi - functional programming interface - * @export - */ -export const SourcesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SourcesApiAxiosParamCreator(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {string} sourceId The Source id - * @param {ProvisioningPolicyDto} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createProvisioningPolicy(sourceId: string, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createProvisioningPolicy(sourceId, provisioningPolicyDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.createProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {Source} source - * @param {boolean} [provisionAsCsv] If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSource(source: Source, provisionAsCsv?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSource(source, provisionAsCsv, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.createSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {string} sourceId Source ID. - * @param {Schema} schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createSourceSchema(sourceId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSourceSchema(sourceId, schema, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.createSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteProvisioningPolicy(sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.deleteProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.deleteSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * - * @summary Delete source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.deleteSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {string} id The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getAccountsSchema(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountsSchema(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getEntitlementsSchema(id: string, schemaName?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlementsSchema(id, schemaName, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getProvisioningPolicy(sourceId: string, usageType: UsageType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getProvisioningPolicy(sourceId, usageType, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {string} id Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSource(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSource(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {string} sourceId Source ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceConnections(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnections(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceConnections']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {string} sourceId The Source id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceHealth(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceHealth(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceHealth']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchema(sourceId: string, schemaId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchema(sourceId, schemaId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {string} sourceId Source ID. - * @param {GetSourceSchemasIncludeTypesV3} [includeTypes] If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @param {string} [includeNames] A comma-separated list of schema names to filter result. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getSourceSchemas(sourceId: string, includeTypes?: GetSourceSchemasIncludeTypesV3, includeNames?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceSchemas(sourceId, includeTypes, includeNames, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.getSourceSchemas']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {string} id The Source id - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importAccountsSchema(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importAccountsSchema(id, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.importAccountsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {string} sourceId The Source id. - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importConnectorFile(sourceId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importConnectorFile(sourceId, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.importConnectorFile']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {string} id The Source id - * @param {string} [schemaName] Name of entitlement schema - * @param {File} [file] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async importEntitlementsSchema(id: string, schemaName?: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importEntitlementsSchema(id, schemaName, file, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.importEntitlementsSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {string} sourceId The Source id - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listProvisioningPolicies(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProvisioningPolicies(sourceId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.listProvisioningPolicies']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @param {string} [forSubadmin] Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @param {boolean} [includeIDNSource] Include the IdentityNow source in the response. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listSources(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSubadmin?: string, includeIDNSource?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSources(limit, offset, count, filters, sorters, forSubadmin, includeIDNSource, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.listSources']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {string} sourceId The Source ID. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {ProvisioningPolicyDto} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putProvisioningPolicy(sourceId: string, usageType: UsageType, provisioningPolicyDto: ProvisioningPolicyDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putProvisioningPolicy(sourceId, usageType, provisioningPolicyDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.putProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {string} id Source ID. - * @param {Source} source - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSource(id: string, source: Source, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSource(id, source, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.putSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Schema} schema - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putSourceSchema(sourceId: string, schemaId: string, schema: Schema, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putSourceSchema(sourceId, schemaId, schema, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.putSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {string} sourceId The Source id. - * @param {Array} provisioningPolicyDto - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPoliciesInBulk(sourceId: string, provisioningPolicyDto: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPoliciesInBulk(sourceId, provisioningPolicyDto, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.updateProvisioningPoliciesInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {string} sourceId The Source id. - * @param {UsageType} usageType The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateProvisioningPolicy(sourceId: string, usageType: UsageType, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateProvisioningPolicy(sourceId, usageType, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.updateProvisioningPolicy']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {string} id Source ID. - * @param {Array} jsonPatchOperation A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSource(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSource(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.updateSource']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {string} sourceId The Source id. - * @param {string} schemaId The Schema id. - * @param {Array} jsonPatchOperation The JSONPatch payload used to update the schema. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateSourceSchema(sourceId: string, schemaId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateSourceSchema(sourceId, schemaId, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['SourcesApi.updateSourceSchema']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * SourcesApi - factory interface - * @export - */ -export const SourcesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SourcesApiFp(configuration) - return { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createProvisioningPolicy(requestParameters: SourcesApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSource(requestParameters: SourcesApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSource(requestParameters.source, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createSourceSchema(requestParameters: SourcesApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSourceSchema(requestParameters.sourceId, requestParameters.schema, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteProvisioningPolicy(requestParameters: SourcesApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSource(requestParameters: SourcesApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete source schema by id - * @param {SourcesApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteSourceSchema(requestParameters: SourcesApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getAccountsSchema(requestParameters: SourcesApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getEntitlementsSchema(requestParameters: SourcesApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getProvisioningPolicy(requestParameters: SourcesApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSource(requestParameters: SourcesApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSource(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceHealth(requestParameters: SourcesApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchema(requestParameters: SourcesApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getSourceSchemas(requestParameters: SourcesApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importAccountsSchema(requestParameters: SourcesApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importConnectorFile(requestParameters: SourcesApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - importEntitlementsSchema(requestParameters: SourcesApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listProvisioningPolicies(requestParameters: SourcesApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listSources(requestParameters: SourcesApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putProvisioningPolicy(requestParameters: SourcesApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSource(requestParameters: SourcesApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSource(requestParameters.id, requestParameters.source, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putSourceSchema(requestParameters: SourcesApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schema, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPoliciesInBulk(requestParameters: SourcesApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateProvisioningPolicy(requestParameters: SourcesApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSource(requestParameters: SourcesApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSource(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateSourceSchema(requestParameters: SourcesApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createProvisioningPolicy operation in SourcesApi. - * @export - * @interface SourcesApiCreateProvisioningPolicyRequest - */ -export interface SourcesApiCreateProvisioningPolicyRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiCreateProvisioningPolicy - */ - readonly sourceId: string - - /** - * - * @type {ProvisioningPolicyDto} - * @memberof SourcesApiCreateProvisioningPolicy - */ - readonly provisioningPolicyDto: ProvisioningPolicyDto -} - -/** - * Request parameters for createSource operation in SourcesApi. - * @export - * @interface SourcesApiCreateSourceRequest - */ -export interface SourcesApiCreateSourceRequest { - /** - * - * @type {Source} - * @memberof SourcesApiCreateSource - */ - readonly source: Source - - /** - * If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. - * @type {boolean} - * @memberof SourcesApiCreateSource - */ - readonly provisionAsCsv?: boolean -} - -/** - * Request parameters for createSourceSchema operation in SourcesApi. - * @export - * @interface SourcesApiCreateSourceSchemaRequest - */ -export interface SourcesApiCreateSourceSchemaRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiCreateSourceSchema - */ - readonly sourceId: string - - /** - * - * @type {Schema} - * @memberof SourcesApiCreateSourceSchema - */ - readonly schema: Schema -} - -/** - * Request parameters for deleteProvisioningPolicy operation in SourcesApi. - * @export - * @interface SourcesApiDeleteProvisioningPolicyRequest - */ -export interface SourcesApiDeleteProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesApiDeleteProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageType} - * @memberof SourcesApiDeleteProvisioningPolicy - */ - readonly usageType: UsageType -} - -/** - * Request parameters for deleteSource operation in SourcesApi. - * @export - * @interface SourcesApiDeleteSourceRequest - */ -export interface SourcesApiDeleteSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiDeleteSource - */ - readonly id: string -} - -/** - * Request parameters for deleteSourceSchema operation in SourcesApi. - * @export - * @interface SourcesApiDeleteSourceSchemaRequest - */ -export interface SourcesApiDeleteSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiDeleteSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesApiDeleteSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getAccountsSchema operation in SourcesApi. - * @export - * @interface SourcesApiGetAccountsSchemaRequest - */ -export interface SourcesApiGetAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiGetAccountsSchema - */ - readonly id: string -} - -/** - * Request parameters for getEntitlementsSchema operation in SourcesApi. - * @export - * @interface SourcesApiGetEntitlementsSchemaRequest - */ -export interface SourcesApiGetEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiGetEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesApiGetEntitlementsSchema - */ - readonly schemaName?: string -} - -/** - * Request parameters for getProvisioningPolicy operation in SourcesApi. - * @export - * @interface SourcesApiGetProvisioningPolicyRequest - */ -export interface SourcesApiGetProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesApiGetProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageType} - * @memberof SourcesApiGetProvisioningPolicy - */ - readonly usageType: UsageType -} - -/** - * Request parameters for getSource operation in SourcesApi. - * @export - * @interface SourcesApiGetSourceRequest - */ -export interface SourcesApiGetSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiGetSource - */ - readonly id: string -} - -/** - * Request parameters for getSourceConnections operation in SourcesApi. - * @export - * @interface SourcesApiGetSourceConnectionsRequest - */ -export interface SourcesApiGetSourceConnectionsRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiGetSourceConnections - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceHealth operation in SourcesApi. - * @export - * @interface SourcesApiGetSourceHealthRequest - */ -export interface SourcesApiGetSourceHealthRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiGetSourceHealth - */ - readonly sourceId: string -} - -/** - * Request parameters for getSourceSchema operation in SourcesApi. - * @export - * @interface SourcesApiGetSourceSchemaRequest - */ -export interface SourcesApiGetSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiGetSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesApiGetSourceSchema - */ - readonly schemaId: string -} - -/** - * Request parameters for getSourceSchemas operation in SourcesApi. - * @export - * @interface SourcesApiGetSourceSchemasRequest - */ -export interface SourcesApiGetSourceSchemasRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiGetSourceSchemas - */ - readonly sourceId: string - - /** - * If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - * @type {'group' | 'user'} - * @memberof SourcesApiGetSourceSchemas - */ - readonly includeTypes?: GetSourceSchemasIncludeTypesV3 - - /** - * A comma-separated list of schema names to filter result. - * @type {string} - * @memberof SourcesApiGetSourceSchemas - */ - readonly includeNames?: string -} - -/** - * Request parameters for importAccountsSchema operation in SourcesApi. - * @export - * @interface SourcesApiImportAccountsSchemaRequest - */ -export interface SourcesApiImportAccountsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiImportAccountsSchema - */ - readonly id: string - - /** - * - * @type {File} - * @memberof SourcesApiImportAccountsSchema - */ - readonly file?: File -} - -/** - * Request parameters for importConnectorFile operation in SourcesApi. - * @export - * @interface SourcesApiImportConnectorFileRequest - */ -export interface SourcesApiImportConnectorFileRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiImportConnectorFile - */ - readonly sourceId: string - - /** - * - * @type {File} - * @memberof SourcesApiImportConnectorFile - */ - readonly file?: File -} - -/** - * Request parameters for importEntitlementsSchema operation in SourcesApi. - * @export - * @interface SourcesApiImportEntitlementsSchemaRequest - */ -export interface SourcesApiImportEntitlementsSchemaRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiImportEntitlementsSchema - */ - readonly id: string - - /** - * Name of entitlement schema - * @type {string} - * @memberof SourcesApiImportEntitlementsSchema - */ - readonly schemaName?: string - - /** - * - * @type {File} - * @memberof SourcesApiImportEntitlementsSchema - */ - readonly file?: File -} - -/** - * Request parameters for listProvisioningPolicies operation in SourcesApi. - * @export - * @interface SourcesApiListProvisioningPoliciesRequest - */ -export interface SourcesApiListProvisioningPoliciesRequest { - /** - * The Source id - * @type {string} - * @memberof SourcesApiListProvisioningPolicies - */ - readonly sourceId: string -} - -/** - * Request parameters for listSources operation in SourcesApi. - * @export - * @interface SourcesApiListSourcesRequest - */ -export interface SourcesApiListSourcesRequest { - /** - * 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 SourcesApiListSources - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof SourcesApiListSources - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof SourcesApiListSources - */ - 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, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - * @type {string} - * @memberof SourcesApiListSources - */ - 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: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - * @type {string} - * @memberof SourcesApiListSources - */ - readonly sorters?: string - - /** - * Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - * @type {string} - * @memberof SourcesApiListSources - */ - readonly forSubadmin?: string - - /** - * Include the IdentityNow source in the response. - * @type {boolean} - * @memberof SourcesApiListSources - */ - readonly includeIDNSource?: boolean -} - -/** - * Request parameters for putProvisioningPolicy operation in SourcesApi. - * @export - * @interface SourcesApiPutProvisioningPolicyRequest - */ -export interface SourcesApiPutProvisioningPolicyRequest { - /** - * The Source ID. - * @type {string} - * @memberof SourcesApiPutProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageType} - * @memberof SourcesApiPutProvisioningPolicy - */ - readonly usageType: UsageType - - /** - * - * @type {ProvisioningPolicyDto} - * @memberof SourcesApiPutProvisioningPolicy - */ - readonly provisioningPolicyDto: ProvisioningPolicyDto -} - -/** - * Request parameters for putSource operation in SourcesApi. - * @export - * @interface SourcesApiPutSourceRequest - */ -export interface SourcesApiPutSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiPutSource - */ - readonly id: string - - /** - * - * @type {Source} - * @memberof SourcesApiPutSource - */ - readonly source: Source -} - -/** - * Request parameters for putSourceSchema operation in SourcesApi. - * @export - * @interface SourcesApiPutSourceSchemaRequest - */ -export interface SourcesApiPutSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiPutSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesApiPutSourceSchema - */ - readonly schemaId: string - - /** - * - * @type {Schema} - * @memberof SourcesApiPutSourceSchema - */ - readonly schema: Schema -} - -/** - * Request parameters for updateProvisioningPoliciesInBulk operation in SourcesApi. - * @export - * @interface SourcesApiUpdateProvisioningPoliciesInBulkRequest - */ -export interface SourcesApiUpdateProvisioningPoliciesInBulkRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiUpdateProvisioningPoliciesInBulk - */ - readonly sourceId: string - - /** - * - * @type {Array} - * @memberof SourcesApiUpdateProvisioningPoliciesInBulk - */ - readonly provisioningPolicyDto: Array -} - -/** - * Request parameters for updateProvisioningPolicy operation in SourcesApi. - * @export - * @interface SourcesApiUpdateProvisioningPolicyRequest - */ -export interface SourcesApiUpdateProvisioningPolicyRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiUpdateProvisioningPolicy - */ - readonly sourceId: string - - /** - * The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to \'Create Account Profile\', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to \'Update Account Profile\', the provisioning template for the \'Update\' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to \'Enable Account Profile\', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner\'s account is created. DISABLE - This usage type relates to \'Disable Account Profile\', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - * @type {UsageType} - * @memberof SourcesApiUpdateProvisioningPolicy - */ - readonly usageType: UsageType - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesApiUpdateProvisioningPolicy - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for updateSource operation in SourcesApi. - * @export - * @interface SourcesApiUpdateSourceRequest - */ -export interface SourcesApiUpdateSourceRequest { - /** - * Source ID. - * @type {string} - * @memberof SourcesApiUpdateSource - */ - readonly id: string - - /** - * A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - * @type {Array} - * @memberof SourcesApiUpdateSource - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for updateSourceSchema operation in SourcesApi. - * @export - * @interface SourcesApiUpdateSourceSchemaRequest - */ -export interface SourcesApiUpdateSourceSchemaRequest { - /** - * The Source id. - * @type {string} - * @memberof SourcesApiUpdateSourceSchema - */ - readonly sourceId: string - - /** - * The Schema id. - * @type {string} - * @memberof SourcesApiUpdateSourceSchema - */ - readonly schemaId: string - - /** - * The JSONPatch payload used to update the schema. - * @type {Array} - * @memberof SourcesApiUpdateSourceSchema - */ - readonly jsonPatchOperation: Array -} - -/** - * SourcesApi - object-oriented interface - * @export - * @class SourcesApi - * @extends {BaseAPI} - */ -export class SourcesApi extends BaseAPI { - /** - * This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Create provisioning policy - * @param {SourcesApiCreateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public createProvisioningPolicy(requestParameters: SourcesApiCreateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).createProvisioningPolicy(requestParameters.sourceId, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. - * @summary Creates a source in identitynow. - * @param {SourcesApiCreateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public createSource(requestParameters: SourcesApiCreateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).createSource(requestParameters.source, requestParameters.provisionAsCsv, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - * @summary Create schema on source - * @param {SourcesApiCreateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public createSourceSchema(requestParameters: SourcesApiCreateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).createSourceSchema(requestParameters.sourceId, requestParameters.schema, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the provisioning policy with the specified usage on an application. - * @summary Delete provisioning policy by usagetype - * @param {SourcesApiDeleteProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public deleteProvisioningPolicy(requestParameters: SourcesApiDeleteProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).deleteProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` - * @summary Delete source by id - * @param {SourcesApiDeleteSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public deleteSource(requestParameters: SourcesApiDeleteSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).deleteSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete source schema by id - * @param {SourcesApiDeleteSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public deleteSourceSchema(requestParameters: SourcesApiDeleteSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).deleteSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source accounts schema template - * @param {SourcesApiGetAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getAccountsSchema(requestParameters: SourcesApiGetAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getAccountsSchema(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** - * @summary Downloads source entitlements schema template - * @param {SourcesApiGetEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getEntitlementsSchema(requestParameters: SourcesApiGetEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getEntitlementsSchema(requestParameters.id, requestParameters.schemaName, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - * @summary Get provisioning policy by usagetype - * @param {SourcesApiGetProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getProvisioningPolicy(requestParameters: SourcesApiGetProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source by id - * @param {SourcesApiGetSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getSource(requestParameters: SourcesApiGetSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getSource(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). - * @summary Get source connections by id - * @param {SourcesApiGetSourceConnectionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getSourceConnections(requestParameters: SourcesApiGetSourceConnectionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getSourceConnections(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint fetches source health by source\'s id - * @summary Fetches source health by id - * @param {SourcesApiGetSourceHealthRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getSourceHealth(requestParameters: SourcesApiGetSourceHealthRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getSourceHealth(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Source Schema by ID in IdentityNow. - * @summary Get source schema by id - * @param {SourcesApiGetSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getSourceSchema(requestParameters: SourcesApiGetSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getSourceSchema(requestParameters.sourceId, requestParameters.schemaId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - * @summary List schemas on source - * @param {SourcesApiGetSourceSchemasRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public getSourceSchemas(requestParameters: SourcesApiGetSourceSchemasRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).getSourceSchemas(requestParameters.sourceId, requestParameters.includeTypes, requestParameters.includeNames, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s account attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source accounts schema template - * @param {SourcesApiImportAccountsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public importAccountsSchema(requestParameters: SourcesApiImportAccountsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).importAccountsSchema(requestParameters.id, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This uploads a supplemental source connector file (like jdbc driver jars) to a source\'s S3 bucket. This also sends ETS and Audit events. - * @summary Upload connector file to source - * @param {SourcesApiImportConnectorFileRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public importConnectorFile(requestParameters: SourcesApiImportConnectorFileRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).importConnectorFile(requestParameters.sourceId, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API uploads a source schema template file to configure a source\'s entitlement attributes. To retrieve the file to modify and upload, log into Identity Now. Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** >**NOTE: This API is designated only for Delimited File sources.** - * @summary Uploads source entitlements schema template - * @param {SourcesApiImportEntitlementsSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public importEntitlementsSchema(requestParameters: SourcesApiImportEntitlementsSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).importEntitlementsSchema(requestParameters.id, requestParameters.schemaName, requestParameters.file, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the ProvisioningPolicies in IdentityNow. - * @summary Lists provisioningpolicies - * @param {SourcesApiListProvisioningPoliciesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public listProvisioningPolicies(requestParameters: SourcesApiListProvisioningPoliciesRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).listProvisioningPolicies(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point lists all the sources in IdentityNow. - * @summary Lists all sources in identitynow. - * @param {SourcesApiListSourcesRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public listSources(requestParameters: SourcesApiListSourcesRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).listSources(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, requestParameters.forSubadmin, requestParameters.includeIDNSource, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Update provisioning policy by usagetype - * @param {SourcesApiPutProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public putProvisioningPolicy(requestParameters: SourcesApiPutProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).putProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. These fields are immutable, so they cannot be changed: * id * type * authoritative * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (full) - * @param {SourcesApiPutSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public putSource(requestParameters: SourcesApiPutSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).putSource(requestParameters.id, requestParameters.source, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id * name * created * modified Any attempt to modify these fields will result in an error response with a status code of 400. > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. - * @summary Update source schema (full) - * @param {SourcesApiPutSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public putSourceSchema(requestParameters: SourcesApiPutSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).putSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.schema, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This end-point updates a list of provisioning policies on the specified source in IdentityNow. - * @summary Bulk update provisioning policies - * @param {SourcesApiUpdateProvisioningPoliciesInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public updateProvisioningPoliciesInBulk(requestParameters: SourcesApiUpdateProvisioningPoliciesInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).updateProvisioningPoliciesInBulk(requestParameters.sourceId, requestParameters.provisioningPolicyDto, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. - * @summary Partial update of provisioning policy - * @param {SourcesApiUpdateProvisioningPolicyRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public updateProvisioningPolicy(requestParameters: SourcesApiUpdateProvisioningPolicyRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).updateProvisioningPolicy(requestParameters.sourceId, requestParameters.usageType, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. These fields are immutable, so they cannot be changed: * id * type * authoritative * created * modified * connector * connectorClass * passwordPolicies Attempts to modify these fields will result in a 400 error. - * @summary Update source (partial) - * @param {SourcesApiUpdateSourceRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public updateSource(requestParameters: SourcesApiUpdateSourceRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).updateSource(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to selectively update an existing Schema using a JSONPatch payload. The following schema fields are immutable and cannot be updated: - id - name - created - modified To switch an account attribute to a group entitlement, you need to have the following in place: - `isEntitlement: true` - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: ```json { \"name\": \"groups\", \"type\": \"STRING\", \"schema\": { \"type\": \"CONNECTOR_SCHEMA\", \"id\": \"2c9180887671ff8c01767b4671fc7d60\", \"name\": \"group\" }, \"description\": \"The groups, roles etc. that reference account group objects\", \"isMulti\": true, \"isEntitlement\": true, \"isGroup\": true } ``` - * @summary Update source schema (partial) - * @param {SourcesApiUpdateSourceSchemaRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof SourcesApi - */ - public updateSourceSchema(requestParameters: SourcesApiUpdateSourceSchemaRequest, axiosOptions?: RawAxiosRequestConfig) { - return SourcesApiFp(this.configuration).updateSourceSchema(requestParameters.sourceId, requestParameters.schemaId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const GetSourceSchemasIncludeTypesV3 = { - Group: 'group', - User: 'user' -} as const; -export type GetSourceSchemasIncludeTypesV3 = typeof GetSourceSchemasIncludeTypesV3[keyof typeof GetSourceSchemasIncludeTypesV3]; - - -/** - * TaggedObjectsApi - axios parameter creator - * @export - */ -export const TaggedObjectsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV3} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject: async (type: DeleteTaggedObjectTypeV3, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('deleteTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject: async (bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkRemoveTaggedObject' is not null or undefined - assertParamExists('deleteTagsToManyObject', 'bulkRemoveTaggedObject', bulkRemoveTaggedObject) - const localVarPath = `/tagged-objects/bulk-remove`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkRemoveTaggedObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV3} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject: async (type: GetTaggedObjectTypeV3, id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('getTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('getTaggedObject', 'id', id) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects: async (limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV3} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType: async (type: ListTaggedObjectsByTypeTypeV3, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('listTaggedObjectsByType', 'type', type) - const localVarPath = `/tagged-objects/{type}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV3} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObject} taggedObject - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject: async (type: PutTaggedObjectTypeV3, id: string, taggedObject: TaggedObject, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'type' is not null or undefined - assertParamExists('putTaggedObject', 'type', type) - // verify required parameter 'id' is not null or undefined - assertParamExists('putTaggedObject', 'id', id) - // verify required parameter 'taggedObject' is not null or undefined - assertParamExists('putTaggedObject', 'taggedObject', taggedObject) - const localVarPath = `/tagged-objects/{type}/{id}` - .replace(`{${"type"}}`, encodeURIComponent(String(type))) - .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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObject} taggedObject - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject: async (taggedObject: TaggedObject, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'taggedObject' is not null or undefined - assertParamExists('setTagToObject', 'taggedObject', taggedObject) - const localVarPath = `/tagged-objects`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(taggedObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects: async (bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'bulkAddTaggedObject' is not null or undefined - assertParamExists('setTagsToManyObjects', 'bulkAddTaggedObject', bulkAddTaggedObject) - const localVarPath = `/tagged-objects/bulk-add`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(bulkAddTaggedObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TaggedObjectsApi - functional programming interface - * @export - */ -export const TaggedObjectsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TaggedObjectsApiAxiosParamCreator(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {DeleteTaggedObjectTypeV3} type The type of object to delete tags from. - * @param {string} id The ID of the object to delete tags from. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTaggedObject(type: DeleteTaggedObjectTypeV3, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.deleteTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTagsToManyObject(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTagsToManyObject(bulkRemoveTaggedObject, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.deleteTagsToManyObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {GetTaggedObjectTypeV3} type The type of tagged object to retrieve. - * @param {string} id The ID of the object reference to retrieve. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTaggedObject(type: GetTaggedObjectTypeV3, id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaggedObject(type, id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.getTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjects(limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjects(limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.listTaggedObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {ListTaggedObjectsByTypeTypeV3} type The type of tagged object to retrieve. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTaggedObjectsByType(type: ListTaggedObjectsByTypeTypeV3, limit?: number, offset?: number, count?: boolean, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTaggedObjectsByType(type, limit, offset, count, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.listTaggedObjectsByType']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {PutTaggedObjectTypeV3} type The type of tagged object to update. - * @param {string} id The ID of the object reference to update. - * @param {TaggedObject} taggedObject - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putTaggedObject(type: PutTaggedObjectTypeV3, id: string, taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putTaggedObject(type, id, taggedObject, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.putTaggedObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObject} taggedObject - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagToObject(taggedObject: TaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagToObject(taggedObject, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.setTagToObject']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async setTagsToManyObjects(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.setTagsToManyObjects(bulkAddTaggedObject, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TaggedObjectsApi.setTagsToManyObjects']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TaggedObjectsApi - factory interface - * @export - */ -export const TaggedObjectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TaggedObjectsApiFp(configuration) - return { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTaggedObject(requestParameters: TaggedObjectsApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTagsToManyObject(requestParameters: TaggedObjectsApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObject, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTaggedObject(requestParameters: TaggedObjectsApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjects(requestParameters: TaggedObjectsApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTaggedObjectsByType(requestParameters: TaggedObjectsApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putTaggedObject(requestParameters: TaggedObjectsApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObject, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagToObject(requestParameters: TaggedObjectsApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.setTagToObject(requestParameters.taggedObject, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - setTagsToManyObjects(requestParameters: TaggedObjectsApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.setTagsToManyObjects(requestParameters.bulkAddTaggedObject, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for deleteTaggedObject operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiDeleteTaggedObjectRequest - */ -export interface TaggedObjectsApiDeleteTaggedObjectRequest { - /** - * The type of object to delete tags from. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsApiDeleteTaggedObject - */ - readonly type: DeleteTaggedObjectTypeV3 - - /** - * The ID of the object to delete tags from. - * @type {string} - * @memberof TaggedObjectsApiDeleteTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for deleteTagsToManyObject operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiDeleteTagsToManyObjectRequest - */ -export interface TaggedObjectsApiDeleteTagsToManyObjectRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkRemoveTaggedObject} - * @memberof TaggedObjectsApiDeleteTagsToManyObject - */ - readonly bulkRemoveTaggedObject: BulkRemoveTaggedObject -} - -/** - * Request parameters for getTaggedObject operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiGetTaggedObjectRequest - */ -export interface TaggedObjectsApiGetTaggedObjectRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsApiGetTaggedObject - */ - readonly type: GetTaggedObjectTypeV3 - - /** - * The ID of the object reference to retrieve. - * @type {string} - * @memberof TaggedObjectsApiGetTaggedObject - */ - readonly id: string -} - -/** - * Request parameters for listTaggedObjects operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiListTaggedObjectsRequest - */ -export interface TaggedObjectsApiListTaggedObjectsRequest { - /** - * 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 TaggedObjectsApiListTaggedObjects - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsApiListTaggedObjects - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsApiListTaggedObjects - */ - 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - * @type {string} - * @memberof TaggedObjectsApiListTaggedObjects - */ - readonly filters?: string -} - -/** - * Request parameters for listTaggedObjectsByType operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiListTaggedObjectsByTypeRequest - */ -export interface TaggedObjectsApiListTaggedObjectsByTypeRequest { - /** - * The type of tagged object to retrieve. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsApiListTaggedObjectsByType - */ - readonly type: ListTaggedObjectsByTypeTypeV3 - - /** - * 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 TaggedObjectsApiListTaggedObjectsByType - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof TaggedObjectsApiListTaggedObjectsByType - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof TaggedObjectsApiListTaggedObjectsByType - */ - 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: **objectRef.id**: *eq* **objectRef.type**: *eq* - * @type {string} - * @memberof TaggedObjectsApiListTaggedObjectsByType - */ - readonly filters?: string -} - -/** - * Request parameters for putTaggedObject operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiPutTaggedObjectRequest - */ -export interface TaggedObjectsApiPutTaggedObjectRequest { - /** - * The type of tagged object to update. - * @type {'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'} - * @memberof TaggedObjectsApiPutTaggedObject - */ - readonly type: PutTaggedObjectTypeV3 - - /** - * The ID of the object reference to update. - * @type {string} - * @memberof TaggedObjectsApiPutTaggedObject - */ - readonly id: string - - /** - * - * @type {TaggedObject} - * @memberof TaggedObjectsApiPutTaggedObject - */ - readonly taggedObject: TaggedObject -} - -/** - * Request parameters for setTagToObject operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiSetTagToObjectRequest - */ -export interface TaggedObjectsApiSetTagToObjectRequest { - /** - * - * @type {TaggedObject} - * @memberof TaggedObjectsApiSetTagToObject - */ - readonly taggedObject: TaggedObject -} - -/** - * Request parameters for setTagsToManyObjects operation in TaggedObjectsApi. - * @export - * @interface TaggedObjectsApiSetTagsToManyObjectsRequest - */ -export interface TaggedObjectsApiSetTagsToManyObjectsRequest { - /** - * Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - * @type {BulkAddTaggedObject} - * @memberof TaggedObjectsApiSetTagsToManyObjects - */ - readonly bulkAddTaggedObject: BulkAddTaggedObject -} - -/** - * TaggedObjectsApi - object-oriented interface - * @export - * @class TaggedObjectsApi - * @extends {BaseAPI} - */ -export class TaggedObjectsApi extends BaseAPI { - /** - * Delete all tags from a tagged object. - * @summary Delete object tags - * @param {TaggedObjectsApiDeleteTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public deleteTaggedObject(requestParameters: TaggedObjectsApiDeleteTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).deleteTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API removes tags from multiple objects. - * @summary Remove tags from multiple objects - * @param {TaggedObjectsApiDeleteTagsToManyObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public deleteTagsToManyObject(requestParameters: TaggedObjectsApiDeleteTagsToManyObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).deleteTagsToManyObject(requestParameters.bulkRemoveTaggedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a tagged object for the specified type. - * @summary Get tagged object - * @param {TaggedObjectsApiGetTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public getTaggedObject(requestParameters: TaggedObjectsApiGetTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).getTaggedObject(requestParameters.type, requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects. - * @summary List tagged objects - * @param {TaggedObjectsApiListTaggedObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public listTaggedObjects(requestParameters: TaggedObjectsApiListTaggedObjectsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).listTaggedObjects(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns a list of all tagged objects by type. - * @summary List tagged objects by type - * @param {TaggedObjectsApiListTaggedObjectsByTypeRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public listTaggedObjectsByType(requestParameters: TaggedObjectsApiListTaggedObjectsByTypeRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).listTaggedObjectsByType(requestParameters.type, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This updates a tagged object for the specified type. - * @summary Update tagged object - * @param {TaggedObjectsApiPutTaggedObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public putTaggedObject(requestParameters: TaggedObjectsApiPutTaggedObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).putTaggedObject(requestParameters.type, requestParameters.id, requestParameters.taggedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This adds a tag to an object. - * @summary Add tag to object - * @param {TaggedObjectsApiSetTagToObjectRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public setTagToObject(requestParameters: TaggedObjectsApiSetTagToObjectRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).setTagToObject(requestParameters.taggedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API adds tags to multiple objects. - * @summary Tag multiple objects - * @param {TaggedObjectsApiSetTagsToManyObjectsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TaggedObjectsApi - */ - public setTagsToManyObjects(requestParameters: TaggedObjectsApiSetTagsToManyObjectsRequest, axiosOptions?: RawAxiosRequestConfig) { - return TaggedObjectsApiFp(this.configuration).setTagsToManyObjects(requestParameters.bulkAddTaggedObject, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const DeleteTaggedObjectTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type DeleteTaggedObjectTypeV3 = typeof DeleteTaggedObjectTypeV3[keyof typeof DeleteTaggedObjectTypeV3]; -/** - * @export - */ -export const GetTaggedObjectTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type GetTaggedObjectTypeV3 = typeof GetTaggedObjectTypeV3[keyof typeof GetTaggedObjectTypeV3]; -/** - * @export - */ -export const ListTaggedObjectsByTypeTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type ListTaggedObjectsByTypeTypeV3 = typeof ListTaggedObjectsByTypeTypeV3[keyof typeof ListTaggedObjectsByTypeTypeV3]; -/** - * @export - */ -export const PutTaggedObjectTypeV3 = { - AccessProfile: 'ACCESS_PROFILE', - Application: 'APPLICATION', - Campaign: 'CAMPAIGN', - Entitlement: 'ENTITLEMENT', - Identity: 'IDENTITY', - Role: 'ROLE', - SodPolicy: 'SOD_POLICY', - Source: 'SOURCE' -} as const; -export type PutTaggedObjectTypeV3 = typeof PutTaggedObjectTypeV3[keyof typeof PutTaggedObjectTypeV3]; - - -/** - * TransformsApi - axios parameter creator - * @export - */ -export const TransformsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {Transform} transform The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform: async (transform: Transform, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'transform' is not null or undefined - assertParamExists('createTransform', 'transform', transform) - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transform, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getTransform', 'id', id) - const localVarPath = `/transforms/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms: async (offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/transforms`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - 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, - }; - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {Transform} [transform] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform: async (id: string, transform?: Transform, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('updateTransform', 'id', id) - const localVarPath = `/transforms/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(transform, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * TransformsApi - functional programming interface - * @export - */ -export const TransformsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TransformsApiAxiosParamCreator(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {Transform} transform The transform to be created. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createTransform(transform: Transform, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createTransform(transform, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsApi.createTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {string} id ID of the transform to delete - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsApi.deleteTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {string} id ID of the transform to retrieve - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getTransform(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTransform(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsApi.getTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @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} [name] Name of the transform to retrieve from the list. - * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listTransforms(offset?: number, limit?: number, count?: boolean, name?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listTransforms(offset, limit, count, name, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsApi.listTransforms']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {string} id ID of the transform to update - * @param {Transform} [transform] The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async updateTransform(id: string, transform?: Transform, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateTransform(id, transform, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['TransformsApi.updateTransform']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * TransformsApi - factory interface - * @export - */ -export const TransformsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TransformsApiFp(configuration) - return { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createTransform(requestParameters: TransformsApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createTransform(requestParameters.transform, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteTransform(requestParameters: TransformsApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getTransform(requestParameters: TransformsApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getTransform(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listTransforms(requestParameters: TransformsApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateTransform(requestParameters.id, requestParameters.transform, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for createTransform operation in TransformsApi. - * @export - * @interface TransformsApiCreateTransformRequest - */ -export interface TransformsApiCreateTransformRequest { - /** - * The transform to be created. - * @type {Transform} - * @memberof TransformsApiCreateTransform - */ - readonly transform: Transform -} - -/** - * Request parameters for deleteTransform operation in TransformsApi. - * @export - * @interface TransformsApiDeleteTransformRequest - */ -export interface TransformsApiDeleteTransformRequest { - /** - * ID of the transform to delete - * @type {string} - * @memberof TransformsApiDeleteTransform - */ - readonly id: string -} - -/** - * Request parameters for getTransform operation in TransformsApi. - * @export - * @interface TransformsApiGetTransformRequest - */ -export interface TransformsApiGetTransformRequest { - /** - * ID of the transform to retrieve - * @type {string} - * @memberof TransformsApiGetTransform - */ - readonly id: string -} - -/** - * Request parameters for listTransforms operation in TransformsApi. - * @export - * @interface TransformsApiListTransformsRequest - */ -export interface TransformsApiListTransformsRequest { - /** - * 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 TransformsApiListTransforms - */ - 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 TransformsApiListTransforms - */ - 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 TransformsApiListTransforms - */ - readonly count?: boolean - - /** - * Name of the transform to retrieve from the list. - * @type {string} - * @memberof TransformsApiListTransforms - */ - readonly name?: 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: **internal**: *eq* **name**: *eq, sw* - * @type {string} - * @memberof TransformsApiListTransforms - */ - readonly filters?: string -} - -/** - * Request parameters for updateTransform operation in TransformsApi. - * @export - * @interface TransformsApiUpdateTransformRequest - */ -export interface TransformsApiUpdateTransformRequest { - /** - * ID of the transform to update - * @type {string} - * @memberof TransformsApiUpdateTransform - */ - readonly id: string - - /** - * The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. - * @type {Transform} - * @memberof TransformsApiUpdateTransform - */ - readonly transform?: Transform -} - -/** - * TransformsApi - object-oriented interface - * @export - * @class TransformsApi - * @extends {BaseAPI} - */ -export class TransformsApi extends BaseAPI { - /** - * Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. - * @summary Create transform - * @param {TransformsApiCreateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsApi - */ - public createTransform(requestParameters: TransformsApiCreateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsApiFp(this.configuration).createTransform(requestParameters.transform, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. - * @summary Delete a transform - * @param {TransformsApiDeleteTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsApi - */ - public deleteTransform(requestParameters: TransformsApiDeleteTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsApiFp(this.configuration).deleteTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API returns the transform specified by the given ID. - * @summary Transform by id - * @param {TransformsApiGetTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsApi - */ - public getTransform(requestParameters: TransformsApiGetTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsApiFp(this.configuration).getTransform(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Gets a list of all saved transform objects. - * @summary List transforms - * @param {TransformsApiListTransformsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsApi - */ - public listTransforms(requestParameters: TransformsApiListTransformsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return TransformsApiFp(this.configuration).listTransforms(requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.name, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Replaces the transform specified by the given ID with the transform provided in the request body. Only the \"attributes\" field is mutable. Attempting to change other properties (ex. \"name\" and \"type\") will result in an error. - * @summary Update a transform - * @param {TransformsApiUpdateTransformRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof TransformsApi - */ - public updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: RawAxiosRequestConfig) { - return TransformsApiFp(this.configuration).updateTransform(requestParameters.id, requestParameters.transform, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkItemsApi - axios parameter creator - * @export - */ -export const WorkItemsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('approveApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/approve/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('approveApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('completeWorkItem', 'id', id) - const localVarPath = `/work-items/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/completed/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/count`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkItem', 'id', id) - const localVarPath = `/work-items/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items/summary`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/work-items`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (count !== undefined) { - localVarQueryParameter['count'] = count; - } - - if (ownerId !== undefined) { - localVarQueryParameter['ownerId'] = ownerId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItem', 'id', id) - // verify required parameter 'approvalItemId' is not null or undefined - assertParamExists('rejectApprovalItem', 'approvalItemId', approvalItemId) - const localVarPath = `/work-items/{id}/reject/{approvalItemId}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('rejectApprovalItemsInBulk', 'id', id) - const localVarPath = `/work-items/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForward} workItemForward - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendWorkItemForward: async (id: string, workItemForward: WorkItemForward, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('sendWorkItemForward', 'id', id) - // verify required parameter 'workItemForward' is not null or undefined - assertParamExists('sendWorkItemForward', 'workItemForward', workItemForward) - const localVarPath = `/work-items/{id}/forward` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workItemForward, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('submitAccountSelection', 'id', id) - // verify required parameter 'requestBody' is not null or undefined - assertParamExists('submitAccountSelection', 'requestBody', requestBody) - const localVarPath = `/work-items/{id}/submit-account-selection` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkItemsApi - functional programming interface - * @export - */ -export const WorkItemsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkItemsApiAxiosParamCreator(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.approveApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async approveApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.approveApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {string} id The ID of the work item - * @param {string | null} [body] Body is the request payload to create form definition request - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async completeWorkItem(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItem(id, body, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.completeWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCompletedWorkItems(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItems(ownerId, limit, offset, count, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.getCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountCompletedWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.getCountCompletedWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getCountWorkItems(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItems(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.getCountWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {string} id ID of the work item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItem(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItem(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.getWorkItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkItemsSummary(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummary(ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.getWorkItemsSummary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {string} [ownerId] ID of the work item owner. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkItems(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItems(limit, offset, count, ownerId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.listWorkItems']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {string} id The ID of the work item - * @param {string} approvalItemId The ID of the approval item. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItem(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItem(id, approvalItemId, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.rejectApprovalItem']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {string} id The ID of the work item - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async rejectApprovalItemsInBulk(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulk(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.rejectApprovalItemsInBulk']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. - * @summary Forward a work item - * @param {string} id The ID of the work item - * @param {WorkItemForward} workItemForward - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async sendWorkItemForward(id: string, workItemForward: WorkItemForward, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendWorkItemForward(id, workItemForward, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.sendWorkItemForward']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {string} id The ID of the work item - * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async submitAccountSelection(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelection(id, requestBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkItemsApi.submitAccountSelection']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkItemsApi - factory interface - * @export - */ -export const WorkItemsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkItemsApiFp(configuration) - return { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItem(requestParameters: WorkItemsApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - approveApprovalItemsInBulk(requestParameters: WorkItemsApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - completeWorkItem(requestParameters: WorkItemsApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCompletedWorkItems(requestParameters: WorkItemsApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountCompletedWorkItems(requestParameters: WorkItemsApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getCountWorkItems(requestParameters: WorkItemsApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItem(requestParameters: WorkItemsApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItem(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkItemsSummary(requestParameters: WorkItemsApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkItems(requestParameters: WorkItemsApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItem(requestParameters: WorkItemsApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - rejectApprovalItemsInBulk(requestParameters: WorkItemsApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. - * @summary Forward a work item - * @param {WorkItemsApiSendWorkItemForwardRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - sendWorkItemForward(requestParameters: WorkItemsApiSendWorkItemForwardRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.sendWorkItemForward(requestParameters.id, requestParameters.workItemForward, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - submitAccountSelection(requestParameters: WorkItemsApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for approveApprovalItem operation in WorkItemsApi. - * @export - * @interface WorkItemsApiApproveApprovalItemRequest - */ -export interface WorkItemsApiApproveApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiApproveApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsApiApproveApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for approveApprovalItemsInBulk operation in WorkItemsApi. - * @export - * @interface WorkItemsApiApproveApprovalItemsInBulkRequest - */ -export interface WorkItemsApiApproveApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiApproveApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for completeWorkItem operation in WorkItemsApi. - * @export - * @interface WorkItemsApiCompleteWorkItemRequest - */ -export interface WorkItemsApiCompleteWorkItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiCompleteWorkItem - */ - readonly id: string - - /** - * Body is the request payload to create form definition request - * @type {string} - * @memberof WorkItemsApiCompleteWorkItem - */ - readonly body?: string | null -} - -/** - * Request parameters for getCompletedWorkItems operation in WorkItemsApi. - * @export - * @interface WorkItemsApiGetCompletedWorkItemsRequest - */ -export interface WorkItemsApiGetCompletedWorkItemsRequest { - /** - * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - * @type {string} - * @memberof WorkItemsApiGetCompletedWorkItems - */ - readonly ownerId?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsApiGetCompletedWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsApiGetCompletedWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsApiGetCompletedWorkItems - */ - readonly count?: boolean -} - -/** - * Request parameters for getCountCompletedWorkItems operation in WorkItemsApi. - * @export - * @interface WorkItemsApiGetCountCompletedWorkItemsRequest - */ -export interface WorkItemsApiGetCountCompletedWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsApiGetCountCompletedWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getCountWorkItems operation in WorkItemsApi. - * @export - * @interface WorkItemsApiGetCountWorkItemsRequest - */ -export interface WorkItemsApiGetCountWorkItemsRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsApiGetCountWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for getWorkItem operation in WorkItemsApi. - * @export - * @interface WorkItemsApiGetWorkItemRequest - */ -export interface WorkItemsApiGetWorkItemRequest { - /** - * ID of the work item. - * @type {string} - * @memberof WorkItemsApiGetWorkItem - */ - readonly id: string -} - -/** - * Request parameters for getWorkItemsSummary operation in WorkItemsApi. - * @export - * @interface WorkItemsApiGetWorkItemsSummaryRequest - */ -export interface WorkItemsApiGetWorkItemsSummaryRequest { - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsApiGetWorkItemsSummary - */ - readonly ownerId?: string -} - -/** - * Request parameters for listWorkItems operation in WorkItemsApi. - * @export - * @interface WorkItemsApiListWorkItemsRequest - */ -export interface WorkItemsApiListWorkItemsRequest { - /** - * 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 WorkItemsApiListWorkItems - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkItemsApiListWorkItems - */ - readonly offset?: number - - /** - * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {boolean} - * @memberof WorkItemsApiListWorkItems - */ - readonly count?: boolean - - /** - * ID of the work item owner. - * @type {string} - * @memberof WorkItemsApiListWorkItems - */ - readonly ownerId?: string -} - -/** - * Request parameters for rejectApprovalItem operation in WorkItemsApi. - * @export - * @interface WorkItemsApiRejectApprovalItemRequest - */ -export interface WorkItemsApiRejectApprovalItemRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiRejectApprovalItem - */ - readonly id: string - - /** - * The ID of the approval item. - * @type {string} - * @memberof WorkItemsApiRejectApprovalItem - */ - readonly approvalItemId: string -} - -/** - * Request parameters for rejectApprovalItemsInBulk operation in WorkItemsApi. - * @export - * @interface WorkItemsApiRejectApprovalItemsInBulkRequest - */ -export interface WorkItemsApiRejectApprovalItemsInBulkRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiRejectApprovalItemsInBulk - */ - readonly id: string -} - -/** - * Request parameters for sendWorkItemForward operation in WorkItemsApi. - * @export - * @interface WorkItemsApiSendWorkItemForwardRequest - */ -export interface WorkItemsApiSendWorkItemForwardRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiSendWorkItemForward - */ - readonly id: string - - /** - * - * @type {WorkItemForward} - * @memberof WorkItemsApiSendWorkItemForward - */ - readonly workItemForward: WorkItemForward -} - -/** - * Request parameters for submitAccountSelection operation in WorkItemsApi. - * @export - * @interface WorkItemsApiSubmitAccountSelectionRequest - */ -export interface WorkItemsApiSubmitAccountSelectionRequest { - /** - * The ID of the work item - * @type {string} - * @memberof WorkItemsApiSubmitAccountSelection - */ - readonly id: string - - /** - * Account Selection Data map, keyed on fieldName - * @type {{ [key: string]: any; }} - * @memberof WorkItemsApiSubmitAccountSelection - */ - readonly requestBody: { [key: string]: any; } -} - -/** - * WorkItemsApi - object-oriented interface - * @export - * @class WorkItemsApi - * @extends {BaseAPI} - */ -export class WorkItemsApi extends BaseAPI { - /** - * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Approve an approval item - * @param {WorkItemsApiApproveApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public approveApprovalItem(requestParameters: WorkItemsApiApproveApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).approveApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk approve approval items - * @param {WorkItemsApiApproveApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public approveApprovalItemsInBulk(requestParameters: WorkItemsApiApproveApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).approveApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API completes a work item. Either an admin, or the owning/current user must make this request. - * @summary Complete a work item - * @param {WorkItemsApiCompleteWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public completeWorkItem(requestParameters: WorkItemsApiCompleteWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).completeWorkItem(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Completed work items - * @param {WorkItemsApiGetCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public getCompletedWorkItems(requestParameters: WorkItemsApiGetCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).getCompletedWorkItems(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - * @summary Count completed work items - * @param {WorkItemsApiGetCountCompletedWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public getCountCompletedWorkItems(requestParameters: WorkItemsApiGetCountCompletedWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).getCountCompletedWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a count of work items belonging to either the specified user(admin required), or the current user. - * @summary Count work items - * @param {WorkItemsApiGetCountWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public getCountWorkItems(requestParameters: WorkItemsApiGetCountWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).getCountWorkItems(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - * @summary Get a work item - * @param {WorkItemsApiGetWorkItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public getWorkItem(requestParameters: WorkItemsApiGetWorkItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).getWorkItem(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a summary of work items belonging to either the specified user(admin required), or the current user. - * @summary Work items summary - * @param {WorkItemsApiGetWorkItemsSummaryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public getWorkItemsSummary(requestParameters: WorkItemsApiGetWorkItemsSummaryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).getWorkItemsSummary(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This gets a collection of work items belonging to either the specified user(admin required), or the current user. - * @summary List work items - * @param {WorkItemsApiListWorkItemsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public listWorkItems(requestParameters: WorkItemsApiListWorkItemsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).listWorkItems(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - * @summary Reject an approval item - * @param {WorkItemsApiRejectApprovalItemRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public rejectApprovalItem(requestParameters: WorkItemsApiRejectApprovalItemRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).rejectApprovalItem(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - * @summary Bulk reject approval items - * @param {WorkItemsApiRejectApprovalItemsInBulkRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public rejectApprovalItemsInBulk(requestParameters: WorkItemsApiRejectApprovalItemsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).rejectApprovalItemsInBulk(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. - * @summary Forward a work item - * @param {WorkItemsApiSendWorkItemForwardRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public sendWorkItemForward(requestParameters: WorkItemsApiSendWorkItemForwardRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).sendWorkItemForward(requestParameters.id, requestParameters.workItemForward, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This API submits account selections. Either an admin, or the owning/current user must make this request. - * @summary Submit account selections - * @param {WorkItemsApiSubmitAccountSelectionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkItemsApi - */ - public submitAccountSelection(requestParameters: WorkItemsApiSubmitAccountSelectionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkItemsApiFp(this.configuration).submitAccountSelection(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * WorkflowsApi - axios parameter creator - * @export - */ -export const WorkflowsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancelWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{id}/cancel` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequest} [createExternalExecuteWorkflowRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow: async (id: string, createExternalExecuteWorkflowRequest?: CreateExternalExecuteWorkflowRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createExternalExecuteWorkflowRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequest} createWorkflowRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow: async (createWorkflowRequest: CreateWorkflowRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'createWorkflowRequest' is not null or undefined - assertParamExists('createWorkflow', 'createWorkflowRequest', createWorkflowRequest) - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(createWorkflowRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('createWorkflowExternalTrigger', 'id', id) - const localVarPath = `/workflows/{id}/external/oauth-clients` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {boolean} [workflowMetrics] disable workflow metrics - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow: async (id: string, workflowMetrics?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflow', 'id', id) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (workflowMetrics !== undefined) { - localVarQueryParameter['workflowMetrics'] = workflowMetrics; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecution', 'id', id) - const localVarPath = `/workflow-executions/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkflowExecutionHistory: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutionHistory', 'id', id) - const localVarPath = `/workflow-executions/{id}/history` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getWorkflowExecutions', 'id', id) - const localVarPath = `/workflows/{id}/executions` - .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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/actions`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/operators`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflow-library/triggers`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - 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, - }; - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @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: **modified, name** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows: async (filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/workflows`; - // 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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - if (filters !== undefined) { - localVarQueryParameter['filters'] = filters; - } - - if (sorters !== undefined) { - localVarQueryParameter['sorters'] = sorters; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('patchWorkflow', 'id', id) - // verify required parameter 'jsonPatchOperation' is not null or undefined - assertParamExists('patchWorkflow', 'jsonPatchOperation', jsonPatchOperation) - const localVarPath = `/workflows/{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; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - 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, - }; - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBody} workflowBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow: async (id: string, workflowBody: WorkflowBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('putWorkflow', 'id', id) - // verify required parameter 'workflowBody' is not null or undefined - assertParamExists('putWorkflow', 'workflowBody', workflowBody) - const localVarPath = `/workflows/{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: 'PUT', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(workflowBody, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequest} [testExternalExecuteWorkflowRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow: async (id: string, testExternalExecuteWorkflowRequest?: TestExternalExecuteWorkflowRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testExternalExecuteWorkflow', 'id', id) - const localVarPath = `/workflows/execute/external/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication applicationAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "applicationAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testExternalExecuteWorkflowRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** This endpoint has a rate limit of 5 requests per 10 seconds. - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequest} testWorkflowRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow: async (id: string, testWorkflowRequest: TestWorkflowRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testWorkflow', 'id', id) - // verify required parameter 'testWorkflowRequest' is not null or undefined - assertParamExists('testWorkflow', 'testWorkflowRequest', testWorkflowRequest) - const localVarPath = `/workflows/{id}/test` - .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: 'POST', ...baseOptions, ...axiosOptions}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - // authentication userAuth required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(testWorkflowRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - axiosOptions: localVarRequestOptions, - }; - }, - } -}; - -/** - * WorkflowsApi - functional programming interface - * @export - */ -export const WorkflowsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WorkflowsApiAxiosParamCreator(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {string} id The workflow execution ID - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async cancelWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.cancelWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {string} id Id of the workflow - * @param {CreateExternalExecuteWorkflowRequest} [createExternalExecuteWorkflowRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createExternalExecuteWorkflow(id: string, createExternalExecuteWorkflowRequest?: CreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createExternalExecuteWorkflow(id, createExternalExecuteWorkflowRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.createExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {CreateWorkflowRequest} createWorkflowRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflow(createWorkflowRequest: CreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflow(createWorkflowRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.createWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {string} id Id of the workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async createWorkflowExternalTrigger(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowExternalTrigger(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.createWorkflowExternalTrigger']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {string} id Id of the Workflow - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async deleteWorkflow(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflow(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.deleteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {string} id Id of the workflow - * @param {boolean} [workflowMetrics] disable workflow metrics - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflow(id: string, workflowMetrics?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflow(id, workflowMetrics, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {string} id Workflow execution ID. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecution(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecution(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getWorkflowExecution']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {string} id Id of the workflow execution - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async getWorkflowExecutionHistory(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistory(id, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getWorkflowExecutionHistory']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {string} id Workflow ID. - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async getWorkflowExecutions(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutions(id, limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.getWorkflowExecutions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listCompleteWorkflowLibrary(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibrary(limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listCompleteWorkflowLibrary']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryActions(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActions(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listWorkflowLibraryActions']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperators(axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listWorkflowLibraryOperators']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {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* **type**: *eq* - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflowLibraryTriggers(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggers(limit, offset, filters, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listWorkflowLibraryTriggers']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @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: **modified, name** - * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async listWorkflows(filters?: string, sorters?: string, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflows(filters, sorters, limit, offset, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.listWorkflows']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {string} id Id of the Workflow - * @param {Array} jsonPatchOperation - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async patchWorkflow(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflow(id, jsonPatchOperation, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.patchWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {string} id Id of the Workflow - * @param {WorkflowBody} workflowBody - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async putWorkflow(id: string, workflowBody: WorkflowBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflow(id, workflowBody, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.putWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {string} id Id of the workflow - * @param {TestExternalExecuteWorkflowRequest} [testExternalExecuteWorkflowRequest] - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testExternalExecuteWorkflow(id: string, testExternalExecuteWorkflowRequest?: TestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflow(id, testExternalExecuteWorkflowRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.testExternalExecuteWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** This endpoint has a rate limit of 5 requests per 10 seconds. - * @summary Test workflow by id - * @param {string} id Id of the workflow - * @param {TestWorkflowRequest} testWorkflowRequest - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - async testWorkflow(id: string, testWorkflowRequest: TestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflow(id, testWorkflowRequest, axiosOptions); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['WorkflowsApi.testWorkflow']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); - }, - } -}; - -/** - * WorkflowsApi - factory interface - * @export - */ -export const WorkflowsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WorkflowsApiFp(configuration) - return { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - cancelWorkflowExecution(requestParameters: WorkflowsApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createExternalExecuteWorkflow(requestParameters: WorkflowsApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflow(requestParameters: WorkflowsApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflow(requestParameters.createWorkflowRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - createWorkflowExternalTrigger(requestParameters: WorkflowsApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - deleteWorkflow(requestParameters: WorkflowsApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflow(requestParameters: WorkflowsApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecution(requestParameters: WorkflowsApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - getWorkflowExecutionHistory(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - getWorkflowExecutions(requestParameters: WorkflowsApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listCompleteWorkflowLibrary(requestParameters: WorkflowsApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryActions(requestParameters: WorkflowsApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryOperators(axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflowLibraryTriggers(requestParameters: WorkflowsApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {WorkflowsApiListWorkflowsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - listWorkflows(requestParameters: WorkflowsApiListWorkflowsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.listWorkflows(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - patchWorkflow(requestParameters: WorkflowsApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - putWorkflow(requestParameters: WorkflowsApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.putWorkflow(requestParameters.id, requestParameters.workflowBody, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testExternalExecuteWorkflow(requestParameters: WorkflowsApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** This endpoint has a rate limit of 5 requests per 10 seconds. - * @summary Test workflow by id - * @param {WorkflowsApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - */ - testWorkflow(requestParameters: WorkflowsApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testWorkflow(requestParameters.id, requestParameters.testWorkflowRequest, axiosOptions).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for cancelWorkflowExecution operation in WorkflowsApi. - * @export - * @interface WorkflowsApiCancelWorkflowExecutionRequest - */ -export interface WorkflowsApiCancelWorkflowExecutionRequest { - /** - * The workflow execution ID - * @type {string} - * @memberof WorkflowsApiCancelWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for createExternalExecuteWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiCreateExternalExecuteWorkflowRequest - */ -export interface WorkflowsApiCreateExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsApiCreateExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {CreateExternalExecuteWorkflowRequest} - * @memberof WorkflowsApiCreateExternalExecuteWorkflow - */ - readonly createExternalExecuteWorkflowRequest?: CreateExternalExecuteWorkflowRequest -} - -/** - * Request parameters for createWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiCreateWorkflowRequest - */ -export interface WorkflowsApiCreateWorkflowRequest { - /** - * - * @type {CreateWorkflowRequest} - * @memberof WorkflowsApiCreateWorkflow - */ - readonly createWorkflowRequest: CreateWorkflowRequest -} - -/** - * Request parameters for createWorkflowExternalTrigger operation in WorkflowsApi. - * @export - * @interface WorkflowsApiCreateWorkflowExternalTriggerRequest - */ -export interface WorkflowsApiCreateWorkflowExternalTriggerRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsApiCreateWorkflowExternalTrigger - */ - readonly id: string -} - -/** - * Request parameters for deleteWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiDeleteWorkflowRequest - */ -export interface WorkflowsApiDeleteWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsApiDeleteWorkflow - */ - readonly id: string -} - -/** - * Request parameters for getWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiGetWorkflowRequest - */ -export interface WorkflowsApiGetWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsApiGetWorkflow - */ - readonly id: string - - /** - * disable workflow metrics - * @type {boolean} - * @memberof WorkflowsApiGetWorkflow - */ - readonly workflowMetrics?: boolean -} - -/** - * Request parameters for getWorkflowExecution operation in WorkflowsApi. - * @export - * @interface WorkflowsApiGetWorkflowExecutionRequest - */ -export interface WorkflowsApiGetWorkflowExecutionRequest { - /** - * Workflow execution ID. - * @type {string} - * @memberof WorkflowsApiGetWorkflowExecution - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutionHistory operation in WorkflowsApi. - * @export - * @interface WorkflowsApiGetWorkflowExecutionHistoryRequest - */ -export interface WorkflowsApiGetWorkflowExecutionHistoryRequest { - /** - * Id of the workflow execution - * @type {string} - * @memberof WorkflowsApiGetWorkflowExecutionHistory - */ - readonly id: string -} - -/** - * Request parameters for getWorkflowExecutions operation in WorkflowsApi. - * @export - * @interface WorkflowsApiGetWorkflowExecutionsRequest - */ -export interface WorkflowsApiGetWorkflowExecutionsRequest { - /** - * Workflow ID. - * @type {string} - * @memberof WorkflowsApiGetWorkflowExecutions - */ - readonly id: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiGetWorkflowExecutions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiGetWorkflowExecutions - */ - readonly offset?: number - - /** - * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* - * @type {string} - * @memberof WorkflowsApiGetWorkflowExecutions - */ - readonly filters?: string -} - -/** - * Request parameters for listCompleteWorkflowLibrary operation in WorkflowsApi. - * @export - * @interface WorkflowsApiListCompleteWorkflowLibraryRequest - */ -export interface WorkflowsApiListCompleteWorkflowLibraryRequest { - /** - * 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 WorkflowsApiListCompleteWorkflowLibrary - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiListCompleteWorkflowLibrary - */ - readonly offset?: number -} - -/** - * Request parameters for listWorkflowLibraryActions operation in WorkflowsApi. - * @export - * @interface WorkflowsApiListWorkflowLibraryActionsRequest - */ -export interface WorkflowsApiListWorkflowLibraryActionsRequest { - /** - * 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 WorkflowsApiListWorkflowLibraryActions - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiListWorkflowLibraryActions - */ - readonly offset?: number - - /** - * 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* - * @type {string} - * @memberof WorkflowsApiListWorkflowLibraryActions - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflowLibraryTriggers operation in WorkflowsApi. - * @export - * @interface WorkflowsApiListWorkflowLibraryTriggersRequest - */ -export interface WorkflowsApiListWorkflowLibraryTriggersRequest { - /** - * 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 WorkflowsApiListWorkflowLibraryTriggers - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiListWorkflowLibraryTriggers - */ - readonly offset?: number - - /** - * 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* **type**: *eq* - * @type {string} - * @memberof WorkflowsApiListWorkflowLibraryTriggers - */ - readonly filters?: string -} - -/** - * Request parameters for listWorkflows operation in WorkflowsApi. - * @export - * @interface WorkflowsApiListWorkflowsRequest - */ -export interface WorkflowsApiListWorkflowsRequest { - /** - * 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: **enabled**: *eq* **connectorInstanceId**: *eq* **triggerId**: *eq* - * @type {string} - * @memberof WorkflowsApiListWorkflows - */ - 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: **modified, name** - * @type {string} - * @memberof WorkflowsApiListWorkflows - */ - readonly sorters?: string - - /** - * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiListWorkflows - */ - readonly limit?: number - - /** - * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - * @type {number} - * @memberof WorkflowsApiListWorkflows - */ - readonly offset?: number -} - -/** - * Request parameters for patchWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiPatchWorkflowRequest - */ -export interface WorkflowsApiPatchWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsApiPatchWorkflow - */ - readonly id: string - - /** - * - * @type {Array} - * @memberof WorkflowsApiPatchWorkflow - */ - readonly jsonPatchOperation: Array -} - -/** - * Request parameters for putWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiPutWorkflowRequest - */ -export interface WorkflowsApiPutWorkflowRequest { - /** - * Id of the Workflow - * @type {string} - * @memberof WorkflowsApiPutWorkflow - */ - readonly id: string - - /** - * - * @type {WorkflowBody} - * @memberof WorkflowsApiPutWorkflow - */ - readonly workflowBody: WorkflowBody -} - -/** - * Request parameters for testExternalExecuteWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiTestExternalExecuteWorkflowRequest - */ -export interface WorkflowsApiTestExternalExecuteWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsApiTestExternalExecuteWorkflow - */ - readonly id: string - - /** - * - * @type {TestExternalExecuteWorkflowRequest} - * @memberof WorkflowsApiTestExternalExecuteWorkflow - */ - readonly testExternalExecuteWorkflowRequest?: TestExternalExecuteWorkflowRequest -} - -/** - * Request parameters for testWorkflow operation in WorkflowsApi. - * @export - * @interface WorkflowsApiTestWorkflowRequest - */ -export interface WorkflowsApiTestWorkflowRequest { - /** - * Id of the workflow - * @type {string} - * @memberof WorkflowsApiTestWorkflow - */ - readonly id: string - - /** - * - * @type {TestWorkflowRequest} - * @memberof WorkflowsApiTestWorkflow - */ - readonly testWorkflowRequest: TestWorkflowRequest -} - -/** - * WorkflowsApi - object-oriented interface - * @export - * @class WorkflowsApi - * @extends {BaseAPI} - */ -export class WorkflowsApi extends BaseAPI { - /** - * Use this API to cancel a running workflow execution. - * @summary Cancel workflow execution by id - * @param {WorkflowsApiCancelWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public cancelWorkflowExecution(requestParameters: WorkflowsApiCancelWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).cancelWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - * @summary Execute workflow via external trigger - * @param {WorkflowsApiCreateExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public createExternalExecuteWorkflow(requestParameters: WorkflowsApiCreateExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).createExternalExecuteWorkflow(requestParameters.id, requestParameters.createExternalExecuteWorkflowRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create a new workflow with the desired trigger and steps specified in the request body. - * @summary Create workflow - * @param {WorkflowsApiCreateWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public createWorkflow(requestParameters: WorkflowsApiCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).createWorkflow(requestParameters.createWorkflowRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - * @summary Generate external trigger oauth client - * @param {WorkflowsApiCreateWorkflowExternalTriggerRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public createWorkflowExternalTrigger(requestParameters: WorkflowsApiCreateWorkflowExternalTriggerRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).createWorkflowExternalTrigger(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - * @summary Delete workflow by id - * @param {WorkflowsApiDeleteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public deleteWorkflow(requestParameters: WorkflowsApiDeleteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).deleteWorkflow(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow by id. - * @summary Get workflow by id - * @param {WorkflowsApiGetWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public getWorkflow(requestParameters: WorkflowsApiGetWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).getWorkflow(requestParameters.id, requestParameters.workflowMetrics, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. - * @summary Get workflow execution - * @param {WorkflowsApiGetWorkflowExecutionRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public getWorkflowExecution(requestParameters: WorkflowsApiGetWorkflowExecutionRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).getWorkflowExecution(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * [Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found. - * @summary Get workflow execution history - * @param {WorkflowsApiGetWorkflowExecutionHistoryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public getWorkflowExecutionHistory(requestParameters: WorkflowsApiGetWorkflowExecutionHistoryRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).getWorkflowExecutionHistory(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - * @summary List workflow executions - * @param {WorkflowsApiGetWorkflowExecutionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public getWorkflowExecutions(requestParameters: WorkflowsApiGetWorkflowExecutionsRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).getWorkflowExecutions(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists all triggers, actions, and operators in the library - * @summary List complete workflow library - * @param {WorkflowsApiListCompleteWorkflowLibraryRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public listCompleteWorkflowLibrary(requestParameters: WorkflowsApiListCompleteWorkflowLibraryRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).listCompleteWorkflowLibrary(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow actions available to you. - * @summary List workflow library actions - * @param {WorkflowsApiListWorkflowLibraryActionsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public listWorkflowLibraryActions(requestParameters: WorkflowsApiListWorkflowLibraryActionsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).listWorkflowLibraryActions(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow operators available to you - * @summary List workflow library operators - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public listWorkflowLibraryOperators(axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).listWorkflowLibraryOperators(axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * This lists the workflow triggers available to you - * @summary List workflow library triggers - * @param {WorkflowsApiListWorkflowLibraryTriggersRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public listWorkflowLibraryTriggers(requestParameters: WorkflowsApiListWorkflowLibraryTriggersRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).listWorkflowLibraryTriggers(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * List all workflows in the tenant. - * @summary List workflows - * @param {WorkflowsApiListWorkflowsRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public listWorkflows(requestParameters: WorkflowsApiListWorkflowsRequest = {}, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).listWorkflows(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - * @summary Patch workflow - * @param {WorkflowsApiPatchWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public patchWorkflow(requestParameters: WorkflowsApiPatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).patchWorkflow(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Perform a full update of a workflow. The updated workflow object is returned in the response. - * @summary Update workflow - * @param {WorkflowsApiPutWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public putWorkflow(requestParameters: WorkflowsApiPutWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).putWorkflow(requestParameters.id, requestParameters.workflowBody, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - * @summary Test workflow via external trigger - * @param {WorkflowsApiTestExternalExecuteWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public testExternalExecuteWorkflow(requestParameters: WorkflowsApiTestExternalExecuteWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).testExternalExecuteWorkflow(requestParameters.id, requestParameters.testExternalExecuteWorkflowRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } - - /** - * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** This endpoint has a rate limit of 5 requests per 10 seconds. - * @summary Test workflow by id - * @param {WorkflowsApiTestWorkflowRequest} requestParameters Request parameters. - * @param {*} [axiosOptions] Override http request option. - * @throws {RequiredError} - * @memberof WorkflowsApi - */ - public testWorkflow(requestParameters: WorkflowsApiTestWorkflowRequest, axiosOptions?: RawAxiosRequestConfig) { - return WorkflowsApiFp(this.configuration).testWorkflow(requestParameters.id, requestParameters.testWorkflowRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); - } -} - - - diff --git a/sdk-output/v3/package.json b/sdk-output/v3/package.json deleted file mode 100644 index 4332abe8..00000000 --- a/sdk-output/v3/package.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "name": "sailpoint-sdk", - "version": "1.8.69", - "description": "OpenAPI client for sailpoint-sdk", - "author": "OpenAPI-Generator Contributors", - "repository": { - "type": "git", - "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" - }, - "keywords": [ - "axios", - "typescript", - "openapi-client", - "openapi-generator", - "sailpoint-sdk" - ], - "license": "Unlicense", - "main": "./dist/index.js", - "typings": "./dist/index.d.ts", - "scripts": { - "build": "tsc", - "prepare": "npm run build" - }, - "dependencies": { - "axios": "^1.6.1" - }, - "devDependencies": { - "@types/node": "12.11.5 - 12.20.42", - "typescript": "^4.0 || ^5.0" - }, - "publishConfig": { - "registry": "sailpoint.com" - } -} diff --git a/sdk-output/work_items/.gitignore b/sdk-output/work_items/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/work_items/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/work_items/.npmignore b/sdk-output/work_items/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/work_items/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/work_items/.openapi-generator-ignore b/sdk-output/work_items/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/work_items/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/work_items/.openapi-generator/FILES b/sdk-output/work_items/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/work_items/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/work_items/.openapi-generator/VERSION b/sdk-output/work_items/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/work_items/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/work_items/.sdk-partition b/sdk-output/work_items/.sdk-partition new file mode 100644 index 00000000..b0a25990 --- /dev/null +++ b/sdk-output/work_items/.sdk-partition @@ -0,0 +1 @@ +work-items \ No newline at end of file diff --git a/sdk-output/work_items/README.md b/sdk-output/work_items/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/work_items/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/work_items/api.ts b/sdk-output/work_items/api.ts new file mode 100644 index 00000000..768532a8 --- /dev/null +++ b/sdk-output/work_items/api.ts @@ -0,0 +1,1859 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Items + * 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 ApprovalitemdetailsV1 + */ +export interface ApprovalitemdetailsV1 { + /** + * The approval item\'s ID + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'id'?: string; + /** + * The account referenced by the approval item + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'account'?: string | null; + /** + * The name of the application/source + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'application'?: string; + /** + * The attribute\'s name + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'name'?: string | null; + /** + * The attribute\'s operation + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'operation'?: string; + /** + * The attribute\'s value + * @type {string} + * @memberof ApprovalitemdetailsV1 + */ + 'value'?: string | null; + /** + * + * @type {WorkitemstateV1} + * @memberof ApprovalitemdetailsV1 + */ + 'state'?: WorkitemstateV1; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * + * @export + * @interface FormdetailsV1 + */ +export interface FormdetailsV1 { + /** + * ID of the form + * @type {string} + * @memberof FormdetailsV1 + */ + 'id'?: string | null; + /** + * Name of the form + * @type {string} + * @memberof FormdetailsV1 + */ + 'name'?: string | null; + /** + * The form title + * @type {string} + * @memberof FormdetailsV1 + */ + 'title'?: string | null; + /** + * The form subtitle. + * @type {string} + * @memberof FormdetailsV1 + */ + 'subtitle'?: string | null; + /** + * The name of the user that should be shown this form + * @type {string} + * @memberof FormdetailsV1 + */ + 'targetUser'?: string; + /** + * Sections of the form + * @type {Array} + * @memberof FormdetailsV1 + */ + 'sections'?: Array; +} +/** + * + * @export + * @interface FormitemdetailsV1 + */ +export interface FormitemdetailsV1 { + /** + * Name of the FormItem + * @type {string} + * @memberof FormitemdetailsV1 + */ + 'name'?: string | null; +} +/** + * + * @export + * @interface ListWorkItemsV1401ResponseV1 + */ +export interface ListWorkItemsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkItemsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListWorkItemsV1429ResponseV1 + */ +export interface ListWorkItemsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkItemsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface RemediationitemdetailsV1 + */ +export interface RemediationitemdetailsV1 { + /** + * The ID of the certification + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'id'?: string; + /** + * The ID of the certification target + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'targetId'?: string; + /** + * The name of the certification target + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'targetName'?: string; + /** + * The display name of the certification target + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'targetDisplayName'?: string; + /** + * The name of the application/source + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'applicationName'?: string; + /** + * The name of the attribute being certified + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'attributeName'?: string; + /** + * The operation of the certification on the attribute + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'attributeOperation'?: string; + /** + * The value of the attribute being certified + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'attributeValue'?: string; + /** + * The native identity of the target + * @type {string} + * @memberof RemediationitemdetailsV1 + */ + 'nativeIdentity'?: string; +} +/** + * + * @export + * @interface SectiondetailsV1 + */ +export interface SectiondetailsV1 { + /** + * Name of the FormItem + * @type {string} + * @memberof SectiondetailsV1 + */ + 'name'?: string | null; + /** + * Label of the section + * @type {string} + * @memberof SectiondetailsV1 + */ + 'label'?: string | null; + /** + * List of FormItems. FormItems can be SectionDetails and/or FieldDetails + * @type {Array} + * @memberof SectiondetailsV1 + */ + 'formItems'?: Array; +} +/** + * + * @export + * @interface WorkitemforwardV1 + */ +export interface WorkitemforwardV1 { + /** + * The ID of the identity to forward this work item to. + * @type {string} + * @memberof WorkitemforwardV1 + */ + 'targetOwnerId': string; + /** + * Comments to send to the target owner + * @type {string} + * @memberof WorkitemforwardV1 + */ + 'comment': string; + /** + * If true, send a notification to the target owner. + * @type {boolean} + * @memberof WorkitemforwardV1 + */ + 'sendNotifications'?: boolean; +} +/** + * + * @export + * @interface WorkitemsFormV1 + */ +export interface WorkitemsFormV1 { + /** + * ID of the form + * @type {string} + * @memberof WorkitemsFormV1 + */ + 'id'?: string | null; + /** + * Name of the form + * @type {string} + * @memberof WorkitemsFormV1 + */ + 'name'?: string | null; + /** + * The form title + * @type {string} + * @memberof WorkitemsFormV1 + */ + 'title'?: string | null; + /** + * The form subtitle. + * @type {string} + * @memberof WorkitemsFormV1 + */ + 'subtitle'?: string | null; + /** + * The name of the user that should be shown this form + * @type {string} + * @memberof WorkitemsFormV1 + */ + 'targetUser'?: string; + /** + * Sections of the form + * @type {Array} + * @memberof WorkitemsFormV1 + */ + 'sections'?: Array; +} +/** + * + * @export + * @interface WorkitemsV1 + */ +export interface WorkitemsV1 { + /** + * ID of the work item + * @type {string} + * @memberof WorkitemsV1 + */ + 'id'?: string; + /** + * ID of the requester + * @type {string} + * @memberof WorkitemsV1 + */ + 'requesterId'?: string | null; + /** + * The displayname of the requester + * @type {string} + * @memberof WorkitemsV1 + */ + 'requesterDisplayName'?: string | null; + /** + * The ID of the owner + * @type {string} + * @memberof WorkitemsV1 + */ + 'ownerId'?: string | null; + /** + * The name of the owner + * @type {string} + * @memberof WorkitemsV1 + */ + 'ownerName'?: string; + /** + * Time when the work item was created + * @type {string} + * @memberof WorkitemsV1 + */ + 'created'?: string; + /** + * Time when the work item was last updated + * @type {string} + * @memberof WorkitemsV1 + */ + 'modified'?: string | null; + /** + * The description of the work item + * @type {string} + * @memberof WorkitemsV1 + */ + 'description'?: string; + /** + * + * @type {WorkitemstatemanualworkitemsV1} + * @memberof WorkitemsV1 + */ + 'state'?: WorkitemstatemanualworkitemsV1; + /** + * + * @type {WorkitemtypemanualworkitemsV1} + * @memberof WorkitemsV1 + */ + 'type'?: WorkitemtypemanualworkitemsV1; + /** + * A list of remediation items + * @type {Array} + * @memberof WorkitemsV1 + */ + 'remediationItems'?: Array | null; + /** + * A list of items that need to be approved + * @type {Array} + * @memberof WorkitemsV1 + */ + 'approvalItems'?: Array | null; + /** + * The work item name + * @type {string} + * @memberof WorkitemsV1 + */ + 'name'?: string | null; + /** + * The time at which the work item completed + * @type {string} + * @memberof WorkitemsV1 + */ + 'completed'?: string | null; + /** + * The number of items in the work item + * @type {number} + * @memberof WorkitemsV1 + */ + 'numItems'?: number | null; + /** + * + * @type {WorkitemsFormV1} + * @memberof WorkitemsV1 + */ + 'form'?: WorkitemsFormV1; + /** + * An array of errors that ocurred during the work item + * @type {Array} + * @memberof WorkitemsV1 + */ + 'errors'?: Array; +} + + +/** + * + * @export + * @interface WorkitemscountV1 + */ +export interface WorkitemscountV1 { + /** + * The count of work items + * @type {number} + * @memberof WorkitemscountV1 + */ + 'count'?: number; +} +/** + * + * @export + * @interface WorkitemssummaryV1 + */ +export interface WorkitemssummaryV1 { + /** + * The count of open work items + * @type {number} + * @memberof WorkitemssummaryV1 + */ + 'open'?: number; + /** + * The count of completed work items + * @type {number} + * @memberof WorkitemssummaryV1 + */ + 'completed'?: number; + /** + * The count of total work items + * @type {number} + * @memberof WorkitemssummaryV1 + */ + 'total'?: number; +} +/** + * The state of a work item + * @export + * @enum {string} + */ + +export const WorkitemstateV1 = { + Finished: 'Finished', + Rejected: 'Rejected', + Returned: 'Returned', + Expired: 'Expired', + Pending: 'Pending', + Canceled: 'Canceled' +} as const; + +export type WorkitemstateV1 = typeof WorkitemstateV1[keyof typeof WorkitemstateV1]; + + +/** + * The state of a work item + * @export + * @enum {string} + */ + +export const WorkitemstatemanualworkitemsV1 = { + Finished: 'Finished', + Rejected: 'Rejected', + Returned: 'Returned', + Expired: 'Expired', + Pending: 'Pending', + Canceled: 'Canceled' +} as const; + +export type WorkitemstatemanualworkitemsV1 = typeof WorkitemstatemanualworkitemsV1[keyof typeof WorkitemstatemanualworkitemsV1]; + + +/** + * The type of the work item + * @export + * @enum {string} + */ + +export const WorkitemtypemanualworkitemsV1 = { + Generic: 'Generic', + Certification: 'Certification', + Remediation: 'Remediation', + Delegation: 'Delegation', + Approval: 'Approval', + ViolationReview: 'ViolationReview', + Form: 'Form', + PolicyVioloation: 'PolicyVioloation', + Challenge: 'Challenge', + ImpactAnalysis: 'ImpactAnalysis', + Signoff: 'Signoff', + Event: 'Event', + ManualAction: 'ManualAction', + Test: 'Test' +} as const; + +export type WorkitemtypemanualworkitemsV1 = typeof WorkitemtypemanualworkitemsV1[keyof typeof WorkitemtypemanualworkitemsV1]; + + + +/** + * WorkItemsV1Api - axios parameter creator + * @export + */ +export const WorkItemsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Approve an approval item + * @param {string} id The ID of the work item + * @param {string} approvalItemId The ID of the approval item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalItemV1: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('approveApprovalItemV1', 'id', id) + // verify required parameter 'approvalItemId' is not null or undefined + assertParamExists('approveApprovalItemV1', 'approvalItemId', approvalItemId) + const localVarPath = `/work-items/v1/{id}/approve/{approvalItemId}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk approve approval items + * @param {string} id The ID of the work item + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalItemsInBulkV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('approveApprovalItemsInBulkV1', 'id', id) + const localVarPath = `/work-items/v1/bulk-approve/{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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API completes a work item. Either an admin, or the owning/current user must make this request. + * @summary Complete a work item + * @param {string} id The ID of the work item + * @param {string | null} [body] Body is the request payload to create form definition request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeWorkItemV1: async (id: string, body?: string | null, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('completeWorkItemV1', 'id', id) + const localVarPath = `/work-items/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: '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(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + * @summary Forward a work item + * @param {string} id The ID of the work item + * @param {WorkitemforwardV1} workitemforwardV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + forwardWorkItemV1: async (id: string, workitemforwardV1: WorkitemforwardV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('forwardWorkItemV1', 'id', id) + // verify required parameter 'workitemforwardV1' is not null or undefined + assertParamExists('forwardWorkItemV1', 'workitemforwardV1', workitemforwardV1) + const localVarPath = `/work-items/v1/{id}/forward` + .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: '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(workitemforwardV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Completed work items + * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCompletedWorkItemsV1: async (ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/work-items/v1/completed`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['ownerId'] = ownerId; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Count completed work items + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCountCompletedWorkItemsV1: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/work-items/v1/completed/count`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['ownerId'] = ownerId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a count of work items belonging to either the specified user(admin required), or the current user. + * @summary Count work items + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCountWorkItemsV1: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/work-items/v1/count`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['ownerId'] = ownerId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + * @summary Get a work item + * @param {string} id ID of the work item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkItemV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkItemV1', 'id', id) + const localVarPath = `/work-items/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, + }; + }, + /** + * This gets a summary of work items belonging to either the specified user(admin required), or the current user. + * @summary Work items summary + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkItemsSummaryV1: async (ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/work-items/v1/summary`; + // 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 (ownerId !== undefined) { + localVarQueryParameter['ownerId'] = ownerId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This gets a collection of work items belonging to either the specified user(admin required), or the current user. + * @summary List work items + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkItemsV1: async (limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/work-items/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + if (ownerId !== undefined) { + localVarQueryParameter['ownerId'] = ownerId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Reject an approval item + * @param {string} id The ID of the work item + * @param {string} approvalItemId The ID of the approval item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalItemV1: async (id: string, approvalItemId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rejectApprovalItemV1', 'id', id) + // verify required parameter 'approvalItemId' is not null or undefined + assertParamExists('rejectApprovalItemV1', 'approvalItemId', approvalItemId) + const localVarPath = `/work-items/v1/{id}/reject/{approvalItemId}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"approvalItemId"}}`, encodeURIComponent(String(approvalItemId))); + // 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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk reject approval items + * @param {string} id The ID of the work item + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalItemsInBulkV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rejectApprovalItemsInBulkV1', 'id', id) + const localVarPath = `/work-items/v1/bulk-reject/{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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This API submits account selections. Either an admin, or the owning/current user must make this request. + * @summary Submit account selections + * @param {string} id The ID of the work item + * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitAccountSelectionV1: async (id: string, requestBody: { [key: string]: any; }, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('submitAccountSelectionV1', 'id', id) + // verify required parameter 'requestBody' is not null or undefined + assertParamExists('submitAccountSelectionV1', 'requestBody', requestBody) + const localVarPath = `/work-items/v1/{id}/submit-account-selection` + .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: '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(requestBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * WorkItemsV1Api - functional programming interface + * @export + */ +export const WorkItemsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = WorkItemsV1ApiAxiosParamCreator(configuration) + return { + /** + * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Approve an approval item + * @param {string} id The ID of the work item + * @param {string} approvalItemId The ID of the approval item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveApprovalItemV1(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemV1(id, approvalItemId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.approveApprovalItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk approve approval items + * @param {string} id The ID of the work item + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async approveApprovalItemsInBulkV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.approveApprovalItemsInBulkV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.approveApprovalItemsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API completes a work item. Either an admin, or the owning/current user must make this request. + * @summary Complete a work item + * @param {string} id The ID of the work item + * @param {string | null} [body] Body is the request payload to create form definition request + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async completeWorkItemV1(id: string, body?: string | null, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.completeWorkItemV1(id, body, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.completeWorkItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + * @summary Forward a work item + * @param {string} id The ID of the work item + * @param {WorkitemforwardV1} workitemforwardV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async forwardWorkItemV1(id: string, workitemforwardV1: WorkitemforwardV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.forwardWorkItemV1(id, workitemforwardV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.forwardWorkItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Completed work items + * @param {string} [ownerId] The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCompletedWorkItemsV1(ownerId?: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCompletedWorkItemsV1(ownerId, limit, offset, count, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.getCompletedWorkItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Count completed work items + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCountCompletedWorkItemsV1(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCountCompletedWorkItemsV1(ownerId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.getCountCompletedWorkItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a count of work items belonging to either the specified user(admin required), or the current user. + * @summary Count work items + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getCountWorkItemsV1(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCountWorkItemsV1(ownerId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.getCountWorkItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + * @summary Get a work item + * @param {string} id ID of the work item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkItemV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.getWorkItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a summary of work items belonging to either the specified user(admin required), or the current user. + * @summary Work items summary + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkItemsSummaryV1(ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkItemsSummaryV1(ownerId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.getWorkItemsSummaryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This gets a collection of work items belonging to either the specified user(admin required), or the current user. + * @summary List work items + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {string} [ownerId] ID of the work item owner. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkItemsV1(limit?: number, offset?: number, count?: boolean, ownerId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkItemsV1(limit, offset, count, ownerId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.listWorkItemsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Reject an approval item + * @param {string} id The ID of the work item + * @param {string} approvalItemId The ID of the approval item. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectApprovalItemV1(id: string, approvalItemId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemV1(id, approvalItemId, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.rejectApprovalItemV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk reject approval items + * @param {string} id The ID of the work item + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async rejectApprovalItemsInBulkV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejectApprovalItemsInBulkV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.rejectApprovalItemsInBulkV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This API submits account selections. Either an admin, or the owning/current user must make this request. + * @summary Submit account selections + * @param {string} id The ID of the work item + * @param {{ [key: string]: any; }} requestBody Account Selection Data map, keyed on fieldName + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async submitAccountSelectionV1(id: string, requestBody: { [key: string]: any; }, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.submitAccountSelectionV1(id, requestBody, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkItemsV1Api.submitAccountSelectionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * WorkItemsV1Api - factory interface + * @export + */ +export const WorkItemsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = WorkItemsV1ApiFp(configuration) + return { + /** + * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Approve an approval item + * @param {WorkItemsV1ApiApproveApprovalItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalItemV1(requestParameters: WorkItemsV1ApiApproveApprovalItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveApprovalItemV1(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk approve approval items + * @param {WorkItemsV1ApiApproveApprovalItemsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + approveApprovalItemsInBulkV1(requestParameters: WorkItemsV1ApiApproveApprovalItemsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.approveApprovalItemsInBulkV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API completes a work item. Either an admin, or the owning/current user must make this request. + * @summary Complete a work item + * @param {WorkItemsV1ApiCompleteWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + completeWorkItemV1(requestParameters: WorkItemsV1ApiCompleteWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.completeWorkItemV1(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + * @summary Forward a work item + * @param {WorkItemsV1ApiForwardWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + forwardWorkItemV1(requestParameters: WorkItemsV1ApiForwardWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.forwardWorkItemV1(requestParameters.id, requestParameters.workitemforwardV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Completed work items + * @param {WorkItemsV1ApiGetCompletedWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCompletedWorkItemsV1(requestParameters: WorkItemsV1ApiGetCompletedWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getCompletedWorkItemsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Count completed work items + * @param {WorkItemsV1ApiGetCountCompletedWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCountCompletedWorkItemsV1(requestParameters: WorkItemsV1ApiGetCountCompletedWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCountCompletedWorkItemsV1(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a count of work items belonging to either the specified user(admin required), or the current user. + * @summary Count work items + * @param {WorkItemsV1ApiGetCountWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getCountWorkItemsV1(requestParameters: WorkItemsV1ApiGetCountWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getCountWorkItemsV1(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + * @summary Get a work item + * @param {WorkItemsV1ApiGetWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkItemV1(requestParameters: WorkItemsV1ApiGetWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getWorkItemV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a summary of work items belonging to either the specified user(admin required), or the current user. + * @summary Work items summary + * @param {WorkItemsV1ApiGetWorkItemsSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkItemsSummaryV1(requestParameters: WorkItemsV1ApiGetWorkItemsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getWorkItemsSummaryV1(requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This gets a collection of work items belonging to either the specified user(admin required), or the current user. + * @summary List work items + * @param {WorkItemsV1ApiListWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkItemsV1(requestParameters: WorkItemsV1ApiListWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Reject an approval item + * @param {WorkItemsV1ApiRejectApprovalItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalItemV1(requestParameters: WorkItemsV1ApiRejectApprovalItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectApprovalItemV1(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk reject approval items + * @param {WorkItemsV1ApiRejectApprovalItemsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + rejectApprovalItemsInBulkV1(requestParameters: WorkItemsV1ApiRejectApprovalItemsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejectApprovalItemsInBulkV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This API submits account selections. Either an admin, or the owning/current user must make this request. + * @summary Submit account selections + * @param {WorkItemsV1ApiSubmitAccountSelectionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + submitAccountSelectionV1(requestParameters: WorkItemsV1ApiSubmitAccountSelectionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.submitAccountSelectionV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for approveApprovalItemV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiApproveApprovalItemV1Request + */ +export interface WorkItemsV1ApiApproveApprovalItemV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiApproveApprovalItemV1 + */ + readonly id: string + + /** + * The ID of the approval item. + * @type {string} + * @memberof WorkItemsV1ApiApproveApprovalItemV1 + */ + readonly approvalItemId: string +} + +/** + * Request parameters for approveApprovalItemsInBulkV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiApproveApprovalItemsInBulkV1Request + */ +export interface WorkItemsV1ApiApproveApprovalItemsInBulkV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiApproveApprovalItemsInBulkV1 + */ + readonly id: string +} + +/** + * Request parameters for completeWorkItemV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiCompleteWorkItemV1Request + */ +export interface WorkItemsV1ApiCompleteWorkItemV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiCompleteWorkItemV1 + */ + readonly id: string + + /** + * Body is the request payload to create form definition request + * @type {string} + * @memberof WorkItemsV1ApiCompleteWorkItemV1 + */ + readonly body?: string | null +} + +/** + * Request parameters for forwardWorkItemV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiForwardWorkItemV1Request + */ +export interface WorkItemsV1ApiForwardWorkItemV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiForwardWorkItemV1 + */ + readonly id: string + + /** + * + * @type {WorkitemforwardV1} + * @memberof WorkItemsV1ApiForwardWorkItemV1 + */ + readonly workitemforwardV1: WorkitemforwardV1 +} + +/** + * Request parameters for getCompletedWorkItemsV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiGetCompletedWorkItemsV1Request + */ +export interface WorkItemsV1ApiGetCompletedWorkItemsV1Request { + /** + * The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + * @type {string} + * @memberof WorkItemsV1ApiGetCompletedWorkItemsV1 + */ + readonly ownerId?: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkItemsV1ApiGetCompletedWorkItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkItemsV1ApiGetCompletedWorkItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof WorkItemsV1ApiGetCompletedWorkItemsV1 + */ + readonly count?: boolean +} + +/** + * Request parameters for getCountCompletedWorkItemsV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiGetCountCompletedWorkItemsV1Request + */ +export interface WorkItemsV1ApiGetCountCompletedWorkItemsV1Request { + /** + * ID of the work item owner. + * @type {string} + * @memberof WorkItemsV1ApiGetCountCompletedWorkItemsV1 + */ + readonly ownerId?: string +} + +/** + * Request parameters for getCountWorkItemsV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiGetCountWorkItemsV1Request + */ +export interface WorkItemsV1ApiGetCountWorkItemsV1Request { + /** + * ID of the work item owner. + * @type {string} + * @memberof WorkItemsV1ApiGetCountWorkItemsV1 + */ + readonly ownerId?: string +} + +/** + * Request parameters for getWorkItemV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiGetWorkItemV1Request + */ +export interface WorkItemsV1ApiGetWorkItemV1Request { + /** + * ID of the work item. + * @type {string} + * @memberof WorkItemsV1ApiGetWorkItemV1 + */ + readonly id: string +} + +/** + * Request parameters for getWorkItemsSummaryV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiGetWorkItemsSummaryV1Request + */ +export interface WorkItemsV1ApiGetWorkItemsSummaryV1Request { + /** + * ID of the work item owner. + * @type {string} + * @memberof WorkItemsV1ApiGetWorkItemsSummaryV1 + */ + readonly ownerId?: string +} + +/** + * Request parameters for listWorkItemsV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiListWorkItemsV1Request + */ +export interface WorkItemsV1ApiListWorkItemsV1Request { + /** + * 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 WorkItemsV1ApiListWorkItemsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkItemsV1ApiListWorkItemsV1 + */ + readonly offset?: number + + /** + * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {boolean} + * @memberof WorkItemsV1ApiListWorkItemsV1 + */ + readonly count?: boolean + + /** + * ID of the work item owner. + * @type {string} + * @memberof WorkItemsV1ApiListWorkItemsV1 + */ + readonly ownerId?: string +} + +/** + * Request parameters for rejectApprovalItemV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiRejectApprovalItemV1Request + */ +export interface WorkItemsV1ApiRejectApprovalItemV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiRejectApprovalItemV1 + */ + readonly id: string + + /** + * The ID of the approval item. + * @type {string} + * @memberof WorkItemsV1ApiRejectApprovalItemV1 + */ + readonly approvalItemId: string +} + +/** + * Request parameters for rejectApprovalItemsInBulkV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiRejectApprovalItemsInBulkV1Request + */ +export interface WorkItemsV1ApiRejectApprovalItemsInBulkV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiRejectApprovalItemsInBulkV1 + */ + readonly id: string +} + +/** + * Request parameters for submitAccountSelectionV1 operation in WorkItemsV1Api. + * @export + * @interface WorkItemsV1ApiSubmitAccountSelectionV1Request + */ +export interface WorkItemsV1ApiSubmitAccountSelectionV1Request { + /** + * The ID of the work item + * @type {string} + * @memberof WorkItemsV1ApiSubmitAccountSelectionV1 + */ + readonly id: string + + /** + * Account Selection Data map, keyed on fieldName + * @type {{ [key: string]: any; }} + * @memberof WorkItemsV1ApiSubmitAccountSelectionV1 + */ + readonly requestBody: { [key: string]: any; } +} + +/** + * WorkItemsV1Api - object-oriented interface + * @export + * @class WorkItemsV1Api + * @extends {BaseAPI} + */ +export class WorkItemsV1Api extends BaseAPI { + /** + * This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Approve an approval item + * @param {WorkItemsV1ApiApproveApprovalItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public approveApprovalItemV1(requestParameters: WorkItemsV1ApiApproveApprovalItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).approveApprovalItemV1(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk approve approval items + * @param {WorkItemsV1ApiApproveApprovalItemsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public approveApprovalItemsInBulkV1(requestParameters: WorkItemsV1ApiApproveApprovalItemsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).approveApprovalItemsInBulkV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API completes a work item. Either an admin, or the owning/current user must make this request. + * @summary Complete a work item + * @param {WorkItemsV1ApiCompleteWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public completeWorkItemV1(requestParameters: WorkItemsV1ApiCompleteWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).completeWorkItemV1(requestParameters.id, requestParameters.body, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + * @summary Forward a work item + * @param {WorkItemsV1ApiForwardWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public forwardWorkItemV1(requestParameters: WorkItemsV1ApiForwardWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).forwardWorkItemV1(requestParameters.id, requestParameters.workitemforwardV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Completed work items + * @param {WorkItemsV1ApiGetCompletedWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public getCompletedWorkItemsV1(requestParameters: WorkItemsV1ApiGetCompletedWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).getCompletedWorkItemsV1(requestParameters.ownerId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + * @summary Count completed work items + * @param {WorkItemsV1ApiGetCountCompletedWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public getCountCompletedWorkItemsV1(requestParameters: WorkItemsV1ApiGetCountCompletedWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).getCountCompletedWorkItemsV1(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a count of work items belonging to either the specified user(admin required), or the current user. + * @summary Count work items + * @param {WorkItemsV1ApiGetCountWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public getCountWorkItemsV1(requestParameters: WorkItemsV1ApiGetCountWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).getCountWorkItemsV1(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + * @summary Get a work item + * @param {WorkItemsV1ApiGetWorkItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public getWorkItemV1(requestParameters: WorkItemsV1ApiGetWorkItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).getWorkItemV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a summary of work items belonging to either the specified user(admin required), or the current user. + * @summary Work items summary + * @param {WorkItemsV1ApiGetWorkItemsSummaryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public getWorkItemsSummaryV1(requestParameters: WorkItemsV1ApiGetWorkItemsSummaryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).getWorkItemsSummaryV1(requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This gets a collection of work items belonging to either the specified user(admin required), or the current user. + * @summary List work items + * @param {WorkItemsV1ApiListWorkItemsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public listWorkItemsV1(requestParameters: WorkItemsV1ApiListWorkItemsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).listWorkItemsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.ownerId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + * @summary Reject an approval item + * @param {WorkItemsV1ApiRejectApprovalItemV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public rejectApprovalItemV1(requestParameters: WorkItemsV1ApiRejectApprovalItemV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).rejectApprovalItemV1(requestParameters.id, requestParameters.approvalItemId, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + * @summary Bulk reject approval items + * @param {WorkItemsV1ApiRejectApprovalItemsInBulkV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public rejectApprovalItemsInBulkV1(requestParameters: WorkItemsV1ApiRejectApprovalItemsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).rejectApprovalItemsInBulkV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This API submits account selections. Either an admin, or the owning/current user must make this request. + * @summary Submit account selections + * @param {WorkItemsV1ApiSubmitAccountSelectionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkItemsV1Api + */ + public submitAccountSelectionV1(requestParameters: WorkItemsV1ApiSubmitAccountSelectionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkItemsV1ApiFp(this.configuration).submitAccountSelectionV1(requestParameters.id, requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/work_items/base.ts b/sdk-output/work_items/base.ts new file mode 100644 index 00000000..88defd9c --- /dev/null +++ b/sdk-output/work_items/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Items + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/work_items/common.ts b/sdk-output/work_items/common.ts new file mode 100644 index 00000000..b538605a --- /dev/null +++ b/sdk-output/work_items/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Items + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/work_items/configuration.ts b/sdk-output/work_items/configuration.ts new file mode 100644 index 00000000..270545e3 --- /dev/null +++ b/sdk-output/work_items/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Items + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/work_items/git_push.sh b/sdk-output/work_items/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/work_items/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/work_items/index.ts b/sdk-output/work_items/index.ts new file mode 100644 index 00000000..0a74f061 --- /dev/null +++ b/sdk-output/work_items/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Items + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/work_items/package.json b/sdk-output/work_items/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/work_items/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/work_items/tsconfig.json b/sdk-output/work_items/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/work_items/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/work_reassignment/.gitignore b/sdk-output/work_reassignment/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/work_reassignment/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/work_reassignment/.npmignore b/sdk-output/work_reassignment/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/work_reassignment/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/work_reassignment/.openapi-generator-ignore b/sdk-output/work_reassignment/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/work_reassignment/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/work_reassignment/.openapi-generator/FILES b/sdk-output/work_reassignment/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/work_reassignment/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/work_reassignment/.openapi-generator/VERSION b/sdk-output/work_reassignment/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/work_reassignment/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/work_reassignment/.sdk-partition b/sdk-output/work_reassignment/.sdk-partition new file mode 100644 index 00000000..e15e504e --- /dev/null +++ b/sdk-output/work_reassignment/.sdk-partition @@ -0,0 +1 @@ +work-reassignment \ No newline at end of file diff --git a/sdk-output/work_reassignment/README.md b/sdk-output/work_reassignment/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/work_reassignment/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/work_reassignment/api.ts b/sdk-output/work_reassignment/api.ts new file mode 100644 index 00000000..03fdc9c1 --- /dev/null +++ b/sdk-output/work_reassignment/api.ts @@ -0,0 +1,1416 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Reassignment + * 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'; + +/** + * Audit details for the reassignment configuration of an identity + * @export + * @interface AuditdetailsV1 + */ +export interface AuditdetailsV1 { + /** + * Initial date and time when the record was created + * @type {string} + * @memberof AuditdetailsV1 + */ + 'created'?: string; + /** + * + * @type {Identity2V1} + * @memberof AuditdetailsV1 + */ + 'createdBy'?: Identity2V1; + /** + * Last modified date and time for the record + * @type {string} + * @memberof AuditdetailsV1 + */ + 'modified'?: string; + /** + * + * @type {Identity2V1} + * @memberof AuditdetailsV1 + */ + 'modifiedBy'?: Identity2V1; +} +/** + * Type of Reassignment Configuration. + * @export + * @interface ConfigtypeV1 + */ +export interface ConfigtypeV1 { + /** + * + * @type {number} + * @memberof ConfigtypeV1 + */ + 'priority'?: number; + /** + * + * @type {ConfigtypeenumcamelV1} + * @memberof ConfigtypeV1 + */ + 'internalName'?: ConfigtypeenumcamelV1; + /** + * + * @type {ConfigtypeenumV1} + * @memberof ConfigtypeV1 + */ + 'internalNameCamel'?: ConfigtypeenumV1; + /** + * Human readable display name of the type to be shown on UI + * @type {string} + * @memberof ConfigtypeV1 + */ + 'displayName'?: string; + /** + * Description of the type of work to be reassigned, displayed by the UI. + * @type {string} + * @memberof ConfigtypeV1 + */ + 'description'?: string; +} + + +/** + * Enum list of valid work types that can be selected for a Reassignment Configuration + * @export + * @enum {string} + */ + +export const ConfigtypeenumV1 = { + AccessRequests: 'ACCESS_REQUESTS', + Certifications: 'CERTIFICATIONS', + ManualTasks: 'MANUAL_TASKS', + GenericApprovals: 'GENERIC_APPROVALS' +} as const; + +export type ConfigtypeenumV1 = typeof ConfigtypeenumV1[keyof typeof ConfigtypeenumV1]; + + +/** + * Enum list of valid work types that can be selected for a Reassignment Configuration + * @export + * @enum {string} + */ + +export const ConfigtypeenumcamelV1 = { + AccessRequests: 'accessRequests', + Certifications: 'certifications', + ManualTasks: 'manualTasks' +} as const; + +export type ConfigtypeenumcamelV1 = typeof ConfigtypeenumcamelV1[keyof typeof ConfigtypeenumcamelV1]; + + +/** + * The request body of Reassignment Configuration Details for a specific identity and config type + * @export + * @interface ConfigurationdetailsresponseV1 + */ +export interface ConfigurationdetailsresponseV1 { + /** + * + * @type {ConfigtypeenumV1} + * @memberof ConfigurationdetailsresponseV1 + */ + 'configType'?: ConfigtypeenumV1; + /** + * + * @type {Identity2V1} + * @memberof ConfigurationdetailsresponseV1 + */ + 'targetIdentity'?: Identity2V1; + /** + * The date from which to start reassigning work items + * @type {string} + * @memberof ConfigurationdetailsresponseV1 + */ + 'startDate'?: string; + /** + * The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. + * @type {string} + * @memberof ConfigurationdetailsresponseV1 + */ + 'endDate'?: string; + /** + * + * @type {AuditdetailsV1} + * @memberof ConfigurationdetailsresponseV1 + */ + 'auditDetails'?: AuditdetailsV1; +} + + +/** + * The request body for creation or update of a Reassignment Configuration for a single identity and work type + * @export + * @interface ConfigurationitemrequestV1 + */ +export interface ConfigurationitemrequestV1 { + /** + * The identity id to reassign an item from + * @type {string} + * @memberof ConfigurationitemrequestV1 + */ + 'reassignedFromId'?: string; + /** + * The identity id to reassign an item to + * @type {string} + * @memberof ConfigurationitemrequestV1 + */ + 'reassignedToId'?: string; + /** + * + * @type {ConfigtypeenumV1} + * @memberof ConfigurationitemrequestV1 + */ + 'configType'?: ConfigtypeenumV1; + /** + * The date from which to start reassigning work items + * @type {string} + * @memberof ConfigurationitemrequestV1 + */ + 'startDate'?: string; + /** + * The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. + * @type {string} + * @memberof ConfigurationitemrequestV1 + */ + 'endDate'?: string | null; +} + + +/** + * The response body of a Reassignment Configuration for a single identity + * @export + * @interface ConfigurationitemresponseV1 + */ +export interface ConfigurationitemresponseV1 { + /** + * + * @type {Identity2V1} + * @memberof ConfigurationitemresponseV1 + */ + 'identity'?: Identity2V1; + /** + * Details of how work should be reassigned for an Identity + * @type {Array} + * @memberof ConfigurationitemresponseV1 + */ + 'configDetails'?: Array; +} +/** + * The response body of a Reassignment Configuration for a single identity + * @export + * @interface ConfigurationresponseV1 + */ +export interface ConfigurationresponseV1 { + /** + * + * @type {Identity2V1} + * @memberof ConfigurationresponseV1 + */ + 'identity'?: Identity2V1; + /** + * Details of how work should be reassigned for an Identity + * @type {Array} + * @memberof ConfigurationresponseV1 + */ + 'configDetails'?: Array; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * The response body for Evaluate Reassignment Configuration + * @export + * @interface EvaluateresponseV1 + */ +export interface EvaluateresponseV1 { + /** + * The Identity ID which should be the recipient of any work items sent to a specific identity & work type + * @type {string} + * @memberof EvaluateresponseV1 + */ + 'reassignToId'?: string; + /** + * List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration + * @type {Array} + * @memberof EvaluateresponseV1 + */ + 'lookupTrail'?: Array; +} +/** + * + * @export + * @interface GetReassignmentConfigTypesV1401ResponseV1 + */ +export interface GetReassignmentConfigTypesV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetReassignmentConfigTypesV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface GetReassignmentConfigTypesV1429ResponseV1 + */ +export interface GetReassignmentConfigTypesV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof GetReassignmentConfigTypesV1429ResponseV1 + */ + 'message'?: any; +} +/** + * The definition of an Identity according to the Reassignment Configuration service + * @export + * @interface Identity2V1 + */ +export interface Identity2V1 { + /** + * The ID of the object + * @type {string} + * @memberof Identity2V1 + */ + 'id'?: string; + /** + * Human-readable display name of the object + * @type {string} + * @memberof Identity2V1 + */ + 'name'?: 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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * The definition of an Identity according to the Reassignment Configuration service + * @export + * @interface LookupstepV1 + */ +export interface LookupstepV1 { + /** + * The ID of the Identity who work is reassigned to + * @type {string} + * @memberof LookupstepV1 + */ + 'reassignedToId'?: string; + /** + * The ID of the Identity who work is reassigned from + * @type {string} + * @memberof LookupstepV1 + */ + 'reassignedFromId'?: string; + /** + * + * @type {ReassignmenttypeenumV1} + * @memberof LookupstepV1 + */ + 'reassignmentType'?: ReassignmenttypeenumV1; +} + + +/** + * Enum list containing types of Reassignment that can be found in the evaluate response. + * @export + * @enum {string} + */ + +export const ReassignmenttypeenumV1 = { + ManualReassignment: 'MANUAL_REASSIGNMENT,', + AutomaticReassignment: 'AUTOMATIC_REASSIGNMENT,', + AutoEscalation: 'AUTO_ESCALATION,', + SelfReviewDelegation: 'SELF_REVIEW_DELEGATION' +} as const; + +export type ReassignmenttypeenumV1 = typeof ReassignmenttypeenumV1[keyof typeof ReassignmenttypeenumV1]; + + +/** + * Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) + * @export + * @interface TenantconfigurationdetailsV1 + */ +export interface TenantconfigurationdetailsV1 { + /** + * Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. + * @type {boolean} + * @memberof TenantconfigurationdetailsV1 + */ + 'disabled'?: boolean | null; +} +/** + * Tenant-wide Reassignment Configuration settings + * @export + * @interface TenantconfigurationrequestV1 + */ +export interface TenantconfigurationrequestV1 { + /** + * + * @type {TenantconfigurationdetailsV1} + * @memberof TenantconfigurationrequestV1 + */ + 'configDetails'?: TenantconfigurationdetailsV1; +} +/** + * Tenant-wide Reassignment Configuration settings + * @export + * @interface TenantconfigurationresponseV1 + */ +export interface TenantconfigurationresponseV1 { + /** + * + * @type {AuditdetailsV1} + * @memberof TenantconfigurationresponseV1 + */ + 'auditDetails'?: AuditdetailsV1; + /** + * + * @type {TenantconfigurationdetailsV1} + * @memberof TenantconfigurationresponseV1 + */ + 'configDetails'?: TenantconfigurationdetailsV1; +} + +/** + * WorkReassignmentV1Api - axios parameter creator + * @export + */ +export const WorkReassignmentV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Creates a new Reassignment Configuration for the specified identity. + * @summary Create a reassignment configuration + * @param {ConfigurationitemrequestV1} configurationitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createReassignmentConfigurationV1: async (configurationitemrequestV1: ConfigurationitemrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'configurationitemrequestV1' is not null or undefined + assertParamExists('createReassignmentConfigurationV1', 'configurationitemrequestV1', configurationitemrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/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'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(configurationitemrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Deletes a single reassignment configuration for the specified identity + * @summary Delete reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigtypeenumV1} configType + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteReassignmentConfigurationV1: async (identityId: string, configType: ConfigtypeenumV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('deleteReassignmentConfigurationV1', 'identityId', identityId) + // verify required parameter 'configType' is not null or undefined + assertParamExists('deleteReassignmentConfigurationV1', 'configType', configType) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/{identityId}/{configType}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) + .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); + // 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; + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + * @summary Evaluate reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigtypeenumV1} configType Reassignment work type + * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEvaluateReassignmentConfigurationV1: async (identityId: string, configType: ConfigtypeenumV1, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getEvaluateReassignmentConfigurationV1', 'identityId', identityId) + // verify required parameter 'configType' is not null or undefined + assertParamExists('getEvaluateReassignmentConfigurationV1', 'configType', configType) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/{identityId}/evaluate/{configType}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))) + .replace(`{${"configType"}}`, encodeURIComponent(String(configType))); + // 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 (exclusionFilters) { + localVarQueryParameter['exclusionFilters'] = exclusionFilters; + } + + + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Gets a collection of types which are available in the Reassignment Configuration UI. + * @summary List reassignment config types + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReassignmentConfigTypesV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/types`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Gets the Reassignment Configuration for an identity. + * @summary Get reassignment configuration + * @param {string} identityId unique identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReassignmentConfigurationV1: async (identityId: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('getReassignmentConfigurationV1', 'identityId', identityId) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/{identityId}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Gets the global Reassignment Configuration settings for the requestor\'s tenant. + * @summary Get tenant-wide reassignment configuration settings + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantConfigConfigurationV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/tenant-config`; + // 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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Gets all Reassignment configuration for the current org. + * @summary List reassignment configurations + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listReassignmentConfigurationsV1: async (xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/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 (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces existing Reassignment configuration for an identity with the newly provided configuration. + * @summary Update reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigurationitemrequestV1} configurationitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putReassignmentConfigV1: async (identityId: string, configurationitemrequestV1: ConfigurationitemrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'identityId' is not null or undefined + assertParamExists('putReassignmentConfigV1', 'identityId', identityId) + // verify required parameter 'configurationitemrequestV1' is not null or undefined + assertParamExists('putReassignmentConfigV1', 'configurationitemrequestV1', configurationitemrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/{identityId}` + .replace(`{${"identityId"}}`, encodeURIComponent(String(identityId))); + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(configurationitemrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + * @summary Update tenant-wide reassignment configuration settings + * @param {TenantconfigurationrequestV1} tenantconfigurationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putTenantConfigurationV1: async (tenantconfigurationrequestV1: TenantconfigurationrequestV1, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'tenantconfigurationrequestV1' is not null or undefined + assertParamExists('putTenantConfigurationV1', 'tenantconfigurationrequestV1', tenantconfigurationrequestV1) + if (xSailPointExperimental === undefined) { + xSailPointExperimental = 'true'; + } + + const localVarPath = `/reassignment-configurations/v1/tenant-config`; + // 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: 'PUT', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xSailPointExperimental != null) { + localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(tenantconfigurationrequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * WorkReassignmentV1Api - functional programming interface + * @export + */ +export const WorkReassignmentV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = WorkReassignmentV1ApiAxiosParamCreator(configuration) + return { + /** + * Creates a new Reassignment Configuration for the specified identity. + * @summary Create a reassignment configuration + * @param {ConfigurationitemrequestV1} configurationitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createReassignmentConfigurationV1(configurationitemrequestV1: ConfigurationitemrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createReassignmentConfigurationV1(configurationitemrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.createReassignmentConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deletes a single reassignment configuration for the specified identity + * @summary Delete reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigtypeenumV1} configType + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteReassignmentConfigurationV1(identityId: string, configType: ConfigtypeenumV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReassignmentConfigurationV1(identityId, configType, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.deleteReassignmentConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + * @summary Evaluate reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigtypeenumV1} configType Reassignment work type + * @param {Array} [exclusionFilters] Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getEvaluateReassignmentConfigurationV1(identityId: string, configType: ConfigtypeenumV1, exclusionFilters?: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluateReassignmentConfigurationV1(identityId, configType, exclusionFilters, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.getEvaluateReassignmentConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a collection of types which are available in the Reassignment Configuration UI. + * @summary List reassignment config types + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getReassignmentConfigTypesV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigTypesV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.getReassignmentConfigTypesV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets the Reassignment Configuration for an identity. + * @summary Get reassignment configuration + * @param {string} identityId unique identity id + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getReassignmentConfigurationV1(identityId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getReassignmentConfigurationV1(identityId, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.getReassignmentConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets the global Reassignment Configuration settings for the requestor\'s tenant. + * @summary Get tenant-wide reassignment configuration settings + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getTenantConfigConfigurationV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTenantConfigConfigurationV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.getTenantConfigConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets all Reassignment configuration for the current org. + * @summary List reassignment configurations + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listReassignmentConfigurationsV1(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listReassignmentConfigurationsV1(xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.listReassignmentConfigurationsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces existing Reassignment configuration for an identity with the newly provided configuration. + * @summary Update reassignment configuration + * @param {string} identityId unique identity id + * @param {ConfigurationitemrequestV1} configurationitemrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putReassignmentConfigV1(identityId: string, configurationitemrequestV1: ConfigurationitemrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putReassignmentConfigV1(identityId, configurationitemrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.putReassignmentConfigV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + * @summary Update tenant-wide reassignment configuration settings + * @param {TenantconfigurationrequestV1} tenantconfigurationrequestV1 + * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putTenantConfigurationV1(tenantconfigurationrequestV1: TenantconfigurationrequestV1, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putTenantConfigurationV1(tenantconfigurationrequestV1, xSailPointExperimental, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkReassignmentV1Api.putTenantConfigurationV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * WorkReassignmentV1Api - factory interface + * @export + */ +export const WorkReassignmentV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = WorkReassignmentV1ApiFp(configuration) + return { + /** + * Creates a new Reassignment Configuration for the specified identity. + * @summary Create a reassignment configuration + * @param {WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createReassignmentConfigurationV1(requestParameters.configurationitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Deletes a single reassignment configuration for the specified identity + * @summary Delete reassignment configuration + * @param {WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteReassignmentConfigurationV1(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + * @summary Evaluate reassignment configuration + * @param {WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getEvaluateReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getEvaluateReassignmentConfigurationV1(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a collection of types which are available in the Reassignment Configuration UI. + * @summary List reassignment config types + * @param {WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReassignmentConfigTypesV1(requestParameters: WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getReassignmentConfigTypesV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets the Reassignment Configuration for an identity. + * @summary Get reassignment configuration + * @param {WorkReassignmentV1ApiGetReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiGetReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getReassignmentConfigurationV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets the global Reassignment Configuration settings for the requestor\'s tenant. + * @summary Get tenant-wide reassignment configuration settings + * @param {WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getTenantConfigConfigurationV1(requestParameters: WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getTenantConfigConfigurationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets all Reassignment configuration for the current org. + * @summary List reassignment configurations + * @param {WorkReassignmentV1ApiListReassignmentConfigurationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listReassignmentConfigurationsV1(requestParameters: WorkReassignmentV1ApiListReassignmentConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listReassignmentConfigurationsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces existing Reassignment configuration for an identity with the newly provided configuration. + * @summary Update reassignment configuration + * @param {WorkReassignmentV1ApiPutReassignmentConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putReassignmentConfigV1(requestParameters: WorkReassignmentV1ApiPutReassignmentConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putReassignmentConfigV1(requestParameters.identityId, requestParameters.configurationitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + * @summary Update tenant-wide reassignment configuration settings + * @param {WorkReassignmentV1ApiPutTenantConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putTenantConfigurationV1(requestParameters: WorkReassignmentV1ApiPutTenantConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putTenantConfigurationV1(requestParameters.tenantconfigurationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for createReassignmentConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request + */ +export interface WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request { + /** + * + * @type {ConfigurationitemrequestV1} + * @memberof WorkReassignmentV1ApiCreateReassignmentConfigurationV1 + */ + readonly configurationitemrequestV1: ConfigurationitemrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiCreateReassignmentConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for deleteReassignmentConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request + */ +export interface WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request { + /** + * unique identity id + * @type {string} + * @memberof WorkReassignmentV1ApiDeleteReassignmentConfigurationV1 + */ + readonly identityId: string + + /** + * + * @type {ConfigtypeenumV1} + * @memberof WorkReassignmentV1ApiDeleteReassignmentConfigurationV1 + */ + readonly configType: ConfigtypeenumV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiDeleteReassignmentConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getEvaluateReassignmentConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request + */ +export interface WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request { + /** + * unique identity id + * @type {string} + * @memberof WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1 + */ + readonly identityId: string + + /** + * Reassignment work type + * @type {ConfigtypeenumV1} + * @memberof WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1 + */ + readonly configType: ConfigtypeenumV1 + + /** + * Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments + * @type {Array} + * @memberof WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1 + */ + readonly exclusionFilters?: Array + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getReassignmentConfigTypesV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request + */ +export interface WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiGetReassignmentConfigTypesV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getReassignmentConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiGetReassignmentConfigurationV1Request + */ +export interface WorkReassignmentV1ApiGetReassignmentConfigurationV1Request { + /** + * unique identity id + * @type {string} + * @memberof WorkReassignmentV1ApiGetReassignmentConfigurationV1 + */ + readonly identityId: string + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiGetReassignmentConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for getTenantConfigConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request + */ +export interface WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiGetTenantConfigConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for listReassignmentConfigurationsV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiListReassignmentConfigurationsV1Request + */ +export interface WorkReassignmentV1ApiListReassignmentConfigurationsV1Request { + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiListReassignmentConfigurationsV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for putReassignmentConfigV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiPutReassignmentConfigV1Request + */ +export interface WorkReassignmentV1ApiPutReassignmentConfigV1Request { + /** + * unique identity id + * @type {string} + * @memberof WorkReassignmentV1ApiPutReassignmentConfigV1 + */ + readonly identityId: string + + /** + * + * @type {ConfigurationitemrequestV1} + * @memberof WorkReassignmentV1ApiPutReassignmentConfigV1 + */ + readonly configurationitemrequestV1: ConfigurationitemrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiPutReassignmentConfigV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * Request parameters for putTenantConfigurationV1 operation in WorkReassignmentV1Api. + * @export + * @interface WorkReassignmentV1ApiPutTenantConfigurationV1Request + */ +export interface WorkReassignmentV1ApiPutTenantConfigurationV1Request { + /** + * + * @type {TenantconfigurationrequestV1} + * @memberof WorkReassignmentV1ApiPutTenantConfigurationV1 + */ + readonly tenantconfigurationrequestV1: TenantconfigurationrequestV1 + + /** + * Use this header to enable this experimental API. + * @type {string} + * @memberof WorkReassignmentV1ApiPutTenantConfigurationV1 + */ + readonly xSailPointExperimental?: string +} + +/** + * WorkReassignmentV1Api - object-oriented interface + * @export + * @class WorkReassignmentV1Api + * @extends {BaseAPI} + */ +export class WorkReassignmentV1Api extends BaseAPI { + /** + * Creates a new Reassignment Configuration for the specified identity. + * @summary Create a reassignment configuration + * @param {WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public createReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiCreateReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).createReassignmentConfigurationV1(requestParameters.configurationitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deletes a single reassignment configuration for the specified identity + * @summary Delete reassignment configuration + * @param {WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public deleteReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiDeleteReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).deleteReassignmentConfigurationV1(requestParameters.identityId, requestParameters.configType, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + * @summary Evaluate reassignment configuration + * @param {WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public getEvaluateReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiGetEvaluateReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).getEvaluateReassignmentConfigurationV1(requestParameters.identityId, requestParameters.configType, requestParameters.exclusionFilters, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a collection of types which are available in the Reassignment Configuration UI. + * @summary List reassignment config types + * @param {WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public getReassignmentConfigTypesV1(requestParameters: WorkReassignmentV1ApiGetReassignmentConfigTypesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).getReassignmentConfigTypesV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets the Reassignment Configuration for an identity. + * @summary Get reassignment configuration + * @param {WorkReassignmentV1ApiGetReassignmentConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public getReassignmentConfigurationV1(requestParameters: WorkReassignmentV1ApiGetReassignmentConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).getReassignmentConfigurationV1(requestParameters.identityId, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets the global Reassignment Configuration settings for the requestor\'s tenant. + * @summary Get tenant-wide reassignment configuration settings + * @param {WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public getTenantConfigConfigurationV1(requestParameters: WorkReassignmentV1ApiGetTenantConfigConfigurationV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).getTenantConfigConfigurationV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets all Reassignment configuration for the current org. + * @summary List reassignment configurations + * @param {WorkReassignmentV1ApiListReassignmentConfigurationsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public listReassignmentConfigurationsV1(requestParameters: WorkReassignmentV1ApiListReassignmentConfigurationsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).listReassignmentConfigurationsV1(requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces existing Reassignment configuration for an identity with the newly provided configuration. + * @summary Update reassignment configuration + * @param {WorkReassignmentV1ApiPutReassignmentConfigV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public putReassignmentConfigV1(requestParameters: WorkReassignmentV1ApiPutReassignmentConfigV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).putReassignmentConfigV1(requestParameters.identityId, requestParameters.configurationitemrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + * @summary Update tenant-wide reassignment configuration settings + * @param {WorkReassignmentV1ApiPutTenantConfigurationV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkReassignmentV1Api + */ + public putTenantConfigurationV1(requestParameters: WorkReassignmentV1ApiPutTenantConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkReassignmentV1ApiFp(this.configuration).putTenantConfigurationV1(requestParameters.tenantconfigurationrequestV1, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/work_reassignment/base.ts b/sdk-output/work_reassignment/base.ts new file mode 100644 index 00000000..bae8e2e9 --- /dev/null +++ b/sdk-output/work_reassignment/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Reassignment + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/work_reassignment/common.ts b/sdk-output/work_reassignment/common.ts new file mode 100644 index 00000000..f82eb703 --- /dev/null +++ b/sdk-output/work_reassignment/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Reassignment + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/work_reassignment/configuration.ts b/sdk-output/work_reassignment/configuration.ts new file mode 100644 index 00000000..7d3d5950 --- /dev/null +++ b/sdk-output/work_reassignment/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Reassignment + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/work_reassignment/git_push.sh b/sdk-output/work_reassignment/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/work_reassignment/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/work_reassignment/index.ts b/sdk-output/work_reassignment/index.ts new file mode 100644 index 00000000..a8695f46 --- /dev/null +++ b/sdk-output/work_reassignment/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Work Reassignment + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/work_reassignment/package.json b/sdk-output/work_reassignment/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/work_reassignment/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/work_reassignment/tsconfig.json b/sdk-output/work_reassignment/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/work_reassignment/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-output/workflows/.gitignore b/sdk-output/workflows/.gitignore new file mode 100644 index 00000000..149b5765 --- /dev/null +++ b/sdk-output/workflows/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/sdk-output/workflows/.npmignore b/sdk-output/workflows/.npmignore new file mode 100644 index 00000000..999d88df --- /dev/null +++ b/sdk-output/workflows/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/sdk-output/workflows/.openapi-generator-ignore b/sdk-output/workflows/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/sdk-output/workflows/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/sdk-output/workflows/.openapi-generator/FILES b/sdk-output/workflows/.openapi-generator/FILES new file mode 100644 index 00000000..70c4a1c1 --- /dev/null +++ b/sdk-output/workflows/.openapi-generator/FILES @@ -0,0 +1,12 @@ +.gitignore +.npmignore +.openapi-generator-ignore +README.md +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts +package.json +tsconfig.json diff --git a/sdk-output/workflows/.openapi-generator/VERSION b/sdk-output/workflows/.openapi-generator/VERSION new file mode 100644 index 00000000..5f84a81d --- /dev/null +++ b/sdk-output/workflows/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.12.0 diff --git a/sdk-output/workflows/.sdk-partition b/sdk-output/workflows/.sdk-partition new file mode 100644 index 00000000..1aa7c601 --- /dev/null +++ b/sdk-output/workflows/.sdk-partition @@ -0,0 +1 @@ +workflows \ No newline at end of file diff --git a/sdk-output/workflows/README.md b/sdk-output/workflows/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/workflows/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/workflows/api.ts b/sdk-output/workflows/api.ts new file mode 100644 index 00000000..2014eb16 --- /dev/null +++ b/sdk-output/workflows/api.ts @@ -0,0 +1,2868 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Workflows + * 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 ArrayInnerV1 + */ +export interface ArrayInnerV1 { +} +/** + * + * @export + * @interface CreateExternalExecuteWorkflowV1200ResponseV1 + */ +export interface CreateExternalExecuteWorkflowV1200ResponseV1 { + /** + * The workflow execution id + * @type {string} + * @memberof CreateExternalExecuteWorkflowV1200ResponseV1 + */ + 'workflowExecutionId'?: string; + /** + * An error message if any errors occurred + * @type {string} + * @memberof CreateExternalExecuteWorkflowV1200ResponseV1 + */ + 'message'?: string; +} +/** + * + * @export + * @interface CreateExternalExecuteWorkflowV1RequestV1 + */ +export interface CreateExternalExecuteWorkflowV1RequestV1 { + /** + * The input for the workflow + * @type {object} + * @memberof CreateExternalExecuteWorkflowV1RequestV1 + */ + 'input'?: object; +} +/** + * + * @export + * @interface CreateWorkflowV1RequestV1 + */ +export interface CreateWorkflowV1RequestV1 { + /** + * The name of the workflow + * @type {string} + * @memberof CreateWorkflowV1RequestV1 + */ + 'name': string; + /** + * + * @type {WorkflowbodyOwnerV1} + * @memberof CreateWorkflowV1RequestV1 + */ + 'owner'?: WorkflowbodyOwnerV1; + /** + * Description of what the workflow accomplishes + * @type {string} + * @memberof CreateWorkflowV1RequestV1 + */ + 'description'?: string; + /** + * + * @type {WorkflowdefinitionV1} + * @memberof CreateWorkflowV1RequestV1 + */ + 'definition'?: WorkflowdefinitionV1; + /** + * Enable or disable the workflow. Workflows cannot be created in an enabled state. + * @type {boolean} + * @memberof CreateWorkflowV1RequestV1 + */ + 'enabled'?: boolean; + /** + * + * @type {WorkflowtriggerV1} + * @memberof CreateWorkflowV1RequestV1 + */ + 'trigger'?: WorkflowtriggerV1; +} +/** + * + * @export + * @interface ErrormessagedtoV1 + */ +export interface ErrormessagedtoV1 { + /** + * The locale for the message text, a BCP 47 language tag. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'locale'?: string | null; + /** + * + * @type {LocaleoriginV1} + * @memberof ErrormessagedtoV1 + */ + 'localeOrigin'?: LocaleoriginV1 | null; + /** + * Actual text of the error message in the indicated locale. + * @type {string} + * @memberof ErrormessagedtoV1 + */ + 'text'?: string; +} + + +/** + * + * @export + * @interface ErrorresponsedtoV1 + */ +export interface ErrorresponsedtoV1 { + /** + * Fine-grained error code providing more detail of the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'detailCode'?: string; + /** + * Unique tracking id for the error. + * @type {string} + * @memberof ErrorresponsedtoV1 + */ + 'trackingId'?: string; + /** + * Generic localized reason for error + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'messages'?: Array; + /** + * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + * @type {Array} + * @memberof ErrorresponsedtoV1 + */ + 'causes'?: Array; +} +/** + * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) + * @export + * @interface JsonpatchoperationV1 + */ +export interface JsonpatchoperationV1 { + /** + * The operation to be performed + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'op': JsonpatchoperationV1OpV1; + /** + * A string JSON Pointer representing the target path to an element to be affected by the operation + * @type {string} + * @memberof JsonpatchoperationV1 + */ + 'path': string; + /** + * + * @type {JsonpatchoperationValueV1} + * @memberof JsonpatchoperationV1 + */ + 'value'?: JsonpatchoperationValueV1; +} + +export const JsonpatchoperationV1OpV1 = { + Add: 'add', + Remove: 'remove', + Replace: 'replace', + Move: 'move', + Copy: 'copy', + Test: 'test' +} as const; + +export type JsonpatchoperationV1OpV1 = typeof JsonpatchoperationV1OpV1[keyof typeof JsonpatchoperationV1OpV1]; + +/** + * @type JsonpatchoperationValueV1 + * The value to be used for the operation, required for \"add\" and \"replace\" operations + * @export + */ +export type JsonpatchoperationValueV1 = Array | boolean | number | object | string; + +/** + * + * @export + * @interface ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ +export interface ListCompleteWorkflowLibraryV1200ResponseInnerV1 { + /** + * Operator ID. + * @type {string} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'id'?: string; + /** + * Operator friendly name + * @type {string} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'name'?: string; + /** + * Operator type + * @type {string} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'type'?: string; + /** + * Description of the operator + * @type {string} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'description'?: string; + /** + * One or more inputs that the operator accepts + * @type {Array} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'formFields'?: Array | null; + /** + * + * @type {WorkflowlibraryactionExampleOutputV1} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'exampleOutput'?: WorkflowlibraryactionExampleOutputV1; + /** + * + * @type {boolean} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'deprecated'?: boolean; + /** + * + * @type {string} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'deprecatedBy'?: string; + /** + * Version number + * @type {number} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'versionNumber'?: number; + /** + * + * @type {boolean} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'isSimulationEnabled'?: boolean; + /** + * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + * @type {boolean} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'isDynamicSchema'?: boolean; + /** + * Example output schema + * @type {object} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'outputSchema'?: object; + /** + * Example trigger payload if applicable + * @type {object} + * @memberof ListCompleteWorkflowLibraryV1200ResponseInnerV1 + */ + 'inputExample'?: object | null; +} +/** + * + * @export + * @interface ListWorkflowsV1401ResponseV1 + */ +export interface ListWorkflowsV1401ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkflowsV1401ResponseV1 + */ + 'error'?: any; +} +/** + * + * @export + * @interface ListWorkflowsV1429ResponseV1 + */ +export interface ListWorkflowsV1429ResponseV1 { + /** + * A message describing the error + * @type {any} + * @memberof ListWorkflowsV1429ResponseV1 + */ + '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 LocaleoriginV1 = { + Default: 'DEFAULT', + Request: 'REQUEST' +} as const; + +export type LocaleoriginV1 = typeof LocaleoriginV1[keyof typeof LocaleoriginV1]; + + +/** + * + * @export + * @interface TestExternalExecuteWorkflowV1200ResponseV1 + */ +export interface TestExternalExecuteWorkflowV1200ResponseV1 { + /** + * The input that was received + * @type {object} + * @memberof TestExternalExecuteWorkflowV1200ResponseV1 + */ + 'payload'?: object; +} +/** + * + * @export + * @interface TestExternalExecuteWorkflowV1RequestV1 + */ +export interface TestExternalExecuteWorkflowV1RequestV1 { + /** + * The test input for the workflow + * @type {object} + * @memberof TestExternalExecuteWorkflowV1RequestV1 + */ + 'input'?: object; +} +/** + * + * @export + * @interface TestWorkflowV1200ResponseV1 + */ +export interface TestWorkflowV1200ResponseV1 { + /** + * The workflow execution id + * @type {string} + * @memberof TestWorkflowV1200ResponseV1 + */ + 'workflowExecutionId'?: string; +} +/** + * + * @export + * @interface TestWorkflowV1RequestV1 + */ +export interface TestWorkflowV1RequestV1 { + /** + * The test input for the workflow. + * @type {object} + * @memberof TestWorkflowV1RequestV1 + */ + 'input': object; +} +/** + * Workflow creator\'s identity. + * @export + * @interface WorkflowAllOfCreatorV1 + */ +export interface WorkflowAllOfCreatorV1 { + /** + * Workflow creator\'s DTO type. + * @type {string} + * @memberof WorkflowAllOfCreatorV1 + */ + 'type'?: WorkflowAllOfCreatorV1TypeV1; + /** + * Workflow creator\'s identity ID. + * @type {string} + * @memberof WorkflowAllOfCreatorV1 + */ + 'id'?: string; + /** + * Workflow creator\'s display name. + * @type {string} + * @memberof WorkflowAllOfCreatorV1 + */ + 'name'?: string; +} + +export const WorkflowAllOfCreatorV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type WorkflowAllOfCreatorV1TypeV1 = typeof WorkflowAllOfCreatorV1TypeV1[keyof typeof WorkflowAllOfCreatorV1TypeV1]; + +/** + * + * @export + * @interface WorkflowV1 + */ +export interface WorkflowV1 { + /** + * The name of the workflow + * @type {string} + * @memberof WorkflowV1 + */ + 'name'?: string; + /** + * + * @type {WorkflowbodyOwnerV1} + * @memberof WorkflowV1 + */ + 'owner'?: WorkflowbodyOwnerV1; + /** + * Description of what the workflow accomplishes + * @type {string} + * @memberof WorkflowV1 + */ + 'description'?: string; + /** + * + * @type {WorkflowdefinitionV1} + * @memberof WorkflowV1 + */ + 'definition'?: WorkflowdefinitionV1; + /** + * Enable or disable the workflow. Workflows cannot be created in an enabled state. + * @type {boolean} + * @memberof WorkflowV1 + */ + 'enabled'?: boolean; + /** + * + * @type {WorkflowtriggerV1} + * @memberof WorkflowV1 + */ + 'trigger'?: WorkflowtriggerV1; + /** + * Workflow ID. This is a UUID generated upon creation. + * @type {string} + * @memberof WorkflowV1 + */ + 'id'?: string; + /** + * The number of times this workflow has been executed. + * @type {number} + * @memberof WorkflowV1 + */ + 'executionCount'?: number; + /** + * The number of times this workflow has failed during execution. + * @type {number} + * @memberof WorkflowV1 + */ + 'failureCount'?: number; + /** + * The date and time the workflow was created. + * @type {string} + * @memberof WorkflowV1 + */ + 'created'?: string; + /** + * The date and time the workflow was modified. + * @type {string} + * @memberof WorkflowV1 + */ + 'modified'?: string; + /** + * + * @type {WorkflowmodifiedbyV1} + * @memberof WorkflowV1 + */ + 'modifiedBy'?: WorkflowmodifiedbyV1; + /** + * + * @type {WorkflowAllOfCreatorV1} + * @memberof WorkflowV1 + */ + 'creator'?: WorkflowAllOfCreatorV1; +} +/** + * The identity that owns the workflow. The owner\'s permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request. + * @export + * @interface WorkflowbodyOwnerV1 + */ +export interface WorkflowbodyOwnerV1 { + /** + * The type of object that is referenced + * @type {string} + * @memberof WorkflowbodyOwnerV1 + */ + 'type'?: WorkflowbodyOwnerV1TypeV1; + /** + * The unique ID of the object + * @type {string} + * @memberof WorkflowbodyOwnerV1 + */ + 'id'?: string; + /** + * The name of the object + * @type {string} + * @memberof WorkflowbodyOwnerV1 + */ + 'name'?: string; +} + +export const WorkflowbodyOwnerV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type WorkflowbodyOwnerV1TypeV1 = typeof WorkflowbodyOwnerV1TypeV1[keyof typeof WorkflowbodyOwnerV1TypeV1]; + +/** + * + * @export + * @interface WorkflowbodyV1 + */ +export interface WorkflowbodyV1 { + /** + * The name of the workflow + * @type {string} + * @memberof WorkflowbodyV1 + */ + 'name'?: string; + /** + * + * @type {WorkflowbodyOwnerV1} + * @memberof WorkflowbodyV1 + */ + 'owner'?: WorkflowbodyOwnerV1; + /** + * Description of what the workflow accomplishes + * @type {string} + * @memberof WorkflowbodyV1 + */ + 'description'?: string; + /** + * + * @type {WorkflowdefinitionV1} + * @memberof WorkflowbodyV1 + */ + 'definition'?: WorkflowdefinitionV1; + /** + * Enable or disable the workflow. Workflows cannot be created in an enabled state. + * @type {boolean} + * @memberof WorkflowbodyV1 + */ + 'enabled'?: boolean; + /** + * + * @type {WorkflowtriggerV1} + * @memberof WorkflowbodyV1 + */ + 'trigger'?: WorkflowtriggerV1; +} +/** + * The map of steps that the workflow will execute. + * @export + * @interface WorkflowdefinitionV1 + */ +export interface WorkflowdefinitionV1 { + /** + * The name of the starting step. + * @type {string} + * @memberof WorkflowdefinitionV1 + */ + 'start'?: string; + /** + * One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. + * @type {{ [key: string]: any; }} + * @memberof WorkflowdefinitionV1 + */ + 'steps'?: { [key: string]: any; }; +} +/** + * + * @export + * @interface WorkflowexecutionV1 + */ +export interface WorkflowexecutionV1 { + /** + * Workflow execution ID. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'id'?: string; + /** + * Workflow ID. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'workflowId'?: string; + /** + * Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'requestId'?: string; + /** + * Date/time when the workflow started. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'startTime'?: string; + /** + * Date/time when the workflow ended. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'closeTime'?: string; + /** + * Workflow execution status. + * @type {string} + * @memberof WorkflowexecutionV1 + */ + 'status'?: WorkflowexecutionV1StatusV1; +} + +export const WorkflowexecutionV1StatusV1 = { + Completed: 'Completed', + Failed: 'Failed', + Canceled: 'Canceled', + Running: 'Running', + Queued: 'Queued' +} as const; + +export type WorkflowexecutionV1StatusV1 = typeof WorkflowexecutionV1StatusV1[keyof typeof WorkflowexecutionV1StatusV1]; + +/** + * + * @export + * @interface WorkflowexecutioneventV1 + */ +export interface WorkflowexecutioneventV1 { + /** + * The type of event + * @type {string} + * @memberof WorkflowexecutioneventV1 + */ + 'type'?: WorkflowexecutioneventV1TypeV1; + /** + * The date-time when the event occurred + * @type {string} + * @memberof WorkflowexecutioneventV1 + */ + 'timestamp'?: string; + /** + * Additional attributes associated with the event + * @type {object} + * @memberof WorkflowexecutioneventV1 + */ + 'attributes'?: object; +} + +export const WorkflowexecutioneventV1TypeV1 = { + WorkflowExecutionScheduled: 'WorkflowExecutionScheduled', + WorkflowExecutionStarted: 'WorkflowExecutionStarted', + WorkflowExecutionCompleted: 'WorkflowExecutionCompleted', + WorkflowExecutionFailed: 'WorkflowExecutionFailed', + WorkflowTaskScheduled: 'WorkflowTaskScheduled', + WorkflowTaskStarted: 'WorkflowTaskStarted', + WorkflowTaskCompleted: 'WorkflowTaskCompleted', + WorkflowTaskFailed: 'WorkflowTaskFailed', + ActivityTaskScheduled: 'ActivityTaskScheduled', + ActivityTaskStarted: 'ActivityTaskStarted', + ActivityTaskCompleted: 'ActivityTaskCompleted', + ActivityTaskFailed: 'ActivityTaskFailed', + StartChildWorkflowExecutionInitiated: 'StartChildWorkflowExecutionInitiated', + ChildWorkflowExecutionStarted: 'ChildWorkflowExecutionStarted', + ChildWorkflowExecutionCompleted: 'ChildWorkflowExecutionCompleted', + ChildWorkflowExecutionFailed: 'ChildWorkflowExecutionFailed' +} as const; + +export type WorkflowexecutioneventV1TypeV1 = typeof WorkflowexecutioneventV1TypeV1[keyof typeof WorkflowexecutioneventV1TypeV1]; + +/** + * + * @export + * @interface WorkflowexecutionhistoryV1 + */ +export interface WorkflowexecutionhistoryV1 { + /** + * + * @type {object} + * @memberof WorkflowexecutionhistoryV1 + */ + 'definition'?: object; + /** + * + * @type {object} + * @memberof WorkflowexecutionhistoryV1 + */ + 'history'?: object; + /** + * + * @type {object} + * @memberof WorkflowexecutionhistoryV1 + */ + 'trigger'?: object; +} +/** + * @type WorkflowlibraryactionExampleOutputV1 + * @export + */ +export type WorkflowlibraryactionExampleOutputV1 = Array | object; + +/** + * + * @export + * @interface WorkflowlibraryactionV1 + */ +export interface WorkflowlibraryactionV1 { + /** + * Action ID. This is a static namespaced ID for the action + * @type {string} + * @memberof WorkflowlibraryactionV1 + */ + 'id'?: string; + /** + * Action Name + * @type {string} + * @memberof WorkflowlibraryactionV1 + */ + 'name'?: string; + /** + * Action type + * @type {string} + * @memberof WorkflowlibraryactionV1 + */ + 'type'?: string; + /** + * Action Description + * @type {string} + * @memberof WorkflowlibraryactionV1 + */ + 'description'?: string; + /** + * One or more inputs that the action accepts + * @type {Array} + * @memberof WorkflowlibraryactionV1 + */ + 'formFields'?: Array | null; + /** + * + * @type {WorkflowlibraryactionExampleOutputV1} + * @memberof WorkflowlibraryactionV1 + */ + 'exampleOutput'?: WorkflowlibraryactionExampleOutputV1; + /** + * + * @type {boolean} + * @memberof WorkflowlibraryactionV1 + */ + 'deprecated'?: boolean; + /** + * + * @type {string} + * @memberof WorkflowlibraryactionV1 + */ + 'deprecatedBy'?: string; + /** + * Version number + * @type {number} + * @memberof WorkflowlibraryactionV1 + */ + 'versionNumber'?: number; + /** + * + * @type {boolean} + * @memberof WorkflowlibraryactionV1 + */ + 'isSimulationEnabled'?: boolean; + /** + * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + * @type {boolean} + * @memberof WorkflowlibraryactionV1 + */ + 'isDynamicSchema'?: boolean; + /** + * Defines the output schema, if any, that this action produces. + * @type {object} + * @memberof WorkflowlibraryactionV1 + */ + 'outputSchema'?: object; +} +/** + * + * @export + * @interface WorkflowlibraryformfieldsV1 + */ +export interface WorkflowlibraryformfieldsV1 { + /** + * Description of the form field + * @type {string} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'description'?: string; + /** + * Describes the form field in the UI + * @type {string} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'helpText'?: string; + /** + * A human readable name for this form field in the UI + * @type {string} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'label'?: string; + /** + * The name of the input attribute + * @type {string} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'name'?: string; + /** + * Denotes if this field is a required attribute + * @type {boolean} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'required'?: boolean; + /** + * The type of the form field + * @type {string} + * @memberof WorkflowlibraryformfieldsV1 + */ + 'type'?: WorkflowlibraryformfieldsV1TypeV1 | null; +} + +export const WorkflowlibraryformfieldsV1TypeV1 = { + Text: 'text', + Textarea: 'textarea', + Boolean: 'boolean', + Email: 'email', + Url: 'url', + Number: 'number', + Json: 'json', + Checkbox: 'checkbox', + Jsonpath: 'jsonpath', + Select: 'select', + MultiType: 'multiType', + Duration: 'duration', + Toggle: 'toggle', + FormPicker: 'formPicker', + IdentityPicker: 'identityPicker', + GovernanceGroupPicker: 'governanceGroupPicker', + String: 'string', + Object: 'object', + Array: 'array', + Secret: 'secret', + KeyValuePairs: 'keyValuePairs', + EmailPicker: 'emailPicker', + AdvancedToggle: 'advancedToggle', + VariableCreator: 'variableCreator', + HtmlEditor: 'htmlEditor' +} as const; + +export type WorkflowlibraryformfieldsV1TypeV1 = typeof WorkflowlibraryformfieldsV1TypeV1[keyof typeof WorkflowlibraryformfieldsV1TypeV1]; + +/** + * + * @export + * @interface WorkflowlibraryoperatorV1 + */ +export interface WorkflowlibraryoperatorV1 { + /** + * Operator ID. + * @type {string} + * @memberof WorkflowlibraryoperatorV1 + */ + 'id'?: string; + /** + * Operator friendly name + * @type {string} + * @memberof WorkflowlibraryoperatorV1 + */ + 'name'?: string; + /** + * Operator type + * @type {string} + * @memberof WorkflowlibraryoperatorV1 + */ + 'type'?: string; + /** + * Description of the operator + * @type {string} + * @memberof WorkflowlibraryoperatorV1 + */ + 'description'?: string; + /** + * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + * @type {boolean} + * @memberof WorkflowlibraryoperatorV1 + */ + 'isDynamicSchema'?: boolean; + /** + * + * @type {boolean} + * @memberof WorkflowlibraryoperatorV1 + */ + 'deprecated'?: boolean; + /** + * + * @type {string} + * @memberof WorkflowlibraryoperatorV1 + */ + 'deprecatedBy'?: string; + /** + * + * @type {boolean} + * @memberof WorkflowlibraryoperatorV1 + */ + 'isSimulationEnabled'?: boolean; + /** + * One or more inputs that the operator accepts + * @type {Array} + * @memberof WorkflowlibraryoperatorV1 + */ + 'formFields'?: Array | null; +} +/** + * + * @export + * @interface WorkflowlibrarytriggerV1 + */ +export interface WorkflowlibrarytriggerV1 { + /** + * Trigger ID. This is a static namespaced ID for the trigger. + * @type {string} + * @memberof WorkflowlibrarytriggerV1 + */ + 'id'?: string; + /** + * Trigger type + * @type {string} + * @memberof WorkflowlibrarytriggerV1 + */ + 'type'?: WorkflowlibrarytriggerV1TypeV1; + /** + * Whether the trigger is deprecated. + * @type {boolean} + * @memberof WorkflowlibrarytriggerV1 + */ + 'deprecated'?: boolean; + /** + * Date the trigger was deprecated, if applicable. + * @type {string} + * @memberof WorkflowlibrarytriggerV1 + */ + 'deprecatedBy'?: string; + /** + * Whether the trigger can be simulated. + * @type {boolean} + * @memberof WorkflowlibrarytriggerV1 + */ + 'isSimulationEnabled'?: boolean; + /** + * Example output schema + * @type {object} + * @memberof WorkflowlibrarytriggerV1 + */ + 'outputSchema'?: object; + /** + * Trigger Name + * @type {string} + * @memberof WorkflowlibrarytriggerV1 + */ + 'name'?: string; + /** + * Trigger Description + * @type {string} + * @memberof WorkflowlibrarytriggerV1 + */ + 'description'?: string; + /** + * Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. + * @type {boolean} + * @memberof WorkflowlibrarytriggerV1 + */ + 'isDynamicSchema'?: boolean; + /** + * Example trigger payload if applicable + * @type {object} + * @memberof WorkflowlibrarytriggerV1 + */ + 'inputExample'?: object | null; + /** + * One or more inputs that the trigger accepts + * @type {Array} + * @memberof WorkflowlibrarytriggerV1 + */ + 'formFields'?: Array | null; +} + +export const WorkflowlibrarytriggerV1TypeV1 = { + Event: 'EVENT', + Scheduled: 'SCHEDULED', + External: 'EXTERNAL', + AccessRequestTrigger: 'AccessRequestTrigger' +} as const; + +export type WorkflowlibrarytriggerV1TypeV1 = typeof WorkflowlibrarytriggerV1TypeV1[keyof typeof WorkflowlibrarytriggerV1TypeV1]; + +/** + * + * @export + * @interface WorkflowmodifiedbyV1 + */ +export interface WorkflowmodifiedbyV1 { + /** + * + * @type {string} + * @memberof WorkflowmodifiedbyV1 + */ + 'type'?: WorkflowmodifiedbyV1TypeV1; + /** + * Identity ID + * @type {string} + * @memberof WorkflowmodifiedbyV1 + */ + 'id'?: string; + /** + * Human-readable display name of identity. + * @type {string} + * @memberof WorkflowmodifiedbyV1 + */ + 'name'?: string; +} + +export const WorkflowmodifiedbyV1TypeV1 = { + Identity: 'IDENTITY' +} as const; + +export type WorkflowmodifiedbyV1TypeV1 = typeof WorkflowmodifiedbyV1TypeV1[keyof typeof WorkflowmodifiedbyV1TypeV1]; + +/** + * + * @export + * @interface WorkflowoauthclientV1 + */ +export interface WorkflowoauthclientV1 { + /** + * OAuth client ID for the trigger. This is a UUID generated upon creation. + * @type {string} + * @memberof WorkflowoauthclientV1 + */ + 'id'?: string; + /** + * OAuthClient secret. + * @type {string} + * @memberof WorkflowoauthclientV1 + */ + 'secret'?: string; + /** + * URL for the external trigger to invoke + * @type {string} + * @memberof WorkflowoauthclientV1 + */ + 'url'?: string; +} +/** + * The trigger that starts the workflow + * @export + * @interface WorkflowtriggerV1 + */ +export interface WorkflowtriggerV1 { + /** + * The trigger type + * @type {string} + * @memberof WorkflowtriggerV1 + */ + 'type': WorkflowtriggerV1TypeV1; + /** + * The trigger display name + * @type {string} + * @memberof WorkflowtriggerV1 + */ + 'displayName'?: string | null; + /** + * Workflow Trigger Attributes. + * @type {object} + * @memberof WorkflowtriggerV1 + */ + 'attributes': object | null; +} + +export const WorkflowtriggerV1TypeV1 = { + Event: 'EVENT', + External: 'EXTERNAL', + Scheduled: 'SCHEDULED', + Empty: '' +} as const; + +export type WorkflowtriggerV1TypeV1 = typeof WorkflowtriggerV1TypeV1[keyof typeof WorkflowtriggerV1TypeV1]; + + +/** + * WorkflowsV1Api - axios parameter creator + * @export + */ +export const WorkflowsV1ApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Use this API to cancel a running workflow execution. + * @summary Cancel workflow execution by id + * @param {string} id The workflow execution ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelWorkflowExecutionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cancelWorkflowExecutionV1', 'id', id) + const localVarPath = `/workflow-executions/v1/{id}/cancel` + .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: 'POST', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + * @summary Execute workflow via external trigger + * @param {string} id Id of the workflow + * @param {CreateExternalExecuteWorkflowV1RequestV1} [createExternalExecuteWorkflowV1RequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createExternalExecuteWorkflowV1: async (id: string, createExternalExecuteWorkflowV1RequestV1?: CreateExternalExecuteWorkflowV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('createExternalExecuteWorkflowV1', 'id', id) + const localVarPath = `/workflows/v1/execute/external/{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: '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(createExternalExecuteWorkflowV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + * @summary Generate external trigger oauth client + * @param {string} id Id of the workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkflowExternalTriggerV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('createWorkflowExternalTriggerV1', 'id', id) + const localVarPath = `/workflows/v1/{id}/external/oauth-clients` + .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: 'POST', ...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, + }; + }, + /** + * Create a new workflow with the desired trigger and steps specified in the request body. + * @summary Create workflow + * @param {CreateWorkflowV1RequestV1} createWorkflowV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkflowV1: async (createWorkflowV1RequestV1: CreateWorkflowV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createWorkflowV1RequestV1' is not null or undefined + assertParamExists('createWorkflowV1', 'createWorkflowV1RequestV1', createWorkflowV1RequestV1) + const localVarPath = `/workflows/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(createWorkflowV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + * @summary Delete workflow by id + * @param {string} id Id of the Workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkflowV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('deleteWorkflowV1', 'id', id) + const localVarPath = `/workflows/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 detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get workflow execution history + * @param {string} id Id of the workflow execution + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionHistoryV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkflowExecutionHistoryV1', 'id', id) + const localVarPath = `/workflow-executions/v1/{id}/history` + .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, + }; + }, + /** + * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get updated workflow execution history + * @param {string} id Id of the workflow execution + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionHistoryV2: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkflowExecutionHistoryV2', 'id', id) + const localVarPath = `/workflow-executions/v1/{id}/history-v2` + .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, + }; + }, + /** + * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. + * @summary Get workflow execution + * @param {string} id Workflow execution ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkflowExecutionV1', 'id', id) + const localVarPath = `/workflow-executions/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, + }; + }, + /** + * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + * @summary List workflow executions + * @param {string} id Workflow ID. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionsV1: async (id: string, limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkflowExecutionsV1', 'id', id) + const localVarPath = `/workflows/v1/{id}/executions` + .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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * Get a single workflow by id. + * @summary Get workflow by id + * @param {string} id Id of the workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getWorkflowV1', 'id', id) + const localVarPath = `/workflows/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, + }; + }, + /** + * This lists all triggers, actions, and operators in the library + * @summary List complete workflow library + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCompleteWorkflowLibraryV1: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workflow-library/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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This lists the workflow actions available to you. + * @summary List workflow library actions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryActionsV1: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workflow-library/v1/actions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (filters !== undefined) { + localVarQueryParameter['filters'] = filters; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This lists the workflow operators available to you + * @summary List workflow library operators + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryOperatorsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workflow-library/v1/operators`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * This lists the workflow triggers available to you + * @summary List workflow library triggers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* **type**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryTriggersV1: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workflow-library/v1/triggers`; + // 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 (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + 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, + }; + }, + /** + * List all workflows in the tenant. + * @summary List workflows + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowsV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/workflows/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; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + * @summary Patch workflow + * @param {string} id Id of the Workflow + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchWorkflowV1: async (id: string, jsonpatchoperationV1: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('patchWorkflowV1', 'id', id) + // verify required parameter 'jsonpatchoperationV1' is not null or undefined + assertParamExists('patchWorkflowV1', 'jsonpatchoperationV1', jsonpatchoperationV1) + const localVarPath = `/workflows/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(jsonpatchoperationV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Perform a full update of a workflow. The updated workflow object is returned in the response. + * @summary Update workflow + * @param {string} id Id of the Workflow + * @param {WorkflowbodyV1} workflowbodyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putWorkflowV1: async (id: string, workflowbodyV1: WorkflowbodyV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('putWorkflowV1', 'id', id) + // verify required parameter 'workflowbodyV1' is not null or undefined + assertParamExists('putWorkflowV1', 'workflowbodyV1', workflowbodyV1) + const localVarPath = `/workflows/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: 'PUT', ...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(workflowbodyV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + * @summary Test workflow via external trigger + * @param {string} id Id of the workflow + * @param {TestExternalExecuteWorkflowV1RequestV1} [testExternalExecuteWorkflowV1RequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testExternalExecuteWorkflowV1: async (id: string, testExternalExecuteWorkflowV1RequestV1?: TestExternalExecuteWorkflowV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('testExternalExecuteWorkflowV1', 'id', id) + const localVarPath = `/workflows/v1/execute/external/{id}/test` + .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: '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(testExternalExecuteWorkflowV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + /** + * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + * @summary Test workflow by id + * @param {string} id Id of the workflow + * @param {TestWorkflowV1RequestV1} testWorkflowV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testWorkflowV1: async (id: string, testWorkflowV1RequestV1: TestWorkflowV1RequestV1, axiosOptions: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('testWorkflowV1', 'id', id) + // verify required parameter 'testWorkflowV1RequestV1' is not null or undefined + assertParamExists('testWorkflowV1', 'testWorkflowV1RequestV1', testWorkflowV1RequestV1) + const localVarPath = `/workflows/v1/{id}/test` + .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: '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(testWorkflowV1RequestV1, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + axiosOptions: localVarRequestOptions, + }; + }, + } +}; + +/** + * WorkflowsV1Api - functional programming interface + * @export + */ +export const WorkflowsV1ApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = WorkflowsV1ApiAxiosParamCreator(configuration) + return { + /** + * Use this API to cancel a running workflow execution. + * @summary Cancel workflow execution by id + * @param {string} id The workflow execution ID + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async cancelWorkflowExecutionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cancelWorkflowExecutionV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.cancelWorkflowExecutionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + * @summary Execute workflow via external trigger + * @param {string} id Id of the workflow + * @param {CreateExternalExecuteWorkflowV1RequestV1} [createExternalExecuteWorkflowV1RequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createExternalExecuteWorkflowV1(id: string, createExternalExecuteWorkflowV1RequestV1?: CreateExternalExecuteWorkflowV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createExternalExecuteWorkflowV1(id, createExternalExecuteWorkflowV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.createExternalExecuteWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + * @summary Generate external trigger oauth client + * @param {string} id Id of the workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createWorkflowExternalTriggerV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowExternalTriggerV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.createWorkflowExternalTriggerV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create a new workflow with the desired trigger and steps specified in the request body. + * @summary Create workflow + * @param {CreateWorkflowV1RequestV1} createWorkflowV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async createWorkflowV1(createWorkflowV1RequestV1: CreateWorkflowV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createWorkflowV1(createWorkflowV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.createWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + * @summary Delete workflow by id + * @param {string} id Id of the Workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async deleteWorkflowV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWorkflowV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.deleteWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get workflow execution history + * @param {string} id Id of the workflow execution + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkflowExecutionHistoryV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistoryV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.getWorkflowExecutionHistoryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get updated workflow execution history + * @param {string} id Id of the workflow execution + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkflowExecutionHistoryV2(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionHistoryV2(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.getWorkflowExecutionHistoryV2']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. + * @summary Get workflow execution + * @param {string} id Workflow execution ID. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkflowExecutionV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.getWorkflowExecutionV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + * @summary List workflow executions + * @param {string} id Workflow ID. + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkflowExecutionsV1(id: string, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowExecutionsV1(id, limit, offset, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.getWorkflowExecutionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get a single workflow by id. + * @summary Get workflow by id + * @param {string} id Id of the workflow + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async getWorkflowV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getWorkflowV1(id, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.getWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists all triggers, actions, and operators in the library + * @summary List complete workflow library + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listCompleteWorkflowLibraryV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listCompleteWorkflowLibraryV1(limit, offset, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.listCompleteWorkflowLibraryV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists the workflow actions available to you. + * @summary List workflow library actions + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkflowLibraryActionsV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryActionsV1(limit, offset, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.listWorkflowLibraryActionsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists the workflow operators available to you + * @summary List workflow library operators + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryOperatorsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.listWorkflowLibraryOperatorsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * This lists the workflow triggers available to you + * @summary List workflow library triggers + * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @param {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* **type**: *eq* + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkflowLibraryTriggersV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowLibraryTriggersV1(limit, offset, filters, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.listWorkflowLibraryTriggersV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List all workflows in the tenant. + * @summary List workflows + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listWorkflowsV1(axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.listWorkflowsV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + * @summary Patch workflow + * @param {string} id Id of the Workflow + * @param {Array} jsonpatchoperationV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async patchWorkflowV1(id: string, jsonpatchoperationV1: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.patchWorkflowV1(id, jsonpatchoperationV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.patchWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Perform a full update of a workflow. The updated workflow object is returned in the response. + * @summary Update workflow + * @param {string} id Id of the Workflow + * @param {WorkflowbodyV1} workflowbodyV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async putWorkflowV1(id: string, workflowbodyV1: WorkflowbodyV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.putWorkflowV1(id, workflowbodyV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.putWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + * @summary Test workflow via external trigger + * @param {string} id Id of the workflow + * @param {TestExternalExecuteWorkflowV1RequestV1} [testExternalExecuteWorkflowV1RequestV1] + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testExternalExecuteWorkflowV1(id: string, testExternalExecuteWorkflowV1RequestV1?: TestExternalExecuteWorkflowV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testExternalExecuteWorkflowV1(id, testExternalExecuteWorkflowV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.testExternalExecuteWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + * @summary Test workflow by id + * @param {string} id Id of the workflow + * @param {TestWorkflowV1RequestV1} testWorkflowV1RequestV1 + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + async testWorkflowV1(id: string, testWorkflowV1RequestV1: TestWorkflowV1RequestV1, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.testWorkflowV1(id, testWorkflowV1RequestV1, axiosOptions); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkflowsV1Api.testWorkflowV1']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * WorkflowsV1Api - factory interface + * @export + */ +export const WorkflowsV1ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = WorkflowsV1ApiFp(configuration) + return { + /** + * Use this API to cancel a running workflow execution. + * @summary Cancel workflow execution by id + * @param {WorkflowsV1ApiCancelWorkflowExecutionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + cancelWorkflowExecutionV1(requestParameters: WorkflowsV1ApiCancelWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cancelWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + * @summary Execute workflow via external trigger + * @param {WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createExternalExecuteWorkflowV1(requestParameters: WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createExternalExecuteWorkflowV1(requestParameters.id, requestParameters.createExternalExecuteWorkflowV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + * @summary Generate external trigger oauth client + * @param {WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkflowExternalTriggerV1(requestParameters: WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createWorkflowExternalTriggerV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Create a new workflow with the desired trigger and steps specified in the request body. + * @summary Create workflow + * @param {WorkflowsV1ApiCreateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + createWorkflowV1(requestParameters: WorkflowsV1ApiCreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createWorkflowV1(requestParameters.createWorkflowV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + * @summary Delete workflow by id + * @param {WorkflowsV1ApiDeleteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + deleteWorkflowV1(requestParameters: WorkflowsV1ApiDeleteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteWorkflowV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get workflow execution history + * @param {WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionHistoryV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getWorkflowExecutionHistoryV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get updated workflow execution history + * @param {WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. + * @summary Get workflow execution + * @param {WorkflowsV1ApiGetWorkflowExecutionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + * @summary List workflow executions + * @param {WorkflowsV1ApiGetWorkflowExecutionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowExecutionsV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.getWorkflowExecutionsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Get a single workflow by id. + * @summary Get workflow by id + * @param {WorkflowsV1ApiGetWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + getWorkflowV1(requestParameters: WorkflowsV1ApiGetWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getWorkflowV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists all triggers, actions, and operators in the library + * @summary List complete workflow library + * @param {WorkflowsV1ApiListCompleteWorkflowLibraryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listCompleteWorkflowLibraryV1(requestParameters: WorkflowsV1ApiListCompleteWorkflowLibraryV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listCompleteWorkflowLibraryV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists the workflow actions available to you. + * @summary List workflow library actions + * @param {WorkflowsV1ApiListWorkflowLibraryActionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryActionsV1(requestParameters: WorkflowsV1ApiListWorkflowLibraryActionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkflowLibraryActionsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists the workflow operators available to you + * @summary List workflow library operators + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkflowLibraryOperatorsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * This lists the workflow triggers available to you + * @summary List workflow library triggers + * @param {WorkflowsV1ApiListWorkflowLibraryTriggersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowLibraryTriggersV1(requestParameters: WorkflowsV1ApiListWorkflowLibraryTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkflowLibraryTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * List all workflows in the tenant. + * @summary List workflows + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.listWorkflowsV1(axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + * @summary Patch workflow + * @param {WorkflowsV1ApiPatchWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + patchWorkflowV1(requestParameters: WorkflowsV1ApiPatchWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.patchWorkflowV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Perform a full update of a workflow. The updated workflow object is returned in the response. + * @summary Update workflow + * @param {WorkflowsV1ApiPutWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + putWorkflowV1(requestParameters: WorkflowsV1ApiPutWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.putWorkflowV1(requestParameters.id, requestParameters.workflowbodyV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + * @summary Test workflow via external trigger + * @param {WorkflowsV1ApiTestExternalExecuteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testExternalExecuteWorkflowV1(requestParameters: WorkflowsV1ApiTestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testExternalExecuteWorkflowV1(requestParameters.id, requestParameters.testExternalExecuteWorkflowV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + /** + * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + * @summary Test workflow by id + * @param {WorkflowsV1ApiTestWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + */ + testWorkflowV1(requestParameters: WorkflowsV1ApiTestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.testWorkflowV1(requestParameters.id, requestParameters.testWorkflowV1RequestV1, axiosOptions).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for cancelWorkflowExecutionV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiCancelWorkflowExecutionV1Request + */ +export interface WorkflowsV1ApiCancelWorkflowExecutionV1Request { + /** + * The workflow execution ID + * @type {string} + * @memberof WorkflowsV1ApiCancelWorkflowExecutionV1 + */ + readonly id: string +} + +/** + * Request parameters for createExternalExecuteWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request + */ +export interface WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request { + /** + * Id of the workflow + * @type {string} + * @memberof WorkflowsV1ApiCreateExternalExecuteWorkflowV1 + */ + readonly id: string + + /** + * + * @type {CreateExternalExecuteWorkflowV1RequestV1} + * @memberof WorkflowsV1ApiCreateExternalExecuteWorkflowV1 + */ + readonly createExternalExecuteWorkflowV1RequestV1?: CreateExternalExecuteWorkflowV1RequestV1 +} + +/** + * Request parameters for createWorkflowExternalTriggerV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request + */ +export interface WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request { + /** + * Id of the workflow + * @type {string} + * @memberof WorkflowsV1ApiCreateWorkflowExternalTriggerV1 + */ + readonly id: string +} + +/** + * Request parameters for createWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiCreateWorkflowV1Request + */ +export interface WorkflowsV1ApiCreateWorkflowV1Request { + /** + * + * @type {CreateWorkflowV1RequestV1} + * @memberof WorkflowsV1ApiCreateWorkflowV1 + */ + readonly createWorkflowV1RequestV1: CreateWorkflowV1RequestV1 +} + +/** + * Request parameters for deleteWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiDeleteWorkflowV1Request + */ +export interface WorkflowsV1ApiDeleteWorkflowV1Request { + /** + * Id of the Workflow + * @type {string} + * @memberof WorkflowsV1ApiDeleteWorkflowV1 + */ + readonly id: string +} + +/** + * Request parameters for getWorkflowExecutionHistoryV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request + */ +export interface WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request { + /** + * Id of the workflow execution + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowExecutionHistoryV1 + */ + readonly id: string +} + +/** + * Request parameters for getWorkflowExecutionHistoryV2 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request + */ +export interface WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request { + /** + * Id of the workflow execution + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowExecutionHistoryV2 + */ + readonly id: string +} + +/** + * Request parameters for getWorkflowExecutionV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiGetWorkflowExecutionV1Request + */ +export interface WorkflowsV1ApiGetWorkflowExecutionV1Request { + /** + * Workflow execution ID. + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowExecutionV1 + */ + readonly id: string +} + +/** + * Request parameters for getWorkflowExecutionsV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiGetWorkflowExecutionsV1Request + */ +export interface WorkflowsV1ApiGetWorkflowExecutionsV1Request { + /** + * Workflow ID. + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowExecutionsV1 + */ + readonly id: string + + /** + * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkflowsV1ApiGetWorkflowExecutionsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkflowsV1ApiGetWorkflowExecutionsV1 + */ + readonly offset?: number + + /** + * 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowExecutionsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for getWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiGetWorkflowV1Request + */ +export interface WorkflowsV1ApiGetWorkflowV1Request { + /** + * Id of the workflow + * @type {string} + * @memberof WorkflowsV1ApiGetWorkflowV1 + */ + readonly id: string +} + +/** + * Request parameters for listCompleteWorkflowLibraryV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiListCompleteWorkflowLibraryV1Request + */ +export interface WorkflowsV1ApiListCompleteWorkflowLibraryV1Request { + /** + * 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 WorkflowsV1ApiListCompleteWorkflowLibraryV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkflowsV1ApiListCompleteWorkflowLibraryV1 + */ + readonly offset?: number +} + +/** + * Request parameters for listWorkflowLibraryActionsV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiListWorkflowLibraryActionsV1Request + */ +export interface WorkflowsV1ApiListWorkflowLibraryActionsV1Request { + /** + * 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 WorkflowsV1ApiListWorkflowLibraryActionsV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkflowsV1ApiListWorkflowLibraryActionsV1 + */ + readonly offset?: number + + /** + * 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* + * @type {string} + * @memberof WorkflowsV1ApiListWorkflowLibraryActionsV1 + */ + readonly filters?: string +} + +/** + * Request parameters for listWorkflowLibraryTriggersV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiListWorkflowLibraryTriggersV1Request + */ +export interface WorkflowsV1ApiListWorkflowLibraryTriggersV1Request { + /** + * 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 WorkflowsV1ApiListWorkflowLibraryTriggersV1 + */ + readonly limit?: number + + /** + * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + * @type {number} + * @memberof WorkflowsV1ApiListWorkflowLibraryTriggersV1 + */ + readonly offset?: number + + /** + * 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* **type**: *eq* + * @type {string} + * @memberof WorkflowsV1ApiListWorkflowLibraryTriggersV1 + */ + readonly filters?: string +} + +/** + * Request parameters for patchWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiPatchWorkflowV1Request + */ +export interface WorkflowsV1ApiPatchWorkflowV1Request { + /** + * Id of the Workflow + * @type {string} + * @memberof WorkflowsV1ApiPatchWorkflowV1 + */ + readonly id: string + + /** + * + * @type {Array} + * @memberof WorkflowsV1ApiPatchWorkflowV1 + */ + readonly jsonpatchoperationV1: Array +} + +/** + * Request parameters for putWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiPutWorkflowV1Request + */ +export interface WorkflowsV1ApiPutWorkflowV1Request { + /** + * Id of the Workflow + * @type {string} + * @memberof WorkflowsV1ApiPutWorkflowV1 + */ + readonly id: string + + /** + * + * @type {WorkflowbodyV1} + * @memberof WorkflowsV1ApiPutWorkflowV1 + */ + readonly workflowbodyV1: WorkflowbodyV1 +} + +/** + * Request parameters for testExternalExecuteWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiTestExternalExecuteWorkflowV1Request + */ +export interface WorkflowsV1ApiTestExternalExecuteWorkflowV1Request { + /** + * Id of the workflow + * @type {string} + * @memberof WorkflowsV1ApiTestExternalExecuteWorkflowV1 + */ + readonly id: string + + /** + * + * @type {TestExternalExecuteWorkflowV1RequestV1} + * @memberof WorkflowsV1ApiTestExternalExecuteWorkflowV1 + */ + readonly testExternalExecuteWorkflowV1RequestV1?: TestExternalExecuteWorkflowV1RequestV1 +} + +/** + * Request parameters for testWorkflowV1 operation in WorkflowsV1Api. + * @export + * @interface WorkflowsV1ApiTestWorkflowV1Request + */ +export interface WorkflowsV1ApiTestWorkflowV1Request { + /** + * Id of the workflow + * @type {string} + * @memberof WorkflowsV1ApiTestWorkflowV1 + */ + readonly id: string + + /** + * + * @type {TestWorkflowV1RequestV1} + * @memberof WorkflowsV1ApiTestWorkflowV1 + */ + readonly testWorkflowV1RequestV1: TestWorkflowV1RequestV1 +} + +/** + * WorkflowsV1Api - object-oriented interface + * @export + * @class WorkflowsV1Api + * @extends {BaseAPI} + */ +export class WorkflowsV1Api extends BaseAPI { + /** + * Use this API to cancel a running workflow execution. + * @summary Cancel workflow execution by id + * @param {WorkflowsV1ApiCancelWorkflowExecutionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public cancelWorkflowExecutionV1(requestParameters: WorkflowsV1ApiCancelWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).cancelWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the \"External Trigger\" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + * @summary Execute workflow via external trigger + * @param {WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public createExternalExecuteWorkflowV1(requestParameters: WorkflowsV1ApiCreateExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).createExternalExecuteWorkflowV1(requestParameters.id, requestParameters.createExternalExecuteWorkflowV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + * @summary Generate external trigger oauth client + * @param {WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public createWorkflowExternalTriggerV1(requestParameters: WorkflowsV1ApiCreateWorkflowExternalTriggerV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).createWorkflowExternalTriggerV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create a new workflow with the desired trigger and steps specified in the request body. + * @summary Create workflow + * @param {WorkflowsV1ApiCreateWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public createWorkflowV1(requestParameters: WorkflowsV1ApiCreateWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).createWorkflowV1(requestParameters.createWorkflowV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + * @summary Delete workflow by id + * @param {WorkflowsV1ApiDeleteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public deleteWorkflowV1(requestParameters: WorkflowsV1ApiDeleteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).deleteWorkflowV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get workflow execution history + * @param {WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public getWorkflowExecutionHistoryV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionHistoryV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).getWorkflowExecutionHistoryV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + * @summary Get updated workflow execution history + * @param {WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public getWorkflowExecutionHistoryV2(requestParameters: WorkflowsV1ApiGetWorkflowExecutionHistoryV2Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).getWorkflowExecutionHistoryV2(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a \"404 Not Found\" response. + * @summary Get workflow execution + * @param {WorkflowsV1ApiGetWorkflowExecutionV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public getWorkflowExecutionV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).getWorkflowExecutionV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Use this API to list a specified workflow\'s executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following: - Filter to find relevant workflow executions. For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq \"Failed\"` - Paginate through results with the `offset` parameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + * @summary List workflow executions + * @param {WorkflowsV1ApiGetWorkflowExecutionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public getWorkflowExecutionsV1(requestParameters: WorkflowsV1ApiGetWorkflowExecutionsV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).getWorkflowExecutionsV1(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get a single workflow by id. + * @summary Get workflow by id + * @param {WorkflowsV1ApiGetWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public getWorkflowV1(requestParameters: WorkflowsV1ApiGetWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).getWorkflowV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists all triggers, actions, and operators in the library + * @summary List complete workflow library + * @param {WorkflowsV1ApiListCompleteWorkflowLibraryV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public listCompleteWorkflowLibraryV1(requestParameters: WorkflowsV1ApiListCompleteWorkflowLibraryV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).listCompleteWorkflowLibraryV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists the workflow actions available to you. + * @summary List workflow library actions + * @param {WorkflowsV1ApiListWorkflowLibraryActionsV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public listWorkflowLibraryActionsV1(requestParameters: WorkflowsV1ApiListWorkflowLibraryActionsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).listWorkflowLibraryActionsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists the workflow operators available to you + * @summary List workflow library operators + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public listWorkflowLibraryOperatorsV1(axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).listWorkflowLibraryOperatorsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * This lists the workflow triggers available to you + * @summary List workflow library triggers + * @param {WorkflowsV1ApiListWorkflowLibraryTriggersV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public listWorkflowLibraryTriggersV1(requestParameters: WorkflowsV1ApiListWorkflowLibraryTriggersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).listWorkflowLibraryTriggersV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * List all workflows in the tenant. + * @summary List workflows + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public listWorkflowsV1(axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).listWorkflowsV1(axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + * @summary Patch workflow + * @param {WorkflowsV1ApiPatchWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public patchWorkflowV1(requestParameters: WorkflowsV1ApiPatchWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).patchWorkflowV1(requestParameters.id, requestParameters.jsonpatchoperationV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Perform a full update of a workflow. The updated workflow object is returned in the response. + * @summary Update workflow + * @param {WorkflowsV1ApiPutWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public putWorkflowV1(requestParameters: WorkflowsV1ApiPutWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).putWorkflowV1(requestParameters.id, requestParameters.workflowbodyV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * Validate a workflow with an \"External Trigger\" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + * @summary Test workflow via external trigger + * @param {WorkflowsV1ApiTestExternalExecuteWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public testExternalExecuteWorkflowV1(requestParameters: WorkflowsV1ApiTestExternalExecuteWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).testExternalExecuteWorkflowV1(requestParameters.id, requestParameters.testExternalExecuteWorkflowV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } + + /** + * :::info Workflow must be disabled in order to use this endpoint. ::: Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + * @summary Test workflow by id + * @param {WorkflowsV1ApiTestWorkflowV1Request} requestParameters Request parameters. + * @param {*} [axiosOptions] Override http request option. + * @throws {RequiredError} + * @memberof WorkflowsV1Api + */ + public testWorkflowV1(requestParameters: WorkflowsV1ApiTestWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig) { + return WorkflowsV1ApiFp(this.configuration).testWorkflowV1(requestParameters.id, requestParameters.testWorkflowV1RequestV1, axiosOptions).then((request) => request(this.axios, this.basePath)); + } +} + + + diff --git a/sdk-output/workflows/base.ts b/sdk-output/workflows/base.ts new file mode 100644 index 00000000..b3a24289 --- /dev/null +++ b/sdk-output/workflows/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Workflows + * 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'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "https://sailpoint.api.identitynow.com".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + axiosOptions: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath || this.basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/sdk-output/workflows/common.ts b/sdk-output/workflows/common.ts new file mode 100644 index 00000000..4da24ecf --- /dev/null +++ b/sdk-output/workflows/common.ts @@ -0,0 +1,183 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Workflows + * 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 { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + let userAgent = `SailPoint-SDK-TypeScript/1.0.0`; + if (configuration?.consumerIdentifier && configuration?.consumerVersion) { + userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; + } + userAgent += ` (${process.platform}; ${process.arch}) Node/${process.versions.node} (openapi-generator/7.12.0)`; + const headers = { + ...axiosArgs.axiosOptions.headers, + ...{'X-SailPoint-SDK':'typescript-1.0.0'}, + ...{'User-Agent': userAgent}, + } + + if(!configuration.experimental && ("X-SailPoint-Experimental" in headers)) { + throw new Error("You are using Experimental APIs. Set configuration.experimental = True to enable these APIs in the SDK.") + } else if(configuration.experimental == true && ("X-SailPoint-Experimental" in headers)) { + console.log("Warning: You are using Experimental APIs") + } + + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.basePath) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); + }; +} diff --git a/sdk-output/workflows/configuration.ts b/sdk-output/workflows/configuration.ts new file mode 100644 index 00000000..1fb0fe19 --- /dev/null +++ b/sdk-output/workflows/configuration.ts @@ -0,0 +1,110 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Workflows + * 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. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/sdk-output/workflows/git_push.sh b/sdk-output/workflows/git_push.sh new file mode 100644 index 00000000..f53a75d4 --- /dev/null +++ b/sdk-output/workflows/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/sdk-output/workflows/index.ts b/sdk-output/workflows/index.ts new file mode 100644 index 00000000..7ccd702d --- /dev/null +++ b/sdk-output/workflows/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Identity Security Cloud API - Workflows + * 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. + */ + + +export * from "./api"; +export * from "../configuration"; + diff --git a/sdk-output/workflows/package.json b/sdk-output/workflows/package.json new file mode 100644 index 00000000..65897fe3 --- /dev/null +++ b/sdk-output/workflows/package.json @@ -0,0 +1,34 @@ +{ + "name": "sailpoint-api-client", + "version": "1.0.0", + "description": "OpenAPI client for sailpoint-api-client", + "author": "OpenAPI-Generator Contributors", + "repository": { + "type": "git", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + }, + "keywords": [ + "axios", + "typescript", + "openapi-client", + "openapi-generator", + "sailpoint-api-client" + ], + "license": "Unlicense", + "main": "./dist/index.js", + "typings": "./dist/index.d.ts", + "scripts": { + "build": "tsc", + "prepare": "npm run build" + }, + "dependencies": { + "axios": "^1.6.1" + }, + "devDependencies": { + "@types/node": "12.11.5 - 12.20.42", + "typescript": "^4.0 || ^5.0" + }, + "publishConfig": { + "registry": "sailpoint.com" + } +} diff --git a/sdk-output/workflows/tsconfig.json b/sdk-output/workflows/tsconfig.json new file mode 100644 index 00000000..d953a374 --- /dev/null +++ b/sdk-output/workflows/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "declaration": true, + "target": "ES5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": "dist", + "rootDir": ".", + "lib": [ + "es6", + "dom" + ], + "typeRoots": [ + "node_modules/@types" + ] + }, + "exclude": [ + "dist", + "node_modules" + ] +} diff --git a/sdk-resources/beta-config.yaml b/sdk-resources/beta-config.yaml deleted file mode 100644 index 0fb12a1a..00000000 --- a/sdk-resources/beta-config.yaml +++ /dev/null @@ -1,11 +0,0 @@ -templateDir: ./sdk-resources/resources -files: - package.mustache: - templateType: SupportingFiles - destinationFilename: package.json -npmName: sailpoint-sdk -npmRepository: sailpoint.com -npmVersion: 1.8.69 -useSingleRequestParameter: true -apiVersion: beta -enumNameSuffix: Beta diff --git a/sdk-resources/build-versioned-sdk.js b/sdk-resources/build-versioned-sdk.js new file mode 100644 index 00000000..f600766b --- /dev/null +++ b/sdk-resources/build-versioned-sdk.js @@ -0,0 +1,730 @@ +#!/usr/bin/env node +/** + * build-versioned-sdk.js + * + * TypeScript-axios adaptation of the Go versioned SDK builder. + * Builds one TypeScript SDK sub-directory per resource partition found in + * the apis/ directory. New partitions are discovered automatically — no + * script updates required when new endpoints are added. + * + * Pipeline for each partition: + * 1. Copy apis/ to .sdk-build-tmp/ (git-ignored, so source files stay clean) + * 2. Apply prescript YAML fixes to the temp copy + * 3. Bundle the partition openapi.yaml with redocly (resolves shared/ $refs) + * 4. Run openapi-generator-cli with a dynamically generated config + * 5. Run postscript.js on the generated output + * + * After all partitions are built: + * 6. Regenerate sdk-output/index.ts to re-export from every partition package + * + * On failure, structured error logs are written to build-errors/: + * build-errors/summary.md — overview of all failures + * build-errors/-error.md — self-contained per-partition report + * with error output + spec file contents + * (designed to be fed directly to an AI) + * + * Usage: + * node sdk-resources/build-versioned-sdk.js [--partition ] [--keep-tmp] + * + * Options: + * --partition Build only the named partition (default: all) + * --keep-tmp Do not delete .sdk-build-tmp after the build + */ + +"use strict"; + +const fs = require("fs"); +const path = require("path"); +const { spawnSync } = require("child_process"); + +// --------------------------------------------------------------------------- +// Constants +// --------------------------------------------------------------------------- + +const SDK_ROOT = path.resolve(__dirname, ".."); +const SDK_OUTPUT = path.join(SDK_ROOT, "sdk-output"); +const TEMP_DIR = path.join(SDK_ROOT, ".sdk-build-tmp"); +const BUNDLED_DIR = path.join(TEMP_DIR, "bundled"); +const ERROR_DIR = path.join(SDK_ROOT, "build-errors"); +const JAR = path.join(SDK_ROOT, "openapi-generator-cli.jar"); +const POSTSCRIPT = path.join(__dirname, "postscript.js"); +const TEMPLATE_DIR = path.join(__dirname, "resources"); + +const NPM_NAME = "sailpoint-api-client"; +const NPM_VERSION = "1.0.0"; +const API_VERSION = "v1"; + +// --------------------------------------------------------------------------- +// CLI args +// --------------------------------------------------------------------------- + +const args = process.argv.slice(2); +if (args.length === 0 || args[0].startsWith("--")) { + console.error("Usage: node sdk-resources/build-versioned-sdk.js [--partition ] [--keep-tmp]"); + process.exit(1); +} + +const apisDir = path.resolve(args[0]); +const keepTmp = args.includes("--keep-tmp"); +const partitionIdx = args.indexOf("--partition"); +const onlyPartition = partitionIdx !== -1 ? args[partitionIdx + 1] : null; + +// --------------------------------------------------------------------------- +// Utility: copy directory recursively +// --------------------------------------------------------------------------- + +function copyDirSync(src, dest) { + fs.mkdirSync(dest, { recursive: true }); + for (const entry of fs.readdirSync(src, { withFileTypes: true })) { + const srcPath = path.join(src, entry.name); + const destPath = path.join(dest, entry.name); + if (entry.isDirectory()) { + copyDirSync(srcPath, destPath); + } else { + fs.copyFileSync(srcPath, destPath); + } + } +} + +// --------------------------------------------------------------------------- +// Utility: walk directory, return all file paths +// --------------------------------------------------------------------------- + +function walkSync(dir, files = []) { + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + walkSync(full, files); + } else { + files.push(full); + } + } + return files; +} + +// --------------------------------------------------------------------------- +// Utility: read a file safely (returns empty string if missing) +// --------------------------------------------------------------------------- + +function readFileSafe(filePath) { + try { + return fs.readFileSync(filePath, "utf8"); + } catch { + return ""; + } +} + +// --------------------------------------------------------------------------- +// Prescript fixes (applied to the temp copy of apis/) +// --------------------------------------------------------------------------- + +function applyPrescriptFixes(tempApisDir) { + const files = walkSync(tempApisDir); + let fixed = 0; + + for (const file of files) { + if (!file.endsWith(".yaml") && !file.endsWith(".yml")) continue; + + let rawdata = fs.readFileSync(file, "utf8"); + let lines = rawdata.split("\n"); + let out = []; + let changed = false; + + // Fix X-SailPoint-Experimental headers (TypeScript prescript.js logic) + const experimentalFixed = rawdata.replace( + /(- name: X-SailPoint-Experimental[\s\S]*?required: )true/g, + "$1false" + ); + if (experimentalFixed !== rawdata) { + rawdata = experimentalFixed; + lines = rawdata.split("\n"); + changed = true; + } + + // Fix transforms and sources transform schemas + if (file.includes(path.join("transforms", "schemas", "transform.yaml")) || + file.includes(path.join("sources", "schemas", "transform.yaml"))) { + for (let line of lines) { + if (line.includes("oneOf")) { line = line.replaceAll("oneOf:", "type: object"); changed = true; } + if (!line.includes("- $ref:")) out.push(line); + } + lines = out; out = []; + } + + // Fix workflow trigger schemas + if (file.includes(path.join("workflows", "schemas", "workflowtrigger.yaml"))) { + for (let line of lines) { + if (line.includes("anyOf")) { line = line.replaceAll("anyOf:", "type: object"); changed = true; } + if (!line.includes("- $ref:")) out.push(line); + } + lines = out; out = []; + } + + // Fix search document schemas (TypeScript generator does not handle discriminated unions well) + if (file.includes(path.join("search", "schemas", "searchdocument.yaml")) || + file.includes(path.join("search", "schemas", "searchdocuments.yaml"))) { + lines = ["type: object"]; + changed = true; + } + + if (changed) { + fs.writeFileSync(file, lines.join("\n"), "utf8"); + fixed++; + } + } + + console.log(` prescript: fixed ${fixed} file(s) in temp copy`); +} + +// --------------------------------------------------------------------------- +// Bundle a single partition's openapi.yaml with redocly +// --------------------------------------------------------------------------- + +function bundlePartition(partitionName, tempApisDir) { + const inputSpec = path.join(tempApisDir, partitionName, "openapi.yaml"); + const outputSpec = path.join(BUNDLED_DIR, `${partitionName}.yaml`); + + fs.mkdirSync(BUNDLED_DIR, { recursive: true }); + + const result = spawnSync( + "npx", + ["redocly", "bundle", inputSpec, "-o", outputSpec, "--force"], + { encoding: "utf8" } + ); + + return { + ok: result.status === 0, + stdout: result.stdout || "", + stderr: result.stderr || "", + outputSpec, + }; +} + +// --------------------------------------------------------------------------- +// Generate per-partition config YAML (TypeScript-specific) +// --------------------------------------------------------------------------- + +function writePartitionConfig(partitionName) { + const config = [ + `templateDir: ${TEMPLATE_DIR}`, + `files:`, + ` package.mustache:`, + ` templateType: SupportingFiles`, + ` destinationFilename: package.json`, + `npmName: ${NPM_NAME}`, + `npmRepository: sailpoint.com`, + `npmVersion: ${NPM_VERSION}`, + `useSingleRequestParameter: true`, + `apiVersion: ${API_VERSION}`, + `enumNameSuffix: V1`, + ].join("\n"); + + const configPath = path.join(TEMP_DIR, `${partitionName}-config.yaml`); + fs.writeFileSync(configPath, config, "utf8"); + return configPath; +} + +// --------------------------------------------------------------------------- +// Run openapi-generator for a single partition +// --------------------------------------------------------------------------- + +function generatePartition(partitionName, bundledSpec, configPath) { + const packageDir = partitionName.replaceAll("-", "_"); + const outputDir = path.join(SDK_OUTPUT, packageDir); + + if (fs.existsSync(outputDir)) { + fs.rmSync(outputDir, { recursive: true, force: true }); + } + + const result = spawnSync( + "java", + [ + "-jar", JAR, + "generate", + "-i", bundledSpec, + "-g", "typescript-axios", + "-o", outputDir, + "--global-property", "skipFormModel=false", + "--config", configPath, + "--api-name-suffix", "V1Api", + "--model-name-suffix", "V1", + ], + { encoding: "utf8" } + ); + + // Write a marker so cleanup and index generation can identify generated dirs + // without relying on a version suffix in the folder name. + if (result.status === 0) { + fs.writeFileSync(path.join(outputDir, ".sdk-partition"), partitionName, "utf8"); + } + + return { + ok: result.status === 0, + stdout: result.stdout || "", + stderr: result.stderr || "", + outputDir, + packageDir, + }; +} + +// --------------------------------------------------------------------------- +// Run postscript.js on the generated output +// --------------------------------------------------------------------------- + +function runPostscript(outputDir) { + const result = spawnSync( + "node", + [POSTSCRIPT, outputDir], + { encoding: "utf8" } + ); + + return { + ok: result.status === 0, + stdout: result.stdout || "", + stderr: result.stderr || "", + }; +} + +// --------------------------------------------------------------------------- +// Error logging +// --------------------------------------------------------------------------- + +const MAX_FILE_BYTES = 20_000; + +function collectSpecFiles(partitionName, tempApisDir) { + const partDir = path.join(tempApisDir, partitionName); + if (!fs.existsSync(partDir)) return {}; + + const collected = {}; + const files = walkSync(partDir).filter(f => f.endsWith(".yaml")); + + for (const f of files) { + const relPath = path.relative(path.join(tempApisDir, ".."), f); + let content = readFileSafe(f); + if (Buffer.byteLength(content, "utf8") > MAX_FILE_BYTES) { + content = content.slice(0, MAX_FILE_BYTES) + "\n\n[... truncated — file exceeds 20 KB ...]"; + } + collected[relPath] = content; + } + + return collected; +} + +function writeErrorReport(partitionName, step, errorOutput, tempApisDir, apisSourceDir) { + fs.mkdirSync(ERROR_DIR, { recursive: true }); + + const specFiles = collectSpecFiles(partitionName, path.join(tempApisDir, "apis")); + const sourceDir = path.join(apisSourceDir, partitionName); + const reportPath = path.join(ERROR_DIR, `${partitionName}-error.md`); + + const fileBlocks = Object.entries(specFiles) + .map(([relPath, content]) => `### \`${relPath}\`\n\`\`\`yaml\n${content}\n\`\`\``) + .join("\n\n"); + + const report = `# SDK Build Error: \`${partitionName}\` + +## Context for AI + +This file is a self-contained error report for the \`${partitionName}\` API partition. +It contains the build error and all relevant OpenAPI spec files needed to diagnose and fix the problem. + +**Source directory to fix:** \`${sourceDir}\` +**Failed step:** ${step} + +--- + +## Error Output + +\`\`\` +${errorOutput.trim()} +\`\`\` + +--- + +## Fix Instructions + +1. Read the error output above carefully. +2. Identify which spec file(s) below are causing the problem. +3. Apply fixes directly to the source files under \`${sourceDir}\`. +4. Do **not** edit files in \`.sdk-build-tmp/\` — those are generated copies. +5. After fixing, re-run the build for just this partition: + \`\`\`bash + node sdk-resources/build-versioned-sdk.js --partition ${partitionName} + \`\`\` + +--- + +## Spec Files + +${fileBlocks || "_No spec files found._"} +`; + + fs.writeFileSync(reportPath, report, "utf8"); + return reportPath; +} + +function writeSummaryReport(results, apisSourceDir) { + fs.mkdirSync(ERROR_DIR, { recursive: true }); + + const failureLines = results.failed.map(({ partition, step, reportPath }) => + `| \`${partition}\` | ${step} | [${path.basename(reportPath)}](./${path.basename(reportPath)}) |` + ).join("\n"); + + const summary = `# SDK Build Error Summary + +**Date:** ${new Date().toISOString()} +**APIs directory:** \`${apisSourceDir}\` +**Total partitions:** ${results.total} +**Succeeded:** ${results.success.length} +**Failed:** ${results.failed.length} + +## Failed Partitions + +| Partition | Failed Step | Error Report | +|-----------|-------------|--------------| +${failureLines || "_(none)_"} + +## How to Fix + +Each error report in this directory is self-contained and can be given directly to an AI. +It includes the full error output and all relevant spec file contents. + +Fix partitions one at a time: +\`\`\`bash +# Fix a single partition +node sdk-resources/build-versioned-sdk.js --partition + +# Re-run all after fixes +node sdk-resources/build-versioned-sdk.js +\`\`\` +`; + + const summaryPath = path.join(ERROR_DIR, "summary.md"); + fs.writeFileSync(summaryPath, summary, "utf8"); + return summaryPath; +} + +// --------------------------------------------------------------------------- +// Regenerate sdk-output/index.ts from discovered partition packages +// +// Naming convention in the SailPoint namespace: +// Generated class AccountsV1Api → SailPoint.AccountsApi +// Generated class AccountsV2Api → still SailPoint.AccountsApi (combined) +// +// The version suffix is stripped from the namespace name so the import never +// changes as new versions land. Method names carry the version suffix +// (listAccountsV1, listAccountsV2) so you always know which version you're +// calling. +// +// Single-version resource → const AccountsApi = _AccountsV1Api +// Multi-version resource → generated combined class that extends the +// latest version and copies older-version prototype methods, with +// TypeScript interface merging for full type safety on all methods. +// +// TS2308 note: export * across 100+ partitions collides on shared error model +// names (Redocly inlines them into every partition). Only API classes are +// exported from the root — models are imported directly from sub-paths: +// import type { AccountV1 } from "sailpoint-api-client/accounts_v1/api" +// --------------------------------------------------------------------------- + +/** AccountsV1Api → AccountsApi */ +function toResourceApiName(className) { + return className.replace(/V\d+Api$/, "Api"); +} + +/** Extract the numeric version from a class name: AccountsV1Api → 1 */ +function classVersion(className) { + return parseInt(className.match(/V(\d+)Api$/)?.[1] ?? "1", 10); +} + +function generateIndexTs() { + const partitionDirs = fs.readdirSync(SDK_OUTPUT) + .filter(d => { + if (!fs.statSync(path.join(SDK_OUTPUT, d)).isDirectory()) return false; + return fs.existsSync(path.join(SDK_OUTPUT, d, ".sdk-partition")); + }) + .sort(); + + if (partitionDirs.length === 0) { + console.log(" No generated partition packages found, skipping index.ts regeneration."); + return; + } + + // Collect { dir, className } for every partition + const partitions = partitionDirs.map(d => { + const apiTsPath = path.join(SDK_OUTPUT, d, "api.ts"); + const content = fs.existsSync(apiTsPath) ? fs.readFileSync(apiTsPath, "utf8") : ""; + const match = content.match(/^export class (\w+) extends BaseAPI/m); + return match ? { dir: d, className: match[1] } : null; + }).filter(Boolean); + + // Group by resource name, sorted oldest→newest within each group + const byResource = new Map(); + for (const p of partitions) { + const key = toResourceApiName(p.className); + if (!byResource.has(key)) byResource.set(key, []); + byResource.get(key).push(p); + } + for (const group of byResource.values()) { + group.sort((a, b) => classVersion(a.className) - classVersion(b.className)); + } + + // Build the three output sections + const importLines = []; // import { X as _X } from "..." + const exportLines = []; // export { _X as X } (named / backward-compat) + const combinedBlocks = []; // combined class declarations for multi-version resources + const nsLines = []; // lines inside `export namespace SailPoint { ... }` + + for (const [resourceApiName, group] of byResource.entries()) { + // --- import every versioned class --- + for (const p of group) { + importLines.push(`import { ${p.className} as _${p.className} } from "./${p.dir}/api";`); + exportLines.push(`export { _${p.className} as ${p.className} };`); + } + + if (group.length === 1) { + // Single version — simple alias in namespace + nsLines.push(` export const ${resourceApiName} = _${group[0].className};`); + } else { + // Multi-version — generate a combined class: + // • extends the latest version (newest methods available natively) + // • interface-merges older versions (TypeScript knows all method signatures) + // • copies older prototype methods at runtime (runtime correctness) + const latest = group[group.length - 1]; + const older = group.slice(0, -1); + const implVar = `_${resourceApiName}Impl`; // e.g. _AccountsApiImpl + + const interfaceMerges = older + .map(p => `interface ${implVar} extends _${p.className} {}`) + .join("\n"); + + const protoCopyArgs = older.map(p => `_${p.className}`).join(", "); + + combinedBlocks.push( + `// ${resourceApiName}: combined ${group.map(p => p.className).join(" + ")}`, + `class ${implVar} extends _${latest.className} {}`, + interfaceMerges, + `(function(target: any, ...sources: Function[]) {`, + ` for (const src of sources) {`, + ` for (const key of Object.getOwnPropertyNames((src as any).prototype)) {`, + ` if (key !== "constructor" && !(key in target.prototype)) {`, + ` const d = Object.getOwnPropertyDescriptor((src as any).prototype, key);`, + ` if (d) Object.defineProperty(target.prototype, key, d);`, + ` }`, + ` }`, + ` }`, + `})(${implVar}, ${protoCopyArgs});`, + "", + ); + + nsLines.push(` export const ${resourceApiName} = ${implVar};`); + } + } + + const fileContent = `/* tslint:disable */ +/* eslint-disable */ +// Code generated by build-versioned-sdk.js; DO NOT EDIT. +// +// Named imports — backward-compatible, version-explicit: +// import { AccountsV1Api, Configuration } from "sailpoint-api-client" +// +// Namespace — resource-named, version-agnostic (preferred): +// import { SailPoint, Configuration } from "sailpoint-api-client" +// const api = new SailPoint.AccountsApi(config) // works for v1, v2, v3 … +// api.listAccountsV1(...) // method name shows version +// api.listAccountsV2(...) // when v2 partition lands +// +// Models — import directly from the partition sub-path: +// import type { AccountV1 } from "sailpoint-api-client/accounts/api" + +// --- Partition imports (private _ alias avoids TS1194 / TS2303 in namespace) --- +${importLines.join("\n")} + +// --- Named exports (versioned class names, backward-compatible) --- +${exportLines.join("\n")} + +// --- Generic / NERM / shared exports --- +export * from "./generic/api"; + +export * from "./nerm/api"; +export { Configuration as ConfigurationNerm, ConfigurationParameters as ConfigurationParametersNerm } from "./nerm/configuration"; + +export * from "./nermv2025/api"; +export { Configuration as ConfigurationNermV2025, ConfigurationParameters as ConfigurationParametersNermV2025 } from "./nermv2025/configuration"; + +export { Configuration, ConfigurationParameters } from "./configuration"; + +export * from "./paginator"; +export { axiosRetry }; + + import * as axiosRetry from "axios-retry"; + +${combinedBlocks.length > 0 ? "// --- Combined multi-version API classes ---\n" + combinedBlocks.join("\n") : ""} +// --- SailPoint namespace (resource-named, all versions combined) --- +export namespace SailPoint { +${nsLines.join("\n")} +} +`; + + fs.writeFileSync(path.join(SDK_OUTPUT, "index.ts"), fileContent, "utf8"); + console.log(` Wrote index.ts — ${partitions.length} partition(s), ${byResource.size} resource(s) in SailPoint namespace`); +} + +// --------------------------------------------------------------------------- +// Main +// --------------------------------------------------------------------------- + +async function main() { + if (!fs.existsSync(apisDir)) { + console.error(`Error: apis directory not found: ${apisDir}`); + process.exit(1); + } + + if (!fs.existsSync(JAR)) { + console.error(`Error: openapi-generator-cli.jar not found at ${JAR}`); + console.error(" Download it with:"); + console.error(" wget -q https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.12.0/openapi-generator-cli-7.12.0.jar -O openapi-generator-cli.jar"); + process.exit(1); + } + + const allPartitions = fs.readdirSync(apisDir, { withFileTypes: true }) + .filter(e => e.isDirectory() && e.name !== "shared") + .map(e => e.name) + .sort(); + + const partitions = onlyPartition + ? allPartitions.filter(p => p === onlyPartition) + : allPartitions; + + if (partitions.length === 0) { + console.error(`No partitions found${onlyPartition ? ` matching '${onlyPartition}'` : ""} in ${apisDir}`); + process.exit(1); + } + + console.log(`\nFound ${partitions.length} partition(s) to build\n`); + + // Set up temp directory + console.log(`[SETUP] Copying apis/ → ${path.relative(SDK_ROOT, TEMP_DIR)}/`); + if (fs.existsSync(TEMP_DIR)) fs.rmSync(TEMP_DIR, { recursive: true, force: true }); + copyDirSync(apisDir, path.join(TEMP_DIR, "apis")); + + console.log("[SETUP] Applying prescript fixes to temp copy ..."); + applyPrescriptFixes(path.join(TEMP_DIR, "apis")); + + // Clear any previous error reports + if (fs.existsSync(ERROR_DIR)) fs.rmSync(ERROR_DIR, { recursive: true, force: true }); + + // Remove all stale generated partition directories so renamed/removed APIs don't linger. + // Generated dirs are identified by the presence of a .sdk-partition marker file written + // during generation; shared dirs (generic, nerm, nermv2025) are never touched. + // Also removes legacy dirs with a _v{n} suffix (pre-marker naming convention). + // Skipped when --partition is used (single-partition rebuild preserves sibling packages). + if (!onlyPartition && fs.existsSync(SDK_OUTPUT)) { + console.log("[CLEAN] Removing stale generated partition directories ..."); + const expectedDirs = new Set(partitions.map(p => p.replaceAll("-", "_"))); + const stale = fs.readdirSync(SDK_OUTPUT) + .filter(d => { + if (!fs.statSync(path.join(SDK_OUTPUT, d)).isDirectory()) return false; + // New-style: identified by marker file + if (fs.existsSync(path.join(SDK_OUTPUT, d, ".sdk-partition"))) return !expectedDirs.has(d); + // Legacy migration: old _v{n} suffix dirs written before the marker was introduced + if (/^[a-z].+_v\d+$/.test(d)) return true; + return false; + }); + for (const d of stale) { + fs.rmSync(path.join(SDK_OUTPUT, d), { recursive: true, force: true }); + console.log(` removed sdk-output/${d}/`); + } + console.log(` cleaned ${stale.length} directory/directories\n`); + } + + const results = { + total: partitions.length, + success: [], + failed: [], + }; + + for (const partition of partitions) { + console.log(`\n${"=".repeat(60)}`); + console.log(` Building: ${partition}`); + console.log(`${"=".repeat(60)}`); + + // --- Step 1: Bundle --- + console.log(" [1/4] Bundling spec ..."); + const bundle = bundlePartition(partition, path.join(TEMP_DIR, "apis")); + if (!bundle.ok) { + const errorOutput = [bundle.stdout, bundle.stderr].filter(Boolean).join("\n"); + console.error(` ✗ bundling failed`); + const reportPath = writeErrorReport(partition, "bundling", errorOutput, TEMP_DIR, apisDir); + results.failed.push({ partition, step: "bundling", reportPath }); + continue; + } + + // --- Step 2: Config --- + console.log(" [2/4] Writing generator config ..."); + const configPath = writePartitionConfig(partition); + + // --- Step 3: Generate --- + console.log(" [3/4] Generating TypeScript SDK ..."); + const gen = generatePartition(partition, bundle.outputSpec, configPath); + if (!gen.ok) { + const errorOutput = [gen.stdout, gen.stderr].filter(Boolean).join("\n"); + console.error(` ✗ generation failed`); + const reportPath = writeErrorReport(partition, "generation", errorOutput, TEMP_DIR, apisDir); + results.failed.push({ partition, step: "generation", reportPath }); + continue; + } + + // --- Step 4: Postscript --- + console.log(" [4/4] Running postscript ..."); + const post = runPostscript(gen.outputDir); + if (!post.ok) { + const errorOutput = [post.stdout, post.stderr].filter(Boolean).join("\n"); + console.error(` ✗ postscript failed`); + const reportPath = writeErrorReport(partition, "postscript", errorOutput, TEMP_DIR, apisDir); + results.failed.push({ partition, step: "postscript", reportPath }); + continue; + } + + results.success.push(partition); + console.log(` ✓ ${partition} → sdk-output/${gen.packageDir}/`); + } + + // Cleanup + if (!keepTmp) { + console.log("\n[CLEANUP] Removing .sdk-build-tmp/ ..."); + fs.rmSync(TEMP_DIR, { recursive: true, force: true }); + } + + // Regenerate index.ts to include all current *_v1 packages + console.log("\n[INDEX] Regenerating sdk-output/index.ts ..."); + generateIndexTs(); + + // Write error reports + if (results.failed.length > 0) { + const summaryPath = writeSummaryReport(results, apisDir); + console.log(`\n[ERRORS] ${results.failed.length} partition(s) failed.`); + console.log(` Summary: ${path.relative(SDK_ROOT, summaryPath)}`); + console.log(` Reports: ${path.relative(SDK_ROOT, ERROR_DIR)}/`); + console.log(`\n Failed partitions:`); + for (const { partition, step, reportPath } of results.failed) { + console.log(` ✗ ${partition} (${step}) → ${path.relative(SDK_ROOT, reportPath)}`); + } + } + + // Summary + console.log("\n" + "=".repeat(60)); + console.log("BUILD SUMMARY"); + console.log("=".repeat(60)); + console.log(` Success: ${results.success.length} / ${results.total}`); + console.log(` Failed: ${results.failed.length} / ${results.total}`); + + if (results.failed.length > 0) { + process.exit(1); + } +} + +main().catch(err => { + console.error(`Unexpected error: ${err.message}`); + process.exit(1); +}); diff --git a/sdk-resources/nerm-v2025-config.yaml b/sdk-resources/nerm-v2025-config.yaml index 8bf87d85..99c8b65e 100644 --- a/sdk-resources/nerm-v2025-config.yaml +++ b/sdk-resources/nerm-v2025-config.yaml @@ -7,6 +7,6 @@ npmName: sailpoint-nerm-sdk npmRepository: sailpoint.com npmVersion: 1.8.69 useSingleRequestParameter: true -apiVersion: 2025 +apiVersion: v2025 enumNameSuffix: NermV2025 nerm: true diff --git a/sdk-resources/postscript.js b/sdk-resources/postscript.js index b7e52824..75284ee3 100644 --- a/sdk-resources/postscript.js +++ b/sdk-resources/postscript.js @@ -7,19 +7,37 @@ const getAllFiles = function (dirPath, arrayOfFiles) { if (fs.statSync(dirPath + "/" + file).isDirectory()) { arrayOfFiles = getAllFiles(dirPath + "/" + file, arrayOfFiles); } else { - arrayOfFiles.push(path.join(__dirname.replaceAll('sdk-resources',''), dirPath, "/", file)); + arrayOfFiles.push(path.join(dirPath, file)); } }); return arrayOfFiles; }; +// When an OpenAPI schema name already contains a version suffix (e.g. AccessRequestConfigV2), +// the generator lowercases it to "accessrequestconfigv2" and then appends the +// --model-name-suffix "V1", producing "Accessrequestconfigv2V1". +// This function corrects those names back to "AccessrequestconfigV2": +// Pattern: word ending in vV1 → replace with V +const fixVersionedModelNames = function (content) { + return content.replace(/([A-Z]\w*)v(\d+)V1\b/g, "$1V$2"); +}; + const fixFiles = function (myArray) { + for (const file of myArray) { + if (!file.endsWith(".ts")) continue; + const original = fs.readFileSync(file, "utf8"); + const fixed = fixVersionedModelNames(original); + if (fixed !== original) { + fs.writeFileSync(file, fixed, "utf8"); + } + } } + let myArray = []; getAllFiles(process.argv[2], myArray); diff --git a/sdk-resources/prescript.js b/sdk-resources/prescript.js deleted file mode 100644 index dec34f42..00000000 --- a/sdk-resources/prescript.js +++ /dev/null @@ -1,53 +0,0 @@ -const fs = require('fs'); -const path = require('path'); - -const updateYamlFiles = (directoryPath) => { - // Read all files and directories within the given directory - fs.readdir(directoryPath, (err, files) => { - if (err) { - console.error('Error reading directory:', err); - return; - } - - files.forEach(file => { - const filePath = path.join(directoryPath, file); - fs.stat(filePath, (err, stat) => { - if (err) { - console.error('Error stating file:', err); - return; - } - - if (stat.isDirectory()) { - // Recursively process subdirectories - updateYamlFiles(filePath); - } else if (path.extname(file) === '.yaml' || path.extname(file) === '.yml') { - // Process YAML file - fs.readFile(filePath, 'utf8', (err, data) => { - if (err) { - console.error('Error reading file:', err); - return; - } - - const updatedData = data.replaceAll( - /(- name: X-SailPoint-Experimental[\s\S]*?required: )true/g, - '$1false', - ); - - // Write the updated YAML back to the file only if changes were made - if (updatedData !== data) { - fs.writeFile(filePath, updatedData, 'utf8', (err) => { - if (err) { - console.error('Error writing file:', err); - } else { - console.log(`Updated file: ${filePath}`); - } - }); - } - }); - } - }); - }); - }); -}; - -updateYamlFiles(process.argv[2]); diff --git a/sdk-resources/resources/baseApi.mustache b/sdk-resources/resources/baseApi.mustache index f7801c40..af2939ed 100644 --- a/sdk-resources/resources/baseApi.mustache +++ b/sdk-resources/resources/baseApi.mustache @@ -39,14 +39,14 @@ export interface RequestArgs { export class BaseAPI { protected configuration: Configuration | undefined; - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = configuration?.axiosInstance ?? globalAxios) { if (configuration) { this.configuration = configuration; {{#nerm}} this.basePath = configuration.nermBasePath{{#apiVersion}}+ "/{{{apiVersion}}}"{{/apiVersion}}; {{/nerm}} {{^nerm}} - this.basePath = configuration.basePath {{#apiVersion}}+ "/{{{apiVersion}}}"{{/apiVersion}}|| this.basePath; + this.basePath = configuration.basePath || this.basePath; {{/nerm}} } } diff --git a/sdk-resources/resources/common.mustache b/sdk-resources/resources/common.mustache index 4f687467..f186867b 100644 --- a/sdk-resources/resources/common.mustache +++ b/sdk-resources/resources/common.mustache @@ -6,7 +6,6 @@ import type { Configuration } from "../configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -import axiosRetry from "axios-retry"; {{#withNodeImports}} import { URL, URLSearchParams } from 'url'; {{/withNodeImports}} @@ -136,8 +135,7 @@ export const toPathString = function (url: URL) { * @export */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - axiosRetry(axios, configuration.retriesConfig) + return async >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { let userAgent = `SailPoint-SDK-TypeScript/{{npmVersion}}`; if (configuration?.consumerIdentifier && configuration?.consumerVersion) { userAgent += ` (${configuration.consumerIdentifier}/${configuration.consumerVersion})`; @@ -156,8 +154,23 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi console.log("Warning: You are using Experimental APIs") } - axiosArgs.axiosOptions.headers = headers - const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (configuration?.{{#nerm}}nermBasePath{{/nerm}}{{^nerm}}basePath{{/nerm}}{{#apiVersion}}+ "/{{{apiVersion}}}"{{/apiVersion}} || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); + await setBearerAuthToObject(headers, configuration); + + const axiosRequestArgs = {...axiosArgs.axiosOptions, url: (basePath || configuration?.{{#nerm}}nermBasePath{{/nerm}}{{^nerm}}basePath{{/nerm}}) + axiosArgs.url, headers}; + return axios.request(axiosRequestArgs).catch((error: any) => { + if (error?.isAxiosError === true) { + const clean: any = new Error(error.message ?? 'API request failed'); + clean.name = 'ApiError'; + clean.stack = error.stack; + clean.code = error.code; + if (error.response) { + clean.status = error.response.status; + clean.statusText = error.response.statusText; + clean.data = error.response.data; + } + throw clean; + } + throw error; + }); }; } diff --git a/sdk-resources/v2024-config.yaml b/sdk-resources/v2024-config.yaml deleted file mode 100644 index a04eae28..00000000 --- a/sdk-resources/v2024-config.yaml +++ /dev/null @@ -1,11 +0,0 @@ -templateDir: ./sdk-resources/resources -files: - package.mustache: - templateType: SupportingFiles - destinationFilename: package.json -npmName: sailpoint-sdk -npmRepository: sailpoint.com -npmVersion: 1.8.69 -useSingleRequestParameter: true -apiVersion: v2024 -enumNameSuffix: V2024 diff --git a/sdk-resources/v2025-config.yaml b/sdk-resources/v2025-config.yaml deleted file mode 100644 index 024c4328..00000000 --- a/sdk-resources/v2025-config.yaml +++ /dev/null @@ -1,11 +0,0 @@ -templateDir: ./sdk-resources/resources -files: - package.mustache: - templateType: SupportingFiles - destinationFilename: package.json -npmName: sailpoint-sdk -npmRepository: sailpoint.com -npmVersion: 1.8.69 -useSingleRequestParameter: true -apiVersion: v2025 -enumNameSuffix: V2025 diff --git a/sdk-resources/v2026-config.yaml b/sdk-resources/v2026-config.yaml deleted file mode 100644 index 623cf509..00000000 --- a/sdk-resources/v2026-config.yaml +++ /dev/null @@ -1,11 +0,0 @@ -templateDir: ./sdk-resources/resources -files: - package.mustache: - templateType: SupportingFiles - destinationFilename: package.json -npmName: sailpoint-sdk -npmRepository: sailpoint.com -npmVersion: 1.8.69 -useSingleRequestParameter: true -apiVersion: v2026 -enumNameSuffix: V2026 diff --git a/sdk-resources/v3-config.yaml b/sdk-resources/v3-config.yaml deleted file mode 100644 index d15131a8..00000000 --- a/sdk-resources/v3-config.yaml +++ /dev/null @@ -1,11 +0,0 @@ -templateDir: ./sdk-resources/resources -files: - package.mustache: - templateType: SupportingFiles - destinationFilename: package.json -npmName: sailpoint-sdk -npmRepository: sailpoint.com -npmVersion: 1.8.69 -useSingleRequestParameter: true -apiVersion: v3 -enumNameSuffix: V3